diff --git a/.gitattributes b/.gitattributes index bed0738c7eeb449bca98b5d2f33c89a1ee56349a..a63f6962c0be1b0e0ab07a0834c3b39516b7aeff 100644 --- a/.gitattributes +++ b/.gitattributes @@ -58,3 +58,15 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text # Video files - compressed *.mp4 filter=lfs diff=lfs merge=lfs -text *.webm filter=lfs diff=lfs merge=lfs -text +original/38865-i00.docx filter=lfs diff=lfs merge=lfs -text +original/23700-97-i10.docx filter=lfs diff=lfs merge=lfs -text +original/23436-i20.docx filter=lfs diff=lfs merge=lfs -text +original/33898-i01.docx filter=lfs diff=lfs merge=lfs -text +original/36305-i00.docx filter=lfs diff=lfs merge=lfs -text +original/36304-i00.docx filter=lfs diff=lfs merge=lfs -text +original/22261-ic0.docx filter=lfs diff=lfs merge=lfs -text +original/29558-i40.docx filter=lfs diff=lfs merge=lfs -text +original/24257-i20.docx filter=lfs diff=lfs merge=lfs -text +original/23288-i40.docx filter=lfs diff=lfs merge=lfs -text +original/38101-5-i40.docx filter=lfs diff=lfs merge=lfs -text +original/38741-i00.docx filter=lfs diff=lfs merge=lfs -text diff --git a/gsma/29_series/29002/raw.md b/gsma/29_series/29002/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..71ec98a583c6167255ae598d1184b024e715cc96 --- /dev/null +++ b/gsma/29_series/29002/raw.md @@ -0,0 +1,58081 @@ + + +# 3GPP TS 29.002 V18.0.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobile Application Part (MAP) specification (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- 1 Contents + +| | | | +|----|------------------------------------------------------------------------|----| +| 2 | Foreword..... | 28 | +| 3 | 1 Scope..... | 29 | +| 4 | 2 References..... | 29 | +| 5 | 3 Abbreviations..... | 35 | +| 6 | 4 Void..... | 36 | +| 7 | 5 Overload and compatibility overview..... | 36 | +| 8 | 5.1 Overload control..... | 36 | +| 9 | 5.1.1 Overload control for MSC (outside MAP)..... | 36 | +| 10 | 5.1.2 Overload control for MAP entities..... | 36 | +| 11 | 5.1.3 Congestion control for Signalling System No. 7..... | 40 | +| 12 | 5.2 Compatibility..... | 40 | +| 13 | 5.2.1 General..... | 40 | +| 14 | 5.2.2 Strategy for selecting the Application Context (AC) version..... | 40 | +| 15 | 5.2.2.1 Proposed method..... | 40 | +| 16 | 5.2.2.2 Managing the version look-up table..... | 41 | +| 17 | 5.2.2.3 Optimising the method..... | 42 | +| 18 | 6 Requirements concerning the use of SCCP and TC..... | 42 | +| 19 | 6.1 Use of SCCP..... | 42 | +| 20 | 6.1.1 SCCP Class..... | 42 | +| 21 | 6.1.2 Sub-System Number (SSN)..... | 42 | +| 22 | 6.1.3 SCCP addressing..... | 43 | +| 23 | 6.1.3.1 Introduction..... | 43 | +| 24 | 6.1.3.2 The Mobile-services Switching Centre (MSC)..... | 45 | +| 25 | 6.1.3.2.1 MSC interaction during handover or relocation..... | 45 | +| 26 | 6.1.3.2.2 MSC for short message routing..... | 45 | +| 27 | 6.1.3.2.3 MSC for location request routing..... | 45 | +| 28 | 6.1.3.2.4 MSC for LMU Control..... | 45 | +| 29 | 6.1.3.3 The Home Location Register (HLR)..... | 46 | +| 30 | 6.1.3.3.1 During call set-up..... | 46 | +| 31 | 6.1.3.3.2 Before location updating completion..... | 46 | +| 32 | 6.1.3.3.3 After location updating completion..... | 46 | +| 33 | 6.1.3.3.4 VLR restoration..... | 47 | +| 34 | 6.1.3.3.5 During Network-Requested PDP Context Activation..... | 47 | +| 35 | 6.1.3.3.6 Before GPRS location updating completion..... | 47 | +| 36 | 6.1.3.3.7 After GPRS location updating completion..... | 48 | +| 37 | 6.1.3.3.8 Query for a Location Request..... | 48 | +| 38 | 6.1.3.4 The Visitor Location Register (VLR)..... | 48 | +| 39 | 6.1.3.4.0 General..... | 48 | +| 40 | 6.1.3.4.1 Inter-VLR information retrieval..... | 48 | +| 41 | 6.1.3.4.2 HLR request..... | 48 | +| 42 | 6.1.3.4.3 CSS request..... | 49 | +| 43 | 6.1.3.5 The Interworking MSC (IWMSC) for Short Message Service..... | 49 | +| 44 | 6.1.3.6 The Equipment Identity Register (EIR)..... | 49 | +| 45 | 6.1.3.7 Void..... | 49 | +| 46 | 6.1.3.8 The Serving GPRS Support Node (SGSN)..... | 49 | +| 47 | 6.1.3.8.0 General..... | 49 | +| 48 | 6.1.3.8.1 HLR request..... | 49 | +| 49 | 6.1.3.8.2 GMSC request..... | 49 | +| 50 | 6.1.3.8.3 CSS request..... | 49 | +| 51 | 6.1.3.9 The Gateway GPRS Support Node (GGSN)..... | 49 | +| 52 | 6.1.3.10 The Gateway MSC (GMSC) for Short Message Service..... | 50 | +| 53 | 6.1.3.10A Void..... | 50 | +| 54 | 6.1.3.10A.1 Void..... | 50 | +| 55 | 6.1.3.10A.2 Void..... | 50 | + +| | | | | +|-----|-----------|----------------------------------------------------|----| +| 56 | 6.1.3.10B | The Gateway Mobile Location Centre (GMLC)..... | 50 | +| 57 | 6.1.3.10C | The CSG Subscriber Server (CSS)..... | 50 | +| 58 | 6.1.3.11 | Summary table..... | 50 | +| 59 | 6.2 | Use of TC..... | 54 | +| 60 | 7 | General on MAP services..... | 54 | +| 61 | 7.1 | Terminology and definitions..... | 54 | +| 62 | 7.2 | Modelling principles..... | 54 | +| 63 | 7.3 | Common MAP services..... | 55 | +| 64 | 7.3.1 | MAP-OPEN service..... | 56 | +| 65 | 7.3.2 | MAP-CLOSE service..... | 59 | +| 66 | 7.3.3 | MAP-DELIMITER service..... | 59 | +| 67 | 7.3.4 | MAP-U-ABORT service..... | 59 | +| 68 | 7.3.5 | MAP-P-ABORT service..... | 60 | +| 69 | 7.3.6 | MAP-NOTICE service..... | 61 | +| 70 | 7.3.7 | Void..... | 62 | +| 71 | 7.3.8 | Void..... | 62 | +| 72 | 7.3.9 | Void..... | 62 | +| 73 | 7.3.10 | Void..... | 62 | +| 74 | 7.4 | Sequencing of services..... | 62 | +| 75 | 7.5 | General rules for mapping of services onto TC..... | 63 | +| 76 | 7.5.1 | Mapping of common services..... | 63 | +| 77 | 7.5.2 | Mapping of user specific services..... | 64 | +| 78 | 7.6 | Definition of parameters..... | 65 | +| 79 | 7.6.1 | Common parameters..... | 65 | +| 80 | 7.6.1.1 | Invoke Id..... | 65 | +| 81 | 7.6.1.2 | Linked Id..... | 65 | +| 82 | 7.6.1.3 | Provider error..... | 65 | +| 83 | 7.6.1.4 | User error..... | 65 | +| 84 | 7.6.2 | Numbering and identification parameters..... | 69 | +| 85 | 7.6.2.1 | IMSI..... | 69 | +| 86 | 7.6.2.2 | TMSI..... | 69 | +| 87 | 7.6.2.3 | IMEI..... | 69 | +| 88 | 7.6.2.3a | IMEISV..... | 69 | +| 89 | 7.6.2.4 | Previous location area Id..... | 69 | +| 90 | 7.6.2.5 | Stored location area Id..... | 69 | +| 91 | 7.6.2.6 | Current location area Id..... | 69 | +| 92 | 7.6.2.7 | Target location area Id..... | 69 | +| 93 | 7.6.2.8 | Target cell Id..... | 69 | +| 94 | 7.6.2.8A | Target RNC Id..... | 69 | +| 95 | 7.6.2.9 | Void..... | 69 | +| 96 | 7.6.2.10 | Originating entity number..... | 70 | +| 97 | 7.6.2.11 | MSC number..... | 70 | +| 98 | 7.6.2.12 | Target MSC number..... | 70 | +| 99 | 7.6.2.13 | HLR number..... | 70 | +| 100 | 7.6.2.14 | VLR number..... | 70 | +| 101 | 7.6.2.15 | HLR Id..... | 70 | +| 102 | 7.6.2.16 | LMSI..... | 70 | +| 103 | 7.6.2.17 | MS ISDN..... | 70 | +| 104 | 7.6.2.17A | Additional MSISDN..... | 70 | +| 105 | 7.6.2.18 | OMC Id..... | 70 | +| 106 | 7.6.2.19 | Roaming number..... | 70 | +| 107 | 7.6.2.19A | Relocation Number List..... | 70 | +| 108 | 7.6.2.20 | Void..... | 70 | +| 109 | 7.6.2.21 | Handover number..... | 70 | +| 110 | 7.6.2.22 | Forwarded-to number..... | 71 | +| 111 | 7.6.2.22A | Long forwarded-to number..... | 71 | +| 112 | 7.6.2.22B | Long FTN Supported..... | 71 | +| 113 | 7.6.2.23 | Forwarded-to subaddress..... | 71 | +| 114 | 7.6.2.24 | Called number..... | 71 | +| 115 | 7.6.2.25 | Calling number..... | 71 | +| 116 | 7.6.2.26 | Originally dialled number..... | 71 | + +| | | | | +|-----|-----------|-------------------------------------------------------|----| +| 117 | 7.6.2.27 | Service centre address..... | 71 | +| 118 | 7.6.2.28 | Zone Code..... | 71 | +| 119 | 7.6.2.29 | MSISdn-Alert..... | 71 | +| 120 | 7.6.2.30 | Location Information..... | 71 | +| 121 | 7.6.2.30a | Location Information for GPRS..... | 71 | +| 122 | 7.6.2.30b | Location Information for EPS..... | 71 | +| 123 | 7.6.2.31 | GMSC Address..... | 71 | +| 124 | 7.6.2.32 | VMS Address..... | 72 | +| 125 | 7.6.2.33 | Group Id..... | 72 | +| 126 | 7.6.2.34 | North American Equal Access preferred Carrier Id..... | 72 | +| 127 | 7.6.2.35 | Void..... | 72 | +| 128 | 7.6.2.36 | Void..... | 72 | +| 129 | 7.6.2.37 | Serving cell Id..... | 72 | +| 130 | 7.6.2.38 | SGSN number..... | 72 | +| 131 | 7.6.2.39 | SGSN address..... | 72 | +| 132 | 7.6.2.40 | GGSN address..... | 72 | +| 133 | 7.6.2.41 | GGSN number..... | 72 | +| 134 | 7.6.2.42 | APN..... | 72 | +| 135 | 7.6.2.43 | Network Node number..... | 73 | +| 136 | 7.6.2.43A | Network Node Diameter Address..... | 73 | +| 137 | 7.6.2.44 | PDP-Type..... | 73 | +| 138 | 7.6.2.44A | Extension PDP-Type..... | 73 | +| 139 | 7.6.2.45 | PDP-Address..... | 73 | +| 140 | 7.6.2.45A | Extension PDP-Address..... | 73 | +| 141 | 7.6.2.46 | Additional number..... | 73 | +| 142 | 7.6.2.46A | Additional Network Node Diameter Address..... | 73 | +| 143 | 7.6.2.46B | Third Number..... | 73 | +| 144 | 7.6.2.46C | Third Network Node Diameter Address..... | 73 | +| 145 | 7.6.2.47 | P-TMSI..... | 73 | +| 146 | 7.6.2.48 | B-subscriber number..... | 74 | +| 147 | 7.6.2.49 | B-subscriber subaddress..... | 74 | +| 148 | 7.6.2.50 | LMU Number..... | 74 | +| 149 | 7.6.2.51 | MLC Number..... | 74 | +| 150 | 7.6.2.52 | Multicall Bearer Information..... | 74 | +| 151 | 7.6.2.53 | Multiple Bearer Requested..... | 74 | +| 152 | 7.6.2.54 | Multiple Bearer Not Supported..... | 74 | +| 153 | 7.6.2.55 | PDP-Charging Characteristics..... | 74 | +| 154 | 7.6.2.56 | Selected RAB ID..... | 74 | +| 155 | 7.6.2.57 | RAB ID..... | 74 | +| 156 | 7.6.2.58 | gsmSCF Address..... | 74 | +| 157 | 7.6.2.59 | V-GMLC Address..... | 74 | +| 158 | 7.6.2.60 | Void..... | 74 | +| 159 | 7.6.2.61 | H-GMLC Address..... | 74 | +| 160 | 7.6.2.62 | PPR Address..... | 75 | +| 161 | 7.6.2.63 | Routeing Number..... | 75 | +| 162 | 7.6.2.64 | Additional V-GMLC Address..... | 75 | +| 163 | 7.6.2.65 | MME Name..... | 75 | +| 164 | 7.6.2.66 | 3GPP AAA Server Name..... | 75 | +| 165 | 7.6.2.67 | CSS number..... | 75 | +| 166 | 7.6.2.68 | SGSN Name..... | 75 | +| 167 | 7.6.2.69 | SGSN Realm..... | 75 | +| 168 | 7.6.3 | Subscriber management parameters..... | 75 | +| 169 | 7.6.3.1 | Category..... | 75 | +| 170 | 7.6.3.2 | Equipment status..... | 75 | +| 171 | 7.6.3.2a | BMUEF..... | 75 | +| 172 | 7.6.3.3 | Extensible Bearer service..... | 75 | +| 173 | 7.6.3.4 | Extensible Teleservice..... | 75 | +| 174 | 7.6.3.5 | Extensible Basic Service Group..... | 76 | +| 175 | 7.6.3.6 | GSM bearer capability..... | 76 | +| 176 | 7.6.3.7 | Subscriber Status..... | 76 | +| 177 | 7.6.3.8 | CUG Outgoing Access indicator..... | 76 | + +| | | | | +|-----|-----------|----------------------------------------------------------------|----| +| 178 | 7.6.3.9 | Operator Determined Barring General Data..... | 76 | +| 179 | 7.6.3.10 | ODB HPLMN Specific Data..... | 78 | +| 180 | 7.6.3.11 | Regional Subscription Data..... | 78 | +| 181 | 7.6.3.12 | Regional Subscription Response..... | 79 | +| 182 | 7.6.3.13 | Roaming Restriction Due To Unsupported Feature..... | 79 | +| 183 | 7.6.3.14 | Extensible SS-Info..... | 79 | +| 184 | 7.6.3.15 | Extensible forwarding information..... | 79 | +| 185 | 7.6.3.16 | Extensible forwarding feature..... | 79 | +| 186 | 7.6.3.17 | Extensible SS-Status..... | 79 | +| 187 | 7.6.3.18 | Extensible Forwarding Options..... | 80 | +| 188 | 7.6.3.19 | Extensible No reply condition timer..... | 80 | +| 189 | 7.6.3.20 | Extensible Call barring information..... | 80 | +| 190 | 7.6.3.21 | Extensible Call barring feature..... | 80 | +| 191 | 7.6.3.22 | CUG info..... | 80 | +| 192 | 7.6.3.23 | CUG subscription..... | 80 | +| 193 | 7.6.3.24 | CUG interlock..... | 81 | +| 194 | 7.6.3.25 | CUG index..... | 81 | +| 195 | 7.6.3.26 | CUG feature..... | 81 | +| 196 | 7.6.3.27 | Inter CUG options..... | 81 | +| 197 | 7.6.3.28 | Intra CUG restrictions..... | 81 | +| 198 | 7.6.3.29 | Extensible SS-Data..... | 81 | +| 199 | 7.6.3.30 | Subscriber State..... | 82 | +| 200 | 7.6.3.31 | Requested Info..... | 82 | +| 201 | 7.6.3.31A | Requested Domain..... | 82 | +| 202 | 7.6.3.32 | Suppression of Announcement..... | 82 | +| 203 | 7.6.3.33 | Suppress T-CSI..... | 82 | +| 204 | 7.6.3.34 | GMSC CAMEL Subscription Info..... | 82 | +| 205 | 7.6.3.35 | VLR CAMEL Subscription Info..... | 82 | +| 206 | 7.6.3.36 | Supported CAMEL Phases in the VLR..... | 82 | +| 207 | 7.6.3.36A | Supported CAMEL Phases in the SGSN..... | 82 | +| 208 | 7.6.3.36B | Offered CAMEL4 CSIs in the VLR..... | 82 | +| 209 | 7.6.3.36C | Offered CAMEL4 CSIs in the SGSN..... | 82 | +| 210 | 7.6.3.36D | Offered CAMEL4 CSIs..... | 82 | +| 211 | 7.6.3.36E | Offered CAMEL4 CSIs in interrogating node..... | 82 | +| 212 | 7.6.3.36F | Offered CAMEL4 CSIs in VMSC..... | 82 | +| 213 | 7.6.3.36G | Offered CAMEL4 Functionalities..... | 83 | +| 214 | 7.6.3.36H | Supported CAMEL Phases..... | 83 | +| 215 | 7.6.3.36I | Supported CAMEL Phases in interrogating node..... | 83 | +| 216 | 7.6.3.37 | CUG Subscription Flag..... | 83 | +| 217 | 7.6.3.38 | CAMEL Subscription Info Withdraw..... | 83 | +| 218 | 7.6.3.39 | Voice Group Call Service (VGCS) Data..... | 83 | +| 219 | 7.6.3.40 | Voice Broadcast Service (VBS) Data..... | 83 | +| 220 | 7.6.3.41 | ISDN bearer capability..... | 83 | +| 221 | 7.6.3.42 | Lower layer Compatibility..... | 83 | +| 222 | 7.6.3.43 | High Layer Compatibility..... | 83 | +| 223 | 7.6.3.44 | Alerting Pattern..... | 83 | +| 224 | 7.6.3.45 | GPRS Subscription Data Withdraw..... | 83 | +| 225 | 7.6.3.45A | EPS Subscription Data Withdraw..... | 83 | +| 226 | 7.6.3.46 | GPRS Subscription Data..... | 84 | +| 227 | 7.6.3.46A | EPS Subscription Data..... | 84 | +| 228 | 7.6.3.47 | QoS-Subscribed..... | 84 | +| 229 | 7.6.3.48 | VPLMN address allowed..... | 84 | +| 230 | 7.6.3.49 | Roaming Restricted In SGSN/MME Due To Unsupported Feature..... | 84 | +| 231 | 7.6.3.50 | Network Access Mode..... | 84 | +| 232 | 7.6.3.51 | Mobile Not Reachable Reason..... | 84 | +| 233 | 7.6.3.52 | Cancellation Type..... | 84 | +| 234 | 7.6.3.53 | All GPRS Data..... | 84 | +| 235 | 7.6.3.54 | Complete Data List Included..... | 84 | +| 236 | 7.6.3.55 | PDP Context Identifier..... | 84 | +| 237 | 7.6.3.56 | LSA Information..... | 84 | +| 238 | 7.6.3.57 | SoLSA support indicator..... | 85 | + +| | | | | +|-----|--------------------|--------------------------------------------------------|----| +| 239 | 7.6.3.58 | LSA Information Withdraw..... | 85 | +| 240 | 7.6.3.59 | LMU Indicator..... | 85 | +| 241 | 7.6.3.60 | LCS Information..... | 85 | +| 242 | 7.6.3.61 | GMLC List..... | 85 | +| 243 | 7.6.3.62 | LCS Privacy Exception List..... | 85 | +| 244 | 7.6.3.62A | Additional LCS Privacy Exception List..... | 85 | +| 245 | 7.6.3.63 | LCS Privacy Exception Parameters..... | 85 | +| 246 | 7.6.3.64 | External Client List..... | 86 | +| 247 | 7.6.3.65 | Internal Client List..... | 86 | +| 248 | 7.6.3.65A | MO-LR List..... | 86 | +| 249 | 7.6.3.65B | Privacy Notification to MS User..... | 86 | +| 250 | 7.6.3.65C | GMLC List Withdraw..... | 86 | +| 251 | 7.6.3.65D | Service Type List..... | 86 | +| 252 | 7.6.3.66 | IST Alert Timer..... | 86 | +| 253 | 7.6.3.67 | Call Termination Indicator..... | 86 | +| 254 | 7.6.3.68 | IST Information Withdraw..... | 86 | +| 255 | 7.6.3.69 | IST Support Indicator..... | 86 | +| 256 | 7.6.3.70 | Super-Charger Supported In HLR..... | 87 | +| 257 | 7.6.3.71 | Super-Charger Supported In Serving Network Entity..... | 87 | +| 258 | 7.6.3.72 | Age Indicator..... | 87 | +| 259 | 7.6.3.73 | GPRS enhancements support indicator..... | 87 | +| 260 | 7.6.3.74 | Extension QoS-Subscribed..... | 87 | +| 261 | 7.6.3.75 | SGSN CAMEL Subscription Info..... | 87 | +| 262 | 7.6.3.75A | Extension-2 QoS-Subscribed..... | 87 | +| 263 | 7.6.3.75B | Extension-3 QoS-Subscribed..... | 87 | +| 264 | 7.6.3.75C | Extension-4 QoS-Subscribed..... | 87 | +| 265 | 7.6.3.76 | MO-SMS-CSI..... | 87 | +| 266 | 7.6.3.76a | MT-SMS-CSI..... | 88 | +| 267 | 7.6.3.77 | GPRS-CSI..... | 88 | +| 268 | 7.6.3.78 | CAMEL subscription info..... | 88 | +| 269 | 7.6.3.83 | Call Barring Data..... | 88 | +| 270 | 7.6.3.84 | Call Forwarding Data..... | 88 | +| 271 | 7.6.3.85 | ODB Data..... | 89 | +| 272 | 7.6.3.86 | Requested Subscription Info..... | 89 | +| 273 | 7.6.3.87 | CS Allocation/Retention priority..... | 89 | +| 274 | 7.6.3.88 | ODB Info..... | 89 | +| 275 | 7.6.3.89 | Suppress VT-CSI..... | 89 | +| 276 | 7.6.3.90 | Suppress Incoming Call Barring..... | 89 | +| 277 | 7.6.3.91 | gsmSCF Initiated Call..... | 89 | +| 278 | 7.6.3.91a | SuppressMTSS..... | 89 | +| 279 | 7.6.3.92 | Call barring support indicator..... | 89 | +| 280 | 7.6.3.93 | MNP Info Result..... | 89 | +| 281 | 7.6.3.94 | Allowed Services..... | 89 | +| 282 | 7.6.3.95 | Unavailability Cause..... | 90 | +| 283 | 7.6.3.96 | MNP Requested Info..... | 90 | +| 284 | 7.6.3.97 | Access Restriction Data..... | 90 | +| 285 | 7.6.3.98 | Supported RAT types indicator..... | 90 | +| 286 | 7.6.3.99 | UE SRVCC Capability..... | 90 | +| 287 | 7.6.3.100 | Temporary Empty CSG Subscription data Indicator..... | 90 | +| 288 | 7.6.3.101 | WLAN-offloadability..... | 90 | +| 289 | 7.6.3.102 | IMSI-Group-Id..... | 90 | +| 290 | 7.6.4 | Supplementary services parameters..... | 90 | +| 291 | 7.6.4.1 | SS-Code..... | 90 | +| 292 | 7.6.4.1A | SS-Code 2..... | 91 | +| 293 | 7.6.4.2 | SS-Status..... | 91 | +| 294 | 7.6.4.3 | SS-Data..... | 91 | +| 295 | 7.6.4.4 | Override Category..... | 91 | +| 296 | 7.6.4.5 | CLI Restriction Option..... | 91 | +| 297 | 7.6.4.6 | Forwarding Options..... | 92 | +| 298 | 7.6.4.7 | No reply condition timer..... | 92 | +| 299 | 7.6.4.8 - 7.6.4.14 | Void..... | 92 | + +| | | | | +|-----|---------------------|--------------------------------------------------|----| +| 300 | 7.6.4.15 | Forwarding information..... | 92 | +| 301 | 7.6.4.16 | Forwarding feature..... | 92 | +| 302 | 7.6.4.17 | Void..... | 92 | +| 303 | 7.6.4.18 | Call barring information..... | 92 | +| 304 | 7.6.4.19 | Call barring feature..... | 93 | +| 305 | 7.6.4.20 | New password..... | 93 | +| 306 | 7.6.4.21 | Current password..... | 93 | +| 307 | 7.6.4.22 | Guidance information..... | 93 | +| 308 | 7.6.4.23 | Void..... | 93 | +| 309 | 7.6.4.24 | SS-Info..... | 93 | +| 310 | 7.6.4.25 - 7.6.4.35 | Void..... | 93 | +| 311 | 7.6.4.36 | USSD Data Coding Scheme..... | 94 | +| 312 | 7.6.4.37 | USSD String..... | 94 | +| 313 | 7.6.4.38 | Bearer service..... | 94 | +| 314 | 7.6.4.38A | Bearer Service 2..... | 94 | +| 315 | 7.6.4.39 | Teleservice..... | 94 | +| 316 | 7.6.4.39A | Teleservice 2..... | 94 | +| 317 | 7.6.4.40 | Basic Service Group..... | 94 | +| 318 | 7.6.4.41 | eMLPP information..... | 94 | +| 319 | 7.6.4.42 | SS-event..... | 94 | +| 320 | 7.6.4.43 | SS-event data..... | 95 | +| 321 | 7.6.4.44 | LCS Privacy Exceptions..... | 95 | +| 322 | 7.6.4.45 | Mobile Originating Location Request (MO-LR)..... | 95 | +| 323 | 7.6.4.46 | NbrUser..... | 95 | +| 324 | 7.6.4.47 | MC Subscription Data..... | 95 | +| 325 | 7.6.4.48 | MC Information..... | 95 | +| 326 | 7.6.4.49 | CCBS Request State..... | 96 | +| 327 | 7.6.4.50 | Basic Service Group 2..... | 96 | +| 328 | 7.6.5 | Call parameters..... | 96 | +| 329 | 7.6.5.1 | Call reference number..... | 96 | +| 330 | 7.6.5.2 | Interrogation type..... | 96 | +| 331 | 7.6.5.3 | OR interrogation..... | 96 | +| 332 | 7.6.5.4 | OR capability..... | 96 | +| 333 | 7.6.5.5 | Forwarding reason..... | 96 | +| 334 | 7.6.5.6 | Forwarding interrogation required..... | 97 | +| 335 | 7.6.5.7 | O-CSI..... | 97 | +| 336 | 7.6.5.7A | D-CSI..... | 97 | +| 337 | 7.6.5.7B | T-CSI..... | 97 | +| 338 | 7.6.5.7C | VT-CSI..... | 97 | +| 339 | 7.6.5.7D | O-IM-CSI..... | 97 | +| 340 | 7.6.5.7E | D-IM-CSI..... | 97 | +| 341 | 7.6.5.7F | VT-IM-CSI..... | 97 | +| 342 | 7.6.5.8 | Void..... | 97 | +| 343 | 7.6.5.9 | Void..... | 97 | +| 344 | 7.6.5.10 | Void..... | 97 | +| 345 | 7.6.5.11 | CCBS Feature..... | 97 | +| 346 | 7.6.5.12 | UU Data..... | 98 | +| 347 | 7.6.5.14 | Number Portability Status..... | 98 | +| 348 | 7.6.5.15 | Pre-paging supported..... | 98 | +| 349 | 7.6.5.16 | MT Roaming Retry Supported..... | 98 | +| 350 | 7.6.5.17 | MT Roaming Retry..... | 98 | +| 351 | 7.6.5.18 | Paging Area..... | 98 | +| 352 | 7.6.5.19 | Call Priority..... | 98 | +| 353 | 7.6.5.20 | MTRF Supported..... | 98 | +| 354 | 7.6.5.21 | LCLS Global Call Reference (LCLS GCR)..... | 98 | +| 355 | 7.6.5.22 | LCLS-Negotiation..... | 98 | +| 356 | 7.6.5.23 | LCLS-Configuration-Preference..... | 98 | +| 357 | 7.6.6 | Radio parameters..... | 98 | +| 358 | 7.6.6.1 - 7.6.6.3 | Void..... | 99 | +| 359 | 7.6.6.4 | GERAN Classmark..... | 99 | +| 360 | 7.6.6.5 | BSSMAP Service Handover..... | 99 | + +| | | | | +|-----|-----------|-------------------------------------------------|-----| +| 361 | 7.6.6.5A | BSSMAP Service Handover List..... | 99 | +| 362 | 7.6.6.6 | RANAP Service Handover..... | 99 | +| 363 | 7.6.6.7 | HO-Number Not Required..... | 99 | +| 364 | 7.6.6.8 | Integrity Protection Information..... | 99 | +| 365 | 7.6.6.9 | Encryption Information..... | 99 | +| 366 | 7.6.6.10 | Radio Resource Information..... | 99 | +| 367 | 7.6.6.10A | Radio Resource List..... | 99 | +| 368 | 7.6.6.10B | Chosen Radio Resource Information..... | 99 | +| 369 | 7.6.6.11 | Key Status..... | 99 | +| 370 | 7.6.6.12 | Selected UMTS Algorithms..... | 99 | +| 371 | 7.6.6.13 | Allowed GSM Algorithms..... | 99 | +| 372 | 7.6.6.14 | Allowed UMTS Algorithms..... | 100 | +| 373 | 7.6.6.15 | Selected GSM Algorithm..... | 100 | +| 374 | 7.6.6.16 | Iu-Currently Used Codec..... | 100 | +| 375 | 7.6.6.17 | Iu-Supported Codecs List..... | 100 | +| 376 | 7.6.6.17A | Iu-Available Codecs List..... | 100 | +| 377 | 7.6.6.18 | Iu-Selected Codec..... | 100 | +| 378 | 7.6.6.19 | RAB Configuration Indicator..... | 100 | +| 379 | 7.6.6.20 | UESBI-Iu..... | 100 | +| 380 | 7.6.6.21 | Alternative Channel Type..... | 100 | +| 381 | 7.6.6.22 | AoIP-Supported Codecs List Anchor..... | 100 | +| 382 | 7.6.6.23 | AoIP-Available Codecs List Map..... | 100 | +| 383 | 7.6.6.24 | AoIP-Selected Codec Target..... | 100 | +| 384 | 7.6.7 | Authentication parameters..... | 101 | +| 385 | 7.6.7.1 | Authentication set list..... | 101 | +| 386 | 7.6.7.2 | Rand..... | 101 | +| 387 | 7.6.7.3 | Sres..... | 101 | +| 388 | 7.6.7.4 | Kc..... | 101 | +| 389 | 7.6.7.5 | Xres..... | 101 | +| 390 | 7.6.7.5A | Ck..... | 101 | +| 391 | 7.6.7.5B | Ik..... | 101 | +| 392 | 7.6.7.5C | Autn..... | 101 | +| 393 | 7.6.7.5D | KASME..... | 101 | +| 394 | 7.6.7.6 | Cksn..... | 101 | +| 395 | 7.6.7.6A | Ksi..... | 101 | +| 396 | 7.6.7.6B | Auts..... | 101 | +| 397 | 7.6.7.7 | Ciphering mode..... | 102 | +| 398 | 7.6.7.8 | Current Security Context..... | 102 | +| 399 | 7.6.7.9 | Failure cause..... | 102 | +| 400 | 7.6.7.10 | Re-attempt..... | 102 | +| 401 | 7.6.7.11 | Access Type..... | 102 | +| 402 | 7.6.8 | Short message parameters..... | 102 | +| 403 | 7.6.8.1 | SM-RP-DA..... | 102 | +| 404 | 7.6.8.2 | SM-RP-OA..... | 102 | +| 405 | 7.6.8.3 | MWD status..... | 102 | +| 406 | 7.6.8.4 | SM-RP-UI..... | 103 | +| 407 | 7.6.8.5 | SM-RP-PRI..... | 103 | +| 408 | 7.6.8.6 | SM Delivery Outcome..... | 103 | +| 409 | 7.6.8.7 | More Messages To Send..... | 103 | +| 410 | 7.6.8.8 | Alert Reason..... | 103 | +| 411 | 7.6.8.9 | Absent Subscriber Diagnostic SM..... | 103 | +| 412 | 7.6.8.10 | Alert Reason Indicator..... | 103 | +| 413 | 7.6.8.10A | Additional Alert Reason Indicator..... | 103 | +| 414 | 7.6.8.11 | Additional SM Delivery Outcome..... | 103 | +| 415 | 7.6.8.12 | Additional Absent Subscriber Diagnostic SM..... | 103 | +| 416 | 7.6.8.13 | Delivery Outcome Indicator..... | 104 | +| 417 | 7.6.8.14 | GPRS Node Indicator..... | 104 | +| 418 | 7.6.8.14A | IMS Node Indicator..... | 104 | +| 419 | 7.6.8.15 | GPRS Support Indicator..... | 104 | +| 420 | 7.6.8.16 | SM-RP-MTI..... | 104 | +| 421 | 7.6.8.17 | SM-RP-SMEA..... | 104 | + +| | | | | +|-----|-----------|------------------------------------------------------|-----| +| 422 | 7.6.8.18 | IP-SM-GW SM Delivery Outcome..... | 104 | +| 423 | 7.6.8.19 | IP-SM-GW Absent Subscriber Diagnostic SM..... | 104 | +| 424 | 7.6.8.20 | IP-SM-GW Indicator..... | 104 | +| 425 | 7.6.8.21 | SM Delivery Timer..... | 104 | +| 426 | 7.6.8.22 | SM Delivery Start Time..... | 104 | +| 427 | 7.6.8.23 | Maximum Retransmission Time..... | 104 | +| 428 | 7.6.8.24 | Requested Retransmission Time..... | 104 | +| 429 | 7.6.8.25 | Maximum UE Availability Time..... | 105 | +| 430 | 7.6.8.26 | SMS-GMSC Alert Event..... | 105 | +| 431 | 7.6.8.27 | SMS-GMSC Address..... | 105 | +| 432 | 7.6.8.28 | SMS-GMSC Diameter Address..... | 105 | +| 433 | 7.6.8.29 | New SGSN Number..... | 105 | +| 434 | 7.6.8.30 | New MME Number..... | 105 | +| 435 | 7.6.8.31 | New SGSN Diameter Address..... | 105 | +| 436 | 7.6.8.32 | New MME Diameter Address..... | 105 | +| 437 | 7.6.8.33 | New MSC Number..... | 105 | +| 438 | 7.6.8.34 | SMSF 3GPP Absent Subscriber Diagnostic SM..... | 105 | +| 439 | 7.6.8.35 | SMSF Non 3GPP Absent Subscriber Diagnostic SM..... | 105 | +| 440 | 7.6.8.36 | SMSF 3GPP Delivery Outcome Indicator..... | 105 | +| 441 | 7.6.8.37 | SMSF Non-3GPP Delivery Outcome Indicator..... | 106 | +| 442 | 7.6.8.38 | SMSF 3GPP SM Delivery Outcome..... | 106 | +| 443 | 7.6.8.39 | SMSF Non-3GPP SM Delivery Outcome..... | 106 | +| 444 | 7.6.8.40 | SMSF 3GPP Absent Subscriber Diagnostic SM..... | 106 | +| 445 | 7.6.8.41 | SMSF Non 3GPP Absent Subscriber Diagnostic SM..... | 106 | +| 446 | 7.6.9 | Access and signalling system related parameters..... | 106 | +| 447 | 7.6.9.1 | AN-apdu..... | 106 | +| 448 | 7.6.9.2 | CM service type..... | 106 | +| 449 | 7.6.9.3 | Access connection status..... | 106 | +| 450 | 7.6.9.4 | External Signal Information..... | 107 | +| 451 | 7.6.9.5 | Access signalling information..... | 107 | +| 452 | 7.6.9.6 | Location update type..... | 107 | +| 453 | 7.6.9.7 | Protocol ID..... | 107 | +| 454 | 7.6.9.8 | Network signal information..... | 107 | +| 455 | 7.6.9.8A | Network signal information 2..... | 108 | +| 456 | 7.6.9.9 | Call Info..... | 108 | +| 457 | 7.6.9.10 | Additional signal info..... | 108 | +| 458 | 7.6.10 | System operations parameters..... | 108 | +| 459 | 7.6.10.1 | Network resources..... | 109 | +| 460 | 7.6.10.2 | Trace reference..... | 109 | +| 461 | 7.6.10.2A | Trace reference 2..... | 109 | +| 462 | 7.6.10.3 | Trace type..... | 109 | +| 463 | 7.6.10.4 | Additional network resources..... | 109 | +| 464 | 7.6.10.5 | Trace depth list..... | 109 | +| 465 | 7.6.10.6 | Trace NE type list..... | 109 | +| 466 | 7.6.10.7 | Trace interface list..... | 109 | +| 467 | 7.6.10.8 | Trace event list..... | 109 | +| 468 | 7.6.10.9 | Trace support indicator..... | 110 | +| 469 | 7.6.10.10 | Trace Propagation List..... | 110 | +| 470 | 7.6.10.11 | MDT-Configuration..... | 110 | +| 471 | 7.6.10.12 | MDT User Consent..... | 110 | +| 472 | 7.6.11 | Location Service Parameters..... | 110 | +| 473 | 7.6.11.1 | Age of Location Estimate..... | 110 | +| 474 | 7.6.11.2 | Deferred MT-LR Response Indicator..... | 110 | +| 475 | 7.6.11.3 | Deferred MT-LR Data..... | 110 | +| 476 | 7.6.11.4 | LCS Client ID..... | 110 | +| 477 | 7.6.11.5 | LCS Event..... | 110 | +| 478 | 7.6.11.7 | LCS Priority..... | 110 | +| 479 | 7.6.11.8 | LCS QoS..... | 110 | +| 480 | 7.6.11.9 | CS LCS Not Supported by UE..... | 111 | +| 481 | 7.6.11.10 | PS LCS Not Supported by UE..... | 111 | +| 482 | 7.6.11.11 | Location Estimate..... | 111 | + +| | | | | +|-----|------------|--------------------------------------------------------------------------|-----| +| 483 | 7.6.11.11A | GERAN Positioning Data..... | 111 | +| 484 | 7.6.11.11B | UTRAN Positioning Data..... | 111 | +| 485 | 7.6.11.11C | GERAN GANSS Positioning Data..... | 112 | +| 486 | 7.6.11.11D | UTRAN GANSS Positioning Data..... | 112 | +| 487 | 7.6.11.11E | UTRAN Additional Positioning Data..... | 112 | +| 488 | 7.6.11.11F | UTRAN Barometric Pressure Measurement..... | 112 | +| 489 | 7.6.11.11G | UTRAN Civic Address..... | 112 | +| 490 | 7.6.11.12 | Location Type..... | 112 | +| 491 | 7.6.11.13 | NA-ESRD..... | 112 | +| 492 | 7.6.11.14 | NA-ESRK..... | 112 | +| 493 | 7.6.11.15 | LCS Service Type Id..... | 112 | +| 494 | 7.6.11.16 | Privacy Override..... | 112 | +| 495 | 7.6.11.17 | Supported LCS Capability Sets..... | 113 | +| 496 | 7.6.11.18 | LCS Codeword..... | 113 | +| 497 | 7.6.11.19 | NA-ESRK Request..... | 113 | +| 498 | 7.6.11.20 | Supported GAD Shapes..... | 113 | +| 499 | 7.6.11.21 | Additional Location Estimate..... | 113 | +| 500 | 7.6.11.22 | Cell Id Or SAI..... | 113 | +| 501 | 7.6.11.23 | LCS-Reference Number..... | 113 | +| 502 | 7.6.11.24 | LCS Privacy Check..... | 113 | +| 503 | 7.6.11.25 | Additional LCS Capability Sets..... | 114 | +| 504 | 7.6.11.26 | Area Event Info..... | 114 | +| 505 | 7.6.11.27 | Velocity Estimate..... | 114 | +| 506 | 7.6.11.28 | Accuracy Fulfilment Indicator..... | 114 | +| 507 | 7.6.11.29 | MO-LR Short Circuit Indicator..... | 114 | +| 508 | 7.6.11.30 | Reporting PLMN List..... | 114 | +| 509 | 7.6.11.31 | Periodic LDR information..... | 114 | +| 510 | 7.6.11.32 | Sequence Number..... | 114 | +| 511 | 7.6.12 | Void..... | 114 | +| 512 | 7.7 | Representation of a list of a basic parameter in service-primitives..... | 114 | +| 513 | 8 | Mobility services..... | 115 | +| 514 | 8.1 | Location management services..... | 115 | +| 515 | 8.1.1 | Void..... | 115 | +| 516 | 8.1.1.1 | Void..... | 115 | +| 517 | 8.1.1.2 | Void..... | 115 | +| 518 | 8.1.1.3 | Void..... | 115 | +| 519 | 8.1.2 | MAP_UPDATE_LOCATION service..... | 115 | +| 520 | 8.1.2.1 | Definition..... | 115 | +| 521 | 8.1.2.2 | Service primitives..... | 115 | +| 522 | 8.1.2.3 | Parameter definitions and use..... | 116 | +| 523 | 8.1.3 | MAP_CANCEL_LOCATION service..... | 119 | +| 524 | 8.1.3.1 | Definition..... | 119 | +| 525 | 8.1.3.2 | Service primitives..... | 119 | +| 526 | 8.1.3.3 | Parameter definitions and use..... | 119 | +| 527 | 8.1.4 | MAP_SEND_IDENTIFICATION service..... | 120 | +| 528 | 8.1.4.1 | Definition..... | 120 | +| 529 | 8.1.4.2 | Service primitives..... | 120 | +| 530 | 8.1.4.3 | Parameter definitions and use..... | 121 | +| 531 | 8.1.5 | Void..... | 122 | +| 532 | 8.1.5.1 | Void..... | 122 | +| 533 | 8.1.5.2 | Void..... | 122 | +| 534 | 8.1.5.3 | Void..... | 122 | +| 535 | 8.1.6 | MAP_PURGE_MS service..... | 122 | +| 536 | 8.1.6.1 | Definition..... | 122 | +| 537 | 8.1.6.2 | Service primitives..... | 123 | +| 538 | 8.1.6.3 | Parameter definitions and use..... | 123 | +| 539 | 8.1.7 | MAP_UPDATE_GPRS_LOCATION service..... | 124 | +| 540 | 8.1.7.1 | Definition..... | 124 | +| 541 | 8.1.7.2 | Service primitives..... | 124 | +| 542 | 8.1.7.3 | Parameter definitions and use..... | 125 | +| 543 | 8.1.8 | MAP-NOTE-MM-EVENT..... | 129 | + +| | | | | +|-----|----------|----------------------------------------------|-----| +| 544 | 8.1.8.1 | Definition..... | 129 | +| 545 | 8.1.8.2 | Service primitives..... | 129 | +| 546 | 8.1.8.3 | Parameter use..... | 130 | +| 547 | 8.1.9 | MAP_UPDATE_VCSG_LOCATION service..... | 131 | +| 548 | 8.1.9.1 | Definition..... | 131 | +| 549 | 8.1.9.2 | Service primitives..... | 131 | +| 550 | 8.1.9.3 | Parameter definitions and use..... | 131 | +| 551 | 8.1.10 | MAP_CANCEL_VCSG_LOCATION service..... | 132 | +| 552 | 8.1.10.1 | Definition..... | 132 | +| 553 | 8.1.10.2 | Service primitives..... | 132 | +| 554 | 8.1.10.3 | Parameter definitions and use..... | 132 | +| 555 | 8.2 | Paging and search..... | 133 | +| 556 | 8.2.1 | MAP_PAGE service..... | 133 | +| 557 | 8.2.1.1 | Definition..... | 133 | +| 558 | 8.2.1.2 | Service primitives..... | 133 | +| 559 | 8.2.1.3 | Parameter definitions and use..... | 133 | +| 560 | 8.2.2 | MAP_SEARCH_FOR_MS service..... | 134 | +| 561 | 8.2.2.1 | Definition..... | 134 | +| 562 | 8.2.2.2 | Service primitives..... | 134 | +| 563 | 8.2.2.3 | Parameter definitions and use..... | 134 | +| 564 | 8.3 | Access management services..... | 135 | +| 565 | 8.3.1 | MAP_PROCESS_ACCESS_REQUEST service..... | 135 | +| 566 | 8.3.1.1 | Definition..... | 135 | +| 567 | 8.3.1.2 | Service primitives..... | 135 | +| 568 | 8.3.1.3 | Parameter definitions and use..... | 135 | +| 569 | 8.4 | Handover services..... | 136 | +| 570 | 8.4.1 | MAP_PREPARE_HANDOVER service..... | 136 | +| 571 | 8.4.1.1 | Definition..... | 137 | +| 572 | 8.4.1.2 | Service primitives..... | 137 | +| 573 | 8.4.1.3 | Parameter use..... | 137 | +| 574 | 8.4.2 | MAP_SEND_END_SIGNAL service..... | 141 | +| 575 | 8.4.2.1 | Definition..... | 141 | +| 576 | 8.4.2.2 | Service primitives..... | 142 | +| 577 | 8.4.2.3 | Parameter use..... | 142 | +| 578 | 8.4.3 | MAP_PROCESS_ACCESS_SIGNALLING service..... | 142 | +| 579 | 8.4.3.1 | Definition..... | 142 | +| 580 | 8.4.3.2 | Service primitives..... | 142 | +| 581 | 8.4.3.3 | Parameter use..... | 142 | +| 582 | 8.4.4 | MAP_FORWARD_ACCESS_SIGNALLING service..... | 144 | +| 583 | 8.4.4.1 | Definition..... | 144 | +| 584 | 8.4.4.2 | Service primitives..... | 144 | +| 585 | 8.4.4.3 | Parameter use..... | 144 | +| 586 | 8.4.5 | MAP_PREPARE_SUBSEQUENT_HANDOVER service..... | 147 | +| 587 | 8.4.5.1 | Definition..... | 147 | +| 588 | 8.4.5.2 | Service primitives..... | 147 | +| 589 | 8.4.5.3 | Parameter use..... | 147 | +| 590 | 8.4.6 | MAP_ALLOCATE_HANDOVER_NUMBER service..... | 148 | +| 591 | 8.4.6.1 | Definition..... | 148 | +| 592 | 8.4.6.2 | Service primitives..... | 148 | +| 593 | 8.4.6.3 | Parameter use..... | 148 | +| 594 | 8.4.7 | MAP_SEND_HANDOVER_REPORT service..... | 148 | +| 595 | 8.4.7.1 | Definition..... | 148 | +| 596 | 8.4.7.2 | Service primitives..... | 149 | +| 597 | 8.4.7.3 | Parameter use..... | 149 | +| 598 | 8.5 | Authentication management services..... | 149 | +| 599 | 8.5.1 | MAP_AUTHENTICATE service..... | 149 | +| 600 | 8.5.1.1 | Definition..... | 149 | +| 601 | 8.5.1.2 | Service primitives..... | 149 | +| 602 | 8.5.1.3 | Parameter use..... | 150 | +| 603 | 8.5.2 | MAP_SEND_AUTHENTICATION_INFO service..... | 150 | +| 604 | 8.5.2.1 | Definition..... | 150 | + +| | | | | +|-----|----------|--------------------------------------------------------------------|-----| +| 605 | 8.5.2.2 | Service primitives..... | 151 | +| 606 | 8.5.2.3 | Parameter use..... | 151 | +| 607 | 8.5.3 | MAP_AUTHENTICATION_FAILURE_REPORT service..... | 153 | +| 608 | 8.5.3.1 | Definition..... | 153 | +| 609 | 8.5.3.2 | Service primitives..... | 153 | +| 610 | 8.5.3.3 | Parameter use..... | 153 | +| 611 | 8.6 | Security management services..... | 154 | +| 612 | 8.6.1 | MAP_SET_CIPHERING_MODE service..... | 154 | +| 613 | 8.6.1.1 | Definitions..... | 154 | +| 614 | 8.6.1.2 | Service primitives..... | 154 | +| 615 | 8.6.1.3 | Parameter use..... | 154 | +| 616 | 8.7 | International mobile equipment identities management services..... | 154 | +| 617 | 8.7.1 | MAP_CHECK_IMEI service..... | 154 | +| 618 | 8.7.1.1 | Definition..... | 154 | +| 619 | 8.7.1.2 | Service primitives..... | 155 | +| 620 | 8.7.1.3 | Parameter use..... | 155 | +| 621 | 8.7.2 | MAP_OBTAIN_IMEI service..... | 156 | +| 622 | 8.7.2.1 | Definition..... | 156 | +| 623 | 8.7.2.2 | Service primitives..... | 156 | +| 624 | 8.7.2.3 | Parameter use..... | 156 | +| 625 | 8.8 | Subscriber management services..... | 156 | +| 626 | 8.8.1 | MAP-INSERT-SUBSCRIBER-DATA service..... | 156 | +| 627 | 8.8.1.1 | Definition..... | 156 | +| 628 | 8.8.1.2 | Service primitives..... | 157 | +| 629 | 8.8.1.3 | Parameter use..... | 158 | +| 630 | 8.8.1.4 | Basic service information related to supplementary services..... | 172 | +| 631 | 8.8.2 | MAP-DELETE-SUBSCRIBER-DATA service..... | 173 | +| 632 | 8.8.2.1 | Definition..... | 173 | +| 633 | 8.8.2.2 | Service primitives..... | 173 | +| 634 | 8.8.2.3 | Parameter use..... | 174 | +| 635 | 8.9 | Identity management services..... | 178 | +| 636 | 8.9.1 | MAP-PROVIDE-IMSI service..... | 178 | +| 637 | 8.9.1.1 | Definition..... | 179 | +| 638 | 8.9.1.2 | Service primitives..... | 179 | +| 639 | 8.9.1.3 | Parameter use..... | 179 | +| 640 | 8.9.2 | MAP-FORWARD-NEW-TMSI service..... | 179 | +| 641 | 8.9.2.1 | Definition..... | 179 | +| 642 | 8.9.2.2 | Service primitives..... | 179 | +| 643 | 8.9.2.3 | Parameter use..... | 179 | +| 644 | 8.10 | Fault recovery services..... | 179 | +| 645 | 8.10.1 | MAP_RESET service..... | 179 | +| 646 | 8.10.1.1 | Definition..... | 180 | +| 647 | 8.10.1.2 | Service primitives..... | 180 | +| 648 | 8.10.1.3 | Parameter definition and use..... | 180 | +| 649 | 8.10.2 | MAP_FORWARD_CHECK_SS_INDICATION service..... | 181 | +| 650 | 8.10.2.1 | Definition..... | 181 | +| 651 | 8.10.2.2 | Service primitives..... | 181 | +| 652 | 8.10.2.3 | Parameter definition and use..... | 181 | +| 653 | 8.10.3 | MAP_RESTORE_DATA service..... | 182 | +| 654 | 8.10.3.1 | Definition..... | 182 | +| 655 | 8.10.3.2 | Service primitives..... | 182 | +| 656 | 8.10.3.3 | Parameter definitions and use..... | 182 | +| 657 | 8.11 | Subscriber Information services..... | 184 | +| 658 | 8.11.1 | MAP-ANY-TIME-INTERROGATION service..... | 184 | +| 659 | 8.11.1.1 | Definition..... | 184 | +| 660 | 8.11.1.2 | Service primitives..... | 184 | +| 661 | 8.11.1.3 | Parameter definition and use..... | 185 | +| 662 | 8.11.2 | MAP-PROVIDE-SUBSCRIBER-INFO service..... | 186 | +| 663 | 8.11.2.1 | Definition..... | 186 | +| 664 | 8.11.2.2 | Service primitives..... | 186 | +| 665 | 8.11.2.3 | Parameter definition and use..... | 186 | + +| | | | | +|-----|----------|------------------------------------------------------|-----| +| 666 | 8.11.3 | MAP-ANY-TIME-SUBSCRIPTION-INTERROGATION service..... | 187 | +| 667 | 8.11.3.1 | Definition..... | 187 | +| 668 | 8.11.3.2 | Service primitives..... | 187 | +| 669 | 8.11.3.3 | Parameter definition and use..... | 188 | +| 670 | 8.11.4 | MAP-ANY-TIME-MODIFICATION service..... | 189 | +| 671 | 8.11.4.1 | Definition..... | 189 | +| 672 | 8.11.4.2 | Service primitives..... | 189 | +| 673 | 8.11.4.3 | Parameter definition and use..... | 189 | +| 674 | 8.11.5 | MAP-NOTE-SUBSCRIBER-DATA-MODIFIED service..... | 190 | +| 675 | 8.11.5.1 | Definition..... | 190 | +| 676 | 8.11.5.2 | Service primitives..... | 190 | +| 677 | 8.11.5.3 | Parameter definition and use..... | 191 | +| 678 | 9 | Operation and maintenance services..... | 192 | +| 679 | 9.1 | Subscriber tracing services..... | 192 | +| 680 | 9.1.1 | MAP-ACTIVATE-TRACE-MODE service..... | 192 | +| 681 | 9.1.1.1 | Definition..... | 192 | +| 682 | 9.1.1.2 | Service primitives..... | 193 | +| 683 | 9.1.1.3 | Parameter use..... | 193 | +| 684 | 9.1.2 | MAP-DEACTIVATE-TRACE-MODE service..... | 194 | +| 685 | 9.1.2.1 | Definition..... | 194 | +| 686 | 9.1.2.2 | Service primitives..... | 194 | +| 687 | 9.1.2.3 | Parameter use..... | 194 | +| 688 | 9.1.3 | MAP-TRACE-SUBSCRIBER-ACTIVITY service..... | 195 | +| 689 | 9.1.3.1 | Definition..... | 195 | +| 690 | 9.1.3.2 | Service primitives..... | 195 | +| 691 | 9.1.3.3 | Parameter use..... | 195 | +| 692 | 9.2 | Other operation and maintenance services..... | 196 | +| 693 | 9.2.1 | MAP-SEND-IMSI service..... | 196 | +| 694 | 9.2.1.1 | Definition..... | 196 | +| 695 | 9.2.1.2 | Service primitives..... | 196 | +| 696 | 9.2.1.3 | Parameter use..... | 196 | +| 697 | 10 | Call handling services..... | 196 | +| 698 | 10.1 | MAP_SEND_ROUTING_INFORMATION service..... | 196 | +| 699 | 10.1.1 | Definition..... | 196 | +| 700 | 10.1.2 | Service primitives..... | 196 | +| 701 | 10.1.3 | Parameter use..... | 197 | +| 702 | 10.2 | MAP_PROVIDE_ROAMING_NUMBER service..... | 203 | +| 703 | 10.2.1 | Definition..... | 203 | +| 704 | 10.2.2 | Service primitives..... | 203 | +| 705 | 10.2.3 | Parameter use..... | 204 | +| 706 | 10.3 | MAP_RESUME_CALL_HANDLING service..... | 206 | +| 707 | 10.3.1 | Definition..... | 206 | +| 708 | 10.3.2 | Service primitives..... | 206 | +| 709 | 10.3.3 | Parameter use..... | 207 | +| 710 | 10.4 | MAP_PREPARE_GROUP_CALL service..... | 208 | +| 711 | 10.4.1 | Definition..... | 208 | +| 712 | 10.4.2 | Service primitives..... | 208 | +| 713 | 10.4.3 | Parameter definitions and use..... | 209 | +| 714 | 10.5 | MAP_PROCESS_GROUP_CALL_SIGNALLING service..... | 210 | +| 715 | 10.5.1 | Definitions..... | 210 | +| 716 | 10.5.2 | Service primitives..... | 210 | +| 717 | 10.5.3 | Parameter definitions and use..... | 210 | +| 718 | 10.6 | MAP_FORWARD_GROUP_CALL_SIGNALLING service..... | 211 | +| 719 | 10.6.1 | Definitions..... | 211 | +| 720 | 10.6.2 | Service primitives..... | 211 | +| 721 | 10.6.3 | Parameter definitions and use..... | 211 | +| 722 | 10.7 | MAP_SEND_GROUP_CALL_END_SIGNAL service..... | 212 | +| 723 | 10.7.1 | Definitions..... | 212 | +| 724 | 10.7.2 | Service primitives..... | 213 | +| 725 | 10.7.3 | Parameter definitions and use..... | 213 | + +| | | | | +|-----|---------|--------------------------------------------------|-----| +| 726 | 10.7A | MAP_SEND_GROUP_CALL_INFO service..... | 213 | +| 727 | 10.7A.1 | Definitions..... | 213 | +| 728 | 10.7A.2 | Service primitives..... | 213 | +| 729 | 10.7A.3 | Parameter definitions and use..... | 214 | +| 730 | 10.8 | Void..... | 215 | +| 731 | 10.9 | Void..... | 215 | +| 732 | 10.10 | MAP_SET_REPORTING_STATE service..... | 215 | +| 733 | 10.10.1 | Definition..... | 215 | +| 734 | 10.10.2 | Service primitives..... | 215 | +| 735 | 10.10.3 | Parameter use..... | 215 | +| 736 | 10.11 | MAP_STATUS_REPORT service..... | 216 | +| 737 | 10.11.1 | Definition..... | 216 | +| 738 | 10.11.2 | Service primitives..... | 216 | +| 739 | 10.11.3 | Parameter use..... | 216 | +| 740 | 10.12 | MAP_REMOTE_USER_FREE service..... | 217 | +| 741 | 10.12.1 | Definition..... | 217 | +| 742 | 10.12.2 | Service primitives..... | 217 | +| 743 | 10.12.3 | Parameter use..... | 217 | +| 744 | 10.13 | MAP_IST_ALERT service..... | 218 | +| 745 | 10.13.1 | Definition..... | 218 | +| 746 | 10.13.2 | Service primitives..... | 218 | +| 747 | 10.13.3 | Parameter use..... | 218 | +| 748 | 10.14 | MAP_IST_COMMAND service..... | 219 | +| 749 | 10.14.1 | Definition..... | 219 | +| 750 | 10.14.2 | Service primitives..... | 219 | +| 751 | 10.14.3 | Parameter use..... | 219 | +| 752 | 10.15 | MAP_RELEASE_RESOURCES service..... | 220 | +| 753 | 10.15.1 | Definition..... | 220 | +| 754 | 10.15.2 | Service primitives..... | 220 | +| 755 | 10.15.3 | Parameter use..... | 220 | +| 756 | 11 | Supplementary services related services..... | 220 | +| 757 | 11.1 | MAP_REGISTER_SS service..... | 220 | +| 758 | 11.1.1 | Definition..... | 220 | +| 759 | 11.1.2 | Service primitives..... | 220 | +| 760 | 11.1.3 | Parameter use..... | 221 | +| 761 | 11.2 | MAP_ERASE_SS service..... | 222 | +| 762 | 11.2.1 | Definition..... | 222 | +| 763 | 11.2.2 | Service primitives..... | 222 | +| 764 | 11.2.3 | Parameter use..... | 222 | +| 765 | 11.3 | MAP_ACTIVATE_SS service..... | 223 | +| 766 | 11.3.1 | Definition..... | 223 | +| 767 | 11.3.2 | Service primitives..... | 223 | +| 768 | 11.3.3 | Parameter use..... | 223 | +| 769 | 11.4 | MAP_DEACTIVATE_SS service..... | 224 | +| 770 | 11.4.1 | Definitions..... | 224 | +| 771 | 11.4.2 | Service primitives..... | 225 | +| 772 | 11.4.3 | Parameter use..... | 225 | +| 773 | 11.5 | MAP_INTERROGATE_SS service..... | 226 | +| 774 | 11.5.1 | Definitions..... | 226 | +| 775 | 11.5.2 | Service primitives..... | 226 | +| 776 | 11.5.3 | Parameter use..... | 226 | +| 777 | 11.6 | Void..... | 228 | +| 778 | 11.7 | MAP_REGISTER_PASSWORD service..... | 228 | +| 779 | 11.7.1 | Definitions..... | 228 | +| 780 | 11.7.2 | Service primitives..... | 228 | +| 781 | 11.7.3 | Parameter use..... | 228 | +| 782 | 11.8 | MAP_GET_PASSWORD service..... | 229 | +| 783 | 11.8.1 | Definitions..... | 229 | +| 784 | 11.8.2 | Service primitives..... | 229 | +| 785 | 11.8.3 | Parameter use..... | 229 | +| 786 | 11.9 | MAP_PROCESS_UNSTRUCTURED_SS_REQUEST service..... | 229 | + +| | | | | +|-----|---------|------------------------------------------------|-----| +| 787 | 11.9.1 | Definitions..... | 230 | +| 788 | 11.9.2 | Service primitives..... | 230 | +| 789 | 11.9.3 | Parameter use..... | 230 | +| 790 | 11.10 | MAP_UNSTRUCTURED_SS_REQUEST service..... | 231 | +| 791 | 11.10.1 | Definitions..... | 231 | +| 792 | 11.10.2 | Service primitives..... | 231 | +| 793 | 11.10.3 | Parameter use..... | 231 | +| 794 | 11.11 | MAP_UNSTRUCTURED_SS_NOTIFY service..... | 232 | +| 795 | 11.11.1 | Definitions..... | 232 | +| 796 | 11.11.2 | Service primitives..... | 232 | +| 797 | 11.11.3 | Parameter use..... | 232 | +| 798 | 11.12 | MAP_SS_INVOCATION_NOTIFY..... | 233 | +| 799 | 11.12.1 | Definition..... | 233 | +| 800 | 11.12.2 | Service primitives..... | 233 | +| 801 | 11.12.3 | Parameter use..... | 233 | +| 802 | 11.13 | MAP_REGISTER_CC_ENTRY service..... | 234 | +| 803 | 11.13.1 | Definition..... | 234 | +| 804 | 11.13.2 | Service primitives..... | 234 | +| 805 | 11.13.3 | Parameter use..... | 234 | +| 806 | 11.14 | MAP_ERASE_CC_ENTRY service..... | 235 | +| 807 | 11.14.1 | Definition..... | 235 | +| 808 | 11.14.2 | Service primitives..... | 235 | +| 809 | 11.14.3 | Parameter use..... | 235 | +| 810 | 12 | Short message service management services..... | 236 | +| 811 | 12.1 | MAP-SEND-ROUTING-INFO-FOR-SM service..... | 236 | +| 812 | 12.1.1 | Definition..... | 236 | +| 813 | 12.1.2 | Service primitives..... | 236 | +| 814 | 12.1.3 | Parameter use..... | 237 | +| 815 | 12.1.4 | Identities of MT-SMS Target Nodes..... | 240 | +| 816 | 12.2 | MAP-MO-FORWARD-SHORT-MESSAGE service..... | 241 | +| 817 | 12.2.1 | Definition..... | 241 | +| 818 | 12.2.2 | Service primitives..... | 241 | +| 819 | 12.2.3 | Parameter use..... | 241 | +| 820 | 12.3 | MAP-REPORT-SM-DELIVERY-STATUS service..... | 242 | +| 821 | 12.3.1 | Definition..... | 242 | +| 822 | 12.3.2 | Service primitives..... | 242 | +| 823 | 12.3.3 | Parameter use..... | 243 | +| 824 | 12.4 | MAP-READY-FOR-SM service..... | 245 | +| 825 | 12.4.1 | Definition..... | 245 | +| 826 | 12.4.2 | Service primitives..... | 245 | +| 827 | 12.4.3 | Parameter use..... | 246 | +| 828 | 12.5 | MAP-ALERT-SERVICE-CENTRE service..... | 246 | +| 829 | 12.5.1 | Definition..... | 246 | +| 830 | 12.5.2 | Service primitives..... | 247 | +| 831 | 12.5.3 | Parameter use..... | 247 | +| 832 | 12.6 | MAP-INFORM-SERVICE-CENTRE service..... | 249 | +| 833 | 12.6.1 | Definition..... | 249 | +| 834 | 12.6.2 | Service primitives..... | 250 | +| 835 | 12.6.3 | Parameter use..... | 250 | +| 836 | 12.7 | MAP-SEND-INFO-FOR-MT-SMS service..... | 250 | +| 837 | 12.7.1 | Definition..... | 250 | +| 838 | 12.7.2 | Service primitives..... | 251 | +| 839 | 12.7.3 | Parameter use..... | 251 | +| 840 | 12.8 | MAP-SEND-INFO-FOR-MO-SMS service..... | 251 | +| 841 | 12.8.1 | Definition..... | 252 | +| 842 | 12.8.2 | Service primitives..... | 252 | +| 843 | 12.8.3 | Parameter use..... | 252 | +| 844 | 12.9 | MAP-MT-FORWARD-SHORT-MESSAGE service..... | 252 | +| 845 | 12.9.1 | Definition..... | 252 | +| 846 | 12.9.2 | Service primitives..... | 252 | +| 847 | 12.9.3 | Parameter use..... | 253 | + +| | | | | +|-----|---------|--------------------------------------------------------|-----| +| 848 | 12.10 | MAP-MT-FORWARD-SM-FOR-VGCS service..... | 255 | +| 849 | 12.10.1 | Definition..... | 255 | +| 850 | 12.10.2 | Service primitives..... | 255 | +| 851 | 12.10.3 | Parameter use..... | 255 | +| 852 | 13 | Network-Requested PDP Context Activation services..... | 256 | +| 853 | 13.1 | MAP_SEND_ROUTING_INFO_FOR_GPRS service..... | 256 | +| 854 | 13.1.1 | Definition..... | 256 | +| 855 | 13.1.2 | Service primitives..... | 256 | +| 856 | 13.1.3 | Parameter definition and use..... | 256 | +| 857 | 13.2 | MAP_FAILURE_REPORT service..... | 257 | +| 858 | 13.2.1 | Definition..... | 257 | +| 859 | 13.2.2 | Service primitives..... | 257 | +| 860 | 13.2.3 | Parameter definition and use..... | 257 | +| 861 | 13.3 | MAP_NOTE_MS_PRESENT_FOR_GPRS service..... | 258 | +| 862 | 13.3.1 | Definition..... | 258 | +| 863 | 13.3.2 | Service primitives..... | 258 | +| 864 | 13.3.3 | Parameter definition and use..... | 258 | +| 865 | 13A | Location Service Management Services..... | 259 | +| 866 | 13A.1 | MAP-SEND-ROUTING-INFO-FOR-LCS Service..... | 259 | +| 867 | 13A.1.1 | Definition..... | 259 | +| 868 | 13A.1.2 | Service Primitives..... | 259 | +| 869 | 13A.1.3 | Parameter Use..... | 260 | +| 870 | 13A.2 | MAP-PROVIDE-SUBSCRIBER-LOCATION Service..... | 261 | +| 871 | 13A.2.1 | Definition..... | 261 | +| 872 | 13A.2.2 | Service Primitives..... | 261 | +| 873 | 13A.2.3 | Parameter Definition and Use..... | 262 | +| 874 | 13A.3 | MAP-SUBSCRIBER-LOCATION-REPORT Service..... | 265 | +| 875 | 13A.3.1 | Definition..... | 265 | +| 876 | 13A.3.2 | Service Primitives..... | 265 | +| 877 | 13A.3.3 | Parameter Definition and Use..... | 266 | +| 878 | 13A.4 | Void..... | 269 | +| 879 | 13A.4.1 | Void..... | 269 | +| 880 | 13A.4.2 | Void..... | 269 | +| 881 | 13A.4.3 | Void..... | 269 | +| 882 | 13A.5 | Void..... | 269 | +| 883 | 13A.5.1 | Void..... | 269 | +| 884 | 13A.5.2 | Void..... | 269 | +| 885 | 13A.5.3 | Void..... | 269 | +| 886 | 13A.6 | Void..... | 269 | +| 887 | 13A.6.1 | Void..... | 270 | +| 888 | 13A.6.2 | Void..... | 270 | +| 889 | 13A.6.3 | Void..... | 270 | +| 890 | 13A.7 | Void..... | 270 | +| 891 | 13A.7.1 | Void..... | 270 | +| 892 | 13A.7.2 | Void..... | 270 | +| 893 | 13A.7.3 | Void..... | 270 | +| 894 | 13A.8 | Void..... | 270 | +| 895 | 13A.8.1 | Void..... | 270 | +| 896 | 13A.8.2 | Void..... | 270 | +| 897 | 13A.8.3 | Void..... | 270 | +| 898 | 13A.9 | Void..... | 270 | +| 899 | 13A.9.1 | Void..... | 270 | +| 900 | 13A.9.2 | Void..... | 270 | +| 901 | 13A.9.3 | Void..... | 270 | +| 902 | 14 | General..... | 270 | +| 903 | 14.1 | Overview..... | 270 | +| 904 | 14.2 | Underlying services..... | 270 | +| 905 | 14.3 | Model..... | 271 | +| 906 | 14.4 | Conventions..... | 271 | + +| | | | | +|-----|------------|------------------------------------------------------------------|-----| +| 907 | 15 | Elements of procedure..... | 271 | +| 908 | 15.1 | Handling of unknown operations..... | 271 | +| 909 | 15.2 | Dialogue establishment..... | 272 | +| 910 | 15.2.1 | Behaviour at the initiating side..... | 272 | +| 911 | 15.2.2 | Behaviour at the responding side..... | 273 | +| 912 | 15.3 | Dialogue continuation..... | 274 | +| 913 | 15.4 | Load control..... | 274 | +| 914 | 15.5 | Procedures for MAP specific services..... | 274 | +| 915 | 15.5.1 | Service invocation..... | 274 | +| 916 | 15.5.2 | Void..... | 275 | +| 917 | 15.5.3 | Service invocation receipt..... | 275 | +| 918 | 15.5.4 | Void..... | 275 | +| 919 | 15.5.5 | Handling of components received from TC..... | 275 | +| 920 | 15.6 | SDL descriptions..... | 275 | +| 921 | 16 | Mapping on to TC services..... | 308 | +| 922 | 16.1 | Dialogue control..... | 308 | +| 923 | 16.1.1 | Directly mapped parameters..... | 308 | +| 924 | 16.1.2 | Use of other parameters of dialogue handling primitives..... | 308 | +| 925 | 16.1.2.1 | Dialogue Id..... | 308 | +| 926 | 16.1.2.2 | Application-context-name..... | 308 | +| 927 | 16.1.2.3 | User information..... | 308 | +| 928 | 16.1.2.4 | Component present..... | 308 | +| 929 | 16.1.2.5 | Termination..... | 308 | +| 930 | 16.1.2.6 | P-Abort-Cause..... | 308 | +| 931 | 16.1.2.7 | Quality of service..... | 308 | +| 932 | 16.2 | Service specific procedures..... | 309 | +| 933 | 16.2.1 | Directly mapped parameters..... | 309 | +| 934 | 16.2.2 | Use of other parameters of component handling primitives..... | 309 | +| 935 | 16.2.2.1 | Dialogue Id..... | 309 | +| 936 | 16.2.2.2 | Class..... | 309 | +| 937 | 16.2.2.3 | Linked Id..... | 309 | +| 938 | 16.2.2.4 | Operation..... | 310 | +| 939 | 16.2.2.5 | Error..... | 311 | +| 940 | 16.2.2.6 | Parameters..... | 311 | +| 941 | 16.2.2.7 | Time out..... | 311 | +| 942 | 16.2.2.8 | Last component..... | 311 | +| 943 | 16.2.2.9 | Problem code..... | 311 | +| 944 | 16.2.2.9.1 | Mapping to MAP User Error..... | 311 | +| 945 | 16.2.2.9.2 | Mapping to MAP Provider Error parameter..... | 312 | +| 946 | 16.2.2.9.3 | Mapping to diagnostic parameter..... | 312 | +| 947 | 17 | Abstract syntax of the MAP protocol..... | 313 | +| 948 | 17.1 | General..... | 313 | +| 949 | 17.1.1 | Encoding rules..... | 313 | +| 950 | 17.1.2 | Use of TC..... | 313 | +| 951 | 17.1.2.1 | Use of Global Operation and Error codes defined outside MAP..... | 314 | +| 952 | 17.1.3 | Use of information elements defined outside MAP..... | 314 | +| 953 | 17.1.4 | Compatibility considerations..... | 314 | +| 954 | 17.1.5 | Structure of the Abstract Syntax of MAP..... | 315 | +| 955 | 17.1.6 | Application Contexts..... | 317 | +| 956 | 17.2 | Operation packages..... | 318 | +| 957 | 17.2.1 | General aspects..... | 318 | +| 958 | 17.2.2 | Packages specifications..... | 319 | +| 959 | 17.2.2.1 | Location updating..... | 319 | +| 960 | 17.2.2.2 | Location cancellation..... | 319 | +| 961 | 17.2.2.3 | Roaming number enquiry..... | 320 | +| 962 | 17.2.2.4 | Information retrieval..... | 320 | +| 963 | 17.2.2.5 | Inter-VLR information retrieval..... | 320 | +| 964 | 17.2.2.6 | IMSI retrieval..... | 320 | +| 965 | 17.2.2.7 | Call control transfer..... | 321 | +| 966 | 17.2.2.8 | Void..... | 321 | + +| | | | | +|------|------------|----------------------------------------------------|-----| +| 967 | 17.2.2.9 | Void..... | 321 | +| 968 | 17.2.2.10 | Interrogation..... | 321 | +| 969 | 17.2.2.11 | Void..... | 321 | +| 970 | 17.2.2.12 | Handover Control..... | 321 | +| 971 | 17.2.2.13 | Subscriber Data management stand alone..... | 322 | +| 972 | 17.2.2.14 | Equipment management..... | 322 | +| 973 | 17.2.2.15 | Subscriber data management..... | 322 | +| 974 | 17.2.2.16 | Location register restart..... | 322 | +| 975 | 17.2.2.17 | Tracing stand-alone..... | 323 | +| 976 | 17.2.2.18 | Functional SS handling..... | 323 | +| 977 | 17.2.2.19 | Tracing..... | 323 | +| 978 | 17.2.2.20 | Binding..... | 323 | +| 979 | 17.2.2.21 | Unstructured SS handling..... | 324 | +| 980 | 17.2.2.22 | MO Short message relay services..... | 324 | +| 981 | 17.2.2.23 | Short message gateway services..... | 324 | +| 982 | 17.2.2.24 | MT Short message relay services..... | 325 | +| 983 | 17.2.2.25 | Void..... | 325 | +| 984 | 17.2.2.26 | Message waiting data management..... | 325 | +| 985 | 17.2.2.27 | Alerting..... | 325 | +| 986 | 17.2.2.28 | Data restoration..... | 325 | +| 987 | 17.2.2.29 | Purging..... | 326 | +| 988 | 17.2.2.30 | Subscriber information enquiry..... | 326 | +| 989 | 17.2.2.31 | Any time information enquiry..... | 326 | +| 990 | 17.2.2.32 | Group Call Control..... | 326 | +| 991 | 17.2.2.32A | Group Call Info Retrieval..... | 326 | +| 992 | 17.2.2.33 | Void..... | 327 | +| 993 | 17.2.2.34 | Void..... | 327 | +| 994 | 17.2.2.35 | Gprs location updating..... | 327 | +| 995 | 17.2.2.36 | Gprs Interrogation..... | 327 | +| 996 | 17.2.2.37 | Failure reporting..... | 327 | +| 997 | 17.2.2.38 | GPRS notifying..... | 327 | +| 998 | 17.2.2.39 | Supplementary Service invocation notification..... | 328 | +| 999 | 17.2.2.40 | Set Reporting State..... | 328 | +| 1000 | 17.2.2.41 | Status Report..... | 328 | +| 1001 | 17.2.2.42 | Remote User Free..... | 328 | +| 1002 | 17.2.2.43 | Call Completion..... | 328 | +| 1003 | 17.2.2.44 | Location service gateway services..... | 328 | +| 1004 | 17.2.2.45 | Location service enquiry..... | 329 | +| 1005 | 17.2.2.45A | Location service reporting..... | 329 | +| 1006 | 17.2.2.46 | Void..... | 329 | +| 1007 | 17.2.2.47 | Void..... | 329 | +| 1008 | 17.2.2.48 | Void..... | 329 | +| 1009 | 17.2.2.49 | IST Alerting..... | 329 | +| 1010 | 17.2.2.50 | Service Termination..... | 329 | +| 1011 | 17.2.2.51 | Mobility Management event notification..... | 330 | +| 1012 | 17.2.2.53 | Subscriber Data modification notification..... | 330 | +| 1013 | 17.2.2.54 | Authentication Failure Report..... | 330 | +| 1014 | 17.2.2.55 | Resource Management..... | 330 | +| 1015 | 17.2.2.56 | MT Short message relay VGCS services..... | 331 | +| 1016 | 17.2.2.57 | Vcsg location updating..... | 331 | +| 1017 | 17.2.2.58 | Vcsg location cancellation..... | 331 | +| 1018 | 17.3 | Application contexts..... | 331 | +| 1019 | 17.3.1 | General aspects..... | 331 | +| 1020 | 17.3.2 | Application context definitions..... | 332 | +| 1021 | 17.3.2.1 | Void..... | 332 | +| 1022 | 17.3.2.2 | Location Updating..... | 332 | +| 1023 | 17.3.2.3 | Location Cancellation..... | 332 | +| 1024 | 17.3.2.4 | Roaming number enquiry..... | 333 | +| 1025 | 17.3.2.5 | Void..... | 333 | +| 1026 | 17.3.2.6 | Location Information Retrieval..... | 333 | +| 1027 | 17.3.2.7 | Call control transfer..... | 333 | + +| | | | | +|------|------------|----------------------------------------------------|-----| +| 1028 | 17.3.2.8 | Void..... | 334 | +| 1029 | 17.3.2.9 | Void..... | 334 | +| 1030 | 17.3.2.10 | Void..... | 334 | +| 1031 | 17.3.2.11 | Location registers restart..... | 334 | +| 1032 | 17.3.2.12 | Handover control..... | 334 | +| 1033 | 17.3.2.13 | IMSI Retrieval..... | 334 | +| 1034 | 17.3.2.14 | Equipment Management..... | 335 | +| 1035 | 17.3.2.15 | Information retrieval..... | 335 | +| 1036 | 17.3.2.16 | Inter-VLR information retrieval..... | 335 | +| 1037 | 17.3.2.17 | Stand Alone Subscriber Data Management..... | 336 | +| 1038 | 17.3.2.18 | Tracing..... | 336 | +| 1039 | 17.3.2.19 | Network functional SS handling..... | 336 | +| 1040 | 17.3.2.20 | Network unstructured SS handling..... | 337 | +| 1041 | 17.3.2.21 | Short Message Gateway..... | 337 | +| 1042 | 17.3.2.22 | Mobile originating Short Message Relay..... | 337 | +| 1043 | 17.3.2.23 | Void..... | 338 | +| 1044 | 17.3.2.24 | Short message alert..... | 338 | +| 1045 | 17.3.2.25 | Short message waiting data management..... | 338 | +| 1046 | 17.3.2.26 | Mobile terminating Short Message Relay..... | 338 | +| 1047 | 17.3.2.27 | MS purging..... | 339 | +| 1048 | 17.3.2.28 | Subscriber information enquiry..... | 339 | +| 1049 | 17.3.2.29 | Any time information enquiry..... | 339 | +| 1050 | 17.3.2.30 | Group Call Control..... | 339 | +| 1051 | 17.3.2.30A | Group Call Info Retrieval..... | 339 | +| 1052 | 17.3.2.31 | Void..... | 340 | +| 1053 | 17.3.2.32 | Gprs Location Updating..... | 340 | +| 1054 | 17.3.2.33 | Gprs Location Information Retrieval..... | 340 | +| 1055 | 17.3.2.34 | Failure Reporting..... | 340 | +| 1056 | 17.3.2.35 | GPRS Notifying..... | 340 | +| 1057 | 17.3.2.36 | Supplementary Service invocation notification..... | 341 | +| 1058 | 17.3.2.37 | Reporting..... | 341 | +| 1059 | 17.3.2.38 | Call Completion..... | 341 | +| 1060 | 17.3.2.39 | Location Service Gateway..... | 342 | +| 1061 | 17.3.2.40 | Location Service Enquiry..... | 342 | +| 1062 | 17.3.2.41 | Void..... | 342 | +| 1063 | 17.3.2.42 | Void..... | 342 | +| 1064 | 17.3.2.43 | Void..... | 342 | +| 1065 | 17.3.2.44 | IST Alerting..... | 342 | +| 1066 | 17.3.2.45 | Service Termination..... | 342 | +| 1067 | 17.3.2.46 | Mobility Management event notification..... | 343 | +| 1068 | 17.3.2.48 | Subscriber Data modification notification..... | 343 | +| 1069 | 17.3.2.49 | Authentication Failure Report..... | 343 | +| 1070 | 17.3.2.50 | Resource Management..... | 343 | +| 1071 | 17.3.2.51 | Mobile terminating Short Message Relay VGCS..... | 344 | +| 1072 | 17.3.2.52 | Vcsg Location Updating..... | 344 | +| 1073 | 17.3.2.53 | Vcsg Location Cancellation..... | 344 | +| 1074 | 17.3.3 | ASN.1 Module for application-context-names..... | 344 | +| 1075 | 17.4 | MAP Dialogue Information..... | 347 | +| 1076 | 17.5 | MAP operation and error codes..... | 349 | +| 1077 | 17.6 | MAP operations and errors..... | 351 | +| 1078 | 17.6.1 | Mobile Service Operations..... | 351 | +| 1079 | 17.6.2 | Operation and Maintenance Operations..... | 358 | +| 1080 | 17.6.3 | Call Handling Operations..... | 359 | +| 1081 | 17.6.4 | Supplementary service operations..... | 362 | +| 1082 | 17.6.5 | Short message service operations..... | 366 | +| 1083 | 17.6.6 | Errors..... | 369 | +| 1084 | 17.6.7 | Group Call operations..... | 375 | +| 1085 | 17.6.8 | Location service operations..... | 377 | +| 1086 | 17.6.9 | Void..... | 378 | +| 1087 | 17.7 | MAP constants and data types..... | 378 | +| 1088 | 17.7.1 | Mobile Service data types..... | 378 | + +| | | | | +|------|-----------|-----------------------------------------------------|-----| +| 1089 | 17.7.2 | Operation and maintenance data types..... | 427 | +| 1090 | 17.7.3 | Call handling data types..... | 434 | +| 1091 | 17.7.4 | Supplementary service data types..... | 440 | +| 1092 | 17.7.5 | Supplementary service codes..... | 444 | +| 1093 | 17.7.6 | Short message data types..... | 447 | +| 1094 | 17.7.7 | Error data types..... | 453 | +| 1095 | 17.7.8 | Common data types..... | 459 | +| 1096 | 17.7.9 | Teleservice Codes..... | 468 | +| 1097 | 17.7.10 | Bearer Service Codes..... | 469 | +| 1098 | 17.7.11 | Extension data types..... | 471 | +| 1099 | 17.7.12 | Group Call data types..... | 472 | +| 1100 | 17.7.13 | Location service data types..... | 475 | +| 1101 | 17.7.14 | Void..... | 485 | +| 1102 | 18 | General on MAP user procedures..... | 486 | +| 1103 | 18.1 | Introduction..... | 486 | +| 1104 | 18.2 | Common aspects of user procedure descriptions..... | 486 | +| 1105 | 18.2.1 | General conventions..... | 486 | +| 1106 | 18.2.2 | Naming conventions..... | 486 | +| 1107 | 18.2.3 | Convention on primitives parameters..... | 487 | +| 1108 | 18.2.3.1 | Open service..... | 487 | +| 1109 | 18.2.3.2 | Close service..... | 488 | +| 1110 | 18.2.4 | Version handling at dialogue establishment..... | 488 | +| 1111 | 18.2.4.1 | Behaviour at the initiating side..... | 488 | +| 1112 | 18.2.4.2 | Behaviour at the responding side..... | 488 | +| 1113 | 18.2.5 | Abort Handling..... | 488 | +| 1114 | 18.2.6 | SDL conventions..... | 488 | +| 1115 | 18.3 | Interaction between MAP Provider and MAP Users..... | 489 | +| 1116 | 19 | Mobility procedures..... | 490 | +| 1117 | 19.1 | Location management Procedures..... | 490 | +| 1118 | 19.1.1 | Location updating..... | 491 | +| 1119 | 19.1.1.1 | General..... | 491 | +| 1120 | 19.1.1.2 | Procedures in the VLR..... | 496 | +| 1121 | 19.1.1.3 | Procedure in the PVLR..... | 496 | +| 1122 | 19.1.1.4 | Procedure in the SGSN..... | 496 | +| 1123 | 19.1.1.5 | Procedures in the HLR..... | 497 | +| 1124 | 19.1.1A | Location updating for VCSG..... | 517 | +| 1125 | 19.1.1A.1 | General..... | 517 | +| 1126 | 19.1.1A.2 | Procedures in the VLR..... | 517 | +| 1127 | 19.1.1A.3 | Procedures in the SGSN..... | 517 | +| 1128 | 19.1.1A.4 | Procedures in the CSS..... | 517 | +| 1129 | 19.1.2 | Location Cancellation..... | 525 | +| 1130 | 19.1.2.1 | General..... | 525 | +| 1131 | 19.1.2.2 | Procedure in the HLR..... | 525 | +| 1132 | 19.1.2.3 | Procedure in the VLR..... | 526 | +| 1133 | 19.1.2.4 | Procedure in the SGSN..... | 526 | +| 1134 | 19.1.2A | Location Cancellation for VCSG..... | 533 | +| 1135 | 19.1.2A.1 | General..... | 533 | +| 1136 | 19.1.2A.2 | Procedure in the CSS..... | 533 | +| 1137 | 19.1.2A.3 | Procedure in the VLR..... | 533 | +| 1138 | 19.1.2A.4 | Procedure in the SGSN..... | 533 | +| 1139 | 19.1.3 | Void..... | 537 | +| 1140 | 19.1.4 | MS Purging..... | 537 | +| 1141 | 19.1.4.1 | General..... | 538 | +| 1142 | 19.1.4.2 | Procedure in the VLR..... | 538 | +| 1143 | 19.1.4.3 | Procedure in the SGSN..... | 538 | +| 1144 | 19.1.4.4 | Procedure in the HLR..... | 539 | +| 1145 | 19.2 | Handover procedures..... | 544 | +| 1146 | 19.2.1 | General..... | 544 | +| 1147 | 19.2.2 | Procedure in MSC-A..... | 547 | +| 1148 | 19.2.2.1 | Basic handover..... | 547 | + +| | | | | +|------|-----------|-----------------------------------------------------------|-----| +| 1149 | 19.2.2.2 | Handling of access signalling..... | 548 | +| 1150 | 19.2.2.3 | Subsequent handover..... | 548 | +| 1151 | 19.2.3 | Procedure in MSC-B..... | 548 | +| 1152 | 19.2.3.1 | Basic handover..... | 549 | +| 1153 | 19.2.3.2 | Handling of access signalling..... | 549 | +| 1154 | 19.2.3.3 | Subsequent handover..... | 549 | +| 1155 | 19.2.4 | Macro Receive_Error_From_HO_CA..... | 549 | +| 1156 | 19.2.5 | Procedure in VLR-B..... | 549 | +| 1157 | 19.3 | Fault recovery procedures..... | 568 | +| 1158 | 19.3.1 | VLR fault recovery procedures..... | 568 | +| 1159 | 19.3.1.1 | General 568 | | +| 1160 | 19.3.1.2 | Procedure in the VLR..... | 569 | +| 1161 | 19.3.1.3 | Procedure in the HLR..... | 569 | +| 1162 | 19.3.2 | HLR fault recovery procedures..... | 571 | +| 1163 | 19.3.2.1 | General..... | 571 | +| 1164 | 19.3.2.2 | Procedure in the HLR..... | 572 | +| 1165 | 19.3.2.3 | Procedure in the VLR..... | 573 | +| 1166 | 19.3.2.4 | Procedure in the SGSN..... | 573 | +| 1167 | 19.3.3 | CSS fault recovery procedures..... | 579 | +| 1168 | 19.3.3.1 | General..... | 579 | +| 1169 | 19.3.3.2 | Procedure in the CSS..... | 580 | +| 1170 | 19.3.3.3 | Procedure in the VLR..... | 580 | +| 1171 | 19.3.3.4 | Procedure in the SGSN..... | 580 | +| 1172 | 19.4 | Mobility Management event notification procedure..... | 585 | +| 1173 | 19.4.1 | General..... | 585 | +| 1174 | 19.4.2 | Procedure in the VLR or SGSN..... | 586 | +| 1175 | 19.4.3 | Procedure in the gsmSCF..... | 586 | +| 1176 | 19.5 | HLR Insert Subscriber Data macros..... | 589 | +| 1177 | 19.5.1 | Macro Insert_Subs_Data_Framed_HLR..... | 589 | +| 1178 | 19.5.2 | Macro Insert_GPRS_Subs_Data_Framed_HLR..... | 589 | +| 1179 | 19.5A | CSS Insert Subscriber Data macros..... | 592 | +| 1180 | 19.5A.1 | Macro Insert_VCSG_Subs_Data_Framed_CSS..... | 592 | +| 1181 | 20 | Operation and maintenance procedures..... | 594 | +| 1182 | 20.1 | General..... | 594 | +| 1183 | 20.1.1 | Tracing Co-ordinator for the VLR..... | 594 | +| 1184 | 20.1.2 | Tracing Co-ordinator for the SGSN..... | 594 | +| 1185 | 20.1.3 | Subscriber Data Management Co-ordinator for the VLR..... | 594 | +| 1186 | 20.1.4 | Subscriber Data Management Co-ordinator for the SGSN..... | 594 | +| 1187 | 20.2 | Tracing procedures..... | 601 | +| 1188 | 20.2.1 | Subscriber tracing activation procedure..... | 604 | +| 1189 | 20.2.1.1 | Procedures in the HLR..... | 604 | +| 1190 | 20.2.1.2 | Procedure in the VLR..... | 604 | +| 1191 | 20.2.1.3 | Procedure in the SGSN..... | 604 | +| 1192 | 20.2.2 | Subscriber tracing deactivation procedure..... | 604 | +| 1193 | 20.2.2.1 | Procedures in the HLR..... | 604 | +| 1194 | 20.2.2.2 | Procedure in the VLR..... | 605 | +| 1195 | 20.2.2.3 | Procedure in the SGSN..... | 605 | +| 1196 | 20.3 | Subscriber data management procedures for HLR..... | 618 | +| 1197 | 20.3.1 | Subscriber deletion procedure..... | 619 | +| 1198 | 20.3.1.1 | Procedure in the HLR..... | 619 | +| 1199 | 20.3.1.2 | Procedure in the VLR..... | 619 | +| 1200 | 20.3.1.3 | Procedure in the SGSN..... | 620 | +| 1201 | 20.3.2 | Subscriber data modification procedure..... | 620 | +| 1202 | 20.3.2.1 | Procedure in the HLR..... | 620 | +| 1203 | 20.3.2.2 | Procedures in the VLR..... | 621 | +| 1204 | 20.3.2.3 | Procedures in the SGSN..... | 621 | +| 1205 | 20.3A | Subscriber Data Management procedures for CSS..... | 633 | +| 1206 | 20.3A.1 | Subscriber deletion procedure..... | 634 | +| 1207 | 20.3A.1.1 | Procedure in the CSS..... | 634 | +| 1208 | 20.3A.1.2 | Procedure in the VLR..... | 634 | +| 1209 | 20.3A.1.3 | Procedure in the SGSN..... | 634 | + +| | | | | +|------|-----------|-----------------------------------------------------------------------------|-----| +| 1210 | 20.3A.2 | Subscriber data modification procedure..... | 635 | +| 1211 | 20.3A.2.1 | Procedure in the CSS..... | 635 | +| 1212 | 20.3A.2.2 | Procedures in the VLR..... | 635 | +| 1213 | 20.3A.2.3 | Procedures in the SGSN..... | 635 | +| 1214 | 20.4 | Subscriber Identity procedure..... | 647 | +| 1215 | 20.4.1 | Procedure in the VLR..... | 647 | +| 1216 | 20.4.2 | Procedure in the HLR..... | 647 | +| 1217 | 21 | Call handling procedures..... | 650 | +| 1218 | 21.1 | General..... | 650 | +| 1219 | 21.2 | Retrieval of routing information..... | 650 | +| 1220 | 21.2.1 | General..... | 650 | +| 1221 | 21.2.2 | Procedure in the GMSC..... | 654 | +| 1222 | 21.2.9 | Process in the gsmSCF..... | 654 | +| 1223 | 21.2.4 | Procedure in the HLR..... | 654 | +| 1224 | 21.2.5 | Procedure in the VLR to provide a roaming number..... | 655 | +| 1225 | 21.2.6 | Procedure in the VLR to restore subscriber data..... | 655 | +| 1226 | 21.2.7 | Procedure in the VLR to provide subscriber information..... | 655 | +| 1227 | 21.2.8 | Procedure in the old VLR to request a Roaming Number (MTRF)..... | 655 | +| 1228 | 21.3 | Transfer of call handling..... | 665 | +| 1229 | 21.3.1 | General..... | 665 | +| 1230 | 21.3.2 | Process in the VMSC..... | 665 | +| 1231 | 21.3.3 | Process in the GMSC..... | 666 | +| 1232 | 21.4 | Inter MSC Group Call Procedures..... | 669 | +| 1233 | 21.4.1 | General..... | 669 | +| 1234 | 21.4.2 | Process in the Anchor MSC..... | 669 | +| 1235 | 21.4.3 | Process in the Relay MSC..... | 670 | +| 1236 | 21.4A | Inter MSC Group Call Info Retrieval..... | 675 | +| 1237 | 21.4A.1 | General..... | 675 | +| 1238 | 21.4A.2 | Process in the MSC..... | 675 | +| 1239 | 21.5 | Void..... | 678 | +| 1240 | 21.6 | CCBS: monitoring and reporting the status of the subscriber..... | 678 | +| 1241 | 21.6.1 | Reporting co-ordinator process in the VLR..... | 678 | +| 1242 | 21.6.2 | Setting the reporting state – stand-alone..... | 678 | +| 1243 | 21.6.2.1 | Process in the HLR..... | 678 | +| 1244 | 21.6.2.2 | Process in the VLR..... | 678 | +| 1245 | 21.6.3 | Status Reporting..... | 678 | +| 1246 | 21.6.3.1 | Process in the VLR..... | 679 | +| 1247 | 21.6.3.2 | Process in the HLR..... | 680 | +| 1248 | 21.6.4 | CCBS: Remote User Free..... | 680 | +| 1249 | 21.6.4.1 | Process in the HLR..... | 681 | +| 1250 | 21.6.3.2 | Process in the VLR..... | 681 | +| 1251 | 21.7 | Void..... | 694 | +| 1252 | 21.8 | Void..... | 694 | +| 1253 | 21.9 | Immediate Service Termination (IST)..... | 694 | +| 1254 | 21.9.1 | IST Alert..... | 694 | +| 1255 | 21.9.1.1 | Procedure in the MSC..... | 694 | +| 1256 | 21.9.1.2 | Procedure in the HLR..... | 694 | +| 1257 | 21.9.2 | IST Command..... | 694 | +| 1258 | 21.9.2.1 | Procedure in the HLR..... | 695 | +| 1259 | 21.9.2.2 | Procedure in the MSC..... | 695 | +| 1260 | 21.10 | Resource Management..... | 700 | +| 1261 | 21.10.1 | General..... | 700 | +| 1262 | 21.3.2 | Process in the GMSC..... | 700 | +| 1263 | 21.3.3 | Process in the VMSC..... | 700 | +| 1264 | 22 | Supplementary services procedures..... | 703 | +| 1265 | 22.1 | Supplementary service co-ordinator processes..... | 703 | +| 1266 | 22.1.1 | Supplementary service co-ordinator process for the MSC..... | 703 | +| 1267 | 22.1.2 | Void..... | 703 | +| 1268 | 22.1.3 | Functional supplementary service co-ordinator process for the HLR..... | 703 | +| 1269 | 22.1.4 | Call completion supplementary service co-ordinator process for the HLR..... | 703 | + +| | | | | +|------|---------|-----------------------------------------------------------------------|-----| +| 1270 | 22.2 | Registration procedure..... | 708 | +| 1271 | 22.2.1 | General..... | 708 | +| 1272 | 22.2.2 | Procedure in the MSC..... | 709 | +| 1273 | 22.2.3 | Procedure in the VLR..... | 709 | +| 1274 | 22.2.4 | Procedure in the HLR..... | 709 | +| 1275 | 22.3 | Erasure procedure..... | 715 | +| 1276 | 22.3.1 | General..... | 715 | +| 1277 | 22.3.2 | Procedure in the MSC..... | 716 | +| 1278 | 22.3.3 | Procedure in the VLR..... | 716 | +| 1279 | 22.3.4 | Procedure in the HLR..... | 716 | +| 1280 | 22.4 | Activation procedure..... | 716 | +| 1281 | 22.4.1 | General..... | 716 | +| 1282 | 22.4.2 | Procedure in the MSC..... | 717 | +| 1283 | 22.4.3 | Procedure in the VLR..... | 718 | +| 1284 | 22.4.4 | Procedure in the HLR..... | 718 | +| 1285 | 22.5 | Deactivation procedure..... | 724 | +| 1286 | 22.5.1 | General..... | 724 | +| 1287 | 22.5.2 | Procedure in the MSC..... | 725 | +| 1288 | 22.5.3 | Procedures in the VLR..... | 725 | +| 1289 | 22.5.4 | Procedures in the HLR..... | 725 | +| 1290 | 22.6 | Interrogation procedure..... | 725 | +| 1291 | 22.6.1 | General..... | 725 | +| 1292 | 22.6.2 | Procedure in the MSC..... | 726 | +| 1293 | 22.6.3 | Procedures in the VLR..... | 726 | +| 1294 | 22.6.4 | Procedure in the HLR..... | 727 | +| 1295 | 22.7 | Void..... | 731 | +| 1296 | 22.8 | Password registration procedure..... | 732 | +| 1297 | 22.8.1 | General..... | 732 | +| 1298 | 22.8.2 | Procedure in the MSC..... | 734 | +| 1299 | 22.8.3 | Procedure in the VLR..... | 734 | +| 1300 | 22.8.4 | Procedure in the HLR..... | 734 | +| 1301 | 22.9 | Mobile Initiated USSD procedure..... | 737 | +| 1302 | 22.9.1 | General..... | 737 | +| 1303 | 22.9.2 | Procedure in the MSC..... | 737 | +| 1304 | 22.9.3 | Procedure in the VLR..... | 737 | +| 1305 | 22.9.4 | Procedure in the HLR..... | 738 | +| 1306 | 22.9.5 | Procedures in the gsmSCF/secondary HLR..... | 738 | +| 1307 | 22.10 | Network initiated USSD procedure..... | 752 | +| 1308 | 22.10.1 | General..... | 752 | +| 1309 | 22.10.2 | Procedure in the MSC..... | 752 | +| 1310 | 22.10.3 | Procedure in the VLR..... | 752 | +| 1311 | 22.10.4 | Procedure in the HLR..... | 753 | +| 1312 | 22.10.5 | Procedure in the gsmSCF or secondary HLR..... | 753 | +| 1313 | 22.11 | Common macros for clause 22..... | 773 | +| 1314 | 22.11.1 | SS Password handling macros..... | 773 | +| 1315 | 22.11.2 | Void..... | 773 | +| 1316 | 22.12 | Supplementary Service Invocation Notification procedure..... | 777 | +| 1317 | 22.12.1 | General..... | 777 | +| 1318 | 22.12.2 | Procedure in the MSC..... | 777 | +| 1319 | 22.12.3 | Procedure in the gsmSCF..... | 777 | +| 1320 | 22.13 | Activation of a CCBS request..... | 780 | +| 1321 | 22.13.1 | General..... | 780 | +| 1322 | 22.13.2 | Procedure in the VLR..... | 780 | +| 1323 | 22.13.3 | Procedure in the HLR..... | 780 | +| 1324 | 22.14 | Deactivation of a CCBS request..... | 783 | +| 1325 | 22.14.1 | General..... | 783 | +| 1326 | 22.14.2 | Procedure in the VLR..... | 783 | +| 1327 | 22.14.3 | Procedure in the HLR..... | 783 | +| 1328 | 23 | Short message service procedures..... | 786 | +| 1329 | 23.1 | General..... | 786 | +| 1330 | 23.1.1 | Mobile originated short message service Co-ordinator for the MSC..... | 786 | + +| | | | | +|------|----------|-----------------------------------------------------------------------------------|-----| +| 1331 | 23.1.2 | Short message Gateway Co-ordinator for the HLR..... | 786 | +| 1332 | 23.2 | The mobile originated short message transfer procedure..... | 791 | +| 1333 | 23.2.1 | Procedure in the serving MSC..... | 792 | +| 1334 | 23.2.2 | Procedure in the VLR..... | 792 | +| 1335 | 23.2.3 | Procedure in the SGSN..... | 792 | +| 1336 | 23.2.4 | Procedure in the SMS Interworking MSC (SMS-IWMSC)..... | 793 | +| 1337 | 23.3 | The mobile terminated short message transfer procedure..... | 805 | +| 1338 | 23.3.1 | Procedure in the SMS-GMSC..... | 812 | +| 1339 | 23.3.2 | Procedure in the HLR..... | 814 | +| 1340 | 23.3.3 | Procedure in the Serving MSC..... | 814 | +| 1341 | 23.3.4 | Procedure in the VLR..... | 815 | +| 1342 | 23.3.5 | Procedure in the SGSN..... | 815 | +| 1343 | 23.3.6 | Procedure in the SMS Router..... | 816 | +| 1344 | 23.3.7 | Procedure in the IP-SM-GW..... | 817 | +| 1345 | 23.4 | The Short Message Alert procedure..... | 863 | +| 1346 | 23.4.1 | Procedure in the Serving MSC – the MS has memory available..... | 865 | +| 1347 | 23.4.2 | Procedures in the VLR..... | 865 | +| 1348 | 23.4.2.1 | The Mobile Subscriber is present..... | 865 | +| 1349 | 23.4.2.2 | The MS has memory available..... | 865 | +| 1350 | 23.4.3 | Procedures in the SGSN..... | 866 | +| 1351 | 23.4.3.1 | The Mobile Subscriber is present..... | 866 | +| 1352 | 23.4.3.2 | The Mobile Equipment has memory available..... | 866 | +| 1353 | 23.4.4 | Procedure in the HLR..... | 866 | +| 1354 | 23.4.5 | Procedure in the SMS Interworking MSC..... | 866 | +| 1355 | 23.5 | The SM delivery status report procedure..... | 875 | +| 1356 | 23.5.1 | Procedure in the SMS-GMSC..... | 875 | +| 1357 | 23.5.2 | Procedure in the HLR..... | 875 | +| 1358 | 23.5.3 | Procedure in the IP-SM-GW..... | 876 | +| 1359 | 23.6 | The macro Report_SM_Delivery_Stat_HLR..... | 881 | +| 1360 | 23.7 | The mobile terminated short message transfer procedure for VGCS..... | 884 | +| 1361 | 23.7.1 | Procedure in the SMS-GMSC..... | 885 | +| 1362 | 23.7.2 | Procedure in the Anchor MSC..... | 885 | +| 1363 | 24 | GPRS process description..... | 889 | +| 1364 | 24.1 | Procedure for retrieval of routeing information for GPRS..... | 890 | +| 1365 | 24.1.1 | Process in the GGSN..... | 890 | +| 1366 | 24.1.2 | Process in the HLR..... | 890 | +| 1367 | 24.2 | Procedure for reporting failure to establish a network requested PDP context..... | 893 | +| 1368 | 24.2.1 | Process in the GGSN..... | 893 | +| 1369 | 24.2.2 | Process in the HLR..... | 893 | +| 1370 | 24.3 | Procedure for reporting that an MS has become reachable for GPRS..... | 896 | +| 1371 | 24.3.1 | Process in the HLR..... | 896 | +| 1372 | 24.3.2 | Process in the GGSN for Note Ms Present For Gprs..... | 896 | +| 1373 | 24A | CSE interrogation and control of subscriber data..... | 899 | +| 1374 | 24A.1 | General..... | 899 | +| 1375 | 24A.2 | Any Time Subscription Interrogation procedure..... | 901 | +| 1376 | 24A.2.1 | General..... | 901 | +| 1377 | 24A.2.2 | Process in the gsmSCF..... | 901 | +| 1378 | 24A.2.3 | Process in the HLR..... | 901 | +| 1379 | 24A.3 | Any Time Modification procedure..... | 904 | +| 1380 | 24A.3.1 | General..... | 904 | +| 1381 | 24A.3.2 | Process in the gsmSCF..... | 904 | +| 1382 | 24A.3.3 | Process in the HLR..... | 904 | +| 1383 | 24A.4 | Subscriber Data Modification Notification procedure..... | 907 | +| 1384 | 24A.4.1 | General..... | 907 | +| 1385 | 24A.4.2 | Process in the HLR..... | 907 | +| 1386 | 24A.4.3 | Process in the gsmSCF..... | 907 | +| 1387 | 24A.5 | Any Time Interrogation procedure..... | 912 | +| 1388 | 24A.5.1 | General..... | 912 | +| 1389 | 24A.5.2 | Procedures in the gsmSCF..... | 913 | +| 1390 | 24A.5.3 | Procedure in the HLR..... | 913 | + +| | | | | +|------|----------|----------------------------------------------------------------------------|-----| +| 1391 | 24A.5.4 | Procedure in the GMLC..... | 913 | +| 1392 | 24B | Location Services process description..... | 919 | +| 1393 | 24B.1 | Routeing information retrieval procedure for LCS..... | 919 | +| 1394 | 24B.1.1 | General..... | 919 | +| 1395 | 24B.1.2 | Process in the GMLC..... | 919 | +| 1396 | 24B.1.3 | Process in the HLR..... | 919 | +| 1397 | 24B.2 | Provide Subscriber Location procedure..... | 922 | +| 1398 | 24B.2.1 | General..... | 922 | +| 1399 | 24B.2.2 | Process in the GMLC..... | 922 | +| 1400 | 24B.2.3 | Process in the MSC..... | 922 | +| 1401 | 24B.2.4 | Process in the SGSN..... | 922 | +| 1402 | 24B.3 | Subscriber Location Report procedure..... | 926 | +| 1403 | 24B.3.1 | General..... | 926 | +| 1404 | 24B.3.2 | Process in the MSC..... | 926 | +| 1405 | 24B.3.3 | Process in the SGSN..... | 926 | +| 1406 | 24B.3.4 | Process in the GMLC..... | 926 | +| 1407 | 25 | General macro description..... | 930 | +| 1408 | 25.1 | MAP_OPEN handling macros..... | 930 | +| 1409 | 25.1.1 | Macro Receive_Open_Ind..... | 930 | +| 1410 | 25.1.2 | Macro Receive_Open_Cnf..... | 930 | +| 1411 | 25.2 | Macros to check the content of indication and confirmation primitives..... | 935 | +| 1412 | 25.2.1 | Macro Check_Indication..... | 935 | +| 1413 | 25.2.2 | Macro Check_Confirmation..... | 935 | +| 1414 | 25.3 | The page and search macros..... | 938 | +| 1415 | 25.3.1 | Macro PAGE_MSC..... | 938 | +| 1416 | 25.3.2 | Macro Search_For_MS_MSC..... | 938 | +| 1417 | 25.4 | Macros for handling an Access Request..... | 941 | +| 1418 | 25.4.1 | Macro Process_Access_Request_MSC..... | 941 | +| 1419 | 25.4.2 | Macro Process_Access_Request_VLR..... | 941 | +| 1420 | 25.4.3 | Macro Obtain_Identity_VLR..... | 941 | +| 1421 | 25.4.4 | Process Update_Location_Child_VLR..... | 941 | +| 1422 | 25.5 | Authentication macros and processes..... | 951 | +| 1423 | 25.5.1 | Macro Authenticate_MSC..... | 951 | +| 1424 | 25.5.2 | Macro Authenticate_VLR..... | 951 | +| 1425 | 25.5.3 | Macro Obtain_Authent_Params_VLR..... | 951 | +| 1426 | 25.5.4 | Process Obtain_Authentication_Sets_VLR..... | 951 | +| 1427 | 25.5.5 | Process Obtain_Authent_Sets_SGSN..... | 951 | +| 1428 | 25.5.6 | Process Obtain_Authent_Sets_HLR..... | 951 | +| 1429 | 25.5.7 | Authentication Failure Reporting..... | 952 | +| 1430 | 25.5.7.1 | General..... | 952 | +| 1431 | 25.5.7.2 | Process in the VLR..... | 952 | +| 1432 | 25.5.7.3 | Process in the SGSN..... | 952 | +| 1433 | 25.5.7.4 | Process in the HLR..... | 952 | +| 1434 | 25.6 | IMEI Handling Macros..... | 968 | +| 1435 | 25.6.1 | Macro Check_IMEI_MSC..... | 968 | +| 1436 | 25.6.2 | Macro Check_IMEI_VLR..... | 968 | +| 1437 | 25.6.3 | Process Check_IMEI_SGSN..... | 968 | +| 1438 | 25.6.4 | Process Check_IMEI_EIR..... | 968 | +| 1439 | 25.6.5 | Macro Obtain_IMEI_MSC..... | 968 | +| 1440 | 25.6.6 | Macro Obtain_IMEI_VLR..... | 968 | +| 1441 | 25.7 | Insert Subscriber Data macros and processes..... | 977 | +| 1442 | 25.7.1 | Macro Insert_Subs_Data_VLR..... | 977 | +| 1443 | 25.7.2 | Macro Insert_Subs_Data_SGSN..... | 977 | +| 1444 | 25.7.3 | Process Insert_Subs_Data_Stand_Alone_HLR..... | 977 | +| 1445 | 25.7.4 | Process Insert_GPRS_Subs_Data_Stand_Alone_HLR..... | 977 | +| 1446 | 25.7.5 | Macro Wait_for_Insert_Subs_Data_Cnf..... | 978 | +| 1447 | 25.7.6 | Macro Wait_for_Insert_GPRS_Subs_Data_Cnf..... | 978 | +| 1448 | 25.7.7 | Process Send_Insert_Subs_Data_HLR..... | 978 | +| 1449 | 25.7.8 | Process Insert_VCSG_Subs_Data_Stand_Alone_CSS..... | 978 | +| 1450 | 25.7.9 | Macro Wait_for_Insert_VCSG_Subs_Data_Cnf..... | 978 | + +| | | | | +|------|---------|---------------------------------------------------------------------------------------------|-------------| +| 1451 | 25.7.10 | Process Send_Insert_VCSG_Subs_Data_CSS..... | 978 | +| 1452 | 25.8 | Request IMSI Macros..... | 992 | +| 1453 | 25.8.1 | Macro Obtain_IMSI_MSC..... | 992 | +| 1454 | 25.8.2 | Macro Obtain_IMSI_VLR..... | 992 | +| 1455 | 25.9 | Tracing macros..... | 995 | +| 1456 | 25.9.1 | Macro Trace_Subscriber_Activity_MSC..... | 995 | +| 1457 | 25.9.2 | Macro Trace_Subscriber_Activity_VLR..... | 995 | +| 1458 | 25.9.3 | Macro Trace_Subscriber_Activity_SGSN..... | 995 | +| 1459 | 25.9.4 | Macro Activate_Tracing_VLR..... | 995 | +| 1460 | 25.9.5 | Macro Activate_Tracing_SGSN..... | 995 | +| 1461 | 25.9.6 | Macro Control_Tracing_With_VLR_HLR..... | 995 | +| 1462 | 25.9.7 | Macro Control_Tracing_With_SGSN_HLR..... | 995 | +| 1463 | 25.10 | Short Message Alert procedures..... | 1003 | +| 1464 | 25.10.1 | Process Subscriber_Present_VLR..... | 1003 | +| 1465 | 25.10.2 | Process SubscriberPresent_SGSN..... | 1003 | +| 1466 | 25.10.3 | Macro Alert_Service_Centre_HLR..... | 1003 | +| 1467 | 25.10.4 | Process Alert_SC_HLR..... | 1003 | +| 1468 | | Annex A (informative): ASN.1 Cross-reference listing and fully expanded sources..... | 1007 | +| 1469 | | Annex B (informative): Void..... | 1008 | +| 1470 | | Annex C (informative): Message Segmentation Mechanisms..... | 1009 | +| 1471 | C.1 | SCCP segmentation..... | 1009 | +| 1472 | C.2 | TCAP segmentation..... | 1009 | +| 1473 | C.2.1 | Empty Begin..... | 1009 | +| 1474 | C.2.2 | Empty Continue..... | 1009 | +| 1475 | C.2.3 | TC-Result-NL..... | 1009 | +| 1476 | C.3 | MAP Segmentation..... | 1010 | +| 1477 | C.3.1 | Invoke without explicit indication..... | 1010 | +| 1478 | C.3.2 | Invoke with explicit indication..... | 1010 | +| 1479 | C.3.3 | Result..... | 1010 | +| 1480 | | Annex D (informative): Void..... | 1014 | +| 1481 | | Annex E (informative): Change History..... | 1015 | + +--- + +## 1483 Foreword + +1484 This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +1485 The contents of the present document are subject to continuing work within the TSG and may change following formal +1486 TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an +1487 identifying change of release date and an increase in version number as follows: + +1488 Version x.y.z + +1489 where: + +1490 x the first digit: + +1491 1 presented to TSG for information; + +1492 2 presented to TSG for approval; + +1493 3 or greater indicates TSG approved document under change control. + +1494 y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, +1495 updates, etc. + +1496 z the third digit is incremented when editorial only changes have been incorporated in the document. + +1497 In the present document, modal verbs have the following meanings: + +1498 **shall** indicates a mandatory requirement to do something + +1499 **shall not** indicates an interdiction (prohibition) to do something + +1500 The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in +1501 Technical Reports. + +1502 The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided +1503 insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, +1504 non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a +1505 referenced document. + +1506 **should** indicates a recommendation to do something + +1507 **should not** indicates a recommendation not to do something + +1508 **may** indicates permission to do something + +1509 **need not** indicates permission not to do something + +1510 The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions +1511 "might not" or "shall not" are used instead, depending upon the meaning intended. + +1512 **can** indicates that something is possible + +1513 **cannot** indicates that something is impossible + +1514 The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +1515 **will** indicates that something is certain or expected to happen as a result of action taken by an agency +1516 the behaviour of which is outside the scope of the present document + +1517 **will not** indicates that something is certain or expected not to happen as a result of action taken by an +1518 agency the behaviour of which is outside the scope of the present document + +1519 **might** indicates a likelihood that something will happen as a result of action taken by some agency the +1520 behaviour of which is outside the scope of the present document + +1521 **might not** indicates a likelihood that something will not happen as a result of action taken by some agency +1522 the behaviour of which is outside the scope of the present document + +1523 In addition: + +1524 **is** (or any other verb in the indicative mood) indicates a statement of fact + +1525 **is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +1526 The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1527 1 Scope + +1528 It is necessary to transfer between entities of a Public Land Mobile Network (PLMN) information specific to the PLMN +1529 in order to deal with the specific behaviour of roaming Mobile Stations (MS)s. The Signalling System No. 7 specified +1530 by CCITT is used to transfer this information. + +1531 The present document describes the requirements for the signalling system and the procedures needed at the application +1532 level in order to fulfil these signalling needs. + +1533 Clauses 1 to 6 are related to general aspects such as terminology, mobile network configuration and other protocols +1534 required by MAP. + +1535 MAP consists of a set of MAP services that are provided to MAP service-users by a MAP service-provider. + +![Diagram illustrating the modelling principles of MAP. It shows two 'MAP service-user' boxes at the top, each connected by a vertical line to a central 'Service Interface' box. Both 'Service Interface' boxes are then connected by vertical lines to a single, larger 'MAP Service-provider' box at the bottom. The connections are marked with small crosses.](84e5b251aa38db522f76f5cc3afcb853_img.jpg) + +``` +graph TD; subgraph TopRow [ ]; direction LR; S1[MAP service-user] --- SI1[Service Interface]; S2[MAP service-user] --- SI2[Service Interface]; end; SI1 --- SP[MAP Service-provider]; SI2 --- SP[MAP Service-provider]; +``` + +Diagram illustrating the modelling principles of MAP. It shows two 'MAP service-user' boxes at the top, each connected by a vertical line to a central 'Service Interface' box. Both 'Service Interface' boxes are then connected by vertical lines to a single, larger 'MAP Service-provider' box at the bottom. The connections are marked with small crosses. + +1536 + +1537 + +**Figure 1.1/1: Modelling principles** + +1538 Clauses 7 to 13A of the present document describe the MAP services. + +1539 Clauses 14 to 17 define the MAP protocol specification and the behaviour of service provider (protocol elements to be +1540 used to provide MAP services, mapping on to TC service primitives, abstract syntaxes, etc.). + +1541 Clauses 18 to 25 describe the MAP user procedures that make use of MAP services. + +1542 The present document specifies functions, procedures and information which apply to GERAN Iu mode. However, +1543 functionality related to GERAN Iu mode is neither maintained nor enhanced. + +--- + +## 1544 2 References + +1545 The following documents contain provisions which, through reference in this text, constitute provisions of the present +1546 document. + +1547 - References are either specific (identified by date of publication, edition number, version number, etc.) or +1548 non-specific. + +1549 - For a specific reference, subsequent revisions do not apply. + +1550 - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including +1551 a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same +1552 Release as the present document. + +| | | | +|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1553 | [1] | 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". | +| 1554 | [2] | 3GPP TS 22.001: "Digital cellular telecommunications system (Phase 2+); Principles of telecommunication services supported by a Public Land Mobile Network (PLMN)". | +| 1555 | | | +| 1556 | [3] | 3GPP TS 22.002: "Bearer Services Supported by a Public Land Mobile Network (PLMN)". | +| 1557 | [4] | 3GPP TS 22.003: "Circuit Teleservices Supported by a Public Land Mobile Network (PLMN)". | +| 1558 | [5] | 3GPP TS 22.004: "General on Supplementary Services". | +| 1559 | [6] | 3GPP TS 42.009: "Digital cellular telecommunications system (Phase 2+); Security aspects". | +| 1560 | [7] | 3GPP TS 22.016: "International Mobile station Equipment Identities (IMEI)". | +| 1561 | [8] | 3GPP TS 22.041: "Operator Determined Barring". | +| 1562 | [9] | 3GPP TS 22.081: "Line identification supplementary services - Stage 1". | +| 1563 | [10] | 3GPP TS 22.082: "Call Forwarding (CF) supplementary services - Stage 1". | +| 1564 | [11] | 3GPP TS 22.083: "Call Waiting (CW) and Call Hold (HOLD) Supplementary Services - Stage 1". | +| 1565 | [12] | 3GPP TS 22.084: "Multi Party (MPTY) Supplementary Services - Stage 1". | +| 1566 | [13] | 3GPP TS 22.085: "Closed User Group (CUG) supplementary services - Stage 1". | +| 1567 | [14] | 3GPP TS 22.086: "Advice of charge (AoC) Supplementary Services - Stage 1". | +| 1568 | [15] | 3GPP TS 22.088: "Call Barring (CB) supplementary services - Stage 1". | +| 1569 | [16] | 3GPP TS 22.090: "Unstructured Supplementary Service Data (USSD); - Stage 1". | +| 1570 | [17] | 3GPP TS 23.003: "Numbering, addressing and identification". | +| 1571 | [18] | Void | +| 1572 | [19] | 3GPP TS 23.007: "Restoration procedures". | +| 1573 | [20] | 3GPP TS 23.008: "Organisation of subscriber data". | +| 1574 | [21] | 3GPP TS 23.009: "Handover procedures". | +| 1575 | [22] | 3GPP TS 23.011: "Technical realization of Supplementary Services - General Aspects". | +| 1576 | [23] | 3GPP TS 23.012: "Location management procedures". | +| 1577 | [24] | 3GPP TS 43.020: "Security related network functions". | +| 1578 | [25] | 3GPP TS 23.038: "Alphabets and language". | +| 1579 | [25a] | 3GPP TS 23.039: "Interface protocols for the connection of Short Message Service Centres (SMSCs) to Short Message Entities (SMEs)". | +| 1580 | | | +| 1581 | [26] | 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS) Point to Point (PP)". | +| 1582 | [26a] | 3GPP TS 23.271: "Functional stage2 description of LCS". | +| 1583 | [27] | 3GPP TS 23.081: "Line Identification Supplementary Services - Stage 2". | +| 1584 | [28] | 3GPP TS 23.082: "Call Forwarding (CF) Supplementary Services - Stage 2". | +| 1585 | [29] | 3GPP TS 23.083: "Call Waiting (CW) and Call Hold (HOLD) Supplementary Services - Stage 2". | +| 1586 | [30] | 3GPP TS 23.084: "Multi Party (MPTY) Supplementary Services - Stage 2". | +| 1587 | [31] | 3GPP TS 23.085: "Closed User Group (CUG) Supplementary Services - Stage 2". | +| 1588 | [32] | 3GPP TS 23.086: "Advice of Charge (AoC) Supplementary Services - Stage 2". | + +| | | | +|------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1589 | [33] | 3GPP TS 23.088: "Call Barring (CB) Supplementary Services - Stage 2". | +| 1590 | [34] | 3GPP TS 23.090: "Unstructured Supplementary Services Data (USSD) - Stage 2". | +| 1591 | [34a] | 3GPP TS 33.204: "3G Security; Network domain security; TCAP user security". | +| 1592 | [35] | 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols - Stage 3". | +| 1593 | | | +| 1594 | [36] | 3GPP TS 24.010: "Mobile radio interface layer 3 Supplementary Services specification - General aspects". | +| 1595 | | | +| 1596 | [37] | 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". | +| 1597 | | | +| 1598 | [37a] | 3GPP TS 44.071: "Location Services (LCS) – stage 3". | +| 1599 | [38] | 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification - Formats and coding". | +| 1600 | | | +| 1601 | [39] | 3GPP TS 24.081: "Line identification supplementary services - Stage 3". | +| 1602 | [40] | 3GPP TS 24.082: "Call Forwarding (CF) Supplementary Services - Stage 3". | +| 1603 | [41] | 3GPP TS 24.083: "Call Waiting (CW) and Call Hold (HOLD) supplementary services - Stage 3". | +| 1604 | [42] | 3GPP TS 24.084: "Multi Party (MPTY) Supplementary Services - Stage 3". | +| 1605 | [43] | 3GPP TS 24.085: "Closed User Group (CUG) Supplementary Services - Stage 3". | +| 1606 | [44] | 3GPP TS 24.086: "Advice of Charge (AoC) Supplementary Services - Stage 3". | +| 1607 | [45] | 3GPP TS 24.088: "Call Barring (CB) Supplementary Services - Stage 3". | +| 1608 | [46] | 3GPP TS 24.090: "Unstructured Supplementary Services Data - Stage 3". | +| 1609 | [47] | 3GPP TS 48.002: " Base Station System - Mobile-services Switching Centre (BSS - MSC) interface principles". | +| 1610 | | | +| 1611 | [48] | 3GPP TS 48.006: "Signalling transport mechanism specification for the Base Station System - Mobile-services Switching Centre (BSS - MSC) interface". | +| 1612 | | | +| 1613 | [49] | 3GPP TS 48.008: "Mobile Switching Centre - Base Station System (MSC - BSS) interface; Layer 3 specification". | +| 1614 | | | +| 1615 | [49a1] | 3GPP TS 48.031: "Location Services (LCS); Serving Mobile Location Centre (SMLC) – Serving Mobile Location Centre (SMLC); SMLC Peer Protocol (SMLCPP)". | +| 1616 | | | +| 1617 | [49b] | 3GPP TS 48.071: "Location Services (LCS); Serving Mobile Location Centre - Base Station System (SMLC - BSS) interface Layer 3 specification". | +| 1618 | | | +| 1619 | [50] | 3GPP TS 49.001: "General network interworking scenarios". | +| 1620 | [51] | 3GPP TS 29.002: "Mobile Application Part (MAP) specification". | +| 1621 | [52] | Void | +| 1622 | [53] | Void | +| 1623 | [54] | Void | +| 1624 | [55] | 3GPP TS 29.006: "Interworking between a Public Land Mobile Network (PLMN) and a Packet Switched Public Data Network/Integrated Services Digital Network (PSPDN/ISDN) for the support of Packet Switched data transmission services". | +| 1625 | | | +| 1626 | | | + +| | | | +|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1627 | [56] | 3GPP TS 29.007: "General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". | +| 1628 | | | +| 1629 | | | +| 1630 | [57] | 3GPP TS 29.008: "Application of the Base Station System Application Part (BSSAP) on the E-interface". | +| 1631 | | | +| 1632 | [58] | 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System and BSS - Mobile-services Switching Centre (MS - BSS - MSC) Signalling procedures and the Mobile Application Part (MAP)". | +| 1633 | | | +| 1634 | | | +| 1635 | [59] | 3GPP TS 29.011: "Signalling interworking for Supplementary Services". | +| 1636 | [59a] | 3GPP TS 49.031: "Digital cellular telecommunications system (Phase 2+); Location Services (LCS); Base Station System Application Part LCS Extension (BSSAP-LE)". | +| 1637 | | | +| 1638 | [60] | Void | +| 1639 | [61] | 3GPP TS 52.008: "GSM Subscriber and Equipment Trace". | +| 1640 | [62] | ETS 300 102-1 (1990): "Integrated Services Digital Network (ISDN); User-network interface layer 3 specifications for basic call control". | +| 1641 | | | +| 1642 | [63] | ETS 300 136 (1992): "Integrated Services Digital Network (ISDN); Closed User Group (CUG) supplementary service description". | +| 1643 | | | +| 1644 | [64] | ETS 300 138 (1992): "Integrated Services Digital Network (ISDN); Closed User Group (CUG) supplementary service Digital Subscriber Signalling System No.one (DSS1) protocol". | +| 1645 | | | +| 1646 | [65] | ETS 300 287: "Integrated Services Digital Network (ISDN); Signalling System No.7; Transaction Capabilities (TC) version 2". | +| 1647 | | | +| 1648 | [66] | ETR 060: "Signalling Protocols and Switching (SPS); Guide-lines for using Abstract Syntax Notation One (ASN.1) in telecommunication application protocols". | +| 1649 | | | +| 1650 | [66b] | ETR 091: "ETSI object identifier tree; Common domain Mobile domain" | +| 1651 | [67] | ITU-T Recommendation E.164: "The international public telecommunication numbering plan". | +| 1652 | [68] | ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". | +| 1653 | | | +| 1654 | [69] | ITU-T Recommendation E.213: "Telephone and ISDN numbering plan for land mobile stations in public land mobile networks (PLMN) ". | +| 1655 | | | +| 1656 | [70] | ITU-T Recommendation E.214: "Structure of the land mobile global title for the signalling connection control part (SCCP) ". | +| 1657 | | | +| 1658 | [71] | ITU-T Recommendation Q.699: "Interworking between ISDN access and non-ISDN access over ISDN User Part of Signalling System No. 7 ". | +| 1659 | | | +| 1660 | [72] | ITU-T Recommendation Q.711: "Specifications of Signalling System No.7; Functional description of the Signalling Connection Control Part". | +| 1661 | | | +| 1662 | [73] | ITU-T Recommendation Q.712: "Definition and function of SCCP messages". | +| 1663 | [74] | ITU-T Recommendation Q.713: "Specifications of Signalling System No.7; SCCP formats and codes". | +| 1664 | | | +| 1665 | [75] | ITU-T Recommendation Q.714: "Specifications of Signalling System No.7; Signalling Connection Control Part procedures". | +| 1666 | | | +| 1667 | [76] | ITU-T Recommendation Q.716: "Specifications of Signalling System No.7; Signalling connection control part (SCCP) performances". | +| 1668 | | | + +1669 [77] ITU-T Recommendation Q.721 (1988): "Specifications of Signalling System No.7; Functional +1670 description of the Signalling System No.7 Telephone user part". + +1671 [78] ITU-T Recommendation Q.722 (1988): "Specifications of Signalling System No.7; General +1672 function of Telephone messages and signals". + +1673 [79] ITU-T Recommendation Q.723 (1988): "Specifications of Signalling System No.7; Formats and +1674 codes". + +1675 [80] ITU-T Recommendation Q.724 (1988): "Specifications of Signalling System No.7; Signalling +1676 procedures". + +1677 [81] ITU-T Recommendation Q.725 (1988): "Specifications of Signalling System No.7; Signalling +1678 performance in the telephone application". + +1679 [82] ITU-T Recommendation Q.761 (1988): "Specifications of Signalling System No.7; Functional +1680 description of the ISDN user part of Signalling System No.7". + +1681 [83] ITU-T Recommendation Q.762 (1988): "Specifications of Signalling System No.7; General +1682 function of messages and signals". + +1683 [84] ITU-T Recommendation Q.763 (1988): "Specifications of Signalling System No.7; Formats and +1684 codes". + +1685 [85] ITU-T Recommendation Q.764 (1988): "Specifications of Signalling System No.7; Signalling +1686 procedures". + +1687 [86] ITU-T Recommendation Q.767: "Specifications of Signalling System No.7; Application of the +1688 ISDN user part of CCITT signalling System No.7 for international ISDN interconnections". + +1689 [87] ITU-T Recommendation Q.771: "Specifications of Signalling System No.7; Functional description +1690 of transaction capabilities". + +1691 [88] ITU-T Recommendation Q.772: "Specifications of Signalling System No.7; Transaction +1692 capabilities information element definitions". + +1693 [89] ITU-T Recommendation Q.773: "Specifications of Signalling System No.7; Transaction +1694 capabilities formats and encoding". + +1695 [90] ITU-T Recommendation Q.774: "Specifications of Signalling System No.7; Transaction +1696 capabilities procedures". + +1697 [91] ITU-T Recommendation Q.775: "Specifications of Signalling System No.7; Guide-lines for using +1698 transaction capabilities". + +1699 [92] ITU-T Recommendation X.200: "Reference Model of Open systems interconnection for CCITT +1700 Applications". + +1701 [93] ITU-T Recommendation X.680: "Information technology – Abstract Syntax Notation One +1702 (ASN.1): Specification of basic notation". + +1703 [93b] ITU-T Recommendation X.681: "Information technology – Abstract Syntax Notation One +1704 (ASN.1): Information object specification". + +1705 [94] ITU-T Recommendation X.690: "Information technology – ASN.1 encoding rules: Specification +1706 of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding +1707 Rules (DER)". + +1708 [95] ITU-T Recommendation X.210: "Open systems interconnection layer service definition +1709 conventions". + +1710 [97] 3GPP TS 23.018: "Basic Call Handling". + +1711 [98] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) +1712 Phase 4 - Stage 2". + +| | | | +|------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1713 | [99] | 3GPP TS 23.079: "Support of Optimal Routeing (SOR) - Stage 2". | +| 1714 | [100] | 3GPP TS 43.068: "Voice Group Call Service (VGCS) - Stage 2". | +| 1715 | [101] | 3GPP TS 43.069: "Voice Broadcast service (VBS) - Stage 2". | +| 1716 | [102] | ANSI T1.113: "Signaling System No. 7 (SS7) - ISDN User Part". | +| 1717 | [103] | Void | +| 1718 | [104] | 3GPP TS 23.060: "General Packet Radio Service (GPRS) Service description; Stage 2". | +| 1719 | [105] | 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". | +| 1720 | | | +| 1721 | [106] | 3GPP TS 29.018: "General Packet Radio Service (GPRS); Serving GPRS Support Node (SGSN) - Visitors Location Register (VLR); Gs interface layer 3 specification". | +| 1722 | | | +| 1723 | [107] | 3GPP TS 23.093: "Technical Realization of Completion of Calls to Busy Subscriber (CCBS); Stage 2". | +| 1724 | | | +| 1725 | [108] | 3GPP TS 23.066: "Support of Mobile Number Portability (MNP); Technical Realisation Stage 2". | +| 1726 | [109] | ANSI T1.112 (1996): "Telecommunication – Signalling No. 7 - Signaling Connection Control Part (SCCP)". | +| 1727 | | | +| 1728 | [110] | 3GPP TS 23.116: "Super-Charger Technical Realisation; Stage 2". | +| 1729 | [111] | Void. | +| 1730 | [112] | Void | +| 1731 | [113] | Void | +| 1732 | [114] | Void | +| 1733 | [115] | Void | +| 1734 | [116] | ITU-T Recommendation Q.850 (May 1998): "Usage of cause and location in the Digital Subscriber Signalling System No. 1 and the Signalling System No. 7 ISDN User Part". | +| 1735 | | | +| 1736 | [117] | 3GPP TS 22.135: "Multicall; Service description; Stage 1". | +| 1737 | [118] | 3GPP TS 23.135: "Multicall supplementary service; Stage 2". | +| 1738 | [119] | 3GPP TS 24.135: "Multicall supplementary service; Stage 3". | +| 1739 | [120] | 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". | +| 1740 | | | +| 1741 | [121] | 3GPP TS 29.202: "SS7 signalling transport in core network". | +| 1742 | [122] | 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". | +| 1743 | [123] | 3GPP TS 22.071: "Location Services (LCS); Service description, Stage 1". | +| 1744 | [124] | ITU-T Recommendation X.880: "Data networks and open system communication - Open System Interconnection - Service definitions - Remote operations: Concepts, model and notation". | +| 1745 | | | +| 1746 | [125] | 3GPP TS 23.278: "Customised Applications for Mobile Network Enhanced Logic (CAMEL) Phase 4 – Stage 2 IM CN Interworking (Rel-5)". | +| 1747 | | | +| 1748 | [126] | 3GPP TS 23.172: "Technical realization of Circuit Switched (CS) multimedia service; UDI/RDI fallback and service modification". | +| 1749 | | | +| 1750 | [127] | 3GPP TS 26.103: "Speech codec list for GSM and UMTS". | +| 1751 | [128] | 3GPP TS 23.141: "Presence Service; Architecture and Functional Description". | + +| | | | +|------|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1752 | [129] | 3GPP TS 23.094: "Follow Me (FM) – Stage 2". | +| 1753 | [130] | Void | +| 1754 | [131] | 3GPP TS 32.421: "Subscriber and equipment trace: Trace concepts and requirements". | +| 1755 | [132] | 3GPP TS 32.422: "Subscriber and equipment trace; Trace control and Configuration Management". | +| 1756 | | | +| 1757 | [133] | 3GPP TS 23.236: "Intra-domain connection of Radio Access Network (RAN) nodes to multiple Core Network (CN) nodes". | +| 1758 | | | +| 1759 | [134] | 3GPP TS 23.204: "Support of Short Message Service (SMS) over generic 3GPP Internet Protocol (IP) access". | +| 1760 | | | +| 1761 | [135] | 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services". | +| 1762 | [136] | 3GPP TS 23.067: "enhanced Multi-Level Precedence and Pre-emption service (eMLPP) - Stage 2". | +| 1763 | | | +| 1764 | [137] | 3GPP TS 24.067: "Enhanced Multi-Level Precedence and Pre-emption service (eMLPP); Stage 3". | +| 1765 | [138] | 3GPP TS 22.011: "Service accessibility". | +| 1766 | [139] | IETF RFC 3588: "Diameter Base Protocol". | +| 1767 | [140] | Void | +| 1768 | [141] | 3GPP TS 29.173: "Locations Services; Diameter-based SLh interface for Control Plane LCS". | +| 1769 | [142] | Void | +| 1770 | [143] | 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". | +| 1771 | [144] | 3GPP TS 29.272: "Evolved Packet System (EPS); Mobility Management Entity (MME) and Service GPRS Support Node (SGSN) related interfaces based on Diameter protocol". | +| 1772 | | | +| 1773 | [145] | 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". | +| 1774 | | | +| 1775 | [146] | 3GPP TS 29.205: "Application of Q.1900 series to bearer independent Circuit Switched (CS) core network architecture; Stage 3". | +| 1776 | | | +| 1777 | [147] | 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". | +| 1778 | | | +| 1779 | [148] | 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". | +| 1780 | | | +| 1781 | [149] | 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". | +| 1782 | | | +| 1783 | [150] | 3GPP TS 23.380: "IMS Restoration Procedures". | +| 1784 | [151] | 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". | +| 1785 | [152] | 3GPP TS 29.118: "Mobility Management Entity (MME) - Visitor Location Register (VLR) SGs interface specification". | +| 1786 | | | +| 1787 | [153] | 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". | +| 1788 | [154] | 3GPP TS 23.107: "Quality of Service (QoS) concept and architecture". | + +1790 ADD Automatic Device Detection + +1791 GANSS Galileo and Additional Navigation Satellite Systems + +1792 All other abbreviations used in the present document are listed in 3GPP TS 21.905. + +--- + +## 1793 4 Void + +## 1794 5 Overload and compatibility overview + +### 1795 5.1 Overload control + +1796 There is a requirement for an overload/congestion control for all entities of the Public Land Mobile Network and the +1797 underlying Signalling System No. 7. + +#### 1798 5.1.1 Overload control for MSC (outside MAP) + +1799 For the entity MSC the following two procedures (outside MAP) may be applied to control the processor load: + +- 1800 - ISDN +- 1801 CCITT Recommendation Q.764 (Automatic Congestion Control), applicable to reduce the mobile terminating +- 1802 traffic; +- 1803 - BSSAP +- 1804 3GPP TS 48.008 [49] (A-interface Flow Control), applicable to reduce the mobile originating traffic. + +#### 1805 5.1.2 Overload control for MAP entities + +1806 For all MAP entities, especially the HLR, the following overload control method is applied. + +1807 If overload of a MAP entity is detected requests for certain MAP operations (see tables 5.1/1, 5.1/2, 5.1/3 and 5.1/4) +1808 may be ignored by the responder. The decision as to which MAP Operations may be ignored is made by the MAP +1809 service provider and is based upon the priority of the application context. + +1810 Since most of the affected MAP operations are supervised in the originating entity by TC timers (medium) an additional +1811 delay effect is achieved for the incoming traffic. + +1812 If overload levels are applicable in the Location Registers the MAP operations should be discarded taking into account +1813 the priority of their application context (see table 5.1/1 for HLR, table 5.1/2 for MSC/VLR, table 5.1/3 for the SGSN +1814 and table 5.1/4 for the SMLC; the lowest priority is discarded first). + +1815 The ranking of priorities given in the tables 5.1/1, 5.1/2, 5.1/3 and 5.1/4 is not normative. The tables can only be seen as +1816 a proposal that might be changed due to network operator/implementation matters. + +1817 + +**Table 5.1/1: Priorities of Application Contexts for HLR as Responder** + +| | | | +|------|--------------------------------------------------------------|-----------| +| 1818 | Responder = HLRInitiating Entity | | +| 1819 | Priority high | | +| 1820 | Mobility Management | | +| 1821 | networkLocUp VLR | | +| 1822 | (updateLocation), | | +| 1823 | (restoreData/v2), | | +| 1824 | (sendParameters/v1) | | +| 1825 | gprsLocationUpdate | SGSN | +| 1826 | (updateGPRSLocation/v3), | | +| 1827 | infoRetrieval VLR/SGSN | | +| 1828 | (sendAuthenticationInfo/v2/v3), | | +| 1829 | (sendParameters/v1) | | +| 1830 | istAlerting MSC | | +| 1831 | (istAlert/v3) msPurging | VLR | +| 1832 | (purgeMS/v2/v3) | | +| 1833 | msPurging SGSN | | +| 1834 | (purgeMS/v3) | | +| 1835 | Short Message Service | | +| 1836 | shortMsgGateway GMSC | | +| 1837 | (sendRoutingInfoforSM), | | +| 1838 | (reportSM-DeliveryStatus) | | +| 1839 | mwdMngt VLR/SGSN | | +| 1840 | (readyForSM/v2/v3), | | +| 1841 | (noteSubscriberPresent/v1) | | +| 1842 | Mobile Terminating Traffic | | +| 1843 | locInfoRetrieval GMSC | | +| 1844 | (sendRoutingInfo) | | +| 1845 | anyTimeEnquiry gsmSCF | | +| 1846 | (anyTimeInterrogation/v3) | | +| 1847 | reporting VLR | | +| 1848 | (statusReport) | | +| 1849 | Location Services | | +| 1850 | locationSvcGateway | GMLC | +| 1851 | (sendRoutingInfoforLCS/v3) | | +| 1852 | Subscriber Controlled Inputs (Supplementary Services) | | +| 1853 | networkFunctionalSs | VLR | +| 1854 | (registerSS), | | +| 1855 | (eraseSS), | | +| 1856 | (activateSS), | | +| 1857 | (deactivateSS), | | +| 1858 | (interrogateSS), | | +| 1859 | (registerPassword), | | +| 1860 | (processUnstructuredSS-Data/v1), | | +| 1861 | (beginSubscriberActivity/v1) | | +| 1862 | callCompletion VLR | | +| 1863 | (registerCCEntry), | | +| 1864 | (eraseCCEntry) | | +| 1865 | networkUnstructuredSs | VLR | +| 1866 | (processUnstructuredSS-Request/v2) | | +| 1867 | imsiRetrieval VLR | | +| 1868 | (sendIMSI/v2) | | +| 1869 | gprsLocationInfoRetrieval | GGSN/SGSN | +| 1870 | (sendRoutingInfoForGprs/v3/v4) | | +| 1871 | failureReport GGSN/SGSN | | +| 1872 | (failureReport/v3) | | +| 1873 | authenticationFailureReport | VLR/SGSN | +| 1874 | (authenticationFailureReport/v3) | | + +1875 ***Priority low*** + +1876 NOTE: The application context name is the last component but one of the object identifier. +1877 Operation names are given in brackets for information with "/vn" appended to vn only operations. + +1878 + +**Table 5.1/3: Priorities of Application Contexts for SGSN as Responder** + +| 1879 | Responder = SGSN | Initiating Entity | +|------|------------------------------------------------------|--------------------------| +| 1880 | Priority high | | +| 1881 | Mobility and Location Register Management | | +| 1882 | locationCancel HLR | | +| 1883 | (cancelLocation v3) | | +| 1884 | reset HLR | | +| 1885 | (reset) | | +| 1886 | subscriberDataMngt | HLR | +| 1887 | (insertSubscriberData v3), | | +| 1888 | (deleteSubscriberData v3) | | +| 1889 | tracing HLR | | +| 1890 | (activateTraceMode), | | +| 1891 | (deactivateTraceMode) | | +| 1892 | | | +| 1893 | Short Message Service | | +| 1894 | shortMsgMT-Relay | MSC | +| 1895 | (MT-ForwardSM v3), | | +| 1896 | (forwardSM v1/v2) | | +| 1897 | | | +| 1898 | Location Services | | +| 1899 | | | +| 1900 | locationSvcEnquiry | GMLC | +| 1901 | (provideSubscriberLocation v3) | | +| 1902 | | | +| 1903 | Network-Requested PDP context activation | | +| 1904 | gprsNotify HLR | | +| 1905 | (noteMsPresentForGprs v3), | | +| 1906 | | | +| 1907 | ( Subscriber Location & State retrieval ) | | +| 1908 | subscriberInfoEnquiry | HLR | +| 1909 | (provideSubscriberInformation/v3) | | +| 1910 | | | +| 1911 | Priority low | | + +1912 NOTE: The application context name is the last component but one of the object identifier. +1913 Operation names are given in brackets for information with "/vn" appended to vn. + +**Table 5.1/2: Priorities of Application Contexts for MSC/VLR as Responder** + +| Responder = MSC/VLR | Initiating Entity | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| Priority high | | +| Handover
handoverControl MSC
(prepareHandover/v2/v3),
(performHandover/v1) | | +| Group call and Broadcast call
groupCallControlMSC
(prepareGroupCall/v3)
groupCallInfoRetrieval
(sendGroupCallInfo/v3) | MSC | +| Mobility and Location Register Management
locationCancel HLR
(cancelLocation)
reset HLR
(reset)
immediateTermination
(istCommand/v3)
interVlrInfoRetrieval
(sendIdentification/v2/v3),
(sendParameters/v1)
subscriberDataMngt
(insertSubscriberData),
(deleteSubscriberData)
tracing HLR
(activateTraceMode),
(deactivateTraceMode) | HLR
VLR
HLR | +| Short Message Service
shortMsgMO-Relay
(MO-ForwardSM v3),
(forwardSM v1/v2)
shortMsgMT-Relay
(MT-ForwardSM v3),
(forwardSM v1/v2)
shortMsgAlert HLR
(alertServiceCentre/v2),
(alertServiceCentreWithoutResult/v1) | MSC/SGSN
MSC | +| Mobile Terminating Traffic
resourceMngt GMSC
(releaseResources)
roamingNbEnquiry HLR
(provideRoamingNumber)
callControlTransfer
(resumeCallHandling)
subscriberInfoEnquiry
(provideSubscriberInformation/v3)
reporting HLR
(remoteUserFree),
(SetReportingState) | MSC
HLR | +| Location Services
locationSveEnquiry
(provideSubscriberLocation/v3) | GMLC | +| Network-Initiated USSD
networkUnstructuredSs
(unstructuredSS-Request/v2),
(unstructuredSS-Notify/v2) | HLR | +| Priority low | | + +1916 NOTE: The application context name is the last component but one of the object identifier. +1917 Operation names are given in brackets for information with "/vn" appended to vn only operations. + +### 1918 5.1.3 Congestion control for Signalling System No. 7 + +1919 The requirements of SS7 Congestion control have to be taken into account as far as possible. + +1920 Means that could be applied to achieve the required traffic reductions are described in clauses 5.1.1 and 5.1.2. + +## 1921 5.2 Compatibility + +### 1922 5.2.1 General + +1923 The present document of the Mobile Application Part is designed in such a way that an implementation which conforms +1924 to it can also conform to the Mobile Application Part operational version 1 specifications, except on the MSC-VLR +1925 interface. + +1926 A version negotiation mechanism based on the use of an application-context-name is used to negotiate the protocol +1927 version used between two entities for supporting a MAP-user signalling procedure. + +1928 When starting a signalling procedure, the MAP-user supplies an application-context-name to the MAP-provider. This +1929 name refers to the set of application layer communication capabilities required for this dialogue. This refers to the +1930 required TC facilities (e.g. version 1 or 2) and the list of operation packages (i.e. set of operations) from which +1931 operations can be invoked during the dialogue. + +1932 A version one application-context-name may only be transferred to the peer user in a MAP-U-ABORT to an entity of +1933 version two or higher (i.e. to trigger a dialogue which involves only communication capabilities defined for MAP +1934 operational version 1). + +1935 If the proposed application-context-name can be supported by the responding entity the dialogue continues on this basis +1936 otherwise the dialogue is refused and the initiating user needs to start a new dialogue, which involves another +1937 application-context-name which requires less communication capabilities but provides similar functionality (if +1938 possible). + +1939 When a signalling procedure can be supported by several application contexts that differ by their version number, the +1940 MAP-User needs to select a name. It can either select the name that corresponds to the highest version it supports or +1941 follow a more specific strategy so that the number of protocol fallbacks due to version compatibility problems is +1942 minimised. + +### 1943 5.2.2 Strategy for selecting the Application Context (AC) version + +1944 A method should be used to minimise the number of protocol fall-backs which would occur sometimes if the highest +1945 supported AC-Name were always the one selected by GSM entities when initiating a dialogue. The following method is +1946 an example that can be used mainly at transitory phase stage when the network is one of mixed phase entities. + +#### 1947 5.2.2.1 Proposed method + +1948 A table (table 1) may be set up by administrative action to define the highest application context (AC) version supported +1949 by each destination; a destination may be another node within the same or a different PLMN, or another PLMN +1950 considered as a single entity. The destination may be defined by an E.164 number or an E.214 number derived from an +1951 IMSI or in North America (World Zone 1) by an E.164 number or an IMSI (E.212 number). The table also includes the +1952 date when each destination is expected to be able to handle at least one AC of the latest version of the MAP protocol. +1953 When this date is reached, the application context supported by the node is marked as "unknown", which will trigger the +1954 use of table 2. + +1955 A second table (table 2) contains an entry for each destination that has an entry in table 1. For a given entity, the entry +1956 in table 2 may be a single application context version or a vector of different versions applying to different application +1957 contexts for that entity. Table 2 is managed as described in clause 5.2.2.2. + +1958 The data for each destination will go through the following states: + +- 1959 a) the version shown in table 1 is "version n-1", where 'n' is the highest version existing in this specification; table 2 +1960 is not used; +- 1961 b) the version shown in table 1 is "unknown"; table 2 is used, and maintained as described in clause 5.2.2.2; +- 1962 c) when the PLMN operator declares that an entity (single node or entire PLMN) has been upgraded to support all +1963 the MAP version n ACs defined for the relevant interface, the version shown in table 1 is set to "version n" by +1964 administrative action; table 2 is no longer used, and the storage space may be recovered. + +## 1965 5.2.2.2 Managing the version look-up table + +1966 **WHEN** it receives a MAP-OPEN and the MAP-User determines the originating entity number either using the +1967 originating address parameter or the originating reference parameter or retrieving it from the subscriber data using the +1968 IMSI or the MSISDN. + +1969 **IF** the entity number is known: + +1970 **THEN** + +1971 It updates (if required) the associated list of highest supported ACs. + +1972 **ELSE** + +1973 It creates an entry for this entity and includes the received AC-name in the list of highest supported ACs. + +1974 **WHEN** starting a procedure, the originating MAP-user looks up its version control table. + +1975 **IF** the destination address is known and not timed-out. + +1976 **THEN** + +1977 It retrieves the appropriate AC-name and uses it + +1978 **IF** the dialogue is accepted by the peer + +1979 **THEN** + +1980 It does not modify the version control table + +1981 **ELSE** (this should never occur) + +1982 It starts a new dialogue with the common highest version supported (based on information implicitly +1983 or explicitly provided by the peer). + +1984 It replaces the old AC-name by the new one in the list of associated highest AC supported. + +1985 **ELSE** + +1986 It uses the AC-name that corresponds to the highest version it supports. + +1987 **IF** the dialogue is accepted by the peer. + +1988 **THEN** + +1989 It adds the destination node in its version control table and includes the AC-Name in the list of +1990 associated highest AC supported. + +1991 **ELSE** + +1992 It starts a new dialogue with the common highest version supported (based on information implicitly or +1993 explicitly provided by the peer). + +1994 **IF** the destination node was not known + +1995 **THEN** + +1996 It adds the destination node in its version control table and includes the new AC-Name in the list of +1997 associated highest AC supported. + +1998 **ELSE** + +1999 It replaces the old AC-name by the new one in the list of highest supported AC and reset the timer. + +### 2000 5.2.2.3 Optimising the method + +2001 A table look-up may be avoided in some cases if both the HLR and the VLR or both the HLR and the SGSN store for +2002 each subscriber the version of the AC-name used at location updating. Then: + +2003 - for procedures which make use of the same application-context, the same AC-name (thus the same version) can +2004 be selected (without any table look-up) when the procedure is triggered; + +2005 - for procedures which make use of a different application-context but which includes one of the packages used by +2006 the location updating AC, the same version can be selected (without any table look-up) when the procedure is +2007 triggered; + +2008 **for HLR:** + +2009 - Subscriber data modification (stand alone); + +2010 **for VLR:** + +2011 - Data Restoration. + +--- + +## 2012 6 Requirements concerning the use of SCCP and TC + +### 2013 6.1 Use of SCCP + +2014 The Mobile Application Part (MAP) makes use of the services offered by the Signalling Connection Control Part +2015 (SCCP). + +2016 MAP supports the following SCCP versions: + +2017 - Signalling Connection Control Part, Signalling System no. 7 CCITT ('Blue Book SCCP'); + +2018 - Signalling Connection Control Part, Signalling System no. 7 ITU-T Recommendation (07/96) Q.711 to Q.716 +2019 ('White Book SCCP'). Support of White Book SCCP at the receiving side shall be mandated from 00:01hrs, 1st +2020 July 2002(UTC). However, for signalling over the MAP E-interface to support inter-MSC handover/relocation, +2021 the support of White Book SCCP shall be mandated with immediate effect. + +2022 A White Book SCCP message will fail if any signalling point used in the transfer of the message does not support +2023 White Book SCCP. Therefore it is recommended that the originator of the White Book SCCP message supports a drop +2024 back mechanism or route capability determination mechanism to interwork with signalling points that are beyond the +2025 control of GSM/UMTS network operators. + +2026 In North America (World Zone 1) the national version of SCCP is used as specified in ANSI T1.112. Interworking +2027 between a PLMN in North America and a PLMN outside North America will involve an STP to translate between +2028 ANSI SCCP and ITU-T/CCITT SCCP. + +2029 The SCCP is identified as an MTP3-user and the transport of SCCP messages between two entities shall be +2030 accomplished according to the 3GPP TS 29.202 [121]. + +#### 2031 6.1.1 SCCP Class + +2032 MAP will only make use of the connectionless classes (0 or 1) of the SCCP. + +#### 2033 6.1.2 Sub-System Number (SSN) + +2034 The Application Entities (AEs) defined for MAP consist of several Application Service Elements (ASEs) and are + 2035 addressed by sub-system numbers (SSNs). The SSNs for MAP are specified in 3GPP TS 23.003 [17]. + +2036 When the SGSN emulates MSC behaviour for processing messages (MAP-MO-FORWARD-SHORT-MESSAGE, + 2037 MAP\_CHECK\_IMEI, MAP\_SUBSCRIBER\_LOCATION\_REPORT) towards entities which do not support + 2038 interworking to SGSNs, it shall use the MSC SSN in the calling party address instead of the SGSN SSN. + +2039 When present in the network, the Presence Network Agent emulates the behaviour of the GSM Service Control + 2040 Function (gsm SCF) for processing of messages (MAP-NOTE-MM-EVENT, MAP-ANY-TIME-INTERROGATION + 2041 and MAP-ANY-TIME-MODIFICATION). + +2042 When a FFN (Follow Me Functional Node, see TS 23.094 [129]) is implemented in a network entity different from + 2043 HLR, this network entity shall emulate HLR behaviour, i.e. it shall accept MAP-PROCESS-UNSTRUCTURED-SS- + 2044 REQUEST messages addressed with SSN for HLR. + +2045 In an EPS, an Interworking Function (IWF) may be used to convert Diameter S6a messages to MAP Gr messages and + 2046 vice versa; also an IWF may be used to convert Diameter S13 messages to MAP Gf messages and vice versa. An SSN + 2047 value for the IWF does not exist. Instead the IWF shall use the SGSN SSN value when serving an MME and use the + 2048 HLR SSN when serving an HSS. An IWF is said to serve an MME (or HSS) when Diameter messages are exchanged + 2049 between the IWF and the MME (or HSS). + +2050 In a 5GS, a UDM may support a MAP interface towards the SMS-GMSC/SMS-Router by emulating HLR behaviour, + 2051 i.e. the UDM may have an integrated/collocated HLR component serving the MAP communication to the SMS- + 2052 GMSC/SMS-Router. An SSN value for UDM does not exist. Instead the UDM (with an integrated/collocated HLR) + 2053 shall use the HLR SSN value. + +2054 + +## 2055 6.1.3 SCCP addressing + +### 2056 6.1.3.1 Introduction + +2057 Within the GSM System there will be a need to communicate between entities within the same PLMN and in different + 2058 PLMNs. Using the Mobile Application Part (MAP) for this function implies the use of Transaction Capabilities (TC) + 2059 and the Signalling Connection Control Part (SCCP) of CCITT Signalling System No. 7. + +2060 Only the entities that should be addressed are described below. If the CCITT or ITU-T SCCP is used, the format and + 2061 coding of address parameters carried by the SCCP for that purpose shall comply with CCITT Recommendation Q.713 + 2062 with the following restrictions: + +#### 2063 1) Intra-PLMN addressing + +2064 For communication between entities within the same PLMN, a MAP SSN shall always be included in the + 2065 called and calling party addresses. All other aspects of SCCP addressing are network specific. + +#### 2066 2) Inter-PLMN addressing + +##### 2067 a) Called Party Address + +- 2068 - SSN indicator = 1 (MAP SSN always included); +- 2069 - Global title indicator = 0100 (Global title includes translation type, numbering plan, encoding scheme and + 2070 nature of address indicator); +- 2071 - the translation type field will be coded "00000000" (Not used). For call related messages for non-optimal + 2072 routed calls (as described in 3GPP TS 23.066 [108]) directed to another PLMN the translation type field + 2073 may be coded "10000000" (CRMNP); +- 2074 - Routing indicator = 0 (Routing on global title); + +##### 2075 b) Calling Party Address + +- 2076 - SSN indicator = 1 (MAP SSNs always included); + +2077 - Point code indicator = 0; + +2078 - Global title indicator = 0100 (Global title includes translation type, numbering plan, encoding scheme and +2079 nature of address indicator); + +2080 - Numbering Plan = 0001 (ISDN Numbering Plan, E.164; In Case of Inter-PLMN Signalling, the dialogue +2081 initiating entity and dialogue responding entity shall always include its own E.164 Global Title as Calling +2082 Party Address); + +2083 - the translation type field will be coded "00000000" (Not used); + +2084 - Routing indicator = 0 (Routing on Global Title). + +2085 If ANSI T1.112 SCCP is used, the format and coding of address parameters carried by the SCCP for that purpose shall +2086 comply with ANSI specification T1.112 with the following restrictions: + +2087 1) Intra-PLMN addressing + +2088 For communication between entities within the same PLMN, a MAP SSN shall always be included in the +2089 called and calling party addresses. All other aspects of SCCP addressing are network specific. + +2090 2) Inter-PLMN addressing + +2091 a) Called Party Address + +2092 - SSN indicator = 1 (MAP SSN always included); + +2093 - Global title indicator = 0010 (Global title includes translation type); + +2094 - the Translation Type (TT) field will be coded as follows: + +2095 TT = 9, if IMSI is included; + +2096 TT = 14, if MSISDN is included; + +2097 Or TT = 10, if Network Element is included. (If TT=10, then Number Portability GTT is not invoked, +2098 if TT=14, then Number Portability GTT may be invoked). + +2099 - Routing indicator = 0 (Routing on global title); + +2100 b) Calling Party Address + +2101 - SSN indicator = 1 (MAP SSNs always included); + +2102 - Point code indicator = 0; + +2103 - Global Title indicator = 0010 (Global title includes translation type); + +2104 TT = 9, if IMSI is included; + +2105 TT = 14, if MSISDN is included; + +2106 Or TT = 10, if Network Element is included. (If TT=10, then Number Portability GTT is not invoked, +2107 if TT=14, then Number Portability GTT may be invoked). + +2108 Routing indicator = 0 (Routing on Global Title). + +2109 If a Global Title translation is required for obtaining routeing information, one of the numbering plans E.164, E.212 and +2110 E.214 is applicable. + +2111 - E.212 numbering plan. + +2112 When CCITT or ITU-T SCCP is used, an E.212 number must not be included as Global Title in an SCCP +2113 UNITDATA message. The translation of an E.212 number into a Mobile Global Title is applicable in a +2114 dialogue initiating VLR, SGSN or GGSN if the routeing information towards the HLR is derived from the +2115 subscriber's IMSI. In World Zone 1 when ANSI SCCP is used, the IMSI (E.212 number) is used as a Global +2116 Title to address the HLR. When an MS moves from one VLR service area to another, the new VLR may + +2117            derive the address of the previous VLR from the Location Area Identification provided by the MS in the +2118            location registration request. The PLMN where the previous VLR is located is identified by the E.212 +2119            numbering plan elements of the Location Area Identification, i.e. the Mobile Country Code (MCC) and the +2120            Mobile Network Code (MNC). + +2121    -   E.214 and E.164 numbering plans. + +2122            When CCITT or ITU-T SCCP is used, only address information belonging to either E.214 or E.164 +2123            numbering plan is allowed to be included as Global Title in the Called and Calling Party Address. In World +2124            Zone 1 when ANSI SCCP is used, the IMSI (E.212 number) is used as a Global Title to address the HLR. + +2125            If the Calling Party Address associated with the dialogue initiating message contains a Global Title, the +2126            sending network entity shall include its E.164 entity number. + +2127            When receiving an SCCP UNITDATA message, SCCP shall accept either of the valid numbering plans in +2128            the Called Party Address and in the Calling Party Address. + +2129            When CCITT or ITU-T SCCP is used and an N-UNITDATA-REQUEST primitive from TC is received, +2130            SCCP shall accept an E.164 number or an E.214 number in the Called Address and in the Calling Address. In +2131            World Zone 1 when ANSI SCCP is used, the IMSI (E.212 number) is used instead of E.214 number. + +2132 The following clauses describe the method of SCCP addressing appropriate for each entity both for the simple +2133 intra-PLMN case and where an inter-PLMN communication is required. The following entities are considered: + +- 2134    -   the Mobile-services Switching Centre (MSC); +- 2135    -   the Home location Register (HLR); +- 2136    -   the Visitor Location Register (VLR); +- 2137    -   the Gateway Mobile-services Switching Centre (GMSC); +- 2138    -   the GSM Service Control Function (gsmSCF); +- 2139    -   the Interworking Mobile-services Switching Centre (IWMSC); +- 2140    -   the Serving GPRS Support Node (SGSN); +- 2141    -   the Gateway GPRS Support Node (GGSN); +- 2142    -   the Gateway Mobile Location Centre (GMLC); +- 2143    -   the CSG Subscriber Server (CSS). + +### 2144 6.1.3.2            The Mobile-services Switching Centre (MSC) + +2145 There are several cases where it is necessary to address the MSC. + +#### 2146 6.1.3.2.1            MSC interaction during handover or relocation + +2147 The address is derived from the target Cell id or from the target RNC id. + +#### 2148 6.1.3.2.2            MSC for short message routing + +2149 When a short message has to be routed to an MS, the GMSC addresses the VMSC by an MSC identity received from +2150 the HLR that complies with E.164 rules. + +2151 For MS originating short message, the IWMSC address is derived from the Service Centre address. + +#### 2152 6.1.3.2.3            MSC for location request routing + +2153 When a location request for a particular MS needs to be sent to the MS's VMSC, the GMLC addresses the VMSC using +2154 an E.164 address received from the MS's HLR. + +#### 2155 6.1.3.2.4 MSC for LMU Control + +2156 When a control message has to be routed to an LMU from an SMLC, the SMLC addresses the serving MSC for the +2157 LMU using an E.164 address. + +#### 2158 6.1.3.3 The Home Location Register (HLR) + +2159 There are several cases where the HLR has to be addressed. + +##### 2160 6.1.3.3.1 During call set-up + +2161 When a call is initiated the HLR of the called mobile subscriber will be interrogated to discover the whereabouts of the +2162 MS. The addressing required by the SCCP will be derived from the MSISDN dialled by the calling subscriber. The +2163 dialled number will be translated into either an SPC, in the case of communications within a PLMN, or a Global Title if +2164 other networks are involved (i.e. if the communication is across a PLMN boundary). + +2165 If the calling subscriber is a fixed network subscriber, the interrogation can be initiated from the Gateway MSC of the +2166 home PLMN in the general case. If the topology of the network allows it, the interrogation could be initiated from any +2167 Signalling Point that has MAP capabilities, e.g. local exchange, outgoing International Switching Centre (ISC), etc. + +##### 2168 6.1.3.3.2 Before location updating completion + +2169 When an MS registers for the first time in a VLR, the VLR has to initiate the update location dialogue with the MS's +2170 HLR and a preceding dialogue for authentication information retrieval if the authentication information must be +2171 retrieved from the HLR. When initiating either of these dialogues, the only data for addressing the HLR that the VLR +2172 has available is contained in the IMSI, and addressing information for SCCP must be derived from it. When continuing +2173 the established update location dialogue (as with any other dialogue), the VLR must derive the routeing information +2174 towards the HLR from the Calling Party Address received with the first responding CONTINUE message until the +2175 dialogue terminating message is received. This means that the VLR must be able to address the HLR based on: + +- 2176 - an E.214 Mobile Global Title originally derived by the VLR from the IMSI (when CCITT or ITU-T SCCP is +2177 used), or an E.212 number originally derived from IMSI (when ANSI SCCP is used, an IMSI); or +- 2178 - an E.164 HLR address; or +- 2179 - in the case of intra-PLMN signalling, an SPC. + +2180 When answering with Global Title to the VLR, the HLR shall insert its E.164 address in the Calling Party Address of +2181 the SCCP message containing the first responding CONTINUE message. + +2182 If the HLR is in the same PLMN as the VLR, local translation tables may exist to derive an SPC. For authentication +2183 information retrieval and location updating via the international PSTN/ISDN signalling network that requires the use of +2184 CCITT or ITU-T SCCP, the Global Title must be derived from the IMSI, using the principles contained in CCITT +2185 Recommendation E.214 and the Numbering Plan Indicator (NPI) value referenced by the SCCP Specifications. In +2186 World Zone 1 where the ANSI SCCP is used, IMSI (E.212 number) is used as Global Title. A summary of the +2187 translation from the IMSI (CCITT Recommendation E.212) to Mobile Global Title (described in CCITT +2188 Recommendation E.214) is shown below: + +- 2189 - E.212 Mobile Country Code translates to E.164 Country Code; +- 2190 - E.212 Mobile Network Code translates to E.164 National Destination Code; +- 2191 - E.212 Mobile Subscriber Identification Number (MSIN) is carried unchanged if within the E.164 number +2192 maximum length (15 digits). If the Mobile Global Title is more than 15 digits the number is truncated to 15 by +2193 deleting the least significant digits. + +2194 This translation will be done either at the application or at SCCP level in the VLR. The Mobile Global Title thus +2195 derived will be used to address the HLR. + +2196 If location updating is triggered by an MS that roams from one MSC Area into a different MSC Area served by the +2197 same VLR, the VLR shall address the HLR in the same way as if the MS registers for the first time in the VLR. + +##### 2198 6.1.3.3.3 After location updating completion + +2199 In this case, the subscriber's basic MSISDN has been received from the HLR during the subscriber data retrieval +2200 procedure as well as the HLR number constituting a parameter of the MAP message indicating successful completion of +2201 the update location dialogue. From either of these E.164 numbers the address information for initiating dialogues with +2202 the roaming subscriber's HLR can be derived. Also the subscriber's IMSI may be used for establishing the routeing +2203 information towards the HLR. This may apply in particular if the dialogue with the HLR is triggered by subscriber +2204 controlled input. + +2205 Thus the SCCP address of the roaming subscriber's HLR may be an SPC, or it may be a Global title consisting of the +2206 E.164 MSISDN or the E.164 number allocated to the HLR or either the E.214 Mobile Global Title derived from the +2207 IMSI if CCITT or ITU-T SCCP is used, or the IMSI if ANSI SCCP is used (ANSI SCCP is used in World Zone 1). + +#### 2208 6.1.3.3.4 VLR restoration + +2209 If a roaming number is requested by the HLR for an IMSI that has no data record in the interrogated VLR, the VLR +2210 provides the roaming number in the dialogue terminating message. Subsequently the VLR must retrieve the +2211 authentication data from the MS's HLR, if required, and must then trigger the restore data procedure. For this purpose, +2212 the VLR has to initiate in succession two independent dialogues with the MS's HLR. The MTP and SCCP address +2213 information needed for routeing towards the HLR can be derived from the IMSI received as a parameter of the MAP +2214 message requesting the roaming number. In this case, the IMSI received from the HLR in the roaming number request +2215 shall be processed in the same way as the IMSI that is received from an MS that registers for the first time within a +2216 VLR. Alternatively to the IMSI, the Calling Party Address associated with the roaming number request may be used to +2217 obtain the routeing information towards the HLR. + +#### 2218 6.1.3.3.5 During Network-Requested PDP Context Activation + +2219 When receiving a PDP PDU the GGSN may interrogate the HLR of the MS for information retrieval. When initiating +2220 such a dialogue, the only data for addressing the HLR that the GGSN has available is contained in the IMSI, and +2221 addressing information must be derived from it. The IMSI is obtained from the IP address or the X.25 address in the +2222 incoming IP message by means of a translation table. This means that the GGSN shall be able to address the HLR based +2223 on an E.214, (if CCITT or ITU-T SCCP is used), or E.212 (if ANSI SCCP is used), Mobile Global Title originally +2224 derived by the GGSN from the IMSI in the case of inter-PLMN signalling. In the case of intra-PLMN signalling, an +2225 SPC may also be used. + +2226 If the HLR is in the same PLMN as the GGSN, local translation tables may exist to derive an SPC. For information +2227 retrieval via the international PSTN/ISDN signalling network, the Global title must be derived from the IMSI, using the +2228 principles contained in CCITT Recommendation E.214 and the Numbering Plan Indicator (NPI) value referenced by the +2229 SCCP Specifications. A summary of the translation from the IMSI (CCITT Recommendation E.212) to Mobile Global +2230 Title (described in CCITT Recommendation E.214) is shown below: + +- 2231 - E.212 Mobile Country Code translates to E.164 Country Code; +- 2232 - E.212 Mobile Network Code translates to E.164 National Destination Code; +- 2233 - E.212 Mobile Subscriber Identification Number (MSIN) is carried unchanged if within the E.164 number +2234 maximum length (15 digits). If the Mobile Global Title is more than 15 digits the number is truncated to 15 by +2235 deleting the least significant digits. + +2236 This translation will be done either at the application or at SCCP level in the GGSN. The Mobile Global Title thus +2237 derived will be used to address the HLR. + +#### 2238 6.1.3.3.6 Before GPRS location updating completion + +2239 When an MS registers for the first time in an SGSN, the SGSN has to initiate the update location dialogue with the +2240 MS's HLR and a preceding dialogue for authentication information retrieval if the authentication information must be +2241 retrieved from the HLR. When initiating either of these dialogues, the only data for addressing the HLR that the SGSN +2242 has available is contained in the IMSI, and addressing information for SCCP must be derived from it. When continuing +2243 the established update location dialogue (as with any other dialogue), the SGSN must derive the routeing information +2244 towards the HLR from the Calling Party Address received with the first responding CONTINUE message until the +2245 dialogue terminating message is received. This means that the SGSN must be able to address the HLR based on: + +- 2246 - an E.214 (if CCITT or ITU-T SCCP is used) or E.212 (if ANSI SCCP is used) Mobile Global Title originally +2247 derived by the SGSN from the IMSI; or + +2248 - an E.164 HLR address; or + +2249 - in the case of intra-PLMN signalling, an SPC. + +2250 If the HLR is in the same PLMN as the SGSN, local translation tables may exist to derive an SPC. For authentication +2251 information retrieval and location updating via the international PSTN/ISDN signalling network, the Global title must +2252 be derived from the IMSI, using the principles contained in CCITT Recommendation E.214 and the Numbering Plan +2253 Indicator (NPI) value referenced by the SCCP Specifications. A summary of the translation from the IMSI (CCITT +2254 Recommendation E.212) to Mobile Global Title (described in CCITT Recommendation E.214) is shown below: + +2255 - E.212 Mobile Country Code translates to E.164 Country Code; + +2256 - E.212 Mobile Network Code translates to E.164 National Destination Code; + +2257 - E.212 Mobile Subscriber Identification Number (MSIN) is carried unchanged if within the E.164 number +2258 maximum length (15 digits). If the Mobile Global Title is more than 15 digits the number is truncated to 15 by +2259 deleting the least significant digits. + +2260 This translation will be done either at the application or at SCCP level in the SGSN. The Mobile Global Title thus +2261 derived will be used to address the HLR. + +#### 2262 6.1.3.3.7 After GPRS location updating completion + +2263 In this case, the subscriber's Basic MSISDN has been received from the HLR during the subscriber data retrieval +2264 procedure as well as the HLR number constituting a parameter of the MAP message indicating successful completion of +2265 the update location dialogue. From either of these E.164 numbers the address information for initiating dialogues with +2266 the roaming subscriber's HLR can be derived. Also the subscriber's IMSI may be used for establishing the routeing +2267 information towards the HLR. + +2268 Thus the SCCP address of the roaming subscriber's HLR may be an SPC, or it may be a Global title consisting of the +2269 E.164 MSISDN or the E.164 number allocated to the HLR or the E.214 Mobile Global Title derived from the IMSI. + +#### 2270 6.1.3.3.8 Query for a Location Request + +2271 For a location request from an external client, the GMLC needs to address the home HLR of the target MS to obtain the +2272 address of the target MS's serving MSC. The GMLC uses either the international E.164 MSISDN, the international +2273 E.214 number (if CCITT or ITU-T SCCP is used) or the international E.212 number (if ANSI SCCP is used) of the MS +2274 as means to route a query to the HLR. + +### 2275 6.1.3.4 The Visitor Location Register (VLR) + +#### 2276 6.1.3.4.0 General + +2277 There are several cases when the VLR needs to be addressed. + +#### 2278 6.1.3.4.1 Inter-VLR information retrieval + +2279 When an MS moves from one VLR service area to another, the new VLR may request the IMSI and authentication sets +2280 from the previous VLR. The new VLR derives the address of the previous VLR from the Location Area Identification +2281 provided by the MS in the location registration request. + +#### 2282 6.1.3.4.2 HLR request + +2283 The HLR will only request information from a VLR if it is aware that one of its subscribers is in the VLR service area. +2284 This means that a location updating dialogue initiated by the VLR has been successfully completed, i.e. the HLR has +2285 indicated successful completion of the update location procedure to the VLR. + +2286 When initiating dialogues towards the VLR after successful completion of location updating, the routeing information +2287 used by the HLR is derived from the E.164 VLR number received as a parameter of the MAP message initiating the +2288 update location dialogue. If the VLR is in the same PLMN as the HLR, the VLR may be addressed directly by an SPC +2289 derived from the E.164 VLR number. For dialogues via the international PSTN/ISDN signalling network, presence of +2290 the E.164 VLR number in the Called Party Address is required. + +#### 2291 6.1.3.4.3 CSS request + +2292 The CSS will only request information from a VLR if it is aware that one of its subscribers is in the VLR service area. +2293 This means that a VCSG location updating dialogue initiated by the VLR has been successfully completed, i.e. the CSS +2294 has indicated successful completion of the update VCSG location procedure to the VLR. + +2295 When initiating dialogues towards the VLR after successful completion of VCSG location updating, the routeing +2296 information used by the CSS is derived from the E.164 VLR number received as a parameter of the MAP message +2297 initiating the update VCSG location dialogue. The VLR may be addressed either by the E.164 VLR number or directly +2298 by an SPC derived from the E.164 VLR number due to the VLR is in the same PLMN as the CSS. + +#### 2299 6.1.3.5 The Interworking MSC (IWMSC) for Short Message Service + +2300 The IWMSC is the interface between the mobile network and the network to access to the Short Message Service +2301 Centre. This exchange has an E.164 address known in the SGSN or in the MSC. + +#### 2302 6.1.3.6 The Equipment Identity Register (EIR) + +2303 The EIR address is either unique or could be derived from the IMEI. The type of address is not defined. + +#### 2304 6.1.3.7 Void + +#### 2305 6.1.3.8 The Serving GPRS Support Node (SGSN) + +##### 2306 6.1.3.8.0 General + +2307 There are several cases when the SGSN needs to be addressed. + +##### 2308 6.1.3.8.1 HLR request + +2309 The HLR will initiate dialogues towards the SGSN if it is aware that one of its subscribers is in the SGSN serving area. +2310 This means that a GPRS location updating has been successfully completed, i.e., the HLR has indicated successful +2311 completion of the GPRS location update to the SGSN. The routeing information used by the HLR is derived from the +2312 E.164 SGSN number received as parameter of the MAP message initiating the GPRS update location procedure. If the +2313 SGSN is in the same PLMN as the HLR, the SGSN may be addressed directly by an SPC derived from the E.164 SGSN +2314 number. For dialogues via the international PSTN/ISDN signalling network, the presence of the E.164 SGSN number in +2315 the Called Party Address is required. + +##### 2316 6.1.3.8.2 GMSC request + +2317 When the GMSC initiates dialogues towards the SGSN the SGSN (MAP) SSN (See 3GPP TS 23.003 [17]) shall be +2318 included in the called party address. The routeing information used by the GMSC is derived from the E.164 SGSN +2319 number received as a parameter of the MAP message initiating the forward short message procedure. If the GMSC does +2320 not support the GPRS functionality the MSC (MAP) SSN value shall be included in the called party address. + +2321 NOTE: Every VMSC and SGSN shall have uniquely identifiable application using E.164 numbers, for the +2322 purpose of SMS over GPRS when the GMSC does not support the GPRS functionality. + +##### 2323 6.1.3.8.3 CSS request + +2324 The CSS will initiate dialogues towards the SGSN if it is aware that one of its subscribers is in the SGSN serving area. +2325 This means that a VCSG location updating has been successfully completed, i.e., the CSS has indicated successful +2326 completion of the VCSG location update to the SGSN. The routeing information used by the CSS is derived from the +2327 E.164 SGSN number received as parameter of the MAP message initiating the update VCSG location procedure. The +2328 SGSN may be addressed either by the E.164 SGSN number or directly by an SPC derived from the E.164 SGSN +2329 number due to the SGSN is in the same PLMN as the CSS. + +#### 2330 6.1.3.9 The Gateway GPRS Support Node (GGSN) + +2331 The GGSN provides interworking with external packet-switched networks, network screens and routing of the +2332 Network-Requested PDP Context activation. If a Network-Requested PDP Context activation fails, the HLR will alert +2333 the GGSN when the subscriber becomes reachable. The HLR will use the E.164 GGSN number received as parameter +2334 of the MAP message reporting the failure. + +### 2335 6.1.3.10 The Gateway MSC (GMSC) for Short Message Service + +2336 The GMSC provides interworking with the network to access the Short Message Service Centre, the mobile network +2337 and routing of Send Routing Info For SM. The GMSC has an E.164 address known in the HLR, SGSN or MSC. + +2338 6.1.3.10A Void + +2339 6.1.3.10A.1 Void + +2340 6.1.3.10A.2 Void + +### 2341 6.1.3.10B The Gateway Mobile Location Centre (GMLC) + +2342 The GMLC initiates location requests on behalf of external clients. The E.164 address of the GMLC is provided to an +2343 HLR when the GMLC requests a serving MSC address or SGSN address from the HLR for a target MS. The E.164 +2344 address of the GMLC is also provided to a serving MSC or SGSN when the GMLC requests the location of a target MS +2345 served by this MSC or SGSN. + +### 2346 6.1.3.10C The CSG Subscriber Server (CSS) + +2347 The CSS address is either unique or could be derived from the IMSI. **The type of address is not defined.** + +### 2348 6.1.3.11 Summary table + +2349 The following tables summarise the SCCP address used for invoke operations. As a principle, within a PLMN either an +2350 SPC or a GT may be used (network operation option), whereas when addressing an entity outside the PLMN the GT +2351 must be used. The address type mentioned in the table (e.g. MSISDN) is used as GT or to derive the SPC. + +2352 For a response, the originating address passed in the invoke is used as SCCP Called Party Address. For extra-PLMN +2353 addressing the own E.164 entity address is used as SCCP Calling Party Address; for intra-PLMN addressing an SPC +2354 derived from the entity number may be used instead. When using an SPC, the SPC may be taken directly from MTP. + + + +| to
from | fixed
net
work | HLR | VLR | MSC | EIR | gsmSCF | SGSN | GGSN | CSS | +|------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------|-------------------------------------|-------------------------------------|-------------------------------------|----------------------------------------|--------------------------------------|--------------------------------------|--------------------------------------| +| fixed
network | --- | E:GT
T:MSISDN | --- | --- | --- | --- | --- | --- | --- | +| Home
Location
Register | --- | --- | I:SPC/GT
E:GT
T:VLR
NUMBER | --- | --- | I:SPC/GT
E:GT
T:gsmSCF
NUMBER | I:SPC/GT
E:GT
T:SGSN
NUMBER | I:SPC/GT
E:GT
T:GGSN
NUMBER | --- | +| Visitor
Location
Register | --- | I:SPC/GT
E:GT
T:MGT
(outside
World Zone
1)/MSISDN
(World Zone
1)/HLR
NUMBER
(note) | I:SPC/GT
E:GT
T:VLR
NUMBER | --- | --- | I:SPC/GT
E:GT
T:gsmSCF
NUMBER | --- | --- | I: SPC/GT
E:GT
T:CSS
NUMBER | +| mobile-
services
switching
centre | --- | I:SPC/GT
E:GT
T:MSISDN | I:SPC/GT
E:GT
T:VLR
NUMBER | I:SPC/GT
E:GT
T:MSC
NUMBER | I:SPC/GT
E:GT
T:EIR
NUMBER | I:SPC/GT
E:GT
T:gsmSCF
NUMBER | I:SPC/GT
E:GT
T:SGSN
NUMBER | --- | --- | +| gsm
Service
Control
Function | --- | I:SPC/GT
E:GT
T:MSISDN | --- | --- | --- | --- | --- | --- | --- | +| Serving
GPRS
Support
Node | --- | I:SPC/GT
E:GT
T:MGT/
MSISDN/
HLR
NUMBER | --- | I:SPC/GT
E:GT
T:MSC
NUMBER | I:SPC/GT
E:GT
T:EIR
NUMBER | I:SPC/GT
E:GT
T:gsmSCF
NUMBER | --- | --- | I:SPC/GT
E:GT
T:CSS
NUMBER | +| Gateway
GPRS
Support
Node | --- | I:SPC/GT
E:GT
T:MGT | --- | --- | --- | --- | --- | --- | --- | +| Gateway
Mobile
Location
Centre | --- | I:SPC/GT
E:GT
T:MSISDN,
MGT
(outside
World Zone
1) or IMSI
(World Zone
1)
(note) | --- | I:SPC/GT
E:GT
T:MSC
NUMBER | --- | --- | I:SPC/GT
E:GT
T:SGSN
NUMBER | --- | --- | +| CSG
Subscriber
Server | --- | --- | I:SPC/GT
E:GT
T:VLR
NUMBER | --- | --- | --- | I:SPC/GT
E:GT
T:SGSN
NUMBER | --- | --- | + +| | | +|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| I: | Intra-PLMN. | +| E: | Extra (Inter)-PLMN. | +| T: | Address Type. | +| GT: | Global Title. | +| MGT: | E.214 Mobile Global Title. | +| SPC: | Signalling Point Code. | +| NOTE: |

For initiating the location updating procedure and an authentication information retrieval from the HLR preceding it, the VLR has to derive the HLR address from the IMSI of the MS. The result can be an SPC or an E.214 Mobile Global Title if CCITT or ITU-T SCCP is used, or IMSI itself if ANSI SCCP is used (ANSI SCCP is used in World Zone 1). When continuing the established update location dialogue (as with any other dialogue) the VLR must derive the routeing information towards the HLR from the Calling Party Address received with the first responding CONTINUE message until the dialogue terminating message is received.

For transactions invoked by the VLR after update location completion, the VLR may derive the information for addressing the HLR from addresses received in the course of the update location procedure (MSISDN or HLR number) or from the IMSI.

When invoking the Restore Data procedure and an authentication information retrieval from the HLR preceding it, the VLR must derive the information for addressing the HLR from the address information received in association with the roaming number request. This may be either the IMSI received as a parameter of the MAP message requesting the Roaming Number or the Calling Party Address associated with the MAP message requesting the Roaming Number.

The gsmSCF shall be addressed using more than one Global Title number. The first Global Title number is used to address a gsmSCF for MAP. The second Global Title number is used to address a gsmSCF for CAP.

For querying the HLR to obtain the VMSC address to support location services, the GMLC has to derive the HLR address from either the MSISDN or IMSI of the target MS. When using the IMSI, the result can be an SPC or an E.214 Mobile Global Title if CCITT or ITU-T SCCP is used, or IMSI itself if ANSI SCCP is used (ANSI SCCP is used in World Zone 1).

| + +2356 + +2357 + +**Table 6.1/2** + +| to
from | | GMLC | +|-----------------------------------------|----------------------------|----------------------------------| +| fixed network | | --- | +| Home Location Register | | --- | +| Visitor Location Register | | --- | +| Mobile-services Switching Centre | | I:SPC/GT
E:GT
T:MLC Number | +| gsm Service Control Function | | I:SPC/GT
E:GT
T:MSISDN | +| Serving GPRS Support Node | | I:SPC/GT
E:GT
T:MLC Number | +| Gateway GPRS Support Node | | --- | +| Gateway Mobile Location Centre | | | +| I: | Intra-PLMN. | | +| E: | Extra (Inter)-PLMN. | | +| T: | Address Type. | | +| GT: | Global Title. | | +| MGT: | E.214 Mobile Global Title. | | +| SPC: | Signalling Point Code. | | + +2358 + +## 2359 6.2 Use of TC + +2360 The Mobile Application part makes use of the services offered by the Transaction Capabilities (TC) of Signalling +2361 System No. 7. ETS 300 287, which is based on CCITT White Book Recommendations Q.771 to Q.775, should be +2362 consulted for the full specification of TC. + +2363 The MAP uses all the services provided by TC except the ones related to the unstructured dialogue facility. + +2364 From a modelling perspective, the MAP is viewed as a single Application Service Element. Further structuring of it is +2365 for further study. + +2366 Transaction Capabilities refers to a protocol structure above the network layer interface (i.e., the SCCP service +2367 interface) up to the application layer including common application service elements but not the specific application +2368 service elements using them. + +2369 TC is structured as a Component sub-layer above a Transaction sub-layer. + +2370 The Component sub-layer provides two types of application services: services for the control of end-to-end dialogues +2371 and services for Remote Operation handling. These services are accessed using the TC-Dialogue handling primitives +2372 and TC-Component handling primitives respectively. + +2373 Services for dialogue control include the ability to exchange information related to application-context negotiation as +2374 well as initialisation data. + +2375 Services for Remote Operation handling provide for the exchange of protocol data units invoking tasks (operations), +2376 and reporting their outcomes (results or errors) plus any non-application-specific protocol errors detected by the +2377 component sub-layer. The reporting of application-specific protocol errors by the TC user, as distinct from application +2378 process errors, is also provided. The Transaction sub-layer provides a simple end-to-end connection association service +2379 over which several related protocol data units (i.e. built by the Component Sub-Layer) can be exchanged. A Transaction +2380 termination can be prearranged (no indication provided to the TC user) or basic (indication provided). + +2381 + +--- + +## 2382 7 General on MAP services + +### 2383 7.1 Terminology and definitions + +2384 The term service is used in clauses 7 to 12 as defined in CCITT Recommendation X.200. The service definition +2385 conventions of CCITT Recommendation X.210 are also used. + +2386 MAP services that are defined for use between HLR and SGSN are also used in an Evolved Packet System (EPS) +2387 between two IWFs and between HSS and IWF, where the IWF is an Interworking Function that converts MAP +2388 messages to Diameter messages and vice versa. + +2389 MAP services that are defined for use between SGSN and EIR are also used in an Evolved Packet System (EPS) +2390 between IWF and EIR. + +2391 IWFs may be connected via Diameter to MMEs and HSSs and they may be connected via MAP to HSSs, IWFs, and +2392 EIRs. + +2393 + +### 2394 7.2 Modelling principles + +2395 MAP provides its users with a specified set of services and can be viewed by its users as a "black box" or abstract +2396 machine representing the MAP service-provider. The service interface can then be depicted as shown in figure 7.2/1. + +![Diagram illustrating the modelling principles of MAP. Two boxes labeled 'MAP service-user' are at the top, each connected by a vertical line to a central horizontal line labeled 'Service Interface'. Below the 'Service Interface' line, a single box labeled 'MAP Service-provider' is shown, connected to the interface by a vertical line.](89f8aefc01866631793087542316cef2_img.jpg) + +Diagram illustrating the modelling principles of MAP. Two boxes labeled 'MAP service-user' are at the top, each connected by a vertical line to a central horizontal line labeled 'Service Interface'. Below the 'Service Interface' line, a single box labeled 'MAP Service-provider' is shown, connected to the interface by a vertical line. + +2397 + +2398 + +**Figure 7.2/1: Modelling principles** + +2399 The MAP service-users interact with the MAP service-provider by issuing or receiving MAP service-primitives at the +2400 service interface. + +2401 A MAP service-user may receive services from several instances of the MAP service-provider at the same time. In such +2402 cases the overall procedure is synchronised by the service-user. + +2403 The MAP service-primitives are named using the following notation: + +| | +|--------------------------------------| +| MAP-ServicePrimitiveName type | +|--------------------------------------| + +2405 where **type** can be any of: request (req), indication (ind), response (rsp) or confirm (cnf). (In the user arrow diagrams +2406 type is not indicated in the case of req/ind and indicated as "ack" in the case of rsp/cnf). + +2407 The services are further classified as unconfirmed-service, confirmed-service and provider-initiated-service where the +2408 first two categories refer to whether or not the service is confirmed by the service-provider. The confirmation may or +2409 may not correspond to a response provided by the other service-user. + +2410 MAP services are also classified as common MAP services that are available to all MAP service-users, and MAP +2411 service-user specific services, which are services available to one or several, but not all, MAP service-users. + +2412 A MAP dialogue is defined as an exchange of information between two MAP users in order to perform a common task. +2413 A MAP dialogue will consist of one or several MAP services. + +## 2414 7.3 Common MAP services + +2415 All MAP service-users require access to services for performing basic application layer functions: + +- 2416 - for establishing and clearing MAP dialogues between peer MAP service-users; + +- 2417 - for accessing functions supported by layers below the applications layer; + +- 2418 - for reporting abnormal situations; + +- 2419 - for handling of different MAP versions; + +- 2420 - for testing whether or not a persistent MAP dialogue is still active at each side. + +2421 For these purposes the following common services are defined: + +- 2422 - MAP-OPEN service; + +- 2423 - MAP-CLOSE service; + +- 2424 - MAP-DELIMITER service; + +- 2425 - MAP-U-ABORT service; + +- 2426 - MAP-P-ABORT service; + +- 2427 - MAP-NOTICE service. + +2428 In defining the service-primitives the following convention is used for categorising parameters: + +- 2429 M the inclusion of the parameter is mandatory. The M category can be used for any primitive type and specifies +2430 that the corresponding parameter must be present in the indicated primitive type; +- 2431 O the inclusion of the parameter is a service-provider option. The O category can be used in indication and +2432 confirm type primitives and is used for parameters that may optionally be included by the service-provider; +- 2433 U the inclusion of the parameter is a service-user option. The U category can be used in request and response +2434 type primitives. The inclusion of the corresponding parameter is the choice of the service-user; +- 2435 C the inclusion of the parameter is conditional. The C category can be used for the following purposes: +- 2436 - to indicate that if the parameter is received from another entity it must be included for the service being +2437 considered; + - 2438 - to indicate that the service user must decide whether to include the parameter, based on the context on +2439 which the service is used; + - 2440 - to indicate that one of a number of mutually exclusive parameters must be included (e.g. parameters +2441 indicating a positive result versus parameters indicating a negative result); + - 2442 - to indicate that a service user optional parameter (marked "U") or a conditional parameter (marked "C") +2443 presented by the service user in a request or response type primitive is to be presented to the service user in +2444 the corresponding indication or confirm type primitive; +- 2445 (=) when appended to one of the above, this symbol means that the parameter takes the same value as the +2446 parameter appearing immediately to its left; +- 2447 blank the parameter is not present. +- 2448 A primitive type may also be without parameters, i.e. no parameter is required with the primitive type; in this case the +2449 corresponding column of the table is empty. + +### 2450 7.3.1 MAP-OPEN service + +2451 This service is used for establishing a MAP dialogue between two MAP service-users. The service is a confirmed +2452 service with service primitives as shown in table 7.3/1. + +2453 **Table 7.3/1: Service-primitives for the MAP-OPEN service** + +| Parameters | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Application context name | M | M(=) | U | C(=) | +| Destination address | M | M(=) | | | +| Destination reference | U | C(=) | | | +| Originating address | U | O | | | +| Originating reference | U | C(=) | | | +| Specific information | U | C(=) | U | C(=) | +| Responding address | | | U | C(=) | +| Result | | | M | M(=) | +| Refuse-reason | | | C | C(=) | +| Provider error | | | | O | + +2454 + +#### 2455 Application context name: + +2456 This parameter identifies the type of application context being established. If the dialogue is accepted the received +2457 application context name shall be echoed. In case of refusal of dialogue this parameter shall indicate the highest version +2458 supported. + +#### 2459 Destination address: + +2460 A valid SCCP address identifying the destination peer entity (see also clause 6). As an implementation option, this +2461 parameter may also, in the indication, be implicitly associated with the service access point at which the primitive is +2462 issued. + +#### 2463 Destination-reference: + +2464 This parameter is a reference that refines the identification of the called process. It may be identical to Destination + 2465 address but its value is to be carried at MAP level. Table 7.3/2 describes the MAP services using this parameter. Only + 2466 these services are allowed to use it. + +2467 + +**Table 7.3/2: Use of the destination reference** + +| MAP service | Reference type | Use of the parameter | +|-------------------------------------|----------------|----------------------| +| MAP-REGISTER-SS | IMSI | Subscriber identity | +| MAP-ERASE-SS | IMSI | Subscriber identity | +| MAP-ACTIVATE-SS | IMSI | Subscriber identity | +| MAP-DEACTIVATE-SS | IMSI | Subscriber identity | +| MAP-INTERROGATE-SS | IMSI | Subscriber identity | +| MAP-REGISTER-PASSWORD | IMSI | Subscriber identity | +| MAP-PROCESS-UNSTRUCTURED-SS-REQUEST | IMSI (note 1) | Subscriber identity | +| MAP-UNSTRUCTURED-SS-REQUEST | IMSI (note 2) | Subscriber identity | +| MAP-UNSTRUCTURED-SS-NOTIFY | IMSI (note 2) | Subscriber identity | +| MAP-FORWARD-SHORT-MESSAGE | IMSI (note 3) | Subscriber identity | +| MAP-REGISTER-CC-ENTRY | IMSI | Subscriber identity | +| MAP-ERASE-CC-ENTRY | IMSI | Subscriber identity | + +2468 + +2469 NOTE 1: On the HLR - HLR interface and on the HLR - gsmSCF interface the Destination reference shall be either + 2470 IMSI or MSISDN. + +2471 NOTE 2: On the gsmSCF - HLR interface and on the HLR - HLR interface the Destination reference shall be either + 2472 IMSI or MSISDN. + +2473 + +2474 NOTE 3: Only when the IMSI and the LMSI are received together from the HLR in the mobile terminated short + 2475 message transfer. + +2476 Originating address: + +2477 A valid SCCP address identifying the requestor of a MAP dialogue (see also clause 6). As an implementation option, + 2478 this parameter may also, in the request, be implicitly associated with the service access point at which the primitive is + 2479 issued. + +2480 Originating-reference: + +2481 This parameter is a reference that refines the identification of the calling process. It may be identical to the Originating + 2482 address but its value is to be carried at MAP level. Table 7.3/3 describes the MAP services using the parameter. Only + 2483 these services are allowed to use it. Processing of the Originating-reference shall be performed according to the + 2484 supplementary service descriptions and other service descriptions, e.g. operator determined barring. Furthermore the + 2485 receiving entity may be able to use the value of the Originating-reference to screen the service indication. + +**Table 7.3/3: Use of the originating reference** + +| MAP service | Reference type | Use of the parameter | +|-------------------------------------|----------------------------|-----------------------------| +| MAP-REGISTER-SS | ISDN-Address-String | Originated entity address | +| MAP-ERASE-SS | ISDN-Address-String | Originated entity address | +| MAP-ACTIVATE-SS | ISDN-Address-String | Originated entity address | +| MAP-DEACTIVATE-SS | ISDN-Address-String | Originated entity address | +| MAP-INTERROGATE-SS | ISDN-Address-String | Originated entity address | +| MAP-REGISTER-PASSWORD | ISDN-Address-String | Originated entity address | +| MAP-PROCESS-UNSTRUCTURED-SS-REQUEST | ISDN-Address-String | Originated entity address | +| MAP-UNSTRUCTURED-SS-REQUEST | ISDN-Address-String (note) | Originated entity address | +| MAP-UNSTRUCTURED-SS-NOTIFY | ISDN-Address-String (note) | Originated entity address | +| MAP-REGISTER-CC-ENTRY | ISDN-Address-String | Originated entity address | +| MAP-ERASE-CC-ENTRY | ISDN-Address-String | Originated entity address | + +2487 + +2488 NOTE: The Originating reference may be omitted. + +2489 Specific information: + +2490 This parameter may be used for passing any user specific information. Establishment and processing of the Specific +2491 information is not specified by GSM and shall be performed according to operator specific requirements. + +2492 Responding address: + +2493 An address identifying the responding entity. The responding address is included if required by the context (e.g. if it is +2494 different from the destination address). + +2495 Result: + +2496 This parameter indicates whether the peer accepts the dialogue. + +2497 Refuse reason: + +2498 This parameter is present only if the Result parameter indicates that the dialogue is refused. It takes one of the following +2499 values: + +- 2500 - Application-context-not-supported; +- 2501 - Invalid-destination-reference; +- 2502 - Invalid-originating-reference; +- 2503 - No-reason-given; +- 2504 - Remote node not reachable; +- 2505 - Potential version incompatibility. + +## 7.3.2 MAP-CLOSE service + +This service is used for releasing a previously established MAP dialogue. The service may be invoked by either MAP service-user depending on rules defined within the service-user. The service is an unconfirmed service with parameters as shown in table 7.3/4. + +**Table 7.3/4: Service-primitives for the MAP-CLOSE service** + +| Parameters | Request | Indication | +|----------------------|---------|------------| +| Release method | M | | +| Specific Information | U | C(=) | + +2511 + +### Release method: + +This parameter can take the following two values: + +- normal release; in this case the primitive is mapped onto the protocol and sent to the peer; +- prearranged end; in this case the primitive is not mapped onto the protocol. Prearranged end is managed independently by the two users, i.e. only the request type primitive is required in this case. + +### Specific information: + +This parameter may be used for passing any user specific information. Establishment and processing of the Specific information is not specified by GSM GSM and shall be performed according to operator specific requirements. + +## 7.3.3 MAP-DELIMITER service + +This service is used to explicitly request the transfer of the MAP protocol data units to the peer entities. + +See also clause 7.4 and 7.5 for the detailed use of the MAP-DELIMITER service. + +The service is an unconfirmed service with service-primitives as shown in table 7.3/5. + +**Table 7.3/5: Service-primitives for the MAP-DELIMITER service** + +| Parameters | Request | Indication | +|------------|---------|------------| +| | | | +| | | | + +2525 + +## 7.3.4 MAP-U-ABORT service + +This service enables the service-user to request the MAP dialogue to be aborted. The service is an unconfirmed service with service-primitives as shown in table 7.3/6. + +**Table 7.3/6: Service-primitives for the MAP-U-ABORT service** + +| Parameters | Request | Indication | +|------------------------|---------|------------| +| User reason | M | M(=) | +| Diagnostic information | U | C(=) | +| Specific information | U | C(=) | + +2530 + +### User reason: + +This parameter can take the following values: + +- resource limitation (congestion); +the requested user resource is unavailable due to congestion; +- resource unavailable; + +- 2536 the requested user resource is unavailable for reasons other than congestion; +- 2537 - application procedure cancellation; +- 2538 the procedure is cancelled for reasons detailed in the diagnostic information parameter; +- 2539 - procedure error; +- 2540 processing of the procedure is terminated for procedural reasons. + +2541 Diagnostic information: + +2542 This parameter may be used to give additional information for some of the values of the user-reason parameter: + +2543 **Table 7.3/7: User reason and diagnostic information** + +| User reason | Diagnostic information | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Resource limitation (congestion) | - | +| Resource unavailable | Short term/long term problem | +| Application procedure cancellation | Handover cancellation/
Radio Channel release/
Network path release/
Call release/
Associated procedure failure/
Tandem dialogue released/
Remote operations failure | +| Procedure error | - | + +2544 + +2545 Specific information: + +2546 This parameter may be used for passing any user specific information. Establishment and processing of the Specific +2547 information is not specified by GSM and shall be performed according to operator specific requirements. + +## 2548 7.3.5 MAP-P-ABORT service + +2549 This service enables the MAP service-provider to abort a MAP dialogue. The service is a provider-initiated service with +2550 service-primitives as shown in table 7.3/8. + +2551 **Table 7.3/8: Service-primitives for the MAP-P-ABORT service** + +| Parameters | | Indication | +|-----------------|--|------------| +| Provider reason | | M | +| Source | | M | + +2552 + +2553 Provider reason: + +2554 This parameter indicates the reason for aborting the MAP dialogue: + +- 2555 - provider malfunction; +- 2556 - supporting dialogue/transaction released; +- 2557 - resource limitation; +- 2558 - maintenance activity; +- 2559 - version incompatibility; +- 2560 - abnormal MAP dialogue. + +2561 Source: + +2562 This parameter indicates the source of the abort. For Transaction Capabilities (TC) applications the parameter may take +2563 the following values: + +- 2564 - MAP problem; + 2565 - TC problem; + 2566 - network service problem. + +2567 **Table 7.3/9: Values of provider reason and source parameters** + 2568 **and examples of corresponding events** + +| Provider reason | Source | Corresponding event | +|----------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Provider | MAP | Malfunction at MAP level at peer entity | +| malfunction | TC | "Unrecognised message type" or
"Badly formatted transaction portion" or
"Incorrect transaction portion" received in TC-P-ABORT
"Abnormal dialogue" | +| | Network service | Malfunction at network service level at peer entity | +| Supporting dialogue/
transaction released | TC | "Unrecognised transaction ID" received in TC-ABORT | +| Resource | MAP | Congestion towards MAP peer service-user | +| limitation | TC | "Resource limitation" received in TC-P-ABORT | +| Maintenance | MAP | Maintenance at MAP peer service-user | +| activity | Network service | Maintenance at network peer service level | +| Abnormal MAP
dialogue | MAP | MAP dialogue is not in accordance with specified
application context | +| Version
incompatibility | TC | A Provider Abort indicating "No common dialogue portion"
is received in the dialogue initiated state | + +2569 + +### 2570 7.3.6 MAP-NOTICE service + +2571 This service is used to notify the MAP service-user about protocol problems related to a MAP dialogue not affecting the + 2572 state of the protocol machines. + +2573 The service is a provider-initiated service with service-primitive as shown in table 7.3/10. + +2574 **Table 7.3/10: Service-primitive for the MAP-NOTICE service** + +| Parameters | Indication | +|--------------------|------------| +| Problem diagnostic | M | + +2575 + +2576 Problem diagnostic: + +2577 This parameter can take one of the following values: + +- 2578 - abnormal event detected by the peer; + 2579 - response rejected by the peer; + 2580 - abnormal event received from the peer; + 2581 - message cannot be delivered to the peer. + +2582 7.3.7 Void + +2583 7.3.8 Void + +2584 7.3.9 Void + +2585 7.3.10 Void + +## 2586 7.4 Sequencing of services + +2587 The sequencing of services is shown in figure 7.4/1 and is as follows: + +### 2588 Opening: + +2589 The MAP-OPEN service is invoked before any user specific service-primitive is accepted. The sequence may +2590 contain none, one or several user specific service-primitives. If no user specific service-primitive is contained +2591 between the MAP-OPEN and the MAP-DELIMITER primitives, then this will correspond to sending an +2592 empty Begin message in TC. If more than one user specific service-primitive is included, all are to be sent in +2593 the same Begin message. The sequence ends with a MAP-DELIMITER primitive. + +### 2594 Continuing: + +2595 This sequence may not be present in some MAP dialogues. If it is present, it ends with a MAP-DELIMITER +2596 primitive. If more than one user specific service-primitive is included, all are to be included in the same +2597 Continue message. + +### 2598 Closing: + +2599 The sequence can only appear after an opening sequence or a continuing sequence. The sequence may +2600 contain none, one or several user specific service-primitives if the MAP-CLOSE primitive specifies normal +2601 release. If no user specific service-primitive is included, then this will correspond to sending an empty End +2602 message in TC. If more than one user specific service-primitive is included, all are to be sent in the same End +2603 message. If prearranged end is specified, the sequence cannot contain any user specific service-primitive. The +2604 MAP-CLOSE primitive must be sent after all user specific service-primitives have been delivered to the +2605 MAP service-provider. + +### 2606 Aborting: + +2607 A MAP service-user can issue a MAP-U-ABORT primitive at any time after the MAP dialogue has been +2608 opened or as a response to an attempt to open a MAP dialogue. + +2609 The MAP service-provider may issue at any time a MAP-P-ABORT primitive towards a MAP service-user for which a +2610 MAP dialogue exists. + +2611 MAP-U-ABORT primitives and MAP-P-ABORT primitives terminate the MAP dialogue. + +![Diagram showing the sequencing of services for the 'Opening' phase. It consists of three boxes: 'MAP-OPEN' on the left, 'User specific service-primitive' in the center, and 'MAP-DELIMITER' on the right. Lines connect 'MAP-OPEN' to the central box, and the central box to 'MAP-DELIMITER'. Below the central box, a long line with a left-pointing arrow indicates a return or response path from the 'MAP-DELIMITER' back towards the 'MAP-OPEN' side.](0629ebd517a3f52337d7d1087e06e07b_img.jpg) + +``` + +graph LR + A[MAP-OPEN] --> B[User specific service-primitive] + B --> C[MAP-DELIMITER] + C --> D[ ] + style D fill:none,stroke:none + D -.-> A + +``` + +Diagram showing the sequencing of services for the 'Opening' phase. It consists of three boxes: 'MAP-OPEN' on the left, 'User specific service-primitive' in the center, and 'MAP-DELIMITER' on the right. Lines connect 'MAP-OPEN' to the central box, and the central box to 'MAP-DELIMITER'. Below the central box, a long line with a left-pointing arrow indicates a return or response path from the 'MAP-DELIMITER' back towards the 'MAP-OPEN' side. + +2612 + +2613 + +**a) Opening** + +2614 +2615 + +![Diagram showing the sequencing of services for 'Continuing'. A 'User specific service-primitive' box is shown with a return arrow pointing to it from a 'MAP-DELIMITER' box. Above the 'User specific service-primitive' box, there are two nested boxes representing previous service primitives.](feae5a5b6e128162dbced0860fd97b9b_img.jpg) + +Diagram showing the sequencing of services for 'Continuing'. A 'User specific service-primitive' box is shown with a return arrow pointing to it from a 'MAP-DELIMITER' box. Above the 'User specific service-primitive' box, there are two nested boxes representing previous service primitives. + +**b) Continuing** + +2616 +2617 + +![Diagram showing the sequencing of services for 'Closing'. A 'User specific service-primitive' box is shown with a return arrow pointing to it from a 'MAP-CLOSE' box. Above the 'User specific service-primitive' box, there is one nested box representing a previous service primitive.](376f80eb8a41369e87da63a0210d173e_img.jpg) + +Diagram showing the sequencing of services for 'Closing'. A 'User specific service-primitive' box is shown with a return arrow pointing to it from a 'MAP-CLOSE' box. Above the 'User specific service-primitive' box, there is one nested box representing a previous service primitive. + +**c) Closing** + +2618 +2619 + +![Diagram showing the sequencing of services for 'Aborting'. Two boxes, 'MAP-U-ABORT' and 'MAP-P-ABORT', are shown side-by-side with horizontal lines leading to them from the left and right respectively.](9d49325b5cb2d7a1431cb30637b5a7c9_img.jpg) + +Diagram showing the sequencing of services for 'Aborting'. Two boxes, 'MAP-U-ABORT' and 'MAP-P-ABORT', are shown side-by-side with horizontal lines leading to them from the left and right respectively. + +**d) Aborting** + +2620 + +**Figure 7.4/1: Sequencing of services** + +2621 If the reason "resource unavailable (short term problem)" is indicated in the MAP-U-ABORT indication primitive, the +2622 MAP service-user may decide to attempt a new MAP dialogue establishment immediately. + +2623 Sequencing of user specific service-primitives is done by the MAP service-user and based on rules applicable for each +2624 MAP service-user instance. + +2625 A MAP-NOTICE indication primitive may be received at any time during the active period of a MAP dialogue. + +## 2626 7.5 General rules for mapping of services onto TC + +### 2627 7.5.1 Mapping of common services + +2628 Table 7.5/1 gives an overview of the mapping rules for mapping of common services onto TC-services. Table 7.5/2 +2629 gives the mapping rules for mapping of TC-services onto common services. + +2630 Protocol machine description is given in clauses 14 to 17. + +2631 + +**Table 7.5/1: Mapping of common services onto TC services** + +| MAP service-primitive | TC service-primitive | +|------------------------------------------------------------------------------------------|-----------------------------------------------------------------| +| MAP-OPEN request
(+ any user specific service primitives)
+ MAP-DELIMITER request | TC-BEGIN request
(+ component handling primitives) | +| MAP-OPEN response
(+ any user specific service primitives)
+ MAP-DELIMITER request | TC-CONTINUE request (note)
(+ component handling primitives) | +| (any user specific service primitives)
+ MAP-DELIMITER request | TC-CONTINUE request
(+ component handling primitives) | +| (any user specific service primitives)
+ MAP-CLOSE request | TC-END request
(+ component handling primitives) | + +| | | +|----------------------------------------------------------------------------------------------|--------------------| +| MAP-U-ABORT request | TC-U-ABORT request | +| NOTE: Or TC-END if the MAP-CLOSE request has been received before the MAP-DELIMITER request. | | + +2632 + +2633 + +**Table 7.5/2: Mapping of TC services onto common service** + +| TC service-primitive | MAP service-primitive | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TC-BEGIN indication
(+ component handling primitives) | MAP-OPEN indication
(+ user specific service primitives)
+ MAP-DELIMITER indication (note 1) | +| TC-CONTINUE indication
(+ component handling primitives) | First time:
MAP-OPEN confirm
(+ user specific service primitives)
+ MAP-DELIMITER indication (note 1)

Subsequent times:
(user specific service primitives)
+ MAP-DELIMITER indication (note 1) | +| TC-END indication
(+ component handling primitives) | MAP-OPEN confirm (note 6)
(user specific service primitives)
+ MAP-CLOSE indication | +| TC-U-ABORT indication | MAP-U-ABORT indication or
MAP-P-ABORT indication (note 2)
MAP-OPEN confirmation (note 3) | +| TC-P-ABORT indication | MAP-P-ABORT indication (note 4)
MAP-OPEN confirmation (note 5) | +| NOTE 1: It may not be necessary to present this primitive to the user for MAP version 2 applications. | | +| NOTE 2: The mapping depends on whether the TC-U-ABORT indication primitive contains a MAP-abort-PDU from the remote MAP service-provider or a MAP-user-abort-PDU from the remote MAP service-user. | | +| NOTE 3: Only if the opening sequence is pending and if the "Abort Reason" in the TC-U-ABORT indication is set to "Application Context Not Supported". | | +| NOTE 4: If the "Abort Reason" in the TC-P-ABORT indication is set to a value different from "Incorrect Transaction Portion". | | +| NOTE 5: Only if the opening sequence is pending and if the "Abort Reason" in the TC-P-ABORT indication is set to "Incorrect Transaction Portion". | | +| NOTE 6: Only if opening sequence is pending. | | + +2634 + +## 2635 7.5.2 Mapping of user specific services + +2636 Table 7.5/3 gives the general mapping rules which apply to mapping of MAP user specific services onto TC services +2637 and table 7.5/4 gives the similar rules for mapping of TC services onto MAP user specific services. Detailed mapping is +2638 given in clauses 14 to 17. + +2639 + +**Table 7.5/3: Mapping of MAP user specific services onto TC services** + +| MAP service-primitive | TC-service-primitive | +|-----------------------------|------------------------------------------------------------------------------------------------| +| MAP-xx request | TC-INVOKE request | +| MAP-xx response
(note 1) | TC-RESULT-L request
TC-U-ERROR request
TC-U-REJECT request
TC-INVOKE request (note 2) | + +2640 + +2641 + +**Table 7.5/4: Mapping of TC services onto MAP user specific services** + +| TC-service-primitive | MAP service-primitive | +|-------------------------------------------------------------------------------------------|-----------------------| +| TC-INVOKE indication | MAP-xx indication | +| TC-RESULT-L indication (note 4)
TC-U-ERROR indication
TC-INVOKE indication (note 2) | MAP-xx confirm | + +| | | +|------------------------|--------------------------------| +| TC-L-CANCEL indication | | +| TC-U-REJECT indication | MAP-xx confirm or | +| TC-L-REJECT indication | MAP-NOTICE indication (note 3) | +| TC-R-REJECT indication | | + +2642 + +2643 Notes to tables 7.5/3 and 7.5/4: + +2644 NOTE 1: The mapping is determined by parameters contained in the MAP-xx response primitive. + +2645 NOTE 2: This applies only to TC class 4 operations where the operation is used to pass a result of another class 2 + 2646 or class 4 operation. + +2647 NOTE 3: The detailed mapping rules are given in clause 16. + +2648 NOTE 4: If RESULT-NL components are present they are mapped onto the same MAP-xx confirm. + +## 2649 7.6 Definition of parameters + +### 2650 7.6.1 Common parameters + +2651 The following set of parameters is used in several MAP service-primitives. + +#### 2652 7.6.1.1 Invoke Id + +2653 This parameter identifies corresponding service primitives. The parameter is supplied by the MAP service-user and + 2654 must be unique over each service-user/service-provider interface. + +#### 2655 7.6.1.2 Linked Id + +2656 This parameter is used for linked services and it takes the value of the invoke Id of the service linked to. + +#### 2657 7.6.1.3 Provider error + +2658 This parameter is used to indicate a protocol related type of error: + +- 2659 - duplicated invoke Id; +- 2660 - not supported service; +- 2661 - mistyped parameter; +- 2662 - resource limitation; +- 2663 - initiating release, i.e. the peer has already initiated release of the dialogue and the service has to be released; +- 2664 - unexpected response from the peer; +- 2665 - service completion failure; +- 2666 - no response from the peer; +- 2667 - invalid response received. + +#### 2668 7.6.1.4 User error + +2669 This parameter can take values as follows: + +2670 NOTE: The values are grouped in order to improve readability; the grouping has no other significance. + +2671 a) Generic error: + +- 2672 - system failure, i.e. a task cannot be performed because of a problem in the entity reporting the error or in +2673 another entity. The type of entity or network resource may be indicated by use of the network resource +2674 parameter or additional network resource parameter. If and only if the problem is in the entity reporting the +2675 error, a cause of failure (FailureCauseParam) shall be included; +- 2676 - data missing, i.e. an optional parameter required by the context is missing; +- 2677 - unexpected data value, i.e. the data type is formally correct but its value or presence is unexpected in the +2678 current context; +- 2679 - resource limitation; +- 2680 - initiating release, i.e. the receiving entity has started the release procedure; +- 2681 - facility not supported, i.e. the requested facility is not supported by the PLMN with detailed reasons as +2682 follows: + - 2683 - Shape of location estimate not supported; + - 2684 - Needed LCS capability not supported in serving node; +- 2685 - incompatible terminal, i.e. the requested facility is not supported by the terminal. +- 2686 b) Identification or numbering problem: + - 2687 - unknown subscriber, i.e. no such subscription exists; + - 2688 - number changed, i.e. the subscription does not exist for that number any more; + - 2689 - unknown MSC; + - 2690 - unidentified subscriber, i.e. if the subscriber is not contained in the database and it has not or cannot be +2691 established whether or not a subscription exists; + - 2692 - unallocated roaming number; + - 2693 - unknown equipment; + - 2694 - unknown location area. +- 2695 c) Subscription problem: + - 2696 - roaming not allowed, i.e. a location updating attempt is made in an area not covered by the subscription; + - 2697 - illegal subscriber, i.e. illegality of the access has been established by use of authentication procedure; + - 2698 - bearer service not provisioned; + - 2699 - teleservice not provisioned; + - 2700 - illegal equipment, i.e. the IMEI check procedure has shown that the IMEI is prohibited-listed or not +2701 permitted-listed. +- 2702 d) Handover problem: + - 2703 - no handover number available, i.e. the VLR cannot allocate a number for handover or cannot allocate the +2704 required amount of numbers for relocation; + - 2705 - subsequent handover failure, i.e. handover to a third MSC failed for some reason; + - 2706 - target cell outside group call area. +- 2707 e) Operation and maintenance problem: + - 2708 - tracing buffer full, i.e. tracing cannot be performed because the tracing capacity is exceeded. +- 2709 f) Call set-up problem: + +- 2710 - no roaming number available, i.e. a roaming number cannot be allocated because all available numbers are in +2711 use; +- absent subscriber, i.e. the subscriber has activated the detach service or the system detects the absence condition. This error may be qualified to indicate whether the subscriber was IMSI detached, in a restricted area or did not respond to paging; +- 2712 - busy subscriber. This error may be qualified to indicate that the subscriber was busy due to CCBS and that +2713 CCBS is possible; +- 2714 - no subscriber reply; +- 2715 - forwarding violation, i.e. the call has already been forwarded the maximum number of times that is allowed; +- 2716 - CUG reject, i.e. the call does not pass a CUG check; additional information may also be given in order to +2717 indicate rejection due to e.g. incoming call barred or non-CUG membership; +- 2718 - call barred. Optionally, additional information may be included for indicating either that the call meets a +2719 barring condition set by the subscriber or that the call is barred for operator reasons. In the case of barring of +2720 Mobile Terminating Short Message, the additional information may indicate a barring condition due to +2721 "Unauthorised Message Originator"; if the call is rejected due to the application of the ACR supplementary +2722 service, the additional information shall indicate a barring condition due to "Anonymous Call Rejection"; +- 2723 - optimal routeing not allowed, i.e. the entity which sends the error does not support optimal routeing, or the +2724 HLR will not accept an optimal routeing interrogation from the GMSC, or the call cannot be optimally routed +2725 because it would contravene optimal routeing constraints; +- 2726 - forwarding failed, i.e. the GMSC interrogated the HLR for forwarding information but the HLR returned an +2727 error. + +2728 g) Supplementary services problem: + +- 2729 - call barred; +- 2730 - illegal SS operation; +- 2731 - SS error status; +- 2732 - SS not available; +- 2733 - SS subscription violation; +- 2734 - SS incompatibility; +- 2735 - negative password check; +- 2736 - password registration failure; +- 2737 - Number of Password Attempts; +- 2738 - USSD Busy; +- 2739 - Unknown Alphabet; +- 2740 - short term denial; +- 2741 - long term denial. + +2742 For definition of these errors see 3GPP TS 24.080 [38]. + +2743 h) Short message problem: + +- 2744 - SM delivery failure with detailed reason as follows: +- 2745 - memory capacity exceeded; +- 2746 - MS protocol error; + +- 2747 - MS not equipped; +- 2748 - unknown service centre (SC); +- 2749 - SC congestion; +- 2750 - invalid SME address; +- 2751 - subscriber is not an SC subscriber; +- 2752 - and possibly detailed diagnostic information, coded as specified in 3GPP TS 23.040, under SMS- +- 2753 SUBMIT-REPORT and SMS-DELIVERY-REPORT. If the SM entity that returns the SM Delivery +- 2754 Failure error includes detailed diagnostic information, it shall be forwarded in the +- 2755 MAP\_MO\_FORWARD\_SHORT\_MESSAGE and in the MAP\_MT\_FORWARD\_SHORT\_MESSAGE +- 2756 response. +- 2757 - message waiting list full, i.e. no further SC address can be added to the message waiting list. +- 2758 - Subscriber busy for MT SMS, i.e. the mobile terminated short message transfer cannot be completed +- 2759 because: +- 2760 - another mobile terminated short message transfer is going on and the delivery node does not support +- 2761 message buffering; or +- 2762 - another mobile terminated short message transfer is going on and it is not possible to buffer the message +- 2763 for later delivery; or +- 2764 - the message was buffered but it is not possible to deliver the message before the expiry of the buffering +- 2765 time defined in 3GPP TS 23.040; +- Absent Subscriber SM, i.e. the mobile terminated short message transfer cannot be completed because the network cannot contact the subscriber. Diagnostic information regarding the reason for the subscriber's absence may be included with this error. +- 2766 i) Location services problem: +- 2767 - Unauthorised Requesting Network +- 2768 - Unauthorised LCS Client with detailed reasons as follows: +- 2769 - NoAdditional Information +- 2770 - Client not in MS Privacy Exception List +- 2771 - Call to Client not setup +- 2772 - Disallowed by Local Regulatory Requirements +- 2773 - Unauthorised Privacy Class +- 2774 - Unauthorised Call/Session Unrelated External Client +- 2775 - Unauthorised Call/Session Related External Client +- 2776 - Privacy override not applicable +- 2777 - Position method failure with detailed reasons as follows: +- 2778 - Congestion +- 2779 - Insufficient resources +- 2780 - Insufficient Measurement Data +- 2781 - Inconsistent Measurement Data +- 2782 - Location procedure not completed + +- 2783 - QoS not attainable +- 2784 - Position Method Not Available in Network +- 2785 - Position Method Not Available in Location Area +- 2786 - Unknown or unreachable LCS Client. + +#### 2787 7.6.1.5 All Information Sent + +2788 This parameter indicates to the receiving entity when the sending entity has sent all necessary information. + +### 2789 7.6.2 Numbering and identification parameters + +#### 2790 7.6.2.1 IMSI + +2791 This parameter is the International Mobile Subscriber Identity defined in 3GPP TS 23.003 [17]. + +#### 2792 7.6.2.2 TMSI + +2793 This parameter is the Temporary Mobile Subscriber Identity defined in 3GPP TS 23.003 [17]. + +#### 2794 7.6.2.3 IMEI + +2795 This parameter is the International Mobile Equipment Identity defined in 3GPP TS 23.003 [17]. + +#### 2796 7.6.2.3a IMEISV + +2797 This parameter is the International Mobile Equipment Identity and Software Version Number defined in 3GPP TS +2798 23.003 [17]. + +#### 2799 7.6.2.4 Previous location area Id + +2800 This parameter refers to the identity of the location area from which the subscriber has roamed. + +#### 2801 7.6.2.5 Stored location area Id + +2802 This parameter refers to the location area where the subscriber is assumed to be located. + +#### 2803 7.6.2.6 Current location area Id + +2804 This parameter is used to indicate the location area in which the subscriber is currently located. + +#### 2805 7.6.2.7 Target location area Id + +2806 This parameter refers to the location area into which the subscriber intends to roam. + +#### 2807 7.6.2.8 Target cell Id + +2808 This parameter refers to the identity of the cell to which a call has to be handed over. + +#### 2809 7.6.2.8A Target RNC Id + +2810 This parameter refers to the identity of the RNC to which a call has to be relocated. + +#### 2811 7.6.2.9 Void + +2812 **7.6.2.10        Originating entity number** + +2813 This parameter refers to an application layer identification of a system component in terms of its associated ISDN +2814 number. + +2815 **7.6.2.11        MSC number** + +2816 This parameter refers to the ISDN number of an MSC. + +2817 **7.6.2.12        Target MSC number** + +2818 This parameter refers to the ISDN number of an MSC to which a call has to be handed over. + +2819 **7.6.2.13        HLR number** + +2820 This parameter refers to the ISDN number of an HLR. + +2821 **7.6.2.14        VLR number** + +2822 This parameter refers to the ISDN number of a VLR. + +2823 **7.6.2.15        HLR Id** + +2824 This parameter refers to the identity of an HLR derived from the IMSI defined in CCITT Recommendation E.212. + +2825 **7.6.2.16        LMSI** + +2826 This parameter refers to a local identity allocated by the VLR to a given subscriber for internal management of data in +2827 the VLR. LMSI shall not be sent to the SGSN. + +2828 **7.6.2.17        MS ISDN** + +2829 This parameter refers to one of the ISDN numbers assigned to a mobile subscriber in accordance with CCITT +2830 Recommendation E.213. + +2831 **7.6.2.17A      Additional MSISDN** + +2832 This parameter refers to an ISDN number assigned on top of the existing MSISDN, to a user with a connection to the +2833 PS domain (see 3GPP TS 23.003 [17]). If the Additional MSISDN is available its value shall be used as C-MSISDN on +2834 the Sv interface. + +2835 **7.6.2.18        OMC Id** + +2836 This parameter refers to the identity of an Operation and Maintenance Centre. + +2837 **7.6.2.19        Roaming number** + +2838 This parameter refers to the roaming number as defined in CCITT Recommendation E.213. + +2839 **7.6.2.19A      Relocation Number List** + +2840 This parameter refers to the number(s) used for routing one call or several calls between MSCs during relocation. + +2841 **7.6.2.20        Void** + +2842 **7.6.2.21        Handover number** + +2843 This parameter refers to the number used for routing a call between MSCs during handover. + +2844 **7.6.2.22 Forwarded-to number** + +2845 This parameter refers to the address to which a call is to be forwarded. A subaddress may be appended. For subscribers +2846 having an originating CAMEL Phase 2 or higher subscription, this address need not be in E.164 international format. + +2847 **7.6.2.22A Long forwarded-to number** + +2848 This parameter refers to the address to which a call is to be forwarded. A subaddress may be appended. For subscribers +2849 having an originating CAMEL Phase 2 or higher subscription this address need not be in international format. + +2850 **7.6.2.22B Long FTN Supported** + +2851 This parameter indicates that the sending entity supports Long Forwarded-to Numbers. + +2852 **7.6.2.23 Forwarded-to subaddress** + +2853 This parameter refers to the sub-address attached to the address to which a call is to be forwarded. + +2854 **7.6.2.24 Called number** + +2855 This parameter refers to a called party number as defined in CCITT Recommendation Q.767. + +2856 **7.6.2.25 Calling number** + +2857 This parameter refers to a calling party number as defined in CCITT Recommendation Q.767. + +2858 **7.6.2.26 Originally dialled number** + +2859 This parameter refers to the number dialled by the calling party in order to reach a mobile subscriber. + +2860 **7.6.2.27 Service centre address** + +2861 This parameter represents the address of a Short Message Service Centre. + +2862 **7.6.2.28 Zone Code** + +2863 This parameter is used to define location areas into which the subscriber is allowed or not allowed to roam (regional +2864 subscription). With a complete list of Zone Codes the VLR or the SGSN or MME is able to determine for all its location +2865 areas, routing areas or tracking areas whether roaming is allowed or not. + +2866 **7.6.2.29 MSISdn-Alert** + +2867 This parameter refers to the MSISDN stored in a Message Waiting Data File in the HLR. It is used to alert the Service +2868 Centre when the MS is again attainable. + +2869 **7.6.2.30 Location Information** + +2870 The VLR indicates in this parameter the location of the served subscriber as defined in 3GPP TS 23.018 [97]. + +2871 **7.6.2.30a Location Information for GPRS** + +2872 The SGSN indicates in this parameter the location of the served subscriber as defined in 3GPP TS 23.078 [98]. + +2873 **7.6.2.30b Location Information for EPS** + +2874 The MME (via an IWF) indicates in this parameter the location of the served subscriber. + +2875 **7.6.2.31 GMSC Address** + +2876 This parameter refers to the E.164 address of a GMSC. + +2877 **7.6.2.32 VMSC Address** + +2878 This parameter refers to the E.164 address of a VMSC. + +2879 **7.6.2.33 Group Id** + +2880 This parameter is used to describe groups a subscriber can be a member of. A subscriber can partake in all group calls +2881 (VBS/VGCS) where he subscribed to the respective groups. + +2882 **7.6.2.34 North American Equal Access preferred Carrier Id** + +2883 This parameter refers to the carrier identity preferred by the subscriber for calls requiring routing via an inter-exchange +2884 carrier. This identity is used at: + +- 2885 - outgoing calls: when the subscriber does not specify at call set-up a carrier identity; +- 2886 - forwarded calls: when a call is forwarded by the subscriber; +- 2887 - incoming calls: applicable to the roaming leg of the call. + +2888 **7.6.2.35 Void** + +2889 **7.6.2.36 Void** + +2890 **7.6.2.37 Serving cell Id** + +2891 This parameter indicates the cell currently being used by the served subscriber. + +2892 **7.6.2.38 SGSN number** + +2893 This parameter refers to the ISDN number of a SGSN. + +2894 **7.6.2.39 SGSN address** + +2895 This parameter refers to the IP-address of a SGSN. This parameter is defined in 3GPP TS 23.003 [17]. + +2896 **7.6.2.40 GGSN address** + +2897 This parameter refers to the IP-address of a GGSN. This parameter is defined in 3GPP TS 23.003 [17]. + +2898 **7.6.2.41 GGSN number** + +2899 This parameter refers to the ISDN number of a GGSN or the ISDN number of the protocol-converter if a +2900 protocol-converting GSN is used between the GGSN and the HLR. + +2901 **7.6.2.42 APN** + +2902 This parameter refers to the DNS name of a GGSN. This parameter is defined in 3GPP TS 23.060 [104]. + +#### 2903 7.6.2.43 Network Node number + +2904 This parameter refers to the ISDN number of an MT-SMS target node (MSC or MME, SGSN, or IP-SM-GW) or of an +2905 SMS Router. + +#### 2906 7.6.2.43A Network Node Diameter Address + +2907 This parameter refers to the Diameter Name and Realm of the same MT-SMS target node or SMS Router of which the +2908 ISDN number is within the Network Node number parameter. + +#### 2909 7.6.2.44 PDP-Type + +2910 This parameter indicates which type of protocol is used by the MS as defined in 3GPP TS 23.060 [104]. The allowed +2911 values are one of IPv4 encoded as HEX (21) or IPv6 encoded as HEX (57), or Non-IP encoded as HEX (02). + +2912 NOTE: To indicate both IPv4 and IPv6 PDP types are allowed, but not IPv4v6, two PDP contexts need to be +2913 present in the subscription for the same APN, one indicating IPv4 PDP type and one indicating IPv6 PDP +2914 type. + +2915 + +#### 2916 7.6.2.44A Extension PDP-Type + +2917 This parameter indicates the support of the dual-stack PDP-type (IPv4v6) encoded as HEX (8D) by a certain PDP, as +2918 defined in 3GPP TS 23.060 [104], and it is an extension to PDP-Type. + +#### 2919 7.6.2.45 PDP-Address + +2920 This parameter indicates the address of the data protocol as defined in 3GPP TS 23.060 [104]. + +#### 2921 7.6.2.45A Extension PDP-Address + +2922 This parameter indicates an additional address of the data protocol, and it is included when the PDP supports dual-stack +2923 (IPv4v6). + +2924 It is an extension to PDP-Address and it is encoded in the same way. IPv4 or IPv6 address types can be used in this +2925 parameter but, when both parameters are present, each of them shall contain different address types. + +#### 2926 7.6.2.46 Additional number + +2927 This parameter refers to the ISDN number of an additional MT-SMS target node (MSC or MME or SGSN) or of an +2928 SMS Router. + +#### 2929 7.6.2.46A Additional Network Node Diameter Address + +2930 This parameter refers to an additional Diameter Name and Realm of the same MT-SMS target node or SMS Router of +2931 which the ISDN number is within the Additional number parameter. + +#### 2932 7.6.2.46B Third Number + +2933 This parameter refers to the ISDN number of a third MT-SMS target node (MSC or MME or SGSN). + +#### 2934 7.6.2.46C Third Network Node Diameter Address + +2935 This parameter refers to the third Diameter Name and Realm of the same MT-SMS target node of which the ISDN +2936 number is within the Third number parameter. + +#### 2937 7.6.2.47 P-TMSI + +2938 This parameter is the Packet Temporary Mobile Subscriber Identity defined in 3GPP TS 23.003 [17]. + +2939 **7.6.2.48 B-subscriber number** + +2940 This parameter refers to the number of the destination B dialled by the A user. This may include a subaddress. + +2941 **7.6.2.49 B-subscriber subaddress** + +2942 This parameter refers to the sub-address attached to the destination B dialled by the A user. + +2943 **7.6.2.50 LMU Number** + +2944 This parameter refers to a local number assigned to an LMU by an SMLC. + +2945 **7.6.2.51 MLC Number** + +2946 This parameter refers to the ISDN (E.164) number of an MLC. + +2947 **7.6.2.52 Multicall Bearer Information** + +2948 This parameter refers to the number of simultaneous bearers supported per user by the serving network. + +2949 **7.6.2.53 Multiple Bearer Requested** + +2950 This parameter indicates whether multiple bearers are requested for a relocation. + +2951 **7.6.2.54 Multiple Bearer Not Supported** + +2952 This parameter indicates whether multiple bearers are supported. + +2953 **7.6.2.55 PDP-Charging Characteristics** + +2954 This parameter indicates the charging characteristics associated with a specific PDP context as defined in 3GPP +2955 TS 32.215. + +2956 **7.6.2.56 Selected RAB ID** + +2957 The selected radio access bearer to be kept at subsequent inter-MSC handover from UMTS to GSM. + +2958 **7.6.2.57 RAB ID** + +2959 This parameter indicates the radio access bearer identifier as defined in 3GPP TS 25.413. This parameter is used to +2960 relate the radio resources with the radio access bearers. + +2961 **7.6.2.58 gsmSCF Address** + +2962 This parameter refers to the ISDN number assigned to the gsmSCF address. In an IP Multimedia Core Network, the +2963 gsmSCF-address shall contain the IM-SSF address when the IM-SSF takes the role of the gsmSCF. + +2964 **7.6.2.59 V-GMLC Address** + +2965 This parameter refers to the IP address of a V-GMLC. + +2966 **7.6.2.60 Void** + +2967 **7.6.2.61 H-GMLC Address** + +2968 This parameter refers to the IP address of a H-GMLC. + +#### 2969 **7.6.2.62 PPR Address** + +2970 This parameter refers to the IP address of a Privacy Profile Register. + +#### 2971 **7.6.2.63 Routeing Number** + +2972 This parameter refers to a number used for routeing purpose and identifying a network operator. See 3GPP TS 23.066 +2973 [108]. + +#### 2974 **7.6.2.64 Additional V-GMLC Address** + +2975 This parameter refers to the IP address of a V-GMLC. + +#### 2976 **7.6.2.65 MME Name** + +2977 This parameter refers to the Diameter Identity of an MME as defined in 3GPP TS 23.003 [17]. + +#### 2978 **7.6.2.66 3GPP AAA Server Name** + +2979 This parameter refers to the Diameter Identity of a 3GPP AAA server as defined in 3GPP TS 29.273 [151]. + +#### 2980 **7.6.2.67 CSS number** + +2981 This parameter refers to the ISDN number of a CSS as defined in 3GPP TS 23.003[17]. + +#### 2982 **7.6.2.68 SGSN Name** + +2983 This parameter refers to the Diameter Identity of an SGSN as defined in 3GPP TS 23.003 [17]. + +#### 2984 **7.6.2.69 SGSN Realm** + +2985 This parameter refers to the Diameter Identity of an SGSN as defined in 3GPP TS 23.003 [17]. + +### 2986 **7.6.3 Subscriber management parameters** + +#### 2987 **7.6.3.1 Category** + +2988 This parameter refers to the calling party category as defined in CCITT Recommendation Q.767. + +#### 2989 **7.6.3.2 Equipment status** + +2990 This parameter refers to the status of the mobile equipment as defined in 3GPP TS 22.016 [7]. + +#### 2991 **7.6.3.2a BMUEF** + +2992 This parameter refers to the Bit Map of UE Faults and corresponds to the UESBI-Iu parameter defined in 3GPP TS +2993 25.413 [120]. + +#### 2994 **7.6.3.3 Extensible Bearer service** + +2995 This parameter may refer to a single bearer service, a set of bearer services or to all bearer services as defined in 3GPP +2996 TS 22.002 [3]. This parameter is used only for subscriber profile management. Extensible Bearer service values include +2997 all values defined for a Bearer service parameter (7.6.4.38). + +#### 2998 **7.6.3.4 Extensible Teleservice** + +2999 This parameter may refer to a single teleservice, a set of teleservices or to all teleservices as defined in 3GPP TS 22.003 + 3000 [4]. This parameter is used only for subscriber profile management. Extensible Teleservice values include all values + 3001 defined for a Teleservice parameter (7.6.4.39). + +3002 **7.6.3.5 Extensible Basic Service Group** + +3003 This parameter refers to the Basic Service Group either as an extensible bearer service (see clause 7.6.3.3) or an + 3004 extensible teleservice (see clause 7.6.3.4). This parameter is used only for subscriber profile management. The null + 3005 value (i.e. neither extensible bearer service nor extensible teleservice) is used to denote the group containing all + 3006 extensible bearer services and all extensible teleservices. + +3007 **7.6.3.6 GSM bearer capability** + +3008 This parameter refers to the GSM bearer capability information element defined in 3GPP TS 24.008 [35]. + +3009 **7.6.3.7 Subscriber Status** + +3010 This parameter refers to the barring status of the subscriber: + +- 3011 - service granted; +- 3012 - Operator Determined Barring. + +3013 **7.6.3.8 CUG Outgoing Access indicator** + +3014 This parameter represents the Outgoing Access as defined in ETS 300 136. + +3015 **7.6.3.9 Operator Determined Barring General Data** + +3016 This parameter refers to the set of subscriber features that the network operator or the service provider can regulate. + 3017 This set only includes those limitations that can be + +- 3018 a) controlled in the VLR, +- 3019 b) controlled in the SGSN or MME, +- 3020 c) controlled in the SGSN applied for short message transfer only, +- 3021 d) interrogated or modified by the gsmSCF: + +3022 + +| ODB category | Controlled in the VLR | Controlled in the SGSN or MME | Controlled in the SGSN applied for short message transfer only | Interrogatable and modifiable by the gsmSCF | +|---------------------------------------------------------------------------|-----------------------|-------------------------------|----------------------------------------------------------------|---------------------------------------------| +| All outgoing calls barred | X | | X | X | +| International outgoing calls barred | X | | X | X | +| International outgoing calls except those to the home PLMN country barred | X | | X | X | +| Interzonal outgoing calls barred | X | | X | X | +| Interzonal outgoing calls except those to the home PLMN country | X | | X | X | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---| +| barred | | | | | +| Interzonal outgoing calls AND international outgoing calls except those directed to the home PLMN country barred | X | | X | X | +| Premium rate (information) outgoing calls barred | X | | | X | +| Premium rate (entertainment) outgoing calls barred | X | | | X | +| Supplementary service access barred | X | | | X | +| Invocation of call transfer barred | X | | | X | +| Invocation of chargeable call transfer barred | X | | | X | +| Invocation of internationally chargeable call transfer barred | X | | | X | +| Invocation of interzonally chargeable call transfer barred | X | | | X | +| Invocation of call transfer where both legs are chargeable barred | X | | | X | +| Invocation of call transfer if there is already an ongoing transferred call for the served subscriber in the serving MSC/VLR barred | X | | | X | +| All packet Oriented Services barred | | X | | X | +| Roamer Access to HPLMN-AP barred | | X | | X | +| Roamer Access to VPLMN-AP barred | | X | | X | +| Outgoing calls when roaming outside the home PLMN country | | | | X | +| All incoming calls | | | | X | + +| | | | | | +|--------------------------------------------------------------------------------------------------------|--|--|--|---| +| Incoming calls when roaming outside the home PLMN country | | | | X | +| Incoming calls when roaming outside the zone of the home PLMN country | | | | X | +| Roaming outside the home PLMN | | | | X | +| Roaming outside the home PLMN country | | | | X | +| Registration of any call forwarded-to number | | | | X | +| Registration of any international call forwarded-to number | | | | X | +| Registration of any international call forwarded-to number except to a number within the HPLMN country | | | | X | +| Registration of any inter-zone call forwarded-to number | | | | X | +| Registration of any inter-zone call forwarded-to number except to a number within the HPLMN country | | | | X | + +3023 + +3024 + +3025 **7.6.3.10 ODB HPLMN Specific Data** + +3026 This parameter refers to the set of subscriber features that the network operator or the service provider can regulate only + 3027 when the subscriber is registered in the HPLMN. This set only includes those limitations that can be controlled in the + 3028 VLR or in the SGSN or MME: + +- 3029 - Operator Determined Barring Type 1; +- 3030 - Operator Determined Barring Type 2; +- 3031 - Operator Determined Barring Type 3; +- 3032 - Operator Determined Barring Type 4. + +3033 **7.6.3.11 Regional Subscription Data** + +3034 This parameter defines the regional subscription area in which the subscriber is allowed to roam. It consists of a list of + 3035 Zone Codes (see clause 7.6.2.28). + +### 3036 7.6.3.12 Regional Subscription Response + +3037 This parameter indicates either that the regional subscription data cannot be handled or that the current MSC or SGSN +3038 or MME area is entirely restricted because of regional subscription. + +### 3039 7.6.3.13 Roaming Restriction Due To Unsupported Feature + +3040 This parameter defines that a subscriber is not allowed to roam in the current MSC area. It may be used by the HLR if a +3041 feature or service is indicated as unsupported by the VLR. + +### 3042 7.6.3.14 Extensible SS-Info + +3043 This parameter refers to all the information related to a supplementary service and is a choice between: + +- 3044 - extensible forwarding information (see clause 7.6.3.15); +- 3045 - extensible call barring information (see clause 7.6.3.20); +- 3046 - CUG info (see clause 7.6.3.22); +- 3047 - extensible SS-Data (see clause 7.6.3.29). + +### 3048 7.6.3.15 Extensible forwarding information + +3049 This parameter represents the information related to each call forwarding service: + +- 3050 - the SS-Code of the relevant call forwarding service (see clause 7.6.4.1); +- 3051 - if required, a list of extensible forwarding feature parameters (see clause 7.6.3.16). + +3052 The list may contain one item per Basic Service Group. + +### 3053 7.6.3.16 Extensible forwarding feature + +3054 This parameter applies to each combination of call forwarding service and Basic Service Group and contains the +3055 following information, as required: + +- 3056 - extensible Basic Service Group (see clause 7.6.3.5); +- 3057 - extensible SS-Status (see clause 7.6.3.17); +- 3058 - forwarded-to number (see clause 7.6.2.22); +- 3059 - forwarded-to subaddress (see clause 7.6.2.23); +- 3060 - extensible forwarding options (see clause 7.6.3.18); +- 3061 - extensible no reply condition timer (see clause 7.6.4.19); +- 3062 - long forwarded-to number (see clause 7.6.2.22A). + +3063 If a number is required to define the forwarded-to destination then: + +- 3064 - If the VLR supports Long Forwarded-to Numbers then the long forwarded-to number shall be present and the +3065 forwarded-to number shall be absent; +- 3066 - If the VLR does not support Long Forwarded-to Numbers then the forwarded-to number shall be present and the +3067 long forwarded-to number shall be absent. + +### 3068 7.6.3.17 Extensible SS-Status + +3069 This parameter refers to the state information of individual supplementary services as defined in 3GPP TS 23.011 [22]. + +### 3070 7.6.3.18 Extensible Forwarding Options + +3071 This parameter refers to a set of forwarding options attached to a supplementary service. It contains the following +3072 information: + +- 3073 - notification to forwarding party (see 3GPP TS 22.082 [10] for the meaning of this +3074 parameter); +- 3075 - redirection notification to the forwarded-to party (see 3GPP TS 22.082 [10] for the meaning of this +3076 parameter); +- 3077 - notification to calling party (see 3GPP TS 22.082 [10] for the meaning of this +3078 parameter); +- 3079 - redirecting presentation (see 3GPP TS 22.082 [10] for the meaning of this +3080 parameter); +- 3081 - forwarding reason (see 3GPP TS 22.082 [10] for the meaning of this +3082 parameter). + +### 3083 7.6.3.19 Extensible No reply condition timer + +3084 This parameter refers to the extensible no reply condition timer for call forwarding on no reply. + +### 3085 7.6.3.20 Extensible Call barring information + +3086 This parameter contains for each call barring service: + +- 3087 - SS-Code (see clause 7.6.4.1); +- 3088 - a list of extensible call barring feature parameters (see clause 7.6.3.21). + +3089 The list may contain one item per Basic Service Group. + +### 3090 7.6.3.21 Extensible Call barring feature + +3091 This parameter gives the status of call barring services as applicable to each Basic Service Group. The parameter +3092 contains the following information: + +- 3093 - Extensible Basic Service Group (see clause 7.6.3.5); +- 3094 - provisioned SS-Status (see clause 7.6.3.17). + +### 3095 7.6.3.22 CUG info + +3096 This parameter refers to the overall information required for operation for each CUG: + +- 3097 - CUG subscriptionList; +- 3098 - CUG featureList. + +### 3099 7.6.3.23 CUG subscription + +3100 This parameter refers to the set of basic information for each CUG defined in that subscription. The following +3101 information is stored: + +- 3102 - CUG index; +- 3103 - CUG interlock; +- 3104 - Intra CUG restrictions; +- 3105 - Basic Service Group List. + +#### 3106 7.6.3.24 CUG interlock + +3107 This parameter represents the CUG interlock code defined in ETS 300 138. + +#### 3108 7.6.3.25 CUG index + +3109 This parameter represents the CUG index defined in ETS 300 138. + +#### 3110 7.6.3.26 CUG feature + +3111 This parameter contains two parameters that are associated with the Basic Service Group. If the Basic Service Group +3112 Code is not present the feature applies to all Basic Services. The following parameters are included: + +- 3113 - Preferential CUG indicator: + - 3114 - indicates which CUG index is to be used at outgoing call set-up using the associated Basic Service Group; +- 3115 - Inter CUG Option: + - 3116 - describes whether it for the associated Basic Service Group is allowed to make calls outside the CUG and +3117 whether incoming calls are allowed; +- 3118 - Basic Service Group. + +3119 See 3GPP TS 22.085 [13] for meaning of this parameter. + +#### 3120 7.6.3.27 Inter CUG options + +3121 This parameter indicates the subscribers' ability to make and receive calls outside a specific closed user group. It takes +3122 any of the following values: + +- 3123 - CUG only facility (only calls within CUG are allowed); +- 3124 - CUG with outgoing access (calls outside CUG allowed); +- 3125 - CUG with incoming access (calls from outside CUG into CUG allowed); +- 3126 - CUG with both incoming and outgoing access (all calls allowed). + +#### 3127 7.6.3.28 Intra CUG restrictions + +3128 This parameter describes whether or not the subscriber is allowed to originate calls to or to receive calls from within the +3129 CUG. It can take any of the following values: + +- 3130 - no CUG restrictions; +- 3131 - CUG incoming calls barred; +- 3132 - CUG outgoing calls barred. + +#### 3133 7.6.3.29 Extensible SS-Data + +3134 This parameter refers to the necessary set of information required in order to characterise one supplementary service: + +- 3135 - SS-Code (see clause 7.6.4.1); +- 3136 - Extensible SS-Status (if applicable) (see clause 7.6.3.17); +- 3137 - Extensible Override subscription option (if applicable) (see clause 7.6.3.30); +- 3138 - Extensible CLI Restriction (if applicable) (see clause 7.6.3.31); +- 3139 - Extensible Basic Service Group Code (see clause 7.6.3.5). + +3140 **7.6.3.30 Subscriber State** + +3141 This parameter indicates the state of the MS as defined in 3GPP TS 23.018 [97]. + +3142 **7.6.3.31 Requested Info** + +3143 This parameter indicates the subscriber information being requested as defined in 3GPP TS 23.018 [97] and 3GPP +3144 TS 23.078 [98]. + +3145 **7.6.3.31A Requested Domain** + +3146 This parameter indicates the domain (circuit switched, i.e. from the MSC/VLR, or packet switched, i.e. from the SGSN) +3147 from which the requested information should be retrieved. + +3148 **7.6.3.32 Suppression of Announcement** + +3149 This parameter indicates if the announcement or tones shall be suppressed as defined in 3GPP TS 23.078 [98]. + +3150 **7.6.3.33 Suppress T-CSI** + +3151 This parameter is used to suppress the invocation of terminating CAMEL services. + +3152 **7.6.3.34 GMSC CAMEL Subscription Info** + +3153 This parameter contains CAMEL subscription information, i.e. O-CSI and/or D-CSI and/or T-CSI, which indicates to +3154 the GMSC that originating and/or terminating CAMEL services shall be invoked for the incoming call. + +3155 **7.6.3.35 VLR CAMEL Subscription Info** + +3156 This parameter identifies the subscriber as having CAMEL services that are invoked in the MSC or VLR. + +3157 **7.6.3.36 Supported CAMEL Phases in the VLR** + +3158 This parameter indicates which phases of CAMEL are supported in the VLR. + +3159 **7.6.3.36A Supported CAMEL Phases in the SGSN** + +3160 This parameter indicates which phases of CAMEL are supported in the SGSN. + +3161 **7.6.3.36B Offered CAMEL4 CSIs in the VLR** + +3162 This parameter indicates which CSIs of CAMEL phase 4 are offered in the VLR as defined in 3GPP TS 23.078. + +3163 **7.6.3.36C Offered CAMEL4 CSIs in the SGSN** + +3164 This parameter indicates which CSIs of CAMEL phase 4 are offered in the SGSN as defined in 3GPP TS 23.078. + +3165 **7.6.3.36D Offered CAMEL4 CSIs** + +3166 This parameter indicates which CSIs of CAMEL phase 4 are offered as defined in 3GPP TS 23.078. + +3167 **7.6.3.36E Offered CAMEL4 CSIs in interrogating node** + +3168 This parameter indicates which CSIs of CAMEL phase 4 are offered in the GMSC or in the gsmSCF as defined in +3169 3GPP TS 23.078. + +3170 **7.6.3.36F Offered CAMEL4 CSIs in VMSC** + +3171 This parameter indicates which CSIs of CAMEL phase 4 are offered in the VMSC as defined in 3GPP TS 23.078. + +#### 3172 **7.6.3.36G Offered CAMEL4 Functionalities** + +#### 3173 **7.6.3.36H Supported CAMEL Phases** + +3174 This parameter indicates which phases of CAMEL are supported as defined in 3GPP TS 23.078. + +#### 3175 **7.6.3.36I Supported CAMEL Phases in interrogating node** + +3176 This parameter indicates which phases of CAMEL are supported as defined in 3GPP TS 23.078. The interrogating node +3177 may be a GMSC or a gsmSCF. + +3178 This parameter indicates which functionalities of CAMEL phase 4 are offered as defined in 3GPP TS 23.078. + +#### 3179 **7.6.3.37 CUG Subscription Flag** + +3180 This parameter indicates that a subscriber with a T-CSI also has a CUG subscription. It is defined in 3GPP TS 23.078. + +#### 3181 **7.6.3.38 CAMEL Subscription Info Withdraw** + +3182 This parameter indicates that CAMEL Subscription Info shall be deleted from the VLR or SGSN. + +#### 3183 **7.6.3.39 Voice Group Call Service (VGCS) Data** + +3184 This parameter refers to one or more groups a subscriber may be a member of for voice group calls. + +#### 3185 **7.6.3.40 Voice Broadcast Service (VBS) Data** + +3186 This parameter refers to one or more groups a subscriber may be a member of for the voice broadcast service. Per group +3187 it is further indicated whether the subscriber is only allowed to listen to respective group calls or whether he is in +3188 addition entitled to initiate respective voice broadcast calls. + +#### 3189 **7.6.3.41 ISDN bearer capability** + +3190 This parameter refers to the ISDN bearer capability information element defined in 3GPP TS 29.007 [56]. + +#### 3191 **7.6.3.42 Lower layer Compatibility** + +3192 This parameter refers to the lower layer compatibility information element defined in 3GPP TS 24.008 [35]. + +#### 3193 **7.6.3.43 High Layer Compatibility** + +3194 This parameter refers to the high layer compatibility information element defined in 3GPP TS 24.008 [35]. + +#### 3195 **7.6.3.44 Alerting Pattern** + +3196 This parameter is an indication that can be used by the MS to alert the user in a specific manner in case of mobile +3197 terminating traffic (switched call or USSD). That indication can be an alerting level or an alerting category. + +#### 3198 **7.6.3.45 GPRS Subscription Data Withdraw** + +3199 This parameter indicates that GPRS Subscription Data shall be deleted from the SGSN. + +#### 3200 **7.6.3.45A EPS Subscription Data Withdraw** + +3201 This parameter indicates that EPS Subscription Data shall be deleted from the MME. + +#### 3202 7.6.3.46 GPRS Subscription Data + +3203 This parameter refers to the list of PDP-Contexts the subscriber has subscribed to. + +#### 3204 7.6.3.46A EPS Subscription Data + +3205 This parameter refers to the list of APN-Configurations the subscriber has subscribed to. + +#### 3206 7.6.3.47 QoS-Subscribed + +3207 This parameter indicates the quality of service subscribed for a certain service. It is defined in 3GPP TS 23.060 [104]. + +#### 3208 7.6.3.48 VPLMN address allowed + +3209 This parameter specifies whether the MS is allowed to use a dynamic address allocated in the VPLMN. It is defined in +3210 3GPP TS 23.060 [104]. + +#### 3211 7.6.3.49 Roaming Restricted In SGSN/MME Due To Unsupported Feature + +3212 This parameter defines that a subscriber is not allowed to roam in the current SGSN or MME area. It may be used by +3213 the HLR if a feature or service is indicated as unsupported by the SGSN or MME. + +#### 3214 7.6.3.50 Network Access Mode + +3215 This parameter is defined in 3GPP TS 23.008 [20]. + +#### 3216 7.6.3.51 Mobile Not Reachable Reason + +3217 This parameter stores the reason for the MS being absent when an attempt to deliver a short message to an MS fails at +3218 the MSC, SGSN or both. It is defined in 3GPP TS 23.040. + +#### 3219 7.6.3.52 Cancellation Type + +3220 This parameter indicates the reason of location cancellation. It is defined in 3GPP TS 23.060 [104]. The HLR shall not +3221 send Cancel Location with a Cancellation Type of "initialAttachProcedure" to the SGSN unless the SGSN has indicated +3222 support of this cancellation type within UpdateGprsLocation or the HLR has enough knowledge that the SGSN supports +3223 "initialAttachProcedure". If the HLR needs to send a cancellation type of "initialAttachProcedure" but cannot do so due +3224 to non-support by the SGSN, the HLR shall send Cancel Location with a Cancellation Type of "updateProcedure" and +3225 delete the stored SGSN-Number. + +#### 3226 7.6.3.53 All GPRS Data + +3227 This parameter indicates to the SGSN that all GPRS Subscription Data shall be deleted for the subscriber. + +#### 3228 7.6.3.54 Complete Data List Included + +3229 This parameter indicates to the SGSN or MME that the complete GPRS Subscription Data/EPS Subscription Data +3230 stored for the Subscriber shall be replaced with the GPRS Subscription Data/EPS Subscription Data received. + +#### 3231 7.6.3.55 PDP Context Identifier + +3232 This parameter is used to identify a PDP context for the subscriber. + +#### 3233 7.6.3.56 LSA Information + +3234 This parameter refers to one or more localised service areas a subscriber may be a member of, together with the priority, +3235 the preferential access indicator, the active mode support indicator and active mode indication of each localised service +3236 area. The access right outside these localised service areas is also indicated. + +### 3237 7.6.3.57 SoLSA support indicator + +3238 This parameter indicates that the VLR or the SGSN supports SoLSA subscription. + +### 3239 7.6.3.58 LSA Information Withdraw + +3240 This parameter indicates that LSA information shall be deleted from the VLR or the SGSN. + +### 3241 7.6.3.59 LMU Indicator + +3242 This parameter indicates the presence of an LMU. + +### 3243 7.6.3.60 LCS Information + +3244 This parameter defines the LCS related information for an MS subscriber and contains the following components: + +- 3245 - GMLC List (see clause 7.6.3.61). +- 3246 - LCS Privacy Exception List (see clause 7.6.3.62). +- 3247 - MO-LR List (see clause 7.6.3.65A). +- 3248 - Additional LCS Privacy Exception List (see clause 7.6.3.62A). + +3249 + +### 3250 7.6.3.61 GMLC List + +3251 This parameter contains the addresses of all GMLCs that are permitted to issue a call/session unrelated or call/session +3252 related MT-LR location request for this MS. Usage of this parameter is defined in 3GPP TS 23.271. + +### 3253 7.6.3.62 LCS Privacy Exception List + +3254 This parameter defines the classes of LCS Client that are allowed to locate any target MS. For each class, the following +3255 information is provided: + +- 3256 - SS-Code (see clause 7.6.4.1); +- 3257 - a list of LCS privacy exception parameters (see clause 7.6.3.63). + +### 3258 7.6.3.62A Additional LCS Privacy Exception List + +3259 This parameter defines the classes of LCS Client that are allowed to locate any target MS. For each class, the following +3260 information is provided: + +- 3261 - SS-Code (see clause 7.6.4.1); +- 3262 - a list of LCS privacy exception parameters (see clause 7.6.3.63). + +3263 The Additional LCS Privacy Exception List shall be present only if the LCS Privacy Exception List is present and +3264 contains LCS privacy exception parameters for 4 privacy exception classes. + +### 3265 7.6.3.63 LCS Privacy Exception Parameters + +3266 This parameter gives the status of each LCS privacy exception class and any additional parameters relevant to this class. +3267 The parameter contains the following information: + +- 3268 - provisioned SS-Status (see clause 7.6.3.17); +- 3269 - privacy notification to MS user (see clause 7.6.3.65B); +- 3270 - external client List (see clause 7.6.3.64); + +- 3271 - internal client List (see clause 7.6.3.65). +3272 - service type List (see clause 7.6.3.65D); +3273 + +#### 3274 7.6.3.64 External Client List + +3275 This parameter is only applicable to the call/session unrelated privacy class and call/session related privacy class, and +3276 gives the identities of the external clients that are allowed to locate a target MS for a MT-LR. Each identity is an +3277 international (e.g.E.164) address. For each identified external client, GMLC restrictions may be defined. It may also be +3278 indicated if the MS shall be notified of a non-restricted MT-LR from each identified LCS client and, if so, whether +3279 notification only or notification with privacy verification shall apply. Usage of this parameter is defined in 3GPP TS +3280 23.271. + +#### 3281 7.6.3.65 Internal Client List + +3282 This parameter is only applicable to the PLMN operator privacy class and gives the identities of the internal PLMN +3283 operator clients that are allowed to locate a target MS for an NI-LR or MT-LR. Usage of this parameter is defined in +3284 3GPP TS 23.271. + +#### 3285 7.6.3.65A MO-LR List + +3286 This parameter defines the classes of MO-LR for which a subscription exists for a particular MS. For each class, the +3287 following information is provided: + +- 3288 - SS-Code (see clause 7.6.4.1). + +#### 3289 7.6.3.65B Privacy Notification to MS User + +3290 This parameter is applicable to the call/session unrelated privacy class and call/session related privacy class. For non- +3291 call/call related privacy class it indicates whether the MS user shall be notified for that class MT-LR from any value +3292 added LCS client when the MT-LR is restricted and be enabled to accept or override the restriction. Usage of this +3293 parameter is defined in 3GPP TS 23.271. + +#### 3294 7.6.3.65C GMLC List Withdraw + +3295 This parameter indicates whether the subscriber's LCS GMLC list shall be deleted from the VLR or SGSN. + +#### 3296 7.6.3.65D Service Type List + +3297 This parameter is only applicable to the Service type privacy class and gives the identities of the service type of the +3298 clients that are allowed to locate a target MS for an MT-LR. Usage of this parameter is defined in 3GPP TS 23.271. + +#### 3299 7.6.3.66 IST Alert Timer + +3300 This parameter indicates the IST Alert Timer value that must be used in the MSC to inform the HLR about the call +3301 activities that the subscriber performs. Units are minutes. + +#### 3302 7.6.3.67 Call Termination Indicator + +3303 This parameter indicates whether the MSC shall terminate a specific ongoing call, or all the call activities related to a +3304 specified subscriber. + +#### 3305 7.6.3.68 IST Information Withdraw + +3306 This parameter indicates that IST information shall be deleted from the VMSC. + +#### 3307 7.6.3.69 IST Support Indicator + +3308 This parameter indicates the degree of IST functionality supported by the MSC (Visited MSC or Gateway MSC). It can +3309 take one of the following values: + +- 3310 - Basic IST functionality; +- 3311 - IST command service (in addition to the basic IST functionality and including the ability to terminate all calls +3312 being carried for the identified subscriber). + +#### 3313 **7.6.3.70 Super-Charger Supported In HLR** + +3314 This parameter is used by the HLR to indicate support of the Super-Charger functionality and an indication of the age of +3315 the subscription data stored in the HLR. + +#### 3316 **7.6.3.71 Super-Charger Supported In Serving Network Entity** + +3317 This parameter is used to indicate support of the Super-Charger functionality by the originating entity and to indicate +3318 either that subscription data is required or the date and time of the last know subscriber data modification. + +#### 3319 **7.6.3.72 Age Indicator** + +3320 This parameter is used by the HLR to determine the validity of the subscription data retained by the serving network +3321 entity in a Super-Charged network. + +#### 3322 **7.6.3.73 GPRS enhancements support indicator** + +3323 This parameter indicates to the HLR that the SGSN supports GPRS enhancements. + +#### 3324 **7.6.3.74 Extension QoS-Subscribed** + +3325 This parameter indicates the enhanced QoS subscribed for a certain service. It is defined in 3GPP TS 23.060. This +3326 parameter is an extension to QoS-Subscribed. + +#### 3327 **7.6.3.75 SGSN CAMEL Subscription Info** + +3328 This parameter identifies the subscriber as having CAMEL services that are invoked in the SGSN. + +#### 3329 **7.6.3.75A Extension-2 QoS-Subscribed** + +3330 This parameter indicates the additional QoS information to the Extension QoS-subscribed parameter. It is a further +3331 extension to Extension QoS-Subscribed. This parameter shall be used when the maximum bit rate exceeds 8640 kbps. +3332 For more details, refer to 3GPP TS 24.008 [35]. + +#### 3333 **7.6.3.75B Extension-3 QoS-Subscribed** + +3334 This parameter indicates the additional QoS information to the Extension QoS-subscribed parameter. It is a further +3335 extension to Extension QoS-Subscribed. This parameter shall be used when the maximum/guaranteed bit rate for uplink +3336 exceeds 8640 kbps. For more details, refer to 3GPP TS 24.008 [35]. + +#### 3337 **7.6.3.75C Extension-4 QoS-Subscribed** + +3338 This parameter indicates the additional QoS information to the Extension QoS-subscribed parameter. It is a further +3339 extension to Extension QoS-Subscribed. This parameter shall be used to define the Evolved Allocation/Retention +3340 Priority parameter, which includes the Priority Level, the Preemption Capability value and the Preemption vulnerability +3341 value, as described in 3GPP TS 29.060 [105]. + +#### 3342 **7.6.3.76 MO-SMS-CSI** + +3343 This parameter identifies the subscriber as having mobile originating SMS CAMEL services as defined in 3GPP TS +3344 23.078. For the CAMEL phase 3 the MO-SMS-CSI is the same as the SMS-CSI. + +3345 **7.6.3.76a MT-SMS-CSI** + +3346 This parameter identifies the subscriber as having mobile terminating SMS CAMEL services as defined in 3GPP TS +3347 23.078. + +3348 **7.6.3.77 GPRS-CSI** + +3349 This parameter identifies the subscriber as having GPRS CAMEL services as defined in 3GPP TS 23.078. + +3350 **7.6.3.78 CAMEL subscription info** + +3351 This parameter indicates the CSI that can be controlled by CSE. + +3352 **7.6.3.79 Extensible Call barring information for CSE** + +3353 This parameter contains for each call barring service for CSE: + +- 3354 - SS-Code; +- 3355 - a list of extensible call barring feature parameters. +3356 The list may contain one item per Basic Service Group. +- 3357 - password; +- 3358 - wrong password attempt counter; +- 3359 - notification-to-CSE flag. + +3360 **7.6.3.80 Extensible Forwarding information for CSE** + +3361 This parameter represents the information for CSE related to each call forwarding service: + +- 3362 - the SS-Code of the relevant call forwarding service; +- 3363 - if required, a list of extensible forwarding feature parameters; +- 3364 - the list may contain one item per Basic Service Group; +- 3365 - notification-to-CSE flag. + +3366 **7.6.3.81 Modification Request for CSI** + +3367 This parameter indicates the CAMEL subscription information to be modified by CSE. + +3368 **7.6.3.81a Modification Request for ODB data** + +3369 This parameter indicates the operator determined barring data to be modified by CSE. + +3370 **7.6.3.82 Modification Request for SS Information** + +3371 This parameter indicates the call forwarding, call barring, call hold, call waiting, explicit call transfer, calling line +3372 identification presentation and calling line identification restriction supplementary service data to be modified by CSE. + +3373 **7.6.3.83 Call Barring Data** + +3374 This parameter contains the extensible call barring feature list (see clause 7.6.3.21) and Notification to CSE flag. + +3375 **7.6.3.84 Call Forwarding Data** + +3376 This parameter contains the extensible call forwarding feature list (see clause 7.6.3.16) and Notification to CSE flag. + +3377 **7.6.3.85 ODB Data** + +3378 This parameter contains the ODB general data, ODB HPLMN specific data. + +3379 **7.6.3.86 Requested Subscription Info** + +3380 This parameter indicates the subscription information being requested. + +3381 **7.6.3.87 CS Allocation/Retention priority** + +3382 This parameter indicates the allocation/retention priority for Circuit Switched (CS). It corresponds to the +3383 allocation/retention priority that is defined in 3GPP TS 23.107 [154]. + +3384 **7.6.3.88 ODB Info** + +3385 This parameter contains the ODB data and Notification to CSE flag. + +3386 **7.6.3.89 Suppress VT-CSI** + +3387 This parameter is used to suppress the invocation of terminating CAMEL services at the VMSC. + +3388 **7.6.3.90 Suppress Incoming Call Barring** + +3389 This parameter is used to suppress the invocation of Incoming Call Barrings. + +3390 **7.6.3.91 gsmSCF Initiated Call** + +3391 This parameter is used to indicate that the call was initiated by the gsmSCF. + +3392 **7.6.3.91a SuppressMTSS** + +3393 This parameter is used to suppress the invocation of terminating supplementary services + +3394 **7.6.3.92 Call barring support indicator** + +3395 This parameter is used to indicate that the SGSN supports the call barring services for SMS. + +3396 **7.6.3.93 MNP Info Result** + +3397 This parameter refers to the Mobile Number Portability (MNP) information result (see 3GPP TS 23.078 [98] and 3GPP +3398 TS 23.066 [108]). This parameter may contain the following information: + +- 3399 - Routeing Number (see clause 7.6.2.63). +- 3400 - IMSI (see 3GPP TS 23.078[98], see also clause 7.6.2.1). +- 3401 - MSISDN (see clause 7.6.2.17). +- 3402 - Number Portability Status (see clause 7.6.5.14). + +3403 **7.6.3.94 Allowed Services** + +3404 This parameter is used by the HLR to indicate which service is available for a call when two services have been +3405 requested, for the SCUDIF feature described in 3GPP TS 23.172 [126]. + +### 3406 7.6.3.95 Unavailability Cause + +3407 This parameter is used to indicate the reason for the unavailability of one of the services as indicated by the Allowed +3408 Services IE (see 7.6.3.94) when two services have been requested, for the SCUDIF feature described in 3GPP TS +3409 23.172 [126]. + +### 3410 7.6.3.96 MNP Requested Info + +3411 This parameter indicates by its presence that Mobile Number Portability (MNP) information is requested for the +3412 subscriber, as defined in 3GPP TS 23.078 [98]. + +### 3413 7.6.3.97 Access Restriction Data + +3414 This parameter refers to the radio access technologies that are possibly restricted to a subscriber via subscription data. +3415 For the use of the parameter, see 3GPP TS 23.012 [23] for the CS domain and 3GPP TS 23.060[104], 3GPP TS 29.060 +3416 [105] clause 7.5.3 and 3GPP TS 29.274 [149] clause 7.3.6 for the PS domain. + +### 3417 7.6.3.98 Supported RAT types indicator + +3418 This parameter indicates which RAT types are supported/served by the MSC/VLR or SGSN or MME + +### 3419 7.6.3.99 UE SRVCC Capability + +3420 This parameter indicates, if present, the support of SRVCC capability by the UE. + +### 3421 7.6.3.100 Temporary Empty CSG Subscription data Indicator + +3422 This parameter indicates that the CSS has currently no CSG subscription data for this roaming user but registers the +3423 VLR or SGSN, so to inform them if later changes in CSG subscription data occur. + +### 3424 7.6.3.101 WLAN-offloadability + +3425 This parameter refers to the WLAN offloadability for E-UTRAN or UTRAN. This parameter is defined in 3GPP TS +3426 29.272 [144]. + +### 3427 7.6.3.102 IMSI-Group-Id + +3428 This parameter refers to the IMSI-Group identifier. This parameter is defined in 3GPP TS 29.272 [144]. + +3429 + +## 3430 7.6.4 Supplementary services parameters + +### 3431 7.6.4.1 SS-Code + +3432 This parameter may refer to one supplementary service or a set of supplementary services as defined in 3GPP TS +3433 22.004. For MAP this includes: + +- 3434 - Calling Line Identification Presentation service (CLIP); +- 3435 - Calling Line Identification Restriction service (CLIR); +- 3436 - Connected Line Identification Presentation service (COLP); +- 3437 - Connected Line Identification Restriction service (COLR); +- 3438 - Calling Name Presentation (CNAP); +- 3439 - All Call Forwarding services, including Call Deflection; + +- 3440 - Call Waiting (CW); +- 3441 - Call Hold (HOLD); +- 3442 - Multi-Party service (MPTY); +- 3443 - Closed User Group (CUG); +- 3444 - All Charging services; +- 3445 - All Call Restriction services; +- 3446 - Explicit Call Transfer service (ECT); +- 3447 - enhanced Multi-Level Precedence and Pre-emption service (eMLPP); +- 3448 - Completion of Calls to Busy Subscriber, originating side (CCBS-A); +- 3449 - Completion of Calls to Busy Subscriber, destination side (CCBS-B); +- 3450 - All LCS privacy exceptions (see clause 7.6.4.44); +- 3451 - Mobile Originating Location Request (MO-LR) (see clause 7.6.4.45); +- 3452 - Multicall (MC). + +#### 3453 7.6.4.1A SS-Code 2 + +3454 This parameter is used to refer to one or a set of supplementary services (as 7.6.4.1 "SS-Code") related to Network + 3455 Signal Info 2 for SCUDIF calls (see 3GPP TS 23.172 [126]). + +#### 3456 7.6.4.2 SS-Status + +3457 This parameter refers to the state information of individual supplementary services as defined in 3GPP TS 23.011. + +#### 3458 7.6.4.3 SS-Data + +3459 This parameter refers to the necessary set of information required in order to characterise one supplementary service: + +- 3460 - SS-Code (see clause 7.6.4.1); +- 3461 - SS-Status (if applicable) (see clause 7.6.4.2); +- 3462 - Override subscription option (see clause 7.6.4.4); +- 3463 - CLI Restriction (see clause 7.6.4.5); +- 3464 - Basic Service Group Code (see clause 7.6.4.40). + +#### 3465 7.6.4.4 Override Category + +3466 This parameter refers to the subscription option Override Category attached to a supplementary service. It can take the + 3467 following two values: + +- 3468 - Enabled; +- 3469 - Disabled. + +#### 3470 7.6.4.5 CLI Restriction Option + +3471 This parameter refers to the subscription option Restriction mode attached to the CLIR supplementary service. It can + 3472 take the following three values: + +- 3473 - Permanent; + +- 3474 - Temporary (Default Restricted); +- 3475 - Temporary (Default Allowed). + +#### 3476 7.6.4.6 Forwarding Options + +3477 This parameter refers to a forwarding option attached to a supplementary service. It can take one of the following +3478 values: + +- 3479 - notification to forwarding party (see 3GPP TS 22.082 [10] for the meaning of this parameter); +- 3480 - notification to calling party (see 3GPP TS 22.082 [10] for the meaning of this parameter); +- 3481 - redirecting presentation (see 3GPP TS 22.082 [10] for the meaning of this parameter); +- 3482 - Forwarding reason (see 3GPP TS 22.082 [10] for the meaning of this parameter). + +#### 3483 7.6.4.7 No reply condition timer + +3484 This parameter refers to the no reply condition timer for call forwarding on no reply. + +#### 3485 7.6.4.8 - 7.6.4.14 Void + +#### 3486 7.6.4.15 Forwarding information + +3487 This parameter represents the information related to each call forwarding service: + +- 3488 - the SS-Code of the relevant call forwarding service (see clause 7.6.4.1); + - 3489 - if required, a list of forwarding feature parameters (see clause 7.6.4.16). +- 3490 the list may contain one item per Basic Service Group. + +#### 3491 7.6.4.16 Forwarding feature + +3492 This parameter applies to each combination of call forwarding service and Basic Service Group and contains the +3493 following information, as required: + +- 3494 - Basic Service Group (see clause 7.6.4.40); +- 3495 - SS-Status (see clause 7.6.4.2); +- 3496 - forwarded-to number (see clause 7.6.2.22); +- 3497 - forwarded-to subaddress (see clause 7.6.2.23); +- 3498 - forwarding options (see clause 7.6.4.6); +- 3499 - no reply condition timer (see clause 7.6.4.7); +- 3500 - long forwarded-to number (see clause 7.6.2.22A). + +3501 If a number is required to define the forwarded-to destination then: + +- 3502 - If the VLR supports Long Forwarded-to Numbers then the long forwarded-to number shall be present and the +3503 forwarded-to number shall be absent. +- 3504 - If the VLR does not support Long Forwarded-to Numbers then the forwarded-to number shall be present and the +3505 long forwarded-to number shall be absent. + +#### 3506 7.6.4.17 Void + +#### 3507 7.6.4.18 Call barring information + +3508 This parameter contains for each call barring service: + +- 3509 - SS-Code (see clause 7.6.4.1); +- 3510 - a list of call barring feature parameters (see clause 7.6.4.19). +- 3511 The list may contain one item per Basic Service Group. + +#### 3512 7.6.4.19 Call barring feature + +3513 This parameter gives the status of call barring services as applicable to each Basic Service Group. The parameter +3514 contains the following information: + +- 3515 - Basic Service Group (see clause 7.6.4.40); +- 3516 - SS-Status (see clause 7.6.4.2). + +#### 3517 7.6.4.20 New password + +3518 This parameter refers to the password which the subscriber just registered in the network. + +3519 This parameter refers to a password used by the subscriber for supplementary service control. + +#### 3520 7.6.4.21 Current password + +3521 This parameter refers to a password used by the subscriber for supplementary service control. + +#### 3522 7.6.4.22 Guidance information + +3523 This parameter refers to guidance information given to a subscriber who is requested to provide a password. One of the +3524 following information may be given: + +- 3525 - "enter password"; +3526 this information is used for checking of the old password; +- 3527 - "enter new password"; +3528 this information is used during password registration for the request of the first new password; +- 3529 - "enter new password again"; +3530 this information is used during password registration for the request of the new password again for verification. + +#### 3531 7.6.4.23 Void + +#### 3532 7.6.4.24 SS-Info + +3533 This parameter refers to all the information related to a supplementary service and is a choice between: + +- 3534 - forwarding information (see clause 7.6.4.15); +- 3535 - call barring information (see clause 7.6.4.18); +- 3536 - CUG info (see clause 7.6.4.8); +- 3537 - SS-Data (see clause 7.6.4.3). +- 3538 - eMLPP information (see clause 7.6.4.41). + +#### 3539 7.6.4.25 - 7.6.4.35 Void + +#### 3540 7.6.4.36 USSD Data Coding Scheme + +3541 This parameter contains the information of the alphabet and the language used for the unstructured information in an +3542 Unstructured Supplementary Service Data operation. The coding of this parameter is according to the Cell Broadcast +3543 Data Coding Scheme as specified in 3GPP TS 23.038 [25]. + +#### 3544 7.6.4.37 USSD String + +3545 This parameter contains a string of unstructured information in an Unstructured Supplementary Service Data operation. +3546 The string is sent either by the mobile user or the network. The contents of a string sent by the MS are interpreted by the +3547 network as specified in 3GPP TS 22.090 [16]. + +#### 3548 7.6.4.38 Bearer service + +3549 This parameter may refer to a single bearer service, a set of bearer services or to all bearer services as defined in 3GPP +3550 TS 22.002 [3]. This parameter is used only for supplementary service management. + +#### 3551 7.6.4.38A Bearer Service 2 + +3552 This parameter is used to indicate the bearer service or set of bearer services (as 7.6.4.38 "Bearer service") related to +3553 Network Signal Info 2 for SCUDIF calls (see 3GPP TS 23.172 [126]). + +#### 3554 7.6.4.39 Teleservice + +3555 This parameter may refer to a single teleservice, a set of teleservices or to all teleservices as defined in 3GPP TS 22.003 +3556 [4]. This parameter is used only for supplementary service management. + +#### 3557 7.6.4.39A Teleservice 2 + +3558 This parameter is used to indicate the teleservice or set of teleservices (as 7.6.4.39 "Teleservice") related to Network +3559 Signal Info 2 for SCUDIF calls (see 3GPP TS 23.172 [126]). + +#### 3560 7.6.4.40 Basic Service Group + +3561 This parameter refers to the Basic Service Group either as a bearer service (see clause 7.6.4.38) or a teleservice (see +3562 clause 7.6.4.39). This parameter is used only for supplementary service management. The null value (i.e. neither bearer +3563 service nor teleservice) is used to denote the group containing all bearer services and all teleservices. + +#### 3564 7.6.4.41 eMLPP information + +3565 This parameter contains two parameters which are associated with the eMLPP service. The following two parameters +3566 are included: + +- 3567 - maximum entitled priority: + - 3568 - indicates the highest priority level the subscriber is allowed to apply for an outgoing call set-up; +- 3569 - default priority: + - 3570 - defines the priority level which shall be assigned to a call if no explicit priority is indicated during call set-up. + +#### 3571 7.6.4.42 SS-event + +3572 This parameter indicates the Supplementary Service for which an invocation notification is sent towards the gsmSCF. It +3573 can indicate one of the following services: + +- 3574 - Explicit Call Transfer (ECT) +- 3575 - Call Deflection (CD) +- 3576 - Multi-Party call (MPTY) + +3577 - Completion of Calls to Busy Subscriber (CCBS) + +#### 3578 7.6.4.43 SS-event data + +3579 This parameter contains additional information related to Supplementary Service invocation. Depending on the service +3580 invoked it can contain the following information: + +3581 ECT A list with all Called Party Numbers involved. + +3582 CD The called Party number involved. + +#### 3583 7.6.4.44 LCS Privacy Exceptions + +3584 Distinct SS codes are assigned to the following classes of LCS client in a target MS subscriber's privacy exception list. + +3585 - Universal Class; + +3586 - Call/session related value added class; + +3587 - Call/session unrelated value added class; + +3588 - PLMN operator class. + +3589 - Service type class. + +3590 + +#### 3591 7.6.4.45 Mobile Originating Location Request (MO-LR) + +3592 Distinct SS codes are assigned to the following classes of MO-LR: + +3593 - Basic Self Location; + +3594 - Autonomous Self Location; + +3595 - Transfer to Third Party. + +#### 3596 7.6.4.46 NbrUser + +3597 This parameter indicates the maximum number of parallel bearers that may be used as defined by the user at registration +3598 of the MC SS. + +#### 3599 7.6.4.47 MC Subscription Data + +3600 This parameter contains two parameters which are associated with the MC service. The following two parameters are +3601 included: + +3602 - NbrUser: + +3603 indicates the maximum number of parallel bearers that may be used as defined by the user at registration of +3604 the MC SS + +3605 - NbrSB: + +3606 indicates the maximum number of parallel bearers that may be used as defined by the user's subscription. + +#### 3607 7.6.4.48 MC Information + +3608 This parameter contains three parameters which are associated with the MC service. The following parameters are +3609 included: + +3610 - NbrSB; + +3611 - NbrUser; + +3612 - NbrSN. + +3613 Definitions of these parameters are provided in 3GPP TS 23.135. + +#### 3614 **7.6.4.49 CCBS Request State** + +3615 This parameter indicates the current state of the CCBS request. It can take one of seven values: + +3616 - request; + +3617 - recall; + +3618 - active; + +3619 - completed; + +3620 - suspended; + +3621 - frozen; + +3622 - deleted. + +#### 3623 **7.6.4.50 Basic Service Group 2** + +3624 This parameter refers to the Basic Service Group either as a bearer service (see clause 7.6.4.38) or a teleservice (see +3625 clause 7.6.4.39). This parameter is used only for supplementary service management. + +### 3626 **7.6.5 Call parameters** + +#### 3627 **7.6.5.1 Call reference number** + +3628 This parameter refers to a call reference number allocated by a call control MSC. + +#### 3629 **7.6.5.2 Interrogation type** + +3630 This parameter refers to the type of interrogation for routing information which is sent from a GMSC to an HLR. It can +3631 take either of two values: + +3632 - basic call (for information to route a call before the call has been extended to the VMSC of the called party); + +3633 - forwarding (for information to route the call to the forwarded-to destination after the VMSC of the forwarding +3634 party has requested the GMSC to resume handling of the call. + +#### 3635 **7.6.5.3 OR interrogation** + +3636 This parameter indicates that the GMSC which interrogated the HLR for routeing information is not in the same PLMN +3637 as the HLR, and therefore that the call will potentially be optimally routed. + +#### 3638 **7.6.5.4 OR capability** + +3639 This parameter indicates the phase of OR which the GMSC supports. + +#### 3640 **7.6.5.5 Forwarding reason** + +3641 This parameter indicates the reason for which the call is to be forwarded. It can take one of three values: + +3642 - busy subscriber; + +3643 - mobile subscriber not reachable; + +3644 - no subscriber reply. + +#### 3645 7.6.5.6 Forwarding interrogation required + +3646 This parameter indicates that if the VMSC of the forwarding subscriber requests the GMSC to resume handling of the +3647 call the GMSC shall interrogate the HLR for forwarding information. + +#### 3648 7.6.5.7 O-CSI + +3649 This parameter identifies the subscriber as having originating CAMEL services as defined in 3GPP TS 23.078. + +#### 3650 7.6.5.7A D-CSI + +3651 This parameter identifies the subscriber as having originating CAMEL dialled services as defined in 3GPP TS 23.078. + +#### 3652 7.6.5.7B T-CSI + +3653 This parameter identifies the subscriber as having terminating CAMEL services in the GMSC, as defined in 3GPP +3654 TS 23.078. + +#### 3655 7.6.5.7C VT-CSI + +3656 This parameter identifies the subscriber as having terminating CAMEL services in the VMSC, as defined in +3657 3GPP TS 23.078. + +#### 3658 7.6.5.7D O-IM-CSI + +3659 This parameter identifies the subscriber as having originating IP Multimedia Core Network CAMEL services as defined +3660 in 3GPP TS 23.278. + +#### 3661 7.6.5.7E D-IM-CSI + +3662 This parameter identifies the subscriber as having originating IP Multimedia Core Network CAMEL dialled services as +3663 defined in 3GPP TS 23.278. + +#### 3664 7.6.5.7F VT-IM-CSI + +3665 This parameter identifies the subscriber as having terminating IP Multimedia Core Network CAMEL services as +3666 defined in 3GPP TS 23.278. + +#### 3667 7.6.5.8 Void + +#### 3668 7.6.5.9 Void + +#### 3669 7.6.5.10 Void + +#### 3670 7.6.5.11 CCBS Feature + +3671 This parameter corresponds to the 'CCBS Description' parameter in 3GPP TS 23.093. It refers to the necessary set of +3672 information required in order to characterise a certain CCBS request. The parameter may contain the following +3673 information: + +- 3674 - CCBS Index (see 3GPP TS 23.093 for the use of this parameter); +- 3675 - B-subscriber number (see clause 7.6.2.48); +- 3676 - B-subscriber subaddress (see clause 7.6.2.49); + +3677 - Basic Service Group Code (see clause 7.6.4.40). + +#### 3678 7.6.5.12 UU Data + +3679 This parameter includes User-To-User Data. It is defined in 3GPP TS 23.087. + +#### 3680 7.6.5.13 UUS CF Interaction + +3681 This parameter indicates if the call forwarding or call deflection has been activated after UUS1 request has been +3682 accepted . It is defined in 3GPP TS 23.087. + +#### 3683 7.6.5.14 Number Portability Status + +3684 This parameter indicates the number portability status of subscriber. See 3GPP TS 23.066 [108]. + +#### 3685 7.6.5.15 Pre-paging supported + +3686 This parameter indicates that the entity which sent it supports pre-paging. + +#### 3687 7.6.5.16 MT Roaming Retry Supported + +3688 The parameter indicates that the entity which sent it supports MT Roaming Retry. When sent by the HLR, it further +3689 indicates that the GMSC also supports MT Roaming Retry. + +#### 3690 7.6.5.17 MT Roaming Retry + +3691 The parameter indicates that the GMSC receiving the IE shall start MT roaming retry (see 3GPP TS 23.018 [97] and +3692 3GPP TS 23.012 [23]). + +#### 3693 7.6.5.18 Paging Area + +3694 The parameter indicates the paging area where the MS is currently located (see 3GPP TS 23.012 [23] and 3GPP TS +3695 23.018 [97]). + +#### 3696 7.6.5.19 Call Priority + +3697 The parameter indicates the eMLPP priority of the call (see 3GPP TS 23.067 [136]). + +#### 3698 7.6.5.20 MTRF Supported + +3699 The parameter indicates that the entity which sends it supports MT Roaming Forwarding. + +#### 3700 7.6.5.21 LCLS Global Call Reference (LCLS GCR) + +3701 This parameter refers to a globally unique call identifier for the duration of the call (see 3GPP TS 29.205 [146]). This +3702 parameter is used to identify a call and to correlate the call legs of a call to determine if the call is a local call within the +3703 BSS. + +#### 3704 7.6.5.22 LCLS-Negotiation + +3705 This parameter is used to request MSC-B to indicate LCLS, see 3GPP TS 29.205 [146] clause B.2.1.4 LCLS +3706 Negotiation Request. + +#### 3707 7.6.5.23 LCLS-Configuration-Preference + +3708 This parameter contains information to indicate the negotiated LCLS configuration preference, see 3GPP TS 29.205 +3709 [146] clause B.2.1.10 LCLS Configuration Preference. + +## 3710 7.6.6 Radio parameters + +### 3711 7.6.6.1 - 7.6.6.3 Void + +### 3712 7.6.6.4 GERAN Classmark + +3713 This information element is sent from one MSC to the other MSC in the signalling for inter MSC handover. It is used +3714 to convey information related to cell capabilities, as defined in 3GPP TS 48.008. + +### 3715 7.6.6.5 BSSMAP Service Handover + +3716 This parameter refers to the Service Handover information element defined in 3GPP TS 48.008 + +### 3717 7.6.6.5A BSSMAP Service Handover List + +3718 This parameter refers to the list of Service Handover information elements defined in 3GPP TS 48.008. This parameter +3719 shall be used when there are multiple bearers and at least one of the bearers has an associated BSSMAP Service +3720 Handover parameter. + +### 3721 7.6.6.6 RANAP Service Handover + +3722 This parameter refers to the Service Handover information element defined in 3GPP TS 25.413. + +### 3723 7.6.6.7 HO-Number Not Required + +3724 This parameter indicates that no handover or relocation number allocation is necessary. + +### 3725 7.6.6.8 Integrity Protection Information + +3726 This parameter refers to the Integrity Protection Information element defined in 3GPP TS 25.413. + +### 3727 7.6.6.9 Encryption Information + +3728 This parameter refers to the Encryption Information element defined in 3GPP TS 25.413. + +### 3729 7.6.6.10 Radio Resource Information + +3730 This parameter refers to the Channel Type information element defined in 3GPP TS 48.008 [49]. + +### 3731 7.6.6.10A Radio Resource List + +3732 This parameter refers to list of RAB-id's and their associated Channel Type information elements defined in 3GPP TS +3733 48.008. This parameter shall be used when there are multiple bearers and at least one of the bearers has an associated +3734 Radio Resource Information parameter. + +### 3735 7.6.6.10B Chosen Radio Resource Information + +3736 This parameter refers to the Chosen Channel and Speech Version information elements defined in 3GPP TS 48.008. + +### 3737 7.6.6.11 Key Status + +3738 This parameter refers to the Key Status element defined in 3GPP TS 25.413. + +### 3739 7.6.6.12 Selected UMTS Algorithms + +3740 This parameters identifies the UMTS integrity and optionally encryption algorithms selected by MSC-B. Coding of this +3741 parameter is defined in 3GPP TS 25.413. + +#### 3742 7.6.6.13 Allowed GSM Algorithms + +3743 This parameter identifies the allowed GSM algorithms in MSC-B. Coding of this parameter is defined in 3GPP TS +3744 48.008. + +#### 3745 7.6.6.14 Allowed UMTS Algorithms + +3746 This parameter identifies the allowed UMTS algorithms in MSC-B. Coding of this parameter is defined in 3GPP TS +3747 25.413. + +#### 3748 7.6.6.15 Selected GSM Algorithm + +3749 This parameter identifies the GSM algorithm selected by GSM BSC controlled by MSC-B. Coding of this parameter is +3750 defined in 3GPP TS 48.008. + +#### 3751 7.6.6.16 Iu-Currently Used Codec + +3752 This parameter indicates the codec used at the Iu interface before handover. + +#### 3753 7.6.6.17 Iu-Supported Codecs List + +3754 This parameter indicates the codecs supported by the UE and by MSC-A and the associated modes in priority order (the +3755 first entry being the highest priority codec). MSC-B uses this information to select the associated transcoder resources. + +#### 3756 7.6.6.17A Iu-Available Codecs List + +3757 This parameter indicates the codecs available at the Iu interface in MSC-B and the associated modes. MSC-A uses this +3758 information to decide whether a change to a different codec at the Iu interface is possible. + +#### 3759 7.6.6.18 Iu-Selected Codec + +3760 When sent by MSC-B, this parameter indicates the codec selected by MSC-B for the Iu interface. When sent by MSC- +3761 A, this parameter indicates the codec to be used by MSC-B at the Iu interface. + +#### 3762 7.6.6.19 RAB Configuration Indicator + +3763 This parameter indicates by its presence that MSC-A (or MSC-B in case of subsequent handover) has generated the +3764 RAB parameters according to the preferred codec (first entry in the Iu-Supported Codecs List). + +#### 3765 7.6.6.20 UESBI-Iu + +3766 This parameter refers to the UESBI-Iu (UE Specific Behaviour Information over the Iu interface) information element +3767 defined in 3GPP TS 25.413. + +#### 3768 7.6.6.21 Alternative Channel Type + +3769 This parameter refers to the Channel Type information element defined in 3GPP TS 48.008 [49] for the alternative radio +3770 access bearer. This parameter is used for SCUDIF calls (see 3GPP TS 23.172 [126]). + +#### 3771 7.6.6.22 AoIP-Supported Codecs List Anchor + +3772 This parameter is used for inter- MSC handover with AoIP access and the procedures and contents of the parameter are +3773 as defined in AoIP-Supported Codecs List (Anchor) in 3GPP TS 23.009 [21]. + +#### 3774 7.6.6.23 AoIP-Available Codecs List Map + +3775 This parameter is used for inter- MSC handover with AoIP access and the procedures and contents of the parameter +3776 are as defined in AoIP-Available Codecs List (Map) in 3GPP TS 23.009 [21]. + +#### 3777 7.6.6.24 AoIP-Selected Codec Target + +3778 This parameter is used for inter-MSC handover with AoIP access and the procedures and contents of the parameter are +3779 as defined in AoIP-Selected Codec (Target) in 3GPP TS 23.009 [21]. + +### 3780 7.6.7 Authentication parameters + +#### 3781 7.6.7.1 Authentication set list + +3782 This parameter represents a list of sets of authentication parameters for a given subscriber. + +3783 The list either contains Authentication Triplets (Rand, Sres, Kc) or Authentication Quintuplets (Rand, Xres, Ck, Ik, +3784 Autn). If the list contains Authentication Quintuplets, the order of sequence in this list is chronological, the first +3785 quintuplet in the list is the oldest one. + +#### 3786 7.6.7.2 Rand + +3787 This parameter represents a random number used for authentication. + +#### 3788 7.6.7.3 Sres + +3789 This parameter represents the response to an authentication request. + +#### 3790 7.6.7.4 Kc + +3791 This parameter refers to a key used for ciphering purposes. + +#### 3792 7.6.7.5 Xres + +3793 This parameter represents the response to an UMTS authentication request. + +#### 3794 7.6.7.5A Ck + +3795 This parameter refers to a key used for UMTS ciphering purposes. + +#### 3796 7.6.7.5B Ik + +3797 This parameter refers to the Integrity Key. + +#### 3798 7.6.7.5C Autn + +3799 This parameter refers to the Authentication Token. + +#### 3800 7.6.7.5D KASME + +3801 This parameter refers to the Key for the Access Security Management Entity. + +#### 3802 7.6.7.6 Cksn + +3803 This parameter refers to a ciphering key sequence number. + +#### 3804 7.6.7.6A Ksi + +3805 This parameter refers to a key set identifier. + +#### 3806 7.6.7.6B Auts + +3807 This parameter refers to the resynchronisation token. + +### 3808 7.6.7.7 Ciphering mode + +3809 This parameter refers to the ciphering mode which is associated with a radio channel. It may take values as follows: + +- 3810 - no encryption; +- 3811 - identification of specific ciphering algorithm. + +### 3812 7.6.7.8 Current Security Context + +3813 This parameter represents a list of security context parameters for a given subscriber. + +3814 The list either contains GSM Security Context data (Kc, Cksn) or UMTS Security Context Data (Ck, Ik, Ksi). + +### 3815 7.6.7.9 Failure cause + +3816 This parameter refers to an authentication failure which has occurred. It may take values as follows: + +- 3817 - wrong user response; +- 3818 - wrong network signature. + +### 3819 7.6.7.10 Re-attempt + +3820 It indicates whether the failure occurred in a normal authentication attempt or in an authentication reattempt (there was a +3821 previous unsuccessful authentication). + +### 3822 7.6.7.11 Access Type + +3823 It indicates whether the authentication procedure was initiated due to a call, an emergency call, a location updating, a +3824 supplementary service procedure, a short message transfer, a GPRS attach procedure, a routing area updating, a service +3825 request, a MS initiated Detach in GPRS, a PDP context activation or a PDP context deactivation procedure. + +## 3826 7.6.8 Short message parameters + +### 3827 7.6.8.1 SM-RP-DA + +3828 This parameter represents the destination address used by the short message service relay sub-layer protocol. It can be +3829 either of the following: + +- 3830 - IMSI (see clause 7.6.2.1); +- 3831 - LMSI (see clause 7.6.2.16); +- 3832 - MS-ISDN (see clause 7.6.2.17); +- 3833 - roaming number (see clause 7.6.2.19); +- 3834 - service centre address (see clause 7.6.2.27). + +### 3835 7.6.8.2 SM-RP-OA + +3836 This parameter refers to the originating address used by the short message service relay sub-layer protocol. It can be +3837 either of the following: + +- 3838 - MS-ISDN (see clause 7.6.2.17); +- 3839 - service centre address (see clause 7.6.2.27). + +### 3840 7.6.8.3 MWD status + +3841 This parameter indicates whether or not the address of the originator service centre is already contained in the Message +3842 Waiting Data file. In addition, it contains the status of the Memory Capacity Exceeded Flag (MCEF), the status of the +3843 Mobile subscriber Not Reachable Flag (MNRF), the status of the Mobile station Not Reachable for GPRS flag +3844 (MNRG), the status of the Mobile station Not Reachable for 5G-3GPP access flag (MNR5G) and the status of the +3845 Mobile station Not Reachable for 5G-Non-3GPP access flag (MNR5GN3G). + +#### 3846 **7.6.8.4 SM-RP-UI** + +3847 This parameter represents the user data field carried by the short message service relay sub-layer protocol. + +#### 3848 **7.6.8.5 SM-RP-PRI** + +3849 This parameter is used to indicate whether or not delivery of the short message shall be attempted when a service centre +3850 address is already contained in the Message Waiting Data file. + +#### 3851 **7.6.8.6 SM Delivery Outcome** + +3852 This parameter indicates the cause for setting the message waiting data. It can take one of the following values: + +- 3853 - Absent subscriber; +- 3854 - MS memory capacity exceeded; +- 3855 - Successful transfer. + +#### 3856 **7.6.8.7 More Messages To Send** + +3857 This parameter is used to indicate whether or not the service centre has more short messages to send. + +#### 3858 **7.6.8.8 Alert Reason** + +3859 This parameter is used to indicate the reason why the service centre is alerted. It can take one of the following values: + +- 3860 - MS present; +- 3861 - Memory Available. + +#### 3862 **7.6.8.9 Absent Subscriber Diagnostic SM** + +3863 This parameter is used to indicate the reason why the subscriber is absent. For the values for this parameter see 3GPP +3864 TS 23.040. + +#### 3865 **7.6.8.10 Alert Reason Indicator** + +3866 This parameter indicates that the alert reason is sent to the HLR due to GPRS activity. + +#### 3867 **7.6.8.10A Additional Alert Reason Indicator** + +3868 This parameter indicates that the alert reason is sent to the HLR due to IMS activity. + +#### 3869 **7.6.8.11 Additional SM Delivery Outcome** + +3870 This parameter is used to indicate the GPRS delivery outcome in case a combination between delivery outcome for +3871 GPRS and non-GPRS are sent to the HLR. + +#### 3872 **7.6.8.12 Additional Absent Subscriber Diagnostic SM** + +3873 This parameter indicates the reason of the additional SM Delivery Outcome. + +#### 3874 7.6.8.13 Delivery Outcome Indicator + +3875 This parameter indicates that the delivery outcome sent to the HLR is for GPRS. + +#### 3876 7.6.8.14 GPRS Node Indicator + +3877 This parameter indicates by its presence that the Network Node Number sent by the HLR, SMS-Router or IP-SM-GW +3878 is to be considered as the SGSN number (although it may actually be an SMS-Router Number or IP-SM-GW Number). + +#### 3879 7.6.8.14A IMS Node Indicator + +3880 This parameter indicates by its presence that the Network Node Number sent by the HLR is an IP-SM-GW number. + +#### 3881 7.6.8.15 GPRS Support Indicator + +3882 This parameter indicates that the SMS-GMSC supports GPRS specific procedure of combine delivery of Short Message +3883 via MSC and/or via the SGSN. + +#### 3884 7.6.8.16 SM-RP-MTI + +3885 This parameter represents the RP-Message Type Indicator of the Short Message. It is used to distinguish a SM sent to +3886 the mobile station in order to acknowledge an MO-SM initiated by the mobile from a normal MT-SM. This parameter is +3887 formatted according to the formatting rules of address fields as described in 3GPP TS 23.040. + +#### 3888 7.6.8.17 SM-RP-SMEA + +3889 This parameter represents the RP-Originating SME-address of the Short Message Entity that has originated the SM. +3890 This parameter is used by the short message service relay sub-layer protocol and is formatted according to the +3891 formatting rules of address fields as described in 3GPP TS 23.040. + +#### 3892 7.6.8.18 IP-SM-GW SM Delivery Outcome + +3893 This parameter is used to indicate the delivery outcome for the IMS domain. + +#### 3894 7.6.8.19 IP-SM-GW Absent Subscriber Diagnostic SM + +3895 This parameter indicates the reason of the IP-SM-GW SM Delivery Outcome. + +#### 3896 7.6.8.20 IP-SM-GW Indicator + +3897 This parameter indicates by its presence that sm-deliveryOutcome is for delivery via IMS. + +#### 3898 7.6.8.21 SM Delivery Timer + +3899 This parameter indicates the SM Delivery Timer value set in the SMS-GMSC to the IP-SM-GW, SGSN or MSC/VLR. +3900 It may be taken into account by the domain selection procedure in the IP-SM-GW. Units are in seconds. + +#### 3901 7.6.8.22 SM Delivery Start Time + +3902 This parameter indicates the timestamp (in UTC) at which the SM Delivery Supervision Timer was started in the SMS- +3903 GMSC. + +#### 3904 7.6.8.23 Maximum Retransmission Time + +3905 This parameter indicates the maximum retransmission time (in UTC) until which the SMS-GMSC is capable to +3906 retransmit the MT Short Message. + +#### 3907 7.6.8.24 Requested Retransmission Time + +3908 This parameter indicates the retransmission time (in UTC) at which the SMS-GMSC is requested to retransmit the MT +3909 Short Message. + +#### 3910 **7.6.8.25 Maximum UE Availability Time** + +3911 This parameter indicates the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended +3912 idle mode DRX) is expected to be reachable for SM Delivery. + +3913 This information may be used by the SMS Center to prioritize the retransmission of Short Message to UEs using a +3914 power saving mechanism. + +#### 3915 **7.6.8.26 SMS-GMSC Alert Event** + +3916 This parameter indicates the event that causes the MME (via an IWF) or the SGSN to alert the SMS-GMSC for +3917 retransmitting an MT Short Message. + +#### 3918 **7.6.8.27 SMS-GMSC Address** + +3919 This parameter contains the E.164 number of the SMS-GMSC or SMS Router, in international number format as +3920 described in ITU-T Recommendation E.164 [67]. + +#### 3921 **7.6.8.28 SMS-GMSC Diameter Address** + +3922 This parameter contains the Diameter Identity of the SMS-GMSC or SMS Router. + +#### 3923 **7.6.8.29 New SGSN Number** + +3924 This parameter contains the E.164 number of the new SGSN serving the MS. + +#### 3925 **7.6.8.30 New MME Number** + +3926 This parameter contains the E.164 number of the new MME serving the MS. + +#### 3927 **7.6.8.31 New SGSN Diameter Address** + +3928 This parameter contains the Diameter Identity of the new SGSN serving the MS. + +#### 3929 **7.6.8.32 New MME Diameter Address** + +3930 This parameter contains the Diameter Identity of the new MME serving the MS. + +#### 3931 **7.6.8.33 New MSC Number** + +3932 This parameter contains the E.164 number of the new MSC serving the MS. + +#### 3933 **7.6.8.34 SMSF 3GPP Absent Subscriber Diagnostic SM** + +3934 This parameter is used to indicate the reason why the subscriber is absent for 5G 3GPP access. For the values for this +3935 parameter see 3GPP TS 23.040. + +#### 3936 **7.6.8.35 SMSF Non 3GPP Absent Subscriber Diagnostic SM** + +3937 This parameter is used to indicate the reason why the subscriber is absent for 5G Non 3GPP access. For the values for +3938 this parameter see 3GPP TS 23.040. + +#### 3939 **7.6.8.36 SMSF 3GPP Delivery Outcome Indicator** + +3940 This parameter indicates that the delivery outcome IE is associated to the SM delivery via the SMSF for 3GPP access. + +#### 3941 7.6.8.37 SMSF Non-3GPP Delivery Outcome Indicator + +3942 This parameter indicates that the delivery outcome IE is associated to the SM delivery via the SMSF for Non-3GPP +3943 access. + +#### 3944 7.6.8.38 SMSF 3GPP SM Delivery Outcome + +3945 This parameter is used to indicate the delivery outcome at the SMSF for 3GPP access. + +#### 3946 7.6.8.39 SMSF Non-3GPP SM Delivery Outcome + +3947 This parameter is used to indicate the delivery outcome at the SMSF for non-3GPP access. + +#### 3948 7.6.8.40 SMSF 3GPP Absent Subscriber Diagnostic SM + +3949 This parameter is used to indicate the reason why the subscriber is absent for 5G 3GPP access. For the values for this +3950 parameter see 3GPP TS 23.040. + +#### 3951 7.6.8.41 SMSF Non 3GPP Absent Subscriber Diagnostic SM + +3952 This parameter is used to indicate the reason why the subscriber is absent for 5G Non 3GPP access. For the values for +3953 this parameter see 3GPP TS 23.040. + +### 3954 7.6.9 Access and signalling system related parameters + +#### 3955 7.6.9.1 AN-apdu + +3956 This parameter includes one or two concatenated complete 3GPP TS 25.413 or 3GPP TS 48.006 [48] messages, as +3957 described in 3GPP TS 23.009 and 3GPP TS 29.010. The access network protocol ID indicates that the message or +3958 messages are according to either 3GPP TS 48.006 [48] or 3GPP TS 25.413. For the coding of the messages see 3GPP +3959 TS 25.413, 3GPP TS 48.006 [48] and 3GPP TS 48.008 [49]. + +#### 3960 7.6.9.2 CM service type + +3961 This parameter identifies the service category being requested by the subscriber: + +- 3962 - mobile originating call; +- 3963 - emergency call establishment; +- 3964 - short message service; +- 3965 - mobile originating call re-establishment; +- 3966 - mobile terminating call; +- 3967 - SS request; +- 3968 - Voice group call set-up; +- 3969 - Voice broadcast set-up. + +#### 3970 7.6.9.3 Access connection status + +3971 This parameter represents the following access connection status information: + +- 3972 - RR-connection status (established/not established); +- 3973 - ciphering mode (on/off); +- 3974 - authentication status (authenticated/not authenticated). + +#### 3975 7.6.9.4 External Signal Information + +3976 This parameter contains concatenated information elements (including tag and length) which are defined by a common +3977 protocol version, preceded by the associated protocol ID. It is used to transport information of the indicated protocol via +3978 MAP interfaces. + +#### 3979 7.6.9.5 Access signalling information + +3980 This parameter refers to any set of information elements imported from 3GPP TS 24.008 [35]. + +#### 3981 7.6.9.6 Location update type + +3982 This parameter refers to the location update type (normal, periodic or IMSI attach) contained in the 3GPP TS 24.008 +3983 [35] LOCATION REGISTRATION REQUEST message. + +#### 3984 7.6.9.7 Protocol ID + +3985 This parameter refers to the protocol to which the coding of the content of the associated External Signal Information +3986 conforms. + +3987 The following values are defined: + +3988 - 04.08; + +3989 - 08.06; + +3990 - ETS 300 102-1. + +3991 This value indicates the protocol defined by ETS 300 102-1 (EDSS1). + +#### 3992 7.6.9.8 Network signal information + +3993 This parameter is transported as external signal information. The protocol ID shall be set to "ETS 300 102-1". + +3994 The network signal information may include the following information elements as defined in 3GPP TS 29.007 [56]: + +3995 - ISDN BC; the tag and length are defined by ETS 300 102-1. + +3996 For the content, see 3GPP TS 29.007 [56]. + +3997 - HLC; the tag and length are defined by ETS 300 102-1. + +3998 For the content, see 3GPP TS 29.007 [56]. + +3999 - LLC; the tag and length are defined by ETS 300 102-1. + +4000 For the content, see 3GPP TS 29.007 [56]. + +4001 They are contained in the Signal Information parameter according to figure 7.6/1 (irrespective of the order): + +![Diagram of Network signal information parameter structure showing three stacked blocks for ISDN BC TAG, HLC TAG, and LLC TAG, each with LENGTH and CONTENT fields.](b8d855a06aad434aeafa2739bf62e7de_img.jpg) + +| | +|-------------| +| ISDN BC TAG | +| LENGTH | +| CONTENT | +| HLC TAG | +| LENGTH | +| CONTENT | +| LLC TAG | +| LENGTH | +| CONTENT | + +Diagram of Network signal information parameter structure showing three stacked blocks for ISDN BC TAG, HLC TAG, and LLC TAG, each with LENGTH and CONTENT fields. + +4002 + +4003 + +**Figure 7.6/1: Network signal information parameter** + +4004 **7.6.9.8A Network signal information 2** + +4005 This parameter is transported as additional external signal information for SCUDIF calls, described in 3GPP TS 23.172 + 4006 [126]. The protocol ID and possibly included information elements are identical to Network Signal Information, defined + 4007 in 7.6.9.8, "Network signal information". + +4008 **7.6.9.9 Call Info** + +4009 This parameter is transported as external signal information. The protocol ID shall be set to "3GPP TS 24.008 [35]". + +4010 The Call Info includes the set of information elements from the original SETUP message and is imported from 3GPP + 4011 TS 24.008 [35]. + +4012 **7.6.9.10 Additional signal info** + +4013 This parameter is transported as external signal information. The protocol ID shall be set to "ETS 300 356". + +4014 The additional signal information may include the following information elements: + +4015 - Calling Party Number as defined by ETS 300 356. + +4016 - Generic Number as defined by ETS 300 356. + +4017 They are contained in the Signal Information parameter according to figure 7.6/2 (irrespective of the order): + +![Diagram of Additional signal information parameter structure showing two stacked blocks, each with three empty rows.](9400925a53bd0c7e071258c54cb15c15_img.jpg) + +| | +|--| +| | +| | +| | +| | +| | +| | + +Diagram of Additional signal information parameter structure showing two stacked blocks, each with three empty rows. + +4018 + +4019 + +**Figure 7.6/2: Additional signal information parameter** + +4020 **7.6.10 System operations parameters** + +#### 4021 7.6.10.1 Network resources + +4022 This parameter refers to a class or type of network resource: + +- 4023 - PLMN; +- 4024 - HLR; +- 4025 - VLR (current or previous); +- 4026 - MSC (controlling or current); +- 4027 - EIR; +- 4028 - radio sub-system. + +#### 4029 7.6.10.2 Trace reference + +4030 This parameter represents a reference associated with a GSM only tracing request as defined in 3GPP TS 52.008 [61]. + +4031 The parameter is managed by OMC/EM. + +#### 4032 7.6.10.2A Trace reference 2 + +4033 This parameter represents a reference associated with a tracing request as defined in 3GPP TS 32.421 [131] and 3GPP +4034 TS 32.422 [132]. The parameter is managed by EM. + +#### 4035 7.6.10.3 Trace type + +4036 This parameter identifies the type of trace for GSM only tracing request. Trace types are fully defined in 3GPP +4037 TS 52.008 [61]. If the activation of the tracing is requested only for UMTS, then this parameter shall contain value "No +4038 MSC Trace" for MSC Record Type and value "No BSS Trace" for BSS Record Type. + +#### 4039 7.6.10.4 Additional network resources + +4040 This parameter refers to a class or type of network resource: + +- 4041 - SGSN; +- 4042 - GGSN; +- 4043 - GMLC; +- 4044 - gsmSCF; +- 4045 - NPLR; +- 4046 - AuC. + +#### 4047 7.6.10.5 Trace depth list + +4048 This parameter identifies the list of depths of trace per network element. See 3GPP TS 32.422 [132]. + +#### 4049 7.6.10.6 Trace NE type list + +4050 This parameter identifies the list of network elements to be traced. See 3GPP TS 32.422 [132]. + +#### 4051 7.6.10.7 Trace interface list + +4052 This parameter identifies the list of interfaces or protocols per network element to be traced. See 3GPP TS 32.422 +4053 [132]. + +#### 4054 7.6.10.8 Trace event list + +4055 This parameter identifies the list of events per network element, which trigger a Trace Recording Session. See 3GPP TS +4056 32.422 [132]. + +#### 4057 **7.6.10.9 Trace support indicator** + +4058 This parameter indicates that UMTS trace parameters are supported in the VLR or in the SGSN. + +#### 4059 **7.6.10.10 Trace Propagation List** + +4060 This parameter indicates UMTS trace propagation parameters sent from one MSC to the other MSC in the signalling +4061 for inter MSC handover/relocation. See 3GPP TS 32.422 [132]. + +#### 4062 **7.6.10.11 MDT-Configuration** + +4063 This parameter contains Minimization of Drive Test Configuration Data as defined in 3GPP TS 32.422 [132]. + +#### 4064 **7.6.10.12 MDT User Consent** + +4065 This parameter contains an indicator whether user consent for MDT activation is available or not as defined in 3GPP TS +4066 32.422 [132]. + +### 4067 **7.6.11 Location Service Parameters** + +#### 4068 **7.6.11.1 Age of Location Estimate** + +4069 This parameter indicates how long ago the location estimate was obtained. + +#### 4070 **7.6.11.2 Deferred MT-LR Response Indicator** + +4071 This parameter shows that this is a response to a deferred mt-lr request. + +#### 4072 **7.6.11.3 Deferred MT-LR Data** + +4073 This parameter is used to report the deferred location event type, the location information and reason why the serving +4074 node aborted monitoring the event to the GMLC. The termination cause mt-lrRestart shall be used to trigger the GMLC +4075 to restart the location procedure in all the cases where the sending node detects that the location procedure cannot be +4076 successfully performed anymore by the sending node and that it could be successfully performed by another node (as +4077 for example when Cancel Location or Send Identification has been received). The location information shall be +4078 included only if the termination cause is mt-lrRestart. The network node number contained in the location information +4079 refers to the node where the MS/UE has moved to and shall be included if available, like in case Send Identification has +4080 been received. + +#### 4081 **7.6.11.4 LCS Client ID** + +4082 This parameter provides information related to the identity of an LCS client. + +#### 4083 **7.6.11.5 LCS Event** + +4084 This parameter identifies an event associated with the triggering of a location estimate. + +#### 4085 **7.6.11.6 Void** + +#### 4086 **7.6.11.7 LCS Priority** + +4087 This parameter gives the priority of the location request. + +#### 4088 **7.6.11.8 LCS QoS** + +4089 This parameter defines the Quality of Service (QoS) for any location request. It is composed of the following elements. + +4090 1) Response Time + +4091 Indicates the category of response time – "low delay" or "delay tolerant". + +4092 2) Horizontal Accuracy + +4093 Indicates the required horizontal accuracy of the location estimate. + +4094 3) Vertical Coordinate + +4095 Indicates if a vertical coordinate is required (in addition to horizontal coordinates). + +4096 4) Vertical Accuracy + +4097 Indicates the required vertical accuracy of the location estimate (inclusion is optional). + +4098 5) Velocity Request + +4099 Indicates that velocity should be returned if available (inclusion is optional). + +4100 6) LCS QoS Class + +4101 Indicates that LCS QoS Class should be applied if available - "best effort" or "assured" (inclusion is optional). + +#### 4102 7.6.11.9 CS LCS Not Supported by UE + +4103 This parameter is used by the VLR to indicate to the HLR that the UE does not support neither UE Based nor UE + +4104 Assisted positioning methods for Circuit Switched Location Services. VLR defines the presence of this parameter on the + +4105 basis of the Classmark 3 information. + +#### 4106 7.6.11.10 PS LCS Not Supported by UE + +4107 This parameter is used by the SGSN to indicate to the HLR that the UE does not support neither UE Based nor UE + +4108 Assisted positioning methods for Packet Switched Location Services. SGSN defines the presence of this parameter on + +4109 the basis of the UE capability information and the access technology supported by the SGSN. + +#### 4110 7.6.11.11 Location Estimate + +4111 This parameter gives an estimate of the location of an MS in universal coordinates and the accuracy of the estimate. The + +4112 estimate is expressed in terms of the geographical shapes defined by 3GPP TS 23.032. and is composed of the type of + +4113 shape plus the encoding of the shape itself. Any type of shape defined in 3GPP TS 23.032 can be filled in in the + +4114 Location Estimate parameter, but only the encoding of the following shapes shall be carried by Location Estimate: + +4115 - Ellipsoid point with uncertainty circle + +4116 - Ellipsoid point with uncertainty ellipse + +4117 - Ellipsoid point with altitude and uncertainty ellipsoid + +4118 - Ellipsoid arc + +4119 - Ellipsoid point + +4120 The encoding for the remaining types of shape, defined in the 3GPP TS 23.032, shall be filled in in the Additional + +4121 Location Estimate parameter. + +#### 4122 7.6.11.11A GERAN Positioning Data + +4123 This parameter provides positioning data associated with a successful or unsuccessful location attempt for a target MS + +4124 described in 3GPP TS 49.031 [59a]. + +#### 4125 7.6.11.11B UTRAN Positioning Data + +4126 This parameter provides positioning data associated with a successful location attempt for a target MS as described in +4127 3GPP TS 25.413 [120]. It contains the positioningDataDiscriminator and positioningDataSet parts of the RANAP +4128 PositionData element only. + +#### 4129 7.6.11.11C GERAN GANSS Positioning Data + +4130 This parameter provides GANSS positioning data associated with a successful or unsuccessful location attempt for a +4131 target MS as described in 3GPP TS 49.031 [59a] if GANSS has been used. + +#### 4132 7.6.11.11D UTRAN GANSS Positioning Data + +4133 This parameter provides GANSS positioning data associated with a successful location attempt for a target MS as +4134 described in 3GPP TS 25.413 [120] if GANSS has been used. It contains the GANSS-PositioningDataSet part of the +4135 RANAP PositionData element only. + +#### 4136 7.6.11.11E UTRAN Additional Positioning Data + +4137 This parameter provides additional positioning data associated with a successful location attempt for a target MS as +4138 described in 3GPP TS 25.413 [120] if Additional Positioning has been used. It contains the Additional- +4139 PositioningDataSet part of the RANAP PositionData element only. + +#### 4140 7.6.11.11F UTRAN Barometric Pressure Measurement + +4141 This parameter provides barometric pressure measurement associated with a successful location attempt for a target MS +4142 as described in 3GPP TS 25.413 [120]. + +#### 4143 7.6.11.11G UTRAN Civic Address + +4144 This parameter provides civic address associated with a successful location attempt for a target MS as described in +4145 3GPP TS 25.413 [120]. + +#### 4146 7.6.11.12 Location Type + +4147 This parameter indicates the type of location estimate required by the LCS client. Possible location estimate types include: + +- 4148 - current location; +- 4149 - current or last known location; +- 4150 - initial location for an emergency services call; +- 4151 - deferred location event type; +- 4152 - notification verification only. + +#### 4153 7.6.11.13 NA-ESRD + +4154 This parameter only applies to location for an emergency services call in North America and gives the North American +4155 Emergency Services Routing Digits. + +#### 4156 7.6.11.14 NA-ESRK + +4157 This parameter only applies to location for an emergency services call in North America and gives the North American +4158 Emergency Services Routing Key. + +#### 4159 7.6.11.15 LCS Service Type Id + +4160 This parameter defines the LCS Service Type of the current positioning request. The possible values are defined in +4161 3GPP TS 22.071 [123] + +#### 4162 7.6.11.16 Privacy Override + +4163 This parameter indicates if MS privacy is overridden by the LCS client when the GMLC and VMSC/SGSN for an MT- +4164 LR are in the same country. + +#### 4165 7.6.11.17 Supported LCS Capability Sets + +4166 This parameter indicates which capability sets of LCS are supported in the VLR or SGSN. + +#### 4167 7.6.11.18 LCS Codeword + +4168 This parameter contains the codeword associated to current positioning request as described in 3GPP TS 23.271 [26a]. + +#### 4169 7.6.11.19 NA-ESRK Request + +4170 This parameter allows the MSC to indicate that it requires the GMLC to allocate a NA-ESRK based on the target MS +4171 location estimate. This parameter only applies to emergency services calls in North America. + +#### 4172 7.6.11.20 Supported GAD Shapes + +4173 This parameter indicates which of the shapes defined in 3GPP TS 23.032 are supported. If the parameter is not provided +4174 then the receiving node shall assume that the sending entity supports the following shapes: + +- 4175 - Ellipsoid point with uncertainty circle +- 4176 - Ellipsoid point with uncertainty ellipse +- 4177 - Ellipsoid point with altitude and uncertainty ellipsoid +- 4178 - Ellipsoid arc +- 4179 - Ellipsoid point + +#### 4180 7.6.11.21 Additional Location Estimate + +4181 This parameter gives an estimate of the location of an MS/UE in universal coordinates and the accuracy of the estimate. +4182 This parameter allows the location estimate to be expressed in any of the geographical shapes defined in 3GPP TS +4183 23.032 + +#### 4184 7.6.11.22 Cell Id Or SAI + +4185 For GERAN access, this parameter contains the Global Cell Identifier for the cell that the subscriber is currently +4186 attached to. For UTRAN access, this parameter contains the Service Area Identifier for the cell that the subscriber is +4187 currently attached to. + +#### 4188 7.6.11.23 LCS-Reference Number + +4189 This parameter represents a reference between a request and a response of a deferred mt-lr procedure as described in +4190 3GPP TS 23.271 [26a]. + +#### 4191 7.6.11.24 LCS Privacy Check + +4192 This parameter refers to the requested privacy check related actions (call/session unrelated and/or call/session related) +4193 from MSC or SGSN provided by H-GMLC. Possible requested actions are: + +- 4194 - positioning allowed without notifying the UE user; +- 4195 - positioning allowed with notification to the UE user; +- 4196 - positioning requires notification and verification by the UE user; positioning is allowed only if granted by the +4197 UE user or if there is no response to the notification; + +- 4198 - positioning requires notification and verification by the UE user; positioning is allowed only if granted by the +4199 UE user; +4200 - positioning not allowed. + +#### 4201 7.6.11.25 Additional LCS Capability Sets + +4202 This parameter indicates which capability sets of LCS are supported in the VLR or SGSN. + +#### 4203 7.6.11.26 Area Event Info + +4204 This parameter defines the requested deferred MT-LR area event information. The parameter consists of +4205 area definition, type of area event, occurrence info and minimum interval time. + +#### 4206 7.6.11.27 Velocity Estimate + +4207 This parameter gives an estimate of the velocity of an MS and the accuracy of the estimate. The estimate is expressed in +4208 terms of speed and bearing as defined by 3GPP TS 23.032 [122], and is composed of the velocity terms plus the +4209 encoding of the velocity itself. Only the encoding of the following velocity definitions shall be carried by the Velocity +4210 Estimate: + +- 4211 - Horizontal Velocity +- 4212 - Horizontal with Vertical Velocity +- 4213 - Horizontal Velocity with Uncertainty +- 4214 - Horizontal with Vertical Velocity and Uncertainty + +#### 4215 7.6.11.28 Accuracy Fulfilment Indicator + +4216 This parameter indicates the fulfilled accuracy of the positioning procedure. For details see 3GPP TS +4217 23.271 [26a]. + +#### 4218 7.6.11.29 MO-LR Short Circuit Indicator + +4219 This parameter indicates whether MO-LR short circuit feature is permitted. For details see 3GPP TS +4220 23.271 [26a]. + +#### 4221 7.6.11.30 Reporting PLMN List + +4222 This parameter provides a list of PLMNs in which subsequent periodic MO-LR TTTP requests will be +4223 made. For details see 3GPP TS 23.271 [26a]. + +#### 4224 7.6.11.31 Periodic LDR information + +4225 This parameter refers to the periodic reporting interval and reporting amount of the deferred periodic +4226 location. For details see 3GPP TS 23.271 [26a]. + +#### 4227 7.6.11.32 Sequence Number + +4228 This parameter refers to the number of the periodic location reports completed. The sequence number +4229 would be set to 1 in the first location report and increment by 1 for each new report. When the number +4230 reaches the reporting amount value, the H-GMLC (for a periodic MT-LR or a periodic MO-LR transfer to +4231 third party) will know the procedure is complete. For details see 3GPP TS 23.271 [26a]. + +#### 4232 7.6.12 Void + +4233 + +4234 **7.7 Representation of a list of a basic parameter in service-primitives** +4235 + +4236 In some service-primitives several instances of a basic parameter of clause 7.6 are required. In the service descriptions +4237 such cases will be represented as + +4238 + +| | +|-------------------| +| ParameterNameLIST | +|-------------------| + +4239 in the tables where ParameterName refers to one of the parameters defined in clause 7.6. This corresponds to the +4240 following construction rule: + +![Diagram showing the construction of lists. A horizontal line has a box labeled 'Parameter' in the center. Above this box, a line extends to the left and right, with a right-pointing arrowhead on the right side, indicating a list construction rule.](54159e6d8f5ecc73ad262758e3a60677_img.jpg) + +4241 + +Diagram showing the construction of lists. A horizontal line has a box labeled 'Parameter' in the center. Above this box, a line extends to the left and right, with a right-pointing arrowhead on the right side, indicating a list construction rule. + +4242 **Figure 7.7/1: Construction of Lists** + +4243 **8 Mobility services** + +4244 **8.1 Location management services** + +4245 **8.1.1 Void** + +4246 **8.1.1.1 Void** + +4247 **8.1.1.2 Void** + +4248 **8.1.1.3 Void** + +4249 **8.1.2 MAP\_UPDATE\_LOCATION service** + +4250 **8.1.2.1 Definition** + +4251 This service is used by the VLR to update the location information stored in the HLR. + +4252 This service is also used by an IWF that registers an MME as MSC for MT-SMS. + +4253 The MAP\_UPDATE\_LOCATION service is a confirmed service using the service primitives given in table 8.1/2. + +4254 **8.1.2.2 Service primitives** + +4255 **Table 8.1/2: MAP\_UPDATE\_LOCATION** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| MSC Address | M | M(=) | | | +| VLR number | M | M(=) | | | +| LMSI | U | C(=) | | | +| Supported CAMEL Phases | C | C(=) | | | +| SoLSA Support Indicator | C | C(=) | | | +| IST Support Indicator | C | C(=) | | | +| Super-Charger Supported in Serving Network Entity | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Supported LCS Capability Sets | C | C(=) | | | + +| | | | | | +|---------------------------------|---|------|---|------| +| Offered CAMEL 4 CSIs | C | C(=) | | | +| Inform Previous Network Entity | C | C(=) | | | +| CS LCS Not Supported by UE | C | C(=) | | | +| V-GMLC Address | U | C(=) | | | +| IMEISV | C | C(=) | | | +| Skip Subscriber Data Update | U | C(=) | | | +| Supported RAT Types Indicator | U | C(=) | | | +| Paging Area | U | C(=) | | | +| Restoration Indicator | U | C(=) | | | +| MTRF Supported | U | C(=) | | | +| Equivalent PLMN List | C | C(=) | | | +| MSISDN-less Operation Supported | C | C(=) | | | +| MME-Diameter-Address-For MT-SMS | C | C(=) | | | +| Reset-IDs Supported | C | C(=) | | | +| ADD Capability | | | U | C(=) | +| Paging Area Capability | | | U | C(=) | +| HLR number | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4256 + +### 4257 8.1.2.3 Parameter definitions and use + +#### 4258 Invoke Id + +4259 See definition in clause 7.6.1. + +#### 4260 IMSI + +4261 See definition in clause 7.6.2. + +#### 4262 MSC Address + +4263 See definition for MSC number in clause 7.6.2. The MSC address is used for short message delivery only and for each +4264 incoming call set-up attempt the MSRN will be requested from the VLR. + +#### 4265 VLR number + +4266 See definition in clause 7.6.2. + +#### 4267 LMSI + +4268 See definition in clause 7.6.2. It is an operator option to provide the LMSI from the VLR; it is mandatory for the HLR +4269 to support the LMSI handling procedures. + +#### 4270 Supported CAMEL Phases + +4271 This parameter indicates which phases of CAMEL are supported. Must be present if a CAMEL phase different from +4272 phase 1 is supported. Otherwise may be absent. + +#### 4273 HLR number + +4274 See definition in clause 7.6.2. The presence of this parameter is mandatory in case of successful HLR updating. + +#### 4275 SoLSA Support Indicator + +4276 This parameter is used by the VLR to indicate to the HLR in the Update Location indication that SoLSA is supported. If +4277 this parameter is not included in the Update Location indication and the Subscriber is marked as only allowed to roam +4278 in Subscribed LSAs, then the HLR shall reject the roaming and indicate to the VLR that roaming is not allowed to that +4279 Subscriber in the VLR. + +4280 This SoLSA Support Indicator shall be stored by the HLR per VLR where there are Subscribers roaming. If a +4281 Subscriber is marked as only allowed to roam in Subscribed LSAs while roaming in a VLR and no SoLSA Support +4282 indicator is stored for that VLR, the location status of that Subscriber shall be set to Restricted. + +#### 4283 IST Support Indicator + +4284 This parameter is used to indicate to the HLR that the VMSC supports basic IST functionality, that is, the VMSC is able +4285 to terminate the Subscriber Call Activity that originated the IST Alert when it receives the IST alert response indicating +4286 that the call(s) shall be terminated. If this parameter is not included in the Update Location indication and the +4287 Subscriber is marked as an IST Subscriber, then the HLR may limit the service for the subscriber (by inducing an +4288 Operator Determined barring of Roaming, Incoming or Outgoing calls), or allow service assuming the associated risk of +4289 not having the basic IST mechanism available. + +4290 This parameter can also indicate that the VMSC supports the IST Command service, including the ability to terminate +4291 all calls being carried for the identified subscriber by using the IMSI as a key. If this additional capability is not +4292 included in the Update Location indication and the HLR supports the IST Command capability, then the HLR may limit +4293 the service for the subscriber (by inducing an Operator Determined barring of Roaming, Incoming or Outgoing calls), or +4294 allow service assuming the associated risk of not having the IST Command mechanism available. + +4295 Long FTN Supported + +4296 This parameter indicates that the VLR supports Long Forwarded-to Numbers. + +4297 Super-Charger Supported in Serving Network Entity + +4298 This parameter is used by the VLR to indicate to the HLR that the VLR supports the Super-Charger functionality and +4299 whether subscription data has been retained by the VLR. If subscription data has been retained by the VLR the age +4300 indicator shall be included. Otherwise the VLR shall indicate that subscriber data is required. + +4301 If this parameter is absent then the VLR does not support the Super-Charger functionality. + +4302 Supported LCS Capability Sets + +4303 This parameter indicates, if present, the capability sets of LCS which are supported. If the parameter is sent but no +4304 capability set is marked as supported then the VLR does not support LCS at all. + +4305 If this parameter is absent then the VLR may support at most LCS capability set 1, that is LCS Release98 or Release99 +4306 version. + +4307 Offered CAMEL 4 CSIs + +4308 This parameter indicates the CAMEL phase 4 CSIs offered in the VMSC/VLR (see clause 7.6.3.36D). + +4309 Inform Previous Network Entity + +4310 This parameter is used by the VLR to ask the HLR to inform the previous network entity about the update by sending +4311 the previous network entity a Cancel Location message. It is used if Super-Charger is supported in the network and +4312 either the serving network entity has not been able to inform the previous network entity that MS has moved (i.e. if it +4313 has not sent Send Identification to the previous serving entity) or the MTRF Supported flag is set in the MAP\_UPDATE +4314 LOCATION request. + +4315 CS LCS Not Supported by UE + +4316 See definition in clause 7.6.11. + +4317 V-GMLC address + +4318 See definition in clause 7.6.2. + +4319 IMEISV + +4320 For definition of the parameter see clause 7.6.2. For the use of this parameter see 3GPP TS 23.012. IMEISV shall be +4321 present if ADD function is supported and a new IMEISV is to be notified to the HLR (The functional requirements for +4322 the presence of IMEISV due to ADD are described in 3GPP TS 22.101 clause 7.4). + +4323 Skip Subscriber Data Update + +4324 The presence of the parameter is optional and if present it indicates that the service is solely used to inform the HLR +4325 about change of IMEISV or Paging Area. The parameter is used to optimise signalling load during Location Update +4326 procedure. + +4327 Supported RAT Types Indicator + +4328 This parameter indicates, if present, which access technologies (e.g. GERAN and / or UTRAN) are served by the +4329 MSC/VLR (see clause 7.6.3) + +4330 Paging Area + +4331 This parameter indicates, if present, the paging area where the MS is currently located (see clause 7.6.5.18) + +4332 Restoration Indicator + +4333 This parameter indicates, if present, that the HLR shall send in the MAP-INSERT-SUBSCRIBER-DATA the MME +4334 Name if the subscriber is registered to EPS, or the SGSN Number if available and if the subscriber is registered to +4335 GPRS. The VLR may set this indicator during a CSFB mobile originated call if the VLR performs an implicit location +4336 update (see 3GPP TS 23.272 [143]). + +4337 MTRF Supported + +4338 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +4339 Equivalent PLMN List + +4340 This parameter indicates the equivalent PLMN list of which the VLR requests the corresponding CSG Subscription +4341 data. + +4342 MSISDN-less Operation Supported + +4343 See clause 3.6.1.5 of 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +4344 MME-Diameter-Address-For-MT-SMS + +4345 This parameter may be sent by an IWF that registers an MME for MT-SMS. The MME-Diameter-Address-For-MT- +4346 SMS may be stored in the HLR and may be sent in SMS interrogation responses to SMS-GMSCs. + +4347 Reset-IDs Supported + +4348 This parameter indicates, if present, the support of Reset-IDs by the MSC. + +4349 ADD Capability + +4350 This parameter indicates, if present, the support of ADD function by the HLR. + +4351 Paging Area Capability + +4352 This parameter indicates, if present, the support of Paging Area function by the HLR. The HLR shall report the same +4353 capability for all subscribers. + +4354 User error + +4355 In case of unsuccessful updating, an error cause shall be returned by the HLR. The following error causes defined in +4356 clause 7.6.1 may be used, depending on the nature of the fault: + +4357 - unknown subscriber; + +4358 - roaming not allowed; + +4359 This cause will be sent if the MS is not allowed to roam into the PLMN indicated by the VLR number. The +4360 cause is qualified by the roaming restriction reason "PLMN Not Allowed", "Supported RAT Types Not +4361 Allowed" or "Operator Determined Barring". If no qualification is received (HLR with MAP Version 1), +4362 "PLMN Not Allowed" is taken as default. + +4363 This cause shall be used when the HLR rejects a MAP Update Location request received for an MSISDN- +4364 less subscription from a VLR not supporting MSISDN-less operation (see clause 3.6.1.5 of 3GPP TS 23.012 +4365 [23]). + +4366 - system failure; + +4367 - unexpected data value. + +4368 Provider error + +4369 For definition of provider errors see clause 7.6.1. + +### 4370 8.1.3 MAP\_CANCEL\_LOCATION service + +#### 4371 8.1.3.1 Definition + +4372 This service is used between HLR and VLR to delete a subscriber record from the VLR. It may be invoked +4373 automatically when an MS moves from one VLR area to another, to remove the subscriber record from the old VLR, or +4374 by the HLR operator to enforce a location updating from the VLR to the HLR, e.g. on withdrawal of a subscription. + +4375 Also this service is used between HLR and SGSN to delete a subscriber record from the SGSN. It may be invoked +4376 automatically when an MS moves from one SGSN area to another, to remove the subscriber record from the old SGSN, +4377 or by the HLR operator to enforce a location updating from the SGSN to the HLR. This service is also used to request +4378 the SGSN to indicate to the MS to initiate an immediate re-attach procedure. + +4379 In an EPS this service is used between HSS and IWF and between IWF and IWF to delete the subscriber record from +4380 the MME or SGSN or to release bearer resources without deleting the subscriber record. This service is also used to +4381 request the MME or SGSN to indicate to the UE to initiate an immediate re-attach procedure. + +4382 The MAP\_CANCEL\_LOCATION service is a confirmed service using the primitives defined in table 8.1/3. + +#### 4383 8.1.3.2 Service primitives + +4384 **Table 8.1/3: MAP\_CANCEL\_LOCATION** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| LMSI | C | C(=) | | | +| Cancellation Type | C | C(=) | | | +| MTRF Supported And Authorized | U | C(=) | | | +| MTRF Supported And Not Authorized | U | C(=) | | | +| New MSC Number | U | C(=) | | | +| New VLR Number | U | C(=) | | | +| New LMSI | U | C(=) | | | +| Reattach Required | U | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4385 + +#### 4386 8.1.3.3 Parameter definitions and use + +4387 Invoke Id + +4388 See definition in clause 7.6.1. + +4389 IMSI + +4390 See definition in clause 7.6.2. + +4391 LMSI + +4392 See definition in clause 7.6.2. The LMSI shall be included if it has been received from VLR. LMSI is not applicable +4393 between SGSN and HLR. + +4394 Value 0000 0000 can be used to indicate that the LMSI is not in use. + +4395 Cancellation Type + +4396 See definition in clause 7.6.3. The presence of this parameter is mandatory when the Cancel Location is sent to the +4397 SGSN or IWF. The parameter may also be sent during an inter-VLR location update If the VLR receives this parameter +4398 and does not understand it the VLR shall ignore it and should by default assume an Update procedure. If the SGSN +4399 receives this parameter indicating initial attach procedure, the SGSN shall do as specified in 3GPP TS 23.060 [104], and +4400 shall not delete the subscription data. + +4401 MTRF Supported And Authorized + +4402 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +4403 MTRF Supported And Not Authorized + +4404 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +4405 New MSC Number + +4406 This parameter refers to the E.164 address of the new VMSC. The use and conditions of presence of this parameter are +4407 specified in 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23]. This parameter shall be present if the MTRF Supported +4408 And Authorized flag is present. + +4409 New VLR Number + +4410 This parameter contains the new VLR Number. See definition in clause 7.6.2. The use and conditions of presence of +4411 this parameter are specified in 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23]. This parameter shall be present if the +4412 MTRF Supported And Authorized flag is present. + +4413 New LMSI + +4414 See definition in clause 7.6.2 for LMSI. This parameter shall be present if the MTRF Supported And Authorized flag is +4415 present and the HLR has received the LMSI in Update Location from the new VLR. + +4416 Reattach Required + +4417 When present and when the Cancellation Type indicates a subscription withdraw, this parameter indicates that the +4418 MME (informed via the IWF) or the SGSN shall delete the subscription data and request the UE or MS to initiate an +4419 immediate re-attach procedure as described in 3GPP TS 23.401 [145] and in 3GPP TS 23.060 [12]. + +4420 User error + +4421 If the cancellation fails, an error cause is to be returned by the VLR or by the SGSN or IWF. One of the following error +4422 causes defined in clause 7.6.1 shall be used: + +- 4423 - unexpected data value; +- 4424 - data missing. + +4425 Provider error + +4426 For definition of provider errors see clause 7.6.1. + +## 4427 8.1.4 MAP\_SEND\_IDENTIFICATION service + +### 4428 8.1.4.1 Definition + +4429 The MAP\_SEND\_IDENTIFICATION service is used between a VLR and a previous VLR to retrieve IMSI and +4430 authentication data for a subscriber registering afresh in that VLR. + +4431 It may also be used to send the MSC number from a VLR to a previous VLR. + +4432 The MAP\_SEND\_IDENTIFICATION service is a confirmed service using the service primitives defined in table 8.1/4. + +### 4433 8.1.4.2 Service primitives + +4434 **Table 8.1/4: MAP\_SEND\_IDENTIFICATION** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| TMSI | M | M(=) | | | +| Number of requested vectors | M | M(=) | | | +| Segmentation prohibited indicator | C | C(=) | | | +| MSC Number | U | C(=) | | | +| Previous Location Area Id | U | C(=) | | | +| Hop Counter | U | C(=) | | | +| MTRF Supported | U | C(=) | | | +| VLR Number | U | C(=) | | | +| New LMSI | U | C(=) | | | +| IMSI | | | C | C(=) | +| Authentication set | | | U | C(=) | +| Current Security Context | | | U | C(=) | +| MT call pending flag | | | U | C(=) | +| Last used LTE PLMN ID | | | U | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4435 + +#### 4436 8.1.4.3 Parameter definitions and use + +##### 4437 Invoke Id + +4438 See definition in clause 7.6.1. + +##### 4439 TMSI + +4440 See definition in clause 7.6.2. + +4441 If multiple service requests are present in a dialogue then this parameter shall be present in every service request. + +##### 4442 Number of requested vectors + +4443 A number indicating how many authentication vectors the new VLR is prepared to receive. The previous VLR shall not +4444 return more vectors than indicated by this parameter. + +4445 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +4446 dialogue then this parameter shall not be present in any service request other than the first one + +##### 4447 Segmentation prohibited indicator + +4448 This parameter indicates if the new VLR or SGSN allows segmentation of the response at MAP user level. + +4449 This parameter may be present only in the first request of the dialogue. + +##### 4450 IMSI + +4451 See definition in clause 7.6.2. The IMSI is to be returned if the service succeeds. + +4452 If multiple service requests are present in a dialogue and the service succeeds then this parameter shall not be present in +4453 any service response other than the first one + +##### 4454 MSC Number + +4455 This is the ISDN number assigned to the MSC currently serving the MS. This parameter shall be present if the MTRF +4456 Supported flag is present. + +##### 4457 Previous Location Area Id + +4458 See definition in clause 7.6.2. Together with the TMSI the Previous Location Area Id can be used to derive the IMSI. + +4459 Authentication set + +4460 See definition in clause 7.6.7. If the service succeeds a list of up to five authentication sets is returned, if there are any +4461 available. + +4462 Current Security Context + +4463 See definition in clause 7.6.7. If the service succeeds, a list of either GSM or UMTS Security Context parameters can be +4464 returned. + +4465 This parameter shall not be included if the Key Status associated to the current security context indicates this is a new +4466 keyset that has not been used yet. If this parameter is present in the message, the new VLR shall consider that the keyset +4467 has already been used (i.e. the key status is "old"). + +4468 MT call pending flag + +4469 This flag indicates by its presence that there is a Mobile Terminating call pending in the old MSC/VLR. See 3GPP TS +4470 23.018 [97] for the use of this parameter and the conditions for its presence. + +4471 Hop Counter + +4472 For the use of this parameter see 3GPP TS 23.012 [23]. + +4473 MTRF Supported + +4474 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +4475 VLR Number + +4476 This is the ISDN number assigned to the VLR currently serving the MS. See definition in clause 7.6.2. The use and +4477 conditions of presence of this parameter are specified in 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23]. This +4478 parameter shall be present if the MTRF Supported flag is present. + +4479 New LMSI + +4480 See definition in clause 7.6.2 for LMSI. This parameter may be present if the MTRF Supported flag is present. + +4481 Last used LTE PLMN ID + +4482 See 3GPP TS 23.272 [143] for the use of this parameter and the conditions for its presence. + +4483 User error + +4484 This parameter is mandatory if the service fails. The following error cause defined in clause 7.6.1 may be used, +4485 depending on the nature of the fault: + +4486 - unidentified subscriber. + +4487 Provider error + +4488 For definition of provider errors see clause 7.6.1. + +4489 **8.1.5 Void** + +4490 **8.1.5.1 Void** + +4491 **8.1.5.2 Void** + +4492 **8.1.5.3 Void** + +4493 **8.1.6 MAP\_PURGE\_MS service** + +4494 **8.1.6.1 Definition** + +4495 This service is used between the VLR and the HLR to cause the HLR to mark its data for an MS so that any request for + 4496 routing information for a mobile terminated call or a mobile terminated short message will be treated as if the MS is not + 4497 reachable. It is invoked when the subscriber record for the MS is to be deleted in the VLR, either by MMI interaction or + 4498 automatically, e.g. because the MS has been inactive for several days. This service shall not be used if both the VLR + 4499 and HLR support the Super-Charger functionality. + +4500 Also this service is used between the SGSN and the HLR to cause the HLR to mark its data for an MS so that any + 4501 request for routing information for a mobile terminated short message or a network requested PDP-context activation + 4502 will be treated as if the MS is not reachable. It is invoked when the subscriber record for the MS is to be deleted in the + 4503 SGSN, either by MMI interaction or automatically, e.g. because the MS has been inactive for several days. This service + 4504 shall not be used if both the SGSN and HLR support the Super-Charger functionality. + +4505 In an EPS this service is used between IWF and IWF and between IWF and HSS. + +4506 The MAP\_PURGE\_MS service is a confirmed service using the primitives defined in table 8.1/6. + +### 4507 8.1.6.2 Service primitives + +4508 + +**Table 8.1/6: MAP\_PURGE\_MS** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| VLR number | C | C(=) | | | +| Freeze TMSI | | | C | C(=) | +| Freeze P-TMSI | | | C | C(=) | +| Freeze M-TMSI | | | C | C(=) | +| SGSN number | C | C(=) | | | +| Last known location | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4509 + +### 4510 8.1.6.3 Parameter definitions and use + +4511 Invoke ID + +4512 See definition in clause 7.6.1. + +4513 IMSI + +4514 See definition in clause 7.6.2. + +4515 VLR number + +4516 Shall be present if the sender is VLR. See definition in clause 7.6.2. + +4517 SGSN number + +4518 Shall be present if the sender is SGSN. See definition in clause 7.6.2. + +4519 In an EPS, this parameter may contain the IWF number. + +4520 Freeze TMSI + +4521 This parameter is sent to the VLR to indicate that the TMSI has to be frozen. It shall be present if the received VLR + 4522 number matches the stored VLR number. + +4523 Freeze P-TMSI + +4524 This parameter is sent to the SGSN to indicate that the P-TMSI has to be frozen. It shall be present if the received + 4525 SGSN number matches the stored SGSN number. + +4526 Freeze M-TMSI + +4527 This parameter is sent to the IWF to indicate that the M-TMSI has to be frozen. It shall be present if the received node + 4528 number matches the stored IWF number. + +4529 Last known location + +4530 This parameter contains the last known location of the purged UE. + +4531 User error + +4532 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 4533 - Data Missing; +- 4534 - Unexpected Data Value; +- 4535 - Unknown Subscriber. + +4536 Provider error + +4537 See definition of provider errors in clause 7.6.1. + +## 4538 8.1.7 MAP\_UPDATE\_GPRS\_LOCATION service + +### 4539 8.1.7.1 Definition + +4540 This service is used by the SGSN to update the location information stored in the HLR. + +4541 In an EPS, this service is used between IWF and IWF and between IWF and HSS. + +4542 The MAP\_UPDATE\_GPRS\_LOCATION service is a confirmed service using the service primitives given in + 4543 table 8.1/7. + +### 4544 8.1.7.2 Service primitives + +4545 **Table 8.1/7: MAP\_UPDATE\_GPRS\_LOCATION** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| SGSN number | M | M(=) | | | +| SGSN address | M | M(=) | | | +| Supported CAMEL Phases | C | C(=) | | | +| SoLSA Support Indicator | C | C(=) | | | +| Super-Charger Supported in Serving Network Entity | C | C(=) | | | +| GPRS enhancements support indicator | C | C(=) | | | +| Supported LCS Capability Sets | C | C(=) | | | +| Offered CAMEL 4 CSIs | C | C(=) | | | +| Inform Previous Network Entity | C | C(=) | | | +| PS LCS Not Supported by UE | C | C(=) | | | +| V-GMLC Address | U | C(=) | | | +| Call barring support indicator | C | C(=) | | | +| IMEISV | C | C(=) | | | +| Skip Subscriber Data Update | U | C(=) | | | +| Supported RAT Types Indicator | U | C(=) | | | +| EPS Info | C | C(=) | | | +| Serving Node Type Indicator | C | C(=) | | | +| Supported Features | U | C(=) | | | +| Used RAT Type | U | C(=) | | | +| GPRS Subscription Data not needed Indicator | C | C(=) | | | +| EPS Subscription Data Not Needed Indicator | C | C(=) | | | +| Node-Type-Indicator | U | C(=) | | | +| Area Restricted Indicator | C | C(=) | | | +| UE Reachable Indicator | C | C(=) | | | +| T-ADS Data Retrieval Support Indicator | C | C(=) | | | + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------------------------------------------|---------|------------|----------|---------| +| Homogeneous Support Of IMS Voice Over PS Sessions | C | C(=) | | | +| Update of Homogeneous Support Of IMS Voice Over PS Sessions | C | C(=) | | | +| UE SRVCC Capability | C | C(=) | | | +| Equivalent PLMN List | C | C(=) | | | +| MME Number for MT SMS | C | C(=) | | | +| SMS-Only | C | C(=) | | | +| SMS Register Request | C | C(=) | | | +| Removal of MME Registration for SMS | C | C(=) | | | +| MSISDN-less Operation Supported | C | C(=) | | | +| SGSN Name | C | C(=) | | | +| SGSN Realm | C | C(=) | | | +| Lgd Support Indicator | C | C(=) | | | +| Adjacent-PLMNs | C | C(=) | | | +| Reset-IDs Supported | C | C(=) | | | +| ADD Capability | | | U | C(=) | +| SGSN-MME Separation Support Indicator | | | C | C(=) | +| HLR number | | | C | C(=) | +| MME Registered for SMS | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4546 + +### 4547 8.1.7.3 Parameter definitions and use + +#### 4548 Invoke Id + +4549 See definition in clause 7.6.1. + +#### 4550 IMSI + +4551 See definition in clause 7.6.2. + +#### 4552 SGSN number + +4553 See definition in clause 7.6.2. + +4554 In an EPS, this parameter is populated with an IWF number if received from an IWF. + +#### 4555 SGSN address + +4556 See definition in clause 7.6.2. + +4557 In an EPS, this parameter is populated with an IWF address if received from an IWF. + +#### 4558 Supported CAMEL Phases + +4559 This parameter indicates which phases of CAMEL are supported. The SGSN can only support CAMEL phase 3 or greater. + +#### 4561 SoLSA Support Indicator + +4562 This parameter is used by the SGSN to indicate to the HLR in the Update GPRS Location indication that SoLSA is +4563 supported. If this parameter is not included in the Update GPRS Location indication and the Subscriber is marked as +4564 only allowed to roam in Subscribed LSAs, then the HLR shall reject the roaming and indicate to the SGSN that roaming +4565 is not allowed to that Subscriber in the SGSN. + +4566 This SoLSA Support Indicator shall be stored by the HLR per SGSN where there are Subscribers roaming. If a +4567 Subscriber is marked as only allowed to roam in Subscribed LSAs while roaming in a SGSN and no SoLSA Support +4568 indicator is stored for that SGSN, the location status of that Subscriber has to be set to Restricted. + +#### 4569 Super-Charger Supported in Serving Network Entity + +4570 This parameter is used by the SGSN to indicate to the HLR that the SGSN supports the Super-Charger functionality and +4571 whether subscription data has been retained by the SGSN. If subscription data has been retained by the SGSN the age +4572 indicator shall be included. Otherwise the SGSN shall indicate that subscriber data is required. + +4573 If this parameter is absent then the SGSN does not support the Super-Charger functionality. + +4574 GPRS enhancements support indicator + +4575 This parameter is used by the SGSN to indicate to the HLR in the Update GPRS Location indication that GPRS +4576 enhancements are supported. If this parameter is included in the Update GPRS Location indication the HLR may send +4577 the extension QoS parameter in the PDP contexts to the SGSN. The HLR may send the extension-2 QoS, the +4578 extension-3 QoS and the extension-4 QoS parameters with the extension QoS parameter. + +4579 HLR number + +4580 See definition in clause 7.6.2. The presence of this parameter is mandatory in case of successful HLR updating. + +4581 Supported LCS Capability Sets + +4582 This parameter indicates, if present, the capability sets of LCS which are supported. If the parameter is sent but no +4583 capability set is marked as supported then the SGSN does not support LCS at all. + +4584 The SGSN is not allowed to indicate support for LCS capability set 1. + +4585 If this parameter is absent then the SGSN does not support LCS at all. + +4586 Offered CAMEL 4 CSIs + +4587 This parameter indicates the CAMEL phase 4 CSIs offered in the SGSN (see clause 7.6.3.36D). + +4588 Inform Previous Network Entity + +4589 This parameter is used by the SGSN to ask the HLR to inform the previous network entity about the update by sending +4590 the previous network entity a Cancel Location message. It is used in case Super-Charger is supported in the +4591 network and the serving network entity has not been able to inform the previous network entity that MS has moved, that +4592 is if it has not sent SGSN Context Request to the previous serving entity. + +4593 PS LCS Not Supported by UE + +4594 See definition in clause 7.6.11. + +4595 V-GMLC address + +4596 See definition in clause 7.6.2. + +4597 Call Barring support indicator + +4598 See definition in clause 7.6.3.92. + +4599 IMEISV + +4600 For definition of the parameter see clause 7.6.2. For the use of this parameter see 3GPP TS 23.060. IMEISV shall be +4601 present if ADD function is supported and the IMEISV is new in SGSN (The functional requirements for the presence of +4602 IMEISV due to ADD are described in 3GPP TS 22.101 clause 7.4). + +4603 Skip Subscriber Data Update + +4604 The presence of the parameter is optional and if present it indicates that subscriber data download during the +4605 updateGprsLocation procedure may be skipped by the HLR e.g. because the service is solely used to inform the HLR +4606 about change of IMEISV. The parameter is used to optimise signalling load during Location Update procedure. + +4607 Supported RAT Types Indicator + +4608 This parameter indicates, if present, which access technologies (e.g. GERAN and/or UTRAN and/or E-UTRAN) are +4609 served by the SGSN or MME (see clause 7.6.3) + +4610 EPS Info + +4611 This parameter may indicate that the MME or SGSN has selected a new PDN GW for an APN. If so, the HSS shall skip +4612 subscriber data update (insert subscriber data) and only note the new PDN GW. + +4613 Otherwise this parameter may indicate the appropriate instruction to be performed by the HSS which is one or more of + +- 4614 a) Update Location; i.e. send CancelLocation to the old MME and replace the stored MME id (if Serving Node +4615 Type Indicator is present and the stored MME id is different from the received MME id), or send +4616 CancelLocation to the old SGSN and replace the stored SGSN id (if Serving Node Type Indicator is absent and +4617 the stored SGSN id is different from the received SGSN id); +- 4618 b) Cancel SGSN; i.e. send CancelLocation to the SGSN and delete the stored SGSN id. +- 4619 c) Initial Attach; i.e. send CancelLocation to the MME (if Serving Node Type Indicator is absent) or to the SGSN +4620 (if Serving Node Type Indicator is present) with cancellation type set to "initial attach procedure" + +#### 4621 Serving Node Type Indicator + +4622 This parameter indicates by its presence that the subscriber's serving node is an MME (which is either stand alone or +4623 combined with an SGSN) and it indicates by its absence that the subscriber's serving node is an SGSN (which is either +4624 stand alone or combined with an MME). + +#### 4625 Supported Features + +4626 This parameter shall be used by an IWF to forward feature support indications as received from the MME or SGSN via +4627 S6a/S6d. It shall also be used by the SGSN to indicate support of the Dedicated Core Network functionality to the HLR. + +#### 4628 Used RAT Type + +4629 This parameter may indicate the RAT type currently used by the serving node. + +#### 4630 GPRS Subscription Data not needed Indicator + +4631 This parameter indicates by its presence that the SGSN (or MME/IWF) does not request GPRS Subscription Data in +4632 addition to EPS Subscription Data. + +#### 4633 EPS Subscription Data Not Needed Indicator + +4634 This parameter indicates by its presence that the SGSN does not request EPS Subscription Data in addition to GPRS +4635 Subscription Data. + +4636 NOTE: The indicator is only applicable to an SGSN which only supports Gn and Gp interfaces and does not +4637 support S4 interface. + +#### 4638 Node-Type Indicator + +4639 This parameter indicates by its presence that the requesting node is a combined MME/SGSN. Absence of this Indicator +4640 indicates that the requesting node is a single MME or SGSN. + +4641 When Node-Type Indicator is absent and Serving Node Type Indicator is present, the HSS may skip checking +4642 SMS/LCS supported features and skip the download of SMS/LCS-related subscription data to a standalone MME. + +#### 4643 Area Restricted Indicator + +4644 This parameter indicates by its presence that the network node area is restricted due to regional subscription. This +4645 parameter is used by the IWF only. + +#### 4646 UE-Reachable Indicator + +4647 This parameter indicates by its presence that the UE is reachable. + +4648 NOTE: In general any UpdateGPRS-Location request message (with or without UE-Reachable Indicator) +4649 implicitly conveys the information that the UE is now reachable. + +4650 This explicit indicator shall be set only when UpdateGPRS-Location is used for the only and no other purpose than +4651 indicating UE reachability. The HLR shall skip subscriber data downloading and any mobility management +4652 functionality other than reporting the UE's reachability to relevant core network entities. + +4653 T-ADS Data Retrieval Support Indicator + +4654 This parameter indicates by its presence that the SGSN supports retrieval of T-ADS data with the Provide-Subscriber- +4655 Info service. + +4656 Homogeneous Support Of IMS Voice Over PS Sessions + +4657 This parameter when present indicates that IMS voice over PS sessions is homogeneously supported in the complete +4658 SGSN area or that IMS voice over PS sessions is homogeneously not supported in the complete SGSN area. + +4659 Update of Homogeneous Support Of IMS Voice Over PS Sessions + +4660 This parameter when present indicates that Homogeneous Support of IMS Voice Over PS Sessions is updated. If the +4661 Homogeneous Support of IMS Voice Over PS Session is not present, the value of the Homogeneous Support of IMS +4662 Voice Over PS Sessions shall be updated as unknown to the serving node. + +4663 UE SRVCC Capability + +4664 See definition in clause 7.6.3.99. + +4665 Equivalent PLMN List + +4666 This parameter indicates the equivalent PLMN list of which the MME/SGSN requests the corresponding CSG +4667 Subscription data. + +4668 MME Number for MT SMS + +4669 This parameter contains the ISDN number of the MME allocated for MT SMS (see 3GPP TS 23.003 [17]). It is present +4670 when the MME requests to be registered for SMS. + +4671 SMS-Only + +4672 This parameter indicates to the HSS that the UE needs only PS domain services and SMS services. + +4673 SMS Register Request + +4674 This parameter indicates to the HSS that if the MME (via IWF) needs to be registered for SMS, prefers not to be +4675 registered for SMS or has no preference to be registered for SMS, see 3GPP TS 23.272 [143]. + +4676 This parameter indicates to the HSS that if the SGSN needs to be registered for SMS, prefers not to be registered for +4677 SMS or has no preference to be registered for SMS, see 3GPP TS 23.060 [104]. + +4678 Removal of MME Registration for SMS + +4679 This parameter indicates by its presence that the MME requests to remove its registration for SMS. + +4680 MSISDN-less Operation Supported + +4681 This parameter indicates by its presence that the SGSN supports MSISDN-less operation (see clause 5.3.17 of 3GPP TS +4682 23.060 [23]). An SGSN which supports MSISDN-less operation shall set this parameter. + +4683 SGSN Name + +4684 See definition in clause 7.6.2. This parameter is provided in a request when the serving node is an SGSN and the SGSN +4685 supports Lgd interface for LCS and/or Gdd interface for SMS. + +4686 SGSN Realm + +4687 See definition in clause 7.6.2. This parameter is provided in a request when the serving node is an SGSN and the SGSN +4688 supports Lgd interface for LCS and/or Gdd interface for SMS. + +4689 Lgd Support Indicator + +4690 This parameter, by its presence, indicates to the HSS that the SGSN supports Lgd interface for LCS. When absent the +4691 SGSN supports only Lg interface for LCS, if LCS is supported. + +4692 Adjacent PLMNs + +4693 This parameter indicates the list of PLMNs where an UE served by the SGSN is likely to make a handover from the +4694 PLMN where the SGSN is located. This list is statically configured by the operator in the SGSN, according to the +4695 geographical disposition of the different PLMNs in that area, the roaming agreements, etc... + +4696 Reset-IDs Supported + +4697 This parameter indicates, if present, the support of Reset-IDs by the SGSN. + +4698 ADD Capability + +4699 This parameter indicates, if present, the support of ADD function by the HLR. + +4700 SGSN-MME Separation Support Indicator + +4701 This parameter indicates by its presence that the HSS separately stores SGSN Id and MME Id. A combined +4702 MME/SGSN shall not send Update-GPRS-Location at intra node inter RAT routing area update if a Separation +4703 Indicator was not received previously. + +4704 MME Registered for SMS + +4705 This parameter indicates by its presence that the HSS has registered the MME for SMS. + +4706 User error + +4707 In case of unsuccessful updating, an error cause shall be returned by the HLR. The following error causes defined in +4708 clause 7.6.1 may be used, depending on the nature of the fault: + +4709 - unknown subscriber; + +4710 - roaming not allowed. + +4711 This cause will be sent if the MS is not allowed to roam into the PLMN indicated by the SGSN number. The +4712 cause is qualified by the roaming restriction reason "PLMN Not Allowed", "Supported RAT Types Not +4713 Allowed" or "Operator Determined Barring". + +4714 This cause shall be used when the HLR rejects a MAP Update Gprs Location request received for an +4715 MSISDN-less subscription from a SGSN not supporting MSISDN-less operation. + +4716 - system failure; + +4717 - unexpected data value. + +4718 The diagnostic in the Unknown Subscriber may indicate "Imsi Unknown" or "Gprs or EPS Subscription Unknown". + +4719 Provider error + +4720 For definition of provider errors see clause 7.6.1. + +## 4721 8.1.8 MAP-NOTE-MM-EVENT + +### 4722 8.1.8.1 Definition + +4723 This service is used between the VLR and the gsmSCF or between the SGSN and the gsmSCF when a mobility +4724 management event for a subscriber has been processed successfully, that subscriber is provisioned with M-CSI or MG- +4725 CSI and the relevant mobility management event is marked for reporting. + +4726 This service is also used between the VLR and the Presence Network Agent or between the SGSN and the Presence +4727 Network Agent to notify the Presence Network Agent when a mobility management event for a subscriber has been +4728 processed successfully, that subscriber is provisioned with M-CSI or MG-CSI and the relevant mobility management +4729 event is marked for reporting (see 3GPP TS 23.141 [128]). + +### 4730 8.1.8.2 Service primitives + +4731 The service primitives are shown in table 8.1/8. + +4732 + +**Table 8.1/8: MAP\_NOTE\_MM\_EVENT parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Event Met | M | M(=) | | | +| Service Key | M | M(=) | | | +| IMSI | M | M(=) | | | +| Basic MSISDN | M | M(=) | | | +| Location Information for GPRS | C | C(=) | | | +| Location Information | C | C(=) | | | +| LSA Identity | C | C(=) | | | +| Supported CAMEL Phases | M | M(=) | | | +| Offered CAMEL 4 Functionalities | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4733 + +### 4734 8.1.8.3 Parameter use + +4735 Event Met + +4736 This parameter indicates the mobility management event that has lead to the notification. It shall have one of the + 4737 following values for a mobility management event reported by the VLR: + +- 4738 - Location update in the same VLR service area; +- 4739 - Location update to another VLR service area; +- 4740 - IMSI attach; +- 4741 - MS initiated IMSI detach (explicit detach); +- 4742 - Network initiated IMSI detach (implicit detach). + +4743 It shall have one of the following values for a mobility management event reported by the SGSN: + +- 4744 - Routeing area update in the same SGSN service area; +- 4745 - Routeing area update to another SGSN service area; +- 4746 - GPRS attach; +- 4747 - MS initiated GPRS detach; +- 4748 - Network initiated GPRS detach; +- 4749 - Network initiated transfer to the "not reachable for paging" state. + +4750 Service Key + +4751 See clause 7.6.x. + +4752 IMSI + +4753 See clause 7.6.x. + +4754 Basic MSISDN + +4755 See clause 7.6.x. + +4756 Location Information + +4757 See clause 7.6.2.30. This information shall be sent when the event is reported by a VLR, if available. If the event is + 4758 reported as part of an SGs location update procedure, this information shall include the LAI and the Location + 4759 Information for EPS if available. + +4760 Location Information for GPRS + +4761 See clause 7.6.2.30a. This information shall be sent when the event is reported by an SGSN, if available. + +4762 LSA Identity + +4763 See clause 7.6.x. This information shall be sent, if available. + +4764 Supported CAMEL Phases + +4765 See clause 7.6.x. This information shall always be sent. + +4766 Offered CAMEL 4 Functionalities + +4767 This parameter indicates the CAMEL phase 4 functionalities offered by the sending entity, VMSC/VLR or SGSN (see +4768 clause 7.6.3.36G). + +4769 User error + +4770 This parameter is sent by the receiving entity when an error is detected. It shall have one of the following values: + +- 4771 - Data Missing; +- 4772 - Unexpected Data Value; +- 4773 - Unknown Subscriber; +- 4774 - MM-EventNotSupported. + +4775 Provider error + +4776 This is defined in clause 7.6.1. + +## 4777 8.1.9 MAP\_UPDATE\_VCSG\_LOCATION service + +### 4778 8.1.9.1 Definition + +4779 This procedure is used by the VLR or SGSN to register the MS in the CSS when + +- 4780 - the VPLMN supports Autonomous CSG Roaming +- 4781 - and the HPLMN has enabled Autonomous CSG Roaming in the VPLMN +- 4782 - and the MS has requested an initial attach or a location area procedure or a routing area procedure to a CSG cell +- 4783 - and the VLR or SGSN has not yet registered the MS in the CSS. + +4784 The MAP\_UPDATE\_VCSG\_LOCATION service is a confirmed service using the service primitives given in table +4785 8.1/9. + +### 4786 8.1.9.2 Service primitives + +4787 **Table 8.1/9: MAP\_UPDATE\_VCSG\_LOCATION** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| VLR number | C | C(=) | | | +| SGSN number | C | C(=) | | | +| MSISDN | C | C(=) | | | +| Temporary Empty CSG Subscription data Indicator | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4788 + +### 8.1.9.3 Parameter definitions and use + +#### Invoke Id + +See definition in clause 7.6.1. + +#### IMSI + +See definition in clause 7.6.2. + +#### VLR number + +See definition in clause 7.6.2. The presence of this parameter is mandatory when the service is used by the VLR. + +#### SGSN number + +See definition in clause 7.6.2. The presence of this parameter is mandatory when the service is used by the SGSN. + +#### MSISDN + +See definition in clause 7.6.2. Shall be present if this parameter is available. + +#### Temporary Empty CSG Subscription data Indicator + +See definition in clause 7.6.3.100. This parameter shall be present if the CSS accepts the request and there is no CSG Subscription data (empty CSG-ID list) for the roaming MS in the CSS. + +#### User error + +The following error causes defined in clause 7.6.1 may be used: + +- unknown subscriber; +- system failure; +- unexpected data value. + +#### Provider error + +For definition of provider errors see clause 7.6.1 + +### 8.1.10 MAP\_CANCEL\_VCSG\_LOCATION service + +#### 8.1.10.1 Definition + +This service is used between CSS and VLR to delete a roaming user record including the CSG subscription data and the CSS number from the VLR. The service is also used between CSS and SGSN to delete a roaming user record including the CSG subscription data and the CSS number from the SGSN. It may be invoked when there is removal of the CSG subscription data in CSS and of the MS registration including the case where a MS was registered in CSS but without CSG data. + +The MAP\_CANCEL\_VCSG\_LOCATION service is a confirmed service using the primitives defined in table 8.1/10. + +#### 8.1.10.2 Service primitives + +**Table 8.1/10: MAP\_CANCEL\_VCSG\_LOCATION** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4820 + +4821 8.1.10.3 Parameter definitions and use + +4822 Invoke Id + +4823 See definition in clause 7.6.1. + +4824 IMSI + +4825 See definition in clause 7.6.2. + +4826 User error + +4827 If the cancellation fails, an error cause is to be returned by the VLR or by the SGSN. One of the following error causes +4828 defined in clause 7.6.1 shall be used: + +4829 - unexpected data value; + +4830 - data missing. + +4831 Provider error + +4832 For definition of provider errors see clause 7.6.1. + +4833 8.2 Paging and search + +4834 8.2.1 MAP\_PAGE service + +4835 8.2.1.1 Definition + +4836 This service is used between VLR and MSC to initiate paging of an MS for mobile terminated short message or +4837 unstructured SS notification. + +4838 The MAP\_PAGE service is a confirmed service using the primitives from table 8.2/1. + +4839 8.2.1.2 Service primitives + +4840 **Table 8.2/1: MAP\_PAGE** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| Stored location area Id | M | M(=) | | | +| TMSI | U | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4841 + +4842 8.2.1.3 Parameter definitions and use + +4843 Invoke Id + +4844 See definition in clause 7.6.1. + +4845 IMSI + +4846 See definition in clause 7.6.2. The IMSI is used to define the paging subgroup. If the TMSI is not supplied, paging on +4847 the radio path uses the IMSI as an identifier. + +4848 Stored location area Id + +4849 See definition in clause 7.6.2. + +4850 TMSI + +4851 See definition in clause 7.6.2. The TMSI is included if paging on the radio channel is to use the TMSI as an identifier. + +4852 User error + +4853 The following error causes defined in clause 7.6.1 may be sent by the user in case of a paging error, depending on the +4854 failure reason: + +- 4855 - absent subscriber; +- 4856 - unknown location area; +- 4857 - busy subscriber; +- 4858 - system failure; +- 4859 - this corresponds to the case where there is no call associated with the MAP\_PAGE service, i.e. if the call has +4860 been released but the dialogue to the VLR has not been aborted; +- 4861 - unexpected data value. + +4862 Provider error + +4863 See definition in clause 7.6.1. + +## 4864 8.2.2 MAP\_SEARCH\_FOR\_MS service + +### 4865 8.2.2.1 Definition + +4866 This service is used between VLR and MSC to initiate paging of an MS in all location areas of that VLR. It is used if +4867 the VLR does not hold location area information confirmed by radio contact. + +4868 The MAP\_SEARCH\_FOR\_MS service is a confirmed service using the primitives from table 8.2/2. + +### 4869 8.2.2.2 Service primitives + +4870 **Table 8.2/2: MAP\_SEARCH\_FOR\_MS** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| Current location area Id | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4871 + +### 4872 8.2.2.3 Parameter definitions and use + +4873 Invoke Id + +4874 See definition in clause 7.6.1. + +4875 IMSI + +4876 See definition in clause 7.6.2. The IMSI is used to identify the subscriber when paging on the radio path. + +4877 Current location area Id + +4878 See definition in clause 7.6.2. In case of successful outcome of the service, i.e. if the MS responds to paging, the +4879 Location Area Id of the area in which the MS responded is given in the response. + +4880 User error + +4881 The following error causes defined in clause 7.6.1 shall be sent by the user if the search procedure fails, depending on + 4882 the failure reason: + +- 4883 - absent subscriber; + 4884 this error cause is returned by the MSC if the MS does not respond to the paging request; +- 4885 - system failure; +- 4886 - this corresponds to the case where there is no call associated with the MAP\_SEARCH\_FOR\_MS service, i.e. if + 4887 the call has been released but the dialogue to the VLR has not been aborted; +- 4888 - busy subscriber; +- 4889 - unexpected data value. + +4890 Provider error + +4891 See definition in clause 7.6.1. + +## 4892 8.3 Access management services + +### 4893 8.3.1 MAP\_PROCESS\_ACCESS\_REQUEST service + +#### 4894 8.3.1.1 Definition + +4895 This service is used between MSC and VLR to initiate processing of an MS access to the network, e.g. for mobile + 4896 originated short message submission or after being paged by the network. + +4897 The MAP\_PROCESS\_ACCESS\_REQUEST service is a confirmed service using the primitives from table 8.3/1. + +#### 4898 8.3.1.2 Service primitives + +4899 **Table 8.3/1: MAP\_PROCESS\_ACCESS\_REQUEST** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| CM service type | M | M(=) | | | +| Access connection status | M | M(=) | | | +| Current Location Area Id | M | M(=) | | | +| Serving cell Id | M | M(=) | | | +| TMSI | C | C(=) | | | +| Cksn | C | C(=) | | | +| IMSI | C | C(=) | C | C(=) | +| IMEI | C | C(=) | C | C(=) | +| MSISDN | | | U | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4900 + +#### 4901 8.3.1.3 Parameter definitions and use + +4902 Invoke Id + +4903 See definition in clause 7.6.1. + +4904 CM service type + +4905 See definition in clause 7.6.9. + +4906 Access connection status + +4907 See definition in clause 7.6.9. + +4908 Current Location Area Id + +4909 See definition in clause 7.6.2. This parameter is used to update the VLR in case of previous VLR failure. + +4910 Serving cell Id + +4911 See definition in clause 7.6.2. + +4912 TMSI + +4913 See definition in clause 7.6.2. Either TMSI or IMSI as received from the MS are included in the Request/Indication, but +4914 one shall be present. In case of CM Service Type "Emergency Call Establishment", the IMEI may replace IMSI/TMSI. + +4915 Cksn + +4916 See definition in clause 7.6.7. In case of access with TMSI, the Cksn shall be present. + +4917 IMSI + +4918 See definition in clause 7.6.2. Either TMSI or IMSI as received from the MS are included in the Request/Indication, but +4919 one shall be present. In case of CM Service Type "Emergency Call Establishment", the IMEI may replace IMSI/TMSI. + +4920 In the Response/Confirmation, the IMSI is to be sent in case of successful outcome of the service. In case of CM +4921 Service Type "Emergency Call Establishment", IMEI may replace IMSI. + +4922 IMEI + +4923 See definition in clause 7.6.2. The IMEI may replace IMSI/TMSI in the Request/Indication and IMSI in the +4924 Response/Confirmation only in case the CM Service Type indicates "Emergency Call Establishment". + +4925 MSISDN + +4926 See definition in clause 7.6.2. The MSISDN is included in case of successful outcome of the service as an operator +4927 option, e.g. if it is needed at the MSC for charging purposes in case of call forwarding. + +4928 User error + +4929 One of the following error causes defined in clause 7.6.1 shall be sent by the user if the access request fails, depending +4930 on the failure reason: + +4931 - unidentified subscriber; + +4932 - illegal subscriber; + +4933 this error is sent if a correlated authentication procedure has not authenticated the subscriber; + +4934 - illegal equipment; + +4935 this error is sent if an IMEI check failed, i.e. the IMEI is prohibited-listed or not permitted-listed; + +4936 - roaming not allowed; + +4937 - this cause is used after VLR restart if the subscriber has no subscription for the current location area, e.g. due to +4938 regional subscription. The cause will be qualified by "location area not allowed" or "national roaming not +4939 allowed", respectively; + +4940 - unknown location area; + +4941 - system failure; + +4942 - unexpected data value. + +4943 Provider error + +4944 For definition of provider errors see clause 7.6.1. + +## 4945 8.4 Handover services + +4946 It should be noted that the handover services used on the B-interface have not been updated for Release 99. The B- +4947 interface is not fully operational specified. It is strongly recommended not to implement the B-interface as an external +4948 interface. + +### 4949 8.4.1 MAP\_PREPARE\_HANDOVER service + +#### 4950 8.4.1.1 Definition + +4951 This service is used between MSC-A and MSC-B (E-interface) when a call is to be handed over or relocated from +4952 MSC-A to MSC-B. + +4953 The MAP\_PREPARE\_HANDOVER service is a confirmed service using the primitives from table 8.4/1. + +#### 4954 8.4.1.2 Service primitives + +4955 **Table 8.4/1: MAP\_PREPARE\_HANDOVER** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Target Cell Id | C | C(=) | | | +| Target RNC Id | C | C(=) | | | +| HO-NumberNotRequired | C | C(=) | | | +| IMSI | C | C(=) | | | +| Integrity Protection Information | C | C(=) | | | +| Encryption Information | C | C(=) | | | +| Radio Resource Information | C | C(=) | | | +| AN-APDU | C | C(=) | C | C(=) | +| Allowed GSM Algorithms | C | C(=) | | | +| Allowed UMTS Algorithms | C | C(=) | | | +| Radio Resource List | C | C(=) | | | +| RAB ID | C | C(=) | | | +| GERAN Classmark | C | C(=) | | | +| BSSMAP Service Handover | C | C(=) | | | +| BSSMAP Service Handover List | C | C(=) | | | +| RANAP Service Handover | C | C(=) | | | +| Iu-Currently Used Codec | C | C(=) | | | +| Iu-Supported Codecs List | C | C(=) | | | +| RAB Configuration Indicator | C | C(=) | | | +| ASCI Call Reference | C | C(=) | | | +| UESBI-Iu | C | C(=) | | | +| IMEISV | C | C(=) | | | +| Alternative Channel Type | C | C(=) | | | +| Trace Propagation List | C | C(=) | | | +| AoIP-Supported Codecs List | C | C(=) | | | +| Anchor | | | | | +| Regional Subscription Data | U | (C=) | | | +| CSG Subscription Data | U | (C=) | | | +| LCLS Global Call Reference | C | C(=) | | | +| LCLS-Negotiation | C | C(=) | | | +| LCLS-Configuration-Preference | C | C(=) | | | +| Multiple Bearer Requested | C | C(=) | | | +| Handover Number | | | C | C(=) | +| Relocation Number List | | | C | C(=) | +| Multicall Bearer Information | | | C | C(=) | +| Multiple Bearer Not Supported | | | C | C(=) | +| Selected UMTS Algorithms | | | C | C(=) | + +| | | | | | +|-----------------------------------|--|--|---|------| +| Chosen Radio Resource Information | | | C | C(=) | +| Iu-Selected Codec | | | C | C(=) | +| Iu-Available Codecs List | | | C | C(=) | +| AoIP-Selected Codec Target | | | C | C(=) | +| AoIP-Available Codecs List Map | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +4956 + +### 4957 8.4.1.3 Parameter use + +#### 4958 Invoke Id + +4959 For definition of this parameter see clause 7.6.1. + +#### 4960 Target Cell Id + +4961 For definition of this parameter see clause 7.6.2. This parameter is only included if the service is not in an ongoing +4962 transaction. This parameter shall also be excluded if the service is a part of the Inter-MSC SRNS Relocation procedure +4963 or the inter-system handover GSM to UMTS procedure described in 3GPP TS 23.009. + +#### 4964 Target RNC Id + +4965 For definition of this parameter see clause 7.6.2. This parameter shall be included if the service is a part of the Inter- +4966 MSC SRNS Relocation procedure or the inter-system handover GSM to UMTS procedure described in 3GPP TS +4967 23.009. + +#### 4968 HO-Number Not Required + +4969 For definition of this parameter see clause 7.6.6. + +#### 4970 IMSI + +4971 For definition of this parameter see clause 7.6.2. This UMTS parameter shall be included if: + +- 4972 - available and +- 4973 - if the access network protocol is BSSAP and +- 4974 - there is an indication that the MS also supports UMTS. + +#### 4975 Integrity Protection Information + +4976 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if available and if the access +4977 network protocol is BSSAP. + +#### 4978 Encryption Information + +4979 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if available and if the access +4980 network protocol is BSSAP. + +#### 4981 Radio Resource Information + +4982 For definition of this parameter see clause 7.6.6. This GSM parameter shall be included if the access network protocol +4983 is RANAP and there is an indication that the UE also supports GSM. If the parameter Radio Resource List is sent , the +4984 parameter Radio Resource Information shall not be sent. + +#### 4985 AN-APDU + +4986 For definition of this parameter see clause 7.6.9. + +#### 4987 Allowed GSM Algorithms + +4988 For definition of this parameter see clause 7.6.6. This parameter includes allowed GSM algorithms. This GSM +4989 parameter shall be included if: + +- 4990 - the service is a part of the Inter-MSC SRNS Relocation procedure and +- 4991 - Ciphering or Security Mode Setting procedure has been performed. and +- 4992 - there is an indication that the UE also supports GSM. + +#### 4993 Allowed UMTS Algorithms + +4994 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if all of the following +4995 conditions apply: + +- 4996 - access network protocol is BSSAP and +- 4997 - Integrity Protection Information and Encryption Information are not available and +- 4998 - Ciphering or Security Mode Setting procedure has been performed. + +#### 4999 Radio Resource List + +5000 For definition of this parameter see clause 7.6.6. This parameter shall be included if the access network protocol is +5001 RANAP and there is an indication that the UE also supports GSM. This parameter shall be sent when MSC-A requests +5002 multiple bearers to MSC-B. If the parameter Radio Resource Information is sent, the parameter Radio Resource List +5003 shall not be sent. + +#### 5004 RAB ID + +5005 For definition of this parameter see clause 7.6.2. This parameter shall be included when MSC-A supports multiple +5006 bearers and access network protocol is BSSAP and the RAB ID has a value other than 1. + +#### 5007 GERAN Classmark + +5008 For definition of this parameter see clause 7.6.6 This parameter shall be included if available. + +#### 5009 BSSMAP Service Handover + +5010 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the access network protocol is +5011 RANAP. If the parameter BSSMAP Service Handover List is sent, the parameter BSSMAP Service Handover shall not +5012 be sent. + +#### 5013 BSSMAP Service Handover List + +5014 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the access network protocol is +5015 RANAP. This parameter shall be sent when MSC-A requests multiple bearers to MSC-B. If the parameter BSSMAP +5016 Service Handover is sent, the parameter BSSMAP Service Handover List shall not be sent. + +#### 5017 RANAP Service Handover + +5018 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the access network protocol is +5019 BSSAP. + +#### 5020 Iu-Currently Used Codec + +5021 For definition of this parameter see clause 7.6.6. This parameter shall be included if the handover is requested for a +5022 speech bearer and the MS is in UMTS or GERAN Iu-mode access. This parameter shall not be included if the Iu- +5023 Supported Codecs List is not included. + +#### 5024 Iu-Supported Codecs List + +5025 For definition of this parameter see clause 7.6.6. This parameter shall be included by MSC-A, if the handover is +5026 requested for a speech bearer. + +#### 5027 RAB Configuration Indicator + +5028 For definition of this parameter see clause 7.6.6. This parameter may be included if the handover is requested for a +5029 speech bearer and MSC-A knows by means of configuration information that MSC-B supports the use of the Iu- +5030 Supported Codecs List parameter. This parameter shall not be included if the Iu-Supported Codecs List is not included. + +5031 ASCI Call Reference + +5032 This parameter contains either the broadcast call reference or group call reference. It shall be included if a subscriber is +5033 undergoing handover during a VGCS or VBS call, where MSC-B already has a Bearer established, so that MSC-B can +5034 determine the Group or Broadcast Call to which it shall attach the subscriber, see 3GPP TS 48.008 [49]. +5035 + +5036 UESBI-Iu + +5037 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the access network protocol is +5038 BSSAP. + +5039 IMEISV + +5040 For definition of the parameter see clause 7.6.2. This parameter shall be present, if available. This is used e.g. for +5041 Management based Trace Activation (see 3GPP TS 32.422). + +5042 Alternative Channel Type + +5043 For definition of this parameter see clause 7.6.6 It shall be present for a SCUDIF call if the access network protocol is +5044 BSSAP. + +5045 Trace Propagation List + +5046 See definition in clause 7.6.10. This parameter shall be included when MSC-A requests trace invocation. + +5047 AoIP-Supported Codecs List Anchor + +5048 For definition of this parameter see clause 7.6.6. This parameter may be included by MSC-A, if the handover is +5049 requested for a speech bearer and mobile terminal supports GSM codec types. + +5050 Regional Subscription Data + +5051 The list of subscribed Zone Codes as received from the HLR may be included by MSC-A at intra PLMN inter MSC +5052 handover and may be stored at MSC-B for use at subsequent intra MSC handover. + +5053 CSG Subscription Data + +5054 The subscribed CSG Subscription Information as received from the HLR may be included by MSC-A at intra PLMN +5055 inter MSC handover and at inter PLMN inter MSC handover when the target PLMN is an ePLMN, and may be stored at +5056 MSC-B for use at subsequent intra MSC handover. + +5057 LCLS Global Call Reference + +5058 For definition of this parameter see clause 7.6.5.21. This parameter shall be included when MSC-A supports LCLS. + +5059 LCLS-Negotiation + +5060 For definition of this parameter see clause 7.6.5.22. This parameter shall be included when MSC-A supports LCLS. + +5061 LCLS-Configurations-Preference + +5062 For definition of this parameter see clause 7.6.5.23. This parameter shall be included when MSC-A supports LCLS. + +5063 Multiple Bearer Requested + +5064 For a definition of this parameter see clause 7.6.2. This parameter shall be sent when MSC-A requests multiple bearers +5065 to MSC-B. + +5066 Handover Number + +5067 For definition of this parameter see clause 7.6.2. This parameter shall be returned at handover, unless the parameter +5068 HO-NumberNotRequired is sent. If the parameter Handover Number is returned, the parameter Relocation Number List +5069 shall not be returned. + +5070 Relocation Number List + +5071 For definition of this parameter see clause 7.6.2. This parameter shall be returned at relocation, unless the parameter +5072 HO-NumberNotRequired is sent. If the parameter Relocation Number List is returned, the parameter Handover Number +5073 shall not be returned. + +5074 Multicall Bearer Information + +5075 For a definition of this parameter see clause 7.6.2. This parameter shall be returned at relocation in the case that MSC-B +5076 supports multiple bearers. + +5077 Multiple Bearer Not Supported + +5078 For a definition of this parameter see clause 7.6.2. This parameter shall be returned at relocation when MSC-B receives +5079 Multiple Bearer Requested parameter and MSC-B does not support multiple bearers. + +5080 Selected UMTS Algorithms + +5081 For definition of this parameter see clause 7.6.6. This parameter includes the UMTS integrity and optionally +5082 encryption algorithms selected by RNC under the control of MSC-B. This UMTS parameter shall be included if the +5083 service is a part of the inter MSC inter system handover from GSM to UMTS. + +5084 Chosen Radio Resource Information + +5085 For definition of this parameter see clause 7.6.6. This parameter shall be returned at relocation if the encapsulated PDU +5086 is RANAP RAB Assignment Response and MS is in GSM access. + +5087 Iu-Selected Codec + +5088 For definition of this parameter see clause 7.6.6. This parameter shall be included if an Iu-Supported Codecs List was +5089 received in the service request and MSC-B supports the selection of codec based on the Iu-Supported Codecs List and +5090 the target radio access network is connected to MSC-B via the Iu interface, even if the Iu-Selected Codec is equal to the +5091 Iu-Currently Used Codec received in the service request. This parameter shall not be included if the Iu-Supported +5092 Codecs List was not received in the service request. + +5093 Iu-Available Codecs List + +5094 For definition of this parameter see clause 7.6.6. This parameter shall be included by an MSC-B supporting TrFO, if the +5095 Iu-Supported Codecs List was included by MSC-A and the target radio access is UMTS or GERAN Iu-mode. + +5096 AoIP-Selected Codec Target + +5097 For definition of this parameter see clause 7.6.6. This parameter may be included by an MSC-B supporting TrFO, if the +5098 AoIP-Supported Codecs List Anchor was included by MSC-A and if AoIP is used on the target A interface with +5099 transcoder inserted in the MGW. + +5100 AoIP-Available Codecs List Map + +5101 For definition of this parameter see clause 7.6.6. This parameter may be included by an MSC-B supporting TrFO, if the +5102 AoIP-Supported Codecs List Anchor was included by MSC-A and if AoIP is used on the target A interface with +5103 transcoder inserted in the MGW. + +5104 User error + +5105 For definition of this parameter see clause 7.6.1. The following errors defined in clause 7.6.1 may be used, depending +5106 on the nature of the fault: + +- 5107 - No handover number available. +- 5108 - Target cell outside group call area; +- 5109 - System failure. + +5110 - Unexpected data value. + +5111 - Data Missing. + +5112 Provider error + +5113 See definition of provider errors in clause 7.6.1. + +## 5114 8.4.2 MAP\_SEND\_END\_SIGNAL service + +### 5115 8.4.2.1 Definition + +5116 This service is used between MSC-B and MSC-A (E-interface) indicating that the radio path has been established by +5117 MSC-B to the MS. MSC-A retains then the main control of the call until it clears. + +5118 The response is used by MSC-A to inform MSC-B that all resources for the call can be released in MSC-B, either +5119 because the call has been released in MSC-A or because the call has been successfully handed over or relocated from +5120 MSC-B to another MSC. + +5121 The MAP\_SEND\_END\_SIGNAL service is a confirmed service using the primitives from table 8.4/2. + +### 5122 8.4.2.2 Service primitives + +5123 **Table 8.4/2: MAP\_SEND\_END\_SIGNAL** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| AN-APDU | M | M(=) | | | +| Provider error | | | | O | + +5124 + +### 5125 8.4.2.3 Parameter use + +5126 Invoke Id + +5127 For definition of this parameter see clause 7.6.1. + +5128 AN-APDU + +5129 For definition of this parameter see clause 7.6.9. + +5130 Provider error + +5131 For definition of this parameter see clause 7.6.1. + +## 5132 8.4.3 MAP\_PROCESS\_ACCESS\_SIGNALLING service + +### 5133 8.4.3.1 Definition + +5134 This service is used between MSC-B and MSC-A (E-interface) to pass information received on the A-interface or Iu- +5135 interface in MSC-B to MSC-A. + +5136 The MAP\_PROCESS\_ACCESS\_SIGNALLING service is a non-confirmed service using the primitives from +5137 table 8.4/3. + +### 5138 8.4.3.2 Service primitives + +5139 **Table 8.4/3: MAP\_PROCESS\_ACCESS\_SIGNALLING** + +| Parameter name | Request | Indication | +|----------------|---------|------------| +| Invoke Id | M | M(=) | + +| | | | +|-----------------------------------|---|------| +| AN-APDU | M | M(=) | +| Selected GSM Algorithm | C | C(=) | +| Selected UMTS Algorithms | C | C(=) | +| Chosen Radio Resource Information | C | C(=) | +| Selected RAB id | C | C(=) | +| Iu-Selected Codec | C | C(=) | +| Iu-Available Codecs List | C | C(=) | +| AoIP-Selected Codec Target | C | C(=) | +| AoIP-Available Codecs List Map | C | C(=) | + +5140 + +### 5141 8.4.3.3 Parameter use + +#### 5142 Invoke Id + +5143 For definition of this parameter see clause 7.6.1. + +#### 5144 AN-APDU + +5145 For definition of this parameter see clause 7.6.9. + +#### 5146 Selected GSM algorithm + +5147 For definition of this parameter see clause 7.6.6. This parameter shall be present if the encapsulated PDU is Security +5148 Mode Complete and MS is in GSM access. + +#### 5149 Selected UMTS Algorithms + +5150 For definition of this parameter see clause 7.6.6. This parameter includes the UMTS integrity and optionally +5151 encryption algorithms selected by RNC under the control of MSC-B. This UMTS parameter shall be included if the +5152 encapsulated PDU is BSSMAP Cipher Mode Complete and the MS is in UMTS, or an intersystem handover to UMTS is +5153 performed in MSC-B, or in the case of intra MSC-B intra UMTS relocation. + +#### 5154 Chosen Radio Resource Information + +5155 For definition of this parameter see clause 7.6.6. This parameter shall be sent if the encapsulated PDU is RANAP RAB +5156 Assignment Response and MS is in GSM access. + +#### 5157 Selected RAB ID + +5158 The selected radio access bearer that was kept at subsequent intra-MSC handover from UMTS to GSM after multiple +5159 bearers were used. + +#### 5160 Iu-Selected Codec + +5161 For definition of this parameter see clause 7.6.6. This parameter shall be included + +5162 - if MSC-B changes the selected codec and the MS is in UMTS or GERAN Iu-mode access; + +5163 - if intersystem handover to UMTS or GERAN Iu-mode is performed in MSC-B; or + +5164 - if MSC-B received a Forward Access Signalling service request including an Iu-Supported Codecs List and the +5165 MS is in UMTS or GERAN Iu-mode access. + +5166 This parameter shall not be included if the Iu-Supported Codecs List was not received either in the Prepare Handover +5167 service request or in the Forward Access Signalling service request. + +#### 5168 Iu-Available Codecs List + +5169 For definition of this parameter see clause 7.6.6. This parameter shall be included by an MSC-B supporting TrFO + +5170 - if the Iu-Available Codecs List has changed in MSC-B; + +5171 - if intersystem handover to UMTS or GERAN Iu-mode is performed in MSC-B; or + +5172 - if MSC-B received a Forward Access Signalling service request including an Iu-Supported Codecs List and the +5173 MS is in UMTS or GERAN Iu-mode access. + +5174 AoIP-Selected Codec Target + +5175 For definition of this parameter see clause 7.6.6. This parameter may be included + +5176 - if A interface codec is changed in MSC-B; or + +5177 - if intersystem handover to AoIP capable BSC is performed in MSC-B and if AoIP is used on the target A +5178 interface with transcoder inserted in the MGW; or + +5179 - if MSC-B received a Forward Access Signalling service request including an AoIP-Supported Codecs List and +5180 the MS is in AoIP capable GSM access where AoIP is used on the target A interface with transcoder inserted in +5181 the MGW. + +5182 This parameter shall not be included if the AoIP-Supported Codecs List Anchor was not received either in the Prepare +5183 Handover service request or in the Forward Access Signalling service request. + +5184 AoIP-Available Codecs List Map + +5185 For definition of this parameter see clause 7.6.6. This parameter may be included by an MSC-B supporting TrFO + +5186 - if the AoIP-Available Codecs List has changed in MSC-B; or + +5187 - if intersystem handover to AoIP capable BSC is performed in MSC-B where AoIP is used on the target A +5188 interface with transcoder inserted in the MGW; or + +5189 - if MSC-B received a Forward Access Signalling service request including an AoIP-Supported Codecs List +5190 Anchor and the MS is in AoIP capable GSM access where AoIP is used on the target A interface with transcoder +5191 inserted in the MGW. + +## 5192 8.4.4 MAP\_FORWARD\_ACCESS\_SIGNALLING service + +### 5193 8.4.4.1 Definition + +5194 This service is used between MSC-A and MSC-B (E-interface) to pass information to be forwarded to the A-interface +5195 or Iu-interface of MSC-B. + +5196 The MAP\_FORWARD\_ACCESS\_SIGNALLING service is a non-confirmed service using the primitives from +5197 table 8.4/4. + +### 5198 8.4.4.2 Service primitives + +5199 **Table 8.4/4: MAP\_FORWARD\_ACCESS\_SIGNALLING** + +| Parameter name | Request | Indication | +|----------------------------------|---------|------------| +| Invoke Id | M | M(=) | +| Integrity Protection Information | C | C(=) | +| Encryption Information | C | C(=) | +| Key Status | C | C(=) | +| AN-APDU | M | M(=) | +| Allowed GSM Algorithms | C | C(=) | +| Allowed UMTS Algorithms | C | C(=) | +| Radio Resource Information | C | C(=) | +| Radio Resource List | C | C(=) | +| BSSMAP Service Handover | C | C(=) | +| BSSMAP Service Handover List | C | C(=) | +| RANAP Service Handover | C | C(=) | +| Iu-Currently Used Codec | C | C(=) | +| Iu-Supported Codecs List | C | C(=) | +| RAB Configuration Indicator | C | C(=) | +| Iu-Selected Codec | C | C(=) | + +| | | | +|----------------------------|---|------| +| Alternative Channel Type | C | C(=) | +| Trace Propagation List | C | C(=) | +| AoIP-Supported Codecs List | C | C(=) | +| Anchor | | | +| AoIP-Selected Codec Target | C | C(=) | +| UESBI-lu | C | C(=) | +| IMEISV | C | C(=) | + +5200 + +#### 5201 8.4.4.3 Parameter use + +5202 For the definition and use of all parameters and errors, see clause 7.6.1. + +##### 5203 Invoke Id + +5204 For definition of this parameter see clause 7.6.1. + +##### 5205 Integrity Protection Information + +5206 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if available and if the +5207 encapsulated PDU is BSSMAP Cipher Mode Command. + +##### 5208 Encryption Information + +5209 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if available and if the +5210 encapsulated PDU is BSSMAP Cipher Mode Command. + +##### 5211 Key Status + +5212 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if available and if the +5213 encapsulated PDU is BSSMAP Cipher Mode Command. + +##### 5214 AN-APDU + +5215 For definition of this parameter see clause 7.6.9. + +##### 5216 Allowed GSM Algorithms + +5217 This parameter includes allowed GSM algorithms. This GSM parameter shall be included if the encapsulated PDU is +5218 RANAP Security Mode Command and there is an indication that the UE also supports GSM. + +##### 5219 Allowed UMTS Algorithms + +5220 For definition of this parameter see clause 7.6.6. This UMTS parameter shall be included if Integrity Protection +5221 Information and Encryption Information are not available and the encapsulated PDU is BSSMAP Cipher Mode +5222 Command. + +##### 5223 Radio Resource Information + +5224 For definition of this parameter see clause 7.6.6. This parameter shall be sent if the encapsulated PDU is RANAP RAB +5225 Assignment Request. If the parameter Radio Resource List is sent, the parameter Radio Resource Information shall not +5226 be sent. + +##### 5227 Radio Resource List + +5228 For definition of this parameter see clause 7.6.6. This parameter shall be sent if the encapsulated PDU is RANAP RAB +5229 Assignment Request and MSC-A requests modification of multiple bearers. If the parameter Radio Resource +5230 Information is sent, the parameter Radio Resource List shall not be sent. + +##### 5231 BSSMAP Service Handover + +5232 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the encapsulated PDU is +5233 RANAP RAB Assignment Request. If the parameter BSSMAP Service Handover List is sent, the parameter BSSMAP +5234 Service Handover shall not be sent. + +##### 5235 BSSMAP Service Handover List + +5236 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the encapsulated PDU is +5237 RANAP RAB Assignment Request and MSC-A requests modification of multiple bearers. If the parameter BSSMAP +5238 Service Handover is sent, the parameter BSSMAP Service Handover List shall not be sent. + +5239 RANAP Service Handover + +5240 For definition of this parameter see clause 7.6.6.. It shall be present if it is available and the encapsulated PDU is +5241 BSSMAP Assignment Request. + +5242 Iu-Currently Used Codec + +5243 For definition of this parameter see clause 7.6.6. This parameter shall be included if the encapsulated PDU is a RANAP +5244 RAB Assignment Request or BSSMAP Assignment Request for a speech bearer and the MS is in UMTS or GERAN +5245 Iu-mode access. This parameter shall not be included if the Iu-Supported Codecs List is not included. + +5246 Iu-Supported Codecs List + +5247 For definition of this parameter see clause 7.6.6. This parameter shall be included if the encapsulated PDU is a RANAP +5248 RAB Assignment Request or BSSMAP Assignment Request and + +- 5249 - a new bearer is allocated for speech; +- 5250 - an existing bearer is modified from data to speech; or +- 5251 - for an existing speech bearer the order of priority in the Iu-Supported Codecs List needs to be modified. + +5252 This parameter shall not be included if the Iu-Selected Codec is included. + +5253 RAB Configuration Indicator + +5254 For definition of this parameter see clause 7.6.6. This parameter may be included if the encapsulated PDU is a RANAP +5255 RAB Assignment Request for a speech bearer, and MSC-A knows by means of configuration information that MSC-B +5256 supports the use of the Iu-Supported Codecs List parameter. This parameter shall not be included if the Iu-Supported +5257 Codecs List is not included. + +5258 Iu-Selected Codec + +5259 For definition of this parameter see clause 7.6.6. This parameter shall be included if + +- 5260 - the encapsulated PDU is a RANAP RAB Assignment Request or BSSMAP Assignment Request for an existing +5261 speech bearer; and +- 5262 - the MS is in UMTS or GERAN Iu-mode access; and +- 5263 - an Iu-Available Codecs List was received by MSC-A for this speech bearer before, either in the Prepare +5264 Handover service response or in the Process Access Signalling service request. + +5265 This parameter shall not be included if the Iu-Supported Codecs List is included. + +5266 Alternative Channel Type + +5267 For definition of this parameter see clause 7.6.6. This parameter shall be present for a SCUDIF call if the encapsulated +5268 PDU is BSSMAP Assignment Request. + +5269 Trace Propagation List + +5270 See definition in clause 7.6.10. This parameter shall be included when MSC-A requests trace invocation. + +5271 AoIP-Supported Codecs List Anchor + +5272 For definition of this parameter see clause 7.6.6. This parameter may be included if the encapsulated PDU is a +5273 BSSMAP Assignment Request and + +- 5274 - a new bearer is allocated for speech; +- 5275 - an existing bearer is modified from data to speech; or + +5276 - for an existing speech bearer the order of priority in the AoIP-Supported Codecs List needs to be modified. + +5277 This parameter shall not be included if the AoIP-Selected Codec Target is included. + +5278 AoIP-Selected Codec Target + +5279 For definition of this parameter see clause 7.6.6. This parameter may be included if + +5280 - the encapsulated PDU is a BSSMAP Assignment Request for an existing speech bearer; and + +5281 - the MS is in AoIP capable GSM access where AoIP is used on the target A interface with transcoder inserted in +5282 the MGW; and + +5283 - an AoIP-Available Codecs List was received by MSC-A for this speech bearer before, either in the Prepare +5284 Handover service response or in the Process Access Signalling service request. + +5285 This parameter shall not be included if the AoIP-Supported Codecs List Anchor is included. + +5286 UESBI-Iu + +5287 For definition of this parameter see clause 7.6.6. It shall be present if it is available and the access network protocol is +5288 BSSAP and the parameter has not already been sent to the target MSC. + +5289 IMEISV + +5290 For definition of the parameter see clause 7.6.2. This parameter shall be present if available and if not already sent to +5291 the target MSC. This is used e.g. for Management based Trace Activation (see 3GPP TS 32.422). + +## 5292 8.4.5 MAP\_PREPARE\_SUBSEQUENT\_HANDOVER service + +### 5293 8.4.5.1 Definition + +5294 This service is used between MSC-B and MSC-A (E-interface) to inform MSC-A that it has been decided that a +5295 handover or relocation to either MSC-A or a third MSC (MSC-B') is required. + +5296 The MAP\_PREPARE\_SUBSEQUENT\_HANDOVER service is a confirmed service using the primitives from +5297 table 8.4/5. + +### 5298 8.4.5.2 Service primitives + +5299 **Table 8.4/5: MAP\_PREPARE\_SUBSEQUENT\_HANDOVER** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Target Cell Id | C | C(=) | | | +| Target RNC Id | C | C(=) | | | +| Target MSC Number | M | M(=) | | | +| Selected RAB ID | C | C(=) | | | +| GERAN Classmark | C | C(=) | | | +| RAB Configuration Indicator | C | C(=) | | | +| AN-APDU | M | M(=) | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +5300 + +### 5301 8.4.5.3 Parameter use + +5302 Invoke Id + +5303 For definition of this parameter see clause 7.6.1. + +5304 Target Cell Id + +5305 For definition of this parameter see clause 7.6.2. This parameter shall be excluded if the service is a part of the Inter- + 5306 MSC SRNS Relocation procedure or the inter-system handover GSM to UMTS procedure described in 3GPP TS + 5307 23.009. + +5308 Target RNC Id + +5309 For definition of this parameter see clause 7.6.2. This parameter shall be included if the service is a part of the Inter- + 5310 MSC SRNS Relocation procedure or the inter-system handover GSM to UMTS procedure described in 3GPP TS + 5311 23.009. + +5312 Target MSC Number + +5313 For definition of this parameter see clause 7.6.2. + +5314 Selected RAB ID + +5315 For definition of this parameter see clause 7.6.2. + +5316 GERAN Classmark + +5317 For definition of this parameter see clause 7.6.6 This parameter shall be included if available. + +5318 RAB Configuration Indicator + +5319 For definition of this parameter see clause 7.6.6. This parameter may be included if the call is a speech call and MSC-B + 5320 knows by means of configuration information that MSC-B' (and MSC-A) supports the use of the Iu-Supported Codecs + 5321 List parameter. + +5322 AN-APDU + +5323 For definition of this parameter see clause 7.6.9. + +5324 User error + +5325 For definition of this parameter see clause 7.6.1. The following error causes defined in clause 7.6.1 may be used, + 5326 depending on the nature of the fault: + +- 5327 - Unknown MSC; +- 5328 - Subsequent handover failure; +- 5329 - Unexpected data value; +- 5330 - Data Missing. + +5331 Provider error + +5332 For definition of this parameter see clause 7.6.1. + +## 5333 8.4.6 MAP\_ALLOCATE\_HANDOVER\_NUMBER service + +### 5334 8.4.6.1 Definition + +5335 This service is used between MSC and VLR (B-interface) to request a handover number. + +5336 The MAP\_ALLOCATE\_HANDOVER\_NUMBER service is a confirmed service using the primitives from table 8.4/6. + +### 5337 8.4.6.2 Service primitives + +5338 **Table 8.4/6: MAP\_ALLOCATE\_HANDOVER\_NUMBER** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +5339 + +### 5340 8.4.6.3 Parameter use + +#### 5341 Invoke Id + +5342 For definition of this parameter see clause 7.6.1. + +#### 5343 User error + +5344 For definition of this parameter see clause 7.6.1. The following errors defined in clause 7.6.1 may be used, depending +5345 on the nature of the fault: + +5346 - No handover number available. + +#### 5347 Provider error + +5348 For definition of this parameter see clause 7.6.1. + +## 5349 8.4.7 MAP\_SEND\_HANDOVER\_REPORT service + +### 5350 8.4.7.1 Definition + +5351 This service is used between VLR and MSC-B (B-interface) to transfer the handover number to be forwarded to and +5352 used by MSC-A. + +5353 The MAP\_SEND\_HANDOVER\_REPORT service is a confirmed service using the primitives from table 8.4/7. + +### 5354 8.4.7.2 Service primitives + +5355 **Table 8.4/7: MAP\_SEND\_HANDOVER\_REPORT** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Handover Number | M | M(=) | | | +| Linked Id | M | M(=) | | | +| Provider error | | | | O | + +5356 + +### 5357 8.4.7.3 Parameter use + +#### 5358 Invoke Id + +5359 For definition of this parameter see clause 7.6.1. + +#### 5360 Handover Number + +5361 For definition of this parameter see clause 7.6.2. + +#### 5362 Linked Id + +5363 For definition of this parameter see clause 7.6.1. This service is linked with +5364 MAP\_ALLOCATE\_HANDOVER\_NUMBER. + +#### 5365 Provider error + +5366 For definition of this parameter see clause 7.6.1. + +## 5367 8.5 Authentication management services + +### 5368 8.5.1 MAP\_AUTHENTICATE service + +5369 The MAP\_AUTHENTICATE service is used on the MAP B interface. This interface is not fully operational specified. +5370 It is strongly recommended not to implement the B-interface as an external interface. + +### 5371 8.5.1.1 Definition + +5372 This service is used between the VLR and the MSC when the VLR receives a MAP service indication from the MSC +5373 concerning a location registration, call set-up, operation on a supplementary service or a request from the MSC to +5374 initiate authentication. + +5375 The service is a confirmed service and consists of four service primitives. + +### 5376 8.5.1.2 Service primitives + +5377 The service primitives are shown in table 8.5/1. + +5378 **Table 8.5/1: MAP\_AUTHENTICATE parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| RAND | M | M(=) | | | +| CKSN | M | M(=) | | | +| SRES | | | M | M(=) | +| Provider error | | | | O | + +5379 + +### 5380 8.5.1.3 Parameter use + +#### 5381 Invoke id + +5382 See clause 7.6.1 for the use of this parameter. + +#### 5383 RAND + +5384 See clause 7.6.7 for the use of this parameter. + +#### 5385 CKSN + +5386 See clause 7.6.7 for the use of this parameter. + +#### 5387 SRES + +5388 See clause 7.6.7 for the use of this parameter. + +#### 5389 Provider error + +5390 See clause 7.6.1 for the use of this parameter. + +## 5391 8.5.2 MAP\_SEND\_AUTHENTICATION\_INFO service + +### 5392 8.5.2.1 Definition + +5393 This service is used between the VLR and the HLR for the VLR to retrieve authentication information from the HLR. +5394 The VLR requests up to five authentication vectors. + +5395 Also this service is used between the SGSN and the HLR for the SGSN to retrieve authentication information and/or +5396 UE Usage Type from the HLR. The SGSN requests up to five authentication vectors. + +5397 Also this service is used between the BSF and the HLR for the BSF to retrieve authentication information from the +5398 HLR. The BSF shall only request one authentication vector at a time. + +5399 In an EPS, this service is used between IWF and IWF and between IWF and HSS. + +- 5400 If the requesting node type is different from "MME" and the user is a UMTS subscriber, the HLR shall return +5401 authentication quintuplets. If the requesting node type is different from MME and the user is a GSM subscriber, the +5402 HLR shall return authentication triplets. +- 5403 If the requesting node type is "MME", the HSS shall return EPS authentication vectors. +- 5404 If the requesting node type is a combined MME/SGSN, the HSS shall return requested authentication vectors for the +5405 actual RAT and may return additional authentication vectors for the other RAT. +- 5406 If the HLR cannot provide the VLR, the SGSN or the BSF with triplets, an empty response is returned. The VLR, the +5407 SGSN, or the BSF may then re-use old authentication triplets, except where this is forbidden under the conditions +5408 specified in 3GPP TS 43.020 [24]. +- 5409 If the HLR cannot provide the VLR, the SGSN or the BSF with quintuplets, an empty response is returned. The VLR, +5410 the SGSN or the BSF shall not re-use old authentication quintuplets. +- 5411 If the HSS cannot provide the IWF with EPS authentication vectors, an empty response is returned. +- 5412 If the VLR or SGSN or IWF or BSF receives a MAP\_SEND\_AUTHENTICATION\_INFO response containing a User +5413 Error parameter as part of the handling of an authentication procedure, the authentication procedure in the VLR or +5414 SGSN or MME or BSF shall fail. +- 5415 Security related network functions are further described in 3GPP TS 43.020 [24] and 3GPP TS 33.200. +- 5416 The service is a confirmed service and consists of four service primitives. + +### 5417 8.5.2.2 Service primitives + +5418 The service primitives are shown in table 8.5/2. + +5419 **Table 8.5/2: MAP\_SEND\_AUTHENTICATION\_INFO parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| Number of requested vectors | C | C(=) | | | +| Requesting node type | C | C(=) | | | +| Re-synchronisation Info | C | C(=) | | | +| Segmentation prohibited indicator | C | C(=) | | | +| Immediate response preferred indicator | U | C(=) | | | +| Requesting PLMN ID | C | C(=) | | | +| Number of additional requested vectors | C | C(=) | | | +| Additional requested Vectors are for EPS | C | C(=) | | | +| UE Usage Type Request Indication | C | C(=) | | | +| AuthenticationSetList | | | C | C(=) | +| UE Usage Type | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +5420 + +### 5421 8.5.2.3 Parameter use + +5422 Invoke id + +5423 See clause 7.6.1 for the use of this parameter. + +5424 IMSI + +5425 See clause 7.6.2 for the use of this parameter. + +5426 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5427 dialogue then this parameter shall not be present in any service request other than the first one. + +5428 Number of requested vectors + +5429 A number indicating how many authentication vectors the VLR, the SGSN, the MME or the BSF is prepared to receive. +5430 The HLR shall not return more vectors than indicated by this parameter. + +5431 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5432 dialogue then this parameter shall not be present in any service request other than the first one. + +5433 Requesting node type + +5434 The type of the requesting node (SGSN, MME, combined MME/SGSN, VLR, or BSF). + +5435 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5436 dialogue then this parameter shall not be present in any service request other than the first one. + +5437 Re-synchronisation Info + +5438 For definition and use of this parameter see 3GPP TS 33.200. + +5439 If multiple service requests are present in a dialogue then this parameter shall not be present in any service request other +5440 than the first one.. + +5441 Segmentation prohibited indicator + +5442 This parameter indicates if the VLR, the SGSN or the IWF allows segmentation of the response at MAP user level. + +5443 This parameter may be present only in the first request of the dialogue. + +5444 Immediate response preferred indicator + +5445 This parameter indicates that one of the requested authentication vectors is requested for immediate use in the VLR, the +5446 SGSN, the MME or the BSF. It may be used by the HLR together with the number of requested vectors and the number +5447 of vectors stored in the HLR to determine the number of vectors to be obtained from the AuC. It shall be ignored if the +5448 number of available vectors is greater than the number of requested vectors. + +5449 If multiple service requests are present in a dialogue then this parameter shall not be present in any service request other +5450 than the first one. + +5451 Requesting PLMN ID + +5452 The PLMN-ID of the requesting node. See 3GPP TS 23.003. + +5453 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5454 dialogue then this parameter shall not be present in any service request other than the first one. + +5455 Number of additional requested vectors + +5456 A number indicating how many additional authentication vectors the combined MME/SGSN or IWF is prepared to +5457 receive. The HLR shall not return more vectors than indicated by this parameter. This parameter shall be present only if +5458 the requesting node type is a combined MME/SGSN. A combined MME/SGSN that wants to request only EPS-Vectors +5459 (only non-EPS-Vectors) shall set the requesting node type to "MME" ("SGSN"). + +5460 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5461 dialogue then this parameter shall not be present in any service request other than the first one. + +5462 Additional vectors are for EPS + +5463 This parameter shall be absent if Number of additional vectors is absent. The parameter indicates by its presence that +5464 additional vectors (i.e. not for immediate use) are for EPS. + +5465 This parameter shall be present in the first (or only) request of the dialogue. If multiple service requests are present in a +5466 dialogue then this parameter shall not be present in any service request other than the first one. + +5467 UE Usage Type Request Indication + +5468 This parameter indicates by its presence that the HLR (if it supports the Dedicated Core Network functionality) shall +5469 include the UE Usage Type in the response to the SGSN. This parameter is not applicable for VLRs. + +5470 AuthenticationSetList + +5471 A set of one to five authentication vectors are transferred from the HLR to the VLR, from the HLR to the SGSN or IWF + 5472 or from the HLR to the BSF, if the outcome of the service was successful. + +5473 UE Usage Type + +5474 This parameter shall be present if UE Usage Type Request Indication was present in the request and the HLR supports + 5475 the Dedicated Core Networks functionality (see 3GPP TS 23.060 [104]) and a UE Usage Type is available in the + 5476 subscription data of the user. In this case, if the Immediate Response Preferred parameter is not set, the HLR may return + 5477 no authentication vectors in the response. + +5478 User error + +5479 One of the following error causes defined in clause 7.6.1 shall be sent by the user in case of unsuccessful outcome of + 5480 the service, depending on the respective failure reason: + +- 5481 - unknown subscriber; +- 5482 - unexpected data value; +- 5483 - system failure; +- 5484 - data missing. + +5485 Provider error + +5486 See clause 7.6.1 for the use of this parameter. + +## 5487 8.5.3 MAP\_AUTHENTICATION\_FAILURE\_REPORT service + +### 5488 8.5.3.1 Definition + +5489 This service is used between the VLR and the HLR or between the SGSN or HLR for reporting of authentication + 5490 failures. + +### 5491 8.5.3.2 Service primitives + +5492 The service primitives are shown in table 8.5/3. + +5493 **Table 8.5/3: MAP\_AUTHENTICATION\_FAILURE\_REPORT parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| Failure cause | M | M(=) | | | +| Re-attempt | M | M(=) | | | +| Access Type | M | M(=) | | | +| Rand | M | M(=) | | | +| VLR number | C | C(=) | | | +| SGSN number | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +5494 + +### 5495 8.5.3.3 Parameter use + +5496 Invoke id + +5497 See clause 7.6.1 for the use of this parameter. + +5498 IMSI + +5499 See clause 7.6.2 for the use of this parameter. + +5500 Failure Cause + +5501 See clause 7.6.7 for use of this parameter. + +5502 + +5503 Re-attempt + +5504 See clause 7.6.7 for use of this parameter. + +5505 Access Type + +5506 See clause 7.6.7 for use of this parameter. + +5507 Rand + +5508 This parameter identifies the specific AV that failed authentication. + +5509 See clause 7.6.7 for use of this parameter. + +5510 VLR number + +5511 Shall be present if the sender is VLR. See definition in clause 7.6.2. + +5512 SGSN number + +5513 Shall be present if the sender is SGSN. See definition in clause 7.6.2. + +5514 User error + +5515 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +5516 values defined in clause 7.6.1: + +- 5517 - Unknown Subscriber; +- 5518 - System Failure; +- 5519 - Unexpected Data Value. + +5520 Provider error + +5521 These are defined in clause 7.6. + +## 5522 8.6 Security management services + +### 5523 8.6.1 MAP\_SET\_CIPHERING\_MODE service + +#### 5524 8.6.1.1 Definitions + +5525 This service is used between the VLR and the MSC to set the ciphering mode and to start ciphering if applicable. It is +5526 called when another service requires that information is to be sent on the radio path in encrypted form. + +5527 The service is a non-confirmed service and consists of two service primitives. + +#### 5528 8.6.1.2 Service primitives + +5529 The service primitives are shown in table 8.6/1. + +5530 + +**Table 8.6/1: MAP\_SET\_CIPHERING\_MODE parameters** + +| Parameter name | Request | Indication | +|----------------|---------|------------| +| Invoke id | M | M(=) | +| Ciphering mode | M | M(=) | +| Kc | C | C(=) | + +5531 + +### 8.6.1.3 Parameter use + +#### Invoke id + +See clause 7.6.1 for the use of this parameter. + +#### Ciphering mode + +See clause 7.6.7 for the use of this parameter. + +#### Kc + +The Kc parameter should be included when the ciphering mode parameter indicates that ciphering must be performed. + +## 8.7 International mobile equipment identities management services + +### 8.7.1 MAP\_CHECK\_IMEI service + +#### 8.7.1.1 Definition + +This service is used between the VLR and the MSC, between the MSC and the EIR, between the SGSN and EIR, and between IWF and EIR to request check of IMEI. If the IMEI is not available in the MSC or in the SGSN, it is requested from the MS and transferred to the EIR in the service request. + +This service may also be used to request the BMUEF from the EIR. + +The service is a confirmed service and consists of four service primitives. + +#### 8.7.1.2 Service primitives + +The service primitives are shown in table 8.7/1. + +**Table 8.7/1: MAP\_CHECK\_IMEI parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMEI | C | C(=) | C | C(=) | +| IMEISV | C | C(=) | C(=) | C(=) | +| Requested Equipment Info | M | M(=) | | | +| Equipment status | | | C | C(=) | +| BMUEF | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +### 8.7.1.3 Parameter use + +#### Invoke id + +See clause 7.6.1 for the use of this parameter. + +#### Requested Equipment Info + +This parameter indicates whether Equipment Status or BMUEF or both is requested. + +5557 IMEI + +5558 See clause 7.6.2 for the use of this parameter. The parameter shall not be included in the service request between the +5559 VLR and the MSC, but one of IMEI and IMEISV is mandatory in the service request from the MSC to the EIR, from +5560 the SGSN to the EIR and from the IWF to the EIR. It is not included in the service response from the EIR to the MSC, +5561 the SGSN or the IWF, but one of IMEI and IMEISV is mandatory in the service response from the MSC to the VLR on +5562 successful outcome. + +5563 IMEISV + +5564 See clause 7.6.2 for the use of this parameter. IMEISV shall be present if BMUEF is requested. + +5565 Equipment status + +5566 See clause 7.6.3 for the use of this parameter. This parameter is sent by the responder in case of successful outcome of +5567 the service if Equipment status was requested. + +5568 BMUEF + +5569 See clause 7.6.4 for the use of this parameter. This parameter is sent by the responder in case of successful outcome of +5570 the service if BMUEF was requested. + +5571 User error + +5572 One of the following error causes defined in clause 7.6.1 shall be sent by the user in case of unsuccessful outcome of +5573 the service, depending on the respective failure reason: + +- 5574 - unknown equipment; +5575 this error is returned by the responder when the IMEI is not known in the EIR; +- 5576 - system failure; +- 5577 - data missing. + +5578 Provider error + +5579 See clause 7.6.1 for the use of this parameter. + +## 5580 8.7.2 MAP\_OBTAIN\_IMEI service + +### 5581 8.7.2.1 Definition + +5582 This service is used between the VLR and the MSC to request the IMEI. If the IMEI is not available in the MSC, it is +5583 requested from the MS. + +5584 The service is a confirmed service and consists of four service primitives. + +### 5585 8.7.2.2 Service primitives + +5586 The service primitives are shown in table 8.7/2. + +5587 **Table 8.7/2: MAP\_OBTAIN\_IMEI parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMEI | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +5588 + +### 5589 8.7.2.3 Parameter use + +5590 Invoke id + +5591 See clause 7.6.1 for the use of this parameter. + +5592 IMEI + +5593 See clause 7.6.2 for the use of this parameter. The parameter is included in the service response from the MSC to the + +5594 VLR on successful outcome of the service. + +5595 User error + +5596 If the service fails, the VLR sends the user error System Failure (see clause 7.6.1) to the MSC. + +5597 Provider error + +5598 See clause 7.6.1 for the use of this parameter. + +## 5599 8.8 Subscriber management services + +### 5600 8.8.1 MAP-INSERT-SUBSCRIBER-DATA service + +#### 5601 8.8.1.1 Definition + +5602 This service is used by an HLR to update a VLR with certain subscriber data in the following occasions: + +- 5603 - the operator has changed the subscription of one or more supplementary services, basic services or data of a +- 5604 subscriber. Note that in case of withdrawal of a Basic or Supplementary service this primitive shall not be used; +- 5605 - the operator has applied, changed or removed Operator Determined Barring; +- 5606 - the subscriber has changed data concerning one or more supplementary services by using a subscriber procedure; +- 5607 - the HLR provides the VLR with subscriber parameters at location updating of a subscriber or at restoration. In +- 5608 this case, this service is used to indicate explicitly that a supplementary service is not provisioned, if the +- 5609 supplementary service specification requires it. The only supplementary services which have this requirement +- 5610 are the CLIR and COLR services. Network access mode is provided only in restoration. If the Super-Charger +- 5611 functionality is supported the HLR may not need to provide the VLR with subscriber parameters at location +- 5612 updating of a subscriber. See TS 23.116. + +5613 Also this service is used by an HLR to update an SGSN with certain subscriber data in the following occasions: + +- 5614 - if the GPRS subscription has changed; +- 5615 - if the network access mode is changed; +- 5616 - the operator has applied, changed or removed Operator Determined Barring; +- 5617 - the subscriber has changed data concerning one or more supplementary services by using a subscriber procedure; +- 5618 - the HLR provides the SGSN with subscriber parameters at GPRS location updating of a subscriber. If the +- 5619 Super-Charger functionality is supported the HLR may not need to provide the SGSN with subscriber parameters. See +- 5620 3GPP TS 23.116. + +5621 Also this service is used by a CSS to update an SGSN or a VLR with VPLMN-CSG-Subscription data in the following + +5622 occasions: + +- 5623 - if the VPLMN-CSG subscription data has changed; +- 5624 - the CSS provides the VLR or SGSN with VPLMN-CSG subscription data at VCSG location updating of a +- 5625 subscriber. + +5626 + +5627 In an EPS, this service is used by an HSS to update an MME via IWF with certain subscriber data in the following + +5628 occasions: + +- 5629 - the EPS subscription has changed; +- 5630 - the operator has applied, changed or removed Operator Determined Barring; +- 5631 - the HSS provides the MME via IWF(MME) with subscriber parameters at EPS location updating of a subscriber +- 5632 unless an explicit indication to skip subscriber data update has been received. + +5633 In an EPS, this service is used by an IWF to indicate to the MME via IWF that the HSS has requested to be notified + +5634 when the UE has become reachable. + +5635 It is a confirmed service and consists of the primitives shown in table 8.8/1. + +## 5636 8.8.1.2 Service primitives + +5637 + +**Table 8.8/1: MAP-INSERT-SUBSCRIBER-DATA** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| MSISDN | C | C(=) | | | +| Additional MSISDN | C | C(=) | | | +| Category | C | C(=) | | | +| Subscriber Status | C | C(=) | | | +| Bearer service List | C | C(=) | C | C(=) | +| Teleservice List | C | C(=) | C | C(=) | +| Forwarding information List | C | C(=) | | | +| Call barring information List | C | C(=) | | | +| CUG information List | C | C(=) | | | +| SS-Data List | C | C(=) | | | +| eMLPP Subscription Data | C | C(=) | | | +| MC-Subscription Data | C | C(=) | | | +| Operator Determined Barring General data | C | C(=) | C | C(=) | +| Operator Determined Barring HPLMN data | C | C(=) | | | +| Roaming Restriction Due To Unsupported Feature | C | C(=) | | | +| Regional Subscription Data | C | C(=) | | | +| VLR CAMEL Subscription Info | C | C(=) | | | +| Voice Broadcast Data | C | C(=) | | | +| Voice Group Call Data | C | C(=) | | | +| Network access mode | C | C(=) | | | +| GPRS Subscription Data | C | C(=) | | | +| EPS Subscription Data | C | C(=) | | | +| VPLMN LIPA Allowed | C | C(=) | | | +| Roaming Restricted In SGSN/MME Due To Unsupported Feature | C | C(=) | | | +| North American Equal Access preferred Carrier Id List | U | C(=) | | | +| SGSN CAMEL Subscription Info | C | C(=) | | | +| LSA Information | C | C(=) | | | +| IST Alert Timer | C | C(=) | | | +| SS-Code List | | | C | C(=) | +| LMU Identifier | C | C(=) | | | +| LCS Information | C | C(=) | | | +| CS Allocation/Retention priority | C | C(=) | | | +| Super-Charger Supported In HLR | C | C(=) | | | +| Subscribed Charging Characteristics | C | C(=) | | | +| Access Restriction Data | C | C(=) | | | +| ICS Indicator | U | C(=) | | | +| CSG Subscription Data | C | C(=) | | | +| VPLMN CSG Subscription Data | C | C(=) | | | +| UE Reachability Request Indicator | C | C(=) | | | +| SGSN Number | C | C(=) | | | +| MME-Name | C | C(=) | | | +| Subscribed Periodic RAU-TAU Timer | C | C(=) | | | + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------------------------|---------|------------|----------|---------| +| Subscribed Periodic LAU Timer | C | C(=) | | | +| MDT User Consent | C | C(=) | | | +| PS and SMS-Only Service Provision | C | C(=) | | | +| SMS in SGSN Allowed | C | C(=) | | | +| CS-to-PS-SRVCC-Allowed-Indicator | C | C(=) | | | +| P-CSCF Restoration Request | C | C(=) | | | +| Adjacent Access Restriction Data | C | C(=) | | | +| IMSI-Group-Id List | C | C(=) | | | +| UE Usage Type | C | C(=) | | | +| User Plane Integrity Protection Indicator | C | C(=) | | | +| DL-Buffering Suggested Packet Count | C | C(=) | | | +| Reset-IDs | C | C(=) | | | +| eDRX-Cycle-Length List | C | C(=) | | | +| IAB-Operation-Allowed-Indicator | C | C(==) | | | +| Regional Subscription Response | | | C | C(=) | +| Supported CAMEL Phases | | | C | C(=) | +| Offered CAMEL 4 CSIs | | | C | C(=) | +| Supported Features | | | U | C(=) | +| User error | | | U | C(=) | +| Provider error | | | | O | + +5638 + +### 5639 8.8.1.3 Parameter use + +5640 All parameters are described in clause 7.6. The following clarifications are applicable: + +#### 5641 Network access mode + +5642 This parameter defines if the subscriber has access to MSC/VLR and/or to SGSN/MME. This parameter is used by +5643 SGSN/MME and MSC/VLR. In VLR, the parameter is used only as part of Restore Data Procedure and the parameter is +5644 not stored in the VLR. This parameter shall always be sent to the SGSN and via IWF to the MME as part of the GPRS +5645 subscriber data at GPRS/MME location updating. It shall be sent to the SGSN and via IWF to the MME if it is changed +5646 as a result of administrative action. + +5647 This parameter shall not be used by the CSS. + +5648 + +#### 5649 IMSI + +5650 It is only included if the service is not used in an ongoing transaction (e.g. location updating). This parameter is used by +5651 the VLR and the SGSN and IWF. + +#### 5652 MSISDN + +5653 For subscriptions with MSISDN: +5654 It is included at location updating and when it is changed. The MSISDN sent shall be the basic MSISDN. This +5655 parameter is used by the VLR and the SGSN and IWF. + +5656 For a subscription without MSISDN: +5657 The HLR shall not populate this parameter if the VLR or SGSN explicitly indicated support of MSISDN-less +5658 operation. + +5659 NOTE 1: See clauses 8.1.2.3 and 8.1.7.3 for the case where the VLR or SGSN does not support MSISDN-less +5660 operation. + +#### 5661 Additional MSISDN + +5662 If subscribed, the Additional MSISDN is included at location updating and when it is changed. This parameter is used +5663 by the SGSN and IWF. This parameter shall be ignored by the VLR if received. + +5664 If the SGSN does not indicate support of the feature the HSS shall not send the parameter. + +#### 5665 Category + +5666 It is included either at location updating or when it is changed. This parameter is used only by the VLR and if the SGSN +5667 or IWF receives this parameter it shall ignore it. + +5668 Subscriber Status + +5669 It is included either at location updating or when it is changed. + +5670 To apply, remove or update Operator Determined Barring Categories the Subscriber Status is set to Operator +5671 Determined Barring. In this case ODB General Data shall also be present. If the Operator Determined Barring applies +5672 and the subscriber is registered in the HPLMN and HPLMN specific Operator Determined Barring applies then ODB +5673 HPLMN Specific Data shall also be present. + +5674 To remove all Operator Determined Barring Categories the Subscriber Status shall be set to "Service Granted". This +5675 parameter is used by the VLR and the SGSN and IWF. + +5676 This parameter shall not be used by the CSS. + +5677 + +5678 Bearer service List + +5679 A list of Extensible Bearer service parameters (Extensible Bearer service is defined in clause 7.6). An Extensible Bearer +5680 service parameter must be the code for an individual Bearer service, except in the cases described below. + +5681 The codes for the Bearer service groups "allAlternateSpeech-DataCDA" and "allAlternateSpeech-DataCDS" shall, if +5682 applicable, be sent from the HLR to the VLR as a pair. The codes for the Bearer service groups +5683 "allSpeechFollowedByDataCDA" and "allSpeechFollowedByDataCDS" shall, if applicable, be sent from the HLR to +5684 the VLR as a pair. + +5685 If it is included in the Request/Indication, it includes either all Extensible Bearer services subscribed (at location +5686 updating or at restoration) or only the ones added (at subscriber data modification). + +5687 If the VLR receives an Indication containing any Extensible Bearer service parameters which it does not +5688 support/allocate it returns them in the response to the HLR and discards the unsupported Extensible Bearer services (no +5689 error is sent back), except in the cases described below. + +5690 If the VLR receives the codes for the Bearer service groups "allSpeechFollowedByDataCDA" and +5691 "allSpeechFollowedByDataCDS" and supports one or more of the circuit-switched synchronous or asynchronous data +5692 rates specified for simple data bearer services, it shall accept the bearer service codes, and not return them in the +5693 response to the HLR. If the VLR does not support any of the circuit-switched synchronous or asynchronous data rates +5694 specified for simple data bearer services, and receives the pair of codes for "allAlternateSpeech-DataCDA" and +5695 "allAlternateSpeech-DataCDS" or the pair of codes for "allSpeechFollowedByDataCDA" and +5696 "allSpeechFollowedByDataCDS", it shall reject the pair of codes by returning them in the response to the HLR. This +5697 parameter is used only by the VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +5698 This parameter shall not be used by the CSS. + +5699 + +5700 Teleservice List + +5701 A list of Extensible Teleservice parameters (Extensible Teleservice is defined in clause 7.6). An Extensible Teleservice +5702 parameter must be the code for an individual Teleservice. + +5703 If it is included in the Request/Indication, it contains either all Extensible Teleservices subscribed (at location updating +5704 or at restoration) or the ones added (at subscriber data modification). Only the Extensible Teleservices that are relevant +5705 to the node at which the message is received should be included in the Teleservice List. + +5706 If the VLR or the SGSN or the IWF receives an Indication containing any Extensible Teleservice parameters which it +5707 does not support/allocate it returns them in the response to the HLR and discards the unsupported Extensible +5708 Teleservices (no error is sent back). This parameter is used by the VLR and the SGSN and the IWF. + +5709 This parameter shall not be used by the CSS. + +5710 + +#### 5711 Forwarding information List + +5712 A list of Extensible Forwarding information parameters (Extensible Forwarding information is defined in clause 7.6). It +5713 includes Call Forwarding services either at location updating or at restoration or when they are changed. Each +5714 Extensible Forwarding information parameter shall be treated independently of all other parameters in the primitive. + +5715 The Extensible Forwarding information shall include the SS-Code for an individual call forwarding supplementary +5716 service. The Extensible Forwarding information shall contain one or more Extensible Forwarding Features (Extensible +5717 Forwarding Feature is defined in clause 7.6). + +5718 The Extensible Forwarding Feature may include an Extensible Basic Service Group. This shall be interpreted according +5719 to the rules in clause 8.8.1.4. + +5720 The Extensible Forwarding Feature shall contain an Extensible SS-Status parameter. + +5721 If the Extensible SS-Status indicates that call forwarding is registered then (except for call forwarding unconditional) +5722 the Extensible Forwarding Feature shall contain a number to define the forwarded-to destination and, if available, the +5723 forwarded-to subaddress. In other states the forwarded-to number and, if applicable, the forwarded-to subaddress shall +5724 not be included. For call forwarding unconditional the forwarded-to number and, if applicable, the forwarded-to +5725 subaddress shall not be included. If the VLR does not receive a forwarded-to subaddress then it shall assume that a +5726 forwarded-to subaddress has not been registered. + +5727 The Extensible Forwarding Feature shall contain the extensible forwarding options (except for call forwarding +5728 unconditional where the extensible forwarding options shall not be included). Bits 3 and 4 of the extensible forwarding +5729 options shall be ignored by the VLR, and may be set to any value by the HLR. + +5730 For call forwarding on no reply: If the extensible SS-Status indicates that call forwarding is registered then the +5731 Extensible Forwarding Feature shall contain an extensible no reply condition timer. In other states the no reply +5732 condition timer shall not be included. + +5733 For call forwarding services other than call forwarding on no reply: The Extensible Forwarding Feature shall not +5734 contain a no reply condition timer. + +5735 If the VLR receives an Indication containing any Call Forwarding service codes which it does not support/allocate it +5736 returns them to the HLR in the parameter SS-Code List and discards the unsupported Call Forwarding service codes +5737 (no error is sent back). This parameter is used only by the VLR and if the SGSN or IWF receives this parameter it shall +5738 ignore it. + +5739 This parameter shall not be used by the CSS. + +5740 + +#### 5741 Call barring information List + +5742 A list of Extensible Call barring information parameters (Extensible Call barring information is defined in clause 7.6). It +5743 includes Call Barring services either at location updating or at restoration or when they are changed. Each Extensible +5744 Call barring information parameter shall be treated independently of all other parameters in the primitive. + +5745 The Extensible Call barring information shall include the SS-Code for an individual call barring supplementary service. +5746 The Extensible Call barring information shall contain one or more Extensible Call Barring Features (Extensible Call +5747 Barring Feature is defined in clause 7.6). + +5748 The Extensible Call Barring Feature may include an Extensible Basic Service Group. This shall be interpreted +5749 according to the rules in clause 8.8.1.4. + +5750 The Extensible Call Barring Feature shall contain an extensible SS-Status parameter. + +5751 If the VLR or the SGSN or the IWF receives an Indication containing any Extensible Call Barring service codes which +5752 it does not support/allocate it returns them to the HLR in the parameter SS-Code List and discards the unsupported +5753 Extensible Call Barring service codes (no error is sent back). + +5754 This parameter shall not be used by the CSS. + +#### 5755 CUG information List + +5756 A list of CUG information list parameters (CUG information is defined in clause 7.6). It includes CUG information +5757 either at location updating or at restoration or when it is changed. + +5758 At location updating, restoration or when there is a change in CUG data, the HLR shall include the complete +5759 CUG-SubscriptionList and, if there are options per basic group, it shall also include the complete CUG-FeatureList. If +5760 there are not options per extensible basic service group the CUG-FeatureList shall not be included. + +5761 In any dialogue, the first insertSubscriberData message which contains CUG information shall include a non-empty +5762 CUG-SubscriptionList. + +5763 When the VLR receives CUG data it shall replace the stored CUG data with the received data set. + +5764 If CUG-FeatureList is omitted in the Insert Subscriber Data operation VLR shall interpret that no options per extensible +5765 basic service group exist, and then it shall apply the default values i.e. no outgoing access, no incoming access, no +5766 preferential CUG exists. + +5767 If CUG-Feature is received without preferential CUG, the VLR shall interpret that no preferential CUG applies. + +5768 If the VLR detects that there is overlapping in the information received within a dialogue, it shall send the error +5769 Unexpected Data Value. + +5770 Note that data consistency between CUG subscription data and CUG feature data is the responsibility of the HLR. + +5771 If the VLR does not support the CUG service it returns its code to the HLR in the parameter SS-Code List and discards +5772 the received information (no error is sent back). This parameter is used only by the VLR and if the SGSN or IWF +5773 receives this parameter it shall ignore it. + +5774 This parameter shall not be used by the CSS. + +#### 5775 SS-Data List + +5776 A list of Extensible SS-Data parameters (Extensible SS-Data is defined in clause 7.6). It is sent for any other +5777 supplementary service than Call Forwarding, Call Barring, CUG and eMLPP either at location updating or at restoration +5778 or when they are changed. Each SS-Data parameter shall be treated independently of all other parameters in the +5779 primitive. + +5780 The Extensible SS-Data shall include the SS-Code for an individual supplementary service. + +5781 The Extensible SS-Data shall contain an Extensible SS-Status parameter and any subscription options that are +5782 applicable to the service defined by the SS-Code. + +5783 The SS-Data may include a Basic Service Group List. This shall be interpreted according to the rules in clause 8.8.1.4. + +5784 If the VLR receives an Indication containing any supplementary service codes which it does not support/allocate it +5785 returns them to the HLR in the parameter SS-Code List and therefore discards the unsupported service codes received +5786 (no error is sent back). + +5787 This parameter is used by the SGSN only for LCS. If the SGSN receives an Indication containing any LCS related +5788 supplementary service codes which it does not support/allocate it returns them to the HLR in the parameter SS-Code +5789 List and therefore discards the unsupported service codes received (no error is sent back). SS-codes not related to the +5790 supported LCS capability set shall be discarded. + +5791 If the IWF receives an Indication containing any LCS related supplementary service codes, it returns them to the HSS in +5792 the parameter SS-Code List and therefore discards the service codes received (no error is sent back). SS-codes not +5793 related to the supported LCS capability set shall be discarded. + +5794 This parameter shall not be used by the CSS. + +#### 5795 Operator Determined Barring General data + +5796 If it is included in a Request/Indication, it includes all the Operator Determined Barring categories that may be applied +5797 to a subscriber registered in any PLMN. This parameter is only included in a Request/Indication when the parameter +5798 Subscriber Status is set to the value Operator Determined Barring. Note that all General Operator Determined Barring +5799 Categories shall be set to their actual status. + +5800 If the VLR or the SGSN or IWF receives an Indication containing Operator Determined Barring General Data which +5801 shows that the subscriber is subject to barring not supported / not allocated by the VLR or by the SGSN, it returns +5802 Operator Determined Barring General Data in the response to the HLR to show the barring categories which are not +5803 supported / not allocated by the VLR or by the SGSN. This parameter is used by the VLR and the SGSN and IWF. + +5804 This parameter shall not be used by the CSS. + +5805 Operator Determined Barring HPLMN data + +5806 It includes all the Operator Determined Barring categories that may be applied only to a subscriber registered in the +5807 HPLMN. Therefore, it shall only be transferred to the VLR or to the SGSN or IWF when the subscriber is roaming into +5808 the HPLMN and when the parameter Subscriber Status is set to the value Operator Determined Barring. Note that all +5809 HPLMN Operator Determined Barring Categories shall be set to their actual status. + +5810 If Subscriber Status is set to the value Operator Determined Barring and no Operator Determined Barring HPLMN data +5811 is present then the VLR or the SGSN or IWF shall not apply any HPLMN specific ODB services to the subscriber. This +5812 parameter is used by the VLR and the SGSN and IWF. + +5813 This parameter shall not be used by the CSS. + +5814 eMLPP Subscription Data + +5815 If included in the Insert Subscriber Data request this parameter defines the priorities the subscriber might apply for a +5816 call (as defined in clause 7.6). It contains both subparameters of eMLPP. + +5817 If the VLR does not support the eMLPP service it returns its code to the HLR in the parameter SS-Code List and +5818 therefore discards the received information (no error is sent back). + +5819 eMLPP subscription data that have been stored previously in a subscriber data record in the VLR are completely +5820 replaced by the new eMLPP subscription data received in a MAP\_INSERT\_SUBSCRIBER\_DATA during either an +5821 Update Location or Restore Data procedure or a stand alone Insert Subscriber data procedure. This parameter is used +5822 only by the VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +5823 This parameter shall not be used by the CSS. + +5824 MC Subscription Data + +5825 If included in the Insert Subscriber Data request, this parameter provides the MC Subscription Data as defined in +5826 clause 7.6. + +5827 If the VLR does not support the MC service, it returns its code to the HLR in the parameter SS-Code List and therefore +5828 discards the received information (no error is sent back). + +5829 MC subscription data that have been stored previously in a subscriber data record in the VLR are completely replaced +5830 by the new MC subscription data received in a MAP\_INSERT\_SUBSCRIBER\_DATA during either an Update +5831 Location or Restore Data procedure or a stand alone Insert Subscriber data procedure. This parameter is used only by +5832 the VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +5833 This parameter shall not be used by the CSS. + +5834 Roaming Restriction Due To Unsupported Feature + +5835 The HLR may decide to include this parameter in the request if certain services or features are indicated as not +5836 supported by the MSC/VLR (e.g. Advice of Charge Charging Level). + +5837 If this parameter is sent to the VLR the MSC area is restricted by the HLR and the VLR. This parameter is used only by +5838 the VLR and if the SGSN or the IWF receives this parameter it shall ignore it. + +5839 This parameter shall not be used by the CSS. + +5840 Regional Subscription Data + +5841 If included in the Insert Subscriber Data request this parameter defines the subscriber's subscription area for the +5842 addressed VLR, for the addressed SGSN or for the addressed MME (as defined in clause 7.6). It contains the complete +5843 list of up to 10 Zone Codes that apply to a subscriber in the currently visited PLMN. The HLR shall send only those +5844 Zone Codes which are stored against the CC and NDC of the VLR, the SGSN or the MME to be updated. + +5845 NOTE 2: Support of this parameter is a network operator option and it will not be sent to networks which do not +5846 support Regional Subscription. + +5847 Regional subscription data that have been stored previously in a subscriber data record in the VLR, in the SGSN or in +5848 the MME are completely replaced by the regional subscription data received in an Insert Subscriber Data indication +5849 during either an Update Location or Restore Data procedure or a stand alone Insert Subscriber data procedure. + +5850 After the regional subscription data are inserted the VLR or the SGSN shall derive whether its location areas are +5851 allowed or not. If the whole MSC or SGSN area is restricted it will be reported to HLR by returning the Regional +5852 Subscription Response. + +5853 The VLR or the SGSN returns a Regional Subscription Response indicating that a problem with the Zone Code has +5854 been detected in one of the following cases: + +- 5855 - Too Many Zone Codes: more than 10 Zone Codes are to be stored in the VLR or in the SGSN. +- 5856 - Regional Subscription Not Supported by the VLR or the SGSN. +- 5857 - Zone Codes Conflict: the VLR or the SGSN detects that the zone codes indicate conflicting service permission +5858 for a location area. + +5859 Zone codes which have no mapping to location areas shall be ignored. + +5860 If a sequence of MAP\_INSERT\_SUBSCRIBER\_DATA services is used during a dialogue, Regional Subscription Data +5861 shall be accepted only in one service. Regional Subscription Data received in a subsequent service shall be rejected with +5862 the error Unexpected Data Value. + +5863 If Regional Subscription Data are not included in any MAP\_INSERT\_SUBSCRIBER\_DATA service, there is no +5864 restriction of roaming due to Regional Subscription. This parameter is used by the VLR, the SGSN and the IWF. + +5865 This parameter shall not be used by the CSS. + +#### 5866 Voice Broadcast Data + +5867 This parameter contains a list of group id's a user might have subscribed to; (VBS-Data is defined in clause 7.6). It +5868 includes VBS information either at location updating or at restoration or when it is changed. + +5869 At location updating, restoration or when there is a change in VBS data, the HLR shall include the complete VBS-Data. + +5870 When the VLR receives VBS-Data within a dialogue it shall replace the stored VBS-data with the received data set. All +5871 subsequent VBS-data received within this dialogue shall be interpreted as add-on data. + +5872 If VBS-data is omitted in the Insert Subscriber Data operation the VLR shall keep the previously stored VBS data. + +5873 If the VLR detects that there is overlapping in the information received within a dialogue, it shall send the error +5874 Unexpected Data Value. This parameter is used only by the VLR and if the SGSN or the IWF receives this parameter it +5875 shall ignore it. + +5876 This parameter shall not be used by the CSS. + +#### 5877 Voice Group Call Data + +5878 This parameter contains a list of group id's a user might have subscribed to; see clause 7.6. + +5879 At location updating, restoration or when there is a change in VGCS data, the HLR shall include the complete +5880 VGCS-Data. + +5881 When the VLR receives VGCS-Data within a dialogue it shall replace the stored VGCS-Data with the received data set. +5882 All VGCS-Data received within this dialogue shall be interpreted as add-on data. + +5883 If VGCS-Data is omitted in the Insert Subscriber Data operation the VLR shall keep the previously stored VGCS-Data. + +5884 If the VLR detects that there is overlapping in the information received within a dialogue, it shall send the error +5885 Unexpected Data Value. This parameter is used only by the VLR and if the SGSN or the IWF receives this parameter it +5886 shall ignore it. + +5887 This parameter shall not be used by the CSS. + +5888 North American Equal Access preferred Carrier Id List + +5889 A list of the preferred carrier identity codes that are subscribed to. + +5890 When the VLR receives this parameter from the HLR, it shall replace the previously stored preferred carrier identity +5891 codes with the received ones. It is not possible to delete all the preferred carrier identity codes from the VLR using this +5892 service. To delete all the preferred carrier identity codes from the VLR, the HLR shall use the +5893 MAP\_CANCEL\_LOCATION service. + +5894 This parameter shall not be used by the CSS. + +5895 LSA Information + +5896 If included in the ISD request, this parameter contains a list of localised service area identities a user might have +5897 subscribed to together with the priority, the preferential access indicator, the active mode support indicator and active +5898 mode indication of each localised service area; see clause 7.6. The access right outside these localised service areas is +5899 also indicated. In all cases mentioned below, the LSA information shall only include LSA Data applicable to the +5900 VPLMN where the Subscriber is located. The VLR number, received in the MAP-UPDATE\_LOCATION primitive, or +5901 the SGSN number, received in the MAP\_UPDATE\_GPRS\_LOCATION primitive, can be used, alongside data stored +5902 in the HLR, to determine the LSA Data applicable to the VPLMN. + +5903 At restoration, location updating or GPRS location updating the HLR shall include the complete set of applicable LSA +5904 Information. + +5905 When there is a change in LSA data the HLR shall include at least the new and/or modified LSA data. + +5906 When there is a change in the access right outside the localised service areas the HLR shall include the LSA only access +5907 indicator. + +5908 When the SGSN or the VLR receives LSA information within a dialogue it shall check if the received data has to be +5909 considered as the entire LSA information. If so, it shall replace the stored LSA information with the received data set, +5910 otherwise it shall replace the data only for the modified LSA data (if any) and/or access right, and add the new LSA +5911 data (if any) to the stored LSA Information. + +5912 If the entire LSA information is received, it shall always include the LSA only access indicator value together with the +5913 LSA data applicable for the PLMN (if any). + +5914 If LSA Information is omitted in the Insert Subscriber Data operation the SGSN or the VLR shall keep the previously +5915 stored LSA Information. + +5916 If the SGSN or the VLR detects that there is overlapping in the information received within a dialogue, it shall send the +5917 error Unexpected Data Value. This parameter is used by the VLR and the SGSN, and if the IWF receives this parameter +5918 it shall ignore it. + +5919 This parameter shall not be used by the CSS. + +5920 IST Alert Timer + +5921 This parameter contains the IST Alert timer value that must be used to inform the HLR about the call activities that the +5922 subscriber performs. + +5923 At Location Updating, restoration, or when there is a change in the IST data defined for the Subscriber, the HLR shall +5924 include the IST Alert timer. + +5925 This parameter shall not be used by the CSS. + +5926 LMU Identifier + +5927 This parameter indicates the presence of an LMU. This parameter is used only by the VLR and shall be ignored if +5928 received by an SGSN or an IWF. + +5929 This parameter shall not be used by the CSS. + +5930 LCS Information + +5931 This parameter provides the following LCS related information for an MS subscriber: + +5932 - list of GMLCs in the HPLMN; + +5933 - privacy exception list; + +5934 - MO-LR list. + +5935 At restoration and location updating, the HLR shall include the complete LCS data of the subscriber. + +5936 When there is a change in LCS subscriber data the HLR shall include at least the new and/or modified LCS data. LCS +5937 data that is not modified need not be included. + +5938 The VLR/SGSN shall keep any previously stored LCS Information that is not included in an Insert Subscriber Data +5939 operation. + +5940 If the VLR/SGSN detects that there is overlapping in the LCS information received within a dialogue, it shall send the +5941 error Unexpected Data Value. However, if the VLR receives the LCS code in both the LCS Information and the +5942 SS-Data List, then the VLR shall not interpret this as overlapping data. This parameter is used by the VLR and the +5943 SGSN and the IWF. + +5944 This parameter shall not be used by the CSS. + +#### 5945 Super-Charger Supported In HLR + +5946 This parameter is used by the HLR to indicate support for the Super-Charger functionality. If this parameter is present it +5947 shall include an indication of the age of the subscription data stored in the HLR. + +5948 If this parameter is absent then the HLR does not support the Super-Charger functionality. + +5949 This parameter shall not be used by the CSS. + +#### 5950 SS-Code List + +5951 The list of SS-Code parameters for the services that are provided to a subscriber but are not supported/allocated by the +5952 VLR/SGSN/IWF (SS-Code is defined in clause 7.6). The list can only include individual SS-Codes that were sent in the +5953 service request. For the VLR, this list can also include SS-Codes for the eMLPP and/or CUG services if the above +5954 mentioned conditions, as described in eMLPP Subscription Data and/or CUG information List, are met (that is, eMLPP +5955 Subscription Data and/or CUG information List are received). + +5956 This parameter shall not be used by the CSS. + +#### 5957 ICS-Indicator + +5958 This optional flag indicates to the MSC Server enhanced for ICS (see 3GPP TS 23.292 [135]) whether the MSC Server +5959 shall attempt the IMS registration. + +5960 This parameter is used by the VLR and the SGSN. + +5961 This parameter shall not be used by the CSS. + +#### 5962 CSG-Subscription Data + +5963 This parameter contains a list of CSG-Ids, the associated expiration dates (see 3GPP TS 22.011 [138]) and a list of +5964 corresponding APNs (see 3GPP TS 29.272 [144]). When the VLR or SGSN or MME receives CSG-Subscription Data +5965 from the HLR/HSS it shall replace the stored CSG-Subscription Data from the HLR/HSS (if any) with the received +5966 data. This parameter is used by the VLR and the SGSN and IWF, except the list of corresponding APNs is not +5967 applicable to the VLR, and the VLR shall ignore this list if it is received. + +5968 This parameter shall not be used by the CSS. + +#### 5969 VPLMN CSG Subscription Data + +5970 This parameter contains a list of CSG-Ids, the associated expiration dates (see 3GPP TS 22.011 [138]). When the VLR +5971 or SGSN or MME receives VPLMN CSG Subscription Data from the CSS, it shall replace the stored VPLMN-CSG +5972 Subscription Data from the CSS (if any) with the received VPLMN CSG Subscription data. This parameter is used by +5973 the VLR, the SGSN and MME. + +5974 This parameter is not applicable for the HLR/HSS, and the VLR or SGSN or IWF shall ignore this parameter if it is +5975 received from the HLR/HSS. + +5976 CSG Subscription Data from the HLR/HSS and VPLMN CSG Subscription Data from the CSS are managed +5977 independently in the VLR or SGSN or MME. If the same CSG Id exists in both CSG subscription data from the CSS +5978 and CSG subscription data from the HLR/HSS, the CSG subscription data from the HLR/HSS shall take precedence +5979 over the CSG subscription data from the CSS in further use. + +5980 UE Reachability Request Indicator + +5981 This parameter indicates by its presence that the HSS is awaiting a Notification of UE Reachability. This parameter is +5982 used by the IWF only. + +5983 This parameter shall not be used by the CSS. + +5984 MME Name + +5985 This parameter contains the MME identity used over the SGs interface (see 3GPP TS 23.003 [17] clause 19.4.2.4) when +5986 stored in the HSS. Otherwise this parameter contains the Diameter Identity of the MME (see 3GPP TS 23.003 [17]). If +5987 the subscriber is registered to EPS and the length of the MME Name does not exceed 55 octets, the HLR shall send the +5988 MME Name to the VLR during the data restoration procedure if the 'Restoration Indicator' is set in the +5989 MAP\_RESTORE\_DATA request, and during an Update Location procedure if the 'Restoration Indicator' is set in the +5990 MAP\_UPDATE\_LOCATION request. This parameter may be used by the MSC/VLR, e.g. to page the UE via SGs. + +5991 This parameter shall not be used by the CSS. + +5992 Subscribed Periodic RAU-TAU Timer + +5993 This parameter contains the subscribed periodic RAU/TAU timer (see 3GPP TS 23.401 [145] and 3GPP TS 23.060 +5994 [104]) and is used by the SGSN and MME (via IWF). The SGSN and MME shall handle the Subscribed Periodic RAU- +5995 TAU Timer as specified in clause 5.2.1.1.2 of 3GPP TS 29.272 [144]. + +5996 If the VLR receives this parameter it shall ignore it. + +5997 This parameter shall not be used by the CSS. + +5998 Subscribed Periodic LAU Timer + +5999 This parameter contains the subscribed periodic LAU timer value (see 3GPP TS 23.012 [23]) and is used by the +6000 MSC/VLR. The MSC/VLR shall handle the Subscribed Periodic LAU Timer as specified in clause 3.7.3 of 3GPP TS +6001 23.012 [23]. + +6002 If the SGSN receives this parameter it shall ignore it. + +6003 This parameter shall not be used by the CSS. + +6004 SGSN Number + +6005 This parameter contains the Identity of the SGSN (see 3GPP TS 23.003 [17]). If the subscriber is registered to GPRS, +6006 the HLR shall send the SGSN Number if available to the VLR during the data restoration procedure if the 'Restoration +6007 Indicator' is set in the MAP\_RESTORE\_DATA request, and during an Update Location procedure if the 'Restoration +6008 Indicator' is set in the MAP\_UPDATE\_LOCATION request. This parameter may be used by the MSC/VLR, e.g. to +6009 page the UE via Gs. + +6010 This parameter shall not be used by the CSS. + +6011 MDT User Consent + +6012 This parameter indicates the user consent availability for MDT activation, see 3GPP TS 32.422 [132]. This parameter is +6013 used by the VLR, the SGSN and the IWF. + +6014 This parameter shall not be used by the CSS. + +6015 PS and SMS-only Service Provision + +6016 This parameter indicates whether the subscription is for PS Only and permits CS service access only for SMS. + +6017 SMS in SGSN Allowed + +6018 This parameter indicates whether the HSS allows SMS to be provided by SGSN over NAS. + +6019 User Plane Integrity Protection Indicator + +6020 This parameter indicates by its presence that the SGSN may decide to activate integrity protection of the user plane +6021 when GERAN is used (see 3GPP TS 43.020 [24]). + +6022 If the VLR receives this parameter it shall ignore it. + +6023 DL-Buffering Suggested Packet Count + +6024 This parameter indicates a suggested DL-Buffering Packet Count. The MME (via IWF) and SGSN may take it into +6025 account in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the +6026 SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local +6027 policies only (see 3GPP TS 29.272 [144]). + +6028 If the VLR receives this parameter it shall ignore it. + +6029 Reset-IDs + +6030 This parameter contains a list of subscribed Reset-IDs. + +6031 eDRX-Cycle-Length List + +6032 This list shall contain the subscribed eDRX cycle length, along with the RAT type to which it is applicable. + +6033 IAB-Operation-Allowed-Indicator + +6034 This parameter indicates by its presence that IAB operation is authorized for the UE. See 3GPP TS 401 [145]. + +6035 Regional Subscription Response + +6036 If included in the response this parameter indicates one of: + +- 6037 - Network Node Area Restricted entirely because of regional subscription; +- 6038 - Too Many Zone Codes to be inserted; +- 6039 - Zone Codes Conflict; +- 6040 - Regional Subscription not Supported by the VLR or by the SGSN or MME. + +6041 If the VLR determines after insertion of Regional Subscription Data that the entire MSC area is restricted, the VLR +6042 shall respond with a Regional Subscription Response indicating MSC Area Restricted. Otherwise MSC Area Restricted +6043 is not sent. The HLR shall check whether the current MSC area is no longer restricted. + +6044 If the SGSN determines after insertion of Regional Subscription Data that the entire SGSN area is restricted, the SGSN +6045 shall respond with a Regional Subscription Response indicating SGSN Area Restricted. Otherwise SGSN Area +6046 Restricted is not sent. The HLR shall check whether the current SGSN area is no longer restricted. This parameter is +6047 used by the VLR, the SGSN and the IWF. + +6048 This parameter shall not be used by the CSS. + +6049 VLR CAMEL Subscription Info + +6050 This parameter is sent for subscribers who have CAMEL services which are invoked in the MSC. + +- 6051 - In CAMEL phase 1, this parameter contains only the O-CSI. +- 6052 - In CAMEL Phase 2, this parameter may contain O-CSI, SS-CSI and TIF-CSI. In CAMEL Phase 2 and onwards, +6053 TDP-Criteria for O-CSI may be associated with O-CSI. +- 6054 - In CAMEL Phase 3, this parameter may contain O-CSI, D-CSI, SS-CSI, VT-CSI, MO-SMS-CSI, M-CSI and +6055 TIF-CSI. In CAMEL Phase 3 and onwards, TDP-Criteria for VT-CSI may be associated with VT-CSI. + +6056 - In CAMEL Phase 4, this parameter may contain O-CSI, D-CSI, SS-CSI, VT-CSI, MO-SMS-CSI, MT-SMS-CSI, +6057 M-CSI and TIF-CSI. In CAMEL Phase 4, TDP-Criteria for MT-SMS-CSI may be associated with MT-SMS- +6058 CSI. + +6059 The VLR CAMEL Subscription Info is sent at location updating or when any information in the applicable CAMEL +6060 Subscription Info in the HLR has been changed. + +6061 At location updating, the complete set of VLR CAMEL Subscription Info is sent in one dialogue. + +6062 When CAMEL Subscription Information is changed in the HLR and changed data have to be sent to the VLR, then: + +6063 - for CAMEL Phase 1 and CAMEL Phase 2, the complete set of VLR CAMEL Subscription Info is sent in one +6064 dialogue; + +6065 - for CAMEL Phase 3 or higher, one or more specific elements of VLR CAMEL Subscription Info are sent in one +6066 dialogue. + +6067 When the VLR receives a specific element of VLR CAMEL Subscription Info, it shall overwrite the corresponding +6068 specific element of VLR CAMEL Subscription Info (if any) which it has stored for that subscriber. + +6069 For CAMEL Phase 1 and CAMEL Phase 2 , the VLR CAMEL Subscription Info consists of any one or more of: + +6070 - O-CSI (irrespective of the value of the "CAMEL Capability Handling" inside O-CSI),TDP-Criteria for O- +6071 CSI,SS-CSI and TIF-CSI. + +6072 (The complete set of above shall be sent even if only one CSI has changed in case of stand alone ISD. The +6073 omitted elements of above list will be withdrawn in the VLR.) + +6074 From CAMEL phase 3 onwards, the specific elements of VLR CAMEL Subscription Info which may be sent are: + +6075 O-CSI (irrespective of the value of the "CAMEL Capability Handling" inside O-CSI), TDP criteria for O-CSI, SS- +6076 CSI and TIF-CSI; + +6077 (The complete set of above shall be sent even if only one CSI has changed in case of stand alone ISD. The +6078 omitted elements of above list will be withdrawn in the VLR.) + +6079 - D-CSI; + +6080 - VT-CSI; + +6081 - TDP-Criteria for VT-CSI; + +6082 - MO-SMS-CSI; + +6083 - MT-SMS-CSI; + +6084 - TDP-Criteria for MT-SMS-CSI; + +6085 - M-CSI. + +6086 If the VLR CAMEL Subscription Info is omitted in the Insert Subscriber Data operation the VLR shall keep the +6087 previously stored VLR CAMEL Subscription Info. Within one dialogue subsequent received data are interpreted as +6088 add-on data. If the VLR detects that there is overlapping in the information received within a dialogue, it shall send the +6089 error Unexpected Data Value. This parameter is used only by the VLR and if the SGSN or IWF receives this parameter +6090 it shall ignore it. + +6091 The VLR CAMEL Subscription Info may contain the TIF-CSI (Translation Information Flag) for CAMEL Phase 2 and +6092 higher. See 3GPP TS 23.072 for the use of this parameter and the conditions for its presence. + +6093 This parameter shall not be used by the CSS. + +6094 Supported CAMEL Phases + +6095 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. This parameter is used +6096 by the VLR and SGSN. + +6097 A VLR or SGSN not supporting any CAMEL Phase may omit this parameter. An IWF shall omit this parameter. + +6098 This parameter shall not be used by the CSS. + +#### 6099 GPRS Subscription Data + +6100 This parameter contains a list of PDP-contexts a user has subscribed to; see clause 7.6. + +6101 At GPRS location updating the HLR shall include the complete GPRS Subscription Data. + +6102 When there is a change in GPRS subscriber data the HLR shall include only the new and/or modified PDP contexts. + +6103 When the SGSN receives GPRS Subscription Data within a dialogue it shall check if the received data has to be +6104 considered as the entire GPRS subscription data. If so, it shall replace the stored GPRS Subscription Data with the +6105 received data set, otherwise it shall replace the data only for the modified PDP contexts (if any) and add the new PDP +6106 contexts (if any) to the stored GPRS Subscription Data. + +6107 If GPRS Subscription Data is omitted in the Insert Subscriber Data operation the SGSN shall keep the previously stored +6108 GPRS Subscription Data. + +6109 If the SGSN detects that there is overlapping in the information received within a dialogue, it shall send the error +6110 Unexpected Data Value. This parameter is used only by the SGSN and if the VLR receives this parameter it shall ignore +6111 it. + +6112 The SGSN shall handle the SIPTO-Permission information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6113 The SGSN shall handle the SIPTO-Local-Network-Permission information as specified in 3GPP TS 29.272 [144] +6114 clause 5.2.1.1.2. + +6115 The SGSN shall handle the LIPA Permission information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6116 The SGSN shall handle the Restoration-Priority information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6117 This parameter shall not be used by the CSS. + +#### 6118 EPS Subscription Data + +6119 This parameter contains: + +- 6120 - the UE level APN-OI Replacement (see 3GPP TS 23.401 [145]), and +- 6121 - the Subscriber Profile ID for RAT/Frequency Priority (RFSP-ID) (see 3GPP TS 23.401 [145], 3GPP TS 36.413 +6122 [147] and 3GPP TS 23.060 [104]), and +- 6123 - the AMBR (see 3GPP TS 23.401 [145] and 3GPP TS 23.060 [104]), and +- 6124 - a list of APN Configurations, +- 6125 - a session transfer number for SRVCC (STN-SR) (see 3GPP TS 23.003 [17]). +- 6126 - MPS CS Priority, which by its presence indicates the UE is subscribed to the eMLPP in the CS domain. +- 6127 - MPS EPS Priority, which by its presence indicates the UE is subscribed to the MPS in the EPS domain. +- 6128 - Subscribed vSRVCC (see 3GPP 29.272 [144]). + +6129 This parameter is used only by the MME via IWF and SGSN. If the VLR receives this parameter it shall ignore it. + +6130 The MPS CS Priority and MPS EPS Priority inside the parameter are used only by the MME via IWF. If the SGSN +6131 receives them it shall ignore them. + +6132 The SGSN shall handle the SIPTO-Permission information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6133 The SGSN shall handle the SIPTO-Local-Network-Permission information as specified in 3GPP TS 29.272 [144] +6134 clause 5.2.1.1.2. + +6135 The SGSN shall handle the LIPA Permission information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6136 The SGSN shall handle the Restoration-Priority information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6137 The SGSN shall handle the WLAN-offloadability information as specified in 3GPP TS 29.272 [144] clause 5.2.1.1.2. + +6138 This parameter shall not be used by the CSS. + +6139 VPLMN LIPA Allowed + +6140 This parameter by its presence indicates that the UE is allowed to use LIPA in the PLMN where the UE is attached (see +6141 3GPP TS 23.401 [145] and 3GPP TS 23.060 [104]). + +6142 This parameter is used only by the IWF and SGSN. If the VLR receives this parameter it shall ignore it. + +6143 This parameter shall not be used by the CSS. + +6144 SGSN CAMEL Subscription Info + +6145 The SGSN CAMEL Subscription Info is sent at GPRS location updating or when any information in the applicable +6146 SGSN CAMEL Subscription Info in the HLR has been changed. + +6147 - In CAMEL Phase 3, this parameter may contain one or both of GPRS-CSI and MO-SMS-CSI. + +6148 - In CAMEL Phase 4, this parameter may contain GPRS-CSI, MO-SMS-CSI and MT-SMS-CSI and TDP-Criteria +6149 for MT-SMS-CSI. + +6150 At GPRS location updating the complete set of SGSN CAMEL Subscription Info is sent. + +6151 When CAMEL Subscription Information is changed in the HLR and changed data have to be sent to the SGSN, then +6152 one or more specific elements of SGSN CAMEL Subscription Info are sent in one dialogue. + +6153 When the SGSN receives a specific element of SGSN CAMEL Subscription Info, it shall overwrite the corresponding +6154 specific element of SGSN CAMEL Subscription Info (if any) which it has stored for that subscriber. + +6155 The specific elements of SGSN CAMEL Subscription Info which may be sent are: + +6156 - MO-SMS-CSI; + +6157 - MT-SMS-CSI; + +6158 - TDP-Criteria for MT-SMS-CSI; + +6159 - GPRS-CSI; + +6160 - MC-CSI. + +6161 This parameter is used only by the SGSN and if the VLR or IWF receives this parameter it shall ignore it. + +6162 This parameter shall not be used by the CSS. + +6163 Roaming Restricted In SGSN/MME Due To Unsupported Feature + +6164 The HSS/HLR may decide to include this parameter in the request if certain services or features are indicated as not +6165 supported by the SGSN/IWF. This parameter is used only by the SGSN and IWF and if the VLR receives this parameter +6166 it shall ignore it. + +6167 This parameter shall not be used by the CSS. + +6168 CS Allocation/Retention priority + +6169 The CS Allocation/Retention priority is used only for Circuit Switched (CS). This parameter specifies relative +6170 importance to compare with other bearers about allocation and retention of bearer. This parameter is used only by the +6171 VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +6172 This parameter shall not be used by the CSS. + +6173 Offered CAMEL 4 CSIs + +6174 This parameter indicates the CAMEL phase 4 CSIs offered in the VMSC/VLR or SGSN (see clause 7.6.3.36D). An +6175 IWF shall omit this parameter. + +6176 This parameter shall not be used by the CSS. + +6177 Subscribed Charging Characteristics + +6178 This parameter refers to the Subscribed Charging Characteristics as defined in 3GPP TS 32.251. + +6179 For a detailed description of the use of the parameter, see 3GPP TS 32.251. + +6180 This parameter is used only by the SGSN and IWF and if the VLR receives this parameter it shall ignore it. + +6181 This parameter shall not be used by the CSS. + +6182 Access Restriction Data + +6183 This parameter indicates the allowed RAT for the PLMN where the UE is attached according to subscription data. (see +6184 clause 7.6.3.97) + +6185 If the VLR/SGSN/MME supports the Access Restriction feature but does not receive the Access Restriction Data +6186 parameter from the HSS/HLR at location updating or restoration, the VLR/SGSN/MME shall assume that the +6187 subscriber's profile does not have any restrictions enabled. + +6188 For a detailed description of the use of the parameter, see 3GPP TS 23.012 [23] for the CS domain and 3GPP TS +6189 23.060[104], 3GPP TS 29.060 [105] clause 7.5.3 and 3GPP TS 29.274 [149] clause 7.3.6 for the PS domain. + +6190 This parameter shall not be used by the CSS. + +6191 Supported Features + +6192 This parameter shall be used by an IWF to forward feature support indications as received from the MME or SGSN via +6193 S6a/S6d. + +6194 This parameter shall not be used by the CSS. + +6195 CS-to-PS-SRVCC-Allowed-Indicator + +6196 This parameter indicates by its presence to the MSC Server enhanced for ICS (see 3GPP TS 23.292 [135]) that CS to +6197 PS SRVCC is subscribed. + +6198 This parameter is used by the VLR. + +6199 P-CSCF Restoration Request + +6200 This parameter indicates by its presence that the HSS requests to the SGSN or the MME (via the IWF) the execution of +6201 the HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [150], clause 5.4. + +6202 This parameter shall not be used by the CSS. + +6203 Adjacent Access Restriction Data + +6204 This parameter indicates the allowed RAT in each one of the indicated PLMN IDs, according to subscription data. + +6205 This parameter shall not be used by the CSS. + +6206 IMSI-Group-Id List + +6207 A list of IMSI-Group-Id parameters each of which identifies an IMSI-Group the subscriber belongs to. + +6208 UE Usage Type + +6209 This parameter indicates the usage characteristics of the UE that enables the selection of a specific Dedicated Core +6210 Network . It shall not be sent to VLRs and shall not be sent to SGSNs that did not indicate support of the Dedicated +6211 Core Network functionality within GPRS-Location Update. When the Insert-Subscriber-Data operation is used within +6212 an Update-GPRS-Location Dialogue, the HLR shall include this parameter if the SGSN indicated support of the +6213 Dedicated Core Network functionality and a UE Usage Type is available in the subscription data of the user. Outside +6214 the Update-Gprs-Location Dialogue the HLR shall include this parameter towards the SGSN that supports the +6215 Dedicated Core Network functionality if the value changed. + +6216 User error + +6217 Only one of the following values is applicable: + +- 6218 - Unidentified subscriber; +- 6219 - Data missing; +- 6220 - Unexpected data value. + +#### 6221 8.8.1.4 Basic service information related to supplementary services + +6222 A number of parameters that relate to supplementary services can be qualified by a Basic Service Group (or a Basic Service Group List). This clause explains how this information is to be interpreted. Supplementary service parameters to which this clause is applicable only apply to the basic service groups described in this clause, and only those basic service groups shall be overwritten at the VLR or the SGSN. + +6226 The Basic Service Group (or Basic Service Group List) is optional. + +6227 If present the Basic Service Group (or each element of the Basic Service Group List) shall be one of: + +- 6228 - an Elementary Basic Service Group for which the supplementary service is applicable to at least one basic service in the group and for which the subscriber has a subscription to at least one basic service in the group; +- 6230 - the group "All Teleservices" provided that the service is applicable to at least one teleservice and that the subscriber has a subscription to at least one teleservice which is in the same Elementary Basic Service Group as a teleservice to which the service is applicable; +- 6233 - the group "All Bearer Services" provided that the service is applicable to at least one bearer service and that the subscriber has a subscription to at least one bearer service which is in the same Elementary Basic Service Group as a basic service to which the service is applicable. + +6236 If the Basic Service Group (or Basic Service Group List) is not present then the parameter shall apply to all Basic Service Groups. + +6238 If the basic service information is not a single Elementary Basic Service Group then the parameter shall be taken as applying individually to all the Elementary Basic Service Groups for which: + +- 6240 - the supplementary service is applicable to at least one basic service in the Basic Service Group; and +- 6241 - the subscriber has a subscription to at least one basic service in the Basic Service Group. + +6242 The VLR and the SGSN are not required to store supplementary services data for Basic Service Groups which are not supported at the VLR or the SGSN respectively. + +#### 6244 8.8.2 MAP-DELETE-SUBSCRIBER-DATA service + +##### 6245 8.8.2.1 Definition + +6246 This service is used by an HLR to remove certain subscriber data from a VLR or SGSN if the subscription of one or more supplementary services or basic services is withdrawn. Note that this service is not used in case of erasure or deactivation of supplementary services. + +6249 This service is also used by an HLR to remove GPRS subscription data from an SGSN. + +6250 This service is also used by an HSS via IWF to remove EPS subscription data from an MME. + +6251 This service is also used by a CSS to remove the CSG subscription data from an MME via IWF or a VLR/SGSN. + +6252 + +6253 It is a confirmed service and consists of the primitives shown in table 8.8/2. + +##### 6254 8.8.2.2 Service primitives + +**Table 8.8/2: MAP-DELETE-SUBSCRIBER-DATA** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------------------------|----------------|-------------------|-----------------|----------------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| Basic service List | C | C(=) | | | +| SS-Code List | C | C(=) | | | +| Roaming Restriction Due To | | | | | +| Unsupported Feature | C | C(=) | | | +| Camel Subscription Info Withdraw | C | C(=) | | | +| Specific CSI Withdraw | C | C(=) | | | +| Regional Subscription Data | C | C(=) | | | +| VBS Group Indication | C | C(=) | | | +| VGCS Group Indication | C | C(=) | | | +| GPRS Subscription Data Withdraw | C | C(=) | | | +| EPS Subscription Data Withdraw | C | C(=) | | | +| Roaming Restricted In SGSN/MME Due To | C | C(=) | | | +| Unsupported Feature | | | | | +| LSA Information Withdraw | C | C(=) | | | +| IST Information Withdraw | C | C(=) | | | +| Regional Subscription Response | | | C | C(=) | +| GMLC List Withdraw | C | C(=) | | | +| Subscribed Charging Characteristics | C | C(=) | | | +| Withdraw | | | | | +| CSG Information Deleted | C | C(=) | | | +| VPLMN CSG Information Deleted | C | C(=) | | | +| APN-OI-Replacement Withdraw | C | C(=) | | | +| STN-SR Withdraw | C | C(=) | | | +| Subscribed vSRVCC Withdraw | C | C(=) | | | +| Subscribed Periodic RAU-TAU Timer | C | C(=) | | | +| Withdraw | | | | | +| Subscribed Periodic LAU Timer Withdraw | C | C(=) | | | +| Additional MSISDN Withdraw | C | C(=) | | | +| CS-to-PS-SRVCC Withdraw | C | C(=) | | | +| User Plane Integrity Protection Withdraw | C | C(=) | | | +| DL-Buffering Suggested Packet Count | C | C(=) | | | +| Withdraw | | | | | +| UE-Usage-Type Withdraw | C | C(=) | | | +| Reset-IDs Withdraw | C | C(=) | | | +| IAB-Operation-Withdraw | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6256 + +6257 **8.8.2.3 Parameter use** + +6258 All parameters are described in clause 7.6. The following clarifications are applicable: + +6259 Basic service List + +6260 A list of Extensible Basic service parameters (Extensible Basic service is defined in clause 7.6). It is used when one, +6261 several or all basic services are to be withdrawn from the subscriber. If the VLR or the SGSN receives a value for an +6262 Extensible Basic Service which it does not support, it shall ignore that value. This parameter is used by the VLR and by +6263 the SGSN; if the IWF receives this parameter it shall ignore it. + +6264 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6265 from the CSS. + +6266 SS-Code List + +6267 A list of SS-Code parameters (SS-Code is defined in clause 7.6). It is used when several or all supplementary services +6268 are to be withdrawn from the subscriber. + +6269 There are three possible options: + +6270 - deletion of basic service(s); + +6271 The parameter Basic service List is only included. + +6272 - deletion of supplementary service(s); + +6273 The parameter SS-Code List is only included. + +6274 - deletion of basic and supplementary services; + +6275 Both Basic service List and SS-Code List are included. + +6276 This parameter is used by the VLR and SGSN and IWF for Call Barring and LCS. Otherwise, this parameter is used +6277 only by the VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +6278 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6279 from the CSS. + +#### 6280 Roaming Restriction Due To Unsupported Feature + +6281 This parameter is used if Roaming Restriction Due To Unsupported Feature is deleted from the subscriber data. This +6282 may occur if unsupported features or services are removed from the subscriber data in the HLR. + +6283 If this parameter is sent the VLR shall check if the current Location Area is possibly allowed now. This parameter is +6284 used only by the VLR and if the SGSN or IWF receives this parameter it shall ignore it. + +6285 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6286 from the CSS. + +#### 6287 CAMEL Subscription Info Withdraw + +6288 This parameter is used to indicate that CAMEL Subscription Info shall be deleted from the VLR or from the SGSN. All +6289 CAMEL Subscription Info for the subscriber shall be deleted. This parameter is used by the VLR and by the SGSN. +6290 This parameter should not be sent in the same message as the Specific CSI Withdraw parameter; if the IWF receives +6291 this parameter it shall ignore it. + +6292 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6293 from the CSS. + +#### 6294 Specific CSI Withdraw + +6295 This parameter is used to indicate that one or more specific elements of CAMEL Subscription Info shall be deleted from +6296 the VLR or from the SGSN. + +6297 The specific elements of CAMEL Subscription Info which may be withdrawn are: + +6298 - O-CSI with TDP criteria for O-CSI; + +6299 - SS-CSI; + +6300 - TIF-CSI; + +6301 - D-CSI; + +6302 - VT-CSI with TDP criteria for VT-CSI; + +6303 - MO-SMS-CSI; + +6304 - MT-SMS-CSI with TDP-Criteria for MT-SMS-CSI; + +6305 - M-CSI; + +6306 - MG-CSI; + +6307 - GPRS-CSI. + +6308 This parameter is used by the VLR and by the SGSN; if the IWF receives this parameter it shall ignore it. It shall not be +6309 sent to VLRs that do not support CAMEL phase 3 or higher. This parameter should not be sent in the same message as +6310 the CAMEL Subscription Info Withdraw parameter. + +6311 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6312 from the CSS. + +#### 6313 Regional Subscription Identifier + +6314 Contains one single Zone Code (as defined in clause 7.6) and is used if all Zone Codes shall be deleted from the +6315 subscriber data. When all the Zone Codes are deleted, the VLR, the SGSN or the MME shall check for its location areas +6316 whether they are allowed or not. If the whole Network Node area is restricted, the VLR, the SGSN or the MME (via the +6317 IWF) will report it to HLR by returning the Regional Subscription Response "Network Node Area Restricted". + +6318 The binary coding of the Zone Code value received in a Delete Subscriber Data request shall not be checked by the +6319 VLR, the SGSN or the MME. + +6320 Note that support of this parameter is a network operator option and it shall not be sent to networks which do not +6321 support Regional Subscription. + +6322 If Regional Subscription is not supported by the VLR, the SGSN or the MME, the request for deletion of Zone Codes is +6323 refused by sending the Regional Subscription Response "Regional Subscription Not Supported" to the HLR. + +6324 If no Zone Codes are stored in the respective subscriber data record, the request for deleting all Zone Code information +6325 shall be ignored and no Regional Subscription Response shall be returned. This parameter is used by the VLR, the +6326 SGSN and the MME. + +6327 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6328 from the CSS. + +#### 6329 VBS Group Indication + +6330 Contains an indication (flag) which is used if all Group Ids shall be deleted from the subscriber data for the Voice +6331 Broadcast teleservice. + +6332 If VBS is not supported in the VLR or no Group Ids are stored for VBS in the respective subscriber record, the request +6333 for deletion of all Group Ids shall be ignored. This parameter is used only by the VLR and if the SGSN or the IWF +6334 receives this parameter it shall ignore it. + +6335 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6336 from the CSS. + +#### 6337 VGCS Group Indication + +6338 Contains an indication (flag) which is used if all Group Id's shall be deleted from the subscriber data for the Voice +6339 Group Call teleservice. This parameter is used only by the VLR and if the SGSN receives this parameter it shall ignore +6340 it. + +6341 If VGCS is not supported in the VLR or no Group Ids are stored for VGCS in the respective subscriber record, the +6342 request for deletion of all Group Ids shall be ignored. + +6343 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6344 from the CSS. + +#### 6345 GPRS Subscription Data Withdraw + +6346 This parameter is used to indicate whether all GPRS Subscription Data for the subscriber shall be deleted or if only a +6347 subset of the stored GPRS Subscription Data for the subscriber shall be deleted. In the latter case only those PDP +6348 contexts whose identifiers are included in the subsequent identifier list will be deleted. This parameter is used only by +6349 the SGSN and if the VLR receives this parameter it shall ignore it. + +6350 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6351 from the CSS. + +#### 6352 EPS Subscription Data Withdraw + +6353 This parameter is used to indicate whether all EPS Subscription Data for the subscriber shall be deleted or if only a +6354 subset of the stored EPS Subscription Data for the subscriber shall be deleted. In the latter case, only those APN +6355 Configurations whose identifiers are included in the subsequent identifier list will be deleted. This parameter is used +6356 only by the SGSN and the MME and if the VLR receives this parameter it shall ignore it. + +6357 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6358 from the CSS. + +#### 6359 Roaming Restricted In SGSN/MME Due To Unsupported Feature + +6360 This parameter is used if Roaming Restricted In SGSN/MME Due To Unsupported Feature is deleted from the +6361 GPRS/EPS subscriber data. This may occur if unsupported features or services are removed from the GPRS/EPS +6362 subscriber data in the HLR. + +6363 If this parameter is sent the SGSN shall check if the current Location Area is possibly allowed now. This parameter is +6364 used only by the SGSN and the IWF and if the VLR receives this parameter it shall ignore it. + +6365 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6366 from the CSS. + +#### 6367 LSA Information Withdraw + +6368 This parameter is used to indicate whether all LSA Information for the subscriber shall be deleted or if only a subset of +6369 the stored LSA Information for the subscriber shall be deleted. In the latter case only the LSA data whose LSA +6370 identities are included in the subsequent LSA data list will be deleted. This parameter is used by the VLR and the +6371 SGSN. + +6372 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6373 from the CSS. + +#### 6374 IST Information Withdraw + +6375 This parameter is used to indicate that the IST condition has been removed for the subscriber. See 3GPP TS 43.035 for +6376 the use of this parameter. + +6377 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6378 from the CSS. + +#### 6379 Regional Subscription Response + +6380 If included in the Delete Subscriber Data response this parameter indicates one of: + +6381 - Network Node Area Restricted; + +6382 - Regional Subscription Not Supported. + +6383 This parameter is used by the VLR, the SGSN and the IWF. + +6384 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6385 from the CSS. + +#### 6386 GMLC List Withdraw + +6387 This parameter indicates that the subscriber's LCS GMLC List shall be deleted from the VLR or SGSN. This parameter +6388 is used by the VLR and the SGSN and IWF. + +6389 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6390 from the CSS. + +#### 6391 Subscribed Charging Characteristics Withdraw + +6392 This parameter indicates that the Subscribed Charging Characteristics shall be replaced with a local default value in the +6393 SGSN or in the MME (see 3GPP TS 32.251). + +6394 This parameter is used only by the SGSN and the IWF and if the VLR receives this parameter it shall ignore it. + +6395 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6396 from the CSS. + +6397 CSG Information Deleted + +6398 This parameter indicates that CSG Subscription Information received from the HLR/HSS shall be deleted from VLR, +6399 SGSN, or MME. + +6400 This parameter is used by the VLR, SGSN and the IWF. This parameter is not applicable for the CSS and the VLR or +6401 SGSN or IWF shall ignore this parameter if it is received from the CSS. + +6402 VPLMN CSG Information Deleted + +6403 This parameter indicates that CSG Subscription Information received from the CSS shall be deleted from VLR, SGSN. +6404 This parameter is used by the VLR and SGSN. This parameter is not applicable for the HLR/HSS and the VLR or +6405 SGSN or IWF shall ignore this parameter if it is received from the HLR/HSS. + +6406 APN-OI-Replacement Withdraw + +6407 This parameter indicates that APN-OI-Replacement shall be deleted from the SGSN or the MME. + +6408 This parameter is used by the SGSN and the IWF and if the VLR receives this parameter it shall ignore it. This +6409 parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received from +6410 the CSS. + +6411 STN-SR Withdraw + +6412 This parameter indicates that STN-SR shall be deleted from the SGSN or the MME. + +6413 This parameter is used by the SGSN and the IWF and if the VLR receives this parameter it shall ignore it. This +6414 parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received from +6415 the CSS. + +6416 Subscribed vSRVCC Withdraw + +6417 This parameter indicates that Subscribed vSRVCC shall be deleted from the MME. + +6418 This parameter is used by the MME and the IWF and if the SGSN or VLR receives this parameter it shall ignore it. + +6419 This parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received +6420 from the CSS. + +6421 Subscribed Periodic RAU-TAU Timer Withdraw + +6422 This parameter indicates that Subscribed Periodic RAU-TAU Timer value shall be deleted from the SGSN or the MME. + +6423 This parameter is used by the SGSN and the IWF and if the VLR receives this parameter it shall ignore it. This + +6424 parameter is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received from +6425 the CSS. + +6426 Subscribed Periodic LAU Timer Withdraw + +6427 This parameter indicates that Subscribed Periodic LAU Timer value shall be deleted from the VLR. + +6428 This parameter is used by the VLR and if the MME or SGSN receives this parameter it shall ignore it. This parameter +6429 is not applicable for the CSS and the VLR or SGSN or IWF shall ignore this parameter if it is received from the CSS. + +6430 Additional MSISDN Withdraw + +6431 This parameter indicates that Additional MSISDN shall be deleted from the SGSN or MME. + +6432 This parameter is used by the SGSN and the IWF. + +6433 CS-to-PS-SRVCC Withdraw + +6434 This parameter indicates by its presence that CS to PS SRVCC is no longer subscribed. + +6435 User Plane Integrity Protection Withdraw + +6436 This parameter indicates by its presence that User Plane Integrity Protection may no longer be required. + +6437 DL-Buffering Suggested Packet Count Withdraw + +6438 This parameter indicates by its presence that a suggested DL-Buffering Packet Count is no longer subscribed. + +6439 UE-Usage-Type Withdraw + +6440 This parameter indicates by its presence that a UE-Usage-Type is no longer subscribed. + +6441 This parameter is not applicable for VLRs. + +6442 The HLR shall include this parameter towards the SGSN or MME (via IWF) that supports the Dedicated Core Network + +6443 functionality if the subscription to a UE-Usage-Type is removed. + +6444 Reset-IDs Withdraw + +6445 This parameter indicates by its presence that Reset-IDs are no longer subscribed. + +6446 IAB-Operation-Withdraw + +6447 This parameter indicates by its presence that IAB operation is no longer authorized for the UE. + +6448 User error + +6449 Only one of the following values is applicable: + +6450 - Unidentified subscriber; + +6451 - Data missing; + +6452 - Unexpected data value. + +6453 **8.9 Identity management services** + +6454 **8.9.1 MAP-PROVIDE-IMSI service** + +6455 **8.9.1.1 Definition** + +6456 This service is used by a VLR in order to get, via the MSC, the IMSI of a subscriber (e.g. when a subscriber has + +6457 identified itself with a TMSI not allocated to any subscriber in the VLR). + +6458 It is a confirmed service and consists of the primitives shown in table 8.9/1. + +6459 **8.9.1.2 Service primitives** + +6460 **Table 8.9/1: MAP-PROVIDE-IMSI** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6461 + +6462 **8.9.1.3 Parameter use** + +6463 All parameters are described in clause 7.6. The following clarifications are applicable: + +6464 IMSI + +6465 This parameter is received when the request is successfully carried out. It contains the requested IMSI. + +6466 User error + +6467 Only one of the following values is applicable: + +6468 - Absent subscriber. + +6469 **8.9.2 MAP-FORWARD-NEW-TMSI service** + +### 6470 8.9.2.1 Definition + +6471 This service is used by a VLR to allocate, via MSC, a new TMSI to a subscriber during an ongoing transaction (e.g. call +6472 set-up, location updating or supplementary services operation). + +6473 It is a confirmed service and consists of the primitives shown in table 8.9/2. + +### 6474 8.9.2.2 Service primitives + +6475 **Table 8.9/2: MAP-FORWARD-NEW-TMSI** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| TMSI | M | M(=) | | | +| Provider error | | | | O | + +6476 + +### 6477 8.9.2.3 Parameter use + +6478 The parameter TMSI is described in clause 7.6. + +## 6479 8.10 Fault recovery services + +### 6480 8.10.1 MAP\_RESET service + +#### 6481 8.10.1.1 Definition + +6482 This service is used by the HSS/HLR or CSS, after a restart, to indicate to a list of VLRs, SGSNs or MMEs (via IWF) +6483 that a failure occurred. + +6484 This service may also be used by the HSS/HLR as part of operation and maintenance actions e.g. to allow planned +6485 HLR/HSS outage without service interruption, or to update subscription data shared by multiple subscribers. + +6486 The MAP\_RESET service is a non-confirmed service using the service primitives defined in table 8.10/1. + +#### 6487 8.10.1.2 Service primitives + +6488 **Table 8.10/1: MAP\_RESET** + +| Parameter name | Request | Indication | +|-------------------------------|---------|------------| +| Invoke Id | M | M(=) | +| Sending Node
Number | M | M(=) | +| HLR Id LIST | U | C(=) | +| Reset-ID LIST | C | C(=) | +| Subscription Data | C | C(=) | +| Subscription Data
Deletion | C | C(=) | + +6489 + +#### 6490 8.10.1.3 Parameter definition and use + +##### 6491 Invoke Id + +6492 See definition in clause 7.6.1. + +##### 6493 SendingNode Number + +6494 For a restart of the HLR/HSS, this parameter shall contain the HLR number. See definition in clause 7.6.2. + +6495 For a restart of the CSS, this parameter shall contain the CSS number. See definition in clause 7.6.2. + +6496 HLR Id LIST + +6497 The HLR Id List is a list of HLR Ids. If the parameter is present in the indication, the VLR, the SGSN or the MME may +6498 base the retrieval of subscribers to be restored on their IMSI: the subscribers affected by the reset are those whose IMSI +6499 leading digits are equal to one of these numbers. If the parameter and the Reset-ID List is absent, subscribers to be +6500 restored are those for which the OriginatingEntityNumber received at location updating time matches the equivalent +6501 parameter of the Reset Indication. + +6502 This parameter shall only be applicable for a restart of the HLR/HSS. It shall not be present if Reset-ID LIST is present. + +6503 Reset-ID LIST + +6504 The Reset-ID LIST is a list of Reset-IDs. It shall not be present if Reset-IDs are not supported by the HLR/HSS and by +6505 the VLR or SGSN or MME (via IWF). If the parameter is present in the indication, the VLR, the SGSN or the MME +6506 may base the retrieval of affected subscribers (i.e. those impacted by the restoration or by the shared data update) on +6507 their subscribed Reset-IDs: The subscribers affected by the reset are those whose subscription contains at least one of +6508 these Reset-IDs. + +6509 Subscription Data + +6510 If the Reset Procedure is used to add/ modify subscription data shared by multiple subscribers, this Information Element +6511 shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the VLR, +6512 MME or SGSN or combined MME/SGSN or is replacing a part of the subscription profiles of the impacted subscribers +6513 stored in the VLR, MME or SGSN. + +6514 Shall be absent if Subscription Data Deletion is present. + +6515 Shall be absent if Reset-ID LIST is absent + +6516 Subscription Data Deletion + +6517 If the Reset Procedure is used to delete subscription data shared by multiple subscribers, this Information Element shall +6518 contain the identifications of the part of the subscription profile that is to be deleted from the subscription profiles of the +6519 impacted subscribers stored in the VLR, MME or SGSN. + +6520 Shall be absent if Subscription Data is present. + +6521 Shall be absent if Reset-ID LIST is absent + +6522 + +## 6523 8.10.2 MAP\_FORWARD\_CHECK\_SS\_INDICATION service + +### 6524 8.10.2.1 Definition + +6525 This service may be used by an HLR as an implementation option, to indicate to a mobile subscriber that supplementary +6526 services parameters may have been altered, e.g. due to a restart. If received from the HLR, the VLR shall forward this +6527 indication to the MSC, which in turn forwards it to the MS. The HLR only sends this indication after successful +6528 completion of the subscriber data retrieval from HLR to VLR that ran embedded in a MAP\_UPDATE\_LOCATION +6529 procedure. + +6530 The MAP\_FORWARD\_CHECK\_SS\_INDICATION service is a non-confirmed service using the service primitives +6531 defined in table 8.10/2. + +### 6532 8.10.2.2 Service primitives + +6533 **Table 8.10/2: MAP\_FORWARD\_CHECK\_SS\_INDICATION** + +| Parameter name | Request | Indication | +|----------------|---------|------------| +| Invoke Id | M | M(=) | + +6534 + +### 6535 8.10.2.3 Parameter definition and use + +6536 Invoke Id + +6537 See definition in clause 7.6.1. + +## 6538 8.10.3 MAP\_RESTORE\_DATA service + +### 6539 8.10.3.1 Definition + +6540 This service is invoked by the VLR on receipt of a MAP\_PROVIDE\_ROAMING\_NUMBER indication for an + +6541 unknown IMSI, or for a known IMSI with the indicator "Subscriber Data Confirmed by HLR" set to "Not confirmed". + +6542 The service is used to update the LMSI in the HLR, if provided, and to request the HLR to send all data to the VLR that + +6543 are to be stored in the subscriber's IMSI record. + +6544 This service may be invoked by the VLR on receipt of a "MAP-MT-FORWARD-SHORT-MESSAGE" message for an + +6545 unknown IMSI, or for a known IMSI with the indicator "Subscriber Data Confirmed by HLR" set to "Not confirmed". + +6546 The service is used to update the LMSI in the HLR, if provided, and to request the HLR to send all data to the VLR that + +6547 are to be stored in the subscriber's IMSI record. + +6548 The HLR shall return the error "system failure" to the VLR if the subscriber is not registered on the VLR. + +6549 The MAP\_RESTORE\_DATA service is a confirmed service using the service primitives defined in table 8.10/3. + +### 6550 8.10.3.2 Service primitives + +6551 + +**Table 8.10/3: MAP\_RESTORE\_DATA** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| LMSI | U | C(=) | | | +| Supported CAMEL phases | C | C(=) | | | +| SoLSA Support Indicator | C | C(=) | | | +| IST Support Indicator | C | C(=) | | | +| Super-Charger Supported in Serving Network Entity | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Supported LCS Capability Sets | C | C(=) | | | +| Offered CAMEL 4 CSIs | C | C(=) | | | +| Restoration Indicator | U | C(=) | | | +| Supported RAT Types Indicator | U | C(=) | | | +| MTRF Supported | U | C(=) | | | +| MSISDN-less Operation Supported | C | C(=) | | | +| HLR number | | | C | C(=) | +| MS Not Reachable Flag | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6552 + +### 6553 8.10.3.3 Parameter definitions and use + +6554 Invoke Id + +6555 See definition in clause 7.6.1. + +6556 IMSI + +6557 See definition in clause 7.6.2. + +6558 LMSI + +6559 See definition in clause 7.6.2. It is an operator option to provide the LMSI from the VLR; it is mandatory for the HLR +6560 to support the LMSI handling procedures. + +6561 Supported CAMEL Phases + +6562 This parameter indicates which phases of CAMEL are supported. Must be present if a CAMEL phase different from +6563 phase 1 is supported. Otherwise may be absent. + +6564 SoLSA Support Indicator + +6565 This parameter is used by the VLR to indicate to the HLR in the Restore Data indication that SoLSA is supported. If +6566 this parameter is not included in the Restore Data indication then the HLR shall not perform any specific error handling. + +6567 This SoLSA Support Indicator shall be stored by the HLR per VLR where there are Subscribers roaming. If a +6568 Subscriber is marked as only allowed to roam in Subscribed LSAs while roaming in a VLR and no SoLSA Support +6569 indicator is stored for that VLR, the location status of that Subscriber shall be set to Restricted. + +6570 IST Support Indicator + +6571 This parameter is used to indicate to the HLR that the VMSC supports basic IST functionality, that is, the VMSC is able +6572 to terminate the Subscriber Call Activity that originated the IST Alert when it receives the IST alert response indicating +6573 that the call(s) shall be terminated. If this parameter is not included in the Restore Data indication and the Subscriber is +6574 marked as an IST Subscriber, then the HLR may limit the service for the subscriber (by inducing an Operator +6575 Determined barring of Outgoing calls), or allow service assuming the associated risk of not having the basic IST +6576 mechanism available. + +6577 This parameter can also indicate that the VMSC supports the IST Command service, including the ability to terminate +6578 all calls being carried for the identified subscriber by using the IMSI as a key. If this additional capability is not +6579 included in the Restore Data indication and the HLR supports the IST Command capability, then the HLR may limit the +6580 service for the subscriber (by inducing an Operator Determined barring of Outgoing calls), or allow service assuming +6581 the associated risk of not having the IST Command mechanism available. + +6582 Long FTN Supported + +6583 This parameter indicates that the VLR supports Long Forwarded-to Numbers. + +6584 Super-Charger Supported in Serving Network Entity + +6585 This parameter is used by the VLR to indicate to the HLR that the VLR supports the Super-Charger functionality and +6586 that subscriber data is required. + +6587 If this parameter is absent then the VLR does not support the Super-Charger functionality. + +6588 Supported LCS Capability Sets + +6589 This parameter indicates, if present, the capability sets of LCS which are supported. If the parameter is sent but no +6590 capability set is marked as supported then the VLR does not support LCS at all. + +6591 If this parameter is absent then the VLR may support at most LCS capability set 1, that is LCS Release98 or Release99 +6592 version. + +6593 Offered CAMEL 4 CSIs + +6594 This parameter indicates the CAMEL phase 4 CSIs offered in the VMSC/VLR (see clause 7.6.3.36D). + +6595 Restoration Indicator + +6596 This parameter indicates, if present, that the HLR shall send in the MAP-INSERT-SUBSCRIBER-DATA the MME +6597 Name if the subscriber is registered to EPS, or the SGSN Number if available and if the subscriber is registered to +6598 GPRS. The VLR may set this indicator if it supports Gs or SG interfaces. + +6599 Supported RAT Types Indicator + +6600 This parameter indicates, if present, which access technologies (e.g. GERAN and / or UTRAN) are served by the +6601 MSC/VLR (see clause 7.6.3) + +6602 MTRF Supported + +6603 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +6604 MSISDN-less Operation Supported + +6605 See clause 3.6.1.5 of 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +6606 HLR number + +6607 See definition in clause 7.6.2. The presence of this parameter is mandatory in case of successful outcome of the service. + +6608 MS Not Reachable Flag + +6609 See definition in clause 7.6.8. This parameter shall be present in case of successful outcome of the service, if the "MS +6610 Not Reachable flag" was set in the HLR. + +6611 User error + +6612 In case of unsuccessful outcome of the service, an error cause shall be returned by the HLR. The following error causes +6613 defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 6614 - unknown subscriber; +- 6615 - system failure; +- 6616 - unexpected data value; +- 6617 - data missing. + +6618 Provider error + +6619 For definition of provider errors see clause 7.6.1. + +## 6620 8.11 Subscriber Information services + +### 6621 8.11.1 MAP-ANY-TIME-INTERROGATION service + +#### 6622 8.11.1.1 Definition + +6623 This service is used by the gsmSCF, to request information (e.g. subscriber state and location) from the HLR or the +6624 GMLC at any time. This service may also be used by the gsmSCF to request the Mobile Number Portability (MNP) +6625 information from the NPLR. + +6626 This service is also used by the Presence Network Agent to request information, (e.g. subscriber state and location) +6627 about the subscriber (associated with a presentity) from the HLR at any time (see 3GPP TS 23.141 [128]). + +6628 When this service is used to the HLR, the subscriber state, location, Time Zone, or T-ADS data may be requested. + +6629 When this service is used to the GMLC, only the location may be requested. + +6630 When this service is used to the NPLR, only the MNP information may be requested. + +6631 The MAP-ANY-TIME-INTERROGATION service is a confirmed service using the service primitives defined in +6632 table 8.11/1. + +#### 6633 8.11.1.2 Service primitives + +6634 **Table 8.11/1: Any\_Time\_Interrogation** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Requested Info | M | M(=) | | | +| Requested domain | C | C(=) | | | + +| | | | | | +|----------------------------------------------|---|------|---|------| +| MNP Requested Info | C | C(=) | | | +| gsmSCF-Address | M | M(=) | | | +| IMSI | C | C(=) | | | +| MSISDN | C | C(=) | | | +| Location Information | | | C | C(=) | +| Location Information for GPRS | | | C | C(=) | +| Location Information for EPS | | | C | C(=) | +| Subscriber State | | | C | C(=) | +| PS Subscriber State | | | C | C(=) | +| EPS Subscriber State | | | C | C(=) | +| IMEI | | | C | C(=) | +| MS Classmark 2 | | | C | C(=) | +| GPRS MS Class | | | C | C(=) | +| MNP info Result | | | C | C(=) | +| IMS Voice Over PS Sessions Support Indicator | | | C | C(=) | +| Last UE Activity Time | | | C | C(=) | +| Last RAT Type | | | C | C(=) | +| Time Zone | | | C | C(=) | +| Daylight Saving Time | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6635 + +### 6636 8.11.1.3 Parameter definition and use + +6637 All parameters are described in clause 7.6. The use of these parameters and the requirements for their presence are +6638 specified in 3GPP TS 23.018 [97] and 3GPP TS 23.078 [98]. + +6639 The HLR or GMLC may be able to use the value of the parameter gsmSCF-address to screen a +6640 MAP\_Any\_Time\_Interrogation indication. + +6641 The use of the parameters and the requirements for their presence are specified in 3GPP TS 23.078 [98]. + +#### 6642 IMS Voice Over PS Sessions Support Indicator + +6643 This parameter indicates the most recent IMS-Voice-Over-PS-Sessions support (based on the Last UE Activity Time), +6644 as received from the serving nodes. This parameter shall be present if Requested Info indicates that T-ADS Data are +6645 requested. + +#### 6646 Last UE Activity Time + +6647 This parameter indicates the most recent available point in time of the UE's last radio contact, as received from the +6648 serving nodes. This value may not represent the absolute last instant of radio activity of the UE, when any of the serving +6649 nodes has not answered to the T-ADS query. This parameter may be present if requested Info indicates that T-ADS +6650 Data are requested. This value may not be available when all the serving nodes have indicated an homogeneous support +6651 or an homogeneous non support of IMS Voice Over PS Sessions, since in that case, the serving nodes do not need to be +6652 explicitly asked for T-ADS Data. + +#### 6653 Last RAT Type + +6654 This parameter indicates the most recent available RAT Type of the access (based on the Last UE Activity Time), as +6655 received from the serving nodes. This parameter shall be present if requested Info indicates that T-ADS Data are +6656 requested and the IMS Voice Over PS Sessions Support Indicator does not take the value "unknown". This value may +6657 not represent the absolute last RAT Type of the UE, when any of the serving nodes has not answered to the T-ADS +6658 query. This parameter may be present if requested Info indicates that T-ADS Data are requested. This value may not be +6659 available when all the serving nodes have indicated an homogeneous support or an homogeneous non support of IMS +6660 Voice Over PS Sessions, since in that case, the serving nodes do not need to be explicitly asked for T-ADS Data. + +#### 6661 Time Zone + +6662 This parameter indicates the Time Zone of the location in the visited network where the UE is attached, including any +6663 adjustment for summertime (daylight saving time). + +6664 Daylight Saving Time + +6665 This parameter indicates the Daylight Saving Time (in steps of 1 hour) used to adjust for summertime the time zone of +6666 the location where the UE is attached in the visited network. + +6667 User error + +6668 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 6669 - System Failure; +- 6670 - Any Time Interrogation Not Allowed; +- 6671 - Data Missing; +- 6672 - Unexpected Data Value; +- 6673 - Unknown Subscriber. + +6674 Provider error + +6675 These are defined in clause 7.6.1. + +## 6676 8.11.2 MAP-PROVIDE-SUBSCRIBER-INFO service + +### 6677 8.11.2.1 Definition + +6678 This service is used to request information (e.g. subscriber state and location) from the VLR, SGSN or MME (via an +6679 IWF) at any time. + +6680 The MAP-PROVIDE-SUBSCRIBER-INFO service is a confirmed service using the primitives defined in table 8.11/2. + +### 6681 8.11.2.2 Service primitives + +6682 **Table 8.11/2: Provide\_Subscriber\_Information** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Requested Info | M | M(=) | | | +| IMSI | M | M(=) | | | +| LMSI | U | O | | | +| Call Priority | U | O | | | +| Location Information | | | C | C(=) | +| Location Information for GPRS | | | C | C(=) | +| Subscriber State | | | C | C(=) | +| PS Subscriber State | | | C | C(=) | +| IMEI | | | C | C(=) | +| MS Classmark 2 | | | C | C(=) | +| GPRS MS Class | | | C | C(=) | +| IMS Voice Over PS Sessions Support Indicator | | | C | C(=) | +| Last UE Activity Time | | | C | C(=) | +| Last RAT Type | | | C | C(=) | +| Location Information for EPS | | | C | C(=) | +| Time Zone | | | C | C(=) | +| Daylight Saving Time | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6683 + +### 6684 8.11.2.3 Parameter definition and use + +6685 All parameters are defined in clause 7.6. The use of these parameters and the requirements for their presence are +6686 specified in 3GPP TS 23.018 [97] and 3GPP TS 23.078 [98]. + +#### 6687 Call Priority + +6688 This parameter indicates the eMLPP priority of the call (see 3GPP TS 24.067 [137]). This parameter should be present +6689 if the HLR supports this parameter and if the Call Priority was received in the +6690 MAP\_SEND\_ROUTING\_INFORMATION request. + +#### 6691 IMS Voice Over PS Sessions Support Indicator + +6692 This parameter indicates whether IMS Voice Over PS Sessions is supported at the UE's current Routing Area. This +6693 parameter shall be present if the UE's current Routing Area is known to the SGSN and the Requested Info indicates that +6694 T-ADS Data are requested; otherwise it shall be absent. + +#### 6695 Last UE Activity Time + +6696 This parameter indicates the point in time of the UE's last radio contact. This parameter shall be present if requested +6697 Info indicates that T-ADS Data are request. + +#### 6698 Last RAT Type + +6699 This parameter indicates the RAT Type of the access where the UE was present at the time of the last radio contact. +6700 This parameter shall be present if requested Info indicates that T-ADS Data are request. + +#### 6701 Time Zone + +6702 This parameter indicates the Time Zone of the location in the visited network where the UE is attached, including any +6703 adjustment for summertime (daylight saving time). + +#### 6704 Daylight Saving Time + +6705 This parameter indicates the Daylight Saving Time (in steps of 1 hour) used to adjust for summertime the time zone of +6706 the location where the UE is attached in the visited network. + +#### 6707 User error + +6708 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +6709 - Data Missing; + +6710 - Unexpected Data Value. + +6711 If the subscriber is not found on the VLR, SGSN or MME, this may be indicated to the requester with the "Unexpected +6712 Subscriber" value inside the Unexpected Data Value error + +#### 6713 Provider error + +6714 These are defined in clause 7.6.1. + +### 6715 8.11.3 MAP-ANY-TIME-SUBSCRIPTION-INTERROGATION service + +#### 6716 8.11.3.1 Definition + +6717 This service is used by the gsmSCF, to request subscription information (e.g. call forwarding supplementary service +6718 data or CSI) from the HLR at any time. In an IP Multimedia Core Network, an IM-SSF can take on the role of a +6719 gsmSCF for this service. + +6720 + +6721 8.11.3.2 Service primitives + +6722 + +**Table 8.11/3: Any\_Time\_Subscription\_Interrogation** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Requested Subscription Info | M | M(=) | | | +| GsmSCF-Address | M | M(=) | | | +| IMSI | C | C(=) | | | +| MSISDN | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Call Forwarding Data | | | C | C(=) | +| Call Barring Data | | | C | C(=) | +| ODB Info | | | C | C(=) | +| CAMEL Subscription Info | | | C | C(=) | +| Supported CAMEL phases in VLR | | | C | C(=) | +| Supported CAMEL phases in SGSN | | | C | C(=) | +| Offered CAMEL 4 CSIs in VLR | | | C | C(=) | +| Offered CAMEL 4 CSIs in SGSN | | | C | C(=) | +| MSISDN-BS-List | | | C | C(=) | +| CSG Subscription Data | | | C | C(=) | +| Call Hold Data | | | C | C(=) | +| Call Waiting Data | | | C | C(=) | +| Explicit Call Transfer Data | | | C | C(=) | +| Calling Line Identification Presentation Data | | | C | C(=) | +| Calling Line Identification Restriction Data | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6723 + +6724 8.11.3.3 Parameter definition and use + +6725 All parameters are described in clause 7.6. + +6726 The HLR may be able to use the value of the parameter gsmSCF-address to screen a + +6727 MAP\_Any\_Time\_Subscription\_Interrogation indication. The gsmSCF-address shall contain the IM-SSF address when +6728 the IM-SSF takes the role of the gsmSCF. + +6729 + +6730 The use of the parameters and the requirements for their presence are specified in 3GPP TS 23.078 [98] and 3GPP TS +6731 23.278 [125]. + +6732 User error + +6733 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 6734 - Unexpected Data Value; +- 6735 - Unknown Subscriber; +- 6736 - BearerServiceNotProvisioned; +- 6737 - TeleserviceNotProvisioned; +- 6738 - CallBarred; +- 6739 - IllegalSS-Operation; +- 6740 - SS-NotAvailable; +- 6741 - InformationNotAvailable; +- 6742 - Any Time Subscription Interrogation Not Allowed; + +6743 - Data Missing. + +6744 Provider error + +6745 These are defined in clause 7.6.1. + +## 6746 8.11.4 MAP-ANY-TIME-MODIFICATION service + +### 6747 8.11.4.1 Definition + +6748 This service is used by the gsmSCF, to modify information of the HLR at any time. + +6749 This service is also used by the Presence Network Agent to activate or deactivate reporting of mobility management +6750 events (associated with a presentity) from the VLR or SGSN (see 3GPP TS 23.141 [128]). + +6751 This service is also used by a Service Related Entity (e.g. the IP-SM-GW) to activate a one-time subscription of UE- +6752 reachability in the MME (see 3GPP TS 23.204 [134]) and SGSN (see 3GPP TS 23.060 [104]). + +6753 This service is also used by external Short Message Gateway (IP-SM-GW) for updating the IP-SM-GW Number stored +6754 in the HLR, and for retrieving SC Address from the HLR. + +### 6755 8.11.4.2 Service primitives + +6756 **Table 8.11/4: Any\_Time\_Modification** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| gsmSCF-Address | M | M(=) | | | +| Subscriber Identity | M | M(=) | | | +| Modification request for ODB data | C | C(=) | | | +| Modification request for SS information | C | C(=) | | | +| Modification request for CSI | C | C(=) | | | +| Modification request for CSG | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Modification request for IP-SM-GW data | C | C(=) | | | +| Activation request for UE-Reachability | C | C(=) | | | +| Ext Forwarding information-for-CSE | | | C | C(=) | +| Ext Call barring information-for-CSE | | | C | C(=) | +| ODB Info | | | C | C(=) | +| CAMEL subscription info | | | C | C(=) | +| Service Centre Address | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6757 + +### 6758 8.11.4.3 Parameter definition and use + +6759 All parameters are described in clause 7.6. + +6760 The HLR may be able to use the value of the parameter gsmSCF-address to screen a MAP\_Any\_Time\_Modification +6761 indication. + +6762 The use of parameters other than described below and the requirements for their presence are specified in 3GPP TS +6763 23.078 [98] and 3GPP TS 23.278 [125]. + +#### 6764 gsmSCF-Address + +6765 This parameter indicates the address of the interrogating gsmSCF. The gsmSCF Address shall be in international E.164 +6766 format. If the service is used by IP-SM-GW, the parameter contains the address of the IP-SM-GW. See also 3GPP TS +6767 23.078 [98] and 3GPP TS 23.278 [125]. + +#### 6768 Modification request for CSG + +6769 This parameter is used by the gsmSCF to request notification of modification of CSG subscription data. + +6770 Modification request for IP-SM-GW data + +6771 This parameter is used by the external IP-SM-GW for updating the IP-SM-GW Number and IP-SM-GW Diameter + +6772 Address stored in the HLR. If this parameter is present then other modification requests shall not be present. + +6773 Activation request for UE Reachability + +6774 This parameter is used by the Service Related Entity (e.g. IP-SM-GW) to activate the one-time subscription for UE- + +6775 Reachability. If this parameter is present then other modification requests shall not be present. + +6776 Service Centre Address + +6777 See definition in clause 7.6.2. + +6778 User error + +6779 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +6780 - Any Time Modification Not Allowed; + +6781 - Data Missing; + +6782 - Unexpected Data Value; + +6783 - Unknown Subscriber; + +6784 - Bearer service not provisioned; + +6785 This error is returned only if not even a subset of the requested bearer service group has been subscribed to; + +6786 - Teleservice not provisioned; + +6787 This error is returned only if not even a subset of the requested teleservice group has been subscribed to; + +6788 - Call Barred; + +6789 - Illegal SS operation; + +6790 - SS error status; + +6791 - SS incompatibility; + +6792 - SS subscription violation; + +6793 - Information Not Available. + +6794 Provider error + +6795 These are defined in clause 7.6.1. + +## 6796 8.11.5 MAP-NOTE-SUBSCRIBER-DATA-MODIFIED service + +### 8.11.5.1 Definition + +This service is used by the HLR to inform the gsmSCF that subscriber data have been modified. In an IP Multimedia Core Network, an IM-SSF can take on the role of a gsmSCF for this service. + +This service is also used by the HLR to inform the Service Related Entity (e.g. IP-SM-GW) that the UE has become reachable (see 3GPP TS 23.204 [134]). + +### 8.11.5.2 Service primitives + +**Table 8.11/5: Note\_Subscriber\_Data\_Modified** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| MSISDN | M | M(=) | | | +| Ext Forwarding information-for-CSE | C | C(=) | | | +| Ext Call barring information-for-CSE | C | C(=) | | | +| ODB Info | C | C(=) | | | +| CAMEL subscription info | C | C(=) | | | +| CSG Subscription Data | C | C | | | +| CW info | C | C(=) | | | +| CH info | C | C(=) | | | +| CLIP Info | C | C(=) | | | +| CLIR Info | C | C(=) | | | +| ECT Info | C | C(=) | | | +| All Information Sent | C | C(=) | | | +| UE reachable | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +### 8.11.5.3 Parameter definition and use + +#### Invoke id + +See clause 7.6.1 for the use of this parameter. + +#### IMSI + +See clause 7.6.2 for the use of this parameter. + +#### MSISDN + +See clause 7.6.2 for the use of this parameter. In an IP Multimedia Core Network, if no MSISDN is available, the HLR shall populate this parameter with the dummy MSISDN value (see clause 3 of 3GPP TS 23.003 [17]). + +#### Ext Forwarding information-for-CSE + +See clause 7.6.3 for the use of this parameter. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98]. + +#### Ext Call barring information-for-CSE + +See clause 7.6.3 for the use of this parameter. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98]. + +#### ODB Info + +See clause 7.6.3 for the use of this parameter. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98]. + +#### CAMEL subscription info + +See clause 7.6.3 for the use of this parameter. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] and 3GPP TS 23.278 [125]. + +#### CSG Subscription Data + +This parameter contains a list of CSG-Ids and the associated expiration dates (see 3GPP TS 22.011 [138]). The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98]. + +#### CW Info + +This parameter contains the status of the call waiting supplementary service. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] + +#### CH Info + +This parameter contains the status of the call hold supplementary service. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] + +#### ECT Info + +This parameter contains the status of the explicit call transfer supplementary service. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] + +#### CLIP Info + +This parameter contains the status of the calling line identification presentation supplementary service. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] + +#### CLIR Info + +This parameter contains the status of the calling line identification restriction supplementary service. The use of this parameter and the requirements for their presence are specified in 3GPP TS 23.078 [98] + +#### 6797 All Information Sent + +6798 This parameter is set when the HLR has sent all information to gsmSCF. + +#### 6799 UE Reachable + +6800 This parameter is used when the HLR indicates to the Service related entity (e.g. IP-SM-GW) that the UE is reachable +6801 again. + +#### User error + +This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +6802 - Data Missing; + +6803 - Unexpected Data Value; + +6804 - Unknown Subscriber. + +#### Provider error + +These are defined in clause 7.6.1. + +The use of the parameters and the requirements for their presence are specified in 3GPP TS 23.078 [98] and 3GPP TS 23.278 [125]. + +--- + +## 6805 9 Operation and maintenance services + +### 6806 9.1 Subscriber tracing services + +#### 6807 9.1.1 MAP-ACTIVATE-TRACE-MODE service + +##### 6808 9.1.1.1 Definition + +6809 This service is used between the HLR and the VLR to activate subscriber tracing in the VLR. + +6810 Also this service is used between the HLR and the SGSN to activate subscriber tracing in the SGSN. + +6811 The MAP-ACTIVATE-TRACE-MODE service is a confirmed service using the primitives from table 9.1/1. + +### 6812 9.1.1.2 Service primitives + +6813 **Table 9.1/1: MAP-ACTIVATE-TRACE-MODE** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| Trace reference | M | M(=) | | | +| Trace type | M | M(=) | | | +| Trace reference 2 | C | C(=) | | | +| Trace depth list | C | C(=) | | | +| Trace NE type list | C | C(=) | | | +| Trace interface list | C | C(=) | | | +| Trace event list | C | C(=) | | | +| Trace support indicator | | | C | C(=) | +| OMC Id | U | C(=) | | | +| MDT-Configuration | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6814 + +### 6815 9.1.1.3 Parameter use + +#### 6816 Invoke id + +6817 See definition in clause 7.6.1. + +#### 6818 IMSI + +6819 See definition in clause 7.6.2. The IMSI is a mandatory parameter in a stand-alone operation. + +#### 6820 Trace reference + +6821 See definition in clause 7.6.10. This parameter contains trace reference for GSM only tracing request. + +#### 6822 Trace type + +6823 See definition in clause 7.6.10. This parameter contains trace type for GSM only tracing request. + +#### 6824 OMC Id + +6825 See definition in clause 7.6.2. The use of this parameter is an operator option. + +#### 6826 Trace reference 2 + +6827 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +#### 6828 Trace depth list + +6829 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +#### 6830 Trace NE type list + +6831 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +#### 6832 Trace interface list + +6833 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +#### 6834 Trace event list + +6835 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +6836 Trace support indicator + +6837 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +6838 MDT-Configuration + +6839 See definition in clause 7.6.10. + +6840 User error + +6841 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +6842 - Unidentified Subscriber; + +6843 - Facility Not Supported; + +6844 - Tracing Buffer Full; + +6845 - System Failure; + +6846 - Unexpected Data Value; + +6847 - Data missing. + +6848 Provider error + +6849 For definition of provider errors see clause 7.6.1. + +## 6850 9.1.2 MAP-DEACTIVATE-TRACE-MODE service + +### 6851 9.1.2.1 Definition + +6852 This service is used between the VLR and the HLR for deactivating subscriber tracing in the VLR. + +6853 Also this service is used between the SGSN and the HLR for deactivating subscriber tracing in the SGSN. + +6854 The MAP-DEACTIVATE-TRACE-MODE service is a confirmed service using the primitives from table 9.1/2. + +### 6855 9.1.2.2 Service primitives + +6856 **Table 9.1/2: MAP-DEACTIVATE-TRACE-MODE** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| Trace reference | M | M(=) | | | +| Trace reference 2 | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6857 + +### 6858 9.1.2.3 Parameter use + +6859 Invoke id + +6860 See definition in clause 7.6.1. + +6861 IMSI + +6862 See definition in clause 7.6.2. The IMSI is a mandatory parameter in a stand-alone operation. + +6863 Trace reference + +6864 See definition in clause 7.6.10. + +6865 Trace reference 2 + +6866 See definition in clause 7.6.10. This parameter shall be used for UMTS trace activation. + +6867 User error + +6868 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 6869 - Unidentified Subscriber; +- 6870 - Facility Not Supported; +- 6871 - System Failure; +- 6872 - Unexpected Data Value; +- 6873 - Data missing. + +6874 Provider error + +6875 For definition of provider errors see clause 7.6.1. + +## 6876 9.1.3 MAP-TRACE-SUBSCRIBER-ACTIVITY service + +### 6877 9.1.3.1 Definition + +6878 This service is used between the VLR and the MSC to activate the subscriber tracing in the MSC. + +6879 The MAP-TRACE-SUBSCRIBER-ACTIVITY service is a non-confirmed service using the primitives from table 9.1/3. + +### 6880 9.1.3.2 Service primitives + +6881 **Table 9.1/3: MAP-TRACE-SUBSCRIBER-ACTIVITY** + +| Parameter name | Request | Indication | +|-----------------|---------|------------| +| Invoke id | M | M(=) | +| IMSI | C | C(=) | +| Trace reference | M | M(=) | +| Trace type | M | M(=) | +| OMC Id | U | C(=) | + +6882 + +### 6883 9.1.3.3 Parameter use + +6884 Invoke id + +6885 See definition in clause 7.6.1. + +6886 IMSI + +6887 See definition in clause 7.6.2. The controlling MSC shall provide either the IMSI or the IMEI to the servicing MSC. + +6888 Trace reference + +6889 See definition in clause 7.6.10. + +6890 Trace type + +6891 See definition in clause 7.6.10. + +6892 OMC Id + +6893 See definition in clause 7.6.2. The use of this parameter is an operator option. + +## 9.2 Other operation and maintenance services + +### 9.2.1 MAP-SEND-IMSI service + +#### 9.2.1.1 Definition + +This service is used by a VLR in order to fetch the IMSI of a subscriber in case of some Operation & Maintenance procedure where subscriber data are needed in the Visited PLMN and MSISDN is the only subscriber's identity known. + +It is a confirmed service and consists of the primitives shown in table 9.2/1. + +#### 9.2.1.2 Service primitives + +**Table 9.2/1: MAP-SEND-IMSI** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MSISDN | M | M(=) | | | +| IMSI | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +6902 + +#### 9.2.1.3 Parameter use + +All parameters are described in clause 7.6. The following clarifications are applicable. + +##### User error + +Only one of the following values is applicable: + +- Unknown subscriber; +- Unexpected data value; +- Data missing. + +--- + +## 10 Call handling services + +### 10.1 MAP\_SEND\_ROUTING\_INFORMATION service + +#### 10.1.1 Definition + +This service is used between the Gateway MSC and the HLR. The service is invoked by the Gateway MSC to perform the interrogation of the HLR in order to route a call towards the called MS. + +This is a confirmed service using the primitives listed in table 10.1/1. + +This service is also used between the GMSC and the NPLR and between the gsmSCF and the HLR. + +#### 10.1.2 Service primitives + +**Table 10.1/1: MAP\_SEND\_ROUTING\_INFORMATION parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Interrogation Type | M | M(=) | | | +| GMSC or gsmSCF Address | M | M(=) | | | + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------------|---------|------------|----------|---------| +| MSISDN | M | M(=) | C | C(=) | +| OR Interrogation | C | C(=) | | | +| OR Capability | C | C(=) | | | +| CUG Interlock | C | C(=) | C | C(=) | +| CUG Outgoing Access | C | C(=) | C | C(=) | +| Number of Forwarding | C | C(=) | | | +| Network Signal Info | C | C(=) | | | +| Supported CAMEL Phases | C | C(=) | C | C(=) | +| Suppress T-CSI | C | C(=) | | | +| Offered CAMEL 4 CSIs | C | C(=) | | | +| Suppression of Announcement | C | C(=) | | | +| Call Reference Number | C | C(=) | | | +| Forwarding Reason | C | C(=) | | | +| Basic Service Group | C | C(=) | | | +| Basic Service Group 2 | C | C(=) | | | +| Alerting Pattern | C | C(=) | | | +| CCBS Call | C | C(=) | | | +| Supported CCBS Phase | C | C(=) | | | +| Additional Signal Info | C | C(=) | | | +| IST Support Indicator | C | C(=) | | | +| Pre-paging supported | C | C(=) | | | +| Call Diversion Treatment Indicator | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Suppress VT-CSI | C | C(=) | | | +| Suppress Incoming Call Barring | C | C(=) | | | +| SuppressMTSS | C | C(=) | | | +| gsmSCF Initiated Call | C | C(=) | | | +| Network Signal Info 2 | C | C(=) | | | +| MT Roaming Retry Supported | U | C(=) | | | +| Call Priority | U | C(=) | | | +| IMSI | | | C | C(=) | +| MSRN | | | C | C(=) | +| Forwarding Data | | | C | C(=) | +| Forwarding Interrogation Required | | | C | C(=) | +| VMSC address | | | C | C(=) | +| ReleaseResourcesSupported | | | C | C(=) | +| GMSC Camel Subscription Info | | | C | C(=) | +| Location Information | | | C | C(=) | +| Subscriber State | | | C | C(=) | +| Basic Service Code | | | C | C(=) | +| CUG Subscription Flag | | | C | C(=) | +| North American Equal Access preferred | | | U | C(=) | +| Carrier Id | | | | | +| User error | | | C | C(=) | +| SS-List | | | U | C(=) | +| CCBS Target | | | C | C(=) | +| Keep CCBS Call Indicator | | | C | C(=) | +| IST Alert Timer | | | C | C(=) | +| Number Portability Status | | | U | C(=) | +| Supported CAMEL Phases in VMSC | | | C | | +| Offered CAMEL 4 CSIs in VMSC | | | C | C(=) | +| MSRN 2 | | | C | C(=) | +| Forwarding Data 2 | | | C | C(=) | +| SS-List 2 | | | C | C(=) | +| Basic Service Code 2 | | | C | C(=) | +| Allowed Services | | | C | C(=) | +| Unavailability Cause | | | C | C(=) | +| Provider error | | | | O | +| GSM Bearer Capability | | | U | C(=) | + +6919 + +### 6920 10.1.3 Parameter use + +6921 See clause 7.6 for a definition of the parameters used in addition to the following. Note that: + +- 6922 - a conditional parameter whose use is defined only in 3GPP TS 23.078 shall be absent if the sending entity does +6923 not support CAMEL; +- 6924 - a conditional parameter whose use is defined only in 3GPP TS 23.079 [99] shall be absent if the sending entity +6925 does not support optimal routeing; +- 6926 - a conditional parameter whose use is defined only in 3GPP TS 23.078 & 3GPP TS 23.079 [99] shall be absent if +6927 the sending entity supports neither CAMEL nor optimal routeing. + +6928 Interrogation Type + +6929 See 3GPP TS 23.079 [99] for the use of this parameter. + +6930 GMSC or gsmSCF address + +6931 The E.164 address of the GMSC or the gsmSCF. This parameter contains the gsmSCF address if the gsmSCF initiated +6932 call parameter is present, otherwise it is the GMSC address. + +6933 MSISDN + +6934 This is the Mobile Subscriber ISDN number assigned to the called subscriber. In the Request & Indication it is the +6935 number received by the GMSC in the ISUP IAM. If the call is to be forwarded and the HLR supports determination of +6936 the redirecting number, the HLR inserts the basic MSISDN in the Response. + +6937 See 3GPP TS 23.066 [108] for the use of this parameter and the conditions for its presence in the response. + +6938 OR Interrogation + +6939 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +6940 OR Capability + +6941 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +6942 CUG Interlock + +6943 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +6944 CUG Outgoing Access + +6945 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +6946 Number of Forwarding + +6947 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +6948 Network Signal Info + +6949 See 3GPP TS 23.018 [97] for the conditions for the presence of the components of this parameter. + +6950 Supported CAMEL Phases + +6951 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +6952 T-CSI Suppression + +6953 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +6954 Offered CAMEL 4 CSIs + +6955 This parameter indicates the CAMEL phase 4 CSIs offered in the GMSC/VLR (see clause 7.6.3.36D). + +6956 + +6957 Suppression Of Announcement + +6958 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +6959 Call Reference Number + +6960 The use of this parameter and the conditions for its presence are specified in 3GPP TS 23.078 [98], 3GPP TS 23.079 +6961 [99] and 3GPP TS 23.018 [97]. + +6962 Forwarding Reason + +6963 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +6964 Basic Service Group + +6965 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +6966 Basic Service Group 2 + +6967 See 3GPP TS 23.079[99] for the use of this parameter and the conditions for its presence. + +6968 Alerting Pattern + +6969 See 3GPP TS 23.018 [97] and 3GPP TS 23.078 [98] for the use of this parameter and the conditions for its presence. + +6970 CCBS Call + +6971 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +6972 Supported CCBS Phase + +6973 This parameter indicates by its presence that CCBS is supported and the phase of CCBS which is supported. + +6974 Additional Signal Info + +6975 See 3GPP TS 23.081 [27] and 3GPP TS 23.088 [33] for the conditions for the presence of the components of this +6976 parameter. + +6977 IST Support Indicator + +6978 This parameter is used to indicate to the HLR that the GMSC supports basic IST functionality, that is, the GMSC is able +6979 to terminate the subscriber call activity that originated the IST Alert when it receives the IST Alert response indicating +6980 that the call(s) shall be terminated. If this parameter is not included in the Send Routing Information indication and the +6981 subscriber is marked as an IST subscriber, then the HLR may limit the service for the call (by barring the incoming call +6982 if it is not subject to forwarding, or suppressing Call Forwarding from the GMSC), or allow the call assuming the +6983 associated risk of not having the basic IST mechanism available. + +6984 This parameter can also indicate that the GMSC supports the IST Command, including the ability to terminate all calls +6985 being carried for the identified subscriber by using the IMSI as a key. If this additional capability is not included in the +6986 Send Routing Information indication and the subscriber is marked as an IST subscriber, then the HLR may limit the +6987 service for the subscriber (by barring the incoming calls if they are not subject to forwarding, or suppressing Call +6988 Forwarding from the GMSC), or allow the incoming calls assuming the associated risk of not having the IST Command +6989 mechanism available. + +6990 Pre-paging supported + +6991 See 3GPP TS 23.018 for the use of this parameter and the conditions for its presence. + +6992 Call Diversion Treatment Indicator + +6993 This parameter indicates whether or not call diversion is allowed. + +6994 Network Signal Info 2 + +6995 See 3GPP TS 23.172 [126] for the conditions for the presence of the components of this parameter. + +6996 MT Roaming Retry Supported + +6997 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. + +6998 Call Priority + +6999 This parameter indicates the eMLPP priority of the call (see 3GPP TS 24.067 [137]). This parameter should be present +7000 if the GMSC supports the eMLPP feature and if the call is an eMLPP call. The eMLPP priority levels A and B shall be +7001 mapped to the Call Priority level 0. + +7002 IMSI + +7003 See 3GPP TS 23.018 [97] and 3GPP TS 23.066 [108] for the use of this parameter and the conditions for its presence. + +7004 MSRN + +7005 See 3GPP TS 23.018 [97], 3GPP TS 23.066 [108] and 3GPP TS 23.079 [99] for the use of this parameter and the +7006 conditions for its presence. If the NPLR returns only the MSISDN-number without Routeing Number to the GMSC, the +7007 MSISDN-number shall be returned as MSRN. + +7008 Forwarding Data + +7009 This parameter includes a number to define the forwarded-to destination, the forwarding reason and the forwarding +7010 options Notification to calling party and Redirecting presentation, and can include the forwarded-to subaddress. See +7011 3GPP TS 23.018 [97] and 3GPP TS 23.079 [99] for the conditions for the presence of its components. + +7012 Forwarding Interrogation Required + +7013 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +7014 Long FTN Supported + +7015 This parameter indicates that the GMSC supports Long Forwarded-to Numbers. + +7016 Suppress VT-CSI + +7017 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7018 Suppress Incoming Call Barring + +7019 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7020 gsmSCF Initiated Call + +7021 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7022 SuppressMTSS + +7023 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7024 VMSC address + +7025 See 3GPP TS 23.079 [99] and 3GPP TS 23.078 [98] for the use of this parameter and the conditions for its presence. +7026 In addition this parameter shall be present if the ReleaseResourcesSupported parameter is present. + +7027 Release Resources Supported + +7028 This parameter indicates by its presence that the MAP\_RELEASE\_RESOURCES service is supported at the VMSC. It +7029 shall be present if so indicated by the VMSC with MAP\_PROVIDE\_ROAMING\_NUMBER confirm. + +7030 GMSC CAMEL Subscription Info + +7031 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7032 Location Information + +7033 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7034 Subscriber State + +7035 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7036 CUG Subscription Flag + +7037 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7038 North American Equal Access preferred Carrier Id + +7039 This parameter is returned to indicate the preferred carrier identity to be used to set-up the call (i.e. forwarding the call +7040 or establishing the roaming leg). + +7041 SS-List + +7042 This parameter includes SS-codes and will be returned as an operator option. The HLR shall not send PLMN-specific +7043 SS-codes across PLMN boundaries. However if the GMSC receives PLMN-specific SS-codes from a foreign PLMN's +7044 HLR the GMSC may ignore it. If the GMSC attempts to process the PLMN- specific SS- codes, this may lead to +7045 unpredictable behaviour but the GMSC shall continue call processing. + +7046 Basic Service Code + +7047 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7048 If the CAMEL service is not involved, this parameter includes the basic service code and will be returned as an operator +7049 option. The HLR shall not send a PLMN-specific Basic Service Code across PLMN boundaries. However if the GMSC +7050 receives a PLMN-specific Basic Service Code from a foreign PLMN's HLR the GMSC may ignore it. If the GMSC +7051 attempts to process the PLMN specific Basic Service codes, this may lead to unpredictable behaviour but the GMSC +7052 shall continue call processing. + +7053 CCBS Target + +7054 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7055 Keep CCBS Call Indicator + +7056 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7057 IST Alert Timer + +7058 It includes the IST Alert timer value that must be used to inform the HLR about the call activities that the subscriber +7059 performs. This parameter is only sent to the GMSC in response to a Send Routing Information request which indicates +7060 the the GMSC supports IST. + +7061 Number Portability Status + +7062 This parameter indicates the number portability status of the subscriber. This parameter may be present if the sender of +7063 SRIack is NPLR. + +7064 Supported CAMEL Phases in VMSC + +7065 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078. + +7066 Offered CAMEL 4 CSIs in VMSC + +7067 This parameter is defined in clause 7.6.3.36F. + +7068 MSRN 2 + +7069 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7070 Forwarding Data 2 + +7071 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7072 SS-List 2 + +7073 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7074 Basic Service Code 2 + +7075 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7076 Allowed Services + +7077 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7078 Unavailability Cause + +7079 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.172 [126]. + +7080 User error + +7081 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +7082 - Unknown Subscriber; + +7083 The diagnostic for the Unknown Subscriber error may indicate "NPDB Mismatch". + +7084 - Number changed; + +7085 - Call Barred; + +7086 This error will indicate that either incoming calls are barred for this MS or that calls are barred due to Operator + +7087 Determined Barring (see 3GPP TS 22.041 [8] for a definition of this network feature); + +7088 - CUG Reject; + +7089 The value of this error cause will indicate the reason for CUG Reject; + +7090 - Bearer Service Not Provisioned; + +7091 - Teleservice Not Provisioned; + +7092 A subscription check has been performed and the call has not passed the check due to incompatibility with + +7093 regard to the requested service. Depending on the nature of the incompatibility, either of these messages will be + +7094 returned; + +7095 - Facility Not Supported; + +7096 - Absent Subscriber; + +7097 This indicates that the location of the MS is not known (either the station is not registered and there is no + +7098 location information available or the Provide Roaming Number procedure fails due to IMSI detached flag being + +7099 set), or the GMSC requested forwarding information with a forwarding reason of not reachable, and the call + +7100 forwarding on MS not reachable service is not active; this may also indicate that the MS has moved to a new + +7101 MSC/VLR and that MT Roaming Retry is requested (see 3GPP TS 23.018 [97]); + +7102 - Busy Subscriber; + +7103 This indicates that Call Forwarding on Busy was not active for the specified basic service group when the + +7104 GMSC requested forwarding information with a forwarding reason of busy; + +7105 The error may also indicate that the subscriber is busy due to an outstanding CCBS recall. In the error data it + +7106 may then be specified that CCBS is possible for the busy encountered call; + +7107 - No Subscriber Reply; + +7108 This indicates that Call Forwarding on No Reply was not active for the specified basic service group when the + +7109 GMSC requested forwarding information with a forwarding reason of no reply; + +7110 - OR Not Allowed; + +7111 This indicates that the HLR is not prepared to accept an OR interrogation from the GMSC, or that calls to the + +7112 specified subscriber are not allowed to be optimally routed; + +7113 - Forwarding Violation; + +7114 - System Failure; + +7115 - Data Missing; + +7116 - Unexpected Data Value. + +7117 See clause 7.6.1.4 for a definition of these errors. + +7118 Provider error + +7119 These are defined in clause 7.6. + +7120 GSM Bearer Capability + +7121 This information is passed according to the rules specified in 3GPP TS 29.007 [56]. There may be two GSM Bearer +7122 Capabilities supplied. + +7123 + +## 7124 10.2 MAP\_PROVIDE\_ROAMING\_NUMBER service + +### 7125 10.2.1 Definition + +7126 This service is used between the HLR and VLR. The service is invoked by the HLR to request a VLR to send back a +7127 roaming number to enable the HLR to instruct the GMSC to route an incoming call to the called MS. + +7128 This service is also used between old VLR and new VLR during the MT Roaming Forwarding procedure. The service is +7129 invoked by the old VLR to request a roaming number from the new VLR to be able to route an incoming call to the +7130 called UE. + +7131 This is a confirmed service which uses the primitives described in table 10.2/1. + +### 7132 10.2.2 Service primitives + +7133 + +**Table 10.2/1: MAP\_PROVIDE\_ROAMING\_NUMBER parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| MSC Number | M | M(=) | | | +| MSISDN | U | C(=) | | | +| LMSI | C | C(=) | | | +| GSM Bearer Capability | C | C(=) | | | +| Network Signal Info | C | C(=) | | | +| Suppression Of Announcement | C | C(=) | | | +| Call Reference Number | C | C(=) | | | +| GMSC Address | C | C(=) | | | +| OR Interrogation | C | C(=) | | | +| OR Not Supported in GMSC | C | C(=) | | | +| Alerting Pattern | C | C(=) | | | +| CCBS Call | C | C(=) | | | +| Supported CAMEL Phases in interrogating node | C | C(=) | | | +| Additional Signal Info | C | C(=) | | | +| Pre-paging supported | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| Suppress VT-CSI | C | C(=) | | | +| Offered CAMEL 4 CSIs in interrogating node | C | C(=) | | | +| MT Roaming Retry Supported | U | C(=) | | | +| Paging Area | U | C(=) | | | +| Call Priority | U | C(=) | | | +| MTRF Indicator | U | C(=) | | | +| Old MSC Number | U | C(=) | | | +| Last used LTE PLMN ID | U | C(=) | | | +| Roaming Number | | | C | C(=) | +| VMSC address | | | U | C(=) | +| ReleaseResourcesSupported | | | U | C(=) | +| User error | | | C | C(=) | + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Provider error | | | | O | + +7134 + +### 7135 10.2.3 Parameter use + +7136 See clause 7.6 for a definition of the parameters used, in addition to the following. Note that: + +- 7137 - a conditional parameter whose use is defined only in 3GPP TS 23.078 [98] shall be absent if the sending entity +- 7138 does not support CAMEL; +- 7139 - a conditional parameter whose use is defined only in 3GPP TS 23.079 [99] shall be absent if the sending entity +- 7140 does not support optimal routeing; +- 7141 - a conditional parameter whose use is defined only in 3GPP TS 23.078 [98] & 3GPP TS 23.079 [99] shall be +- 7142 absent if the sending entity supports neither CAMEL nor optimal routeing. + +#### 7143 IMSI + +7144 This is the IMSI of the called Subscriber. + +#### 7145 MSC Number + +7146 This is the ISDN number assigned to the MSC currently serving the MS. When the service is used between HLR and + +7147 VLR, the MSC number will have been stored in the HLR as provided at location updating. When used between old + +7148 VLR and new VLR during an MT Roaming Forwarding procedure, the MSC number will have been provided at + +7149 location cancelling or within Send Identification. + +#### 7150 MSISDN + +7151 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +#### 7152 LMSI + +7153 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. In addition, for the mobile + +7154 terminating roaming forwarding procedure between the old VLR and the new VLR, this parameter shall be present if + +7155 the MTRF Indicator is present and the old VLR has received the new LMSI in Cancel Location from the HLR or in + +7156 Send Identification from the new VLR. + +#### 7157 GSM Bearer Capability + +7158 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +7159 This information is passed according to the rules specified in TS 3GPP TS 29.007 [56]. + +7160 There may be two GSM Bearer Capabilities supplied. + +#### 7161 Network Signal Info + +7162 See 3GPP TS 23.018 [97] for the conditions for the presence of the components of this parameter. + +#### 7163 Suppression Of Announcement + +7164 The use of this parameter and the requirements for its presence are specified in 3GPP TS 23.078 [98]. + +#### 7165 Call Reference Number + +7166 The use of this parameter and the conditions for its presence are specified in 3GPP TS 23.078 [98], 3GPP TS 23.079 + +7167 [99] and 3GPP TS 23.018 [97]. + +#### 7168 GMSC Address + +7169 The use of this parameter and the conditions for its presence are specified in 3GPP TS 23.078 [98], 3GPP TS 23.079 + +7170 [99] and 3GPP TS 23.018 [97]. + +#### 7171 OR Interrogation + +7172 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +7173 OR Not Supported in GMSC + +7174 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +7175 Supported CAMEL Phases in interrogating node + +7176 This parameter is defined in clause 7.6.3.36I.Alerting Pattern + +7177 See 3GPP TS 23.078 [98] for the use of this parameter and the conditions for its presence. + +7178 CCBS Call + +7179 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7180 Additional Signal Info + +7181 See 3GPP TS 23.081 [27] for the conditions for the presence of the components of this parameter. + +7182 Pre-paging supported + +7183 See 3GPP TS 23.018 for the use of this parameter and the conditions for its presence. This information element is not +7184 applicable for MTRF, and shall be ignored if received while the MTRF Indicator is present. + +7185 Long FTN supported + +7186 See 3GPP TS 23.082 for the use of this parameter and the conditions for its presence. + +7187 Suppress VT-CSI + +7188 See 3GPP TS 23.078 for the use of this parameter and the conditions for its presence. + +7189 Offered CAMEL 4 CSIs in interrogating node + +7190 This parameter is defined in clause 7.6.3.36E. + +7191 MT Roaming Retry Supported + +7192 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. +7193 This information element is not applicable for MTRF, and shall be ignored if received while the MTRF Indicator is +7194 present. + +7195 Paging Area + +7196 See 3GPP TS 23.018 [97] and 3GPP TS 23.012 [23] for the use of this parameter and the conditions for its presence. +7197 This information element is not applicable for MTRF, and shall be ignored if received while the MTRF Indicator is +7198 present. + +7199 Call Priority + +7200 This parameter indicates the eMLPP priority of the call (see 3GPP TS 24.067 [137]). This parameter should be present +7201 if the HLR supports this parameter and if the Call Priority was received in the +7202 MAP\_SEND\_ROUTING\_INFORMATION request. + +7203 MTRF Indicator + +7204 This indicator indicates by its presence that the service is used between old VLR and new VLR during an MT Roaming +7205 Forwarding procedure. See 3GPP TS 23.018 [97]. + +7206 Old MSC Number + +7207 This parameter refers to the E.164 address of the old MSC. The use of this parameter is specified in 3GPP TS 23.018 +7208 [97]. This information element is applicable only if the MTRF Indicator is set. + +7209 Last used LTE PLMN ID + +7210 See 3GPP TS 23.272 [143] for the use of this parameter and the conditions for its presence. This information element is +7211 applicable only if the MTRF Indicator is set. + +7212 Roaming Number + +7213 See 3GPP TS 23.018 [97] for the use of this parameter and the conditions for its presence. + +7214 VMSC address + +7215 See 3GPP TS 23.079 [99], 3GPP TS 23.078 [98] and 3GPP TS 23.018 [97] for the use of this parameter and the +7216 conditions for its presence. This parameter shall be present during the Mobile Terminating Roaming Forwarding Call +7217 during Retrieval of Routeing Information procedure if an MSRN is allocated by the new MSC/VLR. + +7218 ReleaseResourcesSupported + +7219 This parameter indicates by its presence that the MAP\_RELEASE\_RESOURCES service is supported at the VMSC. + +7220 User error + +7221 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +7222 - Absent Subscriber; + +7223 This error will be returned if the IMSI detach flag is set. + +7224 - No Roaming Number Available; + +7225 - OR Not Allowed; + +7226 This indicates that the MAP\_PROVIDE\_ROAMING\_NUMBER indication included the OR interrogation +7227 indicator, but the VLR does not support optimal routeing. + +7228 - Facility Not Supported; + +7229 - System Failure; + +7230 - Data Missing; + +7231 - Unexpected Data Value. + +7232 See clause 7.6 for a definition of these reasons. + +7233 Provider error + +7234 These are defined in clause 7.6. + +## 7235 10.3 MAP\_RESUME\_CALL\_HANDLING service + +### 7236 10.3.1 Definition + +7237 This service is used between the terminating VMSC and the GMSC. The service is invoked by the terminating VMSC +7238 to request the GMSC to resume handling the call and forward it to the specified destination. + +7239 This is a confirmed service which uses the Primitives listed in table 10.3/1. + +### 7240 10.3.2 Service primitives + +7241 **Table 10.3/1: MAP\_RESUME\_CALL\_HANDLING parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Call Reference Number | C | C(=) | | | +| Basic Service Group | C | C(=) | | | +| Basic Service Group 2 | C | C(=) | | | + +| | | | | | +|----------------------|---|------|---|------| +| IMSI | C | C(=) | | | +| Forwarding Data | C | C(=) | | | +| CUG Interlock | C | C(=) | | | +| CUG Outgoing Access | C | C(=) | | | +| O-CSI | C | C(=) | | | +| D-CSI | C | C(=) | | | +| CCBS Target | C | C(=) | | | +| UU Data | C | C(=) | | | +| UUS CF Interaction | C | C(=) | | | +| All Information Sent | C | C(=) | | | +| MSISDN | C | C(=) | | | +| MT Roaming Retry | U | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7242 + +### 7243 10.3.3 Parameter use + +7244 Information received in subsequent segment of a segmented dialogue shall not overwrite information received in an +7245 earlier segment. + +7246 See clause 7.6 for a definition of the parameters used, in addition to the following. + +#### 7247 Call Reference Number + +7248 See 3GPP TS 23.079 [99] for the use of this parameter. This parameter shall be present in the first segment of the +7249 dialogue. + +#### 7250 Basic Service Group + +7251 See 3GPP TS 23.079 [99] for the use of this parameter. This parameter shall be present in the first segment of the +7252 dialogue. + +#### 7253 Basic Service Group 2 + +7254 See 3GPP TS 23.079[99] for the use of this parameter. If this parameter is present, it shall be in the first segment of the +7255 dialogue. + +#### 7256 IMSI + +7257 This is the IMSI of the forwarding Subscriber. This parameter shall be present in the first segment of the dialogue. + +#### 7258 Forwarding Data + +7259 This parameter includes a number to define the forwarded-to destination, the forwarding reason and the forwarding +7260 options Notification to calling party and Redirecting presentation, and can include the forwarded-to subaddress. See +7261 3GPP TS 23.079 [99] for the conditions for the presence of its components. This parameter shall be present in a first +7262 segment of the dialogue. + +#### 7263 CUG Interlock + +7264 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +#### 7265 CUG Outgoing Access + +7266 See 3GPP TS 23.079 [99] for the use of this parameter and the conditions for its presence. + +#### 7267 O-CSI + +7268 See 3GPP TS 23.078 for the use of this parameter and the conditions for its presence. + +7269 For CAMEL phases 1 & 2, the O-CSI shall contain only one set of O-BCSM TDP data. + +#### 7270 D-CSI + +7271 The Dialled Services-CSI. + +7272 See 3GPP TS 23.078 for the use of this parameter and the conditions for its presence. + +7273 CCBS Target + +7274 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7275 UU Data + +7276 See 3GPP TS 23.087 for the use of this parameter and the conditions for its presence. + +7277 UUS CF Interaction + +7278 See 3GPP TS 23.087 for the use of this parameter and the conditions for its presence. + +7279 All Information Sent + +7280 This parameter is set when the VMSC has sent all information to GMSC. + +7281 MT Roaming Retry + +7282 See 3GPP TS 23.018 [97], 3GPP TS 23.012 [23] and 3GPP TS 23.079 [99] for the use of this parameter and the +7283 conditions for its presence. When this parameter is present, only the Call Reference Number and All Information Sent +7284 IEs shall be present; the other IEs shall be ignored by the GMSC if received. + +7285 MSISDN + +7286 This parameter is the basic MSISDN of the forwarding subscriber. It shall be present if the VMSC supports +7287 determination of the redirecting number. + +7288 User error + +7289 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +7290 - Optimal Routeing not allowed; + +7291 - Forwarding failed; + +7292 - Unexpected Data Value; + +7293 - Data Missing. + +7294 Provider error + +7295 These are defined in clause 7.6. + +## 7296 10.4 MAP\_PREPARE\_GROUP\_CALL service + +### 7297 10.4.1 Definition + +7298 This service is used by the Anchor\_MSC to inform the Relay\_MSC about a group call set-up. + +7299 The MAP\_PREPARE\_GROUP\_CALL service is a confirmed service using the service primitives given in table 10.4/1. + +### 7300 10.4.2 Service primitives + +7301 **Table 10.4/1: MAP\_PREPARE\_GROUP\_CALL service** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Teleservice | M | M(=) | | | +| ASCI Call Reference | M | M(=) | | | +| Ciphering Algorithm | M | M(=) | | | +| Group Key Number VK-Id | C | C(=) | | | +| VSTK Key | C | C(=) | | | + +| | | | | | +|--------------------------|---|------|---|------| +| VSTK-RAND | C | C(=) | | | +| Priority | C | C(=) | | | +| CODEC-Information | M | M(=) | | | +| Uplink Free Indicator | M | M(=) | | | +| Talker Channel Parameter | C | C(=) | | | +| Uplink Reply Indicator | C | C(=) | | | +| Group Call Number | | | M | M(=) | +| User Error | | | C | C(=) | +| Provider Error | | | | O | + +7302 + +### 7303 10.4.3 Parameter definitions and use + +#### 7304 Invoke Id + +7305 See definition in clause 7.6.1. + +#### 7306 Teleservice + +7307 Voice Broadcast Service or Voice Group Call Service. + +#### 7308 ASCI Call Reference + +7309 Broadcast call reference or group call reference. This item is used to access the VBS-GCR or VGCS-GCR within the +7310 Relay\_MSC. + +#### 7311 Ciphering Algorithm + +7312 The ciphering algorithm to be used for the group call. + +#### 7313 Group Key Number VK-Id + +7314 This Group Key Number has to be broadcast and is used by the mobile station to derive the key for ciphering on the +7315 radio interface (see 3GPP TS 43.020 [24]). Values 2 to 15 are reserved for future use. + +7316 Shall be present if the ciphering applies. + +#### 7317 VSTK + +7318 The VGCS/VBS Short Term Key is used to derive the key for ciphering on the radio interface (see 3GPP TS 43.020 +7319 [24]). + +7320 Shall be present if the ciphering applies. + +#### 7321 VSTK-RAND + +7322 This random number has to be broadcast and is used by the mobile station to derive the group key for ciphering on the +7323 radio interface (see 3GPP TS 43.020 [24]). + +7324 Shall be present if the ciphering applies. + +#### 7325 Priority + +7326 Default priority level related to the call if eMLPP applies. + +#### 7327 CODEC-Information + +7328 Information on the codecs allowed for this call. + +#### 7329 Uplink Free Indicator + +7330 A flag indicating whether the call is initiated from a dispatcher. + +#### 7331 Talker Channel Parameter + +7332 A flag indicating by its presence that a dedicated channel shall be established and maintained for the talking service +7333 subscriber. + +7334 Uplink Reply Indicator + +7335 A flag indicating by its presence that the uplink reply procedure is applicable for the voice group call or voice broadcast +7336 call. + +7337 Group Call Number + +7338 This temporary allocated E.164 number is used for routing the call from the Anchor MSC to the Relay MSC. + +7339 User Error + +7340 For definition of this parameter see clause 7.6.1 The following errors defined in clause 7.6.1 may be used, depending on +7341 the nature of the fault: + +- 7342 - No Group Call Number available; +- 7343 - System Failure; +- 7344 - Unexpected Data Value. + +7345 Provider Error + +7346 See definition of provider error in clause 7.6.1. + +## 7347 10.5 MAP\_PROCESS\_GROUP CALL\_SIGNALLING service + +### 7348 10.5.1 Definitions + +7349 This service is used between Relay MSC and Anchor MSC for transmission of Group Call notifications. + +7350 The MAP\_PROCESS\_GROUP\_CALL\_SIGNALLING service is a non-confirmed service using the service primitives +7351 given in table 10.5/1. + +### 7352 10.5.2 Service primitives + +7353 **Table 10.5/1: MAP\_PROCESS\_GROUP\_CALL\_SIGNALLING service** + +| Parameter name | Request | Indication | +|--------------------------------------|---------|------------| +| Invoke Id | M | M(=) | +| Uplink Request | C | C(=) | +| Uplink Release Indication | C | C(=) | +| AN-APDU | C | C(=) | +| Release Group Call | C | C(=) | +| Talker Priority | C | C(=) | +| Additional Info | C | C(=) | +| Emergency Mode Reset
Command Flag | C | C(=) | + +7354 + +### 7355 10.5.3 Parameter definitions and use + +7356 Invoke Id + +7357 See definition in clause 7.6.1 + +7358 Uplink Request + +7359 This information element indicates to the anchor MSC that a service subscriber roaming in the relay MSC area requests +7360 access to the uplink. + +7361 Uplink Release Indication + +7362 This information element if included by the Relay MSC indicates to the Anchor MSC that the uplink has become free. + +7363 AN-APDU + +7364 This parameter contains the Notification Data message as defined in 3GPP TS 48.008 [49]. + +7365 Release Group Call + +7366 This information element if included by the Relay MSC indicates to the Anchor MSC that the service subscriber who +7367 has initiated the call and who currently has access to the uplink terminates the call. + +7368 Talker Priority + +7369 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +7370 Additional Info + +7371 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +7372 Emergency Mode Reset Command Flag + +7373 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +## 7374 10.6 MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING service + +### 7375 10.6.1 Definitions + +7376 This service is used between Anchor MSC and Relay MSC for transmission of Group Call notifications. + +7377 The MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING service is a non-confirmed service using the service +7378 primitives given in table 10.6/1. + +### 7379 10.6.2 Service primitives + +7380 **Table 10.6/1: MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING service** + +| Parameter name | Request | Indication | +|-----------------------------------|---------|------------| +| Invoke Id | M | M(=) | +| IMSI | C | C(=) | +| Uplink Request Acknowledgement | C | C(=) | +| Uplink Release Indication | C | C(=) | +| Uplink Reject Command | C | C(=) | +| Uplink Seized Command | C | C(=) | +| Uplink Release Command | C | C(=) | +| AN-APDU | C | C(=) | +| State Attributes | C | C(=) | +| Talker Priority | C | C(=) | +| Additional Info | C | C(=) | +| Emergency Mode Reset Command Flag | C | C(=) | +| SM RP UI | C | C(=) | + +7381 + +### 7382 10.6.3 Parameter definitions and use + +7383 IMSI + +7384 Identity of the service subscriber who has established the call and who is allowed to terminate the call. + +7385 Invoke Id + +7386 See definition in clause 7.6.1. + +7387 Uplink Request Acknowledgement + +7388 This information element is used for positive acknowledgement of an uplink request. + +7389 Uplink Release Indication + +7390 This information element if included by the Anchor MSC indicates to the Relay MSC that the uplink has become free. + +7391 Uplink Reject Command + +7392 This information element is used for negative acknowledgement of an uplink request. + +7393 Uplink Seized Command + +7394 This information element if included by the Anchor MSC indicates to the Relay MSC that the uplink is no longer free. + +7395 Uplink Release Command + +7396 This information element if included by the Anchor MSC indicates to the Relay MSC that the uplink which is granted +7397 to a MS in the relay MSC area shall be released. + +7398 AN-APDU + +7399 This parameter contains the Notification Data message as defined in 3GPP TS 48.008 [49] + +7400 State Attributes + +7401 This information element is used to allow service logic running in an Anchor MSC to mute a VGCS talker even when +7402 the talker is served on a Relay MSC. The IE is used to build a GCC message that provides a mechanism to induce the +7403 VGCS talker terminal to mute/unmute the downlink at the Anchor MSC, as defined in 3GPP TS 44.068. + +7404 Talker Priority + +7405 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +7406 Additional Info + +7407 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +7408 Emergency Mode Reset Command Flag + +7409 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +7410 SM RP UI + +7411 See definition in clause 7.6.8. The short message transfer protocol data unit received from the Service Centre is inserted +7412 in this parameter. + +7413 + +## 7414 10.7 MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL service + +### 7415 10.7.1 Definitions + +7416 This service is used between the Relay MSC and the Anchor MSC. When the VGCS/ VBS calling service subscriber is +7417 in the Relay MSC area the MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL indicates that at least the downlink channel +7418 in the originating cell is established. For all other VGCS/ VBS call set-up scenarios (i.e. calling service subscriber in +7419 Anchor MSC area, calling service subscriber in other Relay MSC area, dispatcher originated call) the +7420 MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL indicates that at least the downlink channel in any one cell within the +7421 VGCS/ VBS call area in the Relay MSC is established. The response is used by the Anchor MSC to inform the Relay +7422 MSC that all resources for the call can be released in the Relay MSC because the call has been released in the Anchor +7423 MSC. + +7424 The MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL service is a confirmed service using the service primitives given in +7425 table 10.7/1. + +## 10.7.2 Service primitives + +Table 10.7/1: MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL service + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| Talker Priority | C | C(=) | | | +| Additional Info | C | C(=) | | | +| Provider Error | | | | O | + +7428 + +## 10.7.3 Parameter definitions and use + +### Invoke Id + +See definition in clause 7.6.1 + +### IMSI + +Identity of the service subscriber who has established the call and who is allowed to terminate the call. + +Shall be present if the call was established by a service subscriber roaming in the relay MSC area. + +### Talker Priority + +For the definition and use of this parameter see 3GPP TS 43.068 [100] + +### Additional Info + +For the definition and use of this parameter see 3GPP TS 43.068 [100] + +### Provider Error + +See definition of provider error in clause 7.6.1. + +## 10.7A MAP\_SEND\_GROUP\_CALL\_INFO service + +### 10.7A.1 Definitions + +This service is used in a RANflex configuration (see 3GPP TS 23.236 [133]) between the subscriber's visited MSC and group call serving MSC of the subscriber's location area. + +The MAP\_SEND\_GROUP\_CALL\_INFO service is a confirmed service using the service primitives given in table 10.7A/1. + +## 10.7A.2 Service primitives + +Table 10.7A/1: MAP\_SEND\_GROUP\_CALL\_INFO service + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Requested Info | M | M(=) | | | +| Teleservice | M | M(=) | | | +| Cell Id | C | C(=) | | | +| Group Id | M | M(=) | | | +| IMSI | C | C(=) | C | C(=) | +| Talker Priority | C | C(=) | | | +| Additional Info | C | C(=) | C | C(=) | +| TMSI | C | C(=) | | | +| CKSN | C | C(=) | | | +| Anchor MSC Address | | | C | C(=) | + +| | | | | | +|--------------------------|--|--|---|------| +| ASCI Call Reference | | | C | C(=) | +| Additional Subscriptions | | | C | C(=) | +| Kc | | | C | C(=) | +| User Error | | | C | C(=) | +| Provider Error | | | | O | + +7449 + +### 7450 10.7A.3 Parameter definitions and use + +#### 7451 Invoke Id + +7452 See definition in clause 7.6.1 + +#### 7453 Requested Info + +7454 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +#### 7455 Teleservice + +7456 Voice Broadcast Service or Voice Group Call Service. + +#### 7457 Cell Id + +7458 Identity of the initiating service subscriber's current cell. + +#### 7459 Group Id + +7460 For the definition and use of this parameter see 3GPP TS 43.068 [100] and 3GPP TS 43.069 [101]. + +7461 If prefixes are used together with group IDs, the most significant digit of the Group Id contains the prefix. + +#### 7462 IMSI + +7463 If sent in the request: Identity of the service subscriber who has established the call and who is allowed to terminate the + +7464 call. + +7465 If sent in the response: Identity of the uplink requesting service subscriber. + +#### 7466 Talker Priority + +7467 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +#### 7468 Additional Info + +7469 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +#### 7470 TMSI + +7471 See definition in clause 7.6.2. + +#### 7472 CKSN + +7473 See clause 7.6.7 for the use of this parameter. + +#### 7474 Anchor MSC Address + +7475 For the definition and use of this parameter see 3GPP TS 43.068 [100] and 3GPP TS 43.069 [101] + +#### 7476 ASCI Call Reference + +7477 For the definition and use of this parameter see 3GPP TS 43.068 [100] and 3GPP TS 43.069 [101] + +#### 7478 Additional Subscriptions + +7479 For the definition and use of this parameter see 3GPP TS 43.068 [100] + +#### 7480 Kc + +7481 See clause 7.6.7 for the use of this parameter. + +#### 7482 User Error + +7483 For definition of this parameter see clause 7.6.1 The following errors defined in clause 7.6.1 may be used, depending on +7484 the nature of the fault: + +- 7485 - System Failure; +- 7486 - Unexpected Data Value; +- 7487 - Data Missing +- 7488 - TeleserviceNotProvisioned; +- 7489 - Unknown Subscriber; +- 7490 - Ongoing Call. + +#### 7491 Provider Error + +7492 See definition of provider error in clause 7.6.1. + +### 7493 10.8 Void + +### 7494 10.9 Void + +### 7495 10.10 MAP\_SET\_REPORTING\_STATE service + +#### 7496 10.10.1 Definition + +7497 This service is used between the HLR and the VLR to set the reporting state for a requested service. It is a confirmed +7498 service using the service primitives shown in table 10.10/1. + +#### 7499 10.10.2 Service primitives + +7500 **Table 10.10/1: MAP\_SET\_REPORTING\_STATE parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | +| LMSI | C | C(=) | | | +| CCBS Monitoring | C | C(=) | | | +| CCBS Subscriber Status | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7501 + +#### 7502 10.10.3 Parameter use + +7503 See clause 7.6 for a definition of the parameters used, in addition to the following. + +##### 7504 IMSI + +7505 The IMSI is a mandatory parameter if the service is used as the only one in a dialogue. + +##### 7506 CCBS Monitoring + +7507 This parameter indicates whether monitoring for CCBS shall be started or stopped. If it indicates that monitoring shall + 7508 be started this service corresponds to the message 'Start Reporting' in 3GPP TS 23.093 [107]; if it indicates that + 7509 monitoring shall be stopped this service corresponds to the message 'Stop Reporting' in 3GPP TS 23.093 [107]. + +7510 CCBS Subscriber Status + +7511 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7512 User error + +7513 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following + 7514 values defined in clause 7.6.1: + +- 7515 - System Failure; +- 7516 - Unidentified Subscriber; +- 7517 - Unexpected Data Value; +- 7518 - Data Missing; +- 7519 - Resource Limitation; +- 7520 - Facility Not Supported. + +7521 NOTE: This error is reserved for future use. + +7522 Provider error + +7523 These are defined in clause 7.6. + +## 7524 10.11 MAP\_STATUS\_REPORT service + +### 7525 10.11.1 Definition + +7526 This service is used by the VLR to report an event or call outcome to the HLR. It is a confirmed service using the + 7527 service primitives shown in table 10.11/1. + +### 7528 10.11.2 Service primitives + +7529 **Table 10.11/1: MAP\_STATUS\_REPORT parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| CCBS Subscriber Status | C | C(=) | | | +| Monitoring Mode | C | C(=) | | | +| Call Outcome | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7530 + +### 7531 10.11.3 Parameter use + +7532 See clause 7.6 for a definition of the parameters used, in addition to the following. + +7533 CCBS Subscriber Status + +7534 If this parameter is present without Monitoring Mode and Call Outcome this service corresponds to the message 'Event + 7535 Report' in 3GPP TS 23.093 [107]. See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its + 7536 presence. + +7537 Monitoring Mode + +7538 If this parameter is present with CCBS Call Outcome this service corresponds to the message 'CCBS Call Report' in +7539 3GPP TS 23.093 [107]. See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +#### 7540 Call Outcome + +7541 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +#### 7542 User error + +7543 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7544 values defined in clause 7.6.1: + +- 7545 - Unknown Subscriber; +- 7546 - System Failure; +- 7547 - Unexpected Data Value; +- 7548 - Data Missing. + +#### 7549 Provider error + +7550 These are defined in clause 7.6. + +## 7551 10.12 MAP\_REMOTE\_USER\_FREE service + +### 7552 10.12.1 Definition + +7553 This service is used between the HLR and the VLR to report that the B subscriber is now idle and that the A subscriber +7554 can be notified. It is a confirmed service using the service primitives shown in table 10.12/1. + +### 7555 10.12.2 Service primitives + +7556 **Table 10.12/1: MAP\_REMOTE\_USER\_FREE parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| Call Info | M | M(=) | | | +| CCBS Feature | M | M(=) | | | +| Translated B Number | M | M(=) | | | +| Replace B Number | C | C(=) | | | +| Alerting Pattern | C | C(=) | | | +| RUF Outcome | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7557 + +### 7558 10.12.3 Parameter use + +7559 See clause 7.6 for a definition of the parameters used, in addition to the following. + +#### 7560 Call Info + +7561 See 3GPP TS 23.093 [107] for the use of this parameter. + +#### 7562 CCBS Feature + +7563 See 3GPP TS 23.093 [107] for the conditions for the presence of the parameters included in the CCBS feature. + +#### 7564 Translated B Number + +7565 See 3GPP TS 23.093 [107] for the use of this parameter. + +7566 Replace B Number + +7567 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7568 Alerting Pattern + +7569 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7570 RUF Outcome + +7571 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +7572 User error + +7573 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7574 values defined in clause 7.6.1: + +- 7575 - Unexpected Data Value; +- 7576 - Data Missing; +- 7577 - Incompatible Terminal; +- 7578 - This error is returned by the responder when the terminal used for CCBS activation is not compatible with the +7579 terminal used for the CCBS recall. For details refer to 3GPP TS 24.008 [35]; +- 7580 - Absent Subscriber (IMSI Detach; Restricted Area; No Page Response); +- 7581 - System Failure; +- 7582 - Busy Subscriber (CCBS Busy). + +7583 Provider error + +7584 These are defined in clause 7.6. + +7585 **10.13 MAP\_IST\_ALERT service** + +7586 **10.13.1 Definition** + +7587 This service is used between the MSC (Visited MSC or Gateway MSC) and the HLR, to report that the IST timer +7588 running for a call for the Subscriber has expired. It is a confirmed service using the service primitives shown in +7589 table 10.13/1. + +7590 **10.13.2 Service primitives** + +7591 **Table 10.13/1: MAP\_IST\_ALERT parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| IST Alert Timer | | | C | C(=) | +| IST Information Withdraw | | | C | C(=) | +| Call termination Indicator | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7592 + +7593 **10.13.3 Parameter use** + +7594 All parameters are described in clause 7.6. The following clarifications are applicable: + +7595 IST Alert Timer + +7596 If included in the IST Alert response, it includes the new IST Alert timer value that must be used to inform the HLR +7597 about the call activities that the subscriber performs. + +7598 IST Information Withdraw + +7599 If included in the IST Alert response, this parameter is used to indicate that the IST condition has been removed for the +7600 subscriber. When the MSC receives this parameter, IST control for that call shall be terminated. + +7601 Call termination Indicator + +7602 If included in the IST Alert response, this parameter is used to indicate whether the MSC shall terminate the call activity +7603 that had previously triggered the IST Alert procedure, or it shall also release all other call activities for the specified +7604 subscriber (outgoing call activities if the IST Alert is initiated by the VMSC, or incoming call activities if the IST Alert +7605 is initiated by the GMSC). Release of all other call activities is possible only if the MSC has the capability to link the +7606 call activities for the Subscriber by using the IMSI as key. + +7607 User error + +7608 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 7609 - System Failure; +- 7610 - Unexpected Data Value; +- 7611 - Resource Limitation; +- 7612 - Facility Not Supported; +- 7613 - Unknown Subscriber. + +## 7614 10.14 MAP\_IST\_COMMAND service + +### 7615 10.14.1 Definition + +7616 This service is used by the HLR to instruct the MSC (Visited MSC or Gateway MSC) to terminate ongoing call +7617 activities for a specific subscriber. It is a confirmed service using the service primitives shown in table 10.14/1. + +### 7618 10.14.2 Service primitives + +7619 **Table 10.14/1: MAP\_IST\_COMMAND parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7620 + +### 7621 10.14.3 Parameter use + +7622 All parameters are described in clause 7.6. The following clarifications are applicable: + +7623 User error + +7624 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 7625 - System Failure; +- 7626 - Unexpected Data Value; +- 7627 - Resource Limitation; +- 7628 - Facility Not Supported; + +7629 - Unknown Subscriber. + +## 7630 10.15 MAP\_RELEASE\_RESOURCES service + +### 7631 10.15.1 Definition + +7632 This service is used between the GMSC and the terminating VMSC. The service is invoked by the GMSC to request the +7633 VMSC to release the resources associated with the specified MSRN. + +7634 This is a confirmed service which uses the Primitives listed in table 10.15/1. + +### 7635 10.15.2 Service primitives + +7636 **Table 10.15/1: MAP\_RELEASE\_RESOURCES parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MSRN | M | M(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7637 + +### 7638 10.15.3 Parameter use + +#### 7639 MSRN + +7640 See 3GPP TS 23.018 [97] for the use of this parameter. + +#### 7641 User error + +7642 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- 7643 - System Failure; +- 7644 - Unexpected Data Value; + +#### 7645 Provider error + +7646 These are defined in clause 7.6. + +--- + +## 7647 11 Supplementary services related services + +### 7648 11.1 MAP\_REGISTER\_SS service + +#### 7649 11.1.1 Definition + +7650 This service is used between the MSC and the VLR and between the VLR and the HLR to register data related to a +7651 supplementary service. The VLR will relay the message to the HLR. + +7652 The service is a confirmed service and uses the service primitives shown in table 11.1/1. + +#### 7653 11.1.2 Service primitives + +7654 **Table 11.1/1: MAP\_REGISTER\_SS parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | + +| | | | | | +|-------------------------------------|---|------|---|------| +| SS-Code | M | M(=) | | | +| Basic service | C | C(=) | | | +| Forwarded-to number with subaddress | C | C(=) | | | +| No reply condition time | C | C(=) | | | +| EMLPP default priority | C | C(=) | C | C(=) | +| Long FTN Supported | C | C(=) | | | +| NbrUser | C | C(=) | C | C(=) | +| Forwarding information | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7655 + +### 7656 11.1.3 Parameter use + +7657 Invoke id + +7658 See clause 7.6.1 for the use of this parameter. + +7659 SS-Code + +7660 This parameter indicates the supplementary service which the mobile subscriber wants to register. + +7661 Basic service + +7662 This parameter indicates for which basic service group the supplementary service is to be registered. If it is not +7663 included, the registration request applies to all basic services. + +7664 Forwarded-to number with subaddress + +7665 This parameter is obligatory if the registration applies to one or more call forwarding supplementary services. It can +7666 optionally include a sub-address. + +7667 No reply condition time + +7668 This parameter is included if the registration applies to the Call Forwarding on No Reply supplementary service (or a +7669 superset of this service) and the mobile subscriber supplies a value for this time. + +7670 EMLPP default priority + +7671 This parameter is sent by the initiator to register the eMLPP default priority level and is returned by the responder at +7672 successful outcome of the service. + +7673 Long FTN Supported + +7674 This parameter indicates that the mobile station supports Long Forwarded-to Numbers. + +7675 NbrUser + +7676 This parameter is sent by the initiator to register the MC maximum number of user defined circuit switched bearers to +7677 be used. + +7678 Forwarding information + +7679 This parameter is returned by the responder at successful outcome of the service, if the registration request concerned +7680 one or a group of Call Forwarding supplementary services. + +7681 User error + +7682 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7683 values defined in clause 7.6.1: + +7684 - System failure; + +7685 - Data missing; + +7686 - Unexpected data value; + +- 7687 - Call Barred; +- 7688 - Bearer service not provisioned; +- 7689 - This error is returned only if not even a subset of the requested bearer service group has been subscribed to; +- 7690 - Teleservice not provisioned; +- 7691 This error is returned only if not even a subset of the requested teleservice group has been subscribed to; +- 7692 - Illegal SS operation; +- 7693 - SS error status; +- 7694 - SS incompatibility. + +7695 Provider error + +7696 See clause 7.6.1 for the use of this parameter. + +## 7697 11.2 MAP\_ERASE\_SS service + +### 7698 11.2.1 Definition + +7699 This service is used between the MSC and the VLR and between the VLR and the HLR to erase data related to a +7700 supplementary service. The VLR will relay the message to the HLR. + +7701 The service is a confirmed service and uses the service primitives shown in table 11.2/1. + +### 7702 11.2.2 Service primitives + +7703 **Table 11.2/1: MAP\_ERASE\_SS parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | | | +| Basic service | C | C(=) | | | +| Forwarding information | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7704 + +### 7705 11.2.3 Parameter use + +7706 Invoke id + +7707 See clause 7.6.1 for the use of this parameter. + +7708 SS-Code + +7709 This parameter indicates the supplementary service which the mobile subscriber wants to erase. + +7710 Basic service + +7711 This parameter indicates for which basic service group the supplementary service should be erased. If it is not included, +7712 the erasure request applies to all basic services. + +7713 Forwarding information + +7714 This parameter is returned by the responder at successful outcome of the service, if the erasure request concerned one or +7715 a group of Call Forwarding supplementary services. + +7716 User error + +7717 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7718 values, defined in clause 7.6.1: + +- 7719 - System failure; +- 7720 - Data Missing; +- 7721 - Unexpected data value; +- 7722 - Bearer service not provisioned; +7723 This error is returned only if not even a subset of the requested bearer service group has been subscribed to; +- 7724 - Teleservice not provisioned; +7725 This error is returned only if not even a subset of the requested teleservice group has been subscribed to; +- 7726 - Call Barred; +- 7727 - Illegal SS operation; +- 7728 - SS error status. + +7729 Provider error + +7730 See clause 7.6.1 for the use of this parameter. + +## 7731 11.3 MAP\_ACTIVATE\_SS service + +### 7732 11.3.1 Definition + +7733 This service is used between the MSC and the VLR and between the VLR and the HLR to activate a supplementary +7734 service. The VLR will relay the message to the HLR. + +7735 The service is a confirmed service and uses the service primitives shown in table 11.3/1. + +### 7736 11.3.2 Service primitives + +7737 **Table 11.3/1: MAP\_ACTIVATE\_SS parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | | | +| Long FTN Supported | C | C(=) | | | +| Basic service | C | C(=) | | | +| Forwarding information | | | C | C(=) | +| Call barring information | | | C | C(=) | +| SS-Data | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7738 + +### 7739 11.3.3 Parameter use + +7740 Invoke id + +7741 See clause 7.6.1 for the use of this parameter. + +7742 SS-Code + +7743 This parameter indicates the supplementary service which the mobile subscriber wants to activate. + +7744 Basic service + +7745 This parameter indicates for which basic service groups the requested supplementary service(s) should be activated. If it +7746 is not included, the activation request applies to all basic services. + +7747 Forwarding information + +7748 This parameter is returned by the responder at successful outcome of the service, if the activation request concerned +7749 Call Forwarding. + +7750 Long FTN Supported + +7751 This parameter indicates that the mobile station supports Long Forwarded-to Numbers. + +7752 Call barring information + +7753 This parameter is returned by the responder at successful outcome of the service, if the activation request concerned +7754 Call Barring. + +7755 SS-Data + +7756 This parameter is returned by the responder at successful outcome of the service, if the activation request concerned for +7757 example Call Waiting. + +7758 User error + +7759 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7760 values, defined in clause 7.6.1: + +- 7761 - System failure; +- 7762 - Data Missing; +- 7763 - Unexpected data value; +- 7764 - Bearer service not provisioned; +- 7765 - This error is returned only if not even a subset of the requested bearer service group has been subscribed to. +- 7766 - Teleservice not provisioned; +- 7767 - This error is returned only if not even a subset of the requested teleservice group has been subscribed to. +- 7768 - Call Barred; +- 7769 - Illegal SS operation; +- 7770 - SS error status; +- 7771 - SS subscription violation; +- 7772 - SS incompatibility; +- 7773 - Negative PW check; +- 7774 - Number Of PW Attempts Violation. + +7775 Provider error + +7776 See clause 7.6.1 for the use of this parameter. + +## 7777 11.4 MAP\_DEACTIVATE\_SS service + +### 7778 11.4.1 Definitions + +7779 This service is used between the MSC and the VLR and between the VLR and the HLR to deactivate a supplementary +7780 service. The VLR will relay the message to the HLR. + +7781 The service is a confirmed service and uses the service primitives shown in table 11.4/1. + +## 7782 11.4.2 Service primitives + +7783 **Table 11.4/1: MAP\_DEACTIVATE\_SS parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | | | +| Basic service | C | C(=) | | | +| Forwarding information | | | C | C(=) | +| Call barring information | | | C | C(=) | +| SS-Data | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7784 + +## 7785 11.4.3 Parameter use + +### 7786 Invoke id + +7787 See clause 7.6.1 for the use of this parameter. + +### 7788 SS-Code + +7789 This parameter indicates the supplementary service which the mobile subscriber wants to deactivate. + +### 7790 Basic service + +7791 This parameter indicates for which basic service group the requested supplementary service(s) should be deactivated. If +7792 it is not included the deactivation request applies to all basic services. + +### 7793 Forwarding information + +7794 This parameter is returned by the responder at successful outcome of the service, if the deactivation request concerned +7795 one or a group of Call Forwarding supplementary services. + +### 7796 Call barring information + +7797 This parameter is returned by the responder at successful outcome of the service, if the activation request concerned one +7798 or a group of Call Barring supplementary services. + +### 7799 SS-Data + +7800 This parameter is returned by the responder at successful outcome of the service, for example if the deactivation request +7801 concerned the Call Waiting supplementary service. + +### 7802 User error + +7803 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7804 values, defined in clause 7.6.1: + +- 7805 - System failure; +- 7806 - Data Missing; +- 7807 - Unexpected data value; +- 7808 - Bearer service not provisioned; +7809 This error is returned only if not even a subset of the requested bearer service group has been subscribed to; +- 7810 - Teleservice not provisioned; +7811 This error is returned only if not even a subset of the requested teleservice group has been subscribed to; + +- 7812 - Call Barred; +- 7813 - Illegal SS operation; +- 7814 - SS error status; +- 7815 - SS subscription violation; +- 7816 - Negative PW check; +- 7817 - Number Of PW Attempts Violation. + +7818 Provider error + +7819 See clause 7.6.1 for the use of this parameter. + +## 7820 11.5 MAP\_INTERROGATE\_SS service + +### 7821 11.5.1 Definitions + +7822 This service is used between the MSC and the VLR and between the VLR and the HLR to retrieve information related + 7823 to a supplementary service. The VLR will relay the message to the HLR if necessary. + +7824 The service is a confirmed service and consists of four service primitives. + +### 7825 11.5.2 Service primitives + +7826 The service primitives are shown in table 11.5/1. + +7827 **Table 11.5/1: MAP\_INTERROGATE\_SS parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | | | +| Basic service | C | C(=) | | | +| Long FTN Supported | C | C(=) | | | +| SS-Status | | | C | C(=) | +| Basic service Group LIST | | | C | C(=) | +| Forwarding feature LIST | | | C | C(=) | +| CLI restriction Info | | | C | C(=) | +| EMLPP Info | | | C | C(=) | +| MC Information | | | C | C(=) | +| CCBS Feature LIST | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7828 + +### 7829 11.5.3 Parameter use + +7830 For additional information on parameter use refer to the GSM 04.8x and 04.9x-series of technical specifications. + +7831 Invoke id + +7832 See clause 7.6.1 for the use of this parameter. + +7833 SS-Code + +7834 The mobile subscriber can only interrogate a single supplementary service per service request. + +7835 Basic service + +7836 This parameter indicates for which basic service group the given supplementary service is interrogated. If it is not + 7837 included, the interrogation request applies to all basic services. + +7838 SS-Status + +7839 This parameter is included by the responder if: + +- 7840 - the interrogated supplementary service can only be subscribed for all applicable basic services simultaneously; +- 7841 or +- 7842 - the interrogated supplementary service is not active for any of the interrogated basic services, or +- 7843 - the interrogation was for the CCBS supplementary service and no CCBS request is active or the service is not +- 7844 provisioned. + +7845 Basic service group LIST + +7846 This parameter LIST is used to include one or a series of basic service groups for which the interrogated supplementary + +7847 service is active. If the interrogated supplementary service is not active for any of the interrogated (and provisioned) + +7848 basic service groups, the SS-Status parameter is returned. + +7849 Long FTN Supported + +7850 This parameter indicates that the mobile station supports Long Forwarded-to Numbers. + +7851 Forwarding feature LIST + +7852 The forwarding feature parameter is described in clause 7.6.4. A list of one or more forwarding features is returned by + +7853 the responder when the interrogation request applied to Call Forwarding supplementary service. + +7854 If no basic service code parameter is provided within this sequence, the forwarding feature parameter applies to all + +7855 provisioned basic services. + +7856 CLI restriction Info + +7857 The CLI-RestrictionInfo parameter is returned by the responder when the interrogation request applies to the CLIR + +7858 supplementary service. + +7859 EMLPP Info + +7860 The eMLPP info (maximum entitled priority and default priority) is returned by the responder if the interrogation + +7861 request applies to the eMLPP supplementary service. + +7862 MC Information + +7863 The MC information (NbrSB, NbrUser and NbrSN) is returned by the responder if the interrogation request applies to + +7864 the MC supplementary service. For a definition of these 3 components, refer to 3GPP TS 23.135 and 3GPP TS 24.135. + +7865 CCBS Feature LIST + +7866 The CCBS feature parameter is described in clause 7.6. A list of one or more CCBS features is returned by the + +7867 responder when the interrogation request applied to the CCBS supplementary service. See 3GPP TS 23.093 [107] for + +7868 the conditions for the presence of the parameters included in the CCBS feature. + +7869 User error + +7870 This error is sent by the responder upon unsuccessful outcome of the interrogation service, and then takes one of the + +7871 following values, defined in clause 7.6.1: + +- 7872 - System failure; +- 7873 - Data Missing; +- 7874 - Unexpected data value; +- 7875 - Bearer Service not provisioned; +- 7876 This error is returned only if not even a subset of the interrogated bearer services are provided; +- 7877 - Teleservice not provisioned; + +7878 This error is returned only if not even a subset of the interrogated teleservices are provided; + +7879 - Call Barred; + +7880 - Illegal SS operation; + +7881 - SS not available. + +7882 Provider error + +7883 See clause 7.6.1 for the use of this parameter. + +## 7884 11.6 Void + +## 7885 11.7 MAP\_REGISTER\_PASSWORD service + +### 7886 11.7.1 Definitions + +7887 This service is used between the MSC and the VLR and between the VLR and the HLR if the mobile subscriber +7888 requests to register a new password. The VLR will relay the message to the HLR. + +7889 The service is a confirmed service and consists of four service primitives. + +### 7890 11.7.2 Service primitives + +7891 The service primitives are shown in table 11.7/1. + +7892 **Table 11.7/1: MAP\_REGISTER\_PASSWORD parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | | | +| New password | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7893 + +### 7894 11.7.3 Parameter use + +7895 Invoke id + +7896 See clause 7.6.1 for the use of this parameter. + +7897 SS-Code + +7898 This parameter indicates for which supplementary service(s) the password should be registered. + +7899 New Password + +7900 See clause 7.6.4 for the use of this parameter. + +7901 User error + +7902 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7903 values, defined in clause 7.6.1: + +7904 - System failure; + +7905 - Data Missing; + +7906 - Unexpected data value; + +- 7907 - Call Barred; +- 7908 - SS subscription violation; +- 7909 - Password registration failure; +- 7910 - Negative PW check; +- 7911 - Number Of PW Attempts Violation. + +7912 Provider error + +7913 See clause 7.6.1 for the use of this parameter. + +## 7914 11.8 MAP\_GET\_PASSWORD service + +### 7915 11.8.1 Definitions + +7916 This service is used between the HLR and the VLR and between the VLR and the MSC when the HLR receives a + 7917 request from the mobile subscriber for an operation on a supplementary service which requires a password from the + 7918 subscriber. The VLR will relay the message to the MSC. + +7919 The service is a confirmed service and uses the service primitives shown in table 11.8/1. + +### 7920 11.8.2 Service primitives + +7921 **Table 11.8/1: MAP\_GET\_PASSWORD parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Linked id | C | C(=) | | | +| Guidance info | M | M(=) | | | +| Current password | | | M | M(=) | +| Provider error | | | | O | + +7922 + +### 7923 11.8.3 Parameter use + +7924 Invoke id + +7925 See clause 7.6.1 for the use of this parameter. + +7926 Linked Id + +7927 See clause 7.6.1 for the use of this parameter. If the MAP\_GET\_PASSWORD service is used in conjunction with the + 7928 MAP\_REGISTER\_PASSWORD service, this parameter must be present; otherwise it must be absent. + +7929 Guidance info + +7930 See clause 7.6.4 for the use of this parameter. + +7931 Current password + +7932 See clause 7.6.4 for the use of this parameter. + +7933 Provider error + +7934 See clause 7.6.1 for the use of this parameter. + +## 7935 11.9 MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST 7936 service + +## 11.9.1 Definitions + +This service is used between the MSC and the VLR, between the VLR and the HLR, between the HLR and gsmSCF and between the HLR and HLR to relay information in order to allow unstructured supplementary service operation. + +The MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST service is a confirmed service using the primitives from table 11.9/1. + +## 11.9.2 Service primitives + +**Table 11.9/1: MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| USSD Data Coding Scheme | M | M(=) | C | C(=) | +| USSD String | M | M(=) | C | C(=) | +| MSISDN | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +## 11.9.3 Parameter use + +### Invoke id + +See clause 7.6.1 for the use of this parameter. + +### USSD Data Coding Scheme + +See clause 7.6.4 for the use of this parameter. The presence of the parameter in the response is dependent on the unstructured supplementary service application. If this parameter is present, then the USSD String parameter has to be present. + +### USSD String + +See clause 7.6.1 for the use of this parameter. The presence of the parameter in the response is dependent on the unstructured supplementary service application. If this parameter is present, then the USSD Data Coding Scheme parameter has to be present. + +### MSISDN + +The subscriber's basic MSISDN. + +See definition in clause 7.6.2. For Follow Me when the service request is sent from the HLR of the A subscriber, the parameter shall contain the MSISDN of the A subscriber, see 3GPP TS 23.094 [129]. For other purposes the MSISDN may be included as an operator option, e.g. to allow addressing the subscriber's data in the gsmSCF with the MSISDN. + +### User error + +This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following values defined in clause 7.6.1: + +- System failure; + +- Data missing; + +- Unexpected data value; + +This error is returned by the responder if it is not able to deal with the contents of the USSD string. + +- Call Barred; + +- Unknown Alphabet. + +### Provider error + +7971 See clause 7.6.1 for the use of this parameter. + +## 7972 11.10 MAP\_UNSTRUCTURED\_SS\_REQUEST service + +### 7973 11.10.1 Definitions + +7974 This service is used between the gsmSCF and the HLR, the HLR and the VLR and between the VLR and the MSC +7975 when the invoking entity requires information from the mobile user, in connection with unstructured supplementary +7976 service handling. + +7977 The MAP\_UNSTRUCTURED\_SS\_REQUEST service is a confirmed service using the primitives from table 11.10/1. + +### 7978 11.10.2 Service primitives + +7979 **Table 11.10/1: MAP\_UNSTRUCTURED\_SS\_REQUEST parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| USSD Data Coding Scheme | M | M(=) | C | C(=) | +| USSD String | M | M(=) | C | C(=) | +| Alerting Pattern | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +7980 + +### 7981 11.10.3 Parameter use + +#### 7982 Invoke id + +7983 See clause 7.6.1 for the use of this parameter. + +#### 7984 USSD Data Coding Scheme + +7985 See clause 7.6.4 for the use of this parameter. The presence of the parameter in the response is dependent on the mobile +7986 user's MMI input. If this parameter is present, then the USSD String parameter has to be present. + +#### 7987 USSD String + +7988 See clause 7.6.1 for the use of this parameter. The presence of the parameter in the response is dependent on the mobile +7989 user's MMI input. If this parameter is present, then the USSD Data Coding Scheme parameter has to be present. + +#### 7990 Alerting Pattern + +7991 See clause 7.6.3 for the use of this parameter. + +#### 7992 User error + +7993 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +7994 values defined in clause 7.6.1: + +- 7995 - System failure; +- 7996 - Data missing; +- 7997 - Unexpected data value; +- 7998 This error is returned by the responder if it is not able to deal with the contents of the USSD string; +- 7999 - Absent Subscriber; +- 8000 - Illegal Subscriber; + +8001 This error indicates that delivery of the unstructured supplementary service data failed because the MS failed +8002 authentication; +8003 - Illegal Equipment; +8004 - USSD Busy; +8005 - Unknown Alphabet. +8006 Provider error +8007 See clause 7.6.1 for the use of this parameter. + +## 8008 11.11 MAP\_UNSTRUCTURED\_SS\_NOTIFY service + +### 8009 11.11.1 Definitions + +8010 This service is used between the gsmSCF and the HLR, the HLR and the VLR and between the VLR and the MSC +8011 when the invoking entity requires a notification to be sent to the mobile user, in connection with unstructured +8012 supplementary services handling. + +8013 The MAP\_UNSTRUCTURED\_SS\_NOTIFY service is a confirmed service using the primitives from table 11.11/1. + +### 8014 11.11.2 Service primitives + +8015 **Table 11.11/1: MAP\_UNSTRUCTURED\_SS\_NOTIFY parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| USSD Data Coding Scheme | M | M(=) | | | +| USSD String | M | M(=) | | | +| Alerting Pattern | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8016 + +### 8017 11.11.3 Parameter use + +8018 Invoke id + +8019 See clause 7.6.1 for the use of this parameter. + +8020 USSD Data Coding Scheme: + +8021 See clause 7.6.4 for the use of this parameter. + +8022 USSD String: + +8023 See clause 7.6.1 for the use of this parameter. + +8024 Alerting Pattern + +8025 See clause 7.6.3 for the use of this parameter. + +8026 User error + +8027 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +8028 values defined in clause 7.6.1: + +8029 - System failure; + +8030 - Data missing; + +- 8031 - Unexpected data value; +- 8032 This error is returned by the responder if it is not able to deal with the contents of the USSD string. +- 8033 - Absent Subscriber; +- 8034 - Illegal Subscriber; +- 8035 This error indicates that delivery of the unstructured supplementary service data failed because the MS failed +8036 authentication. +- 8037 - Illegal Equipment; +- 8038 - USSD Busy; +- 8039 - Unknown Alphabet. +- 8040 Provider error +- 8041 See clause 7.6.1 for the use of this parameter. + +## 8042 11.12 MAP\_SS\_INVOCATION\_NOTIFY + +### 8043 11.12.1 Definition + +- 8044 This service is used between the MSC and the gsmSCF when the subscriber invokes one of the following +8045 supplementary services; Call Deflection (CD), Explicit Call Transfer (ECT) or Multi Party (MPTY). +- 8046 This service is used between the HLR and the gsmSCF when the subscriber invokes the CCBS supplementary service. + +### 8047 11.12.2 Service primitives + +- 8048 The service primitives are shown in table 11.12/1. + +8049 **Table 11.12/1: SS\_INVOCATION\_NOTIFY parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| MSISDN | M | M(=) | | | +| IMSI | M | M(=) | | | +| SS- event | M | M(=) | | | +| SS- event data | C | C(=) | | | +| B-subscriber Number | C | C(=) | | | +| CCBS Request State | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8050 + +### 8051 11.12.3 Parameter use + +- 8052 All parameters are described in clause 7.6. The use of these parameters and the requirements for their presence are +8053 specified in 3GPP TS 23.078. + +#### 8054 User error + +- 8055 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: +- 8056 - Data Missing; +- 8057 - Unexpected Data Value; +- 8058 - Unknown Subscriber. + +8059 Provider error + +8060 This is defined in clause 7.6.1. + +## 8061 11.13 MAP\_REGISTER\_CC\_ENTRY service + +### 8062 11.13.1 Definition + +8063 This service is used between the MSC and the VLR and between the VLR and the HLR to register data for a requested +8064 call completion supplementary service. The VLR will relay the message to the HLR. + +8065 The service is a confirmed service and uses the service primitives shown in table 11.13/1. + +### 8066 11.13.2 Service primitives + +8067 **Table 11.13/1: MAP\_REGISTER\_CC\_ENTRY parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS Code | M | M(=) | | | +| CCBS Feature | C | C(=) | C | C(=) | +| Translated B number | C | C(=) | | | +| Service Indicator | C | C(=) | | | +| Call Info | C | C(=) | | | +| Network Signal Info | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8068 + +### 8069 11.13.3 Parameter use + +8070 See clause 7.6 for a definition of the parameters used, in addition to the following. + +#### 8071 SS-Code + +8072 This parameter indicates the call completion supplementary service for which the mobile subscriber wants to register an +8073 entry. + +#### 8074 CCBS Feature + +8075 See 3GPP TS 23.093 [107] for the conditions for the presence of the parameters included in the CCBS feature. + +#### 8076 Translated B Number + +8077 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +#### 8078 Service Indicator + +8079 This parameter corresponds to the parameters 'Presentation Indicator' and 'CAMEL Invoked' in 3GPP TS 23.093 [107]. +8080 It indicates which services have been invoked for the original call (e.g. CLIR, CAMEL). See 3GPP TS 23.093 [107] for +8081 the use of this parameter and the conditions for its presence. + +#### 8082 Call Info + +8083 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +#### 8084 Network Signal Info + +8085 See 3GPP TS 23.093 [107] for the use of this parameter and the conditions for its presence. + +#### 8086 User error + +8087 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +8088 values, defined in clause 7.6.1: + +- 8089 - System failure; +- 8090 - Data missing; +- 8091 - Unexpected data value; +- 8092 - Call Barred; +- 8093 - Illegal SS operation; +- 8094 - SS error status; +- 8095 - SS incompatibility. +- 8096 - Short Term Denial; +- 8097 - Long Term Denial; +- 8098 - Facility Not Supported; + +8099 NOTE: This error is reserved for future use. + +8100 Private Extensions shall not be sent with these user errors for this operation. + +8101 Provider error + +8102 See clause 7.6.1 for the use of this parameter. + +## 8103 11.14 MAP\_ERASE\_CC\_ENTRY service + +### 8104 11.14.1 Definition + +8105 This service is used between the MSC and the VLR and between the VLR and the HLR to erase data related to a call +8106 completion supplementary service. The VLR will relay the message to the HLR. + +8107 The service is a confirmed service and uses the service primitives shown in table 11.14/1. + +### 8108 11.14.2 Service primitives + +8109 **Table 11.14/1: MAP\_ERASE\_CC\_ENTRY parameters** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| SS-Code | M | M(=) | C(=) | C(=) | +| CCBS Index | C | C(=) | | | +| SS-Status | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8110 + +### 8111 11.14.3 Parameter use + +8112 See clause 7.6 for a definition of the parameters used, in addition to the following. + +8113 SS-Code + +8114 This parameter indicates the call completion supplementary service for which the mobile subscriber wants to erase an +8115 entry/entries. + +8116 CCBS Index + +8117 See 3GPP TS 23.093 [107] for the use of this parameter and the condition for its presence. + +8118 SS-Status + +8119 Depending on the outcome of the service request this parameter may indicate either provisioned and active or not +8120 provisioned. + +8121 User error + +8122 This parameter is sent by the responder upon unsuccessful outcome of the service, and then takes one of the following +8123 values, defined in clause 7.6.1: + +- 8124 - System failure; +- 8125 - Data Missing; +- 8126 - Unexpected data value; +- 8127 - Call Barred; +- 8128 - Illegal SS operation; +- 8129 - SS error status. + +8130 Private Extensions shall not be sent with these user errors for this operation. + +8131 Provider error + +8132 See clause 7.6.1 for the use of this parameter. + +--- + +## 8133 12 Short message service management services + +### 8134 12.1 MAP-SEND-ROUTING-INFO-FOR-SM service + +#### 8135 12.1.1 Definition + +8136 This service is used between the gateway MSC and the HLR to retrieve the routing information needed for routing the +8137 short message to the servicing MSC or MME but not both, or SGSN, or (for T4-device triggering via the IMS) IP-SM- +8138 GW, or SMSF. This service is also used between the gateway MSC and SMS Router, and SMS Router and HLR in +8139 order to enforce routing of the SM delivery via the HPLMN of the receiving MS. This service is also used between +8140 HLR and IP-SM-GW, and between IP-SM-GW and HLR in order to allow MT-SM delivery (other than T4-device +8141 triggering) via the IMS. + +8142 This service is also used with an IWF interfacing the S6c interface. + +8143 The MAP-SEND-ROUTING-INFO-FOR-SM is a confirmed service using the primitives from table 12.1/1. + +#### 8144 12.1.2 Service primitives + +8145 **Table 12.1/1: MAP-SEND-ROUTING-INFO-FOR-SM** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MSISDN | M | M(=) | | | +| SM-RP-PRI | M | M(=) | | | +| Service Centre Address | M | M(=) | | | +| SM-RP-MTI | C | C(=) | | | +| SM-RP-SMEA | C | C(=) | | | +| GPRS Support Indicator | C | C(=) | | | +| SM-Delivery Not Intended | U | C(=) | | | +| IP-SM-GW Guidance | U | C(=) | | | + +| | | | | | +|------------------------------------------|---|------|---|------| +| Support Indicator | | | | | +| Single Attempt Delivery | C | C(=) | | | +| IMSI | C | C(=) | C | C(=) | +| Correlation ID | C | C(=) | | | +| T4 Trigger Indicator | C | C(=) | | | +| SMSF Support Indicator | C | C(=) | | | +| Network Node Number | | | C | C(=) | +| Network Node Diameter Address | | | C | C(=) | +| LMSI | | | C | C(=) | +| GPRS Node Indicator | | | C | C(=) | +| Additional Number | | | C | C(=) | +| Additional Network Node Diameter Address | | | C | C(=) | +| IP-SM-GW Guidance | | | U | C(=) | +| Third Number | | | C | C(=) | +| Third Network Node Diameter Address | | | C | C(=) | +| IMS Node Indicator | | | C | C(=) | +| SMSF 3GPP Number | | | C | C(=) | +| SMSF 3GPP Diameter Address | | | C | C(=) | +| SMSF Non-3GPP Number | | | C | C(=) | +| SMSF Non-3GPP Diameter Address | | | C | C(=) | +| SMSF 3GPP Address Indicator | | | C | C(=) | +| SMSF Non 3GPP Address Indicator | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8146 + +### 8147 12.1.3 Parameter use + +#### 8148 Invoke id + +8149 See definition in clause 7.6.1. + +#### 8150 MSISDN + +8151 See definition in clause 7.6.2. + +8152 When SEND-ROUTING-INFO-FOR-SM is sent by the SMS-GMSC to the HLR following an T4 Submit Trigger (see +8153 3GPP TS 23.682 [148]), MSISDN may not be available. In this case the UE shall be identified by the IMSI and the +8154 MSISDN shall take the dummy MSISDN value (see clause 3 of 3GPP TS 23.003 [17]). + +8155 When SEND-ROUTING-INFO-FOR-SM is sent by the SMS-GMSC to the HLR in a retry context of SMS for IMS UE +8156 to IMS UE without MSISDN (see 3GPP TS 23.204 [134]), MSISDN may not be available. In this case the UE shall be +8157 identified by a Correlation ID (SIP-URI-B) and the MSISDN shall take the dummy MSISDN value (see clause 3 of +8158 3GPP TS 23.003 [17]). + +#### 8159 SM-RP-PRI + +8160 See definition in clause 7.6.8. + +#### 8161 Service Centre Address + +8162 See definition in clause 7.6.2. + +#### 8163 SM-RP-MTI + +8164 See definition in clause 7.6.8. This parameter shall be present when the feature « SM filtering by the HPLMN » is +8165 supported by the SMS-GMSC and when the equivalent parameter is received from the short message service relay sub- +8166 layer protocol. + +8167 SM-RP-SMEA + +8168 See definition in clause 7.6.8. This parameter shall be present when the feature « SM filtering by the HPLMN » is +8169 supported by the SMS-GMSC and when the equivalent parameter is received from the short message service relay sub- +8170 layer protocol. + +8171 GPRS Support Indicator + +8172 See definition in clause 7.6.8. The presence of this parameter is mandatory if the SMS-GMSC supports receiving of the +8173 two numbers from the HLR. + +8174 SM-Delivery Not Intended + +8175 This parameter indicates by its presence that delivery of a short message is not intended. It further indicates whether +8176 only IMSI or only MCC+MNC are requested. + +8177 This parameter may be set by entities that request the service without intending to deliver a short message (e.g. MMS +8178 Relay/Server), and shall be evaluated by the SMS Router and may be evaluated by the HLR. + +8179 IP-SM-GW Guidance Support Indicator + +8180 This parameter indicates whether or not the SMS-GMSC is prepared to receive IP-SM-GW Guidance in the response. + +8181 Single Attempt Delivery + +8182 This parameter indicates the short message is only valid for delivering once, and the HLR/HSS does not need to add the +8183 received SC address into MWD list in the case there is no serving node available to provide SMS to the user. + +8184 IMSI + +8185 See definition in clause 7.6.2. + +8186 In Request and Indication: + +8187 IMSI shall be present if MSISDN is not available. When SEND-ROUTING-INFO-FOR-SM is sent by the SMS-GMSC +8188 to the HLR in a retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [134]), IMSI may +8189 not be available. In this case the IMSI parameter shall be populated with the HLR-ID value. + +8190 In Response and Confirm: If enforcement of routing an SM via the HPLMN of the receiving MS is deployed, this +8191 parameter contains an MT Correlation ID instead of an IMSI when the service is used between SMS-GMSC and SMS +8192 Router (see 3GPP TS 23.040 [26] for more information). If the "SM-Delivery Not Intended" parameter was present in +8193 the Indication with a value of "only MCC+MNC requested", then this parameter may contain MCC+MNC+dummy +8194 MSIN. + +8195 The presence of this parameter is mandatory in a successful case. + +8196 T4 Trigger Indicator + +8197 This indicator indicates by its presence that the request is sent in the context of T4 device triggering (see 3GPP TS +8198 23.682 [148]). When received, the HLR may return up to three serving node numbers and shall not forward the request +8199 to an IP-SM-GW or SMS Router. + +8200 SMSF Support Indicator + +8201 It indicates that the requesting node is capable of receiving ISDN numbers and/or Diameter addresses of the SMSF as +8202 target of MT-SMS. + +8203 Correlation ID + +8204 The Correlation ID parameter contains the SIP-URI-B identifying the (MSISDN-less) destination user. SIP-URI-A and +8205 HLR-ID shall be absent from this parameter. + +8206 The Correlation ID indicates by its presence that the request is sent in the context of MSISDN-less SMS delivery in +8207 IMS (see 3GPP TS 23.204 [134]). When received, the HLR shall return the IP-SM-GW number and shall not forward +8208 the request to an IP-SM-GW. + +8209 Network Node Number + +8210 See definition in clause 7.6.2. This parameter is provided in a successful response. If the "SM-Delivery Not Intended" +8211 parameter was present in the Indication a dummy address (encoded in the same manner as the dummy MSISDN defined +8212 in clause 3.3 of 3GPP TS 23.003 [17]) may be provided. See clause 12.1.4. + +8213 Network Node Diameter Address + +8214 See definition in clause 7.6.2. See clause 12.1.4. + +8215 LMSI + +8216 See definition in clause 7.6.2. It is an operator option to provide this parameter from the VLR; it is mandatory for the +8217 HLR to include the LMSI in a successful response, if the VLR has used the LMSI. + +8218 GPRS Node Indicator + +8219 See definition in clause 7.6.8. + +8220 Outside the context of T4 device triggering: The presence of this parameter is mandatory if only the SGSN number is +8221 sent in the Network Node Number (i.e. if the value within Network Node Number is to be considered as SGSN-Number +8222 and Additional Number is absent). + +8223 Within the context of T4 device triggering: The presence of this parameter is mandatory if the value within Network +8224 Node Number is to be considered as SGSN-Number and Third Number is absent. + +8225 Additional Number + +8226 See definition in clause 7.6.2. See clause 12.1.4. + +8227 Additional Network Node Diameter Address + +8228 See definition in clause 7.6.2. See clause 12.1.4. + +8229 IP-SM-GW Guidance + +8230 This parameter contains the recommended and the minimum timer values for supervision of MT-Forward-Short- +8231 Message response. Shall be absent if the IP-SM-GW-Guidance Support Indicator in the request is absent. This +8232 parameter is only used by IP-SM-GW and SMS-GMSC. + +8233 Third Number + +8234 See definition in clause 7.6.2. See clause 12.1.4. + +8235 Third Network Node Diameter Address + +8236 See definition in clause 7.6.2. See clause 12.1.4. + +8237 IMS Node Indicator + +8238 See definition in clause 7.6.8. + +8239 Outside the context of T4 device triggering: The parameter is not applicable and shall be absent. + +8240 Within the context of T4 device triggering: The presence of this parameter is mandatory if the value within Network +8241 Node Number is to be considered as IP-SM-GW-Number and Third Number is absent. + +8242 SMSF 3GPP Number + +8243 This parameter contains the ISDN number of the SMSF target node for MT-SMS over 3GPP access. + +8244 SMSF 3GPP Diameter Address + +8245 This parameter contains the Diameter Name and Realm of the SMSF target node for MT-SMS over 3GPP access. + +8246 SMSF Non-3GPP Number + +8247 This parameter contains the ISDN number of the SMSF target node for MT-SMS over non-3GPP access. + +8248 SMSF Non-3GPP Diameter Address + +8249 This parameter contains the Diameter Name and Realm of the SMSF target node for MT-SMS over non-3GPP access. + +#### 8250 SMSF 3GPP Address Indicator + +8251 It indicates that the parameter Network Node Number (and Network Node Diameter Address, if present) contains the +8252 address of an SMSF for 3GPP access. + +#### 8253 SMSF Non-3GPP Address Indicator + +8254 It indicates that the parameter Network Node Number (and Network Node Diameter Address, if present) contains the +8255 address of an SMSF for non-3GPP access. + +#### 8256 User error + +8257 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8258 - Unknown subscriber; +- 8259 - Call Barred; +- 8260 - Teleservice Not Provisioned; +- 8261 - Absent Subscriber\_SM; +- 8262 - Facility Not Supported; +- 8263 - System failure; +- 8264 - Unexpected Data Value; +- 8265 - Data missing. + +#### 8266 Provider error + +8267 For definition of provider errors see clause 7.6.1. + +### 8268 **12.1.4 Identities of MT-SMS Target Nodes** + +8269 In a successful MAP-Send-Routing-Info-For-SM response at least one MT-SMS Target Node identity or an SMS +8270 Router identity shall be present and this shall be an E.164 number within the Network Node Number parameter. + +8271 In addition, optionally a second Target Node identity or an SMS Router identity may be present as E.164 number within +8272 the Additional Number Parameter. + +8273 In T4 device trigger scenarios in addition to a second Target Node identity, a third Target Node Identity may be present +8274 as E.164 number within the Third Number parameter. + +8275 In addition to the E.164 identity of an MT-SMS Target Node or an SMSRouter, the presence of the Diameter +8276 Name/Realm of the corresponding target node or SMS Router follows the hereafter rules: + +- 8277 - If Network Node Number contains an MME number for SMS, Network Node Diameter Address shall be present +8278 and contain the Diameter address of the MME. +- 8279 - If Network Node Number contains an MSC number, Network Node Diameter Address may be present and shall +8280 contain the Diameter address of the MME. +- 8281 - If Network Node Number contains an SGSN number, Network Node Diameter Address shall be present only if +8282 the HSS has received the information that SGSN supports the Gdd interface. +- 8283 - If Network Node Number contains an SMS Router number, Network Node Diameter Address may be present +8284 and shall contain the SMS Router Diameter address. +- 8285 - If Network Node Number contains an IP-SM-GW number, Network Node Diameter Address may be present and +8286 shall contain the IP-SM-GW Diameter address. + +8287 Similar for Additional Number - Additional Network Node Diameter Address; + +8288 Similar for Third Number - Third Network Node Diameter Address. + +8289 In scenarios supporting interworking with 5G System, an E.164 Number and a Diameter Address of the SMSF may be + 8290 present, for both 3GPP and non-3GPP accesses. In addition: + +- 8291 - If Network Node Number contains an SMSF 3GPP number, Network Node Diameter Address may be present + 8292 and shall contain the SMSF 3GPP Diameter address. +- 8293 - If Network Node Number contains an SMSF Non-3GPP number, Network Node Diameter Address may be + 8294 present and shall contain the SMSF Non-3GPP Diameter address. + +8295 + +## 8296 12.2 MAP-MO-FORWARD-SHORT-MESSAGE service + +### 8297 12.2.1 Definition + +8298 This service is used between the serving MSC or the SGSN or IP-SM-GW and the SMS Interworking MSC to forward + 8299 mobile originated short messages. + +8300 The MAP-MO-FORWARD-SHORT-MESSAGE service is a confirmed service using the service primitives given in + 8301 table 12.2/1. + +### 8302 12.2.2 Service primitives + +8303 + +**Table 12.2/1: MAP-MO-FORWARD-SHORT-MESSAGE** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| SM RP DA | M | M(=) | | | +| SM RP OA | M | M(=) | | | +| SM RP UI | M | M(=) | C | C(=) | +| IMSI | C | C(=) | | | +| Correlation ID | C | C(=) | | | +| SM Delivery Outcome | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8304 + +### 8305 12.2.3 Parameter use + +8306 Invoke id + +8307 See definition in clause 7.6.1. + +8308 SM RP DA + +8309 See definition in clause 7.6.8. + +8310 In the mobile originated SM transfer this parameter contains the Service Centre address received from the mobile + 8311 station. + +8312 SM RP OA + +8313 See definition in clause 7.6.8. + +8314 The MSISDN received from the VLR or from the SGSN is inserted in this parameter in the mobile originated SM + 8315 transfer. + +8316 A Dummy MSISDN value is used for MSISDN-less SMS in IMS. In this case the originating user is identified by SIP- + 8317 URI-A (see Correlation ID). + +8318 SM RP UI + +8319 See definition in clause 7.6.8. The short message transfer protocol data unit received from the Service Centre is inserted +8320 in this parameter. + +8321 IMSI + +8322 See definition in clause 7.6.2.1. The IMSI of the originating subscriber shall be inserted in this parameter in the mobile +8323 originated SM transfer. + +8324 Correlation ID + +8325 The Correlation ID is composed of an HLR-Id identifying the destination user's HLR, a SIP-URI-B identifying the +8326 MSISDN-less destination user, and a SIP-URI-A identifying the originating user. + +8327 The Correlation ID indicates by its presence that the request is sent in the context of MSISDN-less SMS delivery in +8328 IMS (see 3GPP TS 23.204 [134]), and that a Report-SM-Delivery status needs to be sent to the HLR to add the SC +8329 address to the MWD. + +8330 SM Delivery Outcome + +8331 See definition in clause 7.6.8. This parameter indicates the status of the mobile terminated SM delivery. + +8332 Shall be present if Correlation ID is present and shall take one of the unsuccessful outcome values. + +8333 User error + +8334 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8335 - Facility Not Supported; +- 8336 - System Failure; +- 8337 - SM Delivery Failure; + - 8338 - The reason of the SM Delivery Failure can be one of the following in the mobile originated SM: + - 8339 - unknown Service Centre address; + - 8340 - Service Centre congestion; + - 8341 - invalid Short Message Entity address; + - 8342 - subscriber not Service Centre subscriber; + - 8343 - protocol error. +- 8344 - Unexpected Data Value + +8345 Provider error + +8346 For definition of provider errors see clause 7.6.1. + +## 8347 12.3 MAP-REPORT-SM-DELIVERY-STATUS service + +### 8348 12.3.1 Definition + +8349 This service is used between the gateway MSC and the HLR or the external Short Message Gateway (IP-SM-GW) and +8350 the HLR. The MAP-REPORT-SM-DELIVERY-STATUS service is used to set the Message Waiting Data into the HLR +8351 or to inform the HLR of successful SM transfer after polling. This service is invoked by the gateway MSC or the +8352 external Short Message Gateway (IP-SM-GW). + +8353 The MAP-REPORT-SM-DELIVERY-STATUS service is a confirmed service using the service primitives given in +8354 table 12.3/1. + +### 8355 12.3.2 Service primitives + +8356 + +**Table 12.3/1: MAP-REPORT-SM-DELIVERY-STATUS** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MSISDN | M | M(=) | | | +| IMSI | C | C(=) | | | +| Service Centre Address | M | M(=) | | | +| SM Delivery Outcome | M | M(=) | | | +| Absent Subscriber Diagnostic SM | C | C(=) | | | +| GPRS Support Indicator | C | C(=) | | | +| Delivery Outcome Indicator | C | C(=) | | | +| Additional SM Delivery Outcome | C | C(=) | | | +| Additional Absent Subscriber Diagnostic SM | C | C(=) | | | +| IP-SM-GW-Indicator | C | C(=) | | | +| IP-SM-GW SM Delivery Outcome | C | C(=) | | | +| IP-SM-GW Absent Subscriber Diagnostic SM | C | C(=) | | | +| Single Attempt Delivery | C | C(=) | | | +| Correlation ID | C | C(=) | | | +| SMSF 3GPP Delivery Outcome Indicator | C | C(=) | | | +| SMSF 3GPP SM Delivery Outcome | C | C(=) | | | +| SMSF 3GPP Absent Subscriber Diagnostic SM | C | C(=) | | | +| SMSF non-3GPP Delivery Outcome Indicator | C | C(=) | | | +| SMSF non-3GPP SM Delivery Outcome | C | C(=) | | | +| SMSF non-3GPP Absent Subscriber Diagnostic SM | C | C(=) | | | +| MSISdn-Alert | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8357 + +### 8358 12.3.3 Parameter use + +8359 Invoke id + +8360 See definition in clause 7.6.1. + +8361 MSISDN + +8362 See definition in clause 7.6.2. + +8363 When REPORT-SM-DELIVERY-STATUS is sent by the SMS-GMSC to the HLR following an T4 Submit Trigger +8364 (see 3GPP TS 23.682 [148]), MSISDN may not be available. In this case the UE shall be identified by the IMSI and the +8365 MSISDN shall take the dummy MSISDN value (see clause 3 of 3GPP TS 23.003 [17]). + +8366 When REPORT-SM-DELIVERY-STATUS is sent by the SMS-GMSC to the HLR in a retry context of SMS for IMS +8367 UE to IMS UE without MSISDN (see 3GPP TS 23.204 [134]), MSISDN may not be available. In this case the UE shall +8368 be identified by a Correlation ID (SIP-URI-B) and the MSISDN shall take the dummy MSISDN value (see clause 3 of +8369 3GPP TS 23.003 [17]). + +8370 IMSI + +8371 See definition in clause 7.6.2. When REPORT-SM-DELIVERY-STATUS is sent by the SMS-GMSC to the HLR in a +8372 retry context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [134]), IMSI may not be +8373 available. In this case the IMSI parameter shall be populated with an HLR-ID). + +8374 Service Centre Address + +8375 See definition in clause 7.6.2. + +8376 SM Delivery Outcome + +8377 See definition in clause 7.6.8. This parameter indicates the status of the mobile terminated SM delivery. + +8378 Absent Subscriber Diagnostic SM + +8379 See definition in clause 7.6.8. + +8380 GPRS Support Indicator + +8381 See definition in clause 7.6.8. The presence of this parameter is mandatory if the SMS-GMSC supports handling of two +8382 delivery outcomes. + +8383 Delivery Outcome Indicator + +8384 See definition in clause 7.6.8. + +8385 Additional SM Delivery Outcome + +8386 See definition in clause 7.6.8. + +8387 Additional Absent Subscriber Diagnostic SM + +8388 See definition in clause 7.6.8. + +8389 IP-SM-GW Indicator + +8390 See definition in clause 7.6.8. + +8391 IP-SM-GW SM Delivery Outcome + +8392 See definition in clause 7.6.8. + +8393 IP-SM-GW Absent Subscriber Diagnostic SM + +8394 See definition in clause 7.6.8. + +8395 Single Attempt Delivery + +8396 This parameter indicates the short message is only valid for delivering once, and the HLR/HSS does not need to add the +8397 received SC address into MWD list. It may only be present in the case the delivery of the short message failed due to +8398 absent subscriber or MS memory capacity exceeded. + +8399 **Editor's Note: Description of the use of this parameter might be needed in 3GPP TS 23.040.** + +8400 Correlation ID + +8401 The Correlation ID parameter contains the SIP-URI-B identifying the (MSISDN-less) destination user. SIP-URI-A and +8402 HLR-ID shall be absent from this parameter. + +8403 SMSF 3GPP Delivery Outcome Indicator + +8404 See definition in clause 7.6.8. + +8405 SMSF 3GPP SM Delivery Outcome + +8406 See definition in clause 7.6.8. + +8407 SMSF 3GPP Absent Subscriber Diagnostic SM + +8408 See definition in clause 7.6.8. + +8409 SMSF Non-3GPP Delivery Outcome Indicator + +8410 See definition in clause 7.6.8. + +8411 SMSF Non-3GPP SM Delivery Outcome + +8412 See definition in clause 7.6.8. + +8413 SMSF Non-3GPP Absent Subscriber Diagnostic SM + +8414 See definition in clause 7.6.8. + +8415 MSIsdn-Alert + +8416 See definition in clause 7.6.2. This parameter shall be present in case of unsuccessful delivery, when the MSISDN +8417 received in the operation is different from the stored MSIsdn-Alert; the stored MSIsdn-Alert is the value that is returned +8418 to the gateway MSC. + +8419 User error + +8420 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8421 - Unknown Subscriber; +- 8422 - Message Waiting List Full; +- 8423 - Unexpected Data Value; +- 8424 - Data missing. + +8425 Provider error + +8426 For definition of provider errors see clause 7.6.1. + +## 8427 12.4 MAP-READY-FOR-SM service + +### 8428 12.4.1 Definition + +8429 This service is used between the MSC and VLR as well as between the VLR and the HLR. The MSC initiates this +8430 service if a subscriber indicates memory available situation. The VLR uses the service to indicate this to the HLR. + +8431 The VLR initiates this service if a subscriber, whose message waiting flag is active in the VLR, has radio contact in the +8432 MSC. + +8433 Also this service is used between the SGSN and the HLR. The SGSN initiates this service if a subscriber indicates +8434 memory available situation. The SGSN uses the service to indicate this to the HLR. + +8435 Also this service is used between the HSS and the MME via an IWF. The MME initiates this service if a subscriber +8436 indicates memory available situation. The MME uses the service to indicate this to the HLR. + +8437 The SGSN initiates this service if a subscriber, whose message waiting flag is active in the SGSN, has radio contact in +8438 the GPRS. + +8439 The MME initiates this service if a subscriber, whose message waiting flag is active in the MME, has radio contact via +8440 LTE. + +8441 Also this service is used between the external Short Message Gateway (IP-SM-GW) and the HLR. The IP-SM-GW +8442 initiates this service if a subscriber indicates memory available situation. The IP-SM-GW uses the service to indicate +8443 this to the HLR. + +8444 The IP-SM-GW initiates this service if a subscriber, whose message waiting flag is active in the IP-SM-GW, is +8445 reachable in IMS. + +8446 The MAP-READY-FOR-SM service is a confirmed service using the primitives from table 12.4/1. + +### 8447 12.4.2 Service primitives + +8448 + +**Table 12.4/1: MAP-READY-FOR-SM** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| IMSI | C | C(=) | | | + +| | | | | | +|--------------------------------------|---|------|---|------| +| TMSI | C | C(=) | | | +| Alert Reason | M | M(=) | | | +| Alert Reason Indicator | C | C(=) | | | +| Additional Alert
Reason Indicator | C | C(=) | | | +| Maximum UE
Availability Time | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8449 + +### 8450 12.4.3 Parameter use + +8451 Invoke id + +8452 See definition in clause 7.6.1. + +8453 IMSI + +8454 See definition in clause 7.6.2. The IMSI is used always between the VLR and the HLR and between the SGSN and the +8455 HLR and between the HSS and the IWF. Between the MSC and the VLR the identification can be either IMSI or TMSI. + +8456 TMSI + +8457 See definition in clause 7.6.2. The identification can be either IMSI or TMSI between MSC and VLR. + +8458 Alert Reason + +8459 See definition in clause 7.6.8. This parameter indicates if the mobile subscriber is present or the MS has memory +8460 available. + +8461 Alert Reason Indicator + +8462 See definition in clause 7.6.8. This parameter by its presence indicates the message is sent from SGSN, and by its +8463 absence indicates the message is sent from VLR or MME via IWF. + +8464 Additional Alert Reason Indicator + +8465 See definition in clause 7.6.8. + +8466 Maximum UE Availability Time + +8467 See definition in clause 7.6.8. This information element may be included by the SGSN or MSC when notifying the HLR +8468 that the MS is reachable. + +8469 User error + +8470 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8471 - Unknown Subscriber; +- 8472 - Facility Not Supported; +- 8473 - System Failure; +- 8474 - Unexpected Data Value; +- 8475 - Data missing. + +8476 Provider error + +8477 For definition of provider errors see clause 7.6.1. + +### 8478 12.5 MAP-ALERT-SERVICE-CENTRE service + +## 8479 12.5.1 Definition + +8480 This service is used between the HLR and the interworking MSC. The HLR initiates this service, if the HLR detects +8481 that a subscriber, whose MSISDN is in the Message Waiting Data file, is active or the MS has memory available. + +8482 This service is also used between an MME (via an IWF), SGSN or an MSC using Deployment Option 2 (see clause +8483 8.2.4a.1 of 3GPP TS 23.272 [143] and 3GPP TS 23.040 [6]) and the SMS-GMSC (possibly via an SMS Router), to +8484 indicate that a MS, for which one or more MT SMS have been requested to be retransmitted at a later time, is now +8485 available for MT SMS delivery or has moved under the coverage of another MME, SGSN or MSC. This procedure is +8486 used according to the call flows described in clause 10.1 of 3GPP TS 23.040 [26]. + +8487 The MAP-ALERT-SERVICE-CENTRE service is a confirmed service using the primitives from table 12.5/1. + +## 8488 12.5.2 Service primitives + +8489 **Table 12.5/1: MAP-ALERT-SERVICE-CENTRE** + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MSIsdn-Alert | M | M(=) | | | +| IMSI | C | C(=) | | | +| Correlation ID | C | C(=) | | | +| Service Centre Address | M | M(=) | | | +| Maximum UE Availability | C | C(=) | | | +| Time | | | | | +| SMS-GMSC Alert Event | C | C(=) | | | +| SMS-GMSC Diameter Address | C | C(=) | | | +| New SGSN Number | C | C(=) | | | +| New SGSN Diameter Address | C | C(=) | | | +| New MME Number | C | C(=) | | | +| New MME Diameter Address | C | C(=) | | | +| New MSC Number | C | C(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8490 + +## 8491 12.5.3 Parameter use + +### 8492 Invoke id + +8493 See definition in clause 7.6.1. + +### 8494 MSIsdn-Alert + +8495 See definition in clause 7.6.2. + +8496 When the service is used between the HLR and the SMS-IWMSC, the provided MSISDN shall be the one which is +8497 stored in the Message Waiting Data file. If no MSISDN is available, the dummy MSISDN value (see clause 3 of 3GPP +8498 TS 23.003 [17]) shall be sent and an IMSI or Correlation ID (SIP-URI-B) shall be present. + +8499 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, the dummy MSISDN +8500 value (see clause 3 of 3GPP TS 23.003 [17]) shall be sent and an IMSI shall be present. + +### 8501 IMSI + +8502 When the service is used between the HLR and the SMS-IWMSC, the provided IMSI shall be the identifier which is +8503 stored in the Message Waiting Data file if no MSISDN is available in the context of T4 device triggering (see 3GPP TS +8504 23.682 [148]). + +8505 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element +8506 shall contain the IMSI in the request sent from the MME (via an IWF), SGSN or MSC, or the User Identifier Alert + +8507 previously sent in the MT Forward Short Message response, when the request is sent from the SMS Router to the SMS- +8508 GMSC. + +8509 Correlation ID + +8510 When the service is used between the HLR and the SMS-IWMSC, the provided SIP-URI-B within the Correlation ID +8511 parameter shall be the identifier which is stored in the Message Waiting Data file if no MSISDN is available in a retry +8512 context of SMS for IMS UE to IMS UE without MSISDN (see 3GPP TS 23.204 [134]). HLR-ID and SIP-URI-A shall +8513 be absent. + +8514 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element +8515 shall not be included. + +8516 Service Centre Address + +8517 See definition in clause 7.6.2. + +8518 When the service is used between the HLR and the SMS-IWMSC, this information element shall contain the E.164 +8519 number of the Service Center. + +8520 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element +8521 shall contain the E.164 number of the SMS-GMSC (or SMS Router) previously received in the SMS-GMSC Address IE +8522 in the MT Forward Short Message Request. + +8523 Maximum UE Availability Time + +8524 See definition in clause 7.6.8. + +8525 When the service is used between the HLR and the SMS-IWMSC, this information element shall be included, if +8526 available. + +8527 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element +8528 shall not be included. + +8529 SMS-GMSC Alert Event + +8530 See definition in clause 7.6.8. + +8531 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8532 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element +8533 shall either indicate that the MS is now available for MT SMS or that the MS has moved under the coverage of another +8534 MME, SGSN or MSC. + +8535 New SGSN Number + +8536 See definition in clause 7.6.8. + +8537 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8538 When the service is used between an MME (via an IWF) or SGSN and the SMS-GMSC, this information element may +8539 be included if the SMS-GMSC Alert Event indicates that the MS has moved under the coverage of another SGSN. +8540 When present, it shall contain the E.164 number of the new SGSN serving the MS. + +8541 New MME Number + +8542 See definition in clause 7.6.8. + +8543 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8544 When the service is used between an MME (via an IWF) or SGSN and the SMS-GMSC, this information element may +8545 be included if the SMS-GMSC Alert Event indicates that the MS has moved under the coverage of another MME. +8546 When present, it shall contain the E.164 number of the new MME serving the MS. + +8547 New SGSN Diameter Address + +8548 See definition in clause 7.6.8. + +8549 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8550 When the service is used between an MME (via an IWF) or SGSN and the SMS-GMSC, this information element shall + 8551 be included if available and if the SMS-GMSC Alert Event indicates that the MS has moved under the coverage of + 8552 another SGSN. When present, it shall contain the Diameter Identity of the new SGSN serving the MS. + +8553 New MME Diameter Address + +8554 See definition in clause 7.6.8. + +8555 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8556 When the service is used between an MME (via an IWF) or SGSN and the SMS-GMSC, this information element shall + 8557 be included if available and if the SMS-GMSC Alert Event indicates that the MS has moved under the coverage of + 8558 another MME. When present, it shall contain the Diameter Identity of the new MME serving the MS. + +8559 SMS-GMSC Diameter Address + +8560 See definition in clause 7.6.2. + +8561 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8562 When the service is used between an MME (via an IWF), SGSN or MSC and the SMS-GMSC, this information element + 8563 shall contain, if available, the Diameter Identity of the SMS-GMSC (or SMS Router) previously received in the SMS- + 8564 GMSC Diameter Address IE in the MT Forward Short Message Request. + +8565 New MSC Number + +8566 See definition in clause 7.6.8.33. + +8567 When the service is used between the HLR and the SMS-IWMSC, this information element shall not be included. + +8568 When the service is used between an MSC and the SMS-GMSC, this information element may be included if the SMS- + 8569 GMSC Alert Event indicates that the MS has moved under the coverage of another MSC. When present, it shall contain + 8570 the E.164 number of the new MSC serving the MS. + +8571 + +8572 User error + +8573 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +8574 - System Failure; + +8575 - Unexpected Data Value; + +8576 - Data missing. + +8577 Provider error + +8578 For definition of provider errors see clause 7.6.1. + +## 8579 12.6 MAP-INFORM-SERVICE-CENTRE service + +### 8580 12.6.1 Definition + +8581 This service is used between the HLR and the gateway MSC (transiting an SMS Router, if present) to inform the + 8582 Service Centre which MSISDN number is stored in the Message Waiting Data file. If the stored MSISDN number is not + 8583 the same as the one received from the gateway MSC in the MAP-SEND-ROUTING-INFO-FOR-SM service primitive + 8584 the stored MSISDN number is included in the message. + +8585 Additionally the status of MCEF, MNRF, MNRG, MNR5G and MNR5GN3G flags and the inclusion of the particular + 8586 Service Centre address in the Message Waiting Data list is informed to the gateway MSC when appropriate. + +8587 If the HLR has stored a single MNRR, the value is included in the Absent Subscriber Diagnostic SM parameter. + +8588 If the HLR has stored a second MNRR, the value of the MNRR for the MSC is included in the Absent Subscriber + 8589 Diagnostic SM parameter and the value of the MNRR for the SGSN is included in the Additional Absent Subscriber + 8590 Diagnostic SM parameter. + +8591 The MAP-INFORM-SERVICE-CENTRE service is a non-confirmed service using the primitives from table 12.6/1. + +## 8592 12.6.2 Service primitives + +8593 + +**Table 12.6/1: MAP-INFORM-SERVICE-CENTRE** + +| Parameter name | Request | Indication | +|-----------------------------------------------------|---------|------------| +| Invoke Id | M | M(=) | +| MSIsdn-Alert | C | C(=) | +| MWD Status | C | C(=) | +| Absent Subscriber
Diagnostic SM | C | C(=) | +| Additional Absent
Subscriber Diagnostic
SM | C | C(=) | +| SMSF 3GPP Absent
Subscriber Diagnostic
SM | C | C(=) | +| SMSF Non 3GPP
Absent Subscriber
Diagnostic SM | C | C(=) | + +8594 + +## 8595 12.6.3 Parameter use + +8596 Invoke id + +8597 See definition in clause 7.6.1. + +8598 MSIsdn-Alert + +8599 See definition in clause 7.6.2. This parameter refers to the MSISDN stored in a Message Waiting Data file in the HLR. + +8600 MWD Status + +8601 See definition in clause 7.6.8. This parameter indicates the status of the MCEF, MNRF, MNRG, MNR5G and + 8602 MNR5GN3G flags and the status of the particular SC address presence in the Message Waiting Data list. + +8603 Absent Subscriber Diagnostic SM + +8604 See definition in clause 7.6.8. + +8605 Additional Absent Subscriber Diagnostic SM + +8606 See definition in clause 7.6.8. + +8607 SMSF 3GPP Absent Subscriber Diagnostic SM + +8608 See definition in clause 7.6.8. + +8609 SMSF Non 3GPP Absent Subscriber Diagnostic SM + +8610 See definition in clause 7.6.8. + +## 8611 12.7 MAP-SEND-INFO-FOR-MT-SMS service + +### 8612 12.7.1 Definition + +8613 This service is used between the MSC and the VLR. The service is invoked by the MSC receiving a mobile terminated + 8614 short message to request subscriber related information from the VLR. + +8615 The MAP-SEND-INFO-FOR-MT-SMS service is a confirmed service using the primitives from table 12.7/1. + +## 8616 12.7.2 Service primitives + +8617 + +**Table 12.7/1: MAP-SEND-INFO-FOR-MT-SMS** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| SM RP DA | M | M(=) | | | +| IMSI | C | C(=) | | | +| MSISDN | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8618 + +## 8619 12.7.3 Parameter use + +8620 Invoke id + +8621 See definition in clause 7.6.1. + +8622 SM RP DA + +8623 See definition in clause 7.6.8. This parameter shall contain either an IMSI or an LMSI. + +8624 IMSI + +8625 See definition in clause 7.6.2. This parameter shall be present if the SM RP DA parameter contains an LMSI; otherwise + 8626 it shall be absent. + +8627 MSISDN + +8628 See definition in clause 7.6.2. + +8629 User error + +8630 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8631 - Unknown subscriber; +- 8632 - Unidentified Subscriber; +- 8633 - Absent subscriber; +- 8634 - Unexpected Data Value; +- 8635 - Data Missing; +- 8636 - Illegal subscriber; +- 8637 - Illegal equipment; +- 8638 - Subscriber busy for MT SMS; +- 8639 - System Failure. + +8640 Provider error + +8641 For definition of provider errors see clause 7.6.1. + +## 8642 12.8 MAP-SEND-INFO-FOR-MO-SMS service + +## 8643 12.8.1 Definition + +8644 This service is used between the MSC and the VLR. The service is invoked by the MSC which has to handle a mobile +8645 originated short message request to request the subscriber related information from the VLR. + +8646 The MAP-SEND-INFO-FOR-MO-SMS service is a confirmed service using the primitives from table 12.8/1. + +## 8647 12.8.2 Service primitives + +8648 **Table 12.8/1: MAP-SEND-INFO-FOR-MO-SMS** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| Service Centre Address | M | M(=) | | | +| MSISDN | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8649 + +## 8650 12.8.3 Parameter use + +### 8651 Invoke id + +8652 See definition in clause 7.6.1. + +### 8653 Service Centre Address + +8654 See definition in clause 7.6.2. + +### 8655 MSISDN + +8656 See definition in clause 7.6.2. + +### 8657 User error + +8658 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +8659 - Teleservice Not Provisioned; + +8660 - Call Barred; + +8661 - Unexpected Data Value; + +8662 - Data Missing. + +### 8663 Provider error + +8664 For definition of provider errors see clause 7.6.1. + +## 8665 12.9 MAP-MT-FORWARD-SHORT-MESSAGE service + +### 8666 12.9.1 Definition + +8667 This service is used between the gateway MSC and the serving MSC or the SGSN (transiting an SMS Router, if +8668 present) or the IP-SM-GW to forward mobile terminated short messages. + +8669 The MAP-MT-FORWARD-SHORT-MESSAGE service is a confirmed service using the service primitives given in +8670 table 12.9/1. + +### 8671 12.9.2 Service primitives + +8672 + +**Table 12.9/1: MAP-MT-FORWARD-SHORT-MESSAGE** + +| Parameter name | Request | Indication | Response | Confirm | +|-------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| SM RP DA | M | M(=) | | | +| SM RP OA | M | M(=) | | | +| SM RP UI | M | M(=) | C | C(=) | +| More Messages To Send | C | C(=) | | | +| SM Delivery Timer | C | C(=) | | | +| SM Delivery Start Time | C | C(=) | | | +| SMS Over IP Only Indicator | C | C(=) | | | +| Correlation ID | C | C(=) | | | +| Maximum Retransmission Time | C | C(=) | | | +| SMS-GMSC Address | C | C(=) | | | +| SMS-GMSC Diameter Address | C | C(=) | | | +| Requested Retransmission Time | | | C | C(=) | +| User Identifier Alert | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8673 + +### 8674 12.9.3 Parameter use + +#### 8675 Invoke id + +8676 See definition in clause 7.6.1. + +#### 8677 SM RP DA + +8678 See definition in clause 7.6.8. This parameter can contain either an IMSI or a LMSI. The use of the LMSI is an operator +8679 option. The LMSI can be provided if it is received from the HLR. The IMSI is used if the use of the LMSI is not +8680 available. + +8681 This parameter is omitted (i.e. is present and takes the value "noSM-RP-DA") in the mobile terminated subsequent SM +8682 transfers. + +8683 When a Correlation ID is present, the IMSI parameter within SM RP DA shall be populated with the HLR-ID and the +8684 destination user is identified by the SIP-URI-B within the Correlation ID. + +#### 8685 SM RP OA + +8686 See definition in clause 7.6.8. The Service Centre address received from the originating Service Centre is inserted in +8687 this parameter. + +8688 This parameter is omitted in the mobile terminated subsequent SM transfers. + +#### 8689 SM RP UI + +8690 See definition in clause 7.6.8. The short message transfer protocol data unit received from the Service Centre is inserted +8691 in this parameter. A short message transfer protocol data unit may also be inserted in this parameter in the message +8692 delivery acknowledgement from the MSC or from the SGSN to the Service Centre. + +#### 8693 More Messages To Send + +8694 See definition in clause 7.6.8. The information from the MMS indication received from the Service Centre is inserted in +8695 this parameter. + +#### 8696 SM Delivery Timer + +8697 See definition in clause 7.6.8. + +#### 8698 SM Delivery Start Time + +8699 See definition in clause 7.6.8. + +8700 SMS Over IP Only Indicator + +8701 This indicator indicates by its presence that the IP-SM-GW shall try to deliver the short message via IMS without +8702 retrying to other domains. It shall be present in messages sent to the IP-SM-GW following a T4-Submit Trigger +8703 message (see 3GPP TS 23.682 [148]) but not in messages sent to MSC or SGSN (possibly transiting an SMS-Router). + +8704 The indicator also indicates to the IP-SM-GW by its presence that the IMSI within the message is a real IMSI and not a +8705 MT-Correlation ID allocated by the IP-SM-GW. + +8706 Correlation ID + +8707 The Correlation ID parameter contains the SIP-URI-B identifying the (MSISDN-less) destination user and the SIP-URI- +8708 A identifying the (MSISDN-less) originating user. HLR-ID shall be absent from this parameter. + +8709 Maximum Retransmission Time + +8710 See definition in clause 7.6.8. + +8711 SMS-GMSC Address + +8712 See definition in clause 7.6.8. + +8713 This information element shall be present if the Maximum Retransmission Time IE is present in the message. When +8714 present, it shall contain the E.164 number of the SMS-GMSC in the request sent by the SMS-GMSC or the E.164 +8715 number of the SMS Router in the request sent by the SMS Router. + +8716 SMS-GMSC Diameter Address + +8717 See definition in clause 7.6.8. + +8718 This information element shall be present if available and if the Maximum Retransmission Time IE is present in the +8719 message. When present, it shall contain the Diameter Identity of the SMS-GMSC in the request sent by the SMS- +8720 GMSC or the Diameter Identity of the SMS Router in the request sent by the SMS Router. + +8721 Requested Retransmission Time + +8722 See definition in clause 7.6.8. This information element may only be present if the MT Forward Short Message +8723 Response contains the User error set to Absent Subscriber\_SM and if the Maximum Retransmission Time information +8724 element is present in the MT Forward Short Message Request. It may be included by an MSC using Deployment Option +8725 2 (see clause 8.2.4a.1 of 3GPP TS 23.272 [143] and 3GPP TS 23.040 [6]) or the SGSN if the UE is using a power +8726 saving mechanism (such as extended idle mode DRX) and the UE is currently not reachable. + +8727 The Requested Retransmission Time shall not exceed the Maximum Retransmission Time received from the SMS- +8728 GMSC. + +8729 User-Identifier-Alert + +8730 See definition in clause 7.6.8. + +8731 This information element shall be present in the message from the SMS Router to the SMS-GMSC, if the Requested +8732 Retransmission Time IE is present in the message. When present, this information shall contain an MT Correlation ID. + +8733 User error + +8734 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8735 - Unidentified subscriber; +- Absent Subscriber\_SM; +- 8736 - Subscriber busy for MT SMS; +- 8737 - Facility Not Supported; + +- 8738 - Illegal Subscriber indicates that delivery of the mobile terminated short message failed because the mobile +- 8739 station failed authentication; +- 8740 - Illegal equipment indicates that delivery of the mobile terminated short message failed because an IMEI check +- 8741 failed, i.e. the IMEI was prohibited-listed or not permitted-listed; +- 8742 - System Failure; +- 8743 - SM Delivery Failure: + - 8744 - The reason of the SM Delivery Failure can be one of the following in the mobile terminated SM: + - 8745 - memory capacity exceeded in the mobile equipment; + - 8746 - protocol error; + - 8747 - mobile equipment does not support the mobile terminated short message service. +- 8748 - Unexpected Data Value; +- 8749 - Data Missing. + +8750 Provider error + +8751 For definition of provider errors see clause 7.6.1. + +## 8752 12.10 MAP-MT-FORWARD-SM-FOR-VGCS service + +### 8753 12.10.1 Definition + +8754 This service is used between the SMS gateway MSC and the Group Call Anchor MSC to forward mobile terminated + +8755 short messages into an ongoing voice group call. + +8756 The MAP-MT-FORWARD-SM-FOR-VGCS service is a confirmed service using the service primitives given in + +8757 table 12.10/1. + +### 8758 12.10.2 Service primitives + +8759 **Table 12.10/1: MAP-MT-FORWARD-SM-VGCS** + +| Parameter name | Request | Indication | Response | Confirm | +|------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| ASCI Call Reference | M | M(=) | | | +| SM RP OA | M | M(=) | | | +| SM RP UI | M | M(=) | C | C(=) | +| Dispatcher List | | | C | C(=) | +| Ongoing Call Indicator | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8760 + +### 8761 12.10.3 Parameter use + +8762 Invoke id + +8763 See definition in clause 7.6.1. + +8764 ASCI Call Reference + +8765 Group call reference. This item is used to access the VGCS-GCR within the Anchor\_MSC. + +8766 SM RP OA + +8767 See definition in clause 7.6.8. The Service Centre address received from the originating Service Centre is inserted in +8768 this parameter. + +8769 SM RP UI + +8770 See definition in clause 7.6.8. The short message transfer protocol data unit received from the Service Centre is inserted +8771 in this parameter. A short message transfer protocol data unit may also be inserted in this parameter in the message +8772 delivery acknowledgement from the MSC to the Service Centre. + +8773 Dispatcher List + +8774 A list of identities (international E.164 phone numbers) identifying the dispatchers of the VGCS call. It shall be present +8775 if received from the GCR; otherwise shall be absent. + +8776 Ongoing Call Indicator + +8777 Indicates by its presence that the VGCS call is ongoing. + +8778 User error + +8779 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8780 - System Failure; +- 8781 - Unexpected Data Value. + +8782 Provider error + +8783 For definition of provider errors see clause 7.6.1. + +--- + +## 8784 13 Network-Requested PDP Context Activation services + +### 8785 13.1 MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS service + +#### 8786 13.1.1 Definition + +8787 This service is used by the GGSN to request GPRS routing information from the HLR. + +#### 8788 13.1.2 Service primitives + +8789 **Table 13.1/1: MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS** + +| Parameter name | Request | Indication | Response | Confirm | +|-----------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| GGSN address | C | C(=) | C | C(=) | +| GGSN number | M | M(=) | | | +| SGSN address | | | C | C(=) | +| Mobile Not Reachable Reason | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8790 + +#### 8791 13.1.3 Parameter definition and use + +8792 Invoke Id + +8793 See definition in clause 7.6.1. + +8794 IMSI + +8795 See definition in clause 7.6.2. + +8796 GGSN address + +8797 This parameter shall be present if the protocol-converting GSN is used between the GGSN and the HLR. + +8798 GGSN number + +8799 See definition in clause 7.6.2. + +8800 SGSN address + +8801 This parameter shall be present if the outcome of the Send Routing Info For GPRS request to the GPRS application +8802 process in the HLR is positive. + +8803 Mobile Not Reachable Reason + +8804 This parameter shall be present if the outcome of the Send Routing Info For GPRS request to the GPRS application +8805 process in the HLR is positive and the MNRG flag in the HLR is set. See definition in clause 7.6.3.51. + +8806 User error + +8807 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +8808 - Absent Subscriber; + +8809 - System Failure; + +8810 - Data Missing; + +8811 - Unexpected Data Value; + +8812 - Unknown Subscriber. + +8813 The diagnostic in the Unknown Subscriber may indicate "Imsi Unknown" or "Gprs Subscription Unknown". + +8814 - Call Barred; + +8815 This error will indicate that the received PDP PDUs in the GGSN shall be barred for this MS due to Operator +8816 Determined Barring. (The CallBarringCause must be the operatorBarring.) + +8817 Provider error + +8818 These are defined in clause 7.6.1. + +## 8819 13.2 MAP\_FAILURE\_REPORT service + +### 8820 13.2.1 Definition + +8821 This service is used by the GGSN to inform the HLR that network requested PDP-context activation has failed. + +### 8822 13.2.2 Service primitives + +8823 + +**Table 13.2/1: MAP\_FAILURE\_REPORT** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| GGSN address | C | C(=) | C | C(=) | +| GGSN number | M | M(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8824 + +### 13.2.3 Parameter definition and use + +#### Invoke Id + +See definition in clause 7.6.1. + +#### IMSI + +See definition in clause 7.6.2. + +#### GGSN address + +This parameter shall be present if the protocol-converting GSN is used between the GGSN and the HLR. + +#### GGSN number + +See definition in clause 7.6.2. + +#### User error + +This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +- System Failure; +- Data Missing; +- Unexpected Data Value; +- Unknown Subscriber. + +#### Provider error + +These are defined in clause 7.6.1. + +### 13.3 MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS service + +#### 13.3.1 Definition + +This service is used by the HLR to inform the GGSN that the MS is present for GPRS again. + +#### 13.3.2 Service primitives + +8846 + +**Table 13.3/1: MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| IMSI | M | M(=) | | | +| GGSN address | C | C(=) | | | +| SGSN address | M | M(=) | | | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8847 + +### 13.3.3 Parameter definition and use + +#### Invoke Id + +See definition in clause 7.6.1. + +#### IMSI + +See definition in clause 7.6.2. + +8853 GGSN address + +8854 This parameter shall be present if the protocol-converting GSN is used between the GGSN and the HLR. + +8855 SGSN address + +8856 See definition in clause 7.6.2. + +8857 User error + +8858 This parameter is sent by the responder when an error is detected and if present, takes one of the following values: + +8859 - System Failure; + +8860 - Data Missing; + +8861 - Unexpected Data Value; + +8862 - Unknown Subscriber. + +8863 Provider error + +8864 These are defined in clause 7.6.1. + +--- + +## 8865 13A Location Service Management Services + +### 8866 13A.1 MAP-SEND-ROUTING-INFO-FOR-LCS Service + +#### 8867 13A.1.1 Definition + +8868 This service is used between the GMLC and the HLR to retrieve the routing information needed for routing a location +8869 service request to the servicing VMSC, SGSN, MME or 3GPP AAA server. The MAP-SEND-ROUTING-INFO-FOR- +8870 LCS is a confirmed service using the primitives from table 13A.1/1. + +#### 8871 13A.1.2 Service Primitives + +8872 + +**Table 13A.1/1: MAP-SEND-ROUTING-INFO-FOR-LCS** + +| Parameter name | Request | Indication | Response | Confirm | +|--------------------------------|---------|------------|----------|---------| +| Invoke Id | M | M(=) | M(=) | M(=) | +| MLC Number | M | M(=) | | | +| MSISDN | C | C(=) | C | C(=) | +| IMSI | C | C(=) | C | C(=) | +| LMSI | | | C | C(=) | +| Network Node Number | | | C | C(=) | +| GPRS Node Indicator | | | C | C(=) | +| Additional Number | | | C | C(=) | +| Supported LCS Capability Sets | | | C | C(=) | +| Additional LCS Capability Sets | | | C | C(=) | +| MME Name | | | C | C(=) | +| SGSN Name | | | C | C(=) | +| SGSN Realm | | | C | C(=) | +| AAA Server Name | | | C | C(=) | +| V-GMLC Address | | | U | C(=) | +| Additional V-GMLC Address | | | U | C(=) | +| H-GMLC Address | | | C | C(=) | +| PPR Address | | | U | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8873 + +### 8874 13A.1.3 Parameter Use + +8875 Invoke id + +8876 See definition in clause 7.6.1. + +8877 MLC Number + +8878 See definition in clause 7.6.2. + +8879 MSISDN + +8880 See definition in clause 7.6.2. The request shall carry either the IMSI or MSISDN. The response shall carry whichever +8881 of these was not included in the request (see 3GPP TS 23.271 for details). + +8882 IMSI + +8883 See definition in clause 7.6.2. + +8884 LMSI + +8885 See definition in clause 7.6.2. It is an operator option to provide this parameter from the VLR; it is mandatory for the +8886 HLR to include the LMSI in a successful response, if the VLR has used the LMSI. + +8887 Network Node Number + +8888 See definition in clause 7.6.2. This parameter is provided in a successful response. If the Network Node Number and +8889 Additional Number are received in the GMLC, the Network Node Number is used in preference to the Additional +8890 Number. If the serving node has no ISDN number, the HLR shall populate the Network Node Number parameter with a +8891 dummy ISDN number of "0". + +8892 GPRS Node Indicator + +8893 See definition in clause 7.6.8. The presence of this parameter is mandatory only if the SGSN number is sent in the +8894 Network Node Number. + +8895 Additional Number + +8896 See definition in clause 7.6.2. This parameter is provided in a successful response. If the Network Node Number and +8897 Additional Number are received in the GMLC, the Network Node Number is used in preference to the Additional +8898 Number. + +8899 Supported LCS Capability Sets + +8900 See definition in clause 7.6.11. This parameter indicates the LCS capability of the serving node that is indicated by the +8901 Network Node Number. This parameter is provided only if LCS capability sets are available in HLR and Network Node +8902 Number is present in this message. + +8903 Additional LCS Capability Sets + +8904 See definition in clause 7.6.11. This parameter indicates the LCS capability of the serving node that is indicated by the +8905 Additional Number. This parameter is provided only if LCS capability sets are available in HLR and Additional +8906 Number is present in this message. + +8907 MME Name + +8908 See definition in clause 7.6.2. This parameter is provided in a successful response when the serving node is an MME. + +8909 SGSN Name + +8910 See definition in clause 7.6.2. This parameter is provided in a successful response when the serving node is an SGSN +8911 and the SGSN has indicated its support for Lgd interface. + +8912 SGSN Realm + +8913 See definition in clause 7.6.2. This parameter is provided in a successful response when the serving node is an SGSN +8914 and the SGSN has indicated its support for Lgd interface. + +8915 AAA Server Name + +8916 See definition in clause 7.6.2. This parameter is provided in a successful response when the serving node is a +8917 3GPP AAA server. + +8918 V-GMLC address + +8919 See definition in clause 7.6.2. . This parameter indicates the V-GMLC address of the serving node that is indicated by +8920 the Network Node Number. + +8921 Additional V-GMLC address + +8922 See definition in clause 7.6.2. This parameter indicates the V-GMLC address of the serving node that is indicated by the +8923 Additional Number. This parameter is provided only if additional LCS capability sets are available in HLR and +8924 Additional Number is present in this message. + +8925 H-GMLC address + +8926 See definition in clause 7.6.2. The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +8927 PPR address + +8928 See definition in clause 7.6.2. + +8929 User error + +8930 The following errors defined in clause 7.6.1 may be used, depending on the nature of the fault: + +- 8931 - Unknown subscriber; +- 8932 - Absent Subscriber; +- 8933 - Facility Not Supported; +- 8934 - System failure; +- 8935 - Unexpected Data Value; +- 8936 - Data missing; +- 8937 - Unauthorised requesting network. + +8938 Provider error + +8939 For definition of provider errors see clause 7.6.1. + +## 8940 13A.2 MAP-PROVIDE-SUBSCRIBER-LOCATION Service + +### 8941 13A.2.1 Definition + +8942 This service is used by a GMLC to request the location of a target MS from the visited MSC or SGSN at any time. This +8943 is a confirmed service using the primitives from table 13A.2/1. + +### 8944 13A.2.2 Service Primitives + +8945 **Table 13A.2/1: Provide\_Subscriber\_Location** + +| Parameter name | Request | Indication | Response | Confirm | +|----------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| Location Type | M | M(=) | | | +| MLC Number | M | M(=) | | | + +| | | | | | +|---------------------------------------|---|------|---|------| +| LCS Client ID | M | M(=) | | | +| Privacy Override | U | C(=) | | | +| IMSI | C | C(=) | | | +| MSISDN | C | C(=) | | | +| LMSI | C | C(=) | | | +| LCS Priority | C | C(=) | | | +| LCS QoS | C | C(=) | | | +| IMEI | U | C(=) | | | +| Supported GAD Shapes | C | C(=) | | | +| LCS-Reference Number | C | C(=) | | | +| LCS Codeword | C | C(=) | | | +| LCS Service Type Id | C | C(=) | | | +| LCS Privacy Check | C | C(=) | | | +| Area Event Info | C | C(=) | | | +| H-GMLC Address | C | C(=) | | | +| Reporting PLMN List | C | C(=) | | | +| PeriodicLDRInfo | C | C(=) | | | +| MO-LR Short Circuit Indicator | C | C(=) | C | C(=) | +| Location Estimate | | | M | M(=) | +| GERAN Positioning Data | | | C | C(=) | +| UTRAN Positioning Data | | | C | C(=) | +| GERAN GANSS Positioning Data | | | C | C(=) | +| UTRAN GANSS Positioning Data | | | C | C(=) | +| UTRAN Additional Positioning Data | | | C | C(=) | +| UTRAN Barometric Pressure Measurement | | | C | C(=) | +| UTRAN Civic Address | | | C | C(=) | +| Age of Location Estimate | | | C | C(=) | +| Additional Location Estimate | | | C | C(=) | +| Deferred MT-LR Response Indicator | | | C | C(=) | +| Cell Id Or SAI | | | C | C(=) | +| Accuracy Fulfilment Indicator | | | C | C(=) | +| Target Serving Node for Handover | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +8946 + +### 8947 13A.2.3 Parameter Definition and Use + +8948 All parameters are defined in clause 7.6. The use of these parameters and the requirements for their presence are +8949 specified in 3GPP TS 23.271 [26a]. + +#### 8950 Location Type + +8951 This parameter identifies the type of location information requested. + +#### 8952 MLC Number + +8953 This is the E.164 number of the requesting GMLC. + +#### 8954 LCS Client ID + +8955 This parameter provides information related to the identity of an LCS client. + +#### 8956 Privacy Override + +8957 This parameter indicates if MS privacy is overridden by the LCS client when the GMLC and VMSC or SGSN for an +8958 MT-LR are in the same country. + +8959 IMSI + +8960 The IMSI is provided to identify the target MS. At least one of the IMSI or MSISDN is mandatory. + +8961 MSISDN + +8962 The MSISDN is provided to identify the target MS. At least one of the IMSI or MSISDN is mandatory. + +8963 LMSI + +8964 The LMSI shall be provided if previously supplied by the HLR. This parameter is only used in the case of the MT-LR +8965 for CS domain. + +8966 LCS Priority + +8967 This parameter indicates the priority of the location request. + +8968 LCS QoS + +8969 This parameter indicates the required quality of service in terms of response time, accuracy and lcs qos class. + +8970 IMEI + +8971 The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +8972 Supported GAD Shapes + +8973 This parameter indicates which of the shapes defined in 3GPP TS 23.032 [122] are supported. + +8974 LCS-Reference Number + +8975 This parameter shall be included if a deferred MT-LR procedure is performed for a UE available event, an area event or +8976 a periodic positioning event. + +8977 LCS Codeword + +8978 See definition in clause 7.6.11.18. The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +8979 LCS Service Type Id + +8980 See definition in clause 7.6.11.15. The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +8981 LCS Privacy Check + +8982 See definition in clause 7.6.11. The requirements for its and its components presence are specified in 3GPP TS 23.271 +8983 [26a]. + +8984 Area Event Info + +8985 See definition in clause 7.6.11. The parameter shall be included if a deferred MT-LR procedure is performed for an area +8986 event. + +8987 H-GMLC address + +8988 See definition in clause 7.6.2. The parameter shall be included if a deferred MT-LR procedure is performed for a UE +8989 available event, an area event or a periodic positioning event. + +8990 Location Estimate + +8991 This parameter provides the location estimate if this is encoded in one of the supported geographical shapes. Otherwise +8992 this parameter shall consist of one octet, which shall be discarded by the receiving node. + +8993 GERAN Positioning Data + +8994 This parameter indicates the usage of each positioning method that was attempted to determine the location estimate +8995 either successfully or unsuccessfully. If Positioning Data received from the RAN contains no Positioning Methods, +8996 Positioning Data is excluded from the MAP message. It may be included in the message only if the access network is +8997 GERAN, see 3GPP TS 23.271 [26a]. + +8998 UTRAN Positioning Data + +8999 This parameter indicates the usage of each positioning method that was successfully attempted to determine the location +9000 estimate. If Position Data received from the RAN contains no Positioning Methods, UTRAN Positioning Data is +9001 excluded from the MAP message. It may be included in the message only if the access network is UTRAN, see 3GPP +9002 TS 23.271 [26a]. + +9003 GERAN GANSS Positioning Data + +9004 This parameter indicates the usage of each GANSS positioning method that was attempted to determine the location +9005 estimate either successfully or unsuccessfully. If GANSS Positioning Data received from the RAN contains no GANSS +9006 method, GERAN GANSS Positioning Data is excluded from the MAP message. It may be included in the message only +9007 if the access network is GERAN, see 3GPP TS 23.271 [26a]. + +9008 UTRAN GANSS Positioning Data + +9009 This parameter indicates the usage of each GANSS positioning method that was successfully attempted to determine the +9010 location estimate. If Position Data received from the RAN contains no GANSS Positioning Data Set, UTRAN GANSS +9011 Positioning Data is excluded from the MAP message. It may be included in the message only if the access network is +9012 UTRAN, see 3GPP TS 23.271 [26a]. + +9013 UTRAN Additional Positioning Data + +9014 This parameter indicates the usage of each Additional positioning method that was successfully attempted to determine +9015 the location estimate. If Position Data received from the RAN contains no Additional Positioning Data Set, UTRAN +9016 Additional Positioning Data is excluded from the MAP message. It may be included in the message only if the access +9017 network is UTRAN, see 3GPP TS 23.271 [26a]. + +9018 UTRAN Barometric Pressure Measurement + +9019 This parameter indicates the uncompensated barometric pressure measurement at the MS. The absence of this parameter +9020 implies that a barometric pressure measurement was not available or could not be successfully obtained. It may be +9021 included in the message only if the access network is UTRAN, see 3GPP TS 23.271 [26a]. + +9022 UTRAN Civic Address + +9023 This parameter indicates the civic address of the MS. The absence of this parameter implies that a civic address was not +9024 available or could not be successfully obtained. It may be included in the message only if the access network is +9025 UTRAN, see 3GPP TS 23.271 [26a]. + +9026 Age of Location Estimate + +9027 This parameter indicates how long ago the location estimate was obtained. + +9028 Additional Location Estimate + +9029 This parameter provides the location estimate when not provided by the Location Estimate parameter. It may be sent +9030 only if the parameter Supported GAD Shapes has been received in the Provide Subscriber Location indication and the +9031 shape to be included is supported by the GMLC. + +9032 Deferred MT-LR Response Indicator + +9033 See definition in clause 7.6.11.2. + +9034 Cell Id Or SAI + +9035 For GERAN access, this parameter indicates Global Cell Identifier of the cell that the served subscriber is currently +9036 attached to. For UTRAN access, this parameter contains the Service Area Identifier for the cell that the subscriber is +9037 currently attached to. This parameter is included only for North American Emergency Calls as described in 3GPP TS +9038 23.271 [26a]. + +9039 Accuracy Fulfilment Indicator + +9040 See definition in clause 7.6.11.28. + +9041 MO-LR Short Circuit Indicator + +9042 This parameter indicates whether MO-LR Short Circuit is permitted for periodic location. + +9043 Reporting PLMN List + +9044 This parameter indicates a list of PLMNs in which subsequent periodic MO-LR TTTP requests will be made. + +9045 Periodic LDR information + +9046 This parameter indicates the reporting amount and reporting interval of deferred periodic location. + +9047 Target Serving Node for Handover + +9048 This parameter provides the address of the target side serving node for handover of an IMS Emergency Call. + +9049 User error + +9050 This parameter is sent by the responder when the location request has failed or cannot proceed and if present, takes one +9051 of the following values defined in clause 7.6.1. + +- 9052 - System Failure; +- 9053 - Data Missing; +- 9054 - Unexpected Data Value; +- 9055 - Facility Not Supported; +- 9056 - Unidentified Subscriber; +- 9057 - Illegal Subscriber; +- 9058 - Illegal Equipment; +- 9059 - Absent Subscriber (diagnostic information may also be provided); +- 9060 - Unauthorised requesting network; +- 9061 - Unauthorised LCS Client with detailed reason; +- 9062 - Position method failure with detailed reason. + +9063 Provider error + +9064 These are defined in clause 7.6.1. + +## 9065 13A.3 MAP-SUBSCRIBER-LOCATION-REPORT Service + +### 9066 13A.3.1 Definition + +9067 This service is used by a VMSC or SGSN to provide the location of a target MS to a GMLC when a request for location is +9068 either implicitly administered or made at some earlier time. This is a confirmed service using the primitives from +9069 table 13A.3/1. + +9070 13A.3.2 Service Primitives + +9071 + +Table 13A.3/1: Subscriber\_Location\_Report + +| Parameter name | Request | Indication | Response | Confirm | +|---------------------------------------|---------|------------|----------|---------| +| Invoke id | M | M(=) | M(=) | M(=) | +| LCS Event | M | M(=) | | | +| LCS Client ID | M | M(=) | | | +| Network Node Number | M | M(=) | | | +| IMSI | C | C(=) | | | +| MSISDN | C | C(=) | | | +| NA-ESRD | C | C(=) | C | C(=) | +| NA-ESRK | C | C(=) | C | C(=) | +| IMEI | U | C(=) | | | +| Location Estimate | C | C(=) | | | +| GERAN Positioning Data | C | C(=) | | | +| UTRAN Positioning Data | C | C(=) | | | +| GERAN GANSS Positioning Data | C | C(=) | | | +| UTRAN GANSS Positioning Data | C | C(=) | | | +| UTRAN Additional Positioning Data | C | C(=) | | | +| UTRAN Barometric Pressure Measurement | C | C(=) | | | +| UTRAN Civic Address | C | C(=) | | | +| Age of Location Estimate | C | C(=) | | | +| LMSI | U | C(=) | | | +| GPRS Node Indicator | C | C(=) | | | +| Additional Location Estimate | C | C(=) | | | +| Deferred MT-LR Data | C | C(=) | | | +| LCS-Reference Number | C | C(=) | C | C(=) | +| NA-ESRK Request | C | C(=) | | | +| Cell Id Or SAI | C | C(=) | | | +| H-GMLC Address | C | C(=) | C | C(=) | +| LCS Service Type Id | C | C(=) | | | +| Pseudonym Indicator | C | C(=) | | | +| Accuracy Fulfilment Indicator | C | C(=) | | | +| Sequence Number | C | C(=) | | | +| Periodic LDR Info | C | C(=) | | | +| MO-LR Short Circuit Indicator | C | C(=) | C | C(=) | +| Target Serving Node for Handover | C | C(=) | | | +| Reporting PLMN List | | | C | C(=) | +| User error | | | C | C(=) | +| Provider error | | | | O | + +9072 + +9073 13A.3.3 Parameter Definition and Use + +9074 All parameters are defined in clause 7.6. The use of these parameters and the requirements for their presence are + 9075 specified in. 3GPP TS 23.271 [26a]. + +9076 LCS Event + +9077 This parameter indicates the event that triggered the Subscriber Location Report. + +9078 LCS Client ID + +9079 This parameter provides information related to the identity of the recipient LCS client. + +9080 Network Node Number + +9081 See definition in clause 7.6.2. This parameter provides the address of the sending node. + +9082 IMSI + +9083 The IMSI shall be provided if available to the VMSC or SGSN. + +9084 MSISDN + +9085 The MSISDN shall be provided if available to the VMSC or SGSN. + +9086 NA-ESRD + +9087 If the target MS has originated an emergency service call in North America, the NA-ESRD shall be provided by the +9088 VMSC if available. + +9089 If the target MS has originated an emergency service call in North America and NA-ESRK Request is included in +9090 Subscriber\_Location\_Report-Arg, an NA-ESRK or NA-ESRD, but not both, may also be included in the response to the +9091 MSC, see 3GPP TS 23.271 [26a]. + +9092 NA-ESRK + +9093 If the target MS has originated an emergency service call in North America, the NA-ESRK shall be provided by the +9094 VMSC if assigned. + +9095 If the target MS has originated an emergency service call in North America and NA-ESRK Request is included in +9096 Subscriber\_Location\_Report-Arg, an NA-ESRK or NA-ESRD, but not both, may also be included in the response to the +9097 MSC, see 3GPP TS 23.271 [26a]. + +9098 IMEI + +9099 The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +9100 Location Estimate + +9101 This parameter provides the location estimate. The absence of this parameter implies that a location estimate was not +9102 available or could not be successfully obtained. If the obtained location estimate is not encoded in one of the supported +9103 geographical shapes then this parameter shall consist of one octet, which shall be discarded by the receiving node. + +9104 GERAN Positioning Data + +9105 This parameter indicates the usage of each positioning method that was attempted to determine the location estimate +9106 either successfully or unsuccessfully. If Positioning Data received from the RAN contains no Positioning Methods, +9107 Positioning Data is excluded from the MAP message. It may be included in the message only if the access network is +9108 GERAN, see 3GPP TS 23.271 [26a]. + +9109 UTRAN Positioning Data + +9110 This parameter indicates the usage of each positioning method that was successfully attempted to determine the location +9111 estimate. If Position Data received from the RAN contains no Positioning Methods, UTRAN Positioning Data is +9112 excluded from the MAP message. It may be included in the message only if the access network is UTRAN, see 3GPP +9113 TS 23.271 [26a]. + +9114 GERAN GANSS Positioning Data + +9115 This parameter indicates the usage of each GANSS positioning method that was attempted to determine the location +9116 estimate either successfully or unsuccessfully. If GANSS Positioning Data received from the RAN contains no GANSS +9117 method, GERAN GANSS Positioning Data is excluded from the MAP message. It may be included in the message only +9118 if the access network is GERAN, see 3GPP TS 23.271 [26a]. + +9119 UTRAN GANSS Positioning Data + +9120 This parameter indicates the usage of each GANSS positioning method that was successfully attempted to determine the +9121 location estimate. If Position Data received from the RAN contains no GANSS Positioning Data Set, UTRAN GANSS +9122 Positioning Data is excluded from the MAP message. It may be included in the message only if the access network is +9123 UTRAN, see 3GPP TS 23.271 [26a]. + +9124 UTRAN Additional Positioning Data + +9125 This parameter indicates the usage of each Additional positioning method that was successfully attempted to determine +9126 the location estimate. If Position Data received from the RAN contains no Additional Positioning Data Set, UTRAN +9127 Additional Positioning Data is excluded from the MAP message. It may be included in the message only if the access +9128 network is UTRAN, see 3GPP TS 23.271 [26a]. + +9129 UTRAN Barometric Pressure Measurement + +9130 This parameter indicates the uncompensated barometric pressure measurement at the MS. The absence of this parameter +9131 implies that a barometric pressure measurement was not available or could not be successfully obtained. It may be +9132 included in the message only if the access network is UTRAN, see 3GPP TS 23.271 [26a]. + +9133 UTRAN Civic Address + +9134 This parameter indicates the civic address of the MS. The absence of this parameter implies that a civic address was not +9135 available or could not be successfully obtained. It may be included in the message only if the access network is +9136 UTRAN, see 3GPP TS 23.271 [26a]. + +9137 Age of Location Estimate + +9138 This parameter indicates how long ago the location estimate was obtained. + +9139 LMSI + +9140 The LMSI may be provided if assigned by the VLR. + +9141 GPRS Node Indicator + +9142 See definition in clause 7.6.8. This presence of this parameter is mandatory only if the SGSN number is sent in the +9143 Network Node Number. + +9144 Additional Location Estimate + +9145 This parameter provides the location estimate when not provided by the Location Estimate parameter.. + +9146 Deferred MT-LR Data + +9147 See definition in clause 7.6.11.3. + +9148 LCS-Reference Number + +9149 This parameter shall be included if the Subscriber Location Report is the response to a deferred MT location request. + +9150 NA-ESRK Request + +9151 If the target MS has originated an emergency service call in North America, NA-ESRK Request may be included to +9152 indicate that the MSC is able to accept NA-ESRK in the Response message, see clause 7.6.11.19. + +9153 Cell Id Or SAI + +9154 For GERAN access, this parameter indicates Global Cell Identifier of the cell that the served subscriber is currently +9155 attached to. For UTRAN access, this parameter contains the Service Area Identifier for the cell that the subscriber is +9156 currently attached to. This parameter is included only for Emergency Calls as described in 3GPP TS 23.271 [26a]. + +9157 H-GMLC address + +9158 See definition in clause 7.6.2. The parameter shall be included if the Subscriber Location Report is the response to a +9159 deferred MT location request for a UE available event, an area event or a periodic positioning event. This parameter +9160 shall be included in a Subscriber Location Report response if a deferred MO-LR TTTP procedure is initiated for a +9161 periodic positioning event. + +9162 LCS Service Type Id + +9163 See definition in clause 7.6.11.15. The requirements for its presence are specified in 3GPP TS 23.271 [26a]. + +9164 Pseudonym Indicator + +9165 This parameter indicates by its presence that the pseudonym is required. Refer to 3GPP TS 23.271 [26a]. + +9166 Accuracy Fulfilment Indicator + +9167 For a mobile terminated periodic LDR, this parameter indicates whether the obtained location estimate satisfies the +9168 requested accuracy or not, provided that this indication is obtained from RAN or the UE with the location estimate. + +9169 Periodic LDR Information + +9170 This parameter refers to the periodic reporting interval and reporting amount of the deferred periodic location. + +9171 MO-LR Short Circuit Indicator + +9172 This parameter indicates whether MO-LR Short Circuit is permitted for periodic location. + +9173 Reporting PLMN List + +9174 This parameter indicates a list of PLMNs in which subsequent periodic MO-LR TTTP requests will be made. + +9175 Sequence Number + +9176 This parameter refers to the number of the periodic location reports completed. The sequence number would be set to 1 +9177 in the first location report and increment by 1 for each new report. When the number reaches the reporting +9178 amount value, the H-GMLC (for a periodic MT-LR or a periodic MO-LR transfer to third party) will know the +9179 procedure is complete. For details see 3GPP TS 23.271 [26a]. + +9180 Target Serving Node for Handover + +9181 This parameter provides the address of the target side serving node for handover of an IMS Emergency Call. + +9182 User error + +9183 This parameter is sent by the responder when the received message contains an error, cannot be forwarded or stored for +9184 an LCS client or cannot be accepted for some other reason and if present, takes one of the following values defined in +9185 clause 7.6.1. + +- 9186 - System Failure; +- 9187 - Data Missing; +- 9188 - Unexpected Data Value; +- 9189 - Resource Limitation; +- 9190 - Unknown Subscriber; +- 9191 - Unauthorised requesting network; +- 9192 - Unknown or unreachable LCS Client. + +9193 Provider error + +9194 These are defined in clause 7.6.1. + +## 9195 13A.4 Void + +### 9196 13A.4.1 Void + +### 9197 13A.4.2 Void + +### 9198 13A.4.3 Void + +9199 **13A.5** Void + +9200 **13A.5.1** Void + +9201 **13A.5.2** Void + +9202 **13A.5.3** Void + +9203 **13A.6** Void + +9204 **13A.6.1** Void + +9205 **13A.6.2** Void + +9206 **13A.6.3** Void + +9207 **13A.7** Void + +9208 **13A.7.1** Void + +9209 **13A.7.2** Void + +9210 **13A.7.3** Void + +9211 **13A.8** Void + +9212 **13A.8.1** Void + +9213 **13A.8.2** Void + +9214 **13A.8.3** Void + +9215 **13A.9** Void + +9216 **13A.9.1** Void + +9217 **13A.9.2** Void + +9218 **13A.9.3** Void + +--- + +9219 **14** General + +9220 **14.1** Overview + +9221 Clauses 14 to 17 specify the protocol elements to be used to provide the MAP services described in clause 7. + +9222 Clause 15 specifies the elements of procedures for the MAP protocol. Clause 16 specifies the mapping onto TC service +9223 primitives. Clause 17 specifies the application contexts, operation packages and abstract syntaxes for the MAP protocol +9224 as well as the encoding rules to be applied. + +## 9225 14.2 Underlying services + +9226 The MAP protocol relies on the services provided by the Transaction Capabilities (TC) of Signalling System Number +9227 No. 7, as referenced in clause 6. + +## 9228 14.3 Model + +9229 The MAP Protocol Machine (MAP PM) can be modelled as a collection of service state machines (SSMs) - one per +9230 MAP specific service invoked - coordinated by a MAP dialogue control function with its one state machine: MAP +9231 dialogue state machine (DSM). There are two types of Service State Machines: Requesting Service State Machines +9232 (RSM) and Performing Service State Machines (PSM). + +9233 A new invocation of a MAP PM is employed on the receipt of a MAP-OPEN request primitive or a TC-BEGIN +9234 indication primitive. Each invocation controls exactly one MAP dialogue. For each MAP specific service invoked +9235 during a dialogue, a MAP RSM is created at the requestor's side and a MAP PSM is created at the performer's side. + +9236 This modelling is used only to facilitate understanding and the MAP behaviour descriptions and is not intended to +9237 suggest any implementation. SDL descriptions are organised according to this model. + +9238 How the MAP-service-user and the MAP refer to a MAP dialogue (i.e. a MAP PM invocation) is a local +9239 implementation matter. + +9240 How TC dialogue identifiers are assigned to a MAP PM invocation is also a local implementation matter. + +## 9241 14.4 Conventions + +9242 The behaviour of the MAP PM depends on the application-context-name associated with the dialogue. One major +9243 difference is that the MAP requests the transfer of the application-context-name by TC only for those contexts which do +9244 not belong to the so-called "version one context set". + +9245 The "version one context set" is a set of application-contexts which model the behaviour of a MAP V1 implementation +9246 according to the latest phase 1 version of GSM 09.02. This set is defined in clause 15. + +9247 The procedures described in clause 15 are used when the application-context-name does not refer to a dialogue between +9248 an MSC and its VLR. When the application-context-name refers to a dialogue between an MSC and its VLR the MAP +9249 PM procedures are a local implementation matter. + +--- + +## 9250 15 Elements of procedure + +### 9251 15.1 Handling of unknown operations + +9252 Unknown operations (i.e. a standard operation introduced in a later version of the MAP specification, or a private +9253 operation) can be introduced into MAP in a backwards compatible way. This means that the receiver of an unknown +9254 operation shall, if the dialogue state allows it, send a TC-REJECT component to the sender of the operation indicating +9255 'unrecognised operation' and continue with the processing of further components or messages exchanged within the +9256 dialogue as if the unknown operation had not been received. + +9257 The standardised structure of a MAP dialogue shall not be affected by the invocation of unknown operations, i.e. if a +9258 dialogue uses only a TC-BEGIN message which is acknowledged by a TC-END message, a TC-CONTINUE message +9259 shall not be used to invoke an unknown operation. However the standardised structure of a MAP dialogue may be +9260 affected by the rejection of unknown operations, i.e. if a dialogue uses only a TC-BEGIN message which is + +9261 acknowledged by a TC-END message, a TC-CONTINUE message followed by a TC-END message may be used to +9262 carry the rejection of an unknown operation and the response to the standardised operation. The entity which initiated a +9263 dialogue whose standardised structure is a TC-BEGIN message which is acknowledged by a TC-END message shall +9264 not send any messages in that dialogue after the TC-BEGIN. Note that if the dialogue structure is affected as described +9265 in this paragraph the TC-CONTINUE shall include the dialogue portion required to confirm the acceptance of the +9266 dialogue. + +9267 Unknown operations may be invoked in the following types of message (there is no restriction as to how many +9268 unknown operations can be invoked in a message): + +9269 - TC-BEGIN: the component to invoke the unknown operation shall follow the component of the standard +9270 operation which is included in this message. + +9271 - TC-CONTINUE: the component to invoke the unknown operation may be transported as the only component +9272 in a stand-alone message or may be grouped with existing operations. In the latter case a specific sequencing +9273 of components is not required. + +9274 - TC-END: if the component to invoke the unknown operation is grouped with an existing operation a specific +9275 sequencing of components is not required + +9276 The TC-REJECT component may be sent in the following messages: + +9277 - TC-CONTINUE or TC-END: either as the only component of the message or grouped with an existing +9278 component. The choice is up to the MAP-Service User. + +9279 If the received message contains only unknown operations the MAP-Service User shall send the TC-REJECT +9280 components in a TC-CONTINUE message to the peer entity, if the dialogue state allows it. + +9281 If the received message contains unknown operations and standard operations and the standardised structure +9282 of the dialogue requires the response to the standard operation to be sent within a TC-END message, then the +9283 MAP-Service User may send the response to the standard operations and the TC-REJECT components for +9284 the unknown operations in a TC-CONTINUE message followed by a TC-END message. Neither a specific +9285 distribution of the components to the TC messages nor a specific sequencing of components is required. + +9286 Note that the SDL diagrams of clauses 19 - 25 do not show the report to the MAP-Service User about the reception of +9287 the unknown operation. This has been done for simplicity of description; the MAP PM may inform the MAP-Service +9288 User. + +9289 The sender of the unknown operation shall ensure that there is enough room in the used message for the unknown +9290 operation. + +## 9291 15.2 Dialogue establishment + +9292 The establishment of a MAP dialogue involves two MAP-service-users: the dialogue-initiator and the dialogue- +9293 responder. + +9294 This procedure is driven by the following signals: + +9295 - a MAP-OPEN request primitive from the dialogue-initiator; + +9296 - a TC-BEGIN indication primitive occurring at the responding side; + +9297 - a MAP-OPEN response primitive from the dialogue-responder; + +9298 - the first TC-CONTINUE indication primitive occurring at the initiating side; + +9299 and under specific conditions: + +9300 - a TC-END indication primitive occurring at the initiating side; + +9301 - a TC-U-ABORT indication primitive occurring at the initiating side; + +9302 - a TC-P-ABORT indication primitive occurring at the initiating side. + +9303 One instance of the MAP dialogue state machine runs at the initiating side, and one at the responding side. + +## 9304 15.2.1 Behaviour at the initiating side + +9305 The behaviour of the MAP dialogue state machine at the initiating side is defined in sheets 1 – 8 of the process +9306 MAP\_DSM (figure 15.6/3). + +9307 Sheet 3: When the MAP dialogue state machine at the initiating side is waiting for a response from the responding side, +9308 a TC-END indication which echoes the AC name which was sent in the TC-BEGIN indicates acceptance of the +9309 dialogue. + +9310 Sheet 3: If the dialogue opening is accepted, any components included in the TC-END are processed and passed to the +9311 MAP-Service User. The dialogue is closed by sending a MAP-CLOSE to the MAP-Service User. + +9312 Sheet 3, sheet 4, sheet 5, sheet 6, sheet 7, sheet 8: when a dialogue is terminated, the MAP dialogue state machine +9313 terminates all instances of the Requesting\_MAP\_SSM which are active for this dialogue. + +9314 Sheet 4: A TC-P-ABORT with an abort parameter Incorrect\_Transaction\_Portion indicates that the responding side +9315 does not support a MAP version higher than 1. This triggers a MAP-OPEN confirm indicating that the dialogue is +9316 refused, with a refuse reason potential version incompatibility. The MAP-Service User may then decide to retry the +9317 dialogue at MAP version 1. + +9318 Sheet 8: When the MAP dialogue state machine at the initiating side is waiting for a response from the responding side, +9319 a TC-CONTINUE indication which echoes the AC name which was sent in the TC-BEGIN indicates acceptance of the +9320 dialogue. + +9321 Sheet 8: If the dialogue opening is accepted, any components included in the TC-CONTINUE are processed and passed +9322 to the MAP-Service User. The dialogue has then reached the established state. + +## 9323 15.2.2 Behaviour at the responding side + +9324 The behaviour of the MAP dialogue state machine at the responding side is defined in sheets 0 – 14 of the process +9325 MAP\_DSM (figure 15.6/3). + +9326 Sheet 9: If no application context information is included in the TC-BEGIN indication, this implies a MAP version 1 +9327 dialogue. An explicit application context indicating version 1 is treated as abnormal behaviour. + +9328 Sheet 11: The v1 application context name which corresponds to a v1 operation is derived using the information in table +9329 15.2/1. + +9330 **Table 15.2/1: Mapping of V1 operation codes on to application-context-names** + +| Operation | Application-context-name (note 1) | +|---------------------------------|------------------------------------------------------------| +| updateLocation | networkLocUpContext-v1 | +| cancelLocation | locationCancellationContext-v1 | +| provideRoamingNumber | roamingNumberEnquiryContext-v1 | +| insertSubscriberData | subscriberDataMngtContext-v1 | +| deleteSubscriberData | subscriberDataMngtContext-v1 | +| sendParameters | infoRetrievalContext-v1
networkLocUpContext-v1 (note 2) | +| beginSubscriberActivity | networkFunctionalSsContext-v1 | +| sendRoutingInfo | locationInfoRetrievalContext-v1 | +| performHandover | handoverControlContext-v1 | +| reset | resetContext-v1 | +| activateTraceMode | tracingContext-v1 | +| deactivateTraceMode | tracingContext-v1 | +| sendRoutingInfoForSM | shortMsgGatewayContext-v1 | +| forwardSM | shortMsgRelayContext-v1 | +| reportSM-deliveryStatus | shortMsgGatewayContext-v1 | +| noteSubscriberPresent | mwdMngtContext-v1 | +| alertServiceCentreWithoutResult | shortMsgAlertContext-v1 | +| checkIMEI | EquipmentMngtContext-v1 | + +9331 + +9332 NOTE 1: These symbolic names refer to the object identifier value defined in clause 17 and allocated to each +9333 application-context used for the MAP. + +9334 NOTE 2: The choice between the application contexts is based on the parameters received in the operation. + +9335 +9336 Sheet 12: If the dialogue is accepted, each component present in the TC-BEGIN is forwarded to an instance of a +9337 Performing\_MAP\_SSM, by executing the procedure Process\_Components. + +9338 Sheet 13: If the MAP dialogue state machine receives a MAP-OPEN response with a result accepted, it waits for any +9339 MAP specific service request or response primitives or a MAP-DELIMITER request. + +9340 Sheet 13, sheet 14: When a dialogue is terminated, the MAP dialogue state machine terminates all instances of the +9341 Requesting\_MAP\_SSM or Performing\_MAP\_SSM which are active for this dialogue. + +9342 Sheet 14: A MAP-DELIMITER request triggers a TC-CONTINUE request to accept the dialogue. The dialogue has +9343 then reached the established state. + +## 9344 15.3 Dialogue continuation + +9345 Once established the dialogue is said to be in a continuation phase. The behaviour of the MAP dialogue state machine in +9346 this phase is defined in sheets 15 – 17 of the process MAP\_DSM (figure 15.6/3). + +9347 Both MAP users can request the transfer of MAP APDUs until one of them requests the termination of the dialogue. + +9348 Normal closure of an established dialogue is shown on sheet 16; abnormal termination is shown on sheet 17. + +## 9349 15.4 Load control + +9350 If an entity which should respond to a MAP dialogue opening request is overloaded, it uses the AC of the request to +9351 determine whether to discard the request. + +9352 The priority level allocated to each application-context is described in clause 5, tables 5.1/1, 5.1/2, and 5.1/3. + +## 9353 15.5 Procedures for MAP specific services + +9354 This clause describes the MAP procedures for MAP specific services. These procedures are driven by the following +9355 types of event: + +9356 - a MAP specific request or a MAP specific response primitive; + +9357 - a component handling primitive from TC. + +9358 A Service State Machine is activated when of one of the following signals is received: + +9359 - a MAP request primitive, which activates a requesting SSM; + +9360 - a TC-INVOKED indication primitive without a linked identifier, which activates a performing SSM. + +9361 For component handling primitives there are two types of event: + +9362 - events which activate a Service State Machine or which can be related to an existing one; + +9363 - events which cannot be related to a Service State Machine. + +### 9364 15.5.1 Service invocation + +9365 The behaviour of the requesting SSM which handles a service is defined by the SDL for the process +9366 Requesting\_MAP\_SSM. The requesting SSM receives a MAP service request from the MAP-Service User via the MAP +9367 dialogue state machine and sends a TC-INVOKED request to TCAP. When a confirm is received from TCAP via the +9368 MAP dialogue state machine, the requesting SSM forwards a MAP service confirm to the MAP-Service User. + +9369 The response to a MAP service invocation may come in the form of a linked request. If the linked request corresponds +9370 to a class 4 operation, this is handled by the requesting SSM. If the linked request corresponds to a class 1, 2 or 3 + +9371 operation, the MAP dialogue state machine sends a notification to the requesting SSM and creates an instance of a +9372 performing SSM to handle the linked request. The test "Linked\_Operation\_Allowed" on sheet 3 of the process +9373 Requesting\_MAP\_SSM takes the (TRUE) exit if the definition of the parent operation includes the received linked +9374 operation as a permitted linked operation; otherwise the test takes the (FALSE) exit. + +9375 The mapping of MAP specific services on to remote operations is given in table 16.2/1. + +## 9376 15.5.2 Void + +## 9377 15.5.3 Service invocation receipt + +9378 The behaviour of the performing SSM which handles a service is defined by the SDL for the process +9379 Performing\_MAP\_SSM. The performing SSM receives a TC-INVOKE component from TCAP via the MAP dialogue +9380 state machine and sends a MAP service indication to the MAP-Service User. When a MAP service response is received +9381 from the MAP-Service User via the MAP dialogue state machine, the performing SSM forwards a TC-RESULT or TC- +9382 U-ERROR component to TCAP. + +## 9383 15.5.4 Void + +## 9384 15.5.5 Handling of components received from TC + +9385 The procedure Process\_Components shows the handling of components received in a TC-BEGIN, TC-CONTINUE or +9386 TC-END message. + +9387 Sheet 2: If a linked invoke component corresponds to a class 4 operation, the MAP dialogue state machine sends it to +9388 the requesting SSM instance identified by the linked invoke ID. If a linked invoke component corresponds to any other +9389 class of operation, the MAP dialogue state machine sends a notification to the requesting SSM instance identified by the +9390 linked invoke ID, creates an instance of a performing SSM and sends the invoke component to it. + +## 9391 15.6 SDL descriptions + +9392 The following SDL specification describes a system which includes three blocks: MAP-user, MAP-provider and TC. + +9393 Such a system resides in each network component supporting MAP and communicates with its peers via the lower +9394 layers of the signalling network which are part of the environment. + +9395 Only the MAP-provider is fully described in this clause. The various types of processes which form the MAP-User +9396 block and the TC block are described respectively in clauses 18 to 25 of the present document and in CCITT +9397 Recommendation Q.774. + +9398 The MAP-Provider block communicates with the MAP\_USER via two channels U1 and U2. Via U1 the MAP-provider +9399 receives the MAP request and response primitives. Via U2 it sends the MAP indication and confirm primitives. + +9400 The MAP-Provider block communicates with TC via two channels P1 and P2. Via P1 the MAP-Provider sends all the +9401 TC request primitives. Via P2 it receives all the TC indication primitives. + +9402 The MAP-Provider block is composed of the four following types of process: + +9403 a) MAP\_DSM: This type of process handles a dialogue for transport of MAP messages. There exists one +9404 process instance per MAP dialogue. + +9405 b) Load\_Ctrl: This type of process is in charge of load control. There is only one instance of this process in each +9406 system. + +9407 c) Requesting\_MAP\_SSM: This type of process handles a MAP service requested during a dialogue. An +9408 instance of this process is created by the instance of the MAP\_DSM process for each requested MAP service. + +9409 d) Performing\_MAP\_SSM: This type of process handles a MAP service performed during a dialogue. An +9410 instance of this process is created by the instance of the MAP\_DSM process for each MAP service to be +9411 performed. + +9412 A process MAP\_DSM exchanges external signals with other blocks as well as internal signals with the other processes +9413 of the MAP-Provider block. The external signals are either MAP service primitives or TC service primitives. + +9414 The signal routes used by the various processes are organised as follows: + +9415 a) A process MAP\_DSM receives and sends events from/to the MAP\_user via signal route User1/User2. These +9416 routes use channels U1 and U2 respectively. + +9417 b) A process MAP\_DSM receives and sends events from/to the TCAP via signal route TC1/TC2. These routes +9418 use channels P1 and P2 respectively. + +9419 c) A process MAP\_DSM receives and sends events from/to the LOAD\_CTRL process via signal route +9420 Load1/Load2. These routes are internal. + +9421 d) A process MAP\_DSM sends events to the Performing\_MAP\_SSM processes via signal route Intern1. This +9422 route is internal. + +9423 e) A process MAP\_DSM sends events to the Requesting\_MAP\_SSM processes via signal route Intern2. This +9424 route is internal. + +9425 f) A process Performing\_MAP\_SSM sends events to the MAP\_USER via signal route User3. This route uses +9426 channel U2. + +9427 g) A process Performing\_MAP\_SSM sends events to the TCAP via signal route TC3. This route uses channel +9428 P1. + +9429 h) A process Requesting\_MAP\_SSM sends events to the MAP\_USER via signal route User4. This route uses +9430 channel U2. + +9431 i) A process Requesting\_MAP\_SSM sends events to the TCAP via signal route TC4. This route uses channel +9432 P1. + +System MAP\_Stack + +Map\_Stack1(1) + +![Sequence diagram of System MAP_Stack showing interactions between MAP_USER, MAP Provider, and TCAP.](1fa646088a731bde9ff4c9af87f93d3c_img.jpg) + +``` +sequenceDiagram + participant MAP_USER + participant MAP_Provider as MAP Provider + participant TCAP + + Note left of MAP_USER: [u1] + MAP_USER->>MAP_Provider: (MAP_REQ_SM) + Note right of MAP_Provider: [u2] + MAP_Provider-->>MAP_USER: MAP_IND_SP + Note left of TCAP: [P1] + MAP_Provider->>TCAP: TC_REQ_SP + Note right of TCAP: [P2] + TCAP-->>MAP_Provider: TC_IND_SP +``` + +The diagram illustrates the interaction within the System MAP\_Stack. It features three main components: MAP\_USER, MAP Provider, and TCAP. The sequence of interactions is as follows: 1. MAP\_USER sends a request (MAP\_REQ\_SM) to the MAP Provider, labeled with [u1]. 2. The MAP Provider responds with an indication (MAP\_IND\_SP), labeled with [u2]. 3. The MAP Provider then sends a request (TC\_REQ\_SP) to the TCAP, labeled with [P1]. 4. Finally, the TCAP returns an indication (TC\_IND\_SP) to the MAP Provider, labeled with [P2]. + +Sequence diagram of System MAP\_Stack showing interactions between MAP\_USER, MAP Provider, and TCAP. + +Figure 15.6/1: System MAP\_Stack + +![Block diagram of MAPProvider (MAP_Provider1(1)) showing internal components: MAP_DSM, Load_Ctrl, Requesting_MAP_SSM, and Performing_MAP_SSM with their respective inputs and outputs.](e9b0c54f494f276491a59ab381f2e5b2_img.jpg) + +The diagram illustrates the internal structure of the **Block MAPProvider** (labeled **MAP\_Provider1(1)** in the top right). A small note icon is present in the top left corner. + +The main components and their connections are as follows: + +- MAP\_DSM** (top center): + - Inputs: **TC2** and **TC1** from the left; **User1** and **User2** from the right. + - Outputs: **TC1** to the left; **User2** to the right. + - Internal connections: **Load2** output to **Load\_Ctrl**; **Load1** input from **Load\_Ctrl**. + - External connections: **Intern2** output to **Requesting\_MAP\_SSM**; **Intern1** output to **Performing\_MAP\_SSM**. +- Load\_Ctrl** (middle center): + - Input: **Load2** from **MAP\_DSM**. + - Output: **Load1** to **MAP\_DSM**. +- Requesting\_MAP\_SSM** (bottom left): + - Input: **Intern2** from **MAP\_DSM**. + - Output: **TC4** to the left. + - Internal connection: **TC3** input from the bottom. +- Performing\_MAP\_SSM** (bottom right): + - Input: **Intern1** from **MAP\_DSM**. + - Output: **User3** to the right. + - Internal connection: **TC3** output to the bottom. +- External Connections:** + - TC3** (bottom left) connects to **User4** (bottom right). + - TC4** (bottom left) connects to **User3** (bottom right). + +Each signal line has a small empty box **[ ]** associated with it, likely for parameterization or configuration. + +Block diagram of MAPProvider (MAP\_Provider1(1)) showing internal components: MAP\_DSM, Load\_Ctrl, Requesting\_MAP\_SSM, and Performing\_MAP\_SSM with their respective inputs and outputs. + +9435 + +9436 + +Figure 15.6/2: Block MAP\_Provider + +# Process MAP\_DSM + +MAP\_DSM1(17) + +Process to manage a MAP dialogue + +Comment 'MAP Dialogue State Machine'; +DCL +Components\_Present, AC\_Name\_Unchanged, +AC\_Included, AC\_Supported, Invoke\_ID\_Active, Last\_Component, Operation\_Exists, +Alternative\_Name\_Exists, User\_Info\_Included BOOLEAN, +Op\_Code INTEGER; + +![State transition diagram for Process MAP_DSM](fb00a9ea622a6fe32404236fbf9b1b6a_img.jpg) + +``` +graph TD; Start([ ]) --> IDLE([IDLE]); IDLE --> MAP_OPEN_req{{MAP_OPEN_req}}; MAP_OPEN_req --> Store_AC_and_user_data[Store_AC_and_user_data]; Store_AC_and_user_data --> WAIT_FOR_USER_REQUESTS([WAIT_FOR_USER_REQUESTS]); Store_AC_and_user_data -.-> Note[For dialogue portion of TC-BEGIN]; +``` + +The diagram illustrates the state transitions for the Process MAP\_DSM. It begins with an initial state (oval), leading to the IDLE state (rounded rectangle). From IDLE, a transition labeled 'MAP\_OPEN\_req' (chevron) leads to the 'Store\_AC\_and\_user\_data' state (rectangle). This state is associated with a note 'For dialogue portion of TC-BEGIN'. Finally, a transition leads to the 'WAIT\_FOR\_USER\_REQUESTS' state (rounded rectangle). + +State transition diagram for Process MAP\_DSM + +9437 + +9438 + +Figure 15.6/3a: Process MAP\_DSM (sheet 1) + +Process MAP\_DSM + +MAP\_DSM2(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at WAIT_FOR_USER_REQUESTS and branches into three paths: MAP_req (leading to Requesting_MAP_SSM, Service_Invoked_VIA_Intern2, and back to WAIT_FOR_USER_REQUESTS), MAP_DELIMITER_req (leading to TC_BEGIN_req_VIA_TC1 and DIALOGUE_INITIATED), and MAP_U_ABORT_req (leading to Set_Abort_Reason, Set_User_Info, TC_U_ABORT_req_VIA_TC1, Terminated_VIA_Intern2, IDLE, and To all active RSSMs).](bf9abec3605f1a8d00ae6524a9af02ed_img.jpg) + +``` +stateDiagram-v2 + [*] --> WAIT_FOR_USER_REQUESTS + WAIT_FOR_USER_REQUESTS --> MAP_req + WAIT_FOR_USER_REQUESTS --> MAP_DELIMITER_req + WAIT_FOR_USER_REQUESTS --> MAP_U_ABORT_req + MAP_req --> Requesting_MAP_SSM + Requesting_MAP_SSM --> Service_Invoked_VIA_Intern2 + Service_Invoked_VIA_Intern2 --> WAIT_FOR_USER_REQUESTS + MAP_DELIMITER_req --> TC_BEGIN_req_VIA_TC1 + TC_BEGIN_req_VIA_TC1 --> DIALOGUE_INITIATED + MAP_U_ABORT_req --> Set_Abort_Reason:User_Specific + Set_Abort_Reason:User_Specific --> Set_User_Info:MAP_User_Abort_PDU + Set_User_Info:MAP_User_Abort_PDU --> TC_U_ABORT_req_VIA_TC1 + TC_U_ABORT_req_VIA_TC1 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + Terminated_VIA_Intern2 --> To_all_active_RSSMs: To all active RSSMs +``` + +State transition diagram for Process MAP\_DSM. It starts at WAIT\_FOR\_USER\_REQUESTS and branches into three paths: MAP\_req (leading to Requesting\_MAP\_SSM, Service\_Invoked\_VIA\_Intern2, and back to WAIT\_FOR\_USER\_REQUESTS), MAP\_DELIMITER\_req (leading to TC\_BEGIN\_req\_VIA\_TC1 and DIALOGUE\_INITIATED), and MAP\_U\_ABORT\_req (leading to Set\_Abort\_Reason, Set\_User\_Info, TC\_U\_ABORT\_req\_VIA\_TC1, Terminated\_VIA\_Intern2, IDLE, and To all active RSSMs). + +9439 + +9440 + +Figure 15.6/3b: Process MAP\_DSM (sheet 2) + +Process MAP\_DSM + +MAP\_DSM3(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_INITIATED and branches based on TC_END_ind and TC_NOTICE_ind signals. The main path involves setting results, opening via User2, checking components, closing via User2, and terminating via internal signals to reach an IDLE state. A sub-path handles 'Dialogue_Refused' and 'Node_Not_Reachable' cases.](933a097f8f087e901730352801e25555_img.jpg) + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_INITIATED + DIALOGUE_INITIATED --> TC_END_ind + DIALOGUE_INITIATED --> TC_NOTICE_ind + TC_END_ind --> AC_Name_Unchanged + AC_Name_Unchanged -- (FALSE) --> 1 + AC_Name_Unchanged -- (TRUE) --> Set_Result_Accepted + Set_Result_Accepted --> MAP_OPEN_cnf_VIA_User2 + MAP_OPEN_cnf_VIA_User2 --> Components_Present + Components_Present -- (FALSE) --> MAP_CLOSE_ind_VIA_User2 + Components_Present -- (TRUE) --> Process_Components + Process_Components --> MAP_CLOSE_ind_VIA_User2 + MAP_CLOSE_ind_VIA_User2 --> Terminated_VIA_Intern1 + Terminated_VIA_Intern1 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + 1 --> Set_Provider_Reason + Set_Provider_Reason --> MAP_P_ABORT_ind_VIA_User2 + TC_NOTICE_ind --> Set_Result_Refused + Set_Result_Refused --> Set_Refuse_Reason + Set_Refuse_Reason --> MAP_OPEN_cnf_VIA_User2 + MAP_P_ABORT_ind_VIA_User2 --> IDLE + MAP_OPEN_cnf_VIA_User2 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + Terminated_VIA_Intern1 --> To_all_active_PSSMs + Terminated_VIA_Intern2 --> To_all_active_RSSMs + Terminated_VIA_Intern2 --> To_all_active_RSSMs + +``` + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_INITIATED and branches based on TC\_END\_ind and TC\_NOTICE\_ind signals. The main path involves setting results, opening via User2, checking components, closing via User2, and terminating via internal signals to reach an IDLE state. A sub-path handles 'Dialogue\_Refused' and 'Node\_Not\_Reachable' cases. + +9441 + +9442 + +Figure 15.6/3c: Process MAP\_DSM (sheet 3) + +Process MAP\_DSM + +MAP\_DSM4(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_INITIATED, goes through TC_P_ABORT_ind, then a P-Abort_Parameter decision. The decision has three paths: 'Incorrect_Transaction_Portion' leads to Set_Result: Dialogue_Refused; 'No_Common_Dialogue_Portion' leads to Set_Provider_Reason: Version_Incompatibility; 'Else' also leads to Set_Provider_Reason: Version_Incompatibility. Both Set_Result and Set_Provider_Reason lead to MAP_P_ABORT_ind_VIA_User2. From there, the flow goes to Terminated_VIA_Intern2, which then leads to IDLE. There are also callouts 'To all active RSSMs' from both Terminated_VIA_Intern2 blocks.](a9858b877d4da8ec2e81be7a7a50dd00_img.jpg) + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_INITIATED + DIALOGUE_INITIATED --> TC_P_ABORT_ind + TC_P_ABORT_ind --> P-Abort_Parameter + P-Abort_Parameter --> Set_Result: Dialogue_Refused : Incorrect_Transaction_Portion + P-Abort_Parameter --> Set_Provider_Reason: Version_Incompatibility : No_Common_Dialogue_Portion + P-Abort_Parameter --> Set_Provider_Reason: Version_Incompatibility : Else + Set_Result: Dialogue_Refused --> Set_Refuse_Reason: Potential_Version_Incompatibility + Set_Refuse_Reason: Potential_Version_Incompatibility --> MAP_OPEN_cnf_VIA_User2 + MAP_OPEN_cnf_VIA_User2 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + Set_Provider_Reason: Version_Incompatibility --> MAP_P_ABORT_ind_VIA_User2 + MAP_P_ABORT_ind_VIA_User2 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + +``` + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_INITIATED, goes through TC\_P\_ABORT\_ind, then a P-Abort\_Parameter decision. The decision has three paths: 'Incorrect\_Transaction\_Portion' leads to Set\_Result: Dialogue\_Refused; 'No\_Common\_Dialogue\_Portion' leads to Set\_Provider\_Reason: Version\_Incompatibility; 'Else' also leads to Set\_Provider\_Reason: Version\_Incompatibility. Both Set\_Result and Set\_Provider\_Reason lead to MAP\_P\_ABORT\_ind\_VIA\_User2. From there, the flow goes to Terminated\_VIA\_Intern2, which then leads to IDLE. There are also callouts 'To all active RSSMs' from both Terminated\_VIA\_Intern2 blocks. + +9443 + +9444 + +Figure 15.6/3d: Process MAP\_DSM (sheet 4) + +Process MAP\_DSM + +MAP\_DSM5(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_INITIATED and branches into TC_U_ABORT_ind and TC_L_CANCEL_ind. The TC_U_ABORT_ind path leads to an Abort_Reason decision, which can lead to state 4, a dialogue refusal sequence, or back to DIALOGUE_INITIATED. The TC_L_CANCEL_ind path leads to MAP_OPEN_cnf_VIA_User2, then to an invoke_ID_Active decision, which can lead to a timer expiry or back to DIALOGUE_INITIATED.](a2763753bfc5fc69f0694c695973cd40_img.jpg) + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_INITIATED + DIALOGUE_INITIATED --> TC_U_ABORT_ind + DIALOGUE_INITIATED --> TC_L_CANCEL_ind + TC_U_ABORT_ind --> Abort_Reason + Abort_Reason --> 4 : User_Specific + Abort_Reason --> Set_Result : AC_Not_Supported + Set_Result --> Set_Refuse_Reason : Dialogue_Refused + Set_Refuse_Reason --> MAP_OPEN_cnf_VIA_User2 + MAP_OPEN_cnf_VIA_User2 --> Terminated : To all active RSSMs + Terminated --> IDLE + TC_L_CANCEL_ind --> MAP_OPEN_cnf_VIA_User2 + MAP_OPEN_cnf_VIA_User2 --> invoke_ID_Active + invoke_ID_Active --> Timer_Expiry : (TRUE) + invoke_ID_Active --> DIALOGUE_INITIATED : (FALSE) + Timer_Expiry --> DIALOGUE_INITIATED + +``` + +Accepted. The dialogue is considered implicitly accepted when something is received + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_INITIATED and branches into TC\_U\_ABORT\_ind and TC\_L\_CANCEL\_ind. The TC\_U\_ABORT\_ind path leads to an Abort\_Reason decision, which can lead to state 4, a dialogue refusal sequence, or back to DIALOGUE\_INITIATED. The TC\_L\_CANCEL\_ind path leads to MAP\_OPEN\_cnf\_VIA\_User2, then to an invoke\_ID\_Active decision, which can lead to a timer expiry or back to DIALOGUE\_INITIATED. + +9445 + +9446 + +Figure 15.6/3e: Process MAP\_DSM (sheet 5) + +Process MAP\_DSM + +MAP\_DSM6(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at a circle labeled '4', leading to a decision diamond 'User_Information'. From 'User_Information', four paths emerge: 'User_Abort_PDU' (leading to 'MAP_P_ABORT_ind_VIA_User2'), 'Provider_Abort_PDU' (leading to 'MAP_P_ABORT_ind_VIA_User2'), 'Dialogue_Refused' (leading to 'Set_Result: Dialogue_Refused' then 'MAP Refuse_PDU_Error'), and 'No_User_Info' (leading to 'Set_Result: Dialogue_Refused'). 'MAP Refuse_PDU_Error' has three sub-paths: 'Invalid_Destination_Reference' (leading to 'Set_Refuse_Reason: Invalid_Destination_Reference'), 'Invalid_Originating_Reference' (leading to 'Set_Refuse_Reason: Invalid_Originating_Reference'), and 'No_Reason_Given' (leading to 'Set_Refuse_Reason: No_Reason_Given'). These three paths merge at a junction. From this junction, one path leads to 'MAP_OPEN_cnf_VIA_User2' and another leads to 'Set_Refuse_Reason: Potential_Version_Incompatibility'. All three paths ('MAP_OPEN_cnf_VIA_User2', 'Set_Refuse_Reason: Potential_Version_Incompatibility', and the merged path from the junction) lead to a decision diamond 'Terminated_VIA_Intern2'. 'Terminated_VIA_Intern2' has a dashed box 'To all active RSSMs' and leads to an oval 'IDLE' state.](d1203e87a330a98abf08c99d65e5a24b_img.jpg) + +``` + +stateDiagram-v2 + [*] --> User_Information + User_Information --> User_Abort_PDU + User_Information --> Provider_Abort_PDU + User_Information --> Dialogue_Refused + User_Information --> No_User_Info + User_Abort_PDU --> MAP_P_ABORT_ind_VIA_User2 + Provider_Abort_PDU --> MAP_P_ABORT_ind_VIA_User2 + Dialogue_Refused --> Set_Result_Dialogue_Refused + No_User_Info --> Set_Result_Dialogue_Refused + Set_Result_Dialogue_Refused --> MAP_Refuse_PDU_Error + MAP_Refuse_PDU_Error --> Invalid_Destination_Reference + MAP_Refuse_PDU_Error --> Invalid_Originating_Reference + MAP_Refuse_PDU_Error --> No_Reason_Given + Invalid_Destination_Reference --> Set_Refuse_Reason_Invalid_Destination_Reference + Invalid_Originating_Reference --> Set_Refuse_Reason_Invalid_Originating_Reference + No_Reason_Given --> Set_Refuse_Reason_No_Reason_Given + Set_Refuse_Reason_Invalid_Destination_Reference --> Junction + Set_Refuse_Reason_Invalid_Originating_Reference --> Junction + Set_Refuse_Reason_No_Reason_Given --> Junction + Junction --> MAP_OPEN_cnf_VIA_User2 + Junction --> Set_Refuse_Reason_Potential_Version_Incompatibility + Set_Refuse_Reason_Potential_Version_Incompatibility --> Junction + MAP_OPEN_cnf_VIA_User2 --> Terminated_VIA_Intern2 + Set_Refuse_Reason_Potential_Version_Incompatibility --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> To_all_active_RSSMs + Terminated_VIA_Intern2 --> IDLE + +``` + +State transition diagram for Process MAP\_DSM. It starts at a circle labeled '4', leading to a decision diamond 'User\_Information'. From 'User\_Information', four paths emerge: 'User\_Abort\_PDU' (leading to 'MAP\_P\_ABORT\_ind\_VIA\_User2'), 'Provider\_Abort\_PDU' (leading to 'MAP\_P\_ABORT\_ind\_VIA\_User2'), 'Dialogue\_Refused' (leading to 'Set\_Result: Dialogue\_Refused' then 'MAP Refuse\_PDU\_Error'), and 'No\_User\_Info' (leading to 'Set\_Result: Dialogue\_Refused'). 'MAP Refuse\_PDU\_Error' has three sub-paths: 'Invalid\_Destination\_Reference' (leading to 'Set\_Refuse\_Reason: Invalid\_Destination\_Reference'), 'Invalid\_Originating\_Reference' (leading to 'Set\_Refuse\_Reason: Invalid\_Originating\_Reference'), and 'No\_Reason\_Given' (leading to 'Set\_Refuse\_Reason: No\_Reason\_Given'). These three paths merge at a junction. From this junction, one path leads to 'MAP\_OPEN\_cnf\_VIA\_User2' and another leads to 'Set\_Refuse\_Reason: Potential\_Version\_Incompatibility'. All three paths ('MAP\_OPEN\_cnf\_VIA\_User2', 'Set\_Refuse\_Reason: Potential\_Version\_Incompatibility', and the merged path from the junction) lead to a decision diamond 'Terminated\_VIA\_Intern2'. 'Terminated\_VIA\_Intern2' has a dashed box 'To all active RSSMs' and leads to an oval 'IDLE' state. + +9447 + +9448 + +Figure 15.6/3f: Process MAP\_DSM (sheet 6) + +Process MAP\_DSM + +MAP\_DSM7(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_INITIATED and branches into two paths: one for MAP_U_ABORT_req (Local) and one for MAP_CLOSE_req (Pre-arranged). Both paths lead to TC_*_req_VIA_TC1, which then lead to Terminated_VIA_Intern2 and finally to IDLE. The MAP_U_ABORT_req path includes Set_Abort_Reason: User_Specific and Set_User_Info: MAP_User_Abort_Info.](00bb8c9fd2ec7fa7da34a98f824468b6_img.jpg) + +``` +graph TD; DIALOGUE_INITIATED([DIALOGUE_INITIATED]) --> MAP_U_ABORT_req{{MAP_U_ABORT_req}}; DIALOGUE_INITIATED --> MAP_CLOSE_req{{MAP_CLOSE_req}}; MAP_U_ABORT_req --> Set_Abort_Reason[Set_Abort_Reason: User_Specific]; Set_Abort_Reason --> Set_User_Info[Set_User_Info: MAP_User_Abort_Info]; Set_User_Info --> TC_U_ABORT_req_VIA_TC1{{TC_U_ABORT_req_VIA_TC1}}; TC_U_ABORT_req_VIA_TC1 --> Terminated_VIA_Intern2{{Terminated_VIA_Intern2}}; Terminated_VIA_Intern2 --> IDLE([IDLE]); MAP_CLOSE_req --> TC_END_req_VIA_TC1{{TC_END_req_VIA_TC1}}; TC_END_req_VIA_TC1 --> Terminated_VIA_Intern2; Local[Local] -.-> TC_U_ABORT_req_VIA_TC1; Pre-arranged[Pre-arranged] -.-> TC_END_req_VIA_TC1; To_all_active_RSSMs[To all active RSSMs] -.-> Terminated_VIA_Intern2 +``` + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_INITIATED and branches into two paths: one for MAP\_U\_ABORT\_req (Local) and one for MAP\_CLOSE\_req (Pre-arranged). Both paths lead to TC\_\*\_req\_VIA\_TC1, which then lead to Terminated\_VIA\_Intern2 and finally to IDLE. The MAP\_U\_ABORT\_req path includes Set\_Abort\_Reason: User\_Specific and Set\_User\_Info: MAP\_User\_Abort\_Info. + +9449 + +9450 + +Figure 15.6/3g: Process MAP\_DSM (sheet 7) + +Process MAP\_DSM + +MAP\_DSM8(17) + +Process to manage +a MAP dialogue + +![SDL process diagram for MAP_DSM showing the flow from DIALOGUE_INITIATED to either DIALOGUE_ESTABLISHED or IDLE based on AC_Name_Unchanged and Components_Present decisions.](524bf86b6b42612b7ec0d0a04b04a708_img.jpg) + +``` + +graph TD + Start([DIALOGUE_INITIATED]) --> TC_Ind[/TC_CONTINUE_ind/] + TC_Ind --- Comment1[The first one] + TC_Ind --> Decision1{AC_Name_Unchanged} + + Decision1 -- "(TRUE)" --> Task1[Set_Result: +Dialogue_ +Accepted] + Task1 --> Output1[/MAP_OPEN_ +cnf_VIA_User2/] + Output1 --> Decision2{Components_ +Present} + + Decision2 -- "(TRUE)" --> Proc1[[Process_ +Components]] + Proc1 --> Output2[/MAP_ +DELIMITER_ +req_VIA_User2/] + Output2 --> End1([DIALOGUE_ +ESTABLISHED]) + + Decision2 -- "(FALSE)" --> End1 + + Decision1 -- "(FALSE)" --> Conn2((2)) + Conn2 --> Task2[Set_MAP_Provider_ +Abort_Reason: +Abnormal_Dialogue] + Task2 --> Output3[/MAP_P_ABORT_ +ind_VIA_User2/] + Output3 --> Task3[Set_Abort_Reason_ +User_Specific] + Task3 --> Task4[Set_User_Information: +MAP_Provider_ +Abort_Info] + Task4 --- Comment2[MAP_Provider_ +Abort_Reason:= +Abnormal_Dialogue] + Task4 --> Output4[/TC_U_ABORT_ +req_VIA_TC1/] + Output4 --> Output5[/Terminated_ +VIA_Intern2/] + Output5 --- Comment3[To all active +RSSMs] + Output5 --> End2([IDLE]) + +``` + +SDL process diagram for MAP\_DSM showing the flow from DIALOGUE\_INITIATED to either DIALOGUE\_ESTABLISHED or IDLE based on AC\_Name\_Unchanged and Components\_Present decisions. + +9451 + +9452 + +Figure 15.6/3h: Process MAP\_DSM (sheet 8) + +Process MAP\_DSM + +MAP\_DSM9(17) + +Process to manage a MAP dialogue + +![Flowchart for Process MAP_DSM starting from IDLE state, through TC_BEGIN_ind, AC_included, AC_Vession, MAP_Dialogue_PDU included, Extract_User_Information, MAP-OPEN dialogue PDU?, User_Info required for AC?, Invalid Parameter?, Check_Load_VIA_Load1, TC_U_ABORT req_VIA_TC1, and ending in various states like WAIT_FOR_LOAD_CHECK_RESULT1, IDLE, and WAIT_FOR_INIT_DATA.](ca2740c55eeb32272b09a48cdfb7ee4d_img.jpg) + +``` + +graph TD + IDLE1([IDLE]) --> TC_BEGIN_ind[/TC_BEGIN_ind/] + TC_BEGIN_ind --> AC_included{AC_included} + AC_included -- (FALSE) --> Components_Present{Components_Present} + AC_included -- (TRUE) --> AC_Vession{AC_Vession = 1} + AC_Vession -- (FALSE) --> MAP_Dialogue_PDU_included{MAP_Dialogue_PDU_included} + AC_Vession -- (TRUE) --> Components_Present + MAP_Dialogue_PDU_included -- (FALSE) --> User_Info_required{User_Info required for AC?} + MAP_Dialogue_PDU_included -- (TRUE) --> Extract_User_Information[Extract_User_Information] + Extract_User_Information --> MAP_OPEN_dialogue_PDU{MAP-OPEN dialogue PDU?} + MAP_OPEN_dialogue_PDU -- No --> Junction(( )) + MAP_OPEN_dialogue_PDU -- Yes --> Invalid_Parameter{Invalid Parameter?} + Invalid_Parameter -- No --> Check_Load_VIA_Load1[/Check_Load_VIA_Load1/] + Invalid_Parameter -- Yes --> Junction + User_Info_required -- Yes --> Connector3((3)) + User_Info_required -- No --> Junction + Components_Present -- (FALSE) --> TC_U_ABORT_req_VIA_TC1[/TC_U_ABORT req_VIA_TC1/] + Components_Present -- (TRUE) --> WAIT_FOR_INIT_DATA([WAIT_FOR_INIT_DATA]) + TC_U_ABORT_req_VIA_TC1 --> IDLE2([IDLE]) + Check_Load_VIA_Load1 --> WAIT_FOR_LOAD_CHECK_RESULT1([WAIT_FOR_LOAD_CHECK_RESULT1]) + Junction --> Connector3 + +``` + +Flowchart for Process MAP\_DSM starting from IDLE state, through TC\_BEGIN\_ind, AC\_included, AC\_Vession, MAP\_Dialogue\_PDU included, Extract\_User\_Information, MAP-OPEN dialogue PDU?, User\_Info required for AC?, Invalid Parameter?, Check\_Load\_VIA\_Load1, TC\_U\_ABORT req\_VIA\_TC1, and ending in various states like WAIT\_FOR\_LOAD\_CHECK\_RESULT1, IDLE, and WAIT\_FOR\_INIT\_DATA. + +9453 + +9454 + +Figure 15.6/3i: Process MAP\_DSM (sheet 9) + +# Process MAP\_DSM + +MAP\_DSM10(17) + +Process to manage a MAP dialogue + +![Flowchart for Process MAP_DSM](07ccb21f70641797dd02a891ced72b7e_img.jpg) + +``` +graph TD; Start((3)) --> Step1[Set_MAP_Provider_ Abort_Reason: Abnormal_Dialogue]; Step1 --> Step2[Set_User_Info: MAP_Provider_ Abort_Info]; Step2 --> Step3[Set_Abort_Reason: User_Specific]; Step3 --> Decision{TC_U_ABORT req_VIA_TC1}; Decision --> End([IDLE]); +``` + +The flowchart illustrates the process for managing a MAP dialogue. It begins with a start node labeled '3'. The first step is 'Set\_MAP\_Provider\_ Abort\_Reason: Abnormal\_Dialogue'. This is followed by 'Set\_User\_Info: MAP\_Provider\_ Abort\_Info'. The next step is 'Set\_Abort\_Reason: User\_Specific'. A decision node follows, labeled 'TC\_U\_ABORT req\_VIA\_TC1'. The final state is 'IDLE'. + +Flowchart for Process MAP\_DSM + +9455 + +9456 + +Figure 15.6/3j: Process MAP\_DSM (sheet 10) + +# Process MAP\_DSM + +MAP\_DSM11(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It shows two main state machines. The left one starts at WAIT_FOR_INIT_DATA and transitions based on TC_INVOKE_ind, TC_L_REJECT_ind, or Any_OTHER_ind. The right one starts at WAIT_FOR_LOAD_CHECK_RESULT2 and transitions based on Load_OK or Overload. Both lead to IDLE states.](e4b6ed98fad76b79cb9f85783e13086a_img.jpg) + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_INIT_DATA + WAIT_FOR_INIT_DATA --> TC_INVOKE_ind {Op_Code} + WAIT_FOR_INIT_DATA --> TC_L_REJECT_ind + WAIT_FOR_INIT_DATA --> Any_OTHER_ind + TC_INVOKE_ind --> Operation_Exists {Operation_Exists} + Operation_Exists -- (TRUE) --> Derive_V1_AC + Derive_V1_AC --> Check_Load_VIA_Load1 + Check_Load_VIA_Load1 --> WAIT_FOR_LOAD_CHECK_RESULT2 + Operation_Exists -- (FALSE) --> Any_OTHER_ind + TC_L_REJECT_ind --> Any_OTHER_ind + Any_OTHER_ind --> TC_U_ABORT_req_VIA_TC1 + TC_U_ABORT_req_VIA_TC1 --> IDLE + + [*] --> WAIT_FOR_LOAD_CHECK_RESULT2 + WAIT_FOR_LOAD_CHECK_RESULT2 --> Load_OK + WAIT_FOR_LOAD_CHECK_RESULT2 --> Overload + Overload --> IDLE + Load_OK --> Op_Code {Op_Code} + Op_Code -- ELSE --> begin_subscriber_activity + Op_Code -- begin_subscriber_activity --> Last_Component {Last_Component} + Last_Component -- (TRUE) --> TC_U_ABORT_req_VIA_TC1 + Last_Component -- (FALSE) --> Build_MAP_OPEN_ind_Primitive + TC_U_ABORT_req_VIA_TC1 --> IDLE + Build_MAP_OPEN_ind_Primitive --> MAP_OPEN_ind_VIA_User2 + MAP_OPEN_ind_VIA_User2 --> Perform_version_1_protocol + Perform_version_1_protocol --> IDLE + +``` + +State transition diagram for Process MAP\_DSM. It shows two main state machines. The left one starts at WAIT\_FOR\_INIT\_DATA and transitions based on TC\_INVOKE\_ind, TC\_L\_REJECT\_ind, or Any\_OTHER\_ind. The right one starts at WAIT\_FOR\_LOAD\_CHECK\_RESULT2 and transitions based on Load\_OK or Overload. Both lead to IDLE states. + +9457 + +9458 + +Figure 15.6/3k: Process MAP\_DSM (sheet 11) + +Process MAP\_DSM + +MAP\_DSM12(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts with WAIT_FOR_LOAD_CHECK_RESULT1, leading to Load_OK and Overload. Overload leads to IDLE. Load_OK leads to AC_Supported decision. AC_Supported (TRUE) leads to AC_Name:= Received_AC_Name, then Set_User_Data, then MAP_OPEN_ind_VIA_User2. AC_Supported (FALSE) leads to Alternative_Name_Exists decision. Alternative_Name_Exists (TRUE) leads to AC_Name:= Alternative_AC_Name, then TC_U_ABORT_req_VIA_TC1, then IDLE. Alternative_Name_Exists (FALSE) leads to AC_Name:= Received_AC_Name, then MAP_OPEN_ind_VIA_User2. MAP_OPEN_ind_VIA_User2 leads to Components_Present decision. Components_Present (TRUE) leads to Process_Components, then MAP_DELIMITER_ind_VIA_User2, then DIALOGUE_PENDING. Components_Present (FALSE) leads to MAP_DELIMITER_ind_VIA_User2.](9997ce2599510a8912ccac15865ae602_img.jpg) + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_LOAD_CHECK_RESULT1 + WAIT_FOR_LOAD_CHECK_RESULT1 --> Load_OK + WAIT_FOR_LOAD_CHECK_RESULT1 --> Overload + Overload --> IDLE + Load_OK --> AC_Supported + AC_Supported --> AC_Name_1[AC_Name:= Received_AC_Name] : (TRUE) + AC_Supported --> Alternative_Name_Exists : (FALSE) + AC_Name_1 --> Set_User_Data + Set_User_Data --> MAP_OPEN_ind_VIA_User2 + Alternative_Name_Exists --> AC_Name_2[AC_Name:= Received_AC_Name] : (FALSE) + Alternative_Name_Exists --> AC_Name_3[AC_Name:= Alternative_AC_Name] : (TRUE) + AC_Name_2 --> MAP_OPEN_ind_VIA_User2 + AC_Name_3 --> TC_U_ABORT_req_VIA_TC1 + TC_U_ABORT_req_VIA_TC1 --> IDLE + MAP_OPEN_ind_VIA_User2 --> Components_Present + Components_Present --> Process_Components : (TRUE) + Components_Present --> MAP_DELIMITER_ind_VIA_User2 : (FALSE) + Process_Components --> MAP_DELIMITER_ind_VIA_User2 + MAP_DELIMITER_ind_VIA_User2 --> DIALOGUE_PENDING + +``` + +State transition diagram for Process MAP\_DSM. It starts with WAIT\_FOR\_LOAD\_CHECK\_RESULT1, leading to Load\_OK and Overload. Overload leads to IDLE. Load\_OK leads to AC\_Supported decision. AC\_Supported (TRUE) leads to AC\_Name:= Received\_AC\_Name, then Set\_User\_Data, then MAP\_OPEN\_ind\_VIA\_User2. AC\_Supported (FALSE) leads to Alternative\_Name\_Exists decision. Alternative\_Name\_Exists (TRUE) leads to AC\_Name:= Alternative\_AC\_Name, then TC\_U\_ABORT\_req\_VIA\_TC1, then IDLE. Alternative\_Name\_Exists (FALSE) leads to AC\_Name:= Received\_AC\_Name, then MAP\_OPEN\_ind\_VIA\_User2. MAP\_OPEN\_ind\_VIA\_User2 leads to Components\_Present decision. Components\_Present (TRUE) leads to Process\_Components, then MAP\_DELIMITER\_ind\_VIA\_User2, then DIALOGUE\_PENDING. Components\_Present (FALSE) leads to MAP\_DELIMITER\_ind\_VIA\_User2. + +9459 + +9460 + +Figure 15.6/31: Process MAP\_DSM (sheet 12) + +Process MAP\_DSM + +MAP\_DSM13(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_PENDING, branches into MAP_OPEN_rsp and MAP_U_ABORT_req. MAP_OPEN_rsp leads to a Result decision (Accepted to DIALOGUE_ACCEPTED, Refused to Set_Abort_Reason). MAP_U_ABORT_req leads to Set_Abort_Reason and Set_User_Info, then to TC_U_ABORT_req_VIA_TC1. Both paths lead to Terminated_VIA_Intern1 and then to IDLE.](d1aa8db844a6bb8519d74e48d1cf5343_img.jpg) + +``` +stateDiagram-v2 + [*] --> DIALOGUE_PENDING + DIALOGUE_PENDING --> MAP_OPEN_rsp + DIALOGUE_PENDING --> MAP_U_ABORT_req + MAP_OPEN_rsp --> Result + Result -- Accepted --> DIALOGUE_ACCEPTED + Result -- Refused --> Set_Abort_Reason_1[Set_Abort_Reason: User_Specific] + MAP_U_ABORT_req --> Set_Abort_Reason_2[Set_Abort_Reason: User_Specific] + Set_Abort_Reason_2 --> Set_User_Info[Set_User_Info: MAP_User_Abort_Info] + Set_Abort_Reason_1 --> Build_MAP_Refuse_PDU[Build_MAP_Refuse_PDU] + Set_User_Info --> TC_U_ABORT_req_VIA_TC1{TC_U_ABORT_req_VIA_TC1} + Build_MAP_Refuse_PDU --> TC_U_ABORT_req_VIA_TC1 + TC_U_ABORT_req_VIA_TC1 --> Terminated_VIA_Intern1[Terminated_VIA_Intern1] + Terminated_VIA_Intern1 --> IDLE + Terminated_VIA_Intern1 -- To all active PSSMs +``` + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_PENDING, branches into MAP\_OPEN\_rsp and MAP\_U\_ABORT\_req. MAP\_OPEN\_rsp leads to a Result decision (Accepted to DIALOGUE\_ACCEPTED, Refused to Set\_Abort\_Reason). MAP\_U\_ABORT\_req leads to Set\_Abort\_Reason and Set\_User\_Info, then to TC\_U\_ABORT\_req\_VIA\_TC1. Both paths lead to Terminated\_VIA\_Intern1 and then to IDLE. + +9461 + +9462 + +Figure 15.6/3m: Process MAP\_DSM (sheet 13) + +Process MAP\_DSM + +MAP\_DSM14(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. It starts at DIALOGUE_ACCEPTED and branches into three paths: MAP_req (leading to Requesting_MAP_SSM, Service_Invoked_VIA_Intern2, and then DIALOGUE_ACCEPTED), MAP_rsp (leading to Response_Issued_VIA_Intern1 and then DIALOGUE_ACCEPTED), and MAP_DELIMITER_req (leading to TC_CONTINUE_req_VIA_TC1 and then DIALOGUE_ESTABLISHED). From the second DIALOGUE_ACCEPTED state, it branches into MAP_CLOSE_req (leading to TC_END_req_VIA_TC1) and MAP_U_ABORT_req (leading to Set_Abort_Reason: User_Specific, User_Info:= MAP-UserAbortInfo, and then TC_U_ABORT_req_VIA_TC1). Both TC_END_req_VIA_TC1 and TC_U_ABORT_req_VIA_TC1 lead to a common path of Terminated_VIA_Intern1 (To all active PSSMs) and Terminated_VIA_Intern2 (To all active RSSMs), which finally leads to the IDLE state.](d33209b2cda1d21b3db2a2b0382a4c05_img.jpg) + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_ACCEPTED + DIALOGUE_ACCEPTED --> MAP_req + DIALOGUE_ACCEPTED --> MAP_rsp + DIALOGUE_ACCEPTED --> MAP_DELIMITER_req + MAP_req --> Requesting_MAP_SSM + Requesting_MAP_SSM --> Service_Invoked_VIA_Intern2 + Service_Invoked_VIA_Intern2 --> DIALOGUE_ACCEPTED + MAP_rsp --> Response_Issued_VIA_Intern1 + Response_Issued_VIA_Intern1 --> DIALOGUE_ACCEPTED + MAP_DELIMITER_req --> TC_CONTINUE_req_VIA_TC1 + TC_CONTINUE_req_VIA_TC1 --> DIALOGUE_ESTABLISHED + DIALOGUE_ESTABLISHED --> DIALOGUE_ACCEPTED + DIALOGUE_ACCEPTED --> MAP_CLOSE_req + DIALOGUE_ACCEPTED --> MAP_U_ABORT_req + MAP_CLOSE_req --> TC_END_req_VIA_TC1 + MAP_U_ABORT_req --> Set_Abort_Reason: User_Specific + Set_Abort_Reason: User_Specific --> User_Info:= MAP-UserAbortInfo + User_Info:= MAP-UserAbortInfo --> TC_U_ABORT_req_VIA_TC1 + TC_END_req_VIA_TC1 --> Terminated_VIA_Intern1 + TC_U_ABORT_req_VIA_TC1 --> Terminated_VIA_Intern1 + Terminated_VIA_Intern1 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> IDLE + Terminated_VIA_Intern1 --> To_all_active_PSSMs + Terminated_VIA_Intern2 --> To_all_active_RSSMs + +``` + +State transition diagram for Process MAP\_DSM. It starts at DIALOGUE\_ACCEPTED and branches into three paths: MAP\_req (leading to Requesting\_MAP\_SSM, Service\_Invoked\_VIA\_Intern2, and then DIALOGUE\_ACCEPTED), MAP\_rsp (leading to Response\_Issued\_VIA\_Intern1 and then DIALOGUE\_ACCEPTED), and MAP\_DELIMITER\_req (leading to TC\_CONTINUE\_req\_VIA\_TC1 and then DIALOGUE\_ESTABLISHED). From the second DIALOGUE\_ACCEPTED state, it branches into MAP\_CLOSE\_req (leading to TC\_END\_req\_VIA\_TC1) and MAP\_U\_ABORT\_req (leading to Set\_Abort\_Reason: User\_Specific, User\_Info:= MAP-UserAbortInfo, and then TC\_U\_ABORT\_req\_VIA\_TC1). Both TC\_END\_req\_VIA\_TC1 and TC\_U\_ABORT\_req\_VIA\_TC1 lead to a common path of Terminated\_VIA\_Intern1 (To all active PSSMs) and Terminated\_VIA\_Intern2 (To all active RSSMs), which finally leads to the IDLE state. + +9463 + +9464 + +Figure 15.6/3n: Process MAP\_DSM (sheet 14) + +Process MAP\_DSM + +MAP\_DSM15(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM. The diagram shows two main sections. The top section starts with DIALOGUE_ESTABLISHED and branches into MAP_req (leading to Requesting_MAP_SSM and Service_Invoked_VIA_Intern2), MAP_rsp (leading to Response_Issued_VIA_Intern1), and MAP_DELIMITER_req (leading to TC_CONTINUE_req_VIA_TC1). These paths merge into another DIALOGUE_ESTABLISHED state. The bottom section starts with DIALOGUE_ESTABLISHED and branches into TC_L_CANCEL_ind (leading to Invoke_ID_Active decision), TC_NOTICE_ind (leading to MAP_NOTICE_ind_VIA_User2), and TC_CONTINUE_ind (leading to Components_Present decision). The Invoke_ID_Active decision has (TRUE) leading to Timer_Expiry_VIA_Intern2 and (FALSE) leading to And SSM active. The Components_Present decision has (TRUE) leading to Process_Components and MAP_DELIMITER_ind_VIA_User2, and (FALSE) leading to the final merge. All paths merge into a final DIALOGUE_ESTABLISHED state.](69e2cabe4d7ea5d5fb8f98661cacdda3_img.jpg) + +``` + +stateDiagram-v2 + [*] --> DIALOGUE_ESTABLISHED_1 : DIALOGUE_ESTABLISHED + DIALOGUE_ESTABLISHED_1 --> MAP_req + DIALOGUE_ESTABLISHED_1 --> MAP_rsp + DIALOGUE_ESTABLISHED_1 --> MAP_DELIMITER_req + MAP_req --> Requesting_MAP_SSM + Requesting_MAP_SSM --> Service_Invoked_VIA_Intern2 + MAP_rsp --> Response_Issued_VIA_Intern1 + MAP_DELIMITER_req --> TC_CONTINUE_req_VIA_TC1 + Service_Invoked_VIA_Intern2 --> Merge1 + Response_Issued_VIA_Intern1 --> Merge1 + TC_CONTINUE_req_VIA_TC1 --> Merge1 + Merge1 --> DIALOGUE_ESTABLISHED_2 : DIALOGUE_ESTABLISHED + DIALOGUE_ESTABLISHED_2 --> TC_L_CANCEL_ind + DIALOGUE_ESTABLISHED_2 --> TC_NOTICE_ind + DIALOGUE_ESTABLISHED_2 --> TC_CONTINUE_ind + TC_L_CANCEL_ind --> Invoke_ID_Active + Invoke_ID_Active --> Timer_Expiry_VIA_Intern2 : (TRUE) + Invoke_ID_Active --> And_SSM_active : (FALSE) + TC_NOTICE_ind --> MAP_NOTICE_ind_VIA_User2 + TC_CONTINUE_ind --> Components_Present + Components_Present --> Process_Components : (TRUE) + Components_Present --> Merge2 : (FALSE) + Process_Components --> MAP_DELIMITER_ind_VIA_User2 + Timer_Expiry_VIA_Intern2 --> Merge2 + MAP_NOTICE_ind_VIA_User2 --> Merge2 + MAP_DELIMITER_ind_VIA_User2 --> Merge2 + Merge2 --> DIALOGUE_ESTABLISHED_3 : DIALOGUE_ESTABLISHED + +``` + +State transition diagram for Process MAP\_DSM. The diagram shows two main sections. The top section starts with DIALOGUE\_ESTABLISHED and branches into MAP\_req (leading to Requesting\_MAP\_SSM and Service\_Invoked\_VIA\_Intern2), MAP\_rsp (leading to Response\_Issued\_VIA\_Intern1), and MAP\_DELIMITER\_req (leading to TC\_CONTINUE\_req\_VIA\_TC1). These paths merge into another DIALOGUE\_ESTABLISHED state. The bottom section starts with DIALOGUE\_ESTABLISHED and branches into TC\_L\_CANCEL\_ind (leading to Invoke\_ID\_Active decision), TC\_NOTICE\_ind (leading to MAP\_NOTICE\_ind\_VIA\_User2), and TC\_CONTINUE\_ind (leading to Components\_Present decision). The Invoke\_ID\_Active decision has (TRUE) leading to Timer\_Expiry\_VIA\_Intern2 and (FALSE) leading to And SSM active. The Components\_Present decision has (TRUE) leading to Process\_Components and MAP\_DELIMITER\_ind\_VIA\_User2, and (FALSE) leading to the final merge. All paths merge into a final DIALOGUE\_ESTABLISHED state. + +9465 + +9466 + +Figure 15.6/30: Process MAP\_DSM (sheet 15) + +# Process MAP\_DSM + +MAP\_DSM16(17) + +Process to manage a MAP dialogue + +![State transition diagram for Process MAP_DSM](b10773c5223053f543c2f978197d4882_img.jpg) + +``` +stateDiagram-v2 + [*] --> DIALOGUE_ESTABLISHED + DIALOGUE_ESTABLISHED --> TC_END_ind + DIALOGUE_ESTABLISHED --> MAP_CLOSE_req + TC_END_ind --> Components_Present + Components_Present --> Process_Components : (TRUE) + Components_Present --> MAP_CLOSE_ind_VIA_User2 : (FALSE) + Process_Components --> MAP_CLOSE_ind_VIA_User2 + MAP_CLOSE_req --> TC_END_req_VIA_TC1 + TC_END_req_VIA_TC1 --> MAP_CLOSE_ind_VIA_User2 + MAP_CLOSE_ind_VIA_User2 --> Terminated_VIA_Intern1 + Terminated_VIA_Intern1 --> To_all_active_PSSMs + Terminated_VIA_Intern1 --> Terminated_VIA_Intern2 + Terminated_VIA_Intern2 --> To_all_active_RSSMs + Terminated_VIA_Intern2 --> IDLE +``` + +The diagram illustrates the state transitions for the Process MAP\_DSM. It begins with an initial state leading to **DIALOGUE\_ESTABLISHED**. From this state, two transitions are possible: **TC\_END\_ind** and **MAP\_CLOSE\_req**. The **TC\_END\_ind** transition leads to a decision diamond **Components\_Present**. If **(TRUE)**, it leads to **Process\_Components**, which then leads to **MAP\_CLOSE\_ind\_VIA\_User2**. If **(FALSE)**, it leads directly to **MAP\_CLOSE\_ind\_VIA\_User2**. The **MAP\_CLOSE\_req** transition leads to **TC\_END\_req\_VIA\_TC1**, which then leads to **MAP\_CLOSE\_ind\_VIA\_User2**. From **MAP\_CLOSE\_ind\_VIA\_User2**, the process proceeds to **Terminated\_VIA\_Intern1**, which then leads to **To\_all\_active\_PSSMs**. This is followed by **Terminated\_VIA\_Intern2**, which leads to **To\_all\_active\_RSSMs** and finally to the **IDLE** state. + +State transition diagram for Process MAP\_DSM + +9467 + +9468 + +Figure 15.6/3p: Process MAP\_DSM (sheet 16) + +## Process MAP\_DSM + +MAP\_DSM17(17) + +![SDL process diagram for MAP_DSM showing abort procedures from DIALOGUE ESTABLISHED to IDLE state.](c9e3572a1d0a3fd946db179079f95fcb_img.jpg) + +Process to manage +a MAP dialogue + +``` + +stateDiagram-v2 + state "DIALOGUE\nESTABLISHED" as DE + state "IDLE" as IDLE + state "User_Info" as UI <> + + [*] --> DE + DE --> TC_U_ABORT_ind + DE --> TC_P_ABORT_ind + DE --> MAP_U_ABORT_req + + TC_U_ABORT_ind --> UI + UI --> MAP_U_ABORT_ind_VIA_User2 : User_Abort_PDU + UI --> MAP_P_ABORT_ind_VIA_User2 : Provider_Abort_PDU + + TC_P_ABORT_ind --> MAP_P_ABORT_ind_VIA_User2 + + MAP_U_ABORT_req --> Set_Abort_Reason + note right of Set_Abort_Reason : User_Specific + Set_Abort_Reason --> Set_User_Info + note right of Set_User_Info : MAP_User_Abort_Info + Set_User_Info --> TC_U_ABORT_req_VIA_TC1 + + MAP_U_ABORT_ind_VIA_User2 --> Terminated_VIA_Intern1 + MAP_P_ABORT_ind_VIA_User2 --> Terminated_VIA_Intern1 + TC_U_ABORT_req_VIA_TC1 --> Terminated_VIA_Intern1 + + Terminated_VIA_Intern1 --> Terminated_VIA_Intern2 + note right of Terminated_VIA_Intern1 : To all active PSSMs + Terminated_VIA_Intern2 --> IDLE + note right of Terminated_VIA_Intern2 : To all active RSSMs + +``` + +SDL process diagram for MAP\_DSM showing abort procedures from DIALOGUE ESTABLISHED to IDLE state. + +9469 + +9470 + +**Figure 15.6/3q: Process MAP\_DSM (sheet 17)** + +9471 + +![Flowchart for Procedure Process_Components. It starts with a connector, followed by WAIT_FOR_COMPONENTS, TC_INVOKE_ind(Op_Code), and a decision diamond 'Invoke_ID_Assigned'. The flow branches based on (TRUE) and (FALSE) paths, leading to various processing steps like 'Set_Problem_Code: Duplicated_Invoke_ID', 'TC_U_REJECT_req_VIA_TC1', 'Set_Diagnostic: Abnormal_Event_Received_From_Peer', 'MAP_NOTICE_ind_VIA_User2', and 'Last_Component' decision. It ends with a connector and another WAIT_FOR_COMPONENTS block.](945bdd5b440b3ed5bc0fcf1ac3b7d5b4_img.jpg) + +### Procedure Process\_Components + +Proc\_Comp1(5) + +Procedure to process components received in a TC message + +Comment: 'Components from TCAP' +DCL +Op\_Code, Operation\_Class INTEGER; +Operation\_Exists, Last\_Component, Invoke\_ID\_Present, Invoke\_ID\_Assigned, Linked\_ID\_Present, Linked\_ID\_Assigned, Linked\_Operation\_Allowed, v3\_Or\_Higher\_Dialogue BOOLEAN; + +``` +graph TD; Start([ ]) --> WFC1(WAIT_FOR_COMPONENTS); WFC1 --> TC_INVOKE[TC_INVOKE_ind(Op_Code)]; TC_INVOKE --> D1{Invoke_ID_Assigned}; D1 -- (FALSE) --> D1_False[ ]; D1 -- (TRUE) --> D2{Operation_Exists}; D2 -- (TRUE) --> D3{Linked_ID_Present}; D2 -- (FALSE) --> Set_Problem_Code_1[Set_Problem_Code: Unrecognised_Operation]; Set_Problem_Code_1 --> TC_U_REJECT_1[TC_U_REJECT_req_VIA_TC1]; D3 -- (TRUE) --> Connector1((1)); D3 -- (FALSE) --> Performing_MAP_SSM[Performing_MAP_SSM]; Performing_MAP_SSM --> Service_Invocation[Service_Invocation_Received_VIA_Intern1]; TC_U_REJECT_1 --> D4{v3_Or_Higher_Dialogue}; D4 -- (TRUE) --> D5{Last_Component}; D4 -- (FALSE) --> Set_Diagnostic[Set_Diagnostic: Abnormal_Event_Received_From_Peer]; Set_Diagnostic --> MAP_NOTICE[MAP_NOTICE_ind_VIA_User2]; MAP_NOTICE --> D5; D5 -- (TRUE) --> Connector2(( )); D5 -- (FALSE) --> WFC2(WAIT_FOR_COMPONENTS); +``` + +Flowchart for Procedure Process\_Components. It starts with a connector, followed by WAIT\_FOR\_COMPONENTS, TC\_INVOKE\_ind(Op\_Code), and a decision diamond 'Invoke\_ID\_Assigned'. The flow branches based on (TRUE) and (FALSE) paths, leading to various processing steps like 'Set\_Problem\_Code: Duplicated\_Invoke\_ID', 'TC\_U\_REJECT\_req\_VIA\_TC1', 'Set\_Diagnostic: Abnormal\_Event\_Received\_From\_Peer', 'MAP\_NOTICE\_ind\_VIA\_User2', and 'Last\_Component' decision. It ends with a connector and another WAIT\_FOR\_COMPONENTS block. + +9472 + +9473 + +Figure 15.6/4a: Procedure Process\_Components (sheet 1) + +Procedure Process\_Components + +Proc\_Comp2(5) + +Procedure to process components received in a TC message + +![Flowchart for Procedure Process_Components. It starts at connector '1', goes to decision 'Linked_ID_Assigned'. If (FALSE), it goes to 'Set_Problem_Code: Linked_ID_Not Assigned' then 'TC_U_REJECT_req_VIA_TC1'. If (TRUE), it goes to decision 'Operation_Class'. 'Operation_Class' has branches (1,2,3) leading to 'Linked_Service_Invoked_VIA_Intern2' and (4) leading to 'Linked_Request_Received_VIA_Intern2'. Both branches lead to 'Performing_MAP_SSM'. From 'Performing_MAP_SSM', it goes to 'Service_Invocation_Received_VIA_Intern1'. Both 'MAP_NOTICE_ind_VIA_User2' (from TC_U_REJECT) and 'Service_Invocation_Received_VIA_Intern1' lead to decision 'Last_Component'. If (TRUE), it ends at a circle with an X. If (FALSE), it goes to 'WAIT_FOR_COMPONENTS' and loops back to the start of the 'Operation_Class' decision.](1ef5623b9afe103c2e5bb1e19977dcd4_img.jpg) + +Flowchart for Procedure Process\_Components. It starts at connector '1', goes to decision 'Linked\_ID\_Assigned'. If (FALSE), it goes to 'Set\_Problem\_Code: Linked\_ID\_Not Assigned' then 'TC\_U\_REJECT\_req\_VIA\_TC1'. If (TRUE), it goes to decision 'Operation\_Class'. 'Operation\_Class' has branches (1,2,3) leading to 'Linked\_Service\_Invoked\_VIA\_Intern2' and (4) leading to 'Linked\_Request\_Received\_VIA\_Intern2'. Both branches lead to 'Performing\_MAP\_SSM'. From 'Performing\_MAP\_SSM', it goes to 'Service\_Invocation\_Received\_VIA\_Intern1'. Both 'MAP\_NOTICE\_ind\_VIA\_User2' (from TC\_U\_REJECT) and 'Service\_Invocation\_Received\_VIA\_Intern1' lead to decision 'Last\_Component'. If (TRUE), it ends at a circle with an X. If (FALSE), it goes to 'WAIT\_FOR\_COMPONENTS' and loops back to the start of the 'Operation\_Class' decision. + +9474 + +9475 + +Figure 15.6/4b: Procedure Process\_Components (sheet 2) + +Procedure Process\_Components + +Proc\_Comp3(5) + +Procedure to process components received in a TC message + +![Flowchart for Procedure Process_Components. It starts with WAIT_FOR_COMPONENTS, branches into TC_RESULT_L_ind, TC_RESULT_NL_ind, and TC_U_ERROR_ind. Each branch has an Invoke_ID_Assigned decision. TC_RESULT_L_ind and TC_RESULT_NL_ind lead to connectors '2' on FALSE and result messages on TRUE. TC_U_ERROR_ind leads to connector '2' on FALSE and a series of error handling steps on TRUE. All result messages lead to a Last_Component decision. If FALSE, it loops back to WAIT_FOR_COMPONENTS. If TRUE, it ends at a connector with an 'X'.](4391cd8ac8f58d1b46439ea0cb130782_img.jpg) + +``` + +graph TD + Start([WAIT_FOR_COMPONENTS]) --> TC_RESULT_L_ind[/TC_RESULT_L_ind/] + Start --> TC_RESULT_NL_ind[/TC_RESULT_NL_ind/] + Start --> TC_U_ERROR_ind[/TC_U_ERROR_ind/] + + TC_RESULT_L_ind --> Invoke_ID_Assigned_L{Invoke_ID_Assigned} + Invoke_ID_Assigned_L -- (FALSE) --> C2_L((2)) + Invoke_ID_Assigned_L -- (TRUE) --> Result_Received_VIA_Intern2[/Result_Received_VIA_Intern2/] + + TC_RESULT_NL_ind --> Invoke_ID_Assigned_NL{Invoke_ID_Assigned} + Invoke_ID_Assigned_NL -- (FALSE) --> C2_NL((2)) + Invoke_ID_Assigned_NL -- (TRUE) --> Partial_Result_Received_VIA_Intern2[/Partial_Result_Received_VIA_Intern2/] + + TC_U_ERROR_ind --> Invoke_ID_Assigned_U{Invoke_ID_Assigned} + Invoke_ID_Assigned_U -- (FALSE) --> C2_U((2)) + Invoke_ID_Assigned_U -- (TRUE) --> Set_Problem_Code[Set_Problem_Code: +Invoke_ID +Not Assigned] + Set_Problem_Code --> TC_U_REJECT_req_VIA_TC1[/TC_U_REJECT_req_VIA_TC1/] + TC_U_REJECT_req_VIA_TC1 --> Set_Diagnostic[Set_Diagnostic: +Abnormal_Event_Received +From Peer] + Set_Diagnostic --> MAP_NOTICE_ind_VIA_User2[/MAP_NOTICE_ind_VIA_User2/] + + Result_Received_VIA_Intern2 --> Last_Component{Last_Component} + Partial_Result_Received_VIA_Intern2 --> Last_Component + Negative_Result_Received_VIA_Intern2[/Negative_Result_Received_VIA_Intern2/] --> Last_Component + MAP_NOTICE_ind_VIA_User2 --> Last_Component + + Last_Component -- (FALSE) --> Start + Last_Component -- (TRUE) --> End((X)) + +``` + +Flowchart for Procedure Process\_Components. It starts with WAIT\_FOR\_COMPONENTS, branches into TC\_RESULT\_L\_ind, TC\_RESULT\_NL\_ind, and TC\_U\_ERROR\_ind. Each branch has an Invoke\_ID\_Assigned decision. TC\_RESULT\_L\_ind and TC\_RESULT\_NL\_ind lead to connectors '2' on FALSE and result messages on TRUE. TC\_U\_ERROR\_ind leads to connector '2' on FALSE and a series of error handling steps on TRUE. All result messages lead to a Last\_Component decision. If FALSE, it loops back to WAIT\_FOR\_COMPONENTS. If TRUE, it ends at a connector with an 'X'. + +9476 + +9477 + +Figure 15.6/4c: Procedure Process\_Components (sheet 3) + +# Procedure Process\_Components + +Proc\_Comp4(5) + +Procedure to process components received in a TC message + +![Flowchart for Procedure Process_Components. It starts with WAIT_FOR_COMPONENTS, branches into TC_L_REJECT_ind and TC_R_REJECT_ind paths, includes decision diamonds for Invoke_ID_Present, Problem Type, and Invoke_ID_Assigned, and ends with a Last_Component decision leading to either an end symbol or back to WAIT_FOR_COMPONENTS.](a4dfbebcb37369374ba8d65c7a9bd887_img.jpg) + +``` + +graph TD + Start([WAIT_FOR_COMPONENTS]) --> TC_L[TC_L_REJECT_ind] + Start --> TC_R[TC_R_REJECT_ind] + + TC_L --> L1{Invoke_ID_Present} + L1 -- (FALSE) --> L4[MAP NOTICE_ind_VIA_User2] + L1 -- (TRUE) --> L2{Problem Type +rr_problem, re_problem, general_problem} + L2 -- invoke_problem --> L4 + + L2 --> L3{Invoke_ID_Assigned} + L3 -- (FALSE) --> L4 + L3 -- (TRUE) --> L5[Provider_Reject_Received_VIA_Intern2] + + TC_R --> R2{Problem Type +rr_problem, re_problem, general_problem} + R2 -- invoke_problem --> R4[MAP NOTICE_ind_VIA_User2] + + R2 --> R3{Invoke_ID_Assigned} + R3 -- (FALSE) --> R4 + R3 -- (TRUE) --> R5[Provider_Reject_Received_VIA_Intern2] + + L5 --> Join(( )) + L4 --> Join + R5 --> Join + R4 --> Join + + Join --> Last{Last_Component} + Last -- (TRUE) --> End((X)) + Last -- (FALSE) --> End([WAIT_FOR_COMPONENTS]) + +``` + +Flowchart for Procedure Process\_Components. It starts with WAIT\_FOR\_COMPONENTS, branches into TC\_L\_REJECT\_ind and TC\_R\_REJECT\_ind paths, includes decision diamonds for Invoke\_ID\_Present, Problem Type, and Invoke\_ID\_Assigned, and ends with a Last\_Component decision leading to either an end symbol or back to WAIT\_FOR\_COMPONENTS. + +9478 + +9479 + +Figure 15.6/4d: Procedure Process\_Components (sheet 4) + +Procedure Process\_Components + +Proc\_Comp5(5) + +Procedure to process components received in a TC message + +![Flowchart for Procedure Process_Components](5a0427b4033881484e387d85b8d8fa77_img.jpg) + +``` +graph TD; Start([WAIT_FOR_COMPONENTS]) --> TC_U[TC_U REJECT_ind]; Start --> Asterisk[/*/]; TC_U --> Problem_Type{Problem Type}; Problem_Type -- "rr_problem, re_problem" --> Asterisk; Problem_Type -- invoke_problem --> Invoke_ID{Invoke_ID Assigned}; Invoke_ID -- (FALSE) --> Asterisk; Invoke_ID -- (TRUE) --> User_Reject[User_Reject Received VIA_Intern2]; User_Reject --> Last_Component{Last Component}; MAP_NOTICE[MAP NOTICE_ind VIA_User2] --> Last_Component; Last_Component -- (FALSE) --> Asterisk; Last_Component -- (TRUE) --> End(( )); Last_Component -- (TRUE) --> End_Wait([WAIT_FOR_COMPONENTS]); +``` + +The flowchart illustrates the 'Process\_Components' procedure. It begins with a 'WAIT\_FOR\_COMPONENTS' state, leading to a 'TC\_U REJECT\_ind' input. From this input, the flow can lead to an asterisk symbol (representing an exit or continuation) or to a 'Problem Type' decision. The 'Problem Type' decision has two outputs: 'rr\_problem, re\_problem' which leads to the asterisk, and 'invoke\_problem' which leads to an 'Invoke\_ID Assigned' decision. The 'Invoke\_ID Assigned' decision has two outputs: '(FALSE)' which leads to the asterisk, and '(TRUE)' which leads to a 'User\_Reject Received VIA\_Intern2' output. Both the 'User\_Reject' output and a 'MAP NOTICE\_ind VIA\_User2' output lead to a 'Last Component' decision. The 'Last Component' decision has two outputs: '(FALSE)' which leads to the asterisk, and '(TRUE)' which leads to an end symbol (circle with an X) and a 'WAIT\_FOR\_COMPONENTS' state. + +Flowchart for Procedure Process\_Components + +9480 + +9481 + +Figure 15.6/4e: Procedure Process\_Components (sheet 5) + +Process Load\_Ctrl + +Load\_Ctrl1(1) + +Process to verify whether offered dialogue should be discarded because of overload + +Comment 'LOAD CONTROL'; +DCL +Congestion, Dialogue\_Acceptable BOOLEAN + +![Flowchart for Process Load_Ctrl showing logic for load control based on Congestion and Dialogue_Acceptable boolean flags.](fb4503cfc4abdcdf439a898cde5bab68_img.jpg) + +``` +graph TD; Start([ ]) --> IDLE1([IDLE]); IDLE1 --> CheckLoad{{Check_Load}}; CheckLoad --> Congestion{Congestion}; Congestion -- TRUE --> DialogueAcceptable{Dialogue_Acceptable}; Congestion -- FALSE --> LoadOK1{{Load_OK_VIA_Load2}}; DialogueAcceptable -- TRUE --> LoadOK2{{Load_OK_VIA_Load2}}; DialogueAcceptable -- FALSE --> Overload{{Overload_VIA_Load2}}; LoadOK1 --> IDLE2([IDLE]); LoadOK2 --> IDLE2; Overload --> IDLE2; +``` + +The flowchart illustrates the 'Process Load\_Ctrl' logic. It begins with an initial state leading to an 'IDLE' state. From 'IDLE', the process moves to a 'Check\_Load' step. A decision diamond 'Congestion' follows. If 'TRUE', it proceeds to another decision diamond 'Dialogue\_Acceptable'. If 'Dialogue\_Acceptable' is 'TRUE', it leads to a 'Load\_OK\_VIA\_Load2' state. If 'FALSE', it leads to an 'Overload\_VIA\_Load2' state. If 'Congestion' is 'FALSE', it leads directly to a 'Load\_OK\_VIA\_Load2' state. All three states ('Load\_OK\_VIA\_Load2', 'Overload\_VIA\_Load2', and the direct path) converge to a final 'IDLE' state. + +Flowchart for Process Load\_Ctrl showing logic for load control based on Congestion and Dialogue\_Acceptable boolean flags. + +9482 +9483 + +Figure 15.6/5: Process Load\_Ctrl + +# Process Requesting\_MAP\_SSM + +MAP\_RSSM1(4) + +Process to handle MAP service requests and the responses from the distant entity + +Comment 'Requesting MAP Service State Machine': +DCL +Argument\_Correct, Error\_Code\_Correct, Linked\_Request\_Defined, Syntax\_Correct, MAP\_initiated, +Unexpected\_Data, Implicit\_Cnf, Linked\_Operation\_Allowed, Wait\_For\_Cnf, Service\_Parameter\_Available BOOLEAN, +Operation\_Class INTEGER; + +![State transition diagram for Process Requesting_MAP_SSM](e5b4cfceaf317b48009d22b45b0c6340_img.jpg) + +``` +graph TD; Start([ ]) --> IDLE{{IDLE}}; IDLE --> Service_Invoked[/Service_Invoked/]; Service_Invoked -.-> Note1[A service has been invoked by the MAP user]; Service_Invoked --> Set_Operation[Set_Operation_Code_and_TCAP_Parameters]; Set_Operation --> TC_INVOKE{TC_INVOKE_req_VIA_TC4}; TC_INVOKE --> Wait_For_Cnf{Wait_For_Cnf}; Wait_For_Cnf -- TRUE --> WAIT_FOR_CONFIRM{{WAIT_FOR_CONFIRM}}; Wait_For_Cnf -- FALSE --> End((X)); +``` + +The diagram is a state transition diagram for the 'Process Requesting\_MAP\_SSM'. It begins with an oval connector symbol pointing down to a double-bordered oval state labeled 'IDLE'. From 'IDLE', a vertical line leads to a chevron-shaped transition symbol labeled 'Service\_Invoked'. To the right of this transition is a dashed box containing the text 'A service has been invoked by the MAP user'. Below the transition, a vertical line leads to a rectangular process symbol labeled 'Set\_Operation\_Code\_and\_TCAP\_Parameters'. Below this process, a vertical line leads to a diamond-shaped decision symbol labeled 'TC\_INVOKE\_req\_VIA\_TC4'. Below this decision, a vertical line leads to another diamond-shaped decision symbol labeled 'Wait\_For\_Cnf'. From 'Wait\_For\_Cnf', a vertical line labeled '(TRUE)' leads down to a double-bordered oval state labeled 'WAIT\_FOR\_CONFIRM'. A horizontal line labeled '(FALSE)' extends to the right from 'Wait\_For\_Cnf' and ends at a circle with an 'X' inside, representing an error or termination state. + +State transition diagram for Process Requesting\_MAP\_SSM + +9484 + +9485 + +Figure 15.6/6a: Process Requesting\_MAP\_SSM (sheet 1) + +# Process Requesting\_MAP\_SSM + +MAP\_RSSM2(4) + +Process to handle MAP service requests and the responses from the distant entity + +![State transition diagram for Process Requesting_MAP_SSM. It starts with WAIT_FOR_CONFIRM and branches into Result_Received, 1, Partial_Result_Received, and Negative_Result_Received. Each branch contains decision diamonds for Syntax_Correct, Partial_Result_Correct, Service_Parameter_Available, and Unexpected_Data_Value, leading to various actions like Append_Partial_Info, Set_Provider_Error, MAP_cnf, and TC_U_REJECT.](81e0bc85cbb6bdb4779d4af6d86e80cd_img.jpg) + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_CONFIRM + WAIT_FOR_CONFIRM --> Result_Received + WAIT_FOR_CONFIRM --> 1 + WAIT_FOR_CONFIRM --> Partial_Result_Received + WAIT_FOR_CONFIRM --> Negative_Result_Received + + Result_Received --> Syntax_Correct_1{Syntax_Correct} + Syntax_Correct_1 --> 1 : (FALSE) + Syntax_Correct_1 --> Partial_Result_Correct_1{Partial_Result_Correct} : (TRUE) + Partial_Result_Correct_1 --> 1 : (FALSE) + Partial_Result_Correct_1 --> Append_Partial_Info : (TRUE) + Append_Partial_Info --> Service_Parameter_Available_1{Service_Parameter_Available} + Service_Parameter_Available_1 --> 1 : (FALSE) + Service_Parameter_Available_1 --> Unexpected_Data_Value_1{Unexpected_Data_Value} : (TRUE) + Unexpected_Data_Value_1 --> 1 : (FALSE) + Unexpected_Data_Value_1 --> Set_Provider_Error_1[Set_Provider_Error: Invalid_Response_Received] : (TRUE) + Set_Provider_Error_1 --> MAP_cnf_1[MAP_cnf VIA_User4] + MAP_cnf_1 --> [*] + + 1 --> Set_Provider_Error_2[Set_Provider_Error: Invalid_Response_Received] + Set_Provider_Error_2 --> MAP_cnf_2[MAP_cnf VIA_User4] + MAP_cnf_2 --> Set_Problem_Code_2[Set_Problem_Code: Mistyped_Parameter] + Set_Problem_Code_2 --> TC_U_REJECT_2[TC_U_REJECT req_VIA_TC4] + TC_U_REJECT_2 --> [*] + + Partial_Result_Received --> Syntax_Correct_3{Syntax_Correct} + Syntax_Correct_3 --> TC_U_CANCEL_req_3[TC_U_CANCEL req_VIA_TC4] : (FALSE) + Syntax_Correct_3 --> Store_Partial_Info : (TRUE) + Store_Partial_Info --> WAIT_FOR_CONFIRM + + Negative_Result_Received --> Error_Code_Correct{Error_Code_Correct} + Error_Code_Correct --> 1 : (FALSE) + Error_Code_Correct --> Syntax_Correct_4{Syntax_Correct} : (TRUE) + Syntax_Correct_4 --> 1 : (FALSE) + Syntax_Correct_4 --> Service_Parameters_Available_4{Service_Parameters_Available} : (TRUE) + Service_Parameters_Available_4 --> 1 : (FALSE) + Service_Parameters_Available_4 --> Unexpected_Data_Value_4{Unexpected_Data_Value} : (TRUE) + Unexpected_Data_Value_4 --> 1 : (FALSE) + Unexpected_Data_Value_4 --> Set_User_Error_4[Set_User_Error] : (TRUE) + Set_User_Error_4 --> MAP_cnf_4[MAP_cnf VIA_User4] + MAP_cnf_4 --> [*] + +``` + +State transition diagram for Process Requesting\_MAP\_SSM. It starts with WAIT\_FOR\_CONFIRM and branches into Result\_Received, 1, Partial\_Result\_Received, and Negative\_Result\_Received. Each branch contains decision diamonds for Syntax\_Correct, Partial\_Result\_Correct, Service\_Parameter\_Available, and Unexpected\_Data\_Value, leading to various actions like Append\_Partial\_Info, Set\_Provider\_Error, MAP\_cnf, and TC\_U\_REJECT. + +9486 + +9487 + +Figure 15.6/6b: Process Requesting\_MAP\_SSM (sheet 2) + +# Process Requesting\_MAP\_SSM + +MAP\_RSSM3(4) + +Process to handle MAP service requests and the responses from the distant entity + +![State transition diagram for Process Requesting_MAP_SSM. It starts with WAIT_FOR_CONFIRM and branches into four states: Linked_Request_Received, Terminated, User_Reject_Received, and Linked_Service_Invoked. The diagram includes decision diamonds for Linked_Operation_Allowed, Argument_Correct, Service_Parameters_Available, and MAP_Initiated, leading to various actions like Find_Parent_Operation_Code, Set_Problem_Code, Set_Provider_Error, and Set_User_Error, eventually leading to MAP_cnf_VIA_User4 or WAIT_FOR_CONFIRM.](0c373f7645ae57a94d9107bb41043cfe_img.jpg) + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_CONFIRM + WAIT_FOR_CONFIRM --> Linked_Request_Received + WAIT_FOR_CONFIRM --> Terminated + WAIT_FOR_CONFIRM --> User_Reject_Received + WAIT_FOR_CONFIRM --> Linked_Service_Invoked + + Linked_Request_Received --> Find_Parent_Operation_Code + Find_Parent_Operation_Code --> Linked_Operation_Allowed{Linked_Operation_Allowed} + Linked_Operation_Allowed -- (FALSE) --> 1 + Linked_Operation_Allowed -- (TRUE) --> Argument_Correct{Argument_Correct} + Argument_Correct -- (FALSE) --> Set_Problem_Code + Argument_Correct -- (TRUE) --> Service_Parameters_Available{Service_Parameters_Available} + Service_Parameters_Available -- (FALSE) --> Set_Provider_Error_1[Set_Provider_Error: Data_Missing] + Service_Parameters_Available -- (TRUE) --> MAP_cnf_VIA_User4_1{{MAP_cnf_VIA_User4}} + Set_Problem_Code --> TC_U_REJECT_req_VIA_TC4{{TC_U_REJECT req_VIA_TC4}} + TC_U_REJECT_req_VIA_TC4 --> MAP_cnf_VIA_User4_1 + Set_Provider_Error_1 --> MAP_cnf_VIA_User4_1 + MAP_cnf_VIA_User4_1 --> [*] + + User_Reject_Received --> MAP_Initiated{MAP_Initiated} + MAP_Initiated -- (FALSE) --> Set_Provider_Error_2[Set_Provider_Error] + MAP_Initiated -- (TRUE) --> Set_User_Error + Set_Provider_Error_2 --> MAP_cnf_VIA_User4_2{{MAP_cnf_VIA_User4}} + Set_User_Error --> MAP_cnf_VIA_User4_2 + MAP_cnf_VIA_User4_2 --> [*] + + Linked_Service_Invoked --> Implicit_Cnf_TRUE[Implicit_Cnf:= TRUE] + Implicit_Cnf_TRUE --> WAIT_FOR_CONFIRM + +``` + +State transition diagram for Process Requesting\_MAP\_SSM. It starts with WAIT\_FOR\_CONFIRM and branches into four states: Linked\_Request\_Received, Terminated, User\_Reject\_Received, and Linked\_Service\_Invoked. The diagram includes decision diamonds for Linked\_Operation\_Allowed, Argument\_Correct, Service\_Parameters\_Available, and MAP\_Initiated, leading to various actions like Find\_Parent\_Operation\_Code, Set\_Problem\_Code, Set\_Provider\_Error, and Set\_User\_Error, eventually leading to MAP\_cnf\_VIA\_User4 or WAIT\_FOR\_CONFIRM. + +Figure 15.6/6c: Process Requesting\_MAP\_SSM (sheet 3) + +# Process Requesting\_MAP\_SSM + +MAP\_RSSM4(4) + +Process to handle MAP service requests and the responses from the distant entity + +![State transition diagram for Process Requesting_MAP_SSM. It starts at WAIT_FOR_CONFIRM, leading to a merge point. From the merge point, it can go to Provider_Reject_Received or Timer_Expiry. Both lead to Operation_Class decision (4). Operation_Class (2) leads to Linked_Request_Defined (TRUE/FALSE). Operation_Class (1,3) leads to Implicit_Cnf (TRUE/FALSE). Both decisions lead to Set_Provider_Error and then MAP_cnf VIA_User4. Operation_Class (4) also leads to an exit.](aed3396820a10fad2d1554d72c525982_img.jpg) + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_CONFIRM + WAIT_FOR_CONFIRM --> Merge + state "Provider_Reject_Received" as Provider_Reject_Received + state "Timer_Expiry" as Timer_Expiry + state "Operation_Class" as Operation_Class + state "Linked_Request_Defined" as Linked_Request_Defined + state "Implicit_Cnf" as Implicit_Cnf + state "Set_Provider_Error" as Set_Provider_Error + state "MAP_cnf VIA_User4" as MAP_cnf_VIA_User4 + + Merge --> Provider_Reject_Received + Merge --> Timer_Expiry + Provider_Reject_Received --> Set_Provider_Error + Timer_Expiry --> Operation_Class + Operation_Class --> Set_Provider_Error + Operation_Class --> Implicit_Cnf + Operation_Class --> [*] + Linked_Request_Defined --> Implicit_Cnf + Implicit_Cnf --> Set_Provider_Error + Implicit_Cnf --> MAP_cnf_VIA_User4 + Implicit_Cnf --> [*] + Set_Provider_Error --> MAP_cnf_VIA_User4 + MAP_cnf_VIA_User4 --> [*] + +``` + +Associated with the service + +'A linked operation should have been invoked' + +State transition diagram for Process Requesting\_MAP\_SSM. It starts at WAIT\_FOR\_CONFIRM, leading to a merge point. From the merge point, it can go to Provider\_Reject\_Received or Timer\_Expiry. Both lead to Operation\_Class decision (4). Operation\_Class (2) leads to Linked\_Request\_Defined (TRUE/FALSE). Operation\_Class (1,3) leads to Implicit\_Cnf (TRUE/FALSE). Both decisions lead to Set\_Provider\_Error and then MAP\_cnf VIA\_User4. Operation\_Class (4) also leads to an exit. + +9490 + +9491 + +Figure 15.6/6d: Process Requesting\_MAP\_SSM (sheet 4) + +9492 +9493 +9494 +9495 + +# Process Performing\_MAP\_SSM + +MAP\_PSSM1(2) + +Process to handle an invoke component received from the peer and the response from the user + +Comment 'Performing MAP Service State Machine': +DCL +Argument\_Correct, Service\_Identifiable, Service\_Parameters\_Available, Unexpected\_Data, +Length\_OK, User\_Error\_Present, Linked\_Request, Specific\_Error, More\_Data, +Cnf\_Required BOOLEAN, +Operation\_Class INTEGER, +TIMER Guard\_Timer COMMENT 'expires if MAP user does not respond'; + +![State transition diagram for Process Performing_MAP_SSM. It starts at IDLE, goes to Service_Invocation_Received, then checks Argument_Correct. If FALSE, it goes to Set_Problem_Code: Mistyped_Parameter. If TRUE, it checks Service_Identifiable. If FALSE, it goes to Discard_Invocation. If TRUE, it checks Service_Parameters_Available. If FALSE, it goes to Discard_Invocation. If TRUE, it checks Unexpected_Data. If TRUE, it goes to Discard_Invocation. If FALSE, it checks Cnf_Required. If TRUE, it goes to Set_(Guard_Timer) then WAIT_FOR_RESPONSE. If FALSE, it goes to Discard_Invocation. From Service_Identifiable TRUE, it checks Operation_Class. If (1,2), it goes to Set_Error: Unexpected_Data_Value. If (3,4), it goes to Discard_Invocation. From Operation_Class (Associated with the service) in the Service_Identifiable path, it goes to Set_Error: Data_Missing. Both Set_Error: Unexpected_Data_Value and Set_Error: Data_Missing lead to TC_U_ERROR req_VIA_TC3. From TC_U_ERROR req_VIA_TC3, it goes to MAP_NOTICE_ind_VIA_User3. From Set_Problem_Code: Mistyped_Parameter, it goes to TC_U_REJECT_req_VIA_TC3, then MAP_NOTICE_ind_VIA_User3. There are also exit points (crosses) from Discard_Invocation, Set_(Guard_Timer), and MAP_NOTICE_ind_VIA_User3 states. A connector '1' is used between the Operation_Class (Associated with the service) in the Service_Identifiable path and the Set_Error: Unexpected_Data_Value state.](a0e4d56066bf089079b9b4d24f666b01_img.jpg) + +``` + +stateDiagram-v2 + [*] --> IDLE + IDLE --> Service_Invocation_Received + Service_Invocation_Received --> Argument_Correct + Argument_Correct --> Service_Identifiable + Argument_Correct --> Set_Problem_Code: Mistyped_Parameter (FALSE) + Service_Identifiable --> Service_Parameters_Available + Service_Identifiable --> Discard_Invocation (FALSE) + Service_Identifiable --> Operation_Class (TRUE) + Service_Parameters_Available --> Discard_Invocation (FALSE) + Service_Parameters_Available --> Unexpected_Data (TRUE) + Unexpected_Data --> Discard_Invocation (TRUE) + Unexpected_Data --> Cnf_Required (FALSE) + Cnf_Required --> Set_(Guard_Timer) (TRUE) + Cnf_Required --> Discard_Invocation (FALSE) + Set_(Guard_Timer) --> WAIT_FOR_RESPONSE + Operation_Class --> Set_Error: Unexpected_Data_Value (1,2) + Operation_Class --> Discard_Invocation (3,4) + Operation_Class --> Set_Error: Data_Missing (Associated with the service) + Set_Error: Unexpected_Data_Value --> TC_U_ERROR req_VIA_TC3 + Set_Error: Data_Missing --> TC_U_ERROR req_VIA_TC3 + TC_U_ERROR req_VIA_TC3 --> MAP_NOTICE_ind_VIA_User3 + Set_Problem_Code: Mistyped_Parameter --> TC_U_REJECT_req_VIA_TC3 + TC_U_REJECT_req_VIA_TC3 --> MAP_NOTICE_ind_VIA_User3 + Discard_Invocation --> [*] + Set_(Guard_Timer) --> [*] + MAP_NOTICE_ind_VIA_User3 --> [*] + +``` + +State transition diagram for Process Performing\_MAP\_SSM. It starts at IDLE, goes to Service\_Invocation\_Received, then checks Argument\_Correct. If FALSE, it goes to Set\_Problem\_Code: Mistyped\_Parameter. If TRUE, it checks Service\_Identifiable. If FALSE, it goes to Discard\_Invocation. If TRUE, it checks Service\_Parameters\_Available. If FALSE, it goes to Discard\_Invocation. If TRUE, it checks Unexpected\_Data. If TRUE, it goes to Discard\_Invocation. If FALSE, it checks Cnf\_Required. If TRUE, it goes to Set\_(Guard\_Timer) then WAIT\_FOR\_RESPONSE. If FALSE, it goes to Discard\_Invocation. From Service\_Identifiable TRUE, it checks Operation\_Class. If (1,2), it goes to Set\_Error: Unexpected\_Data\_Value. If (3,4), it goes to Discard\_Invocation. From Operation\_Class (Associated with the service) in the Service\_Identifiable path, it goes to Set\_Error: Data\_Missing. Both Set\_Error: Unexpected\_Data\_Value and Set\_Error: Data\_Missing lead to TC\_U\_ERROR req\_VIA\_TC3. From TC\_U\_ERROR req\_VIA\_TC3, it goes to MAP\_NOTICE\_ind\_VIA\_User3. From Set\_Problem\_Code: Mistyped\_Parameter, it goes to TC\_U\_REJECT\_req\_VIA\_TC3, then MAP\_NOTICE\_ind\_VIA\_User3. There are also exit points (crosses) from Discard\_Invocation, Set\_(Guard\_Timer), and MAP\_NOTICE\_ind\_VIA\_User3 states. A connector '1' is used between the Operation\_Class (Associated with the service) in the Service\_Identifiable path and the Set\_Error: Unexpected\_Data\_Value state. + +9496 + +Figure 15.6/8a: Process Performing\_MAP\_SSM (sheet 1) + +![State transition diagram for Process Performing_MAP_SSM (sheet 1). The process starts at WAIT_FOR_RESPONSE and branches based on Guard_Timer_Expired, Response_Issued, or Terminated. Response_Issued leads to User_Error_Present, which then branches to Linked_Request or Specific_Error. These lead to various processing steps like Length_O.K., Split_info, TC_RESULT_NL_req_VIA_TC3, more_data, Set_Operation_Code_and_TCAP_Param, Set_Error_Code, Set_Problem_Code, and finally TC_INVOKE_req_VIA_TC3, TC_U_ERROR_req_VIA_TC3, or TC_U_REJECT_req_VIA_TC3.](083e35cb1266483c58c5b483d57b4219_img.jpg) + +**Process Performing\_MAP\_SSM** MAP\_PSSM2(2) + +Process to handle an invoke component received from the peer and the response from the user + +``` + +stateDiagram-v2 + [*] --> WAIT_FOR_RESPONSE + WAIT_FOR_RESPONSE --> Guard_Timer_Expired + WAIT_FOR_RESPONSE --> Response_Issued + WAIT_FOR_RESPONSE --> Terminated + Guard_Timer_Expired --> [*] + Terminated --> [*] + Response_Issued --> User_Error_Present + User_Error_Present -- TRUE --> Specific_Error + User_Error_Present -- FALSE --> Linked_Request + Specific_Error -- TRUE --> Set_Error_Code + Specific_Error -- FALSE --> Set_Problem_Code + Linked_Request -- TRUE --> Set_Operation_Code_and_TCAP_Param + Linked_Request -- FALSE --> Length_O.K. + Length_O.K. -- TRUE --> TC_RESULT_L_req_VIA_TC3 + Length_O.K. -- FALSE --> Split_info + Split_info --> 2 + 2 --> TC_RESULT_NL_req_VIA_TC3 + TC_RESULT_NL_req_VIA_TC3 --> more_data + more_data -- TRUE --> 2 + more_data -- FALSE --> TC_RESULT_L_req_VIA_TC3 + Set_Operation_Code_and_TCAP_Param --> TC_INVOKE_req_VIA_TC3 + Set_Error_Code --> TC_U_ERROR_req_VIA_TC3 + Set_Problem_Code --> TC_U_REJECT_req_VIA_TC3 + TC_INVOKE_req_VIA_TC3 --> [*] + TC_U_ERROR_req_VIA_TC3 --> [*] + TC_U_REJECT_req_VIA_TC3 --> [*] + TC_RESULT_L_req_VIA_TC3 --> [*] + TC_RESULT_NL_req_VIA_TC3 --> [*] + Note right of Response_Issued: by the MAP user or the Secure_Performing_MAP_SSM + +``` + +State transition diagram for Process Performing\_MAP\_SSM (sheet 1). The process starts at WAIT\_FOR\_RESPONSE and branches based on Guard\_Timer\_Expired, Response\_Issued, or Terminated. Response\_Issued leads to User\_Error\_Present, which then branches to Linked\_Request or Specific\_Error. These lead to various processing steps like Length\_O.K., Split\_info, TC\_RESULT\_NL\_req\_VIA\_TC3, more\_data, Set\_Operation\_Code\_and\_TCAP\_Param, Set\_Error\_Code, Set\_Problem\_Code, and finally TC\_INVOKE\_req\_VIA\_TC3, TC\_U\_ERROR\_req\_VIA\_TC3, or TC\_U\_REJECT\_req\_VIA\_TC3. + +Figure 15.6/8b: Process Performing\_MAP\_SSM (sheet 2) + +9500 + +9501 + +--- + +## 9502 16 Mapping on to TC services + +### 9503 16.1 Dialogue control + +9504 Dialogue control services are mapped to TC dialogue handling services. The TC-UNI service is not used by the MAP +9505 PM. + +#### 9506 16.1.1 Directly mapped parameters + +9507 The following parameters of the MAP-OPEN request and indication primitives are directly mapped on to the +9508 corresponding parameters of the TC-BEGIN primitives: + +- 9509 - destination address; +- 9510 - originating address. + +#### 9511 16.1.2 Use of other parameters of dialogue handling primitives + +##### 9512 16.1.2.1 Dialogue Id + +9513 The value of this parameter is associated with the MAP PM invocation in an implementation dependent manner. + +##### 9514 16.1.2.2 Application-context-name + +9515 The application-context-name parameter of a MAP primitive is mapped to the application-context-name parameter of +9516 TC dialogue handling primitives according to the rules described in clause 15.1. + +##### 9517 16.1.2.3 User information + +9518 The user information parameter of TC dialogue primitives is used to carry the MAP dialogue APDUs. + +##### 9519 16.1.2.4 Component present + +9520 This parameter is used by the MAP PM as described in CCITT Recommendation Q.771. It is not visible to the MAP +9521 user. + +##### 9522 16.1.2.5 Termination + +9523 The value of this parameter of the TC-END request primitive is set by the MAP PM on the basis of the release method +9524 parameter of the MAP-CLOSE request primitive, except when the dialogue state machine is in the state DIALOGUE +9525 INITIATED, in which case the Termination parameter shall always indicate "pre-arranged end". + +##### 9526 16.1.2.6 P-Abort-Cause + +9527 Values of the P-abort-cause parameter are mapped to the values of the provider-reason parameter of the +9528 MAP-P-ABORT indication primitive according to table 16.1/1, except in the dialogue initiated phase for the +9529 "incorrectTransactionPortion" and "noCommonDialoguePortion" values which are mapped to the "potential +9530 incompatibility problem" value of the refuse-reason parameter of the MAP-OPEN cnf primitive. The source parameter +9531 in the MAP-P-ABORT ind takes the value "TC problem". + +##### 9532 16.1.2.7 Quality of service + +9533 The quality of service of TC request primitives is set by the MAP as shown below. + +- 9534 - Return option: "Return message on error" or "Discard message on error" as required by the network operator; +- 9535 - Sequence control: "Sequence guaranteed" or "Sequence result not guaranteed" as required by the network operator; +- 9536 +- 9537 - "Sequence guaranteed" shall be used when a segmented result is to be transferred (e.g. subscriber data in +- 9538 response to SendParameters). It may also be appropriate to use Sequence guaranteed when a series of +- 9539 InsertSubscriberData, ProcessAccessSignalling or ForwardAccessSignalling operations is used. + +9540 It is essential that the TC message which indicates acceptance of a dialogue opening request is received by the dialogue +9541 initiator before any subsequent message in that dialogue; otherwise the dialogue opening will fail. The dialogue +9542 responder shall ensure that this requirement is met by: + +- 9543 - Sending the dialogue acceptance message in a TC-END, if the dialogue structure requires it; or +- 9544 - Using "Sequence guaranteed", if the dialogue acceptance message is sent in a TC-CONTINUE; or +- 9545 - Waiting until the dialogue acceptance message has been acknowledged by the dialogue initiator before sending a +- 9546 subsequent message, if the dialogue acceptance message is sent in a TC-CONTINUE. + +9547 **Table 16.1/1: Mapping of P-Abort cause in TC-P-ABORT indication** +9548 **on to provider-reason in MAP-P-ABORT indication** + +| TC P-Abort cause | MAP provider-reason | +|-------------------------------------------------------------------|------------------------------| +| unrecognised message type | provider malfunction | +| unrecognised transaction Id | supporting dialogue released | +| badlyFormattedTransactionPotion | provider malfunction | +| incorrectTransactionPotion | provider malfunction (note) | +| resourceLimitation | resource limitation | +| abnormalDialogue | provider malfunction | +| noCommonDialoguePotion | version incompatibility | +| NOTE: Or version incompatibility in the dialogue initiated phase. | | + +9549 + +## 9550 16.2 Service specific procedures + +9551 Specific services are mapped to TC component handling services. + +### 9552 16.2.1 Directly mapped parameters + +9553 The Invoke Id parameter of the MAP request and indication primitive is directly mapped on to the Invoke Id parameter +9554 of the component handling primitives. + +### 9555 16.2.2 Use of other parameters of component handling primitives + +#### 9556 16.2.2.1 Dialogue Id + +9557 The value of this parameter is associated with the MAP PM invocation in an implementation dependent manner. + +#### 9558 16.2.2.2 Class + +9559 The value of this parameter is set by the MAP PM according to the type of the operation to be invoked. + +#### 9560 16.2.2.3 Linked Id + +9561 When a service response is mapped to a class 4 operation, the value of this parameter is set by the MAP PM and +9562 corresponds to the value assigned by the user to the initial service request (i.e. the value of the invoke ID parameter of + +9563 the request primitive). Otherwise if such a parameter is included in MAP request/indication primitives it is directly + 9564 mapped to the linked ID parameter of the associated TC-INVOK request/indication primitives. + +## 9565 16.2.2.4 Operation + +9566 When mapping a request primitive on to a Remote Operations PDU (invoke), the MAP PM shall set the operation code + 9567 according to the mapping described in table 16.2/1. + +9568 When mapping a response primitive on to a Remote Operations service, the MAP PM shall set the operation code of the + 9569 TC-RESULT-L/NL primitive (if required) to the same value as the one received at invocation time. + +9570 **Table 16.2/1: Mapping of MAP specific services on to MAP operations** + +| | | +|-----------------------------------------|----------------------------------| +| MAP-SERVICE | operation | +| MAP-ACTIVATE-SS | activateSS | +| MAP-ACTIVATE-TRACE-MODE | activateTraceMode | +| MAP-ALERT-SERVICE-CENTRE | alertServiceCentre | +| MAP-ANY-TIME-INTERROGATION | anyTimeInterrogaton | +| MAP_AUTHENTICATION_FAILURE_REPORT | authenticationFailureReport | +| MAP-ANY-TIME-MODIFICATION | anyTimeModification | +| MAP-ANY-TIME-SUBSCRIPTION-INTERROGATION | anyTimeSubscriptionInterrogation | +| MAP-CANCEL-LOCATION | cancelLocation | +| MAP-CHECK-IMEI | checkIMEI | +| MAP-DEACTIVATE-SS | deactivateSS | +| MAP-DEACTIVATE-TRACE-MODE | deactivateTraceMode | +| MAP-DELETE-SUBSCRIBER-DATA | deleteSubscriberData | +| MAP-ERASE-CC-ENTRY | eraseCC-Entry | +| MAP-ERASE-SS | eraseSS | +| MAP-FAILURE-REPORT | failureReport | +| MAP-FORWARD-ACCESS-SIGNALLING | forwardAccessSignalling | +| MAP-FORWARD-CHECK-SS-INDICATION | forwardCheckSsIndication | +| MAP-FORWARD-GROUP-CALL-SIGNALLING | forwardGroupCallSignalling | +| MAP-MT-FORWARD-SHORT-MESSAGE | mt-forwardSM | +| MAP-MO-FORWARD-SHORT-MESSAGE | mo-forwardSM | +| MAP-GET-PASSWORD | getPassword | +| MAP-INFORM-SERVICE-CENTRE | informServiceCentre | +| MAP-INSERT-SUBSCRIBER-DATA | insertSubscriberData | +| MAP-INTERROGATE-SS | interrogateSs | +| MAP-IST-ALERT | istAlert | +| MAP-IST-COMMAND | istCommand | +| MAP-NOTE-MS-PRESENT-FOR-GPRS | noteMsPresentForGprs | +| MAP-NOTE-SUBSCRIBER-DATA-MODIFIED | noteSubscriberDataModified | +| MAP-PREPARE-GROUP-CALL | prepareGroupCall | +| MAP-PREPARE-HANDOVER | prepareHandover | +| MAP-PREPARE-SUBSEQUENT-HANDOVER | prepareSubsequentHandover | +| MAP-PROCESS-ACCESS-SIGNALLING | processAccessSignalling | +| MAP-PROCESS-GROUP-CALL-SIGNALLING | processGroupCallSignalling | +| MAP-PROCESS-UNSTRUCTURED-SS-REQUEST | processUnstructuredSS-Request | +| MAP-PROVIDE-ROAMING-NUMBER | provideRoamingNumber | +| MAP-PROVIDE-SUBSCRIBER-LOCATION | provideSubscriberLocation | +| MAP-PROVIDE-SUBSCRIBER-INFO | provideSubscriberInfo | +| MAP-PURGE-MS | purgeMS | +| MAP-READY-FOR-SM | readyForSM | +| MAP-REGISTER-CC-ENTRY | registerCC-Entry | +| MAP-REGISTER-PASSWORD | registerPassword | +| MAP-REGISTER-SS | registerSS | +| MAP-REMOTE-USER-FREE | remoteUserFree | +| MAP-REPORT-SM-DELIVERY-STATUS | reportSmDeliveryStatus | +| MAP-RESET | reset | +| MAP-RESTORE-DATA | restoreData | +| MAP-SEND_GROUP_CALL_END_SIGNAL | sendGroupCallEndSignal | +| MAP-SEND-GROUP-CALL-INFO | sendGroupCallInfo | +| MAP-SEND-END-SIGNAL | sendEndSignal | + +| | | +|---------------------------------------------------|----------------------------| +| MAP-SEND-AUTHENTICATION-INFO | sendAuthenticationInfo | +| MAP-SEND-IMSI | sendIMSI | +| MAP-SEND-IDENTIFICATION | sendIdentification | +| MAP-SEND-ROUTING-INFO-FOR-SM | sendRoutingInfoForSM | +| MAP-SEND-ROUTING-INFO-FOR-GPRS | sendRoutingInfoForGprs | +| MAP-SEND-ROUTING-INFO-FOR-LCS | sendRoutingInfoForLCS | +| MAP-SEND-ROUTING-INFORMATION | sendRoutingInfo | +| MAP-SET-REPORTING-STATE | setReportingState | +| MAP-STATUS-REPORT | statusReport | +| MAP-SUBSCRIBER-LOCATION-REPORT | subscriberLocationReport | +| MAP-SUPPLEMENTARY-SERVICE-INVOCATION-NOTIFICATION | ss-Invocation-Notification | +| MAP-UNSTRUCTURED-SS-NOTIFY | unstructuredSS-Notify | +| MAP-UNSTRUCTURED-SS-REQUEST | unstructuredSS-Request | +| MAP-UPDATE-GPRS-LOCATION | updateGprsLocation | +| MAP-UPDATE-LOCATION | updateLocation | +| MAP-NOTE-MM-EVENT | NoteMM-Event | +| MAP-UPDATE-VCSG-LOCATION | updateVcsgLocation | +| MAP-CANCEL-VCSG-LOCATION | cancelVcsgLocation | + +9571 + +## 9572 16.2.2.5 Error + +9573 The error parameter in a TC-U-ERROR indication primitive is mapped to the user error parameter in the MAP confirm +9574 primitive of the service associated with the operation to which the error is attached. + +9575 The user error parameter in MAP response primitives is mapped to the error parameter of the TC-U-ERROR request +9576 primitive, except for "initiating-release" and "resource-limitation" which are mapped to the problem code parameter of +9577 the TC-U-REJECT request primitive. + +## 9578 16.2.2.6 Parameters + +9579 The parameters of MAP specific request and indication primitives are mapped to the argument parameter of TC- +9580 INVOKE primitives. + +9581 The parameters of MAP specific response and confirm primitives are mapped to the result parameter of TC-RESULT-L +9582 primitives, the parameter of TC-U-ERROR primitives or the argument of TC-INVOKE primitives when mapping on +9583 linked class 4 operations is used. + +## 9584 16.2.2.7 Time out + +9585 The value of this parameter is set by the MAP PM according to the type of operation invoked. + +## 9586 16.2.2.8 Last component + +9587 This parameter is used by the MAP PM as described in CCITT Recommendation Q.711. It is not visible from the MAP +9588 user. + +## 9589 16.2.2.9 Problem code + +### 9590 16.2.2.9.1 Mapping to MAP User Error + +9591 The following values of the user error parameter are mapped as follows to values of the TC problem code parameter. +9592 These values are generated by the MAP user. This mapping is valid from the TC-U-REJECT indication primitive to the +9593 MAP confirm service primitive and from the MAP response service primitive to the TC-U-REJECT request primitive. + +9594 **Table 16.2/2: Mapping of MAP User Error parameter on to TC problem code** +9595 **in TC-U-REJECT primitives** + +| MAP User Error | TC problem code | +|---------------------|---------------------| +| resource limitation | resource limitation | +| initiating release | initiating release | + +9596 + +9597 16.2.2.9.2 Mapping to MAP Provider Error parameter + +9598 The following values of the TC problem code parameter of the TC-U-REJECT indication primitive are mapped as +9599 follows to values of the MAP Provider Error parameter of the MAP confirm primitive. + +9600 **Table 16.2/3: Mapping of TC problem code in TC-U-REJECT on to MAP Provider Error parameter** + +| TC problem code | MAP Provider Error | +|------------------------|-----------------------| +| duplicated invoke Id | duplicated invoke id | +| unrecognised operation | service not supported | +| mistyped parameter | mistyped parameter | + +9601 + +9602 The following values of the problem code parameters of the TC-L-REJECT primitive are mapped to values of the +9603 provider error parameter of the MAP confirm primitive as follows. + +9604 **Table 16.2/4: Mapping of TC problem code in TC-L-REJECT on to MAP Provider Error parameter** + +| TC problem code | MAP Provider Error | +|--------------------------|-----------------------------------| +| return result unexpected | unexpected response from the peer | +| return error unexpected | unexpected response from the peer | + +9605 + +9606 16.2.2.9.3 Mapping to diagnostic parameter + +9607 The following values of the problem code parameter of the TC-R-REJECT and TC-U-REJECT primitive are mapped to +9608 values of the diagnostic parameter of the MAP-NOTICE indication primitive as follows: + +9609 **Table 16.2/5: Mapping of TC problem code of TC-R-REJECT and TC-U-REJECT** +9610 **on to diagnostic parameter** + +| TC problem code | MAP diagnostic | +|-------------------------------|---------------------------------------| +| General problem | - abnormal event detected by the peer | +| Invoke problem | | +| - unrecognised linked ID | - abnormal event detected by the peer | +| - linked response unexpected | - response rejected by the peer | +| - unexpected linked operation | - response rejected by the peer | +| Return result problem | | +| - unrecognised invoke ID | - response rejected by the peer | +| - return result unexpected | - response rejected by the peer | +| - mistyped parameter | - response rejected by the peer | +| Return error problem | | +| - unrecognised invoke ID | - response rejected by the peer | +| - return error unexpected | - response rejected by the peer | +| - unrecognised error | - response rejected by the peer | +| - unexpected error | - response rejected by the peer | +| - mistyped parameter | - response rejected by the peer | + +9611 + +9612 The following values of the problem code parameter of the TC-L-REJECT primitive are mapped to values of the +9613 diagnostic parameter of the MAP-NOTICE indication primitive as follows. + +9614 **Table 16.2/6: Mapping of TC problem code of TC-L-REJECT on to diagnostic parameter** + +| TC problem code | MAP diagnostic | +|--------------------------|-----------------------------------------| +| General problems | - abnormal event received from the peer | +| Invoke problem | | +| - unrecognised linked ID | - abnormal event received from the peer | +| Return result problem | | +| - unrecognised invoke ID | - abnormal event received from the peer | +| Return error problem | | +| - unrecognised invoke ID | - abnormal event received from the peer | + +9615 + +--- + +# 9616 17 Abstract syntax of the MAP protocol + +## 9617 17.1 General + +9618 This clause specifies the Abstract Syntaxes for the Mobile Application Part as well as the associated set of Operations +9619 and Errors, using the Abstract Syntax Notation One (ASN.1), defined in ITU-T Recommendations X.680 and X.681 +9620 with additions as defined in clause 17.1.4 on Compatibility Considerations and the OPERATION and ERROR external +9621 information object classes, defined in ITU-T Recommendation X.880. + +9622 The Abstract Syntax is defined for all interfaces specified in clause 4.4 except for the A- and B-interfaces. + +9623 The Mobile Application Part protocol is defined by two Abstract Syntaxes: + +9624 - one Abstract Syntax which encompass all Operations and Errors identified by the various MAP subsystem +9625 numbers. + +9626 This Abstract Syntax represents the set of values each of which is a value of the ASN.1 type TCAPMessages. +9627 TCMessage as defined in ITU-T Recommendation Q.773 with the component relationconstraint clauses resolved by the +9628 operation and error codes included in the ASN.1 modules MAP-\*Operations and MAP-Errors. However, only the +9629 subset of this abstract syntax which is required by the procedures defined for an entity needs to be supported. + +9630 - one Abstract Syntax identified by the OBJECT IDENTIFIER value MAP-DialogueInformation.map- +9631 DialogueAS. + +9632 This Abstract Syntax represents the set of values each of which is a value of the ASN.1 type MAP- +9633 DialogueInformation.MAP-DialoguePDU. Such a value of the ASN.1 single-ASN.1-type element is contained within +9634 the user-information element of the TCAPMessages.DialoguePortion ASN.1 type. This Abstract Syntax name is to be +9635 used as a direct reference. + +## 9636 17.1.1 Encoding rules + +9637 The encoding rules which are applicable to the defined Abstract Syntaxes are the Basic Encoding Rules for Abstract +9638 Syntax Notation One, defined in ITU-T Recommendation X.690 with the same exceptions as in ITU-T +9639 Recommendation Q.773, clause 4 Message Representation. + +9640 When the definite form is used for length encoding, a data value of length less than 128 octets must have the length +9641 encoded in the short form. + +9642 When the long form is employed to code a length, the minimum number of octets shall be used to code the length field. + +9643 OCTET STRING values and BIT STRING values must be encoded in a primitive form. + +9644 There is no restriction to the use of empty constructors (e.g. an empty SEQUENCE type). That is, the encoding of the +9645 content of any data value shall consist of zero, one or more octets. + +## 9646 17.1.2 Use of TC + +9647 The mapping of OPERATION and ERROR to TC components is defined in ETS 300 287 (version 2) which is based on +9648 ITU-T Recommendation Q.773. + +9649 NOTE 1: The class of an operation is not stated explicitly but is specified as well in the ASN.1 operation definition. + +9650 Class 1: RESULT and ERROR appear in ASN.1 operation definition. + +9651 Class 2: only ERROR appears in ASN.1 operation definition. + +9652 Class 3: only RESULT appears in ASN.1 operation definition. + +9653 Class 4: both RESULT and ERROR do not appear in ASN.1 operation definition. + +9654 The field "ARGUMENT", "PARAMETER" or "RESULT" (for information objects of class OPERATION and +9655 ERROR) is always optional from a syntactic point of view. However, except when specifically mentioned with the + +9656 ASN.1 comment "-- optional" , the "parameter" part of a component has to be considered as mandatory from a semantic +9657 point of view. + +9658 When an optional element is missing in an invoke component or in an inner data structure while it is required by the +9659 context, an error component is returned if specified in the information object associated with the operation ; the +9660 associated type of error is "DataMissing". This holds also when the entire parameter of an invoke component is missing +9661 while it is required by the context. + +9662 NOTE 2: When a mandatory element is missing in the parameter or inner data structure of any component, a reject +9663 component is returned (if the dialogue still exists). The problem code to be used is "Mistyped parameter". + +9664 The Timer Values used in the operation definitions are indicated as ASN.1 comments. The Timer Value Ranges are: + +9665 s = from 3 seconds to 10 seconds; + +9666 m = from 15 seconds to 30 seconds; + +9667 ml = from 1 minute to 10 minutes; + +9668 l = from 28 hours to 38 hours. + +### 9669 17.1.2.1 Use of Global Operation and Error codes defined outside MAP + +9670 An entity supporting an application context greater than 2 shall be capable of receiving an operation or error code, +9671 within an application context defined in GSM 29.002, encoded as either an Object Identifier (as defined in ITU-T +9672 Recommendation X.690 ) or an integer value (as defined in clause 17.5). Related restrictions regarding the use of +9673 Object Identifiers are as follows: + +9674 - The length of the Object Identifier shall not exceed 16 octets and the number of components of the Object +9675 Identifier shall not exceed 16. + +9676 - Object Identifiers shall be used only for operations or errors defined outside of GSM 29.002. + +9677 - Global error codes may be sent only in response to a global operation. If a standard operation is received then +9678 a global error code shall not be sent in response. + +9679 Handling of an unknown operation codes by the receiving entity is defined in clause 15.1.1. + +### 9680 17.1.3 Use of information elements defined outside MAP + +9681 An information element or a set of information elements (messages) transparently carried in the Mobile Application +9682 Part but defined in other recommendations/technical specifications are handled in one of the following ways: + +9683 i) The contents of each information element (without the octets encoding the identifier and the length in the +9684 recommendation/technical specification where it is defined unless explicitly stated otherwise) is carried as the +9685 value of an ASN.1 type derived from the OCTET STRING data type. Additionally, the internal structure may be +9686 explained by means of comments. In case of misalignment the referred to recommendation/technical +9687 specification takes precedence. + +9688 ii) The complete information element (including the octets encoding the identifier and the length in the +9689 recommendation/technical specification where it is defined) or set of information elements and the identity of the +9690 associated protocol are carried as the value of the ExternalSignalInfo data type defined in the present document. +9691 Where more than one information element is carried, the information elements are sent contiguously with no +9692 filler octets between them. + +### 9693 17.1.4 Compatibility considerations + +9694 The following ASN.1 modules conform to ITU-T Recommendation X.680 and X.681 . An extension marker ("...") is +9695 used wherever future protocol extensions are foreseen. + +9696 The "..." construct applies only to SEQUENCE and ENUMERATED data types. An entity supporting a version greater +9697 than 1 shall not reject an unsupported extension following "..." of that SEQUENCE or ENUMERATED data type. The + +9698 Encoding Rules from clause 17.1.1 apply to every element of the whole Transfer Syntax especially to the ASN.1 type +9699 EXTERNAL. + +9700 The extension container "privateExtensionList" is defined in this specification in order to carry extensions which are +9701 defined outside this specification. Private extensions can be defined by, for example, network operators, manufacturers, +9702 and regional standardisation bodies. + +9703 Private extensions shall: + +9704 1) if included in operations of an AC of V2, follow the extension marker and be tagged using PRIVATE tags up +9705 to and including 29. + +9706 NOTE: This type of extension is in most cases used only within a PLMN. + +9707 2) if included in operations of an AC of V3 or higher: be included only in the Private Extension Container that +9708 is defined in the specification. + +9709 NOTE: This type of extension can be used between PLMNs. + +9710 Private extensions shall not be included in v2 supplementary service operations. + +9711 Private extensions shall not be included within user error for RegisterCCEntry and EraseCCEntry operations. + +9712 PCS extensions shall be included in the PCS Extension Container that is defined in this specification. + +9713 In order to improve extensibility, a few error parameters have been defined as a CHOICE between the version 2 +9714 description and a SEQUENCE including the version 2 description and an extension container. Operations used in a v2- +9715 application-context must consider only the first alternative while operations used in a vn-application-context (n>2) must +9716 consider only the second alternative. + +## 9717 17.1.5 Structure of the Abstract Syntax of MAP + +9718 For each MAP parameter which has to be transferred by a MAP Protocol Data Unit (MAP message), there is a PDU +9719 field (an ASN.1 type) which has the same name as the corresponding parameter, except for the differences required by +9720 the ASN.1 notation (blanks between words are removed or replaced by hyphen, the first letter of the first word is capital +9721 and the first letter of each of the following words is capitalised, e.g. "no reply condition time" is mapped to +9722 "NoReplyConditionTime"). Additionally some words may be abbreviated as follows: + +9723 bs basic service +9724 ch call handling +9725 cug closed user group +9726 ho handover +9727 ic incoming call +9728 id identity +9729 info information +9730 mm mobility management +9731 lcs location services +9732 ms mobile service +9733 oc outgoing call +9734 om operation & maintenance +9735 pw Password +9736 sm short message service +9737 ss supplementary service + +9738 The MAP protocol is composed of several ASN.1 modules dealing with either operations, errors, data types, and, if +9739 applicable, split into those dealing with mobile services, call handling services, supplementary services and short +9740 message services. For operations and errors the code values are given as parameters, in order to allow use of the +9741 defined information objects also by other protocols (e.g. 3GPP TS 24.080 [38]). The ASN.1 source lines are preceded +9742 by line-numbers at the left margin in order to enable the usage of the cross-reference in annex A. + +9743 The module containing the definition of the operation packages for MAP is: + +9744 1. MAP-OperationPackages. + +9745 The module containing the definition of the application contexts for MAP is: + +9746 2. MAP-ApplicationContexts. + +9747 The module containing the data types for the Abstract Syntax to be used for TCAPMessages.DialoguePortion for MAP +9748 is: + +9749 3. MAP-DialogueInformation. + +9750 The module containing the supported operations is: + +9751 4. MAP-Protocol. + +9752 The modules containing all operation definitions for MAP are: + +9753 5. MAP-MobileServiceOperations; + +9754 6. MAP-OperationAndMaintenanceOperations; + +9755 7. MAP-CallHandlingOperations; + +9756 8. MAP-SupplementaryServiceOperations; + +9757 9. MAP-ShortMessageServiceOperations; + +9758 10. MAP-Group-Call-Operations; + +9759 11. MAP-LocationServiceOperations. + +9760 The module containing all error definitions for MAP is: + +9761 12. MAP-Errors. + +9762 Modules containing all data type definitions for MAP are: + +9763 13. MAP-MS-DataTypes; + +9764 14. MAP-OM-DataTypes; + +9765 15. MAP-CH-DataTypes; + +9766 16. MAP-SS-DataTypes; + +9767 17. MAP-SS-Code; + +9768 18. MAP-SM-DataTypes; + +9769 19. MAP-ER-DataTypes; + +9770 20. MAP-CommonDataTypes; + +9771 21. MAP-TS-Code; + +9772 22. MAP-BS-Code; + +9773 23. MAP-ExtensionDataTypes; + +9774 24. MAP-GR-DataTypes; + +9775 25. MAP-LCS-DataTypes. + +9776 References are made also to modules defined outside of the present document. They are defined in the technical +9777 specification Mobile Services Domain, technical specification Transaction Capability and ITU-T Recommendation +9778 X.880 respectively: + +9779 MobileDomainDefinitions; + +9780 TCAPMessages, DialoguePDUs ; + +9781 Remote-Operations-Information-Objects. + +## 9782 17.1.6 Application Contexts + +9783 The following informative table lists the latest versions of the Application Contexts used in this specification, with the +9784 operations used by them and, where applicable, whether or not the operation description is exactly the same as for +9785 previous versions. Information in 17.6 & 17.7 relates only to the ACs in this table. + +9786 + +| AC Name | AC Version | Operations Used | Comments | +|------------------------------|------------|---------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| locationCancellationContext | v3 | cancelLocation | | +| equipmentMngtContext | V3 | checkIMEI | | +| imsiRetrievalContext | v2 | sendIMSI | | +| infoRetrievalContext | v3 | sendAuthenticationInfo | | +| interVlrInfoRetrievalContext | v3 | sendIdentification | | +| handoverControlContext | v3 | prepareHandover
forwardAccessSignalling
sendEndSignal
processAccessSignalling
prepareSubsequentHandover | the syntax of this operation has been extended in comparison with release 98 version | +| mwdMngtContext | v3 | readyForSM | | +| msPurgingContext | v3 | purgeMS | | +| shortMsgAlertContext | v2 | alertServiceCentre | | +| resetContext | v3 | reset | | +| networkUnstructuredSsContext | v2 | processUnstructuredSS-Request
unstructuredSS-Request
unstructuredSS-Notify | | +| tracingContext | v3 | activateTraceMode
deactivateTraceMode | | +| networkFunctionalSsContext | v2 | registerSS
eraseSS
activateSS
deactivateSS
registerPassword
interrogateSS
getPassword | | +| shortMsgMO-RelayContext | v3 | mo-forwardSM | | +| shortMsgMT-RelayContext | v3 | mt-forwardSM | | +| shortMsgMT-VGCS-RelayContext | v3 | mt-forwardSM-VGCS | | +| shortMsgGatewayContext | v3 | sendRoutingInfoForSM
reportSM-DeliveryStatus
InformServiceCentre | the syntax of this operation has been extended in comparison with release 96 version | +| networkLocUpContext | v3 | updateLocation
forwardCheckSs-Indication
restoreData
insertSubscriberData
activateTraceMode | the syntax is the same in v1 & v2 | +| gprsLocationUpdateContext | v3 | updateGprsLocation
insertSubscriberData
activateTraceMode | | +| subscriberDataMngtContext | v3 | insertSubscriberData | | + +| AC Name | AC Version | Operations Used | Comments | +|-----------------------------------------------|------------|--------------------------------------------------------------------------------------------------------|----------| +| | | deleteSubscriberData | | +| roamingNumberEnquiryContext | v3 | provideRoamingNumber | | +| locationInfoRetrievalContext | v3 | sendRoutingInfo | | +| gprsNotifyContext | v3 | noteMsPresentForGprs | | +| gprsLocationInfoRetrievalContext | v4 | sendRoutingInfoForGprs | | +| failureReportContext | v3 | failureReport | | +| callControlTransferContext | v4 | resumeCallHandling | | +| subscriberInfoEnquiryContext | v3 | provideSubscriberInfo | | +| anyTimeEnquiryContext | v3 | anyTimeInterrogation | | +| anyTimeInfoHandlingContext | v3 | anyTimeSubscriptionInterrogation
anyTimeModification | | +| ss-InvocationNotificationContext | v3 | ss-InvocationNotification | | +| groupCallControlContext | v3 | prepareGroupCall
processGroupCallSignalling
forwardGroupCallSignalling
sendGroupCallEndSignal | | +| reportingContext | v3 | setReportingState
statusReport
remoteUserFree | | +| callCompletionContext | v3 | registerCC-Entry
eraseCC-Entry | | +| istAlertingContext | v3 | istAlert | | +| ServiceTerminationContext | v3 | istCommand | | +| locationSvcEnquiryContext | v3 | provideSubscriberLocation
subscriberLocationReport | | +| locationSvcGatewayContext | v3 | sendRoutingInfoForLCS | | +| mm-EventReportingContext | v3 | noteMM-Event | | +| subscriberDataModificationNotificationContext | v3 | noteSubscriberDataModified | | +| authenticationFailureReportContext | v3 | authenticationFailureReport | | +| resourceManagementContext | v3 | releaseResources | | +| groupCallInfoRetrievalContext | v3 | sendGroupCallInfo | | +| vcsgLocationUpdateContext | v3 | updateVcsgLocation
insertSubscriberData | | +| vcsgLocationCancelContext | v3 | cancelVcsgLocation | | + +9787 + +9788 NOTE (\*): The syntax of the operations is not the same as in previous versions unless explicitly stated + +## 9789 17.2 Operation packages + +### 9790 17.2.1 General aspects + +9791 This clause describes the operation-packages which are used to build the application-contexts defined in clause 17.3. + +9792 Each operation-package is a specification of the roles of a pair of communicating objects (i.e. a pair of MAP-Providers), +9793 in terms of operations which they can invoke of each other. + +9794 The grouping of operations into one or several packages does not necessarily imply any grouping in terms of +9795 Application Service Elements. + +9796 The following ASN.1 information object class is used to describe operation-packages in this clause: + +``` + +9797 OPERATION-PACKAGE ::= CLASS { +9798 &Both OPERATION OPTIONAL, +9799 &Consumer OPERATION OPTIONAL, +9800 &Supplier OPERATION OPTIONAL, +9801 &id OBJECT IDENTIFIER UNIQUE OPTIONAL } +9802 WITH SYNTAX { +9803 [ OPERATIONS &Both ] +9804 [ CONSUMER INVOKES &Supplier ] +9805 [ SUPPLIER INVOKES &Consumer ] +9806 [ ID &id ] } +9807 + +``` + +9808 Since the application-context definitions provided in clause 17.3 use only an informal description technique, only the +9809 type notation is used in the following clauses to define operation-packages. + +9810 The following definitions are used throughout this clause (n>=2): + +- 9811 - v1-only operation: An operation which shall be used only in v1 application-contexts; +- 9812 - vn-only operation: An operation which shall be used only in vn application-contexts; +- 9813 - v(n-1)-operation: An operation whose specification has not been modified since the MAP v(n-1) specifications +9814 or if the modifications are considered as not affecting v(n-1) implementations; +- 9815 - v(n-1)-equivalent operation: The version of an operation which excludes all the information elements and errors +9816 which have been added since the MAP v(n-1) specification; +- 9817 - vn-only package: An operation package which contains only vn-only operations; +- 9818 - v(n-1)-package: An operation package which contains only v(n-1)- operations. + +9819 The names of vn-packages are suffixed by "-vn" where n>=2. + +9820 For each operation package which is not vn-only (n>=2) and which does not include only v(n-1)-operations, there is a +9821 v(n-1)-equivalent package. Except when a definition is explicitly provided in the following clauses, the +9822 v(n-1)-equivalent package includes the v(n-1)-equivalent operations of the operations which belong to this package. + +## 9823 17.2.2 Packages specifications + +### 9824 17.2.2.1 Location updating + +9825 This operation package includes the operations required for location management procedures between HLR and VLR. + +``` + +9826 LocationUpdatingPackage-v3 OPERATION-PACKAGE ::= { +9827 -- Supplier is HLR if Consumer is VLR +9828 CONSUMER INVOKES { +9829 updateLocation} +9830 SUPPLIER INVOKES { +9831 forwardCheckSs-Indication} } +9832 + +``` + +9833 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9834 17.2.2.2 Location cancellation + +9835 This operation package includes the operations required for location cancellation and MS purging procedures between +9836 HLR and VLR and between HLR and SGSN. + +``` + +9837 LocationCancellationPackage-v3 OPERATION-PACKAGE ::= { +9838 -- Supplier is VLR or SGSN if Consumer is HLR +9839 CONSUMER INVOKES { +9840 cancelLocation} } +9841 + +``` + +9842 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9843 17.2.2.3 Roaming number enquiry + +9844 This operation package includes the operations required for roaming number enquiry procedures between HLR or old +9845 VLR and VLR. + +``` +9846 roamingNumberEnquiryPackage-v3 OPERATION-PACKAGE ::= { +9847 -- Supplier is VLR if Consumer is HLR or old VLR +9848 CONSUMER INVOKES { +9849 provideRoamingNumber} } +``` + +9850 +9851 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9852 17.2.2.4 Information retrieval + +9853 This operation package includes the operation required for the authentication information retrieval procedure between +9854 HLR and VLR and between HLR and SGSN. + +``` +9855 infoRetrievalPackage-v3 OPERATION-PACKAGE ::= { +9856 -- Supplier is HLR if Consumer is VLR +9857 -- Supplier is HLR if Consumer is SGSN +9858 CONSUMER INVOKES { +9859 sendAuthenticationInfo} } +``` + +9860 +9861 The v2-equivalent package is defined as follows: + +``` +9862 infoRetrievalPackage-v2 OPERATION-PACKAGE ::= { +9863 -- Supplier is HLR if Consumer is VLR +9864 -- Supplier is HLR if Consumer is SGSN +9865 CONSUMER INVOKES { +9866 sendAuthenticationInfo} } +``` + +9867 +9868 The v1-equivalent package is defined as follows: + +``` +9869 infoRetrievalPackage-v1 OPERATION-PACKAGE ::= { +9870 -- Supplier is HLR or VLR if Consumer is VLR +9871 -- Supplier is HLR if Consumer is SGSN +9872 CONSUMER INVOKES { +9873 sendParameters} } +``` + +### 9875 17.2.2.5 Inter-VLR information retrieval + +9876 This operation package includes the operations required for inter VLR information retrieval procedures. + +``` +9877 interVlrInfoRetrievalPackage-v3 OPERATION-PACKAGE ::= { +9878 -- Supplier is VLR if Consumer is VLR +9879 CONSUMER INVOKES { +9880 sendIdentification} } +``` + +9881 +9882 The v2-equivalent package is defined as follows: + +``` +9883 interVlrInfoRetrievalPackage-v2 OPERATION-PACKAGE ::= { +9884 -- Supplier is VLR if Consumer is VLR +9885 CONSUMER INVOKES { +9886 sendIdentification} } +``` + +9887 +9888 The v1-equivalent package is : infoRetrievalPackage-v1. + +### 9889 17.2.2.6 IMSI retrieval + +9890 This operation package includes the operation required for the IMSI retrieval procedure between HLR and VLR. + +``` +9891 imsiRetrievalPackage-v2 OPERATION-PACKAGE ::= { +9892 -- Supplier is HLR if Consumer is VLR +9893 CONSUMER INVOKES { +9894 sendIMSI} } +``` + +9895 +9896 This package is v2 only. + +### 9897 17.2.2.7 Call control transfer + +9898 This operation package includes the operation required for the call control transfer procedure between VMSC and +9899 GMSC. + +``` +9900 callControlTransferPackage-v4 OPERATION-PACKAGE ::= { +9901 -- Supplier is GMSC if Consumer is VMSC +9902 CONSUMER INVOKES { +9903 resumeCallHandling} } +``` + +9904 +9905 The v3-equivalent package can be determined according to the rules described in clause 17.2.1. + +### 9906 17.2.2.8 Void + +### 9907 17.2.2.9 Void + +### 9908 17.2.2.10 Interrogation + +9909 This operation package includes the operations required for interrogation procedures between MSC and HLR or NPLR +9910 or between HLR and gsmSCF. + +``` +9911 interrogationPackage-v3 OPERATION-PACKAGE ::= { +9912 -- Supplier is HLR or NPLR if Consumer is MSC +9913 -- Supplier is HLR if Consumer is gsmSCF +9914 CONSUMER INVOKES { +9915 sendRoutingInfo} } +``` + +9916 +9917 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9918 17.2.2.11 Void + +### 9919 17.2.2.12 Handover Control + +9920 This operation package includes the operations required for handover procedures between MSCs. + +``` +9921 handoverControlPackage-v3 OPERATION-PACKAGE ::= { +9922 -- Supplier is MSCB if Consumer is MSCA +9923 CONSUMER INVOKES { +9924 prepareHandover | +9925 forwardAccessSignalling} +9926 SUPPLIER INVOKES { +9927 sendEndSignal | +9928 processAccessSignalling | +9929 prepareSubsequentHandover} } +``` + +9930 +9931 The v2-equivalent package can be determined according to the rules described in clause 17.2.1. + +9932 The v1-equivalent package is defined as follows. + +``` +9933 handoverControlPackage-v1 OPERATION-PACKAGE ::= { +9934 -- Supplier is MSCB if Consumer is MSCA +9935 CONSUMER INVOKES { +9936 performHandover | +9937 forwardAccessSignalling | +9938 traceSubscriberActivity} +9939 SUPPLIER INVOKES { +9940 sendEndSignal | +9941 noteInternalHandover | +9942 processAccessSignalling | +9943 performSubsequentHandover} } +``` + +9944 + +### 9945 17.2.2.13 Subscriber Data management stand alone + +9946 This operation package includes the operations required for stand alone subscriber data management procedures +9947 between HLR and VLR or between HLR and SGSN. Also this operation package includes the operations required for +9948 stand alone subscriber data management procedures between CSS and VLR or between CSS and SGSN. For the CSS – +9949 VLR interface and CSS – SGSN interface only version 3 of this operation package is applicable. + +``` +9950 subscriberDataMngtStandAlonePackage-v3 OPERATION-PACKAGE ::= { +9951 -- Supplier is VLR or SGSN if Consumer is HLR or CSS +9952 CONSUMER INVOKES { +9953 insertSubscriberData | +9954 deleteSubscriberData} } +``` + +9956 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9957 17.2.2.14 Equipment management + +9958 This operation package includes the operations required for equipment management procedures between EIR and MSC +9959 or between EIR and SGSN. + +``` +9960 equipmentMngtPackage-v3 OPERATION-PACKAGE ::= { +9961 -- Supplier is EIR if Consumer is MSC +9962 -- Supplier is EIR if Consumer is SGSN +9963 CONSUMER INVOKES { +9964 checkIMEI} } +``` + +9966 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9967 17.2.2.15 Subscriber data management + +9968 This operation package includes the operations required for subscriber data management procedures between HLR and +9969 VLR or between HLR and SGSN. Also this operation package includes the operations required for subscriber data +9970 management procedures between CSS and VLR or between CSS and SGSN. For the CSS – VLR interface and CSS – +9971 SGSN interface only version 3 of this operation package is applicable. + +``` +9972 subscriberDataMngtPackage-v3 OPERATION-PACKAGE ::= { +9973 -- Supplier is VLR or SGSN if Consumer is HLR or CSS +9974 CONSUMER INVOKES { +9975 insertSubscriberData} } +``` + +9977 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9978 17.2.2.16 Location register restart + +9979 This operation package includes the operations required for location register restart procedures between HLR and VLR +9980 or between HLR and SGSN and also between CSS and VLR or between CSS and SGSN. + +``` +9981 resetPackage-v3 OPERATION-PACKAGE ::= { +9982 -- Supplier is VLR or SGSN if Consumer is HLR or CSS +9983 CONSUMER INVOKES { +9984 reset} } +``` + +9986 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +9987 For CSS-VLR interface and CSS-SGSN interface, only version 3 of this operation package is applicable. + +### 9988 17.2.2.17 Tracing stand-alone + +9989 This operation package includes the operations required for stand alone tracing procedures between HLR and VLR or +9990 between HLR and SGSN. + +``` +9991 tracingStandAlonePackage-v3 OPERATION-PACKAGE ::= { +9992 -- Supplier is VLR or SGSN if Consumer is HLR +9993 CONSUMER INVOKE { +9994 activateTraceMode | +9995 deactivateTraceMode } } +``` + +9996 +9997 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 9998 17.2.2.18 Functional SS handling + +9999 This operation package includes the operations required for functional supplementary services procedures between VLR +10000 and HLR. + +``` +10001 functionalSsPackage-v2 OPERATION-PACKAGE ::= { +10002 -- Supplier is HLR if Consumer is VLR +10003 CONSUMER INVOKE { +10004 registerSS | +10005 eraseSS | +10006 activateSS | +10007 deactivateSS | +10008 registerPassword | +10009 interrogateSS } +10010 SUPPLIER INVOKE { +10011 getPassword } } +``` + +10012 +10013 The v1-equivalent package can be determined according to the rules described in clause 17.2.1. + +### 10014 17.2.2.19 Tracing + +10015 This operation package includes the operations required for tracing procedures between HLR and VLR or between HLR +10016 and SGSN. + +``` +10017 tracingPackage-v3 OPERATION-PACKAGE ::= { +10018 -- Supplier is VLR or SGSN if Consumer is HLR +10019 CONSUMER INVOKE { +10020 activateTraceMode } } +``` + +10021 +10022 The v1-equivalent and v2-equivalent packages can be determined according to the rules described in clause 17.2.1. + +### 10023 17.2.2.20 Binding + +10024 This operation package includes the operation required to initialise a supplementary service procedure between VLR +10025 and HLR or between gsmSCF and HLR. + +``` +10026 bindingPackage-v1 OPERATION-PACKAGE ::= { +10027 -- Supplier is HLR if Consumer is VLR +10028 -- Supplier is gsmSCF if Consumer is HLR +10029 CONSUMER INVOKE { +10030 beginSubscriberActivity } } +``` + +10031 This package is v1 only. + +### 10032 17.2.2.21 Unstructured SS handling + +10033 This operation package includes the operations required for unstructured supplementary services procedures between +10034 VLR and HLR, between the HLR and the gsmSCF, and between HLR and HLR. + +``` +10035 unstructuredSsPackage-v2 OPERATION-PACKAGE ::= { +10036 -- Supplier is HLR if Consumer is VLR +10037 -- Supplier is gsmSCF or HLR if Consumer is HLR +10038 CONSUMER INVOKES { +10039 processUnstructuredSS-Request} +10040 SUPPLIER INVOKES { +10041 unstructuredSS-Request | +10042 unstructuredSS-Notify } +10043 } +``` + +10044 The v1-equivalent package is defined as follows: + +``` +10045 unstructuredSsPackage-v1 OPERATION-PACKAGE ::= { +10046 -- Supplier is HLR if Consumer is VLR +10047 -- Supplier is gsmSCF if Consumer is HLR +10048 CONSUMER INVOKES { +10049 processUnstructuredSS-Data } +10050 } +``` + +### 10051 17.2.2.22 MO Short message relay services + +10052 This operation package includes the operations required for short message relay service procedures between IWMSC +10053 and VMSC or between GMSC and MSC or between SGSN and IWMSC. + +``` +10054 mo-ShortMsgRelayPackage-v3 OPERATION-PACKAGE ::= { +10055 -- Supplier is IWMSC if Consumer is MSC +10056 -- Supplier is IWMSC if Consumer is SGSN +10057 CONSUMER INVOKES { +10058 mo-forwardSM } +10059 } +``` + +10060 The v2-equivalent package is defined as follows: + +``` +10061 shortMsgRelayPackage-v2 OPERATION-PACKAGE ::= { +10062 -- Supplier is IWMSC if Consumer is MSC +10063 -- Supplier is MSC or SGSN if Consumer is GMSC +10064 -- Supplier is IWMSC if Consumer is SGSN +10065 CONSUMER INVOKES { +10066 forwardSM } +10067 } +``` + +10068 The v1-equivalent package can be determined according to the rules described in clause 17.2.1. + +### 10069 17.2.2.23 Short message gateway services + +10070 This operation package includes the operations required for short message service gateway procedures between MSC +10071 and HLR. + +``` +10072 shortMsgGatewayPackage-v3 OPERATION-PACKAGE ::= { +10073 -- Supplier is HLR if Consumer is GMSC +10074 CONSUMER INVOKES { +10075 sendRoutingInfoForSM | +10076 reportSM-DeliveryStatus} +10077 SUPPLIER INVOKES { +10078 informServiceCentre } +10079 } +``` + +10080 The v2-equivalent package can be determined according to the rules described in clause 17.2.1. + +10081 The v1-equivalent package is defined as follows: + +``` +10082 shortMsgGatewayPackage-v1 OPERATION-PACKAGE ::= { +10083 -- Supplier is HLR if Consumer is GMSC +10084 CONSUMER INVOKES { +10085 sendRoutingInfoForSM | +10086 reportSMDeliveryStatus } +10087 } +``` + +### 10088 17.2.2.24 MT Short message relay services + +10089 This operation package includes the operations required for short message relay service procedures between GMSC and +10090 MSC or between GMSC and SGSN. + +``` +10091 mt-ShortMsgRelayPackage-v3 OPERATION-PACKAGE ::= { +10092 -- Supplier is MSC or SGSN or SMS-Router or IP-SM-GW if Consumer is GMSC +10093 CONSUMER INVOKES { +10094 mt-forwardSM} } +``` + +10095 +10096 The v2-equivalent package is: **shortMsgRelayPackage-v2** + +### 10097 17.2.2.25 Void + +### 10098 17.2.2.26 Message waiting data management + +10099 This operation package includes the operations required for short message waiting data procedures between HLR and +10100 VLR, between HLR and SGSN. + +``` +10101 mwdMngtPackage-v3 OPERATION-PACKAGE ::= { +10102 -- Supplier is HLR if Consumer is SGSN +10103 -- Supplier is HLR if Consumer is VLR +10104 CONSUMER INVOKES { +10105 readyForSM} } +``` + +10106 +10107 The v2-equivalent package can be determined according to the rules described in clause 17.2.1. + +10108 +10109 The v1-equivalent package is defined as follows: + +``` +10110 mwdMngtPackage-v1 OPERATION-PACKAGE ::= { +10111 -- Supplier is HLR if Consumer is VLR +10112 CONSUMER INVOKES { +10113 noteSubscriberPresent} } +``` + +### 10115 17.2.2.27 Alerting + +10116 This operation package includes the operations required for alerting between HLR and IWMSC. + +``` +10117 alertingPackage-v2 OPERATION-PACKAGE ::= { +10118 -- Supplier is IWMSC if Consumer is HLR +10119 CONSUMER INVOKES { +10120 alertServiceCentre} } +``` + +10121 +10122 The v1-equivalent package is defined as follows. + +``` +10123 alertingPackage-v1 OPERATION-PACKAGE ::= { +10124 -- Supplier is IWMSC if Consumer is HLR +10125 CONSUMER INVOKES { +10126 alertServiceCentreWithoutResult} } +``` + +### 10128 17.2.2.28 Data restoration + +10129 This operation package includes the operations required for VLR data restoration between HLR and VLR. + +``` +10130 dataRestorationPackage-v3 OPERATION-PACKAGE ::= { +10131 -- Supplier is HLR if Consumer is VLR +10132 CONSUMER INVOKES { +10133 restoreData} } +``` + +10134 +10135 The v2-equivalent package can be determined according to the rules described in clause 17.2.1. + +10136 The v1-equivalent package is: **infoRetrievalPackage-v1** + +### 10137 17.2.2.29 Purging + +10138 This operation package includes the operations required for purging between HLR and VLR or between HLR and +10139 SGSN. + +``` +10140 purgingPackage-v3 OPERATION-PACKAGE ::= { +10141 -- Supplier is HLR if Consumer is VLR +10142 -- Supplier is HLR if Consumer is SGSN +10143 CONSUMER INVOKES { +10144 purgeMS } } +``` + +10146 The v2-equivalent package can be determined according to the rules described in clause 17.2.1. + +### 10147 17.2.2.30 Subscriber information enquiry + +10148 This operation package includes the operations required for subscriber information enquiry procedures between HLR +10149 and VLR or between HLR and SGSN. + +``` +10150 subscriberInformationEnquiryPackage-v3 OPERATION-PACKAGE ::= { +10151 -- Supplier is VLR or SGSN if Consumer is HLR +10152 CONSUMER INVOKES { +10153 provideSubscriberInfo } } +``` + +10155 This package is v3 only. + +### 10156 17.2.2.31 Any time information enquiry + +10157 This operation package includes the operations required for any time information enquiry procedures between gsmSCF +10158 and HLR or between gsmSCF and GMLC or between gsmSCF and NPLR. + +``` +10159 anyTimeInformationEnquiryPackage-v3 OPERATION-PACKAGE ::= { +10160 -- Supplier is HLR or GMLC or NPLR if Consumer is gsmSCF +10161 CONSUMER INVOKES { +10162 anyTimeInterrogation } } +``` + +10164 This package is v3 only. + +### 10165 17.2.2.32 Group Call Control + +10166 This operation package includes the operations required for group call and broadcast call procedures between MSCs. + +``` +10167 groupCallControlPackage-v3 OPERATION-PACKAGE ::= { +10168 -- Supplier is relay MSC if Consumer is anchor MSC +10169 CONSUMER INVOKES { +10170 prepareGroupCall | +10171 forwardGroupCallSignalling } +10172 SUPPLIER INVOKES { +10173 sendGroupCallEndSignal | +10174 processGroupCallSignalling } } +``` + +10176 This package is v3 only. + +### 10177 17.2.2.32A Group Call Info Retrieval + +10178 This operation package includes the operations required for group call and broadcast call info retrieval between MSCs. + +``` +10179 groupCallInfoRetrievalPackage-v3 OPERATION-PACKAGE ::= { +10180 -- Supplier is group call serving MSC if Consumer is visited MSC +10181 -- Supplier is visited MSC if Consumer is group call serving MSC +10182 CONSUMER INVOKES { +10183 sendGroupCallInfo } } +``` + +10185 This package is v3 only. + +10186 17.2.2.33 Void + +10187 17.2.2.34 Void + +10188 17.2.2.35 Gprs location updating + +10189 This operation package includes the operations required for the gprs location management procedures between HLR +10190 and SGSN. + +``` +10191 gprsLocationUpdatingPackage-v3 OPERATION-PACKAGE ::= { +10192 -- Supplier is HLR if Consumer is SGSN +10193 CONSUMER INVOKES { +10194 updateGprsLocation} } +``` + +10195 + +10196 This package is v3 only. + +10197 17.2.2.36 Gprs Interrogation + +10198 This operation package includes the operations required for interrogation procedures between HLR and GGSN. + +``` +10199 gprsInterrogationPackage-v4 OPERATION-PACKAGE ::= { +10200 -- Supplier is HLR if Consumer is GGSN +10201 CONSUMER INVOKES { +10202 sendRoutingInfoForGprs} } +``` + +10203 + +10204 The v3-equivalent package is defined as follows. + +10205 + +``` +10206 gprsInterrogationPackage-v3 OPERATION-PACKAGE ::= { +10207 -- Supplier is HLR if Consumer is GGSN +10208 CONSUMER INVOKES { +10209 sendRoutingInfoForGprs} } +``` + +10210 + +10211 17.2.2.37 Failure reporting + +10212 This operation package includes the operations required for failure reporting between HLR and GGSN. + +``` +10213 failureReportingPackage-v3 OPERATION-PACKAGE ::= { +10214 -- Supplier is HLR if Consumer is GGSN +10215 CONSUMER INVOKES { +10216 failureReport} } +``` + +10217 + +10218 This package is v3 only. + +10219 17.2.2.38 GPRS notifying + +10220 This operation package includes the operations required for notifying that GPRS subscriber is present between HLR and +10221 GGSN. + +``` +10222 gprsNotifyingPackage-v3 OPERATION-PACKAGE ::= { +10223 -- Supplier is GGSN if Consumer is HLR +10224 CONSUMER INVOKES { +10225 noteMsPresentForGprs} } +``` + +10226 + +10227 This package is v3 only. + +### 10228 17.2.2.39 Supplementary Service invocation notification + +10229 This operation package includes the operations required for Supplementary Service invocation notification procedures +10230 between the MSC and the gsmSCF and between the HLR and the gsmSCF. + +``` +10231 ss-InvocationNotificationPackage-v3 OPERATION-PACKAGE ::= { +10232 -- Supplier is gsmSCF if Consumer is MSC +10233 -- Supplier is gsmSCF if Consumer is HLR +10234 CONSUMER INVOKES { +10235 ss-InvocationNotification } } +``` + +10236 +10237 This package is v3 only. + +### 10238 17.2.2.40 Set Reporting State + +10239 This operation package includes the operation required for procedures between HLR and VLR to set the reporting state. + +``` +10240 setReportingStatePackage-v3 OPERATION-PACKAGE ::= { +10241 -- Supplier is VLR if Consumer is HLR +10242 CONSUMER INVOKES { +10243 setReportingState } } +``` + +10244 +10245 This package is v3 only. + +### 10246 17.2.2.41 Status Report + +10247 This operation package includes the operation required for procedures between VLR and HLR to report call results and +10248 events. + +``` +10249 statusReportPackage-v3 OPERATION-PACKAGE ::= { +10250 -- Supplier is HLR if Consumer is VLR +10251 CONSUMER INVOKES { +10252 statusReport } } +``` + +10253 +10254 This package is v3 only. + +### 10255 17.2.2.42 Remote User Free + +10256 This operation package includes the operation required by the HLR to indicate to the VLR that the remote user is free. + +``` +10257 remoteUserFreePackage-v3 OPERATION-PACKAGE ::= { +10258 -- Supplier is VLR if Consumer is HLR +10259 CONSUMER INVOKES { +10260 remoteUserFree } } +``` + +10261 +10262 This package is v3 only. + +### 10263 17.2.2.43 Call Completion + +10264 This operation package includes the operations required for procedures between VLR and HLR for subscriber control of +10265 call completion services. + +``` +10266 callCompletionPackage-v3 OPERATION-PACKAGE ::= { +10267 -- Supplier is HLR if Consumer is VLR +10268 CONSUMER INVOKES { +10269 registerCC-Entry | +10270 eraseCC-Entry } } +``` + +10271 +10272 This package is v3 only. + +### 10273 17.2.2.44 Location service gateway services + +10274 This operation package includes the operations required for location service gateway procedures between GMLC and +10275 HLR. + +``` +10276 LocationSvcGatewayPackage-v3 OPERATION-PACKAGE ::= { +10277 -- Supplier is HLR if Consumer is GMLC +10278 CONSUMER INVOKES { +10279 sendRoutingInfoForLCS} } +``` + +10281 This package is v3 only. + +## 10282 17.2.2.45 Location service enquiry + +10283 This operation package includes the operations required for the location service enquiry procedures between GMLC and +10284 MSC and between GMLC and SGSN. + +``` +10285 LocationSvcEnquiryPackage-v3 OPERATION-PACKAGE ::= { +10286 -- Supplier is MSC or SGSN if Consumer is GMLC +10287 CONSUMER INVOKES { +10288 provideSubscriberLocation} } +``` + +10290 This package is v3 only. + +## 10291 17.2.2.45A Location service reporting + +10292 This operation package includes the operations required for the location service enquiry procedures between MSC and +10293 GMLC and between SGSN and GMLC. + +``` +10294 LocationSvcReportingPackage-v3 OPERATION-PACKAGE ::= { +10295 -- Supplier is GMLC if Consumer is MSC +10296 -- Supplier is GMLC if Consumer is SGSN +10297 CONSUMER INVOKES { +10298 subscriberLocationReport} } +``` + +10299 + +10300 17.2.2.46 Void + +10301 17.2.2.47 Void + +10302 17.2.2.48 Void + +## 10303 17.2.2.49 IST Alerting + +10304 This operation package includes the operation required for alerting procedures between the MSC (Visited MSC or +10305 Gateway MSC) and HLR. + +``` +10306 ist-AlertingPackage-v3 OPERATION-PACKAGE ::= { +10307 -- Supplier is HLR if Consumer is VMSC +10308 -- Supplier is HLR if Consumer is GMSC +10309 CONSUMER INVOKES { +10310 istAlert} } +``` + +10311 + +10312 This package is v3 only. + +## 10313 17.2.2.50 Service Termination + +10314 This operation package includes the operation required for immediate service termination procedures between the HLR +10315 and the Visited MSC or between the HLR and the Gateway MSC. + +``` +10316 serviceTerminationPackage-v3 OPERATION-PACKAGE ::= { +10317 -- Supplier is VMSC or GMSC if Consumer is HLR +10318 CONSUMER INVOKES { +10319 istCommand} } +``` + +10320 + +10321 This package is v3 only. + +### 10322 17.2.2.5.1 Mobility Management event notification + +10323 This operation package includes the operations required for Mobility Management event notification procedures +10324 between VLR and gsmSCF. + +``` +10325 mm-EventReportingPackage-v3 OPERATION-PACKAGE ::= { +10326 -- Supplier is gsmSCF if Consumer is VLR +10327 CONSUMER INVOKES { +10328 noteMM-Event} } +``` + +10329 This package is v3 only. + +### 10330 17.2.2.5.2 Any time information handling + +10331 This operation package includes the operations required for any time information handling procedures between gsmSCF +10332 and HLR. + +``` +10333 anyTimeInformationHandlingPackage-v3 OPERATION-PACKAGE ::= { +10334 -- Supplier is HLR if Consumer is gsmSCF +10335 CONSUMER INVOKES { +10336 anyTimeSubscriptionInterrogation | +10337 anyTimeModification} } +``` + +10338 +10339 This package is v3 only. + +### 17.2.2.5.3 Subscriber Data modification notification + +This operation package includes the operations required for Subscriber Data modification notification procedures between HLR and gsmSCF. + +``` +subscriberDataModificationNotificationPackage-v3 OPERATION-PACKAGE ::= { + -- Supplier is gsmSCF if Consumer is HLR + CONSUMER INVOKES { + noteSubscriberDataModified} } +``` + +This package is v3 only. + +### 10340 17.2.2.5.4 Authentication Failure Report + +10341 This operation package includes the operation required for procedures between VLR and HLR or the SGSN and the +10342 HLR for reporting of authentication failures. + +``` +10343 authenticationFailureReportPackage-v3 OPERATION-PACKAGE ::= { +10344 -- Supplier is HLR if Consumer is VLR +10345 -- Supplier is HLR if Consumer is SGSN +10346 CONSUMER INVOKES { +10347 authenticationFailureReport} } +``` + +10348 +10349 This package is v3 only. + +### 10350 17.2.2.5.5 Resource Management + +10351 This operation package includes the operation required for procedures between GMSC and VMSC for resource +10352 management purpose. + +``` +10353 resourceManagementPackage-v3 OPERATION-PACKAGE ::= { +10354 -- Supplier is VMSC if Consumer is GMSC +10355 CONSUMER INVOKES { +10356 releaseResources} } +``` + +10357 +10358 This package is v3 only. + +## 10359 17.2.2.56 MT Short message relay VGCS services + +10360 This operation package includes the operations required for short message relay service procedures between SMS +10361 GMSC and MSC. + +``` +10362 mt-ShortMsgRelay-VGCS-Package-v3 OPERATION-PACKAGE ::= { +10363 -- Supplier is MSC if Consumer is GMSC +10364 CONSUMER INVOKES { +10365 mt-forwardSM-VGCS } } +``` + +10366 +10367 This package is v3 only. + +## 10368 17.2.2.57 Vcsg location updating + +10369 This operation package includes the operations required for the vcsg location management procedures between CSS and +10370 VLR or between CSS and SGSN. + +``` +10371 vcsgLocationUpdatingPackage-v3 OPERATION-PACKAGE ::= { +10372 -- Supplier is CSS if Consumer is VLR or SGSN +10373 CONSUMER INVOKES { +10374 updateVcsgLocation } } +``` + +10375 + +10376 This operation package is v3 only. + +## 10377 17.2.2.58 Vcsg location cancellation + +10378 This operation package includes the operations required for the vcsg location cancellation procedures between CSS and +10379 VLR or between CSS and SGSN. + +``` +10380 vcsgLocationCancellationPackage-v3 OPERATION-PACKAGE ::= { +10381 -- Supplier is VLR or SGSN if Consumer is CSS +10382 CONSUMER INVOKES { +10383 cancelVcsgLocation } } +``` + +10384 + +10385 This operation package is v3 only. + +10386 + +# 10387 17.3 Application contexts + +## 10388 17.3.1 General aspects + +10389 An application-context is assigned for each dialogue established by a MAP-user. In the present document each +10390 application-context is assigned a name which is supplied in the MAP-OPEN Req primitive by the MAP-User and +10391 transmitted to the peer under certain circumstances. + +10392 The following ASN.1 information object class is used to describe the main aspects of application-contexts in the +10393 following clauses: + +``` +10394 APPLICATION-CONTEXT ::= CLASS { +10395 &Symmetric OPERATION-PACKAGE OPTIONAL, +10396 &InitiatorConsumerOf OPERATION-PACKAGE OPTIONAL, +10397 &ResponderConsumerOf OPERATION-PACKAGE OPTIONAL, +10398 &code OBJECT IDENTIFIER } +10399 WITH SYNTAX { +10400 [ OPERATIONS OF &Symmetric ] +10401 [ INITIATOR CONSUMER OF &InitiatorConsumerOf +10402 RESPONDER CONSUMER OF &ResponderConsumerOf +10403 ID &code ] +10404 } +``` + +10405 + +10406 The following definitions are used throughout this clause: + +- 10407 - v1-application-context: An application-context which contains only v1-packages and uses only TC v1 facilities; +- 10408 - v1 context set: the set of v1-application-contexts defined in the present document. +- 10409 - vn-application-context (n>=2): An application-context which contains only vn-packages; + +10410 The names of v1-application-contexts are suffixed by "-v1" while other names are suffixed by "-vn" where n>=2. + +10411 Application-contexts which do not belong to the v1 context set use v2 TC facilities. + +10412 The last component of each application-context-name (i.e. the last component of the object identifier value) assigned to +10413 an application-context which belongs to the v1 context set indicates explicitly "version1". + +10414 For each application-context which does not belong to the "v1 context set" there is a v1-equivalent application context. +10415 This is a v1-application-context which includes the v1-equivalents of the packages included in the original context. + +10416 Each application-context uses the abstract-syntax associated with the operation-packages it includes and uses the +10417 transfer-syntax derived from it by applying the encoding rules defined in clause 17.1.1. + +10418 ACs which do not belong to the v1 context set require the support of the abstract-syntax identified by the object +10419 identifier value: MAP-DialogueInformation.map-Dialogue-AS defined in clause 17.4. + +## 10420 17.3.2 Application context definitions + +### 10421 17.3.2.1 Void + +### 10422 17.3.2.2 Location Updating + +10423 This application context is used between HLR and VLR for location updating procedures. + +``` +10424 networkLocUpContext-v3 APPLICATION-CONTEXT ::= { +10425 -- Responder is HLR if Initiator is VLR +10426 INITIATOR CONSUMER OF { +10427 locationUpdatingPackage-v3 | +10428 dataRestorationPackage-v3} +10429 RESPONDER CONSUMER OF { +10430 subscriberDataMngtPackage-v3 | +10431 tracingPackage-v3} +10432 ID {map-ac networkLocUp(1) version3(3)} } +``` + +10434 The following application-context-name is assigned to the v2-equivalent application-context: + +| | | +|-------|-----------------------------------------| +| 10435 | ID {map-ac networkLocUp(1) version2(2)} | +|-------|-----------------------------------------| + +10437 The following application-context-name is assigned to the v1-equivalent application-context: + +| | | +|-------|-----------------------------------------| +| 10438 | ID {map-ac networkLocUp(1) version1(1)} | +|-------|-----------------------------------------| + +### 10440 17.3.2.3 Location Cancellation + +10441 This application context is used between HLR and VLR or between HLR and SGSN for location cancellation +10442 procedures. For the HLR - SGSN interface only version 3 of this application context is applicable. + +``` +10443 locationCancellationContext-v3 APPLICATION-CONTEXT ::= { +10444 -- Responder is VLR or SGSN if Initiator is HLR +10445 INITIATOR CONSUMER OF { +10446 locationCancellationPackage-v3} +10447 ID {map-ac locationCancel(2) version3(3)} } +``` + +10449 The following application-context-name is assigned to the v2-equivalent application-context: + +| | | +|-------|-------------------------------------------| +| 10450 | ID {map-ac locationCancel(2) version2(2)} | +|-------|-------------------------------------------| + +10451 + +10452 The following application-context-name is assigned to the v1-equivalent application-context: + +| | | | +|-------|----|-----------------------------------------------| +| 10453 | ID | map-ac locationCancel (2) version1 (1) | +| 10454 | | | + +### 10455 17.3.2.4 Roaming number enquiry + +10456 This application context is used between HLR and VLR for roaming number enquiry procedures. + +| | | | +|-------|-----------------------------------------------|---------------------------| +| 10457 | roamingNumberEnquiryContext-v3 | APPLICATION-CONTEXT ::= { | +| 10458 | -- Responder is VLR if Initiator is HLR | | +| 10459 | INITIATOR CONSUMER OF { | | +| 10460 | roamingNumberEnquiryPackage-v3} | | +| 10461 | ID {map-ac roamingNbEnquiry (3) version3 (3)} | } | +| 10462 | | | + +10463 The following application-context-name is assigned to the v2-equivalent application-context: + +| | | | +|-------|----|---------------------------------------------------| +| 10464 | ID | {map-ac roamingNbEnquiry (3) version2 (2)} | +| 10465 | | | + +10466 The following application-context-name is assigned to the v1-equivalent application-context: + +| | | | +|-------|----|---------------------------------------------------| +| 10467 | ID | {map-ac roamingNbEnquiry (3) version1 (1)} | +| 10468 | | | + +### 10469 17.3.2.5 Void + +### 10470 17.3.2.6 Location Information Retrieval + +10471 This application-context is used between GMSC and HLR or between GMSC and NPLR or between gsmSCF and HLR +10472 when retrieving location information. For the GMSC - NPLR interface version 1, version 2 and version 3 of this +10473 application context are applicable. + +| | | | +|-------|--------------------------------------------------|---------------------------| +| 10474 | locationInfoRetrievalContext-v3 | APPLICATION-CONTEXT ::= { | +| 10475 | -- Responder is HLR or NPLR if Initiator is GMSC | | +| 10476 | -- Responder is HLR if Initiator is gsmSCF | | +| 10477 | INITIATOR CONSUMER OF { | | +| 10478 | interrogationPackage-v3} | | +| 10479 | ID {map-ac locInfoRetrieval (5) version3 (3)} | } | +| 10480 | | | + +10481 The following application-context-name is assigned to the v2-equivalent application-context: + +| | | | +|-------|----|---------------------------------------------------| +| 10482 | ID | {map-ac locInfoRetrieval (5) version2 (2)} | +| 10483 | | | +| 10484 | | | + +10485 The following application-context-name is assigned to the v1-equivalent application-context: + +| | | | +|-------|----|---------------------------------------------------| +| 10486 | ID | {map-ac locInfoRetrieval (5) version1 (1)} | +| 10487 | | | + +### 10488 17.3.2.7 Call control transfer + +10489 This application context is used for the call control transfer procedure between the VMSC and the GMSC. + +| | | | +|-------|--------------------------------------------------|---------------------------| +| 10490 | callControlTransferContext-v4 | APPLICATION-CONTEXT ::= { | +| 10491 | -- Responder is GMSC if Initiator is VMSC | | +| 10492 | INITIATOR CONSUMER OF { | | +| 10493 | callControlTransferPackage-v4} | | +| 10494 | ID {map-ac callControlTransfer (6) version4 (4)} | } | +| 10495 | | | + +10496 The following application-context-name is assigned to the v3-equivalent application-context: + +| | | | +|-------|----|------------------------------------------------------| +| 10497 | ID | {map-ac callControlTransfer (6) version3 (3)} | +|-------|----|------------------------------------------------------| + +10498 17.3.2.8 Void + +10499 17.3.2.9 Void + +10500 17.3.2.10 Void + +10501 17.3.2.11 Location registers restart + +10502 This application context is used between HLR and VLR or between HLR and SGSN for location register restart +10503 procedures or between CSS and VLR or between CSS and SGSN for CSG Subscriber Server restart procedures. For the +10504 HLR - VLR interface and for the HLR - SGSN interface version 1, version 2 and version 3 of this application context +10505 are applicable For the CSS - VLR interface and the CSS - SGSN interface version 3 of this application context is +10506 applicable. + +``` +10507 resetContext-v3 APPLICATION-CONTEXT ::= { +10508 -- Responder is VLR or SGSN if Initiator is HLR or CSS +10509 INITIATOR CONSUMER OF { +10510 resetPackage-v3} +10511 ID {map-ac reset(10) version3(3)} } +``` + +10513 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10514 ID {map-ac reset(10) version2(2)} +``` + +10516 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10517 ID {map-ac reset(10) version1(1)} +``` + +10519 17.3.2.12 Handover control + +10520 This application context is used for handover procedures between MSCs. + +``` +10521 handoverControlContext-v3 APPLICATION-CONTEXT ::= { +10522 -- Responder is MSCB if Initiator is MSCA +10523 INITIATOR CONSUMER OF { +10524 handoverControlPackage-v3} +10525 ID {map-ac handoverControl(11) version3(3)} } +``` + +10526 + +10527 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10528 ID {map-ac handoverControl(11) version2(2)} +``` + +10529 + +10530 + +10531 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10532 ID {map-ac handoverControl(11) version1(1)} +``` + +10533 + +10534 17.3.2.13 IMSI Retrieval + +10535 This application context is used for IMSI retrieval between HLR and VLR. + +``` +10536 imsiRetrievalContext-v2 APPLICATION-CONTEXT ::= { +10537 -- Responder is HLR if Initiator is VLR +10538 INITIATOR CONSUMER OF { +10539 imsi-RetrievalPackage-v2} +10540 ID {map-ac imsiRetrieval(26) version2(2)} } +``` + +10541 + +10542 This application-context is v2 only. + +### 10543 17.3.2.14 Equipment Management + +10544 This application context is used for equipment checking between MSC and EIR or between SGSN and EIR. For the +10545 SGSN - EIR interface version 1 and version 2 and version 3 of this application context are applicable: + +``` +10546 equipmentMngtContext-v3 APPLICATION-CONTEXT ::= { +10547 -- Responder is EIR if Initiator is MSC +10548 -- Responder is EIR if Initiator is SGSN +10549 INITIATOR CONSUMER OF { +10550 equipmentMngtPackage-v3} +10551 ID {map-ac equipmentMngt(13) version3(3)} } +``` + +10553 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10554 equipmentMngtContext-v2 APPLICATION-CONTEXT ::= { +10555 -- Responder is EIR if Initiator is MSC +10556 -- Responder is EIR if Initiator is SGSN +10557 INITIATOR CONSUMER OF { +10558 equipmentMngtPackage-v2} +10559 ID {map-ac equipmentMngt(13) version2(2)} } +``` + +10561 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10562 ID {map-ac equipmentMngt(13) version1(1)} +``` + +### 10564 17.3.2.15 Information retrieval + +10565 This application context is used for authentication information retrieval between HLR and VLR or between HLR and +10566 SGSN. For the HLR - SGSN interface version 1 and version 2 and version 3 of this application context are applicable. + +``` +10567 infoRetrievalContext-v3 APPLICATION-CONTEXT ::= { +10568 -- Responder is HLR if Initiator is VLR +10569 -- Responder is HLR if Initiator is SGSN +10570 INITIATOR CONSUMER OF { +10571 infoRetrievalPackage-v3} +10572 ID {map-ac infoRetrieval(14) version3(3)} } +``` + +10574 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10575 infoRetrievalContext-v2 APPLICATION-CONTEXT ::= { +10576 -- Responder is HLR if Initiator is VLR +10577 -- Responder is HLR if Initiator is SGSN +10578 INITIATOR CONSUMER OF { +10579 infoRetrievalPackage-v2} +10580 ID {map-ac infoRetrieval(14) version2(2)} } +``` + +10582 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10583 ID {map-ac infoRetrieval(14) version1(1)} +``` + +### 10585 17.3.2.16 Inter-VLR information retrieval + +10586 This application context is used for information retrieval between VLRs. + +``` +10587 interVlrInfoRetrievalContext-v3 APPLICATION-CONTEXT ::= { +10588 -- Responder is VLR if Initiator is VLR +10589 INITIATOR CONSUMER OF { +10590 interVlrInfoRetrievalPackage-v3} +10591 ID {map-ac interVlrInfoRetrieval(15) version3(3)} } +``` + +10593 The v2-equivalent application-context is: + +``` +10594 interVlrInfoRetrievalContext-v2 APPLICATION-CONTEXT ::= { +10595 -- Responder is VLR if Initiator is VLR +10596 INITIATOR CONSUMER OF { +10597 interVlrInfoRetrievalPackage-v2} +10598 ID {map-ac interVlrInfoRetrieval(15) version2(2)} } +``` + +10600 The v1-equivalent application-context is: + +``` +10601 ID {map-ac infoRetrieval(14) version1(1)} +``` + +10602 + +### 10603 17.3.2.17 Stand Alone Subscriber Data Management + +10604 This application context is used for stand alone subscriber data management between HLR and VLR or between HLR +10605 and SGSN. For the HLR - SGSN interface only version 3 of this application context is applicable. Also this application +10606 context is used for stand alone subscriber data management between CSS and VLR or between CSS and SGSN. For the +10607 CSS – VLR interface and CSS – SGSN interface only version 3 of this application context is applicable: + +``` +10608 subscriberDataMngtContext-v3 APPLICATION-CONTEXT ::= { +10609 -- Responder is VLR or SGSN if Initiator is HLR or CSS +10610 INITIATOR CONSUMER OF { +10611 subscriberDataMngtStandAlonePackage-v3} +10612 ID {map-ac subscriberDataMngt(16) version3(3)} } +``` + +10613 +10614 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10615 ID {map-ac subscriberDataMngt(16) version2(2)} +``` + +10616 +10617 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10618 ID {map-ac subscriberDataMngt(16) version1(1)} +``` + +### 10620 17.3.2.18 Tracing + +10621 This application context is used between HLR and VLR or between HLR and SGSN for stand alone tracing control +10622 procedures. For the HLR - SGSN interface version 1, version 2 and version 3 of this application context are applicable. + +``` +10623 tracingContext-v3 APPLICATION-CONTEXT ::= { +10624 -- Responder is VLR or SGSN if Initiator is HLR +10625 INITIATOR CONSUMER OF { +10626 tracingStandAlonePackage-v3} +10627 ID {map-ac tracing(17) version3(3)} } +``` + +10628 + +10629 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10630 ID {map-ac tracing(17) version2(2)} +``` + +10631 +10632 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10633 ID {map-ac tracing(17) version1(1)} +``` + +### 10635 17.3.2.19 Network functional SS handling + +10636 This application context is used for functional-like SS handling procedures between VLR and HLR. + +``` +10637 networkFunctionalSsContext-v2 APPLICATION-CONTEXT ::= { +10638 -- Responder is HLR, Initiator is VLR +10639 INITIATOR CONSUMER OF { +10640 functionalSsPackage-v2} +10641 ID {map-ac networkFunctionalSs(18) version2(2)} } +``` + +10642 + +10643 The v1-equivalent application-context is defined as follows: + +``` +10644 networkFunctionalSsContext-v1 APPLICATION-CONTEXT ::= { +10645 -- Responder is HLR, Initiator is VLR +10646 INITIATOR CONSUMER OF { +10647 functionalSsPackage-v1 | +10648 unstructuredSsPackage-v1 | +10649 bindingPackage-v1} +10650 ID {map-ac networkFunctionalSs(18) version1(1)} } +``` + +10651 + +### 10652 17.3.2.20 Network unstructured SS handling + +10653 This application context is used for handling stimuli-like procedures between HLR and VLR, between the HLR and +10654 gsmSCF, and between HLR and HLR. + +``` +10655 networkUnstructuredSsContext-v2 APPLICATION-CONTEXT ::= { +10656 -- Responder is HLR, Initiator is VLR +10657 -- Responder is VLR, Initiator is HLR +10658 -- Responder is gsmSCF, Initiator is HLR +10659 -- Responder is HLR, Initiator is gsmSCF +10660 -- Responder is HLR, Initiator is HLR +10661 OPERATIONS OF { +10662 unstructuredSsPackage-v2} +10663 ID {map-ac networkUnstructuredSs(19) version2(2)} } +``` + +10665 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10666 ID {map-ac networkFunctionalSs(18) version1(1)} +``` + +### 10668 17.3.2.21 Short Message Gateway + +10669 This application context is used for short message gateway procedures. + +``` +10670 shortMsgGatewayContext-v3 APPLICATION-CONTEXT ::= { +10671 -- Responder is HLR if Initiator is GMSC +10672 INITIATOR CONSUMER OF { +10673 shortMsgGatewayPackage-v3} +10674 ID {map-ac shortMsgGateway(20) version3(3)} } +``` + +10676 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10677 ID {map-ac shortMsgGateway(20) version2(2)} +``` + +10679 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10680 ID {map-ac shortMsgGateway(20) version1(1)} +``` + +### 10682 17.3.2.22 Mobile originating Short Message Relay + +10683 This application context is used between MSC and IWMSC or between SGSN and IWMSC for mobile originating short +10684 message relay procedures. For the SGSN - IWMSC interface version 1, version 2 and version 3 of this application +10685 context are applicable. + +``` +10686 shortMsgMO-RelayContext-v3 APPLICATION-CONTEXT ::= { +10687 -- Responder is IWMSC if Initiator is MSC +10688 -- Responder is IWMSC if Initiator is SGSN +10689 INITIATOR CONSUMER OF { +10690 mo-ShortMsgRelayPackage-v3} +10691 ID {map-ac shortMsgMO-Relay(21) version3(3)} } +``` + +10693 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10694 ID {map-ac shortMsgMO-Relay(21) version2(2)} +``` + +10696 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10697 ID {map-ac shortMsg-Relay(21) version1(1)} +``` + +10699 17.3.2.23 Void + +10700 17.3.2.24 Short message alert + +10701 This application context is used for short message alerting procedures. + +``` +10702 shortMsgAlertContext-v2 APPLICATION-CONTEXT ::= { +10703 -- Responder is IWMSC if Initiator is HLR +10704 INITIATOR CONSUMER OF { +10705 alertingPackage-v2} +10706 ID {map-ac shortMsgAlert(23) version2(2)} } +``` + +10708 The following application-context-name is symbolically assigned to the v1-equivalent application-context: + +``` +10709 ID {map-ac shortMsgAlert(23) version1(1)} +10710 +``` + +10711 17.3.2.25 Short message waiting data management + +10712 This application context is used between VLR and HLR or between SGSN and HLR for short message waiting data +10713 management procedures. For the SGSN - HLR interface only version 3 of this application context is applicable. + +``` +10714 mwdMngtContext-v3 APPLICATION-CONTEXT ::= { +10715 -- Responder is HLR if Initiator is SGSN +10716 -- Responder is HLR if Initiator is VLR +10717 INITIATOR CONSUMER OF { +10718 mwdMngtPackage-v3} +10719 ID {map-ac mwdMngt(24) version3(3)} } +``` + +10720 + +10721 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10722 ID {map-ac mwdMngt(24) version2(2)} +10723 +``` + +10723 + +10724 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10725 ID {map-ac mwdMngt(24) version1(1)} +10726 +``` + +10726 + +10727 17.3.2.26 Mobile terminating Short Message Relay + +10728 This application context is used between GMSC and MSC or between GMSC and SGSN for mobile terminating short +10729 message relay procedures. For the GMSC - SGSN interface version 2 and version 3 of this application context and the +10730 equivalent version 1 application context are applicable. + +``` +10731 shortMsgMT-RelayContext-v3 APPLICATION-CONTEXT ::= { +10732 -- Responder is MSC or SGSN if Initiator is GMSC +10733 INITIATOR CONSUMER OF { +10734 mt-ShortMsgRelayPackage-v3} +10735 ID {map-ac shortMsgMT-Relay(25) version3(3)} } +``` + +10736 + +10737 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10738 ID {map-ac shortMsgMT-Relay(25) version2(2)} +10739 +``` + +10739 + +10740 The following application-context-name is assigned to the v1-equivalent application-context: + +``` +10741 ID {map-ac shortMsg-Relay(21) version1(1)} +10742 +``` + +10742 + +### 10743 17.3.2.27 MS purging + +10744 This application context is used between HLR and VLR or between HLR and SGSN for MS purging procedures. For +10745 the SGSN - HLR interface only version 3 of this application context is applicable. + +``` +10746 msPurgingContext-v3 APPLICATION-CONTEXT ::= { +10747 -- Responder is HLR if Initiator is VLR +10748 -- Responder is HLR if Initiator is SGSN +10749 INITIATOR CONSUMER OF { +10750 purgingPackage-v3} +10751 ID {map-ac msPurging(27) version3(3)} } +``` + +10752 +10753 The following application-context-name is assigned to the v2-equivalent application-context: + +``` +10754 ID {map-ac msPurging(27) version2(2)} +``` + +10755 + +### 10756 17.3.2.28 Subscriber information enquiry + +10757 This application context is used between HLR and VLR or between HLR and SGSN for subscriber information enquiry +10758 procedures. + +``` +10759 subscriberInfoEnquiryContext-v3 APPLICATION-CONTEXT ::= { +10760 -- Responder is VLR or SGSN if Initiator is HLR +10761 INITIATOR CONSUMER OF { +10762 subscriberInformationEnquiryPackage-v3} +10763 ID {map-ac subscriberInfoEnquiry(28) version3(3)} } +``` + +10764 +10765 This application-context is v3 only. + +### 10766 17.3.2.29 Any time information enquiry + +10767 This application context is used between gsmSCF and HLR or between gsmSCF and GMLC or between gsmSCF and +10768 NPLR for any time information enquiry procedures. + +``` +10769 anyTimeInfoEnquiryContext-v3 APPLICATION-CONTEXT ::= { +10770 -- Responder is HLR or GMLC or NPLR if Initiator is gsmSCF +10771 INITIATOR CONSUMER OF { +10772 anyTimeInformationEnquiryPackage-v3} +10773 ID {map-ac anyTimeInfoEnquiry(29) version3(3)} } +``` + +10774 +10775 This application-context is v3 only. + +### 10776 17.3.2.30 Group Call Control + +10777 This application context is used between anchor MSC and relay MSC for group call and broadcast call procedures. + +``` +10778 groupCallControlContext-v3 APPLICATION-CONTEXT ::= { +10779 -- Responder is relay MSC if Initiator is anchor MSC +10780 INITIATOR CONSUMER OF { +10781 groupCallControlPackage-v3} +10782 ID {map-ac groupCallControl(31) version3(3)} } +``` + +10783 +10784 This application-context is v3 only. + +### 10785 17.3.2.30A Group Call Info Retrieval + +10786 This application context is used between group call serving MSC and visited MSC for group call and broadcast call +10787 procedures. + +``` +10788 groupCallInfoRetControlContext-v3 APPLICATION-CONTEXT ::= { +10789 -- Responder is group call serving MSC if Initiator is visited MSC +10790 -- Responder is visited MSC if Initiator is group call serving MSC +10791 INITIATOR CONSUMER OF { +10792 groupCallInfoRetrievalPackage-v3} +10793 ID {map-ac groupCallInfoRetrieval(45) version3(3)} } +``` + +10794 +10795 This application-context is v3 only. + +10796 17.3.2.31 Void + +10797 17.3.2.32 Gprs Location Updating + +10798 This application context is used between HLR and SGSN for gprs location updating procedures. + +``` +10799 gprsLocationUpdateContext-v3 APPLICATION-CONTEXT ::= { +10800 -- Responder is HLR if Initiator is SGSN +10801 INITIATOR CONSUMER OF { +10802 gprsLocationUpdatingPackage-v3} +10803 RESPONDER CONSUMER OF { +10804 subscriberDataMngtPackage-v3 | +10805 tracingPackage-v3} +10806 ID {map-ac gprsLocationUpdate(32) version3(3)} } +``` + +10807 +10808 This application-context is v3 only. + +10809 17.3.2.33 Gprs Location Information Retrieval + +10810 This application context is used between HLR and GGSN when retrieving gprs location information. + +``` +10811 gprsLocationInfoRetrievalContext-v4 APPLICATION-CONTEXT ::= { +10812 -- Responder is HLR if Initiator is GGSN +10813 INITIATOR CONSUMER OF { +10814 gprsInterrogationPackage-v4} +10815 ID {map-ac gprsLocationInfoRetrieval(33) version4(4)} } +``` + +10816 + +10817 The following application-context-name is assigned to the v3-equivalent application-context: + +``` +10818 ID {map-ac gprsLocationInfoRetrieval(33) version3(3)} +``` + +10819 +10820 + +10821 17.3.2.34 Failure Reporting + +10822 This application context is used between HLR and GGSN to inform that network requested PDP-context activation has +10823 failed. + +``` +10824 failureReportContext-v3 APPLICATION-CONTEXT ::= { +10825 -- Responder is HLR if Initiator is GGSN +10826 INITIATOR CONSUMER OF { +10827 failureReportingPackage-v3} +10828 ID {map-ac failureReport(34) version3(3)} } +``` + +10829 + +10830 This application-context is v3 only. + +10831 17.3.2.35 GPRS Notifying + +10832 This application context is used between HLR and GGSN for notifying that GPRS subscriber is present again. + +``` +10833 gprsNotifyContext-v3 APPLICATION-CONTEXT ::= { +10834 -- Responder is GGSN if Initiator is HLR +10835 INITIATOR CONSUMER OF { +10836 gprsNotifyingPackage-v3} +10837 ID {map-ac gprsNotify(35) version3(3)} } +``` + +10838 + +10839 This application-context is v3 only. + +10840 17.3.2.36 Supplementary Service invocation notification + +10841 This application context is used between the MSC and the gsmSCF and between the HLR and the gsmSCF for +10842 Supplementary Service invocation notification procedures. + +``` +10843 ss-InvocationNotificationContext-v3 APPLICATION-CONTEXT ::= { +10844 -- Responder is gsmSCF, Initiator is MSC +10845 -- Responder is gsmSCF, Initiator is HLR +10846 INITIATOR CONSUMER OF { +10847 ss-InvocationNotificationPackage-v3} +10848 ID {map-ac ss-InvocationNotification(36) version3(3)} } +``` + +10849 +10850 This application-context is v3 only. + +10851 17.3.2.37 Reporting + +10852 This application context is used between HLR and VLR for reporting procedures. + +``` +10853 reportingContext-v3 APPLICATION-CONTEXT ::= { +10854 -- Responder is VLR if Initiator is HLR +10855 -- Responder is HLR if Initiator is VLR +10856 INITIATOR CONSUMER OF { +10857 setReportingStatePackage-v3 | +10858 statusReportPackage-v3 | +10859 remoteUserFreePackage-v3} +10860 RESPONDER CONSUMER OF { +10861 setReportingStatePackage-v3 | +10862 statusReportPackage-v3} +10863 ID {map-ac reporting(7) version3(3)} } +``` + +10864 +10865 This application-context is v3 only. + +10866 17.3.2.38 Call Completion + +10867 This application context is used between VLR and the HLR for subscriber control of call completion services. + +``` +10868 callCompletionContext-v3 APPLICATION-CONTEXT ::= { +10869 -- Responder is HLR if Initiator is VLR +10870 INITIATOR CONSUMER OF { +10871 callCompletionPackage-v3} +10872 ID {map-ac callCompletion(8) version3(3)} } +``` + +10873 +10874 This application-context is v3 only. + +10875 17.3.2.39 Location Service Gateway + +10876 This application context is used for location service gateway procedures. + +``` +10877 locationSvcGatewayContext-v3 APPLICATION-CONTEXT ::= { +10878 -- Responder is HLR if Initiator is GMLC +10879 INITIATOR CONSUMER OF { +10880 locationSvcGatewayPackage-v3} +10881 ID {map-ac locationSvcGateway(37) version3(3)} } +``` + +10882 + +10883 17.3.2.40 Location Service Enquiry + +10884 This application context is used for location service enquiry procedures. + +``` +10885 locationSvcEnquiryContext-v3 APPLICATION-CONTEXT ::= { +10886 -- Responder is MSC or SGSN if Initiator is GMLC +10887 -- Responder is GMLC if Initiator is MSC +10888 -- Responder is GMLC if Initiator is SGSN +10889 INITIATOR CONSUMER OF { +10890 locationSvcEnquiryPackage-v3 | +10891 locationSvcReportingPackage-v3} +10892 ID {map-ac locationSvcEnquiry(38) version3(3)} } +``` + +10893 + +10894 17.3.2.41 Void + +10895 17.3.2.42 Void + +10896 17.3.2.43 Void + +10897 17.3.2.44 IST Alerting + +10898 This application context is used between MSC (Visited MSC or Gateway MSC) and HLR for alerting services within +10899 IST procedures. + +``` +10900 istAlertingContext-v3 APPLICATION-CONTEXT ::= { +10901 -- Responder is HLR if Initiator is VMSC +10902 -- Responder is HLR if Initiator is GMSC +10903 INITIATOR CONSUMER OF { +10904 ist-AlertingPackage-v3} +10905 ID {map-ac alerting(4) version3(3)} } +``` + +10906 + +10907 This application-context is v3 only. + +10908 17.3.2.45 Service Termination + +10909 This application context is used between HLR and MSC (Visited MSC or Gateway MSC) for service termination +10910 services within IST procedures. + +``` +10911 serviceTerminationContext-v3 APPLICATION-CONTEXT ::= { +10912 -- Responder is VMSC or GMSC if Initiator is HLR +10913 INITIATOR CONSUMER OF { +10914 serviceTerminationPackage-v3} +10915 ID {map-ac serviceTermination(9) version3(3)} } +``` + +10916 + +10917 This application-context is v3 only. + +### 10918 17.3.2.46 Mobility Management event notification + +10919 This application context is used between VLR and gsmSCF for Mobility Management event notification procedures. + +``` +10920 mm-EventReportingContext-v3 APPLICATION-CONTEXT ::= { +10921 -- Responder is gsmSCF, Initiator is VLR +10922 INITIATOR CONSUMER OF { +10923 mm-EventReportingPackage-v3} +10924 ID {map-ac mm-EventReporting(42) version3(3)} } +``` + +10926 This application-context is v3 only. + +### 10927 17.3.2.47 Any time information handling + +10928 This application context is used between gsmSCF and HLR for any time information handling procedures. + +``` +10929 anyTimeInfohandlingContext-v3 APPLICATION-CONTEXT ::= { +10930 -- Responder is HLR if Initiator is gsmSCF +10931 INITIATOR CONSUMER OF { +10932 anyTimeInformationHandlingPackage-v3} +10933 ID {map-ac anyTimeInfoHandling(43) version3(3)} } +``` + +10935 This application-context is v3 only. + +### 10936 17.3.2.48 Subscriber Data modification notification + +This application context is used between HLR and gsmSCF for Subscriber Data modification notification procedures. + +``` +subscriberDataModificationNotificationContext-v3 APPLICATION-CONTEXT ::= { + -- Responder is gsmSCF, Initiator is HLR + INITIATOR CONSUMER OF { + subscriberDataModificationNotificationPackage-v3} + ID {map-ac subscriberDataModificationNotification(22) version3(3)} } +``` + +This application-context is v3 only. + +### 10937 17.3.2.49 Authentication Failure Report + +10938 This application context is used between VLR and HLR or SGSN and HLR for reporting of authentication failures. + +``` +10939 authenticationFailureReportContext-v3 APPLICATION-CONTEXT ::= { +10940 -- Responder is HLR if Initiator is VLR +10941 -- Responder is HLR if Initiator is SGSN +10942 INITIATOR CONSUMER OF { +10943 authenticationFailureReportPackage-v3 } +10944 ID {map-ac authenticationFailureReport(39) version3(3)} } +``` + +10946 This application-context is v3 only. + +### 10947 17.3.2.50 Resource Management + +10948 This application context is used between GMSC and VMSC for resource management purpose. + +``` +10949 resourceManagementContext-v3 APPLICATION-CONTEXT ::= { +10950 -- Responder is VMSC if Initiator is GMSC +10951 INITIATOR CONSUMER OF { +10952 resourceManagementPackage-v3 } +10953 ID {map-ac resourceManagement(44) version3(3)} } +``` + +10955 This application-context is v3 only. + +### 10956 17.3.2.51 Mobile terminating Short Message Relay VGCS + +10957 This application context is used between SMS-GMSC and MSC for mobile terminating short message relay procedures +10958 for VGCS. + +``` +10959 shortMsgMT-Relay-VGCS-Context-v3 APPLICATION-CONTEXT ::= { +10960 -- Responder is MSC if Initiator is SMS-GMSC +10961 INITIATOR CONSUMER OF { +10962 mt-ShortMsgRelay-VGCS-Package-v3} +10963 ID {map-ac shortMsgMT-Relay-VGCS(41) version3(3)} } +``` + +10965 This application-context is v3 only. + +### 10966 17.3.2.52 Vcsg Location Updating + +10967 This application context is used between CSS and VLR or between CSS and SGSN for vcsg location updating +10968 procedures. + +``` +10969 vcsgLocationUpdateContext-v3 APPLICATION-CONTEXT ::= { +10970 -- Responder is CSS if Initiator is VLR or SGSN +10971 INITIATOR CONSUMER OF { +10972 vcsgLocationUpdatingPackage-v3} +10973 RESPONDER CONSUMER OF { +10974 subscriberDataMngtPackage-v3} +10975 ID {map-ac vcsgLocationUpdate(46) version3(3)} } +``` + +10977 This application-context is v3 only. + +### 10978 17.3.2.53 Vcsg Location Cancellation + +10979 This application context is used between CSS and VLR or between CSS and SGSN for vcsg location cancellation +10980 procedures. + +``` +10981 vcsgLocationCancellationContext-v3 APPLICATION-CONTEXT ::= { +10982 -- Responder is VLR or SGSN if Initiator is CSS +10983 INITIATOR CONSUMER OF { +10984 vcsgLocationCancellationPackage-v3} +10985 ID {map-ac vcsgLocationCancel(47) version3(3)} } +``` + +10987 This application-context is v3 only. + +10988 + +10989 + +## 10990 17.3.3 ASN.1 Module for application-context-names + +The following ASN.1 module summarises the application-context-name assigned to MAP application-contexts. + +``` +10991 MAP-ApplicationContexts { +10992 itu-t identified-organization (4) etsi (0) mobileDomain (0) +10993 gsm-Network (1) modules (3) map-ApplicationContexts (2) version21 (21)} +10994 DEFINITIONS +10995 BEGIN +10996 ::= +10997 BEGIN +11000 +11001 +11002 -- EXPORTS everything +11003 +11004 +11005 IMPORTS +11006 gsm-NetworkId, +11007 ac-Id +11008 FROM MobileDomainDefinitions { +11009 itu-t (0) identified-organization (4) etsi (0) mobileDomain (0) +11010 mobileDomainDefinitions (0) version1 (1)} +11011 ; +11012 +``` + +``` +11013 -- application-context-names +11014 +11015 map-ac OBJECT IDENTIFIER ::= {gsm-NetworkId ac-Id} +11016 +11017 networkLocUpContext-v3 OBJECT IDENTIFIER ::= +11018 {map-ac networkLocUp(1) version3(3)} +11019 +11020 locationCancellationContext-v3 OBJECT IDENTIFIER ::= +11021 {map-ac locationCancel(2) version3(3)} +11022 +11023 roamingNumberEnquiryContext-v3 OBJECT IDENTIFIER ::= +11024 {map-ac roamingNbEnquiry(3) version3(3)} +11025 +11026 authenticationFailureReportContext-v3 OBJECT IDENTIFIER ::= +11027 {map-ac authenticationFailureReport(39) version3(3)} +11028 +11029 locationInfoRetrievalContext-v3 OBJECT IDENTIFIER ::= +11030 {map-ac locInfoRetrieval(5) version3(3)} +11031 +11032 resetContext-v3 OBJECT IDENTIFIER ::= +11033 {map-ac reset(10) version3(3)} +11034 +11035 handoverControlContext-v3 OBJECT IDENTIFIER ::= +11036 {map-ac handoverControl(11) version3(3)} +11037 +11038 equipmentMngtContext-v3 OBJECT IDENTIFIER ::= +11039 {map-ac equipmentMngt(13) version3(3)} +11040 +11041 infoRetrievalContext-v3 OBJECT IDENTIFIER ::= +11042 {map-ac infoRetrieval(14) version3(3)} +11043 +11044 interVlrInfoRetrievalContext-v3 OBJECT IDENTIFIER ::= +11045 {map-ac interVlrInfoRetrieval(15) version3(3)} +11046 +11047 subscriberDataMngtContext-v3 OBJECT IDENTIFIER ::= +11048 {map-ac subscriberDataMngt(16) version3(3)} +11049 +11050 tracingContext-v3 OBJECT IDENTIFIER ::= +11051 {map-ac tracing(17) version3(3)} +11052 +11053 networkFunctionalSsContext-v2 OBJECT IDENTIFIER ::= +11054 {map-ac networkFunctionalSs(18) version2(2)} +11055 +11056 networkUnstructuredSsContext-v2 OBJECT IDENTIFIER ::= +11057 {map-ac networkUnstructuredSs(19) version2(2)} +11058 +11059 shortMsgGatewayContext-v3 OBJECT IDENTIFIER ::= +11060 {map-ac shortMsgGateway(20) version3(3)} +11061 +11062 shortMsgMO-RelayContext-v3 OBJECT IDENTIFIER ::= +11063 {map-ac shortMsgMO-Relay(21) version3(3)} +11064 +11065 shortMsgAlertContext-v2 OBJECT IDENTIFIER ::= +11066 {map-ac shortMsgAlert(23) version2(2)} +11067 +11068 mwdMngtContext-v3 OBJECT IDENTIFIER ::= +11069 {map-ac mwdMngt(24) version3(3)} +11070 +11071 shortMsgMT-RelayContext-v3 OBJECT IDENTIFIER ::= +11072 {map-ac shortMsgMT-Relay(25) version3(3)} +11073 +11074 shortMsgMT-Relay-VGCS-Context-v3 OBJECT IDENTIFIER ::= +11075 {map-ac shortMsgMT-Relay-VGCS(41) version3(3)} +11076 +11077 imsiRetrievalContext-v2 OBJECT IDENTIFIER ::= +11078 {map-ac imsiRetrieval(26) version2(2)} +11079 +11080 msPurgingContext-v3 OBJECT IDENTIFIER ::= +11081 {map-ac msPurging(27) version3(3)} +11082 +11083 subscriberInfoEnquiryContext-v3 OBJECT IDENTIFIER ::= +11084 {map-ac subscriberInfoEnquiry(28) version3(3)} +11085 +11086 anyTimeInfoEnquiryContext-v3 OBJECT IDENTIFIER ::= +11087 {map-ac anyTimeInfoEnquiry(29) version3(3)} +``` + +``` + +11088 +11089 callControlTransferContext-v4 OBJECT IDENTIFIER ::= +11090 {map-ac callControlTransfer(6) version4(4)} +11091 +11092 ss-InvocationNotificationContext-v3 OBJECT IDENTIFIER ::= +11093 {map-ac ss-InvocationNotification(36) version3(3)} +11094 +11095 groupCallControlContext-v3 OBJECT IDENTIFIER ::= +11096 {map-ac groupCallControl(31) version3(3)} +11097 +11098 groupCallInfoRetrievalContext-v3 OBJECT IDENTIFIER ::= +11099 {map-ac groupCallInfoRetrieval(45) version3(3)} +11100 +11101 gprsLocationUpdateContext-v3 OBJECT IDENTIFIER ::= +11102 {map-ac gprsLocationUpdate(32) version3(3)} +11103 +11104 gprsLocationInfoRetrievalContext-v4 OBJECT IDENTIFIER ::= +11105 {map-ac gprsLocationInfoRetrieval(33) version4(4)} +11106 +11107 failureReportContext-v3 OBJECT IDENTIFIER ::= +11108 {map-ac failureReport(34) version3(3)} +11109 +11110 gprsNotifyContext-v3 OBJECT IDENTIFIER ::= +11111 {map-ac gprsNotify(35) version3(3)} +11112 +11113 reportingContext-v3 OBJECT IDENTIFIER ::= +11114 {map-ac reporting(7) version3(3)} +11115 +11116 callCompletionContext-v3 OBJECT IDENTIFIER ::= +11117 {map-ac callCompletion(8) version3(3)} +11118 +11119 istAlertingContext-v3 OBJECT IDENTIFIER ::= +11120 {map-ac istAlerting(4) version3(3)} +11121 +11122 serviceTerminationContext-v3 OBJECT IDENTIFIER ::= +11123 {map-ac immediateTermination(9) version3(3)} +11124 +11125 locationSvcGatewayContext-v3 OBJECT IDENTIFIER ::= +11126 {map-ac locationSvcGateway(37) version3(3)} +11127 +11128 locationSvcEnquiryContext-v3 OBJECT IDENTIFIER ::= +11129 {map-ac locationSvcEnquiry(38) version3(3)} +11130 +11131 mm-EventReportingContext-v3 OBJECT IDENTIFIER ::= +11132 {map-ac mm-EventReporting(42) version3(3)} +11133 +11134 anyTimeInfoHandlingContext-v3 OBJECT IDENTIFIER ::= +11135 {map-ac anyTimeInfoHandling(43) version3(3)} +11136 +11137 subscriberDataModificationNotificationContext-v3 OBJECT IDENTIFIER ::= +11138 {map-ac subscriberDataModificationNotification(22) version3(3)} +11139 +11140 resourceManagementContext-v3 OBJECT IDENTIFIER ::= +11141 {map-ac resourceManagement(44) version3(3)} +11142 +11143 vcsgLocationUpdateContext-v3 OBJECT IDENTIFIER ::= +11144 {map-ac vcsgLocationUpdate(46) version3(3)} +11145 +11146 vcsgLocationCancellationContext-v3 OBJECT IDENTIFIER ::= +11147 {map-ac vcsgLocationCancel(47) version3(3)} + +``` + +``` + +11148 +11149 +11150 -- The following Object Identifiers are reserved for application-contexts +11151 -- existing in previous versions of the protocol +11152 + +``` + +| 11153 | -- AC Name & Version | Object Identifier | | +|-------|-----------------------------------------|----------------------------------------------|---------------------| +| 11154 | -- | | | +| 11155 | -- networkLocUpContext-v1 | map-ac networkLocUp (1) | version1 (1) | +| 11156 | -- networkLocUpContext-v2 | map-ac networkLocUp (1) | version2 (2) | +| 11157 | -- locationCancellationContext-v1 | map-ac locationCancellation (2) | version1 (1) | +| 11158 | -- locationCancellationContext-v2 | map-ac locationCancellation (2) | version2 (2) | +| 11159 | -- roamingNumberEnquiryContext-v1 | map-ac roamingNumberEnquiry (3) | version1 (1) | +| 11160 | -- roamingNumberEnquiryContext-v2 | map-ac roamingNumberEnquiry (3) | version2 (2) | +| 11161 | -- locationInfoRetrievalContext-v1 | map-ac locationInfoRetrieval (5) | version1 (1) | +| 11162 | -- locationInfoRetrievalContext-v2 | map-ac locationInfoRetrieval (5) | version2 (2) | +| 11163 | -- resetContext-v1 | map-ac reset (10) | version1 (1) | +| 11164 | -- resetContext-v2 | map-ac reset (10) | version2 (2) | +| 11165 | -- handoverControlContext-v1 | map-ac handoverControl (11) | version1 (1) | +| 11166 | -- handoverControlContext-v2 | map-ac handoverControl (11) | version2 (2) | +| 11167 | -- slWFSAllocationContext-v3 | map-ac slWFSAllocation (12) | version3 (3) | +| 11168 | -- equipmentMngtContext-v1 | map-ac equipmentMngt (13) | version1 (1) | +| 11169 | -- equipmentMngtContext-v2 | map-ac equipmentMngt (13) | version2 (2) | +| 11170 | -- infoRetrievalContext-v1 | map-ac infoRetrieval (14) | version1 (1) | +| 11171 | -- infoRetrievalContext-v2 | map-ac infoRetrieval (14) | version2 (2) | +| 11172 | -- interVlrInfoRetrievalContext-v2 | map-ac interVlrInfoRetrieval (15) | version2 (2) | +| 11173 | -- subscriberDataMngtContext-v1 | map-ac subscriberDataMngt (16) | version1 (1) | +| 11174 | -- subscriberDataMngtContext-v2 | map-ac subscriberDataMngt (16) | version2 (2) | +| 11175 | -- tracingContext-v1 | map-ac tracing (17) | version1 (1) | +| 11176 | -- tracingContext-v2 | map-ac tracing (17) | version2 (2) | +| 11177 | -- networkFunctionalSsContext-v1 | map-ac networkFunctionalSs (18) | version1 (1) | +| 11178 | -- shortMsgGatewayContext-v1 | map-ac shortMsgGateway (20) | version1 (1) | +| 11179 | -- shortMsgGatewayContext-v2 | map-ac shortMsgGateway (20) | version2 (2) | +| 11180 | -- shortMsgRelayContext-v1 | map-ac shortMsgRelay (21) | version1 (1) | +| 11181 | -- shortMsgAlertContext-v1 | map-ac shortMsgAlert (23) | version1 (1) | +| 11182 | -- mwdMngtContext-v1 | map-ac mwdMngt (24) | version1 (1) | +| 11183 | -- mwdMngtContext-v2 | map-ac mwdMngt (24) | version2 (2) | +| 11184 | -- shortMsgMT-RelayContext-v2 | map-ac shortMsgMT-Relay (25) | version2 (2) | +| 11185 | -- msPurgingContext-v2 | map-ac msPurging (27) | version2 (2) | +| 11186 | -- callControlTransferContext-v3 | map-ac callControlTransferContext (6) | version3 (3) | +| 11187 | -- gprsLocationInfoRetrievalContext-v3 | map-ac gprsLocationInfoRetrievalContext (33) | version3 (3) | + +11188 + +11189 + +11190 END + +## 11191 17.4 MAP Dialogue Information + +``` + +11192 MAP-DialogueInformation { +11193 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11194 gsm-Network (1) modules (3) map-DialogueInformation (3) version21 (21)} +11195 +11196 DEFINITIONS +11197 +11198 IMPLICIT TAGS +11199 +11200 ::= +11201 +11202 BEGIN +11203 +11204 EXPORTS +11205 map-DialogueAS, +11206 MAP-DialoguePDU +11207 +11208 ; +11209 +11210 IMPORTS +11211 gsm-NetworkId, +11212 as-Id +11213 FROM MobileDomainDefinitions { +11214 itu-t (0) identified-organization (4) etsi (0) mobileDomain (0) +11215 mobileDomainDefinitions (0) version1 (1)} +11216 +11217 AddressString +11218 FROM MAP-CommonDataTypes { +11219 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11220 gsm-Network(1) modules (3) map-CommonDataTypes (18) version21 (21)} +11221 +11222 ExtensionContainer +11223 FROM MAP-ExtensionDataTypes { +11224 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11225 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +11226 +11227 + +``` + +``` + +11228 ; +11229 +11230 +11231 -- abstract syntax name for MAP-DialoguePDU +11232 +11233 map-DialogueAS OBJECT IDENTIFIER ::= +11234 {gsm-NetworkId as-Id map-DialoguePDU (1) version1 (1)} +11235 +11236 MAP-DialoguePDU ::= CHOICE { +11237 map-open [0] MAP-OpenInfo, +11238 map-accept [1] MAP-AcceptInfo, +11239 map-close [2] MAP-CloseInfo, +11240 map-refuse [3] MAP-RefuseInfo, +11241 map-userAbort [4] MAP-UserAbortInfo, +11242 map-providerAbort [5] MAP-ProviderAbortInfo} +11243 +11244 MAP-OpenInfo ::= SEQUENCE { +11245 destinationReference [0] AddressString OPTIONAL, +11246 originationReference [1] AddressString OPTIONAL, +11247 ..., +11248 extensionContainer ExtensionContainer OPTIONAL +11249 -- extensionContainer must not be used in version 2 +11250 } +11251 +11252 MAP-AcceptInfo ::= SEQUENCE { +11253 ..., +11254 extensionContainer ExtensionContainer OPTIONAL +11255 -- extensionContainer must not be used in version 2 +11256 } +11257 +11258 MAP-CloseInfo ::= SEQUENCE { +11259 ..., +11260 extensionContainer ExtensionContainer OPTIONAL +11261 -- extensionContainer must not be used in version 2 +11262 } +11263 +11264 MAP-RefuseInfo ::= SEQUENCE { +11265 reason Reason, +11266 ..., +11267 extensionContainer ExtensionContainer OPTIONAL, +11268 -- extensionContainer must not be used in version 2 +11269 alternativeApplicationContext OBJECT IDENTIFIER OPTIONAL +11270 -- alternativeApplicationContext must not be used in version 2 +11271 } +11272 +11273 Reason ::= ENUMERATED { +11274 noReasonGiven (0), +11275 invalidDestinationReference (1), +11276 invalidOriginatingReference (2)} +11277 +11278 MAP-UserAbortInfo ::= SEQUENCE { +11279 map-UserAbortChoice MAP-UserAbortChoice, +11280 ..., +11281 extensionContainer ExtensionContainer OPTIONAL +11282 -- extensionContainer must not be used in version 2 +11283 } +11284 +11285 MAP-UserAbortChoice ::= CHOICE { +11286 userSpecificReason [0] NULL, +11287 userResourceLimitation [1] NULL, +11288 resourceUnavailable [2] ResourceUnavailableReason, +11289 applicationProcedureCancellation [3] ProcedureCancellationReason} +11290 +11291 ResourceUnavailableReason ::= ENUMERATED { +11292 shortTermResourceLimitation (0), +11293 longTermResourceLimitation (1)} +11294 +11295 ProcedureCancellationReason ::= ENUMERATED { +11296 handoverCancellation (0), +11297 radioChannelRelease (1), +11298 networkPathRelease (2), +11299 callRelease (3), +11300 associatedProcedureFailure (4), +11301 tandemDialogueRelease (5), +11302 remoteOperationsFailure (6)} +11303 + +``` + +``` + +11304 MAP-ProviderAbortInfo ::= SEQUENCE { +11305 map-ProviderAbortReason MAP-ProviderAbortReason, +11306 ..., +11307 extensionContainer ExtensionContainer OPTIONAL +11308 -- extensionContainer must not be used in version 2 +11309 } +11310 +11311 MAP-ProviderAbortReason ::= ENUMERATED { +11312 abnormalDialogue (0), +11313 invalidPDU (1)} +11314 +11315 END + +``` + +## 11316 17.5 MAP operation and error codes + +``` + +11317 MAP-Protocol { +11318 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11319 gsm-Network (1) modules (3) map-Protocol (4) version21 (21)} +11320 +11321 DEFINITIONS +11322 +11323 ::= +11324 +11325 BEGIN +11326 +11327 IMPORTS +11328 OPERATION +11329 FROM Remote-Operations-Information-Objects { +11330 joint-iso-itu-t remote-operations(4) informationObjects(5) version1(0)} +11331 +11332 updateLocation, +11333 cancelLocation, +11334 cancelVcsgLocation, +11335 purgeMS, +11336 sendIdentification, +11337 updateGprsLocation, +11338 updateVcsgLocation, +11339 prepareHandover, +11340 sendEndSignal, +11341 processAccessSignalling, +11342 forwardAccessSignalling, +11343 prepareSubsequentHandover, +11344 sendAuthenticationInfo, +11345 authenticationFailureReport, +11346 checkIMEI, +11347 insertSubscriberData, +11348 deleteSubscriberData, +11349 reset, +11350 forwardCheckSS-Indication, +11351 restoreData, +11352 provideSubscriberInfo, +11353 anyTimeInterrogation, +11354 anyTimeSubscriptionInterrogation, +11355 anyTimeModification, +11356 sendRoutingInfoForGprs, +11357 failureReport, +11358 noteMsPresentForGprs, +11359 noteMM-Event, +11360 noteSubscriberDataModified +11361 +11362 +11363 FROM MAP-MobileServiceOperations { +11364 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11365 gsm-Network (1) modules (3) map-MobileServiceOperations (5) +11366 version21 (21)} +11367 +11368 activateTraceMode, +11369 deactivateTraceMode, +11370 sendIMSI +11371 FROM MAP-OperationAndMaintenanceOperations { +11372 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11373 gsm-Network (1) modules (3) map-OperationAndMaintenanceOperations (6) +11374 version21 (21)} +11375 +11376 sendRoutingInfo, +11377 provideRoamingNumber, +11378 resumeCallHandling, + +``` + +``` + +11379 setReportingState, +11380 statusReport, +11381 remoteUserFree, +11382 ist-Alert, +11383 ist-Command, +11384 releaseResources +11385 FROM MAP-CallHandlingOperations { +11386 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11387 gsm-Network (1) modules (3) map-CallHandlingOperations (7) +11388 version21 (21)} +11389 +11390 registerSS, +11391 eraseSS, +11392 activateSS, +11393 deactivateSS, +11394 interrogateSS, +11395 processUnstructuredSS-Request, +11396 unstructuredSS-Request, +11397 unstructuredSS-Notify, +11398 registerPassword, +11399 getPassword, +11400 ss-InvocationNotification, +11401 registerCC-Entry, +11402 eraseCC-Entry +11403 FROM MAP-SupplementaryServiceOperations { +11404 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11405 gsm-Network (1) modules (3) map-SupplementaryServiceOperations (8) +11406 version21 (21)} +11407 +11408 sendRoutingInfoForSM, +11409 mo-ForwardSM, +11410 mt-ForwardSM, +11411 reportSM-DeliveryStatus, +11412 alertServiceCentre, +11413 informServiceCentre, +11414 readyForSM, +11415 mt-ForwardSM-VGCS +11416 FROM MAP-ShortMessageServiceOperations { +11417 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11418 gsm-Network (1) modules (3) map-ShortMessageServiceOperations (9) +11419 version21 (21)} +11420 +11421 prepareGroupCall, +11422 processGroupCallSignalling, +11423 forwardGroupCallSignalling, +11424 sendGroupCallEndSignal, +11425 sendGroupCallInfo +11426 FROM MAP-Group-Call-Operations { +11427 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11428 gsm-Network (1) modules (3) map-Group-Call-Operations (22) +11429 version21 (21)} +11430 +11431 provideSubscriberLocation, +11432 sendRoutingInfoForLCS, +11433 subscriberLocationReport +11434 FROM MAP-LocationServiceOperations { +11435 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11436 gsm-Network (1) modules (3) map-LocationServiceOperations (24) +11437 version21 (21)} +11438 +11439 +11440 ; +11441 Supported-MAP-Operations OPERATION ::= {updateLocation | cancelLocation | cancelVcsgLocation | +11442 purgeMS | +11443 sendIdentification | updateGprsLocation | updateVcsgLocation | prepareHandover | sendEndSignal | +11444 processAccessSignalling | forwardAccessSignalling | prepareSubsequentHandover | +11445 sendAuthenticationInfo | authenticationFailureReport | checkIMEI | insertSubscriberData | +11446 deleteSubscriberData | reset | forwardCheckSS-Indication | restoreData | provideSubscriberInfo | +11447 anyTimeInterrogation | anyTimeSubscriptionInterrogation | anyTimeModification | +11448 sendRoutingInfoForGprs | failureReport | noteMsPresentForGprs | noteMM-Event | +11449 noteSubscriberDataModified | activateTraceMode | deactivateTraceMode | sendIMSI | +11450 sendRoutingInfo | provideRoamingNumber | resumeCallHandling | setReportingState | statusReport | +11451 remoteUserFree | ist-Alert | +11452 ist-Command | registerSS | eraseSS | activateSS | deactivateSS | interrogateSS | +11453 processUnstructuredSS-Request | unstructuredSS-Request | unstructuredSS-Notify | +11454 registerPassword | getPassword | ss-InvocationNotification | registerCC-Entry | eraseCC-Entry | +11455 sendRoutingInfoForSM | mo-ForwardSM | mt-ForwardSM | reportSM-DeliveryStatus | +11456 alertServiceCentre | informServiceCentre | readyForSM | prepareGroupCall | +11457 processGroupCallSignalling | forwardGroupCallSignalling | sendGroupCallEndSignal | + +``` + +``` + +11458 provideSubscriberLocation | sendRoutingInfoForLCS | subscriberLocationReport | +11459 releaseResources | mt-ForwardSM-VGCS | sendGroupCallInfo } +11460 +11461 +11462 +11463 -- The following operation codes are reserved for operations +11464 -- existing in previous versions of the protocol +11465 +11466 -- Operation Name AC used Oper. Code +11467 -- +11468 -- sendParameters map-ac infoRetrieval (14) version1 (1) local:9 +11469 -- processUnstructuredSS-Data map-ac networkFunctionalSs (18) version1 (1) local:19 +11470 -- performHandover map-ac handoverControl (11) version1 (1) local:28 +11471 -- performSubsequentHandover map-ac handoverControl (11) version1 (1) local:30 +11472 -- provideSIWFSNumber map-ac siWFSAllocation (12) version3 (3) local:31 +11473 -- siwfs-SignallingModify map-ac siWFSAllocation (12) version3 (3) local:32 +11474 -- noteInternalHandover map-ac handoverControl (11) version1 (1) local:35 +11475 -- noteSubscriberPresent map-ac mwdMngt (24) version1 (1) local:48 +11476 -- alertServiceCentreWithoutResult map-ac shortMsgAlert (23) version1 (1) local:49 +11477 -- traceSubscriberActivity map-ac handoverControl (11) version1 (1) local:52 +11478 -- beginSubscriberActivity map-ac networkFunctionalSs (18) version1 (1) local:54 +11479 +11480 -- The following error codes are reserved for errors +11481 -- existing in previous versions of the protocol +11482 +11483 -- Error Name AC used Error Code +11484 -- +11485 -- unknownBaseStation map-ac handoverControl (11) version1 (1) local:2 +11486 -- invalidTargetBaseStation map-ac handoverControl (11) version1 (1) local:23 +11487 -- noRadioResourceAvailable map-ac handoverControl (11) version1 (1) local:24 +11488 +11489 +11490 END + +``` + +## 11491 17.6 MAP operations and errors + +### 11492 17.6.1 Mobile Service Operations + +``` + +11493 MAP-MobileServiceOperations { +11494 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11495 gsm-Network (1) modules (3) map-MobileServiceOperations (5) +11496 version21 (21)} +11497 +11498 DEFINITIONS +11499 +11500 ::= +11501 +11502 BEGIN +11503 +11504 EXPORTS +11505 +11506 -- location registration operations +11507 updateLocation, +11508 cancelLocation, +11509 purgeMS, +11510 sendIdentification, +11511 +11512 -- gprs location registration operations +11513 updateGprsLocation, +11514 +11515 -- vcsg location registration operations +11516 updateVcsgLocation, +11517 cancelVcsgLocation, +11518 +11519 -- subscriber information enquiry operations +11520 provideSubscriberInfo, +11521 +11522 -- any time information enquiry operations +11523 anyTimeInterrogation, +11524 +11525 -- any time information handling operations +11526 anyTimeSubscriptionInterrogation, +11527 anyTimeModification, +11528 +11529 -- subscriber data modification notification operations +11530 noteSubscriberDataModified, + +``` + +``` + +11531 +11532 +11533 -- handover operations +11534 prepareHandover, +11535 sendEndSignal, +11536 processAccessSignalling, +11537 forwardAccessSignalling, +11538 prepareSubsequentHandover, +11539 +11540 -- authentication management operations +11541 sendAuthenticationInfo, +11542 authenticationFailureReport, +11543 +11544 -- IMEI management operations +11545 checkIMEI, +11546 +11547 -- subscriber management operations +11548 insertSubscriberData, +11549 deleteSubscriberData, +11550 +11551 -- fault recovery operations +11552 reset, +11553 forwardCheckSS-Indication, +11554 restoreData, +11555 +11556 -- gprs location information retrieval operations +11557 sendRoutingInfoForGprs, +11558 +11559 -- failure reporting operations +11560 failureReport, +11561 +11562 -- gprs notification operations +11563 noteMsPresentForGprs, +11564 +11565 -- Mobility Management operations +11566 noteMM-Event +11567 +11568 ; +11569 +11570 IMPORTS +11571 OPERATION +11572 FROM Remote-Operations-Information-Objects { +11573 joint-iso-itu-t remote-operations(4) +11574 informationObjects(5) version1(0) } +11575 +11576 systemFailure, +11577 dataMissing, +11578 unexpectedDataValue, +11579 unknownSubscriber, +11580 unknownMSC, +11581 unidentifiedSubscriber, +11582 unknownEquipment, +11583 roamingNotAllowed, +11584 ati-NotAllowed, +11585 noHandoverNumberAvailable, +11586 subsequentHandoverFailure, +11587 absentSubscriber, +11588 mm-EventNotSupported, +11589 atsi-NotAllowed, +11590 atm-NotAllowed, +11591 bearerServiceNotProvisioned, +11592 teleserviceNotProvisioned, +11593 callBarred, +11594 illegalSS-Operation, +11595 ss-ErrorStatus, +11596 ss-NotAvailable, +11597 ss-Incompatibility, +11598 ss-SubscriptionViolation, +11599 informationNotAvailable, +11600 targetCellOutsideGroupCallArea +11601 +11602 +11603 FROM MAP-Errors { +11604 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11605 gsm-Network (1) modules (3) map-Errors (10) version21 (21) } +11606 +11607 UpdateLocationArg, +11608 UpdateLocationRes, +11609 CancelLocationArg, + +``` + +``` + +11610 CancelLocationRes, +11611 PurgeMS-Arg, +11612 PurgeMS-Res, +11613 SendIdentificationArg, +11614 SendIdentificationRes, +11615 UpdateGprsLocationArg, +11616 UpdateGprsLocationRes, +11617 UpdateVcsgLocationArg, +11618 UpdateVcsgLocationRes, +11619 CancelVcsgLocationArg, +11620 CancelVcsgLocationRes, +11621 PrepareHO-Arg, +11622 PrepareHO-Res, +11623 ForwardAccessSignalling-Arg, +11624 ProcessAccessSignalling-Arg, +11625 SendEndSignal-Arg, +11626 SendEndSignal-Res, +11627 PrepareSubsequentHO-Res, +11628 PrepareSubsequentHO-Arg, +11629 SendAuthenticationInfoArg, +11630 SendAuthenticationInfoRes, +11631 AuthenticationFailureReportArg, +11632 AuthenticationFailureReportRes, +11633 CheckIMEI-Arg, +11634 CheckIMEI-Res, +11635 InsertSubscriberDataArg, +11636 InsertSubscriberDataRes, +11637 DeleteSubscriberDataArg, +11638 DeleteSubscriberDataRes, +11639 ResetArg, +11640 RestoreDataArg, +11641 RestoreDataRes, +11642 ProvideSubscriberInfoArg, +11643 ProvideSubscriberInfoRes, +11644 AnyTimeSubscriptionInterrogationArg, +11645 AnyTimeSubscriptionInterrogationRes, +11646 AnyTimeModificationArg, +11647 AnyTimeModificationRes, +11648 NoteSubscriberDataModifiedArg, +11649 NoteSubscriberDataModifiedRes, +11650 AnyTimeInterrogationArg, +11651 AnyTimeInterrogationRes, +11652 SendRoutingInfoForGprsArg, +11653 SendRoutingInfoForGprsRes, +11654 FailureReportArg, +11655 FailureReportRes, +11656 NoteMsPresentForGprsArg, +11657 NoteMsPresentForGprsRes, +11658 NoteMM-EventArg, +11659 NoteMM-EventRes +11660 +11661 +11662 FROM MAP-MS-DataTypes { +11663 itu-t identified-organization (4) etsi (0) mobileDomain (0) +11664 gsm-Network (1) modules (3) map-MS-DataTypes (11) version21 (21)} +11665 +11666 ; +11667 +11668 +11669 -- location registration operations +11670 +11671 updateLocation OPERATION ::= { +11672 ARGUMENT +11673 UpdateLocationArg +11674 RESULT +11675 UpdateLocationRes +11676 ERRORS { +11677 systemFailure | +11678 dataMissing | +11679 unexpectedDataValue | +11680 unknownSubscriber | +11681 roamingNotAllowed} +11682 CODE local:2 } +11683 + +``` + +--Timer m + +``` +11684 cancelLocation OPERATION ::= { --Timer m +11685 ARGUMENT +11686 CancelLocationArg +11687 RESULT +11688 CancelLocationRes +11689 -- optional +11690 ERRORS { +11691 dataMissing | +11692 unexpectedDataValue} +11693 CODE local:3 } +``` + +``` +11694 +11695 purgeMS OPERATION ::= { --Timer m +11696 ARGUMENT +11697 PurgeMS-Arg +11698 RESULT +11699 PurgeMS-Res +11700 -- optional +11701 ERRORS{ +11702 dataMissing | +11703 unexpectedDataValue| +11704 unknownSubscriber} +11705 CODE local:67 } +``` + +``` +11706 +11707 sendIdentification OPERATION ::= { --Timer s +11708 ARGUMENT +11709 SendIdentificationArg +11710 RESULT +11711 SendIdentificationRes +11712 ERRORS { +11713 dataMissing | +11714 unidentifiedSubscriber} +11715 CODE local:55 } +``` + +``` +11716 +11717 -- gprs location registration operations +11718 +``` + +``` +11719 updateGprsLocation OPERATION ::= { --Timer m +11720 ARGUMENT +11721 UpdateGprsLocationArg +11722 RESULT +11723 UpdateGprsLocationRes +11724 ERRORS { +11725 systemFailure | +11726 unexpectedDataValue | +11727 unknownSubscriber | +11728 roamingNotAllowed} +11729 CODE local:23 } +``` + +``` +11730 +11731 -- subscriber information enquiry operations +11732 +``` + +``` +11733 provideSubscriberInfo OPERATION ::= { --Timer m +11734 ARGUMENT +11735 ProvideSubscriberInfoArg +11736 RESULT +11737 ProvideSubscriberInfoRes +11738 ERRORS { +11739 dataMissing | +11740 unexpectedDataValue} +11741 CODE local:70 } +``` + +``` +11742 +11743 -- any time information enquiry operations +11744 +``` + +``` +11745 anyTimeInterrogation OPERATION ::= { --Timer m +11746 ARGUMENT +11747 AnyTimeInterrogationArg +11748 RESULT +11749 AnyTimeInterrogationRes +11750 ERRORS { +11751 systemFailure | +11752 ati-NotAllowed | +11753 dataMissing | +11754 unexpectedDataValue | +11755 unknownSubscriber} +11756 CODE local:71 } +``` + +``` +11757 +11758 -- any time information handling operations +11759 +``` + +``` + +11760 anyTimeSubscriptionInterrogation OPERATION ::= { --Timer m +11761 ARGUMENT +11762 AnyTimeSubscriptionInterrogationArg +11763 RESULT +11764 AnyTimeSubscriptionInterrogationRes +11765 ERRORS { +11766 atsi-NotAllowed | +11767 dataMissing | +11768 unexpectedDataValue | +11769 unknownSubscriber | +11770 bearerServiceNotProvisioned | +11771 teleserviceNotProvisioned | +11772 callBarred | +11773 illegalSS-Operation | +11774 ss-NotAvailable | +11775 informationNotAvailable} +11776 CODE local:62 } +11777 +11778 anyTimeModification OPERATION ::= { --Timer m +11779 ARGUMENT +11780 AnyTimeModificationArg +11781 RESULT +11782 AnyTimeModificationRes +11783 ERRORS { +11784 atm-NotAllowed | +11785 dataMissing | +11786 unexpectedDataValue | +11787 unknownSubscriber | +11788 bearerServiceNotProvisioned | +11789 teleserviceNotProvisioned | +11790 callBarred | +11791 illegalSS-Operation | +11792 ss-SubscriptionViolation | +11793 ss-ErrorStatus | +11794 ss-Incompatibility | +11795 informationNotAvailable} +11796 CODE local:65 } +11797 +11798 -- subscriber data modification notification operations +11799 +11800 noteSubscriberDataModified OPERATION ::= { --Timer m +11801 ARGUMENT +11802 NoteSubscriberDataModifiedArg +11803 RESULT +11804 NoteSubscriberDataModifiedRes +11805 -- optional +11806 ERRORS { +11807 dataMissing | +11808 unexpectedDataValue | +11809 unknownSubscriber} +11810 CODE local:5 } +11811 +11812 -- handover operations +11813 +11814 prepareHandover OPERATION ::= { --Timer m +11815 ARGUMENT +11816 PrepareHO-Arg +11817 RESULT +11818 PrepareHO-Res +11819 ERRORS { +11820 systemFailure | +11821 dataMissing | +11822 unexpectedDataValue | +11823 noHandoverNumberAvailable | +11824 targetCellOutsideGroupCallArea } +11825 CODE local:68 } +11826 +11827 sendEndSignal OPERATION ::= { --Timer l +11828 ARGUMENT +11829 SendEndSignal-Arg +11830 RESULT +11831 SendEndSignal-Res +11832 CODE local:29 } +11833 + +``` + +``` + +11834 processAccessSignalling OPERATION ::= { --Timer s +11835 ARGUMENT +11836 ProcessAccessSignalling-Arg +11837 CODE local:33 } +11838 +11839 forwardAccessSignalling OPERATION ::= { --Timer s +11840 ARGUMENT +11841 ForwardAccessSignalling-Arg +11842 CODE local:34 } +11843 +11844 prepareSubsequentHandover OPERATION ::= { --Timer m +11845 ARGUMENT +11846 PrepareSubsequentHO-Arg +11847 RESULT +11848 PrepareSubsequentHO-Res +11849 ERRORS { +11850 unexpectedDataValue | +11851 dataMissing | +11852 unknownMSC | +11853 subsequentHandoverFailure} +11854 CODE local:69 } +11855 +11856 -- authentication management operations +11857 +11858 sendAuthenticationInfo OPERATION ::= { --Timer m +11859 ARGUMENT +11860 SendAuthenticationInfoArg +11861 -- optional +11862 -- within a dialogue sendAuthenticationInfoArg shall not be present in +11863 -- subsequent invoke components. If received in a subsequent invoke component +11864 -- it shall be discarded. +11865 +11866 RESULT +11867 SendAuthenticationInfoRes +11868 -- optional +11869 ERRORS { +11870 systemFailure | +11871 dataMissing | +11872 unexpectedDataValue | +11873 unknownSubscriber} +11874 CODE local:56 } +11875 +11876 authenticationFailureReport OPERATION ::= { --Timer m +11877 ARGUMENT +11878 AuthenticationFailureReportArg +11879 RESULT +11880 AuthenticationFailureReportRes +11881 -- optional +11882 ERRORS { +11883 systemFailure | +11884 unexpectedDataValue | +11885 unknownSubscriber} +11886 CODE local:15 } +11887 +11888 -- IMEI management operations +11889 +11890 checkIMEI OPERATION ::= { --Timer m +11891 ARGUMENT +11892 CheckIMEI-Arg +11893 RESULT +11894 CheckIMEI-Res +11895 ERRORS { +11896 systemFailure | +11897 dataMissing | +11898 unknownEquipment} +11899 CODE local:43 } +11900 +11901 -- subscriber management operations +11902 + +``` + +``` + +11903 insertSubscriberData OPERATION ::= { --Timer m +11904 ARGUMENT +11905 InsertSubscriberDataArg +11906 RESULT +11907 InsertSubscriberDataRes +11908 -- optional +11909 ERRORS { +11910 dataMissing | +11911 unexpectedDataValue | +11912 unidentifiedSubscriber} +11913 CODE local:7 } +11914 +11915 deleteSubscriberData OPERATION ::= { --Timer m +11916 ARGUMENT +11917 DeleteSubscriberDataArg +11918 RESULT +11919 DeleteSubscriberDataRes +11920 -- optional +11921 ERRORS { +11922 dataMissing | +11923 unexpectedDataValue | +11924 unidentifiedSubscriber} +11925 CODE local:8 } +11926 +11927 -- fault recovery operations +11928 +11929 reset OPERATION ::= { --Timer m +11930 ARGUMENT +11931 ResetArg +11932 CODE local:37 } +11933 +11934 forwardCheckSS-Indication OPERATION ::= { --Timer s +11935 CODE local:38 } +11936 +11937 restoreData OPERATION ::= { --Timer m +11938 ARGUMENT +11939 RestoreDataArg +11940 RESULT +11941 RestoreDataRes +11942 ERRORS { +11943 systemFailure | +11944 dataMissing | +11945 unexpectedDataValue | +11946 unknownSubscriber} +11947 CODE local:57 } +11948 +11949 -- gprs location information retrieval operations +11950 +11951 sendRoutingInfoForGprs OPERATION ::= { --Timer m +11952 ARGUMENT +11953 SendRoutingInfoForGprsArg +11954 RESULT +11955 SendRoutingInfoForGprsRes +11956 ERRORS { +11957 absentSubscriber | +11958 systemFailure | +11959 dataMissing | +11960 unexpectedDataValue | +11961 unknownSubscriber | +11962 callBarred } +11963 CODE local:24 } +11964 +11965 -- failure reporting operations +11966 +11967 failureReport OPERATION ::= { --Timer m +11968 ARGUMENT +11969 FailureReportArg +11970 RESULT +11971 FailureReportRes +11972 -- optional +11973 ERRORS { +11974 systemFailure | +11975 dataMissing | +11976 unexpectedDataValue | +11977 unknownSubscriber} +11978 CODE local:25 } +11979 +11980 -- gprs notification operations + +``` + +``` + +11981 +11982 noteMsPresentForGprs OPERATION ::= { --Timer m +11983 ARGUMENT +11984 NoteMsPresentForGprsArg +11985 RESULT +11986 NoteMsPresentForGprsRes +11987 -- optional +11988 ERRORS { +11989 systemFailure | +11990 dataMissing | +11991 unexpectedDataValue | +11992 unknownSubscriber} +11993 CODE local:26 } +11994 +11995 noteMM-Event OPERATION ::= { --Timer m +11996 ARGUMENT +11997 NoteMM-EventArgs +11998 RESULT +11999 NoteMM-EventRes +12000 ERRORS { +12001 dataMissing | +12002 unexpectedDataValue | +12003 unknownSubscriber | +12004 mm-EventNotSupported} +12005 CODE local:89 } +12006 +12007 -- vcsf location registration operations +12008 +12009 updateVcsfLocation OPERATION ::= { --Timer m +12010 ARGUMENT +12011 UpdateVcsfLocationArg +12012 RESULT +12013 UpdateVcsfLocationRes +12014 ERRORS { +12015 systemFailure | +12016 unexpectedDataValue | +12017 unknownSubscriber} +12018 CODE local:53 } +12019 +12020 cancelVcsfLocation OPERATION ::= { --Timer m +12021 ARGUMENT +12022 CancelVcsfLocationArg +12023 RESULT +12024 CancelVcsfLocationRes +12025 -- optional +12026 ERRORS { +12027 dataMissing | +12028 unexpectedDataValue} +12029 CODE local:36 } +12030 +12031 END + +``` + +## 17.6.2 Operation and Maintenance Operations + +``` + +12033 MAP-OperationAndMaintenanceOperations { +12034 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12035 gsm-Network (1) modules (3) map-OperationAndMaintenanceOperations (6) +12036 version21 (21)} +12037 +12038 DEFINITIONS +12039 +12040 ::= +12041 +12042 BEGIN +12043 +12044 EXPORTS +12045 activateTraceMode, +12046 deactivateTraceMode, +12047 sendIMSI +12048 ; +12049 +12050 IMPORTS +12051 OPERATION +12052 FROM Remote-Operations-Information-Objects { +12053 joint-iso-itu-t remote-operations (4) +12054 informationObjects (5) version1 (0)} +12055 +12056 systemFailure, + +``` + +``` + +12057 dataMissing, +12058 unexpectedDataValue, +12059 facilityNotSupported, +12060 unknownSubscriber, +12061 unidentifiedSubscriber, +12062 tracingBufferFull +12063 FROM MAP-Errors { +12064 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12065 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +12066 +12067 ActivateTraceModeArg, +12068 ActivateTraceModeRes, +12069 DeactivateTraceModeArg, +12070 DeactivateTraceModeRes +12071 FROM MAP-OM-DataTypes { +12072 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12073 gsm-Network (1) modules (3) map-OM-DataTypes (12) version21 (21)} +12074 +12075 ISDN-AddressString, +12076 IMSI +12077 FROM MAP-CommonDataTypes { +12078 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12079 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +12080 ; +12081 +12082 + +``` + +``` + +12083 activateTraceMode OPERATION ::= { --Timer m +12084 ARGUMENT +12085 ActivateTraceModeArg +12086 RESULT +12087 ActivateTraceModeRes +12088 -- optional +12089 ERRORS { +12090 systemFailure | +12091 dataMissing | +12092 unexpectedDataValue | +12093 facilityNotSupported | +12094 unidentifiedSubscriber | +12095 tracingBufferFull} +12096 CODE local:50 } +12097 + +``` + +``` + +12098 deactivateTraceMode OPERATION ::= { --Timer m +12099 ARGUMENT +12100 DeactivateTraceModeArg +12101 RESULT +12102 DeactivateTraceModeRes +12103 -- optional +12104 ERRORS { +12105 systemFailure | +12106 dataMissing | +12107 unexpectedDataValue | +12108 facilityNotSupported | +12109 unidentifiedSubscriber} +12110 CODE local:51 } +12111 + +``` + +``` + +12112 sendIMSI OPERATION ::= { --Timer m +12113 ARGUMENT +12114 ISDN-AddressString +12115 RESULT +12116 IMSI +12117 ERRORS { +12118 dataMissing | +12119 unexpectedDataValue | +12120 unknownSubscriber} +12121 CODE local:58 } +12122 + +``` + +``` + +12123 END + +``` + +## 17.6.3 Call Handling Operations + +``` + +12125 MAP-CallHandlingOperations { +12126 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12127 gsm-Network (1) modules (3) map-CallHandlingOperations (7) +12128 version21 (21)} +12129 +12130 DEFINITIONS +12131 +12132 ::= + +``` + +``` + +12133 +12134 BEGIN +12135 +12136 EXPORTS +12137 sendRoutingInfo, +12138 provideRoamingNumber, +12139 resumeCallHandling, +12140 setReportingState, +12141 statusReport, +12142 remoteUserFree, +12143 ist-Alert, +12144 ist-Command, +12145 releaseResources +12146 ; +12147 +12148 IMPORTS +12149 OPERATION +12150 FROM Remote-Operations-Information-Objects { +12151 joint-iso-itu-t remote-operations(4) +12152 informationObjects(5) version1(0) } +12153 +12154 systemFailure, +12155 dataMissing, +12156 unexpectedDataValue, +12157 facilityNotSupported, +12158 or-NotAllowed, +12159 unknownSubscriber, +12160 numberChanged, +12161 bearerServiceNotProvisioned, +12162 teleserviceNotProvisioned, +12163 noRoamingNumberAvailable, +12164 absentSubscriber, +12165 busySubscriber, +12166 noSubscriberReply, +12167 callBarred, +12168 forwardingViolation, +12169 forwardingFailed, +12170 cug-Reject, +12171 resourceLimitation, +12172 incompatibleTerminal, +12173 unidentifiedSubscriber +12174 +12175 FROM MAP-Errors { +12176 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12177 gsm-Network (1) modules (3) map-Errors (10) version21 (21) } +12178 SendRoutingInfoArg, +12179 SendRoutingInfoRes, +12180 ProvideRoamingNumberArg, +12181 ProvideRoamingNumberRes, +12182 ResumeCallHandlingArg, +12183 ResumeCallHandlingRes, +12184 SetReportingStateArg, +12185 SetReportingStateRes, +12186 StatusReportArg, +12187 StatusReportRes, +12188 RemoteUserFreeArg, +12189 RemoteUserFreeRes, +12190 IST-AlertArg, +12191 IST-AlertRes, +12192 IST-CommandArg, +12193 IST-CommandRes, +12194 ReleaseResourcesArg, +12195 ReleaseResourcesRes +12196 FROM MAP-CH-DataTypes { +12197 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12198 gsm-Network (1) modules (3) map-CH-DataTypes (13) version21 (21) } +12199 +12200 ; +12201 + +``` + +``` + +12202 sendRoutingInfo OPERATION ::= { --Timer m +12203 -- The timer is set to the upper limit of the range if the GMSC supports pre-paging. +12204 ARGUMENT +12205 SendRoutingInfoArg +12206 RESULT +12207 SendRoutingInfoRes +12208 ERRORS { +12209 systemFailure | +12210 dataMissing | +12211 unexpectedDataValue | +12212 facilityNotSupported | +12213 or-NotAllowed | +12214 unknownSubscriber | +12215 numberChanged | +12216 bearerServiceNotProvisioned | +12217 teleserviceNotProvisioned | +12218 absentSubscriber | +12219 busySubscriber | +12220 noSubscriberReply | +12221 callBarred | +12222 cug-Reject | +12223 forwardingViolation} +12224 CODE local:22 } +12225 +12226 provideRoamingNumber OPERATION ::= { --Timer m +12227 -- The timer is set to the upper limit of the range if the HLR supports pre-paging. +12228 ARGUMENT +12229 ProvideRoamingNumberArg +12230 RESULT +12231 ProvideRoamingNumberRes +12232 ERRORS { +12233 systemFailure | +12234 dataMissing | +12235 unexpectedDataValue | +12236 facilityNotSupported | +12237 or-NotAllowed | +12238 absentSubscriber | +12239 noRoamingNumberAvailable} +12240 CODE local:4 } +12241 +12242 resumeCallHandling OPERATION ::= { --Timer m +12243 ARGUMENT +12244 ResumeCallHandlingArg +12245 RESULT +12246 ResumeCallHandlingRes +12247 -- optional +12248 ERRORS { +12249 forwardingFailed | +12250 or-NotAllowed | +12251 unexpectedDataValue | +12252 dataMissing } +12253 CODE local:6 } +12254 +12255 setReportingState OPERATION ::= { --Timer m +12256 ARGUMENT +12257 SetReportingStateArg +12258 RESULT +12259 SetReportingStateRes +12260 -- optional +12261 ERRORS { +12262 systemFailure | +12263 unidentifiedSubscriber | +12264 unexpectedDataValue | +12265 dataMissing | +12266 resourceLimitation | +12267 facilityNotSupported} +12268 CODE local:73 } +12269 + +``` + +``` + +12270 statusReport OPERATION ::= { --Timer m +12271 ARGUMENT +12272 StatusReportArg +12273 RESULT +12274 StatusReportRes +12275 -- optional +12276 ERRORS { +12277 unknownSubscriber | +12278 systemFailure | +12279 unexpectedDataValue | +12280 dataMissing} +12281 CODE local:74 } +12282 +12283 remoteUserFree OPERATION ::= { --Timer m1 +12284 ARGUMENT +12285 RemoteUserFreeArg +12286 RESULT +12287 RemoteUserFreeRes +12288 ERRORS { +12289 unexpectedDataValue | +12290 dataMissing | +12291 incompatibleTerminal | +12292 absentSubscriber | +12293 systemFailure | +12294 busySubscriber} +12295 CODE local:75 } +12296 +12297 ist-Alert OPERATION ::= { --Timer m +12298 ARGUMENT +12299 IST-AlertArg +12300 RESULT +12301 IST-AlertRes +12302 -- optional +12303 ERRORS { +12304 unexpectedDataValue | +12305 resourceLimitation | +12306 unknownSubscriber | +12307 systemFailure | +12308 facilityNotSupported} +12309 CODE local:87 } +12310 +12311 ist-Command OPERATION ::= { --Timer m +12312 ARGUMENT +12313 IST-CommandArg +12314 RESULT +12315 IST-CommandRes +12316 -- optional +12317 ERRORS { +12318 unexpectedDataValue | +12319 resourceLimitation | +12320 unknownSubscriber | +12321 systemFailure | +12322 facilityNotSupported} +12323 CODE local:88 } +12324 +12325 releaseResources OPERATION ::= { --Timer m +12326 ARGUMENT +12327 ReleaseResourcesArg +12328 RESULT +12329 ReleaseResourcesRes +12330 -- optional +12331 ERRORS { +12332 unexpectedDataValue | +12333 systemFailure } +12334 CODE local:20 } +12335 +12336 END + +``` + +## 12337 17.6.4 Supplementary service operations + +``` + +12338 MAP-SupplementaryServiceOperations { +12339 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12340 gsm-Network (1) modules (3) map-SupplementaryServiceOperations (8) +12341 version21 (21)} +12342 +12343 DEFINITIONS +12344 +12345 ::= + +``` + +``` + +12346 +12347 BEGIN +12348 +12349 EXPORTS +12350 registerSS, +12351 eraseSS, +12352 activateSS, +12353 deactivateSS, +12354 interrogateSS, +12355 processUnstructuredSS-Request, +12356 unstructuredSS-Request, +12357 unstructuredSS-Notify, +12358 registerPassword, +12359 getPassword, +12360 ss-InvocationNotification, +12361 registerCC-Entry, +12362 eraseCC-Entry +12363 ; +12364 +12365 IMPORTS +12366 OPERATION +12367 FROM Remote-Operations-Information-Objects { +12368 joint-iso-itu-t remote-operations(4) +12369 informationObjects(5) version1(0)} +12370 +12371 systemFailure, +12372 dataMissing, +12373 unexpectedDataValue, +12374 unknownSubscriber, +12375 bearerServiceNotProvisioned, +12376 teleserviceNotProvisioned, +12377 callBarred, +12378 illegalSS-Operation, +12379 ss-ErrorStatus, +12380 ss-NotAvailable, +12381 ss-SubscriptionViolation, +12382 ss-Incompatibility, +12383 pw-RegistrationFailure, +12384 negativePW-Check, +12385 numberOfPW-AttemptsViolation, +12386 unknownAlphabet, +12387 ussd-Busy, +12388 absentSubscriber, +12389 illegalSubscriber, +12390 illegalEquipment, +12391 shortTermDenial, +12392 longTermDenial, +12393 facilityNotSupported +12394 FROM MAP-Errors { +12395 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12396 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +12397 +12398 RegisterSS-Arg, +12399 SS-Info, +12400 SS-ForBS-Code, +12401 InterrogateSS-Res, +12402 USSD-Arg, +12403 USSD-Res, +12404 Password, +12405 GuidanceInfo, +12406 SS-InvocationNotificationArg, +12407 SS-InvocationNotificationRes, +12408 RegisterCC-EntryArg, +12409 RegisterCC-EntryRes, +12410 EraseCC-EntryArg, +12411 EraseCC-EntryRes +12412 FROM MAP-SS-DataTypes { +12413 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12414 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +12415 +12416 SS-Code +12417 FROM MAP-SS-Code { +12418 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12419 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +12420 ; +12421 +12422 +12423 -- supplementary service handling operations +12424 + +``` + +``` +12425 registerSS OPERATION ::= { --Timer m +12426 ARGUMENT +12427 RegisterSS-Arg +12428 RESULT +12429 SS-Info +12430 -- optional +12431 ERRORS { +12432 systemFailure | +12433 dataMissing | +12434 unexpectedDataValue | +12435 bearerServiceNotProvisioned | +12436 teleserviceNotProvisioned | +12437 callBarred | +12438 illegalSS-Operation | +12439 ss-ErrorStatus | +12440 ss-Incompatibility} +12441 CODE local:10 } +``` + +``` +12442 +12443 eraseSS OPERATION ::= { --Timer m +12444 ARGUMENT +12445 SS-ForBS-Code +12446 RESULT +12447 SS-Info +12448 -- optional +12449 ERRORS { +12450 systemFailure | +12451 dataMissing | +12452 unexpectedDataValue | +12453 bearerServiceNotProvisioned | +12454 teleserviceNotProvisioned | +12455 callBarred | +12456 illegalSS-Operation | +12457 ss-ErrorStatus +12458 } +12459 CODE local:11 } +``` + +``` +12460 +12461 activateSS OPERATION ::= { --Timer m +12462 ARGUMENT +12463 SS-ForBS-Code +12464 RESULT +12465 SS-Info +12466 -- optional +12467 ERRORS { +12468 systemFailure | +12469 dataMissing | +12470 unexpectedDataValue | +12471 bearerServiceNotProvisioned | +12472 teleserviceNotProvisioned | +12473 callBarred | +12474 illegalSS-Operation | +12475 ss-ErrorStatus | +12476 ss-SubscriptionViolation | +12477 ss-Incompatibility | +12478 negativePW-Check | +12479 numberOfPW-AttemptsViolation} +12480 CODE local:12 } +``` + +``` +12481 +12482 deactivateSS OPERATION ::= { --Timer m +12483 ARGUMENT +12484 SS-ForBS-Code +12485 RESULT +12486 SS-Info +12487 -- optional +12488 ERRORS { +12489 systemFailure | +12490 dataMissing | +12491 unexpectedDataValue | +12492 bearerServiceNotProvisioned | +12493 teleserviceNotProvisioned | +12494 callBarred | +12495 illegalSS-Operation | +12496 ss-ErrorStatus | +12497 ss-SubscriptionViolation | +12498 negativePW-Check | +12499 numberOfPW-AttemptsViolation} +12500 CODE local:13 } +``` + +``` +12501 +``` + +``` + +12502 interrogateSS OPERATION ::= { --Timer m +12503 ARGUMENT +12504 SS-ForBS-Code +12505 RESULT +12506 InterrogateSS-Res +12507 ERRORS { +12508 systemFailure | +12509 dataMissing | +12510 unexpectedDataValue | +12511 bearerServiceNotProvisioned | +12512 teleserviceNotProvisioned | +12513 callBarred | +12514 illegalSS-Operation | +12515 ss-NotAvailable} +12516 CODE local:14 } +12517 +12518 processUnstructuredSS-Request OPERATION ::= {--Timer 10 minutes +12519 ARGUMENT +12520 USSD-Arg +12521 RESULT +12522 USSD-Res +12523 ERRORS { +12524 systemFailure | +12525 dataMissing | +12526 unexpectedDataValue | +12527 unknownAlphabet | +12528 callBarred} +12529 CODE local:59 } +12530 +12531 unstructuredSS-Request OPERATION ::= { --Timer ml +12532 ARGUMENT +12533 USSD-Arg +12534 RESULT +12535 USSD-Res +12536 -- optional +12537 ERRORS { +12538 systemFailure | +12539 dataMissing | +12540 unexpectedDataValue | +12541 absentSubscriber | +12542 illegalSubscriber | +12543 illegalEquipment | +12544 unknownAlphabet | +12545 ussd-Busy} +12546 CODE local:60 } +12547 +12548 unstructuredSS-Notify OPERATION ::= { --Timer ml +12549 ARGUMENT +12550 USSD-Arg +12551 RETURN RESULT TRUE +12552 ERRORS { +12553 systemFailure | +12554 dataMissing | +12555 unexpectedDataValue | +12556 absentSubscriber | +12557 illegalSubscriber | +12558 illegalEquipment | +12559 unknownAlphabet | +12560 ussd-Busy} +12561 CODE local:61 } +12562 + +``` + +``` + +12563 registerPassword OPERATION ::= { --Timer ml +12564 ARGUMENT +12565 SS-Code +12566 RESULT +12567 Password +12568 ERRORS { +12569 systemFailure | +12570 dataMissing | +12571 unexpectedDataValue | +12572 callBarred | +12573 ss-SubscriptionViolation | +12574 pw-RegistrationFailure | +12575 negativePW-Check | +12576 numberOfPW-AttemptsViolation} +12577 LINKED { +12578 getPassword} +12579 CODE local:17 } +12580 +12581 getPassword OPERATION ::= { --Timer m +12582 ARGUMENT +12583 GuidanceInfo +12584 RESULT +12585 Password +12586 CODE local:18 } +12587 +12588 ss-InvocationNotification OPERATION ::= { --Timer m +12589 ARGUMENT +12590 SS-InvocationNotificationArg +12591 RESULT +12592 SS-InvocationNotificationRes +12593 -- optional +12594 ERRORS { +12595 dataMissing | +12596 unexpectedDataValue | +12597 unknownSubscriber} +12598 CODE local:72 } +12599 +12600 registerCC-Entry OPERATION ::= { --Timer m +12601 ARGUMENT +12602 RegisterCC-EntryArg +12603 RESULT +12604 RegisterCC-EntryRes +12605 ERRORS { +12606 systemFailure | +12607 dataMissing | +12608 unexpectedDataValue | +12609 callBarred | +12610 illegalSS-Operation | +12611 ss-ErrorStatus | +12612 ss-Incompatibility | +12613 shortTermDenial | +12614 longTermDenial | +12615 facilityNotSupported} +12616 CODE local:76 } +12617 +12618 eraseCC-Entry OPERATION ::= { --Timer m +12619 ARGUMENT +12620 EraseCC-EntryArg +12621 RESULT +12622 EraseCC-EntryRes +12623 ERRORS { +12624 systemFailure | +12625 dataMissing | +12626 unexpectedDataValue | +12627 callBarred | +12628 illegalSS-Operation | +12629 ss-ErrorStatus} +12630 CODE local:77 } +12631 +12632 END + +``` + +## 12633 17.6.5 Short message service operations + +``` + +12634 MAP-ShortMessageServiceOperations { +12635 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12636 gsm-Network (1) modules (3) map-ShortMessageServiceOperations (9) +12637 version21 (21)} +12638 + +``` + +``` + +12639 DEFINITIONS +12640 +12641 ::= +12642 +12643 BEGIN +12644 +12645 EXPORTS +12646 sendRoutingInfoForSM, +12647 mo-ForwardSM, +12648 mt-ForwardSM, +12649 reportSM-DeliveryStatus, +12650 alertServiceCentre, +12651 informServiceCentre, +12652 readyForSM, +12653 mt-ForwardSM-VGCS +12654 ; +12655 +12656 IMPORTS +12657 OPERATION +12658 FROM Remote-Operations-Information-Objects { +12659 joint-iso-itu-t remote-operations(4) +12660 informationObjects(5) version1(0)} +12661 +12662 systemFailure, +12663 dataMissing, +12664 unexpectedDataValue, +12665 facilityNotSupported, +12666 unknownSubscriber, +12667 unidentifiedSubscriber, +12668 illegalSubscriber, +12669 illegalEquipment, +12670 teleserviceNotProvisioned, +12671 callBarred, +12672 subscriberBusyForMT-SMS, +12673 sm-DeliveryFailure, +12674 messageWaitingListFull, +12675 absentSubscriberSM +12676 FROM MAP-Errors { +12677 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12678 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +12679 +12680 RoutingInfoForSM-Arg, +12681 RoutingInfoForSM-Res, +12682 MO-ForwardSM-Arg, +12683 MO-ForwardSM-Res, +12684 MT-ForwardSM-Arg, +12685 MT-ForwardSM-Res, +12686 ReportSM-DeliveryStatusArg, +12687 ReportSM-DeliveryStatusRes, +12688 AlertServiceCentreArg, +12689 InformServiceCentreArg, +12690 ReadyForSM-Arg, +12691 ReadyForSM-Res, +12692 MT-ForwardSM-VGCS-Arg, +12693 MT-ForwardSM-VGCS-Res +12694 FROM MAP-SM-DataTypes { +12695 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12696 gsm-Network (1) modules (3) map-SM-DataTypes (16) version21 (21)} +12697 +12698 ; +12699 +12700 sendRoutingInfoForSM OPERATION ::= { --Timer m +12701 ARGUMENT +12702 RoutingInfoForSM-Arg +12703 RESULT +12704 RoutingInfoForSM-Res +12705 ERRORS { +12706 systemFailure | +12707 dataMissing | +12708 unexpectedDataValue | +12709 facilityNotSupported | +12710 unknownSubscriber | +12711 teleserviceNotProvisioned | +12712 callBarred | +12713 absentSubscriberSM} +12714 CODE local:45 } +12715 + +``` + +``` + +12716 mo-ForwardSM OPERATION ::= { --Timer ml +12717 ARGUMENT +12718 MO-ForwardSM-Arg +12719 RESULT +12720 MO-ForwardSM-Res +12721 -- optional +12722 ERRORS { +12723 systemFailure | +12724 unexpectedDataValue | +12725 facilityNotSupported | +12726 sm-DeliveryFailure} +12727 CODE local:46 } +12728 +12729 mt-ForwardSM OPERATION ::= { --Timer ml +12730 -- the timer value may be subject to negotiation between GMSC and IP-SM-GW +12731 ARGUMENT +12732 MT-ForwardSM-Arg +12733 RESULT +12734 MT-ForwardSM-Res +12735 -- optional +12736 ERRORS { +12737 systemFailure | +12738 dataMissing | +12739 unexpectedDataValue | +12740 facilityNotSupported | +12741 unidentifiedSubscriber | +12742 illegalSubscriber | +12743 illegalEquipment | +12744 subscriberBusyForMT-SMS | +12745 sm-DeliveryFailure | +12746 absentSubscriberSM} +12747 CODE local:44 } +12748 +12749 reportSM-DeliveryStatus OPERATION ::= { --Timer s +12750 ARGUMENT +12751 ReportSM-DeliveryStatusArg +12752 RESULT +12753 ReportSM-DeliveryStatusRes +12754 -- optional +12755 ERRORS { +12756 dataMissing | +12757 unexpectedDataValue | +12758 unknownSubscriber | +12759 messageWaitingListFull} +12760 CODE local:47 } +12761 +12762 alertServiceCentre OPERATION ::= { --Timer s +12763 ARGUMENT +12764 AlertServiceCentreArg +12765 RETURN RESULT TRUE +12766 ERRORS { +12767 systemFailure | +12768 dataMissing | +12769 unexpectedDataValue} +12770 CODE local:64 } +12771 +12772 informServiceCentre OPERATION ::= { --Timer s +12773 ARGUMENT +12774 InformServiceCentreArg +12775 CODE local:63 } +12776 +12777 readyForSM OPERATION ::= { --Timer m +12778 ARGUMENT +12779 ReadyForSM-Arg +12780 RESULT +12781 ReadyForSM-Res +12782 -- optional +12783 ERRORS { +12784 dataMissing | +12785 unexpectedDataValue | +12786 facilityNotSupported | +12787 unknownSubscriber} +12788 CODE local:66 } +12789 + +``` + +``` + +12790 mt-ForwardSM-VGCS OPERATION ::= { --Timer ml +12791 ARGUMENT +12792 MT-ForwardSM-VGCS-Arg +12793 RESULT +12794 MT-ForwardSM-VGCS-Res +12795 -- optional +12796 ERRORS { +12797 systemFailure | +12798 unexpectedDataValue } +12799 CODE local:21 } +12800 +12801 +12802 END + +``` + +## 12803 17.6.6 Errors + +``` + +12804 MAP-Errors { +12805 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12806 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +12807 +12808 DEFINITIONS +12809 +12810 ::= +12811 +12812 BEGIN +12813 +12814 EXPORTS +12815 +12816 -- generic errors +12817 systemFailure, +12818 dataMissing, +12819 unexpectedDataValue, +12820 facilityNotSupported, +12821 incompatibleTerminal, +12822 resourceLimitation, +12823 +12824 -- identification and numbering errors +12825 unknownSubscriber, +12826 numberChanged, +12827 unknownMSC, +12828 unidentifiedSubscriber, +12829 unknownEquipment, +12830 +12831 -- subscription errors +12832 roamingNotAllowed, +12833 illegalSubscriber, +12834 illegalEquipment, +12835 bearerServiceNotProvisioned, +12836 teleserviceNotProvisioned, +12837 +12838 -- handover errors +12839 noHandoverNumberAvailable, +12840 subsequentHandoverFailure, +12841 targetCellOutsideGroupCallArea, +12842 +12843 -- operation and maintenance errors +12844 tracingBufferFull, +12845 +12846 -- call handling errors +12847 or-NotAllowed, +12848 noRoamingNumberAvailable, +12849 busySubscriber, +12850 noSubscriberReply, +12851 absentSubscriber, +12852 callBarred, +12853 forwardingViolation, +12854 forwardingFailed, +12855 cug-Reject, +12856 +12857 -- any time interrogation errors +12858 ati-NotAllowed, +12859 +12860 -- any time information handling errors +12861 atsi-NotAllowed, +12862 atm-NotAllowed, +12863 informationNotAvailable, +12864 + +``` + +``` + +12865 -- supplementary service errors +12866 illegalSS-Operation, +12867 ss-ErrorStatus, +12868 ss-NotAvailable, +12869 ss-SubscriptionViolation, +12870 ss-Incompatibility, +12871 unknownAlphabet, +12872 ussd-Busy, +12873 pw-RegistrationFailure, +12874 negativePW-Check, +12875 numberOfPW-AttemptsViolation, +12876 shortTermDenial, +12877 longTermDenial, +12878 +12879 -- short message service errors +12880 subscriberBusyForMT-SMS, +12881 sm-DeliveryFailure, +12882 messageWaitingListFull, +12883 absentSubscriberSM, +12884 +12885 -- Group Call errors +12886 noGroupCallNumberAvailable, +12887 ongoingGroupCall, +12888 +12889 -- location service errors +12890 unauthorizedRequestingNetwork, +12891 unauthorizedLCSCClient, +12892 positionMethodFailure, +12893 unknownOrUnreachableLCSCClient, +12894 +12895 -- Mobility Management errors +12896 mm-EventNotSupported +12897 +12898 +12899 ; +12900 +12901 IMPORTS +12902 ERROR +12903 FROM Remote-Operations-Information-Objects {joint-iso-itu-t remote-operations(4) +12904 informationObjects(5) version1(0) } +12905 +12906 SS-Status +12907 FROM MAP-SS-DataTypes { +12908 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12909 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +12910 +12911 SS-IncompatibilityCause, +12912 PW-RegistrationFailureCause, +12913 SM-DeliveryFailureCause, +12914 SystemFailureParam, +12915 DataMissingParam, +12916 UnexpectedDataParam, +12917 FacilityNotSupParam, +12918 UnknownSubscriberParam, +12919 NumberChangedParam, +12920 UnidentifiedSubParam, +12921 RoamingNotAllowedParam, +12922 IllegalSubscriberParam, +12923 IllegalEquipmentParam, +12924 BearerServNotProvParam, +12925 TeleservNotProvParam, +12926 TracingBufferFullParam, +12927 NoRoamingNbParam, +12928 OR-NotAllowedParam, +12929 AbsentSubscriberParam, +12930 BusySubscriberParam, +12931 NoSubscriberReplyParam, +12932 CallBarredParam, +12933 ForwardingViolationParam, +12934 ForwardingFailedParam, +12935 CUG-RejectParam, +12936 ATI-NotAllowedParam, +12937 SubBusyForMT-SMS-Param, +12938 MessageWaitListFullParam, +12939 AbsentSubscriberSM-Param, +12940 ResourceLimitationParam, +12941 NoGroupCallNbParam, +12942 IncompatibleTerminalParam, +12943 ShortTermDenialParam, + +``` + +``` + +12944 LongTermDenialParam, +12945 UnauthorizedRequestingNetwork-Param, +12946 UnauthorizedLCSCClient-Param, +12947 PositionMethodFailure-Param, +12948 UnknownOrUnreachableLCSCClient-Param, +12949 MM-EventNotSupported-Param, +12950 ATSI-NotAllowedParam, +12951 ATM-NotAllowedParam, +12952 IllegalSS-OperationParam, +12953 SS-NotAvailableParam, +12954 SS-SubscriptionViolationParam, +12955 InformationNotAvailableParam, +12956 TargetCellOutsideGCA-Param, +12957 OngoingGroupCallParam +12958 FROM MAP-ER-DataTypes { +12959 itu-t identified-organization (4) etsi (0) mobileDomain (0) +12960 gsm-Network (1) modules (3) map-ER-DataTypes (17) version21 (21)} +12961 ; +12962 +12963 -- generic errors +12964 +12965 systemFailure ERROR ::= { +12966 PARAMETER +12967 SystemFailureParam +12968 -- optional +12969 CODE local:34 } +12970 +12971 dataMissing ERROR ::= { +12972 PARAMETER +12973 DataMissingParam +12974 -- optional +12975 -- DataMissingParam must not be used in version <3 +12976 CODE local:35 } +12977 +12978 unexpectedDataValue ERROR ::= { +12979 PARAMETER +12980 UnexpectedDataParam +12981 -- optional +12982 -- UnexpectedDataParam must not be used in version <3 +12983 CODE local:36 } +12984 +12985 facilityNotSupported ERROR ::= { +12986 PARAMETER +12987 FacilityNotSupParam +12988 -- optional +12989 -- FacilityNotSupParam must not be used in version <3 +12990 CODE local:21 } +12991 +12992 incompatibleTerminal ERROR ::= { +12993 PARAMETER +12994 IncompatibleTerminalParam +12995 -- optional +12996 CODE local:28 } +12997 +12998 resourceLimitation ERROR ::= { +12999 PARAMETER +13000 ResourceLimitationParam +13001 -- optional +13002 CODE local:51 } +13003 +13004 -- identification and numbering errors +13005 +13006 unknownSubscriber ERROR ::= { +13007 PARAMETER +13008 UnknownSubscriberParam +13009 -- optional +13010 -- UnknownSubscriberParam must not be used in version <3 +13011 CODE local:1 } +13012 +13013 numberChanged ERROR ::= { +13014 PARAMETER +13015 NumberChangedParam +13016 -- optional +13017 CODE local:44 } +13018 +13019 unknownMSC ERROR ::= { +13020 CODE local:3 } + +``` + +``` + +13021 +13022 unidentifiedSubscriber ERROR ::= { +13023 PARAMETER +13024 UnidentifiedSubParam +13025 -- optional +13026 -- UnidentifiedSubParam must not be used in version <3 +13027 CODE local:5 } +13028 +13029 unknownEquipment ERROR ::= { +13030 CODE local:7 } +13031 +13032 -- subscription errors +13033 +13034 roamingNotAllowed ERROR ::= { +13035 PARAMETER +13036 RoamingNotAllowedParam +13037 CODE local:8 } +13038 +13039 illegalSubscriber ERROR ::= { +13040 PARAMETER +13041 IllegalSubscriberParam +13042 -- optional +13043 -- IllegalSubscriberParam must not be used in version <3 +13044 CODE local:9 } +13045 +13046 illegalEquipment ERROR ::= { +13047 PARAMETER +13048 IllegalEquipmentParam +13049 -- optional +13050 -- IllegalEquipmentParam must not be used in version <3 +13051 CODE local:12 } +13052 +13053 bearerServiceNotProvisioned ERROR ::= { +13054 PARAMETER +13055 BearerServNotProvParam +13056 -- optional +13057 -- BearerServNotProvParam must not be used in version <3 +13058 CODE local:10 } +13059 +13060 teleserviceNotProvisioned ERROR ::= { +13061 PARAMETER +13062 TeleservNotProvParam +13063 -- optional +13064 -- TeleservNotProvParam must not be used in version <3 +13065 CODE local:11 } +13066 +13067 -- handover errors +13068 +13069 noHandoverNumberAvailable ERROR ::= { +13070 CODE local:25 } +13071 +13072 subsequentHandoverFailure ERROR ::= { +13073 CODE local:26 } +13074 +13075 targetCellOutsideGroupCallArea ERROR ::= { +13076 PARAMETER +13077 TargetCellOutsideGCA-Param +13078 -- optional +13079 CODE local:42 } +13080 +13081 -- operation and maintenance errors +13082 +13083 tracingBufferFull ERROR ::= { +13084 PARAMETER +13085 TracingBufferFullParam +13086 -- optional +13087 CODE local: 40 } +13088 +13089 -- call handling errors +13090 +13091 noRoamingNumberAvailable ERROR ::= { +13092 PARAMETER +13093 NoRoamingNbParam +13094 -- optional +13095 CODE local:39 } +13096 + +``` + +``` +13097 absentSubscriber ERROR ::= { +13098 PARAMETER +13099 AbsentSubscriberParam +13100 -- optional +13101 -- AbsentSubscriberParam must not be used in version <3 +13102 CODE local:27 } +``` + +13103 + +``` +13104 busySubscriber ERROR ::= { +13105 PARAMETER +13106 BusySubscriberParam +13107 -- optional +13108 CODE local:45 } +``` + +13109 + +``` +13110 noSubscriberReply ERROR ::= { +13111 PARAMETER +13112 NoSubscriberReplyParam +13113 -- optional +13114 CODE local:46 } +``` + +13115 + +``` +13116 callBarred ERROR ::= { +13117 PARAMETER +13118 CallBarredParam +13119 -- optional +13120 CODE local:13 } +``` + +13121 + +``` +13122 forwardingViolation ERROR ::= { +13123 PARAMETER +13124 ForwardingViolationParam +13125 -- optional +13126 CODE local:14 } +``` + +13127 + +``` +13128 forwardingFailed ERROR ::= { +13129 PARAMETER +13130 ForwardingFailedParam +13131 -- optional +13132 CODE local:47 } +``` + +13133 + +``` +13134 cug-Reject ERROR ::= { +13135 PARAMETER +13136 CUG-RejectParam +13137 -- optional +13138 CODE local:15 } +``` + +13139 + +``` +13140 or-NotAllowed ERROR ::= { +13141 PARAMETER +13142 OR-NotAllowedParam +13143 -- optional +13144 CODE local:48 } +``` + +13145 + +13146 -- any time interrogation errors + +``` +13147 ati-NotAllowed ERROR ::= { +13148 PARAMETER +13149 ATI-NotAllowedParam +13150 -- optional +13151 CODE local:49 } +``` + +13152 + +13153 -- any time information handling errors + +``` +13154 atsi-NotAllowed ERROR ::= { +13155 PARAMETER +13156 ATSI-NotAllowedParam +13157 -- optional +13158 CODE local:60 } +``` + +13159 + +``` +13160 atm-NotAllowed ERROR ::= { +13161 PARAMETER +13162 ATM-NotAllowedParam +13163 -- optional +13164 CODE local:61 } +``` + +13165 + +``` +13166 informationNotAvailable ERROR ::= { +13167 PARAMETER +13168 InformationNotAvailableParam +13169 -- optional +13170 CODE local:62 } +``` + +13171 + +13172 -- supplementary service errors + +13173 + +``` + +13174 illegalSS-Operation ERROR ::= { +13175 PARAMETER +13176 IllegalSS-OperationParam +13177 -- optional +13178 -- IllegalSS-OperationParam must not be used in version <3 +13179 CODE local:16 } +13180 +13181 ss-ErrorStatus ERROR ::= { +13182 PARAMETER +13183 SS-Status +13184 -- optional +13185 CODE local:17 } +13186 +13187 ss-NotAvailable ERROR ::= { +13188 PARAMETER +13189 SS-NotAvailableParam +13190 -- optional +13191 -- SS-NotAvailableParam must not be used in version <3 +13192 CODE local:18 } +13193 +13194 ss-SubscriptionViolation ERROR ::= { +13195 PARAMETER +13196 SS-SubscriptionViolationParam +13197 -- optional +13198 -- SS-SubscriptionViolationParam must not be used in version <3 +13199 CODE local:19 } +13200 +13201 ss-Incompatibility ERROR ::= { +13202 PARAMETER +13203 SS-IncompatibilityCause +13204 -- optional +13205 CODE local:20 } +13206 +13207 unknownAlphabet ERROR ::= { +13208 CODE local:71 } +13209 +13210 ussd-Busy ERROR ::= { +13211 CODE local:72 } +13212 +13213 pw-RegistrationFailure ERROR ::= { +13214 PARAMETER +13215 PW-RegistrationFailureCause +13216 CODE local:37 } +13217 +13218 negativePW-Check ERROR ::= { +13219 CODE local:38 } +13220 +13221 numberOfPW-AttemptsViolation ERROR ::= { +13222 CODE local:43 } +13223 +13224 shortTermDenial ERROR ::= { +13225 PARAMETER +13226 ShortTermDenialParam +13227 -- optional +13228 CODE local:29 } +13229 +13230 longTermDenial ERROR ::= { +13231 PARAMETER +13232 LongTermDenialParam +13233 -- optional +13234 CODE local:30 } +13235 +13236 -- short message service errors +13237 +13238 subscriberBusyForMT-SMS ERROR ::= { +13239 PARAMETER +13240 SubBusyForMT-SMS-Param +13241 -- optional +13242 CODE local:31 } +13243 +13244 sm-DeliveryFailure ERROR ::= { +13245 PARAMETER +13246 SM-DeliveryFailureCause +13247 CODE local:32 } +13248 + +``` + +``` + +13249 messageWaitingListFull ERROR ::= { +13250 PARAMETER +13251 MessageWaitListFullParam +13252 -- optional +13253 CODE local:33 } +13254 +13255 absentSubscriberSM ERROR ::= { +13256 PARAMETER +13257 AbsentSubscriberSM-Param +13258 -- optional +13259 CODE local:6 } +13260 +13261 -- Group Call errors +13262 +13263 noGroupCallNumberAvailable ERROR ::= { +13264 PARAMETER +13265 NoGroupCallNbParam +13266 -- optional +13267 CODE local:50 } +13268 +13269 ongoingGroupCall ERROR ::= { +13270 PARAMETER +13271 OngoingGroupCallParam +13272 -- optional +13273 CODE local:22 } +13274 +13275 -- location service errors +13276 +13277 unauthorizedRequestingNetwork ERROR ::= { +13278 PARAMETER +13279 UnauthorizedRequestingNetwork-Param +13280 -- optional +13281 CODE local:52 } +13282 +13283 unauthorizedLCSCClient ERROR ::= { +13284 PARAMETER +13285 UnauthorizedLCSCClient-Param +13286 -- optional +13287 CODE local:53 } +13288 +13289 positionMethodFailure ERROR ::= { +13290 PARAMETER +13291 PositionMethodFailure-Param +13292 -- optional +13293 CODE local:54 } +13294 +13295 unknownOrUnreachableLCSCClient ERROR ::= { +13296 PARAMETER +13297 UnknownOrUnreachableLCSCClient-Param +13298 -- optional +13299 CODE local:58 } +13300 +13301 mm-EventNotSupported ERROR ::= { +13302 PARAMETER +13303 MM-EventNotSupported-Param +13304 -- optional +13305 CODE local:59 } +13306 +13307 +13308 END + +``` + +## 13309 17.6.7 Group Call operations + +``` + +13310 MAP-Group-Call-Operations { +13311 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13312 gsm-Network (1) modules (3) map-Group-Call-Operations (22) +13313 version21 (21)} +13314 +13315 DEFINITIONS +13316 +13317 ::= +13318 +13319 BEGIN +13320 +13321 EXPORTS +13322 prepareGroupCall, +13323 sendGroupCallEndSignal, + +``` + +``` + +13324 forwardGroupCallSignalling, +13325 processGroupCallSignalling, +13326 sendGroupCallInfo +13327 ; +13328 +13329 IMPORTS +13330 OPERATION +13331 FROM Remote-Operations-Information-Objects { +13332 joint-iso-itu-t remote-operations(4) +13333 informationObjects(5) version1(0)} +13334 +13335 systemFailure, +13336 unexpectedDataValue, +13337 noGroupCallNumberAvailable, +13338 ongoingGroupCall, +13339 unknownSubscriber, +13340 teleserviceNotProvisioned, +13341 dataMissing +13342 FROM MAP-Errors { +13343 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13344 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +13345 +13346 PrepareGroupCallArg, +13347 PrepareGroupCallRes, +13348 SendGroupCallEndSignalArg, +13349 SendGroupCallEndSignalRes, +13350 ForwardGroupCallSignallingArg, +13351 ProcessGroupCallSignallingArg, +13352 SendGroupCallInfoArg, +13353 SendGroupCallInfoRes +13354 FROM MAP-GR-DataTypes { +13355 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13356 gsm-Network (1) modules (3) map-GR-DataTypes (23) version21 (21)} +13357 +13358 ; +13359 +13360 prepareGroupCall OPERATION ::= { --Timer m +13361 ARGUMENT +13362 PrepareGroupCallArg +13363 RESULT +13364 PrepareGroupCallRes +13365 ERRORS { +13366 systemFailure | +13367 noGroupCallNumberAvailable | +13368 unexpectedDataValue} +13369 CODE local:39 } +13370 +13371 sendGroupCallEndSignal OPERATION ::= { --Timer l +13372 ARGUMENT +13373 SendGroupCallEndSignalArg +13374 RESULT +13375 SendGroupCallEndSignalRes +13376 CODE local:40 } +13377 +13378 processGroupCallSignalling OPERATION ::= { --Timer s +13379 ARGUMENT +13380 ProcessGroupCallSignallingArg +13381 CODE local:41 } +13382 +13383 forwardGroupCallSignalling OPERATION ::= { --Timer s +13384 ARGUMENT +13385 ForwardGroupCallSignallingArg +13386 CODE local:42 } +13387 +13388 sendGroupCallInfo OPERATION ::= { --Timer m +13389 ARGUMENT +13390 SendGroupCallInfoArg +13391 RESULT +13392 SendGroupCallInfoRes +13393 ERRORS { +13394 systemFailure | +13395 ongoingGroupCall | +13396 unexpectedDataValue | +13397 dataMissing | +13398 teleserviceNotProvisioned | +13399 unknownSubscriber} +13400 CODE local:84 } +13401 + +``` + +13402 +13403 END + +## 17.6.8 Location service operations + +``` +13404 MAP-LocationServiceOperations { +13405 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13406 gsm-Network (1) modules (3) map-LocationServiceOperations (24) +13407 version21 (21)} +13408 +13409 DEFINITIONS +13410 +13411 ::= +13412 +13413 BEGIN +13414 +13415 EXPORTS +13416 provideSubscriberLocation, +13417 sendRoutingInfoForLCS, +13418 subscriberLocationReport +13419 ; +13420 +13421 IMPORTS +13422 OPERATION +13423 FROM Remote-Operations-Information-Objects { +13424 joint-iso-itu-t remote-operations(4) +13425 informationObjects(5) version1(0)} +13426 +13427 systemFailure, +13428 dataMissing, +13429 unexpectedDataValue, +13430 facilityNotSupported, +13431 unknownSubscriber, +13432 absentSubscriber, +13433 unauthorizedRequestingNetwork, +13434 unauthorizedLCSClient, +13435 positionMethodFailure, +13436 resourceLimitation, +13437 unknownOrUnreachableLCSClient, +13438 unidentifiedSubscriber, +13439 illegalEquipment, +13440 illegalSubscriber +13441 FROM MAP-Errors { +13442 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13443 gsm-Network (1) modules (3) map-Errors (10) version21 (21)} +13444 +13445 RoutingInfoForLCS-Arg, +13446 RoutingInfoForLCS-Res, +13447 ProvideSubscriberLocation-Arg, +13448 ProvideSubscriberLocation-Res, +13449 SubscriberLocationReport-Arg, +13450 SubscriberLocationReport-Res +13451 FROM MAP-LCS-DataTypes { +13452 itu-t identified-organization (4) etsi (0) mobileDomain (0) +13453 gsm-Network (1) modules (3) map-LCS-DataTypes (25) version21 (21)} +13454 ; +13455 +13456 sendRoutingInfoForLCS OPERATION ::= { --Timer m +13457 ARGUMENT +13458 RoutingInfoForLCS-Arg +13459 RESULT +13460 RoutingInfoForLCS-Res +13461 ERRORS { +13462 systemFailure | +13463 dataMissing | +13464 unexpectedDataValue | +13465 facilityNotSupported | +13466 unknownSubscriber | +13467 absentSubscriber | +13468 unauthorizedRequestingNetwork } +13469 CODE local:85 } +``` + +``` + +13471 provideSubscriberLocation OPERATION ::= { --Timer ml +13472 ARGUMENT +13473 ProvideSubscriberLocation-Arg +13474 RESULT +13475 ProvideSubscriberLocation-Res +13476 ERRORS { +13477 systemFailure | +13478 dataMissing | +13479 unexpectedDataValue | +13480 facilityNotSupported | +13481 unidentifiedSubscriber | +13482 illegalSubscriber | +13483 illegalEquipment | +13484 absentSubscriber | +13485 unauthorizedRequestingNetwork | +13486 unauthorizedLCSClient | +13487 positionMethodFailure } +13488 CODE local:83 } + +``` + +``` + +13489 +13490 subscriberLocationReport OPERATION ::= { --Timer m +13491 ARGUMENT +13492 SubscriberLocationReport-Arg +13493 RESULT +13494 SubscriberLocationReport-Res +13495 ERRORS { +13496 systemFailure | +13497 dataMissing | +13498 resourceLimitation | +13499 unexpectedDataValue | +13500 unknownSubscriber | +13501 unauthorizedRequestingNetwork | +13502 unknownOrUnreachableLCSClient } +13503 CODE local:86 } + +``` + +``` + +13504 +13505 +13506 END + +``` + +1 + +## 17.6.9 Void + +2 + +## 3 17.7 MAP constants and data types + +### 4 17.7.1 Mobile Service data types + +``` + +5 MAP-MS-DataTypes { +6 itu-t identified-organization (4) etsi (0) mobileDomain (0) +7 gsm-Network (1) modules (3) map-MS-DataTypes (11) version21 (21)} +8 +9 DEFINITIONS +10 +11 IMPLICIT TAGS +12 +13 ::= +14 +15 BEGIN +16 +17 EXPORTS +18 +19 -- location registration types +20 UpdateLocationArg, +21 UpdateLocationRes, +22 CancelLocationArg, +23 CancelLocationRes, +24 PurgeMS-Arg, +25 PurgeMS-Res, +26 SendIdentificationArg, +27 SendIdentificationRes, +28 UpdateGprsLocationArg, +29 UpdateGprsLocationRes, +30 IST-SupportIndicator, +31 SupportedLCS-CapabilitySets, +32 UpdateVcsgLocationArg, + +``` + +``` +33 UpdateVcsgLocationRes, +34 CancelVcsgLocationArg, +35 CancelVcsgLocationRes, +36 +37 +38 -- handover types +39 ForwardAccessSignalling-Arg, +40 PrepareHO-Arg, +41 PrepareHO-Res, +42 PrepareSubsequentHO-Arg, +43 PrepareSubsequentHO-Res, +44 ProcessAccessSignalling-Arg, +45 SendEndSignal-Arg, +46 SendEndSignal-Res, +47 +48 -- authentication management types +49 SendAuthenticationInfoArg, +50 SendAuthenticationInfoRes, +51 AuthenticationFailureReportArg, +52 AuthenticationFailureReportRes, +53 +54 -- security management types +55 Kc, +56 Cksn, +57 +58 -- equipment management types +59 CheckIMEI-Arg, +60 CheckIMEI-Res, +61 +62 -- subscriber management types +63 InsertSubscriberDataArg, +64 InsertSubscriberDataRes, +65 LSAIdentity, +66 DeleteSubscriberDataArg, +67 DeleteSubscriberDataRes, +68 Ext-QoS-Subscribed, +69 Ext2-QoS-Subscribed, +70 Ext3-QoS-Subscribed, +71 Ext4-QoS-Subscribed, +72 SubscriberData, +73 ODB-Data, +74 SubscriberStatus, +75 ZoneCodeList, +76 maxNumOfZoneCodes, +77 O-CSI, +78 D-CSI, +79 O-BcsmCamelTDPCriteriaList, +80 T-BCSM-CAMEL-TDP-CriteriaList, +81 SS-CSI, +82 ServiceKey, +83 DefaultCallHandling, +84 DefaultSMS-Handling, +85 DefaultGPRS-Handling, +86 CamelCapabilityHandling, +87 BasicServiceCriteria, +88 SupportedCamelPhases, +89 OfferedCamel4CSIs, +90 OfferedCamel4Functionalities, +91 maxNumOfCamelTDPData, +92 CUG-Index, +93 CUG-Info, +94 CUG-Interlock, +95 InterCUG-Restrictions, +96 IntraCUG-Options, +97 NotificationToMSUser, +98 QoS-Subscribed, +99 IST-AlertTimerValue, +100 T-CSI, +101 T-BcsmTriggerDetectionPoint, +102 APN, +103 AdditionalInfo, +104 +105 -- fault recovery types +106 ResetArg, +107 RestoreDataArg, +108 RestoreDataRes, +109 +``` + +``` + +110 -- provide subscriber info types +111 GeographicalInformation, +112 MS-Classmark2, +113 GPRSMSClass, +114 +115 -- subscriber information enquiry types +116 ProvideSubscriberInfoArg, +117 ProvideSubscriberInfoRes, +118 SubscriberInfo, +119 LocationInformation, +120 LocationInformationGPRS, +121 SubscriberState, +122 GPRSChargingID, +123 MNPInfoRes, +124 RouteingNumber, +125 +126 -- any time information enquiry types +127 AnyTimeInterrogationArg, +128 AnyTimeInterrogationRes, +129 +130 -- any time information handling types +131 AnyTimeSubscriptionInterrogationArg, +132 AnyTimeSubscriptionInterrogationRes, +133 AnyTimeModificationArg, +134 AnyTimeModificationRes, +135 +136 -- subscriber data modification notification types +137 NoteSubscriberDataModifiedArg, +138 NoteSubscriberDataModifiedRes, +139 +140 -- gprs location information retrieval types +141 SendRoutingInfoForGprsArg, +142 SendRoutingInfoForGprsRes, +143 +144 -- failure reporting types +145 FailureReportArg, +146 FailureReportRes, +147 +148 -- gprs notification types +149 NoteMsPresentForGprsArg, +150 NoteMsPresentForGprsRes, +151 +152 -- Mobility Management types +153 NoteMM-EventArg, +154 NoteMM-EventRes, +155 NumberPortabilityStatus, +156 PagingArea, +157 +158 -- VGCS / VBS types types +159 GroupId, +160 Long-GroupId, +161 AdditionalSubscriptions +162 +163 ; +164 +165 IMPORTS +166 maxNumOfSS, +167 SS-SubscriptionOption, +168 SS-List, +169 SS-ForBS-Code, +170 Password, +171 OverrideCategory, +172 CliRestrictionOption +173 FROM MAP-SS-DataTypes { +174 itu-t identified-organization (4) etsi (0) mobileDomain (0) +175 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +176 +177 SS-Code +178 FROM MAP-SS-Code { +179 itu-t identified-organization (4) etsi (0) mobileDomain (0) +180 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +181 +182 Ext-BearerServiceCode +183 FROM MAP-BS-Code { +184 itu-t identified-organization (4) etsi (0) mobileDomain (0) +185 gsm-Network (1) modules (3) map-BS-Code (20) version21 (21)} +186 +187 Ext-TeleserviceCode +188 FROM MAP-TS-Code { + +``` + +``` + +189 itu-t identified-organization (4) etsi (0) mobileDomain (0) +190 gsm-Network (1) modules (3) map-TS-Code (19) version21 (21)} +191 +192 AddressString, +193 ISDN-AddressString, +194 ISDN-SubaddressString, +195 FTN-AddressString, +196 AccessNetworkSignalInfo, +197 IMSI, +198 IMEI, +199 TMSI, +200 HLR-List, +201 LMSI, +202 Identity, +203 GlobalCellId, +204 CellGlobalIdOrServiceAreaIdOrLAI, +205 Ext-BasicServiceCode, +206 NAEA-PreferredCI, +207 EMLPP-Info, +208 MC-SS-Info, +209 SubscriberIdentity, +210 AgeOfLocationInformation, +211 LCSCClientExternalID, +212 LCSCClientInternalID, +213 Ext-SS-Status, +214 LCSServiceTypeID, +215 ASCI-CallReference, +216 TBCD-STRING, +217 LAIFixedLength, +218 PLMN-Id, +219 EMLPP-Priority, +220 GSN-Address, +221 DiameterIdentity, +222 Time, +223 E-UTRAN-CGI, +224 NR-CGI, +225 TA-Id, +226 NR-TA-Id, +227 RAIdentity, +228 NetworkNodeDiameterAddress +229 FROM MAP-CommonDataTypes { +230 itu-t identified-organization (4) etsi (0) mobileDomain (0) +231 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +232 +233 ExtensionContainer +234 FROM MAP-ExtensionDataTypes { +235 itu-t identified-organization (4) etsi (0) mobileDomain (0) +236 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +237 +238 AbsentSubscriberDiagnosticSM +239 FROM MAP-ER-DataTypes { +240 itu-t identified-organization (4) etsi (0) mobileDomain (0) +241 gsm-Network (1) modules (3) map-ER-DataTypes (17) version21 (21)} +242 +243 TracePropagationList +244 FROM MAP-OM-DataTypes { +245 itu-t identified-organization (4) etsi (0) mobileDomain (0) +246 gsm-Network (1) modules (3) map-OM-DataTypes (12) version21 (21)} +247 +248 ; +249 +250 -- location registration types +251 + +``` + +``` + +252 UpdateLocationArg ::= SEQUENCE { +253 imsi IMSI, +254 msc-Number [1] ISDN-AddressString, +255 vlr-Number ISDN-AddressString, +256 lmsi [10] LMSI OPTIONAL, +257 extensionContainer ExtensionContainer OPTIONAL, +258 ... , +259 vlr-Capability [6] VLR-Capability OPTIONAL, +260 informPreviousNetworkEntity [11] NULL OPTIONAL, +261 cs-LCS-NotSupportedByUE [12] NULL OPTIONAL, +262 v-gmlc-Address [2] GSN-Address OPTIONAL, +263 add-info [13] ADD-Info OPTIONAL, +264 pagingArea [14] PagingArea OPTIONAL, +265 skipSubscriberDataUpdate [15] NULL OPTIONAL, +266 -- The skipSubscriberDataUpdate parameter in the UpdateLocationArg and the ADD-Info +267 -- structures carry the same semantic. +268 restorationIndicator [16] NULL OPTIONAL, +269 eplmn-List [3] EPLMN-List OPTIONAL, +270 mme-DiameterAddress [4] NetworkNodeDiameterAddress OPTIONAL +271 } +272 +273 VLR-Capability ::= SEQUENCE{ +274 supportedCamelPhases [0] SupportedCamelPhases OPTIONAL, +275 extensionContainer ExtensionContainer OPTIONAL, +276 ... , +277 solsaSupportIndicator [2] NULL OPTIONAL, +278 istSupportIndicator [1] IST-SupportIndicator OPTIONAL, +279 superChargerSupportedInServingNetworkEntity [3] SuperChargerInfo OPTIONAL, +280 longFTN-Supported [4] NULL OPTIONAL, +281 supportedLCS-CapabilitySets [5] SupportedLCS-CapabilitySets OPTIONAL, +282 offeredCamel4CSIs [6] OfferedCamel4CSIs OPTIONAL, +283 supportedRAT-TypesIndicator [7] SupportedRAT-Types OPTIONAL, +284 longGroupID-Supported [8] NULL OPTIONAL, +285 mtRoamingForwardingSupported [9] NULL OPTIONAL, +286 msisdn-lessOperation-Supported [10] NULL OPTIONAL, +287 reset-ids-Supported [11] NULL OPTIONAL } +288 +289 SupportedRAT-Types ::= BIT STRING { +290 utran (0), +291 geran (1), +292 gan (2), +293 i-hspa-evolution (3), +294 e-utran (4), +295 nb-iot (5)} (SIZE (2..8)) +296 -- exception handling: bits 6 to 7 shall be ignored if received and not understood +297 +298 +299 +300 SuperChargerInfo ::= CHOICE { +301 sendSubscriberData [0] NULL, +302 subscriberDataStored [1] AgeIndicator } +303 +304 AgeIndicator ::= OCTET STRING (SIZE (1..6)) +305 -- The internal structure of this parameter is implementation specific. +306 +307 IST-SupportIndicator ::= ENUMERATED { +308 basicISTSupported (0), +309 istCommandSupported (1), +310 ...} +311 -- exception handling: +312 -- reception of values > 1 shall be mapped to ' istCommandSupported ' +313 + +``` + +``` + +314 SupportedLCS-CapabilitySets ::= BIT STRING { +315 lcsCapabilitySet1 (0), +316 lcsCapabilitySet2 (1), +317 lcsCapabilitySet3 (2), +318 lcsCapabilitySet4 (3) , +319 lcsCapabilitySet5 (4) } (SIZE (2..16)) +320 -- Core network signalling capability set1 indicates LCS Release98 or Release99 version. +321 -- Core network signalling capability set2 indicates LCS Release4. +322 -- Core network signalling capability set3 indicates LCS Release5. +323 -- Core network signalling capability set4 indicates LCS Release6. +324 -- Core network signalling capability set5 indicates LCS Release7 or later version. +325 -- A node shall mark in the BIT STRING all LCS capability sets it supports. +326 -- If no bit is set then the sending node does not support LCS. +327 -- If the parameter is not sent by an VLR then the VLR may support at most capability set1. +328 -- If the parameter is not sent by an SGSN then no support for LCS is assumed. +329 -- An SGSN is not allowed to indicate support of capability set1. +330 -- Other bits than listed above shall be discarded. +331 +332 UpdateLocationRes ::= SEQUENCE { +333 hlr-Number ISDN-AddressString, +334 extensionContainer ExtensionContainer OPTIONAL, +335 ..., +336 add-Capability NULL OPTIONAL, +337 pagingArea-Capability [0]NULL OPTIONAL } +338 +339 ADD-Info ::= SEQUENCE { +340 imeisv [0] IMEI, +341 skipSubscriberDataUpdate [1] NULL OPTIONAL, +342 -- The skipSubscriberDataUpdate parameter in the UpdateLocationArg and the ADD-Info +343 -- structures carry the same semantic. +344 ...} +345 +346 +347 PagingArea ::= SEQUENCE SIZE (1..5) OF LocationArea +348 +349 +350 LocationArea ::= CHOICE { +351 laiFixedLength [0] LAIFixedLength, +352 lac [1] LAC} +353 +354 +355 LAC ::= OCTET STRING (SIZE (2)) +356 -- Refers to Location Area Code of the Location Area Identification defined in +357 -- 3GPP TS 23.003 [17]. +358 -- Location Area Code according to 3GPP TS 24.008 [35] +359 +360 CancelLocationArg ::= [3] SEQUENCE { +361 identity Identity, +362 cancellationType CancellationType OPTIONAL, +363 extensionContainer ExtensionContainer OPTIONAL, +364 ..., +365 typeOfUpdate [0] TypeOfUpdate OPTIONAL, +366 mtrf-SupportedAndAuthorized [1] NULL OPTIONAL, +367 mtrf-SupportedAndNotAuthorized [2] NULL OPTIONAL, +368 newMSC-Number [3] ISDN-AddressString OPTIONAL, +369 newVLR-Number [4] ISDN-AddressString OPTIONAL, +370 new-lmsi [5] LMSI OPTIONAL, +371 reattach-Required [6] NULL OPTIONAL +372 } +373 --mtrf-SupportedAndAuthorized and mtrf-SupportedAndNotAuthorized shall not +374 -- both be present +375 +376 TypeOfUpdate ::= ENUMERATED { +377 sgsn-change (0), +378 mme-change (1), +379 ...} +380 -- TypeOfUpdate shall be absent if CancellationType is different from updateProcedure +381 -- and initialAttachProcedure +382 +383 CancellationType ::= ENUMERATED { +384 updateProcedure (0), +385 subscriptionWithdraw (1), +386 ..., +387 initialAttachProcedure (2) } +388 -- The HLR shall not send values other than listed above +389 + +``` + +``` + +390 CancelLocationRes ::= SEQUENCE { +391 extensionContainer ExtensionContainer OPTIONAL, +392 ... } +393 +394 PurgeMS-Arg ::= [3] SEQUENCE { +395 imsi IMSI, +396 vlr-Number [0] ISDN-AddressString OPTIONAL, +397 sgsn-Number [1] ISDN-AddressString OPTIONAL, +398 extensionContainer ExtensionContainer OPTIONAL, +399 ..., +400 locationInformation [2] LocationInformation OPTIONAL, +401 locationInformationGPRS [3] LocationInformationGPRS OPTIONAL, +402 locationInformationEPS [4] LocationInformationEPS OPTIONAL } +403 +404 PurgeMS-Res ::= SEQUENCE { +405 freezeTMSI [0] NULL OPTIONAL, +406 freezeP-TMSI [1] NULL OPTIONAL, +407 extensionContainer ExtensionContainer OPTIONAL, +408 ..., +409 freezeM-TMSI [2] NULL OPTIONAL } +410 +411 SendIdentificationArg ::= SEQUENCE { +412 tmsi TMSI, +413 numberOfRequestedVectors NumberOfRequestedVectors OPTIONAL, +414 -- within a dialogue numberOfRequestedVectors shall be present in +415 -- the first service request and shall not be present in subsequent service requests. +416 -- If received in a subsequent service request it shall be discarded. +417 segmentationProhibited NULL OPTIONAL, +418 extensionContainer ExtensionContainer OPTIONAL, +419 ..., +420 msc-Number ISDN-AddressString OPTIONAL, +421 previous-LAI [0] LAIFixedLength OPTIONAL, +422 hopCounter [1] HopCounter OPTIONAL, +423 mtRoamingForwardingSupported [2] NULL OPTIONAL, +424 newVLR-Number [3] ISDN-AddressString OPTIONAL, +425 new-imsi [4] LMSI OPTIONAL } +426 +427 HopCounter ::= INTEGER (0..3) +428 +429 SendIdentificationRes ::= [3] SEQUENCE { +430 imsi IMSI OPTIONAL, +431 -- IMSI shall be present in the first (or only) service response of a dialogue. +432 -- If multiple service requests are present in a dialogue then IMSI +433 -- shall not be present in any service response other than the first one. +434 authenticationSetList AuthenticationSetList OPTIONAL, +435 currentSecurityContext [2] CurrentSecurityContext OPTIONAL, +436 extensionContainer [3] ExtensionContainer OPTIONAL, +437 ..., +438 lastUsedLtePLMN-Id [4] PLMN-Id OPTIONAL, +439 mtCallPendingFlag [5] NULL OPTIONAL } +440 +441 -- authentication management types +442 +443 AuthenticationSetList ::= CHOICE { +444 tripletList [0] TripletList, +445 quintupletList [1] QuintupletList } +446 +447 TripletList ::= SEQUENCE SIZE (1..5) OF +448 AuthenticationTriplet +449 +450 QuintupletList ::= SEQUENCE SIZE (1..5) OF +451 AuthenticationQuintuplet +452 +453 AuthenticationTriplet ::= SEQUENCE { +454 rand RAND, +455 sres SRES, +456 kc Kc, +457 ... } +458 +459 AuthenticationQuintuplet ::= SEQUENCE { +460 rand RAND, +461 xres XRES, +462 ck CK, +463 ik IK, +464 autn AUTN, +465 ... } +466 + +``` + +``` + +467 CurrentSecurityContext ::= CHOICE { +468 gsm-SecurityContextData [0] GSM-SecurityContextData, +469 umts-SecurityContextData [1] UMTS-SecurityContextData } +470 +471 GSM-SecurityContextData ::= SEQUENCE { +472 kc Kc, +473 cksn Cksn, +474 ... } +475 +476 UMTS-SecurityContextData ::= SEQUENCE { +477 ck CK, +478 ik IK, +479 ksi KSI, +480 ... } +481 +482 RAND ::= OCTET STRING (SIZE (16)) +483 +484 SRES ::= OCTET STRING (SIZE (4)) +485 +486 Kc ::= OCTET STRING (SIZE (8)) +487 +488 XRES ::= OCTET STRING (SIZE (4..16)) +489 +490 CK ::= OCTET STRING (SIZE (16)) +491 +492 IK ::= OCTET STRING (SIZE (16)) +493 +494 AUTN ::= OCTET STRING (SIZE (16)) +495 +496 AUTS ::= OCTET STRING (SIZE (14)) +497 +498 Cksn ::= OCTET STRING (SIZE (1)) +499 -- The internal structure is defined in 3GPP TS 24.008 +500 +501 KSI ::= OCTET STRING (SIZE (1)) +502 -- The internal structure is defined in 3GPP TS 24.008 +503 +504 AuthenticationFailureReportArg ::= SEQUENCE { +505 imsi IMSI, +506 failureCause FailureCause, +507 extensionContainer ExtensionContainer OPTIONAL, +508 ... , +509 re-attempt BOOLEAN OPTIONAL, +510 accessType AccessType OPTIONAL, +511 rand RAND OPTIONAL, +512 vlr-Number [0] ISDN-AddressString OPTIONAL, +513 sgsn-Number [1] ISDN-AddressString OPTIONAL } +514 +515 AccessType ::= ENUMERATED { +516 call (0), +517 emergencyCall (1), +518 locationUpdating (2), +519 supplementaryService (3), +520 shortMessage (4), +521 gprsAttach (5), +522 routingAreaUpdating (6), +523 serviceRequest (7), +524 pdpContextActivation (8), +525 pdpContextDeactivation (9), +526 ..., +527 gprsDetach (10) } +528 -- exception handling: +529 -- received values greater than 10 shall be ignored. +530 +531 AuthenticationFailureReportRes ::= SEQUENCE { +532 extensionContainer ExtensionContainer OPTIONAL, +533 ... } +534 +535 FailureCause ::= ENUMERATED { +536 wrongUserResponse (0), +537 wrongNetworkSignature (1) } +538 +539 -- gprs location registration types +540 + +``` + +``` + +541 UpdateGprsLocationArg ::= SEQUENCE { +542 imsi IMSI, +543 sgsn-Number ISDN-AddressString, +544 gsn-Address GSN-Address, +545 extensionContainer ExtensionContainer OPTIONAL, +546 ... , +547 sgsn-Capability [0] SGSN-Capability OPTIONAL, +548 informPreviousNetworkEntity [1] NULL OPTIONAL, +549 ps-LCS-NotSupportedByUE [2] NULL OPTIONAL, +550 v-gmlc-Address [3] GSN-Address OPTIONAL, +551 add-info [4] ADD-Info OPTIONAL, +552 eps-info [5] EPS-Info OPTIONAL, +553 servingNodeTypeIndicator [6] NULL OPTIONAL, +554 skipSubscriberDataUpdate [7] NULL OPTIONAL, +555 usedRAT-Type [8] Used-RAT-Type OPTIONAL, +556 gprsSubscriptionDataNotNeeded [9] NULL OPTIONAL, +557 nodeTypeIndicator [10] NULL OPTIONAL, +558 areaRestricted [11] NULL OPTIONAL, +559 ue-reachableIndicator [12] NULL OPTIONAL, +560 epsSubscriptionDataNotNeeded [13] NULL OPTIONAL, +561 ue-srvcc-Capability [14] UE-SRVCC-Capability OPTIONAL, +562 eplmn-List [15] EPLMN-List OPTIONAL, +563 mmeNumberforMTSMS [16] ISDN-AddressString OPTIONAL, +564 smsRegisterRequest [17] SMSRegisterRequest OPTIONAL, +565 sms-Only [18] NULL OPTIONAL, +566 removalofMMERegistrationforSMS [22] NULL OPTIONAL, +567 sgsn-Name [19] DiameterIdentity OPTIONAL, +568 sgsn-Realm [20] DiameterIdentity OPTIONAL, +569 lgd-supportIndicator [21] NULL OPTIONAL, +570 adjacentPLMN-List [23] AdjacentPLMN-List OPTIONAL } +571 +572 SMSRegisterRequest ::= ENUMERATED { +573 sms-registration-required (0), +574 sms-registration-not-preferred (1), +575 no-preference (2), +576 ...} +577 +578 Used-RAT-Type ::= ENUMERATED { +579 utran (0), +580 geran (1), +581 gan (2), +582 i-hspa-evolution (3), +583 e-utran (4), +584 ..., +585 nb-iot (5) } +586 -- The value e-utran indicates wide-band e-utran +587 +588 EPS-Info ::= CHOICE{ +589 pdn-gw-update [0] PDN-GW-Update, +590 isr-information [1] ISR-Information } +591 +592 PDN-GW-Update ::= SEQUENCE{ +593 apn [0] APN OPTIONAL, +594 pdn-gw-Identity [1] PDN-GW-Identity OPTIONAL, +595 contextId [2] ContextId OPTIONAL, +596 extensionContainer [3] ExtensionContainer OPTIONAL, +597 ... } +598 -- The pdn-gw-update IE shall include the pdn-gw-Identity, and the apn or/and the contextID. +599 -- The HSS shall ignore the eps-info IE if it includes a pdn-gw-update IE which does not +600 -- include pdn-gw-Identity. +601 -- The pdn-gw-Identity is defined as OPTIONAL for backward compatibility reason with +602 -- outdated earlier versions of this specification. +603 +604 +605 ISR-Information ::= BIT STRING { +606 updateLocation (0), +607 cancelSGSN (1), +608 initialAttachIndicator (2)} (SIZE (3..8)) +609 -- exception handling: reception of unknown bit assignments in the +610 -- ISR-Information data type shall be discarded by the receiver +611 + +``` + +``` + +612 SGSN-Capability ::= SEQUENCE{ +613 solsaSupportIndicator NULL OPTIONAL, +614 extensionContainer [1] ExtensionContainer OPTIONAL, +615 ... , +616 superChargerSupportedInServingNetworkEntity [2] SuperChargerInfo OPTIONAL , +617 gprsEnhancementsSupportIndicator [3] NULL OPTIONAL, +618 supportedCamelPhases [4] SupportedCamelPhases OPTIONAL, +619 supportedLCS-CapabilitySets [5] SupportedLCS-CapabilitySets OPTIONAL, +620 offeredCamel4CSIs [6] OfferedCamel4CSIs OPTIONAL, +621 smsCallBarringSupportIndicator [7] NULL OPTIONAL, +622 TypesIndicator [8] SupportedRAT-Types OPTIONAL, +623 supportedFeatures [9] SupportedFeatures OPTIONAL, +624 t-adsDataRetrieval [10] NULL OPTIONAL, +625 homogeneousSupportOfIMSVoiceOverPSSessions [11] BOOLEAN OPTIONAL, +626 -- "true" indicates homogeneous support, "false" indicates homogeneous non-support +627 -- in the complete SGSN or MME area +628 cancellationTypeInitialAttach [12] NULL OPTIONAL, +629 msisdn-lessOperation-Supported [14] NULL OPTIONAL, +630 updateOfHomogeneousSupportOfIMSVoiceOverPSSessions [15] NULL OPTIONAL, +631 reset-ids-Supported [16] NULL OPTIONAL, +632 ext-SupportedFeatures [17] Ext-SupportedFeatures OPTIONAL +633 } +634 -- the supportedFeatures , t-adsDataRetrieval, +635 -- homogeneousSupportOfIMSVoiceOverPSSessions +636 -- /updateOfHomogeneousSupportOfIMSVoiceOverPSSessions and +637 -- ext-SupportedFeatures are also applied to the MME/IWF +638 + +``` + +``` + +639 SupportedFeatures ::= BIT STRING { +640 odb-all-apn (0), +641 odb-HPLMN-APN (1), +642 odb-VPLMN-APN (2), +643 odb-all-og (3), +644 odb-all-international-og (4), +645 odb-all-int-og-not-to-HPLMN-country (5), +646 odb-all-interzonal-og (6), +647 odb-all-interzonal-og-not-to-HPLMN-country (7), +648 odb-all-interzonal-og-and-internat-og-not-to-HPLMN-country (8), +649 regSub (9), +650 trace (10), +651 lcs-all-PrivExcep (11), +652 lcs-universal (12), +653 lcs-CallSessionRelated (13), +654 lcs-CallSessionUnrelated (14), +655 lcs-PLMN-operator (15), +656 lcs-ServiceType (16), +657 lcs-all-MOLR-SS (17), +658 lcs-basicSelfLocation (18), +659 lcs-autonomousSelfLocation (19), +660 lcs-transferToThirdParty (20), +661 sm-mo-pp (21), +662 barring-OutgoingCalls (22), +663 baoc (23), +664 boic (24), +665 boicExHC (25), +666 localTimeZoneRetrieval (26), +667 additionalMsisdn (27), +668 smsInMME (28), +669 smsInSGSN (29), +670 ue-Reachability-Notification (30), +671 state-Location-Information-Retrieval (31), +672 partialPurge (32), +673 gddInSGSN (33), +674 sgsnCAMELCapability (34), +675 pscf-Restoration (35), +676 dedicatedCoreNetworks (36), +677 non-IP-PDN-Type-APNs (37), +678 non-IP-PDP-Type-APNs (38), +679 nrAsSecondaryRAT (39) } (SIZE (26..40)) +680 -- for the definition and usage of the above features see the 3GPP TS 29.272 [144]. +681 -- Additional supported features are encoded in Ext-SupportedFeatures bit string. +682 + +``` + +``` + +683 +684 Ext-SupportedFeatures ::= BIT STRING { +685 unlicensedSpectrumAsSecondaryRAT (0) } (SIZE (1..40)) +686 + +``` + +``` + +687 UE-SRVCC-Capability ::= ENUMERATED { +688 ue-srvcc-not-supported (0), +689 ue-srvcc-supported (1), +690 ...} +691 +692 UpdateGprsLocationRes ::= SEQUENCE { +693 hlr-Number ISDN-AddressString, +694 extensionContainer ExtensionContainer OPTIONAL, +695 ..., +696 add-Capability NULL OPTIONAL, +697 sgsn-mmeSeparationSupported [0] NULL OPTIONAL, +698 mmeRegisteredforSMS [1] NULL OPTIONAL } +699 +700 EPLMN-List ::= SEQUENCE SIZE (1..50) OF +701 PLMN-Id +702 +703 AdjacentPLMN-List ::= SEQUENCE SIZE (1..50) OF +704 PLMN-Id +705 +706 +707 -- handover types +708 +709 ForwardAccessSignalling-Arg ::= [3] SEQUENCE { +710 an-APDU AccessNetworkSignalInfo, +711 integrityProtectionInfo [0] IntegrityProtectionInformation OPTIONAL, +712 encryptionInfo [1] EncryptionInformation OPTIONAL, +713 keyStatus [2] KeyStatus OPTIONAL, +714 allowedGSM-Algorithms [4] AllowedGSM-Algorithms OPTIONAL, +715 allowedUMTS-Algorithms [5] AllowedUMTS-Algorithms OPTIONAL, +716 radioResourceInformation [6] RadioResourceInformation OPTIONAL, +717 extensionContainer [3] ExtensionContainer OPTIONAL, +718 ..., +719 radioResourceList [7] RadioResourceList OPTIONAL, +720 bssmap-ServiceHandover [9] BSSMAP-ServiceHandover OPTIONAL, +721 ranap-ServiceHandover [8] RANAP-ServiceHandover OPTIONAL, +722 bssmap-ServiceHandoverList [10] BSSMAP-ServiceHandoverList OPTIONAL, +723 currentlyUsedCodec [11] Codec OPTIONAL, +724 iuSupportedCodecsList [12] SupportedCodecsList OPTIONAL, +725 rab-ConfigurationIndicator [13] NULL OPTIONAL, +726 iuSelectedCodec [14] Codec OPTIONAL, +727 alternativeChannelType [15] RadioResourceInformation OPTIONAL, +728 tracePropagationList [17] TracePropagationList OPTIONAL, +729 aoipSupportedCodecsListAnchor [18] AoIPCodecsList OPTIONAL, +730 aoipSelectedCodecTarget [19] AoIPCodec OPTIONAL, +731 uesbi-Iu [20] UESBI-Iu OPTIONAL, +732 imeisv [21] IMEI OPTIONAL } +733 +734 AllowedGSM-Algorithms ::= OCTET STRING (SIZE (1)) +735 -- internal structure is coded as Algorithm identifier octet from +736 -- Permitted Algorithms defined in 3GPP TS 48.008 +737 -- A node shall mark all GSM algorithms that are allowed in MSC-B +738 +739 AllowedUMTS-Algorithms ::= SEQUENCE { +740 integrityProtectionAlgorithms [0] PermittedIntegrityProtectionAlgorithms +741 OPTIONAL, +742 encryptionAlgorithms [1] PermittedEncryptionAlgorithms OPTIONAL, +743 extensionContainer [2] ExtensionContainer OPTIONAL, +744 ...} +745 +746 PermittedIntegrityProtectionAlgorithms ::= +747 OCTET STRING (SIZE (1..maxPermittedIntegrityProtectionAlgorithmsLength)) +748 -- Octets contain a complete PermittedIntegrityProtectionAlgorithms data type +749 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +750 -- mandated by 3GPP TS 25.413. +751 -- Padding bits are included, if needed, in the least significant bits of the +752 -- last octet of the octet string. +753 +754 +755 maxPermittedIntegrityProtectionAlgorithmsLength INTEGER ::= 9 +756 + +``` + +``` + +757 PermittedEncryptionAlgorithms := +758 OCTET STRING (SIZE (1..maxPermittedEncryptionAlgorithmsLength)) +759 -- Octets contain a complete PermittedEncryptionAlgorithms data type +760 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +761 -- mandated by 3GPP TS 25.413 +762 -- Padding bits are included, if needed, in the least significant bits of the +763 -- last octet of the octet string. +764 +765 +766 maxPermittedEncryptionAlgorithmsLength INTEGER := 9 +767 +768 KeyStatus := ENUMERATED { +769 old (0), +770 new (1), +771 ...} +772 -- exception handling: +773 -- received values in range 2-31 shall be treated as "old" +774 -- received values greater than 31 shall be treated as "new" +775 +776 PrepareHO-Arg := [3] SEQUENCE { +777 targetCellId [0] GlobalCellId OPTIONAL, +778 ho-NumberNotRequired NULL OPTIONAL, +779 targetRNCId [1] RNCId OPTIONAL, +780 an-APDU [2] AccessNetworkSignalInfo OPTIONAL, +781 multipleBearerRequested [3] NULL OPTIONAL, +782 imsi [4] IMSI OPTIONAL, +783 integrityProtectionInfo [5] IntegrityProtectionInformation OPTIONAL, +784 encryptionInfo [6] EncryptionInformation OPTIONAL, +785 radioResourceInformation [7] RadioResourceInformation OPTIONAL, +786 allowedGSM-Algorithms [9] AllowedGSM-Algorithms OPTIONAL, +787 allowedUMTS-Algorithms [10] AllowedUMTS-Algorithms OPTIONAL, +788 radioResourceList [11] RadioResourceList OPTIONAL, +789 extensionContainer [8] ExtensionContainer OPTIONAL, +790 ... , +791 rab-Id [12] RAB-Id OPTIONAL, +792 bssmap-ServiceHandover [13] BSSMAP-ServiceHandover OPTIONAL, +793 ranap-ServiceHandover [14] RANAP-ServiceHandover OPTIONAL, +794 bssmap-ServiceHandoverList [15] BSSMAP-ServiceHandoverList OPTIONAL, +795 asciiCallReference [20] ASCII-CallReference OPTIONAL, +796 geran-classmark [16] GERAN-Classmark OPTIONAL, +797 iuCurrentlyUsedCodec [17] Codec OPTIONAL, +798 iuSupportedCodecsList [18] SupportedCodecsList OPTIONAL, +799 rab-ConfigurationIndicator [19] NULL OPTIONAL, +800 uesbi-Iu [21] UESBI-Iu OPTIONAL, +801 imeisv [22] IMEI OPTIONAL, +802 alternativeChannelType [23] RadioResourceInformation OPTIONAL, +803 tracePropagationList [25] TracePropagationList OPTIONAL, +804 aoipSupportedCodecsListAnchor [26] AoIPCodecsList OPTIONAL, +805 regionalSubscriptionData [27] ZoneCodeList OPTIONAL, +806 lclsGlobalCallReference [28] LCLS-GlobalCallReference OPTIONAL, +807 lcls-Negotiation [29] LCLS-Negotiation OPTIONAL, +808 lcls-Configuration-Preference [30] LCLS-ConfigurationPreference OPTIONAL, +809 csg-SubscriptionDataList [31] CSG-SubscriptionDataList OPTIONAL, +810 } +811 +812 LCLS-GlobalCallReference := OCTET STRING (SIZE (13..15)) +813 -- Octets are coded as specified in 3GPP TS 29.205 [146] +814 +815 +816 LCLS-Negotiation := BIT STRING { +817 permission-indicator-not-allowed-bit (0), +818 permission-indicator-spare-bit (1)} (SIZE (2..8)) +819 --for definition and allowed combination of bits 0 and 1 see 3GPP TS 29.205 +820 -- exception handling: bits 2 to 7 shall be ignored if received and not understood +821 +822 +823 LCLS-ConfigurationPreference := BIT STRING { +824 forward-data-sending-indicator (0), +825 backward-data-sending-indicator (1), +826 forward-data-reception-indicator (2), +827 backward-data-reception-indicator (3)} (SIZE (4..8)) +828 -- exception handling: bits 4 to 7 shall be ignored if received and not understood +829 +830 +831 BSSMAP-ServiceHandoverList := SEQUENCE SIZE (1.. maxNumOfServiceHandovers) OF +832 BSSMAP-ServiceHandoverInfo +833 + +``` + +``` + +834 BSSMAP-ServiceHandoverInfo ::= SEQUENCE { +835 bssmap-ServiceHandover BSSMAP-ServiceHandover, +836 rab-Id RAB-Id, +837 -- RAB Identity is needed to relate the service handovers with the radio access bearers. +838 ...} +839 +840 maxNumOfServiceHandovers INTEGER ::= 7 +841 +842 BSSMAP-ServiceHandover ::= OCTET STRING (SIZE (1)) +843 -- Octets are coded according the Service Handover information element in +844 -- 3GPP TS 48.008. +845 +846 RANAP-ServiceHandover ::= OCTET STRING (SIZE (1)) +847 -- Octet contains a complete Service-Handover data type +848 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +849 -- mandated by 3GPP TS 25.413 +850 -- Padding bits are included in the least significant bits. +851 +852 +853 RadioResourceList ::= SEQUENCE SIZE (1.. maxNumOfRadioResources) OF +854 RadioResource +855 +856 RadioResource ::= SEQUENCE { +857 radioResourceInformation RadioResourceInformation, +858 rab-Id RAB-Id, +859 -- RAB Identity is needed to relate the radio resources with the radio access bearers. +860 ...} +861 +862 maxNumOfRadioResources INTEGER ::= 7 +863 +864 PrepareHO-Res ::= [3] SEQUENCE { +865 handoverNumber [0] ISDN-AddressString OPTIONAL, +866 relocationNumberList [1] RelocationNumberList OPTIONAL, +867 an-APDU [2] AccessNetworkSignalInfo OPTIONAL, +868 multicallBearerInfo [3] MulticallBearerInfo OPTIONAL, +869 multipleBearerNotSupported NULL OPTIONAL, +870 selectedUMTS-Algorithms [5] SelectedUMTS-Algorithms OPTIONAL, +871 chosenRadioResourceInformation [6] ChosenRadioResourceInformation OPTIONAL, +872 extensionContainer [4] ExtensionContainer OPTIONAL, +873 ..., +874 iuSelectedCodec [7] Codec OPTIONAL, +875 iuAvailableCodecsList [8] CodecList OPTIONAL, +876 aoipSelectedCodecTarget [9] AoIPCodec OPTIONAL, +877 aoipAvailableCodecsListMap [10] AoIPCodecsList OPTIONAL } +878 +879 SelectedUMTS-Algorithms ::= SEQUENCE { +880 integrityProtectionAlgorithm [0] ChosenIntegrityProtectionAlgorithm OPTIONAL, +881 encryptionAlgorithm [1] ChosenEncryptionAlgorithm OPTIONAL, +882 extensionContainer [2] ExtensionContainer OPTIONAL, +883 ...} +884 +885 ChosenIntegrityProtectionAlgorithm ::= OCTET STRING (SIZE (1)) +886 -- Octet contains a complete IntegrityProtectionAlgorithm data type +887 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +888 -- mandated by 3GPP TS 25.413 +889 -- Padding bits are included in the least significant bits. +890 +891 ChosenEncryptionAlgorithm ::= OCTET STRING (SIZE (1)) +892 -- Octet contains a complete EncryptionAlgorithm data type +893 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +894 -- mandated by 3GPP TS 25.413 +895 -- Padding bits are included in the least significant bits. +896 +897 ChosenRadioResourceInformation ::= SEQUENCE { +898 chosenChannelInfo [0] ChosenChannelInfo OPTIONAL, +899 chosenSpeechVersion [1] ChosenSpeechVersion OPTIONAL, +900 ...} +901 +902 ChosenChannelInfo ::= OCTET STRING (SIZE (1)) +903 -- Octets are coded according the Chosen Channel information element in 3GPP TS 48.008 +904 +905 ChosenSpeechVersion ::= OCTET STRING (SIZE (1)) +906 -- Octets are coded according the Speech Version (chosen) information element in 3GPP TS +907 -- 48.008 +908 +``` + +``` + +909 PrepareSubsequentHO-Arg ::= [3] SEQUENCE { +910 targetCellId [0] GlobalCellId OPTIONAL, +911 targetMSC-Number [1] ISDN-AddressString, +912 targetRNCId [2] RNCId OPTIONAL, +913 an-APDU [3] AccessNetworkSignalInfo OPTIONAL, +914 selectedRab-Id [4] RAB-Id OPTIONAL, +915 extensionContainer [5] ExtensionContainer OPTIONAL, +916 ..., +917 geran-classmark [6] GERAN-Classmark OPTIONAL, +918 rab-ConfigurationIndicator [7] NULL OPTIONAL } +919 +920 PrepareSubsequentHO-Res ::= [3] SEQUENCE { +921 an-APDU AccessNetworkSignalInfo, +922 extensionContainer [0] ExtensionContainer OPTIONAL, +923 ...} +924 +925 ProcessAccessSignalling-Arg ::= [3] SEQUENCE { +926 an-APDU AccessNetworkSignalInfo, +927 selectedUMTS-Algorithms [1] SelectedUMTS-Algorithms OPTIONAL, +928 selectedGSM-Algorithm [2] SelectedGSM-Algorithm OPTIONAL, +929 chosenRadioResourceInformation [3] ChosenRadioResourceInformation OPTIONAL, +930 selectedRab-Id [4] RAB-Id OPTIONAL, +931 extensionContainer [0] ExtensionContainer OPTIONAL, +932 ..., +933 iUSSelectedCodec [5] Codec OPTIONAL, +934 iuAvailableCodecsList [6] CodecList OPTIONAL, +935 aoipSelectedCodecTarget [7] AoIPCodec OPTIONAL, +936 aoipAvailableCodecsListMap [8] AoIPCodecsList OPTIONAL } +937 +938 AoIPCodecsList ::= SEQUENCE { +939 codec1 [1] AoIPCodec, +940 codec2 [2] AoIPCodec OPTIONAL, +941 codec3 [3] AoIPCodec OPTIONAL, +942 codec4 [4] AoIPCodec OPTIONAL, +943 codec5 [5] AoIPCodec OPTIONAL, +944 codec6 [6] AoIPCodec OPTIONAL, +945 codec7 [7] AoIPCodec OPTIONAL, +946 codec8 [8] AoIPCodec OPTIONAL, +947 extensionContainer [9] ExtensionContainer OPTIONAL, +948 ...} +949 -- Codecs are sent in priority order where codec1 has highest priority +950 +951 AoIPCodec ::= OCTET STRING (SIZE (1..3)) +952 +953 -- The internal structure is defined as follows: +954 -- octet 1 Coded as Speech Codec Elements in 3GPP TS 48.008 +955 -- with the exception that FI, PI, PT and TF bits shall +956 -- be set to 0 +957 -- octets 2,3 Optional; in case of AMR codec types it defines +958 -- the supported codec configurations as defined in +959 -- 3GPP TS 48.008 +960 +961 SupportedCodecsList ::= SEQUENCE { +962 utranCodecList [0] CodecList OPTIONAL, +963 geranCodecList [1] CodecList OPTIONAL, +964 extensionContainer [2] ExtensionContainer OPTIONAL, +965 ...} +966 +967 CodecList ::= SEQUENCE { +968 codec1 [1] Codec, +969 codec2 [2] Codec OPTIONAL, +970 codec3 [3] Codec OPTIONAL, +971 codec4 [4] Codec OPTIONAL, +972 codec5 [5] Codec OPTIONAL, +973 codec6 [6] Codec OPTIONAL, +974 codec7 [7] Codec OPTIONAL, +975 codec8 [8] Codec OPTIONAL, +976 extensionContainer [9] ExtensionContainer OPTIONAL, +977 ...} +978 -- Codecs are sent in priority order where codec1 has highest priority +979 + +``` + +``` + +980 Codec ::= OCTET STRING (SIZE (1..4)) +981 +982 -- The internal structure is defined as follows: +983 -- octet 1 Coded as Codec Identification code in 3GPP TS 26.103 +984 -- octets 2,3,4 Parameters for the Codec as defined in 3GPP TS +985 -- 26.103, if available, length depending on the codec +986 +987 GERAN-Classmark ::= OCTET STRING (SIZE (2..87)) +988 -- Octets are coded according the GERAN Classmark information element in 3GPP TS 48.008 +989 +990 SelectedGSM-Algorithm ::= OCTET STRING (SIZE (1)) +991 -- internal structure is coded as Algorithm identifier octet from Chosen Encryption +992 -- Algorithm defined in 3GPP TS 48.008 +993 -- A node shall mark only the selected GSM algorithm +994 +995 SendEndSignal-Arg ::= [3] SEQUENCE { +996 an-APDU AccessNetworkSignalInfo, +997 extensionContainer [0] ExtensionContainer OPTIONAL, +998 ...} +999 +1000 SendEndSignal-Res ::= SEQUENCE { +1001 extensionContainer [0] ExtensionContainer OPTIONAL, +1002 ...} +1003 +1004 RNCId ::= OCTET STRING (SIZE (7)) +1005 -- The internal structure is defined as follows: +1006 -- octet 1 bits 4321 Mobile Country Code 1st digit +1007 -- bits 8765 Mobile Country Code 2nd digit +1008 -- octet 2 bits 4321 Mobile Country Code 3rd digit +1009 -- bits 8765 Mobile Network Code 3rd digit +1010 -- or filler (1111) for 2 digit MNCs +1011 -- octet 3 bits 4321 Mobile Network Code 1st digit +1012 -- bits 8765 Mobile Network Code 2nd digit +1013 -- octets 4 and 5 Location Area Code according to 3GPP TS 24.008 +1014 -- octets 6 and 7 RNC Id or Extended RNC Id value according to +1015 -- 3GPP TS 25.413 +1016 +1017 RelocationNumberList ::= SEQUENCE SIZE (1..maxNumOfRelocationNumber) OF +1018 RelocationNumber +1019 +1020 MulticallBearerInfo ::= INTEGER (1..maxNumOfRelocationNumber) +1021 +1022 RelocationNumber ::= SEQUENCE { +1023 handoverNumber ISDN-AddressString, +1024 rab-Id RAB-Id, +1025 -- RAB Identity is needed to relate the calls with the radio access bearers. +1026 ...} +1027 +1028 RAB-Id ::= INTEGER (1..maxNrOfRABs) +1029 +1030 maxNrOfRABs INTEGER ::= 255 +1031 +1032 maxNumOfRelocationNumber INTEGER ::= 7 +1033 +1034 RadioResourceInformation ::= OCTET STRING (SIZE (3..13)) +1035 -- Octets are coded according the Channel Type information element in 3GPP TS 48.008 +1036 +1037 IntegrityProtectionInformation ::= OCTET STRING (SIZE (18..maxNumOfIntegrityInfo)) +1038 -- Octets contain a complete IntegrityProtectionInformation data type +1039 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +1040 -- mandated by 3GPP TS 25.413 +1041 -- Padding bits are included, if needed, in the least significant bits of the +1042 -- last octet of the octet string. +1043 +1044 maxNumOfIntegrityInfo INTEGER ::= 100 +1045 +1046 EncryptionInformation ::= OCTET STRING (SIZE (18..maxNumOfEncryptionInfo)) +1047 -- Octets contain a complete EncryptionInformation data type +1048 -- as defined in 3GPP TS 25.413, encoded according to the encoding scheme +1049 -- mandated by 3GPP TS 25.413 +1050 -- Padding bits are included, if needed, in the least significant bits of the +1051 -- last octet of the octet string. +1052 +1053 maxNumOfEncryptionInfo INTEGER ::= 100 +1054 + +``` + +1055 -- authentication management types + +1056 +1057 SendAuthenticationInfoArg ::= SEQUENCE { +1058 imsi [0] IMSI, +1059 numberOfRequestedVectors NumberOfRequestedVectors, +1060 segmentationProhibited NULL OPTIONAL, +1061 immediateResponsePreferred [1] NULL OPTIONAL, +1062 re-synchronisationInfo Re-synchronisationInfo OPTIONAL, +1063 extensionContainer [2] ExtensionContainer OPTIONAL, +1064 ..., +1065 requestingNodeType [3] RequestingNodeType OPTIONAL, +1066 requestingPLMN-Id [4] PLMN-Id OPTIONAL, +1067 numberOfRequestedAdditional-Vectors [5] NumberOfRequestedVectors OPTIONAL, +1068 additionalVectorsAreForEPS [6] NULL OPTIONAL, +1069 ueUsageTypeRequestIndication [7] NULL OPTIONAL } + +1070 +1071 +1072 NumberOfRequestedVectors ::= INTEGER (1..5) + +1073 +1074 Re-synchronisationInfo ::= SEQUENCE { +1075 rand RAND, +1076 auts AUTS, +1077 ... } + +1078 +1079 SendAuthenticationInfoRes ::= [3] SEQUENCE { +1080 authenticationSetList AuthenticationSetList OPTIONAL, +1081 extensionContainer ExtensionContainer OPTIONAL, +1082 ..., +1083 eps-AuthenticationSetList [2] EPS-AuthenticationSetList OPTIONAL, +1084 ueUsageType [3] UE-UsageType OPTIONAL } + +1085 +1086 EPS-AuthenticationSetList ::= SEQUENCE SIZE (1..5) OF +1087 EPC-AV + +1088 +1089 UE-UsageType ::= OCTET STRING (SIZE (4)) +1090 -- octets are coded as defined in 3GPP TS 29.272 [144] + +1091 +1092 EPC-AV ::= SEQUENCE { +1093 rand RAND, +1094 xres XRES, +1095 autn AUTN, +1096 kasme KASME, +1097 extensionContainer ExtensionContainer OPTIONAL, +1098 ... } + +1099 +1100 KASME ::= OCTET STRING (SIZE (32)) + +1101 +1102 RequestingNodeType ::= ENUMERATED { +1103 vlr (0), +1104 sgsn (1), +1105 ..., +1106 s-cscf (2), +1107 bsf (3), +1108 gan-aaa-server (4), +1109 wlan-aaa-server (5), +1110 mme (16), +1111 mme-sgsn (17) +1112 } +1113 -- the values 2, 3, 4 and 5 shall not be used on the MAP-D or Gr interfaces +1114 -- exception handling: +1115 -- received values in the range (6-15) shall be treated as "vlr" +1116 -- received values greater than 17 shall be treated as "sgsn" + +1117 +1118 -- equipment management types + +1119 +1120 CheckIMEI-Arg ::= SEQUENCE { +1121 imei IMEI, +1122 requestedEquipmentInfo RequestedEquipmentInfo, +1123 extensionContainer ExtensionContainer OPTIONAL, +1124 ... } + +1125 +1126 CheckIMEI-Res ::= SEQUENCE { +1127 equipmentStatus EquipmentStatus OPTIONAL, +1128 bmuef UESBI-Iu OPTIONAL, +1129 extensionContainer [0] ExtensionContainer OPTIONAL, +1130 ... } + +1131 + +``` + +1132 RequestedEquipmentInfo ::= BIT STRING { +1133 equipmentStatus (0), +1134 bmuef (1)} (SIZE (2..8)) +1135 -- exception handling: reception of unknown bit assignments in the +1136 -- RequestedEquipmentInfo data type shall be discarded by the receiver +1137 +1138 UESBI-Iu ::= SEQUENCE { +1139 uesbi-IuA [0] UESBI-IuA OPTIONAL, +1140 uesbi-IuB [1] UESBI-IuB OPTIONAL, +1141 ...} +1142 +1143 UESBI-IuA ::= BIT STRING (SIZE(1..128)) +1144 -- See 3GPP TS 25.413 +1145 +1146 UESBI-IuB ::= BIT STRING (SIZE(1..128)) +1147 -- See 3GPP TS 25.413 +1148 +1149 EquipmentStatus ::= ENUMERATED { +1150 permittedListed (0), +1151 prohibitedListed (1), +1152 trackingListed (2)} +1153 +1154 -- subscriber management types +1155 +1156 InsertSubscriberDataArg ::= SEQUENCE { +1157 imsi [0] IMSI OPTIONAL, +1158 COMPONENTS OF SubscriberData, +1159 extensionContainer [14] ExtensionContainer OPTIONAL, +1160 ... , +1161 naea-PreferredCI [15] NAEA-PreferredCI OPTIONAL, +1162 -- naea-PreferredCI is included at the discretion of the HLR operator. +1163 gprsSubscriptionData [16] GPRSSubscriptionData OPTIONAL, +1164 roamingRestrictedInSgsnDueToUnsupportedFeature [23] NULL +1165 OPTIONAL, +1166 networkAccessMode [24] NetworkAccessMode OPTIONAL, +1167 lsaInformation [25] LSAInformation OPTIONAL, +1168 lmu-Indicator [21] NULL OPTIONAL, +1169 lcsInformation [22] LCSInformation OPTIONAL, +1170 istAlertTimer [26] IST-AlertTimerValue OPTIONAL, +1171 superChargerSupportedInHLR [27] AgeIndicator OPTIONAL, +1172 mc-SS-Info [28] MC-SS-Info OPTIONAL, +1173 cs-AllocationRetentionPriority [29] CS-AllocationRetentionPriority OPTIONAL, +1174 sgsn-CAMEL-SubscriptionInfo [17] SGSN-CAMEL-SubscriptionInfo OPTIONAL, +1175 chargingCharacteristics [18] ChargingCharacteristics OPTIONAL, +1176 accessRestrictionData [19] AccessRestrictionData OPTIONAL, +1177 ics-Indicator [20] BOOLEAN OPTIONAL, +1178 eps-SubscriptionData [31] EPS-SubscriptionData OPTIONAL, +1179 csg-SubscriptionDataList [32] CSG-SubscriptionDataList OPTIONAL, +1180 ue-ReachabilityRequestIndicator [33] NULL OPTIONAL, +1181 sgsn-Number [34] ISDN-AddressString OPTIONAL, +1182 mme-Name [35] DiameterIdentity OPTIONAL, +1183 subscribedPeriodicRAUTAutimer [36] SubscribedPeriodicRAUTAutimer OPTIONAL, +1184 vplmnLIPAAllowed [37] NULL OPTIONAL, +1185 mdtUserConsent [38] BOOLEAN OPTIONAL, +1186 subscribedPeriodicLAUTautimer [39] SubscribedPeriodicLAUTautimer OPTIONAL, +1187 vplmn-Csg-SubscriptionDataList [40] VPLMN-CSG-SubscriptionDataList OPTIONAL, +1188 additionalMSISDN [41] ISDN-AddressString OPTIONAL, +1189 psAndSMS-OnlyServiceProvision [42] NULL OPTIONAL, +1190 smsInSGSNAllowed [43] NULL OPTIONAL, +1191 cs-to-ps-SRVCC-Allowed-Indicator [44] NULL OPTIONAL, +1192 pscf-Restoration-Request [45] NULL OPTIONAL, +1193 adjacentAccessRestrictionDataList [46] AdjacentAccessRestrictionDataList OPTIONAL, +1194 imsi-Group-Id-List [47] IMSI-GroupIdList OPTIONAL, +1195 ueUsageType [48] UE-UsageType OPTIONAL, +1196 userPlaneIntegrityProtectionIndicator [49] NULL OPTIONAL, +1197 dl-Buffering-Suggested-Packet-Count [50] DL-Buffering-Suggested-Packet-Count OPTIONAL, +1198 reset-Id-List [51] Reset-Id-List OPTIONAL, +1199 edrx-Cycle-Length-List [52] EDRX-Cycle-Length-List OPTIONAL, +1200 ext-AccessRestrictionData [53] Ext-AccessRestrictionData OPTIONAL, +1201 iab-Operation-Allowed-Indicator [54] NULL OPTIONAL } +1202 -- If the Network Access Mode parameter is sent, it shall be present only in +1203 -- the first sequence if segmentation is used +1204 +1205 EDRX-Cycle-Length-List ::= SEQUENCE SIZE (1..8) OF +1206 EDRX-Cycle-Length +1207 + +``` + +``` + +1208 EDRX-Cycle-Length ::= SEQUENCE { +1209 rat-Type [0] Used-RAT-Type, +1210 eDRX-Cycle-Length-Value [1] EDRX-Cycle-Length-Value, +1211 ... } +1212 -- The eDRX-Cycle-Length contains the subscribed eDRX-Cycle-Length applicable to a +1213 -- a specific RAT Type. +1214 +1215 +1216 EDRX-Cycle-Length-Value ::= OCTET STRING (SIZE (1)) +1217 -- The EDRX-Cycle-Length-Value shall be encoded as specified in clause 7.3.216 of +1218 -- 3GPP TS 29.272 [144]. +1219 +1220 +1221 Reset-Id-List ::= SEQUENCE SIZE (1..50) OF +1222 Reset-Id +1223 +1224 Reset-Id ::= OCTET STRING (SIZE (1..4)) +1225 -- Reset-Ids shall be unique within the HPLMN. +1226 +1227 +1228 DL-Buffering-Suggested-Packet-Count ::= INTEGER (-1..2147483647) +1229 -- values are defined in 3GPP TS 29.272 [144] +1230 +1231 +1232 Group-Service-ID ::= INTEGER (0..4294967295) +1233 -- values are defined in 3GPP TS 29.272 [144] +1234 +1235 +1236 Local-GroupID ::= OCTET STRING (SIZE (1..10)) +1237 -- Refers to Local group ID defined by an operator identified by the PLMN-ID. +1238 -- for details see 3GPP TS 29.272 [144] +1239 +1240 IMSI-GroupIdList ::= SEQUENCE SIZE (1..50) OF +1241 IMSI-GroupId +1242 +1243 IMSI-GroupId ::= SEQUENCE { +1244 group-Service-Id [0] Group-Service-ID, +1245 plmnId [1] PLMN-Id, +1246 local-Group-ID [2] Local-GroupID, +1247 ... } +1248 +1249 SubscribedPeriodicRAUTAtimer ::= INTEGER (0..4294967295) +1250 -- This parameter carries the subscribed periodic TAU/RAU timer value in seconds as +1251 -- specified in 3GPP TS 24.008 [35]. +1252 +1253 SubscribedPeriodicLAUtimer ::= INTEGER (0..4294967295) +1254 -- This parameter carries the subscribed periodic LAU timer value in seconds as +1255 -- specified in 3GPP TS 24.008 [35]. +1256 +1257 CSG-SubscriptionDataList ::= SEQUENCE SIZE (1..50) OF +1258 CSG-SubscriptionData +1259 +1260 CSG-SubscriptionData ::= SEQUENCE { +1261 csg-Id CSG-Id, +1262 expirationDate Time OPTIONAL, +1263 extensionContainer ExtensionContainer OPTIONAL, +1264 ..., +1265 lipa-AllowedAPNList [0] LIPA-AllowedAPNList OPTIONAL, +1266 plmn-Id [1] PLMN-Id OPTIONAL +1267 } +1268 +1269 VPLMN-CSG-SubscriptionDataList ::= SEQUENCE SIZE (1..50) OF +1270 CSG-SubscriptionData +1271 +1272 CSG-Id ::= BIT STRING (SIZE (27)) +1273 -- coded according to 3GPP TS 23.003 [17]. +1274 +1275 LIPA-AllowedAPNList ::= SEQUENCE SIZE (1..maxNumOfLIPAAllowedAPN) OF +1276 APN +1277 +1278 maxNumOfLIPAAllowedAPN INTEGER ::= 50 +1279 +1280 + +``` + +``` + +1281 EPS-SubscriptionData ::= SEQUENCE { +1282 apn-oi-Replacement [0] APN-OI-Replacement OPTIONAL, +1283 -- this apn-oi-Replacement refers to the UE level apn-oi-Replacement. +1284 rfsp-id [2] RFSP-ID OPTIONAL, +1285 ambr [3] AMBR OPTIONAL, +1286 apn-ConfigurationProfile [4] APN-ConfigurationProfile OPTIONAL, +1287 stn-sr [6] ISDN-AddressString OPTIONAL, +1288 extensionContainer [5] ExtensionContainer OPTIONAL, +1289 ..., +1290 mps-CSPriority [7] NULL OPTIONAL, +1291 mps-EPSPriority [8] NULL OPTIONAL, +1292 subscribed-vsrvcc [9] NULL OPTIONAL } +1293 -- mps-CSPriority by its presence indicates that the UE is subscribed to the eMLPP in +1294 -- the CS domain, referring to the 3GPP TS 29.272 [144] for details. +1295 -- mps-EPSPriority by its presence indicates that the UE is subscribed to the MPS in +1296 -- the EPS domain, referring to the 3GPP TS 29.272 [144] for details. +1297 -- +1298 -- subscribed-vsrvcc by its presence indicates that the UE is subscribed to the vSRVCC in +1299 -- the EPS domain, referring to the 3GPP TS 29.272 [144] for details. +1300 +1301 APN-OI-Replacement ::= OCTET STRING (SIZE (9..100)) +1302 -- Octets are coded as APN Operator Identifier according to TS 3GPP TS 23.003 [17] +1303 +1304 RFSP-ID ::= INTEGER (1..256) +1305 +1306 APN-ConfigurationProfile ::= SEQUENCE { +1307 defaultContext ContextId, +1308 completeDataListIncluded NULL OPTIONAL, +1309 -- If segmentation is used, completeDataListIncluded may only be present in the +1310 -- first segment of APN-ConfigurationProfile. +1311 epsDataList [1] EPS-DataList, +1312 extensionContainer [2] ExtensionContainer OPTIONAL, +1313 ... , +1314 additionalDefaultContext [3] ContextId OPTIONAL +1315 -- for details see the 3GPP TS 29.272 [144]. +1316 } +1317 +1318 EPS-DataList ::= SEQUENCE SIZE (1..maxNumOfAPN-Configurations) OF +1319 APN-Configuration +1320 +1321 +1322 maxNumOfAPN-Configurations INTEGER ::= 50 +1323 +1324 +1325 APN-Configuration ::= SEQUENCE { +1326 contextId [0] ContextId, +1327 pdn-Type [1] PDN-Type, +1328 servedPartyIP-IPv4-Address [2] PDP-Address OPTIONAL, +1329 apn [3] APN, +1330 eps-qos-Subscribed [4] EPS-QoS-Subscribed, +1331 pdn-gw-Identity [5] PDN-GW-Identity OPTIONAL, +1332 pdn-gw-AllocationType [6] PDN-GW-AllocationType OPTIONAL, +1333 vplmnAddressAllowed [7] NULL OPTIONAL, +1334 chargingCharacteristics [8] ChargingCharacteristics OPTIONAL, +1335 ambr [9] AMBR OPTIONAL, +1336 specificAPNInfoList [10] SpecificAPNInfoList OPTIONAL, +1337 extensionContainer [11] ExtensionContainer OPTIONAL, +1338 servedPartyIP-IPv6-Address [12] PDP-Address OPTIONAL, +1339 ..., +1340 apn-oi-Replacement [13] APN-OI-Replacement OPTIONAL, +1341 -- this apn-oi-Replacement refers to the APN level apn-oi-Replacement. +1342 sipto-Permission [14] SIPTO-Permission OPTIONAL, +1343 lipa-Permission [15] LIPA-Permission OPTIONAL, +1344 restoration-Priority [16] Restoration-Priority OPTIONAL, +1345 sipto-local-network-Permission [17] SIPTO-Local-Network-Permission OPTIONAL, +1346 wlan-offloadability [18] WLAN-Offloadability OPTIONAL, +1347 non-IP-PDN-Type-Indicator [19] NULL OPTIONAL, +1348 nIDD-Mechanism [20] NIDD-Mechanism OPTIONAL, +1349 sCEF-ID [21] FQDN OPTIONAL, +1350 pdn-ConnectionContinuity [22] PDN-ConnectionContinuity OPTIONAL +1351 -- absence of pdn-ConnectionContinuity indicates that the handling is left to +1352 -- local VPLMN policy +1353 } +1354 + +``` + +``` + +1355 PDN-ConnectionContinuity ::= ENUMERATED { +1356 maintainPDN-Connection (0), +1357 disconnectPDN-ConnectionWithReactivationRequest (1), +1358 disconnectPDN-ConnectionWithoutReactivationRequest (2) +1359 } +1360 +1361 NIDD-Mechanism ::= ENUMERATED { +1362 sGi-based-data-delivery (0), +1363 sCEF-based-data-delivery (1) +1364 -- The default value, when this information element is not present, is +1365 -- sGi-based-data-delivery (0) +1366 } +1367 +1368 PDN-Type ::= OCTET STRING (SIZE (1)) +1369 -- Octet is coded as follows: +1370 -- Bits +1371 -- 3 2 1 +1372 -- 0 0 1 IPv4 +1373 -- 0 1 0 IPv6 +1374 -- 0 1 1 IPv4v6 +1375 -- 1 0 0 IPv4 or IPv6 +1376 -- Bits 8-4 shall be coded as zero. +1377 -- for details see 3GPP TS 29.272 [144] +1378 +1379 EPS-QoS-Subscribed ::= SEQUENCE { +1380 qos-Class-Identifier [0] QoS-Class-Identifier, +1381 allocation-Retention-Priority [1] Allocation-Retention-Priority, +1382 extensionContainer [2] ExtensionContainer OPTIONAL, +1383 ... } +1384 +1385 AMBR ::= SEQUENCE { +1386 max-RequestedBandwidth-UL [0] Bandwidth, +1387 max-RequestedBandwidth-DL [1] Bandwidth, +1388 extensionContainer [2] ExtensionContainer OPTIONAL, +1389 ..., +1390 extended-Max-RequestedBandwidth-UL [3] BandwidthExt OPTIONAL, +1391 extended-Max-RequestedBandwidth-DL [4] BandwidthExt OPTIONAL +1392 -- extended-Max-RequestedBandwidth-UL/DL shall be populated according to the +1393 -- description of the corresponding parameters in 3GPP TS 29.272 [144] +1394 } +1395 +1396 +1397 SpecificAPNInfoList ::= SEQUENCE SIZE (1..maxNumOfSpecificAPNInfos) OF +1398 SpecificAPNInfo +1399 +1400 maxNumOfSpecificAPNInfos INTEGER ::= 50 +1401 +1402 SpecificAPNInfo ::= SEQUENCE { +1403 apn [0] APN, +1404 pdn-gw-Identity [1] PDN-GW-Identity, +1405 extensionContainer [2] ExtensionContainer OPTIONAL, +1406 ... } +1407 +1408 Bandwidth ::= INTEGER +1409 -- bits per second +1410 +1411 BandwidthExt ::= INTEGER +1412 -- kilobits per second +1413 +1414 QoS-Class-Identifier ::= INTEGER (1..9) +1415 -- values are defined in 3GPP TS 29.212 +1416 +1417 +1418 +1419 Allocation-Retention-Priority ::= SEQUENCE { +1420 priority-level [0] INTEGER, +1421 pre-emption-capability [1] BOOLEAN OPTIONAL, +1422 pre-emption-vulnerability [2] BOOLEAN OPTIONAL, +1423 extensionContainer [3] ExtensionContainer OPTIONAL, +1424 ... } +1425 + +``` + +``` + +1426 PDN-GW-Identity ::= SEQUENCE { +1427 pdn-gw-ipv4-Address [0] PDP-Address OPTIONAL, +1428 pdn-gw-ipv6-Address [1] PDP-Address OPTIONAL, +1429 pdn-gw-name [2] FQDN OPTIONAL, +1430 extensionContainer [3] ExtensionContainer OPTIONAL, +1431 ... } +1432 +1433 FQDN ::= OCTET STRING (SIZE (9..255)) +1434 +1435 +1436 PDN-GW-AllocationType ::= ENUMERATED { +1437 static (0), +1438 dynamic (1) } +1439 +1440 +1441 WLAN-Offloadability ::= SEQUENCE { +1442 wlan-offloadability-EUTRAN [0] WLAN-Offloadability-Indication OPTIONAL, +1443 wlan-offloadability-UTRAN [1] WLAN-Offloadability-Indication OPTIONAL, +1444 extensionContainer [2] ExtensionContainer OPTIONAL, +1445 ... } +1446 +1447 WLAN-Offloadability-Indication ::= ENUMERATED { +1448 notAllowed (0), +1449 allowed (1) } +1450 +1451 +1452 +1453 AccessRestrictionData ::= BIT STRING { +1454 utranNotAllowed (0), +1455 geranNotAllowed (1), +1456 ganNotAllowed (2), +1457 i-hspa-evolutionNotAllowed (3), +1458 wb-e-utranNotAllowed (4), +1459 ho-toNon3GPP-AccessNotAllowed (5), +1460 nb-iotNotAllowed (6), +1461 enhancedCoverageNotAllowed (7) } (SIZE (2..8)) +1462 -- exception handling: +1463 -- The VLR shall ignore the access restriction data related to an access type not +1464 -- supported by the node. +1465 -- The handling of the access restriction data by the SGSN is described in clause +1466 -- 5.3.19 of TS 23.060, in clause 7.5.3 of TS 29.060 and clause 7.3.6 of TS 29.274. +1467 -- Additional access restrictions are encoded in Ext-AccessRestrictionData bit string. +1468 +1469 +1470 Ext-AccessRestrictionData ::= BIT STRING { +1471 nrAsSecondaryRATNotAllowed (0), +1472 unlicensedSpectrumAsSecondaryRATNotAllowed (1) } (SIZE (1..32)) +1473 +1474 +1475 AdjacentAccessRestrictionDataList ::= SEQUENCE SIZE (1..50) OF +1476 AdjacentAccessRestrictionData +1477 +1478 +1479 AdjacentAccessRestrictionData ::= SEQUENCE { +1480 plmnId [0] PLMN-Id, +1481 accessRestrictionData [1] AccessRestrictionData, +1482 ... , +1483 ext-AccessRestrictionData [2] Ext-AccessRestrictionData OPTIONAL } +1484 +1485 +1486 CS-AllocationRetentionPriority ::= OCTET STRING (SIZE (1)) +1487 -- This data type encodes each priority level defined in 3GPP TS 23.107 [154] as the +1488 -- binary value of the priority level. +1489 +1490 +1491 IST-AlertTimerValue ::= INTEGER (15..255) +1492 +1493 +1494 LCSInformation ::= SEQUENCE { +1495 gmlc-List [0] GMLC-List OPTIONAL, +1496 lcs-PrivacyExceptionList [1] LCS-PrivacyExceptionList OPTIONAL, +1497 molr-List [2] MOLR-List OPTIONAL, +1498 ..., +1499 add-lcs-PrivacyExceptionList [3] LCS-PrivacyExceptionList OPTIONAL } +1500 -- add-lcs-PrivacyExceptionList may be sent only if lcs-PrivacyExceptionList is +1501 -- present and contains four instances of LCS-PrivacyClass. If the mentioned condition +1502 -- is not satisfied the receiving node shall discard add-lcs-PrivacyExceptionList. +1503 -- If an LCS-PrivacyClass is received both in lcs-PrivacyExceptionList and in +1504 -- add-lcs-PrivacyExceptionList with the same SS-Code, then the error unexpected +1505 -- data value shall be returned. + +``` + +``` + +1502 GMLC-List ::= SEQUENCE SIZE (1..maxNumOfGMLC) OF +1503 ISDN-AddressString +1504 -- if segmentation is used, the complete GMLC-List shall be sent in one segment +1505 +1506 maxNumOfGMLC INTEGER ::= 5 +1507 +1508 NetworkAccessMode ::= ENUMERATED { +1509 packetAndCircuit (0), +1510 onlyCircuit (1), +1511 onlyPacket (2), +1512 ...} +1513 -- if unknown values are received in NetworkAccessMode +1514 -- they shall be discarded. +1515 +1516 GPRSDatalist ::= SEQUENCE SIZE (1..maxNumOfPDP-Contexts) OF +1517 PDP-Context +1518 +1519 maxNumOfPDP-Contexts INTEGER ::= 50 +1520 +1521 PDP-Context ::= SEQUENCE { +1522 pdp-ContextId ContextId, +1523 pdp-Type [16] PDP-Type, +1524 pdp-Address [17] PDP-Address OPTIONAL, +1525 qos-Subscribed [18] QoS-Subscribed, +1526 vplmnAddressAllowed [19] NULL OPTIONAL, +1527 apn [20] APN, +1528 extensionContainer [21] ExtensionContainer OPTIONAL, +1529 ... , +1530 ext-QoS-Subscribed [0] Ext-QoS-Subscribed OPTIONAL, +1531 pdp-ChargingCharacteristics [1] ChargingCharacteristics OPTIONAL, +1532 ext2-QoS-Subscribed [2] Ext2-QoS-Subscribed OPTIONAL, +1533 -- ext2-QoS-Subscribed may be present only if ext-QoS-Subscribed is present. +1534 ext3-QoS-Subscribed [3] Ext3-QoS-Subscribed OPTIONAL, +1535 -- ext3-QoS-Subscribed may be present only if ext2-QoS-Subscribed is present. +1536 ext4-QoS-Subscribed [4] Ext4-QoS-Subscribed OPTIONAL, +1537 -- ext4-QoS-Subscribed may be present only if ext3-QoS-Subscribed is present. +1538 apn-oi-Replacement [5] APN-OI-Replacement OPTIONAL, +1539 -- this apn-oi-Replacement refers to the APN level apn-oi-Replacement and has +1540 -- higher priority than UE level apn-oi-Replacement. +1541 ext-pdp-Type [6] Ext-PDP-Type OPTIONAL, +1542 -- contains the value IPv4v6 defined in 3GPP TS 29.060 [105], if the PDP can be +1543 -- accessed by dual-stack UEs +1544 ext-pdp-Address [7] PDP-Address OPTIONAL, +1545 -- contains an additional IP address in case of dual-stack static IP address assignment +1546 -- for the UE. +1547 -- it may contain an IPv4 or an IPv6 address/prefix, and it may be present +1548 -- only if pdp-Address is present; if both are present, each parameter shall +1549 -- contain a different type of address (IPv4 or IPv6). +1550 ambr [10] AMBR OPTIONAL, +1551 -- this ambr contains the AMBR associated to the APN included in the +1552 -- PDP-Context (APN-AMBR). +1553 sipto-Permission [8] SIPTO-Permission OPTIONAL, +1554 lipa-Permission [9] LIPA-Permission OPTIONAL, +1555 restoration-Priority [11] Restoration-Priority OPTIONAL, +1556 sipto-local-network-Permission [12] SIPTO-Local-Network-Permission OPTIONAL, +1557 nIDD-Mechanism [13] NIDD-Mechanism OPTIONAL, +1558 sCEF-ID [14] FQDN OPTIONAL +1559 } +1560 +1561 Restoration-Priority ::= OCTET STRING (SIZE (1)) +1562 -- Octet 1: +1563 -- Restoration Priority. This octet encodes the Restoration Priority, +1564 -- as the binary value of the Restoration-Priority described in 3GPP TS 29.272 [144]. +1565 +1566 SIPTO-Permission ::= ENUMERATED { +1567 siptoAboveRanAllowed (0), +1568 siptoAboveRanNotAllowed (1) +1569 } +1570 +1571 SIPTO-Local-Network-Permission ::= ENUMERATED { +1572 siptoAtLocalNetworkAllowed (0), +1573 siptoAtLocalNetworkNotAllowed (1) +1574 } +1575 + +``` + +``` + +1576 LIPA-Permission ::= ENUMERATED { +1577 lipaProhibited (0), +1578 lipaOnly (1), +1579 lipaConditional (2) +1580 } +1581 +1582 ContextId ::= INTEGER (1..maxNumOfPDP-Contexts) +1583 +1584 GPRSSubscriptionData ::= SEQUENCE { +1585 completeDataListIncluded NULL OPTIONAL, +1586 -- If segmentation is used, completeDataListIncluded may only be present in the +1587 -- first segment of GPRSSubscriptionData. +1588 gprsDataList [1] GPRSDataList, +1589 extensionContainer [2] ExtensionContainer OPTIONAL, +1590 ..., +1591 apn-oi-Replacement [3] APN-OI-Replacement OPTIONAL +1592 -- this apn-oi-Replacement refers to the UE level apn-oi-Replacement. +1593 } +1594 +1595 SGSN-CAMEL-SubscriptionInfo ::= SEQUENCE { +1596 gprs-CSI [0] GPRS-CSI OPTIONAL, +1597 mo-sms-CSI [1] SMS-CSI OPTIONAL, +1598 extensionContainer [2] ExtensionContainer OPTIONAL, +1599 ..., +1600 mt-sms-CSI [3] SMS-CSI OPTIONAL, +1601 mt-smsCAMELTDP-CriteriaList [4] MT-smsCAMELTDP-CriteriaList OPTIONAL, +1602 mg-csi [5] MG-CSI OPTIONAL +1603 } +1604 +1605 GPRS-CSI ::= SEQUENCE { +1606 gprs-CamelTDPDataList [0] GPRS-CamelTDPDataList OPTIONAL, +1607 camelCapabilityHandling [1] CamelCapabilityHandling OPTIONAL, +1608 extensionContainer [2] ExtensionContainer OPTIONAL, +1609 notificationToCSE [3] NULL OPTIONAL, +1610 csi-Active [4] NULL OPTIONAL, +1611 ...} +1612 -- notificationToCSE and csi-Active shall not be present when GPRS-CSI is sent to SGSN. +1613 -- They may only be included in ATSI/ATM ack/NSDC message. +1614 -- GPRS-CamelTDPData and camelCapabilityHandling shall be present in +1615 -- the GPRS-CSI sequence. +1616 -- If GPRS-CSI is segmented, gprs-CamelTDPDataList and camelCapabilityHandling shall be +1617 -- present in the first segment +1618 +1619 GPRS-CamelTDPDataList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +1620 GPRS-CamelTDPData +1621 -- GPRS-CamelTDPDataList shall not contain more than one instance of +1622 -- GPRS-CamelTDPData containing the same value for gprs-TriggerDetectionPoint. +1623 +1624 GPRS-CamelTDPData ::= SEQUENCE { +1625 gprs-TriggerDetectionPoint [0] GPRS-TriggerDetectionPoint, +1626 serviceKey [1] ServiceKey, +1627 gsmSCF-Address [2] ISDN-AddressString, +1628 defaultSessionHandling [3] DefaultGPRS-Handling, +1629 extensionContainer [4] ExtensionContainer OPTIONAL, +1630 ... +1631 } +1632 +1633 DefaultGPRS-Handling ::= ENUMERATED { +1634 continueTransaction (0) , +1635 releaseTransaction (1) , +1636 ...} +1637 -- exception handling: +1638 -- reception of values in range 2-31 shall be treated as "continueTransaction" +1639 -- reception of values greater than 31 shall be treated as "releaseTransaction" +1640 +1641 GPRS-TriggerDetectionPoint ::= ENUMERATED { +1642 attach (1), +1643 attachChangeOfPosition (2), +1644 pdp-ContextEstablishment (11), +1645 pdp-ContextEstablishmentAcknowledgement (12), +1646 pdp-ContextChangeOfPosition (14), +1647 ... } +1648 -- exception handling: +1649 -- For GPRS-CamelTDPData sequences containing this parameter with any +1650 -- other value than the ones listed the receiver shall ignore the whole +1651 -- GPRS-CamelTDPData sequence. +1652 + +``` + +``` + +1653 APN ::= OCTET STRING (SIZE (2..63)) +1654 -- Octets are coded according to TS 3GPP TS 23.003 [17] +1655 +1656 PDP-Type ::= OCTET STRING (SIZE (2)) +1657 -- Octets are coded according to TS 3GPP TS 29.060 [105] +1658 -- Only the values PPP, IPv4, IPv6 and Non-IP are allowed for this parameter. +1659 +1660 Ext-PDP-Type ::= OCTET STRING (SIZE (2)) +1661 -- Octets are coded, similarly to PDP-Type, according to TS 3GPP TS 29.060 [105]. +1662 -- Only the value IPv4v6 is allowed for this parameter. +1663 +1664 PDP-Address ::= OCTET STRING (SIZE (1..16)) +1665 -- Octets are coded according to TS 3GPP TS 29.060 [105] +1666 +1667 -- The possible size values are: +1668 -- 1-7 octets X.25 address type +1669 -- 4 octets IPv4 address type +1670 -- 16 octets IPv6 address type +1671 +1672 QoS-Subscribed ::= OCTET STRING (SIZE (3)) +1673 -- Octets are coded according to TS 3GPP TS 24.008 [35] Quality of Service Octets +1674 -- 3-5. +1675 +1676 Ext-QoS-Subscribed ::= OCTET STRING (SIZE (1..9)) +1677 -- OCTET 1: +1678 -- Allocation/Retention Priority (This octet encodes each priority level defined in +1679 -- 3GPP TS 23.107 [154] as the binary value of the priority level, declaration in +1680 -- 3GPP TS 29.060 [105]) +1681 -- Octets 2-9 are coded according to 3GPP TS 24.008 [35] Quality of Service Octets +1682 -- 6-13. +1683 +1684 Ext2-QoS-Subscribed ::= OCTET STRING (SIZE (1..3)) +1685 -- Octets 1-3 are coded according to 3GPP TS 24.008 [35] Quality of Service Octets 14-16. +1686 -- If Quality of Service information is structured with 14 octet length, then +1687 -- Octet 1 is coded according to 3GPP TS 24.008 [35] Quality of Service Octet 14. +1688 +1689 Ext3-QoS-Subscribed ::= OCTET STRING (SIZE (1..2)) +1690 -- Octets 1-2 are coded according to 3GPP TS 24.008 [35] Quality of Service Octets 17-18. +1691 +1692 Ext4-QoS-Subscribed ::= OCTET STRING (SIZE (1)) +1693 -- Octet 1: +1694 -- Evolved Allocation/Retention Priority. This octet encodes the Priority Level (PL), +1695 -- the Preemption Capability (PCI) and Preemption Vulnerability (PVI) values, as +1696 -- described in 3GPP TS 29.060 [105]. +1697 +1698 ChargingCharacteristics ::= OCTET STRING (SIZE (2)) +1699 -- Octets are coded according to 3GPP TS 32.215. +1700 +1701 LSAPOnlyAccessIndicator ::= ENUMERATED { +1702 accessOutsideLSAsAllowed (0), +1703 accessOutsideLSAsRestricted (1) } +1704 +1705 LSADatalist ::= SEQUENCE SIZE (1..maxNumOfLSAs) OF +1706 LSADatA +1707 +1708 maxNumOfLSAs INTEGER ::= 20 +1709 +1710 LSADatA ::= SEQUENCE { +1711 lsaIdentity [0] LSADatAIdentity, +1712 lsaAttributes [1] LSADatAAttributes, +1713 lsaActiveModeIndicator [2] NULL OPTIONAL, +1714 extensionContainer [3] ExtensionContainer OPTIONAL, +1715 ... } +1716 +1717 LSADatAInformation ::= SEQUENCE { +1718 completeDataListIncluded NULL OPTIONAL, +1719 +1720 -- If segmentation is used, completeDataListIncluded may only be present in the +1721 -- first segment. +1722 lsaOnlyAccessIndicator [1] LSAPOnlyAccessIndicator OPTIONAL, +1723 lsaDataList [2] LSADatalist OPTIONAL, +1724 extensionContainer [3] ExtensionContainer OPTIONAL, +1725 ... } +1726 + +``` + +``` + +1727 LSAIdentity := OCTET STRING (SIZE (3)) +1728 -- Octets are coded according to TS 3GPP TS 23.003 [17] +1729 +1730 LSAAttributes := OCTET STRING (SIZE (1)) +1731 -- Octets are coded according to TS 3GPP TS 48.008 [49] +1732 +1733 SubscriberData := SEQUENCE { +1734 msisdn [1] ISDN-AddressString OPTIONAL, +1735 category [2] Category OPTIONAL, +1736 subscriberStatus [3] SubscriberStatus OPTIONAL, +1737 bearerServiceList [4] BearerServiceList OPTIONAL, +1738 -- The exception handling for reception of unsupported / not allocated +1739 -- bearerServiceCodes is defined in clause 8.8.1 +1740 teleserviceList [6] TeleserviceList OPTIONAL, +1741 -- The exception handling for reception of unsupported / not allocated +1742 -- teleserviceCodes is defined in clause 8.8.1 +1743 provisionedSS [7] Ext-SS-InfoList OPTIONAL, +1744 odb-Data [8] ODB-Data OPTIONAL, +1745 roamingRestrictionDueToUnsupportedFeature [9] NULL OPTIONAL, +1746 regionalSubscriptionData [10] ZoneCodeList OPTIONAL, +1747 vbssSubscriptionData [11] VBSDatalist OPTIONAL, +1748 vgcsSubscriptionData [12] VGCSDataList OPTIONAL, +1749 vlrCamelSubscriptionInfo [13] VlrCamelSubscriptionInfo OPTIONAL +1750 } +1751 +1752 Category := OCTET STRING (SIZE (1)) +1753 -- The internal structure is defined in ITU-T Rec Q.763. +1754 +1755 SubscriberStatus := ENUMERATED { +1756 serviceGranted (0), +1757 operatorDeterminedBarring (1)} +1758 +1759 BearerServiceList := SEQUENCE SIZE (1..maxNumOfBearerServices) OF +1760 Ext-BearerServiceCode +1761 +1762 maxNumOfBearerServices INTEGER := 50 +1763 +1764 TeleserviceList := SEQUENCE SIZE (1..maxNumOfTeleservices) OF +1765 Ext-TeleserviceCode +1766 +1767 maxNumOfTeleservices INTEGER := 20 +1768 +1769 ODB-Data := SEQUENCE { +1770 odb-GeneralData ODB-GeneralData, +1771 odb-HPLMN-Data ODB-HPLMN-Data OPTIONAL, +1772 extensionContainer ExtensionContainer OPTIONAL, +1773 ...} +1774 + +``` + +``` + +1775 ODB-GeneralData ::= BIT STRING { +1776 allOG-CallsBarred (0), +1777 internationalOGCallsBarred (1), +1778 internationalOGCallsNotToHPLMN-CountryBarred (2), +1779 interzonalOGCallsBarred (6), +1780 interzonalOGCallsNotToHPLMN-CountryBarred (7), +1781 interzonalOGCallsAndInternationalOGCallsNotToHPLMN-CountryBarred (8), +1782 premiumRateInformationOGCallsBarred (3), +1783 premiumRateEntertainmentOGCallsBarred (4), +1784 ss-AccessBarred (5), +1785 allECT-Barred (9), +1786 chargeableECT-Barred (10), +1787 internationalECT-Barred (11), +1788 interzonalECT-Barred (12), +1789 doublyChargeableECT-Barred (13), +1790 multipleECT-Barred (14), +1791 allPacketOrientedServicesBarred (15), +1792 roamerAccessToHPLMN-AP-Barred (16), +1793 roamerAccessToVPLMN-AP-Barred (17), +1794 roamingOutsidePLMNOG-CallsBarred (18), +1795 allIC-CallsBarred (19), +1796 roamingOutsidePLMNIC-CallsBarred (20), +1797 roamingOutsidePLMNCountryIC-CallsBarred (21), +1798 roamingOutsidePLMN-Barred (22), +1799 roamingOutsidePLMN-CountryBarred (23), +1800 registrationAllCF-Barred (24), +1801 registrationCFNotToHPLMN-Barred (25), +1802 registrationInterzonalCF-Barred (26), +1803 registrationInterzonalCFNotToHPLMN-Barred (27), +1804 registrationInternationalCF-Barred (28)} (SIZE (15..32)) +1805 -- exception handling: reception of unknown bit assignments in the +1806 -- ODB-GeneralData type shall be treated like unsupported ODB-GeneralData +1807 -- When the ODB-GeneralData type is removed from the HLR for a given subscriber, +1808 -- in NoteSubscriberDataModified operation sent toward the gsmSCF +1809 -- all bits shall be set to "0". +1810 +1811 ODB-HPLMN-Data ::= BIT STRING { +1812 plmn-SpecificBarringType1 (0), +1813 plmn-SpecificBarringType2 (1), +1814 plmn-SpecificBarringType3 (2), +1815 plmn-SpecificBarringType4 (3)} (SIZE (4..32)) +1816 -- exception handling: reception of unknown bit assignments in the +1817 -- ODB-HPLMN-Data type shall be treated like unsupported ODB-HPLMN-Data +1818 -- When the ODB-HPLMN-Data type is removed from the HLR for a given subscriber, +1819 -- in NoteSubscriberDataModified operation sent toward the gsmSCF +1820 -- all bits shall be set to "0". +1821 +1822 Ext-SS-InfoList ::= SEQUENCE SIZE (1..maxNumOfSS) OF +1823 Ext-SS-Info +1824 +1825 Ext-SS-Info ::= CHOICE { +1826 forwardingInfo [0] Ext-ForwInfo, +1827 callBarringInfo [1] Ext-CallBarInfo, +1828 cug-Info [2] CUG-Info, +1829 ss-Data [3] Ext-SS-Data, +1830 emlpp-Info [4] EMLPP-Info} +1831 +1832 Ext-ForwInfo ::= SEQUENCE { +1833 ss-Code SS-Code, +1834 forwardingFeatureList Ext-ForwFeatureList, +1835 extensionContainer [0] ExtensionContainer OPTIONAL, +1836 ...} +1837 +1838 Ext-ForwFeatureList ::= SEQUENCE SIZE (1..maxNumOfExt-BasicServiceGroups) OF +1839 Ext-ForwFeature +1840 + +``` + +``` + +1841 Ext-ForwFeature ::= SEQUENCE { +1842 basicService Ext-BasicServiceCode OPTIONAL, +1843 ss-Status [4] Ext-SS-Status, +1844 forwardedToNumber [5] ISDN-AddressString OPTIONAL, +1845 -- When this data type is sent from an HLR which supports CAMEL Phase 2 +1846 -- to a VLR that supports CAMEL Phase 2 the VLR shall not check the +1847 -- format of the number +1848 forwardedToSubaddress [8] ISDN-SubaddressString OPTIONAL, +1849 forwardingOptions [6] Ext-ForwOptions OPTIONAL, +1850 noReplyConditionTime [7] Ext-NoRepCondTime OPTIONAL, +1851 extensionContainer [9] ExtensionContainer OPTIONAL, +1852 ..., +1853 longForwardedToNumber [10] FTN-AddressString OPTIONAL } +1854 +1855 Ext-ForwOptions ::= OCTET STRING (SIZE (1..5)) +1856 +1857 -- OCTET 1: +1858 +1859 -- bit 8: notification to forwarding party +1860 -- 0 no notification +1861 -- 1 notification +1862 +1863 -- bit 7: redirecting presentation +1864 -- 0 no presentation +1865 -- 1 presentation +1866 +1867 -- bit 6: notification to calling party +1868 -- 0 no notification +1869 -- 1 notification +1870 +1871 -- bit 5: 0 (unused) +1872 +1873 -- bits 43: forwarding reason +1874 -- 00 ms not reachable +1875 -- 01 ms busy +1876 -- 10 no reply +1877 -- 11 unconditional +1878 +1879 -- bits 21: 00 (unused) +1880 +1881 -- OCTETS 2-5: reserved for future use. They shall be discarded if +1882 -- received and not understood. +1883 +1884 Ext-NoRepCondTime ::= INTEGER (1..100) +1885 -- Only values 5-30 are used. +1886 -- Values in the ranges 1-4 and 31-100 are reserved for future use +1887 -- If received: +1888 -- values 1-4 shall be mapped on to value 5 +1889 -- values 31-100 shall be mapped on to value 30 +1890 +1891 Ext-CallBarInfo ::= SEQUENCE { +1892 ss-Code SS-Code, +1893 callBarringFeatureList Ext-CallBarFeatureList, +1894 extensionContainer ExtensionContainer OPTIONAL, +1895 ...} +1896 +1897 Ext-CallBarFeatureList ::= SEQUENCE SIZE (1..maxNumOfExt-BasicServiceGroups) OF +1898 Ext-CallBarringFeature +1899 +1900 Ext-CallBarringFeature ::= SEQUENCE { +1901 basicService Ext-BasicServiceCode OPTIONAL, +1902 ss-Status [4] Ext-SS-Status, +1903 extensionContainer ExtensionContainer OPTIONAL, +1904 ...} +1905 +1906 CUG-Info ::= SEQUENCE { +1907 cug-SubscriptionList CUG-SubscriptionList, +1908 cug-FeatureList CUG-FeatureList OPTIONAL, +1909 extensionContainer [0] ExtensionContainer OPTIONAL, +1910 ...} +1911 +1912 CUG-SubscriptionList ::= SEQUENCE SIZE (0..maxNumOfCUG) OF +1913 CUG-Subscription +1914 + +``` + +``` + +1915 CUG-Subscription ::= SEQUENCE { +1916 cug-Index CUG-Index, +1917 CUG-Interlock, +1918 intraCUG-Options IntraCUG-Options, +1919 basicServiceGroupList Ext-BasicServiceGroupList OPTIONAL, +1920 extensionContainer [0] ExtensionContainer OPTIONAL, +1921 ...} +1922 +1923 CUG-Index ::= INTEGER (0..32767) +1924 -- The internal structure is defined in ETS 300 138. +1925 +1926 CUG-Interlock ::= OCTET STRING (SIZE (4)) +1927 +1928 IntraCUG-Options ::= ENUMERATED { +1929 noCUG-Restrictions (0), +1930 cugIC-CallBarred (1), +1931 cugOG-CallBarred (2) } +1932 +1933 maxNumOfCUG INTEGER ::= 10 +1934 +1935 CUG-FeatureList ::= SEQUENCE SIZE (1..maxNumOfExt-BasicServiceGroups) OF +1936 CUG-Feature +1937 +1938 Ext-BasicServiceGroupList ::= SEQUENCE SIZE (1..maxNumOfExt-BasicServiceGroups) OF +1939 Ext-BasicServiceCode +1940 +1941 maxNumOfExt-BasicServiceGroups INTEGER ::= 32 +1942 +1943 CUG-Feature ::= SEQUENCE { +1944 basicService Ext-BasicServiceCode OPTIONAL, +1945 preferentialCUG-Indicator CUG-Index OPTIONAL, +1946 interCUG-Restrictions InterCUG-Restrictions, +1947 extensionContainer ExtensionContainer OPTIONAL, +1948 ...} +1949 +1950 InterCUG-Restrictions ::= OCTET STRING (SIZE (1)) +1951 +1952 -- bits 876543: 000000 (unused) +1953 -- Exception handling: +1954 -- bits 876543 shall be ignored if received and not understood +1955 +1956 -- bits 21 +1957 -- 00 CUG only facilities +1958 -- 01 CUG with outgoing access +1959 -- 10 CUG with incoming access +1960 -- 11 CUG with both outgoing and incoming access +1961 +1962 Ext-SS-Data ::= SEQUENCE { +1963 ss-Code SS-Code, +1964 ss-Status [4] Ext-SS-Status, +1965 ss-SubscriptionOption SS-SubscriptionOption OPTIONAL, +1966 basicServiceGroupList Ext-BasicServiceGroupList OPTIONAL, +1967 extensionContainer [5] ExtensionContainer OPTIONAL, +1968 ...} +1969 +1970 LCS-PrivacyExceptionList ::= SEQUENCE SIZE (1..maxNumOfPrivacyClass) OF +1971 LCS-PrivacyClass +1972 +1973 maxNumOfPrivacyClass INTEGER ::= 4 + +``` + +``` + +1974 +1975 LCS-PrivacyClass ::= SEQUENCE { +1976 ss-Code SS-Code, +1977 ss-Status Ext-SS-Status, +1978 notificationToMSUser [0] NotificationToMSUser OPTIONAL, +1979 -- notificationToMSUser may be sent only for SS-codes callSessionRelated +1980 -- and callSessionUnrelated. If not received for SS-codes callSessionRelated +1981 -- and callSessionUnrelated, +1982 -- the default values according to 3GPP TS 23.271 shall be assumed. +1983 externalClientList [1] ExternalClientList OPTIONAL, +1984 -- externalClientList may be sent only for SS-code callSessionUnrelated to a +1985 -- visited node that does not support LCS Release 4 or later versions. +1986 -- externalClientList may be sent only for SS-codes callSessionUnrelated and +1987 -- callSessionRelated to a visited node that supports LCS Release 4 or later versions. +1988 plmnClientList [2] PLMNClientList OPTIONAL, +1989 -- plmnClientList may be sent only for SS-code plmnoperator. +1990 extensionContainer [3] ExtensionContainer OPTIONAL, +1991 ..., +1992 ext-externalClientList [4] Ext-ExternalClientList OPTIONAL, +1993 -- Ext-externalClientList may be sent only if the visited node supports LCS Release 4 or +1994 -- later versions, the user did specify more than 5 clients, and White Book SCCP is used. +1995 serviceTypeList [5] ServiceTypeList OPTIONAL +1996 -- serviceTypeList may be sent only for SS-code serviceType and if the visited node +1997 -- supports LCS Release 5 or later versions. +1998 -- +1999 -- if segmentation is used, the complete LCS-PrivacyClass shall be sent in one segment +2000 } +2001 +2002 ExternalClientList ::= SEQUENCE SIZE (0..maxNumOfExternalClient) OF +2003 ExternalClient +2004 +2005 maxNumOfExternalClient INTEGER ::= 5 +2006 +2007 PLMNClientList ::= SEQUENCE SIZE (1..maxNumOfPLMNClient) OF +2008 LCSCClientInternalID +2009 +2010 maxNumOfPLMNClient INTEGER ::= 5 +2011 +2012 Ext-ExternalClientList ::= SEQUENCE SIZE (1..maxNumOfExt-ExternalClient) OF +2013 ExternalClient +2014 +2015 maxNumOfExt-ExternalClient INTEGER ::= 35 +2016 +2017 ExternalClient ::= SEQUENCE { +2018 clientIdentity LCSCClientExternalID, +2019 gmlc-Restriction [0] GMLC-Restriction OPTIONAL, +2020 notificationToMSUser [1] NotificationToMSUser OPTIONAL, +2021 -- If notificationToMSUser is not received, the default value according to +2022 -- 3GPP TS 23.271 shall be assumed. +2023 extensionContainer [2] ExtensionContainer OPTIONAL, +2024 ... } +2025 +2026 GMLC-Restriction ::= ENUMERATED { +2027 gmlc-List (0), +2028 home-Country (1) , +2029 ... } +2030 -- exception handling: +2031 -- At reception of any other value than the ones listed the receiver shall ignore +2032 -- GMLC-Restriction. +2033 +2034 NotificationToMSUser ::= ENUMERATED { +2035 notifyLocationAllowed (0), +2036 notifyAndVerify-LocationAllowedIfNoResponse (1), +2037 notifyAndVerify-LocationNotAllowedIfNoResponse (2), +2038 ..., +2039 locationNotAllowed (3) } +2040 -- exception handling: +2041 -- At reception of any other value than the ones listed the receiver shall ignore +2042 -- NotificationToMSUser. +2043 +2044 ServiceTypeList ::= SEQUENCE SIZE (1..maxNumOfServiceType) OF +2045 ServiceType +2046 +2047 maxNumOfServiceType INTEGER ::= 32 +2048 + +``` + +``` + +2049 ServiceType ::= SEQUENCE { +2050 serviceTypeIdentity LCSServiceTypeID, +2051 gmlc-Restriction [0] GMLC-Restriction OPTIONAL, +2052 notificationToMSUser [1] NotificationToMSUser OPTIONAL, +2053 -- If notificationToMSUser is not received, the default value according to +2054 -- 3GPP TS 23.271 shall be assumed. +2055 extensionContainer [2] ExtensionContainer OPTIONAL, +2056 ... } +2057 +2058 MOLR-List ::= SEQUENCE SIZE (1..maxNumOfMOLR-Class) OF +2059 MOLR-Class +2060 +2061 maxNumOfMOLR-Class INTEGER ::= 3 +2062 +2063 MOLR-Class ::= SEQUENCE { +2064 ss-Code SS-Code, +2065 ss-Status Ext-SS-Status, +2066 extensionContainer [0] ExtensionContainer OPTIONAL, +2067 ... } +2068 +2069 ZoneCodeList ::= SEQUENCE SIZE (1..maxNumOfZoneCodes) +2070 OF ZoneCode +2071 +2072 ZoneCode ::= OCTET STRING (SIZE (2)) +2073 -- internal structure is defined in TS 3GPP TS 23.003 [17] +2074 +2075 maxNumOfZoneCodes INTEGER ::= 10 +2076 +2077 InsertSubscriberDataRes ::= SEQUENCE { +2078 teleserviceList [1] TeleserviceList OPTIONAL, +2079 bearerServiceList [2] BearerServiceList OPTIONAL, +2080 ss-List [3] SS-List OPTIONAL, +2081 odb-GeneralData [4] ODB-GeneralData OPTIONAL, +2082 regionalSubscriptionResponse [5] RegionalSubscriptionResponse OPTIONAL, +2083 supportedCamelPhases [6] SupportedCamelPhases OPTIONAL, +2084 extensionContainer [7] ExtensionContainer OPTIONAL, +2085 ... , +2086 offeredCamel4CSIs [8] OfferedCamel4CSIs OPTIONAL, +2087 supportedFeatures [9] SupportedFeatures OPTIONAL, +2088 ext-SupportedFeatures [10] Ext-SupportedFeatures OPTIONAL } +2089 +2090 RegionalSubscriptionResponse ::= ENUMERATED { +2091 networkNode-AreaRestricted (0), +2092 tooManyZoneCodes (1), +2093 zoneCodesConflict (2), +2094 regionalSubscNotSupported (3) } +2095 +2096 DeleteSubscriberDataArg ::= SEQUENCE { +2097 imsi [0] IMSI, +2098 basicServiceList [1] BasicServiceList OPTIONAL, +2099 -- The exception handling for reception of unsupported/not allocated +2100 -- basicServiceCodes is defined in clause 6.8.2 +2101 ss-List [2] SS-List OPTIONAL, +2102 roamingRestrictionDueToUnsupportedFeature [4] NULL OPTIONAL, +2103 regionalSubscriptionIdentifier [5] ZoneCode OPTIONAL, +2104 vbsGroupIndication [7] NULL OPTIONAL, +2105 vgcsGroupIndication [8] NULL OPTIONAL, +2106 camelSubscriptionInfoWithdraw [9] NULL OPTIONAL, +2107 extensionContainer [6] ExtensionContainer OPTIONAL, +2108 ..., +2109 gprsSubscriptionDataWithdraw [10] GPRSSubscriptionDataWithdraw OPTIONAL, +2110 roamingRestrictedInSgsnDueToUnsupportedFeature [11] NULL OPTIONAL, +2111 lsaInformationWithdraw [12] LSAInformationWithdraw OPTIONAL, +2112 gmlc-ListWithdraw [13] NULL OPTIONAL, +2113 istInformationWithdraw [14] NULL OPTIONAL, +2114 specificCSI-Withdraw [15] SpecificCSI-Withdraw OPTIONAL, +2115 chargingCharacteristicsWithdraw [16] NULL OPTIONAL, +2116 stn-srWithdraw [17] NULL OPTIONAL, +2117 epsSubscriptionDataWithdraw [18] EPS-SubscriptionDataWithdraw OPTIONAL, +2118 apn-oi-replacementWithdraw [19] NULL OPTIONAL, +2119 csg-SubscriptionDeleted [20] NULL OPTIONAL, +2120 subscribedPeriodicTAU-RAU-TimerWithdraw [22] NULL OPTIONAL, +2121 subscribedPeriodicLAU-TimerWithdraw [23] NULL OPTIONAL, +2122 subscribed-vsrvccWithdraw [21] NULL OPTIONAL, +2123 vplmn-Csg-SubscriptionDeleted [24] NULL OPTIONAL, +2124 additionalMSISDN-Withdraw [25] NULL OPTIONAL, +2125 cs-to-ps-SRVCC-Withdraw [26] NULL OPTIONAL, + +``` + +``` + +2126 imsiGroupIdList-Withdraw [27] NULL OPTIONAL, +2127 userPlaneIntegrityProtectionWithdraw [28] NULL OPTIONAL, +2128 dl-Buffering-Suggested-Packet-Count-Withdraw [29] NULL OPTIONAL, +2129 ue-UsageTypeWithdraw [30] NULL OPTIONAL, +2130 reset-idsWithdraw [31] NULL OPTIONAL, +2131 iab-OperationWithdraw [32] NULL OPTIONAL } +2132 +2133 SpecificCSI-Withdraw ::= BIT STRING { +2134 o-csi (0), +2135 ss-csi (1), +2136 tif-csi (2), +2137 d-csi (3), +2138 vt-csi (4), +2139 mo-sms-csi (5), +2140 m-csi (6), +2141 gprs-csi (7), +2142 t-csi (8), +2143 mt-sms-csi (9), +2144 mg-csi (10), +2145 o-IM-CSI (11), +2146 d-IM-CSI (12), +2147 vt-IM-CSI (13) } (SIZE(8..32)) +2148 -- exception handling: +2149 -- bits 11 to 31 shall be ignored if received by a non-IP Multimedia Core Network entity. +2150 -- bits 0-10 and 14-31 shall be ignored if received by an IP Multimedia Core Network entity. +2151 -- bits 11-13 are only applicable in an IP Multimedia Core Network. +2152 -- Bit 8 and bits 11-13 are only applicable for the NoteSubscriberDataModified operation. +2153 +2154 GPRSSubscriptionDataWithdraw ::= CHOICE { +2155 allGPRSData NULL, +2156 contextIdList ContextIdList} +2157 +2158 EPS-SubscriptionDataWithdraw ::= CHOICE { +2159 allEPS-Data NULL, +2160 contextIdList ContextIdList} +2161 +2162 ContextIdList ::= SEQUENCE SIZE (1..maxNumOfPDP-Contexts) OF +2163 ContextId +2164 +2165 LSAInformationWithdraw ::= CHOICE { +2166 allLSAData NULL, +2167 lsaIdentityList LSAIdentityList } +2168 +2169 LSAIdentityList ::= SEQUENCE SIZE (1..maxNumOfLSAs) OF +2170 LSAIdentity +2171 +2172 BasicServiceList ::= SEQUENCE SIZE (1..maxNumOfBasicServices) OF +2173 Ext-BasicServiceCode +2174 +2175 maxNumOfBasicServices INTEGER ::= 70 +2176 +2177 DeleteSubscriberDataRes ::= SEQUENCE { +2178 regionalSubscriptionResponse [0] RegionalSubscriptionResponse OPTIONAL, +2179 extensionContainer [1] ExtensionContainer OPTIONAL, +2180 ...} +2181 +2182 VlrCamelSubscriptionInfo ::= SEQUENCE { +2183 o-CSI [0] O-CSI OPTIONAL, +2184 extensionContainer [1] ExtensionContainer OPTIONAL, +2185 ..., +2186 ss-CSI [2] SS-CSI OPTIONAL, +2187 o-BcsmCamelTDP-CriteriaList [4] O-BcsmCamelTDP-CriteriaList OPTIONAL, +2188 tif-CSI [3] NULL OPTIONAL, +2189 m-CSI [5] M-CSI OPTIONAL, +2190 mo-sms-CSI [6] SMS-CSI OPTIONAL, +2191 vt-CSI [7] T-CSI OPTIONAL, +2192 t-BCSM-CAMEL-TDP-CriteriaList [8] T-BCSM-CAMEL-TDP-CriteriaList OPTIONAL, +2193 d-CSI [9] D-CSI OPTIONAL, +2194 mt-sms-CSI [10] SMS-CSI OPTIONAL, +2195 mt-smsCAMELTDP-CriteriaList [11] MT-smsCAMELTDP-CriteriaList OPTIONAL +2196 } +2197 +2198 MT-smsCAMELTDP-CriteriaList ::= SEQUENCE SIZE (1.. maxNumOfCamelTDPData) OF +2199 MT-smsCAMELTDP-Criteria +2200 + +``` + +``` + +2201 MT-smsCAMELTPD-Criteria ::= SEQUENCE { +2202 sms-TriggerDetectionPoint SMS-TriggerDetectionPoint, +2203 tpdu-TypeCriterion [0] TPDU-TypeCriterion OPTIONAL, +2204 ... } +2205 +2206 TPDU-TypeCriterion ::= SEQUENCE SIZE (1..maxNumOfTPDUTypes) OF +2207 MT-SMS-TPDU-Type +2208 +2209 +2210 maxNumOfTPDUTypes INTEGER ::= 5 +2211 +2212 MT-SMS-TPDU-Type ::= ENUMERATED { +2213 sms-DELIVER (0), +2214 sms-SUBMIT-REPORT (1), +2215 sms-STATUS-REPORT (2), +2216 ... } +2217 +2218 -- exception handling: +2219 -- For TPDU-TypeCriterion sequences containing this parameter with any +2220 -- other value than the ones listed above the receiver shall ignore +2221 -- the whole TPDU-TypeCriterion sequence. +2222 -- In CAMEL phase 4, sms-SUBMIT-REPORT shall not be used and a received TPDU-TypeCriterion +2223 -- sequence containing sms-SUBMIT-REPORT shall be wholly ignored. +2224 +2225 D-CSI ::= SEQUENCE { +2226 dp-AnalysedInfoCriteriaList [0] DP-AnalysedInfoCriteriaList OPTIONAL, +2227 camelCapabilityHandling [1] CamelCapabilityHandling OPTIONAL, +2228 extensionContainer [2] ExtensionContainer OPTIONAL, +2229 notificationToCSE [3] NULL OPTIONAL, +2230 csi-Active [4] NULL OPTIONAL, +2231 ...} +2232 -- notificationToCSE and csi-Active shall not be present when D-CSI is sent to VLR/GMSC. +2233 -- They may only be included in ATSI/ATM ack/NSDC message. +2234 -- DP-AnalysedInfoCriteria and camelCapabilityHandling shall be present in +2235 -- the D-CSI sequence. +2236 -- If D-CSI is segmented, then the first segment shall contain dp-AnalysedInfoCriteriaList +2237 -- and camelCapabilityHandling. Subsequent segments shall not contain +2238 -- camelCapabilityHandling, but may contain dp-AnalysedInfoCriteriaList. +2239 +2240 DP-AnalysedInfoCriteriaList ::= SEQUENCE SIZE (1..maxNumOfDP-AnalysedInfoCriteria) OF +2241 DP-AnalysedInfoCriterium +2242 +2243 maxNumOfDP-AnalysedInfoCriteria INTEGER ::= 10 +2244 +2245 DP-AnalysedInfoCriterium ::= SEQUENCE { +2246 dialledNumber ISDN-AddressString, +2247 serviceKey ServiceKey, +2248 gsmSCF-Address ISDN-AddressString, +2249 defaultCallHandling DefaultCallHandling, +2250 extensionContainer ExtensionContainer OPTIONAL, +2251 ...} +2252 +2253 SS-CSI ::= SEQUENCE { +2254 ss-CamelData SS-CamelData, +2255 extensionContainer ExtensionContainer OPTIONAL, +2256 ..., +2257 notificationToCSE [0] NULL OPTIONAL, +2258 csi-Active [1] NULL OPTIONAL +2259 -- notificationToCSE and csi-Active shall not be present when SS-CSI is sent to VLR. +2260 -- They may only be included in ATSI/ATM ack/NSDC message. +2261 } +2262 +2263 SS-CamelData ::= SEQUENCE { +2264 ss-EventList SS-EventList, +2265 gsmSCF-Address ISDN-AddressString, +2266 extensionContainer [0] ExtensionContainer OPTIONAL, +2267 ...} +2268 +2269 + +``` + +``` + +2269 SS-EventList ::= SEQUENCE SIZE (1..maxNumOfCamelSSEvents) OF SS-Code +2270 -- Actions for the following SS-Code values are defined in CAMEL Phase 3: +2271 -- ect SS-Code ::= '00110001'B +2272 -- multiPTY SS-Code ::= '01010001'B +2273 -- cd SS-Code ::= '00100100'B +2274 -- cobs SS-Code ::= '01000100'B +2275 -- all other SS codes shall be ignored +2276 -- When SS-CSI is sent to the VLR, it shall not contain a marking for cobs. +2277 -- If the VLR receives SS-CSI containing a marking for cobs, the VLR shall discard the +2278 -- cobs marking in SS-CSI. +2279 +2280 maxNumOfCamelSSEvents INTEGER ::= 10 +2281 +2282 O-CSI ::= SEQUENCE { +2283 o-BcsmCamelTDPDataList O-BcsmCamelTDPDataList, +2284 extensionContainer ExtensionContainer OPTIONAL, +2285 ..., +2286 camelCapabilityHandling [0] CamelCapabilityHandling OPTIONAL, +2287 notificationToCSE [1] NULL OPTIONAL, +2288 csiActive [2] NULL OPTIONAL} +2289 -- notificationToCSE and csiActive shall not be present when O-CSI is sent to VLR/GMSC. +2290 -- They may only be included in ATSI/ATM ack/NSDC message. +2291 -- O-CSI shall not be segmented. +2292 +2293 O-BcsmCamelTDPDataList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +2294 O-BcsmCamelTDPData +2295 -- O-BcsmCamelTDPDataList shall not contain more than one instance of +2296 -- O-BcsmCamelTDPData containing the same value for o-BcsmTriggerDetectionPoint. +2297 -- For CAMEL Phase 2, this means that only one instance of O-BcsmCamelTDPData is allowed +2298 -- with o-BcsmTriggerDetectionPoint being equal to DP2. +2299 +2300 maxNumOfCamelTDPData INTEGER ::= 10 +2301 +2302 O-BcsmCamelTDPData ::= SEQUENCE { +2303 o-BcsmTriggerDetectionPoint O-BcsmTriggerDetectionPoint, +2304 serviceKey ServiceKey, +2305 gsmSCF-Address [0] ISDN-AddressString, +2306 defaultCallHandling [1] DefaultCallHandling, +2307 extensionContainer [2] ExtensionContainer OPTIONAL, +2308 ... +2309 } +2310 +2311 ServiceKey ::= INTEGER (0..2147483647) +2312 +2313 O-BcsmTriggerDetectionPoint ::= ENUMERATED { +2314 collectedInfo (2), +2315 ..., +2316 routeSelectFailure (4) } +2317 -- exception handling: +2318 -- For O-BcsmCamelTDPData sequences containing this parameter with any +2319 -- other value than the ones listed the receiver shall ignore the whole +2320 -- O-BcsmCamelTDPData sequence. +2321 -- For O-BcsmCamelTDP-Criteria sequences containing this parameter with any +2322 -- other value than the ones listed the receiver shall ignore the whole +2323 -- O-BcsmCamelTDP-Criteria sequence. +2324 +2325 O-BcsmCamelTDPCriteriaList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +2326 O-BcsmCamelTDP-Criteria +2327 +2328 T-BCSM-CAMEL-TDP-CriteriaList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +2329 T-BCSM-CAMEL-TDP-Criteria +2330 +2331 O-BcsmCamelTDP-Criteria ::= SEQUENCE { +2332 o-BcsmTriggerDetectionPoint O-BcsmTriggerDetectionPoint, +2333 destinationNumberCriteria [0] DestinationNumberCriteria OPTIONAL, +2334 basicServiceCriteria [1] BasicServiceCriteria OPTIONAL, +2335 callTypeCriteria [2] CallTypeCriteria OPTIONAL, +2336 ..., +2337 o-CauseValueCriteria [3] O-CauseValueCriteria OPTIONAL, +2338 extensionContainer [4] ExtensionContainer OPTIONAL } +2339 +2340 T-BCSM-CAMEL-TDP-Criteria ::= SEQUENCE { +2341 t-BCSM-TriggerDetectionPoint T-BcsmTriggerDetectionPoint, +2342 basicServiceCriteria [0] BasicServiceCriteria OPTIONAL, +2343 t-CauseValueCriteria [1] T-CauseValueCriteria OPTIONAL, +2344 ... } +2345 + +``` + +``` + +2346 DestinationNumberCriteria ::= SEQUENCE { +2347 matchType [0] MatchType, +2348 destinationNumberList [1] DestinationNumberList OPTIONAL, +2349 destinationNumberLengthList [2] DestinationNumberLengthList OPTIONAL, +2350 -- one or both of destinationNumberList and destinationNumberLengthList +2351 -- shall be present +2352 ...} +2353 +2354 DestinationNumberList ::= SEQUENCE SIZE (1..maxNumOfCamelDestinationNumbers) OF +2355 ISDN-AddressString +2356 -- The receiving entity shall not check the format of a number in +2357 -- the dialled number list +2358 +2359 DestinationNumberLengthList ::= SEQUENCE SIZE (1..maxNumOfCamelDestinationNumberLengths) OF +2360 +2361 INTEGER(1..maxNumOfISDN-AddressDigits) +2362 +2363 BasicServiceCriteria ::= SEQUENCE SIZE(1..maxNumOfCamelBasicServiceCriteria) OF +2364 Ext-BasicServiceCode +2365 +2366 maxNumOfISDN-AddressDigits INTEGER ::= 15 +2367 +2368 maxNumOfCamelDestinationNumbers INTEGER ::= 10 +2369 +2370 maxNumOfCamelDestinationNumberLengths INTEGER ::= 3 +2371 +2372 maxNumOfCamelBasicServiceCriteria INTEGER ::= 5 +2373 +2374 CallTypeCriteria ::= ENUMERATED { +2375 forwarded (0), +2376 notForwarded (1)} +2377 +2378 MatchType ::= ENUMERATED { +2379 inhibiting (0), +2380 enabling (1)} +2381 +2382 O-CauseValueCriteria ::= SEQUENCE SIZE(1..maxNumOfCAMEL-O-CauseValueCriteria) OF +2383 CauseValue +2384 +2385 T-CauseValueCriteria ::= SEQUENCE SIZE(1..maxNumOfCAMEL-T-CauseValueCriteria) OF +2386 CauseValue +2387 +2388 maxNumOfCAMEL-O-CauseValueCriteria INTEGER ::= 5 +2389 +2390 maxNumOfCAMEL-T-CauseValueCriteria INTEGER ::= 5 +2391 +2392 CauseValue ::= OCTET STRING (SIZE(1)) +2393 -- Type extracted from Cause parameter in ITU-T Recommendation Q.763. +2394 -- For the use of cause value refer to ITU-T Recommendation Q.850. +2395 +2396 DefaultCallHandling ::= ENUMERATED { +2397 continueCall (0) , +2398 releaseCall (1) , +2399 ...} +2400 -- exception handling: +2401 -- reception of values in range 2-31 shall be treated as "continueCall" +2402 -- reception of values greater than 31 shall be treated as "releaseCall" +2403 +2404 CamelCapabilityHandling ::= INTEGER(1..16) +2405 -- value 1 = CAMEL phase 1, +2406 -- value 2 = CAMEL phase 2, +2407 -- value 3 = CAMEL Phase 3, +2408 -- value 4 = CAMEL phase 4: +2409 -- reception of values greater than 4 shall be treated as CAMEL phase 4. +2410 +2411 SupportedCamelPhases ::= BIT STRING { +2412 phase1 (0), +2413 phase2 (1), +2414 phase3 (2), +2415 phase4 (3)} (SIZE (1..16)) +2416 -- A node shall mark in the BIT STRING all CAMEL Phases it supports. +2417 -- Other values than listed above shall be discarded. +2418 + +``` + +``` + +2419 OfferedCamel4CSIs ::= BIT STRING { +2420 o-csi (0), +2421 d-csi (1), +2422 vt-csi (2), +2423 t-csi (3), +2424 mt-sms-csi (4), +2425 mg-csi (5), +2426 psi-enhancements (6) +2427 } (SIZE (7..16)) +2428 -- A node supporting Camel phase 4 shall mark in the BIT STRING all Camel4 CSIs +2429 -- it offers. +2430 -- Other values than listed above shall be discarded. +2431 +2432 OfferedCamel4Functionalities ::= BIT STRING { +2433 initiateCallAttempt (0), +2434 splitLeg (1), +2435 moveLeg (2), +2436 disconnectLeg (3), +2437 entityReleased (4), +2438 dfc-WithArgument (5), +2439 playTone (6), +2440 dtmf-MidCall (7), +2441 chargingIndicator (8), +2442 alertingDP (9), +2443 locationAtAlerting (10), +2444 changeOfPositionDP (11), +2445 or-Interactions (12), +2446 warningToneEnhancements (13), +2447 cf-Enhancements (14), +2448 subscribedEnhancedDialledServices (15), +2449 servingNetworkEnhancedDialledServices (16), +2450 criteriaForChangeOfPositionDP (17), +2451 serviceChangeDP (18), +2452 collectInformation (19) +2453 } (SIZE (15..64)) +2454 -- A node supporting Camel phase 4 shall mark in the BIT STRING all CAMEL4 +2455 -- functionalities it offers. +2456 -- Other values than listed above shall be discarded. +2457 +2458 SMS-CSI ::= SEQUENCE { +2459 sms-CAMEL-TDP-DataList [0] SMS-CAMEL-TDP-DataList OPTIONAL, +2460 camelCapabilityHandling [1] CamelCapabilityHandling OPTIONAL, +2461 extensionContainer [2] ExtensionContainer OPTIONAL, +2462 notificationToCSE [3] NULL OPTIONAL, +2463 csi-Active [4] NULL OPTIONAL, +2464 ...} +2465 -- notificationToCSE and csi-Active shall not be present +2466 -- when MO-SMS-CSI or MT-SMS-CSI is sent to VLR or SGSN. +2467 -- They may only be included in ATSI/ATM ack/NSDC message. +2468 -- SMS-CAMEL-TDP-Data and camelCapabilityHandling shall be present in +2469 -- the SMS-CSI sequence. +2470 -- If SMS-CSI is segmented, sms-CAMEL-TDP-DataList and camelCapabilityHandling shall be +2471 -- present in the first segment +2472 +2473 SMS-CAMEL-TDP-DataList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +2474 SMS-CAMEL-TDP-Data +2475 -- SMS-CAMEL-TDP-DataList shall not contain more than one instance of +2476 -- SMS-CAMEL-TDP-Data containing the same value for sms-TriggerDetectionPoint. +2477 +2478 SMS-CAMEL-TDP-Data ::= SEQUENCE { +2479 sms-TriggerDetectionPoint [0] SMS-TriggerDetectionPoint, +2480 serviceKey [1] ServiceKey, +2481 gsmSCF-Address [2] ISDN-AddressString, +2482 defaultSMS-Handling [3] DefaultSMS-Handling, +2483 extensionContainer [4] ExtensionContainer OPTIONAL, +2484 ... +2485 } +2486 + +``` + +``` + +2487 SMS-TriggerDetectionPoint ::= ENUMERATED { +2488 sms-CollectedInfo (1), +2489 ..., +2490 sms-DeliveryRequest (2) +2491 } +2492 -- exception handling: +2493 -- For SMS-CAMEL-TDP-Data and MT-smsCAMELTDP-Criteria sequences containing this +2494 -- parameter with any other value than the ones listed the receiver shall ignore +2495 -- the whole sequence. +2496 -- +2497 -- If this parameter is received with any other value than sms-CollectedInfo +2498 -- in an SMS-CAMEL-TDP-Data sequence contained in mo-sms-CSI, then the receiver shall +2499 -- ignore the whole SMS-CAMEL-TDP-Data sequence. +2500 -- +2501 -- If this parameter is received with any other value than sms-DeliveryRequest +2502 -- in an SMS-CAMEL-TDP-Data sequence contained in mt-sms-CSI then the receiver shall +2503 -- ignore the whole SMS-CAMEL-TDP-Data sequence. +2504 -- +2505 -- If this parameter is received with any other value than sms-DeliveryRequest +2506 -- in an MT-smsCAMELTDP-Criteria sequence then the receiver shall +2507 -- ignore the whole MT-smsCAMELTDP-Criteria sequence. +2508 +2509 DefaultSMS-Handling ::= ENUMERATED { +2510 continueTransaction (0) , +2511 releaseTransaction (1) , +2512 ...} +2513 -- exception handling: +2514 -- reception of values in range 2-31 shall be treated as "continueTransaction" +2515 -- reception of values greater than 31 shall be treated as "releaseTransaction" +2516 +2517 M-CSI ::= SEQUENCE { +2518 mobilityTriggers MobilityTriggers, +2519 serviceKey ServiceKey, +2520 gsmSCF-Address [0] ISDN-AddressString, +2521 extensionContainer [1] ExtensionContainer OPTIONAL, +2522 notificationToCSE [2] NULL OPTIONAL, +2523 csi-Active [3] NULL OPTIONAL, +2524 ...} +2525 -- notificationToCSE and csi-Active shall not be present when M-CSI is sent to VLR. +2526 -- They may only be included in ATSI/ATM ack/NSDC message. +2527 +2528 MG-CSI ::= SEQUENCE { +2529 mobilityTriggers MobilityTriggers, +2530 serviceKey ServiceKey, +2531 gsmSCF-Address [0] ISDN-AddressString, +2532 extensionContainer [1] ExtensionContainer OPTIONAL, +2533 notificationToCSE [2] NULL OPTIONAL, +2534 csi-Active [3] NULL OPTIONAL, +2535 ...} +2536 -- notificationToCSE and csi-Active shall not be present when MG-CSI is sent to SGSN. +2537 -- They may only be included in ATSI/ATM ack/NSDC message. +2538 +2539 MobilityTriggers ::= SEQUENCE SIZE (1..maxNumOfMobilityTriggers) OF +2540 MM-Code +2541 +2542 maxNumOfMobilityTriggers INTEGER ::= 10 +2543 + +``` + +``` + +2544 MM-Code ::= OCTET STRING (SIZE (1)) +2545 -- This type is used to indicate a Mobility Management event. +2546 -- Actions for the following MM-Code values are defined in CAMEL Phase 4: +2547 -- +2548 -- CS domain MM events: +2549 -- Location-update-in-same-VLR MM-Code ::= '00000000'B +2550 -- Location-update-to-other-VLR MM-Code ::= '00000001'B +2551 -- IMSI-Attach MM-Code ::= '00000010'B +2552 -- MS-initiated-IMSI-Detach MM-Code ::= '00000011'B +2553 -- Network-initiated-IMSI-Detach MM-Code ::= '00000100'B +2554 -- +2555 -- PS domain MM events: +2556 -- Routeing-Area-update-in-same-SGSN MM-Code ::= '10000000'B +2557 -- Routeing-Area-update-to-other-SGSN-update-from-new-SGSN +2558 -- MM-Code ::= '10000001'B +2559 -- Routeing-Area-update-to-other-SGSN-disconnect-by-detach +2560 -- MM-Code ::= '10000010'B +2561 -- GPRS-Attach MM-Code ::= '10000011'B +2562 -- MS-initiated-GPRS-Detach MM-Code ::= '10000100'B +2563 -- Network-initiated-GPRS-Detach MM-Code ::= '10000101'B +2564 -- Network-initiated-transfer-to-MS-not-reachable-for-paging +2565 -- MM-Code ::= '10000110'B +2566 -- +2567 -- If the MSC receives any other MM-code than the ones listed above for the +2568 -- CS domain, then the MSC shall ignore that MM-code. +2569 -- If the SGSN receives any other MM-code than the ones listed above for the +2570 -- PS domain, then the SGSN shall ignore that MM-code. +2571 +2572 T-CSI ::= SEQUENCE { +2573 t-BcsmCamelTDPDataList T-BcsmCamelTDPDataList, +2574 extensionContainer ExtensionContainer OPTIONAL, +2575 ..., +2576 camelCapabilityHandling [0] CamelCapabilityHandling OPTIONAL, +2577 notificationToCSE [1] NULL OPTIONAL, +2578 csi-Active [2] NULL OPTIONAL} +2579 -- notificationToCSE and csi-Active shall not be present when VT-CSI/T-CSI is sent +2580 -- to VLR/GMSC. +2581 -- They may only be included in ATSI/ATM ack/NSDC message. +2582 -- T-CSI shall not be segmented. +2583 +2584 T-BcsmCamelTDPDataList ::= SEQUENCE SIZE (1..maxNumOfCamelTDPData) OF +2585 T-BcsmCamelTDPData +2586 --- T-BcsmCamelTDPDataList shall not contain more than one instance of +2587 --- T-BcsmCamelTDPData containing the same value for t-BcsmTriggerDetectionPoint. +2588 --- For CAMEL Phase 2, this means that only one instance of T-BcsmCamelTDPData is +2589 allowed +2590 --- with t-BcsmTriggerDetectionPoint being equal to DP12. +2591 --- For CAMEL Phase 3, more TDP's are allowed. +2592 +2593 T-BcsmCamelTDPData ::= SEQUENCE { +2594 t-BcsmTriggerDetectionPoint T-BcsmTriggerDetectionPoint, +2595 serviceKey ServiceKey, +2596 gsmSCF-Address [0] ISDN-AddressString, +2597 defaultCallHandling [1] DefaultCallHandling, +2598 extensionContainer [2] ExtensionContainer OPTIONAL, +2599 ...} +2600 +2601 T-BcsmTriggerDetectionPoint ::= ENUMERATED { +2602 termAttemptAuthorized (12), +2603 ... , +2604 tBusy (13), +2605 tNoAnswer (14)} +2606 -- exception handling: +2607 -- For T-BcsmCamelTDPData sequences containing this parameter with any other +2608 -- value than the ones listed above, the receiver shall ignore the whole +2609 -- T-BcsmCamelTDPData sequence. +2610 +2611 -- gprs location information retrieval types +2612 +2613 SendRoutingInfoForGprsArg ::= SEQUENCE { +2614 imsi [0] IMSI, +2615 ggsn-Address [1] GSN-Address OPTIONAL, +2616 ggsn-Number [2] ISDN-AddressString, +2617 extensionContainer [3] ExtensionContainer OPTIONAL, +2618 ...} +2619 + +``` + +``` + +2620 SendRoutingInfoForGprsRes ::= SEQUENCE { +2621 sgsn-Address [0] GSN-Address, +2622 ggsn-Address [1] GSN-Address OPTIONAL, +2623 mobileNotReachableReason [2] AbsentSubscriberDiagnosticSM OPTIONAL, +2624 extensionContainer [3] ExtensionContainer OPTIONAL, +2625 ...} +2626 +2627 -- failure report types +2628 +2629 FailureReportArg ::= SEQUENCE { +2630 imsi [0] IMSI, +2631 ggsn-Number [1] ISDN-AddressString , +2632 ggsn-Address [2] GSN-Address OPTIONAL, +2633 extensionContainer [3] ExtensionContainer OPTIONAL, +2634 ...} +2635 +2636 FailureReportRes ::= SEQUENCE { +2637 ggsn-Address [0] GSN-Address OPTIONAL, +2638 extensionContainer [1] ExtensionContainer OPTIONAL, +2639 ...} +2640 +2641 -- gprs notification types +2642 +2643 NoteMsPresentForGprsArg ::= SEQUENCE { +2644 imsi [0] IMSI, +2645 sgsn-Address [1] GSN-Address, +2646 ggsn-Address [2] GSN-Address OPTIONAL, +2647 extensionContainer [3] ExtensionContainer OPTIONAL, +2648 ...} +2649 +2650 NoteMsPresentForGprsRes ::= SEQUENCE { +2651 extensionContainer [0] ExtensionContainer OPTIONAL, +2652 ...} +2653 +2654 -- fault recovery types +2655 +2656 ResetArg ::= SEQUENCE { +2657 sendingNodeNumber SendingNode-Number, +2658 hlr-List HLR-List OPTIONAL, +2659 -- The hlr-List parameter shall only be applicable for a restart of the HSS/HLR. +2660 extensionContainer [0] ExtensionContainer OPTIONAL, +2661 ..., +2662 reset-Id-List [1] Reset-Id-List OPTIONAL, +2663 subscriptionData [2] InsertSubscriberDataArg OPTIONAL, +2664 subscriptionDataDeletion [3] DeleteSubscriberDataArg OPTIONAL} +2665 +2666 SendingNode-Number ::= CHOICE { +2667 hlr-Number ISDN-AddressString, +2668 css-Number [1] ISDN-AddressString} +2669 +2670 RestoreDataArg ::= SEQUENCE { +2671 imsi IMSI, +2672 lmsi LMSI OPTIONAL, +2673 extensionContainer ExtensionContainer OPTIONAL, +2674 ... , +2675 vlr-Capability [6] VLR-Capability OPTIONAL, +2676 restorationIndicator [7] NULL OPTIONAL +2677 } +2678 +2679 RestoreDataRes ::= SEQUENCE { +2680 hlr-Number ISDN-AddressString, +2681 msNotReachable NULL OPTIONAL, +2682 extensionContainer ExtensionContainer OPTIONAL, +2683 ...} +2684 +2685 -- VBS/VGCS types +2686 VBSDataList ::= SEQUENCE SIZE (1..maxNumOfVBSGroupIds) OF +2687 VoiceBroadcastData +2688 +2689 VGCSDataList ::= SEQUENCE SIZE (1..maxNumOfVGCSGroupIds) OF +2690 VoiceGroupCallData +2691 +2692 maxNumOfVBSGroupIds INTEGER ::= 50 +2693 +2694 maxNumOfVGCSGroupIds INTEGER ::= 50 +2695 + +``` + +``` + +2696 VoiceGroupCallData := SEQUENCE { +2697 groupId GroupId, +2698 -- groupId shall be filled with six TBCD fillers (1111) if the longGroupId is present +2699 extensionContainer ExtensionContainer OPTIONAL, +2700 ..., +2701 additionalSubscriptions AdditionalSubscriptions OPTIONAL, +2702 additionalInfo [0] AdditionalInfo OPTIONAL, +2703 longGroupId [1] Long-GroupId OPTIONAL } +2704 +2705 -- VoiceGroupCallData containing a longGroupId shall not be sent to VLRs that did not +2706 -- indicate support of long Group IDs within the Update Location or Restore Data +2707 -- request message +2708 +2709 AdditionalInfo := BIT STRING (SIZE (1..136)) +2710 -- Refers to Additional Info as specified in 3GPP TS 43.068 +2711 +2712 AdditionalSubscriptions := BIT STRING { +2713 privilegedUplinkRequest (0), +2714 emergencyUplinkRequest (1), +2715 emergencyReset (2)} (SIZE (3..8)) +2716 -- Other bits than listed above shall be discarded. +2717 +2718 VoiceBroadcastData := SEQUENCE { +2719 groupId GroupId, +2720 -- groupId shall be filled with six TBCD fillers (1111) if the longGroupId is present +2721 broadcastInitEntitlement NULL OPTIONAL, +2722 extensionContainer ExtensionContainer OPTIONAL, +2723 ..., +2724 longGroupId [0] Long-GroupId OPTIONAL } +2725 +2726 -- VoiceBroadcastData containing a longGroupId shall not be sent to VLRs that did not +2727 -- indicate support of long Group IDs within the Update Location or Restore Data +2728 -- request message +2729 +2730 GroupId := TBCD-STRING (SIZE (3)) +2731 -- When Group-Id is less than six characters in length, the TBCD filler (1111) +2732 -- is used to fill unused half octets. +2733 -- Refers to the Group Identification as specified in 3GPP TS 23.003 +2734 -- and 3GPP TS 43.068/ 43.069 +2735 +2736 Long-GroupId := TBCD-STRING (SIZE (4)) +2737 -- When Long-Group-Id is less than eight characters in length, the TBCD filler (1111) +2738 -- is used to fill unused half octets. +2739 -- Refers to the Group Identification as specified in 3GPP TS 23.003 +2740 -- and 3GPP TS 43.068/ 43.069 +2741 +2742 +2743 -- provide subscriber info types +2744 +2745 ProvideSubscriberInfoArg := SEQUENCE { +2746 imsi [0] IMSI, +2747 lmsi [1] LMSI OPTIONAL, +2748 requestedInfo [2] RequestedInfo, +2749 extensionContainer [3] ExtensionContainer OPTIONAL, +2750 ..., +2751 callPriority [4] EMLPP-Priority OPTIONAL +2752 } +2753 +2754 ProvideSubscriberInfoRes := SEQUENCE { +2755 subscriberInfo SubscriberInfo, +2756 extensionContainer ExtensionContainer OPTIONAL, +2757 ...} +2758 + +``` + +``` + +2759 SubscriberInfo ::= SEQUENCE { +2760 locationInformation [0] LocationInformation OPTIONAL, +2761 subscriberState [1] SubscriberState OPTIONAL, +2762 extensionContainer [2] ExtensionContainer OPTIONAL, +2763 ... , +2764 locationInformationGPRS [3] LocationInformationGPRS OPTIONAL, +2765 ps-SubscriberState [4] PS-SubscriberState OPTIONAL, +2766 imei [5] IMEI OPTIONAL, +2767 ms-Classmark2 [6] MS-Classmark2 OPTIONAL, +2768 gprs-MS-Class [7] GPRSMSClass OPTIONAL, +2769 mnpInfoRes [8] MNPInfoRes OPTIONAL, +2770 imsVoiceOverPS-SessionsIndication [9] IMS-VoiceOverPS-SessionsInd OPTIONAL, +2771 lastUE-ActivityTime [10] Time OPTIONAL, +2772 lastRAT-Type [11] Used-RAT-Type OPTIONAL, +2773 eps-SubscriberState [12] PS-SubscriberState OPTIONAL, +2774 locationInformationEPS [13] LocationInformationEPS OPTIONAL, +2775 timeZone [14] TimeZone OPTIONAL, +2776 daylightSavingTime [15] DaylightSavingTime OPTIONAL, +2777 locationInformation5GS [16] LocationInformation5GS OPTIONAL } +2778 +2779 -- If the HLR receives locationInformation, subscriberState or ms-Classmark2 from an SGSN or +2780 -- MME (via an IWF), it shall discard them. +2781 -- If the HLR receives locationInformationGPRS, ps-SubscriberState, gprs-MS-Class or +2782 -- locationInformationEPS (outside the locationInformation IE) from a VLR, it shall +2783 -- discard them. +2784 -- If the HLR receives parameters which it has not requested, it shall discard them. +2785 -- The locationInformation5GS IE should be absent if UE did not access via 5GS and IM-SSF. +2786 +2787 IMS-VoiceOverPS-SessionsInd ::= ENUMERATED { +2788 imsVoiceOverPS-SessionsNotSupported (0), +2789 imsVoiceOverPS-SessionsSupported (1), +2790 unknown (2) +2791 } +2792 -- "unknown" shall not be used within ProvideSubscriberInfoRes +2793 +2794 TimeZone ::= OCTET STRING (SIZE (2..3)) +2795 -- Refer to the 3GPP TS 29.272 [144] for details. +2796 +2797 DaylightSavingTime ::= ENUMERATED { +2798 noAdjustment (0), +2799 plusOneHourAdjustment (1), +2800 plusTwoHoursAdjustment (2) +2801 } +2802 -- Refer to the 3GPP TS 29.272 [144] for details. +2803 +2804 MNPInfoRes ::= SEQUENCE { +2805 routeingNumber [0] RouteingNumber OPTIONAL, +2806 imsi [1] IMSI OPTIONAL, +2807 msisdn [2] ISDN-AddressString OPTIONAL, +2808 numberPortabilityStatus [3] NumberPortabilityStatus OPTIONAL, +2809 extensionContainer [4] ExtensionContainer OPTIONAL, +2810 ... } +2811 -- The IMSI parameter contains a generic IMSI, i.e. it is not tied necessarily to the +2812 -- Subscriber. MCC and MNC values in this IMSI shall point to the Subscription Network of +2813 -- the Subscriber. See 3GPP TS 23.066 [108]. +2814 +2815 RouteingNumber ::= TBCD-STRING (SIZE (1..5)) +2816 +2817 +2818 NumberPortabilityStatus ::= ENUMERATED { +2819 notKnownToBePorted (0), +2820 ownNumberPortedOut (1), +2821 foreignNumberPortedToForeignNetwork (2), +2822 ... , +2823 ownNumberNotPortedOut (4), +2824 foreignNumberPortedIn (5) +2825 } +2826 -- exception handling: +2827 -- reception of other values than the ones listed the receiver shall ignore the +2828 -- whole NumberPortabilityStatus; +2829 -- ownNumberNotPortedOut or foreignNumberPortedIn may only be included in Any Time +2830 -- Interrogation message. +2831 +2832 MS-Classmark2 ::= OCTET STRING (SIZE (3)) +2833 -- This parameter carries the value part of the MS Classmark 2 IE defined in +2834 -- 3GPP TS 24.008 [35]. +2835 + +``` + +``` + +2836 GPRSMSClass := SEQUENCE { +2837 mSNetworkCapability [0] MSNetworkCapability, +2838 mSRadioAccessCapability [1] MSRadioAccessCapability OPTIONAL +2839 } +2840 +2841 MSNetworkCapability := OCTET STRING (SIZE (1..8)) +2842 -- This parameter carries the value part of the MS Network Capability IE defined in +2843 -- 3GPP TS 24.008 [35]. +2844 +2845 MSRadioAccessCapability := OCTET STRING (SIZE (1..50)) +2846 -- This parameter carries the value part of the MS Radio Access Capability IE defined in +2847 -- 3GPP TS 24.008 [35]. +2848 +2849 RequestedInfo := SEQUENCE { +2850 locationInformation [0] NULL OPTIONAL, +2851 subscriberState [1] NULL OPTIONAL, +2852 extensionContainer [2] ExtensionContainer OPTIONAL, +2853 ..., +2854 currentLocation [3] NULL OPTIONAL, +2855 requestedDomain [4] DomainType OPTIONAL, +2856 imei [6] NULL OPTIONAL, +2857 ms-classmark [5] NULL OPTIONAL, +2858 mnpRequestedInfo [7] NULL OPTIONAL, +2859 locationInformationEPS-Supported [11] NULL OPTIONAL, +2860 t-adsData [8] NULL OPTIONAL, +2861 requestedNodes [9] RequestedNodes OPTIONAL, +2862 servingNodeIndication [10] NULL OPTIONAL, +2863 localTimeZoneRequest [12] NULL OPTIONAL +2864 } +2865 +2866 -- currentLocation and locationInformationEPS-Supported shall be absent if +2867 -- locationInformation is absent +2868 -- t-adsData shall be absent in messages sent to the VLR +2869 -- requestedNodes shall be absent if requestedDomain is "cs-Domain" +2870 -- servingNodeIndication shall be absent if locationInformation is absent; +2871 -- servingNodeIndication shall be absent if current location is present; +2872 -- servingNodeIndication indicates by its presence that only the serving node's +2873 -- address (MME-Name or SGSN-Number or VLR-Number) is requested. +2874 +2875 DomainType := ENUMERATED { +2876 cs-Domain (0), +2877 ps-Domain (1), +2878 ...} +2879 -- exception handling: +2880 -- reception of values > 1 shall be mapped to 'cs-Domain' +2881 +2882 RequestedNodes := BIT STRING { +2883 mme (0), +2884 sgsn (1)} (SIZE (1..8)) +2885 -- Other bits than listed above shall be discarded. +2886 + +``` + +``` + +2887 LocationInformation ::= SEQUENCE { +2888 ageOfLocationInformation AgeOfLocationInformation OPTIONAL, +2889 geographicalInformation [0] GeographicalInformation OPTIONAL, +2890 vlr-number [1] ISDN-AddressString OPTIONAL, +2891 locationNumber [2] LocationNumber OPTIONAL, +2892 cellGlobalIdOrServiceAreaIdOrLAI [3] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, +2893 extensionContainer [4] ExtensionContainer OPTIONAL, +2894 ... , +2895 selectedLSA-Id [5] LSAIdentity OPTIONAL, +2896 msc-Number [6] ISDN-AddressString OPTIONAL, +2897 geodeticInformation [7] GeodeticInformation OPTIONAL, +2898 currentLocationRetrieved [8] NULL OPTIONAL, +2899 sai-Present [9] NULL OPTIONAL, +2900 locationInformationEPS [10] LocationInformationEPS OPTIONAL, +2901 userCSGInformation [11] UserCSGInformation OPTIONAL } +2902 -- sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains +2903 -- a Service Area Identity. +2904 -- currentLocationRetrieved shall be present +2905 -- if the location information were retrieved after a successful paging. +2906 -- if the locationInformationEPS IE is present then the cellGlobalIdOrServiceAreaIdOrLAI IE, +2907 -- the ageOfLocationInformation IE, the geographicalInformation IE, the geodeticInformation IE +2908 -- and the currentLocationRetrieved IE (outside the locationInformationEPS IE) shall be +2909 -- absent. As an exception, both the cellGlobalIdOrServiceAreaIdOrLAI IE including an LAI and +2910 -- the locationInformationEPS IE may be present in a MAP-NOTE-MM-EVENT. +2911 -- UserCSGInformation contains the CSG ID, Access mode, and the CSG Membership Indication in +2912 -- the case the Access mode is Hybrid Mode. +2913 -- The locationInformationEPS IE should be absent if locationInformationEPS-Supported was not +2914 -- received in the RequestedInfo IE. + +``` + +``` + +2915 +2916 LocationInformationEPS ::= SEQUENCE { +2917 e-utranCellGlobalIdentity [0] E-UTRAN-CGI OPTIONAL, +2918 trackingAreaIdentity [1] TA-Id OPTIONAL, +2919 extensionContainer [2] ExtensionContainer OPTIONAL, +2920 geographicalInformation [3] GeographicalInformation OPTIONAL, +2921 geodeticInformation [4] GeodeticInformation OPTIONAL, +2922 currentLocationRetrieved [5] NULL OPTIONAL, +2923 ageOfLocationInformation [6] AgeOfLocationInformation OPTIONAL, +2924 ..., +2925 mme-Name [7] DiameterIdentity OPTIONAL } +2926 -- currentLocationRetrieved shall be present if the location information +2927 -- was retrieved after successful paging. + +``` + +``` + +2928 +2929 +2930 LocationInformationGPRS ::= SEQUENCE { +2931 cellGlobalIdOrServiceAreaIdOrLAI [0] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, +2932 routeingAreaIdentity [1] RAIdentity OPTIONAL, +2933 geographicalInformation [2] GeographicalInformation OPTIONAL, +2934 sgsn-Number [3] ISDN-AddressString OPTIONAL, +2935 selectedLSAIdentity [4] LSAIdentity OPTIONAL, +2936 extensionContainer [5] ExtensionContainer OPTIONAL, +2937 ..., +2938 sai-Present [6] NULL OPTIONAL, +2939 geodeticInformation [7] GeodeticInformation OPTIONAL, +2940 currentLocationRetrieved [8] NULL OPTIONAL, +2941 ageOfLocationInformation [9] AgeOfLocationInformation OPTIONAL, +2942 userCSGInformation [10] UserCSGInformation OPTIONAL } +2943 -- sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains +2944 -- a Service Area Identity. +2945 -- currentLocationRetrieved shall be present if the location information +2946 -- was retrieved after successful paging. +2947 -- UserCSGInformation contains the CSG ID, Access mode, and the CSG Membership Indication in +2948 -- the case the Access mode is Hybrid Mode. + +``` + +``` + +2949 +2950 + +``` + +``` + +2951 LocationInformation5GS ::= SEQUENCE { +2952 nrCellGlobalIdentity [0] NR-CGI OPTIONAL, +2953 e-utranCellGlobalIdentity [1] E-UTRAN-CGI OPTIONAL, +2954 geographicalInformation [2] GeographicalInformation OPTIONAL, +2955 geodeticInformation [3] GeodeticInformation OPTIONAL, +2956 amf-address [4] FQDN OPTIONAL, +2957 trackingAreaIdentity [5] TA-Id OPTIONAL, +2958 currentLocationRetrieved [6] NULL OPTIONAL, +2959 ageOfLocationInformation [7] AgeOfLocationInformation OPTIONAL, +2960 vplmnId [8] PLMN-Id OPTIONAL, +2961 localTimeZone [9] TimeZone OPTIONAL, +2962 rat-Type [10] Used-RAT-Type OPTIONAL, +2963 extensionContainer [11] ExtensionContainer OPTIONAL, +2964 ..., +2965 nrTrackingAreaIdentity [12] NR-TA-Id OPTIONAL +2966 } +2967 -- currentLocationRetrieved shall be present if the location information +2968 -- was retrieved after successful paging. +2969 +2970 +2971 UserCSGInformation ::= SEQUENCE { +2972 csg-Id [0] CSG-Id, +2973 extensionContainer [1] ExtensionContainer OPTIONAL, +2974 ..., +2975 accessMode [2] OCTET STRING (SIZE(1)) OPTIONAL, +2976 cmi [3] OCTET STRING (SIZE(1)) OPTIONAL } +2977 -- The encoding of the accessMode and cmi parameters are as defined in 3GPP TS 29.060 [105]. +2978 +2979 GeographicalInformation ::= OCTET STRING (SIZE (8)) +2980 -- Refers to geographical Information defined in 3GPP TS 23.032. +2981 -- Only the description of an ellipsoid point with uncertainty circle +2982 -- as specified in 3GPP TS 23.032 is allowed to be used +2983 -- The internal structure according to 3GPP TS 23.032 is as follows: +2984 -- Type of shape (ellipsoid point with uncertainty circle) 1 octet +2985 -- Degrees of Latitude 3 octets +2986 -- Degrees of Longitude 3 octets +2987 -- Uncertainty code 1 octet +2988 +2989 GeodeticInformation ::= OCTET STRING (SIZE (10)) +2990 -- Refers to Calling Geodetic Location defined in Q.763 (1999). +2991 -- Only the description of an ellipsoid point with uncertainty circle +2992 -- as specified in Q.763 (1999) is allowed to be used +2993 -- The internal structure according to Q.763 (1999) is as follows: +2994 -- Screening and presentation indicators 1 octet +2995 -- Type of shape (ellipsoid point with uncertainty circle) 1 octet +2996 -- Degrees of Latitude 3 octets +2997 -- Degrees of Longitude 3 octets +2998 -- Uncertainty code 1 octet +2999 -- Confidence 1 octet +3000 +3001 LocationNumber ::= OCTET STRING (SIZE (2..10)) +3002 -- the internal structure is defined in ITU-T Rec Q.763 +3003 +3004 +3005 SubscriberState ::= CHOICE { +3006 assumedIdle [0] NULL, +3007 camelBusy [1] NULL, +3008 netDetNotReachable NotReachableReason, +3009 notProvidedFromVLR [2] NULL} +3010 +3011 +3012 PS-SubscriberState ::= CHOICE { +3013 notProvidedFromSGSNorMME [0] NULL, +3014 ps-Detached [1] NULL, +3015 ps-AttachedNotReachableForPaging [2] NULL, +3016 ps-AttachedReachableForPaging [3] NULL, +3017 ps-PDP-ActiveNotReachableForPaging [4] PDP-ContextInfoList, +3018 ps-PDP-ActiveReachableForPaging [5] PDP-ContextInfoList, +3019 netDetNotReachable NotReachableReason } +3020 +3021 +3022 PDP-ContextInfoList ::= SEQUENCE SIZE (1..maxNumOfPDP-Contexts) OF +3023 PDP-ContextInfo +3024 +3025 +3026 +3027 +3028 +3029 +3030 + +``` + +``` + +3011 PDP-ContextInfo ::= SEQUENCE { +3012 pdp-ContextIdentifier [0] ContextId, +3013 pdp-ContextActive [1] NULL OPTIONAL, +3014 pdp-Type [2] PDP-Type, +3015 pdp-Address [3] PDP-Address OPTIONAL, +3016 apn-Subscribed [4] APN OPTIONAL, +3017 apn-InUse [5] APN OPTIONAL, +3018 nsapi [6] NSAPI OPTIONAL, +3019 transactionId [7] TransactionId OPTIONAL, +3020 teid-ForGnAndGp [8] TEID OPTIONAL, +3021 teid-ForIu [9] TEID OPTIONAL, +3022 ggsn-Address [10] GSN-Address OPTIONAL, +3023 qos-Subscribed [11] Ext-QoS-Subscribed OPTIONAL, +3024 qos-Requested [12] Ext-QoS-Subscribed OPTIONAL, +3025 qos-Negotiated [13] Ext-QoS-Subscribed OPTIONAL, +3026 chargingId [14] GPRSChargingID OPTIONAL, +3027 chargingCharacteristics [15] ChargingCharacteristics OPTIONAL, +3028 rnc-Address [16] GSN-Address OPTIONAL, +3029 extensionContainer [17] ExtensionContainer OPTIONAL, +3030 ..., +3031 qos2-Subscribed [18] Ext2-QoS-Subscribed OPTIONAL, +3032 -- qos2-Subscribed may be present only if qos-Subscribed is present. +3033 qos2-Requested [19] Ext2-QoS-Subscribed OPTIONAL, +3034 -- qos2-Requested may be present only if qos-Requested is present. +3035 qos2-Negotiated [20] Ext2-QoS-Subscribed OPTIONAL, +3036 -- qos2-Negotiated may be present only if qos-Negotiated is present. +3037 qos3-Subscribed [21] Ext3-QoS-Subscribed OPTIONAL, +3038 -- qos3-Subscribed may be present only if qos2-Subscribed is present. +3039 qos3-Requested [22] Ext3-QoS-Subscribed OPTIONAL, +3040 -- qos3-Requested may be present only if qos2-Requested is present. +3041 qos3-Negotiated [23] Ext3-QoS-Subscribed OPTIONAL, +3042 -- qos3-Negotiated may be present only if qos2-Negotiated is present. +3043 qos4-Subscribed [25] Ext4-QoS-Subscribed OPTIONAL, +3044 -- qos4-Subscribed may be present only if qos3-Subscribed is present. +3045 qos4-Requested [26] Ext4-QoS-Subscribed OPTIONAL, +3046 -- qos4-Requested may be present only if qos3-Requested is present. +3047 qos4-Negotiated [27] Ext4-QoS-Subscribed OPTIONAL, +3048 -- qos4-Negotiated may be present only if qos3-Negotiated is present. +3049 ext-pdp-Type [28] Ext-PDP-Type OPTIONAL, +3050 -- contains the value IPv4v6 defined in 3GPP TS 29.060 [105], if the PDP can be +3051 -- accessed by dual-stack UEs. +3052 ext-pdp-Address [29] PDP-Address OPTIONAL +3053 -- contains an additional IP address in case of dual-stack static IP address assignment +3054 -- for the UE. +3055 -- it may contain an IPv4 or an IPv6 address/prefix, and it may be present +3056 -- only if pdp-Address is present; if both are present, each parameter shall +3057 -- contain a different type of address (IPv4 or IPv6). +3058 +3059 } +3060 +3061 NSAPI ::= INTEGER (0..15) +3062 -- This type is used to indicate the Network layer Service Access Point +3063 +3064 TransactionId ::= OCTET STRING (SIZE (1..2)) +3065 -- This type carries the value part of the transaction identifier which is used in the +3066 -- session management messages on the access interface. The encoding is defined in +3067 -- 3GPP TS 24.008 +3068 +3069 TEID ::= OCTET STRING (SIZE (4)) +3070 -- This type carries the value part of the Tunnel Endpoint Identifier which is used to +3071 -- distinguish between different tunnels between the same pair of entities which communicate +3072 -- using the GPRS Tunneling Protocol The encoding is defined in 3GPP TS 29.060. +3073 +3074 GPRSChargingID ::= OCTET STRING (SIZE (4)) +3075 -- The Charging ID is a unique four octet value generated by the GGSN when +3076 -- a PDP Context is activated. A Charging ID is generated for each activated context. +3077 -- The encoding is defined in 3GPP TS 29.060. +3078 +3079 NotReachableReason ::= ENUMERATED { +3080 msPurged (0), +3081 imsiDetached (1), +3082 restrictedArea (2), +3083 notRegistered (3) } +3084 +3085 -- any time interrogation info types +3086 + +``` + +``` + +3087 AnyTimeInterrogationArg ::= SEQUENCE { +3088 subscriberIdentity [0] SubscriberIdentity, +3089 requestedInfo [1] RequestedInfo, +3090 gsmSCF-Address [3] ISDN-AddressString, +3091 extensionContainer [2] ExtensionContainer OPTIONAL, +3092 ... } +3093 +3094 AnyTimeInterrogationRes ::= SEQUENCE { +3095 subscriberInfo SubscriberInfo, +3096 extensionContainer ExtensionContainer OPTIONAL, +3097 ... } +3098 +3099 -- any time information handling types +3100 +3101 AnyTimeSubscriptionInterrogationArg ::= SEQUENCE { +3102 subscriberIdentity [0] SubscriberIdentity, +3103 requestedSubscriptionInfo [1] RequestedSubscriptionInfo, +3104 gsmSCF-Address [2] ISDN-AddressString, +3105 extensionContainer [3] ExtensionContainer OPTIONAL, +3106 longFTN-Supported [4] NULL OPTIONAL, +3107 ... } +3108 +3109 AnyTimeSubscriptionInterrogationRes ::= SEQUENCE { +3110 callForwardingData [1] CallForwardingData OPTIONAL, +3111 callBarringData [2] CallBarringData OPTIONAL, +3112 odb-Info [3] ODB-Info OPTIONAL, +3113 camel-SubscriptionInfo [4] CAMEL-SubscriptionInfo OPTIONAL, +3114 supportedVLR-CAMEL-Phases [5] SupportedCamelPhases OPTIONAL, +3115 supportedSGSN-CAMEL-Phases [6] SupportedCamelPhases OPTIONAL, +3116 extensionContainer [7] ExtensionContainer OPTIONAL, +3117 ... , +3118 offeredCamel4CSIsInVLR [8] OfferedCamel4CSIs OPTIONAL, +3119 offeredCamel4CSIsInSGSN [9] OfferedCamel4CSIs OPTIONAL, +3120 msisdn-BS-List [10] MSISDN-BS-List OPTIONAL, +3121 csg-SubscriptionDataList [11] CSG-SubscriptionDataList OPTIONAL, +3122 cw-Data [12] CallWaitingData OPTIONAL, +3123 ch-Data [13] CallHoldData OPTIONAL, +3124 clip-Data [14] ClipData OPTIONAL, +3125 clir-Data [15] ClirData OPTIONAL, +3126 ect-data [16] EctData OPTIONAL } +3127 +3128 CallWaitingData ::= SEQUENCE { +3129 cwFeatureList [1] Ext-CwFeatureList, +3130 notificationToCSE [2] NULL OPTIONAL, +3131 ... } +3132 +3133 Ext-CwFeatureList ::= SEQUENCE SIZE (1..maxNumOfExt-BasicServiceGroups) OF +3134 Ext-CwFeature +3135 +3136 Ext-CwFeature ::= SEQUENCE { +3137 basicService [1] Ext-BasicServiceCode, +3138 ss-Status [2] Ext-SS-Status, +3139 ... } +3140 +3141 ClipData ::= SEQUENCE { +3142 ss-Status [1] Ext-SS-Status, +3143 overrideCategory [2] OverrideCategory, +3144 notificationToCSE [3] NULL OPTIONAL, +3145 ... } +3146 +3147 ClirData ::= SEQUENCE { +3148 ss-Status [1] Ext-SS-Status, +3149 cliRestrictionOption [2] CliRestrictionOption OPTIONAL, +3150 notificationToCSE [3] NULL OPTIONAL, +3151 ... } +3152 +3153 CallHoldData ::= SEQUENCE { +3154 ss-Status [1] Ext-SS-Status, +3155 notificationToCSE [2] NULL OPTIONAL, +3156 ... } +3157 +3158 EctData ::= SEQUENCE { +3159 ss-Status [1] Ext-SS-Status, +3160 notificationToCSE [2] NULL OPTIONAL, +3161 ... } +3162 + +``` + +``` + +3163 RequestedSubscriptionInfo ::= SEQUENCE { +3164 requestedSS-Info [1] SS-ForBS-Code OPTIONAL, +3165 odb [2] NULL OPTIONAL, +3166 requestedCAMEL-SubscriptionInfo [3] RequestedCAMEL-SubscriptionInfo OPTIONAL, +3167 supportedVLR-CAMEL-Phases [4] NULL OPTIONAL, +3168 supportedSGSN-CAMEL-Phases [5] NULL OPTIONAL, +3169 extensionContainer [6] ExtensionContainer OPTIONAL, +3170 ..., +3171 additionalRequestedCAMEL-SubscriptionInfo +3172 [7] AdditionalRequestedCAMEL-SubscriptionInfo +3173 OPTIONAL, +3174 msisdn-BS-List [8] NULL OPTIONAL, +3175 csg-SubscriptionDataRequested [9] NULL OPTIONAL, +3176 cw-Info [10] NULL OPTIONAL, +3177 clip-Info [11] NULL OPTIONAL, +3178 clir-Info [12] NULL OPTIONAL, +3179 hold-Info [13] NULL OPTIONAL, +3180 ect-Info [14] NULL OPTIONAL } +3181 +3182 MSISDN-BS-List ::= SEQUENCE SIZE (1..maxNumOfMSISDN) OF +3183 MSISDN-BS +3184 +3185 maxNumOfMSISDN INTEGER ::= 50 +3186 +3187 +3188 MSISDN-BS ::= SEQUENCE { +3189 msisdn ISDN-AddressString, +3190 basicServiceList [0] BasicServiceList OPTIONAL, +3191 extensionContainer [1] ExtensionContainer OPTIONAL, +3192 ...} +3193 +3194 RequestedCAMEL-SubscriptionInfo ::= ENUMERATED { +3195 o-CSI (0), +3196 t-CSI (1), +3197 vt-CSI (2), +3198 tif-CSI (3), +3199 gprs-CSI (4), +3200 mo-sms-CSI (5), +3201 ss-CSI (6), +3202 m-CSI (7), +3203 d-csi (8) } +3204 +3205 AdditionalRequestedCAMEL-SubscriptionInfo ::= ENUMERATED { +3206 mt-sms-CSI (0), +3207 mg-csi (1), +3208 o-IM-CSI (2), +3209 d-IM-CSI (3), +3210 vt-IM-CSI (4), +3211 ...} +3212 -- exception handling: unknown values shall be discarded by the receiver. +3213 +3214 CallForwardingData ::= SEQUENCE { +3215 forwardingFeatureList Ext-ForwFeatureList, +3216 notificationToCSE NULL OPTIONAL, +3217 extensionContainer [0] ExtensionContainer OPTIONAL, +3218 ...} +3219 +3220 CallBarringData ::= SEQUENCE { +3221 callBarringFeatureList Ext-CallBarFeatureList, +3222 password Password OPTIONAL, +3223 wrongPasswordAttemptsCounter WrongPasswordAttemptsCounter OPTIONAL, +3224 notificationToCSE NULL OPTIONAL, +3225 extensionContainer ExtensionContainer OPTIONAL, +3226 ...} +3227 +3228 WrongPasswordAttemptsCounter ::= INTEGER (0..4) +3229 +3230 ODB-Info ::= SEQUENCE { +3231 odb-Data ODB-Data, +3232 notificationToCSE NULL OPTIONAL, +3233 extensionContainer ExtensionContainer OPTIONAL, +3234 ...} +3235 + +``` + +``` + +3236 CAMEL-SubscriptionInfo ::= SEQUENCE { +3237 o-CSI [0] O-CSI OPTIONAL, +3238 o-BcsuCamelTDP-CriteriaList [1] O-BcsuCamelTDP-CriteriaList OPTIONAL, +3239 d-CSI [2] D-CSI OPTIONAL, +3240 t-CSI [3] T-CSI OPTIONAL, +3241 t-BCSM-CAMEL-TDP-CriteriaList [4] T-BCSM-CAMEL-TDP-CriteriaList OPTIONAL, +3242 vt-CSI [5] T-CSI OPTIONAL, +3243 vt-BCSM-CAMEL-TDP-CriteriaList [6] T-BCSM-CAMEL-TDP-CriteriaList OPTIONAL, +3244 tif-CSI [7] NULL OPTIONAL, +3245 tif-CSI-NotificationToCSE [8] NULL OPTIONAL, +3246 gprs-CSI [9] GPRS-CSI OPTIONAL, +3247 mo-sms-CSI [10] SMS-CSI OPTIONAL, +3248 ss-CSI [11] SS-CSI OPTIONAL, +3249 m-CSI [12] M-CSI OPTIONAL, +3250 extensionContainer [13] ExtensionContainer OPTIONAL, +3251 ..., +3252 specificCSIDeletedList [14] SpecificCSI-Withdraw OPTIONAL, +3253 mt-sms-CSI [15] SMS-CSI OPTIONAL, +3254 mt-smsCAMELTDP-CriteriaList [16] MT-smsCAMELTDP-CriteriaList OPTIONAL, +3255 mg-CSI [17] MG-CSI OPTIONAL, +3256 o-IM-CSI [18] O-CSI OPTIONAL, +3257 o-IM-BcsuCamelTDP-CriteriaList [19] O-BcsuCamelTDP-CriteriaList OPTIONAL, +3258 d-IM-CSI [20] D-CSI OPTIONAL, +3259 vt-IM-CSI [21] T-CSI OPTIONAL, +3260 vt-IM-BCSM-CAMEL-TDP-CriteriaList [22] T-BCSM-CAMEL-TDP-CriteriaList OPTIONAL +3261 } +3262 +3263 AnyTimeModificationArg ::= SEQUENCE { +3264 subscriberIdentity [0] SubscriberIdentity, +3265 gsmSCF-Address [1] ISDN-AddressString, +3266 modificationRequestFor-CF-Info [2] ModificationRequestFor-CF-Info OPTIONAL, +3267 modificationRequestFor-CB-Info [3] ModificationRequestFor-CB-Info OPTIONAL, +3268 modificationRequestFor-CSI [4] ModificationRequestFor-CSI OPTIONAL, +3269 extensionContainer [5] ExtensionContainer OPTIONAL, +3270 longFTN-Supported [6] NULL OPTIONAL, +3271 ..., +3272 modificationRequestFor-ODB-data [7] ModificationRequestFor-ODB-data OPTIONAL, +3273 modificationRequestFor-IP-SM-GW-Data [8] ModificationRequestFor-IP-SM-GW-Data OPTIONAL, +3274 activationRequestForUE-reachability [9] RequestedServingNode OPTIONAL, +3275 modificationRequestFor-CSG [10] ModificationRequestFor-CSG OPTIONAL, +3276 modificationRequestFor-CW-Data [11] ModificationRequestFor-CW-Info OPTIONAL, +3277 modificationRequestFor-CLIP-Data [12] ModificationRequestFor-CLIP-Info OPTIONAL, +3278 modificationRequestFor-CLIR-Data [13] ModificationRequestFor-CLIR-Info OPTIONAL, +3279 modificationRequestFor-HOLD-Data [14] ModificationRequestFor-CH-Info OPTIONAL, +3280 modificationRequestFor-ECT-Data [15] ModificationRequestFor-ECT-Info OPTIONAL } +3281 +3282 ModificationRequestFor-CW-Info ::= SEQUENCE { +3283 basicService [0] Ext-BasicServiceCode OPTIONAL, +3284 ss-Status [1] Ext-SS-Status OPTIONAL, +3285 modifyNotificationToCSE [2] ModificationInstruction OPTIONAL, +3286 extensionContainer [3] ExtensionContainer OPTIONAL, +3287 ...} +3288 +3289 ModificationRequestFor-CH-Info ::= SEQUENCE { +3290 ss-Status [0] Ext-SS-Status OPTIONAL, +3291 modifyNotificationToCSE [1] ModificationInstruction OPTIONAL, +3292 extensionContainer [2] ExtensionContainer OPTIONAL, +3293 ...} +3294 +3295 ModificationRequestFor-ECT-Info ::= SEQUENCE { +3296 ss-Status [0] Ext-SS-Status OPTIONAL, +3297 modifyNotificationToCSE [1] ModificationInstruction OPTIONAL, +3298 extensionContainer [2] ExtensionContainer OPTIONAL, +3299 ...} +3300 +3301 ModificationRequestFor-CLIR-Info ::= SEQUENCE { +3302 ss-Status [0] Ext-SS-Status OPTIONAL, +3303 cliRestrictionOption [1] CliRestrictionOption OPTIONAL, +3304 modifyNotificationToCSE [2] ModificationInstruction OPTIONAL, +3305 extensionContainer [3] ExtensionContainer OPTIONAL, +3306 ...} +3307 + +``` + +``` + +3308 ModificationRequestFor-CLIP-Info ::= SEQUENCE { +3309 ss-Status [0] Ext-SS-Status OPTIONAL, +3310 overrideCategory [1] OverrideCategory OPTIONAL, +3311 modifyNotificationToCSE [2] ModificationInstruction OPTIONAL, +3312 extensionContainer [3] ExtensionContainer OPTIONAL, +3313 ...} +3314 +3315 +3316 ModificationRequestFor-CSG ::= SEQUENCE { +3317 modifyNotificationToCSE [0] ModificationInstruction OPTIONAL, +3318 extensionContainer [1] ExtensionContainer OPTIONAL, +3319 ...} +3320 +3321 RequestedServingNode ::= BIT STRING { +3322 mmeAndSgsn (0) (SIZE (1..8)) +3323 +3324 ServingNode ::= BIT STRING { +3325 mme (0), +3326 sgsn (1) (SIZE (2..8)) +3327 -- Other bits than listed above shall be discarded. +3328 +3329 AnyTimeModificationRes ::= SEQUENCE { +3330 ss-InfoFor-CSE [0] Ext-SS-InfoFor-CSE OPTIONAL, +3331 camel-SubscriptionInfo [1] CAMEL-SubscriptionInfo OPTIONAL, +3332 extensionContainer [2] ExtensionContainer OPTIONAL, +3333 ..., +3334 odb-Info [3] ODB-Info OPTIONAL, +3335 cw-Data [4] CallWaitingData OPTIONAL, +3336 ch-Data [5] CallHoldData OPTIONAL, +3337 clip-Data [6] ClipData OPTIONAL, +3338 clir-Data [7] ClirData OPTIONAL, +3339 ect-data [8] EctData OPTIONAL, +3340 serviceCentreAddress [9] AddressString OPTIONAL +3341 } +3342 +3343 ModificationRequestFor-CF-Info ::= SEQUENCE { +3344 ss-Code [0] SS-Code, +3345 basicService [1] Ext-BasicServiceCode OPTIONAL, +3346 ss-Status [2] Ext-SS-Status OPTIONAL, +3347 forwardedToNumber [3] AddressString OPTIONAL, +3348 forwardedToSubaddress [4] ISDN-SubaddressString OPTIONAL, +3349 noReplyConditionTime [5] Ext-NoRepCondTime OPTIONAL, +3350 modifyNotificationToCSE [6] ModificationInstruction OPTIONAL, +3351 extensionContainer [7] ExtensionContainer OPTIONAL, +3352 ...} +3353 +3354 ModificationRequestFor-CB-Info ::= SEQUENCE { +3355 ss-Code [0] SS-Code, +3356 basicService [1] Ext-BasicServiceCode OPTIONAL, +3357 ss-Status [2] Ext-SS-Status OPTIONAL, +3358 password [3] Password OPTIONAL, +3359 wrongPasswordAttemptsCounter [4] WrongPasswordAttemptsCounter OPTIONAL, +3360 modifyNotificationToCSE [5] ModificationInstruction OPTIONAL, +3361 extensionContainer [6] ExtensionContainer OPTIONAL, +3362 ...} +3363 +3364 ModificationRequestFor-ODB-data ::= SEQUENCE { +3365 odb-data [0] ODB-Data OPTIONAL, +3366 modifyNotificationToCSE [1] ModificationInstruction OPTIONAL, +3367 extensionContainer [2] ExtensionContainer OPTIONAL, +3368 ...} +3369 +3370 ModificationRequestFor-CSI ::= SEQUENCE { +3371 requestedCamel-SubscriptionInfo [0] RequestedCAMEL-SubscriptionInfo, +3372 modifyNotificationToCSE [1] ModificationInstruction OPTIONAL, +3373 modifyCSI-State [2] ModificationInstruction OPTIONAL, +3374 extensionContainer [3] ExtensionContainer OPTIONAL, +3375 ..., +3376 additionalRequestedCAMEL-SubscriptionInfo +3377 [4] AdditionalRequestedCAMEL-SubscriptionInfo +3378 OPTIONAL } +3379 -- requestedCamel-SubscriptionInfo shall be discarded if +3380 -- additionalRequestedCAMEL-SubscriptionInfo is received +3381 + +``` + +``` + +3382 ModificationRequestFor-IP-SM-GW-Data ::= SEQUENCE { +3383 modifyRegistrationStatus [0] ModificationInstruction OPTIONAL, +3384 extensionContainer [1] ExtensionContainer OPTIONAL, +3385 ..., +3386 ip-sm-gw-DiameterAddress [2] NetworkNodeDiameterAddress OPTIONAL +3387 -- ip-sm-gw-DiameterAddress may be present when ModificationInstruction is "activate" +3388 } +3389 +3390 ModificationInstruction ::= ENUMERATED { +3391 deactivate (0), +3392 activate (1)} +3393 +3394 -- subscriber data modification notification types +3395 +3396 NoteSubscriberDataModifiedArg ::= SEQUENCE { +3397 imsi IMSI, +3398 msisdn ISDN-AddressString, +3399 forwardingInfoFor-CSE [0] Ext-ForwardingInfoFor-CSE OPTIONAL, +3400 callBarringInfoFor-CSE [1] Ext-CallBarringInfoFor-CSE OPTIONAL, +3401 odb-Info [2] ODB-Info OPTIONAL, +3402 camel-SubscriptionInfo [3] CAMEL-SubscriptionInfo OPTIONAL, +3403 allInformationSent [4] NULL OPTIONAL, +3404 extensionContainer ExtensionContainer OPTIONAL, +3405 ..., +3406 ue-reachable [5] ServingNode OPTIONAL, +3407 csg-SubscriptionDataList [6] CSG-SubscriptionDataList OPTIONAL, +3408 cw-Data [7] CallWaitingData OPTIONAL, +3409 ch-Data [8] CallHoldData OPTIONAL, +3410 clip-Data [9] ClipData OPTIONAL, +3411 clir-Data [10] ClirData OPTIONAL, +3412 ect-data [11] EctData OPTIONAL } +3413 +3414 NoteSubscriberDataModifiedRes ::= SEQUENCE { +3415 extensionContainer ExtensionContainer OPTIONAL, +3416 ...} +3417 +3418 -- mobility management event notification info types +3419 +3420 NoteMM-EventArg ::= SEQUENCE { +3421 serviceKey ServiceKey, +3422 eventMet [0] MM-Code, +3423 imsi [1] IMSI, +3424 msisdn [2] ISDN-AddressString, +3425 locationInformation [3] LocationInformation OPTIONAL, +3426 supportedCAMELPhases [5] SupportedCamelPhases OPTIONAL, +3427 extensionContainer [6] ExtensionContainer OPTIONAL, +3428 ..., +3429 locationInformationGPRS [7] LocationInformationGPRS OPTIONAL, +3430 offeredCamel4Functionalities [8] OfferedCamel4Functionalities OPTIONAL +3431 } +3432 +3433 NoteMM-EventRes ::= SEQUENCE { +3434 extensionContainer ExtensionContainer OPTIONAL, +3435 ...} +3436 +3437 Ext-SS-InfoFor-CSE ::= CHOICE { +3438 forwardingInfoFor-CSE [0] Ext-ForwardingInfoFor-CSE, +3439 callBarringInfoFor-CSE [1] Ext-CallBarringInfoFor-CSE +3440 } +3441 +3442 Ext-ForwardingInfoFor-CSE ::= SEQUENCE { +3443 ss-Code [0] SS-Code, +3444 forwardingFeatureList [1] Ext-ForwFeatureList, +3445 notificationToCSE [2] NULL OPTIONAL, +3446 extensionContainer [3] ExtensionContainer OPTIONAL, +3447 ...} +3448 +3449 Ext-CallBarringInfoFor-CSE ::= SEQUENCE { +3450 ss-Code [0] SS-Code, +3451 callBarringFeatureList [1] Ext-CallBarFeatureList, +3452 password [2] Password OPTIONAL, +3453 wrongPasswordAttemptsCounter [3] WrongPasswordAttemptsCounter OPTIONAL, +3454 notificationToCSE [4] NULL OPTIONAL, +3455 extensionContainer [5] ExtensionContainer OPTIONAL, +3456 ...} +3457 + +``` + +3458 -- vcsg location registration types + +3459 **UpdateVcsgLocationArg** ::= SEQUENCE { +3460     imsi IMSI, +3461     msisdn [2] ISDN-AddressString OPTIONAL, +3462     vlr-Number [0] ISDN-AddressString OPTIONAL, +3463     sgsn-Number [1] ISDN-AddressString OPTIONAL, +3464     extensionContainer ExtensionContainer OPTIONAL, +3465     ... } + +3466 +3467 **UpdateVcsgLocationRes** ::= SEQUENCE { +3468     temporaryEmptySubscriptiondataIndicator NULL OPTIONAL, +3469     extensionContainer ExtensionContainer OPTIONAL, +3470     ... } + +3471 +3472 **CancelVcsgLocationArg** ::= SEQUENCE { +3473     identity Identity, +3474     extensionContainer ExtensionContainer OPTIONAL, +3475     ... +3476 } + +3477 +3478 **CancelVcsgLocationRes** ::= SEQUENCE { +3479     extensionContainer ExtensionContainer OPTIONAL, +3480     ... } + +3481 +3482 +3483 +3484 END + +## 3485 17.7.2 Operation and maintenance data types + +3486 **MAP-OM-DataTypes** { +3487     itu-t identified-organization (4) etsi (0) mobileDomain (0) +3488     gsm-Network (1) modules (3) map-OM-DataTypes (12) version21 (21)} + +3489 +3490 DEFINITIONS + +3491 +3492 IMPLICIT TAGS + +3493 +3494 ::= + +3495 +3496 BEGIN + +3497 +3498 EXPORTS + +3499     ActivateTraceModeArg, +3500     ActivateTraceModeRes, +3501     DeactivateTraceModeArg, +3502     DeactivateTraceModeRes, +3503     TracePropagationList +3504 ; + +3505 +3506 IMPORTS + +3507     AddressString, +3508     IMSI, +3509     GSN-Address, +3510     GlobalCellId, +3511     E-UTRAN-CGI, +3512     TA-Id, +3513     RAIdentity, +3514     LAIFixedLength, +3515     PLMN-Id + +3516 FROM MAP-CommonDataTypes { +3517     itu-t identified-organization (4) etsi (0) mobileDomain (0) +3518     gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} + +3519 +3520     ExtensionContainer + +3521 FROM MAP-ExtensionDataTypes { +3522     itu-t identified-organization (4) etsi (0) mobileDomain (0) +3523     gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} + +3524 +3525 ; + +3526 + +``` + +3527 ActivateTraceModeArg ::= SEQUENCE { +3528 imsi [0] IMSI OPTIONAL, +3529 traceReference [1] TraceReference, +3530 traceType [2] TraceType, +3531 omc-Id [3] AddressString OPTIONAL, +3532 extensionContainer [4] ExtensionContainer OPTIONAL, +3533 ..., +3534 traceReference2 [5] TraceReference2 OPTIONAL, +3535 traceDepthList [6] TraceDepthList OPTIONAL, +3536 traceNE-TypeList [7] TraceNE-TypeList OPTIONAL, +3537 traceInterfaceList [8] TraceInterfaceList OPTIONAL, +3538 traceEventList [9] TraceEventList OPTIONAL, +3539 traceCollectionEntity [10] GSN-Address OPTIONAL, +3540 mdt-Configuration [11] MDT-Configuration OPTIONAL +3541 } +3542 +3543 MDT-Configuration ::= SEQUENCE { +3544 jobType JobType, +3545 areaScope AreaScope OPTIONAL, +3546 listOfMeasurements ListOfMeasurements OPTIONAL, +3547 reportingTrigger [0] ReportingTrigger OPTIONAL, +3548 reportInterval ReportInterval OPTIONAL, +3549 reportAmount [1] ReportAmount OPTIONAL, +3550 eventThresholdRSRP EventThresholdRSRP OPTIONAL, +3551 eventThresholdRSRQ [2] EventThresholdRSRQ OPTIONAL, +3552 loggingInterval [3] LoggingInterval OPTIONAL, +3553 loggingDuration [4] LoggingDuration OPTIONAL, +3554 extensionContainer [5] ExtensionContainer OPTIONAL, +3555 ..., +3556 measurementPeriodUMTS [6] PeriodUMTS OPTIONAL, +3557 measurementPeriodLTE [7] PeriodLTE OPTIONAL, +3558 collectionPeriodRRM-UMTS [8] PeriodUMTS OPTIONAL, +3559 collectionPeriodRRM-LTE [9] PeriodLTE OPTIONAL, +3560 positioningMethod [10] PositioningMethod OPTIONAL, +3561 measurementQuantity [11] MeasurementQuantity OPTIONAL, +3562 eventThreshold1F [12] EventThreshold1F OPTIONAL, +3563 eventThreshold1I [13] EventThreshold1I OPTIONAL, +3564 mdt-Allowed-PLMN-List [14] MDT-Allowed-PLMNId-List OPTIONAL } +3565 +3566 MDT-Allowed-PLMNId-List ::= SEQUENCE SIZE (1..16) OF +3567 PLMN-Id +3568 PeriodUMTS ::= ENUMERATED { +3569 d250ms (0), +3570 d500ms (1), +3571 d1000ms (2), +3572 d2000ms (3), +3573 d3000ms (4), +3574 d4000ms (5), +3575 d6000ms (6), +3576 d8000ms (7), +3577 d12000ms (8), +3578 d16000ms (9), +3579 d20000ms (10), +3580 d24000ms (11), +3581 d28000ms (12), +3582 d32000ms (13), +3583 d64000ms (14) } +3584 +3585 PeriodLTE ::= ENUMERATED { +3586 d1024ms (0), +3587 d1280ms (1), +3588 d2048ms (2), +3589 d2560ms (3), +3590 d5120ms (4), +3591 d10240ms (5), +3592 d1min (6) } +3593 +3594 PositioningMethod ::= OCTET STRING (SIZE (1)) +3595 -- Octet is coded as described in 3GPP TS 32.422 [132]. +3596 +3597 MeasurementQuantity ::= OCTET STRING (SIZE (1)) +3598 -- Octet is coded as described in 3GPP TS 32.422 [132]. +3599 +3600 EventThreshold1F ::= INTEGER +3601 (-120..165) +3602 + +``` + +``` + +3603 EventThresholdII := INTEGER +3604 (-120..-25) +3605 +3606 JobType := ENUMERATED { +3607 immediate-MDT-only (0), +3608 logged-MDT-only (1), +3609 trace-only (2), +3610 immediate-MDT-and-trace (3)} +3611 +3612 AreaScope := SEQUENCE { +3613 cgi-List [0] CGI-List OPTIONAL, +3614 e-utran-cgi-List [1] E-UTRAN-CGI-List OPTIONAL, +3615 routingAreaId-List [2] RoutingAreaId-List OPTIONAL, +3616 locationAreaId-List [3] LocationAreaId-List OPTIONAL, +3617 trackingAreaId-List [4] TrackingAreaId-List OPTIONAL, +3618 extensionContainer [5] ExtensionContainer OPTIONAL, +3619 ... } +3620 +3621 CGI-List := SEQUENCE SIZE (1..32) OF +3622 GlobalCellId +3623 +3624 E-UTRAN-CGI-List := SEQUENCE SIZE (1..32) OF +3625 E-UTRAN-CGI +3626 +3627 RoutingAreaId-List := SEQUENCE SIZE (1..8) OF +3628 RAIdentity +3629 +3630 LocationAreaId-List := SEQUENCE SIZE (1..8) OF +3631 LAIFixedLength +3632 +3633 TrackingAreaId-List := SEQUENCE SIZE (1..8) OF +3634 TA-Id +3635 +3636 ListOfMeasurements := OCTET STRING (SIZE (4)) +3637 -- Octets are coded as described in 3GPP TS 32.422. +3638 +3639 ReportingTrigger := OCTET STRING (SIZE (1)) +3640 -- Octet is coded as described in 3GPP TS 32.422. +3641 +3642 ReportInterval := ENUMERATED { +3643 umts250ms (0), +3644 umts500ms (1), +3645 umts1000ms (2), +3646 umts2000ms (3), +3647 umts3000ms (4), +3648 umts4000ms (5), +3649 umts6000ms (6), +3650 umts8000ms (7), +3651 umts12000ms (8), +3652 umts16000ms (9), +3653 umts20000ms (10), +3654 umts24000ms (11), +3655 umts28000ms (12), +3656 umts32000ms (13), +3657 umts64000ms (14), +3658 lte120ms (15), +3659 lte240ms (16), +3660 lte480ms (17), +3661 lte640ms (18), +3662 lte1024ms (19), +3663 lte2048ms (20), +3664 lte5120ms (21), +3665 lte10240ms (22), +3666 lte1min (23), +3667 lte6min (24), +3668 lte12min (25), +3669 lte30min (26), +3670 lte60min (27)} +3671 +3672 + +``` + +``` + +3673 ReportAmount ::= ENUMERATED { +3674 d1 (0), +3675 d2 (1), +3676 d4 (2), +3677 d8 (3), +3678 d16 (4), +3679 d32 (5), +3680 d64 (6), +3681 infinity (7) } +3682 +3683 EventThresholdRSRP ::= INTEGER +3684 (0..97) +3685 +3686 EventThresholdRSRQ ::= INTEGER +3687 (0..34) +3688 +3689 LoggingInterval ::= ENUMERATED { +3690 d1dot28 (0), +3691 d2dot56 (1), +3692 d5dot12 (2), +3693 d10dot24 (3), +3694 d20dot48 (4), +3695 d30dot72 (5), +3696 d40dot96 (6), +3697 d61dot44 (7) } +3698 +3699 LoggingDuration ::= ENUMERATED { +3700 d600sec (0), +3701 d1200sec (1), +3702 d2400sec (2), +3703 d3600sec (3), +3704 d5400sec (4), +3705 d7200sec (5) } +3706 +3707 TraceReference ::= OCTET STRING (SIZE (1..2)) +3708 +3709 TraceReference2 ::= OCTET STRING (SIZE (3)) +3710 +3711 TraceRecordingSessionReference ::= OCTET STRING (SIZE (2)) +3712 +3713 TraceType ::= INTEGER +3714 (0..255) +3715 -- Trace types are fully defined in 3GPP TS 52.008. [61] +3716 +3717 TraceDepthList ::= SEQUENCE { +3718 msc-s-TraceDepth [0] TraceDepth OPTIONAL, +3719 mgw-TraceDepth [1] TraceDepth OPTIONAL, +3720 sgsn-TraceDepth [2] TraceDepth OPTIONAL, +3721 ggsn-TraceDepth [3] TraceDepth OPTIONAL, +3722 rnc-TraceDepth [4] TraceDepth OPTIONAL, +3723 bmsc-TraceDepth [5] TraceDepth OPTIONAL, +3724 ... , +3725 mme-TraceDepth [6] TraceDepth OPTIONAL, +3726 sgw-TraceDepth [7] TraceDepth OPTIONAL, +3727 pgw-TraceDepth [8] TraceDepth OPTIONAL, +3728 eNB-TraceDepth [9] TraceDepth OPTIONAL, +3729 msc-s-TraceDepthExtension [10] TraceDepthExtension OPTIONAL, +3730 mgw-TraceDepthExtension [11] TraceDepthExtension OPTIONAL, +3731 sgsn-TraceDepthExtension [12] TraceDepthExtension OPTIONAL, +3732 ggsn-TraceDepthExtension [13] TraceDepthExtension OPTIONAL, +3733 rnc-TraceDepthExtension [14] TraceDepthExtension OPTIONAL, +3734 bmsc-TraceDepthExtension [15] TraceDepthExtension OPTIONAL, +3735 mme-TraceDepthExtension [16] TraceDepthExtension OPTIONAL, +3736 sgw-TraceDepthExtension [17] TraceDepthExtension OPTIONAL, +3737 pgw-TraceDepthExtension [18] TraceDepthExtension OPTIONAL, +3738 eNB-TraceDepthExtension [19] TraceDepthExtension OPTIONAL } +3739 +3740 -- If one of the TraceDepthExtension types is sent, the corresponding TraceDepth type +3741 -- shall also be sent with the same enumeration value to allow the receiver not supporting +3742 -- the Extension to fall back to the non extended type. +3743 -- If one of the TraceDepthExtension types is received and supported, the corresponding +3744 -- TraceDepth type shall be ignored. +3745 + +``` + +``` +3746 TraceDepth ::= ENUMERATED { +3747 minimum (0), +3748 medium (1), +3749 maximum (2), +3750 ...} +3751 -- The value medium is applicable only for RNC. For other network elements, if value medium +3752 -- is received, value minimum shall be applied. +``` + +``` +3753 +3754 TraceDepthExtension ::= ENUMERATED { +3755 minimumWithoutVendorSpecificExtension (0), +3756 mediumWithoutVendorSpecificExtension (1), +3757 maximumWithoutVendorSpecificExtension (2), +3758 ...} +3759 -- The value mediumWithoutVendorSpecificExtension is applicable only for RNC. For other +3760 -- network elements, if value mediumWithoutVendorSpecificExtension is received, value +3761 -- minimumWithoutVendorSpecificExtension shall be applied. +``` + +``` +3762 +3763 TraceNE-TypeList ::= BIT STRING { +3764 msc-s (0), +3765 mgw (1), +3766 sgsn (2), +3767 ggsn (3), +3768 rnc (4), +3769 bm-sc (5) , +3770 mme (6), +3771 sgw (7), +3772 pgw (8), +3773 eNB (9)} (SIZE (6..16)) +3774 -- Other bits than listed above shall be discarded. +``` + +``` +3775 +3776 TraceInterfaceList ::= SEQUENCE { +3777 msc-s-List [0] MSC-S-InterfaceList OPTIONAL, +3778 mgw-List [1] MGW-InterfaceList OPTIONAL, +3779 sgsn-List [2] SGSN-InterfaceList OPTIONAL, +3780 ggsn-List [3] GGSN-InterfaceList OPTIONAL, +3781 rnc-List [4] RNC-InterfaceList OPTIONAL, +3782 bmsc-List [5] BMSC-InterfaceList OPTIONAL, +3783 ..., +3784 mme-List [6] MME-InterfaceList OPTIONAL, +3785 sgw-List [7] SGW-InterfaceList OPTIONAL, +3786 pgw-List [8] PGW-InterfaceList OPTIONAL, +3787 eNB-List [9] ENB-InterfaceList OPTIONAL} +``` + +``` +3788 +3789 MSC-S-InterfaceList ::= BIT STRING { +3790 a (0), +3791 iu (1), +3792 mc (2), +3793 map-g (3), +3794 map-b (4), +3795 map-e (5), +3796 map-f (6), +3797 cap (7), +3798 map-d (8), +3799 map-c (9)} (SIZE (10..16)) +3800 -- Other bits than listed above shall be discarded. +``` + +``` +3801 +3802 MGW-InterfaceList ::= BIT STRING { +3803 mc (0), +3804 nb-up (1), +3805 iu-up (2)} (SIZE (3..8)) +3806 -- Other bits than listed above shall be discarded. +``` + +``` +3807 +3808 SGSN-InterfaceList ::= BIT STRING { +3809 gb (0), +3810 iu (1), +3811 gn (2), +3812 map-gr (3), +3813 map-gd (4), +3814 map-gf (5), +3815 gs (6), +3816 ge (7), +3817 s3 (8), +3818 s4 (9), +3819 s6d (10)} (SIZE (8..16)) +3820 -- Other bits than listed above shall be discarded. +``` + +``` +3821 +``` + +``` + +3822 GGSN-InterfaceList ::= BIT STRING { +3823 gn (0), +3824 gi (1), +3825 gmb (2)} (SIZE (3..8)) +3826 -- Other bits than listed above shall be discarded. +3827 +3828 RNC-InterfaceList ::= BIT STRING { +3829 iu (0), +3830 iur (1), +3831 iub (2), +3832 uu (3)} (SIZE (4..8)) +3833 -- Other bits than listed above shall be discarded. +3834 +3835 BMSC-InterfaceList ::= BIT STRING { +3836 gmb (0)} (SIZE (1..8)) +3837 -- Other bits than listed above shall be discarded. +3838 +3839 MME-InterfaceList ::= BIT STRING { +3840 s1-mme (0), +3841 s3 (1), +3842 s6a (2), +3843 s10 (3), +3844 s11 (4)} (SIZE (5..8)) +3845 -- Other bits than listed above shall be discarded. +3846 +3847 SGW-InterfaceList ::= BIT STRING { +3848 s4 (0), +3849 s5 (1), +3850 s8b (2), +3851 s11 (3), +3852 gxc (4)} (SIZE (5..8)) +3853 -- Other bits than listed above shall be discarded. +3854 +3855 PGW-InterfaceList ::= BIT STRING { +3856 s2a (0), +3857 s2b (1), +3858 s2c (2), +3859 s5 (3), +3860 s6b (4), +3861 gx (5), +3862 s8b (6), +3863 sgi (7)} (SIZE (8..16)) +3864 -- Other bits than listed above shall be discarded. +3865 +3866 ENB-InterfaceList ::= BIT STRING { +3867 s1-mme (0), +3868 x2 (1), +3869 uu (2)} (SIZE (3..8)) +3870 -- Other bits than listed above shall be discarded. +3871 +3872 TraceEventList ::= SEQUENCE { +3873 msc-s-List [0] MSC-S-EventList OPTIONAL, +3874 mgw-List [1] MGW-EventList OPTIONAL, +3875 sgsn-List [2] SGSN-EventList OPTIONAL, +3876 ggsn-List [3] GGSN-EventList OPTIONAL, +3877 bmsc-List [4] BMSC-EventList OPTIONAL, +3878 ..., +3879 mme-List [5] MME-EventList OPTIONAL, +3880 sgw-List [6] SGW-EventList OPTIONAL, +3881 pgw-List [7] PGW-EventList OPTIONAL} +3882 +3883 MSC-S-EventList ::= BIT STRING { +3884 mo-mtCall (0), +3885 mo-mt-sms (1), +3886 lu-imsiAttach-imsiDetach (2), +3887 handovers (3), +3888 ss (4)} (SIZE (5..16)) +3889 -- Other bits than listed above shall be discarded. +3890 +3891 MGW-EventList ::= BIT STRING { +3892 context (0)} (SIZE (1..8)) +3893 -- Other bits than listed above shall be discarded. +3894 + +``` + +``` + +3895 SGSN-EventList ::= BIT STRING { +3896 pdpContext (0), +3897 mo-mt-sms (1), +3898 rau-gprsAttach-gprsDetach (2), +3899 mbmsContext (3)} (SIZE (4..16)) +3900 -- Other bits than listed above shall be discarded. +3901 +3902 GGSN-EventList ::= BIT STRING { +3903 pdpContext (0), +3904 mbmsContext (1)} (SIZE (2..8)) +3905 -- Other bits than listed above shall be discarded. +3906 +3907 BMSC-EventList ::= BIT STRING { +3908 mbmsMulticastServiceActivation (0)} (SIZE (1..8)) +3909 -- Other bits than listed above shall be discarded. +3910 +3911 MME-EventList ::= BIT STRING { +3912 ue-initiatedPDNconnectivityRequest (0), +3913 serviceRequestts (1), +3914 initialAttachTrackingAreaUpdateDetach (2), +3915 ue-initiatedPDNdisconnection (3), +3916 bearerActivationModificationDeletion (4), +3917 handover (5)} (SIZE (6..8)) +3918 -- Other bits than listed above shall be discarded. +3919 +3920 SGW-EventList ::= BIT STRING { +3921 pdn-connectionCreation (0), +3922 pdn-connectionTermination (1), +3923 bearerActivationModificationDeletion (2)} (SIZE (3..8)) +3924 -- Other bits than listed above shall be discarded. +3925 +3926 PGW-EventList ::= BIT STRING { +3927 pdn-connectionCreation (0), +3928 pdn-connectionTermination (1), +3929 bearerActivationModificationDeletion (2)} (SIZE (3..8)) +3930 -- Other bits than listed above shall be discarded. +3931 +3932 TracePropagationList ::= SEQUENCE { +3933 traceReference [0] TraceReference OPTIONAL, +3934 traceType [1] TraceType OPTIONAL, +3935 traceReference2 [2] TraceReference2 OPTIONAL, +3936 traceRecordingSessionReference [3] TraceRecordingSessionReference OPTIONAL, +3937 rnc-TraceDepth [4] TraceDepth OPTIONAL, +3938 rnc-InterfaceList [5] RNC-InterfaceList OPTIONAL, +3939 msc-s-TraceDepth [6] TraceDepth OPTIONAL, +3940 msc-s-InterfaceList [7] MSC-S-InterfaceList OPTIONAL, +3941 msc-s-EventList [8] MSC-S-EventList OPTIONAL, +3942 mgw-TraceDepth [9] TraceDepth OPTIONAL, +3943 mgw-InterfaceList [10] MGW-InterfaceList OPTIONAL, +3944 mgw-EventList [11] MGW-EventList OPTIONAL, +3945 ..., +3946 rnc-TraceDepthExtension [12] TraceDepthExtension OPTIONAL, +3947 msc-s-TraceDepthExtension [13] TraceDepthExtension OPTIONAL, +3948 mgw-TraceDepthExtension [14] TraceDepthExtension OPTIONAL +3949 } +3950 -- If one of the TraceDepthExtension types is sent, the corresponding TraceDepth type +3951 -- shall also be sent with the same enumeration value to allow the receiver not supporting +3952 -- the Extension to fall back to the non extended type. +3953 -- If one of the TraceDepthExtension types is received and supported, the corresponding +3954 -- TraceDepth type shall be ignored. +3955 +3956 ActivateTraceModeRes ::= SEQUENCE { +3957 extensionContainer [0] ExtensionContainer OPTIONAL, +3958 ..., +3959 traceSupportIndicator [1] NULL OPTIONAL +3960 } +3961 +3962 DeactivateTraceModeArg ::= SEQUENCE { +3963 imsi [0] IMSI OPTIONAL, +3964 traceReference [1] TraceReference, +3965 extensionContainer [2] ExtensionContainer OPTIONAL, +3966 ..., +3967 traceReference2 [3] TraceReference2 OPTIONAL +3968 } +3969 + +``` + +``` + +3970 DeactivateTraceModeRes ::= SEQUENCE { +3971 extensionContainer [0] ExtensionContainer OPTIONAL, +3972 ...} +3973 +3974 END + +``` + +## 3975 17.7.3 Call handling data types + +``` + +3976 MAP-CH-DataTypes { +3977 itu-t identified-organization (4) etsi (0) mobileDomain (0) +3978 gsm-Network (1) modules (3) map-CH-DataTypes (13) version21 (21)} +3979 +3980 DEFINITIONS +3981 +3982 IMPLICIT TAGS +3983 +3984 ::= +3985 +3986 BEGIN +3987 +3988 EXPORTS +3989 SendRoutingInfoArg, +3990 SendRoutingInfoRes, +3991 ProvideRoamingNumberArg, +3992 ProvideRoamingNumberRes, +3993 ResumeCallHandlingArg, +3994 ResumeCallHandlingRes, +3995 NumberOfForwarding, +3996 SuppressionOfAnnouncement, +3997 CallReferenceNumber, +3998 SetReportingStateArg, +3999 SetReportingStateRes, +4000 StatusReportArg, +4001 StatusReportRes, +4002 RemoteUserFreeArg, +4003 RemoteUserFreeRes, +4004 IST-AlertArg, +4005 IST-AlertRes, +4006 IST-CommandArg, +4007 IST-CommandRes, +4008 UU-Data, +4009 ReleaseResourcesArg, +4010 ReleaseResourcesRes +4011 ; +4012 +4013 IMPORTS +4014 SubscriberInfo, +4015 SupportedCamelPhases, +4016 OfferedCamel4CSIs, +4017 CUG-Interlock, +4018 O-CSI, +4019 D-CSI, +4020 O-BcsmCamelTDPCriteriaList, +4021 T-BCSM-CAMEL-TDP-CriteriaList, +4022 IST-SupportIndicator, +4023 IST-AlertTimerValue, +4024 T-CSI, +4025 NumberPortabilityStatus, +4026 PagingArea +4027 FROM MAP-MS-DataTypes { +4028 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4029 gsm-Network (1) modules (3) map-MS-DataTypes (11) version21 (21)} +4030 +4031 ForwardingOptions, +4032 SS-List, +4033 CCBS-Feature +4034 FROM MAP-SS-DataTypes { +4035 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4036 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +4037 +4038 ISDN-AddressString, +4039 ISDN-SubaddressString, +4040 FTN-AddressString, +4041 ExternalSignalInfo, +4042 Ext-ExternalSignalInfo, +4043 IMSI, +4044 LMSI, +4045 Ext-BasicServiceCode, + +``` + +``` + +4046 AlertingPattern, +4047 NAEA-PreferredCI, +4048 EMLPP-Priority, +4049 PLMN-Id +4050 FROM MAP-CommonDataTypes { +4051 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4052 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +4053 +4054 ExtensionContainer +4055 FROM MAP-ExtensionDataTypes { +4056 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4057 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +4058 ; +4059 +4060 +4061 CUG-CheckInfo ::= SEQUENCE { +4062 cug-Interlock CUG-Interlock, +4063 cug-OutgoingAccess NULL OPTIONAL, +4064 extensionContainer ExtensionContainer OPTIONAL, +4065 ...} +4066 +4067 NumberOfForwarding ::= INTEGER (1..5) +4068 +4069 SendRoutingInfoArg ::= SEQUENCE { +4070 msisdn [0] ISDN-AddressString, +4071 cug-CheckInfo [1] CUG-CheckInfo OPTIONAL, +4072 numberOfForwarding [2] NumberOfForwarding OPTIONAL, +4073 interrogationType [3] InterrogationType, +4074 or-Interrogation [4] NULL OPTIONAL, +4075 or-Capability [5] OR-Phase OPTIONAL, +4076 gmsc-OrGsmSCF-Address [6] ISDN-AddressString, +4077 callReferenceNumber [7] CallReferenceNumber OPTIONAL, +4078 forwardingReason [8] ForwardingReason OPTIONAL, +4079 basicServiceGroup [9] Ext-BasicServiceCode OPTIONAL, +4080 networkSignalInfo [10] ExternalSignalInfo OPTIONAL, +4081 camelInfo [11] CamelInfo OPTIONAL, +4082 suppressionOfAnnouncement [12] SuppressionOfAnnouncement OPTIONAL, +4083 extensionContainer [13] ExtensionContainer OPTIONAL, +4084 ..., +4085 alertingPattern [14] AlertingPattern OPTIONAL, +4086 ccbs-Call [15] NULL OPTIONAL, +4087 supportedCCBS-Phase [16] SupportedCCBS-Phase OPTIONAL, +4088 additionalSignalInfo [17] Ext-ExternalSignalInfo OPTIONAL, +4089 istSupportIndicator [18] IST-SupportIndicator OPTIONAL, +4090 pre-pagingSupported [19] NULL OPTIONAL, +4091 callDiversionTreatmentIndicator [20] CallDiversionTreatmentIndicator OPTIONAL, +4092 longFTN-Supported [21] NULL OPTIONAL, +4093 suppress-VT-CSI [22] NULL OPTIONAL, +4094 suppressIncomingCallBarring [23] NULL OPTIONAL, +4095 gsmSCF-InitiatedCall [24] NULL OPTIONAL, +4096 basicServiceGroup2 [25] Ext-BasicServiceCode OPTIONAL, +4097 networkSignalInfo2 [26] ExternalSignalInfo OPTIONAL, +4098 suppressMTSS [27] SuppressMTSS OPTIONAL, +4099 mtRoamingRetrySupported [28] NULL OPTIONAL, +4100 callPriority [29] EMLPP-Priority OPTIONAL +4101 } +4102 +4103 SuppressionOfAnnouncement ::= NULL +4104 +4105 SuppressMTSS ::= BIT STRING { +4106 suppressCUG (0), +4107 suppressCCBS (1) } (SIZE (2..16)) +4108 -- Other bits than listed above shall be discarded +4109 +4110 InterrogationType ::= ENUMERATED { +4111 basicCall (0), +4112 forwarding (1)} +4113 +4114 OR-Phase ::= INTEGER (1..127) +4115 +4116 CallReferenceNumber ::= OCTET STRING (SIZE (1..8)) +4117 +4118 ForwardingReason ::= ENUMERATED { +4119 notReachable (0), +4120 busy (1), +4121 noReply (2)} +4122 + +``` + +``` + +4123 SupportedCCBS-Phase ::= INTEGER (1..127) +4124 -- exception handling: +4125 -- Only value 1 is used. +4126 -- Values in the ranges 2-127 are reserved for future use. +4127 -- If received values 2-127 shall be mapped on to value 1. +4128 +4129 CallDiversionTreatmentIndicator ::= OCTET STRING (SIZE(1)) +4130 -- callDiversionAllowed (xxxx xx01) +4131 -- callDiversionNotAllowed (xxxx xx10) +4132 -- network default is call diversion allowed +4133 +4134 SendRoutingInfoRes ::= [3] SEQUENCE { +4135 imsi [9] IMSI OPTIONAL, +4136 -- IMSI must be present if SendRoutingInfoRes is not segmented. +4137 -- If the TC-Result-NL segmentation option is taken the IMSI must be +4138 -- present in one segmented transmission of SendRoutingInfoRes. +4139 extendedRoutingInfo ExtendedRoutingInfo OPTIONAL, +4140 cug-CheckInfo [3] CUG-CheckInfo OPTIONAL, +4141 cugSubscriptionFlag [6] NULL OPTIONAL, +4142 subscriberInfo [7] SubscriberInfo OPTIONAL, +4143 ss-List [1] SS-List OPTIONAL, +4144 basicService [5] Ext-BasicServiceCode OPTIONAL, +4145 forwardingInterrogationRequired [4] NULL OPTIONAL, +4146 vmsc-Address [2] ISDN-AddressString OPTIONAL, +4147 extensionContainer [0] ExtensionContainer OPTIONAL, +4148 ... , +4149 naea-PreferredCI [10] NAEA-PreferredCI OPTIONAL, +4150 -- naea-PreferredCI is included at the discretion of the HLR operator. +4151 ccbs-Indicators [11] CCBS-Indicators OPTIONAL, +4152 msisdn [12] ISDN-AddressString OPTIONAL, +4153 numberPortabilityStatus [13] NumberPortabilityStatus OPTIONAL, +4154 istAlertTimer [14] IST-AlertTimerValue OPTIONAL, +4155 supportedCamelPhasesInVMSC [15] SupportedCamelPhases OPTIONAL, +4156 offeredCamel4CSIsInVMSC [16] OfferedCamel4CSIs OPTIONAL, +4157 routingInfo2 [17] RoutingInfo OPTIONAL, +4158 ss-List2 [18] SS-List OPTIONAL, +4159 basicService2 [19] Ext-BasicServiceCode OPTIONAL, +4160 allowedServices [20] AllowedServices OPTIONAL, +4161 unavailabilityCause [21] UnavailabilityCause OPTIONAL, +4162 releaseResourcesSupported [22] NULL OPTIONAL, +4163 gsm-BearerCapability [23] ExternalSignalInfo OPTIONAL +4164 } +4165 +4166 AllowedServices ::= BIT STRING { +4167 firstServiceAllowed (0), +4168 secondServiceAllowed (1) } (SIZE (2..8)) +4169 -- firstService is the service indicated in the networkSignalInfo +4170 -- secondService is the service indicated in the networkSignalInfo2 +4171 -- Other bits than listed above shall be discarded +4172 +4173 UnavailabilityCause ::= ENUMERATED { +4174 bearerServiceNotProvisioned (1), +4175 teleserviceNotProvisioned (2), +4176 absentSubscriber (3), +4177 busySubscriber (4), +4178 callBarred (5), +4179 cug-Reject (6), +4180 ...} +4181 -- exception handling: +4182 -- Reception of other values than the ones listed shall result in the service +4183 -- being unavailable for that call. +4184 +4185 CCBS-Indicators ::= SEQUENCE { +4186 ccbs-Possible [0] NULL OPTIONAL, +4187 keepCCBS-CallIndicator [1] NULL OPTIONAL, +4188 extensionContainer [2] ExtensionContainer OPTIONAL, +4189 ...} +4190 +4191 RoutingInfo ::= CHOICE { +4192 roamingNumber ISDN-AddressString, +4193 forwardingData ForwardingData} +4194 + +``` + +``` + +4195 ForwardingData ::= SEQUENCE { +4196 forwardedToNumber [5] ISDN-AddressString OPTIONAL, +4197 -- When this datatype is sent from an HLR which supports CAMEL Phase 2 +4198 -- to a GMSC which supports CAMEL Phase 2 the GMSC shall not check the +4199 -- format of the number +4200 forwardedToSubaddress [4] ISDN-SubaddressString OPTIONAL, +4201 forwardingOptions [6] ForwardingOptions OPTIONAL, +4202 extensionContainer [7] ExtensionContainer OPTIONAL, +4203 ..., +4204 longForwardedToNumber [8] FTN-AddressString OPTIONAL} +4205 +4206 ProvideRoamingNumberArg ::= SEQUENCE { +4207 imsi [0] IMSI, +4208 msc-Number [1] ISDN-AddressString, +4209 msisdn [2] ISDN-AddressString OPTIONAL, +4210 lmsi [4] LMSI OPTIONAL, +4211 gsm-BearerCapability [5] ExternalSignalInfo OPTIONAL, +4212 networkSignalInfo [6] ExternalSignalInfo OPTIONAL, +4213 suppressionOfAnnouncement [7] SuppressionOfAnnouncement OPTIONAL, +4214 gmsc-Address [8] ISDN-AddressString OPTIONAL, +4215 callReferenceNumber [9] CallReferenceNumber OPTIONAL, +4216 or-Interrogation [10] NULL OPTIONAL, +4217 extensionContainer [11] ExtensionContainer OPTIONAL, +4218 ... , +4219 alertingPattern [12] AlertingPattern OPTIONAL, +4220 ccbs-Call [13] NULL OPTIONAL, +4221 supportedCamelPhasesInInterrogatingNode [15] SupportedCamelPhases OPTIONAL, +4222 additionalSignalInfo [14] Ext-ExternalSignalInfo OPTIONAL, +4223 orNotSupportedInGMSC [16] NULL OPTIONAL, +4224 pre-pagingSupported [17] NULL OPTIONAL, +4225 longFTN-Supported [18] NULL OPTIONAL, +4226 suppress-VT-CSI [19] NULL OPTIONAL, +4227 offeredCamel4CSIsInInterrogatingNode [20] OfferedCamel4CSIs OPTIONAL, +4228 mtRoamingRetrySupported [21] NULL OPTIONAL, +4229 pagingArea [22] PagingArea OPTIONAL, +4230 callPriority [23] EMLPP-Priority OPTIONAL, +4231 mtrf-Indicator [24] NULL OPTIONAL, +4232 oldMSC-Number [25] ISDN-AddressString OPTIONAL, +4233 lastUsedLtePLMN-Id [26] PLMN-Id OPTIONAL +4234 } +4235 +4236 ProvideRoamingNumberRes ::= SEQUENCE { +4237 roamingNumber ISDN-AddressString, +4238 extensionContainer ExtensionContainer OPTIONAL, +4239 ..., +4240 releaseResourcesSupported NULL OPTIONAL, +4241 vmsc-Address ISDN-AddressString OPTIONAL } +4242 +4243 ResumeCallHandlingArg ::= SEQUENCE { +4244 callReferenceNumber [0] CallReferenceNumber OPTIONAL, +4245 basicServiceGroup [1] Ext-BasicServiceCode OPTIONAL, +4246 forwardingData [2] ForwardingData OPTIONAL, +4247 imsi [3] IMSI OPTIONAL, +4248 cug-CheckInfo [4] CUG-CheckInfo OPTIONAL, +4249 o-CSI [5] O-CSI OPTIONAL, +4250 extensionContainer [7] ExtensionContainer OPTIONAL, +4251 ccbs-Possible [8] NULL OPTIONAL, +4252 msisdn [9] ISDN-AddressString OPTIONAL, +4253 uu-Data [10] UU-Data OPTIONAL, +4254 allInformationSent [11] NULL OPTIONAL, +4255 ..., +4256 d-csi [12] D-CSI OPTIONAL, +4257 o-BcsuCamelTDPCriteriaList [13] O-BcsuCamelTDPCriteriaList OPTIONAL, +4258 basicServiceGroup2 [14] Ext-BasicServiceCode OPTIONAL, +4259 mtRoamingRetry [15] NULL OPTIONAL +4260 } +4261 +4262 UU-Data ::= SEQUENCE { +4263 uuIndicator [0] UUIndicator OPTIONAL, +4264 uui [1] UUI OPTIONAL, +4265 uusCFInteraction [2] NULL OPTIONAL, +4266 extensionContainer [3] ExtensionContainer OPTIONAL, +4267 ...} +4268 +4269 UUIndicator ::= OCTET STRING (SIZE (1)) +4270 -- Octets are coded according to ETS 300 356 +4271 +4272 UUI ::= OCTET STRING (SIZE (1..131)) + +``` + +``` + +4273 -- Octets are coded according to ETS 300 356 +4274 +4275 ResumeCallHandlingRes ::= SEQUENCE { +4276 extensionContainer ExtensionContainer OPTIONAL, +4277 ... } +4278 +4279 CamelInfo ::= SEQUENCE { +4280 supportedCamelPhases SupportedCamelPhases, +4281 suppress-T-CSI NULL OPTIONAL, +4282 extensionContainer ExtensionContainer OPTIONAL, +4283 ... , +4284 offeredCamel4CSIs [0] OfferedCamel4CSIs OPTIONAL } +4285 +4286 ExtendedRoutingInfo ::= CHOICE { +4287 routingInfo RoutingInfo, +4288 camelRoutingInfo [8] CamelRoutingInfo} +4289 +4290 CamelRoutingInfo ::= SEQUENCE { +4291 forwardingData ForwardingData OPTIONAL, +4292 gmscCamelSubscriptionInfo [0] GmscCamelSubscriptionInfo, +4293 extensionContainer [1] ExtensionContainer OPTIONAL, +4294 ... } +4295 +4296 GmscCamelSubscriptionInfo ::= SEQUENCE { +4297 t-CSI [0] T-CSI OPTIONAL, +4298 o-CSI [1] O-CSI OPTIONAL, +4299 extensionContainer [2] ExtensionContainer OPTIONAL, +4300 ... , +4301 o-BcsmCamelTDP-CriteriaList [3] O-BcsmCamelTDP-CriteriaList OPTIONAL, +4302 t-BCSM-CAMEL-TDP-CriteriaList [4] T-BCSM-CAMEL-TDP-CriteriaList OPTIONAL, +4303 d-csi [5] D-CSI OPTIONAL} +4304 +4305 SetReportingStateArg ::= SEQUENCE { +4306 imsi [0] IMSI OPTIONAL, +4307 lmsi [1] LMSI OPTIONAL, +4308 ccbs-Monitoring [2] ReportingState OPTIONAL, +4309 extensionContainer [3] ExtensionContainer OPTIONAL, +4310 ... } +4311 +4312 ReportingState ::= ENUMERATED { +4313 stopMonitoring (0), +4314 startMonitoring (1), +4315 ... } +4316 -- exception handling: +4317 -- reception of values 2-10 shall be mapped to 'stopMonitoring' +4318 -- reception of values > 10 shall be mapped to 'startMonitoring' +4319 +4320 SetReportingStateRes ::= SEQUENCE{ +4321 ccbs-SubscriberStatus [0] CCBS-SubscriberStatus OPTIONAL, +4322 extensionContainer [1] ExtensionContainer OPTIONAL, +4323 ... } +4324 +4325 CCBS-SubscriberStatus ::= ENUMERATED { +4326 ccbsNotIdle (0), +4327 ccbsIdle (1), +4328 ccbsNotReachable (2), +4329 ... } +4330 -- exception handling: +4331 -- reception of values 3-10 shall be mapped to 'ccbsNotIdle' +4332 -- reception of values 11-20 shall be mapped to 'ccbsIdle' +4333 -- reception of values > 20 shall be mapped to 'ccbsNotReachable' +4334 +4335 StatusReportArg ::= SEQUENCE{ +4336 imsi [0] IMSI, +4337 eventReportData [1] EventReportData OPTIONAL, +4338 callReportdata [2] CallReportData OPTIONAL, +4339 extensionContainer [3] ExtensionContainer OPTIONAL, +4340 ... } +4341 +4342 EventReportData ::= SEQUENCE{ +4343 ccbs-SubscriberStatus [0] CCBS-SubscriberStatus OPTIONAL, +4344 extensionContainer [1] ExtensionContainer OPTIONAL, +4345 ... } +4346 + +``` + +``` + +4347 CallReportData ::= SEQUENCE{ +4348 monitoringMode [0] MonitoringMode OPTIONAL, +4349 callOutcome [1] CallOutcome OPTIONAL, +4350 extensionContainer [2] ExtensionContainer OPTIONAL, +4351 ...} +4352 +4353 MonitoringMode ::= ENUMERATED { +4354 a-side (0), +4355 b-side (1), +4356 ...} +4357 -- exception handling: +4358 -- reception of values 2-10 shall be mapped 'a-side' +4359 -- reception of values > 10 shall be mapped to 'b-side' +4360 +4361 CallOutcome ::= ENUMERATED { +4362 success (0), +4363 failure (1), +4364 busy (2), +4365 ...} +4366 -- exception handling: +4367 -- reception of values 3-10 shall be mapped to 'success' +4368 -- reception of values 11-20 shall be mapped to 'failure' +4369 -- reception of values > 20 shall be mapped to 'busy' +4370 +4371 StatusReportRes ::= SEQUENCE { +4372 extensionContainer [0] ExtensionContainer OPTIONAL, +4373 ...} +4374 +4375 RemoteUserFreeArg ::= SEQUENCE{ +4376 imsi [0] IMSI, +4377 callInfo [1] ExternalSignalInfo, +4378 ccbs-Feature [2] CCBS-Feature, +4379 translatedB-Number [3] ISDN-AddressString, +4380 replaceB-Number [4] NULL OPTIONAL, +4381 alertingPattern [5] AlertingPattern OPTIONAL, +4382 extensionContainer [6] ExtensionContainer OPTIONAL, +4383 ...} +4384 +4385 RemoteUserFreeRes ::= SEQUENCE{ +4386 ruf-Outcome [0] RUF-Outcome, +4387 extensionContainer [1] ExtensionContainer OPTIONAL, +4388 ...} +4389 +4390 RUF-Outcome ::= ENUMERATED{ +4391 accepted (0), +4392 rejected (1), +4393 noResponseFromFreeMS (2), -- T4 Expiry +4394 noResponseFromBusyMS (3), -- T10 Expiry +4395 udubFromFreeMS (4), +4396 udubFromBusyMS (5), +4397 ...} +4398 -- exception handling: +4399 -- reception of values 6-20 shall be mapped to 'accepted' +4400 -- reception of values 21-30 shall be mapped to 'rejected' +4401 -- reception of values 31-40 shall be mapped to 'noResponseFromFreeMS' +4402 -- reception of values 41-50 shall be mapped to 'noResponseFromBusyMS' +4403 -- reception of values 51-60 shall be mapped to 'udubFromFreeMS' +4404 -- reception of values > 60 shall be mapped to 'udubFromBusyMS' +4405 +4406 IST-AlertArg ::= SEQUENCE{ +4407 imsi [0] IMSI, +4408 extensionContainer [1] ExtensionContainer OPTIONAL, +4409 ...} +4410 +4411 IST-AlertRes ::= SEQUENCE{ +4412 istAlertTimer [0] IST-AlertTimerValue OPTIONAL, +4413 istInformationWithdraw [1] NULL OPTIONAL, +4414 callTerminationIndicator [2] CallTerminationIndicator OPTIONAL, +4415 extensionContainer [3] ExtensionContainer OPTIONAL, +4416 ...} +4417 +4418 IST-CommandArg ::= SEQUENCE{ +4419 imsi [0] IMSI, +4420 extensionContainer [1] ExtensionContainer OPTIONAL, +4421 ...} +4422 + +``` + +``` + +4423 IST-CommandRes ::= SEQUENCE{ +4424 extensionContainer ExtensionContainer OPTIONAL, +4425 ...} +4426 +4427 CallTerminationIndicator ::= ENUMERATED { +4428 terminateCallActivityReferred (0), +4429 terminateAllCallActivities (1), +4430 ...} +4431 -- exception handling: +4432 -- reception of values 2-10 shall be mapped to ' terminateCallActivityReferred ' +4433 -- reception of values > 10 shall be mapped to ' terminateAllCallActivities ' +4434 +4435 -- In MSCs not supporting linkage of all call activities, any value received shall +4436 -- be interpreted as ' terminateCallActivityReferred ' +4437 +4438 ReleaseResourcesArg ::= SEQUENCE{ +4439 msrn ISDN-AddressString, +4440 extensionContainer ExtensionContainer OPTIONAL, +4441 ...} +4442 +4443 ReleaseResourcesRes ::= SEQUENCE{ +4444 extensionContainer ExtensionContainer OPTIONAL, +4445 ...} +4446 +4447 +4448 END + +``` + +## 4449 17.7.4 Supplementary service data types + +``` + +4450 MAP-SS-DataTypes { +4451 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4452 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +4453 +4454 DEFINITIONS +4455 +4456 IMPLICIT TAGS +4457 +4458 ::= +4459 +4460 BEGIN +4461 +4462 EXPORTS +4463 RegisterSS-Arg, +4464 SS-Info, +4465 SS-Status, +4466 SS-SubscriptionOption, +4467 SS-ForBS-Code, +4468 InterrogateSS-Res, +4469 USSD-Arg, +4470 USSD-Res, +4471 USSD-DataCodingScheme, +4472 USSD-String, +4473 Password, +4474 GuidanceInfo, +4475 SS-List, +4476 SS-InfoList, +4477 OverrideCategory, +4478 CliRestrictionOption, +4479 NoReplyConditionTime, +4480 ForwardingOptions, +4481 maxNumOfSS, +4482 SS-Data, +4483 SS-InvocationNotificationArg, +4484 SS-InvocationNotificationRes, +4485 CCBS-Feature, +4486 RegisterCC-EntryArg, +4487 RegisterCC-EntryRes, +4488 EraseCC-EntryArg, +4489 EraseCC-EntryRes +4490 ; +4491 +4492 IMPORTS +4493 AddressString, +4494 ISDN-AddressString, +4495 ISDN-SubaddressString, +4496 FTN-AddressString, +4497 IMSI, +4498 BasicServiceCode, + +``` + +``` + +4499 AlertingPattern, +4500 EMLPP-Priority, +4501 MaxMC-Bearers, +4502 MC-Bearers, +4503 ExternalSignalInfo +4504 FROM MAP-CommonDataTypes { +4505 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4506 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +4507 +4508 ExtensionContainer +4509 FROM MAP-ExtensionDataTypes { +4510 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4511 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +4512 +4513 SS-Code +4514 FROM MAP-SS-Code { +4515 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4516 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +4517 ; + +``` + +``` + +4518 +4519 +4520 RegisterSS-Arg ::= SEQUENCE { +4521 ss-Code SS-Code, +4522 basicService BasicServiceCode OPTIONAL, +4523 forwardedToNumber [4] AddressString OPTIONAL, +4524 forwardedToSubaddress [6] ISDN-SubaddressString OPTIONAL, +4525 noReplyConditionTime [5] NoReplyConditionTime OPTIONAL, +4526 ..., +4527 defaultPriority [7] EMLPP-Priority OPTIONAL, +4528 nbrUser [8] MC-Bearers OPTIONAL, +4529 longFTN-Supported [9] NULL OPTIONAL } + +``` + +``` + +4530 +4531 NoReplyConditionTime ::= INTEGER (5..30) + +``` + +``` + +4532 +4533 SS-Info ::= CHOICE { +4534 forwardingInfo [0] ForwardingInfo, +4535 callBarringInfo [1] CallBarringInfo, +4536 ss-Data [3] SS-Data} + +``` + +``` + +4537 +4538 ForwardingInfo ::= SEQUENCE { +4539 ss-Code SS-Code OPTIONAL, +4540 forwardingFeatureList ForwardingFeatureList, +4541 ...} + +``` + +``` + +4542 +4543 ForwardingFeatureList ::= +4544 SEQUENCE SIZE (1..maxNumOfBasicServiceGroups) OF +4545 ForwardingFeature + +``` + +``` + +4546 +4547 ForwardingFeature ::= SEQUENCE { +4548 basicService BasicServiceCode OPTIONAL, +4549 ss-Status [4] SS-Status OPTIONAL, +4550 forwardedToNumber [5] ISDN-AddressString OPTIONAL, +4551 forwardedToSubaddress [8] ISDN-SubaddressString OPTIONAL, +4552 forwardingOptions [6] ForwardingOptions OPTIONAL, +4553 noReplyConditionTime [7] NoReplyConditionTime OPTIONAL, +4554 ..., +4555 longForwardedToNumber [9] FTN-AddressString OPTIONAL } + +``` + +``` + +4556 +4557 SS-Status ::= OCTET STRING (SIZE (1)) +4558 +4559 -- bits 8765: 0000 (unused) +4560 -- bits 4321: Used to convey the "P bit", "R bit", "A bit" and "Q bit", +4561 -- representing supplementary service state information +4562 -- as defined in TS 3GPP TS 23.011 [22] +4563 +4564 -- bit 4: "Q bit" +4565 +4566 -- bit 3: "P bit" +4567 +4568 -- bit 2: "R bit" +4569 +4570 -- bit 1: "A bit" + +``` + +``` + +4571 + +``` + +``` + +4572 ForwardingOptions ::= OCTET STRING (SIZE (1)) +4573 +4574 -- bit 8: notification to forwarding party +4575 -- 0 no notification +4576 -- 1 notification +4577 +4578 -- bit 7: redirecting presentation +4579 -- 0 no presentation +4580 -- 1 presentation +4581 +4582 -- bit 6: notification to calling party +4583 -- 0 no notification +4584 -- 1 notification +4585 +4586 -- bit 5: 0 (unused) +4587 +4588 -- bits 43: forwarding reason +4589 -- 00 ms not reachable +4590 -- 01 ms busy +4591 -- 10 no reply +4592 -- 11 unconditional when used in a SRI Result, +4593 -- or call deflection when used in a RCH Argument +4594 -- bits 21: 00 (unused) +4595 +4596 CallBarringInfo ::= SEQUENCE { +4597 ss-Code SS-Code OPTIONAL, +4598 callBarringFeatureList CallBarringFeatureList, +4599 ...} +4600 +4601 CallBarringFeatureList ::= SEQUENCE SIZE (1..maxNumOfBasicServiceGroups) OF +4602 CallBarringFeature +4603 +4604 CallBarringFeature ::= SEQUENCE { +4605 basicService BasicServiceCode OPTIONAL, +4606 ss-Status [4] SS-Status OPTIONAL, +4607 ...} +4608 +4609 SS-Data ::= SEQUENCE { +4610 ss-Code SS-Code OPTIONAL, +4611 ss-Status [4] SS-Status OPTIONAL, +4612 ss-SubscriptionOption SS-SubscriptionOption OPTIONAL, +4613 basicServiceGroupList BasicServiceGroupList OPTIONAL, +4614 ..., +4615 defaultPriority EMLPP-Priority OPTIONAL, +4616 nbrUser [5] MC-Bearers OPTIONAL +4617 } +4618 +4619 SS-SubscriptionOption ::= CHOICE { +4620 cliRestrictionOption [2] CliRestrictionOption, +4621 overrideCategory [1] OverrideCategory} +4622 +4623 CliRestrictionOption ::= ENUMERATED { +4624 permanent (0), +4625 temporaryDefaultRestricted (1), +4626 temporaryDefaultAllowed (2)} +4627 +4628 OverrideCategory ::= ENUMERATED { +4629 overrideEnabled (0), +4630 overrideDisabled (1)} +4631 +4632 SS-ForBS-Code ::= SEQUENCE { +4633 ss-Code SS-Code, +4634 basicService BasicServiceCode OPTIONAL, +4635 ..., +4636 longFTN-Supported [4] NULL OPTIONAL } +4637 +4638 GenericServiceInfo ::= SEQUENCE { +4639 ss-Status SS-Status, +4640 cliRestrictionOption CliRestrictionOption OPTIONAL, +4641 ..., +4642 maximumEntitledPriority [0] EMLPP-Priority OPTIONAL, +4643 defaultPriority [1] EMLPP-Priority OPTIONAL, +4644 ccbs-FeatureList [2] CCBS-FeatureList OPTIONAL, +4645 nbrSB [3] MaxMC-Bearers OPTIONAL, +4646 nbrUser [4] MC-Bearers OPTIONAL, +4647 nbrSN [5] MC-Bearers OPTIONAL } +4648 + +``` + +``` + +4649 CCBS-FeatureList := SEQUENCE SIZE (1..maxNumOfCCBS-Requests) OF +4650 CCBS-Feature +4651 +4652 maxNumOfCCBS-Requests INTEGER := 5 +4653 +4654 CCBS-Feature := SEQUENCE { +4655 ccbs-Index [0] CCBS-Index OPTIONAL, +4656 b-subscriberNumber [1] ISDN-AddressString OPTIONAL, +4657 b-subscriberSubaddress [2] ISDN-SubaddressString OPTIONAL, +4658 basicServiceGroup [3] BasicServiceCode OPTIONAL, +4659 ... } +4660 +4661 CCBS-Index := INTEGER (1..maxNumOfCCBS-Requests) +4662 +4663 InterrogateSS-Res := CHOICE { +4664 ss-Status [0] SS-Status, +4665 basicServiceGroupList [2] BasicServiceGroupList, +4666 forwardingFeatureList [3] ForwardingFeatureList, +4667 genericServiceInfo [4] GenericServiceInfo } +4668 +4669 USSD-Arg := SEQUENCE { +4670 ussd-DataCodingScheme USSD-DataCodingScheme, +4671 ussd-String USSD-String, +4672 ... , +4673 alertingPattern AlertingPattern OPTIONAL, +4674 msisdn [0] ISDN-AddressString OPTIONAL } +4675 +4676 USSD-Res := SEQUENCE { +4677 ussd-DataCodingScheme USSD-DataCodingScheme, +4678 ussd-String USSD-String, +4679 ... } +4680 +4681 USSD-DataCodingScheme := OCTET STRING (SIZE (1)) +4682 -- The structure of the USSD-DataCodingScheme is defined by +4683 -- the Cell Broadcast Data Coding Scheme as described in +4684 -- TS 3GPP TS 23.038 [25] +4685 +4686 USSD-String := OCTET STRING (SIZE (1..maxUSSD-StringLength)) +4687 -- The structure of the contents of the USSD-String is dependent +4688 -- on the USSD-DataCodingScheme as described in TS 3GPP TS 23.038 [25]. +4689 +4690 maxUSSD-StringLength INTEGER := 160 +4691 +4692 Password := NumericString +4693 (FROM ("0"|"1"|"2"|"3"|"4"|"5"|"6"|"7"|"8"|"9")) +4694 (SIZE (4)) +4695 +4696 GuidanceInfo := ENUMERATED { +4697 enterPW (0), +4698 enterNewPW (1), +4699 enterNewPW-Again (2) } +4700 -- How this information is really delivered to the subscriber +4701 -- (display, announcement, ...) is not part of this +4702 -- specification. +4703 +4704 SS-List := SEQUENCE SIZE (1..maxNumOfSS) OF +4705 SS-Code +4706 +4707 maxNumOfSS INTEGER := 30 +4708 +4709 SS-InfoList := SEQUENCE SIZE (1..maxNumOfSS) OF +4710 SS-Info +4711 +4712 BasicServiceGroupList := SEQUENCE SIZE (1..maxNumOfBasicServiceGroups) OF +4713 BasicServiceCode +4714 +4715 maxNumOfBasicServiceGroups INTEGER := 13 +4716 + +``` + +``` + +4717 SS-InvocationNotificationArg ::= SEQUENCE { +4718 imsi [0] IMSI, +4719 msisdn [1] ISDN-AddressString, +4720 ss-Event [2] SS-Code, +4721 -- The following SS-Code values are allowed : +4722 -- ect SS-Code ::= '00110001'B +4723 -- multiPTY SS-Code ::= '01010001'B +4724 -- cd SS-Code ::= '00100100'B +4725 -- ccbs SS-Code ::= '01000100'B +4726 ss-EventSpecification [3] SS-EventSpecification OPTIONAL, +4727 extensionContainer [4] ExtensionContainer OPTIONAL, +4728 ..., +4729 b-subscriberNumber [5] ISDN-AddressString OPTIONAL, +4730 ccbs-RequestState [6] CCBS-RequestState OPTIONAL +4731 } +4732 +4733 CCBS-RequestState ::= ENUMERATED { +4734 request (0), +4735 recall (1), +4736 active (2), +4737 completed (3), +4738 suspended (4), +4739 frozen (5), +4740 deleted (6) +4741 } +4742 +4743 SS-InvocationNotificationRes ::= SEQUENCE { +4744 extensionContainer ExtensionContainer OPTIONAL, +4745 ... +4746 } +4747 +4748 SS-EventSpecification ::= SEQUENCE SIZE (1..maxEventSpecification) OF +4749 AddressString +4750 +4751 maxEventSpecification INTEGER ::= 2 +4752 +4753 RegisterCC-EntryArg ::= SEQUENCE { +4754 ss-Code [0] SS-Code, +4755 ccbs-Data [1] CCBS-Data OPTIONAL, +4756 ...} +4757 +4758 CCBS-Data ::= SEQUENCE { +4759 ccbs-Feature [0] CCBS-Feature, +4760 translatedB-Number [1] ISDN-AddressString, +4761 serviceIndicator [2] ServiceIndicator OPTIONAL, +4762 callInfo [3] ExternalSignalInfo, +4763 networkSignalInfo [4] ExternalSignalInfo, +4764 ...} +4765 +4766 ServiceIndicator ::= BIT STRING { +4767 clir-invoked (0), +4768 camel-invoked (1)} (SIZE(2..32)) +4769 -- exception handling: +4770 -- bits 2 to 31 shall be ignored if received and not understood +4771 +4772 RegisterCC-EntryRes ::= SEQUENCE { +4773 ccbs-Feature [0] CCBS-Feature OPTIONAL, +4774 ...} +4775 +4776 EraseCC-EntryArg ::= SEQUENCE { +4777 ss-Code [0] SS-Code, +4778 ccbs-Index [1] CCBS-Index OPTIONAL, +4779 ...} +4780 +4781 EraseCC-EntryRes ::= SEQUENCE { +4782 ss-Code [0] SS-Code, +4783 ss-Status [1] SS-Status OPTIONAL, +4784 ...} +4785 +4786 END + +``` + +## 4787 17.7.5 Supplementary service codes + +``` + +4788 MAP-SS-Code { +4789 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4790 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +4791 + +``` + +4792 DEFINITIONS + +4793 + +4794 ::= + +4795 + +4796 BEGIN + +4797 + +4798 **SS-Code** ::= OCTET STRING (SIZE (1)) + +4799 -- This type is used to represent the code identifying a single + +4800 -- supplementary service, a group of supplementary services, or + +4801 -- all supplementary services. The services and abbreviations + +4802 -- used are defined in TS 3GPP TS 22.004 [5]. The internal structure is + +4803 -- defined as follows: + +4804 -- + +4805 -- bits 87654321: group (bits 8765), and specific service + +4806 -- (bits 4321) + +4807 + +4808 **allSS** SS-Code ::= '00000000'B + +4809 -- reserved for possible future use + +4810 -- all SS + +4811 + +4812 **allLineIdentificationSS** SS-Code ::= '00010000'B + +4813 -- reserved for possible future use + +4814 -- all line identification SS + +4815 **clip** SS-Code ::= '00010001'B + +4816 -- calling line identification presentation + +4817 **clir** SS-Code ::= '00010010'B + +4818 -- calling line identification restriction + +4819 **colp** SS-Code ::= '00010011'B + +4820 -- connected line identification presentation + +4821 **colr** SS-Code ::= '00010100'B + +4822 -- connected line identification restriction + +4823 **mci** SS-Code ::= '00010101'B + +4824 -- reserved for possible future use + +4825 -- malicious call identification + +4826 + +4827 **allNameIdentificationSS** SS-Code ::= '00011000'B + +4828 -- all name identification SS + +4829 **cnap** SS-Code ::= '00011001'B + +4830 -- calling name presentation + +4831 + +4832 -- SS-Codes '00011010'B to '00011111'B are reserved for future + +4833 -- NameIdentification Supplementary Service use. + +4834 + +4835 **allForwardingSS** SS-Code ::= '00100000'B + +4836 -- all forwarding SS + +4837 **cfu** SS-Code ::= '00100001'B + +4838 -- call forwarding unconditional + +4839 **allCondForwardingSS** SS-Code ::= '00101000'B + +4840 -- all conditional forwarding SS + +4841 **cfb** SS-Code ::= '00101001'B + +4842 -- call forwarding on mobile subscriber busy + +4843 **cfnry** SS-Code ::= '00101010'B + +4844 -- call forwarding on no reply + +4845 **cfnrc** SS-Code ::= '00101011'B + +4846 -- call forwarding on mobile subscriber not reachable + +4847 **cd** SS-Code ::= '00100100'B + +4848 -- call deflection + +4849 + +4850 **allCallOfferingSS** SS-Code ::= '00110000'B + +4851 -- reserved for possible future use + +4852 -- all call offering SS includes also all forwarding SS + +4853 **ect** SS-Code ::= '00110001'B + +4854 -- explicit call transfer + +4855 **mah** SS-Code ::= '00110010'B + +4856 -- reserved for possible future use + +4857 -- mobile access hunting + +4858 + +``` + +4859 allCallCompletionSS SS-Code ::= '01000000'B +4860 -- reserved for possible future use +4861 -- all Call completion SS +4862 cw SS-Code ::= '01000001'B +4863 -- call waiting +4864 hold SS-Code ::= '01000010'B +4865 -- call hold +4866 ccbs-A SS-Code ::= '01000011'B +4867 -- completion of call to busy subscribers, originating side +4868 -- this SS-Code is used only in InsertSubscriberData, DeleteSubscriberData +4869 -- and InterrogateSS +4870 ccbs-B SS-Code ::= '01000100'B +4871 -- completion of call to busy subscribers, destination side +4872 -- this SS-Code is used only in InsertSubscriberData and DeleteSubscriberData +4873 mc SS-Code ::= '01000101'B +4874 -- multicall +4875 +4876 allMultiPartySS SS-Code ::= '01010000'B +4877 -- reserved for possible future use +4878 -- all multiparty SS +4879 multiPTY SS-Code ::= '01010001'B +4880 -- multiparty +4881 +4882 allCommunityOfInterest-SS SS-Code ::= '01100000'B +4883 -- reserved for possible future use +4884 -- all community of interest SS +4885 cug SS-Code ::= '01100001'B +4886 -- closed user group +4887 +4888 allChargingSS SS-Code ::= '01110000'B +4889 -- reserved for possible future use +4890 -- all charging SS +4891 aoci SS-Code ::= '01110001'B +4892 -- advice of charge information +4893 aocc SS-Code ::= '01110010'B +4894 -- advice of charge charging +4895 +4896 allAdditionalInfoTransferSS SS-Code ::= '10000000'B +4897 -- reserved for possible future use +4898 -- all additional information transfer SS +4899 uus1 SS-Code ::= '10000001'B +4900 -- UUS1 user-to-user signalling +4901 uus2 SS-Code ::= '10000010'B +4902 -- UUS2 user-to-user signalling +4903 uus3 SS-Code ::= '10000011'B +4904 -- UUS3 user-to-user signalling +4905 +4906 allBarringSS SS-Code ::= '10010000'B +4907 -- all barring SS +4908 barringOfOutgoingCalls SS-Code ::= '10010001'B +4909 -- barring of outgoing calls +4910 baoc SS-Code ::= '10010010'B +4911 -- barring of all outgoing calls +4912 boic SS-Code ::= '10010011'B +4913 -- barring of outgoing international calls +4914 boicExHC SS-Code ::= '10010100'B +4915 -- barring of outgoing international calls except those directed +4916 -- to the home PLMN Country +4917 barringOfIncomingCalls SS-Code ::= '10011001'B +4918 -- barring of incoming calls +4919 baic SS-Code ::= '10011010'B +4920 -- barring of all incoming calls +4921 bicRoam SS-Code ::= '10011011'B +4922 -- barring of incoming calls when roaming outside home PLMN +4923 -- Country +4924 + +``` + +``` + +4925 allPLMN-specificSS SS-Code ::= '11110000'B +4926 plmn-specificSS-1 SS-Code ::= '11110001'B +4927 plmn-specificSS-2 SS-Code ::= '11110010'B +4928 plmn-specificSS-3 SS-Code ::= '11110011'B +4929 plmn-specificSS-4 SS-Code ::= '11110100'B +4930 plmn-specificSS-5 SS-Code ::= '11110101'B +4931 plmn-specificSS-6 SS-Code ::= '11110110'B +4932 plmn-specificSS-7 SS-Code ::= '11110111'B +4933 plmn-specificSS-8 SS-Code ::= '11111000'B +4934 plmn-specificSS-9 SS-Code ::= '11111001'B +4935 plmn-specificSS-A SS-Code ::= '11111010'B +4936 plmn-specificSS-B SS-Code ::= '11111011'B +4937 plmn-specificSS-C SS-Code ::= '11111100'B +4938 plmn-specificSS-D SS-Code ::= '11111101'B +4939 plmn-specificSS-E SS-Code ::= '11111110'B +4940 plmn-specificSS-F SS-Code ::= '11111111'B +4941 +4942 allCallPrioritySS SS-Code ::= '10100000'B +4943 -- reserved for possible future use +4944 -- all call priority SS +4945 emlpp SS-Code ::= '10100001'B +4946 -- enhanced Multilevel Precedence Pre-emption (EMLPP) service +4947 +4948 allLCSPrivacyException SS-Code ::= '10110000'B +4949 -- all LCS Privacy Exception Classes +4950 universal SS-Code ::= '10110001'B +4951 -- allow location by any LCS client +4952 callSessionRelated SS-Code ::= '10110010'B +4953 -- allow location by any value added LCS client to which a call/session +4954 -- is established from the target MS +4955 callSessionUnrelated SS-Code ::= '10110011'B +4956 -- allow location by designated external value added LCS clients +4957 plmnoperator SS-Code ::= '10110100'B +4958 -- allow location by designated PLMN operator LCS clients +4959 serviceType SS-Code ::= '10110101'B +4960 -- allow location by LCS clients of a designated LCS service type +4961 +4962 allMOLR-SS SS-Code ::= '11000000'B +4963 -- all Mobile Originating Location Request Classes +4964 basicSelfLocation SS-Code ::= '11000001'B +4965 -- allow an MS to request its own location +4966 autonomousSelfLocation SS-Code ::= '11000010'B +4967 -- allow an MS to perform self location without interaction +4968 -- with the PLMN for a predetermined period of time +4969 transferToThirdParty SS-Code ::= '11000011'B +4970 -- allow an MS to request transfer of its location to another LCS client +4971 +4972 END + +``` + +## 4973 17.7.6 Short message data types + +``` + +4974 MAP-SM-DataTypes { +4975 itu-t identified-organization (4) etsi (0) mobileDomain (0) +4976 gsm-Network (1) modules (3) map-SM-DataTypes (16) version21 (21)} +4977 +4978 DEFINITIONS +4979 +4980 IMPLICIT TAGS +4981 +4982 ::= +4983 +4984 BEGIN +4985 +4986 EXPORTS +4987 RoutingInfoForSM-Arg, +4988 RoutingInfoForSM-Res, +4989 MO-ForwardSM-Arg, +4990 MO-ForwardSM-Res, +4991 MT-ForwardSM-Arg, +4992 MT-ForwardSM-Res, +4993 ReportSM-DeliveryStatusArg, +4994 ReportSM-DeliveryStatusRes, +4995 AlertServiceCentreArg, +4996 InformServiceCentreArg, +4997 ReadyForSM-Arg, +4998 ReadyForSM-Res, +4999 SM-DeliveryOutcome, +5000 AlertReason, + +``` + +``` + +5001 Additional-Number, +5002 MT-ForwardSM-VGCS-Arg, +5003 MT-ForwardSM-VGCS-Res +5004 ; +5005 +5006 IMPORTS +5007 AddressString, +5008 ISDN-AddressString, +5009 SignalInfo, +5010 IMSI, +5011 LMSI, +5012 ASCII-CallReference, +5013 Time, +5014 NetworkNodeDiameterAddress, +5015 HLR-Id +5016 +5017 FROM MAP-CommonDataTypes { +5018 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5019 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +5020 +5021 AbsentSubscriberDiagnosticSM +5022 FROM MAP-ER-DataTypes { +5023 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5024 gsm-Network (1) modules (3) map-ER-DataTypes (17) version21 (21)} +5025 +5026 ExtensionContainer +5027 FROM MAP-ExtensionDataTypes { +5028 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5029 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +5030 ; +5031 +5032 +5033 RoutingInfoForSM-Arg ::= SEQUENCE { +5034 msisdn [0] ISDN-AddressString, +5035 sm-RP-PRI [1] BOOLEAN, +5036 serviceCentreAddress [2] AddressString, +5037 extensionContainer [6] ExtensionContainer OPTIONAL, +5038 ... , +5039 gprsSupportIndicator [7] NULL OPTIONAL, +5040 -- gprsSupportIndicator is set only if the SMS-GMSC supports +5041 -- receiving of two numbers from the HLR +5042 sm-RP-MTI [8] SM-RP-MTI OPTIONAL, +5043 sm-RP-SMEA [9] SM-RP-SMEA OPTIONAL, +5044 sm-deliveryNotIntended [10] SM-DeliveryNotIntended OPTIONAL, +5045 ip-sm-gwGuidanceIndicator [11] NULL OPTIONAL, +5046 imsi [12] IMSI OPTIONAL, +5047 t4-Trigger-Indicator [14] NULL OPTIONAL, +5048 singleAttemptDelivery [13] NULL OPTIONAL, +5049 correlationID [15] CorrelationID OPTIONAL, +5050 smsf-supportIndicator [16] NULL OPTIONAL } +5051 +5052 SM-DeliveryNotIntended ::= ENUMERATED { +5053 onlyIMSI-requested (0), +5054 onlyMCC-MNC-requested (1), +5055 ...} +5056 +5057 SM-RP-MTI ::= INTEGER (0..10) +5058 -- 0 SMS Deliver +5059 -- 1 SMS Status Report +5060 -- other values are reserved for future use and shall be discarded if +5061 -- received +5062 +5063 SM-RP-SMEA ::= OCTET STRING (SIZE (1..12)) +5064 -- this parameter contains an address field which is encoded +5065 -- as defined in 3GPP TS 23.040. An address field contains 3 elements : +5066 -- address-length +5067 -- type-of-address +5068 -- address-value +5069 +5070 RoutingInfoForSM-Res ::= SEQUENCE { +5071 imsi IMSI, +5072 locationInfoWithLMSI [0] LocationInfoWithLMSI, +5073 extensionContainer [4] ExtensionContainer OPTIONAL, +5074 ..., +5075 ip-sm-gwGuidance [5] IP-SM-GW-Guidance OPTIONAL } +5076 + +``` + +``` + +5077 IP-SM-GW-Guidance ::= SEQUENCE { +5078 minimumDeliveryTimeValue SM-DeliveryTimerValue, +5079 recommendedDeliveryTimeValue SM-DeliveryTimerValue, +5080 extensionContainer ExtensionContainer OPTIONAL, +5081 ... } +5082 +5083 LocationInfoWithLMSI ::= SEQUENCE { +5084 networkNode-Number [1] ISDN-AddressString, +5085 lmsi LMSI OPTIONAL, +5086 extensionContainer ExtensionContainer OPTIONAL, +5087 ..., +5088 gprsNodeIndicator [5] NULL OPTIONAL, +5089 -- gprsNodeIndicator is set only if the SGSN number is sent as the +5090 -- Network Node Number +5091 additional-Number [6] Additional-Number OPTIONAL, +5092 networkNodeDiameterAddress [7] NetworkNodeDiameterAddress OPTIONAL, +5093 additionalNetworkNodeDiameterAddress [8] NetworkNodeDiameterAddress OPTIONAL, +5094 thirdNumber [9] Additional-Number OPTIONAL, +5095 thirdNetworkNodeDiameterAddress [10] NetworkNodeDiameterAddress OPTIONAL, +5096 imsNodeIndicator [11] NULL OPTIONAL, +5097 -- gprsNodeIndicator and imsNodeIndicator shall not both be present. +5098 -- additionalNumber and thirdNumber shall not both contain the same type of number. +5099 smsf-3gpp-Number [12] ISDN-AddressString OPTIONAL, +5100 smsf-3gpp-DiameterAddress [13] NetworkNodeDiameterAddress OPTIONAL, +5101 smsf-non-3gpp-Number [14] ISDN-AddressString OPTIONAL, +5102 smsf-non-3gpp-DiameterAddress [15] NetworkNodeDiameterAddress OPTIONAL, +5103 smsf-3gpp-address-indicator [16] NULL OPTIONAL, +5104 smsf-non-3gpp-address-indicator [17] NULL OPTIONAL +5105 -- +5106 -- If smsf-supportIndicator was not included in the request, in RoutingInfoForSM-Arg, +5107 -- then smsf-3gpp Number/DiameterAddress, smsf-non-3gpp Number/DiameterAddress and +5108 -- smsf-address-indicator and smsf-non-3gpp-address-indicator shall be absent. +5109 -- +5110 -- If smsf-3gpp-address-indicator is present, it indicates that the networkNode-Number +5111 -- (and networkNodeDiameterAddress, if present) contains the address of an SMSF for +5112 -- 3GPP access. +5113 -- +5114 -- If smsf-non-3gpp-address-indicator is present, it indicates that the +5115 -- networkNode-Number (and networkNodeDiameterAddress, if present) contains the +5116 -- address of an SMSF for non 3GPP access. +5117 -- +5118 -- At most one of gprsNodeIndicator, imsNodeIndicator, smsf-3gpp-address-indicator +5119 -- and smsf-non-3gpp-address-indicator shall be present. Absence of all these +5120 -- indicators indicate that the networkNode-Number (and networkNodeDiameterAddress, +5121 -- if present) contains the address of an MSC/MME. +5122 +5123 } +5124 +5125 Additional-Number ::= CHOICE { +5126 msc-Number [0] ISDN-AddressString, +5127 sgsn-Number [1] ISDN-AddressString} +5128 -- msc-number can be the MSC number or +5129 -- the SMS Router number or the MME number for MT SMS +5130 -- sgsn-number can be the SGSN number or the SMS Router number +5131 +5132 MO-ForwardSM-Arg ::= SEQUENCE { +5133 sm-RP-DA SM-RP-DA, +5134 sm-RP-OA SM-RP-OA, +5135 sm-RP-UI SignalInfo, +5136 extensionContainer ExtensionContainer OPTIONAL, +5137 ... , +5138 imsi IMSI OPTIONAL, +5139 correlationID [0] CorrelationID OPTIONAL, +5140 sm-DeliveryOutcome [1] SM-DeliveryOutcome OPTIONAL +5141 } +5142 +5143 MO-ForwardSM-Res ::= SEQUENCE { +5144 sm-RP-UI SignalInfo OPTIONAL, +5145 extensionContainer ExtensionContainer OPTIONAL, +5146 ... } +5147 + +``` + +``` + +5148 MT-ForwardSM-Arg ::= SEQUENCE { +5149 sm-RP-DA SM-RP-DA, +5150 sm-RP-OA SM-RP-OA, +5151 sm-RP-UI SignalInfo, +5152 moreMessagesToSend NULL OPTIONAL, +5153 extensionContainer ExtensionContainer OPTIONAL, +5154 ..., +5155 smDeliveryTimerValue SM-DeliveryTimerValue OPTIONAL, +5156 smDeliveryStartTime Time OPTIONAL, +5157 smsOverIP-OnlyIndicator [0] NULL OPTIONAL, +5158 correlationID [1] CorrelationID OPTIONAL, +5159 maximumRetransmissionTime [2] Time OPTIONAL, +5160 smsGmscAddress [3] ISDN-AddressString OPTIONAL, +5161 smsGmscDiameterAddress [4] NetworkNodeDiameterAddress OPTIONAL } +5162 -- SM-DeliveryTimerValue contains the value used by the SMS-GMSC +5163 +5164 CorrelationID ::= SEQUENCE { +5165 hlr-id [0] HLR-Id OPTIONAL, +5166 sip-uri-A [1] SIP-URI OPTIONAL, +5167 sip-uri-B [2] SIP-URI} +5168 +5169 SIP-URI ::= OCTET STRING +5170 -- octets are coded as defined in IETF RFC 3261 +5171 +5172 MT-ForwardSM-Res ::= SEQUENCE { +5173 sm-RP-UI SignalInfo OPTIONAL, +5174 extensionContainer ExtensionContainer OPTIONAL, +5175 ... } +5176 +5177 SM-RP-DA ::= CHOICE { +5178 imsi [0] IMSI, +5179 lmsi [1] LMSI, +5180 serviceCentreAddressDA [4] AddressString, +5181 noSM-RP-DA [5] NULL} +5182 +5183 SM-RP-OA ::= CHOICE { +5184 msisdn [2] ISDN-AddressString, +5185 serviceCentreAddressOA [4] AddressString, +5186 noSM-RP-OA [5] NULL} +5187 +5188 SM-DeliveryTimerValue ::= INTEGER (30..600) +5189 + +``` + +``` + +5190 ReportSM-DeliveryStatusArg ::= SEQUENCE { +5191 msisdn ISDN-AddressString, +5192 serviceCentreAddress AddressString, +5193 sm-DeliveryOutcome SM-DeliveryOutcome, +5194 absentSubscriberDiagnosticSM [0] AbsentSubscriberDiagnosticSM +5195 OPTIONAL, +5196 extensionContainer [1] ExtensionContainer OPTIONAL, +5197 ..., +5198 gprsSupportIndicator [2] NULL OPTIONAL, +5199 -- gprsSupportIndicator is set only if the SMS-GMSC supports +5200 -- handling of two delivery outcomes +5201 deliveryOutcomeIndicator [3] NULL OPTIONAL, +5202 -- DeliveryOutcomeIndicator is set when the SM-DeliveryOutcome +5203 -- is for GPRS +5204 additionalSM-DeliveryOutcome [4] SM-DeliveryOutcome OPTIONAL, +5205 -- If received, additionalSM-DeliveryOutcome is for GPRS +5206 -- If DeliveryOutcomeIndicator is set, then AdditionalSM-DeliveryOutcome shall be absent +5207 additionalAbsentSubscriberDiagnosticSM [5] AbsentSubscriberDiagnosticSM OPTIONAL, +5208 -- If received additionalAbsentSubscriberDiagnosticSM is for GPRS +5209 -- If DeliveryOutcomeIndicator is set, then AdditionalAbsentSubscriberDiagnosticSM +5210 -- shall be absent +5211 ip-sm-gw-indicator [6] NULL OPTIONAL, +5212 -- the ip-sm-gw indicator indicates by its presence that sm-deliveryOutcome +5213 -- is for delivery via IMS +5214 -- If present, deliveryOutcomeIndicator shall be absent. +5215 ip-sm-gw-sm-deliveryOutcome [7] SM-DeliveryOutcome OPTIONAL, +5216 -- If received ip-sm-gw-sm-deliveryOutcome is for delivery via IMS +5217 -- If ip-sm-gw-indicator is set, then ip-sm-gw-sm-deliveryOutcome shall be absent +5218 ip-sm-gw-absentSubscriberDiagnosticSM [8] AbsentSubscriberDiagnosticSM OPTIONAL, +5219 -- If received ip-sm-gw-sm-absentSubscriberDiagnosticSM is for delivery via IMS +5220 -- If ip-sm-gw-indicator is set, then ip-sm-gw-sm-absentSubscriberDiagnosticSM +5221 -- shall be absent +5222 imsi [9] IMSI OPTIONAL, +5223 singleAttemptDelivery [10] NULL OPTIONAL, +5224 correlationID [11] CorrelationID OPTIONAL, +5225 smsf-3gpp-deliveryOutcomeIndicator [12] NULL OPTIONAL, +5226 -- smsf-3gpp-deliveryOutcome is set when the SM-DeliveryOutcome +5227 -- is for 3GPP-SMSF +5228 smsf-3gpp-deliveryOutcome [13] SM-DeliveryOutcome OPTIONAL, +5229 -- If smsf-3gpp-deliveryOutcomeIndicator is set, then smsf-3gpp-deliveryOutcome +5230 -- shall be absent +5231 smsf-3gpp-absentSubscriberDiagSM [14] AbsentSubscriberDiagnosticSM OPTIONAL, +5232 -- If smsf-3gpp-deliveryOutcomeIndicator is set, then +5233 -- smsf-3gpp-absentSubscriberDiagSM shall be absent +5234 smsf-non-3gpp-deliveryOutcomeIndicator [15] NULL OPTIONAL, +5235 -- smsf-non-3gpp-deliveryOutcomeIndicator is set when the SM-DeliveryOutcome +5236 -- is for non-3GPP-SMSF +5237 smsf-non-3gpp-deliveryOutcome [16] SM-DeliveryOutcome OPTIONAL, +5238 -- If smsf-non-3gpp-deliveryOutcomeIndicator is set, then smsf-non-3gpp-deliveryOutcome +5239 -- shall be absent +5240 smsf-non-3gpp-absentSubscriberDiagSM [17] AbsentSubscriberDiagnosticSM OPTIONAL +5241 -- If smsf-non-3gpp-deliveryOutcomeIndicator is set, then +5242 -- smsf-non-3gpp-absentSubscriberDiagSM shall be absent +5243 +5244 } + +``` + +``` + +5245 +5246 SM-DeliveryOutcome ::= ENUMERATED { +5247 memoryCapacityExceeded (0), +5248 absentSubscriber (1), +5249 successfulTransfer (2) } + +``` + +``` + +5250 +5251 ReportSM-DeliveryStatusRes ::= SEQUENCE { +5252 storedMSISDN ISDN-AddressString OPTIONAL, +5253 extensionContainer ExtensionContainer OPTIONAL, +5254 ... } + +``` + +``` + +5255 + +``` + +``` + +5256 AlertServiceCentreArg ::= SEQUENCE { +5257 msisdn ISDN-AddressString, +5258 serviceCentreAddress AddressString, +5259 ..., +5260 imsi IMSI OPTIONAL, +5261 correlationID CorrelationID OPTIONAL, +5262 maximumUeAvailabilityTime [0] Time OPTIONAL, +5263 smsGmscAlertEvent [1] SmsGmsc-Alert-Event OPTIONAL, +5264 smsGmscDiameterAddress [2] NetworkNodeDiameterAddress OPTIONAL, +5265 newSGSNNumber [3] ISDN-AddressString OPTIONAL, +5266 newSGSNDiameterAddress [4] NetworkNodeDiameterAddress OPTIONAL, +5267 newMMENumber [5] ISDN-AddressString OPTIONAL, +5268 newMMDiameterAddress [6] NetworkNodeDiameterAddress OPTIONAL, +5269 newMSCNumber [7] ISDN-AddressString OPTIONAL } +5270 +5271 SmsGmsc-Alert-Event ::= ENUMERATED { +5272 msAvailableForMtSms (0), +5273 msUnderNewServingNode (1) } +5274 +5275 InformServiceCentreArg ::= SEQUENCE { +5276 storedMSISDN ISDN-AddressString OPTIONAL, +5277 mw-Status MW-Status OPTIONAL, +5278 extensionContainer ExtensionContainer OPTIONAL, +5279 ..., +5280 absentSubscriberDiagnosticSM AbsentSubscriberDiagnosticSM OPTIONAL, +5281 additionalAbsentSubscriberDiagnosticSM [0] AbsentSubscriberDiagnosticSM OPTIONAL, +5282 -- additionalAbsentSubscriberDiagnosticSM may be present only if +5283 -- absentSubscriberDiagnosticSM is present. +5284 -- if included, additionalAbsentSubscriberDiagnosticSM is for GPRS and +5285 -- absentSubscriberDiagnosticSM is for non-GPRS +5286 smsf3gppAbsentSubscriberDiagnosticSM [1] AbsentSubscriberDiagnosticSM OPTIONAL, +5287 smsfNon3gppAbsentSubscriberDiagnosticSM [2] AbsentSubscriberDiagnosticSM OPTIONAL } +5288 +5289 MW-Status ::= BIT STRING { +5290 sc-AddressNotIncluded (0), +5291 mnrf-Set (1), +5292 mcef-Set (2), +5293 mnrg-Set (3), +5294 mnr5g-Set (4), +5295 mnr5gn3g-Set (5)} (SIZE (6..16)) +5296 -- exception handling: +5297 -- bits 6 to 15 shall be ignored if received and not understood +5298 +5299 ReadyForSM-Arg ::= SEQUENCE { +5300 imsi [0] IMSI, +5301 alertReason AlertReason, +5302 alertReasonIndicator NULL OPTIONAL, +5303 -- alertReasonIndicator is set only when the alertReason +5304 -- sent to HLR is for GPRS +5305 extensionContainer ExtensionContainer OPTIONAL, +5306 ..., +5307 additionalAlertReasonIndicator [1] NULL OPTIONAL, +5308 -- additionalAlertReasonIndicator is set only when the alertReason +5309 -- sent to HLR is for IP-SM-GW +5310 maximumUeAvailabilityTime Time OPTIONAL } +5311 +5312 ReadyForSM-Res ::= SEQUENCE { +5313 extensionContainer ExtensionContainer OPTIONAL, +5314 ...} +5315 +5316 AlertReason ::= ENUMERATED { +5317 ms-Present (0), +5318 memoryAvailable (1)} +5319 +5320 MT-ForwardSM-VGCS-Arg ::= SEQUENCE { +5321 asciCallReference ASCI-CallReference, +5322 sm-RP-OA SM-RP-OA, +5323 sm-RP-UI SignalInfo, +5324 extensionContainer ExtensionContainer OPTIONAL, +5325 ...} +5326 + +``` + +``` + +5327 MT-ForwardSM-VGCS-Res ::= SEQUENCE { +5328 sm-RP-UI [0] SignalInfo OPTIONAL, +5329 dispatcherList [1] DispatcherList OPTIONAL, +5330 ongoingCall NULL OPTIONAL, +5331 extensionContainer [2] ExtensionContainer OPTIONAL, +5332 ..., +5333 additionalDispatcherList [3] AdditionalDispatcherList OPTIONAL } +5334 -- additionalDispatcherList shall be absent if dispatcherList is absent or +5335 -- contains less than 5 ISDN-AddressStrings +5336 +5337 DispatcherList ::= +5338 SEQUENCE SIZE (1..maxNumOfDispatchers) OF +5339 ISDN-AddressString +5340 +5341 maxNumOfDispatchers INTEGER ::= 5 +5342 +5343 AdditionalDispatcherList ::= +5344 SEQUENCE SIZE (1..maxNumOfAdditionalDispatchers) OF +5345 ISDN-AddressString +5346 +5347 maxNumOfAdditionalDispatchers INTEGER ::= 15 +5348 +5349 +5350 END + +``` + +## 5351 17.7.7 Error data types + +``` + +5352 MAP-ER-DataTypes { +5353 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5354 gsm-Network (1) modules (3) map-ER-DataTypes (17) version21 (21)} +5355 +5356 DEFINITIONS +5357 +5358 IMPLICIT TAGS +5359 +5360 ::= +5361 +5362 BEGIN +5363 +5364 EXPORTS +5365 RoamingNotAllowedParam, +5366 CallBarredParam, +5367 CUG-RejectParam, +5368 SS-IncompatibilityCause, +5369 PW-RegistrationFailureCause, +5370 SM-DeliveryFailureCause, +5371 SystemFailureParam, +5372 DataMissingParam, +5373 UnexpectedDataParam, +5374 FacilityNotSupParam, +5375 OR-NotAllowedParam, +5376 UnknownSubscriberParam, +5377 NumberChangedParam, +5378 UnidentifiedSubParam, +5379 IllegalSubscriberParam, +5380 IllegalEquipmentParam, +5381 BearerServNotProvParam, +5382 TeleservNotProvParam, +5383 TracingBufferFullParam, +5384 NoRoamingNbParam, +5385 AbsentSubscriberParam, +5386 BusySubscriberParam, +5387 NoSubscriberReplyParam, +5388 ForwardingViolationParam, +5389 ForwardingFailedParam, +5390 ATI-NotAllowedParam, +5391 SubBusyForMT-SMS-Param, +5392 MessageWaitListFullParam, +5393 AbsentSubscriberSM-Param, +5394 AbsentSubscriberDiagnosticSM, +5395 ResourceLimitationParam, +5396 NoGroupCallNbParam, +5397 IncompatibleTerminalParam, +5398 ShortTermDenialParam, +5399 LongTermDenialParam, +5400 UnauthorizedRequestingNetwork-Param, +5401 UnauthorizedLCSClient-Param, +5402 PositionMethodFailure-Param, + +``` + +``` + +5403 UnknownOrUnreachableLCSCliet-Param, +5404 MM-EventNotSupported-Param, +5405 ATSI-NotAllowedParam, +5406 ATM-NotAllowedParam, +5407 IllegalSS-OperationParam, +5408 SS-NotAvailableParam, +5409 SS-SubscriptionViolationParam, +5410 InformationNotAvailableParam, +5411 TargetCellOutsideGCA-Param, +5412 OngoingGroupCallParam, +5413 PositionMethodFailure-Diagnostic, +5414 UnauthorizedLCSCliet-Diagnostic +5415 +5416 ; +5417 +5418 IMPORTS +5419 SS-Status +5420 FROM MAP-SS-DataTypes { +5421 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5422 gsm-Network (1) modules (3) map-SS-DataTypes (14) version21 (21)} +5423 +5424 SignalInfo, +5425 BasicServiceCode, +5426 NetworkResource, +5427 AdditionalNetworkResource, +5428 IMSI, +5429 Time +5430 FROM MAP-CommonDataTypes { +5431 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5432 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +5433 +5434 +5435 SS-Code +5436 FROM MAP-SS-Code { +5437 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5438 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +5439 +5440 ExtensionContainer +5441 FROM MAP-ExtensionDataTypes { +5442 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5443 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +5444 ; +5445 +5446 RoamingNotAllowedParam ::= SEQUENCE { +5447 roamingNotAllowedCause RoamingNotAllowedCause, +5448 extensionContainer ExtensionContainer OPTIONAL, +5449 ..., +5450 additionalRoamingNotAllowedCause [0] AdditionalRoamingNotAllowedCause OPTIONAL } +5451 +5452 -- if the additionalRoamingNotAllowedCause is received by the MSC/VLR or SGSN then the +5453 -- roamingNotAllowedCause shall be discarded. +5454 +5455 AdditionalRoamingNotAllowedCause ::= ENUMERATED { +5456 supportedRAT-TypesNotAllowed (0), +5457 ...} +5458 +5459 RoamingNotAllowedCause ::= ENUMERATED { +5460 plmnRoamingNotAllowed (0), +5461 operatorDeterminedBarring (3)} +5462 +5463 CallBarredParam ::= CHOICE { +5464 callBarringCause CallBarringCause, +5465 -- call BarringCause must not be used in version 3 and higher +5466 extensibleCallBarredParam ExtensibleCallBarredParam +5467 -- extensibleCallBarredParam must not be used in version <3 +5468 } +5469 +5470 CallBarringCause ::= ENUMERATED { +5471 barringServiceActive (0), +5472 operatorBarring (1)} +5473 + +``` + +``` + +5474 ExtensibleCallBarredParam ::= SEQUENCE { +5475 callBarringCause CallBarringCause OPTIONAL, +5476 extensionContainer ExtensionContainer OPTIONAL, +5477 ... , +5478 unauthorisedMessageOriginator [1] NULL OPTIONAL, +5479 anonymousCallRejection [2] NULL OPTIONAL } +5480 +5481 -- unauthorisedMessageOriginator and anonymousCallRejection shall be mutually exclusive. +5482 +5483 +5484 CUG-RejectParam ::= SEQUENCE { +5485 cug-RejectCause CUG-RejectCause OPTIONAL, +5486 extensionContainer ExtensionContainer OPTIONAL, +5487 ... } +5488 +5489 CUG-RejectCause ::= ENUMERATED { +5490 incomingCallsBarredWithinCUG (0), +5491 subscriberNotMemberOfCUG (1), +5492 requestedBasicServiceViolatesCUG-Constraints (5), +5493 calledPartySS-InteractionViolation (7) } +5494 +5495 SS-IncompatibilityCause ::= SEQUENCE { +5496 ss-Code [1] SS-Code OPTIONAL, +5497 basicService BasicServiceCode OPTIONAL, +5498 ss-Status [4] SS-Status OPTIONAL, +5499 ... } +5500 +5501 PW-RegistrationFailureCause ::= ENUMERATED { +5502 undetermined (0), +5503 invalidFormat (1), +5504 newPasswordsMismatch (2) } +5505 +5506 SM-EnumeratedDeliveryFailureCause ::= ENUMERATED { +5507 memoryCapacityExceeded (0), +5508 equipmentProtocolError (1), +5509 equipmentNotSM-Equipped (2), +5510 unknownServiceCentre (3), +5511 sc-Congestion (4), +5512 invalidSME-Address (5), +5513 subscriberNotSC-Subscriber (6) } +5514 +5515 SM-DeliveryFailureCause ::= SEQUENCE { +5516 sm-EnumeratedDeliveryFailureCause SM-EnumeratedDeliveryFailureCause, +5517 diagnosticInfo SignalInfo OPTIONAL, +5518 extensionContainer ExtensionContainer OPTIONAL, +5519 ... } +5520 +5521 AbsentSubscriberSM-Param ::= SEQUENCE { +5522 absentSubscriberDiagnosticSM AbsentSubscriberDiagnosticSM OPTIONAL, +5523 -- AbsentSubscriberDiagnosticSM can be either for non-GPRS +5524 -- or for GPRS +5525 extensionContainer ExtensionContainer OPTIONAL, +5526 ..., +5527 additionalAbsentSubscriberDiagnosticSM [0] AbsentSubscriberDiagnosticSM OPTIONAL, +5528 -- if received, additionalAbsentSubscriberDiagnosticSM +5529 -- is for GPRS and absentSubscriberDiagnosticSM is +5530 -- for non-GPRS +5531 imsi [1] IMSI OPTIONAL, +5532 -- when sent from HLR to IP-SM-GW, IMSI shall be present if UNRI is not set +5533 -- to indicate that the absent condition is met for CS and PS but not for IMS. +5534 requestedRetransmissionTime [2] Time OPTIONAL, +5535 userIdentifierAlert [3] IMSI OPTIONAL } +5536 +5537 AbsentSubscriberDiagnosticSM ::= INTEGER (0..255) +5538 -- AbsentSubscriberDiagnosticSM values are defined in 3GPP TS 23.040 +5539 +5540 SystemFailureParam ::= CHOICE { +5541 networkResource NetworkResource, +5542 -- networkResource must not be used in version 3 +5543 extensibleSystemFailureParam ExtensibleSystemFailureParam +5544 -- extensibleSystemFailureParam must not be used in version <3 +5545 } +5546 + +``` + +``` + +5547 ExtensibleSystemFailureParam ::= SEQUENCE { +5548 networkResource NetworkResource OPTIONAL, +5549 extensionContainer ExtensionContainer OPTIONAL, +5550 ..., +5551 additionalNetworkResource [0] AdditionalNetworkResource OPTIONAL, +5552 failureCauseParam [1] FailureCauseParam OPTIONAL } +5553 +5554 FailureCauseParam ::= ENUMERATED { +5555 limitReachedOnNumberOfConcurrentLocationRequests (0), +5556 ... } +5557 -- if unknown value is received in FailureCauseParam it shall be ignored +5558 +5559 +5560 DataMissingParam ::= SEQUENCE { +5561 extensionContainer ExtensionContainer OPTIONAL, +5562 ...} +5563 +5564 UnexpectedDataParam ::= SEQUENCE { +5565 extensionContainer ExtensionContainer OPTIONAL, +5566 ..., +5567 unexpectedSubscriber [0] NULL OPTIONAL} +5568 -- the unexpectedSubscriber indication in the unexpectedDataValue error shall not be used +5569 -- for operations that allow the unidentifiedSubscriber error. +5570 +5571 FacilityNotSupParam ::= SEQUENCE { +5572 extensionContainer ExtensionContainer OPTIONAL, +5573 ..., +5574 shapeOfLocationEstimateNotSupported [0] NULL OPTIONAL, +5575 neededLcsCapabilityNotSupportedInServingNode [1] NULL OPTIONAL } +5576 +5577 OR-NotAllowedParam ::= SEQUENCE { +5578 extensionContainer ExtensionContainer OPTIONAL, +5579 ...} +5580 +5581 UnknownSubscriberParam ::= SEQUENCE { +5582 extensionContainer ExtensionContainer OPTIONAL, +5583 ..., +5584 unknownSubscriberDiagnostic UnknownSubscriberDiagnostic OPTIONAL} +5585 +5586 UnknownSubscriberDiagnostic ::= ENUMERATED { +5587 imsiUnknown (0), +5588 gprs-eps-SubscriptionUnknown (1), +5589 ..., +5590 npdbMismatch (2)} +5591 -- if unknown values are received in +5592 -- UnknownSubscriberDiagnostic they shall be discarded +5593 +5594 NumberChangedParam ::= SEQUENCE { +5595 extensionContainer ExtensionContainer OPTIONAL, +5596 ...} +5597 +5598 UnidentifiedSubParam ::= SEQUENCE { +5599 extensionContainer ExtensionContainer OPTIONAL, +5600 ...} +5601 +5602 IllegalSubscriberParam ::= SEQUENCE { +5603 extensionContainer ExtensionContainer OPTIONAL, +5604 ...} +5605 +5606 IllegalEquipmentParam ::= SEQUENCE { +5607 extensionContainer ExtensionContainer OPTIONAL, +5608 ...} +5609 +5610 BearerServNotProvParam ::= SEQUENCE { +5611 extensionContainer ExtensionContainer OPTIONAL, +5612 ...} +5613 +5614 TeleservNotProvParam ::= SEQUENCE { +5615 extensionContainer ExtensionContainer OPTIONAL, +5616 ...} +5617 +5618 TracingBufferFullParam ::= SEQUENCE { +5619 extensionContainer ExtensionContainer OPTIONAL, +5620 ...} +5621 + +``` + +``` + +5622 NoRoamingNbParam ::= SEQUENCE { +5623 extensionContainer ExtensionContainer OPTIONAL, +5624 ...} +5625 +5626 AbsentSubscriberParam ::= SEQUENCE { +5627 extensionContainer ExtensionContainer OPTIONAL, +5628 ..., +5629 absentSubscriberReason [0] AbsentSubscriberReason OPTIONAL} +5630 +5631 AbsentSubscriberReason ::= ENUMERATED { +5632 imsiDetach (0), +5633 restrictedArea (1), +5634 noPageResponse (2), +5635 ... , +5636 purgedMS (3), +5637 mtRoamingRetry (4), +5638 busySubscriber (5)} +5639 -- exception handling: at reception of other values than the ones listed the +5640 -- AbsentSubscriberReason shall be ignored. +5641 -- The AbsentSubscriberReason: purgedMS is defined for the Super-Charger feature +5642 -- (see TS 23.116). If this value is received in a Provide Roaming Number response +5643 -- it shall be mapped to the AbsentSubscriberReason: imsiDetach in the Send Routeing +5644 -- Information response +5645 -- The AbsentSubscriberReason: mtRoamingRetry is used during MT Roaming Retry, +5646 -- see 3GPP TS 23.018[97]. +5647 -- The AbsentSubscriberReason: busySubscriber is used during MT Roaming Forwarding, +5648 -- see 3GPP TS 23.018[97]. +5649 +5650 BusySubscriberParam ::= SEQUENCE { +5651 extensionContainer ExtensionContainer OPTIONAL, +5652 ..., +5653 ccbs-Possible [0] NULL OPTIONAL, +5654 ccbs-Busy [1] NULL OPTIONAL} +5655 +5656 NoSubscriberReplyParam ::= SEQUENCE { +5657 extensionContainer ExtensionContainer OPTIONAL, +5658 ...} +5659 +5660 ForwardingViolationParam ::= SEQUENCE { +5661 extensionContainer ExtensionContainer OPTIONAL, +5662 ...} +5663 +5664 ForwardingFailedParam ::= SEQUENCE { +5665 extensionContainer ExtensionContainer OPTIONAL, +5666 ...} +5667 +5668 ATI-NotAllowedParam ::= SEQUENCE { +5669 extensionContainer ExtensionContainer OPTIONAL, +5670 ...} +5671 +5672 ATSI-NotAllowedParam ::= SEQUENCE { +5673 extensionContainer ExtensionContainer OPTIONAL, +5674 ...} +5675 +5676 ATM-NotAllowedParam ::= SEQUENCE { +5677 extensionContainer ExtensionContainer OPTIONAL, +5678 ...} +5679 +5680 IllegalSS-OperationParam ::= SEQUENCE { +5681 extensionContainer ExtensionContainer OPTIONAL, +5682 ...} +5683 +5684 SS-NotAvailableParam ::= SEQUENCE { +5685 extensionContainer ExtensionContainer OPTIONAL, +5686 ...} +5687 +5688 SS-SubscriptionViolationParam ::= SEQUENCE { +5689 extensionContainer ExtensionContainer OPTIONAL, +5690 ...} +5691 +5692 InformationNotAvailableParam ::= SEQUENCE { +5693 extensionContainer ExtensionContainer OPTIONAL, +5694 ...} +5695 + +``` + +``` + +5696 SubBusyForMT-SMS-Param ::= SEQUENCE { +5697 extensionContainer ExtensionContainer OPTIONAL, +5698 ... , +5699 gprsConnectionSuspended NULL OPTIONAL } +5700 -- If GprsConnectionSuspended is not understood it shall +5701 -- be discarded +5702 +5703 MessageWaitListFullParam ::= SEQUENCE { +5704 extensionContainer ExtensionContainer OPTIONAL, +5705 ... } +5706 +5707 ResourceLimitationParam ::= SEQUENCE { +5708 extensionContainer ExtensionContainer OPTIONAL, +5709 ... } +5710 +5711 NoGroupCallNbParam ::= SEQUENCE { +5712 extensionContainer ExtensionContainer OPTIONAL, +5713 ... } +5714 +5715 IncompatibleTerminalParam ::= SEQUENCE { +5716 extensionContainer ExtensionContainer OPTIONAL, +5717 ... } +5718 +5719 ShortTermDenialParam ::= SEQUENCE { +5720 ... } +5721 +5722 LongTermDenialParam ::= SEQUENCE { +5723 ... } +5724 +5725 UnauthorizedRequestingNetwork-Param ::= SEQUENCE { +5726 extensionContainer ExtensionContainer OPTIONAL, +5727 ... } +5728 +5729 UnauthorizedLCSCliet-Param ::= SEQUENCE { +5730 unauthorizedLCSCliet-Diagnostic [0] UnauthorizedLCSCliet-Diagnostic OPTIONAL, +5731 extensionContainer [1] ExtensionContainer OPTIONAL, +5732 ... } +5733 +5734 UnauthorizedLCSCliet-Diagnostic ::= ENUMERATED { +5735 noAdditionalInformation (0), +5736 clientNotInMSPrivacyExceptionList (1), +5737 callToClientNotSetup (2), +5738 privacyOverrideNotApplicable (3), +5739 disallowedByLocalRegulatoryRequirements (4), +5740 ..., +5741 unauthorizedPrivacyClass (5), +5742 unauthorizedCallSessionUnrelatedExternalClient (6), +5743 unauthorizedCallSessionRelatedExternalClient (7) } +5744 -- exception handling: +5745 -- any unrecognized value shall be ignored +5746 +5747 PositionMethodFailure-Param ::= SEQUENCE { +5748 positionMethodFailure-Diagnostic [0] PositionMethodFailure-Diagnostic OPTIONAL, +5749 extensionContainer [1] ExtensionContainer OPTIONAL, +5750 ... } +5751 +5752 PositionMethodFailure-Diagnostic ::= ENUMERATED { +5753 congestion (0), +5754 insufficientResources (1), +5755 insufficientMeasurementData (2), +5756 inconsistentMeasurementData (3), +5757 locationProcedureNotCompleted (4), +5758 locationProcedureNotSupportedByTargetMS (5), +5759 qosNotAttainable (6), +5760 positionMethodNotAvailableInNetwork (7), +5761 positionMethodNotAvailableInLocationArea (8), +5762 ... } +5763 -- exception handling: +5764 -- any unrecognized value shall be ignored +5765 +5766 UnknownOrUnreachableLCSCliet-Param ::= SEQUENCE { +5767 extensionContainer ExtensionContainer OPTIONAL, +5768 ... } +5769 +5770 MM-EventNotSupported-Param ::= SEQUENCE { + +``` + +``` + +5771 extensionContainer ExtensionContainer OPTIONAL, +5772 ...} +5773 +5774 TargetCellOutsideGCA-Param ::= SEQUENCE { +5775 extensionContainer ExtensionContainer OPTIONAL, +5776 ...} +5777 +5778 OngoingGroupCallParam ::= SEQUENCE { +5779 extensionContainer ExtensionContainer OPTIONAL, +5780 ...} +5781 +5782 +5783 END + +``` + +## 5784 17.7.8 Common data types + +``` + +5785 MAP-CommonDataTypes { +5786 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5787 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +5788 +5789 DEFINITIONS +5790 +5791 IMPLICIT TAGS +5792 +5793 ::= +5794 +5795 BEGIN +5796 +5797 EXPORTS +5798 +5799 -- general data types and values +5800 AddressString, +5801 ISDN-AddressString, +5802 maxISDN-AddressLength, +5803 FTN-AddressString, +5804 ISDN-SubaddressString, +5805 ExternalSignalInfo, +5806 Ext-ExternalSignalInfo, +5807 AccessNetworkSignalInfo, +5808 SignalInfo, +5809 maxSignalInfoLength, +5810 AlertingPattern, +5811 TBCD-STRING, +5812 DiameterIdentity, +5813 Time, +5814 HLR-Id, +5815 +5816 -- data types for numbering and identification +5817 IMSI, +5818 TMSI, +5819 Identity, +5820 SubscriberId, +5821 IMEI, +5822 HLR-List, +5823 LMSI, +5824 GlobalCellId, +5825 NetworkResource, +5826 AdditionalNetworkResource, +5827 NAEA-PreferredCI, +5828 NAEA-CIC, +5829 ASCI-CallReference, +5830 SubscriberIdentity, +5831 PLMN-Id, +5832 E-UTRAN-CGI, +5833 NR-CGI, +5834 TA-Id, +5835 NR-TA-Id, +5836 RAIdentity, +5837 NetworkNodeDiameterAddress, +5838 +5839 -- data types for CAMEL +5840 CellGlobalIdOrServiceAreaIdOrLAI, +5841 CellGlobalIdOrServiceAreaIdFixedLength, +5842 LAIFixedLength, +5843 +5844 -- data types for subscriber management +5845 BasicServiceCode, +5846 Ext-BasicServiceCode, + +``` + +``` + +5847 EMLPP-Info, +5848 EMLPP-Priority, +5849 MC-SS-Info, +5850 MaxMC-Bearers, +5851 MC-Bearers, +5852 Ext-SS-Status, +5853 +5854 -- data types for geographic location +5855 AgeOfLocationInformation, +5856 LCSCClientExternalID, +5857 LCSCClientInternalID, +5858 LCSServiceTypeID, +5859 +5860 -- gprs location registration types +5861 GSN-Address +5862 +5863 ; +5864 +5865 IMPORTS +5866 TeleserviceCode, +5867 Ext-TeleserviceCode +5868 FROM MAP-TS-Code { +5869 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5870 gsm-Network (1) modules (3) map-TS-Code (19) version21 (21)} +5871 +5872 BearerServiceCode, +5873 Ext-BearerServiceCode +5874 FROM MAP-BS-Code { +5875 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5876 gsm-Network (1) modules (3) map-BS-Code (20) version21 (21)} +5877 +5878 SS-Code +5879 FROM MAP-SS-Code { +5880 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5881 gsm-Network (1) modules (3) map-SS-Code (15) version21 (21)} +5882 +5883 ExtensionContainer +5884 FROM MAP-ExtensionDataTypes { +5885 itu-t identified-organization (4) etsi (0) mobileDomain (0) +5886 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +5887 ; +5888 +5889 +5890 -- general data types +5891 +5892 TBCD-STRING ::= OCTET STRING +5893 -- This type (Telephony Binary Coded Decimal String) is used to +5894 -- represent several digits from 0 through 9, *, #, a, b, c, two +5895 -- digits per octet, each digit encoded 0000 to 1001 (0 to 9), +5896 -- 1010 (*), 1011 (#), 1100 (a), 1101 (b) or 1110 (c); 1111 used +5897 -- as filler when there is an odd number of digits. +5898 +5899 -- bits 8765 of octet n encoding digit 2n +5900 -- bits 4321 of octet n encoding digit 2(n-1) +1 +5901 +5902 DiameterIdentity ::= OCTET STRING (SIZE(9..255)) +5903 -- content of DiameterIdentity is defined in IETF RFC 3588 [139] +5904 + +``` + +``` + +5905 AddressString ::= OCTET STRING (SIZE (1..maxAddressLength)) +5906 -- This type is used to represent a number for addressing +5907 -- purposes. It is composed of +5908 -- a) one octet for nature of address, and numbering plan +5909 -- indicator. +5910 -- b) digits of an address encoded as TBCD-String. +5911 +5912 -- a) The first octet includes a one bit extension indicator, a +5913 -- 3 bits nature of address indicator and a 4 bits numbering +5914 -- plan indicator, encoded as follows: +5915 +5916 -- bit 8: 1 (no extension) +5917 +5918 -- bits 765: nature of address indicator +5919 -- 000 unknown +5920 -- 001 international number +5921 -- 010 national significant number +5922 -- 011 network specific number +5923 -- 100 subscriber number +5924 -- 101 reserved +5925 -- 110 abbreviated number +5926 -- 111 reserved for extension +5927 +5928 -- bits 4321: numbering plan indicator +5929 -- 0000 unknown +5930 -- 0001 ISDN/Telephony Numbering Plan (Rec ITU-T E.164) +5931 -- 0010 spare +5932 -- 0011 data numbering plan (ITU-T Rec X.121) +5933 -- 0100 telex numbering plan (ITU-T Rec F.69) +5934 -- 0101 spare +5935 -- 0110 land mobile numbering plan (ITU-T Rec E.212) +5936 -- 0111 spare +5937 -- 1000 national numbering plan +5938 -- 1001 private numbering plan +5939 -- 1111 reserved for extension +5940 +5941 -- all other values are reserved. +5942 +5943 -- b) The following octets representing digits of an address +5944 -- encoded as a TBCD-STRING. + +``` + +5945 + +| | +|---------------------------------------------| +| 5946 maxAddressLength INTEGER ::= 20 | +|---------------------------------------------| + +5947 + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------| +| 5948 ISDN-AddressString ::= 5949 AddressString (SIZE (1..maxISDN-AddressLength)) 5950 -- This type is used to represent ISDN numbers. | +|----------------------------------------------------------------------------------------------------------------------------------------------| + +5951 + +| | +|-------------------------------------------------| +| 5952 maxISDN-AddressLength INTEGER ::= 9 | +|-------------------------------------------------| + +5953 + +| | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5954 FTN-AddressString ::= 5955 AddressString (SIZE (1..maxFTN-AddressLength)) 5956 -- This type is used to represent forwarded-to numbers. 5957 -- If NAI = international the first digits represent the country code (CC) 5958 -- and the network destination code (NDC) as for E.164. | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +5959 + +| | +|-------------------------------------------------| +| 5960 maxFTN-AddressLength INTEGER ::= 15 | +|-------------------------------------------------| + +5961 + +``` + +5962 ISDN-SubaddressString ::= +5963 OCTET STRING (SIZE (1..maxISDN-SubaddressLength)) +5964 -- This type is used to represent ISDN subaddresses. +5965 -- It is composed of +5966 -- a) one octet for type of subaddress and odd/even indicator. +5967 -- b) 20 octets for subaddress information. +5968 +5969 -- a) The first octet includes a one bit extension indicator, a +5970 -- 3 bits type of subaddress and a one bit odd/even indicator, +5971 -- encoded as follows: +5972 +5973 -- bit 8: 1 (no extension) +5974 +5975 -- bits 765: type of subaddress +5976 -- 000 NSAP (X.213/ISO 8348 AD2) +5977 -- 010 User Specified +5978 -- All other values are reserved +5979 +5980 -- bit 4: odd/even indicator +5981 -- 0 even number of address signals +5982 -- 1 odd number of address signals +5983 -- The odd/even indicator is used when the type of subaddress +5984 -- is "user specified" and the coding is BCD. +5985 +5986 -- bits 321: 000 (unused) +5987 +5988 -- b) Subaddress information. +5989 -- The NSAP X.213/ISO8348AD2 address shall be formatted as specified +5990 -- by octet 4 which contains the Authority and Format Identifier +5991 -- (AFI). The encoding is made according to the "preferred binary +5992 -- encoding" as defined in X.213/ISO8348AD2. For the definition +5993 -- of this type of subaddress, see ITU-T Rec I.334. +5994 +5995 -- For User-specific subaddress, this field is encoded according +5996 -- to the user specification, subject to a maximum length of 20 +5997 -- octets. When interworking with X.25 networks BCD coding should +5998 -- be applied. +5999 +6000 maxISDN-SubaddressLength INTEGER ::= 21 +6001 +6002 ExternalSignalInfo ::= SEQUENCE { +6003 protocolId ProtocolId, +6004 signalInfo SignalInfo, +6005 -- Information about the internal structure is given in +6006 -- clause 7.6.9. +6007 extensionContainer ExtensionContainer OPTIONAL, +6008 -- extensionContainer must not be used in version 2 +6009 ...} +6010 +6011 SignalInfo ::= OCTET STRING (SIZE (1..maxSignalInfoLength)) +6012 +6013 maxSignalInfoLength INTEGER ::= 200 +6014 -- This NamedValue represents the theoretical maximum number of octets which is +6015 -- available to carry a single instance of the SignalInfo data type, +6016 -- without requiring segmentation to cope with the network layer service. +6017 -- However, the actual maximum size available for an instance of the data +6018 -- type may be lower, especially when other information elements +6019 -- have to be included in the same component. +6020 +6021 ProtocolId ::= ENUMERATED { +6022 gsm-0408 (1), +6023 gsm-0806 (2), +6024 gsm-BSSMAP (3), +6025 -- Value 3 is reserved and must not be used +6026 ets-300102-1 (4) } +6027 +6028 Ext-ExternalSignalInfo ::= SEQUENCE { +6029 ext-ProtocolId Ext-ProtocolId, +6030 signalInfo SignalInfo, +6031 -- Information about the internal structure is given in +6032 -- clause 7.6.9.10 +6033 extensionContainer ExtensionContainer OPTIONAL, +6034 ...} +6035 + +``` + +``` + +6036 Ext-ProtocolId ::= ENUMERATED { +6037 ets-300356 (1), +6038 ... +6039 } +6040 -- exception handling: +6041 -- For Ext-ExternalSignalInfo sequences containing this parameter with any +6042 -- other value than the ones listed the receiver shall ignore the whole +6043 -- Ext-ExternalSignalInfo sequence. +6044 +6045 AccessNetworkSignalInfo ::= SEQUENCE { +6046 accessNetworkProtocolId AccessNetworkProtocolId, +6047 signalInfo LongSignalInfo, +6048 -- Information about the internal structure is given in clause 7.6.9.1 +6049 +6050 extensionContainer ExtensionContainer OPTIONAL, +6051 ...} +6052 +6053 LongSignalInfo ::= OCTET STRING (SIZE (1..maxLongSignalInfoLength)) +6054 +6055 maxLongSignalInfoLength INTEGER ::= 2560 +6056 -- This Named Value represents the maximum number of octets which is available +6057 -- to carry a single instance of the LongSignalInfo data type using +6058 -- White Book SCCP with the maximum number of segments. +6059 -- It takes account of the octets used by the lower layers of the protocol, and +6060 -- other information elements which may be included in the same component. +6061 +6062 AccessNetworkProtocolId ::= ENUMERATED { +6063 ts3G-48006 (1), +6064 ts3G-25413 (2), +6065 ...} +6066 -- exception handling: +6067 -- For AccessNetworkSignalInfo sequences containing this parameter with any +6068 -- other value than the ones listed the receiver shall ignore the whole +6069 -- AccessNetworkSignalInfo sequence. +6070 +6071 AlertingPattern ::= OCTET STRING (SIZE (1) ) +6072 -- This type is used to represent Alerting Pattern +6073 +6074 -- bits 8765 : 0000 (unused) +6075 +6076 -- bits 43 : type of Pattern +6077 -- 00 level +6078 -- 01 category +6079 -- 10 category +6080 -- all other values are reserved. +6081 +6082 -- bits 21 : type of alerting +6083 +6084 alertingLevel-0 AlertingPattern ::= '00000000'B +6085 alertingLevel-1 AlertingPattern ::= '00000001'B +6086 alertingLevel-2 AlertingPattern ::= '00000010'B +6087 -- all other values of Alerting level are reserved +6088 -- Alerting Levels are defined in GSM 02.07 +6089 +6090 alertingCategory-1 AlertingPattern ::= '00000100'B +6091 alertingCategory-2 AlertingPattern ::= '00000101'B +6092 alertingCategory-3 AlertingPattern ::= '00000110'B +6093 alertingCategory-4 AlertingPattern ::= '00000111'B +6094 alertingCategory-5 AlertingPattern ::= '00001000'B +6095 -- all other values of Alerting Category are reserved +6096 -- Alerting categories are defined in GSM 02.07 +6097 +6098 GSN-Address ::= OCTET STRING (SIZE (5..17)) +6099 -- Octets are coded according to TS 3GPP TS 23.003 [17] +6100 +6101 Time ::= OCTET STRING (SIZE (4)) +6102 -- Octets are coded according to IETF RFC 3588 [139] +6103 +6104 +6105 -- data types for numbering and identification +6106 +6107 IMSI ::= TBCD-STRING (SIZE (3..8)) +6108 -- digits of MCC, MNC, MSIN are concatenated in this order. +6109 + +``` + +``` + +6110 Identity ::= CHOICE { +6111 imsi IMSI, +6112 imsi-WithLMSI IMSI-WithLMSI} +6113 +6114 IMSI-WithLMSI ::= SEQUENCE { +6115 imsi IMSI, +6116 lmsi LMSI, +6117 -- a special value 00000000 indicates that the LMSI is not in use +6118 ...} +6119 +6120 ASCI-CallReference ::= TBCD-STRING (SIZE (1..8)) +6121 -- digits of VGCS/VBS-area,Group-ID are concatenated in this order if there is a +6122 -- VGCS/VBS-area. +6123 +6124 TMSI ::= OCTET STRING (SIZE (1..4)) +6125 +6126 SubscriberId ::= CHOICE { +6127 imsi [0] IMSI, +6128 tmsi [1] TMSI} +6129 +6130 IMEI ::= TBCD-STRING (SIZE (8)) +6131 -- Refers to International Mobile Station Equipment Identity +6132 -- and Software Version Number (SVN) defined in TS 3GPP TS 23.003 [17]. +6133 -- If the SVN is not present the last octet shall contain the +6134 -- digit 0 and a filler. +6135 -- If present the SVN shall be included in the last octet. +6136 +6137 HLR-Id ::= IMSI +6138 -- leading digits of IMSI, i.e. (MCC, MNC, leading digits of +6139 -- MSIN) forming HLR Id defined in TS 3GPP TS 23.003 [17]. +6140 +6141 HLR-List ::= SEQUENCE SIZE (1..maxNumOfHLR-Id) OF +6142 HLR-Id +6143 +6144 maxNumOfHLR-Id INTEGER ::= 50 +6145 +6146 LMSI ::= OCTET STRING (SIZE (4)) +6147 +6148 GlobalCellId ::= OCTET STRING (SIZE (5..7)) +6149 -- Refers to Cell Global Identification defined in TS 3GPP TS 23.003 [17]. +6150 -- The internal structure is defined as follows: +6151 -- octet 1 bits 4321 Mobile Country Code 1st digit +6152 -- bits 8765 Mobile Country Code 2nd digit +6153 -- octet 2 bits 4321 Mobile Country Code 3rd digit +6154 -- bits 8765 Mobile Network Code 3rd digit +6155 -- or filler (1111) for 2 digit MNCs +6156 -- octet 3 bits 4321 Mobile Network Code 1st digit +6157 -- bits 8765 Mobile Network Code 2nd digit +6158 -- octets 4 and 5 Location Area Code according to TS 3GPP TS 24.008 +6159 [35] +6160 -- octets 6 and 7 Cell Identity (CI) according to TS 3GPP TS 24.008 +6161 [35] +6162 +6163 NetworkResource ::= ENUMERATED { +6164 plmn (0), +6165 hlr (1), +6166 vlr (2), +6167 pvlr (3), +6168 controllingMSC (4), +6169 vmsc (5), +6170 eir (6), +6171 rss (7)} +6172 +6173 AdditionalNetworkResource ::= ENUMERATED { +6174 sgsn (0), +6175 ggsn (1), +6176 gmlc (2), +6177 gsmSCF (3), +6178 nplr (4), +6179 auc (5), +6180 ... , +6181 ue (6), +6182 mme (7)} +6183 -- if unknown value is received in AdditionalNetworkResource +6184 -- it shall be ignored. +6185 +6186 + +``` + +``` + +6187 NAEA-PreferredCI := SEQUENCE { +6188 naea-PreferredCIC [0] NAEA-CIC, +6189 extensionContainer [1] ExtensionContainer OPTIONAL, +6190 ... } +6191 +6192 NAEA-CIC := OCTET STRING (SIZE (3)) +6193 -- The internal structure is defined by the Carrier Identification +6194 -- parameter in ANSI T1.113.3. Carrier codes between "000" and "999" may +6195 -- be encoded as 3 digits using "000" to "999" or as 4 digits using +6196 -- "0000" to "0999". Carrier codes between "1000" and "9999" are encoded +6197 -- using 4 digits. +6198 +6199 SubscriberIdentity := CHOICE { +6200 imsi [0] IMSI, +6201 msisdN [1] ISDN-AddressString +6202 } +6203 +6204 LCSCClientExternalID := SEQUENCE { +6205 externalAddress [0] ISDN-AddressString OPTIONAL, +6206 extensionContainer [1] ExtensionContainer OPTIONAL, +6207 ... } +6208 +6209 LCSCClientInternalID := ENUMERATED { +6210 broadcastService (0), +6211 o-andM-HPLMN (1), +6212 o-andM-VPLMN (2), +6213 anonymousLocation (3), +6214 targetMSsubscribedService (4), +6215 ... } +6216 -- for a CAMEL phase 3 PLMN operator client, the value targetMSsubscribedService shall be used +6217 +6218 LCSServiceTypeID := INTEGER (0..127) +6219 -- the integer values 0-63 are reserved for Standard LCS service types +6220 -- the integer values 64-127 are reserved for Non Standard LCS service types +6221 +6222 -- Standard LCS Service Types +6223 emergencyServices LCSServiceTypeID := 0 +6224 emergencyAlertServices LCSServiceTypeID := 1 +6225 personTrackingLCSServiceTypeID := 2 +6226 fleetManagement LCSServiceTypeID := 3 +6227 assetManagement LCSServiceTypeID := 4 +6228 trafficCongestionReporting LCSServiceTypeID := 5 +6229 roadsideAssistance LCSServiceTypeID := 6 +6230 routingToNearestCommercialEnterprise LCSServiceTypeID := 7 +6231 navigation LCSServiceTypeID := 8 +6232 --this service type is reserved for use in previous releases +6233 citySightseeing LCSServiceTypeID := 9 +6234 localizedAdvertising LCSServiceTypeID := 10 +6235 mobileYellowPages LCSServiceTypeID := 11 +6236 trafficAndPublicTransportationInfo LCSServiceTypeID := 12 +6237 weather LCSServiceTypeID := 13 +6238 assetAndServiceFinding LCSServiceTypeID := 14 +6239 gaming LCSServiceTypeID := 15 +6240 findYourFriendLCSServiceTypeID := 16 +6241 dating LCSServiceTypeID := 17 +6242 chatting LCSServiceTypeID := 18 +6243 routeFinding LCSServiceTypeID := 19 +6244 whereAmI LCSServiceTypeID := 20 +6245 +6246 -- The values of LCSServiceTypeID are defined according to 3GPP TS 22.071. +6247 + +``` + +``` + +6248 -- Non Standard LCS Service Types +6249 serv64 LCSServiceTypeID := 64 +6250 serv65 LCSServiceTypeID := 65 +6251 serv66 LCSServiceTypeID := 66 +6252 serv67 LCSServiceTypeID := 67 +6253 serv68 LCSServiceTypeID := 68 +6254 serv69 LCSServiceTypeID := 69 +6255 serv70 LCSServiceTypeID := 70 +6256 serv71 LCSServiceTypeID := 71 +6257 serv72 LCSServiceTypeID := 72 +6258 serv73 LCSServiceTypeID := 73 +6259 serv74 LCSServiceTypeID := 74 +6260 serv75 LCSServiceTypeID := 75 +6261 serv76 LCSServiceTypeID := 76 +6262 serv77 LCSServiceTypeID := 77 +6263 serv78 LCSServiceTypeID := 78 +6264 serv79 LCSServiceTypeID := 79 +6265 serv80 LCSServiceTypeID := 80 +6266 serv81 LCSServiceTypeID := 81 +6267 serv82 LCSServiceTypeID := 82 +6268 serv83 LCSServiceTypeID := 83 +6269 serv84 LCSServiceTypeID := 84 +6270 serv85 LCSServiceTypeID := 85 +6271 serv86 LCSServiceTypeID := 86 +6272 serv87 LCSServiceTypeID := 87 +6273 serv88 LCSServiceTypeID := 88 +6274 serv89 LCSServiceTypeID := 89 +6275 serv90 LCSServiceTypeID := 90 +6276 serv91 LCSServiceTypeID := 91 +6277 serv92 LCSServiceTypeID := 92 +6278 serv93 LCSServiceTypeID := 93 +6279 serv94 LCSServiceTypeID := 94 +6280 serv95 LCSServiceTypeID := 95 +6281 serv96 LCSServiceTypeID := 96 +6282 serv97 LCSServiceTypeID := 97 +6283 serv98 LCSServiceTypeID := 98 +6284 serv99 LCSServiceTypeID := 99 +6285 serv100 LCSServiceTypeID := 100 +6286 serv101 LCSServiceTypeID := 101 +6287 serv102 LCSServiceTypeID := 102 +6288 serv103 LCSServiceTypeID := 103 +6289 serv104 LCSServiceTypeID := 104 +6290 serv105 LCSServiceTypeID := 105 +6291 serv106 LCSServiceTypeID := 106 +6292 serv107 LCSServiceTypeID := 107 +6293 serv108 LCSServiceTypeID := 108 +6294 serv109 LCSServiceTypeID := 109 +6295 serv110 LCSServiceTypeID := 110 +6296 serv111 LCSServiceTypeID := 111 +6297 serv112 LCSServiceTypeID := 112 +6298 serv113 LCSServiceTypeID := 113 +6299 serv114 LCSServiceTypeID := 114 +6300 serv115 LCSServiceTypeID := 115 +6301 serv116 LCSServiceTypeID := 116 +6302 serv117 LCSServiceTypeID := 117 +6303 serv118 LCSServiceTypeID := 118 +6304 serv119 LCSServiceTypeID := 119 +6305 serv120 LCSServiceTypeID := 120 +6306 serv121 LCSServiceTypeID := 121 +6307 serv122 LCSServiceTypeID := 122 +6308 serv123 LCSServiceTypeID := 123 +6309 serv124 LCSServiceTypeID := 124 +6310 serv125 LCSServiceTypeID := 125 +6311 serv126 LCSServiceTypeID := 126 +6312 serv127 LCSServiceTypeID := 127 + +``` + +6313 + +``` + +6314 PLMN-Id := OCTET STRING (SIZE (3)) +6315 -- The internal structure is defined as follows: +6316 -- octet 1 bits 4321 Mobile Country Code 1st digit +6317 -- bits 8765 Mobile Country Code 2nd digit +6318 -- octet 2 bits 4321 Mobile Country Code 3rd digit +6319 -- bits 8765 Mobile Network Code 3rd digit +6320 -- or filler (1111) for 2 digit MNCs +6321 -- octet 3 bits 4321 Mobile Network Code 1st digit +6322 -- bits 8765 Mobile Network Code 2nd digit + +``` + +6323 + +``` + +6324 E-UTRAN-CGI := OCTET STRING (SIZE (7)) +6325 -- Octets are coded as described in 3GPP TS 29.118 [152]. +6326 +6327 NR-CGI := OCTET STRING (SIZE (8)) +6328 -- Octets are coded as described in 3GPP TS 38.413 [153]. +6329 +6330 TA-Id := OCTET STRING (SIZE (5)) +6331 -- Octets are coded as described in 3GPP TS 29.118 [152]. +6332 +6333 NR-TA-Id := OCTET STRING (SIZE (6)) +6334 -- Octets are coded as described in 3GPP TS 38.413 [153]. +6335 +6336 RAIdentity := OCTET STRING (SIZE (6)) +6337 -- Routing Area Identity is coded in accordance with 3GPP TS 29.060 [105]. +6338 -- It shall contain the value part defined in 3GPP TS 29.060 only. I.e. the 3GPP TS 29.060 +6339 -- type identifier octet shall not be included. +6340 +6341 NetworkNodeDiameterAddress := SEQUENCE { +6342 diameter-Name [0] DiameterIdentity, +6343 diameter-Realm [1] DiameterIdentity } +6344 +6345 -- data types for CAMEL +6346 +6347 CellGlobalIdOrServiceAreaIdOrLAI := CHOICE { +6348 cellGlobalIdOrServiceAreaIdFixedLength [0] CellGlobalIdOrServiceAreaIdFixedLength, +6349 laiFixedLength [1] LAIFixedLength} +6350 +6351 CellGlobalIdOrServiceAreaIdFixedLength := OCTET STRING (SIZE (7)) +6352 -- Refers to Cell Global Identification or Service Area Identification +6353 -- defined in 3GPP TS 23.003. +6354 -- The internal structure is defined as follows: +6355 -- octet 1 bits 4321 Mobile Country Code 1st digit +6356 -- bits 8765 Mobile Country Code 2nd digit +6357 -- octet 2 bits 4321 Mobile Country Code 3rd digit +6358 -- bits 8765 Mobile Network Code 3rd digit +6359 -- or filler (1111) for 2 digit MNCs +6360 -- octet 3 bits 4321 Mobile Network Code 1st digit +6361 -- bits 8765 Mobile Network Code 2nd digit +6362 -- octets 4 and 5 Location Area Code according to 3GPP TS 24.008 +6363 -- octets 6 and 7 Cell Identity (CI) value or +6364 -- Service Area Code (SAC) value +6365 -- according to 3GPP TS 23.003 +6366 +6367 LAIFixedLength := OCTET STRING (SIZE (5)) +6368 -- Refers to Location Area Identification defined in 3GPP TS 23.003 [17]. +6369 -- The internal structure is defined as follows: +6370 -- octet 1 bits 4321 Mobile Country Code 1st digit +6371 -- bits 8765 Mobile Country Code 2nd digit +6372 -- octet 2 bits 4321 Mobile Country Code 3rd digit +6373 -- bits 8765 Mobile Network Code 3rd digit +6374 -- or filler (1111) for 2 digit MNCs +6375 -- octet 3 bits 4321 Mobile Network Code 1st digit +6376 -- bits 8765 Mobile Network Code 2nd digit +6377 -- octets 4 and 5 Location Area Code according to 3GPP TS 24.008 [35] +6378 +6379 -- data types for subscriber management +6380 +6381 BasicServiceCode := CHOICE { +6382 bearerService [2] BearerServiceCode, +6383 teleservice [3] TeleserviceCode} +6384 +6385 Ext-BasicServiceCode := CHOICE { +6386 ext-BearerService [2] Ext-BearerServiceCode, +6387 ext-Teleservice [3] Ext-TeleserviceCode} +6388 +6389 EMLPP-Info := SEQUENCE { +6390 maximumUntitledPriority EMLPP-Priority, +6391 defaultPriority EMLPP-Priority, +6392 extensionContainer ExtensionContainer OPTIONAL, +6393 ...} +6394 +6395 EMLPP-Priority := INTEGER (0..15) +6396 -- The mapping from the values A,B,0,1,2,3,4 to the integer-value is +6397 -- specified as follows where A is the highest and 4 is the lowest +6398 -- priority level +6399 -- the integer values 7-15 are spare and shall be mapped to value 4 +6400 + +``` + +``` + +6401 priorityLevelA EMLPP-Priority := 6 +6402 priorityLevelB EMLPP-Priority := 5 +6403 priorityLevel0 EMLPP-Priority := 0 +6404 priorityLevel1 EMLPP-Priority := 1 +6405 priorityLevel2 EMLPP-Priority := 2 +6406 priorityLevel3 EMLPP-Priority := 3 +6407 priorityLevel4 EMLPP-Priority := 4 +6408 +6409 MC-SS-Info := SEQUENCE { +6410 ss-Code [0] SS-Code, +6411 ss-Status [1] Ext-SS-Status, +6412 nbrSB [2] MaxMC-Bearers, +6413 nbrUser [3] MC-Bearers, +6414 extensionContainer [4] ExtensionContainer OPTIONAL, +6415 } +6416 +6417 MaxMC-Bearers := INTEGER (2..maxNumOfMC-Bearers) +6418 +6419 MC-Bearers := INTEGER (1..maxNumOfMC-Bearers) +6420 +6421 maxNumOfMC-Bearers INTEGER := 7 +6422 +6423 Ext-SS-Status := OCTET STRING (SIZE (1..5)) +6424 +6425 -- OCTET 1: +6426 -- +6427 -- bits 8765: 0000 (unused) +6428 -- bits 4321: Used to convey the "P bit", "R bit", "A bit" and "Q bit", +6429 -- representing supplementary service state information +6430 -- as defined in TS 3GPP TS 23.011 [22] +6431 +6432 -- bit 4: "Q bit" +6433 +6434 -- bit 3: "P bit" +6435 +6436 -- bit 2: "R bit" +6437 +6438 -- bit 1: "A bit" +6439 +6440 -- OCTETS 2-5: reserved for future use. They shall be discarded if +6441 -- received and not understood. +6442 +6443 +6444 -- data types for geographic location +6445 +6446 AgeOfLocationInformation := INTEGER (0..32767) +6447 -- the value represents the elapsed time in minutes since the last +6448 -- network contact of the mobile station (i.e. the actuality of the +6449 -- location information). +6450 -- value "0" indicates that the MS is currently in contact with the +6451 -- network +6452 -- value "32767" indicates that the location information is at least +6453 -- 32767 minutes old +6454 +6455 END + +``` + +## 6456 17.7.9 Teleservice Codes + +``` + +6457 MAP-TS-Code { +6458 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6459 gsm-Network (1) modules (3) map-TS-Code (19) version21 (21)} +6460 +6461 DEFINITIONS +6462 +6463 ::= +6464 +6465 BEGIN +6466 +6467 TeleserviceCode := OCTET STRING (SIZE (1)) +6468 -- This type is used to represent the code identifying a single +6469 -- teleservice, a group of teleservices, or all teleservices. The +6470 -- services are defined in TS GSM 22.003 [4]. +6471 -- The internal structure is defined as follows: +6472 +6473 -- bits 87654321: group (bits 8765) and specific service +6474 -- (bits 4321) +6475 + +``` + +``` + +6476 Ext-TeleserviceCode ::= OCTET STRING (SIZE (1..5)) +6477 -- This type is used to represent the code identifying a single +6478 -- teleservice, a group of teleservices, or all teleservices. The +6479 -- services are defined in TS GSM 22.003 [4]. +6480 -- The internal structure is defined as follows: +6481 +6482 -- OCTET 1: +6483 -- bits 87654321: group (bits 8765) and specific service +6484 -- (bits 4321) +6485 +6486 -- OCTETS 2-5: reserved for future use. If received the +6487 -- Ext-TeleserviceCode shall be +6488 -- treated according to the exception handling defined for the +6489 -- operation that uses this type. +6490 +6491 -- Ext-TeleserviceCode includes all values defined for TeleserviceCode. +6492 +6493 allTeleservices TeleserviceCode ::= '00000000'B +6494 +6495 allSpeechTransmissionServices TeleserviceCode ::= '00010000'B +6496 telephony TeleserviceCode ::= '00010001'B +6497 emergencyCalls TeleserviceCode ::= '00010010'B +6498 +6499 allShortMessageServices TeleserviceCode ::= '00100000'B +6500 shortMessageMT-PP TeleserviceCode ::= '00100001'B +6501 shortMessageMO-PP TeleserviceCode ::= '00100010'B +6502 +6503 allFacsimileTransmissionServices TeleserviceCode ::= '01100000'B +6504 facsimileGroup3AndAlterSpeech TeleserviceCode ::= '01100001'B +6505 automaticFacsimileGroup3 TeleserviceCode ::= '01100010'B +6506 facsimileGroup4 TeleserviceCode ::= '01100011'B +6507 +6508 -- The following non-hierarchical Compound Teleservice Groups +6509 -- are defined in TS 3GPP TS 22.030: +6510 allDataTeleservices TeleserviceCode ::= '01110000'B +6511 -- covers Teleservice Groups 'allFacsimileTransmissionServices' +6512 -- and 'allShortMessageServices' +6513 allTeleservices-ExceptSMS TeleserviceCode ::= '10000000'B +6514 -- covers Teleservice Groups 'allSpeechTransmissionServices' and +6515 -- 'allFacsimileTransmissionServices' +6516 -- +6517 -- Compound Teleservice Group Codes are only used in call +6518 -- independent supplementary service operations, i.e. they +6519 -- are not used in InsertSubscriberData or in +6520 -- DeleteSubscriberData messages. +6521 +6522 allVoiceGroupCallServices TeleserviceCode ::= '10010000'B +6523 voiceGroupCall TeleserviceCode ::= '10010001'B +6524 voiceBroadcastCall TeleserviceCode ::= '10010010'B +6525 +6526 allPLMN-specificTS TeleserviceCode ::= '11010000'B +6527 plmn-specificTS-1 TeleserviceCode ::= '11010001'B +6528 plmn-specificTS-2 TeleserviceCode ::= '11010010'B +6529 plmn-specificTS-3 TeleserviceCode ::= '11010011'B +6530 plmn-specificTS-4 TeleserviceCode ::= '11010100'B +6531 plmn-specificTS-5 TeleserviceCode ::= '11010101'B +6532 plmn-specificTS-6 TeleserviceCode ::= '11010110'B +6533 plmn-specificTS-7 TeleserviceCode ::= '11010111'B +6534 plmn-specificTS-8 TeleserviceCode ::= '11011000'B +6535 plmn-specificTS-9 TeleserviceCode ::= '11011001'B +6536 plmn-specificTS-A TeleserviceCode ::= '11011010'B +6537 plmn-specificTS-B TeleserviceCode ::= '11011011'B +6538 plmn-specificTS-C TeleserviceCode ::= '11011100'B +6539 plmn-specificTS-D TeleserviceCode ::= '11011101'B +6540 plmn-specificTS-E TeleserviceCode ::= '11011110'B +6541 plmn-specificTS-F TeleserviceCode ::= '11011111'B +6542 +6543 END + +``` + +## 6544 17.7.10 Bearer Service Codes + +``` + +6545 MAP-BS-Code { +6546 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6547 gsm-Network (1) modules (3) map-BS-Code (20) version21 (21)} +6548 +6549 DEFINITIONS +6550 + +``` + +``` + +6551 ::= +6552 +6553 BEGIN +6554 +6555 BearerServiceCode ::= OCTET STRING (SIZE (1)) +6556 -- This type is used to represent the code identifying a single +6557 -- bearer service, a group of bearer services, or all bearer +6558 -- services. The services are defined in TS 3GPP TS 22.002 [3]. +6559 -- The internal structure is defined as follows: +6560 -- +6561 -- plmn-specific bearer services: +6562 -- bits 87654321: defined by the HPLMN operator +6563 +6564 -- rest of bearer services: +6565 -- bit 8: 0 (unused) +6566 -- bits 7654321: group (bits 7654), and rate, if applicable +6567 -- (bits 321) +6568 +6569 Ext-BearerServiceCode ::= OCTET STRING (SIZE (1..5)) +6570 -- This type is used to represent the code identifying a single +6571 -- bearer service, a group of bearer services, or all bearer +6572 -- services. The services are defined in TS 3GPP TS 22.002 [3]. +6573 -- The internal structure is defined as follows: +6574 -- +6575 -- OCTET 1: +6576 -- plmn-specific bearer services: +6577 -- bits 87654321: defined by the HPLMN operator +6578 -- +6579 -- rest of bearer services: +6580 -- bit 8: 0 (unused) +6581 -- bits 7654321: group (bits 7654), and rate, if applicable +6582 -- (bits 321) +6583 +6584 -- OCTETS 2-5: reserved for future use. If received the +6585 -- Ext-TeleserviceCode shall be +6586 -- treated according to the exception handling defined for the +6587 -- operation that uses this type. +6588 +6589 +6590 -- Ext-BearerServiceCode includes all values defined for BearerServiceCode. +6591 +6592 allBearerServices BearerServiceCode ::= '00000000'B +6593 +6594 allDataCDA-Services BearerServiceCode ::= '00010000'B +6595 dataCDA-300bps BearerServiceCode ::= '00010001'B +6596 dataCDA-1200bps BearerServiceCode ::= '00010010'B +6597 dataCDA-1200-75bps BearerServiceCode ::= '00010011'B +6598 dataCDA-2400bps BearerServiceCode ::= '00010100'B +6599 dataCDA-4800bps BearerServiceCode ::= '00010101'B +6600 dataCDA-9600bps BearerServiceCode ::= '00010110'B +6601 general-dataCDA BearerServiceCode ::= '00010111'B +6602 +6603 allDataCDS-Services BearerServiceCode ::= '00011000'B +6604 dataCDS-1200bps BearerServiceCode ::= '00011010'B +6605 dataCDS-2400bps BearerServiceCode ::= '00011100'B +6606 dataCDS-4800bps BearerServiceCode ::= '00011101'B +6607 dataCDS-9600bps BearerServiceCode ::= '00011110'B +6608 general-dataCDS BearerServiceCode ::= '00011111'B +6609 +6610 allPadAccessCA-Services BearerServiceCode ::= '00100000'B +6611 padAccessCA-300bps BearerServiceCode ::= '00100001'B +6612 padAccessCA-1200bps BearerServiceCode ::= '00100010'B +6613 padAccessCA-1200-75bps BearerServiceCode ::= '00100011'B +6614 padAccessCA-2400bps BearerServiceCode ::= '00100100'B +6615 padAccessCA-4800bps BearerServiceCode ::= '00100101'B +6616 padAccessCA-9600bps BearerServiceCode ::= '00100110'B +6617 general-padAccessCA BearerServiceCode ::= '00100111'B +6618 +6619 allDataPDS-Services BearerServiceCode ::= '00101000'B +6620 dataPDS-2400bps BearerServiceCode ::= '00101100'B +6621 dataPDS-4800bps BearerServiceCode ::= '00101101'B +6622 dataPDS-9600bps BearerServiceCode ::= '00101110'B +6623 general-dataPDS BearerServiceCode ::= '00101111'B +6624 +6625 allAlternateSpeech-DataCDA BearerServiceCode ::= '00110000'B +6626 +6627 allAlternateSpeech-DataCDS BearerServiceCode ::= '00111000'B + +``` + +``` + +6628 +6629 allSpeechFollowedByDataCDA BearerServiceCode ::= '01000000'B +6630 +6631 allSpeechFollowedByDataCDS BearerServiceCode ::= '01001000'B +6632 +6633 -- The following non-hierarchical Compound Bearer Service +6634 -- Groups are defined in TS 3GPP TS 22.030: +6635 allDataCircuitAsynchronous BearerServiceCode ::= '01010000'B +6636 -- covers "allDataCDA-Services", "allAlternateSpeech-DataCDA" and +6637 -- "allSpeechFollowedByDataCDA" +6638 allAsynchronousServices BearerServiceCode ::= '01100000'B +6639 -- covers "allDataCDA-Services", "allAlternateSpeech-DataCDA", +6640 -- "allSpeechFollowedByDataCDA" and "allPadAccessCDA-Services" +6641 allDataCircuitSynchronous BearerServiceCode ::= '01011000'B +6642 -- covers "allDataCDS-Services", "allAlternateSpeech-DataCDS" and +6643 -- "allSpeechFollowedByDataCDS" +6644 allSynchronousServices BearerServiceCode ::= '01101000'B +6645 -- covers "allDataCDS-Services", "allAlternateSpeech-DataCDS", +6646 -- "allSpeechFollowedByDataCDS" and "allDataPDS-Services" +6647 -- +6648 -- Compound Bearer Service Group Codes are only used in call +6649 -- independent supplementary service operations, i.e. they +6650 -- are not used in InsertSubscriberData or in +6651 -- DeleteSubscriberData messages. +6652 +6653 allPLMN-specificBS BearerServiceCode ::= '11010000'B +6654 plmn-specificBS-1 BearerServiceCode ::= '11010001'B +6655 plmn-specificBS-2 BearerServiceCode ::= '11010010'B +6656 plmn-specificBS-3 BearerServiceCode ::= '11010011'B +6657 plmn-specificBS-4 BearerServiceCode ::= '11010100'B +6658 plmn-specificBS-5 BearerServiceCode ::= '11010101'B +6659 plmn-specificBS-6 BearerServiceCode ::= '11010110'B +6660 plmn-specificBS-7 BearerServiceCode ::= '11010111'B +6661 plmn-specificBS-8 BearerServiceCode ::= '11011000'B +6662 plmn-specificBS-9 BearerServiceCode ::= '11011001'B +6663 plmn-specificBS-A BearerServiceCode ::= '11011010'B +6664 plmn-specificBS-B BearerServiceCode ::= '11011011'B +6665 plmn-specificBS-C BearerServiceCode ::= '11011100'B +6666 plmn-specificBS-D BearerServiceCode ::= '11011101'B +6667 plmn-specificBS-E BearerServiceCode ::= '11011110'B +6668 plmn-specificBS-F BearerServiceCode ::= '11011111'B +6669 +6670 END + +``` + +## 6671 17.7.11 Extension data types + +``` + +6672 MAP-ExtensionDataTypes { +6673 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6674 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +6675 +6676 DEFINITIONS +6677 +6678 IMPLICIT TAGS +6679 +6680 ::= +6681 +6682 BEGIN +6683 +6684 EXPORTS +6685 +6686 PrivateExtension, +6687 ExtensionContainer, +6688 SLR-ArgExtensionContainer; +6689 +6690 +6691 -- IOC for private MAP extensions +6692 +6693 +6694 MAP-EXTENSION ::= CLASS { +6695 &ExtensionType OPTIONAL, +6696 &extensionId OBJECT IDENTIFIER } +6697 -- The length of the Object Identifier shall not exceed 16 octets and the +6698 -- number of components of the Object Identifier shall not exceed 16 +6699 +6700 -- data types +6701 + +``` + +``` + +6702 ExtensionContainer ::= SEQUENCE { +6703 privateExtensionList [0] PrivateExtensionList OPTIONAL, +6704 pcs-Extensions [1] PCS-Extensions OPTIONAL, +6705 ... } +6706 +6707 SLR-ArgExtensionContainer ::= SEQUENCE { +6708 privateExtensionList [0] PrivateExtensionList OPTIONAL, +6709 slr-Arg-PCS-Extensions [1] SLR-Arg-PCS-Extensions OPTIONAL, +6710 ... } +6711 +6712 PrivateExtensionList ::= SEQUENCE SIZE (1..maxNumOfPrivateExtensions) OF +6713 PrivateExtension +6714 +6715 PrivateExtension ::= SEQUENCE { +6716 extId MAP-EXTENSION.&extensionId +6717 ({ExtensionSet}), +6718 extType MAP-EXTENSION.&ExtensionType +6719 ({ExtensionSet}{@extId}) OPTIONAL} +6720 +6721 maxNumOfPrivateExtensions INTEGER ::= 10 +6722 +6723 ExtensionSet MAP-EXTENSION ::= +6724 { ... +6725 -- ExtensionSet is the set of all defined private extensions +6726 } +6727 -- Unsupported private extensions shall be discarded if received. +6728 +6729 PCS-Extensions ::= SEQUENCE { +6730 ... } +6731 +6732 SLR-Arg-PCS-Extensions ::= SEQUENCE { +6733 ..., +6734 na-ESRK-Request [0] NULL OPTIONAL } +6735 +6736 END +6737 + +``` + +## 6738 17.7.12 Group Call data types + +``` + +6739 MAP-GR-DataTypes { +6740 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6741 gsm-Network (1) modules (3) map-GR-DataTypes (23) version21 (21)} +6742 +6743 DEFINITIONS +6744 +6745 IMPLICIT TAGS +6746 +6747 ::= +6748 +6749 BEGIN +6750 +6751 EXPORTS +6752 PrepareGroupCallArg, +6753 PrepareGroupCallRes, +6754 SendGroupCallEndSignalArg, +6755 SendGroupCallEndSignalRes, +6756 ForwardGroupCallSignallingArg, +6757 ProcessGroupCallSignallingArg, +6758 SendGroupCallInfoArg, +6759 SendGroupCallInfoRes +6760 ; +6761 +6762 IMPORTS +6763 ISDN-AddressString, +6764 IMSI, +6765 TMSI, +6766 EMLPP-Priority, +6767 ASCI-CallReference, +6768 SignalInfo, +6769 GlobalCellId, +6770 AccessNetworkSignalInfo +6771 FROM MAP-CommonDataTypes { +6772 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6773 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +6774 +6775 Ext-TeleserviceCode +6776 FROM MAP-TS-Code { + +``` + +``` + +6777 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6778 gsm-Network (1) modules (3) map-TS-Code (19) version21 (21)} +6779 +6780 Kc, +6781 AdditionalInfo, +6782 GroupId, +6783 Long-GroupId, +6784 AdditionalSubscriptions, +6785 Cksn +6786 FROM MAP-MS-DataTypes { +6787 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6788 gsm-Network (1) modules (3) map-MS-DataTypes (11) version21 (21)} +6789 +6790 ExtensionContainer +6791 FROM MAP-ExtensionDataTypes { +6792 itu-t identified-organization (4) etsi (0) mobileDomain (0) +6793 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +6794 ; +6795 +6796 + +``` + +``` + +6797 PrepareGroupCallArg ::= SEQUENCE { +6798 teleservice Ext-TeleserviceCode, +6799 asciCallReference ASCI-CallReference, +6800 codec-Info CODEC-Info, +6801 cipheringAlgorithm CipheringAlgorithm, +6802 groupKeyNumber-Vk-Id [0] GroupKeyNumber OPTIONAL, +6803 groupKey [1] Kc OPTIONAL, +6804 -- this parameter shall not be sent and shall be discarded if received +6805 priority [2] EMLPP-Priority OPTIONAL, +6806 uplinkFree [3] NULL OPTIONAL, +6807 extensionContainer [4] ExtensionContainer OPTIONAL, +6808 ..., +6809 vstk [5] VSTK OPTIONAL, +6810 vstk-rand [6] VSTK-RAND OPTIONAL, +6811 talkerChannelParameter [7] NULL OPTIONAL, +6812 uplinkReplyIndicator [8] NULL OPTIONAL} + +``` + +``` + +6813 +6814 VSTK ::= OCTET STRING (SIZE (16)) + +``` + +``` + +6815 +6816 VSTK-RAND ::= OCTET STRING (SIZE (5)) +6817 -- The 36 bit value is carried in bit 7 of octet 1 to bit 4 of octet 5 +6818 -- bits 3, 2, 1, and 0 of octet 5 are padded with zeros. + +``` + +``` + +6819 +6820 PrepareGroupCallRes ::= SEQUENCE { +6821 groupCallNumber ISDN-AddressString, +6822 extensionContainer ExtensionContainer OPTIONAL, +6823 ...} + +``` + +``` + +6824 +6825 SendGroupCallEndSignalArg ::= SEQUENCE { +6826 imsi IMSI OPTIONAL, +6827 extensionContainer ExtensionContainer OPTIONAL, +6828 ..., +6829 talkerPriority [0] TalkerPriority OPTIONAL, +6830 additionalInfo [1] AdditionalInfo OPTIONAL } + +``` + +``` + +6831 +6832 TalkerPriority ::= ENUMERATED { +6833 normal (0), +6834 privileged (1), +6835 emergency (2)} + +``` + +``` + +6836 +6837 SendGroupCallEndSignalRes ::= SEQUENCE { +6838 extensionContainer ExtensionContainer OPTIONAL, +6839 ...} + +``` + +``` + +6840 + +``` + +``` + +6841 ForwardGroupCallSignallingArg ::= SEQUENCE { +6842 imsi IMSI OPTIONAL, +6843 uplinkRequestAck [0] NULL OPTIONAL, +6844 uplinkReleaseIndication [1] NULL OPTIONAL, +6845 uplinkRejectCommand [2] NULL OPTIONAL, +6846 uplinkSeizedCommand [3] NULL OPTIONAL, +6847 uplinkReleaseCommand [4] NULL OPTIONAL, +6848 extensionContainer ExtensionContainer OPTIONAL, +6849 ..., +6850 stateAttributes [5] StateAttributes OPTIONAL, +6851 talkerPriority [6] TalkerPriority OPTIONAL, +6852 additionalInfo [7] AdditionalInfo OPTIONAL, +6853 emergencyModeResetCommandFlag [8] NULL OPTIONAL, +6854 sm-RP-UI [9] SignalInfo OPTIONAL, +6855 an-APDU [10] AccessNetworkSignalInfo OPTIONAL +6856 } +6857 +6858 ProcessGroupCallSignallingArg ::= SEQUENCE { +6859 uplinkRequest [0] NULL OPTIONAL, +6860 uplinkReleaseIndication [1] NULL OPTIONAL, +6861 releaseGroupCall [2] NULL OPTIONAL, +6862 extensionContainer ExtensionContainer OPTIONAL, +6863 ..., +6864 talkerPriority [3] TalkerPriority OPTIONAL, +6865 additionalInfo [4] AdditionalInfo OPTIONAL, +6866 emergencyModeResetCommandFlag [5] NULL OPTIONAL, +6867 an-APDU [6] AccessNetworkSignalInfo OPTIONAL } +6868 +6869 GroupKeyNumber ::= INTEGER (0..15) +6870 +6871 CODEC-Info ::= OCTET STRING (SIZE (5..10)) +6872 -- Refers to channel type +6873 -- coded according to 3GPP TS 48.008 [49] and including Element identifier and Length +6874 +6875 CipheringAlgorithm ::= OCTET STRING (SIZE (1)) +6876 -- Refers to 'permitted algorithms' in 'encryption information' +6877 -- coded according to 3GPP TS 48.008 [49]: +6878 +6879 -- Bits 8-1 +6880 -- 8765 4321 +6881 -- 0000 0001 No encryption +6882 -- 0000 0010 GSM A5/1 +6883 -- 0000 0100 GSM A5/2 +6884 -- 0000 1000 GSM A5/3 +6885 -- 0001 0000 GSM A5/4 +6886 -- 0010 0000 GSM A5/5 +6887 -- 0100 0000 GSM A5/6 +6888 -- 1000 0000 GSM A5/7 +6889 +6890 StateAttributes ::= SEQUENCE { +6891 downlinkAttached [5] NULL OPTIONAL, +6892 uplinkAttached [6] NULL OPTIONAL, +6893 dualCommunication [7] NULL OPTIONAL, +6894 callOriginator [8] NULL OPTIONAL } +6895 +6896 -- Refers to 3GPP TS 44.068 for definitions of StateAttributes fields. +6897 +6898 +6899 SendGroupCallInfoArg ::= SEQUENCE { +6900 requestedInfo RequestedInfo, +6901 groupId Long-GroupId, +6902 teleservice Ext-TeleserviceCode, +6903 cellId [0] GlobalCellId OPTIONAL, +6904 imsi [1] IMSI OPTIONAL, +6905 tmsi [2] TMSI OPTIONAL, +6906 additionalInfo [3] AdditionalInfo OPTIONAL, +6907 talkerPriority [4] TalkerPriority OPTIONAL, +6908 cksn [5] Cksn OPTIONAL, +6909 extensionContainer [6] ExtensionContainer OPTIONAL, +6910 ... } +6911 + +``` + +``` + +6912 RequestedInfo ::= ENUMERATED { +6913 anchorMSC-AddressAndASCI-CallReference (0), +6914 imsiAndAdditionalInfoAndAdditionalSubscription(1), +6915 ... } +6916 -- exception handling: +6917 -- an unrecognized value shall be rejected by the receiver with a return error cause of +6918 -- unexpected data value +6919 +6920 SendGroupCallInfoRes ::= SEQUENCE { +6921 anchorMSC-Address [0] ISDN-AddressString OPTIONAL, +6922 asciCallReference [1] ASCI-CallReference OPTIONAL, +6923 imsi [2] IMSI OPTIONAL, +6924 additionalInfo [3] AdditionalInfo OPTIONAL, +6925 additionalSubscriptions [4] AdditionalSubscriptions OPTIONAL, +6926 kc [5] Kc OPTIONAL, +6927 extensionContainer [6] ExtensionContainer OPTIONAL, +6928 ... } +6929 +6930 +6931 END + +``` + +## 6932 17.7.13 Location service data types + +``` + +1 MAP-LCS-DataTypes { +2 itu-t identified-organization (4) etsi (0) mobileDomain (0) +3 gsm-Network (1) modules (3) map-LCS-DataTypes (25) version21 (21)} +4 +5 DEFINITIONS +6 IMPLICIT TAGS +7 ::= +8 BEGIN +9 +10 EXPORTS +11 RoutingInfoForLCS-Arg, +12 RoutingInfoForLCS-Res, +13 ProvideSubscriberLocation-Arg, +14 ProvideSubscriberLocation-Res, +15 SubscriberLocationReport-Arg, +16 SubscriberLocationReport-Res, +17 LocationType, +18 DeferredLocationEventType, +19 LCSClientName, +20 LCS-QoS, +21 Horizontal-Accuracy, +22 ResponseTime, +23 Ext-GeographicalInformation, +24 VelocityEstimate, +25 SupportedGADShapes, +26 Add-GeographicalInformation, +27 LCSRequestorID, +28 LCS-ReferenceNumber, +29 LCSCodeword, +30 AreaEventInfo, +31 ReportingPLMNList, +32 PeriodicLDRInfo, +33 SequenceNumber, +34 LCSClientType, +35 LCS-Priority, +36 OccurrenceInfo, +37 IntervalTime +38 ; +39 +40 IMPORTS +41 AddressString, +42 ISDN-AddressString, +43 IMEI, +44 IMSI, +45 LMSI, +46 SubscriberIdentity, +47 AgeOfLocationInformation, +48 LCSClientExternalID, +49 LCSClientInternalID, +50 LCSServiceTypeID, +51 CellGlobalIdOrServiceAreaIdOrLAI, +52 PLMN-Id, +53 GSN-Address, +54 DiameterIdentity + +``` + +``` + +55 FROM MAP-CommonDataTypes { +56 itu-t identified-organization (4) etsi (0) mobileDomain (0) +57 gsm-Network (1) modules (3) map-CommonDataTypes (18) version21 (21)} +58 +59 ExtensionContainer, +60 SLR-ArgExtensionContainer +61 FROM MAP-ExtensionDataTypes { +62 itu-t identified-organization (4) etsi (0) mobileDomain (0) +63 gsm-Network (1) modules (3) map-ExtensionDataTypes (21) version21 (21)} +64 +65 USSD-DataCodingScheme, +66 USSD-String +67 FROM MAP-SS-DataTypes { +68 itu-t identified-organization (4) etsi (0) mobileDomain (0) gsm-Network (1) modules (3) +69 map-SS-DataTypes (14) version21 (21)} +70 +71 APN, +72 SupportedLCS-CapabilitySets +73 FROM MAP-MS-DataTypes { +74 itu-t identified-organization (4) etsi (0) mobileDomain (0) +75 gsm-Network (1) modules (3) map-MS-DataTypes (11) version21 (21)} +76 +77 Additional-Number +78 FROM MAP-SM-DataTypes { +79 itu-t identified-organization (4) etsi (0) mobileDomain (0) +80 gsm-Network (1) modules (3) map-SM-DataTypes (16) version21 (21)} +81 ; +82 +83 + +``` + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 84 RoutingInfoForLCS-Arg := SEQUENCE { 85     mlcNumber [0] ISDN-AddressString, 86     targetMS [1] SubscriberIdentity, 87     extensionContainer [2] ExtensionContainer OPTIONAL, 88     ...}
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 90 RoutingInfoForLCS-Res := SEQUENCE { 91     targetMS [0] SubscriberIdentity, 92     lcsLocationInfo [1] LCSLocationInfo, 93     extensionContainer [2] ExtensionContainer OPTIONAL, 94     ..., 95     v-gmlc-Address [3] GSN-Address OPTIONAL, 96     h-gmlc-Address [4] GSN-Address OPTIONAL, 97     ppr-Address [5] GSN-Address OPTIONAL, 98     additional-v-gmlc-Address [6] GSN-Address OPTIONAL }
| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
 100 LCSLocationInfo := SEQUENCE { 101     networkNode-Number ISDN-AddressString, 102     -- NetworkNode-number can be msc-number, sgsn-number or a dummy value of "0" 103     lmsi [0] LMSI OPTIONAL, 104     extensionContainer [1] ExtensionContainer OPTIONAL, 105     ... , 106     gprsNodeIndicator [2] NULL OPTIONAL, 107     -- gprsNodeIndicator is set only if the SGSN number is sent as the Network Node Number 108     additional-Number [3] Additional-Number OPTIONAL, 109     supportedLCS-CapabilitySets [4] SupportedLCS-CapabilitySets OPTIONAL, 110     additional-LCS-CapabilitySets [5] SupportedLCS-CapabilitySets OPTIONAL, 111     mme-Name [6] DiameterIdentity OPTIONAL, 112     aaa-Server-Name [8] DiameterIdentity OPTIONAL, 113     sgsn-Name [9] DiameterIdentity OPTIONAL, 114     sgsn-Realm [10] DiameterIdentity OPTIONAL 115 }
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +116 + +``` + +117 ProvideSubscriberLocation-Arg ::= SEQUENCE { +118 locationType LocationType, +119 mlc-Number ISDN-AddressString, +120 lcs-ClientID [0] LCS-ClientID OPTIONAL, +121 privacyOverride [1] NULL OPTIONAL, +122 imsi [2] IMSI OPTIONAL, +123 msisdn [3] ISDN-AddressString OPTIONAL, +124 lmsi [4] LMSI OPTIONAL, +125 imei [5] IMEI OPTIONAL, +126 lcs-Priority [6] LCS-Priority OPTIONAL, +127 lcs-QoS [7] LCS-QoS OPTIONAL, +128 extensionContainer [8] ExtensionContainer OPTIONAL, +129 ... , +130 supportedGADShapes [9] SupportedGADShapes OPTIONAL, +131 lcs-ReferenceNumber [10] LCS-ReferenceNumber OPTIONAL, +132 lcsServiceTypeID [11] LCSServiceTypeID OPTIONAL, +133 lcsCodeword [12] LCSCodeword OPTIONAL, +134 lcs-PrivacyCheck [13] LCS-PrivacyCheck OPTIONAL, +135 areaEventInfo [14] AreaEventInfo OPTIONAL, +136 h-gmlc-Address [15] GSN-Address OPTIONAL, +137 mo-lrShortCircuitIndicator [16] NULL OPTIONAL, +138 periodicLDRInfo [17] PeriodicLDRInfo OPTIONAL, +139 reportingPLMNList [18] ReportingPLMNList OPTIONAL } +140 +141 -- one of imsi or msisdn is mandatory +142 -- If a location estimate type indicates activate deferred location or cancel deferred +143 -- location, a lcs-Reference number shall be included. +144 +145 LocationType ::= SEQUENCE { +146 locationEstimateType [0] LocationEstimateType, +147 ... , +148 deferredLocationEventType [1] DeferredLocationEventType OPTIONAL } +149 +150 LocationEstimateType ::= ENUMERATED { +151 currentLocation (0), +152 currentOrLastKnownLocation (1), +153 initialLocation (2), +154 ... , +155 activateDeferredLocation (3), +156 cancelDeferredLocation (4) , +157 notificationVerificationOnly (5) } +158 -- exception handling: +159 -- a ProvideSubscriberLocation-Arg containing an unrecognized LocationEstimateType +160 -- shall be rejected by the receiver with a return error cause of unexpected data value +161 +162 DeferredLocationEventType ::= BIT STRING { +163 msAvailable (0) , +164 enteringIntoArea (1) , +165 leavingFromArea (2) , +166 beingInsideArea (3) , +167 periodicLDR (4) } (SIZE (1..16)) +168 -- beingInsideArea is always treated as oneTimeEvent regardless of the possible value +169 -- of occurrenceInfo inside areaEventInfo. +170 -- exception handling: +171 -- a ProvideSubscriberLocation-Arg containing other values than listed above in +172 -- DeferredLocationEventType shall be rejected by the receiver with a return error cause of +173 -- unexpected data value. +174 +175 LCS-ClientID ::= SEQUENCE { +176 lcsClientType [0] LCSClientType, +177 lcsClientExternalID [1] LCSClientExternalID OPTIONAL, +178 lcsClientDialedByMS [2] AddressString OPTIONAL, +179 lcsClientInternalID [3] LCSClientInternalID OPTIONAL, +180 lcsClientName [4] LCSClientName OPTIONAL, +181 ... , +182 lcsAPN [5] APN OPTIONAL, +183 lcsRequestorID [6] LCSRequestorID OPTIONAL } +184 + +``` + +``` + +185 LCSClientType ::= ENUMERATED { +186 emergencyServices (0), +187 valueAddedServices (1), +188 plmnOperatorServices (2), +189 lawfulInterceptServices (3), +190 ... } +191 -- exception handling: +192 -- unrecognized values may be ignored if the LCS client uses the privacy override +193 -- otherwise, an unrecognized value shall be treated as unexpected data by a receiver +194 -- a return error shall then be returned if received in a MAP invoke +195 +196 LCSClientName ::= SEQUENCE { +197 dataCodingScheme [0] USSD-DataCodingScheme, +198 nameString [2] NameString, +199 ..., +200 lcs-FormatIndicator [3] LCS-FormatIndicator OPTIONAL } +201 +202 -- The USSD-DataCodingScheme shall indicate use of the default alphabet through the +203 -- following encoding +204 -- bit 7 6 5 4 3 2 1 0 +205 -- 0 0 0 0 1 1 1 1 +206 +207 NameString ::= USSD-String (SIZE (1..maxNameStringLength)) +208 +209 maxNameStringLength INTEGER ::= 63 +210 +211 LCSRequestorID ::= SEQUENCE { +212 dataCodingScheme [0] USSD-DataCodingScheme, +213 requestorIDString [1] RequestorIDString, +214 ..., +215 lcs-FormatIndicator [2] LCS-FormatIndicator OPTIONAL } +216 +217 RequestorIDString ::= USSD-String (SIZE (1..maxRequestorIDStringLength)) +218 +219 maxRequestorIDStringLength INTEGER ::= 63 +220 +221 LCS-FormatIndicator ::= ENUMERATED { +222 logicalName (0), +223 e-mailAddress (1), +224 msisdn (2), +225 url (3), +226 sipUrl (4), +227 ... } +228 +229 LCS-Priority ::= OCTET STRING (SIZE (1)) +230 -- 0 = highest priority +231 -- 1 = normal priority +232 -- all other values treated as 1 +233 +234 LCS-QoS ::= SEQUENCE { +235 horizontal-accuracy [0] Horizontal-Accuracy OPTIONAL, +236 verticalCoordinateRequest [1] NULL OPTIONAL, +237 vertical-accuracy [2] Vertical-Accuracy OPTIONAL, +238 responseTime [3] ResponseTime OPTIONAL, +239 extensionContainer [4] ExtensionContainer OPTIONAL, +240 ..., +241 velocityRequest [5] NULL OPTIONAL, +242 lcs-qos-class [6] LCS-QoS-Class OPTIONAL +243 } +244 -- lcs-qos-class may only be included in MO-LR request sent by the UE to the network. +245 +246 +247 Horizontal-Accuracy ::= OCTET STRING (SIZE (1)) +248 -- bit 8 = 0 +249 -- bits 7-1 = 7 bit Uncertainty Code defined in 3GPP TS 23.032. The horizontal location +250 -- error should be less than the error indicated by the uncertainty code with 67% +251 -- confidence. +252 +253 Vertical-Accuracy ::= OCTET STRING (SIZE (1)) +254 -- bit 8 = 0 +255 -- bits 7-1 = 7 bit Vertical Uncertainty Code defined in 3GPP TS 23.032. +256 -- The vertical location error should be less than the error indicated +257 -- by the uncertainty code with 67% confidence. +258 + +``` + +``` + +259 ResponseTime ::= SEQUENCE { +260 responseTimeCategory ResponseTimeCategory, +261 ...} +262 -- note: an expandable SEQUENCE simplifies later addition of a numeric response time. +263 +264 ResponseTimeCategory ::= ENUMERATED { +265 lowdelay (0), +266 delaytolerant (1), +267 ... } +268 -- exception handling: +269 -- an unrecognized value shall be treated the same as value 1 (delaytolerant) +270 +271 LCS-QoS-Class ::= ENUMERATED { +272 bestEffort (0), +273 assured (1), +274 ... } +275 -- exception handling: +276 -- an unrecognized value shall be treated the same as value 0 (bestEffort) +277 +278 SupportedGADShapes ::= BIT STRING { +279 ellipsoidPoint (0), +280 ellipsoidPointWithUncertaintyCircle (1), +281 ellipsoidPointWithUncertaintyEllipse (2), +282 polygon (3), +283 ellipsoidPointWithAltitude (4), +284 ellipsoidPointWithAltitudeAndUncertaintyEllipsoid (5), +285 ellipsoidArc (6) } (SIZE (7..16)) +286 -- A node shall mark in the BIT STRING all Shapes defined in 3GPP TS 23.032 it supports. +287 -- exception handling: bits 7 to 15 shall be ignored if received. +288 +289 LCS-ReferenceNumber ::= OCTET STRING (SIZE(1)) +290 +291 LCSCodeword ::= SEQUENCE { +292 dataCodingScheme [0] USSD-DataCodingScheme, +293 lcsCodewordString [1] LCSCodewordString, +294 ...} +295 +296 LCSCodewordString ::= USSD-String (SIZE (1..maxLCSCodewordStringLength)) +297 +298 maxLCSCodewordStringLength INTEGER ::= 20 +299 +300 LCS-PrivacyCheck ::= SEQUENCE { +301 callSessionUnrelated [0] PrivacyCheckRelatedAction, +302 callSessionRelated [1] PrivacyCheckRelatedAction OPTIONAL, +303 ...} +304 +305 PrivacyCheckRelatedAction ::= ENUMERATED { +306 allowedWithoutNotification (0), +307 allowedWithNotification (1), +308 allowedIfNoResponse (2), +309 restrictedIfNoResponse (3), +310 notAllowed (4), +311 ...} +312 -- exception handling: +313 -- a ProvideSubscriberLocation-Arg containing an unrecognized PrivacyCheckRelatedAction +314 -- shall be rejected by the receiver with a return error cause of unexpected data value +315 +316 AreaEventInfo ::= SEQUENCE { +317 areaDefinition [0] AreaDefinition, +318 occurrenceInfo [1] OccurrenceInfo OPTIONAL, +319 intervalTime [2] IntervalTime OPTIONAL, +320 ...} +321 +322 AreaDefinition ::= SEQUENCE { +323 areaList [0] AreaList, +324 ...} +325 +326 AreaList ::= SEQUENCE SIZE (1..maxNumOfAreas) OF Area +327 +328 maxNumOfAreas INTEGER ::= 10 +329 +330 Area ::= SEQUENCE { +331 areaType [0] AreaType, +332 areaIdentification [1] AreaIdentification, +333 ...} +334 + +``` + +``` + +335 AreaType ::= ENUMERATED { +336 countryCode (0), +337 plmnId (1), +338 locationAreaId (2), +339 routingAreaId (3), +340 cellGlobalId (4), +341 ..., +342 utranCellId (5) } +343 +344 AreaIdentification ::= OCTET STRING (SIZE (2..7)) +345 -- The internal structure is defined as follows: +346 -- octet 1 bits 4321 Mobile Country Code 1st digit +347 -- bits 8765 Mobile Country Code 2nd digit +348 -- octet 2 bits 4321 Mobile Country Code 3rd digit +349 -- bits 8765 Mobile Network Code 3rd digit if 3 digit MNC included +350 -- or filler (1111) +351 -- octet 3 bits 4321 Mobile Network Code 1st digit +352 -- bits 8765 Mobile Network Code 2nd digit +353 -- octets 4 and 5 Location Area Code (LAC) for Local Area Id, +354 -- Routing Area Id and Cell Global Id +355 -- octet 6 Routing Area Code (RAC) for Routing Area Id +356 -- octets 6 and 7 Cell Identity (CI) for Cell Global Id +357 -- octets 4 until 7 Utran Cell Identity (UC-Id) for Utran Cell Id +358 +359 OccurrenceInfo ::= ENUMERATED { +360 oneTimeEvent (0), +361 multipleTimeEvent (1), +362 ...} +363 +364 IntervalTime ::= INTEGER (1..32767) +365 -- minimum interval time between area reports in seconds +366 +367 PeriodicLDRInfo ::= SEQUENCE { +368 reportingAmount ReportingAmount, +369 reportingInterval ReportingInterval, +370 ..., +371 reportingOptionMilliseconds [0] ReportingOptionMilliseconds OPTIONAL +372 } +373 -- reportingInterval x reportingAmount shall not exceed 8639999 (99 days, 23 hours, +374 -- 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP +375 -- When reportingOptionMilliseconds is provided and supported, reportingInterval & +376 -- reportingAmount shall be ignored. +377 +378 ReportingAmount ::= INTEGER (1..maxReportingAmount) +379 +380 maxReportingAmount INTEGER ::= 8639999 +381 +382 ReportingInterval ::= INTEGER (1..maxReportingInterval) +383 -- ReportingInterval is in seconds +384 +385 maxReportingInterval INTEGER ::= 8639999 +386 +387 ReportingOptionMilliseconds ::= SEQUENCE { +388 reportingAmountMilliseconds ReportingAmountMilliseconds, +389 reportingIntervalMilliseconds ReportingIntervalMilliseconds, +390 ...} +391 -- reportingAmountMilliseconds x reportingIntervalMilliseconds shall not exceed 8639999000 +392 -- (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP +393 +394 ReportingAmountMilliseconds ::= INTEGER (1..maxReportingAmountMilliseconds) +395 +396 maxReportingAmountMilliseconds INTEGER ::= 8639999000 +397 +398 ReportingIntervalMilliseconds ::= INTEGER (1..maxReportingIntervalMilliseconds) +399 +400 maxReportingIntervalMilliseconds INTEGER ::= 999 +401 +402 ReportingPLMNList ::= SEQUENCE { +403 plmn-ListPrioritized [0] NULL OPTIONAL, +404 plmn-List [1] PLMNList, +405 ...} +406 + +``` + +``` + +407 PLMNList ::= SEQUENCE SIZE (1..maxNumOfReportingPLMN) OF +408 ReportingPLMN +409 +410 maxNumOfReportingPLMN INTEGER ::= 20 +411 +412 ReportingPLMN ::= SEQUENCE { +413 plmn-Id [0] PLMN-Id, +414 ran-Technology [1] RAN-Technology OPTIONAL, +415 ran-PeriodicLocationSupport [2] NULL OPTIONAL, +416 ... } +417 +418 RAN-Technology ::= ENUMERATED { +419 gsm (0), +420 umts (1), +421 ... } +422 +423 ProvideSubscriberLocation-Res ::= SEQUENCE { +424 locationEstimate Ext-GeographicalInformation, +425 ageOfLocationEstimate [0] AgeOfLocationInformation OPTIONAL, +426 extensionContainer [1] ExtensionContainer OPTIONAL, +427 ... , +428 add-LocationEstimate [2] Add-GeographicalInformation OPTIONAL, +429 deferredmt-lrResponseIndicator [3] NULL OPTIONAL, +430 geranPositioningData [4] PositioningDataInformation OPTIONAL, +431 utranPositioningData [5] UtranPositioningDataInfo OPTIONAL, +432 cellIdOrSai [6] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, +433 sai-Present [7] NULL OPTIONAL, +434 accuracyFulfilmentIndicator [8] AccuracyFulfilmentIndicator OPTIONAL, +435 velocityEstimate [9] VelocityEstimate OPTIONAL, +436 mo-lrShortCircuitIndicator [10] NULL OPTIONAL, +437 geranGANSPositioningData [11] GeranGANSPositioningData OPTIONAL, +438 utranGANSPositioningData [12] UtranGANSPositioningData OPTIONAL, +439 targetServingNodeForHandover [13] ServingNodeAddress OPTIONAL, +440 utranAdditionalPositioningData [14] UtranAdditionalPositioningData OPTIONAL, +441 utranBaroPressureMeas [15] UtranBaroPressureMeas OPTIONAL, +442 utranCivicAddress [16] UtranCivicAddress OPTIONAL } +443 +444 -- if deferredmt-lrResponseIndicator is set, locationEstimate is ignored. +445 +446 -- the add-LocationEstimate parameter shall not be sent to a node that did not indicate the +447 -- geographic shapes supported in the ProvideSubscriberLocation-Arg +448 -- The locationEstimate and the add-locationEstimate parameters shall not be sent if +449 -- the supportedGADShapes parameter has been received in ProvideSubscriberLocation-Arg +450 -- and the shape encoded in locationEstimate or add-LocationEstimate is not marked +451 -- as supported in supportedGADShapes. In such a case ProvideSubscriberLocation +452 -- shall be rejected with error FacilityNotSupported with additional indication +453 -- shapeOfLocationEstimateNotSupported. +454 -- sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity. +455 +456 AccuracyFulfilmentIndicator ::= ENUMERATED { +457 requestedAccuracyFulfilled (0), +458 requestedAccuracyNotFulfilled (1), +459 ... } +460 + +``` + +``` + +461 Ext-GeographicalInformation ::= OCTET STRING (SIZE (1..maxExt-GeographicalInformation)) +462 -- Refers to geographical Information defined in 3GPP TS 23.032. +463 -- This is composed of 1 or more octets with an internal structure according to +464 -- 3GPP TS 23.032 +465 -- Octet 1: Type of shape, only the following shapes in 3GPP TS 23.032 are allowed: +466 -- (a) Ellipsoid point with uncertainty circle +467 -- (b) Ellipsoid point with uncertainty ellipse +468 -- (c) Ellipsoid point with altitude and uncertainty ellipsoid +469 -- (d) Ellipsoid Arc +470 -- (e) Ellipsoid Point +471 -- Any other value in octet 1 shall be treated as invalid +472 -- Octets 2 to 8 for case (a) - Ellipsoid point with uncertainty circle +473 -- Degrees of Latitude 3 octets +474 -- Degrees of Longitude 3 octets +475 -- Uncertainty code 1 octet +476 -- Octets 2 to 11 for case (b) - Ellipsoid point with uncertainty ellipse: +477 -- Degrees of Latitude 3 octets +478 -- Degrees of Longitude 3 octets +479 -- Uncertainty semi-major axis 1 octet +480 -- Uncertainty semi-minor axis 1 octet +481 -- Angle of major axis 1 octet +482 -- Confidence 1 octet +483 -- Octets 2 to 14 for case (c) - Ellipsoid point with altitude and uncertainty ellipsoid +484 -- Degrees of Latitude 3 octets +485 -- Degrees of Longitude 3 octets +486 -- Altitude 2 octets +487 -- Uncertainty semi-major axis 1 octet +488 -- Uncertainty semi-minor axis 1 octet +489 -- Angle of major axis 1 octet +490 -- Uncertainty altitude 1 octet +491 -- Confidence 1 octet +492 -- Octets 2 to 13 for case (d) - Ellipsoid Arc +493 -- Degrees of Latitude 3 octets +494 -- Degrees of Longitude 3 octets +495 -- Inner radius 2 octets +496 -- Uncertainty radius 1 octet +497 -- Offset angle 1 octet +498 -- Included angle 1 octet +499 -- Confidence 1 octet +500 -- Octets 2 to 7 for case (e) - Ellipsoid Point +501 -- Degrees of Latitude 3 octets +502 -- Degrees of Longitude 3 octets +503 +504 -- +505 -- An Ext-GeographicalInformation parameter comprising more than one octet and +506 -- containing any other shape or an incorrect number of octets or coding according +507 -- to 3GPP TS 23.032 shall be treated as invalid data by a receiver. +508 -- +509 -- An Ext-GeographicalInformation parameter comprising one octet shall be discarded +510 -- by the receiver if an Add-GeographicalInformation parameter is received +511 -- in the same message. +512 -- +513 -- An Ext-GeographicalInformation parameter comprising one octet shall be treated as +514 -- invalid data by the receiver if an Add-GeographicalInformation parameter is not +515 -- received in the same message. + +``` + +``` + +516 +517 maxExt-GeographicalInformation INTEGER ::= 20 +518 -- the maximum length allows for further shapes in 3GPP TS 23.032 to be included in later +519 -- versions of 3GPP TS 29.002 +520 + +``` + +``` +521 VelocityEstimate ::= OCTET STRING (SIZE (4..7)) +522 -- Refers to Velocity description defined in 3GPP TS 23.032. +523 -- This is composed of 4 or more octets with an internal structure according to +524 -- 3GPP TS 23.032 +525 -- Octet 1: Type of velocity, only the following types in 3GPP TS 23.032 are allowed: +526 -- (a) Horizontal Velocity +527 -- (b) Horizontal with Vertical Velocity +528 -- (c) Horizontal Velocity with Uncertainty +529 -- (d) Horizontal with Vertical Velocity and Uncertainty +530 -- For types Horizontal with Vertical Velocity and Horizontal with Vertical Velocity +531 -- and Uncertainty, the direction of the Vertical Speed is also included in Octet 1 +532 -- Any other value in octet 1 shall be treated as invalid +533 -- Octets 2 to 4 for case (a) Horizontal velocity: +534 -- Bearing 1 octet +535 -- Horizontal Speed 2 octets +536 -- Octets 2 to 5 for case (b) - Horizontal with Vertical Velocity: +537 -- Bearing 1 octet +538 -- Horizontal Speed 2 octets +539 -- Vertical Speed 1 octet +540 -- Octets 2 to 5 for case (c) - Horizontal velocity with Uncertainty: +541 -- Bearing 1 octet +542 -- Horizontal Speed 2 octets +543 -- Uncertainty Speed 1 octet +544 -- Octets 2 to 7 for case (d) - Horizontal with Vertical Velocity and Uncertainty: +545 -- Bearing 1 octet +546 -- Horizontal Speed 2 octets +547 -- Vertical Speed 1 octet +548 -- Horizontal Uncertainty Speed 1 octet +549 -- Vertical Uncertainty Speed 1 octet +``` + +``` +551 PositioningDataInformation ::= OCTET STRING (SIZE (2..maxPositioningDataInformation)) +552 -- Refers to the Positioning Data defined in 3GPP TS 49.031. +553 -- This is composed of 2 or more octets with an internal structure according to +554 -- 3GPP TS 49.031. +``` + +``` +556 maxPositioningDataInformation INTEGER ::= 10 +557 -- +``` + +``` +559 UtranPositioningDataInfo ::= OCTET STRING (SIZE (3..maxUtranPositioningDataInfo)) +560 -- Refers to the Position Data defined in 3GPP TS 25.413. +561 -- This is composed of the positioningDataDiscriminator and the positioningDataSet +562 -- included in positionData as defined in 3GPP TS 25.413. +``` + +``` +564 maxUtranPositioningDataInfo INTEGER ::= 11 +565 -- +``` + +``` +567 GeranGANSSEpositioningData ::= OCTET STRING (SIZE (2..maxGeranGANSSEpositioningData)) +568 -- Refers to the GANSSE Positioning Data defined in 3GPP TS 49.031. +569 -- This is composed of 2 or more octets with an internal structure according to +570 -- 3GPP TS 49.031. +``` + +``` +572 maxGeranGANSSEpositioningData INTEGER ::= 10 +573 -- +``` + +``` +575 UtranGANSSEpositioningData ::= OCTET STRING (SIZE (1..maxUtranGANSSEpositioningData)) +576 -- Refers to the Position Data defined in 3GPP TS 25.413. +577 -- This is composed of the GANSSE-PositioningDataSet only, included in PositionData +578 -- as defined in 3GPP TS 25.413. +``` + +``` +580 maxUtranGANSSEpositioningData INTEGER ::= 9 +581 -- +``` + +``` +583 UtranAdditionalPositioningData ::= OCTET STRING (SIZE (1..maxUtranAdditionalPositioningData)) +584 -- Refers to the Position Data defined in 3GPP TS 25.413. +585 -- This is composed of the Additional-PositioningDataSet only, included in PositionData +586 -- as defined in 3GPP TS 25.413. +``` + +``` +588 maxUtranAdditionalPositioningData INTEGER ::= 8 +589 -- +``` + +``` +591 UtranBaroPressureMeas ::= INTEGER (30000..115000) +592 -- Refers to the barometric pressure measurement defined in 3GPP TS 25.413. +593 -- This is composed of the BarometricPressureMeasurement only as defined in 3GPP TS +594 -- 25.413. +``` + +``` +595 +``` + +``` + +596 UtranCivicAddress ::= OCTET STRING +597 -- Refers to the civic address defined in 3GPP TS 25.413. +598 -- This is composed of the CivicAddress only as defined in 3GPP TS 25.413. +599 +600 Add-GeographicalInformation ::= OCTET STRING (SIZE (1..maxAdd-GeographicalInformation)) +601 -- Refers to geographical Information defined in 3GPP TS 23.032. +602 -- This is composed of 1 or more octets with an internal structure according to +603 -- 3GPP TS 23.032 +604 -- Octet 1: Type of shape, all the shapes defined in 3GPP TS 23.032 are allowed: +605 -- Octets 2 to n (where n is the total number of octets necessary to encode the shape +606 -- according to 3GPP TS 23.032) are used to encode the shape itself in accordance with +607 the +608 -- encoding defined in 3GPP TS 23.032 +609 -- +610 -- An Add-GeographicalInformation parameter, whether valid or invalid, received +611 -- together with a valid Ext-GeographicalInformation parameter in the same message +612 -- shall be discarded. +613 -- +614 -- An Add-GeographicalInformation parameter containing any shape not defined in +615 -- 3GPP TS 23.032 or an incorrect number of octets or coding according to +616 -- 3GPP TS 23.032 shall be treated as invalid data by a receiver if not received +617 -- together with a valid Ext-GeographicalInformation parameter in the same message. +618 +619 maxAdd-GeographicalInformation INTEGER ::= 91 +620 -- the maximum length allows support for all the shapes currently defined in 3GPP TS +621 23.032 +622 +623 SubscriberLocationReport-Arg ::= SEQUENCE { +624 lcs-Event LCS-Event, +625 lcs-ClientID LCS-ClientID, +626 lcsLocationInfo LCSLocationInfo, +627 msisdn [0] ISDN-AddressString OPTIONAL, +628 imsi [1] IMSI OPTIONAL, +629 imei [2] IMEI OPTIONAL, +630 na-ESRD [3] ISDN-AddressString OPTIONAL, +631 na-ESRK [4] ISDN-AddressString OPTIONAL, +632 locationEstimate [5] Ext-GeographicalInformation OPTIONAL, +633 ageOfLocationEstimate [6] AgeOfLocationInformation OPTIONAL, +634 slr-ArgExtensionContainer [7] SLR-ArgExtensionContainer OPTIONAL, +635 ... , +636 add-LocationEstimate [8] Add-GeographicalInformation OPTIONAL, +637 deferredmt-lrData [9] Deferredmt-lrData OPTIONAL, +638 lcs-ReferenceNumber [10] LCS-ReferenceNumber OPTIONAL, +639 geranPositioningData [11] PositioningDataInformation OPTIONAL, +640 utranPositioningData [12] UtranPositioningDataInfo OPTIONAL, +641 cellIdOrSai [13] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, +642 h-gmlc-Address [14] GSN-Address OPTIONAL, +643 lcssServiceTypeID [15] LCSServiceTypeID OPTIONAL, +644 sai-Present [17] NULL OPTIONAL, +645 pseudonymIndicator [18] NULL OPTIONAL, +646 accuracyFulfilmentIndicator [19] AccuracyFulfilmentIndicator OPTIONAL, +647 velocityEstimate [20] VelocityEstimate OPTIONAL, +648 sequenceNumber [21] SequenceNumber OPTIONAL, +649 periodicLDRInfo [22] PeriodicLDRInfo OPTIONAL, +650 mo-lrShortCircuitIndicator [23] NULL OPTIONAL, +651 geranGANSPositioningData [24] GeranGANSPositioningData OPTIONAL, +652 utranGANSPositioningData [25] UtranGANSPositioningData OPTIONAL, +653 targetServingNodeForHandover [26] ServingNodeAddress OPTIONAL, +654 utranAdditionalPositioningData [27] UtranAdditionalPositioningData OPTIONAL, +655 utranBaroPressureMeas [28] UtranBaroPressureMeas OPTIONAL, +656 utranCivicAddress [29] UtranCivicAddress OPTIONAL } +657 +658 -- one of msisdn or imsi is mandatory +659 -- a location estimate that is valid for the locationEstimate parameter should +660 -- be transferred in this parameter in preference to the add-LocationEstimate. +661 -- the deferredmt-lrData parameter shall be included if and only if the lcs-Event +662 -- indicates a deferredmt-lrResponse. +663 -- if the lcs-Event indicates a deferredmt-lrResponse then the locationEstimate +664 -- and the add-LocationEstimate parameters shall not be sent if the +665 -- supportedGADShapes parameter had been received in ProvideSubscriberLocation-Arg +666 -- and the shape encoded in locationEstimate or add-LocationEstimate was not marked +667 -- as supported in supportedGADShapes. In such a case terminationCause +668 -- in deferredmt-lrData shall be present with value +669 -- shapeOfLocationEstimateNotSupported. +670 -- If a lcs event indicates deferred mt-lr response, the lcs-Reference number shall be +671 -- included. +672 -- sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity. +673 + +``` + +``` + +674 Deferredmt-lrData ::= SEQUENCE { +675 deferredLocationEventType DeferredLocationEventType, +676 terminationCause [0] TerminationCause OPTIONAL, +677 lcsLocationInfo [1] LCSLocationInfo OPTIONAL, +678 ...} +679 -- lcsLocationInfo may be included only if a terminationCause is present +680 -- indicating mt-lrRestart. +681 +682 LCS-Event ::= ENUMERATED { +683 emergencyCallOrigination (0), +684 emergencyCallRelease (1), +685 mo-lr (2), +686 ..., +687 deferredmt-lrResponse (3) , +688 deferredmo-lrTTTPInitiation (4), +689 emergencyCallHandover (5) } +690 -- deferredmt-lrResponse is applicable to the delivery of a location estimate +691 -- for an LDR initiated earlier by either the network (via an MT-LR activate deferred +692 -- location) or the UE (via a deferred MO-LR TTTP initiation) +693 -- exception handling: +694 -- a SubscriberLocationReport-Arg containing an unrecognized LCS-Event +695 -- shall be rejected by a receiver with a return error cause of unexpected data value +696 +697 TerminationCause ::= ENUMERATED { +698 normal (0), +699 errorundefined (1), +700 internalTimeout (2), +701 congestion (3), +702 mt-lrRestart (4), +703 privacyViolation (5), +704 ..., +705 shapeOfLocationEstimateNotSupported (6) , +706 subscriberTermination (7), +707 uETermination (8), +708 networkTermination (9) } +709 -- mt-lrRestart shall be used to trigger the GMLC to restart the location procedure, +710 -- either because the sending node knows that the terminal has moved under coverage +711 -- of another MSC or SGSN (e.g. Send Identification received), or because the subscriber +712 -- has been deregistered due to a Cancel Location received from HLR. +713 -- +714 -- exception handling +715 -- an unrecognized value shall be treated the same as value 1 (errorundefined) +716 +717 SequenceNumber ::= INTEGER (1..maxReportingAmount) +718 +719 ServingNodeAddress ::= CHOICE { +720 msc-Number [0] ISDN-AddressString, +721 sgsn-Number [1] ISDN-AddressString, +722 mme-Number [2] DiameterIdentity } +723 +724 SubscriberLocationReport-Res ::= SEQUENCE { +725 extensionContainer ExtensionContainer OPTIONAL, +726 ..., +727 na-ESRK [0] ISDN-AddressString OPTIONAL, +728 na-ESRD [1] ISDN-AddressString OPTIONAL, +729 h-gmlc-Address [2] GSN-Address OPTIONAL, +730 mo-lrShortCircuitIndicator [3] NULL OPTIONAL, +731 reportingPLMNList [4] ReportingPLMNList OPTIONAL, +732 lcs-ReferenceNumber [5] LCS-ReferenceNumber OPTIONAL } +733 +734 -- na-ESRK and na-ESRD are mutually exclusive +735 -- +736 -- exception handling +737 -- receipt of both na-ESRK and na-ESRD shall be treated the same as a return error +738 +739 +740 END + +``` + +## 17.7.14 Void + +--- + +## 742 18 General on MAP user procedures + +### 743 18.1 Introduction + +744 Clauses 18 to 25 describe the use of MAP services for GSM signalling procedures. GSM signalling procedures may +745 involve one or several interfaces running one or several application protocols. The present document addresses only the +746 signalling procedures which require at least the use of one MAP service. + +747 When a signalling procedure takes place in the network, an application process invocation is created in each system +748 component involved. Part of the application process invocation acts as a MAP user and handles one or several MAP +749 dialogues. For each dialogue it employs an instance of the MAP service provider. It may also use other communication +750 services to exchange information on other interfaces, but detailed description of these aspects is outside the scope of the +751 present document. + +### 752 18.2 Common aspects of user procedure descriptions + +#### 753 18.2.1 General conventions + +754 For each signalling procedure the present document provides a brief textual overview accompanied by a flow diagram +755 which represent the functional interactions between system components. Functional interactions are labelled using the +756 MAP service name when the interaction results from a service request or by this service name followed by the symbol +757 "ack" when this interaction results from a service response. + +758 For each of the system components involved, the present document also provides a detailed textual description of the +759 application process behaviour as well as an SDL diagram. SDL diagrams describe the sequence of events, as seen by the +760 MAP-User, which occurs at MAP service provider boundaries as well as external events which occur at other interfaces +761 and which impact on the previous sequence. + +762 External events do not necessarily correspond to the messages of other protocols used in the system component. The +763 MAP-user procedures are described as if a set of interworking functions (IWF) between the MAP-user and the other +764 protocol entities was implemented (see figure 18.2/1). Such interworking functions are assumed to perform either an +765 identity mapping or some processing or translation as required to eliminate information irrelevant to the MAP-user. + +766 The mapping of service primitives on to protocol elements is described in clauses 14 to 17. + +767 GSM signalling procedures are built from one or more sub-procedures (e.g. authentication, ciphering, ...). + +768 Sub-procedures from which signalling procedures are built are represented using SDL MACRO descriptions. + +769 In case of any discrepancy between the textual descriptions and the SDL descriptions, the latter take precedence. + +#### 770 18.2.2 Naming conventions + +771 Events related to MAP are represented by MAP service primitives. The signal names used in the SDL diagrams are +772 derived from the service primitive names defined in clauses 7 to 12, with some lexical transformations for readability +773 and parsability purposes (blanks between words are replaced by underscores, the first letter of each word is capitalised). + +774 Events received and sent on other interfaces are named by appending the message or signal name to a symbol +775 representing the interface type, with some lexical transformations for readability and parsability purposes (blanks +776 between words are replaced by underscores, the first letter of each word is capitalised). + +777 The following symbols are used to represent the interface types: + +778 "I": For interfaces to the fixed network. "I" stands for ISUP interface. + +779 "A": For interfaces between the MSC and the BSS (i.e. A-interfaces); + +780 "Gb": For interfaces between the SGSN and the BSS (i.e. Gb-interfaces); + +781 "OM": For network management interfaces (communication with OMC, MML interface, ...); +782 "SC": For interfaces to a Service Centre; +783 "HO\_CA": For internal interfaces to the Handover Control Application. +784 "US": For a local USSD application. + +785 These naming conventions can be summarised by the following BNF description: + +``` + +786 ::= | +787 ::= | | | | +788 | +789 ::= MAP_Open_Req | MAP_Open_Ind | MAP_Open_Rsp | MAP_Open_Cnf +790 ::= MAP_Close_Req | MAP_Close_Ind +791 ::= MAP_U_Abort_Req | MAP_U_Abort_Ind +792 ::= MAP_P_Abort_Ind +793 ::= MAP_Notice_Ind +794 ::= | | | +795 ::= MAP__Req +796 ::= MAP__Ind +797 ::= MAP__Rsp +798 ::= MAP__Cnf +799 ::= _ +800 ::= I | A | Gb | OM | SC | HO AC | US +801 ::= +802 ::= +803 ::= | _ +804 ::= +805 ::= | +806 ::= | +807 ::= | +808 ::= A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z +809 ::= a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z +810 ::= 1|2|3|4|5|6|7|8|9|0 + +``` + +811 **Figure 18.2/1: Interfaces applicable to the MAP-User** + +## 812 18.2.3 Convention on primitives parameters + +### 813 18.2.3.1 Open service + +814 When the originating and destination reference parameters shall be included in the MAP-OPEN request primitive, their +815 value are indicated as a comment to the signal which represents this primitive. + +### 816 18.2.3.2 Close service + +817 When a pre-arranged release is requested, a comment is attached to the signal which represents the MAP-CLOSE +818 request primitive. In the absence of comment, a normal release is assumed. + +## 819 18.2.4 Version handling at dialogue establishment + +820 Unless explicitly indicated in subsequent clauses, the following principles regarding version handling procedures at +821 dialogue establishment are applied by the MAP-user. + +### 822 18.2.4.1 Behaviour at the initiating side + +823 When a MAP user signalling procedure has to be executed, the MAP-user issues a MAP-OPEN request primitive with +824 an appropriate application-context-name. If several names are supported (i.e. several versions) a suitable one is selected +825 using the procedures described in clause 5. + +826 + +827 If version n is selected (where $1 < n \leq$ highest existing version) and a MAP-OPEN Confirm primitive is received in +828 response to the MAP-OPEN request with a result parameter set to "refused" and a diagnostic parameter indicating +829 "application context not supported" or "potential version incompatibility problem", the MAP-User issues a new MAP- +830 OPEN request primitive with the equivalent version y context (where $1 \leq y < n$ ). This is informally represented in the +831 SDL diagrams by task symbols indicating 'Perform Vr procedure'. + +### 832 18.2.4.2 Behaviour at the responding side + +833 On receipt of a MAP-OPEN indication primitive, the MAP-User analyses the application-context-name and executes +834 the procedure associated with the requested version context. For example, if it refers to a version one context, the +835 associated V1 procedure is executed; if it refers to a version two context, the associated V2 procedure is executed; etc. + +## 836 18.2.5 Abort Handling + +837 Unless explicitly indicated in subsequent clauses, the following principles are applied by the MAP-user regarding abort +838 handling procedures: + +839 On receipt of a MAP-P-ABORT indication or MAP-U-ABORT Indication primitive from any MAP-provider +840 invocation, the MAP-User issues a MAP-U-ABORT Request primitive to each MAP-provider invocation associated +841 with the same user procedure. + +842 If applicable a decision is made to decide if the affected user procedure has to be retried or not. + +## 843 18.2.6 SDL conventions + +844 The MAP SDLs make use of a number of SDL concepts and conventions, where not all of them may be widely known. +845 Therefore, this clause outlines the use of a few concepts and conventions to improve understanding of the MAP SDLs. + +846 The MAP User SDLs make use of SDL Processes, Procedures and Macros. Processes are independent from each other +847 even if one process starts another one: The actions of both of them have no ordering in time. SDL Procedures and +848 Macros are just used to ease writing of the specification: They contain parts of a behaviour used in several places, and +849 the corresponding Procedure/Macro definition has to be expanded at the position of the Procedure/Macro call. + +850 All Processes are started at system initialisation and live forever, unless process creation/termination is indicated +851 explicitly (i.e. a process is created by some other process). + +852 The direction of Input/Output Signals in the SDL graphs is used to indicate the entity to which/from which +853 communication is directed. If a process A communicates in parallel with processes B and C, all Inputs/Outputs to/from +854 B are directed to one side, whereas communication with C is directed to the other side. However, there has been no + +855 formal convention used that communication to a certain entity (e.g. a HLR) will always be directed to a certain side +856 (e.g. right). + +857 In each state all those Input Signals are listed, which result in an action and/or state change. If an Input Signal is not +858 listed in a state, receipt of this input should lead to an implicit consumption without any action or state change +859 (according to the SDL rules). This implicit consumption is mainly used for receipt of the MAP DELIMITER indication +860 and for receipt of a MAP CLOSE indication, except for a premature MAP CLOSE. + +## 861 18.3 Interaction between MAP Provider and MAP Users + +862 Each MAP User is defined by at least one SDL process. On the dialogue initiating side, the MAP User will create a new +863 instance of a MAP Provider implicit by issuing a MAP-OPEN request. This instance corresponds to a TC Dialogue and +864 lives as long as the dialogue exists (see also clause 14.3). There is a fixed relation between MAP User and this Provider +865 instance, i.e. all MAP service primitives from the MAP User for this dialogue are sent to this instance and all TC +866 components received by this MAP Provider are mapped onto service primitives sent to this MAP User. + +867 On the receiving side a MAP Provider instance is created implicit by receipt of a TC BEGIN indication. The +868 corresponding MAP User is determined by the Application Context name included in this primitive, i.e. each +869 Application Context is associated with one and only one MAP User. An instance of this User will be created implicitly +870 by receiving a MAP-OPEN indication. Note that in some cases there exist several SDL Processes for one MAP User +871 (Application Context), e.g. the processes Register\_SS\_HLR, Erase\_SS\_HLR, Activate\_SS\_HLR, Deactivate\_SS\_HLR, +872 Interrogate\_SS\_HLR, and Register\_Password for the AC Network\_Functional\_SS\_Handling. In these cases, a +873 coordinator process is introduced acting as a MAP User, which in turn starts a sub-process depending on the first MAP +874 service primitive received. + +--- + +## 875 19 Mobility procedures + +### 876 19.1 Location management Procedures + +877 The signalling procedures in this clause support: + +- 878 - Interworking between the VLR and the HLR and between the VLR and the previous VLR (PVLR) when a non- +879 GPRS subscriber performs a location update to a new VLR service area; +- 880 - Interworking between the SGSN, the HLR and the VLR when a subscriber with both GPRS and non-GPRS +881 subscriptions performs a routeing area update in an SGSN and the Gs interface is implemented; +- 882 - Interworking between the SGSN and the VLR when a GPRS subscriber performs a routeing area update to a new +883 SGSN service area; +- 884 - Interworking between the HLR and the VLR and between the HLR and the SGSN to delete a subscriber record +885 from the VLR or the SGSN; +- 886 - Interworking between the VLR and the HLR and between the SGSN and the HLR to report to the HLR that a +887 subscriber record has been purged from the VLR or the SGSN. + +888 The MAP co-ordinating process in the HLR to handle a dialogue opened with the network location updating context is +889 shown in figure 19.1/1. The MAP process invokes a macro not defined in this clause; the definition of this macro can be +890 found as follows: + +891     Receive\_Open\_Ind see clause 25.1.1. + +![State transition diagram for process Location_Management_Coordinator_HLR. The diagram shows transitions between states (Null, Wait_For_Service_Primitive, Update_Location_HLR, Restore_Data_HLR, MAP_CLOSE_req) and actions (Receive_Open_ind, Perform_MAP_Vr_dialogue, MAP_UPDATE_LOCATION_ind, MAP_RESTORE_DATA_ind, MAP_NOTICE_ind, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind). It includes callouts to figures 19.1.1/13 and 19.3.1/2. The diagram is divided into three horizontal sections by lines, with the bottom section containing four parallel paths.](0e9742f79dd41bef90d8187d1716879b_img.jpg) + +**process Location\_Management\_Coordinator\_HLR** LMC\_HLR1(1) + +Process in the HLR to handle a dialogue opening request using the application context neiLocUpContext. + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the child process + +``` + +stateDiagram-v2 + [*] --> Null + Null --> Receive_Open_ind + Receive_Open_ind --> Perform_MAP_Vr_dialogue : Vr + Perform_MAP_Vr_dialogue --> Null + Receive_Open_ind --> Wait_For_Service_Primitive : OK + Receive_Open_ind --> Null : Error + Wait_For_Service_Primitive --> MAP_UPDATE_LOCATION_ind + Wait_For_Service_Primitive --> MAP_RESTORE_DATA_ind + Wait_For_Service_Primitive --> MAP_NOTICE_ind + Wait_For_Service_Primitive --> MAP_U_ABORT_ind + MAP_UPDATE_LOCATION_ind --> Update_Location_HLR : Figure 19.1.1/13 + Update_Location_HLR --> MAP_UPDATE_LOCATION_ind + MAP_UPDATE_LOCATION_ind --> Relay_Info + MAP_RESTORE_DATA_ind --> Restore_Data_HLR : Figure 19.3.1/2 + Restore_Data_HLR --> MAP_RESTORE_DATA_ind + MAP_RESTORE_DATA_ind --> Relay_Info + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + MAP_U_ABORT_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Null + MAP_U_ABORT_req --> Relay_Info + MAP_P_ABORT_req --> Null + MAP_P_ABORT_req --> Relay_Info + MAP_CLOSE_req --> Null + MAP_CLOSE_req --> Relay_Info + +``` + +State transition diagram for process Location\_Management\_Coordinator\_HLR. The diagram shows transitions between states (Null, Wait\_For\_Service\_Primitive, Update\_Location\_HLR, Restore\_Data\_HLR, MAP\_CLOSE\_req) and actions (Receive\_Open\_ind, Perform\_MAP\_Vr\_dialogue, MAP\_UPDATE\_LOCATION\_ind, MAP\_RESTORE\_DATA\_ind, MAP\_NOTICE\_ind, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind). It includes callouts to figures 19.1.1/13 and 19.3.1/2. The diagram is divided into three horizontal sections by lines, with the bottom section containing four parallel paths. + +892 + +893 + +**Figure 19.1/1: Process Location\_Management\_Coordinator\_HLR** + +## 894 19.1.1 Location updating + +### 895 19.1.1.1 General + +896 The stage 2 specification for GPRS is in 3GPP TS 23.060 [104]. The interworking between the MAP signalling + 897 procedures and the GPRS procedures in the SGSN and the HLR is shown by the transfer of signals between these + 898 procedures. + +899 The message flow for successful inter-VLR location updating when the IMSI can be retrieved from the PVLR is shown +900 in figure 19.1.1/2. + +901 The message flow for successful inter-VLR location updating when the IMSI cannot be retrieved from the PVLR is +902 shown in figure 19.1.1/3. + +903 The message flow for successful GPRS Attach/RA update procedure (Gs interface not installed) is shown in figure +904 19.1.1/4. + +905 The message flow for successful GPRS Attach/RA update procedure combined with a successful VLR location +906 updating (Gs interface installed) is shown in figure 19.1.1/5. + +![Sequence diagram showing message flow for location updating to a new VLR area. Lifelines: MS, MSC/VLR, PVLR, HLR. The diagram shows 12 numbered messages. 1: MS to MSC/VLR (dotted line); 2: MSC/VLR to PVLR; 3: PVLR to MSC/VLR; 4: MSC/VLR to HLR; 5: HLR to PVLR; 6: PVLR to HLR; 7: HLR to MSC/VLR; 8: MSC/VLR to HLR; 9: MSC/VLR to HLR; 10: HLR to MSC/VLR; 11: MSC/VLR to HLR; 12: MSC/VLR to MS (dotted line).](da535696dd83f3ef649c81510656b0d0_img.jpg) + +``` +sequenceDiagram + participant MS + participant MSC/VLR + participant PVLR + participant HLR + Note left of MS: 1) A_LU_REQUEST (Note 1) + MS-->>MSC/VLR: + Note right of MSC/VLR: 2) MAP_SEND_IDENTIFICATION_req/ind + MSC/VLR->>PVLR: + Note right of PVLR: 3) MAP_SEND_IDENTIFICATION_rsp/cnf + PVLR-->>MSC/VLR: + Note right of MSC/VLR: 4) MAP_UPDATE_LOCATION_req/ind + MSC/VLR->>HLR: + Note right of HLR: 5) MAP_CANCEL_LOCATION_req/ind + HLR-->>PVLR: + Note right of PVLR: 6) MAP_CANCEL_LOCATION_rsp/cnf + PVLR-->>HLR: + Note right of HLR: 7) MAP_ACTIVATE_TRACE_MODE_req/ind (Note 2) + HLR-->>MSC/VLR: + Note right of MSC/VLR: 8) MAP_ACTIVATE_TRACE_MODE_rsp/cnf (Note 2) + MSC/VLR->>HLR: + Note right of HLR: 9) MAP_INSERT_SUBSCRIBER_DATA_req/ind + HLR-->>MSC/VLR: + Note right of MSC/VLR: 10) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf + MSC/VLR->>HLR: + Note right of HLR: 11) MAP_UPDATE_LOCATION_rsp/cnf + HLR-->>MSC/VLR: + Note right of MSC/VLR: 12) A_LU_CONFIRM (Note 1) + MSC/VLR-->>MS: +``` + +Sequence diagram showing message flow for location updating to a new VLR area. Lifelines: MS, MSC/VLR, PVLR, HLR. The diagram shows 12 numbered messages. 1: MS to MSC/VLR (dotted line); 2: MSC/VLR to PVLR; 3: PVLR to MSC/VLR; 4: MSC/VLR to HLR; 5: HLR to PVLR; 6: PVLR to HLR; 7: HLR to MSC/VLR; 8: MSC/VLR to HLR; 9: MSC/VLR to HLR; 10: HLR to MSC/VLR; 11: MSC/VLR to HLR; 12: MSC/VLR to MS (dotted line). + +907 + +908 PVLR = Previous VLR + +909 + +- 910 1) A\_LU\_REQUEST (Note 1) +- 911 2) MAP\_SEND\_IDENTIFICATION\_req/ind +- 912 3) MAP\_SEND\_IDENTIFICATION\_rsp/cnf +- 913 4) MAP\_UPDATE\_LOCATION\_req/ind +- 914 5) MAP\_CANCEL\_LOCATION\_req/ind +- 915 6) MAP\_CANCEL\_LOCATION\_rsp/cnf +- 916 7) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 2) +- 917 8) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 2) +- 918 9) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 919 10) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 920 11) MAP\_UPDATE\_LOCATION\_rsp/cnf +- 921 12) A\_LU\_CONFIRM (Note 1) + +922 + +923 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35]. Services shown in dotted lines +924 indicate the trigger provided by the signalling on the radio path, and the signalling triggered on the radio +925 path. + +926 NOTE 2: Services printed in *italics* are optional. + +927 + +928 **Figure 19.1.1/2: Message flow for location updating to a new VLR area,** +929 **when the IMSI can be retrieved from the previous VLR** + +![Sequence diagram showing message flow for location updating to a new VLR area. Lifelines: MS, MSC/VLR, PVLR, HLR. The diagram shows 12 numbered messages. Messages 2, 3, and 12 are shown with dashed lines, indicating they are triggered by radio path signalling. Messages 7, 8, and 9 are shown in italics, indicating they are optional. The sequence is: 1) MS to MSC/VLR (A_LU_REQUEST); 2) MSC/VLR to MS (A_IDENTITY_REQUEST); 3) MS to MSC/VLR (A_IDENTITY_RESPONSE); 4) MSC/VLR to HLR (MAP_UPDATE_LOCATION_req/ind); 5) HLR to PVLR (MAP_CANCEL_LOCATION_req/ind); 6) PVLR to HLR (MAP_CANCEL_LOCATION_rsp/cnf); 7) HLR to MSC/VLR (MAP_ACTIVATE_TRACE_MODE_req/ind); 8) MSC/VLR to HLR (MAP_ACTIVATE_TRACE_MODE_rsp/cnf); 9) HLR to MSC/VLR (MAP_INSERT_SUBSCRIBER_DATA_req/ind); 10) MSC/VLR to HLR (MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf); 11) HLR to MSC/VLR (MAP_UPDATE_LOCATION_rsp/cnf); 12) MSC/VLR to MS (A_LU_CONFIRM).](0282ba2f6b0525117a4f18ceeadbb2bb_img.jpg) + +Sequence diagram showing message flow for location updating to a new VLR area. Lifelines: MS, MSC/VLR, PVLR, HLR. The diagram shows 12 numbered messages. Messages 2, 3, and 12 are shown with dashed lines, indicating they are triggered by radio path signalling. Messages 7, 8, and 9 are shown in italics, indicating they are optional. The sequence is: 1) MS to MSC/VLR (A\_LU\_REQUEST); 2) MSC/VLR to MS (A\_IDENTITY\_REQUEST); 3) MS to MSC/VLR (A\_IDENTITY\_RESPONSE); 4) MSC/VLR to HLR (MAP\_UPDATE\_LOCATION\_req/ind); 5) HLR to PVLR (MAP\_CANCEL\_LOCATION\_req/ind); 6) PVLR to HLR (MAP\_CANCEL\_LOCATION\_rsp/cnf); 7) HLR to MSC/VLR (MAP\_ACTIVATE\_TRACE\_MODE\_req/ind); 8) MSC/VLR to HLR (MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf); 9) HLR to MSC/VLR (MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind); 10) MSC/VLR to HLR (MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf); 11) HLR to MSC/VLR (MAP\_UPDATE\_LOCATION\_rsp/cnf); 12) MSC/VLR to MS (A\_LU\_CONFIRM). + +931 + +932 PVLR = Previous VLR + +933 + +- 934 1) A\_LU\_REQUEST (Note 1) + 935 2) A\_IDENTITY\_REQUEST (Note 1) + 936 3) A\_IDENTITY\_RESPONSE (Note 1) + 937 4) MAP\_UPDATE\_LOCATION\_req/ind + 938 5) MAP\_CANCEL\_LOCATION\_req/ind + 939 6) MAP\_CANCEL\_LOCATION\_rsp/cnf + 940 7) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 2) + 941 8) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 2) + 942 9) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind* + 943 10) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf + 944 11) MAP\_UPDATE\_LOCATION\_rsp/cnf + 945 12) A\_LU\_CONFIRM (Note 1) + +946 + +947 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35]. Services shown in dotted lines + 948 indicate the trigger provided by the signalling on the radio path, and the signalling triggered on the radio + 949 path. + +950 NOTE 2: Services printed in *italics* are optional. + +951 + +952 + +953 + +**Figure 19.1.1/3: Message flow for location updating to a new VLR area, + when the IMSI cannot be retrieved from the previous VLR** + +![Sequence diagram showing message flow for GPRS location updating between MS, SGSN, PSGSN, and HLR. The diagram shows 10 numbered messages: 1) MS to SGSN (dotted), 2) SGSN to HLR, 3) HLR to PSGSN, 4) PSGSN to HLR, 5) HLR to SGSN, 6) SGSN to HLR, 7) HLR to SGSN, 8) SGSN to HLR, 9) HLR to SGSN, 10) SGSN to MS (dotted).](cf6b2e5b134aeadae43f0ba8d04dea2f_img.jpg) + +``` + +sequenceDiagram + participant MS + participant SGSN + participant PSGSN + participant HLR + Note left of MS: 1) + MS-->>SGSN: + Note right of SGSN: 2) + SGSN->>HLR: + Note right of HLR: 3) + HLR->>PSGSN: + Note right of PSGSN: 4) + PSGSN->>HLR: + Note right of HLR: 5) + HLR->>SGSN: + Note right of SGSN: 6) + SGSN->>HLR: + Note right of HLR: 7) + HLR->>SGSN: + Note right of SGSN: 8) + SGSN->>HLR: + Note right of HLR: 9) + HLR->>SGSN: + Note left of MS: 10) + SGSN-->>MS: + +``` + +Sequence diagram showing message flow for GPRS location updating between MS, SGSN, PSGSN, and HLR. The diagram shows 10 numbered messages: 1) MS to SGSN (dotted), 2) SGSN to HLR, 3) HLR to PSGSN, 4) PSGSN to HLR, 5) HLR to SGSN, 6) SGSN to HLR, 7) HLR to SGSN, 8) SGSN to HLR, 9) HLR to SGSN, 10) SGSN to MS (dotted). + +954 + +955 PSGSN = Previous SGSN + +956 + +957 1) Gb\_ATTACH\_REQUEST or RA\_UPDATE\_REQUEST (Note 1, note 2) + +958 2) MAP\_UPDATE\_GPRS\_LOCATION\_req/ind + +959 3) MAP\_CANCEL\_LOCATION\_req/ind + +960 4) MAP\_CANCEL\_LOCATION\_rsp/cnf + +961 5) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 3) + +962 6) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 3) + +963 7) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind + +964 8) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf + +965 9) MAP\_UPDATE\_GPRS\_LOCATION\_rsp/cnf + +966 10) Gb\_ATTACH\_ACCEPT or RA\_UPDATE\_ACCEPT (Note 1) + +967 + +968 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35]. The services shown in dotted lines indicate the trigger provided by the signalling on the radio path, and the signalling triggered on the radio path. + +969 NOTE 2: For security functions (authentication, ciphering, IMEI check) triggering refer to 3GPP TS 23.060 [104]. The MAP signalling invoked for these functions is described in clause 25 of the present document. + +970 NOTE 3: Services printed in *italics* are optional. + +971 NOTE 4: Refer to 3GPP TS 23.060 [104] for termination of the procedure and triggering of the signalling on the interface between the BSS and the SGSN. + +972 + +973 **Figure 19.1.1/4: Message flow for GPRS location updating (Gs interface not installed)** + +974 + +![Sequence diagram showing signaling between MS, SGSN, VLR, PSGSN, and HLR. The diagram includes 18 numbered messages, some solid and some dotted, representing various GPRS and MAP signaling procedures.](00965742b9d7c465ff2058c927ff2e6c_img.jpg) + +``` + +sequenceDiagram + participant MS + participant SGSN + participant VLR + participant PSGSN + participant HLR + + Note left of MS: 1) Gb_ATTACH_REQUEST or RA_UPDATE_REQUEST + MS-->>SGSN: 1) Gb_ATTACH_REQUEST or RA_UPDATE_REQUEST + Note right of HLR: 2) MAP_UPDATE_GPRS_LOCATION_req/ind + HLR-->>PSGSN: 2) MAP_UPDATE_GPRS_LOCATION_req/ind + Note left of PSGSN: 3) MAP_CANCEL_LOCATION_req/ind + PSGSN-->>HLR: 3) MAP_CANCEL_LOCATION_req/ind + Note right of HLR: 4) MAP_CANCEL_LOCATION_rsp/cnf + HLR-->>PSGSN: 4) MAP_CANCEL_LOCATION_rsp/cnf + Note left of PSGSN: 5) MAP_ACTIVATE_TRACE_MODE_req/ind + PSGSN-->>SGSN: 5) MAP_ACTIVATE_TRACE_MODE_req/ind + Note right of HLR: 6) MAP_ACTIVATE_TRACE_MODE_rsp/cnf + HLR-->>PSGSN: 6) MAP_ACTIVATE_TRACE_MODE_rsp/cnf + Note left of PSGSN: 7) MAP_INSERT_SUBSCRIBER_DATA_req/ind + PSGSN-->>SGSN: 7) MAP_INSERT_SUBSCRIBER_DATA_req/ind + Note right of HLR: 8) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf + HLR-->>PSGSN: 8) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf + Note left of PSGSN: 9) MAP_UPDATE_GPRS_LOCATION_rsp/cnf + PSGSN-->>SGSN: 9) MAP_UPDATE_GPRS_LOCATION_rsp/cnf + Note left of SGSN: 10) Gs_LOCATION_UPDATE_REQUEST + SGSN-->>VLR: 10) Gs_LOCATION_UPDATE_REQUEST + Note right of HLR: 11) MAP_UPDATE_LOCATION_req/ind + HLR-->>VLR: 11) MAP_UPDATE_LOCATION_req/ind + Note left of VLR: 12) MAP_INSERT_SUBSCRIBER_DATA_req/ind + VLR-->>HLR: 12) MAP_INSERT_SUBSCRIBER_DATA_req/ind + Note right of HLR: 13) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf + HLR-->>VLR: 13) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf + Note left of VLR: 14) MAP_UPDATE_LOCATION_rsp/cnf + VLR-->>HLR: 14) MAP_UPDATE_LOCATION_rsp/cnf + Note left of VLR: 15) Gs_LOCATION_UPDATE_ACCEPT + VLR-->>SGSN: 15) Gs_LOCATION_UPDATE_ACCEPT + Note left of MS: 16) Gb_ATTACH_ACCEPT or RA_UPDATE_ACCEPT + MS-->>SGSN: 16) Gb_ATTACH_ACCEPT or RA_UPDATE_ACCEPT + Note left of SGSN: 17) Gb_TMSI_REALLOCATION_COMPLETE + SGSN-->>MS: 17) Gb_TMSI_REALLOCATION_COMPLETE + Note left of VLR: 18) Gs_TMSI_REALLOCATION_COMPLETE + VLR-->>SGSN: 18) Gs_TMSI_REALLOCATION_COMPLETE + +``` + +Sequence diagram showing signaling between MS, SGSN, VLR, PSGSN, and HLR. The diagram includes 18 numbered messages, some solid and some dotted, representing various GPRS and MAP signaling procedures. + +978 + +979 + +980 1) Gb\_ATTACH\_REQUEST or RA\_UPDATE\_REQUEST (Note 1, note 2) + +981 2) MAP\_UPDATE\_GPRS\_LOCATION\_req/ind + +982 3) MAP\_CANCEL\_LOCATION\_req/ind + +983 4) MAP\_CANCEL\_LOCATION\_rsp/cnf + +984 5) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 3) + +985 6) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 3) + +986 7) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind + +987 8) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf + +988 9) MAP\_UPDATE\_GPRS\_LOCATION\_rsp/cnf + +989 10) Gs\_LOCATION\_UPDATE\_REQUEST (Note 4) + +990 11) MAP\_UPDATE\_LOCATION\_req/ind (Note 5) + +991 12) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind + +992 13) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf + +993 14) MAP\_UPDATE\_LOCATION\_rsp/cnf + +994 15) Gs\_LOCATION\_UPDATE\_ACCEPT (Note 4) + +995 16) Gb\_ATTACH\_ACCEPT or RA\_UPDATE\_ACCEPT (Note 1) + +996 17) Gb\_TMSI\_REALLOCATION\_COMPLETE (Note 1) + +997 18) Gs\_TMSI\_REALLOCATION\_COMPLETE (Note 4) + +998 + +999 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35]. The services shown in dotted lines indicate the trigger provided by the signalling on the radio path, and the signalling triggered on the radio path. + +1000 NOTE 2: For security functions (authentication, ciphering, IMEI check) triggering refer to 3GPP TS 23.060 [104]. + +1001 MAP processes invoked for those procedures are described in clause 25.5. + +1002 NOTE 3: Services printed in *italics* are optional. + +1005 NOTE 5: For details of the procedure on the path between the SGSN and the VLR, see 3GPP TS 29.018 [106]. The +1006 services shown in chain lines indicate the trigger provided by the signalling on the path between the SGSN +1007 and the VLR, and the signalling triggered on the path between the SGSN and the VLR. +1008 NOTE 4: Refer to 3GPP TS 23.060 [104] for termination of the procedure and triggering of the signalling on the +1009 interface between the BSS and the SGSN. +1010 NOTE 5: For simplicity, the Location Cancellation procedure towards the previous VLR and optional tracing +1011 activation towards the new VLR are not shown in this figure. +1012 +1013 + +**Figure 19.1.1/5: Message flow for GPRS location updating (Gs interface installed)** + +#### 1014 19.1.1.2 Procedures in the VLR + +1015 The MAP process in the VLR for location updating for a non-GPRS subscriber is shown in figure 19.1.1/6. The MAP +1016 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1017 Receive\_Open\_Cnf see clause 25.1.2; + +1018 Check\_Confirmation see clause 25.2.2. + +1019 The MAP process in the VLR to retrieve the IMSI of a subscriber from the previous VLR (PVLRR) is shown in figure +1020 19.1.1/7. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as +1021 follows: + +1022 Receive\_Open\_Cnf see clause 25.1.2; + +1023 Check\_Confirmation see clause 25.2.2. + +1024 The process in the VLR for location updating for a GPRS subscriber when the Gs interface is installed is shown in +1025 figure 19.1.1/8. + +1026 The macro GPRS\_Location\_Update\_Completion\_VLR is shown in figure 19.1.1/9. The macro invokes a process not +1027 defined in this clause; the definition of this process can be found as follows: + +1028 Subscriber\_Present\_VLR see clause 25.10.1. + +1029 The macro GPRS\_Update\_HLR\_VLR is shown in figure 19.1.1/10. The macro invokes macros not defined in this +1030 clause; the definitions of these macros can be found as follows: + +1031 Receive\_Open\_Cnf see clause 25.1.2; + +1032 Check\_Confirmation see clause 25.2.2; + +1033 Insert\_Subs\_Data\_VLR see clause 25.7.1; + +1034 Activate\_Tracing\_VLR see clause 25.9.4. + +#### 1035 19.1.1.3 Procedure in the PVLRR + +1036 The MAP process in the PVLRR to handle a request for the IMSI of a subscriber from the new VLR is shown in figure +1037 19.1.1/11. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as +1038 follows: + +1039 Receive\_Open\_Ind see clause 25.1.1. + +#### 1040 19.1.1.4 Procedure in the SGSN + +1041 The MAP process in the SGSN for location updating for a GPRS subscriber is shown in figure 19.1.1/12. The MAP +1042 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1043 Receive\_Open\_Cnf see clause 25.1.2; + +1044 Check\_Confirmation see clause 25.2.2; + +1045 Insert\_Subs\_Data\_SGSN see clause 25.7.2; + +1046     Activate\_Tracing\_SGSN   see clause 25.9.5. + +1047 Sheet 2: The procedure Check\_User\_Error\_In\_Serving\_Network\_Entity is specific to Super-Charger; it is specified in +1048 3GPP TS 23.116 [110]. + +#### 1049 19.1.1.5     Procedures in the HLR + +1050 The MAP process in the HLR to handle a location updating request from a VLR is shown in figure 19.1.1/13. The MAP +1051 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1052     Check\_Confirmation   see clause 25.2.2. + +1053 The MAP process in the HLR to handle a location updating request from an SGSN is shown in figure 19.1.1/14. The +1054 MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1055     Receive\_Open\_Ind     see clause 25.1.1; + +1056     Check\_Indication     see clause 25.2.1; + +1057     Check\_Confirmation   see clause 25.2.2; + +1058     Control\_Tracing\_With\_SGSN\_HLR see clause 25.9.7. + +1059 Sheet 2: The procedure Super\_Charged\_Cancel\_Location\_HLR is specific to Super-Charger; it is specified in +1060 3GPP TS 23.116 [110]. If the HLR does not support the Super-Charger functionality, processing continues from the +1061 "No" exit of the test "Result=Pass?". + +1062 Sheet 2: The procedure Super\_Charged\_Location\_Updating\_HLR is specific to Super-Charger; it is specified in +1063 3GPP TS 23.116 [110]. If the HLR does not support the Super-Charger functionality, processing continues from the +1064 "No" exit of the test "Result=Pass?". + +1065 Sheet 2: If the HLR supports the Administrative Restriction of Subscribers' Access feature and roaming is allowed in +1066 the VPLMN then the HLR may check the "Supported RAT Types" received from the VLR against the access restriction +1067 parameters. If this check fails then the decision box "Roaming allowed in this PLMN" shall take the exit "No". + +1068 The MAP process in the HLR to notify Short Message Service Centres that a subscriber is now reachable is shown in +1069 figure 19.1.1/15. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found +1070 as follows: + +1071     Alert\_Service\_Centre\_HLR see clause 25.10.3. + +![Flowchart for process Update_Location_VLR. It starts with 'Null', followed by 'Update Location', then a merge point with messages MAP_OPEN_req, MAP_UPDATE_LOCATION_req, and MAP_DELIMITER_req. It then goes to 'Receive_Open_Cnf'. From there, three paths emerge: 'Error' leads to 'Set negative response: System failure' -> 'Update Location negative response' -> 'Null'; 'Vr' leads to 'Perform MAP Vr dialogue' -> 'Result'; 'OK' leads to 'Wait_For_HLR_Response'. 'Result' has four outcomes: 'Unknown Subscriber', 'Roaming not allowed', 'Procedure error', and 'Aborted', all leading to 'Set negative response' boxes which then lead to 'Update Location negative response' -> 'Null'. 'Procedure error' also leads to 'Update Location ack' -> 'Null'. 'Wait_For_HLR_Response' branches into 'MAP_ACTIVATE_TRACE_MODE_ind' -> 'Activate Trace Mode' and 'MAP_INSERT_SUBSCRIBER_DATA_ind' -> 'Insert Subscriber Data', both leading to 'Wait_For_HLR_Or_Application_Response' -> 'Null'. A label 'HLR number' is near the 'Update Location ack' path.](99eaf23e3d47f7e6cd7837e5587b6aee_img.jpg) + +**process Update\_Location\_VLR** **UL\_VLR1(2)** + +Process in the VLR to handle a location updating dialogue with the HLR when the Gs interface is not used + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Null]) --> UpdateLoc{Update Location} + UpdateLoc --> Merge(( )) + Merge --> Messages["MAP_OPEN_req +MAP_UPDATE_LOCATION_req +MAP_DELIMITER_req"] + Messages --> ReceiveCnf[Receive_Open_Cnf] + + ReceiveCnf -- Error --> ErrResp["Set negative response: +System failure"] + ErrResp --> ErrLoc{Update Location negative response} + ErrLoc --> Null1([Null]) + + ReceiveCnf -- Vr --> PerformVr[Perform MAP Vr dialogue] + + PerformVr --> Result{Result} + + Result -- "Unknown Subscriber" --> Res1["Set negative response: +Unknown subscriber"] + Result -- "Roaming not allowed" --> Res2["Set negative response: +Roaming not allowed"] + Result -- "Procedure error" --> Res3["Set negative response: +Procedure error"] + Result -- "Aborted" --> Res4["Set negative response: +Aborted"] + + Res1 --> NegLoc{Update Location negative response} + Res2 --> NegLoc + Res3 --> NegLoc + Res3 --> PosLoc{Update Location ack} + Res4 --> NegLoc + + NegLoc --> Null2([Null]) + + PosLoc --> Null3([Null]) + + ReceiveCnf -- OK --> WaitHLR[Wait_For_HLR_Response] + + WaitHLR -- "MAP_ACTIVATE_TRACE_MODE_ind" --> ActTrace{Activate Trace Mode} + WaitHLR -- "MAP_INSERT_SUBSCRIBER_DATA_ind" --> InsertData{Insert Subscriber Data} + + ActTrace --> WaitApp[Wait_For_HLR_Or_Application_Response] + InsertData --> WaitApp + + WaitApp --> Null4([Null]) + + Note["HLR number"] -.-> PosLoc + +``` + +Flowchart for process Update\_Location\_VLR. It starts with 'Null', followed by 'Update Location', then a merge point with messages MAP\_OPEN\_req, MAP\_UPDATE\_LOCATION\_req, and MAP\_DELIMITER\_req. It then goes to 'Receive\_Open\_Cnf'. From there, three paths emerge: 'Error' leads to 'Set negative response: System failure' -> 'Update Location negative response' -> 'Null'; 'Vr' leads to 'Perform MAP Vr dialogue' -> 'Result'; 'OK' leads to 'Wait\_For\_HLR\_Response'. 'Result' has four outcomes: 'Unknown Subscriber', 'Roaming not allowed', 'Procedure error', and 'Aborted', all leading to 'Set negative response' boxes which then lead to 'Update Location negative response' -> 'Null'. 'Procedure error' also leads to 'Update Location ack' -> 'Null'. 'Wait\_For\_HLR\_Response' branches into 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' -> 'Activate Trace Mode' and 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' -> 'Insert Subscriber Data', both leading to 'Wait\_For\_HLR\_Or\_Application\_Response' -> 'Null'. A label 'HLR number' is near the 'Update Location ack' path. + +1072 + +1073 + +**Figure 19.1.1/6 (sheet 1 of 2): Process Update\_Location\_VLR** + +![State transition diagram for Update_Location_VLR process. It starts with Wait_For_HLR_Or_Application_Response, branches into various MAP operations (Activate Trace Mode, Insert Subscriber Data, MAP_INSERT_SUBSCRIBER_DATA_ind, MAP_FORWARD_CHECK_SS_ind), and ends with Null states after processing responses like Update Location ack or negative response.](14512fe72d075c1f96895f3037f52aad_img.jpg) + +**process Update\_Location\_VLR** UL\_VLR2(2) + +Process in the VLR to handle a location updating dialogue with the HLR when the Gs interface is not used + +``` + +stateDiagram-v2 + [*] --> Wait_For_HLR_Or_Application_Response + state "Wait_For_HLR_Or_Application_Response" as Wait_For_HLR_Or_Application_Response + state "Activate Trace Mode ack" as Activate_Trace_Mode_ack + state "Activate Trace Mode negative response" as Activate_Trace_Mode_neg_resp + state "Insert Subscriber Data ack" as Insert_Subscriber_Data_ack + state "Insert Subscriber Data negative response" as Insert_Subscriber_Data_neg_resp + state "MAP_INSERT_SUBSCRIBER_DATA_ind" as MAP_INSERT_SUBSCRIBER_DATA_ind + state "MAP_FORWARD_CHECK_SS_ind" as MAP_FORWARD_CHECK_SS_ind + state "Set User Error" as Set_User_Error + state "MAP_ACTIVATE_TRACE_MODE_rsp" as MAP_ACTIVATE_TRACE_MODE_rsp + state "MAP_INSERT_SUBSCRIBER_DATA_rsp" as MAP_INSERT_SUBSCRIBER_DATA_rsp + state "Insert Subscriber Data" as Insert_Subscriber_Data + state "Forward Check SS" as Forward_Check_SS + state "Wait_For_HLR_Or_Application_Response" as Wait_For_HLR_Or_Application_Response + state "MAP_UPDATE_LOCATION_cnf" as MAP_UPDATE_LOCATION_cnf + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind + state "Check Confirmation" as Check_Confirmation + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Set negative response" as Set_Neg_Resp + state "Set negative response: System failure" as Set_Neg_Resp_Sys_Fail + state "Update Location negative response" as Update_Location_Neg_Resp + state "Update Location ack" as Update_Location_Ack + state "Null" as Null + + Wait_For_HLR_Or_Application_Response --> Activate_Trace_Mode_ack + Wait_For_HLR_Or_Application_Response --> Activate_Trace_Mode_neg_resp + Wait_For_HLR_Or_Application_Response --> Insert_Subscriber_Data_ack + Wait_For_HLR_Or_Application_Response --> Insert_Subscriber_Data_neg_resp + Wait_For_HLR_Or_Application_Response --> MAP_INSERT_SUBSCRIBER_DATA_ind + Wait_For_HLR_Or_Application_Response --> MAP_FORWARD_CHECK_SS_ind + + Activate_Trace_Mode_ack --> MAP_ACTIVATE_TRACE_MODE_rsp + Activate_Trace_Mode_neg_resp --> Set_User_Error + Set_User_Error --> MAP_ACTIVATE_TRACE_MODE_rsp + Insert_Subscriber_Data_ack --> MAP_INSERT_SUBSCRIBER_DATA_rsp + Insert_Subscriber_Data_neg_resp --> Set_User_Error + Set_User_Error --> MAP_INSERT_SUBSCRIBER_DATA_rsp + MAP_INSERT_SUBSCRIBER_DATA_ind --> Insert_Subscriber_Data + MAP_FORWARD_CHECK_SS_ind --> Forward_Check_SS + + MAP_ACTIVATE_TRACE_MODE_rsp --> Wait_For_HLR_Or_Application_Response + MAP_INSERT_SUBSCRIBER_DATA_rsp --> Wait_For_HLR_Or_Application_Response + Insert_Subscriber_Data --> Wait_For_HLR_Or_Application_Response + Forward_Check_SS --> Wait_For_HLR_Or_Application_Response + + Wait_For_HLR_Or_Application_Response --> MAP_UPDATE_LOCATION_cnf + Wait_For_HLR_Or_Application_Response --> MAP_NOTICE_ind + Wait_For_HLR_Or_Application_Response --> MAP_U_ABORT_ind + + MAP_UPDATE_LOCATION_cnf --> Check_Confirmation + Check_Confirmation --> Set_Neg_Resp : User Error, Provider Error, Data Error + Check_Confirmation --> Update_Location_Ack : OK + Update_Location_Ack --> Null + Set_Neg_Resp --> Update_Location_Neg_Resp + Update_Location_Neg_Resp --> Null + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_Neg_Resp_Sys_Fail + Set_Neg_Resp_Sys_Fail --> Update_Location_Neg_Resp + Update_Location_Neg_Resp --> Null + +``` + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the HLR + +State transition diagram for Update\_Location\_VLR process. It starts with Wait\_For\_HLR\_Or\_Application\_Response, branches into various MAP operations (Activate Trace Mode, Insert Subscriber Data, MAP\_INSERT\_SUBSCRIBER\_DATA\_ind, MAP\_FORWARD\_CHECK\_SS\_ind), and ends with Null states after processing responses like Update Location ack or negative response. + +1074 + +1075 + +Figure 19.1.1/6 (sheet 2 of 2): Process Update\_Location\_VLR + +![Flowchart for process Send_Identification_VLR. The process starts with 'Null', followed by 'Send Identification', then a message box with MAP_OPEN_req, MAP_SEND_IDENTIFICATION_req, and MAP_DELIMITER_req. It then enters 'Receive_Open_Cnf' with three branches: Error (leading to 'Set negative response: System failure'), Vr (leading to 'Perform MAP Vr dialogue'), and OK (leading to 'Wait_For_PVLR_Response'). The 'Perform MAP Vr dialogue' branch leads to a decision 'IMSI received?'. If 'No', it goes to 'Send Identification negative response' and then 'Null'. If 'Yes', it goes to 'Send Identification ack' and then 'Null'. The 'Wait_For_PVLR_Response' branch leads to a message box with MAP_SEND_IDENTIFICATION_cnf, then 'Check Confirmation'. 'Check Confirmation' has an 'OK' branch leading to 'Wait_For_Dialogue_End' and a 'User Error, Provider Error, Data Error' branch leading to a decision 'IMSI received?'. If 'No', it goes to 'Send Identification negative response' and then 'Null'. If 'Yes', it goes to 'Send Identification ack' and then 'Null'. 'Wait_For_Dialogue_End' leads to 'MAP_CLOSE_ind', which leads to 'Send Identification ack' and then 'Null'. 'Wait_For_Dialogue_End' also leads to 'MAP_DELIMITER_ind', which leads to a message box with MAP_SEND_IDENTIFICATION_req and MAP_DELIMITER_req, which then leads to 'Wait_For_PVLR_Response'.](38ce7d231f30a146f0db151df41f9091_img.jpg) + +**process Send\_Identification\_VLR** **SI\_VLR1(2)** + +Process in the VLR to request IMSI and authentication information from the previous VLR + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the PVLR + +``` + + graph TD + Start([Null]) --> SendID[Send Identification] + SendID --> Msg1[MAP_OPEN_req +MAP_SEND_IDENTIFICATION_req +MAP_DELIMITER_req] + Msg1 --> RecvOpenCnf[Receive_Open_Cnf] + RecvOpenCnf -- Error --> NegResp[Set negative response: +System failure] + RecvOpenCnf -- Vr --> PerformVr[Perform MAP Vr dialogue] + RecvOpenCnf -- OK --> WaitPVLR[Wait_For_PVLR_Response] + + PerformVr --> IMSIRecVr{IMSI received?} + IMSIRecVr -- No --> NegRespVr[Send Identification negative response] + NegRespVr --> NullVr([Null]) + + IMSIRecVr -- Yes --> AckVr[Send Identification ack] + AckVr --> NullVr + + WaitPVLR --> Msg2[MAP_SEND_IDENTIFICATION_cnf] + Msg2 --> CheckConf[Check Confirmation] + + CheckConf -- OK --> WaitDialogEnd[Wait_For_Dialogue_End] + + CheckConf -- "User Error, Provider Error, Data Error" --> IMSIRec{IMSI received?} + + IMSIRec -- No --> NegRespMain[Send Identification negative response] + NegRespMain --> NullMain([Null]) + + IMSIRec -- Yes --> AckMain[Send Identification ack] + AckMain --> NullMain + + WaitDialogEnd --> MAPCloseInd[MAP_CLOSE_ind] + + MAPCloseInd --> AckMain + AckMain --> NullMain + + WaitDialogEnd --> MAPDelimInd[MAP_DELIMITER_ind] + + MAPDelimInd --> Msg3[MAP_SEND_IDENTIFICATION_req +MAP_DELIMITER_req] + + Msg3 --> WaitPVLR + +``` + +Flowchart for process Send\_Identification\_VLR. The process starts with 'Null', followed by 'Send Identification', then a message box with MAP\_OPEN\_req, MAP\_SEND\_IDENTIFICATION\_req, and MAP\_DELIMITER\_req. It then enters 'Receive\_Open\_Cnf' with three branches: Error (leading to 'Set negative response: System failure'), Vr (leading to 'Perform MAP Vr dialogue'), and OK (leading to 'Wait\_For\_PVLR\_Response'). The 'Perform MAP Vr dialogue' branch leads to a decision 'IMSI received?'. If 'No', it goes to 'Send Identification negative response' and then 'Null'. If 'Yes', it goes to 'Send Identification ack' and then 'Null'. The 'Wait\_For\_PVLR\_Response' branch leads to a message box with MAP\_SEND\_IDENTIFICATION\_cnf, then 'Check Confirmation'. 'Check Confirmation' has an 'OK' branch leading to 'Wait\_For\_Dialogue\_End' and a 'User Error, Provider Error, Data Error' branch leading to a decision 'IMSI received?'. If 'No', it goes to 'Send Identification negative response' and then 'Null'. If 'Yes', it goes to 'Send Identification ack' and then 'Null'. 'Wait\_For\_Dialogue\_End' leads to 'MAP\_CLOSE\_ind', which leads to 'Send Identification ack' and then 'Null'. 'Wait\_For\_Dialogue\_End' also leads to 'MAP\_DELIMITER\_ind', which leads to a message box with MAP\_SEND\_IDENTIFICATION\_req and MAP\_DELIMITER\_req, which then leads to 'Wait\_For\_PVLR\_Response'. + +1076 + +1077 + +Figure 19.1.1/7 (sheet 1 of 2): Process Send\_Identification\_VLR + +![Flowchart for process Send_Identification_VLR. It starts with 'Wait_For_PVLR_Response', leading to a split. One path goes left to 'Abort' then 'Null'. Another path goes right through 'MAP_NOTICE_ind' and 'MAP_CLOSE_req' to a decision 'IMSI received?'. If 'No', it goes left to 'Send Identification negative response' then 'Null'. If 'Yes', it goes right to 'Send Identification ack' then 'Null'. A third path from the initial split goes right to an unlabeled box, which then connects to a box containing 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'.](67f1290c75b9e4a4a36af1afacbb7932_img.jpg) + +**process Send\_Identification\_VLR** **SI\_VLR2(2)** + +Process in the VLR to request IMSI and authentication information from the previous VLR + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the PVLR + +``` + + graph TD + Start([Wait_For_PVLR_Response]) --> Split1(( )) + Split1 --> Abort[/Abort/] + Abort --> Null1([Null]) + Split1 --> Notice[/MAP_NOTICE_ind/] + Notice --> Close[/MAP_CLOSE_req/] + Close --> IMSI{IMSI received?} + IMSI -- No --> NegResponse[/Send Identification negative response/] + NegResponse --> Null2([Null]) + IMSI -- Yes --> Ack[/Send Identification ack/] + Ack --> Null3([Null]) + Split1 --> Unlabeled[/ /] + Unlabeled --> Signals[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + +``` + +Flowchart for process Send\_Identification\_VLR. It starts with 'Wait\_For\_PVLR\_Response', leading to a split. One path goes left to 'Abort' then 'Null'. Another path goes right through 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_req' to a decision 'IMSI received?'. If 'No', it goes left to 'Send Identification negative response' then 'Null'. If 'Yes', it goes right to 'Send Identification ack' then 'Null'. A third path from the initial split goes right to an unlabeled box, which then connects to a box containing 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'. + +1078 + +1079 + +**Figure 19.1.1/7 (sheet 2 of 2): Process Send\_Identification\_VLR** + +![Flowchart for process GPRS_Update_Location_Area_VLR. It starts with Null, receives Gs_GPRS_LOCATION_UPDATING_ind, checks if subscriber is known. If no, it confirms location info in HLR (False), then checks if radio contact is confirmed (True), updates LAI, and checks if VLR-SGSN association exists. If no, it creates association; if yes, it updates association. Then it checks if HLR update is required. If yes, it goes to connector 1. If no, it checks if PgA is supported. If no, it sets GPRS_Location_Update_Completion_VLR, updates register, and ends at Null. If yes, it checks if PgA changed. If no, it goes to connector 1. If yes, it checks if HLR supports PgA. If no, it goes to connector 1. If yes, it sets skip subscriber data update and goes to connector 1.](0da7dffc768694ed2710d63f80ca7c19_img.jpg) + +process GPRS\_Update\_Location\_Area\_VLR + +GULA\_VLR1(2) + +Process in the VLR to handle an Update Location Area request received over the Gs interface + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + Start([Null]) --> Input{{Gs_GPRS_LOCATION_UPDATING_ind}} + Input --> SubKnown{Subscriber known?} + SubKnown -- No --> LocInfo[Location Information Confirmed in HLR:=False] + LocInfo --> RadioContact[Confirmed by Radio Contact:=True] + RadioContact --> UpdateLAI[Update LAI] + UpdateLAI --> AssocExists{VLR-SGSN association exists?} + AssocExists -- No --> CreateAssoc[Create association] + AssocExists -- Yes --> UpdateAssoc[Update association] + CreateAssoc --> HLRUpdate{HLR update required?} + UpdateAssoc --> HLRUpdate + HLRUpdate -- Yes --> C1((1)) + HLRUpdate -- No --> PgASupported{PgA supported?} + PgASupported -- No --> GPRSUpdate[GPRS_Location_Update_Completion_VLR] + PgASupported -- Yes --> PgAChanged{PgA changed?} + PgAChanged -- No --> C1 + PgAChanged -- Yes --> HLRSupportPgA{HLR support PgA?} + HLRSupportPgA -- No --> C1 + HLRSupportPgA -- Yes --> SkipData[Set skip Subscriber Data Update] + SkipData --> C2((1)) + GPRSUpdate --> UpdateReg[Update register] + UpdateReg --> End([Null]) + +``` + +Flowchart for process GPRS\_Update\_Location\_Area\_VLR. It starts with Null, receives Gs\_GPRS\_LOCATION\_UPDATING\_ind, checks if subscriber is known. If no, it confirms location info in HLR (False), then checks if radio contact is confirmed (True), updates LAI, and checks if VLR-SGSN association exists. If no, it creates association; if yes, it updates association. Then it checks if HLR update is required. If yes, it goes to connector 1. If no, it checks if PgA is supported. If no, it sets GPRS\_Location\_Update\_Completion\_VLR, updates register, and ends at Null. If yes, it checks if PgA changed. If no, it goes to connector 1. If yes, it checks if HLR supports PgA. If no, it goes to connector 1. If yes, it sets skip subscriber data update and goes to connector 1. + +1080 + +1081 + +Figure 19.1.1/8 (sheet 1 of 2): Process GPRS\_Update\_Location\_Area\_VLR + +![Flowchart for GPRS_Update_Location_Area_VLR process. It starts at connector '1', goes to 'GPRS_Update_HLR_VLR'. From there, 'OK' leads to 'GPRS_Location_Update_Completion_VLR' -> 'Update register' -> 'Null'. 'Procedure_Error' leads to 'Set User Error' -> 'Gs_GPRS_LOCATION_UPDATING_rsp' -> 'Null'. 'Unknown_Subscriber, Roaming_Not_Allowed' leads to 'Delete subscriber record' -> 'Set User Error'.](a9cffaea1e423f35f76268ce60023115_img.jpg) + +**process GPRS\_Update\_Location\_Area\_VLR** **GULA\_VLR2(2)** + +Process in the VLR to handle an Update Location Area request received over the Gs interface + +Signals to/from the left are to/from the SGSN + +``` + + graph TD + 1((1)) --> GPRS_Update_HLR_VLR[GPRS_Update_HLR_VLR] + GPRS_Update_HLR_VLR -- OK --> GPRS_Location_Update_Completion_VLR[GPRS_Location_Update_VLR] + GPRS_Location_Update_Completion_VLR --> Update_register[Update register] + Update_register --> Null1([Null]) + + GPRS_Update_HLR_VLR -- Procedure_Error --> Set_User_Error[Set User Error] + Set_User_Error --> Gs_GPRS_LOCATION_UPDATING_rsp[Gs_GPRS_LOCATION_UPDATING_rsp] + Gs_GPRS_LOCATION_UPDATING_rsp --> Null2([Null]) + + GPRS_Update_HLR_VLR -- "Unknown_Subscriber, Roaming_Not_Allowed" --> Delete_subscriber_record[Delete subscriber record] + Delete_subscriber_record --> Set_User_Error + +``` + +Flowchart for GPRS\_Update\_Location\_Area\_VLR process. It starts at connector '1', goes to 'GPRS\_Update\_HLR\_VLR'. From there, 'OK' leads to 'GPRS\_Location\_Update\_Completion\_VLR' -> 'Update register' -> 'Null'. 'Procedure\_Error' leads to 'Set User Error' -> 'Gs\_GPRS\_LOCATION\_UPDATING\_rsp' -> 'Null'. 'Unknown\_Subscriber, Roaming\_Not\_Allowed' leads to 'Delete subscriber record' -> 'Set User Error'. + +1082 + +1083 + +**Figure 19.1.1/8 (sheet 2 of 2): Process GPRS\_Update\_Location\_Area\_VLR** + +![Flowchart for GPRS_Location_Update_Completion_VLR macro. It starts with a decision 'Roaming allowed in target LA?'. If 'No', it sets 'LA not allowed:= True', 'Set User Error' (See 3GPP TS 29.018), and sends 'Gs_GPRS_LOCATION_UPDATING_rsp'. If 'Yes', it sets 'LA not allowed:= False' and 'IMSI detached:= False', then checks 'Subscriber Present_VLR'. If 'No', it sends 'Set result' and 'Gs_GPRS_LOCATION_UPDATING_rsp'. If 'Yes', it allocates a new TMSI, sets the TMSI parameter, starts a TMSI reallocation timer, sends 'Gs_GPRS_LOCATION_UPDATING_rsp', and waits for 'TMSI_Allocation_Confirm'. Upon confirmation, it sends 'GS_GPRS_TMSI_REALLOCATION_COMPLETE_ind'. If the 'TMSI reallocation timer expired' (Internal), it freezes the old TMSI.](9d79dd380d110194f9f53b210c40a1ec_img.jpg) + +**macrodefinition GPRS\_Location\_Update\_Completion\_VLR** **GLUC\_VLR1(1)** + +Macro in the VLR to complete the local handling of an Update Location Area request received over the Gs interface + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + Start([Start]) --> Roaming{Roaming allowed in target LA?} + Roaming -- No --> LA_Not_Allowed[LA not allowed:= True] + LA_Not_Allowed --> Set_User_Error[Set User Error +See 3GPP TS 29.018] + Set_User_Error --> Gs_Rsp_1{Gs_GPRS_LOCATION_UPDATING_rsp} + Gs_Rsp_1 --> End_1([End]) + Roaming -- Yes --> LA_Not_Allowed_Yes[LA not allowed:= False +IMSI detached:= False] + LA_Not_Allowed_Yes --> Sub_Present{Subscriber Present_VLR} + Sub_Present -- No --> Set_Result[Set result] + Set_Result --> Gs_Rsp_2{Gs_GPRS_LOCATION_UPDATING_rsp} + Gs_Rsp_2 --> End_2([End]) + Sub_Present -- Yes --> Allocate_TMSI[Allocate TMSI] + Allocate_TMSI --> Set_TMSI_Param[Set TMSI parameter] + Set_TMSI_Param --> Start_Timer[Start TMSI reallocation timer] + Start_Timer --> Gs_Rsp_3{Gs_GPRS_LOCATION_UPDATING_rsp} + Gs_Rsp_3 --> Wait_Confirm([Wait_For_TMSI_Allocation_Confirm]) + Wait_Confirm --> Complete_Ind{GS_GPRS_TMSI_REALLOCATION_COMPLETE_ind} + Complete_Ind --> End_3([End]) + Wait_Confirm --> Timer_Expired{TMSI reallocation timer expired} + Timer_Expired -.-> Internal[Internal] + Timer_Expired --> Freeze_Old_TMSI[Freeze old TMSI] + Freeze_Old_TMSI --> End_4([End]) + +``` + +Flowchart for GPRS\_Location\_Update\_Completion\_VLR macro. It starts with a decision 'Roaming allowed in target LA?'. If 'No', it sets 'LA not allowed:= True', 'Set User Error' (See 3GPP TS 29.018), and sends 'Gs\_GPRS\_LOCATION\_UPDATING\_rsp'. If 'Yes', it sets 'LA not allowed:= False' and 'IMSI detached:= False', then checks 'Subscriber Present\_VLR'. If 'No', it sends 'Set result' and 'Gs\_GPRS\_LOCATION\_UPDATING\_rsp'. If 'Yes', it allocates a new TMSI, sets the TMSI parameter, starts a TMSI reallocation timer, sends 'Gs\_GPRS\_LOCATION\_UPDATING\_rsp', and waits for 'TMSI\_Allocation\_Confirm'. Upon confirmation, it sends 'GS\_GPRS\_TMSI\_REALLOCATION\_COMPLETE\_ind'. If the 'TMSI reallocation timer expired' (Internal), it freezes the old TMSI. + +1084 + +1085 + +**Figure 19.1.1/9: Macro GPRS\_Location\_Update\_Completion\_VLR** + +macrodefinition GPRS\_Update\_HLR\_VLR + +GUHLR\_VLR1(2) + +Macro in the VLR to handle a location updating dialogue with the HLR when the Gs interface is used + +Signals to/from the right are to/from the HLR + +![Flowchart for GPRS_Update_HLR_VLR macro. It starts with a decision 'HLR address known?'. If 'No', it goes to 'Roaming_Not_Allowed'. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_UPDATE_LOCATION_req', and 'MAP_DELIMITER_req', then receives 'Open_Cnf'. From 'Open_Cnf', it branches based on 'Error', 'Vr', and 'OK'. 'Error' leads to 'Procedure_Error'. 'Vr' leads to 'Perform MAP_Vr dialogue', which then leads to 'Result?'. 'Result?' branches into 'Procedure error, Aborted' (leading to 'Procedure_Error'), 'Unknown subscriber' (leading to 'Unknown_Subscriber'), 'Roaming not allowed' (leading to 'Roaming_Not_Allowed'), and 'HLR number' (leading to 'OK'). 'OK' from 'Open_Cnf' leads to 'Wait_For_HLR_Response'. Both 'Unknown_Subscriber' and 'HLR number' lead to 'Wait_For_HLR_Response'. From 'Wait_For_HLR_Response', it branches into 'Insert Subs Data_VLR', 'Activate Tracing_VLR', 'MAP_FORWARD_CHECK_SS_INDICATION_ind', 'MAP_NOTICE_ind', and 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'. 'Insert Subs Data_VLR', 'Activate Tracing_VLR', and 'MAP_FORWARD_CHECK_SS_INDICATION_ind' all lead to 'Wait_For_HLR_Response'. 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which leads to a block 'Subscriber data confirmed by HLR=False; Location information confirmed in HLR=False', which then leads to 'Procedure_Error'. 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' also leads to 'Procedure_Error'.](78b2f2e47d941e9f565e3691a1947d50_img.jpg) + +``` + +graph TD + Start([ ]) --> HLR_Known{HLR address known?} + HLR_Known -- No --> Roaming_Not_Allowed1(( )) + Roaming_Not_Allowed1 --> Roaming_Not_Allowed1_out[Roaming_Not_Allowed] + HLR_Known -- Yes --> MAP_Open_Req["MAP_OPEN_req +MAP_UPDATE_LOCATION_req +MAP_DELIMITER_req"] + MAP_Open_Req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- Error --> Procedure_Error1(( )) + Procedure_Error1 --> Procedure_Error1_out[Procedure_Error] + Receive_Open_Cnf -- Vr --> Perform_MAP_Vr[Perform MAP_Vr dialogue] + Perform_MAP_Vr --> Result{Result?} + Result -- "Procedure error, Aborted" --> Procedure_Error2(( )) + Procedure_Error2 --> Procedure_Error2_out[Procedure_Error] + Result -- "Unknown subscriber" --> Unknown_Subscriber(( )) + Unknown_Subscriber --> Unknown_Subscriber_out[Unknown_Subscriber] + Result -- "Roaming not allowed" --> Roaming_Not_Allowed2(( )) + Roaming_Not_Allowed2 --> Roaming_Not_Allowed2_out[Roaming_Not_Allowed] + Result -- "HLR number" --> OK1(( )) + OK1 --> OK1_out[OK] + Receive_Open_Cnf -- OK --> Wait_For_HLR_Response1[Wait_For_HLR_Response] + Unknown_Subscriber --> Wait_For_HLR_Response2[Wait_For_HLR_Response] + HLR_number --> Wait_For_HLR_Response2 + Wait_For_HLR_Response1 --> Insert Subs Data_VLR[Insert Subs Data_VLR] + Insert Subs Data_VLR --> Wait_For_HLR_Response3[Wait_For_HLR_Response] + Wait_For_HLR_Response1 --> Activate Tracing_VLR[Activate Tracing_VLR] + Activate Tracing_VLR --> Wait_For_HLR_Response4[Wait_For_HLR_Response] + Wait_For_HLR_Response1 --> MAP_FORWARD_CHECK_SS_INDICATION_ind[MAP_FORWARD_CHECK_SS_INDICATION_ind] + MAP_FORWARD_CHECK_SS_INDICATION_ind --> Wait_For_HLR_Response5[Wait_For_HLR_Response] + Wait_For_HLR_Response1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Subscriber_Data_Confirmed["Subscriber data confirmed by HLR=False; +Location information confirmed in HLR=False"] + Subscriber_Data_Confirmed --> Procedure_Error3(( )) + Procedure_Error3 --> Procedure_Error3_out[Procedure_Error] + Wait_For_HLR_Response1 --> MAP_U_ABORT_ind["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + MAP_U_ABORT_ind --> Procedure_Error3 + +``` + +Flowchart for GPRS\_Update\_HLR\_VLR macro. It starts with a decision 'HLR address known?'. If 'No', it goes to 'Roaming\_Not\_Allowed'. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_UPDATE\_LOCATION\_req', and 'MAP\_DELIMITER\_req', then receives 'Open\_Cnf'. From 'Open\_Cnf', it branches based on 'Error', 'Vr', and 'OK'. 'Error' leads to 'Procedure\_Error'. 'Vr' leads to 'Perform MAP\_Vr dialogue', which then leads to 'Result?'. 'Result?' branches into 'Procedure error, Aborted' (leading to 'Procedure\_Error'), 'Unknown subscriber' (leading to 'Unknown\_Subscriber'), 'Roaming not allowed' (leading to 'Roaming\_Not\_Allowed'), and 'HLR number' (leading to 'OK'). 'OK' from 'Open\_Cnf' leads to 'Wait\_For\_HLR\_Response'. Both 'Unknown\_Subscriber' and 'HLR number' lead to 'Wait\_For\_HLR\_Response'. From 'Wait\_For\_HLR\_Response', it branches into 'Insert Subs Data\_VLR', 'Activate Tracing\_VLR', 'MAP\_FORWARD\_CHECK\_SS\_INDICATION\_ind', 'MAP\_NOTICE\_ind', and 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'. 'Insert Subs Data\_VLR', 'Activate Tracing\_VLR', and 'MAP\_FORWARD\_CHECK\_SS\_INDICATION\_ind' all lead to 'Wait\_For\_HLR\_Response'. 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which leads to a block 'Subscriber data confirmed by HLR=False; Location information confirmed in HLR=False', which then leads to 'Procedure\_Error'. 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' also leads to 'Procedure\_Error'. + +1086 + +1087 + +Figure 19.1.1/10 (sheet 1 of 2): Macro GPRS\_Update\_HLR\_VLR + +macrodefinition GPRS\_Update\_HLR\_VLR + +GUHLR\_VLR2(2) + +Macro in the VLR to handle a location updating dialogue with the HLR when the Gs interface is used + +Signals to/from the right are to/from the HLR + +![Flowchart for GPRS_Update_HLR_VLR macro. It starts with 'Wait_For_HLR_Response', followed by a merge point for 'MAP_UPDATE_LOCATION_cnf'. Then 'Check_Confirmation' leads to 'OK' (success) or 'User Error'. 'User Error' branches into 'Unknown subscriber', 'Roaming not allowed', and 'Else' (which leads to 'Provider Error, Data Error' and 'Procedure_Error').](86f84829fd1c592351b2c1724f03ebbf_img.jpg) + +``` + +graph TD + Start([Wait_For_HLR_Response]) --> Merge(( )) + Merge --> MAP_UPDATE_LOCATION_cnf[MAP_UPDATE_LOCATION_cnf] + MAP_UPDATE_LOCATION_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> OK[OK] + Check_Confirmation --> User_Error[User Error] + OK --> OK_Success[Subscriber data confirmed by HLR:=True; Location information confirmed in HLR:=True] + OK_Success --> OK_End((OK)) + User_Error --> Unknown_Subscriber[Unknown subscriber] + User_Error --> Roaming_Not_Allowed[Roaming not allowed] + User_Error --> Else[Else] + Unknown_Subscriber --> Unknown_Subs[Unknown_Subscriber] + Unknown_Subs --> Unknown_End(( )) + Roaming_Not_Allowed --> Roaming_Not_Allowed_Subs[Roaming_Not_Allowed] + Roaming_Not_Allowed_Subs --> Roaming_End(( )) + Else --> Else_Subs[Subscriber data confirmed by HLR:=False; Location information confirmed in HLR:=False] + Else_Subs --> Else_End(( )) + Else_Subs --> Procedure_Error[Procedure_Error] + Else_Subs --> Provider_Error[Provider Error, Data Error] + +``` + +Flowchart for GPRS\_Update\_HLR\_VLR macro. It starts with 'Wait\_For\_HLR\_Response', followed by a merge point for 'MAP\_UPDATE\_LOCATION\_cnf'. Then 'Check\_Confirmation' leads to 'OK' (success) or 'User Error'. 'User Error' branches into 'Unknown subscriber', 'Roaming not allowed', and 'Else' (which leads to 'Provider Error, Data Error' and 'Procedure\_Error'). + +1088 + +1089 + +Figure 19.1.1/10 (sheet 2 of 2): Macro GPRS\_Update\_HLR\_VLR + +![Flowchart for process Send_Identification_PVLR. It starts with an initial state leading to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait_For_Service_Primitive'; and 'Error' leading to 'Null'. 'Wait_For_Service_Primitive' leads to a merge point. From this merge point, four paths emerge: 'MAP_NOTICE_ind' leading to 'Null'; 'MAP_P_ABORT_ind' leading to a merge point; a rightward arrow leading to 'MAP_SEND_IDENTIFICATION_ind'; and 'Send Identification' leading to 'Wait_For_Application_Response'. 'MAP_NOTICE_ind' and 'MAP_P_ABORT_ind' both lead to 'MAP_CLOSE_req', which then leads to 'Null'. 'MAP_SEND_IDENTIFICATION_ind' leads to 'Send Identification'. 'Wait_For_Application_Response' leads to another merge point. From this merge point, four paths emerge: 'MAP_NOTICE_ind' leading to 'Null'; a rightward arrow leading to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'; 'Send Identification negative response' leading to 'Set User Error'; and 'Set User Error' leading to a merge point. 'MAP_NOTICE_ind' and the rightward arrow both lead to 'MAP_CLOSE_req', which then leads to 'Abort' and finally 'Null'. The merge point from 'Set User Error' leads to 'MAP_SEND_IDENTIFICATION_rsp, MAP_CLOSE_req', which then leads to 'Null'.](5547a75375f032b096428428783e9718_img.jpg) + +**process Send\_Identification\_PVLR** **SI\_PVLR1(2)** + +Process in the PVLR to handle a request for IMSI and authentication information from the new VLR + +Signals to/from the left are to/from the new VLR, signals to/from the right are to/from the location management application process in the PVLR (see 3GPP TS 23.012) + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive[Receive_Open_Ind] + Receive -- Vr --> Perform[Perform MAP Vr dialogue] + Perform --> Null2([Null]) + Receive -- OK --> Wait1[Wait_For_Service_Primitive] + Receive -- Error --> Null3([Null]) + Wait1 --> Merge1(( )) + Merge1 -- "MAP_NOTICE_ind" --> Null4([Null]) + Merge1 -- "MAP_P_ABORT_ind" --> Merge2(( )) + Merge1 --> Right1[ ] + Right1 -- "MAP_SEND_IDENTIFICATION_ind" --> Right1 + Merge1 -- "Send Identification" --> Wait2[Wait_For_Application_Response] + Merge2 -- "MAP_CLOSE_req" --> Null5([Null]) + Wait2 --> Merge3(( )) + Merge3 -- "MAP_NOTICE_ind" --> Null6([Null]) + Merge3 --> Right2[ ] + Merge3 -- "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" --> Right2 + Merge3 -- "Send Identification negative response" --> SetError[Set User Error] + SetError --> Merge4(( )) + Merge4 -- "MAP_SEND_IDENTIFICATION_rsp, MAP_CLOSE_req" --> Merge4 + Merge4 --> Null7([Null]) + Right2 --> Merge5(( )) + Merge5 -- "MAP_CLOSE_req" --> Abort[Abort] + Abort --> Null8([Null]) + +``` + +Flowchart for process Send\_Identification\_PVLR. It starts with an initial state leading to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait\_For\_Service\_Primitive'; and 'Error' leading to 'Null'. 'Wait\_For\_Service\_Primitive' leads to a merge point. From this merge point, four paths emerge: 'MAP\_NOTICE\_ind' leading to 'Null'; 'MAP\_P\_ABORT\_ind' leading to a merge point; a rightward arrow leading to 'MAP\_SEND\_IDENTIFICATION\_ind'; and 'Send Identification' leading to 'Wait\_For\_Application\_Response'. 'MAP\_NOTICE\_ind' and 'MAP\_P\_ABORT\_ind' both lead to 'MAP\_CLOSE\_req', which then leads to 'Null'. 'MAP\_SEND\_IDENTIFICATION\_ind' leads to 'Send Identification'. 'Wait\_For\_Application\_Response' leads to another merge point. From this merge point, four paths emerge: 'MAP\_NOTICE\_ind' leading to 'Null'; a rightward arrow leading to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'; 'Send Identification negative response' leading to 'Set User Error'; and 'Set User Error' leading to a merge point. 'MAP\_NOTICE\_ind' and the rightward arrow both lead to 'MAP\_CLOSE\_req', which then leads to 'Abort' and finally 'Null'. The merge point from 'Set User Error' leads to 'MAP\_SEND\_IDENTIFICATION\_rsp, MAP\_CLOSE\_req', which then leads to 'Null'. + +1090 + +1091 + +**Figure 19.1.1/11 (sheet 1 of 2): Process Send\_Identification\_PVLR** + +![Flowchart for process Send_Identification_PVLR. It starts with 'Wait_For_Application_Response', followed by 'Send Identification ack' leading to connector '1'. Then 'MAP_SEND_IDENTIFICATION_rsp' is received. A decision 'More authentication sets to send?' follows. If 'No', it goes to 'MAP_CLOSE_req' then 'Null'. If 'Yes', it goes to another decision 'Segmentation allowed?'. If 'No', it goes to 'MAP_CLOSE_req'. If 'Yes', it goes to 'MAP_DELIMITER_req' then 'Wait_For_Next_Request'. From 'Wait_For_Next_Request', three paths emerge: 'MAP_SEND_IDENTIFICATION_ind' leading to connector '1', 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req', and a group of 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' leading to 'Abort'. Both 'MAP_CLOSE_req' and 'Abort' lead to 'Null'.](707ce14d1a5d5c7d61bf59aa85401fa9_img.jpg) + +**process Send\_Identification\_PVLR** **SI\_PVLR2(2)** + +Process in the PVLR to handle a request for IMSI and authentication information from the new VLR + +Signals to/from the left are to/from the new VLR, signals to/from the right are to/from the location management application process in the PVLR (see 3GPP TS 23.012) + +``` + + graph TD + Start([Wait_For_Application_Response]) --> SendAck{{Send Identification ack}} + SendAck --> C1((1)) + C1 --> Rsp{{MAP_SEND_IDENTIFICATION_rsp}} + Rsp --> D1{More authentication sets to send?} + D1 -- No --> CloseReq1{{MAP_CLOSE_req}} + D1 -- Yes --> D2{Segmentation allowed?} + D2 -- No --> CloseReq1 + D2 -- Yes --> DelimiterReq{{MAP_DELIMITER_req}} + DelimiterReq --> WaitNext([Wait_For_Next_Request]) + WaitNext --> Ind1{{MAP_SEND_IDENTIFICATION_ind}} + Ind1 --> C2((1)) + WaitNext --> Ind2{{MAP_NOTICE_ind}} + Ind2 --> CloseReq2{{MAP_CLOSE_req}} + WaitNext --> Ind3{{MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind}} + CloseReq1 --> Null1([Null]) + CloseReq2 --> Abort{{Abort}} + Ind3 --> Abort + Abort --> Null2([Null]) + +``` + +Flowchart for process Send\_Identification\_PVLR. It starts with 'Wait\_For\_Application\_Response', followed by 'Send Identification ack' leading to connector '1'. Then 'MAP\_SEND\_IDENTIFICATION\_rsp' is received. A decision 'More authentication sets to send?' follows. If 'No', it goes to 'MAP\_CLOSE\_req' then 'Null'. If 'Yes', it goes to another decision 'Segmentation allowed?'. If 'No', it goes to 'MAP\_CLOSE\_req'. If 'Yes', it goes to 'MAP\_DELIMITER\_req' then 'Wait\_For\_Next\_Request'. From 'Wait\_For\_Next\_Request', three paths emerge: 'MAP\_SEND\_IDENTIFICATION\_ind' leading to connector '1', 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req', and a group of 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' leading to 'Abort'. Both 'MAP\_CLOSE\_req' and 'Abort' lead to 'Null'. + +1092 + +1093 + +**Figure 19.1.1/11 (sheet 2 of 2): Process Send\_Identification\_PVLR** + +![Flowchart for process Update_GPRS_Location_SGSN. It starts with 'Null', followed by 'Update Location'. A decision 'HLR address known?' follows. If 'No', it goes to 'Set negative response: Unknown HLR' and then 'Null'. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_UPDATE_GPRS_LOCATION_req', and 'MAP_DELIMITER_req'. Then it receives 'Open_Cnf'. If 'OK', it goes to 'Wait_For_HLR_Response'. If 'Vr, Error', it goes to 'Set negative response: Procedure error'. From 'Wait_For_HLR_Response', it branches into 'Update Location negative response', 'Abort', 'Insert Subs_Data_SGSN', 'Activate Tracing_SGSN', 'MAP_NOTICE_ind', and a block with 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind'. 'Update Location negative response' leads to 'Null'. 'Abort' leads to 'MAP_U_ABORT_req' and then 'Null'. 'Insert Subs_Data_SGSN' and 'Activate Tracing_SGSN' both lead to 'Wait_For_HLR_Response'. 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req'. The block with 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' also leads to 'MAP_CLOSE_req'. 'MAP_CLOSE_req' leads to 'Set negative response: Procedure error', which leads to 'Update Location negative response' and then 'Null'.](96b47d5db5f5f313cc8c40db35ebcdf3_img.jpg) + +**process Update\_GPRS\_Location\_SGSN** **UGL\_SGSN1(2)** + +Process in the SGSN to handle a location updating dialogue with the HLR + +Signals to/from the left are to/from the GPRS mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Null]) --> UpdateLoc{Update Location} + UpdateLoc --> HLRKnown{HLR address known?} + HLRKnown -- No --> NegResp1[Set negative response: Unknown HLR] + NegResp1 --> UpdateLocNeg[Update Location negative response] + UpdateLocNeg --> Null1([Null]) + + HLRKnown -- Yes --> MAPReq["MAP_OPEN_req +MAP_UPDATE_GPRS_LOCATION_req +MAP_DELIMITER_req"] + MAPReq --> OpenCnf[Receive Open_Cnf] + + OpenCnf -- "Vr, Error" --> NegResp2[Set negative response: Procedure error] + + OpenCnf -- OK --> WaitHLR[Wait_For_HLR_Response] + + WaitHLR --> UpdateLocNeg2[Update Location negative response] + UpdateLocNeg2 --> Null2([Null]) + + WaitHLR --> Abort[Abort] + Abort --> MAPUAbort[MAP_U_ABORT_req] + MAPUAbort --> Null3([Null]) + + WaitHLR --> InsertSubs[Insert Subs_Data_SGSN] + InsertSubs --> WaitHLR2[Wait_For_HLR_Response] + + WaitHLR --> ActivateTracing[Activate Tracing_SGSN] + ActivateTracing --> WaitHLR3[Wait_For_HLR_Response] + + WaitHLR --> MAPNotice[MAP_NOTICE_ind] + + WaitHLR --> MAPCloseReq[MAP_CLOSE_req] + + MAPNotice --> MAPCloseReq + + MAPCloseReq --> NegResp3[Set negative response: Procedure error] + + MAPCloseReq --> MAPUAbortInd["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + + MAPUAbortInd --> MAPCloseReq + + NegResp3 --> UpdateLocNeg3[Update Location negative response] + UpdateLocNeg3 --> Null4([Null]) + +``` + +Flowchart for process Update\_GPRS\_Location\_SGSN. It starts with 'Null', followed by 'Update Location'. A decision 'HLR address known?' follows. If 'No', it goes to 'Set negative response: Unknown HLR' and then 'Null'. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_UPDATE\_GPRS\_LOCATION\_req', and 'MAP\_DELIMITER\_req'. Then it receives 'Open\_Cnf'. If 'OK', it goes to 'Wait\_For\_HLR\_Response'. If 'Vr, Error', it goes to 'Set negative response: Procedure error'. From 'Wait\_For\_HLR\_Response', it branches into 'Update Location negative response', 'Abort', 'Insert Subs\_Data\_SGSN', 'Activate Tracing\_SGSN', 'MAP\_NOTICE\_ind', and a block with 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind'. 'Update Location negative response' leads to 'Null'. 'Abort' leads to 'MAP\_U\_ABORT\_req' and then 'Null'. 'Insert Subs\_Data\_SGSN' and 'Activate Tracing\_SGSN' both lead to 'Wait\_For\_HLR\_Response'. 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req'. The block with 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' also leads to 'MAP\_CLOSE\_req'. 'MAP\_CLOSE\_req' leads to 'Set negative response: Procedure error', which leads to 'Update Location negative response' and then 'Null'. + +1094 + +1095 + +**Figure 19.1.1/12 (sheet 1 of 2): Process Update\_GPRS\_Location\_SGSN** + +![UML Sequence diagram for Update_GPRS_Location_SGSN process. The process starts with 'Wait_For_HLR_Response', followed by a merge symbol receiving 'MAP_UPDATE_GPRS_LOCATION_cnf'. It then enters 'Check_Confirmation', which branches into three paths: 'User Error' (leading to 'Check_User_Error_In_Serving_Network_Entity', 'Set negative response', 'Update Location negative response', and 'Null'), 'OK' (leading to 'Set result', 'Update Location ack', and 'Null'), and 'Provider Error, Data Error' (leading to 'Set negative response: Procedure error', 'Update Location negative response', and 'Null'). A note 'See 3GPP TS 23.116' is associated with the User Error path.](2b10056b07ec6fecdc2d1b4c2000a2f6_img.jpg) + +**process Update\_GPRS\_Location\_SGSN** **UGL\_SGSN2(2)** + +Process in the SGSN to handle a location updating dialogue with the HLR + +Signals to/from the left are to/from the GPRS mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the HLR + +``` + +sequenceDiagram + participant HLR + participant SGSN + Note left of SGSN: Process in the SGSN to handle a location updating dialogue with the HLR + Note right of SGSN: Signals to/from the left are to/from the GPRS mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the HLR + + SGSN->>HLR: Wait_For_HLR_Response + Note right of SGSN: See 3GPP TS 23.116 + HLR-->>SGSN: MAP_UPDATE_GPRS_LOCATION_cnf + Note right of SGSN: Check_Confirmation + Note right of SGSN: User Error + Note right of SGSN: OK + Note right of SGSN: Provider Error, Data Error + + Note right of SGSN: Check_User_Error_In_Serving_Network_Entity + Note right of SGSN: Set negative response + Note right of SGSN: Update Location negative response + Note right of SGSN: Null + + Note right of SGSN: Set result + Note right of SGSN: Update Location ack + Note right of SGSN: Null + + Note right of SGSN: Set negative response: Procedure error + Note right of SGSN: Update Location negative response + Note right of SGSN: Null + +``` + +UML Sequence diagram for Update\_GPRS\_Location\_SGSN process. The process starts with 'Wait\_For\_HLR\_Response', followed by a merge symbol receiving 'MAP\_UPDATE\_GPRS\_LOCATION\_cnf'. It then enters 'Check\_Confirmation', which branches into three paths: 'User Error' (leading to 'Check\_User\_Error\_In\_Serving\_Network\_Entity', 'Set negative response', 'Update Location negative response', and 'Null'), 'OK' (leading to 'Set result', 'Update Location ack', and 'Null'), and 'Provider Error, Data Error' (leading to 'Set negative response: Procedure error', 'Update Location negative response', and 'Null'). A note 'See 3GPP TS 23.116' is associated with the User Error path. + +1096 + +1097 + +**Figure 19.1.1/12 (sheet 2 of 2): Process Update\_GPRS\_Location\_SGSN** + +![Flowchart for process Update_Location_HLR. It starts with an oval, followed by 'Null', then a merge symbol with 'MAP_UPDATE_LOCATION_ind' input. Then 'Update Location', 'Wait_For_Application_Response'. A split leads to four paths: 1) 'Update Location ack' -> 'Set Result' -> merge symbol with 'MAP_UPDATE_LOCATION_rsp' and 'MAP_CLOSE_req' output. 2) 'Update Location negative response' -> 'Set User Error' -> merge symbol. 3) 'Activate Trace Mode' -> merge symbol with 'MAP_ACTIVATE_TRACE_MODE_req' and 'MAP_DELIMITER_req' input -> 'Wait_For_ATM_Cnf'. 4) 'Insert Subscriber Data' -> merge symbol with 'MAP_INSERT_SUBSCRIBER_DATA_req' and 'MAP_DELIMITER_req' input -> 'Wait_For_ISD_Cnf_Or_Application_Response'. All four paths converge to a final merge symbol with an 'X' below it.](2dd0ba902cf30ea954edf716f87194da_img.jpg) + +**process Update\_Location\_HLR** **UL\_HLR1(3)** + +Process in the HLR to handle an Update Location request from a VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the location management application process in the HLR (see 3GPP TS 23.012) + +``` + + graph TD + Start([ ]) --> Null([Null]) + Null --> Merge1{ } + MAP_UPDATE_LOCATION_ind[MAP_UPDATE_LOCATION_ind] --> Merge1 + Merge1 --> UpdateLocation[Update Location] + UpdateLocation --> WaitApp[Wait_For_Application_Response] + WaitApp --> Split1[ ] + + Split1 --> UpdateAck[Update Location ack] + UpdateAck --> SetResult[Set Result] + + Split1 --> UpdateNeg[Update Location negative response] + UpdateNeg --> SetUserError[Set User Error] + + Split1 --> ActivateTrace[Activate Trace Mode] + ActivateTrace --> Merge2{ } + MAP_ACTIVATE_TRACE_MODE_req[MAP_ACTIVATE_TRACE_MODE_req] --> Merge2 + MAP_DELIMITER_req1[MAP_DELIMITER_req] --> Merge2 + Merge2 --> WaitATM[Wait_For_ATM_Cnf] + + Split1 --> InsertData[Insert Subscriber Data] + InsertData --> Merge3{ } + MAP_INSERT_SUBSCRIBER_DATA_req[MAP_INSERT_SUBSCRIBER_DATA_req] --> Merge3 + MAP_DELIMITER_req2[MAP_DELIMITER_req] --> Merge3 + Merge3 --> WaitISD[Wait_For_ISD_Cnf_Or_Application_Response] + + SetResult --> Merge4{ } + SetUserError --> Merge4 + WaitATM --> Merge4 + WaitISD --> Merge4 + + Merge4 --> Merge5{ } + MAP_UPDATE_LOCATION_rsp[MAP_UPDATE_LOCATION_rsp] --> Merge5 + MAP_CLOSE_req[MAP_CLOSE_req] --> Merge5 + + Merge5 --> End((X)) + +``` + +Flowchart for process Update\_Location\_HLR. It starts with an oval, followed by 'Null', then a merge symbol with 'MAP\_UPDATE\_LOCATION\_ind' input. Then 'Update Location', 'Wait\_For\_Application\_Response'. A split leads to four paths: 1) 'Update Location ack' -> 'Set Result' -> merge symbol with 'MAP\_UPDATE\_LOCATION\_rsp' and 'MAP\_CLOSE\_req' output. 2) 'Update Location negative response' -> 'Set User Error' -> merge symbol. 3) 'Activate Trace Mode' -> merge symbol with 'MAP\_ACTIVATE\_TRACE\_MODE\_req' and 'MAP\_DELIMITER\_req' input -> 'Wait\_For\_ATM\_Cnf'. 4) 'Insert Subscriber Data' -> merge symbol with 'MAP\_INSERT\_SUBSCRIBER\_DATA\_req' and 'MAP\_DELIMITER\_req' input -> 'Wait\_For\_ISD\_Cnf\_Or\_Application\_Response'. All four paths converge to a final merge symbol with an 'X' below it. + +1098 + +1099 + +**Figure 19.1.1/13 (sheet 1 of 3): Process Update\_Location\_HLR** + +![State transition diagram for Update_Location_HLR process. It shows two main state machines. The top one starts in 'Wait_For_ATM_Cnf' and handles MAP_CLOSE_req, leading to Check_Confirmation and various responses (Set negative response: System failure, Activate Trace Mode negative response, Activate Trace Mode ack). The bottom one starts in 'Wait_For_ISD_Cnf_Or_Application_Response' and handles MAP_NOTICE_ind, leading to Set negative response: System failure, Insert Subscriber Data negative response, and MAP_INSERT_SUBSCRIBER_DATA_req. Both include Abort and error handling paths.](86fa12b2972ca1c2a9695ec59ca4226c_img.jpg) + +**process Update\_Location\_HLR** **UL\_HLR2(3)** + +Process in the HLR to handle an Update Location request from a VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the location management application process in the HLR (see 3GPP TS 23.012) + +``` + +stateDiagram-v2 + [*] --> Wait_For_ATM_Cnf + state "Wait_For_ATM_Cnf" as Wait_For_ATM_Cnf + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_ACTIVATE_TRACE_MODE_cnf" as MAP_ACTIVATE_TRACE_MODE_cnf + state "Abort" as Abort + state "X" as X + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Check_Confirmation" as Check_Confirmation + state "Set negative response: System failure" as Set_Neg_Resp_Sys_Fail_1 + state "Set negative response: System failure" as Set_Neg_Resp_Sys_Fail_2 + state "Set negative response" as Set_Neg_Resp + state "Activate Trace Mode negative response" as Act_Trace_Neg_Resp_1 + state "Activate Trace Mode negative response" as Act_Trace_Neg_Resp_2 + state "Activate Trace Mode ack" as Act_Trace_Ack + state "X" as X + state "Wait_For_Application_Response" as Wait_For_App_Resp + + Wait_For_ATM_Cnf --> MAP_U_ABORT_ind + Wait_For_ATM_Cnf --> MAP_NOTICE_ind + Wait_For_ATM_Cnf --> MAP_ACTIVATE_TRACE_MODE_cnf + MAP_U_ABORT_ind --> Abort + Abort --> X + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Check_Confirmation + Check_Confirmation --> Set_Neg_Resp_Sys_Fail_1 : Provider Error + Check_Confirmation --> Set_Neg_Resp_Sys_Fail_2 : Data Error + Check_Confirmation --> Set_Neg_Resp : User Error + Check_Confirmation --> Act_Trace_Ack : OK + Set_Neg_Resp_Sys_Fail_1 --> Act_Trace_Neg_Resp_1 + Act_Trace_Neg_Resp_1 --> X + Set_Neg_Resp_Sys_Fail_2 --> Act_Trace_Neg_Resp_2 + Set_Neg_Resp --> Act_Trace_Neg_Resp_2 + Act_Trace_Neg_Resp_2 --> Wait_For_Application_Response + Wait_For_Application_Response --> Act_Trace_Ack + + [*] --> Wait_For_ISD_Cnf_Or_Application_Response + state "Wait_For_ISD_Cnf_Or_Application_Response" as Wait_For_ISD_Cnf_Or_Application_Response + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "Insert Subscriber Data" as Insert_Subscriber_Data + state "Abort" as Abort + state "X" as X + state "Set negative response: System failure" as Set_Neg_Resp_Sys_Fail_3 + state "Insert Subscriber Data negative response" as Insert_Sub_Dat_Neg_Resp + state "MAP_INSERT_SUBSCRIBER_DATA_req, MAP_DELIMITER_req" as MAP_INSERT_SUBSCRIBER_DATA_req + state "Wait_For_ISD_Cnf_Or_Application_Response" as Wait_For_ISD_Cnf_Or_Application_Response + + Wait_For_ISD_Cnf_Or_Application_Response --> MAP_U_ABORT_ind + Wait_For_ISD_Cnf_Or_Application_Response --> MAP_NOTICE_ind + Wait_For_ISD_Cnf_Or_Application_Response --> Insert_Subscriber_Data + MAP_U_ABORT_ind --> Abort + Abort --> X + MAP_NOTICE_ind --> Set_Neg_Resp_Sys_Fail_3 + Set_Neg_Resp_Sys_Fail_3 --> Insert_Sub_Dat_Neg_Resp + Insert_Sub_Dat_Neg_Resp --> MAP_INSERT_SUBSCRIBER_DATA_req + MAP_INSERT_SUBSCRIBER_DATA_req --> Insert_Subscriber_Data + Insert_Subscriber_Data --> Wait_For_ISD_Cnf_Or_Application_Response + +``` + +State transition diagram for Update\_Location\_HLR process. It shows two main state machines. The top one starts in 'Wait\_For\_ATM\_Cnf' and handles MAP\_CLOSE\_req, leading to Check\_Confirmation and various responses (Set negative response: System failure, Activate Trace Mode negative response, Activate Trace Mode ack). The bottom one starts in 'Wait\_For\_ISD\_Cnf\_Or\_Application\_Response' and handles MAP\_NOTICE\_ind, leading to Set negative response: System failure, Insert Subscriber Data negative response, and MAP\_INSERT\_SUBSCRIBER\_DATA\_req. Both include Abort and error handling paths. + +1100 + +1101 + +**Figure 19.1.1/13 (sheet 2 of 3): Process Update\_Location\_HLR** + +![Sequence diagram for process Update_Location_HLR. The diagram shows the interaction between an external entity (left) and internal HLR processes (right). It starts with a 'Wait_For_ISD_Cnf_Or_Application_Response' state. The left side includes 'Update Location ack', 'Update Location negative response', 'Set Result', 'Set User Error', and 'MAP_UPDATE_LOCATION_rsp MAP_CLOSE_req'. The right side includes 'MAP_INSERT_SUBSCRIBER_DATA_cnf', 'Check_Confirmation', and four error paths: 'OK', 'User Error', 'Data Error', and 'Provider Error', each leading to specific response actions and a return to the initial wait state.](3206908d095735fe036950cff84908e8_img.jpg) + +**process Update\_Location\_HLR** **UL\_HLR3(3)** + +Process in the HLR to handle an Update Location request from a VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the location management application process in the HLR (see 3GPP TS 23.012) + +``` + +sequenceDiagram + participant External + participant HLR_Internal + Note right of HLR_Internal: Wait_For_ISD_Cnf_Or_Application_Response + Note left of External: Update Location ack + Note left of External: Update Location negative response + Note left of External: Set Result + Note left of External: Set User Error + Note left of External: MAP_UPDATE_LOCATION_rsp +MAP_CLOSE_req + Note right of HLR_Internal: MAP_INSERT_SUBSCRIBER_DATA_cnf + Note right of HLR_Internal: Check_Confirmation + Note right of HLR_Internal: OK + Note right of HLR_Internal: User Error + Note right of HLR_Internal: Data Error + Note right of HLR_Internal: Provider Error + Note right of HLR_Internal: Insert Subscriber Data ack + Note right of HLR_Internal: Insert Subscriber Data negative response + Note right of HLR_Internal: Wait_For_ISD_Cnf_Or_Application_Response + +``` + +Sequence diagram for process Update\_Location\_HLR. The diagram shows the interaction between an external entity (left) and internal HLR processes (right). It starts with a 'Wait\_For\_ISD\_Cnf\_Or\_Application\_Response' state. The left side includes 'Update Location ack', 'Update Location negative response', 'Set Result', 'Set User Error', and 'MAP\_UPDATE\_LOCATION\_rsp MAP\_CLOSE\_req'. The right side includes 'MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf', 'Check\_Confirmation', and four error paths: 'OK', 'User Error', 'Data Error', and 'Provider Error', each leading to specific response actions and a return to the initial wait state. + +1102 + +1103 + +**Figure 19.1.1/13 (sheet 3 of 3): Process Update\_Location\_HLR** + +![Flowchart for process Update_GPRS_Location_HLR. It starts with an initial state, followed by 'Null', 'Receive_Open_ind', and 'Wait_For_Service_Primitive'. From 'Wait_For_Service_Primitive', an 'OK' path leads to 'MAP_UPDATE_GPRS_LOCATION_ind' and 'Check_Indication', while a 'Vr, Error' path leads to 'Null'. 'Check_Indication' leads to 'Subscriber known?'. If 'No', it goes to 'Set diagnostic: IMSI unknown' and then 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Network Access Mode?'. If 'Non-GPRS only', it goes to 'Set diagnostic: GPRS subscription unknown'. Both diagnostic paths lead to 'Set User Error: Unknown subscriber'. From 'Set User Error: Unknown subscriber', it goes to a response block 'MAP_UPDATE_GPRS_LOCATION_rsp' and 'MAP_CLOSE_req', then to 'Null'. If 'Subscriber known?' is 'Yes' and 'Network Access Mode?' is 'Else', it goes to 'Subscriber tracing active in SGSN:= False' and then to connector '1'. If 'Subscriber known?' is 'Yes' and 'Network Access Mode?' is 'Error', it goes to a response block 'MAP_UPDATE_GPRS_LOCATION_rsp' and 'MAP_CLOSE_req', then to 'Null'. There are also 'MAP_P_ABORT_ind' and 'MAP_NOTICE_ind' paths from 'Wait_For_Service_Primitive' leading to 'Null' and 'MAP_CLOSE_req' respectively.](cdf6308d33c8eb877deede2d942cc349_img.jpg) + +**process Update\_GPRS\_Location\_HLR** **UGL\_HLR1(2)** + +Process in the HLR to handle an Update GPRS Location request from an SGSN + +Signals to/from the left are to/from the SGSN; signals to/from the right are to/from the GPRS mobility management application process in the HLR (see 3GPP TS 23.060) + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive[Receive_Open_ind] + Receive --> Wait[Wait_For_Service_Primitive] + Wait -- OK --> Ind1[MAP_UPDATE_GPRS_LOCATION_ind] + Ind1 --> Check[Check_Indication] + Check --> SubKnown{Subscriber known?} + SubKnown -- No --> Diag1[Set diagnostic: IMSI unknown] + SubKnown -- Yes --> NetMode{Network Access Mode?} + NetMode -- Non-GPRS only --> Diag2[Set diagnostic: GPRS subscription unknown] + NetMode -- Else --> Trace[Subscriber tracing active in SGSN:= False] + Trace --> Connector1((1)) + Diag1 --> UserError[Set User Error: Unknown subscriber] + Diag2 --> UserError + UserError --> Rsp1[MAP_UPDATE_GPRS_LOCATION_rsp +MAP_CLOSE_req] + Rsp1 --> Null2([Null]) + SubKnown -- Yes --> Error[Error] + Error --> Rsp2[MAP_UPDATE_GPRS_LOCATION_rsp +MAP_CLOSE_req] + Rsp2 --> Null3([Null]) + Wait -- Vr, Error --> Null4([Null]) + Wait --> Abort[MAP_P_ABORT_ind] + Abort --> Null5([Null]) + Wait --> Notice[MAP_NOTICE_ind] + Notice --> Close[MAP_CLOSE_req] + Close --> Null6([Null]) + +``` + +Flowchart for process Update\_GPRS\_Location\_HLR. It starts with an initial state, followed by 'Null', 'Receive\_Open\_ind', and 'Wait\_For\_Service\_Primitive'. From 'Wait\_For\_Service\_Primitive', an 'OK' path leads to 'MAP\_UPDATE\_GPRS\_LOCATION\_ind' and 'Check\_Indication', while a 'Vr, Error' path leads to 'Null'. 'Check\_Indication' leads to 'Subscriber known?'. If 'No', it goes to 'Set diagnostic: IMSI unknown' and then 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Network Access Mode?'. If 'Non-GPRS only', it goes to 'Set diagnostic: GPRS subscription unknown'. Both diagnostic paths lead to 'Set User Error: Unknown subscriber'. From 'Set User Error: Unknown subscriber', it goes to a response block 'MAP\_UPDATE\_GPRS\_LOCATION\_rsp' and 'MAP\_CLOSE\_req', then to 'Null'. If 'Subscriber known?' is 'Yes' and 'Network Access Mode?' is 'Else', it goes to 'Subscriber tracing active in SGSN:= False' and then to connector '1'. If 'Subscriber known?' is 'Yes' and 'Network Access Mode?' is 'Error', it goes to a response block 'MAP\_UPDATE\_GPRS\_LOCATION\_rsp' and 'MAP\_CLOSE\_req', then to 'Null'. There are also 'MAP\_P\_ABORT\_ind' and 'MAP\_NOTICE\_ind' paths from 'Wait\_For\_Service\_Primitive' leading to 'Null' and 'MAP\_CLOSE\_req' respectively. + +1104 + +1105 + +**Figure 19.1.1/14 (sheet 1 of 2): Process Update\_GPRS\_Location\_HLR** + +process Update\_GPRS\_Location\_HLR + +UGL\_HLR2(2) + +Process in the HLR to handle an Update GPRS Location request from an SGSN + +![Flowchart for process Update_GPRS_Location_HLR. It starts at node 1 and branches based on 'New SGSN?' and 'Roaming allowed in this PLMN?' decisions. It includes steps for charging, routing info updates, and subscriber data insertion, leading to a response message or null/error states.](6027f9f24ff9e9ac90508994e1f84733_img.jpg) + +``` + +graph TD + Start((1)) --> NewSGSN{New SGSN?} + NewSGSN -- No --> Merge1(( )) + NewSGSN -- Yes --> SuperCharged[Super_Charged_Cancel_Location_HLR] + SuperCharged -.-> Note1[See 3GPP TS 23.116] + SuperCharged --> ResultPass1{Result=Pass?} + ResultPass1 -- Yes --> Merge1 + ResultPass1 -- No --> CancelGPRS[Cancel_GPRS_Location_Child_HLR] + CancelGPRS --> Merge1 + Merge1 --> RoamingAllowed{Roaming allowed in this PLMN?} + RoamingAllowed -- No --> DeleteRouting[Delete Routeing Info] + DeleteRouting --> SetUserError1[Set User Error: Roaming not allowed] + SetUserError1 --> Null1([Null]) + SetUserError1 --> MAP_UPDATE[MAP_UPDATE_GPRS_LOCATION_rsp +MAP_CLOSE_req] + RoamingAllowed -- Yes --> UpdateRouting[Update Routeing Info; +MS Purged for GPRS:=False] + UpdateRouting --> ControlTracing[Control_Tracing_With_SGSN_HLR] + ControlTracing -- OK --> SuperCharged2[Super_Charged_Location_Updating_HLR] + SuperCharged2 -.-> Note2[See 3GPP TS 23.116] + ControlTracing -- Error --> Null2([Null]) + SuperCharged2 --> ResultPass2{Result=Pass?} + ResultPass2 -- Yes --> Merge2(( )) + ResultPass2 -- No --> InsertGPRS[Insert_GPRS_Subs_Data_Framed_HLR] + InsertGPRS -- OK --> SubscriberPresent[Subscriber_Present_HLR] + InsertGPRS -- Error --> SetUserError2[Set User Error: System failure] + InsertGPRS -- Aborted --> Null3([Null]) + SubscriberPresent --> Merge2 + Merge2 --> MAP_UPDATE2[MAP_UPDATE_GPRS_LOCATION_rsp +MAP_CLOSE_req] + MAP_UPDATE2 --> Null4([Null]) + +``` + +Flowchart for process Update\_GPRS\_Location\_HLR. It starts at node 1 and branches based on 'New SGSN?' and 'Roaming allowed in this PLMN?' decisions. It includes steps for charging, routing info updates, and subscriber data insertion, leading to a response message or null/error states. + +1106 + +1107 + +Figure 19.1.1/14 (sheet 2 of 2): Process Update\_GPRS\_Location\_HLR + +process Subscriber\_Present\_HLR + +SP\_HLR1(1) + +Process in the HLR to alert SMS service centres if required as part of the location updating process for a GPRS or non-GPRS subscriber + +![Flowchart for process Subscriber_Present_HLR. It starts with an oval, followed by a decision diamond 'Message waiting data set?'. The 'No' path bypasses the 'Alert_Service_Centre_HLR' process block. The 'Yes' path goes through the process block. Both paths lead to a merge point marked with an 'X'.](2e7ad223353e4888238650784ee941ef_img.jpg) + +``` +graph TD; Start([ ]) --> Decision{Message waiting data set?}; Decision -- No --> Merge((X)); Decision -- Yes --> Process[Alert_Service_Centre_HLR]; Process --> Merge; +``` + +Flowchart for process Subscriber\_Present\_HLR. It starts with an oval, followed by a decision diamond 'Message waiting data set?'. The 'No' path bypasses the 'Alert\_Service\_Centre\_HLR' process block. The 'Yes' path goes through the process block. Both paths lead to a merge point marked with an 'X'. + +1108 + +1109 + +Figure 19.1.1/15: Process Subscriber\_Present\_HLR + +1110 **19.1.1A Location updating for VCSG** + +1111 **19.1.1A.1 General** + +1112 The message flow for successful VCSG location updating between VLR and CSS or between SGSN and CSS is shown +1113 in figure 19.1.1A/1. + +![Sequence diagram showing message flow between VLR/SGSN and CSS. The diagram consists of two vertical lifelines: VLR/SGSN on the left and CSS on the right. Four numbered messages are shown: 1) A message from CSS to VLR/SGSN; 2) A message from VLR/SGSN to CSS; 3) A message from CSS to VLR/SGSN; 4) A message from VLR/SGSN to CSS.](961f2a48693ab0934b554468ea75aa60_img.jpg) + +``` + +sequenceDiagram + participant CSS + participant VLR_SGSN as VLR/SGSN + Note right of CSS: 1 + CSS->>VLR_SGSN: + Note left of VLR_SGSN: 2 + VLR_SGSN->>CSS: + Note right of CSS: 3 + CSS->>VLR_SGSN: + Note left of VLR_SGSN: 4 + VLR_SGSN->>CSS: + +``` + +Sequence diagram showing message flow between VLR/SGSN and CSS. The diagram consists of two vertical lifelines: VLR/SGSN on the left and CSS on the right. Four numbered messages are shown: 1) A message from CSS to VLR/SGSN; 2) A message from VLR/SGSN to CSS; 3) A message from CSS to VLR/SGSN; 4) A message from VLR/SGSN to CSS. + +1114 + +- 1115 1) MAP\_UPDATE\_VCSG\_LOCATION\_req/ind +- 1116 2) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 1117 3) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 1118 4) MAP\_UPDATE\_VCSG\_LOCATION\_rsp/cnf + +1119 + +1120 + +**Figure 19.1.1A/1: Message flow for VCSG location updating** + +1121 **19.1.1A.2 Procedures in the VLR** + +1122 The MAP process in the VLR for VCSG location updating for a roaming subscriber is shown in figure 19.1.1A/2. + +1123 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 1124 Receive\_Open\_Cnf see clause 25.1.2; +- 1125 Check\_Confirmation see clause 25.2.2; +- 1126 Insert\_Subs\_Data\_VLR see clause 25.7.2. + +1127 **19.1.1A.3 Procedures in the SGSN** + +1128 The MAP process in the SGSN for VCSG location updating for a roaming subscriber is shown in figure 19.1.1A/3. + +1129 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 1130 Receive\_Open\_Cnf see clause 25.1.2; +- 1131 Check\_Confirmation see clause 25.2.2; +- 1132 Insert\_Subs\_Data\_SGSN see clause 25.7.2. + +1133 **19.1.1A.4 Procedures in the CSS** + +1134 The MAP process in the CSS to handle a VCSG location updating request from a VLR or SGSN is shown in figure +1135 19.1.1A/4. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as +1136 follows: + +- 1137 Receive\_Open\_Ind see clause 25.1.1; + +1138 Check\_Indication see clause 25.2.1; +1139 Check\_Confirmation see clause 25.2.2; +1140 Insert\_VCSG\_Subs\_Data\_Framed\_CSS see clause 19.5A.1. +1141 + +process Update\_VCSG\_Location\_VLR + +Process in the VLR to open a dialogue for VCSG location updating with the CSS + +Signals to/from the left are to/from the VCSG mobility management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the CSS + +![Flowchart for process Update_VCSG_Location_VLR. It starts with an entry point leading to 'Null', then 'Update VCSG Location'. A decision 'CSS address known?' follows. If 'No', it goes to 'Set negative result: Unknown CSS' and then 'Update VCSG Location negative response' to 'Null'. If 'Yes', it sends 'MAP_OPEN_req', 'MAP_UPDATE_VCSG_LOCATION_req', and 'MAP_DELIMITER_req', then receives 'Open_Cnf'. If 'OK', it goes to 'Wait_For_CSS_Response'. If 'Vr, Error', it goes to 'Set negative result: Procedure error' and then 'Update VCSG Location negative response' to 'Null'. From 'Wait_For_CSS_Response', it branches into five paths: 1) 'MAP_INSERT_SUBSCRIBER_DATA_ind' leads to 'insert subscriber data ack', which leads to 'MAP_INSERT_SUBSCRIBER_DATA_rsp', which leads to 'Wait_For_CSS_Response'. 2) 'insert subscriber data neg ack' leads to 'Set user error'. 3) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req'. 4) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to 'Set negative result: System failure' and then 'Update VCSG Location negative response' to 'Null'. 5) A note 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.' leads to 'Update VCSG Location negative response' to 'Null'.](065202f6f7813acf6a58126294abec05_img.jpg) + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> UpdateLoc[Update VCSG Location] + UpdateLoc --> CSSKnown{CSS address known?} + CSSKnown -- No --> SetNeg1[Set negative result: Unknown CSS] + SetNeg1 --> NegResp1[Update VCSG Location negative response] + NegResp1 --> Null2([Null]) + CSSKnown -- Yes --> SendReq[MAP_OPEN_req +MAP_UPDATE_VCSG_LOCATION_req +MAP_DELIMITER_req] + SendReq --> RecvCnf[Receive Open_Cnf] + RecvCnf -- OK --> WaitCSS[Wait_For_CSS_Response] + RecvCnf -- "Vr, Error" --> SetNeg2[Set negative result: Procedure error] + SetNeg2 --> NegResp2[Update VCSG Location negative response] + NegResp2 --> Null3([Null]) + WaitCSS --> Ind1[MAP_INSERT_SUBSCRIBER_DATA_ind] + Ind1 --> Ack1[insert subscriber data ack] + Ack1 --> Rsp1[MAP_INSERT_SUBSCRIBER_DATA_rsp] + Rsp1 --> WaitCSS + Ack1 --> Ack2[insert subscriber data neg ack] + Ack2 --> UserErr[Set user error] + Ack1 --> Ind2[MAP_NOTICE_ind] + Ind2 --> CloseReq[MAP_CLOSE_req] + Ack1 --> Ind3["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + Ind3 --> SetNeg3[Set negative result: System failure] + SetNeg3 --> NegResp3[Update VCSG Location negative response] + NegResp3 --> Null4([Null]) + Ack1 --> Note["Subscriber data confirmed by CSS: False; +Location Information confirmed by CSS: False."] + Note --> NegResp4[Update VCSG Location negative response] + NegResp4 --> Null5([Null]) + +``` + +Flowchart for process Update\_VCSG\_Location\_VLR. It starts with an entry point leading to 'Null', then 'Update VCSG Location'. A decision 'CSS address known?' follows. If 'No', it goes to 'Set negative result: Unknown CSS' and then 'Update VCSG Location negative response' to 'Null'. If 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_UPDATE\_VCSG\_LOCATION\_req', and 'MAP\_DELIMITER\_req', then receives 'Open\_Cnf'. If 'OK', it goes to 'Wait\_For\_CSS\_Response'. If 'Vr, Error', it goes to 'Set negative result: Procedure error' and then 'Update VCSG Location negative response' to 'Null'. From 'Wait\_For\_CSS\_Response', it branches into five paths: 1) 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' leads to 'insert subscriber data ack', which leads to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp', which leads to 'Wait\_For\_CSS\_Response'. 2) 'insert subscriber data neg ack' leads to 'Set user error'. 3) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req'. 4) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to 'Set negative result: System failure' and then 'Update VCSG Location negative response' to 'Null'. 5) A note 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.' leads to 'Update VCSG Location negative response' to 'Null'. + +1142 + +1143 + +Figure 19.1.1A/2 (sheet 1 of 2): Process Update\_VCSG\_Location\_VLR + +process Update\_VCSG\_Location\_VLR + +Process in the VLR to open a dialogue for VCSG location updating with the CSS + +Signals to/from the left are to/from the VCSG mobility management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the CSS + +![Flowchart for process Update_VCSG_Location_VLR. It starts with 'Wait_For_CSS_Response', followed by 'MAP_UPDATE_VCSG_LOCATION_cnf', and 'Check_Confirmation'. From 'Check_Confirmation', an 'OK' path leads to 'Set result' (with 'Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.') and then to 'Update VCSG Location response' and 'Null'. A 'Provider Error, Data Error' path leads to 'Set negative result' and then to 'Update VCSG Location negative response' (with 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.') and 'Null'. A 'User error' decision point leads to 'Unknown Subscriber' (Set negative result: Unknown subscriber) or 'else' (Set negative result), both leading to 'Update VCSG Location negative response' and 'Null'.](23f1a7e498776906be1c80ef1e61686b_img.jpg) + +``` + +graph TD + Start([Wait_For_CSS_Response]) --> cnf[MAP_UPDATE_VCSG_LOCATION_cnf] + cnf --> Check[Check_Confirmation] + Check -- OK --> SetResult[Set result] + SetResult --> ResultInfo[Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.] + ResultInfo --> UpdateResponse{Update VCSG Location response} + UpdateResponse --> Null1([Null]) + Check -- "Provider Error, Data Error" --> SetNegResult1[Set negative result] + SetNegResult1 --> UpdateNegResponse{Update VCSG Location negative response} + UpdateNegResponse --> NegResultInfo[Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.] + NegResultInfo --> Null2([Null]) + Check -- User error --> UserError{User error} + UserError -- Unknown Subscriber --> SetNegResult2[Set negative result: Unknown subscriber] + UserError -- else --> SetNegResult3[Set negative result] + SetNegResult2 --> UpdateNegResponse + SetNegResult3 --> UpdateNegResponse + +``` + +Flowchart for process Update\_VCSG\_Location\_VLR. It starts with 'Wait\_For\_CSS\_Response', followed by 'MAP\_UPDATE\_VCSG\_LOCATION\_cnf', and 'Check\_Confirmation'. From 'Check\_Confirmation', an 'OK' path leads to 'Set result' (with 'Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.') and then to 'Update VCSG Location response' and 'Null'. A 'Provider Error, Data Error' path leads to 'Set negative result' and then to 'Update VCSG Location negative response' (with 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.') and 'Null'. A 'User error' decision point leads to 'Unknown Subscriber' (Set negative result: Unknown subscriber) or 'else' (Set negative result), both leading to 'Update VCSG Location negative response' and 'Null'. + +1144 + +1145 + +Figure 19.1.1A/2 (sheet 2 of 2): Process Update\_VCSG\_Location\_VLR + +process Update\_VCSG\_Location\_SGSN + +Process in the SGSN to open a dialogue for a VCSG location updating with the CSS + +Signals to/from the left are to/from the VCSG mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the CSS + +![Flowchart for process Update_VCSG_Location_SGSN. It starts with NULL, followed by Update VCSG Location. A decision 'CSS address known?' leads to 'Yes' (sending MAP_OPEN_req, MAP_UPDATE_VCSG_LOCATION_req, MAP_DELIMITER_req) or 'No' (Set negative result: Unknown CSS). The 'Yes' path leads to Receive_Open_Cnf, then Wait_For_CSS_Response. From Wait_For_CSS_Response, multiple paths emerge: 'Vr, Error' leads to Set negative result: Procedure error; 'MAP_INSERT_SUBSCRIBER_DATA ind' leads to Insert subscriber data; 'insert subscriber data ack' leads to MAP_INSERT_SUBSCRIBER_DATA_rsp; 'insert subscriber data neg ack' leads to Set user error; 'MAP_NOTICE_ind' leads to MAP_CLOSE_req; 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to Set negative result: System failure. All these paths eventually lead to Update VCSG Location negative response and then Null. A note indicates 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.'](df8aa6d2b7df5f22fedb0cbcc364972d_img.jpg) + +``` + +graph TD + Start([NULL]) --> Init[Update VCSG Location] + Init --> Decision{CSS address known?} + Decision -- No --> Neg1[Set negative result: Unknown CSS] + Neg1 --> Neg1Resp[Update VCSG Location negative response] + Neg1Resp --> Null1([Null]) + Decision -- Yes --> Req[MAP_OPEN_req +MAP_UPDATE_VCSG_LOCATION_req +MAP_DELIMITER_req] + Req --> OpenCnf[Receive_Open_Cnf] + OpenCnf -- OK --> Wait[Wait_For_CSS_Response] + OpenCnf -- Vr, Error --> Neg2[Set negative result: Procedure error] + Wait --> Ind1[MAP_INSERT_SUBSCRIBER_DATA ind] + Wait --> Ack1[insert subscriber data ack] + Wait --> NegAck1[insert subscriber data neg ack] + Wait --> Ind2[MAP_NOTICE_ind] + Wait --> Ind3[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Ind1 --> InsertData[Insert subscriber data] + InsertData --> Wait2[Wait_For_CSS_Response] + Ack1 --> Rsp1[MAP_INSERT_SUBSCRIBER_DATA_rsp] + NegAck1 --> UserError[Set user error] + Ind2 --> CloseReq[MAP_CLOSE_req] + Ind3 --> Neg3[Set negative result: System failure] + UserError --> Neg2Resp[Update VCSG Location negative response] + CloseReq --> Neg2Resp + Neg3 --> Neg3Resp[Update VCSG Location negative response] + Neg2Resp --> Null2([Null]) + Neg3Resp --> Null3([Null]) + Note[Subscriber data confirmed by CSS: False; +Location Information confirmed by CSS: False.] + +``` + +Flowchart for process Update\_VCSG\_Location\_SGSN. It starts with NULL, followed by Update VCSG Location. A decision 'CSS address known?' leads to 'Yes' (sending MAP\_OPEN\_req, MAP\_UPDATE\_VCSG\_LOCATION\_req, MAP\_DELIMITER\_req) or 'No' (Set negative result: Unknown CSS). The 'Yes' path leads to Receive\_Open\_Cnf, then Wait\_For\_CSS\_Response. From Wait\_For\_CSS\_Response, multiple paths emerge: 'Vr, Error' leads to Set negative result: Procedure error; 'MAP\_INSERT\_SUBSCRIBER\_DATA ind' leads to Insert subscriber data; 'insert subscriber data ack' leads to MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp; 'insert subscriber data neg ack' leads to Set user error; 'MAP\_NOTICE\_ind' leads to MAP\_CLOSE\_req; 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to Set negative result: System failure. All these paths eventually lead to Update VCSG Location negative response and then Null. A note indicates 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.' + +1146 + +1147 + +Figure 19.1.1A/3 (sheet 1 of 2): Process Update\_VCSG\_Location\_SGSN + +process Update\_VCSG\_Location\_SGSN + +Process in the SGSN to open a dialogue for a VCSG location updating with the CSS + +Signals to/from the left are to/from the VCSG mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the CSS + +![Flowchart for process Update_VCSG_Location_SGSN. It starts with 'Wait_For_CSS_Response', followed by 'MAP_UPDATE_VCSG_LOCATION.cnf', and 'Check_Confirmation'. From 'Check_Confirmation', there are three paths: 'OK' leading to 'Set result' (with a note 'Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.') and then 'Update VCSG Location response' to 'Null'; 'User error' leading to 'Set negative result: Unknown subscriber' and then 'Update VCSG Location negative response' (with a note 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.') to 'Null'; and 'Provider Error, Data Error' leading to 'Set negative result' to 'Null'.](bbefe499225465a871d9b936d8a84e39_img.jpg) + +``` + +graph TD + Start([Wait_For_CSS_Response]) --> cnf[MAP_UPDATE_VCSG_LOCATION.cnf] + cnf --> Check[Check_Confirmation] + Check -- OK --> SetResult[Set result] + SetResult --> NoteTrue[Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.] + NoteTrue --> UpdateResponse{Update VCSG Location response} + UpdateResponse --> Null1([Null]) + Check -- User error --> Unknown[Set negative result: Unknown subscriber] + Unknown --> NegativeResponse{Update VCSG Location negative response} + NegativeResponse --> NoteFalse[Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.] + NoteFalse --> Null2([Null]) + Check -- "else (Provider Error, Data Error)" --> NegResult1[Set negative result] + NegResult1 --> Null3([Null]) + +``` + +Flowchart for process Update\_VCSG\_Location\_SGSN. It starts with 'Wait\_For\_CSS\_Response', followed by 'MAP\_UPDATE\_VCSG\_LOCATION.cnf', and 'Check\_Confirmation'. From 'Check\_Confirmation', there are three paths: 'OK' leading to 'Set result' (with a note 'Subscriber data confirmed by CSS: True; Location Information confirmed by CSS: True.') and then 'Update VCSG Location response' to 'Null'; 'User error' leading to 'Set negative result: Unknown subscriber' and then 'Update VCSG Location negative response' (with a note 'Subscriber data confirmed by CSS: False; Location Information confirmed by CSS: False.') to 'Null'; and 'Provider Error, Data Error' leading to 'Set negative result' to 'Null'. + +1148 + +1149 + +Figure 19.1.1A/3 (sheet 2 of 2): Process Update\_VCSG\_Location\_SGSN + +![Flowchart for process Update_VCSG_Location_CSS. It starts with an initial node, followed by 'Null', then 'Receive Open_Ind'. From 'Receive Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait_For_Service_Primitive' branches into three paths: 'MAP_P_ABORT_ind' leading to 'Null', 'MAP_UPDATE_VCSG_LOCATION_ind' leading to 'Check_Indication', and 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and then 'Null'. 'Check_Indication' has an 'OK' path leading to 'Subscriber known?' and an 'Error' path leading to a response block ('MAP_UPDATE_VCSG_LOCATION_rsp', 'MAP_CLOSE_req') and then 'Null'. 'Subscriber known?' has a 'Yes' path leading to connector '1' and a 'No' path leading to 'Set diagnostic: IMSI unknown', 'Set User Error: Unknown subscriber', a response block ('MAP_UPDATE_VCSG_LOCATION_rsp', 'MAP_CLOSE_req'), and finally 'Null'.](69907ac8150588f702fb1fbb9748e7e3_img.jpg) + +process Update\_VCSG\_Location\_CSS UVL\_CSS1(2) + +Process in the CSS to handle an Update VCSG Location request from a VLR or SGSN + +Signals to/from the left are to/from the VLR or the SGSN; signals to/from the right are to/from the VCSG mobility management application process in the CSS + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- OK --> Wait[Wait_For_Service_Primitive] + RecOpen -- "Vr, Error" --> Null2([Null]) + Wait --> MAP_P_ABORT{MAP_P_ABORT_ind} + Wait --> MAP_UPDATE{MAP_UPDATE_VCSG_LOCATION_ind} + Wait --> MAP_NOTICE{MAP_NOTICE_ind} + MAP_P_ABORT --> Null3([Null]) + MAP_UPDATE --> Check[Check_Indication] + MAP_NOTICE --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_CLOSE_req --> Null4([Null]) + Check -- OK --> SubKnown{Subscriber known?} + Check -- Error --> Res1[MAP_UPDATE_VCSG_LOCATION_rsp +MAP_CLOSE_req] + Res1 --> Null5([Null]) + SubKnown -- Yes --> Connector1((1)) + SubKnown -- No --> SetDiag[Set diagnostic: +IMSI unknown] + SetDiag --> SetErr[Set User Error: +Unknown subscriber] + SetErr --> Res2[MAP_UPDATE_VCSG_LOCATION_rsp +MAP_CLOSE_req] + Res2 --> Null6([Null]) + +``` + +Flowchart for process Update\_VCSG\_Location\_CSS. It starts with an initial node, followed by 'Null', then 'Receive Open\_Ind'. From 'Receive Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait\_For\_Service\_Primitive' branches into three paths: 'MAP\_P\_ABORT\_ind' leading to 'Null', 'MAP\_UPDATE\_VCSG\_LOCATION\_ind' leading to 'Check\_Indication', and 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and then 'Null'. 'Check\_Indication' has an 'OK' path leading to 'Subscriber known?' and an 'Error' path leading to a response block ('MAP\_UPDATE\_VCSG\_LOCATION\_rsp', 'MAP\_CLOSE\_req') and then 'Null'. 'Subscriber known?' has a 'Yes' path leading to connector '1' and a 'No' path leading to 'Set diagnostic: IMSI unknown', 'Set User Error: Unknown subscriber', a response block ('MAP\_UPDATE\_VCSG\_LOCATION\_rsp', 'MAP\_CLOSE\_req'), and finally 'Null'. + +1150 + +1151 + +Figure 19.1.1A/4 (sheet 1 of 2): Process Update\_VCSG\_Location\_CSS + +![Flowchart for process Update_VCSG_Location_CSS. It starts at connector 1, proceeds to Insert_VCSG_Subs_Data_Framed_CSS, then to a Result? decision. If OK, it goes to Update_Routeing_Info, then to a merge point for MAP_UPDATE_VCSG_LOCATION_rsp and MAP_CLOSE_req, and finally to Null. If Error, it goes to Set User Error: System failure, then to the same merge point. If Aborted, it goes directly to Null.](e3adfe9588ba47502c2c933a6e025ca4_img.jpg) + +process Update\_VCSG\_Location\_CSS UVL\_CSS2(2) + +Process in the CSS to handle an Update VCSG Location request from a VLR or SGSN + +Signals to/from the left are to/from the VLR or the SGSN; signals to/from the right are to/from the VCSG mobility management application process in the CSS + +``` + +graph TD + 1((1)) --> Insert[Insert_VCSG_Subs_Data_Framed_CSS] + Insert --> Result{Result?} + Result -- OK --> Update[Update_Routeing_Info] + Update --> Merge{ } + Merge --> Null1([Null]) + Result -- Error --> Error[Set User Error: System failure] + Error --> Merge + Merge -- "MAP_UPDATE_VCSG_LOCATION_rsp +MAP_CLOSE_req" --> Null2([Null]) + Result -- Aborted --> Null3([Null]) + +``` + +Flowchart for process Update\_VCSG\_Location\_CSS. It starts at connector 1, proceeds to Insert\_VCSG\_Subs\_Data\_Framed\_CSS, then to a Result? decision. If OK, it goes to Update\_Routeing\_Info, then to a merge point for MAP\_UPDATE\_VCSG\_LOCATION\_rsp and MAP\_CLOSE\_req, and finally to Null. If Error, it goes to Set User Error: System failure, then to the same merge point. If Aborted, it goes directly to Null. + +1152 + +1153 + +Figure 19.1.1A/4 (sheet 2 of 2): Process Update\_VCSG\_Location\_CSS + +1154 **19.1.2 Location Cancellation** + +1155 **19.1.2.1 General** + +1156 Location cancellation is used to delete a subscriber record from the serving node (VLR or SGSN). The procedure is +1157 invoked: + +- 1158 - because the subscriber has registered with a new serving node, or +- 1159 - because the HPLMN operator has decided to delete the subscriber record from the serving node, e.g. because the +1160 subscription has been withdrawn, or because roaming restrictions have been imposed. Location cancellation can +1161 be used to force location updating including updating of subscriber data in the serving node at the next +1162 subscriber access. + +1163 The message flow for location cancellation for a non-GPRS subscriber is shown in figure 19.1.2/1. + +1164 The message flow for location cancellation for a GPRS subscriber is shown in figure 19.1.2/2. + +![Sequence diagram for non-GPRS location cancellation showing interactions between VLR, HLR, and PVLR.](436937dfff8d225780cc49207a18e87f_img.jpg) + +The diagram shows three lifelines: VLR, HLR, and PVLR. + 1. A dotted arrow points from the VLR lifeline to the HLR lifeline, labeled with a box containing '1'. + 2. A solid arrow points from the HLR lifeline to the PVLR lifeline, labeled with a box containing '2'. + 3. A solid arrow points from the PVLR lifeline back to the HLR lifeline, labeled with a box containing '3'. + +Sequence diagram for non-GPRS location cancellation showing interactions between VLR, HLR, and PVLR. + +1165 + +- 1166 1) MAP\_UPDATE\_LOCATION\_req/ind +- 1167 2) MAP\_CANCEL\_LOCATION\_req/ind +- 1168 3) MAP\_CANCEL\_LOCATION\_rsp/cnf +- 1169 + +1170 NOTE: The service shown in dotted lines indicates the trigger provided by other MAP signalling. +1171 + +1172 **Figure 19.1.2/1: Message flow for Location Cancellation (non-GPRS)** +1173 + +![Sequence diagram for GPRS location cancellation showing interactions between SGSN, HLR, and PSGSN.](5bb65c8534cf12a55e688b511347512f_img.jpg) + +The diagram shows three lifelines: SGSN, HLR, and PSGSN. + 1. A dotted arrow points from the SGSN lifeline to the HLR lifeline, labeled with a box containing '1'. + 2. A solid arrow points from the HLR lifeline to the PSGSN lifeline, labeled with a box containing '2'. + 3. A solid arrow points from the PSGSN lifeline back to the HLR lifeline, labeled with a box containing '3'. + +Sequence diagram for GPRS location cancellation showing interactions between SGSN, HLR, and PSGSN. + +1174 + +- 1175 1) MAP\_UPDATE\_GPRS\_LOCATION\_req/ind +- 1176 2) MAP\_CANCEL\_LOCATION\_req/ind +- 1177 3) MAP\_CANCEL\_LOCATION\_rsp/cnf +- 1178 + +1179 NOTE: The service shown in dotted lines indicates the trigger provided by other MAP signalling. +1180 + +1181 **Figure 19.1.2/2: Message flow for Location Cancellation (GPRS)** +1182 + +1183 **19.1.2.2 Procedure in the HLR** + +1184 The MAP process in the HLR to cancel the location information in a VLR is shown in figure 19.1.2/3. The MAP +1185 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1186     Receive\_Open\_Cnf     see clause 25.1.2; + +1187     Check\_Confirmation     see clause 25.2.2. + +1188 The MAP process in the HLR to cancel the location information in a VLR as an independent process invoked from +1189 another process is shown in figure 19.1.2/4. + +1190 The MAP process in the HLR to cancel the location information in an SGSN is shown in figure 19.1.2/5. The MAP +1191 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1192     Receive\_Open\_Cnf     see clause 25.1.2; + +1193     Check\_Confirmation     see clause 25.2.2. + +1194 The MAP process in the HLR to cancel the location information in an SGSN as an independent process invoked from +1195 another process is shown in figure 19.1.2/6. + +### 1196 19.1.2.3     Procedure in the VLR + +1197 The MAP process in the VLR to handle a location cancellation request is shown in figure 19.1.2/7. The MAP process +1198 invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1199     Receive\_Open\_Ind     see clause 25.1.1. + +### 1200 19.1.2.4     Procedure in the SGSN + +1201 The MAP process in the SGSN to handle a location cancellation request is shown in figure 19.1.2/8. The MAP process +1202 invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1203     Receive\_Open\_Ind     see clause 25.1.1. + +1204 + +![Flowchart for process Cancel_Location_HLR. The process starts with an initial state, followed by 'Null', 'Cancel Location', and a merge point for MAP requests (OPEN, CANCEL_LOCATION, DELIMITER). It then enters 'Receive_Open_Cnf'. From here, a 'Vr' path leads to 'Perform MAP Vr dialogue' and 'Null'. An 'OK' path leads to 'Wait_For_VLR_Response', which then branches into three indicators: 'MAP_P_ABORT_ind' (leading to 'Abort' and 'Null'), 'MAP_CANCEL_LOCATION_cnf' (leading to 'Check Confirmation'), and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req'). 'Check Confirmation' has three outcomes: 'Provider Error, Data Error' (leading to 'Set negative response: System failure', 'Cancel Location negative response', and 'Null'), 'OK' (leading to 'Cancel Location ack' and 'Null'), and 'User Error' (leading to 'Set negative response', 'Cancel Location negative response', and 'Null'). An 'Error' path from 'Wait_For_VLR_Response' leads to 'Set negative response: System failure', 'Cancel Location negative response', and 'Null'.](ad73d5ca7408dae269a6a821e33b1869_img.jpg) + +process Cancel\_Location\_HLR CL\_HLR1(1) + +Process in the HLR to cancel the information stored in a VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the location management application process in the HLR (see 3GPP TS 23.012) or the process Cancel\_Location\_Child\_HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> CancelLocation[Cancel Location] + CancelLocation --> Merge{ } + Merge --- MAP_Req["MAP_OPEN_req +MAP_CANCEL_LOCATION_req +MAP_DELIMITER_req"] + Merge --> ReceiveOpenCnf[Receive_Open_Cnf] + + ReceiveOpenCnf -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null2([Null]) + + ReceiveOpenCnf -- OK --> WaitForVLR[Wait_For_VLR_Response] + + WaitForVLR -- Error --> SetNegSys[Set negative response: System failure] + SetNegSys --> CancelNeg[Cancel Location negative response] + CancelNeg --> Null3([Null]) + + WaitForVLR --> MAP_P_ABORT_ind{MAP_P_ABORT_ind} + MAP_P_ABORT_ind --> Abort[Abort] + Abort --> Null4([Null]) + + WaitForVLR --> MAP_CANCEL_LOCATION_cnf{MAP_CANCEL_LOCATION_cnf} + MAP_CANCEL_LOCATION_cnf --> CheckConfirmation[Check Confirmation] + + CheckConfirmation -- "Provider Error, Data Error" --> SetNegSys2[Set negative response: System failure] + SetNegSys2 --> CancelNeg2[Cancel Location negative response] + CancelNeg2 --> Null5([Null]) + + CheckConfirmation -- OK --> CancelLocAck[Cancel Location ack] + CancelLocAck --> Null6([Null]) + + CheckConfirmation -- User Error --> SetNegUser[Set negative response] + SetNegUser --> CancelNeg3[Cancel Location negative response] + CancelNeg3 --> Null7([Null]) + + WaitForVLR --> MAP_NOTICE_ind{MAP_NOTICE_ind} + MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_CLOSE_req --> SetNegSys3[Set negative response: System failure] + SetNegSys3 --> CancelNeg4[Cancel Location negative response] + CancelNeg4 --> Null8([Null]) + +``` + +Flowchart for process Cancel\_Location\_HLR. The process starts with an initial state, followed by 'Null', 'Cancel Location', and a merge point for MAP requests (OPEN, CANCEL\_LOCATION, DELIMITER). It then enters 'Receive\_Open\_Cnf'. From here, a 'Vr' path leads to 'Perform MAP Vr dialogue' and 'Null'. An 'OK' path leads to 'Wait\_For\_VLR\_Response', which then branches into three indicators: 'MAP\_P\_ABORT\_ind' (leading to 'Abort' and 'Null'), 'MAP\_CANCEL\_LOCATION\_cnf' (leading to 'Check Confirmation'), and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req'). 'Check Confirmation' has three outcomes: 'Provider Error, Data Error' (leading to 'Set negative response: System failure', 'Cancel Location negative response', and 'Null'), 'OK' (leading to 'Cancel Location ack' and 'Null'), and 'User Error' (leading to 'Set negative response', 'Cancel Location negative response', and 'Null'). An 'Error' path from 'Wait\_For\_VLR\_Response' leads to 'Set negative response: System failure', 'Cancel Location negative response', and 'Null'. + +1205 + +1206 + +Figure 19.1.2/3: Process Cancel\_Location\_HLR + +![State transition diagram for process Cancel_Location_Child_HLR. The process starts at an initial state (oval), transitions to a 'Cancel Location' state (diamond), then to a 'Wait_For_VLR_Response' state (oval). From there, it branches into two possible states: 'Cancel Location negative response' (diamond) and 'Cancel Location ack' (diamond). Both of these states lead to terminal states (crosses). A note on the top left indicates this is a child process in the HLR to cancel information in a VLR. A note on the top right indicates signals to/from the left are to/from the process Cancel_Location_HLR.](dc16cec51c6540030d965176f36e4810_img.jpg) + +process **Cancel\_Location\_Child\_HLR** CLC\_HLR1(1) + +``` +stateDiagram-v2 + [*] --> Cancel_Location + Cancel_Location --> Wait_For_VLR_Response + state "Cancel Location negative response" as Cancel_Location_negative_response + state "Cancel Location ack" as Cancel_Location_ack + Wait_For_VLR_Response --> Cancel_Location_negative_response + Wait_For_VLR_Response --> Cancel_Location_ack + Cancel_Location_negative_response --> [*] + Cancel_Location_ack --> [*] +``` + +Child process in the HLR to cancel the information stored in a VLR + +Signals to/from the left are to/from the process **Cancel\_Location\_HLR** + +State transition diagram for process Cancel\_Location\_Child\_HLR. The process starts at an initial state (oval), transitions to a 'Cancel Location' state (diamond), then to a 'Wait\_For\_VLR\_Response' state (oval). From there, it branches into two possible states: 'Cancel Location negative response' (diamond) and 'Cancel Location ack' (diamond). Both of these states lead to terminal states (crosses). A note on the top left indicates this is a child process in the HLR to cancel information in a VLR. A note on the top right indicates signals to/from the left are to/from the process Cancel\_Location\_HLR. + +1207 + +1208 + +**Figure 19.1.2/4: Process Cancel\_Location\_Child\_HLR** + +![Flowchart for process Cancel_GPRS_Location_HLR. It starts with an internal timer expiry leading to 'Repeat attempt timer expired', which then leads to 'Cancel GPRS Location'. From 'Cancel GPRS Location', it sends MAP requests (OPEN, CANCEL_GPRS_LOCATION, DELIMITER) and waits for a response. If 'OK', it checks the confirmation. If 'User Error' or 'Provider Error/Data Error', it checks if a repeat attempt is allowed. If 'Yes', it restarts the timer and loops back. If 'No', it sets a negative response and ends. If 'Vr, Error', it sets a system failure response and ends.](3ba7b01a4ad082fa3e585e0945b135d2_img.jpg) + +**process Cancel\_GPRS\_Location\_HLR** **CGL\_HLR1(1)** + +Process in the HLR to cancel the information stored in an SGSN + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the GPRS mobility management application process in the HLR (see 3GPP TS 23.060) or the process Cancel\_GPRS\_Location\_Child\_HLR unless marked otherwise + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> CancelGPRS[Cancel GPRS Location] + + Internal[Internal] --> TimerExpired{Repeat attempt timer expired} + + CancelGPRS --> MAPReq["MAP_OPEN_req +MAP_CANCEL_GPRS_LOCATION_req +MAP_DELIMITER_req"] + + MAPReq --> ReceiveOpenCnf[Receive_Open_Cnf] + + ReceiveOpenCnf --> WaitForVLR[Wait_For_VLR_Response] + + WaitForVLR --> DecisionOK{OK} + + DecisionOK -- Vr, Error --> SystemFailure[Set negative response: System failure] + + SystemFailure --> CancelNeg[Cancel GPRS Location negative response] + + CancelNeg --> Null2([Null]) + + DecisionOK -- OK --> CheckConfirmation[Check Confirmation] + + CheckConfirmation --> DecisionProviderError{Provider Error, Data Error} + + DecisionProviderError -- Yes --> RepeatAttempt{Repeat attempt?} + + RepeatAttempt -- No --> SystemFailure2[Set negative response: System failure] + + SystemFailure2 --> CancelNeg2[Cancel GPRS Location negative response] + + CancelNeg2 --> Null3([Null]) + + RepeatAttempt -- Yes --> StartRepeat[Start Repeat attempt timer] + + StartRepeat --> WaitForRepeat[Wait_For_Repeat_Attempt_Timer_Expiry] + + WaitForRepeat --> TimerExpired + + DecisionProviderError -- OK --> CancelAck[Cancel GPRS Location ack] + + CancelAck --> Null4([Null]) + + DecisionProviderError -- User Error --> DecisionUserError{Repeat attempt?} + + DecisionUserError -- No --> SetNeg[Set negative response] + + SetNeg --> CancelNeg3[Cancel GPRS Location negative response] + + CancelNeg3 --> Null5([Null]) + + DecisionUserError -- Yes --> StartRepeat2[Start Repeat attempt timer] + + StartRepeat2 --> WaitForRepeat2[Wait_For_Repeat_Attempt_Timer_Expiry] + + WaitForRepeat2 --> TimerExpired + + DecisionOK --> MAP_P_ABORT[MAP_P_ABORT_ind] + + DecisionOK --> MAP_NOTICE[MAP_NOTICE_ind] + + DecisionOK --> MAP_CANCEL_CNF[MAP_CANCEL_LOCATION_cnf] + + MAP_CANCEL_CNF --> CheckConfirmation + + MAP_NOTICE --> MAP_CLOSE_REQ{MAP_CLOSE_req} + + MAP_CLOSE_REQ --> DecisionProviderError + + MAP_P_ABORT --> DecisionProviderError + +``` + +Flowchart for process Cancel\_GPRS\_Location\_HLR. It starts with an internal timer expiry leading to 'Repeat attempt timer expired', which then leads to 'Cancel GPRS Location'. From 'Cancel GPRS Location', it sends MAP requests (OPEN, CANCEL\_GPRS\_LOCATION, DELIMITER) and waits for a response. If 'OK', it checks the confirmation. If 'User Error' or 'Provider Error/Data Error', it checks if a repeat attempt is allowed. If 'Yes', it restarts the timer and loops back. If 'No', it sets a negative response and ends. If 'Vr, Error', it sets a system failure response and ends. + +1209 + +1210 + +**Figure 19.1.2/5: Process Cancel\_GPRS\_Location\_HLR** + +![Flowchart for process Cancel_GPRS_Location_Child_HLR. It starts with an oval, followed by a 'Cancel GPRS Location' message box. Then a 'Wait_For_SGSN_Response' box. A decision line splits into two message boxes: 'Cancel GPRS Location negative response' and 'Cancel GPRS Location ack'. Both lead to an 'X' symbol representing an exit or error state.](96bcdda8c2915356b4fa959ef3c4ee2f_img.jpg) + +process Cancel\_GPRS\_Location\_Child\_HLR CGLC\_HLR1(1) + +Child process in the HLR to cancel the information stored in an SGSN + +Signals to/from the left are to/from the process Cancel\_GPRS\_Location\_HLR + +``` + +graph TD + Start([ ]) --> Msg1[Cancel GPRS Location] + Msg1 --> Wait[Wait_For_SGSN_Response] + Wait --> Decision(( )) + Decision --> Msg2[Cancel GPRS Location negative response] + Decision --> Msg3[Cancel GPRS Location ack] + Msg2 --> Exit1[X] + Msg3 --> Exit2[X] + +``` + +Flowchart for process Cancel\_GPRS\_Location\_Child\_HLR. It starts with an oval, followed by a 'Cancel GPRS Location' message box. Then a 'Wait\_For\_SGSN\_Response' box. A decision line splits into two message boxes: 'Cancel GPRS Location negative response' and 'Cancel GPRS Location ack'. Both lead to an 'X' symbol representing an exit or error state. + +1211 + +1212 + +**Figure 19.1.2/6: Process Cancel\_GPRS\_Location\_Child\_HLR** + +![Flowchart for process Cancel_Location_VLR. It starts with an initial node, followed by 'Null', then 'Receive Open_Ind'. From 'Receive Open_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait_For_Service_Primitive'; and 'Error' leading to 'Null'. From 'Wait_For_Service_Primitive', a 'MAP_CANCEL_LOCATION_ind' signal is received, leading to 'Cancel Location', then 'Wait_For_Application_Response'. From 'Wait_For_Application_Response', two paths emerge: 'Cancel Location ack' leading to 'Set Result', and 'Cancel Location negative response' leading to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to a 'MAP_CANCEL_LOCATION_rsp' / 'MAP_CLOSE_req' signal, and finally to 'Null'.](135596da3b529757391156b44220a6c7_img.jpg) + +**process Cancel\_Location\_VLR** **CL\_VLR1(1)** + +Process in the VLR to handle a Cancel Location request + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null2([Null]) + RecOpen -- OK --> WaitService[Wait_For_Service_Primitive] + RecOpen -- Error --> Null3([Null]) + WaitService -- "MAP_CANCEL_LOCATION_ind" --> CancelLoc{Cancel Location} + CancelLoc --> WaitApp[Wait_For_Application_Response] + WaitApp -- "Cancel Location ack" --> SetResult[Set Result] + WaitApp -- "Cancel Location negative response" --> SetUserError[Set User Error] + SetResult --> Merge(( )) + SetUserError --> Merge + Merge -- "MAP_CANCEL_LOCATION_rsp +MAP_CLOSE_req" --> Null4([Null]) + +``` + +Flowchart for process Cancel\_Location\_VLR. It starts with an initial node, followed by 'Null', then 'Receive Open\_Ind'. From 'Receive Open\_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait\_For\_Service\_Primitive'; and 'Error' leading to 'Null'. From 'Wait\_For\_Service\_Primitive', a 'MAP\_CANCEL\_LOCATION\_ind' signal is received, leading to 'Cancel Location', then 'Wait\_For\_Application\_Response'. From 'Wait\_For\_Application\_Response', two paths emerge: 'Cancel Location ack' leading to 'Set Result', and 'Cancel Location negative response' leading to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to a 'MAP\_CANCEL\_LOCATION\_rsp' / 'MAP\_CLOSE\_req' signal, and finally to 'Null'. + +1213 + +1214 + +**Figure 19.1.2/7: Process Cancel\_Location\_VLR** + +![Flowchart for process Cancel_Location_SGSN. It starts with an initial node, followed by 'Null', 'Receive Open_Ind', 'Wait_For_Service_Primitive', a decision point for 'MAP_CANCEL_LOCATION_ind', 'Check_Indication', 'Subscriber registered?' decision, 'Delete subscriber record', 'Release P-TMSI', a merge point for 'MAP_CANCEL_LOCATION_rsp' and 'MAP_CLOSE_req', and finally 'Null'.](4e3b813e7d14508be44d187387c824d5_img.jpg) + +**process Cancel\_Location\_SGSN** **CGL\_SGSN1(1)** + +Process in the SGSN to handle a Cancel Location request + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- OK --> WaitFor[Wait_For_Service_Primitive] + RecOpen -- "Vr, Error" --> Null2([Null]) + WaitFor --> Merge1(( )) + Merge1 --> MAP_CANCEL_LOCATION_ind{MAP_CANCEL_LOCATION_ind} + MAP_CANCEL_LOCATION_ind --> CheckInd[Check_Indication] + CheckInd -- OK --> SubReg{Subscriber registered?} + CheckInd -- Error --> ReleaseP[Release P-TMSI] + SubReg -- No --> ReleaseP + SubReg -- Yes --> DeleteSub[Delete subscriber record] + DeleteSub --> ReleaseP + ReleaseP --> Merge2(( )) + Merge2 -- "MAP_CANCEL_LOCATION_rsp +MAP_CLOSE_req" --> Null3([Null]) + MAP_CANCEL_LOCATION_ind --> MAP_NOTICE_ind[/MAP NOTICE_ind/] + MAP_NOTICE_ind --> MAP_CLOSE_req[/MAP CLOSE_req/] + MAP_CLOSE_req --> Null4([Null]) + Merge1 --> MAP_P_ABORT_ind[/MAP_P_ABORT_ind/] + MAP_P_ABORT_ind --> Null5([Null]) + +``` + +Flowchart for process Cancel\_Location\_SGSN. It starts with an initial node, followed by 'Null', 'Receive Open\_Ind', 'Wait\_For\_Service\_Primitive', a decision point for 'MAP\_CANCEL\_LOCATION\_ind', 'Check\_Indication', 'Subscriber registered?' decision, 'Delete subscriber record', 'Release P-TMSI', a merge point for 'MAP\_CANCEL\_LOCATION\_rsp' and 'MAP\_CLOSE\_req', and finally 'Null'. + +1215 + +1216 + +**Figure 19.1.2/8: Process Cancel\_Location\_SGSN** + +1217 **19.1.2A Location Cancellation for VCSG** + +1218 **19.1.2A.1 General** + +1219 Location cancellation for VCSG is used to delete a subscriber record from the serving node (VLR or SGSN). The +1220 procedure is invoked: + +- 1221 - because there is a removal of the CSG subscription data in the CSS and of the MS registration +- 1222 - because the CSS has decided to cancel the registration of the MS which does not have CSG subscription data in +- 1223 the CSS. + +1224 NOTE: How the CSS determines when to cancel the registration of the MS is implementation dependent. + +1225 The message flow for VCSG location cancellation for a subscriber is shown in figure 19.1.2A/1. + +![Sequence diagram showing message flow between CSS and VLR/SGSN. Step 1: CSS sends a request to VLR/SGSN. Step 2: VLR/SGSN sends a response back to CSS.](cc3a36cfa986a92dcc94840351e1c36c_img.jpg) + +``` + +sequenceDiagram + participant CSS + participant VLR_SGSN as VLR/SGSN + Note right of VLR_SGSN: 1 + CSS->>VLR_SGSN: Request + Note left of CSS: 2 + VLR_SGSN-->>CSS: Response + +``` + +Sequence diagram showing message flow between CSS and VLR/SGSN. Step 1: CSS sends a request to VLR/SGSN. Step 2: VLR/SGSN sends a response back to CSS. + +1226 + +1227 + +1228 1) MAP\_CANCEL\_VCSG\_LOCATION\_req/ind + +1229 2) MAP\_CANCEL\_VCSG\_LOCATION\_rsp/cnf + +1230 + +1231 + +1232 + +**Figure 19.1.2A/1: Message flow for VCSG Location Cancellation** + +1233 **19.1.2A.2 Procedure in the CSS** + +1234 The MAP process in the CSS to cancel the VCSG location information in a VLR is shown in figure 19.1.2A/2. The +1235 MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1236 Receive\_Open\_Cnf see clause 25.1.2; + +1237 Check\_Confirmation see clause 25.2.2. + +1238 The MAP process in the CSS to cancel the VCSG location information in a SGSN is shown in figure 19.1.2A/3. The +1239 MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1240 Receive\_Open\_Cnf see clause 25.1.2; + +1241 Check\_Confirmation see clause 25.2.2. + +1242 + +1243 **19.1.2A.3 Procedure in the VLR** + +1244 The MAP process in the VLR to handle a VCSG location cancellation request is shown in figure 19.1.2A/4. The MAP +1245 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1246 Receive\_Open\_Ind see clause 25.1.1. + +1247 **19.1.2A.4 Procedure in the SGSN** + +1248 The MAP process in the SGSN to handle a VCSG location cancellation request is shown in figure 19.1.2A/5. The MAP +1249 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1250    Receive\_Open\_Ind    see clause 25.1.1. + +1251 + +# process Cancel\_VCSG\_Location\_CSS + +Process in the CSS to cancel the information stored in a VLR or SGSN + +Signals to are to/from signals to are to/from management process in 3GPP TS TS 23.060 + +![Flowchart for process Cancel_VCSG_Location_CSS. It starts with an initial state leading to 'Null', then 'Cancel VCSG Location'. A decision diamond shows incoming signals: MAP_OPEN_req, MAP_CANCEL_VCSG_LOCATION_req, and MAP_DELIMITER_req. It then goes to 'Receive_Open_Cnf'. From there, a 'Vr' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait_For_VLR_Response'. From this wait state, three options are available: 'MAP_P_ABORT_ind' leading to 'Abort' and then 'Null'; 'MAP_CANCEL_VCSG_LOCATION_cnf' leading to 'Check Confirmation'; and 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req'. The 'Check Confirmation' state has three outcomes: 'Provider Error, Data Error' leading to 'Set negative response: System failure' and then 'Cancel VCSG Location negative response'; 'OK' leading to 'Cancel VCSG Location ack'; and 'User Error' leading to 'Set negative response' and then 'Cancel VCSG Location negative response'.](e43b059d4c242c9ff54eb0d7faf4eca5_img.jpg) + +``` + +graph TD + Start(( )) --> Null1[Null] + Null1 --> CancelLoc[Cancel VCSG Location] + CancelLoc --> InMsg{ } + InMsg --- InMsgText["MAP_OPEN_req +MAP_CANCEL_VCSG_LOCATION_req +MAP_DELIMITER_req"] + InMsg --> RecOpenCnf[Receive_Open_Cnf] + RecOpenCnf -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null2[Null] + RecOpenCnf -- OK --> WaitVLR[Wait_For_VLR_Response] + WaitVLR --> MAP_P_ABORT_ind{MAP_P_ABORT_ind} + WaitVLR --> MAP_CANCEL_VCSG_cnf{MAP_CANCEL_VCSG_LOCATION_cnf} + WaitVLR --> MAP_NOTICE_ind{MAP_NOTICE_ind} + MAP_P_ABORT_ind --> Abort[Abort] + Abort --> Null3[Null] + MAP_CANCEL_VCSG_cnf --> CheckConf[Check Confirmation] + CheckConf -- "Provider Error, Data Error" --> SetNegSys[Set negative response: System failure] + SetNegSys --> NegResp1[Cancel VCSG Location negative response] + CheckConf -- OK --> Ack[Cancel VCSG Location ack] + CheckConf -- User Error --> SetNegUser[Set negative response] + SetNegUser --> NegResp2[Cancel VCSG Location negative response] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + +``` + +Flowchart for process Cancel\_VCSG\_Location\_CSS. It starts with an initial state leading to 'Null', then 'Cancel VCSG Location'. A decision diamond shows incoming signals: MAP\_OPEN\_req, MAP\_CANCEL\_VCSG\_LOCATION\_req, and MAP\_DELIMITER\_req. It then goes to 'Receive\_Open\_Cnf'. From there, a 'Vr' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait\_For\_VLR\_Response'. From this wait state, three options are available: 'MAP\_P\_ABORT\_ind' leading to 'Abort' and then 'Null'; 'MAP\_CANCEL\_VCSG\_LOCATION\_cnf' leading to 'Check Confirmation'; and 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req'. The 'Check Confirmation' state has three outcomes: 'Provider Error, Data Error' leading to 'Set negative response: System failure' and then 'Cancel VCSG Location negative response'; 'OK' leading to 'Cancel VCSG Location ack'; and 'User Error' leading to 'Set negative response' and then 'Cancel VCSG Location negative response'. + +1252 +1253 + +**Figure 19.1.2A/2: Process Cancel\_VCSG\_Location\_CSS** + +![Flowchart for process Cancel_VCSG_Location_VLR. It starts with an initial node, followed by 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'Vr' leading to 'Perfor MAP Vr dialogue' -> 'Null'; 'OK' leading to 'Wait_For_Service_Primitive' -> 'Cancel VCSG Location' -> 'Wait_For_Application_Response'; and 'Error' leading to 'Null'. 'Wait_For_Application_Response' branches into 'Cancel VCSG Location ack' -> 'Set Result' and 'Cancel VCSG Location negative response' -> 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP_CANCEL_LOCATION_rsp MAP_CLOSE_req' -> 'Null'. There are also intermediate signals: 'MAP NOTICE_in' -> 'MAP CLOSE_req' -> 'Null' from the 'Vr' path; 'MAP_CANCEL_VCSG_LOCATION_ind' from the 'OK' path; and 'MAP_P_ABORT_in' -> 'Null' from the 'Error' path.](e114d1c9df1ab13459f56ec96de1c1b4_img.jpg) + +**process Cancel\_VCSG\_Location\_VLR** **CVL\_VLR1(1)** + +Process in the VLR to handle a Cancel VCSG Location request + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- Vr --> Perfor[Perfor MAP Vr dialogue] + Perfor --> Null2([Null]) + Receive_Open_Ind -- OK --> Wait_Service[Wait_For_Service_Primitive] + Wait_Service --> Cancel_VCSG[Cancel VCSG Location] + Cancel_VCSG --> Wait_App[Wait_For_Application_Response] + Wait_App --> Ack[Cancel VCSG Location ack] + Wait_App --> Neg[Cancel VCSG Location negative response] + Ack --> Set_Result[Set Result] + Neg --> Set_User_Error[Set User Error] + Set_Result --> Merge(( )) + Set_User_Error --> Merge + Merge --> MAP_Rsp[MAP_CANCEL_LOCATION_rsp +MAP_CLOSE_req] + MAP_Rsp --> Null3([Null]) + Receive_Open_Ind -- Error --> Null4([Null]) + Null4 --> MAP_P_ABORT[MAP_P_ABORT_in] + MAP_P_ABORT --> Null5([Null]) + Perfor --> MAP_NOTICE[MAP NOTICE_in] + MAP_NOTICE --> MAP_CLOSE[MAP CLOSE_req] + MAP_CLOSE --> Null6([Null]) + Wait_Service --> MAP_CANCEL_IND[MAP_CANCEL_VCSG_LOCATION_ind] + +``` + +Flowchart for process Cancel\_VCSG\_Location\_VLR. It starts with an initial node, followed by 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'Vr' leading to 'Perfor MAP Vr dialogue' -> 'Null'; 'OK' leading to 'Wait\_For\_Service\_Primitive' -> 'Cancel VCSG Location' -> 'Wait\_For\_Application\_Response'; and 'Error' leading to 'Null'. 'Wait\_For\_Application\_Response' branches into 'Cancel VCSG Location ack' -> 'Set Result' and 'Cancel VCSG Location negative response' -> 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP\_CANCEL\_LOCATION\_rsp MAP\_CLOSE\_req' -> 'Null'. There are also intermediate signals: 'MAP NOTICE\_in' -> 'MAP CLOSE\_req' -> 'Null' from the 'Vr' path; 'MAP\_CANCEL\_VCSG\_LOCATION\_ind' from the 'OK' path; and 'MAP\_P\_ABORT\_in' -> 'Null' from the 'Error' path. + +1254 + +1255 + +**Figure 19.1.2A/3: Process Cancel\_VCSG\_Location\_VLR** + +![Flowchart for process Cancel_VCSG_Location_SGSN. It starts with an initial node leading to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait_For_Service_Primitive' leads to a junction. From the junction, three paths emerge: 'MAP_NOTICE_in' leading to 'MAP_CLOSE_req' then 'Null'; 'MAP_CANCEL_VCSG_LOCATION_ind' leading to 'Check_Indication'; and 'MAP_P_ABORT_in' leading to 'Null'. 'Check_Indication' leads to a decision 'Subscriber registered?'. If 'Yes', it leads to 'Delete the CSS Record and CSG Subscription data', which then leads to a junction. If 'No', it also leads to this junction. From this junction, an 'Error' path leads to another junction, and an 'OK' path leads to a junction with 'MAP_CANCEL_VCSG_LOCATION_rsp' and 'MAP_CLOSE_req'. All three junctions lead to the final 'Null' node.](ca9c21b01f6bef8651e2f6d0c4d2e882_img.jpg) + +**process Cancel\_VCSG\_Location\_SGSN** **CVL\_SGSN1(1)** + +Process in the SGSN to handle a Cancel VCSG Location request + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- OK --> Wait_For_Service_Primitive([Wait_For_Service_Primitive]) + Receive_Open_Ind -- "Vr, Error" --> Null2([Null]) + Wait_For_Service_Primitive --> Junction1(( )) + Junction1 -- "MAP_NOTICE_in" --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Null3([Null]) + Junction1 -- "MAP_CANCEL_VCSG_LOCATION_ind" --> Check_Indication[Check_Indication] + Junction1 -- "MAP_P_ABORT_in" --> Null4([Null]) + Check_Indication --> Subscriber_registered{Subscriber registered?} + Subscriber_registered -- Yes --> Delete_CSS[Delete the CSS Record and CSG Subscription data] + Subscriber_registered -- No --> Junction2(( )) + Delete_CSS --> Junction2 + Junction2 -- Error --> Junction3(( )) + Junction2 -- OK --> Junction4(( )) + Junction4 -- "MAP_CANCEL_VCSG_LOCATION_rsp" --> MAP_CANCEL_VCSG_LOCATION_rsp[MAP_CANCEL_VCSG_LOCATION_rsp] + Junction4 -- "MAP_CLOSE_req" --> MAP_CLOSE_req2[MAP_CLOSE_req] + Junction3 --> Null5([Null]) + Junction4 --> Null5 + +``` + +Flowchart for process Cancel\_VCSG\_Location\_SGSN. It starts with an initial node leading to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait\_For\_Service\_Primitive' leads to a junction. From the junction, three paths emerge: 'MAP\_NOTICE\_in' leading to 'MAP\_CLOSE\_req' then 'Null'; 'MAP\_CANCEL\_VCSG\_LOCATION\_ind' leading to 'Check\_Indication'; and 'MAP\_P\_ABORT\_in' leading to 'Null'. 'Check\_Indication' leads to a decision 'Subscriber registered?'. If 'Yes', it leads to 'Delete the CSS Record and CSG Subscription data', which then leads to a junction. If 'No', it also leads to this junction. From this junction, an 'Error' path leads to another junction, and an 'OK' path leads to a junction with 'MAP\_CANCEL\_VCSG\_LOCATION\_rsp' and 'MAP\_CLOSE\_req'. All three junctions lead to the final 'Null' node. + +1256 + +1257 + +**Figure 19.1.2A/4: Process Cancel\_VCSG\_Location\_SGSN** + +1258 + +1259 **19.1.3 Void** + +1260 **19.1.4 MS Purging** + +1261 **19.1.4.1 General** + +1262 O&M procedures in the VLR or SGSN can trigger MS purging either because of administrative action or because the +1263 MS has been inactive for an extended period. The O&M process in the VLR or in the SGSN should ensure that during +1264 the MS purging procedure any other attempt to access the MS record is blocked, to maintain consistency of data. + +1265 The message flow for a VLR to report MS purging to the HLR is shown in figure 19.1.4/1. + +1266 The message flow for an SGSN to report MS purging to the HLR is shown in figure 19.1.4/2. + +![Sequence diagram for VLR to HLR MS purging. The VLR sends a message (1) to the HLR, and the HLR responds with a message (2) back to the VLR.](22f129958642affe06cd9285c2a16dde_img.jpg) + +``` +sequenceDiagram + participant VLR + participant HLR + Note right of HLR: 1 + VLR->>HLR: + Note left of VLR: 2 + HLR->>VLR: +``` + +Sequence diagram for VLR to HLR MS purging. The VLR sends a message (1) to the HLR, and the HLR responds with a message (2) back to the VLR. + +1267 + +1268 + +- 1269 1) MAP\_PURGE\_MS\_req/ind +- 1270 2) MAP\_PURGE\_MS\_rsp/cnf + +1271 + +1272 + +**Figure 19.1.4/1: Message flow for MS purging (non-GPRS)** + +1273 + +![Sequence diagram for SGSN to HLR MS purging. The SGSN sends a message (1) to the HLR, and the HLR responds with a message (2) back to the SGSN.](118206423180cf0f363dbd0ddbdd569e_img.jpg) + +``` +sequenceDiagram + participant SGSN + participant HLR + Note right of HLR: 1 + SGSN->>HLR: + Note left of SGSN: 2 + HLR->>SGSN: +``` + +Sequence diagram for SGSN to HLR MS purging. The SGSN sends a message (1) to the HLR, and the HLR responds with a message (2) back to the SGSN. + +1274 + +1275 + +- 1276 1) MAP\_PURGE\_MS\_req/ind +- 1277 2) MAP\_PURGE\_MS\_rsp/cnf + +1278 + +1279 + +**Figure 19.1.4/2: Message flow for MS purging (GPRS)** + +1280 **19.1.4.2 Procedure in the VLR** + +1281 The MAP process in the VLR to report MS purging to the HLR is shown in figure 19.1.4/3. The MAP process invokes +1282 macros not defined in this clause; the definitions of these macros can be found as follows: + +- 1283 Receive\_Open\_Cnf see clause 25.1.2; +- 1284 Check\_Confirmation see clause 25.2.2. + +1285 **19.1.4.3 Procedure in the SGSN** + +1286 The MAP process in the SGSN to report MS purging to the HLR is shown in figure 19.1.4/4. The MAP process invokes +1287 macros not defined in this clause; the definitions of these macros can be found as follows: + +- 1288 Receive\_Open\_Cnf see clause 25.1.2; +- 1289 Check\_Confirmation see clause 25.2.2. + +1290 Sheet 1: The procedure Purge\_MS\_In\_Serving\_Network\_Entity is specific to Super-Charger; it is specified in 3GPP +1291 TS 23.116 [110]. If the HLR does not support the Super-Charger functionality, processing continues from the "No" exit +1292 of the test "Result=Pass?". + +#### 1293 19.1.4.4 Procedure in the HLR + +1294 The MAP process in the HLR to handle a notification from a VLR or an SGSN that an MS record has been purged is +1295 shown in figure 19.1.4/5. The MAP process invokes macros not defined in this clause; the definitions of these macros +1296 can be found as follows: + +1297     Receive\_Open\_Ind     see clause 25.1.1; + +1298     Check\_Indication     see clause 25.2.1. + +1299 If the notification was received from a VLR, the MAP process communicates with the location management application +1300 process specified in 3GPP TS 23.012 [23]; if the notification was received from an SGSN, the MAP process +1301 communicates with the GPRS mobility management application process specified in 3GPP TS 23.060 [104]. + +1302 + +![Flowchart for process Purge_MS_VLR. The process starts with an oval, followed by a 'Null' oval, then a 'Purge MS' process block. It then enters a loop: a merge node receives 'MAP_OPEN_req', 'MAP_PURGE_MS_req', and 'MAP_DELIMITER_req'; followed by 'Receive_Open_Cnf'. A decision node branches on 'Vr' (left) to 'Perform MAP Vr dialogue' and 'Null', and on 'OK' (right) to 'Wait_For_HLR_Response'. From 'Wait_For_HLR_Response', three paths emerge: 'MAP_PURGE_MS_cnf' leads to 'Check_Confirmation', which branches on 'OK' (left) to 'Purge MS ack' and 'Null', 'User Error' (middle) to 'Set negative response' and then 'Purge MS negative response' and 'Null', and 'Provider Error, Data Error' (right) to 'Set negative response: System failure' and then 'Purge MS negative response' and 'Null'; 'MAP_P_ABORT_ind' and 'MAP_NOTICE_ind' both lead to 'MAP_CLOSE_req', which then leads to a 'Set negative response: System failure' block and 'Purge MS negative response' and 'Null'; an 'Error' path from the decision node also leads to 'Set negative response: System failure' and 'Purge MS negative response' and 'Null'.](a168167bf5e95524ddc74df99b4a977f_img.jpg) + +**process Purge\_MS\_VLR** **PMS\_VLR1(1)** + +Process in the VLR to report purging to the HLR + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> PurgeMS[Purge MS] + PurgeMS --> Merge{ } + Merge -- "MAP_OPEN_req +MAP_PURGE_MS_req +MAP_DELIMITER_req" --> RecvCnf[Receive_Open_Cnf] + RecvCnf --> Decision{ } + Decision -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null2([Null]) + Decision -- OK --> WaitForHLR[Wait_For_HLR_Response] + WaitForHLR --> MapPurgeCnf[MAP_PURGE_MS_cnf] + MapPurgeCnf --> CheckConfirm[Check_Confirmation] + CheckConfirm -- OK --> PurgeMSAck{Purge MS ack} + PurgeMSAck --> Null3([Null]) + CheckConfirm -- User Error --> SetNegResp[Set negative response] + SetNegResp --> PurgeMSNegResp1{Purge MS negative response} + PurgeMSNegResp1 --> Null4([Null]) + CheckConfirm -- "Provider Error, +Data Error" --> SetNegRespSysFail1[Set negative response: System failure] + SetNegRespSysFail1 --> PurgeMSNegResp2{Purge MS negative response} + PurgeMSNegResp2 --> Null5([Null]) + WaitForHLR --> MapPAbortInd[MAP_P_ABORT_ind] + MapPAbortInd --> MapCloseReq[MAP_CLOSE_req] + MapCloseReq --> SetNegRespSysFail2[Set negative response: System failure] + SetNegRespSysFail2 --> PurgeMSNegResp3{Purge MS negative response} + PurgeMSNegResp3 --> Null6([Null]) + WaitForHLR --> MapNoticeInd[MAP_NOTICE_ind] + MapNoticeInd --> MapCloseReq + Decision -- Error --> SetNegRespSysFail3[Set negative response: System failure] + SetNegRespSysFail3 --> PurgeMSNegResp4{Purge MS negative response} + PurgeMSNegResp4 --> Null7([Null]) + +``` + +Flowchart for process Purge\_MS\_VLR. The process starts with an oval, followed by a 'Null' oval, then a 'Purge MS' process block. It then enters a loop: a merge node receives 'MAP\_OPEN\_req', 'MAP\_PURGE\_MS\_req', and 'MAP\_DELIMITER\_req'; followed by 'Receive\_Open\_Cnf'. A decision node branches on 'Vr' (left) to 'Perform MAP Vr dialogue' and 'Null', and on 'OK' (right) to 'Wait\_For\_HLR\_Response'. From 'Wait\_For\_HLR\_Response', three paths emerge: 'MAP\_PURGE\_MS\_cnf' leads to 'Check\_Confirmation', which branches on 'OK' (left) to 'Purge MS ack' and 'Null', 'User Error' (middle) to 'Set negative response' and then 'Purge MS negative response' and 'Null', and 'Provider Error, Data Error' (right) to 'Set negative response: System failure' and then 'Purge MS negative response' and 'Null'; 'MAP\_P\_ABORT\_ind' and 'MAP\_NOTICE\_ind' both lead to 'MAP\_CLOSE\_req', which then leads to a 'Set negative response: System failure' block and 'Purge MS negative response' and 'Null'; an 'Error' path from the decision node also leads to 'Set negative response: System failure' and 'Purge MS negative response' and 'Null'. + +1303 + +1304 + +Figure 19.1.4/3: Process Purge\_MS\_VLR + +![Flowchart for process Purge_MS_SGSN. The process starts with 'Null', followed by 'OM_PURGE_MS_ind'. It then calls 'Purge_MS_In_Serving_Network_Entity' (referencing 3GPP TS 23.116). A decision 'Result=Pass?' follows. If 'Yes', it goes to connector '1'. If 'No', it sends 'MAP_OPEN_req', 'MAP_PURGE_MS_req', and 'MAP_DELIMITER_req', then 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', an 'OK' path leads to 'Wait_For_HLR_Response', while a 'Vr. Error' path leads to 'Set User Error: System failure'. From 'Wait_For_HLR_Response', 'MAP_NOTICE_ind' and 'MAP_P_ABORT_ind' are received. Both lead to 'MAP_CLOSE_req', which then leads to 'Set User Error: System failure'. Finally, 'OM_PURGE_MS_rsp' is sent, and the process ends at 'Null'.](7ad4b768587dcc590d8228b2ee3c8e64_img.jpg) + +process Purge\_MS\_SGSN PMS\_SGSN1(2) + +Process in the SGSN to report purging to the HLR + +Signals to/from the left are to/from the O&M application in the SGSN; signals to/from the right are to/from the HLR + +``` + +graph TD + Start([Null]) --> OM_PURGE_MS_ind{OM_PURGE_MS_ind} + OM_PURGE_MS_ind --> Purge_MS_In_Serving_Network_Entity[Purge_MS_In_Serving_Network_Entity] + Purge_MS_In_Serving_Network_Entity -.-> Note1[See3GPP TS 23.116] + Purge_MS_In_Serving_Network_Entity --> Result_Pass{Result=Pass?} + Result_Pass -- Yes --> Connector1((1)) + Result_Pass -- No --> MAP_OPEN_req[MAP_OPEN_req +MAP_PURGE_MS_req +MAP_DELIMITER_req] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- OK --> Wait_For_HLR_Response[Wait_For_HLR_Response] + Receive_Open_Cnf -- Vr. Error --> Set_User_Error[Set User Error: +System failure] + Wait_For_HLR_Response --> MAP_NOTICE_ind{MAP_NOTICE_ind} + Wait_For_HLR_Response --> MAP_P_ABORT_ind{MAP_P_ABORT_ind} + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_P_ABORT_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_User_Error + Set_User_Error --> OM_PURGE_MS_rsp{OM_PURGE_MS_rsp} + OM_PURGE_MS_rsp --> End([Null]) + +``` + +Flowchart for process Purge\_MS\_SGSN. The process starts with 'Null', followed by 'OM\_PURGE\_MS\_ind'. It then calls 'Purge\_MS\_In\_Serving\_Network\_Entity' (referencing 3GPP TS 23.116). A decision 'Result=Pass?' follows. If 'Yes', it goes to connector '1'. If 'No', it sends 'MAP\_OPEN\_req', 'MAP\_PURGE\_MS\_req', and 'MAP\_DELIMITER\_req', then 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', an 'OK' path leads to 'Wait\_For\_HLR\_Response', while a 'Vr. Error' path leads to 'Set User Error: System failure'. From 'Wait\_For\_HLR\_Response', 'MAP\_NOTICE\_ind' and 'MAP\_P\_ABORT\_ind' are received. Both lead to 'MAP\_CLOSE\_req', which then leads to 'Set User Error: System failure'. Finally, 'OM\_PURGE\_MS\_rsp' is sent, and the process ends at 'Null'. + +1305 + +1306 + +Figure 19.1.4/4 (sheet 1 of 2): Process Purge\_MS\_SGSN + +![Flowchart for process Purge_MS_SGSN. It starts with 'Wait_For_HLR_Response', followed by 'MAP_PURGE_MS_cnf', 'Check_Confirmation', 'Delete subscriber data', 'Freeze P-TMSI?', 'Set Result', 'OM_PURGE_MS_rsp', and 'Null'. Error paths lead to 'Set User Error' or 'Set User Error: System failure'.](f134541214bf186a785a96cfd8b7325b_img.jpg) + +process Purge\_MS\_SGSN PMS\_SGSN2(2) + +Process in the SGSN to report purging to the HLR + +Signals to/from the left are to/from the O&M application in the SGSN; signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Wait_For_HLR_Response]) --> MAP{MAP_PURGE_MS_cnf} + MAP --> Check[Check_Confirmation] + Check --> OK((1)) + OK --> Delete[Delete subscriber data] + Check --> UserError[Set User Error] + Check --> SystemFailure[Set User Error: System failure] + Delete --> Freeze{Freeze P-TMSI?} + Freeze -- No --> SetResult[Set Result] + Freeze -- Yes --> FreezeP[Freeze P-TMSI] + FreezeP --> SetResult + SetResult --> OM{OM_PURGE_MS_rsp} + OM --> Null([Null]) + +``` + +Flowchart for process Purge\_MS\_SGSN. It starts with 'Wait\_For\_HLR\_Response', followed by 'MAP\_PURGE\_MS\_cnf', 'Check\_Confirmation', 'Delete subscriber data', 'Freeze P-TMSI?', 'Set Result', 'OM\_PURGE\_MS\_rsp', and 'Null'. Error paths lead to 'Set User Error' or 'Set User Error: System failure'. + +1307 + +1308 + +Figure 19.1.4/4 (sheet 2 of 2): Process Purge\_MS\_SGSN + +![Flowchart for process Purge_MS_HLR. It starts with an initial state leading to 'Null', then 'Receive Open_Ind'. From 'Receive Open_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait_For_Service_Primitive'; and 'V1, Error' leading to 'Null'. From 'Wait_For_Service_Primitive', three paths emerge: 'MAP_P_ABORT_ind' leading to 'Null'; 'MAP_PURGE_MS_ind' leading to 'Purge MS' then 'Wait_For_Application_Response'; and 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' then 'Null'. From 'Wait_For_Application_Response', two paths emerge: 'Purge MS ack' leading to 'Set Result'; and 'Purge MS negative response' leading to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP_PURGE_MS_rsp / MAP_CLOSE_req' and finally 'Null'.](75f5e8a70ce294160298220122ac295b_img.jpg) + +**process Purge\_MS\_HLR** **PMS\_HLR1(1)** + +Process in the HLR to handle a notification from the VLR or the SGSN that an MS has been purged + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the location management application process in the HLR (see 3GPP TS 23.012) or the GPRS location management application process in the HLR (see 3GPP TS 23.060) + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null2([Null]) + RecOpen -- OK --> WaitService[Wait_For_Service_Primitive] + RecOpen -- "V1, Error" --> Null3([Null]) + WaitService -- "MAP_P_ABORT_ind" --> Null4([Null]) + WaitService -- "MAP_PURGE_MS_ind" --> PurgeMS[Purge MS] + PurgeMS --> WaitApp[Wait_For_Application_Response] + WaitService -- "MAP_NOTICE_ind" --> MAPCloseReq{MAP_CLOSE_req} + MAPCloseReq --> Null5([Null]) + WaitApp -- "Purge MS ack" --> SetResult[Set Result] + WaitApp -- "Purge MS negative response" --> SetUserError[Set User Error] + SetResult --> Merge(( )) + SetUserError --> Merge + Merge -- "MAP_PURGE_MS_rsp / MAP_CLOSE_req" --> Null6([Null]) + +``` + +Flowchart for process Purge\_MS\_HLR. It starts with an initial state leading to 'Null', then 'Receive Open\_Ind'. From 'Receive Open\_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait\_For\_Service\_Primitive'; and 'V1, Error' leading to 'Null'. From 'Wait\_For\_Service\_Primitive', three paths emerge: 'MAP\_P\_ABORT\_ind' leading to 'Null'; 'MAP\_PURGE\_MS\_ind' leading to 'Purge MS' then 'Wait\_For\_Application\_Response'; and 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' then 'Null'. From 'Wait\_For\_Application\_Response', two paths emerge: 'Purge MS ack' leading to 'Set Result'; and 'Purge MS negative response' leading to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP\_PURGE\_MS\_rsp / MAP\_CLOSE\_req' and finally 'Null'. + +1309 + +1310 + +Figure 19.1.4/5: Process Purge\_MS\_HLR + +1311 **19.2 Handover procedures** + +1312 **19.2.1 General** + +1313 In this clause, the term "Inter- MSC handover" is used to denote handover or relocation between different MSCs. + +1314 The interfaces involved for Inter- MSC handover are shown in figure 19.2/1. There are two Inter- MSC handover +1315 procedures: + +1316 1) Basic Inter- MSC handover: + +1317 The call is handed over from the controlling MSC(MSC—A) to another MSC(MSC—B) (figure 19.2/1a). + +1318 Figure 19.2/2 shows the message flow for a successful handover from MSC-A to MSC—B, including a +1319 request for handover number allocation from MSC-B to VLR-B. + +1320 2) Subsequent Inter- MSC handover: + +1321 After the call has been handed over from MSC-A to MSC-B, a further handover either to MSC-A +1322 (figure 19.2/1a) or to a third MSC (MSC-B') (figure 19.2/1b) may be necessary in order to continue the call. + +1323 Figure 19.2/3 shows the message flow for a successful subsequent handover to MSC-B'. For a successful +1324 subsequent handover to MSC-A, the messages to and from MSC-B' and VLR-B' are omitted.. + +![Diagram showing the interface structure for basic handover procedure MSC-A to MSC-B. It consists of three boxes: MSC-A, MSC-B, and VLR-B. MSC-A is connected to MSC-B via an interface labeled 'E'. MSC-B is connected to VLR-B via an interface labeled 'B'.](9cf7132bdaf0943fa5595c89731c8ac0_img.jpg) + +1325 + +Diagram showing the interface structure for basic handover procedure MSC-A to MSC-B. It consists of three boxes: MSC-A, MSC-B, and VLR-B. MSC-A is connected to MSC-B via an interface labeled 'E'. MSC-B is connected to VLR-B via an interface labeled 'B'. + +1326 **a) Basic handover procedure MSC-A to MSC-B** +1327 **and subsequent handover procedure MSC-B to MSC-A.** + +![Diagram showing the interface structure for subsequent handover procedure MSC-B to MSC-B'. It consists of three boxes: MSC-A, MSC-B, and VLR-B in the top row, and MSC-B', VLR-B' in the bottom row. MSC-A is connected to MSC-B via interface 'E'. MSC-B is connected to VLR-B via interface 'B'. MSC-A is also connected to MSC-B' via interface 'E'. MSC-B' is connected to VLR-B' via interface 'B'.](44c56e7532e80e9f28c541da8e075d0e_img.jpg) + +1328 + +Diagram showing the interface structure for subsequent handover procedure MSC-B to MSC-B'. It consists of three boxes: MSC-A, MSC-B, and VLR-B in the top row, and MSC-B', VLR-B' in the bottom row. MSC-A is connected to MSC-B via interface 'E'. MSC-B is connected to VLR-B via interface 'B'. MSC-A is also connected to MSC-B' via interface 'E'. MSC-B' is connected to VLR-B' via interface 'B'. + +1329 **b) Subsequent handover procedure MSC-B to MSC-B'.** + +1330 **Figure 19.2/1: Interface structure for handover** + +![Sequence diagram showing a successful basic handover procedure to MSC-B. The diagram involves three lifelines: MSC-A, MSC-B, and VLR-B. The sequence of messages is: 1) MSC-A to MSC-B, 2) MSC-B to VLR-B, 3) VLR-B to MSC-B, 4) MSC-B to MSC-A, 5) MSC-B to VLR-B, 6) VLR-B to MSC-A, 7) MSC-A to MSC-B, 8) MSC-B to MSC-A, 9) MSC-A to MSC-B, 10) MSC-B to MSC-A.](29ec21437e0dff9d3f11718bca722b88_img.jpg) + +``` + +sequenceDiagram + participant MSC-A + participant MSC-B + participant VLR-B + Note left of MSC-A: + MSC-A->>MSC-B: 1) + MSC-B->>VLR-B: 2) + VLR-B->>MSC-B: 3) + MSC-B->>MSC-A: 4) + MSC-B->>VLR-B: 5) + VLR-B->>MSC-A: 6) + MSC-A->>MSC-B: 7) + MSC-B->>MSC-A: 8) + MSC-A->>MSC-B: 9) + MSC-B->>MSC-A: 10) + +``` + +Sequence diagram showing a successful basic handover procedure to MSC-B. The diagram involves three lifelines: MSC-A, MSC-B, and VLR-B. The sequence of messages is: 1) MSC-A to MSC-B, 2) MSC-B to VLR-B, 3) VLR-B to MSC-B, 4) MSC-B to MSC-A, 5) MSC-B to VLR-B, 6) VLR-B to MSC-A, 7) MSC-A to MSC-B, 8) MSC-B to MSC-A, 9) MSC-A to MSC-B, 10) MSC-B to MSC-A. + +1331 + 1332 + 1333 + 1334 + 1335 + 1336 + 1337 + 1338 + 1339 + 1340 + 1341 + 1342 + 1343 + 1344 + 1345 + 1346 + +- 1) MAP\_PREPARE\_HANDOVER\_req/ind +- 2) MAP\_ALLOCATE\_HANDOVER\_NUMBER\_req/ind +- 3) MAP\_SEND\_HANDOVER\_REPORT\_req/ind +- 4) MAP\_PREPARE\_HANDOVER\_rsp/cnf +- 5) MAP\_SEND\_HANDOVER\_REPORT\_rsp/cnf (Note) +- 6) MAP\_PROCESS\_ACCESS\_SIGNALLING\_req/ind +- 7) MAP\_SEND\_END\_SIGNAL\_req/ind +- 8) MAP\_FORWARD\_ACCESS\_SIGNALLING\_req/ind +- 9) MAP\_PROCESS\_ACCESS\_SIGNALLING\_req/ind +- 10) MAP\_SEND\_END\_SIGNAL\_rsp/cnf + +NOTE: This can be sent at any time after the connection between MSC-A and MSC-B is established. + +**Figure 19.2/2: Example of a successful basic handover procedure to MSC-B** + +![Sequence diagram showing a successful subsequent handover to a third MSC. Lifelines: MSC-A, MSC-B, VLR-B, MSC-B', VLR-B'. The sequence of messages is numbered 1 through 17. The process involves preparation, allocation, reporting, and processing of access signalling between the involved entities.](8ff35d11a04be22995ad783fca5d8dbe_img.jpg) + +``` + +sequenceDiagram + participant MSC-A + participant MSC-B + participant VLR-B + participant MSC-B' + participant VLR-B' + + Note left of MSC-A: 1) MAP_PREPARE_HANDOVER_req/ind + MSC-A->>MSC-B: 1) + Note right of MSC-B: 2) MAP_ALLOCATE_HANDOVER_NUMBER_req/ind + MSC-B->>VLR-B: 2) + Note right of VLR-B: 3) MAP_SEND_HANDOVER_REPORT_req/ind + VLR-B->>MSC-B: 3) + Note left of MSC-A: 4) MAP_PREPARE_HANDOVER_rsp/cnf + MSC-B->>MSC-A: 4) + Note right of VLR-B: 5) MAP_SEND_HANDOVER_REPORT_rsp/cnf (Note 1) + VLR-B->>MSC-B: 5) + Note left of MSC-A: 6) MAP_PROCESS_ACCESS_SIGNALLING_req/ind + MSC-A->>MSC-B: 6) + Note left of MSC-A: 7) MAP_SEND_END_SIGNAL_req/ind + MSC-A->>MSC-B: 7) + Note left of MSC-A: 8) MAP_PREPARE_SUBSEQUENT_HANDOVER_req/ind + MSC-A->>MSC-B: 8) + Note right of MSC-B: 9) MAP_PREPARE_HANDOVER_req/ind + MSC-B->>MSC-B': 9) + Note right of MSC-B': 10) MAP_ALLOCATE_HANDOVER_NUMBER_req/ind + MSC-B'->>VLR-B': 10) + Note right of VLR-B': 11) MAP_SEND_HANDOVER_REPORT_req/ind + VLR-B'->>MSC-B': 11) + Note left of MSC-A: 12) MAP_PREPARE_HANDOVER_rsp/cnf + MSC-B'->>MSC-A: 12) + Note right of VLR-B': 13) MAP_SEND_HANDOVER_REPORT_rsp/cnf (Note 2) + VLR-B'->>MSC-B': 13) + Note right of MSC-B': 14) MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp/cnf + MSC-B'->>MSC-B: 14) + Note left of MSC-A: 15) MAP_PROCESS_ACCESS_SIGNALLING_req/ind + MSC-A->>MSC-B: 15) + Note left of MSC-A: 16) MAP_SEND_END_SIGNAL_req/ind + MSC-A->>MSC-B: 16) + Note left of MSC-A: 17) MAP_SEND_END_SIGNAL_rsp/cnf (Note 3) + MSC-B->>MSC-A: 17) + +``` + +Sequence diagram showing a successful subsequent handover to a third MSC. Lifelines: MSC-A, MSC-B, VLR-B, MSC-B', VLR-B'. The sequence of messages is numbered 1 through 17. The process involves preparation, allocation, reporting, and processing of access signalling between the involved entities. + +1347 + +1348 + +- 1349 1) MAP\_PREPARE\_HANDOVER\_req/ind +- 1350 2) MAP\_ALLOCATE\_HANDOVER\_NUMBER\_req/ind +- 1351 3) MAP\_SEND\_HANDOVER\_REPORT\_req/ind +- 1352 4) MAP\_PREPARE\_HANDOVER\_rsp/cnf +- 1353 5) MAP\_SEND\_HANDOVER\_REPORT\_rsp/cnf (Note 1) +- 1354 6) MAP\_PROCESS\_ACCESS\_SIGNALLING\_req/ind +- 1355 7) MAP\_SEND\_END\_SIGNAL\_req/ind +- 1356 8) MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_req/ind +- 1357 9) MAP\_PREPARE\_HANDOVER\_req/ind +- 1358 10) MAP\_ALLOCATE\_HANDOVER\_NUMBER\_req/ind +- 1359 11) MAP\_SEND\_HANDOVER\_REPORT\_req/ind +- 1360 12) MAP\_PREPARE\_HANDOVER\_rsp/cnf +- 1361 13) MAP\_SEND\_HANDOVER\_REPORT\_rsp/cnf (Note 2) +- 1362 14) MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_rsp/cnf +- 1363 15) MAP\_PROCESS\_ACCESS\_SIGNALLING\_req/ind +- 1364 16) MAP\_SEND\_END\_SIGNAL\_req/ind +- 1365 17) MAP\_SEND\_END\_SIGNAL\_rsp/cnf (Note 3) + +1366 + +NOTE 1: This can be sent at any time after the connection between MSC-A and MSC-B is established. + +1367 + +NOTE 2: This can be sent at any time after the connection between MSC-A and MSC-B' is established. + +1368 + +NOTE 3: At this stage, the subsequent handover is complete. Any further interworking between MSC-A and MSC-B' is the same as the interworking between MSC-A and MSC-B after basic handover + +1369 + +1370 + +1371 + +**Figure 19.2/3: Example of a successful subsequent handover to a third MSC** + +1373 The MAP signalling procedures for inter-MSC handover support the allocation of a handover number or one or more +1374 relocation numbers and the transfer of encapsulated BSSAP or RANAP messages. + +1375 The minimum application context version for the MAP handover application context shall be: + +- 1376 - version 3 for inter-MSC UTRAN to UTRAN handover; +- 1377 - version 3 for inter-MSC intersystem handover from GSM BSS to UTRAN; +- 1378 - version 2 for inter-MSC intersystem handover from UTRAN to GSM BSS. + +1379 NOTE: If the MAP handover application context version 2 is used, subsequent handover to UTRAN is not +1380 possible. + +1381 The minimum application context version for the MAP handover application context should be version 2 for inter-MSC +1382 handover from GSM BSS to GSM BSS. + +1383 NOTE: If the MAP handover application context version 2 or lower is used, subsequent handover to UTRAN is +1384 not possible. + +1385 The BSSAP or RANAP messages encapsulated in MAP messages are processed by the Handover Control Application +1386 in each MSC. The information in the encapsulated BSSAP or RANAP messages is passed from the Handover Control +1387 Application to the MAP process at the sending end; the notation used in the SDL diagrams for the MAP processes is +1388 "HO\_CA\_MESSAGE\_ind(Message transfer)". The information in the encapsulated BSSAP or RANAP messages is +1389 passed from the MAP process to the Handover Control Application at the sending end; the notation used in the SDL +1390 diagrams for the MAP processes is "HO\_CA\_MESSAGE\_req(Message transfer)". + +1391 For details of the interworking between the A-interface and MAP procedures or the Iu-interface and MAP procedures, +1392 see 3GPP TS 23.009 [21] and 3GPP TS 29.010 [58]. + +## 1393 19.2.2 Procedure in MSC-A + +1394 This clause describes the inter-MSC handover procedure in MSC-A; it covers basic inter-MSC handover to another +1395 MSC (MSC-B) and subsequent inter-MSC handover to a third MSC (MSC-B') or back to the controlling MSC +1396 (MSC-A). + +1397 The MAP process in MSC-A to handle inter-MSC handover is shown in figure 19.2/4. The MAP process invokes +1398 macros not defined in this clause; the definitions of these macros can be found as follows: + +- 1399 Receive\_Open\_Cnf see clause 25.1.2; +- 1400 Check\_Indication see clause 25.2.1. +- 1401 Check\_Confirmation see clause 25.2.2. + +1402 Communication between the MAP handover process and the Handover Control application is represented by the +1403 HO\_CA\_MESSAGE service. For a detailed description of the interworking between the Handover Control applications +1404 in different MSCs for the inter-MSC handover procedure, see 3GPP TS 23.009 [21]. + +### 1405 19.2.2.1 Basic handover + +1406 The handling in MSC-A for basic inter-MSC handover is shown in sheets 1 to 6 of figure 19.2/4. + +1407 Sheet 1: The MAP\_PREPARE\_HANDOVER request may contain: + +- 1408 - an indication that handover number allocation is not required; +- 1409 - the target Cell ID, for compatibility for handover to GSM; +- 1410 - the target RNC ID, for SRNS relocation or inter-system handover from GSM to UMTS; +- 1411 - the IMSI; +- 1412 - UMTS encryption information and UMTS integrity protection information, which are necessary for inter-system +1413 handover from GSM to UMTS; + +1414 - GSM radio resource information (channel type); + +1415 - the LCLS Global Call Reference; + +1416 - the LCLS-Negotiation; + +1417 - the LCLS-Configuration-Preference. + +1418 The conditions for the presence of these parameters and the processing in MSC-B (3G\_MSC-B) are described in detail +1419 in 3GPP TS 29.010 [58], 3GPP TS 23.009 [21] and 3GPP TS 29.205 [146]. + +1420 Sheet 2: The MAP\_PREPARE\_HANDOVER confirmation contains one of: + +1421 - no handover number, if the MAP\_PREPARE\_HANDOVER request included an indication that handover +1422 number allocation is not required; + +1423 - a handover number; + +1424 - one or more relocation numbers. + +1425 Sheet 2: The MAP\_PREPARE\_HANDOVER confirmation contains BSSAP or RANAP signalling information, which +1426 is passed to the Handover Control application in MSC-A. + +1427 Sheet 2: If the MAP\_PREPARE\_HANDOVER confirmation contains an indication that MSC-B does not support +1428 multiple bearers, the Handover Control application in MSC-A may request handover of one bearer to the same cell in +1429 MSC-B. + +1430 Sheet 5: If the original MAP\_PREPARE\_HANDOVER request included a parameter indicating that handover number +1431 allocation is not required, the Handover Control application in MSC-A may request a handover number (or one or more +1432 relocation numbers); this triggers a further MAP\_PREPARE\_HANDOVER request towards MSC-B. + +### 1433 19.2.2.2 Handling of access signalling + +1434 The Handover Control application in MSC-A may forward access signalling to any of the MS, RNS-B or BSS-B using +1435 the MAP\_FORWARD\_ACCESS\_SIGNALLING service; any of the MS, RNS-B or BSS-B may forward access +1436 signalling to the Handover Control application in MSC-A using the MAP\_PROCESS\_ACCESS\_SIGNALLING +1437 service. These are non-confirmed services. + +### 1438 19.2.2.3 Subsequent handover + +1439 The handling in MSC-A for subsequent inter-MSC handover is shown in sheets 7 & 8 of figure 19.2/4. If the Handover +1440 Control Application determines that the call is to be handed over to a third MSC (MSC-B') it triggers another instance +1441 of the MAP process to handle the basic handover to MSC-B', and reports the result of the subsequent handover to the +1442 instance of the MAP process which handles the dialogue with MSC-B. + +1443 Sheet 8: While the MAP process in MSC-A is waiting for the completion of subsequent handover, it relays access +1444 signalling between the Handover Control application and the MS, RNS-B or BSS-B as described in clause 19.2.2.2. + +## 1445 19.2.3 Procedure in MSC-B + +1446 This clause describes the handover or relocation procedure in MSC-B; it covers basic handover or relocation from the +1447 controlling MSC (MSC-A) and subsequent handover or relocation. + +1448 The MAP process in MSC-B to handle handover or relocation is shown in figure 19.2/5. The MAP process invokes +1449 macros not defined in this clause; the definitions of these macros can be found as follows: + +1450 Receive\_Open\_Ind see clause 25.1.1; + +1451 Receive\_Open\_Cnf see clause 25.1.2; + +1452 Check\_Indication see clause 25.2.1. + +1453 Check\_Confirmation see clause 25.2.2. + +1454 Communication between the MAP handover process and the Handover Control application is represented by the +1455 HO\_CA\_MESSAGE service. For a detailed description of the interworking between the Handover Control applications +1456 in different MSCs for the inter-MSC handover procedure, see 3GPP TS 23.009 [21]. + +1457 The ordering of allocation of handover number and radio resources shown in the SDL diagrams is not mandatory. + +### 1458 19.2.3.1 Basic handover + +1459 The handling in MSC-B for basic inter-MSC handover is shown in sheets 1 to 7 of figure 19.2/5. + +1460 Sheet 2: If the MAP\_PREPARE\_HANDOVER indication included a parameter requesting multiple bearers but MSC-B +1461 does not support multiple bearers, MSC-B sends a MAP\_PREPARE\_HANDOVER response indicating that multiple +1462 bearers are not supported, and waits for a possible MAP\_PREPARE\_HANDOVER indication requesting handover of a +1463 single bearer. + +1464 Sheet 6: If the original MAP\_PREPARE\_HANDOVER indication included a parameter indicating that handover +1465 number allocation is not required, MSC-A may send a further MAP\_PREPARE\_HANDOVER request to request the +1466 allocation of a handover number (or one or more relocation numbers). + +### 1467 19.2.3.2 Handling of access signalling + +1468 The Handover Control application in MSC-A may forward access signalling to any of the MS, RNS-B or BSS-B using +1469 the MAP\_FORWARD\_ACCESS\_SIGNALLING service; any of the MS, RNS-B or BSS-B may forward access +1470 signalling to the Handover Control application in MSC-A using the MAP\_PROCESS\_ACCESS\_SIGNALLING +1471 service. These are non-confirmed services. Signals to or from any of the MS, RNS-B or BSS-B are routed through the +1472 Handover Control application in MSC-B. + +### 1473 19.2.3.3 Subsequent handover + +1474 The handling in MSC-B for subsequent inter-MSC handover is shown in sheet 8 of figure 19.2/5. + +1475 While the MAP process in MSC-B is waiting for the completion of subsequent handover, it relays access signalling +1476 between MSC-A and the MS, RNS-B or BSS-B through the Handover Control application as described in clause +1477 19.2.3.2. + +## 1478 19.2.4 Macro Receive\_Error\_From\_HO\_CA + +1479 This macro is used by the handover processes in MSC-A and MSC-B to receive errors from the Handover Control +1480 Application at any state of a handover process. + +## 1481 19.2.5 Procedure in VLR-B + +1482 The process in VLR-B to handle a request for a handover number is shown in figure 19.2/7. The process invokes +1483 macros not defined in this clause; the definitions of these macros can be found as follows: + +1484     Receive\_Open\_Ind       see clause 25.1.1; + +1485     Check\_Indication       see clause 25.2.1. + +![State transition diagram for process HO_MSC_A. The process starts at an initial state, goes to 'Null', then receives an 'HO_CA_MESSAGE_ind (Handover Request)'. It then sends 'MAP_OPEN_req', 'MAP_PREPARE_HANDOVER_req', and 'MAP_DELIMITER_req', followed by 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', three paths emerge: 'Error' leads to 'HO_CA_MESSAGE_req (MAP Error)' then 'Null'; 'OK' leads to 'Wait_For_Prepare_Handover_Result'; 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'. From 'Wait_For_Prepare_Handover_Result', four paths emerge: 1) 'HO_CA_MESSAGE_ind (Call Release)' then 'MAP_U_ABORT_req' then 'Null'; 2) 'MAP_CLOSE_ind' then 'HO_CA_MESSAGE_req (Connection Closed)' then 'Null'; 3) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind' and 'MAP_NOTICE_ind' both lead to a common 'HO_CA_MESSAGE_req (MAP Error)' then 'Null'; 4) 'MAP_CLOSE_req' leads to a common 'HO_CA_MESSAGE_req (MAP Error)' then 'Null'.](49130613602e28504e722d05013e2040_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA1(8)** + +Process in MSC-A (the Anchor MSC) to handle inter-MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> HO_CA_MESSAGE_ind1[HO_CA_MESSAGE_ind (Handover Request)] + HO_CA_MESSAGE_ind1 --> MAP_OPEN_req[MAP_OPEN_req +MAP_PREPARE_HANDOVER_req +MAP_DELIMITER_req] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf --> Error[Error] + Receive_Open_Cnf --> OK[OK] + Receive_Open_Cnf --> Vr[Vr] + Error --> HO_CA_MESSAGE_req1[HO_CA_MESSAGE_req (MAP Error)] + HO_CA_MESSAGE_req1 --> Null2[Null] + OK --> Wait_For_Prepare_Handover_Result[Wait_For_Prepare_Handover_Result] + Vr --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null3[Null] + Wait_For_Prepare_Handover_Result --> HO_CA_MESSAGE_ind2[HO_CA_MESSAGE_ind (Call Release)] + Wait_For_Prepare_Handover_Result --> MAP_CLOSE_ind[MAP_CLOSE_ind] + Wait_For_Prepare_Handover_Result --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind] + Wait_For_Prepare_Handover_Result --> MAP_NOTICE_ind[MAP_NOTICE_ind] + HO_CA_MESSAGE_ind2 --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> Null4[Null] + MAP_CLOSE_ind --> HO_CA_MESSAGE_req2[HO_CA_MESSAGE_req (Connection Closed)] + HO_CA_MESSAGE_req2 --> Null5[Null] + MAP_U_ABORT_ind --> HO_CA_MESSAGE_req3[HO_CA_MESSAGE_req (MAP Error)] + MAP_NOTICE_ind --> HO_CA_MESSAGE_req3 + HO_CA_MESSAGE_req3 --> Null6[Null] + MAP_CLOSE_req[MAP_CLOSE_req] --> HO_CA_MESSAGE_req3 + HO_CA_MESSAGE_req3 --> Null6 + +``` + +State transition diagram for process HO\_MSC\_A. The process starts at an initial state, goes to 'Null', then receives an 'HO\_CA\_MESSAGE\_ind (Handover Request)'. It then sends 'MAP\_OPEN\_req', 'MAP\_PREPARE\_HANDOVER\_req', and 'MAP\_DELIMITER\_req', followed by 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', three paths emerge: 'Error' leads to 'HO\_CA\_MESSAGE\_req (MAP Error)' then 'Null'; 'OK' leads to 'Wait\_For\_Prepare\_Handover\_Result'; 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'. From 'Wait\_For\_Prepare\_Handover\_Result', four paths emerge: 1) 'HO\_CA\_MESSAGE\_ind (Call Release)' then 'MAP\_U\_ABORT\_req' then 'Null'; 2) 'MAP\_CLOSE\_ind' then 'HO\_CA\_MESSAGE\_req (Connection Closed)' then 'Null'; 3) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind' and 'MAP\_NOTICE\_ind' both lead to a common 'HO\_CA\_MESSAGE\_req (MAP Error)' then 'Null'; 4) 'MAP\_CLOSE\_req' leads to a common 'HO\_CA\_MESSAGE\_req (MAP Error)' then 'Null'. + +1486 + +1487 + +Figure 19.2/4 (sheet 1 of 8): Process HO\_MSC\_A + +![State transition diagram for process Handover_MSC_A. The process starts in 'Wait_For_Prepare_Handover_Result' state, transitions to 'MAP_PREPARE_HANDOVER_cnf' message, then to 'Check_Confirmation' state. From 'Check_Confirmation', three paths emerge: 'OK' leads to an unlabeled state then to 'HO_CA_MESSAGE_req (Prepare Handover Result)' message; 'Provider Error' leads directly to another unlabeled state then to 'HO_CA_MESSAGE_req (MAP Error)' message; 'User Error, Data Error' leads to 'MAP_U_ABORT_req' message. Both 'HO_CA_MESSAGE_req' messages lead to a decision diamond 'Multiple bearer not supported indication received?'. If 'No', it leads to 'Wait_For_HO_Completion_On_MSC_B' state, then to 'Receive_Error_From_HO_CA' state, which then leads to either 'Wait_For_HO_Completion_On_MSC_B' state (Error) or 'Null' state. If 'Yes', it leads to 'Wait_For_Resend' state, which then leads to an unlabeled state. From this state, two paths emerge: one to 'HO_CA_MESSAGE_ind (Handover Request)' message, then to another unlabeled state, then to 'MAP_PREPARE_HANDOVER_req MAP_DELIMITER_req' message, then to 'Wait_For_Prepare_Handover_Result' state; the other to 'HO_CA_MESSAGE_ind (Error)' message, then to 'MAP_U_ABORT_req' message, then to 'Null' state.](3d3c6241ebe0653d7cf2f2e4524e5f84_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA2(8)** + +Process in MSC-A (the Anchor MSC) to handle inter- MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + +stateDiagram-v2 + [*] --> Wait_For_Prepare_Handover_Result + Wait_For_Prepare_Handover_Result --> MAP_PREPARE_HANDOVER_cnf + MAP_PREPARE_HANDOVER_cnf --> Check_Confirmation + Check_Confirmation --> OK + Check_Confirmation --> Provider_Error: Provider Error + Check_Confirmation --> User_Error_Data_Error: User Error, Data Error + OK --> State_1 + State_1 --> HO_CA_MESSAGE_req_1: HO_CA_MESSAGE_req (Prepare Handover Result) + Provider_Error --> State_2 + State_2 --> HO_CA_MESSAGE_req_2: HO_CA_MESSAGE_req (MAP Error) + User_Error_Data_Error --> MAP_U_ABORT_req_1: MAP_U_ABORT_req + HO_CA_MESSAGE_req_1 --> Decision + HO_CA_MESSAGE_req_2 --> Null_1: Null + MAP_U_ABORT_req_1 --> Null_1 + Decision --> No + Decision --> Yes: Multiple bearer not supported indication received? + No --> Wait_For_HO_Completion_On_MSC_B_1: Wait_For_HO_Completion_On_MSC_B + Yes --> Wait_For_Resend + Wait_For_HO_Completion_On_MSC_B_1 --> Receive_Error_From_HO_CA + Receive_Error_From_HO_CA --> Wait_For_HO_Completion_On_MSC_B_2: Wait_For_HO_Completion_On_MSC_B (Error) + Receive_Error_From_HO_CA --> Null_2: Null + Wait_For_Resend --> State_3 + State_3 --> HO_CA_MESSAGE_ind_1: HO_CA_MESSAGE_ind (Handover Request) + State_3 --> HO_CA_MESSAGE_ind_2: HO_CA_MESSAGE_ind (Error) + HO_CA_MESSAGE_ind_1 --> State_4 + State_4 --> MAP_PREPARE_HANDOVER_req_MAP_DELIMITER_req: MAP_PREPARE_HANDOVER_req MAP_DELIMITER_req + MAP_PREPARE_HANDOVER_req_MAP_DELIMITER_req --> Wait_For_Prepare_Handover_Result + HO_CA_MESSAGE_ind_2 --> MAP_U_ABORT_req_2: MAP_U_ABORT_req + MAP_U_ABORT_req_2 --> Null_3: Null + +``` + +State transition diagram for process Handover\_MSC\_A. The process starts in 'Wait\_For\_Prepare\_Handover\_Result' state, transitions to 'MAP\_PREPARE\_HANDOVER\_cnf' message, then to 'Check\_Confirmation' state. From 'Check\_Confirmation', three paths emerge: 'OK' leads to an unlabeled state then to 'HO\_CA\_MESSAGE\_req (Prepare Handover Result)' message; 'Provider Error' leads directly to another unlabeled state then to 'HO\_CA\_MESSAGE\_req (MAP Error)' message; 'User Error, Data Error' leads to 'MAP\_U\_ABORT\_req' message. Both 'HO\_CA\_MESSAGE\_req' messages lead to a decision diamond 'Multiple bearer not supported indication received?'. If 'No', it leads to 'Wait\_For\_HO\_Completion\_On\_MSC\_B' state, then to 'Receive\_Error\_From\_HO\_CA' state, which then leads to either 'Wait\_For\_HO\_Completion\_On\_MSC\_B' state (Error) or 'Null' state. If 'Yes', it leads to 'Wait\_For\_Resend' state, which then leads to an unlabeled state. From this state, two paths emerge: one to 'HO\_CA\_MESSAGE\_ind (Handover Request)' message, then to another unlabeled state, then to 'MAP\_PREPARE\_HANDOVER\_req MAP\_DELIMITER\_req' message, then to 'Wait\_For\_Prepare\_Handover\_Result' state; the other to 'HO\_CA\_MESSAGE\_ind (Error)' message, then to 'MAP\_U\_ABORT\_req' message, then to 'Null' state. + +1488 + +1489 + +Figure 19.2/4 (sheet 2 of 8): Process HO\_MSC\_A + +![SDL state diagram for process HO_MSC_A showing transitions from Wait_For_HO_Completion_On_MSCB and Wait_For_HO_Completion_On_MSC_B states based on various MAP and HO_CA signals.](c13433e749e902dc29bddea7aedd49c7_img.jpg) + +process Handover\_MSC\_A +HO\_MSCA3(8) + +Process in MSC-A (the Anchor MSC) to handle inter-MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + + graph TD + %% Top Section + S1([Wait_For_HO_Completion_On_MSCB]) + + S1 --> I1[/HO_CA_MESSAGE_ind +(Message Transfer)/] + I1 --> O1[MAP_FORWARD_ACCESS_SIGNALLING_req +MAP_DELIMITER_req] + O1 --> S2([Wait_For_HO_Completion_On_MSC_B]) + + S1 --> I2[/MAP_SEND_END_SIGNAL_ind/] + I2 --> D1{Check_Indication} + D1 -- OK --> O2[HO_CA_MESSAGE_req +(Handover Complete)] + O2 --> O3[MS_On_MSCB] + O3 --> N1([Null]) + D1 -- Error --> O4[HO_CA_MESSAGE_req +(MAP Error)] + O4 --> O5[MAP_U_ABORT_req] + O5 --> N2([Null]) + + S1 --> I3[/MAP_PROCESS_ACCESS_SIGNALLING_ind/] + I3 --> D2{Check_Indication} + D2 -- Error --> S3([Wait_For_HO_Completion_On_MSC_B]) + D2 -- OK --> O6[HO_CA_MESSAGE_req +(Message Transfer)] + O6 --> S4([Wait_For_HO_Completion_On_MSC_B]) + + %% Bottom Section + S5([Wait_For_HO_Completion_On_MSC_B]) + + S5 --> I4[/MAP_CLOSE_req/] + I4 --> O7[HO_CA_MESSAGE_req +(Connection Closed)] + O7 --> N3([Null]) + + S5 --> I5[/MAP_U_ABORT_ind, +MAP_P_ABORT_ind/] + I5 --> O8[HO_CA_MESSAGE_req +(MAP Error)] + O8 --> N4([Null]) + + S5 --> I6[/MAP_NOTICE_ind/] + I6 --> O9[HO_CA_MESSAGE_req +(MAP Error)] + O9 --> S6([Wait_For_HO_Completion_On_MSC_B]) + +``` + +SDL state diagram for process HO\_MSC\_A showing transitions from Wait\_For\_HO\_Completion\_On\_MSCB and Wait\_For\_HO\_Completion\_On\_MSC\_B states based on various MAP and HO\_CA signals. + +1490 + +1491 + +**Figure 19.2/4 (sheet 3 of 8): Process HO\_MSC\_A** + +![State transition diagram for process HO_MSC_A. The diagram shows two main state transition paths starting from MS_On_MSC_B. The top path handles incoming HO_CA_MESSAGE_ind, MAP_FORWARD_ACCESS_SIGNALLING_req, and MAP_PROCESS_ACCESS_SIGNALLING_ind. The bottom path handles incoming MAP_CLOSE_req, MAP_U_ABORT_ind/MAP_P_ABORT_ind, and MAP_NOTICE_ind. Most transitions lead to Null or back to MS_On_MSC_B.](f6dc7fdc0c74e067766ad27976d76403_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA4(8)** + +Process in MSC-A (the Anchor MSC) to handle inter-MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + +stateDiagram-v2 + [*] --> MS_On_MSC_B + state "MS_On_MSC_B" as MS_On_MSC_B + state "Null" as Null + + MS_On_MSC_B --> HO_CA_MESSAGE_ind (Message Transfer) + HO_CA_MESSAGE_ind --> MAP_FORWARD_ACCESS_SIGNALLING_req + MAP_FORWARD_ACCESS_SIGNALLING_req --> MS_On_MSC_B + + MS_On_MSC_B --> Receive_Error_From_HO_CA + Receive_Error_From_HO_CA --> MS_On_MSC_B : Error + Receive_Error_From_HO_CA --> Null : Null + Null --> MS_On_MSC_B : Error + Null --> MS_On_MSC_B : OK + + MS_On_MSC_B --> MAP_PROCESS_ACCESS_SIGNALLING_ind + MAP_PROCESS_ACCESS_SIGNALLING_ind --> Check_Indication + Check_Indication --> HO_CA_MESSAGE_req (Message Transfer) + HO_CA_MESSAGE_req --> MS_On_MSC_B + + MS_On_MSC_B --> MAP_CLOSE_req + MAP_CLOSE_req --> HO_CA_MESSAGE_req (Connection Closed) + HO_CA_MESSAGE_req --> Null + + MS_On_MSC_B --> MAP_U_ABORT_ind_MAP_P_ABORT_ind + MAP_U_ABORT_ind_MAP_P_ABORT_ind --> HO_CA_MESSAGE_req (MAP Error) + HO_CA_MESSAGE_req --> Null + + MS_On_MSC_B --> MAP_NOTICE_ind + MAP_NOTICE_ind --> HO_CA_MESSAGE_req (MAP Error) + HO_CA_MESSAGE_req --> MS_On_MSC_B + +``` + +State transition diagram for process HO\_MSC\_A. The diagram shows two main state transition paths starting from MS\_On\_MSC\_B. The top path handles incoming HO\_CA\_MESSAGE\_ind, MAP\_FORWARD\_ACCESS\_SIGNALLING\_req, and MAP\_PROCESS\_ACCESS\_SIGNALLING\_ind. The bottom path handles incoming MAP\_CLOSE\_req, MAP\_U\_ABORT\_ind/MAP\_P\_ABORT\_ind, and MAP\_NOTICE\_ind. Most transitions lead to Null or back to MS\_On\_MSC\_B. + +1492 + +1493 + +Figure 19.2/4 (sheet 4 of 8): Process HO\_MSC\_A + +![Flowchart for process Handover_MSC_A. It starts with MS_On_MSC_B. Two main paths emerge: one for HO_CA_MESSAGE_ind (Call Release) leading to MAP_SEND_END_SIGNAL_rsp and Null; the other for HO_CA_MESSAGE_ind (HO Number Required) leading to MAP_PREPARE_HANDOVER_req, Wait_For_HO_Number_From_MSC_B, MAP_PREPARE_HANDOVER_cnt, and Check_Confirmation. Check_Confirmation leads to OK, User Error/Data Error, or Provider Error. OK leads to a decision 'Handover number received?'. Yes leads to 'Set HO-number: present', No leads to 'Set HO-number: not present'. Both lead to HO_CA_MESSAGE_req (Routing information) and MS_On_MSC_B. User Error/Data Error leads to HO_CA_MESSAGE_req (MAP Error) and MS_On_MSC_B. Provider Error leads to HO_CA_MESSAGE_req (MAP Error) and Null.](2d1c5bc46086b7f59c21275beea4e683_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA5(8)** + +Process in MSC-A (the Anchor MSC) to handle inter-MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + +graph TD + Start([MS_On_MSC_B]) --> In1{{ }} + In1 --> HO_CA_MESSAGE_ind1[HO_CA_MESSAGE_ind +(Call Release)] + In1 --> In2{{ }} + In2 --> HO_CA_MESSAGE_ind2[HO_CA_MESSAGE_ind +(HO Number Required)] + In2 --> MAP_PREPARE_HANDOVER_req[MAP_PREPARE_HANDOVER_req +MAP_DELIMITER_req] + MAP_PREPARE_HANDOVER_req --> Wait_For_HO_Number_From_MSC_B([Wait_For_HO_Number_From_MSC_B]) + Wait_For_HO_Number_From_MSC_B --> MAP_PREPARE_HANDOVER_cnt{{ }} + MAP_PREPARE_HANDOVER_cnt --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> OK{OK} + OK -- Yes --> Handover_number_received{Handover number received?} + OK -- No --> Set_HO_number_not_present[Set HO-number: +not present] + Handover_number_received -- Yes --> Set_HO_number_present[Set HO-number: +present] + Set_HO_number_present --> HO_CA_MESSAGE_req_routing[HO_CA_MESSAGE_req +(Routing information)] + Set_HO_number_not_present --> HO_CA_MESSAGE_req_routing + HO_CA_MESSAGE_req_routing --> MS_On_MSC_B2([MS_On_MSC_B]) + Check_Confirmation -- "User Error, Data Error" --> HO_CA_MESSAGE_req_error1[HO_CA_MESSAGE_req +(MAP Error)] + HO_CA_MESSAGE_req_error1 --> MS_On_MSC_B3([MS_On_MSC_B]) + Check_Confirmation -- "Provider Error" --> HO_CA_MESSAGE_req_error2[HO_CA_MESSAGE_req +(MAP Error)] + HO_CA_MESSAGE_req_error2 --> Null2([Null]) + In1 --> MAP_SEND_END_SIGNAL_rsp[MAP_SEND_END_SIGNAL_rsp +MAP_CLOSE_req] + MAP_SEND_END_SIGNAL_rsp --> Null1([Null]) + +``` + +Flowchart for process Handover\_MSC\_A. It starts with MS\_On\_MSC\_B. Two main paths emerge: one for HO\_CA\_MESSAGE\_ind (Call Release) leading to MAP\_SEND\_END\_SIGNAL\_rsp and Null; the other for HO\_CA\_MESSAGE\_ind (HO Number Required) leading to MAP\_PREPARE\_HANDOVER\_req, Wait\_For\_HO\_Number\_From\_MSC\_B, MAP\_PREPARE\_HANDOVER\_cnt, and Check\_Confirmation. Check\_Confirmation leads to OK, User Error/Data Error, or Provider Error. OK leads to a decision 'Handover number received?'. Yes leads to 'Set HO-number: present', No leads to 'Set HO-number: not present'. Both lead to HO\_CA\_MESSAGE\_req (Routing information) and MS\_On\_MSC\_B. User Error/Data Error leads to HO\_CA\_MESSAGE\_req (MAP Error) and MS\_On\_MSC\_B. Provider Error leads to HO\_CA\_MESSAGE\_req (MAP Error) and Null. + +1494 + +1495 + +Figure 19.2/4 (sheet 5 of 8): Process HO\_MSC\_A + +![State transition diagram for process Handover_MSC_A. The diagram shows three main paths from an initial 'Wait_For_HO_Number_From_MSC_B' state. Path 1: MAP_CLOSE_req leads to HO_CA_MESSAGE_req (Connection Closed) and then to a Null state. Path 2: MAP_U_ABORT_ind, MAP_P_ABORT_ind leads to HO_CA_MESSAGE_req (MAP Error) and then to a Null state. Path 3: MAP_NOTICE_ind leads to HO_CA_MESSAGE_req (MAP Error) and then to another Wait_For_HO_Number_From_MSC_B state. From this second wait state, a 'Receive_Error_From_HO_CA' event leads to either a Null state (if Null) or back to the initial Wait_For_HO_Number_From_MSC_B state (if Error).](18b107026de7da3bcd10d73dfa8cd527_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA6(8)** + +Process in MSC-A (the Anchor MSC) to handle inter- MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + +stateDiagram-v2 + [*] --> Wait_For_HO_Number_From_MSC_B + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind" as MAP_U_ABORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "HO_CA_MESSAGE_req (Connection Closed)" as HO_CA_MESSAGE_req_1 + state "HO_CA_MESSAGE_req (MAP Error)" as HO_CA_MESSAGE_req_2 + state "Null" as Null_1 + state "Null" as Null_2 + state "Wait_For_HO_Number_From_MSC_B" as Wait_For_HO_Number_From_MSC_B_2 + state "Receive_Error_From_HO_CA" as Receive_Error_From_HO_CA + state "Null" as Null_3 + state "Wait_For_HO_Number_From_MSC_B" as Wait_For_HO_Number_From_MSC_B_3 + + Wait_For_HO_Number_From_MSC_B --> MAP_CLOSE_req + Wait_For_HO_Number_From_MSC_B --> MAP_U_ABORT_ind + Wait_For_HO_Number_From_MSC_B --> MAP_NOTICE_ind + + MAP_CLOSE_req --> HO_CA_MESSAGE_req_1 + HO_CA_MESSAGE_req_1 --> Null_1 + + MAP_U_ABORT_ind --> HO_CA_MESSAGE_req_2 + HO_CA_MESSAGE_req_2 --> Null_2 + + MAP_NOTICE_ind --> HO_CA_MESSAGE_req_2 + HO_CA_MESSAGE_req_2 --> Wait_For_HO_Number_From_MSC_B_2 + + Wait_For_HO_Number_From_MSC_B_2 --> Receive_Error_From_HO_CA + + Receive_Error_From_HO_CA --> Null_3 : Null + Receive_Error_From_HO_CA --> Wait_For_HO_Number_From_MSC_B_3 : Error + +``` + +State transition diagram for process Handover\_MSC\_A. The diagram shows three main paths from an initial 'Wait\_For\_HO\_Number\_From\_MSC\_B' state. Path 1: MAP\_CLOSE\_req leads to HO\_CA\_MESSAGE\_req (Connection Closed) and then to a Null state. Path 2: MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind leads to HO\_CA\_MESSAGE\_req (MAP Error) and then to a Null state. Path 3: MAP\_NOTICE\_ind leads to HO\_CA\_MESSAGE\_req (MAP Error) and then to another Wait\_For\_HO\_Number\_From\_MSC\_B state. From this second wait state, a 'Receive\_Error\_From\_HO\_CA' event leads to either a Null state (if Null) or back to the initial Wait\_For\_HO\_Number\_From\_MSC\_B state (if Error). + +1496 + +1497 + +Figure 19.2/4 (sheet 6 of 8): Process HO\_MSC\_A + +![Flowchart for process Handover_MSC_A. It starts with MS_On_MSC_B, followed by MAP_PREPARE_SUBSEQUENT_HANDOVER_ind. A decision 'MSC known?' leads to 'Set User Error: Unknown MSC' if No, or 'HO_CA_MESSAGE_req (Handover Request)' if Yes. The 'Yes' path leads to 'Wait_For_Subsequent_Handover', which then splits into 'HO_CA_MESSAGE_ind (Subsequent Handover Accepted)' or 'HO_CA_MESSAGE_ind (Subsequent Handover Failure)'. The 'Accepted' path leads to 'MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp' and 'MAP_DELIMITER_req', then 'Wait_For_Subsequent_Handover_Completion', 'HO_CA_MESSAGE_ind (Subsequent Handover Complete)', 'MAP_SEND_END_SIGNAL_rsp' and 'MAP_CLOSE_req', and finally 'Null'. The 'Failure' path leads to 'Set User Error: Subsequent Handover Failure', 'MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp' and 'MAP_DELIMITER_req', and then 'MS_On_MSC_B'. The 'Error' path from 'Check_Indication' leads to 'MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp' and 'MAP_DELIMITER_req', and then 'MS_On_MSC_B'.](b9f1899edf1da4ab3f1d88710590a72d_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA7(8)** + +Process in MSC-A (the Anchor MSC) to handle inter- MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + + graph TD + Start([MS_On_MSC_B]) --> Ind1[MAP_PREPARE_SUBSEQUENT_HANDOVER_ind] + Ind1 --> Check[Check_Indication] + Check -- OK --> Decision{MSC known?} + Check -- Error --> Merge1(( )) + Decision -- No --> Error1[Set User Error: Unknown MSC] + Error1 --> Merge1 + Decision -- Yes --> Req1[HO_CA_MESSAGE_req +(Handover Request)] + Req1 --> Wait1[Wait_For_Subsequent_Handover] + Wait1 --> Merge2(( )) + Merge2 --> Ind2[HO_CA_MESSAGE_ind +(Subsequent Handover Accepted)] + Merge2 --> Ind3[HO_CA_MESSAGE_ind +(Subsequent Handover Failure)] + Ind2 --> Merge3(( )) + Merge3 --> Rsp1[MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp +MAP_DELIMITER_req] + Rsp1 --> Wait2[Wait_For_Subsequent_Handover_Completion] + Wait2 --> Merge4(( )) + Merge4 --> Ind4[HO_CA_MESSAGE_ind +(Subsequent Handover Complete)] + Ind4 --> Merge5(( )) + Merge5 --> Rsp2[MAP_SEND_END_SIGNAL_rsp +MAP_CLOSE_req] + Rsp2 --> Null([Null]) + Ind3 --> Error2[Set User Error: Subsequent Handover Failure] + Error2 --> Merge6(( )) + Merge6 --> Rsp3[MAP_PREPARE_SUBSEQUENT_HANDOVER_rsp +MAP_DELIMITER_req] + Rsp3 --> MSOnB2([MS_On_MSC_B]) + +``` + +Flowchart for process Handover\_MSC\_A. It starts with MS\_On\_MSC\_B, followed by MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_ind. A decision 'MSC known?' leads to 'Set User Error: Unknown MSC' if No, or 'HO\_CA\_MESSAGE\_req (Handover Request)' if Yes. The 'Yes' path leads to 'Wait\_For\_Subsequent\_Handover', which then splits into 'HO\_CA\_MESSAGE\_ind (Subsequent Handover Accepted)' or 'HO\_CA\_MESSAGE\_ind (Subsequent Handover Failure)'. The 'Accepted' path leads to 'MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_rsp' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_Subsequent\_Handover\_Completion', 'HO\_CA\_MESSAGE\_ind (Subsequent Handover Complete)', 'MAP\_SEND\_END\_SIGNAL\_rsp' and 'MAP\_CLOSE\_req', and finally 'Null'. The 'Failure' path leads to 'Set User Error: Subsequent Handover Failure', 'MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_rsp' and 'MAP\_DELIMITER\_req', and then 'MS\_On\_MSC\_B'. The 'Error' path from 'Check\_Indication' leads to 'MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_rsp' and 'MAP\_DELIMITER\_req', and then 'MS\_On\_MSC\_B'. + +1498 + +1499 + +Figure 19.2/4 (sheet 7 of 8): Process HO\_MSC\_A + +![State transition diagram for process HO_MSC_A. The diagram shows two main state machines. The top state machine starts in a state with transitions 'Wait_For_Subsequent_Handover' and 'Wait_For_Subsequent_Handover_Completion'. It has three outgoing transitions: 'HO_CA_MESSAGE_ind (Message Transfer)' leading to a state with 'MAP_FORWARD_ACCESS_SIGNALLING_req' and 'MAP_DELIMITER_req'; 'MAP_PROCESS_ACCESS_SIGNALLING_ind' leading to a 'Check_Indication' state; and 'Receive_Error_From_HO_CA' leading to 'Null' or 'MS_On_MSC_B' states. The 'Check_Indication' state has 'OK' and 'Error' transitions leading to 'HO_CA_MESSAGE_req (Message Transfer)' and terminal states. The 'HO_CA_MESSAGE_req' state leads to 'Wait_For_Handover_Indication'. The bottom state machine starts in a state with transitions 'Wait_For_Subsequent_Handover' and 'Wait_For_Subsequent_Handover_Completion'. It has three outgoing transitions: 'MAP_CLOSE_req' leading to 'HO_CA_MESSAGE_req (Connection Closed)' and 'Null'; 'MAP_U_ABORT_ind, MAP_P_ABORT_ind' leading to 'HO_CA_MESSAGE_req (MAP Error)' and 'Null'; and 'MAP_NOTICE_ind' leading to 'HO_CA_MESSAGE_req (MAP Error)' and a terminal state.](1902200b1ad3f4c86ba69bae8fe13737_img.jpg) + +**process Handover\_MSC\_A** **HO\_MSCA8(8)** + +Process in MSC-A (the Anchor MSC) to handle inter-MSC handover to MSC-B (the Relay MSC) and subsequent handover back to MSC-A or to MSC-B' (the new Relay MSC) + +Signals to/from the left are to/from the Handover Control Application in MSC-A; signals to/from the right are to/from MSC-B + +``` + + graph TD + subgraph TopState [ ] + T1(( )) --> T1_W[Wait_For_Subsequent_Handover, Wait_For_Subsequent_Handover_Completion] + T1 --> HO_CA_MESSAGE_ind[HO_CA_MESSAGE_ind Message Transfer] + T1 --> MAP_PROCESS_ACCESS_SIGNALLING_ind[MAP_PROCESS_ACCESS_SIGNALLING_ind] + T1 --> Receive_Error_From_HO_CA[Receive_Error_From_HO_CA] + HO_CA_MESSAGE_ind --> MAP_FORWARD_ACCESS_SIGNALLING_req[MAP_FORWARD_ACCESS_SIGNALLING_req MAP_DELIMITER_req] + MAP_FORWARD_ACCESS_SIGNALLING_req --> T1_E1(( )) + MAP_PROCESS_ACCESS_SIGNALLING_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> HO_CA_MESSAGE_req_1[HO_CA_MESSAGE_req Message Transfer] + HO_CA_MESSAGE_req_1 --> Wait_For_Handover_Indication[Wait_For_Handover_Indication] + Check_Indication -- Error --> T1_E2(( )) + Receive_Error_From_HO_CA -- Null --> Null_1[Null] + Receive_Error_From_HO_CA -- Error --> MS_On_MSC_B[MS_On_MSC_B] + end + + subgraph BottomState [ ] + B1(( )) --> B1_W[Wait_For_Subsequent_Handover, Wait_For_Subsequent_Handover_Completion] + B1 --> MAP_CLOSE_req[MAP_CLOSE_req] + B1 --> MAP_U_ABORT_ind_MAP_P_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind] + B1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_CLOSE_req --> HO_CA_MESSAGE_req_2[HO_CA_MESSAGE_req Connection Closed] + HO_CA_MESSAGE_req_2 --> Null_2[Null] + MAP_U_ABORT_ind_MAP_P_ABORT_ind --> HO_CA_MESSAGE_req_3[HO_CA_MESSAGE_req MAP Error] + HO_CA_MESSAGE_req_3 --> Null_3[Null] + MAP_NOTICE_ind --> HO_CA_MESSAGE_req_4[HO_CA_MESSAGE_req MAP Error] + HO_CA_MESSAGE_req_4 --> B1_E3(( )) + end + +``` + +State transition diagram for process HO\_MSC\_A. The diagram shows two main state machines. The top state machine starts in a state with transitions 'Wait\_For\_Subsequent\_Handover' and 'Wait\_For\_Subsequent\_Handover\_Completion'. It has three outgoing transitions: 'HO\_CA\_MESSAGE\_ind (Message Transfer)' leading to a state with 'MAP\_FORWARD\_ACCESS\_SIGNALLING\_req' and 'MAP\_DELIMITER\_req'; 'MAP\_PROCESS\_ACCESS\_SIGNALLING\_ind' leading to a 'Check\_Indication' state; and 'Receive\_Error\_From\_HO\_CA' leading to 'Null' or 'MS\_On\_MSC\_B' states. The 'Check\_Indication' state has 'OK' and 'Error' transitions leading to 'HO\_CA\_MESSAGE\_req (Message Transfer)' and terminal states. The 'HO\_CA\_MESSAGE\_req' state leads to 'Wait\_For\_Handover\_Indication'. The bottom state machine starts in a state with transitions 'Wait\_For\_Subsequent\_Handover' and 'Wait\_For\_Subsequent\_Handover\_Completion'. It has three outgoing transitions: 'MAP\_CLOSE\_req' leading to 'HO\_CA\_MESSAGE\_req (Connection Closed)' and 'Null'; 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind' leading to 'HO\_CA\_MESSAGE\_req (MAP Error)' and 'Null'; and 'MAP\_NOTICE\_ind' leading to 'HO\_CA\_MESSAGE\_req (MAP Error)' and a terminal state. + +1500 + +1501 + +**Figure 19.2/4 (sheet 8 of 8): Process HO\_MSC\_A** + +![Flowchart for process Handover_MSC_B. It starts with an initial state leading to 'Null', then 'Receive_Open_ind'. From 'Receive_Open_ind', an 'Error' leads to 'Null', 'OK' leads to 'Wait_For_Service_Indication', and 'Vr' leads to 'Perform MAP Vr dialogue'. 'Wait_For_Service_Indication' branches into three paths: 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and 'Null'; 'MAP_PREPARE_HANDOVER_ind' leading to 'Check_Indication'; and 'MAP_U_ABORT_ind, MAP_P_ABORT_ind' leading to 'Perform MAP Vr dialogue'. 'Check_Indication' has an 'Error' path to 'MAP_PREPARE_HANDOVER_rsp, MAP_CLOSE_req' and 'OK' path to 'VBS or VGCS?'. 'VBS or VGCS?' has a 'No' path to 'Perform MAP Vr dialogue' and a 'Yes' path to 'New cell in Group Call area?'. 'New cell in Group Call area?' has a 'Yes' path to 'Perform MAP Vr dialogue' and a 'No' path to 'Set User Error: Target cell outside Group Call area'. 'Set User Error: Target cell outside Group Call area' leads to 'MAP_PREPARE_HANDOVER_rsp, MAP_CLOSE_req' and 'Null'. 'MAP_PREPARE_HANDOVER_rsp, MAP_CLOSE_req' from 'Set User Error' leads to a merge point. 'MAP_PREPARE_HANDOVER_rsp, MAP_CLOSE_req' from 'Error' in 'Check_Indication' also leads to this merge point. From this merge point, a 'Yes' path from 'Handover number allocation required?' leads to connector '1', and a 'No' path leads to 'HO_CA_MESSAGE_req (Handover Request)' and 'Wait_For_Channel'. 'Perform MAP Vr dialogue' from 'Vr' in 'Receive_Open_ind' leads to 'Null'. 'Perform MAP Vr dialogue' from 'MAP_U_ABORT_ind, MAP_P_ABORT_ind' leads to the same 'Null' state.](4f53860bfd35d33fcb6f7365143da345_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB1(8)** + +Process in MSC-B (the Relay MSC) to handle inter- MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind -- Error --> Null2([Null]) + Receive_Open_ind -- OK --> Wait_For_Service_Indication([Wait_For_Service_Indication]) + Receive_Open_ind -- Vr --> Perform_MAP_Vr_dialogue1[Perform MAP Vr dialogue] + + Wait_For_Service_Indication --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + Wait_For_Service_Indication --> MAP_PREPARE_HANDOVER_ind[/MAP_PREPARE_HANDOVER_ind/] + Wait_For_Service_Indication --> MAP_U_ABORT_ind[/MAP_U_ABORT_ind, MAP_P_ABORT_ind/] + + MAP_NOTICE_ind --> MAP_CLOSE_req1[/MAP_CLOSE_req/] + MAP_CLOSE_req1 --> Null3([Null]) + + MAP_PREPARE_HANDOVER_ind --> Check_Indication[Check_Indication] + + Check_Indication -- Error --> MAP_PREPARE_HANDOVER_rsp1[MAP_PREPARE_HANDOVER_rsp +MAP_CLOSE_req] + + Check_Indication -- OK --> VBS_or_VGCS{VBS or VGCS?} + + VBS_or_VGCS -- No --> Perform_MAP_Vr_dialogue2[Perform MAP Vr dialogue] + + VBS_or_VGCS -- Yes --> New_cell_in_Group_Call_area{New cell in Group Call area?} + + New_cell_in_Group_Call_area -- Yes --> Perform_MAP_Vr_dialogue2 + + New_cell_in_Group_Call_area -- No --> Set_User_Error[Set User Error: +Target cell outside Group Call area] + + Set_User_Error --> MAP_PREPARE_HANDOVER_rsp2[MAP_PREPARE_HANDOVER_rsp +MAP_CLOSE_req] + + MAP_PREPARE_HANDOVER_rsp2 --> Merge1[/ /] + + Merge1 --> Handover_number_allocation_required{Handover number allocation required?} + + Handover_number_allocation_required -- Yes --> Connector1((1)) + + Handover_number_allocation_required -- No --> HO_CA_MESSAGE_req[HO_CA_MESSAGE_req +(Handover Request)] + + HO_CA_MESSAGE_req --> Wait_For_Channel([Wait_For_Channel]) + + MAP_U_ABORT_ind --> Perform_MAP_Vr_dialogue2 + + Perform_MAP_Vr_dialogue2 --> Null4([Null]) + +``` + +Flowchart for process Handover\_MSC\_B. It starts with an initial state leading to 'Null', then 'Receive\_Open\_ind'. From 'Receive\_Open\_ind', an 'Error' leads to 'Null', 'OK' leads to 'Wait\_For\_Service\_Indication', and 'Vr' leads to 'Perform MAP Vr dialogue'. 'Wait\_For\_Service\_Indication' branches into three paths: 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and 'Null'; 'MAP\_PREPARE\_HANDOVER\_ind' leading to 'Check\_Indication'; and 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind' leading to 'Perform MAP Vr dialogue'. 'Check\_Indication' has an 'Error' path to 'MAP\_PREPARE\_HANDOVER\_rsp, MAP\_CLOSE\_req' and 'OK' path to 'VBS or VGCS?'. 'VBS or VGCS?' has a 'No' path to 'Perform MAP Vr dialogue' and a 'Yes' path to 'New cell in Group Call area?'. 'New cell in Group Call area?' has a 'Yes' path to 'Perform MAP Vr dialogue' and a 'No' path to 'Set User Error: Target cell outside Group Call area'. 'Set User Error: Target cell outside Group Call area' leads to 'MAP\_PREPARE\_HANDOVER\_rsp, MAP\_CLOSE\_req' and 'Null'. 'MAP\_PREPARE\_HANDOVER\_rsp, MAP\_CLOSE\_req' from 'Set User Error' leads to a merge point. 'MAP\_PREPARE\_HANDOVER\_rsp, MAP\_CLOSE\_req' from 'Error' in 'Check\_Indication' also leads to this merge point. From this merge point, a 'Yes' path from 'Handover number allocation required?' leads to connector '1', and a 'No' path leads to 'HO\_CA\_MESSAGE\_req (Handover Request)' and 'Wait\_For\_Channel'. 'Perform MAP Vr dialogue' from 'Vr' in 'Receive\_Open\_ind' leads to 'Null'. 'Perform MAP Vr dialogue' from 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind' leads to the same 'Null' state. + +1502 + +1503 + +Figure 19.2/5 (sheet 1 of 8): Process HO\_MSC\_B + +![](16c2a5cb6db777cd9386004ea5cdbfd5_img.jpg) + +**process Handover\_MSC\_B** + +**HO\_MSCB2(8)** + +Process in MSC-B (the Relay MSC) to handle inter-MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B unless marked otherwise + +``` + + graph TD + Start((1)) --> Q1{Multiple +bearer +requested?} + Q1 -- No --> Q2{Multiple +bearer +supported?} + Q1 -- Yes --> Q2 + + Q2 -- No --> Out1[/MAP_PREPARE_HANDOVER_rsp +MAP_DELIMITER_req/] + Q2 -- Yes --> Out2[/MAP_OPEN_req +MAP_ALLOCATE_HANDOVER_NUMBER_req +MAP_DELIMITER_req/] + + Out1 --> State1([Wait_For_ +Service_ +Indication]) + Out2 --> ToVLRB1[[To VLR-B]] + ToVLRB1 --> In1[\Receive_ +Open_Cnf\] + In1 -- OK --> State2([Wait_For_ +Handover_ +Number]) + + State2 --> In2[\MAP_SEND_HANDOVER_REPORT_ind\] + In2 --> FromVLRB1[[From VLR-B]] + FromVLRB1 --> CheckInd{Check_ +Indication} + + CheckInd -- OK --> Out3[/HO_CA_MESSAGE_req +(Handover Number +allocated)/] + Out3 --> State3([Wait_For_ +Channel]) + + CheckInd -- Error --> Task1[Set User Error: +System failure] + + State2 --> In3[\MAP_ALLOCATE_HANDOVER_NUMBER_cnf\] + In3 --> FromVLRB2[[From VLR-B]] + In3 -- Vr, Error --> Task2[Set User Error: +No Handover +Number available] + + Task1 --> Out4[/MAP_PREPARE_HANDOVER_rsp +MAP_CLOSE_req/] + Task2 --> Out4 + Out4 --> Null([Null]) + +``` + +1504 + +1505 + +**Figure 19.2/5 (sheet 2 of 8): Process HO\_MSC\_B** + +![State transition diagram for process HO_MSC_B. The diagram shows two main state machines. The top state machine starts at 'Wait_For_Channel' and branches into three paths: 1) MAP NOTICE_ind leads to MAP_CLOSE_req, then HO_CA_MESSAGE_ind (MAP Error), ending at Null. 2) A merge point receives HO_CA_MESSAGE_ind (Handover Request ack) and leads to a decision 'SCCP segmentation required?'. If 'No', it goes to MAP_DELIMITER_req. If 'Yes', it goes to MAP_DELIMITER_req. Both lead to a merge point receiving MAP_PREPARE_HANDOVER_rsp and MAP_DELIMITER_req, then to 'Wait_For_Connection'. 3) Receive_Error_From_HO_CA leads to MAP_U_ABORT_req, which then leads to Null (Error) or Null (Null). The bottom state machine starts at a merge point with a list of states: Wait_For_Assignment, Wait_For_Channel, Wait_For_Connection, MS_On_MSC_B. It branches into two paths: 1) MAP_U_ABORT_ind and MAP_P_ABORT_ind lead to HO_CA_MESSAGE_ind (MAP Error), ending at Null. 2) MAP_CLOSE_ind leads to HO_CA_MESSAGE_ind (Connection Closed), ending at Null.](825f1c23f73e29f6da4dd471d7d80cca_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB3(8)** + +Process in MSC-B (the Relay MSC) to handle inter- MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B + +``` + +stateDiagram-v2 + [*] --> Wait_For_Channel + state "Wait_For_Channel" as Wait_For_Channel + state "SCCP segmentation required?" as SCCP_segmentation_required + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "MAP_PREPARE_HANDOVER_rsp / MAP_DELIMITER_req" as MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req + state "Wait_For_Connection" as Wait_For_Connection + state "Null" as Null1[Null] + state "Null" as Null2[Null] + state "Null" as Null3[Null] + state "Null" as Null4[Null] + + Wait_For_Channel --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> HO_CA_MESSAGE_ind_MAP_Error1[HO_CA_MESSAGE_ind (MAP Error)] + HO_CA_MESSAGE_ind_MAP_Error1 --> Null1 + + Wait_For_Channel --> Merge1(( )) + Merge1 --> HO_CA_MESSAGE_ind_Handover_Request_ack[HO_CA_MESSAGE_ind (Handover Request ack)] + HO_CA_MESSAGE_ind_Handover_Request_ack --> SCCP_segmentation_required + SCCP_segmentation_required --> MAP_DELIMITER_req + SCCP_segmentation_required --> Merge2(( )) + Merge2 --> MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req + MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req --> Wait_For_Connection + + Wait_For_Channel --> Receive_Error_From_HO_CA + Receive_Error_From_HO_CA --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Null2 + MAP_U_ABORT_req --> Null3 + + [*] --> Merge3(( )) + Merge3 --> Wait_For_Assignment_Wait_For_Channel_Wait_For_Connection_MS_On_MSC_B[Wait_For_Assignment, Wait_For_Channel, Wait_For_Connection, MS_On_MSC_B] + Wait_For_Assignment_Wait_For_Channel_Wait_For_Connection_MS_On_MSC_B --> Merge4(( )) + Merge4 --> MAP_U_ABORT_ind_MAP_P_ABORT_ind[MAP_U_ABORT_ind / MAP_P_ABORT_ind] + MAP_U_ABORT_ind_MAP_P_ABORT_ind --> HO_CA_MESSAGE_ind_MAP_Error2[HO_CA_MESSAGE_ind (MAP Error)] + HO_CA_MESSAGE_ind_MAP_Error2 --> Null4 + + Merge4 --> MAP_CLOSE_ind + MAP_CLOSE_ind --> HO_CA_MESSAGE_ind_Connection_Closed[HO_CA_MESSAGE_ind (Connection Closed)] + HO_CA_MESSAGE_ind_Connection_Closed --> Null4 + +``` + +State transition diagram for process HO\_MSC\_B. The diagram shows two main state machines. The top state machine starts at 'Wait\_For\_Channel' and branches into three paths: 1) MAP NOTICE\_ind leads to MAP\_CLOSE\_req, then HO\_CA\_MESSAGE\_ind (MAP Error), ending at Null. 2) A merge point receives HO\_CA\_MESSAGE\_ind (Handover Request ack) and leads to a decision 'SCCP segmentation required?'. If 'No', it goes to MAP\_DELIMITER\_req. If 'Yes', it goes to MAP\_DELIMITER\_req. Both lead to a merge point receiving MAP\_PREPARE\_HANDOVER\_rsp and MAP\_DELIMITER\_req, then to 'Wait\_For\_Connection'. 3) Receive\_Error\_From\_HO\_CA leads to MAP\_U\_ABORT\_req, which then leads to Null (Error) or Null (Null). The bottom state machine starts at a merge point with a list of states: Wait\_For\_Assignment, Wait\_For\_Channel, Wait\_For\_Connection, MS\_On\_MSC\_B. It branches into two paths: 1) MAP\_U\_ABORT\_ind and MAP\_P\_ABORT\_ind lead to HO\_CA\_MESSAGE\_ind (MAP Error), ending at Null. 2) MAP\_CLOSE\_ind leads to HO\_CA\_MESSAGE\_ind (Connection Closed), ending at Null. + +1506 + +1507 + +Figure 19.2/5 (sheet 3 of 8): Process HO\_MSC\_B + +![State transition diagram for process HO_MSC_B. The diagram shows two main state machines. The top one starts at 'Wait_For_Connection' and branches into three paths based on HO_CA_MESSAGE_ind signals: 'Message Transfer' (leading to MAP_PROCESS_ACCESS_SIGNALLING_req and back to Wait_For_Connection), 'Release Handover Number' (leading to 'Set result', then MAP_SEND_HANDOVER_REPORT_rsp/MAP_CLOSE_req to VLR-B, and back to Wait_For_Connection), and 'Handover Complete' (leading to MAP_SEND_END_SIGNAL_req and then MS_On_MSC_B). The bottom state machine starts at 'Wait_For_Connection' and branches into 'MAP_NOTICE_ind' (leading to MAP_CLOSE_req, HO_CA_MESSAGE_ind (MAP Error), and Null) and 'Receive_Error_From_HO_CA' (leading to a decision: 'Error' leads to MAP_U_ABORT_req and Null, 'Null' leads directly to Null).](9f8684f45b509e2771465930b4d3bc3b_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB4(8)** + +Process in MSC-B (the Relay MSC) to handle inter-MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B unless marked otherwise + +``` + + graph TD + subgraph Top_State_Machine + WFC1([Wait_For_Connection]) --> HO1[HO_CA_MESSAGE_ind +Message Transfer] + WFC1 --> HO2[HO_CA_MESSAGE_ind +Release Handover Number] + WFC1 --> HO3[HO_CA_MESSAGE_ind +Handover Complete] + HO1 --> MP[MAP_PROCESS_ACCESS_SIGNALLING_req +MAP_DELIMITER_req] + MP --> WFC1 + HO2 --> SR[Set result] + SR --> MSR[MAP_SEND_HANDOVER_REPORT_rsp +MAP_CLOSE_req] + MSR -.-> VLRB[To VLR-B] + MSR --> WFC1 + HO3 --> MES[MAP_SEND_END_SIGNAL_req +MAP_DELIMITER_req] + MES --> MOB([MS_On_MSC_B]) + end + + subgraph Bottom_State_Machine + WFC2([Wait_For_Connection]) --> MN[MAP_NOTICE_ind] + WFC2 --> REF[Receive_Error_From_HO_CA] + MN --> MC[MAP_CLOSE_req] + MC --> HO4[HO_CA_MESSAGE_ind +MAP Error] + HO4 --> N1([Null]) + REF --> Error[Error] + REF --> Null1[Null] + Error --> MU[MAP_U_ABORT_req] + MU --> N2([Null]) + Null1 --> N3([Null]) + end + +``` + +State transition diagram for process HO\_MSC\_B. The diagram shows two main state machines. The top one starts at 'Wait\_For\_Connection' and branches into three paths based on HO\_CA\_MESSAGE\_ind signals: 'Message Transfer' (leading to MAP\_PROCESS\_ACCESS\_SIGNALLING\_req and back to Wait\_For\_Connection), 'Release Handover Number' (leading to 'Set result', then MAP\_SEND\_HANDOVER\_REPORT\_rsp/MAP\_CLOSE\_req to VLR-B, and back to Wait\_For\_Connection), and 'Handover Complete' (leading to MAP\_SEND\_END\_SIGNAL\_req and then MS\_On\_MSC\_B). The bottom state machine starts at 'Wait\_For\_Connection' and branches into 'MAP\_NOTICE\_ind' (leading to MAP\_CLOSE\_req, HO\_CA\_MESSAGE\_ind (MAP Error), and Null) and 'Receive\_Error\_From\_HO\_CA' (leading to a decision: 'Error' leads to MAP\_U\_ABORT\_req and Null, 'Null' leads directly to Null). + +1508 + +1509 + +**Figure 19.2/5 (sheet 4 of 8): Process HO\_MSC\_B** + +![State transition diagram for process HO_MSCB5(8) in MSC-B. The diagram shows two main state transition paths starting from 'MS_On_MSC_B'. The top path handles 'MAP_SEND_END_SIGNAL_cnf', 'MAP_FORWARD_ACCESS_SIGNALLING_ind', and 'HO_CA_MESSAGE_ind (Message Transfer)'. The bottom path handles 'MAP_NOTICE_ind' and 'Receive_Error_From_HO_CA'. Transitions lead to 'Null' or back to 'MS_On_MSC_B'.](a2bbf801d7d0f95626d38da25e972941_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB5(8)** + +Process in MSC-B (the Relay MSC) to handle inter-MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B + +``` + +stateDiagram-v2 + [*] --> MS_On_MSC_B + state "MS_On_MSC_B" as MS_On_MSC_B + + MS_On_MSC_B --> MAP_SEND_END_SIGNAL_cnf + MS_On_MSC_B --> MAP_FORWARD_ACCESS_SIGNALLING_ind + MS_On_MSC_B --> HO_CA_MESSAGE_ind_MT[HO_CA_MESSAGE_ind (Message Transfer)] + + MAP_SEND_END_SIGNAL_cnf --> HO_CA_MESSAGE_ind_CC[HO_CA_MESSAGE_ind (Connection Closed)] + HO_CA_MESSAGE_ind_CC --> Null + + MAP_FORWARD_ACCESS_SIGNALLING_ind --> Check_Indication + Check_Indication --> HO_CA_MESSAGE_req_MT[HO_CA_MESSAGE_req (Message Transfer)] + Check_Indication --> Error + Check_Indication --> OK + HO_CA_MESSAGE_req_MT --> MS_On_MSC_B + Error --> MS_On_MSC_B + OK --> MS_On_MSC_B + + HO_CA_MESSAGE_ind_MT --> MAP_PROCESS_ACCESS_SIGNALLING_req[MAP_PROCESS_ACCESS_SIGNALLING_req +MAP_DELIMITER_req] + MAP_PROCESS_ACCESS_SIGNALLING_req --> MS_On_MSC_B + + MS_On_MSC_B --> MAP_NOTICE_ind + MS_On_MSC_B --> Receive_Error_From_HO_CA + + MAP_NOTICE_ind --> HO_CA_MESSAGE_ind_ME[HO_CA_MESSAGE_ind (MAP Error)] + HO_CA_MESSAGE_ind_ME --> MS_On_MSC_B + + Receive_Error_From_HO_CA --> Error + Receive_Error_From_HO_CA --> Null + +``` + +State transition diagram for process HO\_MSCB5(8) in MSC-B. The diagram shows two main state transition paths starting from 'MS\_On\_MSC\_B'. The top path handles 'MAP\_SEND\_END\_SIGNAL\_cnf', 'MAP\_FORWARD\_ACCESS\_SIGNALLING\_ind', and 'HO\_CA\_MESSAGE\_ind (Message Transfer)'. The bottom path handles 'MAP\_NOTICE\_ind' and 'Receive\_Error\_From\_HO\_CA'. Transitions lead to 'Null' or back to 'MS\_On\_MSC\_B'. + +1510 + +1511 + +**Figure 19.2/5 (sheet 5 of 8): Process HO\_MSC\_B** + +process Handover\_MSC\_B + +HO\_MSCB6(8) + +Process in MSC-B (the Relay MSC) to handle inter- MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B unless marked otherwise + +![Flowchart for process Handover_MSC_B. It starts with MS_On_MSC_B, followed by a merge symbol leading to MAP_PREPARE_HANDOVER_ind. Then Check_Indication, followed by a decision diamond 'HO Number Not Required parameter present?'. If Yes, it goes to 'HO Number Not Required parameter present?'. If No, it goes to another decision diamond 'Handover number already used?'. If Yes, it goes to 'Set User Error: Unexpected data value'. If No, it goes to a merge symbol leading to a list of messages: MAP_OPEN_req, MAP_ALLOCATE_HANDOVER_NUMBER_req, MAP_DELIMITER_req, and 'To VLR-B'. Then Receive_Open_Cnf, followed by a decision diamond 'OK'. If OK, it goes to 'Wait_For_Handover_Number_Allocation'. If Vr, Error, it goes to 'Set User Error: No Handover Number available'. Both error paths lead to a merge symbol leading to a list of messages: MAP_PREPARE_HANDOVER_rsp, MAP_DELIMITER_req. Finally, it ends with MS_On_MSC_B.](a4a814d3fa0262489da4fe8224205075_img.jpg) + +``` + +graph TD + Start([MS_On_MSC_B]) --> Merge1{ } + Merge1 --> MAP_PREPARE_HANDOVER_ind[MAP_PREPARE_HANDOVER_ind] + MAP_PREPARE_HANDOVER_ind --> Check_Indication[Check_Indication] + Check_Indication --> Decision1{HO Number Not Required parameter present?} + Decision1 -- Yes --> HO_Number_Not_Required[HO Number Not Required parameter present?] + Decision1 -- No --> Decision2{Handover number already used?} + Decision2 -- Yes --> Set_User_Error_Unexpected[Set User Error: Unexpected data value] + Decision2 -- No --> Merge2{ } + Merge2 --> MAP_OPEN_req[MAP_OPEN_req] + Merge2 --> MAP_ALLOCATE_HANDOVER_NUMBER_req[MAP_ALLOCATE_HANDOVER_NUMBER_req] + Merge2 --> MAP_DELIMITER_req1[MAP_DELIMITER_req] + Merge2 -.-> To_VLR_B[To VLR-B] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + MAP_ALLOCATE_HANDOVER_NUMBER_req --> Receive_Open_Cnf + MAP_DELIMITER_req1 --> Receive_Open_Cnf + To_VLR_B -.-> Receive_Open_Cnf + Receive_Open_Cnf --> Decision3{OK} + Decision3 -- OK --> Wait_For_Handover_Number_Allocation[Wait_For_Handover_Number_Allocation] + Decision3 -- Vr, Error --> Set_User_Error_No_Handover[Set User Error: No Handover Number available] + Set_User_Error_Unexpected --> Merge3{ } + Set_User_Error_No_Handover --> Merge3 + Merge3 --> MAP_PREPARE_HANDOVER_rsp[MAP_PREPARE_HANDOVER_rsp] + Merge3 --> MAP_DELIMITER_req2[MAP_DELIMITER_req] + MAP_PREPARE_HANDOVER_rsp --> End([MS_On_MSC_B]) + MAP_DELIMITER_req2 --> End + +``` + +Flowchart for process Handover\_MSC\_B. It starts with MS\_On\_MSC\_B, followed by a merge symbol leading to MAP\_PREPARE\_HANDOVER\_ind. Then Check\_Indication, followed by a decision diamond 'HO Number Not Required parameter present?'. If Yes, it goes to 'HO Number Not Required parameter present?'. If No, it goes to another decision diamond 'Handover number already used?'. If Yes, it goes to 'Set User Error: Unexpected data value'. If No, it goes to a merge symbol leading to a list of messages: MAP\_OPEN\_req, MAP\_ALLOCATE\_HANDOVER\_NUMBER\_req, MAP\_DELIMITER\_req, and 'To VLR-B'. Then Receive\_Open\_Cnf, followed by a decision diamond 'OK'. If OK, it goes to 'Wait\_For\_Handover\_Number\_Allocation'. If Vr, Error, it goes to 'Set User Error: No Handover Number available'. Both error paths lead to a merge symbol leading to a list of messages: MAP\_PREPARE\_HANDOVER\_rsp, MAP\_DELIMITER\_req. Finally, it ends with MS\_On\_MSC\_B. + +1512 + +1513 + +Figure 19.2/5 (sheet 6 of 8): Process HO\_MSC\_B + +![State transition diagram for process HO_MSC_B. The process starts in 'Wait_For_Handover_Number_Allocation'. It receives 'MAP_ALLOCATE_HANDOVER_NUMBER_cnf' from VLR-B. If 'Error' (No Handover Number available or System failure), it goes to 'Set User Error' states. If 'OK', it receives 'MAP_SEND_HANDOVER_REPORT_ind' from VLR-B, checks the indication, and sends 'HO_CA_MESSAGE_req' to the Handover Control Application. It then enters 'Wait_For_Assignment'. From there, it can receive 'MAP_PREPARE_HANDOVER_rsp' and 'MAP_DELIMITER_req' from VLR-B, leading to 'MS_On_MSC_B'. It can also send 'MAP_NOTICE_ind' to the Handover Control Application, which may return 'HO_CA_MESSAGE_ind (MAP Error)', leading to 'Wait_For_Assignment'. It can receive 'HO_CA_MESSAGE_ind (Handover Request ack)' from the Handover Control Application. If 'SCCP segmentation required?' is 'No', it sends 'MAP_DELIMITER_req' to VLR-B, then 'MAP_PREPARE_HANDOVER_rsp' and 'MAP_DELIMITER_req' to VLR-B, leading to 'MS_On_MSC_B'. If 'Yes', it goes to 'SCCP segmentation required?'. It can also receive 'Error' or 'Null' from 'Receive_Error_From_HO_CA', leading to 'Wait_For_Assignment' or 'Null' respectively.](97390572a8ffb768231d191922d28d74_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB7(8)** + +Process in MSC-B (the Relay MSC) to handle inter-MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Wait_For_Handover_Number_Allocation + state "MAP_ALLOCATE_HANDOVER_NUMBER_cnf" as MAP_ALLOCATE_HANDOVER_NUMBER_cnf + state "MAP_SEND_HANDOVER_REPORT_ind" as MAP_SEND_HANDOVER_REPORT_ind + state "Check_Indication" as Check_Indication + state "HO_CA_MESSAGE_req (Handover Number allocated)" as HO_CA_MESSAGE_req + state "Set User Error: No Handover Number available" as Set_User_Error_No_Handover_Number_available + state "Set User Error: System failure" as Set_User_Error_System_failure + state "MAP_PREPARE_HANDOVER_rsp MAP_DELIMITER_req" as MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req + state "MS_On_MSC_B" as MS_On_MSC_B + state "Wait_For_Assignment" as Wait_For_Assignment + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "HO_CA_MESSAGE_ind (Handover Request ack)" as HO_CA_MESSAGE_ind_Handover_Request_ack + state "Receive_Error_From_HO_CA" as Receive_Error_From_HO_CA + state "Null" as Null + state "SCCP segmentation required?" as SCCP_segmentation_required + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "HO_CA_MESSAGE_ind (MAP Error)" as HO_CA_MESSAGE_ind_MAP_Error + + Note right of MAP_ALLOCATE_HANDOVER_NUMBER_cnf: From VLR-B + Note right of MAP_SEND_HANDOVER_REPORT_ind: From VLR-B + + Wait_For_Handover_Number_Allocation --> MAP_ALLOCATE_HANDOVER_NUMBER_cnf + MAP_ALLOCATE_HANDOVER_NUMBER_cnf --> Check_Indication + Check_Indication --> HO_CA_MESSAGE_req + HO_CA_MESSAGE_req --> Wait_For_Assignment + Wait_For_Assignment --> MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req + MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req --> MS_On_MSC_B + + Check_Indication --> Set_User_Error_No_Handover_Number_available + Check_Indication --> Set_User_Error_System_failure + + Wait_For_Assignment --> MAP_NOTICE_ind + MAP_NOTICE_ind --> HO_CA_MESSAGE_ind_MAP_Error + HO_CA_MESSAGE_ind_MAP_Error --> Wait_For_Assignment + + Wait_For_Assignment --> HO_CA_MESSAGE_ind_Handover_Request_ack + HO_CA_MESSAGE_ind_Handover_Request_ack --> SCCP_segmentation_required + SCCP_segmentation_required --> MAP_DELIMITER_req + MAP_DELIMITER_req --> MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req + MAP_PREPARE_HANDOVER_rsp_MAP_DELIMITER_req --> MS_On_MSC_B + + Wait_For_Assignment --> Receive_Error_From_HO_CA + Receive_Error_From_HO_CA --> Wait_For_Assignment + Receive_Error_From_HO_CA --> Null + +``` + +State transition diagram for process HO\_MSC\_B. The process starts in 'Wait\_For\_Handover\_Number\_Allocation'. It receives 'MAP\_ALLOCATE\_HANDOVER\_NUMBER\_cnf' from VLR-B. If 'Error' (No Handover Number available or System failure), it goes to 'Set User Error' states. If 'OK', it receives 'MAP\_SEND\_HANDOVER\_REPORT\_ind' from VLR-B, checks the indication, and sends 'HO\_CA\_MESSAGE\_req' to the Handover Control Application. It then enters 'Wait\_For\_Assignment'. From there, it can receive 'MAP\_PREPARE\_HANDOVER\_rsp' and 'MAP\_DELIMITER\_req' from VLR-B, leading to 'MS\_On\_MSC\_B'. It can also send 'MAP\_NOTICE\_ind' to the Handover Control Application, which may return 'HO\_CA\_MESSAGE\_ind (MAP Error)', leading to 'Wait\_For\_Assignment'. It can receive 'HO\_CA\_MESSAGE\_ind (Handover Request ack)' from the Handover Control Application. If 'SCCP segmentation required?' is 'No', it sends 'MAP\_DELIMITER\_req' to VLR-B, then 'MAP\_PREPARE\_HANDOVER\_rsp' and 'MAP\_DELIMITER\_req' to VLR-B, leading to 'MS\_On\_MSC\_B'. If 'Yes', it goes to 'SCCP segmentation required?'. It can also receive 'Error' or 'Null' from 'Receive\_Error\_From\_HO\_CA', leading to 'Wait\_For\_Assignment' or 'Null' respectively. + +1514 + +1515 + +Figure 19.2/5 (sheet 7 of 8): Process HO\_MSC\_B + +![State transition diagram for process HO_MSCB8(8). The process starts at MS_On_MSC_B, receives HO_CA_MESSAGE_ind (Handover Required), then MAP_PREPARE_SUBSEQUENT_HANDOVER_req and MAP_DELIMITER_req. It enters Wait_For_Perform_Subsequent_Handover_Result state. From there, it branches based on MAP_FORWARD_ACCESS_SIGNALLING_ind, MAP_PREPARE_SUBSEQUENT_HANDOVER_cnf, and HO_CA_MESSAGE_req (Message Transfer). The diagram shows various transitions to states like Check_Indication, Check_Confirmation, and final states like MS_On_MSC_B, Null, and Wait_For_Perform_Subsequent_Handover_Result, with associated message transfers and error handling.](8b7c6cbcb1fb65cd6c4cdd48a79c3ac4_img.jpg) + +**process Handover\_MSC\_B** **HO\_MSCB8(8)** + +Process in MSC-B (the Relay MSC) to handle inter-MSC handover from MSC-A (the Anchor MSC) + +Signals to/from the left are to/from MSC-A; signals to/from the right are to/from the Handover Control Application in MSC-B + +``` + +stateDiagram-v2 + [*] --> MS_On_MSC_B + MS_On_MSC_B --> HO_CA_MESSAGE_ind + HO_CA_MESSAGE_ind --> MAP_PREPARE_SUBSEQUENT_HANDOVER_req + MAP_PREPARE_SUBSEQUENT_HANDOVER_req --> Wait_For_Perform_Subsequent_Handover_Result + state "Wait_For_Perform_Subsequent_Handover_Result" as Wait_For_Perform_Subsequent_Handover_Result + state "Check_Indication" as Check_Indication + state "Check_Confirmation" as Check_Confirmation + state "MS_On_MSC_B" as MS_On_MSC_B + state "Null" as Null + + Wait_For_Perform_Subsequent_Handover_Result --> MAP_FORWARD_ACCESS_SIGNALLING_ind + Wait_For_Perform_Subsequent_Handover_Result --> MAP_PREPARE_SUBSEQUENT_HANDOVER_cnf + Wait_For_Perform_Subsequent_Handover_Result --> HO_CA_MESSAGE_req_MT[HO_CA_MESSAGE_req (Message Transfer)] + + MAP_FORWARD_ACCESS_SIGNALLING_ind --> Check_Indication + Check_Indication --> OK_1[OK] + Check_Indication --> Error_1[Error] + OK_1 --> HO_CA_MESSAGE_req_MT_1[HO_CA_MESSAGE_req (Message Transfer)] + HO_CA_MESSAGE_req_MT_1 --> Wait_For_Perform_Subsequent_Handover_Result_1[Wait_For_Perform_Subsequent_Handover_Result] + Error_1 --> Wait_For_Perform_Subsequent_Handover_Result_2[Wait_For_Perform_Subsequent_Handover_Result] + + MAP_PREPARE_SUBSEQUENT_HANDOVER_cnf --> Check_Confirmation + Check_Confirmation --> OK_2[OK] + Check_Confirmation --> User_Error[User Error, Data Error] + Check_Confirmation --> Provider_Error[Provider Error] + OK_2 --> HO_CA_MESSAGE_req_HP[HO_CA_MESSAGE_req (HO-Prepared)] + HO_CA_MESSAGE_req_HP --> MS_On_MSC_B_1[MS_On_MSC_B] + User_Error --> HO_CA_MESSAGE_req_SHF[HO_CA_MESSAGE_req (Subsequent Handover Failure)] + HO_CA_MESSAGE_req_SHF --> MS_On_MSC_B_2[MS_On_MSC_B] + Provider_Error --> HO_CA_MESSAGE_req_CC[HO_CA_MESSAGE_req (Connection closed)] + HO_CA_MESSAGE_req_CC --> Null + + HO_CA_MESSAGE_req_MT --> HO_CA_MESSAGE_req_PT[HO_CA_MESSAGE_req (Message Transfer)] + HO_CA_MESSAGE_req_PT --> MAP_PROCESS_ACCESS_SIGNALLING_req + MAP_PROCESS_ACCESS_SIGNALLING_req --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Perform_Subsequent_Handover_Result_3[Wait_For_Perform_Subsequent_Handover_Result] + +``` + +State transition diagram for process HO\_MSCB8(8). The process starts at MS\_On\_MSC\_B, receives HO\_CA\_MESSAGE\_ind (Handover Required), then MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_req and MAP\_DELIMITER\_req. It enters Wait\_For\_Perform\_Subsequent\_Handover\_Result state. From there, it branches based on MAP\_FORWARD\_ACCESS\_SIGNALLING\_ind, MAP\_PREPARE\_SUBSEQUENT\_HANDOVER\_cnf, and HO\_CA\_MESSAGE\_req (Message Transfer). The diagram shows various transitions to states like Check\_Indication, Check\_Confirmation, and final states like MS\_On\_MSC\_B, Null, and Wait\_For\_Perform\_Subsequent\_Handover\_Result, with associated message transfers and error handling. + +1516 + +1517 + +Figure 19.2/5 (sheet 8 of 8): Process HO\_MSC\_B + +![Flowchart for macro Receive_Error_From_HO_CA. It starts with a merge node, followed by an input message HO_CA_MESSAGE_ind (Error Indication). A decision diamond 'Error indication?' follows. If 'Keep dialogue', it sends a MAP_DELIMITER_req and ends at an 'Error' node. If 'Close dialogue', it goes to another decision diamond 'MAP_NOTICE previously received?'. If 'No', it sends a MAP_U_ABORT_req and ends at a 'Null' node. If 'Yes', it sends a MAP_CLOSE_req and ends at a 'Null' node.](3d02994616bea5c657c0f138adc25aad_img.jpg) + +macrodefinition **Receive\_Error\_From\_HO\_CA** REF\_HOCA1(1) + +Macro in the MSC to handle an error indication from the Handover Control Application + +Signals to/from the left are to/from the local Handover Control Application; signals to/from the right are to/from the distant MSC + +``` + + graph TD + Start([ ]) --> Input{{HO_CA_MESSAGE_ind +(Error Indication)}} + Input --> Decision1{Error indication?} + Decision1 -- Keep dialogue --> Output1{{MAP_DELIMITER_req}} + Output1 --> End1((Error)) + Decision1 -- Close dialogue --> Decision2{MAP_NOTICE previously received?} + Decision2 -- No --> Output2{{MAP_U_ABORT_req}} + Output2 --> End2((Null)) + Decision2 -- Yes --> Output3{{MAP_CLOSE_req}} + Output3 --> End3((Null)) + +``` + +Flowchart for macro Receive\_Error\_From\_HO\_CA. It starts with a merge node, followed by an input message HO\_CA\_MESSAGE\_ind (Error Indication). A decision diamond 'Error indication?' follows. If 'Keep dialogue', it sends a MAP\_DELIMITER\_req and ends at an 'Error' node. If 'Close dialogue', it goes to another decision diamond 'MAP\_NOTICE previously received?'. If 'No', it sends a MAP\_U\_ABORT\_req and ends at a 'Null' node. If 'Yes', it sends a MAP\_CLOSE\_req and ends at a 'Null' node. + +1518 + +1519 + +**Figure 19.2/6: Macro Receive\_error\_from\_HO\_CA** + +![Flowchart for process Handover_VLR_B. It starts with an initial state, followed by 'Null', 'Receive_Open_ind'. A decision point follows: if 'OK', it sends 'MAP_ALLOCATE_HANDOVER_NUMBER_ind' and goes to 'Check_Indication'; if 'Vr, Error', it goes to 'Null'. From 'Check_Indication', if 'OK', it checks if a handover number is available. If 'No', it sets a user error and sends 'MAP_ALLOCATE_HANDOVER_NUMBER_rsp' and 'MAP_CLOSE_req' before reaching 'Null'. If 'Yes', it allocates the handover number, sends 'MAP_SEND_HANDOVER_REPORT_req' and 'MAP_DELIMITER_req', and enters 'Wait_For_Handover_Report'. From there, it can send 'MAP_SEND_HANDOVER_REPORT_cnf', receive 'MAP_U_ABORT_ind', or perform a 'Local Abort' (sending 'MAP_U_ABORT_req'). All three paths lead to a final 'Null' state after releasing the handover number.](010423317d39b0a59b0a3438b3d33a5a_img.jpg) + +**process Handover\_VLR\_B** **HO\_VLRB1(1)** + +Process in VLR-B (the VLR of the Relay MSC) to handle inter-MSB handover from MSC-A to MSC-B + +Signals to/from the left are to/from MSC-B; signals from the right are from the handover control application in VLR-B + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive_Open_ind] + RecOpen --> Decision1{ } + Decision1 -- OK --> SendAlloc[MAP_ALLOCATE_HANDOVER_NUMBER_ind] + SendAlloc --> CheckInd[Check_Indication] + Decision1 -- Vr, Error --> Null2([Null]) + CheckInd --> Decision2{ } + Decision2 -- OK --> Decision3{Handover number available?} + Decision3 -- No --> SetError[Set User Error: No Handover number available] + SetError --> SendRsp[MAP_ALLOCATE_HANDOVER_NUMBER_rsp +MAP_CLOSE_req] + SendRsp --> Null3([Null]) + Decision3 -- Yes --> Alloc[Allocate Handover number] + Alloc --> SendReq[MAP_SEND_HANDOVER_REPORT_req +MAP_DELIMITER_req] + SendReq --> WaitReport[Wait_For_Handover_Report] + WaitReport --> Decision4{ } + Decision4 --> SendCnf[MAP_SEND_HANDOVER_REPORT_cnf] + SendCnf --> Release[Release Handover number] + Decision4 --> AbortInd[MAP_U_ABORT_ind] + AbortInd --> Release + Decision4 --> LocalAbort[Local Abort] + LocalAbort --> AbortReq[MAP_U_ABORT_req] + AbortReq --> Release + Release --> Null4([Null]) + +``` + +Flowchart for process Handover\_VLR\_B. It starts with an initial state, followed by 'Null', 'Receive\_Open\_ind'. A decision point follows: if 'OK', it sends 'MAP\_ALLOCATE\_HANDOVER\_NUMBER\_ind' and goes to 'Check\_Indication'; if 'Vr, Error', it goes to 'Null'. From 'Check\_Indication', if 'OK', it checks if a handover number is available. If 'No', it sets a user error and sends 'MAP\_ALLOCATE\_HANDOVER\_NUMBER\_rsp' and 'MAP\_CLOSE\_req' before reaching 'Null'. If 'Yes', it allocates the handover number, sends 'MAP\_SEND\_HANDOVER\_REPORT\_req' and 'MAP\_DELIMITER\_req', and enters 'Wait\_For\_Handover\_Report'. From there, it can send 'MAP\_SEND\_HANDOVER\_REPORT\_cnf', receive 'MAP\_U\_ABORT\_ind', or perform a 'Local Abort' (sending 'MAP\_U\_ABORT\_req'). All three paths lead to a final 'Null' state after releasing the handover number. + +1520 + +1521 + +Figure 19.2/7: Process HO\_VLR\_B + +## 19.3 Fault recovery procedures + +1523 When a location register has restarted after a fault, the fault recovery procedures ensure that the subscriber data in the + 1524 VLR or in the SGSN become consistent with the subscriber data that are stored in the HLR for the MS concerned and + 1525 that the location information in the HLR , the VLR and the SGSN reflect accurately the current location of the MS. + +1526 The stage 2 specification of fault recovery procedures in location registers is 3GPP TS 23.007 [19]. + +### 19.3.1 VLR fault recovery procedures + +#### 19.3.1.1 General + +1529 Restoration of an IMSI record in a VLR can be triggered by a location registration request from the MS or by a request + 1530 from the HLR for a roaming number to route a mobile terminated call to the MS. If the restoration is triggered by a + 1531 location registration request from the MS, the VLR performs the location updating procedure described in + 1532 3GPP TS 23.012 [23] and clause 19.1.1 of the present document. If the restoration is triggered by a request for a + 1533 roaming number, the VLR provides the roaming number and triggers an independent dialogue to restore the subscriber + 1534 data as described in 3GPP TS 23.018 [97]. The message flow for data restoration triggered by a request for a roaming + 1535 number is shown in figure 19.3.1/1. + +![Sequence diagram showing the message flow for data restoration between a VLR and an HLR. The diagram consists of two vertical lifelines labeled 'VLR' and 'HLR'. The sequence of messages is as follows: 1) A message from HLR to VLR; 2) A message from VLR to HLR; 3) A message from HLR to VLR; 4) A message from VLR to HLR; 5) A message from HLR to VLR; 6) A message from VLR to HLR; 7) A message from HLR to VLR; 8) A message from VLR to HLR; 9) A message from HLR to VLR; 10) A message from VLR to HLR.](3602573ad341ace82ec8fb6c8cc5cf42_img.jpg) + +Sequence diagram showing the message flow for data restoration between a VLR and an HLR. The diagram consists of two vertical lifelines labeled 'VLR' and 'HLR'. The sequence of messages is as follows: 1) A message from HLR to VLR; 2) A message from VLR to HLR; 3) A message from HLR to VLR; 4) A message from VLR to HLR; 5) A message from HLR to VLR; 6) A message from VLR to HLR; 7) A message from HLR to VLR; 8) A message from VLR to HLR; 9) A message from HLR to VLR; 10) A message from VLR to HLR. + +1536 + +- 1537 +- 1538 1) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind +- 1539 2) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf +- 1540 3) *MAP\_SEND\_AUTHENTICATION\_INFO\_req/ind* (Note 1, note 2) +- 1541 4) *MAP\_SEND\_AUTHENTICATION\_INFO\_rsp/cnf* (Note 1, note 2) +- 1542 5) MAP\_RESTORE\_DATA\_req/ind +- 1543 6) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 1, note 3) +- 1544 7) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 1, note 3) +- 1545 8) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 1546 9) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 1547 10) MAP\_RESTORE\_DATA\_rsp/cnf + +1548 + +1549 NOTE 1: Services printed in *italics* are optional. + +1550 NOTE 2: If authentication is required. + +1551 NOTE 3: If subscriber tracing is active in the HLR. + +1552 + +1553 + +**Figure 19.3/1: Message flow for VLR restoration at mobile terminated call set-up** + +1554 **19.3.1.2 Procedure in the VLR** + +1555 The procedure in the VLR to handle a dialogue for subscriber data restoration is defined in clause 21.2.6 of the present + +1556 document. + +1557 **19.3.1.3 Procedure in the HLR** + +1558 The MAP process in the HLR to handle a request for data restoration in the VLR is shown in figure 19.3.1/2. The MAP + +1559 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +1560 Check\_Indication see clause 25.2.1; + +1561 Control\_Tracing\_With\_VLR\_HLR see clause 25.9.6. + +1562 + +![Flowchart for process Restore_Data_HLR. It starts with an entry point, followed by 'Null', 'MAP RESTORE DATA_ind', and 'Check_Indication'. From 'Check_Indication', an 'OK' path leads to 'IMSIs known?'. If 'No', it goes to 'Set User Error: Unknown subscriber' and then to an 'Error' exit. If 'Yes', it goes to 'LMSI received?'. If 'No', it goes to 'Set User Error: System failure' and then to an 'Error' exit. If 'Yes', it goes to 'Update LMSI', then 'Subscriber tracing active in VLR:=False', then 'Control_Tracing_With_VLR_HLR'. From 'Control_Tracing_With_VLR_HLR', an 'OK' path leads to 'Insert Subs_Data Framed_HLR', which then leads to a connector '1'. An 'Error' path from 'Control_Tracing_With_VLR_HLR' leads to 'Set User Error: System failure' and then to an 'Error' exit. An 'Aborted' path from 'Control_Tracing_With_VLR_HLR' leads to an 'X' symbol. From connector '1', the flow goes to 'MNRF set?'. If 'No', it goes to an 'Error' exit. If 'Yes', it goes to 'Set: MNRF', then 'Set: HLR number', then to an exit block containing 'MAP RESTORE DATA_rsp' and 'MAP_CLOSE_req'.](3fe4863bfa4bc82904128d9adde9a00b_img.jpg) + +**process Restore\_Data\_HLR** **RD\_HLR1(1)** + +Process in the HLR to handle a request from the VLR to restore subscriber data + +Signals to/from the left are to/from the VLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> MAP_IND{MAP RESTORE DATA_ind} + MAP_IND --> Check[Check_Indication] + Check -- OK --> IMSI{IMSIs known?} + IMSI -- No --> Error1[Set User Error: Unknown subscriber] + Error1 --> ErrorExit1(( )) + IMSI -- Yes --> LMSI{LMSI received?} + LMSI -- No --> Error2[Set User Error: System failure] + Error2 --> ErrorExit2(( )) + LMSI -- Yes --> Update[Update LMSI] + Update --> Tracing[Subscriber tracing active in VLR:=False] + Tracing --> Control[Control_Tracing_With_VLR_HLR] + Control -- OK --> Insert[Insert Subs_Data Framed_HLR] + Insert -- OK --> Connector1((1)) + Control -- Error --> Error3[Set User Error: System failure] + Error3 --> ErrorExit3(( )) + Control -- Aborted --> X1((X)) + Connector1 --> MNRF{MNRF set?} + MNRF -- No --> ErrorExit4(( )) + MNRF -- Yes --> SetMNRF[Set: MNRF] + SetMNRF --> SetHLR[Set: HLR number] + SetHLR --> ExitBlock[MAP RESTORE DATA_rsp +MAP_CLOSE_req] + ExitBlock --> X2((X)) + +``` + +Flowchart for process Restore\_Data\_HLR. It starts with an entry point, followed by 'Null', 'MAP RESTORE DATA\_ind', and 'Check\_Indication'. From 'Check\_Indication', an 'OK' path leads to 'IMSIs known?'. If 'No', it goes to 'Set User Error: Unknown subscriber' and then to an 'Error' exit. If 'Yes', it goes to 'LMSI received?'. If 'No', it goes to 'Set User Error: System failure' and then to an 'Error' exit. If 'Yes', it goes to 'Update LMSI', then 'Subscriber tracing active in VLR:=False', then 'Control\_Tracing\_With\_VLR\_HLR'. From 'Control\_Tracing\_With\_VLR\_HLR', an 'OK' path leads to 'Insert Subs\_Data Framed\_HLR', which then leads to a connector '1'. An 'Error' path from 'Control\_Tracing\_With\_VLR\_HLR' leads to 'Set User Error: System failure' and then to an 'Error' exit. An 'Aborted' path from 'Control\_Tracing\_With\_VLR\_HLR' leads to an 'X' symbol. From connector '1', the flow goes to 'MNRF set?'. If 'No', it goes to an 'Error' exit. If 'Yes', it goes to 'Set: MNRF', then 'Set: HLR number', then to an exit block containing 'MAP RESTORE DATA\_rsp' and 'MAP\_CLOSE\_req'. + +1563 + +1564 + +Figure 19.3.1/2: Process Restore\_Data\_HLR + +1565 **19.3.2 HLR fault recovery procedures** + +1566 **19.3.2.1 General** + +1567 For the HLR, periodic back-up of data to non-volatile memory is mandatory. + +1568 Data that have been changed after the last back-up and before the restart of the HLR cannot be recovered by reload from + 1569 the non-volatile memory. Therefore, a restoration procedure is triggered for each IMSI record that has been affected by + 1570 the HLR fault at the first authenticated radio contact with the MS concerned. + +1571 As an implementation option, a notification can be forwarded to the MS to alert the subscriber to check the parameters + 1572 for supplementary services that allow subscriber controlled input (MAP\_FORWARD\_CHECK\_SS\_INDICATION + 1573 service). If the VLR receives this notification from the HLR it shall forward the notification to the MS. If the Gs- + 1574 interface is implemented the VLR shall not forward this notification. + +1575 A restoration procedure may also be triggered for IMSI records that shares subscription data with other IMSI records + 1576 when the shared subscription data is modified, added or deleted. This option presumes the support of Reset-IDs. + +1577 The message flow for HLR restoration for a non-GPRS subscriber is shown in figure 19.3.2/1. + +1578 The message flow for HLR restoration for a GPRS subscriber is shown in figure 19.3.2/2. + +![Sequence diagram showing message flow between MSC, VLR, and HLR for HLR restoration. The diagram consists of three vertical lifelines: MSC, VLR, and HLR. The sequence of messages is: 1. HLR to VLR (MAP_RESET_req/ind); 2. MSC to VLR (MAP_PROCESS_ACCESS_REQUEST_req/ind); 3. VLR to HLR (MAP_UPDATE_LOCATION_req/ind); 4. HLR to VLR (MAP_ACTIVATE_TRACE_MODE_req/ind); 5. VLR to HLR (MAP_ACTIVATE_TRACE_MODE_rsp/cnf); 6. HLR to VLR (MAP_INSERT_SUBSCRIBER_DATA_req/ind); 7. VLR to HLR (MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf); 8. HLR to VLR (MAP_UPDATE_LOCATION_rsp/cnf); 9. VLR to HLR (MAP_FORWARD_CHECK_SS_INDICATION_req/ind); 10. HLR to MSC (MAP_FORWARD_CHECK_SS_INDICATION_req/ind).](0a2fb1366851831edc7041ad2e47bdc4_img.jpg) + +Sequence diagram showing message flow between MSC, VLR, and HLR for HLR restoration. The diagram consists of three vertical lifelines: MSC, VLR, and HLR. The sequence of messages is: 1. HLR to VLR (MAP\_RESET\_req/ind); 2. MSC to VLR (MAP\_PROCESS\_ACCESS\_REQUEST\_req/ind); 3. VLR to HLR (MAP\_UPDATE\_LOCATION\_req/ind); 4. HLR to VLR (MAP\_ACTIVATE\_TRACE\_MODE\_req/ind); 5. VLR to HLR (MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf); 6. HLR to VLR (MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind); 7. VLR to HLR (MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf); 8. HLR to VLR (MAP\_UPDATE\_LOCATION\_rsp/cnf); 9. VLR to HLR (MAP\_FORWARD\_CHECK\_SS\_INDICATION\_req/ind); 10. HLR to MSC (MAP\_FORWARD\_CHECK\_SS\_INDICATION\_req/ind). + +1579 + +- 1580 +- 1581 1) MAP\_RESET\_req/ind +- 1582 2) MAP\_PROCESS\_ACCESS\_REQUEST\_req/ind +- 1583 3) MAP\_UPDATE\_LOCATION\_req/ind +- 1584 4) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 1, Note 2) +- 1585 5) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 1, Note 2) +- 1586 6) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 1587 7) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 1588 8) MAP\_UPDATE\_LOCATION\_rsp/cnf +- 1589 9) *MAP\_FORWARD\_CHECK\_SS\_INDICATION\_req/ind* (Note 1) +- 1590 10) *MAP\_FORWARD\_CHECK\_SS\_INDICATION\_req/ind* (Note 1) + +1591 + +1592 NOTE 1: Services printed in *italics* are optional. + +1593 NOTE 2: If subscriber tracing is active in the HLR. + +1594 +1595 +1596 +1597 + +Steps 2 to 10 may be skipped if the procedure is used to update shared subscription data. + +**Figure 19.3.2/1: Message flow for HLR restoration (non-GPRS)** + +1598 + +![Sequence diagram for HLR restoration (non-GPRS) showing message flow between SGSN and HLR. The diagram consists of two vertical lifelines: SGSN on the left and HLR on the right. Seven numbered messages are shown: 1) SGSN to HLR, 2) HLR to SGSN (with a break in the line), 3) SGSN to HLR, 4) HLR to SGSN, 5) SGSN to HLR, 6) HLR to SGSN, 7) SGSN to HLR.](8cebaca6b0616289d83a5dd723276e65_img.jpg) + +Sequence diagram for HLR restoration (non-GPRS) showing message flow between SGSN and HLR. The diagram consists of two vertical lifelines: SGSN on the left and HLR on the right. Seven numbered messages are shown: 1) SGSN to HLR, 2) HLR to SGSN (with a break in the line), 3) SGSN to HLR, 4) HLR to SGSN, 5) SGSN to HLR, 6) HLR to SGSN, 7) SGSN to HLR. + +1599 + +1600 +1601 +1602 +1603 +1604 +1605 +1606 +1607 + +- 1) MAP\_RESET\_req/ind +- 2) MAP\_UPDATE\_GPRS\_LOCATION\_req/ind +- 3) *MAP\_ACTIVATE\_TRACE\_MODE\_req/ind* (Note 1, Note 2) +- 4) *MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf* (Note 1, Note 2) +- 5) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 6) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 7) MAP\_UPDATE\_GPRS\_LOCATION\_rsp/cnf + +NOTE 1: Services printed in *italics* are optional. +NOTE 2: If subscriber tracing is active in the HLR. + +1608 +1609 +1610 +1611 +1612 +1613 +1614 +1615 + +Steps 2 to 7 may be skipped if the procedure is used to update shared subscription data. + +**Figure 19.3.2/2: Message flow for HLR restoration (GPRS)** + +1616 **19.3.2.2 Procedure in the HLR** + +1617 The MAP process in the HLR to notify the relevant serving nodes that the HLR has restarted is shown in figure 19.3.2/3. + +1619 The SGSN address list includes one instance of the address of each SGSN in which (according to the HLR data retrieved from the non-volatile memory) there is at least one subscriber registered who is affected by the HLR restart. + +1621 The VLR address list includes one instance of the address of each VLR in which (according to the HLR data retrieved from the non-volatile memory) there is at least one subscriber registered who is affected by the HLR restart. + +1623 The MAP process in the HLR to notify a VLR that the HLR has restarted is shown in figure 19.3.2/4. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1625     Receive\_Open\_Cnf     see clause 25.1.2. + +1626 The MAP process in the HLR to notify an SGSN that the HLR has restarted is shown in figure 19.3.2/5. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1628     Receive\_Open\_Cnf     see clause 25.1.2. + +### 1629 19.3.2.3 Procedure in the VLR + +1630 The MAP process in the VLR to handle a notification that an HLR has restarted is shown in figure 19.3.2/6. The MAP +1631 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1632     Receive\_Open\_Ind     see clause 25.1.1. + +1633 When Reset-IDs are not supported or not present in the MAP\_RESET indication, the VLR uses the HLR number or the +1634 HLR identity list included in the MAP\_RESET indication to identify the IMSI records which are affected by the HLR +1635 restart. + +1636 When Reset-IDs are supported and present in the MAP\_RESET indication, the VLR uses the Reset-IDs included in the +1637 MAP\_RESET indication to identify the affected IMSI records. + +1638 The task "Update Data" includes any required action to let the update come into effect. + +1639 If the update of shared subscription data requires only local updates in the VLR (i.e., the update of the profile does not +1640 imply to initiate any signalling interaction towards other network nodes), the updates should be performed immediately +1641 (e.g. deleting an Operator Determined Barring). + +1642 If the update of shared subscription data implies initiating a signalling interaction towards other nodes, the signalling +1643 towards other nodes should be deferred to the next authenticated radio contact with that UE. + +1644     NOTE:     The rational for the recommendation to defer signalling towards other nodes until the next authenticated +1645                 radio contact is to consider impacts to the network only when the updates are required, and to spread the +1646                 signalling towards other nodes over some time, based on user's activity. + +1647 To avoid high processing/signalling load resulting from shared subscription data update, processing/signalling actions +1648 resulting from data updates in the VLR may take a maximum operator configuration-depending time. + +1649 + +### 1650 19.3.2.4 Procedure in the SGSN + +1651 The MAP process in the SGSN to handle a notification that an HLR has restarted is shown in figure 19.3.2/7. The MAP +1652 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1653     Receive\_Open\_Ind     see clause 25.1.1. + +1654 When Reset-IDs are not supported or not present in the MAP\_RESET indication, the SGSN uses the HLR number or +1655 the HLR identity list included in the MAP\_RESET indication to identify the IMSI records which are affected by the +1656 HLR restart. + +1657 When Reset-IDs are supported and present in the MAP\_RESET indication, the SGSN uses the Reset-IDs included in +1658 the MAP\_RESET indication to identify the affected IMSI records. + +1659 The task "Update Data" includes any required action to let the update come into effect. + +1660 If the update of shared subscription data requires only local updates in the SGSN (i.e., the update of the profile does not +1661 imply to initiate any signalling interaction towards other network nodes), the updates should be performed immediately +1662 (e.g. deleting an Operator Determined Barring). + +1663 If the update of shared subscription data implies initiating a signalling interaction towards other nodes, the signalling +1664 towards other nodes should be deferred to the next authenticated radio contact with that UE. + +1665     NOTE:     The rational for the recommendation to defer signalling towards other nodes until the next authenticated +1666                 radio contact is to consider impacts to the network only when the updates are required, and to spread the +1667                 signalling towards other nodes over some time, based on user's activity. + +1668 To avoid high processing/signalling load resulting from shared subscription data update, processing/signalling actions +1669 resulting from data updates in the SGSN may take a maximum operator configuration-depending time. + +![Flowchart for process Restart_HLR. It starts with an oval, followed by 'Null', 'OM_RESTART_ind', 'Reload data from backup', and then splits into two parallel paths for GPRS and non-GPRS subscribers. The GPRS path involves checking tracing, purging MS, reading SGSN address list, and sending reset messages. The non-GPRS path is similar but uses VLR instead of SGSN. Both paths converge at a connector '1'.](2617157e11d8900104fc3f290e412821_img.jpg) + +**process Restart\_HLR** **R\_HLR1(1)** + +Process in the HLR to notify the relevant serving nodes after an HLR restart + +Signals from the right are from the O&M application in the HLR + +``` + + graph TD + Start([ ]) --> Null1[Null] + Null1 --> OM[OM_RESTART_ind] + OM --> Reload[Reload data from backup] + + Reload --> GPRS_Trace[Subscriber tracing active in SGSN:=False] + GPRS_Trace -.-> GPRS_Trace_Note[For each GPRS subscriber affected by the HLR restart] + + GPRS_Trace --> GPRS_Purge[MS purged for GPRS:=False] + GPRS_Purge -.-> GPRS_Purge_Note[For each GPRS subscriber affected by the HLR restart] + + GPRS_Purge --> GPRS_Read[Read SGSN address list] + + GPRS_Read --> GPRS_Reset[Send_Reset_To_SGSN_HLR] + + GPRS_Reset --> GPRS_All_Notified{All SGSNs notified?} + + GPRS_All_Notified -- No --> GPRS_Reset + GPRS_All_Notified -- Yes --> GPRS_Forward[Forward Check SS indication supported?] + + GPRS_Forward --> GPRS_Required{Check SS required:=True} + + GPRS_Required -.-> GPRS_Required_Note[For each non-GPRS subscriber affected by the HLR restart] + + GPRS_Required --> GPRS_Connector((1)) + + GPRS_Connector --> NonGPRS_Trace[Subscriber tracing active in VLR:=False] + + NonGPRS_Trace -.-> NonGPRS_Trace_Note[For each non-GPRS subscriber affected by the HLR restart] + + NonGPRS_Trace --> NonGPRS_Purge[MS purged:=False] + + NonGPRS_Purge -.-> NonGPRS_Purge_Note[For each non-GPRS subscriber affected by the HLR restart] + + NonGPRS_Purge --> NonGPRS_Read[Read VLR address list] + + NonGPRS_Read --> NonGPRS_Reset[Send_Reset_To_VLR_HLR] + + NonGPRS_Reset --> NonGPRS_All_Notified{All VLRs notified?} + + NonGPRS_All_Notified -- No --> NonGPRS_Reset + NonGPRS_All_Notified -- Yes --> NonGPRS_Null[Null] + +``` + +Flowchart for process Restart\_HLR. It starts with an oval, followed by 'Null', 'OM\_RESTART\_ind', 'Reload data from backup', and then splits into two parallel paths for GPRS and non-GPRS subscribers. The GPRS path involves checking tracing, purging MS, reading SGSN address list, and sending reset messages. The non-GPRS path is similar but uses VLR instead of SGSN. Both paths converge at a connector '1'. + +1670 + +1671 + +**Figure 19.3.2/3: Process Restart\_HLR** + +![A state transition diagram for the process Send_Reset_To_VLR_HLR. It starts at an initial state, transitions to a state with outgoing MAP_OPEN_req, MAP_RESET_req, and MAP_DELIMITER_req messages, then to a 'Receive_Open_Cnf' state. From there, it branches into three paths: 'Vr' leading to 'Perform MAP Vr dialogue', 'OK' leading to a 'MAP_CLOSE_req' state with 'Release method= Prearranged End', and 'Error' leading to a terminal state. Both 'Perform MAP Vr dialogue' and 'MAP_CLOSE_req' lead to terminal states.](81eebff59300420692082c50d4f0d1fc_img.jpg) + +process Send\_Reset\_To\_VLR\_HLR SR\_VLR\_HLR1(1) + +``` + +stateDiagram-v2 + [*] --> S1 + S1 --> S2 : MAP_OPEN_req, MAP_RESET_req, MAP_DELIMITER_req + S2 --> S3 : Receive_Open_Cnf + S3 --> S4 : Vr + S3 --> S5 : OK + S3 --> [*] : Error + S4 --> [*] + S5 --> S6 : Release method= Prearranged End + S5 --> [*] + +``` + +Process in the HLR to send a Reset message to a VLR + +Signals to the left are to the VLR + +MAP\_OPEN\_req +MAP\_RESET\_req +MAP\_DELIMITER\_req + +Receive\_Open\_Cnf + +Vr + +OK + +Error + +Perform MAP Vr dialogue + +MAP\_CLOSE\_req + +Release method= Prearranged End + +A state transition diagram for the process Send\_Reset\_To\_VLR\_HLR. It starts at an initial state, transitions to a state with outgoing MAP\_OPEN\_req, MAP\_RESET\_req, and MAP\_DELIMITER\_req messages, then to a 'Receive\_Open\_Cnf' state. From there, it branches into three paths: 'Vr' leading to 'Perform MAP Vr dialogue', 'OK' leading to a 'MAP\_CLOSE\_req' state with 'Release method= Prearranged End', and 'Error' leading to a terminal state. Both 'Perform MAP Vr dialogue' and 'MAP\_CLOSE\_req' lead to terminal states. + +1672 + +1673 + +Figure 19.3.2/4: Process Send\_Reset\_To\_VLR\_HLR + +![State transition diagram for process Send_Reset_To_VLR_HLR. It starts at an initial state, transitions to a state with MAP_OPEN_req, MAP_RESET_req, and MAP_DELIMITER_req. From there, it goes to a 'Receive_Open_Cnf' state. A transition labeled 'OK' leads to a 'MAP_CLOSE_req' state, which is associated with 'Release method = Prearranged End'. A transition labeled 'Vr' leads to a 'Perform MAP Vr dialogue' state. Both 'Perform MAP Vr dialogue' and 'MAP_CLOSE_req' lead to terminal states (X). A transition labeled 'Error' from 'Receive_Open_Cnf' also leads to a terminal state (X). Notes indicate the process is in the HLR sending a Reset message to a VLR, and signals to the left are to the VLR.](4f33a6e9083ffb400e3c2e074c21434e_img.jpg) + +process Send\_Reset\_To\_VLR\_HLR SR\_VLR\_HLR1(1) + +``` + +stateDiagram-v2 + [*] --> State1 + State1 --> State2 : MAP_OPEN_req, MAP_RESET_req, MAP_DELIMITER_req + State2 --> State3 : Receive_Open_Cnf + State3 --> State4 : OK + State3 --> State5 : Vr + State3 --> [*] : Error + State4 --> [*] + State5 --> [*] + note right of State1 : Process in the HLR to send a Reset message to a VLR + note right of State2 : Signals to the left are to the VLR + note right of State4 : Release method = Prearranged End + +``` + +State transition diagram for process Send\_Reset\_To\_VLR\_HLR. It starts at an initial state, transitions to a state with MAP\_OPEN\_req, MAP\_RESET\_req, and MAP\_DELIMITER\_req. From there, it goes to a 'Receive\_Open\_Cnf' state. A transition labeled 'OK' leads to a 'MAP\_CLOSE\_req' state, which is associated with 'Release method = Prearranged End'. A transition labeled 'Vr' leads to a 'Perform MAP Vr dialogue' state. Both 'Perform MAP Vr dialogue' and 'MAP\_CLOSE\_req' lead to terminal states (X). A transition labeled 'Error' from 'Receive\_Open\_Cnf' also leads to a terminal state (X). Notes indicate the process is in the HLR sending a Reset message to a VLR, and signals to the left are to the VLR. + +1674 + +1675 + +Figure 19.3.2/5: Process Send\_Reset\_To\_SGSN\_HLR + +![Flowchart for Process Receive_Reset_VLR](64ae0196fdf7931139d52ac102898ef9_img.jpg) + +The diagram is a flowchart titled 'Process Receive\_Reset\_VLR'. It begins at the top with a rectangular process block, which points down to a decision diamond. From this diamond, one path leads to a cylinder-shaped data store on the left, and the other leads to a rectangular process block on the right. The right path continues through a series of rectangular process blocks and a decision diamond. From this second decision diamond, one path leads to a cylinder-shaped data store on the right, and the other leads to a rectangular process block on the left. This left path then passes through another decision diamond and ends at a third cylinder-shaped data store at the bottom. The right path from the second decision diamond also passes through a rectangular process block and ends at a third cylinder-shaped data store on the right. The entire flowchart is enclosed in a large rectangular frame. Above the frame, there are two large black rectangular redaction blocks. The top redaction block covers the upper portion of the page, and the bottom redaction block covers a horizontal strip just above the flowchart's top border. To the right of the bottom redaction block, a small cylinder-shaped data store is partially visible. + +Flowchart for Process Receive\_Reset\_VLR + +1676 +1677 + +**Figure 19.3.2/6: Process Receive\_Reset\_VLR** + +![A flowchart diagram titled 'Process Receive_Reset_SGSN'. The diagram is partially obscured by two large black rectangular redaction boxes at the top. The visible portion shows a sequence of steps: a rectangular process block, a decision diamond, and a loop. The loop contains a rectangular process block, a decision diamond, and a connector oval. The main path continues from the first decision diamond to another rectangular process block, which then leads to a second decision diamond. This second decision diamond has two branches, each consisting of a rectangular process block followed by a connector oval. A dashed box is also visible next to the second rectangular process block.](4bad0d660ca8b0915540efeb317f3ae6_img.jpg) + +``` +graph TD; A[ ] --> B{ }; B --> C[ ]; C --> D{ }; D --> E[ ]; E --> F{ }; F --> G[ ]; G --> H[ ]; H --> I([ ]); F --> J[ ]; J --> K[ ]; K --> L([ ]); +``` + +A flowchart diagram titled 'Process Receive\_Reset\_SGSN'. The diagram is partially obscured by two large black rectangular redaction boxes at the top. The visible portion shows a sequence of steps: a rectangular process block, a decision diamond, and a loop. The loop contains a rectangular process block, a decision diamond, and a connector oval. The main path continues from the first decision diamond to another rectangular process block, which then leads to a second decision diamond. This second decision diamond has two branches, each consisting of a rectangular process block followed by a connector oval. A dashed box is also visible next to the second rectangular process block. + +1678 + +1679 + +**Figure 19.3.2/7: Process Receive\_Reset\_SGSN** + +1680 **19.3.3 CSS fault recovery procedures** + +1681 **19.3.3.1 General** + +1682 For the CSS, periodic back-up of data to non-volatile memory is mandatory. + +1683 Serving node numbers that have been changed after the last back-up and before the restart of the CSS cannot be +1684 recovered by reload from the non-volatile memory. Therefore, a restoration procedure is triggered for each IMSI record +1685 that has been affected by the CSS fault at the first authenticated radio contact with the MS concerned. + +1686 The message flow for CSS restoration for a non-GPRS subscriber is shown in figure 19.3.3/1. + +1687 The message flow for CSS restoration for a GPRS subscriber is shown in figure 19.3.3/2. + +![Sequence diagram for non-GPRS CSS restoration between VLR and CSS.](5e6399e6cc782a35c8e0c1aaceaadcb2_img.jpg) + +A sequence diagram showing the message flow for CSS restoration for a non-GPRS subscriber. The diagram consists of two vertical lifelines: VLR on the left and CSS on the right. The interaction is as follows: 1) A message labeled '1' is sent from the VLR lifeline to the CSS lifeline. 2) A message labeled '2' is sent from the CSS lifeline to the VLR lifeline. 3) A message labeled '3' is sent from the VLR lifeline to the CSS lifeline. 4) A message labeled '4' is sent from the CSS lifeline to the VLR lifeline. 5) A message labeled '5' is sent from the VLR lifeline to the CSS lifeline. The messages are represented by horizontal arrows with small numbered boxes next to them. + +Sequence diagram for non-GPRS CSS restoration between VLR and CSS. + +1688 + +1689 + +1690 + +1691 + +1692 + +1693 + +1694 + +1695 + +1696 + +1697 + +- 1) MAP\_RESET\_req/ind +- 2) MAP\_UPDATE\_VCSG\_LOCATION\_req/ind +- 3) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +- 4) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +- 5) MAP\_UPDATE\_VCSG\_LOCATION\_rsp/cnf + +**Figure 19.3.3/1: Message flow for CSS restoration (non-GPRS)** + +1698 + +![Sequence diagram for GPRS CSS restoration between SGSN and CSS.](76c03f7b5abcc83130e66d006621a2cf_img.jpg) + +A sequence diagram showing the message flow for CSS restoration for a GPRS subscriber. The diagram consists of two vertical lifelines: SGSN on the left and CSS on the right. The interaction is as follows: 1) A message labeled '1' is sent from the SGSN lifeline to the CSS lifeline. 2) A message labeled '2' is sent from the CSS lifeline to the SGSN lifeline. 3) A message labeled '3' is sent from the SGSN lifeline to the CSS lifeline. 4) A message labeled '4' is sent from the CSS lifeline to the SGSN lifeline. 5) A message labeled '5' is sent from the SGSN lifeline to the CSS lifeline. The messages are represented by horizontal arrows with small numbered boxes next to them. + +Sequence diagram for GPRS CSS restoration between SGSN and CSS. + +1699 + +1700 + +1701 + +1702 + +- 1) MAP\_RESET\_req/ind +- 2) MAP\_UPDATE\_VCSG\_LOCATION\_req/ind + +1703 3) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind +1704 4) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf +1705 5) MAP\_UPDATE\_VCSG\_LOCATION\_rsp/cnf +1706 +1707 +1708 + +**Figure 19.3.3/2: Message flow for CSS restoration (GPRS)** + +### 1709 19.3.3.2 Procedure in the CSS + +1710 The MAP process in the CSS to notify the relevant serving nodes that the CSS has restarted is shown in figure 19.3.3/3. + +1711 The SGSN address list includes one instance of the address of each SGSN in which (according to the CSS data retrieved +1712 from the non-volatile memory) there is at least one subscriber registered who is affected by the CSS restart. + +1713 The VLR address list includes one instance of the address of each VLR in which (according to the CSS data retrieved +1714 from the non-volatile memory) there is at least one subscriber registered who is affected by the CSS restart. + +1715 The MAP process in the CSS to notify a VLR that the CSS has restarted is shown in figure 19.3.3/4. The MAP process +1716 invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1717 Receive\_Open\_Cnf see clause 25.1.2. + +1718 The MAP process in the CSS to notify an SGSN that the CSS has restarted is shown in figure 19.3.3/5. The MAP +1719 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1720 Receive\_Open\_Cnf see clause 25.1.2. + +### 1721 19.3.3.3 Procedure in the VLR + +1722 The MAP process in the VLR to handle a notification that a CSS has restarted is shown in figure 19.3.3/6. The MAP +1723 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1724 Receive\_Open\_Ind see clause 25.1.1. + +1725 The VLR uses the CSS number (filled in Sending Node number parameter) included in the MAP\_RESET indication to +1726 identify the user's IMSI records which are affected by the CSS restart. + +### 1727 19.3.3.4 Procedure in the SGSN + +1728 The MAP process in the SGSN to handle a notification that a CSS has restarted is shown in figure 19.3.3/6. The MAP +1729 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1730 Receive\_Open\_Ind see clause 25.1.1. + +1731 The SGSN uses the CSS number (filled in Sending Node number parameter) included in the MAP\_RESET indication to +1732 identify the user's IMSI records which are affected by the CSS restart. + +![Flowchart for process Restart_CSS. It starts with an oval, followed by 'Null', 'OM_RESTART_ind', 'Reload data from backup', and 'Read SGSN address list'. A loop exists for 'Send_Reset_To_SGSN_CSS' and 'All SGSNs notified?'. A connector '1' leads to the second part: 'Read VLR address list', 'Send_Reset_To_VLR_CSS', 'All VLRs notified?', and finally 'Null'.](4ecc29a3c000f2a2409ade321df55f28_img.jpg) + +**process Restart\_CSS** **R\_CSS1(1)** + +Process in the CSS to notify the relevant serving nodes after a CSS restart + +Signals from the right are from the O&M application in the CSS + +``` + +graph TD + Start([ ]) --> Null1[Null] + Null1 --> OM[OM_RESTART_ind] + OM --> Reload[Reload data from backup] + Reload --> ReadSGSN[Read SGSN address list] + ReadSGSN --> SendSGSN[Send_Reset_To_SGSN_CSS] + SendSGSN --> AllSGSNs{All SGSNs notified?} + AllSGSNs -- No --> SendSGSN + AllSGSNs -- Yes --> 1((1)) + 1 --> ReadVLR[Read VLR address list] + ReadVLR --> SendVLR[Send_Reset_To_VLR_CSS] + SendVLR --> AllVLRs{All VLRs notified?} + AllVLRs -- No --> SendVLR + AllVLRs -- Yes --> Null2[Null] + +``` + +Flowchart for process Restart\_CSS. It starts with an oval, followed by 'Null', 'OM\_RESTART\_ind', 'Reload data from backup', and 'Read SGSN address list'. A loop exists for 'Send\_Reset\_To\_SGSN\_CSS' and 'All SGSNs notified?'. A connector '1' leads to the second part: 'Read VLR address list', 'Send\_Reset\_To\_VLR\_CSS', 'All VLRs notified?', and finally 'Null'. + +1733 + +1734 + +Figure 19.3.3/3: Process Restart\_CSS + +![Sequence diagram for process Send_Reset_To_VLR_CSS. The diagram shows a vertical timeline starting with an initial node, followed by a left-pointing arrow representing a request. A box next to the arrow lists 'MAP_OPEN_req', 'MAP_RESET_req', and 'MAP_DELIMITER_req'. Below the arrow is a 'Receive_Open_Cnf' box. From this box, two paths emerge: one labeled 'OK' leading to a right-pointing arrow representing a response, and another labeled 'Vr, Error' leading to an 'X' (error). The right-pointing arrow is next to a box containing 'Release method:= Prearranged End'. The sequence ends with an 'X' at the bottom of the timeline.](5ae965392e3ed6f9493eff40d2f1cc3e_img.jpg) + +process Send\_Reset\_To\_VLR\_CSS SR\_VLR\_CSS1(1) + +Process in the CSS to send a Reset message to a VLR + +Signals to the left are to the VLR + +MAP\_OPEN\_req +MAP\_RESET\_req +MAP\_DELIMITER\_req + +Receive\_Open\_Cnf + +OK + +Vr, Error + +MAP\_CLOSE\_req + +Release method:= +Prearranged End + +Sequence diagram for process Send\_Reset\_To\_VLR\_CSS. The diagram shows a vertical timeline starting with an initial node, followed by a left-pointing arrow representing a request. A box next to the arrow lists 'MAP\_OPEN\_req', 'MAP\_RESET\_req', and 'MAP\_DELIMITER\_req'. Below the arrow is a 'Receive\_Open\_Cnf' box. From this box, two paths emerge: one labeled 'OK' leading to a right-pointing arrow representing a response, and another labeled 'Vr, Error' leading to an 'X' (error). The right-pointing arrow is next to a box containing 'Release method:= Prearranged End'. The sequence ends with an 'X' at the bottom of the timeline. + +1735 + +1736 + +Figure 19.3.3/4: Process Send\_Reset\_To\_VLR\_CSS + +![SDL diagram for process Send_Reset_To_SGSN_CSS showing the sequence of sending MAP_OPEN_req, MAP_RESET_req, and MAP_DELIMITER_req, receiving an Open_Cnf, and then either closing the connection if OK or terminating if an error occurs.](53668fc0567b0e9fce35a73e32dcee59_img.jpg) + +process Send\_Reset\_To\_SGSN\_CSS +SR\_SGSN\_CSS1(1) + + + +``` + + graph TD + Start([ ]) --> Output1[MAP_OPEN_req +MAP_RESET_req +MAP_DELIMITER_req] + Output1 --> Input1[Receive_Open_Cnf] + Input1 --> Decision{ } + Decision -- OK --> Output2[MAP_CLOSE_req] + Output2 --- Comment[Release method= +Prearranged End] + Output2 --> End1((X)) + Decision -- "Vr, Error" --> End2((X)) + + subgraph Callouts + direction LR + C1[Process in the CSS to +send a Reset message to +an SGSN] + C2[Signals to the left +are to the SGSN] + end + +``` + +SDL diagram for process Send\_Reset\_To\_SGSN\_CSS showing the sequence of sending MAP\_OPEN\_req, MAP\_RESET\_req, and MAP\_DELIMITER\_req, receiving an Open\_Cnf, and then either closing the connection if OK or terminating if an error occurs. + +1737 + +1738 + +**Figure 19.3.3/5: Process Send\_Reset\_To\_SGSN\_CSS** + +![Flowchart for process Receive_Reset_From_CSS_VLR. It starts with an initial node, followed by 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and an error path labeled 'Vr, Error' leads to 'Null'. From 'Wait_For_Service_Primitive', two parallel paths emerge: 'MAP_P_ABORT_ind' leading to 'Null', and 'MAP_RESET_ind' leading to 'MAP_CLOSE_req'. 'MAP_CLOSE_req' has a note 'Release method:= Prearranged End' and leads to 'Identify IMSI records'. 'Identify IMSI records' leads to 'Location information confirmed by CSS:=False', which has a note 'For each identified IMSI record'. Finally, it leads to 'Null'.](fad4b22bbd4eb39d94bd3c80cea4cc13_img.jpg) + +process **Receive\_Reset\_From\_CSS\_VLR** RR\_CSS\_VLR1(1) + +Process in the VLR to handle a Reset message from the CSS + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null1[Null] + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- OK --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + Receive_Open_Ind -- "Vr, Error" --> Null2[Null] + Wait_For_Service_Primitive --> MAP_P_ABORT_ind[/MAP_P_ABORT_ind/] + Wait_For_Service_Primitive --> MAP_RESET_ind[/MAP_RESET_ind/] + MAP_P_ABORT_ind --> Null3[Null] + MAP_RESET_ind --> MAP_CLOSE_req[/MAP_CLOSE_req/] + MAP_CLOSE_req -- "Release method:= Prearranged End" --> Identify_IMSI_records[Identify IMSI records] + Identify_IMSI_records --> Location_Information_Confirmed[Location information confirmed by CSS:=False] + Location_Information_Confirmed -- "For each identified IMSI record" --> Null4[Null] + +``` + +Flowchart for process Receive\_Reset\_From\_CSS\_VLR. It starts with an initial node, followed by 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and an error path labeled 'Vr, Error' leads to 'Null'. From 'Wait\_For\_Service\_Primitive', two parallel paths emerge: 'MAP\_P\_ABORT\_ind' leading to 'Null', and 'MAP\_RESET\_ind' leading to 'MAP\_CLOSE\_req'. 'MAP\_CLOSE\_req' has a note 'Release method:= Prearranged End' and leads to 'Identify IMSI records'. 'Identify IMSI records' leads to 'Location information confirmed by CSS:=False', which has a note 'For each identified IMSI record'. Finally, it leads to 'Null'. + +1739 + +1740 + +**Figure 19.3.3/6: Process Receive\_Reset\_From\_CSS\_VLR** + +![Flowchart for process Receive_Reset_From_CSS_SGSN. The process starts at an entry point, goes to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to 'Null'. From 'Wait_For_Service_Primitive', two paths emerge: 'MAP_P_ABORT_ind' leading to 'Null' and 'MAP_RESET_ind' leading to 'MAP_CLOSE_req'. 'MAP_CLOSE_req' has an associated note 'Release method:= Prearranged End' and leads to 'Identify IMSI records'. 'Identify IMSI records' leads to 'Location information confirmed by CSS:=False', which has an associated note 'For each identified IMSI record'. Finally, it leads to 'Null'.](ac991aadd44a0ddcae4451e75069dbdc_img.jpg) + +process Receive\_Reset\_From\_CSS\_SGSN RR\_CSS\_SGSN1(1) + +Process in the SGSN to handle a Reset message from the CSS + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Entry([ ]) --> Null1[Null] + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- OK --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + Receive_Open_Ind -- Vr, Error --> Null2[Null] + Wait_For_Service_Primitive --> MAP_P_ABORT_ind{MAP_P_ABORT_ind} + Wait_For_Service_Primitive --> MAP_RESET_ind{MAP_RESET_ind} + MAP_P_ABORT_ind --> Null3[Null] + MAP_RESET_ind --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_CLOSE_req -.-> Note1[Release method:= Prearranged End] + MAP_CLOSE_req --> Identify_IMSI_records[Identify IMSI records] + Identify_IMSI_records --> Location_Information_Confirmed[Location information confirmed by CSS:=False] + Location_Information_Confirmed -.-> Note2[For each identified IMSI record] + Location_Information_Confirmed --> Null4[Null] + +``` + +Flowchart for process Receive\_Reset\_From\_CSS\_SGSN. The process starts at an entry point, goes to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to 'Null'. From 'Wait\_For\_Service\_Primitive', two paths emerge: 'MAP\_P\_ABORT\_ind' leading to 'Null' and 'MAP\_RESET\_ind' leading to 'MAP\_CLOSE\_req'. 'MAP\_CLOSE\_req' has an associated note 'Release method:= Prearranged End' and leads to 'Identify IMSI records'. 'Identify IMSI records' leads to 'Location information confirmed by CSS:=False', which has an associated note 'For each identified IMSI record'. Finally, it leads to 'Null'. + +1741 + +1742 + +Figure 19.3.3/7: Process Receive\_Reset\_From\_CSS\_SGSN + +## 1743 19.4 Mobility Management event notification procedure + +### 1744 19.4.1 General + +1745 The Mobility Management event notification procedure is used to notify a gsmSCF about the successful completion of a + 1746 Mobility Management event. + +1747 The message flow for Mobility Management event notification is shown in figure 19.4/1. + +![Sequence diagram showing message flow between VLR or SGSN and gsmSCF. Step 1: VLR or SGSN sends a message to gsmSCF. Step 2: gsmSCF sends a response back to VLR or SGSN.](07c40b9688931ac29fe8f71c02a2edcc_img.jpg) + +``` +sequenceDiagram + participant VLR or SGSN + participant gsmSCF + Note right of gsmSCF: 1 + VLR or SGSN->>gsmSCF: + Note left of VLR or SGSN: 2 + gsmSCF-->>VLR or SGSN: +``` + +Sequence diagram showing message flow between VLR or SGSN and gsmSCF. Step 1: VLR or SGSN sends a message to gsmSCF. Step 2: gsmSCF sends a response back to VLR or SGSN. + +1748 + +1749 + +1750 1) MAP\_REPORT\_MM\_EVENT\_req/ind + +1751 2) MAP\_REPORT\_MM\_EVENT\_rsp/cnf + +1752 + +1753 + +**Figure 19.5/1: Message flow for Mobility Management event notification** + +## 1754 19.4.2 Procedure in the VLR or SGSN + +1755 The MAP process in the VLR or the SGSN to report a Mobility Management event to the gsmSCF is shown in figure + +1756 19.4/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as + +1757 follows: + +1758    Receive\_Open\_Cnf       see clause 25.1.2; + +1759    Check\_Confirmation:     see clause 25.2.2. + +## 1760 19.4.3 Procedure in the gsmSCF + +1761 The MAP process in the gsmSCF to handle the report of a Mobility Management event is shown in figure 19.4/3. The + +1762 MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1763    Receive\_Open\_Ind       see clause 25.1.1; + +![Flowchart for process Notify_MM_Event_VLR_Or_SGSN. The process starts with an initial state, followed by a 'Null' state. It then sends an MM event notification. A decision block on the right lists MAP_OPEN_req, MAP_REPORT_MM_EVENT_req, and MAP_DELIMITER_req. The flow proceeds to 'Receive_Open_Cnf'. From there, an 'OK' path leads to 'Wait_For_gsmSCF_Response', while a 'Vr, Error' path leads to an 'Abort' state and then 'Null'. From 'Wait_For_gsmSCF_Response', three paths emerge: 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req', a middle path leading to a block with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', and 'MAP_REPORT_MM_EVENT_cnf' leading to 'Check_Confirmation'. 'MAP_CLOSE_req' leads to 'Set negative response: System failure'. The middle block leads to 'Set negative response: System failure'. 'Check_Confirmation' has three outcomes: 'Provider Error, Data Error' leading to 'Set negative response: System failure', 'User Error' leading to 'Set negative response', and 'OK' leading to a decision block. All three 'Set negative response' blocks lead to a merge point. From this merge point, one path leads to a decision block for 'Send MM event notification negative response' and then to 'Null'. The 'OK' path from 'Check_Confirmation' leads to a decision block for 'Send MM event notification ack' and then to 'Null'.](a125eb91cd79c79645898152eb2a9c94_img.jpg) + +process Notify\_MM\_Event\_VLR\_Or\_SGSN + +NMME\_VLR\_SGSN1(1) + +Process in the VLR or SGSN to notify the gsmSCF of a mobility management event + +Signals to/from the left are to/from the location management application process in the VLR (see 3GPP TS 23.012) or the GPRS mobility management application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the gsmSCF + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> SendMM[Send MM event notification] + SendMM --> Decision1{ } + Decision1 -.->|MAP_OPEN_req +MAP_REPORT_MM_EVENT_req +MAP_DELIMITER_req| Right1[ ] + Decision1 --> RecvOpen[Receive_Open_Cnf] + RecvOpen -- OK --> WaitGsmSCF([Wait_For_gsmSCF_Response]) + RecvOpen -- Vr, Error --> Abort{Abort} + Abort --> Null2([Null]) + WaitGsmSCF --> Decision2{ } + Decision2 -- MAP_NOTICE_ind --> MAPCloseReq[MAP_CLOSE_req] + MAPCloseReq --> NegSysFail1[Set negative response: System failure] + Decision2 --> MiddleBlock[ ] + MiddleBlock -.->|MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind| MiddleBlock + MiddleBlock --> NegSysFail2[Set negative response: System failure] + Decision2 -- MAP_REPORT_MM_EVENT_cnf --> CheckConf[Check_Confirmation] + CheckConf -- "Provider Error, Data Error" --> NegSysFail3[Set negative response: System failure] + CheckConf -- User Error --> NegResp[Set negative response] + CheckConf -- OK --> Decision3{ } + NegSysFail1 --> Merge1(( )) + NegSysFail2 --> Merge1 + NegResp --> Merge1 + Merge1 --> Decision4{ } + Decision4 -.->|Send MM event notification negative response| Decision4 + Decision4 --> Null3([Null]) + Decision3 --> Decision5{ } + Decision5 -.->|Send MM event notification ack| Decision5 + Decision5 --> Null4([Null]) + +``` + +Flowchart for process Notify\_MM\_Event\_VLR\_Or\_SGSN. The process starts with an initial state, followed by a 'Null' state. It then sends an MM event notification. A decision block on the right lists MAP\_OPEN\_req, MAP\_REPORT\_MM\_EVENT\_req, and MAP\_DELIMITER\_req. The flow proceeds to 'Receive\_Open\_Cnf'. From there, an 'OK' path leads to 'Wait\_For\_gsmSCF\_Response', while a 'Vr, Error' path leads to an 'Abort' state and then 'Null'. From 'Wait\_For\_gsmSCF\_Response', three paths emerge: 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req', a middle path leading to a block with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', and 'MAP\_REPORT\_MM\_EVENT\_cnf' leading to 'Check\_Confirmation'. 'MAP\_CLOSE\_req' leads to 'Set negative response: System failure'. The middle block leads to 'Set negative response: System failure'. 'Check\_Confirmation' has three outcomes: 'Provider Error, Data Error' leading to 'Set negative response: System failure', 'User Error' leading to 'Set negative response', and 'OK' leading to a decision block. All three 'Set negative response' blocks lead to a merge point. From this merge point, one path leads to a decision block for 'Send MM event notification negative response' and then to 'Null'. The 'OK' path from 'Check\_Confirmation' leads to a decision block for 'Send MM event notification ack' and then to 'Null'. + +1764 + +1765 + +Figure 19.4/2: Process Notify\_MM\_Event\_VLR\_Or\_SGSN + +![Flowchart for process Notify_MM_Event_gsmSCF. It starts with an initial state, followed by 'Null', 'Receive_Open_Ind', and a decision 'OK' vs 'Vr, Error'. The 'OK' path leads to 'Wait_For_Service_Primitive', which then branches into three paths: 'MAP_P_ABORT_ind' (leading to 'Null'), 'MAP_REPORT_MM_EVENT_ind' (leading to 'Report MM Event' and then 'Wait_For_Application_Response'), and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and then 'Null'). From 'Wait_For_Application_Response', it branches into 'Report MM Event ack' (leading to 'Set Result') and 'Report MM Event negative response' (leading to 'Set User Error'). Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP_REPORT_MM_EVENT_rsp' / 'MAP_CLOSE_req' and finally 'Null'.](fadcd3e9a0aec99f497cb697846fbf7f_img.jpg) + +process Notify\_MM\_Event\_gsmSCF + +NMME\_SCF1(1) + +Process in the gsmSCF to handle the notification of a mobility management event + +Signals to/from the left are to/from the VLR or SGSN; signals to/from the right are to/from the service logic application process in the gsmSCF + +``` + +graph TD + Start([ ]) --> Null1[Null] + Null1 --> Receive[Receive_Open_Ind] + Receive --> OK{OK} + OK -- Vr, Error --> Null2[Null] + OK --> WaitService[Wait_For_Service_Primitive] + WaitService --> MAP_ABORT{MAP_P_ABORT_ind} + WaitService --> MAP_REPORT{MAP_REPORT_MM_EVENT_ind} + WaitService --> MAP_NOTICE{MAP_NOTICE_ind} + MAP_ABORT --> Null3[Null] + MAP_REPORT --> ReportMM[Report MM Event] + ReportMM --> WaitApp[Wait_For_Application_Response] + MAP_NOTICE --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_CLOSE_req --> Null4[Null] + WaitApp --> ReportAck{Report MM Event ack} + WaitApp --> ReportNeg{Report MM Event negative response} + ReportAck --> SetResult[Set Result] + ReportNeg --> SetUserError[Set User Error] + SetResult --> Merge{ } + SetUserError --> Merge + Merge --> RspClose{MAP_REPORT_MM_EVENT_rsp +MAP_CLOSE_req} + RspClose --> Null5[Null] + +``` + +Flowchart for process Notify\_MM\_Event\_gsmSCF. It starts with an initial state, followed by 'Null', 'Receive\_Open\_Ind', and a decision 'OK' vs 'Vr, Error'. The 'OK' path leads to 'Wait\_For\_Service\_Primitive', which then branches into three paths: 'MAP\_P\_ABORT\_ind' (leading to 'Null'), 'MAP\_REPORT\_MM\_EVENT\_ind' (leading to 'Report MM Event' and then 'Wait\_For\_Application\_Response'), and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and then 'Null'). From 'Wait\_For\_Application\_Response', it branches into 'Report MM Event ack' (leading to 'Set Result') and 'Report MM Event negative response' (leading to 'Set User Error'). Both 'Set Result' and 'Set User Error' lead to a merge point, which then leads to 'MAP\_REPORT\_MM\_EVENT\_rsp' / 'MAP\_CLOSE\_req' and finally 'Null'. + +1766 + +1767 + +Figure 19.4/3: Process Notify\_MM\_Event\_gsmSCF + +## 1768 19.5 HLR Insert Subscriber Data macros + +### 1769 19.5.1 Macro Insert\_Subs\_Data\_Framed\_HLR + +1770 This macro is used to transfer subscriber data to the VLR as part of an existing dialogue for location updating or data +1771 restoration. The macro invokes a macro and a process not defined in this clause; the definitions of the macro and the +1772 process can be found as follows: + +1773     Wait\_For\_Insert\_Subs\_Data\_Cnf see clause 25.7.5; + +1774     Send\_Insert\_Subs\_Data\_HLR: see clause 25.7.7. + +1775 The HLR may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it sends the +1776 next request, or it may handle the requests and the confirmations in parallel. + +1777 If the VLR has indicated that it does not support a service or feature (e.g. Closed User Group or Advice Of Charge +1778 Charging Level) which the HLR operator regards as essential for the subscriber, the macro + +1779 Wait\_for\_Insert\_Subs\_Data\_Cnf takes the Replace\_Service exit; the HLR sets the Roaming Restriction Due To +1780 Unsupported Feature flag to roaming restricted and sends Roaming Restriction Due To Unsupported Feature in a +1781 subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +1782 If the HLR operator does not regard the unsupported service or feature as essential for the subscriber but the macro +1783 Wait\_for\_Insert\_Subs\_Data\_Cnf takes the Replace\_Service exit, the HLR sends the data for a replacement service in a +1784 subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +1785 If subscriber data for CAMEL Phase 2 or later services are sent to a VLR which does not support the appropriate phase +1786 of CAMEL, the service behaviour may be unpredictable or incorrect. The HLR should therefore ensure that at the +1787 conclusion of a stand alone Insert Subscriber data procedure the data in the VLR do not require a capability that the +1788 VLR does not have. Possible mechanisms to ensure this are described in 3GPP TS 23.078 [98]. + +1789 The HLR should send a Forwarded-to number which is not in E.164 international format to the VLR only when the +1790 HLR has ascertained that the VLR supports CAMEL Phase 2 or later. Thus, the ISD message containing the +1791 Forwarded-to number which is not in E.164 international format shall be sent to the VLR only if the HLR previously +1792 received confirmation from the VLR at Location Update that CAMEL Phase 2 or later is supported. + +### 1793 19.5.2 Macro Insert\_GPRS\_Subs\_Data\_Framed\_HLR + +1794 This macro is used to transfer subscriber data to the SGSN as part of an existing dialogue for location updating. The +1795 macro invokes a macro and a process not defined in this clause; the definitions of the macro and the process can be +1796 found as follows: + +1797     Wait\_For\_Insert\_GPRS\_Subs\_Data\_Cnf see clause 25.7.5; + +1798     Send\_Insert\_Subs\_Data\_HLR: see clause 25.7.7. + +1799 The HLR may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it sends the +1800 next request, or it may handle the requests and the confirmations in parallel. + +1801 If the SGSN has indicated that it does not support a service or feature which the HLR operator regards as essential for +1802 the subscriber, the macro Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf takes the Replace\_Service exit; the HLR sets the +1803 Roaming Restricted In SGSN Due To Unsupported Feature flag to roaming restricted and sends Roaming Restricted In +1804 SGSN Due To Unsupported Feature in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +1805 If the HLR operator does not regard the unsupported service or feature as essential for the subscriber but the macro +1806 Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf takes the Replace\_Service exit, the HLR sends the data for a replacement +1807 service in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +![Flowchart for macrodefinition Insert_Subs_Data_Framed_HLR. The process starts with an entry point, followed by sending MAP_INSERT_SUBSCRIBER_DATA_req and MAP_DELIMITER_req. It then initializes Count:=1 and checks if all data is inserted. If not, it sends Insert_Subs_Data_HLR, increments Count, and loops back. If all data is inserted, it waits for a confirmation. The confirmation can be OK, Replace_Service, Error, or Abort. OK leads to Count:=Count-1 and a loop back if Count>0. Replace_Service leads to setting replacement services, Count:=Count-1, and an exit point. Error leads to an Error exit point. Abort leads to an Aborted state. If Count>0 is false, it checks for network node area restrictions. If none, it sets MSC Area restricted to Not restricted. If restricted, it sets MSC Area restricted to Restricted. Both lead to an OK exit point.](e8820d8ca264fb5f85d8cd4e4a9c4c2a_img.jpg) + +macrodefinition Insert\_Subs\_Data\_Framed\_HLR + +ISDF\_HLR1(1) + +Macro in the HLR to transfer subscriber data to the VLR in an existing dialogue + +Signals to the left are to the VLR + +``` + +graph TD + Entry([ ]) --> Out1{{ )) + Out1 -- "MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req" --> Count1[Count:=1] + Count1 --> AllData{All data inserted?} + AllData -- No --> Send[Send Insert_Subs_Data_HLR] + Send --> CountInc[Count:=Count+1] + CountInc --> AllData + AllData -- Yes --> Wait[Wait For Insert_Subs_Data_Cnf] + Wait -- OK --> CountDec1[Count:=Count-1] + CountDec1 --> CountGT0{Count>0?} + CountGT0 -- Yes --> Wait + CountGT0 -- No --> Restricted{Network node area restricted received OR Roaming Restriction due to Unsupported Feature?} + Wait -- Replace_Service --> Set[Set replacement service(s)] + Set --> CountDec2[Count:=Count-1] + CountDec2 --> Exit1((1)) + Wait -- Error --> Error((Error)) + Wait -- Abort --> Aborted[Aborted] + Restricted -- Yes --> MSCRestricted[MSC Area restricted:= Restricted] + Restricted -- No --> MSCNotRestricted[MSC Area restricted:= Not restricted] + MSCRestricted --> ExitOK((OK)) + MSCNotRestricted --> ExitOK + +``` + +Flowchart for macrodefinition Insert\_Subs\_Data\_Framed\_HLR. The process starts with an entry point, followed by sending MAP\_INSERT\_SUBSCRIBER\_DATA\_req and MAP\_DELIMITER\_req. It then initializes Count:=1 and checks if all data is inserted. If not, it sends Insert\_Subs\_Data\_HLR, increments Count, and loops back. If all data is inserted, it waits for a confirmation. The confirmation can be OK, Replace\_Service, Error, or Abort. OK leads to Count:=Count-1 and a loop back if Count>0. Replace\_Service leads to setting replacement services, Count:=Count-1, and an exit point. Error leads to an Error exit point. Abort leads to an Aborted state. If Count>0 is false, it checks for network node area restrictions. If none, it sets MSC Area restricted to Not restricted. If restricted, it sets MSC Area restricted to Restricted. Both lead to an OK exit point. + +1808 + +1809 + +Figure 19.5/1: Macro Insert\_Subs\_Data\_Framed\_HLR + +macrodefinition Insert\_GPRS\_Subs\_Data\_Framed\_HLR + +IGSDF\_HLR1(1) + +Macro in the HLR to transfer subscriber data to the SGSN in an existing dialogue + +Signals to the left are to the VLR + +![Flowchart for Insert_GPRS_Subs_Data_Framed_HLR macro. It starts with an entry point, followed by MAP_INSERT_SUBSCRIBER_DATA_req and MAP_DELIMITER_req messages. A loop begins with Count:=1 and a decision 'All data inserted?'. If 'No', it goes to 'Send Insert_Subs_Data_HLR', increments Count, and loops back. If 'Yes', it goes to 'Wait_For_Insert_GPRS_Subs_Data_Cnf'. From there, four outcomes are possible: 'OK' leads to Count:=Count-1 and a 'Count>0?' decision; 'Replace_Service' leads to 'Set replacement service(s)', then Count:=Count-1, and then to connector '1'; 'Error' leads to an 'Error' connector; 'Abort' leads to an 'Abort' connector. If 'Count>0?' is 'Yes', it loops back to the 'All data inserted?' decision. If 'No', it goes to a decision 'Network node area restricted received OR Roaming Restricted in SGSN due to Unsupported Feature?'. If 'Yes', it sets 'SGSN Area restricted:= Restricted'; if 'No', it sets 'SGSN Area restricted:= Not restricted'. Both lead to an 'OK' connector.](fdcb84b9824ff628439843df1ab772d7_img.jpg) + +``` + +graph TD + Entry([ ]) --> In(( )) + In --> Msg["MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req"] + Msg --> Count1["Count:=1"] + Count1 --> AllData{All data inserted?} + AllData -- No --> Send["Send Insert_Subs_Data_HLR"] + Send --> CountInc["Count:=Count+1"] + CountInc --> AllData + AllData -- Yes --> Wait["Wait_For_Insert_GPRS_Subs_Data_Cnf"] + Wait -- OK --> CountDec1["Count:=Count-1"] + CountDec1 --> CountGT0{Count>0?} + CountGT0 -- Yes --> AllData + CountGT0 -- No --> NetRestrict{Network node area restricted received OR +Roaming Restricted in SGSN due to Unsupported Feature?} + Wait -- Replace_Service --> SetService["Set replacement service(s)"] + SetService --> CountDec2["Count:=Count-1"] + CountDec2 --> Conn1((1)) + Wait -- Error --> ErrorConn((Error)) + Wait -- Abort --> AbortConn(( )) + AbortConn --> Aborted[Aborted] + NetRestrict -- Yes --> RestrictYes["SGSN Area restricted:= Restricted"] + NetRestrict -- No --> RestrictNo["SGSN Area restricted:= Not restricted"] + RestrictYes --> OKConn((OK)) + RestrictNo --> OKConn + +``` + +Flowchart for Insert\_GPRS\_Subs\_Data\_Framed\_HLR macro. It starts with an entry point, followed by MAP\_INSERT\_SUBSCRIBER\_DATA\_req and MAP\_DELIMITER\_req messages. A loop begins with Count:=1 and a decision 'All data inserted?'. If 'No', it goes to 'Send Insert\_Subs\_Data\_HLR', increments Count, and loops back. If 'Yes', it goes to 'Wait\_For\_Insert\_GPRS\_Subs\_Data\_Cnf'. From there, four outcomes are possible: 'OK' leads to Count:=Count-1 and a 'Count>0?' decision; 'Replace\_Service' leads to 'Set replacement service(s)', then Count:=Count-1, and then to connector '1'; 'Error' leads to an 'Error' connector; 'Abort' leads to an 'Abort' connector. If 'Count>0?' is 'Yes', it loops back to the 'All data inserted?' decision. If 'No', it goes to a decision 'Network node area restricted received OR Roaming Restricted in SGSN due to Unsupported Feature?'. If 'Yes', it sets 'SGSN Area restricted:= Restricted'; if 'No', it sets 'SGSN Area restricted:= Not restricted'. Both lead to an 'OK' connector. + +1810 + +1811 + +Figure 19.5/2: Macro Insert\_GPRS\_Subs\_Data\_Framed\_HLR + +## 1812 19.5A CSS Insert Subscriber Data macros + +### 1813 19.5A.1 Macro Insert\_VCSG\_Subs\_Data\_Framed\_CSS + +1814 This macro is used to transfer CSG subscriber data from the CSS to the VLR or the SGSN as part of an existing +1815 dialogue for VCSG location updating. The macro invokes a macro and a process not defined in this clause; the +1816 definitions of the macro and the process can be found as follows: + +1817     Wait\_For\_Insert\_VCSG\_Subs\_Data\_Cnf see clause 25.7.9; + +1818     Send\_Insert\_VCSG\_Subs\_Data\_CSS: see clause 25.7.10. + +1819 The CSS may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it sends the +1820 next request, or it may handle the requests and the confirmations in parallel. + +1821 If the VLR or the SGSN has indicated that it does not support a service or feature which the CSS operator regards as +1822 essential for the subscriber, the macro Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf takes the Replace\_Service exit. + +1823 If the CSS operator does not regard the unsupported service or feature as essential for the subscriber but the macro +1824 Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf takes the Replace\_Service exit, the CSS sends the data for a replacement +1825 service in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +1826 + +![Flowchart for Insert_VCSG_Subs_Data_Framed_CSS macro. It starts with an entry point, followed by MAP_INSERT_SUBSCRIBER_DATA_req and MAP_DELIMITER_req signals. Count is initialized to 1. A loop begins with 'All data inserted?' decision. If No, it goes to 'Send_Insert_VCSG_Subs_Data_CSS', increments Count, and loops back. If Yes, it goes to 'Wait_For_Insert_VCSG_Subs_Data_Cnf'. From there, four paths exist: OK (decrements Count, checks if Count > 0), Replace_Service (sets replacement services, decrements Count), Error (ends in Error state), and Abort (ends in Aborted state). If Count > 0 after OK or Replace_Service, it loops back to 'All data inserted?'. If Count = 0, it ends in OK state.](341c5e236a73f03a1cc436237fe64d8e_img.jpg) + +**macrodefinition Insert\_VCSG\_Subs\_Data\_Framed\_CSS** IVSDF\_CSS1(1) + +Macro in the CSS to transfer CSG subscriber data to the VLR or the SGSN in an existing dialogue + +Signals to the left are to the VLR or the SGSN + +``` +graph TD; Entry([ ]) --> Signals["MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req"]; Signals --> Count1["Count:=1"]; Count1 --> AllDataInserted{All data inserted?}; AllDataInserted -- No --> SendInsert["Send_Insert_VCSG_Subs_Data_CSS"]; SendInsert --> CountInc["Count:=Count+1"]; CountInc --> AllDataInserted; AllDataInserted -- Yes --> WaitForCnf["Wait_For_Insert_VCSG_Subs_Data_Cnf"]; WaitForCnf -- OK --> CountDec1["Count:=Count-1"]; WaitForCnf -- Replace_Service --> SetReplacement["Set replacement services(s)"]; SetReplacement --> CountDec2["Count:=Count-1"]; WaitForCnf -- Error --> ErrorState((Error)); WaitForCnf -- Abort --> AbortedState((Aborted)); AbortedState --> Aborted["Aborted"]; CountDec1 --> CountGT0{Count>0?}; CountDec2 --> One1((1)); CountGT0 -- Yes --> AllDataInserted; CountGT0 -- No --> OKState((OK)); +``` + +Flowchart for Insert\_VCSG\_Subs\_Data\_Framed\_CSS macro. It starts with an entry point, followed by MAP\_INSERT\_SUBSCRIBER\_DATA\_req and MAP\_DELIMITER\_req signals. Count is initialized to 1. A loop begins with 'All data inserted?' decision. If No, it goes to 'Send\_Insert\_VCSG\_Subs\_Data\_CSS', increments Count, and loops back. If Yes, it goes to 'Wait\_For\_Insert\_VCSG\_Subs\_Data\_Cnf'. From there, four paths exist: OK (decrements Count, checks if Count > 0), Replace\_Service (sets replacement services, decrements Count), Error (ends in Error state), and Abort (ends in Aborted state). If Count > 0 after OK or Replace\_Service, it loops back to 'All data inserted?'. If Count = 0, it ends in OK state. + +1827 + +1828 + +**Figure 19.5A/1: Macro Insert\_VCSG\_Subs\_Data\_Framed\_CSS** + +--- + +## 1829 20 Operation and maintenance procedures + +### 1830 20.1 General + +1831 The Operation and Maintenance procedures are used to support operation and maintenance of the network. + +1832 The following procedures exist for operation and maintenance purposes: + +- 1833 i) Tracing procedures; +- 1834 ii) Subscriber Data Management procedures; +- 1835 iii) Subscriber Identity procedure. + +1836 The following application contexts refer to complex MAP Users consisting of several processes: + +- 1837 - subscriberDataManagementContext; +- 1838 - tracingContext. + +1839 Each of these two application contexts needs a co-ordinating process in the VLR or in the SGSN as described in the +1840 following clauses. + +#### 1841 20.1.1 Tracing Co-ordinator for the VLR + +1842 The Tracing Co-ordinator process in the VLR is shown in figure 20.1/1. The MAP process invokes a macro not +1843 defined in this clause; the definition of this macro can be found as follows: + +1844     Receive\_Open\_Ind     see clause 25.1.1. + +#### 1845 20.1.2 Tracing Co-ordinator for the SGSN + +1846 The Tracing Co-ordinator process in the SGSN is shown in figure 20.1/2. The MAP process invokes a macro not +1847 defined in this clause; the definition of this macro can be found as follows: + +1848     Receive\_Open\_Ind     see clause 25.1.1. + +#### 1849 20.1.3 Subscriber Data Management Co-ordinator for the VLR + +1850 The Subscriber Data Management Co-ordinator process in the VLR is shown in figure 20.1/3 and figure 20.1/5. The +1851 MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1852     Receive\_Open\_Ind     see clause 25.1.1. + +#### 1853 20.1.4 Subscriber Data Management Co-ordinator for the SGSN + +1854 The Subscriber Data Management Co-ordinator process in the SGSN is shown in figure 20.1/4 and figure 20.1/6. The +1855 MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1856     Receive\_Open\_Ind     see clause 25.1.1. + +![Flowchart for process Co_Tracing_VLR. It starts with an entry point leading to 'Null', then 'Receive_Open_ind' (referencing Figure 25.1/1). From 'Receive_Open_ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait_For_Service_Primitive'; and 'Error' leading to 'Null'. 'Wait_For_Service_Primitive' branches into four parallel paths: 1) 'MAP_ACTIVATE_TRACE_MODE_ind' leading to 'ATM_Stand_Alone_VLR' (referencing Figure 20.2/10) then 'MAP_ACTIVATE_TRACE_MODE_ind' (outward) then 'Relay_Info'; 2) 'MAP_DEACTIVATE_TRACE_MODE_ind' leading to 'DTM_Stand_Alone_VLR' (referencing Figure 20.2/14) then 'MAP_DEACTIVATE_TRACE_MODE_ind' (outward) then 'Relay_Info'; 3) 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' then 'Null'; 4) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (outward) then 'Null'. All four 'Relay_Info' blocks from the first two paths lead to a common 'Relay_Info' block. This 'Relay_Info' block branches into four parallel paths: 1) 'MAP_U_ABORT_req, MAP_CLOSE_req' (outward) then '-' (outward) then 'Null'; 2) '*' (outward) then '-' (outward) then 'Relay_Info'; 3) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (outward) then '-' (outward) then 'Null'; 4) '*' (outward) then '-' (outward) then 'Relay_Info'.](a72557efa52586542f028f0a62ff9cf5_img.jpg) + +**process Co\_Tracing\_VLR** **Co\_Tr\_VLR1(1)** + +Co-ordinating process in the VLR to handle a dialogue opening request using the application context tracingContext + +Signals to/from the left are to/from the child process; signals to/from the right are to/from the HLR + +``` + +graph TD + Entry([ ]) --> Null1([Null]) + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind -.-> F25_1_1[Figure 25.1/1] + Receive_Open_ind -- Vr --> Perform_Vr[Perform MAP Vr dialogue] + Perform_Vr --> Null2([Null]) + Receive_Open_ind -- OK --> Wait_For_Primitive[Wait_For_Service_Primitive] + Receive_Open_ind -- Error --> Null3([Null]) + Wait_For_Primitive --> MAP_ACTIVATE_ind[MAP_ACTIVATE_TRACE_MODE_ind] + Wait_For_Primitive --> MAP_DEACTIVATE_ind[MAP_DEACTIVATE_TRACE_MODE_ind] + Wait_For_Primitive --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_Primitive --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_ACTIVATE_ind --> ATM_Stand_Alone_VLR[ATM_Stand_Alone_VLR] + ATM_Stand_Alone_VLR -.-> F20_2_10[Figure 20.2/10] + ATM_Stand_Alone_VLR --> MAP_ACTIVATE_out[MAP_ACTIVATE_TRACE_MODE_ind] + MAP_DEACTIVATE_ind --> DTM_Stand_Alone_VLR[DTM_Stand_Alone_VLR] + DTM_Stand_Alone_VLR -.-> F20_2_14[Figure 20.2/14] + DTM_Stand_Alone_VLR --> MAP_DEACTIVATE_out[MAP_DEACTIVATE_TRACE_MODE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Null4([Null]) + MAP_U_ABORT_ind --> Null5([Null]) + MAP_ACTIVATE_out --> Relay_Info1[Relay_Info] + MAP_DEACTIVATE_out --> Relay_Info2[Relay_Info] + Relay_Info1 --> Relay_Info3[Relay_Info] + Relay_Info2 --> Relay_Info3 + Relay_Info3 --> MAP_U_ABORT_req[MAP_U_ABORT_req, MAP_CLOSE_req] + Relay_Info3 --> Star1[*] + Relay_Info3 --> MAP_U_ABORT_ind2[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Relay_Info3 --> Star2[*] + MAP_U_ABORT_req --> Dash1[-] + Dash1 --> Null6([Null]) + Star1 --> Dash2[-] + Dash2 --> Relay_Info4[Relay_Info] + MAP_U_ABORT_ind2 --> Dash3[-] + Dash3 --> Null7([Null]) + Star2 --> Dash4[-] + Dash4 --> Relay_Info5[Relay_Info] + +``` + +Flowchart for process Co\_Tracing\_VLR. It starts with an entry point leading to 'Null', then 'Receive\_Open\_ind' (referencing Figure 25.1/1). From 'Receive\_Open\_ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leading to 'Wait\_For\_Service\_Primitive'; and 'Error' leading to 'Null'. 'Wait\_For\_Service\_Primitive' branches into four parallel paths: 1) 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' leading to 'ATM\_Stand\_Alone\_VLR' (referencing Figure 20.2/10) then 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' (outward) then 'Relay\_Info'; 2) 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind' leading to 'DTM\_Stand\_Alone\_VLR' (referencing Figure 20.2/14) then 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind' (outward) then 'Relay\_Info'; 3) 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' then 'Null'; 4) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (outward) then 'Null'. All four 'Relay\_Info' blocks from the first two paths lead to a common 'Relay\_Info' block. This 'Relay\_Info' block branches into four parallel paths: 1) 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' (outward) then '-' (outward) then 'Null'; 2) '\*' (outward) then '-' (outward) then 'Relay\_Info'; 3) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (outward) then '-' (outward) then 'Null'; 4) '\*' (outward) then '-' (outward) then 'Relay\_Info'. + +1857 + +1858 + +**Figure 20.1/1: Process Co\_Tracing\_VLR** + +![Flowchart for process Co_Tracing_SGSN. It starts with an entry point leading to 'Null', then 'Receive_Open_ind' (linked to Figure 25.1/1). From 'Receive_Open_ind', three paths emerge: 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leads to 'Wait_For_Service_Primitive'; 'Error' leads to 'Null'. 'Wait_For_Service_Primitive' branches into four paths: 1) 'MAP_ACTIVATE_TRACE_MODE_ind' leads to 'ATM_Stand_Alone_SGSN' (linked to Figure 20.2/11) then 'MAP_ACTIVATE_TRACE_MODE_ind' (outward) then 'Relay_Info'; 2) 'MAP_DEACTIVATE_TRACE_MODE_ind' leads to 'DTM_Stand_Alone_SGSN' (linked to Figure 20.2/15) then 'MAP_DEACTIVATE_TRACE_MODE_ind' (outward) then 'Relay_Info'; 3) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' then 'Null'; 4) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (outward) then 'Relay_Info'. All four 'Relay_Info' blocks lead to a final section with four parallel paths: 1) 'MAP_U_ABORT_req, MAP_CLOSE_req' (outward) then 'Null'; 2) '*' (outward) then 'Relay_Info'; 3) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (outward) then 'Null'; 4) '*' (outward) then 'Relay_Info'.](cbf400f805c12c870d53a2cce2a45ae4_img.jpg) + +**process Co\_Tracing\_SGSN** **Co\_Tr\_SGSN1(1)** + +Co-ordinating process in the SGSN to handle a dialogue opening request using the application context tracingContext + +Signals to/from the left are to/from the child process; signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind -.-> F25_1_1[Figure 25.1/1] + + Receive_Open_ind -- Vr --> Perform_Vr[Perform MAP Vr dialogue] + Perform_Vr --> Null2([Null]) + + Receive_Open_ind -- OK --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + + Receive_Open_ind -- Error --> Null3([Null]) + + Wait_For_Service_Primitive --> MAP_ACTIVATE_TRACE_MODE_ind_in1[MAP_ACTIVATE_TRACE_MODE_ind] + MAP_ACTIVATE_TRACE_MODE_ind_in1 --> ATM_Stand_Alone_SGSN[ATM_Stand_Alone_SGSN] + ATM_Stand_Alone_SGSN -.-> F20_2_11[Figure 20.2/11] + + Wait_For_Service_Primitive --> MAP_DEACTIVATE_TRACE_MODE_ind_in1[MAP_DEACTIVATE_TRACE_MODE_ind] + MAP_DEACTIVATE_TRACE_MODE_ind_in1 --> DTM_Stand_Alone_SGSN[DTM_Stand_Alone_SGSN] + DTM_Stand_Alone_SGSN -.-> F20_2_15[Figure 20.2/15] + + Wait_For_Service_Primitive --> MAP_NOTICE_ind_in[MAP_NOTICE_ind] + + Wait_For_Service_Primitive --> MAP_U_ABORT_ind_in[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + + ATM_Stand_Alone_SGSN --> MAP_ACTIVATE_TRACE_MODE_ind_out1[MAP_ACTIVATE_TRACE_MODE_ind] + + DTM_Stand_Alone_SGSN --> MAP_DEACTIVATE_TRACE_MODE_ind_out1[MAP_DEACTIVATE_TRACE_MODE_ind] + + MAP_NOTICE_ind_in --> MAP_CLOSE_req[MAP_CLOSE_req] + + MAP_U_ABORT_ind_in --> MAP_U_ABORT_ind_out1[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + + MAP_ACTIVATE_TRACE_MODE_ind_out1 --> Relay_Info1[Relay_Info] + MAP_DEACTIVATE_TRACE_MODE_ind_out1 --> Relay_Info2[Relay_Info] + MAP_CLOSE_req --> Null4([Null]) + MAP_U_ABORT_ind_out1 --> Relay_Info3[Relay_Info] + + Relay_Info1 --> MAP_U_ABORT_req[MAP_U_ABORT_req, MAP_CLOSE_req] + MAP_U_ABORT_req --> Null5([Null]) + + Relay_Info2 --> Star1[*] + Star1 --> Relay_Info4[Relay_Info] + + Relay_Info3 --> MAP_U_ABORT_ind_out2[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_U_ABORT_ind_out2 --> Null6([Null]) + + Relay_Info4 --> Star2[*] + Star2 --> Relay_Info5[Relay_Info] + +``` + +Flowchart for process Co\_Tracing\_SGSN. It starts with an entry point leading to 'Null', then 'Receive\_Open\_ind' (linked to Figure 25.1/1). From 'Receive\_Open\_ind', three paths emerge: 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leads to 'Wait\_For\_Service\_Primitive'; 'Error' leads to 'Null'. 'Wait\_For\_Service\_Primitive' branches into four paths: 1) 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' leads to 'ATM\_Stand\_Alone\_SGSN' (linked to Figure 20.2/11) then 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' (outward) then 'Relay\_Info'; 2) 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind' leads to 'DTM\_Stand\_Alone\_SGSN' (linked to Figure 20.2/15) then 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind' (outward) then 'Relay\_Info'; 3) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' then 'Null'; 4) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (outward) then 'Relay\_Info'. All four 'Relay\_Info' blocks lead to a final section with four parallel paths: 1) 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' (outward) then 'Null'; 2) '\*' (outward) then 'Relay\_Info'; 3) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (outward) then 'Null'; 4) '\*' (outward) then 'Relay\_Info'. + +1859 + +1860 + +Figure 20.1/2: Process Co\_Tracing\_SGSN + +![State transition diagram for process Co_SDM_VLR. The process starts at an initial state, goes to 'Null', then 'Receive_Open_ind' (linked to Figure 25.1/1). From 'Receive_Open_ind', three paths emerge: 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leads to 'Wait_For_Service_Primitive'; 'Error' leads to 'Null'. 'Wait_For_Service_Primitive' branches into four paths: 1) 'MAP_INSERT_SUBSCRIBER_DATA_ind' leads to 'Ins Subs Data Stand Alone_VLR' (linked to Figure 20.3/9), then 'MAP_INSERT_SUBSCRIBER_DATA_ind', then 'Relay_Info'. 2) 'MAP_DELETE_SUBSCRIBER_DATA_ind' leads to 'Delete Subs Data_VLR' (linked to Figure 20.3/10), then 'MAP_DELETE_SUBSCRIBER_DATA_ind', then 'Relay_Info'. 3) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', then 'Null'. 4) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to 'Null'. All four 'Relay_Info' blocks lead to a final state. The first 'Relay_Info' leads to 'MAP_U_ABORT_req, MAP_CLOSE_req' then 'Null'. The second 'Relay_Info' leads to 'Null'. The third 'Relay_Info' leads to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' then 'Null'. The fourth 'Relay_Info' leads to 'Null'.](2f3f2aa440b5f97bb36333c1617d1ab3_img.jpg) + +**process Co\_SDM\_VLR** **Co\_SDM\_VLR1(1)** + +Co-ordinating process in the VLR to handle a dialogue opening request using the application context subscriberDataMngtContext + +Signals to/from the left are to/from the child process; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --> Vr[Perform MAP Vr dialogue] + Receive_Open_ind --> OK[Wait_For_Service_Primitive] + Receive_Open_ind --> Error[Null] + Vr --> Null2[Null] + OK --> Insert[MAP_INSERT_SUBSCRIBER_DATA_ind] + OK --> Delete[MAP_DELETE_SUBSCRIBER_DATA_ind] + OK --> Notice[MAP_NOTICE_ind] + OK --> Abort[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Insert --> InsSubs[Ins Subs Data Stand Alone_VLR] + InsSubs --> InsertOut[MAP_INSERT_SUBSCRIBER_DATA_ind] + Delete --> DeleteSubs[Delete Subs Data_VLR] + DeleteSubs --> DeleteOut[MAP_DELETE_SUBSCRIBER_DATA_ind] + Notice --> CloseReq[MAP_CLOSE_req] + CloseReq --> Null3[Null] + Abort --> Null4[Null] + InsertOut --> RelayInfo1[Relay_Info] + DeleteOut --> RelayInfo2[Relay_Info] + CloseReq --> Null3 + Abort --> Null4 + RelayInfo1 --> RelayInfo1_1[MAP_U_ABORT_req, MAP_CLOSE_req] + RelayInfo1 --> Null5[Null] + RelayInfo1 --> RelayInfo1_3[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + RelayInfo1 --> Null6[Null] + RelayInfo2 --> Null5 + RelayInfo2 --> Null7[Null] + RelayInfo2 --> Null8[Null] + RelayInfo2 --> Null9[Null] + +``` + +State transition diagram for process Co\_SDM\_VLR. The process starts at an initial state, goes to 'Null', then 'Receive\_Open\_ind' (linked to Figure 25.1/1). From 'Receive\_Open\_ind', three paths emerge: 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'; 'OK' leads to 'Wait\_For\_Service\_Primitive'; 'Error' leads to 'Null'. 'Wait\_For\_Service\_Primitive' branches into four paths: 1) 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' leads to 'Ins Subs Data Stand Alone\_VLR' (linked to Figure 20.3/9), then 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind', then 'Relay\_Info'. 2) 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' leads to 'Delete Subs Data\_VLR' (linked to Figure 20.3/10), then 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind', then 'Relay\_Info'. 3) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', then 'Null'. 4) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to 'Null'. All four 'Relay\_Info' blocks lead to a final state. The first 'Relay\_Info' leads to 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' then 'Null'. The second 'Relay\_Info' leads to 'Null'. The third 'Relay\_Info' leads to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' then 'Null'. The fourth 'Relay\_Info' leads to 'Null'. + +1861 + +1862 + +**Figure 20.1/3: Process Co\_SDM\_VLR** + +![Flowchart for process Co_SDM_SGSN. It starts with an initial node leading to 'Null', then 'Receive_Open_ind' (linked to Figure 25.1/1). From 'Receive_Open_ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to another 'Null' node. 'Wait_For_Service_Primitive' branches into four parallel paths: 1) MAP_INSERT_SUBSCRIBER_DATA_ind -> Ins_Subs_Data_Stand_Alone_SGSN (linked to Figure 20.3/11) -> MAP_INSERT_SUBSCRIBER_DATA_ind -> Relay_Info. 2) MAP_DELETE_SUBSCRIBER_DATA_ind -> Delete_Subs_Data_SGSN (linked to Figure 20.3/12) -> MAP_DELETE_SUBSCRIBER_DATA_ind -> Relay_Info. 3) MAP_NOTICE_ind -> MAP_CLOSE_req -> Null. 4) MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind -> Null. The 'Relay_Info' from the first two paths branches into four more parallel paths: 1) MAP_U_ABORT_req, MAP_CLOSE_req -> - -> Null. 2) * -> - -> Relay_Info. 3) MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind -> - -> Null. 4) * -> - -> Relay_Info.](b33531f195991b13ef7056eb27220f98_img.jpg) + +**process Co\_SDM\_SGSN** **Co\_SDM\_SGSN1(1)** + +Co-ordinating process in the SGSN to handle a dialogue opening request using the application context subscriberDataMngtContext + +Signals to/from the left are to/from the child process, signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind -.-> F25_1_1[Figure 25.1/1] + Receive_Open_ind -- OK --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + Receive_Open_ind -- "Vr, Error" --> Null2([Null]) + Wait_For_Service_Primitive --> MAP_INSERT_SUBSCRIBER_DATA_ind1[MAP_INSERT_SUBSCRIBER_DATA_ind] + Wait_For_Service_Primitive --> MAP_DELETE_SUBSCRIBER_DATA_ind1[MAP_DELETE_SUBSCRIBER_DATA_ind] + Wait_For_Service_Primitive --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_Service_Primitive --> MAP_U_ABORT_ind_etc[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_INSERT_SUBSCRIBER_DATA_ind1 --> Ins_Subs_Data_Stand_Alone_SGSN[Ins_Subs_Data_Stand_Alone_SGSN] + Ins_Subs_Data_Stand_Alone_SGSN -.-> F20_3_11[Figure 20.3/11] + Ins_Subs_Data_Stand_Alone_SGSN --> MAP_INSERT_SUBSCRIBER_DATA_ind2[MAP_INSERT_SUBSCRIBER_DATA_ind] + MAP_DELETE_SUBSCRIBER_DATA_ind1 --> Delete_Subs_Data_SGSN[Delete_Subs_Data_SGSN] + Delete_Subs_Data_SGSN -.-> F20_3_12[Figure 20.3/12] + Delete_Subs_Data_SGSN --> MAP_DELETE_SUBSCRIBER_DATA_ind2[MAP_DELETE_SUBSCRIBER_DATA_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Null3([Null]) + MAP_U_ABORT_ind_etc --> Null4([Null]) + MAP_INSERT_SUBSCRIBER_DATA_ind2 --> Relay_Info1[Relay_Info] + MAP_DELETE_SUBSCRIBER_DATA_ind2 --> Relay_Info1 + Relay_Info1 --> MAP_U_ABORT_req_etc[MAP_U_ABORT_req, MAP_CLOSE_req] + Relay_Info1 --> Star1[*] + Relay_Info1 --> MAP_U_ABORT_ind_etc2[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Relay_Info1 --> Star2[*] + MAP_U_ABORT_req_etc --> Dash1[-] + Dash1 --> Null5([Null]) + Star1 --> Dash2[-] + Dash2 --> Relay_Info2[Relay_Info] + MAP_U_ABORT_ind_etc2 --> Dash3[-] + Dash3 --> Null6([Null]) + Star2 --> Dash4[-] + Dash4 --> Relay_Info3[Relay_Info] + +``` + +Flowchart for process Co\_SDM\_SGSN. It starts with an initial node leading to 'Null', then 'Receive\_Open\_ind' (linked to Figure 25.1/1). From 'Receive\_Open\_ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to another 'Null' node. 'Wait\_For\_Service\_Primitive' branches into four parallel paths: 1) MAP\_INSERT\_SUBSCRIBER\_DATA\_ind -> Ins\_Subs\_Data\_Stand\_Alone\_SGSN (linked to Figure 20.3/11) -> MAP\_INSERT\_SUBSCRIBER\_DATA\_ind -> Relay\_Info. 2) MAP\_DELETE\_SUBSCRIBER\_DATA\_ind -> Delete\_Subs\_Data\_SGSN (linked to Figure 20.3/12) -> MAP\_DELETE\_SUBSCRIBER\_DATA\_ind -> Relay\_Info. 3) MAP\_NOTICE\_ind -> MAP\_CLOSE\_req -> Null. 4) MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind -> Null. The 'Relay\_Info' from the first two paths branches into four more parallel paths: 1) MAP\_U\_ABORT\_req, MAP\_CLOSE\_req -> - -> Null. 2) \* -> - -> Relay\_Info. 3) MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind -> - -> Null. 4) \* -> - -> Relay\_Info. + +1863 + +1864 + +**Figure 20.1/4: Process Co\_SDM\_SGSN** + +![State transition diagram for process Co_CSG_SDM_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state leading to 'Null', then 'Receive_Open_Ind' (referencing Figure 25.1/1). From 'Receive_Open_Ind', an 'OK' transition leads to 'Wait_For_Service_Primitive', while a 'Vr, Error' transition leads to another 'Null' state. 'Wait_For_Service_Primitive' leads to a parallel state machine with four branches. The first branch involves 'MAP_INSERT_SUBSCRIBER_DATA_ind', 'Ins_VCSG_Subs_Data_Stand_Alone_VLR' (referencing Figure 20.3A/8), and another 'MAP_INSERT_SUBSCRIBER_DATA_ind' leading to 'Relay_Info'. The second branch involves 'MAP_DELETE_SUBSCRIBER_DATA_ind', 'Delete_VCSG_Subs_Data_VLR' (referencing Figure 20.3A/9), and another 'MAP_DELETE_SUBSCRIBER_DATA_ind' leading to 'Relay_Info'. The third branch involves 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and then to 'Null'. The fourth branch involves a transition to a state with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leading to 'Relay_Info'. From the first 'Relay_Info' state, four sub-branches lead to final states: 'Null', 'Relay_Info', 'Null', and 'Relay_Info'. These sub-branches involve 'MAP_U_ABORT_req, MAP_CLOSE_req', '*', 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', and '*'.](68ba0c51631dd29d48b79431e37dbb16_img.jpg) + +**process Co\_CSG\_SDM\_VLR** **Co\_CSG\_SDM\_VLR1(1)** + +Co-ordinating process in the VLR to handle a dialogue opening request using the application context subscriberDataMngtContext + +Signals to/from the left are to/from the child process; signals to/from the right are to/from the CSS + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind --> Null2[Null] : Vr, Error + Receive_Open_Ind --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] : OK + Wait_For_Service_Primitive --> Parallel_States + state "Parallel_States" as Parallel_States + state "Branch 1" as Branch1 + state "Branch 2" as Branch2 + state "Branch 3" as Branch3 + state "Branch 4" as Branch4 + Parallel_States --> Branch1 + Parallel_States --> Branch2 + Parallel_States --> Branch3 + Parallel_States --> Branch4 + state "Branch 1" as Branch1 + Branch1 --> B1_S1[MAP_INSERT_SUBSCRIBER_DATA_ind] + B1_S1 --> B1_S2[Ins_VCSG_Subs_Data_Stand_Alone_VLR] + B1_S2 --> B1_S3[MAP_INSERT_SUBSCRIBER_DATA_ind] + B1_S3 --> B1_S4[Relay_Info] + state "Branch 2" as Branch2 + Branch2 --> B2_S1[MAP_DELETE_SUBSCRIBER_DATA_ind] + B2_S1 --> B2_S2[Delete_VCSG_Subs_Data_VLR] + B2_S2 --> B2_S3[MAP_DELETE_SUBSCRIBER_DATA_ind] + B2_S3 --> B2_S4[Relay_Info] + state "Branch 3" as Branch3 + Branch3 --> B3_S1[MAP_NOTICE_ind] + B3_S1 --> B3_S2[MAP_CLOSE_req] + B3_S2 --> B3_S3[Null] + state "Branch 4" as Branch4 + Branch4 --> B4_S1[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + B4_S1 --> B4_S2[Relay_Info] + state "B1_S4" as B1_S4 + B1_S4 --> B1_S4_S1[MAP_U_ABORT_req, MAP_CLOSE_req] + B1_S4_S1 --> B1_S4_S2[-] + B1_S4_S2 --> B1_S4_S3[Null] + B1_S4 --> B1_S4_S4[*] + B1_S4_S4 --> B1_S4_S5[-] + B1_S4_S5 --> B1_S4_S6[Relay_Info] + B1_S4 --> B1_S4_S7[-] + B1_S4_S7 --> B1_S4_S8[Null] + B1_S4 --> B1_S4_S9[*] + B1_S4_S9 --> B1_S4_S10[-] + B1_S4_S10 --> B1_S4_S11[Relay_Info] + +``` + +State transition diagram for process Co\_CSG\_SDM\_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state leading to 'Null', then 'Receive\_Open\_Ind' (referencing Figure 25.1/1). From 'Receive\_Open\_Ind', an 'OK' transition leads to 'Wait\_For\_Service\_Primitive', while a 'Vr, Error' transition leads to another 'Null' state. 'Wait\_For\_Service\_Primitive' leads to a parallel state machine with four branches. The first branch involves 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind', 'Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR' (referencing Figure 20.3A/8), and another 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' leading to 'Relay\_Info'. The second branch involves 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind', 'Delete\_VCSG\_Subs\_Data\_VLR' (referencing Figure 20.3A/9), and another 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' leading to 'Relay\_Info'. The third branch involves 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and then to 'Null'. The fourth branch involves a transition to a state with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leading to 'Relay\_Info'. From the first 'Relay\_Info' state, four sub-branches lead to final states: 'Null', 'Relay\_Info', 'Null', and 'Relay\_Info'. These sub-branches involve 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req', '\*', 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', and '\*'. + +1865 + +1866 + +Figure 20.1/5: Process Co\_CSG\_SDM\_VLR + +![Flowchart for process Co_CSG_SDM_SGSN. It starts with an initial node leading to 'Null', then 'Receive_Open_Ind' (linked to Figure 25.1/1). From 'Receive_Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait_For_Service_Primitive' leads to a horizontal split. The left branch goes through 'MAP_INSERT_SUBSCRIBER_DATA_ind' to 'Ins_VCSG_Subs_Data_SGSN' (linked to Figure 20.3A/10, labeled 'Stand_Alone_SGSN'), then to 'MAP_INSERT_SUBSCRIBER_DATA_ind' again, and finally to 'Relay_Info'. The middle branch goes through 'MAP_DELETE_SUBSCRIBER_DATA_ind' to 'Delete_VCSG_Subs_Data_SGSN' (linked to Figure 20.3A/11), then to 'MAP_DELETE_SUBSCRIBER_DATA_ind', and finally to 'Relay_Info'. The right branch goes through 'MAP_NOTICE_ind' to 'MAP_CLOSE_req', which leads to 'Null'. A fourth branch from the split leads to a box containing 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', which then leads to 'Relay_Info'. Below the first 'Relay_Info' node, there is another horizontal split. The first path goes through 'MAP_U_ABORT_req, MAP_CLOSE_req' to a '-' node and then to 'Null'. The second path goes through a '*' node, a '-' node, and then to 'Relay_Info'. The third path goes through a '-' node and then to 'Null'. The fourth path goes through 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', a '*' node, a '-' node, and then to 'Relay_Info'.](be5db98077bb821cfe2d717c02215f0b_img.jpg) + +**process Co\_CSG\_SDM\_SGSN** **Co\_CSG\_SDM\_SGSN1(1)** + +Co-ordinating process in the SGSN to handle a dialogue opening request using the application context subscriberDataMngtContext + +Signals to/from the left are to/from the child process; signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive_Open_Ind] + RecOpen -.-> Fig25_1_1[Figure 25.1/1] + RecOpen -- OK --> WaitFor[Wait_For_Service_Primitive] + RecOpen -- Vr, Error --> Null2([Null]) + WaitFor --> Split1(( )) + Split1 --> InsertInd1[MAP_INSERT_SUBSCRIBER_DATA_ind] + Split1 --> DeleteInd1[MAP_DELETE_SUBSCRIBER_DATA_ind] + Split1 --> NoticeInd[MAP_NOTICE_ind] + Split1 --> OtherInds["MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind"] + InsertInd1 --> InsVCSG[Ins_VCSG_Subs_Data_SGSN] + InsVCSG -.-> Fig20_3A_10[Figure 20.3A/10] + InsVCSG -- Stand_Alone_SGSN --> InsertInd2[MAP_INSERT_SUBSCRIBER_DATA_ind] + DeleteInd1 --> DeleteVCSG[Delete_VCSG_Subs_Data_SGSN] + DeleteVCSG -.-> Fig20_3A_11[Figure 20.3A/11] + DeleteVCSG --> DeleteInd2[MAP_DELETE_SUBSCRIBER_DATA_ind] + NoticeInd --> CloseReq[MAP_CLOSE_req] + CloseReq --> Null3([Null]) + OtherInds --> RelayInfo1[Relay_Info] + InsertInd2 --> RelayInfo1 + DeleteInd2 --> RelayInfo1 + RelayInfo1 --> Split2(( )) + Split2 --> UAbortReq["MAP_U_ABORT_req, MAP_CLOSE_req"] + Split2 --> Star1[*] + Split2 --> Dash1[-] + Split2 --> UAbortInds["MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind"] + Split2 --> Star2[*] + UAbortReq --> Dash2[-] + Dash2 --> Null4([Null]) + Star1 --> Dash3[-] + Dash3 --> RelayInfo2[Relay_Info] + Dash1 --> Null5([Null]) + UAbortInds --> Dash4[-] + Dash4 --> RelayInfo3[Relay_Info] + +``` + +Flowchart for process Co\_CSG\_SDM\_SGSN. It starts with an initial node leading to 'Null', then 'Receive\_Open\_Ind' (linked to Figure 25.1/1). From 'Receive\_Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to 'Null'. 'Wait\_For\_Service\_Primitive' leads to a horizontal split. The left branch goes through 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' to 'Ins\_VCSG\_Subs\_Data\_SGSN' (linked to Figure 20.3A/10, labeled 'Stand\_Alone\_SGSN'), then to 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' again, and finally to 'Relay\_Info'. The middle branch goes through 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' to 'Delete\_VCSG\_Subs\_Data\_SGSN' (linked to Figure 20.3A/11), then to 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind', and finally to 'Relay\_Info'. The right branch goes through 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req', which leads to 'Null'. A fourth branch from the split leads to a box containing 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', which then leads to 'Relay\_Info'. Below the first 'Relay\_Info' node, there is another horizontal split. The first path goes through 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' to a '-' node and then to 'Null'. The second path goes through a '\*' node, a '-' node, and then to 'Relay\_Info'. The third path goes through a '-' node and then to 'Null'. The fourth path goes through 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', a '\*' node, a '-' node, and then to 'Relay\_Info'. + +1867 + +1868 + +Figure 20.1/6: Process Co\_CSG\_SDM\_SGSN + +1869 **20.2 Tracing procedures** + +1870 Three types of tracing procedures exist: + +- 1871 i) Subscriber tracing management procedures; +- 1872 ii) Subscriber tracing procedures; +- 1873 iii) Event tracing procedures. + +1874 The subscriber tracing management procedures are used to manage the status and the type of the tracing. The subscriber +1875 tracing activation procedure is used at location updating or data restoration when the trace mode of a subscriber is set +1876 active in the HLR or, as a stand alone procedure, when the subscriber is already registered and the trace mode becomes +1877 active in the HLR. The procedures to activate tracing in the VLR are shown in figures 20.2/1 and 20.2/3. The +1878 procedures to activate tracing in the SGSN are shown in figures 20.2/2 and 20.2/4. + +![Sequence diagram for non-GPRS tracing activation involving VLR, HLR, and OMC.](0eb9f817692d7c6ea4ff57e4e31b492c_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant HLR + participant VLR + Note right of OMC: 1) Subscriber Tracing Activation + OMC->>HLR: 2) MAP_ACTIVATE_TRACE_MODE_req/ind + HLR->>VLR: 3) MAP_ACTIVATE_TRACE_MODE_rsp/cnf + HLR->>OMC: 4) Subscriber Tracing Activation Accepted + +``` + +Sequence diagram for non-GPRS tracing activation involving VLR, HLR, and OMC. + +1879 +1880 +1881 +1882 +1883 +1884 +1885 +1886 + +- 1) Subscriber Tracing Activation +- 2) MAP\_ACTIVATE\_TRACE\_MODE\_req/ind +- 3) MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf +- 4) Subscriber Tracing Activation Accepted + +**Figure 20.2/1: Stand-alone subscriber tracing activation procedure for non-GPRS** + +1887 + +![Sequence diagram for GPRS tracing activation involving SGSN, HLR, and OMC.](493232c165f622d2ab5b27b05787e85b_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant HLR + participant SGSN + Note right of OMC: 1) Subscriber Tracing Activation + OMC->>HLR: 2) MAP_ACTIVATE_TRACE_MODE_req/ind + HLR->>SGSN: 3) MAP_ACTIVATE_TRACE_MODE_rsp/cnf + HLR->>OMC: 4) Subscriber Tracing Activation Accepted + +``` + +Sequence diagram for GPRS tracing activation involving SGSN, HLR, and OMC. + +1888 +1889 +1890 +1891 +1892 +1893 +1894 +1895 + +- 1) Subscriber Tracing Activation +- 2) MAP\_ACTIVATE\_TRACE\_MODE\_req/ind +- 3) MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf +- 4) Subscriber Tracing Activation Accepted + +**Figure 20.2/2: Stand-alone subscriber tracing activation procedure for GPRS** + +1896 + +![Sequence diagram for Figure 20.2/3 showing the interaction between VLR and HLR. The sequence consists of four steps: 1) VLR to HLR (MAP_UPDATE_LOCATION or MAP_RESTORE_DATA_req/ind), 2) HLR to VLR (MAP_ACTIVATE_TRACE_MODE_req/ind), 3) VLR to HLR (MAP_ACTIVATE_TRACE_MODE_rsp/cnf), and 4) HLR to VLR (MAP_UPDATE_LOCATION_rsp/cnf or MAP_RESTORE_DATA_rsp/cnf).](0ab41cb59d8d1227f6df86aaa7e9b093_img.jpg) + +``` + +sequenceDiagram + participant VLR + participant HLR + Note right of HLR: 1) + VLR->>HLR: + Note left of VLR: 2) + HLR->>VLR: + Note right of HLR: 3) + VLR->>HLR: + Note left of VLR: 4) + HLR->>VLR: + +``` + +Sequence diagram for Figure 20.2/3 showing the interaction between VLR and HLR. The sequence consists of four steps: 1) VLR to HLR (MAP\_UPDATE\_LOCATION or MAP\_RESTORE\_DATA\_req/ind), 2) HLR to VLR (MAP\_ACTIVATE\_TRACE\_MODE\_req/ind), 3) VLR to HLR (MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf), and 4) HLR to VLR (MAP\_UPDATE\_LOCATION\_rsp/cnf or MAP\_RESTORE\_DATA\_rsp/cnf). + +1897 + +1898 + +1899 1) MAP\_UPDATE\_LOCATION or MAP\_RESTORE\_DATA\_req/ind + +1900 + +2) MAP\_ACTIVATE\_TRACE\_MODE\_req/ind + +1901 + +3) MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf + +1902 + +4) MAP\_UPDATE\_LOCATION\_rsp/cnf or MAP\_RESTORE\_DATA\_rsp/cnf + +1903 + +1904 + +**Figure 20.2/3: Subscriber tracing activation procedure at location updating or data restoration** + +1905 + +![Sequence diagram for Figure 20.2/4 showing the interaction between SGSN and HLR. The sequence consists of four steps: 1) SGSN to HLR (MAP_UPDATE_GPRS_LOCATION_req/ind), 2) HLR to SGSN (MAP_ACTIVATE_TRACE_MODE_req/ind), 3) SGSN to HLR (MAP_ACTIVATE_TRACE_MODE_rsp/cnf), and 4) HLR to SGSN (MAP_UPDATE_GPRS_LOCATION_rsp/cnf).](5c7d818d8c0e801f5226c9ab6445df08_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant HLR + Note right of HLR: 1) + SGSN->>HLR: + Note left of SGSN: 2) + HLR->>SGSN: + Note right of HLR: 3) + SGSN->>HLR: + Note left of SGSN: 4) + HLR->>SGSN: + +``` + +Sequence diagram for Figure 20.2/4 showing the interaction between SGSN and HLR. The sequence consists of four steps: 1) SGSN to HLR (MAP\_UPDATE\_GPRS\_LOCATION\_req/ind), 2) HLR to SGSN (MAP\_ACTIVATE\_TRACE\_MODE\_req/ind), 3) SGSN to HLR (MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf), and 4) HLR to SGSN (MAP\_UPDATE\_GPRS\_LOCATION\_rsp/cnf). + +1906 + +1907 + +1908 + +1) MAP\_UPDATE\_GPRS\_LOCATION\_req/ind + +1909 + +2) MAP\_ACTIVATE\_TRACE\_MODE\_req/ind + +1910 + +3) MAP\_ACTIVATE\_TRACE\_MODE\_rsp/cnf + +1911 + +4) MAP\_UPDATE\_GPRS\_LOCATION\_rsp/cnf + +1912 + +1913 + +**Figure 20.2/4: Subscriber tracing activation procedure at GPRS location updating** + +1914 The MAP\_ACTIVATE\_TRACE\_MODE request includes the IMSI, trace reference, trace type and identity of the + +1915 OMC. + +1916 The subscriber tracing deactivation procedure is used when tracing of a subscriber in the VLR or in the SGSN is no + +1917 longer required. The procedures are shown in figures 20.2/5 and 20.2/6. + +1918 +1919 +1920 +1921 +1922 +1923 +1924 +1925 + +![Sequence diagram for Figure 20.2/5: Subscriber tracing deactivation procedure for non-GPRS. Lifelines: VLR, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to VLR. Step 3: VLR to HLR. Step 4: HLR to OMC.](d6d9874e255955cbc5b5e94235d3e0b1_img.jpg) + +``` + +sequenceDiagram + participant VLR + participant HLR + participant OMC + OMC->>HLR: 1 + HLR->>VLR: 2 + VLR->>HLR: 3 + HLR->>OMC: 4 + +``` + +Sequence diagram for Figure 20.2/5: Subscriber tracing deactivation procedure for non-GPRS. Lifelines: VLR, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to VLR. Step 3: VLR to HLR. Step 4: HLR to OMC. + +- 1) Subscriber Tracing Deactivation +- 2) MAP\_DEACTIVATE\_TRACE\_MODE\_req/ind +- 3) MAP\_DEACTIVATE\_TRACE\_MODE\_rsp/cnf +- 4) Subscriber Tracing Deactivation Accepted + +**Figure 20.2/5: Subscriber tracing deactivation procedure for non-GPRS** + +![Sequence diagram for Figure 20.2/6: Subscriber tracing deactivation procedure for GPRS. Lifelines: SGSN, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to SGSN. Step 3: SGSN to HLR. Step 4: HLR to OMC.](a693ed717fe54e3c7f29cfddc82542b7_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant HLR + participant OMC + OMC->>HLR: 1 + HLR->>SGSN: 2 + SGSN->>HLR: 3 + HLR->>OMC: 4 + +``` + +Sequence diagram for Figure 20.2/6: Subscriber tracing deactivation procedure for GPRS. Lifelines: SGSN, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to SGSN. Step 3: SGSN to HLR. Step 4: HLR to OMC. + +1926 +1927 +1928 +1929 +1930 +1931 +1932 +1933 + +- 1) Subscriber Tracing Deactivation +- 2) MAP\_DEACTIVATE\_TRACE\_MODE\_req/ind +- 3) MAP\_DEACTIVATE\_TRACE\_MODE\_rsp/cnf +- 4) Subscriber Tracing Deactivation Accepted + +**Figure 20.2/6: Subscriber tracing deactivation procedure for GPRS** + +1934 The subscriber tracing procedures are used when the VLR detects any subscriber related activity for which the trace +1935 mode is activated, e.g. the VLR receives a MAP\_PROCESS\_ACCESS\_REQUEST indication. The procedure is shown +1936 in figure 20.2/7. + +![Sequence diagram for Figure 20.2/7: Subscriber tracing procedure in the serving MSC. Lifelines: MSC, VLR, OMC. Step 1: MSC to VLR. Step 2: VLR to MSC. Step 3: VLR to OMC.](d49c368a5d9f037f252cadd6e1f6ea07_img.jpg) + +``` + +sequenceDiagram + participant MSC + participant VLR + participant OMC + MSC->>VLR: 1 + VLR->>MSC: 2 + VLR->>OMC: 3 + +``` + +Sequence diagram for Figure 20.2/7: Subscriber tracing procedure in the serving MSC. Lifelines: MSC, VLR, OMC. Step 1: MSC to VLR. Step 2: VLR to MSC. Step 3: VLR to OMC. + +1937 +1938 +1939 +1940 +1941 +1942 +1943 + +- 1) MAP\_PROCESS\_ACCESS\_REQUEST\_req/ind +- 2) MAP\_TRACE\_SUBSCRIBER\_ACTIVITY\_req/ind +- 3) Subscriber tracing information + +**Figure 20.2/7: Subscriber tracing procedure in the serving MSC** + +## 1944 20.2.1 Subscriber tracing activation procedure + +### 1945 20.2.1.1 Procedures in the HLR + +1946 A subscriber tracing activation request from the OMC starts the appropriate process in the HLR: + +1947 ATM\_With\_VLR\_HLR if tracing is required in the MSC/VLR, ATM\_With\_SGSN\_HLR if tracing is required in the +1948 SGSN. + +1949 The process in the HLR to activate tracing in the VLR is shown in figure 20.2/8. The MAP process invokes macros not +1950 defined in this clause; the definitions of these macros can be found as follows: + +1951     Receive\_Open\_Cnf     see clause 25.1.2; + +1952     Check\_Confirmation    see clause 25.2.2. + +1953 Sheet 1: If the Repeat attempt counter has reached its limit, the test "Repeat Attempt" takes the "No" exit; otherwise the +1954 test takes the "Yes" exit. The number of repeat attempts and the interval between successive repeat attempts are +1955 operator options. + +1956 The process in the HLR to activate tracing in the SGSN is shown in figure 20.2/9. The MAP process invokes macros +1957 not defined in this clause; the definitions of these macros can be found as follows: + +1958     Receive\_Open\_Cnf     see clause 25.1.2; + +1959     Check\_Confirmation    see clause 25.2.2. + +1960 Sheet 1: If the Repeat attempt counter has reached its limit, the test "Repeat Attempt" takes the "No" exit; otherwise the +1961 test takes the "Yes" exit. The number of repeat attempts and the interval between successive repeat attempts are +1962 operator options. + +### 1963 20.2.1.2 Procedure in the VLR + +1964 The process in the VLR to activate tracing in a stand-alone dialogue is shown in figure 20.2/10. The MAP process +1965 invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1966     Check\_Indication      see clause 25.2.1. + +### 1967 20.2.1.3 Procedure in the SGSN + +1968 The process in the SGSN to activate tracing in a stand-alone dialogue is shown in figure 20.2/11. The MAP process +1969 invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +1970     Check\_Indication      see clause 25.2.1. + +## 1971 20.2.2 Subscriber tracing deactivation procedure + +### 1972 20.2.2.1 Procedures in the HLR + +1973 A subscriber tracing deactivation request from the OMC starts the appropriate process in the HLR: + +1974 DTM\_HLR\_With\_VLR if tracing is no longer required in the MSC/VLR, DTM\_HLR\_With\_SGSN if tracing is no +1975 longer required in the SGSN. + +1976 The process in the HLR to deactivate tracing in the VLR is shown in figure 20.2/12. The MAP process invokes macros +1977 not defined in this clause; the definitions of these macros can be found as follows: + +1978     Receive\_Open\_Cnf     see clause 25.1.2; + +1979     Check\_Confirmation    see clause 25.2.2. + +1980 Sheet 1: If the Repeat attempt counter has reached its limit, the test "Repeat Attempt" takes the "No" exit; otherwise the +1981 test takes the "Yes" exit. The number of repeat attempts and the interval between successive repeat attempts are +1982 operator options. + +1983 The process in the HLR to deactivate tracing in the SGSN is shown in figure 20.2/13. The MAP process invokes macros +1984 not defined in this clause; the definitions of these macros can be found as follows: + +1985     Receive\_Open\_Cnf     see clause 25.1.2; + +1986     Check\_Confirmation     see clause 25.2.2. + +1987 Sheet 1: If the Repeat attempt counter has reached its limit, the test "Repeat Attempt" takes the "No" exit; otherwise the +1988 test takes the "Yes" exit. The number of repeat attempts and the interval between successive repeat attempts are +1989 operator options. + +#### 1990 20.2.2.2     Procedure in the VLR + +1991 The process in the VLR to deactivate tracing is shown in figure 20.2/14. The MAP process invokes a macro not defined +1992 in this clause; the definition of this macro can be found as follows: + +1993     Check\_Indication     see clause 25.2.1. + +#### 1994 20.2.2.3     Procedure in the SGSN + +1995 The process in the SGSN to deactivate tracing is shown in figure 20.2/15. The MAP process invokes a macro not +1996 defined in this clause; the definition of this macro can be found as follows: + +1997     Check\_Indication     see clause 25.2.1. + +![Flowchart for process ATM_With_VLR_HLR. It starts with a Null state, followed by an OM_Subscriber_Tracing_Activation_ind. A decision 'Subscriber known?' leads to 'Set User Error: Unknown Subscriber' if No, or 'Subscriber tracing active in HLR?' if Yes. The 'Yes' path leads to 'Subscriber tracing active in HLR:=True' and then 'Subscriber deregistered?'. If 'Yes' to deregistered, it leads to 'Set User Error: Tracing already active'. If 'No', it leads to 'Subscriber in home PLMN area?'. If 'Yes', it leads to 'Repeat attempt counter:=0' and then a MAP request block. If 'No', it leads to 'Subscriber tracing active in VLR:=False'. The 'Subscriber known?' No path also leads to 'Subscriber tracing active in VLR:=False'. Both 'Subscriber tracing active in VLR:=False' states lead to 'OM_Subscriber_Tracing_Activation_rsp' and then Null. The MAP request block includes MAP_OPEN_req, MAP_ACTIVATE_TRACE_MODE_req, and MAP_DELIMITER_req, followed by 'Receive_Open_Cnf'. This leads to 'Error' (to connector 1), 'OK' (to 'Wait_For_ATM_Result'), or 'Vr' (to 'Perform MAP Vr dialogue' and then Null). A 'Repeat attempt?' decision at the top left leads to 'Subscriber tracing active in VLR:=False' if No, or 'Repeat attempt counter:= Repeat attempt counter+1' if Yes. The Yes path leads to 'Start repeat attempt timer', 'Wait_For_Timer_Expiry', and 'Repeat attempt timer expired' (triggered by an Internal event), which then leads to the MAP request block.](240935a46874e902465be02ff045e6ef_img.jpg) + +**process ATM\_With\_VLR\_HLR** **ATM\_VLR\_HLR1(2)** + +Process in the HLR to activate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the OMC + +``` + + graph TD + Start([Null]) --> Ind{{OM_Subscriber_Tracing_Activation_ind}} + Ind --> Known{Subscriber known?} + Known -- No --> ErrorUnknown[Set User Error: Unknown Subscriber] + Known -- Yes --> TracingActiveHLR{Subscriber tracing active in HLR?} + TracingActiveHLR -- True --> ErrorActive[Set User Error: Tracing already active] + TracingActiveHLR -- False --> TracingActiveHLRTrue[Subscriber tracing active in HLR:=True] + TracingActiveHLRTrue --> Deregistered{Subscriber deregistered?} + Deregistered -- Yes --> ErrorActive + Deregistered -- No --> HomePLMN{Subscriber in home PLMN area?} + HomePLMN -- No --> TracingActiveVLRFalse1[Subscriber tracing active in VLR:=False] + HomePLMN -- Yes --> CounterZero[Repeat attempt counter:=0] + CounterZero --> MAP_Req[MAP_OPEN_req +MAP_ACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req] + MAP_Req --> OpenCnf[Receive_Open_Cnf] + OpenCnf -- Error --> Connector1((1)) + OpenCnf -- OK --> WaitResult[Wait_For_ATM_Result] + OpenCnf -- Vr --> MAPVr[Perform MAP Vr dialogue] + MAPVr --> Null1([Null]) + ErrorUnknown --> OM_Rsp1{{OM_Subscriber_Tracing_Activation_rsp}} + OM_Rsp1 --> Null2([Null]) + ErrorActive --> OM_Rsp2{{OM_Subscriber_Tracing_Activation_rsp}} + OM_Rsp2 --> Null3([Null]) + TracingActiveVLRFalse1 --> OM_Rsp3{{OM_Subscriber_Tracing_Activation_rsp}} + OM_Rsp3 --> Null4([Null]) + + Connector2((1)) --> RepeatAttempt{Repeat attempt?} + RepeatAttempt -- No --> TracingActiveVLRFalse2[Subscriber tracing active in VLR:=False] + RepeatAttempt -- Yes --> CounterInc[Repeat attempt counter:= Repeat attempt counter+1] + CounterInc --> StartTimer[Start repeat attempt timer] + StartTimer --> WaitTimer[Wait_For_Timer_Expiry] + WaitTimer -- Internal --> TimerExpired[Repeat attempt timer expired] + TimerExpired --> CounterZero + +``` + +Flowchart for process ATM\_With\_VLR\_HLR. It starts with a Null state, followed by an OM\_Subscriber\_Tracing\_Activation\_ind. A decision 'Subscriber known?' leads to 'Set User Error: Unknown Subscriber' if No, or 'Subscriber tracing active in HLR?' if Yes. The 'Yes' path leads to 'Subscriber tracing active in HLR:=True' and then 'Subscriber deregistered?'. If 'Yes' to deregistered, it leads to 'Set User Error: Tracing already active'. If 'No', it leads to 'Subscriber in home PLMN area?'. If 'Yes', it leads to 'Repeat attempt counter:=0' and then a MAP request block. If 'No', it leads to 'Subscriber tracing active in VLR:=False'. The 'Subscriber known?' No path also leads to 'Subscriber tracing active in VLR:=False'. Both 'Subscriber tracing active in VLR:=False' states lead to 'OM\_Subscriber\_Tracing\_Activation\_rsp' and then Null. The MAP request block includes MAP\_OPEN\_req, MAP\_ACTIVATE\_TRACE\_MODE\_req, and MAP\_DELIMITER\_req, followed by 'Receive\_Open\_Cnf'. This leads to 'Error' (to connector 1), 'OK' (to 'Wait\_For\_ATM\_Result'), or 'Vr' (to 'Perform MAP Vr dialogue' and then Null). A 'Repeat attempt?' decision at the top left leads to 'Subscriber tracing active in VLR:=False' if No, or 'Repeat attempt counter:= Repeat attempt counter+1' if Yes. The Yes path leads to 'Start repeat attempt timer', 'Wait\_For\_Timer\_Expiry', and 'Repeat attempt timer expired' (triggered by an Internal event), which then leads to the MAP request block. + +1998 + +1999 + +Figure 20.2/8 (sheet 1 of 2): Process ATM\_With\_VLR\_HLR + +![State transition diagram for process ATM_With_VLR_HLR. The diagram shows a state machine with states represented by rounded rectangles and transitions represented by arrows. The initial state is 'Wait_For_ATM_Result'. Transitions include 'MAP_ACTIVATE_TRACE_MODE_cnf', 'MAP_NOTICE_ind', and 'MAP_CLOSE_req'. A 'Check_Confirmation' state leads to 'Subscriber tracing active in VLR:=True' and then to 'OM_Subscriber Tracing_Activation_rsp', which leads to the 'Null' state. Error transitions lead to a circle labeled '1'.](8141e6759be9baa334fc7833145d81ab_img.jpg) + +**process ATM\_With\_VLR\_HLR** **ATM\_VLR\_HLR2(2)** + +Process in the HLR to activate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the OMC + +``` + +stateDiagram-v2 + [*] --> Wait_For_ATM_Result + state "Wait_For_ATM_Result" as Wait_For_ATM_Result + state "MAP_ACTIVATE_TRACE_MODE_cnf" as MAP_ACTIVATE_TRACE_MODE_cnf + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Check_Confirmation" as Check_Confirmation + state "Subscriber tracing active in VLR:=True" as Subscriber_tracing_active_in_VLR_True + state "OM_Subscriber Tracing_Activation_rsp" as OM_Subscriber_Tracing_Activation_rsp + state "Null" as Null + state "1" as 1 + + Wait_For_ATM_Result --> MAP_ACTIVATE_TRACE_MODE_cnf + Wait_For_ATM_Result --> MAP_NOTICE_ind + Wait_For_ATM_Result --> MAP_CLOSE_req + + MAP_ACTIVATE_TRACE_MODE_cnf --> Check_Confirmation + Check_Confirmation --> Subscriber_tracing_active_in_VLR_True : OK + Check_Confirmation --> 1 : User Error, Provider Error, Data Error + + Subscriber_tracing_active_in_VLR_True --> OM_Subscriber_Tracing_Activation_rsp + OM_Subscriber_Tracing_Activation_rsp --> Null + +``` + +State transition diagram for process ATM\_With\_VLR\_HLR. The diagram shows a state machine with states represented by rounded rectangles and transitions represented by arrows. The initial state is 'Wait\_For\_ATM\_Result'. Transitions include 'MAP\_ACTIVATE\_TRACE\_MODE\_cnf', 'MAP\_NOTICE\_ind', and 'MAP\_CLOSE\_req'. A 'Check\_Confirmation' state leads to 'Subscriber tracing active in VLR:=True' and then to 'OM\_Subscriber Tracing\_Activation\_rsp', which leads to the 'Null' state. Error transitions lead to a circle labeled '1'. + +2000 + +2001 + +**Figure 20.2/8 (sheet 2 of 2): Process ATM\_With\_VLR\_HLR** + +![Flowchart for process ATM_With_SGSN_HLR. It starts with a 'Null' entry point, followed by an 'OM_GPRS_Subscriber_Activation_ind' input. A decision 'GPRS subscriber known?' leads to either 'Set User Error: Unknown Subscriber' (No) or 'Subscriber tracing active in HLR?' (Yes). The 'Yes' path leads to 'Subscriber tracing active in HLR=True', which then checks 'Subscriber deregistered?'. If 'Yes', it leads to 'Set User Error: Tracing already active'. If 'No', it checks 'Subscriber in home PLMN area?'. If 'Yes', it leads to 'Repeat attempt counter:=0'. If 'No', it leads to 'Subscriber tracing active in SGSN:=False'. Both 'Repeat attempt counter:=0' and 'Subscriber tracing active in SGSN:=False' lead to a MAP request block. The 'Repeat attempt counter:=0' path also includes 'Repeat attempt?' (Yes/No), 'Subscriber tracing active in SGSN:=False', 'Set: Subscriber Tracing Activation Failure', 'OM_GPRS_Subscriber_Activation_rsp', and 'Null'. The 'Yes' path of 'Repeat attempt?' leads to 'Repeat attempt counter:= Repeat attempt counter+1', 'Start repeat attempt timer', 'Wait_For_Timer_Expiry', and 'Repeat attempt timer expired'. An 'Internal' signal also leads to 'Repeat attempt timer expired'. All paths converge to a MAP request block containing 'MAP_OPEN_req', 'MAP_ACTIVATE_TRACE_MODE_req', and 'MAP_DELIMITER_req'. This is followed by 'Receive_Open_Cnf' with 'Error', 'OK', and 'Vr' outcomes. 'Error' leads to connector '1'. 'OK' leads to 'Wait_For_ATM_Result'. 'Vr' leads to 'Perform MAP Vr dialogue' and then 'Null'. A final 'OM_GPRS_Subscriber_Activation_rsp' leads to 'Null'.](aa07c1556282a134134e8e1f5902d8f6_img.jpg) + +**process ATM\_With\_SGSN\_HLR** **ATM\_SGSN\_HLR1(2)** + +Process in the HLR to activate trace mode in the SGSN using a stand-alone dialogue + +Signals to/from the left are to/from the SGSN; signals to/from the right are to/from the OMC + +``` + + graph TD + Start([Null]) --> Input{OM_GPRS_Subscriber_Activation_ind} + Input --> Decision1{GPRS subscriber known?} + Decision1 -- No --> Error1[Set User Error: Unknown Subscriber] + Decision1 -- Yes --> Decision2{Subscriber tracing active in HLR?} + Decision2 -- True --> Error2[Set User Error: Tracing already active] + Decision2 -- False --> State1[Subscriber tracing active in HLR=True] + State1 --> Decision3{Subscriber deregistered?} + Decision3 -- Yes --> Error2 + Decision3 -- No --> Decision4{Subscriber in home PLMN area?} + Decision4 -- No --> State2[Subscriber tracing active in SGSN:=False] + Decision4 -- Yes --> Counter0[Repeat attempt counter:=0] + Counter0 --> MAP_Req[MAP_OPEN_req +MAP_ACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req] + State2 --> MAP_Req + Error1 --> MAP_Req + Error2 --> MAP_Req + MAP_Req --> Receive[Receive_Open_Cnf] + Receive -- Error --> End1((1)) + Receive -- OK --> End2([Wait_For_ATM_Result]) + Receive -- Vr --> Dialogue[Perform MAP Vr dialogue] + Dialogue --> End3([Null]) + State2 --> Rsp{OM_GPRS_Subscriber_Activation_rsp} + Rsp --> End4([Null]) + + Counter0 --> Decision5{Repeat attempt?} + Decision5 -- No --> State2 + Decision5 -- Yes --> CounterInc[Repeat attempt counter:= Repeat attempt counter+1] + CounterInc --> StartTimer[Start repeat attempt timer] + StartTimer --> WaitTimer[Wait_For_Timer_Expiry] + WaitTimer --> TimerExpired[Repeat attempt timer expired] + Internal[Internal] --> TimerExpired + TimerExpired --> MAP_Req + +``` + +Flowchart for process ATM\_With\_SGSN\_HLR. It starts with a 'Null' entry point, followed by an 'OM\_GPRS\_Subscriber\_Activation\_ind' input. A decision 'GPRS subscriber known?' leads to either 'Set User Error: Unknown Subscriber' (No) or 'Subscriber tracing active in HLR?' (Yes). The 'Yes' path leads to 'Subscriber tracing active in HLR=True', which then checks 'Subscriber deregistered?'. If 'Yes', it leads to 'Set User Error: Tracing already active'. If 'No', it checks 'Subscriber in home PLMN area?'. If 'Yes', it leads to 'Repeat attempt counter:=0'. If 'No', it leads to 'Subscriber tracing active in SGSN:=False'. Both 'Repeat attempt counter:=0' and 'Subscriber tracing active in SGSN:=False' lead to a MAP request block. The 'Repeat attempt counter:=0' path also includes 'Repeat attempt?' (Yes/No), 'Subscriber tracing active in SGSN:=False', 'Set: Subscriber Tracing Activation Failure', 'OM\_GPRS\_Subscriber\_Activation\_rsp', and 'Null'. The 'Yes' path of 'Repeat attempt?' leads to 'Repeat attempt counter:= Repeat attempt counter+1', 'Start repeat attempt timer', 'Wait\_For\_Timer\_Expiry', and 'Repeat attempt timer expired'. An 'Internal' signal also leads to 'Repeat attempt timer expired'. All paths converge to a MAP request block containing 'MAP\_OPEN\_req', 'MAP\_ACTIVATE\_TRACE\_MODE\_req', and 'MAP\_DELIMITER\_req'. This is followed by 'Receive\_Open\_Cnf' with 'Error', 'OK', and 'Vr' outcomes. 'Error' leads to connector '1'. 'OK' leads to 'Wait\_For\_ATM\_Result'. 'Vr' leads to 'Perform MAP Vr dialogue' and then 'Null'. A final 'OM\_GPRS\_Subscriber\_Activation\_rsp' leads to 'Null'. + +2002 + +2003 + +Figure 20.2/9 (sheet 1 of 2): Process ATM\_with\_SGSN\_HLR + +![State transition diagram for process ATM_With_SGSN_HLR. It starts with a 'Wait_For_ATM_Result' state. Transitions include 'MAP_ACTIVATE_TRACE_MODE_cnf' leading to 'Check_Confirmation', 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req', and a self-loop on 'Wait_For_ATM_Result' labeled with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'. 'Check_Confirmation' has an 'OK' transition to 'Subscriber tracing active in SGSN=True', which leads to 'OM_GPRS_Subscriber_Tracing_Activation_rsp' and then to a 'Null' state. 'MAP_CLOSE_req' has a transition to a circle labeled '1' with labels 'User Error, Provider Error, Data Error'.](df079c3046a59bebedea2cc7a9ce5f98_img.jpg) + +**process ATM\_With\_SGSN\_HLR** **ATM\_SGSN\_HLR2(2)** + +Process in the HLR to activate trace mode in the SGSN using a stand-alone dialogue + +Wait\_For\_ATM\_Result + +Signals to/from the left are to/from the SGSN; signals to/from the right are to/from the OMC + +``` + +stateDiagram-v2 + [*] --> Wait_For_ATM_Result + state "Wait_For_ATM_Result" as Wait_For_ATM_Result + state "Check_Confirmation" as Check_Confirmation + state "Subscriber tracing active in SGSN=True" as Subscriber_tracing_active_in_SGSN_True + state "OM_GPRS_Subscriber_Tracing_Activation_rsp" as OM_GPRS_Subscriber_Tracing_Activation_rsp + state "Null" as Null + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "1" as 1 + + Wait_For_ATM_Result --> Check_Confirmation : MAP_ACTIVATE_TRACE_MODE_cnf + Check_Confirmation --> Subscriber_tracing_active_in_SGSN_True : OK + Subscriber_tracing_active_in_SGSN_True --> OM_GPRS_Subscriber_Tracing_Activation_rsp + OM_GPRS_Subscriber_Tracing_Activation_rsp --> Null + + Wait_For_ATM_Result --> MAP_CLOSE_req : MAP_NOTICE_ind + MAP_CLOSE_req --> 1 : User Error, Provider Error, Data Error + + Wait_For_ATM_Result --> Wait_For_ATM_Result : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + +``` + +State transition diagram for process ATM\_With\_SGSN\_HLR. It starts with a 'Wait\_For\_ATM\_Result' state. Transitions include 'MAP\_ACTIVATE\_TRACE\_MODE\_cnf' leading to 'Check\_Confirmation', 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req', and a self-loop on 'Wait\_For\_ATM\_Result' labeled with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'. 'Check\_Confirmation' has an 'OK' transition to 'Subscriber tracing active in SGSN=True', which leads to 'OM\_GPRS\_Subscriber\_Tracing\_Activation\_rsp' and then to a 'Null' state. 'MAP\_CLOSE\_req' has a transition to a circle labeled '1' with labels 'User Error, Provider Error, Data Error'. + +2004 + +2005 + +**Figure 20.2/9 (sheet 2 of 2): Process ATM\_with\_SGSN\_HLR** + +![Flowchart for process ATM_Stand_Alone_VLR. It starts with an initial node, followed by a 'Null' node. An input signal 'MAP_ACTIVATE_TRACE_MODE_ind' enters at a merge node. The flow then goes to 'Check_Indication'. From there, an 'OK' path leads to a decision 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to 'Tracing supported?'. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Tracing buffer full?'. If 'No', it goes to 'Subscriber tracing active:= True'. If 'Yes', it goes to 'Set User Error: Tracing buffer full'. All four error/active nodes lead to a merge node. From this merge node, an 'Error' path leads out to the left, and a response path leads to a split node with output signals 'MAP_ACTIVATE_TRACE_MODE_rsp' and 'MAP_CLOSE_req'. The process ends at a final node marked with an 'X'.](195bfcf817b1bea7a7c4ad3ba8c02ccc_img.jpg) + +process ATM\_Stand\_Alone\_VLR + +ATM\_SA\_VLR1(1) + +Process in the VLR to activate trace mode in a stand-alone-dialogue + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Merge{ } + MAP_ACTIVATE_TRACE_MODE_ind[MAP_ACTIVATE_TRACE_MODE_ind] --> Merge + Merge --> Check[Check_Indication] + Check -- OK --> SubKnown{Subscriber known?} + SubKnown -- No --> ErrUnid[Set User Error: Unidentified subscriber] + SubKnown -- Yes --> TracingSupp{Tracing supported?} + TracingSupp -- No --> ErrFac[Set User Error: Facility not supported] + TracingSupp -- Yes --> BufferFull{Tracing buffer full?} + BufferFull -- No --> SubActive[Subscriber tracing active:= True] + BufferFull -- Yes --> ErrFull[Set User Error: Tracing buffer full] + ErrUnid --> Merge2{ } + ErrFac --> Merge2 + SubActive --> Merge2 + ErrFull --> Merge2 + Merge2 -- Error --> OutLeft[ ] + Merge2 --> Split{ } + Split --> MAP_ACTIVATE_TRACE_MODE_rsp[MAP_ACTIVATE_TRACE_MODE_rsp] + Split --> MAP_CLOSE_req[MAP_CLOSE_req] + Split --> End([X]) + +``` + +Flowchart for process ATM\_Stand\_Alone\_VLR. It starts with an initial node, followed by a 'Null' node. An input signal 'MAP\_ACTIVATE\_TRACE\_MODE\_ind' enters at a merge node. The flow then goes to 'Check\_Indication'. From there, an 'OK' path leads to a decision 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to 'Tracing supported?'. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Tracing buffer full?'. If 'No', it goes to 'Subscriber tracing active:= True'. If 'Yes', it goes to 'Set User Error: Tracing buffer full'. All four error/active nodes lead to a merge node. From this merge node, an 'Error' path leads out to the left, and a response path leads to a split node with output signals 'MAP\_ACTIVATE\_TRACE\_MODE\_rsp' and 'MAP\_CLOSE\_req'. The process ends at a final node marked with an 'X'. + +2006 + +2007 + +Figure 20.2/10: Process ATM\_Standalone\_VLR + +![Flowchart for process ATM_Stand_Alone_SGSN. It starts with 'Null', then receives 'MAP_ACTIVATE_TRACE_MODE_ind'. It checks the indication, then if the subscriber is known and tracing is supported, it checks if the tracing buffer is full. Depending on these checks, it either sets tracing active, sets an error (facility not supported, buffer full, or unidentified subscriber), or returns a response with 'MAP_ACTIVATE_TRACE_MODE_rsp' and 'MAP_CLOSE_req'.](6c2f572f3cbbbae048521f83d7add4da_img.jpg) + +process ATM\_Stand\_Alone\_SGSN ATM\_SA\_SGSN1(1) + +Process in the SGSN to activate trace mode in a stand-alone-dialogue + +Signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Null]) --> In{ } + In -- "MAP_ACTIVATE_TRACE_MODE_ind" --> In + In --> Check[Check Indication] + Check --> OK{OK} + OK -- No --> Unknown[Set User Error: Unidentified subscriber] + OK -- Yes --> Supported{Tracing supported?} + Supported -- No --> NotSupported[Set User Error: Facility not supported] + Supported -- Yes --> Full{Tracing buffer full?} + Full -- Yes --> BufferFull[Set User Error: Tracing buffer full] + Full -- No --> Active[Subscriber tracing active:= True] + Unknown --> Out{ } + NotSupported --> Out + BufferFull --> Out + Active --> Out + Out -- "MAP_ACTIVATE_TRACE_MODE_rsp +MAP_CLOSE_req" --> End(( )) + +``` + +Flowchart for process ATM\_Stand\_Alone\_SGSN. It starts with 'Null', then receives 'MAP\_ACTIVATE\_TRACE\_MODE\_ind'. It checks the indication, then if the subscriber is known and tracing is supported, it checks if the tracing buffer is full. Depending on these checks, it either sets tracing active, sets an error (facility not supported, buffer full, or unidentified subscriber), or returns a response with 'MAP\_ACTIVATE\_TRACE\_MODE\_rsp' and 'MAP\_CLOSE\_req'. + +2008 + +2009 + +Figure 20.2/11: Process ATM\_Standalone\_SGSN + +![Flowchart for process DTM_With_VLR_HLR. It starts with an entry point leading to a 'Null' state. From 'Null', it goes to 'OM_Subscriber_Tracing_Deactivation_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown Subscriber' and then to 'Null'. If 'Yes', it checks 'Subscriber tracing active in HLR'. If 'False', it goes to 'Set User Error: Unknown Subscriber'. If 'True', it checks 'Subscriber tracing active in VLR'. If 'False', it goes to 'Set User Error: Unknown Subscriber'. If 'True', it sets 'Repeat attempt counter:=0' and then sends MAP messages (MAP_OPEN_req, MAP_DEACTIVATE_TRACE_MODE_req, MAP_DELIMITER_req) via an internal process to 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', three outcomes are possible: 'Error' leads to exit point '1'; 'OK' leads to 'Wait_For_DTM_Result'; 'Vr' leads to 'Perform MAP Vr dialogue' and then to 'Null'. Another path from 'OM_Subscriber_Tracing_Deactivation_ind' leads to a decision 'Repeat attempt?'. If 'Yes', it increments 'Repeat attempt counter:= Repeat attempt counter+1', starts a timer, and waits for 'Timer_Expired'. If 'Internal' signal occurs, it loops back to 'Repeat attempt?'. If 'No', it checks 'Subscriber tracing active in VLR:=True', sets 'Subscriber Tracing Deactivation Failure', sends 'OM_Subscriber_Tracing_Deactivation_rsp', and ends at 'Null'.](5f46be30e6ab02f9ce75b6ed98bb0d50_img.jpg) + +**process DTM\_With\_VLR\_HLR** **DTM\_VLR\_HLR1(2)** + +Process in the HLR to deactivate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the OMC + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> OM1{{OM_Subscriber_Tracing_Deactivation_ind}} + + OM1 --> SubKnown{Subscriber known?} + SubKnown -- No --> UserError1[Set User Error: Unknown Subscriber] + UserError1 --> Null2([Null]) + + SubKnown -- Yes --> SubActiveHLR{Subscriber tracing active in HLR} + SubActiveHLR -- False --> UserError1 + SubActiveHLR -- True --> SubActiveVLR{Subscriber tracing active in VLR} + + SubActiveVLR -- False --> UserError1 + SubActiveVLR -- True --> Counter0[Repeat attempt counter:=0] + + Counter0 --> Internal1[Internal] + Internal1 --> MAPReq["MAP_OPEN_req +MAP_DEACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req"] + + MAPReq --> RecvCnf[Receive_Open_Cnf] + + RecvCnf -- Error --> Exit1((1)) + RecvCnf -- OK --> WaitResult[Wait_For_DTM_Result] + RecvCnf -- Vr --> MAPVr[Perform MAP Vr dialogue] + + MAPVr --> Null3([Null]) + + OM1 --> RepeatAttempt{Repeat attempt?} + + RepeatAttempt -- Yes --> CounterInc[Repeat attempt counter:= +Repeat attempt counter+1] + + CounterInc --> StartTimer[Start repeat attempt timer] + + StartTimer --> WaitTimer[Wait_For_Timer_Expired] + + WaitTimer --> TimerExpired[Repeat attempt timer expired] + + TimerExpired --> RepeatAttempt + + RepeatAttempt -- No --> SubActiveVLR2[Subscriber tracing active in VLR:=True] + + SubActiveVLR2 --> SetFailure[Set: Subscriber Tracing Deactivation Failure] + + SetFailure --> OM2{{OM_Subscriber_Tracing_Deactivation_rsp}} + + OM2 --> Null4([Null]) + +``` + +Flowchart for process DTM\_With\_VLR\_HLR. It starts with an entry point leading to a 'Null' state. From 'Null', it goes to 'OM\_Subscriber\_Tracing\_Deactivation\_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown Subscriber' and then to 'Null'. If 'Yes', it checks 'Subscriber tracing active in HLR'. If 'False', it goes to 'Set User Error: Unknown Subscriber'. If 'True', it checks 'Subscriber tracing active in VLR'. If 'False', it goes to 'Set User Error: Unknown Subscriber'. If 'True', it sets 'Repeat attempt counter:=0' and then sends MAP messages (MAP\_OPEN\_req, MAP\_DEACTIVATE\_TRACE\_MODE\_req, MAP\_DELIMITER\_req) via an internal process to 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', three outcomes are possible: 'Error' leads to exit point '1'; 'OK' leads to 'Wait\_For\_DTM\_Result'; 'Vr' leads to 'Perform MAP Vr dialogue' and then to 'Null'. Another path from 'OM\_Subscriber\_Tracing\_Deactivation\_ind' leads to a decision 'Repeat attempt?'. If 'Yes', it increments 'Repeat attempt counter:= Repeat attempt counter+1', starts a timer, and waits for 'Timer\_Expired'. If 'Internal' signal occurs, it loops back to 'Repeat attempt?'. If 'No', it checks 'Subscriber tracing active in VLR:=True', sets 'Subscriber Tracing Deactivation Failure', sends 'OM\_Subscriber\_Tracing\_Deactivation\_rsp', and ends at 'Null'. + +2010 + +2011 + +Figure 20.2/12 (sheet 1 of 2): Process DTM\_with\_VLR\_HLR + +![State transition diagram for process DTM_With_VLR_HLR. It starts at 'Wait_For_DTM_Result' and branches into three paths: 1) MAP_DEACTIVATE_TRACE_MODE_cnf leads to 'Check_Confirmation' (OK path leads to 'Subscriber tracing active in VLR:=False' -> 'OM_Subscriber Tracing_Deactivation_rsp' -> 'Null'); 2) MAP_NOTICE_ind leads to 'MAP_CLOSE_req' which has an error path ('User Error, Provider Error, Data Error') and a transition to state '1'; 3) An unlabeled path leads to a state with MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind.](c2cc2ebb8004b97b8922758a0ae0a1ed_img.jpg) + +**process DTM\_With\_VLR\_HLR** **DTM\_VLR\_HLR2(2)** + +Process in the HLR to deactivate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the OMC + +``` + +stateDiagram-v2 + [*] --> Wait_For_DTM_Result + state "MAP_DEACTIVATE_TRACE_MODE_cnf" as MAP_DEACTIVATE_TRACE_MODE_cnf + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Subscriber tracing active in VLR:=False" as Subscriber_tracing_active_in_VLR_False + state "OM_Subscriber Tracing_Deactivation_rsp" as OM_Subscriber_Tracing_Deactivation_rsp + state "Null" as Null + state "1" as 1 + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + + Wait_For_DTM_Result --> MAP_DEACTIVATE_TRACE_MODE_cnf + Wait_For_DTM_Result --> MAP_NOTICE_ind + Wait_For_DTM_Result --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + + MAP_DEACTIVATE_TRACE_MODE_cnf --> Check_Confirmation + state "Check_Confirmation" as Check_Confirmation + Check_Confirmation --> Subscriber_tracing_active_in_VLR_False : OK + Check_Confirmation --> MAP_CLOSE_req : User Error, Provider Error, Data Error + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> 1 : User Error, Provider Error, Data Error + +``` + +State transition diagram for process DTM\_With\_VLR\_HLR. It starts at 'Wait\_For\_DTM\_Result' and branches into three paths: 1) MAP\_DEACTIVATE\_TRACE\_MODE\_cnf leads to 'Check\_Confirmation' (OK path leads to 'Subscriber tracing active in VLR:=False' -> 'OM\_Subscriber Tracing\_Deactivation\_rsp' -> 'Null'); 2) MAP\_NOTICE\_ind leads to 'MAP\_CLOSE\_req' which has an error path ('User Error, Provider Error, Data Error') and a transition to state '1'; 3) An unlabeled path leads to a state with MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. + +2012 + +2013 + +**Figure 20.2/12 (sheet 2 of 2): Process DTM\_with\_VLR\_HLR** + +![Flowchart for process DTM_With_SGSN_HLR. It starts with a connector '1' leading to a decision 'Repeat attempt?'. If 'No', it checks if tracing is active in SGSN, sets a failure, and sends a response. If 'Yes', it increments a counter and starts a timer. After the timer expires, it checks if tracing is active in HLR. If 'False', it sends a response. If 'True', it resets the counter and sends MAP requests. The MAP requests result in 'Error', 'OK', or 'Vr' responses, leading to connectors '1', 'Wait_For_DTM_Result', or 'Null' respectively. A 'Null' entry point also leads to a 'Subscriber known?' check. If 'No', it sets an unknown subscriber error. If 'Yes', it checks if tracing is active in HLR. If 'False', it sends a response. If 'True', it checks if tracing is active in SGSN. If 'False', it sends a response. If 'True', it resets the counter and sends MAP requests.](50c70e799740b36cdcc2da0c90d0c12a_img.jpg) + +**process DTM\_With\_SGSN\_HLR** **DTM\_SGSN\_HLR1(2)** + +Process in the HLR to deactivate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the OMC; signals to/from the right are to/from the SGSN + +``` + + graph TD + subgraph Left [ ] + direction TB + L1((1)) --> L2{Repeat attempt?} + L2 -- No --> L3[Subscriber tracing active in SGSN:=True] + L3 --> L4[Set: Subscriber Tracing Deactivation Failure] + L4 --> L5[OM_GPRS_Subscriber_Tracing_Deactivation_rsp] + L5 --> L6[Null] + L2 -- Yes --> L7[Repeat attempt counter:= Repeat attempt counter+1] + L7 --> L8[Start repeat attempt timer] + L8 --> L9[Wait_For_Timer_Expiry] + L9 --> L10[Repeat attempt timer expired] + L10 --> L11[ ] + L11 -.-> Internal[Internal] + end + + subgraph Right [ ] + direction TB + R1[Null] --> R2[OM_GPRS_Subscriber_Tracing_Deactivation_ind] + R2 --> R3{Subscriber known?} + R3 -- No --> R4[Set User Error: Unknown Subscriber] + R3 -- Yes --> R5{Subscriber tracing active in HLR} + R5 -- False --> R6[ ] + R5 -- True --> R7[Subscriber tracing active in HLR:=False] + R7 --> R8{Subscriber tracing active in SGSN} + R8 -- False --> R9[ ] + R8 -- True --> R10[Repeat attempt counter:=0] + R10 --> R11[ ] + R11 --> R12[MAP_OPEN_req +MAP_DEACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req] + R12 --> R13[Receive_Open_Cnf] + R13 -- Error --> R14((1)) + R13 -- OK --> R15[Wait_For_DTM_Result] + R13 -- Vr --> R16[Perform MAP Vr dialogue] + R16 --> R17[Null] + R17 --> R18[ ] + R18 --> R19[OM_GPRS_Subscriber_Tracing_Deactivation_rsp] + R19 --> R20[Null] + end + + L11 --> R11 + R4 --> R20 + +``` + +Flowchart for process DTM\_With\_SGSN\_HLR. It starts with a connector '1' leading to a decision 'Repeat attempt?'. If 'No', it checks if tracing is active in SGSN, sets a failure, and sends a response. If 'Yes', it increments a counter and starts a timer. After the timer expires, it checks if tracing is active in HLR. If 'False', it sends a response. If 'True', it resets the counter and sends MAP requests. The MAP requests result in 'Error', 'OK', or 'Vr' responses, leading to connectors '1', 'Wait\_For\_DTM\_Result', or 'Null' respectively. A 'Null' entry point also leads to a 'Subscriber known?' check. If 'No', it sets an unknown subscriber error. If 'Yes', it checks if tracing is active in HLR. If 'False', it sends a response. If 'True', it checks if tracing is active in SGSN. If 'False', it sends a response. If 'True', it resets the counter and sends MAP requests. + +2014 + +2015 + +Figure 20.2/13 (sheet 1 of 2): Process DTM\_with\_SGSN\_HLR + +![Flowchart for process DTM_With_SGSN_HLR. It starts with 'Wait_For_DTM_Result' leading to a split. The left path sends 'MAP_DEACTIVATE_TRACE_MODE_cnf', checks confirmation, and if 'OK', sets 'Subscriber tracing active in SGSN:=False' and sends 'OM_GPRS_Subscriber_Tracing_Deactivation_rsp' to 'Null'. The right path receives 'MAP_NOTICE_ind', sends 'MAP_CLOSE_req', and then joins a common path leading to connector '1'. A 'User Error, Provider Error, Data Error' is also shown on the right path. A third split on the right leads to a box with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'.](240d035b4af1a1143c0a31b95362f077_img.jpg) + +**process DTM\_With\_SGSN\_HLR** **DTM\_SGSN\_HLR2(2)** + +Process in the HLR to deactivate trace mode in the VLR using a stand-alone dialogue + +Signals to/from the left are to/from the SGSN; signals to/from the right are to/from the OMC + +``` + +graph TD + Start([Wait_For_DTM_Result]) --> Split1(( )) + Split1 --> LeftPath[MAP_DEACTIVATE_TRACE_MODE_cnf] + Split1 --> RightPath1[MAP_NOTICE_ind] + Split1 --> RightPath2[ ] + LeftPath --> Check[Check Confirmation] + Check -- OK --> Active[Subscriber tracing active in SGSN:=False] + Active --> Rsp[OM_GPRS_Subscriber_Tracing_Deactivation_rsp] + Rsp --> Null([Null]) + RightPath1 --> CloseReq{MAP_CLOSE_req} + CloseReq --> Join1(( )) + RightPath2 --> Error[User Error, Provider Error, Data Error] + Error --> Join1 + RightPath2 --> RightPath3[ ] + RightPath3 --> Indications[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Indications --> Join1 + Join1 --> Connector1((1)) + +``` + +Flowchart for process DTM\_With\_SGSN\_HLR. It starts with 'Wait\_For\_DTM\_Result' leading to a split. The left path sends 'MAP\_DEACTIVATE\_TRACE\_MODE\_cnf', checks confirmation, and if 'OK', sets 'Subscriber tracing active in SGSN:=False' and sends 'OM\_GPRS\_Subscriber\_Tracing\_Deactivation\_rsp' to 'Null'. The right path receives 'MAP\_NOTICE\_ind', sends 'MAP\_CLOSE\_req', and then joins a common path leading to connector '1'. A 'User Error, Provider Error, Data Error' is also shown on the right path. A third split on the right leads to a box with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'. + +2016 + +2017 + +**Figure 20.2/13 (sheet 2 of 2): Process DTM\_with\_SGSN\_HLR** + +![Flowchart for process DTM_Stand_Alone_VLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop via a merge symbol (chevron) receiving 'MAP_DEACTIVATE_TRACE_MODE_ind'. A 'Check_Indication' block follows. An 'OK' path leads to a 'Subscriber known?' decision. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to a 'Tracing supported?' decision. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Subscriber tracing active:= False'. All three error/processing blocks lead to a merge symbol (cross) before sending 'MAP_DEACTIVATE_TRACE_MODE_rsp' and 'MAP_CLOSE_req' via another merge symbol (chevron), ending at an exit symbol (cross). An 'Error' path from the 'Check_Indication' block also leads to the first merge symbol (cross).](7294734c2ddd2be18cc08977e6ea7d2f_img.jpg) + +process DTM\_Stand\_Alone\_VLR + +DTM\_SA\_VLR1(1) + +Process in the VLR to deactivate trace mode in a stand-alone-dialogue + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Merge1{ } + Merge1 --> Check[Check_Indication] + Check -- OK --> SubKnown{Subscriber known?} + Check -- Error --> Merge2{ } + SubKnown -- No --> Err1[Set User Error: +Unidentified +subscriber] + SubKnown -- Yes --> TracingSupp{Tracing supported?} + TracingSupp -- No --> Err2[Set User Error: +Facility not +supported] + TracingSupp -- Yes --> ActFalse[Subscriber +tracing active:= +False] + Err1 --> Merge2 + Err2 --> Merge2 + ActFalse --> Merge2 + Merge2 --> Merge3{ } + Merge3 --> Send[MAP_DEACTIVATE_TRACE_MODE_rsp +MAP_CLOSE_req] + Send --> Exit[ ] + +``` + +Flowchart for process DTM\_Stand\_Alone\_VLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop via a merge symbol (chevron) receiving 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind'. A 'Check\_Indication' block follows. An 'OK' path leads to a 'Subscriber known?' decision. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to a 'Tracing supported?' decision. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Subscriber tracing active:= False'. All three error/processing blocks lead to a merge symbol (cross) before sending 'MAP\_DEACTIVATE\_TRACE\_MODE\_rsp' and 'MAP\_CLOSE\_req' via another merge symbol (chevron), ending at an exit symbol (cross). An 'Error' path from the 'Check\_Indication' block also leads to the first merge symbol (cross). + +2018 + +2019 + +Figure 20.2/14: Process DTM\_Standalone\_VLR + +![Flowchart for process DTM_Stand_Alone_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop via a merge symbol (circle with a line) associated with 'MAP_DEACTIVATE_TRACE_MODE_ind'. A 'Check Indication' block follows. An 'OK' path leads to a 'Subscriber known?' decision. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to a 'Tracing supported?' decision. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Subscriber tracing active:= False'. All three error/processing blocks lead to a merge symbol (circle with a line) associated with 'MAP_DEACTIVATE_TRACE_MODE_rsp' and 'MAP_CLOSE_req'. An 'Error' path from the 'Check Indication' block also leads to this merge symbol. The process ends with an exit symbol (crossed lines).](7d4ca396ee7dcc1f8da61ad2ed9c6c07_img.jpg) + +process DTM\_Stand\_Alone\_SGSN + +DTM\_SA\_SGSN1(1) + +Process in the SGSN to deactivate trace mode in a stand-alone-dialogue + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Merge1(( )) + Merge1 --- MAP_DEACTIVATE_TRACE_MODE_ind[MAP_DEACTIVATE_TRACE_MODE_ind] + Merge1 --> CheckInd[Check Indication] + CheckInd -- OK --> SubKnown{Subscriber known?} + CheckInd -- Error --> Merge2(( )) + SubKnown -- No --> Err1[Set User Error: Unidentified subscriber] + SubKnown -- Yes --> TracingSup{Tracing supported?} + TracingSup -- No --> Err2[Set User Error: Facility not supported] + TracingSup -- Yes --> ActFalse[Subscriber tracing active:= False] + Err1 --> Merge2 + Err2 --> Merge2 + ActFalse --> Merge2 + Merge2 --- MAP_DEACTIVATE_TRACE_MODE_rsp[MAP_DEACTIVATE_TRACE_MODE_rsp] + Merge2 --- MAP_CLOSE_req[MAP_CLOSE_req] + Merge2 --> Exit(( )) + +``` + +Flowchart for process DTM\_Stand\_Alone\_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop via a merge symbol (circle with a line) associated with 'MAP\_DEACTIVATE\_TRACE\_MODE\_ind'. A 'Check Indication' block follows. An 'OK' path leads to a 'Subscriber known?' decision. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to a 'Tracing supported?' decision. If 'No', it goes to 'Set User Error: Facility not supported'. If 'Yes', it goes to 'Subscriber tracing active:= False'. All three error/processing blocks lead to a merge symbol (circle with a line) associated with 'MAP\_DEACTIVATE\_TRACE\_MODE\_rsp' and 'MAP\_CLOSE\_req'. An 'Error' path from the 'Check Indication' block also leads to this merge symbol. The process ends with an exit symbol (crossed lines). + +2020 + +2021 + +Figure 20.2/15: Process DTM\_Standalone\_SGSN + +2022 **20.3 Subscriber data management procedures for HLR** + +2023 Two types of subscriber data management procedures exist: + +- 2024 1) Subscriber Deletion; +- 2025 2) Subscriber Data Modification. + +2026 The subscriber deletion and subscriber data modification procedures are initiated by the OMC (see figures 20.3/1 , +2027 20.3/2, 20.3/3 and 20.3/4). + +![Sequence diagram for non-GPRS subscriber deletion. Lifelines: VLR, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to VLR. Step 3: VLR to HLR. Step 4: HLR to OMC.](9e31c4113f34a97fa2ff01325f5c88bc_img.jpg) + +``` +sequenceDiagram + participant OMC + participant HLR + participant VLR + Note right of OMC: 1 + OMC->>HLR: + Note right of HLR: 2 + HLR->>VLR: + Note right of VLR: 3 + VLR->>HLR: + Note right of HLR: 4 + HLR->>OMC: +``` + +Sequence diagram for non-GPRS subscriber deletion. Lifelines: VLR, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to VLR. Step 3: VLR to HLR. Step 4: HLR to OMC. + +2028 + +- 2029 +- 2030 1) Delete Subscriber +- 2031 2) MAP\_CANCEL\_LOCATION\_req/ind +- 2032 3) MAP\_CANCEL\_LOCATION\_rsp/cnf +- 2033 4) Subscriber Deleted +- 2034 +- 2035 + +**Figure 20.3/1: Subscriber deletion procedure for non-GPRS** + +2036 In the subscriber deletion procedure for a non-GPRS subscriber the subscriber data are removed from the VLR and the +2037 HLR. The HLR uses the MAP\_CANCEL\_LOCATION service. + +![Sequence diagram for GPRS subscriber deletion. Lifelines: SGSN, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to SGSN. Step 3: SGSN to HLR. Step 4: HLR to OMC.](d0671ff4e6ea09355aabd187a2d3ff7b_img.jpg) + +``` +sequenceDiagram + participant OMC + participant HLR + participant SGSN + Note right of OMC: 1 + OMC->>HLR: + Note right of HLR: 2 + HLR->>SGSN: + Note right of SGSN: 3 + SGSN->>HLR: + Note right of HLR: 4 + HLR->>OMC: +``` + +Sequence diagram for GPRS subscriber deletion. Lifelines: SGSN, HLR, OMC. Step 1: OMC to HLR. Step 2: HLR to SGSN. Step 3: SGSN to HLR. Step 4: HLR to OMC. + +2038 + +- 2039 +- 2040 1) Delete GPRS Subscriber +- 2041 2) MAP\_CANCEL\_LOCATION\_req/ind +- 2042 3) MAP\_CANCEL\_LOCATION\_rsp/cnf +- 2043 4) GPRS Subscriber Deleted +- 2044 +- 2045 + +**Figure 20.3/2: Subscriber deletion procedure for GPRS** + +2046 In the subscriber deletion procedure for a GPRS subscriber the subscriber data are removed from the SGSN and the +2047 HLR. The HLR uses the MAP\_CANCEL\_LOCATION service. + +![Sequence diagram for Figure 20.3/3: Subscriber data modification procedure for non-GPRS. Lifelines: VLR, HLR, OMC. 1) OMC to HLR (1), 2) HLR to VLR (2), 3) VLR to HLR (3), 4) HLR to OMC (4).](10b5f8259a1411e6de336da5a0e96bd7_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant HLR + participant VLR + Note right of OMC: 1 + OMC->>HLR: + Note right of HLR: 2 + HLR->>VLR: + Note right of VLR: 3 + VLR->>HLR: + Note right of HLR: 4 + HLR->>OMC: + +``` + +Sequence diagram for Figure 20.3/3: Subscriber data modification procedure for non-GPRS. Lifelines: VLR, HLR, OMC. 1) OMC to HLR (1), 2) HLR to VLR (2), 3) VLR to HLR (3), 4) HLR to OMC (4). + +2048 +2049 +2050 +2051 +2052 +2053 +2054 +2055 +2056 +2057 + +- 1) Modify Subscriber Data +- 2) MAP\_CANCEL\_LOCATION\_req/ind, MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind or +MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 3) MAP\_CANCEL\_LOCATION\_rsp/cnf, MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf or +MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 4) Subscriber Data Modified + +**Figure 20.3/3: Subscriber data modification procedure for non-GPRS** + +![Sequence diagram for Figure 20.3/4: Subscriber data modification procedure for GPRS. Lifelines: SGSN, HLR, OMC. 1) OMC to HLR (1), 2) HLR to SGSN (2), 3) SGSN to HLR (3), 4) HLR to OMC (4).](7ed01b362db267d4426e1b664fb44143_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant HLR + participant SGSN + Note right of OMC: 1 + OMC->>HLR: + Note right of HLR: 2 + HLR->>SGSN: + Note right of SGSN: 3 + SGSN->>HLR: + Note right of HLR: 4 + HLR->>OMC: + +``` + +Sequence diagram for Figure 20.3/4: Subscriber data modification procedure for GPRS. Lifelines: SGSN, HLR, OMC. 1) OMC to HLR (1), 2) HLR to SGSN (2), 3) SGSN to HLR (3), 4) HLR to OMC (4). + +2058 +2059 +2060 +2061 +2062 +2063 +2064 +2065 +2066 + +- 1) Modify GPRS Subscriber Data +- 2) MAP\_CANCEL\_LOCATION\_req/ind, MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind or +MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 3) MAP\_CANCEL\_LOCATION\_rsp/cnf, MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf or +MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 4) GPRS Subscriber Data Modified + +**Figure 20.3/4: Subscriber data modification procedure for GPRS** + +2067 In the subscriber data modification procedure the subscriber data are modified in the HLR and when necessary also in +2068 the VLR or in the SGSN. The HLR initiates one of the MAP\_INSERT\_SUBSCRIBER\_DATA, +2069 MAP\_DELETE\_SUBSCRIBER\_DATA or MAP\_CANCEL\_LOCATION services depending on the modified data. + +2070 **20.3.1 Subscriber deletion procedure** + +2071 **20.3.1.1 Procedure in the HLR** + +2072 The subscriber deletion process in the HLR is shown in figure 20.3/5. The MAP process invokes processes not defined +2073 in this clause; the definitions of these processes can be found as follows: + +- 2074 Cancel\_GPRS\_Location\_Child\_HLR see clause 19.1.2.2; +- 2075 Cancel\_Location\_Child\_HLR see clause 19.1.2.2. + +2076 **20.3.1.2 Procedure in the VLR** + +2077 The subscriber deletion procedure in the VLR is described in clause 19.1.2.3 of the present document. + +### 2078 20.3.1.3 Procedure in the SGSN + +2079 The subscriber deletion procedure in the SGSN is described in clause 19.1. 2.4 of the present document. + +## 2080 20.3.2 Subscriber data modification procedure + +### 2081 20.3.2.1 Procedure in the HLR + +2082 The OMC can modify the subscriber data in several different ways. The modifications can be categorised in the +2083 following groups: + +- 2084 1) data shall be modified in the HLR; no effect in the VLR; +- 2085 2) data shall be modified in both the HLR and the VLR; +- 2086 3) withdrawal of a basic service or a supplementary service requiring change to VLR data; +- 2087 4) modification affects the roaming permission for the subscriber and the subscriber record shall be removed from +2088 the VLR data base; +- 2089 5) withdrawal of non-GPRS Subscription caused by a change of Network Access Mode; +- 2090 6) data shall be modified in the HLR; no effect in the SGSN; +- 2091 7) data shall be modified in both the HLR and the SGSN; +- 2092 8) withdrawal of GPRS subscription data or a basic service or a supplementary service requiring change to SGSN +2093 data; +- 2094 9) modification affects the roaming permission for the subscriber and the subscriber record shall be removed from +2095 the SGSN data base; +- 2096 10) withdrawal of GPRS Subscription caused by a change of Network Access Mode; +- 2097 11) authentication algorithm or authentication key of the subscriber is modified. + +2098 In cases 2 and 7 the HLR uses the MAP\_INSERT\_SUBSCRIBER\_DATA service. + +2099 In cases 3 and 8 the HLR uses the MAP\_DELETE\_SUBSCRIBER\_DATA service. + +2100 In cases 4, 5, 9, 10 and 11 the HLR uses the MAP\_CANCEL\_LOCATION service. + +2101 If the deletion of subscriber data fails, the HLR may repeat the request; the number of repeat attempts and the time in +2102 between are HLR operator options, depending on the error returned by the VLR or the SGSN. + +2103 The subscriber data modification process in the HLR is shown in figure 20.3/6. The MAP process invokes processes not +2104 defined in this clause; the definitions of these processes can be found as follows: + +2105 Insert\_Subs\_Data\_Stand\_Alone\_HLR see clause 25.7.3; + +2106 Cancel\_Location\_Child\_HLR see clause 19.1.2.2; + +2107 Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR see clause 25.7.4; + +2108 Cancel\_GPRS\_Location\_Child\_HLR see clause 19.1.2.2. + +2109 The macro Delete\_Subscriber\_Data\_HLR is shown in figure 20.3/7. The macro invokes macros not defined in this +2110 clause; the definitions of these macros can be found as follows: + +2111 Receive\_Open\_Cnf see clause 25.1.2; + +2112 Check\_Confirmation see clause 25.2.2. + +2113 The macro Delete\_GPRS\_Subscriber\_Data\_HLR is shown in figure 20.3/8. The macro invokes macros not defined in +2114 this clause; the definitions of these macros can be found as follows: + +2115    Receive\_Open\_Cnf           see clause 25.1.2; +2116    Check\_Confirmation       see clause 25.2.2. + +### 2117 20.3.2.2       Procedures in the VLR + +2118 The process in the VLR to update subscriber data in a stand-alone dialogue is shown in figure 20.3/9. The MAP process +2119 invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2120    Check\_Indication           see clause 25.2.1; +2121    Insert\_Subs\_Data\_VLR   see clause 25.7.1. + +2122 The process in the VLR to delete subscriber data is shown in figure 20.3/10. The MAP process invokes a macro not +2123 defined in this clause; the definition of this macro can be found as follows: + +2124    Check\_Indication           see clause 25.2.1. + +### 2125 20.3.2.3       Procedures in the SGSN + +2126 The process in the SGSN to update subscriber data in a stand-alone dialogue is shown in figure 20.3/11. The MAP +2127 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2128    Check\_Indication           see clause 25.2.1; +2129    Insert\_Subs\_Data\_SGSN   see clause 25.7.2. + +2130 The process in the SGSN to delete subscriber data is shown in figure 20.3/12. The MAP process invokes a macro not +2131 defined in this clause; the definition of this macro can be found as follows: + +2132    Check\_Indication           see clause 25.2.1. + +![Flowchart for process Delete_Subscriber_HLR. The process starts with 'Null', followed by 'OM_Delete_Subscriber_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it checks 'Subscriber registered in an SGSN?'. If 'No', it goes to 'Cancel_GPRS_Location_Child_HLR'. If 'Yes', it goes to 'Subscriber registered in a VLR?'. If 'No', it goes to 'Cancel_Location_Child_HLR'. If 'Yes', it goes to 'Delete subscriber data from HLR'. Both 'Cancel' steps lead to 'Delete subscriber data from HLR'. From 'Delete subscriber data from HLR', it goes to 'OM_Delete_Subscriber_rsp' and finally 'Null'.](b6a1b0707decc2aedee3b44d70a2c5ae_img.jpg) + +process Delete\_Subscriber\_HLR + +Del\_Sub\_HLR1(1) + +Process in the HLR to delete a subscriber record from the SGSN and the VLR + +Signals to/from the right are to/from the OMC + +``` + +graph TD + Start([Null]) --> OM_Delete_Subscriber_ind{{OM_Delete_Subscriber_ind}} + OM_Delete_Subscriber_ind --> Subscriber_known{Subscriber known?} + Subscriber_known -- No --> Set_User_Error[Set User Error: Unknown subscriber] + Subscriber_known -- Yes --> Subscriber_registered_SGSN{Subscriber registered in an SGSN?} + Subscriber_registered_SGSN -- No --> Cancel_GPRS[Cancel_GPRS_Location_Child_HLR] + Subscriber_registered_SGSN -- Yes --> Subscriber_registered_VLR{Subscriber registered in a VLR?} + Cancel_GPRS --> Delete_data[Delete subscriber data from HLR] + Subscriber_registered_VLR -- No --> Cancel_Location[Cancel_Location_Child_HLR] + Subscriber_registered_VLR -- Yes --> Delete_data + Cancel_Location --> Delete_data + Delete_data --> OM_Delete_Subscriber_rsp{{OM_Delete_Subscriber_rsp}} + OM_Delete_Subscriber_rsp --> End([Null]) + Set_User_Error --> End + +``` + +Flowchart for process Delete\_Subscriber\_HLR. The process starts with 'Null', followed by 'OM\_Delete\_Subscriber\_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it checks 'Subscriber registered in an SGSN?'. If 'No', it goes to 'Cancel\_GPRS\_Location\_Child\_HLR'. If 'Yes', it goes to 'Subscriber registered in a VLR?'. If 'No', it goes to 'Cancel\_Location\_Child\_HLR'. If 'Yes', it goes to 'Delete subscriber data from HLR'. Both 'Cancel' steps lead to 'Delete subscriber data from HLR'. From 'Delete subscriber data from HLR', it goes to 'OM\_Delete\_Subscriber\_rsp' and finally 'Null'. + +2133 + +2134 + +Figure 20.3/5: Process Delete\_Subscriber\_HLR + +![Flowchart for process Modify_Data_HLR. It starts with an entry point leading to 'Null', then 'OM_Modify_Subscriber_Data_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber' then 'OM_Modify_Subscriber_Data_rsp' to 'Null'. If 'Yes', it goes to 'OM_Modify_Subscriber_Data_rsp', then 'Modify subscriber data in HLR database'. A decision 'Subscriber registered in a VLR?' follows. If 'No', it goes to connector '2'. If 'Yes', it goes to a 'Type of modification' decision. The 'Type of modification' has four branches: 'No effect in VLR' (to connector 2), 'Data to be modified in VLR' (to 'Insert_Subs_Data_Stand_Alone_HLR' then connector 2), 'Data to be deleted from VLR' (to 'Delete_Subscriber_Data_HLR' which has 'OK' to connector 2 and 'Error' to connector 1), and 'Subscriber record to be deleted from VLR' (to 'Cancel_Location_Child_HLR' then connector 2). A separate flow starts with connector '1', decision 'Repeat operation?'. If 'No', it goes to connector '2'. If 'Yes', it goes to 'Start repeat timer', 'Wait_For_Timer_Expiry', 'Repeat timer expired' (with an 'Internal' note), and then to the 'Type of modification' decision.](649db563f545d0dccc6d518baf536453_img.jpg) + +**process Modify\_Data\_HLR** **Mod\_Dat\_HLR1(2)** + +Process in the HLR to modify subscriber data in the SGSN and/or VLR + +Signals to/from the right are to/from the OMC + +``` + + graph TD + Entry([ ]) --> Null1([Null]) + Null1 --> OM_Modify_Subscriber_Data_ind{{OM_Modify_Subscriber_Data_ind}} + + OM_Modify_Subscriber_Data_ind --> Subscriber_known{Subscriber known?} + + Subscriber_known -- No --> Set_User_Error[Set User Error: Unknown subscriber] + Set_User_Error --> OM_Modify_Subscriber_Data_rsp1{{OM_Modify_Subscriber_Data_rsp}} + OM_Modify_Subscriber_Data_rsp1 --> Null2([Null]) + + Subscriber_known -- Yes --> OM_Modify_Subscriber_Data_rsp2{{OM_Modify_Subscriber_Data_rsp}} + OM_Modify_Subscriber_Data_rsp2 --> Modify_Subs_Data[Modify subscriber data in HLR database] + + Modify_Subs_Data --> Subscriber_registered{Subscriber registered in a VLR?} + + Subscriber_registered -- No --> Connector2_1((2)) + + Subscriber_registered -- Yes --> Type_of_Modification{Type of modification} + + Type_of_Modification -- "No effect in VLR" --> Connector2_2((2)) + + Type_of_Modification -- "Data to be modified in VLR" --> Insert_Subs_Data[Insert_Subs_Data_Stand_Alone_HLR] + Insert_Subs_Data --> Connector2_3((2)) + + Type_of_Modification -- "Data to be deleted from VLR" --> Delete_Subs_Data[Delete_Subscriber_Data_HLR] + + Delete_Subs_Data -- OK --> Connector2_4((2)) + + Delete_Subs_Data -- Error --> Connector1_1((1)) + + Type_of_Modification -- "Subscriber record to be deleted from VLR" --> Cancel_Location[Cancel_Location_Child_HLR] + Cancel_Location --> Connector2_5((2)) + + Connector1_2((1)) --> Repeat_Operation{Repeat operation?} + + Repeat_Operation -- No --> Connector2_6((2)) + + Repeat_Operation -- Yes --> Start_Repeat_Timer[Start repeat timer] + + Start_Repeat_Timer --> Wait_For_Timer_Expiry[Wait_For_Timer_Expiry] + + Wait_For_Timer_Expiry --> Repeat_Timer_Expired[Repeat timer expired] + + Note1[Internal] -.-> Repeat_Timer_Expired + + Repeat_Timer_Expired --> Type_of_Modification + +``` + +Flowchart for process Modify\_Data\_HLR. It starts with an entry point leading to 'Null', then 'OM\_Modify\_Subscriber\_Data\_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber' then 'OM\_Modify\_Subscriber\_Data\_rsp' to 'Null'. If 'Yes', it goes to 'OM\_Modify\_Subscriber\_Data\_rsp', then 'Modify subscriber data in HLR database'. A decision 'Subscriber registered in a VLR?' follows. If 'No', it goes to connector '2'. If 'Yes', it goes to a 'Type of modification' decision. The 'Type of modification' has four branches: 'No effect in VLR' (to connector 2), 'Data to be modified in VLR' (to 'Insert\_Subs\_Data\_Stand\_Alone\_HLR' then connector 2), 'Data to be deleted from VLR' (to 'Delete\_Subscriber\_Data\_HLR' which has 'OK' to connector 2 and 'Error' to connector 1), and 'Subscriber record to be deleted from VLR' (to 'Cancel\_Location\_Child\_HLR' then connector 2). A separate flow starts with connector '1', decision 'Repeat operation?'. If 'No', it goes to connector '2'. If 'Yes', it goes to 'Start repeat timer', 'Wait\_For\_Timer\_Expiry', 'Repeat timer expired' (with an 'Internal' note), and then to the 'Type of modification' decision. + +2135 + +2136 + +**Figure 20.3/6 (sheet 1 of 2): Process Modify\_Data\_HLR** + +![Flowchart for process Modify_Data_HLR. It starts at connector 3, checks if an operation should be repeated. If yes, it starts a timer and waits for expiry. If no, it goes to Null. After timer expiry, it checks if the subscriber is registered in an SGSN. If no, it goes to Null. If yes, it checks the type of modification: no effect, modify, delete, or cancel. Modify, delete, and cancel lead to specific HLR actions followed by Null, OK/Error, and Null respectively. All paths eventually lead back to connector 3.](1300bcbec98350ff4935821e311faad8_img.jpg) + +process Modify\_Data\_HLR Mod\_Dat\_HLR2(2) + +Process in the HLR to modify subscriber data in the SGSN and/or VLR + +``` + + graph TD + 3((3)) --> Repeat{Repeat operation?} + Repeat -- No --> Null1([Null]) + Repeat -- Yes --> StartTimer[Start repeat timer] + StartTimer --> WaitTimer([Wait For Timer Expiry]) + WaitTimer --> TimerExpired{Repeat timer expired} + TimerExpired --> RegInSGSN{Subscriber registered in an SGSN?} + RegInSGSN -- No --> Null2([Null]) + RegInSGSN -- Yes --> TypeMod{Type of modification} + TypeMod -- "No effect in SGSN" --> Null3([Null]) + TypeMod -- "Data to be modified in SGSN" --> Insert[Insert_GPRS_Subs_Data_Stand_Alone_HLR] + Insert --> Null4([Null]) + TypeMod -- "Data to be deleted from SGSN" --> Delete[Delete_Subscriber_Data_HLR] + Delete -- OK --> Null5([Null]) + Delete -- Error --> 3 + TypeMod -- "Subscriber record to be deleted from SGSN" --> Cancel[Cancel_GPRS_Location_Child_HLR] + Cancel --> Null6([Null]) + +``` + +Flowchart for process Modify\_Data\_HLR. It starts at connector 3, checks if an operation should be repeated. If yes, it starts a timer and waits for expiry. If no, it goes to Null. After timer expiry, it checks if the subscriber is registered in an SGSN. If no, it goes to Null. If yes, it checks the type of modification: no effect, modify, delete, or cancel. Modify, delete, and cancel lead to specific HLR actions followed by Null, OK/Error, and Null respectively. All paths eventually lead back to connector 3. + +2137 + +2138 + +**Figure 20.3/6 (sheet 2 of 2): Process Modify\_Data\_HLR** + +![Flowchart for Delete_Subscriber_Data_HLR macro. The process starts with an entry point, followed by a selection of signals (MAP_OPEN_req, MAP_DELETE_SUBSCRIBER_DATA_req, MAP_DELIMITER_req). It then receives an Open_Cnf response. From there, it branches based on 'Vr', 'OK', and 'Error' paths. The 'Vr' path leads to 'Perform MAP Vr dialogue', which then checks for a 'Successful result?'. The 'OK' path leads to 'Wait_For_VLR_Response', which then branches into 'MAP_DELETE_SUBSCRIBER_DATA_cnf', 'MAP_NOTICE_ind', and an unnamed signal. The 'MAP_DELETE_SUBSCRIBER_DATA_cnf' path leads to 'Check_Confirmation', which then checks for 'Network Node Area Restricted received OR Roaming Restriction Due To Unsupported Feature'. The 'MAP_NOTICE_ind' path leads to 'MAP_CLOSE_req', which then leads to an 'Error' state. The unnamed signal path leads to a signal block containing 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', which then leads to an 'Error' state.](bb6596f55ac1aa20c63d2a0c8fe00d27_img.jpg) + +macrodefinition Delete\_Subscriber\_Data\_HLR + +DSD\_HLR1(1) + +Macro in the HLR to delete specific subscriber data from a VLR + +Signals to/from the left are to/from the VLR + +``` + + graph TD + Start([ ]) --> Signals["MAP_OPEN_req +MAP_DELETE_SUBSCRIBER_DATA_req +MAP_DELIMITER_req"] + Signals --> OpenCnf[Receive_Open_Cnf] + OpenCnf -- Vr --> PerformVr[Perform MAP Vr dialogue] + OpenCnf -- OK --> WaitForVLR[Wait_For_VLR_Response] + OpenCnf -- Error --> Error1((Error)) + + PerformVr --> SuccessfulResult{Successful result?} + SuccessfulResult -- No --> Error2((Error)) + SuccessfulResult -- Yes --> OK1((OK)) + + WaitForVLR --> DeleteCnf{MAP_DELETE_SUBSCRIBER_DATA_cnf} + WaitForVLR --> NoticeInd{MAP_NOTICE_ind} + WaitForVLR --> UnnamedSignal{ } + + DeleteCnf --> CheckConfirmation[Check_Confirmation] + CheckConfirmation -- "User Error, Provider Error, Data Error" --> Error3((Error)) + CheckConfirmation -- OK --> Restricted{Network Node Area Restricted received OR Roaming Restriction Due To Unsupported Feature} + + Restricted -- No --> MSCFalse[MSC Area Restricted:= False] + Restricted -- Yes --> MSCTrue[MSC Area Restricted:= True] + + MSCFalse --> OK2((OK)) + MSCTrue --> OK2 + + NoticeInd --> CloseReq{MAP_CLOSE_req} + + UnnamedSignal --> AbortInd["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + + CloseReq --> Error4((Error)) + +``` + +Flowchart for Delete\_Subscriber\_Data\_HLR macro. The process starts with an entry point, followed by a selection of signals (MAP\_OPEN\_req, MAP\_DELETE\_SUBSCRIBER\_DATA\_req, MAP\_DELIMITER\_req). It then receives an Open\_Cnf response. From there, it branches based on 'Vr', 'OK', and 'Error' paths. The 'Vr' path leads to 'Perform MAP Vr dialogue', which then checks for a 'Successful result?'. The 'OK' path leads to 'Wait\_For\_VLR\_Response', which then branches into 'MAP\_DELETE\_SUBSCRIBER\_DATA\_cnf', 'MAP\_NOTICE\_ind', and an unnamed signal. The 'MAP\_DELETE\_SUBSCRIBER\_DATA\_cnf' path leads to 'Check\_Confirmation', which then checks for 'Network Node Area Restricted received OR Roaming Restriction Due To Unsupported Feature'. The 'MAP\_NOTICE\_ind' path leads to 'MAP\_CLOSE\_req', which then leads to an 'Error' state. The unnamed signal path leads to a signal block containing 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', which then leads to an 'Error' state. + +2139 + +2140 + +Figure 20.3/7: Macro Delete\_Subscriber\_Data\_HLR + +![Flowchart for Delete_GPRS_Subscriber_Data_HLR macro. The process starts with an entry point, followed by a block of outgoing signals (MAP_OPEN_req, MAP_DELETE_SUBSCRIBER_DATA_req, MAP_DELIMITER_req). It then receives an Open_Cnf response. If OK, it enters a 'Wait_For_SGSN_Response' state. If Vr, Error, it goes to an Error state. From the wait state, three paths emerge: 1) MAP_DELETE_SUBSCRIBER_DATA_cnf leads to Check_Confirmation. If OK, it reaches a decision diamond. If User Error, Provider Error, or Data Error, it goes to an Error state. 2) MAP_NOTICE_ind leads to MAP_CLOSE_req, which then leads to an Error state. 3) An unlabeled path leads to a block of outgoing signals (MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind), which then leads to an Error state. The decision diamond checks for 'Network Node Area Restricted received OR Roaming Restricted in SGSN Due To Unsupported Feature'. If No, it checks 'SGSN Area Restricted:= False'. If Yes, it checks 'SGSN Area Restricted:= True'. Both lead to an OK state.](997b07a913097ec381a81470ca4ab97e_img.jpg) + +macrodefinition Delete\_GPRS\_Subscriber\_Data\_HLR + +DGCSD\_HLR(1) + +Macro in the HLR to delete specific subscriber data from an SGSN + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + Start([ ]) --> Out1[MAP_OPEN_req +MAP_DELETE_SUBSCRIBER_DATA_req +MAP_DELIMITER_req] + Out1 --> Rec1[Receive Open_Cnf] + Rec1 -- OK --> Wait[Wait_For_SGSN_Response] + Rec1 -- "Vr, Error" --> Error1((Error)) + Wait --> Out2[MAP_DELETE_SUBSCRIBER_DATA_cnf] + Wait --> Out3[MAP_NOTICE_ind] + Wait --> Out4[ ] + Out2 --> Check[Check_Confirmation] + Check -- "User Error, Provider Error, Data Error" --> Error2((Error)) + Check -- OK --> Decision{ } + Out3 --> Rec2[MAP_CLOSE_req] + Rec2 --> Error3((Error)) + Out4 --> Out5[MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind] + Out5 --> Error4((Error)) + Decision -- "Network Node Area Restricted received OR +Roaming Restricted in SGSN Due To Unsupported Feature" --> Yes[Yes] + Decision -- No --> No1[SGSN Area Restricted:= False] + Yes --> Yes1[SGSN Area Restricted:= True] + No1 --> OK1((OK)) + Yes1 --> OK1 + +``` + +Flowchart for Delete\_GPRS\_Subscriber\_Data\_HLR macro. The process starts with an entry point, followed by a block of outgoing signals (MAP\_OPEN\_req, MAP\_DELETE\_SUBSCRIBER\_DATA\_req, MAP\_DELIMITER\_req). It then receives an Open\_Cnf response. If OK, it enters a 'Wait\_For\_SGSN\_Response' state. If Vr, Error, it goes to an Error state. From the wait state, three paths emerge: 1) MAP\_DELETE\_SUBSCRIBER\_DATA\_cnf leads to Check\_Confirmation. If OK, it reaches a decision diamond. If User Error, Provider Error, or Data Error, it goes to an Error state. 2) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which then leads to an Error state. 3) An unlabeled path leads to a block of outgoing signals (MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind), which then leads to an Error state. The decision diamond checks for 'Network Node Area Restricted received OR Roaming Restricted in SGSN Due To Unsupported Feature'. If No, it checks 'SGSN Area Restricted:= False'. If Yes, it checks 'SGSN Area Restricted:= True'. Both lead to an OK state. + +2141 + +2142 + +Figure 20.3/8: Macro Delete\_GPRS\_Subscriber\_Data\_HLR + +![Flowchart for process Ins_Subs_Data_Stand_Alone_VLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop: MAP_INSERT_SUBSCRIBER_DATA_ind -> Check_Indication. From Check_Indication, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it goes to another decision 'All received services & features supported?'. If 'No', it goes to 'Update subscriber data for supported services & features' then 'Set parameters for unsupported services & features'. If 'Yes', it goes to 'Update subscriber data'. Both 'Update subscriber data' and 'Set parameters for unsupported services & features' lead to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it proceeds. All three paths ('Set User Error...', 'Set network node...', and the 'No' path) converge at a junction. From the junction, the flow goes to a block labeled 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req', which then leads to 'Wait_For_Service_Indication'. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by HLR:=False', which also converges at the junction.](89b65fcd380f864418aabeaa26627411_img.jpg) + +process Ins\_Subs\_Data\_Stand\_Alone\_VLR + +ISD\_SA\_VLR1(2) + +Process in the VLR to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> MAP_ind{MAP_INSERT_SUBSCRIBER_DATA_ind} + MAP_ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + Check -- Error --> Confirmed[Subscriber data confirmed by HLR:=False] + IMSI -- No --> UserError[Set User Error: Unidentified Subscriber] + IMSI -- Yes --> Supported{All received services & features supported?} + Supported -- No --> UpdateSupported[Update subscriber data for supported services & features] + UpdateSupported --> SetParams[Set parameters for unsupported services & features] + Supported -- Yes --> UpdateData[Update subscriber data] + UpdateData --> Restricted{MSC area restricted due to regional subscription?} + SetParams --> Restricted + Restricted -- Yes --> NetworkNode[Set network node area restricted] + Restricted -- No --> Junction(( )) + UserError --> Junction + NetworkNode --> Junction + Confirmed --> Junction + Junction --> MAP_rsp{MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req} + MAP_rsp --> Wait[Wait_For_Service_Indication] + +``` + +Flowchart for process Ins\_Subs\_Data\_Stand\_Alone\_VLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop: MAP\_INSERT\_SUBSCRIBER\_DATA\_ind -> Check\_Indication. From Check\_Indication, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it goes to another decision 'All received services & features supported?'. If 'No', it goes to 'Update subscriber data for supported services & features' then 'Set parameters for unsupported services & features'. If 'Yes', it goes to 'Update subscriber data'. Both 'Update subscriber data' and 'Set parameters for unsupported services & features' lead to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it proceeds. All three paths ('Set User Error...', 'Set network node...', and the 'No' path) converge at a junction. From the junction, the flow goes to a block labeled 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req', which then leads to 'Wait\_For\_Service\_Indication'. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by HLR:=False', which also converges at the junction. + +2143 + +2144 + +Figure 20.3/9 (sheet 1 of 2): Process Ins\_Subs\_Data\_Stand\_Alone\_VLR + +![State transition diagram for process Ins_Subs_Data_Stand_Alone_VLR. The diagram shows a state machine with four main states: Wait_For_Service_Indication, Insert_Subs_Data_VLR, MAP_CLOSE_ind, and MAP_NOTICE_ind. Transitions are triggered by signals from the HLR (MAP_CLOSE_ind, MAP_NOTICE_ind, MAP_U_ABORT_ind, MAP_P_ABORT_ind) or result in signals to the HLR (Insert_Subs_Data_VLR, MAP_CLOSE_req). The process ends in two terminal states: Subscriber data confirmed by HLR:=True and Subscriber data confirmed by HLR:=False.](a4de814f6aad47c148e3f0e6edb48c55_img.jpg) + +process Ins\_Subs\_Data\_Stand\_Alone\_VLR + +ISD\_SA\_VLR2(2) + +Process in the VLR to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Indication + state "Insert Subscriber Data requests" as Insert_Subs_Data_VLR + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "Subscriber data confirmed by HLR:=True" as True + state "Subscriber data confirmed by HLR:=False" as False + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind" as Abort + + Wait_For_Service_Indication --> Insert_Subs_Data_VLR + Insert_Subs_Data_VLR --> Wait_For_Service_Indication + Wait_For_Service_Indication --> MAP_CLOSE_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> Abort + MAP_CLOSE_ind --> Store_data[Store subscriber data in VLR] + Store_data --> True + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> False + MAP_NOTICE_ind --> Abort + MAP_NOTICE_ind --> MAP_CLOSE_ind + Abort --> MAP_NOTICE_ind + +``` + +State transition diagram for process Ins\_Subs\_Data\_Stand\_Alone\_VLR. The diagram shows a state machine with four main states: Wait\_For\_Service\_Indication, Insert\_Subs\_Data\_VLR, MAP\_CLOSE\_ind, and MAP\_NOTICE\_ind. Transitions are triggered by signals from the HLR (MAP\_CLOSE\_ind, MAP\_NOTICE\_ind, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind) or result in signals to the HLR (Insert\_Subs\_Data\_VLR, MAP\_CLOSE\_req). The process ends in two terminal states: Subscriber data confirmed by HLR:=True and Subscriber data confirmed by HLR:=False. + +2145 + +2146 + +Figure 20.3/9 (sheet 2 of 2): Process Ins\_Subs\_Data\_Stand\_Alone\_VLR + +![Flowchart for process Delete_Subs_Data_VLR. It starts with an oval, followed by a 'Null' block, then a 'MAP_DELETE_SUBSCRIBER_DATA_ind' message. A 'Check_Indication' block follows, leading to an 'IMSI known?' decision. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Delete subscriber data from VLR', then 'Deletion successful?'. If 'No', it goes to 'Subscriber data confirmed by HLR:=False' then 'MAP_U_ABORT_req'. If 'Yes', it goes to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted' then to a merge point. If 'No', it goes directly to the merge point. From the merge point, it goes to 'Subscriber data confirmed by HLR:=True', then a 'MAP_DELETE_SUBSCRIBER_DATA_rsp / MAP_CLOSE_req' message block, ending with an 'X' symbol. The 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by HLR:=False' then to the same merge point.](157b9aaba9418b037266b482404acae7_img.jpg) + +**process Delete\_Subs\_Data\_VLR** **DSD\_VLR1(1)** + +Process in the VLR to handle Delete Subscriber Data requests + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> MAP_DELETE_SUBSCRIBER_DATA_ind[/MAP_DELETE_SUBSCRIBER_DATA_ind/] + MAP_DELETE_SUBSCRIBER_DATA_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> IMSI_known{IMSI known?} + Check_Indication -- Error --> SubDataConfirmedFalse1[Subscriber data confirmed by HLR:=False] + IMSI_known -- No --> SetUserError[Set User Error: Unknown subscriber] + IMSI_known -- Yes --> DeleteSubData[Delete subscriber data from VLR] + DeleteSubData --> DeletionSuccessful{Deletion successful?} + DeletionSuccessful -- No --> SubDataConfirmedFalse2[Subscriber data confirmed by HLR:=False] + DeletionSuccessful -- Yes --> MSCAreaRestricted{MSC area restricted due to regional subscription?} + MSCAreaRestricted -- Yes --> SetNetworkNodeRestricted[Set network node area restricted] + SetNetworkNodeRestricted --> Merge1(( )) + MSCAreaRestricted -- No --> Merge1 + SubDataConfirmedFalse1 --> Merge2(( )) + SubDataConfirmedFalse2 --> Merge2 + SetUserError --> Merge2 + Merge1 --> SubDataConfirmedTrue[Subscriber data confirmed by HLR:=True] + SubDataConfirmedTrue --> MAP_DELETE_SUBSCRIBER_DATA_rsp[MAP_DELETE_SUBSCRIBER_DATA_rsp / MAP_CLOSE_req] + MAP_DELETE_SUBSCRIBER_DATA_rsp --> End1((X)) + Merge2 --> SubDataConfirmedFalse3[Subscriber data confirmed by HLR:=False] + SubDataConfirmedFalse3 --> MAP_U_ABORT_req[/MAP_U_ABORT_req/] + MAP_U_ABORT_req --> End2((X)) + +``` + +Flowchart for process Delete\_Subs\_Data\_VLR. It starts with an oval, followed by a 'Null' block, then a 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' message. A 'Check\_Indication' block follows, leading to an 'IMSI known?' decision. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Delete subscriber data from VLR', then 'Deletion successful?'. If 'No', it goes to 'Subscriber data confirmed by HLR:=False' then 'MAP\_U\_ABORT\_req'. If 'Yes', it goes to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted' then to a merge point. If 'No', it goes directly to the merge point. From the merge point, it goes to 'Subscriber data confirmed by HLR:=True', then a 'MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp / MAP\_CLOSE\_req' message block, ending with an 'X' symbol. The 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by HLR:=False' then to the same merge point. + +2147 + +2148 + +**Figure 20.3/10: Process Delete\_Subs\_Data\_VLR** + +![Flowchart for process Ins_Subs_Data_Stand_Alone_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop: MAP_INSERT_SUBSCRIBER_DATA_ind -> Check_Indication. From Check_Indication, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it goes to another decision 'All received services & features supported?'. If 'No', it goes to 'Update subscriber data for supported services & features' -> 'Set parameters for unsupported services & features'. If 'Yes', it goes to 'Update subscriber data'. Both 'Update subscriber data' and 'Set parameters for unsupported services & features' lead to a decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it proceeds. All three paths ('Set User Error...', 'Set network node...', and 'No' from the second decision) converge at a junction. From this junction, an 'Error' path leads to 'Subscriber data confirmed by HLR:=False', which loops back to the 'Check_Indication' block. The main path continues to a block with 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req', which then leads to 'Wait_For_Service_Indication'.](6994939b855d6bde94efb2f31dee555e_img.jpg) + +process Ins\_Subs\_Data\_Stand\_Alone\_SGSN + +ISD\_SA\_SGSN1(2) + +Process in the SGSN to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> MAP_ind[/MAP_INSERT_SUBSCRIBER_DATA_ind/] + MAP_ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + IMSI -- No --> ErrorSub[Set User Error: Unidentified Subscriber] + IMSI -- Yes --> AllSupp{All received services & features supported?} + AllSupp -- No --> UpdateSupp[Update subscriber data for supported services & features] + AllSupp -- Yes --> UpdateData[Update subscriber data] + UpdateSupp --> AreaRestricted{SGSN area restricted due to regional subscription?} + UpdateData --> AreaRestricted + AreaRestricted -- Yes --> NetworkRestricted[Set network node area restricted] + AreaRestricted -- No --> Junction(( )) + ErrorSub --> Junction + NetworkRestricted --> Junction + Junction -- Error --> Confirmed[Subscriber data confirmed by HLR:=False] + Confirmed --> Check + Junction --> MAP_rsp[/MAP_INSERT_SUBSCRIBER_DATA_rsp
MAP_DELIMITER_req/] + MAP_rsp --> Wait[Wait_For_Service_Indication] + +``` + +Flowchart for process Ins\_Subs\_Data\_Stand\_Alone\_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop: MAP\_INSERT\_SUBSCRIBER\_DATA\_ind -> Check\_Indication. From Check\_Indication, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it goes to another decision 'All received services & features supported?'. If 'No', it goes to 'Update subscriber data for supported services & features' -> 'Set parameters for unsupported services & features'. If 'Yes', it goes to 'Update subscriber data'. Both 'Update subscriber data' and 'Set parameters for unsupported services & features' lead to a decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it proceeds. All three paths ('Set User Error...', 'Set network node...', and 'No' from the second decision) converge at a junction. From this junction, an 'Error' path leads to 'Subscriber data confirmed by HLR:=False', which loops back to the 'Check\_Indication' block. The main path continues to a block with 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req', which then leads to 'Wait\_For\_Service\_Indication'. + +2149 + +2150 + +Figure 20.3/11 (sheet 1 of 2): Process Ins\_Subs\_Data\_Stand\_Alone\_SGSN + +![State transition diagram for process Ins_Subs_Data_Stand_Alone_SGSN. The diagram shows a state machine with four main states: Wait_For_Service_Indication, Insert_Subs_Data_SGSN, MAP_CLOSE_ind, and MAP_NOTICE_ind. Transitions are triggered by various MAP messages and result in actions like storing subscriber data or sending responses. The diagram includes callouts explaining the process and the direction of signals.](483699c07b228d3166457b63f36922df_img.jpg) + +process Ins\_Subs\_Data\_Stand\_Alone\_SGSN ISD\_SA\_SGSN2(2) + +*Process in the SGSN to handle Insert Subscriber Data requests in a stand-alone dialogue* + +*Signals to/from the right are to/from the HLR* + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Indication + state "Insert_Subs_Data_SGSN" as Insert_Subs_Data_SGSN + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state " " as UnlabeledState + + Wait_For_Service_Indication --> Insert_Subs_Data_SGSN + Wait_For_Service_Indication --> MAP_CLOSE_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> UnlabeledState + + Insert_Subs_Data_SGSN --> Wait_For_Service_Indication + + MAP_CLOSE_ind --> Store_subscriber_data_in_SGSN + Store_subscriber_data_in_SGSN --> Subscriber_data_confirmed_by_HLR_True + Subscriber_data_confirmed_by_HLR_True --> [*] + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Subscriber_data_confirmed_by_HLR_False + Subscriber_data_confirmed_by_HLR_False --> [*] + + UnlabeledState --> MAP_U_ABORT_ind_MAP_P_ABORT_ind + MAP_U_ABORT_ind_MAP_P_ABORT_ind --> UnlabeledState + +``` + +States and Transitions: + +- Initial State:** Wait\_For\_Service\_Indication +- State: Insert\_Subs\_Data\_SGSN** + - Transition to: Wait\_For\_Service\_Indication +- State: MAP\_CLOSE\_ind** + - Transition to: Store subscriber data in SGSN + - From: Store subscriber data in SGSN + - From: Subscriber data confirmed by HLR:=True + - End: [\*] +- State: MAP\_NOTICE\_ind** + - Transition to: MAP\_CLOSE\_req + - From: MAP\_CLOSE\_req + - From: Subscriber data confirmed by HLR:=False + - End: [\*] +- Unlabeled State (Orange)** + - Transition to: MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind + - From: MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind + +Callouts: + +- Process in the SGSN to handle Insert Subscriber Data requests in a stand-alone dialogue +- Signals to/from the right are to/from the HLR + +State transition diagram for process Ins\_Subs\_Data\_Stand\_Alone\_SGSN. The diagram shows a state machine with four main states: Wait\_For\_Service\_Indication, Insert\_Subs\_Data\_SGSN, MAP\_CLOSE\_ind, and MAP\_NOTICE\_ind. Transitions are triggered by various MAP messages and result in actions like storing subscriber data or sending responses. The diagram includes callouts explaining the process and the direction of signals. + +2151 + +2152 + +Figure 20.3/11 (sheet 2 of 2): Process Ins\_Subs\_Data\_Stand\_Alone\_SGSN + +![Flowchart for process Delete_Subs_Data_SGSN. The process starts with an oval, followed by a 'Null' block. It then receives a 'MAP_DELETE_SUBSCRIBER_DATA_ind' signal. A 'Check_Indication' block follows. From there, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Delete subscriber data from SGSN'. From there, a decision 'Deletion successful?' follows. If 'No', it goes to 'Subscriber data confirmed by HLR:=False' and then 'MAP_U_ABORT_req'. If 'Yes', it goes to another decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it goes to 'Subscriber data confirmed by HLR:=True'. Both 'Set network node area restricted' and 'Subscriber data confirmed by HLR:=True' lead to a common block. From this block, it goes to 'Subscriber data confirmed by HLR:=True' and then to a block with 'MAP_DELETE_SUBSCRIBER_DATA_rsp' and 'MAP_CLOSE_req'. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by HLR:=False'.](e46f2cda7483721fe450058613289df5_img.jpg) + +process Delete\_Subs\_Data\_SGSN + +DSD\_SGSN1(1) + +Process in the SGSN to handle Delete Subscriber Data requests + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> MAP_DELETE_SUBSCRIBER_DATA_ind[/MAP_DELETE_SUBSCRIBER_DATA_ind/] + MAP_DELETE_SUBSCRIBER_DATA_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> IMSI_known{IMSI known?} + Check_Indication -- Error --> HLR_False1[Subscriber data confirmed by HLR:=False] + IMSI_known -- No --> Unknown[Set User Error: Unknown subscriber] + IMSI_known -- Yes --> Delete_SGSN[Delete subscriber data from SGSN] + Delete_SGSN --> Deletion_successful{Deletion successful?} + Deletion_successful -- No --> HLR_False2[Subscriber data confirmed by HLR:=False] + Deletion_successful -- Yes --> Area_Restricted{SGSN area restricted due to regional subscription?} + Area_Restricted -- Yes --> Set_Restricted[Set network node area restricted] + Area_Restricted -- No --> HLR_True1[Subscriber data confirmed by HLR:=True] + Set_Restricted --> HLR_True1 + HLR_False1 --> MAP_U_ABORT_req[/MAP_U_ABORT_req/] + HLR_False2 --> MAP_U_ABORT_req + Unknown --> Common(( )) + HLR_True1 --> Common + Common --> MAP_DELETE_SUBSCRIBER_DATA_rsp[MAP_DELETE_SUBSCRIBER_DATA_rsp] + Common --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_DELETE_SUBSCRIBER_DATA_rsp --> End1([X]) + MAP_CLOSE_req --> End2([X]) + +``` + +Flowchart for process Delete\_Subs\_Data\_SGSN. The process starts with an oval, followed by a 'Null' block. It then receives a 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' signal. A 'Check\_Indication' block follows. From there, an 'OK' path leads to a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it goes to 'Delete subscriber data from SGSN'. From there, a decision 'Deletion successful?' follows. If 'No', it goes to 'Subscriber data confirmed by HLR:=False' and then 'MAP\_U\_ABORT\_req'. If 'Yes', it goes to another decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it goes to 'Subscriber data confirmed by HLR:=True'. Both 'Set network node area restricted' and 'Subscriber data confirmed by HLR:=True' lead to a common block. From this block, it goes to 'Subscriber data confirmed by HLR:=True' and then to a block with 'MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_CLOSE\_req'. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by HLR:=False'. + +2153 + +2154 + +Figure 20.3/12: Process Delete\_Subs\_Data\_SGSN + +2155 **20.3A Subscriber Data Management procedures for CSS** + +2156 Two types of subscriber data management procedures exist: + +- 2157 1) Subscriber Deletion; +- 2158 2) Subscriber Data Modification. + +2159 The subscriber deletion and subscriber data modification procedures are initiated by the OMC (see figures 20.3A/1, +2160 20.3A/2, 20.3A/3 and 20.3A/4). + +![Sequence diagram for non-GPRS subscriber deletion. Lifelines: VLR, CSS, OMC. Step 1: OMC to CSS. Step 2: CSS to VLR. Step 3: VLR to CSS. Step 4: CSS to OMC.](478a57893fbff452d4943a78b725a07e_img.jpg) + +``` +sequenceDiagram + participant OMC + participant CSS + participant VLR + Note right of OMC: 1 + OMC->>CSS: + Note right of CSS: 2 + CSS->>VLR: + Note right of VLR: 3 + VLR->>CSS: + Note right of CSS: 4 + CSS->>OMC: +``` + +Sequence diagram for non-GPRS subscriber deletion. Lifelines: VLR, CSS, OMC. Step 1: OMC to CSS. Step 2: CSS to VLR. Step 3: VLR to CSS. Step 4: CSS to OMC. + +2161 +2162 +2163 +2164 +2165 +2166 +2167 +2168 + +- 1) Delete Subscriber +- 2) MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 3) MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 4) Subscriber Deleted + +**Figure 20.3A/1: Subscriber deletion procedure for non-GPRS** + +2169 In the subscriber deletion procedure for a non-GPRS subscriber the CSG subscription data for the subscriber in the +2170 VPLMN are removed from the VLR and the CSS. The CSS uses the MAP\_DELETE\_SUBSCRIBER\_DATA service. + +![Sequence diagram for GPRS subscriber deletion. Lifelines: SGSN, CSS, OMC. Step 1: OMC to CSS. Step 2: CSS to SGSN. Step 3: SGSN to CSS. Step 4: CSS to OMC.](6ead1e4ea94e914050b62a8502ec2e3d_img.jpg) + +``` +sequenceDiagram + participant OMC + participant CSS + participant SGSN + Note right of OMC: 1 + OMC->>CSS: + Note right of CSS: 2 + CSS->>SGSN: + Note right of SGSN: 3 + SGSN->>CSS: + Note right of CSS: 4 + CSS->>OMC: +``` + +Sequence diagram for GPRS subscriber deletion. Lifelines: SGSN, CSS, OMC. Step 1: OMC to CSS. Step 2: CSS to SGSN. Step 3: SGSN to CSS. Step 4: CSS to OMC. + +2171 +2172 +2173 +2174 +2175 +2176 +2177 +2178 + +- 1) Delete GPRS Subscriber +- 2) MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 3) MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 4) GPRS Subscriber Deleted + +**Figure 20.3A/2: Subscriber deletion procedure for GPRS** + +2179 In the subscriber deletion procedure for a GPRS subscriber the CSG subscription data for the GPRS subscriber in the +2180 VPLMN are removed from the SGSN and the CSS. The CSS uses the MAP\_DELETE\_SUBSCRIBER\_DATA service. + +![Sequence diagram for Figure 20.3A/3: Subscriber data modification procedure for non-GPRS. The diagram shows three entities: VLR, CSS, and OMC. The sequence of messages is: 1) OMC sends a request to CSS; 2) CSS sends a request to VLR; 3) VLR sends a response to CSS; 4) CSS sends a response to OMC.](672a318767e4141941272424110be3b2_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant CSS + participant VLR + Note right of OMC: 1) + OMC->>CSS: Request + Note right of CSS: 2) + CSS->>VLR: Request + Note right of VLR: 3) + VLR->>CSS: Response + Note right of CSS: 4) + CSS->>OMC: Response + +``` + +Sequence diagram for Figure 20.3A/3: Subscriber data modification procedure for non-GPRS. The diagram shows three entities: VLR, CSS, and OMC. The sequence of messages is: 1) OMC sends a request to CSS; 2) CSS sends a request to VLR; 3) VLR sends a response to CSS; 4) CSS sends a response to OMC. + +- 2181 +- 2182 +- 2183 1) Modify Subscriber Data +- 2184 2) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind or MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 2185 3) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf or MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 2186 4) Subscriber Data Modified +- 2187 +- 2188 **Figure 20.3A/3: Subscriber data modification procedure for non-GPRS** + +![Sequence diagram for Figure 20.3A/4: Subscriber data modification procedure for GPRS. The diagram shows three entities: SGSN, CSS, and OMC. The sequence of messages is: 1) OMC sends a request to CSS; 2) CSS sends a request to SGSN; 3) SGSN sends a response to CSS; 4) CSS sends a response to OMC.](d17f5c469a96ddc06765b0c99361e999_img.jpg) + +``` + +sequenceDiagram + participant OMC + participant CSS + participant SGSN + Note right of OMC: 1) + OMC->>CSS: Request + Note right of CSS: 2) + CSS->>SGSN: Request + Note right of SGSN: 3) + SGSN->>CSS: Response + Note right of CSS: 4) + CSS->>OMC: Response + +``` + +Sequence diagram for Figure 20.3A/4: Subscriber data modification procedure for GPRS. The diagram shows three entities: SGSN, CSS, and OMC. The sequence of messages is: 1) OMC sends a request to CSS; 2) CSS sends a request to SGSN; 3) SGSN sends a response to CSS; 4) CSS sends a response to OMC. + +- 2189 +- 2190 +- 2191 1) Modify GPRS Subscriber Data +- 2192 2) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind or MAP\_DELETE\_SUBSCRIBER\_DATA\_req/ind +- 2193 3) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf or MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp/cnf +- 2194 4) GPRS Subscriber Data Modified +- 2195 +- 2196 **Figure 20.3A/4: Subscriber data modification procedure for GPRS** + +2197 In the subscriber data modification procedure the CSG subscription data in the VPLMN for the subscriber data are + +2198 modified in the CSS and when necessary also in the VLR or in the SGSN. The CSS initiates one of the + +2199 MAP\_INSERT\_SUBSCRIBER\_DATA or MAP\_DELETE\_SUBSCRIBER\_DATA services depending on the modified + +2200 data. + +2201 **20.3A.1 Subscriber deletion procedure** + +2202 **20.3A.1.1 Procedure in the CSS** + +2203 The process in the CSS to delete subscriber is shown in figure 20.3A/5. In this case the CSS uses the + +2204 MAP\_DELETE\_SUBSCRIBER\_DATA service. + +2205 **20.3A.1.2 Procedure in the VLR** + +2206 The process in the VLR for the CSG subscriber deletion procedure is shown in figure 20.3A/9. + +2207 **20.3A.1.3 Procedure in the SGSN** + +2208 The process in the SGSN for the CSG subscriber deletion procedure is shown in figure 20.3A/11. + +## 2209 20.3A.2 Subscriber data modification procedure + +### 2210 20.3A.2.1 Procedure in the CSS + +2211 The OMC can modify the CSG subscriber data in several different ways. The modifications can be categorised in the +2212 following groups: + +- 2213 1) CSG subscription data shall be modified in the CSS; no effect in the VLR; +- 2214 2) CSG subscription data shall be modified in both the CSS and the VLR; +- 2215 3) withdrawal of CSG subscription data requiring change to VLR data. +- 2216 4) CSG subscription data shall be modified in the CSS; no effect in the SGSN; +- 2217 5) CSG subscription data shall be modified in both the CSS and the SGSN; +- 2218 6) withdrawal of CSG subscription data requiring change to SGSN data. + +2219 In cases 2 and 5 the CSS uses the MAP\_INSERT\_SUBSCRIBER\_DATA service. + +2220 In cases 3 and 6 the CSS uses the MAP\_DELETE\_SUBSCRIBER\_DATA service. + +2221 If the deletion of CSG subscriber data fails, the CSS may repeat the request; the number of repeat attempts and the time +2222 in between are CSS operator options, depending on the error returned by the VLR or the SGSN. The CSS removes the +2223 routing information after the completion of CSG subscriber data deletion procedure. + +2224 The CSG subscriber data modification process in the CSS is shown in figure 20.3A/6. The MAP process invokes +2225 processes not defined in this clause; the definitions of these processes can be found as follows: + +2226 Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS see clause 25.7.8; + +2227 The macro Delete\_VCSG\_Subs\_Data\_CSS is shown in figure 20.3A/7. The macro invokes macros not defined in this +2228 clause; the definitions of these macros can be found as follows: + +2229 Receive\_Open\_Cnf see clause 25.1.2; + +2230 Check\_Confirmation see clause 25.2.2. + +### 2231 20.3A.2.2 Procedures in the VLR + +2232 The process in the VLR to update CSG subscription data in the VPLMN for the subscriber in a stand-alone dialogue is +2233 shown in figure 20.3A/8. The MAP process invokes macros not defined in this clause; the definitions of these macros +2234 can be found as follows: + +2235 Check\_Indication see clause 25.2.1; + +2236 Insert\_Subs\_Data\_VLR see clause 25.7.1. + +2237 The process in the VLR to delete CSG subscriber data is shown in figure 20.3A/9. The MAP process invokes a macro +2238 not defined in this clause; the definition of this macro can be found as follows: + +2239 Check\_Indication see clause 25.2.1. + +### 2240 20.3A.2.3 Procedures in the SGSN + +2241 The process in the SGSN to update CSG subscription data in the VPLMN for the GPRS subscriber in a stand-alone +2242 dialogue is shown in figure 20.3A/10. The MAP process invokes macros not defined in this clause; the definitions of +2243 these macros can be found as follows: + +2244 Check\_Indication see clause 25.2.1; + +2245 Insert\_Subs\_Data\_SGSN see clause 25.7.2. + +2246 The process in the SGSN to delete subscriber data is shown in figure 20.3A/11. The MAP process invokes a macro not +2247 defined in this clause; the definition of this macro can be found as follows: + +2248     Check\_Indication               see clause 25.2.1. + +![Flowchart for process Delete_Subscriber_CSS. It starts with an oval 'Null', followed by a 'Null' rectangle. Then a parallelogram 'OM_Delete_Subscriber_ind'. A decision diamond 'Subscriber known?' has a 'No' path to 'Set User Error: Unknown subscriber' and a 'Yes' path to another decision diamond 'Subscriber registered in an SGSN?'. The 'Yes' path from the first diamond leads to 'Subscriber registered in an SGSN?'. From 'Subscriber registered in an SGSN?', a 'No' path leads to 'Delete_VCSG Subs_Data_CSS' and a 'Yes' path leads to 'Remove routing info from SGSN'. Both lead to a third decision diamond 'Subscriber registered in a VLR?'. From 'Subscriber registered in a VLR?', a 'No' path leads to 'Delete_VCSG Subs_Data_CSS' and a 'Yes' path leads to 'Remove routing info from VLR'. Both lead to 'Delete CSG subscriber data from CSS'. From 'Delete CSG subscriber data from CSS', the path leads to a parallelogram 'OM_Delete_Subscriber_rsp', which finally leads to an oval 'Null'.](5030a7405308d6b508b5a4e169901081_img.jpg) + +process Delete\_Subscriber\_CSS Del\_Sub\_CSS1(1) + +Process in the CSS to delete a subscriber record from the SGSN and/or the VLR + +Signals to/from the right are to/from the OMC + +``` + +graph TD + Start([Null]) --> Null1[Null] + Null1 --> OM_Delete_Subscriber_ind[/OM_Delete_Subscriber_ind/] + OM_Delete_Subscriber_ind --> Subscriber_known{Subscriber known?} + Subscriber_known -- No --> Set_User_Error[Set User Error: Unknown subscriber] + Subscriber_known -- Yes --> Subscriber_registered_SGSN{Subscriber registered in an SGSN?} + Subscriber_registered_SGSN -- No --> Delete_VCSG_Subs_Data_CSS1[Delete_VCSG Subs_Data_CSS] + Subscriber_registered_SGSN -- Yes --> Remove_routing_info_SGSN[Remove routing info from SGSN] + Delete_VCSG_Subs_Data_CSS1 --> Subscriber_registered_VLR{Subscriber registered in a VLR?} + Remove_routing_info_SGSN --> Subscriber_registered_VLR + Subscriber_registered_VLR -- No --> Delete_VCSG_Subs_Data_CSS2[Delete_VCSG Subs_Data_CSS] + Subscriber_registered_VLR -- Yes --> Remove_routing_info_VLR[Remove routing info from VLR] + Delete_VCSG_Subs_Data_CSS2 --> Delete_CSG_subscriber_data[Delete CSG subscriber data from CSS] + Remove_routing_info_VLR --> Delete_CSG_subscriber_data + Delete_CSG_subscriber_data --> OM_Delete_Subscriber_rsp[/OM_Delete_Subscriber_rsp/] + Set_User_Error --> OM_Delete_Subscriber_rsp + OM_Delete_Subscriber_rsp --> Null2([Null]) + +``` + +Flowchart for process Delete\_Subscriber\_CSS. It starts with an oval 'Null', followed by a 'Null' rectangle. Then a parallelogram 'OM\_Delete\_Subscriber\_ind'. A decision diamond 'Subscriber known?' has a 'No' path to 'Set User Error: Unknown subscriber' and a 'Yes' path to another decision diamond 'Subscriber registered in an SGSN?'. The 'Yes' path from the first diamond leads to 'Subscriber registered in an SGSN?'. From 'Subscriber registered in an SGSN?', a 'No' path leads to 'Delete\_VCSG Subs\_Data\_CSS' and a 'Yes' path leads to 'Remove routing info from SGSN'. Both lead to a third decision diamond 'Subscriber registered in a VLR?'. From 'Subscriber registered in a VLR?', a 'No' path leads to 'Delete\_VCSG Subs\_Data\_CSS' and a 'Yes' path leads to 'Remove routing info from VLR'. Both lead to 'Delete CSG subscriber data from CSS'. From 'Delete CSG subscriber data from CSS', the path leads to a parallelogram 'OM\_Delete\_Subscriber\_rsp', which finally leads to an oval 'Null'. + +2249 + +2250 + +Figure 20.3A/5: Process Delete\_Subscriber\_CSS + +![Flowchart for process Modify_Data_CSS. It starts with an entry point leading to 'Null', then 'OM_Modify_Subscriber_Data_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber' and then 'Null'. If 'Yes', it goes to 'OM_Modify_Subscriber_Data_rsp', then 'Modify subscriber data in CSS database'. A decision 'Subscriber registered in a VLR?' follows. If 'No', it goes to connector '2'. If 'Yes', it goes to a 'Type of modification' decision. From 'Type of modification', three paths exist: 'No effect in VLR' (to connector '2'), 'Data to be modified in VLR' (to 'Insert_VCSG_Subs_Data_Stand_Alone_CSS' then to connector '2'), and 'Data to be deleted from VLR' (to 'Delete_VCSG_Subs_Data_CSS', then 'OK' leads to 'Remove VLR Routeing Info in CSS database' then to connector '2', while 'Error' leads to connector '1'). A separate path starts with connector '1', leading to 'Repeat operation?'. If 'No', it goes to 'Remove VLR Routeing Info in CSS database' then to connector '2'. If 'Yes', it goes to 'Start repeat timer', then 'Wait_For_Timer_Expiry', then 'Repeat timer expired' (reached via 'Internal' signal). From 'Repeat timer expired', it goes to the 'Type of modification' decision.](9d6590334113ac3b64d7959d0ad63ac2_img.jpg) + +**process Modify\_Data\_CSS** **Mod\_Dat\_CSS1(2)** + +Process in the CSS to modify VPLMN CSG subscriber data in the SGSN and/or VLR + +Signals to/from the right are to/from the OMC + +``` + +graph TD + Entry([ ]) --> Null1([Null]) + Null1 --> OM_Modify_Subscriber_Data_ind[/OM_Modify_Subscriber_Data_ind/] + OM_Modify_Subscriber_Data_ind --> Subscriber_known{Subscriber known?} + Subscriber_known -- No --> Set_User_Error[Set User Error: Unknown subscriber] + Set_User_Error --> Null2([Null]) + Subscriber_known -- Yes --> OM_Modify_Subscriber_Data_rsp1[/OM_Modify_Subscriber_Data_rsp/] + OM_Modify_Subscriber_Data_rsp1 --> Modify_CSS[Modify subscriber data in CSS database] + Modify_CSS --> Subscriber_registered{Subscriber registered in a VLR?} + Subscriber_registered -- No --> Connector_2_1((2)) + Subscriber_registered -- Yes --> Type_of_modification{Type of modification} + Type_of_modification -- "No effect in VLR" --> Connector_2_2((2)) + Type_of_modification -- "Data to be modified in VLR" --> Insert_VCSG[Insert_VCSG_Subs_Data_Stand_Alone_CSS] + Insert_VCSG --> Connector_2_3((2)) + Type_of_modification -- "Data to be deleted from VLR" --> Delete_VCSG[Delete_VCSG_Subs_Data_CSS] + Delete_VCSG -- OK --> Remove_VLR_Info[Remove VLR Routeing Info in CSS database] + Remove_VLR_Info --> Connector_2_4((2)) + Delete_VCSG -- Error --> Connector_1_1((1)) + Connector_1_2((1)) --> Repeat_operation{Repeat operation?} + Repeat_operation -- No --> Remove_VLR_Info_2[Remove VLR Routeing Info in CSS database] + Remove_VLR_Info_2 --> Connector_2_5((2)) + Repeat_operation -- Yes --> Start_Timer[Start repeat timer] + Start_Timer --> Wait_Timer[Wait_For_Timer_Expiry] + Wait_Timer --> Repeat_Timer_Expired[Repeat timer expired] + Internal[Internal] --> Repeat_Timer_Expired + Repeat_Timer_Expired --> Type_of_modification + +``` + +Flowchart for process Modify\_Data\_CSS. It starts with an entry point leading to 'Null', then 'OM\_Modify\_Subscriber\_Data\_ind'. A decision 'Subscriber known?' follows. If 'No', it goes to 'Set User Error: Unknown subscriber' and then 'Null'. If 'Yes', it goes to 'OM\_Modify\_Subscriber\_Data\_rsp', then 'Modify subscriber data in CSS database'. A decision 'Subscriber registered in a VLR?' follows. If 'No', it goes to connector '2'. If 'Yes', it goes to a 'Type of modification' decision. From 'Type of modification', three paths exist: 'No effect in VLR' (to connector '2'), 'Data to be modified in VLR' (to 'Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS' then to connector '2'), and 'Data to be deleted from VLR' (to 'Delete\_VCSG\_Subs\_Data\_CSS', then 'OK' leads to 'Remove VLR Routeing Info in CSS database' then to connector '2', while 'Error' leads to connector '1'). A separate path starts with connector '1', leading to 'Repeat operation?'. If 'No', it goes to 'Remove VLR Routeing Info in CSS database' then to connector '2'. If 'Yes', it goes to 'Start repeat timer', then 'Wait\_For\_Timer\_Expiry', then 'Repeat timer expired' (reached via 'Internal' signal). From 'Repeat timer expired', it goes to the 'Type of modification' decision. + +2251 + +2252 + +**Figure 20.3A/6 (sheet 1 of 2): Process Modify\_Data\_CSS** + +![Flowchart for process Modify_Data_CSS. It starts at connector 3, checks if a repeat operation is needed. If no, it removes SGSN routing info and ends. If yes, it starts a timer and waits for expiry. Once expired, it checks if the subscriber is registered in an SGSN. If not, it ends. If yes, it checks the type of modification: no effect, modify, or delete. Modify and delete both lead to database updates and then to connector 3. Delete also has an error path.](7c4fdc38f4200c353bcd874b5ff3d57a_img.jpg) + +process Modify\_Data\_CSS Mod\_Dat\_CSS2(2) + +Process in the CSS to modify VPLMN CSG subscriber data in the SGSN and/or VLR + +``` + + graph TD + 3((3)) --> Repeat{Repeat operation?} + Repeat -- No --> Remove1[Remove SGSN Routeing Info in CSS database] + Remove1 --> Null1([Null]) + Repeat -- Yes --> StartTimer[Start repeat timer] + StartTimer --> WaitTimer[Wait_For_Timer_Expiry] + WaitTimer --> TimerExpired{Repeat timer expired} + TimerExpired --> Registered{Subscriber registered in an SGSN?} + Registered -- No --> Null2([Null]) + Registered -- Yes --> TypeMod{Type of modification} + TypeMod -- "No effect in SGSN" --> Null3([Null]) + TypeMod -- "Data to be modified in SGSN" --> Insert[Insert_VCSG_Subs_Data_Stand_Alone_CSS] + Insert --> Null4([Null]) + TypeMod -- "Data to be deleted from SGSN" --> Delete[Delete_VCSG_Subs_Data_CSS] + Delete -- OK --> Remove2[Remove SGSN Routeing Info in CSS database] + Remove2 --> Null5([Null]) + Delete -- Error --> 3 + +``` + +Flowchart for process Modify\_Data\_CSS. It starts at connector 3, checks if a repeat operation is needed. If no, it removes SGSN routing info and ends. If yes, it starts a timer and waits for expiry. Once expired, it checks if the subscriber is registered in an SGSN. If not, it ends. If yes, it checks the type of modification: no effect, modify, or delete. Modify and delete both lead to database updates and then to connector 3. Delete also has an error path. + +2253 + +2254 + +Figure 20.3A/6 (sheet 2 of 2): Process Modify\_Data\_CSS + +![Flowchart for macro Delete_VCSG_Subs_Data_CSS. It starts with an entry point leading to a merge point for MAP_OPEN_req, MAP_DELETE_SUBSCRIBER_DATA_req, and MAP_DELIMITER_req. This is followed by a 'Receive_Open_Cnf' block. An 'OK' path leads to 'Wait_For_VLR_Or_SGSN_Response', while a 'Vr, Error' path leads to an 'Error' circle. From the wait block, three paths emerge: 1) 'MAP_DELETE_SUBSCRIBER_DATA_cnf' leads to 'Check_Confirmation', which has an 'OK' path to an 'OK' circle and an error path to an 'Error' circle. 2) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which then leads to an 'Error' circle. 3) A third path leads to a merge point for 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind', which then leads to an 'Error' circle.](d11c6cc5ae4b83017d57a7fed1f5607a_img.jpg) + +**macrodefinition Delete\_VCSG\_Subs\_Data\_CSS** **DVSD\_CSS(1)** + +Macro in the CSS to delete CSG subscriber data in VPLMN from a VLR or SGSN + +Signals to/from the left are to/from the VLR or the SGSN + +``` +graph TD; Entry([ ]) --> Merge1{{ }}; Merge1 -- "MAP_OPEN_req +MAP_DELETE_SUBSCRIBER_DATA_req +MAP_DELIMITER_req" --> ReceiveCnf[Receive_Open_Cnf]; ReceiveCnf -- OK --> WaitForResponse([Wait_For_VLR_Or_SGSN_Response]); ReceiveCnf -- "Vr, Error" --> Error1((Error)); WaitForResponse --> DeleteCnf{MAP_DELETE_SUBSCRIBER_DATA_cnf}; WaitForResponse --> NoticeInd{MAP_NOTICE_ind}; WaitForResponse --> Merge2{{ }}; DeleteCnf --> CheckConfirmation[Check_Confirmation]; CheckConfirmation -- OK --> OK((OK)); CheckConfirmation -- "User Error, Provider Error, Data Error" --> Error2((Error)); NoticeInd --> CloseReq{MAP_CLOSE_req}; CloseReq --> Error3((Error)); Merge2 -- "MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind" --> Error3 +``` + +Flowchart for macro Delete\_VCSG\_Subs\_Data\_CSS. It starts with an entry point leading to a merge point for MAP\_OPEN\_req, MAP\_DELETE\_SUBSCRIBER\_DATA\_req, and MAP\_DELIMITER\_req. This is followed by a 'Receive\_Open\_Cnf' block. An 'OK' path leads to 'Wait\_For\_VLR\_Or\_SGSN\_Response', while a 'Vr, Error' path leads to an 'Error' circle. From the wait block, three paths emerge: 1) 'MAP\_DELETE\_SUBSCRIBER\_DATA\_cnf' leads to 'Check\_Confirmation', which has an 'OK' path to an 'OK' circle and an error path to an 'Error' circle. 2) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which then leads to an 'Error' circle. 3) A third path leads to a merge point for 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind', which then leads to an 'Error' circle. + +**Figure 20.3A/7: Macro Delete\_VCSG\_Subs\_Data\_CSS** + +![Flowchart for process Ins_VCSG_Subs_Data_Stand_Alone_VLR. The process starts with an entry point, followed by a 'Null' state. It then receives a 'MAP_INSERT_SUBSCRIBER_DATA_ind' and enters a 'Check_Indication' state. From there, it checks if the IMSI is known. If not, it sets a user error for an unidentified subscriber. If known, it checks if all received services and features are supported. If not, it updates subscriber data for supported services and features and sets parameters for unsupported ones. If supported, it updates subscriber data. Next, it checks if the MSC area is restricted due to regional subscription. If yes, it sets the network node area restricted. Finally, it sends a 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req' and enters a 'Wait_For_Service_Indication' state. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by CSS:=False'.](4067b0820e16788e1e01899473b3a1e2_img.jpg) + +process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR + +IVSD\_SA\_VLR1(2) + +Process in the VLR to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Entry([ ]) --> Null[Null] + Null --> Ind[MAP_INSERT_SUBSCRIBER_DATA_ind] + Ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + Check -- Error --> CSS[Subscriber data confirmed by CSS:=False] + IMSI -- No --> ErrorSub[Set User Error Unidentified Subscriber] + IMSI -- Yes --> AllSupp{All received services & features supported?} + AllSupp -- No --> UpdateSupp[Update subscriber data for supported services & features] + UpdateSupp --> SetParams[Set parameters for unsupported services & features] + AllSupp -- Yes --> UpdateData[Update subscriber data] + UpdateData --> MSCRestricted{MSC area restricted due to regional subscription?} + MSCRestricted -- Yes --> NetworkRestricted[Set network node area restricted] + MSCRestricted -- No --> Join(( )) + ErrorSub --> Join + NetworkRestricted --> Join + CSS --> Join + Join --> Rsp[MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + Rsp --> Wait[Wait_For_Service_Indication] + +``` + +Flowchart for process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR. The process starts with an entry point, followed by a 'Null' state. It then receives a 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind' and enters a 'Check\_Indication' state. From there, it checks if the IMSI is known. If not, it sets a user error for an unidentified subscriber. If known, it checks if all received services and features are supported. If not, it updates subscriber data for supported services and features and sets parameters for unsupported ones. If supported, it updates subscriber data. Next, it checks if the MSC area is restricted due to regional subscription. If yes, it sets the network node area restricted. Finally, it sends a 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req' and enters a 'Wait\_For\_Service\_Indication' state. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by CSS:=False'. + +2258 + +2259 + +Figure 20.3A/8 (sheet 1 of 2): Process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR + +![State transition diagram for process Ins_VCSG_Subs_Data_Stand_Alone_VLR. The diagram shows transitions between states based on MAP messages. Initial state: Wait_For_Service_Indication. Transitions: Insert_Subs_Data_VLR leads to Wait_For_Service_Indication; MAP_CLOSE_ind leads to Store CSG subscriber data in VLR; MAP_NOTICE_ind leads to MAP_CLOSE_req. From MAP_CLOSE_req, a transition leads to an unlabeled state (receiving MAP_U_ABORT_ind, MAP_P_ABORT_ind) and another to 'Subscriber data confirmed by CSS:=False'. From Store CSG subscriber data in VLR, a transition leads to 'Subscriber data confirmed by CSS:=True'. Both final states lead to a dead state (marked with X).](3d9f6a7ee390e08ac762a77fe7472b9f_img.jpg) + +process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR + +IVSD\_SA\_VLR2(2) + +Process in the VLR to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the CSS + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Indication + state "Wait_For_Service_Indication" as Wait_For_Service_Indication + state "Store CSG subscriber data in VLR" as Store CSG subscriber data in VLR + state "Subscriber data confirmed by CSS:=True" as Subscriber data confirmed by CSS:=True + state "Subscriber data confirmed by CSS:=False" as Subscriber data confirmed by CSS:=False + state "Unlabeled State" as Unlabeled State + state [*] as [*] + + Wait_For_Service_Indication --> Insert_Subs_Data_VLR : Insert_Subs_Data_VLR + Insert_Subs_Data_VLR --> Wait_For_Service_Indication : Wait_For_Service_Indication + Wait_For_Service_Indication --> MAP_CLOSE_ind : MAP_CLOSE_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind : MAP_NOTICE_ind + MAP_CLOSE_ind --> Store CSG subscriber data in VLR : Store CSG subscriber data in VLR + Store CSG subscriber data in VLR --> Subscriber data confirmed by CSS:=True : Subscriber data confirmed by CSS:=True + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_CLOSE_req --> Unlabeled State : MAP_U_ABORT_ind, MAP_P_ABORT_ind + MAP_CLOSE_req --> Subscriber data confirmed by CSS:=False : Subscriber data confirmed by CSS:=False + Subscriber data confirmed by CSS:=True --> [*] : X + Subscriber data confirmed by CSS:=False --> [*] : X + +``` + +State transition diagram for process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR. The diagram shows transitions between states based on MAP messages. Initial state: Wait\_For\_Service\_Indication. Transitions: Insert\_Subs\_Data\_VLR leads to Wait\_For\_Service\_Indication; MAP\_CLOSE\_ind leads to Store CSG subscriber data in VLR; MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req. From MAP\_CLOSE\_req, a transition leads to an unlabeled state (receiving MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind) and another to 'Subscriber data confirmed by CSS:=False'. From Store CSG subscriber data in VLR, a transition leads to 'Subscriber data confirmed by CSS:=True'. Both final states lead to a dead state (marked with X). + +2260 + +2261 + +Figure 20.3A/8 (sheet 2 of 2): Process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_VLR + +![Flowchart for process Delete_VCSG_Subs_Data_VLR. The process starts with an initial node, followed by a 'Null' node. It then receives a 'MAP_DELETE_SUBSCRIBER_DATA_ind' signal. A 'Check_Indication' block follows. If 'OK', it checks if 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it proceeds to 'Delete CSG subscriber data received from CSS stored in the VLR'. From there, if 'Deletion successful?' is 'No', it goes to 'Subscriber data confirmed by CSS:=False'. If 'Yes', it checks if 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. Both 'Set network node area restricted' and 'Subscriber data confirmed by CSS:=False' lead to 'Location Information confirmed by CSS:=False'. If 'MSC area restricted due to regional subscription?' is 'No', it goes to 'Subscriber data confirmed by CSS:=True', then 'Location Information confirmed by CSS:=False'. All three 'Location Information confirmed by CSS:=False' blocks lead to a merge node, which then leads to 'MAP_DELETE_SUBSCRIBER_DATA_rsp' and 'MAP_CLOSE_req'. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by CSS:=False', then 'Location Information confirmed by CSS:=False'. The process ends with an exit node.](6a2cf14cfb5a58fc668f27ae692095c7_img.jpg) + +process Delete\_VCSG\_Subs\_Data\_VLR + +DVSD\_VLR1(1) + +Process in the VLR to handle Delete Subscriber Data requests + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Ind[MAP_DELETE_SUBSCRIBER_DATA_ind] + Ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + Check -- Error --> SubFalse1[Subscriber data confirmed by CSS:=False] + IMSI -- No --> UserError[Set User Error: Unknown subscriber] + IMSI -- Yes --> Delete[Delete CSG subscriber data received from CSS stored in the VLR] + Delete -- No --> SubFalse2[Subscriber data confirmed by CSS:=False] + Delete -- Yes --> Restricted{MSC area restricted due to regional subscription?} + Restricted -- Yes --> SetRestricted[Set network node area restricted] + Restricted -- No --> SubTrue[Subscriber data confirmed by CSS:=True] + SetRestricted --> LocFalse1[Location Information confirmed by CSS:=False] + SubFalse2 --> LocFalse2[Location Information confirmed by CSS:=False] + SubTrue --> LocFalse3[Location Information confirmed by CSS:=False] + SubFalse1 --> LocFalse4[Location Information confirmed by CSS:=False] + LocFalse1 --> Merge{ } + LocFalse2 --> Merge + LocFalse3 --> Merge + LocFalse4 --> Merge + Merge --> Rsp[MAP_DELETE_SUBSCRIBER_DATA_rsp +MAP_CLOSE_req] + Rsp --> End([X]) + UserError --> Merge + SubFalse1 --> LocFalse4 + LocFalse4 --> Abort[MAP_U_ABORT_req] + Abort --> End + +``` + +Flowchart for process Delete\_VCSG\_Subs\_Data\_VLR. The process starts with an initial node, followed by a 'Null' node. It then receives a 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' signal. A 'Check\_Indication' block follows. If 'OK', it checks if 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it proceeds to 'Delete CSG subscriber data received from CSS stored in the VLR'. From there, if 'Deletion successful?' is 'No', it goes to 'Subscriber data confirmed by CSS:=False'. If 'Yes', it checks if 'MSC area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. Both 'Set network node area restricted' and 'Subscriber data confirmed by CSS:=False' lead to 'Location Information confirmed by CSS:=False'. If 'MSC area restricted due to regional subscription?' is 'No', it goes to 'Subscriber data confirmed by CSS:=True', then 'Location Information confirmed by CSS:=False'. All three 'Location Information confirmed by CSS:=False' blocks lead to a merge node, which then leads to 'MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_CLOSE\_req'. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by CSS:=False', then 'Location Information confirmed by CSS:=False'. The process ends with an exit node. + +2262 + +2263 + +Figure 20.3A/9: Process Delete\_VCSG\_Subs\_Data\_VLR + +![Flowchart for process Ins_VCSG_Subs_Data_Stand_Alone_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop with 'MAP_INSERT_SUBSCRIBER_DATA_ind', 'Check_Indication', and a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks if all services and features are supported. If 'No', it updates data for supported services and sets parameters for unsupported ones. If 'Yes', it updates subscriber data. Both paths lead to a decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it sets network node area restricted. If 'No', it proceeds. All paths converge to a block with 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req', ending with 'Wait_For_Service_Indication'. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by CSS:=False'.](78de160f13972924f5ca78417879b13b_img.jpg) + +process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN + +IVSD\_SA\_SGSN1(2) + +Process in the SGSN to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Ind[MAP_INSERT_SUBSCRIBER_DATA_ind] + Ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + Check -- Error --> CSS[Subscriber data confirmed by CSS:=False] + IMSI -- No --> ErrorSub[Set User Error: Unidentified Subscriber] + IMSI -- Yes --> AllSupp{All received services & features supported?} + AllSupp -- No --> UpdateSupp[Update subscriber data for supported services & features] + UpdateSupp --> SetParams[Set parameters for unsupported services & features] + AllSupp -- Yes --> UpdateData[Update subscriber data] + UpdateSupp --> Restricted{SGSN area restricted due to regional subscription?} + SetParams --> Restricted + UpdateData --> Restricted + Restricted -- Yes --> SetRestricted[Set network node area restricted] + SetRestricted --> Join(( )) + CSS --> Join + ErrorSub --> Join + Join --> Rsp[MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + Rsp --> Wait[Wait_For_Service_Indication] + +``` + +Flowchart for process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN. The process starts with an oval, followed by a 'Null' block. It then enters a loop with 'MAP\_INSERT\_SUBSCRIBER\_DATA\_ind', 'Check\_Indication', and a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks if all services and features are supported. If 'No', it updates data for supported services and sets parameters for unsupported ones. If 'Yes', it updates subscriber data. Both paths lead to a decision 'SGSN area restricted due to regional subscription?'. If 'Yes', it sets network node area restricted. If 'No', it proceeds. All paths converge to a block with 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req', ending with 'Wait\_For\_Service\_Indication'. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by CSS:=False'. + +2264 + +2265 + +Figure 20.3A/10 (sheet 1 of 2): Process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN + +![State transition diagram for process Ins_VCSG_Subs_Data_Stand_Alone_SGSN. It shows transitions between states like 'Wait_For_Service_Indication', 'Insert_Subs_Data_SGSN', 'Store CSG subscriber data in SGSN', and 'Subscriber data confirmed by CSS:=True/False'. Transitions are labeled with MAP messages like CLOSE_ind, NOTICE_ind, CLOSE_req, and ABORT_ind.](ac74e08980f38375bdb77b8e8d14bd0f_img.jpg) + +process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN IVSD\_SA\_SGSN2(2) + +Process in the SGSN to handle Insert Subscriber Data requests in a stand-alone dialogue + +Signals to/from the right are to/from the CSS + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Indication + state "Wait_For_Service_Indication" as Wait_For_Service_Indication + state "Insert_Subs_Data_SGSN" as Insert_Subs_Data_SGSN + state "Store CSG subscriber data in SGSN" as Store_CSG_subscriber_data_in_SGSN + state "Subscriber data confirmed by CSS:=True" as Subscriber_data_confirmed_by_CSS_True + state "Subscriber data confirmed by CSS:=False" as Subscriber_data_confirmed_by_CSS_False + + Wait_For_Service_Indication --> Insert_Subs_Data_SGSN : Insert_Subs_Data_SGSN + Insert_Subs_Data_SGSN --> Wait_For_Service_Indication : Wait_For_Service_Indication + Insert_Subs_Data_SGSN --> Store_CSG_subscriber_data_in_SGSN : MAP_CLOSE_ind + Store_CSG_subscriber_data_in_SGSN --> Subscriber_data_confirmed_by_CSS_True : Store CSG subscriber data in SGSN + Store_CSG_subscriber_data_in_SGSN --> Subscriber_data_confirmed_by_CSS_False : MAP_NOTICE_ind + Subscriber_data_confirmed_by_CSS_False --> Insert_Subs_Data_SGSN : MAP_CLOSE_req + Subscriber_data_confirmed_by_CSS_False --> [*] : + Subscriber_data_confirmed_by_CSS_False --> Insert_Subs_Data_SGSN : MAP_U_ABORT_ind, MAP_P_ABORT_ind + +``` + +State transition diagram for process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN. It shows transitions between states like 'Wait\_For\_Service\_Indication', 'Insert\_Subs\_Data\_SGSN', 'Store CSG subscriber data in SGSN', and 'Subscriber data confirmed by CSS:=True/False'. Transitions are labeled with MAP messages like CLOSE\_ind, NOTICE\_ind, CLOSE\_req, and ABORT\_ind. + +2266 + +2267 + +Figure 20.3A/10 (sheet 2 of 2): Process Ins\_VCSG\_Subs\_Data\_Stand\_Alone\_SGSN + +![Flowchart for process Delete_VCSG_Subs_Data_SGSN. The process starts with an initial node, followed by a 'Null' node. It then receives a 'MAP_DELETE_SUBSCRIBER_DATA_ind' message. A 'Check_Indication' block is followed by a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it proceeds to 'Delete CSG subscriber data received from CSS stored in the SGSN'. From there, a decision 'Deletion successful?' follows. If 'No', it goes to 'Subscriber data confirmed by CSS:=False' and then 'Location Information confirmed by CSS:=False', leading to 'MAP_U_ABORT_req'. If 'Yes', it checks 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it goes to 'Subscriber data confirmed by CSS:=True' and then 'Location Information confirmed by CSS:=False'. Both 'Set network node area restricted' and 'Location Information confirmed by CSS:=False' lead to a merge point before the final response 'MAP_DELETE_SUBSCRIBER_DATA_rsp' and 'MAP_CLOSE_req'. An 'Error' path from 'Check_Indication' leads to 'Subscriber data confirmed by CSS:=False' and 'Location Information confirmed by CSS:=False'.](351fc45d07147498cc7990485c230a41_img.jpg) + +process Delete\_VCSG\_Subs\_Data\_SGSN + +DVSD\_SGSN1(1) + +Process in the SGSN to handle Delete Subscriber Data requests + +Signals to/from the right are to/from the CSS + +``` + +graph TD + Start([ ]) --> Null[Null] + Null --> Ind[MAP_DELETE_SUBSCRIBER_DATA_ind] + Ind --> Check[Check_Indication] + Check -- OK --> IMSI{IMSI known?} + Check -- Error --> SubDataFalse1[Subscriber data confirmed by CSS:=False] + SubDataFalse1 --> LocInfoFalse1[Location Information confirmed by CSS:=False] + IMSI -- No --> UserError[Set User Error: Unknown subscriber] + IMSI -- Yes --> DeleteCSG[Delete CSG subscriber data received from CSS stored in the SGSN] + DeleteCSG --> Deletion{Deletion successful?} + Deletion -- No --> SubDataFalse2[Subscriber data confirmed by CSS:=False] + SubDataFalse2 --> LocInfoFalse2[Location Information confirmed by CSS:=False] + Deletion -- Yes --> Restricted{SGSN area restricted due to regional subscription?} + Restricted -- Yes --> SetRestricted[Set network node area restricted] + Restricted -- No --> SubDataTrue[Subscriber data confirmed by CSS:=True] + SubDataTrue --> LocInfoFalse3[Location Information confirmed by CSS:=False] + SetRestricted --> LocInfoFalse3 + SubDataFalse2 --> Merge(( )) + LocInfoFalse1 --> Merge + LocInfoFalse2 --> Merge + LocInfoFalse3 --> Merge + UserError --> Merge + Merge --> Res[MAP_DELETE_SUBSCRIBER_DATA_rsp +MAP_CLOSE_req] + Res --> End([ ]) + LocInfoFalse2 --> Abort[MAP_U_ABORT_req] + Abort --> End2([ ]) + +``` + +Flowchart for process Delete\_VCSG\_Subs\_Data\_SGSN. The process starts with an initial node, followed by a 'Null' node. It then receives a 'MAP\_DELETE\_SUBSCRIBER\_DATA\_ind' message. A 'Check\_Indication' block is followed by a decision 'IMSI known?'. If 'No', it goes to 'Set User Error: Unknown subscriber'. If 'Yes', it proceeds to 'Delete CSG subscriber data received from CSS stored in the SGSN'. From there, a decision 'Deletion successful?' follows. If 'No', it goes to 'Subscriber data confirmed by CSS:=False' and then 'Location Information confirmed by CSS:=False', leading to 'MAP\_U\_ABORT\_req'. If 'Yes', it checks 'SGSN area restricted due to regional subscription?'. If 'Yes', it goes to 'Set network node area restricted'. If 'No', it goes to 'Subscriber data confirmed by CSS:=True' and then 'Location Information confirmed by CSS:=False'. Both 'Set network node area restricted' and 'Location Information confirmed by CSS:=False' lead to a merge point before the final response 'MAP\_DELETE\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_CLOSE\_req'. An 'Error' path from 'Check\_Indication' leads to 'Subscriber data confirmed by CSS:=False' and 'Location Information confirmed by CSS:=False'. + +2268 + +2269 + +Figure 20.3A/11: Process Delete\_VCSG\_Subs\_Data\_SGSN + +## 20.4 Subscriber Identity procedure + +In the subscriber identity procedure the IMSI of the subscriber is retrieved from the HLR. The procedure is shown in figure 20.4/1. + +![Sequence diagram of the subscriber identity procedure showing interactions between OMC, VLR, and HLR.](4965ba9124b08743865ab2ca64355ac0_img.jpg) + +``` +sequenceDiagram + participant OMC + participant VLR + participant HLR + Note left of OMC: 1) Identity request + OMC->>VLR: + Note right of VLR: 2) MAP_SEND_IMSI_req/ind + VLR->>HLR: + Note right of HLR: 3) MAP_SEND_IMSI_rsp/cnf + HLR->>VLR: + Note left of VLR: 4) Identity confirm + VLR->>OMC: +``` + +Sequence diagram of the subscriber identity procedure showing interactions between OMC, VLR, and HLR. + +2273 + +- 2274 +- 2275 1) Identity request +- 2276 2) MAP\_SEND\_IMSI\_req/ind +- 2277 3) MAP\_SEND\_IMSI\_rsp/cnf +- 2278 4) Identity confirm + +Figure 20.4/1: The subscriber identity procedure + +### 20.4.1 Procedure in the VLR + +The subscriber identity process in the VLR is shown in figure 20.4/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 2283 Receive\_Open\_Cnf see clause 25.1.2; +- 2284 Check\_Confirmation see clause 25.2.2. + +### 20.4.2 Procedure in the HLR + +The subscriber identity process in the HLR is shown in figure 20.4/3. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 2288 Receive\_Open\_Ind see clause 25.1.1; +- 2289 Check\_Indication see clause 25.2.1. + +2290 + +![Flowchart for process Send_IMSI_VLR. The process starts with an initial node, followed by a 'Null' node. It then receives an 'OM_Subscriber_Identity_ind' signal. Next, it sends 'MAP_OPEN_req', 'MAP_SEND_IMSI_req', and 'MAP_DELIMITER_req' signals. It then enters a 'Receive_Open_Cnf' state. A decision diamond 'Vr=V1?' follows. If 'Yes', it goes to 'Set User Error'. If 'No', it goes to 'Perform MAP Vr dialogue' and then to a 'Null' node. If 'OK', it goes to 'Wait_For_HLR_Response'. From there, it sends 'MAP_SEND_IMSI_cnf', 'MAP_NOTICE_ind', and another signal (MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind). It then enters a 'Check_Confirmation' state. From 'Check_Confirmation', an 'OK' response leads to 'OM_Subscriber_Identity_rsp' and then to a 'Null' node. A 'User Error, Provider Error, Data Error' response leads to 'Set User Error', which then leads to 'OM_Subscriber_Identity_rsp' and finally to a 'Null' node.](8ecf4fcb6fbc87c458f23d5fe82014b6_img.jpg) + +**process Send\_IMSI\_VLR** **SI\_VLR1(1)** + +Process in the VLR to request the IMSI of a subscriber from the HLR + +Signals to/from the left are to/from the OMC; signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> In1{{ }} + In1 --> OM_Sig1[OM_Subscriber_Identity_ind] + OM_Sig1 --> Out1{{ }} + Out1 --> MAP_Sigs1["MAP_OPEN_req +MAP_SEND_IMSI_req +MAP_DELIMITER_req"] + MAP_Sigs1 --> RecOpenCnf[Receive_Open_Cnf] + RecOpenCnf --> VrV1{Vr=V1?} + VrV1 -- Yes --> SetUserErr1[Set User Error] + VrV1 -- No --> PerformMAP[Perform MAP Vr dialogue] + PerformMAP --> Null2([Null]) + VrV1 -- OK --> WaitForHLR[Wait_For_HLR_Response] + WaitForHLR --> Out2{{ }} + Out2 --> MAP_Sig2[MAP_SEND_IMSI_cnf] + WaitForHLR --> Out3{{ }} + Out3 --> MAP_Sig3[MAP_NOTICE_ind] + WaitForHLR --> Out4{{ }} + Out4 --> MAP_Sig4["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + MAP_Sig2 --> CheckConf[Check_Confirmation] + MAP_Sig3 --> Out5{{ }} + Out5 --> MAP_Sig5[MAP_CLOSE_req] + CheckConf -- OK --> In2{{ }} + In2 --> OM_Sig2[OM_Subscriber_Identity_rsp] + OM_Sig2 --> Null3([Null]) + CheckConf -- "User Error, +Provider Error, +Data Error" --> SetUserErr2[Set User Error] + SetUserErr2 --> In3{{ }} + In3 --> OM_Sig2 + +``` + +Flowchart for process Send\_IMSI\_VLR. The process starts with an initial node, followed by a 'Null' node. It then receives an 'OM\_Subscriber\_Identity\_ind' signal. Next, it sends 'MAP\_OPEN\_req', 'MAP\_SEND\_IMSI\_req', and 'MAP\_DELIMITER\_req' signals. It then enters a 'Receive\_Open\_Cnf' state. A decision diamond 'Vr=V1?' follows. If 'Yes', it goes to 'Set User Error'. If 'No', it goes to 'Perform MAP Vr dialogue' and then to a 'Null' node. If 'OK', it goes to 'Wait\_For\_HLR\_Response'. From there, it sends 'MAP\_SEND\_IMSI\_cnf', 'MAP\_NOTICE\_ind', and another signal (MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind). It then enters a 'Check\_Confirmation' state. From 'Check\_Confirmation', an 'OK' response leads to 'OM\_Subscriber\_Identity\_rsp' and then to a 'Null' node. A 'User Error, Provider Error, Data Error' response leads to 'Set User Error', which then leads to 'OM\_Subscriber\_Identity\_rsp' and finally to a 'Null' node. + +2291 + +2292 + +Figure 20.4/2: Process Send\_IMSI\_VLR + +![Flowchart for process Send_IMSI_HLR. It starts with an initial node, followed by 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'OK' leads to 'Wait_For_Service_Indication', 'Vr' leads to 'Perform MAP Vr dialogue', and 'Error' leads to 'Null'. 'Wait_For_Service_Indication' leads to a horizontal line with three branches: 'MAP_P_ABORT_ind' (leading to 'Null'), 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' then 'Null'), and 'MAP_SEND_IMSI_ind' (leading to 'Check_Indication'). 'Perform MAP Vr dialogue' leads to 'Null'. 'Check_Indication' leads to a decision 'Subscriber known?'. If 'Yes', it goes to 'Fetch IMSI'. If 'No', it goes to 'Set User Error: Unknown subscriber'. Both 'Fetch IMSI' and 'Set User Error' lead to a merge point. From this merge point, a box contains 'MAP_SEND_IMSI_rsp' and 'MAP_CLOSE_req', which then leads to a pentagonal node and finally 'Null'. An 'Error' path also leads from the 'Subscriber known?' decision to the merge point.](fdbf814083ff2d7d499496be85b828a1_img.jpg) + +**process Send\_IMSI\_HLR** **SI\_HLR1(1)** + +Process in the HLR to handle a request from the VLR for the IMSI of a subscriber + +Signals to/from the left are to/from the VLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- OK --> Wait_For_Service_Indication([Wait_For_Service_Indication]) + Receive_Open_Ind -- Vr --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Receive_Open_Ind -- Error --> Null2([Null]) + Wait_For_Service_Indication --> MAP_P_ABORT_ind[/MAP_P_ABORT_ind/] + Wait_For_Service_Indication --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + Wait_For_Service_Indication --> MAP_SEND_IMSI_ind[/MAP_SEND_IMSI_ind/] + Perform_MAP_Vr_dialogue --> Null3([Null]) + MAP_P_ABORT_ind --> Null4([Null]) + MAP_NOTICE_ind --> MAP_CLOSE_req[/MAP_CLOSE_req/] + MAP_CLOSE_req --> Null5([Null]) + MAP_SEND_IMSI_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> Subscriber_known{Subscriber known?} + Subscriber_known -- No --> Set_User_Error[Set User Error: Unknown subscriber] + Subscriber_known -- Yes --> Fetch_IMSI[Fetch IMSI] + Set_User_Error --> Merge(( )) + Fetch_IMSI --> Merge + Merge --> MAP_SEND_IMSI_rsp[MAP_SEND_IMSI_rsp] + Merge --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_SEND_IMSI_rsp --> Pentagonal{ } + MAP_CLOSE_req2 --> Pentagonal + Pentagonal --> Null6([Null]) + Subscriber_known -- Error --> Merge + +``` + +Flowchart for process Send\_IMSI\_HLR. It starts with an initial node, followed by 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'OK' leads to 'Wait\_For\_Service\_Indication', 'Vr' leads to 'Perform MAP Vr dialogue', and 'Error' leads to 'Null'. 'Wait\_For\_Service\_Indication' leads to a horizontal line with three branches: 'MAP\_P\_ABORT\_ind' (leading to 'Null'), 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' then 'Null'), and 'MAP\_SEND\_IMSI\_ind' (leading to 'Check\_Indication'). 'Perform MAP Vr dialogue' leads to 'Null'. 'Check\_Indication' leads to a decision 'Subscriber known?'. If 'Yes', it goes to 'Fetch IMSI'. If 'No', it goes to 'Set User Error: Unknown subscriber'. Both 'Fetch IMSI' and 'Set User Error' lead to a merge point. From this merge point, a box contains 'MAP\_SEND\_IMSI\_rsp' and 'MAP\_CLOSE\_req', which then leads to a pentagonal node and finally 'Null'. An 'Error' path also leads from the 'Subscriber known?' decision to the merge point. + +2293 + +2294 + +Figure 20.4/3: Process Send\_IMSI\_HLR + +--- + +## 2295 21 Call handling procedures + +### 2296 21.1 General + +2297 The MAP call handling procedures are used: + +- 2298 - to retrieve routeing information to handle a mobile terminating call; +- 2299 - to transfer control of a call back to the GMSC if the call is to be forwarded; +- 2300 - to retrieve and transfer information between anchor MSC and relay MSC for inter MSC group calls / broadcast +- 2301 calls; +- 2302 - to handle the reporting of MS status for call completion services; +- 2303 - to handle the notification of remote user free for CCBS; +- 2304 - to handle the alerting and termination of ongoing call activities for a specific subscriber; +- 2305 - to handle early release of no longer needed resources; +- 2306 - to relay a mobile terminating call from the old to the new MSC during the Mobile Terminating Roaming +- 2307 Forwarding procedure. + +2308 The procedures to handle a mobile originating call and a mobile terminating call after the call has arrived at the +2309 destination MSC do not require any signalling over a MAP interface. These procedures are specified in 3GPP TS +2310 23.018 [97]. + +2311 The stage 2 specification for the retrieval of routeing information to handle a mobile terminating call is in 3GPP TS +2312 23.018 [97]; modifications to this procedure for CAMEL are specified in 3GPP TS 23.078 [98], for optimal routeing of +2313 a basic mobile-to-mobile call in 3GPP TS 23.079 [99] and for CCBS in 3GPP TS 23.093 [107]. The interworking +2314 between the MAP signalling procedures and the call handling procedures for each entity (GMSC, HLR and VLR) is +2315 shown by the transfer of signals between these procedures. + +2316 The stage 2 specification for the transfer of control of a call back to the GMSC if the call is to be forwarded is in 3GPP +2317 TS 23.079 [99]. The interworking between the MAP signalling procedures and the call handling procedures for each +2318 entity (VMSC and GMSC) is shown by the transfer of signals between these procedures. + +2319 The stage 2 specifications for inter MSC group calls / broadcast calls are in 3GPP TS 43.068 [100] and 3GPP TS 43.069 +2320 [101]. The interworking between the MAP signalling procedures and the group call /broadcast call procedures for each +2321 entity (Anchor MSC and Relay MSC) is shown by the transfer of signals between these procedures. + +2322 The interworking between the call handling procedures and signalling protocols other than MAP are shown in 3GPP TS +2323 23.018, 3GPP TS 23.078 and 3GPP TS 23.079 [99]. + +2324 The stage 2 specification for the handling of reporting of MS status for call completion services and notification of +2325 remote user free for CCBS is in 3GPP TS 23.093 [107]. + +2326 The stage 2 specification for the Mobile Terminating Roaming Forwarding procedure is in 3GPP TS 23.018 [97] and +2327 3GPP TS 23.012 [23]. + +### 2328 21.2 Retrieval of routing information + +#### 2329 21.2.1 General + +2330 The message flows for successful retrieval of routeing information for a mobile terminating call are shown in +2331 figure 21.2/1 (mobile terminating call which has not been optimally routed) and 21.2/2 (mobile-to-mobile call which +2332 has been optimally routed). The message flow for successful retrieval of routeing information for a gsmSCF initiated +2333 call is shown in figure 21.2/3. The message flow for a successful Mobile Terminating Roaming Forwarding procedure +2334 is shown in figure 21.2/4. + +![Sequence diagram showing message flow for retrieval of routing information between PSTN/ISDN, GMSC, HLR, VLR, and MSC. The diagram shows 14 numbered message exchanges between these entities.](16fcd4fa5a01a7016b528f4dfad779cb_img.jpg) + +``` + +sequenceDiagram + participant PSTN_ISDN as PSTN/ISDN + participant GMSC + participant HLR + participant VLR + participant MSC + + Note right of PSTN_ISDN: 1) I_IAM (Note 1) + PSTN_ISDN->>GMSC: + Note right of GMSC: 2) MAP_SEND_ROUTING_INFORMATION_req/ind (Note 2) + GMSC->>HLR: + Note right of HLR: 3) MAP_PROVIDE_SUBSCRIBER_INFO_req/ind (Note 3, Note 4) + HLR->>VLR: + Note right of VLR: 4) MAP_PROVIDE_SUBSCRIBER_INFO_rsp/cnf (Note 4) + VLR->>HLR: + Note right of HLR: 5) MAP_SEND_ROUTING_INFORMATION_rsp/cnf (Note 4) + HLR->>GMSC: + Note right of GMSC: 6) MAP_SEND_ROUTING_INFORMATION_req/ind (Note 4) + GMSC->>HLR: + Note right of HLR: 7) MAP_PROVIDE_ROAMING_NUMBER_req/ind + HLR->>VLR: + Note right of VLR: 8) MAP_PROVIDE_ROAMING_NUMBER_rsp/cnf + VLR->>HLR: + Note right of HLR: 9) MAP_SEND_ROUTING_INFORMATION_rsp/cnf + HLR->>GMSC: + Note right of GMSC: 10) I_IAM (Note 1) + GMSC->>MSC: + Note right of MSC: 11) MAP_RESTORE_DATA_req/ind (Note 4) + MSC->>HLR: + Note right of HLR: 12) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 4) + HLR->>VLR: + Note right of VLR: 13) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 4) + VLR->>HLR: + Note right of HLR: 14) MAP_RESTORE_DATA_rsp/cnf (Note 4) + HLR->>GMSC: + +``` + +Sequence diagram showing message flow for retrieval of routing information between PSTN/ISDN, GMSC, HLR, VLR, and MSC. The diagram shows 14 numbered message exchanges between these entities. + +2335 + +2336 + +- 2337 1) I\_IAM (Note 1) +- 2338 2) MAP\_SEND\_ROUTING\_INFORMATION\_req/ind (Note 2) +- 2339 3) *MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req/ind* (Note 3, Note 4) +- 2340 4) *MAP\_PROVIDE\_SUBSCRIBER\_INFO\_rsp/cnf* (Note 4) +- 2341 5) *MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf* (Note 4) +- 2342 6) *MAP\_SEND\_ROUTING\_INFORMATION\_req/ind* (Note 4) +- 2343 7) *MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind* +- 2344 8) *MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf* +- 2345 9) *MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf* +- 2346 10) I\_IAM (Note 1) +- 2347 11) *MAP\_RESTORE\_DATA\_req/ind* (Note 4) +- 2348 12) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind* (Note 4) +- 2349 13) *MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf* (Note 4) +- 2350 14) *MAP\_RESTORE\_DATA\_rsp/cnf* (Note 4) + +2351 + +2352 NOTE 1: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the +2353 MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations +2354 and ETSI specification: + +- 2355 - Q.721-725 - Telephone User Part (TUP); +- 2356 - ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part +2357 (ISUP) version 2 for the international interface; Part 1: Basic services. + +2358 NOTE 2: This service may also be used by an ISDN exchange for obtaining routing information from the HLR. + +2359 NOTE 3: As a network operator option, the HLR sends *MAP\_PROVIDE\_SUBSCRIBER\_INFORMATION* to the +2360 VLR. For further details on the CAMEL procedures refer to 3GPP TS 23.078 [98]. + +2361 NOTE 4: Services printed in *italics* are optional. + +2362 + +2363 + +**Figure 21.2/1: Message flow for retrieval of routing information (non-optimally routed call)** + +![Sequence diagram showing message flow for retrieval of routing information (optimally routed call) between VMSC, GMSC, HLR, and VLR. The diagram includes 12 numbered messages: 1) I_IAM from VMSC to GMSC; 2) MAP_SEND_ROUTING_INFORMATION_req/ind from GMSC to HLR; 3) MAP_PROVIDE_SUBSCRIBER_INFO_req/ind from HLR to VLR; 4) MAP_PROVIDE_SUBSCRIBER_INFO_rsp/cnf from VLR to HLR; 5) MAP_PROVIDE_ROAMING_NUMBER_req/ind from HLR to VLR; 6) MAP_PROVIDE_ROAMING_NUMBER_rsp/cnf from VLR to HLR; 7) MAP_SEND_ROUTING_INFORMATION_rsp/cnf from HLR to GMSC; 8) I_IAM from GMSC to MSC; 9) MAP_RESTORE_DATA_req/ind from GMSC to HLR; 10) MAP_INSERT_SUBSCRIBER_DATA_req/ind from HLR to VLR; 11) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf from VLR to HLR; 12) MAP_RESTORE_DATA_rsp/cnf from HLR to GMSC.](601fa245dc7f9388c1cc2d2c4ddb4a14_img.jpg) + +``` + +sequenceDiagram + participant VMSC + participant GMSC + participant HLR + participant VLR + participant MSC + + Note left of VMSC: + VMSC->>GMSC: 1) I_IAM (Note 1) + GMSC->>HLR: 2) MAP_SEND_ROUTING_INFORMATION_req/ind + HLR->>VLR: 3) MAP_PROVIDE_SUBSCRIBER_INFO_req/ind (Note 2) + VLR->>HLR: 4) MAP_PROVIDE_SUBSCRIBER_INFO_rsp/cnf (Note 2) + HLR->>VLR: 5) MAP_PROVIDE_ROAMING_NUMBER_req/ind (Note 2) + VLR->>HLR: 6) MAP_PROVIDE_ROAMING_NUMBER_rsp/cnf (Note 2) + HLR->>GMSC: 7) MAP_SEND_ROUTING_INFORMATION_rsp/cnf + GMSC->>MSC: 8) I_IAM (Note 1) + GMSC->>HLR: 9) MAP_RESTORE_DATA_req/ind (Note 3) + HLR->>VLR: 10) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + VLR->>HLR: 11) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + HLR->>GMSC: 12) MAP_RESTORE_DATA_rsp/cnf (Note 3) + +``` + +Sequence diagram showing message flow for retrieval of routing information (optimally routed call) between VMSC, GMSC, HLR, and VLR. The diagram includes 12 numbered messages: 1) I\_IAM from VMSC to GMSC; 2) MAP\_SEND\_ROUTING\_INFORMATION\_req/ind from GMSC to HLR; 3) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req/ind from HLR to VLR; 4) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_rsp/cnf from VLR to HLR; 5) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind from HLR to VLR; 6) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf from VLR to HLR; 7) MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf from HLR to GMSC; 8) I\_IAM from GMSC to MSC; 9) MAP\_RESTORE\_DATA\_req/ind from GMSC to HLR; 10) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind from HLR to VLR; 11) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf from VLR to HLR; 12) MAP\_RESTORE\_DATA\_rsp/cnf from HLR to GMSC. + +2364 + +2365 + +- 2366 1) I\_IAM (Note 1) +- 2367 2) MAP\_SEND\_ROUTING\_INFORMATION\_req/ind +- 2368 3) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req/ind (Note 2) +- 2369 4) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_rsp/cnf (Note 2) +- 2370 5) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind (Note 2) +- 2371 6) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf (Note 2) +- 2372 7) MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf +- 2373 8) I\_IAM (Note 1) +- 2374 9) *MAP\_RESTORE\_DATA\_req/ind (Note 3)* +- 2375 10) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind (Note 3)* +- 2376 11) *MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf (Note 3)* +- 2377 12) *MAP\_RESTORE\_DATA\_rsp/cnf (Note 3)* + +2378 + +2379 NOTE 1: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the + 2380 MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations + 2381 & ETSI specification: + 2382 - Q.721-725 - Telephone User Part (TUP); + 2383 - ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part + 2384 (ISUP) version 2 for the international interface; Part 1: Basic services. + +2385 NOTE 2: For Optimal Routeing phase 1, only one of the information flows for Provide Subscriber Info and Provide + 2386 Roaming Number is used. + +2387 NOTE 3: Services printed in *italics* are optional. + +2388 + +2389 + +**Figure 21.2/2: Message flow for retrieval of routing information (optimally routed call)** + +2390 + +![Sequence diagram showing message flow between gsmSCF, HLR, and VLR. The sequence starts with gsmSCF sending a request to HLR (1). HLR responds (2). gsmSCF sends another request (3). HLR sends a request to VLR (4). VLR responds (5). HLR responds to gsmSCF (6). HLR sends a request to VLR (7). VLR responds (8). HLR sends a request to VLR (9). VLR responds (10).](70711ca94e7e6d64dd173b9bf46f602a_img.jpg) + +``` + +sequenceDiagram + participant gsmSCF + participant HLR + participant VLR + Note right of HLR: 1 + gsmSCF->>HLR: + Note left of gsmSCF: 2 + HLR-->>gsmSCF: + Note right of HLR: 3 + gsmSCF->>HLR: + Note right of HLR: 4 + HLR->>VLR: + Note left of HLR: 5 + VLR-->>HLR: + Note left of gsmSCF: 6 + HLR-->>gsmSCF: + Note left of HLR: 7 + HLR->>VLR: + Note right of HLR: 8 + VLR-->>HLR: + Note left of HLR: 9 + HLR->>VLR: + Note right of HLR: 10 + VLR-->>HLR: + +``` + +Sequence diagram showing message flow between gsmSCF, HLR, and VLR. The sequence starts with gsmSCF sending a request to HLR (1). HLR responds (2). gsmSCF sends another request (3). HLR sends a request to VLR (4). VLR responds (5). HLR responds to gsmSCF (6). HLR sends a request to VLR (7). VLR responds (8). HLR sends a request to VLR (9). VLR responds (10). + +2391 + +- 2392 1) MAP\_SEND\_ROUTING\_INFORMATION\_req/ind +- 2393 2) *MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf* (Note 1) +- 2394 3) *MAP\_SEND\_ROUTING\_INFORMATION\_req/ind* (Note 1) +- 2395 4) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind +- 2396 5) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf +- 2397 6) MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf +- 2398 7) *MAP\_RESTORE\_DATA\_req/ind* (Note 1) +- 2399 8) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind* (Note 1) +- 2400 9) *MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf* (Note 1) +- 2401 10) *MAP\_RESTORE\_DATA\_rsp/cnf* (Note 1) + +2402 + +2403 NOTE 1: Services printed in *italics* are optional. + +2404 + +2405 **Figure 21.2/3: Message flow for retrieval of routing information for a gsmSCF initiated call** + +2406 The following MAP services are used to retrieve routing information: + +- 2407 MAP\_SEND\_ROUTING\_INFORMATION see clause 10.1; +- 2408 MAP\_PROVIDE\_ROAMING\_NUMBER see clause 10.2; +- 2409 MAP\_PROVIDE\_SUBSCRIBER\_INFO see clause 8.11.2; +- 2410 MAP\_RESTORE\_DATA see clause 8.10.3. + +![Sequence diagram for Mobile Terminating Roaming Forwarding. Lifelines: GMSC, old MSC/VLR, new MSC/VLR, HLR. The sequence of messages is: 1) I_IAM from GMSC to old MSC/VLR; 2) MAP_CANCEL_LOCATION_req/ind from old MSC/VLR to HLR; 3) MAP_PROVIDE_ROAMING_NUMBER_req/ind from HLR to new MSC/VLR; 4) MAP_PROVIDE_ROAMING_NUMBER_rsp/cnf from new MSC/VLR to old MSC/VLR; 5) I_IAM from old MSC/VLR to new MSC/VLR.](c51726be9e547fe7702158a6a10a88a8_img.jpg) + +``` + +sequenceDiagram + participant GMSC + participant oldMSC as old MSC/VLR + participant HLR + participant newMSC as new MSC/VLR + Note right of oldMSC: 1 + GMSC->>oldMSC: I_IAM + Note right of oldMSC: 2 + oldMSC->>HLR: MAP_CANCEL_LOCATION_req/ind + Note right of newMSC: 3 + HLR->>newMSC: MAP_PROVIDE_ROAMING_NUMBER_req/ind + Note right of oldMSC: 4 + newMSC->>oldMSC: MAP_PROVIDE_ROAMING_NUMBER_rsp/cnf + Note right of newMSC: 5 + oldMSC->>newMSC: I_IAM + +``` + +Sequence diagram for Mobile Terminating Roaming Forwarding. Lifelines: GMSC, old MSC/VLR, new MSC/VLR, HLR. The sequence of messages is: 1) I\_IAM from GMSC to old MSC/VLR; 2) MAP\_CANCEL\_LOCATION\_req/ind from old MSC/VLR to HLR; 3) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind from HLR to new MSC/VLR; 4) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf from new MSC/VLR to old MSC/VLR; 5) I\_IAM from old MSC/VLR to new MSC/VLR. + +2411 + +2412 + +- 2413 1) I\_IAM +- 2414 2) MAP\_CANCEL\_LOCATION\_req/ind +- 2415 3) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind +- 2416 4) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf +- 2417 5) I\_IAM + +2418 + +2419 + +**Figure 21.2/4: Message flow for Mobile Terminating Roaming Forwarding** + +2420 The following MAP services are used for the Mobile Terminating Roaming Forwarding procedure: + +2421 MAP\_PROVIDE\_ROAMING\_NUMBER see clause 10.2; + +2422 + +## 2423 21.2.2 Procedure in the GMSC + +2424 The MAP process in the GMSC to retrieve routeing information for a mobile terminating call is shown in figure 21.2/6. + +2425 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2426 Receive\_Open\_Cnf see clause 25.1.2; + +2427 Check\_Confirmation see clause 25.2.2. + +2428 Sheet 1: if the MAP\_SEND\_ROUTING\_INFORMATION request included the OR Interrogation parameter, the test + +2429 "OR interrogation?" takes the "Yes" exit; otherwise the test takes the "No" exit. + +## 2430 21.2.9 Process in the gsmSCF + +2431 For the purposes of retrieving routeing information from the HLR, the gsmSCF takes the role of the GMSC and follows + +2432 the process specified in clause 21.2.2. + +## 2433 21.2.4 Procedure in the HLR + +2434 The MAP process in the HLR to retrieve routeing information for a mobile terminating call is shown in figure 21.2/7. + +2435 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2436 Receive\_Open\_Ind see clause 25.1.1; + +2437 Receive\_Open\_Cnf see clause 25.1.2; + +2438     Check\_Confirmation               see clause 25.2.2. + +2439 Sheet 3: if the MAP\_PROVIDE\_ROAMING\_NUMBER request included the OR Interrogation parameter, the test "OR +2440 interrogation?" takes the "Yes" exit; otherwise the test takes the "No" exit. + +## 2441 **21.2.5   Procedure in the VLR to provide a roaming number** + +2442 The MAP process in the VLR to provide a roaming number for a mobile terminating call is shown in figure 21.2/8. The +2443 MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +2444     Receive\_Open\_Ind   see clause 25.1.1; + +## 2445 **21.2.6   Procedure in the VLR to restore subscriber data** + +2446 The MAP process in the HLR to restore subscriber data is shown in figure 21.2/9. The MAP process invokes macros +2447 not defined in this clause; the definitions of these macros can be found as follows: + +2448     Receive\_Open\_Cnf see clause 25.1.2; + +2449     Check\_Confirmationsee clause 25.2.2; + +2450     Insert\_Subs\_Data\_VLR see clause 25.7.1; + +2451     Activate\_Tracing\_VLR see clause 25.9.4. + +## 2452 **21.2.7   Procedure in the VLR to provide subscriber information** + +2453 The MAP process in the VLR to provide subscriber information for a mobile terminating call subject to CAMEL +2454 invocation is shown in figure 21.2/9. The MAP process invokes a macro not defined in this clause; the definition of this +2455 macro can be found as follows: + +2456     Receive\_Open\_Ind   see clause 25.1.1; + +## 2457 **21.2.8   Procedure in the old VLR to request a Roaming Number (MTRF)** + +2458 The MAP process in the old VLR for Mobile Terminating Roaming Forwarding is shown in figure 21.2/11. The MAP +2459 process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +2460     Receive\_Open\_Cnf see clause 25.1.2 + +2461     Check\_Confirmationsee clause 25.2.2 + +![Flowchart for process SRI_GMSC. It starts at an initial state, goes to Idle, then Send Routeing Info. A message box lists MAP_OPEN_req, MAP_SEND_ROUTING_INFORMATION_req, and MAP_DELIMITER_req. It then goes to Receive_Open_Cnf. From there, three paths emerge: OK leads to Wait_For_HLR_Response; Vr leads to a decision 'OR interrogation?'; Error leads to Abort. The 'OR interrogation?' decision has Yes and No branches. Yes leads to Set negative response: OR not allowed, then Send Routeing Info negative response, then Idle. No leads to Perform MAP Vr dialogue, then Idle. Wait_For_HLR_Response leads to a message box with MAP_SEND_ROUTING_INFORMATION_cnf, then Check Confirmation. Check Confirmation has OK and error (Provider Error, User Error, Data Error) branches. OK leads to Send Routeing Info ack, then Idle. Error leads to Send Routeing Info negative response, then Idle.](bc70af19359c8df5ba8a1d98926b9477_img.jpg) + +**process SRI\_GMSC** **SRI\_GMSC1(2)** + +Process in the GMSC to retrieve routing information for an MT call + +Signals to/from the left are to/from the application process in the GMSC (see 3GPP TS 23.018); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 --> SendRouteingInfo1[Send Routeing Info] + SendRouteingInfo1 --> Messages1["MAP_OPEN_req +MAP_SEND_ROUTING_INFORMATION_req +MAP_DELIMITER_req"] + Messages1 --> ReceiveOpenCnf[Receive_Open_Cnf] + ReceiveOpenCnf -- OK --> WaitForHLRResponse[Wait_For_HLR_Response] + ReceiveOpenCnf -- Vr --> ORInterrogation{OR interrogation?} + ReceiveOpenCnf -- Error --> Abort{Abort} + Abort --> Idle2([Idle]) + + ORInterrogation -- Yes --> SetNegativeResponse[Set negative response: +OR not allowed] + SetNegativeResponse --> SendRouteingInfoNeg[Send Routeing Info negative response] + SendRouteingInfoNeg --> Idle3([Idle]) + + ORInterrogation -- No --> PerformMAPVr[Perform MAP Vr dialogue] + PerformMAPVr --> Idle4([Idle]) + + WaitForHLRResponse --> Messages2["MAP_SEND_ROUTING_INFORMATION_cnf"] + Messages2 --> CheckConfirmation[Check Confirmation] + + CheckConfirmation -- OK --> SendRouteingInfoAck[Send Routeing Info ack] + SendRouteingInfoAck --> Idle5([Idle]) + + CheckConfirmation -- "Provider Error, +User Error, +Data Error" --> SendRouteingInfoNeg2[Send Routeing Info negative response] + SendRouteingInfoNeg2 --> Idle6([Idle]) + +``` + +Flowchart for process SRI\_GMSC. It starts at an initial state, goes to Idle, then Send Routeing Info. A message box lists MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFORMATION\_req, and MAP\_DELIMITER\_req. It then goes to Receive\_Open\_Cnf. From there, three paths emerge: OK leads to Wait\_For\_HLR\_Response; Vr leads to a decision 'OR interrogation?'; Error leads to Abort. The 'OR interrogation?' decision has Yes and No branches. Yes leads to Set negative response: OR not allowed, then Send Routeing Info negative response, then Idle. No leads to Perform MAP Vr dialogue, then Idle. Wait\_For\_HLR\_Response leads to a message box with MAP\_SEND\_ROUTING\_INFORMATION\_cnf, then Check Confirmation. Check Confirmation has OK and error (Provider Error, User Error, Data Error) branches. OK leads to Send Routeing Info ack, then Idle. Error leads to Send Routeing Info negative response, then Idle. + +2462 + +2463 + +Figure 21.2/6 (sheet 1 of 2): Process SRI\_GMSC + +![State transition diagram for process SRI_GMSC. It starts at 'Wait_For_HLR_Response'. Transitions include: 1) 'Abort' to 'Idle' (left side); 2) internal transitions for 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind'; 3) 'MAP_NOTICE_ind' to 'MAP_CLOSE_req' (right side); 4) 'Set negative response: System Failure' to 'Send Routeing Info negative response' to 'Idle' (bottom).](0eae447995c0dcb49ce6b55795609787_img.jpg) + +**process SRI\_GMSC** **SRI\_GMSC2(2)** + +Process in the GMSC to retrieve routeing information for an MT call + +Signals to/from the left are to/from the application process in the GMSC (see 3GPP TS 23.018); signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_HLR_Response + state "Abort" as Abort + state "Idle" as Idle + state "Set negative response: System Failure" as Set_Negative_Response + state "Send Routeing Info negative response" as Send_Negative_Response + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + + Abort --> Idle + Wait_For_HLR_Response --> Abort + Wait_For_HLR_Response --> Set_Negative_Response + Wait_For_HLR_Response --> MAP_NOTICE_ind + Set_Negative_Response --> Send_Negative_Response + Send_Negative_Response --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_Negative_Response + +``` + +MAP\_U\_ABORT\_ind, + MAP\_P\_ABORT\_ind, + MAP\_CLOSE\_ind + +State transition diagram for process SRI\_GMSC. It starts at 'Wait\_For\_HLR\_Response'. Transitions include: 1) 'Abort' to 'Idle' (left side); 2) internal transitions for 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind'; 3) 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req' (right side); 4) 'Set negative response: System Failure' to 'Send Routeing Info negative response' to 'Idle' (bottom). + +2464 + +2465 + +**Figure 21.2/6 (sheet 2 of 2): Process SRI\_GMSC** + +![State transition diagram for process SRI_HLR. It starts at Idle, receives an Open_Ind, and branches based on OK, Error, or Vr signals. The main path involves waiting for service indication, sending routing information, and handling responses from the call handling application process.](6a6350d02cfabf076cabe037aba19f9a_img.jpg) + +**process SRI\_HLR** **SRI\_HLR1(3)** + +Process in the HLR to handle a request for routing information for an MT call + +Signals to/from the left are to/from the GMSC; signals to/from the right are to/from the VLR unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Idle : Error + Receive_Open_Ind --> Perform_MAP_Vr_dialogue : Vr + Perform_MAP_Vr_dialogue --> Idle + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_SEND_ROUTING_INFORMATION_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_SEND_ROUTING_INFORMATION_ind --> Send_Routing_Info + Send_Routing_Info --> To_HLR_call_handling_application_process + Send_Routing_Info --> Wait_For_Call_Handling_Response + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + Wait_For_Call_Handling_Response --> Send_Routing_Info_ack + Wait_For_Call_Handling_Response --> Send_Routing_Info_negative_response + Send_Routing_Info_ack --> From_HLR_call_handling_application_process + Send_Routing_Info_ack --> Set_result + Send_Routing_Info_negative_response --> From_HLR_call_handling_application_process + Send_Routing_Info_negative_response --> Set_error + Set_result --> MAP_SEND_ROUTING_INFORMATION_rsp + Set_error --> MAP_SEND_ROUTING_INFORMATION_rsp + MAP_SEND_ROUTING_INFORMATION_rsp --> MAP_CLOSE_req + MAP_SEND_ROUTING_INFORMATION_rsp --> Idle + +``` + +State transition diagram for process SRI\_HLR. It starts at Idle, receives an Open\_Ind, and branches based on OK, Error, or Vr signals. The main path involves waiting for service indication, sending routing information, and handling responses from the call handling application process. + +2466 + +2467 + +Figure 21.2/7 (sheet 1 of 3): Process SRI\_HLR + +![State transition diagram for process SRI_HLR. The diagram shows various states (Wait_For_Call_Handling_Response, Receive_Open_Cnf, Wait_For_PSI_Response, Check_Confirmation) and transitions (Provide Subscriber Info, MAP_PROVIDE_SUBSCRIBER_INFO_req, MAP_U_ABORT_ind, etc.) with associated logic and external process interactions.](6ffd01f84f590b96da66e2713c6df286_img.jpg) + +**process SRI\_HLR** **SRI\_HLR2(3)** + +Process in the HLR to handle a request for routing information for an MT call + +Signals to/from the left are to/from the GMSC; signals to/from the right are to/from the VLR unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Wait_For_Call_Handling_Response + state "Wait_For_Call_Handling_Response" as Wait_For_Call_Handling_Response + state "Receive_Open_Cnf" as Receive_Open_Cnf + state "Wait_For_PSI_Response" as Wait_For_PSI_Response + state "Check_Confirmation" as Check_Confirmation + state "Set negative response: System failure" as Set_negative_response_System_failure + state "Set negative response: System Failure" as Set_negative_response_System_Failure + + Wait_For_Call_Handling_Response --> Provide_Subscriber_Info + Provide_Subscriber_Info --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_PSI_Response : OK + Receive_Open_Cnf --> Set_negative_response_System_failure : Vr, Error + Set_negative_response_System_failure --> Provide_Subscriber_Info_negative_response + Provide_Subscriber_Info_negative_response --> To_HLR_call_handling_application_process + Provide_Subscriber_Info_negative_response --> Wait_For_Call_Handling_Response + + Wait_For_PSI_Response --> MAP_PROVIDE_SUBSCRIBER_INFO_cnf + Wait_For_PSI_Response --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + Wait_For_PSI_Response --> MAP_NOTICE_ind + Wait_For_PSI_Response --> MAP_CLOSE_req + + MAP_PROVIDE_SUBSCRIBER_INFO_cnf --> Check_Confirmation + Check_Confirmation --> Provide_Subscriber_Info_ack : OK + Check_Confirmation --> Provide_Subscriber_Info_negative_response : Provider Error, User Error, Data Error + Provide_Subscriber_Info_ack --> To_HLR_call_handling_application_process + Provide_Subscriber_Info_ack --> Wait_For_Call_Handling_Response + Provide_Subscriber_Info_negative_response --> To_HLR_call_handling_application_process + Provide_Subscriber_Info_negative_response --> Wait_For_Call_Handling_Response + + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> Set_negative_response_System_Failure + Set_negative_response_System_Failure --> Provide_Subscriber_Info_negative_response + Provide_Subscriber_Info_negative_response --> To_HLR_call_handling_application_process + Provide_Subscriber_Info_negative_response --> Wait_For_Call_Handling_Response + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_negative_response_System_Failure + Set_negative_response_System_Failure --> Provide_Subscriber_Info_negative_response + Provide_Subscriber_Info_negative_response --> To_HLR_call_handling_application_process + Provide_Subscriber_Info_negative_response --> Wait_For_Call_Handling_Response + +``` + +State transition diagram for process SRI\_HLR. The diagram shows various states (Wait\_For\_Call\_Handling\_Response, Receive\_Open\_Cnf, Wait\_For\_PSI\_Response, Check\_Confirmation) and transitions (Provide Subscriber Info, MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req, MAP\_U\_ABORT\_ind, etc.) with associated logic and external process interactions. + +2468 + +2469 + +Figure 21.2/7 (sheet 2 of 3): Process SRI\_HLR + +![Flowchart for process SRI_HLR. The process starts with 'Wait_For_Call_Handling_Response', followed by 'Provide Roaming Number' (to HLR call handling application process). It then enters a loop: 'MAP_OPEN_req / MAP_PROVIDE_ROAMING_NUMBER_req / MAP_DELIMITER_req' -> 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', three paths emerge: 'Error' -> 'Set negative response: System failure' -> 'Provide Roaming Number negative response' (to HLR call handling application process) -> 'Wait_For_Call_Handling_Response'; 'OK' -> 'Wait_For_PRN_Response'; 'Vr' -> 'OR interrogation?'. If 'Yes', it goes to 'Set negative response: OR not allowed' -> 'Provide Roaming Number negative response' (to HLR call handling application process) -> 'Wait_For_Call_Handling_Response'. If 'No', it goes to 'Perform MAP Vr dialogue' -> 'MAP Vr dialogue result' (to HLR call handling application process) -> 'Wait_For_Call_Handling_Response'. Below 'Wait_For_PRN_Response', there are three parallel inputs: 'MAP_PROVIDE_ROAMING_NUMBER_cnf' -> 'Check_Confirmation' -> 'OK' (to 'Provide Roaming Number ack' -> to HLR call handling application process) or 'Provider Error, User Error, Data Error' (to 'Provide Roaming Number negative response' -> to HLR call handling application process); a group of 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' -> 'Set negative response: System Failure' -> 'Provide Roaming Number negative response' (to HLR call handling application process); and 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req'. All three paths lead to 'Wait_For_Call_Handling_Response'.](b926b978b58fbca2dc80f670f4b52736_img.jpg) + +**process SRI\_HLR** **SRI\_HLR3(3)** + +Process in the HLR to handle a request for routing information for an MT call + +Signals to/from the left are to/from the GMSC; signals to/from the right are to/from the VLR unless marked otherwise + +``` + +graph TD + Start([Wait_For_Call_Handling_Response]) --> ProvideRN[Provide Roaming Number] + ProvideRN -.-> ToHLR1[To HLR call handling application process] + ProvideRN --> MAP_OPEN{MAP_OPEN_req +MAP_PROVIDE_ROAMING_NUMBER_req +MAP_DELIMITER_req} + MAP_OPEN --> ReceiveOCnf[Receive_Open_Cnf] + ReceiveOCnf -- Error --> SetNegSys[Set negative response: +System failure] + SetNegSys --> ProvideRNNeg[Provide Roaming Number negative response] + ProvideRNNeg -.-> ToHLR2[To HLR call handling application process] + ProvideRNNeg --> WaitFCH2([Wait_For_Call_Handling_Response]) + ReceiveOCnf -- OK --> WaitFPRN[Wait_For_PRN_Response] + ReceiveOCnf -- Vr --> ORInt{OR interrogation?} + ORInt -- Yes --> SetNegOR[Set negative response: +OR not allowed] + SetNegOR --> ProvideRNNeg2[Provide Roaming Number negative response] + ProvideRNNeg2 -.-> ToHLR3[To HLR call handling application process] + ProvideRNNeg2 --> WaitFCH3([Wait_For_Call_Handling_Response]) + ORInt -- No --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> MAPVrResult{MAP Vr dialogue result} + MAPVrResult -.-> ToHLR4[To HLR call handling application process] + MAPVrResult --> WaitFCH4([Wait_For_Call_Handling_Response]) + WaitFPRN --> MAP_PROVIDE_ROAMING_NUMBER_cnf{MAP_PROVIDE_ROAMING_NUMBER_cnf} + MAP_PROVIDE_ROAMING_NUMBER_cnf --> CheckConf[Check_Confirmation] + CheckConf -- OK --> ProvideRNack[Provide Roaming Number ack] + ProvideRNack -.-> ToHLR5[To HLR call handling application process] + CheckConf -- "Provider Error, +User Error, +Data Error" --> ProvideRNNeg3[Provide Roaming Number negative response] + ProvideRNNeg3 -.-> ToHLR6[To HLR call handling application process] + ProvideRNNeg3 --> WaitFCH5([Wait_For_Call_Handling_Response]) + MAP_U_ABORT_ind[MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind] --> SetNegSysFail[Set negative response: +System Failure] + SetNegSysFail --> ProvideRNNeg4[Provide Roaming Number negative response] + ProvideRNNeg4 -.-> ToHLR7[To HLR call handling application process] + ProvideRNNeg4 --> WaitFCH5 + MAP_NOTICE_ind[MAP_NOTICE_ind] --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_CLOSE_req --> WaitFCH5 + +``` + +Flowchart for process SRI\_HLR. The process starts with 'Wait\_For\_Call\_Handling\_Response', followed by 'Provide Roaming Number' (to HLR call handling application process). It then enters a loop: 'MAP\_OPEN\_req / MAP\_PROVIDE\_ROAMING\_NUMBER\_req / MAP\_DELIMITER\_req' -> 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', three paths emerge: 'Error' -> 'Set negative response: System failure' -> 'Provide Roaming Number negative response' (to HLR call handling application process) -> 'Wait\_For\_Call\_Handling\_Response'; 'OK' -> 'Wait\_For\_PRN\_Response'; 'Vr' -> 'OR interrogation?'. If 'Yes', it goes to 'Set negative response: OR not allowed' -> 'Provide Roaming Number negative response' (to HLR call handling application process) -> 'Wait\_For\_Call\_Handling\_Response'. If 'No', it goes to 'Perform MAP Vr dialogue' -> 'MAP Vr dialogue result' (to HLR call handling application process) -> 'Wait\_For\_Call\_Handling\_Response'. Below 'Wait\_For\_PRN\_Response', there are three parallel inputs: 'MAP\_PROVIDE\_ROAMING\_NUMBER\_cnf' -> 'Check\_Confirmation' -> 'OK' (to 'Provide Roaming Number ack' -> to HLR call handling application process) or 'Provider Error, User Error, Data Error' (to 'Provide Roaming Number negative response' -> to HLR call handling application process); a group of 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Set negative response: System Failure' -> 'Provide Roaming Number negative response' (to HLR call handling application process); and 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req'. All three paths lead to 'Wait\_For\_Call\_Handling\_Response'. + +2470 + +2471 + +Figure 21.2/7 (sheet 3 of 3): Process SRI\_HLR + +![State transition diagram for process PRN_VLR. It starts at an initial state, goes to Idle, then receives an Open_Ind. From there, it branches based on the response: OK leads to Wait_For_Service_Indication, which then leads to a decision point for MAP_P_ABORT_ind, MAP_PROVIDE_ROAMING_NUMBER_ind, or MAP_NOTICE_ind. MAP_P_ABORT_ind leads to Idle. MAP_PROVIDE_ROAMING_NUMBER_ind leads to Provide Roaming Number, then Wait_For_Roaming_Number, then a decision point for Provide Roaming Number ack or negative response, leading to Set result or Set error, then a response state, and finally Idle. MAP_NOTICE_ind leads to MAP_CLOSE_req, then Idle. A 'Vr' signal from the left leads to Perform MAP Vr dialogue, then Idle. An 'Error' signal from the right leads to Idle.](5663991a761141b2ebb40327ca5231de_img.jpg) + +**process PRN\_VLR** **PRN\_VLR1(1)** + +Process in the VLR to handle a request for a roaming number + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the application process in the VLR (see 3GPP TS 23.018) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Idle : Error + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Receive_Open_Ind --> Perform_MAP_Vr_dialogue : Vr + Perform_MAP_Vr_dialogue --> Idle + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_PROVIDE_ROAMING_NUMBER_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_PROVIDE_ROAMING_NUMBER_ind --> Provide_Roaming_Number[Provide Roaming Number] + Provide_Roaming_Number --> Wait_For_Roaming_Number + Wait_For_Roaming_Number --> Provide_Roaming_Number_ack[Provide Roaming Number ack] + Wait_For_Roaming_Number --> Provide_Roaming_Number_neg_response[Provide Roaming Number negative response] + Provide_Roaming_Number_ack --> Set_result[Set result] + Provide_Roaming_Number_neg_response --> Set_error[Set error] + Set_result --> MAP_PROVIDE_ROAMING_NUMBER_rsp[MAP_PROVIDE_ROAMING_NUMBER_rsp / MAP_CLOSE_req] + Set_error --> MAP_PROVIDE_ROAMING_NUMBER_rsp + MAP_PROVIDE_ROAMING_NUMBER_rsp --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process PRN\_VLR. It starts at an initial state, goes to Idle, then receives an Open\_Ind. From there, it branches based on the response: OK leads to Wait\_For\_Service\_Indication, which then leads to a decision point for MAP\_P\_ABORT\_ind, MAP\_PROVIDE\_ROAMING\_NUMBER\_ind, or MAP\_NOTICE\_ind. MAP\_P\_ABORT\_ind leads to Idle. MAP\_PROVIDE\_ROAMING\_NUMBER\_ind leads to Provide Roaming Number, then Wait\_For\_Roaming\_Number, then a decision point for Provide Roaming Number ack or negative response, leading to Set result or Set error, then a response state, and finally Idle. MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, then Idle. A 'Vr' signal from the left leads to Perform MAP Vr dialogue, then Idle. An 'Error' signal from the right leads to Idle. + +2472 + +2473 + +Figure 21.2/8: Process PRN\_VLR + +![State transition diagram for process Restore_Data_VLR. The process starts at Idle, receives a Restore Data request, sends MAP_OPEN_req, MAP_RESTORE_DATA_req, and MAP_DELIMITER_req, then receives an Open_Cnf. If OK, it waits for an HLR Response. If Vr, it performs a MAP Vr dialogue and returns to Idle. If Error, it sends a Restore Data negative response and returns to Idle. Upon receiving an HLR Response, it inserts subscriber data, activates tracing, and sends a MAP_RESTORE_DATA_cnf. It then checks the confirmation. If OK, it sends a Restore Data ack and returns to Idle. If User Error, Provider Error, or Data Error, it sends a Restore Data negative response and returns to Idle. If the HLR Response contains MAP_U_ABORT_ind, MAP_P_ABORT_ind, or MAP_CLOSE_ind, it sends a MAP_NOTICE_ind and a MAP_CLOSE_req, then sends a Restore Data negative response and returns to Idle.](5f07e508bcb460244d3958773a51de14_img.jpg) + +**process Restore\_Data\_VLR** **RD\_VLR1(1)** + +Process in the VLR to request restoration of subscriber data + +Signals to/from the left are to/from the HLR; + signals to/from the right are to/from the application process in the VLR + (see 3GPP TS 23.018) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Restore_Data + Restore_Data --> Open_Req + Open_Req --> Receive_Open_Cnf + Receive_Open_Cnf --> Vr + Receive_Open_Cnf --> OK + Receive_Open_Cnf --> Error + Vr --> Perform_MAP_Vr_dialogue + Perform_MAP_Vr_dialogue --> Idle + OK --> Wait_For_HLR_Response + Error --> Restore_Data_negative_response + Restore_Data_negative_response --> Idle + Wait_For_HLR_Response --> Insert_Subsc_Data_VLR + Wait_For_HLR_Response --> Activate_Tracing_VLR + Wait_For_HLR_Response --> MAP_RESTORE_DATA_cnf + Insert_Subsc_Data_VLR --> Wait_For_HLR_Response + Activate_Tracing_VLR --> Wait_For_HLR_Response + MAP_RESTORE_DATA_cnf --> Check_Confirmation + Check_Confirmation --> OK + Check_Confirmation --> User_Error_Provider_Error_Data_Error + OK --> Restore_Data_ack + Restore_Data_ack --> Idle + User_Error_Provider_Error_Data_Error --> Restore_Data_negative_response + Restore_Data_negative_response --> Idle + Wait_For_HLR_Response --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Restore_Data_negative_response + Restore_Data_negative_response --> Idle + +``` + +State transition diagram for process Restore\_Data\_VLR. The process starts at Idle, receives a Restore Data request, sends MAP\_OPEN\_req, MAP\_RESTORE\_DATA\_req, and MAP\_DELIMITER\_req, then receives an Open\_Cnf. If OK, it waits for an HLR Response. If Vr, it performs a MAP Vr dialogue and returns to Idle. If Error, it sends a Restore Data negative response and returns to Idle. Upon receiving an HLR Response, it inserts subscriber data, activates tracing, and sends a MAP\_RESTORE\_DATA\_cnf. It then checks the confirmation. If OK, it sends a Restore Data ack and returns to Idle. If User Error, Provider Error, or Data Error, it sends a Restore Data negative response and returns to Idle. If the HLR Response contains MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, or MAP\_CLOSE\_ind, it sends a MAP\_NOTICE\_ind and a MAP\_CLOSE\_req, then sends a Restore Data negative response and returns to Idle. + +2474 + +2475 + +Figure 21.2/9: Process Restore\_Data\_VLR + +![State transition diagram for process PSI_VLR. The diagram shows states (Idle, Wait_For_Service_Indication, Wait_For_Subscriber_Info) and transitions (Receive_Open_Ind, MAP_P_ABORT_ind, MAP_PROVIDE_SUBSCRIBER_INFO_ind, MAP_NOTICE_ind, MAP_CLOSE_req, Provide Subscriber Info, Provide Subscriber Info ack, Provide Subscriber Info negative response, Set result, Set error, MAP_PROVIDE_SUBSCRIBER_INFO_rsp, MAP_CLOSE_req). Transitions are labeled with 'OK' or 'Vr, Error'.](778677a2608531f07304d9a602c42c20_img.jpg) + +**process PSI\_VLR** **PSI\_VLR1(1)** + +Process in the VLR to handle a request for subscriber information + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the application process in the VLR (see 3GPP TS 23.018) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Idle : Vr, Error + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_PROVIDE_SUBSCRIBER_INFO_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_PROVIDE_SUBSCRIBER_INFO_ind --> Provide Subscriber Info + Provide Subscriber Info --> Wait_For_Subscriber_Info + Wait_For_Subscriber_Info --> Provide Subscriber Info ack + Wait_For_Subscriber_Info --> Provide Subscriber Info negative response + Provide Subscriber Info ack --> Set result + Provide Subscriber Info negative response --> Set error + Set result --> MAP_PROVIDE_SUBSCRIBER_INFO_rsp + Set error --> MAP_PROVIDE_SUBSCRIBER_INFO_rsp + MAP_PROVIDE_SUBSCRIBER_INFO_rsp --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process PSI\_VLR. The diagram shows states (Idle, Wait\_For\_Service\_Indication, Wait\_For\_Subscriber\_Info) and transitions (Receive\_Open\_Ind, MAP\_P\_ABORT\_ind, MAP\_PROVIDE\_SUBSCRIBER\_INFO\_ind, MAP\_NOTICE\_ind, MAP\_CLOSE\_req, Provide Subscriber Info, Provide Subscriber Info ack, Provide Subscriber Info negative response, Set result, Set error, MAP\_PROVIDE\_SUBSCRIBER\_INFO\_rsp, MAP\_CLOSE\_req). Transitions are labeled with 'OK' or 'Vr, Error'. + +2476 + +2477 + +Figure 21.2/10: Process PSI\_VLR + +![A flowchart diagram titled 'Process PRN_Old_VLR' with a large black redaction box in the center. The visible parts show various process steps represented by rectangles, ovals, and arrows, connected by lines. The top part shows a sequence of three shapes (oval, chevron, rectangle) with a document icon to the left. The bottom part shows a more complex flow with multiple arrows and shapes, including a central oval at the bottom.](eb8b7df8a0c294b217f369f3ab60d0b5_img.jpg) + +A flowchart diagram titled 'Process PRN\_Old\_VLR' with a large black redaction box in the center. The visible parts show various process steps represented by rectangles, ovals, and arrows, connected by lines. The top part shows a sequence of three shapes (oval, chevron, rectangle) with a document icon to the left. The bottom part shows a more complex flow with multiple arrows and shapes, including a central oval at the bottom. + +2478 + +2479 + +**Figure 21.2/11: Process PRN\_Old\_VLR** + +## 2480 21.3 Transfer of call handling + +### 2481 21.3.1 General + +2482 The message flow for successful transfer of call handling to forward a call is shown in figure 21.3/1. + +![Sequence diagram showing the message flow for transfer of call handling between GMSC, HLR, VMSC, and Forwarded-To Local Exchange.](2aff3776e7865ab7d7e769d44ba12442_img.jpg) + +``` +sequenceDiagram + participant GMSC + participant HLR + participant VMSC + participant FLE as Forwarded-To Local Exchange + + Note left of GMSC: 1 + GMSC->>HLR: 2 + Note right of HLR: 3 + HLR->>GMSC: + Note right of VMSC: 4 + VMSC->>HLR: + Note right of VMSC: 5 + VMSC->>FLE: + Note right of FLE: 6 +``` + +The diagram is a sequence diagram with four lifelines: GMSC, HLR, VMSC, and Forwarded-To Local Exchange. The sequence of messages is as follows: 1. A message is sent from the GMSC to the HLR. 2. The HLR sends a response to the GMSC. 3. The GMSC then sends a message to the VMSC. 4. The VMSC sends a response to the HLR. 5. The HLR sends another response to the VMSC. 6. Finally, the VMSC sends a message to the Forwarded-To Local Exchange. + +Sequence diagram showing the message flow for transfer of call handling between GMSC, HLR, VMSC, and Forwarded-To Local Exchange. + +2483 + +2484 + +- 2485 1) *MAP\_RESUME\_CALL\_HANDLING\_req/ind* +- 2486 2) *MAP\_SEND\_ROUTING\_INFORMATION\_req/ind* (Note 2) +- 2487 3) *MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf* (Note 2) +- 2488 4) *MAP\_RESUME\_CALL\_HANDLING\_rsp/cnf* +- 2489 5) I\_REL (Note 1) +- 2490 6) I\_IAM (Note 1) + +2491 + +2492 NOTE 1: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the +2493 MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations +2494 & ETSI specification: +2495 - Q.721-725 - Telephone User Part (TUP); +2496 - ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part +2497 (ISUP) version 2 for the international interface; Part 1: Basic services. + +2498 + +NOTE 2: Services printed in *italics* are optional. + +2499 + +2500 + +**Figure 21.3/1: Message flow for transfer of call handling** + +2501 If the HLR indicated in the response to the original request for routeing information that forwarding interrogation is +2502 required, the GMSC executes the Send Routeing Information procedure with the HLR to obtain forwarding +2503 information; otherwise the GMSC uses the forwarding data which were sent in the +2504 *MAP\_RESUME\_CALL\_HANDLING\_req/ind*. + +### 2505 21.3.2 Process in the VMSC + +2506 The MAP process in the VMSC to retrieve routeing information for a mobile terminating call is shown in figure 21.3/2. +2507 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2508 *Receive\_Open\_Cnf* see clause 25.1.2; + +2509 *Check\_Confirmation* see clause 25.2.2. + +2510 If the capacity of a message signal unit in the lower layers of the protocol is enough to carry all the information which +2511 has to be sent to the GMSC, the test "Segmentation needed?" takes the "No" exit; otherwise the test takes the "Yes" exit. + +### 2512 21.3.3 Process in the GMSC + +2513 The MAP process in the GMSC to handle a request for the GMSC to resume call handling is shown in figure 21.3/3. + +2514 The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +2515       Receive\_Open\_Ind see clause 25.1.1; + +2516 If the parameter All Information Sent was present in the MAP\_RESUME\_CALL\_HANDLING indication, the test "All + +2517 Information Sent" takes the "Yes" exit; otherwise the test takes the "No" exit. + +![State transition diagram for process RCH_VMSC. It starts at 'Idle', goes to 'Resume Call Handling', then checks 'Segmentation needed?'. If 'Yes', it goes to connector '1'. If 'No', it sets 'All Information Sent' and sends 'MAP_RESUME_CALL_HANDLING_req' and 'MAP_DELIMITER_req' to the left. It then enters 'Wait_For_GMSC_Response'. From there, it can receive 'MAP_RESUME_CALL_HANDLING_cnf' (leading to 'Check_Confirmation'), 'MAP_NOTICE_ind', or 'MAP_P_ABORT_ind'/'MAP_CLOSE_ind'. 'Check_Confirmation' leads to 'All information sent?' decision. If 'Yes', it goes to connector '1'. If 'No', it sends 'Resume Call Handling ack' to the right and returns to 'Idle'. 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req'. 'MAP_P_ABORT_ind'/'MAP_CLOSE_ind' leads to 'Idle'. 'MAP_CLOSE_req' leads to 'Set negative response: System failure', which sends 'Resume Call Handling negative response' to the right and returns to 'Idle'. 'Set negative response: System failure' also handles 'Provider Error, User Error, Data Error' by sending 'Resume Call Handling negative response' to the right and returning to 'Idle'. A 'Vr, Error' from 'Wait_For_GMSC_Response' leads to 'Resume Call Handling negative response' and then to 'Idle'.](570f62943c32a8ad78a7898137afd9ac_img.jpg) + +**process RCH\_VMSC** **RCH\_VMSC1(1)** + +Process in the VMSC to request the GMSC to resume call handling + +Signals to/from the left are to/from the GMSC; signals to/from the right are to/from the application process in the VMSC (see 3GPP TS 23.079) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> ResumeCallHandling: Resume Call Handling + ResumeCallHandling --> SegmentationNeeded1{Segmentation needed?} + SegmentationNeeded1 --> 1: Yes + SegmentationNeeded1 --> AllInformationSent1[Set: All Information Sent] + AllInformationSent1 --> MAP_RESUME_CALL_HANDLING_req[MAP_RESUME_CALL_HANDLING_req +MAP_DELIMITER_req] + MAP_RESUME_CALL_HANDLING_req --> Wait_For_GMSC_Response1[Wait_For_GMSC_Response] + Wait_For_GMSC_Response1 --> MAP_RESUME_CALL_HANDLING_cnf[MAP_RESUME_CALL_HANDLING_cnf] + Wait_For_GMSC_Response1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_GMSC_Response1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind, MAP_CLOSE_ind] + Wait_For_GMSC_Response1 --> Vr_Error[Resume Call Handling negative response]: Vr, Error + MAP_P_ABORT_ind --> Idle + MAP_RESUME_CALL_HANDLING_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> AllInformationSent2{All information sent?} + AllInformationSent2 --> 1: Yes + AllInformationSent2 --> No1: No + No1 --> ResumeCallHandling_ack[Resume Call Handling ack] + ResumeCallHandling_ack --> Idle + No1 --> ResumeCallHandling_neg_resp1[Resume Call Handling negative response] + ResumeCallHandling_neg_resp1 --> Idle + No1 --> SetNegResponse[System failure] + SetNegResponse --> ResumeCallHandling_neg_resp2[Resume Call Handling negative response] + ResumeCallHandling_neg_resp2 --> Idle + SetNegResponse --> ProviderError[Provider Error, User Error, Data Error] + ProviderError --> ResumeCallHandling_neg_resp3[Resume Call Handling negative response] + ResumeCallHandling_neg_resp3 --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> SetNegResponse + +``` + +State transition diagram for process RCH\_VMSC. It starts at 'Idle', goes to 'Resume Call Handling', then checks 'Segmentation needed?'. If 'Yes', it goes to connector '1'. If 'No', it sets 'All Information Sent' and sends 'MAP\_RESUME\_CALL\_HANDLING\_req' and 'MAP\_DELIMITER\_req' to the left. It then enters 'Wait\_For\_GMSC\_Response'. From there, it can receive 'MAP\_RESUME\_CALL\_HANDLING\_cnf' (leading to 'Check\_Confirmation'), 'MAP\_NOTICE\_ind', or 'MAP\_P\_ABORT\_ind'/'MAP\_CLOSE\_ind'. 'Check\_Confirmation' leads to 'All information sent?' decision. If 'Yes', it goes to connector '1'. If 'No', it sends 'Resume Call Handling ack' to the right and returns to 'Idle'. 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req'. 'MAP\_P\_ABORT\_ind'/'MAP\_CLOSE\_ind' leads to 'Idle'. 'MAP\_CLOSE\_req' leads to 'Set negative response: System failure', which sends 'Resume Call Handling negative response' to the right and returns to 'Idle'. 'Set negative response: System failure' also handles 'Provider Error, User Error, Data Error' by sending 'Resume Call Handling negative response' to the right and returning to 'Idle'. A 'Vr, Error' from 'Wait\_For\_GMSC\_Response' leads to 'Resume Call Handling negative response' and then to 'Idle'. + +2518 + +2519 + +Figure 21.3/2: Process RCH\_VMSC + +![State transition diagram for process RCH_GMSC. The process starts at an initial state, goes to Idle, then receives an Open_ind. From Open_ind, an OK response leads to Wait_For_Service_Indication, while a Vr, Error response leads to Idle. From Wait_For_Service_Indication, three paths are possible: MAP_P_ABORT_ind leads to Idle; MAP_RESUME_CALL_HANDLING_ind leads to a decision 'All Information Sent?'; MAP_NOTICE_ind leads to MAP_CLOSE_req and then Idle. If 'All Information Sent?' is No, it goes to Store received data, then to a state that sends MAP_RESUME_CALL_HANDLING_rsp and MAP_DELIMITER_req, then to Wait_For_Service_Indication. If 'All Information Sent?' is Yes, it goes to Assemble received data, then to Resume Call Handling, then to Wait_For_Call_Handling_Response. From Wait_For_Call_Handling_Response, two paths are possible: Resume Call Handling ack leads to Set Result; Resume Call Handling negative response leads to Set Error. Both Set Result and Set Error lead to a state that sends MAP_RESUME_CALL_HANDLING_rsp and MAP_CLOSE_req, then to Idle.](d0b7cc026701eaf4a8334cdaebd0bd6f_img.jpg) + +**process RCH\_GMSC** **RCH\_GMSC1(1)** + +Process in the GMSC to handle a request to resume call handling + +Signals to/from the left are to/from the application process in the GMSC (see 3GPP TS 23.079); signals to/from the right are to/from the VMSC; + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_ind + Receive_Open_ind --> Wait_For_Service_Indication: OK + Receive_Open_ind --> Idle: Vr, Error + Wait_For_Service_Indication --> Idle: MAP_P_ABORT_ind + Wait_For_Service_Indication --> All_Information_Sent: MAP_RESUME_CALL_HANDLING_ind + Wait_For_Service_Indication --> Idle: MAP_NOTICE_ind + All_Information_Sent --> Idle: MAP_CLOSE_req + All_Information_Sent --> Assemble_received_data: Yes + All_Information_Sent --> Store_received_data: No + Assemble_received_data --> Resume_Call_Handling + Store_received_data --> MAP_DELIMITER_req_state: MAP_RESUME_CALL_HANDLING_rsp + MAP_DELIMITER_req_state --> Wait_For_Service_Indication + Resume_Call_Handling --> Wait_For_Call_Handling_Response + Wait_For_Call_Handling_Response --> Set_Result: Resume Call Handling ack + Wait_For_Call_Handling_Response --> Set_Error: Resume Call Handling negative response + Set_Result --> MAP_CLOSE_req_state: MAP_RESUME_CALL_HANDLING_rsp + Set_Error --> MAP_CLOSE_req_state: MAP_CLOSE_req + MAP_CLOSE_req_state --> Idle + +``` + +State transition diagram for process RCH\_GMSC. The process starts at an initial state, goes to Idle, then receives an Open\_ind. From Open\_ind, an OK response leads to Wait\_For\_Service\_Indication, while a Vr, Error response leads to Idle. From Wait\_For\_Service\_Indication, three paths are possible: MAP\_P\_ABORT\_ind leads to Idle; MAP\_RESUME\_CALL\_HANDLING\_ind leads to a decision 'All Information Sent?'; MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req and then Idle. If 'All Information Sent?' is No, it goes to Store received data, then to a state that sends MAP\_RESUME\_CALL\_HANDLING\_rsp and MAP\_DELIMITER\_req, then to Wait\_For\_Service\_Indication. If 'All Information Sent?' is Yes, it goes to Assemble received data, then to Resume Call Handling, then to Wait\_For\_Call\_Handling\_Response. From Wait\_For\_Call\_Handling\_Response, two paths are possible: Resume Call Handling ack leads to Set Result; Resume Call Handling negative response leads to Set Error. Both Set Result and Set Error lead to a state that sends MAP\_RESUME\_CALL\_HANDLING\_rsp and MAP\_CLOSE\_req, then to Idle. + +2520 + +2521 + +Figure 21.3/3: Process RCH\_GMSC + +2522 **21.4 Inter MSC Group Call Procedures** + +2523 **21.4.1 General** + +2524 The message flow for successful inter MSC group call / broadcast call set-up is shown in figure 21.4/1. + +![Sequence diagram showing message flow between PSTN/ISDN, Anchor MSC, and Relay MSC. The diagram consists of three vertical lifelines. 1) PSTN/ISDN sends message 1 to Anchor MSC. 2) Anchor MSC sends message 2 to Relay MSC. 3) Relay MSC sends message 3 back to Anchor MSC. 4) Anchor MSC sends message 4 to Relay MSC. 5) Relay MSC sends message 5 back to Anchor MSC. 6) Anchor MSC sends message 6 to Relay MSC. 7) Anchor MSC sends message 7 to PSTN/ISDN. 8) Anchor MSC sends message 8 to Relay MSC. 9) Relay MSC sends message 9 back to Anchor MSC. 10) Anchor MSC sends message 10 to Relay MSC. 11) PSTN/ISDN sends message 11 to Anchor MSC. 12) Anchor MSC sends message 12 to Relay MSC.](7b54229ed3e78df624c177e8e582701c_img.jpg) + +Sequence diagram showing message flow between PSTN/ISDN, Anchor MSC, and Relay MSC. The diagram consists of three vertical lifelines. 1) PSTN/ISDN sends message 1 to Anchor MSC. 2) Anchor MSC sends message 2 to Relay MSC. 3) Relay MSC sends message 3 back to Anchor MSC. 4) Anchor MSC sends message 4 to Relay MSC. 5) Relay MSC sends message 5 back to Anchor MSC. 6) Anchor MSC sends message 6 to Relay MSC. 7) Anchor MSC sends message 7 to PSTN/ISDN. 8) Anchor MSC sends message 8 to Relay MSC. 9) Relay MSC sends message 9 back to Anchor MSC. 10) Anchor MSC sends message 10 to Relay MSC. 11) PSTN/ISDN sends message 11 to Anchor MSC. 12) Anchor MSC sends message 12 to Relay MSC. + +2525 + +2526 + +- 2527 1) I\_IAM (Note 1) +- 2528 2) MAP\_PREPARE\_GROUP\_CALL\_req/ind +- 2529 3) MAP\_PREPARE\_GROUP\_CALL\_rsp/cnf +- 2530 4) I\_IAM (Note 1) +- 2531 5) MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_req/ind +- 2532 6) I\_ACM (Note 1) +- 2533 7) I\_ACM (Note 1) +- 2534 8) MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING\_req/ind (Note 2) +- 2535 9) MAP\_PROCESS\_GROUP\_CALL\_SIGNALLING\_req/ind (Note 2) +- 2536 10) MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_rsp/cnf +- 2537 11) I\_REL (Note 3) +- 2538 12) I\_REL (Note 3) + +2539 + +2540 NOTE 1: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the + 2541 MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations + 2542 and ETSI specification: + +- 2543 - Q.721-725 - Telephone User Part (TUP); +- 2544 - ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part + 2545 (ISUP) version 2 for the international interface; Part 1: Basic services. + +2546 NOTE 2: The MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING and + 2547 MAP\_PROCESS\_GROUP\_CALL\_SIGNALLING services are not applicable for voice broadcast calls. + +2548 NOTE 3: The call can be released from the PSTN/ISDN or the Relay MSC + +2549 + +2550 + +**Figure 21.4/1: Message flow for inter MSC group call / broadcast call** + +2551 **21.4.2 Process in the Anchor MSC** + +2552 The MAP process in the Anchor MSC to retrieve and transfer information from / to the Relay MSC for VBS and VGCS +2553 calls is shown in figure 21.4/2. The MAP process invokes macros not defined in this clause; the definitions of these +2554 macros can be found as follows: + +2555       Receive\_Open\_Cnf see clause 25.1.2; + +2556       Check\_Indication see clause 25.2.1; + +2557       Check\_Confirmation see clause 25.2.2. + +### 2558 21.4.3 Process in the Relay MSC + +2559 The MAP process in the Relay MSC to receive and transfer information from / to the Anchor MSC for VBS and VGCS +2560 calls is shown in figure 21.4/3. The MAP process invokes macros not defined in this clause; the definitions of these +2561 macros can be found as follows: + +2562       Receive\_Open\_Ind see clause 25.1.2; + +2563       Check\_Indication see clause 25.2.1. + +![Sequence diagram for process ASCI_Ancestor_MSC. The diagram shows the internal state transitions and message exchanges within the Anchor MSC. It starts at an initial state, goes to Idle, then Prepare Group Call. From there, it sends MAP_OPEN_req, MAP_PREPARE_GROUP_CALL_req, and MAP_DELIMITER_req. It then enters a Receive_Open_Cnf state. If OK, it goes to Wait_For_Group_Call_Number, receives MAP_PREPARE_GROUP_CALL_cnf, and enters a Check_Confirmation state. From Check_Confirmation, if OK, it goes to Prepare Group Call ack, then Wait_For_Call_Completion, and finally Idle. If Provider Error or User Error/Data Error, it goes to Prepare Group Call negative response, then sends MAP_U_ABORT_req and returns to Idle. If Vr, Error occurs in Receive_Open_Cnf, it goes to Abort and returns to Idle. A second path starts from an initial state (*), goes to MAP_NOTICE_ind, then MAP_CLOSE_req, then Abort, and finally Idle. A message box on the right indicates that MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind are received from the Relay MSC.](7be65c99e859604f653de03aa0c095e9_img.jpg) + +**process ASCI\_Ancestor\_MSC** **AA\_MSC1(2)** + +Process in the Anchor MSC for ASCI call handling + +Signals to/from the left are to/from the ASCI call handling process in the anchor MSC; signals to/from the right are to/from the Relay MSC + +``` + +sequenceDiagram + participant Start1 as + participant Idle1 as Idle + participant PrepareGroupCall1 as Prepare Group Call + participant OpenReq["MAP_OPEN_req +MAP_PREPARE_GROUP_CALL_req +MAP_DELIMITER_req"] + participant ReceiveOpenCnf as Receive_Open_Cnf + participant Abort1 as Abort + participant Idle2 as Idle + participant WaitForGroupCallNumber as Wait_For_Group_Call_Number + participant PrepareGroupCallCnf["MAP_PREPARE_GROUP_CALL_cnf"] + participant CheckConfirmation as Check_Confirmation + participant PrepareGroupCallAck as Prepare Group Call ack + participant WaitForCallCompletion as Wait_For_Call_Completion + participant PrepareGroupCallNegResponse1 as Prepare Group Call negative response + participant MAPUAbortReq["MAP_U_ABORT_req"] + participant Idle3 as Idle + participant Start2 as * + participant MAPNoticeInd as MAP_NOTICE_ind + participant MAPCloseReq as MAP_CLOSE_req + participant Abort2 as Abort + participant Idle4 as Idle + participant MAPUAbortInd["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + + Note left of Start1: Process in the Anchor MSC for ASCI call handling + Note right of Start2: Signals to/from the left are to/from the ASCI call handling process in the anchor MSC; signals to/from the right are to/from the Relay MSC + + Start1 --> Idle1 + Idle1 --> PrepareGroupCall1 + PrepareGroupCall1 --> OpenReq + OpenReq --> ReceiveOpenCnf + ReceiveOpenCnf --> Abort1: Vr, Error + ReceiveOpenCnf --> WaitForGroupCallNumber: OK + Abort1 --> Idle2 + WaitForGroupCallNumber --> PrepareGroupCallCnf + PrepareGroupCallCnf --> CheckConfirmation + CheckConfirmation --> PrepareGroupCallAck: OK + CheckConfirmation --> PrepareGroupCallNegResponse1: Provider Error + CheckConfirmation --> PrepareGroupCallNegResponse1: User Error, Data Error + PrepareGroupCallAck --> WaitForCallCompletion + WaitForCallCompletion --> Idle3 + PrepareGroupCallNegResponse1 --> MAPUAbortReq + MAPUAbortReq --> Idle3 + + Start2 --> MAPNoticeInd + MAPNoticeInd --> MAPCloseReq + MAPCloseReq --> Abort2 + Abort2 --> Idle4 + MAPNoticeInd --> MAPUAbortInd + +``` + +Sequence diagram for process ASCI\_Ancestor\_MSC. The diagram shows the internal state transitions and message exchanges within the Anchor MSC. It starts at an initial state, goes to Idle, then Prepare Group Call. From there, it sends MAP\_OPEN\_req, MAP\_PREPARE\_GROUP\_CALL\_req, and MAP\_DELIMITER\_req. It then enters a Receive\_Open\_Cnf state. If OK, it goes to Wait\_For\_Group\_Call\_Number, receives MAP\_PREPARE\_GROUP\_CALL\_cnf, and enters a Check\_Confirmation state. From Check\_Confirmation, if OK, it goes to Prepare Group Call ack, then Wait\_For\_Call\_Completion, and finally Idle. If Provider Error or User Error/Data Error, it goes to Prepare Group Call negative response, then sends MAP\_U\_ABORT\_req and returns to Idle. If Vr, Error occurs in Receive\_Open\_Cnf, it goes to Abort and returns to Idle. A second path starts from an initial state (\*), goes to MAP\_NOTICE\_ind, then MAP\_CLOSE\_req, then Abort, and finally Idle. A message box on the right indicates that MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind are received from the Relay MSC. + +2564 + +2565 + +**Figure 21.4/2 (sheet 1 of 2): Process ASCI\_Ancestor\_MSC** + +![Sequence diagram for process ASCI_Anschor_MSC. The diagram shows the internal logic of the Anchor MSC for ASCI call handling. It starts with 'Wait_For_Call_Completion', followed by an output signal 'MAP_SEND_GROUP_CALL_END_SIGNAL_ind'. A 'Check_Indication' block follows, leading to either an 'Abort' (Error) or 'Send_Group_Call_End_Signal' (OK). The 'Send_Group_Call_End_Signal' path leads to 'Uplink_Management', which then branches into three paths: 1) 'Idle', 2) 'Forward_Group_Call_Signalling' leading to 'MAP_FORWARD_GROUP_CALL_SIGNALLING_req' and 'MAP_DELIMITER_req', then 'Uplink_Management', then 'Send_Group_Call_End_Signal_ack', then 'MAP_SEND_GROUP_CALL_END_SIGNAL_rsp' and 'MAP_CLOSE_req', ending at 'Idle'; 3) an input signal 'MAP_PROCESS_GROUP_CALL_SIGNALLING_ind' leading to 'Check_Indication', which then branches into 'Abort' (Error) leading to 'MAP_U_ABORT_req' and 'Idle', or 'Process_Group_Call_Signalling' (OK) leading to 'Uplink_Management'.](5a43b8ef2db63ac99a6fb75aa61ebeab_img.jpg) + +**process ASCI\_Anschor\_MSC** **AA\_MSC2(2)** + +Process in the Anchor MSC for ASCI call handling + +Signals to/from the left are to/from the ASCI call handling process in the anchor MSC; signals to/from the right are to/from the Relay MSC + +``` + +sequenceDiagram + participant Internal + Note left of Internal: Process in the Anchor MSC for ASCI call handling + Note right of Internal: Signals to/from the left are to/from the ASCI call handling process in the anchor MSC; signals to/from the right are to/from the Relay MSC + + Internal->>Internal: Wait_For_Call_Completion + Internal->>Relay: MAP_SEND_GROUP_CALL_END_SIGNAL_ind + Internal->>Internal: Check_Indication + alt Error: Abort + Internal->>Internal: Abort + Internal->>Relay: MAP_U_ABORT_req + Internal->>Internal: Idle + else OK: Send_Group_Call_End_Signal + Internal->>Internal: Send_Group_Call_End_Signal + Internal->>Internal: Uplink_Management + alt Idle + Internal->>Internal: Idle + else Forward_Group_Call_Signalling + Internal->>Internal: Forward_Group_Call_Signalling + Internal->>Relay: MAP_FORWARD_GROUP_CALL_SIGNALLING_req + Internal->>Relay: MAP_DELIMITER_req + Internal->>Internal: Uplink_Management + Internal->>Internal: Send_Group_Call_End_Signal_ack + Internal->>Relay: MAP_SEND_GROUP_CALL_END_SIGNAL_rsp + Internal->>Relay: MAP_CLOSE_req + Internal->>Internal: Idle + else MAP_PROCESS_GROUP_CALL_SIGNALLING_ind + Internal->>Relay: MAP_PROCESS_GROUP_CALL_SIGNALLING_ind + Internal->>Internal: Check_Indication + alt Error: Abort + Internal->>Internal: Abort + Internal->>Relay: MAP_U_ABORT_req + Internal->>Internal: Idle + else OK: Process_Group_Call_Signalling + Internal->>Internal: Process_Group_Call_Signalling + Internal->>Internal: Uplink_Management + end + end + end + +``` + +Sequence diagram for process ASCI\_Anschor\_MSC. The diagram shows the internal logic of the Anchor MSC for ASCI call handling. It starts with 'Wait\_For\_Call\_Completion', followed by an output signal 'MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_ind'. A 'Check\_Indication' block follows, leading to either an 'Abort' (Error) or 'Send\_Group\_Call\_End\_Signal' (OK). The 'Send\_Group\_Call\_End\_Signal' path leads to 'Uplink\_Management', which then branches into three paths: 1) 'Idle', 2) 'Forward\_Group\_Call\_Signalling' leading to 'MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING\_req' and 'MAP\_DELIMITER\_req', then 'Uplink\_Management', then 'Send\_Group\_Call\_End\_Signal\_ack', then 'MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_rsp' and 'MAP\_CLOSE\_req', ending at 'Idle'; 3) an input signal 'MAP\_PROCESS\_GROUP\_CALL\_SIGNALLING\_ind' leading to 'Check\_Indication', which then branches into 'Abort' (Error) leading to 'MAP\_U\_ABORT\_req' and 'Idle', or 'Process\_Group\_Call\_Signalling' (OK) leading to 'Uplink\_Management'. + +2566 + +2567 + +**Figure 21.4/2 (sheet 2 of 2): Process ASCI\_Anschor\_MSC** + +![Sequence diagram for process ASCI_Relay_MSC. The process starts at an 'Idle' state, receives an 'Open_Ind' signal, and then branches based on the response: 'Vr, Error' leads back to 'Idle'; 'OK' leads to 'Wait_For_Service_Indication'. From there, three paths emerge: 1) 'MAP_P_ABORT_ind' leads to 'Idle'; 2) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' which leads to 'Idle'; 3) 'MAP_PREPARE_GROUP_CALL_ind' leads to 'Check_Indication'. 'Check_Indication' has an 'Error' path to 'MAP_U_ABORT_req' leading to 'Idle', and an 'OK' path to 'Prepare Group Call' leading to 'Wait_For_Group_Call_Number'. From 'Wait_For_Group_Call_Number', two paths emerge: 1) 'Prepare Group Call ack' leads to 'Set result' leading to a merge point for 'MAP_PREPARE_GROUP_CALL_rsp' and 'MAP_DELIMITER_req', ending at 'Wait_For_End_Signal'; 2) 'Prepare Group Call negative response' leads to 'Set error' leading to a merge point for 'MAP_PREPARE_GROUP_CALL_rsp' and 'MAP_CLOSE_req', ending at 'Idle'.](ae94cc8a2e767eb4f87c9d7cb812d6da_img.jpg) + +process ASCI\_Relay\_MSC + +AR\_MSC1(2) + +Process in the Relay MSC for ASCI call handling + +Signals to/from the left are to/from the Relay MSC; signals to/from the right are to/from the ASCI call handling process in the relay MSC + +``` + +sequenceDiagram + participant Start + participant Idle1[Idle] + participant Open_Ind[Receive Open_Ind] + participant Wait_For_Service_Indication[Wait_For_Service_Indication] + participant Vr_Error[Idle] + participant MAP_P_ABORT_ind{MAP_P_ABORT_ind} + participant MAP_NOTICE_ind{MAP_NOTICE_ind} + participant MAP_PREPARE_GROUP_CALL_ind{MAP_PREPARE_GROUP_CALL_ind} + participant MAP_CLOSE_req{MAP_CLOSE_req} + participant Check_Indication[Check_Indication] + participant MAP_U_ABORT_req{MAP_U_ABORT_req} + participant Prepare_Group_Call{Prepare Group Call} + participant Wait_For_Group_Call_Number[Wait_For_Group_Call_Number] + participant Prepare_Group_Call_ack{Prepare Group Call ack} + participant Set_result[Set result] + participant Prepare_Group_Call_negative_response{Prepare Group Call negative response} + participant Set_error[Set error] + participant Merge1{ } + participant Merge2{ } + participant MAP_DELIMITER_req[MAP_DELIMITER_req] + participant MAP_CLOSE_req2[MAP_CLOSE_req] + participant Wait_For_End_Signal[Wait_For_End_Signal] + + Start --> Idle1 + Idle1 --> Open_Ind + Open_Ind --> Vr_Error: Vr, Error + Open_Ind --> Wait_For_Service_Indication: OK + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> MAP_PREPARE_GROUP_CALL_ind + MAP_P_ABORT_ind --> Idle1 + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle1 + MAP_PREPARE_GROUP_CALL_ind --> Check_Indication + Check_Indication --> MAP_U_ABORT_req: Error + MAP_U_ABORT_req --> Idle1 + Check_Indication --> Prepare_Group_Call: OK + Prepare_Group_Call --> Wait_For_Group_Call_Number + Wait_For_Group_Call_Number --> Prepare_Group_Call_ack + Wait_For_Group_Call_Number --> Prepare_Group_Call_negative_response + Prepare_Group_Call_ack --> Set_result + Set_result --> Merge1 + Merge1 --> MAP_DELIMITER_req + Merge1 --> Wait_For_End_Signal + Prepare_Group_Call_negative_response --> Set_error + Set_error --> Merge2 + Merge2 --> MAP_CLOSE_req2 + Merge2 --> MAP_PREPARE_GROUP_CALL_rsp + Merge2 --> Idle1 + +``` + +Sequence diagram for process ASCI\_Relay\_MSC. The process starts at an 'Idle' state, receives an 'Open\_Ind' signal, and then branches based on the response: 'Vr, Error' leads back to 'Idle'; 'OK' leads to 'Wait\_For\_Service\_Indication'. From there, three paths emerge: 1) 'MAP\_P\_ABORT\_ind' leads to 'Idle'; 2) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' which leads to 'Idle'; 3) 'MAP\_PREPARE\_GROUP\_CALL\_ind' leads to 'Check\_Indication'. 'Check\_Indication' has an 'Error' path to 'MAP\_U\_ABORT\_req' leading to 'Idle', and an 'OK' path to 'Prepare Group Call' leading to 'Wait\_For\_Group\_Call\_Number'. From 'Wait\_For\_Group\_Call\_Number', two paths emerge: 1) 'Prepare Group Call ack' leads to 'Set result' leading to a merge point for 'MAP\_PREPARE\_GROUP\_CALL\_rsp' and 'MAP\_DELIMITER\_req', ending at 'Wait\_For\_End\_Signal'; 2) 'Prepare Group Call negative response' leads to 'Set error' leading to a merge point for 'MAP\_PREPARE\_GROUP\_CALL\_rsp' and 'MAP\_CLOSE\_req', ending at 'Idle'. + +2568 + +2569 + +Figure 21.4/3 (sheet 1 of 2): Process ASCI\_Relay\_MSC + +![Sequence diagram for process ASCI_Relay_MSC. The diagram shows the interaction between the Relay MSC and the ASCI call handling process. It starts with 'Wait_For_End_Signal' and 'Send Group Call End Signal'. The main loop involves 'Uplink_Management', 'MAP_FORWARD_GROUP_CALL_SIGNALLING_ind', 'Check_Indication' (Error/OK), 'Abort' or 'Forward Group Call Signalling', 'MAP_U_ABORT_req', 'Idle', 'Wait_For_Group_Call_Number', 'MAP_NOTICE_ind', 'MAP_CLOSE_req', 'MAP_P_ABORT_ind', 'MAP_CLOSE_ind', 'MAP_SEND_GROUP_CALL_END_SIGNAL_req', 'MAP_SEND_GROUP_CALL_END_SIGNAL_cnf', 'VGCS?' decision, 'Send Group Call End Signal ack', and final 'Idle' states.](3600801fb4c34c9aa22b834d51213c2e_img.jpg) + +**process ASCI\_Relay\_MSC** **AR\_MSC2(2)** + +Process in the Relay MSC for ASCI call handling + +Signals to/from the left are to/from the Relay MSC; signals to/from the right are to/from the ASCI call handling process in the relay MSC + +``` + +sequenceDiagram + participant RelayMSC as Relay MSC + participant ASCI_Process as ASCI call handling process + Note left of RelayMSC: Process in the Relay MSC for ASCI call handling + Note right of RelayMSC: Signals to/from the left are to/from the Relay MSC; signals to/from the right are to/from the ASCI call handling process in the relay MSC + + RelayMSC->>ASCI_Process: Wait_For_End_Signal + RelayMSC->>ASCI_Process: Send Group Call End Signal + RelayMSC->>ASCI_Process: MAP_SEND_GROUP_CALL_END_SIGNAL_req + RelayMSC->>ASCI_Process: Uplink_Management + RelayMSC->>ASCI_Process: MAP_FORWARD_GROUP_CALL_SIGNALLING_ind + RelayMSC->>ASCI_Process: Check_Indication + alt Error + RelayMSC->>ASCI_Process: Abort + RelayMSC->>ASCI_Process: MAP_U_ABORT_req + RelayMSC->>ASCI_Process: Idle + else OK + RelayMSC->>ASCI_Process: Forward Group Call Signalling + RelayMSC->>ASCI_Process: Uplink_Management + RelayMSC->>ASCI_Process: Wait_For_Group_Call_Number + RelayMSC->>ASCI_Process: MAP_NOTICE_ind + RelayMSC->>ASCI_Process: MAP_CLOSE_req + RelayMSC->>ASCI_Process: MAP_P_ABORT_ind + RelayMSC->>ASCI_Process: MAP_CLOSE_ind + RelayMSC->>ASCI_Process: Abort + RelayMSC->>ASCI_Process: Idle + end + + ASCI_Process->>RelayMSC: Process Group Call Signalling + ASCI_Process->>RelayMSC: MAP_PROCESS_GROUP_CALL_SIGNALLING_req + ASCI_Process->>RelayMSC: Uplink_Management + ASCI_Process->>RelayMSC: MAP_SEND_GROUP_CALL_END_SIGNAL_cnf + Note right of ASCI_Process: VGCS? + alt Yes + ASCI_Process->>RelayMSC: Send Group Call End Signal ack + ASCI_Process->>RelayMSC: Idle + else No + ASCI_Process->>RelayMSC: Idle + end + +``` + +Sequence diagram for process ASCI\_Relay\_MSC. The diagram shows the interaction between the Relay MSC and the ASCI call handling process. It starts with 'Wait\_For\_End\_Signal' and 'Send Group Call End Signal'. The main loop involves 'Uplink\_Management', 'MAP\_FORWARD\_GROUP\_CALL\_SIGNALLING\_ind', 'Check\_Indication' (Error/OK), 'Abort' or 'Forward Group Call Signalling', 'MAP\_U\_ABORT\_req', 'Idle', 'Wait\_For\_Group\_Call\_Number', 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', 'MAP\_P\_ABORT\_ind', 'MAP\_CLOSE\_ind', 'MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_req', 'MAP\_SEND\_GROUP\_CALL\_END\_SIGNAL\_cnf', 'VGCS?' decision, 'Send Group Call End Signal ack', and final 'Idle' states. + +2570 + +2571 + +Figure 21.4/3 (sheet 2 of 2): Process ASCI\_Relay\_MSC + +2572 **21.4A Inter MSC Group Call Info Retrieval** + +2573 **21.4A.1 General** + +2574 The message flow for successful inter MSC group call info retrieval is shown in figure 21.4A/1. + +![Sequence diagram showing message flow between two MSCs. The first MSC sends a 'MAP Send Group Call Info req/ind' message to the second MSC, and the second MSC responds with a 'MAP Send Group Call Info rsp/cnf' message.](f61004df7ea0150efe6eacf1295ac41b_img.jpg) + +``` +sequenceDiagram + participant MSC1 as MSC + participant MSC2 as MSC + Note right of MSC1: MAP Send Group Call Info req/ind + MSC1->>MSC2: + Note right of MSC2: MAP Send Group Call Info rsp/cnf + MSC2->>MSC1: +``` + +Sequence diagram showing message flow between two MSCs. The first MSC sends a 'MAP Send Group Call Info req/ind' message to the second MSC, and the second MSC responds with a 'MAP Send Group Call Info rsp/cnf' message. + +2575 + +2576 **Figure 21.4A/1: Message flow for inter MSC group call info retrieval** + +2577 **21.4A.2 Process in the MSC** + +2578 The MAP process in the MSC to retrieve and group call information is shown in figure 21.4A/2. The MAP process +2579 invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2580     Receive\_Open\_Cnf see clause 25.1.2; + +2581     Check\_Confirmation see clause 25.2.2. + +2582     Receive\_Open\_Ind see clause 25.1.2; + +![State transition diagram for process Group_Call_Info_Retrieval_MSC. The diagram shows states (Idle, Wait_For_Distant_MSC_Response) and transitions (Send Group_Call_Info, Receive_Open_Cnf, MAP_SEND_GROUP_CALL_INFO_cnf, MAP_NOTICE_ind, MAP_CLOSE_req, Check_Confirmation, Send_Group_Call_Info_ack, Send_Group_Call_Info_negative_response). Transitions are labeled with MAP messages like MAP_OPEN_req, MAP_SEND_GROUP_CALL_INFO_req, MAP_DELIMITER_req, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind, and error conditions like User Error, Provider Error, Data Error, Vr, Error.](3ffe1dfb268095f8b2ebcc4d58568a5a_img.jpg) + +**process Group\_Call\_Info\_Retrieval\_MSC** **GCIR\_MSC(2)** + +process in the MSC to send and receive Group Call Info Retrieval messages + +Signals to/from the left are to/from the application process in the MSC; + signals to/from the right are to/from the distant MSC + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Send_Group_Call_Info + Send_Group_Call_Info --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_Distant_MSC_Response + Wait_For_Distant_MSC_Response --> Idle : Vr, Error + Wait_For_Distant_MSC_Response --> MAP_SEND_GROUP_CALL_INFO_cnf : OK + Wait_For_Distant_MSC_Response --> MAP_NOTICE_ind + Wait_For_Distant_MSC_Response --> MAP_CLOSE_req + MAP_SEND_GROUP_CALL_INFO_cnf --> Check_Confirmation + Check_Confirmation --> Send_Group_Call_Info_ack : OK + Check_Confirmation --> Send_Group_Call_Info_negative_response : User Error, Provider Error, Data Error + Send_Group_Call_Info_ack --> Idle + Send_Group_Call_Info_negative_response --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Send_Group_Call_Info_negative_response + MAP_CLOSE_req --> MAP_U_ABORT_ind + MAP_CLOSE_req --> MAP_P_ABORT_ind + MAP_CLOSE_req --> MAP_CLOSE_ind + +``` + +State transition diagram for process Group\_Call\_Info\_Retrieval\_MSC. The diagram shows states (Idle, Wait\_For\_Distant\_MSC\_Response) and transitions (Send Group\_Call\_Info, Receive\_Open\_Cnf, MAP\_SEND\_GROUP\_CALL\_INFO\_cnf, MAP\_NOTICE\_ind, MAP\_CLOSE\_req, Check\_Confirmation, Send\_Group\_Call\_Info\_ack, Send\_Group\_Call\_Info\_negative\_response). Transitions are labeled with MAP messages like MAP\_OPEN\_req, MAP\_SEND\_GROUP\_CALL\_INFO\_req, MAP\_DELIMITER\_req, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind, and error conditions like User Error, Provider Error, Data Error, Vr, Error. + +2583 + +2584 + +**Figure 21.4A/2 (sheet 1 of 2): Process Group\_Call\_Info\_Retrieval\_MSC** + +![State transition diagram for process Group_Call_Info_Retrieval_MSC. The diagram shows states (Idle, Wait_For_Service_Indication, Wait_For_Application_Response) and transitions (Receive_Open_ind, MAP_P_ABORT_ind, MAP_SEND_GROUP_CALL_INFO_ind, MAP_NOTICE_ind, MAP_CLOSE_req, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind, Send_Group_Call_info, Send_Group_Call_info_ack, Send_Group_Call_info_negative_response, Set User Error, MAP_SEND_GROUP_CALL_INFO_rsp). Transitions are labeled with OK, Vr, Error, and MAP_CLOSE_req.](3f5a5593228cdb8d717ce04dc85d73a8_img.jpg) + +process Group\_Call\_Info\_Retrieval\_MSC GCRI\_MSC(2) + +process in the MSC to send and receive Group Call Info Retrieval messages + +Signals to/from the left are to/from the application process in the MSC; signals to/from the right are to/from the distant MSC + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_ind + Receive_Open_ind --> Wait_For_Service_Indication : OK + Receive_Open_ind --> Idle : Vr, Error + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_SEND_GROUP_CALL_INFO_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_SEND_GROUP_CALL_INFO_ind --> Send_Group_Call_info + Send_Group_Call_info --> Wait_For_Application_Response + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + Wait_For_Application_Response --> MAP_U_ABORT_ind + Wait_For_Application_Response --> Send_Group_Call_info_ack + Wait_For_Application_Response --> Send_Group_Call_info_negative_response + MAP_U_ABORT_ind --> Idle + Send_Group_Call_info_ack --> MAP_SEND_GROUP_CALL_INFO_rsp + Send_Group_Call_info_ack --> Idle + Send_Group_Call_info_negative_response --> Set User Error + Set User Error --> MAP_SEND_GROUP_CALL_INFO_rsp + Set User Error --> Idle + MAP_SEND_GROUP_CALL_INFO_rsp --> Idle + +``` + +State transition diagram for process Group\_Call\_Info\_Retrieval\_MSC. The diagram shows states (Idle, Wait\_For\_Service\_Indication, Wait\_For\_Application\_Response) and transitions (Receive\_Open\_ind, MAP\_P\_ABORT\_ind, MAP\_SEND\_GROUP\_CALL\_INFO\_ind, MAP\_NOTICE\_ind, MAP\_CLOSE\_req, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind, Send\_Group\_Call\_info, Send\_Group\_Call\_info\_ack, Send\_Group\_Call\_info\_negative\_response, Set User Error, MAP\_SEND\_GROUP\_CALL\_INFO\_rsp). Transitions are labeled with OK, Vr, Error, and MAP\_CLOSE\_req. + +2585 + +2586 + +Figure 21.4A/2 (sheet 2 of 2): Process Group\_Call\_Info\_Retrieval\_MSC + +## 2587 21.5 Void + +## 2588 21.6 CCBS: monitoring and reporting the status of the subscriber + +### 2589 21.6.1 Reporting co-ordinator process in the VLR + +2590 The MAP co-ordinating process in the VLR to handle a dialogue opened with the reporting application context is shown +2591 in figure 21.6/6. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found +2592 as follows: + +2593       Receive\_Open\_Ind see clause 25.1.1. + +2594 + +### 2595 21.6.2 Setting the reporting state – stand-alone + +2596 The message flow for setting the reporting state in a stand-alone dialogue is shown in figure 21.6/1. + +![Sequence diagram showing message flow between VLR and HLR for setting the reporting state. The HLR sends a request (1) to the VLR, and the VLR sends a response (2) back to the HLR.](fbcb102c13c3286cfefff5bad73d8c6f_img.jpg) + +``` +sequenceDiagram + participant HLR + participant VLR + Note right of HLR: 1 + HLR->>VLR: MAP_SET_REPORTING_STATE_req/ind + Note left of VLR: 2 + VLR-->>HLR: MAP_SET_REPORTING_STATE_rsp/cnf +``` + +Sequence diagram showing message flow between VLR and HLR for setting the reporting state. The HLR sends a request (1) to the VLR, and the VLR sends a response (2) back to the HLR. + +- 2597 +- 2598 +2599 1)       MAP\_SET\_REPORTING\_STATE\_req/ind +2600 2)       MAP\_SET\_REPORTING\_STATE\_rsp/cnf +2601 +2602 +- Figure 21.6/1: Message flow for setting the reporting state – stand-alone dialogue** + +#### 2603 21.6.2.1 Process in the HLR + +2604 The MAP process in the HLR to set the reporting state in the VLR in a stand-alone dialogue is shown in figure 21.6/7. +2605 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2606       Receive\_Open\_Cnf see clause 25.1.2; + +2607       Check\_Confirmation see clause 25.2.2. + +2608 The result of a request to stop reporting is not reported to the CCBS application in the HLR. + +#### 2609 21.6.2.2 Process in the VLR + +2610 The MAP process in the VLR to set the reporting state is shown in figure 21.6/8. + +2611 The macro Set\_Reporting\_State\_VLR is shown in figure 21.6/9. + +## 2612 21.6.3 Status Reporting + +2613 The message flows for reporting the status of a subscriber are shown in figures 21.6/2 and 21.6/3. + +![Sequence diagram for Figure 21.6/2 showing message flow between VLR and HLR. The HLR sends a request (1) to the VLR, and the VLR responds (2).](12957cc44ed694f84719f5792dc73ed3_img.jpg) + +``` + +sequenceDiagram + participant HLR + participant VLR + Note right of HLR: 1 + HLR->>VLR: + Note left of VLR: 2 + VLR-->>HLR: + +``` + +Sequence diagram for Figure 21.6/2 showing message flow between VLR and HLR. The HLR sends a request (1) to the VLR, and the VLR responds (2). + +2614 + 2615 + 2616 + 2617 + 2618 + 2619 + +- 1) MAP\_STATUS\_REPORT\_req/ind +- 2) MAP\_STATUS\_REPORT\_rsp/cnf + +**Figure 21.6/2: Message flow for status reporting, when monitoring continues in the VLR** + +![Sequence diagram for Figure 21.6/3 showing message flow between VLR and HLR. The HLR sends a request (1) to the VLR. The VLR responds (2) and then sends a request (3) to the HLR. The HLR responds (4).](7c3939cca352ff2db6b1b0e7eef75df1_img.jpg) + +``` + +sequenceDiagram + participant HLR + participant VLR + Note right of HLR: 1 + HLR->>VLR: + Note left of VLR: 2 + VLR-->>HLR: + Note left of VLR: 3 + VLR->>HLR: + Note right of HLR: 4 + HLR-->>VLR: + +``` + +Sequence diagram for Figure 21.6/3 showing message flow between VLR and HLR. The HLR sends a request (1) to the VLR. The VLR responds (2) and then sends a request (3) to the HLR. The HLR responds (4). + +2620 + 2621 + 2622 + 2623 + 2624 + 2625 + 2626 + 2627 + +- 1) MAP\_STATUS\_REPORT\_req/ind +- 2) MAP\_STATUS\_REPORT\_rsp/cnf +- 3) MAP\_SET\_REPORTING\_STATE\_req/ind +- 4) MAP\_SET\_REPORTING\_STATE\_rsp/cnf + +**Figure 21.6/3: Message flow for status reporting, when monitoring stops** + +2628 The MAP\_SET\_REPORTING\_STATE request is used to stop monitoring in the VLR. If the HLR requires the VLR to + 2629 continue monitoring, it closes the dialogue without sending a MAP\_SET\_REPORTING\_STATE request. + +### 2630 21.6.3.1 Process in the VLR + +2631 The MAP process in the VLR to send a status report to the HLR is shown in figure 21.6/10. The MAP process invokes + 2632 macros not defined in this clause; the definitions of these macros can be found as follows: + +- 2633       Receive\_Open\_Cnf see clause 25.1.2; +- 2634       Check\_Confirmation see clause 25.2.2. + +2635 This process can be used to report: + +- 2636       - an event, such as the user becoming free, or +- 2637       - the result of a CCBS call attempt +- 2638 to the HLR + +2639 21.6.3.2 Process in the HLR + +2640 The MAP process in the HLR to handle a status report is shown in figure 21.6/11. The MAP process invokes a macro +2641 not defined in this clause; the definition of this macro can be found as follows: + +2642       Receive\_Open\_Ind see clause 25.1.1; + +2643 It is an implementation option whether to send the MAP\_DELIMITER request before invoking the macro + +2644       Set\_Reporting\_State\_HLR. + +2645 The macro Receive\_Status\_Report\_HLR is shown in figure 21.6/12. + +2646 The macro Set\_Reporting\_State\_HLR is shown in figure 21.6/13. The macro invokes a macro not defined in this clause; +2647 the definition of this macro can be found as follows: + +2648       Check\_Confirmation see clause 25.2.2. + +2649 21.6.4 CCBS: Remote User Free + +2650 The message flows for handling remote user free are shown in figures 21.6/4 and 21.6/5. + +![Sequence diagram for Remote User Free: recall not accepted. It shows two lifelines, VLR and HLR. Step 1 is a message from HLR to VLR. Step 2 is a message from VLR to HLR.](751e1cf53975481ed9d0a1a34089acc4_img.jpg) + +``` + +sequenceDiagram + participant VLR + participant HLR + Note left of VLR: 1 + HLR->>VLR: + Note right of HLR: 2 + VLR->>HLR: + +``` + +Sequence diagram for Remote User Free: recall not accepted. It shows two lifelines, VLR and HLR. Step 1 is a message from HLR to VLR. Step 2 is a message from VLR to HLR. + +2651 + +- 2652 +- 2653 1)       MAP\_REMOTE\_USER\_FREE\_req/ind +- 2654 2)       MAP\_REMOTE\_USER\_FREE\_rsp/cnf +- 2655 +- 2656 + +**Figure 21.6/4: Remote User Free: recall not accepted** + +![Sequence diagram for Remote User Free: recall not accepted. It shows two lifelines, VLR and HLR. Step 1 is a message from HLR to VLR. Step 2 is a message from VLR to HLR. Step 3 is a message from HLR to VLR. Step 4 is a message from VLR to HLR.](12f813f41fdd775110aa16e22731173f_img.jpg) + +``` + +sequenceDiagram + participant VLR + participant HLR + Note left of VLR: 1 + HLR->>VLR: + Note right of HLR: 2 + VLR->>HLR: + Note right of HLR: 3 + HLR->>VLR: + Note left of VLR: 4 + VLR->>HLR: + +``` + +Sequence diagram for Remote User Free: recall not accepted. It shows two lifelines, VLR and HLR. Step 1 is a message from HLR to VLR. Step 2 is a message from VLR to HLR. Step 3 is a message from HLR to VLR. Step 4 is a message from VLR to HLR. + +2657 + +- 2658 +- 2659 1)       MAP\_REMOTE\_USER\_FREE\_req/ind +- 2660 2)       MAP\_REMOTE\_USER\_FREE\_rsp/cnf +- 2661 3)       MAP\_STATUS\_REPORT\_req/ind +- 2662 4)       MAP\_STATUS\_REPORT\_rsp/cnf +- 2663 + +2664 + +**Figure 21.6/5: Remote User Free: recall accepted** + +2665 **21.6.4.1 Process in the HLR** + +2666 The MAP process in the HLR to handle Remote User Free is shown in figure 21.6/14. The MAP process invokes +2667 macros not defined in this clause; the definitions of these macros can be found as follows: + +2668       Receive\_Open\_Cnf see clause 25.1.2; + +2669       Check\_Confirmation see clause 25.2.2. + +2670 **21.6.3.2 Process in the VLR** + +2671 The MAP process in the VLR to handle Remote User Free is shown in figure 21.6/15. The MAP process invokes a +2672 macro not defined in this clause; the definition of this macro can be found as follows: + +2673       Check\_Confirmation see clause 25.2.2. + +![State transition diagram for process Reporting_Coord_VLR. The diagram shows states (Idle, Wait_For_Service_Indication, Relay_Information) and transitions (Receive_Open_Ind, MAP_REMOTE_USER_FREE_ind, MAP_SET_REPORTING_STATE_ind, MAP_NOTICE_ind, MAP_CLOSE_req). It includes callouts for signal directions and process context.](f514006eae532ed76cc7446a17595018_img.jpg) + +**process Reporting\_Coord\_VLR** **Rep\_Co\_VLR1(1)** + +Co-ordinating process in the VLR to handle a dialogue opened with the AC ReportingContext + +Signals to/from the left are to/from the HLR; +signals to/from the right are to/from the child process + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Receive_Open_Ind --> Idle : Vr, Error + Wait_For_Service_Indication --> MAP_REMOTE_USER_FREE_ind + Wait_For_Service_Indication --> MAP_SET_REPORTING_STATE_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> MAP_CLOSE_req + MAP_REMOTE_USER_FREE_ind --> Remote_User_Free_VLR + Remote_User_Free_VLR --> MAP_REMOTE_USER_FREE_ind + MAP_REMOTE_USER_FREE_ind --> Relay_Information + MAP_SET_REPORTING_STATE_ind --> Set_Reporting_State_VLR + Set_Reporting_State_VLR --> MAP_SET_REPORTING_STATE_ind + MAP_SET_REPORTING_STATE_ind --> Relay_Information + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_CLOSE_req --> MAP_U_ABORT_ind + MAP_U_ABORT_ind --> MAP_P_ABORT_ind + MAP_P_ABORT_ind --> MAP_CLOSE_ind + MAP_CLOSE_ind --> Idle + +``` + +State transition diagram for process Reporting\_Coord\_VLR. The diagram shows states (Idle, Wait\_For\_Service\_Indication, Relay\_Information) and transitions (Receive\_Open\_Ind, MAP\_REMOTE\_USER\_FREE\_ind, MAP\_SET\_REPORTING\_STATE\_ind, MAP\_NOTICE\_ind, MAP\_CLOSE\_req). It includes callouts for signal directions and process context. + +2674 + +2675 + +**Figure 21.6/6: Process Reporting\_Coord\_VLR** + +process Set\_Reporting\_State\_Stand\_Alone\_HLR + +SRS\_SA\_HLR1(1) + +Process in the HLR to set the reporting state in the VLR using a separate dialogue + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +![Flowchart for process Set_Reporting_State_Stand_Alone_HLR. It starts at 'Idle', branches into 'Start reporting' and 'Stop reporting', both leading to 'Set required reporting state: Start/Stop'. These lead to a message block with MAP_OPEN_req, MAP_SET_REPORTING_STATE_req, and MAP_DELIMITER_req. This is followed by 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', an 'OK' path leads to 'Wait_For_VLR_Response', which then branches into 'MAP_NOTICE_ind', 'MAP_CLOSE_req', and 'MAP_SET_REPORTING_STATE_cnf'. The 'MAP_SET_REPORTING_STATE_cnf' path leads to 'Check Confirmation', which has an 'OK' path leading to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting ack' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'. The 'MAP_NOTICE_ind' path leads to 'MAP_CLOSE_req', which leads to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting negative response' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'. The 'Receive_Open_Cnf' also has a 'Vr, Error' path leading to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting negative response' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'.](683fef8013ee552e09df0f171a40cf4c_img.jpg) + +``` + +graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 --> StartReporting[Start reporting] + Idle1 --> StopReporting[Stop reporting] + StartReporting --> SetStart[Set required reporting state: Start] + StopReporting --> SetStop[Set required reporting state: Stop] + SetStart --> MapReq[MAP_OPEN_req +MAP_SET_REPORTING_STATE_req +MAP_DELIMITER_req] + SetStop --> MapReq + MapReq --> ReceiveCnf[Receive_Open_Cnf] + ReceiveCnf -- OK --> WaitForResponse[Wait_For_VLR_Response] + ReceiveCnf -- "Vr, Error" --> Decision1{Required reporting state=Start?} + WaitForResponse --> NoticeInd[MAP_NOTICE_ind] + WaitForResponse --> CloseReq[MAP_CLOSE_req] + WaitForResponse --> SetStateCnf[MAP_SET_REPORTING_STATE_cnf] + SetStateCnf --> CheckConfirmation[Check Confirmation] + CheckConfirmation -- OK --> Decision2{Required reporting state=Start?} + CheckConfirmation -- "User Error, Provider Error, Data Error" --> Error1[ ] + Decision2 -- Yes --> StartAck[Start reporting ack] + StartAck --> Idle2([Idle]) + Decision2 -- No --> Decision3{Required reporting state=Start?} + Decision3 -- Yes --> StartAck + StartAck --> Idle2 + Decision3 -- No --> Error1 + NoticeInd --> CloseReq + CloseReq --> Decision4{Required reporting state=Start?} + Decision4 -- Yes --> StartNegResponse[Start reporting negative response] + StartNegResponse --> Idle3([Idle]) + Decision4 -- No --> Error1 + Decision1 -- Yes --> StartNegResponse + StartNegResponse --> Idle3 + Decision1 -- No --> Error1 + +``` + +Flowchart for process Set\_Reporting\_State\_Stand\_Alone\_HLR. It starts at 'Idle', branches into 'Start reporting' and 'Stop reporting', both leading to 'Set required reporting state: Start/Stop'. These lead to a message block with MAP\_OPEN\_req, MAP\_SET\_REPORTING\_STATE\_req, and MAP\_DELIMITER\_req. This is followed by 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', an 'OK' path leads to 'Wait\_For\_VLR\_Response', which then branches into 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', and 'MAP\_SET\_REPORTING\_STATE\_cnf'. The 'MAP\_SET\_REPORTING\_STATE\_cnf' path leads to 'Check Confirmation', which has an 'OK' path leading to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting ack' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'. The 'MAP\_NOTICE\_ind' path leads to 'MAP\_CLOSE\_req', which leads to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting negative response' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'. The 'Receive\_Open\_Cnf' also has a 'Vr, Error' path leading to a decision 'Required reporting state=Start?'. If 'Yes', it leads to 'Start reporting negative response' and then 'Idle'. If 'No', it leads to 'User Error, Provider Error, Data Error'. + +2676 + +2677 + +Figure 21.6/7: Process Set\_Reporting\_State\_Stand\_Alone\_HLR + +![State transition diagram for process Set_Reporting_State_VLR. The diagram shows a vertical flow: an initial state (oval) leading to an Idle state (rounded rectangle), which leads to a Receive_Set_Reporting_State_VLR state (double-bordered rectangle), which leads to a MAP CLOSE_req state (pentagon). The flow ends at a crossed-out line. Two callout boxes provide additional information: one on the left describes the process as handling an HLR request to set reporting state, and one on the right notes that signals to/from the right are to/from the HLR.](240d7169714fb062f650cf571f5888ea_img.jpg) + +process Set\_Reporting\_State\_VLR + +SRS\_VLR1(1) + +``` +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Set_Reporting_State_VLR + Receive_Set_Reporting_State_VLR --> MAP_CLOSE_req + MAP_CLOSE_req --> [*] +``` + +Process in the VLR to handle a request from the HLR to set the reporting state for a subscriber + +Signals to/from the right are to/from the HLR + +State transition diagram for process Set\_Reporting\_State\_VLR. The diagram shows a vertical flow: an initial state (oval) leading to an Idle state (rounded rectangle), which leads to a Receive\_Set\_Reporting\_State\_VLR state (double-bordered rectangle), which leads to a MAP CLOSE\_req state (pentagon). The flow ends at a crossed-out line. Two callout boxes provide additional information: one on the left describes the process as handling an HLR request to set reporting state, and one on the right notes that signals to/from the right are to/from the HLR. + +2678 + +2679 + +Figure 21.6/8: Process Set\_Reporting\_State\_VLR + +macrodefinition Receive\_Set\_Reporting\_State\_VLR + +RSRS\_VLR1(1) + +Macro in the VLR to handle a request from the HLR to set the reporting state for a subscriber + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +![Flowchart for macrodefinition Receive_Set_Reporting_State_VLR. It starts with an entry point, followed by MAP_SET_REPORTING_STATE_ind. A decision diamond asks 'Required reporting state=Start?'. If 'No', it goes to 'Stop Reporting'. If 'Yes', it goes to 'Start Reporting', then 'Wait_For_Application_Response'. From there, it branches to 'Start Reporting ack' or 'Start Reporting negative response'. The latter leads to 'Set User Error'. Both 'Stop Reporting', 'Start Reporting ack', and 'Set User Error' lead to a common merge point, which then leads to 'MAP_SET_REPORTING_STATE_rsp' and finally an exit point.](00d5ae6b4f3a95e996e39ddb32e522a4_img.jpg) + +``` + +graph TD + Entry(( )) --> Input[/MAP_SET_REPORTING_STATE_ind/] + Input --> Decision{Required reporting state=Start?} + Decision -- No --> StopReporting{{Stop Reporting}} + Decision -- Yes --> StartReporting{{Start Reporting}} + StartReporting --> WaitForResponse([Wait_For_Application_Response]) + WaitForResponse --> StartReportingAck[/Start Reporting ack/] + WaitForResponse --> StartReportingNeg[/Start Reporting negative response/] + StartReportingNeg --> SetUserError[Set User Error] + StopReporting --> Merge(( )) + StartReportingAck --> Merge + SetUserError --> Merge + Merge --> Output[/MAP_SET_REPORTING_STATE_rsp/] + Output --> Exit(( )) + +``` + +Flowchart for macrodefinition Receive\_Set\_Reporting\_State\_VLR. It starts with an entry point, followed by MAP\_SET\_REPORTING\_STATE\_ind. A decision diamond asks 'Required reporting state=Start?'. If 'No', it goes to 'Stop Reporting'. If 'Yes', it goes to 'Start Reporting', then 'Wait\_For\_Application\_Response'. From there, it branches to 'Start Reporting ack' or 'Start Reporting negative response'. The latter leads to 'Set User Error'. Both 'Stop Reporting', 'Start Reporting ack', and 'Set User Error' lead to a common merge point, which then leads to 'MAP\_SET\_REPORTING\_STATE\_rsp' and finally an exit point. + +2680 + +2681 + +Figure 21.6/9: Macro Receive\_Set\_Reporting\_State\_VLR + +![State transition diagram for process Send_Status_Report_VLR. It starts at Idle, branches into Event Report and CCBS Call Report paths, both leading to MAP message building. It then uses a MAP_OPEN_req, MAP_STATUS_REPORT_req, or MAP_DELIMITER_req. After receiving Open_Cnf, it enters Wait_For_HLR_Response. From there, it handles MAP_STATUS_REPORT_cnf, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind, or MAP_NOTICE_ind. MAP_CLOSE_ind leads to MAP_CLOSE_req. A decision diamond checks if CCBS call report data is present. If No, it goes to Event Report negative response. If Yes, it goes to CCBS Call Report negative response. Both negative responses lead to Wait_For_Set_Reporting_State, which then returns to Idle. Error states (User Error, Provider Error, Data Error, Vr, Error) also lead to Idle.](3de4054a64d656760b2bfd54ed67fb83_img.jpg) + +process Send\_Status\_Report\_VLR SSR\_VLR1(2) + +Process in the VLR to send a status report to the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Event_Report + Idle --> CCBS_Call_Report + Event_Report --> Build_MAP_message_1[Build MAP message] + CCBS_Call_Report --> Build_MAP_message_2[Build MAP message] + Build_MAP_message_2 --> Include_call_report_data[Include call report data] + Build_MAP_message_1 --> MAP_Open_req + Build_MAP_message_2 --> MAP_Open_req + MAP_Open_req --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response + Wait_For_HLR_Response --> MAP_STATUS_REPORT_cnf + Wait_For_HLR_Response --> MAP_U_ABORT_ind + Wait_For_HLR_Response --> MAP_P_ABORT_ind + Wait_For_HLR_Response --> MAP_CLOSE_ind + Wait_For_HLR_Response --> MAP_NOTICE_ind + MAP_STATUS_REPORT_cnf --> Check_Confirmation + Check_Confirmation --> User_Error[User Error, Provider Error, Data Error] + User_Error --> Idle + MAP_U_ABORT_ind --> Idle + MAP_P_ABORT_ind --> Idle + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Decision[CCBS call report data present?] + MAP_NOTICE_ind --> Idle + Decision -- No --> Event_Report_negative_response[Event Report negative response] + Decision -- Yes --> CCBS_Call_Report_negative_response[CCBS Call Report negative response] + Event_Report_negative_response --> Wait_For_Set_Reporting_State + CCBS_Call_Report_negative_response --> Idle + Wait_For_Set_Reporting_State --> Idle + Vr_Error[Vr, Error] --> Idle + +``` + +State transition diagram for process Send\_Status\_Report\_VLR. It starts at Idle, branches into Event Report and CCBS Call Report paths, both leading to MAP message building. It then uses a MAP\_OPEN\_req, MAP\_STATUS\_REPORT\_req, or MAP\_DELIMITER\_req. After receiving Open\_Cnf, it enters Wait\_For\_HLR\_Response. From there, it handles MAP\_STATUS\_REPORT\_cnf, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind, or MAP\_NOTICE\_ind. MAP\_CLOSE\_ind leads to MAP\_CLOSE\_req. A decision diamond checks if CCBS call report data is present. If No, it goes to Event Report negative response. If Yes, it goes to CCBS Call Report negative response. Both negative responses lead to Wait\_For\_Set\_Reporting\_State, which then returns to Idle. Error states (User Error, Provider Error, Data Error, Vr, Error) also lead to Idle. + +2682 + +2683 + +Figure 21.6/10 (sheet 1 of 2): Process Send\_Status\_Report\_VLR + +![State transition diagram for process Send_Status_Report_VLR. It starts in 'Wait_For_Set_Reporting_State' and branches into four paths based on incoming signals: 'Receive_Set_Reporting_State_VLR', 'MAP_CLOSE_ind', 'MAP_NOTICE_ind', and an unlabeled path for 'MAP_U_ABORT_ind' and 'MAP_P_ABORT_ind'. The first three paths lead to 'MAP_CLOSE_req' and then 'Idle'. The unlabeled path leads directly to 'Idle'. 'MAP_CLOSE_ind' also leads to 'Continue Monitoring' before reaching 'Idle'.](27437c680df436ac580ac2cbbe0738f2_img.jpg) + +process Send\_Status\_Report\_VLR SSR\_VLR2(2) + +Process in the VLR to send a status report to the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Set_Reporting_State + state "Wait_For_Set_Reporting_State" as Wait_For_Set_Reporting_State + state "Receive_Set_Reporting_State_VLR" as Receive_Set_Reporting_State_VLR + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind" as MAP_U_ABORT_ind_MAP_P_ABORT_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Continue Monitoring" as Continue_Monitoring + state "Idle" as Idle + + Wait_For_Set_Reporting_State --> Receive_Set_Reporting_State_VLR + Wait_For_Set_Reporting_State --> MAP_CLOSE_ind + Wait_For_Set_Reporting_State --> MAP_NOTICE_ind + Wait_For_Set_Reporting_State --> MAP_U_ABORT_ind_MAP_P_ABORT_ind + + Receive_Set_Reporting_State_VLR --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + + MAP_CLOSE_ind --> Continue_Monitoring + Continue_Monitoring --> Idle + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + + MAP_U_ABORT_ind_MAP_P_ABORT_ind --> Idle + +``` + +State transition diagram for process Send\_Status\_Report\_VLR. It starts in 'Wait\_For\_Set\_Reporting\_State' and branches into four paths based on incoming signals: 'Receive\_Set\_Reporting\_State\_VLR', 'MAP\_CLOSE\_ind', 'MAP\_NOTICE\_ind', and an unlabeled path for 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind'. The first three paths lead to 'MAP\_CLOSE\_req' and then 'Idle'. The unlabeled path leads directly to 'Idle'. 'MAP\_CLOSE\_ind' also leads to 'Continue Monitoring' before reaching 'Idle'. + +2684 + +2685 + +Figure 21.6/10 (sheet 2 of 2): Process Send\_Status\_Report\_VLR + +![State transition diagram for process Status_Report_HLR. The process starts at an initial state, goes to Idle, then receives an Open_Ind. From there, it can go to Wait_For_Service_Indication (OK path) or Idle (Vr, Error path). Wait_For_Service_Indication leads to a decision point for MAP_P_ABORT_ind, Receive_Status_Report_HLR, or MAP_NOTICE_ind. The Receive_Status_Report_HLR path continues through Wait_For_Application_Response, Stop Reporting, Set required reporting state: Stop, MAP_DELIMITER_req, and Set_Reporting_State_HLR to a final Idle state. The MAP_P_ABORT_ind path leads to Idle, then Continue Monitoring, MAP_CLOSE_req, and Idle. The MAP_NOTICE_ind path leads to MAP_CLOSE_req and Idle.](6cba75c8486e1053fc1859aa66af45c6_img.jpg) + +**process Status\_Report\_HLR** **SR\_HLR1(1)** + +Process in the HLR to handle a status report from the VLR + +Signals to/from the left are to/from the VLR; + signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind --> Wait_For_Service_Indication[Wait_For_Service_Indication] : OK + Receive_Open_Ind --> Idle2[Idle] : Vr, Error + Wait_For_Service_Indication --> Decision1{ } + Decision1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind] + Decision1 --> Receive_Status_Report_HLR[Receive_Status_Report_HLR] + Decision1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_P_ABORT_ind --> Idle3[Idle] + Idle3 --> Continue_Monitoring[Continue Monitoring] + Continue_Monitoring --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_CLOSE_req1 --> Idle4[Idle] + Receive_Status_Report_HLR --> Wait_For_Application_Response[Wait_For_Application_Response] + Wait_For_Application_Response --> Stop_Reporting[Stop Reporting] + Stop_Reporting --> Set_required_reporting_state[Set required reporting state: Stop] + Set_required_reporting_state --> MAP_DELIMITER_req[MAP_DELIMITER_req] + MAP_DELIMITER_req --> Set_Reporting_State_HLR[Set_Reporting_State_HLR] + Set_Reporting_State_HLR --> Idle5[Idle] : OK, Error, Aborted + MAP_NOTICE_ind --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Idle6[Idle] + +``` + +State transition diagram for process Status\_Report\_HLR. The process starts at an initial state, goes to Idle, then receives an Open\_Ind. From there, it can go to Wait\_For\_Service\_Indication (OK path) or Idle (Vr, Error path). Wait\_For\_Service\_Indication leads to a decision point for MAP\_P\_ABORT\_ind, Receive\_Status\_Report\_HLR, or MAP\_NOTICE\_ind. The Receive\_Status\_Report\_HLR path continues through Wait\_For\_Application\_Response, Stop Reporting, Set required reporting state: Stop, MAP\_DELIMITER\_req, and Set\_Reporting\_State\_HLR to a final Idle state. The MAP\_P\_ABORT\_ind path leads to Idle, then Continue Monitoring, MAP\_CLOSE\_req, and Idle. The MAP\_NOTICE\_ind path leads to MAP\_CLOSE\_req and Idle. + +2686 + +2687 + +Figure 21.6/11: Process Status Report\_HLR + +macrodefinition Receive\_Status\_Report\_HLR + +RSR\_HLR1(1) + +Macro in the HLR to receive a status report from the VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +![Flowchart for macrodefinition Receive_Status_Report_HLR. It starts with a connector, followed by MAP_STATUS_REPORT_ind. A decision diamond asks 'CCBS call report data present?'. If 'Yes', it goes to 'CCBS Call Report'. If 'No', it goes to 'Event Report'. Both lead to 'Wait For Application_Response'. From there, four paths emerge: 'CCBS Call Report ack', 'CCBS Call Report negative response' (leading to 'Set User Error'), 'Event Report ack', and 'Event Report negative response' (leading to 'Set User Error'). All four paths converge to 'MAP_STATUS_REPORT_rsp', which ends at a connector.](50b0a679fb121fc66ab60c8a8a5b4ae3_img.jpg) + +``` + +graph TD + Start([ ]) --> Ind{MAP_STATUS_REPORT_ind} + Ind --> Decision{CCBS call report data present?} + Decision -- Yes --> CCBS_Report[CCBS Call Report] + Decision -- No --> Event_Report[Event Report] + CCBS_Report --> Wait[Wait For Application_Response] + Event_Report --> Wait + Wait --> Ack1[CCBS Call Report ack] + Wait --> Neg1[CCBS Call Report negative response] + Wait --> Ack2[Event Report ack] + Wait --> Neg2[Event Report negative response] + Neg1 --> Error1[Set User Error] + Neg2 --> Error2[Set User Error] + Ack1 --> Rsp{MAP_STATUS_REPORT_rsp} + Error1 --> Rsp + Ack2 --> Rsp + Error2 --> Rsp + Rsp --> End([ ]) + +``` + +Flowchart for macrodefinition Receive\_Status\_Report\_HLR. It starts with a connector, followed by MAP\_STATUS\_REPORT\_ind. A decision diamond asks 'CCBS call report data present?'. If 'Yes', it goes to 'CCBS Call Report'. If 'No', it goes to 'Event Report'. Both lead to 'Wait For Application\_Response'. From there, four paths emerge: 'CCBS Call Report ack', 'CCBS Call Report negative response' (leading to 'Set User Error'), 'Event Report ack', and 'Event Report negative response' (leading to 'Set User Error'). All four paths converge to 'MAP\_STATUS\_REPORT\_rsp', which ends at a connector. + +2688 + +2689 + +Figure 21.6/12: Macro Receive\_Status\_Report\_HLR + +# macrodefinition Set\_Reporting\_State\_HLR + +SRS\_HLR1(1) + +Macro in the HLR to instruct the VLR to set the reporting state for a subscriber + +Signals to/from the left are to/from the VLR + +![State transition diagram for Set_Reporting_State_HLR macro. It starts with an initial state leading to a request (MAP_SET_REPORTING_STATE_req, MAP_DELIMITER_req), followed by a wait state (Wait_For_VLR_Response). From there, it branches into three paths: a successful confirmation (MAP_SET_REPORTING_STATE_cnf) leading to a check and then OK or Error states; a notice indication (MAP_NOTICE_ind) leading to a close request (MAP_CLOSE_req) and then an Aborted state; and an abort/close indication (MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind) leading directly to the Aborted state.](86de25c748dbfa7189a602dbda537b3b_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Request + state "MAP_SET_REPORTING_STATE_req
MAP_DELIMITER_req" as Request + Request --> Wait + state "Wait_For_VLR_Response" as Wait + Wait --> Success + state "MAP_SET_REPORTING_STATE_cnf" as Success + Success --> Check + state "Check_Confirmation" as Check + Check --> OK + state "OK" as OK + Check --> Error + state "Error" as Error + Note right of Error: User Error, Provider Error, Data Error + Wait --> Notice + state "MAP_NOTICE_ind" as Notice + Notice --> CloseReq + state "MAP_CLOSE_req" as CloseReq + CloseReq --> Aborted + state "Aborted" as Aborted + Wait --> AbortClose + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as AbortClose + AbortClose --> Aborted + +``` + +State transition diagram for Set\_Reporting\_State\_HLR macro. It starts with an initial state leading to a request (MAP\_SET\_REPORTING\_STATE\_req, MAP\_DELIMITER\_req), followed by a wait state (Wait\_For\_VLR\_Response). From there, it branches into three paths: a successful confirmation (MAP\_SET\_REPORTING\_STATE\_cnf) leading to a check and then OK or Error states; a notice indication (MAP\_NOTICE\_ind) leading to a close request (MAP\_CLOSE\_req) and then an Aborted state; and an abort/close indication (MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind) leading directly to the Aborted state. + +2690 + +2691 + +Figure 21.6/13: Macro Set\_Reporting\_State\_HLR + +process Remote\_User\_Free\_HLR + +RUF\_HLR1(1) + +Process in the HLR to send a Remote User Free notification to the VLR + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +![State transition diagram for process Remote_User_Free_HLR. The process starts at an 'Idle' state, receives a 'CCBS RUF' signal, sends 'MAP_OPEN_req', 'MAP_REMOTE_USER_FREE_req', and 'MAP_DELIMITER_req' to the VLR, receives 'Receive_Open_Cnf', and then enters a 'Wait_For_VLR_Response' state. From there, it branches based on the response: 'OK' leads to 'MAP_REMOTE_USER_FREE_cnf' and 'Check_Confirmation'; 'User Error, Provider Error, Data Error' leads to 'MAP_CLOSE_req'; 'Vr, Error' leads to 'Set negative response: System failure'. 'Check_Confirmation' leads to 'CCBS RUF ack' and 'Wait_For_Status_Report'. 'Wait_For_Status_Report' branches to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (leading to 'Idle'), 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and then 'Idle'), 'Receive_Status_Report_HLR' (leading to 'Abort' and then 'MAP_CLOSE_req' and 'Idle'), or 'Set negative response: System failure' (leading to 'CCBS RUF negative response' and then 'Idle').](4300fa385c800064ed8ea51254c7aaaa_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> CCBS_RUF_in {CCBS RUF} + CCBS_RUF_in --> Send_Requests + state "Send Requests" as Send_Requests + Send_Requests : MAP_OPEN_req, MAP_REMOTE_USER_FREE_req, MAP_DELIMITER_req + Send_Requests --> Receive_Open_Cnf + state "Receive_Open_Cnf" as Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_VLR_Response + state "Wait_For_VLR_Response" as Wait_For_VLR_Response + Wait_For_VLR_Response --> OK + Wait_For_VLR_Response --> Error + OK --> MAP_REMOTE_USER_FREE_cnf + state "MAP_REMOTE_USER_FREE_cnf" as MAP_REMOTE_USER_FREE_cnf + MAP_REMOTE_USER_FREE_cnf --> Check_Confirmation + state "Check_Confirmation" as Check_Confirmation + Check_Confirmation --> CCBS_RUF_ack + state "CCBS RUF ack" as CCBS_RUF_ack + CCBS_RUF_ack --> Wait_For_Status_Report + state "Wait_For_Status_Report" as Wait_For_Status_Report + Wait_For_Status_Report --> Abort_Ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as Abort_Ind + Abort_Ind --> Idle + Wait_For_Status_Report --> Notice_Ind + state "MAP_NOTICE_ind" as Notice_Ind + Notice_Ind --> MAP_CLOSE_req + state "MAP_CLOSE_req" as MAP_CLOSE_req + MAP_CLOSE_req --> Idle + Wait_For_Status_Report --> Status_Report + state "Receive_Status_Report_HLR" as Status_Report + Status_Report --> Abort + state "Abort" as Abort + Abort --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + Wait_For_Status_Report --> System_Failure + state "Set negative response: System failure" as System_Failure + System_Failure --> CCBS_RUF_negative_response + state "CCBS RUF negative response" as CCBS_RUF_negative_response + CCBS_RUF_negative_response --> Idle + Error --> Vr_Error + state "Vr, Error" as Vr_Error + Vr_Error --> System_Failure + User_Error --> MAP_CLOSE_req + state "User Error, Provider Error, Data Error" as User_Error + User_Error --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process Remote\_User\_Free\_HLR. The process starts at an 'Idle' state, receives a 'CCBS RUF' signal, sends 'MAP\_OPEN\_req', 'MAP\_REMOTE\_USER\_FREE\_req', and 'MAP\_DELIMITER\_req' to the VLR, receives 'Receive\_Open\_Cnf', and then enters a 'Wait\_For\_VLR\_Response' state. From there, it branches based on the response: 'OK' leads to 'MAP\_REMOTE\_USER\_FREE\_cnf' and 'Check\_Confirmation'; 'User Error, Provider Error, Data Error' leads to 'MAP\_CLOSE\_req'; 'Vr, Error' leads to 'Set negative response: System failure'. 'Check\_Confirmation' leads to 'CCBS RUF ack' and 'Wait\_For\_Status\_Report'. 'Wait\_For\_Status\_Report' branches to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (leading to 'Idle'), 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and then 'Idle'), 'Receive\_Status\_Report\_HLR' (leading to 'Abort' and then 'MAP\_CLOSE\_req' and 'Idle'), or 'Set negative response: System failure' (leading to 'CCBS RUF negative response' and then 'Idle'). + +2692 + +2693 + +Figure 21.6/14: Process Remote\_User\_Free\_HLR + +![State transition diagram for process Remote_User_Free_VLR. It starts at Idle, receives MAP_REMOTE_USER_FREE_ind, enters CCBS RUF state, and waits for a response. Responses include ack (accepted), ack (unsuccessful), negative response, or an abort/close indication. Successful ack leads to sending responses and waiting for a call report. Unsuccessful ack and negative response lead to setting an error and sending responses. The abort/close path ends in a terminal state.](e343a5925678a3d9126523971922bd1c_img.jpg) + +**process Remote\_User\_Free\_VLR** **RUF\_VLR1(2)** + +Process in the VLR to handle a Remote User Free notification from the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> MAP_REMOTE_USER_FREE_ind + MAP_REMOTE_USER_FREE_ind --> CCBS_RUF : CCBS RUF + CCBS_RUF --> Wait_For_Application_Response + state "Wait_For_Application_Response" as Wait_For_Application_Response + state "CCBS RUF ack (Recall accepted)" as CCBS_RUF_ack_accepted + state "CCBS RUF ack (Recall unsuccessful)" as CCBS_RUF_ack_unsuccessful + state "CCBS RUF negative response" as CCBS_RUF_negative_response + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as Abort_Close_Ind + state "Set User Error" as Set_User_Error + state "MAP_REMOTE_USER_FREE_rsp, MAP_DELIMITER_req" as Rsp_Delimiter_Req + state "MAP_REMOTE_USER_FREE_rsp, MAP_CLOSE_req" as Rsp_Close_Req + state "Wait_For_Call_Report" as Wait_For_Call_Report + state "X" as Terminal + + Wait_For_Application_Response --> CCBS_RUF_ack_accepted + Wait_For_Application_Response --> CCBS_RUF_ack_unsuccessful + Wait_For_Application_Response --> CCBS_RUF_negative_response + Wait_For_Application_Response --> Abort_Close_Ind + + CCBS_RUF_ack_accepted --> Rsp_Delimiter_Req + Rsp_Delimiter_Req --> Wait_For_Call_Report + + CCBS_RUF_ack_unsuccessful --> Set_User_Error + Set_User_Error --> Rsp_Close_Req + Rsp_Close_Req --> Terminal + + CCBS_RUF_negative_response --> Set_User_Error + Set_User_Error --> Rsp_Close_Req + Rsp_Close_Req --> Terminal + + Abort_Close_Ind --> Terminal + +``` + +State transition diagram for process Remote\_User\_Free\_VLR. It starts at Idle, receives MAP\_REMOTE\_USER\_FREE\_ind, enters CCBS RUF state, and waits for a response. Responses include ack (accepted), ack (unsuccessful), negative response, or an abort/close indication. Successful ack leads to sending responses and waiting for a call report. Unsuccessful ack and negative response lead to setting an error and sending responses. The abort/close path ends in a terminal state. + +2694 + +2695 + +**Figure 21.6/15 (sheet 1 of 2): Process Remote\_User\_Free\_VLR** + +![Sequence diagram for process Remote_User_Free_VLR. The process starts in a 'Wait_For_Call_Report' state. It receives a 'CCBS Call Report' from the left, which triggers a 'MAP_STATUS_REPORT_req' and 'MAP_DELIMITER_req' to the right. It then enters a 'Wait_For_HLR_Response' state. From there, it can receive a 'MAP_STATUS_REPORT_cnf' from the right, leading to a 'Check_Confirmation' block. If 'OK', the process ends. If 'User Error, Provider Error, Data Error', it sends a 'MAP_CLOSE_req' to the right. Alternatively, it can receive a 'MAP_NOTICE_ind' from the right, which triggers a 'MAP_CLOSE_req' to the right. It also receives various indication signals (ABORT, CLOSE) from the right. The process ends in a negative response state.](bf4cb26ecd7a615a6de16a510d0d06e5_img.jpg) + +**process Remote\_User\_Free\_VLR** **RUF\_VLR2(2)** + +Process in the VLR to handle a Remote User Free notification from the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + +sequenceDiagram + participant VLR as Remote_User_Free_VLR + Note right of VLR: Wait_For_Call_Report + Note left of VLR: CCBS Call Report + Note right of VLR: MAP_STATUS_REPORT_req, MAP_DELIMITER_req + Note left of VLR: Wait_For_HLR_Response + Note right of VLR: MAP_STATUS_REPORT_cnf + Note left of VLR: Check_Confirmation + Note right of VLR: OK + Note right of VLR: User Error, Provider Error, Data Error + Note right of VLR: MAP_CLOSE_req + Note right of VLR: MAP_NOTICE_ind + Note right of VLR: MAP_CLOSE_req + Note right of VLR: CCBS Call Report negative response + +``` + +Sequence diagram for process Remote\_User\_Free\_VLR. The process starts in a 'Wait\_For\_Call\_Report' state. It receives a 'CCBS Call Report' from the left, which triggers a 'MAP\_STATUS\_REPORT\_req' and 'MAP\_DELIMITER\_req' to the right. It then enters a 'Wait\_For\_HLR\_Response' state. From there, it can receive a 'MAP\_STATUS\_REPORT\_cnf' from the right, leading to a 'Check\_Confirmation' block. If 'OK', the process ends. If 'User Error, Provider Error, Data Error', it sends a 'MAP\_CLOSE\_req' to the right. Alternatively, it can receive a 'MAP\_NOTICE\_ind' from the right, which triggers a 'MAP\_CLOSE\_req' to the right. It also receives various indication signals (ABORT, CLOSE) from the right. The process ends in a negative response state. + +2696 + +2697 + +**Figure 21.6/15 (sheet 2 of 2): Process Remote\_User\_Free\_VLR** + +2698 21.7 Void + +2699 21.8 Void + +## 2700 21.9 Immediate Service Termination (IST) + +### 2701 21.9.1 IST Alert + +2702 The Immediate Service Termination Alert procedure is used to keep track of the call activities performed by subscribers +2703 who are marked as being subject to IST monitoring and, possibly, to terminate the call activities for which the alert was +2704 sent, or all the call activities related to the subscriber for whom the alert was sent. + +2705 The message flow for alerting is shown in figure 21.9/1; the MSC may be a Visited MSC or a Gateway MSC. + +![Sequence diagram showing the message flow for IST Alert between an MSC and an HLR. The MSC sends a message to the HLR (labeled 1), and the HLR responds (labeled 2).](f252804b6058cc43c4ee3a3251702abe_img.jpg) + +``` +sequenceDiagram + participant MSC + participant HLR + Note right of HLR: 1 + MSC->>HLR: + Note left of MSC: 2 + HLR-->>MSC: +``` + +Sequence diagram showing the message flow for IST Alert between an MSC and an HLR. The MSC sends a message to the HLR (labeled 1), and the HLR responds (labeled 2). + +2706 + +2707 +2708 1) MAP\_IST\_ALERT\_req/ind +2709 2) MAP\_IST\_ALERT\_rsp/cnf +2710 +2711 + +Figure 21.9/1: Message flow for IST Alert + +### 2712 21.9.1.1 Procedure in the MSC + +2713 The MAP process in the MSC (Visited MSC or Gateway MSC) is shown in figure 21.9/3. The MAP process invokes +2714 macros not defined in this clause; the definitions of these macros can be found as follows: + +2715       Receive\_Open\_Cnf           see clause 25.1.2; + +2716       Check\_Confirmation         see clause 25.2.2. + +### 2717 21.9.1.2 Procedure in the HLR + +2718 The MAP process in the HLR is shown in figure 21.9/4. The MAP process invokes a macro not defined in this clause; +2719 the definition of this macro can be found as follows: + +2720       Receive\_Open\_Ind           see clause 25.1.1; + +## 2721 21.9.2 IST Command + +2722 The Immediate Service Termination Command procedure is used to terminate the call activities related to a subscriber. + +2723 The message flow for the IST Command procedure is shown in figure 21.9/2; the MSC may be a Visited MSC or a +2724 Gateway MSC. + +![Sequence diagram showing message flow between MSC and HLR. The MSC sends a message (1) to the HLR, and the HLR responds (2).](527a7b5533d626c7395e2606b08fc220_img.jpg) + +``` + +sequenceDiagram + participant MSC + participant HLR + Note left of MSC: 1 + MSC->>HLR: + Note right of HLR: 2 + HLR->>MSC: + +``` + +Sequence diagram showing message flow between MSC and HLR. The MSC sends a message (1) to the HLR, and the HLR responds (2). + +2725 + +2726 + +2727 1) MAP\_IST\_COMMAND\_req/ind + +2728 2) MAP\_IST\_COMMAND\_rsp/cnf + +2729 + +2730 + +**Figure 21.9/2: Message flow for IST Command** + +### 2731 21.9.2.1 Procedure in the HLR + +2732 The MAP process in the HLR is shown in figure 21.9/5. The MAP process invokes macros not defined in this clause; +2733 the definitions of these macros can be found as follows: + +2734 Receive\_Open\_Cnf see clause 25.1.2; + +2735 Check\_Confirmation see clause 25.2.2. + +### 2736 21.9.2.2 Procedure in the MSC + +2737 The MAP process in the MSC is shown in figure 21.9/6. The MAP process invokes a macro not defined in this clause; +2738 the definition of this macro can be found as follows: + +2739 Receive\_Open\_Ind see clause 25.1.1. + +![State transition diagram for process IST_Alert_MSC. The process starts at an initial state, goes to Idle, then IST Alert. It sends MAP_OPEN_req, MAP_IST_ALERT_req, and MAP_DELIMITER_req to the HLR. It receives Open_Cnf. If OK, it goes to Wait_For_HLR_Response. If Vr, Error, it goes to IST Alert negative response and then Idle. From Wait_For_HLR_Response, it receives MAP_IST_ALERT_cnf, MAP_NOTICE_ind, and MAP_CLOSE_req. If MAP_IST_ALERT_cnf is OK, it goes to Check Confirmation. If MAP_NOTICE_ind is User Error, Provider Error, or Data Error, it goes to IST Alert negative response. If MAP_CLOSE_req is OK, it goes to IST Alert ack. If MAP_CLOSE_req is not OK, it goes to IST Alert negative response. Both IST Alert ack and IST Alert negative response lead to Idle. There is also a transition from the third state to MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind.](e41e58044b89601b2e949f518af843eb_img.jpg) + +process IST\_Alert\_MSC + +ISTA\_MSC1(1) + +Process in the MSC to send an IST alert to the HLR + +Signals to/from the left are to/from the call handling application process in the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> IST_Alert + IST_Alert --> State1 + State1 --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Receive_Open_Cnf --> IST_Alert_negative_response: Vr, Error + IST_Alert_negative_response --> Idle + Wait_For_HLR_Response --> MAP_IST_ALERT_cnf + Wait_For_HLR_Response --> MAP_NOTICE_ind + Wait_For_HLR_Response --> State3 + State3 --> MAP_U_ABORT_ind + MAP_IST_ALERT_cnf --> Check_Confirmation + Check_Confirmation --> IST_Alert_ack: OK + Check_Confirmation --> MAP_CLOSE_req: User Error, Provider Error, Data Error + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> IST_Alert_ack: OK + MAP_CLOSE_req --> IST_Alert_negative_response: User Error, Provider Error, Data Error + IST_Alert_ack --> Idle + IST_Alert_negative_response --> Idle + +``` + +2740 + +2741 + +State transition diagram for process IST\_Alert\_MSC. The process starts at an initial state, goes to Idle, then IST Alert. It sends MAP\_OPEN\_req, MAP\_IST\_ALERT\_req, and MAP\_DELIMITER\_req to the HLR. It receives Open\_Cnf. If OK, it goes to Wait\_For\_HLR\_Response. If Vr, Error, it goes to IST Alert negative response and then Idle. From Wait\_For\_HLR\_Response, it receives MAP\_IST\_ALERT\_cnf, MAP\_NOTICE\_ind, and MAP\_CLOSE\_req. If MAP\_IST\_ALERT\_cnf is OK, it goes to Check Confirmation. If MAP\_NOTICE\_ind is User Error, Provider Error, or Data Error, it goes to IST Alert negative response. If MAP\_CLOSE\_req is OK, it goes to IST Alert ack. If MAP\_CLOSE\_req is not OK, it goes to IST Alert negative response. Both IST Alert ack and IST Alert negative response lead to Idle. There is also a transition from the third state to MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. + +Figure 21.9/3: Process IST\_Alert\_MSC + +![State transition diagram for process IST_Alert_HLR. The process starts at an initial state, goes to Idle, then receives an Open_Ind. If OK, it waits for a service indication. From there, it can handle MAP_P_ABORT_ind, MAP_IST_ALERT_ind, or MAP_NOTICE_ind. MAP_IST_ALERT_ind leads to an IST Alert state and then waiting for an application response. Responses include IST Alert ack, IST Alert negative response, or a combined response. MAP_NOTICE_ind leads to a MAP_CLOSE_req and then Idle. MAP_P_ABORT_ind also leads to Idle. The combined response includes MAP_IST_ALERT_rsp and MAP_CLOSE_req.](1962ee7e9a747e60da0f0a30a9509763_img.jpg) + +**process IST\_Alert\_HLR** **ISTA\_HLR(1)** + +Process in the HLR to handle an IST Alert from the MSC + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the IST application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Service_Indication: OK + Receive_Open_Ind --> Idle: Vr, Error + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_IST_ALERT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_IST_ALERT_ind --> IST_Alert + IST_Alert --> Wait_For_Application_Response + Wait_For_Application_Response --> IST_Alert_ack + Wait_For_Application_Response --> IST_Alert_negative_response + Wait_For_Application_Response --> Combined_Response + IST_Alert_ack --> Idle + IST_Alert_negative_response --> Set_User_Error + Set_User_Error --> Combined_Response + Combined_Response --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +MAP\_P\_ABORT\_ind + MAP\_IST\_ALERT\_ind + MAP\_NOTICE\_ind + IST Alert + Wait\_For\_Application\_Response + IST Alert ack + IST Alert negative response + Set User Error + MAP\_IST\_ALERT\_rsp + MAP\_CLOSE\_req + +State transition diagram for process IST\_Alert\_HLR. The process starts at an initial state, goes to Idle, then receives an Open\_Ind. If OK, it waits for a service indication. From there, it can handle MAP\_P\_ABORT\_ind, MAP\_IST\_ALERT\_ind, or MAP\_NOTICE\_ind. MAP\_IST\_ALERT\_ind leads to an IST Alert state and then waiting for an application response. Responses include IST Alert ack, IST Alert negative response, or a combined response. MAP\_NOTICE\_ind leads to a MAP\_CLOSE\_req and then Idle. MAP\_P\_ABORT\_ind also leads to Idle. The combined response includes MAP\_IST\_ALERT\_rsp and MAP\_CLOSE\_req. + +2742 + +2743 + +Figure 21.9/4: Process IST\_Alert\_HLR + +![State transition diagram for process IST_Command_HLR. The process starts at an initial state, goes to Idle, then receives an IST Command. It sends MAP_OPEN_req, MAP_IST_COMMAND_req, and MAP_DELIMITER_req, then receives Open_Cnf. If OK, it goes to Wait_For_MSC_Response. If Vr, Error, it sends an IST Command negative response and returns to Idle. From Wait_For_MSC_Response, it can receive MAP_IST_COMMAND_cnf, MAP_NOTICE_ind, or an empty box. MAP_IST_COMMAND_cnf leads to Check_Confirmation. If OK, it sends an IST Command ack and returns to Idle. If User Error, Provider Error, or Data Error, it sends an IST Command negative response and returns to Idle. MAP_NOTICE_ind leads to MAP_CLOSE_req. An empty box leads to a box with MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind. Both lead to IST Command negative response and return to Idle.](009a676afba09ee7f6a02dbf84a75fb8_img.jpg) + +process IST\_Command\_HLR ISTC\_HLR1(1) + +Process in the HLR to send an IST command to the MSC + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the IST application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> IST_Command[IST Command] + IST_Command --> MAP_Requests[MAP_OPEN_req, MAP_IST_COMMAND_req, MAP_DELIMITER_req] + MAP_Requests --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf --> Wait_For_MSC_Response[Wait_For_MSC_Response] + Wait_For_MSC_Response --> OK1[OK] + Wait_For_MSC_Response --> Vr_Error[Vr, Error] + Vr_Error --> IST_Neg_Response1[IST Command negative response] + IST_Neg_Response1 --> Idle2[Idle] + OK1 --> MAP_IST_COMMAND_cnf[MAP_IST_COMMAND_cnf] + OK1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + OK1 --> EmptyBox[ ] + EmptyBox --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_IST_COMMAND_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> OK2[OK] + Check_Confirmation --> User_Error[User Error, Provider Error, Data Error] + User_Error --> IST_Neg_Response2[IST Command negative response] + IST_Neg_Response2 --> Idle3[Idle] + OK2 --> IST_Ack[IST Command ack] + IST_Ack --> Idle4[Idle] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> IST_Neg_Response3[IST Command negative response] + IST_Neg_Response3 --> Idle5[Idle] + MAP_U_ABORT_ind --> IST_Neg_Response4[IST Command negative response] + IST_Neg_Response4 --> Idle6[Idle] + +``` + +State transition diagram for process IST\_Command\_HLR. The process starts at an initial state, goes to Idle, then receives an IST Command. It sends MAP\_OPEN\_req, MAP\_IST\_COMMAND\_req, and MAP\_DELIMITER\_req, then receives Open\_Cnf. If OK, it goes to Wait\_For\_MSC\_Response. If Vr, Error, it sends an IST Command negative response and returns to Idle. From Wait\_For\_MSC\_Response, it can receive MAP\_IST\_COMMAND\_cnf, MAP\_NOTICE\_ind, or an empty box. MAP\_IST\_COMMAND\_cnf leads to Check\_Confirmation. If OK, it sends an IST Command ack and returns to Idle. If User Error, Provider Error, or Data Error, it sends an IST Command negative response and returns to Idle. MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req. An empty box leads to a box with MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. Both lead to IST Command negative response and return to Idle. + +2744 + +2745 + +Figure 21.9/5: Process IST\_Command\_HLR + +![Sequence diagram for process IST_Command_MSC. The diagram shows the state transitions and message exchanges for handling an IST Command. It starts at an initial state, goes to Idle, receives an Open_Ind, and then branches based on the response (OK or Vr, Error). The OK path leads to Wait_For_Service_Indication, which then branches into three possible indications: MAP_P_ABORT_ind, MAP_IST_COMMAND_ind, and MAP_NOTICE_ind. The MAP_IST_COMMAND_ind path leads to an IST Command state, then Wait_For_Application_Response, which branches into IST Command ack, IST Command negative response, or a combined state with MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind. The IST Command ack path leads to a state with MAP_IST_COMMAND_rsp and MAP_CLOSE_req, which then leads to Idle. The IST Command negative response path leads to Set User Error, which then leads to the combined state. The combined state leads to Idle. The MAP_P_ABORT_ind and MAP_NOTICE_ind paths both lead to Idle states. The Vr, Error path from the initial Open_Ind also leads to Idle.](e791584696ddaa89eecf172a72ae05e9_img.jpg) + +process IST\_Command\_MSC ISTC\_MSC1(1) + +Process in the MSC to handle an IST Command from the HLR + +Signals to/from the left are to/from the call handling application process in the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Open_Ind : Receive_Open_Ind + Open_Ind --> Wait_For_Service_Indication : OK + Open_Ind --> Idle : Vr, Error + Wait_For_Service_Indication --> MAP_P_ABORT_ind : MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_IST_COMMAND_ind : MAP_IST_COMMAND_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind : MAP_NOTICE_ind + MAP_P_ABORT_ind --> Idle + MAP_IST_COMMAND_ind --> IST_Command : IST Command + IST_Command --> Wait_For_Application_Response : Wait_For_Application_Response + Wait_For_Application_Response --> Ack : IST Command ack + Wait_For_Application_Response --> Negative : IST Command negative response + Wait_For_Application_Response --> Combined : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Ack --> Rsp : MAP_IST_COMMAND_rsp, MAP_CLOSE_req + Rsp --> Idle + Negative --> Set_User_Error : Set User Error + Set_User_Error --> Combined + Combined --> Idle + MAP_NOTICE_ind --> Close_Req : MAP_CLOSE_req + Close_Req --> Idle + +``` + +Sequence diagram for process IST\_Command\_MSC. The diagram shows the state transitions and message exchanges for handling an IST Command. It starts at an initial state, goes to Idle, receives an Open\_Ind, and then branches based on the response (OK or Vr, Error). The OK path leads to Wait\_For\_Service\_Indication, which then branches into three possible indications: MAP\_P\_ABORT\_ind, MAP\_IST\_COMMAND\_ind, and MAP\_NOTICE\_ind. The MAP\_IST\_COMMAND\_ind path leads to an IST Command state, then Wait\_For\_Application\_Response, which branches into IST Command ack, IST Command negative response, or a combined state with MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind. The IST Command ack path leads to a state with MAP\_IST\_COMMAND\_rsp and MAP\_CLOSE\_req, which then leads to Idle. The IST Command negative response path leads to Set User Error, which then leads to the combined state. The combined state leads to Idle. The MAP\_P\_ABORT\_ind and MAP\_NOTICE\_ind paths both lead to Idle states. The Vr, Error path from the initial Open\_Ind also leads to Idle. + +2746 + +2747 + +Figure 21.9/6: Process IST\_Command\_MSC + +## 21.10 Resource Management + +### 21.10.1 General + +The message flow for successful release of resources is shown in figure 21.10/1. + +![Sequence diagram showing message flow for early release of resources between GMSC, HLR, and VMSC/VLR.](4286d6102bce8b0903b7ad79cd772959_img.jpg) + +The diagram is a sequence diagram with three lifelines: GMSC, HLR, and VMSC/VLR. The message flow is as follows: + +- An external message (1) is received by the GMSC. +- The GMSC sends a message (2) to the HLR. +- The HLR sends a message (3) to the VMSC/VLR. +- An external message (4) is received by the GMSC. +- The VMSC/VLR sends a message (5) to the HLR. +- The HLR sends a message (6) to the GMSC. +- The GMSC sends a message (7) to the VMSC/VLR. + +Sequence diagram showing message flow for early release of resources between GMSC, HLR, and VMSC/VLR. + +2751 + +2752 + +- 2753 1) I\_IAM (Note 1) +- 2754 2) MAP\_SEND\_ROUTING\_INFORMATION\_req/ind +- 2755 3) MAP\_PROVIDE\_ROAMING\_NUMBER\_req/ind +- 2756 4) I\_REL (Note 1) +- 2757 5) MAP\_PROVIDE\_ROAMING\_NUMBER\_rsp/cnf +- 2758 6) MAP\_SEND\_ROUTING\_INFORMATION\_rsp/cnf +- 2759 7) *MAP\_RELEASE\_RESOURCES* (Note 2) + +2760 + +2761 NOTE 1: TUP or ISUP may be used in signalling between MSCs, depending on the network type between the +2762 MSCs. For further details on the TUP and ISUP procedures refer to the following ITU-T Recommendations +2763 & ETSI specification: +2764 - Q.721-725 - Telephone User Part (TUP); +2765 - ETS 300 356-1 - Integrated Services Digital Network (ISDN); Signalling System No.7; ISDN User Part +2766 (ISUP) version 2 for the international interface; Part 1: Basic services. + +2767 + +NOTE 2: Services printed in *italics* are optional. + +2768 + +2769 + +**Figure 21.10/1: Message flow for early release of resources** + +### 21.3.2 Process in the GMSC + +2771 The MAP process in the GMSC to release resources is shown in figure 21.10/2. The MAP process invokes macros not +2772 defined in this clause; the definitions of these macros can be found as follows: + +2773 Receive\_Open\_Cnf see clause 25.1.2; + +2774 Check\_Confirmation see clause 25.2.2. + +### 21.3.3 Process in the VMSC + +2776 The MAP process in the VMSC to handle a request for the GMSC to release resources is shown in figure 21.10/3. The +2777 MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +2778 Receive\_Open\_Ind see clause 25.1.1; + +process Release\_Resources\_GMSC + +1(1) + +Process in the GMSC to request the VMSC to release resources + +Signals to/from the left are to/from the application process in the GMSC (see 3GPP TS 23.018); signals to/from the right are to/from the VMSC; + +![State transition diagram for process Release_Resources_GMSC. It starts at an initial state, goes to Idle, then Release Resources. A transition leads to a state where MAP_OPEN_req, MAPRELEASE_RESOURCES_req, and MAP_DELIMITER_req are sent. Then, Receive_Open_cnf is received. If OK, it goes to Wait_For_VMSC_Response. If Vr, Error, it goes to Idle. From Wait_For_VMSC_Response, three transitions are possible: MAP_NOTICE_ind (leading to MAP_CLOSE_req), MAP_RELEASE_RESOURCES_cnf (leading to Idle), and a transition leading to a state where MAP_P_ABORT_ind and MAP_CLOSE_req are sent. All three paths eventually lead to the Idle state.](1fc4ebd7c0ce26ca009bfb082bbe39d1_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> ReleaseResources[Release Resources] + ReleaseResources --> Out1[ ] + state " " as Out1 + Out1 --> In1[ ] + state " " as In1 + In1 --> ReceiveOpenCnf[Receive_Open_cnf] + ReceiveOpenCnf --> WaitForVMSCResponse[Wait_For_VMSC_Response] + ReceiveOpenCnf --> Idle2[Idle] + Note right of In1: MAP_OPEN_req +MAPRELEASE_RESOURCES_req +MAP_DELIMITER_req + Note right of WaitForVMSCResponse: OK + Note right of Idle2: Vr, Error + WaitForVMSCResponse --> Out2[ ] + state " " as Out2 + Out2 --> In2[ ] + state " " as In2 + In2 --> MAPNoticeInd[MAP_NOTICE_ind] + In2 --> MAPReleaseResourcesCnf[MAP_RELEASE_RESOURCES_cnf] + In2 --> Out3[ ] + state " " as Out3 + Out3 --> In3[ ] + state " " as In3 + In3 --> MAPCloseReq1[MAP_CLOSE_req] + In3 --> Idle3[Idle] + Note right of Out3: MAP_P_ABORT_ind, +MAP_CLOSE_req + MAPNoticeInd --> MAPCloseReq2[MAP_CLOSE_req] + MAPCloseReq2 --> Idle3 + MAPReleaseResourcesCnf --> Idle3 + +``` + +State transition diagram for process Release\_Resources\_GMSC. It starts at an initial state, goes to Idle, then Release Resources. A transition leads to a state where MAP\_OPEN\_req, MAPRELEASE\_RESOURCES\_req, and MAP\_DELIMITER\_req are sent. Then, Receive\_Open\_cnf is received. If OK, it goes to Wait\_For\_VMSC\_Response. If Vr, Error, it goes to Idle. From Wait\_For\_VMSC\_Response, three transitions are possible: MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req), MAP\_RELEASE\_RESOURCES\_cnf (leading to Idle), and a transition leading to a state where MAP\_P\_ABORT\_ind and MAP\_CLOSE\_req are sent. All three paths eventually lead to the Idle state. + +2779 +2780 + +Figure 21.10/2: Process Release Resources\_GMSC + +process Release\_Resources\_VMSC + +1(1) + +Process in the VMSC to handle a request to release resources + +Signals to/from the left are to/from the GMSC; signals to/from the right are to/from the application process in the VMSC (see 3GPP TS 23.018) + +![State transition diagram for process Release_Resources_VMSC. It starts at an initial state, goes to Idle, then receives an Open_ind. From there, it branches based on OK or Vr, Error. The OK path leads to Wait_For_Service_Indication, which then branches into three paths: MAP_P_ABORT_ind (leading to Idle), a central path with MAP_RELEASE_RESOURCES_ind, Release Resources, Wait-For_Call_Handling_Response, Release Resources Ack, and finally Idle; and a right path with MAP_NOTICE_ind, MAP_CLOSE_req, and Idle. The Vr, Error path from the initial branch leads to Idle. The central path also includes a 'Set Error' block and a response message block (MAP_RELEASE_RESOURCES_rsp, MAP_CLOSE_req) before reaching the final Idle state.](16e669d3add13913a04db9fd11cb1834_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --> Wait_For_Service_Indication[Wait_For_Service_Indication] + Receive_Open_ind --> Idle2[Idle] : Vr, Error + Wait_For_Service_Indication --> MAP_P_ABORT_ind[/MAP_P_ABORT_ind/] + Wait_For_Service_Indication --> MAP_RELEASE_RESOURCES_ind[MAP_RELEASE_RESOURCES_ind] + Wait_For_Service_Indication --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + MAP_P_ABORT_ind --> Idle3[Idle] + MAP_RELEASE_RESOURCES_ind --> Release_Resources[/Release Resources/] + Release_Resources --> Wait-For_Call_Handling_Response[Wait-For_Call_Handling_Response] + Wait-For_Call_Handling_Response --> Release_Resources_Ack[/Release Resources Ack/] + Wait-For_Call_Handling_Response --> Release_Resources_Negative_Response[/Release Resources negative response/] + Release_Resources_Negative_Response --> Set_Error[Set Error] + Set_Error --> MAP_RELEASE_RESOURCES_rsp[MAP_RELEASE_RESOURCES_rsp] + Set_Error --> MAP_CLOSE_req[MAP_CLOSE_req] + Release_Resources_Ack --> Idle4[Idle] + MAP_RELEASE_RESOURCES_rsp --> Idle4 + MAP_CLOSE_req --> Idle4 + MAP_NOTICE_ind --> MAP_CLOSE_req2[/MAP_CLOSE_req/] + MAP_CLOSE_req2 --> Idle5[Idle] + +``` + +State transition diagram for process Release\_Resources\_VMSC. It starts at an initial state, goes to Idle, then receives an Open\_ind. From there, it branches based on OK or Vr, Error. The OK path leads to Wait\_For\_Service\_Indication, which then branches into three paths: MAP\_P\_ABORT\_ind (leading to Idle), a central path with MAP\_RELEASE\_RESOURCES\_ind, Release Resources, Wait-For\_Call\_Handling\_Response, Release Resources Ack, and finally Idle; and a right path with MAP\_NOTICE\_ind, MAP\_CLOSE\_req, and Idle. The Vr, Error path from the initial branch leads to Idle. The central path also includes a 'Set Error' block and a response message block (MAP\_RELEASE\_RESOURCES\_rsp, MAP\_CLOSE\_req) before reaching the final Idle state. + +2781 + +2782 + +Figure 21.10/3: Process Release Resources\_VMSC + +--- + +## 22 Supplementary services procedures + +### 22.1 Supplementary service co-ordinator processes + +#### 22.1.1 Supplementary service co-ordinator process for the MSC + +The co-ordinator process in the MSC to handle a CM connection request with CM service type Supplementary service activation is shown in figure 22.1/1. The process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +Process\_Access\_Request\_MSC see clause 25.4.1. + +#### 22.1.2 Void + +#### 22.1.3 Functional supplementary service co-ordinator process for the HLR + +The MAP co-ordinator process in the HLR to handle a dialogue opened with the networkFunctionalSS application context is shown in figure 22.1/3. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1. + +#### 22.1.4 Call completion supplementary service co-ordinator process for the HLR + +The MAP co-ordinator process in the HLR to handle a dialogue opened with the callCompletion application context is shown in figure 22.1/4. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1. + +![Flowchart of process SS_Coordinator_MSC. It starts with an initial node, followed by 'Null', then 'A_CM_SERV_REQ' (CM Service type = Supplementary service activation), then 'Process_Access_Request_MSC'. From there, an 'OK' path leads to 'Wait_For_Service_Indication' and an 'Error' path leads to 'Null'. 'Wait_For_Service_Indication' branches into six parallel paths: 1. A_REGISTER_SS_ind -> Register_SS_MSC -> A_REGISTER_SS_ind; 2. A_ERASE_SS_ind -> Erase_SS_MSC -> A_ERASE_SS_ind; 3. A_ACTIVATE_SS_ind -> Activate_SS_MSC -> A_ACTIVATE_SS_ind; 4. A_DEACTIVATE_SS_ind -> Deactivate_SS_MSC -> A_DEACTIVATE_SS_ind; 5. A_INTERROGATE_SS_ind -> Interrogate_SS_MSC -> A_INTERROGATE_SS_ind; 6. A_REGISTER_PASSWORD_ind (From interworking function; see 3GPP TS 29.011) -> Register_Password_MSC -> A_REGISTER_PASSWORD_ind. All six paths converge to a final 'Relay_Info' node.](bdedf1de83edcaaff55b513dc0e077c5_img.jpg) + +process SS\_Coordinator\_MSC SSC\_MSC1(2) + +Supplementary service co-ordinating process in the MSC + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the child process unless shown otherwise + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> CM_REQ{A_CM_SERV_REQ} + CM_REQ --- CM_Type[CM Service type= Supplementary service activation] + CM_REQ --> ProcessAccess[Process_Access_Request_MSC] + ProcessAccess -- OK --> WaitForInd[Wait_For_Service_Indication] + ProcessAccess -- Error --> Null2([Null]) + WaitForInd --> RegisterInd{A_REGISTER_SS_ind} + WaitForInd --> EraseInd{A_ERASE_SS_ind} + WaitForInd --> ActivateInd{A_ACTIVATE_SS_ind} + WaitForInd --> DeactivateInd{A_DEACTIVATE_SS_ind} + WaitForInd --> InterrogateInd{A_INTERROGATE_SS_ind} + WaitForInd --> RegisterPasswordInd{A_REGISTER_PASSWORD_ind} + RegisterInd --> RegisterMSC[Register_SS_MSC] + RegisterMSC --> RegisterOut{A_REGISTER_SS_ind} + EraseInd --> EraseMSC[Erase_SS_MSC] + EraseMSC --> EraseOut{A_ERASE_SS_ind} + ActivateInd --> ActivateMSC[Activate_SS_MSC] + ActivateMSC --> ActivateOut{A_ACTIVATE_SS_ind} + DeactivateInd --> DeactivateMSC[Deactivate_SS_MSC] + DeactivateMSC --> DeactivateOut{A_DEACTIVATE_SS_ind} + InterrogateInd --> InterrogateMSC[Interrogate_SS_MSC] + InterrogateMSC --> InterrogateOut{A_INTERROGATE_SS_ind} + RegisterPasswordInd --- PasswordNote[From interworking function; see 3GPP TS 29.011] + RegisterPasswordInd --> RegisterPasswordMSC[Register_Password_MSC] + RegisterPasswordMSC --> RegisterPasswordOut{A_REGISTER_PASSWORD_ind} + RegisterOut --> RelayInfo([Relay_Info]) + EraseOut --> RelayInfo + ActivateOut --> RelayInfo + DeactivateOut --> RelayInfo + InterrogateOut --> RelayInfo + RegisterPasswordOut --> RelayInfo + +``` + +Flowchart of process SS\_Coordinator\_MSC. It starts with an initial node, followed by 'Null', then 'A\_CM\_SERV\_REQ' (CM Service type = Supplementary service activation), then 'Process\_Access\_Request\_MSC'. From there, an 'OK' path leads to 'Wait\_For\_Service\_Indication' and an 'Error' path leads to 'Null'. 'Wait\_For\_Service\_Indication' branches into six parallel paths: 1. A\_REGISTER\_SS\_ind -> Register\_SS\_MSC -> A\_REGISTER\_SS\_ind; 2. A\_ERASE\_SS\_ind -> Erase\_SS\_MSC -> A\_ERASE\_SS\_ind; 3. A\_ACTIVATE\_SS\_ind -> Activate\_SS\_MSC -> A\_ACTIVATE\_SS\_ind; 4. A\_DEACTIVATE\_SS\_ind -> Deactivate\_SS\_MSC -> A\_DEACTIVATE\_SS\_ind; 5. A\_INTERROGATE\_SS\_ind -> Interrogate\_SS\_MSC -> A\_INTERROGATE\_SS\_ind; 6. A\_REGISTER\_PASSWORD\_ind (From interworking function; see 3GPP TS 29.011) -> Register\_Password\_MSC -> A\_REGISTER\_PASSWORD\_ind. All six paths converge to a final 'Relay\_Info' node. + +2802 + +2803 + +Figure 22.1/1 (sheet 1 of 2): Process SS\_Coordinator\_MSC + +![Sequence diagram for process SS_Coordinator_MSC. The diagram shows the flow of signals and messages within the process. It starts with 'Wait_For_Service_Indication' leading to three parallel branches. The first branch involves 'A_CM_SERV_RELEASE_ind', 'MAP_U_ABORT_req' (leading to 'Application procedure cancellation'), 'A_CM_RELEASE_COMPLETE_req', and 'Null'. The second branch involves 'A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind', 'MS_Init_USSD_MSC', 'A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind', and 'Relay_Info'. The third branch involves an unlabeled merge node, 'A_CM_RELEASE_req', and 'Null'. All three branches converge to a second set of parallel branches. The first sub-branch has 'A_REL', 'A_REL', and 'Null'. The second sub-branch has an unlabeled merge node, an unlabeled message, and 'Relay_Info'. The third sub-branch has 'A_REL', 'A_REL', and 'Null'. The fourth sub-branch has an unlabeled merge node, an unlabeled message, and 'Relay_Info'.](4239623dc3aa0e3e90a1a7574869c9c6_img.jpg) + +process SS\_Coordinator\_MSC SSC\_MSC2(2) + +Supplementary service co-ordinating process in the MSC + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the child process + +MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind + +``` + +sequenceDiagram + participant Wait_For_Service_Indication + Note left of Wait_For_Service_Indication: Supplementary service co-ordinating process in the MSC + Note right of Wait_For_Service_Indication: Signals to/from the left are to/from the MS; signals to/from the right are to/from the child process + Note right of Wait_For_Service_Indication: MAP_U_ABORT_ind, MAP_CLOSE_ind + + Wait_For_Service_Indication --> A_CM_SERV_RELEASE_ind + Wait_For_Service_Indication --> A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind + Wait_For_Service_Indication --> Merge1(( )) + + A_CM_SERV_RELEASE_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Application_procedure_cancellation[Application procedure cancellation] + Application_procedure_cancellation --> A_CM_RELEASE_COMPLETE_req + A_CM_RELEASE_COMPLETE_req --> Null1(Null) + + A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind --> MS_Init_USSD_MSC + MS_Init_USSD_MSC --> A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind2[A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind] + A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind2 --> Relay_Info1(Relay_Info) + + Merge1 --> A_CM_RELEASE_req1[A_CM_RELEASE_req] + A_CM_RELEASE_req1 --> Null2(Null) + + Null1 --> Merge2(( )) + Relay_Info1 --> Merge2 + Null2 --> Merge2 + + Merge2 --> A_REL1[A_REL] + Merge2 --> Merge3(( )) + Merge2 --> A_REL2[A_REL] + Merge2 --> Merge4(( )) + + A_REL1 --> A_REL1_msg[A_REL] + A_REL1_msg --> Null3(Null) + + Merge3 --> Merge3_msg[-] + Merge3_msg --> Relay_Info2(Relay_Info) + + A_REL2 --> A_REL2_msg[A_REL] + A_REL2_msg --> Null4(Null) + + Merge4 --> Merge4_msg[-] + Merge4_msg --> Relay_Info3(Relay_Info) + +``` + +Sequence diagram for process SS\_Coordinator\_MSC. The diagram shows the flow of signals and messages within the process. It starts with 'Wait\_For\_Service\_Indication' leading to three parallel branches. The first branch involves 'A\_CM\_SERV\_RELEASE\_ind', 'MAP\_U\_ABORT\_req' (leading to 'Application procedure cancellation'), 'A\_CM\_RELEASE\_COMPLETE\_req', and 'Null'. The second branch involves 'A\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_ind', 'MS\_Init\_USSD\_MSC', 'A\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_ind', and 'Relay\_Info'. The third branch involves an unlabeled merge node, 'A\_CM\_RELEASE\_req', and 'Null'. All three branches converge to a second set of parallel branches. The first sub-branch has 'A\_REL', 'A\_REL', and 'Null'. The second sub-branch has an unlabeled merge node, an unlabeled message, and 'Relay\_Info'. The third sub-branch has 'A\_REL', 'A\_REL', and 'Null'. The fourth sub-branch has an unlabeled merge node, an unlabeled message, and 'Relay\_Info'. + +2804 + +2805 + +Figure 22.1/1 (sheet 2 of 2): Process SS\_Coordinator\_MSC + +2806 + +Figure 22.1/2 void + +![Flowchart for process SS_Coordinator_HLR. It starts with a Null state, followed by Receive_Open_Ind. A decision point 'OK' leads to Wait_For_Service_Indication, which then branches into six parallel MAP operations: REGISTER, ERASE, ACTIVATE, DEACTIVATE, INTERROGATE, and REGISTER PASSWORD. These lead to a Relay_Info state. From Relay_Info, it branches into four paths: one with MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind leading to Null; one with a '*' symbol leading to Relay_Info; one with MAP_U_ABORT_req, MAP_CLOSE_req leading to Null; and one with a '-' symbol leading to Relay_Info. All four paths converge to a Wait_For_Service_Indication state, which then branches into MAP_NOTICE_ind and MAP_CLOSE_req leading to Null, and another path with MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind leading to Null.](26f743627a63ee4e129d3afd6ba69c6c_img.jpg) + +**process SS\_Coordinator\_HLR** **SSC\_HLR1(1)** + +Supplementary service co-ordinating process in the HLR + +Signals to/from the left are to/from the VLR; +signals to/from the right are to/from the child process + +``` + + graph TD + Start([Null]) --> RecOpen[Receive_Open_Ind] + RecOpen --> Decision1{ } + Decision1 -- Error --> Null1([Null]) + Decision1 -- OK --> WaitF1[Wait_For_Service_Indication] + Decision1 -- Vr --> PerformMAP[Perform MAP Vr dialogue] + PerformMAP --> Null2([Null]) + + WaitF1 --> MAP_REG[MAP_REGISTER_SS_ind] + WaitF1 --> MAP_ERASE[MAP_ERASE_SS_ind] + WaitF1 --> MAP_ACTIVATE[MAP_ACTIVATE_SS_ind] + WaitF1 --> MAP_DEACTIVATE[MAP_DEACTIVATE_SS_ind] + WaitF1 --> MAP_INTERROGATE[MAP_INTERROGATE_SS_ind] + WaitF1 --> MAP_REG_PWD[MAP_REGISTER_PASSWORD_ind] + + MAP_REG --> RegHLR[Register_SS_HLR] + MAP_ERASE --> EraseHLR[Erase_SS_HLR] + MAP_ACTIVATE --> ActivateHLR[Activate_SS_HLR] + MAP_DEACTIVATE --> DeactivateHLR[Deactivate_SS_HLR] + MAP_INTERROGATE --> InterrogateHLR[Interrogate_SS_HLR] + MAP_REG_PWD --> RegPwdHLR[Register_Password_HLR] + + RegHLR --> MAP_REG_OUT[MAP_REGISTER_SS_ind] + EraseHLR --> MAP_ERASE_OUT[MAP_ERASE_SS_ind] + ActivateHLR --> MAP_ACTIVATE_OUT[MAP_ACTIVATE_SS_ind] + DeactivateHLR --> MAP_DEACTIVATE_OUT[MAP_DEACTIVATE_SS_ind] + InterrogateHLR --> MAP_INTERROGATE_OUT[MAP_INTERROGATE_SS_ind] + RegPwdHLR --> MAP_REG_PWD_OUT[MAP_REGISTER_PASSWORD_ind] + + MAP_REG_OUT --> RelayInfo1[Relay_Info] + MAP_ERASE_OUT --> RelayInfo1 + MAP_ACTIVATE_OUT --> RelayInfo1 + MAP_DEACTIVATE_OUT --> RelayInfo1 + MAP_INTERROGATE_OUT --> RelayInfo1 + MAP_REG_PWD_OUT --> RelayInfo1 + + RelayInfo1 --> MAP_P_ABORT[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + MAP_P_ABORT --> Null3([Null]) + + RelayInfo1 --> Star[*] + Star --> Null4([Null]) + + RelayInfo1 --> MAP_U_ABORT[MAP_U_ABORT_req, MAP_CLOSE_req] + MAP_U_ABORT --> Null5([Null]) + + RelayInfo1 --> Dash[-] + Dash --> Null6([Null]) + + Null3 --> WaitF2[Wait_For_Service_Indication] + Null4 --> WaitF2 + Null5 --> WaitF2 + Null6 --> WaitF2 + + WaitF2 --> MAP_NOTICE[MAP_NOTICE_ind] + MAP_NOTICE --> MAP_CLOSE[MAP_CLOSE_req] + MAP_CLOSE --> Null7([Null]) + + WaitF2 --> MAP_P_ABORT2[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + MAP_P_ABORT2 --> Null8([Null]) + +``` + +Flowchart for process SS\_Coordinator\_HLR. It starts with a Null state, followed by Receive\_Open\_Ind. A decision point 'OK' leads to Wait\_For\_Service\_Indication, which then branches into six parallel MAP operations: REGISTER, ERASE, ACTIVATE, DEACTIVATE, INTERROGATE, and REGISTER PASSWORD. These lead to a Relay\_Info state. From Relay\_Info, it branches into four paths: one with MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind leading to Null; one with a '\*' symbol leading to Relay\_Info; one with MAP\_U\_ABORT\_req, MAP\_CLOSE\_req leading to Null; and one with a '-' symbol leading to Relay\_Info. All four paths converge to a Wait\_For\_Service\_Indication state, which then branches into MAP\_NOTICE\_ind and MAP\_CLOSE\_req leading to Null, and another path with MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind leading to Null. + +2807 + +2808 + +Figure 22.1/3: Process SS\_Coordinator\_HLR + +![Flowchart for process CC_Coordinator_HLR. It starts with an initial state leading to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', an 'OK' path leads to 'Wait_For_Service_Indication' and a 'Vr, Error' path leads to 'Null'. 'Wait_For_Service_Indication' branches into four paths: 1) 'MAP_REGISTER_CC_ENTRY_ind' -> 'Register_CC_Entry_HLR' -> 'MAP_REGISTER_CC_ENTRY_ind' -> 'Relay_Info'; 2) 'MAP_ERASE_CC_ENTRY_ind' -> 'Erase_CC_Entry_HLR' -> 'MAP_ERASE_CC_ENTRY_ind' -> 'Relay_Info'; 3) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Null'; 4) an unlabeled path leading to a box with 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' -> 'Null'. All four paths converge to a 'Relay_Info' state. From 'Relay_Info', four paths emerge: 1) an unlabeled path -> a box with 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' -> a box with '-' -> 'Null'; 2) a path with '*' -> a box with '-' -> 'Relay_Info'; 3) a path with '-' -> a box with '-' -> 'Null'; 4) a path with '*' -> a box with 'MAP_U_ABORT_req, MAP_CLOSE_req' -> a box with '-' -> 'Relay_Info'.](c70920fb7053af492e6b0a7f14ce0ccd_img.jpg) + +**process CC\_Coordinator\_HLR** **CCC\_HLR1(1)** + +Call Completion co-ordinating process in the HLR + +Signals to/from the left are to/from the VLR; + signals to/from the right are to/from the child process + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- OK --> Wait_For_Service_Indication([Wait_For_Service_Indication]) + Receive_Open_Ind -- "Vr, Error" --> Null2([Null]) + + Wait_For_Service_Indication --> MAP_REGISTER_CC_ENTRY_ind[/MAP_REGISTER_CC_ENTRY_ind/] + Wait_For_Service_Indication --> MAP_ERASE_CC_ENTRY_ind[/MAP_ERASE_CC_ENTRY_ind/] + Wait_For_Service_Indication --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + + MAP_REGISTER_CC_ENTRY_ind --> Register_CC_Entry_HLR[Register_CC_Entry_HLR] + Register_CC_Entry_HLR --> MAP_REGISTER_CC_ENTRY_ind2[/MAP_REGISTER_CC_ENTRY_ind/] + + MAP_ERASE_CC_ENTRY_ind --> Erase_CC_Entry_HLR[Erase_CC_Entry_HLR] + Erase_CC_Entry_HLR --> MAP_ERASE_CC_ENTRY_ind2[/MAP_ERASE_CC_ENTRY_ind/] + + MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req} + + MAP_CLOSE_req --> Null3([Null]) + + MAP_CLOSE_req --> Unlabeled1[ ] + Unlabeled1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + + MAP_REGISTER_CC_ENTRY_ind2 --> Relay_Info1([Relay_Info]) + MAP_ERASE_CC_ENTRY_ind2 --> Relay_Info1 + + Relay_Info1 --> Unlabeled2[ ] + Unlabeled2 --> MAP_P_ABORT_ind2[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + + Relay_Info1 --> Star1[*] + Star1 --> Dash1[ ] + + Relay_Info1 --> Dash2[ ] + + Relay_Info1 --> Star2[*] + Star2 --> MAP_U_ABORT_req[MAP_U_ABORT_req, MAP_CLOSE_req] + + MAP_P_ABORT_ind2 --> Dash3[ ] + Dash3 --> Null4([Null]) + + Dash1 --> Dash4[ ] + Dash4 --> Relay_Info2([Relay_Info]) + + Dash2 --> Dash5[ ] + Dash5 --> Null5([Null]) + + MAP_U_ABORT_req --> Dash6[ ] + Dash6 --> Relay_Info3([Relay_Info]) + +``` + +Flowchart for process CC\_Coordinator\_HLR. It starts with an initial state leading to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Indication' and a 'Vr, Error' path leads to 'Null'. 'Wait\_For\_Service\_Indication' branches into four paths: 1) 'MAP\_REGISTER\_CC\_ENTRY\_ind' -> 'Register\_CC\_Entry\_HLR' -> 'MAP\_REGISTER\_CC\_ENTRY\_ind' -> 'Relay\_Info'; 2) 'MAP\_ERASE\_CC\_ENTRY\_ind' -> 'Erase\_CC\_Entry\_HLR' -> 'MAP\_ERASE\_CC\_ENTRY\_ind' -> 'Relay\_Info'; 3) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Null'; 4) an unlabeled path leading to a box with 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Null'. All four paths converge to a 'Relay\_Info' state. From 'Relay\_Info', four paths emerge: 1) an unlabeled path -> a box with 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> a box with '-' -> 'Null'; 2) a path with '\*' -> a box with '-' -> 'Relay\_Info'; 3) a path with '-' -> a box with '-' -> 'Null'; 4) a path with '\*' -> a box with 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' -> a box with '-' -> 'Relay\_Info'. + +2809 + +2810 + +**Figure 22.1/4: Process CC\_Coordinator\_HLR** + +## 22.2 Registration procedure + +### 22.2.1 General + +The registration procedure is used to register data related to a supplementary service in the HLR. The registration procedure is a fully transparent communication between the MS and the HLR, except that some services may be invoked as a result of the procedure, as described in the clauses below. + +The registration procedure is shown in figure 22.2.1/1. + +The following services may be used: + +- MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); +- MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); +- MAP\_PROVIDE\_IMSI (see clauses 8 and 25); +- MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); +- MAP\_AUTHENTICATE (see clauses 8 and 25); +- MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); +- MAP\_CHECK\_IMEI (see clauses 8 and 25); +- MAP\_READY\_FOR\_SM (see clauses 12 and 25); +- MAP\_INSERT\_SUBSCRIBER\_DATA (see clauses 8 and 25); + +The following service is certainly used: + +- MAP\_REGISTER\_SS (defined in clause 11). + +![Sequence diagram showing the registration procedure between MS, MSC, VLR, and HLR. The diagram consists of four lifelines: MS, MSC, VLR, and HLR. The sequence of messages is: 1. MS sends A_CM_SERV_REQ to MSC; 2. MSC sends MAP_PROCESS_ACCESS_REQUEST to VLR; 3. MS sends A_REGISTER_SS to MSC; 4. MSC sends MAP_REGISTER_SS_req/ind to VLR; 5. VLR sends MAP_REGISTER_SS_req/ind to HLR; 6. HLR sends MAP_REGISTER_SS_rsp/cnf to VLR; 7. VLR sends MAP_REGISTER_SS_rsp/cnf to MSC; 8. MSC sends A_REGISTER_SS ack to MS; 9. VLR sends MAP_INSERT_SUBSCRIBER_DATA_req/ind to HLR; 10. HLR sends MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf to VLR.](020a8313c255e32fd3c32d21526de441_img.jpg) + +``` + +sequenceDiagram + participant MS + participant MSC + participant VLR + participant HLR + Note left of MS: 1) A_CM_SERV_REQ (Note 1) + MS->>MSC: 1) A_CM_SERV_REQ (Note 1) + Note right of MSC: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + MSC->>VLR: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + Note left of MS: 3) A_REGISTER_SS (Note 1) + MS->>MSC: 3) A_REGISTER_SS (Note 1) + Note right of MSC: 4) MAP_REGISTER_SS_req/ind + MSC->>VLR: 4) MAP_REGISTER_SS_req/ind + Note right of VLR: 5) MAP_REGISTER_SS_req/ind + VLR->>HLR: 5) MAP_REGISTER_SS_req/ind + Note right of HLR: 6) MAP_REGISTER_SS_rsp/cnf + HLR->>VLR: 6) MAP_REGISTER_SS_rsp/cnf + Note right of VLR: 7) MAP_REGISTER_SS_rsp/cnf + VLR->>MSC: 7) MAP_REGISTER_SS_rsp/cnf + Note left of MSC: 8) A_REGISTER_SS ack (Note 1) + MSC->>MS: 8) A_REGISTER_SS ack (Note 1) + Note right of VLR: 9) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + VLR->>HLR: 9) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + Note right of HLR: 10) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + HLR->>VLR: 10) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + +``` + +Sequence diagram showing the registration procedure between MS, MSC, VLR, and HLR. The diagram consists of four lifelines: MS, MSC, VLR, and HLR. The sequence of messages is: 1. MS sends A\_CM\_SERV\_REQ to MSC; 2. MSC sends MAP\_PROCESS\_ACCESS\_REQUEST to VLR; 3. MS sends A\_REGISTER\_SS to MSC; 4. MSC sends MAP\_REGISTER\_SS\_req/ind to VLR; 5. VLR sends MAP\_REGISTER\_SS\_req/ind to HLR; 6. HLR sends MAP\_REGISTER\_SS\_rsp/cnf to VLR; 7. VLR sends MAP\_REGISTER\_SS\_rsp/cnf to MSC; 8. MSC sends A\_REGISTER\_SS ack to MS; 9. VLR sends MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind to HLR; 10. HLR sends MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf to VLR. + +- 1) A\_CM\_SERV\_REQ (Note 1) +- 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) +- 3) A\_REGISTER\_SS (Note 1) +- 4) MAP\_REGISTER\_SS\_req/ind +- 5) MAP\_REGISTER\_SS\_req/ind +- 6) MAP\_REGISTER\_SS\_rsp/cnf +- 7) MAP\_REGISTER\_SS\_rsp/cnf +- 8) A\_REGISTER\_SS ack (Note 1) +- 9) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind (Note 3) +- 10) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf (Note 3) + +2842 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS +2843 24.08x and 3GPP TS 24.09x. Services shown in dotted lines indicate the trigger provided by the signalling +2844 on the radio path, and the signalling triggered on the radio path. +2845 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 in the present document. +2846 NOTE 3: Services printed in *italics* are optional. +2847 +2848 **Figure 22.2.1/1: Message flow for supplementary service registration** + +## 2849 22.2.2 Procedure in the MSC + +2850 The A\_REGISTER\_SS service indication received by the MAP process in the MSC contains the SS-Code and any +2851 parameters that are related to the supplementary service. + +2852 The MAP user transfers the received information to the VLR in the MAP\_REGISTER\_SS request without checking the +2853 contents of the service indication. Rules for the mapping are described in 3GPP TS 29.011 [59]. + +2854 The information in the MAP\_REGISTER\_SS confirm from the VLR is relayed to the MS in the A\_REGISTER\_SS +2855 response message as described in 3GPP TS 24.08x, 3GPP TS 24.08x and 3GPP TS 29.011. + +2856 For call independent SS operations, each message shall contain only a single component. Messages which contain more +2857 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +2858 The registration process in the MSC is shown in figure 22.2.2/1. + +## 2859 22.2.3 Procedure in the VLR + +2860 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2861 *Receive\_Open\_Ind* see clause 25.1.1; + +2862 *Receive\_Open\_Cnf* see clause 25.1.2; + +2863 *Check Confirmation* see clause 25.2.2; + +2864 *Process\_Access\_Request\_VLR* see clause 25.4.2. + +2865 The MAP process in the VLR transfers the information received in the MAP\_REGISTER\_SS indication to the HLR in +2866 the MAP\_REGISTER\_SS request without checking the contents. The MAP\_OPEN request includes the IMSI of the +2867 subscriber as the destination reference and the VLR number as the originating reference. + +2868 If the MAP\_REGISTER\_SS confirm is properly formed and contains a result or a user error, the MAP process in the +2869 VLR shall transfer the information contained in this primitive to the MSC in the MAP\_REGISTER\_SS response. + +2870 For call independent SS operations, each message shall contain only a single component. Messages which contain more +2871 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +2872 The registration process in the VLR is shown in figure 22.2.3/1. + +## 2873 22.2.4 Procedure in the HLR + +2874 The MAP process invokes a macro and a process not defined in this clause; the definitions of the macro and process can +2875 be found as follows: + +2876 *Check\_Indication* see clause 25.2.1; + +2877 *Insert\_Subs\_Data\_Stand\_Alone\_HLR* see clause 25.7.3. + +2878 The supplementary service request shall be processed according to 3GPP TS 23.011 [22] and the 23.08x and 23.09x- +2879 series of technical specifications. This handling may lead to a successful result, a partially successful result or an error +2880 being returned. + +2881 For call independent SS operations, each message shall contain only a single component. Messages which contain more +2882 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +2883 The registration process in the HLR is shown in figure 22.2.4/1. + +![SDL diagram for process Register_SS_MSC. It shows state transitions and signal exchanges between the MSC and VLR for supplementary service registration. Key states include 'Null' and 'Wait_For_Register_SS_Confirm'. Signals include A_REGISTER_SS_ind, MAP_REGISTER_SS_req, MAP_REGISTER_SS_cnf, and various abort/release signals.](570c644e6b2f2bdf49ec9e1b4eb4b626_img.jpg) + +**process Register\_SS\_MSC** **RSS\_MSC1(1)** + +Process in the MSC to handle a request to register data for a supplementary service + +Signals to/from the left are to/from the SS co-ordinating process in the MSC; signals to/from the right are to/from the VLR + + + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> A_CM_SERV_RELEASE_ind_1{A_CM_SERV_RELEASE_ind} + Null --> A_REGISTER_SS_ind_1{A_REGISTER_SS_ind} + Null --> MAP_ABORT_CLOSE_ind_1{MAP_U_ABORT_ind, +MAP_CLOSE_ind} + + A_CM_SERV_RELEASE_ind_1 --> MAP_U_ABORT_req_1[/MAP_U_ABORT_req/] + MAP_U_ABORT_req_1 -- Application procedure cancellation --> A_CM_RELEASE_COMPLETE_req_1[/A_CM_RELEASE_COMPLETE_req/] + A_CM_RELEASE_COMPLETE_req_1 --> Term1((X)) + + A_REGISTER_SS_ind_1 --> MAP_REG_DELIM_req[/MAP_REGISTER_SS_req, +MAP_DELIMITER_req/] + MAP_REG_DELIM_req --> Wait_For_SS_Confirm[Wait_For_Register_SS_Confirm] + + MAP_ABORT_CLOSE_ind_1 --> A_CM_RELEASE_req_1[/A_CM_RELEASE_req/] + A_CM_RELEASE_req_1 --> Term2((X)) + + Wait_For_SS_Confirm --> A_CM_SERV_RELEASE_ind_2{A_CM_SERV_RELEASE_ind} + Wait_For_SS_Confirm --> MAP_REGISTER_SS_cnf_1{MAP_REGISTER_SS_cnf} + Wait_For_SS_Confirm --> MAP_ABORT_CLOSE_ind_2{MAP_U_ABORT_ind, +MAP_CLOSE_ind} + + A_CM_SERV_RELEASE_ind_2 --> MAP_U_ABORT_req_2[/MAP_U_ABORT_req/] + MAP_U_ABORT_req_2 -- Application procedure cancellation --> A_CM_RELEASE_COMPLETE_req_2[/A_CM_RELEASE_COMPLETE_req/] + A_CM_RELEASE_COMPLETE_req_2 --> Term3((X)) + + MAP_REGISTER_SS_cnf_1 --> A_REG_SS_rsp_RELEASE_req[/A_REGISTER_SS_rsp, +A_CM_RELEASE_req/] + A_REG_SS_rsp_RELEASE_req --> Term4((X)) + + MAP_ABORT_CLOSE_ind_2 --> A_CM_RELEASE_req_2[/A_CM_RELEASE_req/] + A_CM_RELEASE_req_2 --> Term5((X)) + +``` + +SDL diagram for process Register\_SS\_MSC. It shows state transitions and signal exchanges between the MSC and VLR for supplementary service registration. Key states include 'Null' and 'Wait\_For\_Register\_SS\_Confirm'. Signals include A\_REGISTER\_SS\_ind, MAP\_REGISTER\_SS\_req, MAP\_REGISTER\_SS\_cnf, and various abort/release signals. + +2884 + +2885 + +Figure 22.2.2/1: Process Register\_SS\_MSC + +![Flowchart for process Register_SS_VLR. The process starts at an oval, goes to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', 'OK' leads to 'Wait_For_PAR' and 'Vr, Error' leads to 'Null'. 'Wait_For_PAR' leads to a junction. One path goes left to a chevron, then 'MAP_U_ABORT_ind, MAP_CLOSE_ind', then 'Null'. The other path goes right to 'Process_Access_Request_VLR'. From 'Process_Access_Request_VLR', 'OK' leads to 'Wait_For_Register_SS_Request' and 'Error' leads to 'Null'. 'Wait_For_Register_SS_Request' leads to 'MAP_REGISTER_SS_ind'. 'MAP_REGISTER_SS_ind' leads to a junction. One path goes right to 'MAP_OPEN_req, MAP_REGISTER_SS_req, MAP_DELIMITER_req', then to 'Receive_Open_Cnf'. 'Receive_Open_Cnf' has three outputs: 'Error' leads to 'MAP_U_ABORT_req' then 'Null'; 'OK' leads to 'Wait_For_Register_SS_Confirm'; 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'.](ad98c332aee74f5ad3f274a2b22dfee5_img.jpg) + +**process Register\_SS\_VLR** **RSS\_VLR1(2)** + +Process in the VLR to handle a request to register data for a supplementary service + +Signals to/from the left are to/from the MSC; +signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- "OK" --> Wait_For_PAR([Wait_For_PAR]) + Receive_Open_Ind -- "Vr, Error" --> Null2([Null]) + Wait_For_PAR --> Junction1(( )) + Junction1 --> Chevron1{ } + Chevron1 --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_CLOSE_ind] + MAP_U_ABORT_ind --> Null3([Null]) + Junction1 --> Process_Access_Request_VLR[Process_Access_Request_VLR] + Process_Access_Request_VLR -- "OK" --> Wait_For_Register_SS_Request([Wait_For_Register_SS_Request]) + Process_Access_Request_VLR -- "Error" --> Null4([Null]) + Wait_For_Register_SS_Request --> MAP_REGISTER_SS_ind[MAP_REGISTER_SS_ind] + MAP_REGISTER_SS_ind --> Junction2(( )) + Junction2 --> MAP_OPEN_req[MAP_OPEN_req, MAP_REGISTER_SS_req, MAP_DELIMITER_req] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- "Error" --> MAP_U_ABORT_req{MAP_U_ABORT_req} + MAP_U_ABORT_req --> Null5([Null]) + Receive_Open_Cnf -- "OK" --> Wait_For_Register_SS_Confirm([Wait_For_Register_SS_Confirm]) + Receive_Open_Cnf -- "Vr" --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null6([Null]) + +``` + +Flowchart for process Register\_SS\_VLR. The process starts at an oval, goes to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', 'OK' leads to 'Wait\_For\_PAR' and 'Vr, Error' leads to 'Null'. 'Wait\_For\_PAR' leads to a junction. One path goes left to a chevron, then 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind', then 'Null'. The other path goes right to 'Process\_Access\_Request\_VLR'. From 'Process\_Access\_Request\_VLR', 'OK' leads to 'Wait\_For\_Register\_SS\_Request' and 'Error' leads to 'Null'. 'Wait\_For\_Register\_SS\_Request' leads to 'MAP\_REGISTER\_SS\_ind'. 'MAP\_REGISTER\_SS\_ind' leads to a junction. One path goes right to 'MAP\_OPEN\_req, MAP\_REGISTER\_SS\_req, MAP\_DELIMITER\_req', then to 'Receive\_Open\_Cnf'. 'Receive\_Open\_Cnf' has three outputs: 'Error' leads to 'MAP\_U\_ABORT\_req' then 'Null'; 'OK' leads to 'Wait\_For\_Register\_SS\_Confirm'; 'Vr' leads to 'Perform MAP Vr dialogue' then 'Null'. + +2886 + +2887 + +**Figure 22.2.3/1 (sheet 1 of 2): Process Register\_SS\_VLR** + +![State transition diagram for process Register_SS_VLR. It starts at 'Wait_For_Register_SS_Confirm' and branches into four main paths based on incoming indications: MAP_U_ABORT_ind/MAP_CLOSE_ind, MAP_REGISTER_SS_cnf, MAP_NOTICE_ind, and MAP_P_ABORT_ind/MAP_U_ABORT_ind/MAP_CLOSE_ind. Each path leads to specific requests and eventually to a 'Null' state.](c620ea4d9898d79f8c56cbe446f91bd4_img.jpg) + +**process Register\_SS\_VLR** **RSS\_VLR2(2)** + +Process in the VLR to handle a request to register data for a supplementary service + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Register_SS_Confirm + state "Wait_For_Register_SS_Confirm" as Wait_For_Register_SS_Confirm + state "Null" as Null + state "Check_Confirmation" as Check_Confirmation + state "MAP_REGISTER_SS_rsp / MAP_CLOSE_req" as MAP_REGISTER_SS_rsp_MAP_CLOSE_req + + Wait_For_Register_SS_Confirm --> MAP_U_ABORT_ind_in + Wait_For_Register_SS_Confirm --> MAP_REGISTER_SS_cnf_in + Wait_For_Register_SS_Confirm --> MAP_NOTICE_ind_in + Wait_For_Register_SS_Confirm --> MAP_P_ABORT_ind_in + + state "MAP_U_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind_in + state "MAP_REGISTER_SS_cnf" as MAP_REGISTER_SS_cnf_in + state "MAP_NOTICE_ind" as MAP_NOTICE_ind_in + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as MAP_P_ABORT_ind_in + + MAP_U_ABORT_ind_in --> MAP_U_ABORT_req + MAP_REGISTER_SS_cnf_in --> Check_Confirmation + MAP_NOTICE_ind_in --> MAP_CLOSE_req + MAP_P_ABORT_ind_in --> MAP_U_ABORT_req + + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "MAP_CLOSE_req" as MAP_CLOSE_req + + Check_Confirmation --> OK_User_Error_Data_Error + Check_Confirmation --> Provider_Error + + state "OK, User Error, Data Error" as OK_User_Error_Data_Error + state "Provider Error" as Provider_Error + + OK_User_Error_Data_Error --> MAP_REGISTER_SS_rsp_MAP_CLOSE_req + Provider_Error --> MAP_U_ABORT_req + + MAP_U_ABORT_req --> Null + MAP_REGISTER_SS_rsp_MAP_CLOSE_req --> Null + MAP_CLOSE_req --> Null + +``` + +State transition diagram for process Register\_SS\_VLR. It starts at 'Wait\_For\_Register\_SS\_Confirm' and branches into four main paths based on incoming indications: MAP\_U\_ABORT\_ind/MAP\_CLOSE\_ind, MAP\_REGISTER\_SS\_cnf, MAP\_NOTICE\_ind, and MAP\_P\_ABORT\_ind/MAP\_U\_ABORT\_ind/MAP\_CLOSE\_ind. Each path leads to specific requests and eventually to a 'Null' state. + +2888 + +2889 + +Figure 22.2.3/1 (sheet 2 of 2): Process Register\_SS\_VLR + +![Flowchart for process Register_SS_HLR. It starts with an oval, followed by a 'Null' block, then 'MAP_REGISTER_SS_ind'. A decision 'OK' leads to 'Check_Indication'. From 'Check_Indication', 'Yes' leads to 'Operator Determined Barring of SS management?' and 'No' leads to 'SS request'. 'Operator Determined Barring of SS management?' leads to 'Set User Error: Call barred' and 'Call barring cause= Operator barring', which then lead to 'MAP_REGISTER_SS_rsp' and 'MAP_CLOSE_req'. 'SS request' leads to 'Wait_For_Application_Response'. From 'Wait_For_Application_Response', five paths emerge: 'acknowledge', 'partial acceptance', 'error', 'MAP_NOTICE_ind', and an unlabeled path leading to 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind'. 'acknowledge', 'partial acceptance', and 'error' lead to 'Set Result', 'Set User Error', and 'MAP_U_ABORT_req' respectively. 'MAP_NOTICE_ind' leads to 'MAP_U_ABORT_req'. All three lead to a merge point. From the merge point, 'MAP_REGISTER_SS_rsp' and 'MAP_CLOSE_req' are sent. A decision 'Update of subs data required in VLR?' follows. 'Yes' leads to 'Insert Subs_Data Stand_Alone_HLR'. Both 'No' and 'Insert Subs_Data Stand_Alone_HLR' lead to an exit point marked with an 'X'. There are also exit points marked with 'X' on the left and right sides of the diagram.](15907527acdc7018da2e4a290405cb8a_img.jpg) + +**process Register\_SS\_HLR** **RSS\_HLR1(1)** + +Process in the HLR to handle a request to register data for a supplementary service + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the process SS\_REQUEST\_WITH\_BS\_GROUP (see 3GPP TS 23.011) + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> MAP_REGISTER_SS_ind[/MAP_REGISTER_SS_ind/] + MAP_REGISTER_SS_ind --> Check_Indication[Check_Indication] + Check_Indication -- Yes --> Operator_Determined[Operator Determined Barring of SS management?] + Check_Indication -- No --> SS_request[/SS request/] + + Operator_Determined --> Set_User_Error[Set User Error: Call barred] + Set_User_Error --> Call_barring_cause[Call barring cause= Operator barring] + + SS_request --> Wait_For_Application_Response[Wait_For_Application_Response] + + Wait_For_Application_Response -- acknowledge --> Set_Result[Set Result] + Wait_For_Application_Response -- partial acceptance --> Set_Result + Wait_For_Application_Response -- error --> Set_User_Error_2[Set User Error] + Wait_For_Application_Response -- MAP_NOTICE_ind[/MAP_NOTICE_ind/] --> MAP_U_ABORT_req[/MAP_U_ABORT_req/] + + Set_Result --> Merge1(( )) + Set_User_Error_2 --> Merge1 + MAP_U_ABORT_req --> Merge1 + + Merge1 --> MAP_REGISTER_SS_rsp[MAP_REGISTER_SS_rsp] + Merge1 --> MAP_CLOSE_req[MAP_CLOSE_req] + + MAP_REGISTER_SS_rsp --> Update_of_subs_data{Update of subs data required in VLR?} + MAP_CLOSE_req --> Update_of_subs_data + + Update_of_subs_data -- Yes --> Insert_Subs_Data[Insert Subs_Data Stand_Alone_HLR] + + Insert_Subs_Data --> Exit1((X)) + Update_of_subs_data -- No --> Exit1 + + Exit2((X)) --> MAP_REGISTER_SS_rsp + MAP_REGISTER_SS_rsp --> Exit2 + + MAP_P_ABORT_ind[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] --> Exit3((X)) + +``` + +Flowchart for process Register\_SS\_HLR. It starts with an oval, followed by a 'Null' block, then 'MAP\_REGISTER\_SS\_ind'. A decision 'OK' leads to 'Check\_Indication'. From 'Check\_Indication', 'Yes' leads to 'Operator Determined Barring of SS management?' and 'No' leads to 'SS request'. 'Operator Determined Barring of SS management?' leads to 'Set User Error: Call barred' and 'Call barring cause= Operator barring', which then lead to 'MAP\_REGISTER\_SS\_rsp' and 'MAP\_CLOSE\_req'. 'SS request' leads to 'Wait\_For\_Application\_Response'. From 'Wait\_For\_Application\_Response', five paths emerge: 'acknowledge', 'partial acceptance', 'error', 'MAP\_NOTICE\_ind', and an unlabeled path leading to 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. 'acknowledge', 'partial acceptance', and 'error' lead to 'Set Result', 'Set User Error', and 'MAP\_U\_ABORT\_req' respectively. 'MAP\_NOTICE\_ind' leads to 'MAP\_U\_ABORT\_req'. All three lead to a merge point. From the merge point, 'MAP\_REGISTER\_SS\_rsp' and 'MAP\_CLOSE\_req' are sent. A decision 'Update of subs data required in VLR?' follows. 'Yes' leads to 'Insert Subs\_Data Stand\_Alone\_HLR'. Both 'No' and 'Insert Subs\_Data Stand\_Alone\_HLR' lead to an exit point marked with an 'X'. There are also exit points marked with 'X' on the left and right sides of the diagram. + +2890 + +2891 + +Figure 22.2.4/1: Process Register\_SS\_HLR + +## 22.3 Erasure procedure + +### 22.3.1 General + +The erasure procedure is used to erase data related to a supplementary service in the HLR. The erasure procedure is a fully transparent communication between the MS and the HLR, except that some services may be invoked as a result of the procedure, as described in the clauses below. + +The erasure procedure is shown in figure 22.3.1/1. + +The following services may be used: + +- MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); +- MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); +- MAP\_PROVIDE\_IMSI (see clauses 8 and 25); +- MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); +- MAP\_AUTHENTICATE (see clauses 8 and 25); +- MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); +- MAP\_CHECK\_IMEI (see clauses 8 and 25); +- MAP\_READY\_FOR\_SM (see clauses 12 and 25); +- MAP\_INSERT\_SUBSCRIBER\_DATA (see clauses 8 and 25); + +The following service is certainly used: + +- MAP\_ERASE\_SS (defined in clause 11). + +![Sequence diagram showing the erasure procedure between MS, MSC, VLR, and HLR. The diagram consists of four vertical lifelines: MS, MSC, VLR, and HLR. The sequence of messages is as follows: 1) MS sends A_CM_SERV_REQ to MSC; 2) MSC sends MAP_PROCESS_ACCESS_REQUEST to VLR; 3) MS sends A_ERASE_SS to MSC; 4) MSC sends MAP_ERASE_SS_req/ind to VLR; 5) VLR sends MAP_ERASE_SS_req/ind to HLR; 6) HLR sends MAP_ERASE_SS_rsp/cnf to VLR; 7) VLR sends MAP_ERASE_SS_rsp/cnf to MSC; 8) MSC sends A_ERASE_SS ack to MS; 9) VLR sends MAP_INSERT_SUBSCRIBER_DATA_req/ind to HLR; 10) HLR sends MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf to VLR.](009bd9eab25edaa72970a496fba6c755_img.jpg) + +``` + +sequenceDiagram + participant MS + participant MSC + participant VLR + participant HLR + Note left of MS: 1) A_CM_SERV_REQ (Note 1) + MS->>MSC: 1) A_CM_SERV_REQ (Note 1) + Note right of MSC: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + MSC->>VLR: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + Note left of MS: 3) A_ERASE_SS (Note 1) + MS->>MSC: 3) A_ERASE_SS (Note 1) + Note right of MSC: 4) MAP_ERASE_SS_req/ind + MSC->>VLR: 4) MAP_ERASE_SS_req/ind + Note right of VLR: 5) MAP_ERASE_SS_req/ind + VLR->>HLR: 5) MAP_ERASE_SS_req/ind + Note right of HLR: 6) MAP_ERASE_SS_rsp/cnf + HLR->>VLR: 6) MAP_ERASE_SS_rsp/cnf + Note right of VLR: 7) MAP_ERASE_SS_rsp/cnf + VLR->>MSC: 7) MAP_ERASE_SS_rsp/cnf + Note left of MSC: 8) A_ERASE_SS ack (Note 1) + MSC->>MS: 8) A_ERASE_SS ack (Note 1) + Note right of VLR: 9) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + VLR->>HLR: 9) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + Note right of HLR: 10) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + HLR->>VLR: 10) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + +``` + +Sequence diagram showing the erasure procedure between MS, MSC, VLR, and HLR. The diagram consists of four vertical lifelines: MS, MSC, VLR, and HLR. The sequence of messages is as follows: 1) MS sends A\_CM\_SERV\_REQ to MSC; 2) MSC sends MAP\_PROCESS\_ACCESS\_REQUEST to VLR; 3) MS sends A\_ERASE\_SS to MSC; 4) MSC sends MAP\_ERASE\_SS\_req/ind to VLR; 5) VLR sends MAP\_ERASE\_SS\_req/ind to HLR; 6) HLR sends MAP\_ERASE\_SS\_rsp/cnf to VLR; 7) VLR sends MAP\_ERASE\_SS\_rsp/cnf to MSC; 8) MSC sends A\_ERASE\_SS ack to MS; 9) VLR sends MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind to HLR; 10) HLR sends MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf to VLR. + +- 1) A\_CM\_SERV\_REQ (Note 1) +- 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) +- 3) A\_ERASE\_SS (Note 1) +- 4) MAP\_ERASE\_SS\_req/ind +- 5) MAP\_ERASE\_SS\_req/ind +- 6) MAP\_ERASE\_SS\_rsp/cnf +- 7) MAP\_ERASE\_SS\_rsp/cnf +- 8) A\_ERASE\_SS ack (Note 1) +- 9) MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind (Note 3) +- 10) MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf (Note 3) + +2923 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS +2924 24.08x and 3GPP TS 24.09x. Services shown in dotted lines indicate the trigger provided by the signalling +2925 on the radio path, and the signalling triggered on the radio path. +2926 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 in the present document. +2927 NOTE 3: Services printed in *italics* are optional. +2928 +2929 **Figure 22.3.1/1: Message flow for supplementary service erasure** + +## 2930 22.3.2 Procedure in the MSC + +2931 The MSC procedure for erasure is identical to that specified for registration in clause 22.2.2. The text and diagrams in +2932 clause 22.2.2 apply with all references to registration changed to erasure. + +## 2933 22.3.3 Procedure in the VLR + +2934 The VLR procedure for erasure is identical to that specified for registration in clause 22.2.3. The text and diagrams in +2935 clause 22.2.3 apply with all references to registration changed to erasure. + +## 2936 22.3.4 Procedure in the HLR + +2937 The HLR procedure for erasure is identical to that specified for registration in clause 22.2.4. The text and diagrams in +2938 clause 22.2.4 apply with all references to registration changed to erasure. + +# 2939 22.4 Activation procedure + +## 2940 22.4.1 General + +2941 The activation procedure is used to activate a supplementary service in the HLR. The activation procedure is a fully +2942 transparent communication between the MS and the HLR, except that some services may be invoked as a result of the +2943 procedure, as described in the clauses below. + +2944 The activation procedure is shown in figure 22.4.1/1. + +2945 The following services may be used: + +2946 MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); +2947 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); +2948 MAP\_PROVIDE\_IMSI (see clauses 8 and 25); +2949 MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); +2950 MAP\_AUTHENTICATE (see clauses 8 and 25); +2951 MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); +2952 MAP\_CHECK\_IMEI (see clauses 8 and 25); +2953 MAP\_READY\_FOR\_SM (see clauses 12 and 25); +2954 MAP\_GET\_PASSWORD (defined in clause 11); +2955 MAP\_INSERT\_SUBSCRIBER\_DATA (see clauses 8 and 25); + +2956 The following service is certainly used: + +2957 MAP\_ACTIVATE\_SS (defined in clause 11). + +![Sequence diagram showing message flow for supplementary service activation between MS, MSC, VLR, and HLR. The diagram includes 16 numbered messages. Solid lines represent optional MAP messages, while dashed lines represent mandatory A messages. The sequence starts with MS sending A_CM_SERV_REQ to MSC, followed by MSC sending MAP_PROCESS_ACCESS_REQUEST to VLR. The process continues with various activation and password-related messages between the entities.](e3514230081b133d75e94b4fb40b04e0_img.jpg) + +``` + +sequenceDiagram + participant MS + participant MSC + participant VLR + participant HLR + + Note left of MS: 1) A_CM_SERV_REQ (Note 1) + MS-->>MSC: 1) A_CM_SERV_REQ (Note 1) + Note right of MSC: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + MSC->>VLR: 2) MAP_PROCESS_ACCESS_REQUEST (Note 2) + Note left of MSC: 3) A_ACTIVATE_SS (Note 1) + MSC-->>MS: 3) A_ACTIVATE_SS (Note 1) + Note right of VLR: 4) MAP_ACTIVATE_SS_req/ind + VLR->>MSC: 4) MAP_ACTIVATE_SS_req/ind + Note right of MSC: 5) MAP_ACTIVATE_SS_req/ind + MSC->>HLR: 5) MAP_ACTIVATE_SS_req/ind + Note right of HLR: 6) MAP_GET_PASSWORD_req/ind (Note 3) + HLR->>VLR: 6) MAP_GET_PASSWORD_req/ind (Note 3) + Note right of VLR: 7) MAP_GET_PASSWORD_req/ind (Note 3) + VLR->>MSC: 7) MAP_GET_PASSWORD_req/ind (Note 3) + Note left of MSC: 8) A_GET_PASSWORD (Note 1, Note 3) + MSC-->>MS: 8) A_GET_PASSWORD (Note 1, Note 3) + Note left of MS: 9) A_GET_PASSWORD ack (Note 1, Note 3) + MS-->>MSC: 9) A_GET_PASSWORD ack (Note 1, Note 3) + Note right of MSC: 10) MAP_GET_PASSWORD_rsp/cnf (Note 3) + MSC->>VLR: 10) MAP_GET_PASSWORD_rsp/cnf (Note 3) + Note right of VLR: 11) MAP_GET_PASSWORD_rsp/cnf (Note 3) + VLR->>HLR: 11) MAP_GET_PASSWORD_rsp/cnf (Note 3) + Note right of HLR: 12) MAP_ACTIVATE_SS_rsp/cnf + HLR->>VLR: 12) MAP_ACTIVATE_SS_rsp/cnf + Note right of VLR: 13) MAP_ACTIVATE_SS_rsp/cnf + VLR->>MSC: 13) MAP_ACTIVATE_SS_rsp/cnf + Note left of MSC: 14) A_ACTIVATE_SS ack (Note 1) + MSC-->>MS: 14) A_ACTIVATE_SS ack (Note 1) + Note right of MSC: 15) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + MSC->>VLR: 15) MAP_INSERT_SUBSCRIBER_DATA_req/ind (Note 3) + Note right of VLR: 16) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + VLR->>HLR: 16) MAP_INSERT_SUBSCRIBER_DATA_rsp/cnf (Note 3) + +``` + +Sequence diagram showing message flow for supplementary service activation between MS, MSC, VLR, and HLR. The diagram includes 16 numbered messages. Solid lines represent optional MAP messages, while dashed lines represent mandatory A messages. The sequence starts with MS sending A\_CM\_SERV\_REQ to MSC, followed by MSC sending MAP\_PROCESS\_ACCESS\_REQUEST to VLR. The process continues with various activation and password-related messages between the entities. + +2958 + +2959 + +- 2960 1) A\_CM\_SERV\_REQ (Note 1) +- 2961 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) +- 2962 3) A\_ACTIVATE\_SS (Note 1) +- 2963 4) MAP\_ACTIVATE\_SS\_req/ind +- 2964 5) MAP\_ACTIVATE\_SS\_req/ind +- 2965 6) *MAP\_GET\_PASSWORD\_req/ind* (Note 3) +- 2966 7) *MAP\_GET\_PASSWORD\_req/ind* (Note 3) +- 2967 8) A\_GET\_PASSWORD (Note 1, Note 3) +- 2968 9) *A\_GET\_PASSWORD ack* (Note 1, Note 3) +- 2969 10) *MAP\_GET\_PASSWORD\_rsp/cnf* (Note 3) +- 2970 11) *MAP\_GET\_PASSWORD\_rsp/cnf* (Note 3) +- 2971 12) MAP\_ACTIVATE\_SS\_rsp/cnf +- 2972 13) MAP\_ACTIVATE\_SS\_rsp/cnf +- 2973 14) A\_ACTIVATE\_SS ack (Note 1) +- 2974 15) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind* (Note 3) +- 2975 16) *MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf* (Note 3) + +2976 + +2977 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS + 2978 24.08x and 3GPP TS 24.09x. Services shown in dotted lines indicate the trigger provided by the signalling + 2979 on the radio path, and the signalling triggered on the radio path. + +2980 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 of this document. + +2981 NOTE 3: Services printed in *italics* are optional. + +2982 + +2983 + +**Figure 22.4.1/1: Message flow for supplementary service activation** + +## 2984 22.4.2 Procedure in the MSC + +2985 The A\_ACTIVATE\_SS service indication received by the MAP user in the MSC contains the SS-Code and any + 2986 parameters related to the supplementary service. + +2987 The MSC transfers the received information to the VLR in the MAP\_ACTIVATE\_SS request without checking the + 2988 contents of the service indication. Rules for the mapping are described in 3GPP TS 29.011 [59]. + +2989 The information in the MAP\_ACTIVATE\_SS confirm from the VLR is relayed to the MS in the A\_ACTIVATE\_SS + 2990 response message, as described in TS 24.08x, 3GPP TS 24.08x and 3GPP TS 29.011. + +2991 For call independent SS operations, each message shall contain only a single component. Messages which contain more + 2992 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +2993 The activation process in the MSC is shown in figure 22.4.2/1. + +### 2994 22.4.3 Procedure in the VLR + +2995 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +2996     Receive\_Open\_Ind       see clause 25.1.1; + +2997     Receive\_Open\_Cnf       see clause 25.1.2; + +2998     Check\_Confirmation      see clause 25.2.2; + +2999     Process\_Access\_Request\_VLR see clause 25.4.2. + +3000 The MAP process in the VLR transfers the information received in the MAP\_ACTIVATE\_SS indication to the HLR in +3001 the MAP\_ACTIVATE\_SS request without checking the contents. The MAP\_OPEN request includes the IMSI of the +3002 subscriber as the destination reference and the VLR number as the originating reference. + +3003 If the MAP\_REGISTER\_SS confirm is properly formed and contains a result or a user error, the MAP process in the +3004 VLR shall transfer the information contained in this primitive to the MSC in the MAP\_ACTIVATE\_SS response. + +3005 For call independent SS operations, each message shall contain only a single component. Messages which contain more +3006 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +3007 The activation process in the VLR is shown in figure 22.4.3/1. + +### 3008 22.4.4 Procedure in the HLR + +3009 The MAP process invokes a macro and a process not defined in this clause; the definitions of the macro and process can +3010 be found as follows: + +3011     Check\_Indication           see clause 25.2.1; + +3012     Insert\_Subs\_Data\_Stand\_Alone\_HLR see clause 25.7.3. + +3013 The supplementary service request shall be processed according to 3GPP TS 23.011 [22] and the 23.08x and 23.09x- +3014 series of technical specifications. This handling may lead to a successful result, a partially successful result or an error +3015 being returned. + +3016 For call independent SS operations, each message shall contain only a single component. Messages which contain more +3017 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +3018 The activation process in the HLR is shown in figure 22.4.4/1. + +![State transition diagram for process Activate_SS_MSC. It starts at a 'Null' state and branches into three main paths. The left path handles release/abort signals. The middle path handles activation signals, leading to a 'Wait_For_Activate_SS_Confirm' state. The right path handles close/abort signals. From the activation wait state, it branches into three sub-paths: release/abort, activation response, and password handling. The password path leads to a 'Get_Password_MSC' block with 'Null' and 'OK' outcomes.](3dbe2da229eb652369eb63de9975139e_img.jpg) + +**process Activate\_SS\_MSC** **ASS\_MSC1(1)** + +Process in the MSC to handle a request to activate a supplementary service + +Signals to/from the left are to/from the SS co-ordinating process in the MSC; signals to/from the right are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> Null + Null --> A_CM_SERV_RELEASE_ind + Null --> A_ACTIVATE_SS_ind + Null --> MAP_U_ABORT_ind_MAP_CLOSE_ind + + state "A_CM_SERV_RELEASE_ind" as A_CM_SERV_RELEASE_ind + A_CM_SERV_RELEASE_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Application_procedure_cancellation + Application_procedure_cancellation --> A_CM_RELEASE_COMPLETE_req + A_CM_RELEASE_COMPLETE_req --> [*] + + state "A_ACTIVATE_SS_ind" as A_ACTIVATE_SS_ind + A_ACTIVATE_SS_ind --> MAP_ACTIVATE_SS_req_MAP_DELIMITER_req + MAP_ACTIVATE_SS_req_MAP_DELIMITER_req --> Wait_For_Activate_SS_Confirm + Wait_For_Activate_SS_Confirm --> A_CM_SERV_RELEASE_ind + Wait_For_Activate_SS_Confirm --> MAP_ACTIVATE_SS_cnf + Wait_For_Activate_SS_Confirm --> Get_Password_MSC + Wait_For_Activate_SS_Confirm --> MAP_U_ABORT_ind_MAP_CLOSE_ind + + state "MAP_ACTIVATE_SS_cnf" as MAP_ACTIVATE_SS_cnf + MAP_ACTIVATE_SS_cnf --> A_ACTIVATE_SS_rsp_A_CM_RELEASE_req + A_ACTIVATE_SS_rsp_A_CM_RELEASE_req --> [*] + + state "Get_Password_MSC" as Get_Password_MSC + Get_Password_MSC --> Null + Get_Password_MSC --> OK + OK --> Wait_For_SS_Confirm + Wait_For_SS_Confirm --> [*] + + state "MAP_U_ABORT_ind_MAP_CLOSE_ind" as MAP_U_ABORT_ind_MAP_CLOSE_ind + MAP_U_ABORT_ind_MAP_CLOSE_ind --> A_CM_RELEASE_req + A_CM_RELEASE_req --> [*] + +``` + +State transition diagram for process Activate\_SS\_MSC. It starts at a 'Null' state and branches into three main paths. The left path handles release/abort signals. The middle path handles activation signals, leading to a 'Wait\_For\_Activate\_SS\_Confirm' state. The right path handles close/abort signals. From the activation wait state, it branches into three sub-paths: release/abort, activation response, and password handling. The password path leads to a 'Get\_Password\_MSC' block with 'Null' and 'OK' outcomes. + +3019 + +3020 + +Figure 22.4.2/1: Process Activate\_SS\_MSC + +![Flowchart for process Activate_SS_VLR. The process starts at an oval, goes to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', 'OK' leads to 'Wait_For_PAR' and 'Vr, Error' leads to 'Null'. 'Wait_For_PAR' leads to a junction. One path from the junction goes left through a chevron to 'Null', with a box 'MAP_U_ABORT_ind, MAP_CLOSE_ind' above it. The other path goes right to 'Process_Access_Request_VLR'. From 'Process_Access_Request_VLR', 'OK' leads to 'Wait_For_Activate_SS_Request' and 'Error' leads to 'Null'. 'Wait_For_Activate_SS_Request' leads to a chevron 'MAP_ACTIVATE_SS_ind'. This leads to another junction. A box to the right of this junction contains 'MAP_OPEN_req', 'MAP_ACTIVATE_SS_req', and 'MAP_DELIMITER_req'. The main path continues down to 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', 'Error' leads to a decision 'MAP_U_ABORT_req' which leads to 'Null'. 'OK' leads to 'Wait_For_Activate_SS_Confirm'. 'Vr' leads to 'Perform MAP Vr dialogue' which leads to 'Null'.](a014601c1ffe7fbee64d9b81187c4d86_img.jpg) + +**process Activate\_SS\_VLR** **ASS\_VLR1(2)** + +Process in the VLR to handle a request to activate a supplementary service + +Signals to/from the left are to/from the MSC; +signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- "OK" --> Wait_For_PAR([Wait_For_PAR]) + Receive_Open_Ind -- "Vr, Error" --> Null2([Null]) + Wait_For_PAR --> Junction1(( )) + Junction1 -- "MAP_U_ABORT_ind, MAP_CLOSE_ind" --> Null3([Null]) + Junction1 --> Process_Access_Request_VLR[Process_Access_Request_VLR] + Process_Access_Request_VLR -- "OK" --> Wait_For_Activate_SS_Request([Wait_For_Activate_SS_Request]) + Process_Access_Request_VLR -- "Error" --> Null4([Null]) + Wait_For_Activate_SS_Request --> MAP_ACTIVATE_SS_ind[/MAP_ACTIVATE_SS_ind/] + MAP_ACTIVATE_SS_ind --> Junction2(( )) + Junction2 -- "MAP_OPEN_req +MAP_ACTIVATE_SS_req +MAP_DELIMITER_req" --> Null5([Null]) + Junction2 --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- "Error" --> MAP_U_ABORT_req{MAP_U_ABORT_req} + MAP_U_ABORT_req --> Null6([Null]) + Receive_Open_Cnf -- "OK" --> Wait_For_Activate_SS_Confirm([Wait_For_Activate_SS_Confirm]) + Receive_Open_Cnf -- "Vr" --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null7([Null]) + +``` + +Flowchart for process Activate\_SS\_VLR. The process starts at an oval, goes to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', 'OK' leads to 'Wait\_For\_PAR' and 'Vr, Error' leads to 'Null'. 'Wait\_For\_PAR' leads to a junction. One path from the junction goes left through a chevron to 'Null', with a box 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' above it. The other path goes right to 'Process\_Access\_Request\_VLR'. From 'Process\_Access\_Request\_VLR', 'OK' leads to 'Wait\_For\_Activate\_SS\_Request' and 'Error' leads to 'Null'. 'Wait\_For\_Activate\_SS\_Request' leads to a chevron 'MAP\_ACTIVATE\_SS\_ind'. This leads to another junction. A box to the right of this junction contains 'MAP\_OPEN\_req', 'MAP\_ACTIVATE\_SS\_req', and 'MAP\_DELIMITER\_req'. The main path continues down to 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', 'Error' leads to a decision 'MAP\_U\_ABORT\_req' which leads to 'Null'. 'OK' leads to 'Wait\_For\_Activate\_SS\_Confirm'. 'Vr' leads to 'Perform MAP Vr dialogue' which leads to 'Null'. + +3021 + +3022 + +Figure 22.4.3/1 (sheet 1 of 2): Process Activate\_SS\_VLR + +![State transition diagram for process Activate_SS_VLR. It shows two main state machines. The top one starts in 'Wait_For_Activate_SS_Confirm' and handles 'MAP_U_ABORT_ind, MAP_CLOSE_ind', 'MAP_ACTIVATE_SS_cnf', 'MAP_NOTICE_ind', and 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind'. The bottom one starts in 'Wait_For_Activate_SS_Confirm', calls 'Get_Password_VLR', and then either returns to 'Wait_For_Activate_SS_Confirm' on 'OK' or goes to 'Null' on 'Null'.](6818896c78f403ee74f560a89f9e4e69_img.jpg) + +**process Activate\_SS\_VLR** **ASS\_VLR2(2)** + +Process in the VLR to handle a request to activate a supplementary service + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> W1: Wait_For_Activate_SS_Confirm + W1 --> S1: MAP_U_ABORT_ind, MAP_CLOSE_ind + W1 --> S2: MAP_ACTIVATE_SS_cnf + W1 --> S3: MAP_NOTICE_ind + W1 --> S4: MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind + + S1 --> R1: MAP_U_ABORT_req + R1 --> Null1: Null + + S2 --> C1: Check Confirmation + C1 --> S5: OK, User Error, Data Error + C1 --> S6: Provider Error + S5 --> R2: MAP_ACTIVATE_SS_rsp, MAP_CLOSE_req + R2 --> Null2: Null + S6 --> R3: MAP_U_ABORT_req + R3 --> Null3: Null + + S3 --> R4: MAP_CLOSE_req + R4 --> R5: MAP_U_ABORT_req + R5 --> Null4: Null + + S4 --> R5 + R5 --> Null4 + + [*] --> W2: Wait_For_Activate_SS_Confirm + W2 --> G1: Get_Password_VLR + G1 --> W2: OK + G1 --> Null5: Null + +``` + +State transition diagram for process Activate\_SS\_VLR. It shows two main state machines. The top one starts in 'Wait\_For\_Activate\_SS\_Confirm' and handles 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind', 'MAP\_ACTIVATE\_SS\_cnf', 'MAP\_NOTICE\_ind', and 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. The bottom one starts in 'Wait\_For\_Activate\_SS\_Confirm', calls 'Get\_Password\_VLR', and then either returns to 'Wait\_For\_Activate\_SS\_Confirm' on 'OK' or goes to 'Null' on 'Null'. + +3023 + +3024 + +Figure 22.4.3/1 (sheet 2 of 2): Process Activate\_SS\_VLR + +![Flowchart for process Activate_SS_HLR. The process starts with an oval, followed by a 'Null' block. It then receives a 'MAP_ACTIVATE_SS_ind' signal. A 'Check Indication' block follows. If 'OK', it checks 'Operator Determined Barring of SS management?'. If 'Yes', it sets a user error 'Call barred' with cause 'Operator barring' and sends 'MAP_ACTIVATE_SS_rsp' and 'MAP_CLOSE_req' signals. If 'No', it sends an 'SS request' and waits for an application response. The response can be 'acknowledge', 'partial acceptance', 'error', or 'MAP_NOTICE_ind'. 'acknowledge' and 'partial acceptance' lead to 'Set Result'. 'error' leads to 'Set User Error'. 'MAP_NOTICE_ind' leads to 'MAP_U_ABORT_req'. All three paths lead to a common merge point. From there, it sends 'MAP_ACTIVATE_SS_rsp' and 'MAP_CLOSE_req' signals. A decision 'Update of subs data required in VLR?' follows. If 'Yes', it performs 'Insert Subs Data Stand Alone_HLR'. Finally, it reaches connector '1'.](76e7ce06af53fb17b6207582a43218d0_img.jpg) + +**process Activate\_SS\_HLR** **ASS\_HLR1(2)** + +Process in the HLR to handle a request to activate a supplementary service + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the process SS\_REQUEST\_WITH\_BS\_GROUP (see 3GPP TS 23.011) + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> In1{{MAP_ACTIVATE_SS_ind}} + In1 --> Check[Check Indication] + Check -- OK --> Decision1{Operator Determined Barring of SS management?} + Decision1 -- Yes --> SetError1[Set User Error: Call barred] + SetError1 --> Cause[Call barring cause=Operator barring] + Cause --> Out1{{MAP_ACTIVATE_SS_rsp +MAP_CLOSE_req}} + Out1 -- Error --> End1((X)) + Decision1 -- No --> In2{{SS request}} + In2 --> Wait[Wait_For_Application_Response] + Wait --> Acknowledge{{acknowledge}} + Wait --> PartialAcceptance{{partial acceptance}} + Wait --> Error2{{error}} + Wait --> NoticeInd{{MAP_NOTICE_ind}} + Acknowledge --> SetResult[Set Result] + Error2 --> SetError2[Set User Error] + NoticeInd --> AbortReq{{MAP_U_ABORT_req}} + SetResult --> Merge1(( )) + SetError2 --> Merge1 + AbortReq --> Merge1 + Merge1 --> Out2{{MAP_ACTIVATE_SS_rsp +MAP_CLOSE_req}} + Out2 --> Decision2{Update of subs data required in VLR?} + Decision2 -- Yes --> InsertData[Insert Subs Data Stand Alone_HLR] + InsertData --> Merge2(( )) + Decision2 -- No --> Merge2 + Merge2 --> End2((1)) + +``` + +Flowchart for process Activate\_SS\_HLR. The process starts with an oval, followed by a 'Null' block. It then receives a 'MAP\_ACTIVATE\_SS\_ind' signal. A 'Check Indication' block follows. If 'OK', it checks 'Operator Determined Barring of SS management?'. If 'Yes', it sets a user error 'Call barred' with cause 'Operator barring' and sends 'MAP\_ACTIVATE\_SS\_rsp' and 'MAP\_CLOSE\_req' signals. If 'No', it sends an 'SS request' and waits for an application response. The response can be 'acknowledge', 'partial acceptance', 'error', or 'MAP\_NOTICE\_ind'. 'acknowledge' and 'partial acceptance' lead to 'Set Result'. 'error' leads to 'Set User Error'. 'MAP\_NOTICE\_ind' leads to 'MAP\_U\_ABORT\_req'. All three paths lead to a common merge point. From there, it sends 'MAP\_ACTIVATE\_SS\_rsp' and 'MAP\_CLOSE\_req' signals. A decision 'Update of subs data required in VLR?' follows. If 'Yes', it performs 'Insert Subs Data Stand Alone\_HLR'. Finally, it reaches connector '1'. + +3025 + +3026 + +Figure 22.4.4/1 (sheet 1 of 2): Process Activate\_SS\_HLR + +![State transition diagram for process Activate_SS_HLR. The process starts in 'Wait_For_Application_Response', transitions to 'SS Get Password', then to a state with 'MAP_GET_PASSWORD_req' and 'MAP_DELIMITER_req'. It then enters 'Wait_For_Password'. From there, it can transition to 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and then an error state), 'MAP_GET_PASSWORD_cnf' (leading to 'Check Confirmation'), or an unlabeled state (leading to error signals and an error state). From 'Check Confirmation', 'OK, User Error' leads to 'SS Get Password_Ack' and back to 'Wait_For_Application_Response', while 'Provider Error, Data Error' leads to an error state.](bca588deb64f5309a2502fe06555eec4_img.jpg) + +**process Activate\_SS\_HLR** **ASS\_HLR2(2)** + +Process in the HLR to handle a request to activate a supplementary service + +``` + +stateDiagram-v2 + [*] --> Wait_For_Application_Response + state "Wait_For_Application_Response" as Wait_For_Application_Response + state "SS Get Password" as SS_Get_Password + state "MAP_GET_PASSWORD_req, MAP_DELIMITER_req" as MAP_GET_PASSWORD_req_MAP_DELIMITER_req + state "Wait_For_Password" as Wait_For_Password + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_GET_PASSWORD_cnf" as MAP_GET_PASSWORD_cnf + state "Check Confirmation" as Check_Confirmation + state "SS Get Password_Ack" as SS_Get_Password_Ack + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as Error_Signals + state "Error State" as [*] + + Wait_For_Application_Response --> SS_Get_Password + SS_Get_Password --> MAP_GET_PASSWORD_req_MAP_DELIMITER_req + MAP_GET_PASSWORD_req_MAP_DELIMITER_req --> Wait_For_Password + Wait_For_Password --> MAP_NOTICE_ind + Wait_For_Password --> MAP_GET_PASSWORD_cnf + Wait_For_Password --> Error_Signals + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> [*] + MAP_GET_PASSWORD_cnf --> Check_Confirmation + Check_Confirmation --> SS_Get_Password_Ack : OK, User Error + Check_Confirmation --> [*] : Provider Error, Data Error + SS_Get_Password_Ack --> Wait_For_Application_Response + +``` + +State transition diagram for process Activate\_SS\_HLR. The process starts in 'Wait\_For\_Application\_Response', transitions to 'SS Get Password', then to a state with 'MAP\_GET\_PASSWORD\_req' and 'MAP\_DELIMITER\_req'. It then enters 'Wait\_For\_Password'. From there, it can transition to 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and then an error state), 'MAP\_GET\_PASSWORD\_cnf' (leading to 'Check Confirmation'), or an unlabeled state (leading to error signals and an error state). From 'Check Confirmation', 'OK, User Error' leads to 'SS Get Password\_Ack' and back to 'Wait\_For\_Application\_Response', while 'Provider Error, Data Error' leads to an error state. + +3027 + +3028 + +**Figure 22.4.4/1 (sheet 2 of 2): Process Activate\_SS\_HLR** + +## 3029 22.5 Deactivation procedure + +### 3030 22.5.1 General + +3031 The deactivation procedure is used to deactivate a supplementary service in the HLR. The deactivation procedure is a +3032 fully transparent communication between the MS and the HLR, except that some services may be invoked as a result of +3033 the procedure, as described in the clauses below. + +3034 The deactivation procedure is shown in figure 22.5.1/1. + +3035 The following services may be used: + +- 3036 MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); +- 3037 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); +- 3038 MAP\_PROVIDE\_IMSI (see clauses 8 and 25); +- 3039 MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); +- 3040 MAP\_AUTHENTICATE (see clauses 8 and 25); +- 3041 MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); +- 3042 MAP\_CHECK\_IMEI (see clauses 8 and 25); +- 3043 MAP\_READY\_FOR\_SM (see clauses 12 and 25); +- 3044 MAP\_GET\_PASSWORD (defined in clause 11); +- 3045 MAP\_INSERT\_SUBSCRIBER\_DATA (see clauses 8 and 25); + +3046 The following service is certainly used: + +- 3047 MAP\_DEACTIVATE\_SS (defined in clause 11). + +![Sequence diagram for the deactivation procedure. Lifelines: MS, MSC, VLR, HLR. The sequence starts with the MS sending a request (1) to the MSC. The MSC then sends a request (2) to the VLR. The VLR sends a request (3) to the HLR. The HLR responds (4) to the VLR. The VLR responds (5) to the MSC. The MSC responds (6) to the MS. The MS sends a response (7) to the MSC. The MSC sends a response (8) to the VLR. The VLR sends a response (9) to the HLR. The HLR responds (10) to the VLR. The VLR responds (11) to the MSC. The MSC responds (12) to the MS. The MS sends a response (13) to the MSC. The MSC sends a response (14) to the VLR. The VLR sends a response (15) to the HLR. The HLR responds (16) to the VLR.](5a572c77a281fc60efe055dcd75215a2_img.jpg) + +``` +sequenceDiagram + participant MS + participant MSC + participant VLR + participant HLR + Note left of MS: 1) A_CM_SERV_REQ (Note 1) + MS->>MSC: 1 + MSC->>VLR: 2 + VLR->>HLR: 3 + HLR-->>VLR: 4 + VLR-->>MSC: 5 + MSC-->>MS: 6 + MS->>MSC: 7 + MSC-->>VLR: 8 + VLR-->>HLR: 9 + HLR-->>VLR: 10 + VLR-->>MSC: 11 + MSC-->>MS: 12 + MS->>MSC: 13 + MSC-->>VLR: 14 + VLR-->>HLR: 15 + HLR-->>VLR: 16 +``` + +Sequence diagram for the deactivation procedure. Lifelines: MS, MSC, VLR, HLR. The sequence starts with the MS sending a request (1) to the MSC. The MSC then sends a request (2) to the VLR. The VLR sends a request (3) to the HLR. The HLR responds (4) to the VLR. The VLR responds (5) to the MSC. The MSC responds (6) to the MS. The MS sends a response (7) to the MSC. The MSC sends a response (8) to the VLR. The VLR sends a response (9) to the HLR. The HLR responds (10) to the VLR. The VLR responds (11) to the MSC. The MSC responds (12) to the MS. The MS sends a response (13) to the MSC. The MSC sends a response (14) to the VLR. The VLR sends a response (15) to the HLR. The HLR responds (16) to the VLR. + +3048 + +- 3049 +- 3050 1) A\_CM\_SERV\_REQ (Note 1) +- 3051 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) + +3052 3) *A\_DEACTIVATE\_SS* (Note 1) +3053 4) *MAP\_DEACTIVATE\_SS\_req/ind* +3054 5) *MAP\_DEACTIVATE\_SS\_req/ind* +3055 6) *MAP\_GET\_PASSWORD\_req/ind* (Note 3) +3056 7) *MAP\_GET\_PASSWORD\_req/ind* (Note 3) +3057 8) *A\_GET\_PASSWORD* (Note 1, Note 3) +3058 9) *A\_GET\_PASSWORD\_ack* (Note 1, Note 3) +3059 10) *MAP\_GET\_PASSWORD\_rsp/cnf* (Note 3) +3060 11) *MAP\_GET\_PASSWORD\_rsp/cnf* (Note 3) +3061 12) *MAP\_DEACTIVATE\_SS\_rsp/cnf* +3062 13) *MAP\_DEACTIVATE\_SS\_rsp/cnf* +3063 14) *A\_DEACTIVATE\_SS\_ack* (Note 1) +3064 15) *MAP\_INSERT\_SUBSCRIBER\_DATA\_req/ind* (Note 3) +3065 16) *MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp/cnf* (Note 3) +3066 +3067 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS +3068 24.08x and 3GPP TS 24.09x. Services shown in dotted lines indicate the trigger provided by the signalling +3069 on the radio path, and the signalling triggered on the radio path. +3070 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 in the present document. +3071 NOTE 3: Services printed in *italics* are optional. +3072 +3073 **Figure 22.5.1/1: Message flow for supplementary service deactivation** + +## 3074 22.5.2 Procedure in the MSC + +3075 The MSC procedure for deactivation is identical to that specified for activation in clause 22.4.2. The text and diagrams +3076 in clause 22.4.2 apply with all references to activation changed to deactivation. + +## 3077 22.5.3 Procedures in the VLR + +3078 The VLR procedure for deactivation is identical to that specified for activation in clause 22.4.3. The text and diagrams +3079 in clause 22.4.3 apply with all references to activation changed to deactivation. + +## 3080 22.5.4 Procedures in the HLR + +3081 The HLR procedure for deactivation is identical to that specified for activation in clause 22.4.4. The text and diagrams +3082 in clause 22.4.4 apply with all references to activation changed to deactivation. + +# 3083 22.6 Interrogation procedure + +## 3084 22.6.1 General + +3085 The interrogation procedure is used to retrieve information related to a supplementary service from the VLR or the +3086 HLR. It is the VLR which decides whether an interrogation request should be forwarded to the HLR or not. Some non- +3087 supplementary service related services may be invoked as a result of the procedure, as described in the clauses below. + +3088 The interrogation procedure is shown in figure 22.6.1/1. + +3089 The following services may be used: + +3090 *MAP\_PROCESS\_ACCESS\_REQUEST* (see clauses 8 and 25); +3091 *MAP\_TRACE\_SUBSCRIBER\_ACTIVITY* (see clauses 9 and 25); +3092 *MAP\_PROVIDE\_IMSI* (see clauses 8 and 25); +3093 *MAP\_FORWARD\_NEW\_TMSI* (see clauses 8 and 25); +3094 *MAP\_AUTHENTICATE* (see clauses 8 and 25); +3095 *MAP\_SET\_CIPHERING\_MODE* (see clauses 8 and 25); + +3096 MAP\_CHECK\_IMEI (see clauses 8 and 25); + 3097 MAP\_READY\_FOR\_SM (see clauses 12 and 25); + 3098 The following service is certainly used: + 3099 MAP\_INTERROGATE\_SS (defined in clause 11). + +![Sequence diagram showing message flow for supplementary service interrogation between MS, MSC, VLR, and HLR. The diagram shows 8 numbered messages: 1) A_CM_SERV_REQ (dotted line MS to MSC), 2) MAP_PROCESS_ACCESS_REQUEST (solid line MSC to VLR), 3) A_INTERROGATE_SS (dotted line MS to MSC), 4) MAP_INTERROGATE_SS_req/ind (solid line MSC to VLR), 5) MAP_INTERROGATE_SS_req/ind (solid line VLR to HLR), 6) MAP_INTERROGATE_SS_rsp/cnf (solid line HLR to VLR), 7) MAP_INTERROGATE_SS_rsp/cnf (solid line VLR to MSC), 8) A_INTERROGATE_SS ack (dotted line MSC to MS).](fa2660fd2f78ad77de9acb043a931d97_img.jpg) + +Sequence diagram showing message flow for supplementary service interrogation between MS, MSC, VLR, and HLR. The diagram shows 8 numbered messages: 1) A\_CM\_SERV\_REQ (dotted line MS to MSC), 2) MAP\_PROCESS\_ACCESS\_REQUEST (solid line MSC to VLR), 3) A\_INTERROGATE\_SS (dotted line MS to MSC), 4) MAP\_INTERROGATE\_SS\_req/ind (solid line MSC to VLR), 5) MAP\_INTERROGATE\_SS\_req/ind (solid line VLR to HLR), 6) MAP\_INTERROGATE\_SS\_rsp/cnf (solid line HLR to VLR), 7) MAP\_INTERROGATE\_SS\_rsp/cnf (solid line VLR to MSC), 8) A\_INTERROGATE\_SS ack (dotted line MSC to MS). + +3100 + +3101 + 3102 1) A\_CM\_SERV\_REQ (Note 1) + 3103 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) + 3104 3) A\_INTERROGATE\_SS (Note 1) + 3105 4) MAP\_INTERROGATE\_SS\_req/ind + 3106 5) *MAP\_INTERROGATE\_SS\_req/ind* + 3107 6) *MAP\_INTERROGATE\_SS\_rsp/cnf* + 3108 7) MAP\_INTERROGATE\_SS\_rsp/cnf + 3109 8) A\_INTERROGATE\_SS ack (Note 1) + +3110 + +3111 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS + 3112 24.08x and 3GPP TS 24.09x. Services shown in dotted lines indicate the trigger provided by the signalling + 3113 on the radio path, and the signalling triggered on the radio path. + +3114 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 in the present document. + +3115 NOTE 3: Services printed in *italics* are optional. + +3116 + +3117 + +**Figure 22.6.1/1: Message flow for supplementary service interrogation** + +## 3118 22.6.2 Procedure in the MSC + +3119 The MSC procedures for interrogation are identical to those specified for registration in clause 22.2.2. The text and + 3120 diagrams in clause 22.2.2 apply with all references to registration changed to interrogation. + +## 3121 22.6.3 Procedures in the VLR + +3122 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3123 Receive\_Open\_Ind see clause 25.1.1; + 3124 Receive\_Open\_Cnf see clause 25.1.2; + 3125 Check\_Confirmation see clause 25.2.2; + 3126 Process\_Access\_Request\_VLR see clause 25.4.2. + +3127 The interrogation is answered either by the VLR or by the HLR, depending on the service interrogated. + +3128 1) **Interrogation to be handled by the VLR** + +3129 The supplementary service request shall be processed according to 3GPP TS 23.011 [22] and the 23.08x and 23.09x- +3130 series of technical specifications. This handling may lead to a successful result, a partially successful result or an error +3131 being returned. + +3132 For call independent SS operations, each message shall contain only a single component. Messages which contain more +3133 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +#### 3134 **2) Interrogation to be handled by the HLR** + +3135 If the interrogation is to be handled by the HLR, the MAP process in the VLR transfers the information received in the +3136 MAP\_INTERROGATE\_SS indication to the HLR in the MAP\_INTERROGATE\_SS request without checking the +3137 contents of the service indication. The MAP\_OPEN request includes the IMSI of the subscriber as the destination +3138 reference and the VLR number as the originating reference. + +3139 If the MAP\_INTERROGATE\_SS confirm is properly formed and contains a result or a user error, the MAP process in +3140 the VLR shall transfer the information contained in this primitive to the MSC in the MAP\_INTERROGATE\_SS +3141 response. + +3142 For call independent SS operations, each message shall contain only a single component. Messages which contain more +3143 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +3144 The Interrogation process in the VLR is shown in figure 22.6.3/1. + +### 3145 **22.6.4 Procedure in the HLR** + +3146 The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +3147 Check\_Indication see clause 25.2.1. + +3148 The HLR acts as follows: + +3149 The interrogation is answered either by the VLR or by the HLR, depending on the service interrogated. + +#### 3150 **1) Interrogation to be handled by the VLR** + +3151 If the interrogation procedure should have been answered by the VLR, then the HLR assumes that the VLR does +3152 not support the interrogated supplementary service, and returns the SS Not Available error to the VLR. + +#### 3153 **2) Interrogation to be handled by HLR** + +3154 The supplementary service request shall be processed according to 3GPP TS 23.011 [22] and the 23.08x and +3155 23.09x-series of technical specifications. This handling may lead to either a successful result or an error being +3156 returned. + +3157 For call independent SS operations, each message shall contain only a single component. Messages which contain more +3158 than one component will be stopped at the air interface (as specified in 3GPP TS 29.011 [59]). + +3159 The Interrogation process in the HLR is shown in figure 22.6.4/1. + +![Flowchart for process Interrogate_SS_VLR. It details the logic for handling supplementary service interrogation requests in the VLR, including access requests, barring checks, and determining if interrogation is handled locally or forwarded.](b58be03dfedfc48f5e785b7d59a28b53_img.jpg) + +**process Interrogate\_SS\_VLR** **ISS\_VLR1(2)** + +Processs in the VLR to handle a request to interrogate data for a supplementary service + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the process SS\_REQUEST\_WITH\_BS\_GROUP (see 3GPP TS 23.011) + +``` + + graph TD + Start([ ]) --> Null1(Null) + Null1 --> RecOpen[/Receive_Open_Ind/] + RecOpen -- OK --> WaitPAR(Wait_For_PAR) + RecOpen -- "Vr, Error" --> NullErr(Null) + + WaitPAR --> ProcAcc[Process_Access_Request_VLR] + ProcAcc -- OK --> WaitInterrog(Wait_For_Interrogate_SS_Request) + ProcAcc -- Error --> NullErr2(Null) + + %% Left side branch + WaitPAR -- "MAP_U_ABORT_ind, +MAP_CLOSE_ind" --> NullAbort(Null) + + WaitInterrog --> MAPInd[/MAP_INTERROGATE_SS_ind/] + MAPInd --> Barring{Operator Determined Barring +of SS management?} + + Barring -- Yes --> SetError[Set User Error: +Call barred] + SetError --> Cause[Call barring cause= +Operator barring] + Cause --> MAPRsp[/MAP_INTERROGATE_SS_rsp +MAP_CLOSE_req/] + MAPRsp --> NullEnd(Null) + + Barring -- No --> SSKnown{SS known?} + SSKnown -- No --> Conn1((1)) + SSKnown -- Yes --> HandleVLR{Handle interrogation +in VLR?} + + HandleVLR -- No --> Conn1 + HandleVLR -- Yes --> SSReq[/SS request/] + SSReq --> WaitApp(Wait_For_Application_Response) + +``` + +Flowchart for process Interrogate\_SS\_VLR. It details the logic for handling supplementary service interrogation requests in the VLR, including access requests, barring checks, and determining if interrogation is handled locally or forwarded. + +3160 + +3161 + +**Figure 22.6.3/1 (sheet 1 of 2): Process Interrogate\_SS\_VLR** + +![Flowchart for process Interrogate_SS_VLR. The process starts at a circle labeled '1', leading to a decision diamond. The left branch handles Error and Vr cases, leading to MAP_U_ABORT_req and Null. The right branch (OK) leads to Wait_For_Interrogate_SS_Confirm, then a decision diamond. The left sub-branch handles MAP_U_ABORT_ind and MAP_CLOSE_ind, leading to MAP_U_ABORT_req and Null. The middle sub-branch handles MAP_INTERROGATE_SS_cnf, leading to Check_Confirmation. The right sub-branch handles MAP_P_ABORT_ind, MAP_U_ABORT_ind, and MAP_CLOSE_ind, leading to MAP_NOTICE_ind and MAP_CLOSE_req. Check_Confirmation leads to a decision diamond for OK, User Error, Data Error, and Provider Error. The OK branch leads to MAP_INTERROGATE_SS_rsp and MAP_CLOSE_req, then Null. The User Error and Data Error branches lead to MAP_U_ABORT_req and Null. The Provider Error branch leads to MAP_U_ABORT_req and Null. Below this, the process continues to Wait_For_Application_Response, then a decision diamond for acknowledge, partial acceptance, and error. The acknowledge and partial acceptance branches lead to Set Result. The error branch leads to Set User Error. Both Set Result and Set User Error lead to a decision diamond for MAP_INTERROGATE_SS_rsp and MAP_CLOSE_req, which then leads to Null.](3112451876ed341b259b5f389b56723f_img.jpg) + +**process Interrogate\_SS\_VLR** **ISS\_VLR2(2)** + +Process in the VLR to handle a request to interrogate data for a supplementary service + +In the upper subtree, signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + + graph TD + Start((1)) --> Decision1{ } + Decision1 --> OpenCnf[Receive Open_Cnf] + OpenCnf --> Decision2{ } + Decision2 -- Error --> UAbortReq1[MAP_U_ABORT_req] + UAbortReq1 --> Null1([Null]) + Decision2 -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null1 + Decision2 -- OK --> WaitConfirm[Wait_For_Interrogate_SS_Confirm] + WaitConfirm --> Decision3{ } + Decision3 --> UAbortInd1[MAP_U_ABORT_ind, MAP_CLOSE_ind] + UAbortInd1 --> UAbortReq2[MAP_U_ABORT_req] + UAbortReq2 --> Null2([Null]) + Decision3 --> InterrogateCnf[MAP_INTERROGATE_SS_cnf] + InterrogateCnf --> CheckConfirm[Check_Confirmation] + CheckConfirm --> Decision4{ } + Decision4 -- "OK, User Error, Data Error" --> InterrogateRsp1[MAP_INTERROGATE_SS_rsp, MAP_CLOSE_req] + InterrogateRsp1 --> Null3([Null]) + Decision4 -- Provider Error --> UAbortReq3[MAP_U_ABORT_req] + UAbortReq3 --> Null4([Null]) + Decision3 --> PAbortInd[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + PAbortInd --> NoticeInd[MAP_NOTICE_ind] + NoticeInd --> CloseReq1[MAP_CLOSE_req] + CloseReq1 --> UAbortReq4[MAP_U_ABORT_req] + UAbortReq4 --> Null5([Null]) + Null2 --> WaitAppResp[Wait_For_Application_Response] + Null3 --> WaitAppResp + Null4 --> WaitAppResp + Null5 --> WaitAppResp + WaitAppResp --> Decision5{ } + Decision5 -- acknowledge --> SetResult[Set Result] + Decision5 -- partial acceptance --> SetResult + Decision5 -- error --> SetUserError[Set User Error] + SetResult --> Decision6{ } + SetUserError --> Decision6 + Decision6 --> InterrogateRsp2[MAP_INTERROGATE_SS_rsp, MAP_CLOSE_req] + InterrogateRsp2 --> Null6([Null]) + +``` + +In the lower subtree, signals to/from the left are to/from the MSC; signals to/from the right are to/from the process SS\_REQUEST\_WITH\_BS\_GROUP (see 3GPP TS 23.011) + +Flowchart for process Interrogate\_SS\_VLR. The process starts at a circle labeled '1', leading to a decision diamond. The left branch handles Error and Vr cases, leading to MAP\_U\_ABORT\_req and Null. The right branch (OK) leads to Wait\_For\_Interrogate\_SS\_Confirm, then a decision diamond. The left sub-branch handles MAP\_U\_ABORT\_ind and MAP\_CLOSE\_ind, leading to MAP\_U\_ABORT\_req and Null. The middle sub-branch handles MAP\_INTERROGATE\_SS\_cnf, leading to Check\_Confirmation. The right sub-branch handles MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, and MAP\_CLOSE\_ind, leading to MAP\_NOTICE\_ind and MAP\_CLOSE\_req. Check\_Confirmation leads to a decision diamond for OK, User Error, Data Error, and Provider Error. The OK branch leads to MAP\_INTERROGATE\_SS\_rsp and MAP\_CLOSE\_req, then Null. The User Error and Data Error branches lead to MAP\_U\_ABORT\_req and Null. The Provider Error branch leads to MAP\_U\_ABORT\_req and Null. Below this, the process continues to Wait\_For\_Application\_Response, then a decision diamond for acknowledge, partial acceptance, and error. The acknowledge and partial acceptance branches lead to Set Result. The error branch leads to Set User Error. Both Set Result and Set User Error lead to a decision diamond for MAP\_INTERROGATE\_SS\_rsp and MAP\_CLOSE\_req, which then leads to Null. + +3162 + +3163 + +Figure 22.6.3/1 (sheet 2 of 2): Process Interrogate\_SS\_VLR + +![Flowchart for process Interrogate_SS_HLR. It starts with 'Null', followed by 'MAP_INTERROGATE_SS_ind'. A decision diamond 'Check_Indication' leads to 'OK' or 'Error'. 'OK' leads to a decision 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' (with 'Call barring cause= Operator barring') and then to an error exit. If 'No', it goes to 'SS supported in HLR?'. If 'Yes', it goes to 'Set User Error: Unexpected data value' and then to an error exit. If 'No', it goes to 'Interrogation should be handled in VLR?'. If 'Yes', it goes to 'Set User Error: SS not available' and then to an error exit. If 'No', it goes to 'SS request' -> 'Wait_For_Application_Response'. From there, it branches into 'acknowledge' -> 'Set Result' -> 'MAP_INTERROGATE_SS_rsp' / 'MAP_CLOSE_req' -> exit; 'error' -> 'Set User Error' -> 'MAP_INTERROGATE_SS_rsp' / 'MAP_CLOSE_req' -> exit; 'MAP_NOTICE_ind' -> 'MAP_U_ABORT_req' -> exit; and an unlabeled path leading to 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' -> exit.](a40aa98acf7618b7940b8f222255c8cb_img.jpg) + +**process Interrogate\_SS\_HLR** **ISS\_HLR1(1)** + +Process in the HLR to handle a request to interrogate data for a supplementary service + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the process SS\_REQUEST\_WITH\_BS\_GROUP (see 3GPP TS 23.011) + +``` + + graph TD + Start([Null]) --> MAP_IND{MAP_INTERROGATE_SS_ind} + MAP_IND --> CHECK[Check_Indication] + CHECK -- OK --> DEC1{Operator Determined Barring of SS management?} + CHECK -- Error --> EXIT1((X)) + DEC1 -- Yes --> SET_ERR1[Set User Error: Call barred] + SET_ERR1 --> SET_ERR1_CAUSE[Call barring cause= Operator barring] + SET_ERR1_CAUSE --> EXIT1 + DEC1 -- No --> DEC2{SS supported in HLR?} + DEC2 -- Yes --> SET_ERR2[Set User Error: Unexpected data value] + SET_ERR2 --> EXIT1 + DEC2 -- No --> DEC3{Interrogation should be handled in VLR?} + DEC3 -- Yes --> SET_ERR3[Set User Error: SS not available] + SET_ERR3 --> EXIT1 + DEC3 -- No --> SS_REQ[/SS request/] + SS_REQ --> WAIT[Wait_For_Application_Response] + WAIT --> ACK[/acknowledge/] + WAIT --> ERR[/error/] + WAIT --> NOTICE[MAP_NOTICE_ind] + WAIT --> UNL[ ] + style UNL fill:none,stroke:none + ACK --> SET_RES[Set Result] + SET_RES --> RSP1[/MAP_INTERROGATE_SS_rsp / MAP_CLOSE_req/] + RSP1 --> EXIT2((X)) + ERR --> SET_ERR4[Set User Error] + SET_ERR4 --> RSP2[/MAP_INTERROGATE_SS_rsp / MAP_CLOSE_req/] + RSP2 --> EXIT3((X)) + NOTICE --> ABORT[MAP_U_ABORT_req] + ABORT --> EXIT4((X)) + UNL --> ABORT_IND[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + ABORT_IND --> EXIT5((X)) + +``` + +Flowchart for process Interrogate\_SS\_HLR. It starts with 'Null', followed by 'MAP\_INTERROGATE\_SS\_ind'. A decision diamond 'Check\_Indication' leads to 'OK' or 'Error'. 'OK' leads to a decision 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' (with 'Call barring cause= Operator barring') and then to an error exit. If 'No', it goes to 'SS supported in HLR?'. If 'Yes', it goes to 'Set User Error: Unexpected data value' and then to an error exit. If 'No', it goes to 'Interrogation should be handled in VLR?'. If 'Yes', it goes to 'Set User Error: SS not available' and then to an error exit. If 'No', it goes to 'SS request' -> 'Wait\_For\_Application\_Response'. From there, it branches into 'acknowledge' -> 'Set Result' -> 'MAP\_INTERROGATE\_SS\_rsp' / 'MAP\_CLOSE\_req' -> exit; 'error' -> 'Set User Error' -> 'MAP\_INTERROGATE\_SS\_rsp' / 'MAP\_CLOSE\_req' -> exit; 'MAP\_NOTICE\_ind' -> 'MAP\_U\_ABORT\_req' -> exit; and an unlabeled path leading to 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> exit. + +3164 + +3165 + +Figure 22.6.4/1: Process Interrogate\_SS\_HLR + +3166 **22.7 Void** + +3167 + +**Figure 22.7.2/1 void** + +3168 + +**Figure 22.7.3/1 void** + +## 3169 22.8 Password registration procedure + +### 3170 22.8.1 General + +3171 The password registration procedure is used to register a password in the HLR. The password registration procedure is a +3172 fully transparent communication between the MS and the HLR, except that some services may be invoked as a result of +3173 the procedure, as described below. + +3174 The password registration procedure is shown in figure 22.8.1/1. + +3175 The following services may be used: + +3176 MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); + +3177 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); + +3178 MAP\_PROVIDE\_IMSI (see clauses 8 and 25); + +3179 MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); + +3180 MAP\_AUTHENTICATE (see clauses 8 and 25); + +3181 MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); + +3182 MAP\_CHECK\_IMEI (see clauses 8 and 25); + +3183 MAP\_READY\_FOR\_SM (see clauses 12 and 25); + +3184 The following services are certainly used: + +3185 MAP\_REGISTER\_PASSWORD (defined in clause 11); + +3186 MAP\_GET\_PASSWORD (defined in clause 11). + +![Sequence diagram showing interactions between MS, MSC, VLR, and HLR. The diagram consists of four vertical lifelines: MS, MSC, VLR, and HLR. Messages are numbered 1 through 26. Solid arrows represent MAP and A messages, while dashed arrows represent A messages. The sequence starts with MS sending A_CM_SERV_REQ (1) to MSC. MSC then sends MAP_PROCESS_ACCESS_REQUEST (2) to VLR. VLR sends MAP_REGISTER_PASSWORD_req/ind (3) to MSC. MSC sends A_REGISTER_PASSWORD (4) to MS. MSC also sends MAP_REGISTER_PASSWORD_req/ind (5) to HLR. HLR sends MAP_GET_PASSWORD_req/ind (6) to VLR. VLR sends MAP_GET_PASSWORD_req/ind (7) to MSC. MSC sends A_GET_PASSWORD (8) to MS. MS sends A_GET_PASSWORD ack (9) to MSC. MSC sends MAP_GET_PASSWORD_rsp/cnf (10) to VLR. VLR sends MAP_GET_PASSWORD_rsp/cnf (11) to HLR. HLR sends MAP_GET_PASSWORD_req/ind (12) to VLR. VLR sends MAP_GET_PASSWORD_req/ind (13) to MSC. MSC sends A_GET_PASSWORD (14) to MS. MS sends A_GET_PASSWORD ack (15) to MSC. MSC sends MAP_GET_PASSWORD_rsp/cnf (16) to VLR. VLR sends MAP_GET_PASSWORD_rsp/cnf (17) to HLR. HLR sends MAP_GET_PASSWORD_req/ind (18) to VLR. VLR sends MAP_GET_PASSWORD_req/ind (19) to MSC. MSC sends A_GET_PASSWORD (20) to MS. MS sends A_GET_PASSWORD ack (21) to MSC. MSC sends MAP_GET_PASSWORD_rsp/cnf (22) to VLR. VLR sends MAP_GET_PASSWORD_rsp/cnf (23) to HLR. HLR sends MAP_REGISTER_PASSWORD_rsp/cnf (24) to VLR. VLR sends MAP_REGISTER_PASSWORD_rsp/cnf (25) to MSC. MSC sends A_REGISTER_PASSWORD (26) to MS.](5097b7cfd8f956654072fd7cf0fccbb3_img.jpg) + +Sequence diagram showing interactions between MS, MSC, VLR, and HLR. The diagram consists of four vertical lifelines: MS, MSC, VLR, and HLR. Messages are numbered 1 through 26. Solid arrows represent MAP and A messages, while dashed arrows represent A messages. The sequence starts with MS sending A\_CM\_SERV\_REQ (1) to MSC. MSC then sends MAP\_PROCESS\_ACCESS\_REQUEST (2) to VLR. VLR sends MAP\_REGISTER\_PASSWORD\_req/ind (3) to MSC. MSC sends A\_REGISTER\_PASSWORD (4) to MS. MSC also sends MAP\_REGISTER\_PASSWORD\_req/ind (5) to HLR. HLR sends MAP\_GET\_PASSWORD\_req/ind (6) to VLR. VLR sends MAP\_GET\_PASSWORD\_req/ind (7) to MSC. MSC sends A\_GET\_PASSWORD (8) to MS. MS sends A\_GET\_PASSWORD ack (9) to MSC. MSC sends MAP\_GET\_PASSWORD\_rsp/cnf (10) to VLR. VLR sends MAP\_GET\_PASSWORD\_rsp/cnf (11) to HLR. HLR sends MAP\_GET\_PASSWORD\_req/ind (12) to VLR. VLR sends MAP\_GET\_PASSWORD\_req/ind (13) to MSC. MSC sends A\_GET\_PASSWORD (14) to MS. MS sends A\_GET\_PASSWORD ack (15) to MSC. MSC sends MAP\_GET\_PASSWORD\_rsp/cnf (16) to VLR. VLR sends MAP\_GET\_PASSWORD\_rsp/cnf (17) to HLR. HLR sends MAP\_GET\_PASSWORD\_req/ind (18) to VLR. VLR sends MAP\_GET\_PASSWORD\_req/ind (19) to MSC. MSC sends A\_GET\_PASSWORD (20) to MS. MS sends A\_GET\_PASSWORD ack (21) to MSC. MSC sends MAP\_GET\_PASSWORD\_rsp/cnf (22) to VLR. VLR sends MAP\_GET\_PASSWORD\_rsp/cnf (23) to HLR. HLR sends MAP\_REGISTER\_PASSWORD\_rsp/cnf (24) to VLR. VLR sends MAP\_REGISTER\_PASSWORD\_rsp/cnf (25) to MSC. MSC sends A\_REGISTER\_PASSWORD (26) to MS. + +3187 + +3188 + 3189 1) A\_CM\_SERV\_REQ (Note 1) + 3190 2) MAP\_PROCESS\_ACCESS\_REQUEST (Note 2) + 3191 3) A\_REGISTER\_PASSWORD (Note 1) + 3192 4) MAP\_REGISTER\_PASSWORD\_req/ind + 3193 5) MAP\_REGISTER\_PASSWORD\_req/ind + 3194 6) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3195 7) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3196 8) A\_GET\_PASSWORD (Note 1, Note 3) + 3197 9) A\_GET\_PASSWORD ack (Note 1, Note 3) + 3198 10) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3199 11) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3200 12) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3201 13) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3202 14) A\_GET\_PASSWORD (Note 1, Note 3) + 3203 15) A\_GET\_PASSWORD ack (Note 1, Note 3) + 3204 16) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3205 17) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3206 18) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3207 19) MAP\_GET\_PASSWORD\_req/ind (Note 3) + 3208 20) A\_GET\_PASSWORD (Note 1, Note 3) + 3209 21) A\_GET\_PASSWORD ack (Note 1, Note 3) + 3210 22) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3211 23) MAP\_GET\_PASSWORD\_rsp/cnf (Note 3) + 3212 24) MAP\_REGISTER\_PASSWORD\_rsp/cnf + 3213 25) MAP\_REGISTER\_PASSWORD\_rsp/cnf + 3214 26) A\_REGISTER\_PASSWORD (Note 1) + 3215 + +3216 NOTE 1: For details of the procedure on the radio path, see 3GPP TS 24.008 [35], 3GPP TS 24.010 [36], 3GPP TS +3217 24.08x and 3GPP TS 24.09x. Services shown in dotted lines are triggers/ triggered signalling on the radio +3218 path. +3219 NOTE 2: For details of the Process Access Request procedure, refer to clause 25.4 in the present document. +3220 NOTE 3: The use of each of the three MAP\_GET\_PASSWORD operations is described in clause 22.8.4. +3221 +3222 **Figure 22.8.1/1: Message flow for supplementary service password registration** + +## 3223 22.8.2 Procedure in the MSC + +3224 The password registration procedure in the MSC is identical to that for activation specified in clause 22.4.2. All the text +3225 and diagrams in clause 22.4.2 apply with all references to activation changed to password registration. + +## 3226 22.8.3 Procedure in the VLR + +3227 The password registration procedure in the VLR is identical to that for activation specified in clause 22.4.3. All the text +3228 and diagrams in clause 22.4.3 apply with all references to activation changed to password registration. + +## 3229 22.8.4 Procedure in the HLR + +3230 The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +3231 Check\_Indication see clause 25.2.1. + +3232 The HLR shall process the MAP\_REGISTER\_PASSWORD indication as specified in 3GPP TS 23.011 [22]. During +3233 the handling of password registration, the password procedure is initiated (as specified in 3GPP TS 23.011 [22]) This +3234 involves the sending of MAP\_GET\_PASSWORD requests to the VLR. + +3235 The password registration process in the HLR is shown in figure 22.8.4/1. + +![Flowchart for process Register_Password_HLR. It starts with an oval, followed by a 'Null' oval, then a 'MAP_REGISTER_PASSWORD_ind' signal block. A 'Check_Indication' block follows. A decision diamond 'Operator Determined Barring of SS management?' has 'Yes' and 'No' paths. The 'Yes' path leads to 'Set User Error: Call barred' and 'Call barring cause= Operator barring', which then lead to a 'MAP_REGISTER_SS_rsp' and 'MAP_CLOSE_req' block, ending at a crossed-out line. The 'No' path leads to a 'register password' block, then a 'Wait_For_Application_Response' oval. From there, it splits into two parallel paths: one with 'MAP_NOTICE_ind' and 'MAP_U_ABORT_req' blocks, and another with a signal block containing 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind'. Both paths end at a crossed-out line.](1820e5591678c51a3797ca92464a6080_img.jpg) + +**process Register\_Password\_HLR** **RP\_HLR1(2)** + +Process in the HLR to handle a request to register a password for a supplementary service + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the application process PW1/PW2/PW3/PW4 (see 3GPP TS 23.011) + +``` + + graph TD + Start([ ]) --> Null([Null]) + Null --> MAP_REG[MAP_REGISTER_PASSWORD_ind] + MAP_REG --> Check[Check_Indication] + Check --> Decision{Operator Determined Barring of SS management?} + Decision -- Yes --> SetError[Set User Error: Call barred] + SetError --> CallBarring[Call barring cause= Operator barring] + CallBarring --> MAP_RSP[MAP_REGISTER_SS_rsp +MAP_CLOSE_req] + MAP_RSP --> End1((X)) + + Decision -- No --> Register[register password] + Register --> Wait[Wait_For_Application_Response] + + Wait --> MAP_NOTICE[MAP_NOTICE_ind] + Wait --> MAP_ABORT[MAP_P_ABORT_ind, +MAP_U_ABORT_ind, +MAP_CLOSE_ind] + + MAP_NOTICE --> MAP_U_ABORT[MAP_U_ABORT_req] + + MAP_U_ABORT --> End2((X)) + MAP_ABORT --> End2 + +``` + +Flowchart for process Register\_Password\_HLR. It starts with an oval, followed by a 'Null' oval, then a 'MAP\_REGISTER\_PASSWORD\_ind' signal block. A 'Check\_Indication' block follows. A decision diamond 'Operator Determined Barring of SS management?' has 'Yes' and 'No' paths. The 'Yes' path leads to 'Set User Error: Call barred' and 'Call barring cause= Operator barring', which then lead to a 'MAP\_REGISTER\_SS\_rsp' and 'MAP\_CLOSE\_req' block, ending at a crossed-out line. The 'No' path leads to a 'register password' block, then a 'Wait\_For\_Application\_Response' oval. From there, it splits into two parallel paths: one with 'MAP\_NOTICE\_ind' and 'MAP\_U\_ABORT\_req' blocks, and another with a signal block containing 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. Both paths end at a crossed-out line. + +3236 + +3237 + +**Figure 22.8.4/1 (sheet 1 of 2): Process Register\_PW\_HLR** + +![State transition diagram for process Register_Password_HLR. It shows states like 'Wait_For_Application_Response', 'Wait_For_Password', and 'Check_Confirmation', and transitions for messages like 'password changed', 'error', 'get password', 'get new password', 'get new password again', 'MAP_REGISTER_PASSWORD_rsp', 'MAP_GET_PASSWORD_req', 'MAP_NOTICE_ind', 'MAP_P_ABORT_ind', 'MAP_U_ABORT_ind', 'MAP_CLOSE_ind', 'SS_Get_Password_Ack', and 'MAP_REGISTER_PASSWORD_rsp'. It also includes error handling for 'Data Error' and 'Provider Error'.](f0c43de2e9993b7f72f164a820ff22f5_img.jpg) + +**process Register\_Password\_HLR** RP\_HLR2(2) + +Process in the HLR to handle a request to register a password for a supplementary service + +``` + +stateDiagram-v2 + [*] --> Wait_For_Application_Response + state "Wait_For_Application_Response" as Wait_For_Application_Response + state "Wait_For_Password" as Wait_For_Password + state "Check_Confirmation" as Check_Confirmation + state "SS_Get_Password_Ack" as SS_Get_Password_Ack + + Wait_For_Application_Response --> password_changed + Wait_For_Application_Response --> error + Wait_For_Application_Response --> get_password + Wait_For_Application_Response --> get_new_password + Wait_For_Application_Response --> get_new_password_again + + get_password --> [*] + get_new_password --> [*] + get_new_password_again --> [*] + + error --> Set_User_Error + Set_User_Error --> password_changed + + password_changed --> MAP_REGISTER_PASSWORD_rsp + MAP_REGISTER_PASSWORD_rsp --> [*] + + get_new_password --> MAP_GET_PASSWORD_req + MAP_GET_PASSWORD_req --> Wait_For_Password + + Wait_For_Password --> MAP_GET_PASSWORD_cnf + Wait_For_Password --> MAP_NOTICE_ind + Wait_For_Password --> MAP_P_ABORT_ind + Wait_For_Password --> MAP_U_ABORT_ind + Wait_For_Password --> MAP_CLOSE_ind + + MAP_GET_PASSWORD_cnf --> Check_Confirmation + Check_Confirmation --> SS_Get_Password_Ack + SS_Get_Password_Ack --> Wait_For_Application_Response + + Check_Confirmation --> Data_Error : Data Error + Check_Confirmation --> Provider_Error : Provider Error + Check_Confirmation --> OK_User_Error : OK, User Error + + Data_Error --> Set_User_Error_System_failure + Set_User_Error_System_failure --> MAP_REGISTER_PASSWORD_rsp + MAP_REGISTER_PASSWORD_rsp --> [*] + + Provider_Error --> [*] + + OK_User_Error --> [*] + + MAP_NOTICE_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> [*] + + MAP_P_ABORT_ind --> [*] + MAP_U_ABORT_ind --> [*] + MAP_CLOSE_ind --> [*] + +``` + +State transition diagram for process Register\_Password\_HLR. It shows states like 'Wait\_For\_Application\_Response', 'Wait\_For\_Password', and 'Check\_Confirmation', and transitions for messages like 'password changed', 'error', 'get password', 'get new password', 'get new password again', 'MAP\_REGISTER\_PASSWORD\_rsp', 'MAP\_GET\_PASSWORD\_req', 'MAP\_NOTICE\_ind', 'MAP\_P\_ABORT\_ind', 'MAP\_U\_ABORT\_ind', 'MAP\_CLOSE\_ind', 'SS\_Get\_Password\_Ack', and 'MAP\_REGISTER\_PASSWORD\_rsp'. It also includes error handling for 'Data Error' and 'Provider Error'. + +3238 + +3239 + +**Figure 22.8.4/1 (sheet 2 of 2): Process Register\_PW\_HLR** + +## 3240 22.9 Mobile Initiated USSD procedure + +### 3241 22.9.1 General + +3242 The procedure supports supplementary service signalling procedures which allow PLMN specific services to be +3243 introduced. + +3244 The message flow for the procedure can be found in 3GPP TS 23.090 [34]. + +3245 The following services may be used: + +3246 MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); + +3247 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clauses 9 and 25); + +3248 MAP\_PROVIDE\_IMSI (see clauses 8 and 25); + +3249 MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); + +3250 MAP\_AUTHENTICATE (see clauses 8 and 25); + +3251 MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); + +3252 MAP\_CHECK\_IMEI (see clauses 8 and 25); + +3253 MAP\_READY\_FOR\_SM (see clauses 12 and 25); + +3254 MAP\_UNSTRUCTURED\_SS\_REQUEST (defined in clause 11); + +3255 MAP\_UNSTRUCTURED\_SS\_NOTIFY (defined in clause 11). + +3256 The following service is certainly used: + +3257 MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST (defined in clause 11). + +### 3258 22.9.2 Procedure in the MSC + +3259 The process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +3260 Check\_Confirmation see clause 25.2.2. + +3261 The A\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST from the MS contains information input by the user; the +3262 message may be fed to an application contained locally in the MSC or to the VLR. The rules for determining this are +3263 specified in 3GPP TS 23.090 [34]. + +#### 3264 1) Message Destined for the VLR + +3265 If the message is destined for the VLR then the MSC shall transfer the message to the VLR using the mapping specified +3266 in detail in 3GPP TS 29.011 [59]. + +#### 3267 2) Message Destined for the Local Application + +3268 If the message is destined for the local USSD application then the MSC shall transfer the information contained in the +3269 message to the application. + +3270 The process in the MSC is shown in figure 22.9.2/1. + +### 3271 22.9.3 Procedure in the VLR + +3272 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3273 Receive\_Open\_Cnf see clause 25.1.2; + +3274 Check\_Confirmation see clause 25.2.2; + +3275 Process\_Access\_Request\_VLR see clause 25.4.2. + +3276 The MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST from the MSC contains information input by the user; the +3277 message may be fed to an application contained locally in the VLR or to the HLR. The rules for determining this are +3278 specified in 3GPP TS 23.090 [34]. + +3279 **1) Message Destined for the HLR** + +3280 If the message is destined for the HLR then the VLR shall transfer the message transparently to the HLR. + +3281 **2) Message Destined for the Local Application** + +3282 If the message is destined for the local USSD application then the VLR shall transfer the information contained in the +3283 message to the application. + +3284 The process in the VLR is shown in figure 22.9.3/1. + +## 3285 22.9.4 Procedure in the HLR + +3286 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3287     Receive\_Open\_Ind       see clause 25.1.1; + +3288     Receive\_Open\_Cnf      see clause 25.1.2; + +3289     Check\_Confirmation    see clause 25.2.2. + +3290 The MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST from the VLR contains information input by the user. If the +3291 alphabet used for the message is understood then the message shall be fed to an application contained locally in the +3292 HLR or to the gsmSCF or to a secondary HLR where the USSD application is located. + +3293 **1) Message Destined for the Local Application** + +3294 If the message is destined for the local USSD application then the HLR shall transfer the information contained in the +3295 message to the local application. + +3296 **2) Message Destined for the gsmSCF or the secondary HLR** + +3297 If the message is destined for the gsmSCF or the secondary HLR then the primary HLR shall transfer the message +3298 transparently to the next node. + +3299 The process in the primary HLR is shown in figure 22.9.4/1. + +## 3300 22.9.5 Procedures in the gsmSCF/secondary HLR + +3301 The MAP process invokes a macro not defined in this clause; the definition of this macros can be found as follows: + +3302     Receive\_Open\_Ind       see clause 25.1.1. + +3303 The process in the gsmSCF or secondary HLR is shown in figure 22.9.5/1. + +![Flowchart for process MS_Init_USSD_MSC. It starts with an oval, followed by 'Wait_For_Service_Indication'. A decision diamond 'Handle in MSC?' (See 3GPP TS 23.090) follows. If 'Yes', it goes to connector '1'. If 'No', it sends 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req' and 'MAP_DELIMITER_req', then waits for 'PUSSR_Confirm'. From there, it branches into two paths: one for notification (sending 'MAP_UNSTRUCTURED_SS_NOTIFY_ind', receiving 'A_UNSTRUCTURED_SS_NOTIFY_req', waiting for 'USSLN_Confirm', receiving 'A_UNSTRUCTURED_SS_NOTIFY_cnf', sending 'MAP_UNSTRUCTURED_SS_NOTIFY_rsp' and 'MAP_DELIMITER_req', then waiting for 'PUSSR_Confirm'); the other for request (sending 'MAP_UNSTRUCTURED_SS_REQUEST_ind', receiving 'A_UNSTRUCTURED_SS_REQUEST_req', waiting for 'USSLR_Confirm', receiving 'A_UNSTRUCTURED_SS_REQUEST_cnf', sending 'MAP_UNSTRUCTURED_SS_REQUEST_rsp' and 'MAP_DELIMITER_req', then waiting for 'PUSSR_Confirm').](76041f86868a4730a97b21b203d610c7_img.jpg) + +**process MS\_Init\_USSD\_MSC** **MI\_USSD\_MSC1(3)** + +Process in the MSC to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the SS co-ordinating process in the MSC; signals to/from the right are to/from the VLR + +``` + + graph TD + Start([ ]) --> WFS[Wait_For_Service_Indication] + WFS --> A_PU[A_PROCESS_UNSTRUCTURED_SS_REQUEST_ind] + A_PU --> Decision{Handle in MSC? +(See 3GPP TS 23.090)} + Decision -- Yes --> Connector1((1)) + Decision -- No --> MAP_PU_REQ[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req +MAP_DELIMITER_req] + MAP_PU_REQ --> WPC[Wait_For_PUSSR_Confirm] + WPC --> Split(( )) + Split --> MAP_UNI_IND[MAP_UNSTRUCTURED_SS_NOTIFY_ind] + Split --> MAP_USR_IND[MAP_UNSTRUCTURED_SS_REQUEST_ind] + MAP_UNI_IND --> AUSN_REQ[A_UNSTRUCTURED_SS_NOTIFY_req] + AUSN_REQ --> WUC[Wait_For_USSLN_Confirm] + WUC --> AUSN_CNF[A_UNSTRUCTURED_SS_NOTIFY_cnf] + AUSN_CNF --> MAP_UNI_RSP[MAP_UNSTRUCTURED_SS_NOTIFY_rsp +MAP_DELIMITER_req] + MAP_UNI_RSP --> WPC2[Wait_For_PUSSR_Confirm] + MAP_USR_IND --> AUSR_REQ[A_UNSTRUCTURED_SS_REQUEST_req] + AUSR_REQ --> WURC[Wait_For_USSLR_Confirm] + WURC --> AUSR_CNF[A_UNSTRUCTURED_SS_REQUEST_cnf] + AUSR_CNF --> MAP_USR_RSP[MAP_UNSTRUCTURED_SS_REQUEST_rsp +MAP_DELIMITER_req] + MAP_USR_RSP --> WPC3[Wait_For_PUSSR_Confirm] + +``` + +Flowchart for process MS\_Init\_USSD\_MSC. It starts with an oval, followed by 'Wait\_For\_Service\_Indication'. A decision diamond 'Handle in MSC?' (See 3GPP TS 23.090) follows. If 'Yes', it goes to connector '1'. If 'No', it sends 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_req' and 'MAP\_DELIMITER\_req', then waits for 'PUSSR\_Confirm'. From there, it branches into two paths: one for notification (sending 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind', receiving 'A\_UNSTRUCTURED\_SS\_NOTIFY\_req', waiting for 'USSLN\_Confirm', receiving 'A\_UNSTRUCTURED\_SS\_NOTIFY\_cnf', sending 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_rsp' and 'MAP\_DELIMITER\_req', then waiting for 'PUSSR\_Confirm'); the other for request (sending 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind', receiving 'A\_UNSTRUCTURED\_SS\_REQUEST\_req', waiting for 'USSLR\_Confirm', receiving 'A\_UNSTRUCTURED\_SS\_REQUEST\_cnf', sending 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_rsp' and 'MAP\_DELIMITER\_req', then waiting for 'PUSSR\_Confirm'). + +3304 + +3305 + +Figure 22.9.2/1 (sheet 1 of 3): Process MS\_Init\_USSD\_MSC + +![State transition diagram for process MS_Init_USSD_MSC. The diagram shows two main vertical paths. The top path starts with 'Wait_For_PUSSR_Confirm', followed by an input 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf', then 'Check_Confirmation'. From 'Check_Confirmation', an 'OK, User Error, Data Error' output leads to a state with 'A_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' and 'A_CM_RELEASE_req', which ends with a cross. A 'Provider Error' output from 'Check_Confirmation' leads to a state with 'A_CM_RELEASE_req', which also ends with a cross. The bottom path starts with a state containing 'Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm'. This state branches into two paths. The left path has an output 'A_CM_SERV_RELEASE_ind', followed by an input 'MAP_U_ABORT_req' leading to 'Application procedure cancellation', then an output 'A_CM_RELEASE_COMPLETE_req', ending with a cross. The right path has an input 'MAP_U_ABORT_ind, MAP_CLOSE_ind', followed by an output 'A_CM_RELEASE_req', ending with a cross.](4ca9477ab422c43c6f5ac022fa8b7baa_img.jpg) + +**process MS\_Init\_USSD\_MSC** **MI\_USSD\_MSC2(3)** + +Process in the MSC to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the SS co-ordinating process in the MSC; signals to/from the right are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_PUSSR_Confirm + state "Wait_For_PUSSR_Confirm" as Wait_For_PUSSR_Confirm + state "Check_Confirmation" as Check_Confirmation + state "A_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, A_CM_RELEASE_req" as State1 + state "A_CM_RELEASE_req" as State2 + [*] --> Wait_For_PUSSR_Confirm + state "Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm" as State3 + state "A_CM_SERV_RELEASE_ind" as State4 + state "MAP_U_ABORT_req" as State5 + state "Application procedure cancellation" as State6 + state "A_CM_RELEASE_COMPLETE_req" as State7 + state "MAP_U_ABORT_ind, MAP_CLOSE_ind" as State8 + state "A_CM_RELEASE_req" as State9 + + Wait_For_PUSSR_Confirm --> State1 + State1 --> [*] + Check_Confirmation --> State1 + Check_Confirmation --> State2 + State2 --> [*] + State3 --> State4 + State3 --> State8 + State4 --> State5 + State5 --> State6 + State6 --> State7 + State7 --> [*] + State8 --> State9 + State9 --> [*] + +``` + +State transition diagram for process MS\_Init\_USSD\_MSC. The diagram shows two main vertical paths. The top path starts with 'Wait\_For\_PUSSR\_Confirm', followed by an input 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_cnf', then 'Check\_Confirmation'. From 'Check\_Confirmation', an 'OK, User Error, Data Error' output leads to a state with 'A\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' and 'A\_CM\_RELEASE\_req', which ends with a cross. A 'Provider Error' output from 'Check\_Confirmation' leads to a state with 'A\_CM\_RELEASE\_req', which also ends with a cross. The bottom path starts with a state containing 'Wait\_For\_PUSSR\_Confirm, Wait\_For\_USSN\_Confirm, Wait\_For\_USSR\_Confirm'. This state branches into two paths. The left path has an output 'A\_CM\_SERV\_RELEASE\_ind', followed by an input 'MAP\_U\_ABORT\_req' leading to 'Application procedure cancellation', then an output 'A\_CM\_RELEASE\_COMPLETE\_req', ending with a cross. The right path has an input 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind', followed by an output 'A\_CM\_RELEASE\_req', ending with a cross. + +3306 + +3307 + +**Figure 22.9.2/1 (sheet 2 of 3): Process MS\_Init\_USSD\_MSC** + +process MS\_Init\_USSD\_MSC + +MI\_USSD\_MSC3(3) + +Process in the MSC to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the SS co-ordinating process in the MSC; signals to/from the right are to/from the USSD application process in the MSC unless shown otherwise + +![Sequence diagram for process MS_Init_USSD_MSC. It starts with a connector '1', followed by 'Process Unstructured SS Request', 'MAP CLOSE_req' (to VLR), and 'Wait_For_Application_Response'. It then branches into three paths: 1) 'Unstructured SS Notify' -> 'A_UNSTRUCTURED_SS_NOTIFY_req' -> 'Wait_For_USSN_Confirm_Local' -> 'A_UNSTRUCTURED_SS_NOTIFY_cnf' -> 'Unstructured SS Notify ack' -> 'Wait_For_PUSSR_Confirm'. 2) 'Unstructured SS Request' -> 'A_UNSTRUCTURED_SS_REQUEST_req' -> 'Wait_For_USSR_Confirm_Local' -> 'A_UNSTRUCTURED_SS_REQUEST_cnf' -> 'Unstructured SS Request ack' -> 'Wait_For_PUSSR_Confirm'. 3) A path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response' -> 'A_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' / 'A_CM_RELEASE_req'. This path then leads to a state 'Wait_For_Application_Response, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local', which branches to 'A_CM_SERV_RELEASE_ind' (leading to 'Abort' and 'A_CM_RELEASE_COMPLETE_req') and 'Abort' (leading to 'A_CM_SERV_RELEASE_req').](9343540fbb568aaaa5bdd259337839d2_img.jpg) + +``` + +sequenceDiagram + participant 1 as 1 + participant P as Process Unstructured SS Request + participant M as MAP CLOSE_req + participant W as Wait_For_Application_Response + participant U1 as Unstructured SS Notify + participant U2 as Unstructured SS Request + participant P1 as Process Unstructured SS Request ack, Process Unstructured SS Request negative response + participant A1 as A_UNSTRUCTURED_SS_NOTIFY_req + participant A2 as A_UNSTRUCTURED_SS_REQUEST_req + participant A3 as A_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp / A_CM_RELEASE_req + participant W1 as Wait_For_USSN_Confirm_Local + participant W2 as Wait_For_USSR_Confirm_Local + participant W3 as Wait_For_Application_Response, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local + participant A4 as A_UNSTRUCTURED_SS_NOTIFY_cnf + participant A5 as A_UNSTRUCTURED_SS_REQUEST_cnf + participant U3 as Unstructured SS Notify ack + participant U4 as Unstructured SS Request ack + participant W4 as Wait_For_PUSSR_Confirm + participant A6 as A_CM_SERV_RELEASE_ind + participant A7 as A_CM_RELEASE_COMPLETE_req + participant A8 as A_CM_SERV_RELEASE_req + + Note right of P: To VLR + + 1->>P: + P->>M: + M-->>W: + W-->>U1: + W-->>U2: + W-->>P1: + U1->>A1: + A1->>W1: + W1->>A4: + A4->>U3: + U3->>W4: + U2->>A2: + A2->>W2: + W2->>A5: + A5->>U4: + U4->>W4: + P1->>A3: + A3->>W3: + W3->>A6: + A6->>Abort1: + Abort1->>A7: + W3->>Abort2: + Abort2->>A8: + +``` + +Sequence diagram for process MS\_Init\_USSD\_MSC. It starts with a connector '1', followed by 'Process Unstructured SS Request', 'MAP CLOSE\_req' (to VLR), and 'Wait\_For\_Application\_Response'. It then branches into three paths: 1) 'Unstructured SS Notify' -> 'A\_UNSTRUCTURED\_SS\_NOTIFY\_req' -> 'Wait\_For\_USSN\_Confirm\_Local' -> 'A\_UNSTRUCTURED\_SS\_NOTIFY\_cnf' -> 'Unstructured SS Notify ack' -> 'Wait\_For\_PUSSR\_Confirm'. 2) 'Unstructured SS Request' -> 'A\_UNSTRUCTURED\_SS\_REQUEST\_req' -> 'Wait\_For\_USSR\_Confirm\_Local' -> 'A\_UNSTRUCTURED\_SS\_REQUEST\_cnf' -> 'Unstructured SS Request ack' -> 'Wait\_For\_PUSSR\_Confirm'. 3) A path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response' -> 'A\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' / 'A\_CM\_RELEASE\_req'. This path then leads to a state 'Wait\_For\_Application\_Response, Wait\_For\_USSN\_Confirm\_Local, Wait\_For\_USSR\_Confirm\_Local', which branches to 'A\_CM\_SERV\_RELEASE\_ind' (leading to 'Abort' and 'A\_CM\_RELEASE\_COMPLETE\_req') and 'Abort' (leading to 'A\_CM\_SERV\_RELEASE\_req'). + +3308 + +3309 + +Figure 22.9.2/1 (sheet 3 of 3): Process MS\_Init\_USSD\_MSC + +![Flowchart for process MS_Init_USSD_VLR. It starts with an oval, followed by 'Null', 'Receive_Open_Ind'. From 'Receive_Open_Ind', 'OK' leads to 'Wait_For_PAR' and 'Vr, Error' leads to 'Null'. From 'Wait_For_PAR', an arrow points to a merge point. From this merge point, one path goes left through a chevron to 'Null' with message 'MAP_U_ABORT_ind, MAP_CLOSE_ind'. The main path goes right to 'Process_Access_Request_VLR'. From 'Process_Access_Request_VLR', 'OK' leads to 'Wait_For_PUSSR_Request' and 'Error' leads to 'Null'. From 'Wait_For_PUSSR_Request', an arrow points to another merge point. From this merge point, one path goes left through a chevron to 'Null' with message 'MAP_CLOSE_ind'. The main path goes right through a chevron to a decision diamond 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' with message 'Call barring cause= Operator barring', then to a chevron with message 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req', and finally to 'Null'. If 'No', it goes to another decision diamond 'Handle in VLR? (See 3GPP TS 23.090)'. If 'Yes', it goes to a circle with number '1'. If 'No', it goes to a chevron with messages 'MAP_OPEN_req, MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req, MAP_DELIMITER_req', then to 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', 'Vr' leads to a chevron with message 'MAP_U_ABORT_req' and 'Null'. 'Error' leads to 'Set User Error: System failure', then to a chevron with message 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req', and finally to 'Null'. 'OK' leads to 'Wait_For_PUSSR_Confirm'.](fc5d9ea5b3acb1856df98efc488f7c3d_img.jpg) + +**process MS\_Init\_USSD\_VLR** **MI\_USSD\_VLR1(4)** + +Process in the VLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the MSC; +signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> Null1[Null] + Null1 --> RecOpenInd[Receive_Open_Ind] + RecOpenInd -- OK --> WaitForPAR[Wait_For_PAR] + RecOpenInd -- Vr, Error --> Null2[Null] + WaitForPAR --> Merge1(( )) + Merge1 --> Chevron1[/ /] + Chevron1 -- "MAP_U_ABORT_ind, MAP_CLOSE_ind" --> Null3[Null] + Merge1 --> ProcessAccessReq[Process_Access_Request_VLR] + ProcessAccessReq -- OK --> WaitForPUSSRReq[Wait_For_PUSSR_Request] + ProcessAccessReq -- Error --> Null4[Null] + WaitForPUSSRReq --> Merge2(( )) + Merge2 --> Chevron2[/ /] + Chevron2 -- "MAP_CLOSE_ind" --> Null5[Null] + Merge2 --> Decision1{Operator Determined Barring of SS management?} + Decision1 -- Yes --> SetUserError1[Set User Error: Call barred] + SetUserError1 -- "Call barring cause= Operator barring" --> Chevron3[/ /] + Chevron3 -- "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req" --> Null6[Null] + Decision1 -- No --> Decision2{Handle in VLR? (See 3GPP TS 23.090)} + Decision2 -- Yes --> Circle1((1)) + Decision2 -- No --> Chevron4[/ /] + Chevron4 -- "MAP_OPEN_req, MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req, MAP_DELIMITER_req" --> RecOpenCnf[Receive_Open_Cnf] + RecOpenCnf -- Vr --> Chevron5[/ /] + Chevron5 -- "MAP_U_ABORT_req" --> Null7[Null] + RecOpenCnf -- Error --> SetUserError2[Set User Error: System failure] + SetUserError2 --> Chevron6[/ /] + Chevron6 -- "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req" --> Null8[Null] + RecOpenCnf -- OK --> WaitForPUSSRCnf[Wait_For_PUSSR_Confirm] + +``` + +Flowchart for process MS\_Init\_USSD\_VLR. It starts with an oval, followed by 'Null', 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', 'OK' leads to 'Wait\_For\_PAR' and 'Vr, Error' leads to 'Null'. From 'Wait\_For\_PAR', an arrow points to a merge point. From this merge point, one path goes left through a chevron to 'Null' with message 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. The main path goes right to 'Process\_Access\_Request\_VLR'. From 'Process\_Access\_Request\_VLR', 'OK' leads to 'Wait\_For\_PUSSR\_Request' and 'Error' leads to 'Null'. From 'Wait\_For\_PUSSR\_Request', an arrow points to another merge point. From this merge point, one path goes left through a chevron to 'Null' with message 'MAP\_CLOSE\_ind'. The main path goes right through a chevron to a decision diamond 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' with message 'Call barring cause= Operator barring', then to a chevron with message 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp, MAP\_CLOSE\_req', and finally to 'Null'. If 'No', it goes to another decision diamond 'Handle in VLR? (See 3GPP TS 23.090)'. If 'Yes', it goes to a circle with number '1'. If 'No', it goes to a chevron with messages 'MAP\_OPEN\_req, MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_req, MAP\_DELIMITER\_req', then to 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', 'Vr' leads to a chevron with message 'MAP\_U\_ABORT\_req' and 'Null'. 'Error' leads to 'Set User Error: System failure', then to a chevron with message 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp, MAP\_CLOSE\_req', and finally to 'Null'. 'OK' leads to 'Wait\_For\_PUSSR\_Confirm'. + +3310 + +3311 + +Figure 22.9.3/1 (sheet 1 of 4): Process MS\_Init\_USSD\_VLR + +process MS\_Init\_USSD\_VLR + +MI\_USSD\_VLR2(4) + +Process in the VLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +![State transition diagram for process MS_Init_USSD_VLR. It shows two main paths starting from 'Wait_For_PUSSR_Confirm'. The left path handles 'Provider Error' via 'MAP_U_ABORT_req' to 'Null'. The right path handles 'OK, User Error, Data Error' via 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' and 'MAP_CLOSE_req' to 'Null'. A second 'Wait_For_PUSSR_Confirm' state leads to two parallel paths: one for 'MAP_UNSTRUCTURED_SS_NOTIFY_ind' and another for 'MAP_UNSTRUCTURED_SS_REQUEST_ind'. Both paths involve intermediate state transitions and messages like 'MAP_UNSTRUCTURED_SS_NOTIFY_req', 'MAP_DELIMITER_req', 'MAP_UNSTRUCTURED_SS_NOTIFY_rsp', and 'MAP_UNSTRUCTURED_SS_REQUEST_rsp' before returning to 'Wait_For_PUSSR_Confirm'.](93065516414db5e661217149adc134d6_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_PUSSR_Confirm + state "Wait_For_PUSSR_Confirm" as Wait_For_PUSSR_Confirm + state "Check_Confirmation" as Check_Confirmation + state "Null" as Null + state "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf + state "MAP_UNSTRUCTURED_SS_NOTIFY_ind" as MAP_UNSTRUCTURED_SS_NOTIFY_ind + state "MAP_UNSTRUCTURED_SS_REQUEST_ind" as MAP_UNSTRUCTURED_SS_REQUEST_ind + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSN_Confirm" as Wait_For_USSN_Confirm + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "MAP_UNSTRUCTURED_SS_NOTIFY_rsp" as MAP_UNSTRUCTURED_SS_NOTIFY_rsp + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "MAP_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_UNSTRUCTURED_SS_REQUEST_rsp + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + + Wait_For_PUSSR_Confirm --> Check_Confirmation + Check_Confirmation --> Null : Provider Error + Check_Confirmation --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp : OK, User Error, Data Error + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + Wait_For_PUSSR_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_ind + Wait_For_PUSSR_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_ind + + MAP_UNSTRUCTURED_SS_NOTIFY_ind --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_PUSSR_Confirm + + MAP_UNSTRUCTURED_SS_REQUEST_ind --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_USSR_Confirm + Wait_For_USSR_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_PUSSR_Confirm + +``` + +State transition diagram for process MS\_Init\_USSD\_VLR. It shows two main paths starting from 'Wait\_For\_PUSSR\_Confirm'. The left path handles 'Provider Error' via 'MAP\_U\_ABORT\_req' to 'Null'. The right path handles 'OK, User Error, Data Error' via 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' and 'MAP\_CLOSE\_req' to 'Null'. A second 'Wait\_For\_PUSSR\_Confirm' state leads to two parallel paths: one for 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind' and another for 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind'. Both paths involve intermediate state transitions and messages like 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req', 'MAP\_DELIMITER\_req', 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_rsp', and 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_rsp' before returning to 'Wait\_For\_PUSSR\_Confirm'. + +3312 + +3313 + +Figure 22.9.3/1 (sheet 2 of 4): Process MS\_Init\_USSD\_VLR + +![State transition diagram for process MS_Init_USSD_VLR. It starts with an initial state leading to a 'Wait' state. From 'Wait', three transitions are possible: 1) Left to an unlabeled state, then down to 'MAP_U_ABORT_req' and 'Null'. 2) Right to an unlabeled state, then down to 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind'. 3) Right to 'MAP_NOTICE_ind', then down to 'MAP_CLOSE_req', then right to 'MAP_U_ABORT_req' and 'Null'.](bb90121f4f3d2a58df74e15f7918c754_img.jpg) + +**process MS\_Init\_USSD\_VLR** **MI\_USSD\_VLR3(4)** + +Process in the VLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait + state "Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm" as Wait + Wait --> S1 + state " " as S1 + S1 --> S2 + state " " as S2 + S1 --> S3 + state "MAP_NOTICE_ind" as S3 + S3 --> S4 + state "MAP_CLOSE_req" as S4 + S4 --> S5 + state "MAP_U_ABORT_req" as S5 + S5 --> Null1 + state "Null" as Null1 + S2 --> S6 + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as S6 + S6 --> S5 + S1 --> S7 + state "MAP_U_ABORT_ind, MAP_CLOSE_ind" as S7 + S7 --> S8 + state "MAP_U_ABORT_req" as S8 + S8 --> Null2 + state "Null" as Null2 + +``` + +State transition diagram for process MS\_Init\_USSD\_VLR. It starts with an initial state leading to a 'Wait' state. From 'Wait', three transitions are possible: 1) Left to an unlabeled state, then down to 'MAP\_U\_ABORT\_req' and 'Null'. 2) Right to an unlabeled state, then down to 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. 3) Right to 'MAP\_NOTICE\_ind', then down to 'MAP\_CLOSE\_req', then right to 'MAP\_U\_ABORT\_req' and 'Null'. + +3314 + +3315 + +**Figure 22.9.3/1 (sheet 3 of 4): Process\_MS\_Init\_USSD\_VLR** + +![State transition diagram for process MS_Init_USSD_VLR. It starts at state 1, proceeds to 'Process Unstructured SS Request', then 'Wait_For_Application_Response'. From there, it branches into three paths: 1) 'Unstructured SS Notify' -> 'MAP_UNSTRUCTURED_SS_NOTIFY_req' -> 'Wait_For_USSN_Confirm_Local' -> 'MAP_UNSTRUCTURED_SS_NOTIFY_cnf' -> 'Unstructured SS Notify ack' -> 'Wait_For_PUSSR_Confirm'. 2) 'Unstructured SS Request' -> 'MAP_UNSTRUCTURED_SS_REQUEST_req' -> 'Wait_For_USSR_Confirm_Local' -> 'MAP_UNSTRUCTURED_SS_REQUEST_cnf' -> 'Unstructured SS Request ack' -> 'Wait_For_PUSSR_Confirm'. 3) A path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response' -> 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' -> 'MAP_CLOSE_req' -> 'Null'. From 'Wait_For_PUSSR_Confirm', it goes to a state with 'Wait_For_Application_Response, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local', which then branches to 'MAP_U_ABORT_ind, MAP_CLOSE_ind' -> 'Abort' -> 'Null' or 'MAP_U_ABORT_req' -> 'Abort' -> 'Null'.](8c9b13e5dffc82125436bced758cb953_img.jpg) + +**process MS\_Init\_USSD\_VLR** **MIUSSD\_VLR4(4)** + +Process in the VLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the USSD application process in the VLR + +``` + +stateDiagram-v2 + [*] --> 1 + 1 --> Process_Unstructured_SS_Request : Process Unstructured SS Request + Process_Unstructured_SS_Request --> Wait_For_Application_Response : Wait_For_Application_Response + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "Process Unstructured SS Request ack, Process Unstructured SS Request negative response" as Process_Ack_Neg + Wait_For_Application_Response --> Unstructured_SS_Notify + Wait_For_Application_Response --> Unstructured_SS_Request + Wait_For_Application_Response --> Process_Ack_Neg + Unstructured_SS_Notify --> MAP_UNSTRUCTURED_SS_NOTIFY_req : MAP_UNSTRUCTURED_SS_NOTIFY_req, MAP_DELIMITER_req + Unstructured_SS_Request --> MAP_UNSTRUCTURED_SS_REQUEST_req : MAP_UNSTRUCTURED_SS_REQUEST_req, MAP_DELIMITER_req + Process_Ack_Neg --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp : MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local : Wait_For_USSN_Confirm_Local + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local : Wait_For_USSR_Confirm_Local + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp --> Null : Null + Wait_For_USSN_Confirm_Local --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf : MAP_UNSTRUCTURED_SS_NOTIFY_cnf + Wait_For_USSR_Confirm_Local --> MAP_UNSTRUCTURED_SS_REQUEST_cnf : MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Unstructured_SS_Notify_ack : Unstructured SS Notify ack + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Unstructured_SS_Request_ack : Unstructured SS Request ack + Unstructured_SS_Notify_ack --> Wait_For_PUSSR_Confirm : Wait_For_PUSSR_Confirm + Unstructured_SS_Request_ack --> Wait_For_PUSSR_Confirm : Wait_For_PUSSR_Confirm + Wait_For_PUSSR_Confirm --> Wait_For_Application_Response_etc : Wait_For_Application_Response, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local + state "Wait_For_Application_Response, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local" as Wait_For_Application_Response_etc + Wait_For_Application_Response_etc --> MAP_U_ABORT_ind : MAP_U_ABORT_ind, MAP_CLOSE_ind + Wait_For_Application_Response_etc --> MAP_U_ABORT_req : MAP_U_ABORT_req + MAP_U_ABORT_ind --> Abort : Abort + MAP_U_ABORT_req --> Abort : Abort + Abort --> Null : Null + +``` + +State transition diagram for process MS\_Init\_USSD\_VLR. It starts at state 1, proceeds to 'Process Unstructured SS Request', then 'Wait\_For\_Application\_Response'. From there, it branches into three paths: 1) 'Unstructured SS Notify' -> 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req' -> 'Wait\_For\_USSN\_Confirm\_Local' -> 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_cnf' -> 'Unstructured SS Notify ack' -> 'Wait\_For\_PUSSR\_Confirm'. 2) 'Unstructured SS Request' -> 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_req' -> 'Wait\_For\_USSR\_Confirm\_Local' -> 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_cnf' -> 'Unstructured SS Request ack' -> 'Wait\_For\_PUSSR\_Confirm'. 3) A path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response' -> 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'. From 'Wait\_For\_PUSSR\_Confirm', it goes to a state with 'Wait\_For\_Application\_Response, Wait\_For\_USSN\_Confirm\_Local, Wait\_For\_USSR\_Confirm\_Local', which then branches to 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Abort' -> 'Null' or 'MAP\_U\_ABORT\_req' -> 'Abort' -> 'Null'. + +3316 + +3317 + +**Figure 22.9.3/1 (sheet 4 of 4): Process\_MS\_Init\_USSD\_VLR** + +3318 + +**Figure 22.9.3/2 void** + +![Flowchart for process MS_Init_USSD_HLR. The process starts with an entry point, followed by 'Null', 'Receive_Open_Ind'. From 'Receive_Open_Ind', an 'Error' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait_For_Service_Indication'. From 'Wait_For_Service_Indication', the flow goes to a decision diamond 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' -> 'Call barring cause= Operator barring' -> 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' -> 'MAP_CLOSE_req' -> 'Null'. If 'No', it goes to 'Alphabet supported?'. If 'Yes', it goes to 'Handle in HLR? (See 3GPP TS 23.090)' -> '1'. If 'No', it goes to 'Set User Error: Unknown alphabet' -> 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' -> 'MAP_CLOSE_req' -> 'Null'. From 'Handle in HLR? (See 3GPP TS 23.090)' if 'Yes', it goes to 'MAP_OPEN_req' -> 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req' -> 'MAP_DELIMITER_req' -> 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', an 'Error' path leads to 'Set User Error: System failure' -> 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' -> 'MAP_CLOSE_req' -> 'Null'. An 'OK' path leads to 'Wait_For_PUSSR_Confirm' -> 'Null'. A 'Vr' path leads to 'MAP_U_ABORT_req' -> 'Null'.](bbb098bf9218bf7be1e8e037ed2327f0_img.jpg) + +**process MS\_Init\_USSD\_HLR** **MI\_USSD\_HLR1(4)** + +Process in the HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the VLR; + signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- Error --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null2([Null]) + Receive_Open_Ind -- OK --> Wait_For_Service_Indication[Wait_For_Service_Indication] + Wait_For_Service_Indication --> Operator_Determined_Barring{Operator Determined Barring of SS management?} + Operator_Determined_Barring -- Yes --> Set_User_Error_Call_barred[Set User Error: Call barred] + Set_User_Error_Call_barred --> Call_barring_cause[Call barring cause= Operator barring] + Call_barring_cause --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp1[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp1 --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_CLOSE_req1 --> Null3([Null]) + Operator_Determined_Barring -- No --> Alphabet_supported{Alphabet supported?} + Alphabet_supported -- Yes --> Handle_in_HLR{Handle in HLR? (See 3GPP TS 23.090)} + Handle_in_HLR -- Yes --> Connector1((1)) + Handle_in_HLR -- No --> MAP_OPEN_req[MAP_OPEN_req] + MAP_OPEN_req --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_req --> MAP_DELIMITER_req[MAP_DELIMITER_req] + MAP_DELIMITER_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- Error --> Set_User_Error_System_failure[Set User Error: System failure] + Set_User_Error_System_failure --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp2[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp2 --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Null4([Null]) + Receive_Open_Cnf -- OK --> Wait_For_PUSSR_Confirm[Wait_For_PUSSR_Confirm] + Wait_For_PUSSR_Confirm --> Null5([Null]) + Receive_Open_Cnf -- Vr --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> Null6([Null]) + Alphabet_supported -- No --> Set_User_Error_Unknown_alphabet[Set User Error: Unknown alphabet] + Set_User_Error_Unknown_alphabet --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp3[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp3 --> MAP_CLOSE_req3[MAP_CLOSE_req] + MAP_CLOSE_req3 --> Null7([Null]) + +``` + +Flowchart for process MS\_Init\_USSD\_HLR. The process starts with an entry point, followed by 'Null', 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', an 'Error' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait\_For\_Service\_Indication'. From 'Wait\_For\_Service\_Indication', the flow goes to a decision diamond 'Operator Determined Barring of SS management?'. If 'Yes', it goes to 'Set User Error: Call barred' -> 'Call barring cause= Operator barring' -> 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'. If 'No', it goes to 'Alphabet supported?'. If 'Yes', it goes to 'Handle in HLR? (See 3GPP TS 23.090)' -> '1'. If 'No', it goes to 'Set User Error: Unknown alphabet' -> 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'. From 'Handle in HLR? (See 3GPP TS 23.090)' if 'Yes', it goes to 'MAP\_OPEN\_req' -> 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_req' -> 'MAP\_DELIMITER\_req' -> 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', an 'Error' path leads to 'Set User Error: System failure' -> 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'. An 'OK' path leads to 'Wait\_For\_PUSSR\_Confirm' -> 'Null'. A 'Vr' path leads to 'MAP\_U\_ABORT\_req' -> 'Null'. + +3319 + +3320 + +Figure 22.9.4/1 (sheet 1 of 4): Process MS\_Init\_USSD\_HLR + +process MS\_Init\_USSD\_HLR + +MI\_USSD\_HLR2(4) + +Process in the HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +![State transition diagram for process MS_Init_USSD_HLR. It shows two main paths starting from 'Wait_For_PUSSR_Confirm'. The first path handles a 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf' and then checks for a confirmation, leading to either an abort or a response. The second path handles 'MAP_UNSTRUCTURED_SS_NOTIFY_ind' and 'MAP_UNSTRUCTURED_SS_REQUEST_ind' signals, followed by a series of request/response exchanges and delimiter handling, ending in another 'Wait_For_PUSSR_Confirm' state.](ae10a7e5d67793deb1d25f3bb963e76e_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_PUSSR_Confirm + state "Wait_For_PUSSR_Confirm" as Wait_For_PUSSR_Confirm + state "Check_Confirmation" as Check_Confirmation + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "Null" as Null + state "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf + state "MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_UNSTRUCTURED_SS_NOTIFY_ind" as MAP_UNSTRUCTURED_SS_NOTIFY_ind + state "MAP_UNSTRUCTURED_SS_REQUEST_ind" as MAP_UNSTRUCTURED_SS_REQUEST_ind + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSN_Confirm" as Wait_For_USSN_Confirm + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "MAP_UNSTRUCTURED_SS_NOTIFY_rsp" as MAP_UNSTRUCTURED_SS_NOTIFY_rsp + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "MAP_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_UNSTRUCTURED_SS_REQUEST_rsp + state "Wait_For_PUSSR_Confirm_2" as Wait_For_PUSSR_Confirm + + Wait_For_PUSSR_Confirm --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_cnf --> Check_Confirmation + Check_Confirmation --> MAP_U_ABORT_req : Provider Error + Check_Confirmation --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp : OK, User Error, Data Error + Check_Confirmation --> MAP_CLOSE_req : OK, User Error, Data Error + MAP_U_ABORT_req --> Null + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp --> Null + MAP_CLOSE_req --> Null + + Wait_For_PUSSR_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_ind + Wait_For_PUSSR_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_ind + MAP_UNSTRUCTURED_SS_NOTIFY_ind --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_ind --> MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm + MAP_DELIMITER_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> Wait_For_PUSSR_Confirm_2 + MAP_DELIMITER_req --> Wait_For_PUSSR_Confirm_2 + + MAP_UNSTRUCTURED_SS_REQUEST_ind --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_ind --> MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSN_Confirm + MAP_DELIMITER_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> Wait_For_PUSSR_Confirm_2 + MAP_DELIMITER_req --> Wait_For_PUSSR_Confirm_2 + +``` + +State transition diagram for process MS\_Init\_USSD\_HLR. It shows two main paths starting from 'Wait\_For\_PUSSR\_Confirm'. The first path handles a 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_cnf' and then checks for a confirmation, leading to either an abort or a response. The second path handles 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind' and 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind' signals, followed by a series of request/response exchanges and delimiter handling, ending in another 'Wait\_For\_PUSSR\_Confirm' state. + +3321 + +3322 + +Figure 22.9.4/1 (sheet 2 of 4): Process MS\_Init\_USSD\_HLR + +![State transition diagram for process MS_Init_USSD_HLR. It starts with an initial state leading to a 'Wait' state. From 'Wait', it branches into two parallel paths. The left path goes through 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' to a merge point, then 'MAP_NOTICE_ind' to 'MAP_CLOSE_req', then 'MAP_U_ABORT_req' to 'Null'. The right path goes through 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' to another merge point, then 'MAP_NOTICE_ind' to 'MAP_CLOSE_req', then 'MAP_U_ABORT_req' to 'Null'. Both merge points lead to the 'MAP_U_ABORT_req' state.](9c366736af445890a3e1dd2b9c1651a5_img.jpg) + +**process MS\_Init\_USSD\_HLR** **MI\_USSD\_HLR3(4)** + +Process in the HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +Wait\_For\_PUSSR\_Confirm, +Wait\_For\_USSN\_Confirm, +Wait\_For\_USSR\_Confirm, + +``` + +stateDiagram-v2 + [*] --> Wait + state "Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm," as Wait + Wait --> LeftMerge + Wait --> RightMerge + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as LeftMerge + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as RightMerge + LeftMerge --> LeftNotice + RightMerge --> RightNotice + state "MAP_NOTICE_ind" as LeftNotice + state "MAP_NOTICE_ind" as RightNotice + LeftNotice --> LeftCloseReq + RightNotice --> RightCloseReq + state "MAP_CLOSE_req" as LeftCloseReq + state "MAP_CLOSE_req" as RightCloseReq + LeftCloseReq --> LeftAbortReq + RightCloseReq --> RightAbortReq + state "MAP_U_ABORT_req" as LeftAbortReq + state "MAP_U_ABORT_req" as RightAbortReq + LeftAbortReq --> Null1 + RightAbortReq --> Null2 + state "Null" as Null1 + state "Null" as Null2 + +``` + +State transition diagram for process MS\_Init\_USSD\_HLR. It starts with an initial state leading to a 'Wait' state. From 'Wait', it branches into two parallel paths. The left path goes through 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' to a merge point, then 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req', then 'MAP\_U\_ABORT\_req' to 'Null'. The right path goes through 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' to another merge point, then 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req', then 'MAP\_U\_ABORT\_req' to 'Null'. Both merge points lead to the 'MAP\_U\_ABORT\_req' state. + +3323 + +3324 + +Figure 22.9.4/1 (sheet 3 of 4): Process MS\_Init\_USSD\_HLR + +![State transition diagram for process MS_Init_USSD_HLR. The process starts at state 1, proceeds to 'Process Unstructured SS Request', then 'Wait_For_Application_Response'. It then branches into three paths: 1) 'Unstructured SS Notify' leading to 'MAP_UNSTRUCTURED_SS_NOTIFY_req', 'Wait_For_USSN_Confirm_Local', 'MAP_UNSTRUCTURED_SS_NOTIFY_cnf', 'Unstructured SS Notify ack', and 'Wait_For_PUSSR_Confirm'. 2) 'Unstructured SS Request' leading to 'MAP_UNSTRUCTURED_SS_REQUEST_req', 'Wait_For_USSR_Confirm_Local', 'MAP_UNSTRUCTURED_SS_REQUEST_cnf', 'Unstructured SS Request ack', and 'Wait_For_PUSSR_Confirm'. 3) A negative response path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response', 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp', 'MAP_CLOSE_req', and 'Null'. Both 'Wait_For_PUSSR_Confirm' states lead to a common state with a note: 'Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local'. From this state, it branches into: 1) 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' leading to 'Abort' and 'Null'. 2) 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and then 'Abort' and 'Null'. 3) 'Abort' leading to 'MAP_U_ABORT_req' and 'Null'.](6c759550c6d07880e10c4374ad85c181_img.jpg) + +**process MS\_Init\_USSD\_HLR** **MI\_USSD\_HLR4(4)** + +Process in the HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the USSD application process in the HLR + +``` + +stateDiagram-v2 + [*] --> 1 + 1 --> Process_Unstructured_SS_Request: Process Unstructured SS Request + Process_Unstructured_SS_Request --> Wait_For_Application_Response: Wait_For_Application_Response + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "Process Unstructured SS Request ack, Process Unstructured SS Request negative response" as Negative_Response + Unstructured_SS_Notify --> MAP_UNSTRUCTURED_SS_NOTIFY_req: MAP_UNSTRUCTURED_SS_NOTIFY_req, MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local: Wait_For_USSN_Confirm_Local + Wait_For_USSN_Confirm_Local --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf: MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Unstructured_SS_Notify_ack: Unstructured SS Notify ack + Unstructured_SS_Notify_ack --> Wait_For_PUSSR_Confirm_1: Wait_For_PUSSR_Confirm + Unstructured_SS_Request --> MAP_UNSTRUCTURED_SS_REQUEST_req: MAP_UNSTRUCTURED_SS_REQUEST_req, MAP_DELIMITER_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local: Wait_For_USSR_Confirm_Local + Wait_For_USSR_Confirm_Local --> MAP_UNSTRUCTURED_SS_REQUEST_cnf: MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Unstructured_SS_Request_ack: Unstructured SS Request ack + Unstructured_SS_Request_ack --> Wait_For_PUSSR_Confirm_2: Wait_For_PUSSR_Confirm + Negative_Response --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp: MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp --> Null_1: Null + Wait_For_PUSSR_Confirm_1 --> Common_Wait: Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local + Wait_For_PUSSR_Confirm_2 --> Common_Wait + Common_Wait --> MAP_P_ABORT_ind: MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind + MAP_P_ABORT_ind --> Abort_1: Abort + Abort_1 --> Null_2: Null + Common_Wait --> MAP_NOTICE_ind: MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req_2: MAP_CLOSE_req + MAP_CLOSE_req_2 --> Abort_2: Abort + Abort_2 --> Null_3: Null + Common_Wait --> Abort_3: Abort + Abort_3 --> MAP_U_ABORT_req: MAP_U_ABORT_req + MAP_U_ABORT_req --> Null_4: Null + +``` + +State transition diagram for process MS\_Init\_USSD\_HLR. The process starts at state 1, proceeds to 'Process Unstructured SS Request', then 'Wait\_For\_Application\_Response'. It then branches into three paths: 1) 'Unstructured SS Notify' leading to 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req', 'Wait\_For\_USSN\_Confirm\_Local', 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_cnf', 'Unstructured SS Notify ack', and 'Wait\_For\_PUSSR\_Confirm'. 2) 'Unstructured SS Request' leading to 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_req', 'Wait\_For\_USSR\_Confirm\_Local', 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_cnf', 'Unstructured SS Request ack', and 'Wait\_For\_PUSSR\_Confirm'. 3) A negative response path leading to 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response', 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp', 'MAP\_CLOSE\_req', and 'Null'. Both 'Wait\_For\_PUSSR\_Confirm' states lead to a common state with a note: 'Wait\_For\_PUSSR\_Confirm, Wait\_For\_USSN\_Confirm\_Local, Wait\_For\_USSR\_Confirm\_Local'. From this state, it branches into: 1) 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' leading to 'Abort' and 'Null'. 2) 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and then 'Abort' and 'Null'. 3) 'Abort' leading to 'MAP\_U\_ABORT\_req' and 'Null'. + +3325 + +3326 + +Figure 22.9.4/1 (sheet 4 of 4): Process MS\_Init\_USSD\_HLR + +process MS\_INIT\_USSD\_gsmSCF\_Secondary\_HLR + +MI\_USSD\_SCF1(2) + +Process in the gsmSCF or secondary HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the USSD application process + +![Flowchart for process MS_INIT_USSD_gsmSCF_Secondary_HLR. The process starts with an entry point leading to 'Null', then 'Receive_Open_ind'. From 'Receive_Open_ind', an 'Error' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait_For_Service_Indication', which then leads to a merge point for 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_ind'. This is followed by 'Process Unstructured SS Request' and 'Wait_For_Application_Response'. From 'Wait_For_Application_Response', three paths emerge: 1) 'Unstructured SS Notify' leading to a merge point for 'MAP_UNSTRUCTURED_SS_NOTIFY_req' and 'MAP_DELIMITER_req', then 'Wait_For_USSN_Confirm_Local', then a merge point for 'MAP_UNSTRUCTURED_SS_NOTIFY_cnf', then 'Unstructured SS Notify ack', and finally 'Wait_For_PUSSR_Confirm'. 2) 'Unstructured SS Request' leading to a merge point for 'MAP_UNSTRUCTURED_SS_REQUEST_req' and 'MAP_DELIMITER_req', then 'Wait_For_USSR_Confirm_Local', then a merge point for 'MAP_UNSTRUCTURED_SS_REQUEST_cnf', then 'Unstructured SS Request ack', and finally 'Wait_For_PUSSR_Confirm'. 3) A path leading to a merge point for 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response', then a merge point for 'MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp' and 'MAP_CLOSE_req', and finally 'Null'.](66478ca94b9cd879c8980a6a91490faf_img.jpg) + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind -- Error --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null2([Null]) + Receive_Open_ind -- OK --> Wait_For_Service_Indication[Wait_For_Service_Indication] + Wait_For_Service_Indication --> Merge1{ } + Merge1 --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_ind[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_ind] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_ind --> Process_Unstructured_SS_Request[/Process Unstructured SS Request/] + Process_Unstructured_SS_Request --> Wait_For_Application_Response[Wait_For_Application_Response] + Wait_For_Application_Response --> Merge2{ } + Merge2 --> Unstructured_SS_Notify[/Unstructured SS Notify/] + Merge2 --> Unstructured_SS_Request[/Unstructured SS Request/] + Merge2 --> Merge3{ } + Unstructured_SS_Notify --> Merge4{ } + Merge4 --> MAP_UNSTRUCTURED_SS_NOTIFY_req[MAP_UNSTRUCTURED_SS_NOTIFY_req +MAP_DELIMITER_req] + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local[Wait_For_USSN_Confirm_Local] + Wait_For_USSN_Confirm_Local --> Merge5{ } + Merge5 --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf[MAP_UNSTRUCTURED_SS_NOTIFY_cnf] + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Unstructured_SS_Notify_ack[/Unstructured SS Notify ack/] + Unstructured_SS_Notify_ack --> Wait_For_PUSSR_Confirm1[Wait_For_PUSSR_Confirm] + Unstructured_SS_Request --> Merge6{ } + Merge6 --> MAP_UNSTRUCTURED_SS_REQUEST_req[MAP_UNSTRUCTURED_SS_REQUEST_req +MAP_DELIMITER_req] + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local[Wait_For_USSR_Confirm_Local] + Wait_For_USSR_Confirm_Local --> Merge7{ } + Merge7 --> MAP_UNSTRUCTURED_SS_REQUEST_cnf[MAP_UNSTRUCTURED_SS_REQUEST_cnf] + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Unstructured_SS_Request_ack[/Unstructured SS Request ack/] + Unstructured_SS_Request_ack --> Wait_For_PUSSR_Confirm2[Wait_For_PUSSR_Confirm] + Merge3 --> Merge8{ } + Merge8 --> Process_Unstructured_SS_Request_ack[Process Unstructured SS Request ack, +Process Unstructured SS Request negative response] + Process_Unstructured_SS_Request_ack --> Merge9{ } + Merge9 --> MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp[MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp +MAP_CLOSE_req] + MAP_PROCESS_UNSTRUCTURED_SS_REQUEST_rsp --> Null3([Null]) + +``` + +Flowchart for process MS\_INIT\_USSD\_gsmSCF\_Secondary\_HLR. The process starts with an entry point leading to 'Null', then 'Receive\_Open\_ind'. From 'Receive\_Open\_ind', an 'Error' path leads to 'Perform MAP Vr dialogue' and then 'Null'. An 'OK' path leads to 'Wait\_For\_Service\_Indication', which then leads to a merge point for 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_ind'. This is followed by 'Process Unstructured SS Request' and 'Wait\_For\_Application\_Response'. From 'Wait\_For\_Application\_Response', three paths emerge: 1) 'Unstructured SS Notify' leading to a merge point for 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_USSN\_Confirm\_Local', then a merge point for 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_cnf', then 'Unstructured SS Notify ack', and finally 'Wait\_For\_PUSSR\_Confirm'. 2) 'Unstructured SS Request' leading to a merge point for 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_req' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_USSR\_Confirm\_Local', then a merge point for 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_cnf', then 'Unstructured SS Request ack', and finally 'Wait\_For\_PUSSR\_Confirm'. 3) A path leading to a merge point for 'Process Unstructured SS Request ack, Process Unstructured SS Request negative response', then a merge point for 'MAP\_PROCESS\_UNSTRUCTURED\_SS\_REQUEST\_rsp' and 'MAP\_CLOSE\_req', and finally 'Null'. + +3327 + +3328 + +Figure 22.9.5/1 (sheet 1 of 2): Process MS\_Init\_USSD\_gsmSCF\_Secondary\_HLR + +process MS\_INIT\_USSD\_gsmSCF\_Secondary\_HLR + +MI\_USSD\_SCF2(2) + +Process in the gsmSCF or secondary HLR to handle an MS initiated USSD transaction + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the USSD application process + +![State transition diagram for process MS_INIT_USSD_gsmSCF_Secondary_HLR. It shows transitions between states based on MAP messages like P_ABORT, U_ABORT, CLOSE, NOTICE, and U_ABORT requests, leading to Null states or Abort states.](97d40ecf574c206406b1674e364a0484_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_PUSSR_Confirm + state "Wait_For_PUSSR_Confirm, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local" as Wait_For_PUSSR_Confirm + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as Left_External + state "MAP_NOTICE_ind" as Right_External + state "MAP_CLOSE_req" as Right_External + state "Abort" as Left_External + state "MAP_U_ABORT_req" as Right_External + state "Null" as Left_End + state "Null" as Right_End + + Wait_For_PUSSR_Confirm --> Left_External + Wait_For_PUSSR_Confirm --> Right_External + Wait_For_PUSSR_Confirm --> Right_External + Left_External --> Right_External + Right_External --> Right_External + Right_External --> Left_External + Right_External --> Left_End + Right_External --> Right_End + +``` + +State transition diagram for process MS\_INIT\_USSD\_gsmSCF\_Secondary\_HLR. It shows transitions between states based on MAP messages like P\_ABORT, U\_ABORT, CLOSE, NOTICE, and U\_ABORT requests, leading to Null states or Abort states. + +3329 + +3330 + +Figure 22.9.5/1 (sheet 2 of 2): Process MS\_Init\_USSD\_gsmSCF\_Secondary\_HLR + +## 3331 22.10 Network initiated USSD procedure + +### 3332 22.10.1 General + +3333 The procedure supports supplementary service signalling procedures which allow PLMN specific services to be +3334 introduced. + +3335 The message flow for the procedure can be found in 3GPP TS 23.090 [34]. + +3336 The following services may be used: + +- 3337 MAP\_PAGE (see clauses 8 and 25); +- 3338 MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER (see clauses 8 and 25); +- 3339 MAP\_PROCESS\_ACCESS\_REQUEST (see clauses 8 and 25); +- 3340 MAP\_AUTHENTICATE (see clauses 8 and 25); +- 3341 MAP\_SET\_CIPHERING\_MODE (see clauses 8 and 25); +- 3342 MAP\_FORWARD\_NEW\_TMSI (see clauses 8 and 25); +- 3343 MAP\_READY\_FOR\_SM (see clauses 12 and 25). + +3344 At least one of the following services will certainly be used, and both may be used: + +- 3345 MAP\_UNSTRUCTURED\_SS\_REQUEST (defined in clause 11); +- 3346 MAP\_UNSTRUCTURED\_SS\_NOTIFY (defined in clause 11). + +### 3347 22.10.2 Procedure in the MSC + +3348 The process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 3349 Receive\_Open\_Ind see clause 25.1.1; +- 3350 Receive\_Open\_Cnf see clause 25.1.2; +- 3351 Page\_MSC see clause 25.3.1; +- 3352 Search\_For\_MS\_MSC see clause 25.3.2; +- 3353 Process\_Access\_Request\_MSC see clause 25.4.1. + +3354 The process in the MSC is shown in figure 22.10.2/1. + +### 3355 22.10.3 Procedure in the VLR + +3356 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +- 3357 Receive\_Open\_Ind see clause 25.1.1; +- 3358 Receive\_Open\_Cnf see clause 25.1.2; +- 3359 Check\_Indication see clause 25.2.1; +- 3360 Check\_Confirmation see clause 25.2.2. + +3361 The process in the VLR is shown in figure 22.10.3/1. + +### 3362 MSC Initiated USSD + +3363 If a USSD application in the MSC wishes to use the network initiated USSD procedure, and a connection to the MS +3364 does not exist then the MSC opens a dialogue with the VLR. This dialogue leads to the VLR performing page or search +3365 using the macro Start\_USSD\_VLR. + +3366 **Macro Start\_USSD\_VLR** + +3367 The macro invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3368     Check\_Confirmation     see clause 25.2.1; + +3369     Process\_Access\_Request\_VLR see clause 25.4.2. + +3370 The macro is shown in figure 22.10.3/2. + +## 3371 22.10.4 Procedure in the HLR + +3372 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3373     Receive\_Open\_Ind     see clause 25.1.1; + +3374     Receive\_Open\_Cnf     see clause 25.1.2; + +3375     Check\_Indication     see clause 25.2.1; + +3376     Check\_Confirmation     see clause 25.2.2. + +3377 The process in the primary HLR is shown in figures 22.10.4/1 and 22.10.4/2. + +## 3378 22.10.5 Procedure in the gsmSCF or secondary HLR + +3379 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3380     Receive\_Open\_Cnf     see clause 25.1.2; + +3381     Check\_Confirmation     see clause 25.2.2. + +3382 The procedure in the gsmSCF or secondary HLR is shown in figure 22.10.5/1. + +![State transition diagram for process NW_Init_USSD_MSC. The process starts at 'Null', receives 'Start USSD' from the application, sends 'MAP_OPEN_req' and 'MAP_DELIMITER_req', receives 'Receive_Open_Cnf', and then branches based on 'Wait_For_Paging_Command_Local' (OK or Vr, Error).](6432fc33a8cf0dface0a39ba95522a9a_img.jpg) + +**process NW\_Init\_USSD\_MSC** **NI\_USSD\_MSC3(4)** + +Process in the MSC to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the VLR + unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Null + Null --> Start_USSD + Start_USSD --> Open_Req + Open_Req --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_Paging_Command_Local + Wait_For_Paging_Command_Local --> Page_MSC + Wait_For_Paging_Command_Local --> Search_For_MS_MSC + Wait_For_Paging_Command_Local --> Abort + Wait_For_Paging_Command_Local --> Vr_Error + Page_MSC --> Null + Page_MSC --> Error + Page_MSC --> OK + Search_For_MS_MSC --> Error + Search_For_MS_MSC --> OK + Search_For_MS_MSC --> Null + Error --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + OK --> Process_Access_Request_MSC + Process_Access_Request_MSC --> MAP_CLOSE_req + Process_Access_Request_MSC --> Error + MAP_CLOSE_req --> Wait_For_USSD_Instruction + Wait_For_USSD_Instruction --> Null + Abort --> Null + +``` + +**State Transitions:** + +- Null** → **Start USSD** (From the USSD application in the MSC) +- Start USSD** → **MAP\_OPEN\_req / MAP\_DELIMITER\_req** +- MAP\_OPEN\_req / MAP\_DELIMITER\_req** → **Receive\_Open\_Cnf** +- Receive\_Open\_Cnf** → **Wait\_For\_Paging\_Command\_Local** (OK) or **1** (Vr, Error) +- Wait\_For\_Paging\_Command\_Local** → **Page\_MSC**, **Search\_For\_MS\_MSC**, **Abort** (To the USSD application in the MSC), or **1** +- Page\_MSC** → **Null** (Null), **MAP\_CLOSE\_req** (Error), or **Process\_Access\_Request\_MSC** (OK) +- Search\_For\_MS\_MSC** → **MAP\_CLOSE\_req** (Error), **Process\_Access\_Request\_MSC** (OK), or **1** (Null) +- Process\_Access\_Request\_MSC** → **MAP\_CLOSE\_req** (OK) or **1** (Error) +- MAP\_CLOSE\_req** → **Null** +- MAP\_CLOSE\_req** → **Wait\_For\_USSD\_Instruction** +- Wait\_For\_USSD\_Instruction** → **Null** + +State transition diagram for process NW\_Init\_USSD\_MSC. The process starts at 'Null', receives 'Start USSD' from the application, sends 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req', receives 'Receive\_Open\_Cnf', and then branches based on 'Wait\_For\_Paging\_Command\_Local' (OK or Vr, Error). + +3383 + +3384 + +Figure 22.10.2/1 (sheet 1 of 4): Process NW\_Init\_USSD\_MSC + +process NW\_Init\_USSD\_MSC + +NI\_USSD\_MSC2(4) + +Process in the MSC to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +![State transition diagram for process NW_Init_USSD_MSC. The diagram shows two main vertical paths starting from a 'Wait_For_USSD_Indication' state. The left path handles NOTIFY messages, and the right path handles REQUEST messages. Both paths lead to a common 'Wait_For_USSN_Confirm, Wait_For_USSR_Confirm' state, which then branches into either a successful release sequence or an abort sequence.](dae0b516657a8fa6cf81e92cf48e6033_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_USSD_Indication + state "Wait_For_USSD_Indication" as Wait_For_USSD_Indication + state "Wait_For_USSN_Confirm" as Wait_For_USSN_Confirm + state "Wait_For_USSR_Confirm" as Wait_For_USSR_Confirm + state "Wait_For_USSN_Confirm, Wait_For_USSR_Confirm" as Wait_For_USSN_Confirm_Wait_For_USSR_Confirm + state "A_CM_RELEASE_COMPLETE_req" as A_CM_RELEASE_COMPLETE_req + state "A_CM_RELEASE_req" as A_CM_RELEASE_req + state "Null" as Null + state "Application procedure cancellation" as Application_procedure_cancellation + + Wait_For_USSD_Indication --> Wait_For_USSN_Confirm : MAP_UNSTRUCTURED_SS_NOTIFY_ind + Wait_For_USSN_Confirm --> Wait_For_USSD_Indication : A_UNSTRUCTURED_SS_NOTIFY_req + Wait_For_USSN_Confirm --> Wait_For_USSR_Confirm : A_UNSTRUCTURED_SS_NOTIFY_cnf + Wait_For_USSR_Confirm --> Wait_For_USSD_Indication : MAP_UNSTRUCTURED_SS_REQUEST_ind + Wait_For_USSR_Confirm --> Wait_For_USSN_Confirm : A_UNSTRUCTURED_SS_REQUEST_req + Wait_For_USSR_Confirm --> Wait_For_USSN_Confirm_Wait_For_USSR_Confirm : A_UNSTRUCTURED_SS_REQUEST_cnf + Wait_For_USSN_Confirm_Wait_For_USSR_Confirm --> A_CM_RELEASE_COMPLETE_req : MAP_UNSTRUCTURED_SS_NOTIFY_rsp, MAP_DELIMITER_req + Wait_For_USSN_Confirm_Wait_For_USSR_Confirm --> MAP_U_ABORT_ind : MAP_U_ABORT_ind, MAP_CLOSE_ind + A_CM_RELEASE_COMPLETE_req --> Null + MAP_U_ABORT_req --> Application_procedure_cancellation + Application_procedure_cancellation --> A_CM_RELEASE_COMPLETE_req + A_CM_RELEASE_req --> Null + +``` + +State transition diagram for process NW\_Init\_USSD\_MSC. The diagram shows two main vertical paths starting from a 'Wait\_For\_USSD\_Indication' state. The left path handles NOTIFY messages, and the right path handles REQUEST messages. Both paths lead to a common 'Wait\_For\_USSN\_Confirm, Wait\_For\_USSR\_Confirm' state, which then branches into either a successful release sequence or an abort sequence. + +3385 + +3386 + +Figure 22.10.2/1 (sheet 2 of 4): Process NW\_Init\_USSD\_MSC + +![State transition diagram for process NW_Init_USSD_MSC. The process starts at 'Null', receives 'Start USSD' from the application, sends 'MAP_OPEN_req' and 'MAP_DELIMITER_req', receives 'Receive_Open_Cnf', and then branches based on 'OK' or 'Vr, Error'. The 'OK' path leads to 'Wait_For_Paging_Command_Local', which then branches into 'Page_MSC', 'Search_For_MS_MSC', and an 'Abort' path. 'Page_MSC' and 'Search_For_MS_MSC' lead to 'MAP_CLOSE_req' and then to state '1'. 'Search_For_MS_MSC' also leads to 'Process_Access_Request_MSC', which leads to 'MAP_CLOSE_req' and then to 'Wait_For_USSD_Instruction'. The 'Abort' path leads to 'To the USSD application in the MSC' and then to 'Null'.](93719af32eaa0771c630c27247cc89b6_img.jpg) + +**process NW\_Init\_USSD\_MSC** **NI\_USSD\_MSC3(4)** + +Process in the MSC to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the VLR + unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Null + Null --> Start_USSD : From the USSD application in the MSC + Start_USSD --> MAP_OPEN_req : MAP_OPEN_req, MAP_DELIMITER_req + MAP_OPEN_req --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_Paging_Command_Local : OK + Receive_Open_Cnf --> 1 : Vr, Error + Wait_For_Paging_Command_Local --> Page_MSC + Wait_For_Paging_Command_Local --> Search_For_MS_MSC + Wait_For_Paging_Command_Local --> Abort : MAP_U_ABORT_ind, MAP_CLOSE_ind + Page_MSC --> 1 : Null + Page_MSC --> MAP_CLOSE_req : Error + Page_MSC --> 1 : OK + Search_For_MS_MSC --> 1 : Null + Search_For_MS_MSC --> MAP_CLOSE_req : Error + Search_For_MS_MSC --> Process_Access_Request_MSC : OK + Process_Access_Request_MSC --> 1 : Error + Process_Access_Request_MSC --> MAP_CLOSE_req : OK + MAP_CLOSE_req --> 1 + MAP_CLOSE_req --> Wait_For_USSD_Instruction + Abort --> To_USSD_application : To the USSD application in the MSC + To_USSD_application --> Null + +``` + +State transition diagram for process NW\_Init\_USSD\_MSC. The process starts at 'Null', receives 'Start USSD' from the application, sends 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req', receives 'Receive\_Open\_Cnf', and then branches based on 'OK' or 'Vr, Error'. The 'OK' path leads to 'Wait\_For\_Paging\_Command\_Local', which then branches into 'Page\_MSC', 'Search\_For\_MS\_MSC', and an 'Abort' path. 'Page\_MSC' and 'Search\_For\_MS\_MSC' lead to 'MAP\_CLOSE\_req' and then to state '1'. 'Search\_For\_MS\_MSC' also leads to 'Process\_Access\_Request\_MSC', which leads to 'MAP\_CLOSE\_req' and then to 'Wait\_For\_USSD\_Instruction'. The 'Abort' path leads to 'To the USSD application in the MSC' and then to 'Null'. + +3387 + +3388 + +**Figure 22.10.2/1 (sheet 3 of 4): Process NW\_Init\_USSD\_MSC** + +![State transition diagram for process NW_Init_USSD_MSC. The process starts in 'Wait_For_USSD_Instruction' and branches into two parallel paths: 'Unstructured SS Notify' and 'Unstructured SS Request'. Both paths involve local confirmations and subsequent instructions. A central state contains three wait conditions. From this state, the process can either release the service (leading to 'Abort' and 'Null') or continue with 'USSD release' (leading to 'Null').](56649cc9e7ebcf10ce69f4c018e67419_img.jpg) + +**process NW\_Init\_USSD\_MSC** **NI\_USSD\_MSC4(4)** + +Process in the MSC to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the USSD application in the MSC + +``` + +stateDiagram-v2 + [*] --> Wait_For_USSD_Instruction + state "Wait_For_USSD_Instruction" as Wait_For_USSD_Instruction + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "A_UNSTRUCTURED_SS_NOTIFY_req" as A_UNSTRUCTURED_SS_NOTIFY_req + state "A_UNSTRUCTURED_SS_REQUEST_req" as A_UNSTRUCTURED_SS_REQUEST_req + state "Wait_For_USSN_Confirm_Local" as Wait_For_USSN_Confirm_Local + state "Wait_For_USSR_Confirm_Local" as Wait_For_USSR_Confirm_Local + state "A_UNSTRUCTURED_SS_NOTIFY_cnf" as A_UNSTRUCTURED_SS_NOTIFY_cnf + state "A_UNSTRUCTURED_SS_REQUEST_cnf" as A_UNSTRUCTURED_SS_REQUEST_cnf + state "Unstructured SS Notify ack" as Unstructured_SS_Notify_ack + state "Unstructured SS Request ack" as Unstructured_SS_Request_ack + state "Wait_For_USSD_Instruction_2" as Wait_For_USSD_Instruction + state "Wait_For_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local" as Wait_Conditions + state "A_CM_SERV_RELEASE_ind" as A_CM_SERV_RELEASE_ind + state "USSD release" as USSD_release + state "Abort" as Abort + state "A_CM_RELEASE_COMPLETE_req" as A_CM_RELEASE_COMPLETE_req + state "A_CM_SERV_RELEASE_req" as A_CM_SERV_RELEASE_req + state "Null" as Null + + Wait_For_USSD_Instruction --> Unstructured_SS_Notify + Wait_For_USSD_Instruction --> Unstructured_SS_Request + Unstructured_SS_Notify --> A_UNSTRUCTURED_SS_NOTIFY_req + A_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local + Wait_For_USSN_Confirm_Local --> A_UNSTRUCTURED_SS_NOTIFY_cnf + A_UNSTRUCTURED_SS_NOTIFY_cnf --> Unstructured_SS_Notify_ack + Unstructured_SS_Notify_ack --> Wait_For_USSD_Instruction + Unstructured_SS_Request --> A_UNSTRUCTURED_SS_REQUEST_req + A_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local + Wait_For_USSR_Confirm_Local --> A_UNSTRUCTURED_SS_REQUEST_cnf + A_UNSTRUCTURED_SS_REQUEST_cnf --> Unstructured_SS_Request_ack + Unstructured_SS_Request_ack --> Wait_For_USSD_Instruction + Wait_For_USSD_Instruction --> Wait_Conditions + Wait_Conditions --> A_CM_SERV_RELEASE_ind + Wait_Conditions --> USSD_release + A_CM_SERV_RELEASE_ind --> Abort + Abort --> A_CM_RELEASE_COMPLETE_req + A_CM_RELEASE_COMPLETE_req --> Null + USSD_release --> A_CM_SERV_RELEASE_req + A_CM_SERV_RELEASE_req --> Null + +``` + +State transition diagram for process NW\_Init\_USSD\_MSC. The process starts in 'Wait\_For\_USSD\_Instruction' and branches into two parallel paths: 'Unstructured SS Notify' and 'Unstructured SS Request'. Both paths involve local confirmations and subsequent instructions. A central state contains three wait conditions. From this state, the process can either release the service (leading to 'Abort' and 'Null') or continue with 'USSD release' (leading to 'Null'). + +3389 + +3390 + +Figure 22.10.2/1 (sheet 4 of 4): Process NW\_Init\_USSD\_MSC + +![State transition diagram for process NW_Init_USSD_VLR. The process starts at a Null state, receives an Open_Ind from the HLR, and then branches based on the type of indication (SS_NOTIFY, SS_REQUEST, or P_ABORT/U_ABORT/CLOSE). It then checks the indication, sends responses, and either starts the USSD_VLR process or sets a user error.](61d27a7d74168c5c2f5cd8b0de0a9098_img.jpg) + +**process NW\_Init\_USSD\_VLR** **NI\_USSD\_VLR1(5)** + +Process in the VLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MSC; + signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_USSD_Indication + Wait_For_USSD_Indication --> Check_Indication1[Check_Indication] + Wait_For_USSD_Indication --> Check_Indication2[Check_Indication] + Wait_For_USSD_Indication --> MAP_CLOSE_req + Check_Indication1 --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + Check_Indication1 --> Null2[Null] + Check_Indication2 --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + Check_Indication2 --> Null3[Null] + MAP_CLOSE_req --> Null4[Null] + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_OPEN_req + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_OPEN_req + MAP_OPEN_req --> Receive_Open_Cnf + Receive_Open_Cnf --> Start_USSD_VLR1[Start_USSD_VLR] + Receive_Open_Cnf --> Null5[Null] + Start_USSD_VLR1 --> Wait_For_USSN_Confirm + Start_USSD_VLR1 --> Set_User_Error1[Set User Error] + Start_USSD_VLR1 --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp2 + Start_USSD_VLR1 --> Null6[Null] + Set_User_Error1 --> Null7[Null] + MAP_UNSTRUCTURED_SS_NOTIFY_rsp2 --> Null8[Null] + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_OPEN_req2 + MAP_OPEN_req2 --> Receive_Open_Cnf2 + Receive_Open_Cnf2 --> Start_USSD_VLR2[Start_USSD_VLR] + Receive_Open_Cnf2 --> Null9[Null] + Start_USSD_VLR2 --> Wait_For_USSR_Confirm + Start_USSD_VLR2 --> Set_User_Error2[Set User Error] + Start_USSD_VLR2 --> MAP_UNSTRUCTURED_SS_REQUEST_rsp2 + Start_USSD_VLR2 --> Null10[Null] + Set_User_Error2 --> Null11[Null] + MAP_UNSTRUCTURED_SS_REQUEST_rsp2 --> Null12[Null] + +``` + +State transition diagram for process NW\_Init\_USSD\_VLR. The process starts at a Null state, receives an Open\_Ind from the HLR, and then branches based on the type of indication (SS\_NOTIFY, SS\_REQUEST, or P\_ABORT/U\_ABORT/CLOSE). It then checks the indication, sends responses, and either starts the USSD\_VLR process or sets a user error. + +3391 + +3392 + +**Figure 22.10.3/1 (sheet 1 of 5): Process NW\_Init\_USSD\_VLR** + +![State transition diagram for process NW_Init_USSD_VLR. It starts at 'Wait_For_Next_USSD_Indication' and branches based on incoming indications: MAP_CLOSE_ind, MAP_UNSTRUCTURED_SS_NOTIFY_ind, and MAP_UNSTRUCTURED_SS_REQUEST_ind. Each branch handles the respective indication, sends responses, and returns to the initial wait state or ends in a Null state.](4d1315a63029d027c93c29f2dce12b83_img.jpg) + +**process NW\_Init\_USSD\_VLR** **NI\_USSD\_VLR2(5)** + +Process in the VLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Next_USSD_Indication + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_UNSTRUCTURED_SS_NOTIFY_ind" as MAP_UNSTRUCTURED_SS_NOTIFY_ind + state "MAP_UNSTRUCTURED_SS_REQUEST_ind" as MAP_UNSTRUCTURED_SS_REQUEST_ind + state "Null" as Null + state "Check_Indication" as Check_Indication + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_UNSTRUCTURED_SS_NOTIFY_rsp" as MAP_UNSTRUCTURED_SS_NOTIFY_rsp + state "MAP_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_UNSTRUCTURED_SS_REQUEST_rsp + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSN_Confirm" as Wait_For_USSN_Confirm + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "Wait_For_USSR_Confirm" as Wait_For_USSR_Confirm + state "MAP_UNSTRUCTURED_SS_NOTIFY_rsp" as MAP_UNSTRUCTURED_SS_NOTIFY_rsp + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_Next_USSD_Indication" as Wait_For_Next_USSD_Indication + + Wait_For_Next_USSD_Indication --> MAP_CLOSE_ind + Wait_For_Next_USSD_Indication --> MAP_UNSTRUCTURED_SS_NOTIFY_ind + Wait_For_Next_USSD_Indication --> MAP_UNSTRUCTURED_SS_REQUEST_ind + + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + MAP_UNSTRUCTURED_SS_NOTIFY_ind --> Check_Indication + Check_Indication --> Null : Error + Check_Indication --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp : OK + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + MAP_UNSTRUCTURED_SS_REQUEST_ind --> Check_Indication + Check_Indication --> Null : Error + Check_Indication --> MAP_UNSTRUCTURED_SS_REQUEST_rsp : OK + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Next_USSD_Indication + + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm + Wait_For_USSR_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Next_USSD_Indication + +``` + +State transition diagram for process NW\_Init\_USSD\_VLR. It starts at 'Wait\_For\_Next\_USSD\_Indication' and branches based on incoming indications: MAP\_CLOSE\_ind, MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind, and MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind. Each branch handles the respective indication, sends responses, and returns to the initial wait state or ends in a Null state. + +3393 + +3394 + +**Figure 22.10.3/1 (sheet 2 of 5): Process NW\_Init\_USSD\_VLR** + +![State transition diagram for process NW_Init_USSD_VLR. The diagram is divided into two main sections: upper subtrees (signals to/from VLR) and lower subtrees (signals to/from USSD application). States are represented by rounded rectangles, transitions by arrows, and decision points by diamonds. Labels include MAP_CLOSE_ind, MAP_U_ABORT_req, Null, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm, MAP_U_ABORT_ind, MAP_CLOSE_ind, MAP_NOTICE_ind, MAP_P_ABORT_ind, Receive_Open_ind, From MSC, OK, Vr, Error, Start_USSD_VLR, Abort, Wait_For_USSD_Instruction, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm, Wait_For_Next_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local.](8b41806930c4899e083c07f69462b876_img.jpg) + +**process NW\_Init\_USSD\_VLR** **NI\_USSD\_VLR3(5)** + +Process in the VLR to handle a network initiated USSD transaction + +In the upper subtrees, signals to/from the left are to/from the VLR; signals to/from the right are to/from the HLR + +In the lower subtrees, signals to/from the left are to/from the VLR; signals to/from the right are to/from the USSD application in the VLR + +``` + +stateDiagram-v2 + [*] --> S1 : Wait_For_Next_USSD_Indication, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm + S1 --> S2 : MAP_CLOSE_ind + S2 --> S3 : MAP_U_ABORT_req + S3 --> [*] : Null + S1 --> S4 : MAP_U_ABORT_ind, MAP_CLOSE_ind + S4 --> S5 : MAP_U_ABORT_req + S5 --> [*] : Null + S1 --> S6 : MAP_NOTICE_ind + S6 --> S7 : MAP_CLOSE_req + S7 --> S8 : MAP_U_ABORT_req + S8 --> [*] : Null + S1 --> S9 : MAP_P_ABORT_ind, MAP_U_ABORT_ind + S9 --> S7 + S9 --> S8 + S9 --> [*] : Null + + [*] --> S10 : Null + S10 --> S11 : Receive_Open_ind + S11 --> S12 : OK + S11 --> S13 : Vr, Error + S12 --> S14 : Start_USSD_VLR + S14 --> S10 : OK, Error + S14 --> S13 : OK, Error + S10 --> S15 : Abort + S15 --> S16 : MAP_U_ABORT_req + S16 --> [*] : Null + S10 --> S17 : Wait_For_USSD_Instruction, Wait_For_USSN_Confirm, Wait_For_USSR_Confirm + S17 --> S18 : MAP_U_ABORT_ind, MAP_CLOSE_ind + S18 --> S19 : Abort + S19 --> [*] : Null + S10 --> S20 : Wait_For_Next_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local + S20 --> S18 + +``` + +State transition diagram for process NW\_Init\_USSD\_VLR. The diagram is divided into two main sections: upper subtrees (signals to/from VLR) and lower subtrees (signals to/from USSD application). States are represented by rounded rectangles, transitions by arrows, and decision points by diamonds. Labels include MAP\_CLOSE\_ind, MAP\_U\_ABORT\_req, Null, Wait\_For\_USSN\_Confirm, Wait\_For\_USSR\_Confirm, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind, MAP\_NOTICE\_ind, MAP\_P\_ABORT\_ind, Receive\_Open\_ind, From MSC, OK, Vr, Error, Start\_USSD\_VLR, Abort, Wait\_For\_USSD\_Instruction, Wait\_For\_USSN\_Confirm, Wait\_For\_USSR\_Confirm, Wait\_For\_Next\_USSD\_Instruction, Wait\_For\_USSN\_Confirm\_Local, Wait\_For\_USSR\_Confirm\_Local. + +3395 + +3396 + +Figure 22.10.3/1 (sheet 3 of 5): Process NW\_Init\_USSD\_VLR + +process NW\_Init\_USSD\_VLR + +NI\_USSD\_VLR4(5) + +Process in the VLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the USSD application in the VLR + +![Flowchart for process NW_Init_USSD_VLR. It starts with 'Null' leading to 'Start USSD', which leads to a decision diamond. The right path from the diamond is labeled 'MAP_OPEN_req' and 'MAP_DELIMITER_req', leading to 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', an 'OK' path leads to 'Wait_For_USSD_Instruction' and a 'Vr, Error' path leads to 'Abort' (which ends at 'Null'). From 'Wait_For_USSD_Instruction', the flow splits into two parallel paths. The left path goes through 'Unstructured SS Notify' to 'Start_USSD_VLR', which then splits into 'OK' (leading to a decision diamond, then 'MAP_UNSTRUCTURED_SS_NOTIFY_req'/'MAP_DELIMITER_req', then 'Wait_For_USSN_Confirm_Local') and 'Error' (leading to 'Set negative response', then 'Unstructured SS Notify negative response', then 'Null'). The right path goes through 'Unstructured SS Request' to 'Start_USSD_VLR', which similarly splits into 'OK' (leading to a decision diamond, then 'MAP_UNSTRUCTURED_SS_REQUEST_req'/'MAP_DELIMITER_req', then 'Wait_For_USSR_Confirm_Local') and 'Error' (leading to 'Set negative response', then 'Unstructured SS Request negative response', then 'Null').](6147b14ea158d1697f84344113b5b027_img.jpg) + +``` + +graph TD + Null1([Null]) --> StartUSSD{{Start USSD}} + StartUSSD --> Decision1{ } + Decision1 -- "MAP_OPEN_req +MAP_DELIMITER_req" --> ReceiveOpenCnf[Receive_Open_Cnf] + ReceiveOpenCnf -- OK --> WaitForUSSDInstruction([Wait_For_USSD_Instruction]) + ReceiveOpenCnf -- "Vr, Error" --> Abort{{Abort}} + Abort --> Null2([Null]) + WaitForUSSDInstruction --> UnstructuredSSNotify{{Unstructured SS Notify}} + WaitForUSSDInstruction --> UnstructuredSSRequest{{Unstructured SS Request}} + UnstructuredSSNotify --> StartUSSDVLR1[Start_USSD_VLR] + StartUSSDVLR1 -- OK --> Decision2{ } + Decision2 -- "MAP_UNSTRUCTURED_SS_NOTIFY_req +MAP_DELIMITER_req" --> WaitForUSSNConfirmLocal([Wait_For_USSN_Confirm_Local]) + StartUSSDVLR1 -- Error --> SetNegativeResponse1[Set negative response] + SetNegativeResponse1 --> UnstructuredSSNotifyNegativeResponse{{Unstructured SS Notify negative response}} + UnstructuredSSNotifyNegativeResponse --> Null3([Null]) + UnstructuredSSRequest --> StartUSSDVLR2[Start_USSD_VLR] + StartUSSDVLR2 -- OK --> Decision3{ } + Decision3 -- "MAP_UNSTRUCTURED_SS_REQUEST_req +MAP_DELIMITER_req" --> WaitForUSSRConfirmLocal([Wait_For_USSR_Confirm_Local]) + StartUSSDVLR2 -- Error --> SetNegativeResponse2[Set negative response] + SetNegativeResponse2 --> UnstructuredSSRequestNegativeResponse{{Unstructured SS Request negative response}} + UnstructuredSSRequestNegativeResponse --> Null4([Null]) + +``` + +Flowchart for process NW\_Init\_USSD\_VLR. It starts with 'Null' leading to 'Start USSD', which leads to a decision diamond. The right path from the diamond is labeled 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req', leading to 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', an 'OK' path leads to 'Wait\_For\_USSD\_Instruction' and a 'Vr, Error' path leads to 'Abort' (which ends at 'Null'). From 'Wait\_For\_USSD\_Instruction', the flow splits into two parallel paths. The left path goes through 'Unstructured SS Notify' to 'Start\_USSD\_VLR', which then splits into 'OK' (leading to a decision diamond, then 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req'/'MAP\_DELIMITER\_req', then 'Wait\_For\_USSN\_Confirm\_Local') and 'Error' (leading to 'Set negative response', then 'Unstructured SS Notify negative response', then 'Null'). The right path goes through 'Unstructured SS Request' to 'Start\_USSD\_VLR', which similarly splits into 'OK' (leading to a decision diamond, then 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_req'/'MAP\_DELIMITER\_req', then 'Wait\_For\_USSR\_Confirm\_Local') and 'Error' (leading to 'Set negative response', then 'Unstructured SS Request negative response', then 'Null'). + +3397 + +3398 + +Figure 22.10.3/1 (sheet 4 of 5): Process NW\_Init\_USSD\_VLR + +![State transition diagram for process NW_Init_USSD_VLR. It starts with 'Wait_For_Next_USSD_Instruction' and branches into three paths: USSD release, Unstructured SS Notify, and Unstructured SS Request. Each path involves MAP requests, local confirmation checks, and subsequent responses or acknowledgments before returning to the initial wait state.](8d5aefe6fd62d986007fc4724ad48628_img.jpg) + +**process NW\_Init\_USSD\_VLR** **NI\_USSD\_VLR5(5)** + +Process in the VLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the USSD application in the VLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Next_USSD_Instruction + state "Wait_For_Next_USSD_Instruction" as Wait_For_Next_USSD_Instruction + state "USSD release" as USSD_release + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Null" as Null + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "Wait_For_USSN_Confirm_Local" as Wait_For_USSN_Confirm_Local + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "Check_Confirmation" as Check_Confirmation + state "Set negative response" as Set_negative_response + state "Set ack" as Set_ack + state "Unstructured SS Notify negative response" as Unstructured_SS_Notify_negative_response + state "Unstructured SS Notify ack" as Unstructured_SS_Notify_ack + state "MAP_UNSTRUCTURED_SS_REQUEST_req" as MAP_UNSTRUCTURED_SS_REQUEST_req + state "Wait_For_USSR_Confirm_Local" as Wait_For_USSR_Confirm_Local + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "Unstructured SS Request negative response" as Unstructured_SS_Request_negative_response + state "Unstructured SS Request ack" as Unstructured_SS_Request_ack + + Wait_For_Next_USSD_Instruction --> USSD_release + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Notify + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Request + + USSD_release --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + Null --> Wait_For_Next_USSD_Instruction + + Unstructured_SS_Notify --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local + Wait_For_USSN_Confirm_Local --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Check_Confirmation + Check_Confirmation --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirmation --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Notify_negative_response + Set_ack --> Unstructured_SS_Notify_ack + Unstructured_SS_Notify_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Notify_ack --> Wait_For_Next_USSD_Instruction + + Unstructured_SS_Request --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local + Wait_For_USSR_Confirm_Local --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Check_Confirmation + Check_Confirmation --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirmation --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Request_negative_response + Set_ack --> Unstructured_SS_Request_ack + Unstructured_SS_Request_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Request_ack --> Wait_For_Next_USSD_Instruction + +``` + +State transition diagram for process NW\_Init\_USSD\_VLR. It starts with 'Wait\_For\_Next\_USSD\_Instruction' and branches into three paths: USSD release, Unstructured SS Notify, and Unstructured SS Request. Each path involves MAP requests, local confirmation checks, and subsequent responses or acknowledgments before returning to the initial wait state. + +3399 + +3400 + +**Figure 22.10.3/1 (sheet 5 of 5): Process NW\_Init\_USSD\_VLR** + +macrodefinition Start\_USSD\_VLR + +S\_USSD\_VLR1(2) + +Macro in the VLR to page the MS to start a network initiated USSD transaction + +Signals to/from the left are to/from the MSC + +![Flowchart for macrodefinition Start_USSD_VLR. It starts with an entry point, followed by a decision 'Subscriber data confirmed by HLR?'. If 'No', it goes to 'Set User Error: System Failure' then 'Error'. If 'Yes', it goes to 'IMSI detached?'. If 'Yes', it goes to 'Set User Error: Absent Subscriber' then 'Error'. If 'No', it goes to 'Roaming allowed in current location area?'. If 'No', it goes to 'Error'. If 'Yes', it goes to 'LAI known?'. If 'No', it goes to 'Confirmed by Radio Contact?'. If 'Yes', it goes to 'MAP_PAGE_req' and 'MAP_DELIMITER_req', then 'Wait_For_Access_Request'. If 'No', it goes to 'MAP_SEARCH_FOR_MS_req' and 'MAP_DELIMITER_req', then 'Wait_For_Access_Request'.](5175a695be4c949bfb94d01307f8e0fa_img.jpg) + +``` + +graph TD + Entry([ ]) --> D1{Subscriber data confirmed by HLR?} + D1 -- No --> E1[Set User Error: System Failure] + E1 --> Error((Error)) + D1 -- Yes --> D2{IMSI detached?} + D2 -- Yes --> E2[Set User Error: Absent Subscriber] + E2 --> Error + D2 -- No --> D3{Roaming allowed in current location area?} + D3 -- No --> Error + D3 -- Yes --> D4{LAI known?} + D4 -- No --> D5{Confirmed by Radio Contact?} + D5 -- Yes --> P1[MAP_PAGE_req +MAP_DELIMITER_req] + D5 -- No --> S1[MAP_SEARCH_FOR_MS_req +MAP_DELIMITER_req] + P1 --> W[Wait_For_Access_Request] + S1 --> W + +``` + +Flowchart for macrodefinition Start\_USSD\_VLR. It starts with an entry point, followed by a decision 'Subscriber data confirmed by HLR?'. If 'No', it goes to 'Set User Error: System Failure' then 'Error'. If 'Yes', it goes to 'IMSI detached?'. If 'Yes', it goes to 'Set User Error: Absent Subscriber' then 'Error'. If 'No', it goes to 'Roaming allowed in current location area?'. If 'No', it goes to 'Error'. If 'Yes', it goes to 'LAI known?'. If 'No', it goes to 'Confirmed by Radio Contact?'. If 'Yes', it goes to 'MAP\_PAGE\_req' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_Access\_Request'. If 'No', it goes to 'MAP\_SEARCH\_FOR\_MS\_req' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_Access\_Request'. + +3401 + +3402 + +Figure 22.10.3/2 (sheet 1 of 2): Macro Start\_USSD\_VLR + +![Flowchart for macro definition Start_USSD_VLR. It starts with 'Wait_For_Access_Request' and branches into four paths: 'MAP_U_ABORT_ind' (Error), 'Process_Access_Request_VLR' (OK/Error), 'MAP_PAGE_cnf' (User Error/Absent subscriber/System failure), and 'MAP_SEARCH_FOR_MS_cnf' (OK/Update LAI/Confirmed/Wait_For_Access_Request or Provider Error/Data Error).](86ab158965bc6f92917abcc615d51e57_img.jpg) + +macrodefinition Start\_USSD\_VLR + +S\_USSD\_VLR2(2) + +Macro in the VLR to page the MS to start a network initiated USSD transaction + +Signals to/from the left are to/from the MSC + +``` + +graph TD + Start([Wait_For_Access_Request]) --> MAP_U_ABORT_ind[/MAP_U_ABORT_ind/] + Start --> Process_Access_Request_VLR[Process_Access_Request_VLR] + Start --> MAP_PAGE_cnf[/MAP_PAGE_cnf/] + Start --> MAP_SEARCH_FOR_MS_cnf[/MAP_SEARCH_FOR_MS_cnf/] + + MAP_U_ABORT_ind --> Error1((Error)) + + Process_Access_Request_VLR -- OK --> OK1((OK)) + Process_Access_Request_VLR -- Error --> Error2((Error)) + + MAP_PAGE_cnf -- User Error --> Error3((Error)) + MAP_PAGE_cnf -- Yes --> Set_User_Error_Absent[Set User Error: Absent subscriber] + MAP_PAGE_cnf -- No --> Set_User_Error_System[Set User Error: System failure] + Set_User_Error_Absent --> MAP_CLOSE_req[/MAP_CLOSE_req/] + Set_User_Error_System --> MAP_CLOSE_req + MAP_CLOSE_req --> Error4((Error)) + + MAP_SEARCH_FOR_MS_cnf -- OK --> Update_LAI[Update LAI] + Update_LAI --> Confirmed[Confirmed by Radio Contact= Confirmed] + Confirmed --> Wait_For_Access_Request2([Wait_For_Access_Request]) + + MAP_SEARCH_FOR_MS_cnf -- "Provider Error, Data Error" --> Error5((Error)) + +``` + +Flowchart for macro definition Start\_USSD\_VLR. It starts with 'Wait\_For\_Access\_Request' and branches into four paths: 'MAP\_U\_ABORT\_ind' (Error), 'Process\_Access\_Request\_VLR' (OK/Error), 'MAP\_PAGE\_cnf' (User Error/Absent subscriber/System failure), and 'MAP\_SEARCH\_FOR\_MS\_cnf' (OK/Update LAI/Confirmed/Wait\_For\_Access\_Request or Provider Error/Data Error). + +3403 + +3404 + +Figure 22.10.3/2 (sheet 2 of 2): Macro Start\_USSD\_VLR + +![State transition diagram for process NW_Init_USSD_HLR. The process starts at an initial state, goes to 'Null', then receives an 'Open_ind' from gsmSCF or secondary HLR. It then enters 'Wait_For_USSD_Indication'. From there, it branches based on indications: 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' then 'Null'; 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' leads to 'Null'; 'MAP_UNSTRUCTURED_SS_REQUEST_ind' leads to 'Check_Indication'. 'Check_Indication' has 'OK' (to 'Start_USSD_HLR') and 'Error' (to 'Null') paths. 'Start_USSD_HLR' has 'OK' (to connector 1), 'Abort' (to 'MAP_U_ABORT_req' then 'Null'), and 'Error' (to 'Null') paths. Another 'Check_Indication' block on the right has 'OK' (to 'Start_USSD_HLR'), 'Error' (to 'Null'), and 'Abort' (to 'MAP_U_ABORT_req' then 'Null') paths. 'Start_USSD_HLR' also has an 'OK' path to connector 2. A third 'Check_Indication' block in the middle leads to 'Null'.](1f3d7b206a7e807b225da932f6e47236_img.jpg) + +**process NW\_Init\_USSD\_HLR** **NI\_USSD\_HLR1(5)** + +Process in the HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +``` + +stateDiagram-v2 + [*] --> Null + Null --> Receive_Open_ind + Receive_Open_ind --> Wait_For_USSD_Indication + Wait_For_USSD_Indication --> MAP_NOTICE_ind + Wait_For_USSD_Indication --> MAP_P_ABORT_ind + Wait_For_USSD_Indication --> MAP_UNSTRUCTURED_SS_REQUEST_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + MAP_P_ABORT_ind --> Null + MAP_UNSTRUCTURED_SS_REQUEST_ind --> Check_Indication_R + Check_Indication_R --> Start_USSD_HLR_R + Start_USSD_HLR_R --> Null + Start_USSD_HLR_R --> MAP_U_ABORT_req_R + Start_USSD_HLR_R --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + Start_USSD_HLR_R --> Null + Start_USSD_HLR_R --> 2 + Check_Indication_M --> Null + Check_Indication --> Start_USSD_HLR + Start_USSD_HLR --> Null + Start_USSD_HLR --> MAP_U_ABORT_req + Start_USSD_HLR --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + Start_USSD_HLR --> Null + Start_USSD_HLR --> 1 + +``` + +State transition diagram for process NW\_Init\_USSD\_HLR. The process starts at an initial state, goes to 'Null', then receives an 'Open\_ind' from gsmSCF or secondary HLR. It then enters 'Wait\_For\_USSD\_Indication'. From there, it branches based on indications: 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' then 'Null'; 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' leads to 'Null'; 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind' leads to 'Check\_Indication'. 'Check\_Indication' has 'OK' (to 'Start\_USSD\_HLR') and 'Error' (to 'Null') paths. 'Start\_USSD\_HLR' has 'OK' (to connector 1), 'Abort' (to 'MAP\_U\_ABORT\_req' then 'Null'), and 'Error' (to 'Null') paths. Another 'Check\_Indication' block on the right has 'OK' (to 'Start\_USSD\_HLR'), 'Error' (to 'Null'), and 'Abort' (to 'MAP\_U\_ABORT\_req' then 'Null') paths. 'Start\_USSD\_HLR' also has an 'OK' path to connector 2. A third 'Check\_Indication' block in the middle leads to 'Null'. + +3405 + +3406 + +Figure 22.10.4/1 (sheet 1 of 5): Process NW\_Init\_USSD\_HLR + +![State transition diagram for process NW_Init_USSD_HLR. The diagram is divided into two main vertical paths, 1 and 2, which merge into a common horizontal state. Path 1 and 2 start with an initial state (circle with number), leading to a decision diamond. From the diamond, a message block (MAP_OPEN_req, MAP_UNSTRUCTURED_SS_NOTIFY_req, MAP_DELIMITER_req) is sent. This leads to a 'Receive_Open_Cnf' state. From 'Receive_Open_Cnf', an 'OK' transition leads to 'Wait_For_USSN_Confirm' and a 'Vr, Error' transition leads to a 'MAP_U_ABORT_req' state, which then leads to 'Null'. Paths 1 and 2 merge into a common state 'Wait_For_USSN_Confirm, Wait_For_USSR_Confirm'. From this state, four transitions are possible: 1) 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' to the left, 2) 'MAP_NOTICE_ind' to the right, 3) 'MAP_CLOSE_req' to the right, and 4) 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' to the right. The 'MAP_NOTICE_ind' and 'MAP_CLOSE_req' paths both lead to a 'Set User Error: System failure' state. From 'Set User Error: System failure', a 'MAP_UNSTRUCTURED_SS_REQUEST_rsp, MAP_CLOSE_req' message is sent to the left, leading to 'Null'. The 'MAP_CLOSE_req' path also leads to a 'MAP_U_ABORT_req' state, which leads to 'Null'.](524a1954e3bc2e0a657892149a5aab0a_img.jpg) + +**process NW\_Init\_USSD\_HLR** **NI\_USSD\_HLR2(5)** + +Process in the HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +``` + +stateDiagram-v2 + [*] --> 1 + [*] --> 2 + 1 --> D1{ } + D1 --> M1[MAP_OPEN_req +MAP_UNSTRUCTURED_SS_NOTIFY_req +MAP_DELIMITER_req] + M1 --> S1[Receive_Open_Cnf] + S1 --> W1[Wait_For_USSN_Confirm] : OK + S1 --> A1[MAP_U_ABORT_req] : Vr, Error + A1 --> N1[Null] + 2 --> D2{ } + D2 --> M2[MAP_OPEN_req +MAP_UNSTRUCTURED_SS_REQUEST_req +MAP_DELIMITER_req] + M2 --> S2[Receive_Open_Cnf] + S2 --> W2[Wait_For_USSR_Confirm] : OK + S2 --> A2[MAP_U_ABORT_req] : Vr, Error + A2 --> N2[Null] + W1 --> W[Wait_For_USSN_Confirm, Wait_For_USSR_Confirm] + W2 --> W + W --> M3[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] : left + W --> M4[MAP_NOTICE_ind] : right + W --> M5[MAP_CLOSE_req] : right + W --> M6[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] : right + M4 --> S3[Set User Error: System failure] + M5 --> S3 + S3 --> M7[MAP_UNSTRUCTURED_SS_REQUEST_rsp +MAP_CLOSE_req] : left + M7 --> N3[Null] + M5 --> A3[MAP_U_ABORT_req] + A3 --> N4[Null] + +``` + +State transition diagram for process NW\_Init\_USSD\_HLR. The diagram is divided into two main vertical paths, 1 and 2, which merge into a common horizontal state. Path 1 and 2 start with an initial state (circle with number), leading to a decision diamond. From the diamond, a message block (MAP\_OPEN\_req, MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req, MAP\_DELIMITER\_req) is sent. This leads to a 'Receive\_Open\_Cnf' state. From 'Receive\_Open\_Cnf', an 'OK' transition leads to 'Wait\_For\_USSN\_Confirm' and a 'Vr, Error' transition leads to a 'MAP\_U\_ABORT\_req' state, which then leads to 'Null'. Paths 1 and 2 merge into a common state 'Wait\_For\_USSN\_Confirm, Wait\_For\_USSR\_Confirm'. From this state, four transitions are possible: 1) 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' to the left, 2) 'MAP\_NOTICE\_ind' to the right, 3) 'MAP\_CLOSE\_req' to the right, and 4) 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' to the right. The 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_req' paths both lead to a 'Set User Error: System failure' state. From 'Set User Error: System failure', a 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_rsp, MAP\_CLOSE\_req' message is sent to the left, leading to 'Null'. The 'MAP\_CLOSE\_req' path also leads to a 'MAP\_U\_ABORT\_req' state, which leads to 'Null'. + +3407 + +3408 + +**Figure 22.10.4/1 (sheet 2 of 5): Process NW\_Init\_USSD\_HLR** + +![State transition diagram for process NW_Init_USSD_HLR. It starts with Wait_For_Next_USSD_Indication and branches based on incoming indications: MAP_CLOSE_ind, MAP_UNSTRUCTURED_SS_NOTIFY_ind, and MAP_UNSTRUCTURED_SS_REQUEST_ind. Each branch leads to a check, then either a response, a null state, or further signaling.](63db7f66a26834861edbcf76049f647c_img.jpg) + +**process NW\_Init\_USSD\_HLR** **NI\_USSD\_HLR3(5)** + +Process in the HLR to handle a network initiated USSD transaction + +Wait\_For\_Next\_USSD\_Indication + +Signals to/from the left are to/from the VLR; +signals to/from the right are to/from the next node (gsmSCF or secondary HLR) + +``` + +stateDiagram-v2 + [*] --> Wait_For_Next_USSD_Indication + state "MAP_CLOSE_ind" as MAP_CLOSE_ind + state "MAP_UNSTRUCTURED_SS_NOTIFY_ind" as MAP_UNSTRUCTURED_SS_NOTIFY_ind + state "MAP_UNSTRUCTURED_SS_REQUEST_ind" as MAP_UNSTRUCTURED_SS_REQUEST_ind + state "Check_Indication" as Check_Indication + state "Error" as Error + state "OK" as OK + state "Null" as Null + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_UNSTRUCTURED_SS_NOTIFY_rsp" as MAP_UNSTRUCTURED_SS_NOTIFY_rsp + state "MAP_UNSTRUCTURED_SS_REQUEST_rsp" as MAP_UNSTRUCTURED_SS_REQUEST_rsp + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSN_Confirm" as Wait_For_USSN_Confirm + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "Wait_For_Next_USSD_Indication" as Wait_For_Next_USSD_Indication + + Wait_For_Next_USSD_Indication --> MAP_CLOSE_ind + Wait_For_Next_USSD_Indication --> MAP_UNSTRUCTURED_SS_NOTIFY_ind + Wait_For_Next_USSD_Indication --> MAP_UNSTRUCTURED_SS_REQUEST_ind + + MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + MAP_UNSTRUCTURED_SS_NOTIFY_ind --> Check_Indication + Check_Indication --> Error + Check_Indication --> OK + Error --> Null + OK --> MAP_UNSTRUCTURED_SS_NOTIFY_rsp + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + MAP_UNSTRUCTURED_SS_REQUEST_ind --> Check_Indication + Check_Indication --> Error + Check_Indication --> OK + Error --> Null + OK --> MAP_UNSTRUCTURED_SS_REQUEST_rsp + MAP_UNSTRUCTURED_SS_REQUEST_rsp --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Next_USSD_Indication + + MAP_UNSTRUCTURED_SS_NOTIFY_rsp --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm + Wait_For_USSN_Confirm --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Next_USSD_Indication + +``` + +State transition diagram for process NW\_Init\_USSD\_HLR. It starts with Wait\_For\_Next\_USSD\_Indication and branches based on incoming indications: MAP\_CLOSE\_ind, MAP\_UNSTRUCTURED\_SS\_NOTIFY\_ind, and MAP\_UNSTRUCTURED\_SS\_REQUEST\_ind. Each branch leads to a check, then either a response, a null state, or further signaling. + +3409 + +3410 + +Figure 22.10.4/1 (sheet 3 of 5): Process NW\_Init\_USSD\_HLR + +![State transition diagram for process NW_Init_USSD_HLR. The diagram shows two main entry points from 'Null' states: 'Unstructured SS Notify' and 'Unstructured SS Request'. Both lead to 'MS reachable?' decision diamonds. If 'No', they lead to 'Set Negative response: MS not reachable' and then to 'Null'. If 'Yes', they lead to 'Receive_Open_Cnf' blocks. From 'Receive_Open_Cnf', 'OK' leads to 'Wait_For_USSN_Confirm_Local' and 'Vr, Error' leads to 'Abort' and then 'Null'. 'Wait_For_USSN_Confirm_Local' leads to a 'MAP_NOTICE_ind' block, which then leads to 'MAP_CLOSE_req' and 'Abort' to 'Null'. 'Wait_For_USSN_Confirm_Local' also leads to a 'Wait_For_Next_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local' block, which leads to 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' and then to 'Abort' to 'Null'. 'Unstructured SS Request' path is similar but leads to 'Wait_For_USSR_Confirm_Local' and 'MAP_U_ABORT_req' to 'Null'.](b4c2c3df00aa13813eab98fa243a456f_img.jpg) + +**process NW\_Init\_USSD\_HLR** **NI\_USSD\_HLR4(5)** + +Process in the HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the VLR; +signals to/from the right are to/from the USSD application in the HLR + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Unstructured_SS_Notify[Unstructured SS Notify] + Null1 --> Unstructured_SS_Request[Unstructured SS Request] + + Unstructured_SS_Notify --> MS_Reachable_Notify{MS reachable?} + MS_Reachable_Notify -- No --> Set_Neg_Response_Notify[Set Negative response: MS not reachable] + Set_Neg_Response_Notify --> Null2[Null] + + MS_Reachable_Notify -- Yes --> Receive_Open_Cnf_Notify[Receive_Open_Cnf] + Receive_Open_Cnf_Notify -- OK --> Wait_For_USSN_Confirm_Local_Notify[Wait_For_USSN_Confirm_Local] + Receive_Open_Cnf_Notify -- Vr, Error --> Abort_Notify[Abort] + Abort_Notify --> Null3[Null] + + Unstructured_SS_Request --> MS_Reachable_Request{MS reachable?} + MS_Reachable_Request -- No --> Set_Neg_Response_Request[Set Negative response: MS not reachable] + Set_Neg_Response_Request --> Null4[Null] + + MS_Reachable_Request -- Yes --> Receive_Open_Cnf_Request[Receive_Open_Cnf] + Receive_Open_Cnf_Request -- OK --> Wait_For_USSR_Confirm_Local_Request[Wait_For_USSR_Confirm_Local] + Receive_Open_Cnf_Request -- Vr, Error --> Abort_Request[Abort] + Abort_Request --> Null5[Null] + + Wait_For_USSN_Confirm_Local_Notify --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Abort_Notify + Abort_Notify --> Null3 + + Wait_For_USSN_Confirm_Local_Notify --> Wait_For_Next_USSD_Instruction[Wait_For_Next_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local] + Wait_For_Next_USSD_Instruction --> MAP_P_ABORT_ind[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + MAP_P_ABORT_ind --> Abort_Notify + Abort_Notify --> Null3 + + Wait_For_USSR_Confirm_Local_Request --> Wait_For_USSN_Confirm_Local_Request[Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local] + Wait_For_USSN_Confirm_Local_Request --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> Null5 + +``` + +State transition diagram for process NW\_Init\_USSD\_HLR. The diagram shows two main entry points from 'Null' states: 'Unstructured SS Notify' and 'Unstructured SS Request'. Both lead to 'MS reachable?' decision diamonds. If 'No', they lead to 'Set Negative response: MS not reachable' and then to 'Null'. If 'Yes', they lead to 'Receive\_Open\_Cnf' blocks. From 'Receive\_Open\_Cnf', 'OK' leads to 'Wait\_For\_USSN\_Confirm\_Local' and 'Vr, Error' leads to 'Abort' and then 'Null'. 'Wait\_For\_USSN\_Confirm\_Local' leads to a 'MAP\_NOTICE\_ind' block, which then leads to 'MAP\_CLOSE\_req' and 'Abort' to 'Null'. 'Wait\_For\_USSN\_Confirm\_Local' also leads to a 'Wait\_For\_Next\_USSD\_Instruction, Wait\_For\_USSN\_Confirm\_Local, Wait\_For\_USSR\_Confirm\_Local' block, which leads to 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' and then to 'Abort' to 'Null'. 'Unstructured SS Request' path is similar but leads to 'Wait\_For\_USSR\_Confirm\_Local' and 'MAP\_U\_ABORT\_req' to 'Null'. + +3411 + +3412 + +Figure 22.10.4/1 (sheet 4 of 5): Process NW\_Init\_USSD\_HLR + +![State transition diagram for process NW_Init_USSD_HLR. The process starts in 'Wait_For_Next_USSD_Instruction' and branches into three paths: 'USSD release' leading to 'Null', 'Unstructured SS Notify' leading to 'MAP_UNSTRUCTURED_SS_NOTIFY_req' and then 'Wait_For_USSN_Confirm_Local', and 'Unstructured SS Request' leading to 'MAP_UNSTRUCTURED_SS_REQUEST_req' and then 'Wait_For_USSR_Confirm_Local'. Both wait states lead to 'Check_Confirmation' which branches into 'Set negative response' or 'Set ack' based on 'User Error, Data Error, Provider Error' or 'OK'. All paths eventually lead back to 'Wait_For_Next_USSD_Instruction'.](7dd9a58aeb9a178544e2002f8b43f0d7_img.jpg) + +**process NW\_Init\_USSD\_HLR** **NI\_USSD\_HLR5(5)** + +Process in the HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the USSD application in the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Next_USSD_Instruction + state "Wait_For_Next_USSD_Instruction" as Wait_For_Next_USSD_Instruction + state "USSD release" as USSD_release + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Null" as Null + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSN_Confirm_Local" as Wait_For_USSN_Confirm_Local + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "Check_Confirmation" as Check_Confirmation + state "Set negative response" as Set_negative_response + state "Set ack" as Set_ack + state "Unstructured SS Notify negative response" as Unstructured_SS_Notify_negative_response + state "Unstructured SS Notify ack" as Unstructured_SS_Notify_ack + state "MAP_UNSTRUCTURED_SS_REQUEST_req" as MAP_UNSTRUCTURED_SS_REQUEST_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + state "Wait_For_USSR_Confirm_Local" as Wait_For_USSR_Confirm_Local + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "Check_Confirmation" as Check_Confirmation + state "Set negative response" as Set_negative_response + state "Set ack" as Set_ack + state "Unstructured SS Request negative response" as Unstructured_SS_Request_negative_response + state "Unstructured SS Request ack" as Unstructured_SS_Request_ack + + Wait_For_Next_USSD_Instruction --> USSD_release + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Notify + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Request + + USSD_release --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + Unstructured_SS_Notify --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_USSN_Confirm_Local + Wait_For_USSN_Confirm_Local --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Check_Confirmation + Check_Confirmation --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirmation --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Notify_negative_response + Set_ack --> Unstructured_SS_Notify_ack + Unstructured_SS_Notify_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Notify_ack --> Wait_For_Next_USSD_Instruction + + Unstructured_SS_Request --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_USSR_Confirm_Local + Wait_For_USSR_Confirm_Local --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Check_Confirmation + Check_Confirmation --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirmation --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Request_negative_response + Set_ack --> Unstructured_SS_Request_ack + Unstructured_SS_Request_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Request_ack --> Wait_For_Next_USSD_Instruction + +``` + +State transition diagram for process NW\_Init\_USSD\_HLR. The process starts in 'Wait\_For\_Next\_USSD\_Instruction' and branches into three paths: 'USSD release' leading to 'Null', 'Unstructured SS Notify' leading to 'MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req' and then 'Wait\_For\_USSN\_Confirm\_Local', and 'Unstructured SS Request' leading to 'MAP\_UNSTRUCTURED\_SS\_REQUEST\_req' and then 'Wait\_For\_USSR\_Confirm\_Local'. Both wait states lead to 'Check\_Confirmation' which branches into 'Set negative response' or 'Set ack' based on 'User Error, Data Error, Provider Error' or 'OK'. All paths eventually lead back to 'Wait\_For\_Next\_USSD\_Instruction'. + +3413 + +3414 + +Figure 22.10.4/1 (sheet 5 of 5): Process NW\_Init\_USSD\_HLR + +macrodefinition Start\_USSD\_HLR + +S\_USSD\_HLR1(1) + +Macro in the HLR to check the reachability of the subscriber for a network initiated USSD transaction + +![Flowchart for macrodefinition Start_USSD_HLR. It starts with an oval connector, followed by a decision 'Subscriber known?'. If 'No', it goes to an 'Abort' circle. If 'Yes', it goes to 'Location known?'. If 'No', it goes to 'Set User Error: Absent subscriber' box. If 'Yes', it goes to 'MS purged?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' box. If 'No', it goes to a decision diamond (MSC area restricted?). If 'Yes', it goes to 'MSC area restricted?' box. If 'No', it goes to another decision diamond (Roaming restriction due to unsupported feature?). If 'Yes', it goes to 'Roaming restriction due to unsupported feature?' box. Both 'Yes' paths lead to 'Set User Error: Absent subscriber' box. Finally, it leads to either an 'Error' circle or an 'OK' circle.](4fc51a9baa4c09a1aa997449702dcb05_img.jpg) + +``` + +graph TD + Start([ ]) --> D1{Subscriber known?} + D1 -- No --> Abort((Abort)) + D1 -- Yes --> D2{Location known?} + D2 -- No --> SetError[Set User Error: Absent subscriber] + D2 -- Yes --> D3{MS purged?} + D3 -- Yes --> SetError + D3 -- No --> D4{ } + D4 -- Yes --> MSCRestricted[MSC area restricted?] + D4 -- No --> D5{ } + D5 -- Yes --> RoamingRestriction[Roaming restriction due to unsupported feature?] + D5 -- No --> SetError + SetError --> Error((Error)) + D5 -- No --> OK((OK)) + +``` + +Flowchart for macrodefinition Start\_USSD\_HLR. It starts with an oval connector, followed by a decision 'Subscriber known?'. If 'No', it goes to an 'Abort' circle. If 'Yes', it goes to 'Location known?'. If 'No', it goes to 'Set User Error: Absent subscriber' box. If 'Yes', it goes to 'MS purged?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' box. If 'No', it goes to a decision diamond (MSC area restricted?). If 'Yes', it goes to 'MSC area restricted?' box. If 'No', it goes to another decision diamond (Roaming restriction due to unsupported feature?). If 'Yes', it goes to 'Roaming restriction due to unsupported feature?' box. Both 'Yes' paths lead to 'Set User Error: Absent subscriber' box. Finally, it leads to either an 'Error' circle or an 'OK' circle. + +3415 + +3416 + +Figure 22.10.4/2: Macro Start\_USSD\_HLR + +![State transition diagram for process NI_USSD_gsmSCF_Secondary_HLR. The diagram shows two main entry points from 'Null' states. The left path is for 'Unstructured SS Notify' and the right path is for 'Unstructured SS Request'. Both paths lead to 'Receive_Open_Cnf' states with associated MAP messages. From 'Receive_Open_Cnf', 'OK' leads to 'Wait_For_USSN_Confirm_Local' or 'Wait_For_USSR_Confirm_Local' states, while 'Vr, Error' leads to 'Abort' and then 'Null'. The 'Wait' states lead to a central loop involving 'MAP_NOTICE_ind', 'MAP_CLOSE_req', and 'Abort' transitions, eventually returning to 'Null'.](e3ed7cd4fa87f55c884d0d7548b8ae7d_img.jpg) + +**process NI\_USSD\_gsmSCF\_Secondary\_HLR** **NI\_USSD\_SCF1(2)** + +Process in the gsmSCF or secondary HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the USSD application process + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Unstructured_SS_Notify[Unstructured SS Notify] + Null1 --> Unstructured_SS_Request[Unstructured SS Request] + + Unstructured_SS_Notify --> Receive_Open_Cnf_Notify[Receive_Open_Cnf] + Unstructured_SS_Notify --> MAP_Open_Notify[MAP_OPEN_req, MAP_UNSTRUCTURED_SS_NOTIFY_req, MAP_DELIMITER_req] + + Unstructured_SS_Request --> Receive_Open_Cnf_Request[Receive_Open_Cnf] + Unstructured_SS_Request --> MAP_Open_Request[MAP_OPEN_req, MAP_UNSTRUCTURED_SS_REQUEST_req, MAP_DELIMITER_req] + + Receive_Open_Cnf_Notify --> Wait_For_USSN_Confirm_Local_Notify[Wait_For_USSN_Confirm_Local] + Receive_Open_Cnf_Notify --> Abort_Notify[Abort] + Wait_For_USSN_Confirm_Local_Notify --> Null2[Null] + Abort_Notify --> Null2 + + Receive_Open_Cnf_Request --> Wait_For_USSR_Confirm_Local_Request[Wait_For_USSR_Confirm_Local] + Receive_Open_Cnf_Request --> Abort_Request[Abort] + Wait_For_USSR_Confirm_Local_Request --> Null3[Null] + Abort_Request --> Null3 + + Wait_For_USSN_Confirm_Local_Notify --> Wait_For_Next_USSD_Instruction[Wait_For_Next_USSD_Instruction, Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local] + Wait_For_USSR_Confirm_Local_Request --> Wait_For_USSN_Confirm_Local_Wait[Wait_For_USSN_Confirm_Local, Wait_For_USSR_Confirm_Local] + + Wait_For_Next_USSD_Instruction --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_USSN_Confirm_Local_Wait --> Abort_Wait[Abort] + + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> MAP_P_abort_ind[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + MAP_CLOSE_req --> MAP_U_abort_req[MAP_U_ABORT_req] + + MAP_P_abort_ind --> Abort_Wait + MAP_U_abort_req --> Null4[Null] + +``` + +State transition diagram for process NI\_USSD\_gsmSCF\_Secondary\_HLR. The diagram shows two main entry points from 'Null' states. The left path is for 'Unstructured SS Notify' and the right path is for 'Unstructured SS Request'. Both paths lead to 'Receive\_Open\_Cnf' states with associated MAP messages. From 'Receive\_Open\_Cnf', 'OK' leads to 'Wait\_For\_USSN\_Confirm\_Local' or 'Wait\_For\_USSR\_Confirm\_Local' states, while 'Vr, Error' leads to 'Abort' and then 'Null'. The 'Wait' states lead to a central loop involving 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', and 'Abort' transitions, eventually returning to 'Null'. + +3417 + +3418 + +**Figure 22.10.5/1 (sheet 1 of 2): Process NW\_Init\_USSD\_gsmSCF\_secondary\_HLR** + +![State transition diagram for process NI_USSD_gsmSCF_Secondary_HLR. The diagram shows three main paths starting from 'Wait_For_Next_USSD_Instruction': 1) USSD release leads to MAP_CLOSE_req and Null. 2) Unstructured SS Notify leads to MAP_UNSTRUCTURED_SS_NOTIFY_req, Wait_For_USSN_Confirm_Local, MAP_UNSTRUCTURED_SS_NOTIFY_cnf, Check_Confirm, and then either Set negative response or Set ack, leading to Unstructured SS Notify negative response or Unstructured SS Notify ack, and finally back to Wait_For_Next_USSD_Instruction. 3) Unstructured SS Request leads to MAP_UNSTRUCTURED_SS_REQUEST_req, Wait_For_USSR_Confirm_Local, MAP_UNSTRUCTURED_SS_REQUEST_cnf, Check_Confirm, and then either Set negative response or Set ack, leading to Unstructured SS Request negative response or Unstructured SS Request ack, and finally back to Wait_For_Next_USSD_Instruction.](8f58a770e664298894e5d40a9261aafa_img.jpg) + +**process NI\_USSD\_gsmSCF\_Secondary\_HLR** **NI\_USSD\_SCF2(2)** + +Process in the gsmSCF or secondary HLR to handle a network initiated USSD transaction + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the USSD application process + +``` + +stateDiagram-v2 + [*] --> Wait_For_Next_USSD_Instruction + state "Wait_For_Next_USSD_Instruction" as Wait_For_Next_USSD_Instruction + state "USSD release" as USSD_release + state "Unstructured SS Notify" as Unstructured_SS_Notify + state "Unstructured SS Request" as Unstructured_SS_Request + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Null" as Null + state "MAP_UNSTRUCTURED_SS_NOTIFY_req" as MAP_UNSTRUCTURED_SS_NOTIFY_req + state "Wait_For_USSN_Confirm_Local" as Wait_For_USSN_Confirm_Local + state "MAP_UNSTRUCTURED_SS_NOTIFY_cnf" as MAP_UNSTRUCTURED_SS_NOTIFY_cnf + state "Check_Confirm" as Check_Confirm + state "Set negative response" as Set_negative_response + state "Set ack" as Set_ack + state "Unstructured SS Notify negative response" as Unstructured_SS_Notify_negative_response + state "Unstructured SS Notify ack" as Unstructured_SS_Notify_ack + state "MAP_UNSTRUCTURED_SS_REQUEST_req" as MAP_UNSTRUCTURED_SS_REQUEST_req + state "Wait_For_USSR_Confirm_Local" as Wait_For_USSR_Confirm_Local + state "MAP_UNSTRUCTURED_SS_REQUEST_cnf" as MAP_UNSTRUCTURED_SS_REQUEST_cnf + state "Unstructured SS Request negative response" as Unstructured_SS_Request_negative_response + state "Unstructured SS Request ack" as Unstructured_SS_Request_ack + + Wait_For_Next_USSD_Instruction --> USSD_release + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Notify + Wait_For_Next_USSD_Instruction --> Unstructured_SS_Request + + USSD_release --> MAP_CLOSE_req + MAP_CLOSE_req --> Null + + Unstructured_SS_Notify --> MAP_UNSTRUCTURED_SS_NOTIFY_req + MAP_UNSTRUCTURED_SS_NOTIFY_req --> Wait_For_USSN_Confirm_Local + Wait_For_USSN_Confirm_Local --> MAP_UNSTRUCTURED_SS_NOTIFY_cnf + MAP_UNSTRUCTURED_SS_NOTIFY_cnf --> Check_Confirm + Check_Confirm --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirm --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Notify_negative_response + Set_ack --> Unstructured_SS_Notify_ack + Unstructured_SS_Notify_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Notify_ack --> Wait_For_Next_USSD_Instruction + + Unstructured_SS_Request --> MAP_UNSTRUCTURED_SS_REQUEST_req + MAP_UNSTRUCTURED_SS_REQUEST_req --> Wait_For_USSR_Confirm_Local + Wait_For_USSR_Confirm_Local --> MAP_UNSTRUCTURED_SS_REQUEST_cnf + MAP_UNSTRUCTURED_SS_REQUEST_cnf --> Check_Confirm + Check_Confirm --> Set_negative_response : User Error, Data Error, Provider Error + Check_Confirm --> Set_ack : OK + Set_negative_response --> Unstructured_SS_Request_negative_response + Set_ack --> Unstructured_SS_Request_ack + Unstructured_SS_Request_negative_response --> Wait_For_Next_USSD_Instruction + Unstructured_SS_Request_ack --> Wait_For_Next_USSD_Instruction + +``` + +State transition diagram for process NI\_USSD\_gsmSCF\_Secondary\_HLR. The diagram shows three main paths starting from 'Wait\_For\_Next\_USSD\_Instruction': 1) USSD release leads to MAP\_CLOSE\_req and Null. 2) Unstructured SS Notify leads to MAP\_UNSTRUCTURED\_SS\_NOTIFY\_req, Wait\_For\_USSN\_Confirm\_Local, MAP\_UNSTRUCTURED\_SS\_NOTIFY\_cnf, Check\_Confirm, and then either Set negative response or Set ack, leading to Unstructured SS Notify negative response or Unstructured SS Notify ack, and finally back to Wait\_For\_Next\_USSD\_Instruction. 3) Unstructured SS Request leads to MAP\_UNSTRUCTURED\_SS\_REQUEST\_req, Wait\_For\_USSR\_Confirm\_Local, MAP\_UNSTRUCTURED\_SS\_REQUEST\_cnf, Check\_Confirm, and then either Set negative response or Set ack, leading to Unstructured SS Request negative response or Unstructured SS Request ack, and finally back to Wait\_For\_Next\_USSD\_Instruction. + +3419 + +3420 + +**Figure 22.10.5/1 (sheet 2 of 2): Process NW\_Init\_USSD\_gsmSCF\_Secondary\_HLR** + +## 3421 22.11 Common macros for clause 22 + +3422 The following macros are used for the description of more than one of the supplementary service processes described in +3423 clause 22. + +### 3424 22.11.1 SS Password handling macros + +#### 3425 **Macro Get\_Password\_MSC** + +3426 This macro is used by the MSC to relay a request for password from the VLR to the MS, and to relay a response from +3427 the MS back to the VLR. The macro is shown in figure 22.11.1/1. + +#### 3428 **Macro Get\_Password\_VLR** + +3429 This macro is used by the VLR to relay a request for password from the HLR to the MSC, and to relay a response from +3430 the MSC back to the HLR. The macro invokes a macro not defined in this clause; the definition of this macro can be +3431 found as follows: + +3432     Check\_Indication               see clause 25.2.1. + +3433 The macro is shown in figure 22.11.1/2. + +### 3434 22.11.2 Void + +![Sequence diagram for Get_Password_MSC macro. The process starts with a MAP_GET_PASSWORD_ind, followed by an A_GET_PASSWORD_req. It then enters a 'Wait_For_Password' state. From there, three possible outcomes are shown: 1) A CM SERV_RELEASE_ind leads to a MAP_U_ABORT_req and an A_CM_RELEASE_COMPLETE_req, ending in a Null state. 2) An A_GET_PASSWORD_cnf leads to a MAP_GET_PASSWORD_rsp and a MAP_DELIMITER_req, ending in an OK state. 3) An unlabeled signal leads to a MAP_U_ABORT_ind and a MAP_CLOSE_ind, followed by an A_CM_RELEASE_req and ending in a Null state. A note indicates that signals to/from the left are to/from the MS, and signals to/from the right are to/from the VLR. Another note indicates this macro relays a password request and response.](a50ae81de6cad563aeaa11bc7d744359_img.jpg) + +macrodefinition Get\_Password\_MSC Get\_Pwd\_MSC1(1) + +Macro in the MSC to relay a password request and response + +Signals to/from the left are to/from the MS; +signals to/from the right are to/from the VLR + +``` + +sequenceDiagram + participant MS + participant VLR + Note left of MS: Macro in the MSC to relay a password request and response + Note right of VLR: Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + + MS->>VLR: MAP_GET_PASSWORD_ind + VLR->>MS: A_GET_PASSWORD_req + Note right of VLR: Wait_For_Password + alt Path 1: CM Release + VLR->>MS: A_CM_SERV_RELEASE_ind + MS->>VLR: MAP_U_ABORT_req + Note right of VLR: Application procedure cancellation + VLR->>MS: A_CM_RELEASE_COMPLETE_req + Note right of MS: Null + alt Path 2: Password Confirm + VLR->>MS: A_GET_PASSWORD_cnf + MS->>VLR: MAP_GET_PASSWORD_rsp + Note right of VLR: MAP_DELIMITER_req + Note right of MS: OK + alt Path 3: Abort/Close + VLR->>MS: + MS->>VLR: MAP_U_ABORT_ind + Note right of VLR: MAP_CLOSE_ind + VLR->>MS: A_CM_RELEASE_req + Note right of MS: Null + +``` + +Sequence diagram for Get\_Password\_MSC macro. The process starts with a MAP\_GET\_PASSWORD\_ind, followed by an A\_GET\_PASSWORD\_req. It then enters a 'Wait\_For\_Password' state. From there, three possible outcomes are shown: 1) A CM SERV\_RELEASE\_ind leads to a MAP\_U\_ABORT\_req and an A\_CM\_RELEASE\_COMPLETE\_req, ending in a Null state. 2) An A\_GET\_PASSWORD\_cnf leads to a MAP\_GET\_PASSWORD\_rsp and a MAP\_DELIMITER\_req, ending in an OK state. 3) An unlabeled signal leads to a MAP\_U\_ABORT\_ind and a MAP\_CLOSE\_ind, followed by an A\_CM\_RELEASE\_req and ending in a Null state. A note indicates that signals to/from the left are to/from the MS, and signals to/from the right are to/from the VLR. Another note indicates this macro relays a password request and response. + +3435 + +3436 + +Figure 22.11.1/1: Macro Get\_Password\_MSC + +![Sequence diagram for macro Get_Password_VLR. The process starts with an indication MAP_GET_PASSWORD_ind, followed by a 'Check_Indication' block. If 'Error', it sends MAP_U_ABORT_req to the left and ends at a 'Null' state. If 'OK', it sends MAP_GET_PASSWORD_req and MAP_DELIMITER_req to the right, enters 'Wait_For_Password' state, and then branches based on incoming signals (MAP_U_ABORT_ind, MAP_GET_PASSWORD_cnf, MAP_NOTICE_ind, MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind). The 'MAP_GET_PASSWORD_cnf' path leads to a response MAP_GET_PASSWORD_rsp and MAP_DELIMITER_req to the right, ending at an 'OK' state. Other paths lead to 'Null' states via MAP_U_ABORT_req or MAP_CLOSE_req.](a7de6044abdc076b478fd75ba2473648_img.jpg) + +macrodefinition Get\_Password\_VLR Get\_Pwd\_VLR1(1) + +Macro in the VLR to relay a password request and response + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +``` + +sequenceDiagram + participant VLR + Note left of VLR: Macro in the VLR to relay a password request and response + Note right of VLR: Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + + VLR->>VLR: MAP_GET_PASSWORD_ind + VLR->>VLR: Check_Indication + alt Error + VLR->>Left: MAP_U_ABORT_req + VLR-->>Null1((Null)) + else OK + VLR->>Right: MAP_GET_PASSWORD_req + VLR->>Right: MAP_DELIMITER_req + VLR->>VLR: Wait_For_Password + alt MAP_U_ABORT_ind, MAP_CLOSE_ind + VLR->>Left: MAP_U_ABORT_req + VLR-->>Null2((Null)) + else MAP_GET_PASSWORD_cnf + VLR->>Right: MAP_GET_PASSWORD_rsp + VLR->>Right: MAP_DELIMITER_req + VLR-->>OK((OK)) + else MAP_NOTICE_ind + VLR->>Right: MAP_CLOSE_req + VLR-->>Null3((Null)) + else MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind + VLR->>Right: MAP_CLOSE_req + VLR-->>Null4((Null)) + end + end + +``` + +Sequence diagram for macro Get\_Password\_VLR. The process starts with an indication MAP\_GET\_PASSWORD\_ind, followed by a 'Check\_Indication' block. If 'Error', it sends MAP\_U\_ABORT\_req to the left and ends at a 'Null' state. If 'OK', it sends MAP\_GET\_PASSWORD\_req and MAP\_DELIMITER\_req to the right, enters 'Wait\_For\_Password' state, and then branches based on incoming signals (MAP\_U\_ABORT\_ind, MAP\_GET\_PASSWORD\_cnf, MAP\_NOTICE\_ind, MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind). The 'MAP\_GET\_PASSWORD\_cnf' path leads to a response MAP\_GET\_PASSWORD\_rsp and MAP\_DELIMITER\_req to the right, ending at an 'OK' state. Other paths lead to 'Null' states via MAP\_U\_ABORT\_req or MAP\_CLOSE\_req. + +3437 + +3438 + +Figure 22.11.1/2: Macro Get\_Password\_VLR + +3439 + +Figure 22.11.2/1 void + +3440 + +Figure 22.11.2/2 void + +3441 + +Figure 22.11.2/3 void + +3442 + +Figure 22.11.2/4 void + + + +## 22.12 Supplementary Service Invocation Notification procedure + +### 22.12.1 General + +The Supplementary Service Invocation Notification procedure is used to notify a gsmSCF about the invocation of a GSM Supplementary Service. + +The supplementary service invocation notification procedure is shown in figure 22.12.1/1. + +The following service is certainly used: + +MAP\_SS\_INVOCATION\_NOTIFY (defined in clause 11). + +![Sequence diagram showing the message flow for supplementary service invocation notification between an MSC and a gsmSCF. The MSC sends a message to the gsmSCF (labeled 1), and the gsmSCF sends a response back to the MSC (labeled 2).](cf347939c11f91fbebf49d96e8713d63_img.jpg) + +``` +sequenceDiagram + participant MSC + participant gsmSCF + Note right of gsmSCF: 1 + MSC->>gsmSCF: MAP_SS_INVOCATION_NOTIFY_req/ind + Note left of MSC: 2 + gsmSCF-->>MSC: MAP_SS_INVOCATION_NOTIFY_rsp/cnf +``` + +Sequence diagram showing the message flow for supplementary service invocation notification between an MSC and a gsmSCF. The MSC sends a message to the gsmSCF (labeled 1), and the gsmSCF sends a response back to the MSC (labeled 2). + +- 1) MAP\_SS\_INVOCATION\_NOTIFY\_req/ind +2) MAP\_SS\_INVOCATION\_NOTIFY\_rsp/cnf +- Figure 22.12.1/1: Message flow for supplementary service invocation notification** + +### 22.12.2 Procedure in the MSC + +The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2. + +The supplementary service invocation notification process in the MSC is shown in figure 22.12.2/1. + +### 22.12.3 Procedure in the gsmSCF + +The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1. + +The supplementary service invocation notification process in the gsmSCF is shown in figure 22.12.3/1. + +![Sequence diagram for process Notify_SS_Invocation_MSC. The process starts with an initial node, followed by 'Null', 'Note SS invocation', and a request block containing MAP_OPEN_req, MAP_SS_INVOCATION_NOTIFY_req, and MAP_DELIMITER_req. It then enters 'Receive_Open_Cnf', which leads to 'Abort' on error or 'Wait_For_gsmSCF_Response' on OK. The wait state leads to three parallel paths: one for MAP_P_ABORT_ind, MAP_U_ABORT_ind, and MAP_CLOSE_ind; one for MAP_NOTICE_ind leading to MAP_CLOSE_req; and one for MAP_SS_INVOCATION_NOTIFY_cnf leading to 'Check_Confirmation'. 'Check_Confirmation' leads to 'Note SS invocation ack' on OK, or 'Set Negative response: System failure' on User Error or Provider/Data Error, which then leads to 'Note SS invocation negative response'. All three parallel paths eventually lead to a 'Null' terminal node.](222390abf7ceb44aaaf7f6e994ec33ff_img.jpg) + +**process Notify\_SS\_Invocation\_MSC** **NSSI\_MSC1(1)** + +Process in the MSC to notify the gsmSCF that a supplementary service has been invoked + +Signals to/from the left are to/from the SS handling application process in the MSC; signals to/from the right are to/from the gsmSCF + +``` + +sequenceDiagram + participant Start as + participant Null1[Null] + participant NoteSS[Note SS invocation] + participant Req["MAP_OPEN_req +MAP_SS_INVOCATION_NOTIFY_req +MAP_DELIMITER_req"] + participant RecOpenCnf[Receive_Open_Cnf] + participant Abort{Abort} + participant WaitForResponse[Wait_For_gsmSCF_Response] + participant PAbortInd["MAP_P_ABORT_ind, +MAP_U_ABORT_ind, +MAP_CLOSE_ind"] + participant NoticeInd[MAP_NOTICE_ind] + participant CloseReq[MAP_CLOSE_req] + participant ConfirmCnf[MAP_SS_INVOCATION_NOTIFY_cnf] + participant CheckConfirmation[Check_Confirmation] + participant NegResponse1[Set Negative response: +System failure] + participant NegResponse2[Set Negative response: +System failure] + participant NegResponse3[Set Negative response: +System failure] + participant NoteSSNeg[Note SS invocation negative response] + participant NoteSSAck[Note SS invocation ack] + participant Null2[Null] + participant Null3[Null] + participant Null4[Null] + + Note left of Start: Process in the MSC to notify the gsmSCF that a supplementary service has been invoked + Start --> Null1 + Null1 --> NoteSS + NoteSS --> Req + Req --> RecOpenCnf + RecOpenCnf --> Abort: Vr, Error + RecOpenCnf --> WaitForResponse: OK + Abort --> Null2 + WaitForResponse --> PAbortInd + WaitForResponse --> NoticeInd + WaitForResponse --> ConfirmCnf + PAbortInd --> NegResponse1 + NoticeInd --> CloseReq + CloseReq --> NegResponse1 + ConfirmCnf --> CheckConfirmation + CheckConfirmation --> NoteSSAck: OK + CheckConfirmation --> NegResponse2: User Error + CheckConfirmation --> NegResponse3: Provider Error, Data Error + NegResponse1 --> NoteSSNeg + NoteSSNeg --> Null2 + NoteSSAck --> Null3 + NegResponse2 --> NoteSSNeg + NoteSSNeg --> Null4 + NegResponse3 --> NoteSSNeg + NoteSSNeg --> Null4 + +``` + +Sequence diagram for process Notify\_SS\_Invocation\_MSC. The process starts with an initial node, followed by 'Null', 'Note SS invocation', and a request block containing MAP\_OPEN\_req, MAP\_SS\_INVOCATION\_NOTIFY\_req, and MAP\_DELIMITER\_req. It then enters 'Receive\_Open\_Cnf', which leads to 'Abort' on error or 'Wait\_For\_gsmSCF\_Response' on OK. The wait state leads to three parallel paths: one for MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, and MAP\_CLOSE\_ind; one for MAP\_NOTICE\_ind leading to MAP\_CLOSE\_req; and one for MAP\_SS\_INVOCATION\_NOTIFY\_cnf leading to 'Check\_Confirmation'. 'Check\_Confirmation' leads to 'Note SS invocation ack' on OK, or 'Set Negative response: System failure' on User Error or Provider/Data Error, which then leads to 'Note SS invocation negative response'. All three parallel paths eventually lead to a 'Null' terminal node. + +3465 + +3466 + +**Figure 22.12.2/1: Process Notify\_SS\_Invocation\_MSC** + +![Flowchart for process Note_SS_Invocation_gsmSCF. It starts with an initial state leading to 'Null', then 'Receive Open_Ind'. From 'Receive Open_Ind', an 'OK' path leads to 'Wait_For_Service_Indication' and a 'Vr, Error' path leads to 'Null'. 'Wait_For_Service_Indication' leads to a junction. One path from the junction goes left through 'MAP_P_ABORT_ind' and 'MAP_NOTICE_ind' to 'MAP_CLOSE_req' and then to 'Null'. The other path goes right through a junction to 'MAP_SS_INVOCATION_NOTIFY_ind', then 'Note SS invocation', then 'Wait_For_Application_Response'. 'Wait_For_Application_Response' leads to another junction. One path from this junction goes left through 'Note SS invocation ack' to 'Set Result'. The other path goes right through 'Note SS invocation negative response' to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a third junction. From this junction, a path goes right to 'MAP_SS_INVOCATION_NOTIFY_rsp' and 'MAP_CLOSE_req', and then down to the final 'Null' state.](56c813b6db0a87376846e0f6dde99095_img.jpg) + +**process Note\_SS\_Invocation\_gsmSCF** **NSSI\_SCF1(1)** + +Process in the gsmSCF to handle a notification of supplementary service invocation + +Signals to/from the left are to/from the MSC; +signals to/from the right are to/from the application process in the gsmSCF + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- OK --> WaitService[Wait_For_Service_Indication] + RecOpen -- "Vr, Error" --> Null2([Null]) + WaitService --> Junction1(( )) + Junction1 --> MAP_P_ABORT[MAP_P_ABORT_ind] + Junction1 --> MAP_NOTICE[MAP_NOTICE_ind] + Junction1 --> Junction2(( )) + MAP_P_ABORT --> MAP_CLOSE_req{MAP_CLOSE_req} + MAP_NOTICE --> MAP_CLOSE_req + MAP_CLOSE_req --> Null3([Null]) + Junction2 --> MAP_SS_NOTIFY_ind[MAP_SS_INVOCATION_NOTIFY_ind] + MAP_SS_NOTIFY_ind --> NoteSS[Note SS invocation] + NoteSS --> WaitApp[Wait_For_Application_Response] + WaitApp --> Junction3(( )) + Junction3 --> NoteSS_ack[Note SS invocation ack] + Junction3 --> NoteSS_neg[Note SS invocation negative response] + NoteSS_ack --> SetResult[Set Result] + NoteSS_neg --> SetUserError[Set User Error] + SetResult --> Junction4(( )) + SetUserError --> Junction4 + Junction4 --> MAP_SS_NOTIFY_rsp[MAP_SS_INVOCATION_NOTIFY_rsp] + Junction4 --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_SS_NOTIFY_rsp --> Null4([Null]) + MAP_CLOSE_req2 --> Null4 + +``` + +Flowchart for process Note\_SS\_Invocation\_gsmSCF. It starts with an initial state leading to 'Null', then 'Receive Open\_Ind'. From 'Receive Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Indication' and a 'Vr, Error' path leads to 'Null'. 'Wait\_For\_Service\_Indication' leads to a junction. One path from the junction goes left through 'MAP\_P\_ABORT\_ind' and 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req' and then to 'Null'. The other path goes right through a junction to 'MAP\_SS\_INVOCATION\_NOTIFY\_ind', then 'Note SS invocation', then 'Wait\_For\_Application\_Response'. 'Wait\_For\_Application\_Response' leads to another junction. One path from this junction goes left through 'Note SS invocation ack' to 'Set Result'. The other path goes right through 'Note SS invocation negative response' to 'Set User Error'. Both 'Set Result' and 'Set User Error' lead to a third junction. From this junction, a path goes right to 'MAP\_SS\_INVOCATION\_NOTIFY\_rsp' and 'MAP\_CLOSE\_req', and then down to the final 'Null' state. + +3467 + +3468 + +**Figure 22.12.3/1: Process Note\_SS\_Invocation\_gsmSCF** + +3469 **22.13 Activation of a CCBS request** + +3470 **22.13.1 General** + +3471 The message flow to activate a CCBS request is shown in figure 22.13.1/1. + +3472 The following service is certainly used: + +3473        MAP\_REGISTER\_CC\_ENTRY        (defined in clause 11). + +![Sequence diagram showing message flow between VLR and HLR. Step 1: VLR to HLR. Step 2: HLR to VLR.](a8a60ff34b2c12d3b5ae528c9843d3fd_img.jpg) + +``` +sequenceDiagram + participant VLR + participant HLR + Note right of HLR: 1 + VLR->>HLR: + Note left of VLR: 2 + HLR->>VLR: +``` + +Sequence diagram showing message flow between VLR and HLR. Step 1: VLR to HLR. Step 2: HLR to VLR. + +3474 + +3475 + +3476    1)        MAP\_REGISTER\_CC\_ENTRY\_req/ind + +3477    2)        MAP\_REGISTER\_CC\_ENTRY\_rsp/cnf + +3478 + +3479 + +**Figure 22.13.1/1: Message flow to activate a CCBS request** + +3480 **22.13.2 Procedure in the VLR** + +3481 The MAP process in the VLR to activate a CCBS request is shown in figure 22.13.2/1. The MAP process invokes + +3482 macros not defined in this clause; the definitions of these macros can be found as follows: + +3483    Receive\_Open\_Cnf see clause 25.1.2; + +3484    Check\_Confirmation see clause 25.2.2. + +3485 **22.13.3 Procedure in the HLR** + +3486 The MAP process in the HLR to activate a CCBS request is shown in figure 22.13.2/1. + +![Flowchart for process Register_CC_Entry_VLR. It starts with an initial state, followed by a 'Null' state, then a 'CCBS request' input. It then sends MAP messages (MAP_OPEN_req, MAP_REGISTER_CC_ENTRY_req, MAP_DELIMITER_req) and receives 'Open_Cnf'. A 'Wait_For_Response_From_HLR' state follows. From there, it branches based on MAP messages: 'MAP_P_ABORT_ind' leads to 'Vr, Error'; 'MAP_NOTICE_ind' leads to 'MAP CLOSE_req'; 'MAP_REGISTER_CC_ENTRY_cnf' leads to 'Check_Confirmation'. 'Check_Confirmation' branches into 'Provider Error, Data Error', 'User Error', and 'OK'. 'Provider Error, Data Error' and 'User Error' both lead to 'Set Negative response: System failure' and 'CCBS request negative response', ending in 'Null'. 'OK' leads to 'CCBS request ack' and 'Null'. A 'Vr, Error' line also connects to 'Set Negative response: System failure' and 'CCBS request negative response'.](51feb1c455e865f743be045d0b423bb7_img.jpg) + +**process Register\_CC\_Entry\_VLR** **RCCE\_VLR1(1)** + +Process in the VLR to request registration of a Call Completion entry in the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> CCBS_req{CCBS request} + CCBS_req --> MAP_send[ ] + MAP_send --> MAP_req["MAP_OPEN_req +MAP_REGISTER_CC_ENTRY_req +MAP_DELIMITER_req"] + MAP_req --> Open_Cnf[Receive_Open_Cnf] + Open_Cnf --> Wait[Wait_For_Response_From_HLR] + Wait --> MAP_abort{MAP_P_ABORT_ind} + Wait --> MAP_notice{MAP_NOTICE_ind} + Wait --> MAP_cnf{MAP_REGISTER_CC_ENTRY_cnf} + MAP_abort --> Vr_Error[Vr, Error] + MAP_notice --> MAP_close[MAP CLOSE_req] + MAP_cnf --> Check[Check_Confirmation] + Check --> Provider_Error[Provider Error, Data Error] + Check --> User_Error[User Error] + Check --> OK[OK] + Provider_Error --> Neg_Sys[Set Negative response: +System failure] + User_Error --> Neg_User[Set Negative response] + Neg_Sys --> Neg_Req1{CCBS request negative response} + Neg_User --> Neg_Req2{CCBS request negative response} + OK --> Ack{CCBS request ack} + Neg_Req1 --> Null2([Null]) + Neg_Req2 --> Null3([Null]) + Ack --> Null4([Null]) + Vr_Error --> Neg_Sys + Vr_Error --> Neg_Req1 + +``` + +Flowchart for process Register\_CC\_Entry\_VLR. It starts with an initial state, followed by a 'Null' state, then a 'CCBS request' input. It then sends MAP messages (MAP\_OPEN\_req, MAP\_REGISTER\_CC\_ENTRY\_req, MAP\_DELIMITER\_req) and receives 'Open\_Cnf'. A 'Wait\_For\_Response\_From\_HLR' state follows. From there, it branches based on MAP messages: 'MAP\_P\_ABORT\_ind' leads to 'Vr, Error'; 'MAP\_NOTICE\_ind' leads to 'MAP CLOSE\_req'; 'MAP\_REGISTER\_CC\_ENTRY\_cnf' leads to 'Check\_Confirmation'. 'Check\_Confirmation' branches into 'Provider Error, Data Error', 'User Error', and 'OK'. 'Provider Error, Data Error' and 'User Error' both lead to 'Set Negative response: System failure' and 'CCBS request negative response', ending in 'Null'. 'OK' leads to 'CCBS request ack' and 'Null'. A 'Vr, Error' line also connects to 'Set Negative response: System failure' and 'CCBS request negative response'. + +3487 + +3488 + +Figure 22.13.2/1: Process Register\_CC\_Entry\_VLR + +![Flowchart for process Register_CC_Entry_HLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop: a chevron (left) receives 'MAP_REGISTER_CC_ENTRY_ind' from the right, followed by a 'CCBS request' block, and a 'Wait For Application_Response' block. A decision point follows, leading to four paths: 1) 'MAP_NOTICE_ind' (left) leads to 'MAP_CLOSE_req' (left) which then leads to an 'Abort' block (left) and an end symbol. 2) A chevron (left) leads to a block with 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' (right) which then leads to the 'Abort' block. 3) 'CCBS request negative response' (right) leads to 'Ser User Error' (right) which then leads to a chevron (left) receiving 'MAP_REGISTER_CC_ENTRY_rsp' and 'MAP_CLOSE_req' (right) before ending. 4) 'CCBS request ack' (right) leads to 'Set Result' (right) which then leads to the same chevron and response block before ending.](2844c942c7f3a3a71d1ad69519978c0a_img.jpg) + +**process Register\_CC\_Entry\_HLR** **RCCE\_HLR1(1)** + +Process in the HLR to handle a request to register a Call Completion entry + +Signals to/from the left are to/from the VLR; signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> In1{ } + In1 --> In1_Ext[MAP_REGISTER_CC_ENTRY_ind] + In1 --> CCBS[CCBS request] + CCBS --> Wait[Wait For Application_Response] + Wait --> Decision(( )) + + Decision --> Out1{ } + Out1 --> Out1_Ext[MAP_NOTICE_ind] + + Decision --> Out2{ } + + Decision --> Out3{ } + Out3 --> Out3_Ext[CCBS request negative response] + + Decision --> Out4{ } + Out4 --> Out4_Ext[CCBS request ack] + + Out1_Ext --> CloseReq1[MAP_CLOSE_req] + + Out3_Ext --> UserError[Ser User Error] + + Out4_Ext --> SetResult[Set Result] + + CloseReq1 --> Abort[Abort] + + UserError --> In2{ } + + SetResult --> In2 + + In2 --> In2_Ext[MAP_REGISTER_CC_ENTRY_rsp +MAP_CLOSE_req] + + Abort --> End1((X)) + + In2_Ext --> End2((X)) + +``` + +Flowchart for process Register\_CC\_Entry\_HLR. The process starts with an oval, followed by a 'Null' block. It then enters a loop: a chevron (left) receives 'MAP\_REGISTER\_CC\_ENTRY\_ind' from the right, followed by a 'CCBS request' block, and a 'Wait For Application\_Response' block. A decision point follows, leading to four paths: 1) 'MAP\_NOTICE\_ind' (left) leads to 'MAP\_CLOSE\_req' (left) which then leads to an 'Abort' block (left) and an end symbol. 2) A chevron (left) leads to a block with 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' (right) which then leads to the 'Abort' block. 3) 'CCBS request negative response' (right) leads to 'Ser User Error' (right) which then leads to a chevron (left) receiving 'MAP\_REGISTER\_CC\_ENTRY\_rsp' and 'MAP\_CLOSE\_req' (right) before ending. 4) 'CCBS request ack' (right) leads to 'Set Result' (right) which then leads to the same chevron and response block before ending. + +3489 + +3490 + +Figure 22.13.3/1: Process Register\_CC\_Entry\_HLR + +3491 **22.14 Deactivation of a CCBS request** + +3492 **22.14.1 General** + +3493 The message flow to deactivate a CCBS request is shown in figure 22.14.1/1. + +3494 The following service is certainly used: + +3495        MAP\_ERASE\_CC\_ENTRY        (defined in clause 11). + +![Sequence diagram showing message flow between VLR and HLR. Step 1: VLR to HLR. Step 2: HLR to VLR.](41995432d27e3667e838217005d3db93_img.jpg) + +``` +sequenceDiagram + participant VLR + participant HLR + Note right of HLR: 1 + VLR->>HLR: + Note left of VLR: 2 + HLR->>VLR: +``` + +Sequence diagram showing message flow between VLR and HLR. Step 1: VLR to HLR. Step 2: HLR to VLR. + +3496 + +3497 + +3498    1)        MAP\_ERASE\_CC\_ENTRY\_req/ind + +3499    2)        MAP\_ERASE\_CC\_ENTRY\_rsp/cnf + +3500 + +3501 + +**Figure 22.14.1/1: Message flow to deactivate a CCBS request** + +3502 **22.14.2 Procedure in the VLR** + +3503 The MAP process in the VLR to deactivate a CCBS request is shown in figure 22.14.2/1. The MAP process invokes + +3504 macros not defined in this clause; the definitions of these macros can be found as follows: + +3505        Receive\_Open\_Cnf see clause 25.1.2; + +3506        Check\_Confirmation see clause 25.2.2. + +3507 **22.14.3 Procedure in the HLR** + +3508 The MAP process in the HLR to deactivate a CCBS request is shown in figure 22.14.2/1. + +![Flowchart for process Erase_CC_Entry_VLR. The process starts with an initial node, followed by 'Null', 'Deactivate CCBS', and a block with MAP_OPEN_req, MAP_ERASE_CC_ENTRY_req, and MAP_DELIMITER_req. It then enters 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', an 'OK' path leads to 'Wait_For_Response_From_HLR', while a 'Vr, Error' path leads to 'Set Negative response: System failure'. From 'Wait_For_Response_From_HLR', three paths emerge: 'MAP_P_ABORT_ind' leading to 'MAP CLOSE_req', 'MAP NOTICE_ind' leading to 'MAP CLOSE_req', and 'MAP_ERASE_CC_ENTRY_cnf' leading to 'Check Confirmation'. From 'Check Confirmation', three paths emerge: 'Provider Error, Data Error' leading to 'Set Negative response: System failure', 'User Error' leading to 'Set Negative response', and 'OK' leading to 'Deactivate CCBS ack'. All three paths from 'Check Confirmation' lead to 'Null' nodes. Both 'MAP CLOSE_req' and 'Set Negative response: System failure' lead to 'Deactivate CCBS negative response', which then leads to 'Null'.](54d5b7faa03d245014a06e342884c642_img.jpg) + +**process Erase\_CC\_Entry\_VLR** **ECCE\_VLR1(1)** + +Process in the VLR to request erasure of a Call Completion entry in the HLR + +Signals to/from the left are to/from the CCBS application process in the VLR (see 3GPP TS 23.093); signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> DeactivateCCBS1{Deactivate CCBS} + DeactivateCCBS1 --> MAP_Req["MAP_OPEN_req +MAP_ERASE_CC_ENTRY_req +MAP_DELIMITER_req"] + MAP_Req --> ReceiveOpenCnf[Receive_Open_Cnf] + ReceiveOpenCnf -- OK --> WaitForResponse[Wait_For_Response_From_HLR] + ReceiveOpenCnf -- "Vr, Error" --> SetNegSysFailure1[Set Negative response: +System failure] + WaitForResponse -- "MAP_P_ABORT_ind" --> MAPCloseReq1[MAP CLOSE_req] + WaitForResponse -- "MAP NOTICE_ind" --> MAPCloseReq2[MAP CLOSE_req] + WaitForResponse -- "MAP_ERASE_CC_ENTRY_cnf" --> CheckConfirmation[Check Confirmation] + CheckConfirmation -- "Provider Error, Data Error" --> SetNegSysFailure2[Set Negative response: +System failure] + CheckConfirmation -- "User Error" --> SetNegResponse[Set Negative response] + CheckConfirmation -- OK --> DeactivateCCBSAck{Deactivate CCBS ack} + SetNegSysFailure1 --> DeactivateCCBSNeg1{Deactivate CCBS negative response} + SetNegSysFailure2 --> DeactivateCCBSNeg2{Deactivate CCBS negative response} + SetNegResponse --> DeactivateCCBSNeg3{Deactivate CCBS negative response} + DeactivateCCBSAck --> Null2([Null]) + DeactivateCCBSNeg1 --> Null3([Null]) + DeactivateCCBSNeg2 --> Null4([Null]) + DeactivateCCBSNeg3 --> Null5([Null]) + +``` + +Flowchart for process Erase\_CC\_Entry\_VLR. The process starts with an initial node, followed by 'Null', 'Deactivate CCBS', and a block with MAP\_OPEN\_req, MAP\_ERASE\_CC\_ENTRY\_req, and MAP\_DELIMITER\_req. It then enters 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', an 'OK' path leads to 'Wait\_For\_Response\_From\_HLR', while a 'Vr, Error' path leads to 'Set Negative response: System failure'. From 'Wait\_For\_Response\_From\_HLR', three paths emerge: 'MAP\_P\_ABORT\_ind' leading to 'MAP CLOSE\_req', 'MAP NOTICE\_ind' leading to 'MAP CLOSE\_req', and 'MAP\_ERASE\_CC\_ENTRY\_cnf' leading to 'Check Confirmation'. From 'Check Confirmation', three paths emerge: 'Provider Error, Data Error' leading to 'Set Negative response: System failure', 'User Error' leading to 'Set Negative response', and 'OK' leading to 'Deactivate CCBS ack'. All three paths from 'Check Confirmation' lead to 'Null' nodes. Both 'MAP CLOSE\_req' and 'Set Negative response: System failure' lead to 'Deactivate CCBS negative response', which then leads to 'Null'. + +3509 + +3510 + +**Figure 22.14.2/1: Process Erase\_CC\_Entry\_VLR** + +![Flowchart for process Erase_CC_Entry_HLR. It starts with an oval, followed by a 'Null' block, then an input block for 'MAP_ERASE_CC_ENTRY_ind'. This is followed by a 'Deactivate CCBS' block and a 'Wait For Application_Response' block. A decision point follows, leading to four paths: 1) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Abort' -> end; 2) an unlabeled input block -> a block with 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' -> 'Abort' -> end; 3) 'Deactivate CCBS negative response' -> 'Ser User Error' -> an unlabeled output block -> a block with 'MAP_ERASE_CC_ENTRY_rsp, MAP_CLOSE_req' -> end; 4) 'Deactivate CCBS ack' -> 'Set Result' -> the same unlabeled output block -> end.](4b29d7112312e8a8a704a0f9a9db35b2_img.jpg) + +**process Erase\_CC\_Entry\_HLR** **ECCE\_HLR1(1)** + +Process in the HLR to handle a request to erase a Call Completion entry + +Signals to/from the left are to/from the VLR; + signals to/from the right are to/from the CCBS application process in the HLR (see 3GPP TS 23.093) + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> Input1{{ }} + Input1 --- MAP_ERASE_CC_ENTRY_ind[MAP_ERASE_CC_ENTRY_ind] + Input1 --> DeactivateCCBS[Deactivate CCBS] + DeactivateCCBS --> WaitForResponse[Wait For Application_Response] + WaitForResponse --> Decision(( )) + + Decision --> Input2{{ }} + Input2 --- MAP_NOTICE_ind[MAP_NOTICE_ind] + Input2 --> MAP_CLOSE_req[MAP_CLOSE_req] + + Decision --> Input3{{ }} + Input3 --- MAP_P_ABORT_ind[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + + Decision --> Input4{{ }} + Input4 --- DeactivateCCBS_neg[Deactivate CCBS negative response] + + Decision --> Input5{{ }} + Input5 --- DeactivateCCBS_ack[Deactivate CCBS ack] + + MAP_CLOSE_req --> Abort[Abort] + MAP_P_ABORT_ind --> Abort + Abort --> End1((X)) + + DeactivateCCBS_neg --> SerUserError[Ser User Error] + DeactivateCCBS_ack --> SetResult[Set Result] + + SerUserError --> Output1{{ }} + SetResult --> Output1 + + Output1 --- MAP_ERASE_CC_ENTRY_rsp[MAP_ERASE_CC_ENTRY_rsp, MAP_CLOSE_req] + Output1 --> End2((X)) + +``` + +Flowchart for process Erase\_CC\_Entry\_HLR. It starts with an oval, followed by a 'Null' block, then an input block for 'MAP\_ERASE\_CC\_ENTRY\_ind'. This is followed by a 'Deactivate CCBS' block and a 'Wait For Application\_Response' block. A decision point follows, leading to four paths: 1) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Abort' -> end; 2) an unlabeled input block -> a block with 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Abort' -> end; 3) 'Deactivate CCBS negative response' -> 'Ser User Error' -> an unlabeled output block -> a block with 'MAP\_ERASE\_CC\_ENTRY\_rsp, MAP\_CLOSE\_req' -> end; 4) 'Deactivate CCBS ack' -> 'Set Result' -> the same unlabeled output block -> end. + +3511 + +3512 + +Figure 22.14.3/1: Process Erase\_CC\_Entry\_HLR + +--- + +## 3513 23 Short message service procedures + +### 3514 23.1 General + +3515 The short message service procedures are used to control both mobile originated and mobile terminated short message +3516 transfer. + +3517 Four procedures exist for short message services: + +- 3518 - mobile originated short message service transfer; +- 3519 - mobile terminated short message service transfer; +- 3520 - short message alert procedure; +- 3521 - short message delivery status report procedure. + +3522 The following application context refers to a complex MAP user consisting of several processes: + +- 3523 - shortMessageGatewayContext. + +3524 This application context needs a co-ordinating process in the HLR. Additionally a co-ordinating process needed for the +3525 mobile originated situation in the MSC, because the A\_CM\_SERV\_REQ message does not distinguish between mobile +3526 originated short message transfer and the short message alert procedures. + +3527 NOTE: the A\_CM\_SERV\_REQ message is not used for SMS over GPRS. The modelling is based on the +3528 assumption that the SGSN will trigger the appropriate process, according to whether an RP\_MO\_DATA +3529 or an RP\_SM\_MEMORY\_AVAILABLE is received over the LLC layer. + +3530 When the "SMS in MME" architecture option is supported, the clause 23 and its associated figures applies where HSS +3531 replaces HLR and where MME is handled as a MSC, except the procedures between the serving MSC and the VLR +3532 which, here, are not applicable to the MME. + +3533 NOTE: MSC and MME cannot be both registered as serving nodes for MT SMS at a given time (cf 3GPP TS +3534 23.272 [2]) + +### 3535 23.1.1 Mobile originated short message service Co-ordinator for the MSC + +3536 The process starts when the MSC receives an A\_CM\_SERV\_REQ message (see 3GPP TS 24.008 [35]), with a CM +3537 service type indicating short message service, from the A-interface. The process invokes a macro not defined in this +3538 clause; the definition of this macro can be found as follows: + +3539 Process\_Access\_Request\_MSC see clause 25.4.1. + +3540 If the macro Process\_Access\_Request\_MSC takes the "OK" exit (which means that the MSC has sent an +3541 A\_CM\_SERVICE\_ACCEPT to the MS), , the MS initiates mobile originated short message transfer or sends an +3542 indication that it has memory available for more short messages. + +3543 The SMS Co-ordinator process in the MSC is shown in figure 23.1/1. + +### 3544 23.1.2 Short message Gateway Co-ordinator for the HLR + +3545 The process starts when the HLR receives a MAP\_OPEN indication using when the application context +3546 shortMessageGatewayContext. The MAP process invokes a macro not defined in this clause; the definition of this +3547 macro can be found as follows: + +3548 Receive\_Open\_Ind see clause 25.1.1. + +3549 The SM Gateway Co-ordinator process in the HLR is shown in figure 23.1/2. + +3550 If the Receive\_Open\_Ind macro takes the Vr exit then HLR shall perform the MAP dialogue as specified for the +3551 appropriate application context version. Depending on the subscriber data, handling at the MAP user application level +3552 may be performed as specified in clauses 23.3.2 and 23.5.2 of the present document: + +![State transition diagram for process Co_SMS_MSC. The diagram starts with an initial state leading to 'Null', then 'A CM_SERVICE_REQUEST', then 'Process_Access_Request_MSC'. From there, an 'Error' leads to 'Null' and an 'OK' leads to 'Wait_For_Service_Primitive'. A horizontal line connects 'Wait_For_Service_Primitive' to four parallel paths. Path 1: 'A_MM_RELEASE_ind' -> 'MAP_U_ABORT_req' -> 'Null'. Path 2: 'A_RP_MO_DATA' -> 'MO_SM_MSC' -> 'A_RP_MO_DATA' (To offspring) -> 'Relay_Info'. Path 3: 'A_RP_SM_MEMORY_AVAILABLE' -> 'SM_Alert_MSC' -> 'A_RP_SM_MEMORY_AVAILABLE' (To offspring) -> 'Relay_Info'. Path 4: an unlabeled state -> 'MAP_U_ABORT_ind, MAP_CLOSE_ind' -> 'Null'.](cc3fc3e0d3d8b84502df9fb9c840d365_img.jpg) + +process Co\_SMS\_MSC Co\_SMS\_MSC1(2) + +Co-ordinating process in the MSC for mobile originated SMS activity + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the VLR unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> A_CM_SERVICE_REQUEST{A CM_SERVICE_REQUEST} + A_CM_SERVICE_REQUEST --> Process_Access_Request_MSC[Process_Access_Request_MSC] + Process_Access_Request_MSC --> Null2[Null] : Error + Process_Access_Request_MSC --> Wait_For_Service_Primitive{Wait_For_Service_Primitive} : OK + state " " as UnlabeledState + Wait_For_Service_Primitive --> A_MM_RELEASE_ind{A_MM_RELEASE_ind} + Wait_For_Service_Primitive --> A_RP_MO_DATA1{A_RP_MO_DATA} + Wait_For_Service_Primitive --> A_RP_SM_MEMORY_AVAILABLE1{A_RP_SM_MEMORY_AVAILABLE} + Wait_For_Service_Primitive --> UnlabeledState + A_MM_RELEASE_ind --> MAP_U_ABORT_req{{MAP_U_ABORT_req}} + MAP_U_ABORT_req --> Null3[Null] + A_RP_MO_DATA1 --> MO_SM_MSC[MO_SM_MSC] + MO_SM_MSC --> A_RP_MO_DATA2{A_RP_MO_DATA} + A_RP_MO_DATA2 --> To_offspring1[To offspring] + To_offspring1 --> Relay_Info[Relay_Info] + A_RP_SM_MEMORY_AVAILABLE1 --> SM_Alert_MSC[SM_Alert_MSC] + SM_Alert_MSC --> A_RP_SM_MEMORY_AVAILABLE2{A_RP_SM_MEMORY_AVAILABLE} + A_RP_SM_MEMORY_AVAILABLE2 --> To_offspring2[To offspring] + To_offspring2 --> Relay_Info + UnlabeledState --> MAP_U_ABORT_ind_MAP_CLOSE_ind{{MAP_U_ABORT_ind, MAP_CLOSE_ind}} + MAP_U_ABORT_ind_MAP_CLOSE_ind --> Null4[Null] + +``` + +State transition diagram for process Co\_SMS\_MSC. The diagram starts with an initial state leading to 'Null', then 'A CM\_SERVICE\_REQUEST', then 'Process\_Access\_Request\_MSC'. From there, an 'Error' leads to 'Null' and an 'OK' leads to 'Wait\_For\_Service\_Primitive'. A horizontal line connects 'Wait\_For\_Service\_Primitive' to four parallel paths. Path 1: 'A\_MM\_RELEASE\_ind' -> 'MAP\_U\_ABORT\_req' -> 'Null'. Path 2: 'A\_RP\_MO\_DATA' -> 'MO\_SM\_MSC' -> 'A\_RP\_MO\_DATA' (To offspring) -> 'Relay\_Info'. Path 3: 'A\_RP\_SM\_MEMORY\_AVAILABLE' -> 'SM\_Alert\_MSC' -> 'A\_RP\_SM\_MEMORY\_AVAILABLE' (To offspring) -> 'Relay\_Info'. Path 4: an unlabeled state -> 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Null'. + +3553 + +3554 + +Figure 23.1/1 (sheet 1 of 2): Process Co\_SMS\_MSC + +![Sequence diagram for process Co_SMS_MSC. The diagram is split into two subtrees. The upper subtree shows three signal paths starting from a Relay_Info lifeline: 1) A_MM_RELEASE_ind leads to a Null state; 2) A_DISC_ind leads to a Null state; 3) A_* leads to another Relay_Info lifeline. The lower subtree shows four signal paths starting from a Relay_Info lifeline: 1) A signal with MAP_U_ABORT_ind, MAP_CLOSE_ind leads to a Null state; 2) A_* signal leads to a Relay_Info lifeline; 3) A signal with MAP_U_ABORT_ind, MAP_CLOSE_ind leads to a Null state; 4) A '-' signal leads to a Relay_Info lifeline.](c2d91061c4a09b286eb6aaf27bd84a5f_img.jpg) + +**process Co\_SMS\_MSC** **Co\_SMS\_MSC2(2)** + +Co-ordinating process in the MSC for mobile originated SMS activity + +In the upper subtree, signals to/from the left are to/from the MS; signals to/from the right are to/from the child process + +In the lower subtree, signals to/from the left are to/from the VLR; signals to/from the right are to/from the child process + +Sequence diagram for process Co\_SMS\_MSC. The diagram is split into two subtrees. The upper subtree shows three signal paths starting from a Relay\_Info lifeline: 1) A\_MM\_RELEASE\_ind leads to a Null state; 2) A\_DISC\_ind leads to a Null state; 3) A\_\* leads to another Relay\_Info lifeline. The lower subtree shows four signal paths starting from a Relay\_Info lifeline: 1) A signal with MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind leads to a Null state; 2) A\_\* signal leads to a Relay\_Info lifeline; 3) A signal with MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind leads to a Null state; 4) A '-' signal leads to a Relay\_Info lifeline. + +3555 + +3556 + +**Figure 23.1/1 (sheet 2 of 2): Process Co\_SMS\_MSC** + +![Flowchart for process Co_SM_GW_HLR. It starts with an initial node leading to 'Null', then 'Receive_Open_ind' (linked to Figure 25.1/1). From 'Receive_Open_ind', three paths emerge: 'Error' leading to 'Null', 'OK' leading to 'Wait_For_Service_Primitive', and 'Vr' leading to 'Perform Vr dialogue' then 'Null'. 'Wait_For_Service_Primitive' branches into five parallel paths: 1) 'MAP_SEND_ROUTING_INFO_FOR_SM_ind' -> 'MTSM_HLR' -> 'MAP_SEND_ROUTING_INFO_FOR_SM_ind' -> 'Relay_Info'; 2) 'Report_SM_Delivery_Status_HLR' -> 'MAP_REPORT_SM_DELIVERY_STATUS_ind' -> 'Relay_Info'; 3) 'MAP_REPORT_SM_DELIVERY_STATUS_ind' -> 'Relay_Info'; 4) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Null'; 5) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' -> 'Relay_Info'. All five 'Relay_Info' nodes converge to a final horizontal bus. From this bus, four paths emerge: 1) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' -> 'Null'; 2) '*' -> 'Relay_Info'; 3) 'MAP_U_ABORT_ind, MAP_CLOSE_ind' -> 'Null'; 4) '*' -> 'Relay_Info'.](f6d30d19c55b4183969d1e72c52578f3_img.jpg) + +**process Co\_SM\_GW\_HLR** **Co\_SM\_GW\_HLR1(1)** + +Co-ordinating process in the HLR for SMS activity using the shortMsgGatewayContext + +Signals to/from the left are to/from the SMS-GMSC, signals to/from the right are to/from the child process + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive[Receive_Open_ind] + Receive -.-> Fig25_1_1[Figure 25.1/1] + Receive -- Error --> Null2([Null]) + Receive -- OK --> Wait[Wait_For_Service_Primitive] + Receive -- Vr --> VrDialog[Perform Vr dialogue] + VrDialog --> Null3([Null]) + Wait --> Split1(( )) + Split1 --> Path1_1[MAP_SEND_ROUTING_INFO_FOR_SM_ind] + Path1_1 --> Path1_2[MTSM_HLR] + Path1_2 --> Path1_3[MAP_SEND_ROUTING_INFO_FOR_SM_ind] + Path1_3 --> Path1_4[Relay_Info] + Split1 --> Path2_1[Report_SM_Delivery_Status_HLR] + Path2_1 --> Path2_2[MAP_REPORT_SM_DELIVERY_STATUS_ind] + Path2_2 --> Path2_3[Relay_Info] + Split1 --> Path3_1[MAP_REPORT_SM_DELIVERY_STATUS_ind] + Path3_1 --> Path3_2[Relay_Info] + Split1 --> Path4_1[MAP_NOTICE_ind] + Path4_1 --> Path4_2[MAP_CLOSE_req] + Path4_2 --> Path4_3[Null] + Split1 --> Path5_1[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Path5_1 --> Path5_2[Relay_Info] + Path1_4 --> Split2(( )) + Path2_3 --> Split2 + Path3_2 --> Split2 + Path4_3 --> Split2 + Path5_2 --> Split2 + Split2 --> Path6_1[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Path6_1 --> Path6_2[Null] + Split2 --> Path7_1[*] + Path7_1 --> Path7_2[Relay_Info] + Split2 --> Path8_1[MAP_U_ABORT_ind, MAP_CLOSE_ind] + Path8_1 --> Path8_2[Null] + Split2 --> Path9_1[*] + Path9_1 --> Path9_2[Relay_Info] + +``` + +Flowchart for process Co\_SM\_GW\_HLR. It starts with an initial node leading to 'Null', then 'Receive\_Open\_ind' (linked to Figure 25.1/1). From 'Receive\_Open\_ind', three paths emerge: 'Error' leading to 'Null', 'OK' leading to 'Wait\_For\_Service\_Primitive', and 'Vr' leading to 'Perform Vr dialogue' then 'Null'. 'Wait\_For\_Service\_Primitive' branches into five parallel paths: 1) 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ind' -> 'MTSM\_HLR' -> 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ind' -> 'Relay\_Info'; 2) 'Report\_SM\_Delivery\_Status\_HLR' -> 'MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ind' -> 'Relay\_Info'; 3) 'MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ind' -> 'Relay\_Info'; 4) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Null'; 5) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Relay\_Info'. All five 'Relay\_Info' nodes converge to a final horizontal bus. From this bus, four paths emerge: 1) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Null'; 2) '\*' -> 'Relay\_Info'; 3) 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Null'; 4) '\*' -> 'Relay\_Info'. + +3557 + +3558 + +**Figure 23.1/2: Process Co\_SM\_Gateway\_HLR** + +3559 **23.2 The mobile originated short message transfer procedure** + +3560 The mobile originated short message service procedure is used to forward a short message from a mobile subscriber to a + 3561 Service Centre. The message flow for the mobile originated short message service procedure is shown in figure 23.2/1. + +![Sequence diagram showing the mobile originated short message transfer procedure between MS, Serving MSC or SGSN, VLR, Interworking MSC, and SC. The sequence of messages is: 1) Short Message from MS to Serving MSC or SGSN; 2) MAP_SEND_INFO_FOR_MO_SMS from Serving MSC or SGSN to VLR; 3) MAP_SEND_INFO_FOR_MO_SMS_ACK from VLR to Serving MSC or SGSN; 4) TCAP BEGIN from Serving MSC or SGSN to Interworking MSC; 4a) TCAP CONTINUE from Interworking MSC to Serving MSC or SGSN; 4b) MAP_MO_FORWARD_SHORT_MESSAGE from Interworking MSC to Serving MSC or SGSN; 5) Short message from Interworking MSC to SC; 6) Short message Acknowledgement from SC to Interworking MSC; 7) MAP_MO_FORWARD_SHORT_MESSAGE_ACK from Interworking MSC to Serving MSC or SGSN; 8) Short Message Acknowledgement from Serving MSC or SGSN to MS.](2579889c2739c3e124f5ff8f1053054d_img.jpg) + +Sequence diagram showing the mobile originated short message transfer procedure between MS, Serving MSC or SGSN, VLR, Interworking MSC, and SC. The sequence of messages is: 1) Short Message from MS to Serving MSC or SGSN; 2) MAP\_SEND\_INFO\_FOR\_MO\_SMS from Serving MSC or SGSN to VLR; 3) MAP\_SEND\_INFO\_FOR\_MO\_SMS\_ACK from VLR to Serving MSC or SGSN; 4) TCAP BEGIN from Serving MSC or SGSN to Interworking MSC; 4a) TCAP CONTINUE from Interworking MSC to Serving MSC or SGSN; 4b) MAP\_MO\_FORWARD\_SHORT\_MESSAGE from Interworking MSC to Serving MSC or SGSN; 5) Short message from Interworking MSC to SC; 6) Short message Acknowledgement from SC to Interworking MSC; 7) MAP\_MO\_FORWARD\_SHORT\_MESSAGE\_ACK from Interworking MSC to Serving MSC or SGSN; 8) Short Message Acknowledgement from Serving MSC or SGSN to MS. + +3562 + +- 3563 +- 3564 1) Short Message (3GPP TS 24.011 [37]). +- 3565 2) MAP\_SEND\_INFO\_FOR\_MO\_SMS (\*). +- 3566 3) MAP\_SEND\_INFO\_FOR\_MO\_SMS\_ACK (\*). +- 3567 4) TCAP BEGIN (\*\*) +- 3568 4a) TCAP CONTINUE (\*\*) +- 3569 4b) MAP\_MO\_FORWARD\_SHORT\_MESSAGE. +- 3570 5) Short message (3GPP TS 23.040). +- 3571 6) Short message Acknowledgement (3GPP TS 23.040). +- 3572 7) MAP\_MO\_FORWARD\_SHORT\_MESSAGE\_ACK. +- 3573 8) Short Message Acknowledgement (3GPP TS 24.011 [37]). +- 3574 (\*) Messages 2) and 3) are not used by the SGSN. +- 3575 (\*\*) If +- 3576 a) +- 3577 the capacity of a message signal unit in the lower layers of the protocol is enough to carry the content of +- 3578 the MAP\_OPEN request and the content of the MAP\_MO\_FORWARD\_SHORT\_MESSAGE request in a +- 3579 single TC message +- 3580 +- 3581 and +- 3582 b) the Interworking MSC operator and the serving node (MSC or SGSN) operator agreed not to use the +- 3583 TCAP handshake countermeasure against SMS fraud for messages exchanged between their networks +- 3584 (see 3GPP TS 33.204 [34a]) +- 3585 +- 3586 then +- 3587 the TCAP handshake may be omitted. + +3588 **Figure 23.2/1: Mobile originated short message transfer** + +3590 In addition the following MAP services are used: + +- 3591 MAP\_PROCESS\_ACCESS\_REQUEST (see clause 8.3); (\*) +- 3592 MAP\_AUTHENTICATE (see clause 8.5); (\*) +- 3593 MAP\_SET\_CIPHERING\_MODE (see clause 8.6); (\*) +- 3594 MAP\_PROVIDE\_IMSI (see clause 8.9); (\*) + +3595 MAP\_CHECK\_IMEI (see clause 8.7); + 3596 MAP\_FORWARD\_NEW\_TMSI (see clause 8.9); (\*) + 3597 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clause 9.1); (\*) + 3598 MAP\_READY\_FOR\_SM (see clause 12.4). + 3599 (\*) These services are not used by the SGSN. + +## 3600 23.2.1 Procedure in the serving MSC + +3601 Any CAMEL-specific handling defined in this clause is omitted if the MSC does not support CAMEL control of MO + 3602 SMS, or if the subscriber does not have a subscription for CAMEL control of MO SMS. + +3603 The process starts when the MSC receives a short message from the MS. The process invokes macros not defined in this + 3604 clause; the definitions of these macros can be found as follows: + +3605 Receive\_Open\_Cnf see clause 25.1.2; + +3606 Check\_Indication see clause 25.2.1; + +3607 Check\_Confirmation see clause 25.2.2. + +3608 Sheet 1: If the MSC is integrated with the SMS-IWMSC, it communicates directly with the Short Message Service + 3609 Centre (SMSC) using one of the protocols described in 3GPP TS 23.039 [25a]; otherwise it communicates with the + 3610 SMS-IWMSC using MAP. + +3611 Sheet 3: If the capacity of a message signal unit in the lower layers of the protocol is enough to carry the content of the + 3612 MAP\_OPEN request and the content of the MAP\_MO\_FORWARD\_SHORT\_MESSAGE request in a single TC + 3613 message, the test "Message segmentation needed" takes the "No" exit; otherwise the test takes the "Yes" exit. + +3614 Sheet 3: The decision box "TCAP Handshake required" takes the "yes" or "no" exit depending on agreements between + 3615 the serving MSC's operator and the SMS-IWMSC's operator (see 3GPP TS 33.204 [34a]). + +3616 The mobile originated short message service process in the MSC is shown in figure 23.2/2. + +## 3617 23.2.2 Procedure in the VLR + +3618 Any CAMEL-specific handling defined in this clause is omitted if the VLR does not support CAMEL control of MO + 3619 SMS. + +3620 The process starts when the VLR receives a dialogue opening request followed by a + 3621 MAP\_PROCESS\_ACCESS\_REQUEST including a CM service type Short Message Service. The process invokes + 3622 macros not defined in this clause; the definitions of these macros can be found as follows: + +3623 Receive\_Open\_Ind see clause 25.1.1; + +3624 Check\_Indication see clause 25.2.1; + +3625 Process\_Access\_Request\_VLR see clause 25.4.2. + +3626 The mobile originated short message transfer process in the VLR is shown in figure 23.2/3. + +## 3627 23.2.3 Procedure in the SGSN + +3628 Any CAMEL-specific handling defined in this clause is omitted if the SGSN does not support CAMEL control of MO + 3629 SMS, or if the subscriber does not have a subscription for CAMEL control of MO SMS. + +3630 The process starts when the SGSN receives a short message received from the MS over the Gb interface. The MAP + 3631 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3632 Receive\_Open\_Cnf see clause 25.1.2; + +3633 Check\_Confirmation see clause 25.2.2. + +3634 Sheet 2: If the capacity of a message signal unit in the lower layers of the protocol is enough to carry the content of the +3635 MAP\_OPEN request and the content of the MAP\_MO\_FORWARD\_SHORT\_MESSAGE request in a single TC +3636 message, the test "Message segmentation needed" takes the "No" exit; otherwise the test takes the "Yes" exit. + +3637 Sheet 2: The decision box "TCAP Handshake required" takes the "yes" or "no" exit depending on agreements between +3638 the serving SGSN's operator and the SMS-IWMSC's operator (see 3GPP TS 33.204 [34a]). + +3639 The mobile originated short message service process in the SGSN is shown in figure 23.2/4. + +## 3640 23.2.4 Procedure in the SMS Interworking MSC (SMS-IWMSC) + +3641 This procedure applies only when the SMS-IWMSC is not integrated with the serving MSC or SGSN. + +3642 The process starts when the SMS-IWMSC receives a dialogue opening request with the application context +3643 shortMsgMO-RelayContext. The MAP process invokes macros not defined in this clause; the definitions of these +3644 macros can be found as follows: + +3645 Receive\_Open\_Ind see clause 25.1.1; + +3646 Check\_Indication see clause 25.2.1. + +3647 Sheet 1: The decision box "TCAP Handshake required" takes the "yes" or "no" exit depending on agreements between +3648 the SMS-IWMSC's operator and the serving node's operator (see 3GPP TS 33.204 [34a]). + +3649 The mobile originated short message service transfer process in the SMS-IWMSC is shown in figure 23.2/5. + +![Flowchart for process MO_SM_MSC. The process starts with an initial state, followed by 'Null', then 'A_RP_MO_DATA_ind'. It then sends 'MAP_SEND_INFO_FOR_MO_SMS_req' and 'MAP_DELIMITER_req', and waits for a 'VLR_Response'. A decision point follows: if 'MAP_U_ABORT_ind' or 'MAP_CLOSE_ind' is received, it sends 'CAMEL_O_SMS_FAILURE' (referencing 3GPP TS 23.078), sets 'RP_ERROR: Network out of order', and sends 'A_RP_ERROR_req' (terminated). If 'MAP_SEND_INFO_FOR_MO_SMS_cnf' is received, it checks the confirmation. If 'OK', it checks if 'MSC=IWMSC?'. If 'Yes', it sends 'SC_RP_MO_DATA_req' to the SMSC and waits for confirmation. If 'No', it goes to connector '1'. If 'User Error' or 'Data Error', it sends 'CAMEL_O_SMS_FAILURE' (referencing 3GPP TS 23.078), sets 'RP_ERROR' or 'Network out of order', sends 'A_RP_ERROR_req' (terminated), or goes to connector '1'.](a3a4a1bab05ca97f74c3e8462ac962be_img.jpg) + +**process MO\_SM\_MSC** **MO\_SM\_MSC1(4)** + +Process in the MSC to handle MO short message submission + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the VLR + unless marked otherwise + +``` + + graph TD + Start([ ]) --> Null[Null] + Null --> In1{{ }} + In1 --> A_RP_MO_DATA_ind[A_RP_MO_DATA_ind] + A_RP_MO_DATA_ind --> In2{{ }} + In2 --> Out1[MAP_SEND_INFO_FOR_MO_SMS_req +MAP_DELIMITER_req] + Out1 --> Wait_VLR[Wait_For_VLR_Response] + Wait_VLR --> Decision1{{ }} + Decision1 --> In3{{ }} + In3 --> Out2[MAP_U_ABORT_ind, +MAP_CLOSE_ind] + In3 --> In4{{ }} + In4 --> Out3[MAP_SEND_INFO_FOR_MO_SMS_cnf] + Out3 --> Check[Check_Confirmation] + Check --> Decision2{MSC=IWMSC?} + Decision2 -- Yes --> Out4[SC_RP_MO_DATA_req] + Out4 --> To_SMSC[To SMSC] + To_SMSC --> Wait_Confirm[Wait_For_Confirm_From_SC] + Decision2 -- No --> Connector1((1)) + Check -- User Error --> Failure1[CAMEL_O_SMS_FAILURE] + Failure1 --> Ref1[See 3GPP TS 23.078] + Failure1 --> Set_Error1[Set RP_ERROR] + Set_Error1 --> Connector1 + Check -- Data Error --> Failure2[CAMEL_O_SMS_FAILURE] + Failure2 --> Ref2[See 3GPP TS 23.078] + Failure2 --> Set_Error2[Set RP_ERROR: +Network out of order] + Set_Error2 --> A_RP_ERROR_req2[A_RP_ERROR_req] + A_RP_ERROR_req2 --> End2[ ] + Decision2 -- OK --> Failure3[CAMEL_O_SMS_FAILURE] + Failure3 --> Ref3[See 3GPP TS 23.078] + Failure3 --> Set_Error3[Set RP_ERROR: +Network out of order] + Set_Error3 --> A_RP_ERROR_req3[A_RP_ERROR_req] + A_RP_ERROR_req3 --> End3[ ] + +``` + +Flowchart for process MO\_SM\_MSC. The process starts with an initial state, followed by 'Null', then 'A\_RP\_MO\_DATA\_ind'. It then sends 'MAP\_SEND\_INFO\_FOR\_MO\_SMS\_req' and 'MAP\_DELIMITER\_req', and waits for a 'VLR\_Response'. A decision point follows: if 'MAP\_U\_ABORT\_ind' or 'MAP\_CLOSE\_ind' is received, it sends 'CAMEL\_O\_SMS\_FAILURE' (referencing 3GPP TS 23.078), sets 'RP\_ERROR: Network out of order', and sends 'A\_RP\_ERROR\_req' (terminated). If 'MAP\_SEND\_INFO\_FOR\_MO\_SMS\_cnf' is received, it checks the confirmation. If 'OK', it checks if 'MSC=IWMSC?'. If 'Yes', it sends 'SC\_RP\_MO\_DATA\_req' to the SMSC and waits for confirmation. If 'No', it goes to connector '1'. If 'User Error' or 'Data Error', it sends 'CAMEL\_O\_SMS\_FAILURE' (referencing 3GPP TS 23.078), sets 'RP\_ERROR' or 'Network out of order', sends 'A\_RP\_ERROR\_req' (terminated), or goes to connector '1'. + +3650 + +3651 + +Figure 23.2/2 (sheet 1 of 4): Process MO\_SM\_MSC + +![Sequence diagram for process MO_SM_MSC. It starts with Wait_For_VLR_Response, followed by a merge point for MAP_CONTINUE_CAMEL_SMS_HANDLING_ind. Then Check_Indication, CAMEL_O_SMS_INIT (referencing 3GPP TS 23.078), and a Result? decision. The Continue path leads to MAP_SEND_INFO_FOR_MO_SMS_req and back to Wait_For_VLR_Response. The Release_SMS path leads to Set RP_ERROR, A_RP_ERROR_req, and MAP_U_ABORT_req. The Redirect_SMS path leads to Modify data and then to the merge point before MAP_SEND_INFO_FOR_MO_SMS_req. The Error path leads to Set RP_ERROR: Network out of order, A_RP_ERROR_req, and MAP_U_ABORT_req. The SMS_Aborted path leads directly to MAP_U_ABORT_req.](90163785f797d2f1152f74c311e6cae9_img.jpg) + +**process MO\_SM\_MSC** **MO\_SM\_MSC2(4)** + +Process in the MSC to handle MO short message submission + +Signals to/from the left are to/from the MS; + Signals to/from the right are to/from the VLR + +``` + +sequenceDiagram + participant MS + participant VLR + participant MSC + Note left of MSC: Process in the MSC to handle MO short message submission + Note right of MSC: Signals to/from the left are to/from the MS; Signals to/from the right are to/from the VLR + + MSC->>MSC: Wait_For_VLR_Response + Note right of MSC: MAP_CONTINUE_CAMEL_SMS_HANDLING_ind + MSC->>MSC: Check_Indication + Note right of MSC: OK + Note right of MSC: Error + MSC->>MSC: CAMEL_O_SMS_INIT + Note right of MSC: See 3GPP TS 23.078 + MSC->>MSC: Result? + Note right of MSC: Continue + Note right of MSC: Release_SMS + Note right of MSC: Redirect_SMS + Note right of MSC: SMS_Aborted + + alt Continue + MSC->>MSC: MAP_SEND_INFO_FOR_MO_SMS_req + Note right of MSC: MAP_DELIMITER_req + MSC->>MSC: Wait_For_VLR_Response + else Release_SMS + MSC->>MSC: Set RP_ERROR according to gsmSCF instructions + MSC->>MSC: A_RP_ERROR_req + MSC->>MSC: MAP_U_ABORT_req + Note right of MSC: X + else Redirect_SMS + MSC->>MSC: Modify data according to gsmSCF instructions + Note right of MSC: Merge point before MAP_SEND_INFO_FOR_MO_SMS_req + else Error + MSC->>MSC: Set RP_ERROR: Network out of order + MSC->>MSC: A_RP_ERROR_req + MSC->>MSC: MAP_U_ABORT_req + Note right of MSC: X + else SMS_Aborted + MSC->>MSC: MAP_U_ABORT_req + Note right of MSC: X + end + +``` + +Sequence diagram for process MO\_SM\_MSC. It starts with Wait\_For\_VLR\_Response, followed by a merge point for MAP\_CONTINUE\_CAMEL\_SMS\_HANDLING\_ind. Then Check\_Indication, CAMEL\_O\_SMS\_INIT (referencing 3GPP TS 23.078), and a Result? decision. The Continue path leads to MAP\_SEND\_INFO\_FOR\_MO\_SMS\_req and back to Wait\_For\_VLR\_Response. The Release\_SMS path leads to Set RP\_ERROR, A\_RP\_ERROR\_req, and MAP\_U\_ABORT\_req. The Redirect\_SMS path leads to Modify data and then to the merge point before MAP\_SEND\_INFO\_FOR\_MO\_SMS\_req. The Error path leads to Set RP\_ERROR: Network out of order, A\_RP\_ERROR\_req, and MAP\_U\_ABORT\_req. The SMS\_Aborted path leads directly to MAP\_U\_ABORT\_req. + +3652 + +3653 + +Figure 23.2/2 (sheet 2 of 4): Process MO\_SM\_MSC + +![SDL Flowchart for MO_SM_MSC process showing message segmentation logic, TCAP handshake requirements, and CAMEL interaction for short message submission.](c321eed701b327255a025f66b51b8535_img.jpg) + +process MO\_SM\_MSC +MO\_SM\_MSC3(4) + +Process in the MSC to handle MO short message submission + +Signals to/from the left are to/from the MS; + Signals to/from the right are to/from the IWMSC + +``` + + graph TD + Start((1)) --> SegNeeded{Message +segmentation +needed?} + + SegNeeded -- No --> TCAPReq{TCAP +Handshake +required} + SegNeeded -- Yes --> MAPOpenReqR[MAP_OPEN_req +MAP_DELIMITER_req] + + TCAPReq -- no --> RecOpenCnfL[Receive_ +Open_Cnf] + TCAPReq -- yes --> MAPOpenReqL[MAP_OPEN_req +MAP_MO_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req] + + MAPOpenReqR --> RecOpenCnfR[Receive_ +Open_Cnf] + + RecOpenCnfL -- OK --> WaitResultL(Wait_For_ +MO_SMS_ +Result) + RecOpenCnfL -- Vr --> PerformVrL[Perform +MAP Vr +dialogue] + RecOpenCnfL -- Error --> CamelFailL[CAMEL_O_ +SMS_ +FAILURE] + + RecOpenCnfR -- OK --> WaitResultR(Wait_For_ +MO_SMS_ +Result) + RecOpenCnfR -- Vr --> PerformVrR[Perform +MAP Vr +dialogue] + + PerformVrL --> State2((2)) + + CamelFailL --> Note1[See 3GPP +TS 23.078] + CamelFailL --> SetErrorNet[Set RP_ERROR: +Network +out of order] + SetErrorNet --> ARPErrorReqL[A_RP_ +ERROR_req] + ARPErrorReqL --> End1((X)) + + PerformVrR --> SubSuccess{Submission +successful?} + + WaitResultL --> MAPMOFwdCnf[MAP_MO_FORWARD_SHORT_MESSAGE_cnf] + MAPMOFwdCnf --> CheckConf{Check_ +Confirmation} + + CheckConf -- OK --> CamelSubL[CAMEL_O_ +SMS_ +SUBMITTED] + CamelSubL --> Note2[See 3GPP +TS 23.078] + CamelSubL --> ARPACKReqL[A_RP_ +ACK_req] + ARPACKReqL --> End2((X)) + + CheckConf -- "Provider Error, +User Error, +Data Error" --> CamelFailMid[CAMEL_O_ +SMS_ +FAILURE] + CamelFailMid --> Note3[See 3GPP +TS 23.078] + CamelFailMid --> SetRPError[Set +RP_ERROR] + SetRPError --> ARPErrorReqMid[A_RP_ +ERROR_req] + ARPErrorReqMid --> End3((X)) + + SubSuccess -- No --> CamelFailMid + SubSuccess -- Yes --> CamelSubR[CAMEL_O_ +SMS_ +SUBMITTED] + CamelSubR --> Note4[See 3GPP +TS 23.078] + CamelSubR --> ARPACKReqR[A_RP_ +ACK_req] + ARPACKReqR --> End4((X)) + +``` + +SDL Flowchart for MO\_SM\_MSC process showing message segmentation logic, TCAP handshake requirements, and CAMEL interaction for short message submission. + +3654 + +3655 + +**Figure 23.2/2 (sheet 3 of 4): Process MO\_SM\_MSC** + +![State transition diagram for process MO_SM_MSC. The diagram shows two main vertical paths. The left path starts with SC_RP_ERROR_ind leading to CAMEL_O_SMS_FAILURE (referencing 3GPP TS 23.078), then Set RP_ERROR, and finally A_RP_ERROR_req. The middle path starts with Wait_For_Confirm_From_SC leading to SC_ABORT_ind, then CAMEL_O_SMS_FAILURE (referencing 3GPP TS 23.078), then Set RP_ERROR: Network out of order, then A_RP_ERROR_req. The right path starts with SC_RP_ACK_ind leading to CAMEL_O_SMS_SUBMITTED (referencing 3GPP TS 23.078), then A_RP_ACK_ind. Both A_RP_ERROR_req and A_RP_ACK_ind lead to a merge point. Below the merge point is Wait_For_MO_SMS_RESULT. From there, the left path leads to MAP_NOTICE_ind, then MAP_CLOSE_req, then CAMEL_O_SMS_FAILURE (referencing 3GPP TS 23.078), then Set RP_ERROR: Network out of order, then A_RP_ERROR_req. The right path from Wait_For_MO_SMS_RESULT leads to an unlabeled box, which then leads to MAP_U_ABORT_ind and MAP_P_ABORT_ind. Both A_RP_ERROR_req and the path from the unlabeled box lead to a final merge point.](a97065d6f7f90c18eb5af01c0afaec5b_img.jpg) + +**process MO\_SM\_MSC** **MO\_SM\_MSC4(4)** + +*Process in the MSC to handle MO short message submission* + +*In the upper subtree, signals to/from the left are to/from the MS; Signals to/from the right are to/from the SMSC* + +*In the lower subtree, signals to/from the left are to/from the MS; Signals to/from the right are to/from the IWMSC* + +``` + +stateDiagram-v2 + [*] --> Wait_For_Confirm_From_SC + state "SC_RP_ERROR_ind" as SC_RP_ERROR_ind + state "SC_ABORT_ind" as SC_ABORT_ind + state "SC_RP_ACK_ind" as SC_RP_ACK_ind + state "CAMEL_O_SMS_FAILURE" as CAMEL_O_SMS_FAILURE + state "CAMEL_O_SMS_SUBMITTED" as CAMEL_O_SMS_SUBMITTED + state "Set RP_ERROR" as Set RP_ERROR + state "Set RP_ERROR: Network out of order" as Set RP_ERROR: Network out of order + state "A_RP_ERROR_req" as A_RP_ERROR_req + state "A_RP_ACK_ind" as A_RP_ACK_ind + state "Wait_For_MO_SMS_RESULT" as Wait_For_MO_SMS_RESULT + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind" as MAP_U_ABORT_ind, MAP_P_ABORT_ind + state "Unlabeled Box" as + state [*] as [*] + + Wait_For_Confirm_From_SC --> SC_RP_ERROR_ind + Wait_For_Confirm_From_SC --> SC_ABORT_ind + Wait_For_Confirm_From_SC --> SC_RP_ACK_ind + + SC_RP_ERROR_ind --> CAMEL_O_SMS_FAILURE + CAMEL_O_SMS_FAILURE --> Set RP_ERROR + Set RP_ERROR --> A_RP_ERROR_req + + SC_ABORT_ind --> CAMEL_O_SMS_FAILURE + CAMEL_O_SMS_FAILURE --> Set RP_ERROR: Network out of order + Set RP_ERROR: Network out of order --> A_RP_ERROR_req + + SC_RP_ACK_ind --> CAMEL_O_SMS_SUBMITTED + CAMEL_O_SMS_SUBMITTED --> A_RP_ACK_ind + + A_RP_ERROR_req --> Merge1 + A_RP_ACK_ind --> Merge1 + Merge1 --> Wait_For_MO_SMS_RESULT + + Wait_For_MO_SMS_RESULT --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> CAMEL_O_SMS_FAILURE + CAMEL_O_SMS_FAILURE --> Set RP_ERROR: Network out of order + Set RP_ERROR: Network out of order --> A_RP_ERROR_req + + Wait_For_MO_SMS_RESULT --> Unlabeled Box + Unlabeled Box --> MAP_U_ABORT_ind, MAP_P_ABORT_ind + + A_RP_ERROR_req --> Merge2 + MAP_U_ABORT_ind, MAP_P_ABORT_ind --> Merge2 + Merge2 --> [*] + +``` + +State transition diagram for process MO\_SM\_MSC. The diagram shows two main vertical paths. The left path starts with SC\_RP\_ERROR\_ind leading to CAMEL\_O\_SMS\_FAILURE (referencing 3GPP TS 23.078), then Set RP\_ERROR, and finally A\_RP\_ERROR\_req. The middle path starts with Wait\_For\_Confirm\_From\_SC leading to SC\_ABORT\_ind, then CAMEL\_O\_SMS\_FAILURE (referencing 3GPP TS 23.078), then Set RP\_ERROR: Network out of order, then A\_RP\_ERROR\_req. The right path starts with SC\_RP\_ACK\_ind leading to CAMEL\_O\_SMS\_SUBMITTED (referencing 3GPP TS 23.078), then A\_RP\_ACK\_ind. Both A\_RP\_ERROR\_req and A\_RP\_ACK\_ind lead to a merge point. Below the merge point is Wait\_For\_MO\_SMS\_RESULT. From there, the left path leads to MAP\_NOTICE\_ind, then MAP\_CLOSE\_req, then CAMEL\_O\_SMS\_FAILURE (referencing 3GPP TS 23.078), then Set RP\_ERROR: Network out of order, then A\_RP\_ERROR\_req. The right path from Wait\_For\_MO\_SMS\_RESULT leads to an unlabeled box, which then leads to MAP\_U\_ABORT\_ind and MAP\_P\_ABORT\_ind. Both A\_RP\_ERROR\_req and the path from the unlabeled box lead to a final merge point. + +3656 + +3657 + +**Figure 23.2/2 (sheet 4 of 4): Process MO\_SM\_MSC** + +![State transition diagram for process MO_SM_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state (oval), leading to a 'Null' state (oval). From 'Null', a transition 'Receive_Open_Ind' (rectangle) leads to 'Wait_For_Service_Primitive' (oval). From 'Wait_For_Service_Primitive', a transition 'Process_Access_Request_VLR' (rectangle) leads to another decision point. From this point, an 'OK' transition leads to 'Wait_For_Info_Request' (oval), and a 'Vr, Error' transition leads to another 'Null' state (oval).](d27fb5fe0f1e92b128d45dfbc529d9c7_img.jpg) + +process MO\_SM\_VLR + +MO\_SM\_VLR1(2) + +Process in the VLR to handle a request for information to handle MO short message submission + +Signals to/from the left are to/from the MSC + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + Wait_For_Service_Primitive --> Process_Access_Request_VLR[Process_Access_Request_VLR] + Process_Access_Request_VLR --> Wait_For_Info_Request[Wait_For_Info_Request] : OK + Process_Access_Request_VLR --> Null2[Null] : Vr, Error + +``` + +State transition diagram for process MO\_SM\_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state (oval), leading to a 'Null' state (oval). From 'Null', a transition 'Receive\_Open\_Ind' (rectangle) leads to 'Wait\_For\_Service\_Primitive' (oval). From 'Wait\_For\_Service\_Primitive', a transition 'Process\_Access\_Request\_VLR' (rectangle) leads to another decision point. From this point, an 'OK' transition leads to 'Wait\_For\_Info\_Request' (oval), and a 'Vr, Error' transition leads to another 'Null' state (oval). + +3658 + +3659 + +Figure 23.2/3 (sheet 1 of 2): Process MOSM\_VLR + +![Flowchart for process MO_SM_VLR. It starts with 'Wait_For_Info_Request', leading to a merge point. From the merge point, one path goes to 'MAP_U_ABORT_req' -> 'Null'. The other path goes to 'MAP_SEND_INFO_FOR_MO_SMS_ind' -> 'Check_Indication'. 'Check_Indication' leads to 'MO_SMS_provisioned?' decision. If 'No', it goes to 'Set User Error: Teleservice not provisioned' -> merge point. If 'OK', it goes to 'Operator barring?' decision. If 'Yes', it goes to 'BAOC'. If 'No', it goes to 'SS barring?' decision. If 'Yes', it goes to 'BAOC'. If 'No', it goes to 'CAMEL_MO_SMS_VLR' -> 'See 3GPP TS 23.078' -> 'Result?' decision. 'Result?' 'Fail' goes to 'Null'. 'Result?' 'Pass' goes to 'Operator barring?' decision. If 'Yes', it goes to 'BOIC or BOIC-exHC etc'. If 'No', it goes to 'SS barring?' decision. If 'Yes', it goes to 'BOIC or BOIC-exHC'. If 'No', it goes to 'Set User Error: Call barred (Operator barring)' or 'Set User Error: Call barred (barring service active)' -> merge point. All paths eventually lead to a merge point before 'MAP_SEND_INFO_FOR_MO_SMS_rsp' -> 'MAP_CLOSE_req' -> 'Null'.](82d715590769d59b129a92b92d02bbc2_img.jpg) + +**process MO\_SM\_VLR** **MO\_SM\_VLR2(2)** + +Process in the VLR to handle a request for information to handle MO short message submission + +Signals to/from the left are to/from the MSC + +``` + + graph TD + WFI[Wait_For_Info_Request] --> Merge1(( )) + Merge1 --> MUI[MAP_U_ABORT_req] + MUI --> Null1([Null]) + Merge1 --> MSIM[MAP_SEND_INFO_FOR_MO_SMS_ind] + MSIM --> CI[Check_Indication] + CI --> MSP{MO_SMS_provisioned?} + MSP -- No --> SUE1[Set User Error: Teleservice not provisioned] + SUE1 --> Merge1 + CI -- OK --> OB1{Operator barring?} + OB1 -- Yes --> BAOC1[BAOC] + OB1 -- No --> SS1{SS barring?} + SS1 -- Yes --> BAOC2[BAOC] + SS1 -- No --> CMV[CAMEL_MO_SMS_VLR] + CMV --> S3GPP[See 3GPP TS 23.078] + CMV --> Res{Result?} + Res -- Fail --> Null2([Null]) + Res -- Pass --> OB2{Operator barring?} + OB2 -- Yes --> BOIC1[BOIC or BOIC-exHC etc] + OB2 -- No --> SS2{SS barring?} + SS2 -- Yes --> BOIC2[BOIC or BOIC-exHC] + SS2 -- No --> SUE2[Set User Error: Call barred (Operator barring)] + SS2 -- No --> SUE3[Set User Error: Call barred (barring service active)] + SUE2 --> Merge2(( )) + SUE3 --> Merge2 + BOIC1 --> Merge2 + BOIC2 --> Merge2 + Merge2 --> MSIR[MAP_SEND_INFO_FOR_MO_SMS_rsp] + MSIR --> MCR[MAP_CLOSE_req] + MCR --> Null3([Null]) + +``` + +Flowchart for process MO\_SM\_VLR. It starts with 'Wait\_For\_Info\_Request', leading to a merge point. From the merge point, one path goes to 'MAP\_U\_ABORT\_req' -> 'Null'. The other path goes to 'MAP\_SEND\_INFO\_FOR\_MO\_SMS\_ind' -> 'Check\_Indication'. 'Check\_Indication' leads to 'MO\_SMS\_provisioned?' decision. If 'No', it goes to 'Set User Error: Teleservice not provisioned' -> merge point. If 'OK', it goes to 'Operator barring?' decision. If 'Yes', it goes to 'BAOC'. If 'No', it goes to 'SS barring?' decision. If 'Yes', it goes to 'BAOC'. If 'No', it goes to 'CAMEL\_MO\_SMS\_VLR' -> 'See 3GPP TS 23.078' -> 'Result?' decision. 'Result?' 'Fail' goes to 'Null'. 'Result?' 'Pass' goes to 'Operator barring?' decision. If 'Yes', it goes to 'BOIC or BOIC-exHC etc'. If 'No', it goes to 'SS barring?' decision. If 'Yes', it goes to 'BOIC or BOIC-exHC'. If 'No', it goes to 'Set User Error: Call barred (Operator barring)' or 'Set User Error: Call barred (barring service active)' -> merge point. All paths eventually lead to a merge point before 'MAP\_SEND\_INFO\_FOR\_MO\_SMS\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'. + +3660 + +3661 + +**Figure 23.2/3 (sheet 2 of 2): Process MO\_SM\_VLR** + +![Flowchart for process MO_SM_SGSN. It starts with 'Null', then 'Gb_RP_MO_DATA_ind'. Decision: 'MO SMS provisioned?'. If No, goes to 'Set RP_ERROR: Requested facility not subscribed' -> 'Gb_RP_ERROR_req' -> 'Null'. If Yes, decision: 'Operator barring?'. If Yes, goes to 'BAOC'. If No, decision: 'SS barring?'. If Yes, goes to 'BAOC'. If No, goes to 'CAMEL_O_SMS_INIT' -> 'See 3GPP TS 23.078' -> 'Result?'. From 'Result?', options: 'SMS_Aborted' -> 'Null', 'Release_SMS' -> 'Set RP_ERROR according to gsmSCF instructions' -> 'Gb_RP_ERROR_req' -> 'Null', 'Redirect_SMS' -> 'Modify data according to gsmSCF instructions' -> 'Operator barring?'. If Yes, goes to 'BOIC or BOIC-exHC etc'. If No, decision: 'SS barring?'. If Yes, goes to 'CAMEL_O_SMS_FAILURE' -> 'See 3GPP TS 23.078' -> '2'. If No, goes to '3'. There are also connector points '1' and '2' leading to 'CAMEL_O_SMS_FAILURE' -> 'See 3GPP TS 23.078' -> 'Set RP_ERROR: Operator determined barring' -> 'Gb_RP_ERROR_req' -> 'Null'.](25f7c3066ddba1641935c3ba3cbcde1b_img.jpg) + +**process MO\_SM\_SGSN** **MO\_SM\_SGSN1(3)** + +Process in the SGSN to handle submission of a short message + +Signals to/from the left are to/from the UE; +signals to/from the right are to/from the HLR + +``` + +graph TD + Start([Null]) --> GbRP[Gb_RP_MO_DATA_ind] + GbRP --> MO_SMS_Prov{MO SMS provisioned?} + MO_SMS_Prov -- No --> RP_Err_Req1[Gb_RP_ERROR_req] + RP_Err_Req1 --> Null1([Null]) + MO_SMS_Prov -- Yes --> Op_Barr1{Operator barring?} + Op_Barr1 -- Yes --> BAOC1[BAOC] + Op_Barr1 -- No --> SS_Barr1{SS barring?} + SS_Barr1 -- Yes --> BAOC2[BAOC] + SS_Barr1 -- No --> CAMEL_Init[CAMEL_O_SMS_INIT] + CAMEL_Init --> TS_23_078_1[See 3GPP TS 23.078] + CAMEL_Init --> Result{Result?} + Result -- SMS_Aborted --> Null2([Null]) + Result -- Release_SMS --> RP_Err_Req2[Gb_RP_ERROR_req] + RP_Err_Req2 --> Null3([Null]) + Result -- Redirect_SMS --> ModData[Modify data according to gsmSCF instructions] + ModData --> Op_Barr2{Operator barring?} + Op_Barr2 -- Yes --> BOIC[BOIC or BOIC-exHC etc] + Op_Barr2 -- No --> SS_Barr2{SS barring?} + SS_Barr2 -- Yes --> CAMEL_Fail[CAMEL_O_SMS_FAILURE] + CAMEL_Fail --> TS_23_078_2[See 3GPP TS 23.078] + CAMEL_Fail --> Connector2((2)) + SS_Barr2 -- No --> Connector3((3)) + Connector1((1)) --> CAMEL_Fail2[CAMEL_O_SMS_FAILURE] + CAMEL_Fail2 --> TS_23_078_3[See 3GPP TS 23.078] + CAMEL_Fail2 --> RP_Err_Req3[Gb_RP_ERROR_req] + RP_Err_Req3 --> Null4([Null]) + Connector2 --> RP_Err_Req4[Gb_RP_ERROR_req] + RP_Err_Req4 --> Null5([Null]) + +``` + +Flowchart for process MO\_SM\_SGSN. It starts with 'Null', then 'Gb\_RP\_MO\_DATA\_ind'. Decision: 'MO SMS provisioned?'. If No, goes to 'Set RP\_ERROR: Requested facility not subscribed' -> 'Gb\_RP\_ERROR\_req' -> 'Null'. If Yes, decision: 'Operator barring?'. If Yes, goes to 'BAOC'. If No, decision: 'SS barring?'. If Yes, goes to 'BAOC'. If No, goes to 'CAMEL\_O\_SMS\_INIT' -> 'See 3GPP TS 23.078' -> 'Result?'. From 'Result?', options: 'SMS\_Aborted' -> 'Null', 'Release\_SMS' -> 'Set RP\_ERROR according to gsmSCF instructions' -> 'Gb\_RP\_ERROR\_req' -> 'Null', 'Redirect\_SMS' -> 'Modify data according to gsmSCF instructions' -> 'Operator barring?'. If Yes, goes to 'BOIC or BOIC-exHC etc'. If No, decision: 'SS barring?'. If Yes, goes to 'CAMEL\_O\_SMS\_FAILURE' -> 'See 3GPP TS 23.078' -> '2'. If No, goes to '3'. There are also connector points '1' and '2' leading to 'CAMEL\_O\_SMS\_FAILURE' -> 'See 3GPP TS 23.078' -> 'Set RP\_ERROR: Operator determined barring' -> 'Gb\_RP\_ERROR\_req' -> 'Null'. + +3662 + +3663 + +Figure 23.2/4 (sheet 1 of 3): Process MO\_SM\_SGSN + +![Flowchart for process MO_SM_SGSN. It starts at connector 3, checks for message segmentation. If 'Yes', it sends MAP_OPEN_req and MAP_DELIMITER_req to the HLR, receives confirmation, performs a MAP_Vr dialogue, and then checks submission success. If 'No', it checks if a TCAP handshake is required. If 'yes', it sends MAP_OPEN_req, MAP_MO_FORWARD_SHORT_MESSAGE_req, and MAP_DELIMITER_req to the HLR, receives confirmation, performs a MAP_Vr dialogue, and checks submission success. If 'no', it sends MAP_MO_FORWARD_SHORT_MESSAGE_req to the HLR, receives confirmation, checks submission success, and then handles the result (CAMEL_O_SMS_SUBMITTED, FAILURE, or error handling).](52b571c5f533172048bd268c4eff2da0_img.jpg) + +**process MO\_SM\_SGSN** **MO\_SM\_SGSN2(3)** + +*Process in the SGSN to handle submission of a short message* + +*Signals to/from the left are to/from the UE; signals to/from the right are to/from the HLR* + +``` + +graph TD + Start((3)) --> Segmentation{Message segmentation needed?} + Segmentation -- Yes --> OpenReq1[MAP_OPEN_req +MAP_DELIMITER_req] + OpenReq1 --> OpenCnf1[Receive_Open_Cnf] + OpenCnf1 -- OK --> ForwardReq1[MAP_MO_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req] + ForwardReq1 --> WaitResult1[Wait_For_MO_SMS_Result] + OpenCnf1 -- Vr --> PerformVr1[Perform MAP_Vr dialogue] + PerformVr1 --> Success{Submission successful?} + Success -- Yes --> Submitted1[CAMEL_O_SMS_SUBMITTED] + Submitted1 --> AckReq1{Gb_RP_ACK_req} + AckReq1 --> Null1[Null] + Success -- No --> Failure1[CAMEL_O_SMS_FAILURE] + Failure1 --> SetError1[Set RP_ERROR] + SetError1 --> ErrorReq1{Gb_RP_ERROR_req} + ErrorReq1 --> Null2[Null] + Segmentation -- No --> Handshake{TCAP Handshake required} + Handshake -- yes --> OpenReq2[MAP_OPEN_req +MAP_MO_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req] + OpenReq2 --> OpenCnf2[Receive_Open_Cnf] + OpenCnf2 -- OK --> ForwardReq2[MAP_MO_FORWARD_SHORT_MESSAGE_req] + ForwardReq2 --> WaitResult2[Wait_For_MO_SMS_Result] + OpenCnf2 -- Vr --> PerformVr2[Perform MAP_Vr dialogue] + PerformVr2 --> Success2{Submission successful?} + Success2 -- Yes --> Submitted2[CAMEL_O_SMS_SUBMITTED] + Submitted2 --> AckReq2{Gb_RP_ACK_req} + AckReq2 --> Null3[Null] + Success2 -- No --> Failure2[CAMEL_O_SMS_FAILURE] + Failure2 --> SetError2[Set RP_ERROR] + SetError2 --> ErrorReq2{Gb_RP_ERROR_req} + ErrorReq2 --> Null4[Null] + Handshake -- no --> ForwardReq3[MAP_MO_FORWARD_SHORT_MESSAGE_req] + ForwardReq3 --> CheckConfirm[Check Confirmation] + CheckConfirm -- OK --> Submitted3[CAMEL_O_SMS_SUBMITTED] + Submitted3 --> AckReq3{Gb_RP_ACK_req} + AckReq3 --> Null5[Null] + CheckConfirm -- "Provider Error, User Error, Data Error" --> Failure3[CAMEL_O_SMS_FAILURE] + Failure3 --> SetError3[Set RP_ERROR] + SetError3 --> ErrorReq3{Gb_RP_ERROR_req} + ErrorReq3 --> Null6[Null] + PerformVr1 -.-> See3GPP1[See 3GPP TS 23.078] + PerformVr2 -.-> See3GPP2[See 3GPP TS 23.078] + Submitted1 -.-> See3GPP3[See 3GPP TS 23.078] + Failure1 -.-> See3GPP4[See 3GPP TS 23.078] + Submitted2 -.-> See3GPP5[See 3GPP TS 23.078] + Failure2 -.-> See3GPP6[See 3GPP TS 23.078] + Submitted3 -.-> See3GPP7[See 3GPP TS 23.078] + Failure3 -.-> See3GPP8[See 3GPP TS 23.078] + CAMEL_O_SMS_FAILURE1[CAMEL_O_SMS_FAILURE] -.-> See3GPP9[See 3GPP TS 23.078] + CAMEL_O_SMS_FAILURE2[CAMEL_O_SMS_FAILURE] -.-> See3GPP10[See 3GPP TS 23.078] + CAMEL_O_SMS_FAILURE3[CAMEL_O_SMS_FAILURE] -.-> See3GPP11[See 3GPP TS 23.078] + +``` + +Flowchart for process MO\_SM\_SGSN. It starts at connector 3, checks for message segmentation. If 'Yes', it sends MAP\_OPEN\_req and MAP\_DELIMITER\_req to the HLR, receives confirmation, performs a MAP\_Vr dialogue, and then checks submission success. If 'No', it checks if a TCAP handshake is required. If 'yes', it sends MAP\_OPEN\_req, MAP\_MO\_FORWARD\_SHORT\_MESSAGE\_req, and MAP\_DELIMITER\_req to the HLR, receives confirmation, performs a MAP\_Vr dialogue, and checks submission success. If 'no', it sends MAP\_MO\_FORWARD\_SHORT\_MESSAGE\_req to the HLR, receives confirmation, checks submission success, and then handles the result (CAMEL\_O\_SMS\_SUBMITTED, FAILURE, or error handling). + +3664 + +3665 + +Figure 23.2/4 (sheet 2 of 3): Process MO\_SM\_SGSN + +![Flowchart for process MO_SM_SGSN. The flow starts with 'Wait_For_MO_SMS_Result', followed by 'MAP_NOTICE_ind' (left) and an unlabeled box (right) leading to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind'. Then 'MAP_CLOSE_req' (left) and a merge point. Next is 'CAMEL_O_SMS_FAILURE' (left) with a note 'See 3GPP TS 23.078'. Then 'Set RP_ERROR: Network out of order' (left), 'Gb_RP_ERROR_req' (left), and finally 'Null'.](e4734458e8913c13c84699d9d3f66ec8_img.jpg) + +process MO\_SM\_SGSN + +MO\_SM\_SGSN3(3) + +Process in the SGSN to handle submission of a short message + +Signals to/from the left are to/from the UE; signals to/from the right are to/from the HLR + +``` + +graph TD + Start([Wait_For_MO_SMS_Result]) --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + Start --> Unlabeled[ ] + Unlabeled --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[/MAP_CLOSE_req/] + MAP_CLOSE_req --> Merge(( )) + MAP_U_ABORT_ind --> Merge + Merge --> CAMEL_O_SMS_FAILURE[CAMEL_O_SMS_FAILURE] + CAMEL_O_SMS_FAILURE -.-> Note[See 3GPP TS 23.078] + CAMEL_O_SMS_FAILURE --> SetRP[Set RP_ERROR: Network out of order] + SetRP --> GbRP[Gb_RP_ERROR_req] + GbRP --> Null([Null]) + +``` + +Flowchart for process MO\_SM\_SGSN. The flow starts with 'Wait\_For\_MO\_SMS\_Result', followed by 'MAP\_NOTICE\_ind' (left) and an unlabeled box (right) leading to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind'. Then 'MAP\_CLOSE\_req' (left) and a merge point. Next is 'CAMEL\_O\_SMS\_FAILURE' (left) with a note 'See 3GPP TS 23.078'. Then 'Set RP\_ERROR: Network out of order' (left), 'Gb\_RP\_ERROR\_req' (left), and finally 'Null'. + +3666 + +3667 + +Figure 23.2/4 (sheet 3 of 3): Process MO\_SM\_SGSN + +![Flowchart for process MO_SM_IWMSC. It starts with an initial node leading to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' -> 'Null'; 'OK' leading to a decision 'TCAP Handshake required'; and 'Error' leading to 'Null'. From 'TCAP Handshake required', 'no' leads to 'Wait_For_Service_Primitive' -> 'MAP_DELIMITER_ind' -> 'MAP_DELIMITER_req' -> 'Wait_For_Service_Primitive'; 'yes' leads to 'Wait_For_DELIMITER'. From 'Wait_For_DELIMITER', multiple paths emerge: 1) 'MAP_DELIMITER_ind' -> 'MAP_DELIMITER_req' -> 'Wait_For_Service_Primitive'; 2) an unlabeled path leading to 'Set Error System Failure' -> 'MAP_MO_FORWARD_SM_rsp' -> 'MAP_CLOSE_req' -> 'Null'; 3) 'MAP_MO_FORWARD_SHORT_MESSAGE_ind'; 4) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Null'; 5) an unlabeled path leading to a box with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' -> 'Null'.](46e1d5619acee885091b5677076bba4b_img.jpg) + +**process MO\_SM\_IWMSC** **MO\_SM\_IWMSC1(2)** + +Process in the MSC to handle MO short message submission + +Signals to/from the left are to/from the MSC; +signals to/from the right are to/from the SMSC + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- Vr --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Perform_MAP_Vr_dialogue --> Null2([Null]) + Receive_Open_Ind -- OK --> TCAP_Handshake_required{TCAP Handshake required} + Receive_Open_Ind -- Error --> Null3([Null]) + TCAP_Handshake_required -- no --> Wait_For_Service_Primitive1[Wait_For_Service_Primitive] + Wait_For_Service_Primitive1 --> MAP_DELIMITER_ind1[MAP_DELIMITER_ind] + MAP_DELIMITER_ind1 --> MAP_DELIMITER_req1[MAP_DELIMITER_req] + MAP_DELIMITER_req1 --> Wait_For_Service_Primitive2[Wait_For_Service_Primitive] + TCAP_Handshake_required -- yes --> Wait_For_DELIMITER[Wait_For_DELIMITER] + Wait_For_DELIMITER --> MAP_DELIMITER_ind2[MAP_DELIMITER_ind] + MAP_DELIMITER_ind2 --> MAP_DELIMITER_req2[MAP_DELIMITER_req] + MAP_DELIMITER_req2 --> Wait_For_Service_Primitive3[Wait_For_Service_Primitive] + Wait_For_DELIMITER --> Set_Error_System_Failure[Set Error System Failure] + Set_Error_System_Failure --> MAP_MO_FORWARD_SM_rsp[MAP_MO_FORWARD_SM_rsp] + MAP_MO_FORWARD_SM_rsp --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Null4([Null]) + Wait_For_DELIMITER --> MAP_MO_FORWARD_SHORT_MESSAGE_ind[MAP_MO_FORWARD_SHORT_MESSAGE_ind] + Wait_For_DELIMITER --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Null5([Null]) + Wait_For_DELIMITER --> Unlabeled1[ ] + Unlabeled1 --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_U_ABORT_ind --> Null6([Null]) + +``` + +Flowchart for process MO\_SM\_IWMSC. It starts with an initial node leading to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'Vr' leading to 'Perform MAP Vr dialogue' -> 'Null'; 'OK' leading to a decision 'TCAP Handshake required'; and 'Error' leading to 'Null'. From 'TCAP Handshake required', 'no' leads to 'Wait\_For\_Service\_Primitive' -> 'MAP\_DELIMITER\_ind' -> 'MAP\_DELIMITER\_req' -> 'Wait\_For\_Service\_Primitive'; 'yes' leads to 'Wait\_For\_DELIMITER'. From 'Wait\_For\_DELIMITER', multiple paths emerge: 1) 'MAP\_DELIMITER\_ind' -> 'MAP\_DELIMITER\_req' -> 'Wait\_For\_Service\_Primitive'; 2) an unlabeled path leading to 'Set Error System Failure' -> 'MAP\_MO\_FORWARD\_SM\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'; 3) 'MAP\_MO\_FORWARD\_SHORT\_MESSAGE\_ind'; 4) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Null'; 5) an unlabeled path leading to a box with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' -> 'Null'. + +3668 + +3669 + +3670 + +**Figure 23.2/5 (sheet 1 of 2): Process MO\_SM\_IWMSC** + +process MO\_SM\_IWMSC + +MO\_SM\_IWMSC2(2) + +Process in the MSC to handle MO short message submission + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the SMSC + +![Flowchart for process MO_SM_IWMSC showing message handling logic between MSC and SMSC.](1fc0375eeb03547ee607c15fef041f56_img.jpg) + +``` + + graph TD + Start([Wait_For_Service_Primitive]) --> Branch1(( )) + Branch1 --> In1{{ }} + In1 --> Out1[MAP_MO_FORWARD_SHORT_MESSAGE_ind] + Out1 --> Check[Check_Indication] + Check --> Decision{SC known?} + Decision -- OK --> Yes[Yes] + Decision -- No --> Error1((Error 1)) + Yes --> Req1{SC_RP_MO_DATA_req} + Req1 --> Wait1([Wait_For_Confirm_From_SC]) + Wait1 --> Branch2(( )) + Branch2 --> In2{{ }} + In2 --> Out2[MAP_NOTICE_ind] + Out2 --> Req2{MAP_CLOSE_req} + Req2 --> Out3[SC_ABORT_req] + Out3 --> Null1([Null]) + Branch2 --> In3{{ }} + In3 --> Out4[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Branch2 --> In4{{ }} + In4 --> Out5[SC_RP_ACK_ind] + Out5 --> Null2([Null]) + Branch2 --> In5{{ }} + In5 --> Out6[SC_RP_ERROR_ind] + Out6 --> Error2[Set User Error: SM delivery failure] + Error2 --> Param2[Set error parameter: according to service centre error value] + Param2 --> End2((1)) + Branch2 --> In6{{ }} + In6 --> Out7[MAP_MO_FORWARD_SHORT_MESSAGE_rsp] + Out7 --> Null3([Null]) + Branch1 --> In7{{ }} + In7 --> Out8[MAP_NOTICE_ind] + Out8 --> Req3{MAP_CLOSE_req} + Req3 --> Null4([Null]) + Branch1 --> In8{{ }} + In8 --> Out9[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Branch1 --> In9{{ }} + In9 --> Out10[MAP_MO_FORWARD_SHORT_MESSAGE_ind] + Out10 --> Null5([Null]) + +``` + +Flowchart for process MO\_SM\_IWMSC showing message handling logic between MSC and SMSC. + +3671 + +3672 + +Figure 23.2/5 (sheet 2 of 2): Process MO\_SM\_IWMSC + +3673 **23.3 The mobile terminated short message transfer procedure** + +3674 The mobile terminated short message transfer procedure is used for forwarding a short message or several short + 3675 messages from a Service Centre to a mobile subscriber. The message flow for the mobile terminated short message + 3676 procedure for a single short message transfer is shown in figure 23.3/1. + +![Sequence diagram showing the mobile terminated short message transfer procedure between MS, Serving MSC or SGSN, VLR, HLR, Gateway MSC, and SC.](514150054ea2e72f86da03de4e230d7d_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Serving MSC or SGSN + participant VLR + participant HLR + participant Gateway MSC + participant SC + + Note right of SC: 1 + SC->>Gateway MSC: + Note right of Gateway MSC: 2 + Gateway MSC->>HLR: + Note right of HLR: 3 + HLR->>Gateway MSC: + Note right of Gateway MSC: 4a + Gateway MSC->>Serving MSC or SGSN: + Note right of Serving MSC or SGSN: 4b + Serving MSC or SGSN->>VLR: + Note right of VLR: 5 + VLR->>Serving MSC or SGSN: + Note right of Serving MSC or SGSN: 5a + Serving MSC or SGSN->>VLR: + Note right of VLR: 5b + VLR->>MS: + Note right of MS: 7 + MS->>Serving MSC or SGSN: + Note right of Serving MSC or SGSN: 8 + Serving MSC or SGSN->>VLR: + Note right of VLR: 9 + VLR->>MS: + Note right of MS: 11 + MS->>Serving MSC or SGSN: + Note right of Serving MSC or SGSN: 12 + Serving MSC or SGSN->>Gateway MSC: + Note right of Gateway MSC: 13 + Gateway MSC->>SC: + Note right of SC: 14 + +``` + +Sequence diagram showing the mobile terminated short message transfer procedure between MS, Serving MSC or SGSN, VLR, HLR, Gateway MSC, and SC. + +3677 + +3678 + +**Figure 23.3/1: Mobile terminated short message service procedures** + +3679 1) Short Message (3GPP TS 23.040). + 3680 2) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM. + 3681 3) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK. + 3682 4) TCAP BEGIN (\*\*\*) + 3683 4a) TCAP CONTINUE (\*\*\*) + 3684 4b) MAP\_MT\_FORWARD\_SHORT\_MESSAGE. + 3685 The message should include the timer value used at the SMS-GMSC for the supervision of the + 3686 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. + 3687 5) MAP\_SEND\_INFO\_FOR\_MT\_SMS (\*). + 3688 5a) MAP\_CONTINUE\_CAMEL\_SMS\_HANDLING (\*) (\*\*\*) + 3689 5b) MAP\_SEND\_INFO\_FOR\_MT\_SMS (\*) (\*\*\*) + 3690 6) MAP\_PAGE/MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER (\*). + 3691 7) Page (3GPP TS 24.008 [35]). + 3692 8) Page response (3GPP TS 24.008 [35]). + 3693 9) MAP\_PROCESS\_ACCESS\_REQUEST\_ACK and + 3694 MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER\_ACK (\*). + 3695 10) MAP\_SEND\_INFO\_FOR\_MT\_SMS\_ACK (\*). + 3696 11) Short Message (3GPP TS 24.011 [37]). + 3697 12) Short Message Acknowledgement (3GPP TS 24.011 [37]). + 3698 13) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. + 3699 14) Short Message Acknowledgement (3GPP TS 23.040). + 3700 + 3701 (\*) Messages 5), 5a), 5b), 6), 9), and 10) are not used by the SGSN. + 3702 (\*\*) These messages are used only for a subscriber provisioned with MT-SMS-CSI in the VLR. + 3703 (\*\*\*) If + 3704 a) + 3705 - the capacity of a message signal unit in the lower layers of the protocol is enough to carry the + 3706 content of the MAP\_OPEN request and the content of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE + 3707 request in a single TC message, + 3708 + 3709 and + 3710 b) the SMS Gateway MSC operator and the serving node (MSC or SGSN) operator + 3711 agreed not to use the TCAP handshake countermeasure against SMS fraud for + 3712 messages exchanged between their networks (see 3GPP TS 33.204 [34a]) + 3713 then + 3714 the TCAP handshake may be omitted. + 3715 + +3716 The message flow for the mobile terminated short message procedure for multiple short message transfer is shown in + 3717 figure 23.3/2. + +![Sequence diagram showing the mobile terminated short message procedure for multiple short message transfer. Lifelines: MS, Serving MSC or SGSN, VLR, HLR, Gateway MSC, SC. The sequence starts with the SC sending a Short Message (1) to the Gateway MSC, which then sends a MAP_SEND_ROUTING_INFO_FOR_SM (2) to the HLR. The HLR responds with a MAP_SEND_ROUTING_INFO_FOR_SM_ACK (3). The Gateway MSC then sends a TCAP BEGIN (4) to the Serving MSC or SGSN. The Serving MSC or SGSN sends a TCAP CONTINUE (4a) to the Gateway MSC, which responds with a MAP_MT_FORWARD_SHORT_MESSAGE (4b). The Serving MSC or SGSN then sends a MAP_SEND_INFO_FOR_MT_SMS (5) to the VLR, which responds with a MAP_CONTINUE_CAMEL_SMS_HANDLING (5a). The Serving MSC or SGSN then sends a MAP_SEND_INFO_FOR_MT_SMS (5b) to the VLR, which responds with a MAP_PAGE/MAP_SEARCH_FOR_MOBILE_SUBSCRIBER (6). The VLR then sends a Page (7) to the MS, which responds with a Page response (8). The VLR then sends a MAP_PROCESS_ACCESS_REQUEST_ACK and a MAP_SEARCH_FOR_MOBILE_SUBSCRIBER_ACK (9) to the Serving MSC or SGSN. The Serving MSC or SGSN then sends a MAP_SEND_INFO_FOR_MT_SMS_ACK (10) to the VLR, which responds with a Short Message (11). The VLR then sends a Short Message Acknowledgement (12) to the MS. Finally, the Serving MSC or SGSN sends a MAP_MT_FORWARD_SHORT_MESSAGE_ACK (13) to the Gateway MSC, which then sends a Short Message (14) to the SC. The SC responds with a Short Message Acknowledgement (15). The Gateway MSC then sends a Short Message (16) to the MS, which responds with a Short Message Acknowledgement (17). The Gateway MSC then sends a Short Message (18) to the Serving MSC or SGSN, which responds with a Short Message Acknowledgement (19). The Serving MSC or SGSN then sends a Short Message (20) to the VLR.](8d47784a87ca9afcc7731bbe41341031_img.jpg) + +Sequence diagram showing the mobile terminated short message procedure for multiple short message transfer. Lifelines: MS, Serving MSC or SGSN, VLR, HLR, Gateway MSC, SC. The sequence starts with the SC sending a Short Message (1) to the Gateway MSC, which then sends a MAP\_SEND\_ROUTING\_INFO\_FOR\_SM (2) to the HLR. The HLR responds with a MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK (3). The Gateway MSC then sends a TCAP BEGIN (4) to the Serving MSC or SGSN. The Serving MSC or SGSN sends a TCAP CONTINUE (4a) to the Gateway MSC, which responds with a MAP\_MT\_FORWARD\_SHORT\_MESSAGE (4b). The Serving MSC or SGSN then sends a MAP\_SEND\_INFO\_FOR\_MT\_SMS (5) to the VLR, which responds with a MAP\_CONTINUE\_CAMEL\_SMS\_HANDLING (5a). The Serving MSC or SGSN then sends a MAP\_SEND\_INFO\_FOR\_MT\_SMS (5b) to the VLR, which responds with a MAP\_PAGE/MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER (6). The VLR then sends a Page (7) to the MS, which responds with a Page response (8). The VLR then sends a MAP\_PROCESS\_ACCESS\_REQUEST\_ACK and a MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER\_ACK (9) to the Serving MSC or SGSN. The Serving MSC or SGSN then sends a MAP\_SEND\_INFO\_FOR\_MT\_SMS\_ACK (10) to the VLR, which responds with a Short Message (11). The VLR then sends a Short Message Acknowledgement (12) to the MS. Finally, the Serving MSC or SGSN sends a MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK (13) to the Gateway MSC, which then sends a Short Message (14) to the SC. The SC responds with a Short Message Acknowledgement (15). The Gateway MSC then sends a Short Message (16) to the MS, which responds with a Short Message Acknowledgement (17). The Gateway MSC then sends a Short Message (18) to the Serving MSC or SGSN, which responds with a Short Message Acknowledgement (19). The Serving MSC or SGSN then sends a Short Message (20) to the VLR. + +3718 + 3719 **Figure 23.3/2: Mobile terminated short message procedure for multiple short message transfer** + +- 3720 1) Short Message (3GPP TS 23.040 [26]). +- 3721 2) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM. +- 3722 3) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK. +- 3723 4) TCAP BEGIN (\*\*\*) +- 3724 4a) TCAP CONTINUE (\*\*\*) +- 3725 4b) MAP\_MT\_FORWARD\_SHORT\_MESSAGE (note 1). +- 3726 The message should include the timer value used at the SMS-GMSC for the supervision of the +- 3727 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. +- 3728 5) MAP\_SEND\_INFO\_FOR\_MT\_SMS (\*). +- 3729 5a) MAP\_CONTINUE\_CAMEL\_SMS\_HANDLING (\*) (\*\*) +- 3730 5b) MAP\_SEND\_INFO\_FOR\_MT\_SMS (\*) (\*\*) +- 3731 6) MAP\_PAGE/MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER (\*). +- 3732 7) Page (3GPP TS 48.008 [49]). +- 3733 8) Page response (3GPP TS 24.008 [35]). +- 3734 9) MAP\_PROCESS\_ACCESS\_REQUEST\_ACK and +- 3735 MAP\_SEARCH\_FOR\_MOBILE\_SUBSCRIBER\_ACK (\*). +- 3736 10) MAP\_SEND\_INFO\_FOR\_MT\_SMS\_ACK (\*). +- 3737 11) Short Message (3GPP TS 24.011 [37]). +- 3738 12) Short Message Acknowledgement (3GPP TS 24.011 [37]). +- 3739 13) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. + +3740 14) Short Message Acknowledgement (3GPP TS 23.040 [26]). + +3741 15) Short Message (3GPP TS 23.040 [26]). + +3742 16) MAP\_MT\_FORWARD\_SHORT\_MESSAGE (note 2). + +3743 The message should include the timer value used at the SMS-GMSC for the supervision of the + +3744 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. + +3745 17) Short Message (3GPP TS 24.011 [37]). + +3746 18) Short Message Acknowledgement (3GPP TS 24.011 [37]). + +3747 19) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. + +3748 20) Short Message Acknowledgement (3GPP TS 23.040 [26]). + +3749 + +3750 (\*) Messages 5), 5a), 5b) 6), 9), and 10) are not used by the SGSN. + +3751 (\*\*) These messages are used only for a subscriber provisioned with MT-SMS-CSI in the VLR. + +3752 (\*\*\*) If + +3753 a) the capacity of a message signal unit in the lower layers of the protocol is enough to carry the + +3754 content of the MAP\_OPEN request and the content of the MAP\_MT\_FORWARD\_SHORT\_MESSAGE + +3755 request in a single TC message, + +3756 and + +3757 b) the SMS Gateway MSC operator and the serving node (MSC or SGSN) operator + +3758 agreed not to use the TCAP handshake countermeasure against SMS fraud for + +3759 messages exchanged between their networks (see 3GPP TS 33.204 [34a]) + +3760 then the TCAP handshake may be omitted. + +3761 + +3762 NOTE 1: The "More Messages To Send" flag is TRUE. + +3763 NOTE 2: The "More Messages To Send" flag is FALSE. + +3764 + +3765 In the multiple short message transfer the service MAP\_MT\_FORWARD\_SHORT\_MESSAGE can be used several + +3766 times. However, the short message transfer is always acknowledged to the Service Centre before the next short message + +3767 is sent. + +3768 In addition the following MAP services are used: + +3769 MAP\_PROCESS\_ACCESS\_REQUEST (see clause 8.3); (\*) + +3770 MAP\_PAGE (see clause 8.2); (\*) + +3771 MAP\_SEARCH\_FOR\_MS (see clause 8.2); (\*) + +3772 MAP\_AUTHENTICATE (see clause 8.5); (\*) + +3773 MAP\_SET\_CIPHERING\_MODE (see clause 8.6); (\*) + +3774 MAP\_CHECK\_IMEI (see clause 8.7); + +3775 MAP\_FORWARD\_NEW\_TMSI (see clause 8.9); (\*) + +3776 MAP\_REPORT\_SM\_DELIVERY\_STATUS (see clause 12.3); + +3777 MAP\_INFORM\_SERVICE\_CENTRE (see clause 12.6); + +3778 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clause 9.1); (\*) + +3779 MAP\_READY\_FOR\_SM (see clause 12.4). + +3780 (\*) These services are not used by the SGSN. + +3781 A message flow example for the mobile terminated short message procedure for a single short message transfer in an + +3782 environment that makes use of an SMS Router for MT-short-message-transfer is shown in figure 23.3/2a. + +3783 NOTE: This message flow can be applied only if no IP-SM-GW deployed in the same network. + +![Sequence diagram for Mobile terminated short message procedure with SMS Router. Six vertical lifelines are shown. Arrows indicate message flow: from the 6th lifeline to the 5th, then to the 4th, then to the 3rd, and finally from the 3rd to the 5th.](17acb575c195ee674cfb0d30fc8a33e0_img.jpg) + +Sequence diagram for Mobile terminated short message procedure with SMS Router. Six vertical lifelines are shown. Arrows indicate message flow: from the 6th lifeline to the 5th, then to the 4th, then to the 3rd, and finally from the 3rd to the 5th. + +3784 + +3785 + +**Figure 23.3/2a Mobile terminated short message procedure with SMS Router** + +- 3786 1) Short Message (3GPP TS 23.040 [26]) +- 3787 2) & 3) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM +- 3788 NOTE: The HLR relays the message MAP\_SEND\_ROUTING\_INFO\_FOR\_SM received from the SMS-GMSC +- 3789 to the SMS Router on SCCP level. How this is done is implementation specific. +- 3790 4) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM +- 3791 5) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK and conditionally MAP\_INFORM\_SERVICE\_CENTRE +- 3792 6) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK and conditionally MAP\_INFORM\_SERVICE\_CENTRE +- 3793 7) Conditionally: Inform Service Centre (3GPP TS 23.040 [26]) +- 3794 8) MAP\_MT\_FORWARD\_SHORT\_MESSAGE +- 3795 The message should include the timer value used at the SMS-GMSC for the supervision of the +- 3796 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. +- 3797 NOTE: In this example the SMS-GMSC decides to attempt delivery via MSC. Therefore the SCCP called party +- 3798 SSN shall be set to SSN for MSC. +- 3799 9) MAP\_MT\_FORWARD\_SHORT\_MESSAGE +- 3800 The message should include the timer value used at the SMS-GMSC for the supervision of the +- 3801 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. +- 3802 10) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ERROR +- 3803 NOTE: In this example delivery via the MSC is unsuccessful e.g. due to IMSI detached +- 3804 11) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ERROR +- 3805 12) MAP\_MT\_FORWARD\_SHORT\_MESSAGE +- 3806 NOTE: In this example the SMS-GMSC decides to retry delivery via the SGSN. Therefore the SCCP called party +- 3807 SSN shall be set to the SSN for SGSN. + +3808 13) MAP\_MT\_FORWARD\_SHORT\_MESSAGE +3809 The message should include the timer value used at the SMS-GMSC for the supervision of the +3810 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. +3811 14) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK +3812 NOTE: In this example delivery via SGSN is successful +3813 15) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK +3814 16) Conditionally: MAP\_REPORT\_SM\_DELIVERY\_STATUS +3815 NOTE: In this example unsuccessful delivery via MSC and successful delivery via SGSN is reported +3816 17) MAP\_REPORT\_SM\_DELIVERY\_STATUS\_Ack +3817 18) Short Message Acknowledgement (3GPP TS 23.040 [26]). +3818 +3819 A message flow example for the mobile terminated short message procedure for a single short message transfer in an +3820 environment that makes use of an IP-SM-GW (see 3GPP TS 23.204 [134]) for MT-short-message-transfer is shown in +3821 figure 23.3/2b. +3822 NOTE: SMS Routers can apply this message flow as well. + +![Sequence diagram showing three messages between four lifelines. The messages are: 1) from the 4th lifeline to the 3rd, 2) from the 3rd lifeline to the 2nd, and 3) from the 2nd lifeline to the 1st.](54327e3de1d855ebc746b9fc1d29eca4_img.jpg) + +``` +sequenceDiagram + participant 4 + participant 3 + participant 2 + participant 1 + Note right of 4: 1) Short Message (3GPP TS 23.040 [26]) + 4->>3: + Note right of 3: 2) MAP_SEND_ROUTING_INFO_FOR_SM + 3->>2: + Note right of 2: 3) MAP_SEND_ROUTING_INFO_FOR_SM + 2->>1: +``` + +Sequence diagram showing three messages between four lifelines. The messages are: 1) from the 4th lifeline to the 3rd, 2) from the 3rd lifeline to the 2nd, and 3) from the 2nd lifeline to the 1st. + +3824 + +3825 + +**Figure 23.3/2b Mobile terminated short message procedure with IP-SM-GW** + +3826 + +1) + +Short Message (3GPP TS 23.040 [26]) + +3827 + +2) + +MAP\_SEND\_ROUTING\_INFO\_FOR\_SM + +3828 + +the message is forwarded to the IP-SM-GW assigned to the recipient of the SM + +3829 + +the message may contain IP-SM-GW Guidance support indication + +3830 + +3) + +MAP\_SEND\_ROUTING\_INFO\_FOR\_SM + +3831 4) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM +3832 since the message is received from an IP-SM-GW, it is not forwarded to an IP-SM-GW +3833 5) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK and conditionally MAP\_INFORM\_SERVICE\_CENTRE +3834 6) MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ACK and conditionally MAP\_INFORM\_SERVICE\_CENTRE +3835 The IP-SM-GW returns its own address within the network node number parameter +3836 The message may include IP-SM-GW Guidance +3837 7) Conditionally: Inform Service Centre (3GPP TS 23.040 [26]) +3838 8) MAP\_MT\_FORWARD\_SHORT\_MESSAGE +3839 If the IP-SM-GW-Guidance support indicator was present in message 2 and IP-SM-GW-Guidance was +3840 present in message 6, message 8 shall contain the used timer value for supervision of +3841 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK; the used timer should be identical to the recommended +3842 value received in message 6 to ensure that the IP-SM-GW can attempt delivery to multiple domains if +3843 necessary and shall not be lower than the minimum value received in message 6 to ensure that an IP-SM- +3844 GW can attempt delivery to at least one domain. +3845 Otherwise, The message should include the timer value used at the SMS-GMSC for the supervision of the +3846 MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK. +3847 9) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK +3848 10) Conditionally: MAP\_REPORT\_SM\_DELIVERY\_STATUS +3849 NOTE: As an IP-SM-GW is deployed the message is acknowledged ignoring its content + +3850 11) MAP\_REPORT\_SM\_DELIVERY\_STATUS\_Ack +3851 12) Conditionally: MAP\_REPORT\_SM\_DELIVERY\_STATUS +3852 since the message is received from an IP-SM-GW, it is processed +3853 13) MAP\_REPORT\_SM\_DELIVERY\_STATUS\_Ack +3854 NOTE: Step 12 and 13 is independent of steps 10, 11, and 14. They can run in parallel. + +3855 14) Short Message Acknowledgement (3GPP TS 23.040 [26]). +3856 + +### 3857 23.3.1 Procedure in the SMS-GMSC + +3858 Any CAMEL-specific handling described in this clause is omitted if the SMS-GMSC does not support CAMEL. +3859 CAMEL-specific handling is invoked only if the SMS-GMSC is integrated with the VMSC. + +3860 The process starts when the SMS-GMSC receives an SC\_RP\_MT\_DATA indication from a Service Centre. The MAP +3861 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3862 Receive\_Open\_Cnf see clause 25.1.2; + +3863 Check\_Confirmation see clause 25.2.2. + +3864 Process MT\_SM\_GMSC sheet 1: If the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM confirmation included an LMSI, it +3865 shall be included in the sm-RP-DA information field of the first MAP\_MT\_FORWARD\_SHORT\_MESSAGE request +3866 sent to the serving MSC. In this case, the IMSI shall be included in the Destination Reference of the MAP\_OPEN +3867 request. The SMS-GMSC shall not send an LMSI to an SGSN. If the SMS-GMSC does not send an LMSI to the +3868 serving node, the sm-RP-DA information field in the first MAP\_MT\_FORWARD\_SHORT\_MESSAGE request sent to +3869 the serving MSC or SGSN shall contain the IMSI, and the Destination Reference in the MAP\_OPEN request shall not +3870 be present. The parameter SM\_RP\_OA shall contain the Service Centre address. + +3871 Process MT\_SM\_GMSC sheet 1: The indication of which number belongs to the SGSN and which to the MSC, +3872 received from the HLR in the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM confirm (see clause 23.3.2) will enable the +3873 SMS-GMSC to map the causes received from one or both serving nodes into the appropriate causes for non GPRS, +3874 GPRS or both, and send them to the SC and the HLR. + +3875 Process MT\_SM\_GMSC sheet 2: The SMS-GMSC maps "Unexpected data value" and "System failure" MAP errors +3876 from the serving node to a "System failure" RP\_ERROR error cause. The mapping between other MAP error causes +3877 and the RP\_ERROR error cause is given in 3GPP TS 23.040 [26] and 3GPP TS 24.011 [37]. + +3878 Process MT\_SM\_GMSC sheet 2: If the SMS-GMSC receives both MSC and SGSN numbers from the HLR as routeing +3879 information, it may choose which serving node to use for the first delivery attempt. + +3880 Process MT\_SM\_GMSC sheet 2: If the SMS-GMSC makes two delivery attempts, it may report the result of each +3881 delivery attempt to the HLR according to the conditions described below. + +3882 Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 1: if the macro MT\_SM\_Transfer\_MSC takes the Error exit, the +3883 SMS-GMSC maps the MAP User Error to the corresponding SC\_RP error, as defined in 3GPP TS 23.040 [26]. + +3884 Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 3: The decision box "TCAP Handshake required" takes the "yes" +3885 or "no" exit depending on agreements between the GMSC's operator and the serving node's operator (see 3GPP TS +3886 33.204 [34a]). + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 1, sheet 2, sheet 4, sheet 5: The SMS-GMSC invokes the macro +Report\_SM\_Delivery\_Stat\_GMSC if: + +- 3887 - the reason received from the serving node for failure to deliver the message is absent subscriber\_SM, +3888 unidentified subscriber or SM delivery failure with error cause "MS memory capacity exceeded", and the SC +3889 address is not yet included in the MWD set, or +- 3890 - the reason received from the serving node for failure to deliver the message is absent subscriber\_SM, +3891 unidentified subscriber or SM delivery failure with error cause MS memory capacity exceeded, and the +3892 corresponding flag in the HLR (as indicated in the information received in the MAP\_INFORM\_ +3893 SERVICE\_CENTRE) is not set, or +- 3894 - the reason received from the serving node (MSC or SGSN) for failure to deliver the message is absent +3895 subscriber\_SM and the absent subscriber diagnostic is different from the absent subscriber diagnostic received in +3896 the MAP\_INFORM\_SERVICE\_CENTRE. + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 1, sheet 2, sheet 4, sheet 5: If absent subscriber diagnostic +information (see 3GPP TS 23.040 [26]) is included with the absent subscriber\_SM error indication then the SMS- +GMSC relays this information to the HLR using the MAP\_REPORT\_SM\_DELIVERY\_STATUS service. + +3897 Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 1, sheet 4: The More Messages To Send flag is set to TRUE or +3898 FALSE according to the information received from the Service Centre. + +3899 Procedure MT\_SM\_Delivery\_Attempt\_GMSC sheet 3: If the capacity of a message signal unit in the lower layers of +3900 the protocol is enough to carry the content of the MAP\_OPEN request and the content of the +3901 MAP\_MT\_FORWARD\_SHORT\_MESSAGE request in a single TC message, the test "Message segmentation needed" +3902 takes the "No" exit; otherwise the test takes the "Yes" exit. + +3903 The mobile terminated short message transfer process in the SMS-GMSC is shown in figure 23.3/3. The procedure +3904 MT\_SM\_Delivery\_Attempt\_GMSC is shown in figure 23.3/4. The macro MT\_SM\_Transfer\_MSC is shown in +3905 figure 23.3/7. + +3906 The SMS-GMSC may include the Maximum Retransmission Time IE in the MT Forward Short Message Request to +3907 indicate that it is capable to retransmit the Short Message until the indicated maximum retransmission time, if the +3908 following conditions are fulfilled: + +- 3909 - the destination user pertains to the PLMN of the SMS-GMSC; and +- 3910 - if an SMS Router is used for MT SMS sent to destination users pertaining to the PLMN of the SMS-GMSC, the +3911 SMS Router is known to support the Alert Service Centre procedure specified in clause 12.5. + +3912 The SMS-GMSC shall include its E.164 number in the SMS-GMSC address and, if available its Diameter Identity in +3913 the SMS-GMSC Diameter Address in the request if it also includes the Maximum-Retransmission-Time IE. + +3914 If subsequently, the SMS-GMSC receives an Alert Service Centre request from an MME (via an IWF), SGSN or MSC, +3915 the SMS-GMSC shall retransmit pending MT SMS(s) for the destination user identified by the User Identifier Alert, to +3916 the same serving node if the SMS-GMSC Alert Event indicates that the MS is available for MT SMS, or to the new +3917 serving node if the SMS-GMSC Alert Event indicates that the MS has moved under the coverage of another MME, +3918 SGSN or MSC. In the latter case, if neither New MSC Number, nor New SGSN Number, nor New SGSN Diameter +3919 Address, nor New MME Number, nor New MME Diameter Address are received in the Alert Service Centre request, +3920 the SMS-GMSC shall initiate a Send Routing Info for SM procedure to retrieve the new serving node's address from +3921 the HLR. + +## 3922 23.3.2 Procedure in the HLR + +3923 The process starts when the HLR receives a MAP\_SEND\_ROUTING\_INFO\_FOR\_SM indication from the SMS- +3924 GMSC. If an SMS Router is deployed, the HLR receives MAP\_SEND\_ROUTING\_INFO\_FOR\_SM from the +3925 SMS Router (step 4 in figure 23.3/2a); relaying a message received from the SMS-GMSC to the SMS Router on SCCP +3926 level (steps 2 and 3 in figure 23.3/2a) is done by implementation specific means and is not shown in figure 23.3/5. + +3927 The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +3928     Check\_Indication       see clause 25.2.1. + +3929 Sheet 1: The decision box "Relay to IP-SM-GW" takes the "yes" exit if an IP-SM-GW is deployed and the message was +3930 not received from an IP-SM-GW. + +3931 Sheet 3: If the SMS-GMSC does not support GPRS functionality, it uses the protocol defined in the Release 96 version +3932 of this specification. The parameter "msc-Number" in "RoutingInfoForSM-Res" in the Release 96 version of the +3933 protocol definition corresponds to the parameter "networkNode-Number" in "RoutingInfoForSM-Res" in the Release 97 +3934 (and later) version of the protocol definition; therefore if the HLR populates the parameter "networkNode-Number" +3935 with the SGSN number, the Release 96 SMS-GMSC will interpret the SGSN number as an MSC number. If the HLR +3936 populates the "gprsNodeIndicator" parameter in the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM response, a Release 96 +3937 SMS-GMSC will silently discard the parameter. + +3938 Sheet 5: If the HLR received a LMSI from the VLR at location updating, it shall include the LMSI in the +3939 MAP\_SEND\_ROUTING\_INFO\_FOR\_SM response only if the MAP\_SEND\_ROUTING\_INFO\_FOR\_SM response +3940 also includes the MSC number. + +3941 The mobile terminated short message transfer process in the HLR is shown in figure 23.3/5. + +## 3942 23.3.3 Procedure in the Serving MSC + +3943 Any CAMEL-specific handling defined in this clause is omitted if the MSC does not support CAMEL control of MT +3944 SMS, or if the subscriber does not have a subscription for CAMEL control of MT SMS. + +3945 The process starts when the MSC receives a dialogue opening request with the application context shortMsgMT- +3946 RelayContext. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found +3947 as follows: + +3948     Receive\_Open\_Ind       see clause 25.1.1; + +3949     Check\_Indication       see clause 25.2.1. + +3950 The mobile terminated short message transfer process in the serving MSC is shown in figure 23.3/6 + +3951 Procedure MT\_SM\_VMSC sheet 1: The decision box "TCAP Handshake required" takes the "yes" or "no" exit +3952 depending on agreements between the Serving MSC's operator and the SMS Gateway MSC's operator (see 3GPP TS +3953 33.204 [34a]). + +3954 The macro MT\_SM\_Transfer\_MSC may be invoked either in a stand-alone serving MSC or in a serving MSC which is +3955 integrated with the SMS-GMSC. It is used to transfer the first MT short message of a possible sequence of messages. +3956 The macro invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +3957     Check\_Confirmation     see clause 25.2.2. + +3958     Page\_MSC             see clause 25.3.1; + +3959     Search\_for\_MS\_MSC    see clause 25.3.2; + +3960     Process\_Access\_Request\_MSC see clause 25.4.1; + +3961     Trace\_Subscriber\_Activity\_MSC see clause 25.9.1. + +3962 The macro MT\_SM\_Transfer\_MSC is shown in figure 23.3/7. The macro Check\_Subscr\_Identity\_For\_MT\_SMS is +3963 shown in figure 23.3/8. + +3964 3GPP TS 29.118 [152] specifies the extensions applicable to the MT SMS procedure over SGs for a UE using extended +3965 idle mode DRX (as defined in 3GPP TS 23.682 [148]). + +3966 If the MS is using a power saving mechanism such as extended idle mode DRX (see 3GPP TS 23.682 [148]), and if the +3967 MT Forward Short Message Request includes the Maximum Retransmission Time IE, an MSC using Deployment +3968 Option 2 (see clause 8.2.4a.1 of 3GPP TS 23.272 [143] and 3GPP TS 23.040 [6]) may return an MT Forward Short +3969 Message Response with the User Error set to Absent Subscriber\_SM and with the Requested-Retransmission-Time IE +3970 requesting the SMS-GMSC to retransmit the Short Message at a later time prior to the Maximum Retransmission Time. +3971 In that case, the MSC shall store (if not already done) the SMS-GMSC address and, if available, the SMS-GMSC +3972 Diameter Identity received in the request and shall not set the MNRF flag. + +3973 NOTE: This mechanism does not cause additional signalling at the HSS to retransmit the Short Message. + +3974 An MSC using Deployment Option 2 (see clause 8.2.4a.1 of 3GPP TS 23.272 [143] and 3GPP TS 23.040 [6]) shall +3975 initiate the MAP Service Center Alert procedure to alert the SMS-GMSC when the UE, for which one or more MT +3976 SMS have been requested to be retransmitted at a later time, becomes available for MT SMS delivery or moves under +3977 the coverage of another MSC prior to the requested SM retransmission time. The MSC shall then delete the stored +3978 SMS-GMSC address after the Alert Service Centre procedure is completed. + +3979 + +### 3980 23.3.4 Procedure in the VLR + +3981 Any CAMEL-specific handling defined in this clause is omitted if the VLR does not support CAMEL control of MT +3982 SMS. + +3983 The process starts when the VLR receives a dialogue opening request from the MSC. The process invokes macros not +3984 defined in this clause; the definitions of these macros can be found as follows: + +3985     Receive\_Open\_Ind       see clause 25.1.1; + +3986     Check\_Indication       see clause 25.2.1; + +3987     Check\_Confirmation    see clause 25.2.2; + +3988     Process\_Access\_Request\_VLR see clause 25.4.2. + +3989 The mobile terminated short message transfer process in the VLR is shown in figure 23.3/9. + +3990 If the VLR has no IMSI record, or if the record is marked "Subscriber Data Not Confirmed by HLR", the VLR may +3991 perform the data restoration procedure as specified in clause 4.2.2 in 3GPP TS 23.007 [19]. + +### 3992 23.3.5 Procedure in the SGSN + +3993 Any CAMEL-specific handling defined in this clause is omitted if the SGSN does not support CAMEL control of MT +3994 SMS, or if the subscriber does not have a subscription for CAMEL control of MT SMS. + +3995 The process starts when the SGSN receives a dialogue opening request with the application context shortMsgMT- +3996 RelayContext. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found +3997 as follows: + +3998     Receive\_Open\_Ind       see clause 25.1.1; + +3999     Check\_Indication       see clause 25.2.1. + +4000 The mobile terminated short message transfer process in the SGSN is shown in figure 23.3/10. + +4001 Procedure MT\_SM\_SGSN sheet 1: The decision box "TCAP Handshake required" takes the "yes" or "no" exit +4002 depending on agreements between the Serving SGSN's operator and the SMS Gateway MSC's operator (see 3GPP TS +4003 33.204 [34a]). + +4004 The macro MT\_SM\_Transfer\_SGSN is used to transfer the first MT short message of a possible sequence of messages. +4005 It is shown in figure 23.3/11. + +4006 If the MS is using extended idle mode DRX (as defined in 3GPP TS 23.682 [148]) and the MS is expected to respond to +4007 paging shortly or within the time frame indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the +4008 SGSN should page the MS and attempt to deliver the short message to the MS. + +4009 If the MS is using extended idle mode DRX (as defined in 3GPP TS 23.682 [148]) and the MS is expected to not +4010 respond to paging shortly or within the time frame indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time +4011 IEs, the SGSN may behave as specified in figure 23.3/11 for an MS that is not reachable, i.e. set the MNRG flag and +4012 return an Absent Subscriber Error to the SMS-GMSC, while still paging the MS. + +4013 NOTE 1: This mechanism is not intended for MSs which are known to wake up shortly (e.g. within the next 10 +4014 seconds) as enough time needs to elapse, between the sending of the MT Forward Short Message +4015 Response and the subsequent Ready For SM procedure towards the HLR when the MS becomes +4016 reachable, for the Report SM Delivery Status procedure to take place beforehand from the SMS-GMSC to +4017 the HLR. + +4018 If the MS is using a power saving mechanism such as extended idle mode DRX (see 3GPP TS 23.682 [148]), and if the +4019 MT Forward Short Message Request includes the Maximum Retransmission Time IE, the SGSN may return an MT +4020 Forward Short Message Response with the User Error set to Absent Subscriber\_SM and with the Requested- +4021 Retransmission-Time IE requesting the SMS-GMSC to retransmit the Short Message at a later time prior to the +4022 Maximum Retransmission Time. In that case, the SGSN shall store (if not already done) the SMS-GMSC address and, +4023 if available, the SMS-GMSC Diameter Identity received in the request and shall not set the MNRG flag. + +4024 NOTE 2: This mechanism does not cause additional signalling at the HSS to retransmit the Short Message. + +4025 The SGSN shall initiate the MAP Service Center Alert procedure to alert the SMS-GMSC when the UE, for which one +4026 or more MT SMS have been requested to be retransmitted at a later time, becomes available for MT SMS delivery or +4027 moves under the coverage of another MME or SGSN prior to the requested SM retransmission time. The SGSN shall +4028 then delete the stored SMS-GMSC address after the Alert Service Centre procedure is completed. + +4029 The macro Check\_Subscr\_Identity\_For\_MT\_SMS is shown in figure 23.3/8. The page and search procedures are +4030 shown in figures 23.3/12 and 23.3/13. + +### 4031 23.3.6 Procedure in the SMS Router + +4032 If SMS Router is deployed together with IP-SM-GW, then mobile terminated short message transfer process for IP-SM- +4033 GW applies as described in clause 23.3.7. + +4034 The mobile terminated short message transfer process in the SMS Router is shown in figure 23.3/14. + +4035 Procedure MT\_SM\_SMS\_ROUTER sheet 2: Allocated MT Correlation IDs have a limited lifetime, managed by Timer +4036 T1. The value of Timer T1 shall be operator configurable (its value being dependant on such factors as subscriber base, +4037 network size, number of roaming/SMS-interworking partners, average and peak SMS traffic load, etc.). + +4038 The value of the timer T1 shall cover at least the time indicated by the SM Delivery Start Time and SM Delivery Timer +4039 and, if the SMS Router support the Alert Service Centre procedure specified in clause 12.5, the Maximum +4040 Retransmission Time signalled in the MAP-MT-FORWARD-SHORT-MESSAGE. + +4041 Procedure MT\_SM\_SMS\_ROUTER sheet 2: MAP parameters to be stored against the MT Correlation ID are IMSI, +4042 networkNode-Number, gprsNodeIndicator, and additional-Number (if and as received within +4043 MAP\_SEND\_ROUTING\_INFO\_FOR\_SHORT\_MESSAGE\_cnf), and optionally MSISDN as received within +4044 MAP\_SEND\_ROUTING\_INFO\_FOR\_SHORT\_MESSAGE\_ind from the SMS-GMSC (and relayed by the HLR). +4045 The SMS Router may also store the GT, or just the CC and NDC parts of the GT, of the SMS-GMSC from which the +4046 MAP\_SEND\_ROUTING\_INFO\_FOR\_SHORT\_MESSAGE\_ind was received. + +4047 Procedure MT\_SM\_SMS\_ROUTER sheet 3: The SCCP called party SSN received with Open\_ind is used to decide +4048 whether the new dialogue is opened with the MSC or with the SGSN. + +4049 The detail of replacing RP-OA is described in TS23.040 [26]. + +4050 Procedure MT\_SM\_SMS\_ROUTER sheet 4: The decision box "Retry expected" takes the "Yes" exit if two addresses +4051 were received from the HLR, the first delivery attempt was unsuccessful, and the second attempt has not yet been made. + +4052 Procedure MT\_SM\_SMS\_ROUTER sheet 4: The task "Release MT Correlation ID" includes deleting of data stored +4053 against the MT Correlation ID. + +4054 If the MT Forward Short Message Request includes the Maximum-Retransmission-Time IE, the SMS Router shall store +4055 the SMS-GMSC address and, if available, the SMS-GMSC Diameter Identity received in the request and replace it by +4056 its SMS Router address (E.164 number) and, if available, its SMS Router Diameter Identity when forwarding the +4057 request to the MME (via an IFW), SGSN or MSC. + +4058 If the MT Forward Short Message Response includes the Requested-Retransmission-Time IE, the SMS Router shall +4059 include the User Identifier Alert IE when forwarding the response to the SMS-GMSC. + +4060 NOTE: The User Identifier Alert is further used in the Alert Service Centre procedure specified in clause 12.5 to +4061 enable the SMS-GMSC to identify and retransmit all pending MT SMS messages towards the destination +4062 user. + +4063 When receiving an Alert Service Centre request from an MME (via an IWF), SGSN or MSC, the SMS-Router shall +4064 replace the IMSI received in the IMSI IE by the User Identifier Alert previously sent in the MT Forward Short Message +4065 Response, and forward that request to the SMS-GMSC. + +### 4066 23.3.7 Procedure in the IP-SM-GW + +4067 Process MT\_SM\_IPSMGW sheet 3: After unsuccessful delivery via the S-CSCF the IP-SM-GW may retry delivery via +4068 MSC and/or SGSN if MSC address and/or SGSN address are available (unless the reported error was "memory capacity +4069 exceeded" in which case a retry shall not be done). If the retry is successful, a positive response is returned to the SMS- +4070 GMSC. If the retry is unsuccessful, an error indication is returned to the SMS-GMSC as follows: +4071 If one of the error indications received from S-CSCF, MSC, or SGSN is AbsentSubscriberSM or +4072 UnidentifiedSubscriber, this error shall be returned to the SMS-GMSC. + +Process MT\_SM\_IPSMGW sheet 3: The IP-SM-GW invokes the macro Report\_SM\_Delivery\_Stat\_IPSMGW if: + +- 4073 - the reason for failure to deliver the message is absent subscriber\_SM, unidentified subscriber or SM delivery +4074 failure with error cause "MS memory capacity exceeded", and the SC address is not yet included in the MWD +4075 set, or +- 4076 - the reason for failure to deliver the message is absent subscriber\_SM, unidentified subscriber or SM delivery +4077 failure with error cause MS memory capacity exceeded, and the corresponding flag in the HLR (as indicated in +4078 the information received in the MAP\_INFORM\_SERVICE\_CENTRE) is not set, or +- 4079 - the reason for failure to deliver the message is absent subscriber\_SM and the absent subscriber diagnostic is +4080 different from the absent subscriber diagnostic received in the MAP\_INFORM\_SERVICE\_CENTRE. + +4081 + +4082 The mobile terminated short message transfer process in the IP-SM-GW is shown in figure 23.3/15. + +4083 + +![Flowchart for Process MT_SM_GMSC. It starts with a Null terminal, followed by an SC_RP_MT_DATA_ind signal. Then, MAP_OPEN_req, MAP_SEND_ROUTING_INFO_FOR_SM_req, and MAP_DELIMITER_req are sent. The process waits for a Receive_Open_Cnf. If OK, it goes to Wait_For_Routing_Info. If V1, it performs a MAP_V1 Dialogue and reaches connector 1. If Error, it goes to Set RP_CAUSE: System Failure. From Wait_For_Routing_Info, it handles SC_ABORT_ind, MAP_SEND_ROUTING_INFO_FOR_SM_cnf, MAP_NOTICE_ind, or MAP_U_ABORT_ind/MAP_P_ABORT_ind/MAP_CLOSE_ind. After Check Confirmation, if OK, it checks if LMSI is included in routing info. If Yes, it sets destination reference: IMSI and SM_RP_DA: LMSI. If No, it sets destination reference: not included and SM_RP_DA: IMSI. Both lead to Wait_For_INFORM_SC. If User Error, it sets RP_CAUSE. If Provider Error, Data Error, it goes to Set RP_CAUSE: System Failure, then SC_RP_ERROR_req, and finally Null.](6867d3c00b89576b972010f96477d70c_img.jpg) + +### Process MT\_SM\_GMSC + +MT\_SM\_GMSC1(2) + +Process in the SMS-GMSC to handle delivery of an MT short message + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Null]) --> SC_RP_MT_DATA_ind{SC_RP_MT_DATA_ind} + SC_RP_MT_DATA_ind --> MAP_Requests[MAP_OPEN_req +MAP_SEND_ROUTING_INFO_FOR_SM_req +MAP_DELIMITER_req] + MAP_Requests --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- V1 --> Perform_MAP_V1[Perform_MAP_V1 Dialogue] + Perform_MAP_V1 --> 1((1)) + Receive_Open_Cnf -- OK --> Wait_For_Routing_Info[Wait_For_Routing_Info] + Receive_Open_Cnf -- Error --> Set_RP_CAUSE_System_Failure[Set RP_CAUSE: System Failure] + Wait_For_Routing_Info --> SC_ABORT_ind{SC_ABORT_ind} + Wait_For_Routing_Info --> MAP_SEND_ROUTING_INFO_FOR_SM_cnf{MAP_SEND_ROUTING_INFO_FOR_SM_cnf} + Wait_For_Routing_Info --> MAP_NOTICE_ind{MAP_NOTICE_ind} + Wait_For_Routing_Info --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + SC_ABORT_ind --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> Null1([Null]) + MAP_SEND_ROUTING_INFO_FOR_SM_cnf --> Check_Confirmation[Check Confirmation] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Check_Confirmation + MAP_U_ABORT_ind --> Check_Confirmation + Check_Confirmation -- OK --> LMSI_included{LMSI included in routing info?} + Check_Confirmation -- User Error --> Set_RP_CAUSE[Set RP_CAUSE] + Check_Confirmation -- "Provider Error, Data Error" --> Set_RP_CAUSE_System_Failure + LMSI_included -- Yes --> Set_dest_ref_IMSI[Set destination reference: IMSI] + Set_dest_ref_IMSI --> Set_SM_RP_DA_LMSI[Set SM_RP_DA: LMSI] + LMSI_included -- No --> Set_dest_ref_not_included[Set destination reference: not included] + Set_dest_ref_not_included --> Set_SM_RP_DA_IMSI[Set SM_RP_DA: IMSI] + Set_SM_RP_DA_LMSI --> Wait_For_INFORM_SC[Wait_For_INFORM_SC] + Set_SM_RP_DA_IMSI --> Wait_For_INFORM_SC + Set_RP_CAUSE --> Wait_For_INFORM_SC + Set_RP_CAUSE_System_Failure --> SC_RP_ERROR_req[SC_RP_ERROR_req] + SC_RP_ERROR_req --> Null2([Null]) + +``` + +Flowchart for Process MT\_SM\_GMSC. It starts with a Null terminal, followed by an SC\_RP\_MT\_DATA\_ind signal. Then, MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_req, and MAP\_DELIMITER\_req are sent. The process waits for a Receive\_Open\_Cnf. If OK, it goes to Wait\_For\_Routing\_Info. If V1, it performs a MAP\_V1 Dialogue and reaches connector 1. If Error, it goes to Set RP\_CAUSE: System Failure. From Wait\_For\_Routing\_Info, it handles SC\_ABORT\_ind, MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_cnf, MAP\_NOTICE\_ind, or MAP\_U\_ABORT\_ind/MAP\_P\_ABORT\_ind/MAP\_CLOSE\_ind. After Check Confirmation, if OK, it checks if LMSI is included in routing info. If Yes, it sets destination reference: IMSI and SM\_RP\_DA: LMSI. If No, it sets destination reference: not included and SM\_RP\_DA: IMSI. Both lead to Wait\_For\_INFORM\_SC. If User Error, it sets RP\_CAUSE. If Provider Error, Data Error, it goes to Set RP\_CAUSE: System Failure, then SC\_RP\_ERROR\_req, and finally Null. + +4084 + +4085 + +Figure 23.3/3 (sheet 1 of 2): Process MT\_SM\_GMSC + +![Flowchart for Process MT_SM_GMSC. It starts with a connector '1' leading to 'MAP_CLOSE_ind'. From there, it branches into 'MAP_INFORM_SERVICE_Centre_ind' (leading to 'Check_Indication'), 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req'), and 'SC_ABORT_ind' (leading to 'MAP_U_ABORT_req' and then 'Null'). 'Check_Indication' leads to 'Error from HLR?' (OK/Error paths). 'Error from HLR?' (Yes) leads to 'Set RP_IMSI; Set RP_MSISDN' and then 'SC_RP_ERROR_req' (leading to 'Null'). 'Error from HLR?' (No) leads to 'Routing info received?'. 'Routing info received?' (Yes) leads to 'MT_SM_Delivery_Attempt_GMSC' and then 'Result?'. 'Result?' (Fail) leads to 'Null'. 'Result?' (Pass, Abort) leads to 'Second routing address provided?'. 'Second routing address provided?' (Yes) leads to another 'MT_SM_Delivery_Attempt_GMSC' block, which then leads to 'Null'. 'Second routing address provided?' (No) leads to 'Null'. 'Routing info received?' (No) leads to 'Null'.](058e1c4e97c83889f2e61dcdd201982f_img.jpg) + +### Process MT\_SM\_GMSC + +### MT\_SM\_GMSC2(2) + +Process in the SMS-GMSC to handle delivery of an MT short message + +Signals to/from the left are to/from the short message service centre; +signals to/from the right are to/from the HLR + +``` + +graph TD + 1((1)) --> MAP_CLOSE_ind[/MAP_CLOSE_ind/] + MAP_CLOSE_ind --> MAP_INFORM_SERVICE_Centre_ind[/MAP_INFORM_SERVICE_Centre_ind/] + MAP_INFORM_SERVICE_Centre_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + Check_Indication -- Error --> MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req[/MAP_CLOSE_req/] + MAP_CLOSE_req --> Error_from_HLR{Error from HLR?} + Error_from_HLR -- Yes --> Set_RP[Set RP_IMSI; Set RP_MSISDN] + Set_RP --> SC_RP_ERROR_req[/SC_RP_ERROR_req/] + SC_RP_ERROR_req --> Null1([Null]) + Error_from_HLR -- No --> Routing_info{Routing info received?} + Routing_info -- Yes --> MT_SM_Delivery_Attempt_GMSC1[MT_SM_Delivery_Attempt_GMSC] + MT_SM_Delivery_Attempt_GMSC1 --> Result{Result?} + Result -- Fail --> Null2([Null]) + Result -- "Pass, Abort" --> Second_routing{Second routing address provided?} + Second_routing -- Yes --> MT_SM_Delivery_Attempt_GMSC2[MT_SM_Delivery_Attempt_GMSC] + MT_SM_Delivery_Attempt_GMSC2 --> Null3([Null]) + Second_routing -- No --> Null4([Null]) + Routing_info -- No --> Null5([Null]) + MAP_NOTICE_ind --> SC_ABORT_ind[/SC_ABORT_ind/] + SC_ABORT_ind --> MAP_U_ABORT_req[/MAP_U_ABORT_req/] + MAP_U_ABORT_req --> Null6([Null]) + +``` + +Flowchart for Process MT\_SM\_GMSC. It starts with a connector '1' leading to 'MAP\_CLOSE\_ind'. From there, it branches into 'MAP\_INFORM\_SERVICE\_Centre\_ind' (leading to 'Check\_Indication'), 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req'), and 'SC\_ABORT\_ind' (leading to 'MAP\_U\_ABORT\_req' and then 'Null'). 'Check\_Indication' leads to 'Error from HLR?' (OK/Error paths). 'Error from HLR?' (Yes) leads to 'Set RP\_IMSI; Set RP\_MSISDN' and then 'SC\_RP\_ERROR\_req' (leading to 'Null'). 'Error from HLR?' (No) leads to 'Routing info received?'. 'Routing info received?' (Yes) leads to 'MT\_SM\_Delivery\_Attempt\_GMSC' and then 'Result?'. 'Result?' (Fail) leads to 'Null'. 'Result?' (Pass, Abort) leads to 'Second routing address provided?'. 'Second routing address provided?' (Yes) leads to another 'MT\_SM\_Delivery\_Attempt\_GMSC' block, which then leads to 'Null'. 'Second routing address provided?' (No) leads to 'Null'. 'Routing info received?' (No) leads to 'Null'. + +4086 + +4087 + +Figure 23.3/3 (sheet 2 of 2): Process MT\_SM\_GMSC + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA1(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the BSS + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. It starts with a decision 'Serving node = GMSC?'. If 'No', it goes to connector '1'. If 'Yes', it calls 'MT_SM_Transfer_MSC'. From there, it branches into 'Abort', 'OK', and 'Release SMS' paths. The 'OK' path leads to connector '2' and then to a 'Camel Handling' decision. Both 'Camel Handling' decisions lead to either 'CAMEL_T_SMS_FAILURE' (referencing TS 23.078) or 'CAMEL_T_SMS_DELIVERED' (referencing TS 23.078). The 'CAMEL_T_SMS_DELIVERED' path leads to a 'More messages to send?' decision. If 'Yes', it loops back to connector '2'. If 'No', it checks if 'MCEF or MNRF set in HLR?'. If 'Yes', it calls 'Report_SM_Delivery_Stat_GMSC' and then sends 'SC_RP_ACK_req' resulting in 'Result= Pass'. If 'No', it sends 'SC_RP_MT_DATA_ind'. From there, a 'Camel Handling' decision leads to 'CAMEL_T_SMS_INIT' (referencing TS 23.078), which then leads to a 'Result?' decision. If 'Release_SMS', it sends 'SC_ABORT_req' resulting in 'Result= Abort'. If 'Continue', it sends 'A_RP_MT_DATA_req' and then 'Wait_For_Subsequent_A_SM_CONFIRM'. The 'CAMEL_T_SMS_FAILURE' path from the first 'Camel Handling' leads to 'Result= Fail'. The 'CAMEL_T_SMS_FAILURE' path from the second 'Camel Handling' leads to an 'Error?' decision. If 'Else', it loops back to connector '2'. If 'Unidentified Subscriber', it sends 'Set UE: Absent Subscriber'. If 'MWD already set?' is 'Yes', it checks 'Failure cause= indication from HLR?'. If 'No', it sends 'Report_SM_Delivery_Stat_GMSC'. If 'Yes', it sends 'Set RP_ERROR'. Both lead to 'SC_RP_ERROR_req' resulting in 'Result= Fail'. If 'MWD already set?' is 'No', it loops back to connector '2'. Other notes include 'Absent Subscriber, MS Memory Capacity Exceeded' and 'See TS 23.078'.](169399d9ec7701f9c5583c95442c2ef5_img.jpg) + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. It starts with a decision 'Serving node = GMSC?'. If 'No', it goes to connector '1'. If 'Yes', it calls 'MT\_SM\_Transfer\_MSC'. From there, it branches into 'Abort', 'OK', and 'Release SMS' paths. The 'OK' path leads to connector '2' and then to a 'Camel Handling' decision. Both 'Camel Handling' decisions lead to either 'CAMEL\_T\_SMS\_FAILURE' (referencing TS 23.078) or 'CAMEL\_T\_SMS\_DELIVERED' (referencing TS 23.078). The 'CAMEL\_T\_SMS\_DELIVERED' path leads to a 'More messages to send?' decision. If 'Yes', it loops back to connector '2'. If 'No', it checks if 'MCEF or MNRF set in HLR?'. If 'Yes', it calls 'Report\_SM\_Delivery\_Stat\_GMSC' and then sends 'SC\_RP\_ACK\_req' resulting in 'Result= Pass'. If 'No', it sends 'SC\_RP\_MT\_DATA\_ind'. From there, a 'Camel Handling' decision leads to 'CAMEL\_T\_SMS\_INIT' (referencing TS 23.078), which then leads to a 'Result?' decision. If 'Release\_SMS', it sends 'SC\_ABORT\_req' resulting in 'Result= Abort'. If 'Continue', it sends 'A\_RP\_MT\_DATA\_req' and then 'Wait\_For\_Subsequent\_A\_SM\_CONFIRM'. The 'CAMEL\_T\_SMS\_FAILURE' path from the first 'Camel Handling' leads to 'Result= Fail'. The 'CAMEL\_T\_SMS\_FAILURE' path from the second 'Camel Handling' leads to an 'Error?' decision. If 'Else', it loops back to connector '2'. If 'Unidentified Subscriber', it sends 'Set UE: Absent Subscriber'. If 'MWD already set?' is 'Yes', it checks 'Failure cause= indication from HLR?'. If 'No', it sends 'Report\_SM\_Delivery\_Stat\_GMSC'. If 'Yes', it sends 'Set RP\_ERROR'. Both lead to 'SC\_RP\_ERROR\_req' resulting in 'Result= Fail'. If 'MWD already set?' is 'No', it loops back to connector '2'. Other notes include 'Absent Subscriber, MS Memory Capacity Exceeded' and 'See TS 23.078'. + +4088 + +4089 + +Figure 23.3/4 (sheet 1 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +# Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA2(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the BSS + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. It starts with 'Wait For Subsequent A_SM_CONFIRM', then branches into 'A_RP_ERROR_ind' and 'A_RP_ACK_ind'. The 'A_RP_ERROR_ind' path leads to 'Camel Handling' (False/True), 'CAMEL_T_SMS_FAILURE' (See TS 23.078), 'Error?' (Else/MS Memory Capacity Exceeded), 'MWD already set?' (Yes/No), a decision diamond for 'Failure cause= indication from HLR?', 'Report_SM_Delivery_Stat_GMSC' (OK, Error), 'SC_ABORT_req', 'Result= Abort', and an end symbol. The 'A_RP_ACK_ind' path leads to 'Camel Handling' (False/True), 'CAMEL_T_SMS_DELIVERED' (See TS 23.078), and an end symbol labeled '2'.](cfea3ca54d33b18d2069ba64e3cedaa4_img.jpg) + +``` +graph TD; Start([Wait For Subsequent A_SM_CONFIRM]) --> A_RP_ERROR_ind{{A_RP_ERROR_ind}}; Start --> A_RP_ACK_ind{{A_RP_ACK_ind}}; A_RP_ERROR_ind -- False --> Camel_Handling_E{Camel Handling}; A_RP_ERROR_ind -- True --> CAMEL_T_SMS_FAILURE[["CAMEL_T_SMS_FAILURE"]]; CAMEL_T_SMS_FAILURE -.-> Note_E[See TS 23.078]; Camel_Handling_E -- True --> CAMEL_T_SMS_FAILURE; Camel_Handling_E -- False --> Error{Error?}; Error -- Else --> Report_SM_Delivery_Stat_GMSC[["Report_SM_Delivery_Stat_GMSC"]]; Error -- "MS Memory Capacity Exceeded" --> MWD_already_set{MWD already set?}; MWD_already_set -- No --> Decision{ }; MWD_already_set -- Yes --> Decision; Decision -- Yes --> Failure_cause[Failure cause= indication from HLR?]; Failure_cause --> Decision; Decision -- No --> Report_SM_Delivery_Stat_GMSC; Report_SM_Delivery_Stat_GMSC -- "OK, Error" --> SC_ABORT_req{{SC_ABORT_req}}; SC_ABORT_req --> Result_Abort[Result= Abort]; Result_Abort --> End_E((X)); A_RP_ACK_ind -- False --> Camel_Handling_A{Camel Handling}; A_RP_ACK_ind -- True --> CAMEL_T_SMS_DELIVERED[["CAMEL_T_SMS_DELIVERED"]]; CAMEL_T_SMS_DELIVERED -.-> Note_A[See TS 23.078]; Camel_Handling_A -- True --> CAMEL_T_SMS_DELIVERED; Camel_Handling_A -- False --> End_A((2)); +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. It starts with 'Wait For Subsequent A\_SM\_CONFIRM', then branches into 'A\_RP\_ERROR\_ind' and 'A\_RP\_ACK\_ind'. The 'A\_RP\_ERROR\_ind' path leads to 'Camel Handling' (False/True), 'CAMEL\_T\_SMS\_FAILURE' (See TS 23.078), 'Error?' (Else/MS Memory Capacity Exceeded), 'MWD already set?' (Yes/No), a decision diamond for 'Failure cause= indication from HLR?', 'Report\_SM\_Delivery\_Stat\_GMSC' (OK, Error), 'SC\_ABORT\_req', 'Result= Abort', and an end symbol. The 'A\_RP\_ACK\_ind' path leads to 'Camel Handling' (False/True), 'CAMEL\_T\_SMS\_DELIVERED' (See TS 23.078), and an end symbol labeled '2'. + +Figure 23.3/4 (sheet 2 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA3(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. It starts with a connector '1', followed by a decision 'Message segmenting needed?'. If 'Yes', it goes to a process block with 'MAP_OPEN_req' and 'MAP_DELIMITER_req'. If 'No', it goes to a decision 'TCAP Handshake required?'. If 'Yes', it goes to a process block with 'MAP_OPEN_req', 'MAP_MT_FORWARD_SHORT_MESSAGE_req', and 'MAP_DELIMITER_req'. If 'No', it goes directly to 'Receive_Open_Cnf'. Both 'Receive_Open_Cnf' blocks lead to a decision 'Successful delivery?'. If 'Yes', 'Result:= Pass' and an end connector. If 'No', 'SC_RP_ERROR_req' leads to 'Set RP_ERROR: System Failure' and an end connector. If 'OK' from 'Receive_Open_Cnf', it goes to a process block with 'MAP_MT_FORWARD_SHORT_MESSAGE_req' and 'MAP_DELIMITER_req', then to 'Wait_For_First_MT_SMS_Confirm'.](97a02a1421ed287213fa80182159166b_img.jpg) + +``` + +graph TD + 1((1)) --> D1{Message segmenting needed?} + D1 -- Yes --> P1[MAP_OPEN_req +MAP_DELIMITER_req] + D1 -- No --> D2{TCAP Handshake required?} + D2 -- Yes --> P2[MAP_OPEN_req +MAP_MT_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req] + D2 -- No --> R1[Receive_Open_Cnf] + P1 --> R2[Receive_Open_Cnf] + R1 --> D3{Successful delivery?} + R2 --> D4{Successful delivery?} + D3 -- Yes --> RP1[Result:= Pass] + D3 -- No --> SC1[SC_RP_ERROR_req] + SC1 --> SF1[Set RP_ERROR: System Failure] + RP1 --> E1(( )) + SF1 --> E2(( )) + D4 -- Yes --> RP2[Result:= Pass] + D4 -- No --> SC2[SC_RP_ERROR_req] + SC2 --> SF2[Set RP_ERROR: System Failure] + RP2 --> E3(( )) + SF2 --> E4(( )) + R1 -- OK --> P3[MAP_MT_FORWARD_SHORT_MESSAGE_req +MAP_DELIMITER_req] + R2 -- OK --> P3 + P3 --> W1[Wait_For_First_MT_SMS_Confirm] + W1 --> E5(( )) + +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. It starts with a connector '1', followed by a decision 'Message segmenting needed?'. If 'Yes', it goes to a process block with 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req'. If 'No', it goes to a decision 'TCAP Handshake required?'. If 'Yes', it goes to a process block with 'MAP\_OPEN\_req', 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req', and 'MAP\_DELIMITER\_req'. If 'No', it goes directly to 'Receive\_Open\_Cnf'. Both 'Receive\_Open\_Cnf' blocks lead to a decision 'Successful delivery?'. If 'Yes', 'Result:= Pass' and an end connector. If 'No', 'SC\_RP\_ERROR\_req' leads to 'Set RP\_ERROR: System Failure' and an end connector. If 'OK' from 'Receive\_Open\_Cnf', it goes to a process block with 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_req' and 'MAP\_DELIMITER\_req', then to 'Wait\_For\_First\_MT\_SMS\_Confirm'. + +4093 + +4094 + +Figure 23.3/4 (sheet 3 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. It starts with 'Wait_For_First_MT_SMS_Confirm', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_cnf', 'Check_Confirmation', and then branches based on 'OK', 'User Error', or 'Provider Error/Data Error' outcomes.](11a7d67a5e1bb4b322c906c038b8482a_img.jpg) + +### Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA4(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) unless shown otherwise + +``` + + graph TD + Start([Wait_For_First_MT_SMS_Confirm]) --> CNF[MAP_MT_FORWARD_SHORT_MESSAGE_cnf] + CNF --> CHECK[Check_Confirmation] + CHECK --> OK{OK} + OK -- Yes --> MORE[More messages to send?] + MORE -- No --> HLR{MCEF or MNRF set in HLR?} + HLR -- Yes --> STAT1[Report_SM_Delivery_Stat_GMSC] + STAT1 --> ACK1[SC_RP_ACK_req] + ACK1 --> WAIT1[Wait_For_More_Messages_Remote_Delivery] + WAIT1 --> IND[SC_RP_MT_DATA_ind] + IND --> REQ[MAP_MT_FORWARD_SHORT_MESSAGE_req MAP_DELIMITER_req] + REQ --> WAIT2[Wait_For_Subsequent_MT_SMS_Confirm] + MORE -- No --> HLR + HLR -- No --> STAT1 + OK -- User Error --> ERROR{Error?} + ERROR -- Unidentified Subscriber --> SET1[Set UE: Absent Subscriber] + SET1 --> MWD{MWD already set?} + MWD -- Yes --> VMSC{Failure cause from VMSC=indication from HLR?} + VMSC -- Yes --> STAT2[Report_SM_Delivery_Stat_GMSC] + VMSC -- No --> STAT2 + MWD -- No --> STAT2 + STAT2 --> OK2[OK, Error] + OK2 --> SET2[Set RP_ERROR] + SET2 --> REQ2[SC_RP_ERROR_req] + REQ2 --> FAIL1[Result= Fail] + FAIL1 --> END1(( )) + ERROR -- Else --> SET1 + OK -- Provider Error, Data Error --> SET3[Set RP_ERROR] + SET3 --> REQ3[SC_RP_ERROR_req] + REQ3 --> FAIL2[Result= Fail] + FAIL2 --> END2(( )) + SET1 -.-> NOTES[Absent Subscriber, MS Memory Capacity Exceeded] + +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. It starts with 'Wait\_For\_First\_MT\_SMS\_Confirm', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_cnf', 'Check\_Confirmation', and then branches based on 'OK', 'User Error', or 'Provider Error/Data Error' outcomes. + +**Figure 23.3/4 (sheet 4 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC** + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA5(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre, signals to/from the right are to/from the serving node (VMSC or SGSN) + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. The process starts with 'Wait_For_Subsequent_MT_SMS_Confirm', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_cnf', and 'Check_Confirmation'. It then branches based on 'Error?' (OK, User Error, Provider Error, Data Error). The 'Error?' decision leads to 'MS Memory Capacity Exceeded' if 'User Error'. From 'MS Memory Capacity Exceeded', it goes to 'MWD already set?'. If 'Yes', it goes to a decision diamond (Failure cause from VMSC=indication from HLR?). If 'No', it goes to 'Report_SM_Delivery_Stat_GMSC'. Both paths lead to 'SC_ABORT_req'. From the decision diamond, 'Yes' leads to 'Report_SM_Delivery_Stat_GMSC' and 'No' leads to 'SC_ABORT_req'. 'Report_SM_Delivery_Stat_GMSC' leads to 'SC_ABORT_req' (OK, Error). All 'SC_ABORT_req' paths lead to 'Result= Abort' and then to an exit symbol. The 'OK' path from 'Check_Confirmation' leads to connector '3'.](0d333f1ed20780e733957984b3ee1a76_img.jpg) + +``` + +graph TD + Start([Wait_For_Subsequent_MT_SMS_Confirm]) --> MAP[MAP_MT_FORWARD_SHORT_MESSAGE_cnf] + MAP --> Check[Check_Confirmation] + Check --> Error{Error?} + Error -- OK --> 3((3)) + Error -- User Error --> Memory{MS Memory Capacity Exceeded} + Memory --> MWD{MWD already set?} + MWD -- No --> Report[Report_SM_Delivery_Stat_GMSC] + MWD -- Yes --> Decision{Failure cause from VMSC=indication from HLR?} + Decision -- Yes --> Report + Decision -- No --> AbortReq1{SC_ABORT_req} + Report -- "OK, Error" --> AbortReq2{SC_ABORT_req} + AbortReq1 --> Result1[Result= Abort] + Result1 --> Exit1((X)) + AbortReq2 --> Result2[Result= Abort] + Result2 --> Exit2((X)) + Error -- "Provider Error, Data Error" --> AbortReq3{SC_ABORT_req} + AbortReq3 --> Result3[Result= Abort] + Result3 --> Exit3((X)) + +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. The process starts with 'Wait\_For\_Subsequent\_MT\_SMS\_Confirm', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_cnf', and 'Check\_Confirmation'. It then branches based on 'Error?' (OK, User Error, Provider Error, Data Error). The 'Error?' decision leads to 'MS Memory Capacity Exceeded' if 'User Error'. From 'MS Memory Capacity Exceeded', it goes to 'MWD already set?'. If 'Yes', it goes to a decision diamond (Failure cause from VMSC=indication from HLR?). If 'No', it goes to 'Report\_SM\_Delivery\_Stat\_GMSC'. Both paths lead to 'SC\_ABORT\_req'. From the decision diamond, 'Yes' leads to 'Report\_SM\_Delivery\_Stat\_GMSC' and 'No' leads to 'SC\_ABORT\_req'. 'Report\_SM\_Delivery\_Stat\_GMSC' leads to 'SC\_ABORT\_req' (OK, Error). All 'SC\_ABORT\_req' paths lead to 'Result= Abort' and then to an exit symbol. The 'OK' path from 'Check\_Confirmation' leads to connector '3'. + +4098 + +4099 + +Figure 23.3/4 (sheet 5 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +# Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA6(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) unless shown otherwise + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. The process starts with a 'Wait' state, followed by an 'SC_ABORT_ind' signal. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL_T_SMS_FAILURE' (referencing TS 23.078), then 'A_ABORT_req' to the BSS, and ends with 'Result= Abort'. If 'False', it proceeds to 'A_ABORT_req' to the BSS and ends with 'Result= Abort'. There are two parallel sub-processes starting from connectors. The left sub-process starts with 'Wait_For_First_A_SM_CONFIRM', followed by 'A_ABORT_ind' from the BSS. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL_T_SMS_FAILURE' (referencing TS 23.078), then 'Set RP_ERROR: System Failure', 'SC_RP_ERROR_req', and ends with 'Result= Fail'. If 'False', it bypasses these steps and ends with 'Result= Fail'. The right sub-process starts with 'Wait_For_Subsequent_A_SM_CONFIRM', followed by 'A_ABORT_ind' from the BSS. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL_T_SMS_FAILURE' (referencing TS 23.078), then 'SC_ABORT_req', and ends with 'Result= Abort'. If 'False', it bypasses these steps and ends with 'Result= Abort'.](f603beac63483f85d6922a3288fd781b_img.jpg) + +``` + +graph TD + Start([ ]) --> Wait1[Wait_For_First_A_SM_CONFIRM, Wait_For_Subsequent_A_SM_CONFIRM] + Wait1 --> SC_ABORT_ind1{SC_ABORT_ind} + SC_ABORT_ind1 -- False --> CamelHandling1{Camel Handling} + CamelHandling1 -- True --> CAMEL_T_SMS_FAILURE1[CAMEL_T_SMS_FAILURE] + CAMEL_T_SMS_FAILURE1 -.-> TS23078_1[See TS 23.078] + CamelHandling1 -- False --> A_ABORT_req1[A_ABORT_req] + A_ABORT_req1 -.-> ToBSS1[To BSS] + A_ABORT_req1 --> ResultAbort1[Result= Abort] + ResultAbort1 --> End1(( )) + + Start --> Wait2[Wait_For_First_A_SM_CONFIRM] + Wait2 --> A_ABORT_ind2{A_ABORT_ind} + A_ABORT_ind2 -.-> FromBSS2[From BSS] + A_ABORT_ind2 -- False --> CamelHandling2{Camel Handling} + CamelHandling2 -- True --> CAMEL_T_SMS_FAILURE2[CAMEL_T_SMS_FAILURE] + CAMEL_T_SMS_FAILURE2 -.-> TS23078_2[See TS 23.078] + CamelHandling2 -- False --> SetRPError[Set RP_ERROR: System Failure] + SetRPError --> SC_RP_ERROR_req[SC_RP_ERROR_req] + SC_RP_ERROR_req --> ResultFail[Result= Fail] + ResultFail --> End2(( )) + + Start --> Wait3[Wait_For_Subsequent_A_SM_CONFIRM] + Wait3 --> A_ABORT_ind3{A_ABORT_ind} + A_ABORT_ind3 -.-> FromBSS3[From BSS] + A_ABORT_ind3 -- False --> CamelHandling3{Camel Handling} + CamelHandling3 -- True --> CAMEL_T_SMS_FAILURE3[CAMEL_T_SMS_FAILURE] + CAMEL_T_SMS_FAILURE3 -.-> TS23078_3[See TS 23.078] + CamelHandling3 -- False --> SC_ABORT_req[SC_ABORT_req] + SC_ABORT_req --> ResultAbort3[Result= Abort] + ResultAbort3 --> End3(( )) + +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. The process starts with a 'Wait' state, followed by an 'SC\_ABORT\_ind' signal. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL\_T\_SMS\_FAILURE' (referencing TS 23.078), then 'A\_ABORT\_req' to the BSS, and ends with 'Result= Abort'. If 'False', it proceeds to 'A\_ABORT\_req' to the BSS and ends with 'Result= Abort'. There are two parallel sub-processes starting from connectors. The left sub-process starts with 'Wait\_For\_First\_A\_SM\_CONFIRM', followed by 'A\_ABORT\_ind' from the BSS. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL\_T\_SMS\_FAILURE' (referencing TS 23.078), then 'Set RP\_ERROR: System Failure', 'SC\_RP\_ERROR\_req', and ends with 'Result= Fail'. If 'False', it bypasses these steps and ends with 'Result= Fail'. The right sub-process starts with 'Wait\_For\_Subsequent\_A\_SM\_CONFIRM', followed by 'A\_ABORT\_ind' from the BSS. A 'Camel Handling' decision follows. If 'True', it triggers 'CAMEL\_T\_SMS\_FAILURE' (referencing TS 23.078), then 'SC\_ABORT\_req', and ends with 'Result= Abort'. If 'False', it bypasses these steps and ends with 'Result= Abort'. + +4100 + +4101 + +Figure 23.3/4 (sheet 6 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +# Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA7(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) unless shown otherwise + +![Sequence diagram for Procedure MT_SM_Delivery_Attempt_GMSC. The diagram shows two main paths starting from a common entry point. The first path leads to an 'Abort' result via SC_ABORT_ind and MAP_U_ABORT_ind. The second path branches into two parallel sequences: 'Wait_For_First_MT_SMS_Confirm' and 'Wait_For_Subsequent_MT_SMS_Confirm'. Both parallel sequences involve MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_NOTICE_ind, and MAP_CLOSE_req signals. The 'Wait_For_First_MT_SMS_Confirm' path leads to 'Set RP_ERROR: System Failure', then SC_RP_ERROR_req, and finally a 'Fail' result. The 'Wait_For_Subsequent_MT_SMS_Confirm' path leads to SC_ABORT_req and finally an 'Abort' result. All paths end at a circular connector symbol.](53489512b29fbe1eecb47a56bb155fda_img.jpg) + +``` + +sequenceDiagram + participant SMSC as Short Message Service Centre + participant GMSC as SMS-GMSC + participant VMSC_SGSN as VMSC or SGSN + + Note right of SMSC: Wait_For_First_MT_SMS_Confirm, Wait_For_Subsequent_MT_SMS_Confirm + + SMSC->>GMSC: SC_ABORT_ind + GMSC->>SMSC: MAP_U_ABORT_ind + GMSC->>GMSC: Result= Abort + Note right of SMSC: Wait_For_Subsequent_MT_SMS_Confirm + + Note left of SMSC: Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) unless shown otherwise + + Note left of GMSC: Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + + GMSC->>SMSC: MAP_U_ABORT_ind, MAP_P_ABORT_ind + SMSC->>GMSC: MAP_NOTICE_ind + GMSC->>SMSC: MAP_CLOSE_req + + Note left of SMSC: Wait_For_First_MT_SMS_Confirm + Note right of SMSC: Wait_For_Subsequent_MT_SMS_Confirm + + Note left of GMSC: Set RP_ERROR: System Failure + GMSC->>SMSC: SC_RP_ERROR_req + GMSC->>GMSC: Result= Fail + + Note right of SMSC: Wait_For_Subsequent_MT_SMS_Confirm + GMSC->>SMSC: SC_ABORT_req + GMSC->>GMSC: Result= Abort + +``` + +Sequence diagram for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. The diagram shows two main paths starting from a common entry point. The first path leads to an 'Abort' result via SC\_ABORT\_ind and MAP\_U\_ABORT\_ind. The second path branches into two parallel sequences: 'Wait\_For\_First\_MT\_SMS\_Confirm' and 'Wait\_For\_Subsequent\_MT\_SMS\_Confirm'. Both parallel sequences involve MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_NOTICE\_ind, and MAP\_CLOSE\_req signals. The 'Wait\_For\_First\_MT\_SMS\_Confirm' path leads to 'Set RP\_ERROR: System Failure', then SC\_RP\_ERROR\_req, and finally a 'Fail' result. The 'Wait\_For\_Subsequent\_MT\_SMS\_Confirm' path leads to SC\_ABORT\_req and finally an 'Abort' result. All paths end at a circular connector symbol. + +4102 + +4103 + +Figure 23.3/4 (sheet 7 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +MTSMDA8(8) + +Procedure in the SMS-GMSC to attempt MT SM delivery and report the outcome + +Signals to/from the left are to/from the short message service centre; signals to/from the right are to/from the serving node (VMSC or SGSN) unless shown otherwise + +![Flowchart for Procedure MT_SM_Delivery_Attempt_GMSC. The diagram is split into two main vertical paths. The top path starts with 'Wait_For_More_Messages_Local_Delivery' and branches into two abort scenarios: one triggered by 'SC_ABORT_ind' and another by 'A_ABORT_ind' (labeled 'From BSS'). Both lead through 'Camel Handling' (referencing TS 23.078) to 'Result= Abort'. The bottom path starts with 'Wait_For_More_Messages_Remote_Delivery' and branches into three scenarios: 'SC_ABORT_ind' leading to 'Result= Abort', a central path receiving 'MAP_U_ABORT_ind' and 'MAP_P_ABORT_ind' via 'SC_ABORT_req' leading to 'Result= Abort', and a right path receiving 'MAP_NOTICE_ind' and 'MAP_CLOSE_req' via 'SC_ABORT_req' leading to 'Result= Abort'.](362f3486dadd99f17896333a8d291ef6_img.jpg) + +``` + +graph TD + subgraph Local_Delivery + W1[Wait_For_More_Messages_Local_Delivery] --> SC1{SC_ABORT_ind} + W1 --> A1{A_ABORT_ind} + A1 -.-> FromBSS[From BSS] + SC1 -- False --> CH1{Camel Handling} + CH1 -- True --> C1[CAMEL_T_SMS_FAILURE] + C1 -.-> TS1[See TS 23.078] + CH1 -- False --> A1R[A_ABORT_req] + A1R -.-> ToBSS[To BSS] + A1R --> R1[Result= Abort] + R1 --> E1((X)) + A1 -- False --> CH2{Camel Handling} + CH2 -- True --> C2[CAMEL_T_SMS_FAILURE] + C2 -.-> TS2[See TS 23.078] + CH2 -- False --> SC1R[SC_ABORT_req] + SC1R --> R2[Result= Abort] + R2 --> E2((X)) + end + subgraph Remote_Delivery + W2[Wait_For_More_Messages_Remote_Delivery] --> SC2{SC_ABORT_ind} + W2 --> M[ ] + W2 --> MN[MAP_NOTICE_ind] + M --> MU[MAP_U_ABORT_ind, MAP_P_ABORT_ind] + MU --> SC3R[SC_ABORT_req] + SC3R --> R3[Result= Abort] + R3 --> E3((X)) + MN --> MC[MAP_CLOSE_req] + MC --> SC4R[SC_ABORT_req] + SC4R --> R4[Result= Abort] + R4 --> E4((X)) + SC2 --> MU2[MAP_U_ABORT_ind] + MU2 --> R5[Result= Abort] + R5 --> E5((X)) + end + style M fill:none,stroke:none + style MU fill:none,stroke:none + style MC fill:none,stroke:none + style MU2 fill:none,stroke:none + style SC1R fill:none,stroke:none + style SC3R fill:none,stroke:none + style SC4R fill:none,stroke:none + style R4 fill:none,stroke:none + style R5 fill:none,stroke:none + style E4 fill:none,stroke:none + style E5 fill:none,stroke:none + +``` + +Flowchart for Procedure MT\_SM\_Delivery\_Attempt\_GMSC. The diagram is split into two main vertical paths. The top path starts with 'Wait\_For\_More\_Messages\_Local\_Delivery' and branches into two abort scenarios: one triggered by 'SC\_ABORT\_ind' and another by 'A\_ABORT\_ind' (labeled 'From BSS'). Both lead through 'Camel Handling' (referencing TS 23.078) to 'Result= Abort'. The bottom path starts with 'Wait\_For\_More\_Messages\_Remote\_Delivery' and branches into three scenarios: 'SC\_ABORT\_ind' leading to 'Result= Abort', a central path receiving 'MAP\_U\_ABORT\_ind' and 'MAP\_P\_ABORT\_ind' via 'SC\_ABORT\_req' leading to 'Result= Abort', and a right path receiving 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_req' via 'SC\_ABORT\_req' leading to 'Result= Abort'. + +4104 + +4105 + +Figure 23.3/4 (sheet 8 of 8): Procedure MT\_SM\_Delivery\_Attempt\_GMSC + +![A flowchart diagram representing the process MT_SM_HLR. The flow starts with an oval connector, followed by a rounded rectangle, a chevron shape, and a double-bordered rectangle. It then enters a loop of four diamond-shaped decision nodes. The first diamond has a self-loop and an exit path to the left. The second diamond has a self-loop and an exit path to the right. The third diamond has an exit path to the right. The fourth diamond has three exit paths to the bottom. The diagram includes various rectangular process blocks and ends with an 'X' symbol at the bottom left.](0a45b25b2693d2f26fbe2f70eb3fc705_img.jpg) + +A flowchart diagram representing the process MT\_SM\_HLR. The flow starts with an oval connector, followed by a rounded rectangle, a chevron shape, and a double-bordered rectangle. It then enters a loop of four diamond-shaped decision nodes. The first diamond has a self-loop and an exit path to the left. The second diamond has a self-loop and an exit path to the right. The third diamond has an exit path to the right. The fourth diamond has three exit paths to the bottom. The diagram includes various rectangular process blocks and ends with an 'X' symbol at the bottom left. + +4106 + +4107 + +**Figure 23.3/5 (sheet 1 of 6): Process MT\_SM\_HLR** + +![Flowchart for process MT_SM_HLR. It starts at node 2, checks if the MS is reachable in the MSC. If no, it goes to node 5. If yes, it checks if the MSC supports MT SMS. If no, it sets a user error 'Facility not supported' and goes to node 1. If yes, it checks if there is operator barring. If yes, it sets a user error 'Call barred' with cause 'Operator barring' and goes to node 1. If no, it checks if there is SS barring. If yes, it sets a user error 'Call barred' with cause 'Barring service active' and goes to node 1. If no, it checks if MNRF is set. If yes, it checks SM-RP priority. If SM-RP priority is true, it retrieves routing information, sets MW status, and goes to node 10. If SM-RP priority is false, it sets MNRF and goes to node 6. If MNRF is not set, it retrieves routing information and goes to node 11.](33449456be26bf6ac2d988e9db39ba2f_img.jpg) + +process MT\_SM\_HLR + +MT\_SM\_HLR2(6) + +Process in the HLR to provide routing information for MT SMS + +NAM=Non-GPRS + +``` + +graph TD + 2((2)) --> D1{MS reachable in MSC?} + D1 -- No --> 5((5)) + D1 -- Yes --> D2{MSC supports MT SMS?} + D2 -- No --> E1[Set User Error: Facility not supported] + E1 --> 1((1)) + D2 -- Yes --> D3{Operator barring?} + D3 -- Yes --> E2[Set User Error: Call barred] + E2 --> C1[Set Barring cause: Operator barring] + C1 --> 1 + D3 -- No --> D4{SS barring?} + D4 -- Yes --> E3[Set User Error: Call barred] + E3 --> C2[Set Barring cause: Barring service active] + C2 --> 1 + D4 -- No --> D5{MNRF set?} + D5 -- Yes --> D6{SM-RP priority?} + D6 -- True --> R1[Retrieve routing information] + R1 --> S1[Set MW status] + S1 --> 10((10)) + D6 -- False --> S2[Set MNRF] + S2 --> 6((6)) + D5 -- No --> R2[Retrieve routing information] + R2 --> 11((11)) + +``` + +Flowchart for process MT\_SM\_HLR. It starts at node 2, checks if the MS is reachable in the MSC. If no, it goes to node 5. If yes, it checks if the MSC supports MT SMS. If no, it sets a user error 'Facility not supported' and goes to node 1. If yes, it checks if there is operator barring. If yes, it sets a user error 'Call barred' with cause 'Operator barring' and goes to node 1. If no, it checks if there is SS barring. If yes, it sets a user error 'Call barred' with cause 'Barring service active' and goes to node 1. If no, it checks if MNRF is set. If yes, it checks SM-RP priority. If SM-RP priority is true, it retrieves routing information, sets MW status, and goes to node 10. If SM-RP priority is false, it sets MNRF and goes to node 6. If MNRF is not set, it retrieves routing information and goes to node 11. + +4108 + +4109 + +Figure 23.3/5 (sheet 2 of 6): Process MT\_SM\_HLR + +![Flowchart for process MT_SM_HLR. It starts at node 3, checks if MS is reachable in SGSN. If No, it goes to Set MNRG and then to node 9. If Yes, it checks if SGSN supports MT SMS. If No, it goes to node 7. If Yes, it checks if Operator barring. If Yes, it sets User Error: Call barred and Barring cause: Operator barring, then goes to node 1. If No, it checks if SS barring. If Yes, it sets User Error: Call barred and Barring cause: Barring service active, then goes to node 1. If No, it checks if MNRG set. If Yes, it checks SM-RP priority. If True, it retrieves routing information, sets MW status, and goes to node 10. If False, it goes to Set MNRG and then to node 9. If No, it retrieves routing information and goes to node 11.](2ce6b75ca6bbddbcc328c143363111aa_img.jpg) + +process MT\_SM\_HLR + +MT\_SM\_HLR3(6) + +Process in the HLR to provide routing information for MT SMS + +NAM=GPRS + +``` + +graph TD + 3((3)) --> D1{MS reachable in SGSN?} + D1 -- No --> SetMNRG[Set MNRG] + SetMNRG --> 9((9)) + D1 -- Yes --> D2{SGSN supports MT SMS?} + D2 -- No --> 7((7)) + D2 -- Yes --> D3{Operator barring?} + D3 -- Yes --> SetUE1[Set User Error: Call barred] + SetUE1 --> SetBC1[Set Barring cause: Operator barring] + SetBC1 --> 1((1)) + D3 -- No --> D4{SS barring?} + D4 -- Yes --> SetUE2[Set User Error: Call barred] + SetUE2 --> SetBC2[Set Barring cause: Barring service active] + SetBC2 --> 1 + D4 -- No --> D5{MNRG set?} + D5 -- Yes --> D6{SM-RP priority?} + D6 -- True --> RI1[Retrieve routing information] + RI1 --> SetMW[Set MW status] + SetMW --> 10((10)) + D6 -- False --> SetMNRG + D5 -- No --> RI2[Retrieve routing information] + RI2 --> 11((11)) + 8((8)) --> D3 + NAM[GPRS] -.-> 3 + Note[Process in the HLR to provide routing information for MT SMS] -.-> 3 + +``` + +Flowchart for process MT\_SM\_HLR. It starts at node 3, checks if MS is reachable in SGSN. If No, it goes to Set MNRG and then to node 9. If Yes, it checks if SGSN supports MT SMS. If No, it goes to node 7. If Yes, it checks if Operator barring. If Yes, it sets User Error: Call barred and Barring cause: Operator barring, then goes to node 1. If No, it checks if SS barring. If Yes, it sets User Error: Call barred and Barring cause: Barring service active, then goes to node 1. If No, it checks if MNRG set. If Yes, it checks SM-RP priority. If True, it retrieves routing information, sets MW status, and goes to node 10. If False, it goes to Set MNRG and then to node 9. If No, it retrieves routing information and goes to node 11. + +4110 + +4111 + +Figure 23.3/5 (sheet 3 of 6): Process MT\_SM\_HLR + +![Flowchart for process MT_SM_HLR. It starts at node 4 and checks if SMS-GMSC supports GPRS. If No, it goes to a 'Preferred delivery node' decision between MSC (node 2) and SGSN (node 3). If Yes, it checks if MS is reachable in MSC. If No, it checks if MS is reachable in SGSN. If No, node 7 leads to 'Set MNRF; Set MNRG' then node 9. If Yes, it checks if MSC supports MT SMS. If No, it checks if SGSN supports MT SMS. If No, 'Set User Error: Facility not supported' leads to node 1. If Yes, it checks if Operator barring? If Yes, 'Set User Error: Call barred' and 'Set Barring cause: Operator barring' lead to node 6. If No, it checks if SS barring? If Yes, 'Set User Error: Call barred' and 'Set Barring cause: Barring service active' lead to node 1. If No, it checks if MNRF set? If Yes, it checks if MNRG set? If Yes, it checks if SM-RP priority? If True, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. If False, 'Set SGSN address' leads to 'Retrieve routing information'. If No, it checks if SM-RP priority? If True, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. If False, 'Set MSC address' leads to 'Retrieve routing information'. If No, it checks if MNRG set? If Yes, 'Set MSC address; Set SGSN address' leads to node 11. If No, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. 'Retrieve routing information' leads to 'Set MW status' then node 10.](8717425dd6fafc72a992383b93f6118d_img.jpg) + +**process MT\_SM\_HLR** **MT\_SM\_HLR4(6)** + +Process in the HLR to provide routing information for MT SMS + +NAM=Non-GPRS & GPRS + +``` + +graph TD + 4((4)) --> D1{SMS-GMSC supports GPRS?} + D1 -- No --> PDN{Preferred delivery node} + PDN -- MSC --> 2((2)) + PDN -- SGSN --> 3((3)) + D1 -- Yes --> D2{MS reachable in MSC?} + D2 -- No --> D3{MS reachable in SGSN?} + D3 -- No --> 7((7)) + 7 --> S1[Set MNRF; Set MNRG] + S1 --> 9((9)) + D2 -- Yes --> D4{MS reachable in SGSN?} + D4 -- No --> 5((5)) + D4 -- Yes --> D5{MSC supports MT SMS?} + D5 -- No --> D6{SGSN supports MT SMS?} + D6 -- No --> S2[Set User Error: Facility not supported] + S2 --> 1((1)) + D6 -- Yes --> D7{Operator barring?} + D7 -- Yes --> S3[Set User Error: Call barred] + S3 --> S4[Set Barring cause: Operator barring] + S4 --> 6((6)) + D7 -- No --> D8{SS barring?} + D8 -- Yes --> S5[Set User Error: Call barred] + S5 --> S6[Set Barring cause: Barring service active] + S6 --> 1((1)) + D8 -- No --> D9{MNRF set?} + D9 -- Yes --> D10{MNRG set?} + D10 -- Yes --> D11{SM-RP priority?} + D11 -- True --> S7[Set MSC address; Set SGSN address] + D10 -- No --> D12{SM-RP priority?} + D12 -- False --> S8[Set SGSN address] + S7 --> RI[Retrieve routing information] + S8 --> RI + D9 -- No --> D13{MNRG set?} + D13 -- Yes --> D14{SM-RP priority?} + D14 -- True --> S9[Set MSC address; Set SGSN address] + D14 -- False --> S10[Set MSC address] + S9 --> RI + S10 --> RI + D13 -- No --> S11[Set MSC address; Set SGSN address] + S11 --> 11((11)) + RI --> S12[Set MW status] + S12 --> 10((10)) + +``` + +Flowchart for process MT\_SM\_HLR. It starts at node 4 and checks if SMS-GMSC supports GPRS. If No, it goes to a 'Preferred delivery node' decision between MSC (node 2) and SGSN (node 3). If Yes, it checks if MS is reachable in MSC. If No, it checks if MS is reachable in SGSN. If No, node 7 leads to 'Set MNRF; Set MNRG' then node 9. If Yes, it checks if MSC supports MT SMS. If No, it checks if SGSN supports MT SMS. If No, 'Set User Error: Facility not supported' leads to node 1. If Yes, it checks if Operator barring? If Yes, 'Set User Error: Call barred' and 'Set Barring cause: Operator barring' lead to node 6. If No, it checks if SS barring? If Yes, 'Set User Error: Call barred' and 'Set Barring cause: Barring service active' lead to node 1. If No, it checks if MNRF set? If Yes, it checks if MNRG set? If Yes, it checks if SM-RP priority? If True, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. If False, 'Set SGSN address' leads to 'Retrieve routing information'. If No, it checks if SM-RP priority? If True, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. If False, 'Set MSC address' leads to 'Retrieve routing information'. If No, it checks if MNRG set? If Yes, 'Set MSC address; Set SGSN address' leads to node 11. If No, 'Set MSC address; Set SGSN address' leads to 'Retrieve routing information'. 'Retrieve routing information' leads to 'Set MW status' then node 10. + +4112 + +4113 + +Figure 23.3/5 (sheet 4 of 6): Process MT\_SM\_HLR + +![Flowchart for process MT_SM_HLR. It starts with three entry points (9, 10, 11) leading to MAP_SEND_ROUTING_INFO_FOR_SM_rsp. Point 9 leads to a decision 'SC address in MWD list?'. If No, it goes to 'Update MWD list' then 'MWD update failed?'. If Yes, it goes to 'MWD status:= SC address included'. Point 10 leads to 'SC address in MWD list?'. If No, it goes to 'MWD status:= SC address not included'. If Yes, it goes to 'MWD status:= SC address included'. Point 11 leads to 'MCEF set?'. If No, it goes to 'MSISDN= MSISDN Alert?'. If Yes, it goes to 'Set MW status'. All status updates lead to 'MSISDN= MSISDN Alert?'. If No, it goes to 'Set MSISDN Alert' then 'MAP_INFORM_SERVICE_CENTRE_req MAP_CLOSE_req'. If Yes, it goes directly to 'MAP_INFORM_SERVICE_CENTRE_req MAP_CLOSE_req'. The 'MSISDN= MSISDN Alert?' decision from point 11 leads to 'Set MSISDN Alert' then 'MAP_INFORM_SERVICE_CENTRE_req' then 'MAP_CLOSE_req'. All final paths end with an 'X' mark.](f753096fee70af0f41b82a35ee0f13e1_img.jpg) + +**process MT\_SM\_HLR** **MT\_SM\_HLR5(6)** + +Process in the HLR to provide routing information for MT SMS + +Signals to the left are to the SMS-GMSC + +``` + +graph TD + 9((9)) --> R9[MAP_SEND_ROUTING_INFO_FOR_SM_rsp] + 10((10)) --> R10[MAP_SEND_ROUTING_INFO_FOR_SM_rsp] + 11((11)) --> R11[MAP_SEND_ROUTING_INFO_FOR_SM_rsp] + + R9 --> D9{SC address in MWD list?} + D9 -- Yes --> S9[MWD status:= SC address included] + D9 -- No --> U[Update MWD list] + U --> F{MWD update failed?} + F -- Yes --> N9[MWD status:= SC address not included] + F -- No --> S9 + + R10 --> D10{SC address in MWD list?} + D10 -- Yes --> S10[MWD status:= SC address included] + D10 -- No --> N10[MWD status:= SC address not included] + + R11 --> D11{MCEF set?} + D11 -- Yes --> S11[Set MW status] + D11 -- No --> A11{MSISDN= MSISDN Alert?} + + S9 --> A{MSISDN= MSISDN Alert?} + N9 --> A + S10 --> A + N10 --> A + S11 --> A + + A -- Yes --> I[MAP_INFORM_SERVICE_CENTRE_req +MAP_CLOSE_req] + A -- No --> AL[Set MSISDN Alert] + AL --> I + + A11 -- Yes --> C[MAP_CLOSE_req] + A11 -- No --> AL11[Set MSISDN Alert] + AL11 --> I11[MAP_INFORM_SERVICE_CENTRE_req] + I11 --> C + + I --> X1((X)) + C --> X2((X)) + +``` + +Flowchart for process MT\_SM\_HLR. It starts with three entry points (9, 10, 11) leading to MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_rsp. Point 9 leads to a decision 'SC address in MWD list?'. If No, it goes to 'Update MWD list' then 'MWD update failed?'. If Yes, it goes to 'MWD status:= SC address included'. Point 10 leads to 'SC address in MWD list?'. If No, it goes to 'MWD status:= SC address not included'. If Yes, it goes to 'MWD status:= SC address included'. Point 11 leads to 'MCEF set?'. If No, it goes to 'MSISDN= MSISDN Alert?'. If Yes, it goes to 'Set MW status'. All status updates lead to 'MSISDN= MSISDN Alert?'. If No, it goes to 'Set MSISDN Alert' then 'MAP\_INFORM\_SERVICE\_CENTRE\_req MAP\_CLOSE\_req'. If Yes, it goes directly to 'MAP\_INFORM\_SERVICE\_CENTRE\_req MAP\_CLOSE\_req'. The 'MSISDN= MSISDN Alert?' decision from point 11 leads to 'Set MSISDN Alert' then 'MAP\_INFORM\_SERVICE\_CENTRE\_req' then 'MAP\_CLOSE\_req'. All final paths end with an 'X' mark. + +4114 + +4115 + +Figure 23.3/5 (sheet 5 of 6): Process MT\_SM\_HLR + +![A process flow diagram for MT_SM_HLR. It starts with an entry point leading to a decision diamond. The first path from the diamond leads to a process block (two rectangles), which then loops back to the entry point. The second path from the diamond leads to another decision diamond. The first path from this second diamond leads to another process block (two rectangles), which loops back to the entry point. The second path from the second diamond leads to a data store (double rectangle), which then leads to an exit point marked with an 'X'. A small note box is in the top left corner.](e5a887b3a099d85d9b170d574b0604e3_img.jpg) + +``` +graph TD; Entry(( )) --> D1{ }; D1 -- Loop1 --> P1[ ][ ]; P1 --> Entry; D1 -- Loop2 --> D2{ }; D2 -- Loop3 --> P2[ ][ ]; P2 --> Entry; D2 -- DataStore --> DS[= =]; DS --> Exit[X]; +``` + +A process flow diagram for MT\_SM\_HLR. It starts with an entry point leading to a decision diamond. The first path from the diamond leads to a process block (two rectangles), which then loops back to the entry point. The second path from the diamond leads to another decision diamond. The first path from this second diamond leads to another process block (two rectangles), which loops back to the entry point. The second path from the second diamond leads to a data store (double rectangle), which then leads to an exit point marked with an 'X'. A small note box is in the top left corner. + +4116 + +4117 + +**Figure 23.3/5 (sheet 6 of 6): Process MT\_SM\_HLR** + +procedure Perform\_Relaying + +1(1) + +Procedure in the HLR to perform the relaying of the Send Routing Info For SM message to the IP-SM-GW + +Signals to/from the left are to/from the SMS-GMSC; +Signals to/from the right are to/from the IP-SM-GW + +![Flowchart for procedure Perform_Relaying. It starts with a connector, followed by a process block with MAP_OPEN_req, MAP_SEND_ROUTING_INFO_FOR_SM_req, and MAP_DELIMITER_req. Then 'Transparent Relaying' is performed. A loop follows with two parallel paths: one with a '*' symbol and a '-' symbol, and another with a '-' symbol. A decision diamond 'Dialogue closed' follows. If 'Yes', it ends at a connector. If 'No', it goes to another 'Transparent Relaying' block.](2a8b6914e187cb2ba5e51a4d51d32a4c_img.jpg) + +``` + +graph TD + Start([ ]) --> Process["MAP_OPEN_req +MAP_SEND_ROUTING_INFO_FOR_SM_req +MAP_DELIMITER_req"] + Process --> TR1([Transparent Relaying]) + TR1 --> LoopStart(( )) + LoopStart --> LeftPath["* +-"] + LoopStart --> RightPath["-"] + LeftPath --> LoopEnd(( )) + RightPath --> LoopEnd + LoopEnd --> Decision{Dialogue closed} + Decision -- Yes --> End([X]) + Decision -- No --> TR2([Transparent Relaying]) + +``` + +Flowchart for procedure Perform\_Relaying. It starts with a connector, followed by a process block with MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_req, and MAP\_DELIMITER\_req. Then 'Transparent Relaying' is performed. A loop follows with two parallel paths: one with a '\*' symbol and a '-' symbol, and another with a '-' symbol. A decision diamond 'Dialogue closed' follows. If 'Yes', it ends at a connector. If 'No', it goes to another 'Transparent Relaying' block. + +4118 + +4119 + +Figure 23.3/5a (sheet 1 of 1): Procedure Perform\_Relaying + +# Process MT\_SM\_VMSC + +MT\_SM\_VMSC1(4) + +The mobile terminated short message service process in the VMSC + +Signals to/from the left are to/from the SMS-GMSC + +![Flowchart for Process MT_SM_VMSC. It starts with an entry point leading to a 'Null' state, then 'Receive_Open_Ind'. From there, it branches based on 'Vr', 'OK', and 'Error' signals. The 'OK' path leads to 'Destination Reference received' decision. If 'No', it goes to 'Null'. If 'Yes', it goes to 'Store Destination Reference'. Both paths lead to 'TCAP Handshake required' decision. If 'No', it goes to 'Wait_For_Service_Primitive' and then 'MAP_DELIMITER_ind'. If 'Yes', it goes to 'Wait_For_DELIMITER'. From 'Wait_For_DELIMITER', it branches into multiple paths: 'MAP_DELIMITER_ind' (leading to 'MAP_DELIMITER_req' and 'Wait_For_Service_Primitive'), 'MAP_MT_FORW_SM_ind' (leading to 'Set Error System Failure' and 'MAP_MT_FORW_SM_rsp'), 'MAP_DELIMITER_ind' (leading to 'MAP_DELIMITER_req' and 'Wait_For_Service_Primitive'), a path leading to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and 'Null'). From the 'Wait_For_Service_Primitive' state in the middle path, it branches into 'MAP_DELIMITER_ind' (leading to 'MAP_DELIMITER_req' and 'Null'), a path leading to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and 'Null').](5ee8f90537f5f1092504f72bfc7c29f3_img.jpg) + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- Vr --> Perform_MAP_Vr_Dialogue[Perform MAP Vr Dialogue] + Perform_MAP_Vr_Dialogue --> Null2([Null]) + Receive_Open_Ind -- OK --> Destination_Reference_received{Destination Reference received} + Destination_Reference_received -- No --> Null3([Null]) + Destination_Reference_received -- Yes --> Store_Destination_Reference[Store Destination Reference] + Store_Destination_Reference --> TCAP_Handshake_required{TCAP Handshake required} + TCAP_Handshake_required -- No --> Wait_For_Service_Primitive1[Wait_For_Service_Primitive] + Wait_For_Service_Primitive1 --> MAP_DELIMITER_ind1[MAP_DELIMITER_ind] + MAP_DELIMITER_ind1 --> MAP_DELIMITER_req1[MAP_DELIMITER_req] + MAP_DELIMITER_req1 --> Wait_For_Service_Primitive2[Wait_For_Service_Primitive] + TCAP_Handshake_required -- Yes --> Wait_For_DELIMITER[Wait_For_DELIMITER] + Wait_For_DELIMITER --> MAP_DELIMITER_ind2[MAP_DELIMITER_ind] + MAP_DELIMITER_ind2 --> MAP_DELIMITER_req2[MAP_DELIMITER_req] + MAP_DELIMITER_req2 --> Wait_For_Service_Primitive3[Wait_For_Service_Primitive] + Wait_For_DELIMITER --> MAP_MT_FORW_SM_ind[MAP_MT_FORW_SM_ind] + MAP_MT_FORW_SM_ind --> Set_Error_System_Failure[Set Error System Failure] + Set_Error_System_Failure --> MAP_MT_FORW_SM_rsp[MAP_MT_FORW_SM_rsp] + MAP_MT_FORW_SM_rsp --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Null4([Null]) + Wait_For_DELIMITER --> MAP_DELIMITER_ind3[MAP_DELIMITER_ind] + MAP_DELIMITER_ind3 --> MAP_DELIMITER_req3[MAP_DELIMITER_req] + MAP_DELIMITER_req3 --> Wait_For_Service_Primitive4[Wait_For_Service_Primitive] + Wait_For_DELIMITER --> MAP_NOTICE_ind1[MAP_NOTICE_ind] + MAP_NOTICE_ind1 --> MAP_CLOSE_req3[MAP_CLOSE_req] + MAP_CLOSE_req3 --> Null5([Null]) + Wait_For_DELIMITER --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Wait_For_DELIMITER --> MAP_NOTICE_ind2[MAP_NOTICE_ind] + MAP_NOTICE_ind2 --> MAP_CLOSE_req4[MAP_CLOSE_req] + MAP_CLOSE_req4 --> Null6([Null]) + Wait_For_Service_Primitive4 --> MAP_DELIMITER_ind4[MAP_DELIMITER_ind] + MAP_DELIMITER_ind4 --> MAP_DELIMITER_req4[MAP_DELIMITER_req] + MAP_DELIMITER_req4 --> Null7([Null]) + Wait_For_Service_Primitive4 --> MAP_U_ABORT_ind2[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Wait_For_Service_Primitive4 --> MAP_NOTICE_ind3[MAP_NOTICE_ind] + MAP_NOTICE_ind3 --> MAP_CLOSE_req5[MAP_CLOSE_req] + MAP_CLOSE_req5 --> Null8([Null]) + +``` + +Flowchart for Process MT\_SM\_VMSC. It starts with an entry point leading to a 'Null' state, then 'Receive\_Open\_Ind'. From there, it branches based on 'Vr', 'OK', and 'Error' signals. The 'OK' path leads to 'Destination Reference received' decision. If 'No', it goes to 'Null'. If 'Yes', it goes to 'Store Destination Reference'. Both paths lead to 'TCAP Handshake required' decision. If 'No', it goes to 'Wait\_For\_Service\_Primitive' and then 'MAP\_DELIMITER\_ind'. If 'Yes', it goes to 'Wait\_For\_DELIMITER'. From 'Wait\_For\_DELIMITER', it branches into multiple paths: 'MAP\_DELIMITER\_ind' (leading to 'MAP\_DELIMITER\_req' and 'Wait\_For\_Service\_Primitive'), 'MAP\_MT\_FORW\_SM\_ind' (leading to 'Set Error System Failure' and 'MAP\_MT\_FORW\_SM\_rsp'), 'MAP\_DELIMITER\_ind' (leading to 'MAP\_DELIMITER\_req' and 'Wait\_For\_Service\_Primitive'), a path leading to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and 'Null'). From the 'Wait\_For\_Service\_Primitive' state in the middle path, it branches into 'MAP\_DELIMITER\_ind' (leading to 'MAP\_DELIMITER\_req' and 'Null'), a path leading to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and 'Null'). + +4120 + +4121 + +Figure 23.3/6 (sheet 1 of 4): Procedure MT\_SM\_VMSC + +![Flowchart for Process MT_SM_VMSC. It starts with 'Wait_For_Service_Primitive', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind', 'Check_Indication' (referencing Figure 25.2/1), and 'MT_SM_Transfer_MSC' (referencing Figure 23.3/4). From there, it branches based on 'CAMEL Handling' (True/False) and 'More messages to send?' (Yes/No).](0d0294701ebee83eb3e046fc9a4dc18e_img.jpg) + +### Process MT\_SM\_VMSC MT\_SM\_VMSC2(4) + +The mobile terminated short message service process in the VMSC + +Signals to/from the left are to/from the SMS-GMSC + +``` + +graph TD + Start([Wait_For_Service_Primitive]) --> In1{{ }} + In1 -- "MAP_MT_FORWARD_SHORT_MESSAGE_ind" --> Check[Check_Indication] + Check -.-> F2521[Figure 25.2/1] + Check -- OK --> MTSM[MT_SM_Transfer_MSC] + MTSM -.-> F2334[Figure 23.3/4] + MTSM -- Error --> Release[Release SMS] + MTSM -- OK --> CH1{CAMEL Handling} + CH1 -- True --> Delivered[CAMEL_T_SMS_DELIVERED] + Delivered -.-> TS23078_1[See TS 23.078] + CH1 -- False --> MoreMsg{More messages to send?} + CH1 -- Abort --> CH2{CAMEL Handling} + CH2 -- True --> Failure1[CAMEL_T_SMS_FAILURE] + Failure1 -.-> TS23078_2[See TS 23.078] + CH2 -- False --> MoreMsg + CH2 -- Error --> Release + Failure1 --> Null1([Null]) + MoreMsg -- Yes --> Out1{{ }} + Out1 -- "MAP_MT_FORWARD_SHORT_MESSAGE_rsp +MAP_DELIMITER_req" --> WaitMore[Wait_For_More_Messages] + MoreMsg -- No --> Join(( )) + CH3{CAMEL Handling} -- True --> Failure2[CAMEL_T_SMS_FAILURE] + Failure2 -.-> TS23078_3[See TS 23.078] + CH3 -- False --> Release + Failure2 --> Null2([Null]) + Join --> Out2{{ }} + Out2 -- "MAP_MT_FORWARD_SHORT_MESSAGE_rsp +MAP_CLOSE_req" --> Null2 + +``` + +Flowchart for Process MT\_SM\_VMSC. It starts with 'Wait\_For\_Service\_Primitive', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind', 'Check\_Indication' (referencing Figure 25.2/1), and 'MT\_SM\_Transfer\_MSC' (referencing Figure 23.3/4). From there, it branches based on 'CAMEL Handling' (True/False) and 'More messages to send?' (Yes/No). + +4122 + +4123 + +Figure 23.3/6 (sheet 2 of 4): Procedure MT\_SM\_VMSC + +Process MT\_SM\_VMSC + +MT\_SM\_VMSC3(4) + +The mobile terminated short message service process in the VMSC + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + +![Flowchart for Process MT_SM_VMSC showing the logic for mobile terminated short message service in the VMSC. It starts with 'Wait_For_More_Messages', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind', 'Check_Indication', and various decision points for CAMEL handling and message delivery status.](2541521b5520088e72e6e6252691cd13_img.jpg) + +``` + +graph TD + Start([Wait_For_More_Messages]) --> In1{{ }} + In1 --> In1 + In1 --> MAP_ind[MAP_MT_FORWARD_SHORT_MESSAGE_ind] + MAP_ind --> Check[Check_Indication] + Check --> OK{OK} + OK -- True --> CAMEL_Handling_1{CAMEL Handling} + OK -- False --> CAMEL_Handling_1 + CAMEL_Handling_1 -- True --> CAMEL_T_SMS_INIT[CAMEL_T_SMS_INIT] + CAMEL_T_SMS_INIT -.-> TS_23_078_1[See TS 23.078] + CAMEL_T_SMS_INIT --> Result{Result?} + Result -- Release_SMS --> Set_Error[Set Error according to gsmSCF instructions] + Set_Error --> Error[Error] + Result -- Continue --> A_RP_MT_DATA_req[A_RP_MT_DATA_req] + A_RP_MT_DATA_req --> Wait_Subsequent[Wait_For_Subsequent_A_SM_CONFIRM] + Wait_Subsequent --> A_RP_ERROR_ind{{A_RP_ERROR_ind}} + Wait_Subsequent --> A_RP_ACK_ind{{A_RP_ACK_ind}} + A_RP_ERROR_ind --> Set_User_Error[Set User Error] + Set_User_Error --> CAMEL_Handling_2{CAMEL Handling} + CAMEL_Handling_2 -- True --> CAMEL_T_SMS_FAILURE[CAMEL_T_SMS_FAILURE] + CAMEL_T_SMS_FAILURE -.-> TS_23_078_2[See TS 23.078] + CAMEL_Handling_2 -- False --> Error + A_RP_ACK_ind --> CAMEL_Handling_3{CAMEL Handling} + CAMEL_Handling_3 -- True --> CAMEL_T_SMS_DELIVERED[CAMEL_T_SMS_DELIVERED] + CAMEL_T_SMS_DELIVERED -.-> TS_23_078_3[See TS 23.078] + CAMEL_Handling_3 -- False --> More_Messages{More messages to send?} + More_Messages -- No --> Error + More_Messages -- Yes --> Out1{{ }} + Out1 --> Out1 + Out1 --> MAP_rsp[MAP_MT_FORWARD_SHORT_MESSAGE_rsp] + MAP_rsp --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Null([Null]) + Out1 --> MAP_DELIMITER_req[MAP_DELIMITER_req] + MAP_DELIMITER_req --> Wait_For_More_Messages_2([Wait_For_More_Messages]) + +``` + +Flowchart for Process MT\_SM\_VMSC showing the logic for mobile terminated short message service in the VMSC. It starts with 'Wait\_For\_More\_Messages', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind', 'Check\_Indication', and various decision points for CAMEL handling and message delivery status. + +4124 + +4125 + +Figure 23.3/6 (sheet 3 of 4): Procedure MT\_SM\_VMSC + +![Sequence diagram for Process MT_SM_VMSC. The diagram is split into two main sections. The top section starts with 'Wait_For_More_Messages' and shows a loop for handling multiple messages, ending at 'Null'. The bottom section starts with 'Wait_For_Subsequent_A_SM_CONFIRM' and shows a loop for subsequent confirmations, which can lead to 'CAMEL_T_SMS_FAILURE' (referencing TS 23.078) or 'Null'. Various MAP and A messages are exchanged between the VMSC and the SMS-GMSC (left) and the MS (right).](ec3bfe8b7736481dc1218d736a699e89_img.jpg) + +### Process MT\_SM\_VMSC + +### MT\_SM\_VMSC4(4) + +The mobile terminated short message service process in the VMSC + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + +``` + +sequenceDiagram + participant VMSC + participant SMS-GMSC as SMS-GMSC + participant MS as MS + + Note left of VMSC: The mobile terminated short message service process in the VMSC + Note right of VMSC: Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + + Note over VMSC: Wait_For_More_Messages + VMSC->>SMS-GMSC: MAP_U_ABORT_ind / MAP_P_ABORT_ind + VMSC->>MS: MAP_NOTICE_ind + VMSC->>MS: MAP_CLOSE_req + VMSC->>MS: A_ABORT_req + VMSC->>SMS-GMSC: A_ABORT_req + VMSC->>MS: A_MM_RELEASE + VMSC->>MS: MAP_U_ABORT_req + Note over VMSC: Null + + Note over VMSC: Wait_For_Subsequent_A_SM_CONFIRM + VMSC->>SMS-GMSC: MAP_U_ABORT_ind / MAP_P_ABORT_ind + VMSC->>MS: MAP_NOTICE_ind + VMSC->>MS: MAP_CLOSE_req + VMSC->>MS: A_ABORT_req + VMSC->>SMS-GMSC: A_ABORT_req + VMSC->>MS: A_MM_RELEASE + VMSC->>MS: MAP_U_ABORT_req + Note over VMSC: CAMEL-Handling + Note right of VMSC: See TS 23.078 + Note over VMSC: CAMEL_T_SMS_FAILURE + Note over VMSC: Null + +``` + +Sequence diagram for Process MT\_SM\_VMSC. The diagram is split into two main sections. The top section starts with 'Wait\_For\_More\_Messages' and shows a loop for handling multiple messages, ending at 'Null'. The bottom section starts with 'Wait\_For\_Subsequent\_A\_SM\_CONFIRM' and shows a loop for subsequent confirmations, which can lead to 'CAMEL\_T\_SMS\_FAILURE' (referencing TS 23.078) or 'Null'. Various MAP and A messages are exchanged between the VMSC and the SMS-GMSC (left) and the MS (right). + +4126 + +4127 + +Figure 23.3/6 (sheet 4 of 4): Procedure MT\_SM\_VMSC + +Macrodefinition MT\_SM\_Transfer\_MSC + +MT\_SM\_Xfer\_MSC1(4) + +The mobile terminated short message transfer macro in the MSC + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +![State transition diagram for MT_SM_Transfer_MSC macro. The process starts with a check if the MSC supports MT SMS. If 'No', it sets a user error 'Facility Not Supported' and ends in an 'Error' state. If 'Yes', it checks subscriber identity for MT SMS. If 'OK', it sends MAP requests (OPEN_req, SEND_INFO_FOR_MT_SMS_req, DELIMITER_req) and receives a confirmation. If 'Vr, Error', it sets a user error 'System Failure' and ends in an 'Error' state. It then checks if CAMEL handling is false. If so, it waits for a page. The diagram then branches into three parallel paths: 'Page_MSC' (leading to Figure 25.3/1), 'Search_for_MS_MSC' (leading to Figure 25.3/2), and 'MAP_SEND_INFO_FOR_MT_SMS_cnf'. All three paths lead to a decision 'MS supports SMS?'. If 'No', it sets a user error 'SM Delivery Failure' with cause 'Equipment not SM equipped', sends MAP_U_ABORT_req and A_ABORT_req, and ends in an 'Error' state. If 'Yes', it proceeds to 'Process_Access_Request_MSC' (leading to Figure 25.4/1). From there, if 'Error', it sets a user error 'System Failure' and ends in an 'Error' state. If 'OK', it waits for a VLR response.](6678caa2abcfcdb18b5a35654250f4c4_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Start + Start --> MSC_Supports_MT_SMS{MSC supports MT SMS?} + MSC_Supports_MT_SMS -- No --> Set_User_Error_1[Set User Error: Facility Not Supported] + Set_User_Error_1 --> Error_1((Error)) + MSC_Supports_MT_SMS -- Yes --> Check_Subscr[Check_Subscr_Identity_for_MT_SMS] + Check_Subscr -- OK --> MAP_Requests[MAP_OPEN_req, MAP_SEND_INFO_FOR_MT_SMS_req, MAP_DELIMITER_req] + MAP_Requests --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- OK --> CAMEL_Handling[CAMEL Handling:= False] + Receive_Open_Cnf -- Vr, Error --> Set_User_Error_2[Set User Error: System Failure] + Set_User_Error_2 --> Error_2((Error)) + CAMEL_Handling --> Wait_For_Page[Wait_For_Page] + Wait_For_Page --> Page_MSC[Page_MSC] + Wait_For_Page --> Search_for_MS_MSC[Search_for_MS_MSC] + Wait_For_Page --> MAP_SEND_INFO_FOR_MT_SMS_cnf[MAP_SEND_INFO_FOR_MT_SMS_cnf] + Page_MSC -- Null --> Set_User_Error_3[Set User Error: System Failure] + Set_User_Error_3 --> Error_3((Error)) + Page_MSC -- Error --> Wait_For_VLR_Response_1[Wait_For_VLR_Response] + Page_MSC -- OK --> MS_Supports_SMS{MS supports SMS?} + Search_for_MS_MSC -- Null --> Set_User_Error_4[Set User Error: System Failure] + Set_User_Error_4 --> Error_4((Error)) + Search_for_MS_MSC -- Error --> Wait_For_VLR_Response_2[Wait_For_VLR_Response] + Search_for_MS_MSC -- OK --> MS_Supports_SMS + MAP_SEND_INFO_FOR_MT_SMS_cnf --> Set_User_Error_5[Set User Error] + Set_User_Error_5 --> Error_5((Error)) + MS_Supports_SMS -- No --> Set_User_Error_6[Set User Error: SM Delivery Failure] + Set_User_Error_6 --> Delivery_Failure_Cause[Delivery failure cause:= Equipment not SM equipped] + Delivery_Failure_Cause --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> A_ABORT_req[A_ABORT_req] + A_ABORT_req --> Error_6((Error)) + MS_Supports_SMS -- Yes --> Process_Access_Request_MSC[Process_Access_Request_MSC] + Process_Access_Request_MSC -- Error --> Set_User_Error_7[Set User Error: System Failure] + Set_User_Error_7 --> Error_7((Error)) + Process_Access_Request_MSC -- OK --> Wait_For_VLR_Response_3[Wait_For_VLR_Response] + +``` + +State transition diagram for MT\_SM\_Transfer\_MSC macro. The process starts with a check if the MSC supports MT SMS. If 'No', it sets a user error 'Facility Not Supported' and ends in an 'Error' state. If 'Yes', it checks subscriber identity for MT SMS. If 'OK', it sends MAP requests (OPEN\_req, SEND\_INFO\_FOR\_MT\_SMS\_req, DELIMITER\_req) and receives a confirmation. If 'Vr, Error', it sets a user error 'System Failure' and ends in an 'Error' state. It then checks if CAMEL handling is false. If so, it waits for a page. The diagram then branches into three parallel paths: 'Page\_MSC' (leading to Figure 25.3/1), 'Search\_for\_MS\_MSC' (leading to Figure 25.3/2), and 'MAP\_SEND\_INFO\_FOR\_MT\_SMS\_cnf'. All three paths lead to a decision 'MS supports SMS?'. If 'No', it sets a user error 'SM Delivery Failure' with cause 'Equipment not SM equipped', sends MAP\_U\_ABORT\_req and A\_ABORT\_req, and ends in an 'Error' state. If 'Yes', it proceeds to 'Process\_Access\_Request\_MSC' (leading to Figure 25.4/1). From there, if 'Error', it sets a user error 'System Failure' and ends in an 'Error' state. If 'OK', it waits for a VLR response. + +4128 + +4129 + +Figure 23.3/7 (sheet 1 of 4): Macro MT\_SM\_Transfer\_MSC + +![SDL Macro diagram for MT_SM_Transfer_MSC. It shows the logic flow from Wait_For_Page, handling CAMEL initialization, and branching based on the result to either abort or request info for MT SMS.](44f36a2e7dd76edc5279dfac49e85199_img.jpg) + +## Macrodefinition MT\_SM\_Transfer\_MSC MT\_SM\_Xfer\_MSC2(4) + +The mobile terminated short message transfer macro in the MSC + +Signals to/from the right are to/from the VLR + +``` + + graph TD + Start([Wait_For_Page]) --> Input[/MAP_CONTINUE_CAMEL_SMS_HANDLING_ind/] + Input --> Task1[CAMEL Handling:= True] + Task1 --> Proc1[[CAMEL_T_SMS_INIT]] + Proc1 --- Note1[See TS 23.078] + Proc1 --> Dec1{Result?} + + Dec1 -- Release_SMS --> Out1[/MAP_U_ABORT_req/] + Out1 --> End1([Release SMS]) + + Dec1 -- Continue --> Task2[Set Suppress MT-SMS-CSI] + Task2 --> Out2[/MAP_SEND_INFO_FOR_MT_SMS_req/] + Out2 --> End2([Wait_For_Page]) + +``` + +SDL Macro diagram for MT\_SM\_Transfer\_MSC. It shows the logic flow from Wait\_For\_Page, handling CAMEL initialization, and branching based on the result to either abort or request info for MT SMS. + +4130 + +4131 + +**Figure 23.3/7 (sheet 2 of 4): Macro MT\_SM\_Transfer\_MSC** + +# Macrodefinition MT\_SM\_Transfer\_MSC + +MT\_SM\_Xfer\_MSC3(4) + +The mobile terminated short message transfer macro in the MSC + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +Figure 25.9/1 + +![Flowchart for Macro MT_SM_Transfer_MSC. The process starts with 'Wait_For_VLR_Response', followed by 'Trace_Subscriber_Activity_MSC' and 'MAP_SEND_INFO_FOR_MT_SMS_cnf'. It then enters another 'Wait_For_VLR_Response' loop. A decision 'A_RP_MT_DATA_req' follows, with 'OK' leading to 'Wait_For_First_A_SM_CONFIRM' and then 'A_RP_ACK_ind' (OK), and 'Provider Error, Data Error' or 'User Error' leading to 'Set User Error' (Error). A 'Check_Confirmation' block also leads to 'Set User Error' (Error) for 'User Error' cases, with a note that for absent subscribers, the error includes a diagnostic indication.](8e2e5961af70ba6bc28c2e895f3f98ca_img.jpg) + +``` + +graph TD + Start([Wait_For_VLR_Response]) --> Trace[Trace_Subscriber_Activity_MSC] + Trace --> MAP[MAP_SEND_INFO_FOR_MT_SMS_cnf] + Trace --> Wait2([Wait_For_VLR_Response]) + Wait2 --> Decision{A_RP_MT_DATA_req} + Decision -- OK --> Wait3([Wait_For_First_A_SM_CONFIRM]) + Decision -- "Provider Error, Data Error" --> SetError1[Set User Error: System Failure] + SetError1 --> Error1((Error)) + Decision -- User Error --> SetError2[Set User Error] + SetError2 --> Error2((Error)) + Check[Check_Confirmation] -- User Error --> SetError3[Set User Error] + SetError3 --> Error3((Error)) + Note1[For Absent Subscriber, User Error includes diagnostic indication] -.-> SetError3 + Wait3 --> ACK{A_RP_ACK_ind} + ACK --> OK1((OK)) + Wait3 --> ERROR{A_RP_ERROR_ind} + ERROR --> SetError4[Set User Error] + SetError4 --> Error4((Error)) + +``` + +Flowchart for Macro MT\_SM\_Transfer\_MSC. The process starts with 'Wait\_For\_VLR\_Response', followed by 'Trace\_Subscriber\_Activity\_MSC' and 'MAP\_SEND\_INFO\_FOR\_MT\_SMS\_cnf'. It then enters another 'Wait\_For\_VLR\_Response' loop. A decision 'A\_RP\_MT\_DATA\_req' follows, with 'OK' leading to 'Wait\_For\_First\_A\_SM\_CONFIRM' and then 'A\_RP\_ACK\_ind' (OK), and 'Provider Error, Data Error' or 'User Error' leading to 'Set User Error' (Error). A 'Check\_Confirmation' block also leads to 'Set User Error' (Error) for 'User Error' cases, with a note that for absent subscribers, the error includes a diagnostic indication. + +4132 + +4133 + +Figure 23.3/7 (sheet 3 of 4): Macro MT\_SM\_Transfer\_MSC + +Macrodefinition MT\_SM\_Transfer\_MSC + +MT\_SM\_Xfer\_MSC4(4) + +The mobile terminated short message transfer macro in the MSC + +In the upper subtree: +Signals to/from the left are to/from the MS; +signals to/from the right are to/from the VLR + +![Sequence diagram for the upper subtree of MT_SM_Transfer_MSC. It starts with a state box containing 'Wait_For_Page, Wait_For_VLR_Response, Wait_For_First_A_SM_CONFIRM'. A horizontal line leads to a decision point. The left path consists of 'A_MM_RELEASE_ind' (diamond), 'MAP_U_ABORT_req' (arrow), and 'Set User Error: System Failure' (rectangle), ending at an 'Error' circle. The right path consists of a diamond leading to 'MAP_U_ABORT_ind, MAP_CLOSE_ind' (rectangle), then 'A_ABORT_Req' (diamond), and finally merging into the 'Set User Error' path.](e822e328d38fd41da4a4aa84c6d60725_img.jpg) + +Sequence diagram for the upper subtree of MT\_SM\_Transfer\_MSC. It starts with a state box containing 'Wait\_For\_Page, Wait\_For\_VLR\_Response, Wait\_For\_First\_A\_SM\_CONFIRM'. A horizontal line leads to a decision point. The left path consists of 'A\_MM\_RELEASE\_ind' (diamond), 'MAP\_U\_ABORT\_req' (arrow), and 'Set User Error: System Failure' (rectangle), ending at an 'Error' circle. The right path consists of a diamond leading to 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' (rectangle), then 'A\_ABORT\_Req' (diamond), and finally merging into the 'Set User Error' path. + +In the lower subtree: +Signals to/from the left are to/from the MS; +signals to/from the right are to/from the SMS-GMSC unless marked otherwise + +![Sequence diagram for the lower subtree of MT_SM_Transfer_MSC. It starts with a state box containing 'Wait_For_Page, Wait_For_VLR_Response, Wait_For_First_A_SM_CONFIRM'. A horizontal line leads to a decision point. The left path consists of 'MAP_NOTICE_ind' (diamond), 'MAP_CLOSE_req' (arrow), and 'MAP_U_ABORT_Req' (arrow) which points to a 'To VLR' box. The right path consists of a diamond leading to 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (rectangle), then 'A_ABORT_Req' (diamond), and finally merging into the 'MAP_U_ABORT_Req' path. Both paths end at an 'Abort' circle.](1aa4931f90dcf4d8d632d1ac4533bf16_img.jpg) + +Sequence diagram for the lower subtree of MT\_SM\_Transfer\_MSC. It starts with a state box containing 'Wait\_For\_Page, Wait\_For\_VLR\_Response, Wait\_For\_First\_A\_SM\_CONFIRM'. A horizontal line leads to a decision point. The left path consists of 'MAP\_NOTICE\_ind' (diamond), 'MAP\_CLOSE\_req' (arrow), and 'MAP\_U\_ABORT\_Req' (arrow) which points to a 'To VLR' box. The right path consists of a diamond leading to 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (rectangle), then 'A\_ABORT\_Req' (diamond), and finally merging into the 'MAP\_U\_ABORT\_Req' path. Both paths end at an 'Abort' circle. + +4134 + +4135 + +Figure 23.3/7 (sheet 4 of 4): Macro MT\_SM\_Transfer\_MSC + +macrodefinition Check\_Subscr\_Identity\_for\_MT\_SMS + +CSIFMTSMS1(1) + +Macro to check the identity of a subscriber for MT SMS; invoked in the VMSC and the SGSN + +![Flowchart for macrodefinition Check_Subscr_Identity_for_MT_SMS. It starts with an oval connector, leading to a decision diamond 'Destination reference present?'. If 'No', it goes to another decision diamond 'SM_RP_DA= IMSI?'. If 'Yes', it sets 'Destination reference:= Not included' and then 'SM_RP_DA:= IMSI' to reach an 'OK' terminal. If 'No', it goes to a 'Set User Error: Unexpected data value' block to reach an 'Error' terminal. If 'Yes' from the first diamond, it goes to a decision diamond 'SM_RP_DA= LMSI?'. If 'Yes', it sets 'Destination reference:= IMSI' and then 'SM_RP_DA:= LMSI' to reach an 'OK' terminal. If 'No', it joins the path before the 'Set User Error' block.](f6c91eee4c272a5313689832a5622706_img.jpg) + +``` + +graph TD + Start([ ]) --> D1{Destination reference present?} + D1 -- No --> D2{SM_RP_DA= IMSI?} + D1 -- Yes --> D3{SM_RP_DA= LMSI?} + D2 -- Yes --> P1[Destination reference:= Not included] + P1 --> P2[SM_RP_DA:= IMSI] + P2 --> OK1([OK]) + D2 -- No --> J(( )) + D3 -- Yes --> P3[Destination reference:= IMSI] + P3 --> P4[SM_RP_DA:= LMSI] + P4 --> OK2([OK]) + D3 -- No --> J + J --> E[Set User Error: Unexpected data value] + E --> Error([Error]) + +``` + +Flowchart for macrodefinition Check\_Subscr\_Identity\_for\_MT\_SMS. It starts with an oval connector, leading to a decision diamond 'Destination reference present?'. If 'No', it goes to another decision diamond 'SM\_RP\_DA= IMSI?'. If 'Yes', it sets 'Destination reference:= Not included' and then 'SM\_RP\_DA:= IMSI' to reach an 'OK' terminal. If 'No', it goes to a 'Set User Error: Unexpected data value' block to reach an 'Error' terminal. If 'Yes' from the first diamond, it goes to a decision diamond 'SM\_RP\_DA= LMSI?'. If 'Yes', it sets 'Destination reference:= IMSI' and then 'SM\_RP\_DA:= LMSI' to reach an 'OK' terminal. If 'No', it joins the path before the 'Set User Error' block. + +4136 + +4137 + +Figure 23.3/8: Macro Check\_Subscr\_Identity\_For\_MT\_SMS + +![Flowchart for process MT_SM_VLR. It starts with an initial state, followed by a 'Null' state, then 'Receive Open_Ind'. From 'Receive Open_Ind', an 'OK' path leads to 'Wait_For_Service_Primitive' and a 'Vr, Error' path leads to 'Null'. From 'Wait_For_Service_Primitive', the flow goes to a merge point for 'MAP_SEND_INFO_FOR_MT_SMS_ind'. From this merge point, it goes to 'Check_Indication'. From 'Check_Indication', an 'OK' path leads to a decision 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to another decision 'Confirmed by HLR?'. If 'No', it goes to the same 'Set User Error' block. If 'Yes', it leads to connector '1'. Both 'Set User Error' and an 'Error' path from 'Check_Indication' lead to a merge point for 'MAP_SEND_INFO_FOR_MT_SMS_rsp' and 'MAP_CLOSE_req', which then leads to a 'Null' state.](f5657d08a46856dfb878f4ed80220a7f_img.jpg) + +**process MT\_SM\_VLR** **MT\_SM\_VLR1(3)** + +Process in the VLR to handle a request for information to handle MT short message delivery + +Signals to/from the left are to/from the MSC + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpen[Receive Open_Ind] + RecOpen -- OK --> WaitFor[Wait_For_Service_Primitive] + RecOpen -- "Vr, Error" --> Null2([Null]) + WaitFor --> Merge1{ } + Merge1 -- "MAP_SEND_INFO_FOR_MT_SMS_ind" --> CheckInd[Check_Indication] + CheckInd -- OK --> SubKnown{Subscriber known?} + CheckInd -- Error --> Merge2{ } + SubKnown -- No --> SetError[Set User Error: Unidentified subscriber] + SubKnown -- Yes --> Confirmed{Confirmed by HLR?} + Confirmed -- No --> SetError + Confirmed -- Yes --> Connector1((1)) + SetError --> Merge2 + Merge2 -- "MAP_SEND_INFO_FOR_MT_SMS_rsp +MAP_CLOSE_req" --> Null3([Null]) + +``` + +Flowchart for process MT\_SM\_VLR. It starts with an initial state, followed by a 'Null' state, then 'Receive Open\_Ind'. From 'Receive Open\_Ind', an 'OK' path leads to 'Wait\_For\_Service\_Primitive' and a 'Vr, Error' path leads to 'Null'. From 'Wait\_For\_Service\_Primitive', the flow goes to a merge point for 'MAP\_SEND\_INFO\_FOR\_MT\_SMS\_ind'. From this merge point, it goes to 'Check\_Indication'. From 'Check\_Indication', an 'OK' path leads to a decision 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified subscriber'. If 'Yes', it goes to another decision 'Confirmed by HLR?'. If 'No', it goes to the same 'Set User Error' block. If 'Yes', it leads to connector '1'. Both 'Set User Error' and an 'Error' path from 'Check\_Indication' lead to a merge point for 'MAP\_SEND\_INFO\_FOR\_MT\_SMS\_rsp' and 'MAP\_CLOSE\_req', which then leads to a 'Null' state. + +4138 + +4139 + +**Figure 23.3/9 (sheet 1 of 3): Process MT\_SM\_VLR** + +![Flowchart for process MT_SM_VLR. It starts at connector '1', checks if IMSI is detached or if roaming is allowed. If either is 'Yes', it sets a user error, sets an MNRF, sends MAP signals, and ends at 'Null'. If both are 'No', it calls CAMEL_MT_SMS_VLR. If that fails, it ends at 'Null'. If it passes, it checks if LAI is known. If 'No', it sends MAP_SEARCH_FOR_MS_req and MAP_DELIMITER_req, then waits for an access request. If 'Yes', it checks if confirmed by radio contact. If 'No', it sends MAP_SEARCH_FOR_MS_req and MAP_DELIMITER_req, then waits. If 'Yes', it sends MAP_PAGE_req and MAP_DELIMITER_req, then waits.](4e78e866a4fb9c5b16c9c479230964f5_img.jpg) + +**process MT\_SM\_VLR** **MT\_SM\_VLR2(3)** + +Process in the VLR to handle a request for information to handle MT short message delivery + +Signals to/from the left are to/from the MSC + +``` + + graph TD + 1((1)) --> IMSI{IMSI detached?} + IMSI -- Yes --> Error[Set User Error: Absent subscriber] + IMSI -- No --> Roam{Roaming in LA allowed?} + Roam -- No --> Error + Roam -- Yes --> CAMEL[|| CAMEL_MT_SMS_VLR ||] + CAMEL -.-> See3GPP[See 3GPP TS 23.078] + CAMEL --> Result{Result?} + Result -- Fail --> Null1([Null]) + Result -- Pass --> LAI{LAI known?} + LAI -- No --> SearchReq[MAP_SEARCH_FOR_MS_req +MAP_DELIMITER_req] + SearchReq --> Wait[Wait_For_Access_Request] + LAI -- Yes --> Radio{Confirmed by radio contact?} + Radio -- No --> SearchReq + Radio -- Yes --> PageReq[MAP_PAGE_req +MAP_DELIMITER_req] + PageReq --> Wait + Error --> Diag[Set diagnostic: IMSI detached] + Diag --> MNRF[Set MNRF] + MNRF --> SendInfo[MAP_SEND_INFO_FOR_MT_SMS_rsp +MAP_CLOSE_req] + SendInfo --> Null2([Null]) + +``` + +Flowchart for process MT\_SM\_VLR. It starts at connector '1', checks if IMSI is detached or if roaming is allowed. If either is 'Yes', it sets a user error, sets an MNRF, sends MAP signals, and ends at 'Null'. If both are 'No', it calls CAMEL\_MT\_SMS\_VLR. If that fails, it ends at 'Null'. If it passes, it checks if LAI is known. If 'No', it sends MAP\_SEARCH\_FOR\_MS\_req and MAP\_DELIMITER\_req, then waits for an access request. If 'Yes', it checks if confirmed by radio contact. If 'No', it sends MAP\_SEARCH\_FOR\_MS\_req and MAP\_DELIMITER\_req, then waits. If 'Yes', it sends MAP\_PAGE\_req and MAP\_DELIMITER\_req, then waits. + +4140 + +4141 + +**Figure 23.3/9 (sheet 2 of 3): Process MT\_SM\_VLR** + +![Flowchart for process MT_SM_VLR. It starts with 'Wait_For_Access_Request' and branches into four parallel paths: 1) 'Process_Access_Request_VLR' leading to 'Set subscriber data' (OK) or 'Null' (Error). 2) 'MAP_U_ABORT_ind' leading to 'Null'. 3) 'MAP_PAGE_cnf' leading to a decision 'User error= absent subscriber?'. If 'Yes', it goes to 'Ser User Error: Absent subscriber' or 'Set User Error', then 'Set MNRF'. If 'No', it goes to 'Null'. 4) 'MAP_SEARCH_FOR_MS_cnf' leading to 'Check Confirmation'. If 'OK', it goes to 'Update LAI' then 'Confirmed by Radio Contact:= Confirmed' then 'Wait_For_Access_Request'. If 'User Error', it goes to 'Set User Error' then 'Set MNRF'. If 'Provider Error, Data Error', it goes to 'Null'. All paths converge to a merge point, followed by 'MAP_SEND_INFO_FOR_MT_SMS_rsp' and 'MAP_CLOSE_req', ending at 'Null'.](a7939a752385c56d07193179102acbcb_img.jpg) + +**process MT\_SM\_VLR** **MT\_SM\_VLR3(3)** + +Process in the VLR to handle a request for information to handle MT short message delivery + +Signals to/from the left are to/from the MSC + +``` + +graph TD + Start([Wait_For_Access_Request]) --> P1[Process_Access_Request_VLR] + Start --> P2[MAP_U_ABORT_ind] + Start --> P3[MAP_PAGE_cnf] + Start --> P4[MAP_SEARCH_FOR_MS_cnf] + + P1 --> P1_Exit{ } + P1_Exit -- Error --> Null1([Null]) + P1_Exit -- OK --> SetSub[Set subscriber data] + + P2 --> Null2([Null]) + + P3 --> Decision1{User error= absent subscriber?} + Decision1 -- Yes --> SerUserErr1[Ser User Error: Absent subscriber] + Decision1 -- Yes --> SetUserErr1[Set User Error] + SerUserErr1 --> SetMNRF[Set MNRF] + SetUserErr1 --> SetMNRF + Decision1 -- No --> Null3([Null]) + + P4 --> CheckConf[Check Confirmation] + CheckConf -- OK --> UpdateLAI[Update LAI] + UpdateLAI --> Confirmed[Confirmed by Radio Contact:= Confirmed] + Confirmed --> WaitForReq2([Wait_For_Access_Request]) + + CheckConf -- User Error --> SetUserErr2[Set User Error] + SetUserErr2 --> SetMNRF + + CheckConf -- "Provider Error, Data Error" --> Null4([Null]) + + SetSub --> Merge(( )) + SetMNRF --> Merge + Null3 --> Merge + + Merge --> MAP_SEND[MAP_SEND_INFO_FOR_MT_SMS_rsp] + Merge --> MAP_CLOSE[MAP_CLOSE_req] + + MAP_SEND --> Null5([Null]) + MAP_CLOSE --> Null5 + +``` + +Flowchart for process MT\_SM\_VLR. It starts with 'Wait\_For\_Access\_Request' and branches into four parallel paths: 1) 'Process\_Access\_Request\_VLR' leading to 'Set subscriber data' (OK) or 'Null' (Error). 2) 'MAP\_U\_ABORT\_ind' leading to 'Null'. 3) 'MAP\_PAGE\_cnf' leading to a decision 'User error= absent subscriber?'. If 'Yes', it goes to 'Ser User Error: Absent subscriber' or 'Set User Error', then 'Set MNRF'. If 'No', it goes to 'Null'. 4) 'MAP\_SEARCH\_FOR\_MS\_cnf' leading to 'Check Confirmation'. If 'OK', it goes to 'Update LAI' then 'Confirmed by Radio Contact:= Confirmed' then 'Wait\_For\_Access\_Request'. If 'User Error', it goes to 'Set User Error' then 'Set MNRF'. If 'Provider Error, Data Error', it goes to 'Null'. All paths converge to a merge point, followed by 'MAP\_SEND\_INFO\_FOR\_MT\_SMS\_rsp' and 'MAP\_CLOSE\_req', ending at 'Null'. + +4142 + +4143 + +**Figure 23.3/9 (sheet 3 of 3): Process MT\_SM\_VLR** + +![Flowchart for Process MT_SM_SGSN. It starts with an entry point leading to a 'Null' state, then 'Receive_Open_Ind'. A decision 'Destination Reference received' follows. If 'OK', it goes to 'Store Destination Reference'. If 'Error', it goes to 'Null'. If 'Vr', it goes to 'Perform MAP Vr Dialogue' (with a note about GSM 09.02 or TS 29.002) then to 'Null'. From 'Store Destination Reference', a decision 'TCAP Handshake required' follows. If 'No', it goes to 'Wait_For_Service_Primitive' then to 'MAP_DELIMITER_ind' then to 'MAP_DELIMITER_req' then to 'Wait_For_Service_Primitive' then to 'Null'. If 'Yes', it goes to 'Wait_For_DELIMITER'. From 'Wait_For_DELIMITER', there are four paths: 1) 'MAP_DELIMITER_ind' -> 'MAP_DELIMITER_req' -> 'Wait_For_Service_Primitive' -> 'Null'; 2) 'MAP_MT_FORW_SW_ind' -> 'Set Error System Failure' -> 'MAP_MT_FORW_SM_rsp' -> 'MAP_CLOSE_req' -> 'Null'; 3) 'MAP_DELIMITER_ind' -> 'MAP_DELIMITER_req' -> 'Wait_For_Service_Primitive' -> (join point) -> 'Null'; 4) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Null'. A callout 'Figure 25.1/1' is near 'Receive_Open_Ind'.](3a3bf4ad529fa99ba16ada1dfc922882_img.jpg) + +### Process MT\_SM\_SGSN + +### MT\_SM\_SGSN1(4) + +The mobile terminated short message service process in the SGSN + +Signals to/from the left are to/from the SMS-GMSC + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind --> DestRef{Destination Reference received} + DestRef -- OK --> StoreRef[Store Destination Reference] + DestRef -- Error --> Null2([Null]) + DestRef -- Vr --> PerformVr[Perform MAP Vr Dialogue] + PerformVr --> Null3([Null]) + StoreRef --> TCAP{TCAP Handshake required} + TCAP -- No --> WaitFSP1[Wait_For_Service_Primitive] + WaitFSP1 --> MDI1[MAP_DELIMITER_ind] + MDI1 --> MDReq1[MAP_DELIMITER_req] + MDReq1 --> WaitFSP2[Wait_For_Service_Primitive] + WaitFSP2 --> Null4([Null]) + TCAP -- Yes --> WaitFD[Wait_For_DELIMITER] + WaitFD --> MDI2[MAP_DELIMITER_ind] + MDI2 --> MDReq2[MAP_DELIMITER_req] + MDReq2 --> WaitFSP3[Wait_For_Service_Primitive] + WaitFSP3 --> Join1(( )) + Join1 --> Null5([Null]) + WaitFD --> MTFSW[MAP_MT_FORW_SW_ind] + MTFSW --> SetError[Set Error System Failure] + SetError --> MTFSMR[MAP_MT_FORW_SM_rsp] + MTFSMR --> MCReq[MAP_CLOSE_req] + MCReq --> Null6([Null]) + WaitFD --> MDI3[MAP_DELIMITER_ind] + MDI3 --> MDReq3[MAP_DELIMITER_req] + MDReq3 --> WaitFSP4[Wait_For_Service_Primitive] + WaitFSP4 --> Join2(( )) + Join2 --> Null7([Null]) + WaitFD --> MDI4[MAP_NOTICE_ind] + MDI4 --> MCReq2[MAP_CLOSE_req] + MCReq2 --> Null8([Null]) + +``` + +Flowchart for Process MT\_SM\_SGSN. It starts with an entry point leading to a 'Null' state, then 'Receive\_Open\_Ind'. A decision 'Destination Reference received' follows. If 'OK', it goes to 'Store Destination Reference'. If 'Error', it goes to 'Null'. If 'Vr', it goes to 'Perform MAP Vr Dialogue' (with a note about GSM 09.02 or TS 29.002) then to 'Null'. From 'Store Destination Reference', a decision 'TCAP Handshake required' follows. If 'No', it goes to 'Wait\_For\_Service\_Primitive' then to 'MAP\_DELIMITER\_ind' then to 'MAP\_DELIMITER\_req' then to 'Wait\_For\_Service\_Primitive' then to 'Null'. If 'Yes', it goes to 'Wait\_For\_DELIMITER'. From 'Wait\_For\_DELIMITER', there are four paths: 1) 'MAP\_DELIMITER\_ind' -> 'MAP\_DELIMITER\_req' -> 'Wait\_For\_Service\_Primitive' -> 'Null'; 2) 'MAP\_MT\_FORW\_SW\_ind' -> 'Set Error System Failure' -> 'MAP\_MT\_FORW\_SM\_rsp' -> 'MAP\_CLOSE\_req' -> 'Null'; 3) 'MAP\_DELIMITER\_ind' -> 'MAP\_DELIMITER\_req' -> 'Wait\_For\_Service\_Primitive' -> (join point) -> 'Null'; 4) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Null'. A callout 'Figure 25.1/1' is near 'Receive\_Open\_Ind'. + +4144 + +4145 + +**Figure 23.3/10 (sheet 1 of 4): Process MT\_SM\_SGSN** + +![Flowchart for Process MT_SM_SGSN. It starts with 'Wait_For_Service_Primitive', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind'. Then 'Check_Indication' (refer to Figure 25.2/1). An 'OK' path leads to 'MT_SM_Transfer_SGSN' (refer to Figure 23.3/4). From there, three 'CAMEL Handling' decision diamonds are shown. The first 'OK' path leads to 'CAMEL_T_SMS_DELIVERED' (refer to TS 23.078). The second 'Abort' path leads to 'CAMEL_T_SMS_FAILURE' (refer to TS 23.078) and then 'Null'. The third 'Error' path leads to 'CAMEL_T_SMS_FAILURE' (refer to TS 23.078) and then 'Null'. A 'Release SMS' signal is sent from the 'Error' path. After the first 'CAMEL Handling' decision, a 'More messages to send?' decision is made. If 'Yes', it goes to 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_DELIMITER_req', then 'Wait_For_More_Messages'. If 'No', it goes to 'Null'. After the second and third 'CAMEL Handling' decisions, it goes to 'Null'. A 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req' message is sent before the final 'Null' state.](bf8329bbe3bb1ecee069cfdc92e5b386_img.jpg) + +# Process MT\_SM\_SGSN MT\_SM\_SGSN2(4) + +The mobile terminated short message service process in the SGSN + +Signals to/from the left are to/from the SMS-GMSC + +``` + +graph TD + Start([Wait_For_Service_Primitive]) --> Ind[MAP_MT_FORWARD_SHORT_MESSAGE_ind] + Ind --> Check[Check_Indication] + Check -- OK --> Transfer[MT_SM_Transfer_SGSN] + Transfer --> CH1{CAMEL Handling} + Transfer -- Error --> Release[Release SMS] + CH1 -- OK --> Delivered[CAMEL_T_SMS_DELIVERED] + CH1 -- False --> More{More messages to send?} + Delivered -- True --> TS1[See TS 23.078] + TS1 --> More + More -- Yes --> Rsp1[MAP_MT_FORWARD_SHORT_MESSAGE_rsp +MAP_DELIMITER_req] + Rsp1 --> WaitMore([Wait_For_More_Messages]) + More -- No --> Null1([Null]) + CH1 -- Abort --> CH2{CAMEL Handling} + CH2 -- True --> Failure1[CAMEL_T_SMS_FAILURE] + Failure1 -- True --> TS2[See TS 23.078] + TS2 --> Null2([Null]) + CH2 -- False --> Null1 + CH1 -- Error --> CH3{CAMEL Handling} + CH3 -- True --> Failure2[CAMEL_T_SMS_FAILURE] + Failure2 -- True --> TS3[See TS 23.078] + TS3 --> Null3([Null]) + CH3 -- False --> Null1 + Null1 --> Rsp2[MAP_MT_FORWARD_SHORT_MESSAGE_rsp +MAP_CLOSE_req] + Rsp2 --> Null4([Null]) + +``` + +Flowchart for Process MT\_SM\_SGSN. It starts with 'Wait\_For\_Service\_Primitive', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind'. Then 'Check\_Indication' (refer to Figure 25.2/1). An 'OK' path leads to 'MT\_SM\_Transfer\_SGSN' (refer to Figure 23.3/4). From there, three 'CAMEL Handling' decision diamonds are shown. The first 'OK' path leads to 'CAMEL\_T\_SMS\_DELIVERED' (refer to TS 23.078). The second 'Abort' path leads to 'CAMEL\_T\_SMS\_FAILURE' (refer to TS 23.078) and then 'Null'. The third 'Error' path leads to 'CAMEL\_T\_SMS\_FAILURE' (refer to TS 23.078) and then 'Null'. A 'Release SMS' signal is sent from the 'Error' path. After the first 'CAMEL Handling' decision, a 'More messages to send?' decision is made. If 'Yes', it goes to 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_DELIMITER\_req', then 'Wait\_For\_More\_Messages'. If 'No', it goes to 'Null'. After the second and third 'CAMEL Handling' decisions, it goes to 'Null'. A 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req' message is sent before the final 'Null' state. + +4146 + +4147 + +Figure 23.3/10 (sheet 2 of 4): Process MT\_SM\_SGSN + +![Flowchart for Process MT_SM_SGSN. It starts with 'Wait_For_More_Messages', followed by 'MAP_MT_FORWARD_SHORT_MESSAGE_ind'. Then 'Check_Indication' (refer to Figure 25.2/1). A decision 'CAMEL Handling' follows. If 'True', 'CAMEL_T_SMS_INIT' (refer to TS 23.078) is called, then 'Result?' is checked. If 'Release_SMS', 'Set Error according to gsmSCF instructions' is done. If 'Continue', 'Gb_RP_MT_DATA_req' is sent. If 'CAMEL Handling' is 'False', it goes to 'Gb_RP_MT_DATA_req'. From 'Gb_RP_MT_DATA_req', it goes to 'Wait_For_Subsequent_Gb_SM_CONFIRM'. Then 'Gb_RP_ERROR_ind' or 'Gb_RP_ACK_ind' is received. If 'Gb_RP_ERROR_ind', 'Set User Error' is done, then 'CAMEL Handling' is checked. If 'True', 'CAMEL_T_SMS_FAILURE' (refer to TS 23.078) is called. If 'False', it goes to 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req'. If 'Gb_RP_ACK_ind', 'CAMEL Handling' is checked. If 'True', 'CAMEL_T_SMS_DELIVERED' (refer to TS 23.078) is called. Then 'More messages to send?' is checked. If 'Yes', 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_DELIMITER_req' are sent, then back to 'Wait_For_More_Messages'. If 'No', it goes to 'MAP_MT_FORWARD_SHORT_MESSAGE_rsp' and 'MAP_CLOSE_req'. All paths lead to 'Null' at the bottom left.](c83534e2fbfa7d2e2ab5d5e5cc76b6aa_img.jpg) + +### Process MT\_SM\_SGSN + +### MT\_SM\_SGSN3(4) + +The mobile terminated short message service process in the SGSN + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + +``` + +graph TD + Start([Wait_For_More_Messages]) --> In1{{ }} + In1 --> In1_msg[MAP_MT_FORWARD_SHORT_MESSAGE_ind] + In1 --> Check[Check_Indication] + Check --> Check_note[Figure 25.2/1] + Check --> CH1{CAMEL Handling} + CH1 -- True --> Init[CAMEL_T_SMS_INIT] + Init --> Init_note[See TS 23.078] + Init --> Result{Result?} + Result -- Release_SMS --> SetError[Set Error according to gsmSCF instructions] + Result -- Continue --> GbReq[Gb_RP_MT_DATA_req] + CH1 -- False --> GbReq + GbReq --> WaitSub[Wait_For_Subsequent_Gb_SM_CONFIRM] + WaitSub --> In2{{ }} + In2 --> In2_msg[ ] + In2 --> GbError[Gb_RP_ERROR_ind] + In2 --> GbAck[Gb_RP_ACK_ind] + GbError --> SetUserError[Set User Error] + SetUserError --> CH2{CAMEL Handling} + CH2 -- True --> Failure[CAMEL_T_SMS_FAILURE] + Failure --> Failure_note[See TS 23.078] + CH2 -- False --> Rsp1[MAP_MT_FORWARD_SHORT_MESSAGE_rsp] + Rsp1 --> Close1[MAP_CLOSE_req] + GbAck --> CH3{CAMEL Handling} + CH3 -- True --> Delivered[CAMEL_T_SMS_DELIVERED] + Delivered --> Delivered_note[See TS 23.078] + Delivered --> MoreMsg{More messages to send?} + MoreMsg -- Yes --> Rsp2[MAP_MT_FORWARD_SHORT_MESSAGE_rsp] + Rsp2 --> Delimiter[MAP_DELIMITER_req] + Delimiter --> WaitMore([Wait_For_More_Messages]) + MoreMsg -- No --> Rsp3[MAP_MT_FORWARD_SHORT_MESSAGE_rsp] + Rsp3 --> Close2[MAP_CLOSE_req] + SetError --> Null([Null]) + Close1 --> Null + Close2 --> Null + +``` + +Flowchart for Process MT\_SM\_SGSN. It starts with 'Wait\_For\_More\_Messages', followed by 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ind'. Then 'Check\_Indication' (refer to Figure 25.2/1). A decision 'CAMEL Handling' follows. If 'True', 'CAMEL\_T\_SMS\_INIT' (refer to TS 23.078) is called, then 'Result?' is checked. If 'Release\_SMS', 'Set Error according to gsmSCF instructions' is done. If 'Continue', 'Gb\_RP\_MT\_DATA\_req' is sent. If 'CAMEL Handling' is 'False', it goes to 'Gb\_RP\_MT\_DATA\_req'. From 'Gb\_RP\_MT\_DATA\_req', it goes to 'Wait\_For\_Subsequent\_Gb\_SM\_CONFIRM'. Then 'Gb\_RP\_ERROR\_ind' or 'Gb\_RP\_ACK\_ind' is received. If 'Gb\_RP\_ERROR\_ind', 'Set User Error' is done, then 'CAMEL Handling' is checked. If 'True', 'CAMEL\_T\_SMS\_FAILURE' (refer to TS 23.078) is called. If 'False', it goes to 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req'. If 'Gb\_RP\_ACK\_ind', 'CAMEL Handling' is checked. If 'True', 'CAMEL\_T\_SMS\_DELIVERED' (refer to TS 23.078) is called. Then 'More messages to send?' is checked. If 'Yes', 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_DELIMITER\_req' are sent, then back to 'Wait\_For\_More\_Messages'. If 'No', it goes to 'MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_rsp' and 'MAP\_CLOSE\_req'. All paths lead to 'Null' at the bottom left. + +4148 + +4149 + +Figure 23.3/10 (sheet 3 of 4): Process MT\_SM\_SGSN + +Process MT\_SM\_SGSN + +MT\_SM\_SGSN4(4) + +![SDL diagram for Process MT_SM_SGSN showing state transitions from 'Wait_For_More_Messages' and 'Wait_For_Subsequent_Gb_SM_CONFIRM' to 'NULL'.](30c613511d0b3ee7d8d2f5afb4680c9e_img.jpg) + +The mobile terminated short message service process in the SGSN + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + +``` + + graph TD + %% Top Section + S1([Wait_For_More_Messages]) + S1 --> In1{ } + In1 -- MAP_U_ABORT_ind +MAP_P_ABORT_ind --> Out1[Gb_LLC_RELEASE_req] + In1 -- MAP_NOTICE_ind --> Out2[MAP_CLOSE_req] + Out2 --> Out3[Gb_LLC_RELEASE_req] + In1 -- Gb_LLC_RELEASE_ind --> Out4[MAP_U_ABORT_req] + Out1 --> N1([NULL]) + Out3 --> N1 + Out4 --> N1 + + %% Bottom Section + S2([Wait_For_Subsequent_Gb_SM_CONFIRM]) + S2 --> In2{ } + In2 -- MAP_U_ABORT_ind +MAP_P_ABORT_ind --> Out5[Gb_LLC_RELEASE_req] + In2 -- MAP_NOTICE_ind --> Out6[MAP_CLOSE_req] + Out6 --> Out7[Gb_LLC_RELEASE_req] + In2 -- Gb_LLC_RELEASE_ind --> Out8[MAP_U_ABORT_req] + + Out5 --> D1{CAMEL Handling} + Out7 --> D1 + Out8 --> D1 + + D1 -- False --> N2([NULL]) + D1 -- True --> C1[CAMEL_T_SMS_FAILURE] + C1 --> N2 + + subgraph Note + C1 -.-> T1[See TS 23.078] + end + +``` + +**Diagram Description:** + +The diagram illustrates two parallel logic flows for the SGSN process: + +- Flow 1:** Starts at state **Wait\_For\_More\_Messages**. + - Receiving **MAP\_U\_ABORT\_ind** or **MAP\_P\_ABORT\_ind** (from left) leads to sending **Gb\_LLC\_RELEASE\_req** (to right) and entering state **NULL**. + - Receiving **MAP\_NOTICE\_ind** (from left) leads to sending **MAP\_CLOSE\_req** (to left) then **Gb\_LLC\_RELEASE\_req** (to right) and entering state **NULL**. + - Receiving **Gb\_LLC\_RELEASE\_ind** (from right) leads to sending **MAP\_U\_ABORT\_req** (to left) and entering state **NULL**. +- Flow 2:** Starts at state **Wait\_For\_Subsequent\_Gb\_SM\_CONFIRM**. It follows the same signal logic as Flow 1 but passes through a **CAMEL Handling** decision point before reaching the **NULL** state. + - If **CAMEL Handling** is *False*, it transitions directly to **NULL**. + - If **CAMEL Handling** is *True*, it executes **CAMEL\_T\_SMS\_FAILURE** (referencing TS 23.078) before transitioning to **NULL**. + +SDL diagram for Process MT\_SM\_SGSN showing state transitions from 'Wait\_For\_More\_Messages' and 'Wait\_For\_Subsequent\_Gb\_SM\_CONFIRM' to 'NULL'. + +4150 + +4151 + +**Figure 23.3/10 (sheet 4 of 4): Process MT\_SM\_SGSN** + +Macrodefinition MT\_SM\_Transfer\_SGSN + +MT\_SM\_Xfer\_SGSN1(3) + +The mobile terminated short message transfer macro in the SGSN + +![Flowchart for MT_SM_Transfer_SGSN macro. It starts with a decision 'SGSN supports MT SMS?'. If 'No', it goes to 'Set User Error: Facility Not Supported'. If 'Yes', it goes to 'Check_Subscriber_Identity_for_MT_SMS'. From there, if 'OK', it checks 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks 'Confirmed by HLR?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks 'GPRS detached flag=Detached?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' -> 'Set MNRG' -> 'Release SMS'. If 'No', it checks 'RA Not Allowed flag=Not allowed?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' -> 'Set MNRG' -> 'Release SMS'. If 'No', it goes to 'CAMEL_MT_SMS_SGSN' (with a note 'See TS 23.078'). From 'CAMEL_MT_SMS_SGSN', it goes to 'Result?'. If 'Continue', it goes to 'CAMEL Handling'. If 'CAMEL Handling:= False', it goes to 'Release SMS'. If 'CAMEL Handling:= True', it goes to 'CAMEL_T_SMS_INIT' (with a note 'See TS 23.078'). From 'CAMEL_T_SMS_INIT', it goes to 'Result?'. If 'Release_SMS', it goes to 'Set User Error according to gsmSCF instructions' -> 'Release SMS'. If 'Continue', it goes to 'Release SMS'.](4b7adfd81f4c5c15da852897406fee15_img.jpg) + +``` + +graph TD + Start([Start]) --> Decision1{SGSN supports MT SMS?} + Decision1 -- No --> Error1[Set User Error: Facility Not Supported] + Decision1 -- Yes --> Process1[Check_Subscriber_Identity_for_MT_SMS] + Process1 -- OK --> Decision2{Subscriber known?} + Process1 -- Error --> Error1 + Decision2 -- No --> Error2[Set User Error: Unidentified Subscriber] + Decision2 -- Yes --> Decision3{Confirmed by HLR?} + Decision3 -- No --> Error2 + Decision3 -- Yes --> Decision4{GPRS detached flag=Detached?} + Decision4 -- Yes --> Error3[Set User Error: Absent subscriber] + Decision4 -- No --> Decision5{RA Not Allowed flag=Not allowed?} + Decision5 -- Yes --> Error3 + Decision5 -- No --> Process2[CAMEL_MT_SMS_SGSN] + Note1[See TS 23.078] -.-> Process2 + Process2 -- Continue --> Decision6{Result?} + Decision6 -- Continue --> Decision7{CAMEL Handling} + Decision7 -- "CAMEL Handling:= False" --> ReleaseSMS([Release SMS]) + Decision7 -- "CAMEL Handling:= True" --> Process3[CAMEL_T_SMS_INIT] + Note2[See TS 23.078] -.-> Process3 + Process3 -- Continue --> Decision8{Result?} + Decision8 -- Release_SMS --> Error4[Set User Error according to gsmSCF instructions] + Error4 --> ReleaseSMS + Decision8 -- Continue --> ReleaseSMS + Error3 --> SetMNRG[Set MNRG] + SetMNRG --> ReleaseSMS + Error3 --> Diagnostic[Diagnostic= GPRS detached] + Diagnostic --> ReleaseSMS + +``` + +Flowchart for MT\_SM\_Transfer\_SGSN macro. It starts with a decision 'SGSN supports MT SMS?'. If 'No', it goes to 'Set User Error: Facility Not Supported'. If 'Yes', it goes to 'Check\_Subscriber\_Identity\_for\_MT\_SMS'. From there, if 'OK', it checks 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks 'Confirmed by HLR?'. If 'No', it goes to 'Set User Error: Unidentified Subscriber'. If 'Yes', it checks 'GPRS detached flag=Detached?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' -> 'Set MNRG' -> 'Release SMS'. If 'No', it checks 'RA Not Allowed flag=Not allowed?'. If 'Yes', it goes to 'Set User Error: Absent subscriber' -> 'Set MNRG' -> 'Release SMS'. If 'No', it goes to 'CAMEL\_MT\_SMS\_SGSN' (with a note 'See TS 23.078'). From 'CAMEL\_MT\_SMS\_SGSN', it goes to 'Result?'. If 'Continue', it goes to 'CAMEL Handling'. If 'CAMEL Handling:= False', it goes to 'Release SMS'. If 'CAMEL Handling:= True', it goes to 'CAMEL\_T\_SMS\_INIT' (with a note 'See TS 23.078'). From 'CAMEL\_T\_SMS\_INIT', it goes to 'Result?'. If 'Release\_SMS', it goes to 'Set User Error according to gsmSCF instructions' -> 'Release SMS'. If 'Continue', it goes to 'Release SMS'. + +4152 + +4153 + +Figure 23.3/11 (sheet 1 of 3): Macro MT\_SM\_TRANSFER\_SGSN + +Macrodefinition MT\_SM\_Transfer\_SGSN + +MT\_SM\_Xfer\_SGSN2(3) + +The mobile terminated short message transfer macro in the SGSN + +Signals to/from the right are to/from the MS + +![Flowchart for Macro MT_SM_Transfer_SGSN. It starts at connector 1, checks if confirmed by radio contact. If not confirmed, it goes to Search_SMS_SGSN. If confirmed, it checks if RAI is known. If No, it goes to Search_SMS_SGSN. If Yes, it goes to Page_SMS_SGSN. Both lead to a Result decision. If Pass, it checks if MS supports SMS. If No, it sends Gb_LLC_RELEASE_req and ends at Error. If Yes, it sends Gb_RP_MT_DATA_req, waits for confirmation, receives Gb_RP_ACK_ind, and ends at OK. If Result is Fail, it checks for Error. If Absent Subscriber, it sets User Error: Absent Subscriber, sets MNRG, and ends at Error. Else, it sets User Error and ends at Error. A note indicates signals to/from the right are to/from the MS.](1f3c29c51892700d40eaee37ed6b870c_img.jpg) + +``` + +graph TD + 1((1)) --> C1{Confirmed by radio contact} + C1 -- Not confirmed --> S[Search_SMS_SGSN] + C1 -- Confirmed --> R1{RAI known?} + R1 -- No --> S + R1 -- Yes --> P[Page_SMS_SGSN] + P --> Res1{Result} + S --> Res2{Result} + Res1 -- Fail --> 2((2)) + Res1 -- Pass --> MS{MS supports SMS?} + Res2 -- Pass --> MS + Res2 -- Fail --> Err{Error} + Err -- Else --> SetErr[Set User Error] + Err -- Absent Subscriber --> SetErrSub[Set User Error: Absent Subscriber] + SetErrSub --> SetMNRG[Set MNRG] + SetMNRG --> Error((Error)) + SetErr --> Error + MS -- No --> GbLLC[Gb_LLC_RELEASE_req] + GbLLC --> SetErrFail[Set User Error: SM delivery failure] + SetErrFail --> FailCause[Delivery failure cause:= Equipment not SM equipped] + SetErrFail --> Error + MS -- Yes --> GbRPMT[Gb_RP_MT_DATA_req] + GbRPMT --> Wait[Wait_For_First_Gb_SM_Confirm] + Wait --> GbRPACK{Gb_RP_ACK_ind} + Wait --> GbRPERROR{Gb_RP_ERROR_ind} + GbRPACK --> OK((OK)) + GbRPERROR --> SetErr2[Set User Error] + SetErr2 --> Error + +``` + +Flowchart for Macro MT\_SM\_Transfer\_SGSN. It starts at connector 1, checks if confirmed by radio contact. If not confirmed, it goes to Search\_SMS\_SGSN. If confirmed, it checks if RAI is known. If No, it goes to Search\_SMS\_SGSN. If Yes, it goes to Page\_SMS\_SGSN. Both lead to a Result decision. If Pass, it checks if MS supports SMS. If No, it sends Gb\_LLC\_RELEASE\_req and ends at Error. If Yes, it sends Gb\_RP\_MT\_DATA\_req, waits for confirmation, receives Gb\_RP\_ACK\_ind, and ends at OK. If Result is Fail, it checks for Error. If Absent Subscriber, it sets User Error: Absent Subscriber, sets MNRG, and ends at Error. Else, it sets User Error and ends at Error. A note indicates signals to/from the right are to/from the MS. + +4154 + +4155 + +Figure 23.3/11 (sheet 2 of 3): Macro MT\_SM\_TRANSFER\_SGSN + +Macrodefinition MT\_SM\_Transfer\_SGSN + +MT\_SM\_Xfer\_SGSN3(3) + +The mobile terminated short message transfer macro in the SGSN + +Signals to/from the left are to/from the SMS-GMSC; signals to/from the right are to/from the MS + +![State transition diagram for MT_SM_Transfer_SGSN macro. It starts with a 'Wait_For_First_Gb_SM_Confirm' state. Transitions include 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and then to 'Gb_LLC_RELEASE_req' (which leads to 'Abort'); 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leading to 'Gb_LLC_RELEASE_req'; and 'Gb_LLC_RELEASE_ind' leading to 'Set User Error: System failure' (which leads to 'Error').](00f437f8c15ec7fd05fc003781d92db0_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_First_Gb_SM_Confirm + state "Wait_For_First_Gb_SM_Confirm" as Wait_For_First_Gb_SM_Confirm + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + state "Gb_LLC_RELEASE_ind" as Gb_LLC_RELEASE_ind + state "Gb_LLC_RELEASE_req" as Gb_LLC_RELEASE_req + state "Set User Error: System failure" as Set_User_Error_System_failure + state "Abort" as Abort + state "Error" as Error + + Wait_For_First_Gb_SM_Confirm --> MAP_NOTICE_ind + Wait_For_First_Gb_SM_Confirm --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + Wait_For_First_Gb_SM_Confirm --> Gb_LLC_RELEASE_ind + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Gb_LLC_RELEASE_req + Gb_LLC_RELEASE_req --> Abort + + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> Gb_LLC_RELEASE_req + + Gb_LLC_RELEASE_ind --> Set_User_Error_System_failure + Set_User_Error_System_failure --> Error + +``` + +State transition diagram for MT\_SM\_Transfer\_SGSN macro. It starts with a 'Wait\_For\_First\_Gb\_SM\_Confirm' state. Transitions include 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and then to 'Gb\_LLC\_RELEASE\_req' (which leads to 'Abort'); 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leading to 'Gb\_LLC\_RELEASE\_req'; and 'Gb\_LLC\_RELEASE\_ind' leading to 'Set User Error: System failure' (which leads to 'Error'). + +4156 + +4157 + +Figure 23.3/11 (sheet 3 of 3): Macro MT\_SM\_TRANSFER\_SGSN + +Procedure Page\_SMS\_SGSN + +Page\_SMS\_SGSN1(1) + +Procedure in the SGSN to page an MS for MT SMS delivery + +Signals to/from the right are to/from the MS + +![Flowchart for Procedure Page_SMS_SGSN. It starts with a decision 'MS connection exists?'. If 'Yes', it goes to 'Result= Pass' and ends. If 'No', it sends 'Gb_PAGE_REQUEST' (noted as being in the specified routing area), then 'Wait_For_Page_Response'. From there, it branches into 'Gb_PAGE_RESPONSE' (leading to 'Result= Pass'), 'Gb_NO_PAGE_RESPONSE' (leading to 'Error:= Absent subscriber' then 'Result= Fail'), or a default path (marked with '*'). All three paths end with connector symbols.](9c9b18de18babe304d651d5648864315_img.jpg) + +``` +graph TD; Start([ ]) --> Decision{MS connection exists?}; Decision -- Yes --> ResultPass1[Result= Pass]; ResultPass1 --> End1(( )); Decision -- No --> Request[Gb_PAGE_REQUEST]; Note1[In specified routing area] -.-> Request; Request --> Wait[Wait_For_Page_Response]; Wait --> ResponseGb[Gb_PAGE_RESPONSE]; Wait --> NoResponseGb[Gb_NO_PAGE_RESPONSE]; Wait --> Default[*]; ResponseGb --> ResultPass2[Result= Pass]; ResultPass2 --> End2(( )); NoResponseGb --> Error[Error:= Absent subscriber]; Error --> ResultFail[Result= Fail]; ResultFail --> End3(( )); Default --> End4(( )); +``` + +Flowchart for Procedure Page\_SMS\_SGSN. It starts with a decision 'MS connection exists?'. If 'Yes', it goes to 'Result= Pass' and ends. If 'No', it sends 'Gb\_PAGE\_REQUEST' (noted as being in the specified routing area), then 'Wait\_For\_Page\_Response'. From there, it branches into 'Gb\_PAGE\_RESPONSE' (leading to 'Result= Pass'), 'Gb\_NO\_PAGE\_RESPONSE' (leading to 'Error:= Absent subscriber' then 'Result= Fail'), or a default path (marked with '\*'). All three paths end with connector symbols. + +4158 + +4159 + +Figure 23.3/12 (sheet 1 of 1): Procedure Page\_SMS\_SGSN + +Procedure Search\_SMS\_SGSN + +Search\_SMS\_SGSN1(1) + +Procedure in the SGSN to search for an MS for MT SMS delivery + +Signals to/from the right are to/from the MS + +![Flowchart for Search_SMS_SGSN procedure. It starts with a connector, followed by a decision 'MS connection exists?'. If 'Yes', it goes to 'Result= Pass' and then a connector. If 'No', it goes to 'Gb_PAGE_REQUEST' (with a note 'In all routing areas'), then 'Wait_For_Search_Response'. From there, it branches into 'Gb_PAGE_RESPONSE' (leading to 'Update LAI' and 'Result= Pass'), 'Gb_NO_PAGE_RESPONSE' (leading to 'Error:= Absent subscriber' and 'Result= Fail'), or a general connector.](56e90393ca2226804734e447812d148b_img.jpg) + +``` +graph TD; Start([ ]) --> Decision{MS connection exists?}; Decision -- Yes --> ResultPass1[Result= Pass]; ResultPass1 --> Connector1(( )); Decision -- No --> GbPAGE[Gb_PAGE_REQUEST]; Note1[In all routing areas] -.-> GbPAGE; GbPAGE --> Wait[Wait_For_Search_Response]; Wait --> GbPAGE_RESP[Gb_PAGE_RESPONSE]; Wait --> GbNOPAGE_RESP[Gb_NO_PAGE_RESPONSE]; Wait --> Asterisk[/ * /]; GbPAGE_RESP --> UpdateLAI[Update LAI]; UpdateLAI --> ResultPass2[Result= Pass]; ResultPass2 --> Connector2(( )); GbNOPAGE_RESP --> Error[Error:= Absent subscriber]; Error --> ResultFail[Result= Fail]; ResultFail --> Connector3(( )); +``` + +Flowchart for Search\_SMS\_SGSN procedure. It starts with a connector, followed by a decision 'MS connection exists?'. If 'Yes', it goes to 'Result= Pass' and then a connector. If 'No', it goes to 'Gb\_PAGE\_REQUEST' (with a note 'In all routing areas'), then 'Wait\_For\_Search\_Response'. From there, it branches into 'Gb\_PAGE\_RESPONSE' (leading to 'Update LAI' and 'Result= Pass'), 'Gb\_NO\_PAGE\_RESPONSE' (leading to 'Error:= Absent subscriber' and 'Result= Fail'), or a general connector. + +4160 + +4161 + +Figure 23.3/13 (sheet 1 of 1): Procedure Search\_SMS\_SGSN + +process MT\_SM\_SMS\_ROUTER + +1(4) + +Process in the SMS Router to handle delivery of an MT short message + +Signals to/from the left are to/from the HLR +Signals to/from the right are to/from the SMS-GMSC + +![Flowchart for process MT_SM_SMS_ROUTER. The process starts with a 'Null' terminal, followed by a 'MAP_SEND_ROUTING_INFO_FOR_SM_ind' input. It then enters a 'Check_Indication' block. If 'Error', it goes to an 'Error' terminal. If 'OK', it reaches connector 'A'. From connector 'A', it goes to a decision 'SM-Delivery Not Intended'. If 'yes', it checks if 'more than one MCC/MNC allocated for this PLMN'. If 'yes', it goes to connector 'B'. If 'no', it checks if 'only MCC-MNC requested'. If 'yes', it goes to connector 'B'. If 'no', it goes to connector 'A'. If 'no' from the first decision, it goes to 'Set all MAP parameters as received', then sends 'MAP_OPEN_req', 'MAP_SEND_ROUTING_INFO_FOR_SM_req', and 'MAP_DELIMITER_req'. It then 'Receive_Open_Cnf'. If 'Error', it goes to an 'Error' terminal. If 'OK', it goes to 'Wait_For_Routing_Info'. From there, it branches into three paths: 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req'; 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind'; and 'MAP_SEND_ROUTING_INFO_FOR_SM_cnf' -> 'Check_Confirmation'. All three paths lead to a second 'SM-Delivery Not Intended' decision. If 'yes', it goes to connector 'B'. If 'no', it checks if 'only MCC-MNC requested'. If 'yes', it goes to connector 'B'. If 'no', it goes to connector 'C'. The 'MAP_CLOSE_req' path also leads to 'MAP_SEND_ROUTING_INFO_FOR_SM_rsp' and 'MAP_CLOSE_req' output, which then leads to a 'Null' terminal. An 'Error' terminal is also shown on the left side.](6cb9708fe557402511bdf7de0dccf3e5_img.jpg) + +``` + +graph TD + Start([Null]) --> Input1{{MAP_SEND_ROUTING_INFO_FOR_SM_ind}} + Input1 --> CheckInd[Check_Indication] + CheckInd -- Error --> Error1((Error)) + CheckInd -- OK --> A1((A)) + A1 --> Dec1{SM-Delivery Not Intended} + Dec1 -- yes --> MoreMCC{more than one MCC/MNC allocated for this PLMN} + MoreMCC -- yes --> B1((B)) + MoreMCC -- no --> OnlyMCC{only MCC-MNC requested} + OnlyMCC -- yes --> B1 + OnlyMCC -- no --> A1 + Dec1 -- no --> SetParams[Set all MAP parameters as received] + SetParams --> Output1{{MAP_OPEN_req +MAP_SEND_ROUTING_INFO_FOR_SM_req +MAP_DELIMITER_req}} + Output1 --> RecvCnf[Receive_Open_Cnf] + RecvCnf -- Error --> Error2((Error)) + RecvCnf -- OK --> WaitInfo[Wait_For_Routing_Info] + WaitInfo --> NoticeInd{{MAP_NOTICE_ind}} + WaitInfo --> AbortInd{{MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind}} + WaitInfo --> SendCnf{{MAP_SEND_ROUTING_INFO_FOR_SM_cnf}} + NoticeInd --> CloseReq1{{MAP_CLOSE_req}} + SendCnf --> CheckConf[Check_Confirmation] + CloseReq1 --> Dec2{SM-Delivery Not Intended} + AbortInd --> Dec2 + CheckConf --> Dec2 + Dec2 -- yes --> B2((B)) + Dec2 -- no --> OnlyMCC2{only MCC-MNC requested} + OnlyMCC2 -- yes --> B2 + OnlyMCC2 -- no --> C((C)) + CloseReq1 --> Output2{{MAP_SEND_ROUTING_INFO_FOR_SM_rsp +MAP_CLOSE_req}} + Output2 --> Null2([Null]) + SendCnf -- no --> AllocateID[Allocate MT Correlation ID] + AllocateID --> 1((1)) + +``` + +Flowchart for process MT\_SM\_SMS\_ROUTER. The process starts with a 'Null' terminal, followed by a 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_ind' input. It then enters a 'Check\_Indication' block. If 'Error', it goes to an 'Error' terminal. If 'OK', it reaches connector 'A'. From connector 'A', it goes to a decision 'SM-Delivery Not Intended'. If 'yes', it checks if 'more than one MCC/MNC allocated for this PLMN'. If 'yes', it goes to connector 'B'. If 'no', it checks if 'only MCC-MNC requested'. If 'yes', it goes to connector 'B'. If 'no', it goes to connector 'A'. If 'no' from the first decision, it goes to 'Set all MAP parameters as received', then sends 'MAP\_OPEN\_req', 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_req', and 'MAP\_DELIMITER\_req'. It then 'Receive\_Open\_Cnf'. If 'Error', it goes to an 'Error' terminal. If 'OK', it goes to 'Wait\_For\_Routing\_Info'. From there, it branches into three paths: 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req'; 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind'; and 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_cnf' -> 'Check\_Confirmation'. All three paths lead to a second 'SM-Delivery Not Intended' decision. If 'yes', it goes to connector 'B'. If 'no', it checks if 'only MCC-MNC requested'. If 'yes', it goes to connector 'B'. If 'no', it goes to connector 'C'. The 'MAP\_CLOSE\_req' path also leads to 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_rsp' and 'MAP\_CLOSE\_req' output, which then leads to a 'Null' terminal. An 'Error' terminal is also shown on the left side. + +4162 + +4163 + +Figure 23.3/14 (sheet 1 of 4): Process MT\_SM\_SMS\_ROUTER + +process MT\_SM\_SMS\_ROUTER + +2(4) + +Process in the SMS Router to handle delivery of an MT short message + +Signals to/from the left are to/from the HLR +Signals to/from the right are to/from the SMS-GMSC + +![Flowchart for process MT_SM_SMS_ROUTER. It starts with 'Start Timer T1', followed by 'Store required MAP parameters against MT Correlation ID'. Then it branches into three 'Set parameters' blocks (B, C, and a central one) with specific parameter details. These merge into 'MAP_SEND_ROUTING_INFO_FOR_SM_rsp', which leads to 'Wait_For_INFORM_SC'. From there, it branches into four paths: 'MAP_CLOSE_ind' leading to 'MAP_INFORM_SERVICE_CENTRE_req' then 'MAP_CLOSE_req' then a decision 'SM-Delivery Not Intended' (yes leads to 'Null', no leads to 'Wait_For_Short_Message'); 'MAP_INFORM_SERVICE_CENTRE_ind' leading to 'MAP_INFORM_SERVICE_CENTRE_req'; 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' then 'Stop Timer T1' then 'Release MT Correlation ID' then 'Error'; and 'Timer Expiry T1' leading to 'Internal'.](7885090ca50e88f1ee27fa0f1211b0be_img.jpg) + +``` + +graph TD + Start((1)) --> StartTimer[Start Timer T1] + StartTimer --> StoreParams[Store required MAP parameters against MT Correlation ID] + StoreParams --> Merge1(( )) + Merge1 --> B[Set parameters] + Merge1 --> C[Set parameters] + Merge1 --> Central[Set parameters] + B --> BParam[parameter IMSI is populated with MCC+MNC+ dummy MSIN] + C --> CParam[parameter networkNodeNumber is populated with a dummy value] + Central --> CentralParam[parameter IMSI is populated with MT Correlation ID] + BParam --> Merge2(( )) + CParam --> Merge2 + CentralParam --> Merge2 + Merge2 --> MAPSend[MAP_SEND_ROUTING_INFO_FOR_SM_rsp] + MAPSend --> WaitInform[Wait_For_INFORM_SC] + WaitInform --> Merge3(( )) + Merge3 --> MAPCloseInd[MAP_CLOSE_ind] + Merge3 --> MAPInformCentreInd[MAP_INFORM_SERVICE_CENTRE_ind] + Merge3 --> MAPNoticeInd[MAP_NOTICE_ind] + Merge3 --> TimerExpiry[Timer Expiry T1] + MAPCloseInd --> MAPInformCentreReq[MAP_INFORM_SERVICE_CENTRE_req] + MAPInformCentreReq --> MAPCloseReq1[MAP_CLOSE_req] + MAPCloseReq1 --> SMDeliveryNotIntended{SM-Delivery Not Intended} + SMDeliveryNotIntended -- yes --> Null[Null] + SMDeliveryNotIntended -- no --> WaitForShortMessage[Wait_For_Short_Message] + MAPInformCentreInd --> MAPInformCentreReq2[MAP_INFORM_SERVICE_CENTRE_req] + MAPNoticeInd --> MAPCloseReq2[MAP_CLOSE_req] + MAPCloseReq2 --> StopTimer[Stop Timer T1] + StopTimer --> ReleaseMT[Release MT Correlation ID] + ReleaseMT --> Error((Error)) + TimerExpiry --> Internal[Internal] + +``` + +Flowchart for process MT\_SM\_SMS\_ROUTER. It starts with 'Start Timer T1', followed by 'Store required MAP parameters against MT Correlation ID'. Then it branches into three 'Set parameters' blocks (B, C, and a central one) with specific parameter details. These merge into 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_rsp', which leads to 'Wait\_For\_INFORM\_SC'. From there, it branches into four paths: 'MAP\_CLOSE\_ind' leading to 'MAP\_INFORM\_SERVICE\_CENTRE\_req' then 'MAP\_CLOSE\_req' then a decision 'SM-Delivery Not Intended' (yes leads to 'Null', no leads to 'Wait\_For\_Short\_Message'); 'MAP\_INFORM\_SERVICE\_CENTRE\_ind' leading to 'MAP\_INFORM\_SERVICE\_CENTRE\_req'; 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' then 'Stop Timer T1' then 'Release MT Correlation ID' then 'Error'; and 'Timer Expiry T1' leading to 'Internal'. + +4164 + +4165 + +Figure 23.3/14 (sheet 2 of 4): Process MT\_SM\_SMS\_ROUTER + +![Large black redacted area covering the main diagram content.](c36484ee30def42acfc0ed11c6a03ced_img.jpg) + +A large rectangular black box covers the majority of the page, redacting the content of the diagram. Only the title and footer information remain visible. + +Large black redacted area covering the main diagram content. + +![Partial diagram elements visible at the bottom of the redacted area, including a downward arrow.](57ccddd121f0e37792e0ef451fc683de_img.jpg) + +At the bottom of the redacted area, there are several small, partially visible elements. On the left, a small orange rectangle has a downward-pointing arrow below it. In the center, there is a horizontal line. On the right, there is a small, light-colored rounded shape. + +Partial diagram elements visible at the bottom of the redacted area, including a downward arrow. + +4166 + +4167 + +**Figure 23.3/14 (sheet 3 of 4): Process MT\_SM\_ SMS\_ROUTER** + +![State transition diagram for process MT_SM_SMS_ROUTER. It shows various states (Transparent, Set IMSI, Start Timer T1, Wait for Short_Message, Null, Exit) and transitions between them based on MAP messages like MAP_MT_FORWARD_SHORT_MESSAGE_cnf, MAP_DELIMITER_ind, and MAP_CLOSE_ind. The diagram includes decision points for 'Success?' and 'Retry expected'.](18884d42b9bf346a68c7f1b9a02a5a4c_img.jpg) + +**process MT\_SM\_SMS\_ROUTER** 4(4) + +Process in the SMS Router to handle delivery of an MT short message + +Signals to/from the left are to/from the SMS-GMSC +Signals to/from the right are to/from the MSC/SGSN + +``` + +stateDiagram-v2 + [*] --> Transparent1: Transparent + Transparent1 --> MAP_MT_FORWARD_SHORT_MESSAGE_cnf + MAP_MT_FORWARD_SHORT_MESSAGE_cnf --> MAP_DELIMITER_ind + MAP_DELIMITER_ind --> MAP_CLOSE_ind + MAP_CLOSE_ind --> Success{Success?} + Success -- No --> RetryExpected{Retry expected} + Success -- Yes --> Exit((Exit)) + RetryExpected -- No --> Exit + RetryExpected -- Yes --> StartTimerT1: Start Timer T1 + StartTimerT1 --> WaitForShortMessage: Wait for Short_Message + WaitForShortMessage --> [*] + MAP_DELIMITER_ind --> MAP_DELIMITER_req + MAP_DELIMITER_req --> MAP_MT_FORWARD_SHORT_MESSAGE_rsp + MAP_MT_FORWARD_SHORT_MESSAGE_rsp --> Transparent2: Transparent + Transparent2 --> MAP_MT_FORWARD_SHORT_MESSAGE_ind + MAP_MT_FORWARD_SHORT_MESSAGE_ind --> SetIMSI: Set IMSI + SetIMSI --> MAP_MT_FORWARD_SHORT_MESSAGE_req_MAP_DELIMITER_req: MAP_MT_FORWARD_SHORT_MESSAGE_req, MAP_DELIMITER_req + MAP_MT_FORWARD_SHORT_MESSAGE_req_MAP_DELIMITER_req --> Transparent3: Transparent + Exit --> ReleaseMTCorrelationID: Release MT Correlation ID + ReleaseMTCorrelationID --> Null: Null + +``` + +State transition diagram for process MT\_SM\_SMS\_ROUTER. It shows various states (Transparent, Set IMSI, Start Timer T1, Wait for Short\_Message, Null, Exit) and transitions between them based on MAP messages like MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_cnf, MAP\_DELIMITER\_ind, and MAP\_CLOSE\_ind. The diagram includes decision points for 'Success?' and 'Retry expected'. + +4168 + +4169 + +Figure 23.3/14 (sheet 4 of 4): Process MT\_SM\_ SMS\_ROUTER + +process MT\_SM\_IPSMGW + +1(3) + +Process in the IP-SM-GW to handle delivery of an MT short message + +Signals to/from the left are to/from the HLR +Signals to/from the right are to/from the S-CSCF + +![Flowchart for process MT_SM_IPSMGW showing the logic for handling MT short messages, including routing checks, MAP signaling, and error handling.](86da052b1b6a67f928c0c66c0e083aba_img.jpg) + +``` + +graph TD + Start([Null]) --> Null1([Null]) + Null1 --> MAP_SEND_ROUTING_INFO_FOR_SM_ind[MAP_SEND_ROUTING_INFO_FOR_SM_ind] + MAP_SEND_ROUTING_INFO_FOR_SM_ind --> SM_Delivery_Not_Intended{SM-Delivery Not Intended} + SM_Delivery_Not_Intended -- no --> Null1 + SM_Delivery_Not_Intended -- yes --> MoreThanOneMCCMNC{more than one MCC/MNC pair allocated for this PLMN} + MoreThanOneMCCMNC -- yes --> OnlyMCCMNC{only MCC-MNC requested} + MoreThanOneMCCMNC -- no --> SetAllMAP[set all MAP parameter as received] + OnlyMCCMNC -- yes --> B((B)) + OnlyMCCMNC -- no --> SetAllMAP + SetAllMAP --> MAP_OPEN_req[MAP_OPEN_req +MAP_SEND_ROUTING_INFO_FOR_SM_req +MAP_DELIMITER_req] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf -- OK --> Wait_For_Routing_Info[Wait_For_Routing_Info] + Receive_Open_Cnf -- Error --> Error((Error)) + Wait_For_Routing_Info --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_Routing_Info --> MAP_U_ABORT_ind[MAP_U_ABORT_ind +MAP_P_ABORT_ind +MAP_CLOSE_ind] + Wait_For_Routing_Info --> MAP_SEND_ROUTING_INFO_FOR_SM_cnf[MAP_SEND_ROUTING_INFO_FOR_SM_cnf] + MAP_NOTICE_ind --> MAP_SEND_ROUTING_INFO_FOR_SM_rsp[MAP_SEND_ROUTING_INFO_FOR_SM_rsp +MAP_CLOSE_req] + MAP_SEND_ROUTING_INFO_FOR_SM_rsp --> Null2([Null]) + MAP_U_ABORT_ind --> Error + MAP_CLOSE_ind --> Error + MAP_SEND_ROUTING_INFO_FOR_SM_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation -- OK --> 1((1)) + Check_Indication[Check_Indication] -- OK --> A((A)) + Check_Indication -- Error --> Error + A --> SM_Delivery_Not_Intended + B --> SetAllMAP + +``` + +Flowchart for process MT\_SM\_IPSMGW showing the logic for handling MT short messages, including routing checks, MAP signaling, and error handling. + +4170 + +4171 + +Figure 23.3/15 (sheet 1 of 3): Process MT\_SM\_IPSMGW + +process MT\_SM\_IPSMGW + +2(3) + +Process in the IP-SM-GW to handle delivery of an MT short message + +Signals to/from the left are to/from the HLR +Signals to/from the right are to/from the S-CSCF + +![Flowchart for process MT_SM_IPSMGW. It starts with a circle '1' leading to 'Set parameter' (parameter network node number is populated with the IP-SM-GW address). A circle 'B' leads to 'Set parameter' (parameter IMSI is populated with MCC+MNC+ dummy MSIN). Both lead to 'MAP_SEND_ROUTING_INFO_FOR_SM_rsp', which leads to 'Wait For INFORM_SC'. From there, it branches into three paths: 'MAP_CLOSE_ind' leading to 'MAP_INFORM_SERVICE_CENTRE_req' leading to 'MAP_CLOSE_req'; 'MAP_INFORM_SERVICE_CENTRE_ind' leading to 'MAP_INFORM_SERVICE_CENTRE_req' leading to 'MAP_CLOSE_req'; and 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req'. All three 'MAP_CLOSE_req' paths lead to a decision 'SM-Delivery Not Intended'. If 'yes', it goes to 'NULL'. If 'no', it goes to 'Wait_For_Short_Message'. An 'Error' circle is also shown as a terminal state.](5082fe2ab14161df495765246fdacfcf_img.jpg) + +``` + +graph TD + 1((1)) --> SP1[Set parameter] + SP1 --> SP1_desc[parameter network node number is populated with the IP-SM-GW address] + B((B)) --> SP2[Set parameter] + SP2 --> SP2_desc[parameter IMSI is populated with MCC+MNC+ dummy MSIN] + SP1_desc --> MR[MAP_SEND_ROUTING_INFO_FOR_SM_rsp] + SP2_desc --> MR + MR --> WFIS[Wait For INFORM_SC] + WFIS --> MC_ind[MAP_CLOSE_ind] + WFIS --> ISC_ind[MAP_INFORM_SERVICE_CENTRE_ind] + WFIS --> MN_ind[MAP_NOTICE_ind] + MC_ind --> ISC_req[MAP_INFORM_SERVICE_CENTRE_req] + ISC_ind --> ISC_req + MN_ind --> MC_req[MAP_CLOSE_req] + ISC_req --> MC_req + MC_req --> SNI{SM-Delivery Not Intended} + SNI -- yes --> NULL[NULL] + SNI -- no --> WFM[Wait_For_Short_Message] + MN_ind --> Error((Error)) + +``` + +Flowchart for process MT\_SM\_IPSMGW. It starts with a circle '1' leading to 'Set parameter' (parameter network node number is populated with the IP-SM-GW address). A circle 'B' leads to 'Set parameter' (parameter IMSI is populated with MCC+MNC+ dummy MSIN). Both lead to 'MAP\_SEND\_ROUTING\_INFO\_FOR\_SM\_rsp', which leads to 'Wait For INFORM\_SC'. From there, it branches into three paths: 'MAP\_CLOSE\_ind' leading to 'MAP\_INFORM\_SERVICE\_CENTRE\_req' leading to 'MAP\_CLOSE\_req'; 'MAP\_INFORM\_SERVICE\_CENTRE\_ind' leading to 'MAP\_INFORM\_SERVICE\_CENTRE\_req' leading to 'MAP\_CLOSE\_req'; and 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req'. All three 'MAP\_CLOSE\_req' paths lead to a decision 'SM-Delivery Not Intended'. If 'yes', it goes to 'NULL'. If 'no', it goes to 'Wait\_For\_Short\_Message'. An 'Error' circle is also shown as a terminal state. + +4172 + +4173 + +Figure 23.3/15 (sheet 2 of 3): Process MT\_SM\_IPSMGW + +process MT\_SM\_IPSMGW + +3(3) + +Process in the IP-SM-GW to handle delivery of an MT short message + +Signals to/from the left are to/from the SMS-GMSC +Signals to/from the right are to/from the S-CSCF + +![Flowchart for process MT_SM_IPSMGW showing the sequence of operations for delivering an MT short message, including waiting for a message, receiving an indication, checking indications, delivering the SM, and handling responses.](12c19535683984538a011e6fd053c7cd_img.jpg) + +``` + +graph TD + Start([Wait_For_Short_Message]) --> Recv[Receive_Open_ind] + Recv -- OK --> WaitSvc[Wait_For_Service_Primitive] + Recv -- Error --> MAPClose[MAP-CLOSE_req] + MAPClose --> Null1([Null]) + WaitSvc --> MAPForward[MAP_MT_FORWARD_SM_ind] + MAPForward --> Check[Check_Indication] + Check -- OK --> Deliver[Deliver SM] + Check -- Error --> MAPRsp[MAP_MT_FORWARD_SM_rsp] + Deliver --> WaitResp[Wait For Response] + WaitResp -- positive response --> MAPRsp + WaitResp -- negative response --> Decision{delivery via alternative domain successful?} + Decision -- yes --> MAPRsp + Decision -- no --> SetUNR1[set UNR1] + SetUNR1 --> SetError[set error Absent Subscriber SM] + SetError --> MAPRsp + MAPRsp --> Report[Report_SM_Delivery_Stat_IPSMGW] + Report --> Null2([Null]) + +``` + +Flowchart for process MT\_SM\_IPSMGW showing the sequence of operations for delivering an MT short message, including waiting for a message, receiving an indication, checking indications, delivering the SM, and handling responses. + +4174 + +4175 + +Figure 23.3/15 (sheet 3 of 3): Process MT\_SM\_IPSMGW + +4176 **23.4 The Short Message Alert procedure** + +4177 The Short Message Alert procedure is used to alert the Service Centre when the mobile subscriber is active after a short + 4178 message transfer has failed because the mobile subscriber is not reachable, or when the MS has indicated that it has + 4179 memory capacity to accept a short message. + +4180 The message flow for the Short Message Alert procedure for the case when the mobile subscriber was not reachable is + 4181 shown in figure 23.4/1. + +![Sequence diagram for Short Message Alert procedure (Mobile is present). Lifelines: MS, Serving MSC or SGSN, VLR, HLR, Interworking MSC, SC. The sequence shows messages 1 through 7 being exchanged between these entities to alert the Service Centre.](40eb71118a3bf2b8136e6fec828d0a9c_img.jpg) + +``` + +sequenceDiagram + participant MS + participant Serving MSC or SGSN + participant VLR + participant HLR + participant Interworking MSC + participant SC + + Note left of MS: 1) CM Service Request (**), Page response or Location Updating (3GPP TS 24.008 [35]). + MS->>Serving MSC or SGSN: 1) + Note left of Serving MSC or SGSN: 2) MAP_PROCESS_ACCESS_REQUEST / MAP_UPDATE_LOCATION_AREA (**). + Serving MSC or SGSN->>VLR: 2) + Note left of VLR: 3) MAP_READY_FOR_SM (Mobile Present) / MAP_UPDATE_LOCATION / Supplementary Service Control Request (*). + VLR->>HLR: 3) + Note left of HLR: 4) MAP_READY_FOR_SM_ACK (*). + HLR->>VLR: 4) + Note left of HLR: 5) MAP_ALERT_SERVICE_CENTRE (notes 1 and 2). + HLR->>Interworking MSC: 5) + Note left of Interworking MSC: 6) Alert Service Centre (3GPP TS 23.040). + Interworking MSC->>SC: 6) + Note left of Interworking MSC: 5) + Interworking MSC->>Interworking MSC: 5) + Note left of Interworking MSC: 6) + Interworking MSC->>SC: 6) + Note left of Interworking MSC: 5) + Interworking MSC->>Interworking MSC: 5) + Note left of Interworking MSC: 6) + Interworking MSC->>SC: 6) + Note left of Interworking MSC: 7) MAP_ALERT_SERVICE_CENTRE_ACK. + Interworking MSC->>HLR: 7) + Note left of HLR: 7) + HLR->>HLR: 7) + Note left of HLR: 7) + HLR->>HLR: 7) + +``` + +Sequence diagram for Short Message Alert procedure (Mobile is present). Lifelines: MS, Serving MSC or SGSN, VLR, HLR, Interworking MSC, SC. The sequence shows messages 1 through 7 being exchanged between these entities to alert the Service Centre. + +- 4182 +- 4183 + - 4184 1) CM Service Request (\*\*), Page response or Location Updating (3GPP TS 24.008 [35]). + - 4185 2) MAP\_PROCESS\_ACCESS\_REQUEST / MAP\_UPDATE\_LOCATION\_AREA (\*\*). + - 4186 3) MAP\_READY\_FOR\_SM (Mobile Present) / MAP\_UPDATE\_LOCATION / + - 4187 Supplementary Service Control Request (\*). + - 4188 4) MAP\_READY\_FOR\_SM\_ACK (\*). + - 4189 5) MAP\_ALERT\_SERVICE\_CENTRE (notes 1 and 2). + - 4190 6) Alert Service Centre (3GPP TS 23.040). + - 4191 7) MAP\_ALERT\_SERVICE\_CENTRE\_ACK. + - 4192 NOTE 1: To all Service Centres in the Message Waiting List. + - 4193 NOTE 2: The HLR initiates the MAP\_ALERT\_SERVICE\_CENTRE service only if the MS Memory Capacity + - 4194 Exceeded flag is clear. + - 4195 (\*) For GPRS, messages 3) and 4) are sent/received by the SGSN. + - 4196 (\*\*) These messages are not used by the SGSN. + +4197 + 4198 **Figure 23.4/1: Short message alert procedure (Mobile is present)** + +4199 The message flow for the Short Message Alert procedure for the case where the MS indicates that it has memory + 4200 capacity to accept one or more short messages is shown in figure 23.4/2. + +![Sequence diagram for Short message alert procedure (MS memory capacity available). The diagram shows interactions between MS, Serving MSC or SGSN, VLR, HLR, Interworking MSC, and SC. The sequence of messages is: 1) MS to Serving MSC or SGSN; 2) Serving MSC or SGSN to VLR; 3) VLR to HLR; 4) HLR to VLR; 5) VLR to Serving MSC or SGSN; 6) Serving MSC or SGSN to MS; 7) HLR to Interworking MSC (three times); 8) Interworking MSC to SC (three times); 9) Interworking MSC to HLR (three times).](4a7971babb6c8726633005c19e30bf05_img.jpg) + +Sequence diagram for Short message alert procedure (MS memory capacity available). The diagram shows interactions between MS, Serving MSC or SGSN, VLR, HLR, Interworking MSC, and SC. The sequence of messages is: 1) MS to Serving MSC or SGSN; 2) Serving MSC or SGSN to VLR; 3) VLR to HLR; 4) HLR to VLR; 5) VLR to Serving MSC or SGSN; 6) Serving MSC or SGSN to MS; 7) HLR to Interworking MSC (three times); 8) Interworking MSC to SC (three times); 9) Interworking MSC to HLR (three times). + +4201 + +4202 + +4203 1) SM memory capacity available ( 3GPP TS 24.011 [37]). + +4204 2) MAP\_READY\_FOR\_SM (Memory Available) (\*). + +4205 3) MAP\_READY\_FOR\_SM (Memory Available) (\*\*). + +4206 4) MAP\_READY\_FOR\_SM\_ACK (\*\*). + +4207 5) MAP\_READY\_FOR\_SM\_ACK (\*). + +4208 6) SM memory capacity available (Acknowledge) (3GPP TS 24.011 [37]). + +4209 7) MAP\_ALERT\_SERVICE\_CENTRE (note). + +4210 8) Alert Service Centre (3GPP TS 23.040). + +4211 9) MAP\_ALERT\_SERVICE\_CENTRE\_ACK. + +4212 NOTE: To all Service Centres in the Message Waiting List. + +4213 (\*) Messages 2) and 5) are not used by the SGSN. + +4214 (\*\*) For GPRS, messages 3) and 4) are sent/received by the SGSN. + +4215 + +4216 + +**Figure 23.4/2: Short message alert procedure (MS memory capacity available)** + +4217 In addition the following MAP services are used in the MS memory available case: + +4218 MAP\_PROCESS\_ACCESS\_REQUEST (see clause 8.3); (\*) + +4219 MAP\_AUTHENTICATE (see clause 8.5); (\*) + +4220 MAP\_SET\_CIPHERING\_MODE (see clause 8.6); (\*) + +4221 MAP\_PROVIDE\_IMSI (see clause 8.9); (\*) + +4222 MAP\_CHECK\_IMEI (see clause 8.7); + +4223 MAP\_FORWARD\_NEW\_TMSI (see clause 8.9); (\*) + +4224 MAP\_TRACE\_SUBSCRIBER\_ACTIVITY (see clause 9.1). (\*) + +4225 (\*) These services are not used by the SGSN. + +4226 The Short Message Alert procedure when the MS indicates successful transfer after polling is shown in figure 23.4/3. + +![Sequence diagram for Short message alert procedure (Successful transfer after polling). The diagram shows four lifelines: Gateway MSC, HLR, Interworking MSC, and SC. The sequence of messages is: 1) Gateway MSC to HLR (MAP_REPORT_SM_DELIVERY_STATUS); 2) HLR to Gateway MSC (MAP_REPORT_SM_DELIVERY_STATUS_ACK); 3) HLR to Interworking MSC (MAP_ALERT_SERVICE_CENTRE); 4) Interworking MSC to SC (Alert Service Centre); 5) Interworking MSC to HLR (MAP_ALERT_SERVICE_CENTRE_ACK).](6febe06e14962a80f5a508b46c1ae93f_img.jpg) + +``` + +sequenceDiagram + participant Gateway MSC + participant HLR + participant Interworking MSC + participant SC + Note right of HLR: 1 + Gateway MSC->>HLR: + Note right of HLR: 2 + HLR->>Gateway MSC: + Note right of HLR: 3 + HLR->>Interworking MSC: + Note right of Interworking MSC: 3 + Interworking MSC->>HLR: + Note right of Interworking MSC: 4 + Interworking MSC->>SC: + Note right of Interworking MSC: 4 + Interworking MSC->>HLR: + Note right of Interworking MSC: 4 + Interworking MSC->>SC: + Note right of Interworking MSC: 5 + Interworking MSC->>HLR: + Note right of HLR: 5 + HLR->>Interworking MSC: + Note right of HLR: 5 + HLR->>Interworking MSC: + Note right of HLR: 5 + HLR->>Interworking MSC: + +``` + +Sequence diagram for Short message alert procedure (Successful transfer after polling). The diagram shows four lifelines: Gateway MSC, HLR, Interworking MSC, and SC. The sequence of messages is: 1) Gateway MSC to HLR (MAP\_REPORT\_SM\_DELIVERY\_STATUS); 2) HLR to Gateway MSC (MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ACK); 3) HLR to Interworking MSC (MAP\_ALERT\_SERVICE\_CENTRE); 4) Interworking MSC to SC (Alert Service Centre); 5) Interworking MSC to HLR (MAP\_ALERT\_SERVICE\_CENTRE\_ACK). + +4227 + +4228 + +4229 1) MAP\_REPORT\_SM\_DELIVERY\_STATUS (Successful Transfer). + +4230 2) MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ACK. + +4231 3) MAP\_ALERT\_SERVICE\_CENTRE (note). + +4232 4) Alert Service Centre (3GPP TS 23.040). + +4233 5) MAP\_ALERT\_SERVICE\_CENTRE\_ACK. + +4234 NOTE: To all Service Centres in the Message Waiting List. + +4235 + +4236 + +**Figure 23.4/3: Short message alert procedure (Successful transfer after polling)** + +## 4237 23.4.1 Procedure in the Serving MSC – the MS has memory available + +4238 The process starts when the MSC receives a notification from the MS that it has memory available. The process invokes +4239 a macro not defined in this clause; the definition of this macro can be found as follows: + +4240 Check\_Confirmation see clause 25.2.2. + +4241 The short message alert process in the MSC for the MS memory capacity available case is shown in figure 23.4/4. + +## 4242 23.4.2 Procedures in the VLR + +### 4243 23.4.2.1 The Mobile Subscriber is present + +4244 If the VLR successfully handles a MAP\_PROCESS\_ACCESS\_REQUEST indication or a +4245 MAP\_UPDATE\_LOCATION\_AREA indication while the MS Not Reachable Flag (MNRF) is set, the VLR sends a +4246 MAP\_READY\_FOR\_SM request to the HLR. The Alert Reason is set to indicate that the mobile subscriber is present +4247 for non GPRS. If authentication fails during the handling of a MAP\_PROCESS\_ACCESS\_REQUEST indication or a +4248 MAP\_UPDATE\_LOCATION\_AREA indication, the VLR shall not send a MAP\_READY\_FOR\_SM request to the +4249 HLR. The process in the VLR is described in detail in clause 25.10.1. + +### 4250 23.4.2.2 The MS has memory available + +4251 The process starts when the VLR receives dialogue opening request followed by a +4252 MAP\_PROCESS\_ACCESS\_REQUEST indication including a CM service type Short Message Service. The MAP +4253 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4254 Receive\_Open\_Ind see clause 25.1.1; + +4255 Receive\_Open\_Cnf see clause 25.1.2; + +4256 Check\_Indication see clause 25.2.1; + +4257 Check\_Confirmation see clause 25.2.2. + +4258 The short message alert process in the VLR for the MS memory capacity available case is shown in figure 23.4/5. + +### 4259 23.4.3 Procedures in the SGSN + +#### 4260 23.4.3.1 The Mobile Subscriber is present + +4261 If the SGSN successfully handles a Page response, Attach request or Routing Area Update request message (3GPP TS +4262 24.008 [35]), while the MS Not Reachable for GPRS (MNRG) flag is set, the SGSN sends a MAP\_READY\_FOR\_SM +4263 request to the HLR. The Alert Reason is set to indicate that the mobile subscriber is present for GPRS. If authentication +4264 fails during the handling of a Page response, Attach request or Routing Area Update request, the SGSN shall not send a +4265 MAP\_READY\_FOR\_SM request to the HLR + +4266 The process in the SGSN is described in detail in clause 25.10.23. + +#### 4267 23.4.3.2 The Mobile Equipment has memory available + +4268 The process starts when the SGSN receives an RP\_SM\_MEMORY\_AVAILABLE indication from the MS. The MAP +4269 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4270 Receive\_Open\_Cnf see clause 25.1.2; + +4271 Check\_Confirmation see clause 25.2.2. + +4272 The short message alert procedure in the SGSN for the MS memory capacity available case is shown in figure 23.4/6. + +### 4273 23.4.4 Procedure in the HLR + +4274 The process starts when the HLR receives a dialogue opening request using the application context mwdMngtContext. +4275 The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4276 Receive\_Open\_Ind see clause 25.1.1; + +4277 Check\_Indication see clause 25.2.1; + +4278 Alert\_Service\_Centre\_HLR see clause 25.10.3. + +4279 Sheet 1: If the dialogue opening request is from an SGSN, version 2 and version 1 of the application context are not +4280 applicable. + +4281 The short message alert process in the HLR is shown in figure 23.4/7. + +### 4282 23.4.5 Procedure in the SMS Interworking MSC + +4283 The process starts when the SMS-IWMSC receives a dialogue opening request using the application context +4284 shortMsgAlertContext. The MAP process invokes macros not defined in this clause; the definitions of these macros can +4285 be found as follows: + +4286 Receive\_Open\_Ind see clause 25.1.1; + +4287 Check\_Indication see clause 25.2.1. + +4288 The short message alert process in the SMS-IWMSC is shown in figure 23.4/8. + +![Sequence diagram for process SM_Alert_MSC. The flow starts with an initial node, followed by a 'Null' node. It then enters a loop: an output node sends 'A_RP_SM_MEMORY_AVAILABLE_ind' to the right; an input node receives 'MAP_READY_FOR_SM_req' and 'MAP_DELIMITER_req' from the right; a 'Wait_For_VLR_Response' node follows. A decision node then branches into three paths: 1) Output node sends 'A_MM_Release_ind' to the left, followed by an input node receiving 'MAP_U_ABORT_req' from the left, ending with an 'X'. 2) Input node receives 'MAP_READY_FOR_SM_cnf' from the right, followed by a 'Check_Confirmation' node. From 'Check_Confirmation', an 'OK' path leads to an input node receiving 'A_RP_ACK_req' from the left, ending with an 'X'. A non-OK path (User Error, Provider Error, Data Error) leads to a 'Set RP_ERROR' node, then an input node receiving 'A_RP_ERROR_req' from the left, ending with an 'X'. 3) Input node receives 'MAP_U_ABORT_ind' and 'MAP_CLOSE_ind' from the right, followed by a 'Set RP_ERROR: Network out of order' node, then an input node receiving 'A_RP_ERROR_req' from the left, ending with an 'X'.](434430603574c3a3b337b264c6f76438_img.jpg) + +**process SM\_Alert\_MSC** **SMA\_MSC1(1)** + +Process in the MSC to forward a notification that the MS has memory available to store short messages + +Signals to/from the left are to/from the MS; +signals to/from the right are to/from the VLR + +``` + +sequenceDiagram + participant Start + participant Null + participant Out1 + participant In1 + participant Wait + participant Decision + participant Out2 + participant In2 + participant Check + participant SetRE1 + participant In3 + participant SetRE2 + participant In4 + + Start --> Null + Null --> Out1 + Out1 --> In1 + In1 --> Wait + Wait --> Decision + Decision --> Out2 + Out2 --> In2 + In2 --> Check + Check --> SetRE1 + SetRE1 --> In3 + Check --> SetRE2 + SetRE2 --> In4 + +``` + +Sequence diagram for process SM\_Alert\_MSC. The flow starts with an initial node, followed by a 'Null' node. It then enters a loop: an output node sends 'A\_RP\_SM\_MEMORY\_AVAILABLE\_ind' to the right; an input node receives 'MAP\_READY\_FOR\_SM\_req' and 'MAP\_DELIMITER\_req' from the right; a 'Wait\_For\_VLR\_Response' node follows. A decision node then branches into three paths: 1) Output node sends 'A\_MM\_Release\_ind' to the left, followed by an input node receiving 'MAP\_U\_ABORT\_req' from the left, ending with an 'X'. 2) Input node receives 'MAP\_READY\_FOR\_SM\_cnf' from the right, followed by a 'Check\_Confirmation' node. From 'Check\_Confirmation', an 'OK' path leads to an input node receiving 'A\_RP\_ACK\_req' from the left, ending with an 'X'. A non-OK path (User Error, Provider Error, Data Error) leads to a 'Set RP\_ERROR' node, then an input node receiving 'A\_RP\_ERROR\_req' from the left, ending with an 'X'. 3) Input node receives 'MAP\_U\_ABORT\_ind' and 'MAP\_CLOSE\_ind' from the right, followed by a 'Set RP\_ERROR: Network out of order' node, then an input node receiving 'A\_RP\_ERROR\_req' from the left, ending with an 'X'. + +4289 + +4290 + +Figure 23.4/4: Procedure SM\_Alert\_MSC + +![Flowchart for process SM_Alert_VLR. The process starts with an initial state, followed by 'Null', 'Receive_Open_Ind', 'Wait_For_Service_Primitive', 'Process_Access_Request_VLR', 'Wait_For_Ready_For_SM', a decision point for 'MAP_READY_FOR_SM_ind', 'Check_Indication', another decision point for 'Set Ready for SM Reason', a list of MAP requests, 'Receive_Open_Cnf', and finally a decision based on response (Error, V1, Vr, OK) leading to error handling, HLR dialogue, or waiting for response.](870240d0d80351b5b3969050f46660ae_img.jpg) + +**process SM\_Alert\_VLR** **SMA\_VLR1(2)** + +Process in the VLR to forward a notification that the MS has memory available to store short messages + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR; + +``` + + graph TD + Start([ ]) --> Null1([Null]) + Null1 --> RecOpenInd[Receive_Open_Ind] + RecOpenInd -- OK --> WaitService[Wait_For_Service_Primitive] + RecOpenInd -- "Error, Vr" --> Null2([Null]) + WaitService --> ProcessAccess[Process_Access_Request_VLR] + ProcessAccess -- OK --> WaitReady[Wait_For_Ready_For_SM] + ProcessAccess -- Error --> Null2 + WaitReady --> Decision1{ } + Decision1 -- "MAP_READY_FOR_SM_ind" --> CheckInd[Check_Indication] + CheckInd -- OK --> Decision2{ } + Decision2 -- "Set Ready for SM Reason: Memory available for non-GPRS" --> Decision3{ } + Decision3 -- "MAP_OPEN_req +MAP_READY_FOR_SM_req +MAP_DELIMITER_req" --> RecOpenCnf[Receive_Open_Cnf] + RecOpenCnf -- Error --> Decision4{ } + RecOpenCnf -- V1 --> SetErrorV1[Set User Error: Facility not supported] + RecOpenCnf -- Vr --> PerformMAP[Perform MAP Vr dialogue] + RecOpenCnf -- OK --> WaitHLR[Wait_For_HLR_Response] + SetErrorV1 --> Decision4 + PerformMAP --> Null3([Null]) + WaitHLR --> Decision4 + Decision4 -- "MAP_READY_FOR_SM_rsp +MAP_CLOSE_req" --> Null4([Null]) + +``` + +Flowchart for process SM\_Alert\_VLR. The process starts with an initial state, followed by 'Null', 'Receive\_Open\_Ind', 'Wait\_For\_Service\_Primitive', 'Process\_Access\_Request\_VLR', 'Wait\_For\_Ready\_For\_SM', a decision point for 'MAP\_READY\_FOR\_SM\_ind', 'Check\_Indication', another decision point for 'Set Ready for SM Reason', a list of MAP requests, 'Receive\_Open\_Cnf', and finally a decision based on response (Error, V1, Vr, OK) leading to error handling, HLR dialogue, or waiting for response. + +4291 + +4292 + +**Figure 23.4/5 (sheet 1 of 2): Procedure SM\_Alert\_VLR** + +![Flowchart for process SM_Alert_VLR. It starts with 'Wait_For_HLR_Response' leading to a horizontal line. From this line, three paths emerge: 1) Left: 'MAP_READY_FOR_SM_cnf' leads to a left-pointing arrow, then 'Check_Confirmation'. 'Check_Confirmation' has an 'OK' path leading down to a bottom-pointing arrow, and an error path ('User Error, Provider Error, Data Error') leading to 'Set User Error'. 2) Middle: 'MAP_NOTICE_ind' leads down to 'MAP_CLOSE_req', which leads down to 'Set User Error: System failure'. 3) Right: A right-pointing arrow leads to a box with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', which then leads down to the bottom-pointing arrow. Both 'Set User Error' and 'Set User Error: System failure' lead to the bottom-pointing arrow. The bottom-pointing arrow leads to a box with 'MAP_READY_FOR_SM_rsp' and 'MAP_CLOSE_req', which finally leads down to 'Null'.](1c4c92c2c4c668fd3164a94e2d7a3921_img.jpg) + +**process SM\_Alert\_VLR** **SMA\_VLR2(2)** + +Process in the VLR to forward a notification that the MS has memory available to store short messages + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR; + +``` + +graph TD + Start([Wait_For_HLR_Response]) --> Junction(( )) + Junction --> LeftArrow{ } + Junction --> MiddleLine[ ] + Junction --> RightArrow{ } + LeftArrow --> MAP_READY_FOR_SM_cnf[MAP_READY_FOR_SM_cnf] + MAP_READY_FOR_SM_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation -- OK --> BottomArrow{ } + Check_Confirmation -- "User Error, Provider Error, Data Error" --> Set_User_Error[Set User Error] + MiddleLine --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Set_User_Error_System_Failure[Set User Error: System failure] + RightArrow --> Error_Indications["MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind"] + Error_Indications --> BottomArrow + Set_User_Error --> BottomArrow + Set_User_Error_System_Failure --> BottomArrow + BottomArrow --> Responses["MAP_READY_FOR_SM_rsp, MAP_CLOSE_req"] + Responses --> Null([Null]) + +``` + +Flowchart for process SM\_Alert\_VLR. It starts with 'Wait\_For\_HLR\_Response' leading to a horizontal line. From this line, three paths emerge: 1) Left: 'MAP\_READY\_FOR\_SM\_cnf' leads to a left-pointing arrow, then 'Check\_Confirmation'. 'Check\_Confirmation' has an 'OK' path leading down to a bottom-pointing arrow, and an error path ('User Error, Provider Error, Data Error') leading to 'Set User Error'. 2) Middle: 'MAP\_NOTICE\_ind' leads down to 'MAP\_CLOSE\_req', which leads down to 'Set User Error: System failure'. 3) Right: A right-pointing arrow leads to a box with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', which then leads down to the bottom-pointing arrow. Both 'Set User Error' and 'Set User Error: System failure' lead to the bottom-pointing arrow. The bottom-pointing arrow leads to a box with 'MAP\_READY\_FOR\_SM\_rsp' and 'MAP\_CLOSE\_req', which finally leads down to 'Null'. + +4293 + +4294 + +**Figure 23.4/5 (sheet 2 of 2): Procedure SM\_Alert\_VLR** + +![Flowchart for process SM_Alert_SGSN. The flow starts at a Null terminal, followed by a merge symbol receiving Gb_RP_SM_MEMORY_AVAILABLE_ind. It then passes through a process block 'Set Ready for SM Reason: Memory available for GPRS', then a decision symbol with inputs MAP_OPEN_req, MAP_READY_FOR_SM_req, and MAP_DELIMITER_req. The next block is 'Receive_Open_Cnf'. From there, three paths emerge: 'Error' leads to 'Set RP_ERROR: Network out of order'; 'Vr' leads to 'Set RP_ERROR: Facility not supported'; 'OK' leads to 'Wait_For_HLR_Response'. All three paths converge to a decision symbol 'Gb_RP_ERROR_req', which finally leads to a Null terminal.](9e291c566dabfe04833c505f14d02db0_img.jpg) + +**process SM\_Alert\_SGSN** **SMA\_SGSN1(2)** + +Process in the SGSN to forward a notification that the MS has memory available to store short messages + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the HLR + +``` + +graph TD + Start([Null]) --> Merge{ } + Merge -- "Gb_RP_SM_MEMORY_AVAILABLE_ind" --> Process1[Set Ready for SM Reason: +Memory available for GPRS] + Process1 --> Decision1{ } + Decision1 -- "MAP_OPEN_req +MAP_READY_FOR_SM_req +MAP_DELIMITER_req" --> Process2[Receive_Open_Cnf] + Process2 -- Error --> ErrorPath[Set RP_ERROR: +Network out of order] + Process2 -- Vr --> VrPath[Set RP_ERROR: +Facility not supported] + Process2 -- OK --> OKPath([Wait_For_HLR_Response]) + ErrorPath --> Decision2{Gb_RP_ERROR_req} + VrPath --> Decision2 + OKPath --> Decision2 + Decision2 --> End([Null]) + +``` + +Flowchart for process SM\_Alert\_SGSN. The flow starts at a Null terminal, followed by a merge symbol receiving Gb\_RP\_SM\_MEMORY\_AVAILABLE\_ind. It then passes through a process block 'Set Ready for SM Reason: Memory available for GPRS', then a decision symbol with inputs MAP\_OPEN\_req, MAP\_READY\_FOR\_SM\_req, and MAP\_DELIMITER\_req. The next block is 'Receive\_Open\_Cnf'. From there, three paths emerge: 'Error' leads to 'Set RP\_ERROR: Network out of order'; 'Vr' leads to 'Set RP\_ERROR: Facility not supported'; 'OK' leads to 'Wait\_For\_HLR\_Response'. All three paths converge to a decision symbol 'Gb\_RP\_ERROR\_req', which finally leads to a Null terminal. + +4295 + +4296 + +**Figure 23.4/6 (sheet 1 of 2): Process SM\_Alert\_SGSN** + +![State transition diagram for process SM_Alert_SGSN. The diagram starts with a 'Wait_For_HLR_Response' state. It branches into four main paths: 1) Gb_LLC_RELEASE_ind leads to MAP_U_ABORT_req and then Null. 2) MAP_READY_FOR_SM_cnf leads to Check_Confirmation, which on 'OK' leads to Gb_RP_ACK_req and then Null, and on 'User Error, Provider Error, Data Error' leads to Set_RP_ERROR, Gb_RP_ERROR_req, and then Null. 3) MAP_NOTICE_ind leads to MAP_CLOSE_req, Set_RP_ERROR: Network out of order, Gb_RP_ERROR_req, and then Null. 4) A group of signals (MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind) leads to a merge point before Set_RP_ERROR: Network out of order.](be33878621994047f90b955f7cb9ed86_img.jpg) + +**process SM\_Alert\_SGSN** **SMA\_SGSN2(2)** + +Process in the SGSN to forward a notification that the MS has memory available to store short messages + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_HLR_Response + state "Wait_For_HLR_Response" as Wait_For_HLR_Response + state "Gb_LLC_RELEASE_ind" as Gb_LLC_RELEASE_ind + state "MAP_READY_FOR_SM_cnf" as MAP_READY_FOR_SM_cnf + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + state "MAP_U_ABORT_req" as MAP_U_ABORT_req + state "Check_Confirmation" as Check_Confirmation + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Set_RP_ERROR" as Set_RP_ERROR + state "Set_RP_ERROR: Network out of order" as Set_RP_ERROR_Network_out_of_order + state "Gb_RP_ACK_req" as Gb_RP_ACK_req + state "Gb_RP_ERROR_req" as Gb_RP_ERROR_req + state "Null" as Null + + Wait_For_HLR_Response --> Gb_LLC_RELEASE_ind + Wait_For_HLR_Response --> MAP_READY_FOR_SM_cnf + Wait_For_HLR_Response --> MAP_NOTICE_ind + Wait_For_HLR_Response --> MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + + Gb_LLC_RELEASE_ind --> MAP_U_ABORT_req + MAP_U_ABORT_req --> Null + + MAP_READY_FOR_SM_cnf --> Check_Confirmation + Check_Confirmation --> Gb_RP_ACK_req : OK + Check_Confirmation --> Set_RP_ERROR : User Error, Provider Error, Data Error + Set_RP_ERROR --> Gb_RP_ERROR_req + Gb_RP_ACK_req --> Null + Gb_RP_ERROR_req --> Null + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_RP_ERROR_Network_out_of_order + Set_RP_ERROR_Network_out_of_order --> Gb_RP_ERROR_req + Gb_RP_ERROR_req --> Null + + MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind --> Set_RP_ERROR_Network_out_of_order + +``` + +State transition diagram for process SM\_Alert\_SGSN. The diagram starts with a 'Wait\_For\_HLR\_Response' state. It branches into four main paths: 1) Gb\_LLC\_RELEASE\_ind leads to MAP\_U\_ABORT\_req and then Null. 2) MAP\_READY\_FOR\_SM\_cnf leads to Check\_Confirmation, which on 'OK' leads to Gb\_RP\_ACK\_req and then Null, and on 'User Error, Provider Error, Data Error' leads to Set\_RP\_ERROR, Gb\_RP\_ERROR\_req, and then Null. 3) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, Set\_RP\_ERROR: Network out of order, Gb\_RP\_ERROR\_req, and then Null. 4) A group of signals (MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind) leads to a merge point before Set\_RP\_ERROR: Network out of order. + +4297 + +4298 + +Figure 23.4/6 (sheet 2 of 2): Process SM\_Alert\_SGSN + +![Flowchart for process SM_Alert_HLR. It starts with 'Null' -> 'Receive_Open_ind'. From 'Receive_Open_ind', three paths emerge: 'Vr' (left) leads to 'Perform MAP Vr dialogue' -> 'Null'; 'OK' (center) leads to 'Wait_For_Service_Primitive'; 'Error' (right) leads to 'Null'. 'Wait_For_Service_Primitive' branches into four paths: 1) 'MAP_READY_FOR_SM_ind' -> 'Check_Indication' -> Decision 'MNRF or MNRG supported AND MCEF supported AND MWD supported?'. If 'No', 'Set User Error: Facility not supported' -> 'Error' (left). If 'Yes', Decision 'Subscriber known?'. If 'No', 'Set User Error: Unknown subscriber' -> 'Error' (left). If 'Yes', Decision 'MCEF set OR MNRG set OR UNRI set'. If 'No', 'Start Race timer' -> 'Alert_Pending'. If 'Yes', connector '1'. 2) 'MAP_P_ABORT_ind' -> 'Null'. 3) 'MAP_NOTICE_ind' -> 'MAP_CLOSE_req' -> 'Null'. 4) 'MAP_REPORT_SM_DELIVERY_STATUS_ind' -> 'Report_SM_Delivery_Stat_HLR' -> Decision 'Delivery Result=Success?'. If 'No', 'Alert_Pending'. If 'Yes', 'Stop Race timer' -> 'Null'. At the bottom left, a merge point leads to 'MAP_READY_FOR_SM_rsp MAP_CLOSE_req' -> 'Null'.](7607b9e1dc17f539f850ff99f8cac783_img.jpg) + +**process SM\_Alert\_HLR** **SMA\_HLR1(2)** + +Process in the HLR to handle a notification that the MS is ready to receive short messages + +Signals to/from the left are to/from the VLR or the SGSN; signals to/from the right are from the SMS-GMSC + +``` + + graph TD + Start([Null]) --> RecOpen[Receive_Open_ind] + RecOpen -- Vr --> PerformVr[Perform MAP Vr dialogue] + PerformVr --> Null1([Null]) + RecOpen -- OK --> WaitService[Wait_For_Service_Primitive] + RecOpen -- Error --> Null2([Null]) + + WaitService --> MapReadyInd{MAP_READY_FOR_SM_ind} + MapReadyInd --> CheckInd[Check_Indication] + + CheckInd --> DecisionMNRF{MNRF or MNRG supported AND MCEF supported AND MWD supported?} + + DecisionMNRF -- No --> SetErrorFacility[Set User Error: Facility not supported] + SetErrorFacility --> ErrorLeft[Error] + + DecisionMNRF -- Yes --> SubKnown{Subscriber known?} + + SubKnown -- No --> SetErrorUnknown[Set User Error: Unknown subscriber] + SetErrorUnknown --> ErrorLeft + + SubKnown -- Yes --> DecisionMCEF{MCEF set OR MNRG set OR UNRI set} + + DecisionMCEF -- No --> StartRace[Start Race timer] + StartRace --> AlertPending1[Alert_Pending] + + DecisionMCEF -- Yes --> Connector1((1)) + + MapReadyInd --> MapPAbortInd{MAP_P_ABORT_ind} + MapPAbortInd --> Null3([Null]) + + MapReadyInd --> MapNoticeInd{MAP_NOTICE_ind} + MapNoticeInd --> MapCloseReq[MAP_CLOSE_req] + MapCloseReq --> Null4([Null]) + + MapReadyInd --> MapReportSMInd{MAP_REPORT_SM_DELIVERY_STATUS_ind} + MapReportSMInd --> ReportSM[Report_SM_Delivery_Stat_HLR] + + ReportSM --> DecisionDelResult{Delivery Result=Success?} + + DecisionDelResult -- No --> AlertPending2[Alert_Pending] + + DecisionDelResult -- Yes --> StopRace[Stop Race timer] + StopRace --> Null5([Null]) + + ErrorLeft --> MergePoint{{}} + + MergePoint --> MapReadyRsp[MAP_READY_FOR_SM_rsp MAP_CLOSE_req] + + MapReadyRsp --> Null6([Null]) + +``` + +Flowchart for process SM\_Alert\_HLR. It starts with 'Null' -> 'Receive\_Open\_ind'. From 'Receive\_Open\_ind', three paths emerge: 'Vr' (left) leads to 'Perform MAP Vr dialogue' -> 'Null'; 'OK' (center) leads to 'Wait\_For\_Service\_Primitive'; 'Error' (right) leads to 'Null'. 'Wait\_For\_Service\_Primitive' branches into four paths: 1) 'MAP\_READY\_FOR\_SM\_ind' -> 'Check\_Indication' -> Decision 'MNRF or MNRG supported AND MCEF supported AND MWD supported?'. If 'No', 'Set User Error: Facility not supported' -> 'Error' (left). If 'Yes', Decision 'Subscriber known?'. If 'No', 'Set User Error: Unknown subscriber' -> 'Error' (left). If 'Yes', Decision 'MCEF set OR MNRG set OR UNRI set'. If 'No', 'Start Race timer' -> 'Alert\_Pending'. If 'Yes', connector '1'. 2) 'MAP\_P\_ABORT\_ind' -> 'Null'. 3) 'MAP\_NOTICE\_ind' -> 'MAP\_CLOSE\_req' -> 'Null'. 4) 'MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ind' -> 'Report\_SM\_Delivery\_Stat\_HLR' -> Decision 'Delivery Result=Success?'. If 'No', 'Alert\_Pending'. If 'Yes', 'Stop Race timer' -> 'Null'. At the bottom left, a merge point leads to 'MAP\_READY\_FOR\_SM\_rsp MAP\_CLOSE\_req' -> 'Null'. + +4299 + +4300 + +Figure 23.4/7 (sheet 1 of 2): Process SM\_Alert\_HLR + +![Flowchart for process SM_Alert_HLR. It starts with a connector '1' leading to a decision 'Ready for SM Reason'. From this decision, three main paths emerge based on memory and subscriber status. The first path (Memory available for GPRS, non-GPRS, or IP-SM-GW) leads to clearing flags (MNRG, MNRF, UNRI, MCEF) and then to an 'Alert_Service_Centre_HLR' message. The second path (Subscriber present for IP-SM-GW) leads to clearing UNRI. The third path (Subscriber present for GPRS or non-GPRS) leads to clearing MNRG or MNRF. All three paths converge to a decision 'MCEF set?'. If 'No', it goes to 'Alert_Service_Centre_HLR'. If 'Yes', it goes to 'Null'. Both 'Alert_Service_Centre_HLR' and 'Null' lead to 'Alert_Pending'. From 'Alert_Pending', the flow goes to a 'Race timer expired' decision. If 'Internal' (Error), it goes to 'Null'. If 'OK', it goes to 'Wait_For_Service_Primitive'. If 'Vr', it goes to 'Perform MAP Vr dialogue' and then to 'Null'.](e0615287488ece40d876c62e5bc1ff69_img.jpg) + +process SM\_Alert\_HLR + +SMA\_HLR2(2) + +Process in the HLR to handle a notification that the MS is ready to receive short messages + +``` + +graph TD + 1((1)) --> Ready{Ready for SM Reason} + Ready --> M1[Memory available for GPRS] + Ready --> M2[Memory available for non-GPRS] + Ready --> M3[Memory available for IP-SM-GW] + Ready --> S1[Subscriber present for IP-SM-GW] + Ready --> S2[Subscriber present for GPRS] + Ready --> S3[Subscriber present for non-GPRS] + M1 --> C1[Clear MNRG; Clear MCEF] + M2 --> C2[Clear MNRF; Clear MCEF] + M3 --> C3[Clear UNRI; Clear MCEF] + S1 --> C4[Clear UNRI] + S2 --> C5[Clear MNRG] + S3 --> C6[Clear MNRF] + C1 --> MCEF{MCEF set?} + C2 --> MCEF + C3 --> MCEF + C4 --> MCEF + C5 --> MCEF + C6 --> MCEF + MCEF -- No --> ASC[Alert_Service_Centre_HLR] + MCEF -- Yes --> Null1[Null] + ASC --> Null1 + Null1 --> AP[Alert_Pending] + AP --> Race{Race timer expired} + Race -- Internal --> Null2[Null] + Race -- OK --> WFP[Wait_For_Service_Primitive] + Race -- Vr --> PMVD[Perform MAP Vr dialogue] + PMVD --> Null3[Null] + +``` + +Flowchart for process SM\_Alert\_HLR. It starts with a connector '1' leading to a decision 'Ready for SM Reason'. From this decision, three main paths emerge based on memory and subscriber status. The first path (Memory available for GPRS, non-GPRS, or IP-SM-GW) leads to clearing flags (MNRG, MNRF, UNRI, MCEF) and then to an 'Alert\_Service\_Centre\_HLR' message. The second path (Subscriber present for IP-SM-GW) leads to clearing UNRI. The third path (Subscriber present for GPRS or non-GPRS) leads to clearing MNRG or MNRF. All three paths converge to a decision 'MCEF set?'. If 'No', it goes to 'Alert\_Service\_Centre\_HLR'. If 'Yes', it goes to 'Null'. Both 'Alert\_Service\_Centre\_HLR' and 'Null' lead to 'Alert\_Pending'. From 'Alert\_Pending', the flow goes to a 'Race timer expired' decision. If 'Internal' (Error), it goes to 'Null'. If 'OK', it goes to 'Wait\_For\_Service\_Primitive'. If 'Vr', it goes to 'Perform MAP Vr dialogue' and then to 'Null'. + +4301 + +4302 + +4303 + +Figure 23.4/7 (sheet 2 of 2): Process SM\_Alert\_HLR + +![State transition diagram for process Alert_SC_IWMSC. It starts with an initial state leading to 'Null', then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'Error' to 'Null', 'OK' to 'Wait_For_Service_Primitive', and 'Vr' to 'Perform MAP Vr dialogue' (which leads to 'Null'). From 'Wait_For_Service_Primitive', an arrow points to a merge state (chevron). From this merge state, an arrow points to 'Check_Indication', and a signal 'MAP_ALERT_SERVICE_CENTRE_ind' is sent to the right. From 'Check_Indication', two paths emerge: 'Error' leading to a merge state for 'MAP_NOTICE_ind' and 'MAP_CLOSE_ind' (both leading to 'Null'), and 'OK' leading to a decision state (diamond). From the decision state, an arrow points to a merge state (chevron), and signals 'SC_RP_ALERT_SC_req' and 'MAP_ALERT_SERVICE_CENTRE_rsp / MAP_CLOSE_req' are sent to the right. Finally, an arrow from the merge state leads to the 'Null' state.](419bff93f5e948c1d9c64c3582832f7b_img.jpg) + +**process Alert\_SC\_IWMSC** **ASC\_IWMSC1(1)** + +Process in the SMS Interworking MSC to relay an alert to the SMSC + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the SMSC + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind --> Null2[Null] : Error + Receive_Open_Ind --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] : OK + Receive_Open_Ind --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] : Vr + Perform_MAP_Vr_dialogue --> Null3[Null] + Wait_For_Service_Primitive --> Merge1{ } + Merge1 --> Check_Indication[Check_Indication] + Merge1 --> MAP_ALERT_SERVICE_CENTRE_ind[MAP_ALERT_SERVICE_CENTRE_ind] + Check_Indication --> Null4[Null] : Error + Check_Indication --> Decision{ } : OK + Decision --> Merge2{ } + Decision --> SC_RP_ALERT_SC_req[SC_RP_ALERT_SC_req] + Decision --> MAP_ALERT_SERVICE_CENTRE_rsp[MAP_ALERT_SERVICE_CENTRE_rsp / MAP_CLOSE_req] + Merge2 --> Null5[Null] + Merge2 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Merge2 --> MAP_CLOSE_ind[MAP_CLOSE_ind] + MAP_NOTICE_ind --> Null6[Null] + MAP_CLOSE_ind --> Null7[Null] + +``` + +State transition diagram for process Alert\_SC\_IWMSC. It starts with an initial state leading to 'Null', then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'Error' to 'Null', 'OK' to 'Wait\_For\_Service\_Primitive', and 'Vr' to 'Perform MAP Vr dialogue' (which leads to 'Null'). From 'Wait\_For\_Service\_Primitive', an arrow points to a merge state (chevron). From this merge state, an arrow points to 'Check\_Indication', and a signal 'MAP\_ALERT\_SERVICE\_CENTRE\_ind' is sent to the right. From 'Check\_Indication', two paths emerge: 'Error' leading to a merge state for 'MAP\_NOTICE\_ind' and 'MAP\_CLOSE\_ind' (both leading to 'Null'), and 'OK' leading to a decision state (diamond). From the decision state, an arrow points to a merge state (chevron), and signals 'SC\_RP\_ALERT\_SC\_req' and 'MAP\_ALERT\_SERVICE\_CENTRE\_rsp / MAP\_CLOSE\_req' are sent to the right. Finally, an arrow from the merge state leads to the 'Null' state. + +4304 + +4305 + +Figure 23.4/8: Process Alert\_SC\_IWMSC + +## 23.5 The SM delivery status report procedure + +The SM delivery status report procedure is used: + +- to set the Service Centre address into the message waiting list in the HLR after short message delivery has failed because the subscriber is absent or unidentified or the memory capacity is exceeded. The procedure sets: +- the Memory Capacity Exceeded Flag (MCEF) in the HLR if the MS memory does not have room for more messages; +- and/or the MS Not Reachable Flag for non-GPRS if there is no record for the subscriber in the VLR or the subscriber does not respond to paging for delivery via the MSC; +- and/or the MS Not Reachable for GPRS (MNRG) flag if there is no record for the subscriber in the SGSN or the subscriber does not respond to paging for delivery via the SGSN; +- and/or the UE Not Reachable for IP (UNRI) flag if delivery via the IMS was not successful. +- to report to the HLR that delivery has succeeded. The conditions for report of a successful delivery are described in clause 23.3.1. + +The message flow for the SM delivery status report procedure is shown in figure 23.5/1. + +![Sequence diagram of the SM delivery status report procedure. Lifelines: V-MSC or SGSN or IP-SM-GW, HLR, Gateway MSC, SC. The sequence starts with the Gateway MSC sending a message (1) to the V-MSC/SGSN/IP-SM-GW. The V-MSC/SGSN/IP-SM-GW then sends a message (2) to the HLR. The HLR responds with a message (2a) to the V-MSC/SGSN/IP-SM-GW. The V-MSC/SGSN/IP-SM-GW then sends a message (2b) to the Gateway MSC. The Gateway MSC sends a message (3) to the HLR. Finally, the Gateway MSC sends a message (4) to the SC.](fd15797a5f766057f869e827657b63b1_img.jpg) + +``` + +sequenceDiagram + participant V as V-MSC or SGSN or IP-SM-GW + participant H as HLR + participant G as Gateway MSC + participant S as SC + Note right of G: 1 + G->>V: + Note left of V: 2a + V->>H: 2 + Note left of G: 2b + H->>G: + Note right of G: 3 + G->>S: 4 + +``` + +Sequence diagram of the SM delivery status report procedure. Lifelines: V-MSC or SGSN or IP-SM-GW, HLR, Gateway MSC, SC. The sequence starts with the Gateway MSC sending a message (1) to the V-MSC/SGSN/IP-SM-GW. The V-MSC/SGSN/IP-SM-GW then sends a message (2) to the HLR. The HLR responds with a message (2a) to the V-MSC/SGSN/IP-SM-GW. The V-MSC/SGSN/IP-SM-GW then sends a message (2b) to the Gateway MSC. The Gateway MSC sends a message (3) to the HLR. Finally, the Gateway MSC sends a message (4) to the SC. + +- 1) MAP\_MT\_FORWARD\_SHORT\_MESSAGE\_ACK/\_NACK (Absent subscriber\_SM, unidentified subscriber or memory capacity exceeded). +- 2) MAP\_REPORT\_SM\_DELIVERY\_STATUS. (The HLR ignores the content of this message when an IP-SM-GW is deployed) +- 2a) MAP\_REPORT\_SM\_DELIVERY\_STATUS (sent only by IP-SM-GW) +- 2b) MAP-REPORT\_SM\_DELIVERY\_STATUS\_ACK. +- 3) MAP\_REPORT\_SM\_DELIVERY\_STATUS\_ACK. +- 4) Short Message Negative Acknowledgement (3GPP TS 23.040). + +**Figure 23.5/1: Short message delivery status report procedure** + +### 23.5.1 Procedure in the SMS-GMSC + +The conditions for the GMSC to invoke the short message delivery status report procedure are specified in clause 23.3.1. + +The short message delivery status report macro in the SMS-GMSC is shown in figure 23.5/2. + +### 23.5.2 Procedure in the HLR + +4335 When the HLR receives a MAP\_REPORT\_SM\_DELIVERY\_STATUS indication while an IP-SM-GW is deployed in +4336 the network and the message is not received from an IP-SM-GW, it ignores the information received in the message; +4337 otherwise it acts as described in clause 23.6, macro Report\_SM\_Delivery\_Stat\_HLR. + +4338 The short message delivery status report process in the HLR is shown in figure 23.5/3. + +### 4339 23.5.3 Procedure in the IP-SM-GW + +The conditions for the IP-SM-GW and for SMS Router, if deployed with IP-SM-GW, to invoke the short message delivery status report procedure are specified in clause 23.3.7. + +4340 The short message delivery status report macro in the IP-SM-GW is shown in figure 23.5/4. + +4341 + +macrodefinition Report\_SM\_Delivery\_Stat\_GMSC + +RSMDS\_GMSC1(1) + +Macro to report the result of an MT short message delivery attempt + +Signals to/from the right are to/from the HLR + +![SDL diagram for Macro Report_SM_Delivery_Stat_GMSC showing the logic for reporting MT short message delivery status to the HLR, including handling of different MAP versions, success/failure results, and error conditions.](16a841958dd6c4294286b1caa9c87103_img.jpg) + +``` + +graph TD + Start([Start]) --> SendReqs[MAP_OPEN_req +MAP_REPORT_SM_DELIVERY_STATUS_req +MAP_DELIMITER_req] + SendReqs --> ReceiveOpenCnf{{Receive_ +Open_Cnf}} + + ReceiveOpenCnf -- V1 --> DelivResult{Delivery +result?} + DelivResult -- Success --> ErrorTerm1((Error)) + DelivResult -- Failure --> FailReason{Other +Delivery +failure +reason?} + FailReason -- "Absent +Subscriber" --> VrBranch + FailReason -- Other --> ErrorTerm1 + + ReceiveOpenCnf -- Vr --> VrBranch[Perform +MAP Vr +dialogue] + VrBranch -- OK --> OKTerm1((OK)) + + ReceiveOpenCnf -- OK --> WaitHLR{{Wait_For_ +HLR_Response}} + WaitHLR -- "MAP_REPORT_SM_DELIVERY_STATUS_cnf" --> CheckCnf[Check_ +Confirmation] + CheckCnf -- OK --> OKTerm2((OK)) + CheckCnf -- "Provider Error, +User Error, +Data Error" --> ErrorTerm2((Error)) + + ReceiveOpenCnf -- Error --> ErrorTerm3((Error)) + + WaitHLR -- "MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind" --> AbortHandler[ ] + AbortHandler --> MapNotice[/MAP_ +NOTICE_ +ind/] + MapNotice --> MapClose[MAP_ +CLOSE_ +req] + MapClose --> ErrorTerm4((Error)) + +``` + +SDL diagram for Macro Report\_SM\_Delivery\_Stat\_GMSC showing the logic for reporting MT short message delivery status to the HLR, including handling of different MAP versions, success/failure results, and error conditions. + +4342 + +4343 + +Figure 23.5/2: Macro Report\_SM\_Delivery\_Stat\_GMSC + +![A flowchart diagram representing the process SM_Delivery_Status_Report_HLR. The flow starts with an oval, followed by a cylinder, then a chevron pointing right to a rectangle. Below the chevron is a diamond, which connects to another diamond. From the second diamond, one path leads left to a chevron pointing left followed by a rectangle, and the other path leads down to a rectangle. Both final rectangles lead to an 'X' symbol. There are two empty note boxes at the top corners of the diagram area.](2943235f20a8f0c41127fb6a8284d272_img.jpg) + +A flowchart diagram representing the process SM\_Delivery\_Status\_Report\_HLR. The flow starts with an oval, followed by a cylinder, then a chevron pointing right to a rectangle. Below the chevron is a diamond, which connects to another diamond. From the second diamond, one path leads left to a chevron pointing left followed by a rectangle, and the other path leads down to a rectangle. Both final rectangles lead to an 'X' symbol. There are two empty note boxes at the top corners of the diagram area. + +4344 + +4345 + +**Figure 23.5/3: Process SM\_Delivery\_Status\_Report\_HLR** + +macrodefinition Report\_SM\_Delivery\_Stat\_IPSMGW + +1(1) + +Macro to report result of an MT short message delivery attempt + +Signals to/from the right are to/from the HLR + +![Flowchart for macrodefinition Report_SM_Delivery_Stat_IPSMGW showing the process of reporting MT short message delivery results.](5a2d577ae08bb387232b2f0f166feb2a_img.jpg) + +``` + +graph TD + Start([Start]) --> Req["MAP_OPEN_req +MAP_REPORT_SM_DELIVERY_STATUS_req +MAP_DELIMITER_req"] + Req --> Recv["Receive_Open_Cnf"] + Recv --> Decision1{Delivery result?} + Decision1 -- V1 --> Decision2{Other Delivery failure reason?} + Decision1 -- Vr --> Perform["Perform MAP Vr dialogue"] + Perform --> OK1((OK)) + Decision1 -- Failure --> Decision2 + Decision2 -- Absent Subscriber --> Perform + Decision2 -- Success --> Error1((Error)) + Decision1 -- OK --> Wait1[Wait_For_HLR_Response] + Wait1 --> Recv2[MAP_REPORT_SM_DELIVERY_STATUS_cnf] + Recv2 --> Check["Check Confirmation"] + Check -- OK --> OK2((OK)) + Check -- "Provider Error, User Error, Data Error" --> Error2((Error)) + Wait1 --> Wait2[Wait_For_HLR_Response] + Wait2 --> Ind1[MAP_NOTICE_ind] + Ind1 --> Req2[MAP_CLOSE_req] + Req2 --> Error3((Error)) + Wait2 --> Ind2[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Ind2 --> Error3 + +``` + +The flowchart illustrates the macrodefinition Report\_SM\_Delivery\_Stat\_IPSMGW. It begins with a start node leading to a block of outgoing signals: MAP\_OPEN\_req, MAP\_REPORT\_SM\_DELIVERY\_STATUS\_req, and MAP\_DELIMITER\_req. This is followed by a 'Receive\_Open\_Cnf' block. A decision diamond 'Delivery result?' follows, with three main paths: V1 (Success), Vr (Failure), and OK. The V1 path leads to another decision diamond 'Other Delivery failure reason?'. From this second decision, 'Success' leads to an 'Error' terminal, 'Failure' leads to 'Absent Subscriber' which then leads to 'Perform MAP Vr dialogue', and 'Other' leads to 'Perform MAP Vr dialogue'. The 'Perform MAP Vr dialogue' block leads to an 'OK' terminal. The OK path from the first decision leads to 'Wait\_For\_HLR\_Response', which then leads to a 'MAP\_REPORT\_SM\_DELIVERY\_STATUS\_cnf' block, followed by 'Check Confirmation'. 'Check Confirmation' leads to an 'OK' terminal or an 'Error' terminal labeled 'Provider Error, User Error, Data Error'. Both 'Wait\_For\_HLR\_Response' blocks lead to a 'MAP\_NOTICE\_ind' block, which leads to a 'MAP\_CLOSE\_req' block, which leads to an 'Error' terminal. Both 'Wait\_For\_HLR\_Response' blocks also lead to a block containing 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', which leads to an 'Error' terminal. + +Flowchart for macrodefinition Report\_SM\_Delivery\_Stat\_IPSMGW showing the process of reporting MT short message delivery results. + +4346 + +4347 + +Figure 23.5/4: Macro Report\_SM\_Delivery\_Stat\_IPSMGW + +## 4348 23.6 The macro Report\_SM\_Delivery\_Stat\_HLR + +4349 This macro is invoked when the HLR receives a MAP\_REPORT\_SM\_DELIVERY\_STATUS indication from the +4350 SMS-GMSC. The macro invokes macros not defined in this clause; the definitions of these macros can be found as +4351 follows: + +4352 Check\_Indication see clause 25.2.1; + +4353 Alert\_Service\_Centre\_HLR see clause 25.10.3. + +4354 Sheet 1: If the MAP\_REPORT\_SM\_DELIVERY\_STATUS indication did not include the GPRS support indicator, the +4355 HLR deduces the domain for which the delivery report applies as follows: + +4356 - if the subscriber is a GPRS-only subscriber, the report applies for GPRS; + +4357 - if the subscriber is a non-GPRS-only subscriber, the report applies for non-GPRS; + +4358 - if the subscriber is a GPRS and non-GPRS subscriber and the subscription option for MT SMS delivery when +4359 the SMS-GMSC does not support GPRS is set to "Delivery via the SGSN", the report applies for GPRS; + +4360 - if the subscriber is a GPRS and non-GPRS subscriber and the subscription option for MT SMS delivery when +4361 the SMS-GMSC does not support GPRS is set to "Delivery via the MSC", the report applies for non-GPRS; + +4362 The short message delivery status report macro in the HLR is shown in figure 23.6/1. + +![Flowchart for macrodefinition Report_SM_Delivery_Stat_HLR. The process starts with 'Check_Indication', followed by 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unknown Subscriber' and then to an 'Error' terminal. If 'Yes', it goes to 'Delivery result?'. From 'Delivery result?', 'Delivery failure' leads to 'Update MWD list', which then leads to 'MWD update failed?'. If 'Yes', it goes to 'Set User Error: MWD list full' and then to an 'Error' terminal. If 'No', it goes to 'Delivery Result:= Failure' and then to terminal '1'. 'Successful transfer for non-GPRS' leads to 'Clear MNRF: Clear MCEF', which leads to a merge point. 'Successful transfer for GPRS' leads to 'Clear MNRG: Clear MCEF', and 'Successful transfer via IP-SM-GW' leads to 'Clear UNRI Clear MCEF', both leading to the same merge point. From the merge point, it goes to 'MAP_REPORT_SM_DELIVERY_STATUS_rsp MAP_CLOSE_req', then to 'Alert_Service_Centre_HLR', then to 'Delivery Result:= Success', and finally to terminal 'OK'.](4323fed99d217013d0d8926487ee55e9_img.jpg) + +**macrodefinition Report\_SM\_Delivery\_Stat\_HLR** **RSMDS\_HLR1(2)** + +Macro in the HLR to handle an SM delivery status report from the SMS-GMSC + +Signals to/from the left are to/from the SMS-GMSC + +``` + +graph TD + Start([Start]) --> Check[Check_Indication] + Check --> OK[OK] + OK --> Sub{Subscriber known?} + Sub -- No --> Err1[Set User Error: Unknown Subscriber] + Err1 --> Error1((Error)) + Sub -- Yes --> Res{Delivery result?} + Res -- "Delivery failure" --> Update[Update MWD list] + Update --> Failed{MWD update failed?} + Failed -- Yes --> Err2[Set User Error: MWD list full] + Err2 --> Error2((Error)) + Failed -- No --> ResFail[Delivery Result:= Failure] + ResFail --> 1((1)) + Res -- "Successful transfer for non-GPRS" --> Clear1[Clear MNRF: Clear MCEF] + Res -- "Successful transfer for GPRS" --> Clear2[Clear MNRG: Clear MCEF] + Res -- "Successful transfer via IP-SM-GW" --> Clear3[Clear UNRI Clear MCEF] + Clear1 --> Merge{Merge} + Clear2 --> Merge + Clear3 --> Merge + Merge --> MapRsp[MAP_REPORT_SM_DELIVERY_STATUS_rsp +MAP_CLOSE_req] + MapRsp --> Alert[Alert_Service_Centre_HLR] + Alert --> ResSuccess[Delivery Result:= Success] + ResSuccess --> OK2((OK)) + +``` + +Flowchart for macrodefinition Report\_SM\_Delivery\_Stat\_HLR. The process starts with 'Check\_Indication', followed by 'Subscriber known?'. If 'No', it goes to 'Set User Error: Unknown Subscriber' and then to an 'Error' terminal. If 'Yes', it goes to 'Delivery result?'. From 'Delivery result?', 'Delivery failure' leads to 'Update MWD list', which then leads to 'MWD update failed?'. If 'Yes', it goes to 'Set User Error: MWD list full' and then to an 'Error' terminal. If 'No', it goes to 'Delivery Result:= Failure' and then to terminal '1'. 'Successful transfer for non-GPRS' leads to 'Clear MNRF: Clear MCEF', which leads to a merge point. 'Successful transfer for GPRS' leads to 'Clear MNRG: Clear MCEF', and 'Successful transfer via IP-SM-GW' leads to 'Clear UNRI Clear MCEF', both leading to the same merge point. From the merge point, it goes to 'MAP\_REPORT\_SM\_DELIVERY\_STATUS\_rsp MAP\_CLOSE\_req', then to 'Alert\_Service\_Centre\_HLR', then to 'Delivery Result:= Success', and finally to terminal 'OK'. + +4363 + +4364 + +Figure 23.6/1 (sheet 1 of 2): Macro Report\_SM\_Delivery\_Stat\_HLR + +macrodefinition Report\_SM\_Delivery\_Stat\_HLR + +RSMDS\_HLR2(2) + +![Flowchart for SM delivery status report handling in the HLR. The process starts with a macro entry point '1'. It checks if MSISDN=MSISDN-Alert. If 'Yes', it proceeds to 'Delivery failure cause?'. If 'No', it sets MSISDN-Alert and then proceeds to 'Delivery failure cause?'. From 'Delivery failure cause?', multiple paths emerge based on memory capacity or subscriber absence across different network types (non-GPRS, GPRS, IP-SM-GW). These paths lead to setting flags like MCEF, MNRF, MNRG, or UNRI. All paths converge to a decision 'Reason for absence available?'. If 'Yes', it stores the reason, checks absent subscriber status (referencing 3GPP TS 23.116), sends a MAP response, and exits at point '2'. If 'No', it proceeds to another entry point '2' which checks if MCEF is set, then checks if other flags (MNRF, MNRG, UNRI) are set, potentially triggering an 'Alert_Service_Centre_HLR' before reaching 'OK'.](7463e5fb239caa7f0913af358e12e97f_img.jpg) + +Macro in the HLR to handle +an SM delivery status report +from the SMS-GMSC + +Signals to/from the left +are to/from the SMS-GMSC + +``` + + graph TD + Start((1)) --> D1{MSISDN= +MSISDN- +Alert} + D1 -- Yes --> D2{Delivery +failure +cause?} + D1 -- No --> S1[Set MSISDN- +Alert] + S1 --> D2 + + D2 -- "MS memory +capacity +exceeded +for non-GPRS" --> S2[Set MCEF; +Clear MNRF] + D2 -- "MS memory +capacity +exceeded +for GPRS" --> S3[Set MCEF; +Clear MNRG] + D2 -- "MS memory +capability +exceeded +for +IP-SM-GW" --> S4[Set MCEF; +Clear UNRI] + D2 -- "Absent +Subscriber +for +IP-SM-GW" --> S5[Set UNRI] + D2 -- "Absent +Subscriber +for +non-GPRS" --> S6[Set MNRF] + D2 -- "Absent +Subscriber +for GPRS" --> S7[Set MNRG] + D2 -- "Absent +Subscriber +for +non-GPRS +& GPRS" --> S8[Set MNRF; +Set MNRG] + + S2 & S3 & S4 & S5 & S6 & S7 & S8 --> D3{Reason for +absence +available?} + + D3 -- Yes --> S9[Store +Reason for +absence] + S9 --> S10[Check_Absent_ +SubscriberSM_ +In_HLR] + S10 -.-> Note1[See 3GPP TS 23.116] + S10 --> S11[MAP_REPORT_SM_DELIVERY_ +STATUS_rsp +MAP_Close_req] + S11 --> Exit1((2)) + + S9 -.-> Note2[to +MNRR (MSC) +MNRR (SGSN) or +UNRR +depending on the node type of the node +where delivery failed] + + D3 -- No --> J1((2)) + J1 --> D4{MCEF set} + D4 -- yes --> J2(( )) + D4 -- no --> D5{MNRF set & +MNRG set & +UNRI set ?} + D5 -- yes --> J2 + D5 -- no --> S12[Alert_Service_ +Centre_HLR] + S12 --> OK((OK)) + +``` + +Flowchart for SM delivery status report handling in the HLR. The process starts with a macro entry point '1'. It checks if MSISDN=MSISDN-Alert. If 'Yes', it proceeds to 'Delivery failure cause?'. If 'No', it sets MSISDN-Alert and then proceeds to 'Delivery failure cause?'. From 'Delivery failure cause?', multiple paths emerge based on memory capacity or subscriber absence across different network types (non-GPRS, GPRS, IP-SM-GW). These paths lead to setting flags like MCEF, MNRF, MNRG, or UNRI. All paths converge to a decision 'Reason for absence available?'. If 'Yes', it stores the reason, checks absent subscriber status (referencing 3GPP TS 23.116), sends a MAP response, and exits at point '2'. If 'No', it proceeds to another entry point '2' which checks if MCEF is set, then checks if other flags (MNRF, MNRG, UNRI) are set, potentially triggering an 'Alert\_Service\_Centre\_HLR' before reaching 'OK'. + +4365 + +4366 + +**Figure 23.6/1 (sheet 2 of 2): Macro Report\_SM\_Delivery\_Stat\_HLR** + +4367 **23.7 The mobile terminated short message transfer procedure** +4368 **for VGCS** + +4369 The mobile terminated short message transfer for VGCS procedure is used for forwarding a short message from a +4370 Service Centre to the group call anchor MSC. The message flow for the mobile terminated short message transfer +4371 procedure for VGCS is shown in figure 23.7/1. + +![Sequence diagram showing the mobile terminated short message transfer procedure for VGCS. Lifelines: Anchor MSC, GCR, Gateway MSC, SC. Steps: 1. SC to Gateway MSC; 2. Gateway MSC to Anchor MSC; 3. Anchor MSC to Gateway MSC; 4. Gateway MSC to Anchor MSC; 5. Anchor MSC to GCR; 6. GCR to Anchor MSC; 7. Anchor MSC to Gateway MSC; 8. Gateway MSC to SC.](6481339ecf03de9d3565629c3d7b31fc_img.jpg) + +``` +sequenceDiagram + participant SC + participant Gateway MSC + participant Anchor MSC + participant GCR + Note right of SC: 1 + SC->>Gateway MSC: + Note right of Gateway MSC: 2 + Gateway MSC->>Anchor MSC: + Note right of Anchor MSC: 3 + Anchor MSC->>Gateway MSC: + Note right of Gateway MSC: 4 + Gateway MSC->>Anchor MSC: + Note right of Anchor MSC: 5 + Anchor MSC->>GCR: + Note right of GCR: 6 + GCR->>Anchor MSC: + Note right of Anchor MSC: 7 + Anchor MSC->>Gateway MSC: + Note right of Gateway MSC: 8 + Gateway MSC->>SC: +``` + +Sequence diagram showing the mobile terminated short message transfer procedure for VGCS. Lifelines: Anchor MSC, GCR, Gateway MSC, SC. Steps: 1. SC to Gateway MSC; 2. Gateway MSC to Anchor MSC; 3. Anchor MSC to Gateway MSC; 4. Gateway MSC to Anchor MSC; 5. Anchor MSC to GCR; 6. GCR to Anchor MSC; 7. Anchor MSC to Gateway MSC; 8. Gateway MSC to SC. + +4372 +4373 **Figure 23.7/1: Mobile terminated short message for VGCS service procedures** + +``` + +4374 1) Short Message (3GPP TS 23.040). +4375 2) TCAP BEGIN (*) +4376 3) TCAP CONTINUE (*) +4377 4) MAP_MT_FORWARD_SM_FOR_VGCS. +4378 5) GCR_SMS_INTERROGATION (3GPP TS 43.068). +4379 6) GCR_SMS_INTERROGATION_ACK (3GPP TS 43.068). +4380 7) MAP_MT_FORWARD_SM_FOR_VGCS_ACK. +4381 8) Short Message Acknowledgement (3GPP TS 23.040). +4382 +4383 (*) If +4384 a) +4385 - the capacity of a message signal unit in the lower layers of the protocol is enough to carry the +4386 content of the MAP_OPEN request and the content of the MAP_MT_FORWARD_SM_FOR_VGCS +4387 request in a single TC message, +4388 +4389 and +4390 b) the SMS Gateway MSC operator and the serving node (Anchor-MSC) operator +4391 agreed not to use the TCAP handshake countermeasure against SMS fraud for +4392 messages exchanged between their networks (see 3GPP TS 33.204 [34a]) +4393 then +4394 the TCAP handshake may be omitted. +4395 + +``` + +## 4396 23.7.1 Procedure in the SMS-GMSC + +4397 The process starts when the SMS-GMSC receives an SC\_RP\_MT\_DATA indication from a Service Centre. The MAP +4398 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4399     Receive\_Open\_Cnf     see clause 25.1.2; + +4400     Check\_Confirmation    see clause 25.2.2. + +4401 The mobile terminated short message transfer for VGCS process in the SMS-GMSC is shown in figure 23.7/2. + +## 4402 23.7.2 Procedure in the Anchor MSC + +4403 The process starts when the MSC receives a dialogue opening request with the application context shortMsgMT-Relay- +4404 VGCS-Context. The MAP process invokes macros not defined in this clause; the definitions of these macros can be +4405 found as follows: + +4406     Receive\_Open\_Ind     see clause 25.1.1; + +4407 The mobile terminated short message transfer for VGCS process in the Anchor MSC is shown in figure 23.7/3 + +4408 Procedure MT\_SM\_VGCS\_GMSC sheet 1: The decision box "TCAP Handshake required" takes the "yes" or "no" exit +4409 depending on agreements between the Serving MSC's operator and the SMS Gateway MSC's operator (see 3GPP TS +4410 33.204 [34a]). + +process MT\_SM\_VGCS\_GMSC + +1(2) + +Process in the SMS-GMSC to handle delivery of an MT short message to a VGCS call + +Signals to/from the left are to/from the short message service centre, signals to/from the right are to/from the Group Call Anchor MSC + +![Flowchart for process MT_SM_VGCS_GMSC. It starts with an entry point leading to a 'Null' state, then an 'SC_RP_MT_DATA_ind' message (including a Group Call Reference Number). A decision 'Message segmenting needed?' follows. If 'yes', it goes to 'MAP_OPEN_req' and 'MAP_DELIMITER_req'. If 'no', it checks 'TCAP Handshake required?'. If 'yes', it goes to 'MAP_OPEN_req' and 'MAP_DELIMITER_req'. If 'no', it goes to 'MAP_OPEN_req', 'MAP_MT_FORWARD_SM_VGCS_req', and 'MAP_DELIMITER_req'. Both 'MAP_OPEN_req' paths lead to 'Receive_Open_Cnf'. From 'Receive_Open_Cnf', 'Error, Vr' leads to 'Set RP_ERROR: System Failure' -> 'SC_RP_ERROR_req' -> 'NULL'. 'OK' leads to 'Wait_For_Confirm'.](14aaccd030ccca62597f3c5034f49061_img.jpg) + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> SC_RP_MT_DATA_ind{{SC_RP_MT_DATA_ind}} + Note1[including a Group Call Reference Number] -.-> SC_RP_MT_DATA_ind + SC_RP_MT_DATA_ind --> Segmenting{Message segmenting needed?} + Segmenting -- yes --> MAP_OPEN_req1{{MAP_OPEN_req +MAP_DELIMITER_req}} + Segmenting -- no --> TCAP{TCAP Handshake required?} + TCAP -- yes --> MAP_OPEN_req1 + TCAP -- no --> MAP_OPEN_req2{{MAP_OPEN_req +MAP_MT_FORWARD_SM_VGCS_req +MAP_DELIMITER_req}} + MAP_OPEN_req1 --> Receive_Open_Cnf1[Receive_Open_Cnf] + MAP_OPEN_req2 --> Receive_Open_Cnf2[Receive_Open_Cnf] + Receive_Open_Cnf1 -- "Error, Vr" --> Set_RP_Error1[Set RP_ERROR: +System Failure] + Set_RP_Error1 --> SC_RP_ERROR_req1{{SC_RP_ERROR_req}} + SC_RP_ERROR_req1 --> NULL1_end([NULL]) + Receive_Open_Cnf1 -- OK --> Wait_For_Confirm1[Wait_For_Confirm] + Receive_Open_Cnf2 -- "Error, Vr" --> Set_RP_Error2[Set RP_ERROR: +System Failure] + Set_RP_Error2 --> SC_RP_ERROR_req2{{SC_RP_ERROR_req}} + SC_RP_ERROR_req2 --> NULL2_end([NULL]) + Receive_Open_Cnf2 -- OK --> MAP_MT_FORWARD_SM_VGCS_req{{MAP_MT_FORWARD_SM_VGCS_req +MAP_DELIMITER_req}} + MAP_MT_FORWARD_SM_VGCS_req --> Wait_For_Confirm2[Wait_For_Confirm] + +``` + +Flowchart for process MT\_SM\_VGCS\_GMSC. It starts with an entry point leading to a 'Null' state, then an 'SC\_RP\_MT\_DATA\_ind' message (including a Group Call Reference Number). A decision 'Message segmenting needed?' follows. If 'yes', it goes to 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req'. If 'no', it checks 'TCAP Handshake required?'. If 'yes', it goes to 'MAP\_OPEN\_req' and 'MAP\_DELIMITER\_req'. If 'no', it goes to 'MAP\_OPEN\_req', 'MAP\_MT\_FORWARD\_SM\_VGCS\_req', and 'MAP\_DELIMITER\_req'. Both 'MAP\_OPEN\_req' paths lead to 'Receive\_Open\_Cnf'. From 'Receive\_Open\_Cnf', 'Error, Vr' leads to 'Set RP\_ERROR: System Failure' -> 'SC\_RP\_ERROR\_req' -> 'NULL'. 'OK' leads to 'Wait\_For\_Confirm'. + +4411 + +4412 + +Figure 23.7/2 (sheet 1 of 2): Process MT\_SM\_VGCS\_GMSC + +process MT\_SM\_VGCS\_GMSC + +2(2) + +Process in the SMS-GMSC to handle delivery of an MT short message to a VGCS call + +Signals to/from the left are to/from the short message service centre, signals to/from the right are to/from the Group Call Anchor MSC + +![State transition diagram for process MT_SM_VGCS_GMSC. It starts with 'Wait_For_Confirm' leading to three parallel paths: 1) MAP_FORWARD_SM_VGCS_cnf -> Check_Confirmation -> OK leads to SC_RP_ACK_req -> NULL; 2) MAP_NOTICE_ind -> MAP_CLOSE_req -> SET_RP_ERROR -> SC_RP_ERROR_req -> NULL; 3) MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind -> SET_RP_ERROR -> SC_RP_ERROR_req -> NULL. A 'User Error, Provider Error, Data Error' label is present between Check_Confirmation and SET_RP_ERROR.](b58b410e1be789df60ddeae5e55f94fb_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_Confirm + state "MAP_FORWARD_SM_VGCS_cnf" as MAP_FORWARD_SM_VGCS_cnf + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + state "Check_Confirmation" as Check_Confirmation + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "SET_RP_ERROR" as SET_RP_ERROR + state "SC_RP_ACK_req" as SC_RP_ACK_req + state "SC_RP_ERROR_req" as SC_RP_ERROR_req + state NULL + + Wait_For_Confirm --> MAP_FORWARD_SM_VGCS_cnf + Wait_For_Confirm --> MAP_NOTICE_ind + Wait_For_Confirm --> MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + + MAP_FORWARD_SM_VGCS_cnf --> Check_Confirmation + Check_Confirmation --> OK + Check_Confirmation --> User_Error, Provider_Error, Data_Error + OK --> SC_RP_ACK_req + User_Error, Provider_Error, Data_Error --> SET_RP_ERROR + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind --> SET_RP_ERROR + SET_RP_ERROR --> SC_RP_ERROR_req + SC_RP_ACK_req --> NULL + SC_RP_ERROR_req --> NULL + +``` + +State transition diagram for process MT\_SM\_VGCS\_GMSC. It starts with 'Wait\_For\_Confirm' leading to three parallel paths: 1) MAP\_FORWARD\_SM\_VGCS\_cnf -> Check\_Confirmation -> OK leads to SC\_RP\_ACK\_req -> NULL; 2) MAP\_NOTICE\_ind -> MAP\_CLOSE\_req -> SET\_RP\_ERROR -> SC\_RP\_ERROR\_req -> NULL; 3) MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind -> SET\_RP\_ERROR -> SC\_RP\_ERROR\_req -> NULL. A 'User Error, Provider Error, Data Error' label is present between Check\_Confirmation and SET\_RP\_ERROR. + +4413 + +4414 + +Figure 23.7/2 (sheet 2 of 2): Process MT\_SM\_VGCS\_GMSC + +process MT\_SM\_VGCS\_Anchor\_MSC + +1(2) + +Process in the Group Call Anchor MSC to handle delivery of an MT short message to a VGCS call + +Signals to/from the left are to/from the SMS GMSC; signals to/from the right are to/from the the application process in the Anchor MSC + +![State transition diagram for process MT_SM_VGCS_Anchor_MSC. It starts at an initial state, goes to IDLE, then receives an Open_indication. From there, it branches based on 'Error, Vr' (back to IDLE), 'OK' (to a decision 'Message protected by MAPsec'), 'yes' (to 'Wait_For_Service_Primitive'), or 'no' (to 'TCAP Handshake required'). From 'TCAP Handshake required', 'no' leads to 'Wait_For_Service_Primitive' and 'yes' leads to 'Wait_For_DELIMITER'. Both wait states lead to a horizontal line with four options: 'MAP_MT_FORWARD_SM_VGCS_ind' (leading to 'Set Error System Failure' then 'MAP_MT_FORWARD_SM_VGCS_rsp' then 'MAP_CLOSE_req' then IDLE), 'MAP_DELIMITER_ind' (leading to 'MAP_DELIMITER_req' then 'Wait_For_Service_Primitive'), 'MAP_U_ABORT_ind / MAP_P_ABORT_ind / MAP_CLOSE_ind' (leading directly to IDLE), and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' then IDLE).](8fc68c981924a8acc53f3b4bb79bf158_img.jpg) + +``` + +stateDiagram-v2 + [*] --> IDLE + IDLE --> Receive_Open_ind + state "Receive_Open_ind" as Receive_Open_ind + Receive_Open_ind --> IDLE : Error, Vr + Receive_Open_ind --> Message_protected_by_MAPsec : OK + state "Message protected by MAPsec" as Message_protected_by_MAPsec + Message_protected_by_MAPsec --> Wait_For_Service_Primitive : yes + Message_protected_by_MAPsec --> TCAP_Handshake_required : no + state "TCAP Handshake required" as TCAP_Handshake_required + TCAP_Handshake_required --> Wait_For_Service_Primitive : no + TCAP_Handshake_required --> Wait_For_DELIMITER : yes + state "Wait_For_Service_Primitive" as Wait_For_Service_Primitive + state "Wait_For_DELIMITER" as Wait_For_DELIMITER + Wait_For_Service_Primitive --> MAP_MT_FORWARD_SM_VGCS_ind + Wait_For_DELIMITER --> MAP_MT_FORWARD_SM_VGCS_ind + state "MAP_MT_FORWARD_SM_VGCS_ind" as MAP_MT_FORWARD_SM_VGCS_ind + state "MAP_DELIMITER_ind" as MAP_DELIMITER_ind + state "MAP_U_ABORT_ind / MAP_P_ABORT_ind / MAP_CLOSE_ind" as MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + MAP_MT_FORWARD_SM_VGCS_ind --> Set_Error_System_Failure + state "Set Error System Failure" as Set_Error_System_Failure + Set_Error_System_Failure --> MAP_MT_FORWARD_SM_VGCS_rsp + state "MAP_MT_FORWARD_SM_VGCS_rsp" as MAP_MT_FORWARD_SM_VGCS_rsp + MAP_MT_FORWARD_SM_VGCS_rsp --> MAP_CLOSE_req + state "MAP_CLOSE_req" as MAP_CLOSE_req + MAP_CLOSE_req --> IDLE + MAP_DELIMITER_ind --> MAP_DELIMITER_req + state "MAP_DELIMITER_req" as MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Service_Primitive + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> IDLE + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> IDLE + +``` + +State transition diagram for process MT\_SM\_VGCS\_Anchor\_MSC. It starts at an initial state, goes to IDLE, then receives an Open\_indication. From there, it branches based on 'Error, Vr' (back to IDLE), 'OK' (to a decision 'Message protected by MAPsec'), 'yes' (to 'Wait\_For\_Service\_Primitive'), or 'no' (to 'TCAP Handshake required'). From 'TCAP Handshake required', 'no' leads to 'Wait\_For\_Service\_Primitive' and 'yes' leads to 'Wait\_For\_DELIMITER'. Both wait states lead to a horizontal line with four options: 'MAP\_MT\_FORWARD\_SM\_VGCS\_ind' (leading to 'Set Error System Failure' then 'MAP\_MT\_FORWARD\_SM\_VGCS\_rsp' then 'MAP\_CLOSE\_req' then IDLE), 'MAP\_DELIMITER\_ind' (leading to 'MAP\_DELIMITER\_req' then 'Wait\_For\_Service\_Primitive'), 'MAP\_U\_ABORT\_ind / MAP\_P\_ABORT\_ind / MAP\_CLOSE\_ind' (leading directly to IDLE), and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' then IDLE). + +4415 + +4416 + +Figure 23.7/3 (sheet 1 of 2): Process MT\_SM\_VGCS\_Anchor MSC + +process MT\_SM\_VGCS\_Anchor\_MSC + +2(2) + +Process in the Group Call Anchor MSC to handle delivery of an MT short message to a VGCS call + +Signals to/from the left are to/from the SMS GMSC; signals to/from the right are to/from the the application process in the Anchor MSC + +![State transition diagram for process MT_SM_VGCS_Anchor_MSC. It starts with Wait_For_Service_Primitive, leading to four possible indications: MAP_DELIMITER_ind, MAP_MT_FORWARD_SM_VGCS_ind, MAP_U_ABORT_ind/MAP_P_ABORT_ind/MAP_CLOSE_ind, and MAP_NOTICE_ind. The first leads to MAP_DELIMITER_req and back to Wait_For_Service_Primitive. The second leads to MT_Forward_SM_VGCS (referencing 3GPP TS 43.068) and then to Wait_For_Response. The third and fourth lead to MAP_CLOSE_req and then to IDLE. From Wait_For_Response, a positive response leads to set result and a negative response leads to set error, both then leading to MAP_MT_FORWARD_SM_VGCS_rsp/MAP_CLOSE_req and finally to IDLE.](6bf6442555ad45b5b3ec1f6e174c08ce_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Primitive + state "Wait_For_Service_Primitive" as Wait_For_Service_Primitive + state "IDLE" as IDLE + state "MT_Forward_SM_VGCS" as MT_Forward_SM_VGCS + state "Wait_For_Response" as Wait_For_Response + state "set result" as set result + state "set error" as set error + state "MAP_MT_FORWARD_SM_VGCS_rsp / MAP_CLOSE_req" as MAP_MT_FORWARD_SM_VGCS_rsp / MAP_CLOSE_req + + Wait_For_Service_Primitive --> MAP_DELIMITER_ind + Wait_For_Service_Primitive --> MAP_MT_FORWARD_SM_VGCS_ind + Wait_For_Service_Primitive --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + Wait_For_Service_Primitive --> MAP_NOTICE_ind + + MAP_DELIMITER_ind --> MAP_DELIMITER_req + MAP_DELIMITER_req --> Wait_For_Service_Primitive + + MAP_MT_FORWARD_SM_VGCS_ind --> MT_Forward_SM_VGCS + MT_Forward_SM_VGCS --> Wait_For_Response + + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> IDLE + + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> IDLE + + Wait_For_Response --> positive_response + Wait_For_Response --> negative_response + + positive_response --> set result + negative_response --> set error + + set result --> MAP_MT_FORWARD_SM_VGCS_rsp / MAP_CLOSE_req + set error --> MAP_MT_FORWARD_SM_VGCS_rsp / MAP_CLOSE_req + + MAP_MT_FORWARD_SM_VGCS_rsp / MAP_CLOSE_req --> IDLE + +``` + +State transition diagram for process MT\_SM\_VGCS\_Anchor\_MSC. It starts with Wait\_For\_Service\_Primitive, leading to four possible indications: MAP\_DELIMITER\_ind, MAP\_MT\_FORWARD\_SM\_VGCS\_ind, MAP\_U\_ABORT\_ind/MAP\_P\_ABORT\_ind/MAP\_CLOSE\_ind, and MAP\_NOTICE\_ind. The first leads to MAP\_DELIMITER\_req and back to Wait\_For\_Service\_Primitive. The second leads to MT\_Forward\_SM\_VGCS (referencing 3GPP TS 43.068) and then to Wait\_For\_Response. The third and fourth lead to MAP\_CLOSE\_req and then to IDLE. From Wait\_For\_Response, a positive response leads to set result and a negative response leads to set error, both then leading to MAP\_MT\_FORWARD\_SM\_VGCS\_rsp/MAP\_CLOSE\_req and finally to IDLE. + +4417 + +4418 + +Figure 23.7/3 (sheet 2 of 2): Process MT\_SM\_VGCS\_Anchor MSC + +4419 + +## 24 GPRS process description + +4420 The MAP GPRS procedures are used for the Network Requested PDP-Context Activation procedures. + +4421 The stage 2 specification for General Packet Radio Service (GPRS) is in 3GPP TS 23.060 [104]. + +## 4422 24.1 Procedure for retrieval of routing information for GPRS + +### 4423 24.1.1 Process in the GGSN + +4424 The MAP process in the GGSN to request routing information for a network requested PDP context activation is +4425 shown in figure 24.1/2. The MAP process invokes macros not defined in this clause; the definition of these macros can +4426 be found as follows: + +4427     Receive\_Open\_Cnf see clause 25.1.2; + +4428     Check\_Confirmation see clause 25.2.2. + +### 4429 24.1.2 Process in the HLR + +4430 The MAP process in the HLR to provide routing information for a network-requested PDP context activation is shown +4431 in figure 24.1/1. The MAP process invokes macros not defined in this clause; the definitions of these macros can be +4432 found as follows: + +4433     Receive\_Open\_Ind see clause 25.1.1; + +4434     Check\_Indication see clause 25.2.1. + +![State transition diagram for SRI_GPRS_GGSN process. It starts at an initial state, goes to Idle, then Send Routing Info for GPRS. It then branches based on MAP messages (OPEN_req, SEND_ROUTING_INFO_FOR_GPRS_req, DELIMITER_req). From Receive_Open_Cnf, it branches to Wait_For_Routeing_Info (OK) or Perform MAP Vr dialogue (Error). Wait_For_Routeing_Info leads to a decision point for MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind, MAP_NOTICE_ind, and MAP_SEND_ROUTING_INFO_FOR_GPRS_cnf. MAP_NOTICE_ind leads to MAP_CLOSE_req, which then leads to a decision point for Provider Error, Data Error, User Error, and OK. Provider Error, Data Error, and User Error lead to Set negative response: System failure, which then leads to Send Routing Info for GPRS negative response and back to Idle. OK leads to Send Routing Info for GPRS ack and back to Idle.](4ba8a90dcc7c49bb9b60c5326193057d_img.jpg) + +**process SRI\_GPRS\_GGSN** **SRI\_GPRS\_GGSN1(1)** + +Process in the GGSN to retrieve routing information to establish a network-requested PDP context + +Signals to/from the left are to/from the application process in the GGSN; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> SendRoutingInfo[Send Routing Info for GPRS] + SendRoutingInfo --> OpenCnf[Receive_Open_Cnf] + OpenCnf --> WaitForRouteingInfo[Wait_For_Routeing_Info] : OK + OpenCnf --> PerformMAPVr[Perform MAP Vr dialogue] : Error + PerformMAPVr --> Idle2[Idle] + WaitForRouteingInfo --> Decision1{ } + Decision1 --> MAPUAbort[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Decision1 --> MAPNotice[MAP_NOTICE_ind] + Decision1 --> MAPSendRoutingInfoCnf[MAP_SEND_ROUTING_INFO_FOR_GPRS_cnf] + MAPNotice --> MAPCloseReq[MAP_CLOSE_req] + MAPCloseReq --> Decision2{ } + Decision2 --> SetNegativeResponse[Set negative response: System failure] : Provider Error, Data Error + Decision2 --> SendRoutingInfoNeg[Send Routing Info for GPRS negative response] : User Error + Decision2 --> SendRoutingInfoAck[Send Routing Info for GPRS ack] : OK + SetNegativeResponse --> SendRoutingInfoNeg + SendRoutingInfoNeg --> Idle3[Idle] + SendRoutingInfoAck --> Idle4[Idle] + +``` + +State transition diagram for SRI\_GPRS\_GGSN process. It starts at an initial state, goes to Idle, then Send Routing Info for GPRS. It then branches based on MAP messages (OPEN\_req, SEND\_ROUTING\_INFO\_FOR\_GPRS\_req, DELIMITER\_req). From Receive\_Open\_Cnf, it branches to Wait\_For\_Routeing\_Info (OK) or Perform MAP Vr dialogue (Error). Wait\_For\_Routeing\_Info leads to a decision point for MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind, MAP\_NOTICE\_ind, and MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_cnf. MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which then leads to a decision point for Provider Error, Data Error, User Error, and OK. Provider Error, Data Error, and User Error lead to Set negative response: System failure, which then leads to Send Routing Info for GPRS negative response and back to Idle. OK leads to Send Routing Info for GPRS ack and back to Idle. + +4435 + +4436 + +Figure 24.1/1: Process SRI\_GPRS\_GGSN + +process SRI\_GPRS\_HLR + +SRI\_GPRS\_HLR1(1) + +Process in the HLR to provide routing information to establish a network-requested PDP context + +Signals to/from the left are to/from the GGSN; signals to/from the right are to/from the GPRS application process in the HLR + +![State transition diagram for process SRI_GPRS_HLR. The process starts at an initial state leading to 'Idle'. From 'Idle', it receives an 'Open_Ind' signal. The 'Receive_Open_Ind' block has three outputs: 'OK' leading to 'Wait_For_Service_Indication', 'Error' leading back to 'Idle', and 'Vr' leading to 'Perform MAP Vr dialogue' which then returns to 'Idle'. From 'Wait_For_Service_Indication', there are three internal transitions: 'MAP_SEND_ROUTING_INFO_FOR_GPRS_ind' (left), 'MAP_P_ABORT_ind' (right), and 'MAP_NOTICE_ind' (right). 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' (right) which returns to 'Idle'. 'MAP_P_ABORT_ind' also leads to 'MAP_CLOSE_req' (right) which returns to 'Idle'. 'MAP_SEND_ROUTING_INFO_FOR_GPRS_ind' leads to 'Check_Indication'. 'Check_Indication' has 'OK' leading to 'Send Routing Info for GPRS' (left) and 'Error' leading to the bottom 'Idle' state. 'Send Routing Info for GPRS' (left) leads to 'Wait_For_Routing_Info'. From 'Wait_For_Routing_Info', there are three internal transitions: 'Send Routing Info for GPRS ack' (left), 'Send Routing Info for GPRS negative response' (right), and 'MAP_NOTICE_ind' (right). 'Send Routing Info for GPRS ack' (left) leads to 'Set Routing info' (left) which returns to the bottom 'Idle' state. 'Send Routing Info for GPRS negative response' (right) leads to 'Set User Error' (right) which returns to the bottom 'Idle' state. 'MAP_NOTICE_ind' (right) leads to 'MAP_CLOSE_req' (right) which returns to the bottom 'Idle' state. Additionally, 'MAP_P_ABORT_ind' (right) from 'Wait_For_Routing_Info' leads to a block with 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind' (right) which returns to the bottom 'Idle' state. Finally, 'MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp' and 'MAP_CLOSE_req' (left) lead to the bottom 'Idle' state.](b2108e34a59251458599a28c389bbcc4_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + state "Receive_Open_Ind" as Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Service_Indication : OK + Receive_Open_Ind --> Idle : Error + Receive_Open_Ind --> Perform_MAP_Vr_dialogue : Vr + state "Perform MAP Vr dialogue" as Perform_MAP_Vr_dialogue + Perform_MAP_Vr_dialogue --> Idle + state "Wait_For_Service_Indication" as Wait_For_Service_Indication + Wait_For_Service_Indication --> MAP_SEND_ROUTING_INFO_FOR_GPRS_ind : MAP_SEND_ROUTING_INFO_FOR_GPRS_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind : MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind : MAP_NOTICE_ind + state "MAP_SEND_ROUTING_INFO_FOR_GPRS_ind" as MAP_SEND_ROUTING_INFO_FOR_GPRS_ind + state "MAP_P_ABORT_ind" as MAP_P_ABORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_P_ABORT_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_SEND_ROUTING_INFO_FOR_GPRS_ind --> Check_Indication + state "Check_Indication" as Check_Indication + Check_Indication --> Send_Routing_Info_for_GPRS : OK + Check_Indication --> Idle : Error + state "Send Routing Info for GPRS" as Send_Routing_Info_for_GPRS + Send_Routing_Info_for_GPRS --> Wait_For_Routing_Info + state "Wait_For_Routing_Info" as Wait_For_Routing_Info + Wait_For_Routing_Info --> Send_Routing_Info_for_GPRS_ack : Send Routing Info for GPRS ack + Wait_For_Routing_Info --> Send_Routing_Info_for_GPRS_neg_resp : Send Routing Info for GPRS negative response + Wait_For_Routing_Info --> MAP_NOTICE_ind : MAP_NOTICE_ind + state "Send Routing Info for GPRS ack" as Send_Routing_Info_for_GPRS_ack + state "Send Routing Info for GPRS negative response" as Send_Routing_Info_for_GPRS_neg_resp + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + Send_Routing_Info_for_GPRS_ack --> Set_Routing_info : Set Routing info + Set_Routing_info --> Idle + Send_Routing_Info_for_GPRS_neg_resp --> Set_User_Error : Set User Error + Set_User_Error --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_CLOSE_req --> Idle + Wait_For_Routing_Info --> MAP_P_ABORT_ind : MAP_P_ABORT_ind + state "MAP_P_ABORT_ind" as MAP_P_ABORT_ind + MAP_P_ABORT_ind --> MAP_U_ABORT_ind_block : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as MAP_U_ABORT_ind_block + MAP_U_ABORT_ind_block --> Idle + MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp : MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp + MAP_CLOSE_req : MAP_CLOSE_req + MAP_SEND_ROUTING_INFO_FOR_GPRS_rsp --> Idle + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process SRI\_GPRS\_HLR. The process starts at an initial state leading to 'Idle'. From 'Idle', it receives an 'Open\_Ind' signal. The 'Receive\_Open\_Ind' block has three outputs: 'OK' leading to 'Wait\_For\_Service\_Indication', 'Error' leading back to 'Idle', and 'Vr' leading to 'Perform MAP Vr dialogue' which then returns to 'Idle'. From 'Wait\_For\_Service\_Indication', there are three internal transitions: 'MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_ind' (left), 'MAP\_P\_ABORT\_ind' (right), and 'MAP\_NOTICE\_ind' (right). 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' (right) which returns to 'Idle'. 'MAP\_P\_ABORT\_ind' also leads to 'MAP\_CLOSE\_req' (right) which returns to 'Idle'. 'MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_ind' leads to 'Check\_Indication'. 'Check\_Indication' has 'OK' leading to 'Send Routing Info for GPRS' (left) and 'Error' leading to the bottom 'Idle' state. 'Send Routing Info for GPRS' (left) leads to 'Wait\_For\_Routing\_Info'. From 'Wait\_For\_Routing\_Info', there are three internal transitions: 'Send Routing Info for GPRS ack' (left), 'Send Routing Info for GPRS negative response' (right), and 'MAP\_NOTICE\_ind' (right). 'Send Routing Info for GPRS ack' (left) leads to 'Set Routing info' (left) which returns to the bottom 'Idle' state. 'Send Routing Info for GPRS negative response' (right) leads to 'Set User Error' (right) which returns to the bottom 'Idle' state. 'MAP\_NOTICE\_ind' (right) leads to 'MAP\_CLOSE\_req' (right) which returns to the bottom 'Idle' state. Additionally, 'MAP\_P\_ABORT\_ind' (right) from 'Wait\_For\_Routing\_Info' leads to a block with 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind' (right) which returns to the bottom 'Idle' state. Finally, 'MAP\_SEND\_ROUTING\_INFO\_FOR\_GPRS\_rsp' and 'MAP\_CLOSE\_req' (left) lead to the bottom 'Idle' state. + +4437 + +4438 + +Figure 24.1/2: Process SRI\_GPRS\_HLR + +## 4439 24.2 Procedure for reporting failure to establish a network 4440 requested PDP context + +### 4441 24.2.1 Process in the GGSN + +4442 The MAP process in the GGSN to report the failure to establish a network requested PDP context is shown in figure +4443 24.2/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as +4444 follows: + +4445     Receive\_Open\_Cnf see clause 25.1.2; + +4446     Check\_Confirmation see clause 25.2.2. + +### 4447 24.2.2 Process in the HLR + +4448 The MAP process in the HLR to handle a notification from the GGSN that a network requested PDP context could not +4449 be established is shown in figure 24.2/2. The MAP process invokes macros not defined in this clause; the definitions of +4450 these macros can be found as follows: + +4451     Receive\_Open\_Ind see clause 25.1.1; + +4452     Check Indication see clause 25.2.1. + +![State transition diagram for process Failure_Report_GGSN. It starts at Idle, goes to Failure report, then to a state with MAP_OPEN_req, MAP_FAILURE_REPORT_req, and MAP_DELIMITER_req. It then receives an Open_Cnf and enters Wait_For_HLR_Response. From there, it can receive MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind (leading to Vr, Error), MAP_NOTICE_ind (leading to MAP_CLOSE_req), or MAP_FAILURE_REPORT_cnf (leading to Check Confirmation). Check Confirmation leads to either Set negative response: System failure (leading to Failure report negative response and Idle), or Failure report ack (leading to Idle). MAP_CLOSE_req also leads to either Set negative response: System failure or Idle based on Provider Error, Data Error or User Error.](0435bdd4c5e220acd2db04fce162b313_img.jpg) + +**process Failure\_Report\_GGSN** **FR\_GGSN1(1)** + +Process in the GGSN to report a failure to establish a network-requested PDP context + +Signals to/from the left are to/from the application process in the GGSN; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Failure_report: Failure report + Failure_report --> State1: MAP_OPEN_req, MAP_FAILURE_REPORT_req, MAP_DELIMITER_req + State1 --> Receive_Open_Cnf: Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Wait_For_HLR_Response --> State2: MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Wait_For_HLR_Response --> State3: MAP_NOTICE_ind + Wait_For_HLR_Response --> State4: MAP_FAILURE_REPORT_cnf + State2 --> Vr_Error: Vr, Error + State3 --> MAP_CLOSE_req: MAP_CLOSE_req + State4 --> Check_Confirmation: Check Confirmation + Check_Confirmation --> Set_Negative_Response: Set negative response: System failure + Check_Confirmation --> Failure_report_ack: Failure report ack + MAP_CLOSE_req --> Set_Negative_Response: Provider Error, Data Error + MAP_CLOSE_req --> Idle: User Error + Set_Negative_Response --> Failure_report_negative_response: Failure report negative response + Failure_report_negative_response --> Idle + Failure_report_ack --> Idle + +``` + +State transition diagram for process Failure\_Report\_GGSN. It starts at Idle, goes to Failure report, then to a state with MAP\_OPEN\_req, MAP\_FAILURE\_REPORT\_req, and MAP\_DELIMITER\_req. It then receives an Open\_Cnf and enters Wait\_For\_HLR\_Response. From there, it can receive MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind (leading to Vr, Error), MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req), or MAP\_FAILURE\_REPORT\_cnf (leading to Check Confirmation). Check Confirmation leads to either Set negative response: System failure (leading to Failure report negative response and Idle), or Failure report ack (leading to Idle). MAP\_CLOSE\_req also leads to either Set negative response: System failure or Idle based on Provider Error, Data Error or User Error. + +4453 + +4454 + +Figure 24.2/1: Process Failure\_Report\_GGSN + +![State transition diagram for process Failure_Report_HLR. The process starts at an initial state, goes to Idle, then receives an Open_Indication. From there, it can go to Wait_For_Service_Indication (OK path) or back to Idle (Vr, Error path). From Wait_For_Service_Indication, it branches into three paths: 1) MAP_FAILURE_REPORT_ind leads to Check_Indication, then either Failure report (OK) or Error. Failure report leads to Wait_For_Application_Response, which then branches into Failure report ack (leading to Idle), Failure report negative response (leading to Set User Error), or a response message (MAP_FAILURE_REPORT_rsp, MAP_CLOSE_req) leading to Idle. 2) MAP_P_ABORT_ind leads directly to Idle. 3) MAP_NOTICE_ind leads to MAP_CLOSE_req, which leads to Idle.](3b645d2a2a405391a3c5592e50cdb4ba_img.jpg) + +**process Failure\_Report\_HLR** **FR\_HLR1(1)** + +Process in the HLR to handle a failure report from the GGSN + +Signals to/from the left are to/from the GGSN; + signals to/from the right are to/from the GPRS application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Service_Indication: OK + Receive_Open_Ind --> Idle: Vr, Error + Wait_For_Service_Indication --> MAP_FAILURE_REPORT_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_FAILURE_REPORT_ind --> Check_Indication + Check_Indication --> Failure_report: OK + Check_Indication --> Error + Failure_report --> Wait_For_Application_Response + Wait_For_Application_Response --> Failure_report_ack + Wait_For_Application_Response --> Failure_report_negative_response + Wait_For_Application_Response --> MAP_FAILURE_REPORT_rsp + Failure_report_ack --> Idle + Failure_report_negative_response --> Set_User_Error + Set_User_Error --> Failure_report_ack + MAP_FAILURE_REPORT_rsp --> Idle + MAP_P_ABORT_ind --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process Failure\_Report\_HLR. The process starts at an initial state, goes to Idle, then receives an Open\_Indication. From there, it can go to Wait\_For\_Service\_Indication (OK path) or back to Idle (Vr, Error path). From Wait\_For\_Service\_Indication, it branches into three paths: 1) MAP\_FAILURE\_REPORT\_ind leads to Check\_Indication, then either Failure report (OK) or Error. Failure report leads to Wait\_For\_Application\_Response, which then branches into Failure report ack (leading to Idle), Failure report negative response (leading to Set User Error), or a response message (MAP\_FAILURE\_REPORT\_rsp, MAP\_CLOSE\_req) leading to Idle. 2) MAP\_P\_ABORT\_ind leads directly to Idle. 3) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which leads to Idle. + +4455 + +4456 + +**Figure 24.2/2: Process Failure\_Report\_HLR** + +4457 **24.3** Procedure for reporting that an MS has become reachable +4458 for GPRS + +4459 **24.3.1** Process in the HLR + +4460 The MAP process in the HLR to report that an MS is reachable for GPRS is shown in figure 24.3/1. The MAP process +4461 invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4462     Receive\_Open\_Cnf see clause 25.1.2; + +4463     Check\_Confirmation see clause 25.2.2. + +4464 **24.3.2** Process in the GGSN for Note Ms Present For Gprs + +4465 The MAP process in the GGSN to handle a notification that the subscriber is present for GPRS again is shown in figure +4466 24.3/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as +4467 follows: + +4468     Receive\_Open\_Ind see clause 25.1.1; + +4469     Check\_Indication see clause 25.2.1. + +![State transition diagram for process Note_MS_Present_for_GPRS_HLR. The process starts at an Idle state, transitions to 'Note MS present for GPRS', then to a state where it sends MAP_OPEN_req, MAP_NOTE_MS_PRESENT_FOR_GPRS_req, and MAP_DELIMITER_req. It then receives an Open_Cnf. If OK, it goes to 'Wait_For_GGSN_Response'. From there, it can receive MAP_U_ABORT_ind, MAP_P_ABORT_ind, or MAP_CLOSE_ind (leading to a negative response), MAP_NOTICE_ind (leading to a close request), or MAP_NOTE_MS_PRESENT_FOR_GPRS_cnf (leading to a confirmation check). A confirmation check can result in a negative response, a provider/data error, a user error, or an OK (leading to an ack and back to Idle).](672e2bbc82c7be834d21e0dd0f839194_img.jpg) + +**process Note\_MS\_Present\_for\_GPRS\_HLR** **NMP\_GPRS\_HLR1(1)** + +Process in the HLR to report to the GGSN that an MS is reachable for GPRS + +Signals to/from the left are to/from the GGSN; signals to/from the right are to/from the GPRS application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Note_MS_present_for_GPRS : Note MS present for GPRS + Note_MS_present_for_GPRS --> Send_Requests : MAP_OPEN_req, MAP_NOTE_MS_PRESENT_FOR_GPRS_req, MAP_DELIMITER_req + Send_Requests --> Receive_Open_Cnf : Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_GGSN_Response : OK + Receive_Open_Cnf --> Vr_Error : Vr, Error + Wait_For_GGSN_Response --> MAP_U_ABORT_ind : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Wait_For_GGSN_Response --> MAP_NOTICE_ind : MAP_NOTICE_ind + Wait_For_GGSN_Response --> MAP_NOTE_MS_PRESENT_FOR_GPRS_cnf : MAP_NOTE_MS_PRESENT_FOR_GPRS_cnf + MAP_U_ABORT_ind --> Set_Negative_Response : Set negative response: System failure + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_CLOSE_req --> Set_Negative_Response : Provider Error, Data Error + MAP_CLOSE_req --> Note_MS_present_for_GPRS_ack : OK + MAP_NOTE_MS_PRESENT_FOR_GPRS_cnf --> Check_Confirmation : Check Confirmation + Check_Confirmation --> Set_Negative_Response : User Error + Check_Confirmation --> Note_MS_present_for_GPRS_ack : OK + Set_Negative_Response --> Note_MS_present_for_GPRS_neg : Note MS present for GPRS negative response + Note_MS_present_for_GPRS_neg --> Idle + Note_MS_present_for_GPRS_ack --> Idle + +``` + +State transition diagram for process Note\_MS\_Present\_for\_GPRS\_HLR. The process starts at an Idle state, transitions to 'Note MS present for GPRS', then to a state where it sends MAP\_OPEN\_req, MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS\_req, and MAP\_DELIMITER\_req. It then receives an Open\_Cnf. If OK, it goes to 'Wait\_For\_GGSN\_Response'. From there, it can receive MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, or MAP\_CLOSE\_ind (leading to a negative response), MAP\_NOTICE\_ind (leading to a close request), or MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS\_cnf (leading to a confirmation check). A confirmation check can result in a negative response, a provider/data error, a user error, or an OK (leading to an ack and back to Idle). + +4470 + +4471 + +**Figure 24.3/1: Process Note\_MS\_Present\_For\_GPRS\_HLR** + +![State transition diagram for process Note_MS_Present_For_GPRS_GGSN. It starts at Idle, receives an Open indication, and then branches based on OK or Vr, Error. The OK path leads to Wait_For_Service_Indication, which then branches into three paths: MAP_NOTE_MS_PRESENT_FOR_GPRS_ind (leading to Check_Indication and then Note MS present for GPRS), MAP_P_ABORT_ind (leading to Idle), and MAP_NOTICE_ind (leading to MAP_CLOSE_req and then Idle). The Note MS present for GPRS path leads to Wait_For_Application_Response, which branches into Note MS present for GPRS ack (leading to Set Routing info), Note MS present for GPRS negative response (leading to Set User Error), and a combined path for MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind (leading to MAP_CLOSE_req and then Idle). Both Set Routing info and Set User Error lead to a merge point before sending a response. The response is MAP_NOTE_MS_PRESENT_FOR_GPRS_rsp and MAP_CLOSE_req, leading back to Idle. The initial Idle state also has a transition to Idle on Vr, Error.](aa35a318211516e2ee82c0634445520d_img.jpg) + +**process Note\_MS\_Present\_For\_GPRS\_GGSN** **NMP\_GPRS\_GGSN1(1)** + +Process in the GGSN to handle a notification that the MS is reachable for GPRS + +Signals to/from the left are to/from the application process in the GGSN; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_ind + Receive_Open_ind --> Wait_For_Service_Indication: OK + Receive_Open_ind --> Idle: Vr, Error + Wait_For_Service_Indication --> MAP_NOTE_MS_PRESENT_FOR_GPRS_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + MAP_NOTE_MS_PRESENT_FOR_GPRS_ind --> Check_Indication + Check_Indication --> Note_MS_present_for_GPRS: OK + Check_Indication --> [*]: Error + Note_MS_present_for_GPRS --> Wait_For_Application_Response + Wait_For_Application_Response --> Note_MS_present_for_GPRS_ack + Wait_For_Application_Response --> Note_MS_present_for_GPRS_negative_response + Wait_For_Application_Response --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind + Note_MS_present_for_GPRS_ack --> Set_Routing_info + Note_MS_present_for_GPRS_negative_response --> Set_User_Error + Set_Routing_info --> Merge + Set_User_Error --> Merge + Merge --> MAP_NOTE_MS_PRESENT_FOR_GPRS_rsp_MAP_CLOSE_req + MAP_NOTE_MS_PRESENT_FOR_GPRS_rsp_MAP_CLOSE_req --> Idle + MAP_P_ABORT_ind --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process Note\_MS\_Present\_For\_GPRS\_GGSN. It starts at Idle, receives an Open indication, and then branches based on OK or Vr, Error. The OK path leads to Wait\_For\_Service\_Indication, which then branches into three paths: MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS\_ind (leading to Check\_Indication and then Note MS present for GPRS), MAP\_P\_ABORT\_ind (leading to Idle), and MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req and then Idle). The Note MS present for GPRS path leads to Wait\_For\_Application\_Response, which branches into Note MS present for GPRS ack (leading to Set Routing info), Note MS present for GPRS negative response (leading to Set User Error), and a combined path for MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind (leading to MAP\_CLOSE\_req and then Idle). Both Set Routing info and Set User Error lead to a merge point before sending a response. The response is MAP\_NOTE\_MS\_PRESENT\_FOR\_GPRS\_rsp and MAP\_CLOSE\_req, leading back to Idle. The initial Idle state also has a transition to Idle on Vr, Error. + +4472 + +4473 + +Figure 24.3/2: Process Note\_MS\_Present\_For\_GPRS\_GGSN + +--- + +## 4474 24A CSE interrogation and control of subscriber data + +### 4475 24A.1 General + +4476 The MAP procedures for interrogation and control of subscriber data are used to allow the CSE: + +- 4477 - to retrieve subscriber data from the HLR; +- 4478 - to modify subscriber data in the HLR; +- 4479 - to receive notification from the HLR when there is a change in subscriber data; +- 4480 - to request information about the location of a subscriber from the HLR or the GMLC; +- 4481 - to request information about the state of a subscriber from the HLR. + +4482 The following application context refers to a complex MAP user consisting of several processes: + +- 4483 - **anyTimeInfoHandlingContext** + +4484 This application context needs a co-ordinating process in the HLR. + +4485 The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +4486     Receive\_Open\_Ind see clause 25.1.1; + +4487 The Any Time Info Handling Co-ordinator process in the HLR is shown in figure 24A.1/1. + +![State transition diagram for process Co_ATIH_HLR. The process starts at an initial state, goes to 'Null', then receives an 'Open_ind' (referencing Figure 25.1/1). From 'Receive_Open_ind', an 'OK' response leads to 'Wait_For_Service_Primitive', while a 'Vr, Error' leads to another 'Null' state. 'Wait_For_Service_Primitive' branches into four parallel paths: 1) 'MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind' leads to 'ATSI_HLR' and then to another 'MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind' state, which ends at 'Null'. 2) 'MAP_ANY_TIME_MODIFICATION_ind' leads to 'ATM_HLR' and then to another 'MAP_ANY_TIME_MODIFICATION_ind' state, which leads to 'Relay_Info'. 3) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which then leads to 'Null'. 4) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to a state that also leads to 'Null'. All four paths converge to a 'Relay_Info' state. From 'Relay_Info', the process branches into four more parallel paths: 1) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to a state that ends at 'Null'. 2) A state with '*' leads to another state with '-' which ends at 'Relay_Info'. 3) A state with 'MAP_U_ABORT_req, MAP_CLOSE_req' leads to a state with '-' which ends at 'Null'. 4) A state with '*' leads to another state with '-' which ends at 'Relay_Info'.](1796f4a3ab45e16480c90d3cfb0d35b2_img.jpg) + +**process Co\_ATIH\_HLR** **Co\_ATIH\_HLR1(1)** + +Co-ordinating process in the HLR + to handle a dialogue opening request + using the application context + anyTimeInfoHandlingContext + +Signals to/from the left + are to/from the gsmSCF; + signals to/from the right + are to/from the child process + +``` + +stateDiagram-v2 + [*] --> Null1[Null] + Null1 --> Receive_Open_ind + Receive_Open_ind --> Null2[Null] : Vr, Error + Receive_Open_ind --> Wait_For_Service_Primitive : OK + Wait_For_Service_Primitive --> MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind1[MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind] + Wait_For_Service_Primitive --> MAP_ANY_TIME_MODIFICATION_ind1[MAP_ANY_TIME_MODIFICATION_ind] + Wait_For_Service_Primitive --> MAP_NOTICE_ind + Wait_For_Service_Primitive --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind1 --> ATSI_HLR + ATSI_HLR --> MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind2[MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind] + MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind2 --> Null3[Null] + MAP_ANY_TIME_MODIFICATION_ind1 --> ATM_HLR + ATM_HLR --> MAP_ANY_TIME_MODIFICATION_ind2[MAP_ANY_TIME_MODIFICATION_ind] + MAP_ANY_TIME_MODIFICATION_ind2 --> Relay_Info1[Relay_Info] + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Null4[Null] + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind --> Null5[Null] + Null3 --> Relay_Info1 + Null4 --> Relay_Info1 + Null5 --> Relay_Info1 + Relay_Info1 --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind3[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Relay_Info1 --> Star1[*] + Relay_Info1 --> MAP_U_ABORT_req_MAP_CLOSE_req[MAP_U_ABORT_req, MAP_CLOSE_req] + Relay_Info1 --> Star2[*] + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind3 --> Dash1[-] + Dash1 --> Null6[Null] + Star1 --> Dash2[-] + Dash2 --> Relay_Info2[Relay_Info] + MAP_U_ABORT_req_MAP_CLOSE_req --> Dash3[-] + Dash3 --> Null7[Null] + Star2 --> Dash4[-] + Dash4 --> Relay_Info3[Relay_Info] + +``` + +State transition diagram for process Co\_ATIH\_HLR. The process starts at an initial state, goes to 'Null', then receives an 'Open\_ind' (referencing Figure 25.1/1). From 'Receive\_Open\_ind', an 'OK' response leads to 'Wait\_For\_Service\_Primitive', while a 'Vr, Error' leads to another 'Null' state. 'Wait\_For\_Service\_Primitive' branches into four parallel paths: 1) 'MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION\_ind' leads to 'ATSI\_HLR' and then to another 'MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION\_ind' state, which ends at 'Null'. 2) 'MAP\_ANY\_TIME\_MODIFICATION\_ind' leads to 'ATM\_HLR' and then to another 'MAP\_ANY\_TIME\_MODIFICATION\_ind' state, which leads to 'Relay\_Info'. 3) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which then leads to 'Null'. 4) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to a state that also leads to 'Null'. All four paths converge to a 'Relay\_Info' state. From 'Relay\_Info', the process branches into four more parallel paths: 1) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to a state that ends at 'Null'. 2) A state with '\*' leads to another state with '-' which ends at 'Relay\_Info'. 3) A state with 'MAP\_U\_ABORT\_req, MAP\_CLOSE\_req' leads to a state with '-' which ends at 'Null'. 4) A state with '\*' leads to another state with '-' which ends at 'Relay\_Info'. + +4488 + +4489 + +Figure 24A.1/1: Process Co\_ATIH\_HLR + +## 24A.2 Any Time Subscription Interrogation procedure + +### 24A.2.1 General + +The message flow for successful retrieval of subscription information related to an any time subscription interrogation from the CAMEL server are shown in figure 24A.1/1. In an IP Multimedia Core Network, an IM-SSF can take on the role of a gsmSCF for this procedure (see 3GPP TS 23.278 [125]). + +![Sequence diagram showing the message flow for any time subscription interrogation between gsmSCF and HLR.](43cfb9718d89aae4f22d31e2cdc704f1_img.jpg) + +``` +sequenceDiagram + participant gsmSCF + participant HLR + Note right of gsmSCF: MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION + gsmSCF->>HLR: MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION + Note left of HLR: MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION ack + HLR-->>gsmSCF: MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION ack +``` + +The diagram illustrates a sequence of messages between a gsmSCF and an HLR. The gsmSCF sends a 'MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION' message to the HLR, and the HLR responds with a 'MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION ack' message. The messages are shown in rectangular boxes with arrows indicating the direction of the flow. + +Sequence diagram showing the message flow for any time subscription interrogation between gsmSCF and HLR. + +4495 + +4496 **Figure 24A.2/1: Message flow for any time subscription interrogation** + +4497 The following MAP service is used to retrieve requested information: + +4498 `MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION` see clause 8.11.3. + +### 24A.2.2 Process in the gsmSCF + +The MAP process in the gsmSCF to obtain subscription information in response to a request from the application process in the gsmSCF is shown in figure 24A.2/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4503 `Receive_Open_Cnf` see clause 25.1.2; + +4504 `Check_Confirmation` see clause 25.2.2 + +### 24A.2.3 Process in the HLR + +The MAP process in the HLR to provide subscription information in response to an interrogation from the CAMEL server is shown in figure 24A.2/3. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found as follows: + +4509 `Check_Indication` see clause 25.2.2 + +If the `MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION` service response cannot be carried in a single TC-Result component, it is carried in one or more TC-Result-NL components (each sent in a TC-CONTINUE), followed by a TC-Result-L component in a TC-END message. + +![State transition diagram for process ATSI_gsmSCF. It starts at an initial state, goes to Idle, then handles a subscription request by sending MAP_OPEN_req and waiting for a response. From the response, it branches based on OK, Vr, Error, MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_cnf, MAP_NOTICE_ind, or MAP_P_ABORT_ind/MAP_U_ABORT_ind/MAP_CLOSE_ind. Each branch leads to either a final Idle state, a negative response, or a system failure state.](69a9920131a220478b8197986108a334_img.jpg) + +**process ATSI\_gsmSCF** **ATSI\_SCF1(1)** + +Process in the gsmSCF to retrieve subscription information from the HLR + +Signals to/from the left are to/from the application process in the gsmSCF; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Request{Any time subscription interrogation request} + Request --> SendReq[MAP_OPEN_req, MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_req, MAP_DELIMITER_req] + SendReq --> ReceiveCnf[Receive_Open_Cnf] + ReceiveCnf --> WaitForResponse[Wait_For_HLR_Response] + WaitForResponse --> OK + WaitForResponse --> VrError((1)) + WaitForResponse --> Cnf{MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_cnf} + WaitForResponse --> Notice{MAP_NOTICE_ind} + WaitForResponse --> AbortClose{MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind} + Cnf --> CheckConfirmation[Check Confirmation] + CheckConfirmation --> OK2[OK] + CheckConfirmation --> UserError[User Error] + CheckConfirmation --> ProviderError[Provider Error, Data Error] + OK2 --> Ack{Any time subscription interrogation ack} + Ack --> Idle2[Idle] + UserError --> NegativeResponse1{Any time subscription interrogation negative response} + NegativeResponse1 --> Idle3[Idle] + ProviderError --> VrError2((1)) + Notice --> CloseReq[MAP_CLOSE_req] + CloseReq --> AbortClose + AbortClose --> SetNegativeResponse[Set negative response: System failure] + SetNegativeResponse --> NegativeResponse2{Any time subscription interrogation negative response} + NegativeResponse2 --> Idle4[Idle] + +``` + +State transition diagram for process ATSI\_gsmSCF. It starts at an initial state, goes to Idle, then handles a subscription request by sending MAP\_OPEN\_req and waiting for a response. From the response, it branches based on OK, Vr, Error, MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION\_cnf, MAP\_NOTICE\_ind, or MAP\_P\_ABORT\_ind/MAP\_U\_ABORT\_ind/MAP\_CLOSE\_ind. Each branch leads to either a final Idle state, a negative response, or a system failure state. + +4513 + +4514 + +Figure 24A.2/2: Process ATSI\_gsmSCF + +![State transition diagram for process ATSI_HLR. The process starts at an initial state, waits for a service indication, receives a MAP_ANY_TIME_SUBSCRIPTION_INTERROGATION_ind, checks the indication, and then either sends a request or an error. It then waits for an application response and handles it based on whether it's an ack, error, or other indication.](3375413f96777e748d6bb7381255b459_img.jpg) + +**process ATSI\_HLR** **ATSI\_HLR1(1)** + +Process in the HLR to handle a request from the gsmSCF for subscription information + +Signals to/from the left are to/from the gsmSCF; signals to/from the right are to/from the subscriber data management application in the HLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_Service_Indication + state "Wait_For_Service_Indication" as Wait_For_Service_Indication + state "Check_Indication" as Check_Indication + state "Any Time Subscription Interrogation request" as Any_Time_Subscription_Interrogation_request + state "Error" as Error + state "Wait_For_Application_Response" as Wait_For_Application_Response + state "Set result" as Set_result + state "Set User Error" as Set_User_Error + state "MAP_CLOSE_req" as MAP_CLOSE_req + + Wait_For_Service_Indication --> Check_Indication + Check_Indication --> Any_Time_Subscription_Interrogation_request : OK + Check_Indication --> Error : Error + Error --> [*] + Any_Time_Subscription_Interrogation_request --> Wait_For_Application_Response + Wait_For_Application_Response --> Set_result + Wait_For_Application_Response --> Set_User_Error + Wait_For_Application_Response --> MAP_CLOSE_req + Set_result --> [*] + Set_User_Error --> [*] + MAP_CLOSE_req --> [*] + +``` + +The diagram illustrates the state transitions for the **ATSI\_HLR** process. It begins at an initial state, transitioning to **Wait\_For\_Service\_Indication**. From there, it moves to **Check\_Indication**. A transition labeled **OK** leads to **Any Time Subscription Interrogation request**, while an **Error** transition leads to an error state marked with a circle containing '1'. The process then enters **Wait\_For\_Application\_Response**. From this state, three transitions are possible: **Set result**, **Set User Error**, and **MAP\_CLOSE\_req**. Both **Set result** and **Set User Error** lead to the final state (marked with an 'X'), while **MAP\_CLOSE\_req** also leads to the final state. A note indicates that signals to/from the left are to/from the gsmSCF, and signals to/from the right are to/from the subscriber data management application in the HLR. + +State transition diagram for process ATSI\_HLR. The process starts at an initial state, waits for a service indication, receives a MAP\_ANY\_TIME\_SUBSCRIPTION\_INTERROGATION\_ind, checks the indication, and then either sends a request or an error. It then waits for an application response and handles it based on whether it's an ack, error, or other indication. + +4515 + +4516 + +Figure 24A.2/3: Process ATSI\_HLR + +## 24A.3 Any Time Modification procedure + +### 24A.3.1 General + +The message flow for successful modification of subscription information related to an any time modification request from the CAMEL server is shown in figure 24A.3/1 + +![Sequence diagram showing the message flow for any time modification between gsmSCF and HLR. The gsmSCF sends a MAP_ANY_TIME_MODIFICATION message to the HLR, and the HLR responds with a MAP_ANY_TIME_MODIFICATION ack.](141512f04b9aa27a5291824b4ae7c2d8_img.jpg) + +``` +sequenceDiagram + participant gsmSCF + participant HLR + Note right of gsmSCF: MAP_ANY_TIME_MODIFICATION + gsmSCF->>HLR: MAP_ANY_TIME_MODIFICATION + Note left of HLR: MAP_ANY_TIME_MODIFICATION ack + HLR-->>gsmSCF: MAP_ANY_TIME_MODIFICATION ack +``` + +Sequence diagram showing the message flow for any time modification between gsmSCF and HLR. The gsmSCF sends a MAP\_ANY\_TIME\_MODIFICATION message to the HLR, and the HLR responds with a MAP\_ANY\_TIME\_MODIFICATION ack. + +4521 + +4522 + +**Figure 24A.3/1: Message flow for any time modification** + +The following MAP service is used to modify subscription information: + +MAP\_ANY\_TIME\_MODIFICATION see clause 8.11.4. + +### 24A.3.2 Process in the gsmSCF + +The MAP process in the gsmSCF to modify subscription information in response to a request from the application process in the gsmSCF is shown in figure 24A.3/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2 + +### 24A.3.3 Process in the HLR + +The MAP process in the HLR to modify subscriber information in response to a modification request from the CAMEL server is shown in figure 24A.3/3. The MAP process invokes a macro and a process not defined in this clause; the definitions of these can be found as follows: + +Check\_Indication see clause 25.2.2; + +Insert\_Subs\_Data\_Stand\_Alone\_HLR see clause 25.7.3; + +If the macro takes the OK exit, the MAP process waits for a service indication. + +If the MAP\_ANY\_TIME\_MODIFICATION service response cannot be carried in a single TC-Result component, it is carried in one or more TC-Result-NL components (each sent in a TC-CONTINUE), followed by a TC-Result-L component in a TC-END message. + +If the serving node (VLR or SGSN) is to be updated after the modification, the MAP process creates an instance of the appropriate process (Insert\_Subs\_Data\_Stand\_Alone\_HLR for VLR update, Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR for SGSN update). + +![State transition diagram for process ATM_gsmSCF. The process starts at an initial state, goes to Idle, then receives an 'Any time modification request'. It sends MAP_OPEN_req, MAP_ANY_TIME_MODIFICATION_req, and MAP_DELIMITER_req to the HLR. It receives an Open_Cnf. If OK, it waits for an HLR response. If Vr, Error, it goes to connector 1. From 'Wait For_HLR_Response', it branches: 1) MAP_ANY_TIME_MODIFICATION_cnf to application, then Check Confirmation. If OK, it sends 'Any time modification ack' to application and returns to Idle. If User Error, it sends 'Any time modification negative response' to application and returns to Idle. If Provider Error, Data Error, it goes to connector 1. 2) MAP_NOTICE_ind to HLR, then MAP_CLOSE_req to HLR. 3) MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind to application. A merge point for connectors 1 and MAP_CLOSE_req leads to 'Set negative response: System failure', which then sends 'Any time modification negative response' to application and returns to Idle.](ac78f53876459c8656e94fd118f9603a_img.jpg) + +**process ATM\_gsmSCF** **ATM\_SCF1(1)** + +Process in the gsmSCF to modify subscription information in the HLR + +Signals to/from the left are to/from the application process in the gsmSCF; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Any_time_modification_request {Any time modification request} + Any_time_modification_request --> Outgoing {MAP_OPEN_req, MAP_ANY_TIME_MODIFICATION_req, MAP_DELIMITER_req} + Outgoing --> Receive_Open_Cnf {Receive_Open_Cnf} + Receive_Open_Cnf --> Wait_For_HLR_Response {Wait For_HLR_Response} + Wait_For_HLR_Response --> MAP_ANY_TIME_MODIFICATION_cnf {MAP_ANY_TIME_MODIFICATION_cnf} + Wait_For_HLR_Response --> MAP_NOTICE_ind {MAP_NOTICE_ind} + Wait_For_HLR_Response --> MAP_P_ABORT_ind {MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind} + Wait_For_HLR_Response --> Vr_Error {Vr, Error} --> 1 + MAP_ANY_TIME_MODIFICATION_cnf --> Check Confirmation {Check Confirmation} + Check Confirmation --> OK_1 {OK} + Check Confirmation --> User_Error {User Error} + Check Confirmation --> Provider_Error {Provider Error, Data Error} --> 1 + OK_1 --> Any_time_modification_ack {Any time modification ack} + Any_time_modification_ack --> Idle_1 {Idle} + User_Error --> Any_time_modification_negative_response_1 {Any time modification negative response} + Any_time_modification_negative_response_1 --> Idle_2 {Idle} + MAP_NOTICE_ind --> MAP_CLOSE_req {MAP_CLOSE_req} + MAP_P_ABORT_ind --> Merge {Merge} + MAP_CLOSE_req --> Merge + Merge --> Set_negative_response {Set negative response: System failure} + Set_negative_response --> Any_time_modification_negative_response_2 {Any time modification negative response} + Any_time_modification_negative_response_2 --> Idle_3 {Idle} + +``` + +State transition diagram for process ATM\_gsmSCF. The process starts at an initial state, goes to Idle, then receives an 'Any time modification request'. It sends MAP\_OPEN\_req, MAP\_ANY\_TIME\_MODIFICATION\_req, and MAP\_DELIMITER\_req to the HLR. It receives an Open\_Cnf. If OK, it waits for an HLR response. If Vr, Error, it goes to connector 1. From 'Wait For\_HLR\_Response', it branches: 1) MAP\_ANY\_TIME\_MODIFICATION\_cnf to application, then Check Confirmation. If OK, it sends 'Any time modification ack' to application and returns to Idle. If User Error, it sends 'Any time modification negative response' to application and returns to Idle. If Provider Error, Data Error, it goes to connector 1. 2) MAP\_NOTICE\_ind to HLR, then MAP\_CLOSE\_req to HLR. 3) MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind to application. A merge point for connectors 1 and MAP\_CLOSE\_req leads to 'Set negative response: System failure', which then sends 'Any time modification negative response' to application and returns to Idle. + +4544 + +4545 + +Figure 24A.3/2: Process ATM\_gsmSCF + +![Flowchart for process ATM_HLR. The process starts with an initial node, followed by 'Wait_For_Service_Indication'. It then receives 'MAP_ANY_TIME_MODIFICATION_ind' from the right. A 'Check_Indication' block follows, with 'OK' leading to 'Any Time Modification request' and 'Error' leading to connector '1'. The request leads to 'Wait_For_Application_Response'. From there, four paths emerge: 1) 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' leading to an exit; 2) 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req' and then an exit; 3) 'Any Time Modification ack' leading to 'Set result'; 4) 'Any Time Modification error' leading to 'Set User Error'. Both 'Set result' and 'Set User Error' lead to a merge point. From the merge point, 'MAP_ANY_TIME_MODIFICATION_rsp' and 'MAP_CLOSE_req' are sent to the right. A decision 'VLR/SGSN update required?' follows. If 'No', it leads to an exit. If 'Yes', it leads to 'Insert Subs_Data Stand_Alone_HLR', which is associated with a note 'Insert_GPRS_Subs_Data_Stand_Alone_HLR for SGSN update'. This path then leads to an exit.](ec494612ff3d129d88e4e3acb82e1d1e_img.jpg) + +**process ATM\_HLR** **ATM\_HLR1(1)** + +Process in the HLR to handle a request from the gsmSCF to modify subscription information + +Signals to/from the left are to/from the gsmSCF; signals to/from the right are to/from the subscriber data management application in the HLR + +``` + +graph TD + Start([ ]) --> WaitService[Wait_For_Service_Indication] + WaitService --> In1{{ }} + In1 -- "MAP_ANY_TIME_MODIFICATION_ind" --> Check[Check_Indication] + Check -- OK --> Request{Any Time Modification request} + Check -- Error --> C1((1)) + Request --> WaitApp[Wait_For_Application_Response] + WaitApp --> In2{{ }} + In2 -- "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" --> Exit1[ ] + In2 -- "MAP_NOTICE_ind" --> CloseReq1{MAP_CLOSE_req} --> Exit2[ ] + In2 -- "Any Time Modification ack" --> SetResult[Set result] + In2 -- "Any Time Modification error" --> SetUserError[Set User Error] + SetResult --> Merge{{ }} + SetUserError --> Merge + Merge -- "MAP_ANY_TIME_MODIFICATION_rsp +MAP_CLOSE_req" --> In3{{ }} + In3 --> Decision{VLR/SGSN update required?} + Decision -- No --> Exit3[ ] + Decision -- Yes --> Insert[Insert Subs_Data Stand_Alone_HLR] + Insert -.-> Note["Insert_GPRS_Subs_Data_Stand_Alone_HLR for SGSN update"] + Insert --> Exit4[ ] + +``` + +Flowchart for process ATM\_HLR. The process starts with an initial node, followed by 'Wait\_For\_Service\_Indication'. It then receives 'MAP\_ANY\_TIME\_MODIFICATION\_ind' from the right. A 'Check\_Indication' block follows, with 'OK' leading to 'Any Time Modification request' and 'Error' leading to connector '1'. The request leads to 'Wait\_For\_Application\_Response'. From there, four paths emerge: 1) 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' leading to an exit; 2) 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req' and then an exit; 3) 'Any Time Modification ack' leading to 'Set result'; 4) 'Any Time Modification error' leading to 'Set User Error'. Both 'Set result' and 'Set User Error' lead to a merge point. From the merge point, 'MAP\_ANY\_TIME\_MODIFICATION\_rsp' and 'MAP\_CLOSE\_req' are sent to the right. A decision 'VLR/SGSN update required?' follows. If 'No', it leads to an exit. If 'Yes', it leads to 'Insert Subs\_Data Stand\_Alone\_HLR', which is associated with a note 'Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR for SGSN update'. This path then leads to an exit. + +4546 + +4547 + +Figure 24A.3/3: Process ATM\_HLR + +## 24A.4 Subscriber Data Modification Notification procedure + +### 24A.4.1 General + +The Subscriber Data Modification Notification procedure is used to notify a gsmSCF about the modification of subscriber data. In an IP Multimedia Core Network, an IM-SSF can take on the role of a gsmSCF for this procedure. + +The stage 2 specification for Subscriber Data Modification Notification is in 3GPP TS 23.078 [98] and 3GPP TS 23.278 [125]. The interworking between the MAP signalling procedures and the Subscriber Data Modification Notification procedures for each entity (HLR, gsmSCF) is shown by the transfer of signals between these processes. + +The following services are used: + +![Sequence diagram showing message flow between HLR and gsmSCF for subscriber data modification notification.](5446756274ab50ff60d829395bd1136e_img.jpg) + +``` +sequenceDiagram + participant HLR + participant gsmSCF + Note right of HLR: MAP_NOTE_SUBSCRIBER_DATA_MODIFIED + HLR->>gsmSCF: MAP_NOTE_SUBSCRIBER_DATA_MODIFIED + Note left of gsmSCF: MAP_NOTE_SUBSCRIBER_DATA_MODIFIED ack + gsmSCF->>HLR: MAP_NOTE_SUBSCRIBER_DATA_MODIFIED ack +``` + +Sequence diagram showing message flow between HLR and gsmSCF for subscriber data modification notification. + +4556 + +4557 + +**Figure 24A.4/1: Message flow for subscriber data modification notification** + +The following MAP service is used to send the notification to the gsmSCF: + +MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED see clause 8.11.5. + +### 24A.4.2 Process in the HLR + +The MAP process in the HLR to send modified data to the gsmSCF is shown in figure 24A.4/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2. + +If the required information cannot be carried in a single MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED service request, the HLR segments the information into two or more requests. The "All Information Sent" parameter is omitted from each request except the last. + +Sheet 2: If the MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED service request contained the "All Information Sent" parameter, the test "All information sent" takes the "Yes" exit. + +### 24A.4.3 Process in the gsmSCF + +The MAP process in the gsmSCF to handle a notification to the gsmSCF of change of subscriber data is shown in figure 24A.4/3. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1; + +Check\_Indication see clause 25.2.1 + +4576 If the MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED service indication contained the "All Information Sent" +4577 parameter, the test "All information sent" takes the "Yes" exit. + +4578 If the test "All information sent" takes the "No" exit, the MAP process stores the data received in the +4579 MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED service indication. If the test "All information sent" takes the "Yes" +4580 exit, the MAP process assembles the data received in all the MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED service +4581 indications received in the dialogue and sends the assembled data to the application process in the gsmSCF. + +![Flowchart for process NSDC_HLR. It starts at an initial state, goes to Idle, then Notify Subscriber Data change. A decision diamond asks 'Segmentation required?'. If Yes, it goes to 'Set: All Information Sent'. If No, it goes to a merge point. Both paths lead to a process block with MAP_OPEN_req, MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_req, and MAP_DELIMITER_req. This is followed by 'Receive_Open_Cnf'. From there, an 'OK' path leads to 'Wait_For_gsmSCF_Response' and a 'Vr, Error' path leads to 'Set negative response: System failure', which then leads to 'Notify Subscriber Data Change negative response' and finally 'Idle'.](0a2bc9e00f84ccec4da49716d4a590ee_img.jpg) + +process NSDC\_HLR + +NSDC\_HLR1(2) + +Process in the HLR to notify the gsmSCF that subscriber data have changed + +Signals to/from the left are to/from the application process in the HLR (see 3GPP TS 23.078 or 3GPP TS 23.278); + Signals to/from the right are to/from the gsmSCF + +``` + +graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 --> Notify[Notify Subscriber Data change] + Notify --> Decision{Segmentation required?} + Decision -- Yes --> Set[Set: All Information Sent] + Decision -- No --> Merge(( )) + Set --> Merge + Merge --> MAP[MAP_OPEN_req +MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_req +MAP_DELIMITER_req] + MAP --> Receive[Receive_Open_Cnf] + Receive -- OK --> Wait[Wait_For_gsmSCF_Response] + Receive -- Vr, Error --> SetNeg[Set negative response: System failure] + SetNeg --> Merge2(( )) + Merge2 --> NotifyNeg[Notify Subscriber Data Change negative response] + NotifyNeg --> Idle2([Idle]) + +``` + +Flowchart for process NSDC\_HLR. It starts at an initial state, goes to Idle, then Notify Subscriber Data change. A decision diamond asks 'Segmentation required?'. If Yes, it goes to 'Set: All Information Sent'. If No, it goes to a merge point. Both paths lead to a process block with MAP\_OPEN\_req, MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED\_req, and MAP\_DELIMITER\_req. This is followed by 'Receive\_Open\_Cnf'. From there, an 'OK' path leads to 'Wait\_For\_gsmSCF\_Response' and a 'Vr, Error' path leads to 'Set negative response: System failure', which then leads to 'Notify Subscriber Data Change negative response' and finally 'Idle'. + +4582 + +4583 + +Figure 24A.4/2 (sheet 1 of 2): Process NSDC\_HLR + +![Flowchart for process NSDC_HLR. It starts with 'Wait_For_gsmSCF_Response' leading to a merge point. From the merge point, one path goes left through 'MAP_NOTICE_ind' to 'MAP_CLOSE_req' to a merge point, then to 'Notify Subscriber Data Change negative response' and finally 'Idle'. The other path from the merge point goes right through 'MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_cnf' to 'Check_Confirmation'. 'Check_Confirmation' has an 'OK' path leading to a decision 'All information sent?'. If 'Yes', it goes to a merge point, then to 'Notify Subscriber Data Change response' and finally 'Idle'. If 'No', it goes to another decision 'Segmentation required?'. If 'Yes', it goes to a merge point. If 'No', it goes to 'Set: All Information Sent', then to a merge point. From this merge point, it goes right through 'MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_req' and 'MAP_DELIMITER_req' to 'Wait_For_gsmSCF_Response'. A 'User Error, Provider Error, Data Error' path from the first merge point leads to the second merge point. A box with 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind' is also connected to the first merge point.](091179da3e4866bfb1d00c8f9e1963f4_img.jpg) + +**process NSDC\_HLR** **NSDC\_HLR2(2)** + +Process in the HLR to notify the gsmSCF that subscriber data have changed + +Signals to/from the left are to/from the application process in the HLR (see 3GPP TS 23.078 or 3GPP TS 23.278); + Signals to/from the right are to/from the gsmSCF + +``` + + graph TD + W1([Wait_For_gsmSCF_Response]) --> M1(( )) + M1 --> N1[MAP_NOTICE_ind] + N1 --> C1[MAP_CLOSE_req] + C1 --> M2(( )) + M2 --> N2[Notify Subscriber Data Change negative response] + N2 --> I1([Idle]) + + M1 --> E[User Error, Provider Error, Data Error] + + M1 --> N3[MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_cnf] + N3 --> C2[Check_Confirmation] + + C2 -- OK --> D1{All information sent?} + + D1 -- Yes --> M3(( )) + M3 --> N4[Notify Subscriber Data Change response] + N4 --> I2([Idle]) + + D1 -- No --> D2{Segmentation required?} + + D2 -- Yes --> M3 + + D2 -- No --> S[Set: All Information Sent] + + S --> M3 + + M3 --> N5[MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_req +MAP_DELIMITER_req] + + N5 --> W2([Wait_For_gsmSCF_Response]) + + M1 --> A[MAP_P_ABORT_ind, +MAP_U_ABORT_ind, +MAP_CLOSE_ind] + +``` + +Flowchart for process NSDC\_HLR. It starts with 'Wait\_For\_gsmSCF\_Response' leading to a merge point. From the merge point, one path goes left through 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req' to a merge point, then to 'Notify Subscriber Data Change negative response' and finally 'Idle'. The other path from the merge point goes right through 'MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED\_cnf' to 'Check\_Confirmation'. 'Check\_Confirmation' has an 'OK' path leading to a decision 'All information sent?'. If 'Yes', it goes to a merge point, then to 'Notify Subscriber Data Change response' and finally 'Idle'. If 'No', it goes to another decision 'Segmentation required?'. If 'Yes', it goes to a merge point. If 'No', it goes to 'Set: All Information Sent', then to a merge point. From this merge point, it goes right through 'MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED\_req' and 'MAP\_DELIMITER\_req' to 'Wait\_For\_gsmSCF\_Response'. A 'User Error, Provider Error, Data Error' path from the first merge point leads to the second merge point. A box with 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind' is also connected to the first merge point. + +4584 + +4585 + +Figure 24A.4/2 (sheet 2 of 2): Process NSDC\_HLR + +![State transition diagram for process NSDC_gsmSCF. The process starts at an initial state, goes to Idle, then receives an Open indication. If OK, it waits for a service indication. From there, it can send MAP_NOTICE_ind, MAP_P_ABORT_ind, or MAP_CLOSE_req to the HLR (left), or receive a MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_ind from the HLR (right). It then checks the indication. If OK, it checks if all information is sent. If No, it stores received data and sends a response to the application (right) and waits for another service indication. If Yes, it assembles received data, notifies the subscriber data change to the application (right), and waits for an application response. Upon receiving a response, it sends a notification to the HLR (left) and returns to Idle. If an error occurs at any point, it returns to Idle.](665e93f3a2eb6c3ccbbb391fc666a77d_img.jpg) + +**process NSDC\_gsmSCF** **NSDC\_SCF1(1)** + +Process in the gsmSCF to handle a notification of change of subscriber data + +Signals to/from the left are to/from the HLR; signals to/from the right are to/from the application process in the gsmSCF + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_ind + Receive_Open_ind --> Wait_For_Service_Indication: OK + Receive_Open_ind --> Idle: Vr, Error + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind + Wait_For_Service_Indication --> MAP_CLOSE_req + Wait_For_Service_Indication --> MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_ind + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_ind --> Check_Indication + Check_Indication --> Decision1{All information sent?} + Decision1 --> Store_received_data: No + Decision1 --> Assemble_received_data: Yes + Store_received_data --> MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> Wait_For_Service_Indication + Assemble_received_data --> Notify_Subscriber_Data_Change + Notify_Subscriber_Data_Change --> Wait_For_Application_Response + Wait_For_Application_Response --> Notify_Subscriber_Data_Change_neg_response + Notify_Subscriber_Data_Change_neg_response --> Set_User_Error + Set_User_Error --> MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> Idle + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> MAP_P_ABORT_ind + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> MAP_U_ABORT_ind + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> MAP_CLOSE_ind + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> MAP_CLOSE_req + MAP_NOTE_SUBSCRIBER_DATA_MODIFIED_rsp --> Idle + Check_Indication --> Error + Error --> Idle + MAP_CLOSE_req --> Idle + MAP_P_ABORT_ind --> Idle + MAP_NOTICE_ind --> Idle + +``` + +State transition diagram for process NSDC\_gsmSCF. The process starts at an initial state, goes to Idle, then receives an Open indication. If OK, it waits for a service indication. From there, it can send MAP\_NOTICE\_ind, MAP\_P\_ABORT\_ind, or MAP\_CLOSE\_req to the HLR (left), or receive a MAP\_NOTE\_SUBSCRIBER\_DATA\_MODIFIED\_ind from the HLR (right). It then checks the indication. If OK, it checks if all information is sent. If No, it stores received data and sends a response to the application (right) and waits for another service indication. If Yes, it assembles received data, notifies the subscriber data change to the application (right), and waits for an application response. Upon receiving a response, it sends a notification to the HLR (left) and returns to Idle. If an error occurs at any point, it returns to Idle. + +4586 + +4587 + +Figure 24A.4/3: Process NSDC\_gsmSCF + +4588 **24A.5 Any Time Interrogation procedure** + +4589 **24A.5.1 General** + +4590 The message flows for successful retrieval of subscriber information related to an any time interrogation from the +4591 CAMEL server are shown in figure 24A.5/1 for interrogation directed to an HLR and figure 24A.5/2 for interrogation +4592 directed to a GMLC. + +![Sequence diagram for Figure 24A.5/1: Message flow for any time interrogation (gsmSCF to HLR). The diagram shows four numbered message exchanges between gsmSCF, HLR, and SGSN or VLR. 1) gsmSCF to HLR, 2) HLR to SGSN or VLR, 3) SGSN or VLR to HLR, 4) HLR to gsmSCF.](6ccb75cb5c1d05ca2da85a5d10dfbd0c_img.jpg) + +``` +sequenceDiagram + participant gsmSCF + participant HLR + participant SGSN or VLR + Note right of gsmSCF: 1 + gsmSCF->>HLR: + Note right of HLR: 2 + HLR->>SGSN or VLR: + Note right of SGSN or VLR: 3 + SGSN or VLR->>HLR: + Note right of HLR: 4 + HLR->>gsmSCF: +``` + +Sequence diagram for Figure 24A.5/1: Message flow for any time interrogation (gsmSCF to HLR). The diagram shows four numbered message exchanges between gsmSCF, HLR, and SGSN or VLR. 1) gsmSCF to HLR, 2) HLR to SGSN or VLR, 3) SGSN or VLR to HLR, 4) HLR to gsmSCF. + +4593 + +4594 + +- 4595 1) MAP\_ANY\_TIME\_INTERROGATION\_req/ind +- 4596 2) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req/ind +- 4597 3) MAP\_PROVIDE\_SUBSCRIBER\_INFO\_rsp/cnf +- 4598 4) MAP\_ANY\_TIME\_INTERROGATION\_rsp/cnf + +4599 + +4600 + +**Figure 24A.5/1: Message flow for any time interrogation (gsmSCF to HLR)** + +4601 The following MAP services are used to retrieve information about the status and/or location of a subscriber: + +4602 MAP\_ANY\_TIME\_INTERROGATION see clause 8.11.1; + +4603 MAP\_PROVIDE\_SUBSCRIBER\_INFO see clause 8.11.2. + +4604 The HLR sends the MAP\_PROVIDE\_SUBSCRIBER\_INFO request to the SGSN or the VLR, according to the domain +4605 for which the gsmSCF requested the information. + +![Sequence diagram for Figure 24A.5/2: Message flow for any time interrogation (gsmSCF to GMLC). The diagram shows two numbered message exchanges between gsmSCF and GMLC. 1) gsmSCF to GMLC, 2) GMLC to gsmSCF.](98eb542ec579cfbf15c8cf7659ae79d0_img.jpg) + +``` +sequenceDiagram + participant gsmSCF + participant GMLC + Note right of GMLC: 1 + gsmSCF->>GMLC: + Note right of gsmSCF: 2 + GMLC->>gsmSCF: +``` + +Sequence diagram for Figure 24A.5/2: Message flow for any time interrogation (gsmSCF to GMLC). The diagram shows two numbered message exchanges between gsmSCF and GMLC. 1) gsmSCF to GMLC, 2) GMLC to gsmSCF. + +4606 + +4607 + +- 4608 1) MAP\_ANY\_TIME\_INTERROGATION\_req/ind +- 4609 2) MAP\_ANY\_TIME\_INTERROGATION\_rsp/cnf + +4610 + +4611 + +**Figure 24A.5/2: Message flow for any time interrogation (gsmSCF to GMLC)** + +4612 The following MAP service is used to retrieve location information from a GMLC: + +4613 MAP\_ANY\_TIME\_INTERROGATION see clause 8.11.1; + +4614 In addition, the GMLC may use MAP Services specific to Location Services. + +## 4615 24A.5.2 Procedures in the gsmSCF + +4616 The process in the gsmSCF to request information about the location and/or state of a subscriber from the HLR is +4617 shown in figure 24A.5/3. The MAP process invokes macros not defined in this clause; the definitions of these macros +4618 can be found as follows: + +4619     Receive\_Open\_Cnf see clause 25.1.2; + +4620     Check\_Confirmation see clause 25.2.2. + +4621 The process in the gsmSCF to request location information from the GMLC is shown in figure 24A.5/4. The MAP +4622 process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4623     Receive\_Open\_Cnf see clause 25.1.2; + +4624     Check\_Confirmation see clause 25.2.2. + +## 4625 24A.5.3 Procedure in the HLR + +4626 The MAP process in the HLR to provide subscriber information in response to an interrogation from the CAMEL server +4627 is shown in figure 24A.5/5. The MAP process invokes macros not defined in this clause; the definitions of these macros +4628 can be found as follows: + +4629     Receive\_Open\_Ind see clause 25.1.1; + +4630     Receive\_Open\_Cnf see clause 25.1.2; + +4631     Check\_Confirmation see clause 25.2.2. + +## 4632 24A.5.4 Procedure in the GMLC + +4633 The MAP process in the GMLC to provide location information in response to a request from the gsmSCF is shown in +4634 figure 24A.5/6. The MAP process invokes a macro not defined in this clause; the definition of this macro can be found +4635 as follows: + +4636     Receive\_Open\_Ind see clause 25.1.1. + +![State transition diagram for process ATI_To_HLR_gsmSCF. The process starts at an initial state, goes to Idle, then Any Time Interrogation. It sends MAP_OPEN_req, MAP_ANY_TIME_INTERROGATION_req, and MAP_DELIMITER_req to the HLR. It receives Open_Cnf from the HLR. If OK, it goes to Wait_For_HLR_Response. If Vr, Error, it goes to Abort. From Wait_For_HLR_Response, it can receive MAP_ANY_TIME_INTERROGATION_cnf, MAP_NOTICE_ind, or MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind from the HLR. If MAP_ANY_TIME_INTERROGATION_cnf is received, it goes to Check_Confirmation. If OK, it goes to Any Time Interrogation ack, then Idle. If User Error, Provider Error, or Data Error is received, it goes to MAP_CLOSE_req. If MAP_NOTICE_ind is received, it goes to MAP_CLOSE_req. If MAP_P_ABORT_ind, MAP_U_ABORT_ind, or MAP_CLOSE_ind is received, it goes to Set negative response: system failure, then Any Time Interrogation negative response, then Idle.](7cbe81e808d4abb374cc659ddcd3fa53_img.jpg) + +process ATI\_To\_HLR\_gsmSCF + +ATI2HLR\_SCF1(1) + +Process in the gsmSCF to request subscriber location and/or state from the HLR + +Signals to/from the left are to/from the application process in the gsmSCF; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> ATI: Any Time Interrogation + ATI --> OutReq: MAP_OPEN_req, MAP_ANY_TIME_INTERROGATION_req, MAP_DELIMITER_req + OutReq --> RecOpenCnf: Receive_Open_Cnf + RecOpenCnf --> Wait_For_HLR_Response: OK + RecOpenCnf --> Abort: Vr, Error + Abort --> Idle + Wait_For_HLR_Response --> RecCnf: MAP_ANY_TIME_INTERROGATION_cnf + Wait_For_HLR_Response --> RecNotice: MAP_NOTICE_ind + Wait_For_HLR_Response --> RecAbortClose: MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind + RecCnf --> Check_Confirmation + Check_Confirmation --> ATI_Ack: Any Time Interrogation ack + Check_Confirmation --> Error: User Error, Provider Error, Data Error + ATI_Ack --> Idle + Error --> RecCloseReq: MAP_CLOSE_req + RecCloseReq --> Set_Neg_Response: Set negative response: system failure + Set_Neg_Response --> ATI_Neg_Response: Any Time Interrogation negative response + ATI_Neg_Response --> Idle + RecNotice --> RecCloseReq + RecAbortClose --> Set_Neg_Response + +``` + +State transition diagram for process ATI\_To\_HLR\_gsmSCF. The process starts at an initial state, goes to Idle, then Any Time Interrogation. It sends MAP\_OPEN\_req, MAP\_ANY\_TIME\_INTERROGATION\_req, and MAP\_DELIMITER\_req to the HLR. It receives Open\_Cnf from the HLR. If OK, it goes to Wait\_For\_HLR\_Response. If Vr, Error, it goes to Abort. From Wait\_For\_HLR\_Response, it can receive MAP\_ANY\_TIME\_INTERROGATION\_cnf, MAP\_NOTICE\_ind, or MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind from the HLR. If MAP\_ANY\_TIME\_INTERROGATION\_cnf is received, it goes to Check\_Confirmation. If OK, it goes to Any Time Interrogation ack, then Idle. If User Error, Provider Error, or Data Error is received, it goes to MAP\_CLOSE\_req. If MAP\_NOTICE\_ind is received, it goes to MAP\_CLOSE\_req. If MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, or MAP\_CLOSE\_ind is received, it goes to Set negative response: system failure, then Any Time Interrogation negative response, then Idle. + +4637 + +4638 + +Figure 24A.5/3: Process ATI\_To\_HLR\_gsmSCF + +![State transition diagram for process ATI_To_GMLC_gsmSCF. The process starts at an initial state, goes to Idle, then Obtain Subscriber Location. It then sends MAP requests (OPEN, ANY_TIME_INTERROGATION, DELIMITER) to the GMLC. It receives an Open_Cnf and checks it. If OK, it goes to Wait_For_GMLC_Response. If Vr, Error, it goes to Abort and then Idle. From Wait_For_GMLC_Response, it can receive MAP_ANY_TIME_INTERROGATION_cnf (leading to Check Confirmation), MAP_NOTICE_ind (leading to MAP_CLOSE_req), or MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind. Check Confirmation leads to Obtain Subscriber Location ack and then Idle. MAP_CLOSE_req leads to Set negative response: system failure, which leads to Obtain Subscriber Location negative response and then Idle.](1fafab41a297e962a03d24cacd32f479_img.jpg) + +**process ATI\_To\_GMLC\_gsmSCF** **ATI2GMLC\_SCF1(1)** + +Process in the gsmSCF to request subscriber location from the GMLC + +Signals to/from the left are to/from the application process in the gsmSCF; signals to/from the right are to/from the GMLC + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Obtain[Obtain Subscriber Location] + Obtain --> SendReq{ } + SendReq --> SendReq : MAP_OPEN_req, MAP_ANY_TIME_INTERROGATION_req, MAP_DELIMITER_req + SendReq --> ReceiveCnf[Receive Open_Cnf] + ReceiveCnf --> Decision1{ } + Decision1 --> Abort : Vr, Error + Decision1 --> WaitForResponse[Wait_For_GMLC_Response] : OK + Abort --> Idle2[Idle] + WaitForResponse --> Decision2{ } + Decision2 --> ReceiveCnf2[MAP_ANY_TIME_INTERROGATION_cnf] + Decision2 --> NoticeInd[MAP_NOTICE_ind] + Decision2 --> AbortInd[MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind] + ReceiveCnf2 --> CheckConfirmation[Check Confirmation] + CheckConfirmation --> ObtainAck[Obtain Subscriber Location ack] : OK + CheckConfirmation --> SetNegative[Set negative response: system failure] : User Error, Provider Error, Data Error + ObtainAck --> Idle3[Idle] + NoticeInd --> CloseReq[MAP_CLOSE_req] + CloseReq --> SetNegative + AbortInd --> SetNegative + SetNegative --> ObtainNeg[Obtain Subscriber Location negative response] + ObtainNeg --> Idle4[Idle] + +``` + +State transition diagram for process ATI\_To\_GMLC\_gsmSCF. The process starts at an initial state, goes to Idle, then Obtain Subscriber Location. It then sends MAP requests (OPEN, ANY\_TIME\_INTERROGATION, DELIMITER) to the GMLC. It receives an Open\_Cnf and checks it. If OK, it goes to Wait\_For\_GMLC\_Response. If Vr, Error, it goes to Abort and then Idle. From Wait\_For\_GMLC\_Response, it can receive MAP\_ANY\_TIME\_INTERROGATION\_cnf (leading to Check Confirmation), MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req), or MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind. Check Confirmation leads to Obtain Subscriber Location ack and then Idle. MAP\_CLOSE\_req leads to Set negative response: system failure, which leads to Obtain Subscriber Location negative response and then Idle. + +4639 + +4640 + +Figure 24A.5/4: Process ATI\_To\_GMLC\_gsmSCF + +![Flowchart for process ATI_HLR. It starts with an initial state leading to 'Idle'. From 'Idle', it receives an 'Open_ind' signal. If 'OK', it goes to 'Wait_For_Service_Indication'. If 'Vr, Error', it returns to 'Idle'. From 'Wait_For_Service_Indication', it branches into three paths: 'MAP_P_ABORT_ind' (leading to 'Idle'), 'MAP_ANY_TIME_INTERROGATION_ind' (leading to 'Any Time Interrogation request'), and 'MAP_NOTICE_ind' (leading to 'MAP_CLOSE_req' and then 'Idle'). From 'Any Time Interrogation request', it goes to 'Wait_For_Application_Response'. From there, it branches into 'Any Time Interrogation ack' (leading to 'Set result') and 'Any Time Interrogation negative response' (leading to 'Set error'). Both 'Set result' and 'Set error' lead to a merge point. From the merge point, it sends 'MAP_ANY_TIME_INTERROGATION_rsp' and 'MAP_CLOSE_req' signals, and then returns to 'Idle'.](0ce1118265c8d34891db8c8066c14971_img.jpg) + +**process ATI\_HLR** **ATI\_HLR1(2)** + +Process in the HLR to handle an Any Time Interrogation request + +Signals to/from the left are to/from the gsmSCF; signals to/from the right are to/from the application process in the HLR (see 3GPP TS 23.078) + +``` + + graph TD + Start([ ]) --> Idle1([Idle]) + Idle1 -- "Receive_Open_ind" --> WaitForService[Wait_For_Service_Indication] + WaitForService -- "OK" --> WaitForService + WaitForService -- "Vr, Error" --> Idle2([Idle]) + WaitForService --> MAP_P_ABORT{MAP_P_ABORT_ind} + WaitForService --> MAP_ANY_TIME_INTERROGATION{MAP_ANY_TIME_INTERROGATION_ind} + WaitForService --> MAP_NOTICE{MAP_NOTICE_ind} + MAP_P_ABORT --> Idle3([Idle]) + MAP_ANY_TIME_INTERROGATION --> ATI_Request{{Any Time Interrogation request}} + ATI_Request --> WaitForApp[Wait_For_Application_Response] + MAP_NOTICE --> MAP_CLOSE_req{{MAP_CLOSE_req}} + MAP_CLOSE_req --> Idle4([Idle]) + WaitForApp --> ATI_Ack{{Any Time Interrogation ack}} + WaitForApp --> ATI_NegResp{{Any Time Interrogation negative response}} + ATI_Ack --> SetResult[Set result] + ATI_NegResp --> SetError[Set error] + SetResult --> Merge(( )) + SetError --> Merge + Merge --> MAP_ANY_TIME_INTERROGATION_rsp[MAP_ANY_TIME_INTERROGATION_rsp] + Merge --> MAP_CLOSE_req2[MAP_CLOSE_req] + Merge --> Idle5([Idle]) + +``` + +Flowchart for process ATI\_HLR. It starts with an initial state leading to 'Idle'. From 'Idle', it receives an 'Open\_ind' signal. If 'OK', it goes to 'Wait\_For\_Service\_Indication'. If 'Vr, Error', it returns to 'Idle'. From 'Wait\_For\_Service\_Indication', it branches into three paths: 'MAP\_P\_ABORT\_ind' (leading to 'Idle'), 'MAP\_ANY\_TIME\_INTERROGATION\_ind' (leading to 'Any Time Interrogation request'), and 'MAP\_NOTICE\_ind' (leading to 'MAP\_CLOSE\_req' and then 'Idle'). From 'Any Time Interrogation request', it goes to 'Wait\_For\_Application\_Response'. From there, it branches into 'Any Time Interrogation ack' (leading to 'Set result') and 'Any Time Interrogation negative response' (leading to 'Set error'). Both 'Set result' and 'Set error' lead to a merge point. From the merge point, it sends 'MAP\_ANY\_TIME\_INTERROGATION\_rsp' and 'MAP\_CLOSE\_req' signals, and then returns to 'Idle'. + +4641 + +4642 + +**Figure 24A.5/5 (sheet 1 of 2): Process ATI\_HLR** + +![State transition diagram for process ATI_HLR. The process starts in 'Wait_For_Application_Response', moves to 'Provide Subscriber Info', then to an interface with 'To VLR or SGSN' where it sends 'MAP_OPEN_req', 'MAP_PROVIDE_SUBSCRIBER_INFO_req', and 'MAP_DELIMITER_req'. It receives 'Receive_Open_Cnf' with 'OK' or 'Vr, Error' outcomes. 'OK' leads to 'Wait_For_PSI_Response', which then leads to a state with three outgoing transitions: 'MAP_PROVIDE_SUBSCRIBER_INFO_cnf' to 'Check Confirmation' (OK leads to 'Provide Subscriber Info ack' then 'Wait_For_Application_Response'), 'MAP_NOTICE_ind' to 'MAP_CLOSE_req' (leading to 'Provide Subscriber Info negative response' then 'Wait_For_Application_Response'), and an unlabeled transition to 'MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind'. 'Vr, Error' from 'Receive_Open_Cnf' leads to 'Provide Subscriber Info negative response' then 'Wait_For_Application_Response'. 'Check Confirmation' also leads to 'MAP_CLOSE_req' on 'User Error, Provider Error, Data Error'.](ef965323bcabea8dc2e3f8be98b8f7dd_img.jpg) + +**process ATI\_HLR** + +Process in the HLR to handle an Any Time Interrogation request + +**ATI\_HLR2(2)** + +Signals to/from the left are to/from the gsmSCF; signals to/from the right are to/from the application process in the HLR (see 3GPP TS 23.078) unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Wait_For_Application_Response + Wait_For_Application_Response --> Provide_Subscriber_Info : Provide Subscriber Info + Provide_Subscriber_Info --> Interface : To VLR or SGSN + state "Interface" as Interface + Interface --> Send_Requests : MAP_OPEN_req, MAP_PROVIDE_SUBSCRIBER_INFO_req, MAP_DELIMITER_req + Send_Requests --> Receive_Open_Cnf : Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_PSI_Response : OK + Receive_Open_Cnf --> Provide_Subscriber_Info_Neg : Vr, Error + Wait_For_PSI_Response --> State_With_Three_Out + state "State With Three Out" as State_With_Three_Out + State_With_Three_Out --> Check_Confirmation : MAP_PROVIDE_SUBSCRIBER_INFO_cnf + State_With_Three_Out --> MAP_CLOSE_req : MAP_NOTICE_ind + State_With_Three_Out --> MAP_P_ABORT_ind : + Check_Confirmation --> Provide_Subscriber_Info_Ack : OK + Check_Confirmation --> MAP_CLOSE_req : User Error, Provider Error, Data Error + Provide_Subscriber_Info_Ack --> Wait_For_Application_Response + MAP_CLOSE_req --> Provide_Subscriber_Info_Neg + Provide_Subscriber_Info_Neg --> Wait_For_Application_Response + MAP_P_ABORT_ind --> Wait_For_Application_Response + +``` + +State transition diagram for process ATI\_HLR. The process starts in 'Wait\_For\_Application\_Response', moves to 'Provide Subscriber Info', then to an interface with 'To VLR or SGSN' where it sends 'MAP\_OPEN\_req', 'MAP\_PROVIDE\_SUBSCRIBER\_INFO\_req', and 'MAP\_DELIMITER\_req'. It receives 'Receive\_Open\_Cnf' with 'OK' or 'Vr, Error' outcomes. 'OK' leads to 'Wait\_For\_PSI\_Response', which then leads to a state with three outgoing transitions: 'MAP\_PROVIDE\_SUBSCRIBER\_INFO\_cnf' to 'Check Confirmation' (OK leads to 'Provide Subscriber Info ack' then 'Wait\_For\_Application\_Response'), 'MAP\_NOTICE\_ind' to 'MAP\_CLOSE\_req' (leading to 'Provide Subscriber Info negative response' then 'Wait\_For\_Application\_Response'), and an unlabeled transition to 'MAP\_P\_ABORT\_ind, MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind'. 'Vr, Error' from 'Receive\_Open\_Cnf' leads to 'Provide Subscriber Info negative response' then 'Wait\_For\_Application\_Response'. 'Check Confirmation' also leads to 'MAP\_CLOSE\_req' on 'User Error, Provider Error, Data Error'. + +4643 + +4644 + +**Figure 24A.5/5 (sheet 2 of 2): Process ATI\_HLR** + +![State transition diagram for process ATI_GMLC. It starts at an initial state, goes to Idle, then receives an Open indication. From there, it can go to Wait_For_Service_Indication (OK path) or Idle (Vr, Error path). Wait_For_Service_Indication leads to a decision point for MAP_P_ABORT_ind, MAP_ANY_TIME_INTERROGATION_ind, and MAP_NOTICE_ind. The central path leads to Any Time Interrogation request, then Wait_For_Application_Response, which then branches to Any Time Interrogation ack or negative response, leading to Set result or Set error. Both lead to a response state with MAP_ANY_TIME_INTERROGATION_rsp and MAP_CLOSE_req, returning to Idle. The MAP_P_ABORT_ind and MAP_NOTICE_ind paths also lead to Idle states via MAP_CLOSE_req.](252e7ba24faaa002513a8f0399938188_img.jpg) + +**process ATI\_GMLC** + +**ATI\_GMLC1(1)** + +Process in the HLR to handle an Any Time Interrogation request + +Signals to/from the left are to/from the gsmSCF; signals to/from the right are to/from the application process in the GMLC (see 3GPP TS 23.078) + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --> Wait_For_Service_Indication[Wait_For_Service_Indication] : OK + Receive_Open_ind --> Idle2[Idle] : Vr, Error + Wait_For_Service_Indication --> Decision1{ } + Decision1 --> MAP_P_ABORT_ind[MAP_P_ABORT_ind] + Decision1 --> MAP_ANY_TIME_INTERROGATION_ind[MAP_ANY_TIME_INTERROGATION_ind] + Decision1 --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_P_ABORT_ind --> Idle3[Idle] + MAP_ANY_TIME_INTERROGATION_ind --> Any_Time_Interrogation_request[Any Time Interrogation request] + Any_Time_Interrogation_request --> Wait_For_Application_Response[Wait_For_Application_Response] + Wait_For_Application_Response --> Decision2{ } + Decision2 --> Any_Time_Interrogation_ack[Any Time Interrogation ack] + Decision2 --> Any_Time_Interrogation_negative_response[Any Time Interrogation negative response] + Any_Time_Interrogation_ack --> Set_result[Set result] + Any_Time_Interrogation_negative_response --> Set_error[Set error] + Set_result --> Decision3{ } + Set_error --> Decision3 + Decision3 --> MAP_ANY_TIME_INTERROGATION_rsp[MAP_ANY_TIME_INTERROGATION_rsp] + Decision3 --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_ANY_TIME_INTERROGATION_rsp --> Idle4[Idle] + MAP_CLOSE_req1 --> Idle4 + MAP_NOTICE_ind --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Idle5[Idle] + +``` + +State transition diagram for process ATI\_GMLC. It starts at an initial state, goes to Idle, then receives an Open indication. From there, it can go to Wait\_For\_Service\_Indication (OK path) or Idle (Vr, Error path). Wait\_For\_Service\_Indication leads to a decision point for MAP\_P\_ABORT\_ind, MAP\_ANY\_TIME\_INTERROGATION\_ind, and MAP\_NOTICE\_ind. The central path leads to Any Time Interrogation request, then Wait\_For\_Application\_Response, which then branches to Any Time Interrogation ack or negative response, leading to Set result or Set error. Both lead to a response state with MAP\_ANY\_TIME\_INTERROGATION\_rsp and MAP\_CLOSE\_req, returning to Idle. The MAP\_P\_ABORT\_ind and MAP\_NOTICE\_ind paths also lead to Idle states via MAP\_CLOSE\_req. + +4645 + +4646 + +Figure 24A.5/6: Process ATI\_GMLC + +--- + +## 4647 24B Location Services process description + +### 4648 24B.1 Routeing information retrieval procedure for LCS + +#### 4649 24B.1.1 General + +4650 The message flow for successful retrieval of routeing information related to location services is shown in figure +4651 24B.1/1. + +![Sequence diagram showing message flow between GMLC and HLR for routeing information retrieval.](89fc4d82cf10d623e9edc219240205d8_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant HLR + Note right of GMLC: MAP_SEND_ROUTING_INFO_FOR_LCS + GMLC->>HLR: MAP_SEND_ROUTING_INFO_FOR_LCS + Note left of HLR: MAP_SEND_ROUTING_INFO_FOR_LCS_ACK + HLR->>GMLC: MAP_SEND_ROUTING_INFO_FOR_LCS_ACK +``` + +The diagram illustrates a sequence of messages between two entities, GMLC and HLR. The GMLC sends a message labeled 'MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS' to the HLR. The HLR responds with a message labeled 'MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS\_ACK' back to the GMLC. + +Sequence diagram showing message flow between GMLC and HLR for routeing information retrieval. + +4652 + +4653 **Figure 24B.1/1: Message flow for retrieval of routeing information for LCS** + +4654 The following MAP service is used to retrieve routeing information: + +4655 `MAP_SEND_ROUTING_INFO_FOR_LCS` see clause 13A.1. + +#### 4656 24B.1.2 Process in the GMLC + +4657 The MAP process in the GMLC to request routeing information for LCS is shown in figure 24B.1/2. The MAP process +4658 invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4659 `Receive_Open_Cnf` see clause 25.1.2; + +4660 `Check_Confirmation` see clause 25.2.2. + +#### 4661 24B.1.3 Process in the HLR + +4662 The MAP process in the HLR to handle a request for routeing information for LCS is shown in figure 24B.1/3. The +4663 MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +4664 `Receive_Open_Ind` see clause 25.1.1; + +4665 `Check_Indication` see clause 25.2.1. + +4666 + +![State transition diagram for process SRI_LCS_GMLC. The process starts at an initial state, goes to Idle, then sends routing info for LCS. It then sends MAP_OPEN_req, MAP_SEND_ROUTING_INFO_FOR_LCS_req, and MAP_DELIMITER_req to the HLR. It receives an Open_Cnf. If OK, it waits for an HLR response. If Vr, Error, it goes to a negative response. The HLR response can be MAP_SEND_ROUTING_INFO_FOR_LCS_cnf (leading to Check Confirmation), MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind, or MAP_NOTICE_ind (leading to MAP_CLOSE_req). Check Confirmation leads to OK (send ack), User Error (send negative response), or Provider Error, Data Error (set negative response: System failure). All paths lead to Idle.](24508c55181829a29c6681322035ca67_img.jpg) + +**process SRI\_LCS\_GMLC** **SRI\_LCS\_GMLC1(1)** + +Process in the GMLC to retrieve routing information for a location services enquiry + +Signals to/from the left are to/from the application process in the GMLC; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Send_routing_info_for_LCS + Send_routing_info_for_LCS --> Send_MAP_requests + Send_MAP_requests --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Receive_Open_Cnf --> Set_negative_response_System_failure: Vr, Error + Wait_For_HLR_Response --> MAP_SEND_ROUTING_INFO_FOR_LCS_cnf + Wait_For_HLR_Response --> MAP_U_ABORT_ind + Wait_For_HLR_Response --> MAP_P_ABORT_ind + Wait_For_HLR_Response --> MAP_CLOSE_ind + Wait_For_HLR_Response --> MAP_NOTICE_ind + MAP_SEND_ROUTING_INFO_FOR_LCS_cnf --> Check_Confirmation + MAP_U_ABORT_ind --> Set_negative_response_System_failure + MAP_P_ABORT_ind --> Set_negative_response_System_failure + MAP_CLOSE_ind --> Set_negative_response_System_failure + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Set_negative_response_System_failure + Check_Confirmation --> OK + Check_Confirmation --> User_Error + Check_Confirmation --> Provider_Error_Data_Error + OK --> Send_routing_info_for_LCS_ack + User_Error --> Send_routing_info_for_LCS_negative_response + Provider_Error_Data_Error --> Set_negative_response_System_failure + Send_routing_info_for_LCS_ack --> Idle + Send_routing_info_for_LCS_negative_response --> Idle + Set_negative_response_System_failure --> Send_routing_info_for_LCS_negative_response + Send_routing_info_for_LCS_negative_response --> Idle + +``` + +**States:** Idle (Initial, Idle, Idle, Idle, Idle) +**Transitions:** + - Send routing info for LCS + - Send routing info for LCS ack + - Send routing info for LCS negative response +**Internal Messages:** + - MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS\_req, MAP\_DELIMITER\_req + - Receive\_Open\_Cnf + - MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS\_cnf + - MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind + - MAP\_NOTICE\_ind + - MAP\_CLOSE\_req +**External Conditions/Responses:** + - OK + - User Error + - Provider Error, Data Error + - Vr, Error + +State transition diagram for process SRI\_LCS\_GMLC. The process starts at an initial state, goes to Idle, then sends routing info for LCS. It then sends MAP\_OPEN\_req, MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS\_req, and MAP\_DELIMITER\_req to the HLR. It receives an Open\_Cnf. If OK, it waits for an HLR response. If Vr, Error, it goes to a negative response. The HLR response can be MAP\_SEND\_ROUTING\_INFO\_FOR\_LCS\_cnf (leading to Check Confirmation), MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind, or MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req). Check Confirmation leads to OK (send ack), User Error (send negative response), or Provider Error, Data Error (set negative response: System failure). All paths lead to Idle. + +4667 + +4668 + +Figure 24B.1/2: Process SRI\_LCS\_GMLC + +![State transition diagram for process SRI_LCS_HLR. It starts at Idle, receives an Open indication, and then branches based on the response. One path sends routing info and returns to Idle. Another path handles notices or aborts and returns to Idle. A third path handles errors and returns to Idle.](1665ab0c7278ae76e38c3328113f09e5_img.jpg) + +**process SRI\_LCS\_HLR** **SRI\_LCS\_HLR1(1)** + +Process in the HLR to provide routing information for a location services enquiry + +Signals to/from the left are to/from the GMLC; signals to/from the right are to/from the application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Service_Indication: OK + Receive_Open_Ind --> Idle: Vr, Error + Wait_For_Service_Indication --> MAP_SEND_ROUTING_INFO_FOR_LCS_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind + MAP_SEND_ROUTING_INFO_FOR_LCS_ind --> Check_Indication + Check_Indication --> Send_routing_info_for_LCS: OK + Check_Indication --> [*]: Error + Send_routing_info_for_LCS --> Wait_For_Routing_Info + Wait_For_Routing_Info --> Send_routing_info_for_LCS_ack + Wait_For_Routing_Info --> Send_routing_info_for_LCS_negative_response + Send_routing_info_for_LCS_ack --> Set_Result + Send_routing_info_for_LCS_negative_response --> Set_User_Error + Set_Result --> [*] + Set_User_Error --> [*] + [*] --> MAP_SEND_ROUTING_INFO_FOR_LCS_rsp + [*] --> MAP_CLOSE_req + MAP_SEND_ROUTING_INFO_FOR_LCS_rsp --> Idle + MAP_CLOSE_req --> Idle + +``` + +State transition diagram for process SRI\_LCS\_HLR. It starts at Idle, receives an Open indication, and then branches based on the response. One path sends routing info and returns to Idle. Another path handles notices or aborts and returns to Idle. A third path handles errors and returns to Idle. + +4669 + +4670 + +Figure 24B.1/3: Process SRI\_LCS\_HLR + +## 24B.2 Provide Subscriber Location procedure + +### 24B.2.1 General + +The message flow for successful retrieval of the location information of a target MS related to location services is shown in figure 24B.1/1. + +![Sequence diagram showing the message flow for retrieval of location information between GMLC and MSC/SGSN.](3db9a2e103b487562fa906a9df1e500a_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant MSC_SGSN as MSC/SGSN + Note right of GMLC: MAP_PROVIDE_SUBSCRIBER_LOCATION + GMLC->>MSC_SGSN: MAP_PROVIDE_SUBSCRIBER_LOCATION + Note left of MSC_SGSN: MAP_PROVIDE_SUBSCRIBER_LOCATION_ACK + MSC_SGSN-->>GMLC: MAP_PROVIDE_SUBSCRIBER_LOCATION_ACK +``` + +Sequence diagram showing the message flow for retrieval of location information between GMLC and MSC/SGSN. + +4675 + +4676 + +**Figure 24B.2/1: Message flow for retrieval of location information** + +The following MAP service is used to retrieve location information: + +MAP\_PROVIDE\_SUBSCRIBER\_LOCATION see clause 13A.2. + +### 24B.2.2 Process in the GMLC + +The MAP process in the GMLC to request location information from an MSC or an SGSN is shown in figure 24B.2/2. + +The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2. + +### 24B.2.3 Process in the MSC + +The MAP process in the MSC to handle a request for location information from a GMLC is shown in figure 24B.2/3. + +The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1; + +Check\_Indication see clause 25.2.1. + +### 24B.2.4 Process in the SGSN + +The MAP process in the SGSN to handle a request for location information from a GMLC is shown in figure 24B.2/4. + +The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1; + +Check\_Indication see clause 25.2.1. + +![State transition diagram for process PSL_GMLC. The process starts at an initial state, goes to Idle, then Provide subscriber location. It then sends MAP_OPEN_req, MAP_PROVIDE_SUBSCRIBER_LOCATION_req, and MAP_DELIMITER_req. It receives Open_Cnf and enters Wait_For_Serving_Node_Response. From there, it can receive MAP_PROVIDE_SUBSCRIBER_LOCATION_cnf (leading to Check Confirmation), MAP_U_ABORT_ind, MAP_P_ABORT_ind, or MAP_CLOSE_ind (leading to Set negative response: System failure). Check Confirmation leads to Provide subscriber location ack or Set negative response: System failure. MAP_CLOSE_req leads to Set negative response: System failure. All negative responses lead to Provide subscriber location negative response. All final states lead back to Idle.](5ca1f26bc949fa36dc4ce38993cdfb20_img.jpg) + +**process PSL\_GMLC** **PSL\_GMLC1(1)** + +Process in the GMLC to retrieve the location of a target MS from the MSC or the SGSN + +Signals to/from the left are to/from the application process in the GMLC; signals to/from the right are to/from the MSC or the SGSN + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Provide_subscriber_location: Provide subscriber location + Provide_subscriber_location --> Outgoing: MAP_OPEN_req, MAP_PROVIDE_SUBSCRIBER_LOCATION_req, MAP_DELIMITER_req + Outgoing --> Receive_Open_Cnf: Receive Open_Cnf + Receive_Open_Cnf --> Wait_For_Serving_Node_Response: OK + Wait_For_Serving_Node_Response --> Incoming1: MAP_PROVIDE_SUBSCRIBER_LOCATION_cnf + Wait_For_Serving_Node_Response --> Incoming2: MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Wait_For_Serving_Node_Response --> Incoming3: MAP_NOTICE_ind + Incoming1 --> Check_Confirmation: Check Confirmation + Check_Confirmation --> Provide_subscriber_location_ack: OK + Check_Confirmation --> Set_negative_response_1: User Error, Provider Error, Data Error + Set_negative_response_1 --> Provide_subscriber_location_negative_response_1: Provide subscriber location negative response + Incoming2 --> Set_negative_response_2: Set negative response: System failure + Incoming3 --> MAP_CLOSE_req: MAP_CLOSE_req + MAP_CLOSE_req --> Set_negative_response_3: Set negative response: System failure + Set_negative_response_2 --> Provide_subscriber_location_negative_response_2: Provide subscriber location negative response + Set_negative_response_3 --> Provide_subscriber_location_negative_response_3: Provide subscriber location negative response + Provide_subscriber_location_ack --> Idle + Provide_subscriber_location_negative_response_1 --> Idle + Provide_subscriber_location_negative_response_2 --> Idle + Provide_subscriber_location_negative_response_3 --> Idle + +``` + +State transition diagram for process PSL\_GMLC. The process starts at an initial state, goes to Idle, then Provide subscriber location. It then sends MAP\_OPEN\_req, MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_req, and MAP\_DELIMITER\_req. It receives Open\_Cnf and enters Wait\_For\_Serving\_Node\_Response. From there, it can receive MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_cnf (leading to Check Confirmation), MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, or MAP\_CLOSE\_ind (leading to Set negative response: System failure). Check Confirmation leads to Provide subscriber location ack or Set negative response: System failure. MAP\_CLOSE\_req leads to Set negative response: System failure. All negative responses lead to Provide subscriber location negative response. All final states lead back to Idle. + +4694 + +4695 + +Figure 24B.2/2: Process PSL\_GMLC + +![State transition diagram for process PSL_MSC. It starts at an initial state, goes to Idle, then Receive_Open_ind. From there, an OK path leads to Wait_For_Service_Indication, which then branches into three paths: MAP_PROVIDE_SUBSCRIBER_LOCATION_ind (leading to Check_Indication, then Provide subscriber location, then Wait_For_Location_Info, then either Provide subscriber location ack or Provide subscriber location negative response, then Set Result or Set User Error), MAP_NOTICE_ind (leading to MAP_CLOSE_req), and MAP_P_ABORT_ind (leading to Idle). Both Set Result and MAP_CLOSE_req lead to a merge point, which then leads to a response state (MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp / MAP_CLOSE_req) and finally back to Idle. An Error path from Check_Indication also leads to Idle.](323b3cf879e2d4b1684f987244766b53_img.jpg) + +**process PSL\_MSC** **PSL\_MSC1(1)** + +Process in the MSC to retrieve the location of a target MS + +Signals to/from the left are to/from the GMLC; +signals to/from the right are to/from the application process in the MSC + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --> Wait_For_Service_Indication[Wait_For_Service_Indication] + Wait_For_Service_Indication --> MAP_PROVIDE_SUBSCRIBER_LOCATION_ind[MAP_PROVIDE_SUBSCRIBER_LOCATION_ind] + Wait_For_Service_Indication --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_Service_Indication --> MAP_P_ABORT_ind[MAP_P_ABORT_ind] + MAP_P_ABORT_ind --> Idle2[Idle] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> MergePoint(( )) + MAP_PROVIDE_SUBSCRIBER_LOCATION_ind --> Check_Indication[Check_Indication] + Check_Indication --> Error[Error] + Check_Indication --> OK1[OK] + OK1 --> Provide_subscriber_location[Provide subscriber location] + Provide_subscriber_location --> Wait_For_Location_Info[Wait_For_Location_Info] + Wait_For_Location_Info --> Provide_subscriber_location_ack[Provide subscriber location ack] + Wait_For_Location_Info --> Provide_subscriber_location_negative_response[Provide subscriber location negative response] + Provide_subscriber_location_ack --> Set_Result[Set Result] + Provide_subscriber_location_negative_response --> Set_User_Error[Set User Error] + Set_Result --> MergePoint + Set_User_Error --> MergePoint + MergePoint --> MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp[MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp / MAP_CLOSE_req] + MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp --> Idle3[Idle] + +``` + +State transition diagram for process PSL\_MSC. It starts at an initial state, goes to Idle, then Receive\_Open\_ind. From there, an OK path leads to Wait\_For\_Service\_Indication, which then branches into three paths: MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_ind (leading to Check\_Indication, then Provide subscriber location, then Wait\_For\_Location\_Info, then either Provide subscriber location ack or Provide subscriber location negative response, then Set Result or Set User Error), MAP\_NOTICE\_ind (leading to MAP\_CLOSE\_req), and MAP\_P\_ABORT\_ind (leading to Idle). Both Set Result and MAP\_CLOSE\_req lead to a merge point, which then leads to a response state (MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_rsp / MAP\_CLOSE\_req) and finally back to Idle. An Error path from Check\_Indication also leads to Idle. + +4696 + +4697 + +**Figure 24B.2/3: Process PSL\_MSC** + +![State transition diagram for process PSL_SGSN. The process starts at an initial state, goes to Idle, then receives an Open indication. From there, it can go to Wait_For_Service_Indication, then either back to Idle (on error), or branch into three parallel paths: MAP_PROVIDE_SUBSCRIBER_LOCATION_ind, MAP_NOTICE_ind, and MAP_P_ABORT_ind. The first path leads to Check_Indication, then either to Provide subscriber location (on OK) or back to Idle (on Error). The second path leads to MAP_CLOSE_req. The third path leads directly to Idle. Both Provide subscriber location and MAP_CLOSE_req lead to Wait_For_Location_Info. From there, it can lead to Provide subscriber location ack, Set Result, or Set User Error. All three lead to a merge point, which then leads to a response state (MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp, MAP_CLOSE_req) and finally back to Idle.](2938130791afc86f7e37f5cd529eb667_img.jpg) + +**process PSL\_SGSN** **PSL\_SGSN1(1)** + +Process in the SGSN to retrieve the location of a target MS + +Signals to/from the left are to/from the GMLC; +signals to/from the right are to/from the application process in the SGSN + +``` + +stateDiagram-v2 + [*] --> Idle1[Idle] + Idle1 --> Receive_Open_ind[Receive_Open_ind] + Receive_Open_ind --> Wait_For_Service_Indication[Wait_For_Service_Indication] + Wait_For_Service_Indication --> Idle2[Idle] : Vr, Error + Wait_For_Service_Indication --> MAP_PROVIDE_SUBSCRIBER_LOCATION_ind[MAP_PROVIDE_SUBSCRIBER_LOCATION_ind] + Wait_For_Service_Indication --> MAP_NOTICE_ind[MAP_NOTICE_ind] + Wait_For_Service_Indication --> MAP_P_ABORT_ind[MAP_P_ABORT_ind] + MAP_P_ABORT_ind --> Idle3[Idle] + MAP_NOTICE_ind --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_CLOSE_req1 --> MAP_P_ABORT_ind + MAP_PROVIDE_SUBSCRIBER_LOCATION_ind --> Check_Indication[Check_Indication] + Check_Indication --> Idle2 : Error + Check_Indication --> Provide_subscriber_location[Provide subscriber location] : OK + Provide_subscriber_location --> Wait_For_Location_Info[Wait_For_Location_Info] + Wait_For_Location_Info --> Provide_subscriber_location_ack[Provide subscriber location ack] + Wait_For_Location_Info --> Set_Result[Set Result] + Wait_For_Location_Info --> Set_User_Error[Set User Error] + Set_User_Error --> MergePoint(( )) + Set_Result --> MergePoint + Provide_subscriber_location_ack --> MergePoint + MergePoint --> MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp[MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp +MAP_CLOSE_req] + MAP_PROVIDE_SUBSCRIBER_LOCATION_rsp --> Idle4[Idle] + +``` + +State transition diagram for process PSL\_SGSN. The process starts at an initial state, goes to Idle, then receives an Open indication. From there, it can go to Wait\_For\_Service\_Indication, then either back to Idle (on error), or branch into three parallel paths: MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_ind, MAP\_NOTICE\_ind, and MAP\_P\_ABORT\_ind. The first path leads to Check\_Indication, then either to Provide subscriber location (on OK) or back to Idle (on Error). The second path leads to MAP\_CLOSE\_req. The third path leads directly to Idle. Both Provide subscriber location and MAP\_CLOSE\_req lead to Wait\_For\_Location\_Info. From there, it can lead to Provide subscriber location ack, Set Result, or Set User Error. All three lead to a merge point, which then leads to a response state (MAP\_PROVIDE\_SUBSCRIBER\_LOCATION\_rsp, MAP\_CLOSE\_req) and finally back to Idle. + +4698 + +4699 + +Figure 24B.2/4: Process PSL\_SGSN + +## 24B.3 Subscriber Location Report procedure + +### 24B.3.1 General + +The message flow for successful report of the location information of a target MS related to location services is shown in figure 24B.3/1. + +![Sequence diagram showing the message flow for report of the location information between GMLC and MSC/SGSN.](6f3fc13f5890b406edd19c32ca20a482_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant MSC_SGSN as MSC/SGSN + Note right of MSC_SGSN: MAP_SUBSCRIBER_LOCATION_REPORT + MSC_SGSN->>GMLC: MAP_SUBSCRIBER_LOCATION_REPORT + Note left of GMLC: MAP_SUBSCRIBER_LOCATION_REPORT_ACK + GMLC->>MSC_SGSN: MAP_SUBSCRIBER_LOCATION_REPORT_ACK +``` + +Sequence diagram showing the message flow for report of the location information between GMLC and MSC/SGSN. + +4704 + +4705 + +**Figure 24B.3/1: Message flow for report of the location information** + +The following MAP services are used to report location information: + +MAP\_SUBSCRIBER\_LOCATION\_REPORT see clause 13A.3. + +### 24B.3.2 Process in the MSC + +The MAP process in the MSC to send a subscriber location report to the GMLC is shown in figure 24B.3/2. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2. + +### 24B.3.3 Process in the SGSN + +The MAP process in the SGSN to send a subscriber location report to the GMLC is shown in figure 24B.3/3. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Cnf see clause 25.1.2; + +Check\_Confirmation see clause 25.2.2. + +### 24B.3.4 Process in the GMLC + +The MAP process in the GMLC to handle a subscriber location report is shown in figure 24B.3/4. The MAP process invokes macros not defined in this clause; the definitions of these macros can be found as follows: + +Receive\_Open\_Ind see clause 25.1.1; + +Check\_Indication see clause 25.2.1. + +![Sequence diagram for process SLR_MSC showing the interaction between an application process and a GMLC for subscriber location reporting. The process starts at an Idle state, receives a location report, sends MAP requests, receives an Open confirmation, waits for a response, and then handles either a confirmation, an abort/notice, or a close request, leading to either an acknowledgment, a negative response, or returning to Idle.](428a14cda2c27da82e83d1024d9f717e_img.jpg) + +**process SLR\_MSC** **SLR\_MSC1(1)** + +Process in the MSC to report the location of an MS to the GMLC + +Signals to/from the left are to/from the GMLC; signals to/from the right are to/from the application process in the MSC + +``` + +sequenceDiagram + participant Application + participant SLR_MSC + Note left of Application: Process in the MSC to report the location of an MS to the GMLC + Note right of Application: Signals to/from the left are to/from the GMLC; signals to/from the right are to/from the application process in the MSC + + Application->>SLR_MSC: Subscriber location report + SLR_MSC->>Application: MAP_OPEN_req, MAP_SUBSCRIBER_LOCATION_REPORT_req, MAP_DELIMITER_req + Application-->>SLR_MSC: Receive_Open_Cnf + SLR_MSC->>Application: Wait_For_GMLC_Response + Note right of Application: OK + Note right of Application: Vr, Error + + alt Confirmation Path + SLR_MSC->>Application: MAP_SUBSCRIBER_LOCATION_REPORT_cnf + Application->>SLR_MSC: Check_Confirmation + Note right of Application: OK + SLR_MSC->>Application: Subscriber location report ack + Application-->>SLR_MSC: Idle + else User Error / Provider Error, Data Error + Application->>SLR_MSC: Set negative response: System failure + SLR_MSC->>Application: Subscriber location report negative response + Application-->>SLR_MSC: Idle + else Notice/Abort/Close Path + SLR_MSC->>Application: MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + SLR_MSC->>Application: MAP_NOTICE_ind + Application->>SLR_MSC: MAP_CLOSE_req + Note right of Application: System failure + SLR_MSC->>Application: Subscriber location report negative response + Application-->>SLR_MSC: Idle + end + +``` + +Sequence diagram for process SLR\_MSC showing the interaction between an application process and a GMLC for subscriber location reporting. The process starts at an Idle state, receives a location report, sends MAP requests, receives an Open confirmation, waits for a response, and then handles either a confirmation, an abort/notice, or a close request, leading to either an acknowledgment, a negative response, or returning to Idle. + +4723 + +4724 + +**Figure 24B.3/2: Process SLR\_MSC** + +![State transition diagram for process SLR_SGSN. The process starts at an initial state, goes to Idle, then receives a subscriber location report. It sends MAP_OPEN_req, MAP_SUBSCRIBER_LOCATION_REPORT_req, and MAP_DELIMITER_req. It then receives an Open_Cnf. If OK, it waits for a GMLC response. If Vr, Error, it goes to a negative response state. The GMLC response can be a confirmation (leading to Check Confirmation), an indication of abort/close (leading to a negative response state), or a notice (leading to a MAP CLOSE_req). Check Confirmation leads to a report ack and Idle state if OK, or a negative response state if User Error or Provider Error/Data Error. MAP CLOSE_req leads to a negative response state. All negative response states lead to an Idle state.](4e3fafcdb2449d818d4b424f3ef1e958_img.jpg) + +**process SLR\_SGSN** **SLR\_SGSN1(1)** + +Process in the SGSN to report the location of an MS to the GMLC + +Signals to/from the left are to/from the GMLC; signals to/from the right are to/from the application process in the MSC + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> SLR_Req: Subscriber location report + SLR_Req --> OutReq: MAP_OPEN_req, MAP_SUBSCRIBER_LOCATION_REPORT_req, MAP_DELIMITER_req + OutReq --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_GMLC_Response: OK + Receive_Open_Cnf --> Negative_Response: Vr, Error + Wait_For_GMLC_Response --> Confirmation: MAP_SUBSCRIBER_LOCATION_REPORT_cnf + Wait_For_GMLC_Response --> Indication: MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Wait_For_GMLC_Response --> Notice: MAP_NOTICE_ind + Confirmation --> Check_Confirmation + Check_Confirmation --> Ack: OK + Check_Confirmation --> Negative_Response: User Error, Provider Error, Data Error + Ack --> Idle + Negative_Response --> Idle + Notice --> Close_Req: MAP_CLOSE_req + Close_Req --> Negative_Response + Negative_Response --> Idle + +``` + +State transition diagram for process SLR\_SGSN. The process starts at an initial state, goes to Idle, then receives a subscriber location report. It sends MAP\_OPEN\_req, MAP\_SUBSCRIBER\_LOCATION\_REPORT\_req, and MAP\_DELIMITER\_req. It then receives an Open\_Cnf. If OK, it waits for a GMLC response. If Vr, Error, it goes to a negative response state. The GMLC response can be a confirmation (leading to Check Confirmation), an indication of abort/close (leading to a negative response state), or a notice (leading to a MAP CLOSE\_req). Check Confirmation leads to a report ack and Idle state if OK, or a negative response state if User Error or Provider Error/Data Error. MAP CLOSE\_req leads to a negative response state. All negative response states lead to an Idle state. + +4725 + +4726 + +Figure 24B.3/3: Process SLR\_SGSN + +![State transition diagram for process SLR_GMLC. It starts at Idle, receives an Open indication, and then branches based on the response: OK leads to Wait_For_Service_Indication, while Vr, Error leads back to Idle. From Wait_For_Service_Indication, three signals are possible: MAP_SUBSCRIBER_LOCATION_REPORT_ind, MAP_NOTICE_ind, and MAP_P_ABORT_ind. The first leads to Check_Indication, which then leads to a decision point for Subscriber location report. If OK, it goes to Wait_For_Location_Info, then either Subscriber location report ack or Subscriber location report negative response, then Set Result or Set User Error, and finally to a merge point. If Error, it goes directly to the merge point. The second signal, MAP_NOTICE_ind, leads to MAP_CLOSE_req, which then leads to Idle. The third signal, MAP_P_ABORT_ind, also leads to Idle. From the merge point, the process sends a response (MAP_SUBSCRIBER_LOCATION_REPORT_rsp or MAP_CLOSE_req) and returns to Idle.](f22332641b460a9ad3c181dddf857ac7_img.jpg) + +**process SLR\_GMLC** **SLR\_GMLC1(1)** + +Process in the GMLC to receive a subscriber location report from the MSC or the SGSN + +Signals to/from the left are to/from the application process in the GMLC; signals to/from the right are to/from the MSC or the SGSN + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_ind + Receive_Open_ind --> Wait_For_Service_Indication : OK + Receive_Open_ind --> Idle : Vr, Error + Wait_For_Service_Indication --> MAP_SUBSCRIBER_LOCATION_REPORT_ind + Wait_For_Service_Indication --> MAP_NOTICE_ind + Wait_For_Service_Indication --> MAP_P_ABORT_ind + MAP_P_ABORT_ind --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + MAP_SUBSCRIBER_LOCATION_REPORT_ind --> Check_Indication + Check_Indication --> Subscriber_location_report : OK + Check_Indication --> Merge : Error + Subscriber_location_report --> Wait_For_Location_Info + Wait_For_Location_Info --> Subscriber_location_report_ack + Wait_For_Location_Info --> Subscriber_location_report_negative_response + Subscriber_location_report_ack --> Set Result + Subscriber_location_report_negative_response --> Set User Error + Set Result --> Merge + Set User Error --> Merge + Merge --> Response + Response --> Idle + +``` + +State transition diagram for process SLR\_GMLC. It starts at Idle, receives an Open indication, and then branches based on the response: OK leads to Wait\_For\_Service\_Indication, while Vr, Error leads back to Idle. From Wait\_For\_Service\_Indication, three signals are possible: MAP\_SUBSCRIBER\_LOCATION\_REPORT\_ind, MAP\_NOTICE\_ind, and MAP\_P\_ABORT\_ind. The first leads to Check\_Indication, which then leads to a decision point for Subscriber location report. If OK, it goes to Wait\_For\_Location\_Info, then either Subscriber location report ack or Subscriber location report negative response, then Set Result or Set User Error, and finally to a merge point. If Error, it goes directly to the merge point. The second signal, MAP\_NOTICE\_ind, leads to MAP\_CLOSE\_req, which then leads to Idle. The third signal, MAP\_P\_ABORT\_ind, also leads to Idle. From the merge point, the process sends a response (MAP\_SUBSCRIBER\_LOCATION\_REPORT\_rsp or MAP\_CLOSE\_req) and returns to Idle. + +4727 + +4728 + +Figure 24B.3/4: Process SLR\_GMLC + +--- + +## 4729 25 General macro description + +### 4730 25.1 MAP\_OPEN handling macros + +#### 4731 25.1.1 Macro Receive\_Open\_Ind + +4732 This macro is used by a MAP service-user procedure when a peer entity requests opening of a dialogue. + +#### 4733 25.1.2 Macro Receive\_Open\_Cnf + +4734 This macro is used by a user procedure after it has requested opening of a dialogue towards a peer entity. + +macrodefinition Receive\_Open\_Ind + +Rec\_Open\_Ind1(2) + +Macro to handle a +MAP\_OPEN indication + +Signals to/from the left +are to/from the remote +peer entity + +![Flowchart for macrodefinition Receive_Open_Ind. It starts with an oval connector, followed by a process block 'MAP_OPEN_ind'. A decision diamond 'Version 1 AC?' has a 'Yes' path to connector 'Vr' and a 'No' path to decision 'MAP_OPEN info present?'. The 'No' path from 'MAP_OPEN info present?' leads to connector '2'. The 'Yes' path leads to 'Reference := Destination reference', then 'Check_Reference' (linked to Figure 25.1/3). From 'Check_Reference', 'OK' leads to 'Reference := Originating reference' and 'Error' leads to 'Refuse-reason := Invalid destination reference' (connector '1'). From 'Reference := Originating reference', it goes to another 'Check_Reference' (linked to Figure 25.1/3). From this 'Check_Reference', 'OK' leads to decision 'Destination reference check required?'. The 'No' path from this decision leads to connector '2', and the 'Yes' path leads to decision 'Destination reference known?'. The 'No' path from 'Destination reference known?' leads to 'Refuse-reason := Invalid destination reference' (connector '1'). The 'Yes' path from 'Destination reference known?' leads to connector '2'. All connectors (Vr, 1, 2) are circles with numbers or letters inside.](0d5b9c8b2002af22ccfc93c405fbea92_img.jpg) + +``` + +graph TD + Start([ ]) --> MAP_OPEN_ind[MAP_OPEN_ind] + MAP_OPEN_ind --> Version1AC{Version 1 AC?} + Version1AC -- Yes --> Vr((Vr)) + Version1AC -- No --> MAP_OPEN_info{MAP_OPEN info present?} + MAP_OPEN_info -- No --> Connector2_1((2)) + MAP_OPEN_info -- Yes --> RefDest[Reference := Destination reference] + RefDest --> CheckRef1[Check_Reference] + CheckRef1 -.-> Figure25_1_3_1[Figure 25.1/3] + CheckRef1 -- OK --> RefOrig[Reference := Originating reference] + CheckRef1 -- Error --> RefuseReason1[Refuse-reason := Invalid destination reference] + RefuseReason1 --> Connector1_1((1)) + RefOrig --> CheckRef2[Check_Reference] + CheckRef2 -.-> Figure25_1_3_2[Figure 25.1/3] + CheckRef2 -- OK --> DestCheckReq{Destination reference check required?} + DestCheckReq -- No --> Connector2_2((2)) + DestCheckReq -- Yes --> DestKnown{Destination reference known?} + DestKnown -- No --> RefuseReason2[Refuse-reason := Invalid destination reference] + RefuseReason2 --> Connector1_2((1)) + DestKnown -- Yes --> Connector2_3((2)) + +``` + +Flowchart for macrodefinition Receive\_Open\_Ind. It starts with an oval connector, followed by a process block 'MAP\_OPEN\_ind'. A decision diamond 'Version 1 AC?' has a 'Yes' path to connector 'Vr' and a 'No' path to decision 'MAP\_OPEN info present?'. The 'No' path from 'MAP\_OPEN info present?' leads to connector '2'. The 'Yes' path leads to 'Reference := Destination reference', then 'Check\_Reference' (linked to Figure 25.1/3). From 'Check\_Reference', 'OK' leads to 'Reference := Originating reference' and 'Error' leads to 'Refuse-reason := Invalid destination reference' (connector '1'). From 'Reference := Originating reference', it goes to another 'Check\_Reference' (linked to Figure 25.1/3). From this 'Check\_Reference', 'OK' leads to decision 'Destination reference check required?'. The 'No' path from this decision leads to connector '2', and the 'Yes' path leads to decision 'Destination reference known?'. The 'No' path from 'Destination reference known?' leads to 'Refuse-reason := Invalid destination reference' (connector '1'). The 'Yes' path from 'Destination reference known?' leads to connector '2'. All connectors (Vr, 1, 2) are circles with numbers or letters inside. + +4735 + +4736 + +Figure 25.1/1 (sheet 1 of 2): Macro Receive\_Open\_Ind + +macrodefinition Receive\_Open\_Ind + +Rec\_Open\_Ind2(2) + +Macro to handle a +MAP\_OPEN indication + +Signals to/from the left +are to/from the remote +peer entity + +![Flowchart for macrodefinition Receive_Open_Ind. It consists of two vertical paths. Path 1 (left) starts at circle '1', goes to 'Result:= Dialogue refused', then 'AC name:= Highest version supported', then a pentagon 'MAP_OPEN_rsp', and ends at circle 'Error'. Path 2 (right) starts at circle '2', goes to 'Result:= Dialogue accepted', then 'AC name:= Received AC name', then a pentagon 'MAP_OPEN_rsp', then a decision diamond. The diamond has a 'Yes' path to circle 'OK' and a 'No' path to circle 'Vr'. A note next to the diamond asks: 'Received AC version (Vr)= the one defined in this version of 3GPP TS 29.002?'.](28950712913dcf8428ff4b863e5fa780_img.jpg) + +``` + +graph TD + subgraph Path1 + 1((1)) --> R1[Result:= Dialogue refused] + R1 --> AC1[AC name:= Highest version supported] + AC1 --> M1{MAP_OPEN_rsp} + M1 --> E((Error)) + end + subgraph Path2 + 2((2)) --> R2[Result:= Dialogue accepted] + R2 --> AC2[AC name:= Received AC name] + AC2 --> M2{MAP_OPEN_rsp} + M2 --> D{Received AC version (Vr)= the one defined in this version of 3GPP TS 29.002?} + D -- Yes --> OK((OK)) + D -- No --> Vr((Vr)) + end + +``` + +Flowchart for macrodefinition Receive\_Open\_Ind. It consists of two vertical paths. Path 1 (left) starts at circle '1', goes to 'Result:= Dialogue refused', then 'AC name:= Highest version supported', then a pentagon 'MAP\_OPEN\_rsp', and ends at circle 'Error'. Path 2 (right) starts at circle '2', goes to 'Result:= Dialogue accepted', then 'AC name:= Received AC name', then a pentagon 'MAP\_OPEN\_rsp', then a decision diamond. The diamond has a 'Yes' path to circle 'OK' and a 'No' path to circle 'Vr'. A note next to the diamond asks: 'Received AC version (Vr)= the one defined in this version of 3GPP TS 29.002?'. + +4737 + +4738 + +Figure 25.1/1 (sheet 2 of 2): Macro Receive\_Open\_Ind + +![Flowchart for macrodefinition Receive_Open_Cnf. It starts with a connector, followed by 'Wait_For_Open_Cnf'. A horizontal line branches into three paths: 1) MAP_NOTICE_ind leads to MAP_CLOSE_req and then an Error state. 2) An unlabeled path leads to a box with MAP_U_ABORT_ind and MAP_P_ABORT_ind, then to an Error state. 3) MAP_OPEN_cnf leads to a 'Result?' decision diamond. From 'Result?', 'Dialogue accepted' leads to an OK state, and 'Dialogue refused' leads to a 'Refuse reason?' decision diamond. From 'Refuse reason?', 'AC not supported' leads to a 'Yes/No' decision diamond (Yes leads to Vr, No leads to Error), 'Potential version incompatibility' leads to a 'Vr:=V1' box and then to a Vr state, and 'Else' leads to an Error state.](f72079d5107eb4d888c7d6c24dfed66e_img.jpg) + +macrodefinition **Receive\_Open\_Cnf** **Rec\_Open\_Cnf1(1)** + +Macro to handle a MAP\_OPEN confirm + +Signals to/from the right are to/from the remote peer entity + +``` + +graph TD + Start([ ]) --> Wait[Wait_For_Open_Cnf] + Wait --> Branch1(( )) + Branch1 --> Notice[MAP_NOTICE_ind] + Branch1 --> Unlabeled[ ] + Branch1 --> OpenCnf[MAP_OPEN_cnf] + Notice --> CloseReq[MAP_CLOSE_req] + CloseReq --> Error1((Error)) + Unlabeled --> AbortInd[MAP_U_ABORT_ind, MAP_P_ABORT_ind] + AbortInd --> Error2((Error)) + OpenCnf --> Result{Result?} + Result -- Dialogue accepted --> OK((OK)) + Result -- Dialogue refused --> RefuseReason{Refuse reason?} + RefuseReason -- AC not supported --> YesNo{Yes/No} + YesNo -- Yes --> Vr1((Vr)) + YesNo -- No --> Error3((Error)) + RefuseReason -- Potential version incompatibility --> VrAssign[Vr:=V1] + VrAssign --> Vr2((Vr)) + RefuseReason -- Else --> Error4((Error)) + +``` + +Flowchart for macrodefinition Receive\_Open\_Cnf. It starts with a connector, followed by 'Wait\_For\_Open\_Cnf'. A horizontal line branches into three paths: 1) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req and then an Error state. 2) An unlabeled path leads to a box with MAP\_U\_ABORT\_ind and MAP\_P\_ABORT\_ind, then to an Error state. 3) MAP\_OPEN\_cnf leads to a 'Result?' decision diamond. From 'Result?', 'Dialogue accepted' leads to an OK state, and 'Dialogue refused' leads to a 'Refuse reason?' decision diamond. From 'Refuse reason?', 'AC not supported' leads to a 'Yes/No' decision diamond (Yes leads to Vr, No leads to Error), 'Potential version incompatibility' leads to a 'Vr:=V1' box and then to a Vr state, and 'Else' leads to an Error state. + +4739 + +4740 + +**Figure 25.1/2: Macro Receive\_Open\_Cnf** + +macrodefinition Check\_Reference + +Check\_Ref1(1) + +Macro to check a received destination reference or originating reference + +![Flowchart for macro Check_Reference. It starts with a connector, then a decision 'Reference present?'. If 'No', it goes to a second decision 'Reference required for this AC?'. If 'Yes' to the second decision, it ends in 'Error'; if 'No', it ends in 'OK'. If 'Yes' to the first decision, it goes to a third decision 'Reference allowed for this AC?'. If 'Yes' to the third decision, it goes to a fourth decision 'Data type correct?'. If 'Yes' to the fourth decision, it ends in 'OK'; if 'No', it ends in 'Error'. If 'No' to the third decision, it ends in 'Error'.](8e7bb810b1f26df58adcdb261f87a400_img.jpg) + +``` +graph TD; Start([ ]) --> Q1{Reference present?}; Q1 -- No --> Q2{Reference required for this AC?}; Q1 -- Yes --> Q3{Reference allowed for this AC?}; Q2 -- Yes --> Error1([Error]); Q2 -- No --> OK1([OK]); Q3 -- Yes --> Q4{Data type correct?}; Q3 -- No --> Error2([Error]); Q4 -- Yes --> OK2([OK]); Q4 -- No --> Error3([Error]); +``` + +Flowchart for macro Check\_Reference. It starts with a connector, then a decision 'Reference present?'. If 'No', it goes to a second decision 'Reference required for this AC?'. If 'Yes' to the second decision, it ends in 'Error'; if 'No', it ends in 'OK'. If 'Yes' to the first decision, it goes to a third decision 'Reference allowed for this AC?'. If 'Yes' to the third decision, it goes to a fourth decision 'Data type correct?'. If 'Yes' to the fourth decision, it ends in 'OK'; if 'No', it ends in 'Error'. If 'No' to the third decision, it ends in 'Error'. + +4741 + +4742 + +Figure 25.1/3: Macro Check\_Reference + +4743 **25.2**    **Macros to check the content of indication and confirmation** +4744            **primitives** + +4745 **25.2.1**    **Macro Check\_Indication** + +4746 This macro checks that an indication includes all the parameters required by the application, no more and no less, and +4747 that the parameters are all within the correct range. It does not handle syntax checking; that is part of the function of the +4748 MAP protocol machine. + +4749 **25.2.2**    **Macro Check\_Confirmation** + +4750 This macro checks whether a confirmation contains an error or a result, and if it contains a result whether the result is +4751 correctly formed. + +macrodefinition Check\_Indication + +Check\_Ind1(1) + +Macro to check the content +of a MAP specific service indication + +![Flowchart for macro Check_Indication. It starts with a connector, followed by a decision 'Data missing?'. If 'Yes', it goes to 'Set User Error: Data missing' and then an 'Error' connector. If 'No', it goes to 'Unexpected data?'. If 'Yes', it goes to 'Set User Error: Unexpected data value' and then an 'Error' connector. If 'No', it goes to 'Unexpected value?'. If 'Yes', it goes to the same 'Set User Error: Unexpected data value' block. If 'No', it goes to an 'OK' connector.](6cbd3519014bac30018a1913c42f430b_img.jpg) + +``` +graph TD; Start([ ]) --> D1{Data missing?}; D1 -- Yes --> E1[Set User Error: Data missing]; E1 --> Error1((Error)); D1 -- No --> D2{Unexpected data?}; D2 -- Yes --> E2[Set User Error: Unexpected data value]; D2 -- No --> D3{Unexpected value?}; D3 -- Yes --> E2; D3 -- No --> OK((OK)); E2 --> Error2((Error)); +``` + +Flowchart for macro Check\_Indication. It starts with a connector, followed by a decision 'Data missing?'. If 'Yes', it goes to 'Set User Error: Data missing' and then an 'Error' connector. If 'No', it goes to 'Unexpected data?'. If 'Yes', it goes to 'Set User Error: Unexpected data value' and then an 'Error' connector. If 'No', it goes to 'Unexpected value?'. If 'Yes', it goes to the same 'Set User Error: Unexpected data value' block. If 'No', it goes to an 'OK' connector. + +4752 + +4753 + +Figure 25.2/1: Macro Check\_Indication + +![Flowchart for macrodefinition Check_Confirmation. It starts with an oval connector, followed by a series of decision diamonds: 'Provider error?', 'User error?', 'Data missing?', 'Unexpected data?', and 'Unexpected value?'. 'Yes' paths from 'Provider error?' and 'User error?' lead to a 'MAP_CLOSE_req' block and a 'Provider Error' block. 'Yes' paths from 'Data missing?', 'Unexpected data?', and 'Unexpected value?' lead to a 'Data Error' block. A 'No' path from 'Unexpected value?' leads to an 'OK' connector.](862ff33478042f58ccebd2dda6efa7e8_img.jpg) + +**macrodefinition Check\_Confirmation** **Check\_Cnf1(1)** + +Macro to check the content of a MAP specific service confirmation + +Signals to/from the right are to/from the remote peer entity + +``` + + graph TD + Start([ ]) --> D1{Provider error?} + D1 -- Yes --> MAP_CLOSE_req{{MAP_CLOSE_req}} + D1 -- No --> D2{User error?} + D2 -- Yes --> User_Error(( )) + D2 -- No --> D3{Data missing?} + D3 -- Yes --> Data_Error(( )) + D3 -- No --> D4{Unexpected data?} + D4 -- Yes --> Data_Error + D4 -- No --> D5{Unexpected value?} + D5 -- Yes --> Data_Error + D5 -- No --> OK([OK]) + MAP_CLOSE_req --> Provider_Error(( )) + +``` + +Flowchart for macrodefinition Check\_Confirmation. It starts with an oval connector, followed by a series of decision diamonds: 'Provider error?', 'User error?', 'Data missing?', 'Unexpected data?', and 'Unexpected value?'. 'Yes' paths from 'Provider error?' and 'User error?' lead to a 'MAP\_CLOSE\_req' block and a 'Provider Error' block. 'Yes' paths from 'Data missing?', 'Unexpected data?', and 'Unexpected value?' lead to a 'Data Error' block. A 'No' path from 'Unexpected value?' leads to an 'OK' connector. + +4754 + +4755 + +**Figure 25.2/2: Macro Check\_Confirmation** + +## 4756 25.3 The page and search macros + +### 4757 25.3.1 Macro PAGE\_MSC + +4758 This macro is called if an unstructured SS notification, a network-initiated unstructured SS request or a mobile +4759 terminating short message is to be delivered to the MS and the current location area identity of the MS is known in the +4760 VLR. + +4761 If an MM-connection over the radio link already exists for the given IMSI, the MSC sets the access connection status +4762 according to the characteristics of the existing connection (i.e. RR-connection established, ciphering mode on/off, MM- +4763 connection existing and authenticated or not). + +4764 If the MSC pages the MS and the VLR provided the TMSI, the MSC uses it to identify the MS at the radio interface; +4765 otherwise the MSC uses the IMSI. The MSC also uses the IMSI to determine the page group (see 3GPP TS 24.008 +4766 [35]). + +4767 If the MS responds with a channel request containing an establishment cause which is not "answer to paging" the MSC +4768 sends a MAP\_PAGE response primitive with user error Busy Subscriber. This gives priority to the mobile originating +4769 request. Alternatively, as an implementation option, the MSC may treat this as a response to paging, which gives +4770 priority to the mobile terminating request. + +4771 If the paging is for MT SMS delivery and the VLR aborts the transaction before the MSC receives a response from the +4772 MS, the MSC aborts the transaction with the SMS-GMSC. + +### 4773 25.3.2 Macro Search\_For\_MS\_MSC + +4774 This macro is called if an unstructured SS notification, a network-initiated unstructured SS request or a mobile +4775 terminating short message is to be delivered to the MS and the current location area identity of the MS is not known in +4776 VLR. + +4777 If an MM-connection over the radio link already exists for the given IMSI, the MSC returns a +4778 MAP\_SEARCH\_FOR\_MS response containing the IMSI and current location area identification of the called MS to the +4779 VLR and sets the access connection status according to the characteristics of the existing connection (i.e. RR- +4780 connection established, ciphering mode on/off, MM-connection existing and authenticated or not). + +4781 If the MSC pages the MS, the MSC uses the IMSI to identify the subscriber and the page group (see 3GPP TS 24.008 +4782 [35]). + +4783 If the MS responds with a channel request containing an establishment cause which is not "answer to paging" the MSC +4784 sends a MAP\_SEARCH\_FOR\_MS response with user error Busy Subscriber. This gives priority to the mobile +4785 originating request. Alternatively, as an implementation option, the MSC may treat this as a response to paging, which +4786 gives priority to the mobile terminating request. + +4787 If the paging is for MT SMS delivery and the VLR aborts the transaction before the MSC receives a response from the +4788 MS, the MSC aborts the transaction with the SMS-GMSC. + +![Flowchart for macrodefinition Page_MSC. It starts with MAP_PAGE_ind, checks LAI known, transaction still exists, and MS connection exists. If OK, it sends A_Page_Request and waits for response. If No to any check, it sets user errors (Unknown LAI or System failure) and returns MAP_PAGE_rsp. The Wait_For_Page_Response block leads to various responses: A_Page_Response (OK), A_No_Page_Response (1), A_CM_Service_Request (1), MAP_U_ABORT_ind (Null), and signals from SMS-GMSC (Null).](91243a030cf879636d9526d54e9675e1_img.jpg) + +**macrodefinition Page\_MSC** **Page\_MSC1(1)** + +Macro in the MSC to page an MS for network initiated SS activity or SMS delivery + +Signals to/from the left are to/from the BSS; + signals to/from the right are to/from the VLR + unless marked otherwise + +``` + + graph TD + Start([Start]) --> MAP_PAGE_ind[MAP_PAGE_ind] + MAP_PAGE_ind --> Check_Ind[Check_Indication] + Check_Ind -- OK --> LAI_Known{LAI known?} + Check_Ind -- Error --> Error_Sync(( )) + + LAI_Known -- No --> Set_Error_Unknown[Set User Error: Unknown LAI] + Set_Error_Unknown --> Error_Sync + + LAI_Known -- Yes --> Transaction_Exists{Transaction still exists?} + + Transaction_Exists -- No --> Set_Error_System[Set User Error: System failure] + Set_Error_System --> Error_Sync + + Transaction_Exists -- Yes --> MS_Connection{MS connection exists?} + + MS_Connection -- No --> A_Page_Req{A_Page_Request} + + MS_Connection -- Yes --> Set_Access_Status[Set access connection status] + + A_Page_Req --> Wait_For_Resp[Wait_For_Page_Response] + + Wait_For_Resp --> A_Page_Resp[A_Page_Response] + A_Page_Resp --> Set_Access_Status_1[Set access connection status] + Set_Access_Status_1 --> OK_1((OK)) + + Wait_For_Resp --> A_No_Page_Resp[A_No_Page_Response] + A_No_Page_Resp --> Set_Error_Absent[Set User Error: Absent Subscriber] + Set_Error_Absent --> 1_1((1)) + + Wait_For_Resp --> A_CM_Service_Req[A_CM_Service_Request] + A_CM_Service_Req --> Set_Error_Busy[Set User Error: Busy Subscriber] + Set_Error_Busy --> 1_2((1)) + + Wait_For_Resp --> MAP_U_ABORT_ind[MAP_U_ABORT_ind] + MAP_U_ABORT_ind --> MAP_U_ABORT_req[MAP_U_ABORT_req] + MAP_U_ABORT_req --> To_SMS_GMSC[To SMS-GMSC] + To_SMS_GMSC --> Null_1((Null)) + + Wait_For_Resp --> From_SMS_GMSC[From SMS-GMSC] + From_SMS_GMSC --> MAP_U_ABORT_req_2[MAP_U_ABORT_req] + MAP_U_ABORT_req_2 --> Null_2((Null)) + + Error_Sync --> MAP_PAGE_rsp[MAP_PAGE_rsp] + MAP_PAGE_rsp --> MAP_DELIMITER_req[MAP_DELIMITER_req] + +``` + +Flowchart for macrodefinition Page\_MSC. It starts with MAP\_PAGE\_ind, checks LAI known, transaction still exists, and MS connection exists. If OK, it sends A\_Page\_Request and waits for response. If No to any check, it sets user errors (Unknown LAI or System failure) and returns MAP\_PAGE\_rsp. The Wait\_For\_Page\_Response block leads to various responses: A\_Page\_Response (OK), A\_No\_Page\_Response (1), A\_CM\_Service\_Request (1), MAP\_U\_ABORT\_ind (Null), and signals from SMS-GMSC (Null). + +4789 + +4790 + +Figure 25.3/1: Macro Page\_MSC + +![Flowchart for Search_For_MS_MSC macro. It starts with an entry point, followed by MAP_SEARCH_FOR_MS_ind. A decision 'Check_Indication' leads to 'OK' or 'Error'. 'OK' leads to 'Transaction still exists?'. If 'Yes', it leads to 'MS connection exists?'. If 'Yes', it goes to connector 2. If 'No', it goes to 'A_Page_Request'. 'A_Page_Request' leads to 'Wait_For_Search_Response'. 'Error' from 'Check_Indication' leads to connector 1, then to a merge point. From the merge point, it goes to 'MAP_SEARCH_FOR_MS_rsp' and 'MAP_DELIMITER_req', then to an 'Error' connector. 'Wait_For_Search_Response' leads to a horizontal bus with five branches: 1. 'A_Page_Response' leads to connector 2, then to a merge point for 'MAP_SEARCH_FOR_MS_rsp' and 'MAP_DELIMITER_req', then to 'Set access connection status; Set LAI', ending at 'OK' connector. 2. 'A_No_Page_Response' leads to 'Set User Error: Absent Subscriber', ending at connector 1. 3. 'A_CM_Service_Request' leads to 'Set User Error: Busy Subscriber', ending at connector 1. 4. 'MAP_U_ABORT_ind' leads to 'MAP_U_ABORT_req', which goes 'To SMS-GMSC' (from a 'From SMS-GMSC' note), ending at 'Null' connector. 5. A branch with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to a merge point, then to 'MAP_U_ABORT_req', ending at 'Null' connector.](8aac418e4cec0201d026975ef91bf912_img.jpg) + +**macrodefinition Search\_For\_MS\_MSC** **Search\_MSC1(1)** + +Macro in the MSC to search for an MS (i.e. page in all location areas) for network initiated SS activity or SMS delivery + +Signals to/from the left are to/from the BSS; signals to/from the right are to/from the VLR unless marked otherwise + +``` + + graph TD + Start([ ]) --> MAP_SEARCH_FOR_MS_ind[/MAP_SEARCH_FOR_MS_ind/] + MAP_SEARCH_FOR_MS_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> Transaction_exists{Transaction still exists?} + Check_Indication -- Error --> C1((1)) + Transaction_exists -- Yes --> MS_connection{MS connection exists?} + Transaction_exists -- No --> A_Page_Request{A_Page_Request} + MS_connection -- Yes --> C2((2)) + MS_connection -- No --> A_Page_Request + A_Page_Request --> Wait_For_Search_Response([Wait_For_Search_Response]) + C1 --> Merge1(( )) + Merge1 --> MAP_SEARCH_FOR_MS_rsp[/MAP_SEARCH_FOR_MS_rsp/] + Merge1 --> MAP_DELIMITER_req[/MAP_DELIMITER_req/] + MAP_SEARCH_FOR_MS_rsp --> Error((Error)) + Wait_For_Search_Response --> Bus[ ] + Bus --> A_Page_Response[/A_Page_Response/] + Bus --> A_No_Page_Response[/A_No_Page_Response/] + Bus --> A_CM_Service_Request[/A_CM_Service_Request/] + Bus --> MAP_U_ABORT_ind[/MAP_U_ABORT_ind/] + Bus --> MAP_U_ABORT_ind_2[/MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind/] + A_Page_Response --> C2 + C2 --> Merge2(( )) + Merge2 --> MAP_SEARCH_FOR_MS_rsp_2[/MAP_SEARCH_FOR_MS_rsp/] + Merge2 --> MAP_DELIMITER_req_2[/MAP_DELIMITER_req/] + MAP_SEARCH_FOR_MS_rsp_2 --> Set_access[Set access connection status; Set LAI] + Set_access --> OK((OK)) + A_No_Page_Response --> Set_User_Error_Absent[Set User Error: Absent Subscriber] + Set_User_Error_Absent --> C1_1((1)) + A_CM_Service_Request --> Set_User_Error_Busy[Set User Error: Busy Subscriber] + Set_User_Error_Busy --> C1_2((1)) + MAP_U_ABORT_ind --> MAP_U_ABORT_req_1[/MAP_U_ABORT_req/] + MAP_U_ABORT_req_1 --> To_SMS_GMSC[To SMS-GMSC] + From_SMS_GMSC[From SMS-GMSC] -.-> To_SMS_GMSC + MAP_U_ABORT_req_1 --> Null_1((Null)) + MAP_U_ABORT_ind_2 --> Merge3(( )) + Merge3 --> MAP_U_ABORT_req_2[/MAP_U_ABORT_req/] + MAP_U_ABORT_req_2 --> Null_2((Null)) + +``` + +Flowchart for Search\_For\_MS\_MSC macro. It starts with an entry point, followed by MAP\_SEARCH\_FOR\_MS\_ind. A decision 'Check\_Indication' leads to 'OK' or 'Error'. 'OK' leads to 'Transaction still exists?'. If 'Yes', it leads to 'MS connection exists?'. If 'Yes', it goes to connector 2. If 'No', it goes to 'A\_Page\_Request'. 'A\_Page\_Request' leads to 'Wait\_For\_Search\_Response'. 'Error' from 'Check\_Indication' leads to connector 1, then to a merge point. From the merge point, it goes to 'MAP\_SEARCH\_FOR\_MS\_rsp' and 'MAP\_DELIMITER\_req', then to an 'Error' connector. 'Wait\_For\_Search\_Response' leads to a horizontal bus with five branches: 1. 'A\_Page\_Response' leads to connector 2, then to a merge point for 'MAP\_SEARCH\_FOR\_MS\_rsp' and 'MAP\_DELIMITER\_req', then to 'Set access connection status; Set LAI', ending at 'OK' connector. 2. 'A\_No\_Page\_Response' leads to 'Set User Error: Absent Subscriber', ending at connector 1. 3. 'A\_CM\_Service\_Request' leads to 'Set User Error: Busy Subscriber', ending at connector 1. 4. 'MAP\_U\_ABORT\_ind' leads to 'MAP\_U\_ABORT\_req', which goes 'To SMS-GMSC' (from a 'From SMS-GMSC' note), ending at 'Null' connector. 5. A branch with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to a merge point, then to 'MAP\_U\_ABORT\_req', ending at 'Null' connector. + +4791 + +4792 + +**Figure 25.3/2: Macro Search\_for\_MS\_MSC** + +## 4793 25.4 Macros for handling an Access Request + +4794 These macros are invoked when a MS accesses the network, e.g. to submit an MO short message or when responding to +4795 paging. The macros handle identification and authentication of the mobile subscriber as well as invocation of security +4796 related features (see 3GPP TS 42.009 [6]). + +### 4797 25.4.1 Macro Process\_Access\_Request\_MSC + +4798 Sheet 1: The MAP\_PROCESS\_ACCESS\_REQUEST request includes the following parameters: + +- 4799 - the received subscriber identification (IMSI, TMSI); +- 4800 - the CM service type, indicating the type of request; +- 4801 - the status of the access connection, i.e. whether a connection to this MS already exists and if so, whether it is +4802 already authenticated and ciphered; +- 4803 - the current location area id of the MS; and +- 4804 - the CKSN received from the MS. + +4805 Sheet 2, sheet 3: If the MSC receives an A\_SETUP indication while it is waiting for further instructions from the VLR +4806 or for the acknowledgment of TMSI reallocation from the MS, the MSC saves the setup request for processing after +4807 control has returned from the macro Process\_Access\_Request\_MSC to the calling process. + +4808 Sheet 3: When the MSC is waiting for a possible instruction to allocate a new TMSI, a MAP\_DELIMITER indication +4809 indicates that TMSI reallocation is not required. + +4810 Sheet 3: If the MS sends a TMSI reallocation failure in response to the TMSI reallocation command, the MSC takes the +4811 OK exit; the VLR treats the lack of response as a provider error (see macro Process\_Access\_Request\_VLR). + +### 4812 25.4.2 Macro Process\_Access\_Request\_VLR + +4813 Sheet 3: If the MSC does not send a positive response to the MAP\_FORWARD\_NEW\_TMSI request, this is treated as +4814 a MAP\_FORWARD\_NEW\_TMSI confirmation containing a provider error. The Macro takes the Error exit. If TMSI +4815 reallocation does not succeed, the old TMSI is frozen, to prevent it from being reallocated. In this case, both old and +4816 new TMSIs are regarded as valid. + +### 4817 25.4.3 Macro Obtain\_Identity\_VLR + +4818 This macro is invoked by the macro Process\_Access\_Request\_VLR if the subscriber's identity is not known in the +4819 VLR. + +4820 It is an operator option to allow or prevent retrieval of the IMSI without encryption. + +### 4821 25.4.4 Process Update\_Location\_Child\_VLR + +4822 This process is started when the subscriber successfully accesses the network, e.g. for mobile originated short message +4823 submission, response to paging or supplementary services handling. + +4824 The procedure Notify\_gsmSCF is specified in 3GPP TS 23.078. + +![Sequence diagram for Process_Access_Request_MSC macro. The process starts with a decision 'VLR dialogue exists?'. If 'Yes', it sends 'MAP_PROCESS_ACCESS_REQUEST_req' and 'MAP_DELIMITER_REQ' to the VLR. If 'No', it sends 'MAP_OPEN_REQ', 'MAP_PROCESS_ACCESS_REQUEST_req', and 'MAP_DELIMITER_REQ' to the VLR, then receives a confirmation. Both paths lead to 'Wait_For_PAR_Result'. From there, it branches into 'Trace_Subscriber_Activity_MSC', 'Obtain_IMSI_MSC', and 'Obtain_IMEI_MSC'. 'Obtain_IMSI_MSC' and 'Obtain_IMEI_MSC' lead to 'Wait_For_PAR_Result' on OK and 'Error' on failure. All three lead to a merge point before 'MAP_PROCESS_ACCESS_REQUEST_cnf'. This leads to 'Check Confirmation'. If 'OK', it checks 'Ciphering required'. If 'True', it sends 'A_CIPHER_MODE_COMMAND_req' to the MS. If 'False', it checks 'CM service type= Page response?'. If 'Yes', it sends 'A_CM_SERVICE_ACCEPT_req' to the MS. Both 'A_CIPHER_MODE_COMMAND_req' and 'A_CM_SERVICE_ACCEPT_req' lead to 'Wait_For_TMSI_Reallocation'. If 'Check Confirmation' is not 'OK', it maps the error to a reject cause and sends 'A_CM_SERVICE_REJECT_req' to the MS, leading to 'Error'.](4992b9ef8fd1b4f81f112d70312862fc_img.jpg) + +**macrodefinition Process\_Access\_Request\_MSC** **Proc\_Acc\_Req\_MSC1(3)** + +Macro in the MSC to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +``` + +sequenceDiagram + participant MS + participant VLR + participant MSC + + Note left of MSC: Macro in the MSC to handle a request from the MS for access for SMS transfer or SS activity + Note right of MSC: Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + + MSC->>VLR: MAP_PROCESS_ACCESS_REQUEST_req, MAP_DELIMITER_REQ + Note right of MSC: VLR dialogue exists? + alt Yes: Proceed to Wait_For_PAR_Result + alt No: Send MAP_OPEN_REQ, MAP_PROCESS_ACCESS_REQUEST_req, MAP_DELIMITER_REQ to VLR + VLR-->>MSC: Receive_Open_Cnf + Note right of MSC: OK + MSC->>VLR: Wait_For_PAR_Result + Note right of MSC: Vr, Error + MSC->>MSC: Trace_Subscriber_Activity_MSC + MSC->>MSC: Obtain_IMSI_MSC + MSC->>MSC: Obtain_IMEI_MSC + Note right of MSC: OK + Note right of MSC: Error + MSC->>MSC: Wait_For_PAR_Result + Note right of MSC: Error + MSC->>MSC: Wait_For_PAR_Result + Note right of MSC: MAP_PROCESS_ACCESS_REQUEST_cnf + MSC->>MSC: Check Confirmation + Note right of MSC: OK + Note right of MSC: User error, Data error + MSC->>MSC: Ciphering required + Note right of MSC: True + Note right of MSC: False + MSC->>MSC: CM service type= Page response? + Note right of MSC: Yes + Note right of MSC: No + MSC->>MS: A_CIPHER_MODE_COMMAND_req + MSC->>MS: A_CM_SERVICE_ACCEPT_req + Note right of MSC: A_CM_SERVICE_REJECT_req + MSC->>MS: Error + MSC->>MSC: Wait_For_TMSI_Reallocation + +``` + +Sequence diagram for Process\_Access\_Request\_MSC macro. The process starts with a decision 'VLR dialogue exists?'. If 'Yes', it sends 'MAP\_PROCESS\_ACCESS\_REQUEST\_req' and 'MAP\_DELIMITER\_REQ' to the VLR. If 'No', it sends 'MAP\_OPEN\_REQ', 'MAP\_PROCESS\_ACCESS\_REQUEST\_req', and 'MAP\_DELIMITER\_REQ' to the VLR, then receives a confirmation. Both paths lead to 'Wait\_For\_PAR\_Result'. From there, it branches into 'Trace\_Subscriber\_Activity\_MSC', 'Obtain\_IMSI\_MSC', and 'Obtain\_IMEI\_MSC'. 'Obtain\_IMSI\_MSC' and 'Obtain\_IMEI\_MSC' lead to 'Wait\_For\_PAR\_Result' on OK and 'Error' on failure. All three lead to a merge point before 'MAP\_PROCESS\_ACCESS\_REQUEST\_cnf'. This leads to 'Check Confirmation'. If 'OK', it checks 'Ciphering required'. If 'True', it sends 'A\_CIPHER\_MODE\_COMMAND\_req' to the MS. If 'False', it checks 'CM service type= Page response?'. If 'Yes', it sends 'A\_CM\_SERVICE\_ACCEPT\_req' to the MS. Both 'A\_CIPHER\_MODE\_COMMAND\_req' and 'A\_CM\_SERVICE\_ACCEPT\_req' lead to 'Wait\_For\_TMSI\_Reallocation'. If 'Check Confirmation' is not 'OK', it maps the error to a reject cause and sends 'A\_CM\_SERVICE\_REJECT\_req' to the MS, leading to 'Error'. + +4825 + +4826 + +Figure 25.4/1 (sheet 1 of 3): Macro Process\_Access\_Request\_MSC + +![State transition diagram for Process_Access_Request_MSC macro. It consists of two main vertical flows. The top flow starts with 'Wait_For_PAR_Result' and branches into 'A_CM_SERVICE_ABORT_ind', 'MAP_SET_CIPHERING_MODE_ind', 'Authenticate_MSC', 'Check_IMEI_MSC', and a merge point. The bottom flow starts with 'Wait_For_TMSI_Reallocation' and branches into 'A_CM_SERVICE_ABORT_ind', 'A_SETUP_ind', 'Authenticate_MSC', 'Check_IMEI_MSC', and a merge point. Both flows include 'Error' states and 'Wait_For_PAR_Result' loops.](9241ae748c6bc391a42f69c9337d18c0_img.jpg) + +**macrodefinition Process\_Access\_Request\_MSC** **Proc\_Acc\_Req\_MSC2(3)** + +Macro in the MSC to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MS; +signals to/from the right are to/from the VLR + +``` + + graph TD + subgraph TopFlow [Top Flow] + WPR1[Wait_For_PAR_Result] --> AC1{A_CM_SERVICE_ABORT_ind} + WPR1 --> M1[MAP_SET_CIPHERING_MODE_ind] + WPR1 --> AM1[Authenticate_MSC] + WPR1 --> CM1[Check_IMEI_MSC] + WPR1 --> Merge1(( )) + AC1 --> MU1[MAP_U_ABORT_req] + MU1 --> E1((Error)) + M1 --> CR1[Ciphering Required:= True] + CR1 --> WPR2[Wait_For_PAR_Result] + AM1 -- OK --> WPR3[Wait_For_PAR_Result] + AM1 -- Error --> E2((Error)) + CM1 -- OK --> WPR4[Wait_For_PAR_Result] + CM1 -- Error --> E2 + Merge1 --> MU2[MAP_U_ABORT_ind, MAP_CLOSE_ind] + MU2 --> AC2{A_CM_SERVICE_REJECT_req} + AC2 --> E3((Error)) + end + + subgraph BottomFlow [Bottom Flow] + WTR[Wait_For_TMSI_Reallocation] --> AC3{A_CM_SERVICE_ABORT_ind} + WTR --> AS[A_SETUP_ind] + WTR --> AM2[Authenticate_MSC] + WTR --> CM2[Check_IMEI_MSC] + WTR --> Merge2(( )) + AC3 --> MU3[MAP_U_ABORT_req] + MU3 --> E4((Error)) + AM2 -- OK --> WPR5[Wait_For_PAR_Result] + AM2 -- Error --> E5((Error)) + CM2 -- OK --> WPR6[Wait_For_PAR_Result] + CM2 -- Error --> E5 + Merge2 --> MU4[MAP_U_ABORT_ind, MAP_CLOSE_ind] + MU4 --> AC4{A_CM_SERVICE_REJECT_req} + AC4 --> E6((Error)) + end + +``` + +State transition diagram for Process\_Access\_Request\_MSC macro. It consists of two main vertical flows. The top flow starts with 'Wait\_For\_PAR\_Result' and branches into 'A\_CM\_SERVICE\_ABORT\_ind', 'MAP\_SET\_CIPHERING\_MODE\_ind', 'Authenticate\_MSC', 'Check\_IMEI\_MSC', and a merge point. The bottom flow starts with 'Wait\_For\_TMSI\_Reallocation' and branches into 'A\_CM\_SERVICE\_ABORT\_ind', 'A\_SETUP\_ind', 'Authenticate\_MSC', 'Check\_IMEI\_MSC', and a merge point. Both flows include 'Error' states and 'Wait\_For\_PAR\_Result' loops. + +4827 + +4828 + +**Figure 25.4/1 (sheet 2 of 3): Macro Process\_Access\_Request\_MSC** + +![Sequence diagram for Process_Access_Request_MSC. The process starts with 'Wait_For_TMSI_Reallocation', followed by a merge point. From the merge point, one path goes left through 'MAP_DELIMITER_ind' to an 'OK' terminal. The other path goes right through 'MAP_FORWARD_NEW_TMSI_ind' to 'A_TMSI_REALLOC_CMD_req', then 'Wait_For_TMSI_Ack'. From 'Wait_For_TMSI_Ack', the path splits into five branches: 1) 'A_CM_SERVICE_ABORT_ind' leads to 'MAP_U_ABORT_req' and an 'Error' terminal. 2) 'A_TMSI_REALLOC_COMPLETE_ind' leads to a merge point, then 'MAP_FORWARD_NEW_TMSI_rsp' and 'MAP_DELIMITER_req', ending at an 'OK' terminal. 3) 'A_TMSI_REALLOC_FAILURE_ind' leads to an 'OK' terminal. 4) 'A_SETUP_ind' is a standalone path. 5) A merge point leads to 'MAP_U_ABORT_ind, MAP_CLOSE_ind', then 'A_CM_SERVICE_REJECT_req', ending at an 'Error' terminal.](220a56aa2a8455e5a0dba15a4acd596d_img.jpg) + +**macrodefinition Process\_Access\_Request\_MSC** **Proc\_Acc\_Req\_MSC3(3)** + +Macro in the MSC to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +``` + +sequenceDiagram + participant MS + participant MSC + participant VLR + + Note left of MSC: Macro in the MSC to handle a request from the MS for access for SMS transfer or SS activity + Note right of MSC: Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + + MSC->>MS: Wait_For_TMSI_Reallocation + Note right of MSC: + MSC->>VLR: MAP_FORWARD_NEW_TMSI_ind + Note left of MSC: + MSC->>MS: MAP_DELIMITER_ind + Note left of MSC: OK + Note right of MSC: + MSC->>MS: A_TMSI_REALLOC_CMD_req + Note right of MSC: + MSC->>MS: Wait_For_TMSI_Ack + Note right of MSC: + MSC->>MS: A_CM_SERVICE_ABORT_ind + Note left of MSC: + MSC->>VLR: MAP_U_ABORT_req + Note left of MSC: Error + Note right of MSC: + MSC->>MS: A_TMSI_REALLOC_COMPLETE_ind + Note right of MSC: + Note right of MSC: + MSC->>VLR: MAP_FORWARD_NEW_TMSI_rsp + MSC->>VLR: MAP_DELIMITER_req + Note right of MSC: OK + Note right of MSC: + MSC->>MS: A_TMSI_REALLOC_FAILURE_ind + Note left of MSC: OK + Note right of MSC: + MSC->>MS: A_SETUP_ind + Note right of MSC: + Note right of MSC: + MSC->>VLR: MAP_U_ABORT_ind, MAP_CLOSE_ind + Note right of MSC: + MSC->>MS: A_CM_SERVICE_REJECT_req + Note left of MSC: Error + +``` + +Sequence diagram for Process\_Access\_Request\_MSC. The process starts with 'Wait\_For\_TMSI\_Reallocation', followed by a merge point. From the merge point, one path goes left through 'MAP\_DELIMITER\_ind' to an 'OK' terminal. The other path goes right through 'MAP\_FORWARD\_NEW\_TMSI\_ind' to 'A\_TMSI\_REALLOC\_CMD\_req', then 'Wait\_For\_TMSI\_Ack'. From 'Wait\_For\_TMSI\_Ack', the path splits into five branches: 1) 'A\_CM\_SERVICE\_ABORT\_ind' leads to 'MAP\_U\_ABORT\_req' and an 'Error' terminal. 2) 'A\_TMSI\_REALLOC\_COMPLETE\_ind' leads to a merge point, then 'MAP\_FORWARD\_NEW\_TMSI\_rsp' and 'MAP\_DELIMITER\_req', ending at an 'OK' terminal. 3) 'A\_TMSI\_REALLOC\_FAILURE\_ind' leads to an 'OK' terminal. 4) 'A\_SETUP\_ind' is a standalone path. 5) A merge point leads to 'MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind', then 'A\_CM\_SERVICE\_REJECT\_req', ending at an 'Error' terminal. + +4829 + +4830 + +**Figure 25.4/1 (sheet 3 of 3): Macro Process\_Access\_Request\_MSC** + +![Flowchart for Process_Access_Request_VLR macro. It starts with an entry point, receives a MAP_PROCESS_ACCESS_REQUEST_ind, checks the indication, and then branches based on whether the identity is known and if authentication is required. It handles various error cases like system failure, illegal subscriber, or unidentified subscriber, and finally sends a response.](d63ed85b030c766b96f0c01ec86f5868_img.jpg) + +**macrodefinition Process\_Access\_Request\_VLR** **Proc\_Acc\_Req\_VLR1(3)** + +Macro in the VLR to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MSC + +``` + + graph TD + Entry([ ]) --> Input{{ }} + Input -- "MAP_PROCESS_ACCESS_REQUEST_ind" --> Check[Check_Indication] + Check --> IdentityKnown{Identity known?} + IdentityKnown -- No --> Obtain[Obtain Identity_VLR] + Obtain --> Error1((Error)) + Obtain -- OK --> IdentityIMEI{Identity=IMEI?} + IdentityKnown -- Yes --> IdentityIMEI + IdentityIMEI -- No --> AuthRequired{Authentication required?} + IdentityIMEI -- Yes --> Exit2((2)) + AuthRequired -- No --> SystemFailure[Set User Error: System Failure] + SystemFailure --> Exit2 + AuthRequired -- Yes --> Authenticate[Authenticate_VLR] + Authenticate -- "OK" --> Exit2 + Authenticate -- "Procedure_Error" --> SystemFailure + SystemFailure --> Exit2 + Authenticate -- "Illegal_Subscriber" --> Illegal[Set User Error: Illegal subscriber] + Illegal --> Exit2 + Authenticate -- "Aborted" --> Error2((Error)) + Authenticate -- "Unknown_Subscriber, Unidentified_Subscriber" --> Unidentified[Set User Error: Unidentified subscriber] + Unidentified --> Exit2 + Exit2 --> Output{{ }} + Output -- "MAP_PROCESS_ACCESS_REQUEST_rsp +MAP_CLOSE_req" --> Error3((Error)) + +``` + +Flowchart for Process\_Access\_Request\_VLR macro. It starts with an entry point, receives a MAP\_PROCESS\_ACCESS\_REQUEST\_ind, checks the indication, and then branches based on whether the identity is known and if authentication is required. It handles various error cases like system failure, illegal subscriber, or unidentified subscriber, and finally sends a response. + +4831 + +4832 + +**Figure 25.4/2 (sheet 1 of 3): Macro Process\_Access\_Request\_VLR** + +# macrodefinition Process\_Access\_Request\_VLR + +Proc\_Acc\_Req\_VLR2(3) + +Macro in the VLR to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MSC + +![Flowchart for Process_Access_Request_VLR macro. It starts at connector 2, checks radio contact, location info, subscriber data, roaming status, IMSI status, mobile reachability, tracing, and ciphering requirements, leading to connectors 1, 3, and 4.](7017f0dbe12b3cef766e7453972aed37_img.jpg) + +``` + +graph TD + 2((2)) --> C1[Confirmed by radio contact:=True] + C1 --> D1{ } + D1 -- Yes --> D2{Location info confirmed in HLR?} + D1 -- No --> P1[Update_Location_Child_VLR] + P1 --> D3{Subscriber data confirmed by HLR?} + D3 -- Yes --> D4{Roaming allowed in current LA?} + D3 -- No --> E1[Set User Error: Unidentified subscriber] + D4 -- Yes --> P2[IMSI detached:=False] + D4 -- No --> E2[Set User Error: Roaming not allowed in this LA] + P2 --> D5{Mobile Not Reachable Flag set?} + D5 -- Yes --> P3[Subscriber_Present_VLR] + P3 --> D6{Tracing required?} + D6 -- Yes --> P4[Trace_Subscriber_Activity_VLR] + P4 --> D7{Ciphering required?} + D7 -- Yes --> O1{{MAP_SET_CIPHERING_MODE_req +MAP_DELIMITER_req}} + O1 --> 3((3)) + D7 -- No --> 4((4)) + E1 --> 1((1)) + E2 --> 1 + +``` + +Flowchart for Process\_Access\_Request\_VLR macro. It starts at connector 2, checks radio contact, location info, subscriber data, roaming status, IMSI status, mobile reachability, tracing, and ciphering requirements, leading to connectors 1, 3, and 4. + +4833 + +4834 + +Figure 25.4/2 (sheet 2 of 3): Macro Process\_Access\_Request\_VLR + +macrodefinition Process\_Access\_Request\_VLR + +Proc\_Acc\_Req\_VLR3(3) + +Macro in the VLR to handle a request from the MS for access for SMS transfer or SS activity + +Signals to/from the left are to/from the MSC + +![Flowchart for Process_Access_Request_VLR macro. It starts at connector 3, checks if IMEI check is required. If yes, it calls Check_IMEI_VLR. If no, it proceeds to Identity:= IMSI. Both paths lead to a decision diamond. If 'TMSI reallocation required?' is Yes, it calls MAP_FORWARD_NEW_TMSI_req, Freeze old TMSI, Wait_For_TMSI_Ack, and then Check_Confirmation. If No, it goes to OK connector. If 'IMEI check required?' is No (from connector 4), it also proceeds to Identity:= IMSI. If 'IMEI check required?' is Yes, it calls Check_IMEI_VLR. Both paths from connector 4 lead to a decision diamond. If 'Error' or 'Aborted' from Check_IMEI_VLR, it sets IMSI detached:= True and Set User Error: Illegal equipment, then goes to connector 1. If 'OK', it proceeds to Identity:= IMSI. From Identity:= IMSI, it calls MAP_PROCESS_ACCESS_REQUEST_rsp and MAP_DELIMITER_req, then goes to OK connector. From Check_Confirmation, if 'Provider Error', it goes to Error connector. If 'User Error, Data Error', it goes to OK connector. If 'OK', it calls Unfreeze old TMSI and goes to OK connector.](ec13be3d306e581971b0f30add6c4241_img.jpg) + +``` + +graph TD + 3((3)) --> D1{IMEI check required?} + D1 -- No --> I1[Identity:= IMSI] + D1 -- Yes --> C1[Check_IMEI_VLR] + C1 -- Error --> ID1[IMSI detached:= True] + ID1 --> UE1[Set User Error: Illegal equipment] + UE1 --> 1_1((1)) + C1 -- Aborted --> E1((Error)) + C1 -- OK --> I1 + I1 --> D2{TMSI reallocation required?} + D2 -- Yes --> M1[MAP_FORWARD_NEW_TMSI_req +MAP_DELIMITER_req] + M1 --> F[Freeze old TMSI] + F --> W[Wait_For_TMSI_Ack] + W --> C2[Check_Confirmation] + D2 -- No --> OK_1((OK)) + 4((4)) --> D3{IMEI check required?} + D3 -- No --> I2[Identity:= IMSI] + D3 -- Yes --> C3[Check_IMEI_VLR] + C3 -- Error --> ID2[IMSI detached:= True] + ID2 --> UE2[Set User Error: Illegal equipment] + UE2 --> 1_2((1)) + C3 -- Aborted --> E2((Error)) + C3 -- OK --> I2 + I2 --> D4{TMSI reallocation required?} + D4 -- Yes --> M2[MAP_FORWARD_NEW_TMSI_req +MAP_DELIMITER_req] + M2 --> F2[Freeze old TMSI] + F2 --> W2[Wait_For_TMSI_Ack] + W2 --> C3_2[Check_Confirmation] + D4 -- No --> OK_2((OK)) + I2 --> M3[MAP_PROCESS_ACCESS_REQUEST_rsp +MAP_DELIMITER_req] + M3 --> OK_3((OK)) + C2 -- "Provider Error" --> E3((Error)) + C2 -- "User Error, Data Error" --> OK_4((OK)) + C2 -- OK --> U[Unfreeze old TMSI] + U --> OK_5((OK)) + +``` + +Flowchart for Process\_Access\_Request\_VLR macro. It starts at connector 3, checks if IMEI check is required. If yes, it calls Check\_IMEI\_VLR. If no, it proceeds to Identity:= IMSI. Both paths lead to a decision diamond. If 'TMSI reallocation required?' is Yes, it calls MAP\_FORWARD\_NEW\_TMSI\_req, Freeze old TMSI, Wait\_For\_TMSI\_Ack, and then Check\_Confirmation. If No, it goes to OK connector. If 'IMEI check required?' is No (from connector 4), it also proceeds to Identity:= IMSI. If 'IMEI check required?' is Yes, it calls Check\_IMEI\_VLR. Both paths from connector 4 lead to a decision diamond. If 'Error' or 'Aborted' from Check\_IMEI\_VLR, it sets IMSI detached:= True and Set User Error: Illegal equipment, then goes to connector 1. If 'OK', it proceeds to Identity:= IMSI. From Identity:= IMSI, it calls MAP\_PROCESS\_ACCESS\_REQUEST\_rsp and MAP\_DELIMITER\_req, then goes to OK connector. From Check\_Confirmation, if 'Provider Error', it goes to Error connector. If 'User Error, Data Error', it goes to OK connector. If 'OK', it calls Unfreeze old TMSI and goes to OK connector. + +4835 + +4836 + +Figure 25.4/2 (sheet 3 of 3): Macro Process\_Access\_Request\_VLR + +macrodefinition Obtain\_Identity\_VLR + +Obt\_ID\_VLR1(1) + +Macro in the VLR to obtain a useable identity of the MS + +![Flowchart for Obtain_Identity_VLR macro. It starts with an oval connector, followed by a decision 'Identity= IMSI?'. If 'Yes', it goes to an 'Error' terminal. If 'No', it goes to another decision 'Retrieval of IMSI allowed?'. If 'No', it goes to an 'Error' terminal. If 'Yes', it goes to a process 'Obtain IMSI_VLR'. From there, it goes to a decision 'IMSI known?'. If 'No', it goes to an 'Error' terminal. If 'Yes', it goes to an 'OK' terminal. If 'Aborted', it goes to an 'Aborted' terminal.](cec3bc41df2df61b9f95d88c0bf7ad99_img.jpg) + +``` +graph TD; Start([ ]) --> D1{Identity= IMSI?}; D1 -- Yes --> Error1((Error)); D1 -- No --> D2{Retrieval of IMSI allowed?}; D2 -- No --> Error2((Error)); D2 -- Yes --> P1[Obtain IMSI_VLR]; P1 -- OK --> D3{IMSI known?}; P1 -- Error --> Error3((Error)); P1 -- Aborted --> Aborted((Aborted)); D3 -- No --> Error4((Error)); D3 -- Yes --> OK((OK)); +``` + +Flowchart for Obtain\_Identity\_VLR macro. It starts with an oval connector, followed by a decision 'Identity= IMSI?'. If 'Yes', it goes to an 'Error' terminal. If 'No', it goes to another decision 'Retrieval of IMSI allowed?'. If 'No', it goes to an 'Error' terminal. If 'Yes', it goes to a process 'Obtain IMSI\_VLR'. From there, it goes to a decision 'IMSI known?'. If 'No', it goes to an 'Error' terminal. If 'Yes', it goes to an 'OK' terminal. If 'Aborted', it goes to an 'Aborted' terminal. + +4837 + +4838 + +Figure 25.4/3: Macro Obtain\_Identity\_VLR + +![Flowchart for Update_Location_Child_VLR process. It starts with a decision 'HLR address known?'. If 'No', it goes to 'Delete subscriber record'. If 'Yes', it sends MAP requests (OPEN_req, UPDATE_LOCATION_req, DELIMITER_req), receives Open_Cnf, and performs a MAP_Vr dialogue. The Result can be OK, Procedure Error/Aborted, or Unknown Subscriber/ Roaming Not Allowed. OK leads to 'Set Event met: Location update to other VLR', 'Notify_gsmSCF' (referencing 3GPP TS 23.078), and then a 'Wait_For_HLR_Response'. Procedure Error/Aborted and Unknown Subscriber/ Roaming Not Allowed both lead to 'Delete subscriber record'. From the first 'Wait_For_HLR_Response', it branches to 'Activate_Tracing_VLR', 'Insert_Subs_Data_VLR', 'MAP_NOTICE_ind', and a merge point. 'Activate_Tracing_VLR' and 'Insert_Subs_Data_VLR' lead to their own 'Wait_For_HLR_Response' blocks. 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which leads to a merge point. The merge point leads to a block with 'Subscriber data confirmed by HLR:=False' and 'Location information confirmed in HLR:=False', which then leads to another 'Wait_For_HLR_Response' block.](9fb3b9417f90b681f29dba5f20344645_img.jpg) + +**process Update\_Location\_Child\_VLR** **ULC\_VLR1(2)** + +Child process in the VLR to update the location information in the HLR + +Signals to/from the right are to/from the HLR + +``` + +graph TD + Start([ ]) --> HLR_Known{HLR address known?} + HLR_Known -- No --> Delete_1[Delete subscriber record] + HLR_Known -- Yes --> MAP_Req[MAP_OPEN_req +MAP_UPDATE_LOCATION_req +MAP_DELIMITER_req] + MAP_Req --> Open_Cnf[Receive Open_Cnf] + Open_Cnf -- Vr --> MAP_Vr[Perform MAP_Vr dialogue] + Open_Cnf -- Error --> X1((X)) + Open_Cnf -- OK --> Wait_1[Wait_For_HLR_Response] + MAP_Vr --> Result{Result} + Result -- OK --> Set_Event[Set Event met: +Location update to other VLR] + Set_Event --> Notify[Notify_gsmSCF] + Notify -.-> Ref[See 3GPP TS 23.078] + Notify --> X2((X)) + Result -- "Procedure Error, Aborted" --> X3((X)) + Result -- "Unknown Subscriber, +Roaming Not Allowed" --> Delete_2[Delete subscriber record] + Delete_2 --> X4((X)) + X2 --> Wait_2[Wait_For_HLR_Response] + Wait_2 --> Activate[Activate_Tracing_VLR] + Wait_2 --> Insert[Insert_Subs_Data_VLR] + Wait_2 --> Notice[MAP_NOTICE_ind] + Wait_2 --> Merge(( )) + Activate --> Wait_3[Wait_For_HLR_Response] + Insert --> Wait_4[Wait_For_HLR_Response] + Notice --> Close[MAP_CLOSE_req] + Close --> Merge + Merge --> Confirmed[Subscriber data confirmed by HLR:=False +Location information confirmed in HLR:=False] + Confirmed --> Wait_5[Wait_For_HLR_Response] + +``` + +Flowchart for Update\_Location\_Child\_VLR process. It starts with a decision 'HLR address known?'. If 'No', it goes to 'Delete subscriber record'. If 'Yes', it sends MAP requests (OPEN\_req, UPDATE\_LOCATION\_req, DELIMITER\_req), receives Open\_Cnf, and performs a MAP\_Vr dialogue. The Result can be OK, Procedure Error/Aborted, or Unknown Subscriber/ Roaming Not Allowed. OK leads to 'Set Event met: Location update to other VLR', 'Notify\_gsmSCF' (referencing 3GPP TS 23.078), and then a 'Wait\_For\_HLR\_Response'. Procedure Error/Aborted and Unknown Subscriber/ Roaming Not Allowed both lead to 'Delete subscriber record'. From the first 'Wait\_For\_HLR\_Response', it branches to 'Activate\_Tracing\_VLR', 'Insert\_Subs\_Data\_VLR', 'MAP\_NOTICE\_ind', and a merge point. 'Activate\_Tracing\_VLR' and 'Insert\_Subs\_Data\_VLR' lead to their own 'Wait\_For\_HLR\_Response' blocks. 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which leads to a merge point. The merge point leads to a block with 'Subscriber data confirmed by HLR:=False' and 'Location information confirmed in HLR:=False', which then leads to another 'Wait\_For\_HLR\_Response' block. + +4839 + +4840 + +**Figure 25.4/4 (sheet 1 of 2): Process Update\_Location\_Child\_VLR** + +![Flowchart for Update_Location_Child_VLR process. It starts with 'Wait_For_HLR_Response', followed by 'MAP_UPDATE_LOCATION_cnf' input. Then 'Check_Confirmation' block. From there, three paths: 'OK' leads to 'Subscriber data confirmed by HLR:=True; Location information confirmed in HLR:=True' then 'Set Event met: Location update to other VLR' then 'Notify_gsmSCF' (see 3GPP TS 23.078); 'User Error' leads to a decision diamond; 'Provider Error, Data Error' leads to 'Subscriber data confirmed by HLR:=False; Location information confirmed in HLR:=False'. The 'User error' diamond has 'Else' (leads to 'Delete subscriber record') and 'Roaming Not Allowed, Unknown Subscriber' (leads to 'Subscriber data confirmed by HLR:=False; Location information confirmed in HLR:=False'). All terminal paths end with an 'X' symbol.](4f52ec26fe6cc02317dc1e3374476a1b_img.jpg) + +**process Update\_Location\_Child\_VLR** **ULC\_VLR2(2)** + +Child process in the VLR to update the location information in the HLR + +Signals from the right are from the HLR + +``` + +graph TD + Start([Wait_For_HLR_Response]) --> Input{ } + Input -- "MAP_UPDATE_LOCATION_cnf" --> Input + Input --> Check[Check_Confirmation] + Check -- "OK" --> OK[ ] + OK --> OK_Data["Subscriber data confirmed by HLR:=True; +Location information confirmed in HLR:=True"] + OK_Data --> SetEvent["Set Event met: +Location update to other VLR"] + SetEvent --> Notify["Notify_gsmSCF"] + Notify --> NotifyRef["See 3GPP TS 23.078"] + Notify --> EndX1[X] + Check -- "User Error" --> UserError{User error} + UserError -- "Else" --> Delete["Delete subscriber record"] + Delete --> EndX2[X] + UserError -- "Roaming Not Allowed, Unknown Subscriber" --> ErrorData["Subscriber data confirmed by HLR:=False; +Location information confirmed in HLR:=False"] + ErrorData --> EndX3[X] + Check -- "Provider Error, Data Error" --> ProviderError[ ] + ProviderError --> ProviderErrorData["Subscriber data confirmed by HLR:=False; +Location information confirmed in HLR:=False"] + ProviderErrorData --> EndX4[X] + +``` + +Flowchart for Update\_Location\_Child\_VLR process. It starts with 'Wait\_For\_HLR\_Response', followed by 'MAP\_UPDATE\_LOCATION\_cnf' input. Then 'Check\_Confirmation' block. From there, three paths: 'OK' leads to 'Subscriber data confirmed by HLR:=True; Location information confirmed in HLR:=True' then 'Set Event met: Location update to other VLR' then 'Notify\_gsmSCF' (see 3GPP TS 23.078); 'User Error' leads to a decision diamond; 'Provider Error, Data Error' leads to 'Subscriber data confirmed by HLR:=False; Location information confirmed in HLR:=False'. The 'User error' diamond has 'Else' (leads to 'Delete subscriber record') and 'Roaming Not Allowed, Unknown Subscriber' (leads to 'Subscriber data confirmed by HLR:=False; Location information confirmed in HLR:=False'). All terminal paths end with an 'X' symbol. + +4841 + +4842 + +**Figure 25.4/4 (sheet 2 of 2): Process Update\_Location\_Child\_VLR** + +## 4843 25.5 Authentication macros and processes + +4844 The following macros are used in the network in order to enable authentication of a mobile subscriber. + +### 4845 25.5.1 Macro Authenticate\_MSC + +4846 This macro is used by the MSC to relay a request for authentication transparently from the VLR to the MS, wait for a +4847 response from the MS and relay the response from the MS back to the VLR. + +### 4848 25.5.2 Macro Authenticate\_VLR + +4849 This macro is used by the VLR to control the authentication of a subscriber. + +4850 Sheet 1: The test "Received SRES=Expected SRES" indicates: + +4851 - a comparison of the Signed RESult received from the MS with the Signed RESult received from the HLR, if +4852 GSM authentication is used (see 3GPP TS 43.020 [24]), or + +4853 - a comparison of the RESult received from the MS with the expected RESult received from the HLR, if UMTS +4854 authentication is used (see 3GPP TS 33.102). + +### 4855 25.5.3 Macro Obtain\_Authent\_Params\_VLR + +4856 This macro is used by the VLR to request authentication vectors from the HLR. + +4857 Sheet 1, sheet 2, sheet 3: It is an operator option whether to allow the re-use of old authentication triplets. + +4858 Sheet 2, sheet 3: Old UMTS quintuplets shall not be re-used. + +4859 Sheet 2: if the VLR requests more authentication vectors in the same dialogue, the subsequent +4860 MAP\_SEND\_AUTHENTIFICATION\_INFO request has no parameters. + +### 4861 25.5.4 Process Obtain\_Authentication\_Sets\_VLR + +4862 This process is initiated by the VLR to fetch authentication vectors from a subscriber's HLR independently of any other +4863 processing. + +### 4864 25.5.5 Process Obtain\_Authent\_Sets\_SGSN + +4865 The procedure for authentication when the serving node is an SGSN is described in 3GPP TS 23.060 [104] and 3GPP +4866 TS 24.008 [35]. + +4867 This Process is used by the SGSN to request authentication vectors from the HLR. + +4868 Sheet 1, sheet 2: It is an operator option whether to allow the re-use of old authentication triplets. + +4869 Sheet 2: Old UMTS quintuplets shall not be re-used. + +### 4870 25.5.6 Process Obtain\_Authent\_Sets\_HLR + +4871 This process is used to provide authentication vectors (triplets or quintuplets) in response to a request from a VLR or an +4872 SGSN. + +4873 Upon receipt of an authentication information request for a UMTS subscriber, the HLR shall return authentication +4874 quintuplets. If the user is a GSM subscriber, the HLR shall return authentication triplets. + +4875 **25.5.7 Authentication Failure Reporting** + +4876 **25.5.7.1 General** + +4877 The Authentication Failure Report procedure is used to notify an HLR about the occurrence of an authentication failure +4878 in the SGSN or VLR. + +4879 The message flows for this procedure are shown in figures 25.5/7& 25.5/8. + +![Sequence diagram showing message flow between VLR and HLR. The VLR sends a MAP_AUTHENTICATION_FAILURE_REPORT to the HLR, and the HLR responds with a MAP_AUTHENTICATION_FAILURE_REPORT_ACK.](22200464a296d1f8d3937a49864455e0_img.jpg) + +``` +sequenceDiagram + participant VLR + participant HLR + Note right of VLR: MAP_AUTHENTICATION_FAILURE_REPORT + VLR->>HLR: MAP_AUTHENTICATION_FAILURE_REPORT + Note right of HLR: MAP_AUTHENTICATION_FAILURE_REPORT_ACK + HLR->>VLR: MAP_AUTHENTICATION_FAILURE_REPORT_ACK +``` + +Sequence diagram showing message flow between VLR and HLR. The VLR sends a MAP\_AUTHENTICATION\_FAILURE\_REPORT to the HLR, and the HLR responds with a MAP\_AUTHENTICATION\_FAILURE\_REPORT\_ACK. + +4880 + +4881 + +**Figure 25.5/7: Message Flow for Authentication Failure Report – VLR to HLR** + +![Sequence diagram showing message flow between SGSN and HLR. The SGSN sends a MAP_AUTHENTICATION_FAILURE_REPORT to the HLR, and the HLR responds with a MAP_AUTHENTICATION_FAILURE_REPORT_ACK.](1d272c631c1e0794a8ba1a9523049d28_img.jpg) + +``` +sequenceDiagram + participant SGSN + participant HLR + Note right of SGSN: MAP_AUTHENTICATION_FAILURE_REPORT + SGSN->>HLR: MAP_AUTHENTICATION_FAILURE_REPORT + Note right of HLR: MAP_AUTHENTICATION_FAILURE_REPORT_ACK + HLR->>SGSN: MAP_AUTHENTICATION_FAILURE_REPORT_ACK +``` + +Sequence diagram showing message flow between SGSN and HLR. The SGSN sends a MAP\_AUTHENTICATION\_FAILURE\_REPORT to the HLR, and the HLR responds with a MAP\_AUTHENTICATION\_FAILURE\_REPORT\_ACK. + +4882 + +4883 + +**Figure 25.5/8: Message Flow for Authentication Failure Report – SGSN to HLR** + +4884 **25.5.7.2 Process in the VLR** + +4885 **25.5.7.3 Process in the SGSN** + +4886 **25.5.7.4 Process in the HLR** + +![SDL diagram for Authenticate_MSC macro. It shows the logic flow for handling authentication between MS and VLR, including state transitions and signal exchanges.](6de86797fa3956088bc69c8c5ea7c4fb_img.jpg) + +macrodefinition Authenticate\_MSC + +Auth\_MSC1(1) + +Macro in the MSC to relay the signalling for authentication between the MS and the VLR + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +``` + + graph TD + Start([ ]) --> Input1[/MAP_AUTHENTICATE_ind/] + Input1 --> Task1[Check_Indication] + Task1 --> Decision1{ } + Decision1 -- OK --> Output1[A_AUTHENTICATE_req] + Decision1 -- Error --> Output2[MAP_AUTHENTICATE_rsp +MAP_DELIMITER_req] + Output2 --> OK_End1((OK)) + Output1 --> State1{{Wait_For_MS_Response}} + + State1 --> Input2[/A_AUTHENTICATE_cnf/] + Input2 --> Decision2{Error?} + Decision2 -- Yes --> Task2[Set User Error] + Decision2 -- No --> Join1 + Task2 --> Join1 + Join1 --> Output3[MAP_AUTHENTICATE_rsp +MAP_DELIMITER_req] + Output3 --> OK_End2((OK)) + + State1 --> Input3[/A_CM_SERVICE_ABORT_ind/] + Input3 --> Output4[MAP_U_ABORT_req] + Output4 --> Error_End1((Error)) + + State1 --> Input4[/MAP_U_ABORT_ind +MAP_CLOSE_ind/] + Input4 --> Error_End2((Error)) + +``` + +SDL diagram for Authenticate\_MSC macro. It shows the logic flow for handling authentication between MS and VLR, including state transitions and signal exchanges. + +4887 + +4888 + +**Figure 25.5/1: Macro Authenticate\_MSC** + +![Flowchart for macrodefinition Authenticate_VLR. It starts at connector '2', checks if authentication vectors are available. If no, it obtains parameters from VLR. Then it sends MAP_AUTHENTICATE_req and MAP_DELIMITER_req. It waits for a response from MSC. If the response is Null, OK, Unknown_Subscriber, or Procedure_Error, it handles each accordingly. For OK, it checks the confirmation. If OK, it checks if received SRES equals expected SRES. If yes, it checks if more authentication vectors are required. If no, it ends at connector '1'. If yes, it obtains authentication sets from VLR and loops back to connector '2'. If received SRES does not equal expected SRES, it ends at connector '1'. If confirmation is not OK, it sends MAP_U_ABORT_ind, MAP_CLOSE_ind, and ends at connector '1'. Other responses (Null, Unknown_Subscriber, Procedure_Error) lead to their respective end states.](091c1ab9163076c6e911f6fd33219793_img.jpg) + +**macrodefinition Authenticate\_VLR** **Auth\_VLR1(2)** + +Macro in the VLR to authenticate an MS + +Signals to/from the left are to/from the MSC + +``` + +graph TD + Start((2)) --> Decision1{Authentication vectors available?} + Decision1 -- No --> Process1[Obtain_Authent_Params_VLR] + Process1 --> Decision2{ } + Decision2 -- Null --> EndNull1((Null)) + Decision2 -- OK --> Process2[MAP_AUTHENTICATE_req +MAP_DELIMITER_req] + Decision2 -- Unknown_Subscriber --> EndUnknown((Unknown_Subscriber)) + Decision2 -- Procedure_Error --> EndProcedure((Procedure_Error)) + Process2 --> Process3[Wait_For_Response_From_MSC] + Process3 --> Decision3{ } + Decision3 -- User Error, Provider Error, Data Error --> End1((1)) + Decision3 -- MAP_U_ABORT_ind, MAP_CLOSE_ind --> EndNull2((Null)) + Decision3 -- MAP_AUTHENTICATE_cnf --> Process4[Check_Confirmation] + Process4 -- OK --> Decision4{Received SRES=Expected SRES?} + Decision4 -- No --> End1 + Decision4 -- Yes --> Decision5{More authentication vectors required?} + Decision5 -- No --> End1 + Decision5 -- Yes --> Process5[Obtain_Authent_Sets_VLR] + Process5 --> EndOK((OK)) + EndOK --> Start + +``` + +Flowchart for macrodefinition Authenticate\_VLR. It starts at connector '2', checks if authentication vectors are available. If no, it obtains parameters from VLR. Then it sends MAP\_AUTHENTICATE\_req and MAP\_DELIMITER\_req. It waits for a response from MSC. If the response is Null, OK, Unknown\_Subscriber, or Procedure\_Error, it handles each accordingly. For OK, it checks the confirmation. If OK, it checks if received SRES equals expected SRES. If yes, it checks if more authentication vectors are required. If no, it ends at connector '1'. If yes, it obtains authentication sets from VLR and loops back to connector '2'. If received SRES does not equal expected SRES, it ends at connector '1'. If confirmation is not OK, it sends MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind, and ends at connector '1'. Other responses (Null, Unknown\_Subscriber, Procedure\_Error) lead to their respective end states. + +4889 + +4890 + +**Figure 25.5/2 (sheet 1 of 2): Macro Authenticate\_VLR** + +![Flowchart for Authenticate_VLR macro. It starts at node 1, checks if Identity=IMSI. If No, it checks if Retry with IMSI? If Yes, it obtains IMSI_VLR. If No, it goes to a merge point. From Obtain IMSI_VLR, if OK, it checks if IMSI known? If No, it leads to Unidentified_subscriber. If Yes, it checks if IMSI matches TMSI? If Yes, it goes to a merge point. If No, it sets Identity=IMSI and goes to node 2. From Obtain IMSI_VLR, if Error, it leads to Procedure_Error. If Aborted, it leads to Null. Both merge points lead to a common exit node associated with Illegal_Subscriber.](f421b56e7f2a6a91f8056e79402e3e8b_img.jpg) + +macrodefinition Authenticate\_VLR + +Auth\_VLR2(2) + +Macro in the VLR to authenticate an MS + +``` + + graph TD + 1((1)) --> D1{Identity=IMSI?} + D1 -- Yes --> Merge1(( )) + D1 -- No --> D2{Retry with IMSI?} + D2 -- No --> Merge1 + D2 -- Yes --> P1[Obtain IMSI_VLR] + P1 -- OK --> D3{IMSI known?} + P1 -- Error --> P2[Procedure_Error] + P1 -- Aborted --> N1((Null)) + D3 -- No --> P3[Unidentified_subscriber] + D3 -- Yes --> D4{IMSI matches TMSI?} + D4 -- Yes --> Merge2(( )) + D4 -- No --> P4[Identity=IMSI] + P4 --> 2((2)) + Merge1 --> Merge2 + Merge2 --> P5[Illegal_Subscriber] + +``` + +Flowchart for Authenticate\_VLR macro. It starts at node 1, checks if Identity=IMSI. If No, it checks if Retry with IMSI? If Yes, it obtains IMSI\_VLR. If No, it goes to a merge point. From Obtain IMSI\_VLR, if OK, it checks if IMSI known? If No, it leads to Unidentified\_subscriber. If Yes, it checks if IMSI matches TMSI? If Yes, it goes to a merge point. If No, it sets Identity=IMSI and goes to node 2. From Obtain IMSI\_VLR, if Error, it leads to Procedure\_Error. If Aborted, it leads to Null. Both merge points lead to a common exit node associated with Illegal\_Subscriber. + +4891 + +4892 + +Figure 25.5/2 (sheet 2 of 2): Macro Authenticate\_VLR + +macrodefinition Obtain\_Authent\_Params\_VLR + +Obt\_Auth\_Par\_VLR1(3) + +Macro in the VLR to obtain authentication parameters from the HLR + +Signals to/from the right are to/from the HLR + +![Flowchart for Obtain_Authent_Params_VLR macro. It starts with a start node, followed by a process block with MAP_OPEN_req, MAP_SEND_AUTHENTICATION_INFO_req, and MAP_DELIMITER_req. Then a 'Receive_Open_Cnf' block. From there, three paths: 'OK' leads to 'Wait_For_Authentication_Info'; 'Vr' leads to 'Perform MAP Vr dialogue'; 'Error' leads to a connector and 'Procedure_Error'. The 'Perform' block leads to 'Successful result?'. 'Yes' leads to 'Empty result?'. 'No' leads to 'Error=Unknown subscriber?'. 'Error=Unknown subscriber?' 'Yes' leads to 'Unknown_Subscriber' connector; 'No' leads to 'Empty result?'. 'Empty result?' 'Yes' leads to 'Re-use old triplets?'; 'No' leads to 'OK' connector. 'Re-use old triplets?' 'Yes' leads to 'OK' connector; 'No' leads to a connector and 'Procedure_Error'.](903f003288ca0c29563d037be8c23c75_img.jpg) + +``` + +graph TD + Start([Start]) --> Process["MAP_OPEN_req +MAP_SEND_AUTHENTICATION_INFO_req +MAP_DELIMITER_req"] + Process --> Receive["Receive_Open_Cnf"] + Receive -- OK --> Wait["Wait_For_Authentication_Info"] + Receive -- Vr --> Perform["Perform MAP Vr dialogue"] + Receive -- Error --> ErrorConn(( )) + ErrorConn --> ProcedureError1["Procedure_Error"] + Perform --> SuccessfulResult{Successful result?} + SuccessfulResult -- Yes --> EmptyResult{Empty result?} + SuccessfulResult -- No --> UnknownSubscriber{Error=Unknown subscriber?} + UnknownSubscriber -- Yes --> UnknownSubscriberConn(( )) + UnknownSubscriberConn --> UnknownSubscriber["Unknown_Subscriber"] + UnknownSubscriber -- No --> EmptyResult + EmptyResult -- Yes --> ReUseOldTriplets{Re-use old triplets?} + EmptyResult -- No --> OKConn(( )) + ReUseOldTriplets -- Yes --> OKConn + ReUseOldTriplets -- No --> ProcedureError2(( )) + ProcedureError2 --> ProcedureError3["Procedure_Error"] + OKConn --> OK["OK"] + +``` + +Flowchart for Obtain\_Authent\_Params\_VLR macro. It starts with a start node, followed by a process block with MAP\_OPEN\_req, MAP\_SEND\_AUTHENTICATION\_INFO\_req, and MAP\_DELIMITER\_req. Then a 'Receive\_Open\_Cnf' block. From there, three paths: 'OK' leads to 'Wait\_For\_Authentication\_Info'; 'Vr' leads to 'Perform MAP Vr dialogue'; 'Error' leads to a connector and 'Procedure\_Error'. The 'Perform' block leads to 'Successful result?'. 'Yes' leads to 'Empty result?'. 'No' leads to 'Error=Unknown subscriber?'. 'Error=Unknown subscriber?' 'Yes' leads to 'Unknown\_Subscriber' connector; 'No' leads to 'Empty result?'. 'Empty result?' 'Yes' leads to 'Re-use old triplets?'; 'No' leads to 'OK' connector. 'Re-use old triplets?' 'Yes' leads to 'OK' connector; 'No' leads to a connector and 'Procedure\_Error'. + +4893 + +4894 + +Figure 25.5/3 (sheet 1 of 3): Macro Obtain\_Authent\_Params\_VLR + +macrodefinition Obtain\_Authent\_Params\_VLR + +Obt\_Auth\_Par\_VLR2(3) + +Macro in the VLR to obtain authentication parameters from the HLR + +Signals to/from the right are to/from the HLR + +![Flowchart for Obtain_Authent_Params_VLR macro. It starts with 'Wait_For_Authentication_Info', followed by 'MAP_SEND_AUTHENTICATION_INFO_cnf', and 'Check_Confirmation'. From 'Check_Confirmation', four paths emerge: OK (leading to 'Wait_For_Close_Or_Delimiter'), User Error (leading to 'Unknown_subscriber?' - if Yes, 'Unknown_Subscriber'; if No, 'Re-use_old_vectors?' - if Yes, 'OK'; if No, 'Procedure_Error'), Provider Error (leading to 'Re-use_old_vectors?' - if Yes, 'OK'; if No, 'Procedure_Error'), and Data Error (leading to 'MAP_CLOSE_req' and then '1'). 'Wait_For_Close_Or_Delimiter' leads to 'MAP_CLOSE_ind' and 'MAP_DELIMITER_ind'. 'MAP_CLOSE_ind' leads to a decision 'Authentication_vectors_received?' - if No, '1'; if Yes, 'OK'. 'MAP_DELIMITER_ind' leads to 'More_vectors_required?' - if Yes, 'MAP_SEND_AUTHENTICATION_INFO_req' and 'MAP_DELIMITER_req' (looping back to start); if No, 'MAP_CLOSE_req' and 'OK'.](e20e1d3fe823fee992d85fb88c7ff990_img.jpg) + +``` + +graph TD + Start([Wait_For_Authentication_Info]) --> CNF[MAP_SEND_AUTHENTICATION_INFO_cnf] + CNF --> Confirm[Check_Confirmation] + Confirm --> OK1[OK] + Confirm --> UserError[User Error] + Confirm --> ProviderError[Provider Error] + Confirm --> DataError[Data Error] + OK1 --> WaitClose[Wait_For_Close_Or_Delimiter] + UserError --> UnknownSub[Unknown_subscriber?] + UnknownSub -- Yes --> UnknownSubOut(( )) + UnknownSubOut --> UnknownSubText[Unknown_Subscriber] + UnknownSub -- No --> ReuseOld[Re-use_old_vectors?] + ProviderError --> ReuseOld + ReuseOld -- Yes --> OK2((OK)) + ReuseOld -- No --> ProcedureError(( )) + ProcedureError --> ProcedureErrorText[Procedure_Error] + DataError --> MAPCloseReq[MAP_CLOSE_req] + MAPCloseReq --> One1((1)) + WaitClose --> MAPCloseInd[MAP_CLOSE_ind] + WaitClose --> MAPDelimiterInd[MAP_DELIMITER_ind] + MAPCloseInd --> AuthVecRec[Authentication_vectors_received?] + AuthVecRec -- No --> One2((1)) + AuthVecRec -- Yes --> OK3((OK)) + MAPDelimiterInd --> MoreVecsReq[More_vectors_required?] + MoreVecsReq -- Yes --> MAPSendAuthReq[MAP_SEND_AUTHENTICATION_INFO_req] + MoreVecsReq -- Yes --> MAPDelimiterReq[MAP_DELIMITER_req] + MAPSendAuthReq --> Start + MoreVecsReq -- No --> MAPCloseReq2[MAP_CLOSE_req] + MAPCloseReq2 --> OK4((OK)) + +``` + +Flowchart for Obtain\_Authent\_Params\_VLR macro. It starts with 'Wait\_For\_Authentication\_Info', followed by 'MAP\_SEND\_AUTHENTICATION\_INFO\_cnf', and 'Check\_Confirmation'. From 'Check\_Confirmation', four paths emerge: OK (leading to 'Wait\_For\_Close\_Or\_Delimiter'), User Error (leading to 'Unknown\_subscriber?' - if Yes, 'Unknown\_Subscriber'; if No, 'Re-use\_old\_vectors?' - if Yes, 'OK'; if No, 'Procedure\_Error'), Provider Error (leading to 'Re-use\_old\_vectors?' - if Yes, 'OK'; if No, 'Procedure\_Error'), and Data Error (leading to 'MAP\_CLOSE\_req' and then '1'). 'Wait\_For\_Close\_Or\_Delimiter' leads to 'MAP\_CLOSE\_ind' and 'MAP\_DELIMITER\_ind'. 'MAP\_CLOSE\_ind' leads to a decision 'Authentication\_vectors\_received?' - if No, '1'; if Yes, 'OK'. 'MAP\_DELIMITER\_ind' leads to 'More\_vectors\_required?' - if Yes, 'MAP\_SEND\_AUTHENTICATION\_INFO\_req' and 'MAP\_DELIMITER\_req' (looping back to start); if No, 'MAP\_CLOSE\_req' and 'OK'. + +4895 + +4896 + +Figure 25.5/3 (sheet 2 of 3): Macro Obtain\_Authent\_Params\_VLR + +macrodefinition Obtain\_Authent\_Params\_VLR + +Obt\_Auth\_Par\_VLR3(3) + +Macro in the VLR to obtain authentication parameters from the HLR + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the HLR + +![State transition diagram for Obtain_Authent_Params_VLR macro. It starts with 'Wait_For_Authentication_Info' and branches into three paths: one leading to 'Null' via 'MAP_U_ABORT_req', one leading to 'OK' via 'Re-use old vectors?' (Yes), and one leading to 'Procedure_Error' via 'Re-use old vectors?' (No).](816198e6a82098ac1c2af8551d3a6e16_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Wait_For_Authentication_Info + state "MAP_U_ABORT_ind, MAP_CLOSE_ind" as Left + state "MAP_P_ABORT_ind, MAP_U_ABORT_ind, MAP_CLOSE_ind" as Center + state "MAP_NOTICE_ind" as Right + state "MAP_U_ABORT_req" as LeftReq + state "MAP_CLOSE_req" as RightReq + state "Re-use old vectors?" as Decision + state Null as [*] + state OK as [*] + state Procedure_Error as [*] + + Wait_For_Authentication_Info --> Left + Wait_For_Authentication_Info --> Center + Wait_For_Authentication_Info --> Right + Left --> LeftReq + LeftReq --> Null + Center --> Decision + Right --> RightReq + RightReq --> Decision + Decision -- Yes --> OK + Decision -- No --> Procedure_Error + +``` + +State transition diagram for Obtain\_Authent\_Params\_VLR macro. It starts with 'Wait\_For\_Authentication\_Info' and branches into three paths: one leading to 'Null' via 'MAP\_U\_ABORT\_req', one leading to 'OK' via 'Re-use old vectors?' (Yes), and one leading to 'Procedure\_Error' via 'Re-use old vectors?' (No). + +4897 + +4898 + +Figure 25.5/3 (sheet 3 of 3): Macro Obtain\_Authent\_Params\_VLR + +![A state transition diagram for the process Obtain_Authent_Sets_VLR. It starts with an initial state (orange oval) leading to a state box labeled 'Obtain_Authent_Params_VLR'. A note box on the left contains the text 'Process in the VLR to obtain authentication sets from the HLR'. From the 'Obtain_Authent_Params_VLR' state, a transition arrow points down to an exit state (crossed circle). The transition is labeled with 'OK, Null, Unknown_Subscriber, Procedure_Error'.](b6b45350db23a8328edfa2e4ed42440b_img.jpg) + +process Obtain\_Authent\_Sets\_VLR + +Obt\_Auth\_Sets\_VLR1(1) + +``` +stateDiagram-v2 + [*] --> Obtain_Authent_Params_VLR + Obtain_Authent_Params_VLR --> [*] : OK, Null, Unknown_Subscriber, Procedure_Error +``` + +A state transition diagram for the process Obtain\_Authent\_Sets\_VLR. It starts with an initial state (orange oval) leading to a state box labeled 'Obtain\_Authent\_Params\_VLR'. A note box on the left contains the text 'Process in the VLR to obtain authentication sets from the HLR'. From the 'Obtain\_Authent\_Params\_VLR' state, a transition arrow points down to an exit state (crossed circle). The transition is labeled with 'OK, Null, Unknown\_Subscriber, Procedure\_Error'. + +4899 + +4900 + +Figure 25.5/4: Process Obtain\_Authent\_Sets\_VLR + +![Flowchart for process Obtain_Authent_Sets_SGSN. It starts at 'Idle', receives an 'Authentication parameter request', checks if the HLR is unknown. If yes, it sets a negative response and returns to 'Idle'. If no, it sends MAP requests and receives an 'Open_Cnf'. From there, it branches based on 'OK', 'Vr', or 'Error'. The 'Vr' path leads to 'Perform MAP Vr dialogue', which then checks for a successful result. If successful, it checks if the result is empty. If empty, it checks if old triplets can be reused. If not, it sends a negative response and returns to 'Idle'. If old triplets can be reused or the result is not empty, it sends an 'Authentication parameter ack' and returns to 'Idle'. If the result is not successful, it checks if it's an unknown subscriber error. If yes, it sends a negative response and returns to 'Idle'. If no, it checks if old triplets can be reused. If yes, it sends an 'Authentication parameter ack' and returns to 'Idle'. If no, it sends a negative response and returns to 'Idle'. The 'OK' path leads to 'Wait_For_Authentication_Info' and returns to 'Idle'. The 'Error' path leads to a connector '1'.](dfb22056a59b72fa70702df3cb815f8c_img.jpg) + +**process Obtain\_Authent\_Sets\_SGSN** **Obt\_Auth\_Sets\_SGSN1(2)** + +Process in the SGSN to obtain authentication sets from the HLR + +Signals to/from the left are to/from the application process in the SGSN; signals to/from the right are to/from the HLR + +``` + + graph TD + Start([Idle]) --> Request{Authentication parameter request} + Request --> UnknownHLR{Unknown HLR?} + UnknownHLR -- Yes --> NegativeResponse1[Set negative response: Unknown HLR] + NegativeResponse1 --> NegativeResponse1_out{Authentication parameter negative response} + NegativeResponse1_out --> Idle1([Idle]) + + UnknownHLR -- No --> MAPRequests[MAP_OPEN_req +MAP_SEND_AUTHENTICATION_INFO_req +MAP_DELIMITER_req] + MAPRequests --> OpenCnf[Receive_Open_Cnf] + + OpenCnf -- OK --> WaitInfo[Wait_For_Authentication_Info] + WaitInfo --> Idle2([Idle]) + + OpenCnf -- Vr --> MAPVr[Perform MAP Vr dialogue] + + MAPVr --> Successful{Successful result?} + + Successful -- Yes --> Empty{Empty result?} + + Empty -- No --> Ack[Authentication parameter ack] + + Empty -- Yes --> Reuse{Re-use old triplets?} + + Reuse -- Yes --> Ack + + Reuse -- No --> NegativeResponse2{Authentication parameter negative response} + + NegativeResponse2 --> Idle3([Idle]) + + Successful -- No --> UnknownSub{Error=Unknown subscriber?} + + UnknownSub -- Yes --> NegativeResponse3{Authentication parameter negative response} + + NegativeResponse3 --> Idle4([Idle]) + + UnknownSub -- No --> Reuse + + Ack --> Idle5([Idle]) + + OpenCnf -- Error --> Connector1((1)) + + Empty -- Yes --> Connector2((1)) + +``` + +Flowchart for process Obtain\_Authent\_Sets\_SGSN. It starts at 'Idle', receives an 'Authentication parameter request', checks if the HLR is unknown. If yes, it sets a negative response and returns to 'Idle'. If no, it sends MAP requests and receives an 'Open\_Cnf'. From there, it branches based on 'OK', 'Vr', or 'Error'. The 'Vr' path leads to 'Perform MAP Vr dialogue', which then checks for a successful result. If successful, it checks if the result is empty. If empty, it checks if old triplets can be reused. If not, it sends a negative response and returns to 'Idle'. If old triplets can be reused or the result is not empty, it sends an 'Authentication parameter ack' and returns to 'Idle'. If the result is not successful, it checks if it's an unknown subscriber error. If yes, it sends a negative response and returns to 'Idle'. If no, it checks if old triplets can be reused. If yes, it sends an 'Authentication parameter ack' and returns to 'Idle'. If no, it sends a negative response and returns to 'Idle'. The 'OK' path leads to 'Wait\_For\_Authentication\_Info' and returns to 'Idle'. The 'Error' path leads to a connector '1'. + +4901 + +4902 + +**Figure 25.5/5 (sheet 1 of 2): Process Obtain\_Authent\_Sets\_SGSN** + +process Obtain\_Authent\_Sets\_SGSN + +Obt\_Auth\_Sets\_SGSN2(2) + +Process in the SGSN to obtain authentication sets from the HLR + +Signals to/from the left are to/from the application process in the SGSN; signals to/from the right are to/from the HLR + +![Flowchart for process Obtain_Authent_Sets_SGSN. It starts with 'Wait_For_Authentication_Info', followed by 'MAP_SEND_AUTHENTICATION_INFO_cnf', and 'Check_Confirmation'. From 'Check_Confirmation', it branches into 'OK', 'User Error' (Unknown subscriber? No), and 'Provider Error, Data Error'. 'OK' leads to 'Wait_For_Close_Or_Delimiter'. 'User Error' (Unknown subscriber? No) leads to 'Re-use old vectors?'. 'Provider Error, Data Error' leads to 'Re-use old vectors?'. 'Re-use old vectors? Yes' leads to 'Authentication parameter ack' and 'Idle'. 'Re-use old vectors? No' leads to 'Unknown subscriber? Yes', which leads to 'Authentication parameter negative response' and 'Idle'. 'Wait_For_Close_Or_Delimiter' leads to 'MAP_CLOSE_ind' and 'MAP_DELIMITER_ind'. 'MAP_CLOSE_ind' leads to a decision diamond. 'No' leads to connector '1'. 'Yes' leads to 'Authentication vectors received?'. 'MAP_DELIMITER_ind' leads to 'More vectors required?'. 'Yes' leads to 'MAP_SEND_AUTHENTICATION_INFO_req' and 'MAP_DELIMITER_req', which leads to 'Wait_For_Authentication_Info'. 'No' leads to 'MAP_CLOSE_req', which leads to 'Authentication parameter ack' and 'Idle'.](4e6012e3ba9ac443fd007e2f4adda702_img.jpg) + +``` + +graph TD + Start([Wait_For_Authentication_Info]) --> MAP_SEND_AUTHENTICATION_INFO_cnf[MAP_SEND_AUTHENTICATION_INFO_cnf] + MAP_SEND_AUTHENTICATION_INFO_cnf --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> OK[OK] + Check_Confirmation --> User_Error[User Error] + Check_Confirmation --> Provider_Error[Provider Error, Data Error] + User_Error --> Unknown_subscriber{Unknown subscriber?} + Unknown_subscriber -- No --> Re_use_old_vectors{Re-use old vectors?} + Unknown_subscriber -- Yes --> Auth_param_neg_resp{Authentication parameter negative response} + Auth_param_neg_resp --> Idle1([Idle]) + Provider_Error --> Re_use_old_vectors + Re_use_old_vectors -- Yes --> Auth_param_ack1{Authentication parameter ack} + Auth_param_ack1 --> Idle2([Idle]) + Re_use_old_vectors -- No --> Unknown_subscriber + OK --> Wait_For_Close_Or_Delimiter[Wait_For_Close_Or_Delimiter] + Wait_For_Close_Or_Delimiter --> MAP_CLOSE_ind[MAP_CLOSE_ind] + Wait_For_Close_Or_Delimiter --> MAP_DELIMITER_ind[MAP_DELIMITER_ind] + MAP_CLOSE_ind --> Decision1{ } + Decision1 -- No --> Connector1((1)) + Decision1 -- Yes --> Auth_vectors_received{Authentication vectors received?} + MAP_DELIMITER_ind --> More_vectors_required{More vectors required?} + More_vectors_required -- Yes --> MAP_SEND_AUTHENTICATION_INFO_req[MAP_SEND_AUTHENTICATION_INFO_req] + More_vectors_required -- Yes --> MAP_DELIMITER_req[MAP_DELIMITER_req] + MAP_SEND_AUTHENTICATION_INFO_req --> Wait_For_Authentication_Info + More_vectors_required -- No --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> Auth_param_ack2{Authentication parameter ack} + Auth_param_ack2 --> Idle3([Idle]) + Auth_vectors_received --> Auth_param_ack2 + +``` + +Flowchart for process Obtain\_Authent\_Sets\_SGSN. It starts with 'Wait\_For\_Authentication\_Info', followed by 'MAP\_SEND\_AUTHENTICATION\_INFO\_cnf', and 'Check\_Confirmation'. From 'Check\_Confirmation', it branches into 'OK', 'User Error' (Unknown subscriber? No), and 'Provider Error, Data Error'. 'OK' leads to 'Wait\_For\_Close\_Or\_Delimiter'. 'User Error' (Unknown subscriber? No) leads to 'Re-use old vectors?'. 'Provider Error, Data Error' leads to 'Re-use old vectors?'. 'Re-use old vectors? Yes' leads to 'Authentication parameter ack' and 'Idle'. 'Re-use old vectors? No' leads to 'Unknown subscriber? Yes', which leads to 'Authentication parameter negative response' and 'Idle'. 'Wait\_For\_Close\_Or\_Delimiter' leads to 'MAP\_CLOSE\_ind' and 'MAP\_DELIMITER\_ind'. 'MAP\_CLOSE\_ind' leads to a decision diamond. 'No' leads to connector '1'. 'Yes' leads to 'Authentication vectors received?'. 'MAP\_DELIMITER\_ind' leads to 'More vectors required?'. 'Yes' leads to 'MAP\_SEND\_AUTHENTICATION\_INFO\_req' and 'MAP\_DELIMITER\_req', which leads to 'Wait\_For\_Authentication\_Info'. 'No' leads to 'MAP\_CLOSE\_req', which leads to 'Authentication parameter ack' and 'Idle'. + +4903 + +4904 + +Figure 25.5/5 (sheet 2 of 2): Process Obtain\_Authent\_Sets\_SGSN + +![Flowchart for process Obtain_Authent_Sets_HLR. It starts with an initial node, followed by a 'Null' node, then 'Receive_Open_Ind'. From 'Receive_Open_Ind', three paths emerge: 'Error' (leading to 'Null'), 'Vr' (leading to 'Perform MAP Vr dialogue' then 'Null'), and 'OK' (leading to 'Wait_For_Service_Primitive'). 'Wait_For_Service_Primitive' leads to 'MAP_NOTICE_ind'. 'MAP_NOTICE_ind' leads to a merge node, which then leads to 'MAP_SEND_AUTHENTICATION_INFO_ind'. 'MAP_SEND_AUTHENTICATION_INFO_ind' leads to 'Check_Indication'. From 'Check_Indication', 'OK' leads to a connector node '1', and 'Error' leads to a merge node for 'MAP_SEND_AUTHENTICATION_INFO_rsp' and 'MAP_CLOSE_req', which then leads to 'Null'. 'MAP_NOTICE_ind' also leads directly to 'MAP_CLOSE_req', which leads to 'Null'.](477a5b2a3b9218257a4cb98508246975_img.jpg) + +**process Obtain\_Authent\_Sets\_HLR** **Obt\_Auth\_Sets\_HLR1(2)** + +Process in the HLR to handle a request from the VLR for authentication sets + +Signals to/from the left are to/from the VLR or the SGSN + +``` + +graph TD + Start([ ]) --> Null1([Null]) + Null1 --> Receive_Open_Ind[Receive_Open_Ind] + Receive_Open_Ind -- Error --> Null2([Null]) + Receive_Open_Ind -- Vr --> Perform_MAP_Vr[Perform MAP Vr dialogue] + Perform_MAP_Vr --> Null3([Null]) + Receive_Open_Ind -- OK --> Wait_For_Service_Primitive[Wait_For_Service_Primitive] + Wait_For_Service_Primitive --> MAP_NOTICE_ind{MAP_NOTICE_ind} + MAP_NOTICE_ind --> Merge1{ } + Merge1 --> MAP_SEND_AUTHENTICATION_INFO_ind[MAP_SEND_AUTHENTICATION_INFO_ind] + MAP_SEND_AUTHENTICATION_INFO_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> Connector1((1)) + Check_Indication -- Error --> Merge2{ } + Merge2 --> MAP_SEND_AUTHENTICATION_INFO_rsp[MAP_SEND_AUTHENTICATION_INFO_rsp] + Merge2 --> MAP_CLOSE_req1[MAP_CLOSE_req] + MAP_SEND_AUTHENTICATION_INFO_rsp --> Null4([Null]) + MAP_CLOSE_req1 --> Null5([Null]) + MAP_NOTICE_ind --> MAP_CLOSE_req2[MAP_CLOSE_req] + MAP_CLOSE_req2 --> Null6([Null]) + +``` + +Flowchart for process Obtain\_Authent\_Sets\_HLR. It starts with an initial node, followed by a 'Null' node, then 'Receive\_Open\_Ind'. From 'Receive\_Open\_Ind', three paths emerge: 'Error' (leading to 'Null'), 'Vr' (leading to 'Perform MAP Vr dialogue' then 'Null'), and 'OK' (leading to 'Wait\_For\_Service\_Primitive'). 'Wait\_For\_Service\_Primitive' leads to 'MAP\_NOTICE\_ind'. 'MAP\_NOTICE\_ind' leads to a merge node, which then leads to 'MAP\_SEND\_AUTHENTICATION\_INFO\_ind'. 'MAP\_SEND\_AUTHENTICATION\_INFO\_ind' leads to 'Check\_Indication'. From 'Check\_Indication', 'OK' leads to a connector node '1', and 'Error' leads to a merge node for 'MAP\_SEND\_AUTHENTICATION\_INFO\_rsp' and 'MAP\_CLOSE\_req', which then leads to 'Null'. 'MAP\_NOTICE\_ind' also leads directly to 'MAP\_CLOSE\_req', which leads to 'Null'. + +4905 + +4906 + +**Figure 25.5/6 (sheet 1 of 2): Process Obtain\_Authent\_Sets\_HLR** + +![Flowchart for process Obtain_Authent_Sets_HLR. It starts at connector '1', checks if a requesting node type is present. If no, it checks if it's an SGSN with non-GPRS access or a VLR with GPRS access. If neither, it sets a diagnostic or user error and returns a response. If yes, it checks available vectors, then if segmentation is needed, it obtains vectors from AuC and returns a response. Finally, it sends a delimiter request and waits for a service primitive.](3c76eca7bc00e29848744fae0d9d017e_img.jpg) + +**process Obtain\_Authent\_Sets\_HLR** **Obt\_Auth\_Sets\_HLR2(2)** + +Process in the HLR to handle a request from the VLR for authentication sets + +Signals to/from the left are to/from the VLR or the SGSN + +``` + +graph TD + Start((1)) --> Q1{Requesting node type present?} + Q1 -- No --> Q2{Requesting node type=SGSN AND Network access mode=Non-GPRS only} + Q2 -- Yes --> D1[Set Diagnostic: GPRS subscription unknown] + Q2 -- No --> Q3{Requesting node type=VLR AND Network access mode=GPRS only} + Q3 -- Yes --> D2[Set User Error: Unknown subscriber] + D1 --> R1[MAP_SEND_AUTHENTICATION_INFO_rsp +MAP_CLOSE_req] + D2 --> R1 + R1 --> Null1([Null]) + Q1 -- Yes --> P1[Check Available Vectors] + P1 --> Q4{Segmentation allowed and supported and needed?} + Q4 -- No --> R2[MAP_SEND_AUTHENTICATION_INFO_rsp +MAP_CLOSE_req] + Q4 -- Yes --> P2[Obtain Vectors From_AuC] + P2 --> Note[To be stored for later use; see 3GPP TS 33.102 (UMTS) or 3GPP TS 43.020 (GSM)] + P2 --> Null2([Null]) + Note --> R2 + R2 --> P3[MAP_SEND_AUTHENTICATION_INFO_rsp +MAP_DELIMITER_req] + P3 --> End[Wait_For_Service_Primitive] + +``` + +Flowchart for process Obtain\_Authent\_Sets\_HLR. It starts at connector '1', checks if a requesting node type is present. If no, it checks if it's an SGSN with non-GPRS access or a VLR with GPRS access. If neither, it sets a diagnostic or user error and returns a response. If yes, it checks available vectors, then if segmentation is needed, it obtains vectors from AuC and returns a response. Finally, it sends a delimiter request and waits for a service primitive. + +4907 + +4908 + +**Figure 25.5/6 (sheet 2 of 2): Process Obtain\_Authent\_Sets\_HLR** + +procedure Check\_Available\_Vectors + +Chk\_Avl\_Vec1(1) + +Procedure in the HLR to check the number of authentication vectors requested against the number of available vectors + +![Flowchart for Check_Available_Vectors procedure](59bcca262fbcdfd92ec4b9202aa586a1_img.jpg) + +``` +graph TD; Start([Start]) --> D1{More vectors requested than stored?}; D1 -- No --> Exit1(( )); D1 -- Yes --> D2{Number of vectors stored=0?}; D2 -- Yes --> Exit2(( )); D2 -- No --> D3{Immediate Response Preferred indicator supported?}; D3 -- Yes --> D4{Immediate response preferred?}; D3 -- No --> Exit3(( )); D4 -- Yes --> Exit4(( )); D4 -- No --> Process1[Obtain vectors from AuC]; Process1 --> Exit5(( )); D3 -- Yes --> Process2[Obtain vectors from AuC]; Process2 --> Exit6(( )); Note1[HLR operator option] -.-> Process2; +``` + +The flowchart illustrates the 'Check\_Available\_Vectors' procedure. It begins with a start symbol leading to a decision diamond: 'More vectors requested than stored?'. If 'No', it ends at an exit symbol. If 'Yes', it proceeds to another decision diamond: 'Number of vectors stored=0?'. If 'Yes', it ends at an exit symbol. If 'No', it proceeds to a decision diamond: 'Immediate Response Preferred indicator supported?'. If 'No', it ends at an exit symbol. If 'Yes', it proceeds to a decision diamond: 'Immediate response preferred?'. If 'Yes', it ends at an exit symbol. If 'No', it proceeds to a process block: 'Obtain vectors from AuC', which then ends at an exit symbol. If 'Yes' from the 'Immediate Response Preferred indicator supported?' diamond, it proceeds to another process block: 'Obtain vectors from AuC', which is also associated with an 'HLR operator option' note and ends at an exit symbol. + +Flowchart for Check\_Available\_Vectors procedure + +4909 + +4910 + +Figure 25.5/7: Procedure Check\_Available\_Vectors + +![State transition diagram for process Report_Authentication_Failure_VLR. The process starts at an initial state, goes to Idle, then to an Authentication failure report state. From there, it sends MAP_OPEN_req, MAP_AUTHENTICATION_FAILURE_REPORT_req, and MAP_DELIMITER_req to enter a Receive_Open_Cnf state. From Receive_Open_Cnf, an OK response leads to Wait_For_HLR_Response, while a Vr, Error response leads back to Idle. From Wait_For_HLR_Response, a MAP_NOTICE_ind leads to a MAP_CLOSE_req state which returns to Idle. A successful completion (MAP_AUTHENTICATION_FAILURE_REPORT_cnf, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind) also returns the process to Idle.](b605973eb46aa44282266453180c5d23_img.jpg) + +**process Report\_Authentication\_Failure\_VLR** **Rep\_Auth\_Fail\_VLR1(1)** + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Auth_Fail_Report: Authentication failure report + Auth_Fail_Report --> Send_Req: MAP_OPEN_req, MAP_AUTHENTICATION_FAILURE_REPORT_req, MAP_DELIMITER_req + Send_Req --> Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Receive_Open_Cnf --> Idle: Vr, Error + Wait_For_HLR_Response --> Notice_Ind: MAP_NOTICE_ind + Notice_Ind --> Close_Req: MAP_CLOSE_req + Close_Req --> Idle + Wait_For_HLR_Response --> Done: MAP_AUTHENTICATION_FAILURE_REPORT_cnf, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Done --> Idle + +``` + +Process in the VLR to send an authentication failure report to the HLR + +Signals to/from the left are to/from the application process in the VLR; signals to/from the right are to/from the HLR + +State transition diagram for process Report\_Authentication\_Failure\_VLR. The process starts at an initial state, goes to Idle, then to an Authentication failure report state. From there, it sends MAP\_OPEN\_req, MAP\_AUTHENTICATION\_FAILURE\_REPORT\_req, and MAP\_DELIMITER\_req to enter a Receive\_Open\_Cnf state. From Receive\_Open\_Cnf, an OK response leads to Wait\_For\_HLR\_Response, while a Vr, Error response leads back to Idle. From Wait\_For\_HLR\_Response, a MAP\_NOTICE\_ind leads to a MAP\_CLOSE\_req state which returns to Idle. A successful completion (MAP\_AUTHENTICATION\_FAILURE\_REPORT\_cnf, MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind) also returns the process to Idle. + +4911 + +4912 + +**Figure 25.5/9: Process Report\_Authentication\_Failure\_VLR** + +![State transition diagram for process Report_Authentication_Failure_SGSN. It starts at Idle, receives an authentication failure report, sends MAP requests, receives a confirmation, and then either waits for an HLR response or returns to Idle. Upon receiving an HLR response, it sends a notice and close request, returning to Idle, or handles an authentication failure report confirmation.](26cf894361680874f5c51acffdd85eaf_img.jpg) + +**process Report\_Authentication\_Failure\_SGSN** **Rep\_Auth\_Fail\_SGSN1(1)** + +Process in the SGSN to send an authentication failure report to the HLR + +Signals to/from the left are to/from the application process in the SGSN; signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Auth_Fail_Report: Authentication failure report + Auth_Fail_Report --> Send_Req: MAP_OPEN_req, MAP_AUTHENTICATION_FAILURE_REPORT_req, MAP_DELIMITER_req + Send_Req --> Receive_Open_Cnf: Receive_Open_Cnf + Receive_Open_Cnf --> Wait_For_HLR_Response: OK + Receive_Open_Cnf --> Idle: Vr, Error + Wait_For_HLR_Response --> Send_Notice: MAP_NOTICE_ind + Wait_For_HLR_Response --> Handle_Cnf: MAP_AUTHENTICATION_FAILURE_REPORT_cnf, MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Send_Notice --> Send_Close: MAP_CLOSE_req + Send_Close --> Idle + Handle_Cnf --> Idle + +``` + +State transition diagram for process Report\_Authentication\_Failure\_SGSN. It starts at Idle, receives an authentication failure report, sends MAP requests, receives a confirmation, and then either waits for an HLR response or returns to Idle. Upon receiving an HLR response, it sends a notice and close request, returning to Idle, or handles an authentication failure report confirmation. + +4913 + +4914 + +**Figure 25.5/10: Process Report\_Authentication\_Failure\_SGSN** + +![State transition diagram for Note_Authentication_Failure_HLR process. It starts at Idle, receives an Open_Ind, waits for a report, then branches based on MAP_AUTHENTICATION_FAILURE_REPORT_ind, MAP_NOTICE_ind, and MAP_P_ABORT_ind. It includes decision points for subscriber status and error handling, returning to Idle.](b76d25ab65e4f05f195c2d46acbdbd72_img.jpg) + +**process Note\_Authentication\_Failure\_HLR** **Note\_Auth\_Fail\_HLR1(1)** + +Process in the HLR to handle an authentication failure report from the VLR or SGSN + +Signals to/from the left are to/from the VLR or SGSN; +signals to/from the right are to/from the application process in the HLR + +``` + +stateDiagram-v2 + [*] --> Idle + Idle --> Receive_Open_Ind + Receive_Open_Ind --> Wait_For_Report : OK + Receive_Open_Ind --> Idle : Vr, Error + state "MAP_AUTHENTICATION_FAILURE_REPORT_ind" as MAP_AUTHENTICATION_FAILURE_REPORT_ind + state "MAP_NOTICE_ind" as MAP_NOTICE_ind + state "MAP_P_ABORT_ind" as MAP_P_ABORT_ind + Wait_For_Report --> MAP_AUTHENTICATION_FAILURE_REPORT_ind + Wait_For_Report --> MAP_NOTICE_ind + Wait_For_Report --> MAP_P_ABORT_ind + MAP_AUTHENTICATION_FAILURE_REPORT_ind --> Check_Indication + Check_Indication --> Subscriber_known? : OK + Check_Indication --> Error + Subscriber_known? --> Authentication_failure_report : Yes + Subscriber_known? --> Set_User_Error : No + Set_User_Error --> Set_User_Error : Unknown Subscriber + Authentication_failure_report --> MAP_AUTHENTICATION_FAILURE_REPORT_rsp + Set_User_Error --> MAP_AUTHENTICATION_FAILURE_REPORT_rsp + Error --> MAP_AUTHENTICATION_FAILURE_REPORT_rsp + MAP_AUTHENTICATION_FAILURE_REPORT_rsp --> Idle + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_P_ABORT_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> Idle + state "MAP_AUTHENTICATION_FAILURE_REPORT_rsp" as MAP_AUTHENTICATION_FAILURE_REPORT_rsp + state "MAP_CLOSE_req" as MAP_CLOSE_req + state "Set User Error: Unknown Subscriber" as Set_User_Error + state "Authentication failure report" as Authentication_failure_report + state "Subscriber known?" as Subscriber_known? + state "Check_Indication" as Check_Indication + state "Receive_Open_Ind" as Receive_Open_Ind + state "Wait_For_Report" as Wait_For_Report + +``` + +State transition diagram for Note\_Authentication\_Failure\_HLR process. It starts at Idle, receives an Open\_Ind, waits for a report, then branches based on MAP\_AUTHENTICATION\_FAILURE\_REPORT\_ind, MAP\_NOTICE\_ind, and MAP\_P\_ABORT\_ind. It includes decision points for subscriber status and error handling, returning to Idle. + +4915 + +4916 + +**Figure 25.5/11: Process Note\_Authentication\_Failure\_HLR** + +## 4917 25.6 IMEI Handling Macros + +4918 The following macros are used in the network in order to enable handling and checking of the mobile equipment +4919 identity. + +### 4920 25.6.1 Macro Check\_IMEI\_MSC + +4921 This macro is used by the MSC to receive a request from the VLR, relay it to the EIR, and pass the result from the EIR +4922 back to the VLR. + +4923 Sheet 1: If the dialogue with the EIR drops back to a previous protocol version and the EIR returned an error, the MSC +4924 relays the error to the VLR in the MAP\_CHECK\_IMEI response. If the dialogue with the EIR failed, or the EIR +4925 returned a badly formed result, the MSC sends a System Failure error to the VLR in the MAP\_CHECK\_IMEI response. + +### 4926 25.6.2 Macro Check\_IMEI\_VLR + +4927 This macro is used by the VLR to control the check of a mobile equipment's IMEI. It may also be used to request the +4928 BMUEF from the EIR. + +### 4929 25.6.3 Process Check\_IMEI\_SGSN + +4930 This process is used by the SGSN to control the check of a mobile equipment's IMEI. It may also be used to request the +4931 BMUEF from the EIR. + +### 4932 25.6.4 Process Check\_IMEI\_EIR + +4933 This process is used by the EIR to obtain the status of a mobile equipment, upon request from the MSC or from the +4934 SGSN. It may also be used to obtain the BMUEF. + +### 4935 25.6.5 Macro Obtain\_IMEI\_MSC + +4936 This macro is used by the MSC to respond to a request from the VLR to provide the IMEI. + +### 4937 25.6.6 Macro Obtain\_IMEI\_VLR + +4938 This macro is used by the VLR to obtain the IMEI from the MSC. + +macrodefinition Check\_IMEI\_MSC + +Chk\_IMEI\_MSC1(2) + +Macro in the MSC to check the IMEI of the MS, and report the result to the VLR + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR unless marked otherwise + +![Flowchart for macrodefinition Check_IMEI_MSC. The process starts with a MAP_CHECK_IMEI_ind signal. It checks if BMUEF is requested. If no, it checks if IMEI is available. If yes, it sends an A_IDENTITY_REQUEST_req with Requested identity=IMEI and waits for IMEI. If no, it goes to connector 1. If BMUEF is requested, it checks if IMEISV is available. If yes, it sends an A_IDENTITY_REQUEST_req with Requested identity=IMEISV and waits for IMEI. If no, it goes to connector 1. Both wait states lead to a merge point. From the merge point, it sends MAP_OPEN_req, MAP_CHECK_IMEI_req, and MAP_DELIMITER_req to the EIR. It receives an Open_Cnf and checks if the response is OK, Vr, or Error. If OK, it waits for an EIR_Response. If Vr, it performs a MAP Vr dialogue and checks for a successful result. If successful, it adds IMEI to the service response to VLR. If not, it sets a user error. If Error, it sets a user error for system failure. All three paths (OK, Vr, Error) lead to a merge point that sends a MAP_CHECK_IMEI_rsp and MAP_DELIMITER_req to the VLR and ends at an OK connector. The EIR_Response path leads to a MAP_CHECK_IMEI_cnf signal, a Check_Confirmation process, and then checks for OK, User Error, or Provider Error/Data Error. OK leads to adding IMEI to the service response to VLR. User Error and Provider Error/Data Error lead to setting a user error for system failure. Both lead to a merge point that sends a MAP_CHECK_IMEI_rsp and MAP_DELIMITER_req to the VLR and ends at an OK connector.](87c2452c5d2acd3ac68f64b22b4a473f_img.jpg) + +``` + +graph TD + Start([Start]) --> MAP_CHECK_IMEI_ind{MAP_CHECK_IMEI_ind} + MAP_CHECK_IMEI_ind --> BMUEF_requested{BMUEF requested?} + BMUEF_requested -- No --> IMEI_available{IMEI available?} + BMUEF_requested -- Yes --> IMEISV_available{IMEISV available?} + IMEI_available -- No --> A_IDENTITY_REQUEST_req_IMEI{A_IDENTITY_REQUEST_req} + IMEI_available -- Yes --> 1((1)) + A_IDENTITY_REQUEST_req_IMEI --> Requested_identity_IMEI[Requested identity=IMEI] + Requested_identity_IMEI --> Wait_For_IMEI_1[Wait_For_IMEI] + IMEISV_available -- No --> A_IDENTITY_REQUEST_req_IMEISV{A_IDENTITY_REQUEST_req} + IMEISV_available -- Yes --> Requested_identity_IMEISV[Requested identity=IMEISV] + Requested_identity_IMEISV --> Wait_For_IMEI_2[Wait_For_IMEI] + Wait_For_IMEI_1 --> Merge1(( )) + Wait_For_IMEI_2 --> Merge1 + Merge1 --> To_EIR[To EIR] + To_EIR --> MAP_OPEN_req[MAP_OPEN_req +MAP_CHECK_IMEI_req +MAP_DELIMITER_req] + MAP_OPEN_req --> Receive_Open_Cnf[Receive_Open_Cnf] + Receive_Open_Cnf --> Response_Decision{Response Decision} + Response_Decision -- OK --> Wait_For_EIR_Response[Wait_For_EIR_Response] + Response_Decision -- Vr --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Response_Decision -- Error --> Set_User_Error_System_Failure_1[Set User Error: System failure] + Perform_MAP_Vr_dialogue --> Successful_result{Successful result?} + Successful_result -- Yes --> Add_IMEI_to_service_response_1[Add IMEI to service response to VLR] + Successful_result -- No --> Set_User_Error_1[Set User Error] + Add_IMEI_to_service_response_1 --> Merge2(( )) + Set_User_Error_1 --> Merge2 + Set_User_Error_System_Failure_1 --> Merge2 + Merge2 --> MAP_CHECK_IMEI_rsp_1[MAP_CHECK_IMEI_rsp +MAP_DELIMITER_req] + MAP_CHECK_IMEI_rsp_1 --> OK_1((OK)) + Wait_For_EIR_Response --> MAP_CHECK_IMEI_cnf{MAP_CHECK_IMEI_cnf} + MAP_CHECK_IMEI_cnf --> From_EIR[From EIR] + From_EIR --> Check_Confirmation[Check_Confirmation] + Check_Confirmation --> Confirmation_Decision{Confirmation Decision} + Confirmation_Decision -- OK --> Add_IMEI_to_service_response_2[Add IMEI to service response to VLR] + Confirmation_Decision -- User Error --> Set_User_Error_System_Failure_2[Set User Error: System failure] + Confirmation_Decision -- Provider Error, Data Error --> Set_User_Error_System_Failure_2 + Add_IMEI_to_service_response_2 --> Merge3(( )) + Set_User_Error_System_Failure_2 --> Merge3 + Merge3 --> MAP_CHECK_IMEI_rsp_2[MAP_CHECK_IMEI_rsp +MAP_DELIMITER_req] + MAP_CHECK_IMEI_rsp_2 --> OK_2((OK)) + +``` + +Flowchart for macrodefinition Check\_IMEI\_MSC. The process starts with a MAP\_CHECK\_IMEI\_ind signal. It checks if BMUEF is requested. If no, it checks if IMEI is available. If yes, it sends an A\_IDENTITY\_REQUEST\_req with Requested identity=IMEI and waits for IMEI. If no, it goes to connector 1. If BMUEF is requested, it checks if IMEISV is available. If yes, it sends an A\_IDENTITY\_REQUEST\_req with Requested identity=IMEISV and waits for IMEI. If no, it goes to connector 1. Both wait states lead to a merge point. From the merge point, it sends MAP\_OPEN\_req, MAP\_CHECK\_IMEI\_req, and MAP\_DELIMITER\_req to the EIR. It receives an Open\_Cnf and checks if the response is OK, Vr, or Error. If OK, it waits for an EIR\_Response. If Vr, it performs a MAP Vr dialogue and checks for a successful result. If successful, it adds IMEI to the service response to VLR. If not, it sets a user error. If Error, it sets a user error for system failure. All three paths (OK, Vr, Error) lead to a merge point that sends a MAP\_CHECK\_IMEI\_rsp and MAP\_DELIMITER\_req to the VLR and ends at an OK connector. The EIR\_Response path leads to a MAP\_CHECK\_IMEI\_cnf signal, a Check\_Confirmation process, and then checks for OK, User Error, or Provider Error/Data Error. OK leads to adding IMEI to the service response to VLR. User Error and Provider Error/Data Error lead to setting a user error for system failure. Both lead to a merge point that sends a MAP\_CHECK\_IMEI\_rsp and MAP\_DELIMITER\_req to the VLR and ends at an OK connector. + +4939 + +4940 + +Figure 25.6/1 (sheet 1 of 2): Macro Check\_IMEI\_MSC + +![State transition diagram for macro Check_IMEI_MSC. The diagram shows various states and transitions between them, including inputs like A_CM_RELEASE_ind, MAP_U_ABORT_req, A_DISC_req, and A_CLEAR_CMD_req, and outputs like To EIR, From EIR, and internal actions like Set User Error: System failure. It ends in OK and Error states.](6b1e14f97d1425d42564ddd890cf73b4_img.jpg) + +macrodefinition Check\_IMEI\_MSC + +Chk\_IMEI\_MSC2(2) + +Macro in the MSC to check the IMEI of the MS; and report the result to the VLR + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR unless marked otherwise + +``` + +stateDiagram-v2 + [*] --> Wait_For_EIR_Response + state "Wait_For_EIR_Response" as Wait_For_EIR_Response + + Wait_For_EIR_Response --> A_CM_RELEASE_ind + Wait_For_EIR_Response --> MAP_U_ABORT_ind_MAP_CLOSE_ind + Wait_For_EIR_Response --> MAP_NOTICE_ind + Wait_For_EIR_Response --> MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind_from_EIR + + A_CM_RELEASE_ind --> MAP_U_ABORT_req_1[MAP_U_ABORT_req] + MAP_U_ABORT_req_1 --> To_EIR_1[To EIR] + MAP_U_ABORT_req_1 --> MAP_U_ABORT_req_2[MAP_U_ABORT_req] + MAP_U_ABORT_req_2 --> Error_1((Error)) + + MAP_U_ABORT_ind_MAP_CLOSE_ind --> MAP_U_ABORT_req_3[MAP_U_ABORT_req] + MAP_U_ABORT_req_3 --> To_EIR_2[To EIR] + MAP_U_ABORT_req_3 --> A_DISC_req + A_DISC_req --> A_CLEAR_CMD_req + A_CLEAR_CMD_req --> Error_2((Error)) + + MAP_NOTICE_ind --> From_EIR[From EIR] + MAP_NOTICE_ind --> MAP_CLOSE_req + MAP_CLOSE_req --> To_EIR_3[To EIR] + + MAP_U_ABORT_ind_MAP_P_ABORT_ind_MAP_CLOSE_ind_from_EIR --> Set_User_Error[Set User Error: System failure] + Set_User_Error --> MAP_CHECK_IMEI_rsp_MAP_DELIMITER_req + MAP_CHECK_IMEI_rsp_MAP_DELIMITER_req --> OK((OK)) + +``` + +State transition diagram for macro Check\_IMEI\_MSC. The diagram shows various states and transitions between them, including inputs like A\_CM\_RELEASE\_ind, MAP\_U\_ABORT\_req, A\_DISC\_req, and A\_CLEAR\_CMD\_req, and outputs like To EIR, From EIR, and internal actions like Set User Error: System failure. It ends in OK and Error states. + +4941 + +4942 + +Figure 25.6/1 (sheet 2 of 2): Macro Check\_IMEI\_MSC + +macrodefinition Check\_IMEI\_VLR + +Chk\_IMEI\_VLR1(1) + +Macro in the VLR to instruct the MSC to check the IMEI of the MS and handle the report of the result + +Signals to/from the left are to/from the MSC; signals to/from the right are to/from the OMC + +![Flowchart for macro Check_IMEI_VLR. It starts with an entry point, followed by a signal request (MAP_CHECK_IMEI_req, MAP_DELIMITER_req) to the left. Then a 'Wait_For_Check_IMEI_REesult' state. A decision point follows: if 'MAP_CHECK_IMEI_cnf' is received from the left, it checks if 'O&M notification required?'. If 'Yes', it sends 'OM_ALARM_req' to the left and then checks if 'Service granted?'. If 'Yes', it ends at 'OK'; if 'No', it ends at 'Error'. If 'No' to the first decision, it ends at 'OK'. If the second signal (MAP_U_ABORT_rind, MAP_CLOSE_ind) is received from the right, it ends at 'Aborted'.](a91e602653dae90e99b0810577600005_img.jpg) + +``` + +graph TD + Start([ ]) --> Request[MAP_CHECK_IMEI_req +MAP_DELIMITER_req] + Request --> Wait[Wait_For +Check_IMEI_ +REesult] + Wait --> Decision1{ } + Decision1 --> CNF[MAP +CHECK_ +IMEI_cnf] + Decision1 --> ABORT[MAP_U_ABORT_rind, +MAP_CLOSE_ind] + CNF --> OandM{O&M +notification +required?} + OandM -- No --> OK1([OK]) + OandM -- Yes --> Alarm[OM_ALARM_ +req] + Alarm --> Service{Service +granted?} + Service -- No --> Error([Error]) + Service -- Yes --> OK2([OK]) + ABORT --> Aborted([Aborted]) + +``` + +Flowchart for macro Check\_IMEI\_VLR. It starts with an entry point, followed by a signal request (MAP\_CHECK\_IMEI\_req, MAP\_DELIMITER\_req) to the left. Then a 'Wait\_For\_Check\_IMEI\_REesult' state. A decision point follows: if 'MAP\_CHECK\_IMEI\_cnf' is received from the left, it checks if 'O&M notification required?'. If 'Yes', it sends 'OM\_ALARM\_req' to the left and then checks if 'Service granted?'. If 'Yes', it ends at 'OK'; if 'No', it ends at 'Error'. If 'No' to the first decision, it ends at 'OK'. If the second signal (MAP\_U\_ABORT\_rind, MAP\_CLOSE\_ind) is received from the right, it ends at 'Aborted'. + +4943 + +4944 + +Figure 25.6/2: Macro Check\_IMEI\_VLR + +process Check\_IMEI\_SGSN + +Chk\_IMEI\_SGSN1(2) + +Process in the SGSN to check the IMEI of an MS + +Signals to/from the left are to/from the application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the EIR + +![Flowchart for process Check_IMEI_SGSN. It starts with 'Idle', followed by 'Check IMEI'. A decision 'BMUEF requested?' leads to two parallel checks: 'IMEI available?' and 'IMEISV available?'. If both are 'Yes', it sends 'MAP_OPEN_req', 'MAP_CHECK_IMEI_req', and 'MAP_DELIMITER_req' to the EIR, then receives 'Open_Cnf'. A decision 'Requested Info includes Equipment status?' follows. If 'Yes', it performs a 'MAP Vr dialogue' with the EIR. The 'Result?' from the dialogue can be 'Success' (leading to 'Check IMEI ack' and back to 'Idle'), 'User Error' (leading to 'Set negative response: System failure' and then to connector '1'), or 'Provider Error, Data Error' (also leading to 'Set negative response: System failure' and connector '1'). If 'No' to the equipment status question, it goes to 'Wait_For_EIR_Response' and then to connector '1'. If 'Error' to the equipment status question, it goes directly to connector '1'. If either 'IMEI available?' or 'IMEISV available?' is 'No', it goes directly to connector '1'.](2fdcbae1c7a6dc2ee6e97c1b5df177b4_img.jpg) + +``` + +graph TD + Start([Idle]) --> CheckIMEI{Check IMEI} + CheckIMEI --> BMUEF{BMUEF requested?} + BMUEF -- No --> IMEIAvailable{IMEI available?} + BMUEF -- Yes --> IMEISVAvailable{IMEISV available?} + IMEIAvailable -- No --> 1((1)) + IMEIAvailable -- Yes --> MAP_Req[MAP_OPEN_req +MAP_CHECK_IMEI_req +MAP_DELIMITER_req] + IMEISVAvailable -- No --> 1 + IMEISVAvailable -- Yes --> MAP_Req + MAP_Req --> OpenCnf[Receive Open_Cnf] + OpenCnf --> RequestedInfo{Requested Info includes Equipment status?} + RequestedInfo -- No --> WaitForResponse([Wait_For_EIR_Response]) + RequestedInfo -- Yes --> MAPVr[Perform MAP Vr dialogue] + RequestedInfo -- Error --> 1 + MAPVr --> Result{Result?} + Result -- Success --> IMEIAck{Check IMEI ack} + IMEIAck --> Idle([Idle]) + Result -- User Error --> NegativeResponse[Set negative response: System failure] + NegativeResponse --> 1 + Result -- "Provider Error, Data Error" --> NegativeResponse + WaitForResponse --> 1 + +``` + +Flowchart for process Check\_IMEI\_SGSN. It starts with 'Idle', followed by 'Check IMEI'. A decision 'BMUEF requested?' leads to two parallel checks: 'IMEI available?' and 'IMEISV available?'. If both are 'Yes', it sends 'MAP\_OPEN\_req', 'MAP\_CHECK\_IMEI\_req', and 'MAP\_DELIMITER\_req' to the EIR, then receives 'Open\_Cnf'. A decision 'Requested Info includes Equipment status?' follows. If 'Yes', it performs a 'MAP Vr dialogue' with the EIR. The 'Result?' from the dialogue can be 'Success' (leading to 'Check IMEI ack' and back to 'Idle'), 'User Error' (leading to 'Set negative response: System failure' and then to connector '1'), or 'Provider Error, Data Error' (also leading to 'Set negative response: System failure' and connector '1'). If 'No' to the equipment status question, it goes to 'Wait\_For\_EIR\_Response' and then to connector '1'. If 'Error' to the equipment status question, it goes directly to connector '1'. If either 'IMEI available?' or 'IMEISV available?' is 'No', it goes directly to connector '1'. + +4945 + +4946 + +Figure 25.6/3 (sheet 1 of 2): Process Check\_IMEI\_SGSN + +![Flowchart for process Check_IMEI_SGSN. It starts with 'Wait_For_EIR_Response'. From here, three paths emerge: 1) Left path: 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to 'Set negative response: System failure' and connector '1'. 2) Middle path: 'MAP_CHECK_IMEI_cnf' leads to 'Check_Confirmation'. From 'Check_Confirmation', 'User Error' leads to connector '1', 'OK' leads to decision 'O&M notification required?'. If 'Yes', 'OM_ALARM_req' leads to 'To OMC' and then to decision 'Service granted?'. If 'No', it leads directly to 'Service granted?'. From 'Service granted?', 'Yes' leads to 'Check IMEI ack' and 'Idle', while 'No' leads to 'Set negative response: System failure' and connector '1'. 3) Right path: 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which leads to 'Set negative response: System failure' and connector '1'. All 'Set negative response: System failure' blocks lead to connector '1'. All 'Idle' blocks lead to connector '1'. A 'Provider Error, Data Error' signal is shown between the middle and right paths.](21a0b5ff618c57628a62641fb899dd66_img.jpg) + +process Check\_IMEI\_SGSN + +Chk\_IMEI\_SGSN2(2) + +Process in the SGSN to check the IMEI of an MS + +Signals to/from the left are to/from the application process in the SGSN (see 3GPP TS 23.060); signals to/from the right are to/from the EIR + +``` + +graph TD + Start([Wait_For_EIR_Response]) --> MAP_U_ABORT[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + Start --> MAP_CHECK_IMEI_cnf[MAP_CHECK_IMEI_cnf] + Start --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_U_ABORT --> SetNeg1[Set negative response: System failure] + SetNeg1 --> C1((1)) + MAP_CHECK_IMEI_cnf --> CheckConf[Check_Confirmation] + CheckConf -- User Error --> C2((1)) + CheckConf -- OK --> OandMReq{O&M notification required?} + OandMReq -- Yes --> OMAlarm[OM_ALARM_req] + OMAlarm --> ToOMC[To OMC] + ToOMC --> ServiceGranted{Service granted?} + OandMReq -- No --> ServiceGranted + ServiceGranted -- Yes --> CheckIMEIAck[Check IMEI ack] + CheckIMEIAck --> Idle1([Idle]) + ServiceGranted -- No --> SetNeg2[Set negative response: System failure] + SetNeg2 --> C3((1)) + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + MAP_CLOSE_req --> SetNeg3[Set negative response: System failure] + SetNeg3 --> C4((1)) + CheckConf -- "Provider Error, Data Error" --> MAP_NOTICE_ind + +``` + +Flowchart for process Check\_IMEI\_SGSN. It starts with 'Wait\_For\_EIR\_Response'. From here, three paths emerge: 1) Left path: 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to 'Set negative response: System failure' and connector '1'. 2) Middle path: 'MAP\_CHECK\_IMEI\_cnf' leads to 'Check\_Confirmation'. From 'Check\_Confirmation', 'User Error' leads to connector '1', 'OK' leads to decision 'O&M notification required?'. If 'Yes', 'OM\_ALARM\_req' leads to 'To OMC' and then to decision 'Service granted?'. If 'No', it leads directly to 'Service granted?'. From 'Service granted?', 'Yes' leads to 'Check IMEI ack' and 'Idle', while 'No' leads to 'Set negative response: System failure' and connector '1'. 3) Right path: 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which leads to 'Set negative response: System failure' and connector '1'. All 'Set negative response: System failure' blocks lead to connector '1'. All 'Idle' blocks lead to connector '1'. A 'Provider Error, Data Error' signal is shown between the middle and right paths. + +4947 + +4948 + +Figure 25.6/3 (sheet 2 of 2): Process Check\_IMEI\_SGSN + +![Flowchart for process Check_IMEI_EIR. It starts at 'Idle', receives an 'Open_Ind' primitive, and then branches based on 'OK', 'Error', or 'Vr' outcomes. The 'OK' path leads to 'Wait_For_Service_Primitive', which then branches into 'MAP_NOTICE_ind', 'MAP_CLOSE_req', and 'MAP_CHECK_IMEI_ind'. The 'MAP_CHECK_IMEI_ind' path leads to 'Check_Indication', which then branches based on 'OK' or 'Error'. The 'OK' path leads to 'IMEI known?' decision. If 'Yes', it goes to connector '1'. If 'No', it leads to 'Set User Error: Unknown Equipment', which then leads to 'MAP_CHECK_IMEI_rsp' and 'MAP_CLOSE_req', and finally 'Idle'. The 'Error' path from 'Check_Indication' leads to 'Idle'. The 'Error' path from 'Wait_For_Service_Primitive' leads to 'Perform MAP Vr dialogue', which then leads to connector '1'. The 'Vr' path from 'Wait_For_Service_Primitive' leads to 'Idle'. Connector '1' leads to 'Equipment status requested?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Equipment status supported?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Set equipment status', which then leads to 'BMUEF requested?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'BMUEF supported?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Set BMUEF', which then leads to 'MAP_CHECK_IMEI_rsp' and 'MAP_CLOSE_req', and finally 'Idle'.](0a75caa32bf3096417c03cfc94efb1f5_img.jpg) + +**process Check\_IMEI\_EIR** **Chk\_IMEI\_EIR1(1)** + +Process in the EIR to check the IMEI of an MS + +Signals to/from the left are to/from the MSC or the SGSN + +``` + +graph TD + Start([Idle]) --> Receive_Ind[Receive_Open_Ind] + Receive_Ind -- OK --> Wait_For_Service_Primitive([Wait_For_Service_Primitive]) + Receive_Ind -- Error --> Perform_MAP_Vr_dialogue[Perform MAP Vr dialogue] + Receive_Ind -- Vr --> Idle1([Idle]) + Wait_For_Service_Primitive --> MAP_NOTICE_ind[/MAP_NOTICE_ind/] + Wait_For_Service_Primitive --> MAP_CLOSE_req[/MAP_CLOSE_req/] + Wait_For_Service_Primitive --> MAP_CHECK_IMEI_ind[/MAP_CHECK_IMEI_ind/] + MAP_NOTICE_ind --> Idle2([Idle]) + MAP_CLOSE_req --> Idle2 + MAP_CHECK_IMEI_ind --> Check_Indication[Check_Indication] + Check_Indication -- OK --> IMEI_known{IMEI known?} + Check_Indication -- Error --> Idle3([Idle]) + IMEI_known -- Yes --> Connector_1((1)) + IMEI_known -- No --> Set_User_Error[Set User Error: Unknown Equipment] + Set_User_Error --> MAP_CHECK_IMEI_rsp[MAP_CHECK_IMEI_rsp] + Set_User_Error --> MAP_CLOSE_req2[/MAP_CLOSE_req/] + MAP_CHECK_IMEI_rsp --> Idle4([Idle]) + MAP_CLOSE_req2 --> Idle4 + Connector_1 --> Equipment_status_requested{Equipment status requested?} + Equipment_status_requested -- No --> Idle5([Idle]) + Equipment_status_requested -- Yes --> Equipment_status_supported{Equipment status supported?} + Equipment_status_supported -- No --> Idle5 + Equipment_status_supported -- Yes --> Set_equipment_status[Set equipment status] + Set_equipment_status --> BMUEF_requested{BMUEF requested?} + BMUEF_requested -- No --> Idle5 + BMUEF_requested -- Yes --> BMUEF_supported{BMUEF supported?} + BMUEF_supported -- No --> Idle5 + BMUEF_supported -- Yes --> Set_BMUEF[Set BMUEF] + Set_BMUEF --> MAP_CHECK_IMEI_rsp2[MAP_CHECK_IMEI_rsp] + Set_BMUEF --> MAP_CLOSE_req3[/MAP_CLOSE_req/] + MAP_CHECK_IMEI_rsp2 --> Idle6([Idle]) + MAP_CLOSE_req3 --> Idle6 + +``` + +Flowchart for process Check\_IMEI\_EIR. It starts at 'Idle', receives an 'Open\_Ind' primitive, and then branches based on 'OK', 'Error', or 'Vr' outcomes. The 'OK' path leads to 'Wait\_For\_Service\_Primitive', which then branches into 'MAP\_NOTICE\_ind', 'MAP\_CLOSE\_req', and 'MAP\_CHECK\_IMEI\_ind'. The 'MAP\_CHECK\_IMEI\_ind' path leads to 'Check\_Indication', which then branches based on 'OK' or 'Error'. The 'OK' path leads to 'IMEI known?' decision. If 'Yes', it goes to connector '1'. If 'No', it leads to 'Set User Error: Unknown Equipment', which then leads to 'MAP\_CHECK\_IMEI\_rsp' and 'MAP\_CLOSE\_req', and finally 'Idle'. The 'Error' path from 'Check\_Indication' leads to 'Idle'. The 'Error' path from 'Wait\_For\_Service\_Primitive' leads to 'Perform MAP Vr dialogue', which then leads to connector '1'. The 'Vr' path from 'Wait\_For\_Service\_Primitive' leads to 'Idle'. Connector '1' leads to 'Equipment status requested?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Equipment status supported?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Set equipment status', which then leads to 'BMUEF requested?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'BMUEF supported?' decision. If 'No', it goes to 'Idle'. If 'Yes', it leads to 'Set BMUEF', which then leads to 'MAP\_CHECK\_IMEI\_rsp' and 'MAP\_CLOSE\_req', and finally 'Idle'. + +4949 + +4950 + +Figure 25.6/4: Process Check\_IMEI\_EIR + +![Flowchart for macro Obtain_IMEI_MSC. The process starts with a connector, followed by a signal MAP_OBTAIN_IMEI_ind. A decision 'IMEI available?' follows. If 'Yes', it goes to 'Set IMEI'. If 'No', it goes to 'A_IDENTITY_REQUEST_req' (with 'Requested identity=IMEI'), then 'Wait_For_IMEI'. From 'Wait_For_IMEI', it branches to 'A_IDENTITY_RESPONSE_ind', 'A_CM_RELEASE_ind' (leading to 'Set User Error: System failure'), and an unlabeled signal block (leading to 'Error' and signals MAP_U_ABORT_ind, MAP_CLOSE_ind). All three branches converge to 'Set IMEI', which then leads to another unlabeled signal block (with signals MAP_OBTAIN_IMEI_rsp, MAP_DELIMITER_req) and finally 'OK'.](dc9c6705b711ba1323550e2a75df8454_img.jpg) + +macrodefinition Obtain\_IMEI\_MSC + +Obt\_IMEI\_MSC1(1) + +Macro in the MSC to obtain the IMEI from the MS + +Signals to/from the left are to/from the MS; signals to/from the right are to/from the VLR + +``` + +graph TD + Start([ ]) --> S1[MAP_OBTAIN_IMEI_ind] + S1 --> D{IMEI available?} + D -- Yes --> S2[Set IMEI] + D -- No --> S3{A_IDENTITY_REQUEST_req} + S3 --> T1[Requested identity=IMEI] + S3 --> S4([Wait_For_IMEI]) + S4 --> S5{A_IDENTITY_RESPONSE_ind} + S4 --> S6{A_CM_RELEASE_ind} + S4 --> S7[ ] + S6 --> T2[Set User Error: System failure] + S7 --> T3[MAP_U_ABORT_ind, MAP_CLOSE_ind] + S7 --> S8((Error)) + S5 --> S2 + T2 --> S2 + S2 --> S9[ ] + S9 --> T4[MAP_OBTAIN_IMEI_rsp, MAP_DELIMITER_req] + S9 --> S10((OK)) + +``` + +Flowchart for macro Obtain\_IMEI\_MSC. The process starts with a connector, followed by a signal MAP\_OBTAIN\_IMEI\_ind. A decision 'IMEI available?' follows. If 'Yes', it goes to 'Set IMEI'. If 'No', it goes to 'A\_IDENTITY\_REQUEST\_req' (with 'Requested identity=IMEI'), then 'Wait\_For\_IMEI'. From 'Wait\_For\_IMEI', it branches to 'A\_IDENTITY\_RESPONSE\_ind', 'A\_CM\_RELEASE\_ind' (leading to 'Set User Error: System failure'), and an unlabeled signal block (leading to 'Error' and signals MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind). All three branches converge to 'Set IMEI', which then leads to another unlabeled signal block (with signals MAP\_OBTAIN\_IMEI\_rsp, MAP\_DELIMITER\_req) and finally 'OK'. + +4951 + +4952 + +Figure 25.6/5: Macro Obtain\_IMEI\_MSC + +![State transition diagram for macro Obtain_IMEI_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state leading to a transition labeled 'MAP_OBTAIN_IMEI_req' and 'MAP_DELIMITER_req'. This leads to a 'Wait_For_IMEI' state. From this state, a transition labeled 'MAP_OBTAIN_IMEI_cnf' leads to a 'Check Confirmation' state. From 'Check Confirmation', an 'OK' transition leads to an 'OK' state, and a 'User Error, Provider Error, Data Error' transition leads to an 'Error' state. There is also a transition from 'Wait_For_IMEI' to an 'Aborted' state, labeled with 'MAP_U_ABORT_ind' and 'MAP_CLOSE_ind'.](c401b995325dba88808f67e3758152ff_img.jpg) + +macrodefinition Obtain\_IMEI\_VLR + +Obt\_IMEI\_VLR1(1) + +Macro in the VLR to instruct the MSC to obtain the IMEI of the MS and handle the report of the result + +Signals to/from the left are to/from the MSC + +``` + +stateDiagram-v2 + [*] --> Transition1 + state " " as Transition1 + Transition1 --> Wait_For_IMEI + state "Wait_For_IMEI" as Wait_For_IMEI + Wait_For_IMEI --> CheckConfirmation + state "Check Confirmation" as CheckConfirmation + CheckConfirmation --> OK + state "OK" as OK + CheckConfirmation --> Error + state "Error" as Error + Wait_For_IMEI --> Aborted + state "Aborted" as Aborted + Transition1 --> MAP_OBTAIN_IMEI_req + note right of MAP_OBTAIN_IMEI_req: MAP_OBTAIN_IMEI_req +MAP_DELIMITER_req + CheckConfirmation --> MAP_U_ABORT_ind + note right of MAP_U_ABORT_ind: MAP_U_ABORT_ind, +MAP_CLOSE_ind + CheckConfirmation --> UserError + note right of UserError: User Error, +Provider Error, +Data Error + +``` + +State transition diagram for macro Obtain\_IMEI\_VLR. The diagram shows a sequence of states and transitions. It starts with an initial state leading to a transition labeled 'MAP\_OBTAIN\_IMEI\_req' and 'MAP\_DELIMITER\_req'. This leads to a 'Wait\_For\_IMEI' state. From this state, a transition labeled 'MAP\_OBTAIN\_IMEI\_cnf' leads to a 'Check Confirmation' state. From 'Check Confirmation', an 'OK' transition leads to an 'OK' state, and a 'User Error, Provider Error, Data Error' transition leads to an 'Error' state. There is also a transition from 'Wait\_For\_IMEI' to an 'Aborted' state, labeled with 'MAP\_U\_ABORT\_ind' and 'MAP\_CLOSE\_ind'. + +4953 + +4954 + +Figure 25.6/6: Macro Obtain\_IMEI\_VLR + +## 4955 25.7 Insert Subscriber Data macros and processes + +### 4956 25.7.1 Macro Insert\_Subs\_Data\_VLR + +4957 This macro is used by any procedure in the VLR that triggers the reception of subscriber data (e.g. Update Location, +4958 Update VCSG Location or Restore Data). + +### 4959 25.7.2 Macro Insert\_Subs\_Data\_SGSN + +4960 This macro is used by any procedure that triggers the reception of subscriber data (e.g. Update GPRS Location or +4961 Update VCSG Location ). + +### 4962 25.7.3 Process Insert\_Subs\_Data\_Stand\_Alone\_HLR + +4963 This process is used by HLR to transfer subscriber data to the VLR in a stand alone mode, i.e. in a separate dialogue. +4964 This is done whenever a change of subscriber data is performed either by the operator or by the subscriber and this +4965 change has to be reported to the VLR. + +4966 Sheet 1: The HLR may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it +4967 sends the next request, or it may handle the requests and the confirmations in parallel. + +4968 Sheet 1, sheet 2: If the VLR has indicated that it does not support a service or feature (e.g. Closed User Group or +4969 Advice Of Charge Charging Level) which the HLR operator regards as essential for the subscriber, the macro +4970 Wait\_for\_Insert\_Subs\_Data\_Cnf takes the Replace\_Service exit; the HLR sets the Roaming Restriction Due To +4971 Unsupported Feature flag to roaming restricted and sends Roaming Restriction Due To Unsupported Feature in a +4972 subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +4973 Sheet 1, sheet 2: If the HLR operator does not regard the unsupported service or feature as essential for the subscriber +4974 but the macro Wait\_for\_Insert\_Subs\_Data\_Cnf takes the Replace\_Service exit, the HLR sends the data for a +4975 replacement service in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +4976 Sheet 2: It is an operator option whether to repeat the download of subscriber data if the VLR returns an error response. +4977 The number of repeat attempts and the interval between them is also an operator option, depending on the error +4978 response from the VLR. + +4979 If subscriber data for CAMEL Phase 2 or later services are sent to a VLR which does not support the appropriate phase +4980 of CAMEL, the service behaviour may be unpredictable or incorrect. The HLR should therefore ensure that at the +4981 conclusion of a stand alone Insert Subscriber data procedure the data in the VLR do not require a capability that the +4982 VLR does not have. Possible mechanisms to ensure this are described in 3GPP TS 23.078 [98]. + +4983 The HLR should send a Forwarded-to number which is not in E.164 international format to the VLR only when the +4984 HLR has ascertained that the VLR supports CAMEL Phase 2 or later. Thus, the ISD message containing the +4985 Forwarded-to number which is not in E.164 international format shall be sent to the VLR only if the HLR previously +4986 received confirmation from the VLR at Location Update that CAMEL Phase 2 or later is supported. + +### 4987 25.7.4 Process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR + +4988 This process is used by the HLR to transfer subscriber data from the HLR to the SGSN in a stand alone mode, i.e. in a +4989 separate dialogue. This is done whenever a change of subscriber data is performed either by the operator or by the +4990 subscriber and this change has to be reported to the SGSN. + +4991 Sheet 1: The HLR may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it +4992 sends the next request, or it may handle the requests and the confirmations in parallel. + +4993 Sheet 1, sheet 2: If the SGSN has indicated that it does not support a service or feature which the HLR operator regards +4994 as essential for the subscriber, the macro Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf takes the Replace\_Service exit; the +4995 HLR sets the Roaming Restricted In SGSN Due To Unsupported Feature flag to roaming restricted and sends Roaming +4996 Restricted In SGSN Due To Unsupported Feature in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +4997 Sheet 1, sheet 2: If the HLR operator does not regard the unsupported service or feature as essential for the subscriber +4998 but the macro Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf takes the Replace\_Service exit, the HLR sends the data for a +4999 replacement service in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +5000 Sheet 2: It is an operator option whether to repeat the download of subscriber data if the SGSN returns an error +5001 response. The number of repeat attempts and the interval between them is also an operator option, depending on the +5002 error response from the SGSN. + +### 5003 25.7.5 Macro Wait\_for\_Insert\_Subs\_Data\_Cnf + +5004 This macro is used by any process or macro that describes the handling in the HLR of the transfer of subscriber data to +5005 the VLR (e.g. Update Location or Restore Data). + +### 5006 25.7.6 Macro Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf + +5007 This macro is used by any process or macro that describes the handling in the HLR of the transfer of subscriber data to +5008 the SGSN (e.g. Update GPRS Location). + +### 5009 25.7.7 Process Send\_Insert\_Subs\_Data\_HLR + +5010 This process is used by any process or macro in the HLR where a MAP\_INSERT\_SUBSCRIBER\_DATA request is +5011 sent to the VLR or to the SGSN. + +### 5012 25.7.8 Process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS + +5013 This process is used by the CSS to transfer CSG subscriber data from the CSS to the VLR or the SGSN in a stand alone +5014 mode, i.e. in a separate dialogue. This is done whenever a change of CSG subscriber data in the CSS is performed either +5015 by the operator or by the subscriber and this change has to be reported to the VLR or the SGSN. + +5016 Sheet 1: The CSS may wait for each MAP\_INSERT\_SUBSCRIBER\_DATA request to be acknowledged before it +5017 sends the next request, or it may handle the requests and the confirmations in parallel. + +5018 Sheet 1, sheet 2: If the VLR or the SGSN has indicated that it does not support a service or feature which the CSS +5019 operator regards as essential for the subscriber, the macro Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf takes the +5020 Replace\_Service exit. + +5021 Sheet 1, sheet 2: If the CSS operator does not regard the unsupported service or feature as essential for the subscriber +5022 but the macro Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf takes the Replace\_Service exit, the CSS sends the data for a +5023 replacement service in a subsequent MAP\_INSERT\_SUBSCRIBER\_DATA request. + +5024 Sheet 2: It is an operator option whether to repeat the download of CSG subscriber data if the VLR or the SGSN returns +5025 an error response. The number of repeat attempts and the interval between them is also an operator option, depending +5026 on the error response from the VLR or the SGSN. + +### 5027 25.7.9 Macro Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf + +5028 This macro is used by any process or macro that describes the handling in the CSS of the transfer of CSG subscriber +5029 data to the VLR or to the SGSN (e.g. Update VCSG Location). + +### 5030 25.7.10 Process Send\_Insert\_VCSG\_Subs\_Data\_CSS + +5031 This process is used by any process or macro in the CSS where a MAP\_INSERT\_SUBSCRIBER\_DATA request is sent +5032 to the VLR or to the SGSN. + +5033 + +![Flowchart for Insert_Subs_Data_VLR macro. It starts with an incoming MAP_INSERT_SUBSCRIBER_DATA_ind signal, followed by a 'Check_Indication' block. An 'OK' path leads to a decision 'All received services & features supported?'. If 'Yes', it proceeds to 'Update subscriber data'. If 'No', it proceeds to 'Update subscriber data for supported services & features' and then 'Set parameters for unsupported services & features'. Both paths lead to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it proceeds to 'Set network node area restricted'. If 'No', it bypasses this block. All paths converge to an output block containing 'MAP_INSERT_SUBSCRIBER_DATA_rsp' and 'MAP_DELIMITER_req', ending at a connector symbol. An 'Error' path from 'Check_Indication' also leads to the output block.](60c66cf2790b64e5d2f34597d8d59fa1_img.jpg) + +macrodefinition Insert\_Subs\_Data\_VLR + +Ins\_Sub\_Dat\_VLR1(1) + +Macro in the VLR to handle an Insert Subscriber Data request from the HLR or the CSS + +Signals to/from the right are to/from the HLR or the CSS + +``` + +graph TD + Start([ ]) --> In{ } + In --> MAP_IN[MAP_INSERT_SUBSCRIBER_DATA_ind] + MAP_IN --> Check[Check_Indication] + Check -- OK --> Decision1{All received services & features supported?} + Check -- Error --> Output + Decision1 -- Yes --> Update1[Update subscriber data] + Decision1 -- No --> Update2[Update subscriber data for supported services & features] + Update2 --> SetParams[Set parameters for unsupported services & features] + Update1 --> Decision2{MSC area restricted due to regional subscription?} + SetParams --> Decision2 + Decision2 -- Yes --> SetRestricted[Set network node area restricted] + SetRestricted --> Output + Decision2 -- No --> Output + Output --> End([ ]) + subgraph Output + direction TB + O1[MAP_INSERT_SUBSCRIBER_DATA_rsp] + O2[MAP_DELIMITER_req] + end + +``` + +Flowchart for Insert\_Subs\_Data\_VLR macro. It starts with an incoming MAP\_INSERT\_SUBSCRIBER\_DATA\_ind signal, followed by a 'Check\_Indication' block. An 'OK' path leads to a decision 'All received services & features supported?'. If 'Yes', it proceeds to 'Update subscriber data'. If 'No', it proceeds to 'Update subscriber data for supported services & features' and then 'Set parameters for unsupported services & features'. Both paths lead to a decision 'MSC area restricted due to regional subscription?'. If 'Yes', it proceeds to 'Set network node area restricted'. If 'No', it bypasses this block. All paths converge to an output block containing 'MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp' and 'MAP\_DELIMITER\_req', ending at a connector symbol. An 'Error' path from 'Check\_Indication' also leads to the output block. + +5034 + +5035 + +Figure 25.7/1: Macro Insert\_Subs\_Data\_VLR + +![Flowchart for Insert_Subs_Data_SGSN macro. It starts with an incoming MAP_INSERT_SUBSCRIBER_DATA_ind signal, followed by a 'Check_Indication' step. If 'OK', it checks if all services and features are supported. If 'Yes', it updates subscriber data. If 'No', it updates data for supported services and sets parameters for unsupported ones. Both paths lead to a decision on whether the SGSN area is restricted. If 'Yes', it sets the network node area as restricted. Finally, it sends a response with MAP_INSERT_SUBSCRIBER_DATA_rsp and MAP_DELIMITER_req. An 'Error' path from 'Check_Indication' leads directly to the response stage.](11fcb90588a977a8dc718244fd07f5eb_img.jpg) + +macrodefinition Insert\_Subs\_Data\_SGSN + +Ins\_Sub\_Dat\_SGSN1(1) + +Macro in the VLR to handle an Insert Subscriber Data request from the HLR or the CSS + +Signals to/from the right are to/from the HLR or the CSS + +``` + +graph TD + Start([ ]) --> In{ } + In --> MAP_ind[MAP_INSERT_SUBSCRIBER_DATA_ind] + MAP_ind --> Check[Check_Indication] + Check -- OK --> AllSupp{All received services & features supported?} + Check -- Error --> Out{ } + AllSupp -- Yes --> UpdateData[Update subscriber data] + AllSupp -- No --> UpdateSupp[Update subscriber data for supported services & features] + UpdateSupp --> SetParams[Set parameters for unsupported services & features] + UpdateData --> Restricted{SGSN area restricted due to regional subscription?} + SetParams --> Restricted + Restricted -- Yes --> SetRestricted[Set network node area restricted] + SetRestricted --> Out + Restricted -- No --> Out + Out --> MAP_rsp[MAP_INSERT_SUBSCRIBER_DATA_rsp +MAP_DELIMITER_req] + MAP_rsp --> End([ ]) + +``` + +Flowchart for Insert\_Subs\_Data\_SGSN macro. It starts with an incoming MAP\_INSERT\_SUBSCRIBER\_DATA\_ind signal, followed by a 'Check\_Indication' step. If 'OK', it checks if all services and features are supported. If 'Yes', it updates subscriber data. If 'No', it updates data for supported services and sets parameters for unsupported ones. Both paths lead to a decision on whether the SGSN area is restricted. If 'Yes', it sets the network node area as restricted. Finally, it sends a response with MAP\_INSERT\_SUBSCRIBER\_DATA\_rsp and MAP\_DELIMITER\_req. An 'Error' path from 'Check\_Indication' leads directly to the response stage. + +5036 + +5037 + +Figure 25.7/2: Macro Insert\_Subs\_Data\_SGSN + +![Flowchart for process Insert_Subs_Data_Stand_Alone_HLR. The process starts at node 5, opens a dialogue, receives confirmation, and then attempts to insert subscriber data. It includes loops for retries and handles various outcomes like OK, Error, and Abort.](bf7348d754a32240520fb34fcd03c5dd_img.jpg) + +**process Insert\_Subs\_Data\_Stand\_Alone\_HLR** **ISD\_SA\_HLR1(2)** + +Process in the HLR to open a dialogue and transfer subscriber data to the VLR + +Signals to/from the left are to/from the VLR + +``` + +graph TD + Start((5)) --> OpenReq{MAP_OPEN_req +MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req} + OpenReq --> ReceiveOpenCnf[Receive Open_Cnf] + ReceiveOpenCnf --> Decision1{OK / Error / Abort} + Decision1 -- OK --> WaitForInsertCnf[Wait_For_Insert_Subs_Data_Cnf] + Decision1 -- Error --> End1((1)) + Decision1 -- Abort --> End1 + WaitForInsertCnf --> Decision2{OK / Replace_Service / Error} + Decision2 -- OK --> AllDataInserted1{All data inserted?} + Decision2 -- Replace_Service --> SetReplacement[Set replacement service(s)] + SetReplacement --> AllDataInserted1 + Decision2 -- Error --> MAPUAbortReq{MAP_U_ABORT_req} + MAPUAbortReq --> End1 + AllDataInserted1 -- Yes --> End3((3)) + AllDataInserted1 -- No --> Count0[Count:=0] + Count0 --> SendInsertSubsDataHLR[Send_Insert_Subs_Data_HLR] + SendInsertSubsDataHLR --> CountInc[Count:= Count+1] + CountInc --> AllDataInserted2{All data inserted?} + AllDataInserted2 -- Yes --> End2((2)) + AllDataInserted2 -- No --> End4((4)) + PerformMAPVr[Perform MAP Vr dialogue] --> EndX[ ] + style EndX fill:none,stroke:none + +``` + +Flowchart for process Insert\_Subs\_Data\_Stand\_Alone\_HLR. The process starts at node 5, opens a dialogue, receives confirmation, and then attempts to insert subscriber data. It includes loops for retries and handles various outcomes like OK, Error, and Abort. + +5038 + +5039 + +**Figure 25.7/3 (sheet 1 of 2): Process Insert\_Subs\_Data\_Stand\_Alone\_HLR** + +![Flowchart for process Insert_Subs_Data_Stand_Alone_HLR. It starts at connector 2, goes to 'Wait_For_Insert_Subs_Data_Cnf'. From there, four paths emerge: 'Replace_Service' (Count:= Count-1, Set replacement service(s), connector 4), 'OK' (Count:= Count-1, Count>0? decision), 'Error' (MAP_U_ABORT_req, connector 1), and a path to connector 3. From connector 3, it goes to a decision 'Network node area restricted received OR Roaming Restriction due to Unsupported Feature?'. 'No' leads to connector 1. 'Yes' leads to 'MSC Area restricted:= Not restricted' or 'MSC Area restricted:= Restricted', both leading to 'MAP_CLOSE_req'. From 'MAP_CLOSE_req', it goes to 'Repeat update of VLR?'. 'No' leads to a crossed-out path. 'Yes' leads to 'Start repetition timer', 'Wait_For_Repetition_Timer_Expire', 'Repetition timer expired' (Internal), and connector 5.](578d951f22826d7b6df90f5769e1873a_img.jpg) + +**process Insert\_Subs\_Data\_Stand\_Alone\_HLR** **ISD\_SA\_HLR2(2)** + +Process in the HLR to open a dialogue and transfer subscriber data to the VLR + +Signals to/from the left are to/from the VLR + +``` + +graph TD + Start((2)) --> Wait[Wait_For_Insert_Subs_Data_Cnf] + Wait -- Replace_Service --> Count1[Count:= Count-1] + Count1 --> Set[Set replacement service(s)] + Set --> End4((4)) + Wait -- OK --> Count2[Count:= Count-1] + Count2 --> CountGT0{Count>0?} + CountGT0 -- No --> End2((2)) + CountGT0 -- Yes --> End3((3)) + Wait -- Error --> MAPU[MAP_U_ABORT_req] + MAPU --> End1((1)) + Wait --> End3 + End3 --> Restricted{Network node area restricted received OR Roaming Restriction due to Unsupported Feature?} + Restricted -- No --> End1 + Restricted -- Yes --> NotRestricted[MSC Area restricted:= Not restricted] + Restricted -- Yes --> RestrictedYes[MSC Area restricted:= Restricted] + NotRestricted --> MAPClose[MAP_CLOSE_req] + RestrictedYes --> MAPClose + MAPClose --> Repeat{Repeat update of VLR?} + Repeat -- No --> CrossedOut[✗] + Repeat -- Yes --> StartTimer[Start repetition timer] + StartTimer --> WaitTimer[Wait_For_Repetition_Timer_Expire] + WaitTimer --> TimerExpired[Repetition timer expired] + TimerExpired -- Internal --> End5((5)) + +``` + +Flowchart for process Insert\_Subs\_Data\_Stand\_Alone\_HLR. It starts at connector 2, goes to 'Wait\_For\_Insert\_Subs\_Data\_Cnf'. From there, four paths emerge: 'Replace\_Service' (Count:= Count-1, Set replacement service(s), connector 4), 'OK' (Count:= Count-1, Count>0? decision), 'Error' (MAP\_U\_ABORT\_req, connector 1), and a path to connector 3. From connector 3, it goes to a decision 'Network node area restricted received OR Roaming Restriction due to Unsupported Feature?'. 'No' leads to connector 1. 'Yes' leads to 'MSC Area restricted:= Not restricted' or 'MSC Area restricted:= Restricted', both leading to 'MAP\_CLOSE\_req'. From 'MAP\_CLOSE\_req', it goes to 'Repeat update of VLR?'. 'No' leads to a crossed-out path. 'Yes' leads to 'Start repetition timer', 'Wait\_For\_Repetition\_Timer\_Expire', 'Repetition timer expired' (Internal), and connector 5. + +5040 + +5041 + +**Figure 25.7/3 (sheet 2 of 2): Process Insert\_Subs\_Data\_Stand\_Alone\_HLR** + +![Flowchart for process Insert_GPRS_Subs_Data_Stand_Alone_HLR. The process starts at connector 5, opens a dialogue (MAP_OPEN_req, MAP_INSERT_SUBSCRIBER_DATA_req, MAP_DELIMITER_req), receives Open_Cnf, waits for Insert_GPRS_Subs_Data_Cnf, handles replacement services, checks if all data is inserted, sends Insert_Subs_Data_HLR, increments a counter, and checks if all data is inserted again. It ends at connectors 1, 2, 3, or 4 based on the outcome.](5250dd5a75788abbf98d300933b056ae_img.jpg) + +**process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR** **IGSD\_SA\_HLR1(2)** + +Process in the HLR to open a dialogue and transfer subscriber data to the SGSN + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + 5((5)) --> OpenReq{MAP_OPEN_req +MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req} + OpenReq --> ReceiveOpenCnf[Receive Open_Cnf] + ReceiveOpenCnf -- OK --> WaitForInsertGPRSSubsDataCnf[Wait_For Insert_GPRS_Subs_Data_Cnf] + WaitForInsertGPRSSubsDataCnf -- "Vr, Error" --> 1((1)) + WaitForInsertGPRSSubsDataCnf -- Abort --> 1 + WaitForInsertGPRSSubsDataCnf -- "Replace_Service" --> SetReplacement[Set replacement service(s)] + SetReplacement --> AllDataInserted1{All data inserted?} + AllDataInserted1 -- No --> Count0[Count:=0] + Count0 --> SendInsertSubsDataHLR[Send Insert_Subs_Data_HLR] + SendInsertSubsDataHLR --> CountPlus1[Count:= Count+1] + CountPlus1 --> AllDataInserted2{All data inserted?} + AllDataInserted2 -- No --> 4((4)) + AllDataInserted2 -- Yes --> 2((2)) + AllDataInserted1 -- Yes --> 3((3)) + SetReplacement -- "Error" --> MAPUAbortReq{MAP_U_ABORT_req} + MAPUAbortReq --> 1 + +``` + +Flowchart for process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR. The process starts at connector 5, opens a dialogue (MAP\_OPEN\_req, MAP\_INSERT\_SUBSCRIBER\_DATA\_req, MAP\_DELIMITER\_req), receives Open\_Cnf, waits for Insert\_GPRS\_Subs\_Data\_Cnf, handles replacement services, checks if all data is inserted, sends Insert\_Subs\_Data\_HLR, increments a counter, and checks if all data is inserted again. It ends at connectors 1, 2, 3, or 4 based on the outcome. + +5042 + +5043 + +**Figure 25.7/4 (sheet 1 of 2): Process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR** + +![Flowchart for process Insert_GPRS_Subs_Data_Stand_Alone_HLR. It starts at connector 2, goes to 'Wait_For_Insert_GPRS_Subs_Data_Cnf'. From there, four paths emerge: 'Replace_Service' leads to 'Count:= Count-1' then 'Set replacement service(s)' to connector 4; 'OK' leads to 'Count:= Count-1' then a decision 'Count>0?'. If 'Yes', it goes to connector 2; if 'No', it goes to connector 3. 'Error' leads to 'MAP_U_ABORT_req' then to connector 1. 'Abort' also leads to connector 1. From connector 3, it goes to a decision 'Network node area restricted received OR Roaming Restricted in SGSN due to Unsupported Feature?'. If 'Yes', it goes to 'SGSN Area restricted:= Restricted' then to 'MAP_CLOSE_req'. If 'No', it goes to 'SGSN Area restricted:= Not restricted' then to 'MAP_CLOSE_req'. From 'MAP_CLOSE_req', it goes to connector 1 and then to a decision 'Repeat update of SGSN?'. If 'Yes', it goes to 'Start repetition timer' then 'Wait_For_Repetition_Timer_Expire' (internal signal) then to connector 5. If 'No', the path ends with a cross symbol.](87a2e35a8ce420838d250c7a1ecef202_img.jpg) + +**process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR** **IGSD\_SA\_HLR2(2)** + +Process in the HLR to open a dialogue and transfer subscriber data to the SGSN + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + 2((2)) --> W[Wait_For_Insert_GPRS_Subs_Data_Cnf] + W -- Replace_Service --> C1[Count:= Count-1] + C1 --> S[Set replacement service(s)] + S --> 4((4)) + W -- OK --> C2[Count:= Count-1] + C2 --> D1{Count>0?} + D1 -- Yes --> 2 + D1 -- No --> 3((3)) + W -- Error --> MA[MAP_U_ABORT_req] + MA --> 1a((1)) + W -- Abort --> 1b((1)) + 3 --> D2{Network node area restricted received OR Roaming Restricted in SGSN due to Unsupported Feature?} + D2 -- Yes --> R[SGSN Area restricted:= Restricted] + D2 -- No --> NR[SGSN Area restricted:= Not restricted] + R --> MC[MAP_CLOSE_req] + NR --> MC + MC --> 1c((1)) + MC --> D3{Repeat update of SGSN?} + D3 -- Yes --> ST[Start repetition timer] + ST --> WRE[Wait_For_Repetition_Timer_Expire] + WRE -- Internal --> 5((5)) + D3 -- No --> X[ ] + style X fill:none,stroke:none + +``` + +Flowchart for process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR. It starts at connector 2, goes to 'Wait\_For\_Insert\_GPRS\_Subs\_Data\_Cnf'. From there, four paths emerge: 'Replace\_Service' leads to 'Count:= Count-1' then 'Set replacement service(s)' to connector 4; 'OK' leads to 'Count:= Count-1' then a decision 'Count>0?'. If 'Yes', it goes to connector 2; if 'No', it goes to connector 3. 'Error' leads to 'MAP\_U\_ABORT\_req' then to connector 1. 'Abort' also leads to connector 1. From connector 3, it goes to a decision 'Network node area restricted received OR Roaming Restricted in SGSN due to Unsupported Feature?'. If 'Yes', it goes to 'SGSN Area restricted:= Restricted' then to 'MAP\_CLOSE\_req'. If 'No', it goes to 'SGSN Area restricted:= Not restricted' then to 'MAP\_CLOSE\_req'. From 'MAP\_CLOSE\_req', it goes to connector 1 and then to a decision 'Repeat update of SGSN?'. If 'Yes', it goes to 'Start repetition timer' then 'Wait\_For\_Repetition\_Timer\_Expire' (internal signal) then to connector 5. If 'No', the path ends with a cross symbol. + +5044 + +5045 + +Figure 25.7/4 (sheet 2 of 2): Process Insert\_GPRS\_Subs\_Data\_Stand\_Alone\_HLR + +![State transition diagram for macro Wait_For_Insert_Subs_Data_Cnf. It starts with an initial state leading to 'Wait_For_ISD_Cnf'. From there, it branches into three main paths based on incoming signals: MAP_INSERT_SUBSCRIBER_DATA_cnf, a group of MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind, and MAP_NOTICE_ind. The first path leads to 'Check_Confirmation' and then to a decision diamond 'Service unsupported in VLR?'. The second path leads to an 'Abort' state. The third path leads to 'MAP_CLOSE_req' and then to a decision diamond 'Provider Error'. Both 'Service unsupported in VLR?' and 'Provider Error' lead to 'Ignore?' decision diamonds. If 'Yes' to 'Ignore?', it goes to 'OK'. If 'No', it goes to 'Replace service in VLR?' decision diamond. If 'Yes' to that, it goes to 'HLR internal action' and then to 'OK'. If 'No', it goes to 'Replace_Service' and then to an end state.](5041c81f4f739c03bbcdbdef8490c0aa_img.jpg) + +**macrodefinition Wait\_For\_Insert\_Subs\_Data\_Cnf** **WF\_ISD\_Cnf1(1)** + +Macro in the HLR to receive and process the MAP\_INSERT\_SUBSCRIBER\_DATA confirmation + +Signals to/from the left are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> Wait_For_ISD_Cnf + state "MAP_INSERT_SUBSCRIBER_DATA_cnf" as M1 + state "MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind" as M2 + state "MAP_NOTICE_ind" as M3 + Wait_For_ISD_Cnf --> M1 + Wait_For_ISD_Cnf --> M2 + Wait_For_ISD_Cnf --> M3 + M1 --> Check_Confirmation + Check_Confirmation --> Error + Check_Confirmation --> PE{Provider Error} + PE --> Abort + PE --> SE{Service unsupported in VLR?} + SE --> Yes1{Yes} + SE --> No1{No} + Yes1 --> Abort + No1 --> Ignore{Ignore?} + Ignore --> Yes2{Yes} + Ignore --> No2{No} + Yes2 --> OK + No2 --> RS{Replace service in VLR?} + RS --> Yes3{Yes} + RS --> No3{No} + Yes3 --> HLR_action[HLR internal action] + HLR_action --> OK + No3 --> Replace_Service + Replace_Service --> [*] + +``` + +State transition diagram for macro Wait\_For\_Insert\_Subs\_Data\_Cnf. It starts with an initial state leading to 'Wait\_For\_ISD\_Cnf'. From there, it branches into three main paths based on incoming signals: MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf, a group of MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind, and MAP\_NOTICE\_ind. The first path leads to 'Check\_Confirmation' and then to a decision diamond 'Service unsupported in VLR?'. The second path leads to an 'Abort' state. The third path leads to 'MAP\_CLOSE\_req' and then to a decision diamond 'Provider Error'. Both 'Service unsupported in VLR?' and 'Provider Error' lead to 'Ignore?' decision diamonds. If 'Yes' to 'Ignore?', it goes to 'OK'. If 'No', it goes to 'Replace service in VLR?' decision diamond. If 'Yes' to that, it goes to 'HLR internal action' and then to 'OK'. If 'No', it goes to 'Replace\_Service' and then to an end state. + +5046 + +5047 + +**Figure 25.7/5: Macro Wait\_for\_Insert\_Subs\_Data\_Cnf** + +![Flowchart for macrodefinition Wait_For_Insert_GPRS_Subs_Data_Cnf. It starts with an entry point leading to 'Wait_For_IGSD_Cnf'. From there, it branches into three main paths: 1) MAP_INSERT_SUBSCRIBER_DATA_cnf leads to 'Check_Confirmation', which then leads to a decision diamond. 2) A middle path with MAP_U_ABORT_ind, MAP_P_ABORT_ind, and MAP_CLOSE_ind leads to an 'Abort' terminal. 3) MAP_NOTICE_ind leads to MAP_CLOSE_req, which also leads to the decision diamond. The decision diamond has three outcomes: 'User Error, Data Error' leading to 'Error'; 'OK' leading to 'Service unsupported in SGSN?'; and 'Provider Error' leading to 'Abort'. 'Service unsupported in SGSN?' has 'Yes' leading to 'Abort' and 'No' leading to 'Ignore?'. 'Ignore?' has 'Yes' leading to 'OK' and 'No' leading to 'Replace service in SGSN?'. 'Replace service in SGSN?' has 'Yes' leading to 'Replace_Service' and 'No' leading to 'HLR internal action', which then leads to 'OK'.](b8e2571e058a2b0768d3d365d7061b67_img.jpg) + +macrodefinition **Wait\_For\_Insert\_GPRS\_Subs\_Data\_Cnf** WF\_IGSD\_Cnf1(1) + +Macro in the HLR to receive and process the MAP\_INSERT\_SUBSCRIBER\_DATA confirmation + +Signals to/from the left are to/from the SGSN + +``` + + graph TD + Entry([ ]) --> Wait_For_IGSD_Cnf[Wait_For_IGSD_Cnf] + Wait_For_IGSD_Cnf --> Branch(( )) + + Branch --> MAP_INSERT_SUBSCRIBER_DATA_cnf[MAP_INSERT_SUBSCRIBER_DATA_cnf] + MAP_INSERT_SUBSCRIBER_DATA_cnf --> Check_Confirmation[Check_Confirmation] + + Branch --> MiddlePath[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + + Branch --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_NOTICE_ind --> MAP_CLOSE_req[MAP_CLOSE_req] + + Check_Confirmation --> Decision{ } + + MiddlePath --> Abort([Abort]) + + MAP_CLOSE_req --> Decision + + Decision -- "User Error, Data Error" --> Error([Error]) + + Decision -- "OK" --> ServiceUnsupported{Service unsupported in SGSN?} + + Decision -- "Provider Error" --> Abort + + ServiceUnsupported -- Yes --> Abort + ServiceUnsupported -- No --> Ignore{Ignore?} + + Ignore -- Yes --> OK([OK]) + Ignore -- No --> ReplaceService{Replace service in SGSN?} + + ReplaceService -- Yes --> Replace_Service[Replace_Service] + + ReplaceService -- No --> HLRInternalAction[HLR internal action] + + HLRInternalAction --> OK + +``` + +Flowchart for macrodefinition Wait\_For\_Insert\_GPRS\_Subs\_Data\_Cnf. It starts with an entry point leading to 'Wait\_For\_IGSD\_Cnf'. From there, it branches into three main paths: 1) MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf leads to 'Check\_Confirmation', which then leads to a decision diamond. 2) A middle path with MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, and MAP\_CLOSE\_ind leads to an 'Abort' terminal. 3) MAP\_NOTICE\_ind leads to MAP\_CLOSE\_req, which also leads to the decision diamond. The decision diamond has three outcomes: 'User Error, Data Error' leading to 'Error'; 'OK' leading to 'Service unsupported in SGSN?'; and 'Provider Error' leading to 'Abort'. 'Service unsupported in SGSN?' has 'Yes' leading to 'Abort' and 'No' leading to 'Ignore?'. 'Ignore?' has 'Yes' leading to 'OK' and 'No' leading to 'Replace service in SGSN?'. 'Replace service in SGSN?' has 'Yes' leading to 'Replace\_Service' and 'No' leading to 'HLR internal action', which then leads to 'OK'. + +5048 + +5049 + +**Figure 25.7/6: Macro Wait\_for\_Insert\_GPRS\_Subs\_Data\_Cnf** + +![UML process diagram for Send_Insert_Subs_Data_HLR. The diagram shows a process box with a title 'Send_Insert_Subs_Data_HLR' and a sub-label 'Send_ISD_HLR1(1)'. Inside the box, there are three callouts: a top-left note stating 'Process in the HLR to send a MAP_INSERT_SUBSCRIBER_DATA request, independently of the invoking process'; a top-right note stating 'Signals to/from the left are to/from the VLR or SGSN'; and a central message box containing 'MAP_INSERT_SUBSCRIBER_DATA_req' and 'MAP_DELIMITER_req'. A vertical lifeline passes through the center, starting with an oval at the top, followed by a left-pointing arrowhead, and ending with an 'X' at the bottom.](48d327b5c662916972f82213c8f25a4a_img.jpg) + +process Send\_Insert\_Subs\_Data\_HLR + +Send\_ISD\_HLR1(1) + +Process in the HLR to send a MAP\_INSERT\_SUBSCRIBER\_DATA request, independently of the invoking process + +Signals to/from the left are to/from the VLR or SGSN + +MAP\_INSERT\_SUBSCRIBER\_DATA\_req +MAP\_DELIMITER\_req + +UML process diagram for Send\_Insert\_Subs\_Data\_HLR. The diagram shows a process box with a title 'Send\_Insert\_Subs\_Data\_HLR' and a sub-label 'Send\_ISD\_HLR1(1)'. Inside the box, there are three callouts: a top-left note stating 'Process in the HLR to send a MAP\_INSERT\_SUBSCRIBER\_DATA request, independently of the invoking process'; a top-right note stating 'Signals to/from the left are to/from the VLR or SGSN'; and a central message box containing 'MAP\_INSERT\_SUBSCRIBER\_DATA\_req' and 'MAP\_DELIMITER\_req'. A vertical lifeline passes through the center, starting with an oval at the top, followed by a left-pointing arrowhead, and ending with an 'X' at the bottom. + +5050 + +5051 + +**Figure 25.7/7: Process Send\_Insert\_Subs\_Data\_HLR** + +![Flowchart for process Insert_VCSG_Subs_Data_Stand_Alone_CSS. It starts at connector 5, sends MAP requests, receives a confirmation, waits, and then attempts to insert subscriber data. It includes decision points for 'All data inserted?' and handles errors and service replacements.](468660ac6a78a5225a9ed117dea1185b_img.jpg) + +process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS + +IVSD\_SA\_CSS1(2) + +Process in the CSS to open a dialogue and transfer CSG subscriber data to the VLR or the SGSN + +Signals to/from the left are to/from the VLR or the SGSN + +``` + +graph TD + 5((5)) --> Start([Start]) + Start --> SendReq[MAP_OPEN_req +MAP_INSERT_SUBSCRIBER_DATA_req +MAP_DELIMITER_req] + SendReq --> RecvCnf[Receive_Open_Cnf] + RecvCnf -- OK --> Wait[Wait_For_Insert_VCSG_Subs_Data_Cnf] + RecvCnf -- Vr, Error --> Abort[Abort] + Wait --> Decision1{All data inserted?} + Decision1 -- OK --> SetService[Set replacement service(s)] + SetService --> SendInsert[Send_Insert_VCSG_Subs_Data_CSS] + Decision1 -- Error --> MAPUAbort[MAP_U_ABORT_req] + MAPUAbort --> 1((1)) + SendInsert --> Count0[Count:=0] + Count0 --> Decision2{All data inserted?} + Decision2 -- No --> CountInc[Count:=Count+1] + CountInc --> Decision2 + Decision2 -- Yes --> 2((2)) + Decision2 -- No --> 4((4)) + Decision1 -- Yes --> 3((3)) + +``` + +Flowchart for process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS. It starts at connector 5, sends MAP requests, receives a confirmation, waits, and then attempts to insert subscriber data. It includes decision points for 'All data inserted?' and handles errors and service replacements. + +5052 + +5053 + +Figure 25.7/8 (sheet 1 of 2): Process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS + +5054 + +![Flowchart for process Insert_VCSG_Subs_Data_Stand_Alone_CSS. It starts at connector 2, goes to Wait_For_Insert_VCSG_Subs_Data_Cnf. From there, four paths emerge: Replace_Service (Count:=Count-1, Set replacement service(s), connector 4), OK (Count:=Count-1, Count>0? Yes to connector 2, No to connector 3), Error (MAP_U_ABORT_req, connector 1), and Abort (connector 1). From connector 3, it goes to MAP_CLOSE_req (connector 1), then Repeat update of VLR or SGSN? Yes/No. Yes leads to Start repetition timer, Wait_For_Repetition_Timer_Expiry, Repetition timer expired (Internal), connector 5. No leads to a crossed-out path.](b1d18f77df1ab590375a74069612121a_img.jpg) + +**process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS** IVSD\_SA\_CSS2(2) + +Process in the CSS to open a dialogue and transfer CSG subscriber data to the VLR or the SGSN + +Signals to/from the left are to/from the VLR or the SGSN + +``` +graph TD + C2((2)) --> W[Wait_For_Insert_VCSG_Subs_Data_Cnf] + W -- Replace_Service --> C1[Count:=Count-1] + C1 --> S[Set replacement service(s)] + S --> C4((4)) + W -- OK --> C2_2[Count:=Count-1] + C2_2 --> D{Count>0?} + D -- Yes --> C2_3((2)) + D -- No --> C3((3)) + W -- Error --> E{MAP_U_ABORT_req} + E --> C1_1((1)) + W -- Abort --> C1_2((1)) + C3 --> M{MAP_CLOSE_req} + M --> C1_3((1)) + M --> R{Repeat update of VLR or SGSN?} + R -- Yes --> SRT[Start repetition timer] + SRT --> WRT[Wait_For_Repetition_Timer_Expiry] + WRT --> RTE{Repetition timer expired} + RTE -.-> I[Internal] + RTE --> C5((5)) + R -- No --> X[ ] + style X fill:none,stroke:none +``` + +Flowchart for process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS. It starts at connector 2, goes to Wait\_For\_Insert\_VCSG\_Subs\_Data\_Cnf. From there, four paths emerge: Replace\_Service (Count:=Count-1, Set replacement service(s), connector 4), OK (Count:=Count-1, Count>0? Yes to connector 2, No to connector 3), Error (MAP\_U\_ABORT\_req, connector 1), and Abort (connector 1). From connector 3, it goes to MAP\_CLOSE\_req (connector 1), then Repeat update of VLR or SGSN? Yes/No. Yes leads to Start repetition timer, Wait\_For\_Repetition\_Timer\_Expiry, Repetition timer expired (Internal), connector 5. No leads to a crossed-out path. + +5055 + +5056 + +**Figure 25.7/8 (sheet 2 of 2): Process Insert\_VCSG\_Subs\_Data\_Stand\_Alone\_CSS** + +![Flowchart for macro Wait_For_Insert_VCSG_Subs_Data_Cnf. It starts with an entry point leading to 'Wait_For_IVSD_Cnf'. From there, it branches into 'MAP_INSERT_SUBSCRIBER_DATA_cnf' (which leads to 'Check_Confirmation'), 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind', and 'MAP_NOTICE_ind' (which leads to 'MAP_CLOSE_req'). 'Check_Confirmation' leads to a decision diamond 'Service unsupported in VLR or SGSN?'. If 'User Error, Data Error', it goes to 'Error'. If 'OK', it goes to 'OK'. If 'Yes', it goes to 'Ignore?'. If 'No', it goes to 'Replace service in VLR or SGSN?'. If 'Yes', it goes to 'Replace_Service'. If 'No', it goes to 'CSS internal action'. 'Abort' is also shown as a possible outcome.](21bbf996a829bb6fae2b51ba92676ce3_img.jpg) + +macrodefinition Wait\_For\_Insert\_VCSG\_Subs\_Data\_Cnf + +WF\_IVSD\_Cnf1(1) + +Macro in the CSS to receive and process the MAP\_INSERT\_SUBSCRIBER\_DATA confirmation + +Signals to/from the left are to/from the VLR or the SGSN + +``` + +graph TD + Entry(( )) --> WF_IVSD_Cnf[Wait_For_IVSD_Cnf] + WF_IVSD_Cnf --> MAP_INSERT_SUBSCRIBER_DATA_cnf[MAP_INSERT_SUBSCRIBER_DATA_cnf] + WF_IVSD_Cnf --> MAP_U_ABORT_ind[MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind] + WF_IVSD_Cnf --> MAP_NOTICE_ind[MAP_NOTICE_ind] + MAP_INSERT_SUBSCRIBER_DATA_cnf --> Check_Confirmation[Check_Confirmation] + MAP_NOTICE_ind --> MAP_CLOSE_req{MAP_CLOSE_req} + Check_Confirmation --> ServiceUnsupported{Service unsupported in VLR or SGSN?} + ServiceUnsupported -- User Error, Data Error --> Error((Error)) + ServiceUnsupported -- OK --> OK((OK)) + ServiceUnsupported -- Yes --> Ignore{Ignore?} + ServiceUnsupported -- No --> ReplaceService{Replace service in VLR or SGSN?} + Ignore -- Yes --> OK + Ignore -- No --> ReplaceService + ReplaceService -- Yes --> Replace_Service[Replace_Service] + ReplaceService -- No --> CSSInternalAction[CSS internal action] + CSSInternalAction --> OK + MAP_CLOSE_req -- Provider Error --> Abort((Abort)) + +``` + +Flowchart for macro Wait\_For\_Insert\_VCSG\_Subs\_Data\_Cnf. It starts with an entry point leading to 'Wait\_For\_IVSD\_Cnf'. From there, it branches into 'MAP\_INSERT\_SUBSCRIBER\_DATA\_cnf' (which leads to 'Check\_Confirmation'), 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind', and 'MAP\_NOTICE\_ind' (which leads to 'MAP\_CLOSE\_req'). 'Check\_Confirmation' leads to a decision diamond 'Service unsupported in VLR or SGSN?'. If 'User Error, Data Error', it goes to 'Error'. If 'OK', it goes to 'OK'. If 'Yes', it goes to 'Ignore?'. If 'No', it goes to 'Replace service in VLR or SGSN?'. If 'Yes', it goes to 'Replace\_Service'. If 'No', it goes to 'CSS internal action'. 'Abort' is also shown as a possible outcome. + +5057 + +5058 + +Figure 25.7/9: Macro Wait\_for\_Insert\_VCSG\_Subs\_Data\_Cnf + +![UML sequence diagram for process Send_Insert_VCSG_Subs_Data_CSS. The diagram shows a self-call on a lifeline. A note on the left indicates this is a process in the CSS to send a MAP_INSERT_SUBSCRIBER_DATA request. A note on the right indicates signals to/from the left are to/from the VLR or SGSN. The message box contains MAP_INSERT_SUBSCRIBER_DATA_req and MAP_DELIMITER_req. The sequence ends with a destroy marker (X).](ffa32b60aa9e81d116b1baf01de955c0_img.jpg) + +process Send\_Insert\_VCSG\_Subs\_Data\_CSS + +Send\_IVSD\_CSS1(1) + +Process in the CSS to send a +MAP\_INSERT\_SUBSCRIBER\_DATA +request, independently of the +invoking process + +Signals to/from the left +are to/from the VLR or SGSN + +MAP\_INSERT\_SUBSCRIBER\_DATA\_req +MAP\_DELIMITER\_req + +UML sequence diagram for process Send\_Insert\_VCSG\_Subs\_Data\_CSS. The diagram shows a self-call on a lifeline. A note on the left indicates this is a process in the CSS to send a MAP\_INSERT\_SUBSCRIBER\_DATA request. A note on the right indicates signals to/from the left are to/from the VLR or SGSN. The message box contains MAP\_INSERT\_SUBSCRIBER\_DATA\_req and MAP\_DELIMITER\_req. The sequence ends with a destroy marker (X). + +5059 + +5060 + +**Figure 25.7/10: Process Send\_Insert\_VCSG\_Subs\_Data\_CSS** + +## 5061 25.8 Request IMSI Macros + +### 5062 25.8.1 Macro Obtain\_IMSI\_MSC + +5063 This macro describes the handling of the request received from the VLR to provide the IMSI of a subscriber (e.g. at +5064 Location Updating). + +### 5065 25.8.2 Macro Obtain\_IMSI\_VLR + +5066 This macro describes the way VLR requests the MSC the IMSI of a subscriber (e.g. at Location Updating). + +![State transition diagram for Obtain_IMSI_MSC macro. It starts with an initial state, followed by a MAP_PROVIDE_IMSI_ind signal. Then an A_IDENTITY_REQUEST_req is sent to the MS (Requested identity=IMSI). The system then enters a Wait_For_IMSI state. From there, three paths are possible: 1) A_IDENTITY_RESPONSE_ind received, leading to Set IMSI and then a MAP_PROVIDE_IMSI_rsp / MAP_DELIMITER_req signal to the VLR, ending in an OK state. 2) A_CM_RELEASE_ind received, leading to Set User Error: Absent Subscriber and then to the final signal. 3) An error condition (MAP_U_ABORT_ind, MAP_CLOSE_ind) leading to an Error state.](4f1c88f2ca77ac1678f0321255d8e016_img.jpg) + +**macrodefinition Obtain\_IMSI\_MSC** **Obt\_IMSI\_MSC1(1)** + +Macro in the MSC to retrieve the IMSI from the MS and return it to the VLR + +Signals to/from the left are to/from the MS; + signals to/from the right are to/from the VLR + +``` + +stateDiagram-v2 + [*] --> State1 + State1 --> State2: MAP_PROVIDE_IMSI_ind + State2 --> State3: A_IDENTITY_REQUEST_req (Requested identity=IMSI) + State3 --> State4: Wait_For_IMSI + State4 --> State5: A_IDENTITY_RESPONSE_ind + State4 --> State6: A_CM_RELEASE_ind + State4 --> State7: MAP_U_ABORT_ind, MAP_CLOSE_ind + State5 --> State8: Set IMSI + State6 --> State9: Set User Error: Absent Subscriber + State8 --> State10: MAP_PROVIDE_IMSI_rsp, MAP_DELIMITER_req + State9 --> State10 + State10 --> [*]: OK + State7 --> [*]: Error + +``` + +State transition diagram for Obtain\_IMSI\_MSC macro. It starts with an initial state, followed by a MAP\_PROVIDE\_IMSI\_ind signal. Then an A\_IDENTITY\_REQUEST\_req is sent to the MS (Requested identity=IMSI). The system then enters a Wait\_For\_IMSI state. From there, three paths are possible: 1) A\_IDENTITY\_RESPONSE\_ind received, leading to Set IMSI and then a MAP\_PROVIDE\_IMSI\_rsp / MAP\_DELIMITER\_req signal to the VLR, ending in an OK state. 2) A\_CM\_RELEASE\_ind received, leading to Set User Error: Absent Subscriber and then to the final signal. 3) An error condition (MAP\_U\_ABORT\_ind, MAP\_CLOSE\_ind) leading to an Error state. + +5067 + +5068 + +Figure 25.8/1: Macro Obtain\_IMSI\_MSC + +![State transition diagram for macro Obtain_IMSI_VLR. The process starts at an initial state, moves to a state where MAP_PROVIDE_IMSI_req and MAP_DELIMITER_req are sent. It then enters a Wait_For_IMSI state. From there, it can receive a MAP_PROVIDE_IMSI_cnf (leading to Check_Confirmation) or a MAP_U_ABORT_ind/MAP_CLOSE_ind (leading to an Aborted state). Check_Confirmation leads to either an OK state, an Error state (due to Provider Error), or an Aborted state (due to User Error or Data Error).](52ef9b2a0200e552b01e12640fe77c22_img.jpg) + +macrodefinition Obtain\_IMSI\_VLR + +Obt\_IMSI\_VLR1(1) + +Macro in the VLR to instruct the MSC to obtain the IMSI of the MS and handle the report of the result + +Signals to/from the left are to/from the MSC + +``` + +stateDiagram-v2 + [*] --> State1 + State1 --> State2 : MAP_PROVIDE_IMSI_req, MAP_DELIMITER_req + State2 --> State3 : Wait_For_IMSI + State3 --> State4 : MAP_PROVIDE_IMSI_cnf + State3 --> State5 : MAP_U_ABORT_ind, MAP_CLOSE_ind + State4 --> State6 : OK + State4 --> State7 : Provider Error + State4 --> State8 : User Error, Data Error + State5 --> State9 : Aborted + State6 --> [*] : OK + State7 --> [*] : Error + State8 --> [*] : Aborted + +``` + +State transition diagram for macro Obtain\_IMSI\_VLR. The process starts at an initial state, moves to a state where MAP\_PROVIDE\_IMSI\_req and MAP\_DELIMITER\_req are sent. It then enters a Wait\_For\_IMSI state. From there, it can receive a MAP\_PROVIDE\_IMSI\_cnf (leading to Check\_Confirmation) or a MAP\_U\_ABORT\_ind/MAP\_CLOSE\_ind (leading to an Aborted state). Check\_Confirmation leads to either an OK state, an Error state (due to Provider Error), or an Aborted state (due to User Error or Data Error). + +5069 + +5070 + +Figure 25.8/2: Macro Obtain\_IMSI\_VLR + +## 5071 25.9 Tracing macros + +### 5072 25.9.1 Macro Trace\_Subscriber\_Activity\_MSC + +5073 This macro shows the handling in the MSC for a request from the VLR to trace the activity of a subscriber. + +### 5074 25.9.2 Macro Trace\_Subscriber\_Activity\_VLR + +5075 This macro is called during the handling of subscriber activity in the VLR to activate tracing if necessary. + +### 5076 25.9.3 Macro Trace\_Subscriber\_Activity\_SGSN + +5077 This macro is called during the handling of subscriber activity in the SGSN to activate tracing if necessary. + +### 5078 25.9.4 Macro Activate\_Tracing\_VLR + +5079 This macro shows the handling in the VLR for a request from the HLR to activate tracing for a subscriber. + +### 5080 25.9.5 Macro Activate\_Tracing\_SGSN + +5081 This macro shows the handling in the SGSN for a request from the HLR to activate tracing for a subscriber. + +### 5082 25.9.6 Macro Control\_Tracing\_With\_VLR\_HLR + +5083 This macro shows the handling in the HLR to activate tracing in the VLR if it is required during a dialogue between the +5084 VLR and the HLR + +### 5085 25.9.7 Macro Control\_Tracing\_With\_SGSN\_HLR + +5086 This macro shows the handling in the HLR to activate tracing in the SGSN if it is required during a dialogue between +5087 the SGSN and the HLR + +![Sequence diagram for Trace_Subscriber_Activity_MSC macro. The diagram shows a vertical flow: a start node (oval), a merge node (chevron), a message box 'MAP_TRACE_SUBSCRIBER_ACTIVITY_ind', a 'Check_Indication' box, a 'Start Activity Tracing' box, and an end node (oval). There are 'OK' and 'Error' labels near the 'Start Activity Tracing' box. Callouts explain the symbols: 'Macro in the MSC to mark the subscriber for tracing' for the start node and 'Signals to/from the right are to/from the VLR' for the message box.](52340e7ce9cd96eda56e52e3f4b52960_img.jpg) + +macrodefinition Trace\_Subscriber\_Activity\_MSC + +Tr\_Sub\_Act\_MSC1(1) + +``` + +sequenceDiagram + participant VLR + Note left of VLR: Macro in the MSC to mark the subscriber for tracing + Note right of VLR: Signals to/from the right are to/from the VLR + VLR->>VLR: MAP_TRACE_SUBSCRIBER_ACTIVITY_ind + Note right of VLR: Check_Indication + Note right of VLR: Start Activity Tracing + Note right of VLR: OK + Note right of VLR: Error + +``` + +Sequence diagram for Trace\_Subscriber\_Activity\_MSC macro. The diagram shows a vertical flow: a start node (oval), a merge node (chevron), a message box 'MAP\_TRACE\_SUBSCRIBER\_ACTIVITY\_ind', a 'Check\_Indication' box, a 'Start Activity Tracing' box, and an end node (oval). There are 'OK' and 'Error' labels near the 'Start Activity Tracing' box. Callouts explain the symbols: 'Macro in the MSC to mark the subscriber for tracing' for the start node and 'Signals to/from the right are to/from the VLR' for the message box. + +5088 + +5089 + +Figure 25.9/1: Macro Trace\_Subscriber\_Activity\_MSC + +![Flowchart for Trace_Subscriber_Activity_VLR macro. It starts with a connector, goes to a decision diamond. If 'False', it ends at another connector. If 'True', it goes to a process box 'Subscriber tracing active', then to a merge connector, then to a process box 'MAP_TRACE_SUBSCRIBER_ACTIVITY_req', and finally to an end connector.](d21c4750abaf6590d9c5b77c6c1ca5af_img.jpg) + +macrodefinition Trace\_Subscriber\_Activity\_VLR + +Tr\_Sub\_Act\_VLR1(1) + +Macro in the VLR to start tracing in the MSC if required + +Signals to/from the left are to/from the MSC + +``` + +graph TD + Start([ ]) --> Decision{ } + Decision -- False --> End([ ]) + Decision -- True --> Process1[Subscriber tracing active] + Process1 --> Merge{ } + Merge --> Process2[MAP_TRACE_SUBSCRIBER_ACTIVITY_req] + Process2 --> End2([ ]) + +``` + +Flowchart for Trace\_Subscriber\_Activity\_VLR macro. It starts with a connector, goes to a decision diamond. If 'False', it ends at another connector. If 'True', it goes to a process box 'Subscriber tracing active', then to a merge connector, then to a process box 'MAP\_TRACE\_SUBSCRIBER\_ACTIVITY\_req', and finally to an end connector. + +5090 + +5091 + +Figure 25.9/2: Macro Trace\_Subscriber\_Activity\_VLR + +macrodefinition Trace\_Subscriber\_Activity\_SGSN + +Tr\_Sub\_Act\_SGSN1(1) + +Macro in the SGSN to start tracing if required + +![Flowchart for Trace_Subscriber_Activity_SGSN macro. It starts with an oval connector, leading to a decision diamond. The 'False' path bypasses a 'Start activity tracing' rectangle. The 'True' path goes through the rectangle and then to a final oval connector. A note 'Subscriber tracing active' is next to the 'True' path.](cd9412899b63b30e0c547d79f35a48c1_img.jpg) + +``` +graph TD; Start([ ]) --> Decision{ }; Decision -- False --> End([ ]); Decision -- True --> Note[Subscriber tracing active]; Decision -- True --> Activity[Start activity tracing]; Activity --> End; +``` + +Flowchart for Trace\_Subscriber\_Activity\_SGSN macro. It starts with an oval connector, leading to a decision diamond. The 'False' path bypasses a 'Start activity tracing' rectangle. The 'True' path goes through the rectangle and then to a final oval connector. A note 'Subscriber tracing active' is next to the 'True' path. + +5092 + +5093 + +Figure 25.9/3: Macro Trace\_Subscriber\_Activity\_SGSN + +macrodefinition Activate\_Tracing\_VLR + +Act\_Tr\_VLR1(1) + +Macro in the VLR to handle a request from the HLR to activate tracing + +Signals to/from the right are to/from the HLR + +![Flowchart for Activate_Tracing_VLR macro. It starts with an entry point, receives MAP_ACTIVATE_TRACE_MODE_ind, checks indication, then checks if subscriber is known. If not known, it sets an error for unidentified subscriber. If known, it checks if tracing is supported. If not supported, it sets an error for facility not supported. If supported, it checks if tracing buffer is full. If full, it sets an error for buffer full. If not full, it sets subscriber tracing active to true. All error paths and the success path lead to a common exit point where MAP_ACTIVATE_TRACE_MODE_rsp and MAP_DELIMITER_req are sent.](25bc80f6f672ad2534ff1e7eae570971_img.jpg) + +``` + +graph TD + Entry([ ]) --> In{ } + In -- "MAP_ACTIVATE_TRACE_MODE_ind" --> In + In --> Check[Check_Indication] + Check --> OK[OK] + OK --> Sub{Subscriber known?} + Sub -- No --> Err1[Set User Error: Unidentified subscriber] + Sub -- Yes --> TracSup{Tracing supported?} + TracSup -- No --> Err2[Set User Error: Facility not supported] + TracSup -- Yes --> TracBuf{Tracing buffer full?} + TracBuf -- Yes --> Err3[Set User Error: Tracing buffer full] + TracBuf -- No --> Success[Subscriber tracing active:= True] + Err1 --> ErrorLine(( )) + Err2 --> ErrorLine + Err3 --> ErrorLine + Success --> ErrorLine + ErrorLine --> Out{ } + Out -- "MAP_ACTIVATE_TRACE_MODE_rsp +MAP_DELIMITER_req" --> Out + Out --> Exit([ ]) + +``` + +Flowchart for Activate\_Tracing\_VLR macro. It starts with an entry point, receives MAP\_ACTIVATE\_TRACE\_MODE\_ind, checks indication, then checks if subscriber is known. If not known, it sets an error for unidentified subscriber. If known, it checks if tracing is supported. If not supported, it sets an error for facility not supported. If supported, it checks if tracing buffer is full. If full, it sets an error for buffer full. If not full, it sets subscriber tracing active to true. All error paths and the success path lead to a common exit point where MAP\_ACTIVATE\_TRACE\_MODE\_rsp and MAP\_DELIMITER\_req are sent. + +5094 + +5095 + +Figure 25.9/4: Macro Activate\_Tracing\_VLR + +![Flowchart for Activate_Tracing_SGSN macro. It starts with an entry point, receives a MAP_ACTIVATE_TRACE_MODE_ind signal, checks an indication, then checks if the subscriber is known. If not known, it sets an 'Unidentified subscriber' error. If known, it checks if tracing is supported. If not supported, it sets a 'Facility not supported' error. If supported, it checks if the tracing buffer is full. If full, it sets a 'Tracing buffer full' error. If not full, it sets 'Subscriber tracing active := True'. All error paths lead to a common exit point. The successful path leads to a merge point where MAP_ACTIVATE_TRACE_MODE_rsp and MAP_DELIMITER_req signals are sent, followed by an exit point.](2fdab9416c9f7b5b14ff97505c4b32c0_img.jpg) + +macrodefinition **Activate\_Tracing\_SGSN** + +**Act\_Tr\_SGSN1(1)** + +Macro in the SGSN to handle a request from the HLR to activate tracing + +Signals to/from the right are to/from the HLR + +``` + + graph TD + Entry([ ]) --> In{ } + In -- "MAP_ACTIVATE_TRACE_MODE_ind" --> In + In --> Check[Check_Indication] + Check -- OK --> Sub{Subscriber known?} + Sub -- No --> Err1[Set User Error: Unidentified subscriber] + Sub -- Yes --> Trac{Tracing supported?} + Trac -- No --> Err4[Set User Error: Facility not supported] + Trac -- Yes --> Buf{Tracing buffer full?} + Buf -- Yes --> Err3[Set User Error: Tracing buffer full] + Buf -- No --> Succ[Subscriber tracing active := True] + Err1 --> Merge(( )) + Succ --> Merge + Err3 --> Merge + Err4 --> Merge + Merge --> Out{ } + Out -- "MAP_ACTIVATE_TRACE_MODE_rsp +MAP_DELIMITER_req" --> Out + Out --> Exit([ ]) + +``` + +Flowchart for Activate\_Tracing\_SGSN macro. It starts with an entry point, receives a MAP\_ACTIVATE\_TRACE\_MODE\_ind signal, checks an indication, then checks if the subscriber is known. If not known, it sets an 'Unidentified subscriber' error. If known, it checks if tracing is supported. If not supported, it sets a 'Facility not supported' error. If supported, it checks if the tracing buffer is full. If full, it sets a 'Tracing buffer full' error. If not full, it sets 'Subscriber tracing active := True'. All error paths lead to a common exit point. The successful path leads to a merge point where MAP\_ACTIVATE\_TRACE\_MODE\_rsp and MAP\_DELIMITER\_req signals are sent, followed by an exit point. + +5096 + +5097 + +**Figure 25.9/5: Macro Activate\_Tracing\_SGSN** + +![Flowchart for macrodefinition Control_Tracing_With_VLR_HLR. The process starts with a decision 'Subscriber tracing active in HLR'. If False, it proceeds to an 'OK' connector. If True, it proceeds to a decision 'Subscriber tracing active in VLR'. If False, it proceeds to a decision 'Subscriber in HPLMN area?'. If No, it proceeds to an 'OK' connector. If Yes, it sends 'MAP_ACTIVATE_TRACE_MODE_req' and 'MAP_DELIMITER_req' to the VLR, then enters 'Wait_For_ATM_Result'. From 'Wait_For_ATM_Result', it branches into three paths: 1) 'MAP_ACTIVATE_TRACE_MODE_cnf' leads to 'Check Confirmation', which then branches into 'OK' (Subscriber tracing active in VLR:= True), 'User Error, Data Error' (Subscriber tracing active in VLR:= False), and 'Provider Error' (Subscriber tracing active in VLR:= False). 2) 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req', which then leads to an 'Error' connector. 3) 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' leads to an 'Error' connector.](cc82244f939e49d9220051a01bbdfa4a_img.jpg) + +macrodefinition Control\_Tracing\_With\_VLR\_HLR + +Ctrl\_Tr\_VLR\_HLR1(1) + +Macro in the HLR to activate tracing in the VLR + +Signals to/from the left are to/from the VLR + +``` + +graph TD + Start([Start]) --> D1{Subscriber tracing active in HLR} + D1 -- False --> OK1((OK)) + D1 -- True --> D2{Subscriber tracing active in VLR} + D2 -- True --> D3{Subscriber in HPLMN area?} + D2 -- False --> D3 + D3 -- No --> OK1 + D3 -- Yes --> Req1[MAP_ACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req] + Req1 --> Wait[Wait_For_ATM_Result] + Wait --> Cnf1[MAP_ACTIVATE_TRACE_MODE_cnf] + Wait --> Ind1[MAP_NOTICE_ind] + Wait --> Ind2[MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind] + Cnf1 --> Check[Check Confirmation] + Check -- OK --> True1[Subscriber tracing active in VLR:= True] + Check -- "User Error, Data Error" --> False1[Subscriber tracing active in VLR:= False] + Check -- "Provider Error" --> False2[Subscriber tracing active in VLR:= False] + True1 --> OK2((OK)) + False1 --> OK2 + False2 --> Error1((Error)) + Ind1 --> Req2[MAP_CLOSE_req] + Req2 --> Error2((Error)) + Ind2 --> Error3((Error)) + +``` + +Flowchart for macrodefinition Control\_Tracing\_With\_VLR\_HLR. The process starts with a decision 'Subscriber tracing active in HLR'. If False, it proceeds to an 'OK' connector. If True, it proceeds to a decision 'Subscriber tracing active in VLR'. If False, it proceeds to a decision 'Subscriber in HPLMN area?'. If No, it proceeds to an 'OK' connector. If Yes, it sends 'MAP\_ACTIVATE\_TRACE\_MODE\_req' and 'MAP\_DELIMITER\_req' to the VLR, then enters 'Wait\_For\_ATM\_Result'. From 'Wait\_For\_ATM\_Result', it branches into three paths: 1) 'MAP\_ACTIVATE\_TRACE\_MODE\_cnf' leads to 'Check Confirmation', which then branches into 'OK' (Subscriber tracing active in VLR:= True), 'User Error, Data Error' (Subscriber tracing active in VLR:= False), and 'Provider Error' (Subscriber tracing active in VLR:= False). 2) 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req', which then leads to an 'Error' connector. 3) 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' leads to an 'Error' connector. + +5098 + +5099 + +Figure 25.9/6: Macro Control\_Tracing\_With\_VLR\_HLR + +![Flowchart for macrodefinition Control_Tracing_With_SGSN_HLR. The process starts with a decision 'Subscriber tracing active in HLR'. If False, it goes to an OK connector. If True, it checks 'Subscriber tracing active in SGSN'. If True, it goes to an OK connector. If False, it checks 'Subscriber in HPLMN area?'. If No, it goes to an OK connector. If Yes, it sends 'MAP_ACTIVATE_TRACE_MODE_req' and 'MAP_DELIMITER_req' to the SGSN, then enters 'Wait_For_ATM_Result'. From there, it handles three cases: 'MAP_ACTIVATE_TRACE_MODE_cnf' leads to 'Check Confirmation' which results in 'Subscriber tracing active in SGSN:= True' (OK) or 'Subscriber tracing active in SGSN:= False' (Error); 'MAP_NOTICE_ind' leads to 'MAP_CLOSE_req' which goes to an Error connector; and a third case with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' also goes to an Error connector. There are also 'User Error, Data Error' and 'Provider Error' paths from 'Check Confirmation' leading to 'Subscriber tracing active in SGSN:= False' (Error).](7ef58acaae097f1a37dac2a742e93445_img.jpg) + +macrodefinition Control\_Tracing\_With\_SGSN\_HLR + +Ctrl\_Tr\_SGSN\_HLR1(1) + +Macro in the HLR to activate tracing in the SGSN + +Signals to/from the left are to/from the SGSN + +``` + +graph TD + Start([Start]) --> D1{Subscriber tracing active in HLR} + D1 -- False --> OK1((OK)) + D1 -- True --> D2{Subscriber tracing active in SGSN} + D2 -- True --> OK2((OK)) + D2 -- False --> D3{Subscriber in HPLMN area?} + D3 -- No --> OK3((OK)) + D3 -- Yes --> Req1[MAP_ACTIVATE_TRACE_MODE_req +MAP_DELIMITER_req] + Req1 --> Wait[Wait_For_ATM_Result] + Wait --> Cnf1[MAP_ACTIVATE_TRACE_MODE_cnf] + Wait --> Ind1[MAP_NOTICE_ind] + Wait --> Ind2[MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind] + Cnf1 --> Check[Check Confirmation] + Check -- OK --> SubTrue1[Subscriber tracing active in SGSN:= True] + Check -- "User Error, Data Error" --> SubFalse1[Subscriber tracing active in SGSN:= False] + Check -- "Provider Error" --> SubFalse2[Subscriber tracing active in SGSN:= False] + SubTrue1 --> OK4((OK)) + SubFalse1 --> Error1((Error)) + SubFalse2 --> Error2((Error)) + Ind1 --> Req2[MAP_CLOSE_req] + Req2 --> Error3((Error)) + Ind2 --> Error4((Error)) + +``` + +Flowchart for macrodefinition Control\_Tracing\_With\_SGSN\_HLR. The process starts with a decision 'Subscriber tracing active in HLR'. If False, it goes to an OK connector. If True, it checks 'Subscriber tracing active in SGSN'. If True, it goes to an OK connector. If False, it checks 'Subscriber in HPLMN area?'. If No, it goes to an OK connector. If Yes, it sends 'MAP\_ACTIVATE\_TRACE\_MODE\_req' and 'MAP\_DELIMITER\_req' to the SGSN, then enters 'Wait\_For\_ATM\_Result'. From there, it handles three cases: 'MAP\_ACTIVATE\_TRACE\_MODE\_cnf' leads to 'Check Confirmation' which results in 'Subscriber tracing active in SGSN:= True' (OK) or 'Subscriber tracing active in SGSN:= False' (Error); 'MAP\_NOTICE\_ind' leads to 'MAP\_CLOSE\_req' which goes to an Error connector; and a third case with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' also goes to an Error connector. There are also 'User Error, Data Error' and 'Provider Error' paths from 'Check Confirmation' leading to 'Subscriber tracing active in SGSN:= False' (Error). + +5100 + +5101 + +Figure 25.9/7: Macro Control\_Tracing\_With\_SGSN\_HLR + +## 5102 25.10 Short Message Alert procedures + +### 5103 25.10.1 Process Subscriber\_Present\_VLR + +5104 The VLR invokes the process Subscriber\_Present\_VLR when the mobile subscriber becomes active. The general +5105 description of the short message alert procedures is in clause 23.4 of the present document. + +### 5106 25.10.2 Process SubscriberPresent\_SGSN + +5107 The SGSN invokes the process Subscriber\_Present\_SGSN when it receives a Page response, a GPRS Attach request or +5108 a Routing area update request message (3GPP TS 24.008 [35]). The general description of the short message alert +5109 procedures is in clause 23.4 of the present document. + +### 5110 25.10.3 Macro Alert\_Service\_Centre\_HLR + +5111 The HLR invokes the macro Alert\_Service\_Centre\_HLR when Service Centre(s) are to be alerted. + +### 5112 25.10.4 Process Alert\_SC\_HLR + +5113 It is an operator option to resend the MAP\_ALERT\_SERVICE\_CENTRE request to the SMS-IWMSC if the alert is +5114 unsuccessful. The number of repeat attempts and the interval between them is also an operator option. The service +5115 centre address should be purged from the MWD list if the alert is consistently unsuccessful. + +![Flowchart for process Subscriber_Present_VLR. It starts with a decision 'MNRF set?'. If 'No', it ends. If 'Yes', it sends MAP_OPEN_req, MAP_READY_FOR_SM_req, and MAP_DELIMITER_req. Then it receives Open_Cnf. From Open_Cnf, it branches: 'Vr' leads to 'Perform MAP Vr dialogue' (ends), 'OK' leads to 'Wait_For_HLR_Response', and 'Error' ends. From 'Wait_For_HLR_Response', it branches: one path leads to a merge point with 'MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind' (ends), and another path leads to a merge point with 'MAP_READY_FOR_SM_cnf' which then leads to 'Check_Confirmation'. From 'Check_Confirmation', 'User Error, Data Error, Provider Error' ends the process, and 'OK' leads to 'Clear MNRF' which ends the process.](9c2c96a367ceb612a79b361b14406173_img.jpg) + +**process Subscriber\_Present\_VLR** **Sub\_Pres\_VLR1(1)** + +Process in the VLR to report to the HLR that the subscriber has become reachable + +Signals to/from the right are to/from the HLR + +``` + + graph TD + Start([ ]) --> MNRF{MNRF set?} + MNRF -- No --> End1((X)) + MNRF -- Yes --> Send[ ] + Send --> SendMsg["MAP_OPEN_req +MAP_READY_FOR_SM_req +MAP_DELIMITER_req"] + SendMsg --> Recv[Receive Open_Cnf] + Recv -- Vr --> Perform[Perform MAP Vr dialogue] + Perform --> End2((X)) + Recv -- OK --> Wait[Wait_For_HLR_Response] + Recv -- Error --> End3((X)) + Wait --> Merge1[ ] + Merge1 --> Merge1Msg["MAP_U_ABORT_ind, +MAP_P_ABORT_ind, +MAP_CLOSE_ind"] + Merge1Msg --> End4((X)) + Wait --> Merge2[ ] + Merge2 --> Merge2Msg["MAP_READY_FOR_SM_cnf"] + Merge2Msg --> Check[Check_Confirmation] + Check -- "User Error, +Data Error, +Provider Error" --> End5((X)) + Check -- OK --> Clear[Clear MNRF] + Clear --> End6((X)) + +``` + +Flowchart for process Subscriber\_Present\_VLR. It starts with a decision 'MNRF set?'. If 'No', it ends. If 'Yes', it sends MAP\_OPEN\_req, MAP\_READY\_FOR\_SM\_req, and MAP\_DELIMITER\_req. Then it receives Open\_Cnf. From Open\_Cnf, it branches: 'Vr' leads to 'Perform MAP Vr dialogue' (ends), 'OK' leads to 'Wait\_For\_HLR\_Response', and 'Error' ends. From 'Wait\_For\_HLR\_Response', it branches: one path leads to a merge point with 'MAP\_U\_ABORT\_ind, MAP\_P\_ABORT\_ind, MAP\_CLOSE\_ind' (ends), and another path leads to a merge point with 'MAP\_READY\_FOR\_SM\_cnf' which then leads to 'Check\_Confirmation'. From 'Check\_Confirmation', 'User Error, Data Error, Provider Error' ends the process, and 'OK' leads to 'Clear MNRF' which ends the process. + +5116 + +5117 + +**Figure 25.10/1: Process Subscriber\_Present\_VLR** + +![State transition diagram for process Subscriber_Present_SGSN. It starts at an initial state, checks if MNRG is set. If 'No', it ends. If 'Yes', it sends MAP requests (OPEN, READY_FOR_SM, DELIMITER) and waits for a response. Upon receiving 'Open_Cnf' with 'OK', it enters a wait state. From 'Wait_For_HLR_Response', it can receive 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', or 'MAP_CLOSE_ind' (leading to an error state), or 'MAP_READY_FOR_SM_cnf'. Upon receiving 'MAP_READY_FOR_SM_cnf', it checks the confirmation. If 'OK', it clears MNRG and ends. If an error ('User Error', 'Data Error', 'Provider Error') occurs, it ends. A 'Vr, Error' from the wait state also leads to an error state.](d9be851f95e31e733ac1f2e8aff74b81_img.jpg) + +**process Subscriber\_Present\_SGSN** **Sub\_Pres\_SGSN1(1)** + +Process in the SGSN to report to the HLR that the subscriber has become reachable + +Signals to/from the right are to/from the HLR + +``` + +stateDiagram-v2 + [*] --> Decision{MNRG set?} + Decision --> [*] : No + Decision --> Send_Requests : Yes + Send_Requests --> Wait_For_HLR_Response + Send_Requests : MAP_OPEN_req, MAP_READY_FOR_SM_req, MAP_DELIMITER_req + Wait_For_HLR_Response --> [*] : OK + Wait_For_HLR_Response --> [*] : Vr, Error + Wait_For_HLR_Response --> Receive_Indications : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Wait_For_HLR_Response --> Check_Confirmation : MAP_READY_FOR_SM_cnf + Check_Confirmation --> [*] : OK + Check_Confirmation --> [*] : User Error, Data Error, Provider Error + Check_Confirmation : Clear MNRG + +``` + +State transition diagram for process Subscriber\_Present\_SGSN. It starts at an initial state, checks if MNRG is set. If 'No', it ends. If 'Yes', it sends MAP requests (OPEN, READY\_FOR\_SM, DELIMITER) and waits for a response. Upon receiving 'Open\_Cnf' with 'OK', it enters a wait state. From 'Wait\_For\_HLR\_Response', it can receive 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', or 'MAP\_CLOSE\_ind' (leading to an error state), or 'MAP\_READY\_FOR\_SM\_cnf'. Upon receiving 'MAP\_READY\_FOR\_SM\_cnf', it checks the confirmation. If 'OK', it clears MNRG and ends. If an error ('User Error', 'Data Error', 'Provider Error') occurs, it ends. A 'Vr, Error' from the wait state also leads to an error state. + +5118 + +5119 + +Figure 25.10/2: Process Subscriber\_Present\_SGSN + +![Flowchart for macrodefinition Alert_Service_Centre_HLR. It starts with a connector, followed by a decision 'All MWD list entries processed?'. If 'Yes', it ends at an exit connector. If 'No', it goes to a process 'Alert_SC_HLR' and loops back to the start.](729c3e337f4826f94d4d07841eb88323_img.jpg) + +macrodefinition Alert\_Service\_Centre\_HLR + +AI\_Serv\_Ctr\_HLR1(1) + +``` +graph TD; Start([ ]) --> Decision{All MWD list entries processed?}; Decision -- Yes --> End([ ]); Decision -- No --> Process[Alert_SC_HLR]; Process --> Start; +``` + +Macro in the HLR to alert all Short Message Service centres with entries in the MWD list + +Flowchart for macrodefinition Alert\_Service\_Centre\_HLR. It starts with a connector, followed by a decision 'All MWD list entries processed?'. If 'Yes', it ends at an exit connector. If 'No', it goes to a process 'Alert\_SC\_HLR' and loops back to the start. + +5120 + +5121 + +Figure 25.10/3: Macro Alert\_Service\_Centre\_HLR + +![State transition diagram for process Alert_SC_HLR. The process starts in an initial state, transitions to 'Wait_For_Repeat_Timer_Expiry', then to 'Repeat timer expired' (triggered by 'Internal'). From there, it sends 'MAP_OPEN_req', 'MAP_ALERT_SERVICE_CENTRE_req', and 'MAP_DELIMITER_req' via a merge node. It then receives 'Open_Cnf' via a receive node. From 'Open_Cnf', an 'Error' leads to a dead state, 'OK' leads to 'Wait_For_Alert_SC_Response', and 'Vr' leads to 'Perform MAP Vr dialogue' (which also leads to a dead state). From 'Wait_For_Alert_SC_Response', a merge node leads to three paths: one with 'MAP_U_ABORT_ind', 'MAP_P_ABORT_ind', and 'MAP_CLOSE_ind'; another with 'MAP_NOTICE_ind' leading to 'MAP_CLOSE_req'; and a third with 'MAP_ALERT_SERVICE_CENTRE_cnf' leading to 'Check_Confirmation'. 'Check_Confirmation' leads to a decision diamond: 'User Error, Data Error, Provider Error' (No) leads to 'Remove SC address from MWD list?' which leads to 'Remove SC address from MWD list' and then to a dead state; 'OK' (Yes) leads to 'Repeat attempt?'. 'Repeat attempt?' (Yes) leads to 'Start repeat timer' and then back to 'Wait_For_Repeat_Timer_Expiry'; (No) leads to a dead state. The 'MAP_CLOSE_req' path also leads to a dead state.](8e14633000b27e10f59cd10539d49a6e_img.jpg) + +**process Alert\_SC\_HLR** **ASC\_HLR1(1)** + +``` + +stateDiagram-v2 + [*] --> Wait_For_Repeat_Timer_Expiry + state "Internal" as Internal + Internal --> Repeat_timer_expired : Repeat timer expired + Wait_For_Repeat_Timer_Expiry --> Repeat_timer_expired + Repeat_timer_expired --> Merge1{ } + Merge1 --> MAP_OPEN_req : MAP_OPEN_req, MAP_ALERT_SERVICE_CENTRE_req, MAP_DELIMITER_req + MAP_OPEN_req --> Receive_Open_Cnf : Receive_Open_Cnf + Receive_Open_Cnf --> Error : Error + Receive_Open_Cnf --> Wait_For_Alert_SC_Response : OK + Receive_Open_Cnf --> Perform_MAP_Vr_dialogue : Vr + Perform_MAP_Vr_dialogue --> [*] : + Wait_For_Alert_SC_Response --> Merge2{ } + Merge2 --> MAP_U_ABORT_ind : MAP_U_ABORT_ind, MAP_P_ABORT_ind, MAP_CLOSE_ind + Merge2 --> MAP_NOTICE_ind : MAP_NOTICE_ind + Merge2 --> MAP_ALERT_SERVICE_CENTRE_cnf : MAP_ALERT_SERVICE_CENTRE_cnf + MAP_NOTICE_ind --> MAP_CLOSE_req : MAP_CLOSE_req + MAP_ALERT_SERVICE_CENTRE_cnf --> Check_Confirmation : Check_Confirmation + Check_Confirmation --> Decision1{ } + Decision1 --> Remove_SC_address_from_MWD_list : User Error, Data Error, Provider Error (No) + Decision1 --> Repeat_attempt : OK (Yes) + Remove_SC_address_from_MWD_list --> [*] : + Repeat_attempt --> Start_repeat_timer : Yes + Repeat_attempt --> [*] : No + Start_repeat_timer --> Wait_For_Repeat_Timer_Expiry + MAP_CLOSE_req --> [*] : + +``` + +Process in the HLR to alert a Short Message Service centre + +Signals to/from the right are to/from the SMS-IWMSC + +State transition diagram for process Alert\_SC\_HLR. The process starts in an initial state, transitions to 'Wait\_For\_Repeat\_Timer\_Expiry', then to 'Repeat timer expired' (triggered by 'Internal'). From there, it sends 'MAP\_OPEN\_req', 'MAP\_ALERT\_SERVICE\_CENTRE\_req', and 'MAP\_DELIMITER\_req' via a merge node. It then receives 'Open\_Cnf' via a receive node. From 'Open\_Cnf', an 'Error' leads to a dead state, 'OK' leads to 'Wait\_For\_Alert\_SC\_Response', and 'Vr' leads to 'Perform MAP Vr dialogue' (which also leads to a dead state). From 'Wait\_For\_Alert\_SC\_Response', a merge node leads to three paths: one with 'MAP\_U\_ABORT\_ind', 'MAP\_P\_ABORT\_ind', and 'MAP\_CLOSE\_ind'; another with 'MAP\_NOTICE\_ind' leading to 'MAP\_CLOSE\_req'; and a third with 'MAP\_ALERT\_SERVICE\_CENTRE\_cnf' leading to 'Check\_Confirmation'. 'Check\_Confirmation' leads to a decision diamond: 'User Error, Data Error, Provider Error' (No) leads to 'Remove SC address from MWD list?' which leads to 'Remove SC address from MWD list' and then to a dead state; 'OK' (Yes) leads to 'Repeat attempt?'. 'Repeat attempt?' (Yes) leads to 'Start repeat timer' and then back to 'Wait\_For\_Repeat\_Timer\_Expiry'; (No) leads to a dead state. The 'MAP\_CLOSE\_req' path also leads to a dead state. + +5122 + +5123 + +**Figure 25.10/4: Process Alert\_SC\_HLR** + +5124 **Annex A (informative):** + +5125 **ASN.1 Cross-reference listing and fully expanded sources** + +5126 The ASN.1 Cross-reference listing and the fully expanded ASN.1 sources of the MAP protocol are provided for + +5127 information at [http://www.3gpp.org/ftp/Specs/archive/29\\_series/29.002/ASN.1/](http://www.3gpp.org/ftp/Specs/archive/29_series/29.002/ASN.1/) + +--- + +5128 Annex B (informative): +5129 Void + +--- + +## 5130 Annex C (informative): 5131 Message Segmentation Mechanisms + +5132 Various segmentation mechanisms are in use to overcome the problem where a MAP parameter carried in an Invoke, +5133 Result (or Error) component is too long to fit into a single SCCP UDT message. These mechanisms are: + +### 5134 C.1 SCCP segmentation + +5135 Instead of one UDT message several XUDT messages are used according to + +5136 Signalling Connection Control Part, Signalling System no. 7 ITU-T recommendation (07/96) Q.711 to Q.716 +5137 ('White Book SCCP'). + +5138 This mechanism may be used for all MAP messages. If no segmentation mechanism at the TCAP or MAP level is +5139 available, this is the only remaining possibility. + +5140 This mechanism has no impact on the MAP provider level and above; the MAP provider sees the parameter as being +5141 sent in a single segment. + +5142 It should be noted that not all SCCP transit nodes (world wide) currently support the transfer of XUDT messages. +5143 Therefore XUDT messages may be lost without notice, depending on the route the message takes. The routes which +5144 successive messages take between two end points can differ because of load balancing. It is therefore recommended that +5145 this mechanism is used only for: + +5146 a) messages which do not cross PLMN boundaries (when the PLMN operator ensures that all SCCP transit nodes +5147 within his PLMN support White Book SCCP) + +5148 b) messages with low priority i.e. loss of the message does not result in serious misoperation. + +5149 It should be noted that the decision whether or not a message crosses PLMN boundaries needs to be taken at the MAP +5150 application level; it is therefore based on the message's operation code rather than on the SCCP called party address, i.e. +5151 only messages which never cross PLMN boundaries due to the type of message (SendIdentification, SendRoutingInfo +5152 without OR, AnyTimeInterrogation, ...) can be regarded as not crossing PLMN boundaries. + +### 5153 C.2 TCAP segmentation + +5154 At the TCAP level the following segmentation mechanisms are available: + +#### 5155 C.2.1 Empty Begin + +5156 In a dialogue with AC version >1 the first forward message (Begin) must contain a Dialogue Portion. Instead of sending +5157 the Dialogue Portion and the Component Portion in the first forward message, an empty Begin (i.e. without a +5158 Component Portion) is sent, followed (after successful dialogue establishment) by a Continue message which can carry +5159 a longer Component Portion since no Dialogue Portion is present in the second forward message. + +#### 5160 C.2.2 Empty Continue + +5161 In a dialogue with AC version >1 the first backward message (Continue / End) must contain a Dialogue Portion. Instead +5162 of sending the Dialogue Portion and the Component Portion in the first backward message, an empty Continue (i.e. +5163 without a Component Portion) is sent, followed by a Continue/End message which can carry a longer Component +5164 Portion since no Dialogue Portion is present in the second backward message. + +#### 5165 C.2.3 TC-Result-NL + +5166 A Result component may be segmented into one or several Result-Not-Last components followed by a Result-Last +5167 component. As specified in clause 15.6.3, the MAP user parameter shall be split so that each segment is compatible +5168 with the type defined for the parameter of the result of the associated operation. + +5169 Note that this segmentation mechanism runs the risk that the message carrying the Result-Last component arrives +5170 before the message carrying a Result-Not-Last component which results in failure. The use of SCCP class 1 "Sequence +5171 guaranteed", which raises the chance of in sequence delivery, is recommended. + +## 5172 C.3 MAP Segmentation + +5173 At the MAP level the following segmentation mechanisms are available: + +### 5174 C.3.1 Invoke without explicit indication + +5175 An Invoke component may be segmented into several Invoke components. These may be sent in burst mode (in which +5176 case SCCP class 1 is recommended) or in acknowledged mode. The receiving node does not get an indication of +5177 whether or not more segments will be received, so it must not close the dialogue. The MAP user parameter shall be split +5178 so that each segment is compatible with the type defined for the parameter of the invoke of the associated operation. + +### 5179 C.3.2 Invoke with explicit indication + +5180 An Invoke component may be segmented into several Invoke components sent in acknowledged mode. Each +5181 component contains at the MAP level an indication of whether or not subsequent components will follow. The receiving +5182 node terminates the dialogue when the last component is received. The MAP user parameter shall be split so that each +5183 segment is compatible with the type defined for the parameter of the invoke of the associated operation. + +### 5184 C.3.3 Result + +5185 A Result (last) component may be segmented into several Result (last) components sent in acknowledged mode where a +5186 new (empty) Invoke component serves as an acknowledgment. The last segment is not acknowledged. The MAP user +5187 parameter shall be split so that each segment is compatible with the type defined for the parameter of the result of the +5188 associated operation. + +5189 The following tables show the applicability of the mechanisms described above: + +5190 + +**AC Version 4:** + +| Parameter | SCCP-segmentation | Empty Begin | Empty Continue | TC-Result-NL | Invoke without indication | Invoke with indication | Result | +|-----------------------|--------------------------|--------------------|-----------------------|---------------------|----------------------------------|-------------------------------|---------------| +| ResumeCallHandlingArg | allowed | not allowed | n.a. | n.a. | not allowed | recommended | n.a. | + +5191 + +5192 + +**AC Version 3:** + +| Parameter | SCCP-segmentation | Empty Begin | Empty Continue | TC-Result-NL | Invoke without indication | Invoke with indication | Result | +|-------------------------------------|--------------------------|--------------------|-----------------------|---------------------|----------------------------------|-------------------------------|---------------| +| InsertSubscriberDataArg | risky | not allowed | n.a. | n.a. | recommended | n.a. | n.a. | +| SendIdentificationRes | allowed | n.a. | not allowed | not allowed | n.a. | n.a. | recommended | +| PrepareHO-Arg | allowed | not allowed | n.a. | n.a. | not allowed | n.a. | n.a. | +| PrepareHO-Res | allowed | n.a. | recommended | not recommended | n.a. | n.a. | not allowed | +| ProcessAccessSignalling-Arg | allowed | n.a. | n.a. | n.a. | not allowed | n.a. | n.a. | +| ForwardAccessSignalling-Arg | allowed | n.a. | n.a. | n.a. | not allowed | n.a. | n.a. | +| PrepareSubsequentHO-Arg | allowed | n.a. | n.a. | n.a. | not allowed | n.a. | n.a. | +| PrepareSubsequentHO-Res | allowed | n.a. | n.a. | not recommended | n.a. | n.a. | not allowed | +| SendAuthenticationInfoRes | risky | n.a. | not allowed | not allowed | n.a. | n.a. | recommended | +| ProvideSubscriberInfoRes | allowed | n.a. | not allowed | not recommended | n.a. | n.a. | not allowed | +| AnyTimeInterrogationRes | allowed | n.a. | not allowed | not recommended | n.a. | n.a. | not allowed | +| AnyTimeModificationRes | allowed | n.a. | not allowed | recommended | n.a. | n.a. | not allowed | +| AnyTimeSubscriptionInterrogationRes | allowed | n.a. | not allowed | recommended | n.a. | n.a. | not allowed | +| noteSubscriberDataModifiedArg | allowed | not allowed | n.a. | n.a. | not allowed | recommended | n.a. | +| SendRoutingInfoRes | allowed | n.a. | not allowed | recommended | n.a. | n.a. | not allowed | +| MO-ForwardSM-Arg | risky | recommended | n.a. | n.a. | not allowed | n.a. | n.a. | +| MT-ForwardSM-Arg | risky | recommended | n.a. | n.a. | not allowed | n.a. | n.a. | + +5193 + +5194 + +**AC Version 2:** + +| Parameter | SCCP-segmentation | Empty Begin | Empty Continue | TC-Result-NL | Invoke without indication | Invoke with indication | Result | +|---------------------------|--------------------------|--------------------|-----------------------|---------------------|----------------------------------|-------------------------------|---------------| +| InsertSubscriberDataArg | risky | not allowed | not allowed | n.a. | recommended | n.a. | n.a. | +| SendIdentificationRes | allowed | n.a. | not allowed | not recommended | n.a. | n.a. | not allowed | +| SendAuthenticationInfoRes | risky | n.a. | not allowed | not recommended | n.a. | n.a. | not allowed | +| ForwardSM-Arg | risky | recommended | n.a. | n.a. | not allowed | n.a. | n.a. | +| PrepareHO-Res | allowed | n.a. | recommended | not recommended | n.a. | n.a. | not allowed | + +5195 + +5196 + +### AC Version 1: + +| Parameter | SCCP-segmentation | Empty Begin | Empty Continue | TC-Result-NL | Invoke without indication | Invoke with indication | Result | +|-------------------------|-------------------|-------------|----------------|--------------|---------------------------|------------------------|-------------| +| InsertSubscriberDataArg | risky | n.a. | n.a. | n.a. | recommended | n.a. | n.a. | +| SentParameterList | risky | n.a. | n.a. | recommended | n.a. | n.a. | not allowed | + +5197 + +5198 In the tables above the keywords "recommended", "allowed", "risky", "not recommended", "not allowed" and "n.a." are used as follows: + +5199 **"recommended"** + +5200 indicates that the normative part of this specification explicitly specifies the use of this mechanism for the parameter in question; + +5201 **"allowed"** + +5202 indicates that the normative part of this specification allows the use of this mechanism for the sending node and mandates support of this mechanism for the receiving node; + +5203 **"risky"** + +5204 indicates that the mechanism is "allowed". However, the use of this mechanism for the parameter in question may result in serious misoperation because SCCP transit nodes are +5205 not guaranteed to support XUDT messages. + +5206 **"not recommended"** + +5207 indicates that the normative part of this specification does not explicitly specify the use of this mechanism for the parameter in question. + +5208 **"not allowed"** + +5209 indicates that the normative part of this specification implicitly prohibits the use of this mechanism for the parameter in question. + +5210 **"n.a."** + +5211 indicates that the mechanism is not applicable for the parameter in question. + +5212 + +--- + +5213 Annex D (informative): Void + +5214 **Annex E (informative):** + 5215 **Change History** + +5216 + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | New | +|------|-------|-----------|------|-----|----------------------------------------------------------------------------------------------------|-------| +| | 04 | N2-99227 | A002 | 3 | Use of E interface | 3.1.0 | +| | 04 | N2-99578 | A003 | | Introduction of TIF-CSI for Call Deflection | 3.1.0 | +| | 04 | N2-99233 | A004 | | Clarification in ASN.1 encoding of O-CSI and T-CSI | 3.1.0 | +| | 04 | N2-99269 | A005 | | Introduction of MSISDN in USSD operation | 3.1.0 | +| | 04 | N2-99650 | A006 | | Modification of the O-CSI ASN.1 structure | 3.1.0 | +| | 04 | N2-99250 | A007 | | Adding of MAP_DELIMITER_req to the Status report operation | 3.1.0 | +| | 04 | N2-99628 | A008 | | Correction to the Purge MS "Detailed procedure in the HLR" | 3.1.0 | +| | 04 | N2-99677 | A009 | | Adding of MNP-indicator to the SRI ack | 3.1.0 | +| | 04 | N2-99228 | A010 | | New subscription options for call forwarding | 3.1.0 | +| | 04 | N2-99585 | A011 | | Adding the support of ANSI SCCP which is required in North America (World Zone 1) | 3.1.0 | +| | 04 | N2-99515 | A012 | | Introduction of 3-digit MNCs correction | 3.1.0 | +| | 04 | N2-99520 | A013 | | Export of NAEA-CIC | 3.1.0 | +| | 04 | N2-99548 | A014 | | Clarification to text to identify how the LSA data relevant in the current VPLMN can be determined | 3.1.0 | +| | 04 | 3C99-468 | A015 | | Alignment with 04.80 | 3.1.0 | +| | 04 | N2-99519 | A016 | | VBS data | 3.1.0 | +| | 04 | N2-99461 | A017 | | Introduction of Data Missing error to the Resume Call Handling | 3.1.0 | +| | 04 | N2-99583 | A018 | | Removal of 3-digit MNCs | 3.1.0 | +| | 04 | N2-99676 | A019 | | Corrections of mapping from MAP service to TC service | 3.1.0 | +| | 04 | 3C99-206 | A020 | | Introduction of UUS service to Resume Call Handling | 3.1.0 | +| | 05 | N2-99906 | 021 | | Clarification on VLR CAMEL Subscription Info | 3.2.0 | +| | 05 | N2-99908 | 022 | | Clarification on DestinationNumberCriteria | 3.2.0 | +| | 05 | N2-99910 | 023 | | Removal of TDP-Criteria from RCH | 3.2.0 | +| | 05 | N2-99934 | 025 | | Various corrections related to GGSN-HLR Interface. | 3.2.0 | +| | 05 | N2-99936 | 034 | | Update Location handling for GPRS-only subscription | 3.2.0 | +| | 05 | N2-99938 | 035 | | Correction of OP & AC definitions for NoteMS-PresentForGPRS | 3.2.0 | +| | 05 | N2-99952 | 036 | | Removal of redundant information from RCH | 3.2.0 | +| | 05 | N2-99956 | 026 | | OR capability IE in PRN | 3.2.0 | +| | 05 | N2-99964 | 024 | 1 | GSMSC-CAMEL phase 2 support IE in PRN | 3.2.0 | +| | 05 | N2-99A19 | 028 | | Alignment of 29.002 with 02.67 | 3.2.0 | +| | 05 | N2-99A45 | 029 | 1 | Non-CAMEL IST implementation | 3.2.0 | +| | 05 | N2-99B57 | 027 | 2 | Addition of the information elements and the ASN.1 definitions for Pre-paging | 3.2.0 | +| | 05 | N2-99C27 | 042 | | Clarification on 'Supported CAMEL Phases' in ISD ack | 3.2.0 | +| | 05 | N2-99C78 | 044 | | Editing error correction on VLR capabilities | 3.2.0 | +| | 05 | N2-99D06 | 043 | 1 | Addition of exception handling to the CancellationType | 3.2.0 | +| | 05 | N2-99D33 | 046 | | Clarification of LR-REJECT cause corresponding to RoamingRestrictionDueToUnsupportedFeature | 3.2.0 | +| | 05 | N2-99D35 | 047 | | Clarification of returning the MSISDN in SRIack | 3.2.0 | +| | 06 | N2-99G06 | 033 | 3 | Introduction of the Super-Charger Concept in TS 29.002 | 3.3.0 | +| | 06 | N2-99G18 | 032 | 2 | Introduction of White Book SCCP in MAP | 3.3.0 | +| | 06 | N2-99G50 | 070 | | Addition of GGSN number for the SRIforGPRS | 3.3.0 | +| | 06 | N2-99J88 | 075 | 1 | Introduction of Follow Me | 3.3.0 | +| | 06 | N2-99K12 | 077 | | Use of SSN for GPRS | 3.3.0 | +| | 06 | N2-99K24 | 069 | | Correction of the USSD procedure in the HLR. | 3.3.0 | +| | 06 | N2-99K52 | 060 | 1 | MAP Impacts for Location Services (LCS) | 3.3.0 | +| | 06 | N2-99K58 | 045 | 4 | Authentication Enhancements | 3.3.0 | +| | 06 | N2-99K60 | 050 | 5 | QoS-Subscribed field modification | 3.3.0 | +| | 06 | N2-99L20 | 073 | 1 | Introduction of CAMEL Phase 3 in 3GPP TS 29.002 | 3.3.0 | +| | 06 | N2-99J52 | 074 | | Restructuring of MAP Location Management Procedures for the Circuit Switched Domain | 3.3.0 | +| | 06 | N2-99J92 | 068 | | Update of SDIs to support Super-Charger | 3.3.0 | +| | | | | | New version created to fix a CR implementation error | 3.3.1 | +| | 07 | N2B000436 | 048 | 5 | Introduction of Multicall | 3.4.0 | +| | 07 | N2B000319 | 059 | 1 | Alternative solution for ALR | 3.4.0 | +| | 07 | N2B000461 | 063 | 4 | MNP Database Mismatch | 3.4.0 | +| | 07 | N2B000375 | 066 | 5 | Addition of the FTN-AddressString | 3.4.0 | +| | 07 | N2B000456 | 079 | 4 | Correction of SS Invocation Notification for CCBS | 3.4.0 | +| | 07 | N2A000023 | 080 | | Corrections to ATSI, ATM, NCSD | 3.4.0 | +| | 07 | N2B000046 | 083 | | Privacy notification/verification for call related privacy class | 3.4.0 | + +| | | | | | | | +|--|----|-----------|-----|---|--------------------------------------------------------------------------------------------------|-------| +| | 07 | N2B000142 | 084 | 2 | Addition of CS Allocation/retention priority | 3.4.0 | +| | 07 | N2B000144 | 086 | 1 | Editorial cleanup of 29.002 | 3.4.0 | +| | 07 | N2B000100 | 087 | | Correction of LSA information | 3.4.0 | +| | 07 | N2B000067 | 089 | | Security interworking between release 99 and pre-99 MSC/VLRs | 3.4.0 | +| | 07 | N2B000113 | 090 | 1 | Improving GPRS charging efficiency | 3.4.0 | +| | 07 | N2B000120 | 094 | 2 | QoS-Subscribed field enhancements | 3.4.0 | +| | 07 | N2B000322 | 095 | 1 | RANAP support on the E-interface | 3.4.0 | +| | 07 | N2B000191 | 099 | | UMTS Authentication | 3.4.0 | +| | 07 | N2B000466 | 100 | 5 | Support of 3G Handover, including Multicall | 3.4.0 | +| | 07 | N2B000372 | 101 | 1 | Introduction of Service Area Identification | 3.4.0 | +| | 07 | N2B000380 | 102 | 2 | Clarification on Authentication Info Retrieval | 3.4.0 | +| | 07 | N2B000330 | 103 | 1 | Addition of UMTS security to MAP B interface | 3.4.0 | +| | 07 | N2B000244 | 104 | | Re-Synchronisation Info | 3.4.0 | +| | 07 | N2B000324 | 105 | 1 | Introduction of additional service parameters for inter-system handover | 3.4.0 | +| | 07 | N2B000281 | 107 | | Removal of architectural information from clause 4 | 3.4.0 | +| | 07 | N2-000454 | 110 | 1 | Introduction of Authentication Failure Report | 3.4.0 | +| | 07 | N2B000357 | 111 | | Use of MAP private extensions to implement region-specific requirements | 3.4.0 | +| | 07 | N2B000470 | 112 | | Prioritisation of MAP application context related to VGCS/VBS | 3.4.0 | +| | 07 | N2B000472 | 113 | | Correction of SS-Codes for LCS | 3.4.0 | +| | 08 | N4-000098 | 115 | 1 | Minor corrections to CAMEL3 NSDC/ATM/ATSI information flows | 3.5.0 | +| | 08 | N4-000094 | 117 | 1 | Using DSD to delete CCBS-B from the subscriber | 3.5.0 | +| | 08 | N4-000089 | 118 | 1 | Indication in PRN of support of Long FTNs | 3.5.0 | +| | 08 | N4-000073 | 120 | 1 | QoS-Subscribed field enhancements | 3.5.0 | +| | 08 | N4-000050 | 121 | | Correction of introduction of additional service parameters for inter-system handover | 3.5.0 | +| | 08 | N4-000100 | 122 | 2 | Proposed information flow on NSDC | 3.5.0 | +| | 08 | N4-000321 | 124 | 3 | CAMEL Subscription Info | 3.5.0 | +| | 08 | N4-000068 | 125 | | Clarification to GMLC List definition | 3.5.0 | +| | 08 | N4-000320 | 127 | 1 | Optionality of parameters in d-csi and in sms-csi | 3.5.0 | +| | 08 | N4-000209 | 130 | | Version 3 tags for handover messages | 3.5.0 | +| | 08 | N4-000211 | 132 | | Correction of version handling at dialogue establishment | 3.5.0 | +| | 08 | N4-000357 | 133 | 1 | Various corrections and/or cleanup to 29.002 | 3.5.0 | +| | 08 | N4-000217 | 134 | | Correction of errors in Figure 25.1/1: Macro Receive_Open_Ind | 3.5.0 | +| | 08 | N4-000326 | 135 | 1 | Addition of charging characteristics per PDP context | 3.5.0 | +| | 08 | N4-000264 | 138 | | Clarification of SAI-ack segmentation procedure | 3.5.0 | +| | 08 | N4-000392 | 139 | 1 | Indication of unsupported position method | 3.5.0 | +| | 08 | N4-000276 | 141 | | Clarification for ReportSM-DeliveryStatus operation | 3.5.0 | +| | 08 | N4-000349 | 142 | 1 | Addition of a parameter in the subsequent Handover from UMTS to GSM with Multicall | 3.5.0 | +| | 08 | N4-000278 | 143 | | Editorial correction to MSC-A handover SDLs | 3.5.0 | +| | 08 | N4-000378 | 144 | 1 | Use of NAM parameter with MAP-INSERT-SUBSCRIBER-DATA service between HLR and SGSN | 3.5.0 | +| | 08 | N4-000293 | 145 | | Addition of state attributes in Forward group call signalling | 3.5.0 | +| | 08 | N4-000294 | 146 | | New user error 'target cell outside group call area' in MAP Prepare Handover message | 3.5.0 | +| | 08 | N4-000374 | 149 | | Correction to the description of MAP-MO-Forward-Short-Message service | 3.5.0 | +| | 08 | N4-000407 | 148 | 4 | Changes to MAP for secure transport of MAP messages | 4.0.0 | +| | 08 | | | | Version 4.0.1 created to allow inclusion of automatic update of Annexes A and B and of clause 17 | 4.0.1 | +| | 09 | N4-000543 | 152 | 1 | Clarifications for secure MAP transport | 4.1.0 | +| | 09 | N4-000539 | 153 | 1 | Generalization of version handling text in clause 18.2.4 | 4.1.0 | +| | 09 | N4-000491 | 158 | | Deletion of informative Annexe C | 4.1.0 | +| | 09 | N4-000540 | 159 | | Aligning 29.002 with 25.413 (UTRAN Iu Interface RANAP Signalling) | 4.1.0 | +| | 09 | N4-000541 | 160 | | AUTS and AUTN parameter length | 4.1.0 | +| | 09 | N4-000744 | 161 | 2 | Clarification on Authentication Failure Report ack | 4.1.0 | +| | 09 | N4-000666 | 163 | 1 | Correction on Location Information | 4.1.0 | +| | 09 | N4-000777 | 174 | 2 | Optionality of parameters in GPRS-CSI | 4.1.0 | +| | 09 | N4-000788 | 176 | 1 | Correction to QoS indication | 4.1.0 | +| | 09 | N4-000747 | 178 | 1 | Clarification of use of Radio Resource Information | 4.1.0 | +| | 09 | N4-000750 | 180 | 2 | Correction to MSC-A handover SDLs | 4.1.0 | +| | 09 | N4-000736 | 182 | | Removal of LSAIdentity from NoteMM-EventArgs | 4.1.0 | +| | 09 | N4-000772 | 184 | | LCS Support for CAMEL Phase 3 | 4.1.0 | +| | 09 | N4-000751 | 186 | 1 | Correction to MSC-A handover SDLs | 4.1.0 | +| | 09 | N4-000779 | 188 | | Clarification for segmentation of D-CSI and SMS-CSI | 4.1.0 | +| | 10 | N4-000912 | 166 | 3 | Corrections and clarifications for USSD procedures on the HLR - gsmSCF interface | 4.2.0 | +| | 10 | N4-000908 | 191 | 1 | Corrections of ISD data structure for CAMEL phase 3 | 4.2.0 | +| | 10 | N4-001069 | 193 | 2 | USSD Corrections for Follow Me | 4.2.0 | +| | 10 | N4-001071 | 196 | 1 | GSM to 3G Handover: MAP parameter Target Cell ID | 4.2.0 | +| | 10 | N4-000921 | 198 | | ASN.1 description of targetCellId | 4.2.0 | +| | 10 | N4-001073 | 200 | 1 | IMSI in MAP_PREPARE_HANDOVER | 4.2.0 | +| | 10 | N4-001076 | 208 | 1 | Alignment of the Target RNC-ID | 4.2.0 | +| | 10 | N4-001089 | 211 | 1 | Export of GSN-Address data type | 4.2.0 | + +| | | | | | | | +|--|----|-----------|-----|---|----------------------------------------------------------------------------------------|-------| +| | 10 | N4-001095 | 212 | | Transport of long RANAP messages on MAP-E interface | 4.2.0 | +| | - | - | - | - | Automatic update of annexes A and B | 4.2.1 | +| | 11 | N4-010036 | 206 | 1 | Correction to LCS application context | 4.3.0 | +| | 11 | N4-010276 | 215 | 2 | Add parameters to ISD and SRI for GPRS to handle ODB for PS | 4.3.0 | +| | 11 | N4-010033 | 217 | | Correction to maximum number of RAB's | 4.3.0 | +| | 11 | N4-010198 | 222 | 2 | PS domain support for LCS Release 4 | 4.3.0 | +| | 11 | N4-010058 | 224 | | Failure of Update GPRS Location when HLR is not reachable | 4.3.0 | +| | 11 | N4-010287 | 231 | 1 | Extension of call related privacy class for LCS Release 4 | 4.3.0 | +| | 11 | N4-010375 | 232 | 2 | Maximum number of LCS Clients | 4.3.0 | +| | 11 | N4-010261 | 234 | | MAP over IP according to SIGTRAN | 4.3.0 | +| | 11 | N4-010465 | 236 | 1 | Requesting node type in authentication set request | 4.3.0 | +| | 11 | N4-010360 | 246 | | Adding EXPORT definition for LSIdentity | 4.3.0 | +| | 11 | N4-010361 | 247 | | Removing duplicate parameters from ss-CSI | 4.3.0 | +| | 11 | N4-010362 | 248 | | Correction to description of SS-CSI in HLR to VLR information flow | 4.3.0 | +| | 11 | N4-010365 | 250 | | GSM to UMTS handover: addition of MAP parameter RNC ID | 4.3.0 | +| | 11 | N4-010393 | 252 | | Clarification of the use of multicall bearer information | 4.3.0 | +| | 11 | N4-010428 | 258 | | Adding EXPORT definition for GeographicalInformation | 4.3.0 | +| | 11 | N4-010446 | 260 | | Failure of Authentication Parameter GPRS when HLR is not reachable | 4.3.0 | +| | 11 | N4-010484 | 262 | 1 | Correction to D-CSI | 4.3.0 | +| | 12 | N4-010728 | 239 | 4 | Addition of selected UMTS algorithm indication to the handover procedures | 4.4.0 | +| | 12 | N4-010730 | 241 | 4 | Addition of allowed GSM algorithms indication to the handover procedures | 4.4.0 | +| | 12 | N4-010733 | 244 | 4 | Addition of allowed UMTS algorithm indication to the handover procedures | 4.4.0 | +| | 12 | N4-010735 | 245 | 4 | Addition of selected GSM algorithm indication to the handover procedures | 4.4.0 | +| | 12 | N4-010739 | 254 | 2 | Addition of radio resource list to the handover procedures | 4.4.0 | +| | 12 | NP-010247 | 256 | 3 | Addition of GSM channel type and GSM chosen channel indications to handover procedures | 4.4.0 | +| | 12 | N4-010787 | 264 | 3 | Add support in MAP for all shapes defined in 23.032 | 4.4.0 | +| | 12 | N4-010633 | 270 | 1 | Correction to description of RNCId parameter | 4.4.0 | +| | 12 | N4-010635 | 272 | 1 | Correction to Encryption Information and Integrity Protection parameters | 4.4.0 | +| | 12 | N4-010767 | 279 | 3 | Essential drawbacks on services due to introduction of Super-Charger function | 4.4.0 | +| | 12 | N4-010741 | 283 | 1 | Introduction of selected Rab-id to the Process Access Signalling operation | 4.4.0 | +| | 12 | N4-010673 | 285 | | Mistake in the definition of Authentication Failure Report Application Context | 4.4.0 | +| | 12 | N4-010551 | 266 | | Add support in MAP for Ellipsoid Point | 4.4.0 | +| | 12 | N4-010778 | 168 | 5 | Security Header modification | 4.4.0 | +| | 12 | N4-010785 | 267 | 3 | Additional Parameters in Authentication Failure Report | 4.4.0 | +| | 12 | N4-010783 | 268 | 3 | MS presence notification procedure for LCS | 4.4.0 | +| | 12 | N4-010790 | 289 | 2 | Component level granularity of protection | 4.4.0 | +| | | | | | Corrupted headers fixed | 4.4.1 | +| | 13 | N4-010840 | 290 | | Clarifications on long forwarded-to numbers | 4.5.0 | +| | 13 | N4-010929 | 291 | 1 | Corrections for Deferred MT-LR | 4.5.0 | +| | 13 | N4-010930 | 292 | 2 | Clarifications on SupportedLCS-CapabilitySets | 4.5.0 | +| | 13 | N4-010958 | 295 | 2 | Corrections on the introduction of LCS for PS domain | 4.5.0 | +| | 13 | N4-010970 | 302 | 2 | Additional SGSN related values to Access Type | 4.5.0 | +| | 13 | N4-010976 | 306 | | Addition of data type definitions to EXPORT statements for the usage in CAP | 4.5.0 | +| | 13 | N4-011017 | 307 | 2 | Minimum MAP application context for intersystem MSC handover from GSM to UMTS | 4.5.0 | +| | 13 | N4-011019 | 309 | 2 | Minimum MAP application context for intersystem MSC handover from UMTS to GSM | 4.5.0 | +| | 13 | N4-010845 | 277 | 1 | Correction on the SDL of NW initiated USSD operations | 4.5.0 | +| | 13 | | | | Editorial Clean up | 4.5.0 | +| | 14 | N4-011031 | 313 | | Clarification on LCS parameters in MAP | 4.6.0 | +| | 14 | N4-011043 | 314 | | Handling of linked operations in the MAP protocol machine | 4.6.0 | +| | 14 | N4-011285 | 316 | | Corrections on the SDL diagrams for LCS | 4.6.0 | +| | 14 | N4-011198 | 318 | 1 | Indication of deletion of CSI in Notify Subscriber Data Change | 4.6.0 | +| | 14 | N4-011074 | 320 | | Correct length of Add-GeographicalInformation | 4.6.0 | +| | 14 | N4-011091 | 322 | | Clarify encoding of RNC Id | 4.6.0 | +| | 14 | N4-011094 | 324 | | Clarify encoding of RANAP parameters in MAP | 4.6.0 | +| | 14 | N4-011097 | 325 | | Clarifications on long forwarded-to numbers | 4.6.0 | +| | 14 | N4-011227 | 331 | 1 | Clarification of methodology for maintaining data consistency in Supercharger | 4.6.0 | +| | 14 | N4-011173 | 334 | | Addition of RAB ID to Prepare Handover procedure | 4.6.0 | +| | 14 | N4-011175 | 336 | | Correction to the Allowed GSM Algorithms parameter | 4.6.0 | +| | 14 | N4-011177 | 337 | 1 | Correction of references | 4.6.0 | +| | 14 | N4-011190 | 339 | | CUG-Info is not exported from 29.002 | 4.6.0 | +| | 14 | N4-011209 | 341 | | Clarification on NSCD when data is withdrawn | 4.6.0 | +| | 14 | N4-011211 | 343 | | Clarification of sending CAMEL information in stand alone ISD case | 4.6.0 | +| | 14 | N4-011262 | 344 | | Correction of the priority for "SRI for LCS" | 4.6.0 | +| | 14 | N4-011273 | 347 | | ASN.1 correction | 4.6.0 | +| | 14 | N4-011437 | 349 | 2 | Handling of MNRR in the HLR & SMS-GMSC | 4.6.0 | +| | 14 | N4-011433 | 354 | 1 | Minimum MAP application context for G2G inter-MSC handover | 4.6.0 | + +| | | | | | | | +|--|-----|-----------|-----|---|-------------------------------------------------------------------------------------|-------| +| | 14 | N4-011439 | 359 | 2 | Alignment of parameter lengths with those prescribed in 08.08 | 4.6.0 | +| | 14 | N4-011423 | 360 | 1 | Aligning the security header elements with TS33.200 | 4.6.0 | +| | 14 | N4-011394 | 364 | | Syntax error in the ATM result and ATSI result | 4.6.0 | +| | 14 | N4-011381 | 355 | 1 | LCS Capability Handling for UE's | 5.0.0 | +| | 15 | N4-020300 | 368 | 4 | Collective CAMEL Phase 4 CR | 5.1.0 | +| | 15 | N4-020013 | 373 | | Inclusion of complete ODB data in ATSI and NSDC | 5.1.0 | +| | 15 | N4-020266 | 381 | 2 | Introduction of the "Requestor ID" | 5.1.0 | +| | 15 | N4-020068 | 386 | | Correction to AC version of gprsLocationInfoRetrievalContext | 5.1.0 | +| | 15 | N4-020248 | 390 | 1 | Incomplete description of Restore Data parameters | 5.1.0 | +| | 15 | N4-020183 | 403 | | Clarification on CODEC-Info | 5.1.0 | +| | 15 | N4-020250 | 407 | 1 | ODB alignment | 5.1.0 | +| | 16 | N4-020530 | 428 | 2 | LCS: error handling if shape not supported by GMLC | 5.2.0 | +| | 16 | N4-020622 | 453 | | Addition of Radio Resource List to the Forward Access Signalling operation | 5.2.0 | +| | 16 | N4-020641 | 460 | | Clarification on Resume Call Handling | 5.2.0 | +| | 16 | N4-020746 | 440 | 2 | Clarification on SendAuthenticationInfo | 5.2.0 | +| | 16 | N4-020750 | 446 | 1 | Addition of Service Handover parameters to MAP Handover messages | 5.2.0 | +| | 16 | N4-020318 | 398 | | Check of NAM and Requesting Node Type on receipt of SendAuthenticationInfo | 5.2.0 | +| | 16 | N4-020333 | 410 | | Handling the MNRR flag in the HLR & SMS-GMSC | 5.2.0 | +| | 16 | N4-020499 | 420 | 1 | Clarification of introducing Session related and unrelated class | 5.2.0 | +| | 16 | N4-020511 | 430 | 1 | Corrections on the introduction of LCS for PS domain | 5.2.0 | +| | 16 | N4-020743 | 448 | 1 | Corrections in SS-code chapter | 5.2.0 | +| | 16 | N4-020408 | 423 | | Clarification of handling of MT-SMS-TPDU-Type and SMS-TDP | 5.2.0 | +| | 16 | N4-020410 | 425 | | Clarify conditions to trigger restart of MTLR-Deferred procedure | 5.2.0 | +| | 16 | N4-020468 | 414 | 1 | Corrections to the handling of Any Time Interrogation and Provide Subscriber Info | 5.2.0 | +| | 16 | N4-020476 | 435 | 1 | Change PS-connected in PS-PDPactive | 5.2.0 | +| | 16 | N4-020483 | 422 | 1 | Triggering of gsmSCF for MT-SMS-CSI | 5.2.0 | +| | 16 | N4-020485 | 408 | 2 | Transferring the MS classmark & IMEI to the gsmSCF | 5.2.0 | +| | 16 | N4-020543 | 441 | | Correction of Object Identifiers for ASN.1 modules | 5.2.0 | +| | 16 | N4-020608 | 450 | | Enhancement to LCS in the PS domain | 5.2.0 | +| | 16 | N4-020623 | 454 | | Addition of Location Information GPRS to Note MM Event operation | 5.2.0 | +| | 16 | N4-020703 | 421 | 4 | LCS: Codeword and Service Type | 5.2.0 | +| | 16 | N4-020756 | 436 | 2 | Splitting of CAMEL phase 4 | 5.2.0 | +| | 17 | N4-021001 | 437 | 3 | Compatible upgrade to ASN.1:1997 of 29.002 | 5.3.0 | +| | 17 | NP-020399 | 462 | 2 | Introduction of GERAN classmark | 5.3.0 | +| | 17 | N4-020841 | 465 | | Clarification on Call Deflection | 5.3.0 | +| | 17 | N4-021040 | 470 | 1 | Correction to the usage of "Roaming not allowed" error | 5.3.0 | +| | 17 | N4-021041 | 471 | 1 | Clarifications on Send Identification | 5.3.0 | +| | 17 | N4-021094 | 479 | 2 | Handling of partial implementations of CAMEL phase 4 | 5.3.0 | +| | 17 | N4-021047 | 480 | | Removal of ChargingNotification feature | 5.3.0 | +| | 17 | N4-020810 | 481 | | CR29.002-443 (rel5) on extensions to ATM for CAMEL control of IMS | 5.3.0 | +| | 17 | N4-020809 | 482 | | CR to 29.002 for the support of the MAP Si interface | 5.3.0 | +| | 18 | N4-021290 | 499 | | Correction to segmentation of O-CSI and T-CSI | 5.4.0 | +| | 18 | N4-021418 | 508 | | ODB correction | 5.4.0 | +| | 18 | N4-021563 | 511 | 1 | Addition of reference number to deferred location request procedure | 5.4.0 | +| | 18 | N4-021573 | 516 | 2 | Correction to the Service Handover parameters | 5.4.0 | +| | 18 | N4-021299 | 442 | 3 | Description of MT SM delivery via two serving nodes | 5.4.0 | +| | 18 | N4-021294 | 474 | 2 | Correction of handling of MT-SMS in the SGSN | 5.4.0 | +| | 18 | N4-021124 | 475 | | ODB and CB for SMS | 5.4.0 | +| | 18 | N4-021153 | 486 | | Correction of IMEI check for SGSN | 5.4.0 | +| | 18 | N4-021467 | 489 | 5 | Available codecs list and selected codec indication | 5.4.0 | +| | 18 | N4-021194 | 490 | | Clarification of the use of Requested CAMEL Subscription Info parameters | 5.4.0 | +| | 18 | N4-021252 | 495 | | Correction to RCH – adding O-CSI trigger criteria | 5.4.0 | +| | 18 | N4-021264 | 496 | | Additional MM-Code for MG-CSI | 5.4.0 | +| | 18 | N4-021296 | 497 | 1 | Additional handling of partial implementations of CAMEL phase 4 | 5.4.0 | +| | 18 | N4-021383 | 512 | | Correction of Codeword Handling | 5.4.0 | +| | 18 | N4-021443 | 513 | | Reference to TS 23.078 in TS 29.002 regarding handling of VMSC address is missing | 5.4.0 | +| | 18 | N4-021524 | 521 | 1 | Editorial clean-up | 5.4.0 | +| | 18 | N4-021531 | 522 | | Introduction of the CHOICE element "netDetNotReachable" for PS-SubscriberState | 5.4.0 | +| | 18 | N4-021260 | 491 | 1 | Addition of LCS Format Indicator to LCS Client ID | 6.0.0 | +| | 18 | N4-021504 | 517 | 2 | Addition of V-GMLC Address to the Update Location and Update GPRS Location requests | 6.0.0 | +| | 18 | N4-021567 | 518 | 3 | Addition of V-GMLC and H-GMLC Addresses to the Send Routing Info for LCS response | 6.0.0 | +| | 18- | N4-021506 | 519 | 2 | Addition of PPR Address to the Send Routing Info for LCS response | 6.0.0 | +| | 19 | N4-030234 | 509 | 3 | Introduction of Call Barring for SMS in PS domain | 6.1.0 | +| | 19 | N4-030325 | 524 | 3 | Clean-up of SMS procedures chapter | 6.1.0 | +| | 19 | NP-030068 | 545 | 2 | Correction to interactions between CAMEL control of MO SMS and barring | 6.1.0 | +| | 19 | N4-030061 | 526 | | Incrementing ASN.1 module versions | 6.1.0 | +| | 19 | N4-030063 | 528 | | LCS diagnostic alignment | 6.1.0 | + +| | | | | | | | +|--|----|------------|-----|---|----------------------------------------------------------------------------------------------------|-------| +| | 19 | N4-030054 | 529 | | Addition of LCS Capability Set 4 | 6.1.0 | +| | 19 | N4-030301 | 533 | 1 | Correction to the definitions of Radio Resource List and BSSMAP Service Handover List | 6.1.0 | +| | 19 | N4-030305 | 541 | 2 | Handover of Group Calls where MSC-B has bearer established | 6.1.0 | +| | 19 | N4-030287 | 551 | 1 | Change of SS-Code List description for Insert Subscriber Data | 6.1.0 | +| | 19 | N4-030289 | 559 | 1 | Missing of "Continue Monitoring message" in SDL 21.7_3.2 | 6.1.0 | +| | 19 | N4-030297 | 563 | 1 | Alignment of TS 29.002 with TS 23.107 regarding QoS subscribed data | 6.1.0 | +| | 19 | N4-030222 | 566 | 1 | Introduction of MSC Number as a new parameter in MAP-SEND-IDENTIFICATION operation | 6.1.0 | +| | 20 | N4-030692 | 536 | 2 | Additional SGSN Related Access Type – Detach | 6.2.0 | +| | 20 | N4-030658 | 568 | 4 | Addition of Positioning Data IE to Provide Subscriber Location and Send Location Report | 6.2.0 | +| | 20 | N4-030638 | 574 | 1 | Provision of SDL diagrams and removal of redundant text in chapter 25 | 6.2.0 | +| | 20 | N4-030713 | 595 | 2 | Removal of redundant text from 29.002 Chapter 23 | 6.2.0 | +| | 20 | N4-030439 | 599 | | LCS Client external ID | 6.2.0 | +| | 20 | N4-030682 | 607 | 1 | Provision of SDL diagrams and removal of redundant text in chapter 22 | 6.2.0 | +| | 20 | N4-030608 | 608 | 1 | Addition of LCS capability sets to MAP_SRI for LCS response | 6.2.0 | +| | 20 | N4-030647 | 612 | 1 | Enhancement of the CheckIMEI operation to retrieve the BMUEF | 6.2.0 | +| | 20 | N4-030678 | 619 | 1 | Correction to naming of PRN parameter | 6.2.0 | +| | 20 | N4-030609 | 624 | 1 | Addition of Privacy Check Related Action to Provide Subscriber Location request | 6.2.0 | +| | 20 | N4-030642 | 610 | 1 | Transfer of UE-specific behaviour bitmap at handover | 6.2.0 | +| | 20 | N4-030601 | 633 | | Missing SMSs over MSC even if the MS is capable of such sending | 6.2.0 | +| | 21 | N4-031043 | 584 | 2 | Correction to MAP Process Secure_MAP_DSM SDLs | 6.3.0 | +| | 21 | N4-031053 | 664 | 1 | Correction of encoding description of Group-Id | 6.3.0 | +| | 21 | N4-030828 | 657 | | Reduce maximum length of "LCS Requestor ID" and "LCS Codeword". | 6.3.0 | +| | 21 | N4-030922 | 647 | 1 | UESBI -IU format | 6.3.0 | +| | 21 | N4-031069 | 616 | 3 | Incorrect Charging with MNP | 6.3.0 | +| | 21 | N4-031057 | 660 | 2 | Notification of the 2nd BSG in case of Late CF with OR | 6.3.0 | +| | 21 | N4-031059 | 614 | 3 | HLR Interrogation for SCUDIF calls | 6.3.0 | +| | 21 | N4-030785 | 644 | | Removal of tables in clause 7.6 | 6.3.0 | +| | 21 | N4-030806 | 649 | | Correction of References | 6.3.0 | +| | 21 | N4-030815 | 648 | | Correction of wrong AC name in the table in 17.1.6 | 6.3.0 | +| | 21 | N4-030824 | 654 | | New LCS Service Types | 6.3.0 | +| | 21 | N4-030951 | 671 | | SS-Barring Category | 6.3.0 | +| | 21 | N4-031006 | 650 | 1 | Add SGSN, GGSN, GMLC, gsmSCF, NPLR and AuC to network resource parameter | 6.3.0 | +| | 21 | N4-0301038 | 645 | 1 | Introduction of North American Interim Location Based Routing of Emergency Call | 6.3.0 | +| | 21 | N4-031065 | 674 | | Positioning Data for UTRAN LCS | 6.3.0 | +| | 21 | N4-030953 | 637 | 1 | Provision of SDL diagrams and removal of redundant text in chapter 19 | 6.3.0 | +| | 21 | N4-030745 | 639 | | Provision of SDL diagrams and removal of redundant text in chapter 20 | 6.3.0 | +| | 21 | N4-030747 | 641 | | Provision of SDL diagrams and removal of redundant text in chapter 21 | 6.3.0 | +| | 21 | N4-030748 | 642 | | Removal of SIWF description | 6.3.0 | +| | 21 | N4-030749 | 643 | | Deletion of redundant Annex D | 6.3.0 | +| | 22 | N4-031098 | 677 | | Enhancements for the Partial Implementation for "Change of position procedure armed with criteria" | 6.4.0 | +| | 22 | N4-031135 | 687 | | Collective CR for Rel-6 Enhanced Dialled Services | 6.4.0 | +| | 22 | N4-031274 | 648 | 2 | Message Segmentation Mechanisms | 6.4.0 | +| | 22 | N4-031315 | 703 | | Addition of requestingPLMN-ID to Send Authentication Info Request | 6.4.0 | +| | 22 | N4-031372 | 680 | 2 | Addition of CGI to LCS procedures | 6.4.0 | +| | 22 | N4-031373 | 696 | 2 | Include v-gmlc parameter in RESTORE DATA MAP message | 6.4.0 | +| | 22 | N4-031365 | 702 | 2 | Deferred MT-LR Area Event | 6.4.0 | +| | 22 | N4-031132 | 686 | | More spare bits for CAMEL4 enhancements | 6.4.0 | +| | 22 | N4-031163 | 692 | | Clarification on D-CSI segmentation | 6.4.0 | +| | 22 | N4-031342 | 676 | 2 | MNP correction for prepaid charging | 6.4.0 | +| | 22 | N4-031338 | 695 | 1 | Remove redundant option for retrieval of routeing information in figure 21.2.3 | 6.4.0 | +| | 22 | N4-031108 | 679 | | Modification of description for conditions on inclusion of Positioning Data | 6.4.0 | +| | 22 | N4-031317 | 689 | 2 | HSDPA impacts to MAP | 6.4.0 | +| | 22 | NP-030533 | 704 | | EXPORT data types to CAP (Change of position armed with criteria) | 6.4.0 | +| | 23 | N4-040310 | 668 | 3 | Codec Modification/ Mid-Call Codec Negotiation after Inter-MSC Relocation | 6.5.0 | +| | 23 | N4-040193 | 670 | 2 | Correction of Inter-MSC SRSN Relocation procedure | 6.5.0 | +| | 23 | N4-040249 | 701 | 3 | Introduction of Presence Stage 3 (Ph, Pc and Pg) to the MAP interface | 6.5.0 | +| | 23 | N4-040333 | 708 | 2 | Correction to Insert Subscriber Data message for LCS SS | 6.5.0 | +| | 23 | N4-040328 | 709 | 1 | SCCP segmentation for Inter PLMN MAP message | 6.5.0 | +| | 23 | N4-040327 | 711 | 2 | Inclusion of UTRAN Positioning Data parameter | 6.5.0 | +| | 23 | N4-040284 | 717 | 1 | Include administrative restriction subscription parameter | 6.5.0 | +| | 23 | N4-040340 | 720 | 2 | Add new Unavailability cause for SCUDIF | 6.5.0 | +| | 23 | N4-040171 | 721 | | CR implemented by fault | 6.5.0 | +| | 23 | N4-040182 | 724 | | Removal of R-GMLC Address | 6.5.0 | +| | 23 | N4-040322 | 725 | 1 | MO-LR Service Identity support | 6.5.0 | +| | 23 | N4-040267 | 726 | 1 | CAMEL4 SCUDIF notification during active call for prepay | 6.5.0 | +| | 24 | N4-040520 | 731 | | Introduction of North American Interim Location Based Routing of | 6.6.0 | + +| | | | | | | +|--|----|-----------|------|---------------------------------------------------------------------------------------|--------| +| | | | | Emergency Call | | +| | 24 | N4-040585 | 735 | Modify IMEI parameter usage definition in MAP-PSL and MAP-SLR | 6.6.0 | +| | 24 | N4-040600 | 736 | Addition of SAI-Present indication to the LCS procedures | 6.6.0 | +| | 24 | N4-040601 | 737 | Clarification on the use of MSISDN parameter for Follow Me functionality | 6.6.0 | +| | 24 | N4-04732 | 734 | 1 Add Additional V-GMLC parameter in MAP-SRI-INFO-FOR-LCS | 6.6.0 | +| | 24 | N4-040736 | 718 | 6 Addition of IMEISV to Update Location Procedure for ADD function | 6.6.0 | +| | 25 | N4-040929 | 739 | Export of UU-Data data type | 6.7.0 | +| | 25 | N4-041021 | 743 | Wrong SDL flow page implemented | 6.7.0 | +| | 25 | N4-041128 | 732 | 2 Pre-Paging Resource Optimization | 6.7.0 | +| | 26 | N4-041272 | 747 | Incorrect Implementation of CR 731 | 6.8.0 | +| | 26 | N4-041477 | 752 | Correction to the service response parameters of ATI | 6.8.0 | +| | 26 | N4-041662 | 746 | 1 Introducing VGCS/VBS ciphering | 6.8.0 | +| | 26 | N4-041683 | 757 | 2 Clarification about returning authentication data for a subscriber (GSM or UMTS) | 6.8.0 | +| | 26 | N4-041684 | 748 | 1 LCS Capability Handling for UE's | 6.8.0 | +| | 26 | N4-041685 | 753 | 1 Enable NA-ESRD Provision from a GMLC for E911 Location in North America | 6.8.0 | +| | 26 | N4-041641 | 740 | 2 SMS Fraud countermeasures | 6.8.0 | +| | 27 | N4-050212 | 749 | 1 Management Based Activation Impacts | 6.9.0 | +| | 27 | N4-050369 | 761 | 1 Addition of LAI to SendIdentification Request | 6.9.0 | +| | 27 | N4-050430 | 760 | 1 Subscribed Charging Characteristics | 6.9.0 | +| | 27 | N4-050444 | 759 | 1 Addition of TCAP-Handshake for MO-ForwardSM | 6.9.0 | +| | 27 | N4-050446 | 745 | 2 Introduction of Hop Counter for Send Identification | 6.9.0 | +| | 27 | N4-050463 | 738 | 8 Rel-6 trace management additions to trace activation and deactivation procedures | 6.9.0 | +| | 27 | N4-050467 | 763 | 2 Pseudonym indicator support in MO-LR | 6.9.0 | +| | 28 | C4-050737 | 769 | 1 Correction to Trace parameters to allow trace at the BM-SC | 6.10.0 | +| | 28 | C4-050832 | 770 | 6 Full RANAP support of network initiated SCUDIF | 6.10.0 | +| | 28 | C4-050895 | 766 | 2 Clarification on the use of Access Restriction Data parameter | 6.10.0 | +| | 28 | C4-050784 | 765 | 1 Addition of CollectInformation procedure to OfferedCAMEL4Functionalities | 7.0.0 | +| | 29 | C4-051013 | 771 | ASN.1 module version update | 7.1.0 | +| | 29 | C4-051295 | 776 | 2 Enabling the Providing of Velocity | 7.1.0 | +| | 29 | C4-051333 | 772 | 1 Support of talker priorities and talker identity presentation | 7.1.0 | +| | 29 | C4-051334 | 773 | 1 Delivery of SMS to voice group call | 7.1.0 | +| | 29 | C4-051368 | 777 | 2 CS data Mobile Terminating calls from PSTN | 7.1.0 | +| | 29 | C4-051336 | 780 | 2 Correction on misalignment with stage 2 for Location Services | 7.1.0 | +| | 30 | C4-051775 | 783 | 2 Addition of UMTS Trace parameters to handover procedure | 7.2.0 | +| | 31 | C4-060320 | 794 | 1 Addition of UMTS Trace parameters to handover procedure | 7.3.0 | +| | 31 | C4-060295 | 790 | 1 Removal of MAPsec material | 7.3.0 | +| | 31 | C4-060315 | 787 | 1 addition of "supported RAT types indicator" during location/routing area update | 7.3.0 | +| | 31 | C4-060378 | 792 | 1 Addition of Periodic Location Feature Support | 7.3.0 | +| | 31 | C4-060434 | 781 | 3 New LocationType for the notification based on current location of target UE | 7.3.0 | +| | 31 | C4-060318 | 788 | 1 SMS Relay Application Context Names for Version 1 | 7.3.0 | +| | 31 | C4-060041 | 789 | Precision on segmentation of MAP GPRSSubscriptionData parameter | 7.3.0 | +| | 31 | C4-060250 | 801 | Improvements to VGCS Call Establishment | 7.3.0 | +| | 31 | C4-060011 | 786 | Addition of Authentication Domains in MAP Send Authentication Info | 7.3.0 | +| | 32 | C4-060813 | 0808 | 2 List of MSISDNs and Basic Service Code for MAP Any Time Subscription Interrogation. | 7.4.0 | +| | 32 | C4-060499 | 0803 | Correction of LCS parameter for emergency call usage | 7.4.0 | +| | 32 | C4-060680 | 0814 | SSN for FFN | 7.4.0 | +| | 32 | C4-060706 | 0817 | Removal of MAPsec material | 7.4.0 | +| | 33 | CP-060522 | 0818 | 1 Removal of ASN.1 Expanded Source | 7.5.0 | +| | 33 | C4-061047 | 0805 | 1 Interoperability between VBS/VGCS and RANflex | 7.5.0 | +| | 34 | CP-060741 | 0795 | 1 Support of SMS over IP networks | 7.6.0 | +| | 34 | C4-061800 | 0828 | 1 Extension of Group ID | 7.6.0 | +| | 34 | C4-061633 | 0829 | Addition of Teleservice Code to SendGroupCallInfo | 7.6.0 | +| | 34 | C4-061775 | 0834 | Accuracy Fulfillment Indicator parameter to MAP SLR for deferred MT-LR | 7.6.0 | +| | 34 | C4-060693 | 0832 | 2 Optional Suppress Terminating Services Bit String in SRI | 7.6.0 | +| | 34 | C4-061632 | 0807 | 2 Introduction of sending application-specific data to group call members | 8.0.0 | +| | 35 | C4-070140 | 0843 | ASN.1 module version update | 8.1.0 | +| | 35 | C4-070097 | 0837 | Corrections to RAB Configuration Indicator and lu-Selected codec | 8.1.0 | +| | 35 | C4-070229 | 0840 | Addition of capability to route MT-SMs via the HPLMN of the receiving MS | 8.1.0 | +| | 36 | C4-070388 | 0849 | Mobile Termination whilst the MS is moving to another MSC | 8.2.0 | +| | 36 | C4-070394 | 0842 | 2 Addition of SMS over IP functionality | 8.2.0 | +| | 36 | CP-070476 | 0859 | Detailed procedure in the IP-SM-GW | 8.2.0 | +| | 37 | C4-071055 | 0862 | QoS Extension | 8.3.0 | +| | 37 | C4-071072 | 0863 | Talker Channel Parameter | 8.3.0 | +| | 37 | C4-071266 | 0869 | LMSI For MT-SMS | 8.3.0 | +| | 37 | C4-071281 | 0873 | 1 NPI for the call forwarding to number | 8.3.0 | +| | 37 | C4-071285 | 0864 | 1 Limit on number of concurrent MT-LR location requests | 8.3.0 | +| | 37 | C4-071383 | 0868 | 2 Corrections to SMS over IP handling | 8.3.0 | + +| | | | | | | | +|--|----|-----------|------|---|--------------------------------------------------------------------------------------------------------------------------|--------| +| | 38 | C4-071724 | 0876 | | TCRT: Clarification on coding of Notification Data | 8.4.0 | +| | 38 | C4-071815 | 0879 | | Removal of CCBS_Call_Report_Ack and Event_Report_Ack | 8.4.0 | +| | 38 | C4-071855 | 0881 | | Restriction on the use of ccbs-A SS indication | 8.4.0 | +| | 38 | C4-071891 | 0877 | 3 | SMS Router Optimization | 8.4.0 | +| | 38 | C4-071997 | 0875 | 1 | Behaviour of the IP-SM-GW for SM Delivery Status Report | 8.4.0 | +| | 39 | C4-080267 | 0885 | | Updating of RAT Types | 8.5.0 | +| | 39 | C4-080148 | 0883 | | SDL correction for procedure Check_Available_Vectors | 8.5.0 | +| | 39 | C4-080532 | 0886 | 2 | HLR involvement in SMS Router Optimization | 8.5.0 | +| | 40 | C4-081277 | 0888 | 1 | Extension of Group ID | 8.6.0 | +| | 40 | C4-080647 | 0882 | 1 | Paging optimization with A/lu flex | 8.6.0 | +| | 41 | C4-081730 | 0890 | | Addition of IMS Centralized Service subscription information | 8.7.0 | +| | 41 | C4-082447 | 0891 | 1 | eMLPP Priority in MAP SRI, PRN and PSI request | 8.7.0 | +| | 41 | C4-082335 | 0892 | 1 | Gr+ enhancements for EPS | 8.7.0 | +| | 42 | C4-082721 | 0894 | | Gr alignment | 8.8.0 | +| | 42 | C4-082758 | 0896 | | RAT Frequency Selection Priority | 8.8.0 | +| | 42 | C4-083029 | 0899 | | Change in AMBR placement | 8.8.0 | +| | 42 | C4-083221 | 0901 | | PDN-GW-Identity | 8.8.0 | +| | 42 | C4-083223 | 0902 | | APN-OIReplacement | 8.8.0 | +| | 42 | C4-083247 | 0903 | | Access Restriction | 8.8.0 | +| | 42 | CP-080706 | 0906 | 1 | Access Restriction Data Handling | 8.8.0 | +| | 42 | Cp-080771 | 0895 | 4 | Closed Subscriber Group | 8.8.0 | +| | 42 | | | | SDL files added in Zip-file | 8.8.1 | +| | 43 | C4-090140 | 0908 | | Context Identifier for Update or Removal of PDN GW | 8.9.0 | +| | 43 | C4-090269 | 0911 | | Handling LCS Subscription Data | 8.9.0 | +| | 43 | C4-090507 | 0914 | | PDN GW Update for Wildcard APN | 8.9.0 | +| | 43 | C4-090701 | 0909 | 1 | Ready for SM | 8.9.0 | +| | 43 | C4-090855 | 0915 | | Handling SMS Subscription Data | 8.9.0 | +| | 43 | C4-090889 | 0916 | | Allocation Retention Priority Definition | 8.9.0 | +| | 44 | C4-091071 | 0919 | | SMS over IP | 8.10.0 | +| | 44 | C4-091028 | 0917 | | MAP RESTORE DATA service | 8.10.0 | +| | 44 | C4-091377 | 0921 | 1 | Subscription Data Clarification for MAP Interface | 8.10.0 | +| | 44 | C4-091429 | 0920 | 1 | Trace | 8.10.0 | +| | 44 | C4-091435 | 0922 | 1 | Supported Features | 8.10.0 | +| | 44 | CP-090379 | 0923 | 1 | User Data Download | 8.10.0 | +| | 45 | C4-091713 | 0924 | | Notification of SMS over IP Non-Delivery for E-UTRAN and UE Reachability | 8.11.0 | +| | 45 | C4-092244 | 0927 | | SGSN interface list for trace | 8.11.0 | +| | 45 | C4-092254 | 0925 | 2 | Cancel Location for Initial Attach | 8.11.0 | +| | 45 | C4-092291 | 0929 | | Fix APN-Configuration to support dual IP addresses | 8.11.0 | +| | 46 | C4-094140 | 0941 | 1 | Alignment of specifications on Usage of MAP_SEND_AUTHENTICATION_INFO | 8.12.0 | +| | 46 | C4-093972 | 0942 | 1 | SMS over SGs charging | 8.12.0 | +| | 46 | C4-094136 | 0936 | 1 | Subscription to Notification of UE Reachability | 8.12.0 | +| | 46 | C4-093588 | 0935 | 1 | Evolved ARP | 9.0.0 | +| | 46 | C4-093294 | 0932 | 2 | APN level APN-OI-Replacement | 9.0.0 | +| | 46 | C4-093221 | 0933 | 1 | ICS-Flag | 9.0.0 | +| | 47 | C4-100386 | 0949 | | Correction to the location information EPS IE | 9.1.0 | +| | 47 | C4-101003 | 0951 | 1 | User CSG Information for CAMEL | 9.1.0 | +| | 47 | C4-100946 | 0945 | 2 | Support of Location Continuity on the Lg Interface | 9.1.0 | +| | 47 | C4-100947 | 0958 | 2 | Enhancement of MAP-SEND-ROUTING-INFO-FOR-LCS Service for EPS | 9.1.0 | +| | 47 | C4-100264 | 0943 | | Evolved ARP Corrections | 9.1.0 | +| | 47 | C4-100920 | 0928 | 4 | AoIP – MAP level codec negotiation for GSM codecs | 9.1.0 | +| | 47 | C4-100265 | 0944 | | Dual Stack support in GPRS | 9.1.0 | +| | 47 | C4-100353 | 0939 | 2 | Support MT Roaming Retry on Pre-paging | 9.1.0 | +| | 47 | C4-100892 | 0954 | 1 | TCRT: Uplink reply procedure | 9.1.0 | +| | 47 | C4-100881 | 0956 | 1 | TADS support in MAP | 9.1.0 | +| | 47 | C4-101010 | 0950 | 1 | UE-AMBR in GPRS Subscription | 9.1.0 | +| | 47 | CP-100234 | 0960 | | Incorrect KASME length | 9.1.0 | +| | 47 | CP-100203 | 0952 | 5 | EPS Subscriber State and Location Information Request | 9.1.0 | +| | 48 | C4-101236 | 0971 | | CR implementation CR 642 | 9.2.0 | +| | 48 | C4-101403 | 0963 | 1 | Correction to missing GANSS position data in Provide Subscriber Location and Provide Subscriber Location Report services | 9.2.0 | +| | 48 | C4-101400 | 0967 | 1 | Tracking Area Identity Length | 9.2.0 | +| | 48 | C4-101131 | 0961 | | ASN.1 Module Version Update | 9.2.0 | +| | 48 | C4-101135 | 0962 | | EPS state and location retrieval | 9.2.0 | +| | 49 | C4-101802 | 0975 | 1 | Sending of MME name or SGSN Number to the VLR during the data restoration procedure | 9.3.0 | +| | 49 | C4-101805 | 0977 | 1 | Data Restoration for SMS | 9.3.0 | +| | 49 | C4-102251 | 0966 | 3 | MAP SRI Return Error message | 9.3.0 | +| | 49 | C4-102269 | 0985 | 1 | EPS Subscription Data over Gr | 9.3.0 | +| | 49 | C4-102376 | 0980 | 3 | RP-OA modification in SMS Router | 9.3.0 | +| | 49 | C4-101809 | 0976 | 1 | Addition of SIPTO permissions in PS subscription data | 10.0.0 | +| | 49 | C4-102250 | 0957 | 4 | Prevention of Timeout in IP-SM-GW | 10.0.0 | + +| | | | | | | | +|--|----|-----------|------|---|---------------------------------------------------------------------------------------------------------------|--------| +| | 49 | CP-100608 | 0979 | 2 | Addition of SS codes to the ATSI and ATM procedures | 10.0.0 | +| | 50 | C4-103099 | 0990 | 2 | locationInformationEPS in Subscriber Info response | 10.1.0 | +| | 50 | C4-102699 | 0988 | 1 | Removal of MAP Update GPRS Location message during detach or last PDN connection deactivation via 3GPP access | 10.1.0 | +| | 50 | C4-102737 | 0993 | 1 | URRP for SGSN | 10.1.0 | +| | 50 | C4-103156 | 1005 | | Location data including only serving node address | 10.1.0 | +| | 50 | C4-103157 | 0997 | 2 | Correction to ATM for call waiting | 10.1.0 | +| | 50 | C4-103314 | 1002 | 2 | Periodic TAU/RAU timer in HSS subscription | 10.1.0 | +| | 50 | C4-102614 | 0991 | | ASN.1 module version upgrade | 10.1.0 | +| | 50 | C4-102687 | 0987 | 1 | Addition of MPS Priority in Subscription Data | 10.1.0 | +| | 50 | C4-102809 | 0986 | 1 | Addition of LIPA permission in Subscription Data | 10.1.0 | +| | 51 | C4-110389 | 1006 | 2 | UE SRVCC Capability Support in MAP Message | 10.2.0 | +| | 51 | C4-110292 | 1008 | 1 | Use of recovered MME Name / SGSN Name in MSC/VLR | 10.2.0 | +| | 51 | C4-110133 | 1009 | | Zone Code Propagation at Handover | 10.2.0 | +| | 51 | C4-110665 | 1016 | | Retrieval of T-ADS data via MAP ATI | 10.2.0 | +| | 51 | C4-110759 | 1018 | 1 | Mobile Terminating Roaming Forwarding | 10.2.0 | +| | 51 | C4-110778 | 1007 | 2 | Minimization of Drive Tests (MDT) | 10.2.0 | +| | 51 | C4-110793 | 1015 | 1 | Introduction of LCLS functionality in TS 29.002 | 10.2.0 | +| | 51 | C4-110958 | 1017 | 2 | Enhancements of T-ADS data retrieval via MAP ATI | 10.2.0 | +| | 52 | C4-111112 | 1024 | | Correction on Subscriber Data Withdrawal | 10.3.0 | +| | 52 | C4-111611 | 1030 | 2 | Missing MME Name in EPS Location Information | 10.3.0 | +| | 52 | C4-111534 | 1020 | 1 | MDT user consent | 10.3.0 | +| | 52 | C4-111567 | 1021 | 1 | SC Address in IP-SM-GW Register Response | 10.3.0 | +| | 52 | C4-111402 | 1025 | 1 | Periodic LAU timer in HSS subscription | 10.3.0 | +| | 52 | C4-111414 | 1026 | 1 | New LMSI handling for MTRF | 10.3.0 | +| | 52 | C4-111416 | 1029 | 1 | Addition of VMSC Address in PRN Ack | 10.3.0 | +| | 53 | C4-112067 | 1047 | | Use of UE-Reachability by SGSN | 10.4.0 | +| | 53 | C4-112081 | 1042 | 1 | APN-AMBR for GPRS | 10.4.0 | +| | 53 | C4-112096 | 1033 | 1 | MTRF and Super Charger interactions | 10.4.0 | +| | 53 | C4-111986 | 1043 | | ASN.1 exports for 32.298 | 11.0.0 | +| | 53 | C4-112033 | 1032 | 1 | Addition of Anonymous Call Rejection in the CS domain | 11.0.0 | +| | 53 | C4-112209 | 1037 | 2 | Add vSRVCC updates to the Gr interface | 11.0.0 | +| | 53 | C4-112222 | 1040 | 2 | MAP-READY-FOR-SM for IP-SM-GW | 11.0.0 | +| | 54 | C4-112930 | 1053 | 1 | Provide Subscriber Information handling for UE under LTE | 11.1.0 | +| | 54 | C4-112988 | 1063 | | PDN-Type | 11.1.0 | +| | 54 | C4-112990 | 1056 | 1 | Equivalent PLMN CSG Subscription Request | 11.1.0 | +| | 54 | C4-113037 | 1055 | 2 | LCLS negotiation MAP update | 11.1.0 | +| | 54 | C4-112464 | 1039 | 4 | Cancellation type initial attach | 11.1.0 | +| | 55 | C4-120406 | 1064 | 1 | Initial Attach Indication in MAP_CANCEL_LOCATION | 11.2.0 | +| | 55 | C4-120420 | 1073 | 1 | Removal of Subscribed Periodic TAU/RAU timer in HSS subscription | 11.2.0 | +| | 55 | C4-120528 | 1072 | 2 | User Unknown Error in Provide Subscriber Info MAP operation | 11.2.0 | +| | 55 | C4-120224 | 1066 | | UE reachability | 11.2.0 | +| | 55 | C4-120322 | 1070 | | TC-RT: Introduction of group IDs with prefix | 11.2.0 | +| | 55 | C4-120416 | 1067 | 1 | CSG subscription data propagation | 11.2.0 | +| | 55 | C4-120423 | 1069 | 1 | Trace Depth | 11.2.0 | +| | 56 | C4-120707 | 1078 | | Editorial corrections to TS 29.002 | 11.3.0 | +| | 56 | C4-120713 | 1079 | | Equivalent PLMN CSG Subscription Request for CS | 11.3.0 | +| | 56 | C4-120732 | 1080 | | EPS location in MAP Note MM Event | 11.3.0 | +| | 56 | C4-120959 | 1065 | 3 | CSG ID and Local Time for NPLI | 11.3.0 | +| | 56 | C4-121086 | 1082 | | Clarification on HLR procedure for SMS delivery via IP-SM-GW | 11.3.0 | +| | 56 | C4-121222 | 1059 | 4 | Procedures for Update VCSG Location service | 11.3.0 | +| | 56 | C4-121223 | 1049 | 9 | Retrieving CSG subscription data from the CSS to the VLR/SGSN | 11.3.0 | +| | 56 | C4-121227 | 1060 | 5 | CSG Data Management in the VPLMN | 11.3.0 | +| | 57 | C4-121465 | 1089 | - | TC RT: Number of Dispatcher extension | 11.4.0 | +| | 57 | C4-121635 | 1088 | 1 | Check IMEI Error | 11.4.0 | +| | 57 | C4-121805 | 1092 | 2 | Local Time Zone | 11.4.0 | +| | 57 | C4-121534 | 1084 | 1 | IMSI in MAP-MO-FORWARD-SHORT-MESSAGE | 11.4.0 | +| | 57 | C4-121817 | 1068 | 5 | PS additional number | 11.4.0 | +| | 57 | C4-121813 | 1090 | 2 | SRI for SM and MME Diameter address | 11.4.0 | +| | 57 | C4-121802 | 1091 | 2 | MSISDN-less MT-SMS | 11.4.0 | +| | 57 | C4-121625 | 1083 | 1 | PS only subscription w/o MSISDN | 11.4.0 | +| | 57 | C4-121809 | 1077 | 4 | SMS in MME/SGSN | 11.4.0 | +| | 57 | C4-121648 | 1085 | 1 | CSS Reset Procedures | 11.4.0 | +| | 57 | C4-121650 | 1086 | 2 | Temporary empty CSG subscription data | 11.4.0 | +| | 58 | C4-122660 | 1106 | 4 | Clarification on EPS Info | 11.5.0 | +| | 58 | C4-122497 | 1108 | 1 | Pdp Type | 11.5.0 | +| | 58 | C4-122164 | 1093 | 1 | Trace Depth extension | 11.5.0 | +| | 58 | C4-121847 | 1094 | | AC version for Reset | 11.5.0 | +| | 58 | C4-122469 | 1095 | 4 | MSISDN-less UEs | 11.5.0 | +| | 58 | C4-122476 | 1096 | 3 | T4 Device Trigger via IMS | 11.5.0 | +| | 58 | C4-122187 | 1097 | 2 | T4 Trigger indication to IP-SM-GW | 11.5.0 | +| | 58 | C4-122190 | 1098 | 2 | Add Diameter Addresses to MT-SMS target node registrations | 11.5.0 | +| | 58 | C4-121870 | 1099 | | IMSI in AbsentSubscriberSM-param | 11.5.0 | + +| | | | | | | | +|---------|-------|-----------|------|---|-------------------------------------------------------------------------------------------------------|--------| +| | 58 | C4-122165 | 1101 | 1 | Handling of current security context during inter-VLR location update | 11.5.0 | +| | 59 | C4-130330 | 1118 | 1 | SGSN acting on access restriction e-utranNotAllowed | 11.6.0 | +| | 59 | C4-130293 | 1119 | 1 | Registration for SMS Request for SMS in SGSN | 11.6.0 | +| | 59 | C4-130305 | 1120 | 1 | MDT parameters | 11.6.0 | +| | 59 | C4-130335 | 1121 | 1 | Providing Diameter identity of the SGSN to the GMLC over Lh interface | 12.0.0 | +| | 59 | C4-130340 | 1122 | 1 | SGSN indicating support of Lgd interface and providing its Diameter identity to HLR over Gr interface | 12.0.0 | +| | 59 | C4-130423 | 1123 | 2 | Validity Time of Short Message | 12.0.0 | +| | 59 | C4-130256 | 1114 | | Mobile Terminating call pending flag in MAP Send Identification response | 12.0.0 | +| | 60 | C4-131046 | 1147 | 2 | Subscribed RFSP index for Gn SGSNs | 12.1.0 | +| | 60 | C4-131061 | 1142 | 3 | MME identity for restoration procedures | 12.1.0 | +| | 60 | C4-130603 | 1128 | | Explicit T4-Trigger Indicator in SRI-SM | 12.1.0 | +| | 60 | C4-130929 | 1126 | 1 | Restoration Priority during SGW and PGW restoration procedures | 12.1.0 | +| | 60 | CP-130379 | 1132 | 3 | SIPTO permission for Local Network enhancements | 12.1.0 | +| | 60 | C4-130859 | 1131 | 1 | Clarification on RNC ID value | 12.1.0 | +| | 60 | C4-130979 | 1129 | 1 | Storing Last known Location Information of purged UE in HSS | 12.1.0 | +| | 60 | C4-131040 | 1135 | 2 | Maximum value for subscribed periodic timers | 12.1.0 | +| | 61 | C4-131488 | 1158 | 2 | Addition of Missing Supported Features | 12.2.0 | +| | 61 | C4-131261 | 1160 | | ASN.1 module version update | 12.2.0 | +| | 61 | C4-131540 | 1149 | 1 | Returning to former LTE PLMN after CSFB | 12.2.0 | +| | 61 | C4-131398 | 1152 | 2 | Complements for Gdd support | 12.2.0 | +| | 61 | C4-131445 | 1153 | 1 | GERAN Iu Mode | 12.2.0 | +| | 61 | C4-131478 | 1150 | 2 | CancelLocation requesting reattach | 12.2.0 | +| | 61 | C4-131529 | 1161 | | Enforcing access restriction during I-RAT RAU/TAU procedures | 12.2.0 | +| | 61 | C4-131370 | 1130 | 2 | SMS for IMS UE to IMS UE without MSISDN | 12.2.0 | +| | 62 | C4-131758 | 1162 | 1 | Addition of a reference to TS 23.018 for MTRF optimal routing | 12.3.0 | +| | 62 | C4-131759 | 1163 | 1 | Removal of Editor's Notes for Single-shot SM | 12.3.0 | +| | 62 | C4-131764 | 1165 | 1 | Clarification on Serving Node for SMS | 12.3.0 | +| | 62 | C4-132011 | 1167 | | MME Initiated Removal of MME Registration for SMS | 12.3.0 | +| | 62 | C4-132125 | 1169 | 1 | Update of Homogeneous Support of IMS Voice Over PS Sessions | 12.3.0 | +| | 62 | C4-132202 | 1171 | 1 | Time Zone retrieval from a Gn/Gp-SGSN | 12.3.0 | +| | 63 | C4-140243 | 1174 | 1 | Addition of SGSN CAMEL Capability to SupportedFeatures | 12.4.0 | +| | 64 | C4-140515 | 1177 | | CS to PS SRVCC | 12.5.0 | +| | 64 | C4-140897 | 1179 | | Indication of IMEISV during Inter- MSC Handover | 12.5.0 | +| | 65 | C4-141526 | 1181 | 1 | P-CSCF Restoration Indication | 12.6.0 | +| | 65 | C4-141653 | 1182 | 1 | Closing TS 29.234 and reused AVP in TS 29.273 | 12.6.0 | +| | 66 | C4-141778 | 1183 | 1 | MDT PLMN List | 12.7.0 | +| | 66 | C4-142039 | 1187 | 1 | WLAN offloadability for MAP | 12.7.0 | +| | 68 | C4-150647 | 1188 | 1 | Access restriction per VPLMN | 13.0.0 | +| | 68 | C4-150880 | 1190 | | Access Restriction Data per PLMN | 13.0.0 | +| | 69 | C4-151177 | 1191 | | ASN.1 module version update | 13.1.0 | +| | 70 | C4-151631 | 1194 | | Reference Correction | 13.2.0 | +| | 70 | C4-151813 | 1192 | 1 | Introducing IMSI-Group ID Lists to the insert subscriber data | 13.2.0 | +| | 70 | C4-151801 | 1195 | 1 | Retrieval of "UE Usage Type" over MAP-Gr | 13.2.0 | +| | 70 | C4-152198 | 1196 | 1 | Positioning enhancement impacts on MAP protocol | 13.2.0 | +| | 70 | CP-150868 | 1198 | 2 | Mobile Terminating SMS handling for extended Idle mode DRX – Additional Option | 13.2.0 | +| | 70 | CP-150869 | 1197 | 2 | Mobile Terminating SMS handling for extended Idle mode DRX | 13.2.0 | +| | 71 | C4-161271 | 1202 | 1 | Alert procedure from MME/SGSN to SMS-GMSC for MT SMS to UE using eDRX | 13.3.0 | +| | 71 | C4-161062 | 1200 | | Requested Retransmission Time in MT-Forward-SM response | 13.3.0 | +| | 71 | C4-161527 | 1205 | 2 | New PDN-Type for Cellular IoT | 13.3.0 | +| | 71 | C4-161492 | 1204 | 2 | Addition of NB-IoT radio access type to the Access-Restriction-Data feature | 13.3.0 | +| | 71 | C4-161161 | 1203 | | Time Zone in MAP-Any-Time-Interrogation | 13.3.0 | +| | 71 | C4-161317 | 1201 | 1 | User Plane Integrity Protection Indicator | 13.3.0 | +| | 72 | C4-162090 | 1213 | | Clause Numbering | 13.4.0 | +| | 72 | C4-163271 | 1215 | 3 | Group-Service-Id | 13.4.0 | +| 2016-06 | CT#72 | CP-160217 | 1216 | 1 | Use of recovered MME Name / SGSN Name in MSC/VLR | 14.0.0 | +| 2016-06 | CT#72 | CP-160217 | 1214 | 1 | Zone Code Propagation at Handover | 14.0.0 | +| 2016-09 | CT#73 | CP-160430 | 1219 | | Retrieval of T-ADS data via MAP ATI | 14.1.0 | +| 2016-09 | CT#73 | CP-160583 | 1218 | 2 | Mobile Terminating Roaming Forwarding | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 1221 | 1 | Minimization of Drive Tests (MDT) | 14.1.0 | +| 2016-12 | CT#74 | CP-160667 | 1225 | 1 | Introduction of LCLS functionality in TS 29.002 | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 1229 | 1 | Enhancements of T-ADS data retrieval via MAP ATI | 14.2.0 | +| 2016-12 | CT#74 | CP-160659 | 1227 | | Correction on Subscriber Data Withdrawal | 14.2.0 | +| 2016-12 | CT#74 | CP-160683 | 1230 | 3 | Missing MME Name in EPS Location Information | 14.2.0 | +| 2016-12 | CT#74 | CP-160657 | 1233 | | MDT user consent | 14.2.0 | +| 2016-12 | CT#74 | CP-160683 | 1231 | 1 | SC Address in IP-SM-GW Register Response | 14.2.0 | +| 2017-03 | CT#75 | CP-170034 | 1236 | | T4 Triggering | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 1234 | 1 | Enhanced Coverage | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 1235 | 1 | Inter-RAT PDN-Continuity | 14.3.0 | +| 2017-03 | CT#76 | CP-171039 | 1237 | - | T-ADS info retrieval | 15.0.0 | +| 2017-09 | CT#77 | CP-172021 | 1239 | - | ASN.1 module version update | 15.1.0 | + +| | | | | | | | +|---------|--------|-----------|------|---|----------------------------------------------------------------------|--------| +| 2017-12 | CT#78 | CP-173016 | 1243 | 2 | Correction on subscribed eDRX parameter value | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1240 | - | Access Restrictions to NR as Secondary RAT | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 1241 | - | Extended Qos | 15.2.0 | +| 2018-03 | CT#79 | CP-180027 | 1244 | 2 | Access restriction to unlicensed spectrum as secondary RAT | 15.3.0 | +| 2018-10 | | | | | Cover page version number was corrected | 15.3.1 | +| 2018-12 | CT#82 | C4-187638 | 1245 | 2 | Location Information used by IM-SSF in 5G | 15.4.0 | +| 2019-06 | CT#84 | CP-191020 | 1249 | | ASN.1 corrections | 15.5.0 | +| 2019-06 | CT#84 | CP-191058 | 1250 | 1 | SMSF Address | 15.5.0 | +| 2020-03 | CT#87 | CP-200049 | 1253 | | Correction on Location Information used by IM-SSF in 5G | 15.6.0 | +| 2020-03 | CT#87 | CP-200027 | 1251 | 3 | Addition of IAB operation permission to subscriber data | 16.0.0 | +| 2020-12 | CT#90e | CP-203027 | 1255 | | Inform SC | 16.1.0 | +| 2020-12 | CT#90e | CP-203027 | 1257 | | SMSF parameter description | 16.1.0 | +| 2021-03 | CT#91e | CP-210053 | 1260 | | Correction on length of 5GS TAI | 16.2.0 | +| 2021-03 | CT#91e | CP-210036 | 1261 | | Clarification for dummy Network Node Number | 17.0.0 | +| 2021-03 | CT#91e | CP-210036 | 1259 | 1 | Support of MAP messages at the UDM for SMS in 5GS | 17.0.0 | +| 2021-06 | CT#92e | CP-211075 | 1263 | | ASN.1 module version update | 17.1.0 | +| 2021-06 | CT#92e | CP-211319 | 1265 | | Misimplemented CR on Inclusive language review: EIR lists | 17.1.0 | +| 2022-06 | CT#96 | CP-221045 | 1266 | - | 3GPP TS 23.107 missing in clause 2 | 17.2.0 | +| 2023-06 | CT#100 | CP-231075 | 1267 | 1 | Missing finer periodicities than 1s and an infinite reporting amount | 17.3.0 | +| 2023-09 | CT#101 | CP-232075 | 1270 | 1 | Missed LCS QoS Class | 17.4.0 | +| 2023-09 | CT#101 | CP-232058 | 1268 | - | ASN.1 module version update | 18.0.0 | + +5217 \ No newline at end of file diff --git a/gsma/29_series/29061/raw.md b/gsma/29_series/29061/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..6427a342243946ca8cfc12ad1e64d175209d3c41 --- /dev/null +++ b/gsma/29_series/29061/raw.md @@ -0,0 +1,7134 @@ + + +# 3GPP TS 29.061 V18.1.0 (2023-06) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN) (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above it and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +UMTS, GSM, LTE, packet mode, interworking, +PLMN, PDN + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles – Sophia Antipolis +Valbonne – France +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Abbreviations ..... | 14 | +| 3.3 Symbols..... | 15 | +| 4 Network characteristics..... | 16 | +| 4.1 Key characteristics of PLMN..... | 16 | +| 4.2 Key characteristics of PSDN..... | 16 | +| 4.3 Key characteristics of IP Networks..... | 16 | +| 5 Interworking Classifications ..... | 16 | +| 5.1 Service Interworking..... | 16 | +| 5.2 Network Interworking..... | 16 | +| 5.3 Numbering and Addressing..... | 16 | +| 6 Access reference configuration..... | 17 | +| 6.1 General ..... | 17 | +| 6.2 Access Interfaces and Reference Points for non-EPC based Packet Domain..... | 17 | +| 6.3 Access Interfaces and Reference Points for EPC based Packet Domain ..... | 17 | +| 7 Interface to Packet Domain Bearer Services..... | 18 | +| 7.1 A/Gb mode ..... | 18 | +| 7.2 Iu mode..... | 18 | +| 7.3 Interface to EPC-based Packet Domain Bearer Services ..... | 18 | +| 8 Subscription checking..... | 19 | +| 8A Prevention of IP spoofing ..... | 19 | +| 9 Message Screening..... | 19 | +| 10 Interworking with PSDN (X.75/X.25)..... | 19 | +| 11 Interworking with PDN (IP) ..... | 19 | +| 11.1 General ..... | 19 | +| 11.2 PDN Interworking Model..... | 19 | +| 11.2.1 Access to Internet, Intranet or ISP through Packet Domain..... | 21 | +| 11.2.1.1 Transparent access to the Internet..... | 21 | +| 11.2.1.2 IPv4 Non Transparent access to an Intranet or ISP ..... | 22 | +| 11.2.1.2.1 non-EPC based IPv4 Non Transparent access ..... | 22 | +| 11.2.1.2.2 EPC based IPv4 Non Transparent access..... | 25 | +| 11.2.1.3 IPv6 Non Transparent access to an Intranet or ISP ..... | 28 | +| 11.2.1.3.1 IPv6 PDP Context Activation ..... | 28 | +| 11.2.1.3.1a IPv6 EPC based Bearer Activation ..... | 31 | +| 11.2.1.3.2 IPv6 Stateless Address Autoconfiguration..... | 34 | +| 11.2.1.3.2a IPv6 Stateless Address Autoconfiguration for EPC ..... | 35 | +| 11.2.1.3.3 IPv6 Stateful Address Autoconfiguration ..... | 38 | +| 11.2.1.3.4 IPv6 Router Configuration Variables..... | 38 | +| 11.2.1.3.5 IPv6 Prefix Delegation via DHCPv6 ..... | 39 | +| 11.2.1.4 Access to Internet, Intranet or ISP with Mobile IPv4..... | 39 | +| 11.2.1.5 IP Fragmentation Across Gi/Sgi ..... | 42 | +| 11.2.1.6 Support for CUPS across SGi..... | 42 | +| 11.2.1.7 Support L2TP for CUPS across SGi..... | 43 | +| 11.2.2 Access to networks handling Non-IP data services through Packet Domain..... | 45 | +| 11.3 Numbering and Addressing..... | 46 | +| 11.4 Charging..... | 47 | + +| | | | +|------------|-------------------------------------------------------------------------------------|----| +| 11.5 | Domain Name System Server (DNS Server) ..... | 47 | +| 11.6 | Screening..... | 47 | +| 11.7 | IP Multicast access ..... | 47 | +| 11.8 | Non-IP data transfering over SGi..... | 48 | +| 11.8.1 | General ..... | 48 | +| 11.8.2 | Gi/SGi PtP tunnelling based on UDP/IP ..... | 48 | +| 11.8.3 | Other SGi PtP tunnelling mechanisms ..... | 50 | +| 11.9 | Transport Level Marking ..... | 50 | +| 12 | Interworking with PDN (PPP) ..... | 50 | +| 12.1 | General ..... | 50 | +| 12.2 | PDN Interworking Model..... | 50 | +| 12.2.1 | Virtual dial-up- and direct Access to PDNs, or ISPs through Packet Domain..... | 51 | +| 12.2.1.1 | Procedural description ..... | 52 | +| 13 | Interworking with PDN (DHCP) ..... | 53 | +| 13.1 | General ..... | 53 | +| 13.2 | PDN Interworking Model of GGSN for DHCP ..... | 54 | +| 13.2.1 | Address allocation by the Intranet or ISP..... | 55 | +| 13.2.1.1 | Address allocation using DHCPv4..... | 55 | +| 13.2.1.2 | Void. .... | 56 | +| 13.2.2 | Other configuration by the Intranet or ISP (IPv6 only)..... | 56 | +| 13.3 | PDN Interworking Model of P-GW..... | 57 | +| 13.3.1 | Address allocation by the Intranet or ISP..... | 58 | +| 13.3.1.1 | IPv4 Address allocation and IPv4 parameter configuration via DHCPv4..... | 58 | +| 13.3.1.2 | IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6..... | 59 | +| 13.3.1.3 | IPv6 parameter configuration via stateless DHCPv6 ..... | 59 | +| 13a | Interworking with IMS..... | 60 | +| 13a.1 | General ..... | 60 | +| 13a.2 | IMS Interworking Model ..... | 60 | +| 13a.2.1 | IMS Specific Configuration in the GGSN/P-GW ..... | 61 | +| 13a.2.2 | IMS Specific Procedures in the GGSN/P-GW ..... | 61 | +| 13a.2.2.1 | Request for Signalling Server Address..... | 61 | +| 13a.2.2.1a | Failure of Signalling Server Address..... | 62 | +| 13a.2.2.2 | Establishment of a PDP Context/EPS Bearer for Signalling ..... | 62 | +| 13a.2.2.3 | Creation of a PDP Context/EPS Bearer for IMS Media Flows ..... | 63 | +| 13b | Interworking with BM-SC in EPS ..... | 63 | +| 13b.1 | General ..... | 63 | +| 13b.2 | BM-SC interworking model of MBMS GW..... | 63 | +| 13b.3 | Forwarding of user plane packets at the MBMS GW ..... | 65 | +| 14 | Internet Hosted Octet Stream Service (IHOSS)..... | 65 | +| 15 | Interworking between Packet Domains ..... | 65 | +| 15.1 | Security Agreements ..... | 66 | +| 15.2 | Routing protocol agreements ..... | 66 | +| 15.3 | Charging agreements..... | 66 | +| 16 | Usage of RADIUS on Gi/Sgi interface ..... | 66 | +| 16.1 | RADIUS Authentication and Authorization ..... | 66 | +| 16.2 | RADIUS Accounting ..... | 67 | +| 16.3 | Authentication and accounting message flows on Gi interface ..... | 68 | +| 16.3.1 | IP PDP type ..... | 68 | +| 16.3.2 | PPP PDP type ..... | 70 | +| 16.3.3 | Accounting Update..... | 71 | +| 16.3.4 | AAA-Initiated PDP context termination ..... | 72 | +| 16.3a | Authentication and accounting message flows on Sgi interface..... | 73 | +| 16.3a.1 | Authentication, Authorization and Accounting procedures ..... | 73 | +| 16.3a.2 | Accounting Update..... | 75 | +| 16.3a.3 | AAA-Initiated Bearer termination..... | 76 | +| 16.4 | List of RADIUS attributes..... | 77 | +| 16.4.1 | Access-Request message (sent from GGSN/P-GW to AAA server) ..... | 77 | + +| | | | +|----------|-----------------------------------------------------------------------------|-----| +| 16.4.2 | Access-Accept (sent from AAA server to GGSN/P-GW)..... | 79 | +| 16.4.3 | Accounting-Request START (sent from GGSN/P-GW to AAA server)..... | 81 | +| 16.4.4 | Accounting Request STOP (sent from GGSN/P-GW to AAA server) ..... | 82 | +| 16.4.5 | Accounting Request ON (optionally sent from GGSN/P-GW to AAA server)..... | 84 | +| 16.4.6 | Accounting Request OFF (optionally sent from GGSN/P-GW to AAA server) ..... | 84 | +| 16.4.7 | Sub-attributes of the 3GPP Vendor-Specific attribute ..... | 85 | +| 16.4.7.1 | Presence of the 3GPP Vendor-Specific attribute in RADIUS messages..... | 85 | +| 16.4.7.2 | Coding 3GPP Vendor-Specific RADIUS attributes ..... | 90 | +| 16.4.8 | Accounting Request Interim-Update (sent from GGSN/P-GW to AAA server) ..... | 108 | +| 16.4.9 | Disconnect Request (optionally sent from AAA server to GGSN/P-GW) ..... | 110 | +| 16a | Usage of Diameter on Gi/Sgi interface ..... | 111 | +| 16a.1 | Diameter Authentication and Authorization ..... | 111 | +| 16a.2 | Diameter Accounting ..... | 112 | +| 16a.3 | Authentication and accounting message flows on Gi interface ..... | 113 | +| 16a.3.1 | IP PDP type ..... | 113 | +| 16a.3.2 | PPP PDP type ..... | 114 | +| 16a.3.3 | Accounting Update..... | 117 | +| 16a.3.4 | Server-Initiated PDP context termination ..... | 117 | +| 16a.3a | Authentication and accounting message flows on Sgi interface..... | 118 | +| 16a.3a.1 | Authentication, Authorization and Accounting procedures ..... | 118 | +| 16a.3a.2 | Accounting Update..... | 120 | +| 16a.3a.3 | Server-Initiated Bearer termination ..... | 121 | +| 16a.4 | Gi/Sgi Diameter messages ..... | 122 | +| 16a.4.1 | AAR Command ..... | 122 | +| 16a.4.2 | AAA Command..... | 123 | +| 16a.4.3 | ACR Command ..... | 124 | +| 16a.4.4 | ACA Command ..... | 126 | +| 16a.4.5 | STR Command ..... | 126 | +| 16a.4.6 | STA Command..... | 126 | +| 16a.4.7 | ASR Command..... | 127 | +| 16a.4.8 | ASA Command ..... | 127 | +| 16a.5 | Gi/Sgi specific AVPs ..... | 128 | +| 16a.6 | Gi/Sgi specific Experimental-Result-Code AVP ..... | 131 | +| 16a.7 | Gi/Sgi re-used AVPs ..... | 131 | +| 17 | Usage of Diameter on Gmb interface ..... | 131 | +| 17.1 | MBMS user authorisation ..... | 132 | +| 17.2 | MBMS service registration / de-registration..... | 132 | +| 17.3 | MBMS session start / update/ stop..... | 132 | +| 17.4 | MBMS user deactivation..... | 132 | +| 17.5 | Message flows..... | 133 | +| 17.5.1 | Service activation ..... | 133 | +| 17.5.2 | Session start procedure ..... | 134 | +| 17.5.3 | Session stop procedure ..... | 135 | +| 17.5.4 | Registration procedure..... | 135 | +| 17.5.5 | De-registration procedure (GGSN initiated) ..... | 136 | +| 17.5.6 | De-registration procedure (BM-SC initiated)..... | 136 | +| 17.5.7 | Service deactivation..... | 137 | +| 17.5.7.1 | BM-SC Initiated Multicast Service Deactivation ..... | 138 | +| 17.5.8 | Trace Session Activation procedure ..... | 138 | +| 17.5.9 | Trace Session Deactivation procedure ..... | 139 | +| 17.5.10 | MBMS UE Context Modification Procedure ..... | 139 | +| 17.5.11 | Session Update Procedure ..... | 140 | +| 17.5.12 | MBMS broadcast session termination (GGSN initiated) ..... | 141 | +| 17.6 | Gmb Messages ..... | 141 | +| 17.6.1 | AAR Command ..... | 142 | +| 17.6.2 | AAA Command..... | 143 | +| 17.6.3 | STR Command ..... | 143 | +| 17.6.4 | STA Command..... | 144 | +| 17.6.5 | Re-Auth-Request Command ..... | 144 | +| 17.6.6 | RE-Auth-Answer Command ..... | 146 | + +| | | | +|----------|-----------------------------------------------------------------------|-----| +| 17.6.7 | Abort-Session-Request Command ..... | 146 | +| 17.6.8 | Abort-Session-Answer Command..... | 146 | +| 17.7 | Gmb specific AVPs..... | 147 | +| 17.7.0 | General ..... | 147 | +| 17.7.1 | 3GPP-Vendor-Specific AVP ..... | 149 | +| 17.7.2 | TMGI AVP ..... | 149 | +| 17.7.3 | Required-MBMS-Bearer-Capabilities AVP..... | 149 | +| 17.7.4 | Void ..... | 149 | +| 17.7.5 | MBMS-StartStop-Indication AVP ..... | 149 | +| 17.7.6 | MBMS-Service-Area AVP..... | 150 | +| 17.7.7 | MBMS-Session-Duration AVP ..... | 150 | +| 17.7.8 | Alternative-APN AVP..... | 150 | +| 17.7.9 | MBMS-Service-Type AVP ..... | 150 | +| 17.7.10 | MBMS-2G-3G-Indicator AVP..... | 151 | +| 17.7.11 | MBMS-Session-Identity AVP..... | 151 | +| 17.7.12 | RAI AVP ..... | 151 | +| 17.7.13 | Additional-MBMS-Trace-Info AVP ..... | 151 | +| 17.7.14 | MBMS-Time-To-Data-Transfer AVP..... | 151 | +| 17.7.15 | MBMS-Session-Repetition-Number AVP ..... | 152 | +| 17.7.16 | MBMS-Required-QoS AVP..... | 152 | +| 17.7.17 | MBMS-Counting-Information AVP ..... | 152 | +| 17.7.18 | MBMS-User-Data-Mode-Indication AVP ..... | 152 | +| 17.7.19 | MBMS-GGSN-Address AVP ..... | 153 | +| 17.7.20 | MBMS-GGSN-Ipv6-Address AVP..... | 153 | +| 17.7.21 | MBMS-BMSC-SSM-IP-Address AVP..... | 153 | +| 17.7.22 | MBMS-BMSC-SSM-IPv6-Address AVP..... | 153 | +| 17.7.23 | MBMS-Flow-Identifier AVP ..... | 153 | +| 17.7.24 | CN-IP-Multicast-Distribution AVP..... | 153 | +| 17.7.25 | MBMS-HC-Indicator AVP ..... | 153 | +| 17.7a | Gmb re-used AVPs..... | 153 | +| 17.8 | Gmb specific Experimental-Result-Code AVP values ..... | 154 | +| 17.8.0 | General ..... | 154 | +| 17.8.1 | Success ..... | 154 | +| 17.8.2 | Permanent Failures ..... | 154 | +| 17.8.3 | Transient Failures ..... | 155 | +| 18 | Usage of RADIUS at the Pk Reference Point..... | 155 | +| 18.1 | General ..... | 155 | +| 18.2 | Radius Profile for Pk Reference Point ..... | 155 | +| 18.3 | Interconnecting the Presence Network Agent and the GGSN ..... | 155 | +| 19 | Usage of Diameter on Mz interface ..... | 156 | +| 19.1 | Introduction ..... | 156 | +| 19.2 | Call flows in roaming scenarios..... | 156 | +| 19.2.1 | Service activation ..... | 156 | +| 19.2.1.1 | Service Provided by the BM-SC in Home PLMN..... | 156 | +| 19.2.1.2 | Service Provided by the BM-SC in visited PLMN..... | 158 | +| 19.2.2 | Service deactivation..... | 159 | +| 19.2.2.1 | Service Provided by the BM-SC in home PLMN..... | 159 | +| 19.2.2.2 | Service Provided by the BM-SC in visited PLMN..... | 160 | +| 19.2.2.3 | BM-SC in the home PLMN initiated multicast service deactivation ..... | 161 | +| 19.3 | Mz messages ..... | 161 | +| 19.4 | Mz specific AVPs..... | 161 | +| 19.5 | Mz specific Experimental-Result-Code AVP values..... | 162 | +| 19.5.1 | Success ..... | 162 | +| 19.5.2 | Permanent Failures ..... | 162 | +| 19.5.3 | Transient Failures ..... | 162 | +| 20 | Usage of Diameter on SGmb interface ..... | 162 | +| 20.1 | General ..... | 162 | +| 20.2 | MBMS session start / update/ stop..... | 163 | +| 20.2A | MBMS heartbeat ..... | 163 | +| 20.3 | Message flows ..... | 163 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------------------|------------| +| 20.3.1 | Session start procedure ..... | 163 | +| 20.3.2 | Session update procedure ..... | 164 | +| 20.3.3 | Session stop procedure ..... | 165 | +| 20.3.4 | MBMS session termination (MBMS GW initiated)..... | 165 | +| 20.3.5 | MBMS heartbeat procedure ..... | 166 | +| 20.4 | SGmb Messages ..... | 167 | +| 20.4.1 | Re-Auth-Request Command ..... | 167 | +| 20.4.2 | RE-Auth-Answer Command ..... | 169 | +| 20.4.3 | Session-Termination-Request Command..... | 170 | +| 20.4.4 | Session-Termination-Answer Command ..... | 170 | +| 20.4.5 | Abort-Session-Request Command ..... | 170 | +| 20.4.6 | Abort-Session-Answer Command..... | 171 | +| 20.5 | SGmb re-used AVPs ..... | 171 | +| 20.5a | SGmb specific AVPs..... | 174 | +| 20.5a.1 | MBMS-Access-Indicator AVP..... | 174 | +| 20.5a.2 | MBMS-GW-SSM-IP-Address AVP ..... | 175 | +| 20.5a.3 | MBMS-GW-SSM-IPv6-Address AVP ..... | 175 | +| 20.5a.4 | MBMS-BMSC-SSM-UDP-Port AVP ..... | 175 | +| 20.5a.5 | MBMS-GW-UDP-Port AVP..... | 175 | +| 20.5a.6 | MBMS-GW-UDP-Port-Indicator AVP ..... | 175 | +| 20.5a.7 | MBMS-Data-Transfer-Start AVP ..... | 175 | +| 20.5a.8 | MBMS-Data-Transfer-Stop AVP..... | 175 | +| 20.5a.9 | MBMS-Flags AVP ..... | 175 | +| 20.5a.10 | Restart-Counter AVP..... | 176 | +| 20.5a.11 | Diagnostic-Info AVP..... | 176 | +| 20.5a.12 | MBMS-Cell-List AVP..... | 176 | +| 20.6 | SGmb specific Experimental-Result-Code AVP values ..... | 177 | +| 20.7 | Use of the Supported-Features AVP on the SGmb reference point..... | 177 | +| Annex A (informative): | Interworking PCS1900 with PSDNs ..... | 179 | +| Annex B (normative): | Rate control related to Cellular Internet Of Things (CIoT) optimisations ..... | 180 | +| B.1 | General..... | 180 | +| B.2 | Support of rate control of user data..... | 180 | +| B.2.0 | General ..... | 180 | +| B.2.1 | APN Rate Control in the PGW ..... | 180 | +| B.2.2 | Serving PLMN Rate Control information handling in the PGW ..... | 181 | +| Annex C (informative): | Change history..... | 182 | + +--- + +## Foreword + +This Technical Specification (TS) has been produced by the 3rd Generation Partnership Project (3GPP). + +The present document describes the network interworking for the Packet Domain. Interworking to various external networks is defined together with the interworking for data forwarding while subscribers roam within the 3GPP system. + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +--- + +# 1 Scope + +The present document defines the requirements for Packet Domain interworking between a: + +- a) PLMN and PDN; +- b) PLMN and PLMN. + +The present document is valid for a PLMN in A/Gb mode as well as for a PLMN in Iu mode. If text applies only for one of these systems it is explicitly mentioned by using the terms "A/Gb mode" and "Iu mode". Please note, that the A interface does not play any role in the scope of the present document although the term "A/Gb mode" is used. + +For inter-working between EPC PLMN and external networks, the present document is valid for both 3GPP accesses and non-3GPP accesses. + +The present document also defines, in clause 17, the protocol for the Gmb interface, in clause 20, the protocol for the SGmb interface, and in clause 19, the protocol for the Mz interface. + +The present document also defines, in clause 18, the usage of Radius at the Pk Reference Point between the GGSN and the Presence Network Agent. + +The term "Packet Domain" includes both EPC based and non-EPC based Packet Domains. + +The present document also defines the specific requirements for rate control related to CIoT optimisations. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] Void. +- [2] 3GPP TS 22.060: "General Packet Radio Service (GPRS); Service Description; Stage 1". +- [3] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service Description; Stage 2". +- [4] Void. +- [5] Void. +- [6] Void. +- [7] Void. +- [8] Void. +- [9] Void. +- [10] 3GPP TS 27.060: "Packet Domain; Mobile Station (MS) supporting Packet Switched services". +- [11] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [12] Void. + +- [13] Void. +- [14] Void. +- [15] IETF RFC 768 (1980): "User Datagram Protocol" (STD 6). +- [16] IETF RFC 791 (1981): "Internet Protocol" (STD 5). +- [17] IETF RFC 792 (1981): "Internet Control Message Protocol" (STD 5). +- [18] IETF RFC 793 (1981): "Transmission Control Protocol" (STD 7). +- [19] IETF RFC 1034 (1987): "Domain names – concepts and facilities" (STD 7). +- [20] Void. +- [21a] IETF RFC 1661 (1994): "The Point-to-Point Protocol (PPP)" (STD 51). +- [21b] IETF RFC 1662 (1994): "PPP in HDLC-like Framing". +- [22] IETF RFC 1700 (1994): "Assigned Numbers" (STD 2). +- [23] 3GPP TS 44.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [24] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [25] IETF RFC 2794 (2000): "Mobile IP Network Address Identifier Extension for IPv4", P. Calhoun, C. Perkins. +- [26] IETF RFC 2131 (1997): "Dynamic Host Configuration Protocol". +- [27] IETF RFC 1542 (1993): "Clarification and Extensions for the Bootstrap Protocol". +- [28] Void. +- [29] Void. +- [30] IETF RFC 3344 (2002): "IP Mobility Support", C. Perkins. +- [31] IETF RFC 2486 (1999): "The Network Access Identifier", B. Aboba and M. Beadles. +- [32] Void. +- [33] Void. +- [34] Void. +- [35] Void. +- [36] Void. +- [37] IETF RFC 2290 (1998): "Mobile-IPv4 Configuration Option for PPP IPCP", J. Solomon, S. Glass. +- [38] IETF RFC 2865 (2000): "Remote Authentication Dial In User Service (RADIUS)", C. Rigney, S. Willens, A. Rubens, W. Simpson. +- [39] IETF RFC 2866 (2000): "RADIUS Accounting", C. Rigney, Livingston. +- [40] 3GPP TS 23.003: "Numbering, addressing and identification". +- [41] IETF RFC 3576 (2003): "Dynamic Authorization Extensions to Remote Authentication Dial In User Service (RADIUS)", M.Chiba, M.Eklund, D.Mitton, B.Aboba. +- [42] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [43] Void. +- [44] Void. + +- [45] IETF RFC 3118 (2001): "Authentication for DHCP Messages", R. Droms, W. Arbaugh. +- [46] IETF RFC 3315 (2003) "Dynamic Host Configuration Protocol for IPv6 (DHCPv6)", R. Droms, J. Bound, B. Volz, T. Lemon, C. Perkins, M. Carney. +- [47] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [48] IETF RFC 2710 (1999): "Multicast Listener Discovery (MLD) for IPv6", S. Deering, W. Fenner, B. Haberman. +- [49] IETF RFC 2460 (1998): "Internet Protocol, Version 6 (IPv6) Specification", S.Deering, R.Hinden. +- [50] IETF RFC 3162 (2001): "RADIUS and IPv6", B. Adoba, G. Zorn, D. Mitton. +- [51] IETF RFC 2548 (1999): "Microsoft Vendor-specific RADIUS Attributes", G.Zorn. +- [52] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [53] Void +- [54] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [55] Void. +- [56] Void +- [57] Void. +- [58] IETF RFC 1035 (1987): "Domain names – implementation and specification" (STD 13). +- [59] Void. +- [60] IETF RFC 1771 (1995): "A Border Gateway Protocol 4 (BGP-4)". +- [61] IETF RFC 1825 (1995): "Security Architecture for the Internet Protocol". +- [62] IETF RFC 1826 (1995): "IP Authentication Header". +- [63] IETF RFC 1827 (1995): "IP Encapsulating Security Payload (ESP)". +- [64] Void. +- [65] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS) Architecture and Functional Description". +- [66] Void. +- [67] Void. +- [68] 3GPP TS 23.141: "Presence Service; Architecture and functional description". +- [69] 3GPP TS 32.422: "Subscriber and equipment trace: Trace Control and Configuration Management". +- [70] 3GPP TS 48.018: "Base Station System (BSS) – Serving GPRS Support Node (SGSN); BSS GPRS Protocol (BSSGP)". +- [71] 3GPP TS 23.107: "Quality of Service (QoS) Concept and Architecture". +- [72] 3GPP TS 25.346: "Introduction of the Multimedia Broadcast Multicast Service (MBMS) in the Radio Access Network (RAN)". +- [73] IETF RFC 4604 (2006): "Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast". +- [74] IETF RFC 4607 (2006): "Source-Specific Multicast for IP". +- [75] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". + +- [76] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [77] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [78] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [79] IETF RFC 4039 (2005): "Rapid Commit Option for the Dynamic Host Configuration Protocol version 4 (DHCPv4)". +- [80] IETF RFC 3736 (2004): "Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6". +- [81] 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [82] IETF RFC 4291 (2006): "IP Version 6 Addressing Architecture". +- [83] IETF RFC 4862 (2007): "IPv6 Stateless Address Autoconfiguration". +- [84] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS)". +- [85] IETF RFC 2132 (1997): "DHCP Options and BOOTP Vendor Extensions". +- [86] IETF RFC 3361 (2002): "Dynamic Host Configuration Protocol (DHCP-for-IPv4) Option for Session Initiation Protocol (SIP) Servers". +- [87] IETF RFC 3646 (2003): "DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)". +- [88] IETF RFC 3319 (2003): "Dynamic Host Configuration Protocol (DHCPv6) Options for Session Initiation Protocol (SIP) Servers". +- [89] IETF RFC 4861 (2007): "Neighbor Discovery for IP Version 6 (IPv6)". +- [90] 3GPP TS 23.203: "Policy and charging control architecture". +- [91] IETF RFC 4739 (2006): "Multiple Authentication Exchanges in the Internet Key Exchange (IKEv2) Protocol". +- [92] 3GPP TS 25.413: "UTRAN Iu Interface RANAP Signalling". +- [93] IETF RFC 5176 (2008): "Dynamic Authorization Extensions to Remote Authentication Dial In User Service (RADIUS)". +- [94] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". +- [95] 3GPP TS 23.380: "IMS Restoration Procedures". +- [96] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [97] IETF RFC 4818 (2007): "RADIUS Delegated-IPv6-Prefix Attribute". +- [98] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description". +- [99] 3GPP TS 23.221: "Architectural requirements". +- [100] 3GPP TS 23.682: "Architecture Enhancements to facilitate communications with Packet Data Networks and Applications". +- [101] 3GPP TS 29.336: "Home Subscriber Server (HSS) Diameter interfaces for interworking with packet data networks and applications". +- [102] IETF RFC 4282 (2005): "The Network Access Identifier". + +- [103] 3GPP TS 29.275: "Proxy Mobile IPv6 (PMIPv6) based Mobility and Tunnelling protocols; Stage 3". +- [104] 3GPP TS 23.007: "Restoration procedures". +- [105] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [106] 3GPP TS 25.446: "MBMS synchronisation protocol (SYNC)". +- [107] 3GPP TS 25.323: "Packet Data Convergence Protocol (PDCP) specification". +- [108] Void. +- [109] IETF RFC 4960 (2007): "Stream Control Transmission Protocol". +- [110] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications ". +- [111] IETF RFC 6733: "Diameter Base Protocol". +- [112] 3GPP TS 23.285: "Architecture Enhancements for V2X services". +- [113] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE); MB2 Reference point; Stage 3". +- [114] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; Stage 3". +- [115] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [116] IETF RFC 2869: "RADIUS Extensions". +- [117] 3GPP TS 23.214: "Architecture enhancements for control and user plane separation of EPC nodes; Stage 2". +- [118] IETF RFC 2661: " Layer Two Tunneling Protocol "L2TP". +- [119] IETF RFC 2868: "RADIUS Attributes for Tunnel Protocol Support". +- [120] IETF RFC 7155: "Diameter Network Access Server Application". +- [121] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TS 22.060 [2], 3GPP TS 23.060 [3], 3GPP TS 23.401 [77], 3GPP TS 23.402 [78] and the following apply: + +**2G- / 3G-:** prefixes 2G- and 3G- refers to functionality that supports only A/Gb mode GPRS or Iu mode, respectively, e.g., 2G-SGSN refers only to the A/Gb mode GPRS functionality of an SGSN. When the prefix is omitted, reference is made independently from the A/Gb mode GPRS or Iu mode functionality. + +**A/Gb mode:** indicates that the text applies only to a system or sub-system which operate in A/Gb mode of operation, i.e. with a functional division that is in accordance with the use of an A or a Gb interface between the radio access network and the core network. + +**Iu mode:** indicates that the text applies only to a system or a sub-system which operates in Iu mode of operation, i.e. with a functional division that is in accordance with the use of an Iu-CS or Iu-PS interface between the radio access network and the core network. + +**IP-CAN session:** association between a UE and an IP network + +The association is identified by a UE represented by an IPv4 address and/or an IPv6 prefix together with a UE identity information, if available, and a PDN identity (e.g. APN). An IP-CAN session incorporates one or more IP-CAN bearers. Support for multiple IP-CAN bearers per IP-CAN session is IP-CAN specific. An IP-CAN session exists as long as the related UE IPv4 address and/or IPv6 prefix are established and announced to the IP network. + +**EPC based Packet Domain:** Packet domain which makes use of EPC nodes (e.g. P-GW, S-GW, etc.). + +**Packet Domain Bearer:** A transmission path between a UE and a GGSN/P-GW, terminating at the User Plane protocol stack under the IP layers. + +**NR RedCap:** a 3GPP RAT type Identifier used in the Core Network only, which is a sub-type of NR RAT type, and defined to identify in the Core Network the NR when used by a UE indicating NR Reduced Capability. + +## 3.2 Abbreviations + +Abbreviations used in the present document are listed in 3GPP TR 21.905 [42]. For the purposes of the present document, the following additional abbreviations apply: + +| | | +|---------|-----------------------------------------------| +| 5QI | 5G QoS Identifier | +| AMBR | Aggregate Maximum Bit Rate | +| APN | Access Point Name | +| ARP | Allocation and Retention Priority | +| ATM | Asynchronous Transfer Mode | +| APCO | Additional Protocol Configuration Options | +| BG | Border Gateway | +| BM-SC | Broadcast/Multicast Service Centre | +| CHAP | Challenge Handshake Authentication Protocol | +| CIoT | Cellular Internet of Things | +| DHCP | Dynamic Host Configuration Protocol | +| DHCPv6 | Dynamic Host Configuration Protocol version 6 | +| DNS | Domain Name System | +| DSMIPv6 | Dual-Stack MIPv6 | +| DVMRP | Distance Vector Multicast Routing Protocol | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| EPS | Evolved Packet System | +| FQDN | Fully Qualified Domain Name | +| GBR | Guaranteed Bit Rate | +| GFBR | Guaranteed Flow Bit Rate | +| GGSN | Gateway GPRS Support Node | +| GTP-U | GPRS Tunnelling Protocol for user plane | +| ICMP | Internet Control Message Protocol | +| IETF | Internet Engineering Task Force | +| IGMP | Internet Group Management Protocol | +| IMS | IP Multimedia Subsystem | +| IP | Internet Protocol | +| IPCP | IP Control Protocol (PPP NCP for IPv4) | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| IPv6CP | IPv6 Control Protocol (PPP NCP for IPv6) | +| ISDN | Integrated Services Digital Network | +| ISP | Internet Service Provider | +| L2TP | Layer Two Tunneling Protocol | +| LAC | L2TP Access Concentrator | +| LAN | Local Area Network | +| LNS | L2TP Network Server | +| MBMS | Multimedia Broadcast/Multicast Service | +| MBR | Maximum Bit Rate | +| MFBR | Maximum Flow Bit Rate | +| MIP | Mobile IP | +| MLD | Multicast Listener Discovery | + +| | | +|--------|----------------------------------------------| +| MME | Mobility Management Entity | +| MOSPF | Multicast Open Shortest Path First | +| MS | Mobile Station | +| MT | Mobile Terminal | +| MTC | Machine Type Communication | +| MTU | Maximum Transfer Unit | +| NAI | Network Access Identifier | +| NCGI | NR Cell Global Identity | +| PAP | Password Authentication Protocol | +| PCC | Policy and Charging Control | +| PCO | Protocol Configuration Options | +| PCRF | Policy and Charging Rules Function | +| P-CSCF | Proxy Call Session Control Function | +| PDCP | Packet Data Convergence Protocol | +| PDN | Packet Data Network | +| PDU | Protocol Data Unit | +| P-GW | PDN Gateway | +| PGW-C | PDN Gateway Control plane function | +| PGW-U | PDN Gateway User plane function | +| PIM-SM | Protocol Independent Multicast – Sparse Mode | +| PPP | Point-to-Point Protocol | +| PS | Packet Switched | +| QCI | QoS Class Identifier | +| RADIUS | Remote Authentication Dial In User Service | +| SCEF | Service Capability Exposure Function | +| SGSN | Serving GPRS Support Node | +| S-GW | Serving Gateway | +| SMDS | Switched Multimegabit Data Service | +| SMF | Session Management Function | +| TCP | Transmission Control Protocol | +| TE | Terminal Equipment | +| TEID | Tunnel End-point Identifier | +| TMGI | Temporary Mobile Group Identity | +| TWAN | Trusted WLAN Access Network | +| UDP | User Datagram Protocol | + +### 3.3 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Gb | Interface between an SGSN and a BSC. | +| Gi | Reference point between Packet Domain and an external packet data network. | +| Gmb | Reference point between GGSN and BM-SC. | +| Gn | Interface between two GSNs within the same PLMN. | +| Go | Interface between a GGSN and a PDF. | +| Gp | Interface between two GSNs in different PLMNs. The Gp interface allows support of Packet Domain network services across areas served by the co-operating PLMNs. | +| Gs | Interface between an SGSN and MSC. | +| Iu | Interface between the RNS and the core network. It is also considered as a reference point. | +| Pk | Reference Point between GGSN and Presence Network Agent. | +| R | The reference point between a non-ISDN compatible TE and MT. Typically this reference point supports a standard serial interface. | +| S2a | It provides the user plane with related control and mobility support between trusted non-3GPP IP access and P-GW. | +| S2b | It provides the user plane with related control and mobility support between ePDG and P-GW. | +| S2c | It provides the user plane with related control and mobility support between UE and P-GW. This reference point is implemented over trusted and/or untrusted non-3GPP Access and/or 3GPP access. | +| S5 | Interface between a S-GW and a P-GW within the same PLMN. | +| S8 | Interface between a S-GW and a P-GW in different PLMNs. | +| Sgi | The reference point between the EPC based PLMN and the packet data network. | +| Sgi-mb | The reference point between BM-SC and MBMS GW for MBMS data delivery. | + +| | | +|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SGmb | The reference point for the control plane between BM-SC and MBMS GW. | +| T6a | Reference point used between SCEF and serving MME. | +| T6b | Reference point used between SCEF and serving SGSN. | +| Um | The interface between the MS and the fixed network part in A/Gb mode. The Um interface is the A/Gb mode network interface for providing packet data services over the radio to the MS. The MT part of the MS is used to access the GSM services through this interface. | +| Uu | Interface between the mobile station (MS) and the fixed network part in Iu mode. The Uu interface is the Iu mode network interface for providing packet data services over the radio to the MS. The MT part of the MS is used to access the UMTS services through this interface. | + +--- + +## 4 Network characteristics + +### 4.1 Key characteristics of PLMN + +The PLMN is fully defined in the 3GPP technical specifications. The Packet Domain related key characteristics are found in 3GPP TS 23.060 [3] , 3GPP TS 23.401 [77] and 3GPP TS 23.402 [78]. + +### 4.2 Key characteristics of PSDN + +Void. + +### 4.3 Key characteristics of IP Networks + +The Internet is a conglomeration of networks utilising a common set of protocols. IP protocols are defined in the relevant IETF STD specifications and RFCs. The networks topologies may be based on LANs (e.g. Ethernet), Point to Point leased lines, PSTN, ISDN, X.25 or WANs using switched technology (e.g. SMDS, ATM). + +--- + +## 5 Interworking Classifications + +### 5.1 Service Interworking + +Service interworking is required when the Teleservice at the calling and called terminals are different. For Packet Domain, service interworking is not applicable at the Gi/Sgi reference point. + +### 5.2 Network Interworking + +Network interworking is required whenever a PLMN is involved in communications with another network to provide end-to-end communications. The PLMN shall interconnect in a manner consistent with that of a normal Packet Data Network (type defined by the requirements e.g. IP). Interworking appears exactly like that of Packet Data Networks. + +### 5.3 Numbering and Addressing + +See 3GPP TS 23.003 [40] and the relevant section for IP addressing below. + +## 6 Access reference configuration + +### 6.1 General + +The figures depicted in subclauses 6.2 and 6.3 below are the logical representation of the EPC and the non-EPC based Packet Domains. Physically, an operator's PLMN may consist of both EPC and non-EPC nodes. In other words, for example, an operator's PLMN may have both GGSNs and P-GWs; and a Rel-8 SGSN may initiate PDP context activation procedure via both Gn/Gp and S4/S5/S8 reference points. + +### 6.2 Access Interfaces and Reference Points for non-EPC based Packet Domain + +Figure 1a shows the relationship between the MS, its terminal equipment and the PLMN network in the non-EPC based overall Packet Domain environment. + +![Figure 1a: Non-EPC based Packet Domain Access Interfaces and Reference Points diagram](43837b056625d3d6ce615e4c02f163bb_img.jpg) + +The diagram illustrates the network architecture for a non-EPC based packet domain. On the left, a 'TE' (Terminal Equipment) and an 'MT' (Mobile Terminal) are connected by a solid line. These two components are grouped by a bracket labeled 'MS' (Mobile Station). Above the 'TE' is the 'R reference point'. The 'MT' is connected to a 'Non-EPC Based Packet Domain' (represented by an oval) via the 'Um or Uu' interface. Above the 'Non-EPC Based Packet Domain' is the 'Gi reference point'. Below the 'Non-EPC Based Packet Domain' is 'Packet Domain network 2' (another oval), connected via the 'Gp' interface. To the right of the 'Non-EPC Based Packet Domain' is a stack of circles representing the 'PDN or other network', connected via the 'Gi reference point'. + +Figure 1a: Non-EPC based Packet Domain Access Interfaces and Reference Points diagram + +Figure 1a: Non-EPC based Packet Domain Access Interfaces and Reference Points + +### 6.3 Access Interfaces and Reference Points for EPC based Packet Domain + +Figure 1b shows the relationship between the UE and the EPS network for both the 3GPP access and the non-3GPP access in the EPC based Packet Domain environment. The S8/S2a/S2b interface includes GTP-based and PMIP-based. + +![Figure 1b: EPC based Packet Domain Access Interfaces and Reference Points diagram](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +The diagram illustrates the network architecture for an EPC based packet domain. On the left, a 'UE' (User Equipment) is connected to 'EPC Based Packet Domain network 1' (represented by an oval). This network is connected to 'Packet Domain network 2' (another oval) via the 'S8/S2a/S2b/S2c' interface. To the right of 'EPC Based Packet Domain network 1' is a stack of circles representing the 'PDN or other network', connected via the 'SGi' interface. + +Figure 1b: EPC based Packet Domain Access Interfaces and Reference Points diagram + +Figure 1b: EPC based Packet Domain Access Interfaces and Reference Points + +## 7 Interface to Packet Domain Bearer Services + +### 7.1 A/Gb mode + +Figure 2a shows the relationship of the non-EPC based Packet Domain Bearer in A/Gb mode terminating at the SNDCP layer to the rest of the A/Gb mode Packet Domain environment. It is shown for reference purposes only and detailed information can be found in 3GPP TS 23.060 [3]. + +![Figure 2a: User Plane for Packet Domain services in A/Gb mode. This diagram illustrates the protocol stack for user plane data across four main entities: MS (Mobile Station), BSS (Base Station System), SGSN (Serving GPRS Support Node), and GGSN (PDG). The MS stack includes SNDCP, LLC, RLC, MAC, and GSM RF layers. The BSS stack includes RLC, MAC, Network Service, and L1bis layers, with a 'Relay' function between RLC and MAC. The SGSN stack includes SNDCP, LLC, BSSGP, Network Service, and L1bis layers, with a 'Relay' function between SNDCP and LLC. The GGSN stack includes GTP-U, UDP, IP, L2, and L1 layers. Interfaces are labeled: Um between MS and BSS, Gb between BSS and SGSN, Gn between SGSN and GGSN, and Gi at the GGSN output. Access points are shown at the top of the MS and GGSN stacks.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +Figure 2a: User Plane for Packet Domain services in A/Gb mode. This diagram illustrates the protocol stack for user plane data across four main entities: MS (Mobile Station), BSS (Base Station System), SGSN (Serving GPRS Support Node), and GGSN (PDG). The MS stack includes SNDCP, LLC, RLC, MAC, and GSM RF layers. The BSS stack includes RLC, MAC, Network Service, and L1bis layers, with a 'Relay' function between RLC and MAC. The SGSN stack includes SNDCP, LLC, BSSGP, Network Service, and L1bis layers, with a 'Relay' function between SNDCP and LLC. The GGSN stack includes GTP-U, UDP, IP, L2, and L1 layers. Interfaces are labeled: Um between MS and BSS, Gb between BSS and SGSN, Gn between SGSN and GGSN, and Gi at the GGSN output. Access points are shown at the top of the MS and GGSN stacks. + +Figure 2a: User Plane for Packet Domain services in A/Gb mode + +### 7.2 Iu mode + +Figure 2b shows the relationship of the non-EPC based Packet Domain Bearer in Iu mode, terminating at the PDCP layer, to the rest of the Iu mode Packet Domain environment. It is shown for reference purposes only and detailed information can be found in 3GPP TS 23.060 [3]. + +![Figure 2b: User Plane for Packet Domain services in Iu mode. This diagram illustrates the protocol stack for user plane data across four main entities: MS (Mobile Station), RNS (Radio Network System), 3G SGSN (Serving GPRS Support Node), and GGSN (PDG). The MS stack includes PDCP, RLC, MAC, and L1 layers. The RNS stack includes PDCP, RLC, MAC, L1, and ATM layers, with a 'Relay' function between PDCP and RLC. The 3G SGSN stack includes GTP-U, UDP/IP, AAL5, ATM, and L1 layers, with a 'Relay' function between GTP-U and UDP/IP. The GGSN stack includes GTP-U, UDP/IP, L2, and L1 layers. Interfaces are labeled: Uu between MS and RNS, Iu-PS between RNS and 3G SGSN, Gn between 3G SGSN and GGSN, and Gi at the GGSN output. Access points are shown at the top of the MS and GGSN stacks.](124c6108c63173818afb8ed49521e22d_img.jpg) + +Figure 2b: User Plane for Packet Domain services in Iu mode. This diagram illustrates the protocol stack for user plane data across four main entities: MS (Mobile Station), RNS (Radio Network System), 3G SGSN (Serving GPRS Support Node), and GGSN (PDG). The MS stack includes PDCP, RLC, MAC, and L1 layers. The RNS stack includes PDCP, RLC, MAC, L1, and ATM layers, with a 'Relay' function between PDCP and RLC. The 3G SGSN stack includes GTP-U, UDP/IP, AAL5, ATM, and L1 layers, with a 'Relay' function between GTP-U and UDP/IP. The GGSN stack includes GTP-U, UDP/IP, L2, and L1 layers. Interfaces are labeled: Uu between MS and RNS, Iu-PS between RNS and 3G SGSN, Gn between 3G SGSN and GGSN, and Gi at the GGSN output. Access points are shown at the top of the MS and GGSN stacks. + +Figure 2b: User Plane for Packet Domain services in Iu mode + +### 7.3 Interface to EPC-based Packet Domain Bearer Services + +The user plane for EPC based packet domain services can be found in 3GPP TS 23.401 [77], 3GPP TS 23.402 [78] and 3GPP TS 23.060 [3]. + +--- + +## 8 Subscription checking + +The subscription of an MS/UE is checked by the PLMN during IP-CAN session establishment procedure as described in 3GPP TS 23.060 [3], 3GPP TS 23.401 [77] and 3GPP TS 23.402 [78]. The GGSN/P-GW implicitly checks its internal context related to the destination address for each mobile terminated packet. For PDN types other than Non-IP, if there is a context IP-CAN session associated with the IP address the packet shall be forwarded towards the MS/UE; otherwise the packet shall be discarded or rejected depending on the implemented protocol. For PDN type "Non-IP", the packet shall be forwarded towards the MS/UE, discarded or rejected depending on the implemented protocol. + +--- + +## 8A Prevention of IP spoofing + +For PDN types other than "Non-IP", if IP spoofing has to be prevented, the GGSN/P-GW shall verify the source IP address of the IP packets issued by the UE and compare it against the address, IPv4 or IPv6, assigned for the IP-CAN session. If the verification fails for a packet, the GGSN/P-GW shall discard the packets and shall be capable to log the event in the security log against the subscriber information (IMSI/MSISDN). + +--- + +## 9 Message Screening + +Screening functions reside within the Packet Domain as described in 3GPP TS 22.060 [2], 3GPP TS 23.060 [3], 3GPP TS 23.401 [77] and 3GPP TS 23.402 [78]. Screening may be applicable for only certain protocols. Screening is outside the scope of the present document. + +--- + +## 10 Interworking with PSDN (X.75/X.25) + +**Figure 3: Void** + +**Figure 4: Void** + +**Figure 5: Void** + +**Figure 6: Void** + +--- + +## 11 Interworking with PDN (IP) + +### 11.1 General + +Packet Domain shall support interworking with networks based on the Internet Protocol (IP). These interworked networks may be either intranets or the Internet. Packet Domain may also support interworking with networks handling Non-IP data services. + +### 11.2 PDN Interworking Model + +The Packet Domain can interwork with IP networks and networks handling Non-IP data services. When interworking with the IP networks, the Packet Domain can operate IPv4 and/or IPv6. The interworking point with the IP networks or networks handling Non-IP data services is at the Gi and Sgi reference point. Additionally, the interworking point with network handling Non-IP data services may also be the T6a (T6) reference point for Control Plane CIoT EPS Optimizations (see 3GPP TS 29.128 [110]). These interworking points are shown in figure 7. + +![Figure 7: IP network interworking diagram showing a UE connected to a Packet Domain Network, which is connected to two External Network(s) via Gi/SGi and T6 interfaces.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +The diagram illustrates IP network interworking. On the left, a 'UE' (User Equipment) is connected to a 'Packet Domain Network'. The 'Packet Domain Network' is connected to two 'External Network(s)' on the right. The connection to the top 'External Network(s)' is labeled 'Gi/SGi' and the connection to the bottom 'External Network(s)' is labeled 'T6'. Both connections are shown with double-headed arrows. + +Figure 7: IP network interworking diagram showing a UE connected to a Packet Domain Network, which is connected to two External Network(s) via Gi/SGi and T6 interfaces. + +**Figure 7: IP network interworking** + +The GGSN/P-GW for interworking with the IP network is the access point of the Packet Domain (see figure 8). In this case the Packet Domain network will look like any other IP network or subnetwork. + +![Figure 8: The protocol stacks of GGSN and P-GW for the IP network interworking diagram showing layers IP, L2, and L1 within a Packet Domain Bearer, connected to the Gi/SGi interface.](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +The diagram shows the protocol stacks for GGSN and P-GW. A 'Packet Domain Bearer' is shown as a large rectangle. Inside it, there are three stacked layers: 'IP' (top), 'L2' (middle), and 'L1' (bottom). The 'IP' layer is further divided into two sections, each labeled 'IP', with a funnel-like shape between them. The 'Packet Domain Bearer' is connected to the 'Gi/SGi' interface on the right. The 'GGSN/P-GW' label is positioned above the protocol stack. + +Figure 8: The protocol stacks of GGSN and P-GW for the IP network interworking diagram showing layers IP, L2, and L1 within a Packet Domain Bearer, connected to the Gi/SGi interface. + +**Figure 8: The protocol stacks of GGSN and P-GW for the IP network interworking** + +Typically in the IP networks, the interworking with subnetworks is done via IP routers. The Gi reference point is between the GGSN and the external IP network; and the Sgi reference point is between the P-GW and the external IP network. From the external IP network's point of view, the GGSN/P-GW is seen as a normal IP router. The L2 and L1 layers are operator specific. + +It is out of the scope of the present document to standardise the router functions and the used protocols in the Gi/Sgi reference point. + +Interworking with user defined ISPs and private/public IP networks is subject to interconnect agreements between the network operators. + +No user data or header compression is done in the GGSN/P-GW. + +Both the GGSN/P-GW (for both Control Plane and User Plane CIoT EPS Optimizations) and the SCEF (for Control Plane CIoT EPS Optimization) for interworking with the network handling Non-IP data services are the access points of the Packet Domain. See 3GPP TS 23.401 [77] and 3GPP TS 23.060 [3] for further details. + +## 11.2.1 Access to Internet, Intranet or ISP through Packet Domain + +The access to Internet, Intranet or ISP may involve specific functions such as user authentication, user's authorization, end to end encryption between MS and Intranet/ISP, allocation of a dynamic address belonging to the PLMN/Intranet/ISP addressing space, IPv6 address autoconfiguration, etc. + +For this purpose the Packet Domain may offer: + +- either direct transparent access to the Internet; or +- a non transparent access to the Intranet/ISP. In this case the Packet Domain, i.e. the GGSN/P-GW, takes part in the functions listed above. + +The mechanisms for host configuration and user authentication described in this subclause and its subclauses are applicable for the initial IP-CAN session establishment to allocate IP addresses (IPv4 and/or IPv6) to the MS. For GTP based access, the activation of any subsequent IP-CAN bearers for that IP-CAN session, (i.e. secondary PDP context activation Procedure', dedicated bearer activation), as well as the use of TFTs, is described in 3GPP TS 23.060 [3], 3GPP TS 23.401 [77]. + +### 11.2.1.1 Transparent access to the Internet + +![Diagram of the PDN Interworking Model for transparent access to the Internet. It shows a Packet Domain Network (oval) connected to a GGSN (rectangle). The GGSN is connected to an Operator specific IP Network (oval). The Operator specific IP Network is connected to a Firewall / Proxy (rectangle), which is connected to an External IP Network (oval). The GGSN is also connected to a DHCP (rectangle) and a DNS (rectangle). The DHCP and DNS are connected to the Operator specific IP Network. The Gi Reference Point is indicated by a dashed line between the GGSN and the Operator specific IP Network.](5fbb4f0de01736f1293333e599410c99_img.jpg) + +``` + +graph LR + subgraph Packet_Domain_Network [Packet Domain Network] + GGSN[GGSN] + DHCP[DHCP] + DNS[DNS] + end + GGSN --- Gi_Ref[Gi Reference Point] + Gi_Ref --- Operator_IP_Net([Operator specific IP Network]) + Operator_IP_Net --- Firewall_Proxy[Firewall / Proxy] + Firewall_Proxy --- External_IP_Net([External IP Network]) + DHCP --- Operator_IP_Net + DNS --- Operator_IP_Net + +``` + +Diagram of the PDN Interworking Model for transparent access to the Internet. It shows a Packet Domain Network (oval) connected to a GGSN (rectangle). The GGSN is connected to an Operator specific IP Network (oval). The Operator specific IP Network is connected to a Firewall / Proxy (rectangle), which is connected to an External IP Network (oval). The GGSN is also connected to a DHCP (rectangle) and a DNS (rectangle). The DHCP and DNS are connected to the Operator specific IP Network. The Gi Reference Point is indicated by a dashed line between the GGSN and the Operator specific IP Network. + +**Figure 9: Example of the PDN Interworking Model, transparent case** + +In figure 9, an example PDN interworking model for transparent access to the Internet is provided for a GGSN and its Gi reference point. + +In transparent access to the Internet case: + +- the MS is given an IPv4 address and/or an IPv6 prefix belonging to the operator addressing space. The IPv4 address and/or IPv6 prefix is assigned either at subscription in which case it is a static address or at IP-CAN session establishment in which case it is a dynamic address. This IPv4 address and/or IPv6 prefix if applicable is used for packet forwarding between the Internet and the GGSN/P-GW and within the packet domain. With IPv6, Stateless Address Autoconfiguration shall be used to assign an IPv6 address to the MS. These procedures are as described in the IPv6 non-transparent access case except that the addresses belong to the operator addressing space. +- the MS need not send any authentication request at IP-CAN session establishment procedure and the GGSN/P-GW need not take any part in the user authentication/authorization process. + +The transparent case provides at least a basic ISP service. As a consequence of this it may therefore provide a bearer service for a tunnel to a private Intranet. + +Note that the remainder of this subclause deals with this specific use-case as depicted in figure 10. + +- The user level configuration may be carried out between the TE and the intranet, the Packet Domain network is transparent to this procedure. + +The used protocol stack is depicted in figure 10. + +![Figure 10: Transparent access to an Intranet. The diagram shows the protocol stack for a TE (Terminal Equipment), MT (Mobile Terminal), GGSN (PDN Gateway), and Intranet. The TE stack consists of Intranet protocol, IP, and PPP or L2. The MT stack consists of PPP or L2, which connects to the Packet Domain bearer. The GGSN stack consists of IP and L2. The Intranet stack consists of Intranet protocol, IP, and L2. Arrows indicate the flow of data from the TE through the MT, Packet Domain bearer, and GGSN to the Intranet.](90ddf538ef276510e2b631f7b96654e6_img.jpg) + +Figure 10: Transparent access to an Intranet. The diagram shows the protocol stack for a TE (Terminal Equipment), MT (Mobile Terminal), GGSN (PDN Gateway), and Intranet. The TE stack consists of Intranet protocol, IP, and PPP or L2. The MT stack consists of PPP or L2, which connects to the Packet Domain bearer. The GGSN stack consists of IP and L2. The Intranet stack consists of Intranet protocol, IP, and L2. Arrows indicate the flow of data from the TE through the MT, Packet Domain bearer, and GGSN to the Intranet. + +**Figure 10: Transparent access to an Intranet** + +In figure 10, an example for transparent access to an Intranet is provided for a GGSN and its Gi reference point, but the same principle is applicable to EPC. + +The communication between the PLMN and the Intranet may be performed over any network, even an insecure network e.g. the Internet. There is no specific security protocol between the GGSN and the Intranet because security is ensured on an end to end basis between the MS and the intranet by the "Intranet Protocol". + +User authentication and encryption of user data are done within the "Intranet Protocol" if either of them is needed. This "Intranet Protocol" may also carry private (IP) addresses belonging to the address space of the Intranet. + +An example of an "Intranet Protocol" is Ipsec (see RFC 1825 [61]). If Ipsec is used for this purpose then Ipsec authentication header or security header may be used for user (data) authentication and for the confidentiality of user data (see RFC 1826 [62] and RFC 1827 [63]). In this case private IP tunnelling within public IP takes place. + +## 11.2.1.2 IPv4 Non Transparent access to an Intranet or ISP + +### 11.2.1.2.1 non-EPC based IPv4 Non Transparent access + +In this case: + +- the MS is given an address belonging to the Intranet/ISP addressing space. The address is given either at subscription in which case it is a static address or at PDP context activation in which case it is a dynamic address. This address is used for packet forwarding within the GGSN and for packet forwarding on the Intranet/ISP. This requires a link between the GGSN and an address allocation server, like AAA, DHCP, ..., belonging to the Intranet/ISP; +- the MS shall send an authentication request at PDP context activation and the GGSN requests user authentication from a server, like AAA, DHCP, ..., belonging to the Intranet/ISP; +- the protocol configuration options are retrieved (if requested by the MS at PDP context activation) from some server (AAA or DHCP, ...) belonging to the Intranet/ISP; +- the communication between the Packet Domain and the Intranet/ISP may be performed over any network, even an insecure e.g. the Internet. In case of an insecure connection between the GGSN and the Intranet/ISP there may be a specific security protocol in between. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. + +![](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +| TE | MT | | SGSN | | GGSN | | ISP | +|------------|------------|--------------|--------------|--------------|--------------|---------------------------------|-------------------------------| +| PPP/L2 | PPP/L2 | SM | SM | GTP-C | GTP-C | DHCP/
RADIUS/
Diameter | DHCP/
RADIUS/
Diameter | +| | | | | | | Transport layer
( See NOTE ) | Transport layer
(See NOTE) | +| | | | | | | IP | IP | +| Phy. layer | Phy. layer | Lower layers | Lower layers | Lower layers | Lower layers | Lower layers | Lower layers | + +**Figure 11a: Signalling plane of non transparent case** + +NOTE: The transport protocol UDP is used for DHCP and RADIUS, and TCP or SCTP are used for Diameter. + +The following description bullet items describe the signal flow. + +- 1) The TE sends an AT-command to the MT to set up parameters and enter PPP mode. The MT responds with an AT-response. +- 2) LCP negotiates Maximum-Receive-Unit and authentication protocol. The negotiated authentication protocol is, either CHAP, PAP or 'none'. The MT shall try to negotiate for CHAP as first priority. +- 3) If the negotiated authentication protocol is either of CHAP or PAP, the TE authenticates itself towards the MT by means of that protocol. The MT stores the necessary authentication data and sends a forced positive acknowledgement of the authentication to the TE. +- 4) The TE requests IP configuration by sending the IPCP Configure-Request message to the MT indicating either the static IP address that shall be used or that an IP-address shall be dynamically allocated. +- 5) The MT sends the Activate PDP context request message to the SGSN, including the Protocol Configuration Options. The SGSN sends the Create PDP context req message to the chosen GGSN including the unmodified Protocol Configuration Options. +- 6) The GGSN deduces from the APN: + - the server(s) to be used for address allocation, authentication and protocol configuration options retrieval; + - the protocol like RADIUS, DHCP, ... to be used with this / those server(s); + - the communication and security feature needed to dialogue with this / those server(s) e.g. tunnel, IPSec security association, dial-up connection (using possibly PPP), ... + +As an example the GGSN may use one of the following options: + +- RADIUS for authentication and IP-address allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN; +- RADIUS for authentication and DHCP for host configuration and address allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN. After a successful authentication, the DHCP client discovers the DHCP server(s) in the ISP/Intranet and receives host configuration data. +- If the received Protocol Configurations Options IE contains a PPP IPCP Configure-Request packet, the GGSN shall analyse all the contained IPCP options and their requested values. In accordance with the relevant PPP RFC 1661 [21a] and RFC 1662 [21b] the GGSN shall respond with the following messages: + - zero or one PPP IPCP Configure-Reject packet containing options not supported and options which values cannot be returned; + - zero or one PPP IPCP Configure-Nak packet containing options that are supported but has requested values that are incorrect/unsupported; and + +- zero or one PPP IPCP Configure-Ack packet containing options that are supported and has requested values that are correct/supported. + +Any returned PPP IPCP packets shall be contained in the Protocol Configurations Options IE. + +- 7) The GGSN sends back to the SGSN a Create PDP Context Response message, containing the Protocol Configuration Options IE. The cause value shall be set according to the outcome of the host –authentication and –configuration. A PDP context activation shall not be rejected solely due to the presence of unsupported or incorrect PPP IPCP options or option values, received from the MS in the Protocol Configurations Options IE. The MS may however later decide to immediately deactivate the activated PDP context due to the information received in the Protocol Configurations Options IE received from the network. +- 8) Depending on the cause value received in the Create PDP Context Response the SGSN sends either an Activate PDP Context Accept or an Activate PDP Context Reject, to the MS. + +If Protocol Configuration Options are received from the GGSN, the SGSN shall relay those to the MS. The MT sends either the configuration-ack packet (e.g. IPCP Configure Ack in PPP case), the configure-nack packet in case of dynamic address allocation (e.g. IPCP Configure Nack in PPP case), or a link Terminate request (LCP Terminate-Request in PPP case) back to the TE. In the case where a configure-nack packet was sent by the MT, a local negotiation may take place at the R reference point (i.e. the TE proposes the new value to the MT), after which a configuration-ack packet is sent to the TE. + +- 9) In case a configuration-ack packet was sent to the TE, the link from the TE to the external ISP/Intranet is established and IP packets may be exchanged. + +In case a link terminate request packet was sent to the TE, the TE and MT negotiates for link termination. The MT may then send a final AT-response to inform the TE about the rejected PDP Context activation. + +A link terminate request packet (such as LCP Terminate-request in PPP case) causes a PDP context deactivation. + +EXAMPLE: In the following example PPP is used as layer 2 protocol over the R reference point. + +The MT acts as a PPP server and translates Protocol Configuration Options into SM message Ies. GTP-C carries this information unchanged to the GGSN which uses the information e.g. for DHCP or RADIUS authentication and host configuration. The result of the host authentication and configuration is carried via GTP-C to the SGSN which relays the information to the MT. The MT sends an IPCP Configure-Ack to the TE with the appropriate options included. + +![Sequence diagram for PDP Context Activation for the IPv4 Non-transparent case. Lifelines: TE, MT, SGSN, GGSN (RADIUS/DHCP client), ISP/intranet (RADIUS/DHCP server). The diagram shows two options for authentication and IP address allocation: Option 1 (RADIUS) and Option 2 (RADIUS+DHCP).](26d664119ad25250780f554633444e54_img.jpg) + +The sequence diagram illustrates the PDP Context Activation process for the IPv4 Non-transparent case. The participants are TE (Terminal Equipment), MT (Mobile Terminal), SGSN (Serving GPRS Support Node), GGSN (PDN Gateway, acting as a RADIUS/DHCP client), and ISP/intranet (acting as a RADIUS/DHCP server). + +**Initial Setup:** + +- TE sends **AT-Commands [APN]** to MT. +- TE sends **LCP negotiation [MRU, Auth. prot.]** to MT. +- TE sends **Authentication [CHAP/PAP/none]** to MT. The MT stores the authentication parameters. +- TE sends **IPCP Config-req [ IP-address, Header compression ]** to MT. + +**PDP Context Activation:** + +- MT sends **Activate PDP Context req.** to SGSN, containing **[ APN, QoS, PDP-type, NSAPI, Protocol Configuration Options ]**. +- SGSN sends **Create PDP ContextReq.** to GGSN, containing **[ APN, QoS, PDP-type, TID, Protocol Configuration Options ]**. + +**Option 1: RADIUS** + +- GGSN sends **RADIUS Access-Request** to ISP/intranet, containing **Authentication, Configuration**. +- ISP/intranet responds with **RADIUS Access-Accept**, containing **Authentication, Configuration**. + +**Option 2: RADIUS+ DHCP** + +- GGSN sends **RADIUS Access-Request** to ISP/intranet, containing **Authentication**. +- ISP/intranet responds with **RADIUS Access-Accept**, containing **Authentication**. +- GGSN sends **DHCP-DISCOVER** to ISP/intranet. +- ISP/intranet responds with **DHCP-OFFER**, containing **Configuration**. +- GGSN sends **DHCP-REQUEST** to ISP/intranet, containing **Configuration**. +- ISP/intranet responds with **DHCP-ACK**, containing **Configuration**. + +**GGSN Processing:** + +- GGSN performs: + - APN -> ISP address translation via DNS + - allocates 1) RADIUS client or 2) RADIUS client and DHCP client + - Translates the Protocol Configuration Options DHCP option and RADIUS attributes. +- GGSN stores IP-address and composes an NCP-IPCP Configure-Ack packet. + +**Finalization:** + +- SGSN sends **Create PDP Context Response** to MT, containing **[Protocol Configuration Options, Cause]**. +- MT sends **Activate PDP Context Acc** to TE, containing **[Protocol Configuration Options, Cause]**. +- TE sends **IPCP Configuration-Ack [IP-address, Header compression]** to MT. + +Sequence diagram for PDP Context Activation for the IPv4 Non-transparent case. Lifelines: TE, MT, SGSN, GGSN (RADIUS/DHCP client), ISP/intranet (RADIUS/DHCP server). The diagram shows two options for authentication and IP address allocation: Option 1 (RADIUS) and Option 2 (RADIUS+DHCP). + +Figure 11b: PDP Context Activation for the IPv4 Non-transparent case + +## 11.2.1.2.2 EPC based IPv4 Non Transparent access + +In this case: + +- a static or a dynamic IPv4 address belonging to the Intranet/ISP addressing space is allocated to a UE at IP-CAN session establishment. The methods of allocating IP address to the UE are specified in 3GPP TS 23.060 [3], + +3GPP TS 23.401 [77] and 3GPP TS 23.402 [78]. The allocated IPv4 address is used for packet forwarding within the P-GW and for packet forwarding on the Intranet/ISP; + +- as a part of the IP-CAN session establishment, the P-GW may request user authentication from an external AAA server (i.e. RADIUS, Diameter) belonging to the Intranet/ISP; +- the IPv4 address allocation to the UE may be performed based on the subscription or a local address pool, which belongs to the Intranet/ISP addressing space, provisioned in the P-GW. The IPv4 address allocation to the UE may also be done via the address allocation servers (i.e. DHCPv4, RADIUS AAA, Diameter AAA) belonging to the Intranet/ISP; +- if requested by the UE at IP-CAN session establishment, the P-GW may retrieve the Protocol Configuration Options or IPv4 configuration parameters from a locally provisioned database in P-GW and/or from some external server (i.e. DHCPv4, RADIUS AAA, Diameter AAA) belonging to the Intranet/ISP; +- the communication between the Packet Domain and the Intranet/ISP may be performed over any network, even an insecure network ,e.g. the Internet. In case of an insecure connection between the P-GW and the Intranet/ISP, there may be a specific security protocol in between. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. + +Table 0 summarizes the IPv4 address allocation and parameter configuration use cases between the UE and the P-GW that may lead the P-GW to interwork with the external DHCPv4, RADIUS AAA and Diameter AAA servers over Sgi reference point. For detailed description of the signalling flows between the UE and the P-GW, see the references in the table. The detailed description of the signalling use cases that may be triggered between the P-GW and the external servers are specified in this document, as referenced in the table. + +**Table 0 : IPv4 address allocation and parameter configuration use cases** + +| Signalling use cases between UE and P-GW | Signalling use cases between P-GW and external servers | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter server (Clauses 16 or 16a)

(NOTE 1,2,5) | IPv4 Address allocation via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | IPv4 parameter configuration via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | +| (1) IPv4 address allocation and parameter configuration via default bearer activation
(2) IPv4 address allocation and parameter configuration via DHCPv4 signalling from UE towards P-GW (NOTE 3 and 4)

deployment options applicable to both use cases (1) and (2):
- GTP-based S5/S8 (Subclauses 5.3.1, 5.3.2, 5.10.2 in TS 23.401 [77])
- PMIP-based S5/S8 (Subclauses 4.7.1, 5.2, 5.6 in TS 23.402 [78]) | X | X | X | + +| Signalling use cases between UE and P-GW | Signalling use cases between P-GW and external servers | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter server (Clauses 16 or 16a)

(NOTE 1,2,5) | IPv4 Address allocation via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | IPv4 parameter configuration via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | +| (3) IPv4 address allocation and parameter configuration during primary PDP context activation using S4-based SGSN
(4) IPv4 address allocation and parameter configuration using DHCPv4 signalling from UE towards P-GW (NOTE 3 and 4)

and using
- GTP-based S5/S8 (Subclauses 9.2, 9.2.2.1A in TS 23.060 [3])
- PMIP-based S5/S8 (Subclauses 4.7.1, 5.2, 5.6, 5.10 in TS 23.402 [78]) | X | X | X | +| (5) IPv4 address allocation in trusted non-3GPP IP access using on S2a (NOTE 4)
- PMIPv6 (Subclauses 4.7.2, 6.2.1, and 6.2.4 in TS 23.402 [78])
- GTPv2 (Subclauses 16.1.5, and 16.2 in TS 23.402 [78])
and using
- anchoring in P-GW
- chained S2a and PMIP-based S8

(6) IPv4 address allocation in trusted non-3GPP IP access using MIPv4 FACoA on S2a and anchoring in P-GW (NOTE 4)
(Subclause 6.2.3 of TS 23.402 [78])

(7) IPv4 address allocation and parameter configuration via DHCPv4 signalling in non-3GPP IP access on S2a (NOTE 3 and 4)
(Subclauses 4.7.2 in TS 23.402 [78]) | X | X | X | +| (8) IPv4 address allocation and parameter configuration in untrusted non-3GPP IP access using on S2b (NOTE 4)
- PMIPv6 (Subclauses 4.7.3, 7.2.1, and 7.2.3 in TS 23.402 [78])
- GTPv2 (Subclauses 7.2.4 in TS 23.402 [78])
and using
- anchoring in P-GW
- chained S2b and PMIP-based S8 | X | X | X | +| (9) IPv4 parameter configuration via DHCPv4 with DSMIPv6 on S2c (Subclauses 4.7.4 in TS 23.402 [78])

(10) IPv4 address allocation with DSMIPv6 on S2c
- in trusted non-3GPP IP access
- in untrusted non-3GPP IP access
(Subclauses 4.7.4, 6.3 and 7.3 of TS 23.402 [78]) | X | X | X | + +| Signalling use cases between UE and P-GW | Signalling use cases between P-GW and external servers | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter server (Clauses 16 or 16a)

(NOTE 1,2,5) | IPv4 Address allocation via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | IPv4 parameter configuration via DHCPv4 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | +|

NOTE 1: When the P-GW interworks with AAA servers, the APN may be configured to interwork with either Diameter AAA or RADIUS AAA server.

NOTE 2: If RADIUS AAA or Diameter AAA server is used, the authentication, IPv4 address allocation and parameter configuration signalling may be combined. Similarly, if DHCPv4 server is used for IPv4 address allocation and parameter configuration, the signalling towards the DHCPv4 server may be combined.

NOTE 3: If the authentication procedure towards RADIUS AAA or Diameter AAA is required, it is performed by the PGW before the DHCPv4 signalling when it receives the initial access request (e.g. Create Session Request, or Proxy Binding Update).

NOTE 4: For PMIP-based S5/S8, S2a and S2b, the P-GW shall obtain the IPv4 address from the external server after receiving Proxy Binding Update and before sending the Proxy Binding Ack. See 3GPP TS 23.402 [78] for details.

NOTE 5: The UEs may provide PAP/CHAP user credentials in the PCO IE when accessing to EPS on 3GPP and non-3GPP IP accesses. If such information is provided to the P-GW, the P-GW may perform user authentication based on these credentials. For S2c, the P-GW may receive such credentials from the UE based on IETF RFC 4739 [91] during the establishment of security association signalling via IKEv2. For S2b, the UEs may provide such credentials in the IKEv2 protocol as specified in IETF RFC 4739 [91], and if the ePDG supports multiple authentications, it shall include such credentials in the APCO IE (see 3GPP TS 29.275 [103] subclause 12.1.1.19) on the S2b interface.

| | | | + +### 11.2.1.3 IPv6 Non Transparent access to an Intranet or ISP + +When using IPv6 Address Autoconfiguration, the process of setting up the access to an Intranet or ISP involves two signalling phases. The first signalling phase is done in the control plane and consists of the PDP context activation or initial attach (e.g. create default bearer) for EPC based access, followed by a second signalling phase done in the user plane. + +The user plane signalling phase shall be stateless. The stateless procedure, which involves only the MS/UE and the GGSN/P-GW, is described in subclause "IPv6 Stateless Address Autoconfiguration". + +For APNs that are configured for IPv6 address allocation, the GGSN/P-GW shall only use the Prefix part of the IPv6 address for forwarding of mobile terminated IP packets. The size of the prefix shall be according to the maximum prefix length for a global IPv6 address as specified in the IPv6 Addressing Architecture, see RFC 4291 [82]. + +The GGSN/P-GW indicates to the MS/UE that Stateless Autoconfiguration shall be performed by sending Router Advertisements as described in the corresponding subclause below and according to the principles defined in RFC 4861 [89] and RFC 4862 [83]. + +For MS/UE having IPv6, IPv6 Stateless Address Autoconfiguration is mandatory. + +#### 11.2.1.3.1 IPv6 PDP Context Activation + +In this case: + +- The GGSN provides the MS with an IPv6 Prefix belonging to the Intranet/ISP addressing space. A dynamic IPv6 address shall be given using stateless address autoconfiguration. This IPv6 address is used for packet forwarding within the packet domain and for packet forwarding on the Intranet/ISP; +- the MS may send an authentication request at PDP context activation and the GGSN may request user authentication from a server, e.g. AAA, ..., belonging to the Intranet/ISP; +- the protocol configuration options are retrieved (if requested by the MS at PDP context activation) from some server, e.g. AAA, ..., belonging to the Intranet/ISP; + +- in order to avoid any conflict between the link-local address of the MS and that of the GGSN, the Interface-Identifier used by the MS to build its link-local address shall be assigned by the GGSN. The GGSN ensures the uniqueness of this interface-identifier. The MT shall then enforce the use of this Interface-Identifier by the TE. +- the communication between the Packet Domain and the Intranet/ISP may be performed over any network, even an insecure e.g. the Internet. In case of an insecure connection between the GGSN and the Intranet/ISP there may be a specific security protocol over the insecure connection. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. +- the MS may request for DNS server IPv6 addresses using the PCO IE in e.g. the PDP Context Request message. In that case the GGSN may return the IP address of one or more DNS servers in the PCO in the PDP Context Response message. The DNS address(es) shall be coded in the PCO as specified in 3GPP TS 24.008 [54]. If a list of servers is received, the MS shall adhere to the explicit prioritisation order of the list. + +In the following signalling flow example, PPP is used as layer 2 protocol over the R reference point. The MT behaves as a PPP server and translates Protocol Configuration Options into SM message Ies. GTP-C carries this information unchanged to the GGSN which uses the information e.g. for RADIUS authentication. The result of the host authentication is carried via GTP-C back to the SGSN, which then relays the result to the MT. The MT finalises the IPV6CP negotiation by sending an IPV6CP Configure-Ack message to the TE with the appropriate options included, e.g. Interface-Identifier. The Interface-Identifier shall be used in the TE to create a link-local address to be able to perform the IPv6 address autoconfiguration (see subclauses 11.2.1.3.2 and 11.2.1.3.3). + +- 1) The TE sends an AT-command to the MT to set up parameters and enter PPP mode. The MT responds with an AT-response. +- 2) LCP negotiates Maximum-Receive-Unit and authentication protocol. The negotiated authentication protocol is either CHAP, PAP or 'none'. The MT shall try to negotiate for CHAP as first priority. +- 3) If the negotiated authentication protocol is either of CHAP or PAP, the TE authenticates itself towards the MT by means of that protocol. The MT stores the necessary authentication data and sends a forced positive acknowledgement of the authentication to the TE. +- 4) The TE requests IPv6 Interface-Identifier negotiation by sending the IPV6CP Configure-Request message to the MT. +- 5) The MT sends the Activate PDP Context Request message to the SGSN, including the Protocol Configuration Options. The Protocol Configuration Options IE may contain negotiated LCP options such as negotiated Authentication Protocol as well as any authentication data previously stored in the MT. It may also contain a request for dynamic configuration of DNS server IPv6 addresses. The MS shall for dynamic address allocation leave PDP Address empty and set PDP Type to IPv6 or IPv4v6. The SGSN sends the Create PDP context request message to the chosen GGSN including the unmodified Protocol Configuration Options. +- 6) The GGSN deduces from local configuration data associated with the APN: + - the source of IPv6 Prefixes (GGSN internal prefix pool, or external address allocation server); + - any server(s) to be used for address allocation, authentication and/or protocol configuration options retrieval (e.g. IMS related configuration, see 3GPP TS 24.229 [47]); + - the protocol e.g. RADIUS, to be used with the server(s); + - the communication and security feature needed to communicate with the server(s); + +As an example the GGSN may use one of the following options: + +- GGSN internal Prefix pool for IPv6 prefix allocation and no authentication; +- GGSN internal Prefix pool for IPv6 prefix allocation and RADIUS for authentication. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN; +- RADIUS for authentication and IPv6 prefix allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN; + +NOTE: DHCPv6 may be used for IPv6 prefix allocation. + +IPv6 Prefixes in a GGSN internal Prefix pool shall be configurable and structured per APN. + +The GGSN shall in the PDP Address IE in the Create PDP Context Response return an IPv6 address composed of a Prefix and an Interface-Identifier. The Interface-Identifier may have any value and it does not need to be unique within or across APNs. It shall however not conflict with the Interface-Identifier the GGSN has selected for its own side of the MS-GGSN link. The Prefix assigned by the GGSN or the external AAA server shall be globally or site-local unique. + +The GGSN shall analyse the requested values of all the protocol options contained in the received Protocol Configurations Options IE. The contents of the Protocol Configurations Options IE sent in the GGSN response shall be in accordance with the relevant standards e.g. the PPP standard RFC 1661 [21a] and RFC 1662 [21b]. + +- 7) The GGSN sends back to the SGSN a Create PDP Context Response message, containing the PDP Address IE and the Protocol Configuration Options IE. The Protocol Configuration Options IE may contain configuration data such as a list of DNS server IPv6 addresses. The cause value shall be set according to the outcome of the host authentication and configuration. +- 8) Depending on the cause value received in the Create PDP Context Response, the SGSN either stores the PDP Address and sends an Activate PDP Context Accept to the MS or, sends an Activate PDP Context Reject, to the MS. + +If Protocol Configuration Options are received from the GGSN, the SGSN shall relay those to the MS. + +- 9) The MT extracts the Interface-Identifier from the address received in the PDP Address IE and ignores the Prefix part. If this Interface-Identifier is identical to the tentative Interface-Identifier indicated in the IPV6CP Configure-Request message sent from the TE, the MT sends an IPV6CP Configure Ack packet, indicating this Interface-Identifier, to the TE. + +If the Interface-Identifier extracted from the address contained in the PDP Address IE is not identical to the tentative Interface-Identifier indicated in the IPV6CP Configure-Request message sent from the TE, the MT sends an IPV6CP Configure-Nak packet, indicating the Interface-Identifier extracted from the address contained in the PDP Address IE, to the TE. The TE then sends a new IPV6CP Configure-Request message to the MT, indicating the same Interface-Identifier as was indicated in the received IPV6CP Configure Nak (as indicated by the dotted IPV6CP Configure-Request and Configure-Ack in the figure below). Finally the MT responds with a IPV6CP Configure Ack packet. + +In case a PDP Context Reject was sent to the MS the MT sends an LCP Terminate-Request to the TE. + +- 10) When the TE has accepted the Interface-Identifier given by the MT, the user plane link from the TE to the GGSN and the external ISP/Intranet is established and the IPv6 address autoconfiguration may proceed. + +In case a link terminate request packet was sent to the TE, the TE and MT negotiates for link termination. The MT may then send a final AT-response to inform the TE about the rejected PDP Context activation. + +An LCP Terminate-request causes a PDP context deactivation. + +![Sequence diagram for PDP Context Activation for the IPv6 Non-transparent case. Lifelines: TE, MT, SGSN, GGSN (RADIUS/DHCP client), ISP/intranet (RADIUS/DHCP server). The diagram shows two options for authentication and IP address allocation. Option 1 uses RADIUS only, while Option 2 uses RADIUS+DHCP. The GGSN performs APN translation via DNS and translates Protocol Configuration Options. The MT stores authentication parameters. The TE sends IPv6CP Configure-request and receives Ack/Nak. The MT sends Activate PDP Context req. to the SGSN, which creates a PDP ContextReq. for the GGSN. The GGSN authenticates and allocates an IP address. The SGSN then sends Activate PDP Context Acc. to the MT, which in turn sends IPv6CP Configure-Ack to the TE.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +Sequence diagram illustrating PDP Context Activation for the IPv6 Non-transparent case. + +**Participants:** TE, MT, SGSN, GGSN (RADIUS/DHCP client), ISP/intranet (RADIUS/DHCP server). + +**Sequence of Messages:** + +- TE sends **AT-Commands [APN]** to MT. +- TE sends **LCP negotiation [MRU, Auth. prot.]** to MT. +- TE sends **Authentication [CHAP/PAP/none]** to MT. The MT stores the authentication parameters. +- TE sends **IPV6CP Configure-request [Interface Identifier, Compression ]** to MT. +- MT sends **Activate PDP Context req. [ APN, QoS, PDP-type, NSAPI, Protocol Configuration Options]** to SGSN. +- SGSN sends **Create PDP ContextReq. [ APN, QoS, PDP-type, TID, Protocol Configuration Options]** to GGSN. +- GGSN performs: + - APN -> ISP address translation via DNS + - allocates 1) RADIUS client or 2) RADIUS client and DHCP client + - Translates the Protocol Configuration Options, DHCP Option and RADIUS attributes. +- Option 1: RADIUS** + - GGSN sends **RADIUS Access-Request** to ISP/intranet. + - ISP/intranet responds with **Authentication, Configuration**. + - GGSN sends **RADIUS Access-Accept** to ISP/intranet. + - ISP/intranet responds with **Authentication, Configuration**. +- Option 2: RADIUS+ DHCP** + - GGSN sends **RADIUS Access-Request** to ISP/intranet. + - ISP/intranet responds with **Authentication**. + - GGSN sends **RADIUS Access-Accept** to ISP/intranet. + - ISP/intranet responds with **Authentication**. + - GGSN sends **DHCPv6 (Note)** to ISP/intranet. + - ISP/intranet responds with **Configuration**. +- GGSN stores IP-address. +- SGSN sends **Create PDP Context Response [PDP Address, Protocol Configuration Options, Cause]** to MT. +- MT sends **Activate PDP Context Acc [PDP Address, Protocol Configuration Options, Cause]** to TE. +- TE sends **IPV6CP Configure-Ack/Nak [Interface Identifier, Compression]** to MT. +- TE sends **IPV6CP Configure-Request [Interface Identifier, Compression]** to MT. +- TE sends **IPV6CP Configure-Ack [Interface Identifier, Compression]** to MT. + +Sequence diagram for PDP Context Activation for the IPv6 Non-transparent case. Lifelines: TE, MT, SGSN, GGSN (RADIUS/DHCP client), ISP/intranet (RADIUS/DHCP server). The diagram shows two options for authentication and IP address allocation. Option 1 uses RADIUS only, while Option 2 uses RADIUS+DHCP. The GGSN performs APN translation via DNS and translates Protocol Configuration Options. The MT stores authentication parameters. The TE sends IPv6CP Configure-request and receives Ack/Nak. The MT sends Activate PDP Context req. to the SGSN, which creates a PDP ContextReq. for the GGSN. The GGSN authenticates and allocates an IP address. The SGSN then sends Activate PDP Context Acc. to the MT, which in turn sends IPv6CP Configure-Ack to the TE. + +NOTE: DHCPv6 may be used for IPv6 prefix allocation. + +**Figure 11ba: PDP Context Activation for the IPv6 Non-transparent case** + +#### 11.2.1.3.1a IPv6 EPC based Bearer Activation + +In this case, the P-GW provides the UE with an IPv6 Prefix belonging to the Intranet/ISP addressing space. A dynamic IPv6 address is given using stateless address autoconfiguration. This IPv6 address is used for packet forwarding within the packet domain and for packet forwarding on the Intranet/ISP. + +When a P-GW receives an initial access request (e.g. Create Session Request or Proxy Binding Update) message, the P-GW deduces from local configuration data associated with the APN: + +- The source of IPv6 Prefixes (P-GW internal prefix pool, or external address allocation server); +- Any server(s) to be used for address allocation, authentication and/or protocol configuration options retrieval (e.g. IMS related configuration, see 3GPP TS 24.229 [47]); +- The protocol, i.e. RADIUS, Diameter or DHCPv6, to be used with the server(s); +- The communication and security feature needed to communicate with the server(s); + +As an example the P-GW may use one of the following options: + +- P-GW internal Prefix pool for IPv6 prefixes allocation and no authentication; +- P-GW internal Prefix pool for IPv6 prefixes allocation and RADIUS for authentication. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the P-GW; +- RADIUS for authentication and IPv6 prefix allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the P-GW; + +The P-GW includes the PDP Address IE in the the initial access response (e.g. Create Session Response or Proxy Binding Acknowledgement) and return an IPv6 address composed of a Prefix and an Interface-Identifier. The Interface-Identifier may have any value and it does not need to be unique within or across APNs. It shall however not conflict with the Interface-Identifier that the P-GW has selected for its own side of the UE-P-GW link. The Prefix assigned by the P-GW or the external AAA server shall be globally or site-local unique (see the Note in subclause 11.3 of this document regarding the usage of site-local addresses). + +Table 0.a summarizes the IPv6 prefix allocation and parameter configuration use cases between the UE and the P-GW that may lead the P-GW to interwork with the external RADIUS AAA, Diameter AAA and DHCPv6 servers over Sgi reference point. For detailed description of the signalling flows between the UE and the P-GW, see the references in the table. The detailed description of the signalling use cases that may be triggered between the P-GW and the external servers are specified in this document, as referenced in the table. + +**Table 0.a : IPv6 prefix allocation and parameter configuration use cases** + +| Signalling use cases between UE and P-GW | Signalling use cases between P-GW and external servers | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| +| | Authentication via RADIUS or Diameter server (Clauses 16 or 16a)

(NOTE 1, and 2, 3) | IPv6 prefix allocation via DHCPv6 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | IPv6 parameter configuration via DHCPv6 or RADIUS or Diameter server (Clauses 13.3, 16 or 16a)

(NOTE 1 and 2) | +| (1) IPv6 address allocation and parameter configuration
(2) IPv6 parameter configuration via stateless DHCPv6

deployment options applicable to both use cases (1) and (2):
- GTP-based S5/S8 (Subclauses 5.3.1, 5.3.2, 5.10.2 in TS 23.401 [77])
- PMIP-based S5/S8 (Subclauses 4.7.1, 5.2, 5.6 in TS 23.402 [78]) | X | X | X | +| (3) IPv6 address allocation and parameter configuration via S4-based SGSN
(4) IPv6 parameter configuration via stateless DHCPv6

and using
- GTP-based S5/S8 (Subclauses 9.2, 9.2.2.1A in TS 23.060 [3])
- PMIP-based S5/S8 (Subclauses 4.7.1, 5.2, 5.6, 5.10 in TS 23.402 [78]) | X | X | X | +| (5) IPv6 address allocation and parameter configuration in trusted non-3GPP IP access using on S2a
- PMIPv6 (Subclauses 4.7.2, 6.2.1, and 6.2.4 in TS 23.402 [78])
- GTPv2 (Subclauses 16.1.5, and 16.2 in TS 23.402 [78])

(6) IPv6 parameter configuration via stateless DHCPv6

and using
- anchoring in P-GW
- chained S2a and PMIP-based S8 | X | X | X | +| (7) IPv6 address allocation and parameter configuration in untrusted non-3GPP IP access using on S2b
- PMIPv6 (Subclauses 4.7.3, 7.2.1, and 7.2.3 in TS 23.402 [78])
- GTPv2 (Subclauses 7.2.4 in TS 23.402 [78])
and using
- anchoring in P-GW
- chained S2b and PMIP-based S8 | X | X | X | +| (8) IPv6 address allocation and parameter configuration on S2c
- in trusted non-3GPP IP access
- in untrusted non-3GPP IP access
(Subclauses 4.7.4, 6.3 and 7.3 of TS 23.402 [78])

(9) IPv6 parameter configuration via stateless DHCPv6 on S2c
(Subclauses 4.7.4 in TS 23.402 [78]) | X | X | X | +| NOTE 1: When the P-GW interworks with AAA servers, the APN may be configured to interwork with either Diameter AAA or RADIUS AAA server. | | | | +| NOTE 2: If RADIUS AAA or Diameter AAA server is used, the authentication, IPv6 prefix allocation and parameter configuration signalling may be combined. Similarly, if DHCPv6 server is used for IPv6 prefix allocation and parameter configuration, the signalling towards the DHCPv6 server may be combined. | | | | +| NOTE 3: The UEs may provide PAP/CHAP user credentials in the PCO IE when accessing to EPS on 3GPP and non-3GPP IP accesses. If such information is provided to the P-GW, the P-GW may perform user authentication based on these credentials. For S2c, the P-GW may receive such credentials from the UE based on IETF RFC 4739 [91] during the establishment of security association signalling via IKEv2. For S2b, the UEs may provide such credentials in the IKEv2 protocol as specified in IETF RFC 4739 [91], and if the ePDG supports multiple authentications, it shall include such credentials in the APCO IE (see 3GPP TS 29.275 [103] subclause 12.1.1.19) on the S2b interface. | | | | + +### 11.2.1.3.2 IPv6 Stateless Address Autoconfiguration + +As described in 3GPP TS 23.060 [3], the IPv6 prefix of a PDP Context of PDP type IPv6 or IPv4v6 activated by means of the IPv6 Stateless Address Autoconfiguration Procedure is uniquely identified by the prefix part of the IPv6 address only. The MS may select any value for the Interface-Identifier part of the address. The only exception is the Interface-Identifier for the link-local address used by the MS (see RFC 4291 [82]). This Interface-Identifier shall be assigned by the GGSN to avoid any conflict between the link-local address of the MS and that of the GGSN itself. This is described in subclause "IPv6 PDP Context Activation" above. + +For IPv6 the PDP Context Activation phase is followed by an address autoconfiguration phase. The procedure describing APNs configured to use Stateless Address Autoconfiguration, may be as follows: + +- 1) After the first phase of setting up IPv6 access to an Intranet or ISP, the MS shall use the IPv6 Interface-Identifier, as provided by the GGSN, to create its IPv6 Link-Local Unicast Address according to RFC 4291 [82]. + +Before the MS can communicate with other hosts or Mses on the Intranet/ISP, the MS must obtain an IPv6 Global or Site-Local Unicast Address. The simplest way is the IPv6 Stateless Address Autoconfiguration procedure described below and in 3GPP TS 23.060 [3]. The procedure is consistent with RFC 4862 [83]. + +The procedure below takes place through signalling in the user plane. It is done on the link between the MS and the GGSN. From the MS perspective the GGSN is now the first router on the link. + +- 2) After the GGSN has sent a Create PDP Context Response message to the SGSN, it shall start sending Router Advertisements periodically on the new MS-GGSN link established by the PDP Context. The MS may issue a Router Solicitation directly after the user plane establishment. This shall trigger the GGSN to send a Router Advertisement immediately. + +To indicate to the MS that stateless address autoconfiguration shall be performed, the GGSN shall leave the M-flag cleared in the Router Advertisement messages. The GGSN may set the O-flag if there are additional configuration parameters that need to be fetched by the MS (see below). + +The Prefix sent in the Router Advertisements shall be identical to the Prefix returned in the Create PDP Context Response. The Prefix is contained in the Prefix Information Option of the Router Advertisements and shall have the A-flag set ("Autonomous address configuration flag") and the L-flag cleared (i.e. the prefix should not be used for on-link determination). The lifetime of the prefix shall be set to infinity. In practice, the lifetime of a Prefix will be the lifetime of its PDP Context. There shall be exactly one Prefix included in the Router Advertisements. + +The handling of Router Advertisements shall be consistent with what is specified in RFC 4861 [89]. For the MS-GGSN link however, some specific handling shall apply. The randomisation part to determine when Router Advertisements shall be sent may be omitted since the GGSN is the only router on the link. Furthermore, some 3GPP specific protocol constants and default values shall apply (see subclause "IPv6 Router Configuration Variables in the GGSN"). These relate to the periodicity of the Router Advertisements initially and during continued operation. The motivation for this is to have a faster user-plane set-up even in bad radio conditions and to minimize MS power consumption during long continued operation. + +- 3) When creating a Global or Site-Local Unicast Address, the MS may use the Interface-Identifier received during the PDP Context Activation phase or it may generate a new Interface-Identifier. There is no restriction on the value of the Interface-Identifier of the Global or Site-Local Unicast Address, since the Prefix is unique. Interface-Identifiers shall in any case be 64-bit long. + +Since the GGSN guarantees that the Prefix is unique, the MS does not need to perform any Duplicate Address Detection on addresses it creates. That is, the 'DupAddrDetectTransmits' variable in the MS should have a value of zero. If the MS finds more than one Prefix in the Router Advertisement message, it shall only consider the first one and silently discard the others. The GGSN shall not generate any globally unique IPv6 addresses for itself using the Prefix assigned to the MS in the Router Advertisement. + +If the O-flag ("Other configuration flag") was set in the Router Advertisement, the MS may start a DHCP session to retrieve additional configuration parameters. See subclause 13.2.2 "Other configuration by the Intranet or ISP". If the MS is not DHCP capable, the O-flag may be ignored. + +![Sequence diagram for IPv6 Stateless Address Autoconfiguration. The diagram shows four lifelines: MS, SGSN, GGSN, and ISP/intranet RADIUS/Diameter/DHCP server. The sequence of messages is: 1. MS sends 'Activate PDP Context' to SGSN. 2. SGSN sends 'Create PDP Context' to GGSN. 3. GGSN sends 'RADIUS / Diameter / DHCPv6' to the ISP/intranet server. 4. MS sends a 'Router Solicitation' (dashed line) to GGSN. 5. GGSN sends a 'Router Advertisement' to MS with parameters: [M-flag=0, O-flag, Prefix, Lifetime, A-flag=1, L-flag=0]. 6. GGSN sends another 'Router Advertisement' to MS with the same parameters.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant MS + participant SGSN + participant GGSN + participant ISP as ISP/intranet RADIUS/Diameter/DHCP server + + MS->>SGSN: Activate PDP Context + SGSN->>GGSN: Create PDP Context + GGSN->>ISP: RADIUS / Diameter / DHCPv6 + Note right of MS: Router Solicitation + MS-->>GGSN: Router Advertisement + Note right of GGSN: [M-flag=0, O-flag, Prefix, Lifetime, A-flag=1, L-flag=0] + GGSN-->>MS: Router Advertisement + Note right of GGSN: [M-flag=0, O-flag, Prefix, Lifetime, A-flag=1, L-flag=0] + +``` + +Sequence diagram for IPv6 Stateless Address Autoconfiguration. The diagram shows four lifelines: MS, SGSN, GGSN, and ISP/intranet RADIUS/Diameter/DHCP server. The sequence of messages is: 1. MS sends 'Activate PDP Context' to SGSN. 2. SGSN sends 'Create PDP Context' to GGSN. 3. GGSN sends 'RADIUS / Diameter / DHCPv6' to the ISP/intranet server. 4. MS sends a 'Router Solicitation' (dashed line) to GGSN. 5. GGSN sends a 'Router Advertisement' to MS with parameters: [M-flag=0, O-flag, Prefix, Lifetime, A-flag=1, L-flag=0]. 6. GGSN sends another 'Router Advertisement' to MS with the same parameters. + +**Figure 11bb: IPv6 Stateless Address Autoconfiguration** + +#### 11.2.1.3.2a IPv6 Stateless Address Autoconfiguration for EPC + +This subclause describes the signalling flows for the IPv6 Stateless Address Autoconfiguration procedures for EPC, in the case of using GTP-based S5/S8/S2a, and PMIP-based S5/S8/S2a. The procedures are based on the descriptions in TS 23.401 [77] and TS 23.402 [78]. Subclause 11.2.3.1a lists the use cases between the UE to the P-GW that may trigger the P-GW to interwork with the external PDNs for IPv6 Prefix allocation. + +IPv6 prefix is delivered to UE in Router Advertisement message from the access router, in the process of IPv6 Stateless Address Autoconfiguration. + +In the procedure in the cases of using GTP-based S5/S8, P-GW acts as an access router, and allocates to a UE a globally unique /64 IPv6 prefix if the PLMN allocates the prefix, or P-GW retrieves IPv6 prefix from an external PDN if one is allocated by the external PDN and advertises it to the UE. In the latter procedure, P-GW uses RADIUS, Diameter or DHCPv6 protocol for the retrieval of an IPv6 prefix. + +Following is the flow for IPv6 Stateless Address Autoconfiguration for EPC using GTP-based S5/S8. + +1. UE initiates the Attach procedure, indicating 'IPv6' or 'IPv4v6' for PDN type in PDP type information element. +2. MME requests for Default Bearer creation by sending Create Session Request to the S-GW. +- 2x. The S-GW sends Create Session Request to the P-GW. +3. P-GW retrieves IPv6 prefix using RADIUS, Diameter, or DHCPv6 mechanism. This procedure is performed when an external PDN allocates an IPv6 prefix. +4. The P-GW sends Create Session Response. It includes the IPv6 interface identifier I IPv6 prefix. +5. S-GW sends Create Session Response message to the MME. It includes the IPv6 interface identifier I IPv6 prefix. +- 5x. The MME sends Attach Accept message to the UE without the IPv6 prefix. The UE shall ignore the IPv6 prefix if it receives one in the message. +6. After receiving the Attach Accept message, the UE may send a Router Solicitation to the P-GW to solicit a Router Advertisement message. +7. The P-GW sends a Router Advertisement message to the UE, solicited or unsolicited. It shall include an IPv6 prefix in Prefix Information option field of the message. The prefix is the same as the one in the Attach Accept message, if it is provided during the default bearer establishment. For the handling of M, O, L and A flags, and the lifetime of the prefix in the Router Advertisement message, follow the description in subclause 11.2.1.3.2. + +![Sequence diagram for IPv6 Stateless Address Autoconfiguration for GTP-based S5/S8. The diagram shows the interaction between UE, MME, S-GW, P-GW, and External PDN. The sequence of messages is: 1. Attach Request (UE to MME), 2. Create Session Request (MME to S-GW), 2x. Create Session Request (S-GW to P-GW), 3. RADIUS / Diameter / DHCPv6 (P-GW to External PDN), 4. Create Session Response (P-GW to S-GW), 5. Create Session Response (S-GW to MME), 5x. Attach Accept (MME to UE), 6. Router Solicitation (UE to P-GW), and 7. Router Advertisement (P-GW to UE).](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + participant S-GW + participant P-GW + participant External PDN + + Note left of UE: 1. Attach Request + UE->>MME: 1. Attach Request + Note right of MME: 2. Create Session Request + MME->>S-GW: 2. Create Session Request + Note right of S-GW: 2x. Create Session Request + S-GW->>P-GW: 2x. Create Session Request + Note right of P-GW: 3. RADIUS / Diameter / DHCPv6 + P-GW-->>External PDN: 3. RADIUS / Diameter / DHCPv6 + Note right of External PDN: 4. Create Session Response + External PDN-->>P-GW: 4. Create Session Response + Note right of P-GW: 5. Create Session Response + P-GW->>S-GW: 5. Create Session Response + Note right of S-GW: 5x. Attach Accept + S-GW->>MME: 5x. Attach Accept + Note left of MME: 5x. Attach Accept + MME->>UE: 5x. Attach Accept + Note left of UE: 6. Router Solicitation + UE-->>P-GW: 6. Router Solicitation + Note right of P-GW: 7. Router Advertisement + P-GW->>UE: 7. Router Advertisement + +``` + +Sequence diagram for IPv6 Stateless Address Autoconfiguration for GTP-based S5/S8. The diagram shows the interaction between UE, MME, S-GW, P-GW, and External PDN. The sequence of messages is: 1. Attach Request (UE to MME), 2. Create Session Request (MME to S-GW), 2x. Create Session Request (S-GW to P-GW), 3. RADIUS / Diameter / DHCPv6 (P-GW to External PDN), 4. Create Session Response (P-GW to S-GW), 5. Create Session Response (S-GW to MME), 5x. Attach Accept (MME to UE), 6. Router Solicitation (UE to P-GW), and 7. Router Advertisement (P-GW to UE). + +**Figure 11bc: IPv6 Stateless Address Autoconfiguration for GTP-based S5/S8** + +If PMIP-based S5/S8 is used, S-GW acts as an access router. Therefore, it is responsible for receiving Router Solicitation from and sending Router Advertisement message to the UE. Other than this, procedure is the same as the case of using GTP-based S5/S8; P-GW allocates, or retrieves an IPv6 prefix from the external PDN. The prefix is delivered from the P-GW to the S-GW in the IPv6 Home Network Prefix Option IE of a Proxy Binding Acknowledgement message. + +In addition, the S-GW shall initiate sending the IPv6 Router Advertisement message (either solicited or unsolicited) to the UE once the PDN connection with PDN type IPv4v6 or IPv6 is setup after the procedure of E-UTRAN initial Attach, UE requested PDN connectivity, intra-3GPP access handover with Serving GW relocation, or handover from non-3GPP IP Access with S2a/S2b to 3GPP Access. + +Following diagram shows the case where PMIP-based S5/S8 is used. + +![Sequence diagram for IPv6 Stateless Address Autoconfiguration for PMIP-based S5/S8. Lifelines: UE, MME, S-GW, P-GW, External PDN. The sequence starts with UE sending an Attach Request to MME. MME sends a Create Default Bearer Request to S-GW. S-GW sends a Proxy Binding Update to P-GW. P-GW sends a RADIUS/Diameter/DHCPv6 message to External PDN and receives a response. P-GW sends a Proxy Binding Acknowledgement to S-GW. S-GW sends a Create Default Bearer Response to MME. MME sends an Attach Accept to UE. UE sends a Router Solicitation to S-GW. S-GW sends a Router Advertisement to UE.](78ff716475b2f65bf01c3a4d02d89fc4_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MME + participant S-GW + participant P-GW + participant External PDN + + UE->>MME: Attach Request + MME->>S-GW: Create Default Bearer Request + S-GW->>P-GW: Proxy Binding Update + P-GW->>External PDN: RADIUS / Diameter / DHCPv6 + External PDN-->>P-GW: + P-GW->>S-GW: Proxy Binding Acknowledgement + S-GW->>MME: Create Default Bearer Response + MME->>UE: Attach Accept + UE-->>S-GW: Router Solicitation + S-GW->>UE: Router Advertisement + +``` + +Sequence diagram for IPv6 Stateless Address Autoconfiguration for PMIP-based S5/S8. Lifelines: UE, MME, S-GW, P-GW, External PDN. The sequence starts with UE sending an Attach Request to MME. MME sends a Create Default Bearer Request to S-GW. S-GW sends a Proxy Binding Update to P-GW. P-GW sends a RADIUS/Diameter/DHCPv6 message to External PDN and receives a response. P-GW sends a Proxy Binding Acknowledgement to S-GW. S-GW sends a Create Default Bearer Response to MME. MME sends an Attach Accept to UE. UE sends a Router Solicitation to S-GW. S-GW sends a Router Advertisement to UE. + +**Figure 11bd: IPv6 Stateless Address Autoconfiguration for PMIP-based S5/S8** + +For trusted non-3GPP accesses, the non-3GPP network supports prefix advertisement for IPv6 prefix received from the P-GW in PMIPv6 Proxy Binding Acknowledgement. If the trusted non-3GPP access network is a WLAN network, for GTP/PMIP-based S2a, TWAN acts as an access router. Therefore, TWAN is responsible for receiving Router Solicitation from and sending Router Advertisement message to the UE. Other than this, procedure is the same as the case of using GTP/PMIP-based S5/S8; P-GW allocates, or retrieves an IPv6 prefix from the external PDN. The prefix is delivered from the P-GW to the TWAN in the IPv6 Home Network Prefix Option IE of a Proxy Binding Acknowledgement message or in the PDN Address Allocation IE of Create Session Response message. + +Following diagram shows the case for trusted non-3GPP access network for WLAN access where GTP/PMIP-based S2a is used. + +![Sequence diagram for IPv6 Stateless Address Autoconfiguration for trusted WLAN access for GTP/PMIP-based S2a. Lifelines: UE, TWAN, P-GW, External PDN. The sequence starts with UE sending an EAP Authentication message to TWAN. TWAN sends a Create Session Request / Proxy Binding Update to P-GW. P-GW sends a RADIUS/Diameter/DHCPv6 message to External PDN and receives a response. P-GW sends a Create Session Response / Proxy Binding Acknowledgement to TWAN. UE sends a Router Solicitation to TWAN. TWAN sends a Router Advertisement to UE.](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` + +sequenceDiagram + participant UE + participant TWAN + participant P-GW + participant External PDN + + UE->>TWAN: EAP Authentication + TWAN->>P-GW: Create Session Request / Proxy Binding Update + P-GW->>External PDN: RADIUS / Diameter / DHCPv6 + External PDN-->>P-GW: + P-GW->>TWAN: Create Session Response / Proxy Binding Acknowledgement + UE-->>TWAN: Router Solicitation + TWAN->>UE: Router Advertisement + +``` + +Sequence diagram for IPv6 Stateless Address Autoconfiguration for trusted WLAN access for GTP/PMIP-based S2a. Lifelines: UE, TWAN, P-GW, External PDN. The sequence starts with UE sending an EAP Authentication message to TWAN. TWAN sends a Create Session Request / Proxy Binding Update to P-GW. P-GW sends a RADIUS/Diameter/DHCPv6 message to External PDN and receives a response. P-GW sends a Create Session Response / Proxy Binding Acknowledgement to TWAN. UE sends a Router Solicitation to TWAN. TWAN sends a Router Advertisement to UE. + +**Figure 11be: IPv6 Stateless Address Autoconfiguration for trusted WLAN access for GTP/PMIP-based S2a** + +The P-GW ensures that the advertised IPv6 prefix is globally unique. Regarding the handling of Duplicate Address Detection, follow subclause 11.2.1.3.2. + +The UE constructs its full IPv6 address in accordance with RFC 4862[83]. For the handling of IPv6 interface identifier, refer to subclause 11.2.1.3.2. + +If the P-GW, S-GW and TWAN receive Neighbor Solicitation message from the UE, it shall answer with Neighbor Advertisement message. + +To renew the allocated IPv6 prefix, the P-GW (GTP based S5/S8), S-GW (PMIPv6 based S5/S8) or TWAN (GTP/PMIP based S2a) shall send an IPv6 Router Advertisement (solicited or unsolicited) to the UE with the same assigned IPv6 prefix and and new non-zero values in preferred and valid lifetime fields for the PDN connection (PDN type IPv4v6 or IPv6), before the Router Advertisement lifetime and prefix lifetime expiry, as specified in IETF RFC 4861 [89]. When sending the IPv6 Router Advertisement message, the S-GW may trigger the paging (e.g. by sending a Downlink Data Notification message to the MME) if the UE is in idle state. In order to reduce paging an idle UE to deliver RA, the Router Advertisement lifetime and IPv6 prefix lifetime shall be configured accordingly. + +If a UE supports multiple PDN connections functionality, it can connect to multiple P-GWs simultaneously, or it can access multiple PDNs through a single P-GW. In the former case, the IPv6 prefix allocated for its default bearer is used for the UE's dedicated bearers toward the same PDN. In the latter case, IPv6 Stateless Address Autoconfiguration procedure is applied for each PDN connection. + +#### 11.2.1.3.3 IPv6 Stateful Address Autoconfiguration + +**Void.** + +**Figure 11bc : Void** + +#### 11.2.1.3.4 IPv6 Router Configuration Variables + +For IPv6 Address Autoconfiguration to work properly , network entities which act as an access router towards the MS/UE, i.e. PDN GW, Serving GW, ePDG and TWAN, shall be consistent with the RFCs specifying this process (for example RFC 4862 [83] and RFC 4861 [89]), unless stated otherwise in this or other 3GPP specifications. + +RFC 4861 [89] specifies a set of conceptual router configuration variables. Some of these variables require particular attention in GPRS and EPC in order to preserve radio resources and MS/UE power consumption while still allowing for appropriate robustness and fast user-plane set-up time even in bad radio conditions, or simply because they have a particular meaning in GPRS and EPC. These particular variables are listed below with appropriate (default) values and shall be configurable per APN. The values specified hereafter are specific to GPRS and EPC, and supersede those specified in RFC 4861 [89]. + +##### MaxRtrAdvInterval + +Shall have a default value of 21 600 s (6 h). + +##### MinRtrAdvInterval + +Shall have a default value of $0,75 \times \text{MaxRtrAdvInterval}$ i.e. 16 200 s (4,5 h). + +##### AdvValidLifetime + +Shall have a value giving Prefixes infinite lifetime, i.e. 0xFFFFFFFF. The assigned prefix remains Preferred until PDP Context/Bearer Deactivation. + +##### AdvPreferredLifetime + +Shall have a value giving Prefixes infinite lifetime, i.e. 0xFFFFFFFF. The assigned prefix remains Preferred until PDP Context/Bearer Deactivation. + +RFC 4861 [89] also specifies a number of protocol constants. The following shall have specific values for GPRS and EPC: + +MAX\_INITIAL\_RTR\_ADVERT\_INTERVAL + +This constant may be a variable within GPRS and EPC. It may have a value that gradually increases (exponentially or by some other means) with the number of initial Router Advertisements sent. This will enable a fast set-up of the MS-GGSN or MS/UE-PDN GW/Serving GW/ePDG/TWAN links in most cases, while still allowing the MS/UE to receive a Router Advertisement within the initial phase, even in case of bad radio conditions or slow response time, without having to send a large number of initial Router Advertisements. + +#### MAX\_INITIAL\_RTR\_ADVERTISEMENTS + +This is the number of Router Advertisements sent during the initial phase after the MS-GGSN or MS/UE-PDN GW/Serving GW/ePDG/TWAN links have been established. The value of this constant shall be chosen carefully, and in conjunction with MAX\_INITIAL\_RTR\_ADVERT\_INTERVAL, so as to not overload the radio interface while still allowing the MS/UE to complete its configuration in a reasonable delay. For instance, the default value could be chosen so that initial Router Advertisements are sent for at least 30 s. + +After the initial phase, the periodicity is controlled by the MaxRtrAdvInterval and the MinRtrAdvInterval constants. + +#### 11.2.1.3.5 IPv6 Prefix Delegation via DHCPv6 + +Optionally, a single network prefix shorter than the default /64 prefix may be assigned to a PDN connection. In this case, the /64 default prefix used for IPv6 stateless autoconfiguration will be allocated from this network prefix; the remaining address space from the network prefix can be delegated to the PDN connection using prefix delegation after the PDP context activation/default bearer establishment and IPv6 prefix allocation via IPv6 stateless address autoconfiguration as defined in clause 11.2.1.3.2/11.2.1.3.2a. When PLMN based parameter configuration is used, the GGSN / PDN GW provides the requested IPv6 prefix from a locally provisioned pool. When external PDN based IPv6 prefix allocation is used, the GGSN / PDN GW may obtain the prefix from the external PDN as per subclauses 16.4 and 16a.4. + +For the detailed description of the UE uses DHCPv6 to request additional IPv6 prefixes refer to 3GPP TS 23.060 [3] and 3GPP TS 23.401 [77]. + +#### 11.2.1.4 Access to Internet, Intranet or ISP with Mobile IPv4 + +##### General + +A way to allow users to roam from one environment to another, between fixed and mobile, between public and private as well as between different public systems is to use Mobile IP RFC 3344 [30]. Mobile IP (MIP) is a mobility management protocol developed by IETF. The Mobile IP Foreign Agent (FA) RFC 3344 [30] is located in the Core Network in the GGSN. MIP also uses a Home Agent (HA) RFC 3344 [30] which may or may not be located in a PLMN network. + +##### Interworking model for MIP + +A FA is located in the GGSN. The interface between the GGSN and the FA will probably not be standardised as the GGSN/FA is considered being one integrated node. The mapping between these two is a matter of implementation. Each FA must be configured with at least one care-of address. In addition a FA must maintain a list that combines IP addresses with TEIDs of all the visiting MSs that have registered with the FA. IP packets destined for the MS are intercepted by the HA and tunneled to the MS's care-of address, i.e. the FA. The FA de-tunnels the packets and forwards the packets to the MS. Mobile IP related signalling between the MS and the FA is done in the user plane. MIP registration messages RFC 3344 [30] are sent with UDP. + +![Figure 11c: Protocol stacks for the Gi IP reference point in the MIP signalling plane. The diagram shows a GGSN box containing a Foreign Agent, two JDP blocks, and two IP blocks. Below the GGSN is a Packet Domain Bearer box. To the right of the Packet Domain Bearer are L2 and L1 layers. A vertical dashed line labeled 'Gi' is on the far right.](329c96049bb432e9c2cbda4e224a0c9c_img.jpg) + +Figure 11c: Protocol stacks for the Gi IP reference point in the MIP signalling plane. The diagram shows a GGSN box containing a Foreign Agent, two JDP blocks, and two IP blocks. Below the GGSN is a Packet Domain Bearer box. To the right of the Packet Domain Bearer are L2 and L1 layers. A vertical dashed line labeled 'Gi' is on the far right. + +Figure 11c: The protocol stacks for the Gi IP reference point in the MIP signalling plane + +![Figure 11d: Protocol stacks for user access with MIP. The diagram shows five entities: TE, MT, SGSN, GGSN, and Intranet/ISP. The TE has MIP Client, IP, and Phys. layers. The MT has a Packet Domain bearer. The GGSN has IP with FA Functionality, (Tunneling), and Lower layers. The Intranet/ISP has Home Agent, IP, (Tunneling), and Lower layers. The Packet Domain bearer connects the MT to the GGSN.](0b3d9fe35da3ee0c88f1420bb9ed7a03_img.jpg) + +Figure 11d: Protocol stacks for user access with MIP. The diagram shows five entities: TE, MT, SGSN, GGSN, and Intranet/ISP. The TE has MIP Client, IP, and Phys. layers. The MT has a Packet Domain bearer. The GGSN has IP with FA Functionality, (Tunneling), and Lower layers. The Intranet/ISP has Home Agent, IP, (Tunneling), and Lower layers. The Packet Domain bearer connects the MT to the GGSN. + +Figure 11d: Protocol stacks for user access with MIP + +In figure 11d: "(Tunneling)" is intended to show asymmetric traffic flow. Tunneling (IP-in-IP) is only used in the direction from the ISP towards the MT. + +Authentication of the user is supported in Mobile IPv4. This authentication mechanism may involve communication with an authentication server (e.g. RADIUS), although this is not shown in figure 11d. + +Address allocation – at PDP context activation no IP address is allocated to the MS indicated by 0.0.0.0. in the "Requested PDP Address" field. If the MS does not have a static IP address which it could register with the HA, it will acquire a dynamic IP address from the HA RFC 2794 [25]. After completion of the PDP activation the SGSN is informed of the assigned IP address by means of the GGSN initiated PDP Context Modification Procedure. + +An example of a signalling scheme, shown in figure 11e, is described below. In this example the MS is separated into a TE and MT, with AT commands and PPP used in-between (see 3GPP TS 27.060 [10]). The PS attach procedures have been omitted for clarity. + +## IPv4 - Registration UMTS/GPRS + MIP , FA care-of address + +![Sequence diagram illustrating IPv4 Registration UMTS/GPRS + MIP, FA care-of address. The diagram shows the interaction between TE, MT, SGSN, GGSN/FA, and Home Network. The MS (Mobile Station) contains the TE (Terminal Equipment) and MT (Mobile Terminal). The sequence starts with the TE sending an AT Command (APN) to the MT, followed by LCP Negotiation (MRU) and IPCP Conf. Req (MIPv4). The MT then sends an Activate PDP Context Request (APN=MIPv4FA) to the SGSN. The SGSN selects a suitable GGSN and sends a Create PDP Context Request (APN=MIPv4FA) to the GGSN/FA. The GGSN/FA sends a Create PDP Context Response (no PDP address) to the SGSN. The SGSN then sends an Activate PDP Context Accept (no PDP address) to the MT. The MT sends an IPCP Conf. Ack (MIPv4) to the TE. The MT also sends an Agent Advertisement to the TE. The MT sends a MIP Registration Request to the GGSN/FA. The GGSN/FA sends a MIP Registration Request to the Home Network. The Home Network sends a MIP Registration Reply to the GGSN/FA. The GGSN/FA sends a MIP Registration Reply to the MT. The GGSN/FA also sends an Update PDP Context to the SGSN, with a note 'B. Insert home address in PDP Context'. The SGSN sends an Update PDP Context to the MT.](13fde41de77bf026013a0b81684d1fc9_img.jpg) + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN/FA + participant Home Network + Note right of MT: MS + + TE->>MT: 1. AT Command (APN) + MT-->>TE: 2. LCP Negotiation (MRU) + TE->>MT: 3. IPCP Conf. Req (MIPv4) + MT->>SGSN: 4. Activate PDP Context Request (APN=MIPv4FA) + Note right of SGSN: A. Select suitable GGSN + SGSN->>GGSN/FA: 5. Create PDP Context Request (APN=MIPv4FA) + GGSN/FA-->>SGSN: 6. Create PDP Context Response (no PDP address) + SGSN->>MT: 7. Activate PDP Context Accept (no PDP address) + MT->>TE: 8. IPCP Conf. Ack (MIPv4) + MT->>TE: 9. Agent Advertisement + MT->>GGSN/FA: 10. MIP Registration Request + GGSN/FA->>Home Network: 11. MIP Registration Request + Home Network-->>GGSN/FA: 12. MIP Registration Reply + GGSN/FA->>MT: 12. MIP Registration Reply + GGSN/FA->>SGSN: 13. Update PDP Context + Note right of GGSN/FA: B. Insert home address in PDP Context + SGSN->>MT: 13. Update PDP Context + +``` + +Sequence diagram illustrating IPv4 Registration UMTS/GPRS + MIP, FA care-of address. The diagram shows the interaction between TE, MT, SGSN, GGSN/FA, and Home Network. The MS (Mobile Station) contains the TE (Terminal Equipment) and MT (Mobile Terminal). The sequence starts with the TE sending an AT Command (APN) to the MT, followed by LCP Negotiation (MRU) and IPCP Conf. Req (MIPv4). The MT then sends an Activate PDP Context Request (APN=MIPv4FA) to the SGSN. The SGSN selects a suitable GGSN and sends a Create PDP Context Request (APN=MIPv4FA) to the GGSN/FA. The GGSN/FA sends a Create PDP Context Response (no PDP address) to the SGSN. The SGSN then sends an Activate PDP Context Accept (no PDP address) to the MT. The MT sends an IPCP Conf. Ack (MIPv4) to the TE. The MT also sends an Agent Advertisement to the TE. The MT sends a MIP Registration Request to the GGSN/FA. The GGSN/FA sends a MIP Registration Request to the Home Network. The Home Network sends a MIP Registration Reply to the GGSN/FA. The GGSN/FA sends a MIP Registration Reply to the MT. The GGSN/FA also sends an Update PDP Context to the SGSN, with a note 'B. Insert home address in PDP Context'. The SGSN sends an Update PDP Context to the MT. + +**Figure 11e: Example of PDP Context activation with Mobile IP registration +(the PS attach procedure not included)** + +1. The AT command carries parameters that the MT needs to request the PDP Context Activation. The important parameter here, is the APN (Access Point Name), see clause A below. The AT command is followed by a setup of the PPP connection between the MT and the TE. + 2. As part of the PPP connection, LCP negotiates Maximum-Receive-Unit between the TE and the MT. No PPP authentication is required when using MIPv4. + 3. As part of the PPP connection, the TE sends an IPCP Configure Request using the MIPv4 configuration option (see RFC 2290 [37]). The TE sends either its Home Address or a null address (i.e. 0.0.0.0) if the Network Address identifier is used (see RFC 2794 [25]). + 4. The MT sends the "Activate PDP Context Request" to the SGSN. The message includes various parameters of which the "APN" (Access Point Name) and the "Requested PDP Address" are of interest here. The TE/MT may use APN to select a reference point to a certain external network or to select a service. APN is a logical name referring to the external packet data network or to a service that the subscriber wishes to connect to. The "Requested PDP Address" should be omitted for all MSs using Mobile IP. This is done irrespective of if the TE has a permanently assigned Mobile IP address from its Mobile IP home network, a previously assigned dynamic home address from its Mobile IP home network or if it wishes the Mobile IP home network to allocate a "new" dynamic home address. +- A. The SGSN will base the choice of GGSN based on the APN that is given by the MS. +5. The SGSN requests the selected GGSN to set up a PDP Context for the MS. The PDP address and APN fields are the same as in the "Activate PDP Context Request" message. + 6. A Create PDP Context Response is sent from the GGSN/FA to the SGSN. If the creation of PDP Context was successful, some parameters will be returned to the SGSN, if not, an error code will be returned. If the GGSN has been configured, by the operator, to use a Foreign Agent for the requested APN, the PDP address returned by the GGSN shall be set to 0.0.0.0. indicating that the PDP address shall be reset by the MS with a Home Agent after the PDP context activation procedure. + +7. The Activate PDP Context Accept message is sent by the SGSN to the MT and contains similar information as the Create PDP Context Response message. +8. The MT sends an IPCP Configure Ack to the TE in order to terminate the PPP connection phase. +9. The Agent Advertisement RFC 3344 [30] is an ICMP (Internet Control Message Protocol) Router Advertisement message with a mobility agent advertisement extension. The latter part contains parameters of the FA that the mobile node needs, among those are one or more care-of addresses that the FA offers. This message should be sent, in the Packet Domain user plane, as an IP limited broadcast message, i.e. destination address 255.255.255.255, however only on the TEID for the requesting MS to avoid broadcast over the radio interface. +10. The Mobile IP Registration Request is sent from the mobile node to the GGSN/FA across the Packet Domain backbone as user traffic. The mobile node includes its (permanent) home address as a parameter RFC 3344 [30]. Alternatively, it can request a temporary address assigned by the home network by sending 0.0.0.0 as its home address, and include the Network Access Identifier (NAI) in a Mobile-Node-NAI Extension RFC 2794 [25] and RFC 2486 [31]. +11. The FA forwards the Mobile IP Registration Request to the home network of the mobile node, where a home agent (HA) processes it. Meanwhile, the GGSN/FA needs to store the home address of the mobile node or the NAI and the local link address of the MS, i.e. the TEID (Tunnel Endpoint ID). +12. The Registration Reply is sent from the home network to the FA, which extracts the information it needs and forwards the message to the mobile node in the Packet Domain user plane. As the FA/GGSN knows the TEID and the NAI or home address, it can pass it on to the correct MS. + - B. The GGSN/FA extracts the home address from the Mobile IP Registration Reply message and updates its GGSN PDP Context. +13. The GGSN triggers a "GGSN initiated PDP Context modification procedure" in order to update the PDP address in the SGSN and in the MT. + +### 11.2.1.5 IP Fragmentation Across Gi/Sgi + +3GPP and non-3GPP accesses provide IP services for a MS/UE. The GGSN/P-GW endpoint is a GTPv1-U tunnel (controlled by GTP Gn/Gp or S5/S8/S2a/S2b) or IP tunnel (controlled by S5/S8/S2a/S2b PMIPv6 or employed by a UE with MIPv4 or DSMIPv6). + +The MTU of the IP tunnel on the MS/UE side of the IP link may be different than the MTU of the IP link connecting the GGSN/P-GW to the PDN. As a result IP packets crossing the Gi/Sgi interface may need to be fragmented. Unnecessary fragmentation should be avoided when possible due to the following; + +- Fragmentation is bandwidth inefficient, since the complete IP header is duplicated in each fragment. +- Fragmentation is CPU intensive since more fragments require more processing at IP endpoints and IP routers. It also requires additional memory at the receiver. +- If one fragment is lost, the complete IP packet has to be discarded. The reason is there is no selective retransmission of IP fragments provided in IPv4 or IPv6. + +To avoid unnecessary fragmenting of IP packets the MS/UE, or a server in an external IP network, may find out the end-to-end MTU by path MTU discovery and hence fragment correctly at the source. IP Fragmentation on Gi/Sgi shall be handled according to IETF RFC 791 [16] and IETF RFC 2460 [49]. The GGSN/P-GW shall enforce the MTU of IP packets to/from the MS/UE based on IETF RFC 791 [16] and IETF RFC 2460 [49]. + +### 11.2.1.6 Support for CUPS across SGi + +Control plane and user plane separation of PGW as PGW-C and PGW-U, has been introduced as described in 3GPP TS 23.214 [117]. + +For UE IP address from the DN AAA server in the external PDN: If the AAA server in the external PDN is reachable only via the PGW-U, the PGW-U forward all the Diameter or RADIUS messages between the DN AAA server in the external PDN and the PGW-C, according to 3GPP TS 29.244 [114]. + +For UE IP address from DHCPv4/v6 server in the external PDN: If the DHCPv4/v6 server in the external PDN is reachable only via the PGW-U, the PGW-U forward all the DHCPv4/v6 messages between the DHCPv4/v6 server in the external PDN and the PGW-C. according to 3GPP TS 29.244 [114]. + +NOTE: If the DN AAA server or the DHCPv4/v6 server in the external PDN is reachable directly, then the PGW-C communicates with it directly, without involving the PGW-U. + +### 11.2.1.7 Support L2TP for CUPS across SGi + +L2TP (described in IETF RFC 2661 [118]) is a standard method for tunneling encapsulated Point-to-Point Protocol (PPP) frames over an IP network. L2TP operates between two L2TP endpoints (LAC and LNS), and tunnels PPP-encapsulated IP traffic between these endpoints. L2TP runs over UDP/IP and was originally defined for systems where PPP is used by an end-device to connect to a network (e.g. via DSL connections, or 2G/3G PPP PDP context). In these cases, a LAC could be deployed in the network (e.g. in a BNG or GGSN/PGW) to tunnel the PPP traffic to a server (LNS) over an IP network. + +For CUPS with the UE using IP PDN connection, the PPP functionality that is required to use L2TP is instead supported by the PGW-U, as illustrated in below figure. Upon receiving a PDN connection session establishment request from the UE via MME and SGW-C, PGW-C may depend on local L2TP configuration per APN or the received L2TP information from a DN AAA server in Access-Accept message, request the PGW-U to setup L2TP tunnel towards an L2TP network server (LNS) in the external DN and tunnel the PDN Connection user plane traffic in this L2TP tunnel. In this case the PGW-U acts as a L2TP access concentrator (LAC). + +To enable this, the PGW-C may provide L2TP tunnel information to the PGW-U as LAC, such as LNS IP address as described in 3GPP TS 29.244 [114]. This L2TP tunnel information may be configured on the PGW-C as part of the APN configuration or received from the DN-AAA server. Alternatively, the L2TP tunnel parameters may be configured in the PGW-U. The L2TP tunnel parameters include necessary parameters for setting up L2TP tunnel towards the LNS (e.g. LNS address, tunnel password). + +In addition, the PGW-C may provide PAP/CHAP authentication information to the PGW-U, for use in L2TP session establishment, in case it was received from the UE in the PCO or ePCO IE of the PDN Connection establishment request message. + +When L2TP is to be used for a PDN Connection, the PGW-C may select a PGW-U and requests the UE IP address to be allocated by LNS according to 3GPP TS 29.244 [114], the PGW-U (LAC) may retrieve this IP address from the LNS. + +![Diagram illustrating the L2TP Tunnel between CUPS and external DN. The diagram shows the flow of traffic from the UE through the RAN, MME, SGW-C, PGW-C, and PGW-U/LAC to the external DN, where it connects to the LNS. The L2TP tunnel is established between the PGW-U/LAC and the LNS. The EPC (Evolved Packet Core) is shown as a dashed box containing the MME, SGW-C, PGW-C, SGW-U, and PGW-U/LAC. The external DN is shown as a dashed circle containing the AAA server and LNS. The SGi interface is shown between the PGW-C and the external DN. The S1 interface is shown between the RAN and the MME. The S11 interface is shown between the MME and the SGW-C. The S5 interface is shown between the SGW-C and the PGW-C. The Sxa interface is shown between the SGW-C and the SGW-U. The Sxb interface is shown between the PGW-C and the PGW-U/LAC. The L2TP Tunnel is shown as a double-headed arrow between the PGW-U/LAC and the LNS.](ccdeaf31dbe65613f2f87a7b2b06e391_img.jpg) + +Diagram illustrating the L2TP Tunnel between CUPS and external DN. The diagram shows the flow of traffic from the UE through the RAN, MME, SGW-C, PGW-C, and PGW-U/LAC to the external DN, where it connects to the LNS. The L2TP tunnel is established between the PGW-U/LAC and the LNS. The EPC (Evolved Packet Core) is shown as a dashed box containing the MME, SGW-C, PGW-C, SGW-U, and PGW-U/LAC. The external DN is shown as a dashed circle containing the AAA server and LNS. The SGi interface is shown between the PGW-C and the external DN. The S1 interface is shown between the RAN and the MME. The S11 interface is shown between the MME and the SGW-C. The S5 interface is shown between the SGW-C and the PGW-C. The Sxa interface is shown between the SGW-C and the SGW-U. The Sxb interface is shown between the PGW-C and the PGW-U/LAC. The L2TP Tunnel is shown as a double-headed arrow between the PGW-U/LAC and the LNS. + +Figure 11f: L2TP Tunnel between CUPS and external DN + +Below figure describes the L2TP connection procedures between CUPS and external DN, upon the UE is accessed in EPS and the PGW-C and PGW-U has been negotiated supporting L2TP feature. + +![Sequence diagram showing L2TP connection procedures between CUPS and external DN. Lifelines: UE, PGW-C, PGW-U/LAC, DN AAA server, LNS (in external DN).](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PGW-C + participant PGW-U/LAC + participant DN AAA server + participant LNS as LNS (in external DN) + + Note over PGW-C, PGW-U/LAC: 0. L2TP Support Negotiation between PGW-C and PGW-U + PGW-C->>PGW-U/LAC: + PGW-U/LAC->>PGW-C: + + Note left of PGW-C: 1. PDN Connection Session Establishment Request (PCO:username, password) + UE->>PGW-C: + + PGW-C-->>DN AAA server: Access-Request/AAR + Note right of DN AAA server: 2. + DN AAA server-->>PGW-C: Access-Accept/AAA (LNS address, etc.) + + Note over PGW-C, PGW-U/LAC: 3. PFCP Session Establishment Request (L2TP Connection Information) + PGW-C->>PGW-U/LAC: + + rect rgb(240, 240, 240) + Note over PGW-U/LAC, LNS: 4. L2TP Tunnel Setup (if required) + PGW-U/LAC->>LNS: SCCRQ: Start-Control-Connection-Request + LNS->>PGW-U/LAC: SCCRP: Start-Control-Connection-Reply + PGW-U/LAC->>LNS: SCCCN: Start-Control-Connection-Connected + LNS->>PGW-U/LAC: ZLB ACK: Zero-Length Body Acknowledge + end + + rect rgb(240, 240, 240) + Note over PGW-U/LAC, LNS: 5. L2TP Session Setup + PGW-U/LAC->>LNS: ICRQ: Incoming-Call-Request + LNS->>PGW-U/LAC: ICRP: Incoming-Call-Reply + PGW-U/LAC->>LNS: ICCN: Incoming-Call-Connected + LNS->>PGW-U/LAC: ZLB ACK: Zero-Length Body Acknowledge + end + + Note over PGW-C, PGW-U/LAC: 6. PFCP Session Establishment Response (Created L2TP Connection) + PGW-U/LAC->>PGW-C: + + Note left of PGW-C: 7. PDN Connection Session Establishment Response + PGW-C->>UE: + + Note over UE, LNS: User Data Session + UE<->LNS: + +``` + +Sequence diagram showing L2TP connection procedures between CUPS and external DN. Lifelines: UE, PGW-C, PGW-U/LAC, DN AAA server, LNS (in external DN). + +**Figure 11g: L2TP connection procedures between CUPS and external DN** + +0. The PGW-C and the PGW-U negotiated supporting L2TP feature as specified in 3GPP TS 29.244 [114]. +1. The PGW-C receives a PDN Connection session establishment request from the UE via MME and SGW-C. + +The UE may include the authentication information for PAP and/or CHAP in PCO or ePCO IE. The PGW-C may locally configure the UE authentication information for a given APN. + +The PGW-C may determine that an L2TP session is required for the PDN Connection session based on local configured L2TP parameters per APN. + +2. The PGW-C may receive the L2TP Tunnel parameters (e.g. LNS IP address or FQDN, tunnel password) from the DN-AAA server in Access-Accept message or Diameter AAA message, or local configured. +3. If L2TP protocol is determined to support the PDN connection, the PGW-C selects a PGW-U supporting L2TP and be configured with the LAC name/addresses and then requests the PGW-U to setup an L2TP tunnel if needed and/or L2TP session towards the L2TP network server (LNS). + +The PGW-C sends PFCP Session Establishment Request to the PGW-U, which may include L2TP Tunnel Information for setting up a L2TP tunnel and L2TP session information to setup a L2TP session, together with the information for authentication used during L2TP Tunnel setup, as well as for L2TP session. + +The L2TP Tunnel Information includes LNS IPv4 address or IPv6 address of LNS, Tunnel Password. + +The L2TP Session Information includes specific information related to the PDN Connection, e.g. a Calling Number which may be set to UE's MSISDN, an indication to instruct that the PGW-U shall request the LNS to allocate an IP address for the PDN session, indications to instruct that the PGW-U shall request the LNS to provide DNS server addresses or NBNS server addresses etc. as specified in 3GPP TS 29.244 [114]. + +4. The PGW-U checks if any existing L2TP tunnel can be used to serve the PDN Connection according to the information provided in the L2TP Tunnel Information. + +If the PGW-U decides to setup a new L2TP tunnel, it initiates L2TP Tunnel establishment by sending an SCCRQ (Start-Control-Connection-Request) message towards the LNS, the PGW-U will allocate a Tunnel ID, and it may include a CHAP Challenge to authenticate the LNS. The Challenge and Challenge Response (to be included in SCCCN) is produced by the PGW-U using the Tunnel Password received from the PGW-C. + +The LNS responds with an SCCRP (Start-Control-Connection-Reply) message, containing its allocated Tunnel ID and a CHAP Challenge Response to the Challenge in SCCRQ. + +The PGW-U then responds with a Challenge response for tunnel authentication in the SCCCN (Start-Control-Connection-Connected) message. An L2TP tunnel is established after the tunnel authentication is successful, with the reception of the SCCCN message sent by the PGW-U to the LNS. + +If the PGW-U decides to use an already existing L2TP tunnel for the requested PDN Connection from the PGW-C, it proceeds with step 5 below directly without current step. + +5. Once the L2TP Tunnel is established (or already present) between the PGW-U and the LNS for the PDN Connection requested by the UE, the PGW-U proceeds with L2TP session setup towards the LNS. + +The PGW-U sends an ICRQ (Incoming-Call-Request) message towards the LNS, which contains the Tunnel ID assigned by the LNS, its assigned Session ID, and optionally, the Calling Number and Called Number. The LNS responds with an ICRP (Incoming-Call-Reply) message and provides the Session ID assigned by it to the LAC. + +The PGW-U then sends an ICCN (Incoming-Call-Connected) message. If proxy LCP and authentication are employed, the ICCN message includes the link control parameters (e.g. MRU) and UE authentication information sent from the PGW-C which was received via PCO or ePCO IE in step 1. In addition, the PGW-U (LAC) will act as a PPP endpoint to use IPCP to request UE IP Address, DNS server address and/or NBNS server address(es). + +The LCP renegotiation may be triggered by the LNS after receiving the ICCN message. If so, the LAC and LNS will use PPP LCP to communicate link specific control parameter (e.g. MRU), and indicate authentication type, then either PPP PAP/CHAP takes place. The PPP IPCP transactions takes place to retrieve UE IP Address, DNS server address and/or NBNS server address. + +6. The status of the L2TP session setup is sent by the PGW-U to the PGW-C in a PFCP Session Establishment Response. +7. The PGW-C sends a PDU Session Establishment Response to the UE and the user data session is initiated, which may contain the DNS and NBNS Server information. + +## 11.2.2 Access to networks handling Non-IP data services through Packet Domain + +The support of Non-IP data is part of the CIoT EPS optimisations (see 3GPP TS 23.401 [77]) and 3GPP TS 23.060 [3]). A PDN/PDP Type "Non-IP" is used for Non-IP data. The Non-IP data delivery to the network handling Non-IP data services is accomplished by one of two mechanisms: + +- Delivery using SCEF +- Delivery using a Point-to-Point (PtP) SGi tunnel + +Data delivery using SCEF is further described in 3GPP TS 29.128 [110]. + +In order to allow Non-IP delivery data using SGi PtP tunnelling based on UDP/IP (see subclause 11.8), the Packet Domain may offer direct transparent access to the Non-IP Packet Data Network with the following characteristics: + +- The IPv4 address and/or IPv6 prefix is assigned as part of the PDN connection establishment and identifies the PDN connection of the UE within the PLMN domain. +- IP address allocation procedures for the UE (i.e. PDN connection) are performed by the GGSN/P-GW based on APN configuration. Only a single IP address is used (i.e. either IPv4 or IPv6 prefix+Interface Identifier is allocated/assigned). In case of IPv6 the GGSN/P-GW assigns an Interface Identifier for the PDN connection. The IP address or IP prefix is not provided to the UE (i.e. SLAAC / Router Advertisements are not performed. DHCP or DHCPv6 are not used). +- The assigned IPv4 address or IPv6 prefix is used for UDP/IP encapsulation for PtP tunneling between the Non-IP network and the GGSN/P-GW (see subclause 11.8). +- Stateless Address Autoconfiguration does not apply for IPv6. Both IPv4 and IPv6 addresses belong to the operator addressing space. + +User authentication and encryption of user data when accessing networks handling Non-IP data services is outside 3GPP specification. + +## 11.3 Numbering and Addressing + +In the case of interworking with public IP networks (such as the Internet), the PLMN operator shall use public network addresses. These public addresses can be reserved from the responsible IP numbering body, or from an ISP with which the PLMN operator has an agreement. In case of IPv6, a global IPv6 prefix can be obtained from the same sources. + +In the case of interworking with private IP networks, two scenarios can be identified: + +1. the PLMN operator manages internally the subnetwork IPv4 addresses and/ or IPv6 prefixes as applicable. Each private network is assigned a unique subnetwork IPv4 addresses and/ or IPv6 prefixes. Normal routing functions are used to route packets to the appropriate private network; +2. each private network manages its own addressing. In general this will result in different private networks having overlapping address ranges. A logically separate connection (e.g. an IP in IP tunnel or layer 2 virtual circuit) is used between the GGSN/P-GW and each private network. In this case the IP address alone is not necessarily unique. The pair of values, Access Point Name (APN) and IPv4 address and/or IPv6 prefixes, is unique. + +NOTE 1: In IPv6, "site-local addresses" were originally designed to be used for addressing inside of a site that is similar to the usage of "private addresses" in IPv4. The usage of "site-local-addresses" is deprecated as specified in RFC 4291 [82]. Existing implementations and deployments may continue using site-local addresses. However, in new implementations the prefix that was allocated for "site local addresses" shall be treated as for "global unicast addresses", see RFC 4291 [82]. + +The PLMN operator allocates the IP addresses for the subscribers in either of the following ways. + +- The PLMN operator allocates a static IPv4 address and/or a static IPv6 prefix when the subscription record is built. The IPv4 address and/or IPv6 prefix are respectively reserved from a pool of free IPv4 addresses and/or IPv6 prefixes. Each external network has its own pool of IPv4 addresses and/or IPv6 prefixes. +- The PLMN operator allocates (either on its own or in conjunction with the external network) a dynamic IPv4 address and/or a dynamic IPv6 prefix as described in 3GPP TS 23.060 [3], 3GPP TS 23.401 [77] and 3GPP TS 23.402 [78]. + +For UEs used for Machine-Type Communications (MTC) as described in 3GPP TS 23.401 [77] and 3GPP TS 23.060 [3] and Cellular Internet of Things (CIoT) as described in 3GPP TS 23.401 [77] and 3GPP TS 23.060 [3], IPv6 address allocation should be the primary mechanism for IP address allocation. IPv4 based address allocation is considered a transition solution and is deprecated for MTC used over 3GPP accesses. + +NOTE 2: For implementation guidelines related to transition and other aspects of IPv4 address usage see 3GPP TS 23.221 [99] Annex B. + +In case of transferring Non-IP data over SGi PtP tunnelling based on UDP/IP (see subclause 11.8) the PLMN operator uses private network addresses for the establishment of the tunnel. + +## 11.4 Charging + +The PLMN operator may define the accuracy of the charging mechanism using one of the following categories: + +- every source/destination pair is logged separately; +- source/destination pairs are logged to an accuracy of subnetworks; +- source/destination pairs are logged to an accuracy of connection types (e.g., external data network, corporate network, another mobile). + +## 11.5 Domain Name System Server (DNS Server) + +Provision of Domain Name services shall be provided by the PLMN operators in the transparent case and the ISP in the non transparent case. For non-EPS networks see 3GPP TS 23.060 [3] (DNS documentation is provided in RFC 1034 [19] and RFC 1035 [58]) and for EPS networks see 3GPP TS 29.303 [96]. + +## 11.6 Screening + +The way the PLMN is performing the operator controlled screening and the subscription controlled screening is out of the scope of the present document. These functions may be done, for example, in a firewall. + +## 11.7 IP Multicast access + +NOTE: This section is applicable only to GERAN and UTRAN. + +The Packet Domain could allow access to IP Multicast traffic coming from an external network. The support of IP-Multicast in the Packet Domain is optional. + +In order for the Packet Core Network to support Multicast traffic that will allow the MS/UE to subscribe to multicast groups from outside the PLMN, the GGSN/P-GW shall support IGMP (IPv4) and/or MLD (IPv6) and one or more Inter-Router Multicast protocols, such as DVMRP, MOSPF, or PIM-SM. + +IGMP/MLD is an integral part of IP. All hosts wishing to receive IP multicasts are required to implement IGMP (or equivalent) and class-D IPv4 addresses or MLD and IPv6 multicast according to RFC 2710 [48]. IGMP/MLD messages are encapsulated in IP datagrams. + +To be able to deliver IP-Multicast packets to the appropriate Tes, the GGSN/P-GW may have an IP-Multicast proxy functionality. + +The IP-Multicast proxy will perform the following tasks: + +NOTE: In this example it is assumed that IGMP/MLD is used as a Host-Router Multicast protocol. + +- maintain a list of mobiles that joined one or more Multicast groups. This list is built/updated each time the GGSN/P-GW receives an IGMP Join or MLD Report message from the mobile; +- send, based on this maintained list of mobiles, multicast routing information to the routers attached to the Packet Domain, allowing them to route multicast packets; +- upon reception by the GGSN/P-GW of multicast packets, make and send a copy as Point-to-Point packets, to each mobile of the group. + +IP-Multicast traffic can only be handled after an MS/UE has attached to the Packet Domain, and a bearer (e.g. Activated PDP context(s)) (including possibly authentication) pointing to the preferred ISP/external network for this purpose. The Multicast traffic is handled at the application level from a Packet Domain perspective and is sent over UDP/IP. + +Figure 12 depicts the protocol configuration for handling Multicast traffic (control plane) for the non-EPC based domain case. The Multicast traffic handling affects the GGSN by the introduction of the IP-Multicast proxy and the support for an Inter-Router Multicast protocol and a host-router multicast protocol. If the protocol configuration for + +handling Multicast traffic (control plane) is applied for Sgi (i.e EPC based packet domain), the P-GW has the functionality of GGSN and Sgi corresponds to the Gi in Figure 12. + +![Figure 12: Protocol configuration for IP-Multicast handling (control plane). The diagram shows four main entities: TE+MT, SGSN, GGSN, and Intranet/ISP. TE+MT contains IP-M Application, IGMP, and IP layers. SGSN contains IP-M Proxy, IGMP, and IP layers. GGSN contains IP-M Proxy, PIM (or equiv), IP, and Lower layers. Intranet/ISP contains PIM (or equiv), IP, and Lower layers. A dashed line connects the IP-M Application in TE+MT to an IP-M application server in Intranet/ISP, passing through the IP-M Proxy in GGSN. A vertical dashed line labeled 'Gi' separates the GGSN and Intranet/ISP. A 'Packet Domain bearer' is shown between TE+MT and GGSN.](7fe5741e83bc9702d1b1d7585ddf66bd_img.jpg) + +Figure 12: Protocol configuration for IP-Multicast handling (control plane). The diagram shows four main entities: TE+MT, SGSN, GGSN, and Intranet/ISP. TE+MT contains IP-M Application, IGMP, and IP layers. SGSN contains IP-M Proxy, IGMP, and IP layers. GGSN contains IP-M Proxy, PIM (or equiv), IP, and Lower layers. Intranet/ISP contains PIM (or equiv), IP, and Lower layers. A dashed line connects the IP-M Application in TE+MT to an IP-M application server in Intranet/ISP, passing through the IP-M Proxy in GGSN. A vertical dashed line labeled 'Gi' separates the GGSN and Intranet/ISP. A 'Packet Domain bearer' is shown between TE+MT and GGSN. + +Figure 12: Protocol configuration for IP-Multicast handling (control plane) + +## 11.8 Non-IP data transferring over SGi + +### 11.8.1 General + +When support of Non-IP data is provided at the Gi/SGi interface, different Point-to-Point (PtP) tunneling techniques may be used. When using PtP tunneling by UDP/IP encapsulation subclause 11.8.2 below shall be followed. Other techniques as described in clause 11.8.3 below may be used. + +The Gi/SGi based Non-IP data delivery is applicable to the User Plane C IoT EPS Optimization and the Control Plane C IoT EPS Optimization (see 3GPP TS 23.401 [77] and 3GPP TS 23.060 [3]). + +### 11.8.2 Gi/SGi PtP tunnelling based on UDP/IP + +Gi/SGi PtP tunnelling based on UDP/IP may be used to deliver Non-IP data to an AS via Gi/SGi. + +The PtP tunnel is set up by configuration of tunnel parameters in both end of the tunnel. + +The following parameters are pre-configured in the GGSN/P-GW per APN; + +- the UDP destination port number to use when sending Non-IP data; +- the UDP port number it wants to receive Non-IP data; +- the destination IP address to be used for sending Non-IP data. + +NOTE 1: Many APNs can resolve to the same P-GW, but each APN can be unique to a particular AS. + +The following is pre-configured in the AS; + +- the UDP destination port number to use when sending Non-IP data; +- the UDP port number it wants to receive Non-IP data. + +NOTE 2: The GGSN/P-GW as well as the AS can use any UDP port numbers not assigned by IANA. The port numbers used need to be aligned between peers. + +IP address allocation procedures for the UE (i.e. PDN connection) are performed by the GGSN/P-GW as described in subclause 11.2.2. + +The UE IP address for the PDN connection or IPv6 prefix allocated for the PDN connection+suffix assigned for the PtP tunnel end point in the GGSN/P-GW is used as source address in the GGSN/P-GW and as destination address in the AS for the PtP tunnel. + +During the PDP context/PDN connection establishment, the GGSN/P-GW associates the GTP-U tunnel for the PDP context/PDN connection with the Gi/SGi PtP tunnel. The GTP-U tunnel with PDP/PDN type “Non-IP” is used. + +The GGSN/P-GW acts as a transparent forwarding node between the UE used for CIoT and the AS. + +NOTE 3: The UE can include application level identity to AS, what kind of identity is out of scope of this specification. + +For uplink delivery, if the uplink data is received from the GTP-U tunnel the GGSN/P-GW shall forward the received data to the AS over the Gi/SGi PtP tunnel associated with the GTP-U tunnel using UDP/IP encapsulation with the destination address of the AS and the configured UDP destination port number for “Non-IP” data as described above. + +For downlink delivery, the AS shall send the data using UDP/IP encapsulation with the IP address or IPv6 prefix+suffix of the UE as destination address and the configured UDP destination port number for “Non-IP” data as described above. + +NOTE 3: The UDP source port number to use for both uplink and downlink Non-IP data transfer can be a pre-configured or a locally allocated port number in the GGSN/P-GW and AS respectively. + +NOTE 4: For downlink delivery, the GGSN/P-GW decapsulates the received data (i.e. removes the UDP/IP headers) and forwards the data to SGSN/S-GW on the GTP-U tunnel identified by the IP address or the IPv6 prefix of the UE (i.e. PDN connection) for delivery to the UE. + +![Figure 11.8: Protocol configuration for Non-IP data (user plane) using SGiPtP tunneling. The diagram shows three main entities: S-GW, P-GW, and AS. The S-GW and P-GW are connected via S5/S8 interfaces, and the P-GW is connected to the AS via an SGi interface. The protocol stack is shown in layers: Non-IP, UDP, IP, L2, and L1. The S-GW and P-GW have 'Relay' blocks at the top. The S-GW's relay block contains two GTP-U entries. The P-GW's relay block contains one GTP-U entry and one UDP entry. The AS has a single column for its protocol stack. Horizontal lines connect the layers between adjacent entities.](b4f6d3668f7e851eaff07ccf26001623_img.jpg) + +Figure 11.8: Protocol configuration for Non-IP data (user plane) using SGiPtP tunneling. The diagram shows three main entities: S-GW, P-GW, and AS. The S-GW and P-GW are connected via S5/S8 interfaces, and the P-GW is connected to the AS via an SGi interface. The protocol stack is shown in layers: Non-IP, UDP, IP, L2, and L1. The S-GW and P-GW have 'Relay' blocks at the top. The S-GW's relay block contains two GTP-U entries. The P-GW's relay block contains one GTP-U entry and one UDP entry. The AS has a single column for its protocol stack. Horizontal lines connect the layers between adjacent entities. + +**Figure 11.8: Protocol configuration for Non-IP data (user plane) using SGiPtP tunneling** + +![Figure 11.9: Protocol configuration for Non-IP data (user plane) using Gi PtP tunneling. The diagram shows three main entities: SGSN, GGSN, and AS. The SGSN and GGSN are connected via Gn/Gp interfaces, and the GGSN is connected to the AS via a Gi interface. The protocol stack is shown in layers: Non-IP, UDP, IP, L2, and L1. The SGSN and GGSN have 'Relay' blocks at the top. The SGSN's relay block contains two GTP-U entries. The GGSN's relay block contains one GTP-U entry and one UDP entry. The AS has a single column for its protocol stack. Horizontal lines connect the layers between adjacent entities.](0b452c5334567cbdc22ee9817e1246f5_img.jpg) + +Figure 11.9: Protocol configuration for Non-IP data (user plane) using Gi PtP tunneling. The diagram shows three main entities: SGSN, GGSN, and AS. The SGSN and GGSN are connected via Gn/Gp interfaces, and the GGSN is connected to the AS via a Gi interface. The protocol stack is shown in layers: Non-IP, UDP, IP, L2, and L1. The SGSN and GGSN have 'Relay' blocks at the top. The SGSN's relay block contains two GTP-U entries. The GGSN's relay block contains one GTP-U entry and one UDP entry. The AS has a single column for its protocol stack. Horizontal lines connect the layers between adjacent entities. + +**Figure 11.9: Protocol configuration for Non-IP data (user plane) using Gi PtP tunneling.** + +### 11.8.3 Other SGi PtP tunnelling mechanisms + +SGi PtP tunnelling mechanisms such as PMIPv6/GRE, L2TP, GTP-C/U, etc, may be used to deliver Non-IP data to AS via SGi. + +The PtP tunnel is established towards the AS by the P-GW. Depending on the type of protocol employed on the SGi PtP tunnel, the SGi PtP tunnel setup may be done at the time of attach or at the time of first MO datagram being sent by the CIoT UE. + +The P-GW selects the AS based on the P-GW configuration (eg. per APN, or per PtP tunnel type etc). + +NOTE: IP address allocation procedures for the UE are not performed by the P-GW. + +For uplink Non-IP data, the P-GW forwards the received data to the AS over the established SGi PtP tunnel. + +For downlink Non-IP data, the AS locates the right SGi PtP tunnel for the UE (using information such as UE identifiers in the Non-IP protocol itself, etc) to forward the data. The AS sends the data to P-GW over the established SGi PtP tunnel. The P-GW then sends the data to S-GW on the GTP-U tunnel identified by the associated SGi PtP tunnel for delivery to the UE. + +## 11.9 Transport Level Marking + +Based on operator policy, the transport level packet marking (e.g. setting the DiffServ Code Point) by the P-GW in the uplink may be based on the QCI, and optionally the ARP priority level, of the associated EPS bearer. + +--- + +## 12 Interworking with PDN (PPP) + +### 12.1 General + +By means of the PDP type 'PPP' Packet Domain may support interworking with networks based on the point-to-point protocol (PPP), as well as with networks based on any protocol supported by PPP through one of its Network Control Protocols (NCPs). All protocols currently supported by PPP NCPs are listed in RFC 1661 [21a] and RFC 1662 [21b]. It may also support interworking by means of tunnelled PPP, by e.g. the Layer Two Tunnelling Protocol (L2TP). + +### 12.2 PDN Interworking Model + +The interworking point is at the Gi reference point. The GGSN for interworking with the ISP/PDN is the access point of the Packet Domain (see figure 13). The GGSN will either terminate the PPP connection towards the MS or may further relay PPP frames to the PDN. The PPP frames may be tunnelled in e.g. L2TP. + +![Figure 13: The protocol stacks for the Gi PPP reference point. The diagram shows a GGSN (dashed box) and a Packet Domain Bearer. Inside the GGSN, the stack consists of PPP, PPP-NCP supported protocol or PPP, and a stack of e.g. L2TP, UDP, and IP. The Packet Domain Bearer is connected to the PPP layer. The Gi interface is shown on the right side of the GGSN.](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +The diagram illustrates the protocol stack for the Gi PPP reference point. A dashed box labeled 'GGSN' contains a 'PPP' layer, a 'PPP-NCP supported protocol or PPP' layer, and a stack of 'e.g. L2TP', 'UDP', and 'IP'. Below the GGSN box is a 'Packet Domain Bearer' layer. To the right of the GGSN box is the 'Gi' interface. At the bottom of the GGSN box, there are 'L2' and 'L1' layers. + +Figure 13: The protocol stacks for the Gi PPP reference point. The diagram shows a GGSN (dashed box) and a Packet Domain Bearer. Inside the GGSN, the stack consists of PPP, PPP-NCP supported protocol or PPP, and a stack of e.g. L2TP, UDP, and IP. The Packet Domain Bearer is connected to the PPP layer. The Gi interface is shown on the right side of the GGSN. + +**Figure 13: The protocol stacks for the Gi PPP reference point** + +In case the external PDN is an IP based network and the GGSN terminates PPP the same description applies as specified in subclause 11.2. + +In case the GGSN tunnels PPP frames to the PDN, the GGSN may behave like a LAC towards the external network. + +### 12.2.1 Virtual dial-up- and direct Access to PDNs, or ISPs through Packet Domain + +The access to PDNs, or ISPs may involve specific functions such as: user authentication, user's authorization, end to end encryption between MS and PDN/ISP, allocation of a dynamic address belonging to the PLMN/PDN/ISP addressing space, etc. + +For this purpose the PLMN may offer, based on configuration data: + +- direct access to an IP based Intranet/ISP using a protocol configuration as depicted in figure 14. Here DHCP and/or RADIUS are used between the GGSN and Intranet/ISP for performing the specific functions mentioned above. The Packet Domain may also offer access to networks based on any protocol supported by PPP through one of its Network Control Protocols (NCPs); + +![Figure 14: Protocol stack for direct access to IP-based Intranets/ISPs. The diagram shows five entities: TE, MT, SGSN, GGSN, and Intranet/ISP. The TE has a PPP layer and a Phy. layer. The MT has a Packet Domain bearer layer. The SGSN has a Packet Domain bearer layer. The GGSN has a PPP layer, a DHCP/RADIUS layer, a UDP layer, an IP layer, and Lower layers. The Intranet/ISP has a DHCP/RADIUS layer, a UDP layer, an IP layer, and Lower layers. The Packet Domain bearer layer is shared between the MT and the SGSN.](5c65cabec7c5062117fb0d578916cf8b_img.jpg) + +The diagram illustrates the protocol stack for direct access to IP-based Intranets/ISPs. It shows five entities: TE, MT, SGSN, GGSN, and Intranet/ISP. The TE has a 'PPP' layer and a 'Phy. layer'. The MT has a 'Packet Domain bearer' layer. The SGSN has a 'Packet Domain bearer' layer. The GGSN has a 'PPP' layer, a 'DHCP/RADIUS' layer, a 'UDP' layer, an 'IP' layer, and 'Lower layers'. The Intranet/ISP has a 'DHCP/RADIUS' layer, a 'UDP' layer, an 'IP' layer, and 'Lower layers'. The 'Packet Domain bearer' layer is shared between the MT and the SGSN. + +Figure 14: Protocol stack for direct access to IP-based Intranets/ISPs. The diagram shows five entities: TE, MT, SGSN, GGSN, and Intranet/ISP. The TE has a PPP layer and a Phy. layer. The MT has a Packet Domain bearer layer. The SGSN has a Packet Domain bearer layer. The GGSN has a PPP layer, a DHCP/RADIUS layer, a UDP layer, an IP layer, and Lower layers. The Intranet/ISP has a DHCP/RADIUS layer, a UDP layer, an IP layer, and Lower layers. The Packet Domain bearer layer is shared between the MT and the SGSN. + +**Figure 14: Protocol stack for direct access to IP-based Intranets/ISPs** + +- virtual dial-up access to a PDN with PPP frame tunnelling as depicted in figure 15. + +![Figure 15: Protocol stack for virtual dial-up access with PPP frame tunnelling. The diagram shows five entities: TE, MT, SGSN, GGSN (LAC), and LNS. The TE has a stack of PPP and Phy. layer. The MT has a Packet Domain bearer. The GGSN (LAC) has a stack of PPP, e.g. L2TP, UDP, IP, and Lower layers. The LNS has a stack of e.g. L2TP, UDP, IP, and Lower layers. The MT and GGSN (LAC) are connected via the Packet Domain bearer.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +| TE | MT | SGSN | GGSN (LAC) | LNS | +|------------|----------------------|------|--------------|--------------| +| PPP | Packet Domain bearer | | PPP | e.g. L2TP | +| Phy. layer | | | Lower layers | Lower layers | + +Figure 15: Protocol stack for virtual dial-up access with PPP frame tunnelling. The diagram shows five entities: TE, MT, SGSN, GGSN (LAC), and LNS. The TE has a stack of PPP and Phy. layer. The MT has a Packet Domain bearer. The GGSN (LAC) has a stack of PPP, e.g. L2TP, UDP, IP, and Lower layers. The LNS has a stack of e.g. L2TP, UDP, IP, and Lower layers. The MT and GGSN (LAC) are connected via the Packet Domain bearer. + +**Figure 15: Protocol stack for virtual dial-up access with PPP frame tunnelling** + +### 12.2.1.1 Procedural description + +In this case: + +- the MS is given an address belonging to the Intranet/ISP addressing space. The address is given either at subscription in which case it is a static address or at PDP context activation in which case it is a dynamic address. This address is used for packet forwarding within the GGSN and for packet forwarding on the Intranet/ISP. This requires a link between the GGSN and an address allocation server, such as AAA, or DHCP, belonging to the Intranet/ISP; +- the communication between the Packet Domain and the Intranet/ISP may be performed over any network, even an insecure e.g. the Internet. In case of an insecure connection between the GGSN and the Intranet/ISP there may be a specific security protocol in between. This security protocol is defined by mutual agreement between PLMN operator and Intranet/ISP administrator. + +The following description bullet items describe the signal flow. + +- 1) The TE sends an AT-command to the MT to set up parameters. +- 2) The MT sends the Activate PDP context request message to the SGSN which sends the Create PDP context request message to the chosen GGSN. +- 3) The GGSN deduces from the APN: + - the server(s) to be used for address allocation and authentication; + - the protocol such as RADIUS, DHCP or L2TP to be used with this / those server(s); + - the communication and security feature needed to dialogue with this / those server(s) e.g. tunnel ,IPSec security association, dial-up connection (using possibly PPP). + +As an example the GGSN may use one of the following options: + +- RADIUS for authentication and IP-address allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN; + - RADIUS for authentication and DHCP for host configuration and address allocation. The AAA server responds with either an Access-Accept or an Access-Reject to the RADIUS client in the GGSN. After a successful authentication, the DHCP client discovers the DHCP server(s) in the ISP/Intranet and receives host configuration data; + - L2TP for forwarding PPP frames to a L2TP Network Server. +- 4) The GGSN sends back to the SGSN a Create PDP Context Response message. + - 5) Depending on the cause value received in the Create PDP Context Response the SGSN may either send the Activate PDP Context Accept message or send the Activate PDP Context Reject message to the MS. + +- 6) The MT responds with an AT-response that may indicate whether the context activation was successful or not. In the case of a non-successful context activation the response may also indicate the cause. + +In case of a successful context activation, the TE will start its PPP protocol after the LLC link has been established. The LCP, Authentication and NCP negotiations are then carried out. During these negotiations the GGSN may acknowledge values, for any LCP options related to 'L2' framing (e.g. 'ACCM', 'ACFC' and 'FCS-Alternatives'), as proposed by the MT, which itself is forwarding these negotiations from the TE. + +NOTE: With the "PPP" the MT may provide a PPP relay (or proxy) function between the TE and GGSN. This gives the opportunity for the MT to intercept the 'L2' framing end to end negotiations. + +EXAMPLE: In the following example the successful PDP context activation is shown. + +![Sequence diagram of PDP context activation showing interactions between TE, MT, SGSN, GGSN, and Intranet/ISP.](458fdbcb4015a4ee90bd84809afc4aac_img.jpg) + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN + participant Intranet/ISP + + Note left of TE: AT-Commands + TE->>MT: AT-Commands + MT->>SGSN: Activate PDP Context Req. + SGSN->>GGSN: Create PDP Context req. + GGSN->>SGSN: Create PDP Context Resp. + SGSN->>MT: Activate PDP Context Acc. + MT->>TE: AT-Response + Note left of TE: LCP, Authentication and IPCP negotiation + TE->>GGSN: LCP, Authentication and IPCP negotiation + GGSN->>Intranet/ISP: RADIUS/DHCP or L2TP negotiation + Intranet/ISP->>GGSN: RADIUS/DHCP or L2TP negotiation + +``` + +The diagram illustrates the sequence of messages for a successful PDP context activation. It starts with the TE sending 'AT-Commands' to the MT. The MT then sends an 'Activate PDP Context Req.' to the SGSN. The SGSN forwards this as a 'Create PDP Context req.' to the GGSN. The GGSN responds with a 'Create PDP Context Resp.' to the SGSN, which in turn sends an 'Activate PDP Context Acc.' back to the MT. The MT then sends an 'AT-Response' back to the TE. Following this, the TE initiates 'LCP, Authentication and IPCP negotiation' directly with the GGSN. The GGSN then performs 'RADIUS/DHCP or L2TP negotiation' with the Intranet/ISP. + +Sequence diagram of PDP context activation showing interactions between TE, MT, SGSN, GGSN, and Intranet/ISP. + +Figure 16a + +## 13 Interworking with PDN (DHCP) + +### 13.1 General + +In current LAN environments the most commonly used configuration protocol is DHCP (Dynamic Host Configuration Protocol, RFC 2131 [26]) and DHCPv6 (Dynamic Host Configuration Protocol for IPv6, IETF RFC 3315 [46]). It provides a mechanism for passing a large set of configuration parameters to hosts connected to a TCP/IP network (IP address, sub-net mask, domain name, MTU, etc.) in an automatic manner. Moreover DHCP may assign IP addresses to clients for a finite lease time, allowing for sequential reassignment of addresses to different users. + +The lease time is chosen by the administrator of the DHCP server (in the external network), and is therefore out of the scope of the present document. + +The Packet Domain may obtain IP address via external DHCP server during the packet bearer establishment procedures (e.g. PDP Context activation, default bearer establishment). The GGSN/P-GW acts as a DHCP client towards the external DHCP server. + +The Packet Domain offers the end user the possibility to run DHCP end-to-end the same way as he does when connected directly to a LAN (e.g. an enterprise Intranet). No modifications should be required in common implementations of DHCP clients and servers. However in non-EPC based Packet Domain, a DHCP relay agent function is needed in the GGSN so as to allow correct routing of DHCP requests and replies between the TE and the DHCP servers. In EPC based Packet Domain for 3GPP access networks, the P-GW acts a DHCP server towards the UE and it acts as a DHCP client towards the external DHCP server. For trusted non-3GPP access networks, the non-3GPP access network may act as a DHCP relay or DHCP server. In the trusted WLAN access network, the TWAN acts a DHCP server towards the UE and PGW acts as a DHCP client towards the external DHCP server for the GTP/PMIP-based S2a. + +In non-EPC based Packet Domain, at PDP context activation no IP address is allocated, this is done afterwards through DHCP. After the TE's configuration has been completed by DHCP, the PDP context is updated by means of the GGSN-initiated PDP Context Modification Procedure in order to reflect the newly assigned IP address. + +In the following cases the bearer associated with the allocated IP address (i.e. IPv4 address or IPv6 prefix) shall be released: + +- if the DHCP lease expires; +- if the DHCP renewal is rejected by the DHCP server; +- if the IP address is changed during the renewal process. Usually when the lease is renewed, the IP address remains unchanged. However, if for any reason (e.g. poor configuration of the DHCP server), a different IP address is allocated during the lease renewal process the associated bearer shall be released. + +## 13.2 PDN Interworking Model of GGSN for DHCP + +A DHCP relay agent shall be located in the GGSN used for interworking with the IP network as illustrated in the following figure 16b. + +![Diagram of the protocol stack for the Gi IP reference point for DHCP. The diagram shows a GGSN box containing a DHCP Relay Agent, UDP, IP, L2, and L1 layers. To the left is the Packet Domain Bearer, and to the right is the Gi interface.](9e4f582a5d5f6742d1372956db0f8f0b_img.jpg) + +The diagram illustrates the protocol stack for the Gi IP reference point for DHCP. A dashed box labeled "GGSN" contains the following components from top to bottom: + + +- A **DHCP Relay Agent** (represented by a box with a downward-pointing triangle at the top). +- Two **UDP** protocol blocks. +- Two **IP** protocol blocks. +- An **L2** (Link Layer) block. +- An **L1** (Physical Layer) block. + + To the left of the GGSN box is a large box labeled **Packet Domain Bearer**. To the right of the GGSN box is a vertical dashed line labeled **Gi**, representing the interface to the external IP network. The L1 block in the GGSN stack is connected to the Gi interface. + +Diagram of the protocol stack for the Gi IP reference point for DHCP. The diagram shows a GGSN box containing a DHCP Relay Agent, UDP, IP, L2, and L1 layers. To the left is the Packet Domain Bearer, and to the right is the Gi interface. + +**Figure 16b: The protocol stacks for the Gi IP reference point for DHCP** + +The DHCP relay agent relays the requests received from the DHCP client to the DHCP server(s), and the replies received from the server(s) to the corresponding client. The DHCP relay agent allows for the replies from DHCP servers to be delivered to the correct terminal, as the logical connection from the MT terminates in the GGSN, and consequently only the GGSN holds enough information to locate the DHCP client. How the DHCP relay agent identifies the MT based on the DHCP messages is out of the scope of 3GPP standardisation. + +DHCP provides mechanisms for user authentication and integrity protection, but does not offer any message confidentiality, therefore additional mechanisms (e.g. Ipsec tunnel) may be provided if the link towards the external network is not secure. However this is out of the scope of the present document. + +Apart from the particulars mentioned above, this model is basically the same as the one for interworking with IP networks described elsewhere in the present document. Using DHCP corresponds to the transparent access case as the GGSN does not take part in the functions of authentication, authorisation, address allocation, etc. + +### 13.2.1 Address allocation by the Intranet or ISP + +The MS is given an address belonging to the Intranet/ISP addressing space. The address is given dynamically immediately after the PDP context activation. This address is used for packet forwarding between the Intranet/ISP and the GGSN and within the GGSN. + +The MS may authenticate itself to the Intranet/ISP by means of the relevant DHCP procedures (see RFC 3118 [45]). + +The protocol configuration options are retrieved from the DHCP server belonging to the Intranet/ISP. + +![Figure 16c: Protocol stack for access with DHCP end-to-end. The diagram shows the protocol stacks for TE, MT, SGSN, GGSN, and Intranet/ISP. The TE and MT stacks are identical, consisting of DHCP Client, UDP, IP, and Phy. layers. The GGSN stack consists of a DHCP Relay Agent, UDP, IP, and Lower layers. The Intranet/ISP stack consists of a DHCP Server, UDP, IP, and Lower layers. The MT, SGSN, and GGSN are connected via a Packet Domain bearer, which is supported by Lower layers in the GGSN.](71b0a68b4dd64961465d2b0e790538de_img.jpg) + +| TE | MT | SGSN | GGSN | Intranet/ISP | +|-------------|----------------------|------|------------------|--------------| +| DHCP Client | | | DHCP Relay Agent | DHCP Server | +| UDP | | | UDP | UDP | +| IP | | | IP | IP | +| Phy. layers | Packet Domain bearer | | Lower layers | Lower layers | + +Figure 16c: Protocol stack for access with DHCP end-to-end. The diagram shows the protocol stacks for TE, MT, SGSN, GGSN, and Intranet/ISP. The TE and MT stacks are identical, consisting of DHCP Client, UDP, IP, and Phy. layers. The GGSN stack consists of a DHCP Relay Agent, UDP, IP, and Lower layers. The Intranet/ISP stack consists of a DHCP Server, UDP, IP, and Lower layers. The MT, SGSN, and GGSN are connected via a Packet Domain bearer, which is supported by Lower layers in the GGSN. + +**Figure 16c: Protocol stack for access with DHCP end-to-end** + +#### 13.2.1.1 Address allocation using DHCPv4 + +The following description bullet items describe the DHCPv4 signal flow. For a detailed description of the DHCP messages refer to RFC 2131 [26] and RFC 1542 [27]. The end-to-end protocol configuration is depicted in figure 16c. + +- 1) The TE and MT exchange several AT commands carrying the QoS and other parameters requested by the TE, and requesting the activation of a PDP context of PDP type IP. The TE selects the APN of the configured Intranet/ISP offering a DHCP service, or the APN consisting of the Reserved Service Label for DHCP that the user has subscribed to. In the latter case the TE will be connected to a PLMN operator-configured service provider offering a DHCP service (according to the APN selection rules). +- 2) The MT sends the Activate PDP Context Request message to the SGSN with an empty PDP address field. +- 3) The SGSN selects a GGSN based on the APN requested by the MS and sends a Create PDP Context Request message to that GGSN. The GGSN replies with a Create PDP Context Response message. If the GGSN has not been configured by the operator to use external PDN address allocation with DHCP for the requested APN, the cause shall be set to 'Service not supported'. No IP address is assigned at this point; the PDP address returned by the GGSN is set to 0.0.0.0, indicating that the IP address is not yet assigned and shall be negotiated by the TE with the Intranet/ISP after the PDP context activation procedure. +- 4) Depending on the cause value received in the Create PDP Context Response the SGSN sends either an Activate PDP Context Accept or an Activate PDP Context Reject back to the MT. In case of a successful activation the PDP context is established with the PDP address set to 0.0.0.0. +- 5) Upon reception of the Activate PDP Context Accept, the MT sends an AT response to the TE that acknowledges the completion of the PDP context activation procedure. +- 6) The TE sends a DHCPDISCOVER message with the IP destination address set to the limited broadcast address (all 1s). The GGSN will pass the DHCPDISCOVER to the DHCP relay agent which will relay the request to the DHCP server configured for the APN of the PDP context. If more than one DHCP server is configured for a given APN, the request will be sent to all of them. The DHCP relay agent will add enough information to the DHCPDISCOVER message to be able to relay the replies back to the MS. How this is done is out of the scope of 3GPP standardisation. + +- 7) DHCP servers receiving the DHCPDISCOVER request reply by sending a DHCPOFFER message including an offered IP address. The DHCP relay agent forwards the replies to the proper MS. +- 8) The TE chooses one of the possibly several DHCPOFFERs and sends a DHCPREQUEST confirming its choice and requesting additional configuration information. The relay agent relays the DHCPREQUEST as explained in step 6. +- 9) The selected DHCP server receives the DHCPREQUEST and replies with a DHCPACK containing the configuration information requested by the TE. The DHCP relay agent relays the DHCPACK to the TE. +- 10) The DHCP relay agent passes the allocated IP address to the GGSN which stores it in the corresponding PDP context. The GGSN then initiates a PDP context modification procedure by sending an Update PDP Context Request to the appropriate SGSN with the End User Address information element set to the allocated IP address. +- 11) The SGSN sends a Modify PDP Context Request to the MT with the allocated IP address in the PDP Address information element. The MT acknowledges by sending a Modify PDP Context Accept to the SGSN. +- 12) The SGSN sends an Update PDP Context Response to the GGSN. The PDP context has been successfully updated with the allocated IP address. + +EXAMPLE: In the following example a successful PDP context activation with use of DHCP from end to end is shown. + +![Sequence diagram showing DHCPv4 signal flow between TE, MT, SGSN, GGSN (DHCP Relay Agent), and Intranet or ISP.](cc6f9dbfc36aa5821d9749ca84861f93_img.jpg) + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN as GGSN +DHCP Relay Agent + participant Intranet or ISP + + Note left of TE: 1. AT commands + MT->>SGSN: 2. Activate PDP Context req. + SGSN->>GGSN: 3. Create PDP Context req. + GGSN->>SGSN: 3. Create PDP Context resp. + SGSN->>MT: 4. Activate PDP Context acc. + Note left of TE: 5. AT command + Note left of TE: 6. DHCPDISCOVER + TE->>Intranet or ISP: 6. DHCPDISCOVER + Intranet or ISP-->>GGSN: 7. DHCPOFFER (maybe several) + GGSN-->>TE: 7. DHCPOFFER (maybe several) + Note left of TE: 8. DHCPREQUEST + TE->>Intranet or ISP: 8. DHCPREQUEST + Intranet or ISP-->>GGSN: 9. DHCPACK + GGSN-->>TE: 9. DHCPACK + Note left of GGSN: 10. Update PDP Context req. + GGSN->>SGSN: 10. Update PDP Context req. + SGSN->>MT: 11. Modify PDP Context req. + MT-->>SGSN: 11. Modify PDP Context acc. + SGSN->>GGSN: 12. Update PDP Context resp. + +``` + +Sequence diagram showing DHCPv4 signal flow between TE, MT, SGSN, GGSN (DHCP Relay Agent), and Intranet or ISP. + +Figure 16d: DHCPv4 signal flow + +13.2.1.2 Void. + +## 13.2.2 Other configuration by the Intranet or ISP (IPv6 only) + +When using IPv6, in some situations the MS may need additional configuration information from the Intranet or ISP besides the IP address. It may for example be IMS related configuration options (see 3GPP TS 24.229 [47]). If the MS is DHCP capable and the IPv6 address has been allocated using Stateless Address Autoconfiguration, the MS may use a procedure as in the example below to configure additional external network protocol parameters, or other parameters + +that apply to the Intranet or ISP. The GGSN shall in this case indicate to the MS that there is additional configuration information to retrieve by setting the O-flag in the Router Advertisements. This shall be configured per APN in the GGSN. + +The following description bullet items describe an example of a signal flow, where the MS directs an Information-Request to the All\_DHCP\_Relay\_Agents\_and\_Servers multicast address. The MS may also direct the message to a specific server instead of all servers. For a detailed description of the DHCPv6 messages refer to the DHCPv6 IETF RFC 3315 [46]. The sequence is depicted in figure 16f. + +- 1) A Router Advertisement with the O-flag set, is sent from GGSN to TE to indicate to it to retrieve other configuration information. +- 2) The TE sends an INFORMATION-REQUEST message with the IP destination address set to the All\_DHCP\_Relay\_Agents\_and\_Servers multicast address defined in the DHCPv6 IETF RFC 3315 [46]. The source address shall be the link-local address of the MS. The DHCP relay agent in the GGSN shall forward the message. +- 3) DHCP servers receiving the forwarded INFORMATION-REQUEST message, reply by sending a RELAY-REPLY message, with the "Relay Message" option including a REPLY message with the requested configuration parameters. + +The TE chooses one of the possibly several REPLY messages and extracts the configuration information. + +EXAMPLE: In the following example a request for information with use of DHCPv6 from end to end is shown. + +![Sequence diagram illustrating DHCPv6 Other configuration signal flow between TE, MT, SGSN, GGSN (DHCP Relay Agent), and Intranet or ISP DHCP Server(s).](367378559e35017a5e1a6f5c30798c5a_img.jpg) + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN as GGSN +DHCP Relay Agent + participant ISP as Intranet or ISP +DHCP Server(s) + + Note left of TE: 1. Router Advertisement ( O-flag=1 ) + GGSN->>TE: 1. Router Advertisement ( O-flag=1 ) + Note left of TE: 2. INFORMATION-REQUEST + TE->>GGSN: 2. INFORMATION-REQUEST + GGSN->>ISP: RELAY-FORWARD( INFORMATION-REQUEST ) + Note left of TE: 3. REPLY (maybe several) + ISP->>GGSN: RELAY-REPLY( REPLY ) + GGSN->>TE: 3. REPLY (maybe several) + +``` + +Sequence diagram illustrating DHCPv6 Other configuration signal flow between TE, MT, SGSN, GGSN (DHCP Relay Agent), and Intranet or ISP DHCP Server(s). + +Figure 16f: DHCPv6 Other configuration signal flow + +### 13.3 PDN Interworking Model of P-GW for DHCP + +A DHCP Client shall be located in the P-GW used for interworking with the IP network as illustrated in Figure 16g. + +![Diagram of the protocol stack for the Sgi IP reference point for DHCP. The stack is shown within a P-GW box, with layers from top to bottom: DHCP Client, UDP, IP, L2, and L1. The L1 layer connects to the SGi interface.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +The diagram illustrates the protocol stack for the Sgi IP reference point for DHCP. It shows a vertical stack of five protocol layers inside a box labeled 'P-GW'. From top to bottom, the layers are: 'DHCP Client', 'UDP', 'IP', 'L2', and 'L1'. A horizontal line extends from the 'L1' layer to the right, representing the 'SGi' interface. + +Diagram of the protocol stack for the Sgi IP reference point for DHCP. The stack is shown within a P-GW box, with layers from top to bottom: DHCP Client, UDP, IP, L2, and L1. The L1 layer connects to the SGi interface. + +**Figure 16g: The protocol stacks for the Sgi IP reference point for DHCP** + +The DHCP client function in P-GW shall be used to allocate IP address(es) to the UE and/or to configure associated parameters via external DHCP servers in PDN(s). As both IPv4 and IPv6 address allocation are supported in EPS, the P-GW shall have both DHCPv4 and DHCPv6 client functions. + +The procedures where the DHCP client function in the P-GW is used are further described in TS 23.060 [3], TS 23.401 [77] and TS 23.402 [78]. The procedures are IPv4 address allocation and IPv4 parameter configuration via an external DHCPv4 server in a PDN; IPv6 Prefix allocation via stateless address autoconfiguration; and IPv6 parameter configuration via stateless DHCPv6. These procedures are detailed in the subclauses below. + +### 13.3.1 Address allocation by the Intranet or ISP + +The subclauses below provide the signalling flows when the IP address allocation and/or the IP parameter configuration to a UE is performed via an external DHCP server in the PDN. + +#### 13.3.1.1 IPv4 Address allocation and IPv4 parameter configuration via DHCPv4 + +The UE may obtain the IPv4 address and/or its configuration parameters at or after the initial access signalling (e.g. default bearer establishment) to the packet domain. The request for IPv4 address and/or configuration parameters from the UE may trigger the P-GW acting as DHCPv4 client to request the IPv4 address and/or configuration parameters from an external DHCPv4 server and deliver them to the UE. See subclause 11.2.1.2.2 for details. The DHCPv4 functions in the P-GW, the UE and the external DHCPv4 server shall be compliant to RFC 2131 [26], RFC 1542 [27] and RFC 4039 [79]. + +The following bullet items describe the successful IPv4 address allocation and parameter configuration signalling flow between the P-GW and the external DHCPv4 server as depicted Figure 16h. For a detailed description of the DHCPv4 messages, refer to RFC 2131 [26], RFC 1542 [27] and RFC 4039 [79]. + +Figure 16h is an example signalling flow for IPv4 address allocation and parameter configuration at the default bearer setup using DHCPv4 as specified in RFC 2131 [26]. If the optimized signalling (Rapid Commit Option) is used as per RFC 4039 [79], the messages 2-3 can be eliminated. + +- 1) The DHCPv4 client function in the P-GW sends a DHCPDISCOVER as an IP limited broadcast message, i.e. the destination address 255.255.255.255, towards the external PDN. If the P-GW has the DHCPv4 server IP addresses configured for the APN, the DHCPDISCOVER shall be send as unicast (or even multicast) to the external DHCPv4 servers. +- 2) Upon receiving the DHCPDISCOVER request message, the external DHCPv4 servers reply by sending a DHCPOFFER message including an offered IP address. Several DHCPOFFER messages may be received by the P-GW if multiple DHCPv4 servers respond to the DHCPDISCOVER. + +- 3) The DHCPv4 client function in the P-GW processes the messages and sends a DHCPREQUEST towards the selected external DHCPv4 server. +- 4) Upon receiving the DHCPREQUEST message, the selected external DHCPv4 server acknowledges the address allocation by sending a DHCPACK containing the lease period (T1), the time-out time (T2) and the configuration information requested in DHCPREQUEST. The P-GW stores the allocated IPv4 address, the lease timers and the configuration parameters. The IPv4 address and the configuration parameters shall be delivered to the UE through P-GW to UE messages. + +![Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4. The diagram shows four messages between the P-GW (DHCPv4 Client) and the DHCPv4 Server: 1. DHCPDISCOVER (Client to Server), 2. DHCP OFFER (Server to Client), 3. DHCPREQUEST (Client to Server), and 4. DHCP ACK (Server to Client).](03d9aaba6c1af8bfd8e42c1d2422ae5c_img.jpg) + +``` + +sequenceDiagram + participant P-GW as P-GW (DHCPv4 Client) + participant DHCPv4 Server as DHCPv4 Server + Note right of P-GW: 1. DHCPDISCOVER + P-GW->>DHCPv4 Server: 1. DHCPDISCOVER + Note left of DHCPv4 Server: 2. DHCP OFFER + DHCPv4 Server-->>P-GW: 2. DHCP OFFER + Note right of P-GW: 3. DHCPREQUEST + P-GW->>DHCPv4 Server: 3. DHCPREQUEST + Note left of DHCPv4 Server: 4. DHCP ACK + DHCPv4 Server-->>P-GW: 4. DHCP ACK + +``` + +Sequence diagram showing the signalling flow for IPv4 address allocation and parameter configuration using DHCPv4. The diagram shows four messages between the P-GW (DHCPv4 Client) and the DHCPv4 Server: 1. DHCPDISCOVER (Client to Server), 2. DHCP OFFER (Server to Client), 3. DHCPREQUEST (Client to Server), and 4. DHCP ACK (Server to Client). + +**Figure 16h: The signalling flow for IPv4 address allocation and parameter configuration using DHCPv4** + +Figure 16i is an example signalling flow for IPv4 address lease renew by using DHCPv4 protocol as specified in RFC 2131 [26]. + +- 1) The DHCPv4 client function in the P-GW sends a unicast DHCPREQUEST towards the external DHCPv4 server to extend the lease period of the allocated IPv4 address. +- 2) The external DHCPv4 server replies with a DHCPACK message confirming the renewed lease and the T1 and T2 timers are restarted. + +![Sequence diagram showing the signalling flow for IPv4 address lease renew using DHCPv4. The diagram shows two messages between the P-GW (DHCPv4 Client) and the DHCPv4 Server: 1. DHCPREQUEST (Client to Server) and 2. DHCPACK (Server to Client).](91b12db3c85bbf466ad27eb3665a1b06_img.jpg) + +``` + +sequenceDiagram + participant P-GW as P-GW (DHCPv4 Client) + participant DHCPv4 Server as DHCPv4 Server + Note right of P-GW: 1. DHCPREQUEST + P-GW->>DHCPv4 Server: 1. DHCPREQUEST + Note left of DHCPv4 Server: 2. DHCPACK + DHCPv4 Server-->>P-GW: 2. DHCPACK + +``` + +Sequence diagram showing the signalling flow for IPv4 address lease renew using DHCPv4. The diagram shows two messages between the P-GW (DHCPv4 Client) and the DHCPv4 Server: 1. DHCPREQUEST (Client to Server) and 2. DHCPACK (Server to Client). + +**Figure 16i: The signalling flow for IPv4 address lease renew using DHCPv4** + +### 13.3.1.2 IPv6 Prefix allocation via IPv6 stateless address autoconfiguration via DHCPv6 + +When the IPv6 prefix is allocated from the external PDN, it is the P-GW's responsibility to obtain the IPv6 prefix for external PDN, allocate and release the IPv6 prefix. The P-GW may use DHCPv6 to obtain the IPv6 prefix from the external PDN. In this context, the P-GW shall act as a DHCP client as per IETF RFC 3315 [46] towards the external DHCPv6 server. The use cases between the UE and the P-GW that may lead the P-GW to interwork with the external DHCPv6 servers are described in subclause 11.2.1.3.1a. + +### 13.3.1.3 IPv6 parameter configuration via stateless DHCPv6 + +A UE that has obtained an IPv6 address can use stateless DHCP to request other configuration information such as a list of DNS recursive name servers or SIP servers. + +For 3GPP networks if such IPv6 configuration parameters are locally provisioned in the P-GW, the P-GW returns the requested parameters to the UE via its DHCPv6 server function. For trusted non-3gpp access networks, if such IPv6 + +configuration parameters are locally provisioned in the P-GW, the P-GW may return the requested parameters to the UE via its DHCPv6 server function or the P-GW may return the IPv6 configuration parameters to the non-3gpp access network and then the non-3GPP access network may send the parameters to the UE via its DHCPv6 server function. When the non-3GPP access network is a trusted WLAN network, the PGW always returns the IPv6 configuration parameters to the TWAN via GTP/PMIP message, and then the TWAN sends the parameters to the UE via its DHCPv6 server function. When an external DHCPv6 server in a PDN is used to obtain the requested parameters, which is the use case covered in this subclause, the P-GW acts as a DHCPv6 client towards the external DHCPv6 server while acting a DHCPv6 server towards the UE. + +The IPv6 parameter configuration via stateless DHCPv6 function in the UE, the P-GW and the external DHCPv6 Server shall be compliant to RFC 3736 [80]. An example signalling flow for the GGSN is described in Subclause 13.2.2. For the P-GW, the signalling flow is same with the following modifications: + +- For 3GPP access networks, the P-GW sends Router Advertisement for GTP-based S5/S8. In the case of PMIP-based S5/S8, the S-GW sends the Router Advertisement. For trusted non-3GPP access networks, the trusted non-3GPP access network sends the Router Advertisement for PMIP S2a. When the non-3GPP access network is a trusted WLAN network, the TWAN sends the Router Advertisement + +As stated above, the P-GW acts as a DHCPv6 server towards the UE, while acting as a DHCPv6 client towards the external DHCPv6 server. + +--- + +## 13a Interworking with IMS + +### 13a.1 General + +Interworking with the IP Multimedia Core Network Subsystem (IMS) puts additional requirements on the GGSN/P-GW. When the MS/UE connects to the IP Multimedia Core Network Subsystem (IMS), specific parameters in Session Management messages may be handled. The IMS specific parameters are: IMS signalling flag, P-CSCF address request, P-CSCF restoration support, returned P-CSCF address(es) and flow identifier(s). + +For interworking with the IMS, the Gx interface (see 3GPP TS 29.212 [75]) is used to correlate the session (SIP/SDP) and the bearer (PDP Contexts). + +The mechanisms in GGSN/P-GW to support IMS shall be: + +- P-CSCF discovery. +- Dedicated signalling bearer (e.g. PDP contexts) (with or without enhanced QoS) for IMS signalling; with associated packet filters to permit signalling to/from designated servers. +- Gx interface for policy and charging control of bearer (e.g. PDP contexts) for IMS media flows. +- P-CSCF restoration. + +These mechanisms are however not restricted to the IMS and could be used for other services that could benefit from these mechanisms. + +The P-GW shall not modify the fields Type of Service (IPv4) and Traffic Class (IPv6) of the received downlink packets. + +NOTE: The P-CSCF can support paging policy differentiation for different traffic or service types over LTE by marking the fields Type of Service (IPv4) and Traffic Class (IPv6) (see clause L.3.2.4 of 3GPP TS 24.229 [47]). + +### 13a.2 IMS Interworking Model + +The signalling interface between MS/UE and P-CSCF is a logical interface, i.e. it is using GPRS or EPC as a bearer. The Gx interface is used for network communication between the GGSN/P-GW and the PCRF. For a description of the IMS architecture, refer to 3GPP TS 23.228 [52]. For a more detailed view of GGSN/P-GW IMS interworking, see 3GPP TS 29.213 [76]. + +### 13a.2.1 IMS Specific Configuration in the GGSN/P-GW + +The GGSN/P-GW shall have a list of preconfigured addresses of signalling servers (P-CSCF servers). This list shall be provided to MSs/UEs on request. The list shall be possible to preconfigure per APN. + +The GGSN/P-GW shall have locally preconfigured packet filters, and/or applicable PCC rules, as specified in 3GPP TS 29.212 [75] to be applied on the dedicated signalling bearer (e.g. PDP context). The packet filters shall filter up-link and down-link packets and only allow traffic to/from the signalling servers and to DNS and DHCP servers. The locally preconfigured packet filters shall be possible to pre-configure per APN. + +It shall be possible to enable/disable the use of the Gx interface per APN. When Gx is enabled the GGSN/P-GW shall handle IP-CAN Bearer Establishment (e.g. Create PDP Context Requests) as specified in 3GPP TS 29.212 [75]. + +The GGSN/P-GW shall support IPv4 and/or IPv6 addresses and protocol for IMS signalling and IMS bearers. + +The methods for an MS/UE to discover P-CSCF address(es) may vary depending on the access technology that the MS/UE is on. The details of the P-CSCF discovery mechanisms for various accesses are specified in 3GPP TS 23.228 [52] and 3GPP TS 24.229 [47]. For example, for an MS/UE accessing to IMS via GPRS in GERAN and UTRAN, the GGSN shall provide support for P-CSCF discovery in three different ways (see 3GPP TS 23.228 [52] and 3GPP TS 24.229 [47]): + +- GPRS procedure for P-CSCF discovery, i.e. request and provision of P-CSCF address(es) within the PCO IE in GPRS Session Management procedures (see 3GPP TS 24.008 [54]). +- Via DHCP servers i.e. the GGSN shall provide the functionality of a DHCP relay agent +- If the MS/UE has a P-CSCF FQDN locally configured and request the DNS IP address(es) from the GGSN (via PCO or DHCP procedures), the GGSN shall be able to provide DNS IP address(es) to the MS/UE. + +Similarly, the PGW shall have similar functional support depending on the P-CSCF discovery methods supported by the UE on the access technology. For example, for a UE in 3GPP access network (i.e. GERAN, UTRAN, EUTRAN), the P-GW shall support same functions as the GGSN that are specified above except that the P-GW does not act as a DHCP relay agent between the MS/UE and the external DHCP server. In other words, as specified in clause 13 of this document, the P-GW shall have DHCP server function towards the MS/UE while acting as a DHCP client towards external DHCP server, if the P-GW is configured to request DNS and/or P-CSCF IP addresses from external DHCP servers. + +The GGSN/P-GW shall be able to deliver DNS and/or P-CSCF addresses to the MS/UE if requested by the MS/UE via PCO (see 3GPP TS 24.008 [54] and 3GPP TS 24.301 [84]) or via DHCP procedures using the relevant DHCP options for IPv4/IPv6 DNS and SIP servers (see RFC 2132 [85], RFC 3361 [86], RFC 3646 [87] and RFC 3319 [88]). + +On APNs providing IMS services, the information advertised in Router Advertisements from GGSN/P-GW to MSs/UEs shall be configured in the same manner as for other APNs providing IPv6 services (see subclause 11.2.1.3.4), except that the "O-flag" shall be set. + +NOTE: The "O- flag" shall be set in IPv6 Router Advertisement messages sent by the GGSN/P-GW for APNs used for IMS services. This will trigger a DHCP capable MS/UE to start a DHCPv6 session to retrieve server addresses and other configuration parameters. An MS/UE which doesn't support DHCP will simply ignore the "O-flag". An MS/UE, which doesn't support DHCP, shall request IMS specific configuration (e.g. P-CSCF address) via the other discovery methods supported in the MS/UE (i.e. via locally configured P-CSCF address/FQDN in the MS/UE or via PCO procedure, if applicable). + +The GGSN/P-GW shall have configurable policy rules for controlling bearers (e.g. PDP contexts) used for signalling as specified in section 13a.2.2.2. + +### 13a.2.2 IMS Specific Procedures in the GGSN/P-GW + +#### 13a.2.2.1 Request for Signalling Server Address + +When an MS/UE indicates a request for a P-CSCF address in the PCO IE in a Create PDP Context Request message on GERAN/UTRAN or for E-UTRAN in initial access request (e.g. Attach Request, PDN Connectivity Request), the GGSN/P-GW shall respond with one or more P-CSCF server addresses if preconfigured for this APN. If the GGSN/P-GW has no P-CSCF address available, the GGSN/P-GW shall ignore the request. If the GGSN/P-GW provides more + +than one P-CSCF IPv4/IPv6 address in the response, the GGSN/P-GW shall sort the addresses with the highest priority P-CSCF server first in the PCO IE. The GGSN/P-GW may use different prioritisations for different Mses/UEs, e.g. for load sharing between the P-CSCF servers. + +The GGSN/P-GW may use a keep alive mechanism and/or other type based on local policy (e.g. statistical monitoring) to be able to detect a failure of P-CSCF address(es) preconfigured in the APN. The keep alive mechanism should make use of STUN or CRLF as specified for the UE in 3GPP TS 24.229 [47], clause K.2.1.5. As an alternative, ICMP echo request/response may be used. The GGSN/P-GW shall then provide only those P-CSCF address(es) that are available in a Create PDP Context Response/Create Session Response. + +The coding of the PCO IE is described in the 3GPP TS 24.008 [54]. This procedure shall be followed regardless of whether or not the MS/UE uses a dedicated PDP context/EPS bearer for IMS signalling, and irrespective of the Gx status for the APN. + +### 13a.2.2.1a Failure of Signalling Server Address + +If the GGSN/P-GW detects a failure: + +- in P-CSCF address(es) being used by the MS/UEs, if received via Gx (as specified in 3GPP TS 23.380 [95], clause 5); or +- upon receiving a P-CSCF restoration indication from the MME/SGSN or the PCRF, + +then the GGSN/P-GW shall act as specified in 3GPP TS 23.380 [95], clause 5. + +### 13a.2.2.2 Establishment of a PDP Context/EPS Bearer for Signalling + +The following applies for establishing a PDP context/EPS bearer for IMS signalling in the GGSN/P-GW as per 3GPP TS 23.228 [52]: + +- I. The GGSN/P-GW shall allow IMS signalling on a "general-purpose PDP context"/default EPS bearer, in which case the IMS signalling shall be provided like any other transparent services provided by the packet domain. +- II. The GGSN/P-GW may (dependent on operator policy) also support PDP Contexts/EPS Bearers dedicated for IMS services. If the the bearer establishment selected for the APN is controlled by the MS/UE, the MS/UE may request a dedicated PDP context/EPS Bearer for IMS signalling (see 3GPP TS 24.229 [47]) by setting the IM CN Subsystem signalling flag in the PCO IE. Specifically, the GGSN/P-GW may receive the IM CN Subsystem signalling flag in the PCO IE in the PDP context activation or Secondary PDP context activation for GERAN and UTRAN accesses; in the Attach, UE-requested PDN connectivity request or UE-requested bearer resource modification procedures for E-UTRAN access. If the bearer establishment selected for the APN is controlled by the network, depending on the operator policy, the GGSN or P-GW may also activate a PDP context or dedicated EPS bearer for IMS signalling via network-initiated Secondary PDP context activation or network-initiated Dedicated Bearer activation procedures, respectively. If dedicated PDP contexts/EPS Bearers for IMS signalling are not supported, the GGSN/P-GW will reset the signalling flag in the response to the MS/UE. For P-GW, if the APN offers non-IMS services, the default bearer shall not be allowed to be set up as a dedicated IM CN signalling bearer. If the PDP context/EPS bearer can be established as a dedicated bearer for IMS signalling, the GGSN/P-GW can provide a set of UL filters for the PDP context/EPS bearer used for IMS. The UL filters provide the MS/UE with the rules and restrictions applied by the GGSN/P-GW for the dedicated PDP context/EPS bearer for IMS signalling. The GGSN/P-GW can in addition provide the IMS signalling flag to explicitly indicate to the MS/UE the intention of using the PDP context/EPS bearer for IMS related signalling. + +In both cases, I and II, + +- The GGSN may receive the Signalling Indication parameter in the QoS IE. This indicates a request for prioritised handling over the radio interface. The GGSN shall be able to downgrade the QoS (dependent on operator policy) by resetting the Signalling Indication according to the normal procedures for QoS negotiation, see 3GPP TS 23.060 [3]. +- During the (default or dedicated) EPS bearer activation procedure, the P-GW may receive the request for appropriate QCI for IMS signalling traffic as specified in 3GPP TS 23.203 [90] in EPS bearer QoS IE that indicates the prioritised handling of the EPS bearer over the radio interface. The P-GW may either accept or reject the request based on the operator policy configured at the P-GW. + +IM CN subsystem signalling flag and Signalling Indication or appropriate QCI for IMS signalling in the QoS IE may be used independently of each other. However, based on the operator policy, the network may honor the Signalling Indication or appropriate QCI for IMS signalling if the IM CN Subsystem signalling flag is present in PCO IE. + +The operator may provide other properties to the PDP contexts/EPS bearers dedicated for IMS signalling, e.g. special charging. It is out of the current scope of this TS to further specify these properties. + +For a PDP Context/EPS bearer marked as a dedicated for IMS signalling, the GGSN/P-GW shall apply the applicable PCC rules, as specified in 3GPP TS 29.212 [75], and/or locally preconfigured packet filters, which shall only allow packets to be sent to and from a set of signalling servers, such as P-CSCF(s), DHCP server(s) and DNS server(s). The TFT filters on the dedicated signalling bearer shall have a precedence value so that they precede any other TFT filters. This will secure the use of the correct PDP context/EPS bearer for the signalling traffic, and that only authorized traffic uses the signalling PDP context. The locally preconfigured packet filters shall be defined in the GGSN/P-GW by the operator. + +### 13a.2.2.3 Creation of a PDP Context/EPS Bearer for IMS Media Flows + +For PDP Contexts/EPS bearers used to carry IMS media flows, specific policies may be applied. The policy includes packet filtering, which enables a specific charging for these PDP Contexts/EPS bearers, see 3GPP TS 29.212 [75]. + +The creation of a PDP Context/EPS bearer to be used to carry media flows involves interaction between the MS/UE and the GGSN/P-GW and between the GGSN/P-GW and the PCRF. The interaction between the GGSN/P-GW and the PCRF, i.e. the Gx interface, is described in detail in 3GPP TS 29.212 [75]. The interaction between the MS/UE and GGSN/P-GW is described in 3GPP TS 29.213 [76]. + +If Gx is enabled for the APN, the GGSN/P-GW contacts the PCRF selected during the establishment of the APN. + +--- + +## 13b Interworking with BM-SC in EPS + +### 13b.1 General + +MBMS GW is used for interworking with the BM-SC in EPS. One or more MBMS GWs may be used in a PLMN. The specific message, i.e. session start/session update/session stop, and specific parameters, e.g. TMGI, MBMS service area, list of MBMS control plane nodes, are handled. + +MBMS GW provides the Sgi-mb (user plane) reference point and the SGmb (control plane) reference point for interworking with the BM-SC. + +### 13b.2 BM-SC interworking model of MBMS GW + +The control plane and user plane protocol stacks of the MBMS GW for interworking with BM-SC are illustrated in Figure 16j, Figure 16k and Figure 16l. The figures include the following protocols: + +- The "Diameter" SGmb application, as specified in clause 20. +- The Control part of the Evolved GPRS Tunnelling Protocol for EPS, GTPv2-C, as specified in 3GPP TS 29.274 [81]. +- The User Datagram Protocol, UDP, as specified in IETF RFC 768 [15]. +- The Transmission Control Protocol, TCP, as specified in IETF RFC 793 [18] +- The Stream Control Transmission Protocol, SCTP, as specified in IETF RFC 4960 [109]. +- The Packet Data Convergence Protocol, PDCP, as specified in 3GPP TS 25.323 [107]. +- The MBMS synchronisation protocol, SYNC, as specified in 3GPP TS 25.446 [106]. +- The Internet Protocol, IP. + +- L1 and L2 transport protocols for IP (various options exist). + +![Figure 16j: Control plane protocol stacks of MBMS GW and BM-SC for interworking with SGmb.](1f1614411edea7edfc86c839a608e1fc_img.jpg) + +This diagram illustrates the control plane protocol stacks for the MBMS GW and the BM-SC, connected via the SGmb interface. Both entities share a common stack of protocols: Diameter, TCP/SCTP, IP, and L1/L2. The MBMS GW also includes GTPv2-C. + +| MBMS GW | | SGmb | BM-SC | | +|---------|----------|------|----------|--| +| GTPv2-C | Diameter | | Diameter | | +| UDP | TCP/SCTP | | TCP/SCTP | | +| IP | IP | | IP | | +| L1/L2 | L1/L2 | | L1/L2 | | + +Figure 16j: Control plane protocol stacks of MBMS GW and BM-SC for interworking with SGmb. + +Figure 16j: The control plane protocol stacks of MBMS GW for interworking with BM-SC + +![Figure 16k: User plane protocol stacks of MBMS GW and BM-SC for multicast over SGmb.](cc542843836eecb036b99cb270b54a1e_img.jpg) + +This diagram shows the user plane protocol stacks for the MBMS GW and the BM-SC for multicast traffic over the SGmb interface. The stacks are identical, starting with User plane data, followed by PDCP, SYNC, UDP, IP, and L1/L2. + +| MBMS GW | | SGmb | BM-SC | | +|-----------------|--|------|-----------------|--| +| User plane data | | | User plane data | | +| PDCP | | | PDCP | | +| SYNC | | | SYNC | | +| UDP | | | UDP | | +| IP | | | IP | | +| L1/L2 | | | L1/L2 | | + +Figure 16k: User plane protocol stacks of MBMS GW and BM-SC for multicast over SGmb. + +Figure 16k: The user plane protocol stacks of MBMS GW for interworking with BM-SC for multicast + +![Figure 16l: User plane protocol stacks of MBMS GW and BM-SC for broadcast over SGmb.](a057800564be3506d2d87b6a4daee25b_img.jpg) + +This diagram shows the user plane protocol stacks for the MBMS GW and the BM-SC for broadcast traffic over the SGmb interface. The stacks are identical, starting with User plane data, followed by SYNC, UDP, IP, and L1/L2. PDCP is not used in this mode. + +| MBMS GW | | SGmb | BM-SC | | +|-----------------|--|------|-----------------|--| +| User plane data | | | User plane data | | +| SYNC | | | SYNC | | +| UDP | | | UDP | | +| IP | | | IP | | +| L1/L2 | | | L1/L2 | | + +Figure 16l: User plane protocol stacks of MBMS GW and BM-SC for broadcast over SGmb. + +Figure 16l: The user plane protocol stacks of MBMS GW for interworking with BM-SC for broadcast + +A BM-SC sends user plane data to an MBMS GW either by IP unicast (default), or by IP multicasting. Through the control plane communication a BM-SC provides an MBMS GW with necessary data, so that MBMS GW could forward the user plane data downlink either by multicast (default) or by unicast. + +PDCP is not used when the MBMS service is broadcasted in the E-UTRAN, refer to 3GPP TS 36.331 [94]. + +### 13b.3 Forwarding of user plane packets at the MBMS GW + +If user plane data are to be sent to the MBMS Gateway using IP unicast, the MBMS Gateway allocates an IP transport address and a separate UDP port for each MBMS bearer ( i.e the service uniquely identified by its TMGI and Flow ID and provided by the EPS to deliver the same IP datagrams to multiple receivers in a designated location). The MBMS Gateway uses that destination unicast IP address and destination UDP port of user plane packets received over the SGi-mb interface to determine on which MBMS bearer to forward the received user plane packet. + +If user plane data are to be sent to the MBMS Gateway using IP multicast encapsulation, the MBMS Gateway uses, the SGi-mb (transport) plane destination multicast address used and the SGi-mb (transport) plane source UDP port number provided by the BM-SC of user plane packets received over the SGi-mb interface to determine on which MBMS bearer to forward the received user plane packet. + +## 14 Internet Hosted Octet Stream Service (IHOSS) + +Figure 17: Void + +Figure 18: Void + +Figure 19: Void + +Figure 20: Void + +## 15 Interworking between Packet Domains + +The primary reason for the interworking between Packet Domains is to support roaming subscribers as described in 3GPP TS 23.060 [3]. The general model for both GPRS and EPS Packet Domain interworking is shown in figure 21. + +![Figure 21: General interworking model for GPRS Packet Domains and EPS Packet Domains to support roaming subscribers. The diagram shows two packet domains, GPRS and EPS PLMN, connected via an Inter-PLMN Backbone. The GPRS domain includes GGS, BG, SGS, and SGSN. The EPS PLMN domain includes BG, PDN GW, SGS, and S-. Both domains are connected to a Packet Data Network via Gi and SGi interfaces respectively.](0db3cccd1279034258e5ad5b6fdcff01_img.jpg) + +The diagram illustrates the general interworking model for GPRS and EPS Packet Domains. At the top, a 'Packet Data Network' (represented by an oval) is connected to both domains. The GPRS domain (left) consists of a 'GGS' and 'BG' connected to an 'Intra-PLMN Backbone' (oval), which is further connected to 'SGS' and 'SGSN'. This domain connects to the 'Packet Data Network' via a 'Gi' interface and to the 'Inter-PLMN Backbone' (oval) via a 'Gp' interface. The EPS PLMN domain (right) consists of a 'BG' and 'PDN GW' connected to an 'Intra-PLMN Backbone' (oval), which is further connected to 'SGS' and 'S-'. This domain connects to the 'Packet Data Network' via an 'SGi' interface and to the 'Inter-PLMN Backbone' via an 'S8' interface. Both domains are shown as stacked green rectangles, indicating multiple instances. + +Figure 21: General interworking model for GPRS Packet Domains and EPS Packet Domains to support roaming subscribers. The diagram shows two packet domains, GPRS and EPS PLMN, connected via an Inter-PLMN Backbone. The GPRS domain includes GGS, BG, SGS, and SGSN. The EPS PLMN domain includes BG, PDN GW, SGS, and S-. Both domains are connected to a Packet Data Network via Gi and SGi interfaces respectively. + +Figure 21: General interworking model for GPRS Packet Domains and EPS Packet Domains to support roaming subscribers. + +NOTE: There may be multiple Packet Domains of the same type which interwork each other, such as the case of interwork between two GPRS Packet Domains. + +For roaming subscribers that have a PDP address allocated from the HPLMN a forwarding route between the HPLMN and the VPLMN is created. This route is used for both mobile terminated and mobile originated data traffic. The communication is done via the BGs (Border Gateways) as described in 3GPP TS 23.060 [3]. + +The procedures to set the link between the SGSN in the VPLMN and the GGSN in the HPLMN are described in 3GPP TS 23.060 [3]. + +The inter-PLMN link may be any packet data network or dedicated link as described in 3GPP TS 23.060 [3]. The PLMN operators may have a dedicated inter-PLMN link to fulfil the QoS requirements of a certain protocol. + +In the case of interworking between EPS Packet Domains, S8 reference point is the inter-PLMN interface, linking PDN GW of HPLMN and Serving GW of VPLMN. The procedure for setting the link is described in 3GPP TS 23.401 [77] and TS 23.402 [78]. + +## 15.1 Security Agreements + +Each PLMN operator may support Ipsec (RFC 1825 [61]) and accompanying specifications for authentication (RFC 1826 [62]) and encryption (RFC 1827 [63]) as a basic set of security functionality in its border gateways. The PLMN operators may decide to use other security protocols based on bilateral agreements. + +## 15.2 Routing protocol agreements + +Each PLMN operator may support BGP (RFC 1771 [60]) as a basic set of routing functionality in its border gateways. The PLMN operators may decide to use other routing protocols based on bilateral agreements. + +## 15.3 Charging agreements + +Sharing the cost of the inter-PLMN link is subject to the agreement between the PLMN operators. + +There may be a requirement to collect charging information in the Border Gateway (see figure 21) and this is down to the normal interconnect agreement between PLMN and PDN operators. + +--- + +## 16 Usage of RADIUS on Gi/Sgi interface + +A GGSN may, on a per APN basis, use RADIUS authentication to authenticate a user and RADIUS accounting to provide information to an AAA (Authentication, Authorization and Accounting) server. + +### 16.1 RADIUS Authentication and Authorization + +RADIUS Authentication and Authorization shall be used according to RFC 2865 [38], RFC 3162 [50] and RFC 4818 [97]. + +The RADIUS client function may reside in a GGSN/P-GW. When the GGSN receives a Create PDP Context request message or the P-GW receives an initial access request (e.g. Create Session Request) the RADIUS client function may send the authentication information to an authentication server, which is identified during the APN provisioning. + +The authentication server checks that the user can be accepted. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the GGSN or P-GW is interworking with the AAA server. + +The information delivered during the RADIUS authentication can be used to automatically correlate the users identity (the MSISDN or IMSI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the GGSN/P-GW or the authentication server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' authentication server. + +RADIUS Authentication is only applicable to the primary PDP context. When the GGSN receives an Access-Accept message from the authentication server it shall complete the PDP context activation procedure. If Access-Reject or no response is received, the GGSN shall reject the PDP Context Activation attempt with a suitable cause code, e.g. User Authentication failed. The GGSN may also use the RADIUS re-authorization procedure for the purpose of IPv4 address allocation to the MS for PDP type of IPv4v6 after establishment of a PDN connection. + +For EPS, RADIUS Authentication is applicable to the initial access request. When the P-GW receives an Access-Accept message from the authentication server it shall complete the initial access procedure. If Access-Reject or no response is received, the P-GW shall reject the initial access procedure with a suitable cause code. The P-GW may also use the RADIUS re-authorization procedure for the purpose of IPv4 address allocation to the UE for PDN type of IPv4v6 after establishment of a PDN connection. The use cases that may lead this procedure are: + +- Deferred IPv4 address allocation via DHCPv4 procedure after successful attach on 3GPP accesses. +- Deferred IPv4 address allocation after successful attach in trusted non-3GPP IP access on S2a. +- Deferred IPv4 home address allocation via DSMIPv6 Re-Registration procedure via S2c. + +## 16.2 RADIUS Accounting + +RADIUS Accounting shall be used according to IETF RFC 2866 [39], IETF RFC 2869 [116], IETF RFC 3162 [50] and IETF RFC 4818 [97]. + +The RADIUS accounting client function may reside in a GGSN/P-GW. The RADIUS accounting client may send information to an accounting server, which is identified during the APN provisioning. The accounting server may store this information and use it to automatically identify the user. This information can be trusted because the Packet Domain network has authenticated the subscriber (i.e. SIM card and possibly other authentication methods). + +The GGSN/P-GW may use the RADIUS Accounting-Request Start and Stop messages during IP-CAN bearer (e.g. primary and secondary PDP context, default and dedicated bearer) activations and deactivations procedures, respectively. For EPC based Packet domain, if the P-GW is not aware of the IP-CAN bearers, e.g. in case of PMIP-based S5/S8, the P-GW may use the RADIUS Accounting-Request Start and Stop messages per IP-CAN session as it would be one IP-CAN bearer. + +The use of Accounting-Request STOP and in addition the Accounting ON and Accounting OFF messages may be used to ensure that information stored in the accounting server is synchronised with the GGSN/P-GW information. + +If the AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a RADIUS Accounting-Request STOP message for all IP-CAN bearers associated to an IP-CAN session defined by APN and IMSI or MSISDN, the AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +For PDN/PDP type IPv4v6 and deferred IPv4 address allocation, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending RADIUS Accounting-Request Interim-Update with Framed-IP-Address attribute and its value field containing the allocated IPv4 address. Similarly, the release of IPv4 address shall be indicated to the accounting server by sending RADIUS Accounting-Request Interim-Update without the Framed-IP-Address attribute. + +In order to avoid race conditions, the GGSN/P-GW shall include a 3GPP Vendor-Specific sub-attribute "Session Stop indicator" when it sends the Accounting-Request STOP for the last IP-CAN bearer of an IP-CAN session and the IP-CAN session is terminated (i.e. the IPv4 address and/or IPv6 prefix and any associated GTP tunnels or PMIP tunnel can be released). The AAA server shall not assume the IP-CAN session terminated until an Accounting-Request STOP with the Session Stop indicator is received. + +## 16.3 Authentication and accounting message flows on Gi interface + +### 16.3.1 IP PDP type + +Figure 22 represents the RADIUS message flows between a GGSN and an Authentication, Authorization and Accounting (AAA) server. + +![Sequence diagram showing RADIUS message flows for IP PDP type between MT, SGSN, GGSN, AAA Server, and PDN.](6031b46d356ee24f96bfe37ee2cb7616_img.jpg) + +``` + +sequenceDiagram + participant MT + participant SGSN + participant GGSN + participant AAA as AAA Server + participant PDN + + Note right of AAA: (Note 2) + + MT->>SGSN: PDP Context Activate Request + SGSN->>GGSN: Create PDP Context Request + GGSN-->>AAA: Access-Request + Note right of AAA: (Note 3) + AAA-->>GGSN: Access-Accept + GGSN->>AAA: Accounting-Request (start) + AAA-->>GGSN: Accounting-Response (start) + GGSN->>SGSN: Create PDP Context Response + Note right of SGSN: (Note 1) + SGSN->>MT: Activate PDP Context Accept + Note left of PDN: User Data + MT->>SGSN: Deactivate PDP Context Request + SGSN->>GGSN: Delete PDP Context Request + GGSN->>AAA: Accounting-Request (stop) + AAA-->>GGSN: Accounting-Response (stop) + GGSN->>SGSN: Delete PDP Context Response + SGSN->>MT: Deactivate PDP Context Accept + +``` + +The diagram illustrates the sequence of messages for activating and deactivating an IP PDP context. + **Activation:** The MT sends a 'PDP Context Activate Request' to the SGSN. The SGSN sends a 'Create PDP Context Request' to the GGSN. The GGSN sends an 'Access-Request' to the AAA Server. The AAA Server responds with 'Access-Accept' and an 'Accounting-Request (start)'. The GGSN sends a 'Create PDP Context Response' to the SGSN, which then sends an 'Activate PDP Context Accept' to the MT. + **Deactivation:** The MT sends a 'Deactivate PDP Context Request' to the SGSN. The SGSN sends a 'Delete PDP Context Request' to the GGSN. The GGSN sends an 'Accounting-Request (stop)' to the AAA Server. The AAA Server responds with an 'Accounting-Response (stop)'. The GGSN sends a 'Delete PDP Context Response' to the SGSN, which then sends a 'Deactivate PDP Context Accept' to the MT. + **Notes:** + +- Note 1: Located between GGSN and SGSN during activation. +- Note 2: Located next to the AAA Server label. +- Note 3: Located next to the 'Access-Request' message from GGSN to AAA. + + A horizontal line labeled 'User Data' indicates the data flow between the GGSN and the PDN. + +Sequence diagram showing RADIUS message flows for IP PDP type between MT, SGSN, GGSN, AAA Server, and PDN. + +NOTE 1: If some external applications require RADIUS Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Response (START) is received from the AAA server. The GGSN may wait for the Accounting Response (START) before sending the CreatePDPContextResponse. The GGSN may reject the PDP context if the Accounting Response (START) is not received. + +NOTE 2: Separate accounting and authentication servers may be used. + +NOTE 3: The Access-Request message shall be used for primary PDP context only. + +NOTE 4: The Accounting-Request (Start) message may be sent at a later stage, e.g. after IPv6 address has been assigned and PDP Context updated, in case of IP address allocation via DHCPv4 after successful PDP context activation signalling. + +**Figure 22: RADIUS message flow for PDP type IP (successful user authentication case)** + +When a GGSN receives a Create PDP Context Request message for a given APN, the GGSN may (depending on the configuration for this APN) send a RADIUS Access-Request to an AAA server. The AAA server authenticates and + +authorizes the user. If RADIUS is also responsible for IPv4 address and/or IPv6 prefix allocation the AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the Access-Accept message. + +When PDP type is IPv4v6 and deferred IPv4 addressing via IPv4 address pool in the AAA server is used, the GGSN may initiate RADIUS re-authorization procedures after successful initial attach for the purpose of IPv4 address allocation or to renew the lease for a previously allocated IPv4 address. In this case, the GGSN shall set the Service-Type attribute to "Authorize Only" and the 3GPP-Allocate-IP-Type subattribute to the type of IP address to be allocated in the Access-Request message sent to the AAA server. See subclause 16.4.7.2 for the conditions to use 3GPP-Allocate-IP-Type sub-attribute in Access-Request messages. If the GGSN is using DHCPv4 signalling towards the MS and the RADIUS server includes the Session-Timeout attribute in the Access-Accept, the GGSN may use the Session-Timeout value as the DHCPv4 lease time. The GGSN shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The GGSN may renew the DHCP lease to the MS without re-authorization towards the AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the GGSN wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the GGSN was not involved in user authentication (e.g. transparent network access mode), it may send a RADIUS Accounting-Request START message to an AAA server. This message contains parameters, e.g. the tuple which includes the user-id and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the AAA server that the user session has started. The session is uniquely identified by the Acct-Session-Id that is composed of the Charging-Id and the GGSN-Address. + +If some external applications require RADIUS Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Response (START) is received from the AAA server. The GGSN may wait for the Accounting Response (START) before sending the CreatePDPContextResponse. The GGSN may reject the PDP context if the Accounting Response (START) is not received. The authentication and accounting servers may be separately configured for each APN. + +For PDP type IPv4, at IPv4 address allocation via DHCPv4 signalling between the TE and the PDN, no IPv4 address is available at PDP context activation. In that case the GGSN may wait to send the Accounting-Request START message until the TE receives its IPv4 address in a DHCPACK. + +For PDP type IPv4v6 and deferred IPv4 addressing, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending RADIUS Accounting-Request Interim-Update with the Framed-IP-Address attribute and its value field containing the allocated IPv4 address. + +When the GGSN receives a Delete PDP Context Request message and providing a RADIUS Accounting-Request START message was sent previously, the GGSN shall send a RADIUS Accounting-Request STOP message to the AAA server, which indicates the termination of this particular user session. The GGSN shall immediately send a Delete PDP context response, without waiting for an Accounting-Response STOP message from the AAA server. + +The AAA server shall deallocate the IPv4 address and/or IPv6 prefix (if any) initially allocated to the subscriber, if there is no session for the subscriber. + +For PDP type IPv4v6 and deferred IPv4 addressing, when the GGSN receives a message from the MS or the network indicating the release of the IPv4 address (e.g. receiving DHCPRELEASE) or decides to release the IPv4 address on its own (e.g. due to DHCP lease timer expiry or GGSN assigned IPv4 address), the GGSN shall inform the accounting server about the deallocation of the IPv4 address by sending RADIUS Accounting-Request Interim-Update without the Framed-IP-Address attribute. + +Accounting-Request ON and Accounting-Request OFF messages may be sent from the GGSN to the AAA server to ensure the correct synchronization of the session information in the GGSN and the AAA server. + +The GGSN may send an Accounting-Request ON message to the AAA server to indicate that a restart has occurred. The AAA server may then release the associated resources. + +Prior to a scheduled restart, the GGSN may send Accounting-Request OFF message to the AAA server. The AAA server may then release the associated resources. + +If an Access-Challenge is sent to the GGSN when an Access-Request message is pending and when IP PDP type is used, the GGSN shall silently discard the Access-Challenge message and it shall treat an Access-Challenge as though it had received an Access-Reject instead RFC 2865 [38]. + +### 16.3.2 PPP PDP type + +Figure 23 describes the RADIUS message flows between a GGSN and an Authentication, Authorization and Accounting (AAA) server for the case where PPP is terminated at the GGSN. The case where PPP is relayed to an LNS is beyond the scope of the present document. + +![Sequence diagram showing RADIUS message flows for PPP PDP type between TE, MT, SGSN, GGSN, AAA Server, and PDN.](9b9262a549828579ab904148450734f6_img.jpg) + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN + participant AAA as AAA Server + participant PDN + + Note right of AAA: (Note 1) + + MT->>SGSN: PDP Context Activate Request + SGSN->>GGSN: Create PDP Context Request + GGSN->>SGSN: Create PDP Context Response + SGSN->>MT: Activate PDP Context Accept + MT->>GGSN: LCP Negotiation + GGSN->>MT: Challenge + MT-->>GGSN: Authentication Request + GGSN->>AAA: Access-Request + Note left of GGSN: (Note 2) + AAA->>GGSN: Access-Accept + Note right of AAA: (Note 5) + GGSN-->>MT: Authentication Response + MT->>GGSN: NCP Negotiation + GGSN->>AAA: Accounting-Request (start) + AAA->>GGSN: Accounting-Response (start) + Note left of GGSN: (Note 3) + MT->>PDN: User Data + Note center: Session + MT-->>GGSN: LCP Termination + Note left of GGSN: (Note 4) + GGSN->>AAA: Accounting-Request (stop) + Note right of AAA: (Note 6) + AAA->>GGSN: Accounting-Response (stop) + GGSN-->>MT: Delete PDP Context Request + MT->>SGSN: Deactivate PDP Context Request + SGSN->>GGSN: Delete PDP Context Request + GGSN->>AAA: Accounting-Request (stop) + Note right of AAA: (Note 7) + AAA->>GGSN: Accounting-Response (stop) + GGSN-->>MT: Deactivate PDP Context Accept + +``` + +Sequence diagram showing RADIUS message flows for PPP PDP type between TE, MT, SGSN, GGSN, AAA Server, and PDN. + +NOTE 1: Separate accounting and Authentication servers may be used. + +NOTE 2: Actual messages depend on the used authentication protocol (e.g. PAP, CHAP). + +NOTE 3: If some external applications require RADIUS Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Response (START) is received from the AAA server. The GGSN may delete the PDP context if the Accounting Response (START) is not received. + +NOTE 4: An LCP termination procedure may be performed. Either the MS or the GGSN may initiate the context deactivation. + +NOTE 5: The Access-Request message shall be used for primary PDP context only. + +NOTE 6: Network Initiated deactivation. + +NOTE 7: User Initiated deactivation. + +Figure 23: RADIUS message flow for PDP type PPP (successful user authentication case) + +When a GGSN receives a Create PDP Context Request message for a given APN, the GGSN shall immediately send a Create PDP context response back to the SGSN. After PPP link setup, the authentication phase may take place. During Authentication phase, the GGSN sends a RADIUS Access-Request to an AAA server. The AAA server authenticates and authorizes the user. If RADIUS is also responsible for IP address allocation the AAA server shall return the allocated IP address or IPv6 prefix in the Access-Accept message (if the user was authenticated). + +If the user is not authenticated, the GGSN shall send a Delete PDP context request to the SGSN. + +Even if the GGSN was not involved in user authentication (e.g. for PPP no authentication may be selected), it may send a RADIUS Accounting-Request START message to an AAA server. This message contains parameters, e.g. a tuple which includes the user-id and IP address or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the AAA server that the user session has started, and the QoS parameters associated to the session. + +If some external applications require RADIUS Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Response (START) is received from the AAA server. The GGSN may delete the PDP context if the Accounting Response (START) is not received. The Authentication and Accounting servers may be separately configured for each APN. + +When the GGSN receives a Delete PDP Context Request message and providing a RADIUS Accounting-Request START message was sent previously, the GGSN shall send a RADIUS Accounting-Request STOP message to the AAA server, which indicates the termination of this particular user session. The GGSN shall immediately send a Delete PDP context response, without waiting for an Accounting-Response STOP message from the AAA server. + +The AAA server shall deallocate the IP address or IPv6 prefix (if any) initially allocated to the subscriber. + +Accounting-Request ON and Accounting-Request OFF messages may be sent from the GGSN to the AAA server to ensure the correct synchronization of the session information in the GGSN and the AAA server. + +The GGSN may send an Accounting-Request ON message to the AAA server to indicate that a restart has occurred. The AAA server may then release the associated resources. + +Prior to a scheduled restart, the GGSN may send Accounting-Request OFF message to the AAA server, the AAA server may then release the associated resources. + +If an Access-Challenge is sent to the GGSN when using PPP PDP type, the GGSN shall handle it by PPP CHAP providing PPP CHAP was the selected Authentication protocol. If CHAP authentication was not selected, authentication shall fail RFC 2865 [38]. + +### 16.3.3 Accounting Update + +During the life of a PDP context some information related to this PDP context may change (i.e. SGSN address if a Inter-SGSN RA update occurs). Upon reception of an UpdatePDPContextRequest from the SGSN, the GGSN may send an Accounting Request Interim-Update to the AAA server to update the necessary information related to this PDP context (see figure 24). Interim updates are also used when the IPv4 address is allocated/released/re-allocated for deferred IPv4 addressing for the PDP type IPv4v6. If the GGSN receives an UpdatePDPContextRequest from the SGSN that specifically indicates a direct tunnel establishment or a direct tunnel teardown (switching the user plane tunnel end back to the SGSN), and only the GTP user plane address and/or the GTP-U TEID have changed, then the GGSN should not send the Accounting Request Interim-Update to the AAA server. In such cases, the GGSN need not wait for the RADIUS AccountingResponse from the AAA server message before sending the UpdatePDPContextResponse to the SGSN. The GGSN may delete the PDP context if the AccountingResponse is not received from the AAA. + +![Sequence diagram showing RADIUS for PDP context Update between SGSN, GGSN, and AAA. The sequence is: 1. SGSN sends UpdatePDPContextReq to GGSN. 2. GGSN sends AccountingReq (Interim-Update) to AAA. 3. AAA sends AccountingRes to GGSN. 4. GGSN sends UpdatePDPContextRes to SGSN. A note indicates that the GGSN does not wait for the AccountingRes from the AAA before sending the UpdatePDPContextRes to the SGSN.](4b398c5e8c4fd656d5b7a61806400650_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant GGSN + participant AAA + Note right of GGSN: (Note) + SGSN->>GGSN: UpdatePDPContextReq + GGSN->>AAA: AccountingReq (Interim-Update) + AAA-->>GGSN: AccountingRes + GGSN-->>SGSN: UpdatePDPContextRes + +``` + +Sequence diagram showing RADIUS for PDP context Update between SGSN, GGSN, and AAA. The sequence is: 1. SGSN sends UpdatePDPContextReq to GGSN. 2. GGSN sends AccountingReq (Interim-Update) to AAA. 3. AAA sends AccountingRes to GGSN. 4. GGSN sends UpdatePDPContextRes to SGSN. A note indicates that the GGSN does not wait for the AccountingRes from the AAA before sending the UpdatePDPContextRes to the SGSN. + +NOTE: As shown the GGSN need not wait for the RADIUS AccountingResponse from the AAA server message to send the UpdatePDPContextResponse to the SGSN. The GGSN may delete the PDP context if the AccountingResponse is not received from the AAA. + +Figure 24: RADIUS for PDP context Update + +### 16.3.4 AAA-Initiated PDP context termination + +RADIUS is used as the protocol between the GGSN and an AAA server or proxy for applications (e.g. MMS) to deliver information related to GPRS user session. However some IP applications could need to interwork with the GGSN to terminate a particular PDP context. For this purpose, the AAA server or proxy may send a RADIUS Disconnect Request to the GGSN. As depicted in figure 25, the GGSN may react by deleting the corresponding PDP context or silently discard the Disconnect Request message. For more information on RADIUS Disconnect, see RFC 3576 [41]. If the GGSN deletes the corresponding PDP context, it need not wait for the DeletePDPContextResponse from the SGSN before sending the RADIUS DisconnectResponse to the AAA server. + +The Teardown-Indicator in the RADIUS Disconnect Request message indicates to the GGSN that all PDP contexts for this particular user and sharing the same user session shall be deleted. The PDP contexts belong to the same IP-CAN session are identified by the Acct-Session-Id. The Charging-Id contained in the Acct-Session-Id can be of any PDP context of the user. The GGSN is able to find out all the related PDP contexts sharing the same user session once it has found the exact PDP context from the Acct-Session-Id. If a user has the same user IP address for different sets of PDP contexts towards different networks, only the PDP contexts linked to the one identified by the Acct-Session-Id shall be deleted. + +Since the Charging-Id contained in the Acct-Session-Id is already sufficient to uniquely identify PDP context(s) for a user session on a GGSN, it has no impact if the user IP address is not known by the GGSN (e.g. in the case of transparent PPP IP-CAN sessions). In this case the user IP address in the Disconnect message should be set to zero (e.g. 0.0.0.0 for IPv4). + +![Sequence diagram showing PDP Context deletion with RADIUS. The diagram involves three entities: SGSN, GGSN, and AAA. The sequence of messages is: 1. AAA sends a DisconnectReq to GGSN. 2. GGSN sends a DeletePDPContextReq to SGSN. 3. SGSN sends a DeletePDPContextRes to GGSN. 4. GGSN sends a DisconnectRes to AAA. A note is present below the DisconnectRes message.](347010b7ac06d3ae97927fde0f784d7c_img.jpg) + +``` + +sequenceDiagram + participant AAA + participant GGSN + participant SGSN + AAA->>GGSN: DisconnectReq + GGSN->>SGSN: DeletePDPContextReq + SGSN->>GGSN: DeletePDPContextRes + Note right of GGSN: (Note) + GGSN->>AAA: DisconnectRes + +``` + +Sequence diagram showing PDP Context deletion with RADIUS. The diagram involves three entities: SGSN, GGSN, and AAA. The sequence of messages is: 1. AAA sends a DisconnectReq to GGSN. 2. GGSN sends a DeletePDPContextReq to SGSN. 3. SGSN sends a DeletePDPContextRes to GGSN. 4. GGSN sends a DisconnectRes to AAA. A note is present below the DisconnectRes message. + +NOTE: As showed on figure 25, the GGSN need not wait for the DeletePDPContextResponse from the SGSN to send the RADIUS DisconnectResponse to the AAA server. + +Figure 25: PDP Context deletion with RADIUS + +## 16.3a Authentication and accounting message flows on Sgi interface + +### 16.3a.1 Authentication, Authorization and Accounting procedures + +When a P-GW receives an initial access request (e.g. Create Session Request or Proxy Binding Update) message for a given APN, the P-GW may (depending on the configuration for this APN) send a RADIUS Access-Request to an AAA server. The AAA server authenticates and authorizes the user. If the RADIUS server is also responsible for IPv4 address and/or IPv6 prefix allocation, the AAA server shall return the allocated IPv4 address and/or IPv6 prefix in the Access-Accept message. + +When PDN type is IPv4v6 and deferred IPv4 addressing via IPv4 address pool in the AAA server is used, the P-GW may initiate RADIUS re-authorization procedures after successful initial attach for the purpose of IPv4 address allocation or to renew the lease for a previously allocated IPv4 address. In this case, the P-GW shall set the Service-Type attribute to "Authorize Only" and the 3GPP-Allocate-IP-Type subattribute to the type of IP address to be allocated in the Access-Request message sent to the AAA server. See subclause 16.4.7.2 for the conditions to use 3GPP-Allocate-IP-Type sub-attribute in Access-Request messages. If the P-GW is using DHCPv4 signalling towards the UE and the RADIUS server includes the Session-Timeout attribute in the Access-Accept, the P-GW may use the Session-Timeout value as the DHCPv4 lease time. The P-GW shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The P-GW may renew the DHCP lease to the UE without re-authorization towards the AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the P-GW wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the P-GW was not involved in user authentication, it may send a RADIUS Accounting-Request (START) message to an AAA server. This message may contain parameters, e.g. the tuple which includes the user-id and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the AAA server that the user session has started. The session is uniquely identified by the Acct-Session-Id that is composed of the Charging-Id and the PGW-Address. + +If some external applications require RADIUS Accounting-Request (START) information before they can process user packets, then the selected APN (P-GW) may be configured in such a way that the P-GW drops user data until the Accounting-Response (START) is received from the AAA server. The P-GW may wait for the Accounting-Response (START) before sending the initial access response (e.g. Create Session Response or Proxy Binding Acknowledgement). The P-GW may reject the initial access request if the Accounting-Response (START) is not received. The authentication and accounting servers may be separately configured for each APN. + +For PDN type IPv4, at IPv4 address allocation via DHCPv4 signalling between the UE and the PDN, no IPv4 address is available at initial access. In that case the P-GW may wait to send the Accounting-Request (START) message until the UE receives its IPv4 address in a DHCPACK. + +For PDN type IPv4v6 and deferred IPv4 addressing, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending RADIUS Accounting-Request Interim-Update with the Framed-IP-Address attribute and its value field containing the allocated IPv4 address. + +When the P-GW receives a message indicating a bearer deactivation request or PDN disconnection request or detach request (e.g. Delete Bearer Command or Proxy Binding Update with lifetime equal 0) and providing a RADIUS Accounting-Request (START) message was sent previously, the P-GW shall send a RADIUS Accounting-Request (STOP) message to the AAA server, which indicates the termination of this particular bearer or user session. The P-GW shall immediately send the corresponding response (e.g. Delete Bearer Request or Proxy Binding Ack with lifetime equal 0) to the peer node (e.g. S-GW) in the Packet Domain, without waiting for an Accounting-Response (STOP) message from the AAA server. + +The AAA server shall deallocate the IPv4 address and/or IPv6 prefix initially allocated to the subscriber, if there is no session for the subscriber. + +For PDN type IPv4v6 and deferred IPv4 addressing, when the P-GW receives a message from the UE or the network indicating the release of the IPv4 address (e.g. receiving DHCPRELEASE) or decides to release the IPv4 address on its own (e.g. due to DHCP lease timer expiry or P-GW assigned IPv4 address), the P-GW shall inform the accounting server about the deallocation of the IPv4 address by sending RADIUS Accounting-Request Interim-Update without the Framed-IP-Address attribute. + +Accounting-Request (ON) and Accounting-Request (OFF) messages may be sent from the P-GW to the AAA server to ensure the correct synchronization of the session information in the P-GW and the AAA server. + +The P-GW may send an Accounting-Request (ON) message to the AAA server to indicate that a restart has occurred. The AAA server may then release the associated resources. + +Prior to a scheduled restart, the P-GW may send Accounting-Request (OFF) message to the AAA server. The AAA server may then release the associated resources. + +If an Access-Challenge is sent to the P-GW when an Access-Request message is pending, the P-GW shall silently discard the Access-Challenge message and it shall treat an Access-Challenge as though it had received an Access-Reject instead RFC 2865 [38]. + +For example, figure 25a.1 represents the RADIUS message flows between a P-GW and an Authentication, Authorization and Accounting (AAA) server, which is applicable for GTP based S5/S8: + +![Sequence diagram showing RADIUS message flow on Sgi interface for GTP-based S5/S8. Lifelines: S-GW, P-GW, AAA server (note 2), and PDN. The diagram illustrates the interaction for session creation and deletion.](2a476a0b3dbc3429436246db4784ff9f_img.jpg) + +``` + +sequenceDiagram + participant S-GW + participant P-GW + participant AAA_server as AAA server (note 2) + participant PDN + + Note left of S-GW: + S-GW->>P-GW: Create Session Request + P-GW->>AAA_server: Access-Request + AAA_server-->>P-GW: Access-Accept + P-GW->>AAA_server: Accounting-Request (start) + AAA_server-->>P-GW: Accounting-Response (start) + P-GW->>S-GW: Create Session Response (note 1) + Note left of S-GW: + S-GW->>P-GW: Delete Session Request + P-GW->>AAA_server: Accounting-Request (stop) + AAA_server-->>P-GW: Accounting-Response (stop) + P-GW->>S-GW: Delete Session Response + Note left of S-GW: + +``` + +Sequence diagram showing RADIUS message flow on Sgi interface for GTP-based S5/S8. Lifelines: S-GW, P-GW, AAA server (note 2), and PDN. The diagram illustrates the interaction for session creation and deletion. + +NOTE 1: If some external applications require RADIUS Accounting request (Start) information before they can process user packets, then the selected APN (P-GW) may be configured in such a way that the P-GW drops user data until the Accounting Response (START) is received from the AAA server. The P-GW may wait for the Accounting Response (START) before sending the Create Session Response. The P-GW may reject the bearer if the Accounting Response (START) is not received. + +NOTE 2: Separate accounting and authentication servers may be used. + +**Figure 25a.1: An example of RADIUS message flow on Sgi interface for GTP-based S5/S8 (successful user authentication case)** + +### 16.3a.2 Accounting Update + +During the life of an IP-CAN bearer some information related to this bearer may change. Upon occurrence of the following events, the P-GW may send RADIUS Accounting Request Interim-Update to the AAA server: RAT change, S-GW address change and QoS change. Interim updates are also used when the IPv4 address is allocated/released/re-allocated for deferred IPv4 addressing for the PDN type IPv4v6. + +When the P-GW receives a signalling request (e.g. Modify Bearer Request in case of GTP-based S5/S8) that indicates the occurrence of one of these chargeable events, the P-GW may send an Accounting Request Interim-Update to the AAA server to update the necessary information related to this bearer. The P-GW need not wait for the RADIUS AccountingResponse message from the AAA server before sending the response for the triggering signalling message (e.g. Modify Bearer Response). The P-GW may delete the bearer if the AccountingResponse is not received from the AAA. + +The P-GW may also send interim updates at the expiry of an operator configured time limit. + +The following Figure 25a.2 is an example message flow to show the procedure of RADIUS accounting update, which applicable for GTP based S5/S8: + +![Sequence diagram showing RADIUS accounting update for Modify Bearer Request. The diagram involves three entities: S-GW, P-GW, and AAA. The sequence is: 1. S-GW sends a 'Modify Bearer Request' to P-GW. 2. P-GW sends an 'AccountingReq (Interim-Update)' to AAA. 3. AAA sends an 'AccountingRes' back to P-GW. 4. P-GW sends a 'Modify Bearer Response' back to S-GW.](0931f3e098bd4539041de11c50cec2d2_img.jpg) + +``` +sequenceDiagram + participant S-GW + participant P-GW + participant AAA + S-GW->>P-GW: Modify Bearer Request + P-GW->>AAA: AccountingReq (Interim-Update) + AAA-->>P-GW: AccountingRes + P-GW-->>S-GW: Modify Bearer Response +``` + +Sequence diagram showing RADIUS accounting update for Modify Bearer Request. The diagram involves three entities: S-GW, P-GW, and AAA. The sequence is: 1. S-GW sends a 'Modify Bearer Request' to P-GW. 2. P-GW sends an 'AccountingReq (Interim-Update)' to AAA. 3. AAA sends an 'AccountingRes' back to P-GW. 4. P-GW sends a 'Modify Bearer Response' back to S-GW. + +Figure 25a.2: RADIUS accounting update for Modify Bearer Request + +### 16.3a.3 AAA-Initiated Bearer termination + +RADIUS is used as the protocol between the P-GW and the AAA server or proxy for applications (e.g. MMS) to deliver information related to EPS user session. However some IP applications could need to interwork with the P-GW to release the corresponding resource (e.g. terminate a particular bearer or Resource Allocation Deactivation procedures as defined in TS 23.402 [78]). For this purpose, the AAA server or proxy may send a RADIUS Disconnect Request to the P-GW. On receipt of the Disconnect-Request from the AAA server, the P-GW shall release the corresponding resources and reply with a Disconnect-ACK. If the P-GW is unable to release the corresponding resources, it shall reply to the AAA server with a Disconnect-NAK. For more information on RADIUS Disconnect, see IETF RFC 3576 [41]. If the P-GW deletes the corresponding bearer, it need not wait for the response from the S-GW or non-3GPP IP access or ePDG before sending the RADIUS DisconnectResponse to the AAA server. + +The Teardown-Indicator in the RADIUS Disconnect Request message indicates to the P-GW that all IP-CAN bearers for this particular user and sharing the same user session shall be deleted. The IP-CAN bearers that belong to the same IP-CAN session are identified by the Acct-Session-Id. The Charging-Id contained in the Acct-Session-Id can be of any IP-CAN bearer of the user. The P-GW is able to find out all the related IP-CAN bearers sharing the same user session once it has found the exact IP-CAN bearer from the Acct-Session-Id. If a user has the same user IP address for different sets of IP-CAN bearers towards different networks, only the IP-CAN bearers linked to the one identified by the Acct-Session-Id shall be deleted. If the value of Teardown-Indicator is set to "0" or if TI is missing, and if the Acct-Session-Id identifies the default bearer, the P-GW shall tear-down all the IP-CAN bearers that share the same user session identified by the Acct-Session-Id. + +The following Figure 25a.3 is an example message flow to show the procedure of RADIUS AAA-Initiated Bearer termination, which applicable for GTP based S5/S8: + +![Sequence diagram showing AAA-initiated bearer termination. The diagram involves three entities: S-GW, P-GW, and AAA. The sequence of messages is: 1. AAA sends a DisconnectReq to P-GW. 2. P-GW sends a Delete Bearer Request to S-GW. 3. S-GW sends a Delete Bearer Response to P-GW. 4. P-GW sends a DisconnectRes to AAA. A note is present below the DisconnectRes message.](ffb6acd27b8e3a54392840948a75869f_img.jpg) + +``` + +sequenceDiagram + participant AAA + participant P-GW + participant S-GW + Note right of P-GW: (Note) + AAA->>P-GW: DisconnectReq + P-GW->>S-GW: Delete Bearer Request + S-GW->>P-GW: Delete Bearer Response + P-GW->>AAA: DisconnectRes + +``` + +Sequence diagram showing AAA-initiated bearer termination. The diagram involves three entities: S-GW, P-GW, and AAA. The sequence of messages is: 1. AAA sends a DisconnectReq to P-GW. 2. P-GW sends a Delete Bearer Request to S-GW. 3. S-GW sends a Delete Bearer Response to P-GW. 4. P-GW sends a DisconnectRes to AAA. A note is present below the DisconnectRes message. + +NOTE: As shown on figure 25a.3, the P-GW need not wait for the Delete Bearer Response from the S-GW to send the RADIUS DisconnectResponse to the AAA server. + +Figure 25a.3: AAA-initiated bearer termination with RADIUS + +## 16.4 List of RADIUS attributes + +The following tables describe the actual content of the RADIUS messages exchanged between the GGSN/P-GW and the AAA server. Other RADIUS attributes may be used as defined in RADIUS RFC(s). Unless otherwise stated, when the encoding scheme of an attribute is specified as UTF-8 encoding, this shall be interpreted as UTF-8 hexadecimal encoding. + +NOTE: Any digit is converted into UTF-8 character. For example, digit 5 is converted to UTF-8 character '5', which in hexadecimal representation has a value 0x35. Similarly, a hexadecimal digit F is converted to either UTF-8 character 'F', which in hexadecimal representation has a value 0x46, or to UTF-8 character 'f', which in hexadecimal representation has a value 0x66. + +### 16.4.1 Access-Request message (sent from GGSN/P-GW to AAA server) + +Table 1 describes the attributes of the Access-Request message. + +Table 1: The attributes of the Access-Request message + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------------------| +| 1 | User-Name | Username is provided to the GGSN/P-GW by the user in Protocol Configuration Options (PCO) or for the case of the P-GW when multiple authentications are supported in the Additional Protocol Configuration Options (APCO) received during IP-CAN session establishment procedure. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. If no username is available, a generic username, configurable on a per APN basis, shall be present. | String | Mandatory | +| 2 | User-Password | User password is provided to the GGSN/P-GW by the user in the PCO or for the case of the P-GW when multiple authentications are supported in the APCO received during IP-CAN session establishment procedure if PAP is used. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. If no password is available a generic password, configurable on a per APN basis, shall be present. | String | Conditional
Note 1 | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|----------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| 3 | CHAP-Password | CHAP password is provided to the GGSN/P-GW by the user in the PCO or for the case of the P-GW when multiple authentications are supported in the APCO received during IP-CAN session establishment procedure. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. | String | Conditional Note 2 | +| 4 | NAS-IP-Address | IPv4 address of the GGSN/P-GW for communication with the AAA server. | IPv4 | Conditional Note 3 and 7 | +| 95 | NAS-IPv6-Address | IPv6 address of the GGSN/P-GW for communication with the AAA server. | IPv6 | Conditional Note 3 and 7 | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional Note 3 | +| 6 | Service-Type | Indicates the type of service for this user | 2 (Framed)
or
17 (Authorize Only)
Note 9 | Optional | +| 7 | Framed-Protocol | Indicates the type of protocol for this user | 7 (GPRS PDP Context) | Optional Note 8 | +| 8 | Framed-IP-Address | IPv4 address allocated for this user | IPv4 | Conditional Note 4, Note 11 | +| 9 | Framed-IP-Netmask | Netmask for the user IPv4 address | IPv4 | Conditional Note 4, Note 11 | +| 97 | Framed-IPv6-Prefix | IPv6 prefix allocated for this user | IPv6 | Conditional Note 4, Note 11 | +| 123 | Delegated-IPv6-Prefix | IPv6 prefix delegated to the user. | IPv6 | Conditional Note 10 | +| 96 | Framed-Interface-Id | IPv6 Interface Identifier provided by the GGSN/P-GW to the UE at Initial Attach. | 64 bits as per IETF RFC 3162 [50] | Optional Note 5 | +| 30 | Called-Station-Id | Identifier for the target network | APN (UTF-8 encoded characters) | Mandatory | +| 31 | Calling-Station-Id | This attribute is the identifier for the MS, and it shall be configurable on a per APN basis. | MSISDN in international format according to 3GPP TS 23.003 [40], UTF-8 encoded decimal character. (Note 6) | Optional | +| 60 | CHAP-Challenge | CHAP Challenge is provided to the GGSN/P-GW by the user in the PCO or for the case of the P-GW when multiple authentications are supported in the APCO received during the IP-CAN session establishment procedure. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. | String | Conditional Note 2 | +| 61 | NAS-Port-Type | Port type for the GGSN/P-GW | As per RFC 2865 [38] | Optional | +| 26/10415 | 3GPP Vendor-Specific | Sub-attributes according subclause 16.4.7 | See subclause 16.4.7 | Optional except sub-attribute 3 and 27 which are conditional | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------|----------------------| +| NOTE 1: | Shall be present if PAP is used. | | | | +| NOTE 2: | Shall be present if CHAP is used. | | | | +| NOTE 3: | If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, then the Either NAS-IP-Address or NAS-Identifier shall be present. | | | | +| NOTE 4: | IPv4 address and/or IPv6 prefix attributes shall be present. The IP protocol version for end-user and network may be different. | | | | +| NOTE 5: | As per subclause 9.2.1.1 of 3GPP TS 23.060 [3] and subclause 5.3.1.2.2 of 3GPP TS 23.401 [77] the UE shall use this interface identifier to configure its link-local address, however the UE can choose any interface identifier to generate its IPv6 address(es) other than link-local without involving the network . | | | | +| NOTE 6: | There are no leading characters in front of the country code. | | | | +| NOTE 7: | Either IPv4 or IPv6 address attribute shall be present. | | | | +| NOTE 8: | Framed-Protocol value of 7 is used by both GGSN and P-GW when interworking with RADIUS AAA servers. When used for P-GW, it represents the IP-CAN bearer. | | | | +| NOTE 9: | Service-Type attribute value of "Authorize Only" (RFC 5176 [93]) is only applicable for P-GW/GGSN when deferred IPv4 addressing for a UE needs to be performed for PDN/PDP type IPv4v6. In this use case, the Access Request at UE's initial access shall have Service-Type value "Framed", but the subsequent Access Request shall have Service-Type value of "Authorize Only". In both Access-Request messages, the 3GPP-Allocate-IP-Type sub-attribute shall be present. See subclause 16.4.7.2 for the typical uses cases how 3GPP-Allocate-IP-Type subattribute is utilised in Access-Request messages. | | | | +| NOTE 10: | Delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server. | | | | +| NOTE 11: | For an initial Access-Request message, the Ipv4 address and/or Ipv6 prefix attributes shall be present only if the 3GPP-Allocate-IP-Type sub-attribute is not present or is present with an IP Type value set to zero. | | | | + +## 16.4.2 Access-Accept (sent from AAA server to GGSN/P-GW) + +Table 2 describes the attributes of the Access-Accept message. See RFC 2548 [51] for definition of MS specific attributes. + +**Table 2: The attributes of the Access-Accept message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------| +| 1 | User-Name | Username received in the Access-Request message or a substitute username provided by the AAA server. If the User-Name has been received in the Access-Accept message, this user-name shall be used in preference to the above | String | Optional | +| 6 | Service-Type | Indicates the type of service for this user | Framed | Optional | +| 7 | Framed-Protocol | Indicates the type of protocol for this user | 7 (GPRS PDP Context) | Optional
Note 4 | +| 8 | Framed-IP-Address | IPv4 address allocated for this user, if the AAA server is used to allocate IP address. | IPv4 | Conditional
Note 2, Note 8 | +| 9 | Framed-IP-Netmask | Netmask for the user IPv4 address, if the AAA server is used to allocate IP netmask. | IPv4 | Conditional
Note 2, Note 8 | +| 97 | Framed-IPv6-Prefix | IPv6 address prefix allocated for this user, if the AAA server is used to allocate IPv6 address prefixes. | IPv6 | Conditional
Note 2, Note 8 | +| 123 | Delegated-IPv6-Prefix | IPv6 prefix delegated to the user. | IPv6 | Conditional
Note 6 | +| 96 | Framed-Interface-Id | IPv6 Interface Identifier provided by the GGSN/P-GW to the UE at Initial Attach. | 64 bits as per IETF RFC 3162 [50] | Optional
Note 7 | +| 100 | Framed-IPv6-Pool | Name of the IPv6 prefix pool for the specific APN | String | Optional
Note 2 | +| 12 | Framed-MTU | Maximum Transmission Unit of the PDP PDUs, between the MS and GGSN/P-GWs (Note 5) | String | Optional | +| 25 | Class | Identifier to be used in all subsequent accounting messages. | String | Optional
(Note 1) | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|----------------------| +| 27 | Session-Timeout | Indicates the timeout value (in seconds) for the user session | 32 bit unsigned Integer | Optional | +| 28 | Idle-Timeout | Indicates the timeout value (in seconds) for idle user session | 32 bit unsigned Integer | Optional | +| 26/311 | MS- Primary-DNS-Server | Contains the primary DNS server address for this APN | IPv4 | Optional
Note 3 | +| 26/311 | MS-Secondary-DNS-Server | Contains the secondary DNS server address for this APN | IPv4 | Optional
Note 3 | +| 26/311 | MS-Primary-NBNS-Server | Contains the primary NetBIOS name server address for this APN | IPv4 | Optional
Note 3 | +| 26/311 | MS-Secondary-NBNS-Server | Contains the secondary NetBIOS server address for this APN | IPv4 | Optional
Note 3 | +| 26/10415 /17 | 3GPP-IPv6-DNS-Servers | List of IPv6 addresses of DNS servers for this APN | IPv6 | Optional
Note 3 | +| 64 | Tunnel-Type | Indicates the tunneling protocol(s) to be used. Value 3 to be used for L2TP tunnel. | As per RFC 2868 [119] clause 3.1. | Optional
Note 9 | +| 65 | Tunnel-Medium-Type | Indicates which transport medium to use when creating a tunnel for those protocols (such as L2TP). Value 1 for IPv4 and/or value 2 for IPv6 to be used when the Tunnel-Type value 3 for L2TP tunnel is present. | As per RFC 2868 [119] clause 3.2. | Optional
Note 9 | +| 67 | Tunnel-Server-Endpoint | Indicates the address of the server end of the tunnel. | As per RFC 2868 [119] clause 3.4. | Optional
Note 9 | +| 69 | Tunnel-Password | Indicates the password to be used to authenticate to a remote server. | As per RFC 2868 [119] clause 3.5. | Optional | +| 83 | Tunnel-Preference | Indicates the relative preference assigned to each tunnel, If more than one set of tunneling attributes is included. | As per RFC 2868 [119] clause 3.8. | Optional
Note 9 | + +NOTE 1: The presence of this attribute is conditional upon this attribute being received in the Access-Accept message + +NOTE 2: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, then the IPv4 address and/or IPv6 prefix attributes shall be present. The IP protocol version for the end-user and network may be different. + +NOTE 3: Depending on IP address(es) allocated to the user, either or both IPv4 and IPv6 address attributes shall be present. + +NOTE 4: Framed-Protocol value of 7 is used by both GGSN and P-GW when interworking with RADIUS AAA servers. When used for P-GW, it represents the IP-CAN bearer. + +NOTE 5: In network deployments that have MTU size of 1500 octets in the transport network, providing a link MTU value of 1358 octets to the MS as part of the IP configuration information from the network will prevent the IP layer fragmentation within the transport network between the MS and the GGSN/P-GW. Link MTU considerations are discussed further in Annex C of 3GPP TS 23.060 [3]. + +NOTE 6: Delegated IPv6 prefix shall be present if the user was delegated an IPv6 prefix. + +NOTE 7: As per subclause 9.2.1.1 of 3GPP TS 23.060 [3] and subclause 5.3.1.2.2 of 3GPP TS 23.401 [77] the UE shall use this interface identifier to configure its link-local address, however the UE can choose any interface identifier to generate its IPv6 address(es) other than link-local without involving the network. + +NOTE 8: For an initial Access-Accept message, the IPv4 address and/or IPv6 prefix attributes shall be present only if the 3GPP-Allocate-IP-Type sub-attribute is present with IP Type value 1, 2 or 3 in the initial Access-Request message. + +NOTE 9: If more than one set of "Tunneling" attributes are provided, the "Tunnel-Preference" attribute may be provided in each set to identify the relative preference. + +NOTE: The other optional attributes starting with "Tunnel-" not listed in the above table, can be referred to the IETF RFC 2868[119] with implementation specific. + +### 16.4.3 Accounting-Request START (sent from GGSN/P-GW to AAA server) + +Table 3 describes the attributes of the Accounting-Request START message. + +**Table 3: The attributes of the Accounting-Request START message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|---------------------------| +| 1 | User-Name | Username is provided to the GGSN/P-GW by the user in received during IP-CAN session establishment procedure. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. If no username is available a generic username, configurable on a per APN basis, shall be present. If the User-Name has been received in the Access-Accept message, this user-name shall be used in preference to the above | String | Optional | +| 4 | NAS-IP-Address | GGSN/P-GW IPv4 address for communication with the AAA server. | IPv4 | Conditional Notes 1 and 7 | +| 95 | NAS-IPv6-Address | GGSN/P-GW IPv6 address for communication with the AAA server. | IPv6 | Conditional Notes 1 and 7 | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional Note 1 | +| 6 | Service-Type | Indicates the type of service for this user | Framed | Optional | +| 7 | Framed-Protocol | Indicates the type of protocol for this user | 7 (GPRS PDP Context) | Optional Note 8 | +| 8 | Framed-IP-Address | User IPv4 address | IPv4 | Conditional Note 3 | +| 97 | Framed-IPv6-Prefix | User IPv6 Prefix | IPv6 | Conditional Note 3 | +| 123 | Delegated-IPv6-Prefix | Delegates IPv6 Prefix to the user | IPv6 | Conditional Note 9 | +| 96 | Framed-Interface-Id | IPv6 Interface Identifier provided by the GGSN/P-GW to the UE at Initial Attach. | 64 bits as per IETF RFC 3162 [50] | Optional Note 4 | +| 25 | Class | Received in the Access-Accept | String | Conditional (Note 2) | +| 30 | Called-Station-Id | Identifier for the target network | APN (UTF-8 encoded) | Mandatory | +| 31 | Calling-Station-Id | This attribute is the identifier for the MS, and it shall be configurable on a per APN basis. | MSISDN in international format according to 3GPP TS 23.003 [40], UTF-8 encoded decimal character. (Note 6) | Optional | +| 40 | Acct-Status-Type | Type of accounting message | START | Mandatory | +| 41 | Acct-Delay-Time | Indicates how many seconds the GGSN/P-GW has been trying to send this record for, and can be subtracted from the time of arrival on the AAA server to find the approximate time (in seconds) of the event generating this Accounting-Request. | 32 unsigned integer | Optional | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|----------|----------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| 44 | Acct-Session-Id | User session identifier. | GGSN/P-GW IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal character. (Note 5) | Mandatory | +| 45 | Acct-Authentic | Authentication method | RADIUS or LOCAL | Optional | +| 61 | NAS-Port-Type | Port type for the GGSN/P-GW | As per RFC 2865 [38] | Optional | +| 26/10415 | 3GPP Vendor-Specific | Sub-attributes according subclause 16.4.7. | See subclause 16.4.7 | Optional except sub-attribute 3 which is conditional | + +NOTE 1: Either NAS-IP-Address or NAS-Identifier shall be present. + +NOTE 2: The presence of this attribute is conditional upon this attribute being received in the Access-Accept message + +NOTE 3: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, IPv4 address and/or IPv6 prefix attributes shall be present. The IP protocol version for end-user and network may be different. + +NOTE 4: As per subclause 9.2.1.1 of 3GPP TS 23.060 [3] and subclause 5.3.1.2.2 of 3GPP TS 23.401 [77] the UE shall use this interface identifier to configure its link-local address, however the UE can choose any interface identifier to generate its IPv6 address(es) other than link-local without involving the network . + +NOTE 5: The GGSN/P-GW IP address is the same one that is used in the CDRs generated by the GGSN/P-GW. + +NOTE 6: There are no leading characters in front of the country code. + +NOTE 7: Either IPv4 or IPv6 address attribute shall be present. + +NOTE 8: Framed-Protocol value of 7 is used by both GGSN and P-GW when interworking with RADIUS AAA servers. When used for P-GW, it represents the IP-CAN bearer. + +NOTE 9: Delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server. + +#### 16.4.4 Accounting Request STOP (sent from GGSN/P-GW to AAA server) + +Table 4 describes the attributes of the Accounting-Request STOP message. + +**Table 4: The attributes of the Accounting-Request STOP message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---------------------------| +| 1 | User-Name | Username is provided to the GGSN/P-GW by the user in the PCO or for the case of the P-GW when multiple authentications are supported in the APCO received during IP-CAN session establishment procedure. If PPP PDP type is used, it is provided to the GGSN by the user during PPP authentication phase. If no username is available a generic username, configurable on a per APN basis, shall be present. If the User-Name has been received in the Access-Accept message, this username shall be used in preference to the above. | String | Optional | +| 4 | NAS-IP-Address | IPv4 address of the GGSN/P-GW for communication with the AAA server. | IPv4 | Conditional Notes 1 and 7 | +| 95 | NAS-IPv6-Address | IPv6 address of the GGSN/P-GW for communication with the AAA server. | IPv6 | Conditional Notes 1 and 7 | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional Note 1 | +| 6 | Service-Type | Indicates the type of service for this user | Framed | Optional | +| 7 | Framed-Protocol | Indicates the type of protocol for this user | 7 (GPRS PDP Context) | Optional Note 8 | +| 8 | Framed-IP-Address | User IPv4 address | IPv4 | Conditional Note 3 | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|-----------------------| +| 97 | Framed-IPv6-Prefix | User IPv6 Prefix | IPv6 | Conditional
Note 3 | +| 123 | Delegated-IPv6-Prefix | Delegated IPv6 Prefix to the user | IPv6 | Conditional
Note 9 | +| 96 | Framed-Interface-Id | IPv6 Interface Identifier provided by the GGSN/P-GW to the UE at Initial Attach | 64 bits as per IETF RFC 3162 [50] | Optional
Note 4 | +| 25 | Class | Received in the Access-Accept | String | Optional
(Note 2) | +| 30 | Called-Station-Id | Identifier for the target network | APN (UTF-8 encoded characters) | Mandatory | +| 31 | Calling-Station-Id | This attribute is the identifier for the MS, and it shall be configurable on a per APN basis. | MSISDN in international format according to 3GPP TS 23.003 [40], UTF-8 encoded characters. (Note 6) | Optional | +| 40 | Acct-Status-Type | Indicates the type of accounting request | STOP | Mandatory | +| 41 | Acct-Delay-Time | Indicates how many seconds the GGSN/P-GW has been trying to send this record for, and can be subtracted from the time of arrival on the AAA server to find the approximate time of the event generating this Accounting-Request | Second | Optional | +| 42 | Acct-Input-Octets | GGSN/P-GW counted number of octets sent by the user for the IP-CAN bearer | 32 bit unsigned integer | Optional | +| 43 | Acct-Output-Octets | GGSN/P-GW counted number of octets received by the user for the IP-CAN bearer | 32 bit unsigned integer | Optional | +| 44 | Acct-Session-Id | User session identifier. | GGSN/P-GW IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal character. (Note 5) | Mandatory | +| 45 | Acct-Authentic | Authentication method | RADIUS or LOCAL | Optional | +| 46 | Acct-Session-Time | Duration of the session | Second | Optional | +| 47 | Acct-Input-Packets | GGSN/P-GW counted number of packets sent by the user | Packet | Optional
(Note 10) | +| 48 | Acct-Output-Packets | GGSN/P-GW counted number of packets received by the user | Packet | Optional
(Note 10) | +| 49 | Acct-Terminate-Cause | Indicate how the session was terminated | See IETF RFC 2866 [39] | Optional | +| 52 | Acct-Input-Gigawords | It indicates how many times the Acct-Input-Octets counter has wrapped around 2 32 and is present if the Acct-Input-Octets counter has wrapped around 2 32 . | 32 bit unsigned integer
See IETF RFC 2869 [116] | Conditional | +| 53 | Acct-Output-Gigawords | It indicates how many times the Acct-Output-Octets counter has wrapped around 2 32 and is present if the Acct-Output-Octets counter has wrapped around 2 32 . | 32 bit unsigned integer
See IETF RFC 2869 [116] | Conditional | +| 61 | NAS-Port-Type | Port type for the GGSN/P-GW | As per IETF RFC 2865 [38] | Optional | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-----------------------------------------------|----------------------|------------------------------------------------------| +| 26/10415 | 3GPP Vendor-Specific | Sub-attributes according to subclause 16.4.7. | See subclause 16.4.7 | Optional except sub-attribute 3 which is conditional | +| NOTE 1: Either NAS-IP-Address or NAS-Identifier shall be present.
NOTE 2: The presence of this attribute is conditional upon this attribute being received in the Access-Accept message
NOTE 3: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, IPv4 address and/or IPv6 prefix attributes shall be present. The IP protocol version for end-user and network may be different.
NOTE 4: As per subclause 9.2.1.1 of 3GPP TS 23.060 [3] and subclause 5.3.1.2.2 of 3GPP TS 23.401 [77] the UE shall use this interface identifier to configure its link-local address, however the UE can choose any interface identifier to generate its IPv6 address(es) other than link-local without involving the network .
NOTE 5: The GGSN/P-GW IP address is the same one that is used in the CDRs generated by the GGSN/P-GW.
NOTE 6: There are no leading characters in front of the country code.
NOTE 7: Either IPv4 or IPv6 address attribute shall be present.
NOTE 8: Framed-Protocol value of 7 is used by both GGSN and P-GW when interworking with RADIUS AAA servers. When used for P-GW, it represents the IP-CAN bearer.
NOTE 9: Delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server.
NOTE 10: If the P-GW is split into a user plane node and control plane node according to 3GPP TS 29.244 [114], the user plane function "MNOP" need to be supported. | | | | | + +### 16.4.5 Accounting Request ON (optionally sent from GGSN/P-GW to AAA server) + +Table 5 describes the attributes of the Accounting-Request ON message. + +**Table 5: The attributes of the Accounting-Request ON message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------------------------------------------------------------------------------------------------------------------------------------|-------------------|----------------------------------------------------------------------|--------------------------------|------------------------------| +| 4 | NAS-IP-Address | IPv4 address of the GGSN/P-GW for communication with the AAA server. | IPv4 | Conditional
Notes 1 and 2 | +| 95 | NAS-IPv6-Address | IPv6 address of the GGSN/P-GW for communication with the AAA server. | IPv6 | Conditional
Notes 1 and 2 | +| 30 | Called-Station-ID | Identifier for the target network. | APN (UTF-8 encoded characters) | Optional | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional
Note 1 | +| 40 | Acct-Status-Type | Type of accounting message | Accounting-On | Mandatory | +| NOTE 1: Either NAS-IP-Address or NAS-Identifier shall be present.
NOTE 2: Either IPv4 or IPv6 address attribute shall be present. | | | | | + +### 16.4.6 Accounting Request OFF (optionally sent from GGSN/P-GW to AAA server) + +Table 6 describes the attributes of the Accounting-Request OFF message. + +**Table 6: The attributes of the Accounting-Request OFF message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-------------------|--------------------------------------------------------------------|--------------------------------|------------------------------| +| 4 | NAS-IP-Address | IP address of the GGSN/P-GW for communication with the AAA server. | IPv4 | Conditional
Notes 1 and 2 | +| 95 | NAS-IPv6-Address | IP address of the GGSN/P-GW for communication with the AAA server. | IPv6 | Conditional
Notes 1 and 2 | +| 30 | Called-Station-ID | Identifier for the target network. | APN (UTF-8 encoded characters) | Optional | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional
Note 1 | +| 40 | Acct-Status-Type | Type of accounting message | Accounting-Off | Mandatory | + +NOTE 1: Either NAS-IP-Address or NAS-Identifier shall be present. +NOTE 2: Either IPv4 or IPv6 address attribute shall be present. + +## 16.4.7 Sub-attributes of the 3GPP Vendor-Specific attribute + +Table 7 describes the sub-attributes of the 3GPP Vendor-Specific attribute of the Access-Request, Access-Accept, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update and Disconnect-Request messages. The applicability of each sub-attribute to Gi and Sgi reference points is also indicated in Table 7. + +### 16.4.7.1 Presence of the 3GPP Vendor-Specific attribute in RADIUS messages. + +**Table 7: List of the 3GPP Vendor-Specific sub-attributes** + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| 1 | 3GPP-IMSI | IMSI for this user | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 2 | 3GPP-Charging-Id | For GGSN, Charging ID for this PDP Context (this together with the GGSN IP Address constitutes a unique identifier for the PDP context).
For P-GW, Charging ID for this IP-CAN bearer (this together with the P-GW IP address constitutes a unique identifier for the IP-CAN bearer). | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 3 | 3GPP-PDP-Type | For GGSN, it indicates the type of PDP context, e.g. IP or PPP. For P-GW, it indicates the PDN Type, e.g. IPv4, IPv6, IPv4v6. | Conditional (mandatory if attribute 7 is present) | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 4 | 3GPP-CG-Address | Charging Gateway IP address | Optional | Access-Request, Accounting-Request START, Accounting- | Gi, Sgi | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| | | | | Request STOP, Accounting-Request Interim-Update | | +| 5 | 3GPP-GPRS-Negotiated-QoS-Profile | For GGSN, it represents the QoS profile for the PDP context.
For P-GW, it represents the QoS profile for the EPS bearer and the authorized APN-AMBR. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi
Sgi | +| 6 | 3GPP-SGSN-Address | For GGSN, it represents the SGSN IPv4 address that is used by the GTP control plane for the handling of control messages.
For P-GW, it represents the IPv4 address of the S-GW, trusted non-3GPP IP access or ePDG that is used on S5/S8, S2a or S2b, or the SGSN IPv4 address for GnGp SGSN accesses to the PGW for the handling of control messages.
The address may be used to identify the PLMN to which the user is attached. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 7 | 3GPP-GGSN-Address | For GGSN, it represents the GGSN IPv4 address that is used by the GTP control plane for the context establishment.
For P-GW, it represents the P-GW IPv4 address that is used on S5/S8, S2a, S2b or S2c control plane for the IP-CAN session establishment.
The address is the same as the GGSN/P-GW IPv4 address used in the CDRs generated by the GGSN/P-GW. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 8 | 3GPP-IMSI-MCC-MNC | MCC and MNC extracted from the user's IMSI (first 5 or 6 digits, as applicable from the presented IMSI). | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 9 | 3GPP-GGSN- MCC-MNC | MCC-MNC of the network the GGSN or the P-GW belongs to. | Optional | Access-Request, Accounting-Request START, | Gi,
Sgi | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| | | | | Accounting-Request STOP, Accounting-Request Interim-Update | | +| 10 | 3GPP-NSAPI | For GGSN, it identifies a particular PDP context for the associated PDN and MSISDN/IMSI from creation to deletion. For P-GW, it identifies the EPS Bearer ID if it is known to the P-GW (i.e. GTP-based S5/S8 is in use). | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 11 | 3GPP-Session-Stop-Indicator | Indicates to the AAA server that the last PDP context or EPS Bearer of a session is released and that the IP-CAN session has been terminated. | Optional | Accounting Request STOP | Gi, Sgi | +| 12 | 3GPP-Selection-Mode | For GGSN it contains the Selection mode for this PDP Context received in the Create PDP Context Request message. For P-GW it contains the Selection mode for this EPS Bearer received in the Create Session Request message. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 13 | 3GPP-Charging-Characteristics | For GGSN, it contains the charging characteristics for this PDP Context received in the Create PDP Context Request Message (only available in R99 and later releases). For P-GW, it contains the charging characteristics for the IP-CAN bearer. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 14 | 3GPP-CG-IPv6-Address | Charging Gateway IPv6 address | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 15 | 3GPP-SGSN-IPv6-Address | For GGSN, it represents the SGSN IPv6 address that is used by the GTP control plane for the handling of control messages. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| | | For P-GW, it represents the IPv6 address of the S-GW, trusted non-3GPP IP access or ePDG that is used on S5/S8, S2a or S2b, or the SGSN IPv6 address for GnGp SGSN accesses to the PGW for the handling of control messages. The address may be used to identify the PLMN to which the user is attached. | | | | +| 16 | 3GPP-GGSN-IPv6-Address | For GGSN, it represents the GGSN IPv6 address that is used by the GTP control plane for the context establishment. For P-GW, it represents the P-GW IPv6 address that is used on S5/S8, S2a, S2b or S2c control plane for the IP-CAN session establishment. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 17 | 3GPP-IPv6-DNS-Servers | List of IPv6 addresses of DNS servers for an APN | Optional | Access-Accept | Gi, Sgi | +| 18 | 3GPP-SGSN-MCC-MNC | For GGSN and PGW connected to a Gn/Gp SGSN, it represents the MCC and MNC extracted from the RAI within the Create PDP Context Request or Update PDP Context Request message. For P-GW in GTP/PMIP S5/S8 it represents the MCC and MNC extracted from the Serving Network. For PGW connected to S2a, it represents the MCC and MNC extracted from the Serving Network. For PGW connected to S2b, it represents the MCC and MNC extracted from the Serving Network. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------|-----------------------------| +| 19 | 3GPP-Teardown-Indicator | Indicate to the GGSN/P-GW that all IP-CAN bearers for this particular user and sharing the same user session need to be deleted. | Optional | Disconnect Request | Gi
Sgi | +| 20 | 3GPP-IMEISV | International Mobile Equipment Id and its Software Version | Optional | Accounting-Request START, Accounting-Request STOP, Access-Request | Gi,
Sgi | +| 21 | 3GPP-RAT-Type | Indicate which Radio Access Technology is currently serving the UE | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 22 | 3GPP-User-Location-Info | Indicate details of where the UE is currently located (e.g. SAI or CGI). | Optional | Accounting-Request START, Access-Request, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 23 | 3GPP-MS-TimeZone | Indicate the offset between universal time and local time in steps of 15 minutes of where the MS/UE currently resides. | Optional | Accounting-Request START, Access-Request, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 24 | 3GPP-CAMEL-Charging-Info | Used to copy any CAMEL Information present in S-CDR(s). | Optional | Accounting-Request START, Access-Request | Gi | +| 25 | 3GPP-Packet-Filter | Packet Filter used for this PDP context or EPS bearer. | Optional | Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 26 | 3GPP-Negotiated-DSCP | DSCP used to mark the IP packets of this PDP context on the Gi interface or EPS Bearer context on the Sgi interface | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi,
Sgi | +| 27 | 3GPP-Allocate-IP-Type | Indicates whether the Access-Request is sent for user authentication only and/or for allocation of an IPv4 address and/or of an IPv6 prefix | Conditional (see subclause 16.4.7.2 for conditions) | Access-Request | Gi,
Sgi | + +| Sub-attr # | Sub-attribute Name | Description | Presence Requirement | Associated attribute (Location of Sub-attr) | Applicable Reference Points | +|------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------|-----------------------------| +| 28 | External-Identifier | A globally unique identifier of a UE used towards external servers instead of IMSI and MSISDN, refer to 3GPP TS 23.682 [100] and 3GPP TS 23.003 [40]. | Optional | Access-Request, Access-Accept, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Gi, Sgi | +| 29 | TWAN-Identifier | Indicates the UE location in a Trusted WLAN Access Network. | Optional | Accounting-Request START, Access-Request, Accounting-Request STOP, Accounting-Request Interim-Update | Sgi | +| 30 | 3GPP-User-Location-Info-Time | Indicate the time at which the UE was last known to be in the location which is reported during bearer deactivation or PDN disconnection procedure. | Optional | Accounting-Request STOP | Gi, Sgi | +| 31 | 3GPP-Secondary-RAT-Usage | Indicates the data usage in the secondary RAT. | Optional | Accounting-Request STOP, Accounting-Request Interim-Update | Sgi | +| 32 | 3GPP-UE-Local-IP-Address | Indicates the UE local IP address in an untrusted WLAN Access Network. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Sgi | +| 33 | 3GPP-UE-Source-Port | Indicates the UE UDP or TCP source port number. | Optional | Access-Request, Accounting-Request START, Accounting-Request STOP, Accounting-Request Interim-Update | Sgi | + +The information represented by some of the Sgi sub-attributes may not be available to the P-GW depending on the UE's radio access and the S5/S8 protocol type (GTP or PMIP). For example, the P-GW will be aware of the User Location Info (e.g. TAI) if the user is in LTE access and GTP based S5/S8 is used. However, such information is not passed to the P-GW when PMIP based S5/S8 is utilised. In such scenarios, if a sub-attribute is configured in the P-GW to be transferred to the RADIUS AAA server, but the information in the P-GW is not up to date or not available; the P-GW shall not send the corresponding sub-attribute, unless otherwise stated in the following subclause where the encoding of each sub-attribute is specified. + +#### 16.4.7.2 Coding 3GPP Vendor-Specific RADIUS attributes + +In this subclause the provisions of IETF RFC 2865 [38] apply, which in particular specify the following: + +- the Length field of an attribute is one octet, and it indicates the length of this Attribute including the Type, Length and Value fields. + +- type String may be 1-253 octets long and it contains binary data (values 0 through 255 decimal, inclusive). Strings of length zero (0) shall not be sent, but the entire attribute shall be omitted. A NULL terminating character shall not be appended to an attribute of type String. +- type Text may be 1-253 octets long and it contains UTF-8 encoded characters. Text of length zero (0) shall not be sent, but the entire attribute shall be omitted. A NULL terminating character shall not be appended to an attribute of type Text. +- type Address is 32 bit value and most significant octet is the first one. +- type Integer is 32 bit unsigned value and most significant octet is the first one. + +The RADIUS vendor Attribute is encoded as follows (as per IETF RFC 2865 [38]) + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 26 | | | | | | | | +| 2 | Length = n | | | | | | | | +| 3 | Vendor id octet 1 | | | | | | | | +| 4 | Vendor id octet 2 | | | | | | | | +| 5 | Vendor id octet 3 | | | | | | | | +| 6 | Vendor id octet 4 | | | | | | | | +| 7-n | String | | | | | | | | + +$n \geq 7$ + +3GPP Vendor Id = 10415 + +The string part is encoded as follows: + +| Octets | Bits | | | | | | | | +|--------|-----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = | | | | | | | | +| 2 | 3GPP Length = m | | | | | | | | +| 3-m | 3GPP value | | | | | | | | + +$m \geq 2$ and $m \leq 248$ + +The 3GPP specific attributes encoding is clarified below. + +NOTE 1: Unless otherwise stated, the encoding of the value field of a 3GPP vendor-specific attribute is identical for Gi and Sgi. + +## 1 – 3GPP-IMSI + +| Octets | Bits | | | | | | | | +|--------|--------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 1 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | IMSI digits 1-n (UTF-8 encoded characters) | | | | | | | | + +3GPP Type: 1 + +$n \leq 15$ + +Length: $m \leq 17$ + +IMSI value: Text type: + +A GGSN (or a P-GW) receives IMSI that is encoded according to 3GPP TS 29.060 [24] (or 3GPP TS 29.274 [81]) and converts IMSI into the UTF-8 characters, which are encoded as defined in 3GPP TS 23.003 [40]. There shall be no padding characters between the MCC and MNC, and between the MNC and MSIN. If the IMSI is less than 15 digits, the padding in the GTP information element shall be removed by the GGSN (or the P-GW) and not encoded in this sub-attribute. + +## 2 – 3GPP-Charging ID + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 2 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3 | Charging ID value Octet 1 | | | | | | | | +| 4 | Charging ID value Octet 2 | | | | | | | | +| 5 | Charging ID value Octet 3 | | | | | | | | +| 6 | Charging ID value Octet 4 | | | | | | | | + +3GPP Type: 2 + +Length: 6 + +Charging ID value: 32 bits unsigned integer + +## 3 – 3GPP-PDP type + +| Octets | Bits | | | | | | | | +|--------|------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 3 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3 | PDP type octet 1 | | | | | | | | +| 4 | PDP type octet 2 | | | | | | | | +| 5 | PDP type octet 3 | | | | | | | | +| 6 | PDP type octet 4 | | | | | | | | + +3GPP Type: 3 + +Length: 6 + +PDP type value: Unsigned 32 bits integer type + +PDP type may have the following values: + +- 0 = IPv4 +- 1 = PPP +- 2 = IPv6 +- 3 = IPv4v6 +- 4 = Non-IP +- 5 = Unstructured +- 6 = Ethernet + +For P-GW, this sub-attribute represents PDN Type and therefore only the values "0", "2", "3" and "4" are applicable. + +The value 5 Unstructured and 6 Ethernet of PDP type does not apply for the present specification. For specifications referencing the present RADIUS VSA, those values shall only apply if it is explicitly endorsed within the referencing specification. + +#### 4 – 3GPP-Charging Gateway address + +| Octets | Bits | | | | | | | | +|--------|--------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 4 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3 | Charging GW addr Octet 1 | | | | | | | | +| 4 | Charging GW addr Octet 2 | | | | | | | | +| 5 | Charging GW addr Octet 3 | | | | | | | | +| 6 | Charging GW addr Octet 4 | | | | | | | | + +3GPP Type: 4 + +Length: 6 + +Charging GW address value: Address type. + +#### 5 – 3GPP-GPRS Negotiated QoS profile + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 5 | | | | | | | | +| 2 | 3GPP Length= L | | | | | | | | +| 3 – L | UTF-8 encoded QoS profile | | | | | | | | + +3GPP Type: 5 + +Length: For GGSN, $L \leq 37$ (release 7 or higher) or $L \leq 33$ (release 6 or release 5) or $L \leq 27$ (release 4 or release 99) or $L = 11$ (release 98). For P-GW, the length varies depending on the value of QCI. See below for details. + +QoS profile value: Text type + +UTF-8 encoded QoS profile syntax: + +" – " + + = UTF-8 encoded number (two characters) : + +For GGSN: + +"98" = Release 98 + +"99"= Release 99 or release 4 + +"05"= Release 5 or release 6 + +"07"= Release 7 or higher + +For P-GW: + +"08"= Release 8 or higher + +For SMF: + +"15"= Release 15 or higher + + = UTF-8 encoded QoS profile for the release indicated by the release indicator. + +The UTF-8 encoding of a QoS IE is defined as follows: each octet is described by 2 UTF-8 encoded characters, defining its hexadecimal representation. + +For GGSN: + +The QoS profile definition is in 3GPP TS 24.008 [54]. + +The release 98 QoS profile data is 3 octets long, which then results in a 6 octets UTF-8 encoded string. + +The release 99 and release 4 QoS profile data is 11 octets long, which results in a 22 octets UTF-8 encoded string. + +The release 5 and release 6 QoS profile data is 14 octets long, which results in a 28 octets UTF-8 encoded string. + +The release 7 (and higher) QoS profile data is 16 octets long, which results in a 32 octets UTF-8 encoded string. + +For P-GW: + +It contains the following QoS parameters associated with the EPS bearer: + +- QCI +- ARP +- GBR QoS information (UL/DL MBR, UL/DL GBR) or UL/DL APN-AMBR. In other words if the value of QCI indicates a GBR bearer, the GBR QoS information shall be present. If the value of QCI indicates a non-GBR bearer, the APN-AMBR information shall be present. + +The encoding of the EPS bearer QoS profile parameters is specified in 3GPP TS 29.274 [81]: ARP is specified in Bearer QoS IE; QCI, UL MBR, DL MBR, UL GBR and DL GBR are specified in Flow QoS IE; UL APN-AMBR and DL APN-AMBR are specified in AMBR IE. + +For GBR QCIs, the encoding of UTF-8 encoded QoS Profile field shall be as follows: + +| | | +|---------|---------------------------------------------| +| 1-2 | = " 08" (UTF-8 encoded) | +| 3 | "_" (UTF-8 encoded) | +| 4-5 | ARP (UTF-8 encoded) | +| 6-7 | QCI (UTF-8 encoded) | +| 8-m | UL MBR (UTF-8 encoded) | +| (m+1)-n | DL MBR (UTF-8 encoded) | +| (n+1)-o | UL GBR (UTF-8 encoded) | +| (o+1)-p | DL GBR (UTF-8 encoded) | + +For non-GBR QCIs, the UL/DL MBR and UL/DL GBR fields shall not be present; UL APN-AMBR and DL APN-AMBR fields shall be encoded (in UTF-8 encoded format) respectively after the QCI field. + +For SMF: + +It contains the following QoS parameters associated with the QoS flow: + +- 5QI +- ARP +- GBR QoS information (UL/DL MFBR, UL/DL GFBR) or UL/DL Session-AMBR. In other words if the value of 5QI indicates a GBR QoS flow, the GBR QoS information shall be present. If the value of 5QI indicates a non-GBR QoS flow, the Session-AMBR information shall be present. + +5QI value range is 0-255. ARP shall be encoded as Allocation/Retention Priority IE defined in 3GPP TS 29.274 [81]. The UTF-8 encoded UL/DL MFBR, UL/DL GFBR and UL/DL Session-AMBR has the following pattern: + +'^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)\$' + +Examples: + +"125 Mbps", "0.125 Gbps", "125000 Kbps" + +For GBR 5QIs, the encoding of UTF-8 encoded QoS Profile field shall be as follows: + +| | | +|-------------|--------------------------------------------| +| 1-2 | = "15" (UTF-8 encoded) | +| 3 | "-" (UTF-8 encoded) | +| 4-5 | ARP (UTF-8 encoded) | +| 6-7 | 5QI (UTF-8 encoded) | +| 8-9 | UL MFBR length (UTF-8 encoded) | +| 10-m | UL MFBR (UTF-8 encoded) | +| (m+1)-(m+2) | DL MFBR length (UTF-8 encoded) | +| (m+3)-n | DL MFBR (UTF-8 encoded) | +| (n+1)-(n+2) | UL GFBR length (UTF-8 encoded) | +| (n+3)-o | UL GFBR (UTF-8 encoded) | +| (o+1)-(o+2) | UL GFBR length (UTF-8 encoded) | +| (o+3)-p | DL GFBR (UTF-8 encoded) | + +For non-GBR 5QIs, the encoding of UTF-8 encoded QoS Profile field shall be as follows: + +| | | +|-------------|---------------------------------------------| +| 1-2 | - = "15" (UTF-8 encoded) | +| 3 | "-" (UTF-8 encoded) | +| 4-5 | ARP (UTF-8 encoded) | +| 6-7 | 5QI (UTF-8 encoded) | +| 8-9 | UL Session-AMBR length (UTF-8 encoded) | +| 10-m | UL Session-AMBR (UTF-8 encoded) | +| (m+1)-(m+2) | DL Session-AMBR length (UTF-8 encoded) | +| (m+3)-n | DL Session-AMBR (UTF-8 encoded) | + +The above structures for encoding the QoS profile of Release indicator "15" do not apply for the present specification. For specifications referencing the present VSA, those formats shall only apply if it is explicitly endorsed within the referencing specification. + +## 6 – 3GPP-SGSN address + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 6 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3 | SGSN addr Octet 1 | | | | | | | | +| 4 | SGSN addr Octet 2 | | | | | | | | +| 5 | SGSN addr Octet 3 | | | | | | | | +| 6 | SGSN addr Octet 4 | | | | | | | | + +3GPP Type: 6 + +Length: 6 + +SGSN address value: Address type. + +## 7 – 3GPP-GGSN address + +| Octets | Bits | | | | | | | | +|--------|-------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 7 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3 | GGSN addr Octet 1 | | | | | | | | +| 4 | GGSN addr Octet 2 | | | | | | | | +| 5 | GGSN addr Octet 3 | | | | | | | | +| 6 | GGSN addr Octet 4 | | | | | | | | + +3GPP Type: 7 + +Length: 6 + +GGSN address value: Address type. + +## 8 – 3GPP-IMSI MCC-MNC + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 8 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3 | MCC digit1 (UTF-8 encoded character) | | | | | | | | +| 4 | MCC digit2 (UTF-8 encoded character) | | | | | | | | +| 5 | MCC digit3 (UTF-8 encoded character) | | | | | | | | +| 6 | MNC digit1 (UTF-8 encoded character) | | | | | | | | +| 7 | MNC digit2 (UTF-8 encoded character) | | | | | | | | +| 8 | MNC digit3 if present (UTF-8 encoded character) | | | | | | | | + +3GPP Type: 8 + +Length: n shall be 7 or 8 octets depending on the presence of MNC digit 3 + +IMSI MCC-MNC address value: Text type. + +This is the UTF-8 encoded characters representing the IMSI MCC-MNC numerical values. In accordance with 3GPP TS 29.060 [24] (for GGSN), 3GPP TS 29.274 [81] (for P-GW) and 3GPP TS 23.003 [40], the MCC shall be 3 digits and the MNC shall be either 2 or 3 digits. There shall be no padding characters between the MCC and MNC. + +## 9 – 3GPP-GGSN MCC-MNC + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 9 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3 | MCC digit1 (UTF-8 encoded character) | | | | | | | | +| 4 | MCC digit2 (UTF-8 encoded character) | | | | | | | | +| 5 | MCC digit3 (UTF-8 encoded character) | | | | | | | | +| 6 | MNC digit1 (UTF-8 encoded character) | | | | | | | | +| 7 | MNC digit2 (UTF-8 encoded character) | | | | | | | | +| 8 | MNC digit3 if present (UTF-8 encoded character) | | | | | | | | + +3GPP Type: 9 + +Length: n shall be 7 or 8 octets depending on the presence of MNC digit 3 + +GGSN address value: Text type. + +This is the UTF-8 encoding of the GGSN MCC-MNC values. In accordance with 3GPP TS 23.003 [40] and 3GPP TS 29.060 [24] the MCC shall be 3 digits and the MNC shall be either 2 or 3 digits. There shall be no padding characters between the MCC and MNC. + +### 10 – 3GPP-NSAPI + +| Octets | Bits | | | | | | | | +|--------|---------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 10 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | NSAPI (UTF-8 encoded character) | | | | | | | | + +3GPP Type: 10 + +Length: 3 + +NSAPI value: Text Type. + +It is the value of the NSAPI of the PDP context the RADIUS message is related to. It is encoded as its hexadecimal representation, using one UTF-8 encoded character. The GGSN should receive NSAPI values in the following hexadecimal range 05 – 0F. The GGSN shall discard digit 0 and convert the remaining digit into one UTF-8 coded character. + +For P-GW, the value of this sub-attribute represents the EPS Bearer ID as specified in 3GPP TS 29.274 [81]. + +### 11 – 3GPP-Session Stop Indicator + +| Octets | Bits | | | | | | | | +|--------|------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 11 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | 1 1 1 1 1 1 1 1 (bit string) | | | | | | | | + +3GPP Type: 11 + +Length: 3 + +Value is set to all 1. + +3GPP-Session Stop Indicator value: Bit String type. + +### 12 – 3GPP-Selection-Mode + +| Octets | Bits | | | | | | | | +|--------|----------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 12 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | UTF-8 encoded Selection mode character | | | | | | | | + +3GPP Type: 12 + +Length: 3 + +Selection mode value: Text type. + +The format of this sub-attribute shall be a character that represents a single digit, mapping from the binary value of the selection mode in the Create PDP Context message (3GPP TS 29.060 [24]) for the GGSN, and the Create Session Request message (3GPP TS 29.274 [81]) for the P-GW. Where 3GPP TS 29.060 [24] provides for interpretation of the value, e.g. map '3' to '2', this shall be done by the GGSN. + +### 13 – 3GPP-Charging-Characteristics + +| Octets | Bits | | | | | | | | +|--------|----------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 13 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3-6 | UTF-8 encoded Charging Characteristics value | | | | | | | | + +3GPP Type: 13 + +Length: 6 + +Charging characteristics value: Text type. + +The charging characteristics is value of the 2 octets. The value field is taken from the GTP IE described in 3GPP TS 29.060 [24], subclause 7.7.23 for the GGSN and 3GPP TS 29.274 [81] for the P-GW. + +Each octet of this IE field value is represented via 2 UTF-8 encoded character, defining its hexadecimal representation. + +### 14 – 3GPP-Charging Gateway IPv6 address + +| Octets | Bits | | | | | | | | +|--------|----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 14 | | | | | | | | +| 2 | 3GPP Length= 18 | | | | | | | | +| 3 | Charging GW IPv6 addr Octet 1 | | | | | | | | +| 4 | Charging GW IPv6 addr Octet 2 | | | | | | | | +| 5-18 | Charging GW IPv6 addr Octet 3-16 | | | | | | | | + +3GPP Type: 14 + +Length: 18 + +Charging GW IPv6 address value: IPv6 Address. + +Charging GW IPv6 address is Octet String type. + +### 15 – 3GPP-SGSN IPv6 address + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 15 | | | | | | | | +| 2 | 3GPP Length= 18 | | | | | | | | +| 3 | SGSN IPv6 addr Octet 1 | | | | | | | | +| 4 | SGSN IPv6 addr Octet 2 | | | | | | | | +| 5-18 | SGSN IPv6 addr Octet 3-16 | | | | | | | | + +3GPP Type: 15 + +Length: 18 + +SGSN IPv6 address value: IPv6 Address. + +SGSN IPv6 address is Octet String type. + +### 16 – 3GPP-GGSN IPv6 address + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 16 | | | | | | | | +| 2 | 3GPP Length= 18 | | | | | | | | +| 3 | GGSN IPv6 addr Octet 1 | | | | | | | | +| 4 | GGSN IPv6 addr Octet 2 | | | | | | | | +| 5-18 | GGSN IPv6 addr Octet 3-16 | | | | | | | | + +3GPP Type: 16 + +Length: 18 + +GGSN IPv6 address value: IPv6 Address. + +SGSN IPv6 address is Octet String type. + +### 17 – 3GPP-IPv6-DNS-Servers + +| Octets | Bits | | | | | | | | +|--------|---------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 17 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-18 | (1 st ) DNS IPv6 addr Octet 1-16 | | | | | | | | +| 19-34 | (2 nd ) DNS IPv6 addr Octet 1-16 | | | | | | | | +| k-m | (n-th) DNS IPv6 addr Octet 1-16 | | | | | | | | + +3GPP Type: 17 + +Length: $m = n \times 16 + 2$ ; $n \geq 1$ and $n \leq 15$ ; $k = m-15$ + +IPv6 DNS Server value: IPv6 Address. + +IPv6 DNS Server address is Octet String type. + +The 3GPP- IPv6-DNS-Servers sub-attribute provides a list of one or more ('n') IPv6 addresses of Domain Name Server (DNS) servers for an APN. The DNS servers are listed in the order of preference for use by a client resolver, i.e. the first is 'Primary DNS Server', the second is 'Secondary DNS Server' etc. The sub-attribute may be included in Access-Accept packets. + +### 18 – 3GPP-SGSN MCC-MNC + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 18 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3 | MCC digit1 (UTF-8 encoded character) | | | | | | | | +| 4 | MCC digit2 (UTF-8 encoded character) | | | | | | | | +| 5 | MCC digit3 (UTF-8 encoded character) | | | | | | | | +| 6 | MNC digit1 (UTF-8 encoded character) | | | | | | | | +| 7 | MNC digit2 (UTF-8 encoded character) | | | | | | | | +| 8 | MNC digit3 if present (UTF-8 encoded character) | | | | | | | | + +3GPP Type: 18 + +Length: n shall be 7 or 8 octets depending on the presence of MNC digit 3 + +SGSN MCC-MNC address value: Text type. + +This is the UTF-8 encoding of the MCC-MNC values extracted from the RAI or from the Serving Network. In accordance with 3GPP TS 23.003 [40] and 3GPP TS 29.060 [24] (for the GGSN and P-GW connected to a Gn/Gp SGSN) and 3GPP TS 29.274 [81] (for the P-GW in GTP/PMIP S5/S8, S2a, S2b), the MCC shall be 3 digits and the MNC shall be either 2 or 3 digits. There shall be no padding characters between the MCC and MNC. + +## 19 – 3GPP-Teardown Indicator + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|---|---|---|----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 19 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | spare | | | | | | | TI | + +3GPP Type: 19 + +Length: 3 + +Octet 3 is Octet String type. + +For GGSN, if the value of TI is set to "1", then all PDP contexts that share the same user session with the PDP context identified by the Acct-Session-Id shall be torn down. Only the PDP context identified by the Acct-Session-Id shall be torn down if the value of TI is "0" (see subclause 16.3.4 "AAA-Initiated PDP context termination"), or if TI is missing. + +For P-GW, the usage of Teardown-Indicator is as follows (see subclause 16.3a.3 for more details): + +- if the value of TI is set to "1", then all IP-CAN bearers that share the same user session with the IP-CAN bearer identified by the Acct-Session-Id shall be torn down. +- if the value of TI is "0", or if TI is missing, only the IP-CAN bearer identified by the Acct-Session-Id shall be torn down. If the Acct-Session-Id identifies the default bearer, the P-GW shall tear down all the IP-CAN bearers that share the same user session identified by the Acct-Session-Id. + +## 20 -3GGP- IMEISV + +| Bits | | | | | | | | | +|-----------|--------------------------------------------------|---|---|---|---|---|---|---| +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP Type = 20 | | | | | | | | +| 2 | 3GPP Length = 2+n | | | | | | | | +| 3 – (2+n) | IMEI(SV) digits 1 – n (UTF-8 encoded characters) | | | | | | | | + +3GPP Type: 20 + +IMEISV value: Text type. + +A GGSN receives IMEI(SV) that is encoded according to 3GPP TS 29.060 [24]. A P-GW receives IMEI(SV) that is encoded in *ME Identity* IE specified in 3GPP TS 29.274 [81]. The GGSN or the P-GW converts IMEI(SV) into a sequence of UTF-8 characters. IMEI(SV) shall be encoded as defined in 3GPP TS 23.003 [40]. + +$14 \leq n \leq 16$ + +n = 16 for IMEISV, where TAC = 8 digits SNR = 6 digits & SVN = 2 digits; + +n = 15 for IMEI, where TAC = 8 digits SNR = 6 digits & Spare = 1 digit; + +n = 14 for IMEI, where TAC = 8 digits SNR = 6 digits (Spare digit is not sent) + +## 21 – 3GPP-RAT-Type + +| Octets | Bits | | | | | | | | +|--------|--------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 21 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | RAT (octet string) | | | | | | | | + +3GPP Type: 21 + +The 3GPP-RAT-Type sub-attribute indicates which Radio Access Technology is currently serving the UE. + +RAT field: Radio Access Technology type values. RAT field is Octet String type. For GGSN, it shall be coded as specified in 3GPP TS 29.060 [24]. For P-GW, it shall be coded as follows: + +| | | +|---------|-------------------------------------| +| 0-9 | As specified in 3GPP TS 29.274 [81] | +| 10-50 | Spare for future use | +| 51 | NR | +| 52 | NR in unlicensed bands | +| 53 | Trusted WLAN | +| 54 | Trusted Non-3GPP access | +| 55 | Wireline access | +| 56 | Wireline Cable access | +| 57 | Wireline BBF access | +| 58 | NR RedCap | +| 59-100 | Spare for future use | +| 101 | IEEE 802.16e | +| 102 | 3GPP2 eHRPD | +| 103 | 3GPP2 HRPD | +| 104 | 3GPP2 1xRTT | +| 105 | 3GPP2 UMB | +| 106-255 | Spare for future use | + +The value 51-58 does not apply for the present specification. For specifications referencing the present RADIUS VSA, the value shall only apply if it is explicitly endorsed within the referencing specification. + +## 22 – 3GPP-User-Location-Info + +| Octets | Bits | | | | | | | | +|--------|------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 22 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3 | Geographic Location Type | | | | | | | | +| 4-m | Geographic Location (octet string) | | | | | | | | + +3GPP Type: 22 + +Length=m, where m depends on the Geographic Location Type + +For example, m= 10 in the CGI and SAI types. + +Geographic Location Type field is used to convey what type of location information is present in the ‘Geographic Location’ field. For GGSN, the Geographic Location Type values and coding are as defined in 3GPP TS 29.060 [24]. For P-GW, the Geographic Location Type values and coding are defined as follows: + +| | | +|-------|----------------------| +| 0 | CGI | +| 1 | SAI | +| 2 | RAI | +| 3-127 | Spare for future use | +| 128 | TAI | + +| | | +|---------|----------------------------| +| 129 | ECGI | +| 130 | TAI and ECGI | +| 131 | eNodeB ID | +| 132 | TAI and eNodeB ID | +| 133 | extended eNodeB ID | +| 134 | TAI and extended eNodeB ID | +| 135 | NCGI | +| 136 | 5GS TAI | +| 137 | 5GS TAI and NCGI | +| 138 | NG-RAN Node ID | +| 139 | 5GS TAI and NG-RAN Node ID | +| 140-255 | Spare for future use | + +Geographic Location field is used to convey the actual geographic information as indicated in the Geographic Location Type. For GGSN, the coding of this field is as specified in 3GPP TS 29.060 [24]. For P-GW, the coding of this field shall be as follows: + +- If the Geographic Location Type has a value indicating CGI, SAI, RAI, TAI or ECGI (i.e. the value field is equal to 0, 1, 2, 128, or 129), the coding of the Geographic Location field shall be as per clauses 8.21.1 to 8.21.5, respectively, in 3GPP TS 29.274 [81], +- If the Geographic Location Type has a value indicating TAI and ECGI (i.e. the value field is equal to 130), in Geographic Location field both TAI and ECGI shall be encoded one after another as per clauses 8.21.4 and 8.21.5 in 3GPP TS 29.274 [81]. TAI information shall be encoded first starting with Octet 4 of 3GPP-User-Location-Info. +- If the Geographic Location Type has a value indicating eNodeB ID (i.e. the value field is equal to 131), the coding of the Geographic Location field shall be as defined in subclause 8.21.7 in 3GPP TS 29.274 [81]. +- If the Geographic Location Type has a value indicating TAI and eNodeB ID (i.e. the value field is equal to 132), in Geographic Location field both TAI and eNodeB ID shall be encoded one after another as per subclauses 8.21.4 and 8.21.7 in 3GPP TS 29.274 [81]. +- If the Geographic Location Type has a value indicating extended eNodeB ID (i.e. the value field is equal to 133), the coding of the Geographic Location field shall be as defined in subclause 8.21.8 in 3GPP TS 29.274 [81]. +- If the Geographic Location Type has a value indicating TAI and extended eNodeB ID (i.e. the value field is equal to 134), in Geographic Location field both TAI and extended eNodeB ID shall be encoded one after another as per subclauses 8.21.4 and 8.21.8 in 3GPP TS 29.274 [81]. + +NOTE 1: The Geographic Location Type values "TAI and ECGI" is used only in 5GC-EPC interworking e.g in 3GPP TS 29.214 [121]. + +The Geographic Location Type values "NCGI", "5GS TAI", "5GS TAI and NCGI", "NG-RAN Node ID" and "5GS TAI and NG-RAN Node ID" are only introduced to extend the 3GPP-User-Location-Info AVP derived from the 3GPP Vendor-Specific RADIUS attributes and shall not apply for the present specification. For specifications referencing the present data type, those values shall only apply if they are explicitly endorsed within the referencing specification. For those values, the Geographic Location field shall be coded as follows: + +NOTE 2: The Geographic Location Type values "NCGI", "NG-RAN Node ID" and "5GS TAI and NG-RAN Node ID" are not used in 5G till current releases, while the value "5GS TAI and NCGI" is used only in 5GC e.g in 3GPP TS 29.214 [121]. + +- If the Geographic Location Type has a value indicating NCGI (i.e. the value field is equal to 135), the coding of the Geographic Location field shall be as per subclause 9.3.1.7 in 3GPP TS 38.413 [115]. Spare bits shall be placed just after the PLMN Identity and shall be set to zero. +- If the Geographic Location Type has a value indicating 5GS TAI (i.e. the value field is equal to 136), the coding of the Geographic Location field shall be as per subclause 9.3.3.11 in 3GPP TS 38.413 [115]. +- If the Geographic Location Type has a value indicating 5GS TAI and NCGI (i.e. the value field is equal to 137), in Geographic Location field both 5GS TAI and NCGI shall be encoded one after another as per subclause 9.3.3.11 in 3GPP TS 38.413 [115] and per subclause 9.3.1.7 in 3GPP TS 38.413 [115]. Spare bits for the NCGI shall be placed just after the PLMN Identity and shall be set to zero. + +- If the Geographic Location Type has a value indicating NG-RAN Node ID (i.e. the value field is equal to 138), the first octet of the Geographic Location field shall be length of the NG-RAN Node ID in unit of bit, and it also indicates the type of NG-RAN node as follows: + +1. length value = 18, short ng-eNodeB ID +2. length value = 20, ng-eNodeB ID +3. length value = 21, long ng-eNodeB ID +4. length value = 22-32, gNodeB ID + +Starting from the second octet of the Geographic Location field, the coding shall be as per subclause 9.3.1.5 in 3GPP TS 38.413 [115], i.e. first PLMN information then NG-RAN Node ID. Spare bits shall be set to zero. + +- If the Geographic Location Type has a value indicating 5GS TAI and NG-RAN Node ID (i.e. the value field is equal to 139), in Geographic Location field both 5GS TAI and NG-RAN Node ID shall be encoded one after another as per subclause 9.3.3.11 in 3GPP TS 38.413 [115] and as described for NG-RAN Node ID (i.e. the value field is equal to 138). Spare bits shall be set to zero. + +Geographic Location Type and Geographic Location fields are Octet String type. + +### 23 – 3GPP-MS-TimeZone + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 23 | | | | | | | | +| 2 | 3GPP Length= 4 | | | | | | | | +| 3 | Time Zone | | | | | | | | +| 4 | Daylight Saving Time (octet string) | | | | | | | | + +3GPP Type: 23 + +Length=4 + +The Time Zone field and the Daylight Saving Time fields are used to indicate the offset between universal time and local time in steps of 15 minutes of where the MS/UE currently resides. + +For GGSN, both fields are coded as specified in 3GPP TS 29.060 [24] and represented as Octet String type. For, P-GW, both fields are coded as specified in 3GPP TS 29.274 [81] in UE-Time Zone IE and represented as Octet String type. + +### 24 – 3GPP-Camel-Charging-Info + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 24 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | CAMEL Charging Information Container (octet string) | | | | | | | | + +3GPP Type: 24 + +Length=m + +m depends on the size of the CAMELInformationPDP IE. + +The CAMEL Charging Information Container field is used to copy the CAMELInformationPDP IE including Tag and Length from the SGSN's CDR (S-CDR). + +The coding of this field is as specified in 3GPP TS 29.060 [24] and represented as Octet String type. + +## 25 – 3GPP-Packet-Filter + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 25 | | | | | | | | +| 2 | 3GPP Length= n | | | | | | | | +| 3-z | Packet Filter | | | | | | | | + +3GPP Type: 25 + +Length: n + +Each 3GPP-Packet-Filter sub-attribute contains only one packet filter. Multiple 3GPP-Packet-Filter sub-attributes can be sent in one RADIUS Accounting Request message. + +When the GGSN/P-GW sends the packet filter information, the RADIUS message shall carry ALL (or none) of the packet filters. + +Packet Filter Value: + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------------------------------|---|---|---|---|---|---|---|---------| +| Packet filter identifier | | | | | | | | Octet 1 | +| Packet filter evaluation precedence | | | | | | | | Octet 2 | +| Length of Packet filter contents | | | | | | | | Octet 3 | +| Direction of Packet Filter | | | | | | | | Octet 4 | +| Packet filter contents | | | | | | | | Octet 5 | +| | | | | | | | | Octet m | + +Direction Value: + +00000000: Downlink + +00000001: Uplink + +00000010: Bidirectional + +The packet filter content is represented as Octet String type. The packet filter content is defined below: + +| Type | Value | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1: IPv4 address type |

Contains the source address if the direction value is set to Downlink, and the destination address if the direction value is set to Uplink.

Shall be encoded as a sequence of a four octet IPv4 address field and a four octet IPv4 address mask field. The IPv4 address field shall be transmitted first

| +| 2: IPv6 address type |

Contains the source address if the direction value is set to Downlink, and the destination address if the direction value is set to Uplink.

Shall be encoded as a sequence of a sixteen octet IPv6 address field and a sixteen octet IPv6 address mask field. The IPv6 address field shall be transmitted first

| +| 3: Protocol identifier/Next header type | shall be encoded as one octet which specifies the IPv4 protocol identifier or IPv6 next header | + +| | | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4 : Single destination port type | shall be encoded as two octet which specifies a port number | +| 5 : Destination port range type | shall be encoded as a sequence of a two octet port range low limit field and a two octet port range high limit field. The port range low limit field shall be transmitted first | +| 6 : Single source port type | shall be encoded as two octet which specifies a port number | +| 7 : Source port range type | shall be encoded as a sequence of a two octet port range low limit field and a two octet port range high limit field. The port range low limit field shall be transmitted first | +| 8: Security parameter index type (IPv6) | shall be encoded as four octet which specifies the IPSec security parameter index | +| 9: Type of service/Traffic class type | shall be encoded as a sequence of a one octet Type-of-Service/Traffic Class field and a one octet Type-of-Service/Traffic Class mask field. The Type-of-Service/Traffic Class field shall be transmitted first | +| 10: Flow label type (IPv6) | shall be encoded as three octets which specify the IPv6 flow label. The bits 8 through 5 of the first octet shall be spare whereas the remaining 20 bits shall contain the IPv6 flow label | + +NOTE 3: The sending of this sub-attribute is not recommended for an inter-operator interface for security reason. + +## 26 – 3GPP-Negotiated-DSCP + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 26 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | Negotiated DSCP (octet string) | | | | | | | | + +3GPP Type: 26 + +Length: 3 + +Negotiated DSCP value: Octet String + +DSCP value: Octet String type. + +## 27 – 3GPP-Allocate-IP-Type + +| Octets | Bits | | | | | | | | +|--------|------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 27 | | | | | | | | +| 2 | 3GPP Length= 3 | | | | | | | | +| 3 | IP Type (octet string) | | | | | | | | + +3GPP Type: 27 + +If multiple Access-Request signalling towards a AAA server is needed during the lifetime of a PDN connection (e.g. for PDN/PDP type IPv4v6 and deferred IPv4 addressing), this sub-attribute shall be included in the Access-Request message to indicate how the AAA server needs to treat the request. The P-GW/GGSN may also use this sub-attribute if the AAA server is configured to allocate both IPv4 address and IPv6 prefix but the P-GW/GGSN requires assignment of only one IP type or both IP types (e.g. because the UE supports single IP stack and it has requested PDN/PDP type of IPv4 or IPv6). + +If this sub-attribute does not exist in Access-Request from P-GW/GGSN to the AAA server, the IP address allocation shall be based on the IP address allocation policy configured in the the AAA server. + +IP Type field: It is encoded in Octet String type and the following decimal equivalent values apply: + +- 0 Do not allocate IPv4 address or IPv6 prefix. +The typical use case is for PDN/PDP type IPv4v6 and deferred IPv4 addressing and only IPv4 address is allocated by the AAA server but IPv6 prefix is allocated by some other means, e.g. local pool in the P-GW/GGSN. The Access-Request from the P-GW/GGSN to the AAA server during the UE's initial access to the network shall set the value of this sub-attribute to 0. +- 1 Allocate IPv4 address +The typical use case is for PDN/PDP type IPv4v6 and deferred IPv4 addressing and the IPv4 address (and/or IPv6 prefix) is allocated by the AAA server. The Access-Request from the P-GW/GGSN to the AAA server when the P-GW/GGSN receives UE-initiated IPv4 address allocation signalling (e.g. DHCPv4) after UE's successful initial access to the PDN shall set the value of this attribute to 1. In this case, if the AAA server had allocated an IPv6 prefix earlier during UE's initial access to the network, same IPv6 prefix shall be kept allocated. +- 2 Allocate IPv6 prefix +The typical use case is for PDN/PDP type IPv4v6 and deferred IPv4 addressing and both IPv4 address and IPv6 prefix are allocated by the AAA server. The Access-Request from the P-GW/GGSN to the AAA server during the UE's initial access to the network shall set the value of this sub-attribute to 2. +- 3 Allocate IPv4 address and IPv6 prefix +Currently there is no use case identified to use this specific value for PDN/PDP type IPv4v6 and deferred IPv4 addressing. One potential use case is for PDN/PDP type IPv4v6 and non-deferred IPv4 addressing and both IPv4 address and IPv6 prefix are allocated by the AAA server. The Access-Request from the P-GW/GGSN to the AAA server may use this value to have both IPv4 address and IPv6 prefix assigned to the UE. + +4-255 Reserved for future use + +## 28 – External-Identifier + +| Octets | Bits | | | | | | | | +|--------|------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 28 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | Identifier characters 1-n (UTF-8 encoded characters) | | | | | | | | + +3GPP Type: 28 + +n ≤ 72 / 253 (n ≤ 72 octets shall be supported, n ≤ 253 octets recommended, refer to 3GPP TS 29.336 [101] and IETF RFC 4282 [102]) + +Length: m ≤ 74 / 255 (m ≤ 74 octets shall be supported, m ≤ 255 octets recommended, refer to 3GPP TS 29.336 [101] and IETF RFC 4282 [102]) + +External-Identifier value: Text type. + +A globally unique identifier of a UE used towards external server instead of IMSI and MSISDN, refer to 3GPP TS 23.682 [100] and 3GPP TS 23.003 [40]. + +## 29 – TWAN-Identifier + +| Octets | Bits | | | | | | | | +|--------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 29 | | | | | | | | +| 2 | 3GPP Length= m | | | | | | | | +| 3-m | TWAN Identifier (octet string) | | | | | | | | + +3GPP Type: 29 + +Length=m, where m depends on the type of location that is present as described in 3GPP TS 29.274 [81]. + +TWAN Identifier field is used to convey the location information in a Trusted WLAN Access Network (TWAN). The coding of this field shall be the same as for the GTP TWAN Identifier starting with Octet 5, as per clause 8.100 in 3GPP TS 29.274 [81]. + +TWAN Identifier field is Octet String type. + +### 30 – 3GPP-User-Location-Info-Time + +| Octets | Bits | | | | | | | | +|--------|-------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 30 | | | | | | | | +| 2 | 3GPP Length= 6 | | | | | | | | +| 3-6 | User Location Info time | | | | | | | | + +3GPP Type: 30 + +Length=6 + +User Location Info time field is Unsigned32 type, it indicates the NTP time at which the UE was last known to be in the location which is reported during bearer deactivation or UE detach procedure. + +### 31 – 3GPP-Secondary-RAT-Usage + +| Octets | Bits | | | | | | | | | | | +|--------|---------------------|---|---|------|-----|---|---|---|--|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | +| 1 | 3GPP type = 31 | | | | | | | | | | | +| 2 | 3GPP Length= 28 | | | | | | | | | | | +| 3 | spare | | | SESS | RAT | | | | | | | +| 4-7 | RAN Start timestamp | | | | | | | | | | | +| 8-11 | RAN End timestamp | | | | | | | | | | | +| 12-19 | Usage Data DL | | | | | | | | | | | +| 20-28 | Usage Data UL | | | | | | | | | | | + +3GPP Type: 31 + +Length=28 + +Multiple 3GPP-Secondary-RAT-Usage sub-attributes can be sent in one RADIUS Accounting Request Interim-Update/STOP message. + +Octet 3 is Octet String type. The encoding of RAT field (bit 1 to bit 4) is: + +- 0 – NR +- 1 – NR-U +- 2 – EUTRA +- 3 – EUTRA-U + +4 – Unlicensed Spectrum + +5-15 – spare, reserved for future use + +SESS (bit 5): If it is set to 1, it indicates the secondary RAT usage of the PDU session. + +The values 1, 2 and 3 of RAT field and SESS field do not apply for the present specification. For specifications referencing the present RADIUS VSA, they shall only apply if it is explicitly endorsed within the referencing specification. Bit 6 to bit 8 of octet 3 is spare and reserved for future use. + +The encoding of octets 4 to 28 is specified in Secondary RAT Usage Data Report IE of 3GPP TS 29.274 [81]. + +### 32 – 3GPP-UE-Local-IP-Address + +| Octets | Bits | | | | | | | | +|--------|------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 32 | | | | | | | | +| 2 | 3GPP Length= 7 or 19 | | | | | | | | +| 3 | IP Type (octet string) | | | | | | | | +| 4-m | UE local IP address | | | | | | | | + +3GPP Type: 32 + +Length=7 or 19 + +IP Type field: It is encoded in Octet String type and the following decimal equivalent values apply: + +| | | +|---|-----------------------| +| 1 | UE local IPv4 address | +| 2 | UE local IPv6 address | + +UE local IP address field: It is encoded in Octet String type, with 4 octets when the IP Type is UE local IPv4 address, or with 16 octets when the IP Type is UE local IPv6 address. + +### 33 – 3GPP-UE-Source-Port + +| Octets | Bits | | | | | | | | +|--------|---------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP type = 33 | | | | | | | | +| 2 | 3GPP Length= 5 | | | | | | | | +| 3 | Source Port Type (octet string) | | | | | | | | +| 4-5 | Port Number (octet string) | | | | | | | | + +3GPP Type: 33 + +Length=5 + +Source Port Type field: It is encoded in Octet String type and the following decimal equivalent values apply: + +| | | +|---|-----------------| +| 1 | UDP Source Port | +| 2 | TCP Source Port | + +Port Number field: It is encoded in Octet String type, with bit 8 of Octet 4 represents the most significant bit of the port number and bit 1 of Octet 5 represents the least significant bit. + +## 16.4.8 Accounting Request Interim-Update (sent from GGSN/P-GW to AAA server) + +Table 8 describes the attributes of the Accounting-Request Interim-Update message. + +**Table 8: The attributes of the Accounting-Request Interim-Update message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------| +| 1 | User-Name | Username is provided to the GGSN/P-GW by the user in the PCO or for the case of the P-GW when multiple authentications are supported in the APCO received during IP-CAN session establishment procedure. If PPP PDN type is used, it is provided to the GGSN by the user during PPP authentication phase. If no username is available, a generic username, configurable on a per APN basis, shall be present. If the User-Name has been received in the Access-Accept message, this username shall be used in preference to the above. | String | Optional | +| 4 | NAS-IP-Address | IPv4 address of the GGSN/P-GW for communication with the AAA server. | IPv4 | Conditional Notes 1 and 7 | +| 95 | NAS-IPv6-Address | IPv6 address of the GGSN/P-GW for communication with the AAA server. | IPv6 | Conditional Notes 1 and 7 | +| 32 | NAS-Identifier | Hostname of the GGSN/P-GW for communication with the AAA server. | String | Conditional Note 1 | +| 6 | Service-Type | Indicates the type of service for this user | Framed | Optional | +| 7 | Framed Protocol | Indicates the type of protocol for this user | 7 (GPRS PDP Context) | Optional Note 8 | +| 8 | Framed-IP-Address | User IPv4 address | IPv4 | Conditional Note 3 | +| 97 | Framed-IPv6-Prefix | User IPv6 prefix | IPv6 | Conditional Note 3 | +| 123 | Delegated-IPv6-Prefix | Delegated IPv6 prefix to the user | IPv6 | Conditional Note 9 | +| 96 | Framed-Interface-Id | User IPv6 Interface Identifier | IPv6 | Conditional Notes 3 and 4 | +| 25 | Class | Received in the Access-Accept | String | Optional (Note 2) | +| 30 | Called-Station-Id | Identifier for the target network | APN (UTF-8 encoded) | Mandatory | +| 31 | Calling-Station-Id | This attribute is the identifier for the MS, and it shall be configurable on a per APN basis. | MSISDN in international format according to 3GPP TS 23.003 [40], UTF-8 encoded characters. (Note 6) | Optional | +| 40 | Acct-Status-Type | Indicates the type of accounting request | Interim-Update | Mandatory | +| 41 | Acct-Delay-Time | Indicates how many seconds the GGSN/P-GW has been trying to send this record for, and can be subtracted from the time of arrival on the AAA server to find the approximate time of the event generating this Accounting-Request | Second | Optional | +| 42 | Acct-Input-Octets | GGSN/P-GW counted number of octets sent by the user for the IP-CAN bearer | 32 bit unsigned integer | Optional | +| 43 | Acct-Output-Octets | GGSN/P-GW counted number of octets received by the user for the IP-CAN bearer | 32 bit unsigned integer | Optional | +| 44 | Acct-Session-Id | User session identifier. | GGSN/P-GW IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal characters. (Note 5) | Mandatory | + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|----------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------| +| 45 | Acct-Authentic | Authentication method | RADIUS or LOCAL | Optional | +| 46 | Acct-Session-Time | Duration of the session | Second | Optional | +| 47 | Acct-Input-Packets | GGSN/P-GW counted number of packets sent by the user | Packet | Optional (Note 10) | +| 48 | Acct-Output-Packets | GGSN/P-GW counted number of packets received by the user | Packet | Optional (Note 10) | +| 52 | Acct-Input-Gigawords | It indicates how many times the Acct-Input-Octets counter has wrapped around $2^{32}$ and is present if the Acct-Input-Octets counter has wrapped around $2^{32}$ . | 32 bit unsigned integer
See IETF RFC 2869 [116] | Conditional | +| 53 | Acct-Output-Gigawords | It indicates how many times the Acct-Output-Octets counter has wrapped around $2^{32}$ and is present if the Acct-Output-Octets counter has wrapped around $2^{32}$ . | 32 bit unsigned integer
See IETF RFC 2869 [116] | Conditional | +| 61 | NAS-Port-Type | Port type for the GGSN/P-GW | As per RFC 2865 [38] | Optional | +| 26/10415 | 3GPP Vendor-Specific | Sub-attributes according to subclause 16.4.7. | See subclause 16.4.7 | Optional except sub-attribute 3 which is conditional | + +NOTE 1: Either NAS-IP-Address or NAS-Identifier shall be present. +NOTE 2: The presence of this attribute is conditional upon this attribute being received in the Access-Accept message +NOTE 3: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, IPv4 and/or IPv6 address/prefix attributes shall be present. The IP protocol version for end-user and network may be different. +NOTE 4: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. +NOTE 5: The GGSN/P-GW IP address is the same one that is used in the CDRs generated by the GGSN/P-GW. +NOTE 6: There are no leading characters in front of the country code. +NOTE 7: Either IPv4 or IPv6 address attribute shall be present. +NOTE 8: Framed-Protocol value of 7 is used by both GGSN and P-GW when interworking with RADIUS AAA servers. When used for P-GW, it represents the IP-CAN bearer. +NOTE 9: Delegated IPv6 prefix shall be present if IPv6 prefix delegation is required from the external DN-AAA server. +NOTE 10: If the P-GW is split into a user plane node and control plane node according to 3GPP TS 29.244 [114], the user plane function "MNOP" need to be supported. + +### 16.4.9 Disconnect Request (optionally sent from AAA server to GGSN/P-GW) + +Table 9 describes the attributes of the Disconnect-Request message. + +**Table 9: The attributes of the Disconnect-Request message** + +| Attr # | Attribute Name | Description | Content | Presence Requirement | +|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------------------| +| 1 | User-Name | Username provided by the user (extracted from the PCO/APCO field received during PDN connection establishment) or PPP authentication phase (if PPP PDP type is used). If no username is available a generic username, configurable on a per APN basis, shall be present. If the User-Name has been sent in the Access-Accept message, this user-name shall be used in preference to the above | String | Optional | +| 8 | Framed-IP-Address | User IPv4 address | IPv4 | Conditional
Note 2 | + +| | | | | | +|----------|----------------------|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------| +| 97 | Framed-IPv6-Prefix | User IPv6 prefix | IPv6 | Conditional Note 2 | +| 96 | Framed-Interface-Id | User IPv6 Interface Identifier | IPv6 | Conditional Notes 1 and 2 | +| 44 | Acct-Session-Id | User session identifier. | GGSN/P-GW IP address (IPv4 or IPv6) and Charging-ID concatenated in a UTF-8 encoded hexadecimal characters. (Note 3) | Mandatory | +| 26/10415 | 3GPP Vendor-Specific | Sub-attributes according to subclause 16.4.7. | See subclause 16.4.7 | Optional | + +NOTE 1: Included if the prefix alone is not unique for the user. This may be the case, for example, if a static IPv6 address is assigned. + +NOTE 2: If the 3GPP-PDP-Type is IPv4, IPv6, or IPv4v6, either IPv4 or IPv6 address/prefix attribute shall be present. See subclause 16.3.4. + +NOTE 3: The GGSN/P-GW IP address is the same one that is used in the CDRs created by the GGSN/P-GW. + +## 16a Usage of Diameter on Gi/Sgi interface + +As an operator option, it is also possible to use the Diameter protocol in order to provide Authentication, Authorization and Accounting services. + +A GGSN/P-GW may, on a per APN basis, use Diameter authentication to authenticate a user and Diameter accounting to provide information to a Diameter server. + +### 16a.1 Diameter Authentication and Authorization + +Diameter Authentication and Authorization shall be used according to RFC 7155 [120]. + +The GGSN/P-GW and the Diameter server shall advertise the support of the Diameter NASREQ Application by including the value of the appropriate application identifier in the Capability-Exchange-Request and Capability-Exchange-Answer commands as specified in IETF RFC 6733 [111]. + +The Diameter client function may reside in a GGSN/P-GW. When the GGSN/P-GW receives an initial attach (e.g. Create PDP Context) request message the Diameter client function may send the authentication information to an authentication server, which is identified during the APN provisioning. + +The authentication server checks that the user can be accepted. The response (when positive) may contain network information, such as an IPv4 address and/or IPv6 prefix for the user when the GGSN/P-GW is interworking with the AAA server. + +The information delivered during the Diameter authentication can be used to automatically correlate the users identity (the MSISDN or IMSI) to the IPv4 address and/or IPv6 prefix, if applicable, assigned/confirmed by the GGSN/P-GW or the authentication server respectively. The same procedure applies, in case of sending the authentication to a 'proxy' authentication server. + +Diameter Authentication is applicable to the initial access (e.g. primary PDP context or the default bearer). When the GGSN/P-GW receives a positive response from the authentication server it shall complete the initial access (e.g. PDP context activation) procedure. If a failure or no response is received, the GGSN/P-GW shall reject the initial access (e.g. PDP Context Activation) attempt with a suitable cause code, e.g. User Authentication failed. + +The GGSN may also use the Diameter re-authorization procedure for the purpose of IPv4 address allocation to the UE for PDP type of IPv4v6 after establishment of a PDN connection. + +For EPS, the P-GW may also use the Diameter re-authorization procedure for the purpose of IPv4 address allocation to the UE for PDN type of IPv4v6 after establishment of a PDN connection. The use cases that may lead this procedure are: + +- Deferred IPv4 address allocation via DHCPv4 procedure after successful attach on 3GPP accesses. +- Deferred IPv4 address allocation after successful attach in trusted non-3GPP IP access on S2a. +- Deferred IPv4 home address allocation via DSMIPv6 Re-Registration procedure via S2c. + +## 16a.2 Diameter Accounting + +Diameter Accounting shall be used according to RFC 7155 [120]. + +The Diameter accounting client function may reside in a GGSN/P-GW. The Diameter accounting client may send information to an accounting server, which is identified during the APN provisioning. The accounting server may store this information and use it to automatically identify the user. This information can be trusted because the PS access network has authenticated the subscriber (i.e. SIM card and possibly other authentication methods). + +Diameter Accounting messages may be used during both primary and secondary PDP context activation for non-EPC based packet domain (both the default bearer and dedicated bearer for the EPC based packet domain) and deactivation procedures respectively. + +If the AAA server is used for IPv4 address and/or IPv6 prefix assignment, then, upon reception of a Diameter Accounting-Request STOP message for all IP-CAN bearers associated to an IP-CAN session defined by APN and IMSI or MSISDN, the AAA server may make the associated IPv4 address and/or IPv6 prefix available for assignment. + +For PDN/PDP type IPv4v6 and deferred IPv4 address allocation, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending Diameter Accounting-Request Interim-Update with Framed-IP-Address AVP and its value field containing the allocated IPv4 address. Similarly, the release of IPv4 address shall be indicated to the accounting server by sending Diameter Accounting-Request Interim-Update without the Framed-IP-Address AVP. + +## 16a.3 Authentication and accounting message flows on Gi interface + +### 16a.3.1 IP PDP type + +Figure 25a represents the Diameter message flows between a GGSN and a Diameter server. + +![Sequence diagram showing Diameter message flows for IP PDP type activation and deactivation between MT, SGSN, GGSN, Diameter Server, and PDN.](29997432244f81212ee1e6c94f308f1b_img.jpg) + +``` + +sequenceDiagram + participant MT + participant SGSN + participant GGSN + participant DiameterServer as Diameter Server + participant PDN + + Note right of DiameterServer: (Note 2) + + MT->>SGSN: PDP Context Activate Request + SGSN->>GGSN: Create PDP Context Request + GGSN-->>DiameterServer: AA-Request + Note right of DiameterServer: (Note 3) + DiameterServer-->>GGSN: AA-Answer + GGSN->>DiameterServer: Accounting-Request (start) + Note right of DiameterServer: (Note 4) + DiameterServer-->>GGSN: Accounting-Answer (start) + GGSN->>SGSN: Create PDP Context Response + Note left of GGSN: (Note 1) + SGSN->>MT: Activate PDP Context Accept + Note right of GGSN: User Data + MT->>SGSN: Deactivate PDP Context Request + SGSN->>GGSN: Delete PDP Context Request + GGSN->>DiameterServer: Accounting-Request (stop) + DiameterServer-->>GGSN: Accounting-Answer (stop) + GGSN->>SGSN: Delete PDP Context Response + SGSN->>MT: Deactivate PDP Context Accept + +``` + +The diagram illustrates the sequence of messages for IP PDP type activation and deactivation. + **Activation:** The MT sends a 'PDP Context Activate Request' to the SGSN. The SGSN sends a 'Create PDP Context Request' to the GGSN. The GGSN sends an 'AA-Request' to the Diameter Server (Note 3). The Diameter Server responds with an 'AA-Answer'. The GGSN then sends an 'Accounting-Request (start)' (Note 4) to the Diameter Server, which responds with an 'Accounting-Answer (start)'. The GGSN sends a 'Create PDP Context Response' to the SGSN (Note 1), which in turn sends an 'Activate PDP Context Accept' to the MT. User data flow begins between the GGSN and PDN. + **Deactivation:** The MT sends a 'Deactivate PDP Context Request' to the SGSN. The SGSN sends a 'Delete PDP Context Request' to the GGSN. The GGSN sends an 'Accounting-Request (stop)' to the Diameter Server, which responds with an 'Accounting-Answer (stop)'. The GGSN sends a 'Delete PDP Context Response' to the SGSN, which in turn sends a 'Deactivate PDP Context Accept' to the MT. + +Sequence diagram showing Diameter message flows for IP PDP type activation and deactivation between MT, SGSN, GGSN, Diameter Server, and PDN. + +NOTE 1: If some external applications require Diameter Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Answer (START) is received from the Diameter server. The GGSN may wait for the Accounting Answer (START) before sending the CreatePDPContextResponse. The GGSN may reject the PDP context if the Accounting Answer (START) is not received. + +NOTE 2: Separate accounting and authentication servers may be used. + +NOTE 3: The AA-Request message shall be used for primary PDP context only. + +NOTE 4: The Accounting-Request (Start) message may be sent at a later stage, e.g. after IPv4 address has been assigned and PDP Context updated, in case of IP address allocation via DHCPv4 after successful PDP context activation signalling. + +**Figure 25a: Diameter message flow for PDP type IP (successful user authentication case)** + +When a GGSN receives a Create PDP Context Request message for a given APN, the GGSN may (depending on the configuration for this APN) send a Diameter AA-Request to a Diameter server. The Diameter server authenticates and authorizes the user. If Diameter is also responsible for IPv4 address and/or IPv6 prefix allocation the Diameter server + +shall return the allocated IPv4 address and/or IPv6 prefix in the AA-Answer message. The AA-Request and AA-Answer messages are only used for the primary PDP context. + +When PDP type is IPv4v6 and deferred IPv4 addressing via IPv4 address pool in the AAA server is used, the GGSN may initiate Diameter re-authorization procedures after successful initial attach for the purpose of IPv4 address allocation or to renew the lease for a previously allocated IPv4 address. In this case, the GGSN shall set the Session-Id to the value used in the initial access request, the Auth-Request-Type AVP to "AUTHORIZE\_ONLY" and the 3GPP-Allocate-IP-Type AVP to the type of IP address to be allocated in the AA-Request message sent to the AAA server. See subclause 16.4.7.2 for the conditions to use 3GPP-Allocate-IP-Type AVP in AA-Request messages. If the GGSN is using DHCPv4 signalling towards the MS and the Diameter server includes the Session-Timeout attribute in the Access-Accept, the GGSN may use the Session-Timeout value as the DHCP lease time. The GGSN shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The GGSN may renew the DHCP lease to the MS without re-authorization towards the AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the GGSN wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the GGSN was not involved in user authentication (e.g. transparent network access mode), it may send a Diameter Accounting-Request (START) message to a Diameter server. If no Diameter session is already open for the user a Diameter session needs to be activated, otherwise the existing Diameter session is used to send the Accounting-Request (START). The NSAPI will identify the particular PDP context this accounting refers to. The Accounting-Request message also indicates to the Diameter server that the user session has started. This message contains parameters, e.g. the tuple which includes the user-id, IPv4 address and/or IPv6 prefix, and the MSISDN to be used by application servers (e.g. WAP gateway) in order to identify the user. + +If some external applications require Diameter Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Answer (START) is received from the Diameter server. The GGSN may wait for the Accounting Answer (START) before sending the CreatePDPContextResponse. The GGSN may reject the PDP context if the Accounting Answer (START) is not received. The authentication and accounting servers may be separately configured for each APN. + +For PDP type IPv4, at IPv4 address allocation via DHCPv4 signalling between the TE and the PDN, no IPv4 address is available at PDP context activation. In that case the GGSN may wait to send the Accounting-Request (START) message until the TE receives its IP address in a DHCPACK. + +For PDP type IPv4v6 and deferred IPv4 addressing, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending Diameter Accounting-Request Interim-Update with the Framed-IP-Address AVP and its value field containing the allocated IPv4 address. + +When the GGSN receives a Delete PDP Context Request message and providing a Diameter Accounting-Request (START) message was sent previously, the GGSN shall send a Diameter Accounting-Request (STOP) message to the Diameter server, which indicates the termination of this particular user accounting session. The NSAPI will identify the particular PDP context this accounting refers to. The GGSN shall immediately send a Delete PDP context response, without waiting for an Accounting-Answer (STOP) message from the Diameter server. + +If this was the last PDP context for that PDP address, the GGSN shall additionally send an STR message to the Diameter server. The Diameter server shall reply with an STA and shall deallocate the IP address or IPv6 prefix (if any) initially allocated to the subscriber. + +For PDP type IPv4v6 and deferred IPv4 addressing, when the GGSN receives a message from the MS or the network indicating the release of the IPv4 address (e.g. receiving DHCPRELEASE) or decides to release the IPv4 address on its own (e.g. due to DHCP lease timer expiry for GGSN assigned IPv4 address), the GGSN shall inform the accounting server about the deallocation of the IPv4 address by sending Diameter Accounting-Request Interim-Update without the Framed-IP-Address AVP. + +### 16a.3.2 PPP PDP type + +Figure 25b describes the Diameter message flows between a GGSN and a Diameter server for the case where PPP is terminated at the GGSN. The case where PPP is relayed to an LNS is beyond the scope of the present document. + +![Sequence diagram showing Diameter message flow for PDP type PPP. Lifelines: TE, MT, SGSN, GGSN, Diameter Server, PDN. The sequence includes PDP Context Activate Request, Create PDP Context Request/Response, Activate PDP Context Accept, LCP Negotiation, Challenge, Authentication Request, AA-Request/Answer, Authentication Response, NCP Negotiation, Accounting-Request/Answer (start), User Data Session, LCP Termination, Delete PDP Context Request/Response, Deactivate PDP Context Request/Response, and Accounting-Request/Answer (stop).](eabcb2f8b9acedb194571d5bc734b463_img.jpg) + +**Diameter message flow for PDP type PPP (successful user authentication case)** + +``` + +sequenceDiagram + participant TE + participant MT + participant SGSN + participant GGSN + participant DiameterServer as Diameter Server + participant PDN + + Note right of DiameterServer: (Note 1) + + MT->>SGSN: PDP Context Activate Request + SGSN->>GGSN: Create PDP Context Request + GGSN->>SGSN: Create PDP Context Response + SGSN->>MT: Activate PDP Context Accept + MT->>GGSN: LCP Negotiation + GGSN-->>MT: Challenge + MT->>GGSN: Authentication Request + GGSN->>DiameterServer: AA-Request + Note left of GGSN: (Note 2) + DiameterServer-->>GGSN: AA-Answer + Note right of DiameterServer: (Note 5) + GGSN->>MT: Authentication Response + MT->>GGSN: NCP Negotiation + GGSN->>DiameterServer: Accounting-Request (start) + DiameterServer-->>GGSN: Accounting-Answer (start) + Note left of GGSN: (Note 3) + Note right of GGSN: User Data Session + MT->>GGSN: LCP Termination + Note left of GGSN: (Note 4) + GGSN->>DiameterServer: Accounting-Request (stop) + Note right of DiameterServer: (Note 6) + DiameterServer-->>GGSN: Accounting-Answer (stop) + GGSN-->>MT: Delete PDP Context Request + MT->>GGSN: Deactivate PDP Context Request + GGSN->>DiameterServer: Accounting-Request (stop) + Note right of DiameterServer: (Note 7) + DiameterServer-->>GGSN: Accounting-Answer (stop) + GGSN-->>MT: Delete PDP Context Response + MT->>GGSN: Deactivate PDP Context Accept + +``` + +Sequence diagram showing Diameter message flow for PDP type PPP. Lifelines: TE, MT, SGSN, GGSN, Diameter Server, PDN. The sequence includes PDP Context Activate Request, Create PDP Context Request/Response, Activate PDP Context Accept, LCP Negotiation, Challenge, Authentication Request, AA-Request/Answer, Authentication Response, NCP Negotiation, Accounting-Request/Answer (start), User Data Session, LCP Termination, Delete PDP Context Request/Response, Deactivate PDP Context Request/Response, and Accounting-Request/Answer (stop). + +NOTE 1: Separate accounting and Authentication servers may be used. + +NOTE 2: Actual messages depend on the used authentication protocol (e.g. PAP, CHAP). + +NOTE 3: If some external applications require Diameter Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Answer (START) is received from the AAA server. The GGSN may delete the PDP context if the Accounting Response (START) is not received. + +NOTE 4: An LCP termination procedure may be performed. Either the MS or the GGSN may initiate the context deactivation. + +NOTE 5: The AA-Request message shall be used for primary PDP context only. + +NOTE 6: Network Initiated deactivation. + +NOTE 7: User Initiated deactivation. + +**Figure 25b: Diameter message flow for PDP type PPP (successful user authentication case)** + +When a GGSN receives a Create PDP Context Request message for a given APN, the GGSN shall immediately send a Create PDP context response back to the SGSN. After PPP link setup, the authentication phase may take place. During Authentication phase, the GGSN sends a Diameter AA-Request to a Diameter server. The Diameter server authenticates and authorizes the user. If Diameter is also responsible for IP address allocation the Diameter server shall return the allocated IP address or IPv6 prefix in the AA-answer message (if the user was authenticated). + +If the user is not authenticated, the GGSN shall send a Delete PDP context request to the SGSN. The AA-Request and AA-Answer messages are only used for the primary PDP context. + +Even if the GGSN was not involved in user authentication (e.g. for PPP no authentication may be selected), it may send a Diameter Accounting-Request (START) message to a Diameter server. If no Diameter session is already open for the user a Diameter session needs to be activated, otherwise the existing Diameter session is used to send the Accounting-Request (START). The NSAPI will identify the particular PDP context this accounting refers to. The Accounting-Request message also indicates to the Diameter server that the user session has started, and the QoS parameters associated to the session. This message contains parameters, e.g. a tuple which includes the user-id, IP address or IPv6 prefix, and the MSISDN to be used by application servers (e.g. WAP gateway) in order to identify the user. + +If some external applications require Diameter Accounting request (Start) information before they can process user packets, then the selected APN (GGSN) may be configured in such a way that the GGSN drops user data until the Accounting Answer (START) is received from the Diameter server. The GGSN may delete the PDP context if the Accounting Answer (START) is not received. The Authentication and Accounting servers may be separately configured for each APN. + +When the GGSN receives a Delete PDP Context Request message and providing a Diameter Accounting-Request (START) message was sent previously, the GGSN shall send a Diameter Accounting-Request (STOP) message to the Diameter server, which indicates the termination of this particular user session. The NSAPI will identify the particular PDP context this accounting refers to. The GGSN shall immediately send a Delete PDP context response, without waiting for an Accounting-Answer (STOP) message from the Diameter server. + +If this was the last PDP context for that PDP address, the GGSN shall additionally send an STR message to the Diameter server. The Diameter server shall reply with an STA and shall deallocate the IP address or IPv6 prefix (if any) initially allocated to the subscriber. + +### 16a.3.3 Accounting Update + +During the life of a PDP context some information related to this PDP context may change (i.e. SGSN address if an Inter-SGSN RA update occurs). Upon reception of an UpdatePDPContextRequest from the SGSN, the GGSN may send an Accounting Request (Interim) to the Diameter server to update the necessary information related to this PDP context (see figure 25c). Interim updates are also used when the IPv4 address is allocated/released/re-allocated for deferred IPv4 addressing for the PDP type IPv4v6. + +If the GGSN receives an UpdatePDPContextRequest from the SGSN that specifically indicates a direct tunnel establishment or a direct tunnel teardown (switching the user plane tunnel end back to the SGSN), and only the GTP user plane address or the GTP-U TEID have changed, then the GGSN should not send the Accounting Request (Interim) message to the Diameter server. In such cases, the GGSN need not wait for the Diameter Accounting Answer from the Diameter server message before sending the UpdatePDPContextResponse to the SGSN. The GGSN may delete the PDP context if the Accounting Answer is not received from the Diameter server. + +![Sequence diagram for Diameter for PDP context Update. The diagram shows three entities: SGSN, GGSN, and Diameter Server. The sequence of messages is: 1. SGSN sends UpdatePDPContextReq to GGSN. 2. GGSN sends AccountingReq (Interim) to Diameter Server. 3. GGSN sends UpdatePDPContextRes to SGSN. 4. Diameter Server sends AccountingAns to GGSN. A note indicates that the GGSN does not wait for the AccountingAns before sending the UpdatePDPContextRes.](d4a9a1e5b2d8b51e6bf1abacd2421c83_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant GGSN + participant DiameterServer as Diameter Server + Note right of GGSN: (Note) + SGSN->>GGSN: UpdatePDPContextReq + GGSN->>DiameterServer: AccountingReq (Interim) + GGSN->>SGSN: UpdatePDPContextRes + DiameterServer->>GGSN: AccountingAns + +``` + +Sequence diagram for Diameter for PDP context Update. The diagram shows three entities: SGSN, GGSN, and Diameter Server. The sequence of messages is: 1. SGSN sends UpdatePDPContextReq to GGSN. 2. GGSN sends AccountingReq (Interim) to Diameter Server. 3. GGSN sends UpdatePDPContextRes to SGSN. 4. Diameter Server sends AccountingAns to GGSN. A note indicates that the GGSN does not wait for the AccountingAns before sending the UpdatePDPContextRes. + +NOTE: As shown the GGSN need not wait for the Diameter Accounting Answer message from the Diameter server to send the UpdatePDPContextResponse to the SGSN. The GGSN may delete the PDP context if the Accounting Answer is not received from the Diameter server. + +Figure 25c: Diameter for PDP context Update + +### 16a.3.4 Server-Initiated PDP context termination + +Diameter is used as the protocol between the GGSN and a Diameter server or proxy for applications (e.g. MMS) to deliver information related to GPRS user session. However some IP applications could need to interwork with the GGSN to terminate a particular PDP context. For this purpose, the Diameter server or proxy may send a Diameter ASR to the GGSN along with the NSAPI necessary to identify the particular PDP context to be terminated. As depicted in figure 25d, the GGSN should react by deleting the corresponding PDP context. If the GGSN deletes the corresponding PDP context, it need not wait for the DeletePDPContextResponse from the SGSN before sending the ASA to the server. + +The absence of the NSAPI in the Diameter ASR message indicates to the GGSN that all PDP contexts for this particular user and sharing the same user session shall be deleted. The PDP contexts belonging to the same IP-CAN session are identified by the Diameter Session-Id. If a user has the same user IP address for different sets of PDP contexts towards different networks, only the PDP contexts linked to the one identified by the Diameter Session-Id shall be deleted. + +![Sequence diagram showing PDP Context deletion with Diameter. The diagram involves three entities: SGSN, GGSN, and Diameter Server. The sequence of messages is: 1. GGSN sends an ASR (Account-Stop-Request) to the Diameter Server. 2. Diameter Server sends a DeletePDPContextReq to the GGSN. 3. GGSN sends a DeletePDPContextRes to the SGSN. 4. GGSN sends an ASA (Account-Start-Request) to the Diameter Server, with a note indicating this happens without waiting for the response from the SGSN.](ef45b00396c293be0b18d32b97118bf4_img.jpg) + +``` + +sequenceDiagram + participant SGSN + participant GGSN + participant Diameter Server + Note right of GGSN: (Note) + GGSN->>Diameter Server: ASR + Diameter Server->>GGSN: DeletePDPContextReq + GGSN->>SGSN: DeletePDPContextRes + GGSN->>Diameter Server: ASA + +``` + +Sequence diagram showing PDP Context deletion with Diameter. The diagram involves three entities: SGSN, GGSN, and Diameter Server. The sequence of messages is: 1. GGSN sends an ASR (Account-Stop-Request) to the Diameter Server. 2. Diameter Server sends a DeletePDPContextReq to the GGSN. 3. GGSN sends a DeletePDPContextRes to the SGSN. 4. GGSN sends an ASA (Account-Start-Request) to the Diameter Server, with a note indicating this happens without waiting for the response from the SGSN. + +NOTE: As showed on figure 25d, the GGSN need not wait for the DeletePDPContextResponse from the SGSN to send the ASA to the Diameter server. + +Figure 25d: PDP Context deletion with Diameter + +## 16a.3a Authentication and accounting message flows on Sgi interface + +### 16a.3a.1 Authentication, Authorization and Accounting procedures + +When a P-GW receives an initial access request (e.g. Create Session Request or Proxy Binding Update) message for a given APN, the P-GW may (depending on the configuration for this APN) send a Diameter AA-Request to a Diameter server. The Diameter server authenticates and authorizes the user. If the Diameter server is also responsible for IPv4 address and/or IPv6 prefix allocation the Diameter server shall return the allocated IPv4 address and/or IPv6 prefix in the AA-Answer message. + +When PDN type is IPv4v6 and deferred IPv4 addressing via IPv4 address pool in the AAA server is used, the P-GW may initiate Diameter re-authorization procedures after successful initial attach for the purpose of IPv4 address allocation or to renew the lease for a previously allocated IPv4 address. In this case, the P-GW shall set the Session-Id to the value used in the initial access request, the Auth-Request-Type AVP to "AUTHORIZE\_ONLY" and the 3GPP-Allocate-IP-Type AVP to the type of IP address to be allocated in the AA-Request message sent to the AAA server. See subclause 16.4.7.2 for the conditions to use 3GPP-Allocate-IP-Type AVP in AA-Request messages. If the P-GW is using DHCPv4 signalling towards the UE and the Diameter server includes the Session-Timeout attribute in the Access-Accept, the P-GW may use the Session-Timeout value as the DHCP lease time. The P-GW shall not set the DHCPv4 lease time value higher than the Session-Timeout value. The P-GW may renew the DHCP lease to the UE without re-authorization towards the AAA server providing that the new lease expiry is no later than the Session-Timeout timer expiry. If the P-GW wishes to extend the lease time beyond the current Session-Timeout expiry, it shall initiate a new AAA re-authorization. + +Even if the P-GW was not involved in user authentication, it may send a Diameter Accounting-Request (START) message to a Diameter server. If no Diameter session is already open for the same PDN connection a Diameter session needs to be activated, otherwise the existing Diameter session is used to send the Accounting-Request (START). For GTP-based S5/S8/S2a/S2b, if accounting is used per IP-CAN bearer, the EPS bearer ID will identify the particular bearer this accounting message refers to. The Accounting-Request message also indicates to the Diameter server that the user session has started. This message contains parameters, e.g. the tuple which includes the user-id and IPv4 address and/or IPv6 prefix, to be used by application servers (e.g. WAP gateway) in order to identify the user. This message also indicates to the Diameter server that the user session has started. + +If some external applications require Diameter Accounting Request (START) information before they can process user packets, then the selected APN (P-GW) may be configured in such a way that the P-GW drops user data until an Accounting-Answer (START) indicating success is received from the Diameter server. The P-GW may wait for the Accounting-Answer (START) before sending the initial access response (e.g. Create Session Response or Proxy + +Binding Acknowledgement). The P-GW may reject the initial access request if the Accounting-Answer (START) is not received. The authentication and accounting servers may be separately configured for each APN. + +For PDN type IPv4, at IPv4 address allocation via DHCPv4 signalling between the UE and the PDN, no IPv4 address is available at initial access. In that case the P-GW may wait to send the Accounting-Request START message until the UE receives its IPv4 address in a DHCPACK. + +For PDN type IPv4v6 and deferred IPv4 addressing, when the IPv4 address is allocated or re-allocated, the accounting session that was established for the IPv6 prefix allocation shall be used to inform the accounting server about the allocated IPv4 address by sending Diameter Accounting-Request Interim-Update with the Framed-IP-Address AVP and its value field containing the allocated IPv4 address. + +When the P-GW receives a message indicating a bearer deactivation request or PDN disconnection request or detach request (e.g. Delete Bearer Command or Proxy Binding Update with lifetime equal 0) and providing a Diameter Accounting-Request START message was sent previously, the P-GW shall send a Diameter Accounting-Request (STOP) message to the Diameter server, which indicates the termination of this particular bearer or user session. The P-GW shall immediately send the corresponding response (e.g. Delete Bearer Request or Proxy Binding Ack with lifetime equal 0) to the peer node (e.g. S-GW) in the Packet Domain, without waiting for an Accounting-Answer (STOP) message from the Diameter server. + +If the last bearer of an IP-CAN session is deactivated, the P-GW shall additionally send an STR message to the Diameter server. The Diameter server shall reply with an STA and shall deallocate the IPv4 address and/or IPv6 prefix (if any) initially allocated to the subscriber. + +For PDN type IPv4v6 and deferred IPv4 addressing, when the P-GW receives a message from the UE or the network indicating the release of the IPv4 address (e.g. receiving DHCPRELEASE) or decides to release the IPv4 address on its own (e.g. due to DHCP lease timer expiry for P-GW assigned IPv4 address), the P-GW shall inform the accounting server about the deallocation of the IPv4 address by sending Diameter Accounting-Request Interim-Update without the Framed-IP-Address AVP. + +The following Figure 25d.1 is an example message flow to show the procedure of Diameter Authentication and Accounting, which is applicable for GTP based S5/S8: + +![Sequence diagram showing Diameter Authentication and Accounting on Sgi for GTP-based S5/S8. Lifelines: S-GW, P-GW, Diameter Server (note 2), and PDN. The diagram illustrates the message flow for session creation and deletion, including authentication (AA-Request/Answer) and accounting (Accounting-Request/Answer) messages.](9b39a1d27e49bccd8767e8d5fc0be7fd_img.jpg) + +``` + +sequenceDiagram + participant S-GW + participant P-GW + participant DS as Diameter Server (note 2) + participant PDN + + Note left of S-GW: (note 1) + + S-GW->>P-GW: Create Session Request + P-GW-->>DS: AA-Request + DS-->>P-GW: AA-Answer + P-GW->>DS: Accounting-Request (start) + P-GW->>S-GW: Create Session Response + DS-->>P-GW: Accounting- Answer (start) + P-GW->>PDN: User data + S-GW->>P-GW: Delete Session Request + P-GW->>DS: Accounting-Request (stop) + P-GW->>S-GW: Delete Session Response + DS-->>P-GW: Accounting- Answer (stop) + +``` + +Sequence diagram showing Diameter Authentication and Accounting on Sgi for GTP-based S5/S8. Lifelines: S-GW, P-GW, Diameter Server (note 2), and PDN. The diagram illustrates the message flow for session creation and deletion, including authentication (AA-Request/Answer) and accounting (Accounting-Request/Answer) messages. + +NOTE 1: If some external applications require Diameter Accounting request (Start) information before they can process user packets, then the selected APN (P-GW) may be configured in such a way that the P-GW drops user data until the Accounting Answer (START) is received from the Diameter server. The P-GW may wait for the Accounting Answer (START) before sending the Create Session Response. The P-GW may reject the bearer if the Accounting Answer (START) is not received. + +NOTE 2: Separate accounting and authentication servers may be used. + +**Figure 25d.1: An example of Diameter Authentication and Accounting on Sgi for GTP-based S5/S8** + +### 16a.3a.2 Accounting Update + +During the life of a bearer some information related to this bearer may change. Upon occurrence of the following events the P-GW may send an Accounting Request (Interim) to the Diameter server: RAT change, S-GW address change and QoS change. Interim updates are also used when the IPv4 address is allocated/released/re-allocated for deferred IPv4 addressing for the PDN type IPv4v6. + +When the P-GW receives a signalling request (e.g. Modify Bearer Request in case of GTP-based S5/S8) that indicates the occurrence of one of these chargeable events, the P-GW may send an Accounting Request (Interim) to the Diameter server to update the necessary information related to this bearer. The P-GW need not wait for the Diameter Accounting Answer message from the Diameter server before sending the response for the triggering signalling message (e.g. Modify Bearer Response). The P-GW may delete the bearer if the Accounting Answer is not received from the Diameter server. + +The P-GW may also send interim updates at the expiry of an operator configured time limit. + +The message flow in figure 25d.2 provides an example for Diameter Accounting Update procedure on Sgi interface, which is applicable for GTP based S5/S8: + +![Sequence diagram for Diameter accounting update for bearer modification. The diagram shows three entities: S-GW, P-GW, and Diameter Server. The S-GW sends a 'Modify Bearer Req' to the P-GW. The P-GW then sends an 'AccountingReq (Interim)' to the Diameter Server. The Diameter Server responds with 'AccountingAns' to the P-GW, which in turn sends a 'Modify Bearer Res' back to the S-GW.](da85343976fdbb19f866d9ddbdad0eae_img.jpg) + +``` + +sequenceDiagram + participant S-GW + participant P-GW + participant Diameter Server + S-GW->>P-GW: Modify Bearer Req + P-GW->>Diameter Server: AccountingReq (Interim) + Diameter Server-->>P-GW: AccountingAns + P-GW-->>S-GW: Modify Bearer Res + +``` + +Sequence diagram for Diameter accounting update for bearer modification. The diagram shows three entities: S-GW, P-GW, and Diameter Server. The S-GW sends a 'Modify Bearer Req' to the P-GW. The P-GW then sends an 'AccountingReq (Interim)' to the Diameter Server. The Diameter Server responds with 'AccountingAns' to the P-GW, which in turn sends a 'Modify Bearer Res' back to the S-GW. + +Figure 25d.2: Diameter accounting update for bearer modification + +### 16a.3a.3 Server-Initiated Bearer termination + +Diameter is used as the protocol between the P-GW and a Diameter server or proxy for applications (e.g. MMS) to deliver information related to the user session. However some IP applications could need to interwork with the P-GW to release the corresponding resource (e.g. terminate a particular bearer or Resource Allocation Deactivation procedures as defined in TS 23.402 [78]). For this purpose, the Diameter server or proxy may send a Diameter ASR along with the EPS bearer ID, if available, to identify the particular bearer to be terminated to the P-GW. The P-GW should react by deleting the corresponding bearer. If the P-GW deletes the corresponding bearer, it need not wait for the response from the S-GW or trusted non-3GPP IP access or ePDG before sending the ASA to the server. + +The absence of the EPS bearer ID in the Diameter ASR message indicates to the P-GW that all bearers/resources for this particular user and sharing the same user session shall be deleted. The bearer(s)/resources belonging to the same IP-CAN session are identified by the Diameter Session-Id. If a user has the same user IP address(es) for different sets of bearers towards different networks, only the bearers linked to the one identified by the Diameter Session-Id shall be deleted. + +The message flow in figure 25d.3 provides an example for Server-initiated Bearer Termination procedure on Sgi interface, which is applicable for GTP based S5/S8: + +![Sequence diagram for Server-initiated Bearer Termination with Diameter. The diagram shows three entities: S-GW, P-GW, and Diameter Server. The Diameter Server sends a 'Diameter ASR' to the P-GW. The P-GW then sends a 'Delete Bearer Request' to the S-GW. The S-GW responds with a 'Delete Bearer Response' to the P-GW, which in turn sends a 'Diameter ASA' back to the Diameter Server.](f0e3f79f8b55cbaba4a467e762854eae_img.jpg) + +``` + +sequenceDiagram + participant S-GW + participant P-GW + participant Diameter Server + Diameter Server->>P-GW: Diameter ASR + P-GW->>S-GW: Delete Bearer Request + S-GW-->>P-GW: Delete Bearer Response + P-GW-->>Diameter Server: Diameter ASA + +``` + +Sequence diagram for Server-initiated Bearer Termination with Diameter. The diagram shows three entities: S-GW, P-GW, and Diameter Server. The Diameter Server sends a 'Diameter ASR' to the P-GW. The P-GW then sends a 'Delete Bearer Request' to the S-GW. The S-GW responds with a 'Delete Bearer Response' to the P-GW, which in turn sends a 'Diameter ASA' back to the Diameter Server. + +Figure 25d.3: Server-initiated Bearer Termination with Diameter + +## 16a.4 Gi/Sgi Diameter messages + +This clause describes the Gi and the Sgi interface Diameter messages. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in this clause. Other Diameter NASREQ (IETF RFC 7155 [120]) AVPs, even if their AVP flag rules is marked with "M", are not required for being compliant with the current specification. + +### 16a.4.1 AAR Command + +The AAR command, defined in Diameter NASREQ (IETF RFC 7155 [120]), is indicated by the Command-Code field set to 265 and the 'R' bit set in the Command Flags field. It may be sent by the GGSN to a Diameter server, during Primary PDP Context activation only, in order to request user authentication and authorization. In the case of P-GW, the AAR may be sent upon reception of an initial access request (e.g. Create Session Request or Proxy Binding Update) message for a given APN to request user authentication and authorization. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate optional AVPs for Gi/Sgi, or modified existing AVPs. For Sgi, some of the optional 3GPP vendor-specific AVPs listed in the message format below are not applicable. See table 9a in subclause 16a.5 to see the list of vendor-specific AVPs that are applicable to the GGSN and the P-GW. + +Message Format: + +``` + ::= < Diameter Header: 265, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + [ Origin-State-Id ] + [ Port-Limit ] + [ User-Name ] + [ User-Password ] + [ Service-Type ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Auth-Session-State ] + [ Callback-Number ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Originating-Line-Info ] + [ Connect-Info ] + [ CHAP-Auth ] + [ CHAP-Challenge ] + * [ Framed-Compression ] + [ Framed-Interface-Id ] + [ Framed-IP-Address ] + * [ Framed-IPv6-Prefix ] + * [ Delegated-IPv6-Prefix ] + [ Framed-IP-Netmask ] + [ Framed-MTU ] + [ Framed-Protocol ] + * [ Login-IP-Host ] + * [ Login-IPv6-Host ] + [ Login-LAT-Group ] + [ Login-LAT-Node ] + [ Login-LAT-Port ] + [ Login-LAT-Service ] + * [ Tunneling ] + * [ Proxy-Info ] + * [ Route-Record ] + [ 3GPP-IMSI ] + [ External-Identifier ] + [ 3GPP-Charging-ID ] +``` + +``` + +[ 3GPP-PDP-Type ] +[ 3GPP-CG-Address ] +[ 3GPP-GPRS-Negotiated-QoS-Profile ] +[ 3GPP-SGSN-Address ] +[ 3GPP-GGSN-Address ] +[ 3GPP-IMSI-MCC-MNC ] +[ 3GPP-GGSN-MCC-MNC ] +[ 3GPP-NSAPI ] +[ 3GPP-Selection-Mode ] +[ 3GPP-Charging-Characteristics ] +[ 3GPP-CG-IPv6-Address ] +[ 3GPP-SGSN-IPv6-Address ] +[ 3GPP-GGSN-IPv6-Address ] +[ 3GPP-SGSN-MCC-MNC ] +[ 3GPP-User-Location-Info ] +[ 3GPP-RAT-Type ] +[ 3GPP-CAMEL-Charging-Info ] +[ 3GPP-Negotiated-DSCP ] +[ 3GPP-Allocate-IP-Type ] +[ TWAN-Identifier ] +[ 3GPP-UE-Local-IP-Address ] +[ 3GPP-UE-Source-Port ] +* [ AVP ] + +``` + +## 16a.4.2 AAA Command + +The AAA command, defined in Diameter NASREQ (IETF RFC 7155 [120]), is indicated by the Command-Code field set to 265 and the 'R' bit cleared in the Command Flags field., It is sent by the Diameter server to the GGSN/P-GW in response to the AAR command. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The "Tunneling" AVP may include the "Tunnel-Type" with value 3 to represent L2TP tunnel type, "Tunnel-Medium-Type" and "Tunnel-Server-Endpoint" AVPs. If more than one set of these "Tunneling" AVPs are provided, the optional "Tunnel-Preference" AVP may be provided in each set to identify the relative preference. The Tunnel-Password AVP may be used to authenticate to a remote server. + +NOTE: The other optional AVPs within the "Tunneling" AVPs not listed in the above description, can be referred to the IETF RFC 7155 [120] with implementation specific. + +The bold marked AVPs in the message format indicate optional AVPs for Gi/Sgi, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 265, PXY > + < Session-Id > + { Auth-Application-Id } + { Auth-Request-Type } + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + [ Service-Type ] + * [ Class ] + [ Acct-Interim-Interval ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Idle-Timeout ] + [ Authorization-Lifetime ] + [ Auth-Grace-Period ] + [ Auth-Session-State ] + [ Re-Auth-Request-Type ] + [ Multi-Round-Time-Out ] + [ Session-Timeout ] + * [ Reply-Message ] + [ Origin-State-Id ] + * [ Filter-Id ] + [ Port-Limit ] + [ Prompt ] + [ Callback-Id ] + [ Callback-Number ] + +``` + +``` + +* [ Framed-Compression ] +[ Framed-Interface-Id ] +[ Framed-IP-Address ] +* [ Framed-IPv6-Prefix ] +[ Framed-IPv6-Pool ] +* [ Framed-IPv6-Route ] +* [ Delegated-IPv6-Prefix ] +[ Framed-IP-Netmask ] +* [ Framed-Route ] +[ Framed-Pool ] +[ Framed-IPX-Network ] +[ Framed-MTU ] +[ Framed-Protocol ] +[ Framed-Routing ] +* [ Login-IP-Host ] +* [ Login-IPv6-Host ] +[ Login-LAT-Group ] +[ Login-LAT-Node ] +[ Login-LAT-Port ] +[ Login-LAT-Service ] +[ Login-Service ] +[ Login-TCP-Port ] +* [ NAS-Filter-Rule ] +* [ QoS-Filter-Rule ] +* [ Tunneling ] +* [ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +* [ Proxy-Info ] +[ 3GPP-IPv6-DNS-Servers ] +* [ External-Identifier ] +* [ AVP ] + +``` + +### 16a.4.3 ACR Command + +The ACR command, defined in IETF RFC 6733 (Diameter Base) [111], is indicated by the Command-Code field set to 271 and the 'R' bit set in the Command Flags field. It is sent by the GGSN/P-GW to the Diameter server to report accounting information for a certain IP-CAN bearer (e.g. PDP context) or an IP-CAN session of a certain user. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate optional AVPs for Gi/Sgi, or modified existing AVPs. For Sgi, some of the optional 3GPP vendor-specific AVPs listed in the message format below are not applicable. See table 9a in subclause 16a.5 to see the ones that are applicable. + +#### Message Format: + +``` + + ::= < Diameter Header: 271, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Accounting-Record-Type } + { Accounting-Record-Number } + [ Acct-Application-Id ] + [ User-Name ] + [ Origin-State-Id ] + [ Destination-Host ] + [ Event-Timestamp ] + [ Acct-Delay-Time ] + [ NAS-Identifier ] + [ NAS-IP-Address ] + [ NAS-IPv6-Address ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + * [ Class ] + [ Service-Type ] + [ Accounting-Input-Octets ] + [ Accounting-Input-Packets ] + [ Accounting-Output-Octets ] + [ Accounting-Output-Packets ] + [ Acct-Authentic ] + +``` + +``` +[ Accounting-Auth-Method ] +[ Acct-Session-Time ] +[ Acct-Tunnel-Connection ] +[ Acct-Tunnel-Packets-Lost ] +[ Callback-Id ] +[ Callback-Number ] +[ Called-Station-Id ] +[ Calling-Station-Id ] +* [ Connection-Info ] +[ Originating-Line-Info ] +[ Authorization-Lifetime ] +[ Session-Timeout ] +[ Idle-Timeout ] +[ Port-Limit ] +[ Accounting-Realtime-Required ] +[ Acct-Interim-Interval ] +* [ Filter-Id ] +* [ NAS-Filter-Rule ] +* [ Qos-Filter-Rule ] +[ Framed-Compression ] +[ Framed-Interface-Id ] +[ Framed-IP-Address ] +[ Framed-IP-Netmask ] +* [ Framed-IPv6-Prefix ] +[ Framed-IPv6-Pool ] +* [ Framed-IPv6-Route ] +* [ Delegated-IPv6-Prefix ] +[ Framed-IPX-Network ] +[ Framed-MTU ] +[ Framed-Pool ] +[ Framed-Protocol ] +* [ Framed-Route ] +[ Framed-Routing ] +* [ Login-IP-Host ] +* [ Login-IPv6-Host ] +[ Login-LAT-Group ] +[ Login-LAT-Node ] +[ Login-LAT-Port ] +[ Login-LAT-Service ] +[ Login-Service ] +[ Login-TCP-Port ] +* [ Tunneling ] +* [ Proxy-Info ] +* [ Route-Record ] +[ 3GPP-IMSI ] +[ External-Identifier ] +[ 3GPP-Charging-ID ] +[ 3GPP-PDP-Type ] +[ 3GPP-CG-Address ] +[ 3GPP-GPRS-Negotiated-QoS-Profile ] +[ 3GPP-SGSN-Address ] +[ 3GPP-GGSN-Address ] +[ 3GPP-IMSI-MCC-MNC ] +[ 3GPP-GGSN-MCC-MNC ] +[ 3GPP-NSAPI ] +[ 3GPP-Selection-Mode ] +[ 3GPP-Charging-Characteristics ] +[ 3GPP-CG-IPv6-Address ] +[ 3GPP-SGSN-IPv6-Address ] +[ 3GPP-GGSN-IPv6-Address ] +[ 3GPP-SGSN-MCC-MNC ] +[ 3GPP-IMEISV ] +[ 3GPP-RAT-Type ] +[ 3GPP-User-Location-Info ] +[ 3GPP-MS-Time-Zone ] +[ 3GPP-CAMEL-Charging-Info ] +[ 3GPP-Packet-Filter ] +[ 3GPP-Negotiated-DSCP ] +[ TWAN-Identifier ] +[ 3GPP-User-Location-Info-Time ] +* [ 3GPP-Secondary-RAT-Usage ] +[ 3GPP-UE-Local-IP-Address ] +[ 3GPP-UE-Source-Port ] +* [ AVP ] +``` + +### 16a.4.4 ACA Command + +The ACA command, defined in Diameter Base (IETF RFC 6733 [111]), is indicated by the Command-Code field set to 271 and the 'R' bit cleared in the Command Flags field. It is sent by the Diameter server to the GGSN/P-GW in response to the ACR command. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 271, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + { Accounting-Record-Type } + { Accounting-Record-Number } + [ Acct-Application-Id ] + [ User-Name ] + [ Event-Timestamp ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ NAS-Identifier ] + [ NAS-IP-Address ] + [ NAS-IPv6-Address ] + [ NAS-Port ] + [ NAS-Port-Id ] + [ NAS-Port-Type ] + [ Service-Type ] + [ Accounting-Realtime-Required ] + [ Acct-Interim-Interval ] + * [ Class ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +### 16a.4.5 STR Command + +The STR command, defined in IETF RFC 6733 (Diameter Base) [111], is indicated by the Command-Code field set to 275 and the 'R' bit set in the Command Flags field. It is sent by the GGSN/P-GW to the Diameter server to terminate a DIAMETER session corresponding to an IP-CAN session of a certain user. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ User-Name ] + [ Destination-Host ] + * [ Class ] + [ Origin-State-Id ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +### 16a.4.6 STA Command + +The STA command, defined in IETF RFC 6733 (Diameter Base) [111], is indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field. It is sent by the Diameter server to the GGSN/P-GW in response to an STR command. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ User-Name ] + * [ Class ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ AVP ] +``` + +#### 16a.4.7 ASR Command + +The Abort-Session-Request (ASR) command, defined in IETF RFC 6733 (Diameter Base) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit set, is sent by the Diameter server to the GGSN to request that the PDP Context identified by the 3GPP-NSAPI AVP is to be terminated. The absence of the 3GPP-NSAPI AVP will indicate to the GGSN that all the PDP contexts for this particular user and sharing the same user session need to be deleted. Similarly, for P-GW, the ASR command is sent by the Diameter server to the P-GW to request that the EPS bearer identified by the 3GPP-NSAPI AVP is to be terminated. In the absence of the 3GPP-NSAPI AVP or if the value of 3GPP-NSAPI AVP points to the default EPS bearer, the P-GW shall terminate the IP-CAN session associated with the same user session. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate optional AVPs for Gi/Sgi, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 274, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ Origin-State-Id ] + * [ Proxy-Info ] + * [ 3GPP-NSAPI ] + * [ Route-Record ] + * [ AVP ] +``` + +#### 16a.4.8 ASA Command + +The Abort-Session-Answer (ASA) command, defined in IETF RFC 6733 (Diameter Base) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit clear, is sent in response to the ASR. + +The relevant AVPs that are of use for the Gi/Sgi interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gi/Sgi purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate optional AVPs for Gi/Sgi or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 274, PXY > + < Session-Id > + { Result-Code } +``` + +``` +{ Origin-Host } +{ Origin-Realm } +[ User-Name ] +[ Origin-State-Id ] +[ Experimental-Result ] +[ Error-Message ] +[ Error-Reporting-Host ] +[ Failed-AVP ] +* [ Redirected-Host ] +[ Redirected-Host-Usage ] +[ Redirect-Max-Cache-Time ] +* [ Proxy-Info ] +* [ AVP ] +``` + +The Experimental-Result AVP contains an Experimental-Result-Code AVP and will signal to the Diameter server that the IP-CAN bearer (e.g. PDP context) has been successfully terminated as requested. See subclause 16a.6 for the description of the Experimental-Result-Code AVP. + +## 16a.5 Gi/Sgi specific AVPs + +The following table lists the Gi/Sgi specific Diameter AVPs. The Vendor-Id header of all Gi/Sgi specific AVPs defined in the present specification shall be set to 3GPP (10415). + +**Table 9a: Gi/Sgi specific AVPs** + +| AVP Flag rules | +|-----------------------| +|-----------------------| + +| Attribute Name | AVP Code | Section defined | Value Type | Must | May | Should not | Must not | May Encr. | Applicable Reference Points | +|----------------------------------|----------|----------------------|-------------|------|-----|------------|----------|-----------|-----------------------------| +| 3GPP-IMSI | 1 | 16.4.7
(see Note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-Charging-Id | 2 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-PDP-Type | 3 | 16.4.7
(see Note) | Enumerated | V | P | | M | Y | Gi, Sgi | +| 3GPP-CG-Address | 4 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-GPRS-Negotiated-QoS-Profile | 5 | 16.4.7
(see Note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-SGSN-Address | 6 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-GGSN-Address | 7 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-IMSI-MCC-MNC | 8 | 16.4.7
(see note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-GGSN-MCC-MNC | 9 | 16.4.7
(see note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-NSAPI | 10 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-Selection-Mode | 12 | 16.4.7
(see note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-Charging-Characteristics | 13 | 16.4.7
(see note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-CG-IPv6-Address | 14 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-SGSN-IPv6-Address | 15 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-GGSN-IPv6-Address | 16 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-IPv6-DNS-Servers | 17 | 16.4.7
(see note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-SGSN-MCC-MNC | 18 | 16.4.7
(see note) | UTF8String | V | P | | M | Y | Gi, Sgi | +| 3GPP-IMEISV | 20 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-RAT-Type | 21 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-User-Location-Info | 22 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-MS-TimeZone | 23 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-CAMEL-Charging-Info | 24 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi | +| 3GPP-Packet-Filter | 25 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-Negotiated-DSCP | 26 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-Allocate-IP-Type | 27 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| TWAN-Identifier | 29 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Sgi | +| 3GPP-User-Location-Info-Time | 30 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Gi, Sgi | +| 3GPP-Secondary-RAT-Usage | 31 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Sgi | +| 3GPP-UE-Local-IP-Address | 32 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Sgi | +| 3GPP-UE-Source-Port | 33 | 16.4.7
(see Note) | OctetString | V | P | | M | Y | Sgi | + +NOTE: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [m]) and the P flag may be set. + +The information represented by some of the Sgi AVPs may not be available to the P-GW depending on the UE's radio access and the S5/S8 protocol type (GTP or PMIP). For example, the P-GW will be aware of the User Location Info (e.g. TAI) if the user is in LTE access and GTP based S5/S8 is used. + +However, such information is not passed to the P-GW when PMIP based S5/S8 is utilised. In such scenarios, if an Sgi specific AVP is configured in the P-GW to be transferred to the Diameter AAA server, but the information in the P-GW is not up to date or not available; the P-GW shall not send the corresponding AVP, unless otherwise stated in the AVP definitions in subclause 16.4.7.2. + +## 16a.6 Gi/Sgi specific Experimental-Result-Code AVP + +Diameter Base IETF RFC 6733 [111] defines a number of Result-Code AVP values that are used to report protocol errors and how those are used. Those procedures and values apply for the present specification. + +Due to the Gi/Sgi specific AVPs, new application results can occur and the Experimental-Result AVP is used to transfer the 3GPP-specific result codes. The Experimental-Result AVP is a grouped AVP containing the Vendor-Id AVP set to the value of 3GPP's vendor identifier (10415) and an Experimental-Result-Code AVP. + +The following Gi/Sgi specific Experimental-Result-Code value is defined: + +DIAMETER\_PDP\_CONTEXT\_DELETION\_INDICATION (2021) + +For GGSN this is an indication to the server that the requested PDP Context or IP-CAN session has been deleted. + +For P-GW this is an indication to the server that the requested bearer or IP-CAN session has been deleted. + +## 16a.7 Gi/Sgi re-used AVPs + +Table 9b lists the Diameter AVPs re-used by the Gi/Sgi reference point from existing Diameter Applications, reference to the respective specifications and a short description of the usage within the Gi/Sgi reference point. + +**Table 9b: Gi/Sgi re-used Diameter AVPs** + +| Attribute Name | Reference | Description | +|---------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| External-Identifier | 3GPP
TS 29.336 [101] | A globally unique identifier of a UE used towards external servers instead of IMSI and MSISDN, refer to 3GPP TS 23.682 [100] and 3GPP TS 23.003 [40]. | + +# 17 Usage of Diameter on Gmb interface + +Signalling between GGSN and BM-SC is exchanged at Gmb reference point. BM-SC functions for different MBMS bearer services may be provided by different physical network elements. To allow this distribution of BM-SC functions, the Gmb protocol must support the use of proxies to correctly route the different signalling interactions in a manner which is transparent to the GGSN. + +The GGSN uses the Gmb interface + +- to request authorisation/deactivation of a user for a multicast MBMS service, +- to register/de-register the GGSN for receiving a multicast MBMS service. +- to receive indication of session start, session update and session stop messages, which shall cause the GGSN, SGSN and RAN to set up/tear down the appropriate resources for the service. For further details, see 3GPP TS 23.246 [65]. +- to receive indication if IP multicast distribution to UTRAN should be used for the MBMS user plane data. + +The support of Gmb within the GGSN is optional, and needed for MBMS. + +The Gmb application is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. The Gmb application identifier value assigned by IANA is 16777223. + +The Gmb application identifier value shall be included in the Auth-Application-Id AVP. + +The BM-SC and the GGSN shall advertise the support of the Gmb application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [111], i.e. as part of the Vendor-Specific-Application-Id AVP. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol. + +## 17.1 MBMS user authorisation + +Upon reception of an IGMP (IPv4) or MLD (IPv6) Join message for an IP multicast address allocated to MBMS services, the GGSN shall request authorisation of the user for this multicast MBMS bearer service (identified by the PDP context over which the IGMP join is received). + +The GGSN shall support pre-configuration of a BM-SC or Gmb proxy server for authorisation purposes to which the request shall be sent. The GGSN may support a list of pre-configured BM-SC servers based on the MBMS bearer service requested, for authorisation purposes. + +Upon receipt of an MBMS UE Context Establishment Request for a user who has not already been authorised for the MBMS bearer service, the GGSN shall request authorisation of the user for this service. + +## 17.2 MBMS service registration / de-registration + +The MBMS service registration of the GGSN at the BM-SC shall be performed after authorisation of the first user on a particular GGSN, for a particular multicast MBMS Bearer service. The MBMS service de-registration of the GGSN shall be performed when the last user leaves a particular GGSN, for a particular multicast MBMS bearer service. + +The MBMS de-registration procedure shall be initiated by BM-SC when the specific multicast MBMS service is terminated. + +The GGSN shall support pre-configuration of a BM-SC or Gmb proxy server for registration/de-registration purposes. The GGSN may support a list of pre-configured BM-SC servers based on the MBMS bearer service requested for bearer registration purposes. + +## 17.3 MBMS session start / update/ stop + +The MBMS session start shall be used by the BM-SC to trigger the bearer resource establishment and announce the arrival of data for a MBMS bearer service (along with the attributes of the data to be delivered e.g. QoS or MBMS service area) to every GGSN that will deliver the MBMS bearer service. The MBMS session start shall also be used by the BM-SC to indicate to GGSN if IP multicast mechanism should be used for user plane data distribution to UTRAN. + +The MBMS session update shall be used by the BM-SC to trigger the update of MBMS session attributes in the affected GGSNs. + +The MBMS session stop shall be used by the BM-SC to indicate the end of the data stream for an MBMS bearer service to every GGSN that has been delivering the MBMS bearer service. + +## 17.4 MBMS user deactivation + +The MBMS user deactivation is a procedure that removes the MBMS UE context from the GGSN for a particular multicast MBMS bearer service (also called "leaving procedure"). This procedure can be initiated by the GGSN or the BM-SC over the Gmb interface. + +When the last user leaves a particular GGSN, for a particular MBMS multicast service, a de-registration process shall be initiated. + +## 17.5 Message flows + +### 17.5.1 Service activation + +The multicast MBMS bearer service activation procedure registers the user in the network to enable the reception of data from a specific multicast MBMS bearer service + +![Sequence diagram showing the activation of an MBMS multicast service between a UE, GGSN, and BMSC. The process involves IGMP/MLD Join, AA-Request/Answer, MBMS notification, and Create MBMS Context messages, with User Authorization and Conditional Registration steps.](93699fb71e95b4df5a3871fdcf818982_img.jpg) + +``` + +sequenceDiagram + participant UE + participant GGSN + participant BMSC + + Note right of BMSC: User Authorisation + UE->>GGSN: 1. IGMP/MLD Join Message + GGSN->>BMSC: 2. AA-Request [user/service] + BMSC-->>GGSN: 3. AA-Answer [user/service] + GGSN->>UE: 4. MBMS notification Req. + UE-->>GGSN: 5. MBMS Notification Resp. + + Note right of BMSC: User Authorization + Note right of BMSC: Conditional Registration procedure (if the GGSN was not yet registered) + + GGSN->>GGSN: 6. Create MBMS Ctxt + GGSN->>BMSC: 7. AA-Request [user/service] + BMSC-->>GGSN: 8. AA-Answer [user/service] + GGSN-->>BMSC: 9. AA-Request [service] + BMSC-->>GGSN: 10. AA-Answer [service] + GGSN->>GGSN: 11. Create MBMS Ctxt Resp + +``` + +Sequence diagram showing the activation of an MBMS multicast service between a UE, GGSN, and BMSC. The process involves IGMP/MLD Join, AA-Request/Answer, MBMS notification, and Create MBMS Context messages, with User Authorization and Conditional Registration steps. + +**Figure 26; Activation of an MBMS multicast service** + +1. The GGSN receives an IGMP (IPv4) or MLD (IPv6) Join message from a UE, over the default PDP context to signal its interest in receiving a particular multicast MBMS bearer service identified by an IP multicast address. +2. The GGSN sends an AAR seeking authorization for the activating UE to receive data from a particular service. +3. The authorization decision is provided in the AAA together with the APN to be used for creation of the MBMS UE context. If the AAA indicates that the UE is not authorized to receive the MBMS data the process terminates with no additional message exchange. +4. The GGSN sends an MBMS Notification Request (IP multicast address, APN, Linked NSAPI) to the SGSN. Linked NSAPI is set equal to the NSAPI of the PDP context over which the Join request was received. The IP multicast address is the one requested by the UE in the Join request. The APN may be different from the APN to + +which the default PDP context has been activated. In any case, the APN may resolve to a GGSN that is different from the GGSN receiving the IGMP/MLD Join request. The GGSN starts a MBMS Activation Timer as GGSN may receive no response, e.g. in case SGSN or UE does not support MBMS. + +5. The SGSN sends a MBMS Notification Response (Cause) to the GGSN that sent the MBMS Notification Request, where Cause shall indicate successful or unsuccessful MBMS context activation for the reason of SGSN or UE . Upon reception of the response message with Cause indicating unsuccessful operation or time-out of the MBMS Activation Timer in the GGSN, the GGSN may fallback to IP multicast access as defined in clause 11.7. +6. The SGSN creates an MBMS UE context and sends a Create MBMS Context Requests (IP multicast address, APN, RAI) to the GGSN. That GGSN may be different from the GGSN receiving the IGMP/MLD Join request. +7. The GGSN sends an AAR seeking authorization for the activating UE. +8. The authorization decision is provided in the AAA +9. If the GGSN does not have the MBMS Bearer Context information for this MBMS bearer service, i.e. the GGSN was not yet registered, the GGSN sends a AAR to the BM-SC. See subclause 17.5.4 "Registration Procedure". + +If no TMGI has been allocated for this MBMS bearer service, the BM-SC will allocate a new TMGI. This TMGI will be passed to GGSN via the AAA message. + +10. The BM-SC responds with a AAA containing the MBMS Bearer Context information for this MBMS bearer service and adds the identifier of the GGSN to the "list of downstream nodes" parameter in its MBMS Bearer Context. See subclause 17.5.4 "Registration Procedure". +11. The GGSN creates an MBMS UE context and sends a Create MBMS Context Response to the SGSN + +## 17.5.2 Session start procedure + +The BM-SC initiates the MBMS session start procedure when it is ready to send data. This informs the GGSN of the imminent start of the transmission and MBMS session attributes are provided to the GGSNs included in the list of downstream nodes in BM-SC. For a multicast MBMS service these are the GGSNs that have previously registered for the corresponding MBMS bearer service. The bearer plane is allocated. + +BM-SC and GGSN shall at least support IP unicast encapsulation of IP multicast datagrams, which shall be default mode of sending user plane data. BM-SC may support sending user plane IP multicast datagrams to GGSN, and GGSN also may support this mode of operation. + +![Sequence diagram of the MBMS Session Start procedure between GGSN and BM-SC.](c71fd22661fbd344a66043940bbd84fc_img.jpg) + +``` + +sequenceDiagram + participant GGSN + participant BM-SC + Note right of BM-SC: 1. RAR (Start) + BM-SC->>GGSN: RAR (Start) + Note left of GGSN: 2. RAA (Start) + GGSN->>BM-SC: RAA (Start) + +``` + +The diagram illustrates the interaction between the GGSN and the BM-SC for the MBMS Session Start procedure. It consists of two steps: 1. The BM-SC sends a RAR (Start) message to the GGSN. 2. The GGSN responds with a RAA (Start) message to the BM-SC. + +Sequence diagram of the MBMS Session Start procedure between GGSN and BM-SC. + +**Figure 27: MBMS Session Start procedure** + +1. The BM-SC sends a RAR message to indicate the impending start of the transmission and to provide the session attributes to the GGSNs listed in the "list of downstream nodes" parameter of the corresponding MBMS Bearer Context. BM-SC may indicate to GGSN that BM-SC supports sending the user plane IP multicast data without IP unicast encapsulation. In such case BM-SC shall send multicast source address as specified by IETF RFC 4604 [73] and IETF RFC 4607 [74]. The BM-SC sets the state attribute of its MBMS Bearer Context to 'Active'. By sending "CN IP Multicast Distribution" parameter to GGSN, the BM-SC indicates if IP multicast mechanism should be used for user plane data distribution to UTRAN. "MBMS HC Indicator" parameter, if present, indicates that a header compression is used for MBMS user plane data. + +2. For a broadcast MBMS bearer service the GGSN creates an MBMS Bearer Context. The GGSN stores the session attributes in the MBMS Bearer Context, sets the state attribute of its MBMS Bearer Context to 'Active' and sends a RAA message to the BM-SC. In case GGSN receives BM-SC multicast source address, which indicates BM-SC support for both modes of sending user plane data, GGSN decides in which mode GGSN shall receive the user plane data. In case GGSN decides to receive unicast encapsulated data, then GGSN shall send own IP address and UDP port for the encapsulating unicast IP and UDP layer of the user plane to BM-SC. In case GGSN decides to receive IP multicast packets, then GGSN shall join the multicast group as specified by IETF RFC 4604 [73] and IETF RFC 4607 [74], and indicate to BM-SC about the decision. + +### 17.5.3 Session stop procedure + +The BM-SC initiates the MBMS session stop procedure when it considers the MBMS session terminated. Typically this will happen when there is no more MBMS data expected to be transmitted for a sufficiently long period of time to justify the release of bearer plane resources in the network. + +![Sequence diagram for MBMS Session Stop procedure](ca9fd3bd2fe73a46244dd1d017ffa3b5_img.jpg) + +``` +sequenceDiagram + participant BM-SC + participant GGSN + Note right of BM-SC: 1. RAR (Stop) + BM-SC->>GGSN: RAR (Stop) + Note left of GGSN: 2. RAA (Stop) + GGSN->>BM-SC: RAA (Stop) +``` + +The diagram illustrates the MBMS Session Stop procedure between a BM-SC and a GGSN. The BM-SC sends a RAR (Stop) message to the GGSN, and the GGSN responds with a RAA (Stop) message. + +Sequence diagram for MBMS Session Stop procedure + +Figure 28: MBMS Session Stop procedure + +1. The BM-SC sends a RAR message to all GGSNs listed in the "list of downstream nodes" parameter of the affected MBMS Bearer Context to indicate that the MBMS session is terminated and the bearer plane resources can be released. +2. The GGSN sets the state attribute of its MBMS Bearer Context to 'Standby' and sends a RAA message to the BM-SC. An AAR message is not mandated for the Gmb application in response to a RAR- RAA command exchange. + +### 17.5.4 Registration procedure + +The registration procedure occurs when the GGSN indicates the BM-SC that it would like to receive session attributes and data for a particular multicast MBMS bearer service, in order to be distributed further downstream. A corresponding MBMS Bearer Context is established as a result between the GGSN and the BM-SC. + +![Sequence diagram for MBMS Registration procedure](e0774c1e190583a6c13ea92ada80aa9e_img.jpg) + +``` +sequenceDiagram + participant GGSN + participant BM-SC + Note left of BM-SC: 1. AA-Request [service] + GGSN->>BM-SC: AA-Request [service] + Note right of GGSN: 2. AA-Answer [service] + BM-SC->>GGSN: AA-Answer [service] +``` + +The diagram illustrates the MBMS Registration procedure between a GGSN and a BM-SC. The GGSN sends an AA-Request [service] message to the BM-SC, and the BM-SC responds with an AA-Answer [service] message. + +Sequence diagram for MBMS Registration procedure + +Figure 29: MBMS Registration procedure + +1. When the GGSN has no MBMS Bearer Context for an MBMS bearer service and the GGSN receives an MBMS Registration from an SGSN for this MBMS bearer service, or when the first MBMS UE Context is created in the GGSN for an MBMS bearer service for which the GGSN has no MBMS Bearer Context, the GGSN sends a AAR message (containing the IP multicast address and the APN) to the BM-SC. +2. Upon reception of an AAR from a GGSN, the BM-SC adds the identifier of the GGSN to the "list of downstream nodes" parameter in its MBMS Bearer Context and responds with an AAA message (containing TMGI, and Required Bearer Capabilities). If the MBMS Bearer Context is in the 'Active' state, the BM-SC initiates the Session Start procedure with the GGSN, as described in clause 17.5.2 "Session Start Procedure". + +### 17.5.5 De-registration procedure (GGSN initiated) + +The MBMS de-registration is the procedure by which the GGSN informs the BM-SC that it does not need to receive signalling, session attributes and data for a particular multicast MBMS bearer service anymore and therefore would like to be removed from the corresponding distribution tree. + +![Sequence diagram for MBMS De-Registration procedure (GGSN initiated). The diagram shows two vertical lifelines: GGSN on the left and BM-SC on the right. A solid arrow labeled '1. ST-Request [service]' points from the GGSN lifeline to the BM-SC lifeline. A solid arrow labeled '2. ST-Answer [service]' points from the BM-SC lifeline back to the GGSN lifeline.](eea0bd1826a6e1bdcadff03936a7b20a_img.jpg) + +``` +sequenceDiagram + participant GGSN + participant BM-SC + Note left of GGSN: GGSN initiates de-registration + GGSN->>BM-SC: 1. ST-Request [service] + BM-SC-->>GGSN: 2. ST-Answer [service] +``` + +Sequence diagram for MBMS De-Registration procedure (GGSN initiated). The diagram shows two vertical lifelines: GGSN on the left and BM-SC on the right. A solid arrow labeled '1. ST-Request [service]' points from the GGSN lifeline to the BM-SC lifeline. A solid arrow labeled '2. ST-Answer [service]' points from the BM-SC lifeline back to the GGSN lifeline. + +Figure 30: MBMS De-Registration procedure + +1. When the "list of downstream nodes" of a particular MBMS Bearer Context in the GGSN becomes empty and the GGSN has no MBMS UE Contexts linked to that MBMS Bearer Context, the GGSN sends a STR message to the BM-SC. If a bearer plane had been established over Gi for this MBMS bearer service, the bearer plane is released. +2. The BM-SC removes the identifier of the GGSN from the "list of downstream nodes" parameter of the affected MBMS Bearer Context and confirms the operation by sending a STA message to the GGSN. + +### 17.5.6 De-registration procedure (BM-SC initiated) + +This MBMS de-registration procedure is initiated by BM-SC when the specific multicast MBMS bearer service is terminated. This procedure tears down the distribution tree for the delivery of session attributes and MBMS data. This procedure results in releasing of all MBMS Bearer Contexts. + +![Sequence diagram for MBMS De-Registration procedure (BM-SC initiated). The diagram shows two vertical lifelines: GGSN on the left and BM-SC on the right. A solid arrow labeled '1. AS-Request [service]' points from the BM-SC lifeline to the GGSN lifeline. A solid arrow labeled '2. AS-Answer [service]' points from the GGSN lifeline back to the BM-SC lifeline.](e4aab374983ba0fc24496fe7cd11c06c_img.jpg) + +``` +sequenceDiagram + participant GGSN + participant BM-SC + Note right of BM-SC: BM-SC initiates de-registration + BM-SC->>GGSN: 1. AS-Request [service] + GGSN-->>BM-SC: 2. AS-Answer [service] +``` + +Sequence diagram for MBMS De-Registration procedure (BM-SC initiated). The diagram shows two vertical lifelines: GGSN on the left and BM-SC on the right. A solid arrow labeled '1. AS-Request [service]' points from the BM-SC lifeline to the GGSN lifeline. A solid arrow labeled '2. AS-Answer [service]' points from the GGSN lifeline back to the BM-SC lifeline. + +Figure 31: MBMS De-Registration procedure BM-SC initiated + +1. The BM-SC sends a ASR message to all GGSNs contained in the "list of downstream nodes" parameter of the corresponding MBMS Bearer Context to indicate that a specific MBMS bearer service is terminated. +2. The GGSN returns a ASA message to the BM-SC. The BM-SC releases all MBMS UE Contexts and removes the identifier of the GGSN from the "list of downstream nodes" parameter of the corresponding MBMS Bearer context. + +## 17.5.7 Service deactivation + +The multicast service deactivation is a signalling procedure that will terminate the user registration to a particular MBMS multicast service. The multicast service deactivation can be initiated by the GGSN, when indicated so by the UE, or by the BM-SC, for service specific reasons. + +![Sequence diagram of MBMS Service deactivation procedure between UE, GGSN, and BM-SC.](5efe6377e22b9ab76a19a70da29976b9_img.jpg) + +``` + +sequenceDiagram + participant UE + participant GGSN + participant BM-SC + + Note right of BM-SC: User Leave + UE->>GGSN: 1. UE Leave indication + GGSN->>BM-SC: 2. Session-Termination-Request [user/service] + BM-SC-->>GGSN: 3. Session-Termination-Answer [user/service] + GGSN->>UE: 4. MBMS UE Ctxt + Note right of BM-SC: User Deactivation + UE->>GGSN: 5. Delete MBMS Ctxt Req. + GGSN->>BM-SC: 6. Session-Termination-Request [user/service] + BM-SC-->>GGSN: 7. Session-Termination-Answer[user/service] + GGSN->>BM-SC: 8. Session-Termination-Request [service] + Note right of BM-SC: Conditional de-registration procedure (if it was the last user in this GGSN for this MBMS service) + BM-SC-->>GGSN: 9. Session-Termination-Answer[service] + +``` + +The diagram illustrates the MBMS Service deactivation procedure. It starts with a 'UE Leave indication' (1) from the UE to the GGSN. The GGSN sends a 'Session-Termination-Request [user/service]' (2) to the BM-SC. The BM-SC responds with a 'Session-Termination-Answer [user/service]' (3). The GGSN then sends an 'MBMS UE Ctxt' (4) to the UE. Next, the UE sends a 'Delete MBMS Ctxt Req.' (5) to the GGSN. The GGSN sends another 'Session-Termination-Request [user/service]' (6) to the BM-SC. The BM-SC responds with a 'Session-Termination-Answer[user/service]' (7). The GGSN then sends a 'Session-Termination-Request [service]' (8) to the BM-SC. Finally, the BM-SC responds with a 'Session-Termination-Answer[service]' (9). The diagram is divided into three phases: 'User Leave' (steps 1-4), 'User Deactivation' (steps 5-7), and 'Conditional de-registration procedure (if it was the last user in this GGSN for this MBMS service)' (steps 8-9). + +Sequence diagram of MBMS Service deactivation procedure between UE, GGSN, and BM-SC. + +Figure 32: MBMS Service deactivation procedure + +1. The UE sends an IGMP (IPv4) or MLD (IPv6) Leave message over the default PDP context to leave a particular multicast service identified by an IP multicast address. +2. The GGSN sends a STR to the BM-SC, indicating that the UE is requesting to leave the multicast service. The session to be terminated is uniquely identified by the Diameter session-id. +3. Upon reception of the STR, the BM-SC verifies that the IP multicast address corresponds to a valid MBMS bearer service and sends a STA to the GGSN that originated the Leave Indication. The APN shall be the same that was provided during service activation (see " Service Activation" procedure). + +4. Upon reception of the STA the GGSN sends an MBMS UE Context Deactivation Request to the SGSN. The IP multicast address, APN and IMSI together identify the MBMS UE Context to be deleted by the SGSN. The APN is the one received in step 3. +5. The GGSN receives a Delete MBMS Context Request (NSAPI). This GGSN may be different from the GGSN that receives IGMP Leave request in step 1. +6. The GGSN deletes the MBMS UE Context and sends a STR to the BM-SC to confirm the successful deactivation of the MBMS UE Context. +7. The BM-SC, then, deletes the MBMS UE Context and sends a confirmation to the GGSN in a STA message. +8. If the GGSN does not have any more users interested in this MBMS bearer service and the "list of downstream nodes" in the corresponding MBMS Bearer Context is empty, the GGSN initiates a De-Registration procedure as specified in 17.5.5. +9. The BM-SC confirms the operation by sending a STA message to the GGSN as specified in 17.5.5. + +### 17.5.7.1 BM-SC Initiated Multicast Service Deactivation + +This section defines the BM-SC initiated Multicast Service Deactivation procedure. + +![Sequence diagram for BM-SC initiated MBMS Service deactivation procedure. The diagram shows three messages between the GGSN and the BM-SC. 1. AS-Request [user/service] from BM-SC to GGSN. 2. AS-Answer [user/service] from GGSN to BM-SC. 3. MBMS UE Ctxt from GGSN to the left (towards SGSN). A dashed box labeled 'User Leave' is positioned to the right of the BM-SC, with a bracket grouping the first two messages.](629606c93e8d5f98d72a90044ef4b15a_img.jpg) + +``` + +sequenceDiagram + participant GGSN + participant BM-SC + Note right of BM-SC: User Leave + BM-SC->>GGSN: 1. AS-Request [user/service] + GGSN-->>BM-SC: 2. AS-Answer [user/service] + GGSN->>SGSN: 3. MBMS UE Ctxt + +``` + +Sequence diagram for BM-SC initiated MBMS Service deactivation procedure. The diagram shows three messages between the GGSN and the BM-SC. 1. AS-Request [user/service] from BM-SC to GGSN. 2. AS-Answer [user/service] from GGSN to BM-SC. 3. MBMS UE Ctxt from GGSN to the left (towards SGSN). A dashed box labeled 'User Leave' is positioned to the right of the BM-SC, with a bracket grouping the first two messages. + +**Figure 32a: BM-SC initiated MBMS Service deactivation procedure** + +1. The BM-SC sends an ASR to the GGSN, indicating that the UE shall be removed from the multicast service. The session to be terminated is uniquely identified by the Diameter session-id. +2. Upon reception of the ASR, the GGSN sends an ASA to the BM-SC +3. Upon reception of the ASR the GGSN sends an MBMS UE Context Deactivation Request to the SGSN. The IP multicast address, APN and IMSI together identify the MBMS UE Context to be deleted by the SGSN. + +Steps from 5 to 9 of figure 32 in section 17.5.7 follow. + +### 17.5.8 Trace Session Activation procedure + +The Trace Session Activation procedure occurs when the GGSN indicates to the BM-SC that a Trace Session needs to be activated. + +![Sequence diagram for Trace Session Activation procedure between GGSN and BM-SC.](93bd00a00fa28558486f0664550699b1_img.jpg) + +``` +sequenceDiagram + participant GGSN + participant BM-SC + Note right of GGSN: 1. AA-Request [Trace] + GGSN->>BM-SC: 1. AA-Request [Trace] + Note left of BM-SC: 2. AA-Answer [Trace] + BM-SC-->>GGSN: 2. AA-Answer [Trace] +``` + +Sequence diagram for Trace Session Activation procedure between GGSN and BM-SC. + +**Figure 33: Trace Session Activation procedure** + +1. When the GGSN has received a Trace Activation message from the SGSN, in a Create MBMS Context Request/Update MBMS Context Request, that requires the activation of a Trace Session in the BM-SC, the GGSN sends an AAR message (containing the IMSI and the Additional MBMS Trace Info AVPs) to activate a trace session in the BM-SC. +2. Upon reception of an AAR from a GGSN to activate a Trace Session, the BM-SC responds with an AAA message. + +### 17.5.9 Trace Session Deactivation procedure + +The Trace Session Deactivation procedure occurs when the GGSN indicates to the BM-SC that a Trace Session, previously activated, needs to be deactivated. + +![Sequence diagram for Trace Session Deactivation procedure between GGSN and BM-SC.](db184eff73ec14dc2dde56126813517f_img.jpg) + +``` +sequenceDiagram + participant GGSN + participant BM-SC + Note right of GGSN: 1. ST-Request [Trace] + GGSN->>BM-SC: 1. ST-Request [Trace] + Note left of BM-SC: 2. ST-Answer [Trace] + BM-SC-->>GGSN: 2. ST-Answer [Trace] +``` + +Sequence diagram for Trace Session Deactivation procedure between GGSN and BM-SC. + +**Figure 34: Trace Session Deactivation procedure** + +1. When the GGSN has received a Trace Deactivation message from the SGSN, in a Create MBMS Context Request/Update MBMS Context Request, that requires the deactivation of a Trace Session in the BM-SC, the GGSN sends a STR message (containing the Additional MBMS Trace Info AVP) to deactivate a trace session in the BM-SC and to tear down the corresponding Diameter Session previously established to activate the Trace Session. +2. Upon reception of an STR from a GGSN to deactivate a Trace Session, the BM-SC responds with an STA message. + +### 17.5.10 MBMS UE Context Modification Procedure + +During the multicast MBMS bearer service activation, the MBMS UE Context is stored in the BM-SC. Later, the MBMS UE Context shall be updated when the UE enters a new Routeing Area (RA) served by a new SGSN or the UE is transitioning between UTRAN and A/Gb mode GERAN or vice versa (Inter-system Intra-SGSN change). See 3GPP TS 23.246 [65] and 3GPP TS 29.060 [24]. GGSN shall pass the relevant data via the Gmb interface to enable the BM-SC to update its MBMS UE context accordingly. + +![Sequence diagram showing the modification of an MBMS UE Context in BM-SC. The diagram involves two entities: GGSN and BM-SC. The sequence of messages is: 1. Update MBMS Context Request from GGSN to BM-SC; 2. Update MBMS Context Response from BM-SC to GGSN; 3. AA-Request [user] from GGSN to BM-SC; 4. AA-Answer [user] from BM-SC to GGSN.](d22fb161d760fcf9fe3fb7b36f81c6fb_img.jpg) + +``` + +sequenceDiagram + participant GGSN + participant BM-SC + Note left of GGSN: 1. Update MBMS Context Request + GGSN->>BM-SC: 1. Update MBMS Context Request + Note right of BM-SC: 1. Update MBMS Context Response + BM-SC-->>GGSN: 1. Update MBMS Context Response + Note right of GGSN: 2. AA-Request [user] + GGSN->>BM-SC: 2. AA-Request [user] + Note right of BM-SC: 3. AA-Answer [user] + BM-SC-->>GGSN: 3. AA-Answer [user] + +``` + +Sequence diagram showing the modification of an MBMS UE Context in BM-SC. The diagram involves two entities: GGSN and BM-SC. The sequence of messages is: 1. Update MBMS Context Request from GGSN to BM-SC; 2. Update MBMS Context Response from BM-SC to GGSN; 3. AA-Request [user] from GGSN to BM-SC; 4. AA-Answer [user] from BM-SC to GGSN. + +**Figure 35; Modification of an MBMS UE Context in BM-SC** + +1. On request from SGSN, the MBMS UE Context is updated in the GGSN. +2. The GGSN sends updated MBMS UE Context parameters (RAI, and CGI/SAI as specified in clause 17.6.1) to BM-SC in an AAR message. +3. The BM-SC updates its MBMS UE Context fields and responds with an AAA message. + +If the GGSN receives new or updated trace information in step 1, then the above procedure may be followed by a Trace Session Activation procedure (see clause 17.5.8) or a Trace Session Deactivation procedure (see clause 17.5.9). + +## 17.5.11 Session Update Procedure + +The BM-SC initiates the MBMS session update procedure when the service area for an ongoing MBMS session shall be modified. This procedure is defined only for MBMS broadcast services. The MBMS session update procedure is initiated towards one or more of the GGSNs in the list of downstream nodes in the BM-SC, according to the changes in the service area. + +**NOTE:** In addition, when the MBMS Service Area for an ongoing broadcast session is changed in the BM-SC, then GGSN(s) may be added to, or removed from, the list of downstream nodes in the BM-SC. The BM-SC will initiate MBMS session start procedures or MBMS session stop procedures towards these GGSNs accordingly. + +The attributes that can be modified by the session update procedure are the MBMS Service Area, and the list of downstream nodes for GGSN. + +When a session update message is received, GGSN will update its MBMS Bearer Context accordingly and inform its downstream SGSNs of the changed MBMS service area. If a list of downstream SGSNs is included in the session update message, GGSN shall initiate a session start procedure towards the new downstream SGSNs, and a session stop procedure towards the SGSNs that have been removed from the list. + +![Sequence diagram for MBMS Session Update procedure. It shows two lifelines: GGSN and BM-SC. The BM-SC sends a '1. RAR (Update)' message to the GGSN. The GGSN responds with a '2. RAA (Update)' message to the BM-SC.](f4e5a86da5c799372a7c1ea2397dedb7_img.jpg) + +``` + +sequenceDiagram + participant BM-SC + participant GGSN + Note left of BM-SC: 1. RAR (Update) + BM-SC->>GGSN: 1. RAR (Update) + Note right of GGSN: 2. RAA (Update) + GGSN->>BM-SC: 2. RAA (Update) + +``` + +Sequence diagram for MBMS Session Update procedure. It shows two lifelines: GGSN and BM-SC. The BM-SC sends a '1. RAR (Update)' message to the GGSN. The GGSN responds with a '2. RAA (Update)' message to the BM-SC. + +**Figure 27a: MBMS Session Update procedure** + +1. The BM-SC sends a RAR message to the GGSNs that need to update its session attributes. +2. GGSN stores the updated session attributes in the MBMS Bearer Context, initiates session start, session stop or session update procedures towards the SGSNs in its list of downstream nodes and sends an RAA message to the BM-SC. An AAR message is not mandated for the Gmb application in response to a RAR-RAA command exchange. + +### 17.5.12 MBMS broadcast session termination (GGSN initiated) + +![Sequence diagram for Broadcast session termination (GGSN initiated). It shows two lifelines: GGSN and BM-SC. The GGSN sends a '1. ST-Request [service]' message to the BM-SC. The BM-SC responds with a '2. ST-Answer [service]' message to the GGSN.](bdbdf9152f5224e9ced4fc6f402fbe45_img.jpg) + +``` + +sequenceDiagram + participant GGSN + participant BM-SC + Note left of GGSN: 1. ST-Request [service] + GGSN->>BM-SC: 1. ST-Request [service] + Note right of BM-SC: 2. ST-Answer [service] + BM-SC->>GGSN: 2. ST-Answer [service] + +``` + +Sequence diagram for Broadcast session termination (GGSN initiated). It shows two lifelines: GGSN and BM-SC. The GGSN sends a '1. ST-Request [service]' message to the BM-SC. The BM-SC responds with a '2. ST-Answer [service]' message to the GGSN. + +**Figure 36: Broadcast session termination** + +1. In exceptional cases (e.g. resource pre-emption or timeout of the MBMS session), the GGSN may send an STR command to the BM-SC to initiate the termination of the Diameter session related to a broadcast MBMS bearer service. If a bearer plane had been established over Gi for this MBMS bearer service, the bearer plane is released. +2. The BM-SC removes the Diameter session and confirms the operation by sending an STA message to the GGSN. + +## 17.6 Gmb Messages + +This clause defines the Gmb interface Diameter messages. + +The relevant AVPs that are of use for the Gmb interface are detailed in this clause. Other Diameter NASREQ (IETF RFC 7155 [120]) AVPs, even if their AVP flag rules is marked with "M", are not required for being compliant with the current specification. + +All Gmb specific AVPs for Gmb are needed to be compliant to the Gmb interface unless otherwise stated. + +## 17.6.1 AAR Command + +The AAR command, defined in Diameter NASREQ (IETF RFC 7155 [120]), is indicated by the Command-Code field set to 265 and the 'R' bit set in the Command Flags field. It, is sent by the GGSN to the BM-SC to request user authorization (authorize the activating UE to receive Data) , to modify an MBMS UE Context in the BM-SC or to register the GGSN for a particular multicast MBMS bearer service. When used for these purposes, the Additional-MBMS-Trace-Info AVP shall not be included. + +When the AAR command is used by the GGSN to modify an MBMS UE context in the BM-SC, it shall include all the parameters that have been changed according to the triggering Update MBMS Context Request, ref. fig. 35. The inclusion of CGI/SAI in the 3GPP-User-Location-Info AVP shall be according to the rules detailed in subclause 15.1.1a in 3GPP TS 23.060 [3]. The Called-Station-Id AVP, Calling-Station-Id AVP, Framed-IP-Address AVP, Framed-IPv6-Prefix AVP and Framed-Interface-Id AVP shall not be included, + +The AAR command is also used when the GGSN needs to activate a Trace Session in the BM-SC. In this case the Called-Station-Id AVP, Calling-Station-Id AVP, Framed-IP-Address AVP, Framed-IPv6-Prefix AVP, Framed-Interface-Id AVP, and RAI AVP shall not be included. For more detailed description of Trace Session activation/deactivation procedures see 3GPP TS 32.422 [69]. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for Gmb, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 265, REQ, PXY > + < Session-Id > + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Request-Type } + [ Destination-Host ] + [ Called-Station-Id ] + [ Calling-Station-Id ] + [ Framed-IP-Address ] + [ Framed-IPv6-Prefix ] + [ Framed-Interface-Id ] + * [ Proxy-Info ] + * [ Route-Record ] + [ 3GPP-IMSI ] + [ RAI ] + [ 3GPP-IMEISV ] + [ 3GPP-RAT-Type ] + [ 3GPP-User-Location-Info ] + [ 3GPP-MS-TimeZone ] + [ Additional-MBMS-Trace-Info ] +``` + +The GGSN shall allocate a new Session-Id each time an AAR command is sent, except for the case when the AAR is sent to modify an existing MBMS UE Context in the BM-SC. + +A request for user authorisation for an MBMS bearer service is indicated by the presence of the MSISDN within the Calling-Station-Id AVP and the 3GPP-IMSI. Otherwise the request is for the GGSN to be authorised (i.e. registered) to receive the MBMS bearer service. The Framed-IPv6-Prefix AVP contains the IPv6 prefix of the multicast address identifying the MBMS bearer service. + +The Framed-Interface-Id AVP contains the IPv6 interface identifier of the multicast address identifying the MBMS bearer service. + +The Framed-IP-Address AVP contains the IPv4 multicast address identifying the MBMS bearer service. + +The Called-Station-Id AVP contains the Access Point Name (APN) on which the MBMS bearer service authorisation request was received. + +## 17.6.2 AAA Command + +The AAA command, defined in Diameter NASREQ (IETF RFC 7155 [120]), is indicated by the Command-Code field set to 265 and the 'R' bit cleared in the Command Flags field., It is sent by the BM-SC to the GGSN in response to the AAR command. + +When the AAA command is used to acknowledge an AAR that activated a Trace Session, the only Gmb specific AVP that shall be included is the 3GPP-IMSI AVP. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for Gmb, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 265, PXY > + < Session-Id > + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Proxy-Info ] + [ Alternative-APN ] + [ 3GPP-IMSI ] + [ TMGI ] + [ Required-MBMS-Bearer-Capabilities ] +``` + +## 17.6.3 STR Command + +The STR command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code field set to 275 and the 'R' bit set in the Command Flags field, It is sent by the GGSN to the BM-SC to terminate a DIAMETER session. + +A DIAMETER session for a multicast MBMS service is terminated when the last MBMS UE context for the MBMS bearer service is deleted. This informs the BM-SC that the GGSN would like to be deleted from the distribution tree of a particular MBMS bearer service (De-registration procedure). + +A DIAMETER session for an individual UE's multicast MBMS service authorisation is terminated when the UE has requested to the GGSN to leave the MBMS bearer service. + +A DIAMETER session for a broadcast MBMS service may be terminated by the GGSN in exceptional cases. + +The STR command is also used to deactivate a Trace Session previously activated in the BM-SC and to terminate the associated Diameter Session initiated by the AAR that activated the Trace session. The Gmb specific AVP Additonal-MBMS-Trace-Info shall be included in the STR command only in the case of a Trace Session deactivation. For more detailed description of Trace Session activation/deactivation procedures see 3GPP TS 32.422 [69]. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ Destination-Host ] + * [ Class ] + [ Origin-State-Id ] + * [ Proxy-Info ] +``` + +``` +* [ Route-Record ] +[ Additional-MBMS-Trace-Info ] +``` + +## 17.6.4 STA Command + +The STA command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field, is sent in response to an STR command (e.g. De-registration procedure). + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + * [ Class ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] +``` + +## 17.6.5 Re-Auth-Request Command + +The Re-Auth-Request (RAR) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 258 and the message flags' 'R' bit set. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for Gmb, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 258, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ Called-Station-Id ] + [ Framed-IP-Address ] + [ Framed-IPv6-Prefix ] + [ Framed-Interface-Id ] + [ MBMS-StartStop-Indication ] + [ MBMS-Service-Area ] + [ MBMS-Required-QoS ] + [ MBMS-Session-Duration ] + [ MBMS-Service-Type ] + [ MBMS-Counting-Information ] + [ MBMS-Session-Identity ] + [ MBMS-Session-Repetition-number ] + [ TMGI ] + * [ 3GPP-SGSN-Address ] ; broadcast case only + * [ 3GPP-SGSN-IPv6-Address ] ; broadcast case only + [ MBMS-2G-3G-Indicator ] + [ MBMS-Time-To-Data-Transfer ] + [ MBMS-User-Data-Mode-Indication ] + [ MBMS-BMSC-SSM-IP-Address ] + [ MBMS-BMSC-SSM-IPv6-Address ] + [ MBMS-Flow-Identifier ] + [ CN-IP-Multicast-Distribution ] + [ MBMS-HC-Indicator ] +``` + +``` +[ Origin-State-Id ] +* [ Proxy-Info ] +* [ Route-Record ] +``` + +The MBMS-StartStop-Indication AVP will indicate if the command is indicating an MBMS Session Start procedure, an MBMS Session Update procedure or an MBMS Session Stop procedure. + +The Diameter Session-Id is used in subsequent procedures to identify the corresponding MBMS session. + +In the multicast case, the BM-SC shall use the Diameter Session-Id that was received during the GGSN Registration procedure. In the broadcast case, the BM-SC shall allocate a Diameter Session-Id for the first RAR message that is used for the first MBMS Session Start procedure of the MBMS bearer service. Then this Diameter Session-Id will be used for the subsequent MBMS sessions of the same MBMS bearer service. The BM-SC will create a new Diameter Session-Id for a subsequent Session Start procedure if, in exceptional cases, the Diameter session for the MBMS bearer service has been deleted. + +BM-SC shall not initiate a new Session Start procedure for a certain MBMS bearer service until the previous MBMS session for that service has been stopped. + +For the MBMS Session Start procedure, RAR is sent by the BM-SC to the GGSN(s) that will deliver the MBMS service (e.g. in the multicast case these are the GGSNs that have previously registered for the corresponding multicast MBMS bearer service), when it is ready to send data. This is a request to activate all necessary bearer resources in the network for the transfer of MBMS data and to notify interested UEs of the imminent start of the transmission. For broadcast MBMS bearer services the RAR message contains either an IPv4 address or an IPv6 address for each participating SGSN. + +For the MBMS Session Update procedure, RAR is sent by the BM-SC in order for the GGSN(s) to update their session attributes. The updated MBMS-Service-Area AVP shall be included. The MBMS-StartStop-Indication AVP with the value UPDATE shall be included. The MBMS-Time-To-Data-Transfer with the value set to 0 shall be included. The MBMS-Session-Duration AVP shall be included to indicate the duration of the remaining part of the MBMS session. The 3GPP-SGSN-Address AVP and the 3GPP-SGSN-IPv6-Address AVP shall be included if the related lists of downstream nodes in the GGSN(s) have changed. The other bold marked AVPs shall be included as given by the previous, corresponding MBMS Session Start procedure. + +For the MBMS Session Stop procedure, RAR is sent by the BM-SC to the GGSN(s) when it considers the MBMS session to be terminated. The session is typically terminated when there is no more MBMS data expected to be transmitted for a sufficiently long period of time to justify a release of bearer plane resources in the network. + +For the MBMS Session Start procedure, the MBMS-Required-QoS indicates the QoS that is required for the MBMS bearer service for the actual MBMS session. The information of the MBMS-2G-3G-Indicator, the MBMS-Service-Area and the MBMS-Counting-Information is passed from BM-SC transparently through GGSN to the SGSN(s) that are relevant for the actual MBMS bearer service. + +According to 3GPP TS 23.246 [65], a specific MBMS bearer service is uniquely identified by its IP multicast address and an APN. For the MBMS Session Start procedure for broadcast MBMS bearer services, the following AVPs are included (either IPv4 or IPv6 address) to enable GGSN to relate incoming payload packets to the actual MBMS bearer service and distribute the packets to the downstream SGSNs related to this service: + +- The Framed-IPv6-Prefix AVP contains the IPv6 prefix of the multicast address. +- The Framed-Interface-Id AVP contains the IPv6 interface identifier of the multicast address. +- The Framed-IP-Address AVP contains the IPv4 multicast address. +- The Called-Station-Id AVP contains the Access Point Name (APN) for which the MBMS bearer service is defined. + +According to 3GPP TS 23.246 [65], the MBMS-Flow-Identifier is optional, used only for broadcast services with location dependent content. For such services, several sessions with the same TMGI, but different MBMS-Flow-Identifiers, may be going on in parallel. However, at any specific location only one version of the content may be available at any point in time. Hence, the MBMS-Service-Areas of the related MBMS bearer contexts shall not overlap. + +## 17.6.6 RE-Auth-Answer Command + +The Re-Auth-Answer (RAA) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 258 and the message flags' 'R' bit clear, is sent in response to the RAR. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for Gmb, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 258, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ MBMS-StartStop-Indication ] + [ MBMS-GGSN-Address ] ; for unicast encapsulated user data + [ MBMS-GGSN-IPv6-Address ] ; for unicast encapsulated user data + [ MBMS-GW-UDP-Port ] ; for unicast encapsulated user data + [ MBMS-User-Data-Mode-Indication ] + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirected-Host ] + [ Redirected-Host-Usage ] + [ Redirected-Host-Cache-Time ] + * [ Proxy-Info ] +``` + +If multicast user plane data are to be sent to the GGSN using IP unicast, the GGSN shall allocate an IP transport address and a separate UDP port for each MBMS bearer ( i.e the service uniquely identified by its TMGI and Flow ID and provided by the GPRS to deliver the same IP datagrams to multiple receivers in a designated location). The GGSN shall then use the destination unicast IP address and destination UDP port of user plane packets received over the Gi interface to determine on which MBMS bearer to forward the received user plane packet. + +## 17.6.7 Abort-Session-Request Command + +The Abort-Session-Request (ASR) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit set, is sent by the BM-SC to the GGSN to request that the session identified by the Session-Id be stopped. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format + +``` + ::= < Diameter Header: 274, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ Origin-State-Id ] + * [ Proxy-Info ] + * [ Route-Record ] +``` + +## 17.6.8 Abort-Session-Answer Command + +The Abort-Session-Answer (ASA) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit clear, is sent in response to the ASR. + +The relevant AVPs that are of use for the Gmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for Gmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +#### Message Format + +``` + ::= < Diameter Header: 274, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirected-Host ] + [ Redirected-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] +``` + +## 17.7 Gmb specific AVPs + +### 17.7.0 General + +Table 10 describes the Gmb specific Diameter AVPs. The Vendor-Id header of all Gmb specific AVPs defined in the present specification shall be set to 3GPP (10415). + +The Gmb specific AVPs require to be supported to be compliant to the present specification. All AVPs in table 10 are mandatory within Gmb interface unless otherwise stated. + +Table 10: Gmb specific AVPs + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | +|-----------------------------------|----------|----------------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| TMGI | 900 | 17.7.2 | OctetString | M,V | P | | | Y | +| Required-MBMS-Bearer-Capabilities | 901 | 17.7.3 | UTF8String | M,V | P | | | Y | +| MBMS-StartStop-Indication | 902 | 17.7.5 | Enumerated | M,V | P | | | Y | +| MBMS-Service-Area | 903 | 17.7.6 | OctetString | M,V | P | | | Y | +| MBMS-Session-Duration | 904 | 17.7.7 | OctetString | M,V | P | | | Y | +| 3GPP-IMSI | 1 | 16.4.7
(see Note) | UTF8String | M,V | P | | | Y | +| Alternative-APN | 905 | 17.7.8 | UTF8String | M,V | P | | | Y | +| MBMS-Service-Type | 906 | 17.7.9 | Enumerated | M,V | P | | | Y | +| 3GPP-SGSN-Address | 6 | 16.4.7
(see note) | OctetString | M, V | P | | | Y | +| 3GPP-SGSN-IPv6-Address | 15 | 16.4.7
(see note) | OctetString | M, V | P | | | Y | +| MBMS-2G-3G-Indicator | 907 | 17.7.10 | Enumerated | M, V | P | | | Y | +| MBMS-Session-Identity | 908 | 17.7.11 | OctetString | M,V | P | | | Y | +| RAI | 909 | 17.7.12 | UTF8String | M, V | P | | | Y | +| 3GPP-IMEISV | 20 | 16.4.7
(see Note) | OctetString | M,V | P | | | Y | +| 3GPP-RAT-Type | 21 | 16.4.7
(see Note) | OctetString | M,V | P | | | Y | +| 3GPP-User-Location-Info | 22 | 16.4.7
(see Note) | OctetString | M,V | P | | | Y | +| 3GPP-MS-TimeZone | 23 | 16.4.7
(see Note) | OctetString | M,V | P | | | Y | +| Additional-MBMS-Trace-Info | 910 | 17.7.13 | OctetString | M,V | P | | | Y | +| MBMS-Time-To-Data-Transfer | 911 | 17.7.14 | OctetString | M,V | P | | | Y | +| MBMS-Session-Repetition-Number | 912 | 17.7.15 | OctetString | M,V | P | | | Y | +| MBMS-Required-QoS | 913 | 17.7.16 | UTF8String | M,V | P | | | Y | +| MBMS-Counting-Information | 914 | 17.7.17 | Enumerated | M,V | P | | | Y | +| MBMS-User-Data-Mode-Indication | 915 | 17.7.18 | Enumerated | M,V | P | | | Y | +| MBMS-GGSN-Address | 916 | 17.7.19 | OctetString | M,V | P | | | Y | +| MBMS-GGSN-IPv6-Address | 917 | 17.7.20 | OctetString | M,V | P | | | Y | +| MBMS-BMSC-SSM-IP-Address | 918 | 17.7.21 | OctetString | M,V | P | | | Y | +| MBMS-BMSC-SSM-IPv6-Address | 919 | 17.7.22 | OctetString | M,V | P | | | Y | +| MBMS-Flow-Identifier | 920 | 17.7.23 | OctetString | M,V | P | | | Y | +| CN-IP-Multicast-Distribution | 921 | 17.7.24 | Enumerated | M,V | P | | | Y | +| MBMS-HC-Indicator | 922 | 17.7.25 | Enumerated | M,V | P | | | Y | + +NOTE: The use of Radius VSA as a Diameter vendor AVP is described in Diameter NASREQ (IETF RFC 7155 [120]) and the P flag may be set. + +Table 11 lists the set of Diameter AVPs that are not Gmb specific, but are reused from other Diameter applications by the Gmb interface. A reference is done to the specifications where the AVPs are specified. This set of AVPs requires to be supported to be compliant to the present specification. + +**Table 11: Gmb reused AVPs from other Diameter applications.** + +| AVP Name | Reference | +|---------------------|-----------------------------| +| Called-Station-Id | NASREQ, IETF RFC 7155 [120] | +| Calling-Station-Id | NASREQ, IETF RFC 7155 [120] | +| Framed-Interface-Id | NASREQ, IETF RFC 7155 [120] | +| Framed-IP-Address | NASREQ, IETF RFC 7155 [120] | +| Framed-IPv6-Prefix | NASREQ, IETF RFC 7155 [120] | + +NOTE: Diameter Base AVPs are not listed as support of them is mandated by IETF RFC 6733 [111]. + +### 17.7.1 3GPP-Vendor-Specific AVP + +Void. + +### 17.7.2 TMGI AVP + +The TMGI AVP (AVP code 900) is of type OctetString, and contains the Temporary Mobile Group Identity allocated to a particular MBMS bearer service. It is allocated by the BM-SC. The encoding of TMGI is specified in 3GPP TS 24.008 [54]. When allocating the TMGI, BM-SC shall always include the MCC and MNC in the TMGI. + +### 17.7.3 Required-MBMS-Bearer-Capabilities AVP + +The Required-MBMS-Bearer-Capabilities AVP (AVP code 901) is of type UTF8String, and contains the minimum bearer capabilities the UE needs to support. The information contained in this AVP is UTF-8 encoded MBMS bearer capabilities as defined in 3GPP TS 24.008 [54]. + +### 17.7.4 Void + +### 17.7.5 MBMS-StartStop-Indication AVP + +The MBMS-StartStop-Indication AVP (AVP code 902) is of type Enumerated. The following values are supported: + +START (0) + +The message containing this AVP is indicating an MBMS session start procedure. + +STOP (1) + +The message containing this AVP is indicating an MBMS session stop procedure. + +UPDATE (2) + +The message containing this AVP is indicating an MBMS session update procedure. + +HEARTBEAT (3) + +The message containing this AVP is indicating an MBMS heartbeat procedure. + +## 17.7.6 MBMS-Service-Area AVP + +The MBMS-Service-Area AVP (AVP code 903) is of type OctetString, and indicates the area over which the MBMS bearer service has to be distributed. The AVP consists of the following parts: + +| Octet | | +|----------|-----------------------------------------------------------------------------------------------------------------| +| 1 | Number N of MBMS service area codes coded as:
1 binary value is '00000000'
256 binary value is '11111111' | +| 2-(2N+1) | A consecutive list of N MBMS service area codes | + +The MBMS service area code represents the coding for the MBMS Service Area Identity. + +The MBMS Service Area Identity and its semantics are defined in subclause 15.3 of 3GPP TS 23.003 [40]. + +The length of an MBMS service area code is 2 octets. + +Each MBMS service area code shall only be present once in the list. + +## 17.7.7 MBMS-Session-Duration AVP + +The MBMS-Session-Duration AVP (AVP code 904) is of type OctetString with a length of three octets and indicates the estimated session duration (MBMS Service data transmission). Bit 8 of octet 1 to bit 8 of octet 3 (17 bits) express seconds, for which the maximum allowed value is 86400 seconds. Bits 7 to 1 of octet 3 (7 bits) express days, for which the maximum allowed value is 18 days. The coding is as follows (the 's' bits represent the seconds, the 'd' bits represent the days): + +| Octets | Bits | | | | | | | | +|--------|------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | s | s | s | s | s | s | s | s | +| 2 | s | s | s | s | s | s | s | s | +| 3 | s | d | d | d | d | d | d | d | + +For the whole session duration the seconds and days are added together and the maximum session duration is 19 days. + +The lowest value of this AVP (i.e. all 0's), is reserved to indicate an indefinite value to denote sessions that are expected to be always-on. + +## 17.7.8 Alternative-APN AVP + +The Alternative-APN AVP (AVP code 905) is of type UTF8String, and contains the value of a new APN. This AVP is optional within the Gmb interface. BM-SC only includes it if the UE must use a different APN for the MBMS PDP Context from the one used in the Join message. + +## 17.7.9 MBMS-Service-Type AVP + +The MBMS-Service-Type AVP (AVP code 906) is of type Enumerated, and contains explicit information about the type of service that the BM-SC Start Procedure is about to start. + +MULTICAST (0) + +The Start Procedure signalled by the BM-SC is for a Multicast Service. + +BROADCAST (1) + +The Start Procedure signalled by the BM-SC is for a Broadcast Service. + +## 17.7.10 MBMS-2G-3G-Indicator AVP + +The MBMS-2G-3G-Indicator AVP (AVP code 907) is of type Enumerated. It indicates whether the MBMS bearer service will be delivered in 2G- only, 3G- only or both coverage areas. The following values are supported: + +2G (0) + +The MBMS bearer service shall only be delivered in 2G only coverage areas. + +3G (1) + +The MBMS bearer service shall only be delivered in 3G only coverage areas. + +2G-AND-3G (2) + +The MBMS bearer service shall be delivered both in 2G and 3G coverage areas. + +## 17.7.11 MBMS-Session-Identity AVP + +The MBMS-Session-Identity AVP (AVP code 908) is of type OctetString. Its length is one octet. It is allocated by the BM-SC. Together with TMGI it identifies a transmission of a specific MBMS session. The initial transmission and subsequent retransmissions of the MBMS session will use the same values of these parameters. This AVP is optional within the Gmb interface. + +## 17.7.12 RAI AVP + +The RAI AVP (AVP Code 909) is of type UTF8String, and contains the Routing Area Identity of the SGSN where the UE is registered. RAI use and structure is specified in 3GPP TS 23.003 [40]. + +Its value shall be encoded as a UTF-8 string on either 11 (if the MNC contains two digits) or 12 (if the MNC contains three digits) octets as follows: + +- The MCC shall be encoded first using three UTF-8 characters on three octets, each character representing a decimal digit starting with the first MCC digit. +- Then, the MNC shall be encoded as either two or three UTF-8 characters on two or three octets, each character representing a decimal digit starting with the first MNC digit. +- The Location Area Code (LAC) is encoded next using four UTF-8 characters on four octets, each character representing a hexadecimal digit of the LAC which is two binary octets long. +- The Routing Area Code (RAC) is encoded last using two UTF-8 characters on two octets, each character representing a hexadecimal digit of the RAC which is one binary octet long. + +NOTE: As an example, a RAI with the following information: MCC=123, MNC=45, LAC=41655(0xA2C1) and RAC=10(0x0A) is encoded within the RAI AVP as a UTF-8 string of "12345A2C10A". + +## 17.7.13 Additional-MBMS-Trace-Info AVP + +The Additional-MBMS-Trace-Info AVP (AVP Code 910) is of type OctetString. This AVP contains Trace Reference2, Trace Recording Session Reference, Triggering Events in BM-SC, Trace Depth for BM-SC, List of interfaces in BM-SC, Trace Activity Control For BM-SC which are all part of the Additional MBMS Trace Info IE as specified in TS 29.060 [24]. + +## 17.7.14 MBMS-Time-To-Data-Transfer AVP + +The MBMS-Time-To-Data-Transfer AVP (AVP code 911) is of type OctetString. Its length is one octet. It indicates the expected time between reception of the MBMS Session Start (RAR(Start) command) and the commencement of the MBMS Data flow. The coding is specified as per the Time to MBMS Data Transfer Value Part Coding of the Time to MBMS Data Transfer IE in 3GPP TS 48.018 [70]. + +## 17.7.15 MBMS-Session-Repetition-Number AVP + +The MBMS-Session-Repetition-Number AVP (AVP code 912) is of type OctetString with a length of one octet. It contains the session identity repetition number of the MBMS transmission session on the Gmb interface. The value 0 indicates the first transmission of a session. The values 1 to 255 represents the retransmission sequence number of a session. When the optional MBMS-Session-Identity AVP is included in the MBMS Session Start RAR (Start) command by the BM-SC, the BM-SC shall also provide the corresponding MBMS-Session-Repetition-Number AVP, and vice versa. + +## 17.7.16 MBMS-Required-QoS AVP + +The MBMS-Required-QoS AVP (AVP code 913) is the quality of service required for the MBMS bearer service. It is specified as UTF8String with the following encoding: + +| Octet | | +|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Allocation/Retention Priority as specified in 3GPP TS 23.107 [71]. This octet encodes each priority level defined in 3GPP TS 23.107 [71] as the binary value of the priority level. It specifies the relative importance of the actual MBMS bearer service compared to other MBMS and non-MBMS bearer services for allocation and retention of the MBMS bearer service. | +| 2-N | QoS Profile as specified by the Quality-of-Service information element, from octet 3 onwards, in 3GPP TS 24.008 [54]. | + +## 17.7.17 MBMS-Counting-Information AVP + +The MBMS-Counting-Information AVP (AVP code 914) is of type Enumerated, and contains explicit information about whether the MBMS Counting procedures are applicable for the MBMS Service that is about to start. See 3GPP TS 25.346 [72]. + +This AVP is only valid for UTRAN access type. + +The following values are supported: + +### COUNTING-NOT-APPLICABLE (0) + +The MBMS Session Start Procedure signalled by the BM-SC is for a MBMS Service where MBMS Counting procedures are not applicable. + +### COUNTING-APPLICABLE (1) + +The MBMS Session Start Procedure signalled by the BM-SC is for a MBMS Service where MBMS Counting procedures are applicable. + +## 17.7.18 MBMS-User-Data-Mode-Indication AVP + +The MBMS-User-Data-Mode-Indication AVP (AVP code 915) is of type Enumerated. The meaning of the message containing this AVP depends on the sending entity. The absence of this AVP indicates unicast mode of operation. + +The following values are supported: + +### Unicast (0) + +When BM-SC sends this value, that indicates to GGSN that BM-SC supports only unicast mode (IP multicast packets encapsulated over UDP by IP unicast header). + +When GGSN sends this value, that indicates to BM-SC that BM-SC shall send user plane data with unicast mode (IP multicast packets encapsulated over UDP by IP unicast header). + +### Multicast and Unicast (1) + +When BM-SC sends this value, that indicates to GGSN that BM-SC supports both modes of operation. + +When GGSN sends this value, that indicates to BM-SC that BM-SC shall send user plane data with multicast mode. + +### 17.7.19 MBMS-GGSN-Address AVP + +The MBMS-GGSN-Address AVP (AVP code 916) is of type OctetString, and contains the value of GGSN's IPv4 address for user plane data. IPv4 only or dual stack GGSN includes this AVP in case BM-SC requests GGSN's user plane unicast address. + +### 17.7.20 MBMS-GGSN-IPv6-Address AVP + +The MBMS-GGSN-IPv6-Address AVP (AVP code 917) is of type OctetString, and contains the value of GGSN's IPv6 address for user plane data. Dual stack GGSN includes this AVP in case BM-SC requests GGSN's user plane unicast address. + +### 17.7.21 MBMS-BMSC-SSM-IP-Address AVP + +The MBMS-BMSC-SSM-IP-Address AVP (AVP code 918) is of type OctetString, and contains the value of BM-SC's IPv4 address for Source Specific Multicasting. IPv4 only or dual stack BM-SC includes this AVP. + +### 17.7.22 MBMS-BMSC-SSM-IPv6-Address AVP + +The MBMS-BMSC-SSM-IPv6-Address AVP (AVP code 919) is of type OctetString, and contains the value of BM-SC's IPv6 address for Source Specific Multicasting. Dual stack BM-SC includes this AVP. + +### 17.7.23 MBMS-Flow-Identifier AVP + +The MBMS-Flow-Identifier AVP (AVP code 920) is of type OctetString. Its length is two octets. It represents a location dependent subflow of a broadcast MBMS bearer service. When present, the MBMS-Flow-Identifier together with the TMGI uniquely identify an MBMS Bearer Context. + +### 17.7.24 CN-IP-Multicast-Distribution AVP + +CN-IP-Multicast-Distribution AVP (AVP code 921) is of type Enumerated. It represents an indication if IP multicast distribution to UTRAN should be used for the MBMS user plane data. The following values are supported: + +NO-IP-MULTICAST (0) + +Value 0 indicates that IP multicast distribution of MBMS user plane data to UTRAN shall not be used. + +IP-MULTICAST (1) + +Value 1 indicates that MBMS user plane data to UTRAN should be delivered by IP multicast mechanism. + +### 17.7.25 MBMS-HC-Indicator AVP + +MBMS-HC-Indicator AVP (AVP code 922) is of type Enumerated. It represents an indication if header compression is used by BM-SC when sending for MBMS user plane data. The enumeration values are defined in 3GPP TS 25.413 [92]. + +## 17.7a Gmb re-used AVPs + +Table 17.7a.1 lists the Diameter AVPs re-used by the Gmb reference point from other existing Diameter Application, reference to their respective specifications and short description of their usage within the Gmb reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 17.7a.1, but they are re-used for the Gmb reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where RADIUS VSAs are re-used, they shall be translated to Diameter AVPs as described in IETF RFC 7155 [120] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 17.7a.1: Gmb re-used Diameter AVPs** + +| Attribute Name | Reference | Description | +|------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------| +| MBMS-GW-UDP-Port | Clause 20.5a.5 | A transport layer UDP port allocated at the GGSN to receive multicast datagrams encapsulated in unicast IP/UDP encapsulation. | + +## 17.8 Gmb specific Experimental-Result-Code AVP values + +### 17.8.0 General + +There are two different types of errors in Diameter; protocol and application errors. A protocol error is one that occurs at the base protocol level, those are covered in the Diameter Base IETF RFC 6733 [111] specific procedures. Application errors, on the other hand, generally occur due to a problem with a function specified in a Diameter application. + +Diameter Base IETF RFC 6733 [111] defines a number of Result-Code AVP values that are used to report protocol errors and how those are used. Those procedures and values apply for the present specification. + +Due to the Gmb specific AVPs, new applications errors can occur. The Gmb specific errors are described by the Experimental-Result-Code AVP in this clause, below. Note that according to IETF RFC 6733 [111], the Diameter node reports only the first error encountered and only one Result-Code AVP or one Experimental-Result AVP is included in the Diameter answer. + +### 17.8.1 Success + +Resulting codes that fall within the Success category are used to inform a peer that a request has been successfully completed. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [111] are applicable. + +### 17.8.2 Permanent Failures + +Errors that fall within the Permanent Failures category are used to inform the peer that the request failed, and should not be attempted again. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [111] are applicable. Also the following specific Gmb Experimental-Result-Code values are defined for permanent failures: + +#### DIAMETER\_ERROR\_START\_INDICATION (5120) + +This error covers the case when a MBMS Session Start procedure could not be performed due to some of the required session attributes that are necessary to activate the bearer resources are missing (QoS, MBMS Service Area...). The Failed-AVP AVP must contain the missing AVP. + +#### DIAMETER\_ERROR\_STOP\_INDICATION (5121) + +An indication of session stop has been received with no session start procedure running. + +#### DIAMETER\_ERROR\_UNKNOWN\_MBMS\_BEARER\_SERVICE (5122) + +The requested MBMS service is unknown at the BM-SC. + +#### DIAMETER\_ERROR\_SERVICE\_AREA (5123) + +The MBMS service area indicated for a specific MBMS Bearer Service is unknown or not available. + +### 17.8.3 Transient Failures + +Errors that fall within the transient failures category are used to inform a peer that a request could not be satisfied at the time it was received, but it may be satisfied in the future. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [111] are applicable. Also the following specific Gmb Experimental-Result-Code value is defined for transient failures: + +DIAMETER\_ERROR\_OUT\_OF\_RESOURCES (4121) + +This error covers the case when a MBMS Session Start procedure could not be performed due to a temporary resource shortage in the GGSN. The BM-SC may re-try later. + +--- + +## 18 Usage of RADIUS at the Pk Reference Point + +### 18.1 General + +The Pk Reference Point is defined in 3GPP TS 23.141 [68] and allows the GGSN to report presence relevant events to the Presence Network Agent (such as PDP context activation/de-activation). This reference point is implemented using the mechanisms for Accounting of the RADIUS interface on the Gi reference point as defined in Clause 16. + +### 18.2 Radius Profile for Pk Reference Point + +The RADIUS interface on Gi reference point as defined in Clause 16 is used for the Pk Reference Point as clarified in the Profile in this Clause. + +Only the following messages are required for the Radius Profile for the Pk reference Point: + +- Accounting-Request START +- Accounting-Response START +- Accounting-Request STOP +- Accounting-Response STOP + +For the Radius Profile for the Pk Reference Point, only the mandatory Parameters within the Accounting-Request START and Accounting-Request STOP messages according to Clauses 16.4.3 and 16.4.4, respectively, and the Parameter "Calling-Station-Id" need to be supported. The usage of other parameters is optional. They may be ignored by the Presence Network Agent. + +### 18.3 Interconnecting the Presence Network Agent and the GGSN + +The Presence Network Agent may be directly attached to the GGSN or via a Radius Proxy. + +If the GGSN needs to connect both to an AAA server and a Presence Network Agent for the same APN, but supports only a single RADIUS interface, the GGSN can be directly attached to the AAA server. The Presence Network Agent can in turn be attached to the AAA server, which acts as a RADIUS proxy. If the AAA server is configured as a RADIUS Proxy between the Presence Network Agent and the GGSN, the Radius Profile for the Pk Reference Point shall be applicable on the interface between the Presence Network Agent and the AAA server. + +# 19 Usage of Diameter on Mz interface + +## 19.1 Introduction + +3GPP TS 23.246 [65] specifies that when MBMS bearers are used to provide MBMS user services to roaming users, three specific scenarios are used. + +One uses a GGSN in the Home PLMN, which is not related to Mz interface. The other two are enabled by use of the Mz interface for multicast services and are further described below. + +Mz is the roaming variant of the Gmb reference point with the same functionality as described under Gmb, i.e. with MBMS bearer and user specific signalling. The support of Mz with in BM-SC is needed for MBMS roaming scenario. Mz interface is defined between the visited BM-SC and the home BM-SC. + +MBMS bearer and user specific Mz signalling is used between a BM-SC in the visited PLMN and a BM-SC in the home PLMN when MBMS services from the home PLMN are offered by the visited PLMN. + +User specific signalling is used between a BM-SC in the visited PLMN and a BM-SC in the home PLMN when the visited PLMN offers MBMS user service to roaming users. This user specific Mz signalling provides home PLMN authorisation for MBMS user service that are provided by the visited PLMN. + +Mz may use proxy capabilities as described for Gmb, e.g. to proxy signalling between BM-SCs. + +## 19.2 Call flows in roaming scenarios + +The procedures described in clause 17 of the present specification: Session Start procedure (clause 17.5.2), Session Stop procedure (clause 17.5.3), Registration procedure (clause 17.5.4), De-registration procedure (GGSN initiated) (clause 17.5.5), De-registration procedure (BM-SC initiated) (clause 17.5.6), Trace Session Activation procedure (clause 17.5.8), Trace Session Deactivation procedure (clause 17.5.9), MBMS UE Context Modification procedure (clause 17.5.10), and Session Update procedure (clause 17.5.11) work exactly the same in roaming scenarios, i.e. when the GGSN is in a visited PLMN and the BM-SC is in the home PLMN, and they are Gmb procedures only and are not needed over Mz interface. + +Service activation procedures and Service deactivation procedures are the only procedures over Mz interface, and are described in detail in the following subclauses. + +### 19.2.1 Service activation + +#### 19.2.1.1 Service Provided by the BM-SC in Home PLMN + +A visited PLMN may offer to roaming users MBMS user services from their home PLMN. For this case, the PDP connection, which will be used for the JOIN step, may be from the UE to the visited GGSN due to operator policy or routing optimization. Then the authorization is done in the BM-SC in visited PLMN with the authorization information retrieved from the BM-SC in home PLMN. + +Whether GGSN of home or visited PLMN would be used is based on the operator policy, or agreement between PLMNs. + +The MBMS user traffic is provided by the BM-SC in home PLMN and proxied. + +![Sequence diagram showing the activation of an MBMS multicast service in a roaming scenario. The diagram involves four main entities: Visited GGSN, BM-SC in Visited PLMN, BM-SC in Home PLMN, and GGSN. The process starts with an IGMP/MLD Join Message to the Visited GGSN. The Visited GGSN sends an AA-Request [user/service] to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN sends an AA-Answer [user/service] back to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Answer [user/service] back to the Visited GGSN. A dashed box labeled 'User Authorization' groups the AA-Request and AA-Answer messages between the two BM-SCs. Next, a 'Create MBMS Ctxt' message is sent to the GGSN. The GGSN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN sends an AA-Answer [user/service] back to the GGSN. Another dashed box labeled 'User Authorization' groups the AA-Request and AA-Answer messages between the GGSN and the BM-SC in Home PLMN.](c15cb6383bc35906e6b3c7c3aac621ed_img.jpg) + +``` + +sequenceDiagram + participant Visited GGSN + participant BM-SC in Visited PLMN + participant BM-SC in Home PLMN + participant GGSN + + Note left of Visited GGSN: IGMP/MLD Join Message + Visited GGSN->>BM-SC in Visited PLMN: 1. AA-Request [user/service] + BM-SC in Visited PLMN->>BM-SC in Home PLMN: 2. AA-Request [user/service] + Note right of BM-SC in Home PLMN: User Authorization + BM-SC in Home PLMN-->>BM-SC in Visited PLMN: 3. AA-Answer [user/service] + BM-SC in Visited PLMN-->>Visited GGSN: 4. AA-Answer [user/service] + + Note left of GGSN: Create MBMS Ctxt + GGSN->>BM-SC in Home PLMN: 5. AA-Request [user/service] + Note right of BM-SC in Home PLMN: User Authorization + BM-SC in Home PLMN-->>GGSN: 6. AA-Answer [user/service] + +``` + +Sequence diagram showing the activation of an MBMS multicast service in a roaming scenario. The diagram involves four main entities: Visited GGSN, BM-SC in Visited PLMN, BM-SC in Home PLMN, and GGSN. The process starts with an IGMP/MLD Join Message to the Visited GGSN. The Visited GGSN sends an AA-Request [user/service] to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN sends an AA-Answer [user/service] back to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Answer [user/service] back to the Visited GGSN. A dashed box labeled 'User Authorization' groups the AA-Request and AA-Answer messages between the two BM-SCs. Next, a 'Create MBMS Ctxt' message is sent to the GGSN. The GGSN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN sends an AA-Answer [user/service] back to the GGSN. Another dashed box labeled 'User Authorization' groups the AA-Request and AA-Answer messages between the GGSN and the BM-SC in Home PLMN. + +**Figure 28: Activation of an MBMS multicast service in roaming scenario with service provided in the home PLMN** + +1. The GGSN sends an AAR to the BM-SC in visited PLMN seeking authorization for the activating roaming UE to receive data from a particular service. +2. The BM-SC in visited PLMN finds the BM-SC in home PLMN which will serve the roaming UE based on the multicast IP address, and identity of the user, and sends the AAR to it for the roaming UE to receive data from a particular service. +3. The authorization decision is provided from BM-SC in home PLMN in the AAA to BM-SC in visited PLMN. An APN may be included in the signalling between BM-SCs, which indicates a GGSN in home PLMN which will serve the UE for the specific MBMS service. The BM-SC in the visit network may modify the APN based on the operator policy or agreement between PLMNs. +4. The authorization decision, as received from BM-SC in home PLMN, is provided in the AAA to GGSN together with the APN to be used for creation of the MBMS UE Context If the AAA indicates that the roaming UE is not authorized to receive the MBMS data the process terminates with no additional message exchange. + +Whether GGSN of home or visited PLMN would be used is based on the operator policy, or agreement between PLMNs, for example, the visited BM-SC may modify the APN from the home BM-SC according to configuration of operator policy. + +5. The GGSN sends an AAR seeking authorization for the activating UE to BM-SC in home PLMN. This GGSN may be different from the GGSN that receives IGMP join message. +6. The authorization decision is provided in the AAA to GGSN. + +### 19.2.1.2 Service Provided by the BM-SC in visited PLMN + +When visited and home PLMN support the same classes of MBMS user services, a visited PLMN may offer its own MBMS user services to roaming users. In this case, the authorization is done in the BM-SC in visited PLMN with the authorization information retrieved from the BM-SC in home PLMN. Then the MBMS user traffic is provided by the BM-SC in visited PLMN. + +![Sequence diagram showing the activation of an MBMS multicast service in a roaming scenario with service provided in the visited PLMN. The diagram involves three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with an IGMP/MLD Join Message from an external source to the Visited GGSN. The Visited GGSN then sends an AA-Request [user/service] to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN responds with an AA-Answer [user/service] to the BM-SC in Visited PLMN, which in turn sends an AA-Answer [user/service] to the Visited GGSN. A dashed box labeled 'User Authorization' groups the interaction between the two BM-SCs. Below this, a 'Create MBMS Ctxt' message is sent to the Visited GGSN. The Visited GGSN sends another AA-Request [user/service] to the BM-SC in Visited PLMN, which responds with an AA-Answer [user/service]. Another dashed box labeled 'User Authorization' groups this interaction.](2f108a589e99e93fd7aa8fac626398c7_img.jpg) + +``` + +sequenceDiagram + participant External + participant VisitedGGSN as Visited GGSN + participant BMSC_Visited as BM-SC in Visited PLMN + participant BMSC_Home as BM-SC in Home PLMN + + Note right of BMSC_Home: User Authorization + External->>VisitedGGSN: IGMP/MLD Join Message + VisitedGGSN->>BMSC_Visited: 1. AA-Request [user/service] + BMSC_Visited->>BMSC_Home: 2. AA-Request [user/service] + BMSC_Home-->>BMSC_Visited: 3. AA-Answer [user/service] + BMSC_Visited-->>VisitedGGSN: 4. AA-Answer [user/service] + + Note right of BMSC_Home: User Authorization + External->>VisitedGGSN: Create MBMS Ctxt + VisitedGGSN->>BMSC_Visited: 5. AA-Request [user/service] + BMSC_Visited-->>VisitedGGSN: 6. AA-Answer [user/service] + +``` + +Sequence diagram showing the activation of an MBMS multicast service in a roaming scenario with service provided in the visited PLMN. The diagram involves three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with an IGMP/MLD Join Message from an external source to the Visited GGSN. The Visited GGSN then sends an AA-Request [user/service] to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an AA-Request [user/service] to the BM-SC in Home PLMN. The BM-SC in Home PLMN responds with an AA-Answer [user/service] to the BM-SC in Visited PLMN, which in turn sends an AA-Answer [user/service] to the Visited GGSN. A dashed box labeled 'User Authorization' groups the interaction between the two BM-SCs. Below this, a 'Create MBMS Ctxt' message is sent to the Visited GGSN. The Visited GGSN sends another AA-Request [user/service] to the BM-SC in Visited PLMN, which responds with an AA-Answer [user/service]. Another dashed box labeled 'User Authorization' groups this interaction. + +**Figure 29a: Activation of an MBMS multicast service in roaming scenario with service provided in the visited PLMN** + +1. The GGSN sends an AAR to the BM-SC in visited PLMN seeking authorization information for the activating roaming UE to receive data from a particular service. +2. The BM-SC in visited PLMN finds the BM-SC in home PLMN which have the authorization information for the roaming UE based on the multicast IP address, and identity of the user, and sends the AAR to it for the roaming UE to receive authorization from a particular service. +3. The authorization decision is provided from BM-SC in home PLMN in the AAA to BM-SC in visited PLMN. +4. The authorization decision, as received from BM-SC in home PLMN, is provided in the AAA to GGSN together with the APN to be used for creation of the MBMS UE Context If the AAA indicates that the roaming UE is not authorized to receive the MBMS data the process terminates with no additional message exchange. +5. The GGSN sends an AAR seeking authorization for the activating UE to BM-SC in visited PLMN. This GGSN may be different from the GGSN that receives IGMP join message. +6. The authorization decision is provided in the AAA to GGSN. + +## 19.2.2 Service deactivation + +### 19.2.2.1 Service Provided by the BM-SC in home PLMN + +![Sequence diagram for MBMS service deactivation in a roaming scenario. The diagram shows three main entities: GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with a 'UE Leave indication' from the UE to the GGSN. The GGSN sends an 'ST-Request [user/service]' to the BM-SC in Visited PLMN. This BM-SC then sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN. The Home PLMN BM-SC responds with an 'ST-Answer [user/service]' to the Visited PLMN BM-SC, which in turn sends an 'ST-Answer [user/service]' back to the GGSN. This sequence is grouped as 'User Leave'. Next, the GGSN sends a 'Delete MBMS Ctx Req.' to the BM-SC in Visited PLMN. The Visited PLMN BM-SC sends an 'ST-Request [user/service]' to the Home PLMN BM-SC, which responds with an 'ST-Answer [user/service]'. This second sequence is grouped as 'User Deactivation'.](cdcbafff3cef7d54a001e3d0a4d9841e_img.jpg) + +``` + +sequenceDiagram + participant UE + participant GGSN + participant BM-SC_Visited as BM-SC in Visited PLMN + participant BM-SC_Home as BM-SC in Home PLMN + + Note right of BM-SC_Home: User Leave + UE->>GGSN: UE Leave indication + GGSN->>BM-SC_Visited: 1. ST-Request [user/service] + BM-SC_Visited->>BM-SC_Home: 2. ST-Request [user/service] + BM-SC_Home-->>BM-SC_Visited: 3. ST-Answer [user/service] + BM-SC_Visited-->>GGSN: 4. ST-Answer [user/service] + + Note right of BM-SC_Home: User Deactivation + GGSN->>BM-SC_Visited: Delete MBMS Ctx Req. + BM-SC_Visited->>BM-SC_Home: 5. ST-Request [user/service] + BM-SC_Home-->>BM-SC_Visited: 6. ST-Answer [user/service] + +``` + +Sequence diagram for MBMS service deactivation in a roaming scenario. The diagram shows three main entities: GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with a 'UE Leave indication' from the UE to the GGSN. The GGSN sends an 'ST-Request [user/service]' to the BM-SC in Visited PLMN. This BM-SC then sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN. The Home PLMN BM-SC responds with an 'ST-Answer [user/service]' to the Visited PLMN BM-SC, which in turn sends an 'ST-Answer [user/service]' back to the GGSN. This sequence is grouped as 'User Leave'. Next, the GGSN sends a 'Delete MBMS Ctx Req.' to the BM-SC in Visited PLMN. The Visited PLMN BM-SC sends an 'ST-Request [user/service]' to the Home PLMN BM-SC, which responds with an 'ST-Answer [user/service]'. This second sequence is grouped as 'User Deactivation'. + +**Figure 30a: Deactivation of an MBMS multicast service in roaming scenario with service provided in the home PLMN** + +1. Upon receiving the leave indication, the GGSN sends an STR to the BM-SC in visited PLMN, indicating that the roaming UE is requesting to leave the multicast service. The session to be terminate is uniquely identified by the Diameter session-id. +2. Upon reception of the STR, the BM-SC in visited PLMN finds the BM-SC in home PLMN which serves the roaming UE, and sends an STR to it for the roaming UE to deactivate a particular service. +3. Upon reception of the STR, the BM-SC in home PLMN verifies that the IP multicast address corresponds to a valid MBMS bearer service and responds the BM-SC in visited PLMN with an ST-Answer. The APN shall be the same that was provided during service activation. +4. Upon reception of the STA, the BM-SC in visited PLMN sends an STA to the GGSN that originated the Leave Indication. +5. The GGSN which is used to establish the MBMS bearer service deletes the MBMS UE Context and sends an STR to the BM-SC in home PLMN to confirm the successful deactivation of the MBMS UE Context. +6. The BM-SC in home PLMN then, deletes the MBMS UE Context and sends a confirmation to the GGSN in an STA message. + +## 19.2.2.2 Service Provided by the BM-SC in visited PLMN + +![Sequence diagram showing the deactivation of an MBMS multicast service in a roaming scenario. The diagram involves three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with a 'UE Leave indication' to the Visited GGSN. The Visited GGSN sends an 'ST-Request [user/service]' to the BM-SC in Visited PLMN. This BM-SC then sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN. The BM-SC in Home PLMN responds with an 'ST-Answer [user/service]' to the BM-SC in Visited PLMN, which in turn sends an 'ST-Answer [user/service]' to the Visited GGSN. A dashed box labeled 'User Leave' groups the messages between the Visited GGSN and the BM-SC in Visited PLMN. After a break in the sequence (indicated by double slashes), the Visited GGSN sends a 'Delete MBMS Ctxt Req.' to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN, which responds with an 'ST-Answer [user/service]'. A dashed box labeled 'User Deactivation' groups the messages between the Visited GGSN and the BM-SC in Visited PLMN.](18b87e4ce7ef441f5620b8d6539a2939_img.jpg) + +``` + +sequenceDiagram + participant UE + participant Visited GGSN + participant BM-SC in Visited PLMN + participant BM-SC in Home PLMN + + Note right of BM-SC in Home PLMN: User Leave + UE->>Visited GGSN: UE Leave indication + Visited GGSN->>BM-SC in Visited PLMN: 1. ST-Request [user/service] + BM-SC in Visited PLMN->>BM-SC in Home PLMN: 2. ST-Request [user/service] + BM-SC in Home PLMN-->>BM-SC in Visited PLMN: 3. ST-Answer [user/service] + BM-SC in Visited PLMN-->>Visited GGSN: 4. ST-Answer [user/service] + + Note right of BM-SC in Home PLMN: User Deactivation + Visited GGSN->>BM-SC in Visited PLMN: Delete MBMS Ctxt Req. + Visited GGSN->>BM-SC in Visited PLMN: 5. ST-Request [user/service] + BM-SC in Visited PLMN->>BM-SC in Home PLMN: 5. ST-Request [user/service] + BM-SC in Home PLMN-->>BM-SC in Visited PLMN: 6. ST-Answer [user/service] + BM-SC in Visited PLMN-->>Visited GGSN: 6. ST-Answer [user/service] + +``` + +Sequence diagram showing the deactivation of an MBMS multicast service in a roaming scenario. The diagram involves three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The process starts with a 'UE Leave indication' to the Visited GGSN. The Visited GGSN sends an 'ST-Request [user/service]' to the BM-SC in Visited PLMN. This BM-SC then sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN. The BM-SC in Home PLMN responds with an 'ST-Answer [user/service]' to the BM-SC in Visited PLMN, which in turn sends an 'ST-Answer [user/service]' to the Visited GGSN. A dashed box labeled 'User Leave' groups the messages between the Visited GGSN and the BM-SC in Visited PLMN. After a break in the sequence (indicated by double slashes), the Visited GGSN sends a 'Delete MBMS Ctxt Req.' to the BM-SC in Visited PLMN. The BM-SC in Visited PLMN sends an 'ST-Request [user/service]' to the BM-SC in Home PLMN, which responds with an 'ST-Answer [user/service]'. A dashed box labeled 'User Deactivation' groups the messages between the Visited GGSN and the BM-SC in Visited PLMN. + +**Figure 31a: Deactivation of an MBMS multicast service in roaming scenario with service provided in the visited PLMN** + +1. Upon receiving the leave indication, the GGSN sends an STR to the BM-SC in visited PLMN, indicating that the roaming UE is requesting to leave the multicast service. The session to be terminate is uniquely identified by the Diameter session-id. +2. Upon reception of the STR, the BM-SC in visited PLMN verifies that the IP multicast address corresponds to a valid MBMS bearer service and sends an STR to the BM-SC in home PLMN. +3. The BM-SC in home PLMN responds the BM-SC in visited PLMN with an ST-Answer. +4. Upon reception of the STA, the BM-SC in visited PLMN sends an STA to the GGSN that originated the Leave Indication. The APN shall be the same that was provided during service activation. +5. The GGSN deletes the MBMS UE Context and sends an STR to the BM-SC in visited PLMN to confirm the successful deactivation of the MBMS UE Context. +6. The BM-SC in visited PLMN, then, deletes the MBMS UE Context and sends a confirmation to the GGSN in an STA message. + +### 19.2.2.3 BM-SC in the home PLMN initiated multicast service deactivation + +This section defines the BM-SC in the home PLMN initiated multicast service deactivation procedure. + +![Sequence diagram for BM-SC in the home PLMN initiated MBMS multicast service deactivation procedure. The diagram shows three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The sequence of messages is: 1. AS-Request [user/service] from Home PLMN to Visited PLMN; 2. AS-Request [user/service] from Visited PLMN to Visited GGSN; 3. AS-Answer [user/service] from Visited GGSN to Visited PLMN; 4. AS-Answer [user/service] from Visited PLMN to Home PLMN; 5. MBMS UE Context Deactivation Request from Visited GGSN to Visited PLMN. A bracket on the right side of the diagram, spanning steps 1 through 4, is labeled 'User Leave'.](8fce89f02626b8a0c50e2245bc3e7ce7_img.jpg) + +Sequence diagram for BM-SC in the home PLMN initiated MBMS multicast service deactivation procedure. The diagram shows three main entities: Visited GGSN, BM-SC in Visited PLMN, and BM-SC in Home PLMN. The sequence of messages is: 1. AS-Request [user/service] from Home PLMN to Visited PLMN; 2. AS-Request [user/service] from Visited PLMN to Visited GGSN; 3. AS-Answer [user/service] from Visited GGSN to Visited PLMN; 4. AS-Answer [user/service] from Visited PLMN to Home PLMN; 5. MBMS UE Context Deactivation Request from Visited GGSN to Visited PLMN. A bracket on the right side of the diagram, spanning steps 1 through 4, is labeled 'User Leave'. + +**Figure 32b: BM-SC in the home PLMN initiated MBMS multicast service deactivation procedure** + +1. The BM-SC in home PLMN sends an ASR to the BM-SC in visited PLMN, indicating that the UE shall be removed from a specific multicast service. The session to be terminated is uniquely identified by the Diameter session-id. +2. The BM-SC in the visited PLMN sends an ASR to the GGSN indicating that the UE shall be removed from the multicast service. The session to be terminated is uniquely identified by the Diameter session-id. +3. Upon reception of the ASR, the GGSN sends an ASA to the BM-SC in visited PLMN. +4. Upon reception of the ASA, the BM-SC in visited PLMN sends an ASA to the BM-SC in home PLMN. +5. Upon reception of the ASR in step 3, the GGSN sends an MBMS UE Context Deactivation Request to the SGSN. The IP multicast address, APN and IMSI together identify the MBMS UE Context to be deleted by the SGSN. + +Steps 5 and 6 of Figure 30a in section 19.2.2.1 follows in roaming scenarios where service was provided in the home PLMN. + +Steps 5 and 6 of Figure 31a in section 19.2.2.2 follows in roaming scenarios where service was provided in the visited PLMN. + +## 19.3 Mz messages + +This clause defines the Mz interface Diameter messages. + +The Diameter messages used in the Mz protocol, are the same as specified for Gmb interface described in Clause 17 of the present specification: AAR Command (clause 17.6.1), AAA Command (clause 17.6.2), STR Command (clause 17.6.3), STA Command (clause 17.6.4), Abort-Session-Request Command (clause 17.6.7) and Abort-Session-Answer Command (17.6.8). + +To route Diameter messages from the visited PLMN to the home PLMN, the BM-SC in the visited PLMN shall derive the realm of the home PLMN from the user's IMSI. The way to derive the realm of the home PLMN from IMSI is specified in 3GPP TS 23.003 [40] subclause 15.4. + +The derived realm of the home PLMN shall be filled in the Destination-Realm AVP of messages sent from the visited PLMN to the home PLMN, i.e. AAR command, STR command. + +## 19.4 Mz specific AVPs + +The Mz specific AVPs are the same as specified in Table 10 and Table 11. The Vendor-Id header of all Mz specific AVPs defined in the present specification shall be set to 3GPP (10415). + +## 19.5 Mz specific Experimental-Result-Code AVP values + +There are two different types of errors in Diameter; protocol and application errors. A protocol error is one that occurs at the base protocol level, those are covered in the Diameter Base IETF RFC 6733 [111] specific procedures. Application errors, on the other hand, generally occur due to a problem with a function specified in a Diameter application. + +Diameter Base IETF RFC 6733 [111] defines a number of Result-Code AVP values that are used to report protocol errors and how those are used. Those procedures and values apply for the present specification. + +Note that according to IETF RFC 6733 [111], the Diameter node reports only the first error encountered and only one Result-Code AVP or one Experimental-Result AVP is included in the Diameter answer. + +### 19.5.1 Success + +The success result codes specified in clause 17.8.1 of the present specification are applicable for Mz. + +### 19.5.2 Permanent Failures + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [111] are applicable. Also the following specific Gmb Experimental-Result-Code value defined in clause 17.8.2 is applicable for Mz: + +DIAMETER\_ERROR\_UNKNOWN\_MBMS\_BEARER\_SERVICE (5122) + +The requested MBMS service is unknown at the BM-SC. + +### 19.5.3 Transient Failures + +Errors that fall within the transient failures category are used to inform a peer that a request could not be satisfied at the time it was received, but it may be satisfied in the future. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [111] are applicable. + +--- + +## 20 Usage of Diameter on SGmb interface + +### 20.1 General + +Signalling between MBMS GW and BM-SC is exchanged at SGmb reference point. + +The MBMS GW uses the SGmb interface: + +- to receive indication of session start, session update and session stop messages, which shall cause the MBMS GW, MME/SGSN and E-UTRAN/UTRAN to set up/tear down the appropriate resources for the service. For further details, see 3GPP TS 23.246 [65]; +- to enable the BM-SC and MBMS GW to detect an SGmb path failure or the restart of the peer MBMS node. For further details, see 3GPP TS 23.007 [104]. +- to enable the BM-SC to transfer the M1 interface information of local MBMS information. For further details, see 3GPP TS 23.285 [112]. + +NOTE: The localized MBMS architecture refers to Annex B of 3GPP TS 23.285 [112]. + +The SGmb application is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. The SGmb application identifier value assigned by IANA is 16777292. + +The SGmb application identifier value shall be included in the Auth-Application-Id AVP. + +The BM-SC and the MBMS GW shall advertise the support of the SGmb application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands as specified in IETF RFC 6733 [111], i.e. as part of the Vendor-Specific-Application-Id AVP. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol. + +## 20.2 MBMS session start / update/ stop + +The MBMS session start shall be used by the BM-SC to trigger the bearer resource establishment and announce the arrival of data for a MBMS bearer service (along with the attributes of the data to be delivered e.g. QoS, MBMS service area, or MBMS-Cell-List) to every MBMS GW that will deliver the MBMS bearer service. + +The MBMS session update shall be used by the BM-SC to trigger the update of MBMS session attributes in the affected MBMS GWs. The attributes that can be modified are the MBMS service area, the MBMS-Cell-List and the list of MBMS control plane nodes (MMEs, SGSNs). + +The MBMS session stop shall be used by the BM-SC to indicate the end of the data stream for an MBMS bearer service to every MBMS GW that has been delivering the MBMS bearer service. + +## 20.2A MBMS heartbeat + +The MBMS heartbeat procedure enables the BM-SC and MBMS GW to detect an SGmb path failure or the restart of the peer MBMS node, as specified in 3GPP TS 23.007 [104]. + +The use of this procedure shall be negotiated between the BM-SC and MBMS GW upon contacting the peer node for the first time. + +NOTE: The MBMS Heartbeat procedure however applies per (BM-SC, MBMS GW) pair, i.e. not per MBMS session. + +When this procedure is applied, the BM-SC and MBMS GW shall detect an SGmb path failure or the restart of the peer MBMS node as specified in clause 29 of 3GPP TS 23.007 [104]. + +The BM-SC and MBMS GW shall maintain a local restart counter which shall be incremented monotonically whenever the MBMS node restarts with loss of previous states. + +The MBMS heartbeat message shall include the Restart Counter AVP set to the local restart counter of the sending node. The Restart-Counter AVP may also be included in any other SGmb messages e.g. if contacting the peer node for the first time or if the local restart counter has been incremented. + +## 20.3 Message flows + +### 20.3.1 Session start procedure + +The BM-SC initiates the MBMS session start procedure when it is ready to send data. This informs the MBMS GW of the imminent start of the transmission and MBMS session attributes are provided to the MBMS GWs included in the list of downstream nodes in BM-SC. The bearer plane is allocated. + +BM-SC and MBMS GW shall at least support IP unicast encapsulation of IP multicast datagrams, which shall be default mode of sending user plane data. BM-SC may support IP multicast encapsulation of user plane IP multicast datagrams and MBMS GW also may support this mode of operation. + +![Sequence diagram of MBMS Session Start procedure. It shows two lifelines: MBMS GW and BM-SC. Step 1: BM-SC sends a RAR (Start) message to MBMS GW. Step 2: MBMS GW sends a RAA (Start) message to BM-SC.](e01c6273c4177746475715ee9c17a882_img.jpg) + +``` + +sequenceDiagram + participant BM-SC + participant MBMS_GW as MBMS GW + Note right of BM-SC: 1. RAR (Start) + BM-SC->>MBMS_GW: RAR (Start) + Note left of MBMS_GW: 2. RAA (Start) + MBMS_GW->>BM-SC: RAA (Start) + +``` + +Sequence diagram of MBMS Session Start procedure. It shows two lifelines: MBMS GW and BM-SC. Step 1: BM-SC sends a RAR (Start) message to MBMS GW. Step 2: MBMS GW sends a RAA (Start) message to BM-SC. + +**Figure 20.3.1.1: MBMS Session Start procedure** + +1. The BM-SC sends an RAR message to indicate the impending start of the transmission and to provide the session attributes to the MBMS GWs listed in the "list of downstream nodes" parameter of the corresponding MBMS Bearer Context. BM-SC may indicate to MBMS GW that BM-SC supports sending the user plane IP multicast data without IP unicast encapsulation. In such case BM-SC shall send multicast source address as specified by IETF RFC 4604 [73] and IETF RFC 4607 [74] and the user plane multicast destination address. + +If IP unicast mode is used, the BM-SC shall also require the MBMS GW to select one UDP port for the reception of the user plane data for the related MBMS service (identified by TMGI and Flow ID). + +The BM-SC may also indicate its intent to use IP multicast encapsulation of IP multicast datagrams across Sgi-mb. In this case, the BM-SC shall specify an Sgi-mb (transport) destination multicast IP address associated with the MBMS bearer context, as well as the source UDP port. The inclusion of these data shall mean IP multicast encapsulation of IP multicast datagram is the only offered multicast mode over Sgi-mb. The destination UDP port for IP multicast transport shall be fixed as port number 927. The BM-SC shall also specify the (transport) multicast source address. + +The BM-SC shall indicate the M1 interface information of local MBMS information as specified in 3GPP TS 23.285 [112] if the BM-SC determines to use the local MBMS information. + +2. The MBMS GW creates an MBMS Bearer Context, stores the session attributes in the MBMS Bearer Context, initiates session start procedure towards the MMEs/SGSNs in its list of MBMS control plane nodes and sends an RAA message to the BM-SC. In case MBMS GW receives BM-SC multicast source address, which indicates BM-SC support for both modes of sending user plane data, MBMS GW decides in which mode MBMS GW shall receive the user plane data. In case MBMS GW decides to receive unicast encapsulated data, then MBMS GW shall send own IP address for user plane to BM-SC and the MBMS GW shall also indicate the UDP port on which the user plane data shall be received. In case MBMS GW decides to receive IP multicast packets, then MBMS GW shall join the multicast group as specified by IETF RFC 4604 [73] and IETF RFC 4607 [74], and indicate to BM-SC about the decision. In case MBMS GW decides to use M1 interface information of local MBMS information, the MBMS GW skips the allocation procedure for IP multicast distribution. + +If configured, the MBMS GW sends the RAA message after receiving the first session start response (when positive) message from any MME. + +## 20.3.2 Session update procedure + +The BM-SC initiates the MBMS session update procedure when service attributes (e.g. Service Area, MBMS cell list, Access indicator or ARP) for an ongoing MBMS session shall be modified. The MBMS session update procedure is initiated towards one or more of the MBMS GWs in the list of downstream nodes in the BM-SC, according to the changes in the service area. + +**NOTE:** In addition, when the MBMS Service Area for an ongoing broadcast session is changed in the BM-SC, then MBMS GW(s) may be added to, or removed from, the list of downstream nodes in the BM-SC. The BM-SC will initiate MBMS session start procedures or MBMS session stop procedures towards these MBMS GWs accordingly. + +The attributes that can be modified by the RAR message are the MBMS Service Area, the MBMS-Cell-List, the ARP, the Access indicator and the list of MBMS control plane nodes (MMEs, SGSNs). + +When a session update message is received, the MBMS GW updates its MBMS Bearer Context accordingly and informs its downstream MMEs/SGSNs of the changed service attributes. If a list of MBMS control plane nodes (MMEs, SGSNs) is included in the session update message, MBMS GW shall initiate a session start procedure towards the new MMEs/SGSNs, and a session stop procedure towards the MMEs/SGSNs that have been removed from the list. + +![Sequence diagram for MBMS Session Update procedure](3adb4bad764bde2c7c001c4e7fed57ad_img.jpg) + +``` +sequenceDiagram + participant BM-SC + participant MBMS_GW as MBMS GW + Note right of BM-SC: 1. RAR (Update) + BM-SC->>MBMS_GW: RAR (Update) + Note left of MBMS_GW: 2. RAA (Update) + MBMS_GW->>BM-SC: RAA (Update) +``` + +The diagram shows a sequence of two messages between the BM-SC and the MBMS GW. The BM-SC sends a '1. RAR (Update)' message to the MBMS GW, and the MBMS GW responds with a '2. RAA (Update)' message. + +Sequence diagram for MBMS Session Update procedure + +**Figure 20.3.2.1: MBMS Session Update procedure** + +1. The BM-SC sends an RAR message to all MBMS GWs listed in the "list of downstream nodes" parameter of the affected MBMS Bearer Context to indicate that the MBMS session is updated. +2. The MBMS GW stores the new session attributes in the MBMS Bearer Context, initiates session start, session stop or session update procedure towards the MMEs/SGSNs in its list of MBMS control plane nodes and sends an RAA message to the BM-SC. An AAR message is not mandated for the SGmb application in response to an RAR- RAA command exchange. + +### 20.3.3 Session stop procedure + +The BM-SC initiates the MBMS session stop procedure when it considers the MBMS session terminated. Typically this will happen when there is no more MBMS data expected to be transmitted for a sufficiently long period of time to justify the release of bearer plane resources in the network. + +![Sequence diagram for MBMS Session Stop procedure](c879d6feb77f5e629e8feb3b42d5a139_img.jpg) + +``` +sequenceDiagram + participant BM-SC + participant MBMS_GW as MBMS GW + Note right of BM-SC: 1. RAR (Stop) + BM-SC->>MBMS_GW: RAR (Stop) + Note left of MBMS_GW: 2. RAA (Stop) + MBMS_GW->>BM-SC: RAA (Stop) +``` + +The diagram shows a sequence of two messages between the BM-SC and the MBMS GW. The BM-SC sends a '1. RAR (Stop)' message to the MBMS GW, and the MBMS GW responds with a '2. RAA (Stop)' message. + +Sequence diagram for MBMS Session Stop procedure + +**Figure 20.3.3.1: MBMS Session Stop procedure** + +1. The BM-SC sends an RAR message to all MBMS GWs listed in the "list of downstream nodes" parameter of the affected MBMS Bearer Context to indicate that the MBMS session is terminated and the bearer plane resources can be released. +2. The MBMS GW releases the resources regarding the session and sends an RAA message to the BM-SC. An AAR message is not mandated for the SGmb application in response to an RAR- RAA command exchange. + +### 20.3.4 MBMS session termination (MBMS GW initiated) + +![Sequence diagram for MBMS session termination](c0438093a10a593c42106b1e5dbb4331_img.jpg) + +``` +sequenceDiagram + participant MBMS GW + participant BM-SC + Note left of MBMS GW: 1. ST-Request [service] + MBMS GW->>BM-SC: 1. ST-Request [service] + Note right of BM-SC: 2. ST-Answer [service] + BM-SC-->>MBMS GW: 2. ST-Answer [service] +``` + +A sequence diagram showing the interaction between an MBMS GW and a BM-SC for session termination. The MBMS GW sends a message labeled '1. ST-Request [service]' to the BM-SC. The BM-SC responds with a message labeled '2. ST-Answer [service]' back to the MBMS GW. + +Sequence diagram for MBMS session termination + +**Figure 20.3.4.1: MBMS session termination** + +1. In exceptional cases (e.g. resource pre-emption or timeout of the MBMS session), the MBMS GW may send an STR command to the BM-SC to initiate the termination of the Diameter session related to an MBMS bearer service. If a bearer plane had been established over SGi-mb for this MBMS bearer service, the bearer plane is released. If the MBMS GW detects the SGi-mb path failure as specified in subclause 20.3.2.1 of 3GPP TS 23.007 [104], the MBMS GW shall set the Termination-Cause to "DIAMETER\_LINK\_BROKEN" (see IETF RFC 6733 [111]) and shall include the Diagnostic-Info AVP set to "User Plane Failure" if it tears down the MBMS session as a result of detecting an SGi-mb path failure. +2. The BM-SC removes the Diameter session and confirms the operation by sending an STA message to the MBMS GW. + +## 20.3.5 MBMS heartbeat procedure + +The BM-SC initiates the MBMS heartbeat procedure to detect a SGmb path failure or the restart of the MBMS GW as specified in 3GPP TS 23.007 [104]. + +![Sequence diagram for MBMS heartbeat procedure initiated by the BM-SC](7f950d8071cc74c5c726756baed72584_img.jpg) + +``` +sequenceDiagram + participant MBMS GW + participant BM-SC + Note right of BM-SC: 1. RAR (Heartbeat) + BM-SC-->>MBMS GW: 1. RAR (Heartbeat) + Note left of MBMS GW: 2. RAA (Heartbeat) + MBMS GW->>BM-SC: 2. RAA (Heartbeat) +``` + +A sequence diagram showing the interaction between a BM-SC and an MBMS GW for a heartbeat procedure initiated by the BM-SC. The BM-SC sends a message labeled '1. RAR (Heartbeat)' to the MBMS GW. The MBMS GW responds with a message labeled '2. RAA (Heartbeat)' back to the BM-SC. + +Sequence diagram for MBMS heartbeat procedure initiated by the BM-SC + +**Figure 20.3.5.1: MBMS Heartbeat procedure initiated by the BM-SC** + +1. The BM-SC sends an RAR message to the MBMS GW and indicates this is a heartbeat request. The BM-SC also includes the Restart-Counter AVP set to its local restart counter. +2. The MBMS GW sends an RAA message to the BM-SC to acknowledge the heartbeat request. The MBMS GW also includes the Restart-Counter AVP set to its local restart counter. + +The MBMS GW initiates the MBMS heartbeat procedure to detect a SGmb path failure or the restart of the BM-SC as specified in 3GPP TS 23.007 [104]. + +![Sequence diagram showing the MBMS Heartbeat procedure initiated by the MBMS GW. The diagram shows two lifelines: MBMS GW and BM-SC. Step 1: MBMS GW sends a RAR (Heartbeat) message to BM-SC. Step 2: BM-SC sends a RAA (Heartbeat) message back to MBMS GW.](0eb348bf17d67bf96326e07011d1c1ad_img.jpg) + +``` + +sequenceDiagram + participant MBMS GW + participant BM-SC + Note right of MBMS GW: 1. RAR (Heartbeat) + MBMS GW->>BM-SC: RAR (Heartbeat) + Note left of BM-SC: 2. RAA (Heartbeat) + BM-SC-->>MBMS GW: RAA (Heartbeat) + +``` + +Sequence diagram showing the MBMS Heartbeat procedure initiated by the MBMS GW. The diagram shows two lifelines: MBMS GW and BM-SC. Step 1: MBMS GW sends a RAR (Heartbeat) message to BM-SC. Step 2: BM-SC sends a RAA (Heartbeat) message back to MBMS GW. + +**Figure 20.3.5.2: MBMS Heartbeat procedure initiated by the MBMS GW** + +1. The MBMS GW sends an RAR message to the BM-SC and indicates this is a heartbeat request. The MBMS GW also includes the Restart-Counter AVP set to its local restart counter. +2. The BM-SC sends an RAA message to the MBMS GW to acknowledge the heartbeat request. The BM-SC also includes the Restart-Counter AVP set to its local restart counter. + +In the context of this procedure, the Diameter session shall be implicitly terminated, i.e. the client (server) shall behave as if the Auth-Session-State AVP was set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [111]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. + +NOTE: The Auth-Session-State AVP is not included in the RAR/RAA message as this is not permitted by the Diameter base protocol. See IETF RFC 6733 [111]. + +## 20.4 SGmb Messages + +This clause defines the SGmb interface Diameter message. + +The relevant AVPs that are of use for the SGmb interface are detailed in this clause. Other Diameter NASREQ (IETF RFC 7155 [120]) AVPs, even if their AVP flag rules is marked with "M", are not required for being compliant with the current specification. + +All SGmb specific AVPs for SGmb are needed to be compliant to the SGmb interface unless otherwise stated. + +### 20.4.1 Re-Auth-Request Command + +The Re-Auth-Request (RAR) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 258 and the message flags' 'R' bit set. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for SGmb, or modified existing AVPs. + +Message Format: + +``` + + ::= < Diameter Header: 258, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + { Re-Auth-Request-Type } + [ Called-Station-Id ] + [ Framed-IP-Address ] + [ Framed-IPv6-Prefix ] + [ Framed-Interface-Id ] + [ MBMS-Access-Indicator ] + +``` + +``` + +[ MBMS-StartStop-Indication ] +[ MBMS-Service-Area ] +[ QoS-Information ] +[ MBMS-Session-Duration ] +[ MBMS-Session-Identity ] +[ MBMS-Session-Repetition-number ] +[ TMGI ] +* [ 3GPP-SGSN-Address ] +* [ 3GPP-SGSN-IPv6-Address ] +[ MBMS-Time-To-Data-Transfer ] +[ MBMS-Data-Transfer-Start ] +[ MBMS-Data-Transfer-Stop ] +[ MBMS-Flags ] +[ MBMS-User-Data-Mode-Indication ] +[ MBMS-BMSC-SSM-IP-Address ] +[ MBMS-BMSC-SSM-IPv6-Address ] +[ MBMS-Flow-Identifier ] +[ CN-IP-Multicast-Distribution ] +[ MBMS-HC-Indicator ] +[ MBMS-GW-UDP-Port-Indicator ] ; for IP unicast encapsulated user data +[ MBMS-GW-SSM-IP-Address ] ; for IP multicast encapsulated user data +[ MBMS-GW-SSM-IPv6-Address ] ; for IP multicast encapsulated user data +[ MBMS-BMSC-SSM-UDP-Port ] ; for IP multicast encapsulated user data +[ MBMS-Cell-List ] +[ Local-M1-Information ] +[ Origin-State-Id ] +* [ Proxy-Info ] +* [ Route-Record ] +* [ Supported-Features ] +[ Restart-Counter ] + +``` + +For the MBMS Session Start procedure, RAR is sent by the BM-SC to the MBMS GW(s) that will deliver the MBMS service when it is ready to send data. This is a request to activate all necessary bearer resources in the network for the transfer of MBMS data. The RAR message contains either an IPv4 address included in 3GPP-SGSN-Address AVP or an IPv6 address included in 3GPP-SGSN-IPv6-Address AVP for each participating MBMS control plane nodes (MMEs, SGSNs). The MBMS-Time-to-Data-Transfer AVP shall be included to indicate the expected time between the reception of the MBMS Session Start and the transmission of MBMS data flows. For E-UTRAN access, the RAR message may also contain the MBMS-Data-Transfer-Start AVP containing the absolute time stamp of the data delivery start. The RAR message shall also contain the MBMS-Service-Area AVP. If the MBMS Cell List feature is supported, or if the BM-SC does not yet know whether the MBMS-GW supports this feature, the RAR may contain the MBMS-Cell-List AVP. For the distributed MCE architectures, i.e. when the MCE is part of eNB as described in clause 15.1.1 in TS 36.300 [98], the MBMS-Data-Transfer-Start AVP should be used at MBSFN operation mode to ensure synchronized session control and to facilitate a graceful reallocation of resources for the MBSFN when needed. The RAR message shall also contain the Local-M1-Information AVP if the BM-SC determines to use the local MBMS information as specified in 3GPP TS 23.285 [112]. + +The MBMS-Flags AVP may provide specific control indications in relation to MBMS, e.g. whether the MBMS Session Start procedure is used to re-establish an MBMS session. + +For the MBMS Session Update procedure, RAR is sent by the BM-SC in order for the MBMS GW(s) to update their session attributes. If the MBMS service area or the MBMS cell list needs to be changed, the MBMS-Service-Area AVP shall be included in the RAR. If the MBMS Cell List feature is supported and the MBMS cell list needs to be changed, the MBMS-Cell-List AVP shall also be included. If the MBMS-Service-Area AVP but no MBMS-Cell-List AVP is included, this shall indicate that any MBMS Cell List included in a previous RAR does no longer apply. If the Access indicator needs to be updated, it shall be included in the MBMS-Access-Indicator AVP. For E-UTRAN access, the RAR message may also contain the MBMS-Data-Transfer-Start AVP containing the absolute time stamp of the data delivery start. For the distributed MCE architectures, i.e. when the MCE is part of eNB as described in clause 15.1.1 in TS 36.300 [98], the MBMS-Data-Transfer-Start AVP should be used at MBSFN operation mode to ensure synchronized session control and to facilitate a graceful reallocation of resources for the MBSFN when needed. The MBMS-StartStop-Indication AVP with the value UPDATE shall be included. The MBMS-Time-To-Data-Transfer AVP with the value set to 0 shall be included. The MBMS-Session-Duration AVP shall be included to indicate the duration of the remaining part of the MBMS session. The 3GPP-SGSN-Address AVP and the 3GPP-SGSN-IPv6-Address AVP shall be included if the related lists of MBMS control plane nodes (MMEs, SGSNs) in the MBMS GW(s) have changed. If the ARP needs to be changed, the QoS-Information AVP shall be included. The other bold marked AVPs shall be included as given by the previous, corresponding MBMS Session Start procedure. + +For the MBMS Session Stop procedure, RAR is sent by the BM-SC to the MBMS GW(s) when it considers the MBMS session to be terminated. The session is typically terminated when there is no more MBMS data expected to be transmitted for a sufficiently long period of time to justify a release of bearer plane resources in the network. For E- + +UTRAN access, the RAR message may also contain the MBMS-Data-Transfer-Stop AVP containing the absolute time stamp of the data delivery stop. The MBMS-Flags AVP may provide specific control indications, e.g. whether the MBMS Session Stop procedure is used to release the MBMS bearer context locally. + +For the MBMS Session Start procedure, the Qos-Information AVP indicates the QoS that is required for the MBMS bearer service for the actual MBMS session. Only the QoS-Class-Identifier AVP, Max-Requested-Bandwidth-DL AVP, Guaranteed-Bitrate-DL AVP and Allocation-Retention-Priority AVP within the QoS-Information AVP are applicable for the MBMS bearer service. The MBMS-Service-Area AVP is passed from BM-SC transparently through MBMS GW to the MMEs/SGSN(s) that are relevant for the actual MBMS bearer service. The MBMS-Cell-List AVP is also passed transparently through MBMS GW to the MMEs. The MBMS-Access-Indicator AVP indicates in which radio access types the MBMS bearer service shall be broadcasted, i.e. UTRAN, or E-UTRAN, or both. + +The usage of MBMS-StartStop-Indication AVP, Session-Id AVP, Framed-IP-Address AVP, Framed-IPv6-Prefix AVP, Framed-Interface-Id AVP, Called-Station-Id AVP and MBMS-Flow-Identifier AVP can refer to Gmb interface as described in clause 17.6.5. + +If unicast mode is used, the MBMS GW shall select an IP unicast address and a destination UDP port that is unique within the MBMS GW or that IP unicast address. + +If IP multicast encapsulation of application IP multicast datagram is used over Sgi-mb, the BM-SC shall select a source UDP port that is unique within the BM-SC for that IP multicast address. + +For the MBMS Heartbeat procedure, RAR is sent by the BM-SC to the MBMS GW, or vice-versa. The RAR message shall contain the following AVPs: + +- the MBMS-StartStop-Indication AVP set to the value "heartbeat"; +- the Restart-Counter AVP set to the local restart counter of the sender. + +## 20.4.2 RE-Auth-Answer Command + +The Re-Auth-Answer (RAA) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 258 and the message flags' 'R' bit clear, is sent in response to the RAR. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +The bold marked AVPs in the message format indicate new optional AVPs for SGmb, or modified existing AVPs. + +Message Format: + +``` + ::= < Diameter Header: 258, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ MBMS-StartStop-Indication ] + [ MBMS-GGSN-Address ] ; for unicast encapsulated user data + [ MBMS-GGSN-Ipv6-Address ] ; for unicast encapsulated user data + [ MBMS-User-Data-Mode-Indication ] + [ MBMS-GW-UDP-Port ] ; for unicast encapsulated user data + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirected-Host ] + [ Redirected-Host-Usage ] + [ Redirected-Host-Cache-Time ] + [ Proxy-Info ] + * [ Supported-Features ] + [ Restart-Counter ] +``` + +For the MBMS Heartbeat procedure, RAA is sent by the BM-SC to the MBMS GW, or vice-versa. The RAA message shall contain the following AVPs: + +- the MBMS-StartStop-Indication AVP set to the value "heartbeat"; +- the Restart-Counter AVP set to the local restart counter of the sender. + +### 20.4.3 Session-Termination-Request Command + +A DIAMETER session may be terminated by the MBMS GW in exceptional cases. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ Destination-Host ] + * [ Class ] + [ Origin-State-Id ] + * [ Proxy-Info ] + * [ Route-Record ] + [ Diagnostic-Info ] + [ Restart-Counter ] +``` + +### 20.4.4 Session-Termination-Answer Command + +The STA command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field, is sent in response to an STR command. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format: + +``` + ::= < Diameter Header: 275, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + * [ Class ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + [ Restart-Counter ] +``` + +### 20.4.5 Abort-Session-Request Command + +The Abort-Session-Request (ASR) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit set, is sent by the BM-SC to the MBMS GW to request that the session identified by the Session-Id be stopped. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +Message Format + +``` + + ::= < Diameter Header: 274, REQ, PXY > + < Session-Id > + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ Origin-State-Id ] + * [ Proxy-Info ] + * [ Route-Record ] + [ Restart-Counter ] + +``` + +## 20.4.6 Abort-Session-Answer Command + +The Abort-Session-Answer (ASA) command, defined in IETF RFC 6733 (DIAMETER BASE) [111], is indicated by the Command-Code set to 274 and the message flags' 'R' bit clear, is sent in response to the ASR. + +The relevant AVPs that are of use for the SGmb interface are detailed in the ABNF description below. Other valid AVPs for this command are not used for SGmb purposes and should be ignored by the receiver or processed according to the relevant specifications. + +### Message Format + +``` + + ::= < Diameter Header: 274, PXY > + < Session-Id > + { Result-Code } + { Origin-Host } + { Origin-Realm } + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + * [ Redirected-Host ] + [ Redirected-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + [ Restart-Counter ] + +``` + +## 20.5 SGmb re-used AVPs + +Table 20.5.1 lists the Diameter AVPs re-used by the SGmb reference point from the Gmb reference point and other existing Diameter Application, reference to their respective specifications and short description of their usage within the SGmb reference point. When reused from Gmb reference point, the specific clause in the present specification is referred. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol, do not need to be supported. The AVPs from Diameter base protocol are not included in table 20.5.1, but they are re-used for the SGmb reference point. Where RADIUS VSAs are re-used, they shall be translated to Diameter AVPs as described in RFC 7155 [120] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 20.5.1 : SGmb re-used Diameter AVPs** + +| Attribute Name | Reference | Description | +|--------------------------------|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TMGI | 17.7.2 | Contains the Temporary Mobile Group Identity allocated to a particular MBMS bearer service. | +| MBMS-StartStop-Indication | 17.7.5 | Indicates the type of MBMS Session procedure. | +| MBMS-Service-Area | 17.7.6 | Indicates the area over which the MBMS bearer service has to be distributed. | +| MBMS-Session-Duration | 17.7.7 | Indicates the estimated session duration (MBMS Service data transmission). | +| MBMS-Session-Identity | 17.7.11 | Together with TMGI it identifies a transmission of a specific MBMS session. | +| MBMS-Time-To-Data-Transfer | 17.7.14 | Indicates the expected time between reception of the MBMS Session Start (RAR (Start) command) or the MBMS Session Update (RAR (Update) command) and the commencement of the MBMS Data flow. A value of 0 (1 sec.) shall be used in the Session Update. | +| MBMS-Session-Repetition-Number | 17.7.15 | Contains the session identity repetition number of the MBMS transmission session on the SGmb interface. | +| MBMS-User-Data-Mode-Indication | 17.7.18 | When sent from the BM-SC to the MBMS GW, it indicates the mode that BM-SC supports. When sent from the MBMS GW to the BM-SC, it indicates the mode that BM-SC shall send user plane data with.
Two modes apply:
- Unicast mode: IP multicast packets over UDP encapsulated by IP unicast header.
- Multicast mode: IP multicast packets encapsulated over UDP by IP multicast header. | +| MBMS-GGSN-Address | 17.7.19 | Contains the value of MBMS GW's IPv4 address for user plane data. | +| MBMS-GGSN-IPv6-Address | 17.7.20 | Contains the value of MBMS GW's IPv6 address for user plane data. | +| MBMS-BMSC-SSM-IP-Address | 17.7.21 | Contains the value of BM-SC's IPv4 address of Source Specific Multicasting. | +| MBMS-BMSC-SSM-IPv6-Address | 17.7.22 | Contains the value of BM-SC's IPv6 address of Source Specific Multicasting. | +| MBMS-Flow-Identifier | 17.7.23 | Represents a location dependent subflow of an MBMS bearer service. | +| CN-IP-Multicast-Distribution | 17.7.24 | Indicates if IP multicast distribution to UTRAN should be used for the MBMS user plane data. | +| MBMS-HC-Indicator | 17.7.25 | Indicates if header compression is used by BM-SC when sending for MBMS user plane data.(NOTE 1) | +| 3GPP-SGSN-Address | 16.4.7 | Represents the SGSN or MME's IPv4 address that is used by the GTP control plane for the handling of control messages. | +| 3GPP-SGSN-IPv6-Address | 16.4.7 | Represents the SGSN or MME's IPv6 address that is used by the GTP control plane for the handling of control messages. | +| Called-Station-Id | NASREQ, IETF RFC 7155 [120] | Contains the Access Point Name (APN) for which the MBMS bearer service is defined | +| Framed-Interface-Id | NASREQ, IETF RFC 7155 [120] | Contains the IPv6 interface identifier of the multicast address | +| Framed-IP-Address | NASREQ, IETF RFC 7155 [120] | Contains the IPv4 multicast address. | +| Framed-IPv6-Prefix | NASREQ, IETF RFC 7155 [120] | Contains the IPv6 prefix of the multicast address. | +| Local-M1-Information | 3GPP TS 29.468 [113] | Contains the M1 interface information of the local MBMS information, i.e., transport network IP Multicast Address, IP address of multicast source and C-TEID. | +| QoS-Information | 3GPP TS 29.212 [75] | Contains the QoS that is required for the MBMS bearer service for the MBMS session.
Only the QoS-Class-Identifier AVP, Max-Requested-Bandwidth-DL, Guaranteed-Bitrate-DL AVP and Allocation-Retention-Priority AVP within the QoS-Information AVP are applicable for the MBMS bearer service. | +| Supported-Features | 3GPP TS 29.229 [105] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange | + +| Attribute Name | Reference | Description | +|-----------------------------------------------------------------------|-----------|-------------| +| NOTE 1: Header Compression only supported for UTRAN for this Release. | | | + +## 20.5a SGmb specific AVPs + +Table 20.5a.1 describes the SGmb specific Diameter AVPs. The Vendor-Id header of all SGmb specific AVPs defined in the present specification shall be set to 3GPP (10415). + +The SGmb specific AVPs require to be supported to be compliant with the present specification. All AVPs in table 20.5a.1 are mandatory within SGmb interface unless otherwise stated. + +**Table 20.5a.1: SGmb specific AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | May Encr. | Applicability (NOTE) | +|----------------------------|----------|-----------------|-------------|----------------|-----|------------|----------|-----------|----------------------| +| | | | | Must | May | Should not | Must not | | | +| MBMS-Access-Indicator | 923 | 20.5a.1 | Enumerated | M.V | P | | | Y | | +| MBMS-GW-SSM-IP-Address | 924 | 20.5a.2 | OctetString | V | P | | M | Y | | +| MBMS-GW-SSM-IPv6-Address | 925 | 20.5a.3 | OctetString | V | P | | M | Y | | +| MBMS-BMSC-SSM-UDP-Port | 926 | 20.5a.4 | OctetString | V | P | | M | Y | | +| MBMS-GW-UDP-Port | 927 | 20.5a.5 | OctetString | V | P | | M | Y | | +| MBMS-GW-UDP-Port-Indicator | 928 | 20.5a.6 | Enumerated | V | P | | M | Y | | +| MBMS-Data-Transfer-Start | 929 | 20.5a.7 | Unsigned64 | V | P | | M | Y | | +| MBMS-Data-Transfer-Stop | 930 | 20.5a.8 | Unsigned64 | V | P | | M | Y | | +| MBMS-Flag | 931 | 20.5a.9 | Unsigned32 | V | P | | M | Y | | +| Restart-Counter | 932 | 20.5a.10 | Unsigned32 | V | P | | M | Y | MBMS Heartbeat | +| Diagnostic-Info | 933 | 20.5a.11 | Unsigned32 | V | P | | M | Y | | +| MBMS-Cell-List | 934 | 20.5a.12 | OctetString | V | P | | M | Y | MBMS Cell List | + +NOTE: AVPs marked with a supported feature are applicable as described in subclause 20.7. + +### 20.5a.1 MBMS-Access-Indicator AVP + +The MBMS-Access-Indicator AVP (AVP code 923) is of type Enumerated. It indicates whether the MBMS bearer service will be delivered in UTRAN-only, E-UTRAN-only or both coverage areas. The following values are supported: + +UTRAN (0) + +The MBMS bearer service shall only be delivered in UTRAN only coverage areas. + +E-UTRAN (1) + +The MBMS bearer service shall only be delivered in E-UTRAN only coverage areas. + +UTRAN-AND-E-UTRAN (2) + +The MBMS bearer service shall be delivered both in UTRAN and E-UTRAN coverage areas. + +## 20.5a.2 MBMS-GW-SSM-IP-Address AVP + +The MBMS-GW-SSM-IP-Address AVP (AVP code 924) is of type OctetString and contains the Sgi-mb (transport) plane IPv4 destination multicast address used by BM-SC for IP multicast encapsulation of application IP multicast datagrams. + +## 20.5a.3 MBMS-GW-SSM-IPv6-Address AVP + +The MBMS-GW-SSM-IPv6-Address AVP (AVP code 925) is of type OctetString and contains the Sgi-mb (transport) plane IPv6 prefix of the destination multicast address used by BM-SC for IP multicast encapsulation of application IP multicast datagrams. + +## 20.5a.4 MBMS-BMSC-SSM-UDP-Port AVP + +The MBMS-BMSC-SSM-UDP-Port AVP (AVP code 926) is of type OctetString and contains the Sgi-mb (transport) plane source UDP port number at the BM-SC for IP multicast encapsulation of IP multicast datagrams. + +## 20.5a.5 MBMS-GW-UDP-Port AVP + +The MBMS-GW-UDP-Port AVP (AVP code 927) is of type OctetString, and contains the value of the UDP port from which the user plane data will be received in the MBMS-GW. + +## 20.5a.6 MBMS-GW-UDP-Port-Indicator AVP + +MBMS-GW-UDP-Port-Indicator AVP (AVP code 928) is of type Enumerated. It indicates that the payload related to the MBMS service is required to be delivered in the MBMS UDP Port assigned by the MBMS-GW. + +UDP-PORT-REQUIRED (1) + +Value 1 indicates that the user plane data corresponding to the MBMS service shall be delivered on the UDP Port provided by the MBMS-GW. + +## 20.5a.7 MBMS-Data-Transfer-Start AVP + +The MBMS-Data-Transfer-Start AVP (AVP code 929) is of type Unsigned64. + +This value indicates the time in seconds for the radio resources set up relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the first 32 bits and binary encoding of the fraction part in the last 32 bits. The fraction part is expressed with a granularity of $1/2^{32}$ second. + +This AVP is only valid for E-UTRAN access type. + +## 20.5a.8 MBMS-Data-Transfer-Stop AVP + +The MBMS-Data-Transfer-Stop AVP (AVP code 930) is of type Unsigned64. + +This value indicates the time in seconds for the release of resources relative to 00:00:00 on 1 January 1900 (calculated as continuous time without leap seconds and traceable to a common time reference) where binary encoding of the integer part is in the first 32 bits and binary encoding of the fraction part in the last 32 bits. The fraction part is expressed with a granularity of $1/2^{32}$ second. + +This AVP is only valid for E-UTRAN access type. + +## 20.5a.9 MBMS-Flags AVP + +The MBMS-Flags AVP (AVP code 931) is of type Unsigned32. It provides control indications. + +It shall contain a bit mask. The meaning of the bits shall be as defined in table 20.5a.9.1: + +**Table 20.5a.9.1 : MBMS-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MSRI | MBMS Session Re-establishment Indication :

This bit, when set, indicates that the MBMS Session Start Request message is used to re-establish an MBMS session (see 3GPP TS 23.007 [104]). | +| 1 | LMBCRI | Local MBMS Bearer Context Release Indication :

This bit, when set, indicates that the MBMS Session Stop Request message is used to locally release the MBMS bearer context in the MBMS-GW and in the associated MME/SGSNs (see 3GPP TS 23.007 [104]). | +| NOTE: Bits not defined in this table shall be cleared by the sending BM-SC and ignored by the receiving MBMS GW. | | | + +## 20.5a.10 Restart-Counter AVP + +The Restart-Counter AVP (AVP code 932) is of type Unsigned32. This is a monotonically increasing value that is advanced whenever the MBMS entity restarts with loss of previous state, for example upon restart. The Restart-Counter AVP may be included in any Diameter message over the SGmb reference point, including CER/CEA. + +## 20.5a.11 Diagnostic-Info AVP + +The Diagnostic-Info AVP (AVP code 933) is of type Unsigned32. + +It shall contain a bit mask. The meaning of the bits shall be as defined in table 20.5a.11.1: + +**Table 20.5a.11.1 : Diagnostic-Info** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UPFAIL | User Plane Failure:

This bit, when set, indicates the detection of a User Plane Failure by the MBMS GW (see subclause 20.3.2.1 of 3GPP TS 23.007 [104]). | +| NOTE: Bits not defined in this table shall be cleared by the sending MBMS GW and ignored by the receiving BM-SC. | | | + +## 20.5a.12 MBMS-Cell-List AVP + +The MBMS-Cell-List AVP (AVP code 934) is of type OctetString. It contains the MBMS Cell List that the E-UTRAN uses to determine a set of radio resources to be used for the broadcast. Based on the cell ID list, the set of radio resources selected may be reduced from the full set of resources defined by the MBMS service area. + +The AVP shall consist of two octets indicating the number of cell identifiers in the list, followed by a sequence of maximum 4096 cell identifiers, coded as E-CGIs. + +| Bits | | +|--------------|-------------------------------------------------------------------------------------------------------------------------------| +| 1-16 | Number N of ECGI codes coded as:
1 binary value is '0000 0000 0000 0000'

4096 binary value is '0000 1111 1111 1111' | +| 17-(56*N+16) | A consecutive list of N ECGI codes, each encoded according to subclause 8.21.5 of 3GPP TS 29.274 [81]. | + +The ECGI and its semantics are defined in subclause 19.6 of 3GPP TS 23.003 [40]. + +## 20.6 SGmb specific Experimental-Result-Code AVP values + +The same codes specified in clause 17.8 apply here except +DIAMETER\_ERROR\_UNKNOWN\_MBMS\_BEARER\_SERVICE (5122) + +## 20.7 Use of the Supported-Features AVP on the SGmb reference point + +The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request in a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the SGmb reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [105]. + +The base functionality for the SGmb reference point is the 3GPP Rel-11 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the SGmb commands. As defined in clause 7.1.1 of 3GPP TS 29.229 [105], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [105], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the SGmb reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the SGmb reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [105]. The following exceptions apply to the initial RAR/RAA command pair: + +- If the BM-SC supporting post-Rel-11 SGmb functionality is able to interoperate with a MBMS GW supporting Rel-11, the RAR shall include the features supported by the BM-SC within Supported-Features AVP(s) with the 'M' bit cleared. Otherwise, the RAR shall include the supported features within the Supported-Features AVP(s) with the M-bit set. + +NOTE 1: One instance of Supported-Features AVP is needed per Feature-List-ID. + +- If the RAR command does not contain any Supported-Features AVP(s) and the MBMS GW supports Rel-11 SGmb functionality, the RAA command shall not include the Supported-Features AVP. In this case, both BM-SC and MBMS GW shall behave as specified in the Rel-11 version of this document. +- If the RAR command contains the Supported-Features AVP, the MBMS GW shall include the Supported-Features AVP in the RAA command, with the 'M' bit cleared, indicating only the features that both the BM-SC and MBMS GW support. + +NOTE 2: The client will always declare all features that are supported according to table 20.7.1. When more than one feature identifying a release is supported by both BM-SC and MBMS GW, the BM-SC will work according to the latest common supported release. + +Once the BM-SC and MBMS GW have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable to the SGmb interface for the feature list with a Feature-List-ID of 1. + +**Table 20.7.1: Features of Feature-List-ID 1 used in SGmb** + +| Feature bit | Feature | M/O | Description | +|-------------|----------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MBMS Heartbeat | O | This feature indicates the support of the MBMS Heartbeat functionality, including the AVPs and corresponding procedures. | +| 1 | MBMS Cell List | O | This feature indicates the support of providing a MBMS-Cell-List AVP in the MBMS Session Start and MBMS Session Update procedures. For deployments with E-UTRAN access, this feature shall be supported. | + +Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0". + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS". + +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. + +Description: A clear textual description of the feature. + +--- + +## Annex A (informative): Interworking PCS1900 with PSDNs + +Void. + +--- + +## Annex B (normative): Rate control related to Cellular Internet Of Things (CIoT) optimisations + +### B.1 General + +The present annex defines specific requirements for rate control related to CIoT optimisations. + +--- + +### B.2 Support of rate control of user data + +#### B.2.0 General + +The rate of user data sent to and from a UE (e.g. a UE using CIoT EPS Optimizations) can be controlled in two different ways: + +- Serving PLMN rate control +- APN rate control + +Serving PLMN rate control is further described in 3GPP TS 23.401 [77]. + +The APN rate control parameters are a part of the configuration data stored in the GGSN/PGW and is configured on per APN basis. + +APN rate control allows HPLMN operators on per APN and user to control the amount of user data sent DL and UL. This is done with help of policing user data on a maximum number of user data packets per time unit both DL and UL. APN rate control DL policing is done in the GGSN/PGW or the SCEF and the APN rate control policing UL is done in the UE. The GGSN/PGW or SCEF can also do APN rate control UL policing. + +For further information on APN rate control UL in the UE, see 3GPP TS 24.301 [84]. + +For further information on APN rate control in the SCEF, see 3GPP TS 29.128 [110]. + +NOTE: Existing AMBR mechanisms are not suitable for such a service since, for radio efficiency and UE battery life reasons, an AMBR of e.g. > 100kbit/s is desirable and such an AMBR translates to a potentially large daily data volume. + +#### B.2.1 APN Rate Control in the PGW + +To enable APN rate control it shall be configured in the PGW per APN. + +The APN rate control parameters, if configured, shall consist of: + +- the maximum number of DL user data packets per time unit, +- the maximum number of UL user data packets per time unit, +- an indication whether the UE is allowed to send additional exception reports when the limit for the UL APN rate control has been reached , and +- if UE supports it, the maximum number of additional UL exception reports per time unit. + +Possible time units shall be, minute, hour, day or week. + +If the UE does not indicate APN rate control support, the GGSN/PGW may refrain from providing APN rate control information to the UE. + +NOTE 1: The UE indicates support for APN rate control with help of an indicator in the Protocol Configuration Options IE (PCO IE) or the Extended Protocol Configuration Options IE (ePCO IE), see 3GPP TS 24.008 [54] or 3GPP TS 24.301 [84] for IE definition. The APN rate control indicator within the PCO/ePCO IE is received at IP-CAN session establishment. + +NOTE 2: The UE and network support of the ePCO IE, is indicated with help of the Indication IE. The ePCO support indication within the Indication IE can be received at IP-CAN session establishment or at IP-CAN session modification. See 3GPP TS 29.274 [81] for IE definition. + +If the APN rate control is supported by the UE and the Indication IE is received indicating support of ePCO IE at the IP-CAN session establishment request and the PGW supports the ePCO IE, the PGW shall in the reply, if configured for the APN used, include APN UL rate control parameters in the ePCO IE, see 3GPP TS 24.008 [54] for IE definition. If the ePCO IE is not supported the PGW shall use the PCO IE. + +The GGSN shall use the PCO IE. + +If the APN rate control UL parameter(s) is modified and the ePCO IE is supported, the PGW shall initiate an IP-CAN session modification procedure and include the APN UL rate control parameters in the ePCO IE. + +If the ePCO IE is not supported the PGW shall use the PCO IE. + +The GGSN shall use the PCO IE. + +The GGSN/PGW shall enforce the APN rate control per UE and APN according to the configuration for DL and may enforce APN rate control for UL, e.g. when the PGW have indicated to the UE that the UE is not allowed to send exception reports when the limit for the UL APN rate control has been reached. + +NOTE 3: The UE locally enforces this uplink APN rate control instruction. The UE considers this APN rate control instruction as valid until it receives a new one from the GGSN/PGW. + +## B.2.2 Serving PLMN Rate Control information handling in the PGW + +If Serving PLMN rate control information is received in the Serving PLMN Rate Control IE from the MME, the PGW shall store this information and use that for rate control enforcement DL for this UE. + +If the PGW previously have received Serving PLMN rate control information, the PGW shall behave as follows: + +- If the PGW receives new Serving PLMN rate control information in the Serving PLMN Rate Control IE from the MME, the PGW shall replace the old Serving PLMN rate control information with the new Serving PLMN rate control information and use that for rate control enforcement DL for this UE. +- If the PGW receives no Serving PLMN rate control information in the Serving PLMN Rate Control IE from the MME in an IP-CAN session establishment or an IP-CAN session modification , the PGW shall still consider the latest received Serving PLMN rate control information from the MME as valid. +- If PGW receives an indication that Serving PLMN rate control does not apply in the Serving PLMN Rate Control IE, the PGW shall remove the rate control information based on Serving PLMN rate control information. + +See 3GPP TS 29.274 [81] for Serving PLMN Rate Control IE definition. + +APN rate control, if configured, also applies for the same IP-CAN session, see subclause B.2.1. + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2015-03 | CT#67 | CP-150126 | 0444 | 2 | | Paging policy differentiation for IMS voice | 13.0.0 | +| 2015-09 | CT#69 | CP-150464 | 0450 | 1 | A | Usage of the UDP port for default unicast encapsulation mode at the SGmb interface is required to support SYNC protocol. | 13.1.0 | +| 2015-09 | CT#69 | CP-150468 | 0453 | | A | 3GPP Type of RADIUS 3GPP-User-Location-Info-Time sub-attribute | 13.1.0 | +| 2015-09 | CT#69 | CP-150472 | 0455 | 1 | A | Correction of SGmb L4 Transport protocol | 13.1.0 | +| 2015-12 | CT#70 | CP-150658 | 0456 | 1 | B | MBMS bearer establishment and update with cell ID list | 13.2.0 | +| 2015-12 | CT#70 | CP-150669 | 0459 | 1 | A | Transport protocols of Diameter for signalling plane of non transparent case | 13.2.0 | +| 2016-03 | CT#71 | CP-160108 | 0460 | | B | Support for Non-IP data for CIoT over Sgi | 13.3.0 | +| 2016-03 | CT#71 | CP-160089 | 0465 | 2 | B | Usage of the UDP port for default unicast encapsulation mode at the Gmb interface is required to support SYNC protocol | 13.3.0 | +| 2016-06 | CT#72 | CP-160252 | 0466 | 1 | B | Support of Non-IP delivery data | 13.4.0 | +| 2016-06 | CT#72 | CP-160252 | 0469 | | B | RAT-Type extension for NB-IoT | 13.4.0 | +| 2016-06 | CT#72 | CP-160252 | 0471 | 1 | B | Non-IP Transport | 13.4.0 | +| 2016-06 | CT#72 | CP-160277 | 0472 | 1 | B | Support for rate control of CIoT datat | 13.4.0 | +| 2016-06 | CT#72 | CP-160281 | 0468 | 1 | B | Support of Non-IP delivery data | 14.0.0 | +| 2016-09 | CT#73 | CP-160441 | 0474 | 1 | A | PDP type extension with Non-IP value | 14.1.0 | +| 2016-09 | CT#73 | CP-160441 | 0476 | 1 | A | Support of Exception Reports for CIoT | 14.1.0 | +| 2016-09 | CT#73 | CP-160459 | 0477 | | B | APN rate control support in GPRS | 14.1.0 | +| 2016-09 | CT#73 | CP-160441 | 0479 | | A | APN rate control DL correction | 14.1.0 | +| 2016-09 | CT#73 | CP-160452 | 0480 | 2 | B | Modify the 3GPP-User-Location-Info to support eNB ID Information | 14.1.0 | +| 2016-12 | CT#74 | CP-160632 | 0481 | 1 | B | Local MBMS related MBMS data delivery | 14.2.0 | +| 2016-12 | CT#74 | CP-160613 | 0483 | 1 | A | Correction to SGi PTP tunnelling based on UDP/IP | 14.2.0 | +| 2016-12 | CT#74 | CP-160616 | 0484 | 1 | F | Diameter base protocol specification update | 14.2.0 | +| 2017-03 | CT#75 | CP-170076 | 0486 | 1 | F | Handling of Vendor-Specific-Application-Id AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170086 | 0487 | 1 | F | Support of long and short Macro eNodeB IDs | 14.3.0 | +| 2017-03 | CT#75 | CP-170075 | 0489 | 2 | A | Correction in APN rate control | 14.3.0 | +| 2017-03 | CT#75 | CP-170076 | 0492 | 1 | F | Update instance number for the Failed-AVP in answer commands | 14.3.0 | +| 2017-09 | CT#77 | CP-172052 | 0493 | | F | Correction of signalling server address request | 15.0.0 | +| 2017-09 | CT#77 | CP-172052 | 0496 | 1 | F | Correction for QoS modification in MBMS Update Request | 15.0.0 | +| 2017-12 | CT#78 | CP-173088 | 0498 | 2 | F | Rate control for MO exception data | 15.1.0 | +| 2017-12 | CT#78 | CP-173105 | 0499 | | B | Clarification for MBMS session start procedure | 15.1.0 | +| 2018-03 | CT#79 | CP-180049 | 0500 | | F | Addition of a note that input-packets / output-packets are not reported in SGi signalling with CUPS | 15.2.0 | +| 2018-06 | CT#80 | CP-181023 | 0501 | | B | Data Volume Reporting for Secondary RAT usage | 15.3.0 | +| 2018-06 | CT#80 | CP-181013 | 0502 | 2 | B | Updates to 3GPP-User-Location-Info AVP | 15.3.0 | +| 2018-06 | CT#80 | CP-181012 | 0503 | | B | Updates to 3GPP-PDP-Type AVP | 15.3.0 | +| 2018-06 | CT#80 | CP-181183 | 0504 | 3 | B | Updates to 3GPP-RAT-Type AVP | 15.3.0 | +| 2018-06 | CT#80 | CP-181012 | 0505 | 1 | B | Updates to 3GPP-GPRS-Negotiated-QoS-Profile AVP | 15.3.0 | +| 2018-06 | CT#80 | CP-181014 | 0506 | | F | Extended accounting octets for RADIUS | 15.3.0 | +| 2018-06 | CT#80 | CP-181023 | 0506 | | B | Differentiation of LTE-M (eMTC) | 15.3.0 | +| 2018-09 | CT#81 | CP-182015 | 0508 | | F | 3GPP-User-Location-Info AVP extension for 5G | 15.4.0 | +| 2018-09 | CT#81 | CP-182015 | 0509 | | F | Correction to 3GPP-GPRS-Negotiated-QoS-Profile AVP | 15.4.0 | +| 2018-12 | CT#82 | CP-183122 | 0510 | | F | Correct 3GPP-PDP-Type description in RADIUS VSA | 15.5.0 | +| 2020-06 | CT#88e | CP-201214 | 0511 | | F | Correct RAT type | 15.6.0 | +| 2020-06 | CT#88e | CP-201248 | 0511 | | F | Support secondary RAT data usage report | 16.0.0 | +| 2020-09 | CT#89e | CP-202060 | 0526 | | F | RAT Type extension for 5WWC | 16.1.0 | +| 2020-09 | CT#89e | CP-202078 | 0525 | | F | Corrections to Framed IPv6 | 17.0.0 | +| 2020-12 | CT#90e | CP-203144 | 0527 | | F | Corrections to IPv4 and IPv6 | 17.1.0 | +| 2020-12 | CT#90e | CP-203138 | 0529 | 1 | A | Corrections to Delegated-IPv6-Prefix | 17.1.0 | +| 2021-03 | CT#91e | CP-210216 | 0530 | | D | Correct figure number | 17.2.0 | +| 2021-06 | CT#92e | CP-211203 | 0533 | 1 | A | Correction to Framed IP | 17.3.0 | +| 2021-06 | CT#92e | CP-211233 | 0534 | | D | Editorial fix | 17.3.0 | +| 2021-06 | CT#92e | CP-211247 | 0535 | | B | Updates to support CUPS | 17.3.0 | +| 2021-06 | CT#92e | CP-211278 | 0536 | 3 | B | Updates to support L2TP for CUPS | 17.3.0 | +| 2021-06 | CT#92e | CP-211279 | 0537 | 2 | B | Updates to support L2TP in RADIUS message flow | 17.3.0 | +| 2021-06 | CT#92e | CP-211279 | 0538 | 2 | B | Updates to support L2TP in Diameter message flow | 17.3.0 | +| 2021-06 | CT#92e | CP-211212 | 0539 | 1 | B | Reporting UE local IP to Diameter DN-AAA server | 17.3.0 | +| 2021-06 | CT#92e | CP-211212 | 0540 | 1 | B | Reporting UE local IP to RADIUS DN-AAA server | 17.3.0 | +| 2021-06 | CT#92e | CP-211249 | 0541 | | D | Remove duplicated text for 3GPP-User-Location-Info | 17.3.0 | +| 2021-09 | CT#93e | CP-212197 | 0542 | | D | Fix L2TP procedure | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0543 | | D | Editorial fix for unrecognized word | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0544 | | F | Obsolete RFC4005 by RFC7155 | 17.4.0 | +| 2021-09 | CT#93e | CP-212197 | 0545 | | F | Fix editor notes for Tunnel-Password | 17.4.0 | +| 2021-12 | CT#94e | CP-213241 | 0547 | 1 | A | Correction of the applicability of the counted number of packets | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0548 | 1 | F | Clarification about the usage of Geographic Location Type values | 17.5.0 | +| 2022-03 | CT#95e | CP-220208 | 0549 | 1 | B | Update the 3GPP-RAT-Type AVP to support NR RedCap access type | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230175 | 0551 | 1 | F | P-GW setting DSCP | 18.0.0 | +| 2023-03 | CT#99 | CP-230174 | 0552 | | F | Format handling for 3GPP-User-Location-Info attribute | 18.0.0 | +| 2023-03 | CT#99 | CP-230174 | 0553 | | B | Updates on 3GPP-Packet-Filter | 18.0.0 | +| 2023-06 | CT#100 | CP-231133 | 0554 | | F | Handling of 3GPP User Location | 18.1.0 | \ No newline at end of file diff --git a/gsma/29_series/29122/raw.md b/gsma/29_series/29122/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ad601e14cd8a94036f0aff703056f5cb6f8f5045 --- /dev/null +++ b/gsma/29_series/29122/raw.md @@ -0,0 +1,26084 @@ + + +# 3GPP TS 29.122 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; T8 reference point for Northbound APIs; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above it and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. There is a small red signal wave icon under the 'G'. + +3GPP logo + +Keywords +SCEF, SCS/AS, HTTP + +**3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +**3GPP** + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------|----| +| Foreword..... | 20 | +| 1 Scope..... | 21 | +| 2 References..... | 21 | +| 3 Definitions and abbreviations..... | 23 | +| 3.1 Definitions..... | 23 | +| 3.2 Abbreviations..... | 23 | +| 4 T8 reference point..... | 24 | +| 4.1 Overview..... | 24 | +| 4.2 Reference model..... | 25 | +| 4.3 Functional elements..... | 25 | +| 4.3.1 SCEF..... | 25 | +| 4.3.2 SCS/AS..... | 26 | +| 4.4 Procedures over T8 reference point..... | 26 | +| 4.4.1 Introduction..... | 26 | +| 4.4.2 Monitoring Procedures..... | 26 | +| 4.4.2.1 General..... | 26 | +| 4.4.2.2 Monitoring Events Configuration..... | 26 | +| 4.4.2.2.1 General..... | 26 | +| 4.4.2.2.2 Monitoring Events Configuration via HSS..... | 28 | +| 4.4.2.2.2.1 General..... | 28 | +| 4.4.2.2.2.2 Configuration Request for an individual UE..... | 28 | +| 4.4.2.2.2.3 Configuration Request for a group of UEs..... | 29 | +| 4.4.2.2.3 Monitoring Events Configuration directly via MME/SGSN..... | 30 | +| 4.4.2.2.4 Monitoring Events Configuration via PCRF..... | 30 | +| 4.4.2.2.4.1 General..... | 30 | +| 4.4.2.2.4.2 Configuration Request for an individual UE..... | 31 | +| 4.4.2.2.4.3 Configuration Request for a group of UEs..... | 31 | +| 4.4.2.3 Reporting of Monitoring Event Procedure..... | 31 | +| 4.4.2.4 Network-initiated Explicit Monitoring Event Deletion Procedure..... | 32 | +| 4.4.2.5 Network initiated notification of applied parameter configuration..... | 32 | +| 4.4.3 Procedures for resource management of Background Data Transfer..... | 32 | +| 4.4.4 Procedures for changing the chargeable party at session set up or during the session..... | 33 | +| 4.4.5 Procedures for Non-IP Data Delivery..... | 34 | +| 4.4.5.1 General..... | 34 | +| 4.4.5.2 NIDD Configuration..... | 35 | +| 4.4.5.2.1 NIDD Configuration for a single UE..... | 35 | +| 4.4.5.2.2 NIDD Configuration for a group of UEs..... | 36 | +| 4.4.5.3 Mobile Terminated NIDD procedure..... | 36 | +| 4.4.5.3.1 Mobile Terminated NIDD for a single UE..... | 36 | +| 4.4.5.3.2 Mobile Terminated NIDD for a group of UEs..... | 38 | +| 4.4.5.4 Mobile Originated NIDD procedure..... | 38 | +| 4.4.5.5 NIDD Authorisation Update procedure..... | 39 | +| 4.4.5.6 Port Management Configuration..... | 39 | + +###### Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|-------------|-------------------------------------------------------------------|----| +| 4.4.5.6.1 | Port Reservation and Release..... | 39 | +| 4.4.5.6.2 | Port Notification..... | 40 | +| 4.4.6 | Procedures for Device Triggering..... | 41 | +| 4.4.7 | Procedures for Group Message Delivery..... | 42 | +| 4.4.7.1 | General..... | 42 | +| 4.4.7.2 | Group Message Delivery via MBMS..... | 42 | +| 4.4.7.2.1 | General..... | 42 | +| 4.4.7.2.2 | Group Message Delivery via MBMS by MB2..... | 42 | +| 4.4.7.2.2.1 | TMGI Allocation..... | 42 | +| 4.4.7.2.2.2 | TMGI Deallocation..... | 43 | +| 4.4.7.2.2.3 | Creation of group message delivery..... | 43 | +| 4.4.7.2.2.4 | Modification of previous submitted group message delivery..... | 43 | +| 4.4.7.2.2.5 | Cancellation of previous submitted group message delivery..... | 44 | +| 4.4.7.2.3 | Group message Delivery via MBMS by xMB..... | 44 | +| 4.4.7.2.3.1 | Service Creation..... | 44 | +| 4.4.7.2.3.2 | Service Deletion..... | 44 | +| 4.4.7.2.3.3 | Creation of group message delivery..... | 45 | +| 4.4.7.2.3.4 | Modification of previous submitted group message delivery..... | 45 | +| 4.4.7.2.3.5 | Cancellation of previous submitted group message delivery..... | 46 | +| 4.4.8 | Procedures for Reporting of Network Status..... | 46 | +| 4.4.8.1 | General..... | 46 | +| 4.4.8.2 | Network Status Reporting Subscription..... | 46 | +| 4.4.8.3 | Network Status Reporting Notification..... | 47 | +| 4.4.9 | Procedures for Communication Pattern Parameters Provisioning..... | 47 | +| 4.4.10 | Procedures for PFD Management..... | 48 | +| 4.4.11 | Procedures for Enhanced Coverage Restriction Control..... | 50 | +| 4.4.12 | Procedures for Network Parameter Configuration..... | 50 | +| 4.4.12.1 | General..... | 50 | +| 4.4.12.2 | Configuration Request for an individual UE..... | 51 | +| 4.4.12.3 | Configuration Request for a group of UEs..... | 51 | +| 4.4.12.4 | Notification of applied parameter configuration..... | 52 | +| 4.4.13 | Procedures for setting up an AS session with required QoS..... | 52 | +| 4.4.14 | Procedures for MSISDN-less Mobile Originated SMS..... | 53 | +| 4.4.14.1 | General..... | 53 | +| 4.4.14.2 | Delivery of MSISDN-less MO SMS..... | 53 | +| 4.4.15 | Procedures for RACS Parameter Provisioning..... | 54 | +| 5 | T8 APIs..... | 54 | +| 5.1 | Introduction..... | 54 | +| 5.2 | Information applicable to several APIs..... | 55 | +| 5.2.1 | Data Types..... | 55 | +| 5.2.1.1 | Introduction..... | 55 | +| 5.2.1.2 | Referenced structured data types..... | 58 | +| 5.2.1.2.1 | Type: SponsorInformation..... | 58 | +| 5.2.1.2.2 | Type: UsageThreshold..... | 58 | +| 5.2.1.2.3 | Type: TimeWindow..... | 58 | +| 5.2.1.2.4 | Type: Acknowledgement..... | 59 | +| 5.2.1.2.5 | Type: NotificationData..... | 59 | +| 5.2.1.2.6 | Type: EventReport..... | 59 | +| 5.2.1.2.7 | Type: AccumulatedUsage..... | 59 | +| 5.2.1.2.8 | Type: FlowInfo..... | 59 | +| 5.2.1.2.9 | Type: TestNotification..... | 60 | +| 5.2.1.2.10 | Type: WebsockNotifConfig..... | 60 | +| 5.2.1.2.11 | Type: LocationArea..... | 60 | +| 5.2.1.2.12 | Type: ProblemDetails..... | 61 | +| 5.2.1.2.13 | Type: InvalidParam..... | 61 | +| 5.2.1.2.14 | Type: PlmnId..... | 62 | +| 5.2.1.2.15 | Type: ConfigResult..... | 62 | +| 5.2.1.2.16 | Type: UsageThresholdRm..... | 62 | +| 5.2.1.2.17 | Type: LocationArea5G..... | 62 | +| 5.2.1.2.18 | Type: EthFlowInfo..... | 63 | +| 5.2.1.3 | Referenced Simple data types and enumerations..... | 63 | + +| | | | +|-----------|--------------------------------------------------------------------|-----| +| 5.2.1.3.1 | Introduction..... | 63 | +| 5.2.1.3.2 | Simple data types..... | 63 | +| 5.2.1.3.3 | Enumeration: Event..... | 64 | +| 5.2.1.3.4 | Enumeration: ResultReason..... | 65 | +| 5.2.1.4 | Conventions for documenting structured data types..... | 65 | +| 5.2.2 | Usage of HTTP..... | 66 | +| 5.2.2.1 | General..... | 66 | +| 5.2.2.2 | Usage of the HTTP PATCH method..... | 66 | +| 5.2.3 | Content type..... | 66 | +| 5.2.4 | URI structure..... | 67 | +| 5.2.4.1 | Resource URI structure..... | 67 | +| 5.2.4.2 | Custom operations URI structure..... | 67 | +| 5.2.4.3 | Callback URI structure..... | 67 | +| 5.2.5 | Notifications..... | 68 | +| 5.2.5.1 | General..... | 68 | +| 5.2.5.2 | Notification Delivery using a separate HTTP connection..... | 68 | +| 5.2.5.3 | Notification Test Event..... | 68 | +| 5.2.5.4 | Notification Delivery using Websocket..... | 68 | +| 5.2.6 | Error handling..... | 70 | +| 5.2.7 | Feature negotiation..... | 72 | +| 5.2.8 | HTTP custom headers..... | 72 | +| 5.2.8.1 | General..... | 72 | +| 5.2.8.2 | Reused HTTP custom headers..... | 72 | +| 5.2.8.3.1 | General..... | 72 | +| 5.2.9 | Conventions for Open API specification files..... | 74 | +| 5.2.9.1 | General..... | 74 | +| 5.2.9.2 | Formatting of OpenAPI files..... | 74 | +| 5.2.9.3 | Structured data types..... | 74 | +| 5.2.9.4 | Info..... | 76 | +| 5.2.9.5 | Servers..... | 76 | +| 5.2.9.6 | References to other 3GPP-defined Open API specification files..... | 76 | +| 5.2.9.7 | Server-initiated communication..... | 77 | +| 5.2.9.8 | Describing the body of HTTP PATCH requests..... | 77 | +| 5.2.9.8.1 | General..... | 77 | +| 5.2.9.8.2 | JSON Merge Patch..... | 77 | +| 5.2.9.8.3 | JSON PATCH..... | 78 | +| 5.2.9.9 | Error Responses..... | 78 | +| 5.2.9.10 | Enumerations..... | 79 | +| 5.2.9.11 | Read only attribute..... | 80 | +| 5.2.9.12 | externalDocs..... | 80 | +| 5.2.9.13 | Operation identifiers..... | 80 | +| 5.2.9.14 | Usage of the "tags" field..... | 80 | +| 5.2.10 | Redirection handling..... | 81 | +| 5.2.11 | Support of Load and Overload Control..... | 81 | +| 5.2.12 | Query parameters..... | 82 | +| 5.2.13 | Vendor-specific extensions..... | 82 | +| 5.2.13.1 | General 82 | | +| 5.2.13.2 | Vendor-specific extensions to the data model..... | 82 | +| 5.2.13.3 | Vendor-specific query parameters..... | 83 | +| 5.3 | MonitoringEvent API..... | 84 | +| 5.3.1 | Overview..... | 84 | +| 5.3.2 | Data model..... | 84 | +| 5.3.2.1 | Resource data types..... | 84 | +| 5.3.2.1.1 | Introduction..... | 84 | +| 5.3.2.1.2 | Type: MonitoringEventSubscription..... | 87 | +| 5.3.2.1.3 | Void..... | 99 | +| 5.3.2.2 | Notification data types..... | 99 | +| 5.3.2.2.1 | Introduction..... | 99 | +| 5.3.2.2.2 | Type: MonitoringNotification..... | 99 | +| 5.3.2.3 | Referenced structured data types..... | 100 | +| 5.3.2.3.1 | Introduction..... | 100 | + +| | | | +|---------------|---------------------------------------------------------|-----| +| 5.3.2.3.2 | Type: MonitoringEventReport..... | 100 | +| 5.3.2.3.3 | Type: IdleStatusInfo..... | 104 | +| 5.3.2.3.4 | Type: UePerLocationReport..... | 104 | +| 5.3.2.3.5 | Type: LocationInfo..... | 104 | +| 5.3.2.3.6 | Type: FailureCause..... | 106 | +| 5.3.2.3.7 | Type: PdnConnectionInformation..... | 107 | +| 5.3.2.3.8 | Type: AppliedParameterConfiguration..... | 107 | +| 5.3.2.3.9 | Type: ApiCapabilityInfo..... | 107 | +| 5.3.2.3.10 | Type: MonitoringEventReports..... | 108 | +| 5.3.2.3.11 | Type: UavPolicy..... | 108 | +| 5.3.2.3.11 | Type: ConsentRevocNotif..... | 108 | +| 5.3.2.3.12 | Type: ConsentRevoked..... | 109 | +| 5.3.2.3.13 | Type: GroupMembListChanges..... | 109 | +| 5.3.2.3.14 | Type: RangeDirection..... | 109 | +| 5.3.2.3.15 | Type: TwodrelativeLocation..... | 109 | +| 5.3.2.3.16 | Type: ThreedrelativeLocation..... | 109 | +| 5.3.2.3.17 | Type: UpLocRepAddrAfRm..... | 110 | +| 5.3.2.3.18 | Type: UpCumEvtRep..... | 110 | +| 5.3.2.4 | Referenced simple data types and enumerations..... | 110 | +| 5.3.2.4.1 | Introduction..... | 110 | +| 5.3.2.4.2 | Simple data types..... | 110 | +| 5.3.2.4.3 | Enumeration: MonitoringType..... | 110 | +| 5.3.2.4.4 | Enumeration: ReachabilityType..... | 111 | +| 5.3.2.4.5 | Enumeration: LocationType..... | 112 | +| 5.3.2.4.6 | Enumeration: AssociationType..... | 112 | +| 5.3.2.4.7 | Enumeration: Accuracy..... | 112 | +| 5.3.2.4.8 | Enumeration: PdnConnectionStatus..... | 113 | +| 5.3.2.4.9 | Enumeration: PdnType..... | 113 | +| 5.3.2.4.10 | Enumeration: InterfaceIndication..... | 113 | +| 5.3.2.4.11 | Enumeration: LocationFailureCause..... | 114 | +| 5.3.2.4.12 | Enumeration: SubType..... | 114 | +| 5.3.2.4.13 | Enumeration: SACRepFormat..... | 114 | +| 5.3.3 | Resource structure..... | 114 | +| 5.3.3.1 | General..... | 114 | +| 5.3.3.2 | Resource: Monitoring Event Subscriptions..... | 115 | +| 5.3.3.2.1 | Introduction..... | 115 | +| 5.3.3.2.2 | Resource definition..... | 115 | +| 5.3.3.2.3 | Resource methods..... | 115 | +| 5.3.3.2.3.1 | GET..... | 115 | +| 5.3.3.2.3.2 | PUT..... | 116 | +| 5.3.3.2.3.3 | PATCH..... | 116 | +| 5.3.3.2.3.4 | POST..... | 117 | +| 5.3.3.2.3.5 | DELETE..... | 118 | +| 5.3.3.3 | Resource: Individual Monitoring Event Subscription..... | 118 | +| 5.3.3.3.1 | Introduction..... | 118 | +| 5.3.3.3.2 | Resource definition..... | 118 | +| 5.3.3.3.3 | Resource methods..... | 118 | +| 5.3.3.3.3.1 | GET..... | 118 | +| 5.3.3.3.3.2 | PUT..... | 119 | +| 5.3.3.3.3.3 | PATCH..... | 120 | +| 5.3.3.3.3.4 | POST..... | 121 | +| 5.3.3.3.3.5 | DELETE..... | 121 | +| 5.3.3.4 | Void..... | 122 | +| 5.3.3.A | Notifications..... | 122 | +| 5.3.3.A.1 | General..... | 122 | +| 5.3.3.A.2 | Monitoring Notification..... | 123 | +| 5.3.3.A.2.1 | Description..... | 123 | +| 5.3.3.A.2.2 | Target URI..... | 123 | +| 5.3.3.A.2.3 | Standard Methods..... | 123 | +| 5.3.3.A.2.3.1 | Notification via POST..... | 123 | +| 5.3.3.A.2.3.2 | Notification via Websocket..... | 124 | + +| | | | +|--------------|----------------------------------------------------|-----| +| 5.3.3A.3 | User Consent Revocation Notification..... | 124 | +| 5.3.3A.3.1 | Description..... | 124 | +| 5.3.3A.3.2 | Target URI..... | 124 | +| 5.3.3A.3.3 | Operation Definition..... | 125 | +| 5.3.3A.3.3.1 | Notification via HTTP POST..... | 125 | +| 5.3.3A.3.3.2 | Notification via Websocket..... | 125 | +| 5.3.4 | Used Features..... | 125 | +| 5.3.5 | Error handling..... | 128 | +| 5.3.5.1 | General..... | 128 | +| 5.3.5.2 | Protocol Errors..... | 128 | +| 5.3.5.3 | Application Errors..... | 128 | +| 5.4 | ResourceManagementOfBdt API..... | 130 | +| 5.4.1 | Overview..... | 130 | +| 5.4.2 | Data model..... | 130 | +| 5.4.2.1 | Resource data types..... | 130 | +| 5.4.2.1.1 | Introduction..... | 130 | +| 5.4.2.1.2 | Type: Bdt..... | 130 | +| 5.4.2.1.3 | Type: BdtPatch..... | 131 | +| 5.4.2.1.4 | Type: ExNotification..... | 132 | +| 5.4.2.2 | Referenced structured data types..... | 132 | +| 5.4.2.2.1 | Introduction..... | 132 | +| 5.4.2.2.2 | Type: TransferPolicy..... | 132 | +| 5.4.2.3 | Referenced simple data types and enumerations..... | 133 | +| 5.4.2.3.1 | Introduction..... | 133 | +| 5.4.2.3.2 | Simple data types..... | 133 | +| 5.4.3 | Resource structure..... | 133 | +| 5.4.3.1 | General..... | 133 | +| 5.4.3.2 | Resource: BDT Subscriptions..... | 134 | +| 5.4.3.2.1 | Introduction..... | 134 | +| 5.4.3.2.2 | Resource definition..... | 134 | +| 5.4.3.2.3 | Resource methods..... | 134 | +| 5.4.3.2.3.1 | GET..... | 134 | +| 5.4.3.2.3.2 | PUT..... | 135 | +| 5.4.3.2.3.3 | PATCH..... | 135 | +| 5.4.3.2.3.4 | POST..... | 135 | +| 5.4.3.2.3.5 | DELETE..... | 136 | +| 5.4.3.3 | Resource: Individual BDT Subscription..... | 136 | +| 5.4.3.3.1 | Introduction..... | 136 | +| 5.4.3.3.2 | Resource definition..... | 136 | +| 5.4.3.3.3 | Resource methods..... | 136 | +| 5.4.3.3.3.1 | GET..... | 136 | +| 5.4.3.3.3.2 | PUT..... | 137 | +| 5.4.3.3.3.3 | PATCH..... | 138 | +| 5.4.3.3.3.4 | POST..... | 139 | +| 5.4.3.3.3.5 | DELETE..... | 139 | +| 5.4.3.4 | Void..... | 140 | +| 5.4.3A | Notifications..... | 140 | +| 5.4.3A.1 | General..... | 140 | +| 5.4.3A.2 | BDT Warning Notification..... | 141 | +| 5.4.3A.2.1 | Description..... | 141 | +| 5.4.3A.2.2 | Target URI..... | 141 | +| 5.4.3A.2.3 | Standard Methods..... | 141 | +| 5.4.3A.2.3.1 | Notification via POST..... | 141 | +| 5.4.3A.2.3.2 | Notification via Websocket..... | 142 | +| 5.4.4 | Used Features..... | 142 | +| 5.4.5 | Error handling..... | 142 | +| 5.4.5.1 | General..... | 142 | +| 5.4.5.2 | Protocol Errors..... | 142 | +| 5.4.5.3 | Application Errors..... | 142 | +| 5.5 | ChargeableParty API..... | 143 | +| 5.5.1 | Overview..... | 143 | + +| | | | +|--------------|--------------------------------------------------------|-----| +| 5.5.2 | Data model..... | 143 | +| 5.5.2.1 | Resource data types..... | 143 | +| 5.5.2.1.1 | Introduction..... | 143 | +| 5.5.2.1.2 | Type: ChargeableParty..... | 143 | +| 5.5.2.1.3 | Type: ChargeablePartyPatch..... | 145 | +| 5.5.3 | Resource structure..... | 145 | +| 5.5.3.1 | General..... | 145 | +| 5.5.3.2 | Resource: Chargeable Party Transactions..... | 146 | +| 5.5.3.2.1 | Introduction..... | 146 | +| 5.5.3.2.2 | Resource definition..... | 146 | +| 5.5.3.2.3 | Resource methods..... | 146 | +| 5.5.3.2.3.1 | GET..... | 146 | +| 5.5.3.2.3.2 | PUT..... | 147 | +| 5.5.3.2.3.3 | PATCH..... | 147 | +| 5.5.3.2.3.4 | POST..... | 147 | +| 5.5.3.2.3.5 | DELETE..... | 148 | +| 5.5.3.3 | Resource: Individual Chargeable Party Transaction..... | 148 | +| 5.5.3.3.1 | Introduction..... | 148 | +| 5.5.3.3.2 | Resource definition..... | 148 | +| 5.5.3.3.3 | Resource methods..... | 148 | +| 5.5.3.3.3.1 | GET..... | 148 | +| 5.5.3.3.3.2 | PUT..... | 149 | +| 5.5.3.3.3.3 | PATCH..... | 149 | +| 5.5.3.3.3.4 | POST..... | 150 | +| 5.5.3.3.3.5 | DELETE..... | 150 | +| 5.5.3.4 | Void..... | 151 | +| 5.5.3A | Notifications..... | 151 | +| 5.5.3A.1 | General..... | 151 | +| 5.5.3A.2 | Event Notification..... | 152 | +| 5.5.3A.2.1 | Description..... | 152 | +| 5.5.3A.2.2 | Target URI..... | 152 | +| 5.5.3A.2.3 | Standard Methods..... | 152 | +| 5.5.3A.2.3.1 | Notification via POST..... | 152 | +| 5.5.3A.2.3.2 | Notification via Websocket..... | 153 | +| 5.5.4 | Used Features..... | 153 | +| 5.5.5 | Error handling..... | 153 | +| 5.5.5.1 | General..... | 153 | +| 5.5.5.2 | Protocol Errors..... | 153 | +| 5.5.5.3 | Application Errors..... | 153 | +| 5.6 | NIDD API..... | 154 | +| 5.6.1 | Overview..... | 154 | +| 5.6.2 | Data model..... | 154 | +| 5.6.2.1 | Resource data types..... | 154 | +| 5.6.2.1.1 | Introduction..... | 154 | +| 5.6.2.1.2 | Type: NiddConfiguration..... | 155 | +| 5.6.2.1.3 | Type: NiddDownlinkDataTransfer..... | 157 | +| 5.6.2.1.4 | Type: NiddUplinkDataNotification..... | 159 | +| 5.6.2.1.5 | Type: NiddDownlinkDataDeliveryStatusNotification..... | 159 | +| 5.6.2.1.6 | Type: NiddConfigurationStatusNotification..... | 160 | +| 5.6.2.1.7 | Type: NiddConfigurationPatch..... | 160 | +| 5.6.2.1.8 | Type: GmdNiddDownlinkDataDeliveryNotification..... | 161 | +| 5.6.2.1.9 | Type: ManagePort..... | 161 | +| 5.6.2.1.10 | Type: ManagePortNotification..... | 162 | +| 5.6.2.1.11 | Type: NiddDownlinkDataTransferPatch..... | 162 | +| 5.6.2.2 | Referenced structured data types..... | 163 | +| 5.6.2.2.1 | Introduction..... | 163 | +| 5.6.2.2.2 | Type: RdsPort..... | 163 | +| 5.6.2.2.3 | Type: GmdResult..... | 164 | +| 5.6.2.2.4 | Type: NiddDownlinkDataDeliveryFailure..... | 164 | +| 5.6.2.2.5 | Type: RdsDownlinkDataDeliveryFailure..... | 164 | +| 5.6.2.3 | Referenced simple data types and enumerations..... | 165 | + +| | | | +|-------------|-------------------------------------------------------|-----| +| 5.6.2.3.1 | Introduction..... | 165 | +| 5.6.2.3.2 | Simple data types..... | 165 | +| 5.6.2.3.3 | Enumeration: PdnEstablishmentOptions..... | 165 | +| 5.6.2.3.4 | Enumeration: DeliveryStatus..... | 165 | +| 5.6.2.3.5 | Enumeration: NiddStatus..... | 166 | +| 5.6.2.3.6 | Enumeration: PdnEstablishmentOptionsRm..... | 166 | +| 5.6.2.3.7 | Enumeration: ManageEntity..... | 167 | +| 5.6.2.3.8 | Enumeration: SerializationFormat..... | 167 | +| 5.6.3 | Resource structure..... | 167 | +| 5.6.3.1 | General..... | 167 | +| 5.6.3.2 | Resource: NIDD Configurations..... | 168 | +| 5.6.3.2.1 | Introduction..... | 168 | +| 5.6.3.2.2 | Resource definition..... | 169 | +| 5.6.3.2.3 | Resource methods..... | 169 | +| 5.6.3.2.3.1 | GET..... | 169 | +| 5.6.3.2.3.2 | PUT..... | 170 | +| 5.6.3.2.3.3 | PATCH..... | 170 | +| 5.6.3.2.3.4 | POST..... | 170 | +| 5.6.3.2.3.5 | DELETE..... | 170 | +| 5.6.3.3 | Resource: Individual NIDD Configuration..... | 170 | +| 5.6.3.3.1 | Introduction..... | 170 | +| 5.6.3.3.2 | Resource definition..... | 171 | +| 5.6.3.3.3 | Resource methods..... | 171 | +| 5.6.3.3.3.1 | GET..... | 171 | +| 5.6.3.3.3.2 | PUT..... | 172 | +| 5.6.3.3.3.3 | PATCH..... | 172 | +| 5.6.3.3.3.4 | POST..... | 173 | +| 5.6.3.3.3.5 | DELETE..... | 173 | +| 5.6.3.4 | Resource: NIDD downlink data deliveries..... | 173 | +| 5.6.3.4.1 | Introduction..... | 173 | +| 5.6.3.4.2 | Resource definition..... | 174 | +| 5.6.3.4.3 | Resource methods..... | 174 | +| 5.6.3.4.3.1 | GET..... | 174 | +| 5.6.3.4.3.2 | PUT..... | 175 | +| 5.6.3.4.3.3 | PATCH..... | 175 | +| 5.6.3.4.3.4 | POST..... | 175 | +| 5.6.3.4.3.5 | DELETE..... | 177 | +| 5.6.3.5 | Resource: Individual NIDD downlink data delivery..... | 177 | +| 5.6.3.5.1 | Introduction..... | 177 | +| 5.6.3.5.2 | Resource definition..... | 177 | +| 5.6.3.5.3 | Resource methods..... | 177 | +| 5.6.3.5.3.1 | GET..... | 177 | +| 5.6.3.5.3.2 | PUT..... | 178 | +| 5.6.3.5.3.3 | PATCH..... | 179 | +| 5.6.3.5.3.4 | POST..... | 180 | +| 5.6.3.5.3.5 | DELETE..... | 181 | +| 5.6.3.6 | Void..... | 182 | +| 5.6.3.7 | Void..... | 182 | +| 5.6.3.8 | Void..... | 182 | +| 5.6.3.9 | Resource: Individual ManagePort Configuration..... | 182 | +| 5.6.3.9.1 | Introduction..... | 182 | +| 5.6.3.9.2 | Resource definition..... | 182 | +| 5.6.3.9.3 | Resource methods..... | 182 | +| 5.6.3.9.3.1 | GET..... | 182 | +| 5.6.3.9.3.2 | PUT..... | 183 | +| 5.6.3.9.3.3 | PATCH..... | 184 | +| 5.6.3.9.3.4 | POST..... | 184 | +| 5.6.3.9.3.5 | DELETE..... | 184 | +| 5.6.3.10 | Void..... | 185 | +| 5.6.3.11 | Resource: ManagePort Configurations..... | 185 | +| 5.6.3.11.1 | Introduction..... | 185 | + +| | | | +|--------------|-------------------------------------------------------|-----| +| 5.6.3.11.2 | Resource definition..... | 186 | +| 5.6.3.11.3 | Resource methods..... | 186 | +| 5.6.3.11.3.1 | GET..... | 186 | +| 5.6.3.11.3.2 | PUT..... | 187 | +| 5.6.3.11.3.3 | PATCH..... | 187 | +| 5.6.3.11.3.4 | POST..... | 187 | +| 5.6.3.11.3.5 | DELETE..... | 187 | +| 5.6.3A | Notifications..... | 187 | +| 5.6.3A.1 | General..... | 187 | +| 5.6.3A.2 | NIDD Configuration Update Notification..... | 187 | +| 5.6.3A.2.1 | Description..... | 187 | +| 5.6.3A.2.2 | Target URI..... | 188 | +| 5.6.3A.2.3 | Standard Methods..... | 188 | +| 5.6.3A.2.3.1 | Notification via POST..... | 188 | +| 5.6.3A.2.3.2 | Notification via Websocket..... | 189 | +| 5.6.3A.3 | NIDD Downlink Data Delivery Status Notification..... | 189 | +| 5.6.3A.3.1 | Description..... | 189 | +| 5.6.3A.3.2 | Target URI..... | 189 | +| 5.6.3A.3.3 | Standard Methods..... | 189 | +| 5.6.3A.3.3.1 | Notification via POST..... | 189 | +| 5.6.3A.3.3.2 | Notification via Websocket..... | 191 | +| 5.6.3A.4 | NIDD Uplink Data Notification..... | 191 | +| 5.6.3A.4.1 | Description..... | 191 | +| 5.6.3A.4.2 | Target URI..... | 191 | +| 5.6.3A.4.3 | Standard Methods..... | 191 | +| 5.6.3A.4.3.1 | Notification via POST..... | 191 | +| 5.6.3A.4.3.2 | Notification via Websocket..... | 192 | +| 5.6.3A.5 | ManagePort Notification..... | 192 | +| 5.6.3A.5.1 | Description..... | 192 | +| 5.6.3A.5.2 | Target URI..... | 192 | +| 5.6.3A.5.3 | Standard Methods..... | 193 | +| 5.6.3A.5.3.1 | Notification via POST..... | 193 | +| 5.6.3A.5.3.2 | Notification via Websocket..... | 193 | +| 5.6.4 | Used Features..... | 194 | +| 5.6.5 | Error handling..... | 194 | +| 5.6.5.1 | General..... | 194 | +| 5.6.5.2 | Protocol Errors..... | 194 | +| 5.6.5.3 | Application Errors..... | 194 | +| 5.7 | DeviceTriggering API..... | 195 | +| 5.7.1 | Overview..... | 195 | +| 5.7.2 | Data model..... | 195 | +| 5.7.2.1 | Resource data types..... | 195 | +| 5.7.2.1.1 | Introduction..... | 195 | +| 5.7.2.1.2 | Type: DeviceTriggering..... | 196 | +| 5.7.2.1.3 | Type: DeviceTriggeringDeliveryReportNotification..... | 197 | +| 5.7.2.1.4 | Type: DeviceTriggeringPatch..... | 198 | +| 5.7.2.2 | Referenced simple data types and enumerations..... | 198 | +| 5.7.2.2.1 | Introduction..... | 198 | +| 5.7.2.2.2 | Simple data types..... | 198 | +| 5.7.2.2.3 | Enumeration: DeliveryResult..... | 198 | +| 5.7.2.2.4 | Enumeration: Priority..... | 199 | +| 5.7.3 | Resource structure..... | 199 | +| 5.7.3.1 | General..... | 199 | +| 5.7.3.2 | Resource: Device Triggering Transactions..... | 200 | +| 5.7.3.2.1 | Introduction..... | 200 | +| 5.7.3.2.2 | Resource definition..... | 200 | +| 5.7.3.2.3 | Resource methods..... | 200 | +| 5.7.3.2.3.1 | GET..... | 200 | +| 5.7.3.2.3.2 | PUT..... | 201 | +| 5.7.3.2.3.3 | PATCH..... | 201 | +| 5.7.3.2.3.4 | POST..... | 201 | + +| | | | +|---------------|---------------------------------------------------------|-----| +| 5.7.3.2.3.5 | DELETE..... | 202 | +| 5.7.3.3 | Resource: Individual Device Triggering Transaction..... | 202 | +| 5.7.3.3.1 | Introduction..... | 202 | +| 5.7.3.3.2 | Resource definition..... | 202 | +| 5.7.3.3.3 | Resource methods..... | 202 | +| 5.7.3.3.3.1 | GET..... | 202 | +| 5.7.3.3.3.2 | PUT..... | 203 | +| 5.7.3.3.3.3 | PATCH..... | 204 | +| 5.7.3.3.3.4 | POST..... | 205 | +| 5.7.3.3.3.5 | DELETE..... | 205 | +| 5.7.3.4 | Void..... | 206 | +| 5.7.3A | Notifications..... | 206 | +| 5.7.3A.1 | General..... | 206 | +| 5.7.3A.2 | Device Triggering Delivery Report Notification..... | 207 | +| 5.7.3A.2.1 | Description..... | 207 | +| 5.7.3A.2.2 | Target URI..... | 207 | +| 5.7.3A.2.3 | Standard Methods..... | 207 | +| 5.7.3A.2.3.1 | Notification via POST..... | 207 | +| 5.7.3a.2.3.2 | Notification via Websocket..... | 208 | +| 5.7.4 | Used Features..... | 208 | +| 5.7.5 | Error handling..... | 208 | +| 5.7.5.1 | General..... | 208 | +| 5.7.5.2 | Protocol Errors..... | 208 | +| 5.7.5.3 | Application Errors..... | 208 | +| 5.8 | GMD via MBMS related APIs..... | 209 | +| 5.8.1 | Overview..... | 209 | +| 5.8.2 | GMDviaMBMSByMB2 API..... | 209 | +| 5.8.2.1 | Data model..... | 209 | +| 5.8.2.1.1 | Resource data types..... | 209 | +| 5.8.2.1.1.1 | Introduction..... | 209 | +| 5.8.2.1.1.2 | Type: TMGIAllocation..... | 209 | +| 5.8.2.1.1.3 | Type: GMDViaMBMSByMb2..... | 210 | +| 5.8.2.1.1.4 | Type: GMDByMb2Notification..... | 211 | +| 5.8.2.1.1.5 | Type: TMGIAllocationPatch..... | 211 | +| 5.8.2.1.1.6 | Type: GMDViaMBMSByMb2Patch..... | 211 | +| 5.8.2.1.1.7 | Type: MbmsLocArea..... | 212 | +| 5.8.2.2 | Resource structure..... | 212 | +| 5.8.2.2.1 | General..... | 212 | +| 5.8.2.2.2 | Resource: TMGI Allocation..... | 213 | +| 5.8.2.2.2.1 | Introduction..... | 213 | +| 5.8.2.2.2.2 | Resource definition..... | 213 | +| 5.8.2.2.2.3 | Resource methods..... | 213 | +| 5.8.2.2.2.3.1 | GET..... | 213 | +| 5.8.2.2.2.3.2 | PUT..... | 214 | +| 5.8.2.2.2.3.3 | PATCH..... | 214 | +| 5.8.2.2.2.3.4 | POST..... | 214 | +| 5.8.2.2.2.3.5 | DELETE..... | 215 | +| 5.8.2.2.3 | Resource: Individual TMGI Allocation..... | 215 | +| 5.8.2.2.3.1 | Introduction..... | 215 | +| 5.8.2.2.3.2 | Resource definition..... | 215 | +| 5.8.2.2.3.3 | Resource methods..... | 215 | +| 5.8.2.2.3.3.1 | GET..... | 215 | +| 5.8.2.2.3.3.2 | PUT..... | 216 | +| 5.8.2.2.3.3.3 | PATCH..... | 217 | +| 5.8.2.2.3.3.4 | POST..... | 218 | +| 5.8.2.2.3.3.5 | DELETE..... | 218 | +| 5.8.2.2.4 | Resource: GMD via MBMS by MB2..... | 219 | +| 5.8.2.2.4.1 | Introduction..... | 219 | +| 5.8.2.2.4.2 | Resource definition..... | 219 | +| 5.8.2.2.4.3 | Resource methods..... | 220 | +| 5.8.2.2.4.3.1 | GET..... | 220 | + +| | | | +|----------------|----------------------------------------------------|-----| +| 5.8.2.2.4.3.2 | PUT..... | 220 | +| 5.8.2.2.4.3.3 | PATCH..... | 220 | +| 5.8.2.2.4.3.4 | POST..... | 220 | +| 5.8.2.2.4.3.5 | DELETE..... | 221 | +| 5.8.2.2.5 | Resource: Individual GMD via MBMS by MB2..... | 221 | +| 5.8.2.2.5.1 | Introduction..... | 221 | +| 5.8.2.2.5.2 | Resource definition..... | 221 | +| 5.8.2.2.5.3 | Resource methods..... | 221 | +| 5.8.2.2.5.3.1 | GET..... | 221 | +| 5.8.2.2.5.3.2 | PUT..... | 222 | +| 5.8.2.2.5.3.3 | PATCH..... | 223 | +| 5.8.2.2.5.3.4 | POST..... | 224 | +| 5.8.2.2.5.3.5 | DELETE..... | 224 | +| 5.8.2.2.6 | Void..... | 225 | +| 5.8.2.2A | Notifications..... | 225 | +| 5.8.2.2A.1 | General..... | 225 | +| 5.8.2.2A.2 | GMD via MBMS by MB2 Notification..... | 226 | +| 5.8.2.2A.2.1 | Description..... | 226 | +| 5.8.2.2A.2.2 | Target URI..... | 226 | +| 5.8.2.2A.2.3 | Standard Methods..... | 226 | +| 5.8.2.2A.2.3.1 | Notification via POST..... | 226 | +| 5.8.2.2A.2.3.2 | Notification via Websocket..... | 227 | +| 5.8.2.3 | Used Features..... | 227 | +| 5.8.2.4 | Error handling..... | 227 | +| 5.8.2.4.1 | General..... | 227 | +| 5.8.2.4.2 | Protocol Errors..... | 227 | +| 5.8.2.4.3 | Application Errors..... | 227 | +| 5.8.3 | GMDviaMBMSByxMB API..... | 228 | +| 5.8.3.1 | Data model..... | 228 | +| 5.8.3.1.1 | Resource data types..... | 228 | +| 5.8.3.1.1.1 | Introduction..... | 228 | +| 5.8.3.1.1.2 | Type: ServiceCreation..... | 228 | +| 5.8.3.1.1.3 | Type: GMDViaMBMSByxMB..... | 229 | +| 5.8.3.1.1.4 | Type: GMDBByxMBNotification..... | 230 | +| 5.8.3.1.1.5 | Type: GMDViaMBMSByxMBPatch..... | 230 | +| 5.8.3.1.1.6 | Type: MbmsLocArea..... | 231 | +| 5.8.3.1.2 | Referenced simple data types and enumerations..... | 231 | +| 5.8.3.1.2.1 | Introduction..... | 231 | +| 5.8.3.1.2.2 | Simple data types..... | 231 | +| 5.8.3.1.2.3 | Enumeration: ServiceAnnouncementMode..... | 232 | +| 5.8.3.2 | Resource structure..... | 232 | +| 5.8.3.2.1 | General..... | 232 | +| 5.8.3.2.2 | Resource: xMB Services..... | 233 | +| 5.8.3.2.2.1 | Introduction..... | 233 | +| 5.8.3.2.2.2 | Resource definition..... | 233 | +| 5.8.3.2.2.3 | Resource methods..... | 233 | +| 5.8.3.2.2.3.1 | GET..... | 233 | +| 5.8.3.2.2.3.2 | PUT..... | 234 | +| 5.8.3.2.2.3.3 | PATCH..... | 234 | +| 5.8.3.2.2.3.4 | POST..... | 234 | +| 5.8.3.2.2.3.5 | DELETE..... | 235 | +| 5.8.3.2.3 | Resource: Individual xMB Service..... | 235 | +| 5.8.3.2.3.1 | Introduction..... | 235 | +| 5.8.3.2.3.2 | Resource definition..... | 235 | +| 5.8.3.2.3.3 | Resource methods..... | 235 | +| 5.8.3.2.3.3.1 | GET..... | 235 | +| 5.8.3.2.3.3.2 | PUT..... | 236 | +| 5.8.3.2.3.3.3 | PATCH..... | 236 | +| 5.8.3.2.3.3.4 | POST..... | 236 | +| 5.8.3.2.3.3.5 | DELETE..... | 236 | +| 5.8.3.2.4 | Resource: GMD via MBMS by xMB..... | 237 | + +| | | | +|----------------|-----------------------------------------------------------------|-----| +| 5.8.3.2.4.1 | Introduction..... | 237 | +| 5.8.3.2.4.2 | Resource definition..... | 237 | +| 5.8.3.2.4.3 | Resource methods..... | 238 | +| 5.8.3.2.4.3.1 | GET..... | 238 | +| 5.8.3.2.4.3.2 | PUT..... | 238 | +| 5.8.3.2.4.3.3 | PATCH..... | 238 | +| 5.8.3.2.4.3.4 | POST..... | 238 | +| 5.8.3.2.4.3.5 | DELETE..... | 239 | +| 5.8.3.2.5 | Resource: Individual GMD via MBMS by xMB..... | 239 | +| 5.8.3.2.5.1 | Introduction..... | 239 | +| 5.8.3.2.5.2 | Resource definition..... | 239 | +| 5.8.3.2.5.3 | Resource methods..... | 239 | +| 5.8.3.2.5.3.1 | GET..... | 239 | +| 5.8.3.2.5.3.2 | PUT..... | 240 | +| 5.8.3.2.5.3.3 | PATCH..... | 241 | +| 5.8.3.2.5.3.4 | POST..... | 242 | +| 5.8.3.2.5.3.5 | DELETE..... | 242 | +| 5.8.3.2.6 | Void..... | 243 | +| 5.8.3.2A | Notifications..... | 243 | +| 5.8.3.2A.1 | General..... | 243 | +| 5.8.3.2A.2 | GMD via MBMS by xMB Notification..... | 244 | +| 5.8.3.2A.2.1 | Description..... | 244 | +| 5.8.3.2A.2.2 | Target URI..... | 244 | +| 5.8.3.2A.2.3 | Standard Methods..... | 244 | +| 5.8.3.2A.2.3.1 | Notification via POST..... | 244 | +| 5.8.3.2A.2.3.2 | Notification via Websocket..... | 245 | +| 5.8.3.3 | Used Features..... | 245 | +| 5.8.3.4 | Error handling..... | 245 | +| 5.8.3.4.1 | General..... | 245 | +| 5.8.3.4.2 | Protocol Errors..... | 245 | +| 5.8.3.4.3 | Application Errors..... | 245 | +| 5.9 | ReportingNetworkStatus API..... | 246 | +| 5.9.1 | Overview..... | 246 | +| 5.9.2 | Data model..... | 246 | +| 5.9.2.1 | Resource data types..... | 246 | +| 5.9.2.1.1 | Introduction..... | 246 | +| 5.9.2.1.2 | Type: NetworkStatusReportingSubscription..... | 246 | +| 5.9.2.1.3 | Type: NetStatusRepSubsPatch..... | 247 | +| 5.9.2.2 | Notification data types..... | 248 | +| 5.9.2.2.1 | Introduction..... | 248 | +| 5.9.2.2.2 | Type: NetworkStatusReportingNotification..... | 248 | +| 5.9.2.3 | Referenced simple data types and enumerations..... | 249 | +| 5.9.2.3.1 | Introduction..... | 249 | +| 5.9.2.3.2 | Simple data types..... | 249 | +| 5.9.2.3.3 | Enumeration: CongestionType..... | 249 | +| 5.9.3 | Resource structure..... | 249 | +| 5.9.3.1 | General..... | 249 | +| 5.9.3.2 | Resource: Network Status Reporting Subscriptions..... | 250 | +| 5.9.3.2.1 | Introduction..... | 250 | +| 5.9.3.2.2 | Resource definition..... | 250 | +| 5.9.3.2.3 | Resource methods..... | 250 | +| 5.9.3.2.3.1 | GET..... | 250 | +| 5.9.3.2.3.2 | PUT..... | 251 | +| 5.9.3.2.3.3 | PATCH..... | 251 | +| 5.9.3.2.3.4 | POST..... | 251 | +| 5.9.3.2.3.5 | DELETE..... | 252 | +| 5.9.3.3 | Resource: Individual Network Status Reporting Subscription..... | 252 | +| 5.9.3.3.1 | Introduction..... | 252 | +| 5.9.3.3.2 | Resource definition..... | 252 | +| 5.9.3.3.3 | Resource methods..... | 252 | +| 5.9.3.3.3.1 | GET..... | 252 | + +| | | | +|--------------|--------------------------------------------------------|-----| +| 5.9.3.3.3.2 | PUT..... | 253 | +| 5.9.3.3.3.3 | PATCH..... | 254 | +| 5.9.3.3.3.4 | POST..... | 255 | +| 5.9.3.3.3.5 | DELETE..... | 255 | +| 5.9.3.4 | Void..... | 256 | +| 5.9.3A | Notifications..... | 256 | +| 5.9.3A.1 | General..... | 256 | +| 5.9.3A.2 | Network Status Reporting Notification..... | 257 | +| 5.9.3A.2.1 | Description..... | 257 | +| 5.9.3A.2.2 | Target URI..... | 257 | +| 5.9.3A.2.3 | Standard Methods..... | 257 | +| 5.9.3A.2.3.1 | Notification via POST..... | 257 | +| 5.9.3A.2.3.2 | Notification via Websocket..... | 258 | +| 5.9.4 | Used Features..... | 258 | +| 5.9.5 | Error handling..... | 258 | +| 5.9.5.1 | General..... | 258 | +| 5.9.5.2 | Protocol Errors..... | 258 | +| 5.9.5.3 | Application Errors..... | 258 | +| 5.10 | CpProvisioning API..... | 259 | +| 5.10.1 | Overview..... | 259 | +| 5.10.2 | Data model..... | 259 | +| 5.10.2.1 | Resource data types..... | 259 | +| 5.10.2.1.1 | Introduction..... | 259 | +| 5.10.2.1.2 | Type: CpInfo..... | 260 | +| 5.10.2.2 | Referenced structured data types..... | 262 | +| 5.10.2.2.1 | Introduction..... | 262 | +| 5.10.2.2.2 | Type: CpParameterSet..... | 262 | +| 5.10.2.2.3 | Type: ScheduledCommunicationTime..... | 264 | +| 5.10.2.2.4 | Type: CpReport..... | 264 | +| 5.10.2.2.5 | Type: UmtLocationArea5G..... | 264 | +| 5.10.2.2.6 | Type: AppExpUeBehaviour..... | 266 | +| 5.10.2.3 | Referenced simple data types and enumerations..... | 267 | +| 5.10.2.3.1 | Introduction..... | 267 | +| 5.10.2.3.2 | Simple data types..... | 267 | +| 5.10.2.3.3 | Enumeration: CommunicationIndicator..... | 267 | +| 5.10.2.3.4 | Enumeration: StationaryIndication..... | 267 | +| 5.10.2.3.5 | Enumeration: CpFailureCode..... | 267 | +| 5.10.2.3.6 | Enumeration: BatteryIndication..... | 268 | +| 5.10.2.3.7 | Enumeration: TrafficProfile..... | 268 | +| 5.10.2.3.8A | Enumeration: ScheduledCommunicationType..... | 268 | +| 5.10.3 | Resource structure..... | 269 | +| 5.10.3.1 | General..... | 269 | +| 5.10.3.2 | Resource: CP Provisioning Subscriptions..... | 269 | +| 5.10.3.2.1 | Introduction..... | 269 | +| 5.10.3.2.2 | Resource definition..... | 270 | +| 5.10.3.2.3 | Resource methods..... | 270 | +| 5.10.3.2.3.1 | GET..... | 270 | +| 5.10.3.2.3.2 | PUT..... | 271 | +| 5.10.3.2.3.3 | PATCH..... | 271 | +| 5.10.3.2.3.4 | POST..... | 271 | +| 5.10.3.2.3.5 | DELETE..... | 271 | +| 5.10.3.3 | Resource: Individual CP Provisioning Subscription..... | 272 | +| 5.10.3.3.1 | Introduction..... | 272 | +| 5.10.3.3.2 | Resource definition..... | 272 | +| 5.10.3.3.3 | Resource methods..... | 272 | +| 5.10.3.3.3.1 | GET..... | 272 | +| 5.10.3.3.3.2 | PUT..... | 273 | +| 5.10.3.3.3.3 | PATCH..... | 274 | +| 5.10.3.3.3.4 | POST..... | 274 | +| 5.10.3.3.3.5 | DELETE..... | 274 | +| 5.10.3.4 | Resource: Individual CP Set Provisioning..... | 275 | + +| | | | +|--------------|------------------------------------------------------|-----| +| 5.10.3.4.1 | Introduction..... | 275 | +| 5.10.3.4.2 | Resource definition..... | 275 | +| 5.10.3.4.3 | Resource methods..... | 275 | +| 5.10.3.4.3.1 | GET..... | 275 | +| 5.10.3.4.3.2 | PUT..... | 276 | +| 5.10.3.4.3.3 | PATCH..... | 277 | +| 5.10.3.4.3.4 | POST..... | 277 | +| 5.10.3.4.3.5 | DELETE..... | 277 | +| 5.10.4 | Used Features..... | 278 | +| 5.10.5 | Error handling..... | 278 | +| 5.10.5.1 | General..... | 278 | +| 5.10.5.2 | Protocol Errors..... | 278 | +| 5.10.5.3 | Application Errors..... | 278 | +| 5.11 | PfdManagement API..... | 279 | +| 5.11.1 | Overview..... | 279 | +| 5.11.2 | Data model..... | 279 | +| 5.11.2.1 | Resource data types..... | 279 | +| 5.11.2.1.1 | Introduction..... | 279 | +| 5.11.2.1.2 | Type: PfdManagement..... | 280 | +| 5.11.2.1.3 | Type: PfdData..... | 281 | +| 5.11.2.1.4 | Type: Pfd..... | 281 | +| 5.11.2.1.5 | Type: PfdReport..... | 282 | +| 5.11.2.1.6 | Type: UserPlaneLocationArea..... | 282 | +| 5.11.2.1.7 | Type: PfdManagementPatch..... | 283 | +| 5.11.2.2 | Referenced simple data types and enumerations..... | 283 | +| 5.11.2.2.1 | Introduction..... | 283 | +| 5.11.2.2.2 | Simple data types..... | 283 | +| 5.11.2.2.3 | Enumeration: FailureCode..... | 284 | +| 5.11.2.2.4 | Enumeration: DomainNameProtocol..... | 284 | +| 5.11.3 | Resource structure..... | 284 | +| 5.11.3.1 | General..... | 284 | +| 5.11.3.2 | Resource: PFD Management Transactions..... | 285 | +| 5.11.3.2.1 | Introduction..... | 285 | +| 5.11.3.2.2 | Resource definition..... | 285 | +| 5.11.3.2.3 | Resource methods..... | 286 | +| 5.11.3.2.3.1 | GET..... | 286 | +| 5.11.3.2.3.2 | PUT..... | 286 | +| 5.11.3.2.3.3 | POST..... | 287 | +| 5.11.3.2.3.4 | PATCH..... | 287 | +| 5.11.3.2.3.5 | DELETE..... | 287 | +| 5.11.3.3 | Resource: Individual PFD Management Transaction..... | 288 | +| 5.11.3.3.1 | Introduction..... | 288 | +| 5.11.3.3.2 | Resource definition..... | 288 | +| 5.11.3.3.3 | Resource methods..... | 288 | +| 5.11.3.3.3.1 | GET..... | 288 | +| 5.11.3.3.3.2 | PUT..... | 289 | +| 5.11.3.3.3.3 | PATCH..... | 290 | +| 5.11.3.3.3.4 | POST..... | 291 | +| 5.11.3.3.3.5 | DELETE..... | 291 | +| 5.11.3.4 | Resource: Individual Application PFD Management..... | 292 | +| 5.11.3.4.1 | Introduction..... | 292 | +| 5.11.3.4.2 | Resource definition..... | 292 | +| 5.11.3.4.3 | Resource methods..... | 293 | +| 5.11.3.4.3.1 | GET..... | 293 | +| 5.11.3.4.3.2 | PUT..... | 293 | +| 5.11.3.4.3.3 | PATCH..... | 294 | +| 5.11.3.4.3.4 | POST..... | 295 | +| 5.11.3.4.3.5 | DELETE..... | 295 | +| 5.11.3.5 | Void..... | 296 | +| 5.11.3.A | Notifications..... | 296 | +| 5.11.3.A.1 | General..... | 296 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 5.11.3A.2 | PFD Management Notification..... | 297 | +| 5.11.3A.2.1 | Description..... | 297 | +| 5.11.3A.2.2 | Target URI..... | 297 | +| 5.11.3A.2.3 | Standard Methods..... | 297 | +| 5.11.3A.2.3.1 | Notification via POST..... | 297 | +| 5.11.3A.2.3.2 | Notification via Websocket..... | 298 | +| 5.11.4 | Used Features..... | 298 | +| 5.11.5 | Error handling..... | 298 | +| 5.11.5.1 | General..... | 298 | +| 5.11.5.2 | Protocol Errors..... | 298 | +| 5.11.5.3 | Application Errors..... | 298 | +| 5.12 | ECRControl API..... | 299 | +| 5.12.1 | Overview..... | 299 | +| 5.12.2 | Data model..... | 299 | +| 5.12.2.1 | Data types..... | 299 | +| 5.12.2.1.1 | Introduction..... | 299 | +| 5.12.2.1.2 | Type: ECRControl..... | 299 | +| 5.12.2.1.3 | Type: ECRData..... | 300 | +| 5.12.2.1.4 | Type: PlmnEcRestrictionDataWb..... | 301 | +| 5.12.3 | Custom Operations without associated resources..... | 301 | +| 5.12.3.1 | Overview..... | 301 | +| 5.12.3.2 | Operation: query..... | 301 | +| 5.12.3.2.1 | Description..... | 301 | +| 5.12.3.2.2 | Operation Definition..... | 301 | +| 5.12.3.3 | Operation: configure..... | 302 | +| 5.12.3.3.1 | Description..... | 302 | +| 5.12.3.3.2 | Operation Definition..... | 303 | +| 5.12.4 | Used Features..... | 303 | +| 5.12.5 | Error handling..... | 304 | +| 5.12.5.1 | General..... | 304 | +| 5.12.5.2 | Protocol Errors..... | 304 | +| 5.12.5.3 | Application Errors..... | 304 | +| 5.13 | NpConfiguration API..... | 304 | +| 5.13.1 | Overview..... | 304 | +| 5.13.2 | Data model..... | 304 | +| 5.13.2.1 | Resource data types..... | 304 | +| 5.13.2.1.1 | Introduction..... | 304 | +| 5.13.2.1.2 | Type: NpConfiguration..... | 305 | +| 5.13.2.1.3 | Type: NpConfigurationPatch..... | 307 | +| 5.13.2.1.4 | Type: ConfigurationNotification..... | 307 | +| 5.13.3 | Resource structure..... | 308 | +| 5.13.3.1 | General..... | 308 | +| 5.13.3.2 | Resource: NP Configurations..... | 308 | +| 5.13.3.2.1 | Introduction..... | 308 | +| 5.13.3.2.2 | Resource definition..... | 308 | +| 5.13.3.2.3 | Resource methods..... | 308 | +| 5.13.3.2.3.1 | GET..... | 308 | +| 5.13.3.2.3.2 | PUT..... | 309 | +| 5.13.3.2.3.3 | PATCH..... | 309 | +| 5.13.3.2.3.4 | POST..... | 309 | +| 5.13.3.2.3.5 | DELETE..... | 310 | +| 5.13.3.3 | Resource: Individual NP Configuration..... | 310 | +| 5.13.3.3.1 | Introduction..... | 310 | +| 5.13.3.3.2 | Resource definition..... | 310 | +| 5.13.3.3.3 | Resource methods..... | 311 | +| 5.13.3.3.3.1 | GET..... | 311 | +| 5.13.3.3.3.2 | PUT..... | 311 | +| 5.13.3.3.3.3 | PATCH..... | 312 | +| 5.13.3.3.3.4 | POST..... | 313 | +| 5.13.3.3.3.5 | DELETE..... | 313 | +| 5.13.3.4 | Void..... | 314 | + +| | | | +|----------------|---------------------------------------------------------------------|-----| +| 5.13.3.A | Notifications..... | 314 | +| 5.13.3.A.1 | General..... | 314 | +| 5.13.3.A.2 | Configuration Notification..... | 315 | +| 5.13.3.A.2.1 | Description..... | 315 | +| 5.13.3.A.2.2 | Target URI..... | 315 | +| 5.13.3.A.2.3 | Standard Methods..... | 315 | +| 5.13.3.A.2.3.1 | Notification via POST..... | 315 | +| 5.13.3.A.2.3.2 | Notification via Websocket..... | 316 | +| 5.13.4 | Used Features..... | 316 | +| 5.13.5 | Error handling..... | 317 | +| 5.13.5.1 | General..... | 317 | +| 5.13.5.2 | Protocol Errors..... | 317 | +| 5.13.5.3 | Application Errors..... | 317 | +| 5.14 | AsSessionWithQoS API..... | 317 | +| 5.14.1 | Overview..... | 317 | +| 5.14.2 | Data model..... | 317 | +| 5.14.2.1 | Resource data types..... | 317 | +| 5.14.2.1.1 | Introduction..... | 317 | +| 5.14.2.1.2 | Type: AsSessionWithQoSSubscription..... | 320 | +| 5.14.2.1.3 | Type: AsSessionWithQoSSubscriptionPatch..... | 324 | +| 5.14.2.1.4 | Type: UserPlaneNotificationData..... | 327 | +| 5.14.2.1.5 | Type: UserPlaneEventReport..... | 327 | +| 5.14.2.1.6 | Type: QosMonitoringInformation..... | 330 | +| 5.14.2.1.7 | Type: QosMonitoringInformationRm..... | 331 | +| 5.14.2.1.8 | Type: QosMonitoringReport..... | 333 | +| 5.14.2.1.9 | Type: TscQoSRequirement..... | 334 | +| 5.14.2.1.10 | Type: TscQoSRequirementRm..... | 334 | +| 5.14.2.1.11 | Type AdditionalInfoAsSessionWithQos..... | 335 | +| 5.14.2.1.12 | Type: ProblemDetailsAsSessionWithQos..... | 335 | +| 5.14.2.1.13 | Type AsSessionMediaComponent..... | 335 | +| 5.14.2.1.14 | Type AsSessionMediaComponentRm..... | 337 | +| 5.14.2.1.15 | Type: MultiModalFlows..... | 339 | +| 5.14.2.1.16 | Type: UeAddInfo..... | 339 | +| 5.14.2.2 | Referenced simple data types and enumerations..... | 339 | +| 5.14.2.2.1 | Introduction..... | 339 | +| 5.14.2.2.2 | Simple data types..... | 339 | +| 5.14.2.2.3 | Enumeration: UserPlaneEvent..... | 339 | +| 5.14.3 | Resource structure..... | 340 | +| 5.14.3.1 | General..... | 340 | +| 5.14.3.2 | Resource: AS Session with Required QoS subscriptions..... | 341 | +| 5.14.3.2.1 | Introduction..... | 341 | +| 5.14.3.2.2 | Resource definition..... | 341 | +| 5.14.3.2.3 | Resource methods..... | 341 | +| 5.14.3.2.3.1 | GET..... | 341 | +| 5.14.3.2.3.2 | PUT..... | 342 | +| 5.14.3.2.3.3 | PATCH..... | 342 | +| 5.14.3.2.3.4 | POST..... | 342 | +| 5.14.3.2.3.5 | DELETE..... | 343 | +| 5.14.3.3 | Resource: Individual AS Session with Required QoS Subscription..... | 343 | +| 5.14.3.3.1 | Introduction..... | 343 | +| 5.14.3.3.2 | Resource definition..... | 343 | +| 5.14.3.3.3 | Resource methods..... | 344 | +| 5.14.3.3.3.1 | GET..... | 344 | +| 5.14.3.3.3.2 | PUT..... | 345 | +| 5.14.3.3.3.3 | PATCH..... | 346 | +| 5.14.3.3.3.4 | POST..... | 347 | +| 5.14.3.3.3.5 | DELETE..... | 347 | +| 5.14.3.4 | Void..... | 348 | +| 5.14.3.A | Notifications..... | 348 | +| 5.14.3.A.1 | General..... | 348 | +| 5.14.3.A.2 | Event Notification..... | 348 | + +| | | | +|----------------|-------------------------------------------------------|-----| +| 5.14.3.A.2.1 | Description..... | 348 | +| 5.14.3.A.2.2 | Target URI..... | 348 | +| 5.14.3.A.2.3 | Standard Methods..... | 348 | +| 5.14.3.A.2.3.1 | Notification via POST..... | 348 | +| 5.14.3.A.2.3.2 | Notification via Websocket..... | 349 | +| 5.14.4 | Used Features..... | 349 | +| 5.14.5 | Error handling..... | 351 | +| 5.14.5.1 | General..... | 351 | +| 5.14.5.2 | Protocol Errors..... | 351 | +| 5.14.5.3 | Application Errors..... | 351 | +| 5.15 | MsisdnLessMoSms API..... | 352 | +| 5.15.1 | Overview..... | 352 | +| 5.15.2 | Data model..... | 352 | +| 5.15.2.1 | Notification data types..... | 352 | +| 5.15.2.1.1 | Introduction..... | 352 | +| 5.15.2.1.2 | Type: MsisdnLessMoSmsNotification..... | 352 | +| 5.15.2.1.3 | Type: MsisdnLessMoSmsNotificationReply..... | 353 | +| 5.15.3 | Resource structure..... | 353 | +| 5.15.3.1 | General..... | 353 | +| 5.15.3.2 | MSISDN-less MO SMS Notification..... | 353 | +| 5.15.3.2.1 | Introduction..... | 353 | +| 5.15.3.2.2 | Resource definition..... | 354 | +| 5.15.3.2.3 | Standard methods..... | 354 | +| 5.15.3.2.3.1 | Notification via POST..... | 354 | +| 5.15.4 | Used Features..... | 355 | +| 5.15.5 | Error handling..... | 355 | +| 5.15.5.1 | General..... | 355 | +| 5.15.5.2 | Protocol Errors..... | 355 | +| 5.15.5.3 | Application Errors..... | 355 | +| 5.16 | RacsParameterProvisioning API..... | 355 | +| 5.16.1 | Overview..... | 355 | +| 5.16.2 | Data model..... | 356 | +| 5.16.2.1 | Resource data types..... | 356 | +| 5.16.2.1.1 | Introduction..... | 356 | +| 5.16.2.1.2 | Type: RacsProvisioningData..... | 356 | +| 5.16.2.1.3 | Type: RacsFailureReport..... | 357 | +| 5.16.2.1.4 | Type: RacsConfiguration..... | 357 | +| 5.16.2.1.5 | Type: RacsProvisioningDataPatch..... | 358 | +| 5.16.2.1.6 | Type: RacsConfigurationRm..... | 358 | +| 5.16.2.2 | Referenced simple data types and enumerations..... | 359 | +| 5.16.2.2.1 | Introduction..... | 359 | +| 5.16.2.2.2 | Simple data types..... | 359 | +| 5.16.2.2.3 | Enumeration: RacsFailureCode..... | 359 | +| 5.16.3 | Resource structure..... | 359 | +| 5.16.3.1 | General..... | 359 | +| 5.16.3.2 | Resource: RACS Parameter Provisionings..... | 360 | +| 5.16.3.2.1 | Introduction..... | 360 | +| 5.16.3.2.2 | Resource definition..... | 360 | +| 5.16.3.2.3 | Resource methods..... | 360 | +| 5.16.3.2.3.1 | GET..... | 360 | +| 5.16.3.2.3.2 | PUT..... | 361 | +| 5.16.3.2.3.3 | PATCH..... | 361 | +| 5.16.3.2.3.4 | POST..... | 361 | +| 5.16.3.2.3.5 | DELETE..... | 362 | +| 5.16.3.3 | Resource: Individual RACS Parameter Provisioning..... | 362 | +| 5.16.3.3.1 | Introduction..... | 362 | +| 5.16.3.3.2 | Resource definition..... | 362 | +| 5.16.3.3.3 | Resource methods..... | 362 | +| 5.16.3.3.3.1 | GET..... | 362 | +| 5.16.3.3.3.2 | PATCH..... | 363 | +| 5.16.3.3.3.3 | PUT..... | 364 | + +| | | | +|------------------------------------------------------------------------------------------------------|--------------------------------------------|------------| +| 5.16.3.3.3.4 | POST..... | 365 | +| 5.16.3.3.3.5 | DELETE..... | 365 | +| 5.16.4 | Used Features..... | 366 | +| 5.16.5 | Error handling..... | 366 | +| 5.16.5.1 | General..... | 366 | +| 5.16.5.2 | Protocol Errors..... | 366 | +| 5.16.5.3 | Application Errors..... | 366 | +| 6 | Security..... | 367 | +| 7 | Using Common API Framework..... | 367 | +| 7.1 | General..... | 367 | +| 7.2 | Security..... | 367 | +| Annex A (normative): OpenAPI representation for the APIs defined in the present document..... | | 369 | +| A.1 | General..... | 369 | +| A.2 | Data Types applicable to several APIs..... | 369 | +| A.3 | MonitoringEvent API..... | 378 | +| A.4 | ResourceManagementOfBdt API..... | 397 | +| A.5 | ChargeableParty API..... | 403 | +| A.6 | NIDD API..... | 408 | +| A.7 | DeviceTriggering API..... | 425 | +| A.8 | GMDViaMBMS APIs..... | 432 | +| A.8.1 | GMDviaMBMSbyMB2 API..... | 432 | +| A.8.2 | GMDviaMBMSbyxMB API..... | 444 | +| A.9 | ReportingNetworkStatus API..... | 454 | +| A.10 | CpProvisioning API..... | 460 | +| A.11 | PfdManagement API..... | 470 | +| A.12 | ECRControl API..... | 481 | +| A.13 | NpConfiguration API..... | 484 | +| A.14 | AsSessionWithQoS API..... | 490 | +| A.15 | MsisdnLessMoSms API..... | 506 | +| A.16 | RacsParameterProvisioning API..... | 507 | +| Annex B (informative): TS Skeleton Template..... | | 514 | +| Annex C (informative): Change history..... | | 515 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification describes the protocol for the T8 reference point between the SCEF and the SCS/AS. The T8 reference point and the related stage 2 functional requirements are defined in 3GPP TS 23.682 [2]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [3] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [4] Void. +- [5] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [6] Hypertext Transfer Protocol (HTTP) Status Code Registry at IANA, . +- [7] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [8] IETF RFC 9457: "Problem Details for HTTP APIs". +- [9] 3GPP TS 29.154: "Service capability exposure functionality over Nt reference point". +- [10] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [11] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [12] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications". +- [13] 3GPP TS 29.201: "Representational State Transfer (REST) reference point between Application Function (AF) and Protocol Converter (PC)". +- [14] 3GPP TS 23.003: "Numbering, addressing and identification". +- [15] IETF RFC 3339: "Date and Time on the Internet: Timestamps". +- [16] IETF RFC 9112: "HTTP/1.1". +- [17] IETF RFC 9110: "HTTP Semantics". +- [18] Void. +- [19] Void. +- [20] IETF RFC 9111: "HTTP Caching". + +- [21] Void. +- [22] IETF RFC 9113: "HTTP/2". +- [23] 3GPP TS 29.155: "Traffic steering control; Representational state transfer (REST) over St reference point". +- [24] 3GPP TS 29.368: "Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS)". +- [25] 3GPP TS 29.337: "Diameter-based T4 interface for communications with packet data networks and applications". +- [26] 3GPP TS 29.250: "Nu reference point between SCEF and PFDF for sponsored data connectivity". +- [27] Open API: "OpenAPI Specification Version 3.0.0", . +- [28] IETF RFC 1166: "Internet Numbers". +- [29] IETF RFC 5952: "A recommendation for Ipv6 address text representation". +- [30] 3GPP TS 29.153: "Service capability exposure functionality over Ns reference point". +- [31] 3GPP TS 24.250: "Protocol for Reliable Data Service; Stage 3". +- [32] IETF RFC 6455: "The Websocket Protocol". +- [33] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [34] 3GPP TS 29.338: "Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs)". +- [35] 3GPP TS 33.187: "Security aspects of Machine-Type Communications (MTC) and other mobile data applications communications enhancements". +- [36] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE);MB2 Reference Point;Stage 3". +- [37] 3GPP TS 29.116: "Presentational state transfer over xMB reference point between Content Provider and BM-SC". +- [38] IETF RFC 5789: "PATCH method for HTTP". +- [39] IETF RFC 7396: "JSON Merge Patch". +- [40] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [41] YAML (10/2009): "YAML Ain't Markup Language (YAML™) Version 1.2", . +- [42] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [43] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [44] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [45] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [46] IETF RFC 6733: "Diameter Base Protocol". +- [47] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [48] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [49] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [50] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". + +- [51] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [52] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [53] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [54] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [55] 3GPP TS 23.468: "Group Communication System Enablers for LTE (GCSE\_LTE); stage 2". +- [56] 3GPP TS 26.348, "Northbound Application Programming Interface (API) for Multimedia Broadcast/Multicast Service (MBMS) at the xMB reference point". +- [57] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [58] 3GPP TR 21.900: "Technical Specification Group working methods". +- [59] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA) Radio Resource Control (RRC); Protocol Specification". +- [60] 3GPP TS 38.331: "NR; Radio Resource Control (RRC) protocol specification". +- [61] 3GPP TS 29.675: "User Equipment (UE) radio capability provisioning service; Stage 3". +- [62] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [63] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [64] 3GPP TS 24.526: "User Equipment (UE) policies for 5G System (5GS); Stage 3". +- [65] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services; Stage 3". +- [66] IETF RFC 5322: "Internet Message Format". +- [67] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [68] 3GPP TS 33.558: "Security aspects of enhancement of support for enabling edge applications; Stage 2". +- [69] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [70] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [71] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------------| +| AF | Application Function | +| AI/ML | Artificial Intelligence/Machine Learning | +| AS | Application Server | + +| | | +|----------|-------------------------------------------------------| +| ASP | Application Service Provider | +| BAT | Burst Arrival Time | +| BDT | Background Data Transfer | +| CAPIF | Common API Framework | +| CP | Communication Pattern | +| DDN | Downlink Data Notification | +| DNN | Data Network Name | +| DL | Downlink | +| eNB | Evolved Node B | +| GMD | Group Message Delivery | +| IMEI-TAC | Type Allocation Code part of an IMEI | +| IWK-SCEF | Interworking SCEF | +| JSON | JavaScript Object Notation | +| LC | Load Control | +| LCI | Load Control Information | +| MIME | Multipurpose Internet Mail Extensions | +| MT | Mobile Terminated | +| MTC | Machine Type Communications | +| MT-LR | Mobile Terminated Location Request | +| NEF | Network Exposure Function | +| NIDD | Non-IP Data Delivery | +| NP | Network Parameter | +| NSAC | Network Slice Admission Control | +| OCI | Overload Control Information | +| OLC | OverLoad Control | +| PCRF | Policy and Charging Rule Function | +| PDN | Packet Data Network | +| PDV | Packet Delay Variation | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| RCAF | RAN Congestion Awareness Function | +| REST | Representational State Transfer | +| SACH | Service Announcement Channel | +| SCEF | Service Capability Exposure Function | +| SCS | Services Capability Server | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| TAI | Tracking Area Identity | +| TLTRI | T8 Long Term Transaction Reference ID | +| TSC | Time Sensitive Communication | +| TSCAI | Time Sensitive Communication Assistance Information | +| WB | Wide Band | +| YAML | YAML Ain't Markup Language | + +--- + +## 4 T8 reference point + +### 4.1 Overview + +The T8 reference point is between the SCS/AS and the SCEF. It specifies APIs that allow the SCS/AS to access the services and capabilities provided by 3GPP network entities and securely exposed by the SCEF. + +This document also specifies the procedures triggered at the SCEF by API requests from the SCS/AS and by event notifications received from 3GPP network entities. + +The stage 2 level requirements and signalling flows for the T8 reference point are defined in 3GPP TS 23.682 [2]. + +The T8 reference point supports the following procedures: + +- Monitoring Procedures +- Procedures for resource management of Background Data Transfer + +- Procedures for changing the chargeable party +- Procedures for Non-IP Data Delivery +- Procedures for Device Triggering +- Procedures for Group Message Delivery +- Procedures for Reporting of Network Status +- Procedures for Communication Pattern Parameters Provisioning +- Procedures for PFD Management +- Procedures for Enhanced Coverage Restriction Control +- Procedures for Network Parameter Configuration +- Procedures for setting up an AS session with required QoS +- Procedures for MSISDN-less Mobile Originated SMS +- Procedures for RACS Parameter Provisioning + +## 4.2 Reference model + +The T8 reference point resides between the SCEF and the SCS/AS as depicted in figure 4.2.1. The overall SCEF architecture is depicted in clause 4.2 of 3GPP TS 23.682 [2]. + +NOTE: The SCS/AS can be provided by a third party. + +![Diagram of the T8 reference model showing the SCS/AS and SCEF connected by the T8 interface.](8d325fc12b494e42c9ea7ed2a7f327a6_img.jpg) + +``` +graph TD; SCS/AS[SCS/AS] --- T8[T8]; T8 --- SCEF[SCEF]; +``` + +The diagram illustrates the T8 reference model. It consists of two rectangular boxes, one above the other, connected by a vertical line. The top box is labeled 'SCS/AS' and the bottom box is labeled 'SCEF'. The vertical line between them is labeled 'T8'. + +Diagram of the T8 reference model showing the SCS/AS and SCEF connected by the T8 interface. + +Figure 4.2.1: T8 reference model + +## 4.3 Functional elements + +### 4.3.1 SCEF + +The SCEF is a functional element which provides means to securely expose the services and capabilities provided by 3GPP network interfaces. The SCEF provides access to network capabilities through homogenous application programming interfaces. + +Individual instances of SCEF may vary depending on what service capabilities are exposed and what API features are supported. + +The SCEF shall protect the other PLMN entities (e.g. HSS, MME) from requests exceeding the permission arranged in the SLA with the third-party service provider. + +When needed, the SCEF supports mapping between information exchanged with SCS/AS (e.g. geographical identifiers) and information exchanged with internal PLMN functions (e.g. cell-Id, eNB-Id, TAI, MBMS SAI, etc.). This mapping is assumed to be provided by the SCEF based on local configuration data. + +## 4.3.2 SCS/AS + +The SCS is the entity which connects MTC application servers to the 3GPP network to enable them to communicate through specific 3GPP defined services with UEs used for MTC and with the SCEF in the HPLMN. The SCS offers capabilities for use by one or multiple MTC application servers. The MTC applications in the external network are hosted on one or more ASs. + +An SCS/AS can get services from multiple SCEFs, and an SCEF can provide services to multiple SCS/ASs. + +The SCS is controlled by the operator of the HPLMN or by a MTC Service Provider. + +The AS can be controlled by a 3rd party. + +## 4.4 Procedures over T8 reference point + +### 4.4.1 Introduction + +All procedures that operate across the T8 reference point, as specified in 3GPP TS 23.682 [2], are specified in the following clauses. + +### 4.4.2 Monitoring Procedures + +#### 4.4.2.1 General + +These procedures are used to perform event monitoring functions via the T8 interface, which include: + +- Monitoring event configuration as specified in clause 4.4.2.2; +- Reporting of monitoring event as specified in clause 4.4.2.3; +- Network initiated notifications of monitoring event cancellation, as specified in clause 4.4.2.4 ; and +- Network initiated notifications of applied parameter configuration, as specified in clause 4.4.2.5. + +#### 4.4.2.2 Monitoring Events Configuration + +##### 4.4.2.2.1 General + +In order to subscribe to a new monitoring event configuration, the SCS/AS shall send an HTTP POST request message to the SCEF targeting the "Monitoring Event Subscriptions" resource. The body of the HTTP POST request message shall include: + +- the SCS/AS Identifier; +- the Monitoring Type; +- the Notification Destination Address; and +- the identifier(s) of the targeted UE(s), i.e. one of External Identifier, MSISDN or External Group Identifier. The External Identifier or the MSISDN identifies the subscription of an individual UE and the External Group Identifier points to a group of UEs. + +and may include: + +- the Maximum Number of Reports; +- the Monitoring Duration indicated by the property "monitorExpireTime"; + +- the Group Reporting Guard Time; and +- additional Monitoring Type(s), if the subscription request targets multiple event(s). + +If the Subscription\_modification feature is supported, the SCS/AS may send an HTTP PUT message in order to update an existing monitoring event subscription. The HTTP PUT request targets the resource "Individual Monitoring Event Subscription" replacing all the properties in the existing configuration. The identifier(s) of the targeted UE(s) (i.e. "msisdn", "externalId" or "externalGroupId" attribute), the identifier of the MTC Provider (i.e. "mtcProviderId" attribute) and the supported features (i.e. "supportedFeatures" attribute) provided during the creation of the monitoring event subscription shall not be updated. Also, both the "requestTestNotification" and "websocketNotifConfig" attributes shall not be updated, if previously provided. + +For one-time monitoring type of requests, the SCS/AS shall include the Maximum Number of Reports with a value set to 1 and not include the Monitoring Duration in the HTTP request message sent to the SCEF. + +If the Subscription\_Patch feature is supported, the SCS/AS may send an HTTP PATCH request to request the modification of an existing "Individual Monitoring Event Subscription" resource, with the request body including the modification instructions which may include any applicable attributes (e.g. "notificationDestination", "monitorExpireTime"), except the provided UE Identifier (e.g. "msisdn", "externalId" or "externalGroupId"), "mtcProviderId" and "supportedFeatures" attributes. Also, both the "requestTestNotification" and "websocketNotifConfig" attributes shall not be modified, if previously provided. + +For a group of UEs, if the Partial\_group\_modification feature is supported, the SCS/AS may send an HTTP PATCH request message in order to cancel or add certain UE(s) within an active group. The HTTP PATCH request targets the resource "Individual Monitoring Event Subscription" updates with the corresponding "excludedExternalIds" and/or "excludedMsisdns" attributes in the existing configuration for partial group cancellation, and/or updates with the corresponding "addedExternalIds" and/or "addedMsisdns" attributes in the existing configuration for partial group addition. + +Upon reception of the HTTP POST, PUT or PATCH request message, if the SCS/AS is authorized to perform such request, the SCEF shall check whether the parameters (e.g. Maximum Number of Reports, Monitoring Duration, Maximum Latency, Maximum Response Time, suggested number of downlink packets in the HTTP POST or PUT request message) in the HTTP request body are within the range defined by operator policies. If one or more of these parameters are not within the range, the SCEF shall either: + +- reject the request message by sending an HTTP response to the SCS/AS with a status code set to "403 Forbidden" and may include in the response body the "PARAMETER\_OUT\_OF\_RANGE" application error within the "cause" attribute of the ProblemDetails data structure and indicate which parameters are out of the range within the "invalidParams" attribute of the "ProblemDetails" data structure; or +- modify the parameters which are not within the range by selecting different values which are within the range. + +For individual UE configuration requests, the SCEF shall also check whether the Idle Status Indication is included for the UE reachability event. If the Idle Status Indication is received in the request but not supported by the network, the SCEF may reject the request message by sending an HTTP response to the SCS/AS with a status code set to "403 Forbidden" and may include in the response body the "IDLE\_STATUS\_UNSUPPORTED" error within the "cause" attribute of the "ProblemDetails" structure. + +If the SCEF receives an HTTP POST request to create a subscription resource for a monitoring event, but without an indication of the support for the feature corresponding to the requested monitoring event, the SCEF shall reject the request by sending an HTTP "400 Bad Request" HTTP error response including the "EVENT\_FEATURE\_MISMATCH" application error within the "cause" attribute of the "ProblemDetails" structure. + +If the SCEF receives an HTTP POST request to create a subscription resource for a monitoring event that it does not support, the SCEF shall reject the request by sending an HTTP "500 Internal Server Error" HTTP error response including the "EVENT\_UNSUPPORTED" application error within the "cause" attribute of the "ProblemDetails" structure. + +If the "enNB" feature is supported: + +- if the SCEF receives an HTTP POST request to create a subscription resource for a monitoring event and determines that no more subscriptions are allowed for this client, the SCEF shall reject the request by sending an HTTP "403 Forbidden" error response including the "RESOURCES\_EXCEEDED" application error within the "cause" attribute of the "ProblemDetails" structure; and + +- if the SCEF receives an HTTP POST request to create a subscription resource for a monitoring event and determines that a duplicate subscription already exists for this client, the SCEF shall reject the request by sending an HTTP "400 Bad Request" error response including the "DUPLICATE\_REQUEST" application error within the "cause" attribute of the "ProblemDetails" structure. + +After validation, the SCEF shall store the parameters and: + +- may assign a SCEF Reference ID related to the created monitoring event subscription resource; and +- based on operator policies, shall: + - map the accuracy into permissible granularity for the location reporting event; and + - map the location area into a list of cells, eNodeB(s) and/or RAI(s)/TAI(s) and derive the corresponding MME(s)/SGSN(s), for number of UEs present in a geographic area event. + +In order to delete a previously active configured monitoring event subscription at the SCEF, the SCS/AS shall send an HTTP DELETE request message to the SCEF targeting the "Individual Monitoring Event Subscription" resource using the corresponding resource URI previously received in the response to the request that has created the monitoring events subscription resource. The SCEF shall then determine the SCEF Reference ID related to the active monitoring subscription resource, and if the SCS/AS is authorized to perform such request, the SCEF shall delete the targeted resource. + +#### 4.4.2.2.2 Monitoring Events Configuration via HSS + +##### 4.4.2.2.2.1 General + +The following monitoring events are applicable for the monitoring event configuration via HSS for an individual UE or a group of UEs: + +- Loss of connectivity; +- UE reachability; +- Location Reporting; +- Change of IMSI-IMEI(SV) Association; +- Roaming Status; +- Communication Failure; +- PDN connectivity status; +- Availability after DDN Failure; and +- API support capability. + +Only one-time reporting is supported if the "reachabilityType" attribute sets to "SMS" for the event "UE reachability" or if the "locationType" attribute sets to "LAST\_KNOWN\_LOCATION" for the event "Location Reporting" in the monitoring event request. + +##### 4.4.2.2.2.2 Configuration Request for an individual UE + +Upon receipt of a configuration request from the SCS/AS for an individual UE, the SCEF shall interact with the HSS via S6t, as specified in 3GPP TS 29.336 [11]. + +Upon receipt of a successful response from the HSS, + +- if it is a one-time monitoring request and the monitoring event report is received, the SCEF shall delete the associated configuration, send an HTTP response message to the SCS/AS with a "200 OK" status code and including the received monitoring event report(s) (more than one report may be provided if the "enNB" is supported). +- otherwise, the SCEF shall, + +- for an HTTP POST request, create a new "Individual Monitoring Event Subscription" resource addressed by the URI that contains the SCS/AS identifier and an SCEF-created subscription identifier, and send an HTTP response to the SCS/AS with a "201 Created" status code, containing the final suggested configuration parameter(s) (if modified), indication(s) of the discarded parameter(s) (if discarded), the monitoring event report(s) (more than one report may be provided if the "enNB" is supported), if received, and a location header field containing the URI of the created resource. +- for an HTTP PUT request, update the active "Individual Monitoring Event Subscription" resource addressed by the request URI and send an HTTP response to the SCS/AS with a "200 OK" status code, containing the final suggested configuration parameter(s) (if modified), indication(s) of the discarded parameter(s) (if discarded) and the monitoring event report(s) (more than one report may be provided if the "enNB" is supported), if received, or a "204 No Content" status code. +- for an HTTP DELETE request, delete the active "Individual Monitoring Event Subscription" resource addressed by the request URI and send an HTTP response to the SCS/AS with a "204 No Content" status code, or a "200 OK" status code and including the monitoring event report(s) (more than one report may be provided if the "enNB" is supported), if received. + +If the SCEF receives a response with an error code from the HSS, the SCEF shall not create, update nor delete the concerned resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +#### 4.4.2.2.2.3 Configuration Request for a group of UEs + +Upon receipt of a request from the SCS/AS including an External Group Identifier, then the monitoring configuration is for a group of UEs. The SCEF shall interact with the HSS via S6t as specified in 3GPP TS 29.336 [11]. + +Upon receipt of a successful response from the HSS indicating that group processing is in progress and before beginning the processing of individual UEs, the SCEF shall, + +- for an HTTP POST request, create a new "Individual Monitoring Event Subscription" resource addressed by a URI that contains the SCS/AS identity and an SCEF-created subscription identifier, store the number of UEs received in the response message from the HSS within the resource and send an HTTP response to the SCS/AS with "201 Created" status code and a location header field containing the URI of the created resource, in order to acknowledge the SCS/AS of the successful group processing request. +- for an HTTP PUT request, update the active "Individual Monitoring Event Subscription" resource addressed by the request URL and send an HTTP response with "200 OK" status code to acknowledge the SCS/AS of the successful group processing request, or a "204 No Content" status code. +- for an HTTP DELETE request, delete the active "Individual Monitoring Event Subscription" resource addressed by the request URI and send an HTTP response to the SCS/AS with "204 No Content" status code. + +If the SCEF receives a response with an error code from the HSS, the SCEF shall not create, update nor delete the concerned resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +Upon receipt of the processing result of the individual UEs from the HSS, the SCEF shall behave as follows: + +- if no Group Reporting Guard Time is received, the SCEF shall send an HTTP POST request message to the SCS/AS including a reference to the related monitoring subscription, a list of configuration failure result if received for the group members, and the "monitoringEventReports" attribute including a list of monitoring event reports if received for the group members; +- otherwise, the SCEF shall accumulate all of the configuration results and/or monitoring event reports received from the HSS for the group members until the Group Reporting Guard Time expires. Then the SCEF shall send an HTTP POST request message to the SCS/AS including a reference to the related monitoring subscription, and a list of configuration failure result if received for the group members, and the "monitoringEventReports" attribute including a list of monitoring event reports received before the Group Reporting Guard Time. +- If the Partial\_group\_modification feature is supported, + - upon the cancellation of UE(s) within the active group identified by the "excludedExternalIds" and/or "excludedMsisdns" attributes is successful, the SCEF shall, + +- if the maximum number of reports applies to the monitoring event configuration of the cancelled UE(s), set the stored number of reports of the indicated UE(s) to the maximum number of reports; +- still consider the rest of UE(s) as applicable within the active group based monitoring subscription to the group based Monitoring Event Report identified by the External Group Identifier; +- determine whether the reporting for the group based event subscription is completed or not. If completed, the SCEF shall delete the corresponding "Individual Monitoring Event Subscription" resource with procedures as described in clause 4.4.2.3. +- If the cancellation of UE(s) within the active group is unsuccessful, the SCEF shall respond with proper error code indicating the error and should return the appropriate additional error information in the POST response body. +- upon the addition of UE(s) within the active group identified by the "addedExternalIds" and/or "addedMsisdns" attributes is successful, the SCEF shall, + - still consider the existing of UE(s) as applicable within the active group based monitoring subscription to the group based Monitoring Event Report identified by the External Group Identifier; + - subsequently apply monitoring event subscription to the new group member UEs. +- If the addition of UE(s) within the active group is unsuccessful, the SCEF shall respond with proper error code indicating the error and should return the appropriate additional error information in the POST response body. + +The SCS/AS shall send an HTTP response to acknowledge the SCEF about the handling result of the received HTTP POST request. + +#### 4.4.2.2.3 Monitoring Events Configuration directly via MME/SGSN + +The monitoring event "Number of UEs in a geographic area" is applicable for the monitoring event configuration via MME/SGSN. Only one-time reporting is supported for this event with the value of Maximum Number of Reports indicated by "maximumNumberOfReports" set to 1. + +Upon receipt of an HTTP POST request from the SCS/AS, the SCEF shall + +- resolve the location area to the involved SGSN(s)/MME(s) by local configuration; +- interact with the HSS via the S6t interface as specified in 3GPP TS 29.336 [11] if the External Group ID(s) is included; and +- interact with the SGSN(s)/MME(s) via the T6a/b interface as specified in 3GPP TS 29.128 [12]. + +NOTE: The SCEF uses local configuration to resolve the involved SGSN(s)/MME(s) if the location area is not received. + +After collecting responses from the SGSN(s)/MME(s), if the SCEF does not receive any successful response from the involved SGSN(s)/MME(s), the SCEF shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6; otherwise the SCEF should send a response with 200 OK status code to acknowledge the SCS/AS with one aggregated report in the requested area by including the total count of the number of UEs in the "ueCount" attribute and the External Identifier(s) (if available) or the MSISDN(s) (if available) associated with the External Group ID. + +NOTE: It is possible that the number of UEs does not reflect the actual number of UEs in the designated area (e.g. some SGSN(s)/MME(s) do not respond successfully). The SCEF still provides the result to the SCS/AS if at least one SGSN/MME returns a successful response. + +#### 4.4.2.2.4 Monitoring Events Configuration via PCRF + +##### 4.4.2.2.4.1 General + +The following monitoring events: the location reporting event and communication failure event are applicable for the monitoring event configuration via PCRF for an individual UE. + +NOTE: If monitoring event configuration via PCRF is used for a subscription resource, the Subscription\_modification feature cannot be supported. + +Only the location reporting event is applicable for the monitoring event configuration via PCRF for a group of UEs. + +Only one-time reporting is supported for the monitoring event configuration via PCRF. + +HTTP PUT is not supported for the monitoring event configuration via PCRF. If it is received, the SCEF shall reject the HTTP PUT message with 403 Forbidden during monitoring and may indicate the "OPERATION\_PROHIBITED" error in the "cause" attribute of the "ProblemDetails" structure. + +#### 4.4.2.2.4.2 Configuration Request for an individual UE + +Upon receipt of an HTTP POST request from the SCS/AS for an individual UE, the SCEF shall: + +- interact with the PCRF via the Rx interface by using an existing AF session or establishing a new AF session as specified in 3GPP TS 29.214 [10]; + +NOTE 1: The SCEF can derive the service information over the Rx interface based on SCS/AS ID for communication failure event. + +- after receiving the AAA message from the PCRF, create a resource which represents the monitoring event configuration addressed by a URI that contains the SCS/AS identifier and an SCEF-created subscription identifier; and +- send a corresponding status code to acknowledge the SCS/AS of the successful processing of the request in the HTTP response message. + +Then the SCEF shall wait for the reporting from the PCRF as specified in 3GPP TS 29.214 [10]. + +NOTE 2: Different events can be reported in different messages according to 3GPP TS 29.214 [10], e.g. STR/RAR for communication failure. + +During configuration resource deletion, the SCEF shall also terminate the AF session if it was established and used only for event monitoring. + +#### 4.4.2.2.4.3 Configuration Request for a group of UEs + +Upon receipt of an HTTP POST request from the SCS/AS for a group of UEs, the SCEF shall: + +- interact with all PCRFs in the same PLMN via Nta application of Nt interface as specified in 3GPP TS 29.154 [9]; +- after collecting ECA message from all PCRFs, create a resource which represents the monitoring event configuration addressed by a URI that contains the SCS/AS identifier and an SCEF-created subscription identifier; and +- send a corresponding status code to acknowledge the SCS/AS of the successful processing of the request in the HTTP response message. + +Then the SCEF shall wait for the reporting from the PCRF(s) as specified in 3GPP TS 29.154 [9]. + +#### 4.4.2.3 Reporting of Monitoring Event Procedure + +Upon receipt of a Monitoring Event Report from the HSS or the MME/SGSN as defined in clause 5.6.3 or clause 5.6.8 of 3GPP TS 23.682 [2], from the PCRF as defined in clause 5.6.5 or from the IWK-SCEF as defined in clause 5.6.8 of 3GPP TS 23.682 [2], the SCEF shall determine the monitoring event subscription associated with the corresponding Monitoring Event Report. + +If the monitoring event subscription refers to a Monitoring Event Configuration for a single UE or to a group-based Monitoring Event configuration, and no Group Reporting Guard Time was set, then the SCEF shall send an HTTP POST message including a link to the SCEF-created subscription resource and the received Monitoring Event Report to the identified destination. If the monitoring event subscription refers to a group-based Monitoring Event Configuration and Group Reporting Guard Time was provided during the Monitoring Event configuration procedure, then the SCEF + +shall accumulate all of the received Monitoring Event reports for the group of UEs until the Group Reporting Guard Time expires or the monitoring duration indicated by the property "monitorExpireTime" is reached. + +Upon expiration of Group Reporting Guard Time or expiration of the monitoring duration, the SCEF shall send an HTTP POST message to the identified destination including a link to the SCEF-created subscription resource and the list of accumulated Monitoring Event Reports for each UE identified by either its External Identifier or MSISDN. The destination URL of the HTTP POST message is provided by the SCS/AS during the Monitoring Event Configuration procedure. + +If the monitoring event subscription refers to a one-time monitoring request or a continuous monitoring request, but the maximum number of reports is reached, the SCEF shall consider the reporting as completed, delete the corresponding "Individual Monitoring Event Subscription" resource and send an HTTP POST message including the subscription identifier and a cancellation indication to the identified destination. The cancellation indication shall set to "true" indicating to cancel the configured monitoring subscription. The destination URL of the HTTP POST is provided by the SCS/AS during the Monitoring Event Configuration procedure. In addition, the SCEF shall interact with the HSS to delete the event configuration if the latter was performed via the HSS whereas event reports were performed via the SGSN/MME. The SCEF determines that the reporting for a group is completed by comparing the total number of received reports with the number of UEs of the group (received from the HSS during event configuration for a group of UEs) multiplied by the maximum number of reports. + +If the Partial\_group\_modification feature is supported and one or more MSISDN(s) or External Identifier(s) within the active group based monitor subscription have been cancelled or added, the existing UE(s) within the active group based monitoring subscription are still applicable to the group based Monitoring Event Report identified by the External Group Identifier, the added group member(s) shall be subsequently applied with the monitoring event subscription. + +When the monitoring duration indicated by the property "monitorExpireTime" is reached, the SCEF shall delete the related event subscription and event configuration locally. The SCS/AS shall no longer address the corresponding "Individual Monitoring Event Subscription" resource. + +#### 4.4.2.4 Network-initiated Explicit Monitoring Event Deletion Procedure + +Upon receipt of an SCEF Reference ID for the event to be deleted from the HSS as defined in 3GPP TS 29.336 [11], the SCEF shall determine the subscription identifier associated with the indicated active monitoring subscription. Then the SCEF shall delete the related resource "Individual Monitoring Event Subscription", send an HTTP POST message including the subscription identifier and a cancellation indication to the identified destination. The cancellation indication shall set to "true" indicating to cancel the configured monitoring subscription. The destination URL of the HTTP POST is provided by the SCS/AS during the Monitoring Event Configuration procedure. + +If the Partial\_group\_cancellation feature is supported, upon receipt of one or more MSISDN(s) or External Identifier(s) for the group member(s) to be cancelled within the active group based event subscription from the HSS as defined in 3GPP TS 29.336 [11], the SCEF shall, + +- if the maximum number of reports applies to the monitoring event configuration, set the stored number of reports of the indicated UE(s) to the maximum number of reports; +- include the MSISDN(s) or External Identifier(s) to be cancelled in the MonitoringNotification Request to the destination URL provided by the SCS/AS during the Monitoring Event Configuration procedure; and +- determine whether the reporting for the group based event subscription is completed or not. If completed, the SCEF shall delete the corresponding "Individual Monitoring Event Subscription" resource with procedures as described in clause 4.4.2.3. + +NOTE: The above procedure can be triggered from the HSS due to parameter overwritten by Network Parameter Configuration. + +#### 4.4.2.5 Network initiated notification of applied parameter configuration + +For "LOSS\_OF\_CONNECTIVITY" and "UE\_REACHABILITY" events, if the "Enhanced\_param\_config" feature is supported and the SCEF receives the currently applied parameter configuration from the HSS, the SCEF shall notify the SCS/AS via an HTTP POST message including the parameter changes in the "appliedParam" attribute. + +#### 4.4.3 Procedures for resource management of Background Data Transfer + +These procedures are used by an SCS/AS to perform the resource management of background data transfer (BDT) to a set of UEs, i.e. the SCS/AS requests a time window and related conditions from the SCEF via the T8 interface. + +In order to create a resource for the background data transfer policy, the SCS/AS shall send an HTTP POST message to the SCEF for the "BDT Subscriptions" resource to negotiate the transfer policy. The body of the HTTP POST message shall include SCS/AS Identifier, Volume per UE (total volume for both DL and UL or separate volume for DL and/or UL), Number of UEs, Desired Time Window and optionally a location area information. + +After receiving the HTTP POST message, if the SCS/AS is authorized, the SCEF shall map the SCS/AS Identifier to ASP Identifier and negotiate the transfer policy with the PCRF as defined in 3GPP TS 29.154 [9]. After receiving the response including the determined transfer policies from the PCRF, the SCEF shall create a resource "Individual BDT Subscription" which represents the BDT subscription, addressed by a URI that contains the SCS/AS identifier and an SCEF-created subscription identifier, and shall respond to the SCS/AS with a 201 Created message, including a Location header field containing the URI for the created resource and a message body, which may also include Reference ID and a set of transfer policies. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this background data transfer subscription. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not create the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +The SCS/AS may also send an HTTP PUT message to the SCEF for the "Individual BDT Subscription" resource to request starting an update for negotiation of background data transfer policy. The body of the HTTP PUT message shall include data as described in the POST message. The external group identifier shall remain unchanged from previously provided value. After receiving such request, if the SCS/AS is authorized, the SCEF shall negotiate the transfer policy with the PCRF as defined in 3GPP TS 29.154 [9]. After receiving the response including the determined transfer policies from the PCRF, the SCEF shall send an HTTP response to the SCS/AS with a "200 OK" status code and shall include the Bdt data type in the response body, or with a "204 No Content" status code. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +NOTE 1: The SCEF starts a new BDT policy negotiation in the Nt interface by sending the request to the PCRF without the previously associated BDT Reference ID. + +If more than one policy is included in the HTTP response, the SCS/AS shall send an HTTP PATCH message to inform the SCEF for the "Individual BDT Subscription" resource of the transfer policy selected by the SCS/AS. After receiving the HTTP PATCH message, the SCEF shall send an HTTP response to the SCS/AS with a "200 OK" status code and shall include the Bdt data type in the response body, or with a "204 No Content" status code, then the SCEF shall interact with the PCRF as defined in 3GPP TS 29.154 [9]. If the SCEF identifies any error (e.g. selected policy is not within the set of transfer policies), the SCEF shall not update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +The SCS/AS may also send an HTTP DELETE message to the SCEF for the "Individual BDT Subscription" resource requesting to remove an individual resource identified by the URI received in the response to the request that has created resource a URI. After receiving such request, the SCEF shall delete the resource and send an HTTP response to the SCS/AS with a corresponding status code. + +NOTE 2: The SCEF can also remove the resource when the last window end time in transfer policies expires. + +#### 4.4.4 Procedures for changing the chargeable party at session set up or during the session + +This procedure is used by an SCS/AS to either request to sponsor the traffic from the beginning or to request becoming the chargeable party at a later point in time via the T8 interface. + +When setting up the connection between the AS and the UE via the SCEF, the SCS/AS shall send an HTTP POST request to the SCEF, targeting the "Chargeable Party Transactions" resource, to become the chargeable party for the session to be set up. The body of the HTTP POST message shall include the SCS/AS Identifier, UE IP address, IP Flow description, Sponsor ID, ASP ID, Sponsoring Status, notification destination URI identifying the recipient of notifications within the "notificationDestination" attribute and may include the time period and/or traffic volume used for sponsoring. The SCS/AS may also request to activate a previously selected policy of background data transfer by + +including the associated Reference ID in the body of the HTTP POST message. If the feature AppId is supported, either the Flow description or an external Application Identifier shall be included. + +After receiving the HTTP POST request, if the authorization performed by the SCEF is successful, the SCEF shall act as an AF and interact with the PCRF via the Rx interface, as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13], to trigger a PCRF initiated IP-CAN Session Modification. The SCEF may map the SCS/AS Identifier to AF Application Identifier if the external Application Identifier is not provided and only one AF Application Identifier is mapped and may request to be notified about the traffic plane status based on local configuration. If the time period and/or traffic volume are received from the SCS/AS, the SCEF should subscribe with the PCRF to the USAGE\_REPORT event. + +If the "enNB" feature is supported, the SCEF may explicitly receive a list of event(s) that the SCS/AS requests to subscribe to. The SCEF shall subscribe to the corresponding PCRF event(s) (e.g. INDICATION\_OF\_SUCCESSFUL\_RESOURCE\_ALLOCATION) for the received event(s) (e.g. SUCCESSFUL\_RESOURCES\_ALLOCATION) except for SESSION\_TERMINATION. + +NOTE 1: PCRF does not need explicit subscription in order to notify Rx session termination. + +After receiving a successful response from the PCRF, the SCEF shall create a new "Individual Chargeable Party Transaction" resource, which represents the chargeable party transaction, addressed by a URI that contains the SCS/AS identity and an SCEF-created transaction identifier, and shall respond to the SCS/AS with a 201 Created status code, including a Location header field containing the URI of the created resource. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this chargeable party transaction. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not create a resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +In order to update the sponsoring status of an established AS session, the SCS/AS shall send an HTTP PATCH message to the SCEF targeting the associated "Individual Chargeable Party Transaction" resource requesting to partial update a chargeable party transaction resource (e.g. change the Sponsoring Status, update the list of event(s) if the "enNB" feature is supported). When receiving the HTTP PATCH message, the SCEF shall make the change and interact with the PCRF to modify the Rx session as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13]. After receiving a response with successful result code from the PCRF, the SCEF shall send an HTTP response to the SCS/AS with a "200 OK" status code and the result if any in the body of the HTTP response or a "204 No Content" status code. The accumulated usage received from the PCRF shall be included in the HTTP response with the "200 OK" status code if the SCS/AS requested to disable the sponsoring. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not update the resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +NOTE 2: The SCS/AS can assume a successful resource allocation upon receipt of the POST/PATCH response until the FAILED\_RESOURCES\_ALLOCATION event is received. + +NOTE 3: The SCS/AS can update the list of user plane event(s) only for one time specific events, i.e. INDICATION\_OF\_SUCCESSFUL\_RESOURCES\_ALLOCATION, INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION and USAGE\_REPORT events, as specified in clause 5.3.13 of 3GPP TS 29.214 [10]. + +If the SCEF receives a traffic plane notification (e.g. the usage threshold is reached or transmission resource lost) or gets informed that the Rx session is terminated (e.g. due to the release of PDN connection), the SCEF shall send an HTTP POST message including the notified event (e.g. session terminated) and the accumulated usage to the SCS/AS identified by the notification destination URI received during session set up. The SCS/AS shall respond with an HTTP response to confirm the received notification. + +In order to remove an established AS session, the SCS/AS shall send an HTTP DELETE message to the SCEF targeting the associated "Individual Chargeable Party Transaction" resource. After receiving the HTTP DELETE message, the SCEF shall remove all properties of the resource and interact with the PCRF to terminate the Rx session (as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13]). After receiving the response from the PCRF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code and the accumulated usage (if received from the PCRF). + +## 4.4.5 Procedures for Non-IP Data Delivery + +### 4.4.5.1 General + +This procedure is used by an SCS/AS to support the Non-IP Data Delivery (NIDD) via SCEF. It performs the NIDD configuration via the T8 interface. It also includes the mobile terminated (MT) and mobile originated (MO) communication with UEs via the T8 interface. It also includes the group message delivery via MT NIDD via the T8 interface and management of port numbers on UE and SCEF and their dynamic association with different applications. + +Error handling for the procedures in this clause shall be handled based on clause 5.2.6. + +### 4.4.5.2 NIDD Configuration + +#### 4.4.5.2.1 NIDD Configuration for a single UE + +For a NIDD configuration creation, the SCS/AS shall send an HTTP POST message to the SCEF for the "NIDD configurations" resource. The body of the HTTP POST message shall include External Identifier or MSISDN, SCS/AS Identifier, notification destination URI identifying the recipient of notification within the "notificationDestination" attribute and may include NIDD Duration, PDN Connection Establishment Option and Reliable Data Service Configuration. In addition, the SCS/AS may send non-IP data and its associated parameters (e.g. Priority) as described in clause 4.4.5.3.1 in the NIDD configuration creation request. The Reliable Data Service Configuration includes port numbers on UE and SCEF that are used to identify specific applications for data transfer between UE and SCS/AS and an indication if reliable data service acknowledgement is enabled or not. + +Upon receipt of the HTTP POST request from the SCS/AS to create a NIDD configuration, the SCEF shall check whether the SCS/AS is authenticated and authorized to create NIDD configuration, and also authorize the NIDD configuration. If authorization is successful, the SCEF shall interact with the HSS via S6t as specified in 3GPP TS 29.336 [11]. Upon receipt of the successful response from the HSS, the SCEF shall store the UE identity (IMSI and External Identifier or MSISDN) which is associated with the External Identifier or MSISDN and create a resource "Individual NIDD configuration", which represents the NIDD configuration, addressed by a URI that contains the SCS/AS identity and an SCEF-created NIDD configuration identifier, and shall respond to the SCS/AS with a 201 Created message, including a Location header field containing the URI for the created resource. The body of the response message shall include Maximum Packet Size and may include Reliable Data Service Indication. When the SCS/AS receives the URI in the Location header, it shall use this URI in subsequent requests to the SCEF to refer to this NIDD configuration. + +If the SCS/AS includes a downlink non-IP data together with the NIDD configuration creation, the SCEF shall also create the corresponding "Individual NIDD downlink data delivery" sub-resource(s) and send each of the sub-resource(s) within the "self" attribute in the "niddDownlinkDataTransfers" attribute together with the created resource "Individual NIDD configuration" which included in the Location header field in the HTTP POST response. When the SCS/AS receives the URI the "self" attribute in the "niddDownlinkDataTransfers" attribute, it shall use this URI in subsequent requests to the SCEF to refer to this downlink data delivery transfer. + +After sending the HTTP response to NIDD configuration request, the SCEF shall perform the procedure for individual MT NIDD as described in clause 4.4.5.3.1. + +NOTE: Any further interaction with the SCS/AS for the piggybacked individual MT NIDD is performed by the notification of NIDD downlink data delivery status. + +For a NIDD configuration modification, the SCS/AS shall send an HTTP PATCH message to the SCEF for the "Individual NIDD configuration" resource, using the URI received in the response to the request that has created the NIDD configuration resource. Upon receipt of the HTTP PATCH request from the SCS/AS to update the parameters of the NIDD configuration, the SCEF shall check whether the SCS/AS is authenticated and authorized to update NIDD configuration. If the authorization is successful, the SCEF shall verify that the resource to be modified already exists as identified by the URI. If the NIDD configuration resource is found, the SCEF shall update the NIDD configuration as requested. Upon successful update of the requested NIDD configuration including the interaction with the HSS via S6t as specified in 3GPP TS 29.336 [11], the SCEF shall respond to the SCS/AS with a 200 OK success message indicating that the NIDD configuration resource was successfully updated, or with a 204 No Content success message if the NIDD configuration modification is successful updated with no content in the PATCH response message body. + +For a NIDD configuration cancellation, the SCS/AS shall send an HTTP DELETE message to the SCEF for the "Individual NIDD configuration" resource, using the URI received in the response to the request that has created the + +NIDD configuration resource. Upon receipt of the HTTP DELETE message from the SCS/AS, the SCEF shall check whether the SCS/AS is authenticated and authorized to delete NIDD configuration. If the authorization is successful, the SCEF shall verify that the NIDD configuration resource identified by the URI already exists. If the configuration resource exists, the SCEF shall delete the requested configuration, and perform related NIDD procedure to EPC network elements if applicable. Upon successful deletion of requested NIDD configuration, the SCEF shall respond to the SCS/AS with a 200 OK success message indicating that the NIDD configuration was successfully cancelled. As an alternative to the 200 OK success message, the SCEF may send a 204 No Content success message without any message content to the SCS/AS. + +When the NIDD Duration expires, the SCEF may remove the associated NIDD configuration resource and all individual downlink data delivery resources under such NIDD configuration. + +#### 4.4.5.2.2 NIDD Configuration for a group of UEs + +The NIDD configuration procedure for a single UE as described in clause 4.4.5.2.1 shall be applicable for a group of UEs with the following differences: + +- The External Group Identifier shall be included in the POST request instead of MSISDN or External Identifier. +- After receiving the response message from the HSS, the SCEF shall store the list of UE identifiers (IMSI and External Identifier or MSISDN) which are associated with the External Group Identifier. +- The downlink non-IP data is not supported to be handled together with the NIDD configuration. + +#### 4.4.5.3 Mobile Terminated NIDD procedure + +##### 4.4.5.3.1 Mobile Terminated NIDD for a single UE + +If the SCS/AS needs to perform a downlink non-IP data delivery for a single UE, the SCS/AS shall send an HTTP POST message to the SCEF for the "NIDD downlink data deliveries" resource, identifying an existing NIDD configuration resource as parent resource. The body of the HTTP POST message shall include External Identifier or MSISDN and non-IP data and may include PDN Connection Establishment Option, Reliable Data Service Configuration, Maximum Latency and Priority. The Reliable Data Service Configuration includes port numbers on UE and SCEF that are used to identify a specific application for data transfer between UE and SCS/AS and an indication if reliable data service acknowledgement is enabled or not. + +Upon receipt of a HTTP POST request from the SCS/AS for a downlink data delivery for a single UE, the SCEF shall: + +- verify the NIDD configuration resource already exists based on the URI passed, if the configuration resource does not exist, the SCEF shall respond with a 404 Not Found response to reject the downlink data delivery, and +- check whether the SCS/AS is authorised to send NIDD requests, if not authorized, the SCEF shall respond with a 401 Unauthorized response to reject the downlink data delivery, and +- check whether the non-IP packet size is larger than the Maximum Packet Size that was provided to the SCS/AS during NIDD Configuration. If the packet is oversized, the SCEF shall respond with a 403 Forbidden response with a cause value "DATA\_TOO\_LARGE" in the "cause" attribute of the "ProblemDetails" data structure indicating received non-IP packet size is larger than "maximumPacketSize" of the NIDD configuration. +- if the Rds\_port\_verification feature is supported, check whether the RDS port numbers are within the configured RDS port list. If the RDS port numbers are unknown in the SCEF, the SCEF shall respond with a 403 Forbidden response with a cause value "RDS\_PORT\_UNKNOWN" in the "cause" attribute of the "ProblemDetails" data structure. + +If all above checks are successful, the SCEF shall determine the EPS Bearer Context based on the APN associated with the NIDD configuration and the User Identity. If the SCEF EPS bearer context is not found in the SCEF, depending on PDN Connection Establishment Option received in the POST request or from NIDD configuration, the SCEF may: + +- reject the request with an error message to the SCS/AS; +- send a Device Trigger to the UE as described in clause 4.4.6 without buffering the non-IP data and respond the SCS/AS with a 500 Internal Server Error response and a cause value "TRIGGERED" in the "cause" attribute of the "ProblemDetails" data structure; or + +- buffer the non-IP data and create the "Individual NIDD downlink data delivery" sub-resource, then send a 201 Created response to the SCS/AS. The response message also includes an indication of whether the Device Trigger procedure (as described in clause 4.4.6) was performed by the SCEF. A Location header shall be included in the response message that provides the URI of the resource identifying this individual downlink data delivery. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this individual downlink data delivery for possible replacement or cancellation. The non-IP data shall be delivered when the non-IP PDN connection is established. + +If the SCEF EPS bearer context is found in the SCEF, the SCEF shall check if the SCS/AS has exceeded the quota or rate of data submission considering the number of existing buffered non-IP data and restriction in APN and serving PLMN rate control. If quota is reached, the SCEF shall respond the SCS/AS with a 403 Forbidden response and a cause value "QUOTA\_EXCEEDED" in the "cause" attribute of the "ProblemDetails" data structure indicating the reason for the failure condition. If rate limit is reached, the SCEF shall respond the SCS/AS with a 429 Too Many Requests response. + +If the check is passed, the SCEF shall continue the downlink non-IP data delivery procedure as the defined 3GPP TS 29.128 [12]. + +If the non-IP data delivery was successful, the SCEF shall send a 200 OK response to the HTTP POST request indicating the downlink non-IP data delivery is successful along with the acknowledge information; otherwise the SCEF may: + +- send a 500 Internal Server Error response and a cause value indicating the reason for the delivery failure within the "cause" attribute of the "ProblemDetails" data structure, i.e.: + 1. if delivery was unsuccessful due to timeout, the cause value "TIMEOUT"; or + 2. if delivery to the next hop was unsuccessful with the cause value "NEXT\_HOP"; or +- if the MME/SGSN indicates UE is temporary not reachable, either: + 1. buffer the non-IP data and create the "Individual NIDD downlink data delivery" sub-resource, then send a 201 Created response to the SCS/AS. The response may include a Requested Re-Transmission time to indicate the SCS/AS when the UE is expected to be reachable so that the SCEF re-transmits the buffered non-IP data; or + 2. send a 500 Internal Server Error response without buffering the non-IP data, and include a cause value "TEMPORARILY\_NOT\_REACHABLE" in the "cause" attribute of the "ProblemDetails" data structure indicating the downlink non-IP data delivery is performed but stopped since UE is temporarily unreachable. The response may include a Requested Re-Transmission time to indicate the SCS/AS when the UE is expected to be reachable so that the SCS/AS may prepare any re-transmission. + +If the MT\_NIDD\_modification\_cancellation feature is supported and the SCS/AS decides to replace the pending downlink data delivery in the SCEF, the SCS/AS shall send an HTTP PUT message to the SCEF, using the URI received in the response to the request that has created the individual downlink data delivery resource. The External Identifier or MSISDN shall remain unchanged from previous values. Upon receipt of the HTTP PUT request from the SCS/AS, the SCEF shall check whether a pending non-IP data exists with the same URI (i.e. resource exists). If it is found, the SCEF shall replace it with the new non-IP data and continue waiting for any message from the MME/SGSN for the UE indicating either the non-IP PDN connection is being established or the UE is reachable (such message may be an MO NIDD); otherwise the SCEF shall respond with a 409 Conflict response with a cause value "SENDING" in the "cause" attribute of the "ProblemDetails" data structure indicating replacement failure. If the buffered data is already delivered, the SCEF shall respond with a 404 Not Found response and include a cause value "ALREADY\_DELIVERED" in the "cause" attribute of the "ProblemDetails" data structure indicating replacement failure. If delivery was unsuccessful due to timeout, the SCEF shall respond with a 500 Internal Server Error response with a cause value "TIMEOUT" in the "cause" attribute of the "ProblemDetails" data structure. If delivery to the next hop was unsuccessful, the SCEF shall respond with a 500 Internal Server Error response with a cause value "NEXT\_HOP" in the "cause" attribute of the "ProblemDetails" data structure. + +If the "PatchUpdate" feature defined in clause 5.6.4 is supported and the SCS/AS decides to partially modify the pending downlink data delivery in the SCEF, the SCS/AS shall send an HTTP PATCH message to the SCEF to the URI received in the response to the request that has created the concerned individual downlink data delivery resource. The request body shall contain the NiddDownlinkDataTransferPatch data structure including only the attributes that shall be updated. Upon reception of this HTTP PATCH request from the SCS/AS, the SCEF shall check whether a pending non-IP data with the received URI exists (i.e. the resource exists). If it is found, the SCEF shall apply the requested + +modifications and continue waiting for any message from the MME/SGSN for the UE indicating either the non-IP PDN connection is being established or the UE is reachable (such message may be an MO NIDD); otherwise the SCEF shall respond with a "409 Conflict" status code including a cause value "SENDING" within the "cause" attribute of the "ProblemDetails" data structure to indicate modification failure. If the buffered data is already delivered, the SCEF shall respond with a "404 Not Found" status code including a cause value "ALREADY\_DELIVERED" within the "cause" attribute of the "ProblemDetails" data structure to indicate modification failure. If delivery was unsuccessful due to timeout, the SCEF shall respond with a 500 Internal Server Error status code with a cause value "TIMEOUT" in the "cause" attribute of the "ProblemDetails" data structure. If delivery to the next hop was unsuccessful, the SCEF shall respond with a 500 Internal Server Error status code with a cause value "NEXT\_HOP" in the "cause" attribute of the "ProblemDetails" data structure. + +If the MT\_NIDD\_modification\_cancellation feature is supported and the SCS/AS decides to cancel the pending downlink data delivery in the SCEF, the SCS/AS shall send an HTTP DELETE message to the SCEF, using the URI received in the response to the request that has created the individual downlink data delivery resource. Upon receipt of the HTTP DELETE request from the SCS/AS, the SCEF shall check whether a pending request exists with the same URI. If such non-IP data has not been delivered, the SCEF shall remove the individual downlink data delivery resource and respond with an HTTP 204 No Content response; otherwise the SCEF shall respond with a 404 Not Found response (i.e. data already delivered) with a cause value "ALREADY\_DELIVERED" in the "cause" attribute of the "ProblemDetails" data structure or 409 Conflict (i.e. data delivery ongoing) response with a cause value "SENDING" in the "cause" attribute of the "ProblemDetails" data structure, and include a cause value indicating cancellation failure. + +If a pending non-IP data is delivered by the SCEF (e.g. due to non-IP PDN connection establishment), and the SCEF gets the delivery result from the MME/SGSN, the SCEF shall remove the "Individual NIDD downlink data delivery" sub-resource and send an HTTP POST message to the SCS/AS, identified by the notification destination URI received during the NIDD configuration, to notify the delivery result for the pending non-IP data. Upon receipt of the request, the SCS/AS shall acknowledge the notification with an HTTP 200 OK or 204 No Content response. + +During MT NIDD delivery, if the UE indicates no support for RDS and the SCEF previously indicated RDS is enabled to the SCS/AS, the SCEF shall stop sending the non-IP data and send MT NIDD delivery notification with "FAILURE\_RDS\_DISABLED" delivery status. + +#### 4.4.5.3.2 Mobile Terminated NIDD for a group of UEs + +If the SCS/AS needs to perform a downlink non-IP data delivery to a group of UEs and if both the SCS/AS and the SCEF support GroupMessageDelivery feature as defined in clause 5.6.4, the SCS/AS shall send an HTTP POST request message to the SCEF for the "NIDD downlink data deliveries" resource, identifying an existing NIDD configuration resource as parent resource. The body of the HTTP POST request message shall include the External Group Identifier and the non-IP data, and may include Reliable Data Service Configuration, PDN Connection Establishment Option and Maximum Latency. + +Upon receipt of such an HTTP POST request from the SCS/AS requesting the group message delivery, the SCEF checks whether the SCS/AS is authorised to send NIDD requests, whether the non-IP packet size is larger than the Maximum Packet Size that was provided to the SCS/AS during NIDD Configuration and if the Rds\_port\_verification feature is supported whether the RDS port numbers are recognized. If any of those checks fails, the SCEF shall respond with a HTTP response with a cause value indicating the reason for the failure condition. If all checks are successful, the SCEF shall create an "Individual NIDD downlink data delivery" resource and sends a 201 Created response to the SCS/AS to acknowledge acceptance of the HTTP POST request. + +Then for each authorized External Identifier associated to the External Group Identifier which is retrieved from the HSS during preceding NIDD configuration procedure (as specified in clause 4.4.5.2.2), the SCEF shall determine the EPS Bearer Context based on the APN associated with the NIDD configuration and the User Identity and continue the procedure as described for MT NIDD for a single UE in clause 4.4.5.3.1 without sending downlink data delivery status notification for any individual UE to the SCS/AS. + +At the end of buffering (duration determined by the Maximum Latency or local policy) or after processing data delivery for all UEs in the group, the SCEF shall send an HTTP POST message to SCS/AS to indicate the aggregated result of data delivery of each UE. The body of the HTTP POST request message shall include MSISDN or External Identifier, Retransmission Time (optional) and delivery result for each UE. Upon receipt of the request, the SCS/AS shall acknowledge the request with an HTTP 200 OK or 204 No Content response. + +The MT\_NIDD\_modification\_cancellation feature is not supported for the group message delivery via NIDD. If a PUT or DELETE request is received for the "Individual NIDD downlink data delivery" resource which was created for a + +group of UEs, the SCEF shall reject the message with a 403 Forbidden response with a cause value "OPERATION\_PROHIBITED" in the "cause" attribute of the "ProblemDetails" data structure. + +During MT NIDD delivery, if the UE indicates no support for RDS and the SCEF previously indicated RDS is enabled to the SCS/AS, the SCEF shall stop sending the non-IP data for the indicated UE. In the aggregated MT NIDD delivery notification, the SCEF shall send "FAILURE\_RDS\_DISABLED" delivery status for each failed UE. + +#### 4.4.5.4 Mobile Originated NIDD procedure + +When the SCEF receives the non-IP data from MME/SGSN (or IWK-SCEF) as defined in 3GPP TS 29.128 [12], and finds an SCEF EPS bearer context and the associated NIDD configuration, the SCEF shall determine the SCS/AS by the corresponding NIDD configuration, and send an HTTP POST request to the SCS/AS identified by the Notification Destination Address received in the NIDD configuration to notify the uplink non-IP data. The body of the HTTP POST message shall include External Identifier or MSISDN, non-IP data, NIDD configuration identifier, Reliable Data Service Configuration (if available). The Reliable Data Service Configuration includes port numbers on UE and SCEF that are used to identify a specific application for data transfer between UE and SCS/AS and an indication if reliable data service acknowledgement is enabled or not. + +Upon receipt of the request, if the SCS/AS knows the NIDD configuration identified by the NIDD configuration identifier, the SCS/AS shall acknowledge a 200 OK or 204 No Content message to the SCEF. + +#### 4.4.5.5 NIDD Authorisation Update procedure + +When the SCEF receives a NIDD Authorisation Update Request message from HSS to update a user's NIDD authorisation as defined in 3GPP TS 29.336 [11], the SCEF shall determine the SCS/AS with the corresponding NIDD Configuration, and send an HTTP POST message to the SCS/AS to notify it of the NIDD Authorisation Update. The body of the HTTP POST message shall include External Identifier or MSISDN, NIDD configuration identifier and the NIDD configuration status. + +Upon receipt of the request, if the SCS/AS knows the corresponding NIDD configuration, then the SCS/AS shall acknowledge the request with an HTTP 200 OK or 204 No Content response. + +If the NIDD configuration is revoked by the HSS within the received NIDD Authorisation Update Request, the SCEF shall release the corresponding T6a/b PDN connection as specified in 3GPP TS 29.128 [12]. In this case, the SCEF shall reject any subsequent MT NIDD deliveries with a 403 Forbidden response. Or 404 Not Found is returned, if the SCEF locally removed the associated NIDD configuration resource when the configuration was revoked. + +If the RDS capability is changed, e.g. when the T6a/b PDN connection is established, the UE indicates no support for RDS but the SCEF previously indicated RDS is supported to the SCS/AS in the NIDD configuration procedure, the SCEF shall send an HTTP POST message to notify the SCS/AS that the NIDD status is active and RDS capability indication. The SCS/AS shall acknowledge the request with an HTTP 200 OK or 204 No Content response. + +If the Rds\_port\_verification feature is supported, before sending the MO NIDD to the SCS/AS as specified in clause 4.4.5.4, the SCEF shall check RDS port numbers (decoded from the uplink non-IP data according to 3GPP TS 24.250 [31]). If the RDS port numbers are not within the configured RDS port list, the SCEF shall notify the SCS/AS with NIDD status set to "RDS\_PORT\_UNKNOWN" and the unknown RDS port numbers. The SCS/AS shall acknowledge the request with an HTTP 200 OK or 204 No Content response. + +#### 4.4.5.6 Port Management Configuration + +##### 4.4.5.6.1 Port Reservation and Release + +As part of the Port Management configuration, operations to reserve a combination of port numbers, release a combination of port numbers, query the list of port numbers that are reserved and notification of reservation of a port number may be performed, if the Rds\_dynamic\_port feature is supported. + +Indication of the supported serialization formats by the SCS/AS, query of the supported and configured serialization formats by the SCS/AS, and notification of the supported and configured serialization formats by the SCS/AS may be performed if the Rds\_serialization\_format feature is supported. + +If the SCS/AS needs to reserve port numbers and associate them with an application, the SCS/AS shall send an HTTP PUT message to the SCEF, using the URI received in the response to the request that has created the NIDD + +configuration resource and the specific part of "/rds-ports/{portId}" as described in clause 5.6.3.9.2. The SCS/AS may use this operation to reserve port numbers on the UE and SCEF and associate them with an application. The SCS/AS may also use this operation to indicate the serialization formats that are supported by the SCS/AS on the port. Upon receipt of the HTTP PUT request from the SCS/AS, + +- if the "skipUeInquiry" is set to "false" and if the "individual ManagePort Configuration" resource already exists in the same NIDD configuration, the SCEF shall respond with a 403 Forbidden response with a cause value "PORT\_NOT\_FREE" in the "cause" attribute of the "ProblemDetails" data structure; otherwise, the SCEF shall interact with the UE via the SGSN/MME to reserve the port and optionally configure the serialization format by using RDS protocol as specified in 3GPP TS 24.250 [31] and return a 202 Accept response to the SCS/AS if successful response is received from the SGSN/MME. Then if the SCEF receives successful UE response, the SCEF shall create the "individual ManagePort Configuration" resource and notify the SCS/AS with the reserved port and configured serialization format as specified in clause 4.4.5.6.2, the SCEF shall also mark the resource is created by the SCS/AS; otherwise, the SCEF shall notify the SCS/AS about the currently reserved ports as specified in clause 4.4.5.6.2. +- if the "skipUeInquiry" is set to "true" and if the requested SCEF port already exists in an NIDD configuration within the same APN, the SCEF shall respond with a 403 Forbidden response with a cause value "PORT\_NOT\_FREE" in the "cause" attribute of the "ProblemDetails" data structure; otherwise, the SCEF shall create the "individual ManagePort Configuration" resource and send an HTTP 201 Created response to the SCS/AS, the SCEF shall also mark the resource is created by the SCS/AS and notify the UE by using RDS protocol as specified in 3GPP TS 24.250 [31]. + +If the SCEF is not able to configure a serialization format for the port and if the Rds\_serialization\_format feature is supported, the SCEF shall respond with a 500 Internal Server Error response with a cause value "SERIALIZATION\_FORMAT\_NOT\_SUPPORTED" in the "cause" attribute of the "ProblemDetails" data structure. + +If the SCS/AS needs to release port numbers associated with an application, the SCS/AS shall send an HTTP DELETE message to the SCEF, using the URI received in the response to the request that has created the "individual ManagePort Configuration" resource. Upon receipt of the HTTP DELETE request from the SCS/AS, if the "individual ManagePort Configuration" resource does not exist in the same NIDD configuration, the SCEF shall respond with a 404 Not Found response with a cause value "PORT\_NOT\_ASSOC\_WITH\_APP" in the "cause" attribute of the "ProblemDetails" data structure; otherwise if the "individual ManagePort Configuration" resource was created by the SCS/AS and + +- if the "skipUeInquiry" is set to "false", the SCEF shall interact with the UE via the SGSN/MME to release the port by using RDS protocol as specified in 3GPP TS 24.250 [31] and return 202 Accept to the SCS/AS if successful response is received from the SGSN/MME. Then upon receipt of the UE response, the SCEF shall notify the SCS/AS with the currently reserved ports as specified in clause 4.4.5.6.2. +- if the "skipUeInquiry" is set to "true", the SCEF shall delete the individual ManagePort Configuration resource and respond with an HTTP 204 No Content response to the SCS/AS. The SCEF shall also notify the UE by using RDS protocol as specified in 3GPP TS 24.250 [31]. + +If the HTTP DELETE request is received for the "Individual ManagePort Configuration" resource which was created by the UE, the SCEF shall reject the message with a 403 Forbidden response with a cause value "OPERATION\_PROHIBITED" in the "cause" attribute of the "ProblemDetails" data structure. + +If the "skipUeInquiry" is set to "false" and the SCEF is not able to interact with the UE because: + +- PDN connection is not established, the SCEF shall reject the HTTP PUT/DELETE request with a 500 Internal Server Error response with a cause value "NO\_PDN\_CONNECTION"; +- UE is not reachable, the SCEF shall reject the HTTP PUT/DELETE request with a 500 Internal Server Error response with a cause value "TEMPORARILY\_NOT\_REACHABLE". The response may include a Requested Re-Transmission time to indicate the SCS/AS when the UE is expected to be reachable so that the SCS/AS may prepare any re-configuration for the RDS port; or +- the interaction with the SGSN/MME is not successful, the SCEF shall reject the HTTP PUT/DELETE request with a 500 Internal Server Error and a proper cause value indicating the reason for the delivery failure. + +If the SCS/AS needs to read the port numbers and serialization formats that are associated with an application, the SCS/AS shall send an HTTP GET message to the SCEF, using the URI received in the response to the request that has created the NIDD configuration resource and the specific part of "/rds-ports/{portId}" as described in clause 5.6.3.9.2. + +#### 4.4.5.6.2 Port Notification + +If the SCEF needs to send the information about reserved ports and their configuration to the SCS/AS (e.g. due to 3GPP network created or released "individual ManagePort Configuration" resource upon UE triggered RDS port management procedures as specified in 3GPP TS 24.250 [31]), the SCEF shall send an HTTP POST message to the SCS/AS, using the URI received within the "notificationDestination" attribute in the NiddConfiguration resource. The body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.9-1. The SCS/AS shall acknowledge the HTTP POST request with an HTTP 200 OK or 204 No Content response. + +#### 4.4.6 Procedures for Device Triggering + +The procedures are used by the SCS/AS to deliver the device trigger via T8 interface. + +In order to create a new device trigger, the SCS/AS shall send an HTTP POST message to the SCEF for the "Device Triggering Transactions" resource. The body of the HTTP POST message shall include the External Identifier or MSISDN, validity period, priority, Application Port ID and trigger payload. + +Upon receipt of the corresponding HTTP POST message, the SCEF shall check if the SCS/AS is authorised to send a trigger request and if the SCS/AS has exceeded its quota or rate of trigger submission. The SCEF shall also resolve the External Identifier or MSISDN to IMSI and retrieve the "Routing Information" from HSS for the triggering delivery. If the authorisation check fails, or if the quota or rate of trigger submission was exceeded, or if there is no valid subscription information or if the "Routing Information" cannot be found, then the SCEF shall reject the request with an error message to the SCS/AS. Otherwise, the SCEF shall perform the device trigger procedure over Tsp as defined in 3GPP TS 29.368 [24] and T4 as defined in 3GPP TS 29.337 [25]. Upon completion of this procedure, the SCEF shall create a resource "Individual Device Triggering Transaction" which represents the triggering transaction, addressed by a URI that contains the SCS/AS identity and an SCEF-created transaction identifier, and shall respond to the SCS/AS with a 201 Created message, including the trigger and a Location header field containing the URI for the created resource. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this device triggering transaction. + +In order to replace an existing device trigger, the SCS/AS shall send an HTTP PUT message to the SCEF for the "Individual Device Triggering Transaction" resource, using the URI received in the response to the request that has created the device triggering transaction resource. The body of the HTTP PUT message shall include the DeviceTriggering data structure containing the requested updates. The properties "msisdn" or "externalId" shall remain unchanged from the previously provided value. + +If the "PatchUpdate" feature defined in clause 5.7.4 is supported, in order to partially modify an existing Individual Device Triggering Transaction resource, the SCS/AS shall send an HTTP PATCH message to the SCEF targeting the concerned "Individual Device Triggering Transaction" resource, using the URI received in the response to the request that has created the concerned Individual Device Triggering Transaction resource. The body of the HTTP PATCH message shall include the DeviceTriggeringPatch data structure containing the requested modifications. + +After receiving the corresponding HTTP PUT / HTTP PATCH message from the SCS/AS, the SCEF shall check if the SCS/AS is authorised to replace/modify an existing device trigger and if the SCS/AS has not exceeded its quota or rate of trigger submission. If any of these checks fail, then the SCEF shall reject the message with a corresponding failure code as described in clause 5.2.6. Otherwise, the SCEF shall replace the device triggering with the SMS-SC by performing the device trigger replace procedure over Tsp as defined in 3GPP TS 29.368 [24] and T4 as defined in 3GPP TS 29.337 [25]. Upon completion of this procedure, the SCEF shall send an HTTP response to the SCS/AS with a "200 OK" status code and include the result in the body of the HTTP response or a "204 No Content" status code to indicate a successful trigger replacement/modification; otherwise, the SCEF shall send a corresponding failure code as described in clause 5.2.6. + +In order to recall an existing device trigger, the SCS/AS shall send an HTTP DELETE message to the SCEF for the "Individual Device Triggering Transaction" resource, using the URI received in the response to the request that has created the device triggering transaction resource. + +After receiving the corresponding HTTP DELETE message from the SCS/AS, the SCEF shall check if the SCS/AS is authorised to send a recall trigger request and if the SCS/AS has not exceeded its quota or rate of trigger submission. The SCEF shall also check if the device triggering transaction resource referenced by the URI exists. If any of these checks fail, then the SCEF shall reject the message with an error. Otherwise, the SCEF shall recall the device triggering with the SMS-SC by performing the device trigger recall procedure over Tsp as defined in 3GPP TS 29.368 [24] and T4 as defined in 3GPP TS 29.337 [25]. Upon completion of this procedure, the SCEF shall send an HTTP response to the SCS/AS to indicate trigger recall success or failure. + +When it receives the Message Delivery Report from the SMS/SC, the SCEF shall send an HTTP POST message to the SCS/AS to report the trigger delivery result. The body of the HTTP POST message shall include the identifier if the transaction and cause. The SCS/AS shall respond with an HTTP 200 OK or 204 No Content response. + +## 4.4.7 Procedures for Group Message Delivery + +### 4.4.7.1 General + +This procedure is used by an SCS/AS to deliver a payload to a group of UEs. Two methods of Group Message Delivery via the T8 are specified: + +- Group Message Delivery via MBMS which is intended to efficiently distribute the same content to the members of a group that are located in a particular geographical area when MBMS is used. This method further includes two varieties: + - the MB2 interface (see stage 2 in 3GPP TS 23.468 [55] and stage 3 in 3GPP TS 29.468 [36]) is used as southbound interface; + - the xMB interface (see stage 2 in 3GPP TS 26.348 [56] and stage 3 in 3GPP TS 29.116 [37]) is used as southbound interface. +- Group Message Delivery via unicast MT NIDD for UEs which are part of the same External Group Identifier. + +NOTE: Group Message Delivery via MT NIDD is defined in clause 4.4.5.3.2. + +Error handling for the procedures in the subsequent clauses shall be handled based on clause 5.2.6. + +### 4.4.7.2 Group Message Delivery via MBMS + +#### 4.4.7.2.1 General + +This procedure is used by an SCS/AS to deliver a payload to a group of UEs via the T8 interface. The SCEF use the Group Message Delivery via MBMS to efficiently distribute the same content to the members of a group that are located in a particular geographical area when MBMS is used. + +The procedure of Group message Delivery via MBMS and MB2 used as southbound interface is described in caluse 4.4.7.2.2 and the procedure of Group message Delivery via MBMS and xMB used as southbound interface is described in caluse 4.4.7.2.3. + +#### 4.4.7.2.2 Group Message Delivery via MBMS by MB2 + +##### 4.4.7.2.2.1 TMGI Allocation + +If the SCS/AS acts as a GCS AS in the application level and if there is no assigned TMGI for an External Group Identifier, the SCS/AS shall send an HTTP message to the SCEF to the resource "TMGI Allocation". The body of the HTTP POST request message shall include the External Group Identifier. The SCS/AS may also include the location information in the body. + +Upon receipt of the HTTP POST request from the SCS/AS to allocate a TMGI, the SCEF shall check whether the SCS/AS is authorized to request TMGI allocation. If authorization is successful, the SCEF shall initiate TMGI allocation by the BM-SC as defined in clause 5.2.1 of 3GPP TS 29.468 [36]. Upon successful allocation of a TMGI, the SCEF shall create the resource which represents the TMGI allocation, addressed by a URI that contains the SCS identity and TMGI, and shall respond to the SCS/AS with a 201 Created message including the TMGI and the TMGI expiration time. + +In order to renew the TMGI expiration time, the SCS/AS shall send an HTTP PUT or PATCH message to the SCEF to the resource "Individual TMGI Allocation". Upon receipt of the HTTP PUT or PATCH request from the SCS/AS to renew TMGI expiration time, the SCEF shall initiate TMGI expiration time renewal to the BM-SC as defined in clause 5.2.1 of 3GPP TS 29.468 [36]. Upon successful result, the SCEF shall update the resource and respond to the SCS/AS by sending an HTTP response with 200 OK including the new TMGI expiration time or 204 No Content if the + +required TMGI expiration time renewal is successful with no content in the HTTP PUT or PATCH response message body. + +If the SCEF receives the response with an error code from the BM-SC for the allocation of TMGI or renewal of expiration time for the existing TMGI, the SCEF shall not create or update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +Upon the TMGI expiration, the SCEF may delete the resource of the TMGI locally. + +Upon receipt of the notification of TMGI expiration by the BM-SC as defined in clause 5.2.3 of 3GPP TS 29.468 [36], the SCEF shall delete the resource if not yet deleted. + +#### 4.4.7.2.2.2 TMGI Deallocation + +In order to deallocate the TMGI, the SCS/AS shall send an HTTP DELETE message to the SCEF to the resource "Individual TMGI Allocation". Upon receipt of the HTTP DELETE request from the SCS/AS to deallocate the TMGI, the SCEF shall initiate TMGI deallocation by the BM-SC as defined in clause 5.2.2 of 3GPP TS 29.468 [36]. Upon successful deallocation of a TMGI, the SCEF shall delete the resource "Individual TMGI Allocation" together with all sub-resources "GMD via MBMS by MB2" if available, and shall respond to the SCS/AS by sending an HTTP response with 204 No Content. + +#### 4.4.7.2.2.3 Creation of group message delivery + +If the SCS/AS acts as a GCS AS in the application level and if the SCS/AS has an assigned TMGI for the External Group Identifier, in order to perform the group message delivery, the SCS/AS shall send an HTTP POST request message to the SCEF to the resource "GMD via MBMS by MB2". The body of the HTTP POST request message shall include the External Group Identifier and notification destination URI identifying the recipient of notification within the "notificationDestination" attribute. The SCS/AS may also include the Group Message Payload, the location information and a Message Delivery Start Time in the body. + +The SCS/AS may also send an HTTP POST message to the SCEF directly to the resource "TMGI Allocation" without previously requesting TMGI allocation as defined in clause 4.4.7.2.2. The SCEF shall create the resource "Individual TMGI Allocation" and perform the procedure as defined in clause 4.4.7.2.2, and shall also create resource "GMD via MBMS by MB2" and perform the procedure as mentioned in this subclause for MBMS bearer creation. + +Upon receipt of the HTTP POST request from the SCS/AS to deliver the group message, the SCEF shall check whether the SCS/AS is authorized to send a group message request. It also checks to see if the Message Delivery Start Time does not start after the TMGI expiration. If authorization is successful, the SCEF shall initiate the Active MBMS Bearer procedure as defined in clause 5.3.2 of 3GPP TS 29.468 [36] with the difference that the SCEF acts as a GCS AS. The SCEF shall include the location information based on the local configuration if the location information is not provided in the HTTP POST request message. + +Upon successful activation of MBMS bearer, the SCEF shall create resource which represents "Individual GMD via MBMS by MB2", addressed by a URI that contains Transaction Id allocated by the SCEF and respond to the SCS/AS by sending an HTTP response with a 201 Created status code, including a Location header field containing the URI for the created resource. When the SCS/AS receives the URI in the Location header, it shall use this URI in subsequent requests to the SCEF to refer to this active MBMS bearer. If the Group Message Payload was not included in the HTTP POST above, the HTTP response sent from the SCEF shall also include the SCEF message delivery IPv4 address or IPv6 address and port number. + +If the SCEF receives the response with an error code from the BM-SC for the activation of MBMS bearer, the SCEF shall not create the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +If the Group Message Payload was included in the HTTP POST above, the SCEF shall deliver to BM-SC the Group Message Payload(s) as defined in 3GPP TS 29.468 [36] at Message Delivery Start Time. + +If the Group Message Payload was not included in the HTTP POST above, the SCEF shall transfer the contents received from the SCS/AS to the BM-SC at or after the requested Group Message Start Time, but before the TMGI Expiration time. In this case, when the SCEF detects the group message delivery was triggered successful, the SCEF shall send an HTTP POST request message to the SCS/AS. + +NOTE: If Group Message Payload was included, then at Message Delivery Start Time, the SCEF delivers to BM-SC the Group Message Payload(s) to corresponding to MB2-U IP address and port number associated with respective TMGI. + +#### 4.4.7.2.2.4 Modification of previous submitted group message delivery + +If the SCS/AS determines that modification of previous accepted Group Message Delivery Request is required, the SCS/AS shall send an HTTP PATCH or HTTP PUT request message to the SCEF to the resource "Individual GMD via MBMS by MB2". The body of the HTTP PATCH request message shall include the Message Delivery Start Time. The SCS/AS may also include the External Group Identifier, the Group Message Payload and the location information in the body. The body of the HTTP PUT request message shall include the information as the information provided in the HTTP POST in clause 4.4.7.2.2.2.3. The body of the HTTP PATCH request message shall include the information defined in the data type of GMDViaMBMSByMb2Patch as defined in clause 5.8.2.1.1.6. + +Upon receipt of the HTTP PATCH or HTTP PUT request from the SCS/AS to modify the previous group message delivery subscription, the SCEF shall check whether the SCS/AS is authenticated and authorized to modify the submitted group message delivery. If the authorization is successful, the SCEF shall initiate the Modify MBMS Bearer procedure as defined in clause 5.3.4 of 3GPP TS 29.468 [36] with the difference that the SCEF acts as a GCS AS. The SCEF shall include the location information based on the local configuration if the location information is not provided in the HTTP PATCH or HTTP PUT request message. + +Upon successful modification of MBMS bearer, the SCEF shall update the resource and respond to the SCS/AS with a 200 OK success message indicating that previous group message delivery subscription is successfully updated, or 204 No Content if the updates or replacement is successful with no content in the HTTP PATCH or HTTP PUT response message body. + +If the SCEF receives the response with an error code from the BM-SC for the modification of MBMS bearer, the SCEF shall not update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +#### 4.4.7.2.2.5 Cancellation of previous submitted group message delivery + +If the SCS/AS determines that deletion of previous accepted Group Message Delivery Request is required, the SCS/AS shall send an HTTP DELETE request message to the SCEF. + +Upon receipt of the HTTP DELETE request from the SCS/AS to delete the previous group message delivery, the SCEF shall check whether the SCS/AS is authenticated and authorized to delete an existing group message delivery subscription. If the authorization is successful, the SCEF shall initiate the Delete MBMS Bearer procedure as defined in clause 5.3.3 of 3GPP TS 29.468 [36] with the difference that the SCEF acts as a GCS AS. + +Upon successful deletion of MBMS bearer, the SCEF shall respond to the SCS/AS with a 204 No Content message indicating that submitted group message delivery is successfully deleted. + +#### 4.4.7.2.3 Group message Delivery via MBMS by xMB + +##### 4.4.7.2.3.1 Service Creation + +If the SCS/AS acts as a content provider in the application level and if there is no assigned Service ID for an External Group Identifier, the SCS/AS shall send an HTTP POST message to the SCEF to the resource "xMB Services". The body of the HTTP POST request message shall include the External Group Identifier. + +Upon receipt of the HTTP POST request from the SCS/AS to create a service, the SCEF shall check whether the SCS/AS is authorized to request service creation. If authorization is successful, the SCEF shall initiate service creation by the BM-SC as defined in clause 5.2.1.2.2 of 3GPP TS 29.116 [37]. Upon successful service creation, the SCEF shall create the resource which represents the service creation, addressed by a URI that contains the SCS identity and Service Id, and shall respond to the SCS/AS with a 201 Created message which may include the service announcement information. + +If the SCEF receives the response with an error status code from the BM-SC for the service creation, the SCEF shall not create or update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +#### 4.4.7.2.3.2 Service Deletion + +In order to delete the service, the SCS/AS shall send an HTTP DELETE message to the SCEF to the resource "Individual xMB Service". Upon receipt of the HTTP DELETE request from the SCS/AS to delete the service, the SCEF shall initiate service deletion by the BM-SC as defined in clause 5.2.1.2.4 of 3GPP TS 29.116 [37]. Upon successful deletion of a service, the SCEF shall delete the resource "Individual xMB Service" together with all sub-resources "GMD via MBMS by xMB" if available, and shall respond to the SCS/AS by sending an HTTP response with 204 No Content. + +#### 4.4.7.2.3.3 Creation of group message delivery + +If the SCS/AS acts as a content provider in the application level, the SCS/AS may send an HTTP POST request message to the SCEF to the resource "GMD via MBMS by xMB". The body of the HTTP POST request message shall include the External Group Identifier and notification destination URI identifying the recipient of notification within the "notificationDestination" attribute. The SCS/AS may also include the Group Message Payload, the location information, a Message Delivery Start Time and Message Delivery Stop Time in the body. + +Upon receipt of the HTTP POST request from the SCS/AS to deliver the group message, the SCEF shall check whether the SCS/AS is authorized to send a group message request. It also checks to see if the Message Delivery Start Time doesn't start after the Message Delivery Stop Time. If authorization is successful, the SCEF shall initiate the Create Session procedure as defined in clause 4.4.5.2 of 3GPP TS 29.116 [37] and the Update Session procedure as defined in clause 4.4.5.3 of 3GPP TS 29.116 [37] with the difference that the SCEF acts as a Content Provider, Session Start is set according to the Message Delivery Start Time and the Session Stop is set according to the Message Delivery Stop Time. The SCEF shall include the location information based on the local configuration if the location information is not provided and include the session type set to "Files" in the HTTP POST request message. + +Upon successful activation of MBMS bearer, the SCEF shall create resource which represents "Individual GMD via MBMS by xMB ", addressed by a URI that contains Transaction Id allocated by the SCEF and respond to the SCS/AS by sending an HTTP response with a 201 Created status code, including a Location header field containing the URI for the created resource. When the SCS/AS receives the URI in the Location header, it shall use this URI in subsequent requests to the SCEF to refer to this active MBMS bearer. If the Group Message Payload was not included in the HTTP POST above, the HTTP response sent from the SCEF shall also include the SCEF message delivery IPv4 address or IPv6 address and port number. + +If the SCEF receives the response with an error code from the BM-SC for the activation of MBMS bearer, the SCEF shall not create the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +If the Group Message Payload was included the HTTP POST above, the SCEF shall deliver to BM-SC the Group Message Payload(s) as defined in 3GPP TS 29.468 [36] at Message Delivery Start Time. + +If the Group Message Payload was not included in the HTTP POST above, the SCEF shall transfer the contents received from the SCS/AS to the BM-SC at or after the requested Message Delivery Start Time, but before the Message Delivery Stop Time. In this case, when the SCEF detects the group message delivery was triggered successful, the SCEF shall send an HTTP POST request message to the SCS/AS. + +#### 4.4.7.2.3.4 Modification of previous submitted group message delivery + +If the SCS/AS determines that modification of previous accepted Group Message Delivery Request is required, the SCS/AS shall send an HTTP PATCH or HTTP PUT request message to the SCEF to the resource "Individual GMD via MBMS by xMB ". The body of the HTTP PATCH request message shall include the Message Delivery Start Time and Message Delivery Stop Time. The SCS/AS may also include the External Group Identifier, the Group Message Payload and the location information in the body. The body of the HTTP PUT request message shall include the information as the information provided in the HTTP POST in clause 4.4.7.2.3.3. The body of the HTTP PATCH request message shall include the information defined in the data type of GMDViaMBMSByxMBPatch as defined in clause 5.8.3.1.1.4. + +Upon receipt of the HTTP PATCH or HTTP PUT request from the SCS/AS to modify the previous group message delivery subscription, the SCEF shall check whether the SCS/AS is authenticated and authorized to modify the submitted group message delivery. If the authorization is successful, the SCEF shall initiate the Update Session procedure as defined in clause 4.4.5.3 of 3GPP TS 29.116 [37] with the difference that the SCEF acts as a Content Provider, Session Start is set according to the Message Delivery Start Time and the Session Stop is set according to the Message Delivery Stop Time. The SCEF shall include the location information based on the local configuration if the location information is not provided in the HTTP PATCH or HTTP PUT request message. + +Upon successful modification of MBMS bearer, the SCEF shall respond to the SCS/AS with a 200 OK success message indicating that previous group message delivery subscription is successfully updated or with a 204 No Content success message if no content in the HTTP PUT or PATCH response message body. + +If the SCEF receives the response with an error code from the BM-SC for the modification of MBMS bearer, the SCEF shall not update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +#### 4.4.7.2.3.5 Cancellation of previous submitted group message delivery + +If the SCS/AS determines that deletion of previous accepted Group Message Delivery Request is required, the SCS/AS shall send an HTTP DELETE request message to the SCEF. + +Upon receipt of the HTTP DELETE request from the SCS/AS to delete the previous group message delivery, the SCEF shall check whether the SCS/AS is authenticated and authorized to delete an existing group message delivery subscription. If the authorization is successful, the SCEF shall initiate the Delete Session procedure as defined in clause 4.4.5.4 of 3GPP TS 29.116 [37] with the difference that the SCEF acts as a Content Provider. + +Upon successful deletion of MBMS bearer, the SCEF shall respond to the SCS/AS with a 204 No Content message indicating that submitted group message delivery is successfully deleted. + +### 4.4.8 Procedures for Reporting of Network Status + +#### 4.4.8.1 General + +These procedures are used by an SCS/AS to perform reporting of network status via the T8 interface in one time or continuous reporting cases. The SCEF uses the reporting procedures based on the network status information from one or more RCAFs. These procedures can also be used by the SCS/AS to indicate the removal of a previously subscribed reporting request. + +#### 4.4.8.2 Network Status Reporting Subscription + +In order to create a new subscription to request for notifications on network status, the SCS/AS shall send an HTTP POST request message to the SCEF on the "Network Status Reporting Subscriptions" resource. The body of the HTTP POST request shall include a Notification destination address and Location area information, and may include the time duration and threshold(s). + +Upon receiving the HTTP POST request message from the SCS/AS, the SCEF shall check: + +- if the SCS/AS is authorized to perform the request. If not, the SCEF shall respond to the SCS/AS with an HTTP "401 Unauthorized" status code. +- if the SCS/AS has exceeded its quota of submitting requests. If so the SCEF shall respond to the SCS/AS with an HTTP "403 Forbidden" status code and may indicate the failure reason "QUOTA\_EXCEEDED" (i.e. the quota exceeded) within the "cause" attribute of the ProblemDetails data structure in the HTTP POST response. +- if the SCS/AS has exceeded its rate of submitting requests. If so the SCEF shall respond to the SCS/AS with an HTTP "429 Too Many Requests" status code in the HTTP POST response. + +After the SCEF authorized the HTTP request message, the SCEF shall create an "Individual Network Status Reporting Subscription" resource which represents the subscription, addressed by a URI that contains the SCS/AS identity and an SCEF-created subscription identifier, and shall respond to the SCS/AS with an HTTP "201 Created" status code, including a Location header field containing the URI for the created resource, to acknowledge to the SCS/AS the successful subscription creation. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this network status reporting subscription. Then, the SCEF shall trigger the network status reporting procedure with the RCAF over Ns interface as defined in 3GPP TS 29.153 [30]. + +In order to update an existing subscription of continuous network status reporting, the SCS/AS shall send an HTTP PUT request message to the SCEF on the "Individual Network Status Reporting Subscription" resource, using the URI received in the response to the request that has created the network status reporting subscription resource. After receiving the HTTP PUT request message, the SCEF shall send an HTTP PUT response to the SCS/AS with an HTTP "200 OK" status code including a representation of the updated "Individual Network Status Reporting Subscription" + +resource in the response body, or a "204 No Content" status code. Then, the SCEF shall apply the requested updates and interact with the RCAF as defined in 3GPP TS 29.153 [30]. + +If the "PatchUpdate" feature defined in clause 5.9.4 is supported, in order to partially modify an existing subscription of continuous network status reporting, the SCS/AS shall send an HTTP PATCH request message to the SCEF on the "Individual Network Status Reporting Subscription" resource, using the URI received in the response to the request that has created the network status reporting subscription resource. The request body shall contain the NetStatusRepSubsPatch data structure including only the attributes that shall be updated. After receiving the HTTP PATCH request message, the SCEF shall send an HTTP response to the SCS/AS with an HTTP "200 OK" status code including a representation of the modified "Individual Network Status Reporting Subscription" resource in the response body, or a "204 No Content" status code. Then, the SCEF shall apply the requested changes and interact with the RCAF as defined in 3GPP TS 29.153 [30]. + +**NOTE:** In order to update an existing subscription, the SCEF needs to send a cancellation to the previously associated RCAF(s) to remove the related SCEF instructions and then send a new request with updated parameters. + +In order to remove an existing subscription of continuous network status reporting, the SCS/AS shall send an HTTP DELETE request message to the SCEF on the "Individual Network Status Reporting Subscription" resource, using the URI received in the response to the request that has created the network status reporting subscription resource. Upon reception of the HTTP DELETE request message, the SCEF shall send an HTTP DELETE response to the SCS/AS with an HTTP "204 No Content" status code. Then, the SCEF shall interact with the RCAF to terminate the continuous reporting of network status as defined in 3GPP TS 29.153 [30]. + +#### 4.4.8.3 Network Status Reporting Notification + +After receiving reports from all the involved RCAF(s) as defined in 3GPP TS 29.153 [30], the SCEF shall send an HTTP POST message to the SCS/AS using the identified destination URL, which is provided by the SCS/AS during the network status reporting subscription. The body of HTTP POST message shall include the NSI. + +#### 4.4.9 Procedures for Communication Pattern Parameters Provisioning + +One or more set of CP parameters may be provisioned by the SCS/AS for a single UE or a group of UEs. + +In order to create resources for one or more CP parameter set(s), the SCS/AS shall send an HTTP POST message to the SCEF for the "CP Provisioning Subscriptions" resource, including one or more new provisioned CP parameter set(s). The body of HTTP POST message shall include External Identifier or MSISDN for a single UE or External Group ID for a group of UEs, SCS/AS Identifier and one or more set of CP information associated with CP parameter set Id(s). + +After receiving the HTTP POST message, the SCEF shall check if the SCS/AS is authorised. The SCEF may also check if the number of CP parameter sets(s) reaches the limitation based on operator policy or configuration. + +After validation, the SCEF shall for each received CP parameter set Id, assign an SCEF Reference ID which may be derived from the CP parameter set Id, and send Update CP Parameter Request message to the HSS for delivering the CP parameter set(s) as specified in 3GPP TS 29.336 [11]. + +After receiving result from the HSS, if the result is successful, the SCEF shall create a resource "Individual CP Provisioning Subscription" and the corresponding sub-resources "Individual CP Set Provisioning" each represents a successfully provisioned CP parameter set indicated by the HSS and respond to the SCS/AS with a "201 Created" including Location header field containing the URI for the created subscription resource "Individual CP Provisioning Subscription" and the sub-resource(s) "Individual CP Set Provisioning" corresponding to each successful CP parameter set within the "self" attribute in the "cpParameterSet" attribute; otherwise, the SCEF shall not create any resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. If not all CP parameters sets are provisioned successfully (i.e. the HSS indicates failure for some or all CP parameter sets and/or the SCEF does not accept the CP parameter provisioning (e.g. one or more CP Set Identifiers in the request are already present in existing subscriptions)), the SCEF shall also include CP report(s) within attribute "cpReports" with a list of failed CP Set Identifier(s) and the corresponding failure code as specified in table 5.10.2.3.5-1 in the body of the HTTP response. + +In order to add new CP parameter set(s), update and/or remove the existing CP parameter set(s) for one or more CP parameter set Id(s), the SCS/AS may send an HTTP PUT message to the SCEF for the "Individual CP Provisioning Subscription" resource requesting to add new CP parameter set(s) by creating new resource(s), change some created properties (e.g. Validity Time) of the existing resource(s), and/or remove some or entire properties of the existing + +resource(s). After receiving the HTTP PUT message, the SCEF shall send the CP parameter changes to the HSS as specified in 3GPP TS 29.336 [11]. After receiving the response from the HSS with a successful code, if the HSS indicates all CP parameter sets or some CP parameter sets are provisioned successfully, the SCEF shall create or update the corresponding sub-resource(s) "Individual CP Set Provisioning" each represents a successfully provisioned CP parameter set indicated by the HSS and send an HTTP response to the SCS/AS with a "200 OK" status code and include a list of successful CP parameter set(s) in the body of the HTTP response, or a "204 No Content" status code. Otherwise, the SCEF shall not create or update the resource(s) and shall send an HTTP response to the SCS/AS with a corresponding failure code as described in clause 5.2.6. If not all CP parameters sets are provisioned successfully (i.e. the HSS indicates failure for some or all CP parameter sets and/or the SCEF does not accept the CP parameter provisioning (e.g. one or more CP Set Identifiers in the request are already present in existing subscriptions)), the SCEF shall also include CP report(s) within attribute "cpReports" with a list of failed CP Set Identifier(s) and the corresponding failure code as specified in table 5.10.2.3.5-1 in the body of the HTTP response. + +The SCS/AS may send a HTTP PUT message to the SCEF for the "Individual CP Set Provisioning" resource requesting to replace an individual resource identified by the CP parameter set Id. The body of the HTTP PUT message shall include set of CP information. After receiving such request, the SCEF shall interact with the HSS as specified in 3GPP TS 29.336 [11]. After receiving the response from the HSS with a successful code, the SCEF shall update the resource and send an HTTP response to the SCS/AS with a "200 OK" status code or a "204 No Content" status code; otherwise, the SCEF shall not update the resource and shall send an HTTP response to the SCS/AS with a corresponding failure code as described in clause 5.2.6. If the provisioning of the CP set fails (i.e. the HSS returns failure for the CP set or the SCEF does not accept the CP set provisioning), the SCEF shall reject the request with a corresponding status code, and include the attribute "cpReports" with the corresponding failure code as specified in table 5.10.2.3.5-1 and the CP Set Identifier for which the provisioning has failed. + +The SCS/AS may send an HTTP DELETE message to the SCEF requesting to delete an individual CP set resource "Individual CP Set Provisioning". After receiving such request, the SCEF shall determine the SCEF Reference ID for Deletion associated with the CP parameter set Id, and interact with the HSS as specified in 3GPP TS 29.336 [11]. After receiving the response from the HSS, the SCEF shall delete the addressed resource and send an HTTP response to the SCS/AS with a "204 No Content" status code. + +The SCS/AS may send an HTTP DELETE message to the SCEF requesting to delete an individual subscription resource "Individual CP Provisioning Subscription". After receiving such request, the SCEF shall determine the SCEF Reference ID (s) for Deletion associated with the CP parameter set Id(s) and interact with the HSS as specified in 3GPP TS 29.336 [11]. After receiving the response from the HSS, the SCEF shall delete the addressed resource and its sub-resources addressed by "Individual CP Set Provisioning" and send an HTTP response to the SCS/AS with a "204 No Content" status code. + +## 4.4.10 Procedures for PFD Management + +The PFDs associated with application identifier(s) may be created, updated or removed by the third party SCS/AS as defined in 3GPP TS 23.682 [2]. + +In order to create PFDs resources for one or more external Application Identifier(s), the SCS/AS shall send an HTTP POST message to the request URI of the resource "PFD Management Transactions" including one or more set of PFDs for external Application Identifier(s). The body of the HTTP POST message shall include external Application Identifier(s) and PFDs associated with its PFD Identifier(s), an Allowed Delay may be included for the external Application Identifier(s) as well. + +After receiving the HTTP POST message, if the SCS/AS is authorized, the SCEF shall provision the PFDs to the PFDF as defined in 3GPP TS 29.250 [26]. When receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. If one or more external application identifiers are provisioned successfully, the SCEF shall create an "Individual PFD Management Transaction" resource for the request and he corresponding sub-resources "Individual Application PFD Management" each represents a successfully provisioned external application identifier. The SCEF shall respond to the SCS/AS with a 201 Created including Location header field containing the URI for the created transaction resource "Individual PFD Management Transaction" and the sub-resource(s) "Individual Application PFD Management" corresponding to each external application identifier within the "self" attribute in the "PfdData" data type, the SCEF shall also include PFD report(s) with a list of external Application Identifier(s) and result(s) in the body of the HTTP response if some application(s) are not provisioned successfully (i.e. the PFDF returns failure and/or the SCEF does not accept the PFD provisioning (e.g. one or more external Application Identifiers in the request are already present in existing transactions)). + +In order to update the PFDs for an existing individual transaction, the SCS/AS shall send an HTTP PUT message to URI of the resource "Individual PFD Management Transaction" including one or more set of PFDs for external Application Identifier(s). After receiving the HTTP PUT message, the SCEF shall make the change and send the change to the PFDF (i.e. add/update/remove PFDs) as defined in 3GPP TS 29.250 [26]. After receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. The SCEF shall create or update the corresponding sub-resource(s) "Individual Application PFD Management" each represents a successfully provisioned external application identifier, and also include PFD report(s) with a list of external Application Identifier(s) and result(s) in the body of the HTTP response if some application(s) are not provisioned successfully (i.e. the PFDF returns failure and/or the SCEF does not accept the PFD provisioning (e.g. one or more external Application Identifiers in the request are already present in existing transactions)). + +NOTE 1: When the PUT for "Individual PFD Management Transaction" is received in the SCEF, SCEF can use partial update or full update towards the PFDF. + +If the "PatchUpdate" feature defined in clause 5.11.4 is supported, in order to partially modify an existing PFD Management Transaction, the SCS/AS shall send an HTTP PATCH request message to the SCEF on the "Individual PFD Management Transaction" resource, using the URI received in the response to the request that has created the concerned PFD Management Transaction resource. The request body shall contain the PfdManagementPatch data structure including only the attributes that shall be updated. After receiving the HTTP PATCH request, the SCEF shall apply the requested modifications and interact with the concerned PFDF to add/update/remove PFD(s) as defined in 3GPP TS 29.250 [26]. After receiving the response of the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. The SCEF shall then create or update the corresponding "Individual Application PFD Management" sub-resource(s), with each represents a successfully provisioned external application identifier. If some application(s) are not provisioned successfully (i.e. the PFDF returns a failure and/or the SCEF does not accept the PFD provisioning (e.g. one or more external Application Identifiers in the request are already present in existing transactions)), the SCEF shall also include PFD report(s) containing a list of external Application Identifier(s) and result(s) in the body of the HTTP response. + +In order to remove the PFDs for an existing individual transaction, the SCS/AS shall send an HTTP DELETE message to the URI of the resource "Individual PFD Management Transaction". After receiving such request, the SCEF shall delete the "Individual PFD Management Transaction" resource and its "Individual Application PFD Management" sub-resource(s), and shall interact with the PFDF as defined in 3GPP TS 29.250 [26]. After receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. + +For the POST message to the resource "PFD Management Transactions" or the PUT message to the resource "Individual PFD Management Transaction", if the provisioning of all application(s) fails (i.e. the PFDF returns failure and/or the SCEF does not accept the PFD provisioning), the SCEF shall respond with 500 Internal Server Error status code, and include the attribute "pfdReports" with the corresponding failure reason as specified in table 5.11.2.2.3-1 and the external Application Identifier(s) for which the provisioning has failed. + +In order to update the PFDs for an existing external Application Identifier, the SCS/AS shall send an HTTP PUT message to the resource "Individual Application PFD Management" to update the full set of PFDs of an existing resource. After receiving the HTTP PUT message, the SCEF shall make the change and send the change to the PFDF (i.e. add/update/remove PFDs) as defined in 3GPP TS 29.250 [26]. After receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. + +NOTE 2: When the PUT for "Individual Application PFD Management" is received in the SCEF, SCEF can use partial update or full update towards the PFDF. + +In order to update the PFDs for an existing external Application Identifier, the SCS/AS may also send an HTTP PATCH message to URI of the resource "Individual Application PFD Management" to partially update PFDs. After receiving the HTTP PATCH message, the SCEF shall make the change and send the change to the PFDF (i.e. add/update/remove PFDs) as defined in 3GPP TS 29.250 [26]. After receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. + +In order to remove the PFDs for an existing individual application, the SCS/AS shall send an HTTP DELETE message to the resource "Individual Application PFD Management". After receiving such request, the SCEF shall delete the resource and interact with the PFDF as defined in 3GPP TS 29.250 [26]. After receiving the response from the PFDF, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code. + +For the PUT/PATCH message to the resource "Individual Application PFD Management", if the provisioning of the application fails (i.e. the PFDF returns failure or the SCEF does not accept the PFD provisioning), the SCEF shall reject + +the request with a corresponding status code, and include the attribute "pfdReports" with the corresponding failure code as specified in table 5.11.2.2.3-1 and the external Application Identifier for which the provisioning has failed. + +If the SCEF receives PFD management notification including the PFD failure report from the PFDF (as defined in 3GPP TS 29.250 [26]) and if the feature PfdMgmtNotification is supported, the SCEF shall notify the SCS/AS with an HTTP POST message, identified by the notification destination URI received during the PFD provisioning, to notify the failure result for the PFD management by including the PfdReport data type in the body of the message. Within the PfdReport data type, the SCEF shall include the impacted application id(s) within the "externalAppIds" attribute, the "failureCode" attribute set to "PARTIAL\_FAILURE". In addition, if the SCEF receives the location area(s) of PCEF/TDF(s) which are unable to enforce the PFD(s) from the PFDF, the SCEF shall include the location area(s) within the "locationArea" attribute of the PFD report(s). After receiving the HTTP POST message, the SCS/AS shall send a HTTP response with "204 No Content" status code. + +NOTE 3: How the SCS/AS reacts to the failed PFD provisioning is left to implementation. + +NOTE 4: The SCEF maps the 3GPP network area(s) to the geographic area(s) or civic address(es) if the 3GPP network area(s) is not allowed to be exposed to the 3rd party according to the operator policy. + +#### 4.4.11 Procedures for Enhanced Coverage Restriction Control + +The procedures are used by an SCS/AS to query the status of, or to configure the enhanced coverage restriction for a UE via the T8 interface as defined in 3GPP TS 23.682 [2]. + +In order to query the current status of enhanced coverage restriction, the SCS/AS shall send an HTTP POST message to the SCEF using the query custom operation as defined in clause 5.12.13.2. The body of the HTTP POST message shall include External Identifier or MSISDN. + +In order to configure the enhanced coverage restriction, the SCS/AS shall send an HTTP POST message to the SCEF using the configure custom operation as defined in clause 5.12.13.3. The body of the HTTP POST message shall include External Identifier or MSISDN and the Enhanced Coverage Restriction setting (i.e. allowed-PLMN-List or restricted-PLMN-List). + +Upon receiving the HTTP POST message from the SCS/AS, the SCEF shall check: + +- if the SCS/AS is authorized to perform the request. If not the SCEF shall respond to the SCS/AS with a status code set to 401 Unauthorized. +- if the request is malformed. If it is malformed, the SCEF shall respond to the SCS/AS with a status code set to 400 Bad Request. +- if the SCS/AS has exceeded its quota of submitting requests. If so the SCEF shall respond to the SCS/AS with a status code set to 403 Forbidden and may indicate the failure reason "QUOTA\_EXCEEDED" (i.e. the quota exceeded) within the "cause" attribute of the "ProblemDetails" structure in the HTTP POST response. +- if the SCS/AS has exceeded its rate of submitting requests. If so the SCEF shall respond to the SCS/AS with a status code set to 429 Too Many Requests in the HTTP POST response. + +The SCEF shall send a Configuration Information Request to the HSS to query or configure the setting of Enhanced Coverage Restriction as defined in 3GPP TS 29.336 [11]. + +Upon receipt of the response from the HSS, the SCEF shall send an HTTP response to the SCS/AS with a 200 OK message for query or configure custom operation and include the Enhanced Coverage Restriction Data from HSS into the HTTP response. + +If the SCEF receives a response with an error code from the HSS, the SCEF shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +## 4.4.12 Procedures for Network Parameter Configuration + +### 4.4.12.1 General + +The procedures are used by an SCS/AS to request that the network consider setting the suggested network parameter values which can influence certain aspects of UE/network behaviour. The procedures are applicable for an individual UE or a group of UEs. + +In order to create a new network parameter configuration to configure suggested network parameters, the SCS/AS shall send an HTTP POST request message to the SCEF to the resource "NP Configurations". The body of the HTTP request message shall include External Identifier or MSISDN or External Group Identifier, SCS/AS Identifier, and may include Maximum Latency, Maximum Response Time and Suggested Number of Downlink Packets and Group Reporting Guard Time, wherein, the External Identifier or MSISDN indicates the configuration for an individual UE and the External Group Identifier indicates for a group of UEs. If the External Group Identifier is included, the SCS/AS shall provide the Notification Destination Address in the request. + +NOTE: The Notification Delivery as described in clause 5.2.5 is not supported for individual UE configuration case. + +In order to update an existing Network Parameter Configuration, the SCS/AS may send an HTTP PUT message to the resource "Individual NP Configuration" requesting the SCEF to replace all properties in the existing resource. + +The SCS/AS may also use an HTTP PATCH message to request to change some properties in the existing resource. + +Upon receipt of the HTTP POST, PUT or PATCH message, if the SCS/AS is authorized to perform the request, the SCEF shall check whether the Maximum Latency, Maximum Response Time and/or Suggested Number of Downlink Packets in the HTTP request body are within the range defined by operator policies, if one or more of these parameters are not within the range, the SCEF shall: + +- either reject the request message by sending an HTTP response to the SCS/AS with a status code set to "403 Forbidden", in which it may indicate the "PARAMETER\_OUT\_OF\_RANGE" application error in the "cause" attribute of the "ProblemDetails" data structure and it may also indicate which parameters are out of the range in the "invalidParams" attribute of the "ProblemDetails" structure in the response body; or +- modify the parameters which are not within the range by selecting different values which are in the range. + +After validation, the SCEF shall perform the Network Parameter Configuration as described in clause 4.4.12.2 for an individual UE or in clause 4.4.12.3 for a group of UEs. + +In order to delete an existing Network Parameter Configuration at the SCEF, the SCS/AS shall send an HTTP DELETE message to the corresponding resource "Individual NP Configuration" at the SCEF. The SCEF shall determine the SCEF Reference ID for deletion and interact with the HSS via S6t as defined in 3GPP TS 29.336 [11]. Upon receipt of the response from the HSS, the SCEF shall delete active resource "Individual NP Configuration" addressed by the URI and send an HTTP response to the SCS/AS with a "204 No Content" status code. + +### 4.4.12.2 Configuration Request for an individual UE + +If the configuration request from the SCS/AS is for an individual UE, the SCEF shall send the Configuration Information Request command to the HSS via S6t as defined in 3GPP TS 29.336 [11]. + +Upon receipt of the response from the HSS, the SCEF shall, + +- for the HTTP POST message, create a new resource "Individual NP Configuration" addressed by a URI that contains the SCS/AS identifier and an SCEF-created configuration identifier, and send an HTTP POST response to the SCS/AS with "201 Created" status code, the final suggested configuration parameter(s) (if modified), the indication(s) for the discarded parameter(s) (if discarded), and a location header field containing the URI for the created resource. +- for the HTTP PUT or PATCH message, update the active resource "Individual NP Configuration", and send an HTTP response to the SCS/AS with "200 OK" status code, the final suggested network parameter(s) (if modified), the indication(s) for the discarded parameter(s) (if discarded), or a "204 No Content" status code. + +If the SCEF receives a response with an error code from the HSS, the SCEF shall not create or update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +#### 4.4.12.3 Configuration Request for a group of UEs + +If the configuration request from the SCS/AS is for a group of UEs, the SCS/AS shall provide the Notification Destination Address, the SCEF shall send the Configuration Information Request command to the HSS via S6t as defined in 3GPP TS 29.336 [11]. + +Upon receipt of the successful response indicating that group processing is in progress from the HSS before beginning the processing of individual UEs, the SCEF shall, + +- for the HTTP POST message, create a resource "Individual NP Configuration" addressed by a URI that contains the SCS/AS identity and an SCEF-created configuration identifier. The SCEF shall send an HTTP POST response to the SCS/AS including a location header field containing the URI for the created resource and a "201 Created" status code to acknowledge the SCS/AS of the successful group processing request. +- for the HTTP PUT or PATCH message, update the resource "Individual NP Configuration" addressed by the requested URL, and shall send "200 OK" status code or a "204 No Content" status code to acknowledge the SCS/AS of the successful group processing request in the HTTP response message. + +If the SCEF receives a response with an error code from the HSS, the SCEF shall not create or update the resource and shall respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +Upon receipt of the processing result of the individual UEs from the HSS, the SCEF shall send an HTTP POST request message with a reference to the related network parameter configuration and a list of processing result for the group members to the SCS/AS. + +The SCS/AS shall send an HTTP response to acknowledge the SCEF about the handling result of the received request. + +#### 4.4.12.4 Notification of applied parameter configuration + +If the Enhanced\_param\_config feature is supported and the SCEF receives currently applied parameter configuration from the HSS, the SCEF shall notify the SCS/AS by the HTTP POST message including the parameter changes in the "appliedParam" attribute. + +### 4.4.13 Procedures for setting up an AS session with required QoS + +This procedure is used to set up an AS session with required QoS for the service as defined in 3GPP TS 23.682 [2]. + +For initial AS session creation, the SCS/AS shall send an HTTP POST message to the SCEF for the "AS Session with Required QoS Subscriptions" resource. The body of HTTP POST message shall include SCS/AS Identifier, UE IP address, IP Flow description, QoS reference and notification destination address. And it may also include time period and/or traffic volume for sponsored data connectivity purpose. If the feature AppId is supported, either the Flow description or an external Application Identifier shall be included. + +After receiving the HTTP POST message, the SCEF shall authorize the request and may check if the total number of requested QoS reference has exceeded the limit for the SCS/AS. If the authorization is successful, the SCEF shall map the SCS/AS Identifier to AF Application Identifier if the external Application Identifier is not provided and only one AF Application Identifier is mapped, and if required, map the SCS/AS Identifier to ASP Identity and Sponsor Identity. + +NOTE 1: Before the QoS reference is mapped to Rx parameters, the SCEF can perform a mapping from the name space of the 3rd party SCS/AS to the name space of the operator. + +NOTE 2: The QoS reference referring to pre-defined QoS information in the SCEF can be mapped to media component descriptions (e.g. bandwidth, media type) according to SLA. + +If the authorization performed by the SCEF is successful, then the SCEF shall act as an AF to interact with the PCRF via the Rx interface as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13] and trigger a PCRF initiated IP-CAN Session Modification. Based on local configuration, the SCEF may also request to be notified about the transmission resource status, i.e. INDICATION\_OF\_SUCCESSFUL\_RESOURCES\_ALLOCATION, INDICATION\_OF\_RELEASE\_OF\_BEARER, INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION, and optionally INDICATION\_OF\_LOSS\_OF\_BEARER and INDICATION\_OF\_RECOVERY\_OF\_BEARER. If the time + +period and/or traffic volume are received from the AF, the SCEF should subscribe to the PCRF on the USAGE\_REPORT event. + +If the "enNB" feature is supported, the SCEF may explicitly receive a list of user plane event(s) that the SCS/AS requests to subscribe to. The SCEF shall subscribe to the corresponding PCRF event(s) (e.g. INDICATION\_OF\_SUCCESSFUL\_RESOURCE\_ALLOCATION) for the received event(s) (e.g. SUCCESSFUL\_RESOURCES\_ALLOCATION), except for the SESSION\_TERMINATION event. + +NOTE 3: The PCRF does not need explicit subscription in order to notify Rx session termination. + +The SCEF, after receiving the AAA message or HTTP 201 Created message over the Rx interface from the PCRF with successful result code, shall create a resource "Individual AS Session with Required QoS Subscription" which represents AS session, addressed by a URI that contains the SCS/AS identity and an SCEF-created AS session identifier, and shall respond to the SCS/AS with a 201 Created message, including the result in the body of the HTTP response and a Location header field containing the URI for the created resource. The SCS/AS shall use the URI received in the Location header in subsequent requests to the SCEF to refer to this AS session. Otherwise, the SCEF shall send an HTTP response to the SCS/AS with a corresponding status code and include the result in the body of the HTTP response. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not create the resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +In order to update the established AS session, the SCS/AS may send an HTTP PUT message to the SCEF for the "Individual AS Session with Required QoS Subscription" resource requesting to replace all properties (e.g. new usage threshold, Flow Description or external Application Identifier) in the existing resource, addressed by the URI received in the response to the request that has created the resource. The UE IP or MAC address shall remain unchanged from previously provided values. After receiving such message, the SCEF shall make the change (e.g. if the usage threshold within the "usageThreshold" attribute is included in the HTTP PUT request and the accumulated usage report for the previously provided usage threshold is not received yet, the SCEF shall completely replace the previously provided one), and interact with the PCRF to modify the Rx session (as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13]). After receiving the response with successful result code from the PCRF, the SCEF shall replace all properties of the existing resource, send an HTTP response to the SCS/AS with a "200 OK" status code, and include the result in the body of the HTTP response or a "204 No Content" status code. If the SCEF receives a response with an error code from the PCRF, the SCEF shall not update the resource and respond to the SCS/AS with a corresponding failure code as described in clause 5.2.6. + +The SCS/AS may also send an HTTP PATCH message to the SCEF for the "Individual AS Session with Required QoS Subscription" resource requesting to change some created properties (e.g. new usage threshold, Flow Description or external Application Identifier, updated list of user plane event(s) if the "enNB" feature is supported). After receiving the HTTP PATCH message, the SCEF shall make the change (e.g. if the usage threshold within the "usageThreshold" attribute is included in the HTTP PATCH request and the accumulated usage report for the previously provided usage threshold is not received yet, the SCEF shall completely replace the previously provided one), and interact with the PCRF to modify the Rx session (as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13]). After receiving the response from the PCRF, the SCEF shall send an HTTP response to the SCS/AS with a "200 OK" status code and include the result in the body of the HTTP response, or a "204 No Content" status code. + +NOTE 4: The SCS/AS can assume a successful resource allocation upon receipt of the POST/PUT/PATCH response, until the FAILED\_RESOURCES\_ALLOCATION event is received. + +NOTE 5: The SCS/AS can update the list of user plane event(s) only for one time specific events, i.e. INDICATION\_OF\_SUCCESSFUL\_RESOURCES\_ALLOCATION, INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION and USAGE\_REPORT events, as specified in clause 5.3.13 of 3GPP TS 29.214 [10]. + +If the SCEF receives a traffic plane notification (e.g. the usage threshold is reached or transmission resource lost), or if the SCEF gets informed that the Rx session is terminated (e.g. due to a release of PDN connection), the SCEF shall send an HTTP POST message including the notified event (e.g. session terminated) and the accumulated usage (if received from the PCRF) to the callback URI "notificationUri" provided by the SCS/AS during the creation of individual AS Session with Required QoS Subscription. The SCS/AS shall respond with an HTTP response to confirm the received notification. + +In order to remove the established AS session, the SCS/AS shall send an HTTP DELETE message to the SCEF for the "Individual AS Session with Required QoS Subscription" resource. After receiving the HTTP DELETE message, the SCEF shall remove all properties and interact with the PCRF to terminate the Rx session (as defined in 3GPP TS 29.214 [10] or 3GPP TS 29.201 [13]). After receiving the response from the PCRF, the SCEF shall send an + +HTTP response to the SCS/AS with a corresponding status code and include the accumulated usage (if received from the PCRF). + +## 4.4.14 Procedures for MSISDN-less Mobile Originated SMS + +### 4.4.14.1 General + +The procedures are used by the SCEF to send the MSISDN-less MO-SMS to the SCS/AS via T8 interface. + +### 4.4.14.2 Delivery of MSISDN-less MO SMS + +If the SCEF receives an MSISDN-less MO-SMS via T4 including an destination SME address (long/short code of the SCS/AS), the SCEF will use the IMSI of the UE and application port ID received over T4 to query the HSS/HLR for an external ID, and the SCEF shall then determine the notification destination URL of an SCS/AS based on configured information on the mapping of SME addresses to destination URLs. The SCEF shall send to the determined destination URL an HTTP POST request that shall include an MsisdnLessMoSmsNotification data type with: + +- the short message transfer protocol data unit as received on the T4 interface. +- the Application Port as received on the T4 interface, and +- the external identifier of the UE that send the SMS, as received from the HSS/HLR. + +NOTE: The Notification Delivery using Websocket (see clause 5.2.5.4) and the Notification Test Event (see clause 5.2.5.3) are not supported for the present API. + +## 4.4.15 Procedures for RACS Parameter Provisioning + +The procedures are used by an SCS/AS to request that the network to provision manufacturer specific UE radio capability information. + +In order to create a new parameter provisioning, the SCS/AS shall send an HTTP POST request message to the SCEF to the resource "RACS Parameter Provisionings". The body of the HTTP POST request message shall include a list of RACS IDs, and for each provided RACS ID, its radio capability parameters and the related UE model(s) IMEI-TAC value(s). + +In order to fully replace an existing RACS Parameter Provisioning, the SCS/AS may send an HTTP PUT message to the resource "Individual RACS Parameter Provisioning" requesting the SCEF to change all properties in the existing resource. The body of the HTTP PUT request message shall include a list of RACS IDs, and for each provided RACS ID, its radio capability parameters and the related UE model(s) IMEI-TAC value(s). + +In order to partial update an existing RACS Parameter Provisioning, the SCS/AS may send an HTTP PATCH message to the resource "Individual RACS Parameter Provisioning" requesting the SCEF to change some properties in the existing resource. + +Upon receipt of the HTTP POST, PUT or PATCH message, if the SCS/AS is authorized to perform the request, the SCEF shall interact with the UCMF as described in 3GPP TS 29.675 [61]. After receiving the response from the UCMF, if at least one RACS ID is successfully provisioned, the SCEF shall create or update the resource "Individual RACS Parameter Provisioning" and respond with 201 Created or 200 OK to the SCS/AS respectively with the successfully provisioned RACS information or 204 No Content if the updates or replacement is successful with no content in the PATCH or PUT response message body, the SCEF may include RACS report(s) within attribute "racsReports" with a list of RACS ID(s) and the corresponding failure code for which the provisioning has failed as specified in table 5.16.2.2.3-1 in the body of the HTTP response. Otherwise, the SCEF shall send an HTTP response to the SCS/AS with a corresponding failure code as described in clause 5.16.5. If all the RACS IDs failed to be provisioned successfully, the SCEF may send a "500 Internal Server Error" HTTP response and may include in the response body failure reports as specified in clause 5.16.3. + +In order to delete an existing RACS Parameter Provisioning at the SCEF, the SCS/AS shall send an HTTP DELETE message to the corresponding resource "Individual RACS Parameter Provisioning" at the SCEF. Upon receipt of the DELETE request message, the SCEF shall interact with the UCMF as described in 3GPP TS 29.675 [61]. After receiving the response from the UCMF, the SCEF shall remove the resource and respond with 204 No Content to the SCS/AS. + +## 5 T8 APIs + +### 5.1 Introduction + +The T8 APIs are a set of APIs defining the related procedures and resources for the interaction between the SCEF and the SCS/AS. + +Tables 5.1-1 summarizes the APIs defined in this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause defined | Description | OpenAPI Specification File | API Name | Annex | +|---------------------------|----------------|--------------------------------------------------------------|----------------------------------------|--------------------------------------|-------| +| MonitoringEvent | 5.3 | Event Monitoring API | TS29122_MonitoringEvent.yaml | 3gpp-monitoring-event | A.3 | +| ResourceManagementOfBdt | 5.4 | Resource Management of Background Data Transfer (BDT) API | TS29122_ResourceManagementOfBdt.yaml | 3gpp-bdt | A.4 | +| ChargeableParty | 5.5 | Chargeable Party API | TS29122_ChargeableParty.yaml | 3gpp-chargeable-party | A.5 | +| NIDD | 5.6 | Non-IP Data Delivery (NIDD) API | TS29122_NIDD.yaml | 3gpp-nidd | A.6 | +| DeviceTriggering | 5.7 | Device Triggering API | TS29122_DeviceTriggering.yaml | 3gpp-device-triggering | A.7 | +| GMDviaMBMSbyMB2 | 5.8.2 | Group Message Delivery via MBMS by MB2 API | TS29122_GMDviaMBMSbyMB2.yaml | 3gpp-group-message-delivery-mb2 | A.8.1 | +| GMDviaMBMSbyxMB | 5.8.3 | Group Message Delivery via MBMS by xMB | TS29122_GMDviaMBMSbyxMB.yaml | 3gpp-group-message-delivery-xmb | A.8.2 | +| ReportingNetworkStatus | 5.9 | Network Status Reporting API | TS29122_ReportingNetworkStatus.yaml | 3gpp-network-status-reporting | A.9 | +| CpProvisioning | 5.10 | Communication Patterns (CP) Parameters Provisioning API | TS29122_CpProvisioning.yaml | 3gpp-cp-parameter-provisioning | A.10 | +| PfdManagement | 5.11 | Packet Flow Description (PFD) Management API | TS29122_PfdManagement.yaml | 3gpp-pfd-management | A.11 | +| ECRControl | 5.12 | Enhanced Coverage Restriction Control API | TS29122_ECRControl.yaml | 3gpp-ecr-control | A.12 | +| NpConfiguration | 5.13 | Network Parameter Configuration API | TS29122_NpConfiguration.yaml | 3gpp-network-parameter-configuration | A.13 | +| AsSessionWithQoS | 5.14 | Application Server (AS) Session with QoS API | TS29122_AsSessionWithQoS.yaml | 3gpp-as-session-with-qos | A.14 | +| MsisdnLessMoSms | 5.15 | MSISDN-less Mobile-Originated SMS API | TS29122_MsisdnLessMoSms.yaml | 3gpp-msisdn-less-mo-sms | A.15 | +| RacsParameterProvisioning | 5.16 | RACS (Radio Capability Signaling) Parameter Provisioning API | TS29122_RacsParameterProvisioning.yaml | 3gpp-racs-parameter-provisioning | A.16 | + +## 5.2 Information applicable to several APIs + +### 5.2.1 Data Types + +#### 5.2.1.1 Introduction + +This clause defines structured data types, simple data types and enumerations that are applicable to several APIs defined in the present specification and can be referenced from data structures defined in the subsequent clauses. In addition, data types that are defined in OpenAPI Specification [27] can also be referenced from data structures defined in the subsequent clauses. + +NOTE: As a convention, data types in the present specification are written with an upper-case letter in the beginning. Parameters are written with a lower-case letter in the beginning. As an exception, data types that are also defined in OpenAPI Specification [27] can use a lower-case case letter in the beginning for consistency. + +Table 5.2.1.1-1 lists these common data types. + +**Table 5.2.1.1-1: Common Data Types applicable to several T8 APIs** + +| Data type | Section defined | Description | Applicability | +|------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AccumulatedUsage | 5.2.1.2.7 | Represents an accumulated usage. | | +| Acknowledgement | 5.2.1.2.4 | Represents a successful acknowledgement of a notification. | | +| Bandwidth | 5.2.1.3.2 | Represents an integer indicating a bandwidth in bits per second. | | +| BdtReferenceId | 5.2.1.3.2 | Represents a BDT Reference ID. | | +| Binary | 5.2.1.3.2 | String with format "binary" as defined in the OpenAPI Specification. | | +| Bytes | 5.2.1.3.2 | String with format "byte" as defined in the OpenAPI Specification. | | +| ConfigResult | 5.2.1.2.15 | Represents one configuration processing result for a group's members. | | +| DateTime | 5.2.1.3.2 | String with format "date-time" as defined in OpenAPI Specification. | | +| DateTimeRm | 5.2.1.3.2 | Represents the same as the DateTime data type, but with the "nullable: true" property. | | +| DateTimeRo | 5.2.1.3.2 | Represents the same as the DateTime data type, but with the "readOnly=true" property. | | +| DayOfWeek | 5.2.1.3.2 | Integer between 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday. | | +| DurationMin | 5.2.1.3.2 | Unsigned integer identifying a period of time in units of minutes. | | +| DurationSec | 5.2.1.3.2 | Unsigned integer identifying a period of time in units of seconds. | | +| DurationSecRm | 5.2.1.3.2 | Represents the same as the DurationSec data type, but with the "nullable: true" property. | | +| DurationSecRo | 5.2.1.3.2 | Represents the same as the DurationSec data type, but with the "readOnly=true" property. | | +| Event | 5.2.1.3.3 | Represents a bearer event. | | +| EventReport | 5.2.1.2.6 | Represents an event report. | | +| EthFlowInfo | 5.2.1.2.18 | Represents flow Ethernet flow information | | +| ExternalGroupId | 5.2.1.3.2 | Represents an external group identifier. | | +| ExternalId | 5.2.1.3.2 | Represents an external identifier. | | +| FlowInfo | 5.2.1.2.8 | Represents IP flow information. | | +| InvalidParam | 5.2.1.2.13 | Represents the description of invalid parameters, for a request rejected due to invalid parameters. | | +| Ipv4Addr | 5.2.1.3.2 | Represents an IPv4 address. | | +| Ipv4AddrRo | 5.2.1.3.2 | Represents the same as the Ipv4Addr data type, but with the "readOnly=true" property. | | +| Ipv6Addr | 5.2.1.3.2 | Represents an IPv6 address. | | +| Ipv6AddrRo | 5.2.1.3.2 | Represents the same as the Ipv6Addr data type, but with the "readOnly=true" property. | | +| Link | 5.2.1.3.2 | Represents a link towards a referenced resource. | | +| LinkRm | 5.2.1.3.2 | Represents the same as the Link data type, but with the "nullable: true" property. | | +| LocationArea | 5.2.1.2.11 | Represents a user location area. | | +| LocationArea5G | 5.2.1.2.17 | Represents a user location area when the UE is attached to 5G. | | +| Mcc | 5.2.1.3.2 | Represents a Mobile Country Code. | | +| Mnc | 5.2.1.3.2 | Represents a Mobile Network Code. | | +| Msisdn | 5.2.1.3.2 | Represents an MSISDN. | | +| NotificationData | 5.2.1.2.5 | Represents the information to be conveyed in a bearer level event(s) notification. | | +| PlmnId | 5.2.1.2.14 | Represents the identifier of a PLMN. | | +| Port | 5.2.1.3.2 | Unsigned integer with valid values between 0 and 65535 representing a port. | | +| PortRo | 5.2.1.3.2 | Represents the same as the Port data type, but with the "readOnly=true" property. | | +| ProblemDetails | 5.2.1.2.12 | Represents additional information and details on an error response. | | +| ResourceId | 5.2.1.3.2 | Represents an identifier of a resource within a resource URI. | | + +| | | | | +|--------------------|------------|---------------------------------------------------------------------------------------------------|--| +| ResultReason | 5.2.1.3.4 | Represents a failure result reason. | | +| ScsAsId | 5.2.1.3.2 | Represents an SCS/AS identifier. | | +| SponsorInformation | 5.2.1.2.1 | Represents a sponsor information. | | +| TestNotification | 5.2.1.2.9 | Represents a notification that can be sent to test whether a chosen notification mechanism works. | | +| TimeOfDay | 5.2.1.3.2 | Represents a time in a day. | | +| TimeWindow | 5.2.1.2.3 | Represents a time window identified by a start time and a stop time. | | +| Uri | 5.2.1.3.2 | Represents a URI. | | +| UsageThreshold | 5.2.1.2.2 | Represents a usage threshold. | | +| UsageThresholdRm | 5.2.1.2.16 | Represents the same as the UsageThreshold data type but with the "nullable: true" property. | | +| Volume | 5.2.1.3.2 | Unsigned integer identifying a volume in units of bytes. | | +| VolumeRm | 5.2.1.3.2 | Represents the same as the Volume data type, but with the "nullable: true" property. | | +| WebsockNotifConfig | 5.2.1.2.10 | Represents the configuration information for the delivery of notifications over Websockets. | | + +## 5.2.1.2 Referenced structured data types + +### 5.2.1.2.1 Type: SponsorInformation + +This type represents a sponsor information. It shall comply with the provisions defined in table 5.2.1.2.1-1. + +**Table 5.2.1.2.1-1: Definition of the SponsorInformation data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|-----------------------------------------------| +| sponsorId | string | 1 | It indicates Sponsor ID. | +| aspId | string | 1 | It indicates Application Service Provider ID. | + +### 5.2.1.2.2 Type: UsageThreshold + +This type represents a usage threshold. It shall comply with the provisions defined in table 5.2.1.2.2-1. + +Only one of DownlinkVolume, UplinkVolume and TotalVolume shall be provided. If the server supports both duration and volume, then the first threshold that has been reached will apply. + +**Table 5.2.1.2.2-1: Definition of the UsageThreshold data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-------------|-------------|------------------------------------------------| +| duration | DurationSec | 0..1 | Indicates the length of time in seconds | +| totalVolume | Volume | 0..1 | Total data octets for both downlink and uplink | +| downlinkVolume | Volume | 0..1 | Downlink data octets | +| uplinkVolume | Volume | 0..1 | Uplink data octets | + +### 5.2.1.2.3 Type: TimeWindow + +This type represents a start time and a stop time of a time window. It shall comply with the provisions defined in table 5.2.1.2.3-1. + +**Table 5.2.1.2.3-1: Definition of the TimeWindow data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|------------------------------------------------------| +| startTime | DateTime | 1 | Indicates the absolute start time of the time window | +| stopTime | DateTime | 1 | Indicates the absolute stop time of the time window | + +#### 5.2.1.2.4 Type: Acknowledgement + +This type represents a successful acknowledgement for a notification. + +**Table 5.2.1.2.4-1: Definition of the Acknowledgement data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|--------------------------------------------------------------------------| +| details | string | 1 | A human-readable explanation specific to this successful acknowledgement | + +#### 5.2.1.2.5 Type: NotificationData + +This type represents the parameters which shall be notify the SCS/AS for bearer level event(s). + +**Table 5.2.1.2.5-1: Definition of the NotificationData data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|--------------------|-------------|-------------------------------------------------------------------------| +| transaction | Link | 1 | Link to the transaction resource to which this notification is related. | +| eventReports | array(EventReport) | 1..N | Contains the reported event and applicable information | + +#### 5.2.1.2.6 Type: EventReport + +This type represents an event report. It shall comply with the provisions defined in table 5.2.1.2.6-1. + +**Table 5.2.1.2.6-1: Definition of the EventReport data type** + +| Attribute name | Data type | Cardinality | Description | +|------------------|------------------|-------------|------------------------------------------------------------------| +| event | Event | 1 | Indicates the event reported by the SCEF. | +| accumulatedUsage | AccumulatedUsage | 0..1 | Contains the applicable information corresponding to the event. | +| flowIds | array(integer) | 0..N | Identifies the IP flows that were sent during event subscription | + +#### 5.2.1.2.7 Type: AccumulatedUsage + +This type represents an accumulated usage. It shall comply with the provisions defined in table 5.2.1.2.7-1. + +**Table 5.2.1.2.7-1: Definition of the AccumulatedUsage data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-------------|-------------|------------------------------------------------| +| duration | DurationSec | 0..1 | Indicates the length of time in seconds | +| totalVolume | Volume | 0..1 | Total data octets for both downlink and uplink | +| downlinkVolume | Volume | 0..1 | Downlink data octets | +| uplinkVolume | Volume | 0..1 | Uplink data octets | + +#### 5.2.1.2.8 Type: FlowInfo + +This type represents flow information. It shall comply with the provisions defined in table 5.2.1.2.8-1. + +**Table 5.2.1.2.8-1: Definition of the FlowInfo data type** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|------------------|-------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowId | integer | 1 | Indicates the IP flow. | | +| flowDescriptions | array(string) | 0..2 | Indicates the packet filters of the IP flow.
Refer to clause 5.3.8 of 3GPP TS 29.214 [10] for encoding. It shall contain UL and/or DL IP flow description. | | +| tosTC | TosTrafficClasses | 0..1 | Type of service or Traffic Class. | | + +NOTE: The "tosTC" attribute can be included when another packet filter attribute is needed to differentiate between packet flows. For example, packet flows encapsulated and encrypted by a tunnelling protocol can be differentiated by the ToS/TC value of the outer header if appropriately set by the application. To use ToS/TC for service data flow detection, network configuration by the operator (and additionally by the 3rd party Service Provider when the transport network is not fully within the operator control) needs to ensure there is no ToS/TC re-marking applied along the path from the application to the PSA UPF and the specific ToS/TC values are managed properly to avoid potential collision with other usage (e.g., paging policy differentiation). + +#### 5.2.1.2.9 Type: TestNotification + +This type represents a notification that can be sent to test whether a chosen notification mechanism works. It shall be supported if the feature "Notification\_test\_event", as defined for APIs that use notifications, is supported. + +**Table 5.2.1.2.9-1: Definition of the TestNotification data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|-------------------------------------------------------------------------| +| subscription | Link | 1 | Link of the subscription resource to which the notification is related. | + +#### 5.2.1.2.10 Type: WebsockNotifConfig + +This type represents configuration for the delivery of notifications over Websockets. It shall be supported if the feature "Notification\_websocket", as defined for APIs that use notifications, is supported. + +**Table 5.2.1.2.10-1: Definition of the WebsockNotifConfig data type** + +| Attribute name | Data type | Cardinality | Description | +|---------------------|-----------|-------------|------------------------------------------------------------------------------------------------------------------| +| websocketUri | Link | 0..1 | Set by the SCEF to indicate to the SCS/AS the Websocket URI to be used for delivering notifications.
(NOTE 1) | +| requestWebsocketUri | boolean | 0..1 | Set by the SCS/AS to indicate that the Websocket delivery is requested.
(NOTE 2) | + +NOTE 1: A Websocket URI should use the scheme "wss" (Websocket Secure) for encrypted delivery and may use the scheme "ws" (Websocket) for unencrypted delivery. If the WebsockNotifConfig data type is used in an HTTP response, this attribute shall be present. If the WebsockNotifConfig data type is used in an HTTP request, this attribute shall not be set by the SCS/AS in a request to create a resource, and shall not be modified by the SCS/AS in a request to modify a resource. + +NOTE 2: In a request to create or update a resource, this attribute shall be set to true by the SCS/AS to request the SCEF to provide a Websocket URI for the delivery of notifications, and shall be absent otherwise. In any HTTP response, this attribute shall retain the value that was provided upon resource creation or update. + +#### 5.2.1.2.11 Type: LocationArea + +This data type represents the user location area which is sent from the SCS/AS to the SCEF. + +**Table 5.2.1.2.11-1: Definition of the LocationArea data Type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------|-----------------------|-------------|--------------------------------------------------------------------------------------------------------| +| cellIds | array(string) | 0..N | Indicates a list of Cell Global Identities of the user which identifies the cell the UE is registered. | +| enodeBIds | array(string) | 0..N | Indicates a list of eNodeB identities in which the UE is currently located. | +| routingAreaIds | array(string) | 0..N | Identifies a list of Routing Area Identities of the user where the UE is located. | +| trackingAreaIds | array(string) | 0..N | Identifies a list of Tracking Area Identities of the user where the UE is located. | +| geographicAreas | array(GeographicArea) | 0..N | Identifies a list of geographic area of the user where the UE is located. | +| civicAddresses | array(CivicAddress) | 0..N | Identifies a list of civic addresses of the user where the UE is located. | + +#### 5.2.1.2.12 Type: ProblemDetails + +**Table 5.2.1.2.12-1: Definition of the ProblemDetails data type** + +| Attribute name | Data type | Cardinality | Description | +|-------------------|---------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| type | Uri | 0..1 | A URI reference according to IETF RFC 3986 [6] that identifies the problem type. | +| title | string | 0..1 | A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem. | +| status | integer | 0..1 | The HTTP status code for this occurrence of the problem. | +| detail | string | 0..1 | A human-readable explanation specific to this occurrence of the problem. | +| instance | Uri | 0..1 | A URI reference that identifies the specific occurrence of the problem. | +| cause | string | 0..1 | A machine-readable application error cause specific to this occurrence of the problem. This IE should be present and provide application-related error information, if available. | +| invalidParams | array(InvalidParam) | 0..N | Description of invalid parameters, for a request rejected due to invalid parameters. | +| supportedFeatures | SupportedFeatures | 0..1 | Features supported by the server (SCEF or SCS/AS).

When present, this IE shall indicate the features supported by the server; if the server supports no features, this IE shall be set to the character "0". | + +NOTE 1: See IETF RFC 9457 [8] for detailed information and guidance for each attribute. +NOTE 2: Additional attributes may be defined per API. + +#### 5.2.1.2.13 Type: InvalidParam + +**Table 5.2.1.2.13-1: Definition of the InvalidParam data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|---------------------------------------------------------------| +| param | string | 1 | Attribute's name encoded as a JSON Pointer, or header's name. | +| reason | string | 0..1 | A human-readable reason, e.g. "must be a positive integer". | + +## 5.2.1.2.14 Type: PlmnId + +**Table 5.2.1.2.14-1: Definition of the PlmnId data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|---------------------| +| mcc | Mcc | 1 | Mobile Country Code | +| mnc | Mnc | 1 | Mobile Network Code | + +## 5.2.1.2.15 Type: ConfigResult + +This type represents one configuration processing result for the group members. + +**Table 5.2.1.2.15-1: Definition of the ConfigResult data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-------------------|-------------|-----------------------------------------------------------------------------------------| +| externalIds | array(ExternalId) | 0..N | Each element indicates an external identifier of the UE.
(NOTE) | +| msisdns | array(Msisdn) | 0..N | Each element identifies the MS internal PSTN/ISDN number allocated for the UE
(NOTE) | +| resultReason | ResultReason | 1 | Identifies the configuration failure reason for the group members. | + +NOTE: Either "externalId" or "msisdn" shall be included for a group member. + +## 5.2.1.2.16 Type: UsageThresholdRm + +This type represents a usage threshold which is defined in clause 5.2.1.2.2 but defined with "nullable: true" property so it can be removed in "JSON Merge Patch", as defined in IETF RFC 7396 [39]. It shall comply with the provisions defined in table 5.2.1.2.16-1. + +Only one of "downlinkVolume", "uplinkVolume" and "totalVolume" shall be provided. Duration and volume are also removable in "JSON Merge Patch". If the server supports both duration and volume, then the first threshold that has been reached will apply. + +**Table 5.2.1.2.16-1: Definition of the UsageThresholdRm data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|---------------|-------------|------------------------------------------------| +| duration | DurationSecRm | 0..1 | Indicates the length of time in seconds | +| totalVolume | VolumeRm | 0..1 | Total data octets for both downlink and uplink | +| downlinkVolume | VolumeRm | 0..1 | Downlink data octets | +| uplinkVolume | VolumeRm | 0..1 | Uplink data octets | + +## 5.2.1.2.17 Type: LocationArea5G + +This data type represents the user location area which is sent from the AF to the NEF. + +**Table 5.2.1.2.17-1: Definition of the LocationArea5G data Type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------|-----------------------|-------------|--------------------------------------------------------------------------------------| +| geographicAreas | array(GeographicArea) | 0..N | Identifies a list of geographic area of the user where the UE is located. | +| civicAddresses | array(CivicAddress) | 0..N | Identifies a list of civic addresses of the user where the UE is located. | +| nwAreaInfo | NetworkAreaInfo | 0..1 | This IE represents the network area information of the user where the UE is located. | + +### 5.2.1.2.18 Type: EthFlowInfo + +This type represents Ethernet flow information. It shall comply with the provisions defined in table 5.2.1.2.18-1. + +**Table 5.2.1.2.18-1: Definition of the EthFlowInfo data type** + +| Attribute name | Data type | Cardinality | Description | +|---------------------|---------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| flowId | integer | 1 | Indicates the Ethernet flow. | +| ethFlowDescriptions | array(EthFlowDescription) | 0..2 | Indicates the packet filters of the Ethernet flow.
Refer to clause 5.6.2.17 of 3GPP TS 29.514 [52] for encoding of each Ethernet flow. It shall contain UL and/or DL Ethernet flow description. | + +### 5.2.1.3 Referenced Simple data types and enumerations + +#### 5.2.1.3.1 Introduction + +This clause defines simple data types and enumerations that are referenced from data structures. + +#### 5.2.1.3.2 Simple data types + +The reused datatypes defined in OpenAPI Specification [27] listed in table 5.2.1.3.2-1 and the simple data types defined in table 5.2.1.3.2-2 apply to several T8 APIs. + +**Table 5.2.1.3.2-1: Reused OpenAPI data types** + +| Type name | Description | +|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| boolean | As defined in OpenAPI Specification [27], i.e. either value "true" or value "false" as defined in IETF RFC 7159 [5]. | +| integer | As defined in OpenAPI Specification [27]. | +| number | As defined in OpenAPI Specification [27]. | +| string | As defined in OpenAPI Specification [27]. | +| NOTE: | Data type names defined in OpenAPI Specification [27] do not follow the convention to start with capital letters otherwise used in this specification. | + +**Table 5.2.1.3.2-2: Simple data types applicable to several APIs** + +| Type name | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Bandwidth | Integer indicating a bandwidth in bits per second. | +| BdtReferenceId | String identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS 29.154 [9]. | +| Binary | String with format "binary" as defined in OpenAPI Specification [27]. | +| Bytes | String with format "byte" as defined in OpenAPI Specification [27], i.e, base64-encoded characters. | +| DayOfWeek | Integer between and including 1 and 7 denoting a weekday. "1" shall indicate "Monday", and the subsequent weekdays shall be indicated with the next higher numbers. "7" shall indicate "Sunday". | +| DateTime | String with format "date-time" as defined in OpenAPI Specification [27]. | +| DateTimeRm | String with format "date-time" as defined in OpenAPI [27] with "nullable: true" property. | +| DateTimeRo | String with format "date-time" as defined in OpenAPI [27] with "readOnly: true" property. | +| DurationSec | Unsigned integer identifying a period of time in units of seconds. | +| DurationSecRm | Unsigned integer identifying a period of time in units of seconds with "nullable: true" property. | +| DurationSecRo | Unsigned integer identifying a period of time in units of seconds with "readOnly: true" property. | +| DurationMin | Unsigned integer identifying a period of time in units of minutes. | +| ExternalId | String containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See clause 4.6.2 of 3GPP TS 23.682 [2] for more information. | +| ExternalGroupId | String containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 [2] for more information. | +| Ipv4Addr | String identifying an Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [28]. | +| Ipv6Addr | String identifying an Ipv6 address formatted according to clause 4 in IETF RFC 5952 [29]. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 [29] shall not be used. | +| Ipv4AddrRo | String identifying an Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [28], with "readOnly: true" property. | +| Ipv6AddrRo | String identifying an Ipv6 address formatted according to clause 4 in IETF RFC 5952 [29], with "readOnly: true" property. The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 [29] shall not be used. | +| Link | String formatted according to IETF RFC 3986 [7] identifying a referenced resource. | +| LinkRm | String formatted according to IETF RFC 3986 [7] identifying a referenced resource, but with the "nullable: true" property. | +| Mcc | String encoding a Mobile Country Code part of the PLMN, comprising 3 digits, as defined in 3GPP TS 38.413 [54]. | +| Mnc | String encoding a Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in 3GPP TS 38.413 [54]. | +| Msisdn | String formatted according to clause 3.3 of 3GPP TS 23.003 [14] that describes an MSISDN. | +| Port | Unsigned integer with valid values between 0 and 65535. | +| PortRo | Unsigned integer with valid values between 0 and 65535, with "readOnly: true" property. | +| ResourceId | String chosen by the SCEF to serve as an identifier in a resource URI. | +| ScsAsId | String that identifies an SCS/AS. | +| TimeOfDay | String with format "partial-time" or "full-time" as defined in clause 5.6 of IETF RFC 3339 [15]. Examples: "20:15:00", "20:15:00-08:00" (for 8 hours behind UTC). | +| Uri | String providing an URI formatted according to IETF RFC 3986 [7]. | +| Volume | Unsigned integer identifying a volume in units of bytes. | +| VolumeRm | Unsigned integer identifying a volume in units of bytes with "nullable: true" property. | + +### 5.2.1.3.3 Enumeration: Event + +The enumeration Event represents event reported by the SCEF. + +**Table 5.2.1.3.3-1: Enumeration Event** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| SESSION_TERMINATION | Indicates that Rx session is terminated. | +| LOSS_OF_BEARER | Indicates a loss of a bearer. (NOTE 2) | +| RECOVERY_OF_BEARER | Indicates a recovery of a bearer. (NOTE 2) | +| RELEASE_OF_BEARER | Indicates a release of a bearer. (NOTE 2) | +| USAGE_REPORT | Indicates the usage report event. | +| FAILED_RESOURCES_ALLOCATION | Indicates the resource allocation is failed. | +| SUCCESSFUL_RESOURCES_ALLOCATION | Indicates the resource allocation is successful. | +| NOTE 1: The "enNB" feature defined in clause 5.5.4 supports both subscription and notification for SUCCESSFUL_RESOURCES_ALLOCATION event, and explicit subscription for all the events.
NOTE 2: The "LOSS_OF_BEARER", RECOVERY_OF_BEARER, and RELEASE_OF_BEARER only apply to 4G. | | + +#### 5.2.1.3.4 Enumeration: ResultReason + +The enumeration ResultReason represents a failure result reason. + +**Table 5.2.1.3.4-1: Enumeration ResultReason** + +| Enumeration value | Description | +|---------------------|---------------------------------------------------------------------------------| +| ROAMING_NOT_ALLOWED | Identifies the configuration parameters are not allowed by roaming agreement. | +| OTHER_REASON | Identifies the configuration parameters are not configured due to other reason. | + +#### 5.2.1.4 Conventions for documenting structured data types + +The structured data types shall represent an object (see IETF RFC 8259 [40]). The structured data types shall contain attributes that are simple data types, structured data types, arrays (see below), maps (see below) or enumerations. + +An array (see IETF RFC 8259 [40]) shall represent a list of values without keys and with significance in the order of sequence. All values shall be of the same type. + +A map shall represent an object (see IETF RFC 8259 [40]) with a list of key-value pairs (with no significance in the order of sequence), where all keys are of type string and shall be unique identifiers assigned by the application rather than by the schema, and where all values shall be of the same type. + +NOTE 1: Maps are supported by the OpenAPI specification [27] as described at . Maps can enable a faster lookup of elements identified by some key in huge data structures compared to arrays that contain the key within the elements. Maps can also be used instead of arrays to modify individual elements when modification instructions of the PATCH method are compliant to IETF RFC 7396 [39]. + +Each structured data type shall be specified in a separate clause as illustrated in table 5.2.1.4-1. + +**Table 5.2.1.4-1: Definition of type ** + +| Attribute name | Data type | Cardinality | Description | +|------------------|-------------------------------------------------------|----------------------------|----------------------| +| | "" or
"array()"
or
"map()" | "0..1", "1",
or "M..N", | | + +**Attribute name:** Name of attributes that belong to the specified data type. + +**Data type:** Data type of the attribute. If the data type is indicated as "", the attribute shall be of data type . If the data type is indicated as "array()", the attribute shall be an array (see IETF RFC 8259 [40]) that contains elements of data type . If the data type is indicated as "map()", the attribute shall be an object (see IETF RFC 8259 [40]) encoding a map (see OpenAPI specification [27]) that contains as values elements of data + +type . can either be "integer", "number", "string" or "boolean" (as defined in the OpenAPI specification [27]), or a data type defined in a 3GPP specification. + +**Cardinality:** Defines the allowed number of occurrence of data type . A cardinality of "M..N", is only allowed for data types "array()" and "map()" and indicates the number of elements within the array or map; the values M and N can either be the characters "M" and "N", respectively, or integer numbers with M being greater than or equal 0, and N being greater than 1 and M, For data type "", the cardinality shall be set to "0..1" or "1". A lower boundary of "0" for the cardinality also indicates that the attribute is optional. A lower boundary of "0" for the cardinality indicates that the attribute is optional. + +NOTE 2: The "0..N" implies the array or map type of the attribute may be optional. If the attribute is present, the minimum number of elements is described in openAPI file. + +**Description:** Describes the meaning and use of the attribute and may contain normative statements. + +## 5.2.2 Usage of HTTP + +### 5.2.2.1 General + +For T8 APIs, support of HTTP/1.1 (IETF RFC 9112 [16], IETF RFC 9110 [17], IETF RFC 9111 [20]) over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [22]) over TLS is recommended. TLS shall be used as specified in clause 5.5 of 3GPP TS 33.187 [35]. An SCS/AS desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 9113 [22]. + +### 5.2.2.2 Usage of the HTTP PATCH method + +The HTTP PATCH method, as defined in IETF RFC 5789 [38], allows for a partial update of previously sent data, e.g. resources. For a complete replacement of previously sent data, the HTTP PUT method is used. It is defined separately for each resource whether the HTTP PUT and/or the HTTP PATCH are applicable. + +If the HTTP PATCH method is used: + +- if no modification of individual elements within an array needs to be supported, the JSON bodies within the PATCH request shall be encoded according to "JSON Merge Patch", as defined in IETF RFC 7396 [39]; or +- if a modification of individual elements within an array needs to be supported, the "JSON Patch" encoding of changes defined in IETF RFC 6902 [67] shall be used. + +## 5.2.3 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [5]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [5]. + +JSON object used in the HTTP PATCH request shall be encoded according to: + +- "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [39]; or +- "JSON Patch" and shall be signalled by the content type "application/json-patch+json", as defined in IETF RFC 6902 [67]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [8]. + +NOTE: This release only supports the content type JSON. + +## 5.2.4 URI structure + +### 5.2.4.1 Resource URI structure + +Resources are either individual resources, or structured resources that can contain child resources. It is recommended to design each resource following one of the archetypes provided in the Annex C of 3GPP TS 29.501 [49]. + +All API URIs of T8 APIs shall be: + +**{apiRoot}//** + +"apiRoot" is configured by means outside the scope of the present document. "apiName" and "apiVersion" shall be set dependent on the API, as defined in the corresponding clauses below. All resource URIs in the clauses below are defined relative to the above root API URI. + +NOTE 1: The "apiVersion" will only be increased if the new API version contains not backward compatible changes. Otherwise, the supported feature mechanism defined in clause 5.2.7 can instead be used to negotiate extensions. + +NOTE 2: A different root structure can be used when the Resource URI is preconfigured in the SCS/AS. + +The root structure may be followed by "apiSpecificSuffixes" that are dependent on the API and are defined separately for each API as resource URI where they apply: + +**{apiRoot}///** + +The naming conventions defined in clause 5.1.3 of 3GPP TS 29.501 [49] shall apply. + +### 5.2.4.2 Custom operations URI structure + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}////** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}///** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificSuffixes" are as defined in clause 5.2.4.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2 of 3GPP TS 29.501 [49]. + +### 5.2.4.3 Callback URI structure + +The purpose of the callback URI is to enable an HTTP client (the SCS/AS or SCEF) to provide the URI to be used by an HTTP server (the SCEF or SCS/AS) to send notifications or callback requests. + +The callback URI shall be in the form of an absolute URI as defined in clause 4.3 of IETF RFC 3986 [7], including an authority, and excluding any query component, any fragment component and any userinfo subcomponent. + +Therefore, a callback URI consists of the following components, specified with ABNF syntax (see IETF RFC 5234 [69]): + +URI = scheme ":" "/" host [ ":" port ] / path + +Where 'host' is either an FQDN or an IP address and the 'path' is a path to an HTTP client (the SCS/AS or SCEF) resource. + +## 5.2.5 Notifications + +### 5.2.5.1 General + +The SCEF and SCS/AS shall support the delivery of Notifications using a separate HTTP connection towards an address assigned by the SCS/AS, as described in clause 5.2.5.2. + +An SCEF and SCS/AS may support testing a notification connection as described in clause 5.2.5.3. An SCEF and SCS/AS may support the delivery of Notification using Websocket (IETF RFC 6455 [32]) as described in clause 5.2.5.4. + +### 5.2.5.2 Notification Delivery using a separate HTTP connection + +If a delivery of notifications is required for an API, the SCS/AS shall provide a notification destination URI, which designates to the SCEF where the SCEF shall send the HTTP Notifications. This URI is provided within an attribute (e.g. "notificationDestination", "notifUri", "notificationUri") defined in the data types that are passed in a request to create a resource that represents a subscription to notifications, unless it is specified for that API that a preconfigured destination address is used. + +The SCS/AS may provide the same notification destination URI for several subscriptions, and the SCEF should then use the same HTTP connection to deliver related notifications. + +The SCEF shall take the role of the HTTP client on the HTTP connection for the delivery of Notifications. Clause 5.2.2 shall also apply for this HTTP connection with the exception that an SCEF (rather than an SCS/AS) desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version. + +### 5.2.5.3 Notification Test Event + +If the optional "Notification\_test\_event" feature is supported, the SCS/AS may test whether notifications can be received by subscribing to the notification of a test event by providing a "requestTestNotification" attribute set to "true" in the HTTP request to create or update a subscription for notifications. In any other HTTP request or response, this attribute shall retain the value that was provided upon subscription resource creation. + +Upon receiving the "requestTestNotification" attribute as part of a subscription creation or update request, the SCEF shall send immediately after establishing the notification delivery mechanism a test notification containing a body formatted according to the "TestNotification" data type as defined in clause 5.2.1.2.12. If the SCS/AS does not receive the test notification within a configured time, the SCS/AS knows that the notification delivery with the selected method is not possible and may take corrective actions. + +### 5.2.5.4 Notification Delivery using Websocket + +The procedures in the present clause only apply if SCS/AS and SCEF support the "Notification\_websocket" feature. If the feature "Notification\_websocket" is supported, then the feature "Notification\_test\_event" shall also be supported. + +If a delivery of notifications is required for an API and the SCS/AS does not know from previous interactions with the SCEF whether delivery of notifications over a separate HTTP connection works, the SCS/AS should initially request the SCEF to try to establish a separate HTTP connection for notification delivery according to clause 5.2.5.2 by providing a URI to the SCEF designating where to send HTTP Notifications, and shall also subscribe to the notification of a test event as in clause 5.2.5.3. + +If the SCS/AS does not receive the requested notification of the test event during a configured period after the subscription, the SCS/AS may configure the subscription to request the SCEF to provide a URI for an HTTP connection to upgrade to Websocket, setting the "requestWebsocketUri" attribute to "true" as specified in clause 5.2.1.2.13. The SCS/AS may also request the SCEF to provide a URI in a new subscription creation request, and should in this case terminate the original subscription. + +NOTE 1: If the SCS/AS has requested the delivery of notifications to a separate entity, it needs to be informed by that separate entity about the receipt of the test notification. That communication between the separate entity and the SCS/AS is out of scope of the present document. + +When the SCEF receives a subscription creation or update request to use Websockets to deliver notifications (i.e. with the "requestWebsocketUri" attribute set to "true"), it shall assign a Websocket URI where to receive a Websocket connection establishment and provide this URI in the "websocketUri" attribute in the response, as defined in clause 5.1.2.1.13. Once such Websocket URI has been assigned for a particular subscription resource, subsequent update requests to this resource that ask for the assignment of a new Websocket URI for that subscription shall be rejected by the SCEF. + +Upon the reception of the Websocket URI from the SCEF in the "websocketUri" attribute, as specified in clause 5.2.1.2.13-1, in the subscription creation or subscription update response, the SCS/AS or a separate entity that is intended to receive the notification shall establish an HTTP connection towards that URI and shall upgrade that connection to the Websocket protocol (IETF RFC 6455 [32]) using the HTTP upgrade mechanism defined in IETF RFC 9110 [17]. + +NOTE 2: For delivery of Notifications to a separate entity, the SCS/AS needs to provide the Websocket URI to that separate entity. That communication between the SCS/AS and the separate entity is out of scope of the present document. + +The following framing of the request and response shall be used when delivering a notification or acknowledging its delivery through Websockets. + +NOTE 3: The framing is aligned as much as possible with HTTP delivery in order to simplify implementations. + +To deliver a notification towards the SCS/AS, the SCEF shall embed the following structure in a separate Websocket data frame with 0x2 (Binary) opcode in the following order: + +- 1) The string "3GPP-WS-Notif-Seq:", followed by a blank, followed by a four-byte sequence number, encoded as decimal number in ASCII, followed by CRLF +- 2) The following HTTP headers in any order, with the syntax and semantics as defined in IETF RFC 9110 [17]: Content-Type (mandatory), Content-Encoding (optional), Content-Length (mandatory). Every HTTP header line shall be ended by CRLF. +- 3) CRLF to end the headers section. +- 4) The content of the notification, as defined in the individual APIs. + +NOTE 4: The content is the same as the one that would be used if delivering the notification as defined in clause 5.2.5.3. + +To acknowledge the reception of a notification message towards the SCEF, the SCS/AS shall embed the following structure in a separate Websocket data frame with 0x2 (Binary) opcode in the following order: + +- 1) The string "3GPP-WS-Notif-Seq:", followed by a blank, followed by the four-byte sequence number of the notification to be confirmed, encoded as decimal number in ASCII, followed by CRLF. +- 2) The HTTP status code (e.g. 204) and status message (e.g. No Content) as defined for HTTP delivery of the notification in the individual APIs, separated by a single blank character, and ended by CRLF. +- 3) Conditionally, as defined in IETF RFC 9110 [17], the following HTTP headers in any order: Content-Type, Content-Encoding, and Content-Length. Every HTTP header line shall be ended by CRLF. +- 4) CRLF to end the headers section. +- 5) The content of the response, if applicable based on the status code and the HTTP headers, as defined in IETF RFC 9110 [17]. + +NOTE 5: The status code, the status message and the content (if applicable), are the same as if delivering the notification as defined in clause 5.2.5.3. + +Use of CRLF is defined in IETF RFC 9110 [17]. + +The SCEF need not wait for the confirmation of each notification before delivering the next notification. The SCEF shall determine whether a notification has been delivered successfully by correlating the sent notification with the received acknowledgement by checking the sequence numbers of both for equality. The SCEF may re-send a notification, using the same sequence number, if it has not received an acknowledgement with a matching sequence + +number after a configurable time-out. The SCS/AS shall consider notifications with the same sequence number that arrive within a configurable time interval as duplicates. + +The SCS/AS should send periodic Websocket "PING" frames to keep the connection alive. + +NOTE 6: the TCP layer will handle a possible fragmentation and reassembly of large messages. + +The security related clause 6 shall also apply for the HTTP connection that is upgraded to Websocket. + +## 5.2.6 Error handling + +Table 5.2.6-1 lists response bodies that are applicable to all APIs and as responses for all requests in the present specification unless otherwise specified. The HTTP client shall mandatorily support the processing of the status code for all the applicable methods, when received in a HTTP response message. In such cases the HTTP client shall also support the handling of the "ProblemDetails" JSON object with the Content-Type header field set to the value "application/problem+json", if the corresponding API definition in the current specification does not specify another response body for the corresponding status code. + +**Table 5.2.6-1: Response bodies supported for responses to all requests.** + +| Response body | Data type | Cardinality | Response Codes (NOTE 1) | Remarks (NOTE 2, NOTE 4) | Applied Methods | +|---------------|----------------|-------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| | ProblemDetails | 1 | 400 Bad Request | Incorrect parameters were passed in the request. | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 401 Unauthorized | The client is not authorized as described in IETF RFC 9110 [17]. | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 403 Forbidden | This represents the case when the server is able to understand the request but unable to fulfil the request due to errors (e.g. the requested parameters are out of range). More information may be provided in the "invalidParams" attribute of the "ProblemDetails" structure. (NOTE 3) | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 404 Not Found | The resource URI was incorrect, for instance because of a wrong "scsAsId" field. | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 406 Not Acceptable | The content format provided in the "Accept" header is not acceptable by the server. | GET | +| | ProblemDetails | 1 | 411 Length Required | The code indicates that the server refuses to accept the request without a Content-Length header field. | POST, PUT, PATCH | +| | ProblemDetails | 1 | 413 Content Too Large | If the received HTTP request contains content larger than the server is able to process, the NF shall reject the HTTP request. | POST, PUT, PATCH | +| | ProblemDetails | 1 | 415 Unsupported Media Type | The code indicates that the resource is in a format which is not supported by the server for the method. | POST, PUT, PATCH | +| | ProblemDetails | 1 | 429 Too Many Requests | The code indicates that due to excessive traffic which, if continued over time, may lead to (or may increase) an overload situation. The HTTP header field "Retry-After" may be added in the response to indicate how long the client has to wait before making a new request. | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 500 Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. | GET, POST, PUT, PATCH, DELETE | +| | ProblemDetails | 1 | 503 Service Unavailable | The server is unable to handle the request. | GET, POST, PUT, PATCH, DELETE | + +NOTE 1: In addition to the above response codes, the SCEF can also send other valid HTTP response codes, if applicable. The list of all valid HTTP response codes can be found in HTTP Status Code Registry at IANA [6]. + +NOTE 2: The MIME media type that shall be used within the related Content-Type header field is "application/problem+json", as defined in IETF RFC 9457 [8]. + +NOTE 3: The information about which provided parameters are out of range shall be provided in the "invalidParams" attribute of the "ProblemDetails" structure for the API of network parameter configuration. + +NOTE 4: More information may be provided in the "detail" attribute of the "ProblemDetails" structure. + +The protocol and application errors in clause 5.2.7.2 of 3GPP TS 29.500 [44] are applicable for above status codes for the APIs defined in the present specification. Specific errors are contained in the related API definition for each API. + +## 5.2.7 Feature negotiation + +The procedures in clause 6.6.2 of 3GPP TS 29.500 [44] shall be applicable for the APIs defined in the present specification with the difference that the SCEF should not register any feature for northbound APIs in the NRF. + +The supported features are negotiated separately for each API. For each of the APIs defined in the present specification, the applicable list of features is contained in the related API definition. + +## 5.2.8 HTTP custom headers + +### 5.2.8.1 General + +This clause lists reused HTTP custom headers and defines any new HTTP custom headers introduced by this specification. + +### 5.2.8.2 Reused HTTP custom headers + +**Table 5.2.8.2-1: Reused HTTP custom headers** + +| Name | Reference | Description | +|------|-----------|-------------| +| | | | + +### 5.2.8.3 Optional HTTP custom headers + +#### 5.2.8.3.1 General + +The Northbound APIs defined in this specification may support the HTTP custom headers specified in Table 5.2.8.3.1-1 below. A description of each custom header and the normative requirements related to when to include them are also provided in Table 5.2.8.3.1-1. + +**Table 5.2.8.3.1-1: Optional HTTP custom headers** + +| Name | Reference | Description | +|-------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Nb-Api-Sender-Timestamp | clause 5.2.8.3.2 | This header may be used to indicate the date and time (with a millisecond granularity) at which an HTTP request or response is originated. This may be used e.g. for measuring signalling delays in Northbound interfaces. | +| Nb-Api-Max-Rsp-Time | clause 5.2.8.3.3 | This header may be used in a HTTP request to indicate the duration during which the HTTP client waits for a response. | +| Nb-Api-Lci | clause 5.2.8.3.4 | This header may be used by a SCEF to send Load Control Information (LCI) to the sending entity (e.g. SCS/AS, AF). | +| Nb-Api-Oci | clause 5.2.8.3.5 |

This header may be used by an overloaded SCEF in an API response message, or in a notification request message to signal Overload Control Information (OCI) to the sending entity (e.g. SCS/AS, AF).

This header may also be used by an overloaded sending entity (e.g. SCS/AS, AF) in a notification response or in an API request to signal Overload Control Information (OCI) to the SCEF.

| + +### 5.2.8.3.2 Nbi-Api-Sender-Timestamp + +The provisions of clause 5.2.3.3.2 of 3GPP TS 29.500 [44] also apply to this header. + +NOTE: Any provisions that are specific to 5G SBI APIs (e.g. related to the support of Indirect Communication models) are however not applicable for Northbound APIs. + +### 5.2.8.3.3 Nb-Api-Max-Rsp-Time + +The provisions of clause 5.2.3.3.3 of 3GPP TS 29.500 [44] also apply to this header. + +NOTE: Any provisions that are specific to 5G SBI APIs (e.g. related to the support of Indirect Communication models) are however not applicable for Northbound APIs. + +### 5.2.8.3.4 Nbi-Api-Lci + +The header contains a comma-delimited list (see IETF RFC 9110 [17]) of Load Control Information (LCI). See clause 5.2.11. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [17]. + +Nb-Api-Lci = "Nb-Api-Lci:" 1#(RWS timestamp ";" RWS lcMetric ")" + +timestamp = "Timestamp:" RWS DQUOTE date-time DQUOTE + +Mandatory parameter. The date-time type is specified in IETF RFC 5322 [66] and clause 7.1.1.1 of IETF RFC 9110 [17]. It indicates the timestamp associated with the load control information. + +lcMetric = "Load-Metric:" RWS (DIGIT / %x31-39 DIGIT / "100") "%" + +Mandatory parameter. Load-Metric is up to 3 digits long decimal string and the value range shall be from 0 to 100. + +EXAMPLE: Load Control Information: + +Nbi-Api-Lci: Timestamp: "Tue, 04 Feb 2021 08:50:28 GMT"; Load-Metric: 50% + +### 5.2.8.3.5 Nb-Api-Oci + +The header contains a comma-delimited list of Overload Control Information (OCI). See clause 5.2.11. + +The encoding of the header follows the ABNF as defined in IETF RFC 9110 [17]. + +Nb-Api-Oci = "Nb-Api-Oci:" 1#(RWS timestamp ";" RWS validityPeriod ";" RWS olcMetric ")" + +timestamp = "Timestamp:" RWS DQUOTE date-time DQUOTE + +Mandatory parameter. The date-time type is specified in IETF RFC 5322 [66] and clause 7.1.1.1 of IETF RFC 9110 [17]. It indicates the timestamp at which the overload control information was generated. + +validityPeriod = "Period-of-Validity:" RWS 1\*DIGIT "s" + +Mandatory parameter. Period of validity is a timer that is measured in seconds. Once the timer expires, the OCI becomes invalid. + +olcMetric = "Overload-Reduction-Metric:" RWS (DIGIT / %x31-39 DIGIT / "100") "%" + +Mandatory parameter. Overload-Reduction-Metric up to 3 digits long decimal string and the value range shall be from 0 to 100. + +EXAMPLE: Overload Control Information: + +Nbi-Api-Oci: Timestamp: "Tue, 04 Feb 2021 08:50:28 GMT"; Period-of-Validity: 90s; Overload-Reduction-Metric: 25% + +## 5.2.9 Conventions for Open API specification files + +### 5.2.9.1 General + +T8 Open API specification files shall comply with the OpenAPI specification [27] and with the present clause. + +Each API shall be described in one Open API specification file. In addition, 3GPP specifications may contain Open API specification file with common data types. + +For the purpose of referencing (see clause 5.2.9.6), it is assumed that each Open API specification file contained in a 3GPP specification is stored as separate physical, that all Open API specification files are stored in the same directory on the local server, and that the files are named according to the conventions in clause 5.2.9.6. + +### 5.2.9.2 Formatting of OpenAPI files + +The following guidelines shall be used when documenting OpenAPI files: + +- OpenAPI specifications shall be documented using YAML format (see YAML 1.2 [41]). For specific restrictions on the usage of YAML in OpenAPI, see OpenAPI Specification [27]. +- The style used for the specification shall be "PL" (Programming Language). +- The different scopes in the YAML data structures representing collections (objects, arrays...) shall use an indentation of two white spaces. +- Comments may be added by following the standard YAML syntax ("#"). +- Tabs shall not be used in OpenAPI specification files (e.g. within description fields). +- "Unbreakable" spaces (UTF-8 'NO-BREAK SPACE' (U+00A0)) shall not be used in OpenAPI specification files (e.g. within description fields). Only "normal" spaces (UTF-8 'SPACE' (U+0020)) shall be allowed. +- Trailing spaces (i.e. white spaces at the end of a line) should not be used in OpenAPI specification files. + +### 5.2.9.3 Structured data types + +The OpenAPI file shall contain a definition in the components/schemas section defining a schema with the name of the structured data type as key. + +The schema shall contain: + +- "type: object"; +- "description: ", where is the description of the data type in the table defining the structured data type. The "description" attribute should be provided for all data types, specially if they are frequently reused from the same or other OpenAPI specification files; the "description" attribute shall always be provided for data types defined as maps, with a clear indication of the values (strings) used as key of the map; +- if any attributes in the structured data type are marked as mandatory via a minimum cardinality greater than "0", a "required" keyword listing those attributes; and +- a "properties" keyword containing for each attribute in the structured data type an entry with the attribute name as key and: + 1. if the data type is "": + - a. if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - b. otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI file and "\$ref: '#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + 2. if the data type is "array()": + +- a. a type definition "type: array"; + - b. an "items:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI file and "\$ref: '/#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "minItems: "; and + - d. if the cardinality contained an integer value as upper boundary, "maxItems: "; +3. if the data type is "map()": + - a. a type definition "type: object"; + - b. an "additionalProperties:" definition containing: + - i). if the data type of the attribute is "string", "number", "integer", or "boolean", a type definition using that data type as value ("type: "); or + - ii). otherwise a reference to the data type schema for the data type of the attribute, i.e. "\$ref: '#/components/schemas/'" if that data type schema is contained in the same OpenAPI file and "\$ref: '/#/components/schemas/'" if that data type schema is contained in file in the same directory on the same server; + - c. if the cardinality contained an integer value as lower boundary, "min Properties: "; and + - d. if the cardinality contained an integer value as upper boundary, "max Properties: "; and + 4. "description: ", where is the description of the attribute in the table defining the structured data type; the "description" attribute shall always be provided for attributes defined as maps, with a clear indication of the values (strings) used as key of the map. + +NOTE 1: An omission of the "minProperties", and "maxProperties" keywords indicates that no lower or upper boundaries respectively, for the number of properties in an object are defined. An omission of the "minItems", and "maxItems" keywords indicates that no lower or upper boundaries, respectively, for the number of items in an array are defined. + +NOTE 2: The "0..N" implies the array or map type of the attribute may be optional. If the attribute is present, the minimum number of elements is described in openAPI file. + +Example: + +**Table 5.2.9.3-1: Definition of type ExampleStructuredType** + +| Attribute name | Data type | Cardinality | Description | +|-----------------|------------------|-------------|---------------------------------------------------------------------------| +| exSimple | ExSimple | 1 | exSimple attribute description | +| exArrayElements | array(string) | 1..10 | exArrayElements attribute description | +| exMapElements | map(ExStructure) | 1..N | exMapElements attribute description, indicating the values of the map key | + +The data structure in table 5.2.9.3-1 is described in an OpenAPI file as follows: + +``` +components: + schemas: + ExampleStructuredType: + type: object + description: ExampleStructuredType data type description + required: + - exSimple +``` + +``` + +- exMapElements +properties: + exSimple: + $ref: '#/components/schemas/ExSimple' + exArrayElements: + type: array + items: + type: string + minItems: 1 + maxItems: 10 + description: exArrayElements attribute description + exMapElements: + type: object + additionalProperties: + $ref: '#/components/schemas/ExStructure' + minProperties: 1 + description: exMapElements attribute description, indicating the values of the map key + +``` + +NOTE 3: Object schema definitions should not have property names in the "required" attribute for which a corresponding property definition does not exist. + +#### 5.2.9.4 Info + +The Open API specification file of an API shall contain an "info" field with the title and version as defined in clause 4.3 of 3GPP TS 29.501 [49]. + +#### 5.2.9.5 Servers + +As defined in clause 5.2.4, the base URI of an API consists of {apiRoot}//. It shall be encoded in the corresponding Open API specification file as "servers" field with {apiRoot} as variable. + +Example: + +``` + +servers: +- url: '{apiRoot}/3gpp-yyyy/v1' + variables: + apiRoot: + default: https://demohost.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +``` + +#### 5.2.9.6 References to other 3GPP-defined Open API specification files + +For the purpose of referencing, it shall be assumed that each Open API specification file contained in a 3GPP specification is stored as separate physical file, that all Open API specification files are stored in the same directory on the local server, and that the files are named according to the following convention: The file name shall consist of (in the order below): + +- the 3GPP specification number in the format "Tsxxxxyy"; +- an "\_" character; +- if the OpenAPI specification file contains an API definition, the API name as defined for corresponding base URL parts (see clause 4.4) of that API. +- if the OpenAPI specification file contains a definition of CommonData, the string "CommonData"; and +- the string ".yaml". + +Examples: + +Reference to Data Type "Xxx" defined in the same file + +``` +$ref: '#/components/schemas/Xxx' +``` + +Reference to Data Type "Xxx" defined as Common Data in 3GPP TS 29.122: + +``` +$ref: 'TS29122_CommonData.yaml#/components/schemas/Xxx' +``` + +Reference to Data Type "Xxx" defined within API "Nxxx\_Yyy" in 3GPP TS ab.cde: + +``` +$ref: 'Tsabcde_Nxxx_Yyy.yaml#/components/schemas/Xxx' +``` + +## 5.2.9.7 Server-initiated communication + +If an API contains notifications as described in clause 5.2.5, it should be described as "callback" in Open API specification files. + +Example: + +``` +paths: + /subscriptions: + post: + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + callbackUrl: # Callback URL + type: string + format: uri + responses: + '201': + description: Success + callbacks: + myNotification: # arbitrary name + '{$request.body#/callbackUrl}': # refers The callback URL in the POST + post: + requestBody: # Contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationBody' + responses: # Expected responses to the callback message + '200': + description: xxx +``` + +## 5.2.9.8 Describing the body of HTTP PATCH requests + +### 5.2.9.8.1 General + +As described in clause 5.2.2.2, the bodies of HTTP PATCH requests either use a "JSON Merge Patch" encoding as defined in IETF RFC 7396 [39], or a "JSON Patch" encoding as defined in IETF RFC 6902 [67]. + +It is possible to allow both encodings in an OpenAPI Specification [27] offering both schemas as alternative contents. + +### 5.2.9.8.2 JSON Merge Patch + +In the OpenAPI file, the content field key of the Request Body Object shall contain "application/merge-patch+json". The content field value is a Media Type Object identifying the applicable patch body Schema Object. The patch body Schema Object may contain structured data types derived from the data types used in the schema to describe a complete representation of the resource in such a manner that attributes that are allowed to be modified are listed in the "properties" validation keyword. + +NOTE 1: A derived structured data type is beneficial if the data types used to describe a complete representation of the resource contains mandatory attributes, if attributes are allowed to be removed by the PATCH operation, or if a checking by the OpenAPI tooling that only allowed modifications are done via the "additionalProperties: false" keyword is desired. It also provides a clear description in the OpenAPI file to developers which modifications need to be supported. + +As an alternative, the data types used in the schema to describe a complete representation of the resource may be used if any attributes that are allowed to be removed are marked as "nullable: true" in that schema. + +Any attributes that are allowed to be removed shall be marked as "nullable: true" in the patch body Schema Object. + +The "additionalProperties: false" keyword may be set. + +NOTE 2: The "additionalProperties: false" keyword enables the OpenAPI tooling to check that only allowed modifications are done. Extensions of the object in future releases are still possible under the assumption that the supported features mechanism is used to negotiate the usage of any new attribute prior to the PATCH invocation. If new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API, the usage of the "additionalProperties: false" keyword is not appropriate. + +### 5.2.9.8.3 JSON PATCH + +In the OpenAPI file, the content field key of the Request Body Object shall contain "application/json-patch+json". The content field value is a Media Type Object identifying the applicable patch body. It may contain a mutually exclusive list (using the "oneOf" keyword) of all allowed modifications as tuples, where "path" is a string containing a JSON Pointer value referring to a JSON object that is allowed to be modified, "op" is an enumeration of allowed JSON PATCH operations on the JSON object identified by "path" and "value" representing the schema/type of the value that will be updated or added at the JSON object identified by "path". In addition, an open alternative containing an object with no properties may be added using the "anyOf" keyword. + +NOTE 1: A mutually exclusive list provides a clear description in the OpenAPI specification file to developers which modifications need to be supported. This is of particular interest if only a limited number of modifications need to be supported. If no open alternative is included, the OpenAPI tooling will also check that only allowed modifications are done. + +NOTE 2: The open alternative allows for extensions of the PATCH in scenarios where new optional attributes are expected to be introduced without corresponding supported feature or if PATCH can be used as first operation in an API. + +### 5.2.9.9 Error Responses + +As described in clause 5.2.6, T8 APIs use valid HTTP response codes as error codes in HTTP responses and may include a "ProblemDetails" data structure specified in clause 5.2.1.2.12 or an application-specific data structure. + +Clause 5.2.6 specifies HTTP status code per HTTP method. OpenAPI files should include at least the status codes in that table. + +For the purpose of referencing, HTTP error responses with "ProblemDetails" data structure are specified as part of the CommonData OpenAPI file in Annex A.2. + +Example: + +In the example below, the 400, and 500 and default error response descriptions are referenced. + +``` +Paths: + /users: + get: + responses: + '200': + content: + application/json + schema: + $ref: '#/components/schemas/ExampleGetBody' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +The following definitions provided in Annex A.2 are used in that example: + +``` +components: + responses: + '400': + description: Bad request + content: + application/problem+json: + schema: +``` + +``` + + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + default: + description: Generic Error + +``` + +## 5.2.9.10 Enumerations + +For enumerations, the OpenAPI file shall contain a definition in the components/schemas section defining a schema with the name of the enumeration as key. + +The naming conventions defined in clause 5.1.4 of 3GPP TS 29.501 [49] shall apply. + +The schema: + +- shall contain the "anyOf" keyword listing as alternatives: + 1. the "type: string" keyword and the "enum" keyword with a list of all defined values for the enumeration; and + 2. the "type: string" keyword and the "description" keyword with a description stating that the string is only provided for extensibility and is not used to encode contents defined in the present version of the specification, and +- should contain a description field, containing the overall meaning and purpose of the enumeration; additionally, this field may contain a list of the defined values of the enumeration together with explanations of those values. + +NOTE: The "enum" keyword restricts the permissible values of the string to the enumerated ones. This can lead to extensibility problems when new values need to be introduced. + +Example: + +ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; it complies with the provisions defined in table 5.2.9.10-1. + +**Table 5.2.9.10-1: Enumeration ExampleEnumeration** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| ONE | Value ONE description | | +| TWO | Value TWO description | | + +The data structure in table 5.2.9.10-1 is described in an OpenAPI file as follows: + +``` + +components: + schemas: + ExampleEnumeration: + anyOf: + - type: string + enum: + - ONE + - TWO + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + ExampleEnumeration represents xxx, and it is used to indicate yyy or zzz; + it complies with the provisions defined in table 5.2.9.10-1 of 3GPP TS ab.cde. + Possible values are: + - ONE: Value ONE description + - TWO: Value TWO description + +``` + +### 5.2.9.11 Read only attribute + +Each OpenAPI specification should include "readOnly: true" for those attributes that are only provided by the SCEF in the HTTP response message to prevent the SCS/AS from provisioning those attributes which is not expected, if the write and read operations (e.g. POST request and response) share the same data type which contains those attributes. + +Example: + +``` +NiddStatus: + anyOf: + - type: string + enum: + - ACTIVE + - TERMINATED_UE_NOT_AUTHORIZED + - TERMINATED + - type: string + description: > + 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. + Description: > + Possible values are + - ACTIVE: The NIDD configuration is active. + - TERMINATED_UE_NOT_AUTHORIZED: The NIDD configuration was terminated because the UE's +authorisation was revoked. + - TERMINATED: The NIDD configuration was terminated. + readOnly: true +``` + +### 5.2.9.12 externalDocs + +Each OpenAPI specification shall provide in an "externalDoc" field the reference to the 3GPP TS describing the API, as illustrated below. + +Example: + +``` +externalDocs + description: 3GPP TS 29.122 V15.1.0 T8 reference point for Northbound APIs + url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/ +``` + +### 5.2.9.13 Operation identifiers + +Service operations defined in an OpenAPI specification file should be assigned an Operation ID. + +EXAMPLE: + +``` +get: + operationId: ReadInfo + summary: Read Information. + tags: + - Information (Document) + parameters: + - name: infoType + in: path + description: Requested information Type + required: true + schema: + type: string + (...) +``` + +### 5.2.9.14 Usage of the "tags" field + +In an OpenAPI specification, all HTTP operations belonging to the same resource should include a "tags" field containing a same value, briefly describing that resource (e.g. using the name of the resource and its archetype). This results in all operations being grouped by the User Interface of OpenAPI tools, which helps with readability of the API documentation. + +EXAMPLE: + +``` +openapi: 3.0.0 +(...) +paths: + /subscriptions/{subscriptionId}: +``` + +``` +get: + summary: Retrieve an existing Individual subscription resource. + operationId: GetIndSubsc + tags: + - Individual Subscription (Document) + + (...) + +put: + summary: Request the update of an existing Individual Subscription resource. + operationId: UpdateIndSubsc + tags: + - Individual Subscription (Document) + + (...) + +patch: + summary: Request the modification of an existing Individual Subscription resource. + operationId: ModifyIndSubsc + tags: + - Individual Subscription (Document) + + (...) +``` + +## 5.2.10 Redirection handling + +An HTTP request may be redirected to a different target entity. + +Upon receipt of an HTTP request from the SCS/AS, when the SCEF redirects the HTTP request to a different target SCEF, the URI of the target SCEF towards which the request is redirected shall be given by the Location header field of the "307 Temporary Redirect" or "308 Permanent Redirect" response. The SCS/AS should then send the HTTP request towards the new target SCEF. + +Upon receipt of a notification/callback request from the SCEF, when the SCS/AS redirects the notification/callback request to a different target SCS/AS, the URI of the target SCS/AS towards which the notification/callback request is redirected shall be given by the Location header field of the "307 Temporary Redirect" or "308 Permanent Redirect" response. The SCEF should then send the HTTP request towards the new target SCS/AS. + +## 5.2.11 Support of Load and Overload Control + +The Load Control mechanisms defined in clause 6.3 of 3GPP TS 29.500 [44] may be supported by T8 APIs with the following differences: + +- The "Load Control based on load signalled via the NRF" mechanism defined in clause 6.3.2 of 3GPP TS 29.500 [44] shall not be supported; and +- The "Load Control based on LCI Header" mechanism defined in clause 6.3.3 of 3GPP TS 29.500 [44] may be supported with the following differences: + - The Load Control "scope" and all the related provisions are not applicable; + - The "NF Service Consumer" corresponds to the sending entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs and the "NF Service Producer" corresponds to the receiving entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs; + - The provisions related to the SCP (Service Communication Proxy) and SEPP (Security Edge Protection Proxy) entities are not applicable; and + - The "3gpp-Sbi-Lci" custom HTTP header corresponds to the "Nbi-API-Lci" custom HTTP header defined in clause 5.2.8.3.4 for T8 APIs. + - The provisions and mechanisms using the NRF (i.e. 5GC NF Repository Function) are not applicable. + +The Overload Control mechanisms defined in clause 6.4 of 3GPP TS 29.500 [44] may be supported by T8 APIs with the following differences: + +- The "Overload Control based on HTTP status codes" mechanism defined in clause 6.4.2 of 3GPP TS 29.500 [44] may be supported with the following differences: + - The "NF Service Consumer" corresponds to the sending entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs and the "NF Service Producer" corresponds to the receiving entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs; + +and + +- The "Overload Control based on OCI Header" mechanism defined in clause 6.4.3 of 3GPP TS 29.500 [44] may be supported with the following differences: + - The Overload Control "scope" and all the related provisions are not applicable; + - The "NF Service Consumer" corresponds to the sending entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs and the "NF Service Producer" corresponds to the receiving entity (e.g. SCEF, SCS/AS, AF) of the message in T8 APIs; + - The provisions related to the SCP (Service Communication Proxy) and SEPP (Security Edge Protection Proxy) entities are not applicable; and + - The "3gpp-Sbi-Oci" custom HTTP header corresponds to the "Nbi-Api-Oci" custom HTTP header defined in clause 5.2.8.3.5 for T8 APIs. + - The provisions and mechanisms using the NRF (i.e. 5GC NF Repository Function) are not applicable. + +## 5.2.12 Query parameters + +The query component in a URI contains non-hierarchical data that, along with data in the path component, enables to filter the resources identified within the scope of the URI's scheme to a subset of the resources matching the query parameters. The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI. The syntax of the query component is specified in IETF RFC 3986 [7]. + +When a server receives a request with a query component, it shall parse the query string in order to identify the filters. The first question mark is used to be a separator and is not part of the query string. A query string is composed of a series of "key=value" pairs, separated by "&". If one query parameter contains more than one value, i.e. an array of data elements, then the values shall be separated by comma (","). + +The behaviour of the server when receiving an HTTP/2 method with a query parameter which is of type array, and only some of the members in the array can be matched, depends on each API and the behaviour shall be clearly described. + +When multiple query parameters are defined for a method on the resource, the logical 'AND' is the default logical relationship between the query parameters for this resource. If a different logical relationship between multiple query parameters is specified for a method on a resource in an API, then this logical relationship override the default logical relationship for this specific method on the concerned resource in that API. If multiple query parameters are defined for a method on a resource in an API, but there is no need to specify any logical relationship between these query parameters, the concerned API shall explicitly state how to handle multiple query parameters. + +## 5.2.13 Vendor-specific extensions + +### 5.2.13.1 General + +The vendor specific extensions specified in the below clauses are mechanisms for the APIs to re-use. The applicability of these mechanisms for specific 3GPP Northbound and application layer APIs is specified in the respective API specifications. + +### 5.2.13.2 Vendor-specific extensions to the data model + +Vendor-specific extensions for information elements may be generally supported in the 3GPP northbound and application layer APIs by reusing the same vendor-specific extensions mechanism defined for 5GC APIs in clause 6.6.3 of 3GPP TS 29.500 [44]. + +In the 3GPP northbound and application layer APIs, the vendor may alternatively be identified by setting the placeholder "nnnnn" in the vendor-specific member name to a domain name registered to the vendor, or a URN from the URN space managed by the vendor. + +NOTE: The global uniqueness of the domain name or URN, when used to set the placeholder "nnnnn" in the vendor-specific member name, has to be guaranteed. + +An example for the IANA-assigned enterprise code to identify the vendor is: + +EXAMPLE 1: The vendor-specific member name for vendor "3GPP" based on IANA enterprise number would be: + +``` +"vendorSpecific-010415": { + ... +} +``` + +Examples for the additional alternatives to identify the vendor are: + +EXAMPLE 2: The vendor-specific member name for vendor "3GPP" based on domain name would be: + +``` +"vendorSpecific-3gpp.org": { + ... +} +``` + +EXAMPLE 3: The vendor-specific member name for vendor "3GPP" based on URN would be: + +``` +"vendorSpecific-urn:3gpp:example": { + ... +} +``` + +NOTE: The preferred naming scheme (for the "nnnnn" placeholder) for vendor-specific member names is the one based on the IANA-assigned enterprise code defined in clause 6.6.3 of 3GPP TS 29.500 [44]. + +### 5.2.13.3 Vendor-specific query parameters + +Vendor-specific extensions to the query component of an HTTP request may be supported in the 3GPP northbound and application layer APIs by allowing the provisioning of vendor-specific query parameters in order to support additional vendor-specific filtering criteria. Whether an operation (e.g. using the HTTP GET method) on a specific resource of a 3GPP northbound or application layer API shall support the processing of vendor-specific query parameters shall be explicitly specified (within the corresponding resource or custom operation definition clauses) in the definition of this API operation in the technical specification where it is defined. This pattern applies to querying resources of "collection" or "store" archetype. + +A vendor-specific query parameter shall be encoded as follows: + +- The query parameter name shall start with "vend-spec" followed by the actual name of the query parameter, i.e. "vend-spec-". +- The query parameter value shall be encoded as a JSON object containing two attributes as defined in Table 5.2.13.2-1, wherein: + - the "target" attribute is a JSON pointer (as per RFC 6901 [70]) towards the targeted attribute in the targeted resource representation; and + - the "value" attribute contains the actual value of the query parameter that is to be used for filtering and shall hence be encoded in the same way as the attribute in the resource representation that it targets. + +**Table 5.2.13.2-1: Vendor-specific query parameter value content definition** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| target | String | M | 1 | Contains the JSON pointer (as per RFC 6901 [70]) to the attribute in the resource representation that the provided vendor-specific query parameter is targeting. | | +| value | | M | 1 | Contains the vendor-specific query parameter value. | | + +EXAMPLE 1: Assuming that vendor-specific query parameters are supported for the MonitoringEvent API, if an authorized service consumer wants to retrieve the representations of the "Individual Monitoring Event Subscription" resources that contain a specific value (e.g. 6) for the "maximumNumberOfReports" attribute, then it can send a GET request using the following vendor-specific query parameter: + +GET {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions?vend-spec-max-reports={"target": "/maximumNumberOfReports", value: "6"} + +EXAMPLE 2: Assuming that vendor-specific query parameters are supported for the MonitoringEvent API, if within the representations of the "Individual Monitoring Event Subscription" resources, a vendor-specific extension to the data model is provided by an AF via the "vendorSpecific-010415" attribute as specified in clause 5.2.13.1 and contains additional/alternative target location accuracy values within the "addAccuracy" attribute, and an authorized service consumer wants to retrieve the representations of those "Individual Monitoring Event Subscription" resources that contain a specific value for the "addAccuracy" attribute, then it can send a GET request using the following vendor-specific query parameter: + +GET {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions?vend-spec-accuracy={"target": "/vendorSpecific-010415/addAccuracy", value: "CELL\_OR\_TA"} + +## 5.3 MonitoringEvent API + +### 5.3.1 Overview + +The MonitoringEvent API is a RESTful API that allows the SCS/AS to subscribe to notifications about specific events in 3GPP networks. It also allows the SCEF to report the event by sending notifications to the authorised users when the corresponding event is detected. The API also allows the SCEF to indicate the removal of a previously configured monitoring request. The MonitoringEvent API defines a set of data models, resources and the related procedures for the creation and management of monitoring event subscriptions. The corresponding JSON schema for the representation of the resources and operations defined by the MonitoringEvent API is provided in its complete form in Annex A.3. + +### 5.3.2 Data model + +#### 5.3.2.1 Resource data types + +##### 5.3.2.1.1 Introduction + +This clause defines data structures to be used in resource representations, including subscription resources. + +Table 5.3.2.1.1-1 specifies data types re-used by the MonitoringEvent API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the MonitoringEvent API. + +**Table 5.3.2.1.1-1: MonitoringEvent API re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| CivicAddress | 3GPP TS 29.572 [42] | Civic address. | +| CodeWord | 3GPP TS 29.515 [65] | Code word. | +| DIDataDeliveryStatus | 3GPP TS 29.571 [45] | Traffic Descriptor of source of downlink data notifications. | +| DddTrafficDescriptor | 3GPP TS 29.571 [45] | Traffic Descriptor of source of downlink data. | +| Dnn | 3GPP TS 29.571 [45] | Identifies a DNN. | +| Fqdn | 3GPP TS 29.571 [45] | Identifies a FQDN. | +| GeographicArea | 3GPP TS 29.572 [42] | Identifies the geographical information of the user(s). | +| Gpsi | 3GPP TS 29.571 [45] | Represents a GPSI. | +| IpAddr | 3GPP TS 29.571 [45] | UE IP Address. | +| LocationQoS | 3GPP TS 29.572 [42] | Requested location QoS. | +| LdrType | 3GPP TS 29.572 [42] | Location deferred requested event type. | +| MinorLocationQoS | 3GPP TS 29.572 [42] | Minor Location QoS. | +| VelocityRequested | 3GPP TS 29.572 [42] | Velocity of the target UE requested. | +| AgeOfLocationEstimate | 3GPP TS 29.572 [42] | Age of the location estimate for change of location type or motion type of Location deferred report. | +| AccuracyFulfilmentIndicator | 3GPP TS 29.572 [42] | The indication whether the obtained location estimate satisfies the requested QoS or not. | +| VelocityEstimate | 3GPP TS 29.572 [42] | UE velocity, if requested and available. | +| LinearDistance | 3GPP TS 29.572 [42] | This IE shall be present and set to true if a location estimate is required for motion event report. | +| NetworkAreaInfo | 3GPP TS 29.554 [50] | Identifies a network area information. | +| PatchItem | 3GPP TS 29.571 [45] | Contains the list of changes to be made to a resource according to the JSON PATCH format specified in IETF RFC 6902 [67]. | +| PduSessionInformation | 3GPP TS 29.523 [70] | Represents PDU session identification information. | +| PositioningMethod | 3GPP TS 29.572 [42] | Identifies the positioning method used to obtain the location estimate of the UE. | +| SACEventStatus | 3GPP TS 29.571 [45] | Contains the network slice status information related to network slice admission control. | +| SACInfo | 3GPP TS 29.571 [45] | Represents network slice admission control information to control the triggering of notifications or convey network slice status information. | +| Snssai | 3GPP TS 29.571 [45] | Contains a S-NSSAI. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.3.4-1. | +| ServiceIdentity | 3GPP TS 29.515 [65] | Service identity. | +| SupportedGADShapes | 3GPP TS 29.572 [42] | Supported Geographical Area Description shapes. | +| MacAddr48 | 3GPP TS 29.571 [45] | MAC Address. | +| UcPurpose | 3GPP TS 29.503 [63] | Represents the purpose of a user consent. | +| Uinteger | 3GPP TS 29.571 [45] | Represents an unsigned Integer. | +| Uri | 5.2.1.3.2 | Represents a URI. | +| UserLocation | 3GPP TS 29.571 [6] | Represents a user location. | +| RangingSIResult | 3GPP TS 29.572 [42] | Indicates result type for ranging and sidelink positioning | +| RelatedUE | 3GPP TS 29.572 [42] | Indicates information for related UE for ranging and sidelink positioning | + +Table 5.3.2.1.1-2 specifies the data types defined for the MonitoringEvent API. + +**Table 5.3.2.1.1-2: MonitoringEvent API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------------|----------------|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| Accuracy | 5.3.2.4.7 | Represents a desired granularity of accuracy for the requested location information. | Location_notification, eLCS, EDGEAPP | +| ApiCapabilityInfo | 5.3.2.3.9 | Represents the availability information of supported API. | API_support_capability_notification | +| AppliedParameterConfiguration | 5.3.2.3.8 | Represents the parameter configuration applied in the network. | Enhanced_param_config | +| AssociationType | 5.3.2.4.6 | Represents an IMEI or IMEISV to IMSI association. | Change_of_IMSI_IMEI_association_notification | +| ConsentRevocNotif | 5.3.2.3.12 | Represents the user consent revocation information conveyed in a user consent revocation notification. | UserConsentRevocation | +| ConsentRevoked | 5.3.2.3.13 | Represents the information related to revoked user consent(s). | UserConsentRevocation | +| FailureCause | 5.3.2.3.6 | Represents the reason of communication failure. | Communication_failure_notification | +| GroupMembListChanges | 5.3.2.3.13 | Represents information on the change(s) to a group's members list. | GMEC | +| IdleStatusInfo | 5.3.2.3.3 | Represents the information relevant to when the UE transitions into idle mode. | Ue-reachability_notification, Availability_after_DDN_failure_notification | +| InterfaceIndication | 5.3.2.4.10 | Represents the network entity used for data delivery towards the SCS/AS. | Pdn_connectivity_status | +| LocationFailureCause | 5.3.2.4.11 | Represents the cause of location/positioning failure. | eLCS | +| LocationInfo | 5.3.2.3.5 | Represents the user location information. | Location_notification, eLCS | +| LocationType | 5.3.2.4.5 | Represents a location type. | Location_notification, Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G, eLCS | +| MonitoringEventReport | 5.3.2.3.2 | Represents an event monitoring report. | | +| MonitoringEventReports | 5.3.2.3.10 | Represents one or multiple event monitoring report(s). | enNB | +| MonitoringEventSubscription | 5.3.2.1.2 | Represents a subscription to event(s) monitoring. | | +| MonitoringNotification | 5.3.2.2.2 | Represents an event monitoring notification. | | +| MonitoringType | 5.3.2.4.3 | Represents a monitoring event type. | | +| PdnConnectionInformation | 5.3.2.3.7 | Represents the PDN connection information of the UE. | Pdn_connectivity_status | +| PdnConnectionStatus | 5.3.2.4.8 | Represents the PDN connection status. | Pdn_connectivity_status | +| PdnType | 5.3.2.4.9 | Represents a PDN connection type. | | +| ReachabilityType | 5.3.2.4.4 | Represents a reachability type. | Ue-reachability_notification | +| SACRepFormat | 5.3.2.4.13 | Represents the NSAC reporting format. | NSAC | +| SubType | 5.3.2.4.12 | Represents a subscription type. | UAV | +| UavPolicy | 5.3.2.3.11 | Represents the policy information included in the UAV presence monitoring request. | UAV | +| UePerLocationReport | 5.3.2.3.4 | Represents the number of UEs found at the indicated location. | Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_ | + +| | | | | +|------------------------|------------|------------------------------------------------------------------------------------|-----------------| +| | | | notification_5G | +| UpCumEvtRep | 5.3.2.3.18 | Represents the cumulative event report for events reported via user plane. | eLCS_en | +| UpLocRepAddrAfRm | 5.3.2.3.17 | Represents the user plane addressing information. | eLCS_en | +| RangeDirection | 5.3.2.3.14 | Represents the range and direction between two points. | Ranging_SL | +| TwodrelativeLocation | 5.3.2.3.15 | Represents 2D local co-ordinates with origin corresponding to another known point. | Ranging_SL | +| ThreedrelativeLocation | 5.3.2.3.16 | Represents 3D local co-ordinates with origin corresponding to another known point. | Ranging_SL | + +#### 5.3.2.1.2 Type: MonitoringEventSubscription + +This type represents a subscription to monitoring an event. The same structure is used in the subscription request and subscription response. + +**Table 5.3.2.1.2-1: Definition of type MonitoringEventSubscription** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 3) | +|-------------------------|------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| self | Link | 0..1 | Link to the resource "Individual Monitoring Event Subscription". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| mtcProviderId | string | 0..1 | Identifies the MTC Service Provider and/or MTC Application. (NOTE 7) | | +| appId | array(string) | 0..N | Identifies the Application Identifier(s). (NOTE 16) | AppDetection_5G | +| externalId | ExternalId | 0..1 | Identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
This attribute may also be present in a monitoring event subscription response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "uelpAddr" attribute or the "ueMacAddr" attribute. (NOTE 1) (NOTE 5) | | +| msisdn | Msisdn | 0..1 | Identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE 1) (NOTE 5) | | +| addedExternalIds | array(ExternalId) | 0..N | Indicates addition of the external Identifier(s) within the active group. | Partial_group_modification | +| addedMsisdns | array(Msisdn) | 0..N | Indicates addition of the MSISDN(s) within the active group. | Partial_group_modification | +| excludedExternalIds | array(ExternalId) | 0..N | Indicates cancellation of the external Identifier(s) within the active group. | Partial_group_modification | +| excludedMsisdns | array(Msisdn) | 0..N | Indicates cancellation of the MSISDN(s) within the active group. | Partial_group_modification | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 1) (NOTE 6) | | +| addExtGroupIds | array(ExternalGroupId) | 0..N | Identifies user groups as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 1) (NOTE 6) | Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G | +| ipv4Addr | Ipv4Addr | 0..1 | Identifies the Ipv4 address. (NOTE 1) | Location_notification, Communication_failure_notification | +| ipv6Addr | Ipv6Addr | 0..1 | Identifies the Ipv6 address. (NOTE 1) | Location_notification, Communication_failure_notification | +| dnn | Dnn | 0..1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 8) (NOTE 16) | Session_Management_Enhancement, UEId_retrieval, AppDetection_5G | +| notificationDestination | Link | 1 | An URI of a notification destination that T8 message shall be delivered to. | | +| requestTestNotification | boolean | 0..1 | Set to "true" by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. | Notification_test_event | + +| | | | | | +|--|--|--|--------------------------------------------------------------------------------------------------------------------|--| +| | | | Set to "false" by the SCS/AS indicates not request SCEF to send a test notification
Default "false" if omitted. | | +|--|--|--|--------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|------------------------|--------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| monitoringType | MonitoringType | 1 | Enumeration of monitoring type. Refer to clause 5.3.2.4.3. | | +| maximumNumberOfReports | integer | 0..1 | Identifies the maximum number of event reports to be generated by the HSS, MME/SGSN as specified in clause 5.6.0 of 3GPP TS 23.682 [2].
(NOTE 2, NOTE 9, NOTE 13)

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to (or contains) the "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS" values, this attribute may also be provided with a value of 1 to indicate that one-time reporting of the network slice status information is requested by the AF. | | +| monitorExpireTime | DateTime | 0..1 | Identifies the absolute time at which the related monitoring event request is considered to expire, as specified in clause 5.6.0 of 3GPP TS 23.682 [2].

When the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this attribute shall be absent in the response to a one-time reporting monitoring subscription request.
(NOTE 2) | | +| repPeriod | DurationSec | 0..1 | Identifies the periodic time for the event reports. (NOTE 8, NOTE 9, NOTE 13)

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this attribute may be provided. When provided, it also indicates that periodic reporting of the network slice status information is requested by the AF. | | +| groupReportGuardTime | DurationSec | 0..1 | Identifies the time for which the SCEF can aggregate the monitoring event reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2]. | | +| maximumDetectionTime | DurationSec | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOSS_OF_CONNECTIVITY", this parameter may be included to identify the maximum period of time after which the UE is considered to be unreachable. | Loss_of_connectivity_notification | +| reachabilityType | ReachabilityType | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "UE_REACHABILITY", this parameter shall be included to identify whether the request is for "Reachability for SMS" or "Reachability for Data". | Ue-reachability_notification | +| maximumLatency | DurationSec | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "UE_REACHABILITY", this parameter may be included to identify the maximum delay acceptable for downlink data transfers. | Ue-reachability_notification | +| maximumResponseTi | DurationSec | 0..1 | If "monitoringType" attribute (or the | Ue- | + +| | | | | | +|-----------------------------|--------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| me | | | "addnMonTypes" attribute) is set to "UE_REACHABILITY", this parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data. | reachability_no tification | +| suggestedNumberOfDI Packets | integer | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "UE_REACHABILITY", this parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable. | Ue- reachability- notification | +| idleStatusIndication | boolean | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "UE_REACHABILITY" or "AVAILABILITY_AFTER_DDN_FAILURE", this parameter may be included to indicate the notification of when a UE, for which PSM is enabled, transitions into idle mode.
- "true": indicate enabling of notification
- "false": indicate no need to notify
Default: "false" if omitted. | Ue- reachability_no tification, Availability_afte r_DDN_failure_ notification, Availability_afte r_DDN_failure_ notification_en hancement | +| locationType | LocationType | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING" or "NUMBER_OF_UES_IN_AN_AREA", this parameter shall be included to identify whether the request is for Current Location, Initial Location or Last known Location.
(NOTE 4) | Location_notific ation, Number_of_UE s_in_an_area_ notification, Number_of_UE s_in_an_area_ notification_5G, eLCS | +| accuracy | Accuracy | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to identify the desired level of accuracy of the requested location information, as described in clause 4.9.2 of 3GPP TS 23.682 [2].
(NOTE 10, NOTE 11)
For 5G, if the eLCS feature is not supported, the default value is "TA_RA". | Location_notific ation, eLCS | +| minimumReportInterval | DurationSec | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to identify a minimum time interval between Location Reporting notifications.
If the "ldrType" attribute is present and set to "ENTERING_INTO_AREA", "LEAVING_FROM_AREA", "BEING_INSIDE_AREA" or "MOTION", this attribute shall not be included if the maximumNumberOfReports attribute is present and set to one time event. | Location_notific ation, eLCS | +| maxRptExpireIntvl | DurationSec | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to identify a maximum time interval between Location Reporting notifications.
If the "ldrType" attribute is present and set to "ENTERING_INTO_AREA", "LEAVING_FROM_AREA", "BEING_INSIDE_AREA" or "MOTION", this attribute shall not be included if the maximumNumberOfReports attribute is | eLCS | + +| | | | | | +|--|--|--|------------------------------------|--| +| | | | present and set to one time event. | | +|--|--|--|------------------------------------|--| + +| | | | | | +|--------------------|-----------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| samplingInterval | DurationSec | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to identify the maximum time interval between consecutive evaluations by a UE of a trigger event. | eLCS | +| reportingLocEstInd | boolean | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate whether event reporting requires the location information.

Set to "true", indicates the location estimation information shall be included in event reporting.

Set to "false", indicates the location estimation information shall not be included in event reporting.

Default: "false" if omitted. | eLCS | +| linearDistance | LinearDistance | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate the linear(straight line) distance threshold for motion event reporting. | eLCS | +| locQoS | LocationQoS | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate the expected location QoS requirement for an immediate MT-LR or deferred MT-LR.

The "Multiple QoS Class" (i.e. the "IcsQoSClass" attribute within the LocationQoS data structure is set to "MULTIPLE_QOS") shall only be used when the "MULTIQOS" feature is supported.

(NOTE 10) | eLCS, MULTIQOS | +| svcId | ServiceIdentity | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate the service identity of AF. | eLCS | +| ldrType | LdrType | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate the event type for a deferred MT-LR. | eLCS | +| velocityRequested | VelocityRequested | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate if the velocity of the target UE is requested or not. | eLCS | +| maxAgeOfLocEst | AgeOfLocationEstimate | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate acceptable maximum age of location estimate. | eLCS | +| locTimeWindow | TimeWindow | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this | eLCS | + +| | | | | | +|--|--|--|-----------------------------------------------------------------------------------------------|--| +| | | | parameter may be included to indicate the starting time and ending time for a deferred MT-LR. | | +|--|--|--|-----------------------------------------------------------------------------------------------|--| + +| | | | | | +|--------------------|---------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| +| supportedGADShapes | array(SupportedGADShapes) | 0..N | Supported Geographical Area Description shapes. | eLCS | +| codeWord | CodeWord | 0..1 | Code word. | eLCS | +| upLocRepIndAf | boolean | 0..1 |

If the "LOCATION_REPORTING" value is set in either the "monitoringType" attribute or the "addnMonTypes" attribute, this attribute may be included to convey the indication of location reporting over user plane.

When present, this attribute shall be set as follows:
"true": the location reporting over user plane is required.
>false": the location reporting over user plane is not required.
Default: "false" if omitted.

| eLCS_en | +| upLocRepAddrAf | UpLocRepAddrAfRm | 0..1 | If the "upLocRepIndAf" attribute is present and set to "true", this attribute may be present to convey the AF's user plane addressing information to be used for location reporting over user plane. | eLCS_en | +| associationType | AssociationType | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "CHANGE_OF_IMSI_IMEI_ASSOCIATION", this parameter shall be included to identify whether the change of IMSI-IMEI or IMSI-IMEISV association shall be detected. | Change_of_IMSI_IMEI_association_notification | +| plmnIndication | boolean | 0..1 |

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "ROAMING_STATUS", this parameter may be included to indicate the notification of UE's Serving PLMN ID.

  • - "true": The value shall be used to indicate enabling of notification;
  • - "false": The value shall be used to indicate disabling of notification.

Default: "false" if omitted.

| Roaming_status_notification | +| locationArea | LocationArea | 0..1 |

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the area within which the SCS/AS requests the number of UEs.

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "AREA_OF_INTEREST", this parameter shall be included to indicate the area within which the SCS/AS requests the presence status of a specific UAV.

| Number_of_UEs_in_an_area_notification, UAV | +| locationArea5G | LocationArea5G | 0..1 |

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the area within which the AF requests the number of UEs.

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "LOCATION_REPORTING", this parameter may be included to indicate the area within which the AF requests the area event of the target UE. (NOTE 12)

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to

| Number_of_UEs_in_an_area_notification_5G, eLCS, UAV | + +| | | | | | +|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | "AREA_OF_INTEREST", this parameter shall be included to indicate the area within which the AF requests the presence status of a specific UAV. | | +|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | +|-----------------------|------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| dddTraDescriptors | array(DddTraffic Descriptor) | 0..N | The traffic descriptor(s) of the downlink data source. May be included for event "DOWNLINK_DATA_DELIVERY_STATUS" or "AVAILABILITY_AFTER_DDN_FAILURE". | Downlink_data_delivery_status_5G, Availability_after_DDN_failure_notification_enhancement | +| dddStati | array(DlDataDeliveryStatus) | 0..N | May be included for event "DOWNLINK_DATA_DELIVERY_STATUS". The subscribed stati (delivered, transmitted, buffered) for the event. If omitted all stati are subscribed. | Downlink_data_delivery_status_5G | +| monitoringEventReport | MonitoringEvent Report | 0..1 | Identifies a monitoring event report which is sent from the SCEF to the SCS/AS. | | +| apiNames | array(string) | 0..N |

If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "API_SUPPORT_CAPABILITY", this parameter may be included. Each element identifies the name of an API.

It shall set as {apiName} part of the URI structure for each T8 or N33 API as defined in the present specification or 3GPP TS 29.522 [62], respectively.

This allows the SCS/AS to request the capability change for its interested APIs. If it is omitted, the SCS/AS requests to be notified for capability change for all APIs the SCEF+NEF supports.

| API_support_capability_notification | +| tgtNsThreshold | SACInfo | 0..1 |

Indicates the monitoring threshold value, for the network slice identified by the "snssai" attribute, upon which event notification(s) are triggered.

This attribute may be provided if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTP_PDU_SESSIONS". When provided, it also indicates that threshold based reporting of the network slice status information is requested by the AF.

(NOTE 13)

| NSAC | +| nsRepFormat | SACRepFormat | 0..1 |

Indicates the requested NSAC reporting format, i.e. "PERCENTAGE" or "NUMERICAL".

It shall be provided only if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTP_PDU_SESSIONS" and periodic reporting is requested (i.e. the "repPeriod" attribute is provided instead of the "tgtNsThreshold" attribute) or one-time reporting is requested (i.e. the "maximumNumberOfReports" attribute is provided with a value of 1).

| NSAC | +| afServiceId | string | 0..1 |

Contains the identifier of a service on behalf of which the AF is sending the request.

It may be provided by an untrusted AF and only if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to

| NSAC | + +| | | | | | +|--|--|--|-------------------------------------------------------------------------|--| +| | | | either "NUM_OF_REGD_UES" or
"NUM_OF_ESTD_PDU_SESSIONS".
(NOTE 15) | | +|--|--|--|-------------------------------------------------------------------------|--| + +| | | | | | +|--------------|-----------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| +| snssai | Snssai | 0..1 | Indicates the S-NSSAI that the event monitoring subscription is targeting.

This attribute may be provided if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS".

This attribute may also be provided if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "PDN_CONNECTIVITY_STATUS" or "DOWNLINK_DATA_DELIVERY_STATUS".

(NOTE 8) (NOTE 15) (NOTE 16) | NSAC, Session_Management_Enhancement, UEId_retrieval, AppDetection_5G | +| immediateRep | boolean | 0..1 | Indicates that immediate reporting is requested or not.
- "true": indicate an immediate reporting is requested.

- "false": indicate an immediate reporting is not requested.

Default value: "false" if omitted.

This attribute may be included if the "monitoringType" attribute (or the "addnMonTypes" attribute) is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS" when the "NSAC" feature is supported. (NOTE 13)

This attribute may also be included if the SCS/AS requires immediate reporting of the subscribed event(s) when the "enNB1_5G" feature is supported. (NOTE 4) | NSAC, enNB1_5G | +| uavPolicy | UavPolicy | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "AREA_OF_INTEREST", this parameter may be included to indicate the 3GPP network to take corresponding action. | UAV | +| subType | SubType | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included to indicate the subscription type to be listed in the Event report.

(NOTE 14) | UAV | +| sesEstInd | boolean | 0..1 | If "monitoringType" attribute (or the "addnMonTypes" attribute) is set to "NUMBER_OF_UES_IN_AN_AREA", this parameter may be included.
If set to "true", it indicates that only UE's with "PDU session established for DNN(s) subject to aerial service" are to be listed in the Event report.

If set to "false", it indicates that UE's with "PDU session established for DNN(s) subject to aerial service" are not to be listed in the Event report.

Default: "false" if omitted. | UAV | + +| | | | | | +|--|--|--|-----------|--| +| | | | (NOTE 14) | | +|--|--|--|-----------|--| + +| | | | | | +|---------------------|-------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| addnMonTypes | array(Monitoring Type) | 0..N | Represents additional monitoring types.
(NOTE 17) | enNB | +| addnMonEventReports | array(Monitoring EventReport) | 0..N | Additional monitoring event reports. May only be provided if the "addnMonTypes" attribute is provided in the corresponding subscription creation/update request. | enNB | +| uelpAddr | lpAddr | 0..1 | UE IP address. | UEId_retrieval | +| ueMacAddr | MacAddr48 | 0..1 | UE MAC address. | UEId_retrieval | +| revocationNotifUri | Uri | 0..1 | Contains the URI via which the AF desires to receive user consent revocation notifications. | UserConsentRevocation | +| reqRangingSIRes | array(RangingSI Result) | 1..N | Contains the type of result requested for ranging and sidelink positioning. | Ranging_SL | +| relatedUEs | array(RelatedUE ) | 1..N | Contains a list of the information for the related UEs for the ranging and sidelink positioning. | Ranging_SL | + +NOTE 1: One of the properties "externalId", "msisdn", "ipv4Addr", "ipv6Addr" or "externalGroupId" shall be included for features "Location\_notification" and "Communication\_failure\_notification". One of the properties "externalId", "msisdn" or "externalGroupId" shall be included for feature "eLCS". "ipv4Addr" or "ipv6Addr" is required for monitoring via the PCRF for an individual UE. One of the properties "externalId", "msisdn" or "externalGroupId" shall be included for features "Pdn\_connectivity\_status", "Loss\_of\_connectivity\_notification", "Ue-reachability\_notification", "Change\_of\_IMSI\_IMEI\_association\_notification", "Roaming\_status\_notification", "Availability\_after\_DDN\_failure\_notification" and "Availability\_after\_DDN\_failure\_notification\_enhancement". The property "externalGroupId" shall be included for the "GMEC" feature to subscribe to the group member list change event reporting. + +NOTE 2: Inclusion of either "maximumNumberOfReports" (with a value higher than 1) or "monitorExpireTime" makes the Monitoring Request a Continuous Monitoring Request, where the SCEF sends Notifications until either the maximum number of reports or the monitoring duration indicated by the property "monitorExpireTime" is exceeded. The "maximumNumberOfReports" with a value 1 makes the Monitoring Request a One-time Monitoring Request. At least one of "maximumNumberOfReports" or "monitorExpireTime" shall be provided. + +NOTE 3: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +NOTE 4: In this release, for features "Number\_of\_UEs\_in\_an\_area\_notification" and "Number\_of\_UEs\_in\_an\_area\_notification\_5G", locationType shall be set to "LAST\_KNOWN\_LOCATION". For 5G, if the "locationType" attribute sets to "LAST\_KNOWN\_LOCATION", the "maximumNumberOfReports" attribute shall set to 1 as a One-time Monitoring Request. For 5G, when the "enNB1\_5G" feature is supported and the "immediateRep" attribute is present set to "true" and outside the scope of the "NSAC" feature, then the "locationType" shall be set to "LAST\_KNOWN\_LOCATION"; when the "immediateRep" is present set to "false" and outside the scope of the "NSAC" feature, then the "locationType" shall be set to "CURRENT\_LOCATION". + +NOTE 5: The property does not apply for the features "Number\_of\_UEs\_in\_an\_area\_notification" and "Number\_of\_UEs\_in\_an\_area\_notification\_5G". + +NOTE 6: For the features "Number\_of\_UEs\_in\_an\_area\_notification" and "Number\_of\_UEs\_in\_an\_area\_notification\_5G", the property "externalGroupId" may be included for single group and "addExtGroupIds" may be included for multiple groups but not both. + +NOTE 7: The SCEF should check received MTC provider identifier and then the SCEF may: + +- override it with local configured value and send it to HSS; +- send it directly to the HSS; or +- reject the monitoring configuration request. + +NOTE 8: This property is only applicable for the NEF. + +NOTE 9: The value of the "maximumNumberOfReports" attribute sets to 1 and the "repPeriod" attribute are mutually exclusive. + +NOTE 10: If the "eLCS" feature is supported, the "accuracy" attribute and "locQoS" attribute are mutually exclusive, and only the "GEO\_AREA" value is applicable for the "accuracy" attribute. + +NOTE 11: The value of "TWAN\_ID" is only applicable when the monitoring subscription is via the PCRF as described in clause 4.4.2.2.4. + +NOTE 12: If the "eLCS" feature is supported, only the "geographicAreas" attribute within the "locationArea5G" attribute is applicable. + +NOTE 13: For the "NSAC" feature, if the "maximumNumberOfReports" attribute is provided with a value of 1, the "repPeriod" attribute and the "tgtNsThreshold" attribute shall not be provided and the "immediateRep" attribute shall be provided and set to true; otherwise, either the "repPeriod" attribute or the "tgtNsThreshold" attribute shall be provided, and if immediate reporting is requested, the "immediateRep" attribute shall be provided and set to true. + +NOTE 14: For the feature "UAV", the event "Number of UEs present in a geographical area" is used, where "subType" indication and/or "sesEstInd" may be used as event filters. + +NOTE 15: For the "NSAC" feature, the "snssai" and "afServiceId" attributes are mutually exclusive. + +NOTE 16: For the "AppDetection\_5G" feature, AF shall provide the "appId" attribute along with "snssai" and "dnn" attributes for subscription of application traffic detection event notification. the subscription request applies to all the UEs associated with the "snssai" and the "dnn" provided in the request. + +NOTE 17: When the "enNB" feature is supported and the "addnMonTypes" attribute is present and contains at least one array element, then this attribute shall not contain an array element set to the same value as the "monitoringType" attribute. + +#### 5.3.2.1.3 Void + +### 5.3.2.2 Notification data types + +#### 5.3.2.2.1 Introduction + +This clause defines data structures to be used in notifications. + +#### 5.3.2.2.2 Type: MonitoringNotification + +This data type represents a monitoring notification which is sent from the SCEF to the SCS/AS. + +**Table 5.3.2.2.2-1: Definition of type MonitoringNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------|-------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| subscription | Link | 1 | Link to the subscription resource to which this notification is related. | | +| configResults | array(ConfigResult) | 0..N | Each element identifies a notification of grouping configuration result. | | +| monitoringEventReports | array(MonitoringEventReport) | 0..N | Each element identifies a monitoring event report. | | +| addedExternalIds | array(ExternalId) | 0..N | Identifies the added external Identifier(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type. | Partial_group_modification | +| addedMsisdns | array(Msisdn) | 0..N | Identifies the added MSISDN(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type. | Partial_group_modification | +| cancelExternalIds | array(ExternalId) | 0..N | Identifies the cancelled external Identifier(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data type. | Partial_group_modification | +| cancelInd | Boolean | 0..1 | Indicates whether to request to cancel the corresponding monitoring subscription. Set to false or omitted otherwise. | | +| cancelMsisdns | array(Msisdn) | 0..N | Identifies the cancelled MSISDN(s) within the active group via the "externalGroupId" attribute within the MonitoringEventSubscription data. | Partial_group_modification | +| appliedParam | AppliedParameterConfiguration | 0..1 | Indicates the applied parameter configuration in the network. For the attributes included in AppliedParameterConfiguration data type, the "maximumLatency" and "maximumResponseTime" attributes require the "Ue-reachability_notification" feature support, and the "maximumDetectionTime" attribute requires the "Loss_of_connectivity_notification" feature support. | Enhanced_param_config | + +NOTE: Properties marked with a feature as defined in subclause 5.3.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features. + +### 5.3.2.3 Referenced structured data types + +#### 5.3.2.3.1 Introduction + +This clause defines structured data types that are referenced from data structures defined in the previous clauses. + +#### 5.3.2.3.2 Type: MonitoringEventReport + +This data type represents a monitoring event notification which is sent from the SCEF to the SCS/AS. + +**Table 5.3.2.3.2-1: Definition of type MonitoringEventReport** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-----------------------|-----------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| imeiChange | AssociationType | 0..1 | If "monitoringType" is "CHANGE_OF_IMSI_IMEI_ASSOCIATION", this parameter shall be included to identify the event of change of IMSI-IMEI or IMSI-IMEISV association is detected.
Refer to 3GPP TS 29.336 [11] Clause 8.4.22. | Change_of_IMSI_IMEI_association_notification | +| externalId | ExternalId | 0..1 | External identifier.
This attribute may also be present in the monitoring event subscription one-time response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "uelpAddr" attribute or the "ueMacAddr" attribute.
(NOTE 2) | | +| appId | string | 0..1 | Represents the detected application. | AppDetection_5G | +| pduSessInfo | PduSessionInformation | 0..1 | Represents PDU session information related to the observed event.
If "monitoringType" is "APPLICATION_START" and/or "APPLICATION_STOP", this parameter may be included to indicate the Application traffic detection details. | AppDetection_5G | +| idleStatusInfo | IdleStatusInfo | 0..1 | If "idleStatusIndication" in the "MonitoringEventSubscription" sets to "true", this parameter shall be included to indicate the information when the UE transitions into idle mode. | Ue-reachability_notification, Availability_after_DDN_failure_notification | +| locationInfo | LocationInfo | 0..1 | If "monitoringType" is "LOCATION_REPORTING", this parameter shall be included to indicate the user location related information. | Location_notification, eLCS | +| locFailureCause | LocationFailureCause | 0..1 | Indicates the location positioning failure cause. | eLCS | +| lossOfConnectReason | integer | 0..1 | If "monitoringType" is "LOSS_OF_CONNECTIVITY", this parameter shall be included if available to identify the reason why loss of connectivity is reported.
Refer to 3GPP TS 29.336 [11] Clause 8.4.58. | Loss_of_connectivity_notification | +| unavailPerDur | DurationSec | 0..1 | If "monitoringType" is "LOSS_OF_CONNECTIVITY", then this parameter shall be included if available to identify the UE's Unavailability Period Duration. | Loss_of_connectivity_notification_5G | +| maxUEAvailabilityTime | DateTime | 0..1 | If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify the timestamp until which a UE using a power saving mechanism is expected to be reachable for SM delivery. | Ue-reachability_notification | + +| | | | | | +|--|--|--|-----------------------------------------------------|--| +| | | | Refer to Clause 5.3.3.22 of
3GPP TS 29.338 [34]. | | +|--|--|--|-----------------------------------------------------|--| + +| | | | | | +|---------------------|----------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| msisdn | Msisdn | 0..1 | Identifies the MS internal PSTN/ISDN number.
(NOTE 2) | | +| monitoringType | MonitoringType | 1 | Identifies the type of monitoring type as defined in clause 5.3.2.4.3. | | +| uePerLocationReport | UePerLocationReport | 0..1 | If "monitoringType" is "NUMBER_OF_UES_IN_AN_ARE A", this parameter shall be included to indicate the number of UEs found at the location.
If "subType" indicates "AERIAL_UE" subscription type, this parameter shall be included to indicate the number of UAV's found at the location. | Number_of_U Es_in_an_are a_notification, Number_of_U Es_in_an_are a_notification _5G | +| plmnId | PlmnId | 0..1 | If "monitoringType" is "ROAMING_STATUS" and "plmnIndication" in the "MonitoringEventSubscription" sets to "true", this parameter shall be included to indicate the UE's serving PLMN. | Roaming_stat us_notification n | +| reachabilityType | ReachabilityType | 0..1 | If "monitoringType" is "UE_REACHABILITY", this parameter shall be included to identify the reachability of the UE.
Refer to 3GPP TS 29.336 [11] Clause 8.4.20. | Ue- reachability_n otification | +| roamingStatus | boolean | 0..1 | If "monitoringType" is "ROAMING_STATUS", this parameter shall be set to "true" if the new serving PLMN is different from the HPLMN. Set to false or omitted otherwise. | Roaming_stat us_notification n | +| failureCause | FailureCause | 0..1 | If "monitoringType" is "COMMUNICATION_FAILURE", this parameter shall be included to indicate the reason of communication failure. | Communicati on_failure_no tification | +| eventTime | DateTime | 0..1 | Identifies when the event is detected or received.
Shall be included for each group of UEs. | | +| pdnConnInfoList | array(PdnConnectionInf ormation) | 0..N | If "monitoringType" is "PDN_CONNECTIVITY_STATUS", this parameter shall be included to indicate the PDN connection details. | Pdn_connecti vity_status | +| dddStatus | DIDataDeliveryStatus | 0..1 | If "monitoringType" is "DOWNLINK_DATA_DELIVERY_S TATUS", this parameter shall be included to identify the downlink data delivery status detected by the network. | Downlink_dat a_delivery_st atus_5G | +| dddTrafDescriptor | DddTrafficDescriptor | 0..1 | If "monitoringType" is "DOWNLINK_DATA_DELIVERY_S TATUS", this parameter shall be included to identify the downlink data descriptor impacted by the downlink data delivery status change. | Downlink_dat a_delivery_st atus_5G | +| maxWaitTime | DateTime | 0..1 | If "monitoringType" is "DOWNLINK_DATA_DELIVERY_S | Downlink_dat a_delivery_st | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| | | | TATUS", this parameter may be included to identify the time before which the data will be buffered. | atus_5G | +| apiCaps | array(ApiCapabilityInfo) | 0..N | If "monitoringType" is "API_SUPPORT_CAPABILITY", this parameter shall be included to indicate the availability of all APIs supported by the serving network or the availability of interested APIs, indicated by the "apiNames" attribute in "MonitoringEventSubscription", supported by the serving network.
If no API is supported by the serving network, an empty apiCaps shall be provided. | API_support_capability_notification | +| nSStatusInfo | SACEventStatus | 0..1 | If the "monitoringType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this parameter shall be included to indicate the current network slice status information for the concerned network slice.
(NOTE 3) | NSAC | +| afServiceId | string | 0..1 | Contains the identifier of the service to which the NSAC reporting is related.

It shall be provided only if it is present in the related NSAC subscription request and the "monitoringType" attribute is set to either "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS". | NSAC | +| servLevelDevId | string | 0..1 | If "monitoringType" is "AREA_OF_INTEREST" or "NUMBER_OF_UES_IN_AN_AREA" and "subType" indicate "AERIAL_UE", this parameter may be included to identify the UAV. | UAV | +| uavPresInd | boolean | 0..1 | If "monitoringType" is "AREA_OF_INTEREST", this parameter shall be set to true if the specified UAV is in the monitoring area. Set to false or omitted otherwise. | UAV | +| groupMembListChanges | GroupMembListChanges | 0..1 | Contains information on the change(s) to the group member list.

This attribute shall be present only if the "monitoringType" attribute is set to "GROUP_MEMBER_LIST_CHANGE". | GMEC | +| NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | +| NOTE 2: Identifies the user for which the event occurred. At least one of the properties shall be included. | | | | | +| NOTE 3: If the "eNSAC" feature is supported, the "SACEventStatus" data type shall include an indication to report either the current number of registered UEs or the current number of UEs with at least one PDU session/PDN connection. | | | | | + +### 5.3.2.3.3 Type: IdleStatusInfo + +This data type represents the information when the UE transitions into idle mode. It is sent from the SCEF to the SCS/AS. + +**Table 5.3.2.3.3-1: Definition of type IdleStatusInfo** + +| Attribute name | Data type | Cardinality | Description | +|---------------------------|-------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| activeTime | DurationSec | 0..1 | Identifies the active time granted to the UE. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". | +| edrxCycleLength | number | 0..1 | Identifies the power saving interval in unit of seconds. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". | +| suggestedNumberOfDPackets | integer | 0..1 | Identifies the number of packets shall be buffered in the serving gateway. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". | +| idleStatusTimestamp | DateTime | 0..1 | Identifies the timestamp at which the UE transitions into idle mode. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". | +| periodicAUTimer | DurationSec | 0..1 | Identifies the subscribed periodic RAU/TAU timer value. It shall be present if the idle status indication is requested by the SCS/AS with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". | + +### 5.3.2.3.4 Type: UePerLocationReport + +This data type represents the number of UEs found at the indicated location information. It is sent from the SCEF to the SCS/AS. + +**Table 5.3.2.3.4-1: Definition of type UePerLocationReport** + +| Attribute name | Data type | Cardinality | Description | +|---------------------------------------------------------------------------|-------------------|-------------|----------------------------------------------------------------------------------------| +| ueCount | integer | 1 | Identifies the number of UEs. | +| externalIds | array(ExternalId) | 0..N | Each element uniquely identifies a user.
(NOTE) | +| msisdns | array(Msisdn) | 0..N | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE) | +| servLevelDevIds | array(string) | 0..N | Each element uniquely identifies a UAV. | +| NOTE: The property shall be included if received from the MME(s)/SGSN(s). | | | | + +### 5.3.2.3.5 Type: LocationInfo + +This data type represents the user location information which is sent from the SCEF to the SCS/AS. + +**Table 5.3.2.3.5-1: Definition of LocationInfo data Type** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|---------------------------|------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| ageOfLocationInfo | DurationMin | 0..1 | Indicates the elapsed time since the last network contact of the UE.

Refer to the Age-Of-Location-Information AVP as defined in clause 7.3.126 of 3GPP TS 29.272 [33]. | | +| cellId | string | 0..1 | Indicates the Cell Global Identification of the user which identifies the cell the UE is registered.
Refer to the Cell-Global-Identity AVP or E-UTRAN-Cell-Global-Identity AVP as defined in clause 7.3.119 or clause 7.3.117 of 3GPP TS 29.272 [33]. (NOTE 2) | | +| eNodeBId | string | 0..1 | Indicates the eNodeB in which the UE is currently located.
Refer to the eNodeB-ID AVP or Extended-eNodeB-ID AVP as defined in clause 7.3.198 or clause 7.3.218 of 3GPP TS 29.272 [33]. | | +| routingAreaId | string | 0..1 | Identifies the Routing Area Identity of the user where the UE is located.
Refer to the Routing-Area-Identity AVP as defined in clause 7.3.120 of 3GPP TS 29.272 [33]. | | +| trackingAreaId | string | 0..1 | Identifies the Tracking Area Identity of the user where the UE is located.
Refer to the Tracking-Area-Identity AVP as defined in clause 7.3.118 of 3GPP TS 29.272 [33]. (NOTE 3) | | +| plmnId | string | 0..1 | Identifies the PLMN Identity of the user where the UE is located.
Refer to the Visited-PLMN-Id AVP as defined in clause 7.3.9 of 3GPP TS 29.272 [33]. | | +| twanId | string | 0..1 | Identifies the TWAN Identity of the user where the UE is located. | | +| userLocation | UserLocation | 0..1 | Contains UE location information. (NOTE 4) | enNB1 | +| geographicArea | GeographicArea | 0..1 | Identifies a geographic area of the user where the UE is located. | | +| civicAddress | CivicAddress | 0..1 | The civic address of the target UE. | eLCS | +| positionMethod | PositioningMethod | 0..1 | Identifies the positioning method used to obtain the location estimate of the UE, if it is available at the LCS server and if needed. | eLCS,
Ranging_SL | +| qosFulfillInd | AccuracyFulfillmentIndicator | 0..1 | Represents whether the requested accuracy is fulfilled or not.
(NOTE 1) | eLCS,
Ranging_SL | +| ueVelocity | VelocityEstimate | 0..1 | UE velocity, if requested and available | eLCS,
Ranging_SL | +| ldrType | LdrType | 0..1 | The IE may be included to indicate the type of event that triggers event notification. | eLCS | +| achievedQos | MinorLocationQoS | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received. | MULTIQOS | +| relatedApplicationLayerId | ApplicationLayerId | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | 0..1 | Identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| twodrelativeLocation | TwodrelativeLocation | 0..1 | Identifies a relative 2D location with uncertainty ellipse, characterised by a point | Ranging_SL | + +| | | | | | +|------------------------|------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | | +| threeDrelativeLocation | ThreeDrelativeLocation | 0..1 | Identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | 0..1 | UE velocity relative to the UE identified with relatedApplicationLayerId. | Ranging_SL | +| upCumEvtRep | UpCumEvtRep | 0..1 | Contains the cumulative event report for events reported via user plane. | eLCS_en | + +NOTE 1: For the eLCS feature, if "reportingLocEstInd" attribute is set to false or omitted during the monitoring event request, the location estimation information shall not be included. Otherwise, if the "reportingLocEstInd" attribute is set to true, and + +- if the "qosFulfillInd" attribute is set to "REQUESTED\_ACCURACY\_FULFILLED", the location estimate information may be included if the "lcsQosClass" attribute within the "locQoS" attribute is set to "BEST\_EFFORT"; or +- if the "qosFulfillInd" attribute is set to "REQUESTED\_ACCURACY\_NOT\_FULFILLED", the location estimate shall not be included if the "lcsQosClass" attribute within "locQoS" attribute is set to "ASSURED". + +NOTE 2: For NEF, the context of the property shall refer to the Ecgi or Ncgi data type as defined in clause 5.4.4.5 or clause 5.4.4.6 of 3GPP TS 29.571 [45]. + +NOTE 3: For NEF, the context of the property shall refer to the Tai data type as defined in clause 5.4.4 of 3GPP TS 29.571 [45]. + +NOTE 4: When the enNB1 feature is supported, the "userLocation" attribute may be provided instead of the "ageOfLocationInfo", "cellId", "encodeBld", "routingAreaId", "trackingAreaId", "plmnId" and "twanId" attributes, when applicable. + +### 5.3.2.3.6 Type: FailureCause + +This data type represents the reason of communication failure. It shall comply with the provisions defined in table 5.3.2.3.6-1. + +**Table 5.3.2.3.6-1: Definition of type FailureCause** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bssgpCause | integer | 0..1 | Identifies a non-transparent copy of the BSSGP cause code.
Refer to 3GPP TS 29.128 [12]. | +| causeType | integer | 0..1 | Identify the type of the S1AP-Cause.
Refer to 3GPP TS 29.128 [12]. | +| gmmCause | integer | 0..1 | Identifies a non-transparent copy of the GMM cause code.
Refer to 3GPP TS 29.128 [12]. | +| ranapCause | integer | 0..1 | Identifies a non-transparent copy of the RANAP cause code.
Refer to 3GPP TS 29.128 [12]. | +| ranNasCause | string | 0..1 | Indicates RAN and/or NAS release cause code information, TWAN release cause code information or untrusted WLAN release cause code information.
Refer to 3GPP TS 29.214 [10].
(NOTE) | +| s1ApCause | integer | 0..1 | Identifies a non-transparent copy of the S1AP cause code.
Refer to 3GPP TS 29.128 [12]. | +| smCause | integer | 0..1 | Identifies a non-transparent copy of the SM cause code.
Refer to 3GPP TS 29.128 [12]. | + +NOTE: If this property is provided in the "FailureCause" type, then other properties shall not be provided. + +### 5.3.2.3.7 Type: PdnConnectionInformation + +This data type represents the PDN connection information of the UE. + +**Table 5.3.2.3.7-1: Definition of type PdnConnectionInformation** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|----------------|---------------------|-------------|--------------------------------------------------------------------------------------------------------------------------|------------------------| +| status | PdnConnectionStatus | 1 | Identifies the PDN connection status. | | +| apn | string | 0..1 | Identifies the APN, it is depending on the SCEF local configuration whether or not this attribute is sent to the SCS/AS. | | +| pdnType | PdnType | 1 | PDN type | | +| interfaceInd | InterfaceIndication | 0..1 | Identifies the 3GPP network function used to communicate with the SCS/AS for non-IP PDN type. | | +| ipv4Addr | Ipv4Addr | 0..1 | Identifies the UE Ipv4 address. | | +| ipv6Addrs | array(Ipv6Addr) | 0..N | Identifies the UE Ipv6 address.
(NOTE 2) | | +| macAddrs | array(MacAddr48) | 0..N | Identifies the UE MAC address(es) which is only available for the immediate report. | | + +NOTE 1: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: ipv6 prefix is included in this attribute if ipv6 full address is not available. + +### 5.3.2.3.8 Type: AppliedParameterConfiguration + +This data type represents the applied parameter configuration in the network. + +**Table 5.3.2.3.8-1: Definition of type AppliedParameterConfiguration** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------------|-------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| externalIds | array(ExternalId) | 0..N | Each element uniquely identifies a user.
(NOTE) | | +| msisdns | array(Msisdn) | 0..N | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE) | | +| maximumLatency | DurationSec | 0..1 | This parameter may be included to identify the maximum delay acceptable for downlink data transfers, which is applied in the network. | | +| maximumResponseTime | DurationSec | 0..1 | This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data, which is applied in the network. | | +| maximumDetectionTime | DurationSec | 0..1 | This parameter may be included to identify the maximum period of time after which the UE is considered to be unreachable, which is applied in the network. | | + +NOTE: If both are omitted, it means the change applies for the whole configuration (i.e. a single UE or a group of UEs). + +### 5.3.2.3.9 Type: ApiCapabilityInfo + +This data type represents the availability information of a supported API. + +**Table 5.3.2.3.9-1: Definition of type ApiCapabilityInfo** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiName | string | 1 | Identifies the name of an available API provided by the SCEF+NEF. It shall set as {apiName} part of the URI structure for each T8 or N33 API as defined in the present specification or 3GPP TS 29.522 [62], respectively. | | +| suppFeat | SupportedFeatures | 1 | Indicates all the features supported by the API in the serving network, which provided by the SCEF+NEF. | | + +## 5.3.2.3.10 Type: MonitoringEventReports + +**Table 5.3.2.3.10-1: Definition of type MonitoringEventReports** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------|------------------------------|-------------|---------------------------------------------|----------------------| +| monitoringEventReports | array(MonitoringEventReport) | 1..N | Contains a set of event monitoring reports. | | + +NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +## 5.3.2.3.11 Type: UavPolicy + +This data type represents the policy information included in the UAV presence monitoring request. + +**Table 5.3.2.3.11-1: Definition of type UavPolicy** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-----------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uavMoveInd | boolean | 1 | Indicates the UAV moves in or moves out of the Area of Interest. Set to true if the UAV moves in the Area of Interest. Set to false if the UAV moves out of the Area of Interest. | | +| revokeInd | boolean | 1 | Indicates whether the connectivity between UAV and UAV controller shall be revoked. If set to true, the connectivity between UAV and UAV controller shall be revoked. Set to false otherwise. | | + +## 5.3.2.3.11 Type: ConsentRevocNotif + +**Table 5.3.2.3.11-1: Definition of type ConsentRevocNotif** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|-----------------|-----------------------|-------------|-----------------------------------------------------------------------------------|---------------| +| subscriptionId | string | 1 | Contains the identifier of the subscription to which the notification is related. | | +| consentsRevoked | array(ConsentRevoked) | 1..N | Indicates the revoked user consents. | | + +## 5.3.2.3.12 Type: ConsentRevoked + +**Table 5.3.2.3.12-1: Definition of type ConsentRevoked** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|------------|-------------|------------------------------------------------------------------------------------|---------------| +| ucPurpose | UcPurpose | 1 | Identifies the purpose of the revoked user consent. | | +| externalId | ExternalId | 0..1 | Indicates the user(s) for which user consent was revoked.
(NOTE) | | +| msisdn | Msisdn | 0..1 | Indicates the MSISDN(s) of the users for which user consent was revoked.
(NOTE) | | + +NOTE: One of the "externalId", or "msisdn" attributes shall be present. + +## 5.3.2.3.13 Type: GroupMembListChanges + +**Table 5.3.2.3.13-1: Definition of type GroupMembListChanges** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-------------|-------------|----------------------------------------------|---------------| +| addedUEs | array(Gpsi) | 1..N | Identifies the UE(s) added to the group. | | +| removedUEs | array(Gpsi) | 1..N | Identifies the UE(s) removed from the group. | | + +NOTE: At least one of the "addedUEs" attributes and the "removedUEs" attribute shall be provided. + +## 5.3.2.3.14 Type: RangeDirection + +**Table 5.3.2.3.14-1: Definition of type RangeDirection** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|--------------------|-----------|-------------|-------------------------------------------------------------|---------------| +| range | number | 1 | Identifies the distance from point A to point B. | | +| azimuthDirection | Angle | 1 | Identifies the azimuth direction from point A to point B. | | +| elevationDirection | Angle | 1 | Identifies the elevation direction from point A to point B. | | + +## 5.3.2.3.15 Type: TwodrelativeLocation + +**Table 5.3.2.3.15-1: Definition of type TwodrelativeLocation** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|------------------|-------------|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| orientationAngle | Angle | 1 | Identifies the angle of orientation A. | | + +## 5.3.2.3.16 Type: ThreedrelativeLocation + +**Table 5.3.2.3.16-1: Definition of type ThreedrelativeLocation** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|---------------------|-------------|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| verticalUncertainty | Uncertainty | 1 | Indicates the vertical uncertainty. | | +| orientationAngle | Angle | 1 | Identifies the angle of orientation A. | | + +### 5.3.2.3.17 Type: UpLocRepAddrAfRm + +**Table 5.3.2.3.17-1: Definition of type UpLocRepAddrAfRm** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-----------------|-------------|--------------------------------------------------------|---------------| +| ipv4Addrs | array(Ipv4Addr) | 1..N | Contains the IPv4 address(es) of the target.
(NOTE) | | +| ipv6Addrs | array(Ipv6Addr) | 1..N | Contains the IPv6 address(es) of the target.
(NOTE) | | +| fqdn | Fqdn | 0..1 | Contains the FQDN of the target.
(NOTE) | | + +NOTE: At least one of these attributes shall be present. + +### 5.3.2.3.18 Type: UpCumEvtRep + +**Table 5.3.2.3.18-1: Definition of type UpCumEvtRep** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-----------|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| upLocRepStat | UInteger | 0..1 | Contains the number of location event reports transferred over user plane since the last cumulative event report was sent. | | + +## 5.3.2.4 Referenced simple data types and enumerations + +### 5.3.2.4.1 Introduction + +This clause defines simple data types and enumerations that are referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +### 5.3.2.4.2 Simple data types + +The simple data types defined in table 5.3.2.4.2-1 shall be supported. + +**Table 5.3.2.4.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | + +### 5.3.2.4.3 Enumeration: MonitoringType + +The enumeration MonitoringType represents a monitoring event type. It shall comply with the provisions defined in table 5.3.2.4.3-1. + +**Table 5.3.2.4.3-1: Enumeration MonitoringType** + +| Enumeration value | Description | Applicability (NOTE 1) | +|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| LOSS_OF_CONNECTIVITY | The SCS/AS requests to be notified when the 3GPP network detects that the UE is no longer reachable for signalling or user plane communication | Loss_of_connectivity_notification | +| UE_REACHABILITY | The SCS/AS requests to be notified when the UE becomes reachable for sending either SMS or downlink data to the UE | Ue-reachability_notification | +| LOCATION_REPORTING | The SCS/AS requests to be notified of the current location or the last known location of the UE | Location_notification, eLCS | +| CHANGE_OF_IMSI_IMEI_ASSOCIATION | The SCS/AS requests to be notified when the association of an ME (IMEI(SV)) that uses a specific subscription (IMSI) is changed | Change_of_IMSI_IMEI_association_notification | +| ROAMING_STATUS | The SCS/AS queries the UE's current roaming status and requests to get notified when the status changes | Roaming_status_notification | +| COMMUNICATION_FAILURE | The SCS/AS requests to be notified of communication failure events | Communication_failure_notification | +| AVAILABILITY_AFTER_DDN_FAILURE | The SCS/AS requests to be notified when the UE has become available after a DDN failure | Availability_after_DDN_failure_notification,
Availability_after_DDN_failure_notification_enhancement | +| NUMBER_OF_UES_IN_AN_AREA | The SCS/AS requests to be notified the number of UEs in a given geographic area | Number_of_UEs_in_an_area_notification,
Number_of_UEs_in_an_area_notification_5G | +| PDN_CONNECTIVITY_STATUS | The SCS/AS requests to be notified when the 3GPP network detects that the UE's PDN connection is set up or torn down. | Pdn_connectivity_status | +| DOWNLINK_DATA_DELIVERY_STATUS | The AF requests to be notified when the 3GPP network detects that the downlink data delivery status is changed. | Downlink_data_delivery_status_5G | +| API_SUPPORT_CAPABILITY | The SCS/AS requests to be notified of the availability of support of service APIs. | API_support_capability_notification | +| NUM_OF_REGD_UES | The AF requests to be notified of the current number of registered UEs for a network slice. | NSAC | +| NUM_OF_ESTD_PDU_SESSIONS | The AF requests to be notified of the current number of established PDU Sessions for a network slice. | NSAC | +| AREA_OF_INTEREST | The SCS/AS requests to be notified when the UAV moves in or out of the geographic area. | UAV | +| GROUP_MEMBER_LIST_CHANGE | The AF requests to be notified of the changes to a group members list. | GMEC | +| APPLICATION_START | The AF requests to be notified about the start of application traffic has been detected. | AppDetection_5G | +| APPLICATION_STOP | The AF requests to be notified about the stop of application traffic has been detected. | AppDetection_5G | + +NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: More monitoring types can be added in the future based on stage 2. + +#### 5.3.2.4.4 Enumeration: ReachabilityType + +The enumeration ReachabilityType represents a reachability type. It shall comply with the provisions defined in table 5.3.2.4.4-1. If reachabilityType set to "SMS", the monitoring event request from SCS/AS shall be only for one-time monitoring request. + +**Table 5.3.2.4.4-1: Enumeration ReachabilityType** + +| Enumeration value | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------| +| SMS | The SCS/AS requests to be notified when the UE becomes reachable for sending SMS to the UE | Ue-reachability_notification | +| DATA | The SCS/AS requests to be notified when the UE becomes reachable for sending downlink data to the UE | Ue-reachability_notification | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.5 Enumeration: LocationType + +The enumeration LocationType represents a location type. It shall comply with the provisions defined in table 5.3.2.4.5-1. If locationType set to "LAST\_KNOWN\_LOCATION", the monitoring event request from SCS/AS shall be only for one-time monitoring request. + +**Table 5.3.2.4.5-1: Enumeration LocationType** + +| Enumeration value | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| +| CURRENT_LOCATION | The SCS/AS requests to be notified for current location | Location_notification, eLCS | +| LAST_KNOWN_LOCATION | The SCS/AS requests to be notified for last known location | Location_notification, Number_of_UEs_in_an_area_notification, Number_of_UEs_in_an_area_notification_5G | +| CURRENT_OR_LAST_KNOWN_LOCATION | The AF requests the current or last known location. | eLCS | +| INITIAL_LOCATION | The AF requests the initial location. | eLCS | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.6 Enumeration: AssociationType + +The enumeration AssociationType represents an IMEI or IMEISV to IMSI association. It shall comply with the provisions defined in table 5.3.2.4.6-1. + +**Table 5.3.2.4.6-1: Enumeration AssociationType** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|----------------------------------------------| +| IMEI | The value shall be used when the change of IMSI-IMEI association shall be detected | Change_of_IMSI_IMEI_association_notification | +| IMEISV | The value shall be used when the change of IMSI-IMEISV association shall be detected | Change_of_IMSI_IMEI_association_notification | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.7 Enumeration: Accuracy + +The enumeration Accuracy represents a desired granularity of accuracy of the requested location information. It shall comply with the provisions defined in table 5.3.2.4.7-1. + +**Table 5.3.2.4.7-1: Enumeration Accuracy** + +| Enumeration value | Description | Applicability (NOTE) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|----------------------| +| CGI_ECGI | The SCS/AS requests to be notified using cell level location accuracy. | | +| ENODEB | The SCS/AS requests to be notified using eNodeB level location accuracy. | | +| TA_RA | The SCS/AS requests to be notified using TA/RA level location accuracy. | | +| PLMN | The SCS/AS requests to be notified using PLMN level location accuracy. | | +| TWAN_ID | The SCS/AS requests to be notified using TWAN identifier level location accuracy. | | +| GEO_AREA | The SCS/AS requests to be notified using the geographical area accuracy. | | +| CIVIC_ADDR | The SCS/AS requests to be notified using the civic address accuracy. | EDGEAPP | +| NOTE 1: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.8 Enumeration: PdnConnectionStatus + +The enumeration PdnConnectionStatus represents the PDN connection status. It shall comply with the provisions defined in table 5.3.2.4.8-1. + +**Table 5.3.2.4.8-1: Enumeration PdnConnectionStatus** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-------------------------| +| CREATED | The PDN connection is created. | Pdn_connectivity_status | +| RELEASED | The PDN connection is released. | Pdn_connectivity_status | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.9 Enumeration: PdnType + +The enumeration PdnType represents the PDN connection type. It shall comply with the provisions defined in table 5.3.2.4.9-1. + +**Table 5.3.2.4.9-1: Enumeration PdnType** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------| +| IPv4 | PDN connection of IPv4 type | | +| IPv6 | PDN connection of IPv6 type | | +| IPv4V6 | PDN connection of IPv4v6 type | | +| NON_IP | PDN connection of non-IP type | | +| ETHERNET | PDN connection of Ethernet type | | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.3.2.4.10 Enumeration: InterfaceIndication + +The enumeration InterfaceIndication represents the network entity used for data delivery towards the SCS/AS. It shall comply with the provisions defined in table 5.3.2.4.10-1. + +**Table 5.3.2.4.10-1: Enumeration InterfaceIndication** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------|----------------------------------------------------------------|-------------------------| +| EXPOSURE_FUNCTION | SCEF is used for the PDN connection towards the SCS/AS. | Pdn_connectivity_status | +| PDN_GATEWAY | PDN gateway is used for the PDN connection towards the SCS/AS. | Pdn_connectivity_status | + +NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.3.2.4.11 Enumeration: LocationFailureCause + +The enumeration **LocationFailureCause** represents the cause of location positioning failure. It shall comply with the provisions defined in table 5.3.2.4.11-1. **Table 5.3.2.4.11-1: Enumeration LocationFailureCause** + +| Enumeration value | Description | Applicability | +|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "POSITIONING_DENIED" | Positioning is denied. | | +| "UNSUPPORTED_BY_UE" | Positioning is not supported by UE. | | +| "NOT_REGISTERED_UE" | UE is not registered. | | +| "UNSPECIFIED" | Unspecified. | | +| "REQUESTED_AREA_NOT_ALLOWED" | The location request is rejected because the location area requested by the AF for area event reporting is not allowed (e.g., does not overlap with the allowed location areas for area event reporting). | eLCS_en | + +#### 5.3.2.4.12 Enumeration: SubType + +The enumeration **SubType** represents a subscription type. It shall comply with the provisions defined in table 5.3.2.4.12-1 + +**Table 5.3.2.4.12-1: Enumeration SubType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| AERIAL_UE | The UE has Aerial subscription. | UAV | + +#### 5.3.2.4.13 Enumeration: SACRepFormat + +**Table 5.3.2.4.13-1: Enumeration SACRepFormat** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------|---------------| +| "NUMERICAL" | Indicates that the NSAC reporting should be done in numerical format. | | +| "PERCENTAGE" | Indicates that the NSAC reporting should be done in the format of a percentage. | | + +### 5.3.3 Resource structure + +#### 5.3.3.1 General + +All resource URIs of this API should have the following root: + +{apiRoot}/3gpp-monitoring-event/v1 + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-monitoring-event" and "apiVersion" shall be set to "v1" for the current version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|------------------------------------------|-------------------------------------------|-------------|--------------------------------------------------------| +| Monitoring Event Subscriptions | /{scsAsId}/subscriptions | GET | Read all or queried subscriptions for a given SCS/AS | +| | | POST | Create a new subscription of monitoring event | +| Individual Monitoring Event Subscription | /{scsAsId}/subscriptions/{subscriptionId} | PUT | Modify an existing subscription of monitoring event | +| | | PATCH | Modifies an existing subscription of monitoring event. | +| | | GET | Read a subscription of monitoring event | +| | | DELETE | Delete a subscription of monitoring event | + +### 5.3.3.2 Resource: Monitoring Event Subscriptions + +#### 5.3.3.2.1 Introduction + +This resource allows an SCS/AS to read all of the active monitoring event subscriptions or create a new monitoring event subscription for the SCS/AS at the SCEF. + +#### 5.3.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.3.2.2-1. + +**Table 5.3.3.2.2-1: Resource URI variables for resource "Monitoring Event Subscriptions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.3.3.2.3 Resource methods + +##### 5.3.3.2.3.1 GET + +The GET method allows to read all or queried active subscriptions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.3.3.2.3.1-1 and table 5.3.3.2.3.1-2. + +**Table 5.3.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | Applicability | +|-----------|------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ip-addrs | array(IpAddr) | 0..N | The IP address(es) of the requested UE(s).
(NOTE) | enNB | +| ip-domain | string | 0..1 | The IPv4 address domain identifier.
The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. | enNB | +| mac-addrs | array(MacAddr48) | 0..N | The MAC address(es) of the requested UE(s).
(NOTE) | enNB | + +NOTE: Either the "ip-addrs" parameter or the "mac-addrs" parameter may be provided at the same time. If multiple elements are provided in the array data structure, then each element shall be treated as a separate query parameter. + +**Table 5.3.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(MonitoringEventSubscription) | 0..N | 200 OK | The subscription information for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.3.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.3.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.3.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.3.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +## 5.3.3.2.3.4 POST + +The POST method creates a new subscription resource to monitor an event for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.3.3.2.3.4-1 and table 5.3.3.2.3.4-2. + +**Table 5.3.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.3.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------------------|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MonitoringEventSubscription | 1 | | Parameters to register a subscription to notifications about monitoring event with the SCEF. | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | MonitoringEventSubscription | 1 | 201 Created | The subscription resource was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| | MonitoringEventReport | 1 | 200 OK | The operation is successful, and corresponding monitoring event report is included.
This is only applicable for the one-time monitoring request if report is available in the response. | +| | MonitoringEventReports | 1 | 200 OK | The operation is successful and the corresponding monitoring event report(s) are included in the response body.

This is only applicable when the enNB feature is supported, the monitoring request is a one-time reporting request and the event reports are available in the response. | +| | ProblemDetails | 0..1 | 400 Bad Request | (NOTE 2) | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | +| | ProblemDetails | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.3.5.3. + +**Table 5.3.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions/{subscriptionId} | + +### 5.3.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +## 5.3.3.3 Resource: Individual Monitoring Event Subscription + +### 5.3.3.3.1 Introduction + +This resource allows an SCS/AS to read, update or delete an active monitoring event subscription at the SCEF. + +### 5.3.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-monitoring-event/v1/{scsAsId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.2.3.2.2-1. + +**Table 5.3.3.3.2-1: Resource URI variables for resource "Individual Monitoring Event Subscription"** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| subscriptionId | string | Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI. | + +### 5.3.3.3.3 Resource methods + +#### 5.3.3.3.3.1 GET + +The GET method allows to read an active subscription resource to obtain details of the subscription. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.3.3.3.3.1-1 and table 5.3.3.3.3.1-2. + +**Table 5.3.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.3.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|--------------|-----------|-------------|----------------|---------| +| | Data type | Cardinality | Response codes | Remarks | +| none | | | | | + +| | | | | | +|--|-----------------------------|---|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MonitoringEventSubscription | 1 | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.3.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.3.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.3.3.3.3.2 PUT + +The PUT method modifies an existing subscription resource to update the subscription. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.3.3.3.3.2-1 and table 5.3.3.3.3.2-2. + +**Table 5.3.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.3.3.3.2-2: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-----------------------------|--------------------|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MonitoringEventSubscription | 1 | Parameters to update a subscription to notifications about monitoring event with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | MonitoringEventSubscription | 1 | 200 OK | The subscription was updated successfully and the representation of the subscription is returned. | +| | none | | 204 No Content | The subscription was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2, NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. +NOTE 2: The error case is only applicable for monitoring event configuration via PCRF. +NOTE 3: Failure cases are described in clause 5.3.5.3. + +**Table 5.3.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.3.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.3.3.3.3 PATCH + +The PATCH method allows the SCS/AS to modify an existing subscription resource, in order to notify the SCEF about the partial cancellation and/or partial addition of certain UE(s) within an active group. The SCS/AS shall initiate the HTTP PATCH message request with JSON Patch format signalled by the content type "application/json-patch+json". + +This method shall support request and response data structures, and response codes, as specified in the table 5.3.3.3.3-1. + +**Table 5.3.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | array(PatchItem) | 1..N | Contains the list of changes to be made to an individual subscription resource, according to the JSON PATCH format specified in IETF RFC 6902 [67]. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The resource was modified successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.3.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.3.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.3.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.3.3.3.3.5 DELETE + +The DELETE method deletes the related resource and terminates the related monitoring subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.3.3.3.3.5-1 and table 5.3.3.3.3.5-2. + +**Table 5.3.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|------------------|--------------------|----------------| +| none specified | | | | + +**Table 5.3.3.3.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | | +|---------------|------------------------------|-------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | | +| Response body | Data type | | Cardinality | Response codes | Remarks | +| | none | | | 204 No Content | The subscription was terminated successfully. | +| | array(MonitoringEventReport) | | 1..N | 200 OK | The subscription was terminated successfully, the monitoring event report(s) shall be included if received. | +| | none | | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.3.3.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.3.3.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.3.3.4 Void + +## 5.3.3A Notifications + +### 5.3.3A.1 General + +The notifications provided by the MonitoringEvent API are specified in this clause. + +**Table 5.3.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|---------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Notification | {notificationDestination} | POST | Sent from the SCEF to the SCS/AS about the notification of grouping configuration result, detected monitoring event report(s) or notify the SCS/AS to cancel a monitoring subscription | +| User Consent Revocation Notification | {revocationNotifUri} | POST | The user consent revocation notification from the NEF to the AF to inform about the revocation of user consent for one or several UE(s). | + +## 5.3.3A.2 Monitoring Notification + +### 5.3.3A.2.1 Description + +The Monitoring Notification allows the SCEF to send notification about grouping configuration result, monitoring event report(s) or a monitoring subscription cancellation to the SCS/AS. + +### 5.3.3A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.3.3A.2.2-1. + +**Table 5.3.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Callback reference provided by the SCS/AS during creation or modification of the monitoring event subscription. | + +### 5.3.3A.2.3 Standard Methods + +#### 5.3.3A.2.3.1 Notification via POST + +The HTTP POST method reports the notification for a monitoring subscription. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.3.3A.2.3.1-1 and the response data structures and response codes specified in table 5.3.3A.2.3.1-2. + +**Table 5.3.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|------------------------|-------------|---------------------------------------------------| +| MonitoringNotification | 1 | The monitoring notification provided by the SCEF. | + +**Table 5.3.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | The monitoring notification is received successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.3.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.3.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +### 5.3.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the MonitoringNotification may alternatively be delivered through the Websocket mechanism as defined in subclause 5.2.5.4. + +## 5.3.3A.3 User Consent Revocation Notification + +### 5.3.3A.3.1 Description + +The User Consent Revocation Notification is used by the NEF to report the revocation of user consent for one or several UE(s) to the AF. + +### 5.3.3A.3.2 Target URI + +The Callback URI "{revocationNotifUri}" shall be used with the the callback URI variables defined in table 5.3.3A.3.2-1. + +**Table 5.3.3A.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|--------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| revocationNotifUri | Uri | Callback reference provided by the AF during the creation or update/modification of the subscription as defined in clauses 5.3.3.2.3.4 and 5.3.3.3.3.2 or 5.3.3.3.3.3. | + +### 5.3.3A.3.3 Operation Definition + +#### 5.3.3A.3.3.1 Notification via HTTP POST + +This method shall support the request data structures specified in table 5.3.3A.3.3.1-1 and the response data structures and response codes specified in table 5.3.3A.3.3.1-2. + +**Table 5.3.3A.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | Cardinality | Description | +|-------------------|-------------|---------------------------------------------------| +| ConsentRevocNotif | 1 | Contains the user consent revocation information. | + +**Table 5.3.3A.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | 204 No Content | Successful case. The user consent revocation notification is successfully received. | +| n/a | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| n/a | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | + +**Table 5.3.3A.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | Cardinality | Description | +|----------|-----------|-------------|-------------------------------------------------------------------------------------------------------------------------| +| Location | string | 1 | An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. | + +**Table 5.3.3A.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | Cardinality | Description | +|----------|-----------|-------------|-------------------------------------------------------------------------------------------------------------------------| +| Location | string | 1 | An alternative URI representing the end point of an alternative AF towards which the notification should be redirected. | + +#### 5.3.3A.3.3.2 Notification via Websocket + +If supported by both the AF and the NEF and successfully negotiated, the User Consent Revocation Notification may alternatively be delivered via the Websocket mechanism, as defined in clause 5.2.5.4 of 3GPP TS 29.122 [4]. + +### 5.3.4 Used Features + +The table below defines the features applicable to the MonitoringEvent API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.3.4-1: Features used by MonitoringEvent API** + +| Feature Number | Feature | Description | +|----------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Loss_of_connectivity_notification | The SCS/AS is notified when the 3GPP network detects that the UE is no longer reachable for signalling or user plane communication | +| 2 | Ue-reachability_notification | The SCS/AS is notified when the UE becomes reachable for sending either SMS or downlink data to the UE | +| 3 | Location_notification | The SCS/AS is notified of the current location or the last known location of the UE | +| 4 | Change_of_IMSI_IMEI_association_notification | The SCS/AS is notified when the association of an ME (IMEI(SV)) that uses a specific subscription (IMSI) is changed | +| 5 | Roaming_status_notification | The SCS/AS is notified when the UE's roaming status changes | +| 6 | Communication_failure_notification | The SCS/AS is notified of communication failure events | +| 7 | Availability_after_DDN_failure_notification | The SCS/AS is notified when the UE has become available after a DDN failure | +| 8 | Number_of_UEs_in_an_area_notification | The SCS/AS is notified the number of UEs present in a given geographic area
The feature supports pre-5G (e.g. 4G) requirement. | +| 9 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 10 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 11 | Subscription_modification | Modifications of an individual subscription resource. | +| 12 | Number_of_UEs_in_an_area_notification_5G | The AF is notified the number of UEs present in a given geographic area.
The feature supports the 5G requirement. This feature may only be supported in 5G. | +| 13 | Pdn_connectivity_status | The SCS/AS requests to be notified when the 3GPP network detects that the UE's PDN connection is set up or torn down. | +| 14 | Downlink_data_delivery_status_5G | The AF requests to be notified when the 3GPP network detects that the downlink data delivery status is changed. The feature is not applicable to pre-5G. | +| 15 | Availability_after_DDN_failure_notification_enhancement | The AF is notified when the UE has become available after a DDN failure and the traffic matches the packet filter provided by the AF. The feature is not applicable to pre-5G. | +| 16 | Enhanced_param_config | This feature supports the co-existence of multiple event configurations for target UE(s) if there are parameters affecting periodic RAU/TAU timer and/or Active Time. Supporting this feature also requires the support of feature number 1 or 2. | +| 17 | API_support_capability_notification | The SCS/AS is notified of the availability of support of service APIs. This feature is only applicable in interworking SCEF+NEF scenario. | +| 18 | eLCS | This feature supports the enhanced location exposure service (e.g. location information preciser than cell level).
The feature is not applicable to pre-5G (e.g. 4G). | +| 19 | NSAC | This feature controls the support of the Network Slice Admission Control (NSAC) functionalities.
The feature is not applicable to pre-5G (e.g. 4G). | +| 20 | Partial_group_modification | This feature supports the partial cancellation and/or partial addition to the group member(s) within the grouped event monitoring subscription. | + +| | | | +|----|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 21 | UAV |

The SCS/AS requests to be notified of the UAV presence status in a specific geographic area. This feature is only applicable in interworking SCEF+NEF scenario, or standalone 5G scenario.

This feature requires that
Number_of_UEs_in_an_area_notification and
Number_of_UEs_in_an_area_notification_5G
features are also supported.

| +| 22 | MULTIQOS |

This feature indicates the support for "Multiple QoS Class" which enables to support more than one Location QoS during LCS procedures.

This feature requires that the eLCS feature is also supported.

| +| 23 | Session_Management_Enhancement |

This feature supports Session Management enhancement with requested DNN and/or S-NSSAI. This feature requires that the Pdn_connectivity_status feature or Downlink_data_delivery_status_5G feature is also supported.

| +| 24 | enNB | Indicates the support of enhancements to the northbound interfaces. | +| 25 | EDGEAPP |

This feature controls the support of EDGE applications related functionalities (e.g. support the civic address as a possible location granularity). The feature is not applicable to pre-5G (e.g. 4G).

| +| 26 | UEId_retrieval | This feature supports AF specific UE ID retrieval which is not applicable to pre-5G (e.g. 4G). | +| 27 | UserConsentRevocation | This feature indicates the support of user consent revocation management and enforcement (e.g. stop data processing) for EDGE applications. | +| 28 | Subscription_Patch | This feature indicates the support of the PATCH method for partial modification of an existing event monitoring subscription. | +| 29 | GMEC |

This feature indicates the support of Generic Group Management, Exposure and Communication Enhancements (e.g. Ggroup Member List Change event reporting).

This feature is not applicable to pre-5G (e.g. 4G).

| +| 30 | Loss_of_connectivity_notification_5G |

The AF is notified when the 3GPP network detects that the UE is no longer reachable for signalling or user plane communication.

This feature is not applicable to pre-5G (e.g. 4G).

| +| 31 | enNB1 | Indicates the support of enhancements to this northbound API in Rel-18. | +| 32 | AppDetection_5G |

This feature indicates the support of Application traffic detection (start and stop) monitoring event.

This feature is not applicable to pre-5G (e.g. 4G).

| +| 33 | enNB1_5G |

Indicates the support of enhancements to this northbound API for 5G in Rel-18.

This feature is not applicable to pre-5G (e.g. 4G).

| +| 34 | eLCS_en |

This feature indicates the support of the enhancements to the eLCS feature.

The following functionalities are supported:

  • - Support the error handling related to the area event reporting for the case where the requested location area is not allowed.
  • - Support location reporting over user plane between UE and AF.

This feature is not applicable to pre-5G (e.g. 4G).

| + +| | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 35 | eNSAC |

This feature indicates the support of the enhancements to the NSAC feature.

The following functionalities are supported:

  • - Support the status notification of the current number of UEs with at least one PDU session/PDN connection. This feature is not applicable to pre-5G (e.g. 4G).
| +| 36 | Ranging_SL |

This feature supports the enhanced location exposure service (e.g. location information for ranging and sidelink positioning), and requires the support of eLCS feature.

The feature is not applicable to pre-5G (e.g. 4G).

| +| Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification".
Description: A clear textual description of the feature. | | | + +## 5.3.5 Error handling + +### 5.3.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.3.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MonitoringEvent API. + +### 5.3.5.3 Application Errors + +The application errors defined for the MonitoringEvent API are listed in table 5.3.5.3-1. + +**Table 5.3.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| EVENT_FEATURE_MISMATCH | 400 Bad Request | Indicates the resource creation is not allowed since the supported feature corresponding to the monitoring event is not supported by the client. | | +| DUPLICATE_REQUEST | 400 Bad Request | Indicates that a duplicate subscription already exists for this client. | enNB | +| PARAMETER_OUT_OF_RANGE | 403 Forbidden | Indicates that the resource is not allowed to be created since one or more of the received parameter are out of range defined by operator policies. | | +| IDLE_STATUS_UNSUPPORTED | 403 Forbidden | Indicates that the resource is not allowed to be created since the Idle Status Indication is received in the request but not supported by the network. | | +| OPERATION_PROHIBITED | 403 Forbidden | Indicates the HTTP method is not supported. | | +| CONSENT_REVOCATION_NOT_SUPPORTED | 403 Forbidden | Indicates that the request is rejected because user consent management and enforcement is not supported by the client. | UserConsentRevocation | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request is rejected because user consent is not granted. | UserConsentRevocation | +| RESOURCES_EXCEEDED | 403 Forbidden | Indicates that no more subscriptions are allowed for this client. | enNB | +| REQUEST_NOT_AUTHORIZED | 403 Forbidden | Indicates that the AF specific UE ID retrieval request is not authorized or the AF request to application detection is not authorized. | UEId_retrieval, AppDetection_5G | +| REQUESTED_AREA_NOT_ALLOWED | 403 Forbidden | Indicates that the location request is rejected because the location area requested by the AF for an area event reporting is not allowed. | eLCS_en | +| UE_ID_NOT_AVAILABLE | 404 Not Found | Indicates that the AF specific UE ID is not available. | UEId_retrieval | +| UE_NOT_FOUND | 404 Not Found | Indicates that the requested UE address is not found. | UEId_retrieval | +| EVENT_UNSUPPORTED | 500 Internal Server Error | Indicates the required monitoring event is not supported by the | | + +| | | | | +|--|--|---------|--| +| | | server. | | +|--|--|---------|--| + +## 5.4 ResourceManagementOfBdt API + +### 5.4.1 Overview + +The ResourceManagementOfBdt API is a RESTful API that allows the SCS/AS to request background data transfer related conditions for a set of UEs. The ResourceManagementOfBdt API defines a set of data models, resources and the related procedures for the creation and management of the background data transfer request. The corresponding JSON schema for the representation of the resources and operations defined by the ResourceManagementOfBdt API is provided in its complete form in Annex A.4. + +### 5.4.2 Data model + +#### 5.4.2.1 Resource data types + +##### 5.4.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.4.2.1.1-1 specifies data types re-used by the ResourceManagementOfBdt API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the ResourceManagementOfBdt API. + +**Table 5.4.2.1.1-1: ResourceManagementOfBdt API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| GeographicArea | 3GPP TS 29.572 [42] | Identifies the geographical information of the user(s). | +| CivicAddress | 3GPP TS 29.572 [42] | Identifies the civic address information of the user(s). | +| NetworkAreaInfo | 3GPP TS 29.554 [50] | Identifies a network area information. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.4.4-1. | + +Table 5.4.2.1.1-2 specifies the data types defined for the ResourceManagementOfBdt API. + +**Table 5.4.2.1.1-2: ResourceManagementOfBdt API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Bdt | 5.4.2.1.2 | Represents a Background Data Transfer subscription. | | +| BdtPatch | 5.4.2.1.3 | Represents a Background Data Transfer subscription modification request. | | +| ExNotification | 5.4.2.1.4 | Represents a Background Data Transfer notification. | | +| TrafficDescriptor | 5.4.2.3.2 | Identify a traffic descriptor as defined in Figure 5.2.2 of 3GPP TS 24.526 [64]. | | +| TransferPolicy | 5.4.2.2.2 | Represents an offered transfer policy sent from the SCEF to the SCS/AS, or a selected transfer policy sent from the SCS/AS to the SCEF. | | + +##### 5.4.2.1.2 Type: Bdt + +This type represents a BDT subscription. The same structure is used in the subscription request and subscription response. + +**Table 5.4.2.1.2-1: Definition of type Bdt** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|-----------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| self | Link | 0..1 | Link to the resource "Individual BDT Subscription". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| aspId | string | 0..1 | Identifies an application service provider. | AspId_5G | +| volumePerUE | UsageThreshold | 1 | Identifies the data volume expected to be transferred per UE. | | +| numberOfUEs | integer | 1 | Identifies the number of UEs. | | +| desiredTimeWindow | TimeWindow | 1 | Identifies the time interval. | | +| locationArea | LocationArea | 0..1 | Identifies the area within which the SCS/AS requests the number of UE. | Bdt | +| locationArea5G | LocationArea5G | 0..1 | Identifies the area within which the AF requests the number of UE. | LocBdt_5G | +| referenceId | BdtReferenceId | 0..1 | Identifies a selected policy of background data transfer. | | +| transferPolicies | array(TransferPolicy) | 0..N | Identifies an offered transfer policy. | | +| selectedPolicy | integer | 0..1 | Identity of the selected background data transfer policy. Shall not be present in initial message exchange, can be provided by NF service consumer in a subsequent message exchange. | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a group of users. (NOTE 2) | Group_Id | +| notificationDestination | Link | 0..1 | Contains the URI to receive the BDT notification from the NEF. | BdtNotification_5G | +| warnNotifEnabled | boolean | 0..1 | Indicates whether the BDT warning notification is enabled or not. If it is set to true, the BDT warning notification is enabled; if it is set to false or absent, the BDT warning notification is disabled. | BdtNotification_5G | +| trafficDes | TrafficDescriptor | 0..1 | Contains the traffic descriptor of the background data. (NOTE 2) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: The attribute is only applicable to the NEF. + +#### 5.4.2.1.3 Type: BdtPatch + +This type represents a BDT request for the service provided by the SCS/AS to the SCEF via T8 interface. The structure is used for PATCH request. + +**Table 5.4.2.1.3-1: Definition of type BdtPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------------|-----------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| selectedPolicy | integer | 1 | Identity of the selected background data transfer policy. | | +| warnNotifEnabled | boolean | 0..1 | Indicates whether the BDT warning notification is enabled.

- true: the BDT warning notification is enabled;
- false: the BDT warning notification is not enabled. | BdtNotification_5G | +| notificationDestination | Link | 0..1 | Contains the URI to receive the BDT notification from the NEF. | enNB | + +NOTE: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.4.2.1.4 Type: ExNotification + +This type represents a BDT notification provided by the NEF to the AF. The structure is used for POST request. + +**Table 5.4.2.1.4-1: Definition of type ExNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------|-----------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| bdtReflId | BdtReferenceId | 1 | This IE indicates transfer policies of background data transfer which the notification corresponds to. | | +| locationArea5G | LocationArea5G | 0..1 | This IE represents a network area where a network performance will go below the criteria set by the operator. | | +| timeWindow | TimeWindow | 0..1 | This IE indicates a time window when a network performance will go below the criteria set by the operator. | | +| candPolicies | array(TransferPolicy) | 0..N | This IE indicates a list of the candidate transfer policies from which the AF may select a new transfer policy due to network performance degradation. | | + +NOTE: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.4.2.2 Referenced structured data types + +##### 5.4.2.2.1 Introduction + +This clause defines structured data types that are referenced from data structures defined in the previous clauses. + +##### 5.4.2.2.2 Type: TransferPolicy + +This data type represents an offered transfer policy sent from the SCEF to the SCS/AS, or a selected transfer policy sent from the SCS/AS to the SCEF. + +**Table 5.4.2.2.2-1: Definition of type TransferPolicy** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------------|------------|-------------|----------------------------------------------------------------------------------|----------------------| +| bdtpolicyId | integer | 1 | Identifier for the transfer policy | | +| maxUplinkBandwidth | Bandwidth | 0..1 | Indicates the maximum aggregated bitrate in the uplink authorized by the PCRF. | | +| maxDownlinkBandwidth | Bandwidth | 0..1 | Indicates the maximum aggregated bitrate in the downlink authorized by the PCRF. | | +| ratingGroup | integer | 1 | Indicates the rating group during the time window. | | +| timeWindow | TimeWindow | 1 | Indicates the recommended time window of the transfer policy | | + +NOTE: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +## 5.4.2.3 Referenced simple data types and enumerations + +### 5.4.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +### 5.4.2.3.2 Simple data types + +The simple data types defined in table 5.4.2.3.2-1 shall be supported. + +**Table 5.4.2.3.2-1: Simple data types** + +| Type name | Description | +|-------------------|-------------------------------------------------------------------------------------------| +| TrafficDescriptor | String identifying a traffic descriptor as defined in table 5.2.1 of 3GPP TS 24.526 [64]. | + +## 5.4.3 Resource structure + +### 5.4.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-bdt/v1** + +"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|-----------------------------|-------------------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------| +| BDT Subscription | /{scsAsId}/subscriptions | GET | Read all active background data transfer subscription resources for a given SCS/AS | +| | | POST | Create a new background data transfer subscription resource | +| Individual BDT Subscription | /{scsAsId}/subscriptions/{subscriptionId} | PATCH | Modify a background data transfer subscription resource to select one of the transfer policies offered by the SCEF | +| | | PUT | Update a background data transfer subscription resource for negotiation of background data transfer policy | +| | | GET | Read a background data transfer subscription resource | +| | | DELETE | Delete a background data transfer resources | + +### 5.4.3.2 Resource: BDT Subscriptions + +#### 5.4.3.2.1 Introduction + +This resource allows the SCS/AS to read all active long-term transactions related to BDT resource management. + +#### 5.4.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-bdt/v1/{scsAsId}/subscriptions + +This resource shall support the resource URI variables defined in table 5.4.3.2.2-1. + +**Table 5.4.3.2.2-1: Resource URI variables for resource "BDT Subscriptions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.4.3.2.3 Resource methods + +##### 5.4.3.2.3.1 GET + +The GET method allows to read all active resources for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.4.3.2.3.1-1 and table 5.4.3.2.3.1-2. + +**Table 5.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.4.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(Bdt) | 0..N | 200 OK | The resource information for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.4.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.4.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.4.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.4.3.2.3.4 POST + +The POST method creates a new background data transfer subscription resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.4.3.2.3.4-1 and table 5.4.3.2.3.4-2. + +**Table 5.4.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.4.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------| +| | Bdt | 1 | | Parameters to register a subscription to request background data transfer related information with the SCEF. | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | Bdt | 1 | 201
Created | The resource was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-bdt/v1/{scsAsId}/subscriptions/{subscriptionId} | + +#### 5.4.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.4.3.3 Resource: Individual BDT Subscription + +#### 5.4.3.3.1 Introduction + +This resource allows the SCS/AS to manage resources for BDT using a long-term transaction. + +#### 5.4.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-bdt/v1/{scsAsId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.4.3.3.2-1. + +**Table 5.4.3.3.2-1: Resource URI variables for resource "Individual BDT Subscription"** + +| Name | Data type | Definition | +|----------------|------------------|-----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| subscriptionId | string | Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI. | + +#### 5.4.3.3.3 Resource methods + +##### 5.4.3.3.3.1 GET + +The GET method allows to read an individual BDT subscription resource to obtain details of an active resource BDT subscription. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.4.3.3.3.1-1 and table 5.4.3.3.3.1-2. + +**Table 5.4.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.4.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | Bdt | 1 | 200 OK | The resource information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.4.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.4.3.3.3.2 PUT + +The PUT method allows the SCS/AS to modify an existing subscription resource completely. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.4.3.3.3.2-1. + +**Table 5.4.3.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Bdt | 1 | The SCS/AS requests to update the BDT policy subscription. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | Bdt | 1 | 200 OK | The subscription was modified successfully.
The SCEF shall return an updated subscription in the response content. | +| | none | | 204 No Content | The subscription was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.4.3.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.4.3.3.3.3 PATCH + +The PATCH method allows the SCS/AS to modify an existing subscription resource, in order to notify the SCEF about the selected transfer policy. The SCS/AS shall initiate the HTTP PATCH message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.4.3.3.3.3-1. + +**Table 5.4.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | BdtPatch | 1 | Background data transfer policy selected by the SCS/AS. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | Bdt | 1 | 200 OK | The resource was modified successfully.
The SCEF shall return an updated subscription in the response content. | +| | none | | 204 No Content | The resource was modified successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.4.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.4.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.4.3.3.3.5 DELETE + +The DELETE method deletes the resource and terminates the BDT subscription. The SCS/AS shall initiate the HTTP DELETE message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.4.3.3.5-1 and table 5.4.3.3.5-2. + +**Table 5.4.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.4.3.3.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The resource was terminated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.4.3.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.4.3.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.4.3.4 Void + +### 5.4.3A Notifications + +#### 5.4.3A.1 General + +The notifications provided by the ResourceManagementOfBdt API are specified in this clause. + +**Table 5.4.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------|---------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------| +| BDT Warning Notification | {notificationDestination} | POST | Notify the BDT warning from the NEF to the AF identified by the notification destination URI (NOTE) | + +NOTE: This notification may only be supported in 5G. + +## 5.4.3A.2 BDT Warning Notification + +### 5.4.3A.2.1 Description + +The BDT warning notification allows the NEF to notify the AF of the BDT warning notification. The notification may only be supported in 5G. + +### 5.4.3A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.4.3A.2.2-1. + +**Table 5.4.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Reference provided by the AF when the AF requests to send a BDT warning notification when the network performance in the area of interest goes below the criteria set by the operator.
This URI shall be provided within the "notificationDestination" attribute in the Bdt data type. | + +### 5.4.3A.2.3 Standard Methods + +#### 5.4.3A.2.3.1 Notification via POST + +The POST method allows to notify AS identified by the notification destination URI of the BDT warning by the NEF and the AF shall respond to the message. + +This method shall support the request data structures specified in table 5.4.3A.2.3.1-1 and the response data structures and response codes specified in table 5.4.3A.2.3.1-2. + +**Table 5.4.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|----------------|-------------|-------------------------------------------------| +| ExNotification | 1 | Representation of the BDT warning notification. | + +**Table 5.4.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | This case represents a successful notification of BDT warning notification. | +| none | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. | | | | + +**Table 5.4.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.4.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.4.3A.2.3.2 Notification via Websocket + +If supported by both AF and NEF and successfully negotiated, the ExNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.4.4 Used Features + +The table below defines the features applicable to the ResourceManagementOfBdt API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.4.4-1: Features used by ResourceManagementOfBdt API** + +| Feature Number | Feature | Description | +|----------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Bdt | The feature supports the pre-5G (e.g. 4G) requirement. | +| 2 | LocBdt_5G | The feature supports the 5G requirement. This feature may only be supported in 5G. | +| 3 | Group_Id | The feature supports forwarding an external group identifier of the user. This feature shall not be supported in pre-5G. | +| 4 | BdtNotification_5G | The feature supports the sending of BDT notification. This feature includes sending of the BDT warning notification to the AF. This feature may only be supported in 5G. | +| 5 | enNB | The feature supports enhancement of northbound interfaces, e.g. enable the SCS/AS to update notification destination during modification procedure. | +| 6 | AspId_5G | Indicates the support of application service provider.
This feature is not applicable to pre-5G (e.g. 4G). | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +### 5.4.5 Error handling + +#### 5.4.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +#### 5.4.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the ResourceManagementOfBdt API. + +#### 5.4.5.3 Application Errors + +The application errors defined for ResourceManagementOfBdt API are listed in table 5.4.5.3-1. + +**Table 5.4.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.5 ChargeableParty API + +### 5.5.1 Overview + +The ChargeableParty API is a RESTful API that allows the SCS/AS to either request to sponsor the traffic from the beginning or to request becoming the chargeable party at a later point in time via the T8 interface. The ChargeableParty API defines a set of data models, resources and the related procedures for the creation and management of the AS sessions with chargeable party change. The corresponding JSON schema for the representation of the resources and operations defined by the Chargeable API is provided in its complete form in Annex A.5. + +### 5.5.2 Data model + +#### 5.5.2.1 Resource data types + +##### 5.5.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.5.2.1.1-1 specifies data types re-used by the ChargeableParty API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the ChargeableParty API. + +**Table 5.5.2.1.1-1: ChargeableParty API re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| Dnn | 3GPP TS 29.571 [45] | Identifies a DNN. | +| EthFlowDescription | 3GPP TS 29.514 [52] | Defines a packet filter for an Ethernet flow.(NOTE) | +| IpAddr | 3GPP TS 29.571 [45] | UE IP Address. | +| MacAddr48 | 3GPP TS 29.571 [45] | MAC Address. | +| ServAuthInfo | 3GPP TS 29.514 [52] | The authorization result of a request bound to a transfer policy. | +| Snssai | 3GPP TS 29.571 [45] | Identifies the S-NSSAI. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.5.4-1. | +| NOTE: | In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange_5G as specified in clause 5.5.4 shall be supported. | | + +Table 5.5.2.1.1-2 specifies the data types defined for the ChargeableParty API. + +**Table 5.5.2.1.1-2: ChargeableParty API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|-------------------------------------------------------------------|---------------| +| ChargeableParty | 5.5.2.1.2 | Represents the configuration of a chargeable party. | | +| ChargeablePartyPatch | 5.5.2.1.3 | Represents a modification request of a chargeable party resource. | | + +##### 5.5.2.1.2 Type: ChargeableParty + +This type represents the configuration of a chargeable party. The same structure is used in the configuration request and configuration response. + +**Table 5.5.2.1.2-1: Definition of type ChargeableParty** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|---------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual Chargeable Party Transaction". This parameter shall be supplied by the SCEF in HTTP responses. | | +| dnn | Dnn | 0..1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) | | +| snssai | Snssai | 0..1 | Identifies an S-NSSAI. (NOTE 3) | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| notificationDestination | Link | 1 | Contains the URI to receive the notification of bearer level event(s) from the SCEF. | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| exterAppId | string | 0..1 | Identifies the external Application Identifier. (NOTE 2) | AppId | +| ipv4Addr | Ipv4Addr | 0..1 | Identifies the Ipv4 address. (NOTE 2) | | +| ipDomain | string | 0..1 | The IPv4 address domain identifier. The attribute may only be provided if the ipv4Addr attribute is present. | | +| ipv6Addr | Ipv6Addr | 0..1 | Identifies the Ipv6 address. (NOTE 2) | | +| macAddr | MacAddr48 | 0..1 | Identifies the MAC address. (NOTE 2) | EthChgParty_5G | +| flowInfo | array(FlowInfo) | 0..N | Describes the IP flows. (NOTE 2) (NOTE 4) | | +| ethFlowInfo | array(EthFlowDescription) | 0..N | Identifies Ethernet packet flows. (NOTE 2) | EthChgParty_5G | +| sponsorInformation | SponsorInformation | 1 | Describes the sponsor information such as who is sponsoring the traffic. | | +| sponsoringEnabled | boolean | 1 | Indicates whether the sponsoring data connectivity is enabled.

- true: the sponsoring data connectivity is enabled;
- false: the sponsoring data connectivity is not enabled. | | +| referenceId | BdtReferenceId | 0..1 | The reference ID for a previously selected policy of background data transfer. | | +| servAuthInfo | ServAuthInfo | 0..1 | Indicates the authorization result for the request bound to the transfer policy indicated by the "referenceId" attribute. Supplied by the SCEF | | +| usageThreshold | UsageThreshold | 0..1 | Time period and/or traffic volume. | | +| events | array(Event) | 0..N | Corresponds to the event(s) to which the SCS/AS requests to subscribe. | enNB | + +NOTE 1: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +NOTE 2: One of the "ipv4Addr", "ipv6Addr", or "macAddr" attribute shall be provided. If ipv4 or ipv6 address is + +provided, IP flow information shall be provided. If MAC address is provided and the AppId feature is not supported, Ethernet flow information shall be provided. If the AppId feature is supported, one of IP flow information, Ethernet flow information (if EthChgParty\_5G is supported) or External Application Identifier shall be provided. + +NOTE 3: The property is only applicable for the NEF. + +NOTE 4: The "tosTC" attribute of the "flowInfo" attribute may only be present if the "ToSTC\_5G" feature is supported. + +#### 5.5.2.1.3 Type: ChargeablePartyPatch + +This type represents the configuration of a chargeable party. The structure is used for PATCH request. + +**Table 5.5.2.1.3-1: Definition of type ChargeablePartyPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------------|---------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| flowInfo | array(FlowInfo) | 0..N | Describes the IP flows. (NOTE 2)
(NOTE 3) | | +| exterAppId | string | 0..1 | Identifies the AF Application Identifier.
(NOTE 2) | AppId | +| ethFlowInfo | array(EthFlowDescription) | 0..N | Describes Ethernet packet flows.
(NOTE 2) | EthChgParty_5G | +| sponsoringEnabled | boolean | 0..1 | Indicates whether the sponsoring data connectivity is enabled.

- true: the sponsoring data connectivity is enabled;
- false: the sponsoring data connectivity is not enabled. | | +| referenceId | BdtReferenceId | 0..1 | The reference ID for a previously selected policy of background data transfer. | | +| usageThreshold | UsageThresholdRm | 0..1 | Time period and/or traffic volume. | | +| notificationDestination | Link | 0..1 | Contains the URL to receive the notification event(s) from the SCEF. | | +| events | array(Event) | 0..N | Corresponds to the event(s) to which the SCS/AS requests to subscribe to. | enNB | + +NOTE 1: Properties marked with a feature as defined in clause 5.5.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: One of "flowInfo", "exterAppId" or "ethFlowInfo" may be provided. +NOTE 3: The "tosTC" attribute of the "flowInfo" attribute may only be present if the "ToSTC\_5G" feature is supported. + +### 5.5.3 Resource structure + +#### 5.5.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-chargeable-party/v1** + +"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|-----------------------------------------|-----------------------------------------|-------------|-------------------------------------------------------------------------------| +| Chargeable Party Transactions | /{scsAsId}/transactions | GET | Read all or queried chargeable party transaction resources for a given SCS/AS | +| | | POST | Create a new chargeable party transaction resource | +| Individual Chargeable Party Transaction | /{scsAsId}/transactions/{transactionId} | GET | Read a chargeable party transaction resource | +| | | PATCH | Partial update a chargeable party transaction resource. | +| | | DELETE | Delete an existing chargeable party transaction resource | + +## 5.5.3.2 Resource: Chargeable Party Transactions + +### 5.5.3.2.1 Introduction + +This resource allows the SCS/AS to read all active long-term transactions related to setting a chargeable party and create individual long-term transactions. + +### 5.5.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-chargeable-party/v1/{scsAsId}/transactions + +This resource shall support the resource URI variables defined in table 5.5.3.2.2-1. + +**Table 5.5.3.2.2-1: Resource URI variables for resource "Chargeable Party Transactions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.5.3.2.3 Resource methods + +#### 5.5.3.2.3.1 GET + +The GET method allows to read all or queried active chargeable party transactions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.5.3.2.3.1-1 and table 5.5.3.2.3.1-2. + +**Table 5.5.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ip-addrs | array(lpAddr) | 0..N | The IP address(es) of the requested UE(s). | enNB | +| ip-domain | string | 0..1 | The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. | enNB | +| mac-addrs | array(MacAddr48) | 0..N | The MAC address(es) of the requested UE(s). | enNB | +| NOTE: Either the "ip-addrs" parameter or the "mac-addrs" parameter may be provided at the same time. If multiple elements are provided in the array data structure, then each element shall be treated as a separate query parameter. | | | | | + +**Table 5.5.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(ChargeableParty) | 0..N | 200 OK | The chargeable party transactions information for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.5.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.5.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.5.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.5.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.5.3.2.3.4 POST + +The POST method creates a new chargeable party transaction resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource. + +This method shall support request and response data structures, and response codes, as specified in the table 5.5.3.2.3.4-1. + +**Table 5.5.3.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| | ChargeableParty | 1 | Parameters to create a chargeable party transaction with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ChargeableParty | 1 | 201
Created | The transaction was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.5.3.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-chargeable-party/v1/{scsAsId}/transactions/{transactionId} | + +#### 5.5.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.5.3.3 Resource: Individual Chargeable Party Transaction + +#### 5.5.3.3.1 Introduction + +This resource allows the SCS/AS to configure a chargeable party for some application flows using a long-term transaction. + +#### 5.5.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-chargeable-party/v1/{scsAsId}/transactions/{transactionId} + +This resource shall support the resource URI variables defined in table 5.5.3.3.2-1. + +**Table 5.5.3.3.2-1: Resource URI variables for resource "Individual Chargeable Party Transaction"** + +| Name | Data type | Definition | +|---------------|------------------|------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| transactionId | string | Identifier of the transaction. The transactionId corresponds to the stage 2 TLTRI. | + +#### 5.5.3.3.3 Resource methods + +##### 5.5.3.3.3.1 GET + +The GET method allows to read a transaction resource to obtain details of an active. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.5.3.3.3.1-1 and table 5.5.3.3.3.1-2. + +**Table 5.5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.5.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ChargeableParty | 1 | 200 OK | The chargeable party transactions information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.5.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.5.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.5.3.3.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.5.3.3.3.3 PATCH + +The PATCH method allows to change the sponsoring status of an active chargeable party transaction. It also allows to activate a background data transfer policy. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message. This method shall support request and response data structures, and response codes, as specified in the table 5.5.3.3.3.3-1. + +**Table 5.5.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|----------------------|--------------------|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ChargeablePartyPatch | 1 | Sponsor status change, usage threshold change and/or background data transfer policy activation. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ChargeableParty | 1 | 200 OK | The chargeable party transaction resource was modified successfully.
The SCEF shall return a representation of the updated chargeable party transaction resource in the response content. | +| | none | | 204 No Content | The chargeable party transaction resource was modified successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.5.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.5.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.5.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.5.3.3.3.5 DELETE + +The DELETE method allows to delete an active chargeable party transaction resource and to terminate the related chargeable party transaction. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.5.3.3.3.5-1. + +**Table 5.5.3.3.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The subscription was deleted successfully. | +| | NotificationData | 1 | 200 OK | The subscription was deleted successfully. The notification data shall be included in the response. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.5.3.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.5.3.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.5.3.4 Void + +## 5.5.3A Notifications + +### 5.5.3A.1 General + +The notifications provided by the ChargeableParty API are specified in this clause. + +**Table 5.5.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|---------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------| +| Event Notification | {notificationDestination} | POST | Notify the bearer level event(s) from the SCEF to the SCS/AS identified by the notification destination URI | + +## 5.5.3A.2 Event Notification + +### 5.5.3A.2.1 Description + +The Event Notification allows the SCEF to notify the SCS/AS of the bearer level event(s). + +### 5.5.3A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.5.3A.2.2-1. + +**Table 5.5.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Reference provided by the SCS/AS when the SCS/AS requests to sponsor the traffic from the beginning or to become the chargeable party at a later point.
This URI shall be provided within the "notificationDestination" attribute in the ChargeableParty type. | + +### 5.5.3A.2.3 Standard Methods + +#### 5.5.3A.2.3.1 Notification via POST + +The POST method allows to notify SCS/AS identified by the notification destination URI of the bearer level event(s) by the SCEF and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.5.3A.2.3.1-1 and the response data structures and response codes specified in table 5.5.3A.2.3.1-2. + +**Table 5.5.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|------------------|-------------|--------------------------------------------------| +| NotificationData | 1 | Representation of the bearer level notification. | + +**Table 5.5.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | This case represents a successful notification of bearer level event(s). | +| none | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. | | | | + +**Table 5.5.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.5.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +### 5.5.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the NotificationData may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +## 5.5.4 Used Features + +The table below defines the features applicable to the ChargeableParty API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.5.4-1: Features used by ChargeableParty API** + +| Feature Number | Feature | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 3 | EthChgParty_5G | Chargeable Party for Ethernet UE. This feature may only be supported in 5G. | +| 4 | MacAddressRange_5G | Indicates the support of a set of MAC addresses with a specific range in the traffic filter. This feature may only be supported in 5G. | +| 5 | AppId | Indicates the support of dynamically providing the Application Identifier via the API. | +| 6 | enNB | Indicates the support of enhancements to the northbound interfaces, e.g. enable an SCS/AS to explicitly indicate the event(s) that it would like to subscribe to. | +| 7 | ToSTC_5G | Indicates the support of Type of Service or Traffic Class. This feature may only be supported in 5G. | +| Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification".
Description: A clear textual description of the feature. | | | + +## 5.5.5 Error handling + +### 5.5.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.5.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the ChargeableParty API. + +### 5.5.5.3 Application Errors + +The application errors defined for ChargeableParty API are listed in table 5.5.5.3-1. + +**Table 5.5.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.6 NIDD API + +### 5.6.1 Overview + +The NIDD API is a RESTful API that allows the SCS/AS to send non-IP data to the UE or receive non-IP data from the UE. The NIDD API defines a set of data models, resources and the related procedures for the non-IP data transfer. The corresponding JSON schema for the representation of the resources and operations defined by the NIDD API is provided in its complete form in Annex A.6. + +### 5.6.2 Data model + +#### 5.6.2.1 Resource data types + +##### 5.6.2.1.1 Introduction + +This clause defines data structures to be used in resource representations, including subscription resources. + +Table 5.6.2.1.1-1 specifies data types re-used by the NIDD API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NIDD API. + +**Table 5.5.2.1.1-1: NIDD API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| NullValue | 3GPP TS 29.571 [45] | JSON's null value, used as an explicit value of an enumeration. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.6.4-1. | + +Table 5.6.2.1.1-2 specifies the data types defined for the NIDD API. + +**Table 5.6.2.1.1-2: NIDD API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| DeliveryStatus | 5.6.2.3.4 | Represents the status of a downlink NIDD data delivery. | | +| GmdNiddDownlinkDataDeliveryNotification | 5.6.2.1.8 | Represents the delivery status of a specific group NIDD downlink data delivery. | | +| GmdResult | 5.6.2.2.3 | Represents the group message delivery result. | GroupMessageDelivery | +| ManageEntity | 5.6.2.3.7 | Represents the origin that manages the RDS port. | | +| ManagePort | 5.6.2.1.9 | Represents the configuration of a RDS dynamic port management. | Rds_dynamic_port | +| ManagePortNotification | 5.6.2.1.10 | Represents a ManagePort notification of port numbers that are reserved. | | +| NiddConfiguration | 5.6.2.1.2 | Represents the configuration for NIDD. | | +| NiddConfigurationPatch | 5.6.2.1.7 | Represents the parameters to update a NIDD configuration. | | +| NiddConfigurationStatusNotification | 5.6.2.1.6 | Represents an NIDD configuration status notification. | | +| NiddDownlinkDataDeliveryFailure | 5.6.2.2.4 | Represents information related to a failure delivery result. | | +| NiddDownlinkDataDeliveryStatusNotification | 5.6.2.1.5 | Represents the delivery status of a specific NIDD downlink data delivery. | | +| NiddDownlinkDataTransfer | 5.6.2.1.3 | Represents the received NIDD downlink data from the SCS/AS. | | +| NiddDownlinkDataTransferPatch | 5.6.2.1.11 | Represents the parameters to request the modification of an Individual NIDD Downlink Data Delivery resource. | PatchUpdate | +| NiddStatus | 5.6.2.3.5 | Represents the status of a NIDD configuration. | | +| NiddUplinkDataNotification | 5.6.2.1.4 | Represents NIDD uplink data to be notified to the SCS/AS. | | +| PdnEstablishmentOptions | 5.6.2.3.3 | Represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE. | | +| PdnEstablishmentOptionsRm | 5.6.2.3.6 | Represents the same information as the PdnEstablishmentOptions but with the "nullable: true" property. | | +| RdsDownlinkDataDeliveryFailure | 5.6.2.2.5 | Represents the failure delivery result for RDS. | | +| RdsPort | 5.6.2.2.2 | Represents the port configuration for Reliable Data Transfer. | | +| SerializationFormat | 5.6.2.3.8 | Represents a serialization format associated with an RDS port. | Rds_serialization_format | + +#### 5.6.2.1.2 Type: NiddConfiguration + +This type represents the configuration for NIDD. The same structure is used in the configuration request and configuration response. + +**Table 5.6.2.1.2-1: Definition of type NiddConfiguration** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|-------------------------|-------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| self | Link | 0..1 | Link to the resource "Individual NIDD configuration". This parameter shall be supplied by the SCEF in HTTP responses | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| mtcProviderId | string | 0..1 | Identifies the MTC Service Provider and/or MTC Application. (NOTE 3) | | +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.3 of 3GPP TS 23.682 [2].
(NOTE 2) | GroupMessageDelivery | +| duration | DateTime | 0..1 | Identifies the absolute time at which the related NIDD Configuration request is considered to expire, as specified in clause 5.13.2 of 3GPP TS 23.682 [2].
When omitted in the request, it indicates the configuration is requested to be valid forever by the SCS/AS. When omitted in the response, it indicates the configuration is set to valid forever by the SCEF. | | +| reliableDataService | boolean | 0..1 | Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

- true: reliable data service acknowledgement is requested;
- false (default): reliable data service acknowledgement is not requested. | | +| rdsPorts | array(RdsPort) | 0..N | Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | | +| pdnEstablishmentOption | PdnEstablishmentOptions | 0..1 | Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent. (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])
The SCEF will use the value as the default preference from the SCS/AS when handling all MT non-IP packets associated with the NIDD connection. | | +| notificationDestination | Link | 1 | An URI of a notification destination that T8 message shall be delivered to. | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up | Notification_w | + +| | | | | | +|---------------------------|---------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| | g | | notification delivery over Websocket protocol as defined in clause 5.2.5.4. | ebsocket | +| maximumPacketSize | integer | 0..1 | The Maximum Packet Size is the maximum NIDD packet size that was transferred to the UE by the SCEF in the PCO, see clause 4.5.14.1 of 3GPP TS 23.682 [2]. If no maximum packet size was provided to the UE by the SCEF, the SCEF sends a default configured max packet size to SCS/AS.

Unit: bit. | | +| niddDownlinkDataTransfers | array(NiddDownlinkDataTransfer) | 0..N | The downlink data deliveries that needed to be executed by the SCEF. The cardinality of the property shall be 0..1 in the request and 0..N in the response (i.e. response may contain multiple buffered MT NIDD).

For GroupMessageDelivery feature, this property is only applicable for the configuration response to GET request. | | +| status | NiddStatus | 0..1 | May be supplied by the SCEF | | + +NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise. + +NOTE 2: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included. + +NOTE 3: The SCEF should check received MTC provider identifier and then the SCEF may: + +- override it with local configured value and send it to HSS; +- send it directly to the HSS; or +- reject the NIDD configuration request. + +#### 5.6.2.1.3 Type: NiddDownlinkDataTransfer + +This type represents received NIDD downlink data from the SCS/AS. + +**Table 5.6.2.1.3-1: Definition of type NiddDownlinkDataTransfer** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|-----------------------------|-------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.3 of 3GPP TS 23.682 [2].
(NOTE 2) | GroupMessageDelivery | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| self | Link | 0..1 | Link to the resource "Individual NIDD downlink data delivery". This parameter shall be supplied by the SCEF in HTTP responses. | | +| data | Bytes | 1 | The non-IP data that needed to be delivered to UE from the SCS/AS. | | +| reliableDataService | boolean | 0..1 | Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

- true: reliable data service acknowledgement is requested;
- false (default): reliable data service acknowledgement is not requested. | | +| rdsPort | RdsPort | 0..1 | Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | | +| maximumLatency | DurationSec | 0..1 | It is used to indicate maximum delay acceptable for downlink data and may be used to configure the buffer duration; a Maximum Latency of 0 indicates that buffering is not allowed. If not provided, the SCEF determines the acceptable delay based on local policies. | | +| priority | integer | 0..1 | It is used to indicate the priority of the non-IP data packet relative to other non-IP data packets.
For GroupMessageDelivery feature, this property is not applicable. | | +| pdnEstablishmentOption | PdnEstablishmentOptions | 0..1 | Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

If PDN Connection Establishment Option is not provided with the non-IP packet, the SCEF uses the PDN Connection Establishment Option that was provided during NIDD Configuration to decide how to handle the absence of a PDN connection. | | +| deliveryStatus | DeliveryStatus | 0..1 | Indicates the MT NIDD delivery status. | | +| requestedRetransmissionTime | DateTime | 0..1 | Identifies the absolute time at which the SCEF is expected to retransmit the non-IP data when the deliveryStatus indicates that the non-IP data is buffered in the SCEF. This parameter may be supplied by the SCEF for delivery status | | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|---------------------------------------|--| +| | | | "BUFFERING_TEMPORARILY_NOT_REACHABLE" | | +| NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise. | | | | | +| NOTE 2: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included. | | | | | + +#### 5.6.2.1.4 Type: NiddUplinkDataNotification + +This type represents NIDD uplink data to be notified to the SCS/AS. + +**Table 5.6.2.1.4-1: Definition of type NiddUplinkDataNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| niddConfiguration | Link | 1 | Link to the NIDD configuration resource to which this notification is related. | | +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| data | Bytes | 1 | The non IP data that needed to be delivered from the UE to the SCS/AS. | | +| reliableDataService | boolean | 0..1 | Indicates whether the reliable data service acknowledgement is requested.

- true: reliable data service acknowledgement is requested;
- false: reliable data service acknowledgement is not requested. | | +| rdsPort | RdsPort | 0..1 | Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | | +| NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | +| NOTE 2: One of the properties "externalId" or "msisdn" shall be included. | | | | | + +#### 5.6.2.1.5 Type: NiddDownlinkDataDeliveryStatusNotification + +This type represents the delivery status for a specific NIDD downlink data delivery. + +**Table 5.6.2.1.5-1: Definition of type NiddDownlinkDataDeliveryStatusNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| niddDownlinkDataTransfer | Link | 1 | Link to the NIDD downlink data transfer resource to which this notification is related. | | +| deliveryStatus | DeliveryStatus | 1 | Indicates the MT NIDD delivery status. | | +| requestedRetransmissionTime | DateTime | 0..1 | Identifies the absolute time at which the UE will be reachable.
This parameter may be supplied by the SCEF for delivery status
"FAILURE_TEMPORARILY_NOT_REACHABLE" | | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +### 5.6.2.1.6 Type: NiddConfigurationStatusNotification + +This type represents an NIDD configuration status notification. + +**Table 5.6.2.1.6-1: Definition of type NiddConfigurationStatusNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------|------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| niddConfiguration | Link | 1 | Link to the NIDD configuration resource to which this notification is related. | | +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| status | NiddStatus | 1 | Indicates the NIDD configuration status. | | +| rdsCapIndication | boolean | 0..1 | It indicates whether the network capability for the reliable data service is enabled or not. | | +| rdsPort | RdsPort | 0..1 | Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | Rds_port_verification | + +NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: One of the properties "externalId" or "msisdn" shall be included. + +### 5.6.2.1.7 Type: NiddConfigurationPatch + +This type represents an NIDD configuration used in PATCH. + +**Table 5.6.2.1.7-1: Definition of type NiddConfigurationPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| duration | DateTimeRm | 0..1 | Identifies the absolute time at which the related NIDD Configuration request is considered to expire, as specified in clause 5.13.2 of 3GPP TS 23.682 [2]. When set to null in the PATCH request, it indicates the configuration is requested to be valid forever by the SCS/AS. When omitted in the response, it indicates the configuration is set to valid forever by the SCEF. | | +| reliableDataService | boolean | 0..1 | Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

- true: reliable data service acknowledgement is requested;
- false: reliable data service acknowledgement is not requested. | | +| rdsPorts | array(RdsPort) | 0..N | Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | | +| pdnEstablishment Option | PdnEstablishment OptionsRm | 0..1 | Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent. (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])
The SCEF will use the value as the default preference from the SCS/AS when handling all MT non-IP packets associated with the NIDD connection. | | +| notificationDestination | Link | 0..1 | An URI of a notification destination that the message shall be delivered to. | | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +#### 5.6.2.1.8 Type: GmdNiddDownlinkDataDeliveryNotification + +This type represents the delivery status for a specific group NIDD downlink data delivery. + +**Table 5.6.2.1.8-1: Definition of type GmdNiddDownlinkDataDeliveryNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|-----------------------------------------------------------------------------------------|----------------------| +| niddDownlinkDataTransfer | Link | 1 | Link to the NIDD downlink data transfer resource to which this notification is related. | | +| gmdResults | array(GmdResult) | 1..N | Indicates the group message delivery result. | GroupMessageDelivery | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +#### 5.6.2.1.9 Type: ManagePort + +This type represents the configuration for RDS dynamic port management which is applicable for Rds\_dynamic\_port feature. + +**Table 5.6.2.1.9-1: Definition of type ManagePort** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|------------------|----------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| self | Link | 0..1 | Link to the resource "Individual ManagePort Configuration". This parameter shall be supplied by the SCEF in HTTP PUT/GET responses and in the notification POST request. | | +| applicationId | string | 1 | Indicates the application that is associated with port configuration specified above (as defined in clause 5.4.2.6 of 3GPP TS 24.250 [31]). | | +| manageEntity | ManageEntity | 0..1 | Indicates the "Individual ManagePort Configuration" resource is created by which function entity (UE or the AS). This attribute is supplied by the SCEF. | | +| skipUeInquiry | boolean | 0..1 | Indicate whether to skip UE inquiry. Set to "true" if the SCS/AS decides to reserve port on the SCEF without confirming with the UE; otherwise set to "false". Default value is "false" if omitted. | | +| supportedFormats | array(SerializationFormat) | 0..N | Indicates the serialization format(s) that are supported by the SCS/AS on the associated RDS port.
This attribute is supplied by the SCS/AS. | Rds_serialization_format | +| configuredFormat | SerializationFormat | 0..1 | Indicates the serialization format that has been configured/negotiated for the RDS port.
This attribute is supplied by the SCEF.
(NOTE) | Rds_serialization_format | + +NOTE: The same serialization format is used in the MO and MT directions. + +#### 5.6.2.1.10 Type: ManagePortNotification + +This type represents a ManagePort notification of port numbers that are reserved. + +**Table 5.6.2.1.10-1: Definition of type ManagePortNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|-------------------|-------------------|-------------|-----------------------------------------------------------------------------------------------------|---------------| +| niddConfiguration | Link | 1 | Link to the NIDD configuration resource to which this notification is related. | | +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE) | | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/SDN number allocated for a UE.
(NOTE) | | +| managedPorts | array(ManagePort) | 0..N | Indicates the reserved RDS port configuration information. | | + +NOTE: One of the properties "externalId" or "msisdn" shall be included. + +#### 5.6.2.1.11 Type: NiddDownlinkDataTransferPatch + +This data type represents the parameters to request the modification of an Individual NIDD Downlink Data Delivery resource. + +**Table 5.6.2.1.11-1: Definition of type NiddDownlinkDataTransferPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|------------------------|-------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| data | Bytes | 1 | The updated non-IP data that needs to be delivered to the UE from the SCS/AS. | | +| reliableDataService | boolean | 0..1 | Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

- true: reliable data service acknowledgement is requested;
- false: reliable data service acknowledgement is not requested. | | +| rdsPort | RdsPort | 0..1 | Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | | +| maximumLatency | DurationSec | 0..1 | It is used to indicate the maximum delay acceptable for downlink data delivery. It may be used to configure the buffer duration. A Maximum Latency of 0 indicates that buffering is not allowed.
If not provided, the SCEF determines the acceptable delay based on local policies. | | +| priority | integer | 0..1 | It is used to indicate the priority of these non-IP data packets relative to other non-IP data packets. | | +| pdnEstablishmentOption | PdnEstablishmentOptions | 0..1 | Indicates what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

If PDN Connection Establishment Option is not provided with the non-IP packets, the SCEF uses the PDN Connection Establishment Option that was provided during NIDD Configuration to decide how to handle the absence of a PDN connection. | | + +NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise. + +## 5.6.2.2 Referenced structured data types + +### 5.6.2.2.1 Introduction + +This clause defines structured data types that are referenced from data structures defined in the previous clauses. + +### 5.6.2.2.2 Type: RdsPort + +This type represents the port configuration for Reliable Data Transfer. It shall comply with the provisions defined in table 5.6.2.2.2-1. + +**Table 5.6.2.2.2-1: Definition of RdsPort data Type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|-----------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| portUE | Port | 1 | Indicates the port number on UE that is used for reliable data transfer with a specific application on UE using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | +| portSCEF | Port | 1 | Indicates the port number on SCEF that is used for reliable data transfer with a specific application on SCEF using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]). | + +#### 5.6.2.2.3 Type: GmdResult + +This type represents the group message delivery result. It shall comply with the provisions defined in table 5.6.2.2.3-1. + +**Table 5.6.2.2.3-1: Definition of GmdResult data Type** + +| Attribute name | Data type | Cardinality | Description | +|-------------------------------------------------------------------------|----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in subclause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE) | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE) | +| deliveryStatus | DeliveryStatus | 1 | Indicates the MT NIDD delivery status. | +| requestedRetransmissionTime | DateTime | 0..1 | Identifies the absolute time at which the UE will be reachable. This parameter may be supplied by the SCEF for delivery status "FAILURE_TEMPORARILY_NOT_REACHABLE" | +| NOTE: One of the properties "externalId" or "msisdn" shall be included. | | | | + +#### 5.6.2.2.4 Type: NiddDownlinkDataDeliveryFailure + +This type represents the failure delivery result. It shall comply with the provisions defined in table 5.6.2.2.4-1. + +**Table 5.6.2.2.4-1: Definition of NiddDownlinkDataDeliveryFailure data Type** + +| Attribute name | Data type | Cardinality | Description | +|-----------------------------|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| problemDetail | ProblemDetails | 1 | Detailed problem as defined in clause 5.2.1.2.12. | +| requestedRetransmissionTime | DateTime | 0..1 | Identifies the absolute time at which the UE will be reachable. This parameter may be supplied by the SCEF for error indicating "TEMPORARILY_NOT_REACHABLE" | + +#### 5.6.2.2.5 Type: RdsDownlinkDataDeliveryFailure + +This type represents the failure delivery result for RDS. It shall comply with the provisions defined in table 5.6.2.2.5-1. + +**Table 5.6.2.2.5-1: Definition of RdsDownlinkDataDeliveryFailure data Type** + +| Attribute name | Data type | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------|----------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requestedRetransmissionTime | DateTime | 0..1 | Identifies the absolute time at which the UE will be reachable. This parameter may be supplied by the SCEF for error indicating "TEMPORARILY_NOT_REACHABLE" | +| supportedUeFormats | array(SerializationFormat) | 0..N | Indicates the serialization format(s) that are supported by the UE on the associated RDS port. This parameter may be supplied by the SCEF for error indicating "SERIALIZATION_FORMAT_NOT_SUPPORTED" | +| NOTE: This data type also contains all the properties defined for ProblemDetails data type in clause 5.2.1.2.12. | | | | + +### 5.6.2.3 Referenced simple data types and enumerations + +#### 5.6.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +#### 5.6.2.3.2 Simple data types + +The simple data types defined in table 5.6.2.3.2-1 shall be supported. + +**Table 5.6.2.3.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | + +#### 5.6.2.3.3 Enumeration: PdnEstablishmentOptions + +The enumeration PdnEstablishmentOptions represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE. + +**Table 5.6.2.3.3-1: Enumeration PdnEstablishmentOptions** + +| Enumeration value | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------| +| WAIT_FOR_UE | wait for the UE to establish the PDN connection | | +| INDICATE_ERROR | respond with an error cause | | +| SEND_TRIGGER | send a device trigger | | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | + +#### 5.6.2.3.4 Enumeration: DeliveryStatus + +The enumeration DeliveryStatus represents the status of a downlink NIDD data delivery resource. + +**Table 5.6.2.3.4-1: Enumeration DeliveryStatus** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|----------------------| +| SUCCESS | Success but details not provided | | +| SUCCESS_NEXT_HOP_ACKNOWLEDGED | Successful delivery to the next hop with acknowledgment. | | +| SUCCESS_NEXT_HOP_UNACKNOWLEDGED | Successful delivery to the next hop without acknowledgment | | +| SUCCESS_ACKNOWLEDGED | Reliable delivery was acknowledged by the UE | | +| SUCCESS_UNACKNOWLEDGED | Reliable delivery was not acknowledged by the UE | | +| TRIGGERED | The SCEF triggered the device and is buffering the data. | | +| BUFFERING | The SCEF is buffering the data due to no PDN connection established. | | +| BUFFERING_TEMPORARILY_NOT_REACHABLE | The SCEF has been informed that the UE is temporarily not reachable but is buffering the data | | +| SENDING | The SCEF has forwarded the data, but they may be stored elsewhere. | | +| FAILURE | Delivery failure but details not provided | | +| FAILURE_RDS_DISABLED | RDS was disabled. | | +| FAILURE_NEXT_HOP | Unsuccessful delivery to the next hop. | | +| FAILURE_TIMEOUT | Unsuccessful delivery due to timeout. | | +| FAILURE_TEMPORARILY_NOT_REACHABLE | The SCEF has been informed that the UE is temporarily not reachable without buffering the data. | | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +### 5.6.2.3.5 Enumeration: NiddStatus + +The enumeration NiddStatus represents the status of a NIDD configuration. + +**Table 5.6.2.3.5-1: Enumeration NiddStatus** + +| Enumeration value | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|-----------------------| +| ACTIVE | The NIDD configuration is active. | | +| TERMINATED_UE_NOT_AUTHORIZED | The NIDD configuration was terminated because the UE's authorisation was revoked. | | +| TERMINATED | The NIDD configuration was terminated. | | +| RDS_PORT_UNKNOWN | The RDS port is unknown. | Rds_port_verification | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | + +### 5.6.2.3.6 Enumeration: PdnEstablishmentOptionsRm + +The enumeration PdnEstablishmentOptionsRm represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE. It is defined in clause 5.6.2.3.3 but also allows null value (specified as "NullValue" data type) so it can be removed in "JSON Merge Patch", as defined in IETF RFC 7396 [39]. + +**Table 5.6.2.3.6-1: Enumeration PdnEstablishmentOptionsRm** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------| +| WAIT_FOR_UE | wait for the UE to establish the PDN connection | | +| INDICATE_ERROR | respond with an error cause | | +| SEND_TRIGGER | send a device trigger | | +| NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +### 5.6.2.3.7 Enumeration: ManageEntity + +The enumeration ManageEntity represents the origin that manages the RDS port. + +**Table 5.6.2.3.7-1: Enumeration ManageEntity** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------|---------------| +| UE | Representing the UE. | | +| AS | Representing the Application Server | | + +### 5.6.2.3.8 Enumeration: SerializationFormat + +The enumeration SerializationFormat represents a serialization format associated with an RDS port which is applicable for the Rds\_serialization\_format feature. + +**Table 5.6.2.3.8-1: Enumeration SerializationFormat** + +| Enumeration value | Description | Applicability
(NOTE) | +|-------------------|------------------------------|-------------------------| +| CBOR | The CBOR Serialzition format | | +| JSON | The JSON Serialzition format | | +| XML | The XML Serialzition format | | + +## 5.6.3 Resource structure + +### 5.6.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-nidd/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-nidd" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.6.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | HTTP initiator | Meaning | +|----------------------------------------|-----------------------------------------------------------------------------------------------|-------------|----------------|-------------------------------------------------------------------------------------------------------------| +| NIDD configurations | /{scsAsId}/configurations | GET | SCS/AS | Read all NIDD configuration resources for a given SCS/AS. | +| | | POST | SCS/AS | Create a new NIDD configuration resource. | +| Individual NIDD configuration | /{scsAsId}/configurations/{configurationId} | PATCH | SCS/AS | Modify an existing NIDD configuration resource. | +| | | GET | SCS/AS | Read an NIDD configuration resource. | +| | | DELETE | SCS/AS | Delete an existing NIDD configuration resource. | +| NIDD downlink data deliveries | /{scsAsId}/configurations/{configurationId}/downlink-data-deliveries | GET | SCS/AS | Read all pending NIDD downlink data delivery resources related to a particular NIDD configuration resource. | +| | | POST | SCS/AS | Create an NIDD downlink data delivery resource related to a particular NIDD configuration resource. | +| Individual NIDD downlink data delivery | /{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId} | PUT | SCS/AS | Replace an Individual NIDD downlink data delivery resource. | +| | | PATCH | SCS/AS | Modify an Individual NIDD downlink data delivery resource. | +| | | DELETE | SCS/AS | Delete an NIDD downlink data delivery resource. | +| | | GET | SCS/AS | Read pending NIDD downlink data delivery resource. | +| ManagePort Configurations | /{scsAsId}/configurations/{configurationId}/rds-ports | GET | SCS/AS | Read all RDS ManagePort Configurations. | +| Individual ManagePort Configuration | /{scsAsId}/configurations/{configurationId}/rds-ports/{portId} | PUT | SCS/AS | Create a new Individual ManagePort Configuration resource to reserve port numbers. | +| | | DELETE | SCS/AS | Delete an Individual ManagePort Configuration resource to release port numbers. | +| | | GET | SCS/AS | Read an Individual ManagePort Configuration resource to query port numbers. | + +## 5.6.3.2 Resource: NIDD Configurations + +### 5.6.3.2.1 Introduction + +This resource allows the SCS/AS to create an NIDD configuration at the SCEF, and read all NIDD configurations in the SCEF. + +### 5.6.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations + +This resource shall support the resource URI variables defined in table 5.6.3.2.2-1. + +**Table 5.6.3.2.2-1: Resource URI variables for resource "NIDD Configurations"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.6.3.2.3 Resource methods + +#### 5.6.3.2.3.1 GET + +The GET method allows to read all active NIDD configurations for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.2.3.1-1 and table 5.6.3.2.3.1-2. + +**Table 5.6.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|--------------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | Response codes | Remarks | +| Response body | array(NiddConfiguration) | 0..N | 200 OK | The configuration information for the SCS/AS in the request URI are returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.6.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.6.3.2.3.4 POST + +To create a NIDD configuration, the SCS/AS shall use the HTTP POST method on the "configurations" collection resource as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.2-1. + +The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in table 5.6.3.2.3.4-1. + +**Table 5.6.3.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------|-------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NiddConfiguration | 1 | Parameters to create and authorize a NIDD configuration with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddConfiguration | 1 | 201
Created |

The NIDD configuration was created successfully.

The SCEF shall return a data structure of type "NiddConfiguration" in the response content.

The URI of the created resource shall be returned in the "Location" HTTP header.

| + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId} | + +#### 5.6.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.6.3.3 Resource: Individual NIDD Configuration + +#### 5.6.3.3.1 Introduction + +This resource allows the SCS/AS to query/update/cancel the specific NIDD configuration at the SCEF. + +### 5.6.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId} + +This resource shall support the resource URI variables defined in table 5.6.3.3.2-1. + +**Table 5.6.3.3.2-1: Resource URI variables for resource "Individual NIDD Configuration"** + +| Name | Data type | Definition | +|-----------------|-----------|----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration. The configurationId corresponds to the stage 2 TLTRI. | + +### 5.6.3.3.3 Resource methods + +#### 5.6.3.3.3.1 GET + +The GET method allows to read a NIDD configuration resource to obtain details of an active configuration. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.3.3.1-1 and table 5.6.3.3.3.1-2. + +**Table 5.6.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddConfiguration | 1 | 200 OK | The configuration information related to the request URI is returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.3.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.6.3.3.3.3 PATCH + +Assuming that a NIDD configuration has been created using the HTTP POST method described in clause 5.6.3.2.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "configuration" instance resource as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.2-1 + +The possible response messages from the SCEF, depending on whether the PATCH request is successful or unsuccessful, are shown in table 5.6.3.3.3.3-1. + +**Table 5.6.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------|-------------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NiddConfigurationPatch | 1 | Parameters to update a NIDD configuration with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddConfiguration | 1 | 200 OK | The NIDD configuration was modified successfully.
The SCEF shall return an updated data structure of type "NiddConfiguration" in the response content. | +| | None | | 204 No Content | The NIDD configuration has been modified successfully and no content is to be sent in the response message body. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.6.3.3.3.5 DELETE + +To cancel a NIDD configuration, the SCS/AS shall use the HTTP DELETE method on the individual "NIDD configuration" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.6.3.3.3.5-1. + +**Table 5.6.3.3.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | . | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddConfiguration | 1 | 200 OK | The NIDD configuration was cancelled successfully.
The SCEF shall return a full representation of the deleted resource including a data structure of type "NiddConfiguration" with a "TERMINATE" status in the response body. | +| | None | | 204 No Content | The NIDD configuration was cancelled successfully.
The response body shall be empty. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.6.3.4 Resource: NIDD downlink data deliveries + +#### 5.6.3.4.1 Introduction + +This resource allows the SCS/AS to read all pending NIDD downlink data delivery resources for a particular NIDD configuration resource. + +This resource also allows the SCS/AS to create an NIDD downlink data delivery. + +This resource is applicable for a single UE and a group of UEs NIDD MT delivery. + +#### 5.6.3.4.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries + +This resource shall support the resource URI variables defined in table 5.6.3.4.2-1. + +**Table 5.6.3.4.2-1: Resource URI variables for resource "NIDD Downlink Data Deliveries"** + +| Name | Data type | Definition | +|-----------------|-----------|----------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration. | + +#### 5.6.3.4.3 Resource methods + +##### 5.6.3.4.3.1 GET + +The GET method allows to read all pending NIDD downlink data deliveries for a given SCS/AS and NIDD configuration. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.4.3.1-1 and table 5.6.3.4.3.1-2. + +**Table 5.6.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.4.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(NiddDownlinkData Transfer) | 0..N | 200 OK | All pending NIDD downlink data deliveries for the SCS/AS and NIDD configuration in the request URI are returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**5.6.3.4.3.2 PUT** + +This HTTP method is not supported for the resource. + +**5.6.3.4.3.3 PATCH** + +This HTTP method is not supported for the resource. + +**5.6.3.4.3.4 POST** + +To deliver the downlink non-IP data, the SCS/AS shall use the HTTP POST method on the "NIDD downlink data deliveries" resource with the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.3-1. + +The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.6.3.4.3.4-1. + +**Table 5.6.3.4.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|---------------------------------|--------------------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NiddDownlinkDataTransfer | 1 | The parameters and non-IP data for the MT delivery. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddDownlinkDataTransfer | 1 | 200 OK | The NIDD downlink data delivery was successful.

The SCEF shall return a data structure of type "NiddDownlinkDataTransfer" in the response content. | +| | NiddDownlinkDataTransfer | 1 | 201 Created | The NIDD downlink data delivery request was accepted by the SCEF, the NIDD will be performed later.

The SCEF shall return a data structure of type "NiddDownlinkDataTransfer" in the response content, and shall return the URI of the resource representing the downlink data transfer in the "Location" header. | +| | None | | 307 Temporary Redirect | Temporary redirection, during NIDD downlink data delivery. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during NIDD downlink data delivery. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | NiddDownlinkDataDeliveryFailure | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**Table 5.6.3.4.3.4-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.4.3.4-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.4.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId} | + +#### 5.6.3.4.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.6.3.5 Resource: Individual NIDD downlink data delivery + +#### 5.6.3.5.1 Introduction + +For NIDD MT delivery for a single UE, this resource allows the SCS/AS to read a pending NIDD downlink delivery resource, or to replace or cancel an NIDD downlink data delivery resource related to an NIDD configuration resource. + +For NIDD MT delivery for a group of UEs, this resource allows the SCS/AS to read a pending NIDD downlink delivery resource related to a NIDD configuration resource. + +#### 5.6.3.5.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId} + +This resource shall support the resource URI variables defined in table 5.6.3.5.2-1. + +**Table 5.6.3.4.2-1: Resource URI variables for resource "Individual NIDD Downlink Data Delivery"** + +| Name | Data type | Definition | +|------------------------|-----------|-------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration. | +| downlinkDataDeliveryId | string | Identifier of the downlink data delivery. | + +#### 5.6.3.5.3 Resource methods + +##### 5.6.3.5.3.1 GET + +The GET method allows to read a NIDD downlink data delivery resource to obtain details. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.5.3.1-1 and table 5.6.3.5.3.1-2. + +**Table 5.6.3.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.5.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|--------------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddDownlinkDataTransfer | 1 | 200 OK | Individual NIDD downlink data delivery resource is returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.5.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.5.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.5.3.2 PUT + +To replace the buffered downlink non-IP data, the SCS/AS shall use the HTTP PUT method on the "Individual NIDD downlink data delivery" resource with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.3-1. + +The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.6.3.5.3.2-1. + +**Table 5.6.3.5.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|---------------------------------|--------------------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NiddDownlinkDataTransfer | 1 | The parameters and non-IP data for the MT delivery. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddDownlinkDataTransfer | 1 | 200 OK | The update of the Individual NIDD downlink data delivery resource was successful.

The SCEF shall return an updated representation of the resource within the NiddDownlinkDataTransfer data structure in the response message body. | +| | None | | 204 No Content | The update of the Individual NIDD downlink data delivery was successful and no content is to be sent in the response message body. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | +| | ProblemDetails | 0..1 | 409 Conflict | (NOTE 2) | +| | NiddDownlinkDataDeliveryFailure | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**Table 5.6.3.5.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.5.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.6.3.5.3.3 PATCH + +If the "PatchUpdate" feature defined in clause 5.7.4 is supported, to partially modify the buffered downlink non-IP data, the SCS/AS shall use the HTTP PATCH method on the "Individual NIDD downlink data delivery" resource with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.11-1. + +The possible response messages from the SCEF, depending on whether the HTTP PATCH request is successful or unsuccessful, are shown in Table 5.6.3.5.3.3-1. + +**Table 5.6.3.5.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------------------|-------------|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NiddDownlinkDataTransferPatch | 1 | The parameters to modify an existing Individual NIDD downlink data delivery resource. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NiddDownlinkDataTransfer | 1 | 200 OK | The modification of the Individual NIDD downlink data delivery resource was successful.

The SCEF shall return an updated representation of the resource within the NiddDownlinkDataTransfer data structure in the response message body. | +| | n/a | | 204 No Content | The modification of the Individual NIDD downlink data delivery resource was successful and no content is to be sent in the response message body. | +| | n/a | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | n/a | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | +| | ProblemDetails | 0..1 | 409 Conflict | (NOTE 2) | +| | NiddDownlinkDataDeliveryFailure | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**Table 5.6.3.5.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.5.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.5.3.4 POST + +This HTTP method is not supported for the resource. + +## 5.6.3.5.3.5 DELETE + +To cancel a NIDD downlink data delivery, the SCS/AS shall use the HTTP DELETE method on the "Individual NIDD downlink data delivery" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.6.3.3.5-1. + +**Table 5.6.3.5.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------------------|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | . | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The NIDD downlink data delivery was cancelled successfully.
The response body shall be empty. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | +| | ProblemDetails | 0..1 | 409 Conflict | (NOTE 2) | +| | NiddDownlinkDataDeliveryFailure | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**Table 5.6.3.5.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.5.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +5.6.3.6 Void + +5.6.3.7 Void + +5.6.3.8 Void + +5.6.3.9 Resource: Individual ManagePort Configuration + +5.6.3.9.1 Introduction + +This resource allows the SCS/AS to create, delete or read the specific ManagePort configuration at the SCEF. + +5.6.3.9.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/rds-ports/{portId} + +This resource shall support the resource URI variables defined in table 5.6.3.9.2-1. + +**Table 5.6.3.9.2-1: Resource URI variables for resource "Individual ManagePort Configuration"** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration. The configurationId corresponds to the stage 2 TLTRI. | +| portId | string | UE port identifier including both UE port number and exposure function port number.
Pattern: "^(ue([0-9]{1,0-5}))-ef([0-9]{1,0-5}))\$". | + +5.6.3.9.3 Resource methods + +5.6.3.9.3.1 GET + +The GET method allows to read a ManagePort configuration resource to query the ports reserved. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.9.3.1-1 and table 5.6.3.9.3.1-2. + +**Table 5.6.3.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.9.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ManagePort | 1 | 200 OK | The configuration information related to the request URI is returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.9.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.9.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.9.3.2 PUT + +To create a ManagePort configuration and reserve a port number, the SCS/AS shall use the HTTP PUT method on the "ManagePort" resource with the body of the message is encoded in JSON format with the data structure defined in table 5.6.3.9.3.2-1. + +The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.6.3.9.3.2-1. + +**Table 5.6.3.9.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|--------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| | ManagePort | 1 | The ManagePort configuration to be created which represents the information used for reserving the port configuration for an application. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ManagePort | 1 | 201
Created | This indicates the reservation of port configuration for specified application is successful. | +| | None | | 202
Accepted | This indicates the request for reservation of port configuration for specified application is accepted and under processing. | +| | ProblemDetails | 0..1 | 403
Forbidden | (NOTE 2) | +| | RdsDownlinkDataDeliveryFailure | 0..1 | 500
Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**5.6.3.9.3.3 PATCH** + +This HTTP method is not supported for the resource. + +**5.6.3.9.3.4 POST** + +This HTTP method is not supported for the resource. + +**5.6.3.9.3.5 DELETE** + +To cancel a ManagePort configuration and release port numbers, the SCS/AS shall use the HTTP DELETE method on the ManagePort resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.6.3.9.3.5-1. + +**Table 5.6.3.9.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|--------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ManagePort | 1 | The ManagePort configuration to be cancelled which represents the information used for releasing the port configuration for an application | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | None | | 204 No Content | The ManagePort configuration was cancelled successfully and the port configuration was released. | +| | None | | 202 Accepted | This indicates the request for cancellation of port configuration for specified application is accepted and under processing. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | +| | RdsDownlinkDataDeliveryFailure | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.6.5.3. + +**Table 5.6.3.9.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.9.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +5.6.3.10 Void + +5.6.3.11 Resource: ManagePort Configurations + +5.6.3.11.1 Introduction + +This resource allows the SCS/AS to read all ManagePort configurations for a given NIDD configuration at the SCEF. + +### 5.6.3.11.2 Resource definition + +Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/rds-ports + +This resource shall support the resource URI variables defined in table 5.6.3.11.2-1. + +**Table 5.6.3.11.2-1: Resource URI variables for resource "ManagePort Configurations"** + +| Name | Data type | Definition | +|-----------------|-----------|-------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration of type string. The configurationId corresponds to the stage 2 TLTRI. | + +### 5.6.3.11.3 Resource methods + +#### 5.6.3.11.3.1 GET + +The GET method allows to read all ManagePort configurations on the SCEF. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.6.3.11.3.1-1 and table 5.6.3.11.3.1-2. + +**Table 5.6.3.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.6.3.11.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(ManagePort) | 0..N | 200 OK | All RDS dynamic port configuration information related to the request URI are returned. | +| | None | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | None | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.6.3.11.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.6.3.11.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.6.3.11.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.6.3.11.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.6.3.11.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.6.3.11.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.6.3A Notifications + +#### 5.6.3A.1 General + +The notifications provided by the NIDD API are specified in this clause. + +**Table 5.6.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------------|--------------------|---------------------------------|-----------------------------------------------------------------------------| +| NIDD Configuration Update Notification | {notification_uri} | POST | Send notifications about the status of an NIDD configuration to the SCS/AS. | +| NIDD Downlink Data Delivery Status Notification | {notification_uri} | POST | Report a specific NIDD downlink data delivery result to the SCS/AS. | +| NIDD Uplink Data Notification | {notification_uri} | POST | Send an uplink non-IP data notification from the SCEF to the SCS/AS. | +| ManagePort Notification | {notification_uri} | POST | Send notifications about the port numbers that are reserved. | + +#### 5.6.3A.2 NIDD Configuration Update Notification + +##### 5.6.3A.2.1 Description + +The NIDD Configuration Update Notification allows the SCEF to send notifications about the status of an NIDD configuration to the SCS/AS. + +## 5.6.3A.2.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.6.3A.2.2-1. + +**Table 5.6.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification_uri | Link | A URI indicating the notification destination where T8 notification requests shall be delivered.
This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type. | + +## 5.6.3A.2.3 Standard Methods + +### 5.6.3A.2.3.1 Notification via POST + +To report the status of the NIDD configuration to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.6-1. + +This method shall support the request data structures specified in table 5.6.3A.2.3.1-1 and the response data structures and response codes specified in table 5.6.3A.2.3.1-2. + +**Table 5.6.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|-------------------------------------|-------------|---------------------------------------------| +| NiddConfigurationStatusNotification | 1 | The NIDD configuration status notification. | + +**Table 5.6.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification with a body. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| None | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| None | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.6.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +### 5.6.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the NiddConfigurationStatusNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +## 5.6.3A.3 NIDD Downlink Data Delivery Status Notification + +### 5.6.3A.3.1 Description + +The NIDD Downlink Data Delivery Status Notification allows the SCEF to send notifications about the status of downlink NIDD data delivery to the SCS/AS. This resource is applicable for a single UE and a group of UEs NIDD MT delivery. + +### 5.6.3A.3.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.6.3A.3.2-1. + +**Table 5.6.3A.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification_uri | Link | A URI indicating the notification destination URI where T8 notification requests shall be delivered.
This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type. | + +### 5.6.3A.3.3 Standard Methods + +#### 5.6.3A.3.3.1 Notification via POST + +To report the delivery status of the downlink non-IP data delivery, the SCEF shall use the HTTP POST method on the notification endpoint with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.5-1 for a single UE or table 5.6.2.1.8-1 for a group of UEs. + +This method shall support the request and response data structures specified in table 5.6.3A.3.3.1-1 and table 5.6.3A.3.3.1-2 for a single UE, and support the request and response data structures specified in table 5.6.3A.3.3.1-3 and table 5.6.3A.3.3.1-4 for a group of UEs. + +**Table 5.6.3A.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|--------------------------------------------|-------------|------------------------------------------------------------------| +| NiddDownlinkDataDeliveryStatusNotification | 1 | The Down link data delivery status notification for a single UE. | + +**Table 5.6.3A.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| None | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| None | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3A.3.3.1-3: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|-----------------------------------------------|-------------|---------------------------------------------------------------------| +| GmdNiddDownlinkDataDeliveryStatusNotification | 1 | The Down link data delivery status notification for a group of UEs. | + +**Table 5.6.3A.3.3.1-4: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| None | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| None | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3A.3.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.6.3A.3.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +### 5.6.3A.3.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the NiddDownlinkDataDeliveryStatusNotification or GmdNiddDownlinkDataDeliveryStatusNotification may alternatively be delivered for a single UE or a group of UEs through the Websocket mechanism as defined in clause 5.2.5.4. + +## 5.6.3A.4 NIDD Uplink Data Notification + +### 5.6.3A.4.1 Description + +The NIDD Uplink Data Notification allows the SCEF to send notifications about received NIDD uplink data.. + +### 5.6.3A.4.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.6.3A.4.2-1. + +**Table 5.6.3A.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification_uri | Link | A URI indicating the notification destination URI where T8 notification requests shall be delivered.
This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type. | + +### 5.6.3A.4.3 Standard Methods + +#### 5.6.3A.4.3.1 Notification via POST + +To send the uplink non-IP data to the SCS/AS, the SCEF shall use the HTTP POST method on the notification endpoint in SCS/AS as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.4-1. + +This method shall support the request data structures specified in table 5.6.3A.4.3.1-1 and the response data structures and response codes specified in table 5.6.3A.4.3.1-2. + +**Table 5.6.3A.4.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|----------------------------|-------------|------------------------------------------------------------------------------| +| NiddUplinkDataNotification | 1 | The parameters and non-IP data for the NIDD uplink non-IP data notification. | + +**Table 5.6.3A.4.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the uplink data notification | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| None | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| None | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3A.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.6.3A.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.6.3A.4.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the NiddUplinkDataNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.6.3A.5 ManagePort Notification + +#### 5.6.3A.5.1 Description + +The ManagePort Notification allows the SCEF to send notifications about the port numbers that are reserved. + +#### 5.6.3A.5.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.6.3A.5.2-1. + +**Table 5.6.3A.5.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification_uri | Link | A URI indicating the notification destination URI where T8 notification requests shall be delivered.
This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type. | + +### 5.6.3A.5.3 Standard Methods + +#### 5.6.3A.5.3.1 Notification via POST + +To send the information about reserved ports and their configuration to the SCS/AS, the SCEF shall use the HTTP POST method on the notification endpoint in SCS/AS as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.10-1. + +This method shall support the request data structures specified in table 5.6.3A.5.3.1-1 and the response data structures and response codes specified in table 5.6.3A.5.3.1-2. + +**Table 5.6.3A.5.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|------------------------|-------------|------------------------------------------------------------------------------------------------------------------| +| ManagePortNotification | 1 | The parameters that represents the information about port numbers that are reserved for use with an application. | + +**Table 5.6.3A.5.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful notification of reserved port configuration. | +| (None) | | 204 No Content | The successful acknowledgement of the reserved port configuration without a body. | +| None | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| None | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.6.3A.5.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.6.3A.5.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.6.3A.5.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the ManagePortNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +## 5.6.4 Used Features + +The table below defines the features applicable to the NIDD API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.6.4-1: Features used by NIDD API** + +| Feature Number | Feature | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | GroupMessageDelivery | This feature indicates the support of group message delivery via MT NIDD as defined in clause 5.5.3 of 3GPP TS 23.682 [2]. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 3 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 4 | MT_NIDD_modification_cancellation | Modification and cancellation of an individual MT NIDD resource. | +| 5 | Rds_port_verification | This feature indicates the support of RDS port verification in the MO/MT NIDD delivery. | +| 6 | Rds_dynamic_port | This feature indicates the support of RDS dynamic port management. | +| 7 | Rds_serialization_format | This feature indicates the support of RDS Serialization Format reservation, notification, and query. This feature requires that the Rds_dynamic_port is also supported. | +| 8 | PatchUpdate | Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing subscription resource). | +| Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification".
Description: A clear textual description of the feature. | | | + +## 5.6.5 Error handling + +### 5.6.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.6.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the NIDD API. + +### 5.6.5.3 Application Errors + +The application errors defined for the NIDD API are listed in table 5.6.5.3-1. + +**Table 5.6.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| QUOTA_EXCEEDED | 403 Forbidden | Not enough quota for the MT NIDD | | +| DATA_TOO_LARGE | 403 Forbidden | The non-IP data size is larger than "maximumPacketSize" of the NIDD configuration. | | +| RDS_PORT_UNKNOWN | 403 Forbidden | The SCEF does not know the RDS port numbers in the MT NIDD, such port numbers does not match with the configured port numbers. | Rds_port_verification | +| OPERATION_PROHIBITED | 403 Forbidden | Indicates the operation is prohibited. | | +| PORT_NOT_FREE | 403 Forbidden | Port is not free as it is already associated with an application | Rds_dynamic_port | +| ALREADY_DELIVERED | 404 Not Found | The SCEF has already delivered the buffered data. | | +| PORT_NOT_ASSOC_WITH_APP | 404 Not Found | Port is free and is not associated with any application. | Rds_dynamic_port | +| SENDING | 409 Conflict | The SCEF is already in sending the buffered non-IP data. | | +| TRIGGERED | 500 Internal Server Error | The SCEF triggered the device but did not buffer the data. The SCS AS may resubmit the data | | +| TEMPORARILY_NOT_REACHABLE | 500 Internal Server Error | The SCEF has aborted the delivery because the UE is temporarily not reachable. The SCEF may in addition indicate a requested re-submission time for the data. | | +| NEXT_HOP | 500 Internal Server Error | Unsuccessful delivery to the next hop. | | +| TIMEOUT | 500 Internal Server Error | Unsuccessful delivery due to timeout. | | +| NO_PDN_CONNECTION | 500 Internal Server Error | The SCEF cannot proceed since there is no PDN connection. | | +| SERIALIZATION_FORMAT_NOT_SUPPORTED | 500 Internal Server Error | The SCEF was not able to configure a Serialization Format for the port | Rds_serialization_format | + +## 5.7 DeviceTriggering API + +### 5.7.1 Overview + +The DeviceTriggering API is a RESTful API that allows the SCS/AS to deliver specific device trigger to the SCEF; it allows the SCS/AS to replace or recall the pending device trigger via the SCEF. If the corresponding device trigger delivery report is received by the SCEF, it also allows the SCEF to indicate the trigger delivery result to the SCS/AS. + +The DeviceTriggering API defines a set of data models, resources and the related procedure for the creation and management of the device triggering. The corresponding JSON schema for the representation of the resources and operations defined by the DeviceTriggering API is provided in its complete form in Annex A.7. + +### 5.7.2 Data model + +#### 5.7.2.1 Resource data types + +##### 5.7.2.1.1 Introduction + +This clause defines data structures to be used in resource representations, including subscription resources. + +Table 5.7.2.1.1-1 specifies data types re-used by the DeviceTriggering API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the DeviceTriggering API. + +**Table 5.7.2.1.1-1: DeviceTriggering API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.7.4-1. | + +Table 5.7.2.1.1-2 specifies the data types defined for the DeviceTriggering API. + +**Table 5.7.2.1.1-2: DeviceTriggering API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------------------|----------------|----------------------------------------------------------------------------------------------------------------|---------------| +| DeliveryResult | 5.7.2.2.3 | Represents the result of the delivery of a device triggering request. | | +| DeviceTriggering | 5.7.2.1.2 | Represents device triggering related information. | | +| DeviceTriggeringDeliveryReportNotification | 5.7.2.1.3 | Represents a device triggering delivery report notification. | | +| DeviceTriggeringPatch | 5.7.2.1.4 | Represents the parameters to request the modification of an Individual Device Triggering Transaction resource. | PatchUpdate | +| Priority | 5.7.2.2.4 | Represents the priority indication for a trigger payload. | | + +#### 5.7.2.1.2 Type: DeviceTriggering + +This type represents device triggering request. The same structure is used in the request and response. + +**Table 5.7.2.1.2-1: Definition of type DeviceTriggering** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------------|--------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual Device Triggering Transaction". This parameter shall be supplied by the SCEF in HTTP responses. | | +| externalId | ExternalId | 0..1 | Uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| msisdn | Msisdn | 0..1 | Identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| validityPeriod | DurationSec | 1 | The validity time in seconds for the specific action requested. | | +| priority | Priority | 1 | Identifies the priority of the device trigger. | | +| applicationPortId | Port | 1 | This is used to uniquely identify the triggering application addressed in the device for destination port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. | | +| appSrcPortId | Port | 0..1 | This is used to uniquely identify the triggering application addressed in the device for originator port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. | | +| triggerPayload | Bytes | 1 | The device triggering payload. | | +| notificationDestination | Link | 1 | A URI indicating the notification destination for T8 notifications. | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| deliveryResult | DeliveryResult | 0..1 | The delivery result shall be included in the HTTP responses that indicate the delivery status of the device triggering. | | + +NOTE 1: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: One of the properties "externalId" or "msisdn" shall be included. + +### 5.7.2.1.3 Type: DeviceTriggeringDeliveryReportNotification + +This type represents device triggering delivery report notification. + +**Table 5.7.2.1.4-1: Definition of type DeviceTriggeringDeliveryReportNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------|---------------------------------------------------------------------------------------------------|----------------------| +| transaction | Link | 1 | Link to the related device triggering transaction resource to which this notification is related. | | +| Result | DeliveryResult | 1 | OK, unknown or diverse failures | | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +#### 5.7.2.1.4 Type: DeviceTriggeringPatch + +This type represents the parameters to request the modification of an Individual Device Triggering Transaction resource. + +**Table 5.7.2.1.4-1: Definition of type DeviceTriggeringPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| validityPeriod | DurationSec | 1 | The validity time in seconds for the specific action requested. | | +| priority | Priority | 1 | Identifies the priority of the device triggering request. | | +| applicationPortId | Port | 1 | This is used to uniquely identify the triggering application addressed in the device for the destination port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. | | +| appSrcPortId | Port | 0..1 | This is used to uniquely identify the triggering application addressed in the device for the originator port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. | | +| triggerPayload | Bytes | 1 | The modified device triggering payload. | | +| notificationDestination | Link | 1 | A URI indicating the notification destination for T8 notifications. | | +| NOTE 1: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +#### 5.7.2.2 Referenced simple data types and enumerations + +##### 5.7.2.2.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +##### 5.7.2.2.2 Simple data types + +The simple data types defined in table 5.7.2.2.2-1 shall be supported. + +**Table 5.7.2.2.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | +| | | + +##### 5.7.2.2.3 Enumeration: DeliveryResult + +The enumeration DeliveryResult represents the result of the delivery of a device triggering request + +**Table 5.7.2.2.3-1: Enumeration DeliveryResult** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| SUCCESS | The SCEF includes this value in a device triggering notification.
The value indicates that the device action request was successfully completed. | | +| UNKNOWN | The SCEF includes this value in a device triggering notification.
The value indicates any unspecified errors. | | +| FAILURE | The SCEF includes this value in a device triggering notification.
The value indicates that this trigger encountered a delivery error and is deemed permanently undeliverable. | | +| TRIGGERED | The SCEF includes this value in the response for a successful device triggering request.
The value indicates that device triggering request is accepted by the SCEF. | | +| EXPIRED | The SCEF includes this value in a device triggering notification.
The value indicates that the validity period expired before the trigger could be delivered. | | +| UNCONFIRMED | The SCEF includes this value in a device triggering notification.
The value indicates that the delivery of the device action request is not confirmed. | | +| REPLACED | The SCEF includes this value in the response for a successful device triggering replacement request.
The value indicates that the device triggering replacement request is accepted by the SCEF. | | +| TERMINATE | The SCEF includes this value in the response for a successful device triggering cancellation request.
The value indicates that the delivery of the device action request is terminated by the SCS/AS. | | +| NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.7.2.2.4 Enumeration: Priority + +The enumeration Priority represents the priority indication for a trigger payload. + +**Table 5.7.2.2.4-1: Enumeration Priority** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|----------------------| +| NO_PRIORITY | This value indicates that the device trigger has no priority. | | +| PRIORITY | This value indicates that the device trigger has priority. | | +| NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +### 5.7.3 Resource structure + +#### 5.7.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-device-triggering/v1** + +"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.7.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | HTTP initiator | Meaning | +|------------------------------------------|-----------------------------------------|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------| +| Device Triggering Transactions | /{scsAsId}/transactions | GET | SCS/AS | Read all active device triggering transaction resources for a given SCS/AS | +| | | POST | SCS/AS | Create a new device triggering transaction resource | +| Individual Device Triggering Transaction | /{scsAsId}/transactions/{transactionId} | PUT | SCS/AS | Replace an existing Individual Device Triggering Transaction resource and the corresponding device triggering request | +| | | PATCH | SCS/AS | Modify an existing Individual Device Triggering Transaction resource and the corresponding device triggering request. | +| | | GET | SCS/AS | Read a device triggering transaction resource | +| | | DELETE | SCS/AS | Delete an existing device triggering transaction resource and cancel the device triggering | + +### 5.7.3.2 Resource: Device Triggering Transactions + +#### 5.7.3.2.1 Introduction + +This resource allows the SCS/AS to read all active resources related to device triggering, and create a resource for a device triggering transaction with the SCEF. + +#### 5.7.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions + +This resource shall support the resource URI variables defined in table 5.7.3.2.2-1. + +**Table 5.7.3.2.2-1: Resource URI variables for resource "Device Triggering Transactions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.7.3.2.3 Resource methods + +##### 5.7.3.2.3.1 GET + +The GET method allows to read all active device triggering transactions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in table 5.7.3.2.3.1-1 and table 5.7.3.2.3.1-2. + +**Table 5.7.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.7.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(DeviceTriggering) | 0..N | 200 OK | The device triggering transactions information for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.7.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.7.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.7.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.7.3.2.3.4 POST + +To create a long-term transaction for a device triggering, the SCS/AS shall use the HTTP POST method on the "transactions" collection resource as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.7.2.1.2-1. + +The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.7.3.2.3.4-1. + +**Table 5.7.3.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|---------|----------------|--|--|--| +| | DeviceTriggering | | 1 | | | | | +| Response body | Data type | Cardinality | Remarks | | | | | +| | DeviceTriggering | | | 201
Created | | | | +| Parameters to request a device triggering delivery. | | | | | | | | +| The long term transaction for the device triggering was created successfully.
The SCEF shall return a data structure of type "DeviceTriggering" in the response content.
The URI of the created resource shall be returned in the "Location" HTTP header | | | | | | | | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions/{transactionId} | + +#### 5.7.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.7.3.3 Resource: Individual Device Triggering Transaction + +#### 5.7.3.3.1 Introduction + +This resource allows the SCS/AS to operate a specific pending device triggering by using a long-term transaction. + +#### 5.7.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions/{transactionId} + +This resource shall support the resource URI variables defined in table 5.7.3.3.2-1. + +**Table 5.7.3.3.2-1: Resource URI variables for resource "Individual Device Triggering Transaction"** + +| Name | Data type | Definition | +|---------------|-----------|---------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| transactionId | string | Identifier of the transaction resource. The transactionId corresponds to the stage 2 TLTRI. | + +#### 5.7.3.3.3 Resource methods + +##### 5.7.3.3.3.1 GET + +The GET method allows to read an individual device triggering transaction resource to obtain details of an active transaction. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.7.3.3.3.1-1 and table 5.7.3.3.3.1-2. + +**Table 5.7.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.7.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | DeviceTriggering | 1 | 200 OK | The device triggering transaction information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.7.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.7.3.3.3.2 PUT + +A pending device triggering delivery can be replaced by the SCS/AS. To replace the pending device triggering, the SCS/AS shall use the HTTP PUT method on the "transaction" instance resource as follows with the body of the message encoded in JSON format including the data structure defined in table 5.7.2.1.2-1 + +The properties "msisdn" or "externalId" shall remain unchanged from previously provided value. + +The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.7.3.3.3.2-1. + +**Table 5.7.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DeviceTriggering | 1 | Parameters to replace a device triggering with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | DeviceTriggering | 1 | 200 OK | The device triggering was replaced successfully.

The SCEF shall return an updated representation of the resource within the DeviceTriggering data structure including the "deliveryResult" attribute in the response message body. | +| | none | | 204 No Content | The device triggering was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.7.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.7.3.3.3.3 PATCH + +A pending device triggering delivery can be modified by the SCS/AS. If the "PatchUpdate" feature defined in clause 5.7.4 is supported, to partially modify a pending device triggering, delivery, the SCS/AS shall use the HTTP PATCH method on the concerned Individual Device Triggering Transaction resource as follows with the body of the message is encoded in JSON format including the data structure defined in table 5.7.2.1.4-1 + +The possible response messages from the SCEF, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.7.3.3.3-1. + +**Table 5.7.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-----------------------|--------------------|---------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | DeviceTriggeringPatch | 1 | Parameters to request the modification of a pending device triggering delivery. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | DeviceTriggering | 1 | 200 OK | The Individual Device Triggering Transaction resource was successfully modified and a representation of the modified Individual Device Triggering Transaction resource within the DeviceTriggering data structure including the "deliveryResult" attribute is returned by the SCEF in the response message body. | +| | n/a | | 204 No Content | The Individual Device Triggering Transaction resource was successfully modified no content is to be sent in the response message body. | +| | n/a | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | n/a | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.7.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.7.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.7.3.3.3.5 DELETE + +To cancel an ongoing device triggering delivery, the SCS/AS shall use the HTTP DELETE method on the individual "transaction" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.7.3.3.3.5-1. + +**Table 5.7.3.3.3.5-1: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | DeviceTriggering | 1 | 200 OK | The Device Triggering delivery was cancelled successfully.
The SCEF shall return a data structure of type "DeviceTriggering" with a "TERMINATE" status in the response body. | +| | None | | 204 No Content | The Device Triggering was cancelled successfully.
The SCEF shall not return a response content. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction termination.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction termination.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.7.3.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.7.3.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.7.3.4 Void + +## 5.7.3A Notifications + +### 5.7.3A.1 General + +The notifications provided by the DeviceTriggering API are specified in this clause. + +**Table 5.7.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------------------------|--------------------|---------------------------------|-------------------------------------------------------| +| Device Triggering
Delivery Report
Notification | {notification_uri} | POST | Report a device triggering delivery report to SCS/AS. | + +## 5.7.3A.2 Device Triggering Delivery Report Notification + +### 5.7.3A.2.1 Description + +The Device Triggering Delivery Report Notification allows the SCEF to send notifications about device triggering delivery report events to the SCS/AS. + +### 5.7.3A.2.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.7.3A.2.2-1. + +**Table 5.7.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification_uri | Link | A URI indicating the notification destination URI where T8 notification requests shall be delivered.
This URI shall be provided within the "notificationDestination" attribute in the DeviceTriggering type. | + +### 5.7.3A.2.3 Standard Methods + +#### 5.7.3A.2.3.1 Notification via POST + +To report the delivery status of the device triggering delivery, the SCEF shall use the HTTP POST method on the notification endpoint as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.7.2.1.4-1. + +This method shall support the request data structures specified in table 5.7.3A.2.3.1-1 and the response data structures and response codes specified in table 5.7.3A.2.3.1-2. + +**Table 5.7.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|--------------------------------------------|-------------|----------------------------------------| +| DeviceTriggeringDeliveryReportNotification | 1 | The Device Triggering delivery report. | + +**Table 5.7.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.7.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.7.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +### 5.7.3a.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the DeviceTriggeringDeliveryReportNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +## 5.7.4 Used Features + +The table below defines the features applicable to the DeviceTriggering API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.7.4-1: Features used by DeviceTriggering API** + +| Feature Number | Feature | Description | +|----------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 3 | PatchUpdate | Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing subscription resource). | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +## 5.7.5 Error handling + +### 5.7.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the DeviceTriggering API. + +### 5.7.5.3 Application Errors + +The application errors defined for DeviceTriggering API are listed in table 5.7.5.3-1. + +**Table 5.7.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.8 GMD via MBMS related APIs + +### 5.8.1 Overview + +There are two Group Message Delivery via MBMS related APIs defined: + +- GMDviaMBMSbyMB2 API; +- GMDviaMBMSbyxMB API. + +Both APIs are RESTful APIs that allow the SCS/AS to deliver the group message to the SCEF. They define a set of data models, resources and the related procedures for the creation and management of the group message delivery. The corresponding JSON schema for the representation of the resources and operations defined by the GMDviaMBMSbyMB2 API and GMDviaMBMSbyxMB API are provided in its complete form in Annex A.8.1 and Annex A.8.2, respectively. + +### 5.8.2 GMDviaMBMSbyMB2 API + +#### 5.8.2.1 Data model + +##### 5.8.2.1.1 Resource data types + +###### 5.8.2.1.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.8.2.1.1.1-1 specifies data types re-used by the GMDviaMBMSbyMB2 API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the GMDviaMBMSbyMB2 API. + +**Table 5.8.2.1.1.1-1: GMDviaMBMSbyMB2 API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|------------------------------------------------------------------------------------------| +| GeographicArea | 3GPP TS 29.572 [42] | Identifies the geographical information of the user(s). | +| CivicAddress | 3GPP TS 29.572 [42] | Identifies the civic address information of the user(s). | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.8.2.3-1. | + +Table 5.8.2.1.1.1-2 specifies the data types defined for the GMDviaMBMSbyMB2 API. + +**Table 5.8.2.1.1.1-2: GMDviaMBMSbyMB2 API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|-------------------------------------------------------------------------------------------------|---------------| +| GMDBYMB2Notification | 5.8.2.1.1.4 | Represents a group message delivery notification. | | +| GMDViaMBMSByMb2 | 5.8.2.1.1.3 | Represents a group message delivery via MBMS by MB2. | | +| GMDViaMBMSByMb2Patch | 5.8.2.1.1.6 | Represents a modification request of a group message delivery via MBMS by MB2. | | +| MbmsLocArea | 5.8.2.1.1.7 | Represents a user location area within which is sent a group message delivery via MBMS request. | | +| TMGIAllocation | 5.8.2.1.1.2 | Represents an individual TMGI Allocation resource. | | +| TMGIAllocationPatch | 5.8.2.1.1.5 | Represents the parameters to request the modification of a TMGI Allocation resource. | | + +###### 5.8.2.1.1.2 Type: TMGIAllocation + +This type represents TMGI Allocation request. The same structure is used in the request and response. + +**Table 5.8.2.1.1.2-1: Definition of type TMGIAllocation** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------|-------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| self | Link | 0..1 | Link to the resource "Individual TMGI Allocation". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2]. | | +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | +| tmgiExpiration | DateTimeRo | 0..1 | Identifies the absolute time at which the TMGI is considered to expire. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.8.2.1.1.3 Type: GMDViaMBMSByMb2 + +This type represents the group message delivery via MBMS by MB2. + +**Table 5.8.2.1.1.3-1: Definition of type GMDViaMBMSByMb2** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------|--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual GMD via MBMS by MB". This parameter shall be supplied by the SCEF in HTTP responses. | | +| notificationDestination | Link | 1 | A URI indicating the notification destination where T8 notification requests shall be delivered | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2]. | | +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | +| messageDeliveryStartTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately. | | +| groupMessagePayload | Bytes | 0..1 | Indicates the payload the SCS/AS intends to deliver to the UEs. | | +| scefMessageDeliveryIPv4 | Ipv4AddrRo | 0..1 | Indicates the Ipv4 address where the SCEF wants to receive the data. | | +| scefMessageDeliveryIPv6 | Ipv6AddrRo | 0..1 | Indicates the Ipv6 address where the SCEF wants to receive the data. | | +| scefMessageDeliveryPort | PortRo | 0..1 | Indicates the port number where the SCEF wants to receive the data. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +## 5.8.2.1.1.4 Type: GMDBYMb2Notification + +This type represents the group message delivery notification. + +**Table 5.8.2.1.1.4-1: Definition of type GMDBYMb2Notification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-----------------------|-----------|-------------|---------------------------------------------------------------------------------------------------------------------|----------------------| +| transaction | Link | 1 | Link to the transaction resource to which this notification is related. | | +| deliveryTriggerStatus | boolean | 1 | Indicates whether delivery of group message payload corresponding to the TMGI was successful (TRUE) or not (FALSE). | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +## 5.8.2.1.1.5 Type: TMGIAllocationPatch + +This type represents TMGI Allocation request. The structure is used for PATCH request. + +**Table 5.8.2.1.1.5-1: Definition of type TMGIAllocationPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-----------------|-----------------|-------------|-------------------------------------------------------------------------------------------|----------------------| +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2]. | | +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +## 5.8.2.1.1.6 Type: GMDViaMBMSByMb2Patch + +This type represents group message delivery via MBMS request by MB2. The structure is used for PATCH request. + +**Table 5.8.2.1.1.6-1: Definition of the GMDViaMBMSByMb2Patch data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------|-----------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2]. | | +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | +| messageDeliveryStartTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately. | | +| groupMessagePayload | Bytes | 0..1 | Indicates the payload the SCS/AS intends to deliver to the UEs. | | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination where the notification requests shall be delivered. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.8.2.1.1.7 Type: MbmsLocArea + +This data type represents the user location area which is sent from the SCS/AS to the SCEF by group message delivery via MBMS request. + +**Table 5.8.2.1.1.7-1: Definition of the MbmsLocArea data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-------------|----------------------------------------------------------------------------------------------------|----------------------| +| cellId | array(string) | 0..N | Indicates a Cell Global Identification of the user which identifies the cell the UE is registered. | | +| enodeBId | array(string) | 0..N | Indicates an eNodeB in which the UE is currently located. | | +| geographicArea | array(Geographic Area) | 0..N | Identifies a geographic area of the user where the UE is located. | | +| mbmsServiceAreaId | array(string) | 0..N | Identifies an MBMS Service Area Identity of the user where the UE is located. | | +| civicAddress | array(CivicAddresses) | 0..N | Identifies a civic address of the user where the UE is located. | | +| NOTE: Properties marked with a feature as defined in clause 5.8.2.3 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +#### 5.8.2.2 Resource structure + +##### 5.8.2.2.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-group-message-delivery-mb2/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-group-message-delivery-mb2" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.8.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | HTTP initiator | Meaning | +|--------------------------------|-----------------------------------------------------------------------------|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------| +| TMGI Allocation | /{scsAsId}
/tmgi-allocation | GET | SCS/AS | Read all active TMGI resources for a given SCS/AS | +| | | POST | SCS/AS | Create a new TMGI resource for a given SCS/AS | +| Individual TMGI Allocation | /{scsAsId}
/tmgi-allocation/{tmgi} | PUT | SCS/AS | Replace an existing TMGI resource for a given SCS/AS and TMGI | +| | | PATCH | SCS/AS | Modify an existing TMGI resource for a given SCS/AS and TMGI | +| | | GET | SCS/AS | Read a TMGI allocation resource for a given SCS/AS and a TMGI | +| | | DELETE | SCS/AS | Deallocate an existing TMGI resource for a given SCS/AS and TMGI | +| GMD via MBMS by MB2 | /{scsAsId}
/tmgi-allocation/{tmgi}/delivery-via-mbms | GET | SCS/AS | Read all group message delivery resources for a given SCS/AS and TMGI. | +| | | POST | SCS/AS | Create a group message delivery resource for given SCS/AS and TMGI selected by the SCS/AS when MB2 is used as a southbound interface. | +| Individual GMD via MBMS by MB2 | /{scsAsId}
/tmgi-allocation/{tmgi}/delivery-via-mbms/
{transactionId} | PUT | SCS/AS | Replace a group message delivery resource | +| | | PATCH | SCS/AS | Modify a group message delivery resource. | +| | | GET | SCS/AS | Read a group message delivery resource. | +| | | DELETE | SCS/AS | Delete a group message delivery resource. | + +## 5.8.2.2.2 Resource: TMGI Allocation + +### 5.8.2.2.2.1 Introduction + +This resource allows the SCS/AS to read all active TMGI or request a TMGI allocation. + +### 5.8.2.2.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation + +This resource shall support the resource URI variables defined in table 5.8.2.2.2.2-1. + +**Table 5.8.2.2.2.2-1: Resource URI variables for resource "TMGI Allocation"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.8.2.2.2.3 Resource methods + +#### 5.8.2.2.2.3.1 GET + +The GET method read all TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.2.3.1-1. + +**Table 5.8.2.2.2.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(TMGIAllocation) | 0..N | 200 OK | The TMGI allocation for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.2.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.2.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.8.2.2.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.8.2.2.2.3.4 POST + +The POST method creates a new TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.2.3.4-1. + +**Table 5.8.2.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|-----------------------------------------------------------------------------------------------------|----------------|-------------|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | TMGIAllocation | 1 | Parameters to create a TMGI allocation resource | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | TMGIAllocation | 1 | 201
Created |

The creation of a TMGI allocation was created successfully.

The SCEF shall return a data structure of type "TMGI Allocation" in the response content.

On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the TMGI

| +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.8.2.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi} | + +#### 5.8.2.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.8.2.2.3 Resource: Individual TMGI Allocation + +#### 5.8.2.2.3.1 Introduction + +This resource allows the SCS/AS to read an active TMGI or renew an TMGI. + +#### 5.8.2.2.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi} + +This resource shall support the resource URI variables defined in table 5.8.2.2.3.2-1. + +**Table 5.8.2.2.3.2-1: Resource URI variables for resource "Individual TMGI Allocation"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| Tmgi | string | TMGI. | + +#### 5.8.2.2.3.3 Resource methods + +##### 5.8.2.2.3.3.1 GET + +The GET method reads a TMGI Allocation resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.1-1. + +**Table 5.8.2.2.3.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | TMGIAllocation | 1 | 200 OK | A TMGI allocation for the SCS/AS in the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.3.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.3.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.3.3.2 PUT + +The PUT method replaces a TMGI Allocation resource for a given SCS/AS to renew a TMGI expiration time. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.2-1. + +**Table 5.8.2.2.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------|-------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | TMGIAllocation | 1 | Parameters to replace a TMGI resource | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | TMGIAllocation | 1 | 200 OK | The replace of a TMGI allocation was created successfully. | +| | none | | 204 No Content | The TMGI expiration time renewal is successful, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.3.3.3 PATCH + +The PATCH method modifies a TMGI Allocation resource for a given SCS/AS to renew a TMGI expiration time. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.3-1. + +**Table 5.8.2.2.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------|-------------|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | TMGIAllocationPatch | 1 | Parameters to modify a TMGI resource | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | TMGIAllocation | 1 | 200 OK | The modification of a TMGI allocation was created successfully. | +| | none | | 204 No Content | The TMGI expiration time renewal is successful, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.8.2.2.3.3.5 DELETE + +The DELETE method deletes a TMGI Allocation resource for a given SCS/AS to deallocate a TMGI. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.3.3.5-1. + +**Table 5.8.2.2.3.3.5-1: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The TMGI allocation resource was removed successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.8.2.2.4 Resource: GMD via MBMS by MB2 + +### 5.8.2.2.4.1 Introduction + +This resource allows the SCS/AS to read all active group message delivery resources or create a group message delivery when the MB2 is used as a southbound interface. + +### 5.8.2.2.4.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms + +This resource shall support the resource URI variables defined in table 5.8.2.2.4.2-1. + +**Table 5.8.2.2.4.2-1: Resource URI variables for resource "GMD via MBMS by MB2"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| Tmgi | string | TMGI | + +## 5.8.2.2.4.3 Resource methods + +## 5.8.2.2.4.3.1 GET + +The GET method reads all group message delivery via MBMS resources for a given SCS/AS and a TMGI. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.4.3.1-1. + +**Table 5.8.2.2.4.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(GMDViaMBMSBy Mb2) | 0..N | 200 OK | The TMGI allocation for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.4.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.4.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.8.2.2.4.3.2 PUT + +This HTTP method is not supported for the resource. + +## 5.8.2.2.4.3.3 PATCH + +This HTTP method is not supported for the resource. + +## 5.8.2.2.4.3.4 POST + +The POST method creates a new group message delivery via MBMS resource for a given SCS/AS and TMGI selected by the SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. The SCEF shall construct the URI of the created resource using that URI. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.4.3.4-1. + +**Table 5.8.2.2.4.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByMb2 | 1 | Parameters to create and authorize a group message delivery via MBMS with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByMb2 | 1 | 201
Created |

The creation of a group message delivery was created successfully.

The SCEF shall return a data structure of type "GMDViaMBMSByMb2" in the response content.

On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the Transaction Id.

| + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.4.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms/{transactionId} | + +#### 5.8.2.2.4.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.8.2.2.5 Resource: Individual GMD via MBMS by MB2 + +#### 5.8.2.2.5.1 Introduction + +This resource allows the SCS/AS to modify or delete a group message delivery via MBMS by MB2 resource. + +#### 5.8.2.2.5.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-mb2/v1/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms/{transactionId} + +This resource shall support the resource URI variables defined in table 5.8.2.2.5.2-1. + +**Table 5.8.2.2.5.2-1: Resource URI variables for resource "Individual GMD via MBMS by MB2"** + +| Name | Data type | Definition | +|---------------|-----------|-----------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| transactionId | string | TransactionId selected by the SCEF. The transactionId corresponds to the stage 2 TLTRI. | + +#### 5.8.2.2.5.3 Resource methods + +##### 5.8.2.2.5.3.1 GET + +The GET method reads a group message delivery via MBMS by MB2 resource for a given SCS/AS, a TMGI and a transactionId. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.5.3.1-1. + +**Table 5.8.2.2.5.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSbyMb2 | 0..1 | 200 OK | The group message delivery resource for the SCS/AS in the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.5.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.5.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.5.3.2 PUT + +Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.2.2.4.3.4, replace of its properties can be performed by the SCS/AS by using the HTTP PUT method on the "delivery\_via\_mbms" instance resource as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.8.2.2.5.3.2-1. + +The content body of the group message delivery via MBMS update request shall contain updated full representation of the group message delivery resource. Only the properties "locationinfo", "accuracy", "messageDelivervstarttime" and "groupMessagepayload" can be modified. + +The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in table 5.8.2.2.5.3.2-1. + +**Table 5.8.2.2.5.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByMb2 | 1 | Parameters to replace group message delivery resource with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByMb2 | 1 | 200 OK | The group message delivery was modified successfully.
The SCEF shall return an updated data structure of type "GMDViaMBMSByMb2" in the response content. | +| | none | | 204 No Content | The group message delivery is replaced successfully, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.5.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.5.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.8.2.2.5.3.3 PATCH + +Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.2.2.4.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "delivery-via-mbms" instance resource. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.2.2.5.3.3-1. + +**Table 5.8.2.2.5.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|----------------------|--------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByMb2Patch | 1 | Parameters to partially update a group message delivery with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByMb2 | 1 | 200 OK | The group message delivery was modified successfully.
The SCEF shall return an updated data structure of type "GMDViaMBMSByMb2" in the response content. | +| | none | | 204 No Content | The group message delivery is modified successfully, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.5.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.5.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.2.2.5.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.8.2.2.5.3.5 DELETE + +To cancel a group message delivery, the SCS/AS shall use the HTTP DELETE method on the individual "delivery\_via\_mbms" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.2.2.5.3.5-1. + +**Table 5.8.2.2.5.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The group message delivery subscription was cancelled successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2.5.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.2.2.5.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.8.2.2.6 Void + +## 5.8.2.2A Notifications + +### 5.8.2.2A.1 General + +The notifications provided by the GMDviaMBMSbyMB2 API are specified in this clause. + +**Table 5.8.2.2A.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------|---------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------| +| GMD via MBMS by MB2 Notification | {notificationDestination} | POST | Report a specific group message delivery result to the SCS/AS for a given transaction Id selected by the SCEF. | + +## 5.8.2.2A.2 GMD via MBMS by MB2 Notification + +### 5.8.2.2A.2.1 Description + +The GMD via MBMS by MB2 Notification allows the SCEF report the delivery trigger status to the SCS/AS to indicate whether group message delivery was triggered successful. + +### 5.8.2.2A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.8.2.2A.2.2-1. + +**Table 5.8.2.2A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | A URI indicating the notification destination where T8 notification requests shall be delivered.
This URI shall be provided within the field "notificationDestination" in the GMDViaMBMSByMb2 type. | + +### 5.8.2.2A.2.3 Standard Methods + +#### 5.8.2.2A.2.3.1 Notification via POST + +To report the status of the delivery trigger status to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.8.2.1.1.4-1. + +This method shall support the request data structures specified in table 5.8.2.2A.2.3.1-1 and the response data structures and response codes specified in table 5.8.2.2A.2.3.1-2. + +**Table 5.8.2.2A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|----------------------|-------------|-----------------------------------| +| GMDBYMb2Notification | 1 | The delivery status notification. | + +**Table 5.8.2.2A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification with a body. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.8.2.2A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.8.2.2A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.8.2.2A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the GMDByMb2Notification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.8.2.3 Used Features + +The table below defines the features applicable to the GMDviaMBMSbyMB2 API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.8.2.3-1: Features used by GMDviaMBMSbyMB2 API** + +| Feature Number | Feature | Description | +|-----------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". | | | +| Description: A clear textual description of the feature. | | | + +### 5.8.2.4 Error handling + +#### 5.8.2.4.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +#### 5.8.2.4.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the GMDviaMBMSbyMB2 API. + +#### 5.8.2.4.3 Application Errors + +The application errors defined for GMDviaMBMSbyMB2 API are listed in table 5.8.2.4.3-1. + +**Table 5.8.2.4.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.8.3 GMDviaMBMSbyxMB API + +### 5.8.3.1 Data model + +#### 5.8.3.1.1 Resource data types + +##### 5.8.3.1.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.8.3.1.1.1-1 specifies data types re-used by the GMDviaMBMSbyxMB API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the GMDviaMBMSbyxMB API. + +**Table 5.8.3.1.1.1-1: GMDviaMBMSbyxMB API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|------------------------------------------------------------------------------------------| +| GeographicArea | 3GPP TS 29.572 [42] | Identifies the geographical information of the user(s). | +| CivicAddress | 3GPP TS 29.572 [42] | Identifies the civic address information of the user(s). | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.8.3.3-1. | + +Table 5.8.3.1.1.1-2 specifies the data types defined for the GMDviaMBMSbyxMB API. + +**Table 5.8.3.1.1.1-2: GMDviaMBMSbyxMB API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|--------------------------------------------------------------------------------------------------|---------------| +| GMDBByxMBNotification | 5.8.3.1.1.4 | Represents a group message delivery notification. | | +| GMDViaMBMSByxMB | 5.8.3.1.1.3 | Represents a group message delivery via MBMS by xMB. | | +| GMDViaMBMSByxMBPatch | 5.8.3.1.1.5 | Represents a modification request of a group message delivery via MBMS by xMB. | | +| MbmsLocArea | 5.8.3.1.1.6 | Represents a user location area whithin which is sent a group message delivery via MBMS request. | | +| ServiceAnnouncementMode | 5.8.3.1.2.3 | Represents the service announcement mode. | | +| ServiceCreation | 5.8.3.1.1.2 | Represents an individual xMB Service resource. | | + +##### 5.8.3.1.1.2 Type: ServiceCreation + +This type represents the service resource. + +**Table 5.8.3.1.1.2-1: Definition of the ServiceCreation data type** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE) | +|-------------------------|-------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual xMB Service". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in clause 4.6.2 of 3GPP TS 23.682 [2] supplied by the SCS/AS. | | +| userServiceId | string | 0..1 | Identifies the MBMS User Service supplied by the SCEF. | | +| serviceClass | string | 0..1 | The service class that service belongs to supplied by the SCEF. | | +| serviceLanguages | array(string) | 0..N | List of language of the service content supplied by the SCEF. | | +| serviceNames | array(string) | 0..N | List of Service Names supplied by the SCEF | | +| receiveOnlyMode | boolean | 0..1 | When set to 'true', the Content Provider indicates that the service is a Receive Only Mode service. This parameter is supplied by the SCEF | | +| serviceAnnouncementMode | ServiceAnnouncementMode | 0..1 | Enumeration of Service Announcement Mode supplied by the SCEF. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.8.3.1.1.3 Type: GMDViaMBMSByxMB + +This type represents the group message delivery via MBMS by xMB. + +**Table 5.8.3.1.1.3-1: Definition of type GMDViaMBMSByxMB** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------|--------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual GMD via MBMS by xMB". This parameter shall be supplied by the SCEF in HTTP responses. | | +| notificationDestination | Link | 1 | A URI indicating the notification destination where T8 notification requests shall be delivered | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | +| messageDeliveryStartTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately. | | +| messageDeliveryStopTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As is expected to stop distributing the data. If absent, configuration time will be used. | | +| groupMessagePayload | Bytes | 0..1 | Indicates the payload the SCS/AS intends to deliver to the UEs. | | +| scefMessageDeliveryIPv4 | Ipv4AddrRo | 0..1 | Indicates the Ipv4 address where the SCEF wants to receive the data. | | +| scefMessageDeliveryIPv6 | Ipv6AddrRo | 0..1 | Indicates the Ipv6 address where the SCEF wants to receive the data. | | +| scefMessageDeliveryPort | PortRo | 0..1 | Indicates the port number where the SCEF wants to receive the data. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.8.3.1.1.4 Type: GMDByxMBNotification + +This type represents the group message delivery notification. + +**Table 5.8.3.1.1.4-1: Definition of type GMDByxMbNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-----------------------|-----------|-------------|------------------------------------------------------------------------------------------|----------------------| +| transaction | Link | 1 | Link to the transaction resource to which this notification is related. | | +| deliveryTriggerStatus | boolean | 1 | Indicates whether delivery of group message payload was successful (TRUE) or not (FALSE) | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.8.3.1.1.5 Type: GMDViaMBMSByxMBPatch + +This type represents group message delivery via MBMS request. The structure is used for PATCH request. + +**Table 5.8.3.1.1.5-1: Definition of the GMDViaMBMSByxMBPatch data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------|-------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| mbmsLocArea | MbmsLocArea | 0..1 | Represents the location area within which the group message delivery via MBMS is allowed. | | +| messageDeliveryStartTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As starts to distribute the data. If absent, it indicates the message shall be sent immediately. | | +| messageDeliveryStopTime | DateTime | 0..1 | Identifies the absolute time at which the SCS/As is expected to stop distributing the data. If absent, the configuration value will be used. | | +| groupMessagePayload | Bytes | 0..1 | Indicates the payload the SCS/AS intends to deliver to the UEs. | | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination where the notification requests shall be delivered | | + +NOTE: Properties marked with a feature as defined in clause 5.8.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.8.3.1.1.6 Type: MbmsLocArea + +This data type represents the user location area which is sent from the SCS/AS to the SCEF by group message delivery via MBMS request. + +**Table 5.8.3.1.1.6-1: Definition of the MbmsLocArea data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------|------------------------|-------------|----------------------------------------------------------------------------------------------------|----------------------| +| cellId | array(string) | 0..N | Indicates a Cell Global Identification of the user which identifies the cell the UE is registered. | | +| enodeBId | array(string) | 0..N | Indicates an eNodeB in which the UE is currently located. | | +| geographicArea | array(Geographic Area) | 0..N | Identifies a geographic area of the user where the UE is located. | | +| mbmsServiceAreaId | array(string) | 0..N | Identifies an MBMS Service Area Identity of the user where the UE is located. | | +| civicAddress | array(CivicAddresses) | 0..N | Identifies a civic address of the user where the UE is located. | | + +NOTE: Properties marked with a feature as defined in clause 5.8.2.3 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.8.3.1.2 Referenced simple data types and enumerations + +##### 5.8.3.1.2.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +##### 5.8.3.1.2.2 Simple data types + +The simple data types defined in table 5.8.3.1.2.2-1 shall be supported. + +**Table 5.8.3.1.2.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | +| | | + +#### 5.8.3.1.2.3 Enumeration: ServiceAnnouncementMode + +The enumeration ServiceAnnouncementMode represents the service announcement mode + +**Table 5.8.3.1.2.3-1: Enumeration ServiceAnnouncementMode** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| SACH | BM-SC performs the service announcement for the current service using the SACH channel. | | +| CONTENT_PROVIDER | BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information. | | +| NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +### 5.8.3.2 Resource structure + +#### 5.8.3.2.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-group-message-delivery-xmb/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-group-message-delivery-xmb" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.8.3.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | HTTP initiator | Meaning | +|--------------------------------|-----------------------------------------------------------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------| +| xMB Services | /{scsAsId}
/services | POST | SCS/AS | Create a service when xMB is used as a southbound interface. | +| | | GET | SCS/AS | Read all active service resources for a given SCS/AS. | +| Individual xMB Service | /{scsAsId}
/services/{serviceId} | GET | SCS/AS | Read an active service resource for a given SCS/AS and Service Id. | +| | | DELETE | SCS/AS | Delete an existing service resource for a given SCS/AS and Service Id. | +| GMD via MBMS by xMB | /{scsAsId}
/services/{serviceId}/delivery-via-mbms | GET | SCS/AS | Read all group message delivery resources for a given SCS/AS and Service Id. | +| | | POST | SCS/AS | Create a group message delivery resource for given SCS/AS and Service Id when xMB is used as a southbound interface. | +| Individual GMD via MBMS by xMB | /{scsAsId}
/services/{serviceId}/delivery-via-mbms/{transactionId} | PUT | SCS/AS | Replace a group message delivery resource | +| | | PATCH | SCS/AS | Modify a group message delivery resource. | +| | | GET | SCS/AS | Read a group message delivery resource. | +| | | DELETE | SCS/AS | Delete a group message delivery resource. | + +### 5.8.3.2.2 Resource: xMB Services + +#### 5.8.3.2.2.1 Introduction + +This resource allows the SCS/AS to create service resource when the xMB is used as a southbound interface. + +#### 5.8.3.2.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services + +This resource shall support the resource URI variables defined in table 5.8.3.2.2.2-1. + +**Table 5.8.3.2.2.2-1: Resource URI variables for resource "GMD via MBMS by xMB"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.8.3.2.2.3 Resource methods + +##### 5.8.3.2.2.3.1 GET + +The GET method allows the SCS/AS read all active service resources for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.2.3.1-1. + +**Table 5.8.3.2.2.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none. | | | | +| Response body | Data type | | Cardinality | Response codes | +| | Remarks | | | | +| | array(ServiceCreation) | 0..N | 200 OK | The service resource for the SCS/AS in the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.2.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.2.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.3.2.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.2.3.4 POST + +The POST method creates a new service resource for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.2.3.4-1. + +**Table 5.8.3.2.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ServiceCreation | 1 | Parameters to create and authorize a service with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ServiceCreation | 1 | 201
Created | The resource of a service was created successfully.
The SCEF shall return a data structure of type "ServiceCreation" in the response content.
On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the ServiceId. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId} | + +#### 5.8.3.2.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.8.3.2.3 Resource: Individual xMB Service + +#### 5.8.3.2.3.1 Introduction + +This resource allows the SCS/AS to delete a service resource. + +#### 5.8.3.2.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId} + +This resource shall support the resource URI variables defined in table 5.8.3.2.3.2-1. + +**Table 5.8.3.2.3.2-1: Resource URI variables for resource "Individual Service Creation"** + +| Name | Data type | Definition | +|-------------|------------------|----------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| serviceId | string | Identifier of the service. | + +#### 5.8.3.2.3.3 Resource methods + +##### 5.8.3.2.3.3.1 GET + +The GET method reads a active service resource for a given SCS/AS and a service Id. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.3.3.1-1. + +**Table 5.8.3.2.3.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ServiceCreation | 0..1 | 200 OK | The service resource for the SCS/AS and Service Id in the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.3.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.3.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.3.2.3.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.3.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.3.3.5 DELETE + +To delete a service resource, the SCS/AS shall use the HTTP DELETE method on the "ServiceCreation" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.3.2.3.3.5-1. + +**Table 5.8.3.2.3.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The group message delivery subscription was cancelled successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply + +**Table 5.8.3.2.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.3.2.4 Resource: GMD via MBMS by xMB + +##### 5.8.3.2.4.1 Introduction + +This resource allows the SCS/AS to: + +- read all of the group message delivery via MBMS by xMB resources for a given SCS/AS and a service identifier; or +- create a group message delivery when the xMB is used as a southbound interface. + +##### 5.8.3.2.4.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms + +This resource shall support the resource URI variables defined in table 5.8.3.2.4.2-1. + +**Table 5.8.3.2.4.2-1: Resource URI variables for resource "GMD via MBMS by xMB"** + +| Name | Data type | Definition | +|-----------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| ServiceId | string | Identifier of the service | + +## 5.8.3.2.4.3 Resource methods + +## 5.8.3.2.4.3.1 GET + +The GET method reads all of the group message delivery via MBMS by xMB resources for a given SCS/AS and a service identifier. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.4.3.1-1. + +**Table 5.8.3.2.4.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(GMDViaMBMSByxMB) | 0..N | 200 OK | The list of "GMDViaMBMSByxMB" data for the SCS/AS and the service identifier are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.4.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.4.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.8.3.2.4.3.2 PUT + +This HTTP method is not supported for the resource. + +## 5.8.3.2.4.3.3 PATCH + +This HTTP method is not supported for the resource. + +## 5.8.3.2.4.3.4 POST + +The POST method creates a new group message delivery via MBMS resource for a given SCS/AS and service Id selected by the SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.4.3.4-1. + +**Table 5.8.3.2.4.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByxMB | 1 | Parameters to create and authorize a group message delivery via MBMS with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByxMB | 1 | 201
Created |

The creation of a group message delivery was created successfully.

The SCEF shall return a data structure of type "GMDViaMBMSByxMB" in the response content.

On success, the HTTP response shall include a "Location" HTTP header that points to the created resource URI identified by the ScsAsId and the Transaction Id

| + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.4.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms/{transactionId} | + +#### 5.8.3.2.4.3.5 DELETE + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.5 Resource: Individual GMD via MBMS by xMB + +##### 5.8.3.2.5.1 Introduction + +This resource allows the SCS/AS to modify or delete a group message delivery via MBMS resource. + +##### 5.8.3.2.5.2 Resource definition + +Resource URI: {apiRoot}/3gpp-group-message-delivery-xmb/v1/{scsAsId}/services/{serviceId}/delivery-via-mbms/{transactionId} + +This resource shall support the resource URI variables defined in table 5.8.3.2.5.2-1. + +**Table 5.8.3.2.5.2-1: Resource URI variables for resource "Individual GMD via MBMS by xMB"** + +| Name | Data type | Definition | +|-----------|-----------|-----------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| serviceId | string | Identifier of the service selected by the SCEF. The transactionId corresponds to the stage 2 TLTRI. | + +##### 5.8.3.2.5.3 Resource methods + +###### 5.8.3.2.5.3.1 GET + +The GET method reads a group message delivery via MBMS resource for a given SCS/AS, a service Id and a transactionId. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.5.3.1-1. + +**Table 5.8.3.2.5.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByxMB | 0..1 | 200 OK | The group message delivery resource for the SCS/AS in the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.5.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.5.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.8.3.2.5.3.2 PUT + +Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.3.2.4.3.4, replace of its properties can be performed by the SCS/AS by using the HTTP PUT method on the "delivery-via-mbms" instance resource as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.8.3.1.1.3-1. + +The content body of the group message delivery via MBMS update request shall contain updated full representation of the group message delivery resource. Only the properties "locationinfo", "accuracy", "messageDelivervstarttime", "messageDelivervstoptime" and "groupMessagepayload" can be modified. + +The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in table 5.8.3.2.5.3.2-1. + +**Table 5.8.3.2.5.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByxMB | 1 | Parameters to replace group message delivery resource with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByxMB | 1 | 200 OK | The group message delivery was modified successfully.
The SCEF shall return an updated data structure of type "GMDViaMBMSByxMB" in the response content. | +| | none | | 204 No Content | The group message delivery was modified successfully, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.5.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.5.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.8.3.2.5.3.3 PATCH + +Assuming that a group message delivery has been created using the HTTP POST method described in clause 5.8.3.2.4.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "delivery-via-mbms" instance resource. + +This method shall support request and response data structures, and response codes, as specified in the table 5.8.3.2.5.3.3-1. + +**Table 5.8.3.2.5.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-----------------------|--------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | GMDViaMBMSByxMB Patch | 1 | Parameters to partially update a group message delivery with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | GMDViaMBMSByxMB | 1 | 200 OK | The group message delivery was modified successfully.
The SCEF shall return an updated data structure of type "GMDViaMBMSByxMB" in the response content. | +| | none | | 204 No Content | The group message delivery was modified successfully, and no content is to be sent in the response message body. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.5.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.5.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.3.2.5.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.8.3.2.5.3.5 DELETE + +To cancel a group message delivery, the SCS/AS shall use the HTTP DELETE method on the individual "delivery\_via\_mbms" resource which is indicated by the URI in the Location header of the HTTP POST response: + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.8.3.2.5.3.5-1. + +**Table 5.8.3.2.5.3.5-1: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The group message delivery subscription was cancelled successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2.5.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.8.3.2.5.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.8.3.2.6 Void + +#### 5.8.3.2A Notifications + +##### 5.8.3.2A.1 General + +The notifications provided by the GMDviaMBMSbyxMB API are specified in this clause. + +**Table 5.8.3.2A.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------|---------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------| +| GMD via MBMS by xMB Notification | {notificationDestination} | POST | Report a specific group message delivery result to the SCS/AS for a given Transaction Id selected by the SCEF. | + +### 5.8.3.2A.2 GMD via MBMS by xMB Notification + +#### 5.8.3.2A.2.1 Description + +The GMD via MBMS by xMB Notification allows the SCEF report the delivery trigger status to the SCS/AS to indicate whether group message delivery was triggered successful. + +#### 5.8.3.2A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.8.3.2A.2.2-1. + +**Table 5.8.3.2A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | A URI indicating the notification destination where T8 notification requests shall be delivered.
This URI shall be provided within the field "notificationDestination" in the GMDViaMBMSByxMB type. | + +#### 5.8.3.2A.2.3 Standard Methods + +##### 5.8.3.2A.2.3.1 Notification via POST + +To report the status of the delivery trigger status to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows: + +- the body of the message is encoded in JSON format with the data structure defined in table 5.8.3.1.1.4-1. + +This method shall support the request data structures specified in table 5.8.3.2A.2.3.1-1 and the response data structures and response codes specified in table 5.8.3.2A.2.3.1-2. + +**Table 5.8.3.2A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|-----------------------|-------------|-----------------------------------| +| GMDBByxMBNotification | 1 | The delivery status notification. | + +**Table 5.8.3.2A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Acknowledgement | 1 | 200 OK | The successful acknowledgement of the notification with a body. | +| (None) | | 204 No Content | The successful acknowledgement of the notification without a body. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.8.3.2A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.8.3.2A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.8.3.2a.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the GMDByxMBNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.8.3.3 Used Features + +The table below defines the features applicable to the GMDviaMBMSbyxMB API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.8.3.3-1: Features used by GMDviaMBMSbyxMB API** + +| Feature Number | Feature | Description | +|----------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +### 5.8.3.4 Error handling + +#### 5.8.3.4.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +#### 5.8.3.4.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the GMDviaMBMSbyxMB API. + +#### 5.8.3.4.3 Application Errors + +The application errors defined for GMDviaMBMSbyxMB API are listed in table 5.8.3.4.3-1. + +**Table 5.8.3.4.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.9 ReportingNetworkStatus API + +### 5.9.1 Overview + +The ReportingNetworkStatus API is a RESTful API that allows the SCS/AS to be one-time or continuous notified of the network status in a geographic area. The ReportingNetworkStatus API defines a set of data models, resources and the related procedures for the creation and management of the network status reporting request. The corresponding JSON schema for the representation of the resources and operations defined by the ReportingNetworkStatus API is provided in its complete form in Annex A.9. + +### 5.9.2 Data model + +#### 5.9.2.1 Resource data types + +##### 5.9.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.9.2.1.1-1 specifies data types re-used by the ReportingNetworkStatus API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the ReportingNetworkStatus API. + +**Table 5.9.2.1.1-1: ReportingNetworkStatus API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| GeographicArea | 3GPP TS 29.572 [42] | Identifies the geographical information of the user(s). | +| CivicAddress | 3GPP TS 29.572 [42] | Identifies the civic address information of the user(s). | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.9.4-1. | + +Table 5.9.2.1.1-2 specifies the data types defined for the ReportingNetworkStatus API. + +**Table 5.9.2.1.1-2: ReportingNetworkStatus API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------------|----------------|-------------------------------------------------------------------------------------------------|---------------| +| CongestionType | 5.9.2.3.3 | Represents abstracted values for congestion status. | | +| CongestionValue | 5.9.2.3.2 | Represents the congestion level value | | +| NetStatusRepSubsPatch | 5.9.2.1.3 | Represents the parameters to request the modification of network status reporting subscription. | PatchUpdate | +| NetworkStatusReportingNotification | 5.9.2.2.2 | Represents a network status reporting notification. | | +| NetworkStatusReportingSubscription | 5.9.2.1.2 | Represents a subscription to network status information reporting. | | + +##### 5.9.2.1.2 Type: NetworkStatusReportingSubscription + +This type represents the subscription of reporting the network status. The same structure is used in the subscription request and subscription response. + +**Table 5.9.2.1.2-1: Definition of type NetworkStatusReportingSubscription** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual Network Status Reporting subscription". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| notificationDestination | Link | 1 | A URI indicating the notification destination where T8 notification requests shall be delivered | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| locationArea | LocationArea | 1 | Identifies a location area. It can be either a list of cell IDs, or a list of Tracking Areas, or civic addresses, or a geographic area, or a combination of any of the above. | | +| timeDuration | DateTime | 0..1 | Identifies the time for which a continuous reporting is requested. Shall not be provided for one time reporting case. | | +| thresholdValues | array(CongestionValue) | 0..N | Identifies a list of congestion level(s) with exact value that the SCS/AS requests to be informed of when reached.
(NOTE 2) | | +| thresholdTypes | array(CongestionType) | 0..N | Identifies a list of congestion level(s) with abstracted value that the SCS/AS requests to be informed of when reached.
(NOTE 2) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.9.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: thresholdValues and thresholdTypes shall be mutually exclusive. + +### 5.9.2.1.3 Type: NetStatusRepSubsPatch + +This data type represents the parameters to request the modification of network status reporting subscription. + +**Table 5.9.2.1.3-1: Definition of type NetStatusRepSubsPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| notificationDestination | Link | 0..1 | A URI indicating the notification destination where T8 notification requests shall be delivered. | | +| locationArea | LocationArea | 0..1 | Identifies a location area. It can be either a list of cell IDs, or a list of Tracking Areas, or civic addresses, or a geographic area, or a combination of any of the above. | | +| timeDuration | DateTimeRm | 0..1 | Identifies the time for which a continuous reporting is requested. Shall not be provided for one time reporting case. | | +| thresholdValues | array(CongestionValue) | 0..N | Identifies a list of congestion level(s) with exact value that the SCS/AS requests to be informed of when reached.
(NOTE 2) | | +| thresholdTypes | array(CongestionType) | 0..N | Identifies a list of congestion level(s) with abstracted value that the SCS/AS requests to be informed of when reached.
(NOTE 2) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.9.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: The "thresholdValue" attribute and the "thresholdType" attribute shall be mutually exclusive. + +## 5.9.2.2 Notification data types + +### 5.9.2.2.1 Introduction + +This clause defines data structures to be used in notifications. + +### 5.9.2.2.2 Type: NetworkStatusReportingNotification + +This data type represents a network status reporting notification which is sent from the SCEF to the SCS/AS. + +**Table 5.9.2.2.2-1: Definition of type NetworkStatusReportingNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|----------------|-----------------|-------------|--------------------------------------------------------------------------------------------------------|------------------------| +| subscription | Link | 1 | Link to the subscription resource to which this notification is related. | | +| nsiValue | CongestionValue | 0..1 | Network Status Indicator based on exact value for congestion status received from RCAF(s).
(NOTE 2) | | +| nsiType | CongestionType | 0..1 | Network Status Indicator based on abstracted value for congestion status.
(NOTE 2) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.9.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: nsiValue and nsiType shall be mutually exclusive. + +### 5.9.2.3 Referenced simple data types and enumerations + +#### 5.9.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +#### 5.9.2.3.2 Simple data types + +The simple data types defined in table 5.9.2.3.2-1 shall be supported. + +**Table 5.9.2.3.2-1: Simple data types** + +| Type name | Description | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CongestionValue | Unsigned integer with valid values between 0 and 31. The value 0 indicates that there is no congestion. The value 1 is the lowest congestion level and value 31 is the highest congestion level. | + +#### 5.9.2.3.3 Enumeration: CongestionType + +The enumeration CongestionType represents abstracted values for congestion status. + +**Table 5.9.2.3.3-1: Enumeration CongestionType** + +| Enumeration value | Description | Applicability
(NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|-------------------------| +| HIGH | The congestion status is high. | | +| MEDIUM | The congestion status is medium. | | +| LOW | The congestion status is low. | | +| NOTE: Properties marked with a feature as defined in clause 5.9.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +### 5.9.3 Resource structure + +#### 5.9.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-net-stat-report/v1** + +"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.9.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|--------------------------------------------------|-------------------------------------------|-------------|-------------------------------------------------------------------------------| +| Network Status Reporting Subscriptions | /{scsAsId}/subscriptions | GET | Read all network status reporting subscription resources for a given SCS/AS. | +| | | POST | Create a new network status reporting subscription resource. | +| Individual Network Status Reporting subscription | /{scsAsId}/subscriptions/{subscriptionId} | GET | Read a network status reporting subscription resource. | +| | | PUT | Update an existing Individual Network Status Reporting Subscription resource. | +| | | PATCH | Modify an existing Individual Network Status Reporting Subscription resource. | +| | | DELETE | Delete an existing continuous network status reporting subscription resource. | + +### 5.9.3.2 Resource: Network Status Reporting Subscriptions + +#### 5.9.3.2.1 Introduction + +This resource allows the SCS/AS to read all active long-term subscriptions related to a network status reporting. + +#### 5.9.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-net-stat-report/v1/{scsAsId}/subscriptions + +This resource shall support the resource URI variables defined in table 5.9.3.2.2-1. + +**Table 5.9.3.2.2-1: Resource URI variables for resource "Network Status Reporting Subscriptions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.9.3.2.3 Resource methods + +##### 5.9.3.2.3.1 GET + +The GET method allows to read all active network status reporting subscriptions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.9.3.2.3.1-1 and table 5.9.3.2.3.1-2. + +**Table 5.9.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.9.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(NetworkStatusReportingSubscription) | 0..N | 200 OK | The information about the network status reporting subscriptions related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.9.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.9.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.9.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.9.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.9.3.2.3.4 POST + +The POST method creates a new network status reporting subscription resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.9.3.2.3.4-1 and table 5.9.3.2.3.4-2. + +**Table 5.9.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.9.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-------------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| | NetworkStatusReporting Subscription | 1 | Parameters to register a subscription to request notifications about network status information report with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NetworkStatusReporting Subscription | 1 | 201
Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| | ProblemDetails | 0..1 | 403
Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.9.5.3. + +**Table 5.9.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-net-stat-report/v1/{scsAsId}/subscriptions/{subscriptionId} | + +#### 5.9.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.9.3.3 Resource: Individual Network Status Reporting Subscription + +#### 5.9.3.3.1 Introduction + +This resource allows the SCS/AS to request for being notified about the network status using a long-term subscription. + +#### 5.9.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-net-stat-report/v1/{scsAsId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.9.3.3.2-1. + +**Table 5.9.3.3.2-1: Resource URI variables for resource "Individual Network Status Reporting Subscription"** + +| Name | Data type | Definition | +|----------------|------------------|-----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| subscriptionId | string | Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI. | + +#### 5.9.3.3.3 Resource methods + +##### 5.9.3.3.3.1 GET + +The GET method allows to read an active network status reporting subscription resource. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.9.3.3.3.1-1 and table 5.9.3.3.3.1-2. + +**Table 5.9.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.9.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------------------------------------------------------------------------------------|-------------------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NetworkStatusReporting Subscription | 1 | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.9.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.9.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.9.3.3.3.2 PUT + +The PUT method updates an existing subscription resource to update a subscription. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.9.3.3.3.2-1 and table 5.9.3.3.3.2-2. + +**Table 5.9.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.9.3.3.3.2-2: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NetworkStatusReporting Subscription | 1 | Parameters to update a subscription to request notifications about network status information report with the SCEF. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NetworkStatusReporting Subscription | 1 | 200 OK | The subscription was updated successfully. | +| | none | | 204 No Content | The subscription was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.9.3.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.9.3.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.9.3.3.3.3 PATCH + +The PATCH method modifies an existing subscription resource to modify a subscription. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures and response codes specified in the table 5.9.3.3.3.3-1 and table 5.9.3.3.3.3-2. + +**Table 5.9.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | Cardinality | Remarks | +|-------------|------------------|--------------------|----------------| +| n/a | | | | + +**Table 5.9.3.3.3.3-2: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|-------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NetStatusRepSubsPatch | 1 | Contains the parameters to modify an existing Individual Network Status Reporting Subscription resource. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NetworkStatusReporting Subscription | 1 | 200 OK | The modification of the Individual Network Status Reporting Subscription resource was successfull.

The SCEF shall return an updated representation of the resource within the NetworkStatusReportingSubscription data structure in the response message body. | +| | n/a | | 204 No Content | The modification of the Individual Network Status Reporting Subscription resource was successfull and no content is to be sent in the response message body. | +| | n/a | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | n/a | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | + +NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.9.3.3.3.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.9.3.3.3.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**5.9.3.3.3.4 POST** + +This HTTP method is not supported for the resource. + +**5.9.3.3.3.5 DELETE** + +The DELETE method deletes the resource and terminates the related network status reporting subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.9.3.3.3.5-1 and table 5.9.3.3.3.5-2. + +**Table 5.9.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|------------------|--------------------|----------------| +| none specified | | | | + +**Table 5.9.3.3.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The subscription was terminated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.9.3.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.9.3.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.9.3.4 Void + +## 5.9.3A Notifications + +### 5.9.3A.1 General + +The notifications provided by the ReportingNetworkStatus API are specified in this clause. + +**Table 5.9.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|---------------------------|---------------------------------|---------------------------------------------------------------------------------| +| Network Status Reporting Notification | {notificationDestination} | POST | Report a detected network status for a subscription from the SCEF to the SCS/AS | + +## 5.9.3A.2 Network Status Reporting Notification + +### 5.9.3A.2.1 Description + +The Network Status Reporting Notification allows the SCEF to send notifications about the detected network status to the SCS/AS. + +### 5.9.3A.2.2 Target URI + +The Callback URI "{notification\_uri}" shall be used with the callback URI variables defined in table 5.9.3A.2.2-1. + +**Table 5.9.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Callback reference provided by the SCS/AS during creation or modification of the network status reporting subscription. | + +### 5.9.3A.2.3 Standard Methods + +#### 5.9.3A.2.3.1 Notification via POST + +The HTTP POST method reports the detected network status for a network status subscription. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.9.3A.2.3.1-1 and the response data structures and response codes specified in table 5.9.3A.2.3.1-2. + +**Table 5.9.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|------------------------------------|-------------|-----------------------------------------------------------------| +| NetworkStatusReportingNotification | 1 | The network status reporting notification provided by the SCEF. | + +**Table 5.9.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | The network status reporting notification is received successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.9.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.9.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.9.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the NetworkStatusReportingNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.9.4 Used Features + +The table below defines the features applicable to the ReportingNetworkStatus API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.9.4-1: Features used by ReportingNetworkStatus API** + +| Feature Number | Feature | Description | +|----------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notifications connections is supported according to clause 5.2.5.3. | +| 3 | PatchUpdate | Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing subscription resource). | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +### 5.9.5 Error handling + +#### 5.9.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +#### 5.9.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the ReportingNetworkStatus API. + +#### 5.9.5.3 Application Errors + +The application errors defined for the ReportingNetworkStatus API are listed in table 5.9.5.3-1. + +**Table 5.9.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|------------------------------| +| QUOTA_EXCEEDED | 403 Forbidden | Not enough quota for SCS/AS. | + +## 5.10 CpProvisioning API + +### 5.10.1 Overview + +The CpProvisioning API is a RESTful API that allows the SCS/AS to add, change or delete the communication pattern parameter sets of the UE. The CpProvisioning API defines a set of data models, resources and the related procedures for the creation and management of the resources for communication pattern parameter provisioning. The corresponding JSON schema for the representation of the resources and operations defined by the CpProvisioning API is provided in its complete form in Annex A.10. + +### 5.10.2 Data model + +#### 5.10.2.1 Resource data types + +##### 5.10.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.10.2.1.1-1 specifies data types re-used by the CpProvisioning API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the CpProvisioning API. + +**Table 5.10.2.1.1-1: CpProvisioning API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|-----------------------------------------------------------------------------------------| +| Dnn | 3GPP TS 29.571 [45] | Identifies a DNN. | +| IpAddr | 3GPP TS 29.571 [45] | UE IP Address. | +| MacAddr48 | 3GPP TS 29.571 [45] | MAC Address. | +| NetworkAreaInfo | 3GPP TS 29.554 [50] | Identifies a network area information. | +| Snssai | 3GPP TS 29.571 [45] | Identifies the S-NSSAI. | +| TimeWindow | 5.2.1.2.3 | Identifies the time window from the start time to the end time. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.10.4-1. | + +Table 5.10.2.1.1-2 specifies the data types defined for the CpProvisioning API. + +**Table 5.10.2.1.1-2: CpProvisioning API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| AppExpUeBehaviour | 5.10.2.2.6 | Contains the Application Specific Expected UE Behaviour parameters. | AppExpUeBehaviour | +| BatteryIndication | 5.10.2.3.6 | Represents the type of power consumption. | | +| CommunicationIndicator | 5.10.2.3.3 | Represents the communication type used by the UE. | | +| CpFailureCode | 5.10.2.3.5 | Represents the failure reason of the CP parameter provisioning. | | +| CpInfo | 5.10.2.1.2 | Represents the resources for communication pattern parameter provisioning. | | +| CpParameterSet | 5.10.2.2.2 | Represents an offered communication pattern parameter set. | | +| CpReport | 5.10.2.2.4 | Represents a CP report indicating the CP set identifier(s) which CP parameter(s) are not added or modified successfully and the corresponding failure cause(s). | | +| ScheduledCommunicationTime | 5.10.2.2.3 | Represents an offered scheduled communication time. | | +| ScheduledCommunicationType | 5.10.2.3.8a | Represents the type of scheduled communication. | ScheduledCommType_5G | +| StationaryIndication | 5.10.2.3.4 | Indicates whether the UE is stationary or mobile. | | +| TrafficProfile | 5.10.2.3.7 | Represents the type of data transmission. | | +| UmtLocationArea5G | 5.10.2.2.5 | Represents the user location area describing the UE moving trajectory. | ExpectedUMT_5G,
ExpectedUmtTime_5G | + +#### 5.10.2.1.2 Type: CpInfo + +This type represents the resources for communication pattern parameter provisioning. The same structure is used in the subscription request and subscription response. + +**Table 5.10.2.1.2-1: Definition of type CplInfo** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 2) | +|-------------------|---------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| self | Link | 0..1 | Link to the resource "Individual CP Provisioning Subscription".
This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| mtcProviderId | string | 0..1 | Identifies the MTC Service Provider and/or MTC Application. (NOTE 3) | | +| dnn | Dnn | 0..1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | UEId_retrieval | +| externalId | ExternalId | 0..1 | Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

The attribute may also be present in the CP provisioning subscription response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "uelpAddr" attribute or the "ueMacAddr" attribute.
(NOTE 1) | | +| msisdn | Msisdn | 0..1 | Each element identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 1) | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 1) | | +| cpParameterSets | map(CpParameterSet) | 1..N | Identifies a set of CP parameter information that may be part of this CpInfo structure.
Any string value can be used as a key of the map. | | +| cpReports | map(CpReport) | 0..N | Supplied by the SCEF and contains the CP set identifiers for which CP parameter(s) are not added or modified successfully. The failure reason is also included.
Each element provides the related information for one or more CP set identifier(s) and is identified in the map via the failure identifier as key.
(NOTE 4). | | +| snssai | Snssai | 0..1 | Indicate the S-NSSAI. | UEId_retrieval | +| uelpAddr | lpAddr | 0..1 | UE IP address. | UEId_retrieval | +| ueMacAddr | MacAddr48 | 0..1 | UE MAC address. | UEId_retrieval | + +NOTE 1: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included. + +NOTE 2: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +NOTE 3: The SCEF should check received MTC provider identifier and then the SCEF may: +- override it with local configured value and send it to HSS; + +- send it directly to the HSS; or +- reject the communication pattern parameter provisioning request. + +NOTE 4: The failure identifier is a string encoded map key. + +## 5.10.2.2 Referenced structured data types + +### 5.10.2.2.1 Introduction + +This clause defines structured data types that are referenced from data structures defined in the previous clauses. + +### 5.10.2.2.2 Type: CpParameterSet + +This data type represents an offered communication pattern parameter set sent from the SCC/AS to the SCEF. + +**Table 5.10.2.2.2-1: Definition of type CpParameterSet** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|--------------------------------|----------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| setId | string | 1 | SCS/AS-chosen correlator provided by the SCS/AS in the request to create a resource for CP parameter set(s).
(NOTE 4) | | +| self | Link | 0..1 | Link to the resource "Individual CP set Provisioning". This parameter shall be supplied by the SCEF in HTTP responses. | | +| validityTime | DateTime | 0..1 | Identifies when the CP parameter set expires and shall be deleted. If absent, it indicates that there is no expiration time for this CP parameter set. | | +| periodicCommunicationIndicator | Communication Indicator | 0..1 | Identifies whether UE communicates periodically or on demand. | | +| communicationDurationTime | DurationSec | 0..1 | Identifies duration time of periodic communication. | | +| periodicTime | DurationSec | 0..1 | Identifies interval time of periodic communication. | | +| scheduledCommunicationTime | ScheduledCommunicationTime | 0..1 | Identifies time zone and day of the week when the UE is available for communication. | | +| scheduledCommunicationType | ScheduledCommunicationType | 0..1 | Indicates the Scheduled Communication Type.
May only be present if the "scheduledCommunicationTime" attribute is provided. | ScheduledCommType_5G | +| stationaryIndication | StationaryIndication | 0..1 | Identifies whether the UE is stationary or mobile. | | +| batteryInds | array(BatteryIndication) | 0..N | Indicates the power consumption type(s) of the UE.
(NOTE 3) | | +| trafficProfile | TrafficProfile | 0..1 | Identifies the type of data transmission. | | +| expectedUmts | array(UmtLocationArea5G) | 0..N | Identifies the UE's expected geographical movement. The attribute is only applicable in 5G.
(NOTE 2) | ExpectedUMT_5G
ExpectedUmtTime_5G | +| expectedUmtDays | DayOfWeek | 0..6 | Identifies the day of the week. If absent, it indicates every day of the week. | ExpectedUmtTime_5G | +| expectedUmtDaysAdd | array(DayOfWeek) | 0..5 | Identifies the additional day(s) of the week.
(NOTE 5) | ExpectedUmtTime_Add | +| appExpUeBehvs | array(AppExpUeBehaviour) | 0..N | Contains the Application Specific Expected UE Behaviour parameters. | AppExpUeBehaviour | +| confidenceLevel | string | 0..1 | When present, this IE indicates the Confidence level for the associated Expected UE Behaviour parameter.

The value shall be between 0.01 and 1.00 with a step size of 0.01, represented as string.

If not present, confidence level 1.00 applies.

Pattern: '^[0]\.[0-9]{2}[1.00]\$' | ConfAccuLevels | +| accuracyLevel | string | 0..1 | When present, this IE indicates the accuracy level for the associated Expected UE Behaviour parameter.

The value shall be between 0.01 and 1.00 with a step size of 0.01, represented as string.

If not present, accuracy level 1.00 applies.

Pattern: '^[0]\.[0-9]{2}[1.00]\$' | ConfAccuLevels | + +| | | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | +| NOTE 2: | The first instance of the attribute represents the start of the location, and the last one represents the stop of the location. | +| NOTE 3: | If "BATTERY_RECHARGE" is provided, "BATTERY_NO_RECHARGE" shall not be provided simultaneously, vice versa; If "BATTERY_REPLACE" is provided, "BATTERY_NO_REPLACE" shall not be provided simultaneously, vice versa; If "NO_BATTERY" is provided, any value indicating UE powered with battery shall not be provided simultaneously, vice versa. | +| NOTE 4: | A setId can only belong to one "Individual CP Provisioning Subscription" resource. | +| NOTE 5: | The "expectedUmtDaysAdd" attribute may only be provided to indicate the additional day(s) if the "expectedUmtDays" attribute is also provided. | + +#### 5.10.2.2.3 Type: ScheduledCommunicationTime + +This data type represents an offered scheduled communication time. + +**Table 5.10.2.2.3-1: Definition of type ScheduledCommunicationTime** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------|-----------------------------------------------------------------------------------|----------------------| +| daysOfWeek | array(DayOfWeek) | 0..6 | Identifies the day(s) of the week. If absent, it indicates every day of the week. | | +| timeOfDayStart | TimeOfDay | 0..1 | Identifies the start time of the day. | | +| timeOfDayEnd | TimeOfDay | 0..1 | Identifies the end time of the day. | | +| NOTE: Properties marked with a feature as defined in subclause 5.10.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +#### 5.10.2.2.4 Type: CpReport + +This type represents a CP report to indicate the CP set identifier(s) which CP parameter(s) are not added or modified successfully and corresponding failure reason. + +**Table 5.10.2.2.4-1: Definition of type CpReport** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------|--------------------------------------------------------------------------------------------------|----------------------| +| setIds | array(string) | 0..N | Identifies the CP set identifier(s) which CP parameter(s) are not added or modified successfully | | +| failureCode | CpFailureCode | 1 | Identifies the failure reason | | +| NOTE: Properties marked with a feature as defined in subclause 5.10.4 are applicable as described in subclause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +#### 5.10.2.2.5 Type: UmtLocationArea5G + +This data type represents the user location area describing the UE moving trajectory which is sent from the AF. + +**Table 5.10.2.2.5-1: Definition of the UmtLocationArea5G data Type** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------|--------------------------------------------------------------------------|---------------------------| +| umtTime | TimeOfDay | 0..1 | This IE identifies the time of the day when the UE arrives the location. | ExpectedUmtTime_5G | +| umtDuration | DurationSec | 0..1 | This IE identifies the time duration the UE stays in the location. | ExpectedUmtTime_5G | +| NOTE 1: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | +| NOTE 2: This data type also contains all the properties defined for LocationArea5G data type, these properties are applicable for ExpectedUMT_5G. | | | | | + +## 5.10.2.2.6 Type: AppExpUeBehaviour + +**Table 5.10.2.2.6-1: Definition of type AppExpUeBehaviour** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | string | C | 0..1 | Indicates the Application Identifier.
(NOTE 1) | | +| expPduSesInacTm | TimeWindow | O | 0..1 | Identifies the expected PDU Session Inactivity time during which the UE will not have traffic related to the application. | | +| flowDescriptions | array(string) | C | 0..N | Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [46].
(NOTE 1) | | +| confidenceLevel | string | O | 0..1 | When present, this IE indicates the Confidence level for the associated Application-Specific Expected UE Behaviour parameter.

The value shall be between 0.01 and 1.00 with a step size of 0.01, represented as string.

If not present, confidence level 1.00 applies.

Pattern: '^[0]{1}[0-9]{2}[1.00]' | | +| accuracyLevel | string | O | 0..1 | When present, this IE indicates the accuracy level for the associated Application-Specific Expected UE Behaviour parameter.

The value shall be between 0.01 and 1.00 with a step size of 0.01, represented as string.

If not present, accuracy level 1.00 applies.

Pattern: '^[0]{1}[0-9]{2}[1.00]' | | +| failureCode | CpFailureCode | O | 0..1 | Identifies the failure reason for the Application-Specific Expected UE Behaviour parameter is not added or modified successfully.

If absent, the value of the "failureCode" attribute in the higher-level "CpInfo" data type shall be used.
(NOTE 3) | | +| validityTime | DateTime | O | 0..1 | Identifies when the Application-Specific Expected UE Behaviour parameter expires.

If absent, the value of the "validityTime" attribute in the higher-level "CpParameterSet" data type shall be used.
(NOTE 2) | | + +NOTE 1: One of the "appId" attribute or "flowDescriptions" attribute shall be included. +NOTE 2: The attribute if provided, take precedence over the "validityTime" attribute in the higher-level "CpParameterSet" data type. + +NOTE 3: The attribute if provided, take precedence over the "failureCode" attribute in the higher-level "CplInfo" data type. + +### 5.10.2.3 Referenced simple data types and enumerations + +#### 5.10.2.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +#### 5.10.2.3.2 Simple data types + +The simple data types defined in table 5.10.2.3.2-1 shall be supported. + +**Table 5.10.2.3.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | +| | | + +#### 5.10.2.3.3 Enumeration: CommunicationIndicator + +**Table 5.10.2.3.3-1: Enumeration CommunicationIndicator** + +| Enumeration value | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|----------------------| +| PERIODICALLY | Identifies the UE communicates periodically | | +| ON_DEMAND | Identifies the UE communicates on demand | | +| NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.10.2.3.4 Enumeration: StationaryIndication + +**Table 5.10.2.3.4-1: Enumeration StationaryIndication** + +| Enumeration value | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|----------------------| +| STATIONARY | Identifies the UE is stationary | | +| MOBILE | Identifies the UE is mobile | | +| NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.10.2.3.5 Enumeration: CpFailureCode + +The enumeration FailureCode represents the failure reason of the CP parameter provisioning. + +**Table 5.10.2.3.5-1: Enumeration CpFailureCode** + +| Enumeration value | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| MALFUNCTION | This value indicates that something functions wrongly in CP parameter provisioning or the CP parameter provisioning does not function at all. | | +| SET_ID_DUPLICATED | The received CP set identifier(s) are already provisioned. | | +| OTHER_REASON | Other reason unspecified. | | +| CONFIDENCE_LEVEL_NOT_SUFFICIENT | This value indicate that the confidence level provided is not sufficient | ConfAccuLevels | +| ACCURACY_LEVEL_NOT_SUFFICIENT | This value indicate that the accuracy level provided is not sufficient | ConfAccuLevels | +| NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.10.2.3.6 Enumeration: BatteryIndication + +The enumeration BatteryIndication represents the type of power consumption. + +**Table 5.10.2.3.6-1: Enumeration BatteryIndication** + +| Enumeration value | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|----------------------| +| BATTERY_RECHARGE | UE powered with rechargeable battery. | | +| BATTERY_REPLACE | UE powered with replaceable battery. | | +| BATTERY_NO_RECHARGE | UE powered with no rechargeable battery. | | +| BATTERY_NO_REPLACE | UE powered with no replaceable battery. | | +| NO_BATTERY | UE not battery powered. | | +| NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.10.2.3.7 Enumeration: TrafficProfile + +The enumeration TrafficProfile represents the type of data transmission. + +**Table 5.10.2.3.7-1: Enumeration TrafficProfile** + +| Enumeration value | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|----------------------| +| SINGLE_TRANS_UL | Uplink single packet transmission. | | +| SINGLE_TRANS_DL | Downlink single packet transmission. | | +| DUAL_TRANS_UL_FIRST | Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission. | | +| DUAL_TRANS_DL_FIRST | Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission. | | +| MULTI_TRANS | Multiple packet transmission. | | +| NOTE: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | + +#### 5.10.2.3.8A Enumeration: ScheduledCommunicationType + +The enumeration ScheduledCommunicationType represents the type of scheduled communication. + +**Table 5.10.2.3.8A-1: Enumeration ScheduledCommunicationType** + +| Enumeration value | Description | +|-------------------|----------------| +| DOWNLINK | Downlink only | +| UPLINK | Uplink only | +| BIDIRECTIONAL | Bi-directional | + +## 5.10.3 Resource structure + +### 5.10.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-cp-parameter-provisioning/v1** + +"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.10.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|-----------------------------------------|----------------------------------------------------------------------------------|-------------|--------------------------------------------------------------------------------------| +| CP provisioning Subscriptions | /{scsAsId}/subscriptions | GET | Read all active CP parameter provisioning subscription resources for a given SCS/AS. | +| | | POST | Create a new subscription resource of provisioning CP parameter set(s). | +| Individual CP Provisioning Subscription | /{scsAsId}/subscriptions/{subscriptionId} | GET | Read a CP parameter provisioning subscription resource. | +| | | PUT | Modify a CP parameter provisioning subscription resource. | +| | | DELETE | Delete a CP parameter provisioning subscription resource. | +| Individual CP set Provisioning | /{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId}

(NOTE 1, NOTE 2) | PUT | Update CP at individual CP set(s) level associated with a CP parameter set Id. | +| | | GET | Read CP at individual CP set(s) level associated with a CP parameter set Id. | +| | | DELETE | Delete CP at individual CP set(s) level associated with a CP parameter set Id. | + +NOTE 1: This setId as a resource identifier is not necessarily identical as the CP parameter set Id received from the SCS/AS. +NOTE 2: The path segment "cpSets" does not follow the related naming convention defined in clause 5.2.4. The path segment is however kept as currently defined in this specification for backward compatibility considerations. + +### 5.10.3.2 Resource: CP Provisioning Subscriptions + +#### 5.10.3.2.1 Introduction + +This resource allows the SCS/AS to read all active long-term transactions related to CP parameter provisioning resource management. + +#### 5.10.3.2.2 Resource definition + +Resource URI: **{apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions** + +This resource shall support the resource URI variables defined in table 5.10.3.2.2-1. + +**Table 5.10.3.2.2-1: Resource URI variables for resource "CP Provisioning Subscriptions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.10.3.2.3 Resource methods + +#### 5.10.3.2.3.1 GET + +The GET method allows to read all active subscriptions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.2.3.1-1 and table 5.10.3.2.3.1-2. + +**Table 5.10.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.10.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(CplInfo) | 0..N | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.10.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.10.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.10.3.2.3.4 POST + +The POST method allows to create subscription for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.2.3.4-1. + +**Table 5.10.3.2.3.4-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CpInfo | 1 | Change information in CP parameter set. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | CpInfo | 1 | 201 Created | The subscription was created successfully.
The SCEF shall return the created subscription in the response content. CpReport may be included to provide detailed failure information for some CP sets. | +| | array(CpReport) | 1..N | 500 Internal Server Error | The CP parameters for all CP sets were not created successfully. CpReport is included with detailed information. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure causes are described in clause 5.10.5. + +**Table 5.10.3.2.3.4-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId} | + +#### 5.10.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.10.3.3 Resource: Individual CP Provisioning Subscription + +#### 5.10.3.3.1 Introduction + +This resource allows the SCS/AS to manage resources for CP parameter provisioning using a subscription Id. + +#### 5.10.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.10.3.3.2-1. + +**Table 5.10.3.3.2-1: Resource URI variables for resource "Individual CP Provisioning Subscription"** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| subscriptionId | string | Identifier of the subscription resource. The subscriptionId corresponds to the stage 2 TLTRI. | + +### 5.10.3.3.3 Resource methods + +#### 5.10.3.3.3.1 GET + +The GET method allows to read the subscription for a given SCS/AS and subscription Id. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.3.3.1-1 and table 5.10.3.3.3.1-2. + +**Table 5.10.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.10.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | Response codes | | +| Response body | CplInfo | 1 | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.3.3.3.2 PUT + +The PUT method allows to change (add/update/remove) one or more CP parameter set(s) resource(s). The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.14.3.3.3.2-1. + +**Table 5.10.3.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CpInfo | 1 | Change information in CP parameter set(s). | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | CpInfo | 1 | 200 OK | The subscription was modified successfully.
The SCEF shall return an updated subscription in the response content. CpReport may be included to provide detailed failure information for some CP sets. | +| | none | | 204 No Content | The subscription was modified successfully and no content is to be sent in the response message body. | +| | array(CpReport) | 1..N | 500 Internal Server Error | The CP parameters for all CP sets were not created successfully. CpReport is included with detailed information. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.3.3.3.3 PATCH + +This HTTP method is not supported for the resource. + +## 5.10.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +### 5.10.3.3.3.5 DELETE + +The DELETE method allows to remove an active subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.3.3.5-1. + +**Table 5.10.3.3.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The subscription was deleted successfully. The content shall be empty. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.3.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.3.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.3.4 Resource: Individual CP Set Provisioning + +### 5.10.3.4.1 Introduction + +This resource allows the SCS/AS to manage resources for CP parameter set provisioning associated with a CP parameter set Id. + +### 5.10.3.4.2 Resource definition + +Resource URI: {apiRoot}/3gpp-cp-parameter-provisioning/v1/{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId} + +This resource shall support the resource URI variables defined in table 5.10.3.3.2-1. + +**Table 5.10.3.3.2-1: Resource URI variables for resource "Individual CP Set Provisioning"** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| subscriptionId | string | Identifier of the subscription resource. | +| setId | string | Identifier of the CP parameter set | + +### 5.10.3.4.3 Resource methods + +#### 5.10.3.4.3.1 GET + +The GET method allows to read a CP parameter set resource. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.10.3.4.3.1-1 and table 5.10.3.4.3.1-2. + +**Table 5.10.3.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.10.3.4.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | CpParameterSet | 1 | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.3.4.3.2 PUT + +The PUT method allows to update a CP parameter set resource. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.4.3.2-1. + +**Table 5.10.3.4.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------|-------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | CpParameterSet | 1 | Change information in CP parameter set. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | CpParameterSet | 1 | 200 OK | The CP parameter set resource was modified successfully.
The SCEF shall return an updated CP parameter set resource in the response content. | +| | none | | 204 No Content | The CP parameter set resource was modified successfully and no content is to be sent in the response message body. | +| | CpReport | 1 | 409 Conflict | The CP parameters for the CP set were not updated successfully, applicable for error SET_ID_DUPLICATED in table 5.10.2.3.5-1. | +| | CpReport | 1 | 500 Internal Server Error | The CP parameters for the CP set were not updated successfully, applicable for other errors in table 5.10.2.3.5-1. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.4.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.4.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.3.4.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.10.3.4.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.10.3.4.3.5 DELETE + +The DELETE method allows to remove an active subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support request and response data structures, and response codes, as specified in the table 5.10.3.4.3.5-1. + +**Table 5.10.3.4.3.5-1.: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The subscription was deleted successfully. The content shall be empty. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.10.3.4.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.10.3.4.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.10.4 Used Features + +The table below defines the features applicable to the CpProvisioning API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.10.4-1: Features used by CpProvisioning API** + +| Feature Number | Feature | Description | +|----------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ExpectedUMT_5G | The UE's expected geographical movement is supported. This feature may only be supported in 5G. | +| 2 | ExpectedUmtTime_5G | The UE's expected geographical movement with recurrence time is supported. This feature requires the ExpectedUMT_5G feature support and may only be supported in 5G. | +| 3 | ScheduledCommType_5G | Support of scheduled communication type. This feature may only be supported in 5G. | +| 4 | UEId_retrieval | This feature supports AF specific UE ID retrieval. The feature is not applicable to pre-5G (e.g. 4G). | +| 5 | ExpectedUmtTime_Add | This feature supports expected UMT days indication. This feature requires the ExpectedUmtTime_5G feature support. | +| 6 | AppExpUeBehaviour | This feature indicates the support of Application-Specific Expected UE Behaviour parameters. The feature is not applicable to pre-5G (e.g. 4G). | +| 7 | ConfAccuLevels | This feature indicates the support of confidence and accuracy levels for the parameters provisioned. The feature is not applicable to pre-5G (e.g. 4G). | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +## 5.10.5 Error handling + +### 5.10.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.10.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CpProvisioning API. + +### 5.10.5.3 Application Errors + +The application errors defined for CpProvisioning API are listed in table 5.10.5.3-1. + +**Table 5.10.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------------------|------------------|-----------------------------------------------------------------------------------------------|----------------| +| REQUEST_NOT_AUTHORIZED | 403 Forbidden | Indicates that the the AF specific UE ID retrieval request is not authorized. | UEId_retrieval | +| UE_ID_NOT_AVAILABLE | 404 Not Found | Indicates that the AF specific UE ID is not available. | UEId_retrieval | +| UE_NOT_FOUND | 404 Not Found | Indicates that the requested UE address is not found. | UEId_retrieval | +| CONFIDENCE_LEVEL_OUT_OF_RANGE | 403 Forbidden | Confidence Level of the Expected UE Behaviour Parameter is out or range (e.g. <0.00 or >1.00) | ConfAccuLevels | +| ACCURACY_LEVEL_OUT_OF_RANGE | 403 Forbidden | Confidence Level of the Expected UE Behaviour Parameter is out or range (e.g. <0.00 or >1.00) | ConfAccuLevels | + +## 5.11 PfdManagement API + +### 5.11.1 Overview + +The PfdManagement API allows the SCS/AS to manage the PFDs via the SCEF. The PfdManagement API defines a set of data models, resources and the related procedures for the creation and management of the PFD management request. The corresponding JSON schema for the representation of the resources and operations defined by the PfdManagement API is provided in its complete form in Annex A.11. + +### 5.11.2 Data model + +#### 5.11.2.1 Resource data types + +##### 5.11.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.11.2.1.1-1 specifies data types re-used by the PfdManagement API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the PfdManagement API. + +**Table 5.11.2.1.1-1: PfdManagement API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|-----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.11.4-1. | +| Dnai | 3GPP TS 29.571 [45] | DNAI | + +Table 5.11.2.1.1-2 specifies the data types defined for the PfdManagement API. + +**Table 5.11.2.1.1-2: PfdManagement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| DomainNameProtocol | 5.11.2.2.4 | Indicates the additional protocol and protocol field for domain names to be matched. | DomainNameProtocol | +| FailureCode | 5.11.2.2.3 | Represents the failure reason of the PFD management. | | +| Pfd | 5.11.2.1.4 | Represents a PFD for an external Application Identifier. | | +| PfdData | 5.11.2.1.3 | Represents a PFD request to add, update or remove PFD(s) for one external application identifier. | | +| PfdManagement | 5.11.2.1.2 | Represents a PFD management resource for a PFD management request. | | +| PfdManagementPatch | 5.11.2.1.7 | Represents the parameters to request the modification of a PFD management transaction resource. | PatchUpdate | +| PfdReport | 5.11.2.1.5 | Represents a PFD report indicating the external application identifier(s) which PFD(s) are not added or modified successfully and the corresponding failure cause(s). | | +| UserPlaneLocationArea | 5.11.2.1.6 | Represents location area(s) of the user plane functions which are unable to enforce the provisioned PFD(s) successfully. | | + +##### 5.11.2.1.2 Type: PfdManagement + +This type represents a PFD management resource for a PFD management request. + +**Table 5.11.2.1.2-1: Definition of type PfdManagement** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|-------------------------|----------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| self | Link | 0..1 | Link to the resource "Individual PFD Management Transaction".
This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| pfdDatas | map(PfdData) | 1..N | Each element uniquely identifies the PFDs for an external application identifier. Each element is identified in the map via an external application identifier as key. The response shall include successfully provisioned PFD data of application(s). | | +| pfdReports | map(PfdReport) | 0..N | Supplied by the SCEF and contains the external application identifiers for which PFD(s) are not added or modified successfully. The failure reason is also included. Each element provides the related information for one or more external application identifier(s) and is identified in the map via the failure identifier as key. (NOTE 2) | | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination for T8 notifications. | PfdMgmtNotification | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsocketNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | + +NOTE 1: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: The failure identifier is a string encoded map key. + +### 5.11.2.1.3 Type: PfdData + +This type represents a PFD request to add, update or remove PFD(s) for one external application identifier provided by the SCS/AS to the SCEF via T8 interface. + +**Table 5.11.2.1.3-1: Definition of type PfdData** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|----------------|---------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| externalAppId | string | 1 | Each element uniquely external application identifier
(NOTE 2) | | +| self | Link | 0..1 | Link to the resource "Individual Application PFD Management". This parameter shall be supplied by the SCEF in HTTP responses. | | +| pfds | map(Pfd) | 1..N | Contains the PFDs of the external application identifier. Each PFD is identified in the map via a key containing the PFD identifier.
(NOTE 3) | | +| allowedDelay | DurationSecRm | 0..1 | Indicates that the list of PFDs in this request should be deployed within the time interval indicated by the Allowed Delay | | +| cachingTime | DurationSecRo | 0..1 | SCEF supplied property, inclusion of this property means the allowed delayed cannot be satisfied, i.e. it is smaller than the caching time, but the PFD data is still stored. | | + +NOTE 1: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: An externalAppId can only belong to one "individual PFD Management Transaction" resource. +NOTE 3: When multiple PFDs are associated with application identifier, the application is detected when any of the PFDs associated with the application identifier is matched. + +#### 5.11.2.1.4 Type: Pfd + +This data type represents a PFD for an external Application Identifier. + +**Table 5.11.2.1.4-1: Definition of type Pfd** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|------------------|--------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| pfdId | string | 1 | Identifies a PFD of an application identifier. | | +| flowDescriptions | array(string) | 0..N | Represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [46].
(NOTE 2) | | +| urls | array(string) | 0..N | Indicates a URL or a regular expression which is used to match the significant parts of the URL.
(NOTE 2) | | +| domainNames | array(string) | 0..N | Indicates an FQDN or a regular expression as a domain name matching criteria.
(NOTE 2) | | +| dnProtocol | DomainNameProtocol | 0..1 | Indicates the additional protocol and protocol field for domain names to be matched, it may only be provided when domainNames attribute is present. | DomainNameProtocol | + +NOTE 1: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +NOTE 2: At least one of the properties "flowDescriptions", "urls" or "domainNames" shall be included. If a PFD contains multiple filter types, the PFD is only matched when every filter type contained in the PFD has a matching value. + +#### 5.11.2.1.5 Type: PfdReport + +This type represents a PFD report to indicate the external application identifier(s) which PFD(s) are not added or modified successfully and corresponding failure reason. + +**Table 5.11.2.1.5-1: Definition of type PfdReport** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------|-----------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| externalAppIds | array(string) | 1..N | Identifies the external application identifier(s) which PFD(s) are not added or modified successfully | | +| failureCode | FailureCode | 1 | Identifies the failure reason | | +| cachingTime | DurationSec | 0..1 | It shall be included when the allowed delayed cannot be satisfied, i.e. it is smaller than the caching time configured in fetching PFD. | | +| locationArea | UserPlaneLocationArea | 0..1 | Identifies a location area of the user plane(s) which are unable to enforce the PFD(s). | | + +NOTE: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +#### 5.11.2.1.6 Type: UserPlaneLocationArea + +This data type represents location area(s) of the user plane which is unable to enforce the provisioned PFD(s) successfully. It is sent from the SCEF to the SCS/AS. + +**Table 5.11.2.1.6-1: Definition of the UserPlaneLocationArea data Type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------|----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| locationArea | LocationArea | 0..1 | Identifies the network area information served by the user planes functions which are unable to enforce the provisioned PFD(s) successfully. It can be either a list of cell IDs, or a list of Tracking Areas, or civic addresses, or a geographic area, or a combination of any of the above. | | +| locationArea5G | LocationArea5G | 0..1 | Identifies the network area information served by the user planes functions which are unable to enforce the provisioned PFD(s) successfully. It can be either a list of E-UTRA cell IDs, or a list of NR cell ID, or a list of Tracking Areas, or civic addresses, or a geographic area, or a combination of any of the above. | FailureLocation_5G | +| dnais | array(DNAI) | 0..N | Identifies a list of DNAI supported by the user plane functions which are unable to enforce the provisioned PFD(s) successfully. | FailureLocation_5G | + +#### 5.11.2.1.7 Type: PfdManagementPatch + +This type represents the parameters to request the modification of a PFD management transaction resource. + +**Table 5.11.2.1.7-1: Definition of type PfdManagementPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|--------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| pfdDatas | map(PfdData) | 1..N | Each element uniquely identifies the PFDs for an external application identifier. Each element is identified in the map via an external application identifier as the key. | | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination for T8 notifications. | | + +NOTE 1: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. + +### 5.11.2.2 Referenced simple data types and enumerations + +#### 5.11.2.2.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +#### 5.11.2.2.2 Simple data types + +The simple data types defined in table 5.11.2.2.2-1 shall be supported. + +**Table 5.11.2.2.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | +| | | + +### 5.11.2.2.3 Enumeration: FailureCode + +The enumeration FailureCode represents the failure reason of the PFD management. + +**Table 5.11.2.2.3-1: Enumeration FailureCode** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------| +| MALFUNCTION | This value indicates that something functions wrongly in PFD provisioning or the PFD provisioning does not function at all. | | +| RESOURCE_LIMITATION | This value indicates there is resource limitation for PFD storage. | | +| SHORT_DELAY | This value indicates that the allowed delay is too short and PFD(s) are not stored. | | +| APP_ID_DUPLICATED | The received external application identifier(s) are already provisioned. | | +| PARTIAL_FAILURE | The PFD(s) are not provisioned to all PCEFs/TDFs/SMFs. | PfdMgmtNotification | +| OTHER_REASON | Other reason unspecified. | | +| NOTE: Properties marked with a feature as defined in clause 5.11.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | + +### 5.11.2.2.4 Enumeration: DomainNameProtocol + +**Table 5.14.2.2.4-1: Enumeration DomainNameProtocol** + +| Enumeration value | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------------------| +| DNS_QNAME | Identifies the DNS protocol and the question name in DNS query. | | +| TLS_SNI | Identifies the Server Name Indication in TLS ClientHello message. | | +| TLS_SAN | Identifies the Subject Alternative Name in TLS ServerCertificate message. | | +| TSL_SCN | Identifies the Subject Common Name in TLS ServerCertificate message. (NOTE 2) | | +| NOTE 1: Properties marked with a feature as defined in clause 5.10.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | +| NOTE 2: The enumeration value "TSL_SCN" refers to "TLS_SCN" value in domain name protocol. This enumeration value is however kept as currently defined in this specification for backward compatibility considerations. | | | + +## 5.11.3 Resource structure + +### 5.11.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-pfd-management/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-pfd-management" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.11.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|---------------------------------------|---------------------------------------------------------------------|-------------|--------------------------------------------------------------------------------------------------------| +| PFD Management Transactions | /{scsAsId}/transactions | GET | Read all or queried PFDs for a given SCS/AS | +| | | POST | Create PFDs for a given SCS/AS and one or more external Application Identifier(s) | +| Individual PFD Management Transaction | /{scsAsId}/transactions/{transactionId} | GET | Read all PFDs for a given SCS/AS and a transaction for one or more external Application Identifier(s) | +| | | PUT | Update PFD(s) for a given SCS/AS and a transaction for one or more external Application Identifier(s) | +| | | PATCH | Modify PFD(s) for a given SCS/AS and a transaction for one or more external Application Identifier(s). | +| | | DELETE | Delete PFDs for a given SCS/AS and a transaction for one or more external Application Identifier(s) | +| Individual Application PFD Management | /{scsAsId}/transactions/{transactionId}/applications/{appId} (NOTE) | PUT | Update PFDs at individual application level | +| | | PATCH | Update PFDs at individual application level | +| | | GET | Read PFDs at individual application level | +| | | DELETE | Delete PFDs at individual application level | + +NOTE: The appId as the resource identifier is not necessarily identical as the external application identifier received from the SCS/AS. + +## 5.11.3.2 Resource: PFD Management Transactions + +### 5.11.3.2.1 Introduction + +This resource allows an SCS/AS to read all PFDs for a given SCS/AS or create PFDs for a given SCS/AS with one or more external Application Identifier(s). + +### 5.11.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-pfd-management/v1/{scsAsId}/transactions + +This resource shall support the resource URI variables defined in table 5.11.3.2.2-1. + +**Table 5.11.3.2.2-1: Resource URI variables for resource "PFD Management Transactions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.11.3.2.3 Resource methods + +#### 5.11.3.2.3.1 GET + +The GET method allows to read all or queried active PFDs for a given SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the URI query parameters as specified in the table 5.11.3.2.3.1-0. + +**Table 5.11.3.2.3.1-0: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------|-------------------------------------------------------------------|---------------| +| external-app-ids | array(string) | 0..N | The external application identifier(s) of the requested PFD data. | enNB | +| NOTE: If multiple elements are provided in the array data structure, then each element shall be treated as a separate query parameter. | | | | | + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.2.3.1-1. + +**Table 5.11.3.2.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------------------------------------------------------------------------------------|----------------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(PfdManagement) | 0..N | 200 OK | All or queried transactions including the PFDs for the SCS/AS in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.11.3.2.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.2.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.11.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +## 5.11.3.2.3.3 POST + +The POST method creates new PFDs resource(s) for a given SCS/AS with one or more external Application Identifier provided by the SCS/AS. It is initiated by the SCS/AS and answered by the SCEF. The SCS/AS shall provide the external Application Identifier in the message body and upon receipt of the HTTP POST message, the SCEF shall generate the resource "Individual PFD Management Transaction" and also the sub-resource(s) "Individual Application PFD Management", the SCEF shall send these resource URI in the HTTP response to the SCS/AS. + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.2.3.3-1. + +**Table 5.11.3.2.3.3-1: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| | PfdManagement | 1 | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdManagement | 1 | 201 Created | The PFDs resource was created successfully. PfdReport may be included to provide detailed failure information for some applications. | +| | array(PfdReport) | 1..N | 500 Internal Server Error | The PFDs for all applications were not created successfully. PfdReport is included with detailed information. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.2.3.3-2: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-pfd-management/v1/{scsAsId}/transactions/{transactionId} | + +## 5.11.3.2.3.4 PATCH + +This HTTP method is not supported for the resource. + +## 5.11.3.2.3.5 DELETE + +To remove all PFDs for a given SCS/AS, the SCS/AS shall use the HTTP DELETE method on the "PFD Management Transactions" resource. + +The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.11.3.2.3.5-1. + +**Table 5.11.3.2.3.5-1: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | All PFDs were removed successfully. The SCEF shall not return a response content. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. | + +| | | | | | +|-------------------------------------------------------------------------------------------------------|------|--|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | Redirection handling is described in clause 5.2.10. | +| | none | | 308
Permanent Redirect | Permanent redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.11.3.2.3.5-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.2.3.5-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.11.3.3 Resource: Individual PFD Management Transaction + +#### 5.11.3.3.1 Introduction + +This resource allows an SCS/AS to read, or update or delete PFDs for a given SCS/AS and a transaction Id for one or more application identifier(s) at the SCEF. + +#### 5.11.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-pfd-management/v1/{scsAsId}/transactions/{transactionId} + +This resource shall support the resource URI variables defined in table 5.11.3.3.2-1. + +**Table 5.11.3.3.2-1: Resource URI variables for resource "Individual PFD Management Transaction"** + +| Name | Data type | Definition | +|---------------|-----------|------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| transactionId | string | Identifier of the transaction. The transactionId corresponds to the stage 2 TLTRI. | + +#### 5.11.3.3.3 Resource methods + +##### 5.11.3.3.3.1 GET + +The GET method allows to read all PFDs for a given SCS/AS and a transaction Id generated by the SCEF. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.11.3.3.3.1-1. + +**Table 5.11.3.3.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdManagement | 1 | 200 OK | The PFDs for the SCS/AS and the transaction Id for one or more application identifier(s) in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.3.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.3.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.11.3.3.3.2 PUT + +The PUT method modifies the PFDs for a given SCS/AS and an existing transaction Id generated by the SCEF. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.3.3.2-1. + +**Table 5.11.3.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------|-------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | PfdManagement | 1 | Update of PFD(s) for an existing transaction Id. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdManagement | 1 | 200 OK | The PFDs were updated successfully and a representation is returned. PfdReport may be included to provide detailed failure information for some applications. | +| | none | | 204 No Content | The PFDs were updated successfully. | +| | array(PfdReport) | 1..N | 500 Internal Server Error | The PFDs for all applications were not updated successfully. PfdReport is included with detailed information. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.11.3.3.3.3 PATCH + +The PATCH method modifies an existing PFD Management Transaction resource. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message. + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.3.3.3-1. + +**Table 5.11.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|--------------------|-------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | PfdManagementPatch | 1 | Modify of PFD(s) for an existing transaction ID. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdManagement | 1 | 200 OK | The PFDs were modified successfully and a representation of the modified resource is returned. The PfdReport data structure may be included in the response to provide the detailed failure information if the modification failed for some applications. | +| | none | | 204 No Content | The PFDs were modified successfully. | +| | array(PfdReport) | 1..N | 500 Internal Server Error | The PFDs for all applications were not modified successfully. PFD Report(s) shall be included in the response body with the detailed information. | +| | none | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.11.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.11.3.3.3.5 DELETE + +The DELETE method deletes the PFDs for a given SCS/AS and an transaction Id generated by the SCEF. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.11.3.3.3.5-1 and table 5.11.3.3.3.5-2. + +**Table 5.11.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| N/A | | | | + +**Table 5.11.3.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | None | | 204 No Content | The PFDs for an existing transaction Id were removed successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.11.3.4 Resource: Individual Application PFD Management + +### 5.11.3.4.1 Introduction + +This resource allows an SCS/AS to read, update or remove the PFDs for a given SCS/AS and an external Application Identifier at the SCEF. + +### 5.11.3.4.2 Resource definition + +Resource URI: {apiRoot}/3gpp-pfd-management/v1/{scsAsId}/transactions/{transactionId}/applications/{appId} + +This resource shall support the resource URI variables defined in table 5.11.3.4.2-1. + +**Table 5.11.3.4.1: Resource URI variables for resource "Individual Application PFD Management"** + +| Name | Data type | Definition | +|---------------|-----------|----------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| transactionId | string | Identifier of the transaction. | +| appId | string | External Application Identifier. | + +### 5.11.3.4.3 Resource methods + +#### 5.11.3.4.3.1 GET + +The GET method allows to read all PFDs at individual application level. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support request and response data structures, and response codes, as specified in the table 5.11.3.4.3.1-1. + +**Table 5.11.3.4.3.1-1: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | None | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdData | 1 | 200 OK | The PFDs at individual application level in the request URI are returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.4.3.1-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.4.3.1-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.11.3.4.3.2 PUT + +The PUT method modifies the PFDs at individual application level. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.4.3.2-1. + +**Table 5.11.3.4.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | PfdData | 1 | Update of PFD(s) for an existing external application identifier. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdData | 1 | 200 OK | The PFDs for the existing external application identifier were updated successfully and a representation is returned. | +| | none | | 204 No Content | The PFDs for the existing external application identifier were updated successfully. | +| | PfdReport | 1 | 403 Forbidden | The PFDs for the application were not updated successfully, applicable for error SHORT_DELAY in table 5.11.2.2.3-1. | +| | PfdReport | 1 | 409 Conflict | The PFDs for the application were not updated successfully, applicable for error APP_ID_DUPLICATED in table 5.11.2.2.3-1. | +| | PfdReport | 1 | 500 Internal Server Error | The PFDs for the application were not updated successfully, applicable for other errors in table 5.11.2.2.3-1. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.4.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.4.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.11.3.4.3.3 PATCH + +The PATCH method modifies the PFDs at individual application level. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the request and response data structures, and response codes, as specified in the table 5.11.3.4.3.3-1. + +**Table 5.11.3.4.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | PfdData | 1 | Update of PFD(s) for an existing external application identifier. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | PfdData | 1 | 200 OK | The PFDs for the existing external application identifier were updated successfully and a representation is returned. | +| | none | | 204 No Content | The PFDs for the existing external application identifier were updated successfully. | +| | PfdReport | 1 | 403 Forbidden | The PFDs for the application were not updated successfully, applicable for error SHORT_DELAY in table 5.11.2.2.3-1. | +| | PfdReport | 1 | 409 Conflict | The PFDs for the application were not updated successfully, applicable for error APP_ID_DUPLICATED in table 5.11.2.2.3-1. | +| | PfdReport | 1 | 500 Internal Server Error | The PFDs for the application were not updated successfully, applicable for other errors in table 5.11.2.2.3-1. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.4.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.4.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.11.3.4.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.11.3.4.3.5 DELETE + +The DELETE method deletes all the PFDs at individual application level. It is initiated by the SCS/AS and answered by the SCEF. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.11.3.4.3.5-1 and table 5.11.3.4.3.5-2. + +**Table 5.11.3.4.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| N/A | | | | + +**Table 5.11.3.4.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | +| Response body | none | | | | +| | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The PFDs were removed successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.11.3.4.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.11.3.4.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.11.3.5 Void + +## 5.11.3A Notifications + +### 5.11.3A.1 General + +The notifications provided by the PfdManagement API are specified in this clause. + +**Table 5.11.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------|---------------------------|---------------------------------|------------------------------------------| +| PFD Management Notification | {notificationDestination} | POST | Send asynchronous PFD management result. | + +## 5.11.3A.2 PFD Management Notification + +### 5.11.3A.2.1 Description + +The PFD Management Notification allows the SCEF to send notification about PFD management result to the SCS/AS, if the PFD provisioning fails within the allowed delay. + +### 5.11.3A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.11.3A.2.2-1. + +**Table 5.11.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|--------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Callback reference provided by the SCS/AS during creation or modification of the PFD management transaction. | + +### 5.11.3A.2.3 Standard Methods + +#### 5.11.3A.2.3.1 Notification via POST + +The HTTP POST method reports the asynchronous PFD management result. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.11.3A.2.3.1-1 and the response data structures and response codes specified in table 5.11.3A.2.3.1-2. + +**Table 5.11.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|-----------|-------------|-------------------------------------------------------| +| PfdReport | 1..N | The PFD management notification provided by the SCEF. | + +**Table 5.11.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | The PFD management notification is received successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS instance where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.11.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.11.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.11.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the PfdReport may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.11.4 Used Features + +The table below defines the features applicable to the PfdManagement API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.11.4-1: Features used by PfdManagement API** + +| Feature Number | Feature | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | DomainNameProtocol | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| 2 | PfdMgmtNotification | This feature supports PFD management notification. | +| 3 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 4 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 5 | FailureLocation_5G | This feature supports the notification of specific failure location area of UPF for PFD management in 5G. This feature is applicable only if PfdMgmtNotification feature is also supported. The feature supports the 5G requirement and may only be supported in 5G. | +| 6 | enNB | Indicates the support of enhancements to the northbound interfaces. | +| 7 | PatchUpdate | Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing PFD Management Transaction resource). | + +### 5.11.5 Error handling + +#### 5.11.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +#### 5.11.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the PfdManagement API. + +#### 5.11.5.3 Application Errors + +The application errors defined for PfdManagement API are listed in table 5.11.5.3-1. + +**Table 5.11.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.12 ECRControl API + +### 5.12.1 Overview + +The ECRControl API is a custom API (RPC interaction) that allows the SCS/AS to query or configure the enhanced coverage restriction over 3GPP networks. The ECRControl API defines a set of data models and related custom operation procedures for the enhanced coverage restriction control request. The corresponding JSON schema for the representation of the operations defined by the ECRControl API is provided in its complete form in Annex A.12. + +### 5.12.2 Data model + +#### 5.12.2.1 Data types + +##### 5.12.2.1.1 Introduction + +This clause defines data structures to be used in the request and response. + +Table 5.12.2.1.1-1 specifies data types re-used by the ECRControl API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the ECRControl API. + +**Table 5.12.2.1.1-1: ECRControl API re-used Data Types** + +| Data type | Reference | Comments | +|---------------------|---------------------|-----------------------------------------------------------------------------------------| +| EcRestrictionDataWb | 3GPP TS 29.503 [63] | Contains the Enhance Coverage Restriction Data. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.12.4-1. | + +Table 5.12.2.1.1-2 specifies the data types defined for the ECRControl API. + +**Table 5.12.2.1.1-2: ECRControl API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|---------------------------------------------------------------------------------------------------------|---------------| +| ECRControl | 5.12.2.1.2 | Represents the parameters to request Enhanced Coverage Restriction control. | | +| ECRData | 5.12.2.1.3 | Represents the current visited PLMN (if any) and the current settings of enhanced coverage restriction. | | +| PlmnEcRestrictionDataWb | 5.12.2.1.4 | Indicates whether enhanced coverage mode is restricted or not for a PLMN ID. | ECR_WB_5G | + +##### 5.12.2.1.2 Type: ECRControl + +This type represents the Enhanced Coverage Restriction control request. The structure is used only for request. + +**Table 5.12.2.1.2-1: Definition of type ECRControl** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------|--------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| supportedFeatures | SupportedFeatures | 1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. | | +| mtcProviderId | string | 0..1 | Identifier the MTC Service Provider and/or MTC Application. (NOTE 4). | | +| scsAsId | string | 0..1 | Identifier of the SCS/AS. | | +| externalId | ExternalId | 0..1 | Identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
(NOTE 2) | | +| msisdn | Msisdn | 0..1 | Identifies the MS internal PSTN/ISDN number allocated for a UE.
(NOTE 2) | | +| ecrDataWbs | array(PlmnEcRestrictionDataWb) | 0..N | Identifies whether enhanced coverage mode are restricted or not. This attribute shall not be present for the query custom operation. | ECR_WB_5G | +| restrictedPlmnIds | array(PlmnId) | 0..N | Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. This attribute shall not be present for the query custom operation. (NOTE 3) | | +| allowedPlmnIds | array(PlmnId) | 0..N | Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. This attribute shall not be present for the query custom operation. (NOTE 3) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: One of the properties "externalId" or "msisdn" shall be included. +NOTE 3: "restrictedPlmnIds" and "allowedPlmnIds" shall be mutually exclusive. +NOTE 4: The SCEF should check received MTC provider identifier and then the SCEF may: +- override it with local configured value and send it to HSS; +- send it directly to the HSS; or +- reject the Enhanced Coverage Restriction control request + +### 5.12.2.1.3 Type: ECRData + +This data type represents the current visited PLMN (if any) and the current settings of enhanced coverage restriction. The structure is used only for response. + +**Table 5.12.2.1.3-1: Definition of type ECRData** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------|--------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------|------------------------| +| supportedFeatures | SupportedFeatures | 1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. | | +| visitedPlmnId | PlmnId | 0..1 | Indicates the current visited PLMN. | | +| ecrDataWbs | array(PlmnEcRestrictionDataWb) | 0..N | Identifies whether enhanced coverage mode are restricted or not. | ECR_WB_5G | +| restrictedPlmnIds | array(PlmnId) | 0..N | Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be restricted. (NOTE 2) | | +| allowedPlmnIds | array(PlmnId) | 0..N | Indicates a complete list (and possibly empty) of serving PLMNs where Enhanced Coverage shall be allowed. (NOTE 2) | | + +NOTE 1: Properties marked with a feature as defined in clause 5.4.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. +NOTE 2: "restrictedPlmnIds" and "allowedPlmnIds" shall be mutually exclusive. + +#### 5.12.2.1.4 Type: PlmnEcRestrictionDataWb + +**Table 5.12.2.1.4-1: Definition of type PlmnEcRestrictionDataWb** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|---------------------|-------------|-----------------------------------------------------------------------------|---------------| +| plmnId | PlmnId | 1 | Indicates the PLMN where enhanced coverage mode shall be restricted or not. | | +| plmnEcrDataWb | EcRestrictionDataWb | 0..1 | Identifies whether enhanced coverage mode are restricted or not. | | + +### 5.12.3 Custom Operations without associated resources + +#### 5.12.3.1 Overview + +Custom operations used for this API are summarized in table 5.12.3.1-1. "apiRoot" is set as described in clause 5.2.4. + +**Table 5.12.3.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|------------------------------------------------------------| +| query | /query | POST | Query the status of enhanced coverage restriction for a UE | +| configure | /configure | POST | Configure the enhanced coverage restriction for a UE | + +#### 5.12.3.2 Operation: query + +##### 5.12.3.2.1 Description + +This custom operation allows an SCS/AS to query the current status of enhanced coverage restriction for a UE via the T8 interface as defined in 3GPP TS 23.682 [2]. + +##### 5.12.3.2.2 Operation Definition + +This operation shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.12.3.2.2-1 and table 5.12.3.2.2-2. + +**Table 5.12.3.2.2-1: URI query parameters supported by the POST on this operation** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.12.3.2.2-2: Data structures supported by the POST request/response on this operation** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ECRControl | 1 | Parameters to query the current status of Enhanced Coverage Restriction. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ECRData | 1 | 200 OK | The requested information was returned successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.12.5.3. + +**Table 5.12.3.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.12.3.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.12.3.3 Operation: configure + +### 5.12.3.3.1 Description + +This custom operation allows an SCS/AS to configure the current setting of enhanced coverage restriction for a UE via the T8 interface as defined in 3GPP TS 23.682 [2]. + +### 5.12.3.3.2 Operation Definition + +This operation shall support the request data structures specified in table 5.12.3.3.2-1 and the response data structure and response codes specified in table 5.12.3.3.2-2. + +**Table 5.12.3.3.2-1: URI query parameters supported by the POST on this operation** + +| Name | Data type | Cardinality | Remarks | +|----------------|------------------|--------------------|----------------| +| none specified | | | | + +**Table 5.12.3.3.2-2: Data structures supported by the POST request/response on this operation** + +| Request body | Data type | Cardinality | Remarks | | +|----------------------|------------------|--------------------|-----------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ECRControl | 1 | Parameters to configure the setting of Enhanced Coverage Restriction. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | ECRData | 1 | 200 OK | The Enhanced Coverage Restriction setting was configured successfully | +| | none | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.12.5.3. + +**Table 5.12.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.12.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.12.4 Used Features + +The table below defines the features applicable to the ECRControl API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.12.4-1: Features used by ECRControl API** + +| Feature Number | Feature | Description | +|-----------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ECR_WB_5G | The enhanced coverage restriction control information indicates whether the enhanced coverage modes are restricted or not for the WB UE. The feature is not applicable to the pre-5G. | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +## 5.12.5 Error handling + +### 5.12.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.12.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the ECRControl API. + +### 5.12.5.3 Application Errors + +The application errors defined for the ECRControl API are listed in table 5.12.5.3-1. + +**Table 5.12.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|------------------------------| +| QUOTA_EXCEEDED | 403 Forbidden | Not enough quota for SCS/AS. | + +## 5.13 NpConfiguration API + +### 5.13.1 Overview + +The NpConfiguration API is a RESTful API that allows the SCS/AS to send suggested network parameters to influence certain aspects of UE/network behaviour such as the UE's PSM, extended idle mode DRX, and extended buffering configurations. The NpConfiguration API defines a set of data models, resources and the related procedures for the creation and management of the network parameter configuration. The corresponding JSON schema for the representation of the resources and operations defined by the NpConfiguration API is provided in its complete form in Annex A.13. + +### 5.13.2 Data model + +#### 5.13.2.1 Resource data types + +##### 5.13.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.13.2.1.1-1 specifies data types re-used by the NetworkParameterConfiguration API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NetworkParameterConfiguration API. + +**Table 5.13.2.1.1-1: NetworkParameterConfiguration API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|-----------------------------------------------------------------------------------------| +| Dnn | 3GPP TS 29.571 [45] | Identifies a DNN. | +| IpAddr | 3GPP TS 29.571 [45] | UE IP Address. | +| MacAddr48 | 3GPP TS 29.571 [45] | MAC Address. | +| Snssai | 3GPP TS 29.571 [45] | Identifies an S-NSSAI. | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.13.4-1. | + +Table 5.13.2.1.1-2 specifies the data types defined for the NpConfiguration API. + +**Table 5.13.2.1.1-2: NpConfiguration API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------|-----------------------|--------------------------------------------------------------------------------------------------------|----------------------| +| ConfigurationNotification | 5.13.2.1.4 | Represents a configuration result notification. | | +| NpConfiguration | 5.13.2.1.2 | Represents a network parameters configuration. | | +| NpConfigurationPatch | 5.13.2.1.3 | Represents parameters used to request the modification of a network parameters configuration resource. | | + +#### 5.13.2.1.2 Type: NpConfiguration + +This type represents a configuration of network parameters. The same structure is used in the configuration request and response. + +**Table 5.13.2.1.2-1: Definition of type NpConfiguration** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 2) | +|----------------------------|----------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| self | Link | 0..1 | Link to the resource "Individual NP Configuration". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| mtcProviderId | string | 0..1 | Identifies the MTC Service Provider and/or MTC Application. (NOTE 4) | | +| dnn | Dnn | 0..1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | UEId_retrieval | +| externalId | ExternalId | 0..1 | Identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].
The attribute may also be present in the NP configuration response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "ueIpAddr" attribute or the "ueMacAddr" attribute. (NOTE 1) | | +| msisdn | Msisdn | 0..1 | Identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE 1) | | +| externalGroupId | ExternalGroupId | 0..1 | Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 1) | | +| maximumLatency | DurationSec | 0..1 | This parameter may be included to identify the maximum delay acceptable for downlink data transfers. | | +| maximumResponseTime | DurationSec | 0..1 | This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data. | | +| suggestedNumberOfDIPackets | integer | 0..1 | This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable. | | +| groupReportingGuardTime | DurationSec | 0..1 | Identifies the time for which the SCEF can aggregate the reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2]. | | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination where T8 notification requests shall be delivered. The attribute shall be provided if the attribute "externalGroupId" is provided. | | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. The attribute may only be provided if the attribute "externalGroupId" is provided. | Notification_test_event | +| websocketNotifConfig | WebsocketNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. The attribute may only be provided if the attribute "externalGroupId" is provided. | Notification_websocket | +| validityTime | DateTime | 0..1 | Identifies when the network parameter expires and shall be deleted locally if it expires. The attribute is only applicable in 5G. (NOTE 3) | NpExpiry_5G | +| snssai | Snssai | 0..1 | Indicate the S-NSSAI. | UEId_retrieval | +| ueIpAddr | IpAddr | 0..1 | UE IP address. | UEId_retrieval | +| ueMacAddr | MacAddr48 | 0..1 | UE MAC address. | UEId_retrieval | + +NOTE 1: Only one of the properties "externalId", "msisdn" or "externalGroupId" shall be included. + +| | | +|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 2: | Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | +| NOTE 3: | If this attribute is omitted, no expiry for network parameter configuration applies. | +| NOTE 4: | The SCEF should check received MTC provider identifier and then the SCEF may:
  • - override it with local configured value and send it to HSS;
  • - send it directly to the HSS; or
  • - reject the network parameter configuration request.
| + +#### 5.13.2.1.3 Type: NpConfigurationPatch + +This type represents a configuration of network parameters provided by the SCS/AS to the SCEF. The structure is used for HTTP PATCH request. + +**Table 5.13.2.1.3-1: Definition of type NpConfigurationPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| maximumLatency | DurationSecRm | 0..1 | This parameter may be included to identify the maximum delay acceptable for downlink data transfers. | | +| maximumResponseTime | DurationSecRm | 0..1 | This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data. | | +| suggestedNumberOfDIPackets | integer | 0..1 | This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable. | | +| groupReportGuardTime | DurationSecRm | 0..1 | Identifies the time for which the SCEF can aggregate the reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2]. | | +| validityTime | DateTimeRm | 0..1 | Identifies when the network parameter expires and shall be deleted locally if it expires. The attribute is only applicable in 5G. | NpExpiry_5G | +| notificationDestination | Link | 0..1 | A URI indicating the notification destination where T8 notification requests shall be delivered. | | +| NOTE: Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. | | | | | + +#### 5.13.2.1.4 Type: ConfigurationNotification + +This type represents a configuration result notification. + +**Table 5.13.2.1.4-1: Definition of the ConfigurationNotification data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| configuration | Link | 1 | Link to the configuration resource to which this notification is related. | | +| configResults | array(ConfigResult) | 0..N | Each element identifies a notification of grouping configuration result. | | +| appliedParam | AppliedParameterConfiguration | 0..1 | Indicates the applied parameter configuration in the network. The "maximumDetectionTime" attribute in AppliedParameterConfiguration data type is not applicable for Network Parameter configuration. | Enhanced_param_config | +| NOTE: Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +## 5.13.3 Resource structure + +### 5.13.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-network-parameter-configuration/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-network-parameter-configuration" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.13.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|-----------------------------|---------------------------------------------|-------------|---------------------------------------------------------------| +| NP Configurations | /{scsAsId}/configurations | GET | Read all NP configurations for a given SCS/AS | +| | | POST | Create a new NP configuration | +| Individual NP Configuration | /{scsAsId}/configurations/{configurationId} | PUT | Replace all of the properties in an existing NP configuration | +| | | PATCH | Modify some properties in an existing NP configuration | +| | | GET | Read an existing NP configuration | +| | | DELETE | Delete a NP configuration | + +### 5.13.3.2 Resource: NP Configurations + +#### 5.13.3.2.1 Introduction + +This resource allows an SCS/AS to read all active network parameter configurations or create a new configuration to configure network parameters. + +#### 5.13.3.2.2 Resource definition + +Resource URI: **{apiRoot}/3gpp-network-parameter-configuration/v1/{scsAsId}/configurations** + +This resource shall support the resource URI variables defined in table 5.13.3.2.2-1. + +**Table 5.13.3.2.2-1: Resource URI variables for resource "NP Configurations"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +#### 5.13.3.2.3 Resource methods + +##### 5.13.3.2.3.1 GET + +The GET method allows to read all active configurations indicated by the resource URI as defined in clause 5.13.3.2.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.2.3.1-1 and table 5.13.3.2.3.1-2. + +**Table 5.13.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.13.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(NpConfiguration) | 0..N | 200 OK | The NP configuration information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.13.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.13.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.13.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.13.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.13.3.2.3.4 POST + +The POST method creates a new configuration resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.2.3.4-1 and table 5.13.3.2.3.4-2. + +**Table 5.13.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.13.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| | Data type | Cardinality | Response codes | Remarks | +| | NpConfiguration | 1 | | Parameters to create a new configuration to configure network parameters with the SCEF. | +| Response body | NpConfiguration | 1 | 201 Created | The configuration was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.13.5.3. + +**Table 5.13.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-network-parameter-configuration/v1/
{scsAsId}/configurations/{configurationId} | + +### 5.13.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +## 5.13.3.3 Resource: Individual NP Configuration + +### 5.13.3.3.1 Introduction + +This resource allows an SCS/AS to query, update and delete a network parameter configuration indicated by the resource URI as defined in clause 5.13.3.3.2. + +### 5.13.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-network-parameter-configuration/v1/{scsAsId}/configurations/{configurationId} + +This resource shall support the resource URI variables defined in table 5.13.3.2-1. + +**Table 5.13.3.2-1: Resource URI variables for resource "Individual NP Configuration"** + +| Name | Data type | Definition | +|-----------------|-----------|-------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | +| configurationId | string | Identifier of the configuration resource. | + +### 5.13.3.3.3 Resource methods + +#### 5.13.3.3.3.1 GET + +The GET method allows to read an active configuration indicated by the resource URI as defined in subclause 5.13.3.3.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.1-1 and table 5.13.3.3.3.1-2. + +**Table 5.13.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 5.13.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NpConfiguration | 1 | 200 OK | The configuration information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.13.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.13.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.13.3.3.3.2 PUT + +The PUT method modifies an existing configuration indicated by the resource URI as defined in clause 5.13.3.3.2. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.2-1 and table 5.13.3.3.3.2-2. + +**Table 5.13.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.13.3.3.3.2-2: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------|-------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NpConfiguration | 1 | Update of network parameter(s) for an existing Configuration. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NpConfiguration | 1 | 200 OK | The resource was updated successfully.
The SCEF shall return an updated Configuration information in the response. | +| | none | | 204 No Content | The resource was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.13.5.3. + +**Table 5.13.3.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.13.3.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.13.3.3.3.3 PATCH + +The PATCH method shall be used to update some properties in an existing configuration indicated by the Resource URI as defined in clause 5.13.3.3.2. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3-1 and table 5.13.3.3.3-2. + +**Table 5.13.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.13.3.3.3.3-2: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------------|-------------|-------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | NpConfigurationPatch | 1 | Partial update an existing network parameter configuration. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | NpConfiguration | 1 | 200 OK | The configuration was updated successfully.
The SCEF shall return an updated configuration information in the response. | +| | none | | 204 No Content | The configuration was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.13.5.3. + +**Table 5.13.3.3.3.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.13.3.3.3.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.13.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.13.3.3.3.5 DELETE + +The DELETE method deletes an existing configuration resource "Individual NP Configuration". The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.5-1 and table 5.13.3.3.3.5-2. + +**Table 5.13.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| N/A | | | | + +**Table 5.13.3.3.5-2: Data structures supported by the DELETE request/response on the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(ConfigResult) | 1..N | 200 OK | The configuration was terminated successfully, the configuration failure information for group members shall be included if received. | +| | none | | 204 No Content | The configuration was terminated successfully.
The response body shall be empty. | +| | none | | 307 Temporary Redirect | Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.

Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.13.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.13.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.13.3.4 Void + +## 5.13.3A Notifications + +### 5.13.3A.1 General + +The notifications provided by the NpConfiguration API are specified in this clause. + +**Table 5.13.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------|---------------------------|---------------------------------|--------------------------------------------------------------------| +| Configuration Notification | {notificationDestination} | POST | Report a grouping configuration result from the SCEF to the SCS/AS | + +## 5.13.3A.2 Configuration Notification + +### 5.13.3A.2.1 Description + +The Configuration Notification allows the SCEF to send notifications about grouping configuration result to the SCS/AS. + +### 5.13.3A.2.2 Target URI + +The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.13.3A.2.2-1. + +**Table 5.13.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | Callback reference provided by the SCS/AS during creation or modification of the NP configuration subscription. | + +### 5.13.3A.2.3 Standard Methods + +#### 5.13.3A.2.3.1 Notification via POST + +The HTTP POST method reports the grouping configuration results for a NP configuration subscription. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.13.3A.2.3.1-1 and the response data structures and response codes specified in table 5.13.3A.2.3.1-2. + +**Table 5.13.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|---------------------------|-------------|----------------------------------------------------------------------| +| ConfigurationNotification | 1 | The grouping configuration result notification provided by the SCEF. | + +**Table 5.13.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | The notification is received successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.13.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.13.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.13.3a.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the ConfigurationNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.13.4 Used Features + +The table below defines the features applicable to the NpConfiguration API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.13.4-1: Features used by NpConfiguration API** + +| Feature Number | Feature | Description | +|----------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notification connection is supported according to clause 5.2.5.3. | +| 3 | NpExpiry_5G | The network parameter expiry is supported. This feature may only be supported in 5G. | +| 4 | Enhanced_param_configuring | This feature supports the co-existence of multiple event configurations for target UE(s) if there are parameters affecting periodic RAU/TAU timer and/or Active Time. | +| 5 | UEId_retrieval | This feature supports AF specific UE ID retrieval.
The feature is not applicable to pre-5G (e.g. 4G). | + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". +Description: A clear textual description of the feature. + +## 5.13.5 Error handling + +### 5.13.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.13.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the NpConfiguration API. + +### 5.13.5.3 Application Errors + +The application errors defined for the NpConfiguration API are listed in table 5.13.5.3-1. + +**Table 5.13.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| PARAMETER_OUT_OF_RANGE | 403 Forbidden | Indicates that the resource is not allowed to be created since one or more of the received parameters are out of range defined by operator policies. | | +| REQUEST_NOT_AUTHORIZED | 403 Forbidden | Indicates that the AF specific UE ID retrieval request is not authorized. | UEId_retrieval | +| UE_ID_NOT_AVAILABLE | 404 Not Found | Indicates that the AF specific UE ID is not available. | UEId_retrieval | +| UE_NOT_FOUND | 404 Not Found | Indicates that the requested UE address is not found. | UEId_retrieval | + +## 5.14 AsSessionWithQoS API + +### 5.14.1 Overview + +The AsSessionWithQoS API is a RESTful API that allows the SCS/AS to set up a session with SCEF with required QoS based on the application and service requirement. The AsSessionWithQoS API defines a set of data models, resources and the related procedures for the creation and management of the AS sessions with required QoS. The corresponding JSON schema for the representation of the resources and operations defined by the AsSessionWithQoS API is provided in its complete form in Annex A.14. + +### 5.14.2 Data model + +#### 5.14.2.1 Resource data types + +##### 5.14.2.1.1 Introduction + +This clause defines data structures to be used in resource representations, including subscription resources. + +Table 5.14.2.1.1-1 specifies data types re-used by the AsSessionWithQoS API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the AsSessionWithQoS API. + +**Table 5.14.2.1.1-1: AsSessionWithQoS API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AcceptableServiceInfo | 3GPP TS 29.514 [52] | Acceptable maximum requested bandwidth. | | +| AlternativeServiceRequirementsData | 3GPP TS 29.514 [52] | Contains alternative QoS related parameters and a reference to them. | | +| AverWindow | 3GPP TS 29.571 [45] | Averaging Window. | EnQoSMon | +| AverWindowRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "AverWindow" data type, but with the OpenAPI "nullable: true" property. | EnQoSMon | +| BatOffsetInfo | 3GPP TS 29.514 [52] | Contains the offset of the BAT and the optionally adjusted periodicity. | | +| BitRate | 3GPP TS 29.571 [45] | String representing a bit rate that shall be formatted as follows:
Pattern: '^\\d+(\\.\\d+)? (bps Kbps Mbps Gbps Tbps)\$'
Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps" | | +| BitRateRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. | | +| Dnn | 3GPP TS 29.571 [45] | Identifies a DNN. | | +| EthFlowDescription | 3GPP TS 29.514 [52] | Defines a packet filter for an Ethernet flow.(NOTE 1) | | +| EventsSubscReqData | 3GPP TS 29.514 [52] | Identifies the events the application subscribes to. | EnQoSMon | +| EventsSubscReqDataRm | 3GPP TS 29.514 [52] | This data type is defined in the same way as the "EventsSubscReqData" data type, but with the OpenAPI "nullable: true" property | EnQoSMon | +| ExtMaxDataBurstVol | 3GPP TS 29.571 [45] | Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.
Minimum = 4096. Maximum = 2000000. | | +| ExtMaxDataBurstVolRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "ExtMaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property. | | +| ExternalGroupId | 5.2.1.3.2 | Represents an external group identifier. | GMEC_5G | +| Gpsi | 3GPP TS 29.571 [45] | Represents a GPSI. | GMEC_5G | +| IpAddr | 3GPP TS 29.571 [45] | UE IP Address. | | +| MacAddr48 | 3GPP TS 29.571 [45] | MAC Address. | | +| MediaType | 3GPP TS 29.514 [52] | Indicates the media type of a single-modal data flow of a multi-modal service. | MultiMedia | +| MultiModalId | 3GPP TS 29.514 [52] | Represents multi-modal service identifier. | MultiMedia | +| PacketDelBudget | 3GPP TS 29.571 [45] | Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in milliseconds.
Minimum = 1. | | +| PacketDelBudgetRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "PacketDelBudget" data type, but with the OpenAPI "nullable: true" property. | | +| PacketErrRate | 3GPP TS 29.571 [45] | String representing Packet Error | | + +| | | | | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | |

Rate (see clauses 5.7.3.5 and 5.7.4 of 3GPP TS 23.501 [8]), expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit.
Pattern: '^[0-9]E-[0-9]'

Examples:
Packer Error Rate 4 \times 10^{-6} shall be encoded as "4E-6".
Packer Error Rate 10^{-2} shall be encoded as "1E-2".

| | +|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| PacketErrRateRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "PacketErrRate" data type, but with the OpenAPI "nullable: true" property. | | +| PdvMonitoringReport | 3GPP TS 29.514 [52] | Represents a PDV monitoring report. | | +| PeriodicityInfo | 3GPP TS 29.514 [52] | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | | +| PduSetQosPara | 3GPP TS 29.571 [45] | Represents the PDU Set level QoS parameters. | | +| PduSetQosParaRm | 3GPP TS 29.571 [45] | Represents the PDU Set level QoS parameters to be modified. | | +| PlmnIdNid | 3GPP TS 29.571 [45] | Identifies the network: the PLMN Identifier (the mobile country code and the mobile network code) or the SNPn Identifier (the PLMN Identifier and the NID). | | +| Port | 5.2.1.3.2 | Unsigned integer with valid values between 0 and 65535 representing a port. | ListUE_5G | +| ProblemDetails | 5.2.1.2.12 | Problem Details when returning an error response. | | +| ProtoDesc | 3GPP TS 29.514 [52] | Represents Protocol description of the media flow | | +| RatType | 3GPP TS 29.571 [45] | Identifies the RAT Type. | | +| ReportingFrequency | 3GPP TS 29.512 [8] | Indicates the frequency for the reporting, such as event triggeredand/or periodic. (NOTE 2) | | +| RequestedQosMonitoringParameter | 3GPP TS 29.512 [8] | Indicates the QoS information to be measured, e.g. UL packet delay, DL packet delay or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for packet delay is enabled for the service data flow. (NOTE 2) | | +| ServAuthInfo | 3GPP TS 29.514 [52] | The authorization result of a request for QoS / QoS monitoring. | EnQoSMon | +| Snssai | 3GPP TS 29.571 [45] | Identifies the S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.14.4-1. | | +| TscailInputContainer | 3GPP TS 29.514 [52] | TSCAI Input information container. | TSC_5G, MultiMedia | +| TscPriorityLevel | 3GPP TS 29.514 [52] | Represents priority of TSC Flows. | TSC_5G, MultiMedia | +| TscPriorityLevelRm | 3GPP TS 29.514 [52] | Represents the same as the TscPriorityLevel data type, but with the OpenAPI "nullable: true" property. | TSC_5G, MultiMedia | +| TsnQosContainer | 3GPP TS 29.514 [52] | Represents individual QoS parameters | MultiMedia | +| TsnQosContainerRm | 3GPP TS 29.514 [52] | Represents the same as the TsnQosContainer data type, but with the OpenAPI "nullable: true" property. | MultiMedia | +| Uinteger | 3GPP TS 29.571 [45] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.
Minimum = 0. | | +| UintegerRm | 3GPP TS 29.571 [45] | This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property. | | +| UplinkDownlinkSupport | 3GPP TS 29.514 [52] | Provides L4S support information. | L4S | +| NOTE 1: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange_5G as specified in clause 5.14.4 shall be supported. | | | | +| NOTE 2: In order to support QoS Monitoring, feature QoSMonitoring_5G as specified in | | | | + +| | | +|-----------------------------------|--| +| clause 5.14.4 shall be supported. | | +|-----------------------------------|--| + +Table 5.14.2.1.1-2 specifies the data types defined for the AsSessionWithQoS API. + +**Table 5.14.2.1.1-2: AsSessionWithQoS API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| AdditionalInfoAsSessionWithQos | 5.14.2.1.10 | Describes additional error information specific for this API. | | +| AsSessionWithQoSSubscription | 5.14.2.1.2 | Represents an individual AS session with required QoS subscription resource. | | +| AsSessionWithQoSSubscriptionPatch | 5.14.2.1.3 | Represents parameters to modify an AS session with specific QoS subscription. | | +| AsSessionMediaComponent | 5.14.2.1.13 | Represents media component data for a multi-modal service. It contains service data flow information for a single modal data flow of a multi-modal service. | MultiMedia | +| AsSessionMediaComponentRm | 5.14.2.1.14 | Represents the same as the AsSessMediaComponent data type but with the "nullable: true" property. | MultiMedia | +| MultiModalFlows | 5.14.2.1.15 | Represents flow information within a single-modal data flow for a multi-modal service. | MultiMedia | +| ProblemDetailsAsSessionWithQoS | 5.14.2.1.11 | ProblemDetails as defined in clause 5.2.12.12 extended with specific error information for this API, as described in AdditionalInfoAsSessionWithQos. | | +| QosMonitoringInformation | 5.14.2.1.6 | Represents QoS monitoring information. | QoSMonitoring_5G | +| QosMonitoringInformationRm | 5.14.2.1.7 | Represents the same as the QosMonitoringInformation data type but with the "nullable: true" property. | QoSMonitoring_5G | +| QosMonitoringReport | 5.14.2.1.8 | Represents a QoS monitoring report. | QoSMonitoring_5G | +| TscQosRequirement | 5.14.2.1.9 | Represents QoS requirements for time sensitive communication. | TSC_5G
XRM_5G | +| TscQosRequirementRm | 5.14.2.1.10 | Represents the same as the TscQosRequirement data type but with the "nullable: true" property. | TSC_5G
XRM_5G | +| UserPlaneEvent | 5.14.2.2.3 | Represents the user plane event. | enNB | +| UserPlaneEventReport | 5.14.2.1.5 | Represents an event report for user plane. | enNB | +| UserPlaneNotificationData | 5.14.2.1.4 | Represents the parameters to be conveyed in a user plane event(s) notification. | enNB | +| UeAddInfo | 5.14.2.1.16 | Represents the UE address information. | ListUE_5G | + +#### 5.14.2.1.2 Type: AsSessionWithQoSSubscription + +This type represents an AS session request with specific QoS for the service provided by the SCS/AS to the SCEF via T8 interface. The structure is used for subscription request and response. + +**Table 5.14.2.1.2-1: Definition of type AsSessionWithQoSSubscription** + +| Attribute name | Data type | Cardinality | Description | Applicability
(NOTE 1) | +|-------------------------|-------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| self | Link | 0..1 | Link to the resource "Individual AS Session with Required QoS Subscription".
This parameter shall be supplied by the SCEF in HTTP responses. | | +| dnn | Dnn | 0..1 | Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
(NOTE 3) | | +| snssai | Snssai | 0..1 | Identifies an S-NSSAI. (NOTE 3) | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| notificationDestination | Link | 1 | Contains the URL to receive the notification bearer level event(s) from the SCEF. | | +| exterAppId | string | 0..1 | Identifies the external Application Identifier.
(NOTE 2) (NOTE 9) (NOTE 11) | AppId
ListUE_5G
GMEC_5G | +| extGroupId | ExternalGroupId | 0..1 | Identifies a group of UE(s).
(NOTE 10) | GMEC_5G | +| gpsi | Gpsi | 0..1 | Identifies a UE using its GPSI.
(NOTE 10) | GMEC_5G | +| flowInfo | array(FlowInfo) | 0..N | Describe the IP data flow which requires QoS.
(NOTE 2) (NOTE 7) (NOTE 9) (NOTE 11) | | +| ethFlowInfo | array(EthFlowDescription) | 0..N | Identifies Ethernet packet flows.
(NOTE 2) (NOTE 6) (NOTE 11) | EthAsSessionQoS_5G
GMEC_5G | +| enEthFlowInfo | array(EthFlowInfo) | 0..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows.
(NOTE 2) (NOTE 6) (NOTE 11) | EnEthAsSessionQoS_5G
GMEC_5G | +| qosReference | string | 0..1 | Identifies a pre-defined QoS information.
(NOTE 4) (NOTE 5) | | +| altQoSReferences | array(string) | 0..N | Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority.
(NOTE 4) | AlternativeQoS_5G | +| altQoSReqs | array(AlternativeServiceRequirementsData) | 0..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 4) | AltQoSWithinDParams_5G | +| disUeNotif | boolean | 0..1 | Indicates whether to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. The fulfilled situation is either the QoS profile or an Alternative QoS Profile.

- true: the QoS flow parameters signalling to the UE is disabled;
- false (default): the QoS flow parameters signalling to the UE is not disabled. | DisableUENotification_5G | +| uelpv4Addr | Ipv4Addr | 0..1 | The Ipv4 address of the UE.
(NOTE 2) | | +| ipDomain | string | 0..1 | The IPv4 address domain identifier.
The attribute may only be provided if the | | + +| | | | | | +|--|--|--|----------------------------------|--| +| | | | uelpv4Addr attribute is present. | | +|--|--|--|----------------------------------|--| + +| | | | | | +|-------------------------|------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| uelpv6Addr | Ipv6Addr | 0..1 | The Ipv6 address of the UE.
(NOTE 2) | | +| macAddr | MacAddr48 | 0..1 | Identifies the MAC address.
(NOTE 2) | EthAsSessionQoS_5G | +| listUeAddrs | array(UeAddInfo) | 0..N | Identifies the list of UE address(es).
(NOTE 9) (NOTE 12) | ListUE_5G | +| usageThreshold | UsageThreshold | 0..1 | Time period and/or traffic volume in which the QoS is to be applied. | | +| sponsorInfo | SponsorInformation | 0..1 | Indicates a sponsor information | | +| qosMonInfo | QosMonitoringInformation | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | QoSMonitoring_5G | +| directNotifInd | boolean | 0..1 | Indicates whether the direct event notification is requested.

- true: the direct event notification is requested;
- false (default): the direct event notification is not requested. | ExposureToEAS | +| tscQosReq | TscQosRequirement | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 5) | TSC_5G
XRM_5G | +| requestTestNotification | boolean | 0..1 | Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. | Notification_websocket | +| events | array(UserPlaneEvent) | 0..N | Corresponds to the list of user plane event(s) to which the SCS/AS requests to subscribe to. | enNB | +| multiModalId | MultiModalId | 0..1 | Multi-modal Service Identifier, as defined in 3GPP TS 29.514 [52]. | MultiMedia | +| multiModDatFlows | map(AsSessionMediaComponent) | 0..N | Each element of the map represents Media Component data for a single-modal data flow(s) of a multi-modal service. The key of the map is the attribute "medCompN".
(NOTE 8) | MultiMedia | +| l4sInfo | UplinkDownlinkSupport | 0..1 | Provides L4S support information. | L4S | +| pduSetQos | PduSetQosPara | 0..1 | Contains the PDU Set QoS Parameters which are used to support PDU Set based QoS handling. | PDUSetHandling | +| rTLatencyInd | boolean | 0..1 | Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. | RTLatency | +| protoDesc | ProtoDesc | 0..1 | Protocol description for PDU Set identification and end of Data burst indication in UPF | PDUSetHandling
PowerSaving | +| periodInfo | PeriodicityInfo | 0..1 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | PowerSaving | +| pdvMon | QosMonitoringInformation | 0..1 | Contains the Packet Delay Variation information for the subscribed report. It shall be present when the event "PACK_DELAY_VAR" is subscribed. | EnQoSMon | +| qosDuration | DurationSec | 0..1 | Contains the QoS duration to transfer data traffic transmission (e.g., AI/ML transmission). The minimum value of the QoS duration shall be 60 sec. | QoSTiming_5G | +| qosInactInt | DurationSec | 0..1 | Contains the QoS inactivity interval for the given data traffic transmission (e.g., AI/ML transmission). The minimum value of the QoS inactivity interval shall be 60 sec. | QoSTiming_5G | +| rttMon | QosMonitoringInform | 0..1 | Contains the round-trip delay over two | EnQoSMon | + +| | | | | | +|----------------|--------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | ation | | service data flow information for the subscribed report.
It shall be provided for "RT_DELAY_TWO_QOS_FLOWS" event. | | +| qosMonDatRate | QosMonitoringInformation | 0..1 | Contains the data rate measurements information for the subscribed report. It shall be present when the event "QOS_MONITORING" is subscribed and data rate measurements are required.
(NOTE 12) | EnQoSMonListUE_5G | +| avrgWndw | AverWindow | 0..1 | Averaging window for the calculation of the data rate for the service data flow. It may be present when the "qosMonDatRate" attribute is present. | XRM_5G | +| servAuthInfo | ServAuthInfo | 0..1 | Indicates the authorization result for the QoS monitoring request.
Supplied by the NEF. | EnQoSMon | +| qosMonConReq | QosMonitoringInformation | 0..1 | Contains the requirements of the congestion information (ECN marking percentage) monitoring and reporting. It shall be present when the event "QOS_MONITORING" is subscribed and congestion information measurements are required. | EnQoSMon | +| listUeConsDtRt | array(IpAddr) | 0..N | Identifies the list of UE addresses subject for Consolidated Data Rate monitoring.
(NOTE 12) | ListUE_5G | + +NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +NOTE 2: When the GMEC\_5G feature is not supported, one of "uelpv4Addr", "uelpv6Addr" or "macAddr" or "listUeAddrs" shall be included. If ipv4 or ipv6 address is provided, IP flow information shall be provided. If MAC address is provided and the AppId feature is not supported, Ethernet flow information (either "ethFlowInfo", or if the feature EnEthAsSessionQoS\_5G is supported, "enEthFlowInfo") shall be provided. If the AppId feature is supported, one of IP flow information, Ethernet flow information (if EthAsSessionQoS\_5G and/or EnEthAsSessionQoS\_5G is supported) or External Application Identifier shall be provided. + +NOTE 3: The property is only applicable for the NEF. + +NOTE 4: The attributes "altQoSReferences" and "altQoSReqs" are mutually exclusive. The attributes "qosReference" and "altQoSReqs" are also mutually exclusive. + +NOTE 5: The attributes "reqGbrDI", "reqGbrUI", "reqMbrDI", "reqMbrUI", "maxTscBurstSize", "req5Gsdelay", "reqPer" (if the ExtQoS\_5G feature is supported), and "priority" within the "tscQoSReq" attribute may be provided only if the "qosReference" attribute is not provided. + +NOTE 6: When the Ethernet flow information is provided and, the EthAsSessionQoS\_5G and EnEthAsSessionQoS\_5G features are supported, either the "ethFlowInfo" or the "enEthFlowInfo" shall be provided, but not both simultaneously. + +NOTE 7: The "tosTC" attribute of the "flowInfo" attribute may only be present if the "ToSTC\_5G" feature is supported. + +NOTE 8: The attributes "exterAppId", "flowInfo", "ethFlowInfo", "enEthFlowInfo", "qosReference", "altQoSReferences", "altQoSReqs", "tscQoSReq", "qosMonInfo" may be provided only if the "multiModDatFlows" attribute is not provided. + +NOTE 9: When the "ListUE\_5G" feature is supported, the "listUeAddrs" attribute shall be provided, and either "exterAppId" attribute or "flowInfo" attribute shall be provided. + +NOTE 10: When the GMEC\_5G feature is supported and the target UE(s) are not identified by UE address(es) ("uelpv4Addr", "uelpv6Addr", "macAddr", or "listUEAddrs"), the "extGroupId" attribute and the "gpsi" attribute are mutually exclusive. Either one of them shall be provided. If either the "gpsi" attribute or the "extGroupId" attribute are present, then neither the "uelpv4Addr" attribute, the "uelpv6Addr" attribute nor the "macAddr" attribute shall be included. + +NOTE 11: When the GMEC\_5G feature is supported, either the "exterAppId" attribute, "flowInfo" attribute or Ethernet flow information (either "ethFlowInfo" attribute or "enEthFlowInfo" attribute) shall be provided. + +NOTE 12: When the "ListUE\_5G" feature is supported and the "qosMonDatRate" attribute is provided, the "consDataRateThrDI" and "consDataRateThrUI" attributes contained in "qosMonDatRate" attribute indicate the upper bound of the aggregated DL/UL data rate and by default, are applicable to the list of UEs specified by the "listUeAddrs" attribute. If the "listUeConsDtRt" attribute is also provided, then it has to be the subset of "listUeAddrs" attribute. + +Editor's Note: It is FFS whether other IEs within the "tscQoSReq" attribute than "req5Gsdelay" attribute can apply for multi-modal communication services. + +Editor's Note: It is FFS whether the port number requires the transport protocol (like UDP, TCP) for completion or not. + +Editor's Note: Whether the rttMon attribute is needed or the qosMonInfo attribute can be used instead to convey both, packet delay and RTT measurements information requires further discussion. + +Editor's Note: Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +### 5.14.2.1.3 Type: AsSessionWithQoSSubscriptionPatch + +This type represents an AS session request with specific QoS for the service provided by the SCS/AS to the SCEF via T8 interface. The structure is used for PATCH request. + +**Table 5.14.2.1.3-1: Definition of type AsSessionWithQoSSubscriptionPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------------|-------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| exterAppId | string | 0..1 | Identifies the external Application Identifier. (NOTE 2) (NOTE 8) | AppId
ListUE_5G | +| flowInfo | array(FlowInfo) | 0..N | Describe the data flow which requires QoS. (NOTE 2)(NOTE 5) (NOTE 8) | | +| ethFlowInfo | array(EthFlowDescription) | 0..N | Describes Ethernet packet flows. (NOTE 2) | EthAsSessionQoS_5G | +| enEthFlowInfo | array(EthFlowInfo) | 0..N | Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow identifier and the corresponding UL and/or DL flows. (NOTE 2) | EnEthAsSessionQoS_5G | +| listUeAddrs | array(UeAddrInfo) | 0..N | Identifies the list of UE address(es). (NOTE 8) (NOTE 9) | ListUE_5G | +| qosReference | string | 0..1 | Pre-defined QoS reference. (NOTE 3) (NOTE 4) | | +| altQoSReferences | array(string) | 0..N | Identifiers an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | AlternativeQoS_5G | +| altQosReqs | array(AlternativeServiceRequirementsData) | 1..N | Identifies an ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 3) | AltQosWithinDParams_5G | +| disUeNotif | boolean | 0..1 | Indicates whether to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. The fulfilled situation is either the QoS profile or an Alternative QoS Profile.

- true: the QoS flow parameters signalling to the UE is disabled;
- false: the QoS flow parameters signalling to the UE is not disabled. | DisableUENotification_5G | +| usageThreshold | UsageThresholdRm | 0..1 | Time period and/or traffic volume in which the QoS is to be applied. | | +| qosMonInfo | QosMonitoringInformationRm | 0..1 | Qos Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | QoSMonitoring_5G | +| directNotifInd | boolean | 0..1 | Indicates whether the direct event notification is requested.

- true: the direct event notification is requested;
- false: the direct event notification is not requested. | ExposureToEAS | +| tscQosReq | TscQosRequirementRm | 0..1 | Contains the QoS requirements for time sensitive communication. (NOTE 4) | TSC_5G
MultiMedia | +| notificationDestination | Link | 0..1 | Contains the URL to receive the notification event(s) from the SCEF. | | +| events | array(UserPlaneEvent) | 0..N | Corresponds to the list of user plane event(s) to which the SCS/AS requests to subscribe to. | enNB | +| multiModDatFlows | map(AsSessionMediaComponentRm) | 0..N | Each element of the map represents Media Component data for a single-modal data flow(s) of a multi-modal service. The key of the map is the attribute "medCompN". (NOTE 6) | MultiMedia | +| l4sInfo | UplinkDownlinkSupport | 0..1 | Provides L4S support information. | L4S | +| pduSetQos | PduSetQosParaRm | 0..1 | Contains the PDU Set QoS Parameters which are used to support PDU Set based QoS handling. | PDUSetHandling | +| rTLatencyInd | boolean | 0..1 | Indicates the service data flow needs to | RTLatency | + +| | | | | | +|----------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| | | | meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. | | +| protoDesc | ProtoDesc | 0..1 | Protocol description for PDU Set identification and end of Data burst indication in UPF | PDUSetHandling
PowerSaving | +| periodInfo | PeriodicityInfo | 0..1 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | PowerSaving | +| pdvMon | QosMonitoringInformationRm | 0..1 | Packet Delay Variation information for the subscribed report. | EnQoSMon | +| qosDuration | DurationSecRm | 0..1 | Contains the QoS duration to transfer data transmission (e.g., AI/ML transmission). The minimum value of the QoS duration shall be 60 sec.. | QoSTiming_5G | +| qosInactInt | DurationSecRm | 0..1 | Contains the QoS inactivity interval for the given data transfer transmission (e.g., AI/ML transmission). The minimum value of the QoS inactivity interval shall be 60 sec. | QoSTiming_5G | +| rttMon | QosMonitoringInformationRm | 0..1 | Contains the round-trip delay over two QoS flows information for the subscribed report. It shall be provided for "RT_DELAY_TWO_QOS_FLOWS" event. | EnQoSMon | +| qosMonDatRate | QosMonitoringInformationRm | 0..1 | Contains the data rate measurements information for the subscribed report. It shall be present when the event "QOS_MONITORING" is subscribed and data rate measurements are modified. (NOTE 9) | EnQoSMon
ListUE_5G | +| avrgWndw | AverWindowRm | 0..1 | Averaging window for the calculation of the data rate for the service data flow. | XRM_5G | +| qosMonConReq | QosMonitoringInformationRm | 0..1 | Contains the requirements of the congestion information (ECN marking percentage) monitoring and reporting. It shall be present when the event "QOS_MONITORING" is subscribed and congestion information measurements are required. | EnQoSMon | +| listUeConsDtRt | array(IpAddr) | 0..N | Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. (NOTE 9) | ListUE_5G | + +NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +NOTE 2: One of "exterAppId", "flowInfo" or either "ethFlowInfo" or "enEthFlowInfo" may be provided. + +NOTE 3: The attributes "altQoSReferences" and "altQoSReqs" are mutually exclusive. The attributes "qosReference" and "altQoSReqs" are also mutually exclusive. + +NOTE 4: The attributes "reqGbrDI", "reqGbrUI", "reqMbrDI", "reqMbrUI", "maxTscBurstSize", "req5Gsgdelay", "reqPer" (if the ExtQoS\_5G feature is supported), and "priority" within the "tscQoSReq" attribute may be provided only if the "qosReference" attribute is not provided. + +NOTE 5: The "tosTC" attribute of the "flowInfo" attribute may only be present if the "ToSTC\_5G" feature is supported. + +NOTE 6: The attributes "exterAppId", "flowInfo", "ethFlowInfo", "enEthFlowInfo", "qosReference", "altQoSReferences", "altQoSReqs", "tscQoSReq", "qosMonInfo" may be provided only if the "multiModDatFlows" attribute is not provided. + +NOTE 8: When the "ListUE\_5G" feature is supported, the "listUeAddrs" attribute may be provided, and/or either "exterAppId" attribute or "flowInfo" attribute may be provided. + +NOTE 9: When the "ListUE\_5G" feature is supported and the "qosMonDatRate" attribute is provided, the "consDataRateThrDI" and "consDataRateThrUI" attributes contained in "qosMonDatRate" attribute indicate the upper bound of the aggregated DL/UL data rate and by default, are applicable to the list of UEs specified by the "listUeAddrs" attribute. If the "listUeConsDtRt" attribute is also provided, then it has to be the subset of "listUeAddrs" attribute. + +Editor's Note: It is FFS whether other IEs within the "tscQoSReq" attribute than "req5Gsgdelay" attribute can apply for multi-modal communication services. + +Editor's Note: Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +#### 5.14.2.1.4 Type: UserPlaneNotificationData + +This type represents the parameters which shall be notify the SCS/AS for user plane event(s). + +**Table 5.14.2.1.4-1: Definition of the UserPlaneNotificationData data type** + +| Attribute name | Data type | Cardinality | Description | +|----------------|------------------------------|-------------|-------------------------------------------------------------------------| +| transaction | Link | 1 | Link to the transaction resource to which this notification is related. | +| eventReports | array(UserPlaneEvent Report) | 1..N | Contains the reported event and applicable information | + +#### 5.14.2.1.5 Type: UserPlaneEventReport + +This type represents an event report for user plane. It shall comply with the provisions defined in table 5.14.2.1.5-1. + +**Table 5.14.2.1.5-1: Definition of the UserPlaneEventReport data type** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|-------------------|----------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| event | UserPlaneEvent | 1 | Indicates the event reported by the SCEF. | | +| accumulatedUsage | AccumulatedUsage | 0..1 | Contains the applicable information corresponding to the event. | | +| flowIds | array(integer) | 0..N | Identifies the affected flows that were sent during event subscription. It may be omitted when the reported event applies to all the flows sent during the subscription. (NOTE 2) | | +| multiModFlows | array(MultiModalFlows) | 0..N | Each element of the array identifies the flow filters for the multi-modal data flows that were sent during event subscription and that are affected by the reported event. It may be omitted when the reported event applies to all the multi-modal data flows sent during the subscription. (NOTE 2) | MultiMedia | +| appliedQosRef | string | 0..1 | The currently applied QoS reference (or applied individual QoS parameter set, if AltQosWithIndParams_5G is supported). Applicable for event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. When it is omitted and the "event" attribute is QOS_NOT_GUARANTEED, the event report indicates that the lowest priority alternative QoS profile could not be fulfilled either. | AlternativeQoS_5G, AltQosWithIndParams_5G | +| altQosNotSupplInd | boolean | 0..1 | It may be set to true when the "event" attribute is QOS_NOT_GUARANTEED to indicate that alternative service requirements are not supported by the access network. The default value false shall apply if the attribute is not present. | AltQoSProfiles SupportReport | +| plmnId | PlmnIdNid | 0..1 | PLMN Identifier or the SNPN Identifier. It may be present when the reported event is "PLMN_CHG" and which is allowed to be exposed to the AF based on the local policy or local configuration. | enNB_5G | +| qosMonReports | array(QosMonitoringReport) | 0..N | Contains the QoS Monitoring Reporting information. | QoSMonitoring_5G | +| pdvMonReports | array(PdvMonitoringReport) | 0..N | Contains the PDV Monitoring Reporting information. (NOTE 3) | EnQoSMon | +| ratType | RatType | 0..1 | RAT type may be present if applicable, when the notified event is "ACCESS_TYPE_CHANGE" and which is allowed to be exposed to the AF based on the local policy or local configuration. | enNB_5G | +| batOffsetInfo | BatOffsetInfo | 0..1 | The BAT offset and the optionally adjusted periodicity. | EnTSCAC | +| aggrDataRateRpts | array(QosMonitoringReport) | 0..1 | Contains QoS Monitoring for aggregated data rate reporting information. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. | ListUE_5G | +| rttMonReports | array(QosMonitoringReport) | 0..N | Round-Trip delay for the indicated UL and DL QoS flows. It shall be present when the notified event is "RT_DELAY_TWO_QOS_FLOWS". | EnQoSMon | +| qosMonDatRateReps | array(QosMonitoringReport) | 0..1 | Contains QoS Monitoring for data rate reporting information. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. | EnQoSMon | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| qosMonConInfoReports | array(QosMonitoringReport) | 0..N | Contains QoS Monitoring for congestion information (ECN marking percentage). It shall be present when the notified event is "QOS_MONITORING" and congestion measurements are available. | EnQoSMon | +| NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | +| NOTE 2: The attributes "flowIds" and "multiModFlows" are mutually exclusive. | | | | | +| NOTE 3: The PdvMonitoringReport API does not include the "flows" attribute in this API. | | | | | + +Editor's Note: Whether the rttMonReports attribute is needed or the qosMonReports attribute can be used instead to convey both, packet delay and RTT measurements reports requires further discussion. + +Editor's Note: If the pdvReport can include maximum and minimum UL delay variation and pdmf indication it is FFS whether the QosMonitoringReport can be used instead. + +5.14.2.1.6 Type: QosMonitoringInformation + +**Table 5.14.2.1.6-1: Definition of type QosMonitoringInformation** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|--------------------|----------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reqQosMonParams | array(RequestedQosMonitoringParameter) | 1..N | Indicates the QoS information to be measured, e.g. UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for packet delay is enabled for the service data flow. | | +| repFreqs | array(ReportingFrequency) | 1..N | Indicates the frequency for the reporting, such as event triggered and/or periodic. | | +| repThreshDL | UInteger | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for DL packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK". | | +| repThreshUL | UInteger | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for UL packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "UPLINK". | | +| repThreshRp | UInteger | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for round trip packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "ROUND_TRIP". | | +| conThreshDL | UInteger | 0..1 | Indicates the downlink threshold for congestion reporting, i.e. for the reporting of the received ECN marking percentage for DL. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0%. | EnQoSMon | +| conThreshUL | UInteger | 0..1 | Indicates the uplink threshold for the congestion reporting, i.e. for the reporting of the received ECN marking percentage for UL. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0%. | EnQoSMon | +| waitTime | DurationSec | 0..1 | Indicates the minimum waiting time between subsequent reports. It shall be present when the "repFreqs" attribute includes "EVENT_TRIGGERED". | | +| repPeriod | DurationSec | 0..1 | Indicates the time interval between successive reporting. It shall be present when the "repFreqs" attribute includes "PERIODIC".
If the feature "PacketDelayFailureReport" is supported, it also indicates the time interval at which a measurement failure needs to be reported if no measurement result is provided. It shall be present when the "repFreqs" attribute includes "PERIODIC" or "EVENT_TRIGGERED". | | +| repThreshDatRateDL | BitRate | 0..1 | Indicates the bit rate threshold for the DL. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK_DATA_RATE". | EnQoSMon | +| repThreshDatRateUL | BitRate | 0..1 | Indicates the bit rate threshold for the UL. It shall be present when the "reqQosMonParams" attribute includes "UPLINK_DATA_RATE". | EnQoSMon | +| consDataRateThrDL | BitRate | 0..1 | Indicates the Downlink Consolidated Data Rate Threshold. | ListUE_5G | + +| | | | | | +|-----------------------|---------|------|-----------------------------------------------------------|-----------| +| consDataRateThr
UI | BitRate | 0..1 | Indicates the Uplink Consolidated Data Rate
Threshold. | ListUE_5G | +|-----------------------|---------|------|-----------------------------------------------------------|-----------| + +Editor's Note: It is FFS whether the event reporting frequency applies for congestion (ECN marking percentage) information. + +#### 5.14.2.1.7 Type: QosMonitoringInformationRm + +This type represents a QoS Monitoring Information which is defined in clause 5.14.2.1.7 but defined with "nullable: true" property so it can be removed in "JSON Merge Patch", as defined in IETF RFC 7396 [39]. It shall comply with the provisions defined in table 5.14.2.1.7-1. + +Duration and volume are also removable in "JSON Merge Patch". + +**Table 5.14.2.1.7-1: Definition of type QosMonitoringInformationRm** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|--------------------|----------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reqQosMonParams | array(RequestedQosMonitoringParameter) | 0..N | Indicates the QoS information to be measured, e.g. UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for packet delay is enabled for the service data flow. | | +| repFreqs | array(ReportingFrequency) | 0..N | Indicates the frequency for the reporting, such as event triggered and/or periodic. | | +| repThreshDL | UIntegerRm | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for DL packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK". | | +| repThreshUL | UIntegerRm | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for UL packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "UPLINK". | | +| repThreshRp | UIntegerRm | 0..1 | Unsigned integer identifying a threshold in units of milliseconds for round trip packet delay for packet delay or packet delay variation measurement reports. It shall be present when the "reqQosMonParams" attribute includes "ROUND_TRIP". | | +| conThreshDL | UIntegerRm | 0..1 | Indicates the downlink threshold for congestion reporting, i.e. for the reporting of the received ECN marking percentage for DL. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0%. | EnQoSMon | +| conThreshUL | UIntegerRm | 0..1 | Indicates the uplink threshold for congestion reporting, i.e. for the reporting of the received ECN marking percentage for UL. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0%. | EnQoSMon | +| waitTime | DurationSecRm | 0..1 | Indicates the minimum waiting time between subsequent reports. It shall be present when the "repFreqs" attribute includes "EVENT_TRIGGERED". | | +| repPeriod | DurationSecRm | 0..1 | Indicates the time interval between successive reporting. It shall be present when the "repFreqs" attribute includes "PERIODIC".
If the feature "PacketDelayFailureReport" is supported, it also indicates the time interval at which a measurement failure needs to be reported if no measurement result is provided. It shall be present when the "repFreqs" attribute includes "PERIODIC" or "EVENT_TRIGGERED". | | +| repThreshDatRateDL | BitRateRm | 0..1 | Indicates the bit rate threshold for the DL. It shall be present when the "reqQosMonParams" attribute includes "DOWNLINK_DATA_RATE". | EnQoSMon | +| repThreshDatRateUL | BitRateRm | 0..1 | Indicates the bit rate threshold for the UL. It shall be present when the "reqQosMonParams" attribute includes "UPLINK_DATA_RATE". | EnQoSMon | +| consDataRateThrDL | BitRateRm | 0..1 | Indicates the Downlink Consolidated Data Rate Threshold. | ListUE_5G | + +| | | | | | +|-----------------------|-----------|------|--------------------------------------------------------|-----------| +| consDataRateThr
UI | BitRateRm | 0..1 | Indicates the Uplink Consolidated Data Rate Threshold. | ListUE_5G | +|-----------------------|-----------|------|--------------------------------------------------------|-----------| + +Editor's Note: It is FFS whether the event reporting frequency applies for congestion (ECN marking percentage) information. + +#### 5.14.2.1.8 Type: QosMonitoringReport + +**Table 5.14.2.1.8-1: Definition of type QosMonitoringReport** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-----------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| ulDelays | array(Uinteger) | 0..N | Uplink packet delay in units of milliseconds. (NOTE 1) | | +| dlDelays | array(Uinteger) | 0..N | Downlink packet delay in units of milliseconds. (NOTE 1) | | +| rtDelays | array(Uinteger) | 0..N | Round trip delay in units of milliseconds. (NOTE 1) | | +| pdmf | boolean | 0..1 | Packet delay measurement failure indicator. When set to true, it indicates that a packet delay failure has occurred. Default value is false if omitted. (NOTE 2) | PacketDelay FailureReport | +| ulDataRate | BitRate | 0..1 | UL data rate. (NOTE 3) | EnQoSMon | +| dlDataRate | BitRate | 0..1 | DL data rate. (NOTE 3) | EnQoSMon | +| ulAggrDataRate | BitRate | 0..1 | Indicates the uplink aggregated Data Rate for the applicable list of UEs provided by AF. | ListUE_5G | +| dlAggrDataRate | BitRate | 0..1 | Indicates the downlink aggregated Data Rate for the applicable list of UEs provided by AF. | ListUE_5G | +| ulConInfo | Uinteger | 0..1 | Uplink congestion information, i.e., percentage of ECN marked packets for the UL. | EnQoSMon | +| dlConInfo | Uinteger | 0..1 | Downlink congestion information, i.e., percentage of ECN marked packets for the DL. | EnQoSMon | +| cimf | boolean | 0..1 | Represents the congestion information measurement failure indicator. When set to "true", it indicates that a congestion information measurement failure has occurred. Default value is "false" if omitted. | EnQoSMon | + +NOTE 1: In this release of the specification the maximum number of elements in the array is 2. +NOTE 2: When the "pdmf" attribute is set to true, "ulDelays", "dlDelays" and "rtDelays" and when the feature "EnQoSMon" is supported, "ulDataRate" and "dlDataRate" shall not be present. +NOTE 3: When the "ulDataRate" and/or the "dlDataRate" attribute are included, the parameters related to packet delay and/or congestion information shall not be present. + +Editor's Note: The presence conditions of the parameters of QosMonitoringReport are to be consolidated/detailed once all the possible reports are specified. + +Editor's Note: Whether the maximum and minimum data rate measurements are reported for the data rates calculated during the waiting time is FFS. + +Editor's Note: It is FFS whether the "cimf" attribute is needed. + +Editor's Note: Whether the "ulCongInfo" and "dlCongInfo" attributes are single or plural is FFS. + +## 5.14.2.1.9 Type: TscQosRequirement + +**Table 5.14.2.1.9-1: Definition of type TscQosRequirement** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|------------------|----------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reqGbrDl | BitRate | 0..1 | Requested GBR in downlink. | | +| reqGbrUl | BitRate | 0..1 | Requested GBR in uplink. | | +| reqMbrDl | BitRate | 0..1 | Requested MBR in downlink. | | +| reqMbrUl | BitRate | 0..1 | Requested MBR in uplink. | | +| maxTscBurstSize | ExtMaxDataBurstVol | 0..1 | Maximum burst size of the TSC traffic in units of Bytes.
Minimum = 4096, Maximum = 2000000. | | +| req5Gsdelay | PacketDelBudget | 0..1 | Requested Delay of the TSC traffic. | | +| reqPer | PacketErrRate | 0..1 | Requested Packet Error Rate of the TSC traffic. | ExtQoS_5G | +| priority | TscPriorityLevel | 0..1 | Unsigned integer indicating the TSC traffic priority in relation to other TSC and non-TSC traffic. | | +| tscaiTimeDom | UInteger | 0..1 | Indicates the (g)PTP domain that the (TSN)AF is located in. | | +| tscaiInputUl | TscailInputContainer | 0..1 | Transports the input parameters for TSC traffic to construct the TSC Assistance Container in uplink direction.
(NOTE) | | +| tscaiInputDl | TscailInputContainer | 0..1 | Transports the input parameters for TSC traffic to construct the TSC Assistance Container in downlink direction.
(NOTE) | | +| capBatAdaptation | boolean | 0..1 | Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true".
The default value is "false" if omitted.
(NOTE) | EnTSCAC | + +NOTE: The "burstArrivalTimeWnd" attribute, within the "tscaiInputUl" and/or "tscaiInputDl" attributes, and the "capBatAdaptation" attribute are mutually exclusive. + +## 5.14.2.1.10 Type: TscQosRequirementRm + +**Table 5.14.2.1.10-1: Definition of type TscQosRequirementRm** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|------------------|----------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reqGbrDl | BitRateRm | 0..1 | Requested GBR in downlink. | | +| reqGbrUl | BitRateRm | 0..1 | Requested GBR in uplink. | | +| reqMbrDl | BitRateRm | 0..1 | Requested MBR in downlink. | | +| reqMbrUl | BitRateRm | 0..1 | Requested MBR in uplink. | | +| maxTscBurstSize | ExtMaxDataBurstVolRm | 0..1 | Maximum burst size of the TSC traffic in units of Bytes.
Minimum = 4096, Maximum = 2000000. | | +| req5Gsdelay | PacketDelBudgetRm | 0..1 | Requested Delay of the TSC traffic. | | +| reqPer | PacketErrRateRm | 0..1 | Requested Packet Error Rate of the TSC traffic. | ExtQoS_5G | +| priority | TscPriorityLevelRm | 0..1 | Unsigned integer indicating the TSC traffic priority in relation to other TSC and non-TSC traffic. | | +| tscaiTimeDom | UIntegerRm | 0..1 | Indicates the (g)PTP domain that the (TSN)AF is located in. | | +| tscaiInputUl | TscailInputContainer | 0..1 | Transports the input parameters for TSC traffic to construct the TSC Assistance Container in uplink direction.
(NOTE) | | +| tscaiInputDl | TscailInputContainer | 0..1 | Transports the input parameters for TSC traffic to construct the TSC Assistance Container in downlink direction.
(NOTE) | | +| capBatAdaptation | boolean | 0..1 | Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true".
The default value is "false" if omitted.
(NOTE) | EnTSCAC | + +NOTE: The "burstArrivalTimeWnd" attribute, within the "tscaiInputUl" and/or "tscaiInputDl" attributes, and the "capBatAdaptation" attribute are mutually exclusive. + +#### 5.14.2.1.11 Type AdditionalInfoAsSessionWithQos + +**Table 5.14.2.1.11-1: Definition of type AdditionalInfoAsSessionWithQos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acceptableServInfo | AcceptableServiceInfo | O | 0..1 | Describes information related to the acceptable service information, i.e., the maximum acceptable bandwidth for an AF session and/or for specific media components. | | + +#### 5.14.2.1.12 Type: ProblemDetailsAsSessionWithQos + +**Table 5.14.2.1.12-1: Definition of type ProblemDetailsAsSessionWithQos as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|--------------------------------|-------------|-------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Problem details as specified in clause 5.2.12.12 to include an error response | | +| AdditionalInfoAsSessionWithQos | 1 | Describes additional error information specific for this API. | | + +#### 5.14.2.1.13 Type AsSessionMediaComponent + +This type represents media component data for a single-modal data flow of a multi-modal service. It shall comply with the provisions defined in table 5.14.2.1.13-1. + +**Table 5.14.2.1.13-1: Definition of type AsSessionMediaComponent** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowInfos | array(FlowInfo) | 0..N | Contains the IP data flow(s) description for a single-modal data flow. | | +| qosReference | string | 0..1 | Identifies a pre-defined QoS information. | | +| altSerReqs | array(string) | 0..N | Ordered list of alternative service requirements that include a set of QoS references. The lower the index of the array for a given entry, the higher the priority.(NOTE) | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | 0..N | Ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE) | | +| disUeNotif | boolean | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| medCompN | integer | 1 | Identifies the media component number, and it contains the ordinal number of the media component. | | +| medType | MediaType | 0..1 | Indicates the media type of the service. | | +| marBwUI | BitRate | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRate | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tsnQos | TsnQoSContainer | 0..1 | Transports QoS parameters for TSC traffic. | | +| tscaiInputUI | TscaiInputContainer | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE (uplink flow direction). | | +| tscaiInputDI | TscaiInputContainer | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress of the NW-TT (downlink flow direction). | | +| rTLatencyReq | boolean | 0..1 | Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. | | +| pduSetQos | PduSetQosPara | 0..1 | PDU Set QoS parameters for XRM traffic. | | +| evSubsc | EventsSubscReqData | 0..1 | Identifies the events the application subscribes to at creation of a media component. (NOTE) | EnQoSMon | + +NOTE: If attribute "evSubsc" is present, one or more of the following IEs may be included: "events", "notifUri", "reqQosMonParams", "qosMon", "qosMonDatRate", "pdvReqMonParams", "pdvMon", "congestMon", "notifCorrelId", "afApplIds", "directNotifInd", "avrgWndw". In addition, when present the attribute "events", one or more of the following Enumeration "AfEvent" may be included: "QOS\_MONITORING", "PACK\_DEL\_VAR", "RT\_DELAY\_TWO\_QOS\_FLOWS". + +Editor's Note: the list of IEs of a AsSessionMediaComponent to complete the QoS parameters developed for the MediaComponent data defined in TS 29.514 and applicable to external AFs is FFS. + +Editor's Note: It is FFS whether the notifUri and notifCorreId attributes may be required for the evSubsc attribute. + +#### 5.14.2.1.14 Type AsSessionMediaComponentRm + +This type represents the AsSessionMediaComponent with the "nullable: true" property. It shall comply with the provisions defined in table 5.14.2.1.14-1 + +**Table 5.14.2.1.14-1: Definition of type AsSessionMediaComponentRm** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowInfos | array(FlowInfo) | 0..N | Contains the IP data flow(s) description for a single-modal data flow. | | +| qosReference | string | 0..1 | Identifies a pre-defined QoS information. | | +| altSerReqs | array(string) | 0..N | Ordered list of alternative service requirements that include a set of QoS references. The lower the index of the array for a given entry, the higher the priority.(NOTE) | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | 0..N | Ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE) | | +| disUeNotif | boolean | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| medCompN | integer | 1 | Identifies the media component number, and it contains the ordinal number of the media component. | | +| medType | MediaType | 0..1 | Indicates the media type of the service. | | +| marBwUI | BitRateRm | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRateRm | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRateRm | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRateRm | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tsnQos | TsnQoSContainerRm | 0..1 | Transports QoS parameters for TSC traffic. | | +| tscaiInputUI | TscailInputContainer | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE (uplink flow direction). | | +| tscaiInputDI | TscailInputContainer | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress of the NW-TT (downlink flow direction). | | +| rTLatencyReq | boolean | 0..1 | Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". | | +| pduSetQos | PduSetQosPara | 0..1 | PDU Set QoS parameters for XRM traffic. | | +| evSubsc | EventsSubscReqDataRm | 0..1 | Identifies the events the application subscribes to at creation of a media component. (NOTE) | EnQoSMon | +| NOTE: | If attribute "evSubsc" is present, one or more of the following IEs may be included: "events", "notifUri", "reqQosMonParams", "qosMon", "qosMonDatRate", "pdvReqMonParams", "pdvMon", "congestMon", "notifCorrelId", "afApplds", "directNotifInd", "avrgWndw". In addition, when present the attribute "events", one or more of the following Enumeration "AfEvent" may be included: "QOS_MONITORING", "PACK_DEL_VAR", "RT_DELAY_TWO_QOS_FLOWS". | | | | + +Editor's Note: It is FFS whether the notifUri and notifCorrelId attributes may be required for the evSubsc attribute. + +#### 5.14.2.1.15 Type: MultiModalFlows + +This type represents a flow information within a single-modal data flow. It shall comply with the provisions defined in table 5.14.2.1.15-1. + +**Table 5.14.2.1.15-1: Definition of the type MultiModalFlows** + +| Attribute name | Data type | Cardinality | Description | +|----------------|----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| medCompN | integer | 1 | It contains the ordinal number of the single-modal data flow. Identifies the single-modal data flow | +| flowIds | array(integer) | 0..N | Identifies the affected flows within the single-modal data flow (identified by the medCompN attribute). It may be omitted when all flows are affected. | + +#### 5.14.2.1.16 Type: UeAddrInfo + +This type represents UEs Address information. It shall comply with the provisions defined in table 5.14.2.1.16-1. + +**Table 5.14.2.1.16-1: Definition of the type UeAddrInfo** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|-----------|-------------|----------------------------------------------------------------------------------------------------------------|---------------| +| uelpAddr | lpAddr | 1 | Identifies the UE IP address. | | +| portNumber | Port | 0..1 | Indicates the UDP or TCP port number associated with the UE IP address as provided in the "uelpAddr" attribute | | + +### 5.14.2.2 Referenced simple data types and enumerations + +#### 5.14.2.2.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +#### 5.14.2.2.2 Simple data types + +The simple data types defined in table 5.14.2.2.2-1 shall be supported. + +**Table 5.14.2.2.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | + +#### 5.14.2.2.3 Enumeration: UserPlaneEvent + +The enumeration UserPlaneEvent represents the user plane event. + +**Table 5.14.2.2.3-1: Enumeration UserPlaneEvent** + +| Enumeration value | Description | Applicability (NOTE) | +|---------------------------------|------------------------------------------------------------------------------------|----------------------| +| SESSION_TERMINATION | Indicates that Rx session is terminated. | | +| LOSS_OF_BEARER | Indicates a loss of a bearer. (NOTE 3) | | +| RECOVERY_OF_BEARER | Indicates a recovery of a bearer. (NOTE 3) | | +| RELEASE_OF_BEARER | Indicates a release of a bearer. (NOTE 3) | | +| USAGE_REPORT | Indicates the usage report event. | | +| FAILED_RESOURCES_ALLOCATION | Indicates the resource allocation is failed. | | +| SUCCESSFUL_RESOURCES_ALLOCATION | Indicates the resource allocation is successful. | | +| QOS_GUARANTEED | The QoS targets of one or more SDFs are guaranteed again. | AlternativeQoS_5G | +| QOS_NOT_GUARANTEED | The QoS targets of one or more SDFs are not being guaranteed. | AlternativeQoS_5G | +| QOS_MONITORING | Indicates a QoS monitoring event. | QoSMonitoring_5G | +| ACCESS_TYPE_CHANGE | Indicates an Access type change. (NOTE 2) | enNB_5G | +| PLMN_CHG | Indicates a PLMN change. (NOTE 2) | enNB_5G | +| L4S_NOT_AVAILABLE | The ECN marking for L4S of one or more SDFs is not available. | L4S | +| L4S_AVAILABLE | The ECN marking for L4S of one or more SDFs is available again. | L4S | +| BAT_OFFSET_INFO | Indicates the network provided BAT offset and the optionally adjusted periodicity. | EnTSCAC | +| RT_DELAY_TWO_QOS_FLOWS | Indicates round-trip delay on UL and DL flows over two QoS flows. | EnQoSMon | +| PACK_DELAY_VAR | Indicates Packet Delay Variation is enabled for the SDF. | EnQoSMon | + +NOTE 1: Properties marked with a feature as defined in clause 5.14.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +NOTE 2: The exposure of such network information to the AF needs to be authorized based on the local policy or local configuration. + +NOTE 3: The "LOSS\_OF\_BEARER", RECOVERY\_OF\_BEARER, and RELEASE\_OF\_BEARER only apply to 4G. + +## 5.14.3 Resource structure + +### 5.14.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-as-session-with-qos/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-as-session-with-qos" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.14.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|------------------------------------------------------|-------------------------------------------|-------------|--------------------------------------------------------------------------| +| AS Session with Required QoS Subscriptions | /{scsAsId}/subscriptions | GET | Get all or queried subscription resources for a given SCS/AS. | +| | | POST | Create a new AS session. | +| Individual AS Session with Required QoS Subscription | /{scsAsId}/subscriptions/{subscriptionId} | GET | Read a subscription resource for a given SCS/AS and a subscription Id. | +| | | PUT | Modify a subscription resource for a given SCS/AS and a subscription Id. | +| | | PATCH | Modify a subscription resource for a given SCS/AS and a subscription Id. | +| | | DELETE | Delete a subscription resource for a given SCS/AS and a subscription Id. | + +## 5.14.3.2 Resource: AS Session with Required QoS subscriptions + +### 5.14.3.2.1 Introduction + +This resource allows the SCS/AS to read all active AS session with required QoS subscription resources, or create a new subscription resource for the SCS/AS. + +### 5.14.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-as-session-with-qos/v1/{scsAsId}/subscriptions + +This resource shall support the resource URI variables defined in table 5.14.3.2.2-1. + +**Table 5.14.3.2.2-1: Resource URI variables for resource "AS Session with Required QoS Subscriptions"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.14.3.2.3 Resource methods + +#### 5.14.3.2.3.1 GET + +The GET method allows to read all or queried active subscriptions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.14.3.2.3.1-1 and table 5.14.3.2.3.1-2. + +**Table 5.14.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | Applicability | +|-----------|------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ip-addrs | array(IpAddr) | 0..N | The IP address(es) of the requested UE(s). | enNB | +| ip-domain | string | 0..1 | The IPv4 address domain identifier.
The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. | enNB | +| mac-addrs | array(MacAddr48) | 0..N | The MAC address(es) of the requested UE(s). | enNB | + +NOTE: Either the "ip-addrs" parameter or the "mac-addrs" parameter may be provided at the same time. If multiple elements are provided in the array structure, then each element shall be treated as a separate query parameter. + +**Table 5.14.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-------------------------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(AsSessionWithQoSSubscription) | 0..N | 200 OK | The subscription information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.14.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.14.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.14.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.14.3.2.3.4 POST + +The POST method creates a new subscription resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource using that URI. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.14.3.2.3.4-1 and table 5.14.3.2.3.4-2. + +**Table 5.14.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 5.14.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|-------------------------------------------------------------------------------------------------------|--------------------------------|-------------|------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| | AsSessionWithQoSSubscription | 1 | Parameters to create a subscription for an AS session with required QoS for the service requirement. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | AsSessionWithQoSSubscription | 1 | 201 Created | The subscription was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| | ProblemDetailsAsSessionWithQoS | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 500 Internal Server Error | (NOTE 2) | +| NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.14.5.3. | | | | | + +**Table 5.14.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-as-session-with-qos/v1/{scsAsId}/subscriptions/{subscriptionId} | + +**Table 5.14.3.2.3.4-4: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +#### 5.14.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.14.3.3 Resource: Individual AS Session with Required QoS Subscription + +#### 5.14.3.3.1 Introduction + +This resource allows an SCS/AS to query, update and delete an AS session with required QoS subscription. + +#### 5.14.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-as-session-with-qos/v1/{scsAsId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.14.3.3.2-1. + +**Table 5.14.3.2.2-1: Resource URI variables for resource "Individual AS Session with Required QoS Subscription"** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS of type ScsAsId. | +| subscriptionId | string | Identifier of the subscription resource of type string. The subscriptionId corresponds to the stage 2 TLTRI. | + +### 5.14.3.3.3 Resource methods + +#### 5.14.3.3.3.1 GET + +The GET method allows to read a subscription resource. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.14.3.3.3.1-1 and table 5.14.3.3.3.1-2. + +**Table 5.14.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 5.14.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|------------------------------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | AsSessionWithQoSSubscription | 1 | 200 OK | The subscription information related to the resource URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.14.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.14.3.3.3.2 PUT + +The PUT method allows changing the service information of an active subscription. The properties "ueIpv4Addr" or "ueIpv6Addr" shall remain unchanged from previously provided value. + +This method shall support request and response data structures, and response codes, as specified in the table 5.14.3.3.3.2-1. + +**Table 5.14.3.3.3.2-1: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|--------------------------------|-------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AsSessionWithQoSSubscription | 1 | Set up AS session with required QoS. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | AsSessionWithQoSSubscription | 1 | 200 OK | The subscription was modified successfully.
The SCEF shall return an updated subscription in the response content. | +| | none | | 204 No Content | The subscription was updated successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | ProblemDetailsAsSessionWithQoS | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +NOTE 2: Failure cases are described in clause 5.14.5.3. + +**Table 5.14.3.3.3.2-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3.2-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3.2-4: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +## 5.14.3.3.3.3 PATCH + +The PATCH method allows to change the service information of an active subscription. + +This method shall support request and response data structures, and response codes, as specified in the table 5.14.3.3.3-1. + +**Table 5.14.3.3.3-1: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------------------------|-------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | AsSessionWithQoSSubscriptionPatch | 1 | Partial update of an AS session with required QoS. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | AsSessionWithQoSSubscription | 1 | 200 OK | The subscription was modified successfully.
The SCEF shall return an updated subscription in the response content. | +| | none | | 204 No Content | The subscription was modified successfully. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | ProblemDetailsAsSessionWithQoS | 0..1 | 403 Forbidden | (NOTE 2) | +| | ProblemDetails | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. +NOTE 2: Failure cases are described in clause 5.14.5.3. + +**Table 5.14.3.3.3-2: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3-3: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3-4: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +## 5.14.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +## 5.14.3.3.3.5 DELETE + +The DELETE method deletes the AsSessionWithQoSSubscription resource and terminates the related subscription. The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.14.3.3.3.5-1 and table 5.14.3.3.3.5-2. + +**Table 5.14.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 5.14.3.3.3.5-2: Data structures supported by the DELETE request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------------|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The subscription was terminated successfully.
The response body shall be empty. | +| | UserPlaneNotificationData | 1 | 200 OK | The subscription was terminated successfully. The user plane notification data shall be included in the response. | +| | none | | 307 Temporary Redirect | Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. + +**Table 5.14.3.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.14.3.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +### 5.14.3.4 Void + +## 5.14.3A Notifications + +### 5.14.3A.1 General + +The notifications provided by the AsSessionWithQoS API are specified in this clause. + +**Table 5.14.3A-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|--------------------------------------------------------------| +| Event Notification | {notificationUri} | POST | Notify the bearer level event(s) from the SCEF to the SCS/AS | + +### 5.14.3A.2 Event Notification + +#### 5.14.3A.2.1 Description + +The Event Notification allows the SCEF to notify the SCS/AS of the bearer level event(s). + +#### 5.14.3A.2.2 Target URI + +The Callback URI "{notificationUri}" shall be used with the callback URI variables defined in table 5.14.3A.2.2-1. + +**Table 5.14.3A.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationUri | Link | Reference provided by the SCS/AS when the SCS/AS requests to sponsor the traffic from the beginning or to become the chargeable party at a later point.
This URI shall be provided within the "notificationDestination" attribute in the AsSessionWithQoSSubscription type. | + +#### 5.14.3A.2.3 Standard Methods + +##### 5.14.3A.2.3.1 Notification via POST + +The POST method allows to notify SCS/AS of the bearer level event(s) by the SCEF and the SCS/AS shall respond to the message. + +This method shall support the request data structures specified in table 5.14.3A.2.3.1-1 and the response data structures and response codes specified in table 5.14.3A.2.3.1-2. + +**Table 5.14.3A.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | Cardinality | Description | +|---------------------------|-------------|--------------------------------------------------| +| UserPlaneNotificationData | 1 | Representation of the bearer level notification. | + +**Table 5.14.3A.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | Cardinality | Response codes | Description | +|-----------|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| none | | 204 No Content | This case represents a successful notification of bearer level event(s). | +| none | | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.14.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.14.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +#### 5.14.3A.2.3.2 Notification via Websocket + +If supported by both SCS/AS and SCEF and successfully negotiated, the UserPlaneNotificationData may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4. + +### 5.14.4 Used Features + +The table below defines the features applicable to the AsSessionWithQoS API. Those features are negotiated as described in subclause 5.2.7. + +**Table 5.14.4-1: Features used by AsSessionWithQoS API** + +| Feature Number | Feature | Description | +|----------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event feature is also supported. | +| 2 | Notification_test_event | The testing of notifications connections is supported according to clause 5.2.5.3. | +| 3 | EthAsSessionQoS_5G | Setting up required QoS for Ethernet UE. This feature may only be supported in 5G. | +| 4 | MacAddressRange_5G | Indicates the support of a set of MAC addresses with a specific range in the traffic filter. This feature may only be supported in 5G. | +| 5 | AlternativeQoS_5G | Indicates the support of alternative QoS requirements and the QoS notification (i.e. whether the QoS targets for SDF(s) are not guaranteed or guaranteed again). This feature may only be supported in 5G. | +| 6 | QoSMonitoring_5G | Indicates the support of QoS Monitoring functionality and the report for packet delay monitoring. This feature may only be supported in 5G. | +| 7 | DisableUENotification_5G | Indicates the support of disabling QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. This feature may only be supported in 5G. This feature requires that the AlternativeQoS_5G feature is also supported. | +| 8 | TSC_5G | Indicates the support of Time Sensitive Communication. This feature may only be supported in 5G. | +| 9 | AppId | Indicates the support of dynamically providing the Application Identifier via the API. | +| 10 | ExposureToEAS | This feature indicates the support of direct notification in 5GC. This feature requires that the QoSMonitoring_5G feature is also supported. | +| 11 | enNB | Indicates the support of enhancements to the northbound interfaces. | +| 12 | AltQosWithIndParams_5G | This feature indicates the support of provisioning Alternative Service Requirements with individual QoS parameters. This feature requires that the AlternativeQoS_5G feature is also supported. | +| 13 | EnEthAsSessionQoS_5G | Indicates the support of required QoS for Ethernet UE, allowing to indicate separately different UL and/or DL Ethernet flows. This feature may only be supported in 5G. | +| 14 | enNB_5G | Indicates the support of enhancements to the northbound interfaces and only applicable to 5G. | +| 15 | PacketDelayFailureReport | Indicates the support of packet delay failure report as part of QoS Monitoring procedures. This feature requires that QoSMonitoring_5G is supported. This feature may only be supported in 5G. | +| 16 | ToSTC_5G | Indicates the support of Type of Service or Traffic Class. This feature may only be supported in 5G. | +| 17 | EnTSCAC | Indicates the support of extensions to TSCAC and the RAN feedback for BAT offset and adjusted periodicity. This feature may only be supported in 5G, and requires that the TSC_5G feature is also supported. | +| 18 | AltQoSProfilesSupportReport | This feature indicates the support of the report of whether Alternative QoS parameters are supported by the access network. This feature requires that AlternativeQoS_5G and/or AltQosWithIndParams_5G features are also supported. | +| 19 | ExtQoS_5G | This feature indicates the support of extended QoS parameters. This feature may only be supported in 5G. | +| 20 | MultiMedia | Indicates the support for multi-modal or multimedia flows for single UE and multiple UE. This feature may only be supported in 5G. This feature may be used in eXtend Reality (XR) use cases. | +| 21 | ExtErrors | Indicates the support of additional application errors related to authorization or PDU Session availability. | +| 22 | QoSTiming_5G | This feature indicates the support of QoS timing information for the transfer and support of data transmission (e.g., AI/ML transmission). This feature may only be supported in 5G. | +| 23 | ListUE_5G | Indicates the support for the list of UEs This feature may only be supported in 5G. | + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | GMEC_5G |

This feature indicates the support of Generic Group Management Exposure and Communication related enhancements.

The following functionalities are supported:

  • - Support AF requested QoS for a UE or group of UE(s) not identified by the UE address.

This feature may only be supported in 5G.

| +| 25 | PDUSetHandling |

This feature indicates the support of PDU Set handling. This feature may be used for eXtended Reality (XR) and interactive media services.

This feature may only be supported in 5G.

| +| 26 | RTLatency |

This feature indicates the support of Round-Trip latency. This feature may be used for eXtended Reality (XR) and interactive media services.

This feature may only be supported in 5G.

| +| 27 | EnQoSMon |

This feature indicates the support of enhanced QoS monitoring functionality, i.e. the report of the congestion information, and/or, the RTT delay over two QoS flows, and/or, the data rate information, and/or, the Packet Delay Variation monitoring.

This feature may only be supported in 5G

| +| 28 | PowerSaving |

This feature indicates the support of the Power Saving for different traffic measurement.

This feature may only be supported in 5G.

| +| 29 | L4S |

This feature indicates the support of the AF indication of ECN marking for L4S support.

This feature may only be supported in 5G.

| +|

Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification".
Description: A clear textual description of the feature.

| | | + +Editor's Note: Whether and/how to indicate the support of end of burst indication, and provision the flow periodicity information within the Power Saving feature is FFS. + +## 5.14.5 Error handling + +### 5.14.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.14.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the AsSessionWithQoS API. + +### 5.14.5.3 Application Errors + +The application errors defined for AsSessionWithQoS API are listed in table 5.14.5.3-1. + +**Table 5.14.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| REQUESTED_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is rejected. | ExtErrors | +| REQUESTED_SERVICE_TEMPORARILY_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is temporarily rejected. | ExtErrors | +| UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY | 403 Forbidden | The request for sponsored data connectivity is not authorized. | ExtErrors | +| PDU_SESSION_NOT_AVAILABLE | 500 Internal Server Error | The PDU session is not found for the provided UE address. | ExtErrors | +| INVALID_SESSION_UPDATE | 403 Forbidden | Indicates that the session is not allowed to be updated since one or more of the received parameters can not be served in current session. The AF can retry with a new session. | TSC_5G | + +## 5.15 MsisdnLessMoSms API + +### 5.15.1 Overview + +The MsisdnLessMoSms API allows the delivery of MSISDN-less mobile originated SMSs from the SCEF to the SCS/AS. The corresponding JSON schema for the representation of the resources and operations defined by the MsisdnLessMoSms API is provided in its complete form in Annex A.15. + +### 5.15.2 Data model + +#### 5.15.2.1 Notification data types + +##### 5.15.2.1.1 Introduction + +This clause defines data structures to be used in notifications. + +Table 5.15.2.1.1-1 specifies data types re-used by the MsisdnLessMoSms API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the MsisdnLessMoSms API. + +**Table 5.15.2.1.1-1: MsisdnLessMoSms API re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|-----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.15.4-1. | + +Table 5.15.2.1.1-2 specifies the data types defined for the MsisdnLessMoSms API. + +**Table 5.15.2.1.1-2: MsisdnLessMoSms API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------------------|----------------|----------------------------------------------------------|---------------| +| MsisdnLessMoSmsNotification | 5.15.2.1.2 | Represents a MSISDN-less MO SMS notification. | | +| MsisdnLessMoSmsNotificationReply | 5.15.2.1.3 | Represents a reply to a MSISDN-less MO SMS notification. | | + +##### 5.15.2.1.2 Type: MsisdnLessMoSmsNotification + +This data type represents a MSISDN-less MO SMS, which is sent from the SCEF to the SCS/AS. + +**Table 5.15.2.1.2-1: Definition of type MsisdnLessMoSmsNotification** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| supportedFeatures | SupportedFeatures | 1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. | | +| sms | Bytes | 1 | The MSISDN-less MO SMS containing a short message transfer protocol data unit (TPDU) which is defined in 3GPP TS 23.040 [43] and represents the user data field carried by the short message service relay sub-layer protocol. | | +| externalId | string | 1 | External identifier has the form username@realm. | | +| applicationPort | Port | 1 | Unsigned integer used to uniquely identify the triggering application addressed in the device, see clause 9.2.3.24.4 in TS 23.040 [43] for further details. | | +| NOTE: Properties marked with a feature as defined in clause 5.15.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +#### 5.15.2.1.3 Type: MsisdnLessMoSmsNotificationReply + +This data type represents a reply to an MSISDN-less MO SMS notification and is sent from the SCS/AS to the SCEF. + +**Table 5.15.2.1.3-1: Definition of type MsisdnLessMoSmsNotificationReply** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|-------------|--------------------------------------------------------------------------------------------|----------------------| +| supportedFeatures | SupportedFeatures | 1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. | | +| NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. | | | | | + +### 5.15.3 Resource structure + +#### 5.15.3.1 General + +All resource URIs of this API should have the following root: + +**{notificationDestination}** + +"{notificationDestination}" is determined based on preconfigured information in the SCEF as described in clause 4.4.14.2. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.15.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|---------------------------------|---------------------------|-------------|-------------------------------------------------------------------| +| MSISDN-less MO SMS Notification | {notificationDestination} | POST | Deliver a received MSISDN-less MO SMS from the SCEF to the SCS/AS | + +#### 5.15.3.2 MSISDN-less MO SMS Notification + +##### 5.15.3.2.1 Introduction + +The MSISDN-less MO SMS Notification allows the SCEF to deliver a received MSISDN-less MO SMS to the SCS/AS. + +### 5.15.3.2.2 Resource definition + +The Callback URI: {notificationDestination} shall support the callback URI variables defined in table 5.15.3.2.2-1. + +**Table 5.15.3.2.2-1: Callback URI variables for resource "MSISDN-less MO SMS Notification"** + +| Name | Data type | Definition | +|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationDestination | Link | A URI indicating the notification destination where T8 notification requests shall be delivered to.
This URI shall be preconfigured in the SCEF. | + +### 5.15.3.2.3 Standard methods + +#### 5.15.3.2.3.1 Notification via POST + +The HTTP POST method delivers a received MSISDN-less MO SMS. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.15.3.2.3.1-1 and table 5.15.3.2.3.1-2. + +**Table 5.15.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.15.3.2.3.1-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|-----------------------------------------------------------------------------------------------------|----------------------------------|-------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | MsisdnLessMoSmsNotification | 1 | The MSISDN-less MO SMS. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | MsisdnLessMoSmsNotificationReply | | 200 OK | The MSISDN-less MO SMS is received successfully. | +| | none | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| | none | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent.
Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.15.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +**Table 5.15.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. | + +## 5.15.4 Used Features + +The table below defines the features applicable to the MsisdnLessMoSms API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.15.4-1: Features used by MsisdnLessMoSms API** + +| Feature Number | Feature | Description | +|----------------|--------------------------------------------------------------------------------------------|----------------------------------------------------------| +| Feature: | A short name that can be used to refer to the bit and to the feature, e.g. "Notification". | Description: A clear textual description of the feature. | + +## 5.15.5 Error handling + +### 5.15.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.15.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the MsisdnLessMoSms API. + +### 5.15.5.3 Application Errors + +The application errors defined for MsisdnLessMoSms API are listed in table 5.15.5.3-1. + +**Table 5.15.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 5.16 RacsParameterProvisioning API + +### 5.16.1 Overview + +The RacsParameterProvisioning API is a RESTful API that allows the SCS/AS to provision manufacturer specific UE radio capability parameters. The RacsParameterProvisioning API defines a set of data models, resources and the related procedures for the creation and management of the parameters. The corresponding JSON schema for the representation of the resources and operations defined by the RacsParameterProvisioning API is provided in its complete form in Annex A.16. + +## 5.16.2 Data model + +### 5.16.2.1 Resource data types + +#### 5.16.2.1.1 Introduction + +This clause defines data structures to be used in resource representations. + +Table 5.16.2.1.1-1 specifies data types re-used by the RacsParameterProvisioning API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the RacsParameterProvisioning API. + +**Table 5.16.2.1.1-1: RacsParameterProvisioning API re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|---------------------|-----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [45] | Used to negotiate the applicability of the optional features defined in table 5.16.4-1. | +| TypeAllocationCode | 3GPP TS 29.571 [45] | Used to signal UE model's IMEI-TAC values in table 5.16.2.1.4-1. | + +Table 5.16.2.1.1-2 specifies the data types defined for the RacsParameterProvisioning API. + +**Table 5.16.2.1.1-2: RacsParameterProvisioning API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------|----------------|------------------------------------------------------------------------------------------------|---------------| +| RacsConfiguration | 5.16.2.1.4 | Represents a single UE radio capability configuration data. | | +| RacsConfigurationRm | 5.16.2.1.6 | Represents the same as the RacsConfiguration data type but with the "nullable: true" property. | | +| RacsFailureCode | 5.16.2.2.3 | Represents the failure result of UE radio capability provisioning. | | +| RacsFailureReport | 5.16.2.1.3 | Represents a radio capability data provisioning failure report. | | +| RacsProvisioningData | 5.16.2.1.2 | Represents a UE's radio capability data. | | +| RacsProvisioningDataPatch | 5.16.2.1.5 | Represents parameters to request the modification of a UE's radio capability data. | | + +#### 5.16.2.1.2 Type: RacsProvisioningData + +This type represents a UE radio capability data provided by the SCS/AS to the SCEF. + +**Table 5.16.2.1.2-1: Definition of type RacsProvisioningData** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|-------------------|------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| self | Link | 0..1 | Link to the resource "Individual RACS parameter provisioning". This parameter shall be supplied by the SCEF in HTTP responses. | | +| supportedFeatures | SupportedFeatures | 0..1 | Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| racsConfigs | map(RacsConfiguration) | 1..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. The response shall include successfully provisioned RACS data. | | +| racsReports | map(RacsFailureReport) | 0..N | Supplied by the SCEF. Contains the RACS IDs for which the RACS data are not provisioned successfully. Any string value can be used as a key of the map. | | + +NOTE: Properties marked with a feature as defined in clause 5.16.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.16.2.1.3 Type: RacsFailureReport + +This type represents a radio capability data provisioning report provided by the SCEF. + +**Table 5.16.2.1.3-1: Definition of type RacsFailureReport** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------|-----------------|-------------|-------------------------------------------------------------------------------------|----------------------| +| racsIds | array(string) | 1..N | Identifies the RACS ID(s) for which the RACS data are not provisioned successfully. | | +| failureCode | RacsFailureCode | 1 | It indicates the failure reason. | | + +NOTE: Properties marked with a feature as defined in clause 5.16.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.16.2.1.4 Type: RacsConfiguration + +This type represents a single UE radio capability configuration data provided by the SCS/AS to the SCEF. + +**Table 5.16.2.1.4-1: Definition of type RacsConfiguration** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE 1) | +|----------------|---------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| racsId | string | 1 | The UE radio capability ID provided by the SCS/AS to identify the UE radio capability data. See 3GPP TS 23.003 [14] for the encoding. (NOTE 3) | | +| racsParamEps | string | 0..1 | The UE radio capability data in EPS, its encoding shall comply with the UE-CapabilityRAT-ContainerList as defined in clause 6.3.6 of 3GPP TS 36.331 [59]. (NOTE 2, NOTE 4) | | +| racsParam5Gs | string | 0..1 | The UE radio capability data in 5GS, its encoding shall comply with the UE-CapabilityRAT-ContainerList as defined in clause 6.3.3 of 3GPP TS 38.331 [60]. (NOTE 2, NOTE 4) | | +| imeiTacs | array(TypeAllocationCode) | 1..N | Related UE model's IMEI-TAC values | | + +NOTE 1: Properties marked with a feature as defined in clause 5.16.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. +NOTE 2: At least one of racsParamEps or racsParam5Gs shall be provided. +NOTE 3: A racsId shall only belong to one "Individual RACS Parameter Provisioning" resource. +NOTE 4: UTRAN capabilities shall not be included within the "racsParamEps" attribute and/or the "racsParam5Gs" attribute. + +#### 5.16.2.1.5 Type: RacsProvisioningDataPatch + +This type represents a UE radio capability data provided by the SCS/AS to the SCEF. This structure is used in the PATCH request. + +**Table 5.16.2.1.5-1: Definition of type RacsProvisioningDataPatch** + +| Attribute name | Data type | Cardinality | Description | Applicability (NOTE) | +|----------------|--------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| racsConfigs | map(RacsConfigurationRm) | 0..N | Identifies the configuration related to manufacturer specific UE radio capability. Each element uniquely identifies an RACS configuration for an RACS ID and is identified in the map via the RACS ID as key. | | + +NOTE: Properties marked with a feature as defined in clause 5.16.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. + +#### 5.16.2.1.6 Type: RacsConfigurationRm + +This type represents a single UE radio capability configuration data provided by the SCS/AS to the SCEF. It is defined with "nullable: true" property. + +**Table 5.16.2.1.6-1: Definition of type RacsConfigurationRm** + +| Attribute name | Data type | Cardinality | Description | Applicability | +|----------------|---------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| racsParamEps | string | 0..1 | The UE radio capability data in EPS, its encoding shall comply with the UE-CapabilityRAT-ContainerList as defined in clause 6.3.6 of 3GPP TS 36.331 [59]. | | +| racsParam5Gs | string | 0..1 | The UE radio capability data in 5GS, its encoding shall comply with the UE-CapabilityRAT-ContainerList as defined in clause 6.3.3 of 3GPP TS 38.331 [60]. | | +| imeiTacs | array(TypeAllocationCode) | 0..N | Related UE model's IMEI-TAC values. | | + +## 5.16.2.2 Referenced simple data types and enumerations + +### 5.16.2.2.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced. + +### 5.16.2.2.2 Simple data types + +The simple data types defined in table 5.16.2.2.2-1 shall be supported. + +**Table 5.16.2.2.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | + +### 5.16.2.2.3 Enumeration: RacsFailureCode + +The enumeration RacsFailureCode represents the failure result of UE radio capability provisioning. + +**Table 5.16.2.2.3-1: Enumeration RacsFailureCode** + +| Enumeration value | Description | Applicability | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| MALFUNCTION | This value indicates that something functions wrongly in RACS provisioning or the RACS provisioning does not function at all. | | +| RESOURCE_LIMITATION | This value indicates there is resource limitation for RACS data storage. | | +| RACS_ID_DUPLICATED | The received RACS identifier(s) are already provisioned. | | +| OTHER_REASON | Other reason unspecified. | | + +## 5.16.3 Resource structure + +### 5.16.3.1 General + +All resource URIs of this API should have the following root: + +**{apiRoot}/3gpp-racs-pp/v1** + +"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-racs-pp" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI. + +The following resources and HTTP methods are supported for this API: + +**Table 5.16.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Meaning | +|----------------------------------------|--------------------------------------------|-------------|------------------------------------------------------------------| +| RACS Parameter Provisionings | //{scsAsId}/provisionings | GET | Read all RACS parameter provisionings for a given AF | +| | | POST | Create a new RACS parameter provisioning | +| Individual RACS Parameter Provisioning | //{scsAsId}/provisionings/{provisioningId} | PUT | Modify all properties in an existing RACS parameter provisioning | + +| | | | | +|--|--|--------|-------------------------------------------------------------------| +| | | PATCH | Modify some properties in an existing RACS parameter provisioning | +| | | GET | Read an existing RACS parameter provisioning | +| | | DELETE | Delete a RACS parameter provisioning | + +## 5.16.3.2 Resource: RACS Parameter Provisionings + +### 5.16.3.2.1 Introduction + +This resource allows an SCS/AS to read all active RACS parameter provisionings or create a new RACS parameter provisioning. + +### 5.16.3.2.2 Resource definition + +Resource URI: {apiRoot}/3gpp-racs-pp/v1/{scsAsId}/provisionings + +This resource shall support the resource URI variables defined in table 5.16.3.2.2-1. + +**Table 5.16.3.2.2-1: Resource URI variables for resource "Parameter Provisioning"** + +| Name | Data type | Definition | +|---------|-----------|---------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS. | + +### 5.16.3.2.3 Resource methods + +#### 5.16.3.2.3.1 GET + +The GET method allows to read all active RACS parameter provisionings indicated by the resource URI as defined in clause 5.16.3.2.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.2.3.1-1 and table 5.16.3.2.3.1-2. + +**Table 5.16.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.16.3.2.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------------------------|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | array(RacsProvisioningData) | 0..N | 200 OK | The provisioning information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +| | | | | | +|--|------|--|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | none | | 308
Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +|--|------|--|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.16.3.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.16.3.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.16.3.2.3.2 PUT + +This HTTP method is not supported for the resource. + +#### 5.16.3.2.3.3 PATCH + +This HTTP method is not supported for the resource. + +#### 5.16.3.2.3.4 POST + +The POST method creates a new parameter provisioning resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.2.3.4-1 and table 5.16.3.2.3.4-2. + +**Table 5.16.3.2.3.4-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.16.3.2.3.4-2: Data structures supported by the POST request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|--------------------------|-------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| | RacsProvisioningData | 1 | Parameters to create a new provisioning. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | RacsProvisioningData | 1 | 201 Created | The provisioning was created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| | array(RacsFailureReport) | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | +| | | | | | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. + +**Table 5.16.3.2.3.4-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/3gpp-racs-pp/v1/{scsAsId}/provisionings/{provisioningId} | + +#### 5.16.3.2.3.5 DELETE + +This HTTP method is not supported for the resource. + +### 5.16.3.3 Resource: Individual RACS Parameter Provisioning + +#### 5.16.3.3.1 Introduction + +This resource allows an SCS/AS to query, update and delete a parameter provisioning indicated by the resource URI as defined in clause 5.16.3.3.2. + +#### 5.16.3.3.2 Resource definition + +Resource URI: {apiRoot}/3gpp-racs-pp/v1/{scsAsId}/provisionings/{provisioningId} + +This resource shall support the resource URI variables defined in table 5.16.3.3.2-1. + +**Table 5.16.3.2.2-1: Resource URI variables for resource "Individual RACS Parameter Provisioning"** + +| Name | Data type | Definition | +|----------------|-----------|---------------------------------------------------------| +| apiRoot | string | See clause 5.2.4. | +| scsAsId | string | Identifier of the SCS/AS of type ScsAsId. | +| provisioningId | string | Identifier of the provisioning resource of type string. | + +#### 5.16.3.3.3 Resource methods + +##### 5.16.3.3.3.1 GET + +The GET method allows to read an active parameter provisioning indicated by the resource URI as defined in clause 5.16.3.3.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.3.3.1-1 and table 5.16.3.3.3.1-2. + +**Table 5.16.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 5.16.3.3.3.1-2: Data structures supported by the GET request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|----------------|---------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | | | | | + +| | | | | | +|--|----------------------|---|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | RacsProvisioningData | 1 | 200 OK | The provisioning information related to the request URI is returned. | +| | none | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| | none | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. + +**Table 5.16.3.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.16.3.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.16.3.3.3.2 PATCH + +The PATCH method shall be used to update some properties in an existing provisioning indicated by the Resource URI as defined in clause 5.16.3.3.2. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.3.3.2-1 and table 5.16.3.3.3.2-2. + +**Table 5.16.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.16.3.3.3.2-2: Data structures supported by the PATCH request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|---------------------------|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| | Data type | Cardinality | Response codes | Remarks | +| Response body | RacsProvisioningDataPatch | 1 | | Partial update an existing parameter provisioning. | +| | RacsProvisioningData | 1 | 200 OK | The provisioning data was updated successfully. The SCEF shall return an updated provisioning information in the response. | +| | none | | 204 No Content | The provisioning data was updated successfully, and no content is to be sent in the response message body. | + +| | | | | +|--------------------------|------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(RacsFailureReport) | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. + +**Table 5.16.3.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.16.3.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.16.3.3.3.3 PUT + +The PUT method shall be used to update all properties in an existing provisioning indicated by the Resource URI as defined in clause 5.16.3.3.2. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.3.3.1 and table 5.16.3.3.3.2. + +**Table 5.16.3.3.3.1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | Cardinality | Remarks | +|----------------|-----------|-------------|---------| +| none specified | | | | + +**Table 5.16.3.3.3.2: Data structures supported by the PUT request/response by the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|----------------------|-------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| | RacsProvisioningData | 1 | Replace an existing parameter provisioning. | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | RacsProvisioningData | 1 | 200 OK | The provisioning data was replaced successfully. The SCEF shall return an updated provisioning information in the response. | +| | none | | 204 No Content | The existing RACS Parameter Provisioning has been replaced successfully and no content is to be sent in the response message body. | + +| | | | | +|---------------------------|------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(RacsFailureReport ) | 1..N | 500 Internal Server Error | The RACS data for all RACS IDs were not provisioned successfully. | +| none | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | +| none | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. + +**Table 5.16.3.3.3.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.16.3.3.3.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +#### 5.16.3.3.3.4 POST + +This HTTP method is not supported for the resource. + +#### 5.16.3.3.3.5 DELETE + +The DELETE method deletes an existing provisioning resource "Individual RACS Parameter Provisioning". The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.16.3.3.3.5-1 and table 5.16.3.3.3.5-2. + +**Table 5.16.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| N/A | | | | + +**Table 5.16.3.3.3.5-2: Data structures supported by the DELETE request/response on the resource** + +| Request body | Data type | Cardinality | Remarks | | +|---------------|-----------|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| | none | | | | +| Response body | Data type | Cardinality | Response codes | Remarks | +| | none | | 204 No Content | The provisioning was terminated successfully. The response body shall be empty. | +| | none | | 307 Temporary | Temporary redirection, during resource termination. The response shall include a Location header field | + +| | | | | | +|-------------------------------------------------------------------------------------------------------|------|--|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | Redirect | containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| | none | | 308
Permanent Redirect | Permanent redirection, during resource termination.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF.
Redirection handling is described in clause 5.2.10. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. | | | | | + +**Table 5.16.3.3.5-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +**Table 5.16.3.3.5-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SCEF. | + +## 5.16.4 Used Features + +The table below defines the features applicable to the RacsParameterProvisioning API. Those features are negotiated as described in clause 5.2.7. + +**Table 5.16.4-1: Features used by RacsParameterProvisioning API** + +| Feature Number | Feature | Description | +|----------------|--------------------------------------------------------------------------------------------|----------------------------------------------------------| +| Feature: | A short name that can be used to refer to the bit and to the feature, e.g. "Notification". | Description: A clear textual description of the feature. | + +## 5.16.5 Error handling + +### 5.16.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.6. + +In addition, the requirements in the following clauses shall apply. + +### 5.16.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the RacsParameterProvisioning API. + +### 5.16.5.3 Application Errors + +The application errors defined for the RacsParameterProvisioning API are listed in table 5.16.5.3-1. + +**Table 5.16.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6 Security + +TLS shall be used to support the security communication between the SCEF and the SCS/AS over T8 as defined in clause 5.5 of 3GPP TS 33.187 [35]. The access to the SCEF northbound APIs shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [51]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a client, prior to consuming services offered by the SCEF Northbound APIs, shall obtain a "token" from the authorization server. + +## 7 Using Common API Framework + +### 7.1 General + +When CAPIF is used with the SCEF, the SCEF shall support the following as defined in 3GPP TS 29.222 [48]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and related APIs over CAPIF-4/4e reference point; +- the API management function and related APIs over CAPIF-5/5e reference point; and +- at least one of the the security methods for authentication and authorization, and related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [47], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with the SCEF, the SCEF shall register all the features for northbound APIs in the CAPIF Core Function. + +### 7.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the SCEF, the SCS/AS as API invoker shall negotiate the security method (PKI, TLS-PSK or OAUTH2) with CAPIF core function and ensure the SCEF has enough credential to authenticate the SCS/AS (see 3GPP TS 29.222 [48], clause 5.6.2.2 and clause 6.2.2.2). + +If PKI or TLS-PSK is used as the selected security method between the AF and the NEF, upon API invocation, the NEF shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [48], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [53], the access to the T8 APIs may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [51]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [48]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth2 is used as the selected security method between the SCS/AS and the SCEF, the SCS/AS, prior to consuming services offered by the T8 APIs, shall obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [48], clause 5.6.2.3.2. + +The T8 APIs do not define any scopes for OAuth2 authorization. It is the SCEF responsibility to check whether the SCS/AS is authorized to use an API based on the "token". Once the SCEF verifies the "token", it shall check whether the NEF identifier in the "token" matches its own published identifier, and whether the API name in the "token" + +matches its own published API name. If those checks are passed, the AF has full authority to access any resource or operation for the invoked API. + +NOTE 2: The security requirement in the current clause does not apply for the MsisdnLessMoSms API since it is the SCEF initiated interaction with the SCS/AS. How the security scheme works for the MsisdnLessMoSms API is left to configuration. + +NOTE 3: For aforementioned security methods, the SCEF needs to apply admission control according to access control policies after performing the authorization checks. + +# Annex A (normative): OpenAPI representation for the APIs defined in the present document + +## A.1 General + +This Annex is based on the OpenAPI Specification [27] and provides corresponding representations of all APIs defined in the present specification. + +NOTE 1: An OpenAPIs representation embeds JSON Schema representations of HTTP message bodies. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 2: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [58] and clause 5.3.1 of the 3GPP TS 29.501 [49] for further information). + +## A.2 Data Types applicable to several APIs + +For the purpose of referencing entities in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file named "TS29122\_CommonData.yaml". + +NOTE: For the purpose of referencing the error status codes in the Open API file defined in this Annex, this Open API file contains all the mandatory status codes as defined in table 5.2.6-1, all the API specific error status codes defined for T8 APIs, in addition, some error status codes not used in the current release of this specification but for the purpose of referencing by other specifications. + +``` +openapi: 3.0.0 + +info: + title: TS 29.122 Common Data Types + version: 1.3.0-alpha.4 + description: | + Data types applicable to several APIs. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +paths: {} + +components: + schemas: + SponsorInformation: + description: Represents a sponsor information. + type: object + properties: + sponsorId: + type: string + description: It indicates Sponsor ID. + aspId: + type: string + description: It indicates Application Service Provider ID. + required: + - sponsorId + - aspId +``` + +``` +UsageThreshold: + description: Represents a usage threshold. + type: object + properties: + duration: + $ref: '#/components/schemas/DurationSec' + totalVolume: + $ref: '#/components/schemas/Volume' + downlinkVolume: + $ref: '#/components/schemas/Volume' + uplinkVolume: + $ref: '#/components/schemas/Volume' + +UsageThresholdRm: + description: > + Represents the same as the UsageThreshold data type but with the nullable:true property. + type: object + properties: + duration: + $ref: '#/components/schemas/DurationSecRm' + totalVolume: + $ref: '#/components/schemas/VolumeRm' + downlinkVolume: + $ref: '#/components/schemas/VolumeRm' + uplinkVolume: + $ref: '#/components/schemas/VolumeRm' + nullable: true + +TimeWindow: + description: Represents a time window identified by a start time and a stop time. + type: object + properties: + startTime: + $ref: '#/components/schemas/DateTime' + stopTime: + $ref: '#/components/schemas/DateTime' + required: + - startTime + - stopTime + +Acknowledgement: + description: Represents a successful acknowledgement of a notification. + type: object + properties: + details: + type: string + description: A human-readable explanation specific to this successful acknowledgement + required: + - details + +NotificationData: + description: > + Represents the information to be conveyed in a bearer level event(s) notification. + type: object + properties: + transaction: + $ref: '#/components/schemas/Link' + eventReports: + type: array + items: + $ref: '#/components/schemas/EventReport' + minItems: 1 + description: Contains the reported event and applicable information + required: + - transaction + - eventReports + +EventReport: + description: Represents an event report. + type: object + properties: + event: + $ref: '#/components/schemas/Event' + accumulatedUsage: + $ref: '#/components/schemas/AccumulatedUsage' + flowIds: + type: array +``` + +``` + items: + type: integer + minItems: 1 + description: Identifies the IP flows that were sent during event subscription + required: + - event + +AccumulatedUsage: + description: Represents an accumulated usage. + type: object + properties: + duration: + $ref: '#/components/schemas/DurationSec' + totalVolume: + $ref: '#/components/schemas/Volume' + downlinkVolume: + $ref: '#/components/schemas/Volume' + uplinkVolume: + $ref: '#/components/schemas/Volume' + +FlowInfo: + description: Represents IP flow information. + type: object + properties: + flowId: + type: integer + description: Indicates the IP flow identifier. + flowDescriptions: + type: array + items: + type: string + description: > + Indicates the packet filters of the IP flow. Refer to clause 5.3.8 of 3GPP TS 29.214 for + encoding. It shall contain UL and/or DL IP flow description. + minItems: 1 + maxItems: 2 + tosTC: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TosTrafficClass' + required: + - flowId + +TestNotification: + description: > + Represents a notification that can be sent to test whether a chosen notification mechanism + works. + type: object + properties: + subscription: + $ref: '#/components/schemas/Link' + required: + - subscription + +WebsockNotifConfig: + description: > + Represents the configuration information for the delivery of notifications over Websockets. + type: object + properties: + websocketUri: + $ref: '#/components/schemas/Link' + requestWebsocketUri: + type: boolean + description: Set by the SCS/AS to indicate that the Websocket delivery is requested. + +LocationArea: + description: Represents a user location area. + type: object + properties: + cellIDs: + type: array + items: + type: string + minItems: 1 + description: > + Indicates a list of Cell Global Identities of the user which identifies the cell the UE + is registered. + enodeBIDs: + type: array + items: +``` + +``` + type: string + minItems: 1 + description: Indicates a list of eNodeB identities in which the UE is currently located. + routingAreaIds: + type: array + items: + type: string + minItems: 1 + description: > + Identifies a list of Routing Area Identities of the user where the UE is located. + trackingAreaIds: + type: array + items: + type: string + minItems: 1 + description: > + Identifies a list of Tracking Area Identities of the user where the UE is located. + geographicAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: Identifies a list of geographic area of the user where the UE is located. + civicAddresses: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: Identifies a list of civic addresses of the user where the UE is located. + +LocationArea5G: + description: Represents a user location area when the UE is attached to 5G. + type: object + properties: + geographicAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 0 + description: Identifies a list of geographic area of the user where the UE is located. + civicAddresses: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 0 + description: Identifies a list of civic addresses of the user where the UE is located. + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + +ProblemDetails: + description: Represents additional information and details on an error response. + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + description: > + A short, human-readable summary of the problem type. It should not change from +occurrence + to occurrence of the problem. + status: + type: integer + description: The HTTP status code for this occurrence of the problem. + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem. + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + description: > + A machine-readable application error cause specific to this occurrence of the problem. + This IE should be present and provide application-related error information, if + available. + invalidParams: + type: array + items: +``` + +``` + $ref: '#/components/schemas/InvalidParam' + minItems: 1 + description: > + Description of invalid parameters, for a request rejected due to invalid parameters. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +InvalidParam: + description: > + Represents the description of invalid parameters, for a request rejected due to invalid + parameters. + type: object + properties: + param: + type: string + description: Attribute's name encoded as a JSON Pointer, or header's name. + reason: + type: string + description: A human-readable reason, e.g. "must be a positive integer". + required: + - param + +PlmnId: + description: Represents the identifier of a PLMN. + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + +ConfigResult: + description: Represents one configuration processing result for a group's members. + type: object + properties: + externalIds: + type: array + items: + $ref: '#/components/schemas/ExternalId' + minItems: 1 + description: Each element indicates an external identifier of the UE. + msisdns: + type: array + items: + $ref: '#/components/schemas/Msisdn' + minItems: 1 + description: > + Each element identifies the MS internal PSTN/ISDN number allocated for the UE. + resultReason: + $ref: '#/components/schemas/ResultReason' + required: + - resultReason + oneOf: + - required: [externalIds] + - required: [msisdns] + +Bandwidth: + type: integer + minimum: 0 + description: integer indicating a bandwidth in bits per second. + +BdtReferenceId: + type: string + description: string identifying a BDT Reference ID as defined in clause 5.3.3 of 3GPP TS +29.154. + +Binary: + type: string + description: string with format "binary" as defined in OpenAPI Specification. + +Bytes: + type: string + description: > + String with format "byte" as defined in OpenAPI Specification, i.e, base64-encoded + characters. +``` + +DayOfWeek: +type: integer +minimum: 1 +maximum: 7 +description: > +integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday. + +DateTime: +format: date-time +type: string +description: string with format "date-time" as defined in OpenAPI. + +DateTimeRm: +format: date-time +type: string +description: > +string with format "date-time" as defined in OpenAPI with "nullable=true" property. +nullable: true + +DateTimeRo: +format: date-time +type: string +description: > +string with format "date-time" as defined in OpenAPI with "readOnly=true" property. +readOnly: true + +DurationSec: +type: integer +minimum: 0 +description: Unsigned integer identifying a period of time in units of seconds. + +DurationSecRm: +type: integer +minimum: 0 +description: > +Unsigned integer identifying a period of time in units of seconds with "nullable=true" property. +nullable: true + +DurationSecRo: +type: integer +minimum: 0 +description: > +Unsigned integer identifying a period of time in units of seconds with "readOnly=true" property. +readOnly: true + +DurationMin: +type: integer +format: int32 +minimum: 0 +description: Unsigned integer identifying a period of time in units of minutes. + +ExternalId: +type: string +description: > +string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clause 4.6.2 of 3GPP TS 23.682 for more information. + +ExternalGroupId: +type: string +description: > +string containing a local identifier followed by "@" and a domain identifier. Both the local identifier and the domain identifier shall be encoded as strings that do not contain any "@" characters. See Clauses 4.6.2 and 4.6.3 of 3GPP TS 23.682 for more information. + +Ipv4Addr: +type: string +description: > +string identifying a Ipv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166. + +Ipv6Addr: +type: string +description: > + +``` + string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952. + The mixed Ipv4 Ipv6 notation according to clause 5 of IETF RFC 5952 shall not be used. + +Ipv4AddrRo: + type: string + description: > + string identifying a Ipv4 address formatted in the "dotted decimal" notation + as defined in IETF RFC 1166, with "readOnly=true" property. + readOnly: true + +Ipv6AddrRo: + type: string + description: > + string identifying a Ipv6 address formatted according to clause 4 in IETF RFC 5952, + with "readOnly=true" property. The mixed Ipv4 Ipv6 notation according to clause 5 of + IETF RFC 5952 shall not be used. + readOnly: true + +Link: + type: string + description: string formatted according to IETF RFC 3986 identifying a referenced resource. + +LinkRm: + type: string + description: > + String formatted according to IETF RFC 3986 identifying a referenced resource, + but with the nullable property set to true. + nullable: true + +McC: + type: string + description: > + String encoding a Mobile Country Code part of the PLMN, comprising 3 digits, + as defined in 3GPP TS 38.413. + +Mnc: + type: string + description: > + String encoding a Mobile Network Code part of the PLMN, comprising 2 or 3 digits, + as defined in 3GPP TS 38.413. + +Msisdn: + type: string + description: > + string formatted according to clause 3.3 of 3GPP TS 23.003 that describes an MSISDN. + +Port: + type: integer + description: Unsigned integer with valid values between 0 and 65535. + minimum: 0 + maximum: 65535 + +PortRo: + type: integer + description: > + Unsigned integer with valid values between 0 and 65535, with "readOnly=true" property. + minimum: 0 + maximum: 65535 + readOnly: true + +ResourceId: + type: string + description: string chosen by the SCEF to serve as identifier in a resource URI. + +ScsAsId: + type: string + description: string that identifies an SCS/AS. + +TimeOfDay: + type: string + description: > + String with format partial-time or full-time as defined in clause 5.6 of IETF RFC 3339. + Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). + +Uri: + type: string + description: string providing an URI formatted according to IETF RFC 3986. + +Volume: +``` + +``` +type: integer +format: int64 +minimum: 0 +description: Unsigned integer identifying a volume in units of bytes. + +VolumeRm: +type: integer +format: int64 +minimum: 0 +description: > + Unsigned integer identifying a volume in units of bytes with "nullable=true" property. +nullable: true + +EthFlowInfo: +description: Represents Ethernet flow information. +type: object +properties: + flowId: + type: integer + description: Indicates the Ethernet flow identifier. + ethFlowDescriptions: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + description: > + Indicates the packet filters of the Ethernet flow. It shall contain UL and/or DL + Ethernet flow description. + minItems: 1 + maxItems: 2 + required: + - flowId + +Event: +anyOf: +- type: string + enum: + - SESSION_TERMINATION + - LOSS_OF_BEARER + - RECOVERY_OF_BEARER + - RELEASE_OF_BEARER + - USAGE_REPORT + - FAILED_RESOURCES_ALLOCATION + - SUCCESSFUL_RESOURCES_ALLOCATION +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. +description: | + Represents the event reported by the SCEF. + Possible values are: + - SESSION_TERMINATION: Indicates that Rx session is terminated. + - LOSS_OF_BEARER : Indicates a loss of a bearer. + - RECOVERY_OF_BEARER: Indicates a recovery of a bearer. + - RELEASE_OF_BEARER: Indicates a release of a bearer. + - USAGE_REPORT: Indicates the usage report event. + - FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed. + - SUCCESSFUL_RESOURCES_ALLOCATION: Indicates the resource allocation is successful. + +ResultReason: +anyOf: +- type: string + enum: + - ROAMING_NOT_ALLOWED + - OTHER_REASON +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +description: | + Represents a failure result reason. + Possible values are: + - ROAMING_NOT_ALLOWED: Identifies the configuration parameters are not allowed by roaming + agreement. + - OTHER_REASON: Identifies the configuration parameters are not configured due to other + reason. + +# +# HTTP responses +``` + +``` +# +responses: + '307': + description: Temporary Redirect + headers: + Location: + description: 'An alternative URI of the resource.' + required: true + schema: + type: string + '308': + description: Permanent Redirect + headers: + Location: + description: 'An alternative URI of the resource.' + required: true + schema: + type: string + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: Not Acceptable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '411': + description: Length Required + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '412': + description: Precondition Failed + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '413': + description: Content Too Large + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '414': + description: URI Too Long + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +``` + +``` + +'415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'429': + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +default: + description: Generic Error + +``` + +## A.3 MonitoringEvent API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-monitoring-event + version: 1.3.0-alpha.4 + description: | + API for Monitoring Event. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/3gpp-monitoring-event/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/subscriptions: + get: + summary: Read all or queried active subscriptions for the SCS/AS. + operationId: FetchAllMonitoringEventSubscriptions + tags: + - Monitoring Event Subscriptions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: ip-addrs + in: query + description: The IP address(es) of the requested UE(s). + required: false + content: + application/json: + schema: + type: array + +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 +- name: ip-domain + in: query + description: > + The IPv4 address domain identifier. The attribute may only be provided if IPv4 address + is included in the ip-addrs query parameter. + required: false + schema: + type: string +- name: mac-addrs + in: query + description: The MAC address(es) of the requested UE(s). + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 +responses: + '200': + description: OK (Successful get all or queried active subscriptions for the SCS/AS) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MonitoringEventSubscription' + minItems: 0 + description: Monitoring event subscriptions + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Creates a new subscription resource for monitoring event notification. + operationId: CreateMonitoringEventSubscription + tags: + - Monitoring Event Subscriptions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + requestBody: + description: Subscription for notification about monitoring event + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringEventSubscription' + callbacks: + - notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + +``` + +``` + + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +UserConsentRevocationNotif: + '{request.body#/revocationNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConsentRevocNotif' + responses: + '204': + description: No Content (successful notification). + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + responses: + '201': + description: Created (Successful creation of subscription) + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/MonitoringEventSubscription' +headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'200': + description: The operation is successful and immediate report is included. + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MonitoringEventReport' + - $ref: '#/components/schemas/MonitoringEventReports' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/subscriptions/{subscriptionId}: + get: + summary: Read an active subscriptions for the SCS/AS and the subscription Id. + operationId: FetchIndMonitoringEventSubscription + tags: + - Individual Monitoring Event Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get the active subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringEventSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + +``` + +``` + + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Updates/replaces an existing subscription resource. + operationId: UpdateIndMonitoringEventSubscription + tags: + - Individual Monitoring Event Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + requestBody: + description: Parameters to update/replace the existing subscription + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringEventSubscription' + responses: + '200': + description: OK (Successful update of the subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringEventSubscription' + '204': + description: No Content (Successful update of the subscription) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modifies an existing subscription of monitoring event. + operationId: ModifyIndMonitoringEventSubscription + tags: + - Individual Monitoring Event Subscription + parameters: + - name: scsAsId + in: path + +``` + +``` + description: Identifier of the SCS/AS. + required: true + schema: + type: string +- name: subscriptionId + in: path + description: Identifier of the subscription resource. + required: true + schema: + type: string +requestBody: + description: > + This is used for PATCH request for partial cancellation and/or partial addition of certain + UE(s) within an active group. + required: true + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 +responses: + '204': + description: The resource was modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an already existing monitoring event subscription. + operationId: DeleteIndMonitoringEventSubscription + tags: + - Individual Monitoring Event Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing subscription) + '200': + description: OK (Successful deletion of the existing subscription) + content: + application/json: + schema: +``` + +``` + type: array + items: + $ref: '#/components/schemas/MonitoringEventReport' + minItems: 1 + description: > + The subscription was terminated successfully, the monitoring event report(s) + shall be included if received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + MonitoringEventSubscription: + description: Represents a subscription to event(s) monitoring. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtcProviderId: + type: string + description: Identifies the MTC Service Provider and/or MTC Application. + appIds: + type: array + items: + type: string + description: Identifies the Application Identifier(s) + minItems: 1 + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + addedExternalIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + minItems: 1 + description: Indicates the added external Identifier(s) within the active group. + addedMsisdns: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + minItems: 1 + description: Indicates the added MSISDN(s) within the active group. + excludedExternalIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + minItems: 1 + description: Indicates cancellation of the external Identifier(s) within the active group. + excludedMsisdns: +``` + +``` + +type: array +items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' +minItems: 1 +description: Indicates cancellation of the MSISDN(s) within the active group. +externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' +addExtGroupId: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + minItems: 2 +ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' +requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification + as defined in clause 5.2.5.3. Set to false by the SCS/AS indicates not request SCEF to + send a test notification, default false if omitted otherwise. +websockNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' +monitoringType: + $ref: '#/components/schemas/MonitoringType' +maximumNumberOfReports: + type: integer + minimum: 1 + description: > + Identifies the maximum number of event reports to be generated by the HSS, MME/SGSN + as specified in clause 5.6.0 of 3GPP TS 23.682. +monitorExpireTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' +repPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +groupReportGuardTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +maximumDetectionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +reachabilityType: + $ref: '#/components/schemas/ReachabilityType' +maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +maximumResponseTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +suggestedNumberOfDlPackets: + type: integer + minimum: 0 + description: > + If "monitoringType" is "UE_REACHABILITY", this parameter may be included to identify + the number of packets that the serving gateway shall buffer in case that + the UE is not reachable. +idleStatusIndication: + type: boolean + description: > + If "monitoringType" is set to "UE_REACHABILITY" or "AVAILABILITY_AFTER_DDN_FAILURE", + this parameter may be included to indicate the notification of when a UE, for which PSM + is enabled, transitions into idle mode. "true" indicates enabling of notification; + "false" indicate no need to notify. Default value is "false" if omitted. +locationType: + $ref: '#/components/schemas/LocationType' +accuracy: + $ref: '#/components/schemas/Accuracy' +minimumReportInterval: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +maxRptExpireIntvl: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +samplingInterval: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +reportingLocEstInd: + type: boolean + description: > + Indicates whether to request the location estimate for event reporting. If + +``` + +"monitoringType" is "LOCATION\_REPORTING", this parameter may be included to indicate whether event reporting requires the location information. If set to true, the location estimation information shall be included in event reporting. If set to "false", indicates the location estimation information shall not be included in event reporting. Default "false" if omitted. + +linearDistance: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/LinearDistance' + +locQoS: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/LocationQoS' + +svcId: + \$ref: 'TS29515\_Ngmlc\_Location.yaml#/components/schemas/ServiceIdentity' + +ldrType: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/LdrType' + +velocityRequested: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/VelocityRequested' + +maxAgeOfLocEst: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/AgeOfLocationEstimate' + +locTimeWindow: + \$ref: 'TS29122\_CommonData.yaml#/components/schemas/TimeWindow' + +supportedGADShapes: + type: array + items: + \$ref: 'TS29572\_Nlmf\_Location.yaml#/components/schemas/SupportedGADShapes' + +codeWord: + \$ref: 'TS29515\_Ngmlc\_Location.yaml#/components/schemas/CodeWord' + +upLocRepIndAf: + description: > + Indicates whether location reporting over user plane is requested or not. + "true" indicates the location reporting over user plane is requested. + "false" indicates the location reporting over user plane is not requested. + Default value is "false" if omitted. + type: boolean + default: false + +upLocRepAddrAf: + \$ref: '#/components/schemas/UpLocRepAddrAfRm' + +associationType: + \$ref: '#/components/schemas/AssociationType' + +plmnIndication: + type: boolean + description: > + If "monitoringType" is "ROAMING\_STATUS", this parameter may be included to indicate the notification of UE's Serving PLMN ID. Value "true" indicates enabling of notification; "false" indicates disabling of notification. Default value is "false" if omitted. + +locationArea: + \$ref: 'TS29122\_CommonData.yaml#/components/schemas/LocationArea' + +locationArea5G: + \$ref: 'TS29122\_CommonData.yaml#/components/schemas/LocationArea5G' + +dddTraDescriptors: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + +dddStati: + type: array + items: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + +apiNames: + type: array + items: + type: string + minItems: 1 + +monitoringEventReport: + \$ref: '#/components/schemas/MonitoringEventReport' + +snssai: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/Snssai' + +tgtNsThreshold: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/SACInfo' + +nsRepFormat: + \$ref: '#/components/schemas/SACRepFormat' + +afServiceId: + type: string + +immediateRep: + type: boolean + description: > + Indicates whether an immediate reporting is requested or not. + "true" indicate an immediate reporting is requested. + "false" indicate an immediate reporting is not requested. + +``` + + Default value "false" if omitted. + uavPolicy: + $ref: '#/components/schemas/UavPolicy' + sesEstInd: + type: boolean + description: > + Set to true by the SCS/AS so that only UAV's with "PDU session established for DNN(s) + subject to aerial service" are to be listed in the Event report. Set to false or default + false if omitted otherwise. + subType: + $ref: '#/components/schemas/SubType' + addnMonTypes: + type: array + items: + $ref: '#/components/schemas/MonitoringType' + addnMonEventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringEventReport' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + revocationNotifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + reqRangingSlRes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 + required: + - notificationDestination + - monitoringType + anyOf: + - required: [maximumNumberOfReports] + - required: [monitorExpireTime] + +MonitoringNotification: + description: Represents an event monitoring notification. + type: object + properties: + subscription: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + configResults: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult' + minItems: 1 + description: Each element identifies a notification of grouping configuration result. + monitoringEventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringEventReport' + minItems: 1 + description: Monitoring event reports. + addedExternalIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + minItems: 1 + description: > + Identifies the added external Identifier(s) within the active group via + the "externalGroupId" attribute within the MonitoringEventSubscription data type. + addedMsisdns: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + minItems: 1 + description: > + Identifies the added MSISDN(s) within the active group via the "externalGroupId" + attribute within the MonitoringEventSubscription data type. + cancelExternalIds: + type: array + +``` + +``` +items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' +minItems: 1 +description: > + Identifies the cancelled external Identifier(s) within the active group via + the "externalGroupId" attribute within the MonitoringEventSubscription data type. +cancelMsisdns: +type: array +items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' +minItems: 1 +description: > + Identifies the cancelled MSISDN(s) within the active group via the "externalGroupId" + attribute within the MonitoringEventSubscription data type. +cancelInd: +type: boolean +description: > + Indicates whether to request to cancel the corresponding monitoring subscription. + Set to false or omitted otherwise. +appliedParam: + $ref: '#/components/schemas/AppliedParameterConfiguration' +required: +- subscription + +MonitoringEventReport: +description: Represents an event monitoring report. +type: object +properties: +imeiChange: + $ref: '#/components/schemas/AssociationType' +externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' +appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +pduSessInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PduSessionInformation' +idleStatusInfo: + $ref: '#/components/schemas/IdleStatusInfo' +locationInfo: + $ref: '#/components/schemas/LocationInfo' +locFailureCause: + $ref: '#/components/schemas/LocationFailureCause' +lossOfConnectReason: +type: integer +description: > + If "monitoringType" is "LOSS_OF_CONNECTIVITY", this parameter shall be included + if available to identify the reason why loss of connectivity is reported. + Refer to 3GPP TS 29.336 clause 8.4.58. +unavailPerDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' +maxUEAvailabilityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' +msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' +monitoringType: + $ref: '#/components/schemas/MonitoringType' +uePerLocationReport: + $ref: '#/components/schemas/UePerLocationReport' +plmnId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' +reachabilityType: + $ref: '#/components/schemas/ReachabilityType' +roamingStatus: +type: boolean +description: > + If "monitoringType" is "ROAMING_STATUS", this parameter shall be set to "true" + if the new serving PLMN is different from the HPLMN. Set to false or + omitted otherwise. +failureCause: + $ref: '#/components/schemas/FailureCause' +eventTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' +pdnConnInfoList: +type: array +items: + $ref: '#/components/schemas/PdnConnectionInformation' +minItems: 1 +dddStatus: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' +dddTrafDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' +maxWaitTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' +apiCaps: + type: array + items: + $ref: '#/components/schemas/ApiCapabilityInfo' + minItems: 0 +nSStatusInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SACEventStatus' +afServiceId: + type: string +servLevelDevId: + type: string + description: > + If "monitoringType" is "AREA_OF_INTEREST", this parameter may be included + to identify the UAV. +uavPresInd: + type: boolean + description: > + If "monitoringType" is "AREA_OF_INTEREST", this parameter shall be set to true + if the specified UAV is in the monitoring area. Set to false or omitted otherwise. +groupMembListChanges: + $ref: '#/components/schemas/GroupMembListChanges' +required: +- monitoringType + +MonitoringEventReports: + description: Represents a set of event monitoring reports. + type: object + properties: + monitoringEventReports: + type: array + items: + $ref: '#/components/schemas/MonitoringEventReport' + minItems: 1 + required: + - monitoringEventReports + +IdleStatusInfo: + description: Represents the information relevant to when the UE transitions into idle mode. + type: object + properties: + activeTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + edrxCycleLength: + format: float + type: number + minimum: 0 + suggestedNumberOfDlPackets: + type: integer + minimum: 0 + description: > + Identifies the number of packets shall be buffered in the serving gateway. + It shall be present if the idle status indication is requested by the SCS/AS + with "idleStatusIndication" in the "monitoringEventSubscription" sets to "true". + idleStatusTimestamp: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + periodicAUTimer: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + +UePerLocationReport: + description: Represents the number of UEs found at the indicated location. + type: object + properties: + ueCount: + type: integer + minimum: 0 + description: Identifies the number of UEs. + externalIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + minItems: 1 + description: Each element uniquely identifies a user. + msisdns: + type: array +``` + +``` + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + minItems: 1 + description: Each element identifies the MS internal PSTN/ISDN number allocated for a UE. + servLevelDevIds: + type: array + items: + type: string + minItems: 1 + description: Each element uniquely identifies a UAV. + required: + - ueCount + +LocationInfo: + description: Represents the user location information. + type: object + properties: + ageOfLocationInfo: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationMin' + cellId: + type: string + description: > + Indicates the Cell Global Identification of the user which identifies the cell the UE + is registered. + enodeBId: + type: string + description: Indicates the eNodeB in which the UE is currently located. + routingAreaId: + type: string + description: Identifies the Routing Area Identity of the user where the UE is located. + trackingAreaId: + type: string + description: Identifies the Tracking Area Identity of the user where the UE is located. + plmnId: + type: string + description: Identifies the PLMN Identity of the user where the UE is located. + twanId: + type: string + description: Identifies the TWAN Identity of the user where the UE is located. + userLocation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + geographicArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + positionMethod: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' + qosFulfilInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + ueVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + ldrType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrType' + achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: '#/components/schemas/RangeDirection' + twodrelativeLocation: + $ref: '#/components/schemas/TwodrelativeLocation' + threedrelativeLocation: + $ref: '#/components/schemas/ThreedrelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + upCumEvtRep: + $ref: '#/components/schemas/UpCumEvtRep' + +RangeDirection: + description: Represents a range and direction from a point A to a point B. + type: object + properties: + range: + type: number + azimuthDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Angle' + elevationDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Angle' +``` + +``` +TwodrelativeLocation: + description: Represents a relative 2D location with uncertainty ellipse. + type: object + properties: + semiMinor: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Uncertainty' + semiMajor: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Uncertainty' + orientationAngle: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Angle' + +ThreedrelativeLocation: + description: Represents a relative 3D location with uncertainty ellipsoid. + type: object + properties: + semiMinor: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Uncertainty' + semiMajor: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Uncertainty' + verticalUncertainty: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Uncertainty' + orientationAngle: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Angle' + +FailureCause: + description: Represents the reason of communication failure. + type: object + properties: + bssgpCause: + type: integer + description: > + Identifies a non-transparent copy of the BSSGP cause code. Refer to 3GPP TS 29.128. + causeType: + type: integer + description: Identify the type of the SLAP-Cause. Refer to 3GPP TS 29.128. + gmmCause: + type: integer + description: > + Identifies a non-transparent copy of the GMM cause code. Refer to 3GPP TS 29.128. + ranapCause: + type: integer + description: > + Identifies a non-transparent copy of the RANAP cause code. Refer to 3GPP TS 29.128. + ranNasCause: + type: string + description: > + Indicates RAN and/or NAS release cause code information, TWAN release cause code + information or untrusted WLAN release cause code information. Refer to 3GPP TS 29.214. + slapCause: + type: integer + description: > + Identifies a non-transparent copy of the SLAP cause code. Refer to 3GPP TS 29.128. + smCause: + type: integer + description: > + Identifies a non-transparent copy of the SM cause code. Refer to 3GPP TS 29.128. + +PdnConnectionInformation: + description: Represents the PDN connection information of the UE. + type: object + properties: + status: + $ref: '#/components/schemas/PdnConnectionStatus' + apn: + type: string + description: > + Identify the APN, it is depending on the SCEF local configuration whether or + not this attribute is sent to the SCS/AS. + pdnType: + $ref: '#/components/schemas/PdnType' + interfaceInd: + $ref: '#/components/schemas/InterfaceIndication' + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addrs: + type: array +``` + +``` + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + macAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + required: + - status + - pdnType + +AppliedParameterConfiguration: + description: Represents the parameter configuration applied in the network. + type: object + properties: + externalIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + minItems: 1 + description: Each element uniquely identifies a user. + msisdns: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + minItems: 1 + description: Each element identifies the MS internal PSTN/ISDN number allocated for a UE. + maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + maximumResponseTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + maximumDetectionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + +ApiCapabilityInfo: + description: Represents the availability information of supported API. + type: object + properties: + apiName: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - apiName + - suppFeat + +UavPolicy: + description: > + Represents the policy information included in the UAV presence monitoring request. + type: object + properties: + uavMoveInd: + type: boolean + revokeInd: + type: boolean + required: + - uavMoveInd + - revokeInd + +ConsentRevocNotif: + description: > + Represents the user consent revocation information conveyed in a user consent + revocation notification. + type: object + properties: + subscriptionId: + type: string + consentsRevoked: + type: array + items: + $ref: '#/components/schemas/ConsentRevoked' + minItems: 1 + required: + - subscriptionId + - consentsRevoked + +ConsentRevoked: +``` + +``` +description: Represents the information related to a revoked user consent. +type: object +properties: + ucPurpose: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/UcPurpose' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' +required: +- ucPurpose +oneOf: +- required: [externalId] +- required: [msisdn] + +GroupMembListChanges: +description: Represents information on the change(s) to a group's members list. +type: object +properties: + addedUEs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + removedUEs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 +anyOf: +- required: [addedUEs] +- required: [removedUEs] + +UpLocRepAddrAfRm: +description: Represents the user plane addressing information. +type: object +properties: + ipv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +nullable: true +anyOf: +- required: [ipv4Addrs] +- required: [ipv6Addrs] +- required: [fqdn] + +UpCumEvtRep: +description: Represents the cumulative event report. +type: object +properties: + upLocRepStat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +# +# ENUMS +# +MonitoringType: +anyOf: +- type: string +enum: +- LOSS_OF_CONNECTIVITY +- UE_REACHABILITY +- LOCATION_REPORTING +- CHANGE_OF_IMSI_IMEI_ASSOCIATION +- ROAMING_STATUS +- COMMUNICATION_FAILURE +- AVAILABILITY_AFTER_DDN_FAILURE +- NUMBER_OF_UES_IN_AN_AREA +``` + +``` + + - PDN_CONNECTIVITY_STATUS + - DOWNLINK_DATA_DELIVERY_STATUS + - API_SUPPORT_CAPABILITY + - NUM_OF_REGD_UES + - NUM_OF_ESTD_PDU_SESSIONS + - AREA_OF_INTEREST + - GROUP_MEMBER_LIST_CHANGE + - APPLICATION_START + - APPLICATION_STOP +- type: string + description: > + 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. +description: | + Represents a monitoring event type. +Possible values are +- LOSS_OF_CONNECTIVITY: The SCS/AS requests to be notified when the 3GPP network detects + that the UE is no longer reachable for signalling or user plane communication +- UE_REACHABILITY: The SCS/AS requests to be notified when the UE becomes reachable for + sending either SMS or downlink data to the UE +- LOCATION_REPORTING: The SCS/AS requests to be notified of the current location or + the last known location of the UE +- CHANGE_OF_IMSI_IMEI_ASSOCIATION: The SCS/AS requests to be notified when the association + of an ME (IMEI(SV)) that uses a specific subscription (IMSI) is changed +- ROAMING_STATUS: The SCS/AS queries the UE's current roaming status and requests to get + notified when the status changes +- COMMUNICATION_FAILURE: The SCS/AS requests to be notified of communication failure events +- AVAILABILITY_AFTER_DDN_FAILURE: The SCS/AS requests to be notified when the UE has become + available after a DDN failure +- NUMBER_OF_UES_IN_AN_AREA: The SCS/AS requests to be notified the number of UEs in a given + geographic area +- PDN_CONNECTIVITY_STATUS: The SCS/AS requests to be notified when the 3GPP network detects + that the UE's PDN connection is set up or torn down +- DOWNLINK_DATA_DELIVERY_STATUS: The AF requests to be notified when the 3GPP network +detects that the downlink data delivery status is changed. +- API_SUPPORT_CAPABILITY: The SCS/AS requests to be notified of the availability of support + of service APIs. +- NUM_OF_REGD_UES: The AF requests to be notified of the current number of registered UEs + for a network slice. +- NUM_OF_ESTD_PDU_SESSIONS: The AF requests to be notified of the current number of + established PDU Sessions for a network slice. +- AREA_OF_INTEREST: The SCS/AS requests to be notified when the UAV moves in or + out of the geographic area. +- GROUP_MEMBER_LIST_CHANGE: The AF requests to be notified of the changes to a group members + list. +- APPLICATION_START: The AF requests to be notified about the start of application traffic + has been detected. +- APPLICATION_STOP: The AF requests to be notified about the stop of application traffic + has been detected. + +ReachabilityType: + anyOf: + - type: string + enum: + - SMS + - DATA + - type: string + description: > + 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. + description: | + Represents a reachability type. + Possible values are + - SMS: The SCS/AS requests to be notified when the UE becomes reachable for sending SMS + to the UE + - DATA: The SCS/AS requests to be notified when the UE becomes reachable for sending + downlink data to the UE. + +LocationType: + anyOf: + - type: string + enum: + - CURRENT_LOCATION + - LAST_KNOWN_LOCATION + - CURRENT_OR_LAST_KNOWN_LOCATION + - INITIAL_LOCATION + +``` + +``` +- type: string + description: > + 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. + description: | + Represents a location type. + Possible values are + - CURRENT_LOCATION: The SCS/AS requests to be notified for current location + - LAST_KNOWN_LOCATION: The SCS/AS requests to be notified for last known location + - CURRENT_OR_LAST_KNOWN_LOCATION: The AF requests the current or last known location + - INITIAL_LOCATION: The AF requests the initial location + +AssociationType: + anyOf: + - type: string + enum: + - IMEI + - IMEISV + - type: string + description: > + 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. + description: | + Represents an IMEI or IMEISV to IMSI association. + Possible values are + - IMEI: The value shall be used when the change of IMSI-IMEI association shall be detected + - IMEISV: The value shall be used when the change of IMSI-IMEISV association shall be detected + +Accuracy: + anyOf: + - type: string + enum: + - CGI_ECGI + - ENODEB + - TA_RA + - PLMN + - TWAN_ID + - GEO_AREA + - CIVIC_ADDR + - type: string + description: > + 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. + description: | + Represents a desired granularity of accuracy of the requested location information. + Possible values are + - CGI_ECGI: The SCS/AS requests to be notified using cell level location accuracy. + - ENODEB: The SCS/AS requests to be notified using eNodeB level location accuracy. + - TA_RA: The SCS/AS requests to be notified using TA/RA level location accuracy. + - PLMN: The SCS/AS requests to be notified using PLMN level location accuracy. + - TWAN_ID: The SCS/AS requests to be notified using TWAN identifier level location accuracy. + - GEO_AREA: The SCS/AS requests to be notified using the geographical area accuracy. + - CIVIC_ADDR: The SCS/AS requests to be notified using the civic address accuracy. + +PdnConnectionStatus: + anyOf: + - type: string + enum: + - CREATED + - RELEASED + - type: string + description: > + 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. + description: | + Represents the PDN connection status. + Possible values are + - CREATED: The PDN connection is created. + - RELEASED: The PDN connection is released. + +PdnType: + anyOf: + - type: string +``` + +``` +enum: + - IPV4 + - IPV6 + - IPV4V6 + - NON_IP + - ETHERNET +- type: string +description: > + 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. +description: | + Represents the PDN connection type. + Possible values are + - IPV4: PDN connection of IPv4 type. + - IPV6: PDN connection of IPv6 type. + - IPV4V6: PDN connection of IPv4v6 type. + - NON_IP: PDN connection of non-IP type. + - ETHERNET: PDN connection of Ethernet type. + +InterfaceIndication: + anyOf: + - type: string + enum: + - EXPOSURE_FUNCTION + - PDN_GATEWAY + - type: string + description: > + 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. + description: | + Represents the network entity used for data delivery towards the SCS/AS. + Possible values are + - EXPOSURE_FUNCTION: SCEF is used for the PDN connection towards the SCS/AS. + - PDN_GATEWAY: PDN gateway is used for the PDN connection towards the SCS/AS. + +LocationFailureCause: + anyOf: + - type: string + enum: + - POSITIONING_DENIED + - UNSUPPORTED_BY_UE + - NOT_REGISTERED_UE + - UNSPECIFIED + - REQUESTED_AREA_NOT_ALLOWED + - type: string + description: > + 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. + description: > + Represents the cause of location positioning failure. + Possible values are: + - POSITIONING_DENIED: Positioning is denied. + - UNSUPPORTED_BY_UE: Positioning is not supported by UE. + - NOT_REGISTERED_UE: UE is not registered. + - UNSPECIFIED: Unspecified. + - REQUESTED_AREA_NOT_ALLOWED: The location request is rejected because the location area + requested by the AF for area event reporting is not allowed. + +SubType: + anyOf: + - type: string + enum: + - AERIAL_UE + - type: string + description: > + 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. + description: | + Represents a subscription type. + Possible values are + - AERIAL_UE: The UE has Aerial subscription. + +SACRepFormat: + anyOf: + - type: string +``` + +``` + +enum: + - NUMERICAL + - PERCENTAGE +- type: string +description: > + 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. +description: Indicates the NSAC reporting format. + +``` + +## A.4 ResourceManagementOfBdt API + +``` + +openapi: 3.0.0 +info: + title: 3gpp-bdt + version: 1.3.0-alpha.1 + description: | + API for BDT resouce management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.122 V18.2.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/3gpp-bdt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +paths: + /{scsAsId}/subscriptions: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + get: + summary: Fetch all active background data transfer subscription resources for a given SCS/AS. + operationId: FetchAllActiveBDTSubscriptions + tags: + - BDT Subscription + responses: + '200': + description: all BDT policy subscriptions. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Bdt' + minItems: 0 + description: individual BDT policy subscription. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +post: + summary: Creates a new background data transfer subscription resource. + operationId: CreateBDTSubscription + tags: + - BDT Subscription + requestBody: + description: Contains the data to create a BDT subscription. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Bdt' + callbacks: + bDTWarningNotification: + '{ $request.body#/notificationDestination }': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Background data transfer policies offered to the SCS/AS. + content: + application/json: + schema: + $ref: '#/components/schemas/Bdt' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' + '411': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/subscriptions/{subscriptionId}: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + - name: subscriptionId + description: String identifying the individual BDT policy resource in the SCEF. + in: path + required: true + schema: + type: string + get: + summary: Read a background data transfer subscription resource. + operationId: FetchIndBDTSubscription + tags: + - Individual BDT Subscription + responses: + '200': + description: Background data transfer policies offered to and selected by the SCEF. + content: + application/json: + schema: + $ref: '#/components/schemas/Bdt' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Update a background data transfer subscription resource for negotiation of background data transfer policy. + operationId: UpdateBDTSubscription + tags: + - Individual BDT Subscription + requestBody: + description: Parameters to update/replace the existing BDT subscription + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Bdt' + responses: + '200': + description: OK (Successful update of the BDT subscription) + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/Bdt' + '204': + description: No Content. The Individual BDT Subscription resource was updated +successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + patch: + summary: Modify a background data transfer subscription resource to select one of the transfer +policies offered by the SCEF. + operationId: ModifyBDTSubscription + tags: + - Individual BDT Subscription + requestBody: + description: Contains information to be performed on the Bdt data structure to select a +transfer policy. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtPatch' + responses: + '200': + description: The Individual BDT Policy resource is modified with a selected policy and a +representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/Bdt' + '204': + description: The Individual BDT Policy resource is modified with a selected policy. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +``` + +``` + + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete a background data transfer resource. + operationId: DeleteBDTSubscription + tags: + - Individual BDT Subscription + responses: + '204': + description: The Individual BDT Policy resource is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +schemas: + Bdt: + description: Represents a Background Data Transfer subscription. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + aspId: + type: string + description: Identifies an application service provider. + volumePerUE: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + numberOfUEs: + type: integer + minimum: 1 + description: Identifies the number of UEs. + desiredTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + locationArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea' + locationArea5G: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + referenceId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + transferPolicies: + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + description: Identifies an offered transfer policy. + readOnly: true + selectedPolicy: + type: integer + description: Identity of the selected background data transfer policy. Shall not be +present in initial message exchange, can be provided by NF service consumer in a subsequent message +exchange. + +``` + +``` + + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). Default + value is false. + trafficDes: + $ref: '#/components/schemas/TrafficDescriptor' + required: + - volumePerUE + - numberOfUEs + - desiredTimeWindow + BdtPatch: + description: Represents a Background Data Transfer subscription modification request. + type: object + properties: + selectedPolicy: + type: integer + description: Identity of the selected background data transfer policy. + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + required: + - selectedPolicy + TransferPolicy: + description: Represents an offered transfer policy sent from the SCEF to the SCS/AS, or a + selected transfer policy sent from the SCS/AS to the SCEF. + type: object + properties: + bdtPolicyId: + type: integer + description: Identifier for the transfer policy + maxUplinkBandwidth: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bandwidth' + maxDownlinkBandwidth: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bandwidth' + ratingGroup: + type: integer + minimum: 0 + description: Indicates the rating group during the time window. + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - bdtPolicyId + - ratingGroup + - timeWindow + ExNotification: + description: Represents a Background Data Transfer notification. + type: object + properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + locationArea5G: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + timeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + candPolicies: + type: array + items: + $ref: '#/components/schemas/TransferPolicy' + minItems: 1 + description: This IE indicates a list of the candidate transfer policies from which the AF + may select a new transfer policy due to network performance degradation. + required: + - bdtRefId + TrafficDescriptor: + type: string + description: Identify a traffic descriptor as defined in Figure 5.2.2 of 3GPP TS 24.526, + octets v+5 to w. + +``` + +## A.5 ChargeableParty API + +``` + +openapi: 3.0.0 +info: + title: 3gpp-chargeable-party + version: 1.3.0-alpha.1 + description: | + API for Chargeable Party management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/3gpp-chargeable-party/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +paths: + /{scsAsId}/transactions: + get: + summary: Read all or queried chargeable party transaction resources for a given SCS/AS. + operationId: FetchAllChargeablePartyTransactions + tags: + - Chargeable Party Transaction Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: ip-addrs + in: query + description: The IP address(es) of the requested UE(s). + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + - name: ip-domain + in: query + description: The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter. + required: false + schema: + type: string + - name: mac-addrs + in: query + description: The MAC address(es) of the requested UE(s). + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + responses: + '200': + description: OK (successful query of Chargeable Party resource) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ChargeableParty' + minItems: 0 + description: individual BDT policy subscription. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Create a new chargeable party transaction resource. + operationId: CreateChargeablePartyTransaction + tags: + - Chargeable Party Transaction Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + requestBody: + description: representation of the Chargeable Party resource to be Created in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ChargeableParty' + callbacks: + eventNotification: + '{ $request.body#/notificationDestination }': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/NotificationData' + responses: + '204': + description: No Content (The successful acknowledgement of the notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +``` + +``` +responses: + '201': + description: successful creation of a chargeable party resource + content: + application/json: + schema: + $ref: '#/components/schemas/ChargeableParty' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/transactions/{transactionId}: + get: + summary: Read a chargeable party resource for a given SCS/AS and a transaction Id. + operationId: FetchIndChargeablePartyTransaction + tags: + - Individual chargeable party resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of a chargeable party resource) + content: + application/json: + schema: + $ref: '#/components/schemas/ChargeableParty' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +``` + +``` +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates a existing chargeable party resource for a given SCS/AS and transaction Id. + operationId: UpdateChargeablePartyTransaction + tags: + - Individual chargeable party resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + requestBody: + description: representation of the chargeable party resource to be udpatd in the SCEF + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ChargeablePartyPatch' + responses: + '200': + description: successful update of a chargeable party resource + content: + application/json: + schema: + $ref: '#/components/schemas/ChargeableParty' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a chargeable party resource for a given SCS/AS and a transcation Id. + operationId: DeleteChargeablePartyTransaction + tags: + - Individual chargeable party resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true +``` + +``` + + schema: + type: string +- name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string +responses: + '204': + description: successful deletion of an resource of chargeable party + '200': + description: OK (Successful deletion of the existing subscription) + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/NotificationData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +schemas: + ChargeableParty: + description: Represents the configuration of a chargeable party. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: Set to true by the SCS/AS to request the SCEF to send a test notification as +defined in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + exteraAppId: + type: string + description: Identifies the external Application Identifier. + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipDomain: + type: string + ipv6Addr : + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + macAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + flowInfo: + +``` + +``` + + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: Describes the application flows. + ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: Identifies Ethernet packet flows. + sponsorInformation: + $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation' + sponsoringEnabled: + type: boolean + description: > + Indicates whether the sponsoring data connectivity is enabled (true) or not (false). + referenceId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + servAuthInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo' + usageThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + events: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Event' + minItems: 1 + description: Represents the list of event(s) to which the SCS/AS requests to subscribe to. + required: + - notificationDestination + - sponsorInformation + - sponsoringEnabled + ChargeablePartyPatch: + description: Represents a modification request of a chargeable party resource. + type: object + properties: + flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: Describes the IP flows. + exterAppId: + type: string + description: Identifies the external Application Identifier. + ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: Identifies Ethernet packet flows. + sponsoringEnabled: + type: boolean + description: > + Indicates whether the sponsoring data connectivity is enabled (true) or not (false). + referenceId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + usageThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + events: + description: Represents the list of event(s) to which the SCS/AS requests to subscribe to. + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Event' + minItems: 1 + +``` + +## A.6 NIDD API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-nidd + +``` + +``` +version: 1.3.0-alpha.1 +description: | + API for non IP data delivery. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-nidd/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/configurations: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + get: + summary: Read all NIDD configuration resources for a given SCS/AS. + operationId: FetchAllNIDDConfigurations + tags: + - NIDD configurations + responses: + '200': + description: all NIDD configurations. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NiddConfiguration' + minItems: 0 + description: individual NIDD configuration. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + post: + summary: Create a new NIDD configuration resource. + operationId: CreateNIDDConfiguration + tags: + - NIDD configurations + requestBody: + description: Contains the data to create a NIDD configuration. + required: true + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/NiddConfiguration' +responses: + '201': + description: NIDD configuration is successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddConfiguration' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + niddNotifications: + "{$request.body#/notificationDestination}": + post: + requestBody: + description: > + Notification for NIDD configuration status, MO NIDD, MT NIDD delivery report. + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/NiddConfigurationStatusNotification' + - $ref: '#/components/schemas/NiddUplinkDataNotification' + - $ref: '#/components/schemas/NiddDownlinkDataDeliveryStatusNotification' + - $ref: '#/components/schemas/GmdNiddDownlinkDataDeliveryNotification' + - $ref: '#/components/schemas/ManagePortNotification' + responses: + '204': + description: Expected response to a successful callback processing without a body + '200': + description: Expected response to a successful callback processing with a body + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/configurations/{configurationId}: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying the individual NIDD configuration resource in the SCEF. + in: path + required: true + schema: + type: string + get: + summary: Read an NIDD configuration resource. + operationId: FetchIndNIDDConfiguration + tags: + - Individual NIDD configuration + responses: + '200': + description: The individual NIDD configuration is successfully retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddConfiguration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + patch: + summary: Modify an existing NIDD configuration resource. + operationId: ModifyNIDDConfiguration + tags: + - Individual NIDD configuration + requestBody: + description: Contains information to be applied to the individual NIDD configuration. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NiddConfigurationPatch' + responses: + '200': + description: > + The Individual NIDD configuration is modified successfully and a representation + of that resource is returned. + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/NiddConfiguration' + '204': + description: > + The Individual NIDD configuration is modified successfully and no content + is to be sent in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing NIDD configuration resource. + operationId: DeleteNIDDConfiguration + tags: + - Individual NIDD configuration + responses: + '204': + description: The Individual NIDD configuration is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying the individual NIDD configuration resource in the SCEF. + in: path + required: true + schema: + type: string + get: + summary: Read all pending NIDD downlink data delivery resources related to a particular NIDD + configuration resource. + +``` + +``` +operationId: FetchAllDownlinkDataDeliveries +tags: + - NIDD downlink data deliveries +responses: + '200': + description: all NIDD downlink data deliveries. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + minItems: 0 + description: individual NIDD downlink data delivery. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +post: + summary: Create an NIDD downlink data delivery resource related to a particular NIDD +configuration resource. + operationId: CreateDownlinkDataDelivery + tags: + - NIDD downlink data deliveries + requestBody: + description: Contains the data to create a NIDD downlink data delivery. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + responses: + '200': + description: NIDD downlink data delivery is successful. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + '201': + description: NIDD downlink data delivery is pending. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The NIDD downlink data delivery request was not successful. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataDeliveryFailure' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId}: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying the individual NIDD configuration resource in the SCEF. + in: path + required: true + schema: + type: string + - name: downlinkDataDeliveryId + description: String identifying the individual NIDD downlink data delivery in the SCEF. + in: path + required: true + schema: + type: string + get: + summary: Read pending NIDD downlink data delivery resource. + operationId: FetchIndDownlinkDataDelivery + tags: + - Individual NIDD downlink data delivery + responses: + '200': + description: The individual NIDD downlink data delivery is successfully retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Replace an NIDD downlink data delivery resource. + operationId: UpdateIndDownlinkDataDelivery + tags: + +``` + +``` +- Individual NIDD downlink data delivery +requestBody: + description: > + Contains information to be applied to the individual NIDD downlink data delivery. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' +responses: + '200': + description: > + The pending NIDD downlink data is replaced successfully but delivery is pending. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + '204': + description: > + The NIDD downlink data delivery has been replaced successfully and no content + is to be sent in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The NIDD downlink data replacement request was not successful. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataDeliveryFailure' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + summary: Modify an existing Individual NIDD downlink data delivery resource. + operationId: ModifyIndDownlinkDataDelivery + tags: + - Individual NIDD downlink data delivery + requestBody: + description: > + Contains the parameters to update an individual NIDD downlink data delivery resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransferPatch' + responses: + '200': + description: > + OK. The modification of the Individual NIDD downlink data delivery resource was + successful and an updated representation of the resource within the + NiddDownlinkDataTransfer data structure in the response message body is returned + by the SCEF. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + '204': +``` + +``` + +description: > + No Content. The modification of the Individual NIDD downlink data delivery resource + was successful and no content is to be sent in the response message body. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + description: > + Internal Server Error. The NIDD downlink data modification request was not successful. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataDeliveryFailure' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an NIDD downlink data delivery resource. + operationId: DeleteIndDownlinkDataDelivery + tags: + - Individual NIDD downlink data delivery + responses: + '204': + description: The pending NIDD downlink data is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The NIDD downlink data cancellation request was not successful. + content: + application/json: + schema: + $ref: '#/components/schemas/NiddDownlinkDataDeliveryFailure' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/configurations/{configurationId}/rds-ports: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + +``` + +``` + +- name: configurationId + description: String identifying the individual NIDD configuration resource in the SCEF. + in: path + required: true + schema: + type: string +get: + summary: Read all RDS ManagePort Configurations. + operationId: FetchAllManagePortConfigurations + tags: + - ManagePort Configurations + responses: + '200': + description: all ManagePort configurations. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ManagePort' + minItems: 0 + description: individual ManagePort configuration. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/configurations/{configurationId}/rds-ports/{portId}: + parameters: + - name: scsAsId + description: String identifying the SCS/AS. + in: path + required: true + schema: + type: string + - name: configurationId + description: String identifying the individual NIDD configuration resource in the SCEF. + in: path + required: true + schema: + type: string + - name: portId + description: The UE port number. + in: path + required: true + schema: + type: string + pattern: '^(ue([0-9]|(1[0-5]))-ef([0-9]|(1[0-5])) )$' +get: + summary: Read an Individual ManagePort Configuration resource to query port numbers. + operationId: FetchIndManagePortConfiguration + tags: + - Individual ManagePort Configuration + responses: + '200': + description: The individual ManagePort configuration is successfully retrieved. + content: + application/json: + schema: + $ref: '#/components/schemas/ManagePort' + '307': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + summary: Create a new Individual ManagePort Configuration resource to reserve port numbers. + operationId: UpdateIndManagePortConfiguration + tags: + - Individual ManagePort Configuration + requestBody: + description: Contains information to be applied to the individual ManagePort configuration. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ManagePort' + responses: + '201': + description: The individual ManagePort configuration is created. + content: + application/json: + schema: + $ref: '#/components/schemas/ManagePort' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '202': + description: The request is accepted and under processing. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The request was not successful. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/RdsDownlinkDataDeliveryFailure' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an Individual ManagePort Configuration resource to release port numbers. + +``` + +``` +operationId: DeleteIndManagePortConfiguration +tags: + - Individual ManagePort Configuration +responses: + '202': + description: The request is accepted and under processing. + '204': + description: The individual ManagePort configuration is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29122_CommonData.yaml#/components/responses/409' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The request was not successful. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/RdsDownlinkDataDeliveryFailure' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + NiddConfiguration: + description: Represents the configuration for NIDD. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtcProviderId: + type: string + description: Identifies the MTC Service Provider and/or MTC Application. + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + duration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + reliableDataService: + type: boolean + description: > + Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS + 23.682) acknowledgement is requested (true) or not (false). Default value is false. + rdsPorts: + type: array + items: + $ref: '#/components/schemas/RdsPort' + minItems: 1 + description: > + Indicates the static port configuration that is used for reliable data transfer between + specific applications using RDS (as defined in clause 5.2.4 and + 5.2.5 of 3GPP TS 24.250). +``` + +``` +pdnEstablishmentOption: + $ref: '#/components/schemas/PdnEstablishmentOptions' +notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' +requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined + in clause 5.2.5.3. Set to false or omitted otherwise. +websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' +maximumPacketSize: + type: integer + minimum: 1 + description: > + The Maximum Packet Size is the maximum NIDD packet size that was transferred to + the UE by the SCEF in the PCO, see clause 4.5.14.1 of 3GPP TS 23.682. If no maximum + packet size was provided to the UE by the SCEF, the SCEF sends a default configured + max packet size to SCS/AS. Unit bit. + readOnly: true +niddDownlinkDataTransfers: + type: array + items: + $ref: '#/components/schemas/NiddDownlinkDataTransfer' + minItems: 1 + description: > + The downlink data deliveries that needed to be executed by the SCEF. The cardinality of + the property shall be 0..1 in the request and 0..N in the response (i.e. response may + contain multiple buffered MT NIDD). + status: + $ref: '#/components/schemas/NiddStatus' + required: + - notificationDestination + oneOf: + - required: [externalId] + - required: [msisdn] + - required: [externalGroupId] + +NiddDownlinkDataTransfer: + description: Represents the received NIDD downlink data from the SCS/AS. + type: object + properties: + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + reliableDataService: + type: boolean + description: > + Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS + 23.682) acknowledgement is requested (true) or not (false). Default value is false. + rdsPort: + $ref: '#/components/schemas/RdsPort' + maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + priority: + type: integer + description: > + It is used to indicate the priority of the non-IP data packet relative to other + non-IP data packets. + pdnEstablishmentOption: + $ref: '#/components/schemas/PdnEstablishmentOptions' + deliveryStatus: + $ref: '#/components/schemas/DeliveryStatus' + requestedRetransmissionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - data + oneOf: + - required: [externalId] + - required: [msisdn] + - required: [externalGroupId] +``` + +``` +NiddUplinkDataNotification: + description: Represents NIDD uplink data to be notified to the SCS/AS. + type: object + properties: + niddConfiguration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + reliableDataService: + type: boolean + description: > + Indicates whether the reliable data service acknowledgement is requested (true) or + not (false). + rdsPort: + $ref: '#/components/schemas/RdsPort' + required: + - niddConfiguration + - data + oneOf: + - required: [externalId] + - required: [msisdn] + +NiddDownlinkDataDeliveryStatusNotification: + description: Represents the delivery status of a specific NIDD downlink data delivery. + type: object + properties: + niddDownlinkDataTransfer: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + deliveryStatus: + $ref: '#/components/schemas/DeliveryStatus' + requestedRetransmissionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - niddDownlinkDataTransfer + - deliveryStatus + +NiddConfigurationStatusNotification: + description: Represents an NIDD configuration status notification. + type: object + properties: + niddConfiguration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + status: + $ref: '#/components/schemas/NiddStatus' + rdsCapIndication: + type: boolean + description: > + It indicates whether the network capability for the reliable data service is enabled + or not. + rdsPort: + $ref: '#/components/schemas/RdsPort' + required: + - niddConfiguration + - status + oneOf: + - required: [externalId] + - required: [msisdn] + +GmdNiddDownlinkDataDeliveryNotification: + description: Represents the delivery status of a specific group NIDD downlink data delivery. + type: object + properties: + niddDownlinkDataTransfer: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + gmdResults: + type: array + items: + $ref: '#/components/schemas/GmdResult' + minItems: 1 +``` + +``` + description: Indicates the group message delivery result. + required: + - niddDownlinkDataTransfer + - gmdResults + +RdsPort: + description: Represents the port configuration for Reliable Data Transfer. + type: object + properties: + portUE: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + portSCEF: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + required: + - portUE + - portSCEF + +GmdResult: + description: Represents the group message delivery result. + type: object + properties: + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + deliveryStatus: + $ref: '#/components/schemas/DeliveryStatus' + requestedRetransmissionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - deliveryStatus + oneOf: + - required: [externalId] + - required: [msisdn] + +NiddDownlinkDataDeliveryFailure: + description: Represents information related to a failure delivery result. + type: object + properties: + problemDetail: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + requestedRetransmissionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - problemDetail + +ManagePort: + description: Represents the configuration of a RDS dynamic port management. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + appId: + type: string + description: Identifies the application. + manageEntity: + $ref: '#/components/schemas/ManageEntity' + skipUeInquiry: + type: boolean + description: Indicate whether to skip UE inquiry. + supportedFormats: + type: array + items: + $ref: '#/components/schemas/SerializationFormat' + minItems: 1 + description: > + Indicates the serialization format(s) that are supported by the SCS/AS on the associated + RDS port. + configuredFormat: + $ref: '#/components/schemas/SerializationFormat' + required: + - appId + +ManagePortNotification: + description: Represents a ManagePort notification of port numbers that are reserved. + type: object + properties: + niddConfiguration: +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + managedPorts: + type: array + items: + $ref: '#/components/schemas/ManagePort' + minItems: 1 + description: Indicates the reserved RDS port configuration information. + required: + - niddConfiguration + oneOf: + - required: [externalId] + - required: [msisdn] + +RdsDownlinkDataDeliveryFailure: + description: Represents the failure delivery result for RDS. + allOf: + - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + - type: object + properties: + requestedRetransmissionTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + supportedUeFormats: + type: array + items: + $ref: '#/components/schemas/SerializationFormat' + minItems: 1 + description: > + Indicates the serialization format(s) that are supported by the UE on the associated + RDS port. + +NiddDownlinkDataTransferPatch: + description: > + Represents the parameters to request the modification of an Individual NIDD Downlink Data + Delivery resource. + type: object + properties: + data: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + reliableDataService: + type: boolean + description: > + Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS + 23.682) acknowledgement is requested (true) or not (false). + rdsPort: + $ref: '#/components/schemas/RdsPort' + maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + priority: + type: integer + description: > + It is used to indicate the priority of the non-IP data packet relative to other + non-IP data packets. + pdnEstablishmentOption: + $ref: '#/components/schemas/PdnEstablishmentOptions' + +PdnEstablishmentOptions: + anyOf: + - type: string + enum: + - WAIT_FOR_UE + - INDICATE_ERROR + - SEND_TRIGGER + - type: string + description: > + 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. + description: | + Represents PDN establishment options that describe the network behaviour when + there is no PDN connection towards the addressed UE. + Possible values are: + - WAIT_FOR_UE: wait for the UE to establish the PDN connection + - INDICATE_ERROR: respond with an error cause + - SEND_TRIGGER: send a device trigger + +``` + +``` + +PdnEstablishmentOptionsRm: + description: > + Represents the same information as the PdnEstablishmentOptions data type with the + difference that it allows also the null value. + anyOf: + - $ref: '#/components/schemas/PdnEstablishmentOptions' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + +DeliveryStatus: + anyOf: + - type: string + enum: + - SUCCESS + - SUCCESS_NEXT_HOP_ACKNOWLEDGED + - SUCCESS_NEXT_HOP_UNACKNOWLEDGED + - SUCCESS_ACKNOWLEDGED + - SUCCESS_UNACKNOWLEDGED + - TRIGGERED + - BUFFERING + - BUFFERING_TEMPORARILY_NOT_REACHABLE + - SENDING + - FAILURE + - FAILURE_RDS_DISABLED + - FAILURE_NEXT_HOP + - FAILURE_TIMEOUT + - FAILURE_TEMPORARILY_NOT_REACHABLE + - type: string + description: > + 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. + description: | + Represents the status of a downlink NIDD data delivery resource. + Possible values are: + - SUCCESS: Success but details not provided + - SUCCESS_NEXT_HOP_ACKNOWLEDGED: Successful delivery to the next hop with acknowledgment. + - SUCCESS_NEXT_HOP_UNACKNOWLEDGED: Successful delivery to the next hop without + acknowledgment + - SUCCESS_ACKNOWLEDGED: Reliable delivery was acknowledged by the UE + - SUCCESS_UNACKNOWLEDGED: Reliable delivery was not acknowledged by the UE + - TRIGGERED: The SCEF triggered the device and is buffering the data. + - BUFFERING: The SCEF is buffering the data due to no PDN connection established. + - BUFFERING_TEMPORARILY_NOT_REACHABLE: The SCEF has been informed that the UE is temporarily + not reachable but is buffering the data + - SENDING: The SCEF has forwarded the data, but they may be stored elsewhere + - FAILURE: Delivery failure but details not provided + - FAILURE_RDS_DISABLED: RDS was disabled + - FAILURE_NEXT_HOP: Unsuccessful delivery to the next hop. + - FAILURE_TIMEOUT: Unsuccessful delivery due to timeout. + - FAILURE_TEMPORARILY_NOT_REACHABLE: The SCEF has been informed that the UE is temporarily + not reachable without buffering the data. + readOnly: true + +NiddStatus: + anyOf: + - type: string + enum: + - ACTIVE + - TERMINATED_UE_NOT_AUTHORIZED + - TERMINATED + - RDS_PORT_UNKNOWN + - type: string + description: > + 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. + description: | + Represents the status of a NIDD configuration. + Possible values are: + - ACTIVE: The NIDD configuration is active. + - TERMINATED_UE_NOT_AUTHORIZED: The NIDD configuration was terminated because the UE's + authorisation was revoked. + - TERMINATED: The NIDD configuration was terminated. + - RDS_PORT_UNKNOWN: The RDS port is unknown. + readOnly: true + +ManageEntity: + +``` + +``` + +anyOf: +- type: string + enum: + - UE + - AS +- type: string + description: > + 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. +description: | + Represents the origin that manages the RDS port. + Possible values are: + - UE: Representing the UE. + - AS: Representing the Application Server. +readOnly: true + +SerializationFormat: +anyOf: +- type: string + enum: + - CBOR + - JSON + - XML +- type: string + description: > + 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. +description: | + Represents a serialization format associated with an RDS port which is applicable + for the Rds_serialization_format feature. + Possible values are + - CBOR: The CBOR Serialzition format + - JSON: The JSON Serialzition format + - XML: The XML Serialzition format + +NiddConfigurationPatch: +description: Represents the parameters to update a NIDD configuration. +type: object +properties: + duration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRm' + reliableDataService: + type: boolean + description: > + Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS + 23.682) acknowledgement is requested (true) or not (false). + nullable: true + rdsPorts: + type: array + items: + $ref: '#/components/schemas/RdsPort' + minItems: 1 + description: > + Indicates the static port configuration that is used for reliable data transfer between + specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 + of 3GPP TS 24.250). + pdnEstablishmentOption: + $ref: '#/components/schemas/PdnEstablishmentOptionsRm' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + +``` + +## A.7 DeviceTriggering API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-device-triggering + version: 1.3.0-alpha.1 + description: | + API for device trigger. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` +externalDocs: + description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/3gpp-device-triggering/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/transactions: + get: + summary: read all active device triggering transactions for a given SCS/AS. + operationId: FetchAllDeviceTriggeringTransactions + tags: + - Device Triggering Transactions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + responses: + '200': + description: > + OK (Successful get all of the active device triggering transactions for the SCS/AS) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DeviceTriggering' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + post: + summary: Create a long-term transaction for a device triggering. + operationId: CreateDeviceTriggeringTransaction + tags: + - Device Triggering API Transactions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + requestBody: + description: Parameters to request a device triggering delivery. + required: true + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/DeviceTriggering' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggeringDeliveryReportNotification' + responses: + '200': + description: OK (successful notification) + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement' + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Created (Successful creation of subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + +``` + +``` +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/transactions/{transactionId}: + get: + summary: Read a device triggering transaction resource. + operationId: FetchIndDeviceTriggeringTransaction + tags: + - Individual Device Triggering Transaction + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + - name: transactionId + in: path + description: Identifier of the transaction resource + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get the active subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Replace an existing device triggering transaction resource and the corresponding device trigger request. + operationId: UpdateIndDeviceTriggeringTransaction + tags: + - Individual Device Triggering Transaction + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + - name: transactionId + in: path + description: Identifier of the transaction resource + required: true + schema: + type: string + requestBody: + description: Parameters to update/replace the existing device triggering + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' +``` + +``` +responses: + '200': + description: OK (Successful update of the device triggering) + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' + '204': + description: No Content (Successful update of the device triggering) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an existing Individual Device Triggering Transaction resource and the +corresponding device triggering request. + operationId: ModifyIndDeviceTriggeringTransaction + tags: + - Individual Device Triggering Transaction + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + - name: transactionId + in: path + description: Identifier of the transaction resource + required: true + schema: + type: string + requestBody: + description: Parameters to request the modification of the existing Individual Device +Triggering Transaction resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggeringPatch' + responses: + '200': + description: > + OK. The Individual Device Triggering Transaction resource was successfully modified + and a representation of the modified Individual Device Triggering Transaction resource + within the DeviceTriggering data structure including the "deliveryResult" attribute is + returned by the SCEF. + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' + '204': + description: > + No Content. The Individual Device Triggering Transaction resource was successfully + modified no content is returned in the response message body. + '307': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes an already existing device triggering transaction. + operationId: DeleteIndDeviceTriggeringTransaction + tags: + - Individual Device Triggering Transaction + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + - name: transactionId + in: path + description: Identifier of the transaction resource + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing subscription) + '200': + description: OK (Successful deletion of the existing subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/DeviceTriggering' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + +``` + +``` +clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + DeviceTriggering: + description: Represents device triggering related information. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + priority: + $ref: '#/components/schemas/Priority' + applicationPortId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + appSrcPortId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + triggerPayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined in + clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + deliveryResult: + $ref: '#/components/schemas/DeliveryResult' + required: + - validityPeriod + - priority + - applicationPortId + - triggerPayload + - notificationDestination + oneOf: + - required: [externalId] + - required: [msisdn] + + DeviceTriggeringDeliveryReportNotification: + description: Represents a device triggering delivery report notification. + type: object + properties: + transaction: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + result: + $ref: '#/components/schemas/DeliveryResult' + required: + - transaction + - result + + DeviceTriggeringPatch: + description: Represents device triggering related information. + type: object + properties: + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + priority: + $ref: '#/components/schemas/Priority' + applicationPortId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + appSrcPortId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + triggerPayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean +``` + +``` + + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined + in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + + DeliveryResult: + anyOf: + - type: string + enum: + - SUCCESS + - UNKNOWN + - FAILURE + - TRIGGERED + - EXPIRED + - UNCONFIRMED + - REPLACED + - TERMINATE + - type: string + description: > + 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. + description: | + Represents the result of the delivery of a device triggering request. + Possible values are: + - SUCCESS: This value indicates that the device action request was successfully completed. + - UNKNOWN: This value indicates any unspecified errors. + - FAILURE: This value indicates that this trigger encountered a delivery error and is deemed + permanently undeliverable. + - TRIGGERED: This value indicates that device triggering request is accepted by the SCEF. + - EXPIRED: This value indicates that the validity period expired before the trigger could + be delivered. + - UNCONFIRMED: This value indicates that the delivery of the device action request is not + confirmed. + - REPLACED: This value indicates that the device triggering replacement request is accepted + by the SCEF. + - TERMINATE: This value indicates that the delivery of the device action request is + terminated by the SCS/AS. + readOnly: true + + Priority: + anyOf: + - type: string + enum: + - NO_PRIORITY + - PRIORITY + - type: string + description: > + 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. + description: | + Represents the priority indication for a trigger payload. + Possible values are: + - NO_PRIORITY: This value indicates that the device trigger has no priority. + - PRIORITY: This value indicates that the device trigger has priority. + +``` + +## A.8 GMDViaMBMS APIs + +### A.8.1 GMDViaMBMSbyMB2 API + +``` + +openapi: 3.0.0 +info: + title: GMDViaMBMSbyMB2 + description: | + API for Group Message Delivery via MBMS by MB2 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: 1.3.0-alpha.1 +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: + +``` + +``` +- {} +- oAuth2ClientCredentials: [] +servers: +- url: '{apiRoot}/3gpp-group-message-delivery-mb2/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +paths: + /{scsAsId}/tmgi-allocation: + get: + summary: read all TMGI Allocation resource for a given SCS/AS + operationId: FetchAllTMGIAllocations + tags: + - TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of TMGI Allocation resource) + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Creates a new TMGI Allocation resource for a given SCS/AS. + operationId: CreateTMGIAllocation + tags: + - TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + requestBody: + description: representation of the TMGI Allocation to be created in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + responses: + '201': + description: successful creation of an TMGI Allocation + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' +``` + +``` +headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/tmgi-allocation/{tmgi}: + get: + summary: Read a TMGI Allocation resource for a given SCS/AS and a TMGI. + operationId: FetchIndTMGIAllocation + tags: + - Individual TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of TMGI Allocation resource) + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` +put: + summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI. + operationId: UpdateIndTMGIAllocation + tags: + - Individual TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + requestBody: + description: representation of the TMGI Allocation to be updated in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + responses: + '200': + description: successful creation of an TMGI Allocation + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + '204': + description: > + The TMGI expiration time renewal is successful, and no content is to be sent in + the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates an existing TMGI Allocation resource for a given SCS/AS and a TMGI. + operationId: ModifyIndTMGIAllocation + tags: + - Individual TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI +``` + +``` + required: true + schema: + type: string + requestBody: + description: representation of the TMGI Allocation to be updated in the SCEF + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/TMGIAllocationPatch' + responses: + '200': + description: successful creation of an TMGI Allocation + content: + application/json: + schema: + $ref: '#/components/schemas/TMGIAllocation' + '204': + description: > + The TMGI expiration time renewal is successful, and no content is to be sent + in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an existing TMGI Allocation resource for a given SCS/AS and a TMGI. + operationId: DeleteTMGIAllocation + tags: + - Individual TMGI Allocation Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + responses: + '204': + description: No Content, successful deletion of an TMGI Allocation + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/tmgi-allocation/{tmgi}/delivery-via-mbms: + get: + summary: Read all group message delivery via MBMS resource for a given SCS/AS and a TMGI. + operationId: FetchAllGMDViaMBMSByMB2 + tags: + - Delivery via MBMS Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of Delivery via MBMS resource) + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + post: + summary: Creates a new delivery via MBMS for a given SCS/AS and a TMGI. + operationId: CreateGMDViaMBMSByMB2 + tags: + - Delivery via MBMS Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + +``` + +``` + + type: string + requestBody: + description: representation of the GMD via MBMS by MB2 resource to be Created in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + callbacks: + gMDByMb2Notification: + "{$request.body#/notificationDestination}": + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GMDByMb2Notification' + responses: + '200': + description: OK (The successful acknowledgement of the notification with a body) + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement' + '204': + description: successful notification + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: successful creation of an GMD via MBMS by MB2 resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + +``` + +``` + + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/tmgi-allocation/{tmgi}/deliVery-via-mbms/{transactionId}: + get: + summary: Read all group message delivery via MBMS resource for a given SCS/AS and a TMGI. + operationId: FetchIndDeliveryViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of an Delivery via MBMS resource) + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Updates a existing delivery via MBMS for a given SCS/AS, a TMGI and transaction Id. + operationId: UpdateIndDeliveryViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + +``` + +``` + +- name: tmgi + in: path + description: TMGI + required: true + schema: + type: string +- name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string +requestBody: + description: representation of the GMD via MBMS by MB2 resource to be updated in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' +responses: + '200': + description: successful update of an individual GMD via MBMS by MB2 resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + '204': + description: > + The group message delivery is replaced successfully, and no content is to be sent + in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates a existing delivery via MBMS for a given SCS/AS, a TMGI and transaction Id. + operationId: ModifyIndDeliveryViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + +``` + +``` + + required: true + schema: + type: string + requestBody: + description: representation of the GMD via MBMS by MB2 resource to be udpated in the SCEF + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2Patch' + responses: + '200': + description: successful update of an individual GMD via MBMS by MB2 resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByMb2' + '204': + description: > + The group message delivery is modified successfully, and no content is to be sent + in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a delivery via MBMS resource for a given SCS/AS, a TMGI and a transcation Id. + operationId: DeleteIndDeliveryViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: tmgi + in: path + description: TMGI + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + responses: + '204': + description: No Content, successful deletion of an resouce of deliery via MBMS + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + TMGIAllocation: + description: Represents an individual TMGI Allocation resource. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + tmgiExpiration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo' + + GMDViaMBMSByMb2: + description: Represents a group message delivery via MBMS by MB2. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as + defined in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + messageDeliveryStartTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + groupMessagePayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + scefMessageDeliveryIPv4: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4AddrRo' + scefMessageDeliveryIPv6: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6AddrRo' + scefMessageDeliveryPort: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PortRo' + required: + - notificationDestination + + GMDByMb2Notification: + description: Represents a group message delivery notification. + type: object + +``` + +``` +properties: + transaction: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + deliveryTriggerStatus: + type: boolean + description: > + Indicates whether delivery of group message payload corresponding to the TMGI was + successful (TRUE) or not (FALSE) +required: + - transaction + - deliveryTriggerStatus + +TMGIAllocationPatch: + description: > + Represents the parameters to request the modification of a TMGI Allocation resource. + type: object + properties: + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + +GMDViaMBMSByMb2Patch: + description: Represents a modification request of a group message delivery via MBMS by MB2. + type: object + properties: + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + messageDeliveryStartTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + groupMessagePayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + +MbmsLocArea: + description: > + Represents a user location area whithin which is sent a group message delivery + via MBMS request. + type: object + properties: + cellId: + type: array + items: + type: string + minItems: 1 + description: > + Indicates a Cell Global Identification of the user which identifies the cell the + UE is registered. + enodeBId: + type: array + items: + type: string + minItems: 1 + description: Indicates an eNodeB in which the UE is currently located. + geographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: Identifies a geographic area of the user where the UE is located. + mbmsServiceAreaId: + type: array + items: + type: string + minItems: 1 + description: Identifies an MBMS Service Area Identity of the user where the UE is located. + civicAddress: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: Identifies a civic address of the user where the UE is located. +``` + +## A.8.2 GMDviaMBMSbyxMB API + +openapi: 3.0.0 + +info: + +title: GMDviaMBMSbyxMB +description: | + API for Group Message Delivery via MBMS by xMB + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +version: 1.3.0-alpha.1 + +externalDocs: + +description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs +url: 'https://www.3gpp.org/ftp/Specs/archive/29\_series/29.122/' + +security: + +- {} +- oAuth2ClientCredentials: [] + +servers: + +- url: '{apiRoot}/3gpp-group-message-delivery-xmb/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + +/{scsAsId}/services: + +get: + +summary: Read all service resources for a given SCS/AS. +operationId: FetchAllxMBServices +tags: + +- Service Operation + +parameters: + +- name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + +responses: + +'200': + description: OK (successful query of service creation resource) + content: + application/json: + schema: + type: array + items: + \$ref: '#/components/schemas/ServiceCreation' + minItems: 0 + description: The service resource for the SCS/AS in the request URI is returned. +'307': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/307' +'308': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/308' +'400': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/400' +'401': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/401' +'403': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/403' +'404': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/404' +'406': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/406' +'429': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/429' +'500': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/500' +'503': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/503' +default: + \$ref: 'TS29122\_CommonData.yaml#/components/responses/default' + +post: + +summary: Creates a new service creation resource for a given SCS/AS. + +``` + +operationId: CreatexMBSERVICE +tags: + - Service Operation +parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string +requestBody: + description: representation of the service to be created in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceCreation' +responses: + '201': + description: successful creation of a service + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceCreation' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/services/{serviceId}: + get: + summary: Read a service resource for a given SCS/AS and a Service Id. + operationId: FetchIndxMBSERVICE + tags: + - Individual Service Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + responses: + '200': + description: OK (successful query of service resource) + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/ServiceCreation' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an existing service resource for a given SCS/AS and a service id. + operationId: DeletexMBService + tags: + - Individual Service Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + responses: + '204': + description: No Content, successful deletion of a service resource + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/services/{serviceId}/delivery-via-mbms: + get: + summary: Read all group message delivery via MBMS resource for a given SCS/AS and a service +id. + operationId: FetchAllGMDViaMBMS + tags: + - Delivery via MBMS Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + +``` + +``` + + schema: + type: string +- name: serviceId + in: path + description: Service Id + required: true + schema: + type: string +responses: + '200': + description: OK (successful query of Delivery via MBMS resource) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Creates a new delivery via MBMS for a given SCS/AS and a service Id. + operationId: CreateGMDViaMBMS + tags: + - Delivery via MBMS Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + requestBody: + description: representation of the GMD via MBMS by xMB resource to be Created in the SCEF + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + callbacks: + gMDByxMBNotification: + '{ $request.body#/notificationDestination }': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/GMDByxMBNotification' + responses: + '200': + +``` + +``` + + description: OK (The successful acknowledgement of the notification with a body) + content: + application/json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement' + '204': + description: successful notification + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + responses: + '201': + description: successful creation of an GMD via MBMS by xMB resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/services/{serviceId}/delivery-via-mbms/{transactionId}: + get: + summary: Read all group message delivery via MBMS resource for a given SCS/AS and a service + Id. + operationId: FetchIndGMDViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + +``` + +``` + + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string +- name: serviceId + in: path + description: Service Id + required: true + schema: + type: string +- name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string +responses: + '200': + description: OK (successful query of an Delivery via MBMS resource) + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Updates an existing delivery via MBMS for a given SCS/AS, a service Id and +transaction Id. + operationId: UpdateIndGMDViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + requestBody: + description: representation of the GMD via MBMS by xMB resource to be udpated in the SCEF + required: true + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/GMDViaMBMSByxMB' +responses: + '200': + description: successful update of an individual GMD via MBMS by xMB resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + '204': + description: > + The group message delivery was modified successfully, and no content is to be sent + in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates an existing delivery via MBMS for a given SCS/AS, a service Id and +transaction Id. + operationId: ModifyIndGMDViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + requestBody: + description: representation of the GMD via MBMS by xMB resource to be udpated in the SCEF + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMBPatch' +responses: + '200': + description: successful update of an individual GMD via MBMS by xMB resource + content: + application/json: + schema: + $ref: '#/components/schemas/GMDViaMBMSByxMB' + +``` + +``` +'204': + description: > + The group message delivery was modified successfully, and no content is to be sent + in the response message body. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a delivery via MBMS resource for a given SCS/AS, a service Id and a +transcation Id. + operationId: DeleteIndGMDViaMBMS + tags: + - Individual Delivery via MBMS resource Operation + parameters: + - name: scsAsId + in: path + description: Identifier of SCS/AS + required: true + schema: + type: string + - name: serviceId + in: path + description: Service Id + required: true + schema: + type: string + - name: transactionId + in: path + description: Identifier of transaction + required: true + schema: + type: string + responses: + '204': + description: No Content, successful deletion of an resouce of deliery via MBMS + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ServiceCreation: + description: Represents an individual xMB Service resource. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + userServiceId: + type: string + description: Identifies the MBMS User Service supplied by the SCEF. + readOnly: true + serviceClass: + type: string + description: The service class that service belongs to supplied by the SCEF. + readOnly: true + serviceLanguages: + type: array + items: + type: string + minItems: 1 + description: List of language of the service content supplied by the SCEF. + readOnly: true + serviceNames: + type: array + items: + type: string + minItems: 1 + description: List of Service Names supplied by the SCEF. + readOnly: true + receiveOnlyMode: + type: boolean + description: > + When set to 'true', the Content Provider indicates that the service is a Receive Only + Mode service. This parameter is supplied by the SCEF. + readOnly: true + serviceAnnouncementMode: + $ref: '#/components/schemas/ServiceAnnouncementMode' + + GMDViaMBMSByxMB: + description: Represents a group message delivery via MBMS by xMB. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined + in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + messageDeliveryStartTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + messageDeliveryStopTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + groupMessagePayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + scefMessageDeliveryIPv4: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4AddrRo' +``` + +``` + scefMessageDeliveryIPv6: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6AddrRo' + scefMessageDeliveryPort: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PortRo' + required: + - notificationDestination + +GMDBByxMBNotification: + description: Represents a group message delivery notification. + type: object + properties: + transaction: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + deliveryTriggerStatus: + type: boolean + description: > + Indicates whether delivery of group message payload was successful(TRUE) or not (FALSE). + required: + - transaction + - deliveryTriggerStatus + +GMDViaMBMSByxMBPatch: + description: Represents a modification request of a group message delivery via MBMS by xMB. + type: object + properties: + mbmsLocArea: + $ref: '#/components/schemas/MbmsLocArea' + messageDeliveryStartTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + messageDeliveryStopTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + groupMessagePayload: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + +MbmsLocArea: + description: > + Represents a user location area whithin which is sent a group message delivery via MBMS + request. + type: object + properties: + cellId: + type: array + items: + type: string + minItems: 1 + description: > + Indicates a Cell Global Identification of the user which identifies the cell the UE is + registered. + enodeBId: + type: array + items: + type: string + minItems: 1 + description: Indicates an eNodeB in which the UE is currently located. + geographicArea: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: Identifies a geographic area of the user where the UE is located. + mbmsServiceAreaId: + type: array + items: + type: string + minItems: 1 + description: Identifies an MBMS Service Area Identity of the user where the UE is located. + civicAddress: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: Identifies a civic address of the user where the UE is located. + +ServiceAnnouncementMode: + anyOf: + - type: string +``` + +``` + +enum: + - SACH + - CONTENT_PROVIDER +- type: string +description: > + 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. +description: | + Represents the service announcement mode. + Possible values are: + - SACH: BM-SC performs the service announcement for the current service using the + SACH channel. + - CONTENT_PROVIDER: BM-SC provides the necessary service access information used by + the Content Provider to create the service announcement information. +readOnly: true + +``` + +## A.9 ReportingNetworkStatus API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-network-status-reporting + version: 1.3.0-alpha.1 + description: | + API for reporting network status. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.1.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-net-stat-report/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/subscriptions: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + get: + summary: Read all network status reporting subscription resources for a given SCS/AS. + operationId: FetchAllNwStatusReportSubscriptions + tags: + - Network Status Reporting Subscriptions + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Create a new network status reporting subscription resource. + operationId: CreateNwStatusReportSubscription + tags: + - Network Status Reporting Subscriptions + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +responses: + '201': + description: > + The subscription was created successfully. The URI of the created resource shall be + returned in the "Location" HTTP header. + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' +``` + +``` + + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/subscriptions/{subscriptionId}: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId' + - name: subscriptionId + in: path + description: Identifier of the subscription resource of type string + required: true + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ResourceId' + get: + summary: Read an active network status reporting subscription resource. + operationId: FetchIndNwStatusReportSubscription + tags: + - Individual Network Status Reporting subscription + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Modify an existing subscription resource to update a subscription. + operationId: UpdateIndNwStatusReportSubscription + tags: + +``` + +``` + +- Individual Network Status Reporting subscription +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' +responses: + '200': + description: The subscription was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + '204': + description: No Content. The subscription was updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + summary: Modify an existing Individual Network Status Reporting Subscription resource. + operationId: ModifyIndNwStatusReportSubscription + tags: + - Individual Network Status Reporting Subscription + requestBody: + description: > + Contains the parameters to modify an existing Individual Network Status Reporting + Subscription resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NetStatusRepSubsPatch' + responses: + '200': + description: > + OK. The modification of the Individual Network Status Reporting Subscription resource + was successfull. The SCEF shall return an updated representation of the resource within + the NetworkStatusReportingSubscription data structure in the response message body. + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkStatusReportingSubscription' + '204': + description: > + No Content. The modification of the Individual Network Status Reporting Subscription + resource was successfull and no content is to be sent in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + +``` + +``` + + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete an existing continuous network status reporting subscription resource. + operationId: DeleteIndNwStatusReportSubscription + tags: + - Individual Network Status Reporting subscription + responses: + '204': + description: The subscription was updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + NetworkStatusReportingSubscription: + description: Represents a subscription to network status information reporting. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined in + clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + locationArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea' + timeDuration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + +``` + +``` +thresholdValues: + type: array + items: + $ref: '#/components/schemas/CongestionValue' + minItems: 1 + description: > + Identifies a list of congestion level(s) with exact value that the SCS/AS requests + to be informed of when reached. +thresholdTypes: + type: array + items: + $ref: '#/components/schemas/CongestionType' + minItems: 1 + description: Identifies a list of congestion level(s) with abstracted value that the +SCS/AS requests to be informed of when reached. +required: + - notificationDestination + - locationArea +not: + required: [thresholdValues, thresholdTypes] + +NetStatusRepSubsPatch: + description: > + Represents the parameters to request the modification of network status reporting + subscription. + type: object + properties: + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + locationArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea' + timeDuration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRm' + thresholdValues: + type: array + items: + $ref: '#/components/schemas/CongestionValue' + minItems: 1 + thresholdTypes: + type: array + items: + $ref: '#/components/schemas/CongestionType' + minItems: 1 + not: + required: [thresholdValues, thresholdTypes] + +NetworkStatusReportingNotification: + description: Represents a network status reporting notification. + type: object + properties: + subscription: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + nsiValue: + $ref: '#/components/schemas/CongestionValue' + nsiType: + $ref: '#/components/schemas/CongestionType' + required: + - subscription + not: + required: [nsiValue, nsiType] + +CongestionValue: + type: integer + minimum: 0 + maximum: 31 + description: > + Unsigned integer with valid values between 0 and 31. The value 0 indicates that there is no + congestion. The value 1 is the lowest congestion level and value 31 is the highest + congestion level. + +CongestionType: + anyOf: + - type: string + enum: + - HIGH + - MEDIUM + - LOW + - type: string +``` + +``` + +description: > + 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. +description: | + Represents abstracted values for congestion status. + Possible values are: + - HIGH: The congestion status is high. + - MEDIUM: The congestion status is medium. + - LOW: The congestion status is low. + +``` + +## A.10 CpProvisioning API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-cp-parameter-provisioning + version: 1.3.0-alpha.4 + description: | + API for provisioning communication pattern parameters. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: [] + +``` + +``` + +servers: + - url: '{apiRoot}/3gpp-cp-parameter-provisioning/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +``` + +``` + +paths: + /{scsAsId}/subscriptions: + get: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + summary: Read all active CP parameter provisioning subscription resources for a given SCS/AS. + operationId: FetchAllCPProvisioningSubscriptions + tags: + - CP provisioning Subscriptions + responses: + '200': + description: OK. The subscription information related to the request URI is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CpInfo' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + +``` + +``` +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +post: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + summary: Create a new subscription resource of provisioning CP parameter set(s). + operationId: CreateCPProvisioningSubscription + tags: + - CP provisioning Subscriptions + requestBody: + description: > + Create new subscriptions for a given SCS/AS and the provisioning CP parameter sets. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CpInfo' + responses: + '201': + description: > + Created. The subscription was created successfully. The SCEF shall return the created + subscription in the response content. + content: + application/json: + schema: + $ref: '#/components/schemas/CpInfo' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: > + The CP parameters for all sets were not created successfully. CpReport may be included + with detailed information. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CpReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/subscriptions/{subscriptionId}: +``` + +``` +get: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + summary: Read a CP parameter provisioning subscription resource. + operationId: FetchIndCPProvisioningSubscription + tags: + - Individual CP Provisioning Subscription + responses: + '200': + description: OK. The subscription information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/CpInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Modify a CP parameter provisioning subscription resource. + operationId: UpdateIndCPProvisioningSubscription + tags: + - Individual CP Provisioning Subscription + requestBody: + description: Modify a CP parameter provisioning subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CpInfo' + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + responses: + '200': + description: > + OK. The subscription was modified successfully. The SCEF shall return an updated + subscription in the response content. + content: +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/CpInfo' +'204': + description: > + No Content. The subscription was modified successfully and no content is to be sent + in the response message body. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + description: > + The CP parameters for all sets were not updated successfully. CpReport may be included + with detailed information. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CpReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + summary: Delete a CP parameter provisioning subscription resource. + operationId: DeleteIndCPProvisioningSubscription + tags: + - Individual CP Provisioning Subscription + responses: + '204': + description: > + No Content. The subscription was deleted successfully. The content shall be empty. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/subscriptions/{subscriptionId}/cpSets/{setId}: + get: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string + - name: setId + in: path + description: Identifier of the CP parameter set + required: true + schema: + type: string + summary: Read CP at individual CP set(s) level associated with a CP parameter set Id. + operationId: FetchIndCPSetProvisioning + tags: + - Individual CP set Provisioning + responses: + '200': + description: OK. The subscription information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/CpParameterSet' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Update CP at individual CP set(s) level associated with a CP parameter set Id. + operationId: UpdateIndCPSetProvisioning + tags: + - Individual CP set Provisioning + requestBody: + description: Change information for a CP parameter set. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CpParameterSet' + parameters: + - name: scsAsId + in: path + +``` + +``` + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string +- name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string +- name: setId + in: path + description: Identifier of the CP parameter set + required: true + schema: + type: string +responses: + '200': + description: > + OK. The CP parameter set resource was modified successfully. The SCEF shall return an + updated CP parameter set resource in the response content. + content: + application/json: + schema: + $ref: '#/components/schemas/CpParameterSet' + '204': + description: > + No Content. The CP parameter set resource was modified successfully and no content + is to be sent in the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + description: The CP parameters for the CP set were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/CpReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The CP parameters for the CP set were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/CpReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: +``` + +``` + + type: string +- name: subscriptionId + in: path + description: Subscription ID + required: true + schema: + type: string +- name: setId + in: path + description: Identifier of the CP parameter set + required: true + schema: + type: string +summary: Delete CP at individual CP set(s) level associated with a CP parameter set Id. +operationId: DeleteIndCPSetProvisioning +tags: +- Individual CP set Provisioning +responses: + '204': + description: > + No Content. The subscription was deleted successfully. The content shall be empty. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + CpInfo: + description: Represents the resources for communication pattern parameter provisioning. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtcProviderId: + type: string + description: Identifies the MTC Service Provider and/or MTC Application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + cpParameterSets: + type: object + additionalProperties: + $ref: '#/components/schemas/CpParameterSet' + minProperties: 1 + description: > + Identifies a set of CP parameter information that may be part of this CpInfo structure. + +``` + +``` + + Any string value can be used as a key of the map. + cpReports: + type: object + additionalProperties: + $ref: '#/components/schemas/CpReport' + minProperties: 1 + description: > + Supplied by the SCEF and contains the CP set identifiers for which CP parameter(s) are + not added or modified successfully. The failure reason is also included. Each element + provides the related information for one or more CP set identifier(s) and is identified + in the map via the failure identifier as key. + readOnly: true + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ueIpAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + required: + - cpParameterSets + oneOf: + - required: [externalId] + - required: [msisdn] + - required: [externalGroupId] + +CpParameterSet: + description: Represents an offered communication pattern parameter set. + type: object + properties: + setId: + type: string + description: > + SCS/AS-chosen correlator provided by the SCS/AS in the request to create a resource + for CP parameter set(s). + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + validityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + periodicCommunicationIndicator: + $ref: '#/components/schemas/CommunicationIndicator' + communicationDurationTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + periodicTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + scheduledCommunicationTime: + $ref: '#/components/schemas/ScheduledCommunicationTime' + scheduledCommunicationType: + $ref: '#/components/schemas/ScheduledCommunicationType' + stationaryIndication: + $ref: '#/components/schemas/StationaryIndication' + batteryInds: + type: array + items: + $ref: '#/components/schemas/BatteryIndication' + minItems: 1 + trafficProfile: + $ref: '#/components/schemas/TrafficProfile' + expectedUmts: + type: array + items: + $ref: '#/components/schemas/UmtLocationArea5G' + minItems: 1 + description: > + Identifies the UE's expected geographical movement. The attribute is only applicable + in 5G. + expectedUmtDays: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DayOfWeek' + expectedUmtDaysAdd: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DayOfWeek' + minItems: 1 + maxItems: 5 + description: Identifies the additional day(s) of the week. + appExpUeBehvs: + type: array + items: + $ref: '#/components/schemas/AppExpUeBehaviour' + +``` + +``` + + minItems: 1 + description: Contains the Application Specific Expected UE Behaviour parameters. + confidenceLevel: + type: string + pattern: '^[0]\.[0-9]{2}|[1.00]$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}|[1.00]$' + required: + - setId + +ScheduledCommunicationTime: + description: Represents an offered scheduled communication time. + type: object + properties: + daysOfWeek: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DayOfWeek' + minItems: 1 + maxItems: 6 + description: > + Identifies the day(s) of the week. If absent, it indicates every day of the week. + timeOfDayStart: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeOfDay' + timeOfDayEnd: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeOfDay' + +CpReport: + description: > + Represents a CP report indicating the CP set identifier(s) which CP parameter(s) are not + added or modified successfully and the corresponding failure cause(s). + type: object + properties: + setIds: + type: array + items: + type: string + minItems: 1 + description: > + Identifies the CP set identifier(s) which CP parameter(s) are not added or modified + successfully + failureCode: + $ref: '#/components/schemas/CpFailureCode' + required: + - failureCode + +UmtLocationArea5G: + description: Represents the user location area describing the UE moving trajectory. + allOf: + - $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + - type: object + properties: + umtTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeOfDay' + umtDuration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + +AppExpUeBehaviour: + description: Contains the Application Specific Expected UE Behaviour parameters. + type: object + properties: + appId: + type: string + description: Indicates the Application Identifier. + expPduSesInacTm: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + flowDescriptions: + type: array + items: + type: string + minItems: 1 + description: > + Represents a 3-tuple with protocol, server ip and server port for UL/DL application + traffic. The content of the string has the same encoding as the IPFilterRule AVP + value as defined in IETF RFC 6733. + confidenceLevel: + type: string + +``` + +``` + pattern: '^[0]\.[0-9]{2}|[1.00]$' + accuracyLevel: + type: string + pattern: '^[0]\.[0-9]{2}|[1.00]$' + failureCode: + $ref: '#/components/schemas/CpFailureCode' + validityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' +oneOf: +- required: [appId] +- required: [flowDescriptions] + +CommunicationIndicator: +anyOf: +- type: string + enum: + - PERIODICALLY + - ON_DEMAND +- type: string + description: > + 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. + description: | + Represents the type of the communication. + Possible values are: + - PERIODICALLY: Identifies the UE communicates periodically + - ON_DEMAND: Identifies the UE communicates on demand + +StationaryIndication: +anyOf: +- type: string + enum: + - STATIONARY + - MOBILE +- type: string + description: > + 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. + description: | + Represents the stationarity of the UE. + Possible values are: + - STATIONARY: Identifies the UE is stationary + - MOBILE: Identifies the UE is mobile + +CpFailureCode: +anyOf: +- type: string + enum: + - MALFUNCTION + - SET_ID_DUPLICATED + - OTHER_REASON + - CONFIDENCE_LEVEL_NOT_SUFFICIENT + - ACCURACY_LEVEL_NOT_SUFFICIENT +- type: string + description: > + 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. + description: | + Represents the failure reason of the CP parameter provisioning. + Possible values are + - MALFUNCTION: This value indicates that something functions wrongly in CP parameter + provisioning or the CP parameter provisioning does not function at all. + - SET_ID_DUPLICATED: The received CP set identifier(s) are already provisioned. + - OTHER_REASON: Other reason unspecified. + - CONFIDENCE_LEVEL_NOT_SUFFICIENT: The received confidence level for the expected UE + parameter is not sufficient. + - ACCURACY_LEVEL_NOT_SUFFICIENT: The received accuracy level for the expected UE parameter + is not sufficient. + +BatteryIndication: +anyOf: +- type: string + enum: + - BATTERY_RECHARGE + - BATTERY_REPLACE +``` + +``` + + - BATTERY_NO_RECHARGE + - BATTERY_NO_REPLACE + - NO_BATTERY + - type: string + description: > + 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. + description: | + Represents the type of power consumption. + Possible values are: + - BATTERY_RECHARGE: UE powered with rechargeable battery. + - BATTERY_REPLACE: UE powered with replaceable battery. + - BATTERY_NO_RECHARGE: UE powered with no rechargeable battery. + - BATTERY_NO_REPLACE: UE powered with no replaceable battery. + - NO_BATTERY: UE not battery powered. + +TrafficProfile: + anyOf: + - type: string + enum: + - SINGLE_TRANS_UL + - SINGLE_TRANS_DL + - DUAL_TRANS_UL_FIRST + - DUAL_TRANS_DL_FIRST + - MULTI_TRANS + - type: string + description: > + 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. + description: | + Represents the type of data transmission. + Possible values are: + - SINGLE_TRANS_UL: Uplink single packet transmission. + - SINGLE_TRANS_DL: Downlink single packet transmission. + - DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission with + subsequent downlink packet transmission. + - DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission with + subsequent uplink packet transmission. + - MULTI_TRANS: Multiple packet transmission. + +ScheduledCommunicationType: + anyOf: + - type: string + enum: + - DOWNLINK + - UPLINK + - BIDIRECTIONAL + - type: string + description: > + 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. + description: | + Represents the type of scheduled communication. + Possible values are: + - DOWNLINK: Downlink only. + - UPLINK: Uplink only. + - BIDIRECTIONAL: Bi-directional. + +``` + +## A.11 PfdManagement API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-pfd-management + version: 1.3.0-alpha.3 + description: | + API for PFD management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + +``` + +``` +url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +``` + +``` +security: +``` + +``` +- {} +- oAuth2ClientCredentials: [] +``` + +``` +servers: +``` + +``` +- url: '{apiRoot}/3gpp-pfd-management/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +``` + +``` +paths: +``` + +``` +/{scsAsId}/transactions: +``` + +``` +parameters: +``` + +``` +- name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string +``` + +``` +get: +``` + +``` +summary: Read all or queried PFDs for a given SCS/AS. +operationId: FetchAllPFDManagementTransactions +tags: +``` + +``` +- PFD Management Transactions +``` + +``` +parameters: +``` + +``` +- name: external-app-ids + in: query + description: The external application identifier(s) of the requested PFD data. + required: false + schema: + type: array + items: + type: string + minItems: 1 +``` + +``` +responses: +``` + +``` +'200': + description: OK. All or queried transactions related to the request URI are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdManagement' +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` +post: +``` + +``` +summary: Create PFDs for a given SCS/AS and one or more external Application Identifier(s). +operationId: CreatePFDManagementTransaction +tags: +``` + +``` +- PFD Management Transactions +``` + +``` +requestBody: +``` + +``` +required: true +content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/PfdManagement' + description: Create a new transaction for PFD management. + responses: + '201': + description: > + Created. The transaction was created successfully. The SCEF shall return the created + transaction in the response content. PfdReport may be included to provide detailed + failure information for some applications. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdManagement' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: > + The PFDs for all applications were not created successfully. PfdReport is included with + detailed information. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdReport' + minItems: 1 + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/transactions/{transactionId}: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: transactionId + in: path + description: Transaction ID + required: true + schema: + type: string + get: + summary: Read all PFDs for a given SCS/AS and a transaction for one or more external + Application Identifier(s). + operationId: FetchIndPFDManagementTransaction + tags: + - Individual PFD Management Transaction + responses: + '200': + description: OK. The transaction information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdManagement' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Update PFDs for a given SCS/AS and a transaction for one or more external Application + Identifier(s). + operationId: UpdateIndPFDManagementTransaction + tags: + - Individual PFD Management Transaction + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdManagement' + description: Change information in PFD management transaction. + +``` + +``` +responses: + '200': + description: > + OK. The transaction was modified successfully. The SCEF shall return an updated + transaction in the response content. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdManagement' + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: > + The PFDs for all applications were not updated successfully. PfdReport is included with + detailed information. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an existing PFD Management Transaction resource. + operationId: ModifyIndPFDManagementTransaction + tags: + - Individual PFD Management Transaction + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PfdManagementPatch' + +responses: + '200': + description: > + OK. The PFD Management Transaction was modified successfully. The SCEF shall return an + updated representation of the resource in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdManagement' + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: > + The PFDs for all applications were not modified successfully. A set of PFD Report(s) is + included with detailed information. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete PFDs for a given SCS/AS and a transaction for one or more external Application +Identifier(s). + operationId: DeleteIndPFDManagementTransaction + tags: + - Individual PFD Management Transaction + responses: + '204': + description: > + No Content. The transaction was deleted successfully. The content shall be empty. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/transactions/{transactionId}/applications/{appId}: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: transactionId + in: path + description: Transaction ID + required: true + schema: + type: string + - name: appId + in: path + description: Identifier of the application + +``` + +``` + required: true + schema: + type: string +get: + summary: Read PFDs at individual application level. + operationId: FetchIndApplicationPFDManagement + tags: + - Individual Application PFD Management + responses: + '200': + description: OK. The application information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + summary: Update PFDs at individual application level. + operationId: UpdateIndApplicationPFDManagement + tags: + - Individual Application PFD Management + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdData' + description: Change information in application. + responses: + '200': + description: > + OK. The application resource was modified successfully. The SCEF shall return an updated + application resource in the response content. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdData' + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '404': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + summary: Update PFDs at individual application level. + operationId: ModifyIndApplicationPFDManagement + tags: + - Individual Application PFD Management + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PfdData' + description: Change information in PFD management transaction. + responses: + '200': + description: > + OK. The transaction was modified successfully. The SCEF shall return an updated + transaction in the response content. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdData' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '409': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The PFDs for the application were not updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdReport' + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: Delete PFDs at individual application level. + operationId: DeleteIndApplicationPFDManagement + tags: + - Individual Application PFD Management + responses: + '204': + description: > + No Content. The application was deleted successfully. The content shall be empty. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + PfdManagement: + description: Represents a PFD management resource for a PFD management request. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pfdDatas: + type: object + additionalProperties: + $ref: '#/components/schemas/PfdData' + minProperties: 1 + +``` + +``` + +description: > + Each element uniquely identifies the PFDs for an external application identifier. + Each element is identified in the map via an external application identifier as key. + The response shall include successfully provisioned PFD data of application(s). +pfdReports: + type: object + additionalProperties: + $ref: '#/components/schemas/PfdReport' + minProperties: 1 + description: > + Supplied by the SCEF and contains the external application identifiers for which PFD(s) + are not added or modified successfully. The failure reason is also included. + Each element provides the related information for one or more external application + identifier(s) and is identified in the map via the failure identifier as key. + readOnly: true + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined + in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + required: + - pfdDatas + +PfdData: + description: > + Represents a PFD request to add, update or remove PFD(s) for one external application + identifier. + type: object + properties: + externalAppId: + type: string + description: Each element uniquely external application identifier + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + pfdData: + type: object + additionalProperties: + $ref: '#/components/schemas/Pfd' + description: > + Contains the PFDs of the external application identifier. Each PFD is identified in + the map via a key containing the PFD identifier. + allowedDelay: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' + cachingTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRo' + required: + - externalAppId + - pfdData + +Pfd: + description: Represents a PFD for an external Application Identifier. + type: object + properties: + pfdId: + type: string + description: Identifies a PFD of an application identifier. + flowDescriptions: + type: array + items: + type: string + minItems: 1 + description: > + Represents a 3-tuple with protocol, server ip and server port for UL/DL application + traffic. The content of the string has the same encoding as the IPFilterRule AVP + value as defined in IETF RFC 6733. + urls: + type: array + items: + type: string + minItems: 1 + description: > + Indicates a URL or a regular expression which is used to match the significant parts + of the URL. + domainNames: + +``` + +``` + type: array + items: + type: string + minItems: 1 + description: Indicates an FQDN or a regular expression as a domain name matching criteria. + dnProtocol: + $ref: '#/components/schemas/DomainNameProtocol' + required: + - pfdId + +PfdReport: + description: > + Represents a PFD report indicating the external application identifier(s) which PFD(s) + are not added or modified successfully and the corresponding failure cause(s). + type: object + properties: + externalAppIds: + type: array + items: + type: string + minItems: 1 + description: > + Identifies the external application identifier(s) which PFD(s) are not added or + modified successfully + failureCode: + $ref: '#/components/schemas/FailureCode' + cachingTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + locationArea: + $ref: '#/components/schemas/UserPlaneLocationArea' + required: + - externalAppIds + - failureCode + +UserPlaneLocationArea: + description: > + Represents location area(s) of the user plane functions which are unable to enforce the + provisioned PFD(s) successfully. + type: object + properties: + locationArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea' + locationArea5G: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 0 + description: Identifies a list of DNAI which the user plane functions support. + +PfdManagementPatch: + description: > + Represents the parameters to request the modification of a PFD management transaction + resource. + type: object + properties: + pfdDatas: + type: object + additionalProperties: + $ref: '#/components/schemas/PfdData' + minProperties: 1 + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + +FailureCode: + anyOf: + - type: string + enum: + - MALFUNCTION + - RESOURCE_LIMITATION + - SHORT_DELAY + - APP_ID_DUPLICATED + - PARTIAL_FAILURE + - OTHER_REASON + - type: string + description: > + 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. +description: | + Represents the failure reason of the PFD management. +Possible values are: +- MALFUNCTION: This value indicates that something functions wrongly in PFD provisioning + or the PFD provisioning does not function at all. +- RESOURCE_LIMITATION: This value indicates there is resource limitation for PFD storage. +- SHORT_DELAY: This value indicates that the allowed delay is too short and PFD(s) + are not stored. +- APP_ID_DUPLICATED: The received external application identifier(s) are already + provisioned. +- PARTIAL_FAILURE: The PFD(s) are not provisioned to all PCEFs/TDFs/SMFs. +- OTHER_REASON: Other reason unspecified. + +DomainNameProtocol: +anyOf: +- type: string + enum: + - DNS_QNAME + - TLS_SNI + - TLS_SAN + - TSL_SCN +- type: string + description: > + 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. +description: | + Represents the type of Domain Name Protocol. +Possible values are: +- DNS_QNAME: Identifies the DNS protocol and the question name in DNS query. +- TLS_SNI: Identifies the Server Name Indication in TLS ClientHello message. +- TLS_SAN: Identifies the Subject Alternative Name in TLS ServerCertificate message. +- TSL_SCN: Identifies the Subject Common Name in TLS ServerCertificate message. + +``` + +## A.12 ECRControl API + +``` + +openapi: 3.0.0 +info: + title: 3gpp-ecr-control + version: 1.2.0 + description: | + API for enhanced coverage restriction control. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: +- {} +- oAuth2ClientCredentials: [] +servers: +- url: '{apiRoot}/3gpp-ecr-control/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +paths: + /query: + post: + summary: Query the status of enhanced coverage restriction for a UE. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ECRControl' + responses: + '200': + description: The requested information was returned successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ECRData' + +``` + +``` +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/configure: + post: + summary: Configure the enhanced coverage restriction for a UE. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ECRControl' + responses: + '200': + description: The Enhanced Coverage Restriction setting was configured successfully.. + content: + application/json: + schema: + $ref: '#/components/schemas/ECRData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +schemas: +``` + +``` + +ECRControl: + description: Represents the parameters to request Enhanced Coverage Restriction control. + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtcProviderId: + type: string + description: Identifies the MTC Service Provider and/or MTC Application. + scsAsId: + type: string + description: Identifier of the SCS/AS. + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + ecrDataWbs: + type: array + items: + $ref: '#/components/schemas/PlmnEcRestrictionDataWb' + minItems: 0 + restrictedPlmnIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + minItems: 0 + description: Indicates a complete list (and possibly empty) of serving PLMNs where +Enhanced Coverage shall be restricted. This attribute shall not be present for the query custom +operation. + allowedPlmnIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + minItems: 0 + description: Indicates a complete list (and possibly empty) of serving PLMNs where +Enhanced Coverage shall be allowed. This attribute shall not be present for the query custom +operation. + required: + - supportedFeatures + oneOf: + - required: [externalId] + - required: [msisdn] + not: + required: [restrictedPlmnIds, allowedPlmnIds] +ECRData: + description: Represents the current visited PLMN (if any) and the current settings of enhanced +coverage restriction. + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + visitedPlmnId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + ecrDataWbs: + type: array + items: + $ref: '#/components/schemas/PlmnEcRestrictionDataWb' + minItems: 0 + restrictedPlmnIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + minItems: 0 + description: Indicates a complete list (and possibly empty) of serving PLMNs where +Enhanced Coverage shall be restricted. + allowedPlmnIds: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + minItems: 0 + description: Indicates a complete list (and possibly empty) of serving PLMNs where +Enhanced Coverage shall be allowed. + required: + - supportedFeatures + not: + required: [restrictedPlmnIds, allowedPlmnIds] +PlmnEcRestrictionDataWb: + description: Indicates whether enhanced coverage mode is restricted or not for a PLMN ID. + +``` + +``` + +type: object +properties: + plmnId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/PlmnId' + plmnEcrDataWb: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/EcRestrictionDataWb' +required: +- plmnId + +``` + +## A.13 NpConfiguration API + +``` + +openapi: 3.0.0 +info: + title: 3gpp-network-parameter-configuration + version: 1.2.0 + description: | + API for network parameter configuration. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: +- {} +- oAuth2ClientCredentials: [] +servers: +- url: '{apiRoot}/3gpp-network-parameter-configuration/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause of 3GPP TS 29.122. +paths: + /{scsAsId}/configurations: + get: + summary: Read all of the active configurations for the SCS/AS. + operationId: FetchAllNPConfigurations + tags: + - Np Configurations + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get all of the active NpConfigurations for the SCS/AS) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NpConfiguration' + minItems: 0 + description: Network Parameter configurations + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Creates a new configuration resource for network parameter configuration. + operationId: CreateNPConfiguration + tags: + - Np Configurations + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + requestBody: + description: new configuration creation + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigurationNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +responses: + '201': + description: Created (Successful creation of configuration) + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/configurations/{configurationId}: + get: + summary: Read an active configuration for the SCS/AS and the configuration Id. + operationId: FetchIndNPConfiguration + tags: + - Individual Np Configuration + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: configurationId + in: path + description: Identifier of the configuration resource + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get the active configuration) + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Updates/replaces an existing configuration resource. + operationId: UpdateIndNPConfiguration + tags: + - Individual Np Configuration + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + +``` + +``` + required: true + schema: + type: string +- name: configurationId + in: path + description: Identifier of the configuration resource + required: true + schema: + type: string +requestBody: + description: Parameters to update/replace the existing configuration + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' +responses: + '200': + description: OK (Successful update of the existing configuration) + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' + '204': + description: No Content (Successful update of the configuration) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates/replaces an existing configuration resource. + operationId: ModifyIndNPConfiguration + tags: + - Individual Np Configuration + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: configurationId + in: path + description: Identifier of the configuration resource + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NpConfigurationPatch' + responses: + '200': +``` + +``` + description: OK. The configuration was modified successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/NpConfiguration' + '204': + description: No Content. The configuration was modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an already existing configuration. + operationId: DeleteIndNPConfiguration + tags: + - Individual Np Configuration + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: configurationId + in: path + description: Identifier of the configuration resource + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing configuration) + '200': + description: OK. (Successful deletion of the existing configuration) + content: + application/json: + schema: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult' + minItems: 1 + description: The configuration was terminated successfully, the configuration +failure information for group members shall be included if received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +``` + +``` + + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +schemas: + NpConfiguration: + description: Represents a network parameters configuration. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + mtcProviderId: + type: string + description: Identifies the MTC Service Provider and/or MTC Application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + externalId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalId' + msisdn: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Msisdn' + externalGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + maximumResponseTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + suggestedNumberOfDLPackets: + type: integer + minimum: 0 + description: This parameter may be included to identify the number of packets that the +serving gateway shall buffer in case that the UE is not reachable. + groupReportingGuardTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + requestTestNotification: + type: boolean + description: Set to true by the SCS/AS to request the SCEF to send a test notification as +defined in clause 5.2.5.3. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + validityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ueMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + oneOf: + - required: [externalId] + - required: [msisdn] + - required: [externalGroupId] + NpConfigurationPatch: + description: Represents parameters used to request the modification of a network parameters +configuration resource. + type: object + properties: + maximumLatency: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' + maximumResponseTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' + suggestedNumberOfDLPackets: + type: integer + +``` + +``` + + minimum: 0 + description: This parameter may be included to identify the number of packets that the +serving gateway shall buffer in case that the UE is not reachable. + nullable: true + groupReportGuardTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSecRm' + validityTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRm' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + ConfigurationNotification: + description: Represents a configuration result notification. + type: object + properties: + configuration: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + configResults: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ConfigResult' + minItems: 1 + description: The grouping configuration result notification provided by the SCEF. + appliedParam: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/AppliedParameterConfiguration' + required: + - configuration + +``` + +## A.14 AsSessionWithQoS API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-as-session-with-qos + version: 1.3.0-alpha.4 + description: | + API for setting us an AS session with required QoS. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-as-session-with-qos/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/subscriptions: + get: + summary: Read all or queried active subscriptions for the SCS/AS. + operationId: FetchAllASSessionWithQoSSubscriptions + tags: + - AS Session with Required QoS Subscriptions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: ip-addrs + in: query + description: The IP address(es) of the requested UE(s). + required: false + content: + application/json: + schema: + type: array + +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 +- name: ip-domain + in: query + description: > + The IPv4 address domain identifier. The attribute may only be provided if IPv4 address + is included in the ip-addrs query parameter. + required: false + schema: + type: string +- name: mac-addrs + in: query + description: The MAC address(es) of the requested UE(s). + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 +responses: + '200': + description: OK. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +post: + summary: Creates a new subscription resource. + operationId: CreateASessionWithQoSSubscription + tags: + - AS Session with Required QoS Subscriptions + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + requestBody: + description: Request to create a new subscription resource + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + callbacks: + - notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/UserPlaneNotificationData' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Created (Successful creation of subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAsSessionWithQoS' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +``` + +``` +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{scsAsId}/subscriptions/{subscriptionId}: + get: + summary: Read an active subscriptions for the SCS/AS and the subscription Id. + operationId: FetchIndASSessionWithQoSSubscription + tags: + - Individual AS Session with Required QoS Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + responses: + '200': + description: OK (Successful get the active subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Updates/replaces an existing subscription resource. + operationId: UpdateIndASSessionWithQoSSubscription + tags: + - Individual AS Session with Required QoS Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + requestBody: + description: Parameters to update/replace the existing subscription + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + responses: +``` + +``` +'200': + description: OK (Successful update of the subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscription' +'204': + description: No Content (Successful update of the subscription) +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAsSessionWithQoS' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Updates/replaces an existing subscription resource. + operationId: ModifyIndASSessionWithQoSSubscription + tags: + - Individual AS Session with Required QoS Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AsSessionWithQoSSubscriptionPatch' + responses: + '200': + description: OK. The subscription was modified successfully. + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/AsSessionWithQoSSubscription' + '204': + description: No Content. The subscription was modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAsSessionWithQoS' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + type: string + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes an already existing subscription. + operationId: DeleteIndASSessionWithQoSSubscription + tags: + - Individual AS Session with Required QoS Subscription + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the subscription resource + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing subscription) + '200': + description: OK (Successful deletion of the existing subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/UserPlaneNotificationData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + +``` + +``` + +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + AsSessionWithQoSSubscription: + description: Represents an individual AS session with required QoS subscription resource. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + extAppId: + type: string + description: Identifies the external Application Identifier. + extGroupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: Describe the data flow which requires QoS. + ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: Identifies Ethernet packet flows. + enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. + listUeAddrs: + type: array + items: + $ref: '#/components/schemas/UeAddInfo' + minItems: 1 + description: Identifies the list of UE address. + multiModalId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId' + protoDesc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' + qosReference: + type: string + description: Identifies a pre-defined QoS information + altQoSReferences: + +``` + +``` + +type: array +items: + type: string +minItems: 1 +description: > + Identifies an ordered list of pre-defined QoS information. The lower the index of the + array for a given entry, the higher the priority. +altQosReqs: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. +disUeNotif: + description: > + Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified + by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or + not (false). Default value is false. The fulfilled situation is either the QoS profile + or an Alternative QoS Profile. + type: boolean +ueIpv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' +ipDomain: + type: string +ueIpv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' +macAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +usageThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' +sponsorInfo: + $ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation' +qosMonInfo: + $ref: '#/components/schemas/QosMonitoringInformation' +pdvMon: + $ref: '#/components/schemas/QosMonitoringInformation' +qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +directNotifInd: + type: boolean + description: > + Indicates whether the direct event notification is requested (true) or not (false). + Default value is false. +tscQosReq: + $ref: '#/components/schemas/TscQosRequirement' +l4sInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' +requestTestNotification: + type: boolean + description: > + Set to true by the SCS/AS to request the SCEF to send a test notification as defined + in clause 5.2.5.3. Set to false or omitted otherwise. +websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' +events: + description: > + Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to. + type: array + items: + $ref: '#/components/schemas/UserPlaneEvent' + minItems: 1 +multiModDatFlows: + type: object + additionalProperties: + $ref: '#/components/schemas/AsSessionMediaComponent' + minProperties: 1 + description: > + Contains media component data for a single-modal data flow(s). + The key of the map is the medCompN attribute. +pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' +rTLatencyInd: + +``` + +``` + +type: boolean +description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". + The default value is "false" if omitted. +periodInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo' +rttMon: + $ref: '#/components/schemas/QosMonitoringInformation' +qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformation' +avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' +servAuthInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ServAuthInfo' +qosMonConReq: + $ref: '#/components/schemas/QosMonitoringInformation' +listUeConsDtRt: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + description: > + Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. +required: +- notificationDestination + +AsSessionWithQoSSubscriptionPatch: +description: Represents parameters to modify an AS session with specific QoS subscription. +type: object +properties: + exterAppId: + type: string + description: Identifies the external Application Identifier. + flowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: Describe the IP data flow which requires QoS. + ethFlowInfo: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: Identifies Ethernet packet flows. + enEthFlowInfo: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/EthFlowInfo' + minItems: 1 + description: > + Identifies the Ethernet flows which require QoS. Each Ethernet flow consists of a flow + identifier and the corresponding UL and/or DL flows. + listUeAddrs: + type: array + items: + $ref: '#/components/schemas/UeAddInfo' + minItems: 1 + description: Identifies the list of UE address. + qosReference: + type: string + description: Pre-defined QoS reference + altQoSReferences: + type: array + items: + type: string + minItems: 1 + description: > + Identifies an ordered list of pre-defined QoS information. The lower the index of the + array for a given entry, the higher the priority. + altQoSReqs: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Identifies an ordered list of alternative service requirements that include individual + +``` + +``` + + QoS parameter sets. The lower the index of the array for a given entry, the higher the + priority. +disUeNotif: + type: boolean + description: > + Indicates whether the QoS flow parameters signalling to the UE when the SMF is notified + by the NG-RAN of changes in the fulfilled QoS situation is disabled (true) or + not (false). The fulfilled situation is either the QoS profile or an Alternative QoS + Profile. +usageThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' +qosMonInfo: + $ref: '#/components/schemas/QosMonitoringInformationRm' +pdvMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' +directNotifInd: + type: boolean + description: > + Indicates whether the direct event notification is requested (true) or not (false). +notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' +tscQosReq: + $ref: '#/components/schemas/TscQosRequirementRm' +l4sInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' +events: + description: > + Represents the updated list of user plane event(s) to which the SCS/AS requests to + subscribe to. + type: array + items: + $ref: '#/components/schemas/UserPlaneEvent' + minItems: 1 +multiModDatFlows: + type: object + additionalProperties: + $ref: '#/components/schemas/AsSessionMediaComponentRm' + minProperties: 1 + description: > + Contains media component data for a single-modal data flow(s). + The key of the map is the medCompN attribute. +pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' +rTLatencyInd: + type: boolean + description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". + The default value is "false" if omitted. +protoDesc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' +periodInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo' +qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' +qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' +rttMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' +qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformationRm' +avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' +qosMonConReq: + $ref: '#/components/schemas/QosMonitoringInformationRm' +listUeConsDtRt: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + description: > + Identifies the list of UE addresses subject for Consolidated Data Rate monitoring. + +QosMonitoringInformation: + description: Represents QoS monitoring information. + type: object + properties: + reqQosMonParams: + +``` + +``` + + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + repFreqs: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency' + minItems: 1 + repThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + repThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + repThreshRp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + consDataRateThrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + consDataRateThrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + required: + - reqQosMonParams + - repFreqs + +QosMonitoringInformationRm: + description: > + Represents the same as the QosMonitoringInformation data type but with + the nullable:true property. + type: object + properties: + reqQosMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + repFreqs: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency' + minItems: 1 + repThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + repThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + repThreshRp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + consDataRateThrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + consDataRateThrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + +QosMonitoringReport: + description: Represents a QoS monitoring report. + +``` + +``` + +type: object +properties: + ulDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + dlDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + rtDelays: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulAggrDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlAggrDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulConInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dlConInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + cimf: + type: boolean + description: > + Represents the congestion information measurement failure indicator. When set to "true", + it indicates that a congestion information failure has occurred. Default value is false + if omitted. + +UserPlaneNotificationData: + description: Represents the parameters to be conveyed in a user plane event(s) notification. + type: object + properties: + transaction: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + eventReports: + type: array + items: + $ref: '#/components/schemas/UserPlaneEventReport' + minItems: 1 + description: Contains the reported event and applicable information + required: + - transaction + - eventReports + +UserPlaneEventReport: + description: Represents an event report for user plane. + type: object + properties: + event: + $ref: '#/components/schemas/UserPlaneEvent' + accumulatedUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' + flowIds: + type: array + items: + type: integer + minItems: 1 + description: > + Identifies the affected flows that were sent during event subscription. It might be + omitted when the reported event applies to all the flows sent during the subscription. + multiModFlows: + type: array + items: + $ref: '#/components/schemas/MultiModalFlows' + minItems: 1 + description: > + Identifies the the flow filters for the single-modal data flows thatwere sent + +``` + +``` + during event subscription. + It may be omitted when the reported event applies to all the + single-modal data flows sent during the subscription. + appliedQosRef: + type: string + description: > + The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED or + SUCCESSFUL_RESOURCES_ALLOCATION. + altQosNotSuppInd: + type: boolean + description: > + When present and set to true it indicates that the Alternative QoS profiles are not + supported by the access network. Applicable for event QOS_NOT_GUARANTEED. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + description: Contains the QoS Monitoring Reporting information + pdvMonReports: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PdvMonitoringReport' + minItems: 1 + description: Contains the PDV Monitoring Reporting information + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + batOffsetInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' + rttMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + description: Contains the round trip delay over two SDFs reporting information + qosMonDatRateReps: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport' + minItems: 1 + description: > + Contains QoS Monitoring for data rate information. It shall be present when the notified + event is "QOS_MONITORING" and data rate measurements are available. + aggrDataRateRpts: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosMonitoringReport' + minItems: 1 + description: > + Contains QoS Monitoring for aggregated data rate information. It shall be present when + the notified event is "QOS_MONITORING" and data rate measurements are available. + qosMonConInfoReps: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + description: > + Contains QoS Monitoring for congestion information. It shall be present when the + notified event is "QOS_MONITORING" and congestion measurements are available. + required: + - event + +TscQosRequirement: + description: Represents QoS requirements for time sensitive communication. + type: object + properties: + reqGbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + reqGbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + reqMbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + reqMbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' +``` + +``` + +req5Gsgdelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' +reqPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' +priority: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevel' +tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' +tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' +tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' +capBatAdaptation: + type: boolean + description: > + Indicates the capability for AF to adjust the burst sending time, when it is supported + and set to "true". The default value is "false" if omitted. +TscQosRequirementRm: + description: > + Represents the same as the TscQosRequirement data type but with the nullable:true property. + type: object + properties: + reqGbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + reqGbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + reqMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + reqMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + req5Gsgdelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' + reqPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRateRm' + priority: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscPriorityLevelRm' + tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + capBatAdaptation: + type: boolean + description: > + Indicates the capability for AF to adjust the burst sending time, when it is supported + and set to "true". The default value is "false" if omitted. + nullable: true + +AdditionInfoAsSessionWithQos: + description: Describes additional error information specific for this API. + type: object + properties: + acceptableServInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AcceptableServiceInfo' + +ProblemDetailsAsSessionWithQos: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoAsSessionWithQos' + +AsSessionMediaComponent: + description: > + Representmedia component data for a single-modal data flow of a multi-modal service. + type: object + required: + - medCompN + allOf: + - not: + - required: [altSerReqs,altSerReqsData] + - not: + - required: [qosReference,altSerReqsData] + properties: + flowInfos: + type: array + +``` + +``` + + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + nullable: true + description: > + Contains the IP data flow(s) description for a single-modal data flow. + qosReference: + type: string + disUeNotif: + type: boolean + altSerReqs: + type: array + items: + type: string + minItems: 1 + altSerReqsData: + type: array + items: + $ref: + 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains alternative service requirements that include individual QoS parameter sets. + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + medCompN: + type: integer + medType: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tsnQos: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TsnQosContainer' + tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + rTLatencyReq: + type: boolean + description: Round-Trip latency requirement of the service data flow. + pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' + +AsSessionMediaComponentRm: + description: > + Represents the AsSessionMediaComponent data type with nullable information. + type: object + required: + - medCompN + not: + required: [altSerReqs,altSerReqsData] + properties: + flowInfos: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + nullable: true + description: > + Contains the IP data flow(s) description for a single-modal data flow. + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + altSerReqsData: + +``` + +``` + + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains removable alternative service requirements that include individual QoS + parameter sets. + nullable: true + disUeNotif: + type: boolean + nullable: true + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + medCompN: + type: integer + medType: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tsnQos: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TsnQosContainerRm' + tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + rTLatencyReq: + type: boolean + description: Round-Trip latency requirement of the service data flow. + pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' + nullable: true + +MultiModalFlows: + description: Represents a flow information within a single-modal data flow. + type: object + properties: + medCompN: + type: integer + description: > + It contains the ordinal number of the single-modal data flow. Identifies the + single-modal data flow. + flowIds: + type: array + items: + type: integer + minItems: 1 + description: > + Identifies the affected flow(s) within the single-modal data flow + (identified by the medCompN attribute). + It may be omitted when all flows are affected. + required: + - medCompN + +UeAddrInfo: + description: Represent the UE address information. + properties: + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + portNumber: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + +UserPlaneEvent: + anyOf: + - type: string + enum: + - SESSION_TERMINATION + - LOSS_OF_BEARER + - RECOVERY_OF_BEARER + - RELEASE_OF_BEARER + - USAGE_REPORT + - FAILED_RESOURCES_ALLOCATION + +``` + +``` + + - QOS_GUARANTEED + - QOS_NOT_GUARANTEED + - QOS_MONITORING + - SUCCESSFUL_RESOURCES_ALLOCATION + - ACCESS_TYPE_CHANGE + - PLMN_CHG + - L4S_NOT_AVAILABLE + - L4S_AVAILABLE + - BAT_OFFSET_INFO + - RT_DELAY_TWO_QOS_FLOWS + - PACK_DELAY_VAR + - type: string + description: > + 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. + description: | + Represents the user plane event. + Possible values are: + - SESSION_TERMINATION: Indicates that Rx session is terminated. + - LOSS_OF_BEARER : Indicates a loss of a bearer. + - RECOVERY_OF_BEARER: Indicates a recovery of a bearer. + - RELEASE_OF_BEARER: Indicates a release of a bearer. + - USAGE_REPORT: Indicates the usage report event. + - FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed. + - QOS_GUARANTEED: The QoS targets of one or more SDFs are guaranteed again. + - QOS_NOT_GUARANTEED: The QoS targets of one or more SDFs are not being guaranteed. + - QOS_MONITORING: Indicates a QoS monitoring event. + - SUCCESSFUL_RESOURCES_ALLOCATION: Indicates the resource allocation is successful. + - ACCESS_TYPE_CHANGE: Indicates an Access type change. + - PLMN_CHG: Indicates a PLMN change. + - L4S_NOT_AVAILABLE: The ECN marking for L4S of one or more SDFs is not available. + - L4S_AVAILABLE: The ECN marking for L4S of one or more SDFs is available again. + - BAT_OFFSET_INFO: Indicates the network provided BAT offset and the optionally adjusted +periodicity. + - RT_DELAY_TWO_QOS_FLOWS: Indicates round-trip delay on UL and DL flows over two QoS flows. + - PACK_DELAY_VAR: Indicates Packet Delay Variation is enabled for the SDF. + +``` + +## A.15 MsisdnLessMoSms API + +``` + +openapi: 3.0.0 +info: + title: 3gpp-msisdn-less-mo-sms + version: 1.2.0 + description: | + API for MSISDN-less Mobile Originated SMS. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.122 V17.6.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. +paths: + /: + post: + summary: Deliver a received MSISDN-less MO SMS from the SCEF to the SCS/AS. + operationId: DeliverMSISDNlessMOSMSNotification + tags: + - MSISDN-less MO SMS Notification + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MsisdnLessMoSmsNotification' + responses: + '200': + +``` + +``` + + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MsisdnLessMoSmsNotificationReply' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} +schemas: + MsisdnLessMoSmsNotification: + description: Represents a MSISDN-less MO SMS notification. + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + sms: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes' + externalId: + type: string + description: External identifier has the form username@realm. + applicationPort: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + required: + - supportedFeatures + - sms + - externalId + - applicationPort + MsisdnLessMoSmsNotificationReply: + description: Represents a reply to a MSISDN-less MO SMS notification. + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supportedFeatures + +``` + +## A.16 RacsParameterProvisioning API + +openapi: 3.0.0 + +``` + +info: + title: 3gpp-racs-parameter-provisioning + version: 1.2.0-alpha.2 + +``` + +``` + +description: | + API for provisioning UE radio capability parameters. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.122 V18.4.0 T8 reference point for Northbound APIs + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.122/' + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/3gpp-racs-pp/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122. + +paths: + /{scsAsId}/provisionings: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + get: + summary: Read all RACS parameter provisioningings for a given AF. + operationId: FetchAllRACSParameterProvisionings + tags: + - RACS Parameter Provisionings + responses: + '200': + description: OK. The provisioning information related to the request URI is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RacsProvisioningData' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + post: + summary: Create a new RACS parameter provisioning. + operationId: CreateRACSParameterProvisioning + tags: + - RACS Parameter Provisionings + requestBody: + description: create new provisioningings for a given SCS/AS. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' + +``` + +``` +responses: + '201': + description: Created. The provisioning was created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{scsAsId}/provisionings/{provisioningId}: + parameters: + - name: scsAsId + in: path + description: Identifier of the SCS/AS as defined in clause 5.2.4 of 3GPP TS 29.122. + required: true + schema: + type: string + - name: provisioningId + in: path + description: Provisioning ID + required: true + schema: + type: string + get: + summary: Read an existing RACS parameter provisioning. + operationId: FetchIndRACSParameterProvisioning + tags: + - Individual RACS Parameter Provisioning + responses: + '200': + description: OK. The provisioning information related to the request URI is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + summary: Modify some properties in an existing RACS parameter provisioning. + operationId: ModifyIndRACSParameterProvisioning + tags: + - Individual RACS Parameter Provisioning + requestBody: + description: update an existing parameter provisioning. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/RacsProvisioningDataPatch' + responses: + '200': + description: OK. The provisioning data was updated successfully. The SCEF shall return an + updated provisioning information in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' + '204': + description: > + The provisioning data was updated successfully, and no content is to be sent in + the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + summary: Modify all properties in an existing RACS parameter provisioning. + operationId: UpdateIndRACSParameterProvisioning + +``` + +``` +tags: + - Individual RACS Parameter Provisioning +requestBody: + description: update an existing parameter provisioning. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' +responses: + '200': + description: > + OK. The provisioning data was updated successfully. The SCEF shall return an updated + provisioning information in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/RacsProvisioningData' + '204': + description: > + The provisioning data was updated successfully, and no content is to be sent in + the response message body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + description: The RACS data for all RACS IDs were not provisioned successfully. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RacsFailureReport' + minItems: 1 + application/problem+json: + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete a RACS parameter provisioning. + operationId: DeleteIndRACSParameterProvisioning + tags: + - Individual RACS Parameter Provisioning + responses: + '204': + description: > + No Content. The provisioning was terminated successfully. The content shall + be empty. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +``` + +``` + + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + RacsProvisioningData: + description: Represents a UE's radio capability data. + type: object + properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + racsConfigs: + type: object + additionalProperties: + $ref: '#/components/schemas/RacsConfiguration' + minProperties: 1 + description: > + Identifies the configuration related to manufacturer specific UE radio capability. + Each element uniquely identifies an RACS configuration for an RACS ID and is identified + in the map via the RACS ID as key. The response shall include successfully provisioned + RACS data. + racsReports: + type: object + additionalProperties: + $ref: '#/components/schemas/RacsFailureReport' + minProperties: 1 + description: > + Supplied by the SCEF. Contains the RACS IDs for which the RACS data are not provisioned + successfully. Any string value can be used as a key of the map. + readOnly: true + required: + - racsConfigs + RacsFailureReport: + description: Represents a radio capability data provisioning failure report. + type: object + properties: + racsIds: + type: array + items: + type: string + minItems: 1 + description: > + Identifies the RACS ID(s) for which the RACS data are not provisioned successfully. + failureCode: + $ref: '#/components/schemas/RacsFailureCode' + required: + - racsIds + - failureCode + + RacsConfiguration: + description: Represents a single UE radio capability configuration data. + type: object + properties: + racsId: + type: string + description: > + The UE radio capability ID provided by the SCS/AS to identify the UE radio capability + data. See 3GPP TS 23.003 for the encoding. + racsParamEps: + type: string + +``` + +``` + + description: The UE radio capability data in EPS. + racsParam5Gs: + type: string + description: The UE radio capability data in 5GS. + imeiTacs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + minItems: 1 + description: Related UE model's IMEI-TAC values. + anyOf: + - required: [racsParamEps] + - required: [racsParam5Gs] + required: + - racsId + - imeiTacs + +RacsProvisioningDataPatch: + description: > + Represents parameters to request the modification of a UE's radio capability data. + type: object + properties: + racsConfigs: + type: object + additionalProperties: + $ref: '#/components/schemas/RacsConfigurationRm' + minProperties: 1 + description: > + Identifies the configuration related to manufacturer specific UE radio capability. + Each element uniquely identifies an RACS configuration for an RACS ID and is identified + in the map via the RACS ID as key. + +RacsConfigurationRm: + description: > + Represents the same as the RacsConfiguration data type but with the nullable:true property. + type: object + properties: + racsParamEps: + type: string + description: The UE radio capability data in EPS. + nullable: true + racsParam5Gs: + type: string + description: The UE radio capability data in 5GS. + nullable: true + imeiTacs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TypeAllocationCode' + minItems: 1 + description: Related UE model's IMEI-TAC values. + nullable: true + +RacsFailureCode: + anyOf: + - type: string + enum: + - MALFUNCTION + - RESOURCE_LIMITATION + - RACS_ID_DUPLICATED + - OTHER_REASON + - type: string + description: > + 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. + description: | + Represents the failure result of UE radio capability provisioning. + Possible values are: + - MALFUNCTION: This value indicates that something functions wrongly in RACS provisioning or + the RACS provisioning does not function at all. + - RESOURCE_LIMITATION: This value indicates there is resource limitation for RACS data + storage. + - RACS_ID_DUPLICATED: The received RACS identifier(s) are already provisioned. + - OTHER_REASON: Other reason unspecified. + +``` + +--- + +## Annex B (informative): TS Skeleton Template + +A TS Skeleton Template to be used as a starting point of drafting a 3GPP NBI (i.e. northbound and/or application layer interface) Stage 3 specification is available at the following location: + +[https://www.3gpp.org/ftp/information/All\\_Templates/29.xxx-NBI-Stage3-Template.zip](https://www.3gpp.org/ftp/information/All_Templates/29.xxx-NBI-Stage3-Template.zip) + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-04 | CT3#89 | | | | | TS skeleton of T8 reference point stage 3. Inclusion of C3-172217, C3-172242, C3-172249 and editorial change from Rapporteur. | 0.0.0 | +| 2017-05 | CT3#90 | | | | | Inclusion of C3-173256, C3-173257, C3-173306, C3-173318, C3-173323, C3-173329 and editorial change from Rapporteur. | 0.1.0 | +| 2017-09 | CT3#91 | | | | | Inclusion of C3-174368, C3-174279, C3-174079, C3-174352, C3-174328, C3-174329, C3-174374, C3-174375, C3-174243, C3-174333, C3-174334, C3-174376, C3-174281, C3-174377, C3-174356, C3-174280, C3-174358, C3-174359, C3-174379, C3-174337, C3-174361, C3-174294, C3-174362, C3-174385, C3-174299 and editorial change from Rapporteur. | 0.2.0 | +| 2017-10 | CT3#92 | | | | | Inclusion of C3-175068, C3-175365, C3-175370, C3-175301, C3-175227, C3-175228, C3-175359, C3-175230, C3-175231, C3-175337, C3-175247, C3-175290, C3-175360 and editorial changes from Rapporteur. | 0.3.0 | +| 2017-12 | CT3#93 | | | | | Inclusion of C3-176329, C3-176218, C3-176356, C3-176375, C3-176357, C3-176334, C3-176378, C3-176067, C3-176335, C3-176073, C3-176337, C3-176380, C3-176390, C3-176362, C3-176339, C3-176340, C3-176233, C3-176089, C3-176267, C3-176383, C3-176365, C3-176366, C3-176272, C3-176273, C3-176274, C3-176391, C3-176368, C3-176369, C3-176385, C3-176279 and editorial changes from Rapporteur. | 0.4.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of C3-180349, C3-180329, C3-180222, C3-180078, C3-180285, C3-180081, C3-180330, C3-180331, C3-180084, C3-180332, C3-180333, C3-180290, C3-180291, C3-180089, C3-180234, C3-180334, C3-180294, C3-180237, C3-180295, C3-180296, C3-180297, C3-180337, C3-180357, C3-180136, C3-180298 and editorial changes from Rapporteur. | 0.5.0 | +| 2018-02 | CT3#95 | | | | | Inclusion of C3-181271, C3-181324, C3-181340, C3-181273, C3-181333, C3-181334, C3-181276, C3-181325 and editorial changes from Rapporteur. | 0.6.0 | +| 2018-03 | CT#79 | CP-181053 | | | | TS sent to plenary for information | 1.0.0 | +| 2018-04 | CT3#96 | | | | | Inclusion of C3-182464, C3-182017, C3-182444, C3-182019, C3-182486, C3-182487, C3-182344, C3-182074, C3-182373, C3-182446, C3-182291, C3-182292, C3-182488, C3-182508, C3-182345, C3-182094, C3-182295, C3-182346, C3-182096, C3-182347, C3-182348, C3-182026, C3-182349, C3-182098, C3-182350, C3-182099, C3-182100, C3-182209, C3-182210, C3-182101, C3-182102, C3-182455, C3-182506, C3-182353, C3-182491, C3-182355, C3-182447, C3-182507, C3-182359, C3-182106, C3-182107, C3-182108, C3-182492, C3-182109, C3-182110, C3-182480, C3-182362, C3-182448, C3-182449, C3-182450, C3-182425, C3-182365, C3-182112, C3-182113, C3-182035, C3-182367, C3-182115, C3-182368, C3-182493, C3-182494, C3-182509, C3-182372 and editorial changes from Rapporteur. | 1.1.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of C3-183028, C3-183029, C3-183030, C3-183474, C3-183051, C3-183475, C3-183476, C3-183054, C3-183055, C3-183056, C3-183478, C3-183479, C3-183336, C3-183337, C3-183832, C3-183340, C3-183609, C3-183611, C3-183612, C3-183833, C3-183614, C3-183834, C3-183883, C3-183616, C3-183343, C3-183088, C3-183617, C3-183618, C3-183741, C3-183625, C3-183626, C3-183122, C3-183123, C3-183124, C3-183635, C3-183792, C3-183634, C3-183619, C3-183786, C3-183082, C3-183083, C3-183084, C3-183622, C3-183835, C3-183624, C3-183627, C3-183075, C3-183737, C3-183836, C3-183419, C3-183630, C3-183066, C3-183347, C3-183861, C3-183788, C3-183862, C3-183789, C3-183637, C3-183837, C3-183863, C3-183639, C3-183864, C3-183067, C3-183068, C3-183069, C3-183641, C3-183059, C3-183071, C3-183606, C3-183779 and editorial changes from Rapporteur. | 1.2.0 | +| 2018-06 | CT#80 | CP-181038 | | | | TS sent to plenary for approval | 2.0.0 | +| 2018-06 | CT#80 | CP-181038 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182022 | 0001 | 2 | F | MonitoringEvent API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0002 | 2 | F | ChargeableParty API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0003 | 2 | F | GMDviaMBMSbyMB2 API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0004 | 2 | F | GMDviaMBMSbypxMB API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0005 | 2 | F | ReportingNetworkStatus API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0006 | 2 | F | ECRControl API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0007 | 2 | F | NpConfiguration API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0008 | 2 | F | AsSessionWithQoS API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0009 | | F | Update the Error Handling | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0010 | 2 | F | CpProvisioning OpenAPI schema | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182022 | 0011 | 2 | F | Remove the monitoring configuration for a group | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0012 | 1 | F | Resource description in Procedure subclauses | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0013 | 1 | F | Monitoring event API Update | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0014 | 2 | F | BDT API Update | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0015 | | F | Network Parameter Configuration API Update | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0016 | 1 | F | Complete the common openAPI definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0017 | 2 | F | Complete the openAPI definition for BDT API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0018 | | F | NIDD API cleanup | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0019 | 2 | F | Complete the openAPI definition for NIDD API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0020 | 1 | F | One-time monitoring | 15.1.0 | +| 2018-09 | CT#81 | CP-182178 | 0021 | 3 | F | PATCH data type in ChargeableParty API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0022 | 1 | F | Procedure correction of PFD management error handling | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0023 | 2 | F | Complete the openAPI definition for PFD API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0024 | 1 | F | Essential Corrections on TS 29.122 | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0025 | 2 | F | Alignment of error codes with TS 29.500 | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0026 | 2 | F | OpenAPI updates for Device Triggering | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0027 | 1 | F | OpenAPI updates for MSISDN-less Mobile Originated SMS | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0028 | 2 | F | Monitoring event report | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0030 | | F | Add cause in ProblemDetails data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0031 | 1 | F | Remove format keyword for 3GPP defined data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0032 | | F | Correct supported features | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0033 | | F | Correct ConfigResult data type for Monitoring API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0034 | | F | Correct reachability type in monitoring API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0035 | | F | Add HSS interaction for NIDD configuration | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0036 | | F | Correct NiddConfigurationPatch data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182179 | 0037 | 2 | F | Removable attribute definition for NIDD configuration | 15.1.0 | +| 2018-09 | CT#81 | CP-182180 | 0038 | 2 | F | Correct MT NIDD procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0039 | 1 | F | Correct group NIDD procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0040 | | F | Device Trigger cleanup | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0041 | | F | Removable attribute definition for PFD management | 15.1.0 | +| 2018-09 | CT#81 | CP-182181 | 0042 | 2 | F | Correct PFD error code | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0043 | | F | Removable attribute definition for NP configuration | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0044 | | F | Correct ConfigResult data type for NP Provisioning API | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0045 | | F | Removable attribute definition for AS required QoS | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0047 | | F | Version numbering update | 15.1.0 | +| 2018-09 | CT#81 | CP-182022 | 0048 | 1 | F | Removal of external docs field | 15.1.0 | +| 2018-09 | CT#81 | CP-182203 | 0049 | | F | paths property in A.2 | 15.1.0 | +| 2018-12 | CT#82 | CP-183116 | 0050 | | F | File naming for Common data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0051 | | F | UE corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0052 | 2 | F | ExternalDocs field | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0053 | 7 | F | Enhancement of LocationArea | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0054 | | F | Data type for Individual TMGI Allocation PATCH operation | 15.2.0 | +| 2018-12 | CT#82 | CP-183127 | 0055 | 2 | F | Correction on Accuracy level | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0056 | 2 | F | Correction on type ConfigResult | 15.2.0 | +| 2018-12 | CT#82 | CP-183128 | 0057 | 5 | F | Monitoring Event Report | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0059 | | F | Correct server definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0060 | | F | Correct data type for roamingStatus | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0061 | | F | Correct external identifier and msisdn | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0062 | | F | Correct common data definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0063 | 3 | F | Additional data type clarification in openAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0064 | | F | Correct Chargeable Party | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0065 | 2 | F | Correct GMD via MB2 | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0066 | 3 | F | Correct GMD via xMB | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0067 | 5 | F | Correct MT NIDD | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0068 | | F | Correct monitoring API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0069 | | F | Correct CP provisioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0070 | | F | Correct Device trigger | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0071 | | F | Correct PFD management | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0072 | | F | Correct report network status | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0073 | | F | Correct NP provisioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0074 | | F | Correct MO SMS | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0075 | | F | Correct AS session with QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0076 | 3 | F | Error handling | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0077 | 1 | F | Content type | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0078 | 2 | F | Supporting Ethernet UE in Chargeable Party and AF session with QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0079 | 2 | F | Security adaptation for T8 APIs with CAPIF | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0080 | 1 | F | Remove empty array or map for applicable attributes | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0081 | 3 | F | Presence conditions in yaml file | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0082 | | F | Remove format keyword for TimeOfDay data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0083 | 2 | F | Additional external group ID for number of UE in an area | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183116 | 0084 | | F | Correct eDRX cycle length | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0086 | | F | Correct PLMN ID in monitoring API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0088 | | F | Missing ECRData in ECR configuration response | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0089 | | F | Correct GMD via MBMS | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0090 | | F | Missing UE ID in GMD acknowledgement | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0091 | 1 | F | RDS indication in MT NIDD acknowledgement | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0092 | 1 | F | Correct pfdDatas cardinality in PFD management | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0093 | 1 | F | Correct NP configuration yaml definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0094 | 6 | F | Different results in CP parameter sets provisioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0095 | | F | Correct server URI in Device Trigger | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0096 | | F | Implementation of Binary data | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0097 | | F | Missed GET for resource GMD via MBMS by xMB | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0098 | 1 | F | Notification URI Consistency_ChargableParty | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0099 | 1 | F | Notification URI for GMDviaMBMSbyMB2 API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0100 | 1 | F | Notification URI for GMDviaMBMSbyxMB API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0101 | | F | Resource usage and Notification URI for NIDD API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0102 | 2 | F | Security field | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0103 | 1 | F | Status code support for AsSessionWithQoS API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0104 | 1 | F | Status code support for ChargeableParty API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0105 | 2 | F | Status code support for CpProvisioning API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0106 | 1 | F | Status code support for DeviceTriggering API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0107 | 1 | F | Status code support for ECRControl API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0108 | 1 | F | Status code support for GMDviaMBMSbyMB2 API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0109 | 2 | F | Status code support for GMDviaMBMSbyxMB API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0110 | 3 | F | Status code support for MonitoringEvent API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0111 | 1 | F | Status code support for MsisdnLessMoSms API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0112 | 2 | F | Status code support for NIDD API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0113 | 1 | F | Status code support for NpConfiguration API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0114 | 1 | F | Status code support for PfdManagement API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0115 | 1 | F | Status code support for ReportingNetworkStatus API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0116 | 1 | F | Status code support for ResourceManagementOfBdt API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0117 | 1 | F | Location header | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0118 | 2 | F | API Version Update | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0119 | 1 | F | Link of the created resources for AsSessionWithQoS API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0120 | 1 | F | Link of the created resources for ChargeableParty API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0121 | 1 | F | Link of the created resources for CpProvisioning API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0122 | 1 | F | Link of the created resources for DeviceTriggering API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0123 | 1 | F | Link of the created resources for GMDviaMBMSbyMB2 API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0124 | 1 | F | Link of the created resources for GMDviaMBMSbyxMB API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0125 | 1 | F | Link of the created resources for MonitoringEvent API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0126 | 1 | F | Link of the created resources for NIDD API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0127 | 1 | F | Link of the created resources for NpConfiguration API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0128 | 1 | F | Link of the created resources for PfdManagement API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0129 | 1 | F | Link of the created resources for ReportingNetworkStatus API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0130 | 1 | F | Link of the created resources for ResourceManagementOfBdt API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0132 | | F | API version for MonitoringEvent API | 15.2.0 | +| 2018-12 | CT#82 | CP-183116 | 0133 | | F | Successful code corrections for group message delivery APIs | 15.2.0 | +| 2018-12 | CT#82 | CP-183117 | 0087 | 2 | B | PDN connectivity status monitoring | 16.0.0 | +| 2019-03 | CT#83 | CP-190109 | 0138 | 4 | F | PFD extension | 16.1.0 | +| 2019-03 | CT#83 | CP-190125 | 0140 | | F | Remove SHORT_DELAY_STORED | 16.1.0 | +| 2019-03 | CT#83 | CP-190125 | 0142 | 3 | F | Renew TMGI expiration | 16.1.0 | +| 2019-03 | CT#83 | CP-190125 | 0144 | 2 | F | Corrections related to mandatory features and and MonitoringEvent API errors | 16.1.0 | +| 2019-03 | CT#83 | CP-190125 | 0146 | 1 | F | Correction on MacAddr48 data type reference in the OpenAPI file | 16.1.0 | +| 2019-03 | CT#83 | CP-190159 | 0148 | 2 | F | API Version Update | 16.1.0 | +| 2019-03 | CT#83 | CP-190129 | 0149 | 2 | F | Moving xMB stage 2 to TS 26.348 | 16.1.0 | +| 2019-06 | CT#84 | CP-191073 | 0151 | 1 | A | Correction on 5G location area | 16.2.0 | +| 2019-06 | CT#84 | CP-191092 | 0153 | 1 | A | Failure case when feature required by the monitoring type unsupported | 16.2.0 | +| 2019-06 | CT#84 | CP-191073 | 0155 | 1 | A | 5G feature for Number of UEs in an area notification | 16.2.0 | +| 2019-06 | CT#84 | CP-191210 | 0156 | 4 | B | Notification of Downlink data delivery status and availability after DDN failure notification for multiple Afs | 16.2.0 | +| 2019-06 | CT#84 | CP-191090 | 0157 | 1 | B | Add External Group Id | 16.2.0 | +| 2019-06 | CT#84 | CP-191092 | 0160 | 1 | A | Add openAPI definition for 200 OK in MonitoringEvent API | 16.2.0 | +| 2019-06 | CT#84 | CP-191100 | 0163 | | B | Feature applicability for PDN connectivity status | 16.2.0 | +| 2019-06 | CT#84 | CP-191099 | 0165 | 1 | A | Support of MTC Provider Id | 16.2.0 | +| 2019-06 | CT#84 | CP-191070 | 0166 | 1 | B | Network parameter provisioning support | 16.2.0 | +| 2019-06 | CT#84 | CP-191092 | 0168 | | A | Add openAPI definition for PUT in BDT API | 16.2.0 | +| 2019-06 | CT#84 | CP-191103 | 0171 | 1 | B | PFD management notification | 16.2.0 | +| 2019-06 | CT#84 | CP-191100 | 0173 | 1 | F | Clarify number of UE in an area | 16.2.0 | +| 2019-06 | CT#84 | CP-191070 | 0174 | | F | Update reference to TS 24.250 | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191105 | 0175 | 2 | B | BDT Warning Notification Support | 16.2.0 | +| 2019-06 | CT#84 | CP-191092 | 0177 | 1 | A | Precedence and storage of T8 OpenAPI files | 16.2.0 | +| 2019-06 | CT#84 | CP-191092 | 0179 | 2 | A | Copyright Note in YAML file | 16.2.0 | +| 2019-06 | CT#84 | CP-191101 | 0181 | 2 | F | API version Update | 16.2.0 | +| 2019-09 | CT#85 | CP-192139 | 0183 | 1 | A | Correct presence condition in PFD definition | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0184 | 2 | B | Enhancement of Monitoring and Network Parameter Configuration | 16.3.0 | +| 2019-09 | CT#85 | CP-192156 | 0185 | 1 | B | Support a set of MAC addresses in traffic filter | 16.3.0 | +| 2019-09 | CT#85 | CP-192165 | 0187 | 2 | B | Support parameter provisioning in RACS | 16.3.0 | +| 2019-09 | CT#85 | CP-192200 | 0188 | 3 | B | Accurate UE moving trajectory definition | 16.3.0 | +| 2019-09 | CT#85 | CP-192157 | 0189 | 1 | B | Removal of a BDT warning notification request | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0190 | 1 | F | Correction on MSISDN | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0191 | 1 | F | Battery Indication and Traffic Profile for CpProvisioning API | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0192 | 2 | F | Northbound API registration and discovery | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0193 | 1 | F | Corrections on monitoring type | 16.3.0 | +| 2019-09 | CT#85 | CP-192158 | 0194 | 1 | F | Notification of resource allocation failure | 16.3.0 | +| 2019-09 | CT#85 | CP-192197 | 0196 | 3 | B | PFD management partial failure | 16.3.0 | +| 2019-09 | CT#85 | CP-192163 | 0199 | | F | Correction on MSISDN | 16.3.0 | +| 2019-09 | CT#85 | CP-192173 | 0200 | | F | OpenAPI version update for TS 29.122 Rel-16 | 16.3.0 | +| 2019-12 | CT#86 | CP-193216 | 0158 | 9 | B | Update to NIDD APIs for RDS Dynamic Port Management | 16.4.0 | +| 2019-12 | CT#86 | CP-193179 | 0202 | 1 | B | Nnef_APISupportCapability Service | 16.4.0 | +| 2019-12 | CT#86 | CP-193179 | 0203 | 1 | B | Scheduled communication type | 16.4.0 | +| 2019-12 | CT#86 | CP-193198 | 0204 | | F | Correct UMT location area | 16.4.0 | +| 2019-12 | CT#86 | CP-193199 | 0205 | 2 | B | RDS port mismatch in NIDD | 16.4.0 | +| 2019-12 | CT#86 | CP-193199 | 0206 | | F | Reference update: RFC 8259 | 16.4.0 | +| 2019-12 | CT#86 | CP-193206 | 0208 | 4 | A | Correct SCEF aggregation | 16.4.0 | +| 2019-12 | CT#86 | CP-193209 | 0209 | 3 | B | Complete RACS details | 16.4.0 | +| 2019-12 | CT#86 | CP-193199 | 0210 | 1 | B | BatteryIndication data type | 16.4.0 | +| 2019-12 | CT#86 | CP-193220 | 0212 | 3 | B | PFD partial failure notification | 16.4.0 | +| 2019-12 | CT#86 | CP-193206 | 0215 | 1 | A | Correct application port | 16.4.0 | +| 2019-12 | CT#86 | CP-193179 | 0216 | 1 | B | Support API capability change based on API filter | 16.4.0 | +| 2019-12 | CT#86 | CP-193198 | 0217 | 1 | F | openAPI correction for ExNotification | 16.4.0 | +| 2019-12 | CT#86 | CP-193212 | 0218 | 1 | F | Update of API version and TS version in OpenAPI file | 16.4.0 | +| 2020-03 | CT#87e | CP-200198 | 0220 | 1 | B | Update of the DDD status event and availability of DDN failure event | 16.5.0 | +| 2020-03 | CT#87e | CP-200202 | 0222 | 1 | B | QoS Monitoring Report | 16.5.0 | +| 2020-03 | CT#87e | CP-200198 | 0223 | | F | Clarify empty array for API capability change | 16.5.0 | +| 2020-03 | CT#87e | CP-200144 | 0224 | 1 | B | Support PDU session status | 16.5.0 | +| 2020-03 | CT#87e | CP-200208 | 0225 | 1 | B | Support BDT policy candidates in notification | 16.5.0 | +| 2020-03 | CT#87e | CP-200212 | 0226 | 1 | B | Add alternative QoS requirements | 16.5.0 | +| 2020-03 | CT#87e | CP-200219 | 0227 | 1 | B | Adding data type for the BDT Reference ID with "nullable: true" property | 16.5.0 | +| 2020-03 | CT#87e | CP-200209 | 0231 | | F | Enumeration PdnEstablishmentOptionsRm and "nullable" keyword | 16.5.0 | +| 2020-03 | CT#87e | CP-200216 | 0232 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2020-06 | CT#88e | CP-201194 | 0228 | 7 | B | Supporting the Location Services via NEF | 16.6.0 | +| 2020-06 | CT#88e | CP-201243 | 0233 | 1 | F | Addition of IMEI/TAC values for RACS operations | 16.6.0 | +| 2020-06 | CT#88e | CP-201243 | 0234 | 3 | F | Corrections to UE radio capability configuration data | 16.6.0 | +| 2020-06 | CT#88e | CP-201243 | 0235 | 1 | F | Missing bullet in introduction | 16.6.0 | +| 2020-06 | CT#88e | CP-201241 | 0237 | 1 | A | Event of Usage Threshold | 16.6.0 | +| 2020-06 | CT#88e | CP-201235 | 0239 | 3 | F | Periodic reporting by Nnef | 16.6.0 | +| 2020-06 | CT#88e | CP-201210 | 0241 | 1 | F | Correction to the DDD status event | 16.6.0 | +| 2020-06 | CT#88e | CP-201241 | 0243 | | A | Correct GMDViaMBMSByxMB openAPI error | 16.6.0 | +| 2020-06 | CT#88e | CP-201292 | 0245 | 2 | A | Correct NIDD API | 16.6.0 | +| 2020-06 | CT#88e | CP-201213 | 0246 | | F | Correct data type used in QoS monitoring | 16.6.0 | +| 2020-06 | CT#88e | CP-201235 | 0247 | | F | Storage of YAML files | 16.6.0 | +| 2020-06 | CT#88e | CP-201276 | 0248 | 2 | F | Traffic descriptor for xBDT | 16.6.0 | +| 2020-06 | CT#88e | CP-201256 | 0249 | 1 | F | URI of the SCEF northbound APIs | 16.6.0 | +| 2020-06 | CT#88e | CP-201213 | 0250 | 1 | F | Correction to QoS monitoring | 16.6.0 | +| 2020-06 | CT#88e | CP-201243 | 0252 | | F | Avoid using the same data type for PUT and PATCH | 16.6.0 | +| 2020-06 | CT#88e | CP-201250 | 0253 | 1 | B | Complete and fix RDS Port Management | 16.6.0 | +| 2020-06 | CT#88e | CP-201246 | 0254 | 1 | F | Move 5G specific procedure to TS 29.522 | 16.6.0 | +| 2020-06 | CT#88e | CP-201210 | 0255 | 1 | B | Support of Enhanced Coverage Mode control | 16.6.0 | +| 2020-06 | CT#88e | CP-201234 | 0256 | | F | Removal of open issue on external Group Id for ResourceManagementOfBdt API | 16.6.0 | +| 2020-06 | CT#88e | CP-201235 | 0257 | 1 | F | Optionality of ProblemDetails | 16.6.0 | +| 2020-06 | CT#88e | CP-201241 | 0259 | 1 | A | Correction on PfdManagement for PfdManagement API | 16.6.0 | +| 2020-06 | CT#88e | CP-201241 | 0261 | 1 | A | Corrections on APP_ID_DUPLICATED error for PfdManagement API | 16.6.0 | +| 2020-06 | CT#88e | CP-201241 | 0263 | 1 | A | Corrections on SET_ID_DUPLICATED error for CpProvisioning API | 16.6.0 | +| 2020-06 | CT#88e | CP-201235 | 0264 | | F | required field in OpenAPI file | 16.6.0 | +| 2020-06 | CT#88e | CP-201235 | 0265 | 1 | F | Supported headers, Resource Data type and Operation Name | 16.6.0 | +| 2020-06 | CT#88e | CP-201255 | 0267 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2020-09 | CT#89e | CP-202070 | 0271 | | A | Failure response for AsSessionWithQoS API | 16.7.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202070 | 0273 | | A | Same IPv4 address for different PDU sessions | 16.7.0 | +| 2020-09 | CT#89e | CP-202077 | 0274 | 1 | F | Remove 5G procedures to TS 29.522 | 16.7.0 | +| 2020-09 | CT#89e | CP-202072 | 0275 | 1 | F | Unique RACS Id | 16.7.0 | +| 2020-09 | CT#89e | CP-202072 | 0276 | | F | Failure response | 16.7.0 | +| 2020-09 | CT#89e | CP-202048 | 0277 | 1 | F | Initial report for multiple PDN connections | 16.7.0 | +| 2020-09 | CT#89e | CP-202070 | 0281 | | A | Use correct code for deleting individual ChargeableParty transaction | 16.7.0 | +| 2020-09 | CT#89e | CP-202021 | 0283 | 2 | A | Removal of an established AS session | 16.7.0 | +| 2020-09 | CT#89e | CP-202072 | 0284 | | F | Usage of PUT and PATCH | 16.7.0 | +| 2020-09 | CT#89e | CP-202070 | 0286 | | A | Corrections to mtcProviderId | 16.7.0 | +| 2020-09 | CT#89e | CP-202086 | 0287 | 1 | F | Updates NpConfiguration with mtcProviderId | 16.7.0 | +| 2020-09 | CT#89e | CP-202084 | 0289 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.7.0 | +| 2020-12 | CT#90e | CP-203139 | 0291 | 1 | F | TS 29.122 Essential Corrections and alignments | 16.8.0 | +| 2020-12 | CT#90e | CP-203079 | 0294 | 2 | F | Essential Corrections to eLCS related monitoring events | 16.8.0 | +| 2020-12 | CT#90e | CP-203132 | 0295 | 1 | F | Correction to Alternative QoS Parameter | 16.8.0 | +| 2020-12 | CT#90e | CP-203139 | 0296 | | F | Storage of YAML files in 3GPP Forge | 16.8.0 | +| 2020-12 | CT#90e | CP-203108 | 0299 | 1 | F | Corrections to MonitoringEventReport | 16.8.0 | +| 2020-12 | CT#90e | CP-203111 | 0300 | 1 | F | Incorrect definition of QosMonitoringInformation | 16.8.0 | +| 2020-12 | CT#90e | CP-203139 | 0301 | 1 | F | Callback URI correction | 16.8.0 | +| 2020-12 | CT#90e | CP-203133 | 0305 | | A | Successful response code for Event Notification | 16.8.0 | +| 2020-12 | CT#90e | CP-203133 | 0307 | 1 | A | Failure response for SCEF northbound APIs | 16.8.0 | +| 2020-12 | CT#90e | CP-203109 | 0308 | | F | Correction on Location Service via NEF | 16.8.0 | +| 2020-12 | CT#90e | CP-203131 | 0310 | 1 | F | Protocol or application errors | 16.8.0 | +| 2020-12 | CT#90e | CP-203133 | 0312 | 1 | A | Solve IP address overlapping for Chargeable Party | 16.8.0 | +| 2020-12 | CT#90e | CP-203100 | 0314 | 2 | A | Correction to NIDD configuration cancellation procedure | 16.8.0 | +| 2020-12 | CT#90e | CP-203133 | 0316 | 1 | A | Correction to device triggering recall procedure | 16.8.0 | +| 2020-12 | CT#90e | CP-203152 | 0322 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.8.0 | +| 2020-12 | CT#90e | CP-203140 | 0290 | | F | DateTime Enhancement | 17.0.0 | +| 2020-12 | CT#90e | CP-203137 | 0293 | 1 | B | Adding Support for Indicating Serialization Format in RDS | 17.0.0 | +| 2020-12 | CT#90e | CP-203153 | 0323 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203149 | 0324 | | F | Failure authorization result of BDT reference Id for ChargeableParty API request | 17.0.0 | +| 2021-03 | CT#91e | CP-210224 | 0325 | | F | Clarification of eLCS feature applicability only to 5G | 17.1.0 | +| 2021-03 | CT#91e | CP-210210 | 0327 | | A | Correct applied QoS reference for QoS not guaranteed | 17.1.0 | +| 2021-03 | CT#91e | CP-210210 | 0331 | 2 | A | Disable UE notifications at changes related to Alternative QoS Profiles | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0333 | 2 | A | Last known location report | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0335 | | A | Default value of accuracy | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0337 | 3 | A | Support Redirection for MonitoringEvent API | 17.1.0 | +| 2021-03 | CT#91e | CP-210219 | 0338 | 1 | F | OpenAPI "description" fields in data type definitions | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0339 | | F | Update of "description" field for map data types | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0340 | | F | OpenAPI reference | 17.1.0 | +| 2021-03 | CT#91e | CP-210189 | 0344 | | A | Correction to AF ID in ECRControl API | 17.1.0 | +| 2021-03 | CT#91e | CP-210189 | 0346 | | A | Correction to mtcProviderId in ECRControl API | 17.1.0 | +| 2021-03 | CT#91e | CP-210221 | 0352 | 1 | F | Removal of invalid tabulations is some attributes description in the MonitoringEvent API OpenAPI file | 17.1.0 | +| 2021-03 | CT#91e | CP-210234 | 0353 | 1 | D | Text style correction | 17.1.0 | +| 2021-03 | CT#91e | CP-210231 | 0355 | 1 | B | Supported features within ProblemDetails | 17.1.0 | +| 2021-03 | CT#91e | CP-210221 | 0356 | 1 | B | Supported features within ProblemDetails | 17.1.0 | +| 2021-03 | CT#91e | CP-210234 | 0359 | 1 | F | Notification URI Correction for AsSessionWithQoS API | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0361 | 1 | A | Support Redirection for NIDD API | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0363 | 1 | A | Support Redirection for ChargeableParty API | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0365 | 1 | A | Support Redirection for CpProvisioning API | 17.1.0 | +| 2021-03 | CT#91e | CP-210207 | 0367 | 1 | A | Support Redirection for DeviceTriggering API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0369 | 1 | A | Support Redirection for AsSessionWithQoS API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0371 | 1 | A | Support Redirection for ECRControl API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0373 | 1 | A | Support Redirection for MsisdnLessMoSms API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0375 | 1 | A | Support Redirection for NpConfiguration API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0377 | 1 | A | Support Redirection for PfdManagement API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0379 | 1 | A | Support Redirection for RacsParameterProvisioning API | 17.1.0 | +| 2021-03 | CT#91e | CP-210208 | 0381 | 1 | A | Support Redirection for ResourceManagementOfBdt API | 17.1.0 | +| 2021-03 | CT#91e | CP-210209 | 0383 | 1 | A | Usage threshold update | 17.1.0 | +| 2021-03 | CT#91e | CP-210248 | 0385 | 2 | A | Updates to Location Failure Cause | 17.1.0 | +| 2021-03 | CT#91e | CP-210212 | 0387 | 1 | A | Resource allocation status | 17.1.0 | +| 2021-03 | CT#91e | CP-210240 | 0389 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-06 | CT#92e | CP-211271 | 0341 | 3 | B | Updates to AF Application Identifier in ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211271 | 0342 | 3 | B | Updates to AF Application Identifier in AsSessionWithQoS API | 17.2.0 | +| 2021-06 | CT#92e | CP-211282 | 0347 | 5 | B | Update DNN and S-NSSAI in ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211282 | 0348 | 5 | B | Update DNN and S-NSSAI in AsSessionWithQoS API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0390 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the CommonData API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0392 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the ResourceManagementOfBdt API | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211238 | 0393 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0394 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the NIDD API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0395 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the DeviceTriggering API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0396 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the GMDViaMBMS APIs | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0397 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the ReportingNetworkStatus API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0398 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the CpProvisioning API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0399 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the PfdManagement API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0400 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the ECRControl API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0401 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the NpConfiguration API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0402 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the AsSessionWithQoS API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0403 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the MsisdnLessMoSms API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0404 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the RacsParameterProvisioning API | 17.2.0 | +| 2021-06 | CT#92e | CP-211238 | 0405 | 1 | F | Removal of invalid unbreakable spaces in some attributes description in the GMDViaMBMS and ReportingNetworkStatus APIs | 17.2.0 | +| 2021-06 | CT#92e | CP-211241 | 0406 | | F | Support redirection for pure 4G SCEF northbound APIs | 17.2.0 | +| 2021-06 | CT#92e | CP-211241 | 0407 | 1 | F | MonitoringEvent API: TAB and missing "description" fields | 17.2.0 | +| 2021-06 | CT#92e | CP-211178 | 0408 | 3 | B | Support Time Sensitive Communication | 17.2.0 | +| 2021-06 | CT#92e | CP-211232 | 0410 | 1 | A | Clarification on Manufacturer Assigned URC | 17.2.0 | +| 2021-06 | CT#92e | CP-211199 | 0412 | 1 | A | Correction to LDR geographic area | 17.2.0 | +| 2021-06 | CT#92e | CP-211227 | 0415 | | A | Resource corrections for SCEF Northbound APIs | 17.2.0 | +| 2021-06 | CT#92e | CP-211228 | 0418 | 1 | A | TWAN level accuracy applicability | 17.2.0 | +| 2021-06 | CT#92e | CP-211119 | 0422 | 1 | F | New Network slice status reporting events for the MonitoringEvent API | 17.2.0 | +| 2021-06 | CT#92e | CP-211241 | 0426 | 1 | F | Respecting 3GPP Forge executing rules | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0427 | 1 | B | Support of 204 No content response code for PFDs update(NB17) | 17.2.0 | +| 2021-06 | CT#92e | CP-211218 | 0428 | 1 | B | Support of Network Exposure to EAS via Local NEF | 17.2.0 | +| 2021-06 | CT#92e | CP-211239 | 0429 | | F | Adding notificationDestination in NpConfigurationPatch data type | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0430 | 1 | F | Supporting 204 No Content during configuration procedure on NpConfiguration API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0431 | 1 | F | 204 No Content during modification procedure on MonitoringEvent API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0432 | | F | 204 No Content during modification procedure on AsSessionWithQoS API | 17.2.0 | +| 2021-06 | CT#92e | CP-211185 | 0433 | | F | 204 No Content during modification procedure on ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0434 | 1 | F | Update of notification destination for ResourceManagementOfBdt API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0435 | | F | Update of notification destination for ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0436 | | F | Update of notification destination for AsSessionWithQoS API | 17.2.0 | +| 2021-06 | CT#92e | CP-211248 | 0437 | | B | eCAPIF support | 17.2.0 | +| 2021-06 | CT#92e | CP-211269 | 0438 | 1 | B | Update procedures to support HSS initiated GEM partial cancellation | 17.2.0 | +| 2021-06 | CT#92e | CP-211269 | 0439 | 1 | B | Updates to support notification of GEM partial cancellation | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0440 | 1 | F | Updates 204 No Content in NIDD API | 17.2.0 | +| 2021-06 | CT#92e | CP-211240 | 0441 | 1 | F | Updates 204 No Content in RacsParameterProvisioning API | 17.2.0 | +| 2021-06 | CT#92e | CP-211241 | 0444 | 1 | B | Updates notification destination via PATCH operation in NIDD API | 17.2.0 | +| 2021-06 | CT#92e | CP-211228 | 0447 | 1 | A | Format of location information | 17.2.0 | +| 2021-06 | CT#92e | CP-211227 | 0450 | | A | Corrections on PATCH operation for ChargeableParty API | 17.2.0 | +| 2021-06 | CT#92e | CP-211227 | 0453 | | A | Essential corrections to 204 in PATCH in NIDD API | 17.2.0 | +| 2021-06 | CT#92e | CP-211265 | 0454 | | A | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212215 | 0455 | 1 | F | Resource URI corrections for PfdManagement and NpConfiguration APIs | 17.3.0 | +| 2021-09 | CT#93e | CP-212224 | 0456 | 1 | B | Clarification to type FlowInfo | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0457 | | F | Correction to Resource URI of ResourceManagementOfBdt API | 17.3.0 | +| 2021-09 | CT#93e | CP-212210 | 0458 | 1 | B | UAV Presence Monitoring | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0459 | 1 | B | Resource allocation status for Chargeable Party | 17.3.0 | +| 2021-09 | CT#93e | CP-212224 | 0460 | | F | Fix AppId feature description | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0463 | 1 | F | Supporting 204 No Content during configuration procedure on DeviceTriggering API | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0464 | 1 | F | Supporting 204 No Content during configuration procedure on ReportingNetworkStatus API | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93e | CP-212186 | 0466 | 1 | A | Accuracy attribute correction | 17.3.0 | +| 2021-09 | CT#93e | CP-212213 | 0469 | | A | Correction on Configuration data | 17.3.0 | +| 2021-09 | CT#93e | CP-212204 | 0471 | | A | Correction on User Plane Notification data | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0472 | | F | Corrections on resource root structure and resource URI on MonitoringEvent API | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0473 | 1 | F | Rel-17 Resource URI corrections on AsSessionWithQoS API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0474 | | F | Resource URI corrections on ChargeableParty API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0475 | | F | Resource URI correction on DeviceTriggering API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0476 | | F | Resource URI correction on ReportingNetworkStatus API | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0477 | 1 | F | Add list of data types table to the CommonData API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0478 | | F | Correction of some remaining invalid characters in OpenAPI specification files | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0479 | | F | Miscellaneous corrections | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0480 | 1 | F | Resource URI correction in the GMD via MBMS APIs | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0481 | | F | Correction to MAC address in MonitoringEvent API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0482 | | F | Updates 204 No Content in GMDviaMBMSbyMB2 API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0483 | | F | Updates 204 No Content in GMDviaMBMSbyxMB API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0484 | | F | Updates notification destination via PATCH operation in GMDviaMBMSbyMB2 API | 17.3.0 | +| 2021-09 | CT#93e | CP-212214 | 0485 | | F | Updates notification destination via PATCH operation in GMDviaMBMSbyxMB API | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0486 | 1 | F | Correct resource URI in NIDD API | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0487 | 1 | F | Correct resource URI in RacsParameterProvisioning API | 17.3.0 | +| 2021-09 | CT#93e | CP-212224 | 0488 | | B | Update DNN and S-NSSAI in MonitoringEvent API | 17.3.0 | +| 2021-09 | CT#93e | CP-212226 | 0489 | 1 | B | Update procedures to support SCSAS initiated GEM partial cancellation | 17.3.0 | +| 2021-09 | CT#93e | CP-212237 | 0490 | 1 | B | Updates to support GEM partial cancellation | 17.3.0 | +| 2021-09 | CT#93e | CP-212187 | 0491 | 1 | B | Support for Multiple QoS Class in deferred location request | 17.3.0 | +| 2021-09 | CT#93e | CP-212215 | 0492 | 2 | B | Supporting Load and Overload Control for northbound APIs | 17.3.0 | +| 2021-09 | CT#93e | CP-212211 | 0494 | | B | Update of TscQosRequirement and TscQosRequirementRm | 17.3.0 | +| 2021-09 | CT#93e | CP-212223 | 0495 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-12 | CT#94e | CP-213233 | 0496 | 2 | B | Enhance MonitoringEvent API to support UAV list | 17.4.0 | +| 2021-12 | CT#94e | CP-213247 | 0497 | 1 | F | Correcting "JSON Patch" encoding of changes | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0498 | 1 | B | Updates GET Query in AsSessionWithQoS API | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0499 | 1 | B | Updates GET Query in ChargeableParty API | 17.4.0 | +| 2021-12 | CT#94e | CP-213234 | 0500 | 1 | B | Adding alternative QoS related parameters to AsSessionWithQoS | 17.4.0 | +| 2021-12 | CT#94e | CP-213260 | 0502 | 2 | B | Update the data type definition for MonitoringEvent API | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0503 | 1 | F | Removal of errors from MonitoringEvent OpenAPI file | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0504 | | F | ResourceManagementOfBdt: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0505 | | F | ChargeableParty: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0506 | 1 | F | NIDD: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0507 | 1 | F | DeviceTriggering: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0508 | | F | GMDviaMBMSbyMB2: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0509 | | F | GMDviaMBMSbyxMB: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0510 | | F | ReportingNetworkStatus: adding operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0511 | 1 | F | CpProvisioning: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0512 | | F | PfdManagement: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0513 | | F | NpConfiguration: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0514 | | F | AsSessionWithQoS: adding operationId fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0515 | 1 | F | MsisdnLessMoSms: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0516 | | F | RacsParameterProvisioning: adding summary, operationId and tags fields | 17.4.0 | +| 2021-12 | CT#94e | CP-213247 | 0517 | 1 | B | Update error handling procedures for GEM partial cancellation | 17.4.0 | +| 2021-12 | CT#94e | CP-213212 | 0518 | 1 | F | Resolve editor note for Multiple QoS Class | 17.4.0 | +| 2021-12 | CT#94e | CP-213230 | 0519 | | F | Resolving the subscription to NSAC events related ENs | 17.4.0 | +| 2021-12 | CT#94e | CP-213230 | 0520 | 1 | F | Resolving the reporting type related ENs for NSAC event subscriptions | 17.4.0 | +| 2021-12 | CT#94e | CP-213268 | 0521 | 2 | B | Supporting explicit subscription to user plane events for the AsSessionWithQoS API | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0522 | 1 | B | Updating the support of explicit subscription to bearer events for the ChargeableParty API | 17.4.0 | +| 2021-12 | CT#94e | CP-213235 | 0523 | 1 | F | Supporting 204 No Content during configuration procedure on ResourceManagementOfBdt API | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0524 | | F | Correction to Resource URI of CpProvisioning API | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0525 | 1 | B | Support of 204 No Content during modification procedure on CpProvisioning API | 17.4.0 | +| 2021-12 | CT#94e | CP-213220 | 0526 | | B | Alignment with SA3 supported TLS profiles | 17.4.0 | +| 2021-12 | CT#94e | CP-213223 | 0527 | | B | Clarification of direct notification | 17.4.0 | +| 2021-12 | CT#94e | CP-213230 | 0528 | 1 | B | Supporting network slice status retrieval | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0532 | 1 | B | Updates GET Query in MonitoringEvent API | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0533 | 1 | F | Adding a list of APIs table | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213267 | 0534 | 2 | B | Supporting multiple events per subscription on MonitoringEvent API | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0536 | 1 | F | Adding the MonitoringEvent API specific data types tables | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0537 | 1 | F | Adding the DeviceTriggering API specific data types tables | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0538 | 1 | F | Adding the ReportingNetworkStatus API specific data types tables | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0539 | 1 | F | Adding the ECRControl API specific data types tables | 17.4.0 | +| 2021-12 | CT#94e | CP-213236 | 0540 | 1 | F | Adding the NpConfiguration API specific data types tables | 17.4.0 | +| 2021-12 | CT#94e | CP-213246 | 0541 | 1 | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2022-03 | CT#95e | CP-220203 | 0542 | | F | Correction of mbmsLocArea attribute for GMDViaMBMS APIs | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0543 | | F | Adding the ChargeableParty API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0544 | | F | Adding the PfdManagement API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0545 | 1 | F | Adding the ResourceManagementOfBdt API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0546 | 1 | F | Updating the AsSessionWithQoS API data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220204 | 0547 | 2 | B | Add the support for PATCH method for the update of a NIDD DL Data transfer resource | 17.5.0 | +| 2022-03 | CT#95e | CP-220204 | 0548 | 3 | B | Add the support of PATCH for the update of a Device Triggering Transaction resource | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0549 | 1 | F | Adding the NIDD API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0550 | | F | Adding the GMDViaMBMS APIs specific data types tables | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0551 | | F | Adding the CpProvisioning API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0552 | | F | Adding the MsisdnLessMoSms API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0553 | | F | Adding the RacsParameterProvisioning API specific data types table | 17.5.0 | +| 2022-03 | CT#95e | CP-220181 | 0554 | 1 | B | Add the support of the civic address type of accuracy | 17.5.0 | +| 2022-03 | CT#95e | CP-220187 | 0555 | 1 | B | Defining the reporting format for NSAC | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0556 | 1 | B | Description of JSON body with "JSON Patch" encoding of changes | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0557 | | F | Updates to GET query supporting in collection level | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0558 | | B | Updates GET query in PfdManagement API | 17.5.0 | +| 2022-03 | CT#95e | CP-220183 | 0559 | 1 | B | Adding alternative QoS related parameter sets to AsSessionWithQoS | 17.5.0 | +| 2022-03 | CT#95e | CP-220203 | 0560 | | F | Correction of the encoding of complex query parameters | 17.5.0 | +| 2022-03 | CT#95e | CP-220199 | 0561 | 1 | B | Support GEM partial addition | 17.5.0 | +| 2022-03 | CT#95e | CP-220185 | 0562 | | F | Feature support handling for Edge Computing | 17.5.0 | +| 2022-03 | CT#95e | CP-220187 | 0564 | 1 | F | One-time reporting | 17.5.0 | +| 2022-03 | CT#95e | CP-220169 | 0567 | | A | Incorrect resource name and attribute name | 17.5.0 | +| 2022-03 | CT#95e | CP-220181 | 0568 | 1 | B | Support AF specific UE ID retrieval in MonitoringEvent API | 17.5.0 | +| 2022-03 | CT#95e | CP-220181 | 0569 | 1 | B | Support AF specific UE ID retrieval in CpProvisioning API | 17.5.0 | +| 2022-03 | CT#95e | CP-220181 | 0570 | 1 | B | Support AF specific UE ID retrieval in NpConfiguration API | 17.5.0 | +| 2022-03 | CT#95e | CP-220204 | 0571 | 1 | B | Support PATCH for the update of a PFD Management Transaction resource | 17.5.0 | +| 2022-03 | CT#95e | CP-220204 | 0572 | 1 | B | Support PATCH for the update of Network Status Reporting Subscription resource | 17.5.0 | +| 2022-03 | CT#95e | CP-220194 | 0573 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-06 | CT#96 | CP-221145 | 0575 | 1 | B | Mutual exclusivity of QoS reference and individual QoS parameters | 17.6.0 | +| 2022-06 | CT#96 | CP-221139 | 0576 | 1 | F | Corrections to the AF provided inputs for NSAC | 17.6.0 | +| 2022-06 | CT#96 | CP-221147 | 0577 | 1 | F | Aligning the naming conventions for resource URI components and enumerations with 5GC APIs | 17.6.0 | +| 2022-06 | CT#96 | CP-221147 | 0578 | 1 | F | Resolving the naming convention issues | 17.6.0 | +| 2022-06 | CT#96 | CP-221144 | 0580 | 1 | F | Support of QoS notification control for requested alternative QoS parameters | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0581 | | F | Adding Link data type with "nullable: true" property | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0583 | | B | Missing application errors in the Monitoring API | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0584 | | F | Correction to TscQosRequirement and TscQosRequirementRm | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0585 | | B | Supporting user consent revocation for EDGEAPP on the Nnef_EventExposure API | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0588 | | A | Correcting the DateTime data type name | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0589 | | F | Removing the MonitoringEventSubscriptionPatch data type | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0590 | | F | Defining the default logical relationship between query parameters | 17.6.0 | +| 2022-06 | CT#96 | CP-221159 | 0591 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-09 | CT#97e | CP-222097 | 0592 | 1 | F | Updates error handling for AF specific UE Id retrieval in MonitoringEvent API | 17.7.0 | +| 2022-09 | CT#97e | CP-222097 | 0593 | 1 | F | Updates error handling for AF specific UE Id retrieval in CpProvisioning API | 17.7.0 | +| 2022-09 | CT#97e | CP-222097 | 0594 | 1 | F | Updates error handling for AF specific UE Id retrieval in NpConfiguration API | 17.7.0 | +| 2022-09 | CT#97e | CP-222118 | 0595 | 1 | F | The events subscribed by the NEF | 17.7.0 | +| 2022-09 | CT#97e | CP-222113 | 0596 | - | F | Fixing TSC related reused data types in AsSessionWithQoS | 17.7.0 | +| 2022-09 | CT#97e | CP-222118 | 0597 | 1 | F | Application errors handling for the NpConfiguration API | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0598 | - | F | Application errors handling for the RacsParameterProvisioning API | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0599 | 1 | F | Usage of the "tags" field and URI structure | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0600 | - | F | Application errors handling for the NIDD API | 17.7.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222117 | 0601 | 1 | F | Application errors handling for the ReportingNetworkStatus API | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0602 | - | F | Application errors handling for the ECRControl API | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0603 | 1 | F | "Error handling" clause: alignment with other NBI and 5GS APIs | 17.7.0 | +| 2022-09 | CT#97e | CP-222125 | 0605 | 1 | F | Correction of User Plane Event Report | 17.7.0 | +| 2022-09 | CT#97e | CP-222125 | 0607 | 1 | F | Reporting condition for QoS Monitoring Information | 17.7.0 | +| 2022-09 | CT#97e | CP-222090 | 0609 | 1 | A | Corrections on location reporting | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0612 | 1 | F | Boolean types in partial modification | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0613 | 1 | F | Updates on PATCH in MonitoringEvent API | 17.7.0 | +| 2022-09 | CT#97e | CP-222118 | 0614 | 1 | F | Missing description field for enumeration data type in MonitoringEvent API | 17.7.0 | +| 2022-09 | CT#97e | CP-222097 | 0615 | - | F | Correcting the name of the application errors related to user consent revocation support | 17.7.0 | +| 2022-09 | CT#97e | CP-222117 | 0616 | - | F | Application errors handling for the MonitoringEvent API | 17.7.0 | +| 2022-09 | CT#97e | CP-222121 | 0620 | - | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223184 | 0623 | 1 | F | Corrections on PLMN_CHG event | 17.8.0 | +| 2022-12 | CT#98e | CP-223184 | 0624 | 1 | F | Corrections on ACCESS_TYPE_CHANGE event | 17.8.0 | +| 2022-12 | CT#98e | CP-223188 | 0626 | - | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223185 | 0622 | 1 | F | ResultReason enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0625 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230179 | 0628 | 1 | B | Adding PER to AF Session with QoS API | 18.1.0 | +| 2023-03 | CT#99 | CP-230172 | 0629 | 1 | B | Unavailability Period feature for MonitoringEvent API | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0632 | 1 | B | Correction of expectedUmtDays attribute | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0634 | 1 | B | Update Flow Description Information with ToSTC in ChargeableParty API | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0636 | 1 | B | Update Flow Description Information with ToSTC in AsSessionWithQoS API | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0640 | 2 | B | Updates on location reporting | 18.1.0 | +| 2023-03 | CT#99 | CP-230281 | 0641 | 2 | B | Updates to immediate reporting in MonitoringEvent API | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0642 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0643 | - | F | Description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230173 | 0650 | 1 | A | Correction on handling of Packet Delay Failure report Threshold | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0651 | - | F | Generalization of QoS monitoring control description | 18.1.0 | +| 2023-03 | CT#99 | CP-230182 | 0652 | 1 | B | Support of Nnef_AFsessionWithQoS_Create service update for Multi-Modal service XR and Media Services | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0653 | 1 | B | Vendor specific extensions | 18.1.0 | +| 2023-03 | CT#99 | CP-230155 | 0655 | 1 | A | Corrections in MonitoringEvent API | 18.1.0 | +| 2023-03 | CT#99 | CP-230277 | 0656 | 1 | B | Specification of application errors for QoS requests | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0657 | 1 | B | Indication of Alternative Service Requirements not supported | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0658 | 1 | B | Support of BAT window and capability for BAT adaptation | 18.1.0 | +| 2023-03 | CT#99 | CP-230153 | 0659 | - | B | Support of Group Member List Change event | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0660 | 1 | F | Clarification on bearer related events in AsSessionWithQoS API | 18.1.0 | +| 2023-03 | CT#99 | CP-230305 | 0662 | 2 | A | Correction of the procedure when the NEF reject the AF update request | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0664 | - | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231169 | 0639 | 2 | A | Correction on TLS_SCN in PFD data | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0665 | 1 | F | Corrections on applicability of ToS Traffic Class | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0666 | 2 | B | AsSessionWithQoS enhancements to support multi-modal services | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0669 | 1 | B | Vendor specific extensions – resolve EN | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0671 | 2 | B | Support of ECN marking for L4S | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0672 | 1 | F | Defining a TS skeleton for TSs documenting NBI APIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0675 | 1 | F | Support of BAT offset and adjusted periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231300 | 0677 | 1 | B | Support of PDU Set QoS Parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0678 | 3 | B | Support of Uplink Downlink transmission coordination to meet RT latency requirement | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0680 | 1 | B | Updates in NpConfiguration API | 18.2.0 | +| 2023-06 | CT#100 | CP-231186 | 0681 | - | F | Clarification on Loss_of_connectivity_notification_5G | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0682 | 1 | B | Enhanced data management for the Monitoring API | 18.2.0 | +| 2023-06 | CT#100 | CP-231164 | 0686 | 1 | A | Corrections in the Notification mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231153 | 0688 | 1 | A | MonitoringEvent resources update for an Error case | 18.2.0 | +| 2023-06 | CT#100 | CP-231262 | 0689 | 1 | B | Adding Monitoring event for application traffic detection. | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0690 | 1 | B | Protocol description parameter support in AS Session with QoS | 18.2.0 | +| 2023-06 | CT#100 | CP-231147 | 0694 | - | A | Removal of unspecified QoS monitoring control options | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0696 | - | B | Support of periodicity measurement and reporting for power saving | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0697 | - | B | Support Application-Specific Expected UE Behaviour parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231311 | 0699 | 1 | A | Corrections to boolean type in MonitoringEventSubscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231140 | 0700 | 1 | F | Corrections to immediate reporting in MonitoringEvent API | 18.2.0 | +| 2023-06 | CT#100 | CP-231140 | 0701 | 1 | F | Corrections to Location Type and immediate reporting in MonitoringEvent API | 18.2.0 | +| 2023-06 | CT#100 | CP-231313 | 0702 | 1 | B | Updates to BDT on ASP Id | 18.2.0 | +| 2023-06 | CT#100 | CP-231167 | 0705 | - | A | Reporting format for one-time reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0707 | 1 | B | Support of Packet Delay Variation monitoring and reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0711 | - | F | Corrections to the resource update related provisions for the | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| | | | | | | MonitoringEvent API | | +| 2023-06 | CT#100 | CP-231139 | 0712 | | B | Editor Note removal for userLocation attribute | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0715 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232091 | 0721 | 1 | F | Wrong applicability of AsSessionWithQoS error | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0722 | 1 | F | Applicability of new AfSessionWithQoS errors | 18.3.0 | +| 2023-09 | CT#101 | CP-232124 | 0723 | 1 | B | Update application detection event exposure | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0724 | 1 | B | AF QoS Timing info addition | 18.3.0 | +| 2023-09 | CT#101 | CP-232172 | 0725 | 2 | B | AIMLsys service data model update for AsSessionWithQoS | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0727 | 1 | F | Editor note removal for Multimodal id | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 0729 | | B | AF request QoS for target UE in AsSessionWithQoS API | 18.3.0 | +| 2023-09 | CT#101 | CP-232109 | 0731 | 1 | B | Reject Location request when area does not overlap with configured "event report allowed area" | 18.3.0 | +| 2023-09 | CT#101 | CP-232113 | 0732 | 1 | B | Network slice admission control notification update for UE with atleast one PDU session/PDN connection | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0735 | | F | Correction in Feature numbering | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0736 | | F | remove useless BdtReferenceIdRm | 18.3.0 | +| 2023-09 | CT#101 | CP-232091 | 0738 | | F | Corrections on the roaming status report | 18.3.0 | +| 2023-09 | CT#101 | CP-232084 | 0739 | 1 | B | Subscription to Round-Trip delay over two service data flows | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0740 | 1 | B | Subscription to data rate monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0741 | 1 | B | Support of the congestion information measurement and reporting | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0742 | 1 | B | Support of the Packet Delay Variation monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0745 | 1 | B | Confidence and accuracy levels for UE behaviour parameters | 18.3.0 | +| 2023-09 | CT#101 | CP-232103 | 0746 | 2 | B | Location exposure for Ranging_SL | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0747 | 1 | B | Resolve EN for Application-Specific Expected UE Behaviour parameters | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0748 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233231 | 0691 | 4 | B | Supporting query parameters extensibility | 18.4.0 | +| 2023-12 | CT#102 | CP-233263 | 0718 | 1 | A | Resolving the remaining LOLC related ENs | 18.4.0 | +| 2023-12 | CT#102 | CP-233262 | 0719 | 2 | B | Support of user plane positioning | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0734 | 3 | F | Corrections to MonitoringEventReport | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0749 | | F | Correct the attribute names and add abbreviation | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0750 | 1 | B | Introduction of new features for PDU set handle and RT latency | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0752 | | B | Update Data Rate monitoring | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0753 | | F | Corrections to the monitoringType and addnMonTypes attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0754 | 1 | F | Corrections to the User Consent Revocation Notification definition | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0755 | 3 | B | Support of subscription to flow level events | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0756 | 1 | F | Support of the new feature name EnQoSMon | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0757 | 2 | F | Updating the obsoleted IETF HTTP RFCs | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0760 | 1 | F | associate attributes with corresponding NOTE | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0761 | | B | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233268 | 0762 | 1 | B | Update Location exposure for Ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233257 | 0763 | 1 | F | Corrections in MonitoringEventReport | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0764 | | B | Protocol description - End of burst indication update | 18.4.0 | +| 2023-12 | CT#102 | CP-233208 | 0765 | 2 | B | Feature granularity and definition for MultiModal & PowerSaving | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0766 | 1 | F | Correction on formulating conditions based on feature support | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0771 | | B | Definition of L4S feature | 18.4.0 | +| 2023-12 | CT#102 | CP-233236 | 0772 | 3 | B | Updates to AppExpUeBehaviour Data Type in CpProvisioning API | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0774 | | F | Update the feature description for Application-Specific Expected UE Behaviour | 18.4.0 | +| 2023-12 | CT#102 | CP-233257 | 0775 | 1 | B | Update application detection event exposure | 18.4.0 | +| 2023-12 | CT#102 | CP-233262 | 0776 | 1 | B | Support of cumulative event report | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0777 | | F | Remove the redundant features | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0778 | 1 | B | Support of Consolidated Data Rate for Multi-member AF session | 18.4.0 | +| 2023-12 | CT#102 | CP-233209 | 0780 | 2 | B | Port handling with AsSessionWithQoS | 18.4.0 | +| 2023-12 | CT#102 | CP-233236 | 0781 | 1 | B | Multiple AF Expected UE behaviour | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0782 | | F | Removal of EN related to data management | 18.4.0 | +| 2023-12 | CT#102 | CP-233257 | 0783 | 1 | F | Wrong attribute name | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0784 | | F | Corrections on monitoring event | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0785 | | F | Remove the multiModalId in the update message and update the terminology | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0787 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29176/raw.md b/gsma/29_series/29176/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..686cd335bf6f8f88811f126a182c3d9864a6de5e --- /dev/null +++ b/gsma/29_series/29176/raw.md @@ -0,0 +1,1328 @@ + + +# 3GPP TS 29.176 V18.0.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IP Multimedia Subsystems (IMS); Media Function (MF) Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions, symbols and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 5 Services offered by the MF..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nmf_MediaResourceManagement (MRM) Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Nmf_MRM_Create Service Operation..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Creation of a new media context..... | 10 | +| 5.2.2.3 Nmf_MRM_Update Service Operation..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 5.2.2.3.2 Updating an existing media context..... | 11 | +| 5.2.2.4 Nmf_MRM_Delete Service Operation..... | 12 | +| 5.2.2.4.1 General ..... | 12 | +| 5.2.2.4.2 Deleting an existing media context..... | 12 | +| 6 API Definitions ..... | 13 | +| 6.1 Nmf_MRM Service API ..... | 13 | +| 6.1.1 Introduction ..... | 13 | +| 6.1.2 Usage of HTTP..... | 13 | +| 6.1.2.1 General..... | 13 | +| 6.1.2.2 HTTP standard headers..... | 13 | +| 6.1.2.2.1 General ..... | 13 | +| 6.1.2.2.2 Content type ..... | 13 | +| 6.1.2.3 HTTP custom headers..... | 13 | +| 6.1.3 Resources..... | 14 | +| 6.1.3.1 Overview..... | 14 | +| 6.1.3.2 Resource: Contexts Collection..... | 14 | +| 6.1.3.2.1 Description ..... | 14 | +| 6.1.3.2.2 Resource Definition..... | 14 | +| 6.1.3.2.3 Resource Standard Methods..... | 15 | +| 6.1.3.2.4 Resource Custom Operations..... | 16 | +| 6.1.3.3 Resource: Individual Context ..... | 16 | +| 6.1.3.3.1 Description ..... | 16 | +| 6.1.3.3.2 Resource Definition..... | 16 | +| 6.1.3.3.3 Resource Standard Methods..... | 16 | +| 6.1.3.3.4 Resource Custom Operations..... | 18 | +| 6.1.4 Custom Operations without associated resources ..... | 18 | +| 6.1.5 Notifications ..... | 19 | +| 6.1.6 Data Model ..... | 19 | +| 6.1.6.1 General..... | 19 | +| 6.1.6.2 Structured data types..... | 19 | +| 6.1.6.2.1 Introduction ..... | 19 | +| 6.1.6.2.2 Type: MediaContext..... | 20 | +| 6.1.6.2.3 Type: TerminationInfo ..... | 20 | +| 6.1.6.2.4 Type: MediaInfo..... | 21 | + +| | | | +|-------------------------------|-----------------------------------------|-----------| +| 6.1.6.2.5 | Type: DcMedia..... | 22 | +| 6.1.6.2.6 | Type: ArMedia..... | 24 | +| 6.1.6.3 | Simple data types and enumerations..... | 24 | +| 6.1.6.3.1 | Introduction ..... | 24 | +| 6.1.6.3.2 | Simple data types ..... | 24 | +| 6.1.7 | Error Handling ..... | 24 | +| 6.1.7.1 | General ..... | 24 | +| 6.1.7.2 | Protocol Errors ..... | 24 | +| 6.1.7.3 | Application Errors..... | 25 | +| 6.1.8 | Feature negotiation ..... | 25 | +| 6.1.9 | Security ..... | 25 | +| 6.1.10 | HTTP redirection..... | 25 | +| Annex A (normative): | OpenAPI specification ..... | 26 | +| A.1 | General..... | 26 | +| A.2 | Ndcmf_MRM API ..... | 26 | +| Annex B (informative): | Change history..... | 31 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the Media Function (MF). + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The IP Multimedia Subsystem (IMS) Data Channel (DC) architecture and procedures are specified in annex AC of 3GPP TS 23.228 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [15] IETF RFC 6902: " JavaScript Object Notation (JSON) Patch". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +*Definition format (Normal)* + +****: . + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|-----|---------------------------------------| +| DC2 | Reference point between MF and IMS AS | +|-----|---------------------------------------| + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------------------| +| AR | Augmented Reality | +| DC | Data Channel | +| MF | Media Function | +| IMS AS | IP Multimedia Subsystem Application Server | + +# 4 Overview + +Within the IMS DC architecture, the MF offers services to the IMS AS via the Nmf service based interface (see 3GPP TS 23.228 [14]). + +Figure 4.1-1 provides the reference model (in service-based interface representation and in reference point representation), with focus on the MF services. + +![Diagram of the reference model showing the IMS AS connected to the MF via the DC2 reference point and the Nmf service-based interface.](98a45dd7d474e067b7533cc966c11e95_img.jpg) + +The diagram illustrates the reference model for the Media Function (MF). On the left, a white rectangular box is labeled 'IMS AS'. A horizontal line connects this box to a green rectangular box on the right, which is labeled 'MF'. The connection line is labeled 'DC2' near the IMS AS and 'Nmf' near the MF. The 'Nmf' label is positioned next to a small circle on the left side of the MF box, indicating a service-based interface. + +Diagram of the reference model showing the IMS AS connected to the MF via the DC2 reference point and the Nmf service-based interface. + +**Figure 4.1-1: Reference model – MF** + +DC2 is the reference point between MF and IMS AS. + +# 5 Services offered by the MF + +## 5.1 Introduction + +The MF offers the following services via the Nmf interface: + +- Nmf\_MediaResourceManagement (MRM) Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|---------------------------------------|----------------------------|---------|-------| +| Nmf_MRM | 6.1 | Nmf Media Resource Management Service | TS29176_Nmf_MRM.yaml | nmf-mrm | A.2 | + +## 5.2 Nmf\_MediaResourceManagement (MRM) Service + +### 5.2.1 Service Description + +The Nmf\_MRM service as defined in 3GPP TS 23.228 [14] is provided by the Media Function (MF). This service enables the consumer to create, update and delete media resources. Data Channel (DC) and Augmented Reality (AR) are two capabilities supported by MF. + +The media resource represents a media context including one or multiple media terminations. A media termination includes media resources for one or multiple medias on the Mb interface. When a media pass through the MF, there is one termination for the input stream and one termination for the output stream. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Nmf\_MRM service supports the following service operation. + +**Table 5.2.2.1-1: Service operations supported by the Nmf\_MRM service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|--------------------------------------------------------------------------------------|---------------------|---------------------| +| Create | Create a new media context including one or multiple media terminations. | Request/Response | IMS AS | +| Update | Update the one or multiple existing media resources within a specific media context. | Request/Response | IMS AS | +| Delete | Delete a specific media context including all the existing terminations and medias. | Request/Response | IMS AS | + +#### 5.2.2.2 Nmf\_MRM\_Create Service Operation + +##### 5.2.2.2.1 General + +The Nmf\_MRM\_Create service operation is used by an NF service consumer to create a media context including one or multiple terminations and reserve media resources for anchoring one or multiple medias of Mb interface in each + +termination on MF. The consumer NF may also include application function (e.g. DCSF, DC AS) specification information requested by the application layer to be applied on the media by the MF. + +##### 5.2.2.2.2 Creation of a new media context + +The NF service consumer shall request a new context by using HTTP method POST with "{apiRoot}/nmf//contexts" as resource URI representing the "Contexts Collection", see clause 6.1.3.2. + +![Sequence diagram showing the creation of a media context. The NF Service Consumer sends a POST request to the MF. The MF responds with either a 201 Created (MediaContext) or a 4xx/5xx (ProblemDetails) or 3xx response.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MF + Note left of NF Service Consumer: POST ../contexts (MediaContext) + NF Service Consumer->>MF: 1. POST ../contexts (MediaContext) + Note right of MF: -2a. 201 Created (MediaContext) + MF-->>NF Service Consumer: -2a. 201 Created (MediaContext) + Note right of MF: -2b. 4xx/5xx (ProblemDetails) or 3xx + MF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the creation of a media context. The NF Service Consumer sends a POST request to the MF. The MF responds with either a 201 Created (MediaContext) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.2.2.2.2-1 Creation of a media context + +1. The NF Service Consumer shall send a POST request to create an "Individual Context" resource in the MF. The payload body of the POST request shall contain a representation of the individual context resource to be created. + +The NF service consumer shall include list of termination descriptors in the HTTP message body. Each termination descriptor shall include list of media stream descriptors. Each media stream descriptor shall include: + +- Media ID, i.e. a unique identity of the media stream within the media context instance; +- Remote Mb specifications, i.e. the media stream IP address and port allocated at the remote endpoint, i.e. remote UE, remote network. +- Media resource description, which includes + - 1) Media resource type, e.g. DC, AR. + - 2) If media resource type is set to "DC", the DC media specification shall be included. The DC media specification shall include: + - a) Data Channel Mapping and Configuration information when originating/terminating data channel media flows on the Mb interface. It shall include the SCTP stream Id for the DC, and may include subprotocol, order, maxRetry, maxTime and priority may be included. + - b) Maximum Message Size, which represents the maximum size to be expected. + - c) Data Channel Port, which represents the port of SCTP port for the Data Channel. + - d) Security Setup, which identifies the security setup of the DTLS connection. + - e) Security Certificate Fingerprint, which identifies the security certificate fingerprint. + - f) Security Transport Identity, which identifies transport layer identity. + +For establishing bootstrap data channel or P2A/A2P application data channel, the following parameters shall be included: + +- a) media proxy configuration applicable to the media flow; +- b) remote MDC1/MDC2 media specification information to be applied on the media by the MF; +- c) Replacement HTTP URL for each streamId allocated by the application layer representing the application list (e.g. graphical user interface) offered to the IMS subscriber via the MDC1 interface. + +3) If media resource type is set to "AR", the AR media resource description shall be included, which includes: + +a) Media processing specification. + +2a. Upon the reception of the HTTP POST request, if the request is accepted and no error occur, the MF shall: + +- create a new media context; +- assign a media contextId; +- assign a terminationId for each termination descriptor; and +- reserve media resources for each mediaId. + +The MF shall include a HTTP Location header to provide the location of a newly created resource (MediaContext) together with the status code 201 indicating the requested resource is created in the response message. + +2b. On failure, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.3.1-3. + +On redirection, the MF shall include 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance. + +#### 5.2.2.3 Nmf\_MRM\_Update Service Operation + +##### 5.2.2.3.1 General + +The Nmf\_MRM\_Update service operation is used by an NF service consumer to update one or multiple existing media resources within a specific media context on MF. Terminations and/or Medias can be added, modified, or deleted within an Update request. + +##### 5.2.2.3.2 Updating an existing media context + +The NF Service Consumer shall modify the context by using HTTP method PATCH with the URI "{apiRoot}/nmf//contexts/{contextId}" as resource URI representing the "Individual Context ", see clause 6.1.3.3. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MF for updating a media context. The consumer sends a PATCH request to the MF. The MF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (MediaContext), or 2c. 4xx/5xx (ProblemDetails) or 3xx.](ec98c4d2d93f28dfc8eb9d5e5730f62d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MF + Note left of NF Service Consumer: Update a media context + NF Service Consumer->>MF: 1. PATCH .../contexts/{contextId} (PatchData) + MF-->>NF Service Consumer: 2a. 204 No Content + MF-->>NF Service Consumer: 2b. 200 OK (MediaContext) + MF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MF for updating a media context. The consumer sends a PATCH request to the MF. The MF responds with one of three options: 2a. 204 No Content, 2b. 200 OK (MediaContext), or 2c. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.3.2-1 Update a media context + +1. The NF Service Consumer shall send a PATCH request to modify a context resource in the MF. The modification may be for adding, updating or deleting terminations of the existing media context. + +For adding, removing or updating a termination in an existing MediaContext, the payload body of the PATCH request shall contain an "add", "remove" or "replace" PATCH operation respectively, with one item of the attribute "terminations" of the MediaContext. + +- 2a. On success, if the change is to delete the existing termination and MF accepts the request change, the MF shall return the status code 204 No Content. +- 2b. On success, if the change is to add a new termination or to update the existing termination and DCMF accepts the request change, the MF shall return the status code 200 OK. The response shall contain the new resource representation of the resource Individual Context, which includes the added and modified resource or its sub-resource. +- 2c On failure, one of the HTTP status code listed in Table 6.1.3.3.3.1-3 indicating the error shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.1-3. + +On redirection, the MF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance. + +#### 5.2.2.4 Nmf\_MRM\_Delete Service Operation + +##### 5.2.2.4.1 General + +The Nmf\_MRM\_Delete service operation is used by an NF service consumer to delete an existing media context including all existing terminations and medias on MF previously created by itself. + +##### 5.2.2.4.2 Deleting an existing media context + +The NF Service Consumer shall delete an existing context by using HTTP method DELETE with the URI "{apiRoot}/nmf//contexts/{contextId}" as resource URI representing the "Individual Context ", see clause 6.1.3.3. + +![Sequence diagram showing the interaction between an NF Service Consumer and an MF for deleting a media context. The consumer sends a DELETE request to the MF. The MF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) response.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant MF + Note left of NF Service Consumer: 1. DELETE .../contexts/{contextId} + NF Service Consumer->>MF: 1. DELETE .../contexts/{contextId} + Note right of MF: -2a. 204 No Content + MF-->>NF Service Consumer: -2a. 204 No Content + Note right of MF: 2b. 4xx/5xx (ProblemDetails) or 3xx + MF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an MF for deleting a media context. The consumer sends a DELETE request to the MF. The MF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (redirection) response. + +Figure 5.2.2.4.2-1 Delete a media context + +- 1. The NF Service Consumer shall send a DELETE request to delete an existing context resource in the MF. +- 2a. On success, the request is accepted, the MF shall reply with the status code 204 No Content indicating the resource identified by context ID is successfully deleted in the response message. +- 2b. On failure, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 indicating the error shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-3. + +On redirection, the MF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint to another MF (service) instance. + +# 6 API Definitions + +## 6.1 Nmf\_MRM Service API + +### 6.1.1 Introduction + +The Nmf\_MRM service shall use the Ndcmf\_MRM API. + +The API URI of the Nmf\_MRM API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be " nmf\_mrm". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmf\_MRM API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +The use of JSON Patch (IETF RFC 6902 [15]) format in a HTTP request body shall be signaled by the content type "application/json-patch+json". + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Nmf\_MRM API. + +![Diagram showing the resource URI structure for the Nmf_MRM API. The root is {apiRoot}/nmf-mrm/. It branches to /contexts, which then branches to /{contextId}.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nmf-mrm/"] --> Contexts["/contexts"] + Contexts --> ContextId["/{contextId}"] + +``` + +Diagram showing the resource URI structure for the Nmf\_MRM API. The root is {apiRoot}/nmf-mrm/. It branches to /contexts, which then branches to /{contextId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Nmf\_MRM API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|----------------------------------------------------------------------------| +| Contexts Collection | /contexts | POST | Creates a new Individual Context resource. | +| Individual Context | /contexts/{contextId} | PATCH | Updates an existing Individual Context resource identified by {contextId} | +| | | DELETE | Deletes an existing Individual Context resource identified by {contextId}. | + +#### 6.1.3.2 Resource: Contexts Collection + +##### 6.1.3.2.1 Description + +The Contexts Collection resource represents a collection of contexts created by NF service consumers of Nmf\_MRM service at a given MF. The resource is modelled as Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [2]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/ nmf\_mrm//contexts + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------| +| MediaContext | M | 1 | Creates a new Individual Context resource | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------| +| MediaContext | M | 1 | 201
Created | The creation of an Individual Media Context resource is confirmed and a representation of that resource is returned. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nfmf-mrm//contexts/{contextId}. | + +**Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +##### 6.1.3.2.4 Resource Custom Operations + +None in the release of this specification. + +#### 6.1.3.3 Resource: Individual Context + +##### 6.1.3.3.1 Description + +The Individual Context resource represents an individual context created by the NF service consumers of Nmf\_MRM service at a given MF. This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [2]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nmf\_mrm//contexts/{contextId} + +The shall be set as described in clause 6.3.1. + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|----------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| contextId | string | Identifies an individual context to the Nmf_MRM service. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Document describes the modification(s) to an Individual Context resource. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MediaContext | M | 1..N | 200 OK | Represents a successful update on the media context. | +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the modification of media context has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- MEDIA_ID_CONFLICT
- MEDIA_CONNECTION_CHANGED | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of media context has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +###### 6.1.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| Problem Details | O | 0..1 | 404 Not Found | Indicates the deletion of the context has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT NOT FOUND | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative MF (service) instance.
Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MF instance ID towards which the request is redirected. | + +##### 6.1.3.3.4 Resource Custom Operations + +None in the release of specification. + +### 6.1.4 Custom Operations without associated resources + +None in this release of specification. + +### 6.1.5 Notifications + +None in this release of specification. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nmf\_MRM service based interface protocol. + +**Table 6.1.6.1-1: Nmf\_MRM specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------|----------------|--------------------------------------------------|---------------| +| MediaContext | 6.1.6.2.2 | Represents an individual context resource on MF. | | +| TerminationInfo | 6.1.6.2.3 | Represents the termination information. | | +| MediaInfo | 6.1.6.2.4 | Represents the media Information. | | +| DcMedia | 6.1.6.2.5 | Represents the DC media descriptor. | | +| ArMedia | 6.1.6.2.6 | Represents the AR media descriptor. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nmf\_MRM service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmf\_MRM service based interface. + +**Table 6.1.6.1-2: Nmf\_MRM re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-----------------------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Problem Details | | +| MediaId | 3GPP TS 29.571 [16] | Uniquely identifies one media flow within an IMS session. | | +| MaxMessageSize | 3GPP TS 29.571 [16] | Max SCTP user message size. | | +| MediaResourceType | 3GPP TS 29.571 [16] | Media resource types. | | +| MediaProxy | 3GPP TS 29.571 [16] | Media proxy configuration applicable to the media flow | | +| SecuritySetup | 3GPP TS 29.571 [16] | Security setup of the DTLS association. | | +| DcEndpoint | 3GPP TS 29.571 [16] | DC endpoint | | +| DcStream | 3GPP TS 29.571 [16] | Data channel stream information. | | +| ReplaceHttpUrl | 3GPP TS 29.571 [16] | Replacement HTTP URL allocated by the application layer. | | +| Uri | 3GPP TS 29.571 [16] | Uri | | +| Endpoint | 3GPP TS 29.571 [16] | Represents the IP endpoint. | Endpoint | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: MediaContext + +Table 6.1.6.2.2-1: Definition of type MediaContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| contextId | string | C | 0..1 | Identifies a specific context. It is assigned by the MF when creating a new context, i.e. Nmf_MRM_Create operation. | | +| terminations | array(TerminationInfo) | M | 1..N | Represents the media terminations | | + +##### 6.1.6.2.3 Type: TerminationInfo + +Table 6.1.6.2.3-1: Definition of type TerminationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| terminationId | string | C | 0..1 | Identifies a specific media termination. It is assigned by the MF when creating a new termination. It shall be included in the response of adding a new media termination, i.e., the Nmf_MRM_Create operation and in the Nmf_MRM_Update operation with adding a new termination. | | +| medias | array(MediaInfo) | M | 1..N | Represent the list of media resources for one or multiple medias on the Mb interface. | | + +##### 6.1.6.2.4 Type: MediaInfo + +Table 6.1.6.2.4-1: Definition of type MediaInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mediaId | string | M | 1 | Identifies a media stream, e.g. data channel. | | +| mediaResourceType | MediaResourceType | M | 1 | Represents the media resource type, e.g. DC, AR. | | +| localMbEndpoint | Endpoint | C | 0..1 | Represents the local IP address and port number of the local endpoint of MF on the Mb interface.
It will be allocated by MF.
It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE 1, NOTE 2) | | +| remoteMbEndpoint | Endpoint | C | 0..1 | Represents the IP address and port number of the remote endpoint on the Mb interface, e.g. remote UE.
It shall be contained in the request of creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. It can be Null when originating a new media. (NOTE 1, NOTE 2) | | +| dcMedia | DcMedia | C | 0..1 | Represents the data channel media descriptors. It shall be contained if the mediaResourceType is set to "DC". | | +| arMedia | ArMedia | C | 0..1 | Represents the AR media descriptors. It shall be contained if the mediaResourceType is set to "AR". | | +| mediaProcessingURL | Uri | C | 0..1 | The mediaProcessingURL indicates the address where MF receive service-related media instructions. It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE 1) | | + +NOTE 1: The IE cannot be changed once the media has been established. + +NOTE 2: The attribute "transport" inside Endpoint data type shall be set to value only "UDP". + +##### 6.1.6.2.5 Type: DcMedia + +**Table 6.1.6.2.5-1: Definition of type DcMedia** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mediaProxyConfig | MediaProxy | C | 0..1 | Represents the media proxy configuration. It shall be included if the mediald represents bootstrap or P2A/A2P application data channels. | | +| replaceHttpUrl | Map(ReplacementHttpUrl) | C | 0..1 | A map (list of key-value pairs where streamId is used as key of the map) of ReplacementHttpUrl.
Represents URL for the specific IMS subscriber when requesting the application list (e.g. graphical user interface) via the MDC1 interface. It shall be included if the mediald represents bootstrap data channel and streamId is 0 and 100. | | +| remoteMdc1Endpoint | Endpoint | C | 0..1 | Represents the remote MDC1 media endpoint information, i.e. the IP address and port number of DCSF. It shall be included if the mediald represents a bootstrap data channel. | | +| remoteMdc2Endpoint | Endpoint | C | 0..1 | Represents the remote MDC2 media endpoint address, i.e. the IP address and port number of DC AS. It shall be included if the mediald represents a P2A/A2P application data channel and the mediaProxyConfig is set to "HTTP". | | +| localMdc1Endpoint | Endpoint | C | 0..1 | Represents the local MF MDC1 media endpoint information. It will be allocated by MF and contained in the response when the mediald represents a bootstrap data channel. | | +| localMdc2Endpoint | Endpoint | C | 0..1 | Represents the local MF MDC2 media endpoint information. It will be allocated by MF and contained in the response when the mediald represents a P2A/A2P application data channel. | | +| mdc2Protocol | string | O | 0..1 | Represents the transport layer protocols for MDC2 interface. It may be included when mediaProxyConfig is set "HTTP" and remoteMdc2Endpoint is present. This IE is formatted as the following pattern, for example:
'UDP/DTLS/SCTP' | | +| streams | map(DcStream) | M | 1..N | A map (list of key-value pairs where streamId is used as key of the map) of DcStream.
Represents the data channel mapping and configuration information when originating/terminating data channel media flows on the Mb interface. | | +| maxMessageSize | MaxMessageSize | O | 0..1 | Represents the maximum size of to be expected. | | +| localDcEndpoint | DcEndpoint | C | 0..1 | Represents the DC endpoint for the Data Channel.
It will be allocated by MF.
It shall be contained in the response when creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. (NOTE) | | + +| | | | | | | +|---------------------------------------------------------------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| remoteDcEndpoint | DcEndpoint | C | 0..1 | Represents the DC Endpoint for the Data Channel on the Mb interface. It shall be contained in the request of creating a new media stream, i.e. Nmf_MRM_Create operation or Nmf_MRM_Update operation with adding a new termination or adding a media in an existing termination. It can be NULL when originating a data channel media. (NOTE) | | +| securitySetup | SecuritySetup | O | 0..1 | Represents the security set up of the DTLS association. | | +| NOTE: The IE cannot be changed once the media has been established. | | | | | | + +##### 6.1.6.2.6 Type: ArMedia + +**Table 6.1.6.2.6-1: Definition of type ArMedia** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +Editor's note: The definition of ArMedia is FFS. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nmf\_MRM API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmf\_MRM API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nmf\_MRM service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nmf\_MRM service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CONTEXT_NOT_FOUND | 404 Not Found | Indicates that the requested context is not found in the MF. | +| MEDIA_ID_CONFLICT | 403 Forbidden | Indicates that mediald which identifies the newly added media has existed within the specific termination. | +| MEDIA_CONNECTION_CHANGED | 403 Forbidden | Indicates that the connection information which has been marked that cannot be changed once the media has established is changed in the request. including the remoteMbEndpoint, localMbEndpoint etc. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nmf\_MRM API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmf\_MRM API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmf\_MRM API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmf\_MRM service. + +The Nmf\_MRM API defines a single scope "nmf-mrm" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different MF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different MF producer instance will return the NF Instance ID of the new MF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an MF redirects a service request to a different MF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new MF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Ndcnf\_MRM API + +``` +openapi: 3.0.0 + +info: + title: 'MF Media Resource Management (MRM) Service' + version: 1.0.0-alpha.1 + description: | + MF Media Resource Management (MRM) Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.176 V18.0.0; IP Multimedia Subsystem (IMS); Media Function (MF) Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.176/ + +servers: + - url: '{apiRoot}/nmf-mrm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nmf-mrm + +paths: + + /contexts: + post: + summary: Create a new media context. + operationId: CreateMediaContext + tags: + - MediaContext(Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MediaContext' + responses: + '201': + description: Success + content: +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/MediaContext' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nmf-mrm//contexts/{contextId} + required: true + schema: + type: string + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target MF. + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target MF. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/contexts/{contextId}: + + patch: + summary: Update Media Context + operationId: UpdateMediaContext + tags: + - Media Context ID (Document) + parameters: + - name: contextId + in: path + required: true + description: Unique ID of the Media Context to update. + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Expected response to a valid request. + content: + application/json: + schema: + $ref: '#/components/schemas/MediaContext' + '204': + description: Expected response with empty body + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target MF. + required: true + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target MF. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '409': + $ref: 'TS29571_CommonData.yaml#/components/responses/409' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: Deletes a given Media Context + operationId: DeleteMediaContext + tags: + - Media Context ID (Document) + parameters: + - name: contextId + in: path + required: true + description: Unique ID of the Media Context to delete. + schema: + type: string + responses: + '204': + description: Expected response to a successful deletion. +``` + +``` +'307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF. + required: true + schema: + type: string +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse' + headers: + Location: + description: The URI pointing to the resource located on the redirect target NRF. + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +### components: + +``` +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmf-mrm: Access to the Nmf_MRM API. +``` + +### schemas: + +``` +MediaContext: + description: Information of a Media Context in a MF. + type: object + required: + - terminations + properties: + contextId: + type: string + terminations: + type: array + items: + $ref: '#/components/schemas/TerminationInfo' + minItems: 1 + +TerminationInfo: + description: Represents the termination information. + type: object + required: + - medias + properties: +``` + +``` + terminationId: + type: string + medias: + type: array + items: + $ref: '#/components/schemas/MediaInfo' + minItems: 1 + +MediaInfo: + description: Represents the media information. + type: object + required: + - mediaId + - mediaResourceType + properties: + mediaId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId' + mediaResourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaResourceType' + localMbEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + remoteMbEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + dcMedia: + $ref: '#/components/schemas/DcMedia' + mediaProcessingUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +DcMedia: + description: Represents the DC media descriptor. + type: object + required: + - streams + properties: + mediaProxyConfig: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MediaProxy' + replaceHttpUrl: + type: object + description: > + Contains a list of replacement HTTP URLs. The streamId attribute + within the ReplaceHttpUrl data type is the key of the map. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ReplaceHttpUrl' + minProperties: 1 + remoteMdc1Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + remoteMdc2Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + localMdc1Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + localMdc2Endpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Endpoint' + mdc2Protocol: + type: string + streams: + type: object + description: > + Contains a data channel mapping and configuration information. The streamId + attribute within the DcStream data type is the key of the map. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcStream' + minProperties: 1 + maxMessageSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxMessageSize' + localDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + remoteDcEndpoint: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DcEndpoint' + securitySetup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SecuritySetup' +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|----|-----|-----|-----------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2023-04 | CT4#115
e | C4-231552 | | | | Version 0.1.0 | | 0.1.0 | +| 2023-05 | CT4#116 | C4-232178 | | | | Clause 4 Overview | | 0.2.0 | +| 2023-05 | CT4#116 | C4-232224 | | | | Clause 5.1 Introduction of DCMF services | | 0.2.0 | +| 2023-05 | CT4#116 | C4-232506 | | | | Service description and service operation introduction of MRM service | | 0.2.0 | +| 2023-05 | CT4#116 | C4-232607 | | | | MRM API definition | | 0.2.0 | +| 2023-05 | CT4#116 | C4-232637 | | | | MRM service operations | | 0.2.0 | +| 2023-08 | CT4#117 | C4-233707 | | | | Change DCMF to MF | | 0.3.0 | +| 2023-08 | CT4#117 | C4-233307 | | | | Update the data channel related data types | | 0.3.0 | +| 2023-08 | CT4#117 | C4-233306 | | | | Update MF service to support AR | | 0.3.0 | +| 2023-10 | CT4#118 | C4-234539 | | | | Update the scope | | 0.4.0 | +| 2023-10 | CT4#118 | C4-234540 | | | | Support of Redirection | | 0.4.0 | +| 2023-10 | CT4#118 | C4-234575 | | | | Clarification on the DC media | | 0.4.0 | +| 2023-10 | CT4#118 | C4-234543 | | | | Editorial Corrections | | 0.4.0 | +| 2023-10 | CT4#118 | C4-234544 | | | | Update the data model for AR remote cooperation | | 0.4.0 | +| 2023-10 | CT4#118 | C4-234341 | | | | Usage of the apiVersion placeholder | | 0.4.0 | +| 2023-11 | CT4#119 | C4-235576 | | | | Move the Endpoint to Common Data | | 0.5.0 | +| 2023-11 | CT4#119 | C4-235473 | | | | OpenAPI of Nmf_MRM Service | | 0.5.0 | +| 2023-12 | CT#102 | CP-233022 | | | | Presented for information and approval | | 1.0.0 | +| 2023-12 | CT#102 | CP-233022 | | | | Approved in TSC CT#102 | | 18.0.0 | \ No newline at end of file diff --git a/gsma/29_series/29213/raw.md b/gsma/29_series/29213/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..37c4a52fc6791aee8e57caa1f863eee90c6e8739 --- /dev/null +++ b/gsma/29_series/29213/raw.md @@ -0,0 +1,7318 @@ +# 3GPP TS 29.213 V18.0.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +UMTS, LTE, QoS, Charging, Policy + +--- + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles – Sophia Antipolis +Valbonne – France +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +## Contents + +| | | +|----------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 9 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions and abbreviations ..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Abbreviations ..... | 13 | +| 3a Reference architecture..... | 14 | +| 4 Signalling Flows over Gx, Gxx, Rx, Sd, Sy, Np, Nt, St and S9 ..... | 17 | +| 4.0 General ..... | 17 | +| 4.1 IP-CAN Session Establishment..... | 18 | +| 4.2 IP-CAN Session Termination..... | 22 | +| 4.2.1 UE-Initiated ..... | 22 | +| 4.2.1.1 AF located in the HPLMN..... | 22 | +| 4.2.1.2 AF located in the VPLMN..... | 25 | +| 4.2.2 PCEF-Initiated..... | 27 | +| 4.2.2.1 AF located in the HPLMN..... | 27 | +| 4.2.2.2 AF located in the VPLMN..... | 29 | +| 4.2.3 PCRF-Initiated..... | 30 | +| 4.2.3.1 AF located in the HPLMN..... | 30 | +| 4.2.3.2 AF located in the VPLMN..... | 32 | +| 4.3 IP-CAN Session Modification ..... | 34 | +| 4.3.1 Network-Initiated IP-CAN Session Modification..... | 34 | +| 4.3.1.1 Interactions between BBERF, PCEF, TDF, OCS, TSSF and PCRF(PCC/QoS/ADC Rule Provisioning in PUSH mode) ..... | 34 | +| 4.3.1.2 Interactions between PCRF, AF and SPR ..... | 39 | +| 4.3.1.2.1 AF Session Establishment..... | 39 | +| 4.3.1.2.2 AF session modification..... | 42 | +| 4.3.1.2.2.1 AF located in the HPLMN ..... | 42 | +| 4.3.1.2.2.2 AF located in the VPLMN ..... | 44 | +| 4.3.1.2.3 AF session termination..... | 45 | +| 4.3.1.2.3.1 AF located in the HPLMN ..... | 45 | +| 4.3.1.2.3.2 AF located in the VPLMN ..... | 47 | +| 4.3.2 PCEF –Initiated IP-CAN Session Modification (PCC Rule Provisioning in PULL Mode) ..... | 48 | +| 4.3.2.1 PCEF-initiated IP-CAN Session Modification. AF located in HPLMN. .... | 48 | +| 4.3.2.2 PCEF-initiated IP-CAN Session Modification, AF located in the VPLMN ..... | 53 | +| 4.4 Gateway Control Session Procedures ..... | 54 | +| 4.4.1 Gateway Control Session Establishment..... | 55 | +| 4.4.2 Gateway Control and QoS Rules Request..... | 59 | +| 4.4.2.1 Non-Roaming and Home Routed cases ..... | 59 | +| 4.4.2.2 Visited access cases ..... | 61 | +| 4.4.3 Gateway Control and QoS Rules Provision ..... | 62 | +| 4.4.4 Gateway Control Session Termination..... | 63 | +| 4.4.4.1 BBERF-Initiated Gateway Control Session Termination..... | 63 | +| 4.4.4.2 PCRF-Initiated Gateway Control Session Termination..... | 65 | +| 4.5 Multiple BBERF Signalling Flows ..... | 66 | +| 4.5.1 Non-Roaming and Home Routed cases..... | 66 | +| 4.5.1.1 New Gateway Control Session Establishment..... | 66 | +| 4.5.1.2 PCEF IP-CAN session modification – Handover..... | 69 | +| 4.5.1.3 PCEF IP-CAN session modification – S2c-based IP flow mobility..... | 70 | +| 4.5.1.4 Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility..... | 72 | +| 4.5.2 Visited access case ..... | 73 | +| 4.5.2.1 New Gateway Control Session Establishment..... | 73 | +| 4.5.2.2 PCEF-Initiated IP-CAN session modification-Handover..... | 75 | + +| | | | +|---------|--------------------------------------------------------------------------------------------------------------------|-----| +| 4.5.2.3 | PCEF-Initiated IP-CAN session modification - S2c-based IP flow mobility..... | 77 | +| 4.5.2.4 | Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility..... | 79 | +| 4.6 | Application Detection and Enforcement Procedures ..... | 81 | +| 4.6.1 | TDF Session Establishment in case of solicited reporting ..... | 81 | +| 4.6.1A | TDF Session Establishment in case of unsolicited reporting ..... | 82 | +| 4.6.2 | TDF Session termination..... | 82 | +| 4.6.3 | TDF Session modification..... | 84 | +| 4.6.3.1 | Application Detection, Reporting and Control Rules Request..... | 84 | +| 4.6.3.2 | Application Detection and Control Rules Provision..... | 85 | +| 4.7 | Spending limits Procedures over Sy reference point ..... | 86 | +| 4.7.1 | Initial Spending Limit Report Request..... | 86 | +| 4.7.2 | Intermediate Spending Limit Report Request ..... | 86 | +| 4.7.3 | Final Spending Limit Report Request ..... | 87 | +| 4.7.4 | Spending Limit Report ..... | 88 | +| 4.8 | Call flows for User Plane Congestion Management..... | 88 | +| 4.8.1 | General ..... | 88 | +| 4.8.2 | RUCI reporting ..... | 89 | +| 4.8.2.1 | Non-aggregated RUCI report procedure..... | 89 | +| 4.8.2.2 | Aggregated RUCI report procedure..... | 89 | +| 4.8.3 | Np reporting restriction provisioning ..... | 90 | +| 4.8.4 | UE mobility between RCAFs..... | 90 | +| 4.8.5 | Removal of UE context ..... | 91 | +| 4.9 | Traffic Steering Control Procedures over St reference point..... | 91 | +| 4.9.1 | St Session Establishment..... | 91 | +| 4.9.2 | St Session Modification..... | 92 | +| 4.9.3 | St Session Termination..... | 93 | +| 4.9.4 | St notification initiated by the TSSF ..... | 93 | +| 4.10 | Negotiation for future background data transfer procedure over Nt reference point..... | 94 | +| 5 | Binding Mechanism ..... | 94 | +| 5.1 | Overview ..... | 94 | +| 5.2 | Session Binding..... | 95 | +| 5.3 | PCC Rule Authorization and QoS Rule Generation ..... | 96 | +| 5.4 | Bearer Binding ..... | 97 | +| 6 | QoS Parameters Mapping ..... | 98 | +| 6.1 | Overview ..... | 98 | +| 6.1.1 | UE-Initiated IP-CAN bearers ..... | 100 | +| 6.1.2 | Network-Initiated IP-CAN bearers..... | 101 | +| 6.2 | QoS parameter mapping Functions at AF ..... | 102 | +| 6.3 | QoS parameter mapping Functions at PCRF ..... | 115 | +| 6.4 | QoS parameter mapping Functions at PCEF..... | 124 | +| 6.4.1 | GPRS ..... | 124 | +| 6.4.1.1 | Authorized IP QoS parameters per PDP Context to Authorized UMTS QoS parameters mapping in GGSN ..... | 124 | +| 6.4.1.2 | Comparing UMTS QoS Parameters against the Authorized UMTS QoS parameters in GGSN for UE initiated PDP context..... | 126 | +| 6.4.2 | 3GPP- EPS..... | 126 | +| 6.4.2.1 | Authorized IP QoS parameters per PDP Context to Authorized UMTS QoS parameters mapping in P-GW..... | 126 | +| 6.4.2.2 | Comparing UMTS QoS Parameters against the Authorized UMTS QoS parameters in P-GW for UE initiated PDP context..... | 129 | +| 6.5 | QoS parameter mapping Functions at UE for a UE-initiated GPRS PDP Context..... | 129 | +| 6.5.1 | SDP to UMTS QoS parameter mapping in UE..... | 131 | +| 6.5.2 | SDP parameters to Authorized UMTS QoS parameters mapping in UE..... | 131 | +| 7 | PCRF addressing..... | 137 | +| 7.1 | General ..... | 137 | +| 7.2 | DRA Definition..... | 137 | +| 7.3 | DRA Procedures..... | 137 | +| 7.3.1 | General ..... | 137 | +| 7.3.2 | DRA Information Storage ..... | 137 | + +| | | | +|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|------------| +| 7.3.3 | Capabilities Exchange ..... | 138 | +| 7.3.4 | Redirect DRA ..... | 138 | +| 7.3.4.1 | Redirecting Diameter Requests ..... | 138 | +| 7.3.4.2 | DRA binding removal..... | 139 | +| 7.3.5 | Proxy DRA ..... | 139 | +| 7.3.6 | PCRF selection by BBERF/PCEF (non-roaming case)..... | 139 | +| 7.3.7 | PCRF selection by AF ..... | 140 | +| 7.3.8 | PCRF selection in a roaming scenario..... | 140 | +| 7.3.9 | PCRF selection by TDF for unsolicited application reporting ..... | 141 | +| 7.3.10 | PCRF selection by RCAF..... | 141 | +| 7.4 | DRA flows..... | 141 | +| 7.4.1 | Proxy DRA ..... | 141 | +| 7.4.1.1 | Establishment of Diameter Sessions..... | 141 | +| 7.4.1.1.1 | Non-roaming cases..... | 141 | +| 7.4.1.1.2 | Roaming cases..... | 142 | +| 7.4.1.2 | Modification of Diameter Sessions..... | 143 | +| 7.4.1.2.1 | Non-roaming cases..... | 143 | +| 7.4.1.2.2 | Roaming cases..... | 145 | +| 7.4.1.2.2.2 | H-PCRF initiated ..... | 146 | +| 7.4.1.3 | Termination of Diameter Sessions..... | 147 | +| 7.4.1.3.1 | Non-roaming cases..... | 147 | +| 7.4.1.3.2 | Roaming cases..... | 148 | +| 7.4.2 | Redirect DRA ..... | 149 | +| 7.4.2.1 | Establishment of Diameter Sessions..... | 149 | +| 7.4.2.1.1 | Non-roaming cases..... | 149 | +| 7.4.2.1.2 | Roaming cases..... | 150 | +| 7.4.2.2 | Modification of Diameter sessions ..... | 151 | +| 7.4.2.3 | Termination of Diameter Sessions..... | 151 | +| 7.4.2.3.1 | Non-roaming cases..... | 151 | +| 7.4.2.3.2 | Roaming cases..... | 152 | +| 8 | Diameter race condition handling ..... | 154 | +| 8.1 | Overview ..... | 154 | +| 8.2 | Procedures for Gx, Gxx, Sd and S9 ..... | 154 | +| Annex A (informative): Examples of deriving the Maximum Authorized parameters from the SDP parameters ..... | | 156 | +| Annex B (normative): Signalling Flows for IMS..... | | 157 | +| B.0 | General..... | 157 | +| B.1 | Subscription to Notification of Signalling Path Status at IMS Registration..... | 157 | +| B.1a | Subscription to Notification of Change of IP-CAN Type at IMS Registration..... | 158 | +| B.1b | Provisioning of SIP signalling flow information at IMS Registration..... | 159 | +| B.1c | Subscription to Notification of Change of PLMN Identifier at IMS Registration..... | 160 | +| B.2 | IMS Session Establishment..... | 162 | +| B.2.1 | Provisioning of service information at Originating P-CSCF and PCRF..... | 162 | +| B.2.2 | Provisioning of service information at terminating P-CSCF and PCRF..... | 165 | +| B.3 | IMS Session Modification ..... | 169 | +| B.3.1 | Provisioning of service information..... | 169 | +| B.3.2 | Enabling of IP Flows..... | 173 | +| B.3.3 | Disabling of IP Flows..... | 174 | +| B.3.4 | Media Component Removal..... | 175 | +| B.4 | IMS Session Termination..... | 176 | +| B.4.1 | Mobile initiated session release / Network initiated session release..... | 176 | +| B.4.2 | IP-CAN Bearer Release/Loss..... | 178 | +| B.5 | P-CSCF Restoration ..... | 179 | + +| | | | +|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|------------| +| B.6 | IMS Restricted Local Operator Services ..... | 180 | +| B.7 | Retrieval of Network Provided Location Information for SMS over IP at Originating side..... | 180 | +| B.8 | Retrieval of Network Provided Location Information for SMS over IP at Terminating side ..... | 181 | +| Annex C (normative): NAT Related Procedures ..... | | 183 | +| C.1 | Support for media traversal of NATs using ICE..... | 183 | +| C.2 | P-CSCF procedures..... | 183 | +| C.2.1 | General ..... | 183 | +| C.2.2 | Deriving the Ues IP address..... | 184 | +| C.2.3 | Deriving flow descriptions ..... | 184 | +| C.2.4 | Gating control..... | 184 | +| C.2.5 | Bandwidth impacts..... | 184 | +| C.3 | PCRF procedures ..... | 185 | +| C.3.1 | General ..... | 185 | +| C.3.2 | Deriving additional flow descriptions ..... | 185 | +| C.3.3 | Gating control..... | 185 | +| C.3.4 | Bandwidth impacts..... | 185 | +| C.4 | P_CSCF procedures to support media traversal through hosted NAT without ICE..... | 185 | +| Annex D (normative): Access specific procedures for GPRS..... | | 187 | +| D.1 | General..... | 187 | +| D.2 | Binding Mechanisms..... | 187 | +| D.3 | PCC Procedures ..... | 188 | +| D.3.1 | IP-CAN Session Modification ..... | 188 | +| D.3.1.1 | Network-initiated IP-CAN Session Modification ..... | 188 | +| D.3.1.2 | PCEF-initiated IP-CAN Session Modification..... | 188 | +| D.3.1.2.1 | UE-initiated IP-CAN Bearer Establishment or IP-CAN Bearer Modification..... | 188 | +| D.3.1.2.2 | UE-initiated IP-CAN Bearer Termination..... | 191 | +| Annex E (normative): Fixed Broadband Access Interworking with EPC..... | | 194 | +| E.1 | General..... | 194 | +| E.2 | Definitions and abbreviations ..... | 194 | +| E.2.1 | Definitions..... | 194 | +| E.2.2 | Abbreviations ..... | 194 | +| E.3 | Binding Mechanisms..... | 194 | +| E.3.1 | EPC-routed traffic ..... | 194 | +| E.3.2 | NSWO traffic ..... | 194 | +| E.4 | PCC Procedures ..... | 195 | +| E.4.1 | Introduction ..... | 195 | +| E.4.2 | IP-CAN Session Establishment..... | 196 | +| E.4.2.1 | IP-CAN Session Establishment for EPC- routed traffic..... | 196 | +| E.4.2.2 | IP-CAN Session Establishment for NSWO traffic..... | 200 | +| E.4.3 | IP-CAN Session Termination..... | 202 | +| E.4.3.1 | IP-CAN Session Termination for EPC- routed traffic ..... | 202 | +| E.4.3.2 | IP-CAN Session Termination for NSWO traffic..... | 206 | +| E.4.3.2.1 | BPCF-initiated IP-CAN Session Termination for NSWO traffic..... | 206 | +| E.4.3.2.2 | PCRF-initiated IP-CAN Session Termination for NSWO traffic..... | 208 | +| E.4.4 | IP-CAN Session Modification ..... | 209 | +| E.4.4.1 | IP-CAN Session Modification for EPC-routed traffic ..... | 209 | +| E.4.4.1.1 | PCRF-initiated IP-CAN Session Modification..... | 209 | +| E.4.4.1.2 | BPCF-initiated IP-CAN Session Modification..... | 210 | +| E.4.4.1.3 | PCEF-initiated IP-CAN Session Modification..... | 212 | +| E.4.4.1.4 | BBERF-initiated IP-CAN Session Modification..... | 213 | +| E.4.4.2 | IP-CAN Session Modification for NSWO traffic ..... | 215 | + +| | | | +|-------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|------------| +| E.4.4.2.1 | PCRF-initiated IP-CAN Session Modification..... | 215 | +| E.4.4.2.2 | BPCF-initiated IP-CAN Session Modification..... | 217 | +| E.5 | 3GPP HNB Procedures – CS Support..... | 219 | +| E.5.1 | S9a CS Session Establishment..... | 219 | +| E.5.2 | PCRF initiated S9a CS Session Modification..... | 220 | +| E.5.2a | BPCF initiated S9a CS Session Modification..... | 221 | +| E.5.3 | S9a CS Session Termination..... | 221 | +| E.6 | PCRF Addressing..... | 222 | +| E.6.1 | General ..... | 222 | +| E.6.2 | DRA Definition..... | 223 | +| E.6.3 | DRA Procedure ..... | 223 | +| E.6.3.1 | DRA Information Storage ..... | 223 | +| E.6.3.2 | Capabilities Exchange ..... | 223 | +| E.6.3.3 | Redirect DRA ..... | 224 | +| E.6.3.4 | Proxy DRA ..... | 224 | +| E.6.3.5 | PCRF selection by BPCF ..... | 224 | +| E.6.3.6 | PCRF selection by AF and TDF in Unsolicited application reporting mode for NSWO traffic..... | 225 | +| E.6.3.7 | PCRF selection in a roaming scenario..... | 225 | +| E.6.3.8 | PCRF selection for the HNB CS Service ..... | 225 | +| E.6.4 | DRA flows..... | 226 | +| E.6.4.1 | General ..... | 226 | +| E.6.4.2 | Proxy DRA ..... | 226 | +| E.6.4.2.1 | S9 session establishment trigger ..... | 226 | +| E.6.4.2.2 | S9 session termination notification..... | 227 | +| E.6.4.3 | Redirect DRA ..... | 228 | +| E.6.4.3.1 | S9 session establishment trigger ..... | 228 | +| E.6.4.3.2 | S9 session termination notification..... | 228 | +| E.7 | BPCF Addressing..... | 229 | +| E.7.1 | General ..... | 229 | +| E.8 | Session Linking Function..... | 229 | +| Annex F (normative): Access specific aspects, Fixed Broadband Access network convergence ..... | | 230 | +| F.1 | General..... | 230 | +| F.2 | Definitions and abbreviations ..... | 230 | +| F.2.1 | Definitions..... | 230 | +| F.2.2 | Abbreviations ..... | 230 | +| F.3 | Binding Mechanisms..... | 230 | +| F.3.1 | NSWO traffic ..... | 230 | +| F.3.2 | Traffic from fixed devices..... | 231 | +| F.4 | PCC procedures..... | 231 | +| F.4.1 | Introduction ..... | 231 | +| F.4.2 | IP-CAN Session Establishment..... | 231 | +| F.4.3 | IP-CAN Session Termination..... | 231 | +| F.4.3.1 | UE-Initiated ..... | 231 | +| F.4.3.2 | PCEF-Initiated ..... | 232 | +| F.4.3.3 | PCRF-Initiated..... | 232 | +| F.4.4 | IP-CAN Session Modification ..... | 232 | +| F.4.4.1 | PCRF-Initiated IP-CAN Session Modification ..... | 232 | +| F.4.4.2 | PCEF-Initiated IP-CAN Session Modification ..... | 232 | +| F.5 | PCRF Addressing..... | 232 | +| F.5.1 | General ..... | 232 | +| F.5.2 | DRA Definition..... | 232 | +| F.5.3 | DRA Procedure ..... | 232 | +| F.5.3.1 | Redirect DRA ..... | 232 | +| F.5.3.2 | Proxy DRA ..... | 232 | +| F.5.3.3 | PCRF selection by AF and TDF in unsolicited application reporting mode..... | 233 | + +| | | | +|-------------------------------|-----------------------------------------------------|------------| +| F.5.3.4 | PCRF selection in a roaming scenario..... | 233 | +| F.5.4 | DRA flows..... | 233 | +| Annex G (normative): | Diameter overload control mechanism..... | 234 | +| G.1 | General..... | 234 | +| G.2 | Reporting Node..... | 234 | +| G.3 | Reacting Node..... | 234 | +| G.4 | DRA Diameter Overload Behavior..... | 234 | +| G.4.1 | DRA reacting to Host Reports ..... | 234 | +| Annex H (normative): | Access specific procedures for 3GPP EPS..... | 236 | +| H.1 | General..... | 236 | +| H.2 | Binding Mechanisms..... | 236 | +| Annex I (normative): | APN matching procedures ..... | 237 | +| Annex J (normative): | Diameter message priority mechanism..... | 237 | +| J.1 | General..... | 237 | +| J.2 | PCC functional element behaviour ..... | 237 | +| J.3 | Interactions..... | 238 | +| Annex K (normative): | Diameter load control mechanism ..... | 238 | +| K.1 | General..... | 238 | +| K.2 | Endpoint or Agent Reporting Node ..... | 238 | +| K.3 | Reacting Node..... | 238 | +| K.4 | DRA Behaviour..... | 239 | +| Annex L (informative): | Change history ..... | 240 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification adds detailed flows of Policy and Charging Control (PCC) over the Diameter-based Rx, Gx, Gxx, Sd, Sy, S9, Nt, Diameter-based St and Np reference points and their relationship with the bearer level signalling flows over the Gn/Gp, S4, S5/S8, S2a and S2c interfaces. + +The calls flows depicted in this Technical Specification represent usual cases, i.e. not all situations are covered. Detailed information provided in 3GPP TS 29.212 [9], 3GPP TS 29.214 [10], 3GPP TS 29.215 [22], 3GPP TS 29.217 [36], 3GPP TS 29.154 [56] and 3GPP TS 29.219 [28] shall be taken into consideration. + +The present specification also describes the PCC reference architectures for non-roaming and roaming scenarios. + +The present specification also describes the binding and the mapping of QoS parameters among SDP, UMTS QoS parameters, and QoS authorization parameters. + +The present specification also describes the PCRF addressing using DRA. + +The present specification also describes Diameter race condition handling for Gx based applications, i.e Gx, Gxx, Sd and S9. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication and/or edition number or version number) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: “Vocabulary for 3GPP Specifications”. +- [2] 3GPP TS 23.203: “Policy Control and charging architecture”. +- [3] 3GPP TS 23.060: “General Packet Radio Service (GPRS); Service description; Stage 2”. +- [4] 3GPP TS 23.107: “Quality of Service (QoS) concept and architecture”. +- [5] 3GPP TS 24.229: “IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3”. +- [6] 3GPP TS 26.234: “End-to-end transparent streaming service; Protocols and codecs”. + +- [7] Void. +- [8] Void +- [9] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [10] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [11] IETF RFC 2327: "SDP: Session Description Protocol". +- [12] IETF RFC 3264: "An Offer/Answer model with the Session Description Protocol (SDP)". +- [13] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [14] Void. +- [15] Void. +- [16] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [17] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". +- [18] 3GPP2 C.S0046-0 v1.0: "3G Multimedia Streaming Services". +- [19] 3GPP2 C.S0055-A v1.0: "Packet Switched Video Telephony Services (PSVT/MCS)". +- [20] Void +- [21] 3GPP TS 23.402: "Architecture Enhancements for non-3GPP accesses". +- [22] 3GPP TS 29.215: "Policy and Charging Control over S9 reference point". +- [23] IETF RFC 3890: "A Transport Independent Bandwidth Modifier for the Session Description Protocol (SDP) ". +- [24] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [27] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [28] 3GPP TS 29.219: "Policy and Charging Control over Sy reference point". +- [29] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction" +- [30] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS) Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH) ". +- [31] Void. +- [32] Broadband Forum WT-134: "Policy Control Framework" (work in progress). +- [33] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [34] 3GPP TS 23.468: "Group Services and System Aspects; Group Communication System Enablers for LTE (GCSE LTE)". +- [35] 3GPP TS 23.380: "IMS Restoration Procedures". +- [36] 3GPP TS 29.217: "Policy and Charging Control: Congestion Reporting over Np reference point". +- [37] 3GPP TS 23.003: "Numbering, addressing and identification". +- [38] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [39] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". + +- [40] IETF RFC 7944: "Diameter Routing Message Priority". +- [51] 3GPP TS 23.335: "User Data Convergence (UDC); Technical realization and information flows; Stage 2". +- [52] 3GPP TS 29.335: "User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface; Stage 3". +- [53] 3GPP TS 29.201: "Representational State Transfer (REST) reference point between Application Function (AF) and Protocol Converter (PC)". +- [54] 3GPP TS 29.155: "Traffic Steering Control; Representational State Transfer (REST) over St reference point". +- [55] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles". +- [56] 3GPP TS 29.154: "Service Capability Exposure Function over Nt reference point". +- [57] Void. +- [58] 3GPP TS 22.153: "Multimedia Priority Service". +- [59] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [60] IETF RFC 8583: "Diameter Load Information Conveyance". +- [61] IETF RFC 6733: "Diameter Base Protocol". +- [62] 3GPP TS 29.250: "Nu reference point between SCEF and PFDF for sponsored data connectivity". +- [63] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity". +- [64] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [65] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes; Stage 3". +- [66] 3GPP TS 23.221: "Architectural requirements". +- [67] IETF RFC 8445: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal". +- [68] IETF RFC 8839: "Session Description Protocol (SDP) Offer/Answer Procedures for Interactive Connectivity Establishment (ICE)". +- [69] IETF RFC 8864: "Negotiation Data Channels Using the Session Description Protocol (SDP)". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply: + +**DRA binding:** The PCRF routing information stored per UE or per PDN in the DRA, which include the user identity (UE NAI), the UE Ipv4 address and/or Ipv6 prefix, the APN (if available) and the selected PCRF identity for a certain IP-CAN Session. + +**Gateway Control Session:** An association between a BBERF and a PCRF (when GTP is not used in the EPC), used for transferring access specific parameters, BBERF events and QoS rules between the PCRF and BBERF. In the context of this specification this is implemented by use of the Gxx procedures. + +**IP-CAN session:** association between a UE and an IP network. + +The association is identified by one or more UE Ipv4 addresses/ and/or Ipv6 prefix together with a UE identity information, if available, and a PDN represented by a PDN ID (e.g. an APN). An IP-CAN session incorporates one or more IP-CAN bearers. Support for multiple IP-CAN bearers per IP-CAN session is IP-CAN specific. An IP-CAN session exists as long as the related UE Ipv4 address and/or Ipv6 prefix are assigned and announced to the IP network. + +**Policy counter:** A mechanism within the OCS to track spending applicable for a subscriber. + +**Policy counter status:** A label whose values are not standardized and that is associated with a policy counter's value relative to the spending limit(s) (the number of possible policy counter status values for a policy counter is one greater than the number of thresholds associated with that policy counter, i.e policy counter status values describe the status around the thresholds). This is used to convey information relating to subscriber spending from OCS to PCRF. Specific labels are configured jointly in OCS and PCRF. + +**RAN user plane congestion:** RAN user plane congestion occurs when the demand for RAN resources exceeds the available RAN capacity to deliver the user data for a prolonged period of time. + +NOTE: Short-duration traffic bursts is a normal condition at any traffic load level, and is not considered to be RAN user plane congestion. Likewise, a high-level of utilization of RAN resources (based on operator configuration) is considered a normal mode of operation and might not be RAN user plane congestion. + +**Restricted local operator services:** communication services provided by an operator that involve either automated or human assistance (e.g. credit card billing, directory assistance, customer care) for which successful authentication is not necessary. + +**Spending limit:** A spending limit is the usage limit of a policy counter (e.g. monetary, volume, duration) that a subscriber is allowed to consume. + +**Spending limit report:** a notification, containing the current policy counter status generated from the OCS to the PCRF via the Sy reference point. + +**TDF session:** An association between an IP-CAN session and the assigned TDF for the purpose of application detection and control by the PCRF . The association is identified by one UE Ipv4 address and/or Ipv6 prefix together with optionally a PDN represented by a PDN ID and a set of ADC rules to be applied by the TDF. + +## 3.2 Abbreviations + +For the purpose of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply: + +| | | +|--------|-----------------------------------------------------------------------------| +| ADC | Application Detection and Control | +| AF | Application Function | +| ARA | Aggregated RUCI Report Answer | +| ARP | Allocation and Retention Priority | +| ARR | Aggregated RUCI Report Request | +| AVP | Attribute-Value Pair | +| BBERF | Bearer Binding and Event Reporting Function | +| CHEM | Coverage and Handoff Enhancements using Multimedia error robustness feature | +| CSG | Closed Subscriber Group | +| CSG ID | Closed Subscriber Group Identity | +| CoA | Care of Address | +| DRA | Diameter Routing Agent | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| DTS | Data Transport Service | +| GBR | Guaranteed Bitrate | +| GCS | Group Communication Service | +| GCS AS | Group Communication Service Application Server | +| H-AF | Home AF | +| H-DRA | Home DRA | +| H-PCRF | Home PCRF | +| HPLMN | Home PLMN | +| MBR | Maximum Bitrate | +| MUA | Modify UE context Answer | + +| | | +|--------|------------------------------------------| +| MUR | Modify UE context Request | +| MPS | Multimedia Priority Service | +| NBIFOM | Network-based IP flow mobility | +| NRA | Non-Aggregated RUCI Report Answer | +| NRR | Non-Aggregated RUCI Report Request | +| PA | Proxy Agent | +| PCC | Policy and Charging Control | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rule Function | +| PGW | PDN-Gateway | +| PFDF | Packet Flow Description Function | +| RLOS | Restricted Local Operator Services | +| QCI | QoS Class Identifier | +| RCAF | RAN Congestion Awareness Function | +| RUCI | RAN User Plane Congestion Information | +| SCEF | Service Capability Exposure Function | +| SDF | Service Data Flow | +| SLA | Spending Limit Answer | +| SLR | Spending Limit Request | +| SNA | Spending-Status Notification Answer | +| SSD | Source Statistics Descriptor | +| SNR | Spending-Status Notification Request | +| STA | Session Termination Answer | +| TSSF | Traffic Steering Support Function | +| STR | Session Termination Request | +| TDF | Traffic Detection Function | +| UDC | User Data Convergence | +| UDR | User Data Repository | +| V-AF | Visited AF | +| V-DRA | Visited DRA | +| V-PCRF | Visited PCRF | +| VPLMN | Visited PLMN | + +# --- 3a Reference architecture + +The PCC functionality is provided by the functions of the Policy and Charging Rules Function (PCRF), the Policy and Charging Enforcement Function (PCEF), the Bearer Binding and Event Reporting Function (BBERF), the Application Function (AF), the Traffic Detection Function (TDF), the Traffic Steering Support Function (TSSF), the RAN Congestion Awareness Function (RCAF), the Service Capability Exposure Function (SCEF), the Packet Flow Description Function (PFDF), the Online Charging System (OCS), the Offline Charging System (OFCS) and the Subscription Profile Repository (SPR) or the User Data Repository (UDR). UDR replaces SPR when the UDC architecture as defined in 3GPP TS 23.335 [51] is applied to store PCC related subscription data. In this deployment scenario Ud interface as defined in 3GPP TS 29.335 [52] between PCRF and UDR is used to access subscription data in the UDR. 3GPP TS 23.203 [2] specifies the PCC stage 2 functionality. + +![Overall PCC architecture for non-roaming scenario diagram](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +The diagram illustrates the overall PCC architecture for a non-roaming scenario. At the top, four functional blocks are arranged horizontally: **RAN Congestion Awareness Function (RCAF)**, **Subscription Profile Repository (SPR)/ User Data Repository (UDR)**, **Application Function (AF)**, and **Service Capability Exposure Function (SCEF)**. These are connected to a central **Policy and Charging Rules Function (PCRF)** via interfaces **Np**, **Sp/Ud**, **Rx**, and **Nt** respectively. The **PCRF** is connected to an **Online Charging System (OCS)** via the **Sy** interface. Below the PCRF, there are three main components: **Bearer Binding and Event Reporting Function (BBERF)** (part of an **AN-Gateway**), **Policy and Charging Enforcement Function (PCEF)** (part of a **Gateway**), and **Traffic Detection Function (TDF)**. The **PCRF** connects to the **BBERF** via **Gxx**, to the **PCEF** via **Gx**, and to the **TDF** via **Sd**. The **TDF** is connected to a **Packet Flow Description Function (PFDF)** via **Gy**. The **PFDF** is connected to the **OCS** via **Gwn** and to an **Offline Charging System (OFCS)** via **Gzn**. The **PCEF** is connected to the **PFDF** via **Gw** and to the **OFCS** via **Gz**. Additionally, the **SCEF** is connected to the **PCRF** via **Nu**, and to a **Traffic Steering Support Function (TSSF)** via **St**. The **TSSF** is connected to the **PFDF** via **Gyn**. + +Overall PCC architecture for non-roaming scenario diagram + +Figure 3a.1: Overall PCC architecture for non-roaming scenario + +![Overall PCC architecture for roaming with home routed access scenario diagram showing VPLMN and HPLMN components and their interfaces.](88b0f3f4393228e9ea4d6542aef7c399_img.jpg) + +The diagram illustrates the Overall PCC architecture for a roaming with home routed access scenario, divided into two main domains: VPLMN (Visited PLMN) and HPLMN (Home PLMN). + +**VPLMN Components:** + +- RAN Congestion Awareness Function (RCAF)** +- Policy and Charging Rules Function (V-PCRF)** +- AN-Gateway** containing the **Bearer Binding and Event Reporting Function (BBERF)** + +**HPLMN Components:** + +- Application Function (AF)** +- Service Capability Exposure Function (SCEF)** +- Subscription Profile Repository (SPR)/User Data Repository (UDR)** (represented as a cylinder) +- Policy and Charging Rules Function (H-PCRF)** +- Packet Flow Description Function (PFDF)** +- Traffic Steering Support Function (TSSF)** +- Policy and Charging Enforcement Function (PCEF)** (part of the **Gateway**) +- Traffic Detection Function (TDF)** +- Online Charging System (OCS)** +- Offline Charging System (OFCS)** + +**Interfaces:** + +- Np**: Interface between RCAF and H-PCRF. +- S9**: Interface between V-PCRF and H-PCRF. +- Gxx**: Interface between V-PCRF and BBERF. +- Rx**: Interface between AF and H-PCRF. +- Nt**: Interface between SCEF and H-PCRF. +- Nu**: Interface between SCEF and PFDF. +- Sp/Ud**: Interface between SPR/UDR and PFDF. +- St**: Interface between H-PCRF and TSSF. +- Gx**: Interface between H-PCRF and PCEF. +- Sd**: Interface between H-PCRF and TDF. +- Gw**: Interface between H-PCRF and OCS. +- Gwn**: Interface between H-PCRF and OFCS. +- Gy**: Interface between PCEF and OCS. +- Gyn**: Interface between TDF and OCS. +- Gzn**: Interface between TDF and OFCS. +- Gz**: Interface between PCEF and OFCS. + +Overall PCC architecture for roaming with home routed access scenario diagram showing VPLMN and HPLMN components and their interfaces. + +Figure 3a.2: Overall PCC architecture for roaming with home routed access scenario + +![Figure 3a.3: Overall PCC architecture for roaming with visited access scenario. The diagram shows the interaction between various network functions in the VPLMN (Visited PLMN) and HPLMN (Home PLMN).](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +The diagram illustrates the overall PCC architecture for a roaming with visited access scenario, divided into VPLMN (Visited PLMN) and HPLMN (Home PLMN) by a vertical dashed line. + +- VPLMN (Visited PLMN):** + - RAN Congestion Awareness Function (RCAF)** connects to **Policy and Charging Rules Function (V-PCRF)** via the **Np** reference point. + - Application Function (AF)** connects to **V-PCRF** via the **Rx** reference point. + - Bearer Binding and Event Reporting Function (BBERF)** (part of **AN-Gateway**) connects to **V-PCRF** via the **Gxx** reference point. + - Policy and Charging Enforcement Function (PCEF)** (part of **Gateway**) connects to **V-PCRF** via the **Gx** reference point. + - Traffic Detection Function (TDF)** connects to **V-PCRF** via the **Sd** reference point. +- HPLMN (Home PLMN):** + - Application Function (AF)** connects to **Policy and Charging Rules Function (H-PCRF)** via the **Rx** reference point. + - Service Capability Exposure Function (SCEF)** connects to **H-PCRF** via the **Nt** reference point. + - Subscription Profile Repository (SPR)/User Data Repository (UDR)** connects to **H-PCRF** via the **Sp/Ud** reference point. + - Online Charging System (OCS)** connects to **H-PCRF** via the **Sy** reference point. + - Offline Charging System (OFCS)** connects to **H-PCRF** via the **Gy** reference point. +- Interconnections:** + - V-PCRF** and **H-PCRF** are connected via the **S9** reference point. + - H-PCRF** connects to **OCS** via the **Gyn** reference point. + - H-PCRF** connects to **OFCS** via the **Gzn** and **Gz** reference points. + +Figure 3a.3: Overall PCC architecture for roaming with visited access scenario. The diagram shows the interaction between various network functions in the VPLMN (Visited PLMN) and HPLMN (Home PLMN). + +**Figure 3a.3: Overall PCC architecture for roaming with visited access scenario** + +NOTE 1: The Sp reference point is located between PCRF and SPR, The Ud interface is located between PCRF and UDR. + +NOTE 2: The UDC Application Informational Model related to the PCRF is not specified in this Release. + +NOTE 3: AF can be located in both VPLMN and HPLMN for the visited access. + +NOTE 4: The H-PCRF can optionally send the addresses of the OCS to the V-PCRF in the visited access. + +NOTE 5: Use of TSSF in roaming scenarios is in this release only specified for the home routed access. + +NOTE 6: The SCEF acts as an AF (using Rx) in some service capability exposure use cases as described in 3GPP TS 23.682 [38]. + +NOTE 7: Gw and Gwn reference points are not supported in the visited access. + +NOTE 8: The PCEF and TDF can each be decomposed into a User Plane Function and a Control Plane Function connected via the Sx reference point specified in 3GPP TS 29.244 [65]. + +The protocols for the Gx reference point, the Gxx reference point and the Sd reference point are specified in 3GPP TS 29.212 [9]. + +The protocols for the St reference point are specified in 3GPP TS 29.212 [9] and 3GPP TS 29.155 [54]. + +The protocols for the Rx reference point are specified in 3GPP TS 29.214 [10] and 3GPP TS 29.201 [53]. + +The protocol for the S9 reference point is specified in 3GPP TS 29.215 [22]. + +The protocol for the Sy reference point is specified in 3GPP TS 29.219 [28]. + +The protocol for the Np reference point is specified in 3GPP TS 29.217 [36]. + +The protocol for the Nt reference point is specified in 3GPP TS 29.154 [56]. + +The protocol for the Nu reference point is specified in 3GPP TS 29.250 [62]. + +The protocols for the Gw and Gwn reference points are specified in 3GPP TS 29.251 [63]. + +More information about the protocols on the Gy reference point, the Gyn reference point, the Gz reference point and the Gzn reference point are provided in 3GPP TS 32.240 [55]. + +The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +The UDR replaces the SPR when the UDC architecture as defined in 3GPP TS 23.335 [51] is applied to store PCC related subscription data. In this deployment scenario Ud interface as defined in 3GPP TS 29.335 [52] between PCRF and UDR is used to access subscription data in the UDR. + +# --- 4 Signalling Flows over Gx, Gxx, Rx, Sd, Sy, Np, Nt, St and S9 + +## 4.0 General + +There are three distinct network scenarios for an IP-CAN Session: + +Case 1. No Gateway Control Session is required, no Gateway Control Establishment occurs at all (e.g. 3GPP Access where GTP-based S5/S8 are employed, and Non-3GPP access where GTP-based S2a or GTP-based S2b is employed). + +Case 2. A Gateway Control Session is required. There are two subcases: + +2a) The BBERF assigns a Care of Address (CoA) to the UE and establishes a Gateway Control Session prior to any IP-CAN session establishment that will apply for all IP-CAN sessions using that CoA. + +2b) At IP-CAN session establishment a Gateway Control Session is required before the PCEF announces the IP-CAN Session to the PCRF. At BBERF change and pre-registration the Gateway Control Session shall match an IP-CAN session that the PCEF has already announced. Each IP-CAN session is handled in a separate Gateway Control Session. + +The PCRF shall select whether case 2a or case 2b applies based on the information received in the Gateway Control Session Establishment. For a user identified with a Subscription-Id AVP, when the PDN identifier included as part of the Called-Station-Id AVP is received, case 2b applies. If not received, case 2a applies. + +The following considerations shall be taken into account when interpreting the signalling flows: + +- V-PCRF is included to also cover the roaming scenarios. +- H-PCRF will act as a PCRF for non-roaming Ues. +- The steps numbered as “number+letter” (e.g. “3a”) will be executed, for the roaming case, instead of steps numbered as “number” (e.g. “3”), as indicated in the explanatory text below the signalling flows. +- Emergency services and RLOS are handled locally in the serving network, therefore the S9 reference point does not apply. + +NOTE: For the Visited Access case, the operator can by roaming agreement decide not to use S9 reference point. + +The procedure to detect that the Gx session or a Gateway Control Session is restricted to Emergency Services is described in 3GPP TS 29.212 [9]. + +- The procedure to detect that the Gx session is restricted to RLOS is described in 3GPP TS 29.212 [9]. +- Subscription-related information is not relevant for the policy control of Emergency Sessions and RLOS; therefore Sp reference point does not apply in that case. +- With the UDC-based architecture as defined in 3GPP TS 23.203 [2] and 3GPP TS 23.335 [51], SPR, whenever mentioned in the present specification, refers to UDR. The Ud interface as defined in 3GPP TS 29.335 [52] is the interface between the PCRF and the UDR. +- When monitoring event reporting via PCRF applies as defined in 3GPP TS 23.682 [38], the SCEF is acting as an AF. In this case, only the flows where the AF is located in the home network apply. Support of this functionality is detailed in 3GPP TS 29.214 [10], Annex D. +- If the PCEF/BBERF/TDF needs to send an IP-CAN session/ Gateway Control Session/ TDF session modification request towards a PCRF which is known to have restarted since the IP-CAN session/ Gateway Control Session/ TDF session establishment, the PCEF/BBERF/TDF shall follow the PCRF Failure and Restoration procedure as defined in 3GPP TS 29.212 [9]. + +NOTE: Only the interaction with OCS for spending limits reporting over Sy interface is introduced in this document. + +- The PCEF and TDF are depicted as monolithic entities in the signalling flows, but each of those can be decomposed into a User Plane Function and a Control Plane Function connected via the Sx reference point. Signalling on the Sx reference point is not shown. + +## 4.1 IP-CAN Session Establishment + +This subclause is applicable if a new IP-CAN Session is being established. + +![Sequence diagram for IP-CAN Session Establishment showing interactions between BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, SPR, and OCS. The diagram is divided into two 'VISITED ACCESS CASE' sections. It details steps like Gateway Control Session Establishment, IP-CAN Session Request, Diameter CCR/CCA messages, Profile Requests/Responses, Spending Limit Reports, PCC/ADC Rules Decisions, and TDF/St session establishments.](e6df2733626a85205c1db682e6259c46_img.jpg) + +The sequence diagram illustrates the IP-CAN Session Establishment process. The lifelines involved are BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, SPR, and OCS. The process is organized into two 'VISITED ACCESS CASE' blocks. + +- 1. Gateway Control Session Establishment (case 2a and 2b):** Initiated by BBERF. +- 2. Establish IP-CAN Session:** BBERF sends a Request to PCEF. +- 3. Diameter CCR:** PCEF sends to TDF, which then sends to V-PCRF. +- 3b. Store Information:** V-PCRF stores information. +- 3c. Diameter CCR:** V-PCRF sends to H-PCRF. +- 4. Store Information:** H-PCRF stores information. +- 5. Profile Request / 6. Profile Response:** H-PCRF sends a Profile Request to SPR, which responds. +- 7. Initial/intermediate Spending Limit Report Request:** H-PCRF sends to OCS. +- 8. PCC Rules Decision; Policy Decision:** OCS makes a decision. +- 9. Store PCC Rules:** OCS stores rules. +- 10. ADC Rules Decision; Store ADC Rules:** OCS makes another decision. +- 11. TDF session establishment:** TDF initiates session establishment. +- 12. St session establishment:** TSSF initiates session establishment. +- 13. Diameter CCA:** TDF sends CCA to PCEF. +- 13a. Diameter CCA:** V-PCRF sends CCA to H-PCRF. +- 13b. Policy Enforcement:** V-PCRF enforces policy. +- 13c. Store ADC Rules; Policy Decision:** V-PCRF stores rules. +- 13d. Diameter CCR:** V-PCRF sends CCR to H-PCRF. +- 13e. Diameter CCA:** V-PCRF sends CCA to H-PCRF. +- 13f. TDF session establishment:** TDF completes session establishment. +- 13g. Diameter CCA:** TDF sends CCA to PCEF. +- 14. Gateway Control and QoS Rules Provision (case 2a and 2b):** BBERF initiates rules provision. +- 15. Install PCC Rules, Policy Enforcement:** BBERF installs rules. +- 16. Establish IP-CAN session Response:** BBERF sends response to PCEF. + +Sequence diagram for IP-CAN Session Establishment showing interactions between BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, SPR, and OCS. The diagram is divided into two 'VISITED ACCESS CASE' sections. It details steps like Gateway Control Session Establishment, IP-CAN Session Request, Diameter CCR/CCA messages, Profile Requests/Responses, Spending Limit Reports, PCC/ADC Rules Decisions, and TDF/St session establishments. + +**Figure 4.1.1: IP-CAN Session Establishment** + +1. The BBERF may initiate a Gateway Control Session Establishment procedure as defined in subclause 4.4.1 (applicable for cases 2a during initial attach and 2b, as defined in subclause 4.0), if appropriate. In this step, the PCRF determines whether the cases 2a or 2b applies, as defined in subclause 4.0. +2. The PCEF receives an Establish IP-CAN Session Request. The form of the Establish IP-CAN Session Request depends upon the type of the IP-CAN. + +3. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the PCEF informs the H-PCRF of the IP-CAN Session establishment. The PCEF starts a new Gx session by sending a CCR to the H-PCRF using the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The PCEF provides UE identity information, PDN identifier, the UE Ipv4 address and/or UE Ipv6 prefix and, if available, the PDN connection identifier, IP-CAN type, RAT type and/or the default charging method and additional charging parameters as defined in subclause 4.5.1 of 3GPP TS 29.212 [9] and may send charging characteristics if available. The PCEF provides, when available, the Default-EPS-Bearer-QoS and the APN-AMBR to the PCRF. The PCEF may provide the applicable TDF routing information in TDF-Information AVP. If the UE has declared support for the extended TFT filter format and the PCEF does not prevent the use thereof, the PCEF shall indicate that the support for extended TFT filters is available in the IP-CAN session. For types of IP-CAN, where the H-PCRF can be in control of IP-CAN Bearers, e.g. GPRS, the PCEF also provides a new bearer identifier and information about the requested bearer, such as QoS. If applicable for the IP-CAN type, it will also provide information to indicate whether NW-initiated bearer control procedures are supported, if available. The PCRF links the Gx session for the new IP-CAN session with the corresponding Gateway Control Session as defined in subclause 4.0. The PCRF maintains aligned set of PCC and QoS rules in the PCEF and BBERF(s) as applicable for the case. For case 2a and if IP flow mobility is supported, the PCEF provides, when available, the IP flow mobility routing rules. For case 1 and if NBIFOM is supported, the PCEF provides, when available, the NBIFOM support and NBIFOM mode information. If available, the PCEF provides a timestamp corresponding to the time at which the request was initiated by the originating node, and additionally the PCEF can include the maximum wait time as defined in subclause 4.5.1 of 3GPP TS 29.212 [9]. + +For the case when the UE is roaming in a Visited Access scenario, steps 3a~3c are executed instead of step 3. + +- 3a. The PCEF informs the V-PCRF of the establishment of the IP-CAN session. The PCEF starts a new Gx session by sending a CCR to the V-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The parameters for CCR as listed in step 3 are applicable here. +- 3b. The V-PCRF determines that the request is for a roaming user and concludes the IP-CAN session uses visited access. V-PCRF stores the received information. +- 3c. If there is not an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. + +If there is an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. + +4. The H-PCRF stores the information received in the CCR. For cases 2a and 2b, the H-PCRF links the Gx session with the Gateway Control Session(s). + +NOTE 1: In the case 2a, when an additional PDN connection is established, the Gx session is linked with the already established Gateway Control Session. + +5. If the H-PCRF requires subscription-related information and does not have it, the H-PCRF sends a request to the SPR in order to receive the information. +6. The SPR replies with the subscription related information containing the information about the allowed service(s), QoS information, PCC Rules information and may include MPS EPS Priority, MPS Priority Level and IMS Signalling Priority for establishing a PS session with priority. + +NOTE 2: For steps 5 and 6: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +7. If the PCRF determines that the policy decision depends on the status of the policy counters available at the OCS and no Sy session yet has been established for this subscriber, the PCRF sends an Initial Spending Limit Report Request as defined in subclause 4.7.1. If the Sy session is already established for this subscriber, the PCRF may send, if required, an Intermediate Spending Limit Report Request as defined in subclause 4.7.2. + +8. The H-PCRF selects or generates PCC Rule(s) to be installed. The H- PCRF may also make a policy decision by deriving an authorized QoS and by deciding whether service flows described in the PCC Rules are to be enabled or disabled. If MPS EPS Priority, MPS Priority Level, and IMS Signalling Priority are present for the user, the PCRF takes the information into account. If NBIFOM is supported, the PCRF determines whether the NBIFOM applies to the IP-CAN session and selects the NBIFOM mode. +9. The H-PCRF stores the selected PCC Rules. The H-PCRF selects the Bearer Control Mode that will apply during the IP-CAN session if applicable for the particular IP-CAN. If the H-PCRF controls the binding of IP-CAN Bearers, the H-PCRF stores information about the IP-CAN Bearer to which the PCC Rules have been assigned. If the BBERF/PCEF controls the binding of IP-CAN bearers, the H-PCRF may derive the QoS information per QCI applicable to that IP-CAN session for non-GBR bearers. +10. When user profile configuration indicates that Application Detection and Control function is enabled, the H-PCRF makes the policy decision for the application detection and control. For the non-roaming case, or for the case when the UE is roaming in a Home Routed scenario, the H-PCRF selects the applicable PCC Rules to be provided for application detection and control for the PCEF supporting ADC feature, or the applicable ADC rules for the solicited application reporting with a TDF. For the case when the UE is roaming in a Visited Access scenario, the H-PCRF selects the applicable PCC Rules to be provided for application detection and control. For solicited application reporting with a TDF, the H-PCRF finds the TDF by using the TDF-Information AVP received from the PCEF in step 3, or, if not received, using a pre-configured TDF address. +11. Only applicable for non-roaming case, and for the case when the UE is roaming in a home routed case, In case of solicited application reporting with a TDF, the PCRF initiates a TDF Session Establishment procedure, according to subclause 4.6.1, with the selected TDF. +12. If traffic steering control over St applies and the H-PCRF determines that traffic steering control information is needed for the IP-CAN session, the PCRF initiates an St session establishment procedure according to subclause 4.9.1 with the TSSF. The TSSF identifier is pre-configured on the PCRF per e.g. PCEF. +13. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the H-PCRF provisions the PCC Rules to the PCEF using CCA. The H-PCRF also provides the selected Bearer Control Mode if applicable for the particular IP-CAN and if available, the QoS information per QCI. If the PCEF has indicated that the support for extended TFT filters is available in the IP-CAN session, then the PCRF may, by indicating the PCRF support for extended TFT filters, enable the use of the extended TFT filter format in the IP-CAN session. The PCRF may also provide event triggers listing events for which the PCRF desires PCC Rule Requests. Furthermore, the PCRF may provide authorized QoS including the APN-AMBR and the Default-EPS-Bearer-QoS, User Location Information, user CSG information (if received from the BBERF) and Presence Reporting Area Information. If usage monitoring is enabled, the H-PCRF may provide the applicable thresholds for usage monitoring control at PCEF within the Usage-Monitoring-Information AVP. If NBIFOM is supported, the H-PCRF provides the decision on whether the NBIFOM is supported and the selected NBIFOM mode if applicable. + +For types of IP-CAN, where the PCRF controls IP-CAN Bearers, e.g. GPRS, the PCRF indicates the IP-CAN Bearer where the PCC Rules are to be installed and that the authorized QoS refers to. Otherwise, the PCRF operates without any further reference to any specific bearer. + +If the PCEF supports Application Detection and Control feature, the PCRF provisions the applicable PCC Rules to the PCEF for the corresponding IP-CAN session. + +If online charging is applicable then the PCEF requests credit information from the OCS over the Gy interface. If the PCEF receives credit re-authorisation triggers from the OCS then, for case 2b, it requests the PCRF via a CCR message to provision the triggers at the BBERF. The triggers to be provisioned are specified in the Event-Report-Indication AVP in the CCR message. + +For the case when the UE is roaming in a Visited Access scenario, steps 13a -13g are executed. + +- 13a. The PCC Rules, if they were selected in step 9, are provisioned by the H-PCRF to the V-PCRF by using a CCA. The H-PCRF includes PCC Rules in the Subsession-Decision-Info AVP of the CCA, along with the S9 subsession identifier as received in step 3c within the Subsession-Id AVP. Other parameters listed in step 9 are also applicable here. +- 13b. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. + +- 13c. In case of TDF, if Application Detection and Control function is enabled for the IP-CAN session, the V-PCRF extracts ADC rules from the received PCC rules from the H-PCRF and stores the ADC rules. +- 13d. The V-PCRF informs the H-PCRF when a request has been denied and may provide the acceptable QoS Information for the service. +- 13e. The H-PCRF acknowledges the CCR and may additionally include new or modified PCC rules to the V-PCRF. When user profile configuration indicates that Application Detection and Control function is enabled, some of those PCC Rules may be dedicated for application detection and control. +- 13f. In case of solicited application reporting with a TDF, the V-PCRF initiates a TDF Session Establishment procedure, according to subclause 4.6.1, with the selected TDF and provides ADC Rules extracted from the corresponding PCC Rules. +- 13g. The V-PCRF provisions PCC rules received from the H-PCRF to the PCEF by using CCA. The parameters listed in step 11a are applicable here, User Location Information and user CSG information (if received from the BBERF). + +NOTE 3: From this point and onward, the PCRF is responsible for keeping the active PCC, ADC and QoS rules aligned. + +- 14. If case 2a or 2b applies, the PCRF aligns the set of QoS rules at the BBERF with the set of active rules at the PCEF. +- 15. The PCEF installs the received PCC Rules. The PCEF also enforces the authorized QoS and enables or disables service flows according to the flow status of the corresponding PCC Rules. If QoS information is received per QCI, PCEF sets the upper limit accordingly for the MBR that the PCEF assigns to the non-GBR bearer(s) for that QCI. In case of PCEF supporting Application Detection and Control feature, the PCEF enforces the application detection and control. +- 16. The PCEF sends a response to the Establish IP-CAN Session Request. +For GPRS, the GGSN accepts the PDP Context Request based on the results of the authorisation policy decision enforcement. If the requested QoS parameters do not correspond to the authorized QoS, the GGSN adjusts (downgrades /upgrades) the requested UMTS QoS parameters to the authorized values. + +NOTE 4: The PCRF can reject the IP-CAN session establishment, e.g. the PCRF cannot obtain the subscription-related information from the SPR and the PCRF cannot make the PCC rule decisions, as described in 3GPP TS 29.212 [9]. + +PCEF can also enforce active preconfigured PCC rules which are not known to the PCRF. + +The PCEF can also reject the IP-CAN session establishment, e.g. there is no active PCC rule for the IP-CAN session as specified in 3GPP TS 23.203 [2]. + +## 4.2 IP-CAN Session Termination + +### 4.2.1 UE-Initiated + +#### 4.2.1.1 AF located in the HPLMN + +This clause is applicable if an IP-CAN Session is being released by the UE and the AF is located in the HPLMN. + +![Sequence diagram for UE-Initiated IP-CAN Session Termination – AF located in the HPLMN. The diagram shows interactions between BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, and OCS. It is divided into two 'VISITED ACCESS CASE' sections. The process involves removing the IP-CAN session, terminating gateway control sessions, Diameter CCR/CCA exchanges, TDF session termination for roaming UEs, UE context removal, AF session identification, final spending limit reports, and PCRF-initiated gateway control session termination.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +The sequence diagram illustrates the interaction for UE-Initiated IP-CAN Session Termination where the AF is located in the HPLMN. The lifelines are BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, and OCS. The process is as follows: + +- 1. Remove IP-CAN Session Request**: BBERF sends a request to PCEF. +- 2. BBERF-initiated Gateway Control Session Termination (case 2b)**: BBERF initiates this procedure. +- 3. Diameter CCR**: PCEF sends a CCR to H-PCRF. +- 3a. Diameter CCR**: PCEF sends a CCR to V-PCRF (Visited Access Case). +- 3b. TDF session termination for roaming UE with visited access**: Conditional message from V-PCRF to TDF. +- 3c. UE context removal**: Conditional message from V-PCRF to TSSF. +- 3d. Diameter CCR**: V-PCRF sends a CCR to H-PCRF. +- 4. Identify AF Sessions bound to the removed IP-CAN Session**: H-PCRF sends this message to H-AF. +- 5. Diameter CCA**: H-PCRF sends a CCA to PCEF. +- 5a. Diameter CCA**: H-PCRF sends a CCA to V-PCRF (Visited Access Case). +- 5b. removes the information related to the terminated IP-CAN Session**: V-PCRF performs internal processing. +- 5c. Diameter CCA**: V-PCRF sends a CCA to PCEF. +- 6. Remove IP-CAN Session Response**: PCEF sends a response to BBERF. +- 7. TDF session termination for roaming UE with home-routed access**: Conditional message from H-PCRF to TDF. +- 8. UE context removal**: Conditional message from H-PCRF to TSSF. +- 9. Diameter ASR**: H-PCRF sends an ASR to H-AF for each affected AF session. +- 10. Diameter ASA**: H-AF sends an ASA to H-PCRF. +- 11. Diameter STR**: H-PCRF sends an STR to H-AF. +- 12. Diameter STA**: H-AF sends a STA to H-PCRF. +- 13. Final Spending Limit Report Request/Intermediate Spending Limit Report Request**: H-PCRF sends this message to OCS. +- 14. Gateway Control and Qos Rules provision (case 2a) Or PCRF-initiated Gateway Control Session Termination (case 2a)**: H-PCRF initiates this procedure. +- 15. Cancel Subscribed Notification request**: H-PCRF sends this message to SPR. +- 16. Cancel Subscribed Notification Response**: SPR sends a response to H-PCRF. +- 17. St session termination**: Conditional message from H-PCRF to TSSF. + +**Legend:** + +- Mandatory**: Solid line with arrowhead +- Conditional**: Dashed line with arrowhead + +Sequence diagram for UE-Initiated IP-CAN Session Termination – AF located in the HPLMN. The diagram shows interactions between BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, and OCS. It is divided into two 'VISITED ACCESS CASE' sections. The process involves removing the IP-CAN session, terminating gateway control sessions, Diameter CCR/CCA exchanges, TDF session termination for roaming UEs, UE context removal, AF session identification, final spending limit reports, and PCRF-initiated gateway control session termination. + +**Figure 4.2.1.1.1: UE-Initiated IP-CAN Session Termination – AF located in the HPLMN** + +In the following procedures, the V-PCRF is included to depict the roaming scenarios. H-PCRF acts as the PCRF for non-roaming UEs. + +- If case 2b applies (as defined in clause 4.0), the BBERF receives a request to remove the IP-CAN session. In case 2a, the request goes transparently through the BBERF. In all cases, the PCEF receives a request to remove the IP-CAN Session. The form of the Remove IP-CAN Session Request depends upon the type of the IP-CAN. +- If case 2b applies (as defined in clause 4.0), the BBERF-initiated Gateway Control Session Termination procedure as defined in clause 4.4.4 (BBERF-Initiated Gateway Control Session Termination) is initiated. + +3. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the PCEF sends a CCR to the H-PCRF, indicating the IP-CAN Session termination. The PCEF requests the termination of the Gx session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. If the usage monitoring is enabled, the PCEF informs the H-PCRF about the resources that have been consumed by the user since the last report. If the Required-Access-Info AVP is included in any PCC Rule, the PCEF informs the H-PCRF about the access network information. If NAS-RAN-Cause feature is supported the PCEF informs the H-PCRF about the access network information and the failure cause(s), if available. + +For the case when the UE is roaming in a Visited Access scenario, steps 3a~3b are executed instead of step 3: + +- 3a. The PCEF sends a CCR to the V-PCRF, indicating the IP-CAN Session termination. The PCEF requests the termination of the Gx session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. If the usage monitoring is enabled, the PCEF informs the V-PCRF about the resources that have been consumed by the user since the last report. If the Required-Access-Info AVP is included in any PCC Rule, the PCEF informs the V-PCRF about access network information. +- 3b If there is an active TDF session between the TDF and the V-PCRF, for roaming UE with visited access, the TDF Session termination is initiated as defined in Section 4.6.2. For this case, the PCRF described in Section 4.6.2 acts as a V-PCRF. +- 3c. If congestion reporting is active for the user id and PDN id, for roaming UE with visited access, the V-PCRF initiates a UE context removal as defined in clause 4.8.5. +- 3d. The V-PCRF sends the CCR to the H-PCRF. If case 2b or case 1 applies and this is the last subsession associated with the S9 session, the V-PCRF sends a CCR to the H-PCRF to request the termination of the S9 session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. Otherwise, the V-PCRF sends a CCR to the H-PCRF with a CC-Request-Type AVP set to the value UPDATE\_REQUEST and a Subsession-Enforcement-Info within which the Subsession-Operation AVP set to value TERMINATION to request the termination of the corresponding S9 subsession. + +NOTE 1: If the usage monitoring is enabled on PCEF and/or TDF, the V-PCRF gathers the reports and provides them all to H-PCRF in the single CCR message. + +4. The H-PCRF identifies the AF sessions that are bound to IP flows of the removed IP-CAN Session. +5. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the H-PCRF acknowledges the Gx session termination by sending a CCA to the PCEF. + +For the case when the UE is roaming in a Visited Access scenario, steps 5a~5c are executed instead of step 5: + +- 5a. The H-PCRF acknowledges the S9 session or subsession termination by sending a CCA to the V-PCRF. + - 5b. The V-PCRF removes the information related to the terminated IP-CAN Session. + - 5c. The V-PCRF acknowledges the Gx session termination by sending a CCA to the PCEF. +6. The PCEF sends a response to the Remove IP-CAN Session Request. The form of the Remove IP-CAN Session Response depends upon the type of the IP-CAN. Step 6 may be executed in parallel with step 3 or 3a (as applicable). + 7. If there is an active TDF session between the TDF and the H-PCRF, for non-roaming UE/roaming UE with home routed access, the TDF Session termination is initiated as defined in Section 4.6.2. + +NOTE 2: Step 7 can occur anytime after step 3. + +For each AF session identified in step 4 as bound to the IP-CAN Session being removed, steps 7-11 are executed: + +8. If congestion reporting is active for the user id and PDN id, for non-roaming UE or UE is roaming in home routed case, the H-PCRF initiates a UE context removal as defined in clause 4.8.5. + +NOTE 3: Step 8 can occur anytime after step 3. + +9. The H-PCRF indicates the session abort to the H-AF by sending an ASR to the H-AF. +10. The H-AF responds by sending an ASA to the H-PCRF. + +11. The H-AF sends an STR to the H-PCRF to indicate that the session has been terminated. +12. The H-PCRF responds by sending an STA to the H-AF. If the provided PCC rules are related to an AF session associated with a sponsor, usage thresholds were provided by the H-AF earlier, and the H-PCRF has usage data that has not yet been reported to the H-AF, the H-PCRF informs the H-AF about the resources that have been consumed by the user since the last report. If the BBERF in step 2 or PCEF in step 3 reports the access network information and if the AF requested the H-PCRF to report access network information previously and/or the RAN-NAS-Cause feature is supported, the H-PCRF informs the H-AF about the access network information and/or RAN/NAS/TWAN/Untrusted WLAN failure cause(s) if available. +13. If this is the last IP-CAN session for this subscriber the Final Spending Limit Report Request as defined in clause 4.7.3 is sent. If any existing IP-CAN sessions for this subscriber require policy counter status reporting, the Intermediate Spending Limit Report Request as defined in clause 4.7.2 can be sent to alter the list of subscribed policy counters. +14. If case 2a applies (as defined in clause 4.0), the Gateway Control and QoS Rules Provision procedure as defined in clause 4.4.3 (Gateway Control and QoS Rules Provision) may be initiated to remove the QoS rules associated with the IP-CAN session being terminated. This applies e.g. in case the Gateway Control Session remains to serve other IP-CAN sessions. + +Alternatively, if UE acquires a care of address (CoA) that is used for the S2c reference point and the H-PCRF determines that all QoS rules are to be removed and the Gateway Control Session to be terminated, the PCRF-initiated Gateway Control Session Termination procedure as defined in clause 4.4.4 (PCRF-Initiated Gateway Control Session Termination) is initiated. This applies e.g. in case the UE is detached and the CoA acquired by the UE is not used for any other IP-CAN session. + +15. The H-PCRF sends a cancellation notification request to the SPR if it has subscribed such notification. The H-PCRF stores the remaining usage allowance in the SPR if all IP-CAN sessions of the user to the same APN are terminated. Step 14 may be initiated any time after step 5 or 5a (as applicable). +16. The SPR sends a response to the H-PCRF. + +NOTE 4: For steps 14 and 15: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +17. If the H-PCRF has provided traffic steering control information to the TSSF for the IP-CAN session, the H-PCRF initiates the St session termination procedure to the TSSF to remove the traffic steering control information associated to the UE IPv4 address and/or to the UE IPv6 prefix for the terminated IP-CAN session according to the subclause 4.9.3. + +NOTE 5: Step 17 can be initiated any time after step 5. + +#### 4.2.1.2 AF located in the VPLMN + +This clause is applicable only for the Visited Access scenario for the case when an IP-CAN Session is being released by the UE and the AF is located in the VPLMN. + +![Sequence diagram for UE-Initiated IP-CAN Session Termination – AF located in the VPLMN. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, V-AF, SPR. The process starts with Step 1 (UE Initiated IP-CAN Session Termination - AF Located in the HPLMN). A 'VISITED ACCESS CASE' box highlights steps 2-9. Step 2: H-PCRF sends Diameter ASR to V-PCRF. Step 3: V-PCRF proxies ASR to V-AF. Step 4: V-AF sends Diameter ASA to V-PCRF. Step 5: V-PCRF proxies ASA to H-PCRF. Step 6: V-AF sends Diameter STR to V-PCRF. Step 7: V-PCRF proxies STR to H-PCRF. Step 8: V-AF sends Diameter STA to V-PCRF. Step 9: V-PCRF proxies STA to H-PCRF. A bracket on the right indicates steps 2-9 are 'For each affected AF session (if any)'. Step 10: UE Initiated IP-CAN Session Termination - AF Located in the HPLMN. Legend: Solid arrow = Mandatory, Dashed arrow = Conditional.](8307f6b04df072c9332f9987e034272c_img.jpg) + +Sequence diagram illustrating UE-Initiated IP-CAN Session Termination – AF located in the VPLMN. + +The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, V-AF, and SPR. + +Step 1: Perform Step 1 through Step 8: as specified in Figure 4.2.1.1.1 : UE Initiated IP-CAN Session Termination - AF Located in the HPLMN + +Step 2: Diameter ASR (Conditional) from H-PCRF to V-PCRF + +Step 3: Diameter ASR (Conditional) from V-PCRF to V-AF + +Step 4: Diameter ASA (Conditional) from V-AF to V-PCRF + +Step 5: Diameter ASA (Conditional) from V-PCRF to H-PCRF + +Step 6: Diameter STR (Conditional) from V-AF to V-PCRF + +Step 7: Diameter STR (Conditional) from V-PCRF to H-PCRF + +Step 8: Diameter STA (Conditional) from V-AF to V-PCRF + +Step 9: Diameter STA (Conditional) from V-PCRF to H-PCRF + +For each affected AF session (if any) + +Step 10: Perform Step 13 through Step 16: as specified in Figure 4.2.1.1.1 : UE Initiated IP-CAN Session Termination - AF Located in the HPLMN + +Legend: + +- Mandatory (Solid arrow) +- Conditional (Dashed arrow) + +Sequence diagram for UE-Initiated IP-CAN Session Termination – AF located in the VPLMN. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, V-AF, SPR. The process starts with Step 1 (UE Initiated IP-CAN Session Termination - AF Located in the HPLMN). A 'VISITED ACCESS CASE' box highlights steps 2-9. Step 2: H-PCRF sends Diameter ASR to V-PCRF. Step 3: V-PCRF proxies ASR to V-AF. Step 4: V-AF sends Diameter ASA to V-PCRF. Step 5: V-PCRF proxies ASA to H-PCRF. Step 6: V-AF sends Diameter STR to V-PCRF. Step 7: V-PCRF proxies STR to H-PCRF. Step 8: V-AF sends Diameter STA to V-PCRF. Step 9: V-PCRF proxies STA to H-PCRF. A bracket on the right indicates steps 2-9 are 'For each affected AF session (if any)'. Step 10: UE Initiated IP-CAN Session Termination - AF Located in the HPLMN. Legend: Solid arrow = Mandatory, Dashed arrow = Conditional. + +**Figure 4.2.1.2.1: UE-Initiated IP-CAN Session Termination – AF located in the VPLMN** + +If the AF resides in the VPLMN, the V-PCRF proxies AF session signalling over S9 between the V-AF and the H-PCRF. + +- 1 In order to perform UE initiated IP-CAN Session Termination Procedures, step 1 through step 8: as specified in Figure 4.2.1.1.1: UE Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed. + +For each AF session identified in step 4 (Figure 4.2.1.1.1) as bound to the IP-CAN Session being removed steps 2-10 are executed: + +2. The H-PCRF indicates the session abort to the V-AF in VPLMN by sending an ASR to the V-PCRF. +3. The V-PCRF proxies the ASR to the V-AF. +4. The V-AF responds by sending an ASA to the V-PCRF. +5. The V-PCRF proxies the ASA to the H-PCRF. +6. The V-AF sends an STR to the V-PCRF to indicate that the session has been terminated. +7. The V-PCRF proxies the STR to the H-PCRF. +8. The H-PCRF responds by sending an STA to the V-PCRF. + +9. The V-PCRF proxies the STA to the V-AF. + +10. Step 13 through step 16: as specified in Figure 4.2.1.1.1: UE Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed, as needed. + +NOTE: For steps 15 and 16: the details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +### 4.2.2 PCEF-Initiated + +#### 4.2.2.1 AF located in the HPLMN + +This clause is applicable if an IP-CAN Session is being released by the PCEF and the AF is located in the HPLMN. + +![Sequence diagram for PCEF-initiated IP-CAN Session Termination. Lifelines: BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, OCS. The diagram shows the interaction between these elements for session termination, with specific steps for visited and home access cases.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +The sequence diagram illustrates the PCEF-initiated IP-CAN Session Termination process. The lifelines involved are BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, and OCS. The process is divided into two main scenarios: 'VISITED ACCESS CASE' and 'non-roaming UE/roaming UE with home routed access'. + +**Sequence of Messages:** + +- Detection that IP-CAN Session Termination is required (PCEF internal step). +- Remove IP-CAN Session Request (PCEF to BBERF). +- BBERF-initiated Gateway Control Session Termination (case 2b) (BBERF to PCEF, conditional). +- Remove IP-CAN Session Response (BBERF to PCEF). +- Diameter CCR (PCEF to H-PCRF). +- Diameter CCA (H-PCRF to PCEF). +- For the 'VISITED ACCESS CASE': + - 5a. Diameter CCR (PCEF to V-PCRF). + - 5b. TDF session termination for roaming UE with visited access (V-PCRF to TDF, conditional). + - 5c. UE context removal (V-PCRF to TSSF, conditional). + - 5d. Diameter CCR (V-PCRF to H-PCRF). + - 6. Identify AF Sessions bound to the removed IP-CAN Session (H-PCRF to H-AF). + - 7a. Diameter CCA (H-PCRF to V-PCRF). + - 7b. Removes the information related to the terminated IP-CAN Session (H-AF internal step). + - 7c. Diameter CCA (V-PCRF to PCEF). +- For the 'non-roaming UE/roaming UE with home routed access' case: + - 8. TDF session termination for non-roaming UE/roaming UE with home routed access (PCEF to TDF, conditional). + - 9. UE context removal (PCEF to TSSF, conditional). + - 10. Diameter ASR (H-PCRF to H-AF, for each affected AF session if any). + - 11. Diameter ASA (H-AF to H-PCRF, for each affected AF session if any). + - 12. Diameter STR (H-PCRF to H-AF, for each affected AF session if any). + - 13. Diameter STA (H-AF to H-PCRF, for each affected AF session if any). + - 14. Final Spending Limit Report Request (H-PCRF to OCS, conditional). + - 15. Gateway Control and QoS Rules provision (case 2a) or PCRF-initiated Gateway Control Session Termination (case 2a) (PCEF to BBERF, conditional). + - 16. Cancel Subscribed Notification request (H-PCRF to SPR). + - 17. Cancel Subscribed Notification Response (SPR to H-PCRF). + - 18. St session termination (PCEF internal step, conditional). + +**Legend:** + +- Mandatory: Solid line with arrowhead. +- Conditional: Dashed line with arrowhead. + +Sequence diagram for PCEF-initiated IP-CAN Session Termination. Lifelines: BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, OCS. The diagram shows the interaction between these elements for session termination, with specific steps for visited and home access cases. + +**Figure 4.2.2.1.1 : PCEF-initiated IP-CAN Session Termination – AF located in the HPLMN** + +In the following procedures, the V-PCRF is included to depict the roaming scenarios. H-PCRF acts as the PCRF for non-roaming UEs. + +- The PCEF detects that the termination of an IP-CAN Session or bearer is required. +- If case 2b applies (as defined in clause 4.0), PCEF sends the Remove IP-CAN Session Request to the BBERF. If case 2a applies (as defined in clause 4.0), the request goes transparently through the BBERF. In all cases, the PCEF sends a Remove IP-CAN Session Request to remove the IP-CAN Session. The form of the Remove IP-CAN Session Request depends upon the type of the IP-CAN. It can consist of separate requests for each IP-CAN Bearer within an IP-CAN Session. + +- 3 If case 2b applies (as defined in clause 4.0), the BBERF-initiated Gateway Control Session Termination procedure as defined in clause 4.4.4 (BBERF-Initiated Gateway Control Session Termination) is initiated. +4. The PCEF receives a response to the Remove IP-CAN Session Request. +- 5 – 7. Same as Steps 3~5 in figure 4.2.1.1.1. +- 8 – 18. Same as Steps 7~17 in figure 4.2.1.1.1. + +NOTE 1: Steps 2 and 5 may be executed in parallel. + +#### 4.2.2.2 AF located in the VPLMN + +This clause is applicable only for the Visited Access scenario for the case when an IP-CAN Session is being released by the PCEF and the AF is located in the VPLMN + +![Sequence diagram for PCEF-Initiated IP-CAN Session Termination – AF located in the VPLMN. The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, V-AF, and SPR. A vertical bar on the left is labeled 'VISITED ACCESS CASE'. The sequence starts with a block '1. Perform Step 1 through Step 9: as specified in Figure 4.2.2.1.1 : PCEF Initiated IP-CAN Session Termination - AF Located in the HPLMN'. This is followed by a loop for each affected AF session (if any) containing steps 2 through 9: 2. Diameter ASR (V-PCRF to H-PCRF), 3. Diameter ASR (H-PCRF to V-PCRF), 4. Diameter ASA (V-PCRF to H-PCRF), 5. Diameter ASA (H-PCRF to V-PCRF), 6. Diameter STR (V-PCRF to H-PCRF), 7. Diameter STR (H-PCRF to V-PCRF), 8. Diameter STA (V-PCRF to H-PCRF), and 9. Diameter STA (H-PCRF to V-PCRF). This is followed by a block '10. Perform Step 14 through Step 17: as specified in Figure 4.2.2.1.1 : PCEF Initiated IP-CAN Session Termination - AF Located in the HPLMN'. A legend at the bottom left shows a solid arrow for 'Mandatory' and a dashed arrow for 'Conditional'.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +Sequence diagram for PCEF-Initiated IP-CAN Session Termination – AF located in the VPLMN. The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, V-AF, and SPR. A vertical bar on the left is labeled 'VISITED ACCESS CASE'. The sequence starts with a block '1. Perform Step 1 through Step 9: as specified in Figure 4.2.2.1.1 : PCEF Initiated IP-CAN Session Termination - AF Located in the HPLMN'. This is followed by a loop for each affected AF session (if any) containing steps 2 through 9: 2. Diameter ASR (V-PCRF to H-PCRF), 3. Diameter ASR (H-PCRF to V-PCRF), 4. Diameter ASA (V-PCRF to H-PCRF), 5. Diameter ASA (H-PCRF to V-PCRF), 6. Diameter STR (V-PCRF to H-PCRF), 7. Diameter STR (H-PCRF to V-PCRF), 8. Diameter STA (V-PCRF to H-PCRF), and 9. Diameter STA (H-PCRF to V-PCRF). This is followed by a block '10. Perform Step 14 through Step 17: as specified in Figure 4.2.2.1.1 : PCEF Initiated IP-CAN Session Termination - AF Located in the HPLMN'. A legend at the bottom left shows a solid arrow for 'Mandatory' and a dashed arrow for 'Conditional'. + +**Figure 4.2.2.2.1: PCEF-Initiated IP-CAN Session Termination – AF located in the VPLMN** + +If the AF resides in the VPLMN, the V-PCRF proxies AF session signalling over S9 between the V-AF and the H-PCRF. + +1. In order to perform PCEF initiated IP-CAN Session Termination Procedures, step 1 through step 9: as specified in Figure 4.2.2.1.1: PCEF Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed. + +For each AF session identified in step 6 (Figure 4.2.2.1.1) as bound to the IP-CAN Session being removed, steps 2-9 are executed: + +2. The H-PCRF indicates the session abort to the V-AF in VPLMN by sending an ASR to the V-PCRF. + +3. The V-PCRF proxies the ASR to the V-AF. +4. The V-AF responds by sending an ASA to the V-PCRF. +5. The V-PCRF proxies the ASA to the H-PCRF. +6. The V-AF sends an STR to the V-PCRF to indicate that the session has been terminated. +7. The V-PCRF proxies the STR to the H-PCRF. +8. The H-PCRF responds by sending an STA to the V-PCRF. +9. The V-PCRF proxies the STA to the V-AF. +10. Step 14 through step 17: as specified in Figure 4.2.2.1.1: PCEF Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed, as needed. + +NOTE: For steps 16 and 17: the details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +### 4.2.3 PCRF-Initiated + +#### 4.2.3.1 AF located in the HPLMN + +This clause is applicable if an IP-CAN Session is being released by the PCRF and the AF is located in the HPLMN. + +![Sequence diagram for PCRF-initiated IP-CAN Session Termination. Lifelines: BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, OCS. The diagram shows the interaction between these elements to terminate an IP-CAN session, with various Diameter messages like RAR, RAA, CCR, CCA, ASR, ASA, STR, STA, and final reporting steps. It includes 'VISITED ACCESS CASE' labels and a legend for mandatory and conditional messages.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +The sequence diagram illustrates the PCRF-initiated IP-CAN Session Termination process. The lifelines involved are BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, and OCS. The process is divided into several steps, with some steps occurring within 'VISITED ACCESS CASE' blocks. + +- Detection that IP-CAN Session termination is required (H-PCRF) +- Diameter RAR (H-PCRF to PCEF) +- 2a. Diameter RAR (H-PCRF to V-PCRF) +- 2b. Diameter RAR (V-PCRF to PCEF) +- Removal of all PCC Rules (PCEF) +- Diameter RAA (PCEF to H-PCRF) +- 4a. Diameter RAA (H-PCRF to V-PCRF) +- 4b. Diameter RAA (V-PCRF to H-PCRF) +- Remove IP-CAN Session Request (H-PCRF to BBERF) +- BBERF-initiated Gateway Control Session Termination(case 2b) (BBERF to PCEF) +- Remove IP-CAN Session Response (PCEF to H-PCRF) +- Diameter CCR (H-PCRF to PCEF) +- 8a. Diameter CCR (PCEF to V-PCRF) +- 8b. TDF session termination for roaming UE with visited access (Conditional, V-PCRF to TDF) +- 8c. UE context removal (Conditional, V-PCRF to TDF) +- 8d. Diameter CCR (V-PCRF to H-PCRF) +- Identify AF Sessions bound to the removed IP-CAN Session (H-PCRF) +- Diameter CCA (H-PCRF to PCEF) +- 10a. Diameter CCA (PCEF to V-PCRF) +- 10b. removes the information related to the terminated IP-CAN Session (Conditional, V-PCRF to TDF) +- 10c. Diameter CCA (V-PCRF to PCEF) +11. TDF session termination for roaming UE with visited access (Conditional, TDF to TSSF) +12. UE context removal (Conditional, TDF to TSSF) +- For each affected AF session (if any): + - Diameter ASR (H-PCRF to H-AF) + - Diameter ASA (H-AF to H-PCRF) + - Diameter STR (H-PCRF to H-AF) + - Diameter STA (H-AF to H-PCRF) +- Final Spending Limit Report Request (Conditional, H-PCRF to OCS) +- Gateway Control and Qos Rules provision (case 2a) Or PCRF-initiated Gateway Control Session Termination(case 2a) (H-PCRF to BBERF) +- Cancel Subscribed Notification request (H-PCRF to OCS) +- Cancel Subscribed Notification response (OCS to H-PCRF) +- St session termination (Conditional, H-PCRF to TSSF) + +**Legend:** + +- Solid arrow: Mandatory +- Dashed arrow: Conditional + +Sequence diagram for PCRF-initiated IP-CAN Session Termination. Lifelines: BBERF, PCEF, RCAF, TDF, TSSF, V-PCRF, H-PCRF, H-AF, SPR, OCS. The diagram shows the interaction between these elements to terminate an IP-CAN session, with various Diameter messages like RAR, RAA, CCR, CCA, ASR, ASA, STR, STA, and final reporting steps. It includes 'VISITED ACCESS CASE' labels and a legend for mandatory and conditional messages. + +Figure 4.2.3.1.1: PCRF-initiated IP-CAN Session Termination – AF located in HPLMN + +In the following procedures, the V-PCRF is included to depict the roaming scenarios. H-PCRF acts as the PCRF for non-roaming Ues. + +1. The H-PCRF detects that the termination of an IP-CAN Session is required. +2. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the H-PCRF sends a RAR including the Session-Release-Cause AVP to request that the PCEF terminates the IP CAN session. + +For the case when the UE is roaming in a Visited Access scenario, steps 2a~2b are executed instead of step 2: + +- 2a. If case 2b or case 1 applies and the subsession being terminated is the last subsession over S9, the H-PCRF sends a RAR including the Session-Release-Cause AVP to the V-PCRF to indicate the termination of the S9 session. Otherwise, the H-PCRF sends a RAR to the V-PCRF including the Subsession-Decision-Info AVP with the Session-Release-Cause AVP to indicate the request for terminating the S9 subsession corresponding to the IP-CAN session. +- 2b. The V-PCRF sends a RAR including the Session-Release-Cause AVP to the PCEF. +3. The PCEF removes all the PCC Rules which are applied to the IP-CAN session. +4. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the PCEF sends a RAA to acknowledge the RAR. + +For the case when the UE is roaming in a Visited Access scenario, steps 4a~4b are executed instead of step 4: + +- 4a. The PCEF sends a RAA to the V-PCRF. +- 4b. The V-PCRF sends a RAA to the H-PCRF and acknowledges the request for terminating the S9 session or the S9 subsession corresponding to the IP-CAN session. +5. The PCEF applies IP CAN specific procedures to terminate the IP CAN session. +6. – 21. Same as Steps 3-18 in figure 4.2.2.1.1. + +#### 4.2.3.2 AF located in the VPLMN + +This clause is applicable only for the Visited Access scenario for the case when an IP-CAN Session is being released by the PCRF and the AF is located in the VPLMN + +![Sequence diagram for PCRF-Initiated IP-CAN Session Termination – AF located in the VPLMN. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, V-AF, SPR. The diagram shows two main steps: Step 1 (PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN) and Step 10 (PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN). Between steps 1 and 10, a 'VISITED ACCESS CASE' loop occurs for each affected AF session. This loop involves Diameter ASR, ASA, STR, and STA messages between the H-PCRF, V-PCRF, and V-AF. A legend indicates solid arrows are Mandatory and dashed arrows are Conditional.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +The diagram illustrates the sequence of messages for PCRF-Initiated IP-CAN Session Termination when the AF is located in the VPLMN. The lifelines are BBERF, PCEF, V-PCRF, H-PCRF, V-AF, and SPR. The process starts with Step 1: Perform Step 1 through Step 12: as specified in Figure 4.2.3.1.1 : PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN. This is followed by a 'VISITED ACCESS CASE' loop for each affected AF session (if any). Inside this loop, the following messages are exchanged: 2. Diameter ASR (H-PCRF to V-PCRF), 3. Diameter ASR (V-PCRF to V-AF), 4. Diameter ASA (V-AF to V-PCRF), 5. Diameter ASA (V-PCRF to H-PCRF), 6. Diameter STR (V-AF to V-PCRF), 7. Diameter STR (V-PCRF to H-PCRF), 8. Diameter STA (H-PCRF to V-PCRF), and 9. Diameter STA (V-PCRF to V-AF). After the loop, Step 10: Perform Step 17 through Step 20: as specified in Figure 4.2.3.1.1 : PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN is executed. A legend indicates that solid arrows represent Mandatory messages and dashed arrows represent Conditional messages. + +Sequence diagram for PCRF-Initiated IP-CAN Session Termination – AF located in the VPLMN. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, V-AF, SPR. The diagram shows two main steps: Step 1 (PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN) and Step 10 (PCRF Initiated IP-CAN Session Termination - AF Located in the HPLMN). Between steps 1 and 10, a 'VISITED ACCESS CASE' loop occurs for each affected AF session. This loop involves Diameter ASR, ASA, STR, and STA messages between the H-PCRF, V-PCRF, and V-AF. A legend indicates solid arrows are Mandatory and dashed arrows are Conditional. + +**Figure 4.2.3.2.1: PCRF-Initiated IP-CAN Session Termination – AF located in the VPLMN** + +If the AF resides in the VPLMN, the V-PCRF proxies AF session signalling over S9 between the V-AF and the H-PCRF. + +1. In order to perform PCRF initiated IP-CAN Session Termination Procedures, step 1 through step 12: as specified in Figure 4.2.3.1.1: PCRF Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed. + +For each AF session identified in step 6 (Figure 4.2.3.1.1) as bound to the IP-CAN Session being removed, steps 2-9 are executed: + +2. The H-PCRF indicates the session abort to the V-AF in VPLMN by sending an ASR to the V-PCRF. +3. The V-PCRF proxies the ASR to the V-AF. +4. The V-AF responds by sending an ASA to the V-PCRF. +5. The V-PCRF proxies the ASA to the H-PCRF. +6. The V-AF sends an STR to the V-PCRF to indicate that the session has been terminated. +7. The V-PCRF proxies the STR to the H-PCRF. + +8. The H-PCRF responds by sending an STA to the V-PCRF. +9. The V-PCRF proxies the STA to the V-AF. +10. Step 17 through step 20: as specified in Figure 4.2.3.1.1: PCRF Initiated IP-CAN Session Termination – AF Located in the HPLMN are executed, as needed. + +NOTE: For steps 19 and 20: the details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +## 4.3 IP-CAN Session Modification + +### 4.3.1 Network-Initiated IP-CAN Session Modification + +- 4.3.1.1 Interactions between BBERF, PCEF, TDF, OCS, TSSF and PCRF(PCC/QoS/ADC Rule Provisioning in PUSH mode) + +This flow shows the provisioning of PCC/QoS/ADC Rules and/or authorized QoS triggered by an event in the PCRF. + +![Sequence diagram showing interactions between BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, and OCS for PCRF-Initiated IP-CAN Session Modification. The diagram includes lifelines for each entity and numbered messages indicating mandatory and conditional interactions. Two 'VISITED ACCESS CASE' regions are highlighted in light blue.](820515db47ded68f5e0b625f4ec7d2c1_img.jpg) + +The sequence diagram illustrates the following interactions: + +- 1. Trigger:** OCS to H-PCRF (Mandatory) +- 2. PCC Rules decision, Policy Decision:** H-PCRF to V-PCRF (Mandatory) +- 3. Store PCC and ADC Rules:** H-PCRF to V-PCRF (Mandatory) +- 4. Timer:** H-PCRF internal (Conditional) +- 5. Gateway Control & QoS Rule Provision (case 2a & 2b):** V-PCRF to BBERF (Conditional) +- 6. Diameter RAR:** V-PCRF to PCEF (Mandatory) +- 6a. Diameter RAR:** V-PCRF to TSSF (Mandatory) +- 6b. PCC Rules validation, Local Policy Decision:** TSSF to V-PCRF (Mandatory) +- 6c. TDF session establishment/ modification/ termination:** V-PCRF to TDF (Conditional) +- 6d. Diameter RAR:** V-PCRF to BBERF (Conditional) +- 6e. Install, modify or remove QoS rules:** BBERF internal (Conditional) +- 6f. Diameter RAR:** V-PCRF to PCEF (Mandatory) +- 7. Install, modify or remove PCC rules:** PCEF internal (Conditional) +- 8. Diameter RAA:** PCEF to H-PCRF (Mandatory) +- 8a. Diameter RAA:** PCEF to V-PCRF (Conditional) +- 8b. Diameter RAA:** PCEF to V-PCRF (Mandatory) +- 8c. Store Result:** V-PCRF internal (Conditional) +- 8d. Diameter RAA:** V-PCRF to H-PCRF (Mandatory) +- 9. TDF session establishment/ modification/ termination for non-roaming/HR:** H-PCRF to TDF (Conditional) +- 10. St establishment /modification/termination for non-roaming/HR:** H-PCRF to TSSF (Conditional) +- 11. Initial/ Intermediate/ Final Spending Limit Report Request:** H-PCRF to OCS (Conditional) +- 12. IP - CAN session modification:** H-PCRF to PCEF (Conditional) +- 13. IP - CAN session signalling:** PCEF to BBERF (Conditional) +- 14. IP - CAN session modification:** PCEF to BBERF (Conditional) + +**Legend:** + +- Mandatory:** Solid line with arrowhead +- Conditional:** Dashed line with arrowhead + +Sequence diagram showing interactions between BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, and OCS for PCRF-Initiated IP-CAN Session Modification. The diagram includes lifelines for each entity and numbered messages indicating mandatory and conditional interactions. Two 'VISITED ACCESS CASE' regions are highlighted in light blue. + +Figure 4.3.1.1.1: Interactions between BBERF, PCEF, TDF, OCS, TSSF and PCRF for PCRF-Initiated IP-CAN Session Modification + +1. The H-PCRF receives an internal or external trigger to re-evaluate PCC Rules and policy decision for an IP-CAN Session. Possible external trigger events are described in clause 4.3.1.2. In addition, this procedure is triggered by + - PCEF subscribed event + - SPR subscription data modification (e.g. change in MPS EPS Priority, MPS Priority Level and/or IMS Signalling Priority, or change in user profile configuration indicating whether supporting application detection and control). + - OCS status of a policy counter identifier(s) has changed and the PCRF requested notification for spending limits apply. + - Application detection information report from TDF. +2. The H-PCRF selects the PCC Rule(s) to be installed, modified or removed for the IP-CAN Session. In case of PCEF supporting Application Detection and Control feature, some of those PCC rules may be used for application detection and control. The H-PCRF may also update the policy decision by defining an authorized QoS and enable or disable the service flow(s) of PCC Rules. If the PCEF controls the binding of IP-CAN bearers, the H-PCRF may add or change QoS information per QCI applicable to that IP-CAN session. In case of TDF, the H-PCRF selects the applicable ADC rules for the solicited application reporting with a TDF. If NBIFOM applies to the IP-CAN session and Network-initiated mode is selected, the H-PCRF determines the access that is to be used for the transfer of traffic and include the allowed access type in the PCC rules. If NBIFOM applies to the IP-CAN session, the H-PCRF determines one access is to be removed from multi access IP-CAN session. +3. The H-PCRF stores the updated PCC Rules, and ADC rules if available. +4. Step 4 is only applicable if the Bearer Control Mode (BCM) selected is UE-only or, for UE/NW the H-PCRF determines that UE mode applies for the affected PCC Rules, and the PCRF receives an external trigger from the AF. + +The PCRF may start a timer to wait for a UE requested bearer resource initiation, modification or removal procedure initiated by the UE, as depicted in figure 4.3.2.1.1. + +If a UE requested bearer resource initiation, modification or termination procedure initiated by the terminal is received for the affected PCC rules while the timer is running, all subsequent steps in the present figure shall not be executed and, for case 1, the steps in figure 4.3.2.1.1 (on provisioning based on PULL procedure at PCEF – initiated IP-CAN session modification when the AF is located in the HPLMN), 4.3.2.2.1 (on provisioning based on PULL procedure at PCEF-initiated IP-CAN session modification when the AF is located in the VPLMN) and for cases 2a and 2b, the steps in figure 4.4.2.1.1 (Home Routed case) or 4.4.2.2.1 (Visited Access case) shall be executed instead. + +Otherwise, if the BCM selected is UE/NW, the PCRF shall proceed with the subsequent steps (provisioning based on PUSH procedure) in the present figure after timer expiry. + +NOTE 1: For IMS Emergency session and RLOS session step 4 is not applicable. + +5. For case 2a and 2b, if Gxx applies for the IP-CAN session and the user is not roaming, or the user is roaming in a Home Routed scenario or a Visited Access scenario for case 2a when the available QoS rule are not related to any IP-CAN session, the H-PCRF may initiate Gateway Control and QoS rules provisioning procedures described in clause 4.4.3. + +NOTE 2: This step is not executed if this procedure is triggered by PCEF subscribed events and/or credit re-authorisation triggers reported by the BBERF. + +6. The H-PCRF sends a Diameter RAR to request that the PCEF installs, modifies or removes PCC Rules and updates the policy decision, or to report PCEF subscribed events reported by the BBERF. The report includes the User Location Information and the User CSG Information (If received from the BBERF). If the provided PCC rules are related to an AF session associated with a sponsor that has requested sponsoring the service, the H-PCRF includes, in the Charging-Rule-Definition AVP, the Sponsor-Identity AVP and the Application-Service-Provider-Identity AVP that it received from the AF if the Reporting-Level AVP is set to the value SPONSORED\_CONNECTIVITY\_LEVEL and, if AF provided the application usage thresholds, the Usage-Monitoring-Information AVP. If the AF requests the access network information, the H-PCRF includes Required-Access-Info AVP in the Charging-Rule-Definition AVP and/or Charging-Rule-Remove AVP. In + +addition, the H-PCRF includes the Event-Trigger set to the value "ACCESS\_NETWORK\_INFO\_REPORT" if not provided yet. If the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP are provided within the Media-Component-Description AVP, the PCRF may apply the mechanisms for resource sharing as specified at 3GPP TS 29.212 [9]. The PCRF includes the Removal-Of-Access AVP set to the value REMOVAL\_OF\_ACCESS (0) and the IP-CAN-Type AVP set to the value of removed access to remove one access from the multi access IP-CAN session. If the H-PCRF subscribes the change of UE presence in Presence Reporting Area, the H-PCRF may provide the Presence Reporting Area Information to the PCEF. If the RAN-Support-Info feature is enabled and local policy allows, for PCC rules with QCI of 1, the PCRF can provide the Charging-Rule-Definition AVP including the maximum packet loss rate(s) for uplink and/or downlink direction(s) in the Max-PLR-UL/DL AVP(s) respectively. + +When the UE is roaming in a Visited Access scenario, steps 6a ~ 6e are executed instead of step 6: + +- 6a. The H-PCRF sends a Diameter RAR to the V-PCRF to request that the PCEF installs, modifies or removes PCC Rules and updates the policy decision. In the case of VPLMN supporting Application Detection and Control feature for solicited application reporting, some of those PCC Rules may be used for application detection and control. If the provided PCC rules are related to an AF session associated with a sponsor that has requested sponsoring the service, the H-PCRF includes, in the Charging-Rule-Definition AVP, the Sponsor-Identity AVP and the Application-Service-Provider-Identity AVP that it received from the AF if the Reporting-Level AVP is set to the value SPONSORED\_CONNECTIVITY\_LEVEL and, if AF provided the application usage thresholds, the Usage-Monitoring-Information AVP. If the AF requests the access network information, the H-PCRF includes Required-Access-Info AVP in the Charging-Rule-Definition AVP and/or Charging-Rule-Remove AVP. In addition, the H-PCRF includes the Event-Trigger set to the value "ACCESS\_NETWORK\_INFO\_REPORT" if not provided yet. +- 6b. The V-PCRF enforces visited operator policies regarding PCC rules requested by the H-PCRF based on roaming agreements or locally configured policy. In case of TDF, V-PCRF extracts the ADC rules from the PCC Rules received from the H-PCRF and stores them. + +NOTE 3: If the V-PCRF rejects provisioned PCC rules received from the H-PCRF, the remaining steps in this call flow are not followed. Instead, the V-PCRF shall notify the H-PCRF by sending a Diameter RAA, including the Experimental-Result-Code AVP set to the value PCC\_RULE\_EVENT, identify the failed PCC rules as specified in 3GPP TS 29.212 [9], and additionally may provide the acceptable QoS Information for the service. + +- 6c. In case of TDF, solicited application reporting, for roaming UE with visited access, the V-PCRF initiates the TDF session establishment, modification, or termination. If the provided ADC rules are related to an AF session associated with a sponsor that has requested sponsoring the service, the H-PCRF includes, in the ADC-Rule-Definition AVP, the Sponsor-Identity AVP and the Application-Service-Provider-Identity AVP that are received from the AF if the Reporting-Level AVP is set to the value SPONSORED\_CONNECTIVITY\_LEVEL. Additionally, if the AF provided the application usage thresholds, the H-PCRF includes the Usage-Monitoring-Information AVP. If the last ADC rule is deactivated, the V-PCRF requests the TDF to terminate the TDF session toward the V-PCRF as defined in clause 4.6.2. If there is no active TDF session between the TDF and the V-PCRF, the V-PCRF requests the TDF to establish the TDF session towards V-PCRF and provides ADC Rules to the TDF as defined in clause 4.6.1. If there is already an active TDF session between the TDF and the V-PCRF, the V-PCRF provides the ADC rules to the TDF as defined in clause 4.6.3.2. + - 6d. For case 2a and 2b, V-PCRF will derive the QoS rules from the PCC rules. The V-PCRF will initiate a Gateway Control and QoS Rule procedure as described in clause 4.4.3 to install, modify or remove QoS rules and optionally subscribe to new events in the BBERF. + - 6e. The BBERF installs, modifies or removes the identified QoS Rules. The BBERF also enforces the authorized QoS of the corresponding QoS Rules. + - 6f. The V-PCRF sends a Diameter RAR to request that the PCEF installs, modifies or removes PCC Rules. +7. The PCEF installs, modifies or removes the identified PCC Rules. The PCEF also enforces the authorized QoS and enables or disables service flow according to the flow status of the corresponding PCC Rules. If QoS information is received per QCI, PCEF shall set/update the upper limit for the MBR that the PCEF assigns to the non-GBR bearer for that QCI. In the case of PCEF supporting Application Detection and Control feature, the PCEF may also enforce application detection and control. The PCEF may perform resource sharing among PCC rules if requested from the PCRF. If allowed access type information is included in the PCC rules, the PCEF generates the NBIFOM routing rules based on the PCC rules. If the RAN-Support-Info feature is supported, the + +PCEF sets the UL/DL maximum packet loss rate value(s) as described in subclause B.3.18 of 3GPP TS 29.212 [9]. + +The following applies for emergency sessions only: + +When the PCEF receives an IP-CAN Session Modification Request from the PCRF requesting the removal of the PCC rules of an emergency session, the PCEF starts an inactivity timer to enable the PSAP to request a callback session with the UE. + +When the timer expires, the PCEF initiates an IP-CAN Session Termination Request (per clause 4.2.2.1) to terminate the emergency session. + +If, before the timer expires, the PCEF receives an IP-CAN Session Modification Request from the PCRF with PCC rules for an emergency session the PCEF cancels the timer. + +8. The PCEF sends a Diameter RAA to acknowledge the RAR. The PCEF informs the H-PCRF about the outcome of the PCC rule operation + +When the UE is roaming in a Visited Access scenario, steps 8a ~ 8d are executed instead of step 8: + +- 8a. The BBERF informs the V-PCRF about the outcome of the operation by sending a Diameter RAA command. +- 8b. The PCEF informs the V-PCRF about the outcome of the PCC rule operation by sending a Diameter RAA command. +- 8c. The V-PCRF stores the received information. +- 8d. The V-PCRF informs the H-PCRF about the outcome of the operation by sending a Diameter RAA command. + +9. In case of TDF, solicited application reporting, for non-roaming UE/roaming UE with home routed access, H-PCRF initiates the TDF session establishment, modification, or termination. If the provided ADC rules are related to an AF session associated with a sponsor that has requested sponsoring the service, the H-PCRF includes, in the ADC-Rule-Definition AVP, the Sponsor-Identity AVP and the Application-Service-Provider-Identity AVP that are received from the AF if the Reporting-Level AVP is set to the value SPONSORED\_CONNECTIVITY\_LEVEL. Additionally, if the AF provided the application usage thresholds, the H-PCRF includes the Usage-Monitoring-Information AVP. If the last ADC rule is deactivated, the H-PCRF requests the TDF to terminate the TDF session toward the H-PCRF as defined in clause 4.6.2. If there is no active TDF session between the TDF and the H-PCRF, the H-PCRF requests the TDF to establish the TDF session towards H-PCRF and provides ADC Rules to the TDF as defined in clause 4.6.1. If there is already an active TDF session between the TDF and the H-PCRF, H-PCRF provides the ADC rules to the TDF as defined in clause 4.6.3.2. + +NOTE 4: Step 9 can occur anytime after step 6. + +10. If traffic steering control over St applies, if the PCRF determines that the traffic steering control information needs to be provisioned for the IP-CAN session; the PCRF initiates the St session establishment procedure according to the subclause 4.9.1. If the PCRF determines that the traffic steering control information provisioned to the TSSF needs to be updated, the PCRF initiates the St session modification procedure according to the subclause 4.9.2. If the PCRF determines that the traffic steering control information is not needed for the IP-CAN session any more, the PCRF initiates the St session termination procedure according to the subclause 4.9.3. +11. In case of spending limits, for non-roaming/roaming UE with both home routed and visited access, H-PCRF initiates Initial/ Intermediate/ Final Spending Limit Report Request. The H-PCRF sends an Initial Spending Limit Report Request if this is the first time a status notification of policy counter is requested for the user as defined in clause 4.7.1. If the H-PCRF decides to modify the list of subscribed policy counters the H-PCRF sends an Intermediate Spending Limit Report Request as defined in clause 4.7.2. If the H-PCRF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancels the request for reporting the change of the status of the policy counters available at the OCS as defined in clause 4.7.3. + +NOTE 5: Step 11 can occur anytime after step 2. + +12. If usage monitoring is enabled and the H-PCRF either removed the last PCC rule applicable for certain monitoring key, or disabled usage monitoring or requested usage report, the PCEF shall initiate an IP-CAN session modification procedure. +13. When Gxx does not apply for the IP-CAN session, IP-CAN bearer signalling is executed separately for each IP-CAN bearer under the following conditions: + - If all PCC rules bound to a bearer have been removed or deactivated (bearer deactivation is applicable) + - If one or more bearers have to be modified + - If the PCEF needs to establish a new bearer (bearer establishment is applicable). + - If the PCEF needs to request access network information. + - if the PCEF needs to send the NBIFOM routing rules to the UE in the corresponding access. +14. If the AF, in step 1, has requested notifications from the PCRF, e.g. in the case of access network information the PCEF initiates an IP-CAN session modification procedure to provide the requested information as described in clause 4.3.2. + +NOTE 6: If the conditions of both step 14 and step 12 apply the PCEF can make use of only one IP-CAN session modification procedure in step 14. + +#### 4.3.1.2 Interactions between PCRF, AF and SPR + +##### 4.3.1.2.1 AF Session Establishment + +###### 4.3.1.2.1.1 AF located in HPLMN + +![Sequence diagram showing AF session establishment triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN).](d980a3f9608055996a07f31788baf827_img.jpg) + +The sequence diagram illustrates the interaction between BBERF, PCEF, V-PCRF, H-PCRF, AF, and SPR. The sequence of messages is as follows: + +1. Trigger (AF to H-PCRF) +2. Diameter AAR (H-PCRF to V-PCRF) +3. Store Service Information (V-PCRF to H-PCRF) +4. Profile Request (H-PCRF to SPR) +5. Profile Response (SPR to H-PCRF) - Conditional (dashed line) +6. Identify affected IP CAN session(s) (H-PCRF to V-PCRF) +7. Diameter AAA (V-PCRF to H-PCRF) +8. Interactions in Figure 4.3.1.1.1 (H-PCRF to PCEF) + +**Legend:** + +- Mandatory +- - - - -> Conditional + +*Note: Step 5 is conditional if the PCRF needs subscription-related information and does not have it.* + +Sequence diagram showing AF session establishment triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN). + +**Figure 4.3.1.2.1.1.1: AF session establishment triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN)** + +1. The AF receives an internal or external trigger to set-up a new AF session and provides Service Information. The AF identifies the Service Information needed (e.g. IP address of the IP flow (s), port numbers to be used, information on media types, etc). + +2. The AF provides the Service Information to the H-PCRF by sending a Diameter AAR for a new Rx Diameter session. If this AF session is associated with a sponsor, Sponsor-Identity AVP, optionally the Sponsoring-Action AVP set to applicable value and the Application-Service-Provider-Identity AVP are included in Sponsored-Connectivity-Data AVP. If usage thresholds are to be associated with this sponsored AF session, then Granted-Service-Unit AVP is included in Sponsored-Connectivity-Data AVP. The AF can request access network information within the AAR by adding Required-Access-Info AVP(s) and Specific-Action AVP set to the value "ACCESS\_NETWORK\_INFO\_REPORT". If the Service can be subject to resource sharing, the AF includes the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP. If PrioritySharing feature is supported and the service is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions, the AF includes the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP. If the CHEM feature is supported, the AF may also include the maximum packet loss rate(s) for uplink and/or downlink direction(s) in the Max-PLR-UL/DL AVP(s) respectively within the Media-Component-Description AVP. If the service has negotiated the background data transfer policy, the AF includes the reference id of the transfer policy within the Reference-Id AVP. To invoke MPS for DTS, the AF includes the MPS-Action AVP within the AAR, as specified in clause 5.3. +3. The H-PCRF stores the received Service Information. +4. If the H-PCRF requires subscription related information and does not have it, the PCRF sends a request to the SPR in order to receive the information. If the Reference-Id AVP is received, the PCRF retrieves the corresponding transfer policy from the SPR and derives the PCC rules for the background data transfer according to the transfer policy. + +If the AF session is for MPS for DTS invocation, the PCRF performs MPS subscription checks if and only if requested by the AF, as described in subclause 4.4.11 of 3GPP TS 29.214 [10]. + +5. The SPR replies with the subscription related information containing the information about the allowed service(s), QoS information and PCC Rules information. + +NOTE: For steps 4 and 5: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +6. If the AF session is associated with a sponsor and sponsored service is enabled, + - if the UE is in the non-roaming case or UE is roaming with the home routed case and operator policies allow accessing the sponsored data connectivity with this roaming case, the H-PCRF authorizes the request based on sponsored data connectivity profile obtained from the SPR; + - if the UE is roaming with the home routed case and operator policies do not allow accessing the sponsored data connectivity with this roaming case or the UE is roaming with the visited access case, the H-PCRF rejects the request. + +The H-PCRF identifies the affected established IP-CAN Session(s) using the information previously received from the PCEF/V-PCRF and the Service Information received from the AF. + +7. The H-PCRF sends a Diameter AAA to the AF. The PCRF indicates whether the support for UE IP address/mask in the TFT filter is available in the IP-CAN session. +8. The H-PCRF interacts with the PCEF/BBERF/V-PCRF according to figure 4.3.1.1.1 (Interactions between BBERF/PCEF and PCRF for PCRF-Initiated IP-CAN Session Modification). + +###### 4.3.1.2.1.2 + +###### AF located in VPLMN + +![Sequence diagram for AF session establishment triggers PCRF-initiated IP-CAN Session Modification (AF in VPLMN). The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, AF, and SPR. The AF sends a trigger to the V-PCRF, which stores service information and forwards it to the H-PCRF. The H-PCRF may request profile information from the SPR. The V-PCRF then identifies affected IP CAN sessions and sends Diameter AAA messages to the PCEF and BBERF. A callout indicates that if the PCRF needs subscription-related information and does not have it, it sends a profile request to the SPR. A legend indicates that solid arrows are mandatory and dashed arrows are conditional.](d793cf7c174b89eb024d132f00679787_img.jpg) + +``` + +sequenceDiagram + participant AF + participant V-PCRF + participant H-PCRF + participant SPR + participant PCEF + participant BBERF + + Note left of BBERF: ROAMING CASE + + AF->>V-PCRF: 1. Trigger + V-PCRF->>AF: 2. Diameter AAR + Note right of V-PCRF: 3. Store Service Information + V-PCRF->>H-PCRF: 4. Diameter AAR + Note right of H-PCRF: 5. Store Service information Policy Decision + H-PCRF-->>SPR: 6. Profile Request + Note right of SPR: If the PCRF needs subscription-related information and does not have it + SPR-->>H-PCRF: 7. Profile Response + Note right of H-PCRF: 8. Identify affected IP CAN session(s) + H-PCRF->>V-PCRF: 9. Diameter AAA + V-PCRF->>AF: 10. Diameter AAA + Note right of BBERF: 11. Interactions in Figure 4.3.1.1.1 + +``` + +Sequence diagram for AF session establishment triggers PCRF-initiated IP-CAN Session Modification (AF in VPLMN). The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, AF, and SPR. The AF sends a trigger to the V-PCRF, which stores service information and forwards it to the H-PCRF. The H-PCRF may request profile information from the SPR. The V-PCRF then identifies affected IP CAN sessions and sends Diameter AAA messages to the PCEF and BBERF. A callout indicates that if the PCRF needs subscription-related information and does not have it, it sends a profile request to the SPR. A legend indicates that solid arrows are mandatory and dashed arrows are conditional. + +**Figure 4.3.1.2.1.2.1: AF session establishment triggers PCRF-initiated IP-CAN Session Modification (AF in VPLMN)** + +- The AF receives an internal or external trigger to set-up a new AF session and provides Service Information. The AF identifies the Service Information needed (e.g. IP address of the IP flow (s), port numbers to be used, information on media types, etc). +- The AF provides the Service Information to the V-PCRF by sending a Diameter AAR for a new Rx Diameter session. If the AF session is associated with a sponsor, Sponsor-Identity AVP and Application-Service-Provider-Identity are included in Sponsored-Connectivity-Data AVP. If usage thresholds are to be associated with this sponsored AF session, then Granted-Service-Unit AVP is included in Sponsored-Connectivity-Data AVP. The AF can request access network information within the AAR by adding Required-Access-Info AVP(s) and Specific-Action AVP set to the value "ACCESS\_NETWORK\_INFO\_REPORT". If the Service can be subject to resource sharing, the AF includes the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP. If PrioritySharing feature is supported and the service is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions, the AF includes the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP. To invoke MPS for DTS, the AF includes the MPS-Action AVP within the AAR, as specified in clause 5.3. +- The V-PCRF stores the Service Information. +- The V-PCRF forwards the Diameter AAR to the H-PCRF. +- The H-PCRF stores the received Service Information. +- If the H-PCRF requires subscription-related information and does not have it, the H-PCRF sends a request to the SPR in order to receive the information. + +NOTE 1: The V-PCRF may employ operator policies and reject the AAR from the AF if the provided Service Information is not acceptable. If this happens, the V-PCRF replies immediately to the AF, includes an unsuccessful Result-Code or Experimental-Result-Code in the AAA, and the remaining steps of this call flow are not carried out. + +If the AF session is for MPS for DTS invocation, the PCRF performs MPS subscription checks if and only if requested by the AF, as described in subclause 4.4.11 of 3GPP TS 29.214 [10]. + +7. The SPR replies with the subscription related information containing the information about the allowed service(s), QoS information and PCC Rules information. + +NOTE 2: For steps 6 and 7: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +8. If the AF session is associated with a sponsor, the H-PCRF rejects the request. Otherwise, the H-PCRF stores the Service Information and identifies the affected established IP-CAN Session(s) using the information previously received from the PCEF via the V-PCRF and the Service Information received from the AF. +9. The H-PCRF responds to the V-PCRF with a Diameter AAA. The H-PCRF indicates whether the support for UE IP address/mask in the TFT filter is available in the IP-CAN session. +10. The V-PCRF forwards the Diameter AAA to the AF. +11. The H-PCRF interacts with the PCEF/BBERF via the V-PCRF according to figure 4.3.1.1.1 (Interactions between BBERF/PCEF and PCRF for PCRF-Initiated IP-CAN Session Modification). + +##### 4.3.1.2.2 AF session modification + +###### 4.3.1.2.2.1 AF located in the HPLMN + +![Sequence diagram for AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN).](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +The diagram illustrates a sequence of interactions between five network elements: BBERF, PCEF, V-PCRF, H-PCRF, and AF. The sequence is as follows: + +- The AF sends a "Trigger" message to the H-PCRF. +- The AF sends "Define service information" to the H-PCRF. +- The H-PCRF sends a "Diameter AAR" message to the V-PCRF. +- The V-PCRF performs "Store Service Information" internally. +- The V-PCRF performs "Identify affected IP CAN session(s)" internally. +- The H-PCRF sends a "Diameter AAA" message to the AF. +- A large box labeled "7. Interactions in Figure 4.3.1.1.1" spans across the bottom of the diagram, indicating further interactions between the BBERF, PCEF, and V-PCRF. + +Sequence diagram for AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN). + +**Figure 4.3.1.2.2.1.1: AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in HPLMN)** + +1. The AF receives an internal or external trigger to modify an existing AF session and provide related Service Information. +2. The AF identifies the Service Information needed (e.g. IP address of the IP flow(s), port numbers to be used, information on media types, etc.). + +3. The AF provides the Service Information to the H-PCRF by sending a Diameter AAR for the existing Rx Diameter session corresponding to the modified AF session. If this AF session is associated with a sponsor, Sponsor-Identity AVP, optionally if the AF wants to enable sponsored dataconnectivity the Sponsoring-Action AVP set to the value "ENABLE\_SPONSORING" and Application-Service-Provider-Identity are included in Sponsored-Connectivity-Data AVP. If application usage thresholds are to be associated with this sponsored AF session, then Granted-Service-Unit AVP is included in Sponsored-Connectivity-Data AVP. If this AF session is associated with a sponsor and the AF wants to disable sponsored data connectivity the AF includes the Sponsoring-Action AVP set to the value "DISABLE\_SPONSORING" within the Sponsored-Connectivity-Data AVP. The AF can request access network information within the AAR by adding Required-Access-Info AVP(s) and Specific-Action AVP set to the value "ACCESS\_NETWORK\_INFO\_REPORT". If resource sharing conditions have been changed, the AF includes the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP. If the service has negotiated the background data transfer policy, the AF includes the reference id of the transfer policy within the Reference-Id AVP. If PrioritySharing feature is supported and the service is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions, the AF includes the Priority-Sharing-Indicator AVP within the Media-Component-Description AVP to indicate if priority sharing is enabled or disabled. The AF may also include the Pre-emption-Capability AVP and the Pre-emption-Vulnerability AVP within the Media-Component-Description AVP for the PCRF to determine the ARP values and include the Pre-emption-Control-Info AVP at the command level for the PCRF to perform the pre-emption control. If the CHEM feature is supported, the AF may also include the maximum packet loss rate(s) for uplink and/or downlink direction(s) in the Max-PLR-UL/DL AVP(s) respectively within the Media-Component-Description AVP. To invoke/revoke MPS for DTS, the AF includes the MPS-Action AVP within the AAR as specified in clause 5.3. +4. The H-PCRF stores the received Service Information. If the Reference-Id AVP is received, the PCRF retrieves the corresponding transfer policy from the SPR and derives the PCC rules for the background data transfer according to the transfer policy. + +If the AF session is for MPS for DTS invocation, the PCRF performs MPS subscription checks if and only if requested by the AF, as described in subclause 4.4.11 of 3GPP TS 29.214 [10]. + +5. If the AF session is associated with a sponsor and sponsored service is enabled, + - if the UE is in the non-roaming case or UE is roaming with the home routed case and operator policies allow accessing the sponsored data connectivity with this roaming case, the H-PCRF authorizes the request based on sponsored data connectivity profile obtained from the SPR; + - if the UE is roaming with the home routed case and operator policies do not allow accessing the sponsored data connectivity with this roaming case or the UE is roaming with the visited access case, the H-PCRF rejects the request. + +The H-PCRF identifies the affected established IP-CAN Session(s) using the information previously received from the PCEF/V-PCRF and the Service Information received from the AF. + +6. The H-PCRF sends a Diameter AAA to the AF. +7. The H-PCRF interacts with the BBERF/PCEF/V-PCRF according to figure 4.3.1.1.1. + +###### 4.3.1.2.2.2 + +###### AF located in the VPLMN + +![Sequence diagram for AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in VPLMN).](b8661c6c54f72ecc7ff6cb05e47b2891_img.jpg) + +The diagram illustrates a sequence of interactions between five network elements: BBERF, PCEF, V-PCRF, H-PCRF, and AF, under the heading "ROAMING CASE". + +- The AF sends a "1. Trigger" message to itself. +- The AF sends a "2. Define service information" message to itself. +- The AF sends a "3. Diameter AAR" message to the V-PCRF. +- The V-PCRF performs an internal action "4. Store Service Information". +- The V-PCRF sends a "5. Diameter AAR" message to the H-PCRF. +- The H-PCRF performs an internal action "6. Store Service Information". +- The H-PCRF performs an internal action "7. Identify affected IP CAN session(s)". +- The H-PCRF sends a "8. Diameter AAA" message to the V-PCRF. +- The V-PCRF sends a "9. Diameter AAA" message to the H-PCRF. +- A final box labeled "10. Interactions in Figure 4.3.1.1.1" spans across the bottom of the diagram, indicating further interactions. + +Sequence diagram for AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in VPLMN). + +**Figure 4.3.1.2.2.2.1 AF session modification triggers PCRF-Initiated IP-CAN Session Modification (AF in VPLMN)** + +- The AF receives an internal or external trigger to modify an existing AF session and provide related Service Information. +- The AF identifies the Service Information needed (e.g. IP address of the IP flow(s), port numbers to be used, information on media types, etc.). If resource sharing conditions have been changed, the AF includes the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP. If PrioritySharing feature is supported and the service is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions, the AF may include the Priority-Sharing-Indicator AVP within the Media-Component-Description AVP to indicate if priority sharing is enabled or disabled. +- The AF provides the Service Information to the V-PCRF by sending a Diameter AAR for the existing Rx Diameter session corresponding to the modified AF session. If this AF session is associated with a sponsor, Sponsor-Identity AVP and Application-Service-Provider-Identity AVP are included in Sponsored-Connectivity-Data AVP. If usage thresholds are to be associated with this sponsored AF session, then Granted-Service-Unit AVP is included in Sponsored-Connectivity-Data AVP. The AF can request access network information within the AAR by adding Required-Access-Info AVP(s) and Specific-Action AVP set to the value "ACCESS\_NETWORK\_INFO\_REPORT". To invoke/revoke MPS for DTS, the AF includes the MPS-Action AVP within the AAR, as specified in clause 5.3. + +4. The V-PCRF stores the received Service Information. + +NOTE: The V-PCRF may employ operator policies and reject the AAR from the AF if the provided Service Information is not acceptable. If this happens, the V-PCRF replies immediately to the AF, includes an unsuccessful Result-Code or Experimental-Result-Code in the AAA, and the remaining steps of this call flow are not carried out. + +5. The V-PCRF forwards the Diameter AAR to the H-PCRF. + +6. The H-PCRF stores the received Service Information. + +If the AF session is for MPS for DTS invocation, the PCRF performs MPS subscription checks if and only if requested by the AF, as described in subclause 4.4.11 of 3GPP TS 29.214 [10]. + +7. The H-PCRF identifies the affected established IP-CAN Session(s) using the information previously received from the PCEF/V-PCRF and the Service Information received from the AF. + +8. The H-PCRF responds with a Diameter AAA. + +9. The V-PCRF forwards the Diameter AAA to the AF. + +10. The H-PCRF interacts with the BBERF/PCEF via the V-PCRF according to figure 4.3.1.1.1. + +##### 4.3.1.2.3 AF session termination + +###### 4.3.1.2.3.1 AF located in the HPLMN + +![Sequence diagram showing the removal of PCC/QoS rules at AF session release (AF in HPLMN).](536951b2bbd94325ae266d8d1363df8f_img.jpg) + +``` + +sequenceDiagram + participant AF + participant H-PCRF + participant V-PCRF + participant PCEF + participant BBERF + + Note right of AF: 1. Trigger + AF->>H-PCRF: 2. Diameter STR + Note right of H-PCRF: 3. Identify affected IP CAN session where PCC/QoS rules need to be removed. + H-PCRF->>AF: 4a. Diameter STA + Note left of BBERF: 5. Interactions in Figure 4.3.1.1.1 + H-PCRF->>AF: 4b. Diameter STA + +``` + +The diagram illustrates the sequence of interactions for AF session termination when the AF is located in the HPLMN. It involves five entities: BBERF, PCEF, V-PCRF, H-PCRF, and AF. The sequence starts with the AF sending a 'Trigger' (1) to the H-PCRF. The H-PCRF responds with a 'Diameter STR' (2). The H-PCRF then identifies the affected IP CAN session where PCC/QoS rules need to be removed (3). The H-PCRF sends a 'Diameter STA' (4a) to the AF. A callout box labeled '5. Interactions in Figure 4.3.1.1.1' spans across the bottom of the diagram, indicating further interactions between the H-PCRF and the BBERF/PCEF via the V-PCRF. Finally, the H-PCRF sends another 'Diameter STA' (4b) to the AF. + +Sequence diagram showing the removal of PCC/QoS rules at AF session release (AF in HPLMN). + +**Figure 4.3.1.2.3.1.1: Removal of PCC/QoS Rules at AF session release (AF in HPLMN)** + +1. The AF receives an internal or external trigger for a session release. + +2. The AF sends a session termination request, Diameter STR, to the H-PCRF to request the removal of the session. The AF can request access network information within the STR by adding a Required-Access-Info AVP. +3. The H-PCRF identifies the affected IP-CAN Session where PCC Rules and, if available, QoS Rules for the IP flow(s) of this AF session are installed. These PCC/QoS Rules need to be removed. + +If the AF session being terminated corresponds to a session that included the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP, if the related media flow(s) was in priority sharing with other media flows, the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing priority. These PCC/QoS Rules may need to be modified. + +If the AF did not request access network information, and if no usage thresholds due to an AF session associated with a sponsor were provided that relate to the installed PCC rules and RAN-NAS-Cause feature is not supported, step 4a applies. If AF requested access network information, or usage thresholds due to an AF associated with a sponsor were provided that relate to the installed PCC rules, step 4b applies. If RAN-NAS-Cause is supported but Enh-RAN-NAS-Cause is not supported over Gx and the previous conditions do not apply, step 4a applies. Otherwise step 4b applies. + +- 4a. The H-PCRF sends Diameter STA, session termination answer, to the AF. +- 4b. The H-PCRF sends Diameter STA, session termination answer, to the AF and includes access network information and/or information about the resources that have been consumed by the user since the last report or RAN/NAS/TWAN/Untrusted WLAN release cause(s) if available obtained in step 5. +5. The H-PCRF interacts with the BBERF/PCEF/V-PCRF according to figure 4.3.1.1.1. + +###### 4.3.1.2.3.2 AF located in the VPLMN + +![Sequence diagram for the removal of PCC/QoS rules at AF session release (AF in VPLMN). The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, and AF. The process starts with a trigger from the AF, followed by Diameter STR messages to the V-PCRF and then H-PCRF. The H-PCRF identifies the affected session. Diameter STA messages are then sent from the H-PCRF to the V-PCRF and from the V-PCRF to the AF. A callout box indicates that steps 5a, 5b, 6a, and 6b are part of the interactions shown in Figure 4.3.1.1.1. The diagram is labeled 'ROAMING CASE' on the left.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +``` + +sequenceDiagram + participant AF + participant H-PCRF + participant V-PCRF + participant PCEF + participant BBERF + + Note left of BBERF: ROAMING CASE + + AF->>AF: 1. Trigger + AF->>V-PCRF: 2. Diameter STR + V-PCRF->>H-PCRF: 3. Diameter STR + H-PCRF->>H-PCRF: 4. Identify affected IP CAN session where PCC/ QoS rules need to be removed + H-PCRF->>V-PCRF: 5a. Diameter STA + V-PCRF->>AF: 6a. Diameter STA + Note right of BBERF: 7. Interactions in Figure 4.3.1.1.1 + H-PCRF->>V-PCRF: 5b Diameter STA + V-PCRF->>AF: 6b Diameter STA + +``` + +Sequence diagram for the removal of PCC/QoS rules at AF session release (AF in VPLMN). The diagram shows interactions between BBERF, PCEF, V-PCRF, H-PCRF, and AF. The process starts with a trigger from the AF, followed by Diameter STR messages to the V-PCRF and then H-PCRF. The H-PCRF identifies the affected session. Diameter STA messages are then sent from the H-PCRF to the V-PCRF and from the V-PCRF to the AF. A callout box indicates that steps 5a, 5b, 6a, and 6b are part of the interactions shown in Figure 4.3.1.1.1. The diagram is labeled 'ROAMING CASE' on the left. + +**Figure 4.3.1.2.3.2.1: Removal of PCC/QoS Rules at AF session release (AF in VPLMN)** + +1. The AF receives an internal or external trigger for a session release. +2. The AF sends a session termination request, Diameter STR, to the V-PCRF to request the removal of the session. The AF can request access network information within the STR by adding a Required-Access-Info AVP. +3. The V-PCRF forwards the Diameter STR to the H-PCRF. +4. The H-PCRF identifies the affected IP-CAN Session where PCC Rules and, if available, QoS Rules for the IP flow(s) of this AF session are installed. These PCC/QoS Rules need to be removed. + +If the AF session being terminated corresponds to a session that included the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP, if the related media flow(s) was in priority sharing with other media flows, the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing priority. These PCC/QoS Rules may need to be modified. + +Steps 5a and 6a apply if the AF did not request access network information + +- 5a. The H-PCRF sends Diameter STA, session termination answer, to the V-PCRF. + +6a. The V-PCRF forwards the Diameter STA to the AF. + +7. The H-PCRF interacts with the BBERF/PCEF via the V-PCRF according to figure 4.3.1.1.1. + +Steps 5b and 6b apply if the AF requested access network information + +5b. The H-PCRF sends Diameter STA, session termination answer, to the V-PCRF and includes access network information obtained in step 7. + +6b. The V-PCRF forwards the Diameter STA to the AF. + +### 4.3.2 PCEF –Initiated IP-CAN Session Modification (PCC Rule Provisioning in PULL Mode) + +#### 4.3.2.1 PCEF-initiated IP-CAN Session Modification. AF located in HPLMN. + +This flow shows the provisioning of PCC Rules and/or authorized QoS triggered by the PCEF. + +![Sequence diagram for PCEF-initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a series of messages between these entities, with two 'VISITED ACCESS CASE' blocks highlighted in light blue. The process involves gateway control, QoS rule requests, session modifications, diameter messages (CCR, CCA, RAR, RAA, ASR, ASA, STR, STA), profile requests, spending limit reports, PCC/ADC rule decisions, and resource allocation confirmations.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +The sequence diagram illustrates the interaction for a PCEF-initiated IP-CAN Session Modification. The lifelines are BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, AF, SPR, and OCS. The process begins with a 'Gateway control and QoS Rule request (case 2a & case 2b)' from PCEF to BBERF. This is followed by an 'IP-CAN Session Modification' from BBERF to PCEF. The first 'VISITED ACCESS CASE' block (highlighted in light blue) includes: 'Diameter CCR' from PCEF to H-PCRF; 'Diameter CCR' from PCEF to V-PCRF; 'Store Information' (self-call on V-PCRF); 'Diameter CCR' from V-PCRF to H-PCRF; 'Profile Request' from H-PCRF to SPR; 'Profile Response' from SPR to H-PCRF; a group of messages (RAR, RAA, ASR, ASA, STR, STA) between H-PCRF and AF, with a note 'If a specific action is triggered for the AF session'; and another group of messages (STR, STA) between H-PCRF and AF, with a note 'If all session info for an AF session is decided'. Next is an 'Initial/Intermediate/Final Spending limit Report Request' from H-PCRF to OCS. Then 'PCC/ADC Rule Decision' from V-PCRF to H-PCRF, followed by 'Diameter CCA' from H-PCRF to V-PCRF. The second 'VISITED ACCESS CASE' block (highlighted in light blue) includes: 'Diameter CCA' from V-PCRF to H-PCRF; 'PCC/ADC Rules validation' (self-call on V-PCRF); 'Diameter CCA' from V-PCRF to PCEF; 'TDF session modification' (self-call on TDF); 'TDF session modification' from TDF to PCEF; 'Install, modify or remove PCC/ADC Rules' (self-call on TDF); 'St session establishment/modification/termination' (self-call on TDF); and 'IP-CAN Session modification signalling' from TDF to BBERF. The sequence concludes with 'Resource allocation confirmation (case 1)' from BBERF to PCEF and 'Gateway control & QoS Rule Provision (case 2a & case 2b)' from PCEF to BBERF. + +Sequence diagram for PCEF-initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, TSSF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a series of messages between these entities, with two 'VISITED ACCESS CASE' blocks highlighted in light blue. The process involves gateway control, QoS rule requests, session modifications, diameter messages (CCR, CCA, RAR, RAA, ASR, ASA, STR, STA), profile requests, spending limit reports, PCC/ADC rule decisions, and resource allocation confirmations. + +Figure 4.3.2.1.1: PCEF-initiated IP-CAN Session Modification. AF in HPLMN. + +1. For case 2a and 2b, the BBERF may initiate Gateway Control and QoS rules request procedure described in subclause 4.4.2. +2. The PCEF may receive a request for IP-CAN Session modification. The IP-CAN session modification can be initiated upon receiving UE-initiated resource modification request (case 1), a new IP-CAN bearer establishment signalling (case 1), due to a specific event (e.g. UE requested PDN connectivity in all cases) or an internal trigger(e.g. if the PCEF supports Application Detection and Control feature, the start/stop of application traffic event that matches with one or more activated PCC rules for application detection and control that do not contain the Mute-Notification AVP has been detected by the PCEF). +3. The PCEF informs the H-PCRF about the IP-CAN session modification for non-roaming case and Home Routed roaming scenario. The PCEF sends a CCR command to the H-PCRF including the CC-Request-Type AVP set to the value “UPDATE\_REQUEST”. For an IP-CAN Session modification where an existing IP-CAN bearer is modified, the PCEF supplies the specific event that caused the IP-CAN Session modification within the Event-Trigger AVP and the PCC rule name(s) and their status within the Charging-Rule-Report AVP. For an IP-CAN Session modification where an existing IP-CAN bearer is terminated, the PCEF supplies the affected PCC rule name(s), their status set to inactive, the rule failure code and, if available, the RAN/NAS/TWAN/Untrusted WLAN cause(s) within the Charging-Rule-Report AVP. In the case where the UE initiates a resource modification request procedure, the PCEF includes the Packet-Filter-Information AVP, Packet-Filter-Operation AVP and QoS-Information AVP, if applicable. In the case of PCEF supporting Application Detection and Control feature, when the start or stop of the application’s traffic, identified by TDF-Application-Identifier, is detected, if PCRF has previously subscribed to the APPLICATION\_START/APPLICATION\_STOP Event-Triggers, the PCEF shall report the information regarding the detected application’s traffic in the Application-Detection-Information AVP in the CCR command. If NBIFOM applies to the IP-CAN session, if one of the conditions specified in subclause 4.5.25.2 of 3GPP TS 29.212 [9] applies, the PCEF informs the PCRF accordingly making use of the applicable event trigger, i.e. "ADDITION\_OF\_ACCESS", "REMOVAL\_OF\_ACCESS", "UNAVAILIBILITY\_OF\_ACCESS", "AVAILIBILITY\_OF\_ACCESS" or "ROUTING\_RULE\_CHANGE". + +When the UE is roaming in a Visited Access case, steps 3a ~ 3c are executed instead of step 3: + +- 3a. The PCEF sends a Diameter CCR to the V-PCRF to request PCC/ADD Rules for the roaming user. The parameters listed in step 3 are applicable here. + - 3b. The V-PCRF stores the information received in the Diameter CCR from the PCEF. + - 3c. The V-PCRF sends a CCR command with the CC-Request-Type AVP set to “UPDATE\_REQUEST” to the H-PCRF. The V-PCRF includes the Subsession-Enforcement-Info AVP and the assigned S9 subsession identifier within Subsession-Id AVP. The Subsession-Operation AVP is set to the value “MODIFICATION”. +4. If the H-PCRF requires subscription-related information and does not have it, the PCRF sends a request to the SPR in order to receive the information. + +5. The SPR replies with the subscription related information containing the information about the allowed service(s) and PCC Rules information. + +NOTE 1: For steps 4 and 5: The details associated with the Sp reference point are not specified in this Release. The SPR’s relation to existing subscriber databases is not specified in this Release. + +6. If the AF requested a notification of the corresponding event, the H-PCRF sends a Diameter RAR with the Specific-Action AVP set to indicate the event that caused the request. If the session modification affected a sponsored data flow and the H-PCRF detects that the usage threshold provided by the AF has been reached, this message includes the accumulated usage in the Used-Service-Unit AVP within the Sponsored-Connectivity-Data AVP and the Specific-Action AVP set to the value USAGE\_REPORT. + 7. If step 6 takes place, the AF may take the application specific procedure (e.g. for IMS refer to 3GPP TS 23.228 [59], replies with a Diameter RAA and may provide updated service information within. Additionally, the AF may terminate the Rx session as per subclause 4.3.1.2.3. +- 8-11.If all service data flows for an AF session are deleted, the AF session is terminated. If the session modification affected a sponsored data flow and the H-PCRF detects the UE is roaming with home routed case, the H-PCRF initiates the AF session termination. + +If the IP-CAN session is associated with a sponsor, usage thresholds were provided by the AF earlier, and the H-PCRF has usage data that has not yet been reported to the AF, the H-PCRF informs the AF2 in step 11, about the resources that have been consumed by the user since the last report. + +If RAN-NAS-Cause feature is supported and RAN/NAS/TWAN/Untrusted WLAN cause(s) and/or access network information were received in step 3, the H-PCRF sends this information to the AF in step 11. + +NOTE 2: Initial/intermediate/Final Spending Limit Report Request can be triggered at any time after this if PCRF, based on policy decisions, find the need to initialize, modify, or deactivate spending limit reporting for the subscriber according to subclause 4.7.1/2/3 respectively. + +12. The H-PCRF selects or generates PCC Rule(s) to be installed. The H-PCRF may also identify existing PCC rules that need to be modified or removed. In the case of VPLMN supporting Application Detection and Control feature for solicited application reporting, some of those PCC Rules may be used for application detection and control. The PCC Rules may relate to any of the matching AF sessions or may exist in the PCRF without matching to any AF session. The H-PCRF may also make a policy decision by deriving an authorized QoS and by deciding whether service data flows described in the PCC Rules are to be enabled or disabled. The H-PCRF may also update the ADC decisions and select the ADC rules to be installed, modified or removed for the IP-CAN session in the non-roaming case. If the NBIFOM applies to the IP-CAN session, the PCRF can also make a decision of NBIFOM as defined in subclause 4.5.25.2 of 3GPP TS 29.212 [9]. +13. For the non-roaming case, and for the case when the UE is roaming in a Home Routed scenario, the H-PCRF provisions the PCC Rules to the PCEF using CCA command. The H-PCRF also provides the selected Bearer Control Mode, if changed and applicable for the IP-CAN type. The PCRF may also provide a new list of event triggers for which the PCRF requires to be notified. The PCRF may provide QoS information within the APN-AMBR AVP and the Default-EPS-Bearer-QoS AVP. In the case of PCEF supporting Application Detection and Control feature, the H-PCRF may provision the PCC rules for application detection and control to the PCEF. + +When the UE is roaming in a Visited Access, steps 13a ~13c are executed instead of step 13: + +- 13a. The H-PCRF sends a Diameter CCA to the V-PCRF including the PCC Rules to be provisioned within the Subsession-Decision AVP, along with the S9 subsession identifier as received in step 3b within the Subsession-Id AVP. Other parameters listed in step 9 are also applicable here. + +- 13b. The V-PCRF validates the QoS parameters requested within the PCC Rules and enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. In case of TDF, the V-PCRF extracts and validates the ADC rules from the PCC rules received from the H-PCRF according to the local policy and roaming agreements if provided by the H-PCRF. + +NOTE: If the V-PCRF rejects provisioned PCC rules received from the H-PCRF, the remaining steps in this call flow are not followed. Instead, the V-PCRF shall notify the H-PCRF by sending a Diameter CCR, including the Experimental-Result-Code AVP set to the value PCC\_RULE\_EVENT, identify the failed PCC rules as specified in 3GPP TS 29.215 [22], and additionally may provide the acceptable QoS Information for the service. + +- 13c. The V-PCRF provisions PCC rules to the PCEF by using CCA command. The parameters listed in step 13a are applicable here. + +- 13d. In case of TDF, solicited application reporting, the V-PCRF provisions the ADC rules to the TDF as defined in subclause 4.6.3.2. In case of TDF, unsolicited application reporting, the V-PCRF initiates the TDF session termination as defined in clause 4.6.2 if the PCEF reported the UE\_IP\_ADDRESS\_RELEASE to the V-PCRF and there is an active Ipv4 address related TDF session for that IP-CAN session. + +14. In case of TDF, solicited application reporting, the H-PCRF provisions the ADC rules to the TDF as defined in subclause 4.6.3.2. In case of TDF, unsolicited application reporting, the H-PCRF initiates the TDF session termination as defined in subclause 4.6.2 if the PCEF reported the UE\_IP\_ADDRESS\_RELEASE to the H-PCRF and there is an active Ipv4 address related TDF session for that IP-CAN session. + +15. The PCEF installs, modifies or removes the provided PCC Rules. The PCEF also enforces the authorized QoS and enables or disables service flows according to the flow status of the corresponding PCC Rules. In the case of PCEF supporting Application Detection and Control feature, the PCEF enforces application detection and control. + +16. If traffic steering control over St applies, if the PCRF determines that the traffic steering control information needs to be provisioned for the IP-CAN session; the PCRF initiates the St session establishment procedure according to the subclause 4.9.2. If the PCRF determines that the traffic steering control information provisioned to the TSSF needs to be updated, the PCRF initiates the St session modification procedure according to the subclause 4.9.3. If the PCRF determines that the traffic steering control information is not needed for the IP-CAN session any more, the PCRF initiates the St session termination procedure according to the subclause 4.9.2. +17. The PCEF may initiate IP-CAN session signalling or acknowledges any IP-CAN Session signalling for IP-CAN Session modification received in step 2. +18. If the PCRF requested to confirm that the resources associated to a PCC Rule have been successfully allocated or the resource release procedure has concluded, the PCEF-initiated IP-CAN session modification procedure is performed again starting from step 3. +19. For case 2a and 2b, the PCRF may initiate Gateway Control and QoS rules Provision procedure described in subclause 4.4.3. + +#### 4.3.2.2 PCEF-initiated IP-CAN Session Modification, AF located in the VPLMN + +![Sequence diagram for PCEF-initiated IP-CAN Session Modification, AF located in the VPLMN. The diagram shows interactions between BBERF, PCEF, TDF, V-PCRF, H-PCRF, V-AF, and SPR. It includes steps 1-5, 2-9, 10-13, and 12-18 as specified in figure 4.3.2.1.1. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional.](10781f43062bf3e9601a1e086710556c_img.jpg) + +The sequence diagram illustrates the interaction between network elements for PCEF-initiated IP-CAN Session Modification. The lifelines are BBERF, PCEF, TDF, V-PCRF, H-PCRF, V-AF, and SPR. The process is divided into four main steps: + +- 1. Steps 1 to 5 as specified in figure 4.3.2.1.1.** +- 2. Diameter ASR:** A conditional message from H-PCRF to V-PCRF. +- 3. Diameter ASR:** A conditional message from V-PCRF to V-AF. +- 4. Diameter ASA:** A conditional message from V-AF to V-PCRF. +- 5. Diameter ASA:** A conditional message from V-PCRF to H-PCRF. +- 6. Diameter STR:** A conditional message from H-PCRF to V-PCRF. +- 7. Diameter STR:** A conditional message from V-PCRF to V-AF. +- 8. Diameter STA:** A conditional message from V-AF to V-PCRF. +- 9. Diameter STA:** A conditional message from V-PCRF to H-PCRF. +- 10. Diameter RAR:** A conditional message from H-PCRF to V-PCRF. +- 11. Diameter RAR:** A conditional message from V-PCRF to V-AF. +- 12. Diameter RAA:** A conditional message from V-AF to V-PCRF. +- 13. Diameter RAA:** A conditional message from V-PCRF to H-PCRF. +- 14. Steps 12 to 18 as specified in figure 4.3.2.1.1.** + +Annotations on the right side of the diagram: + +- For steps 2-9: "If all session info for an AF session is deleted" +- For steps 10-13: "If a specific action is triggered for the AF session" + +**Legend:** + +- Solid arrow: **Mandatory** +- Dashed arrow: **Conditional** + +Sequence diagram for PCEF-initiated IP-CAN Session Modification, AF located in the VPLMN. The diagram shows interactions between BBERF, PCEF, TDF, V-PCRF, H-PCRF, V-AF, and SPR. It includes steps 1-5, 2-9, 10-13, and 12-18 as specified in figure 4.3.2.1.1. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. + +**Figure 4.3.2.2.1: PCEF-initiated IP-CAN Session Modification, AF in VPLMN. If the AF resides in the VPLMN, the V-PCRF proxies the AF session signalling over S9 between the V-AF and the H-PCRF.** + +1. Steps 1 to 5 in figure 4.3.2.1.1 are executed. + +When all PCC Rules related to a particular AF session are removed, the H-PCRF initiates the AF session termination procedure. For each AF session bound to the modified IP-CAN session that is being removed, steps 2-9 are executed instead of steps 10-13: + +2. The H-PCRF indicates the session abort to the V-PCRF by sending a Diameter ASR to the V-PCRF. +3. The V-PCRF proxies the Diameter ASR command to the V-AF. +4. The V-AF responds by sending a Diameter ASA command to the V-PCRF. + +5. The V-PCRF proxies the ASA command to the H-PCRF. +6. The V-AF sends a Diameter STR command to the V-PCRF to indicate that the session has been terminated. +7. The V-PCRF proxies the Diameter STR command to the H-PCRF. +8. The V-PCRF proxies the Diameter STA command to the V-AF. +9. The H-PCRF responds by sending a Diameter STA command. + +When the H-PCRF receives event triggers related to specific actions that the AF has subscribed to, the H-PCRF initiates the AF session modification procedure to notify the AF of these specific actions. For each Afssession bound to the modified IP-CAN session that has subscribed to these specific actions, steps 10-13 are executed instead of steps 2-9: + +10. If the H-PCRF is notified of an event in the access network that has to be notified to the V-AF for an AF session, the H-PCRF informs of the event by sending a RAR command to the V-PCRF. +11. The V-PCRF proxies the RAR command to the V-AF. +12. The V-AF responds by sending a RAA command to the V-PCRF. +13. The V-PCRF proxies the RAA to the H-PCRF. +14. Steps 12 to 18 in figure 4.3.2.1.1 are executed. + +## 4.4 Gateway Control Session Procedures + +There are two kinds of Gateway Control (GC) sessions: + +- A Gateway Control session that serves a single IP-CAN session (e.g. S-GW/BBERF connecting to PDN-GW using S5/S8 PMIP according to 3GPP TS 23.402 [21]). +- A Gateway Control session that serves all the IP-CAN sessions from the same Care-of address of the UE (e.g. a UE connecting to PDN-GW using S2c according to 3GPP TS 23.402 [21]). + +These Gateway Control sessions are initiated in connection with IP-CAN session establishment and Initial Attach respectively. For the first case, the PCRF will identify that the GC session serves a single IP-CAN session based on the PDN Identifier received in the request. + +An access network may support mobility with BBERF change. The new BBERF shall establish new Gateway Control sessions according to the procedures defined for the new access type and the PCRF shall correlate those sessions with ongoing IP-CAN sessions as part of the handover procedure. + +These scenarios are shown separately in different flows. + +In the following procedures, the V-PCRF is included to depict the roaming scenarios. H-PCRF will act as a PCRF for non-roaming Ues. The procedure to detect that the IP-CAN Session is restricted to Emergency Services is described in 3GPP TS 29.212 [9]. + +### 4.4.1 Gateway Control Session Establishment + +![Sequence diagram for Gateway Control Session Establishment. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, SPR. The diagram shows two main cases: non-roaming and roaming. In the non-roaming case, BBERF sends a CCR to H-PCRF, which responds with a CCA. In the roaming case, BBERF sends a CCR to V-PCRF, which then forwards it to H-PCRF via another CCR. H-PCRF may interact with SPR for profile information. Responses are passed back through the chain. A legend indicates solid arrows are 'Mandatory' and dashed arrows are 'Conditional'. A note indicates that steps 4 and 5 are conditional if the PCRF needs subscription-related information and does not have it.](a3472689858b068ef469213682965325_img.jpg) + +The sequence diagram illustrates the Gateway Control Session Establishment process between the BBERF, PCEF, V-PCRF, H-PCRF, and SPR. The process is divided into two main scenarios: non-roaming and roaming. + +- Non-roaming Case:** + - The BBERF receives a message or indication to establish a Gateway Control session (Step 1). + - It sends a Diameter CCR to the H-PCRF (Step 2). + - The H-PCRF responds with a Diameter CCA (Step 8). + - The BBERF then installs QoS rules and policy enforcement (Step 9). + - Finally, it sends an Establish Gateway Control Session Response (Step 10). +- Roaming Case:** + - The BBERF sends a Diameter CCR to the V-PCRF (Step 2a). + - The V-PCRF stores information (Step 2b) and sends a Diameter CCR to the H-PCRF (Step 2c). + - The H-PCRF stores information (Step 3) and may send a Profile Request to the SPR (Step 4). + - The SPR responds with a Profile Response (Step 5). + - The H-PCRF then makes a PCC Rules Decision and Policy Decision (Step 6) and stores PCC Rules (Step 7). + - It sends a Diameter CCA back to the V-PCRF (Step 8). + - The V-PCRF stores PCC Rules and Policy decision (Step 8b) and sends a Diameter CCA back to the BBERF (Step 8e). + - The BBERF then installs QoS rules and policy enforcement (Step 9). + - Finally, it sends an Establish Gateway Control Session Response (Step 10). + +**Legend:** + +- Mandatory:** Solid arrow +- Conditional:** Dashed arrow + +*Note: If the PCRF needs subscription-related information and does not have it, steps 4 and 5 are conditional.* + +Sequence diagram for Gateway Control Session Establishment. Lifelines: BBERF, PCEF, V-PCRF, H-PCRF, SPR. The diagram shows two main cases: non-roaming and roaming. In the non-roaming case, BBERF sends a CCR to H-PCRF, which responds with a CCA. In the roaming case, BBERF sends a CCR to V-PCRF, which then forwards it to H-PCRF via another CCR. H-PCRF may interact with SPR for profile information. Responses are passed back through the chain. A legend indicates solid arrows are 'Mandatory' and dashed arrows are 'Conditional'. A note indicates that steps 4 and 5 are conditional if the PCRF needs subscription-related information and does not have it. + +**Figure 4.4.1.1 Gateway Control Session Establishment.** + +- The BBERF receives a message or indication that it needs to establish a Gateway Control session. + For case 2a, as defined in clause 4.0, the BBERF detects that a UE has been assigned a Local IP address that the UE may use as a Care-of Address in MIP registrations (see 3GPP TS 23.402 [21], clause 6.3). + For case 2b, as defined in clause 4.0, the BBERF detects that the UE requests an IP-CAN session to be established (see 3GPP TS 23.402 [21], clauses 4.5.2 and 5.6.1) or, at BBERF relocation, to be resumed with a certain APN (see 3GPP TS 23.402 [21], clauses 5.7.1 and 5.7.2) or the UE requests a pre-registration with this BBERF (see 3GPP TS 23.402 [21], clause 9.3.1). +- For the non-roaming case, the BBERF initiates a Gateway Control session with the H-PCRF by sending a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BBERF provides UE identity information and the IP-CAN type, User Location Information, User CSG Information (if received from the access network) and the indication of the BBERF support for the extended TFT filters. + For case 2a, as defined in clause 4.0, the BBERF provides the CoA assigned to the UE. + For case 2b, as defined in clause 4.0, the BBERF provides the PDN identifier and PDN connection identifier, if + +multiple PDN connections for the same APN are supported and, if applicable, a Session-Linking-Indicator to indicate if the session linking has to be deferred. The BBERF provides, when available, the APN-AMBR and Default-EPS-Bearer-QoS. + +NOTE: The BBERF support is a prerequisite for the PCRF enabling the possibility for usage of the extended TFT filter in the IP-CAN session(s). + +If applicable for the IP-CAN type, the BBERF additionally provides Network-Request-Support AVP to indicate whether NW-initiated procedures are supported. + +When the UE is roaming, the steps 2a-2c are executed instead of step 2: + +2a. The BBERF initiates a Gateway Control session with the V-PCRF by sending a CCR to the V-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BBERF provides UE identity information and the IP-CAN type, User Location Information and User CSG Information (if received from the access network). + +For case 2a, as defined in clause 4.0, the BBERF provides the CoA assigned to the UE. + +For case 2b, as defined in clause 4.0, the BBERF provides the PDN identifier and, if applicable, a Session-Linking-Indicator AVP to indicate if the session linking has to be deferred. The BBERF provides, when available, the APN-AMBR and Default-EPS-Bearer-QoS. + +If applicable for the IP-CAN type, the BBERF additionally provides Network-Request-Support AVP to indicate whether NW-initiated procedures are supported. + +2b. The V-PCRF determines based on the UE identity information that the request is for a roaming user. The V-PCRF checks whether the V-PCRF needs to send the CCR to the H-PCRF based on the roaming agreements. For the Visited Access case, the V-PCRF does not send the CCR to the H-PCRF if the Session-Linking-Indicator AVP was received indicating that the session linking has to be deferred. + +NOTE: If the V-PCRF does not send the CCR to the H-PCRF, the PCRF may generate QoS rules based on VPLMN roaming agreements. + +2c. For case 2a: + +- If there is not an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The V-PCRF includes in the CCR the information received in step 2a. +- If there is an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2a. + +For case 2b and for the visited case or for the home routed case and if the Session-Linking-Indicator AVP is not received or it indicates SESSION\_LINKING\_IMMEDIATE, the following procedures apply: + +- If there is not an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this Gateway Control Session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. +- If there is an already established S9 session for this roaming user and not an already established S9 subsession for the PDN connection corresponding to the Gateway Control Session, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this Gateway Control Session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. +- If there is an already established S9 session for this roaming user and an already established S9 subsession for the PDN connection corresponding to the Gateway Control Session, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR command with the S9 subsession identifier assigned by the V-PCRF for this Gateway Control Session within the Subsession-Id AVP, the Subsession-Operation AVP set to the value MODIFICATION, and the BBERF identity within AN-GW-Address AVP. + +For case 2b and for the home routed case and if the Session-Linking-Indicator AVP was received indicating that the session linking has to be deferred, following procedure applies: + +- The V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this Gateway Control Session within the Subsession-Id AVP, the Subsession-Operation AVP set to the value ESTABLISHMENT and the Session-Linking-Indicator AVP set to the value "SESSION\_LINKING\_DEFERRED". +3. The H-PCRF stores the information received in the CCR. The H-PCRF determines the network scenario that applies (case 2a or 2b) as described in clause 4.0. + +For case 2a, the H-PCRF may correlate the UE identity information with already established Gx sessions for the same UE. + +For case 2b, for non roaming case, the H-PCRF links the Gateway Control session with the already established Gx Session and acts as follows: + +- if the Session-Linking-Indicator was received indicating that the session linking has to be deferred, defers the session linking till the associated IP-CAN session establishment or modification is received. + - if the Session-Linking-Indicator was not received or indicates that the session linking has to be performed immediately, links the Gateway Control session with the already established Gx Session. +4. If the H-PCRF requires subscription-related information and does not have it, the H-PCRF sends a request to the SPR in order to receive the information. +5. The SPR replies with the subscription related information containing the information about the allowed service(s), QoS information, PCC Rules information and may include MPS EPS Priority, MPS Priority Level and IMS Signalling Priority of establishment a PS session with priority. + +NOTE: For steps 4 and 5: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +6. For case 2a, the H-PCRF may prepare for the installation of QoS rules if available; + +For case 2b, the H-PCRF may + +- At IP-CAN session establishment, if the session linking was not deferred, select or generate and store PCC Rule(s) in preparation for the anticipated Gx session and derive the QoS rules from them. If MPS EPS Priority, MPS Priority Level, and IMS Signalling Priority are present for the user, the PCRF takes the information into account. If the session linking was deferred, the PCC rules are not generated; + - At BBERF relocation and at pre-registration, if the Session-Linking-Indicator was not received or indicates that the session linking has to be performed immediately, prepare for the installation of QoS rules, derived from the active PCC rules, at the target BBERF; +7. The H-PCRF stores the selected QoS Rules and PCC Rules. If applicable the H-PCRF selects the Bearer Control Mode that will apply during the Gateway Control session. +8. For the non-roaming case, the H-PCRF acknowledges the Gateway Control Session by sending a CCA to the BBERF. The H-PCRF includes: +- The selected BCM, if applicable for the IP-CAN type + - If NW-initiated procedures are available, the available QoS rules + - If BCM is UE-only, the QoS rules that correspond to the request from the BBERF + - Default-EPS-Bearer-QoS and APN-AMBR when applicable + - The event triggers + +When the UE is roaming, the steps 8a-8e are executed instead of step 8: + +- 8a. The H-PCRF acknowledges the Gateway Control Session by sending a CCA to the V-PCRF. The H-PCRF includes + +- The selected BCM, if applicable for the IP-CAN type + - If NW-initiated procedures are available, the available QoS rules for the home routed case or the available PCC rules for the visited access case + - If BCM is UE-only, the QoS rules that correspond to the request from the V-PCRF for the home routed case or the PCC rules that correspond to the request from the V-PCRF for the visited access case + - For the case 2a, the QoS rules when the available QoS rules are not related to any IP-CAN session + - Default-EPS-Bearer-QoS and APN-AMBR when applicable + - Event triggers +- 8b. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. +- 8c. If the V-PCRF denies an authorization, it informs the H-PCRF and may provide the acceptable QoS Information for the service. +- 8d. The H-PCRF may provide new or modified QoS rules to the V-PCRF +- 8e. If V-PCRF receives the PCC rules from the H-PCRF, the V-PCRF extracts the QoS rules from the PCC rules. The V-PCRF acknowledges the Gateway Control Session establishment by sending a CCA to the BBERF. The V-PCRF includes the selected BCM if applicable for the IP-CAN type, any applicable QoS rules and event triggers. +9. The BBERF installs and enforces the received QoS Rules. +10. The BBERF sends an Establish Gateway Session Control Response to ack the Gateway Control Session Request. + +### 4.4.2 Gateway Control and QoS Rules Request + +#### 4.4.2.1 Non-Roaming and Home Routed cases + +![Sequence diagram for Gateway Control and QoS Rules Request for non-roaming and home routed cases. The diagram shows interactions between BBERF, PCEF, V-PCRF, and H-PCRF. It is divided into two shaded regions: 'Roaming case (home routed)' and 'Non-Roaming and Home Routed cases' (implied by the title).](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of BBERF: 1. Trigger to request QoS rules or report event + BBERF->>H-PCRF: 2. Diameter CCR + Note right of V-PCRF: 2b. Store information + Note left of BBERF: Roaming case (home routed) + BBERF->>V-PCRF: 2a. Diameter CCR + V-PCRF->>H-PCRF: 2c. Diameter CCR + Note right of H-PCRF: 3. Store information and update QoS rules + H-PCRF->>BBERF: 4. Diameter CCA + Note right of V-PCRF: 4b. Extract QoS rules + Note left of BBERF: Roaming case (home routed) + V-PCRF->>H-PCRF: 4a. Diameter CCA + V-PCRF->>BBERF: 4c. Diameter CCA + Note left of BBERF: 5. Install and update QoS rules + +``` + +Sequence diagram for Gateway Control and QoS Rules Request for non-roaming and home routed cases. The diagram shows interactions between BBERF, PCEF, V-PCRF, and H-PCRF. It is divided into two shaded regions: 'Roaming case (home routed)' and 'Non-Roaming and Home Routed cases' (implied by the title). + +**Figure 4.4.2.1.1: Gateway Control and QoS Rules Request for non-roaming and home routed** + +1. The BBERF is triggered to either report an event or obtain QoS rules or both for a gateway control session. +2. The BBERF sends a Diameter CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report event or request QoS rules. + +When the UE is roaming (home routed traffic), steps 2a ~ 2c are executed instead of step 2: + +- 2a. The BBERF sends a Diameter CCR to the V-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report event or request QoS rules. +- 2b. The V-PCRF stores the information received. +- 2c. For case 2a, The V-PCRF sends a Diameter CCR to the H-PCRF within the information received in step 2a at command level. + +For case 2b, The V-PCRF sends a Diameter CCR to the H-PCRF within the information received in step 2a at Subsession-Enforcement-Info AVP. + +3. The H-PCRF stores the received information in the Diameter CCR and derives updated QoS rules and event triggers. +4. The H-PCRF provisions the updated QoS rules and event triggers to the BBERF using Diameter CCA. The CCA may also only acknowledge that the event report has been received successfully. + +When the UE is roaming (home routed traffic), steps 4a ~ 4c are executed instead of step 4: + +- 4a. The H-PCRF sends the updated QoS rules and event triggers to the V-PCRF using Diameter CCA. The CCA may also only acknowledge that the event report has been received successfully. + - 4b. The V-PCRF may also perform further authorization of the rules based on local policies. + - 4c. The V-PCRF sends the updated QoS rules and event triggers to the BBERF using Diameter CCA. +5. The BBERF installs the received QoS Rules and event triggers. This may result in bearer binding being performed according to the rules. The BBERF also enables or disables service flow according to the flow status of the corresponding QoS Rules. The result of the QoS rule activation may trigger the BBERF to send an additional Diameter CCR as described above to the PCRF, for example, to indicate that QoS rule activation has failed. + +#### 4.4.2.2 Visited access cases + +![Sequence diagram for Gateway Control and QoS Rules Request for visited access. The diagram shows interactions between BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with a trigger at the BBERF, followed by a Diameter CCR to the V-PCRF. The V-PCRF stores information and updates QoS rules. It then sends a Diameter CCR to the H-PCRF (conditional), which stores information and updates PCC rules. The H-PCRF sends a Diameter CCA back to the V-PCRF (conditional). The V-PCRF then stores information and extracts QoS rules. Finally, the V-PCRF sends a Diameter CCA back to the BBERF, which installs and updates QoS rules. A legend indicates that solid lines are mandatory and dashed lines are conditional.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of BBERF: 1. Trigger to request QoS rules or report event + BBERF->>V-PCRF: 2. Diameter CCR + Note right of V-PCRF: 3. Store information and update QoS rules + Note right of V-PCRF: 3a. Diameter CCR + V-PCRF-->>H-PCRF: 3a. Diameter CCR + Note right of H-PCRF: 3b. Store information and update PCC rules + Note right of H-PCRF: 3c. Diameter CCA + H-PCRF-->>V-PCRF: 3c. Diameter CCA + Note right of V-PCRF: 3d. Store information and Extract QoS rules + V-PCRF->>BBERF: 4. Diameter CCA + Note left of BBERF: 5. Install and update QoS rules + +``` + +**Legend** + +- Mandatory** (solid line) +- Conditional** (dashed line) + +Sequence diagram for Gateway Control and QoS Rules Request for visited access. The diagram shows interactions between BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with a trigger at the BBERF, followed by a Diameter CCR to the V-PCRF. The V-PCRF stores information and updates QoS rules. It then sends a Diameter CCR to the H-PCRF (conditional), which stores information and updates PCC rules. The H-PCRF sends a Diameter CCA back to the V-PCRF (conditional). The V-PCRF then stores information and extracts QoS rules. Finally, the V-PCRF sends a Diameter CCA back to the BBERF, which installs and updates QoS rules. A legend indicates that solid lines are mandatory and dashed lines are conditional. + +**Figure 4.4.2.2.1: Gateway Control and QoS Rules Request for visited access** + +1. The BBERF is triggered to either report an event or obtain QoS rules or both for a gateway control session. +2. The BBERF sends a Diameter CCR to the V-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report event or request QoS rules. +3. The V-PCRF stores the information received in the Diameter CCR and derives updated QoS rules and event triggers according to local policies and roaming agreements. + +When the report event is subscribed by H-PCRF, the steps 3a~3d are executed instead of step3: + +- 3a. The V-PCRF sends a Diameter CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report event. + +For case 2a, the information received in step 2 is send to H-PCRF at command level. + +For case 2b, the CCR is send with the information provided at subsession level within the Subsession-Enforcement-Info AVP. + +- 3b. The H-PCRF stores the received information in the Diameter CCR and derives event triggers. +- 3c. The H-PCRF sends the event triggers to the V-PCRF using Diameter CCA. The CCA may also only acknowledge that the event report has been received successfully. +- 3d. The V-PCRF may also perform further authorization of the rules based on local policies. +- 4. The V-PCRF provisions the updated QoS rules and event triggers to the BBERF using Diameter CCA. +- 5. The BBERF installs the received QoS Rules and event triggers. This may result in bearer binding being performed according to the rules. The BBERF also enables or disables service flow according to the flow status of the corresponding QoS Rules. The result of the QoS rule activation may trigger the BBERF to send an additional Diameter CCR as described above to the PCRF, for example, to indicate that QoS rule activation has failed. + +### 4.4.3 Gateway Control and QoS Rules Provision + +Since the PCRF is required to keep QoS rules aligned with the active PCC rules for a certain IP-CAN session, it shall initiate the Gateway Control and QoS Rules Provision whenever there is a change to the corresponding PCC rules for a Gx session that is linked with the Gateway Control Session. + +![Sequence diagram for Gateway Control and QoS Rules Provision showing interactions between BBERF, PCEF, V-PCRF, and H-PCRF. The diagram includes steps for triggering updates, sending Diameter RAR/RAA messages, and handling roaming cases.](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note right of H-PCRF: 1. Trigger to update QoS rules + H-PCRF->>BBERF: 2. Diameter RAR + Note right of V-PCRF: 2b. Identify the gateway control session and perform authorization + Note over BBERF, PCEF, V-PCRF: Roaming case + V-PCRF->>V-PCRF: 2a. Diameter RAR + V-PCRF->>BBERF: 2c. Diameter RAR + Note left of BBERF: 3. Install/Update QoS rules + BBERF->>H-PCRF: 4. Diameter RAA + Note over BBERF, PCEF, V-PCRF: Roaming case + BBERF->>V-PCRF: 4a. Diameter RAA + V-PCRF->>H-PCRF: 4b. Diameter RAA + Note left of BBERF: 5. Access specific procedures to modify bearers + +``` + +Sequence diagram for Gateway Control and QoS Rules Provision showing interactions between BBERF, PCEF, V-PCRF, and H-PCRF. The diagram includes steps for triggering updates, sending Diameter RAR/RAA messages, and handling roaming cases. + +**Figure 4.4.3.1: Gateway Control and QoS Rules Provision** + +- 1. The H-PCRF receives an internal or external trigger to update QoS Rules and event triggers for a gateway control session. If the trigger is from the AF and the AF requests the access network information, the H-PCRF applies the procedure as defined in clause 4a.5.16 of 3GPP TS 29.212 [9] to request the access network + +information. If the trigger is from the AF and the AF provided the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP, the H-PCRF may apply the procedures as defined in clause 4a.5.10.6 of 3GPP TS 29.212 [9] to request the resource sharing. + +2. The H-PCRF sends a Diameter RAR to request that the BBERF installs, modifies or removes QoS Rules and/or updates the event triggers. + +If the UE is roaming, then steps 2a ~ 2c are executed instead of step 2: + +- 2a. The H-PCRF sends a Diameter RAR to the V-PCRF to provision updated QoS Rules and updated event triggers. + +For case 2a, the RAR provides the updated QoS Rules and updated event triggers with the information included at command level. + +For case 2b, The H-PCRF sends a Diameter RAR to the V-PCRF within the information at Subsession-Decision-Info AVP. + +- 2b. The V-PCRF identifies the gateway control session if needed and performs local authorization of the updated QoS rules when necessary. + +- 2c. The V-PCRF sends a Diameter RAR to the BBERF to provision updated QoS rules and updated event triggers. + +3. The BBERF installs, modifies or removes the identified QoS Rules. The BBERF also enforces the authorized QoS and enables or disables service flow according to the flow status of the corresponding QoS Rules. +4. The BBERF sends RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the QoS rule operation. If network initiated resource allocation procedures apply for the QoS rules and the corresponding IP-CAN bearer can not be established or modified to satisfy the bearer binding, then the BBERF rejects the activation of a PCC rule. + +If the UE is roaming, then steps 4a ~ 4b are executed instead of step 4: + +- 4a. The BBERF sends RAA to the V-PCRF to acknowledge the RAR and informs the V-PCRF about the outcome of the QoS rule operation. If network initiated resource allocation procedures apply for the QoS rules and the corresponding IP-CAN bearer can not be established or modified to satisfy the bearer binding, then the BBERF rejects the activation of a PCC rule. + - 4b. The V-PCRF forwards the RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the QoS rule operation. +5. If needed, the BBERF initiates the access specific procedures to create or modify existing IP-CAN bearers. When the procedure in step 5 is completed and requires of notifications from the BBERF to the PCRF, e.g. in the case of access network information, the steps described as in clause 4.4.2 are additionally executed. + +### 4.4.4 Gateway Control Session Termination + +#### 4.4.4.1 BBERF-Initiated Gateway Control Session Termination + +This procedure applies for case 2b, as defined in clause 4.0, whenever the BBERF detects a request for a PDN disconnection, mobility to other access or the termination of a pre-registration at the BBERF. + +![Sequence diagram showing the interaction between BBERF, PCEF, V-PCRF, and H-PCRF for a Gxx session removal. The process involves Diameter CCR and CCA messages, with specific steps for roaming cases involving IP-CAN session updates.](dd5771673aececa53d42ece89218299d_img.jpg) + +``` +sequenceDiagram + participant External + participant BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of BBERF: Roaming case + External->>BBERF: 1. Remove Gxx Session Request + BBERF->>H-PCRF: 2. Diameter CCR + H-PCRF->>V-PCRF: 2a. Diameter CCR + V-PCRF->>H-PCRF: 2b. Diameter CCR + Note right of H-PCRF: 3. Identify related IP-CAN session and perform update as needed. + H-PCRF->>BBERF: 4. Diameter CCA + Note left of BBERF: Roaming case + H-PCRF->>V-PCRF: 4a. Diameter CCA + Note right of V-PCRF: 4b. Identify related IP-CAN session and perform update if needed + V-PCRF->>BBERF: 4c. Diameter CCA + BBERF->>External: 5. Remove Gxx Session Reply +``` + +The sequence diagram illustrates the interaction between four network elements: BBERF, PCEF, V-PCRF, and H-PCRF. The process begins with an external 'Remove Gxx Session Request' sent to the BBERF. The BBERF then sends a 'Diameter CCR' (2.) to the H-PCRF. This is followed by a 'Diameter CCR' (2a.) from the H-PCRF to the V-PCRF. The V-PCRF sends a 'Diameter CCR' (2b.) back to the H-PCRF. The H-PCRF then performs an internal step to 'Identify related IP-CAN session and perform update as needed.' (3.). The H-PCRF sends a 'Diameter CCA' (4.) back to the BBERF. In a 'Roaming case', the H-PCRF also sends a 'Diameter CCA' (4a.) to the V-PCRF. The V-PCRF then performs an internal step to 'Identify related IP-CAN session and perform update if needed' (4b.). Finally, the V-PCRF sends a 'Diameter CCA' (4c.) to the BBERF, which then sends the 'Remove Gxx Session Reply' (5.) to the external entity. + +Sequence diagram showing the interaction between BBERF, PCEF, V-PCRF, and H-PCRF for a Gxx session removal. The process involves Diameter CCR and CCA messages, with specific steps for roaming cases involving IP-CAN session updates. + +###### Figure 4.4.4.1.1: BBERF-Initiated Gateway Control Session Termination + +1. The BBERF is requested to terminate its gateway control session. The form of the request to remove the gateway control session depends upon the type of the IP-CAN. +2. The BBERF sends a Diameter CCR message to the H-PCRF, indicating the gateway control session termination. The BBERF requests the termination of the DCC session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. + +If the UE is roaming, then steps in 2a ~ 2b are executed instead of step 2: + +- 2a. The BBERF sends a Diameter CCR message to the V-PCRF, indicating the gateway control session termination. The BBERF requests the termination of the DCC session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. +- 2b. For the case 2a or if this is the last subsession associated with the S9 session for the case 2b, the V-PCRF sends a Diameter CCR message to the H-PCRF to request the termination of the S9 session. Otherwise, if the gateway control session is locally handled at the V-PCRF, the V-PCRF continues from step 4b; if the gateway control session has a corresponding S9 subsession, then the V-PCRF sends a Diameter CCR message to the H-PCRF to request the termination of the corresponding S9 subsession. + +3. The H-PCRF identifies the related IP-CAN session and performs update as necessary. +4. The H-PCRF acknowledges the session termination by sending a Diameter CCA message. + +If the UE is roaming, then steps 4a ~ 4c are executed instead of step 4: + +- 4a. If the H-PCRF receives the Diameter CCR message in step 2b, the H-PCRF acknowledges the session or subsession termination request by sending a Diameter CCA message to the V-PCRF. + - 4b. The V-PCRF identifies the related IP-CAN session and performs update as necessary. + - 4c. The V-PCRF acknowledges the session termination by sending a Diameter CCA message to the BBERF. +5. The BBERF sends a reply to the request to remove the gateway control session. The form of the reply depends upon the type of the IP-CAN. + +#### 4.4.4.2 PCRF-Initiated Gateway Control Session Termination + +This procedure applies for case 2a, as defined in clause 4.0, when the PCRF detects that there is no remaining IP-CAN session at the PCRF. + +![Sequence diagram illustrating PCRF-Initiated Gateway Control Session Termination. The diagram shows four lifelines: BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with an external 'Remove Gxx Session Request' to the H-PCRF. The H-PCRF sends a 'Diameter RAR' (Step 2) to the BBERF. If the UE is roaming, the H-PCRF sends a 'Diameter RAR' (Step 2a) to the V-PCRF, which then sends a 'Diameter RAR' (Step 2b) to the BBERF. The BBERF sends a 'Diameter RAA' (Step 3) to the H-PCRF. If the UE is roaming, the BBERF sends a 'Diameter RAA' (Step 3a) to the V-PCRF, which then sends a 'Diameter RAA' (Step 3b) to the H-PCRF. Finally, the BBERF terminates the Gateway control session (Step 4).](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note right of H-PCRF: 1. Remove Gxx Session Request + H-PCRF->>BBERF: 2. Diameter RAR + Note left of BBERF: Roaming case + H-PCRF->>V-PCRF: 2a. Diameter RAR + V-PCRF->>BBERF: 2b. Diameter RAR + BBERF->>H-PCRF: 3. Diameter RAA + Note left of BBERF: Roaming case + BBERF->>V-PCRF: 3a. Diameter RAA + V-PCRF->>H-PCRF: 3b. Diameter RAA + Note right of BBERF: 4. The BBERF terminates the Gateway control session based on the BBERF-initiated termination procedures. + +``` + +Sequence diagram illustrating PCRF-Initiated Gateway Control Session Termination. The diagram shows four lifelines: BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with an external 'Remove Gxx Session Request' to the H-PCRF. The H-PCRF sends a 'Diameter RAR' (Step 2) to the BBERF. If the UE is roaming, the H-PCRF sends a 'Diameter RAR' (Step 2a) to the V-PCRF, which then sends a 'Diameter RAR' (Step 2b) to the BBERF. The BBERF sends a 'Diameter RAA' (Step 3) to the H-PCRF. If the UE is roaming, the BBERF sends a 'Diameter RAA' (Step 3a) to the V-PCRF, which then sends a 'Diameter RAA' (Step 3b) to the H-PCRF. Finally, the BBERF terminates the Gateway control session (Step 4). + +**Figure 4.4.4.2.1: PCRF-Initiated Gateway Control Session Termination** + +1. The H-PCRF is requested to terminate the gateway control session. +2. The H-PCRF sends a Diameter RAR message to the BBERF including a Session-Release-Cause AVP to indicate request for terminating the gateway control session. + +If the UE is roaming, then steps in 2a ~ 2b are executed instead of Step 2: + +2a. The H-PCRF sends a Diameter RAR message to the V-PCRF to indicate the termination of the S9 session including the Session-Release-Cause AVP. + +2b. The V-PCRF sends a Diameter RAR message to the BBERF based on the termination request received from the H-PCRF to indicate the gateway control session termination. + +3. The BBERF acknowledges the gateway control session termination request by sending a Diameter RAA message. + +If the UE is roaming, then steps 3a ~ 3b are executed instead of Step 3: + +3a. The BBERF acknowledges the gateway control session termination request by sending a Diameter RAA message to the V-PCRF. + +3b. The V-PCRF sends a Diameter RAA message to the H-PCRF and acknowledges the request for terminating the S9 session corresponding to the gateway control session. + +4. The BBERF follows the BBERF-initiated gateway control session termination procedures described in clause 4.4.4.1 to terminate the gateway control session. + +## 4.5 Multiple BBERF Signalling Flows + +### 4.5.1 Non-Roaming and Home Routed cases + +#### 4.5.1.1 New Gateway Control Session Establishment + +The following signalling flow describes an example of a new BBERF initiating a GW control session establishment associated with an existing IP-CAN session. + +![Sequence diagram showing Gateway Control Session Establishment during BBERF relocation. Lifelines: Source BBERF, Target BBERF, PCEF, V-PCRF, H-PCRF. The process involves a request from Source BBERF to Target BBERF, followed by Diameter CCR messages to H-PCRF and V-PCRF. The H-PCRF performs internal steps (store info, identify BBERF, PCC/QoS decision) and returns a Diameter CCA. The V-PCRF then performs its own steps (store info, identify home routed access) and returns a Diameter CCA to the Target BBERF. The Target BBERF then installs QoS rules and sends a response back to the Source BBERF. The diagram is divided into 'ROAMING CASE' sections for the V-PCRF interactions.](7a1dee155822446f7828dcb055c465c3_img.jpg) + +``` + +sequenceDiagram + participant Source BBERF + participant Target BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of Source BBERF: 1. Establish Gateway Control Session Request + Source BBERF->>Target BBERF: + Note right of Target BBERF: 2. Diameter CCR + Target BBERF->>H-PCRF: + Note right of H-PCRF: ROAMING CASE + Note right of V-PCRF: 2a. Diameter CCR + V-PCRF->>V-PCRF: 2b. Store Information and identify home routed access + Note right of V-PCRF: + V-PCRF->>H-PCRF: 2c. Diameter CCR + Note right of H-PCRF: + H-PCRF->>H-PCRF: 3. Store Information + H-PCRF->>H-PCRF: 4. Identify multiple BBERF(s) + H-PCRF->>H-PCRF: 5. PCC/QoS Rules decision based on BCM of GW control session + H-PCRF->>H-PCRF: 6. Store PCC/QoS Rules + Note right of H-PCRF: + H-PCRF->>Target BBERF: 7. Diameter CCA + Note right of H-PCRF: ROAMING CASE + H-PCRF->>V-PCRF: 7a. Diameter CCA + Note right of V-PCRF: + V-PCRF->>V-PCRF: 7b. Store PCC/QoS Rules. Policy decision + Note right of V-PCRF: + V-PCRF->>H-PCRF: 7c. Diameter CCR + H-PCRF-->>V-PCRF: 7d. Diameter CCA + Note right of V-PCRF: + V-PCRF->>Target BBERF: 7e. Diameter CCA + Note right of Target BBERF: + Target BBERF->>Target BBERF: 8. Install QoS Rules. Policy enforcement + Note right of Target BBERF: + Target BBERF->>Source BBERF: 9. Establish Gateway Control Session Response + +``` + +**Legend:** + → **Mandatory** + -.-> **Conditional** + +Sequence diagram showing Gateway Control Session Establishment during BBERF relocation. Lifelines: Source BBERF, Target BBERF, PCEF, V-PCRF, H-PCRF. The process involves a request from Source BBERF to Target BBERF, followed by Diameter CCR messages to H-PCRF and V-PCRF. The H-PCRF performs internal steps (store info, identify BBERF, PCC/QoS decision) and returns a Diameter CCA. The V-PCRF then performs its own steps (store info, identify home routed access) and returns a Diameter CCA to the Target BBERF. The Target BBERF then installs QoS rules and sends a response back to the Source BBERF. The diagram is divided into 'ROAMING CASE' sections for the V-PCRF interactions. + +Figure 4.5.1.1.1: Gateway Control Session Establishment during BBERF relocation + +1. The target BBERF receives a message or indication to establish a Gateway Control session + +2. The target BBERF initiates a Gateway Control session with the H-PCRF by sending a CCR using the CC-Request-Type AVP set to the value INITIAL\_REQUEST to the H-PCRF. The target BBERF provides information as detailed in clause 4a.5.1 of 3GPP TS 29.212 [9]. + +When the UE is roaming, the following steps are executed instead of step 2: + +- 2a. The target BBERF initiates a Gateway Control session with the V-PCRF by sending a CCR using the CC-Request-Type AVP set to the value INITIAL\_REQUEST to the V-PCRF. The target BBERF provides information as detailed in clause 4a.5.1 of 3GPP TS 29.212 [9]. +- 2b. The V-PCRF determines based on the UE identity information that the request is for a roaming user. The V-PCRF checks whether the V-PCRF is required to send the request to the H-PCRF based on the roaming agreements. +- 2c. For case 2a: + - The V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2a. The V-PCRF includes the BBERF identity by including the AN-GW-Address AVP at command level. + +For case 2b: + +- If the Session-Linking-Indicator AVP is not received, or it indicates SESSION\_LINKING\_IMMEDIATE, the V-PCRF sends the CCR command to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR command with allocated S9 subsession identifier assigned by the V-PCRF for this PDN connection within the Subsession-Id AVP, the Subsession-Operation AVP set to the value MODIFICATION, the BBERF identity within AN-GW-Address AVP. + - If the Session-Linking-Indicator AVP is received indicating that the session linking has to be deferred, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this Gateway Control Session within the Subsession-Id AVP, the Subsession-Operation AVP set to the value ESTABLISHMENT and the Session-Linking-Indicator AVP set to the value "SESSION\_LINKING\_DEFERRED". +3. The H-PCRF stores the information received in the Diameter CCR. + 4. If the Session-Linking-Indicator AVP was received indicating that the session linking has to be deferred, the linking between the Gateway Control Session and the Gx session shall be deferred. Otherwise, based on the information received the H-PCRF identifies multiple BBERF sessions for a particular IP-CAN session. + 5. The H-PCRF derives applicable PCC/QoS rules based on the BCM mode as defined in clause 4a.5.7 of 3GPP TS 29.212 [9]. + 6. The H-PCRF stores the selected QoS Rules and PCC Rules. For non-roaming users the H-PCRF selects the Bearer Control Mode that will apply during the Gateway Control session. + 7. The H-PCRF acknowledges the Gateway Control Session by sending a Diameter CCA. The H-PCRF includes the selected BCM if applicable, the QoS rules and event triggers. + +When the UE is roaming, the following steps are executed instead of step 7: + +- 7a. The H-PCRF acknowledges the Gateway Control Session by sending a Diameter CCA to the V-PCRF. The H-PCRF includes applicable QoS rules and also event triggers. The H-PCRF also includes the AN-GW-Address AVP if the QoS rules are applicable for a single BBERF. +- 7b. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. +- 7c. If the V-PCRF denies an authorization, it informs the H-PCRF and may provide the acceptable QoS Information for the service. +- 7d. The H-PCRF may provide new or modified QoS rules to the V-PCRF. + +- 7e. The V-PCRF acknowledges the Gateway Control Session and provisions, when applicable, the selected BCM, policy decisions and event triggers to the target BBERF. +8. The BBERF installs the received QoS Rules. +9. The target BBERF establishes an indication for a Gateway control session response. + +#### 4.5.1.2 PCEF IP-CAN session modification – Handover + +The following signalling flow describe the case when an indication of handover is received by the PCEF and the H-PCRF derives QoS rules based on the type of BBERF (primary/non-primary). + +![Sequence diagram for PCEF IP-CAN session modification – Handover involving Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF.](ca5566458a134032dd860e88fdaa0d2b_img.jpg) + +``` + +sequenceDiagram + participant S_BBERF as Source BBERF + participant T_BBERF as Target BBERF + participant PCEF + participant V_PCRF as V-PCRF + participant H_PCRF as H-PCRF + + Note over S_BBERF, PCEF: 1. Indication of handover + S_BBERF->>PCEF: + PCEF->>H_PCRF: 2. Diameter CCR + Note right of H_PCRF: 3. Store Information + Note right of H_PCRF: 4. Derive primary/non-primary BBERF(s) + Note right of H_PCRF: 5. PCC/QoS Rules decision based on BCM of GW control session + Note right of H_PCRF: 6. Store PCC/QoS Rules + H_PCRF->>PCEF: 7. Diameter CCA + H_PCRF->>T_BBERF: 8. Diameter RAR + + rect rgb(220, 255, 255) + Note left of V_PCRF: ROAMING CASE + H_PCRF-->>V_PCRF: 8a. Diameter RAR + Note over V_PCRF: 8b. Store PCC/QoS Rules. Policy decision + V_PCRF-->>H_PCRF: 8c. Diameter RAA + H_PCRF-->>V_PCRF: 8d. Diameter RAR + V_PCRF->>T_BBERF: 8e. Diameter RAR + end + + Note over T_BBERF: 9. Install QoS Rules. Policy enforcement + T_BBERF->>H_PCRF: 10. Diameter RAA + + rect rgb(220, 255, 255) + Note left of V_PCRF: ROAMING CASE + T_BBERF-->>V_PCRF: 10a. Diameter RAA + V_PCRF-->>H_PCRF: 10b. Diameter RAA + end + +``` + +**Legend:** +——> Mandatory +- - - -> Conditional + +Sequence diagram for PCEF IP-CAN session modification – Handover involving Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF. + +**Figure 4.5.1.2.1: PCEF IP-CAN session modification – Handover** + +1. The PCEF receives a message or indication that a handover occurred +2. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the H-PCRF. The PCEF includes the AN\_GW\_CHANGE event trigger, and if applicable the IP-CAN\_CHANGE event trigger as well, to indicate that handover has occurred. + +3. The H-PCRF stores the information received in the Diameter CCR. +4. If there is a pending gateway control session to be linked to a Gx session, the H-PCRF shall perform the session linking according to clause 4a.5.6 of 3GPP TS 29.212 [9] for the non-roaming case. Based on the information received the H-PCRF reclassifies primary/non-primary BBERFs according to the procedures defined in clause 4a.5.7 of 3GPP TS 29.212 [9]. +5. The H-PCRF derives PCC rules for the PCEF, and QoS rules for the new reclassified primary BBERF, based on the BCM mode of the GW control session as defined in clause 4a.5.7 of 3GPP TS 29.212 [9]. +6. The H-PCRF stores the selected QoS Rules and PCC Rules. +7. The H-PCRF acknowledges the IP-CAN session modification request by sending a Diameter CCA to the PCEF. The H-PCRF includes updated PCC rules and event triggers (if applicable). +8. The H-PCRF initiates a Gateway Control and QoS Rules Provision procedure by sending a Diameter RAR. The H-PCRF includes the selected BCM if applicable, the QoS rules and event triggers. + +When the UE is roaming, the following steps are executed instead of step 8: + +- 8a. The H-PCRF initiates a Gateway Control and QoS Rules Provision procedure to the V-PCRF by sending a Diameter RAR to the V-PCRF. The H-PCRF sends applicable QoS rules based on the BBERF type (primary/non-primary) and BCM mode selected as defined in clause 4a.5.9 of 3GPP TS 29.212 [9]. The H-PCRF includes the AN-GW-Address AVP if the QoS rules are applicable only for a single BBERF. If the QoS rules are applicable for all BBERF sessions this AVP is omitted. + - 8b. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. + - 8c. If the V-PCRF denies an authorization, it informs the H-PCRF and may provide the acceptable QoS Information for the service by including in the RAA command the QoS-Rule-Report AVP to indicate the QoS Rules that were not accepted, the Rule-Failure-Code AVP set to UNSUCCESSFUL-QoS-VALIDATION, and the QoS-Information AVP. + - 8d. The H-PCRF may provide new or modified QoS rules to the V-PCRF. + - 8e. The V-PCRF initiates the Gateway Control Session and QoS rules provisions, when applicable, the selected BCM, policy decisions and event triggers to the target BBERF. +9. The BBERF installs the received QoS Rules. + 10. The target BBERF acknowledges the RAR command by sending a Diameter RAA command to the PCRF. + +When the UE is roaming, the following steps are executed instead of step 10: + +- 10a. The BBERF acknowledges the Gateway Control and QoS Rules Provision request by sending a Diameter RAA to the V-PCRF. +- 10b. The V-PCRF acknowledges the Gateway Control and QoS Rules Provision request by sending a Diameter RAA to the H-PCRF. + +#### 4.5.1.3 PCEF IP-CAN session modification – S2c-based IP flow mobility + +The following signalling flow describes an example of S2c-based IP flow mobility. In this case, the H-PCRF receives an IP flow mobility event by the PCEF and derives QoS rules based on the IP flow mobility routing rules. + +![Sequence diagram for PCEF IP-CAN session modification – S2c-based IP flow mobility. Lifelines: BBERF #1, BBERF #2, PCEF, V-PCRF, H-PCRF. The diagram shows a non-roaming case (steps 1-8) and a roaming case (steps 7a-7e). A legend indicates solid arrows are mandatory and dashed arrows are conditional.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +``` + +sequenceDiagram + participant BBERF1 as BBERF #1 + participant BBERF2 as BBERF #2 + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of BBERF1: 1. Indication of IP flow mobility + PCEF->>H-PCRF: 2. Diameter CCR + H-PCRF->>H-PCRF: 3. Store Information + H-PCRF->>H-PCRF: 4. PCC/QoS Rules decision based on BCM of GW control session and received IP flow mobility routing rules + H-PCRF->>H-PCRF: 5. Store PCC/QoS Rules + H-PCRF->>PCEF: 6. Diameter CCA + H-PCRF->>V-PCRF: 7. Diameter RAR + Note right of V-PCRF: ROAMING CASE + alt Roaming Case: 7a. Diameter RAR (H-PCRF to V-PCRF), 7b. Store PCC/QoS Rules. Policy decision (V-PCRF internal), 7c. Diameter RAA (V-PCRF to H-PCRF), 7d. Diameter RAR (H-PCRF to V-PCRF), 7e. Diameter RAR (V-PCRF to BBERF #2) + Note left of BBERF1: 8. Perform Step 9-10b: as specified in Figure 4.5.1.2.1: PCEF-initiated IP-CAN session modification – Handover. + +``` + +**Legend:** + +- **Mandatory** +- **Conditional** + +Sequence diagram for PCEF IP-CAN session modification – S2c-based IP flow mobility. Lifelines: BBERF #1, BBERF #2, PCEF, V-PCRF, H-PCRF. The diagram shows a non-roaming case (steps 1-8) and a roaming case (steps 7a-7e). A legend indicates solid arrows are mandatory and dashed arrows are conditional. + +**Figure 4.5.1.3.1: PCEF IP-CAN session modification – S2c-based IP flow mobility** + +1. The PCEF receives a message or indication that an IP flow mobility event occurred +2. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the H-PCRF. The PCEF includes the ROUTING\_RULE\_CHANGE event trigger to indicate that a change in the IP flow mobility routing rules has occurred. The PCEF includes in the CCR the Routing-Rule-Install and/or Routing-Rule-Removal AVPs. +3. The H-PCRF stores the information received in the Diameter CCR. +4. The H-PCRF derives PCC rules for the PCEF, and QoS rules for the BBERF(s), based on the BCM mode of the GW control session and the IP flow mobility routing rules as defined in clause 4a.5.7 of 3GPP TS 29.212 [9] +5. The H-PCRF stores the selected PCC/QoS Rules. +6. The H-PCRF acknowledges the IP-CAN session modification request by sending a Diameter CCA to the PCEF. The H-PCRF includes updated PCC rules and event triggers (if applicable). +7. The H-PCRF initiates a Gateway Control and QoS Rules Provision procedure by sending a Diameter RAR. The H-PCRF includes the QoS rules and event triggers. + +When the UE is roaming, the following steps are executed instead of step 7: + +- 7a. The H-PCRF initiates a Gateway Control and QoS Rules Provision procedure to the V-PCRF by sending a Diameter RAR to the V-PCRF. The H-PCRF sends applicable QoS rules based on BCM mode selected as defined in clause 4a.5.9 of 3GPP TS 29.212 [9]. The H-PCRF includes the AN-GW-Address AVP identifying the BBERF involved in the exchange of the IP flows described by the received IP flow mobility routing rules + +- 7b. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. +- 7c. If the V-PCRF denies an authorization, it informs the H-PCRF and may provide the acceptable QoS Information for the service by including in the RAA command the QoS-Rule-Report AVP to indicate the QoS Rules that were not accepted, the Rule-Failure-Code AVP set to UNSUCCESSFUL-QoS-VALIDATION, and the QoS-Information AVP. +- 7d. The H-PCRF may provide new or modified QoS rules to the V-PCRF. +- 7e. The V-PCRF initiates the Gateway Control Session and QoS rules provisions, when applicable, policy decisions and event triggers to BBERF. +- 8 Step 9 through step 10b: as specified in Figure 4.5.1.2.1: PCEF-initiated IP-CAN session modification- Handover are executed, as needed. If the IP flows were moved from one access to another (e.g. 3GPP to WLAN, or vice versa), the PCRF may also initiate a RAR command towards BBERF#1 to modify or release the related resources associated with the flows that were moved to BBERF#2. + +#### 4.5.1.4 Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility + +The following signalling flow describes an example of S2c-based IP flow mobility. In this case, the H-PCRF receives a Gateway Control session establishment by a BBERF and an IP flow mobility event by the PCEF. H-PCRF associates the IP-CAN session to multiple Gateway Control Sessions and derives QoS rules based on the IP flow mobility routing rules. + +![Sequence diagram for Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility. The diagram shows interactions between BBERF #1, BBERF #2, PCEF, V-PCRF, and H-PCRF. Step 1: Gateway Control Session Establishment for BBERF #2. Step 2: Indication of IP flow mobility from PCEF to H-PCRF. Step 3: Diameter CCR from H-PCRF to V-PCRF. Step 4: Store Information at V-PCRF. Step 5: PCC/QoS Rules decision at V-PCRF. Step 6: PCEF-initiated IP-CAN session modification.](5860ad6bd2a2dd8d1ab12864b8f90f37_img.jpg) + +``` + +sequenceDiagram + participant BBERF1 as BBERF #1 + participant BBERF2 as BBERF #2 + participant PCEF + participant V-PCRF + participant H-PCRF + + Note over BBERF1, BBERF2: 1. Perform Step 1-10: as specified in Figure 4.4.1.1: Gateway Control Session Establishment. + Note over PCEF: 2. Indication of IP flow mobility + PCEF->>H-PCRF: 3. Diameter CCR + Note over H-PCRF: 4. Store Information. + Note over H-PCRF: 5. PCC/QoS Rules decision based on BCM of GW control session and received IP flow mobility routing rules + Note over PCEF: 6. Perform Step 5-8: as specified in Figure 4.5.1.x.1: PCEF-initiated IP-CAN session modification – IP Flow mobility. + +``` + +**Legend:** + + *Mandatory* + +Sequence diagram for Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility. The diagram shows interactions between BBERF #1, BBERF #2, PCEF, V-PCRF, and H-PCRF. Step 1: Gateway Control Session Establishment for BBERF #2. Step 2: Indication of IP flow mobility from PCEF to H-PCRF. Step 3: Diameter CCR from H-PCRF to V-PCRF. Step 4: Store Information at V-PCRF. Step 5: PCC/QoS Rules decision at V-PCRF. Step 6: PCEF-initiated IP-CAN session modification. + +**Figure 4.5.1.4.1: Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility** + +1. Step 1 through step 10: as specified in Figure 4.4.1.1: Gateway Control Session Establishment are executed, as needed. The Gateway Control Session is established for BBERF #2. The Gateway Control Session for BBERF #1 was previously established. + +NOTE: If the Gateway Control Session is established for WLAN access, only case 2a is possible. + +2. The PCEF receives a message or indication that an IP flow mobility event occurred. +3. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the H-PCRF. The PCEF includes the ROUTING\_RULE\_CHANGE event trigger to indicate that a change in the IP flow mobility routing rules has occurred. The PCEF includes in the CCR the Routing-Rule-Install and/or Routing-Rule-Removal AVPs. +4. The H-PCRF stores the information received in the Diameter CCR. +5. The H-PCRF does not differentiate between primary and non-primary BBFs. H-PCRF derives PCC rules for the PCEF, and QoS rules for the BBERF(s), based on the BCM mode of the GW control session and the IP flow mobility routing rules as defined in clause 4a.5.7 of 3GPP TS 29.212 [9] +6. Step 5 through step 8: as specified in Figure 4.5.1.3.1: PCEF-initiated IP-CAN session modification- IP Flow mobility are executed, as needed. + +### 4.5.2 Visited access case + +#### 4.5.2.1 New Gateway Control Session Establishment + +The following signalling flow describes an example of a new BBERF initiating a GW control session establishment associated with an existing IP-CAN session. + +![Sequence diagram illustrating Gateway Control Session Establishment during BBERF relocation. The diagram shows interactions between Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with the Source BBERF sending an 'Establish Gateway Control Session Request' to the Target BBERF. The Target BBERF then sends a 'Diameter CCR' to the V-PCRF. The V-PCRF performs internal steps: 'Store Information and identify visited access' and 'Identify multiple BBERF(s). Derive and Store QoS Rules. Policy decision'. It then sends a 'Diameter CCR' to the H-PCRF. The H-PCRF performs 'Store Information, PCC Rules decision and store'. The V-PCRF then sends 'Diameter CCA' (step 7) and 'Diameter CCA' (step 8b) to the Target BBERF. The Target BBERF performs 'Install QoS Rules. Policy enforcement' and finally sends an 'Establish Gateway Control Session Response' back to the Source BBERF. A vertical label 'ROAMING CASE (Visited access)' is present on the left side of the diagram.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant Source BBERF + participant Target BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of Source BBERF: ROAMING CASE (Visited access) + + Source BBERF->>Target BBERF: 1. Establish Gateway Control Session Request + Target BBERF->>V-PCRF: 2. Diameter CCR + Note right of V-PCRF: 3. Store Information and identify visited access + Note right of V-PCRF: 4. Identify multiple BBERF(s). Derive and Store QoS Rules. Policy decision + V-PCRF->>H-PCRF: 5. Diameter CCR + Note right of H-PCRF: 6. Store Information, PCC Rules decision and store + H-PCRF-->>V-PCRF: 7. Diameter CCA + Note right of V-PCRF: 8. Store PCC/QoS Rules. Policy decision + V-PCRF->>H-PCRF: 8a. Diameter CCR + H-PCRF-->>V-PCRF: 8b. Diameter CCA + V-PCRF->>Target BBERF: 9. Diameter CCA + Note right of Target BBERF: 10. Install QoS Rules. Policy enforcement + Target BBERF->>Source BBERF: 11. Establish Gateway Control Session Response + +``` + +Sequence diagram illustrating Gateway Control Session Establishment during BBERF relocation. The diagram shows interactions between Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with the Source BBERF sending an 'Establish Gateway Control Session Request' to the Target BBERF. The Target BBERF then sends a 'Diameter CCR' to the V-PCRF. The V-PCRF performs internal steps: 'Store Information and identify visited access' and 'Identify multiple BBERF(s). Derive and Store QoS Rules. Policy decision'. It then sends a 'Diameter CCR' to the H-PCRF. The H-PCRF performs 'Store Information, PCC Rules decision and store'. The V-PCRF then sends 'Diameter CCA' (step 7) and 'Diameter CCA' (step 8b) to the Target BBERF. The Target BBERF performs 'Install QoS Rules. Policy enforcement' and finally sends an 'Establish Gateway Control Session Response' back to the Source BBERF. A vertical label 'ROAMING CASE (Visited access)' is present on the left side of the diagram. + +**Figure 4.5.2.1.1: Gateway Control Session Establishment during BBERF relocation** + +1. The target BBERF receives a message or indication to establish a Gateway Control Session. +2. The target BBERF initiates a Gateway Control Session with the V-PCRF by sending a CCR using the CC-Request-Type AVP set to the value INITIAL\_REQUEST to the V-PCRF. The target BBERF provides information as detailed in clause 4a.5.1 of 3GPP TS 29.212 [9]. +3. The V-PCRF stores the information received in the Diameter CCR and determines based on the UE identity information that the request is for a roaming user. The V-PCRF checks whether the V-PCRF is required to send the request to the H-PCRF based on the roaming agreements. The V-PCRF does not send the CCR to the H-PCRF to update the S9 session immediately if the Session-Linking-Indicator AVP was received indicating that the session linking has to be deferred. +4. If the Session-Linking-Indicator AVP was received indicating that the session linking has to be deferred, the linking between the Gateway Control Session and the Gx session shall be deferred. Otherwise, based on the information received the V-PCRF identifies multiple BBERF sessions for a particular IP-CAN session. The V-PCRF derives applicable QoS rules according to local policies and stores them. + +For case 2a or if either the AN\_GW\_CHANGE or the IP-CAN\_CHANGE event is subscribed by H-PCRF and this event trigger is received steps 5~8 are executed. Otherwise steps 5~8 are skipped. + +5. The V-PCRF initiates an IP-CAN Session Modification procedure by sending a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2. +6. The H-PCRF stores the information received in the Diameter CCR. And the H-PCRF decides PCC rules for the BBERF and stores PCC rules. +7. The H-PCRF sends a Diameter CCA to the V-PCRF to provide the PCC rules. The H-PCRF sends applicable PCC rules. The H-PCRF includes the AN-GW-Address AVP if the PCC rules are applicable only for a single BBERF. If the PCC rules are applicable for all BBERF sessions this AVP is omitted. +8. If the steps 5~7 are executed, the V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. + +Steps 8a and 8b are executed if the V-PCRF denies authorisation for one or more PCC rules. + +- 8a. If V-PCRF denies authorization, it informs the H-PCRF by sending a CCR command including the Charging-Rule-Report AVP to indicate the PCC Rules that were not accepted, the Rule-Failure-Code AVP set to UNSUCCESSFUL-QoS-VALIDATION, and the acceptable QoS Information for the service. +- 8b. The H-PCRF may provide new modified PCC rules to the V-PCRF. +9. The V-PCRF acknowledges the Gateway Control Session and provisions policy decisions and event triggers to the target BBERF. +10. The BBERF installs the received QoS rules. +11. The target BBERF responds to the Gateway control session establishment request in step 1. + +#### 4.5.2.2 PCEF-Initiated IP-CAN session modification-Handover + +The following signalling flow describe the case when an indication of handover is received by the PCEF and the H-PCRF derives QoS rules based on the type of BBERF (primary/non-primary) + +![Sequence diagram for PCEF-initiated IP-CAN session modification – Handover. The diagram shows interactions between Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with an indication of handover from Source BBERF to PCEF. PCEF sends a Diameter CCR to V-PCRF. V-PCRF stores information, identifies multiple BBERF(s), and derives primary/non-primary BBERF(s). V-PCRF sends a Diameter CCR to H-PCRF. H-PCRF stores information, makes a PCC Rules decision, and stores it. H-PCRF sends a Diameter CCA to V-PCRF. V-PCRF stores PCC/QoS Rules and makes a policy decision. V-PCRF sends a Diameter CCR to H-PCRF. H-PCRF sends a Diameter CCA to V-PCRF. V-PCRF sends a Diameter CCA to PCEF. PCEF sends a Diameter RAR to Target BBERF. Target BBERF installs QoS Rules and policy enforcement. Target BBERF sends a Diameter RAA to V-PCRF. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A vertical label on the left indicates 'ROAMING CASE (Visited access)'.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +sequenceDiagram + participant Source BBERF + participant Target BBERF + participant PCEF + participant V-PCRF + participant H-PCRF + + Note left of Source BBERF: ROAMING CASE (Visited access) + + Source BBERF->>PCEF: 1. Indication of handover + PCEF->>V-PCRF: 2. Diameter CCR + Note right of V-PCRF: 3. Store Information + Note right of V-PCRF: 4. Identify multiple BBERF(s) + Note right of V-PCRF: 5. Derive primary/non-primary BBERF(s) + V-PCRF-->>H-PCRF: 6. Diameter CCR + Note right of H-PCRF: 7. Store Information + Note right of H-PCRF: 8. PCC Rules decision and store + H-PCRF-->>V-PCRF: 9. Diameter CCA + Note right of V-PCRF: 10. Store PCC/QoS Rules. Policy decision + V-PCRF-->>H-PCRF: 10a. Diameter CCR + H-PCRF-->>V-PCRF: 10b. Diameter CCA + V-PCRF->>PCEF: 11. Diameter CCA + PCEF->>Target BBERF: 12. Diameter RAR + Note right of Target BBERF: 13. Install QoS Rules Policy enforcement + Target BBERF->>V-PCRF: 14. Diameter RAA + + Note right of H-PCRF: Legend: + Note right of H-PCRF: Mandatory (solid arrow) + Note right of H-PCRF: Conditional (dashed arrow) + +``` + +Sequence diagram for PCEF-initiated IP-CAN session modification – Handover. The diagram shows interactions between Source BBERF, Target BBERF, PCEF, V-PCRF, and H-PCRF. The process starts with an indication of handover from Source BBERF to PCEF. PCEF sends a Diameter CCR to V-PCRF. V-PCRF stores information, identifies multiple BBERF(s), and derives primary/non-primary BBERF(s). V-PCRF sends a Diameter CCR to H-PCRF. H-PCRF stores information, makes a PCC Rules decision, and stores it. H-PCRF sends a Diameter CCA to V-PCRF. V-PCRF stores PCC/QoS Rules and makes a policy decision. V-PCRF sends a Diameter CCR to H-PCRF. H-PCRF sends a Diameter CCA to V-PCRF. V-PCRF sends a Diameter CCA to PCEF. PCEF sends a Diameter RAR to Target BBERF. Target BBERF installs QoS Rules and policy enforcement. Target BBERF sends a Diameter RAA to V-PCRF. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A vertical label on the left indicates 'ROAMING CASE (Visited access)'. + +**Figure 4.5.2.2.1: PCEF-initiated IP-CAN session modification – Handover** + +1. The PCEF receives a message or indication that a handover occurred. +2. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the V-PCRF. The PCEF includes the AN\_GW\_CHANGE event trigger, and if applicable the IP-CAN\_CHANGE event trigger as well, to indicate that handover has occurred. +3. The V-PCRF stores the information received in the Diameter CCR. +4. If there is a pending Gateway Control Session to be linked to a Gx session, the V-PCRF links Gateway Control Session with the Gx session according to clause 4a.5.6 of 3GPP TS 29.212 [9]. Otherwise based on the information received the V-PCRF identifies multiple BBERF sessions for a particular IP-CAN session. +5. Based on the information received the V-PCRF reclassifies primary/non-primary BBERFs according to the procedures defined in clause 4a.5.7 of 3GPP TS 29.212 [9]. + +If either the AN\_GW\_CHANGE or the IP-CAN\_CHANGE event is subscribed by H-PCRF and this event trigger is received steps 6~9 are executed. Otherwise steps 6~9 are skipped. + +6. The V-PCRF initiates an IP-CAN Session Modification procedure by sending a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2. +7. The H-PCRF stores the information received in the Diameter CCR. +8. The H-PCRF decides PCC rules for the PCEF and stores PCC rules. +9. The H-PCRF sends a Diameter CCA to the V-PCRF to provide the PCC Rules. The H-PCRF sends applicable PCC rules. The H-PCRF includes the AN-GW-Address AVP if the PCC rules are applicable only for a single BBERF. If the PCC rules are applicable for all BBERF sessions this AVP is omitted. +10. If the steps 6~9 are executed, the V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. + +Steps 10a and 10b are executed if the V-PCRF denies authorisation for one or more PCC rules. + +- 10a. If V-PCRF denies authorization, it informs the H-PCRF by sending a CCR command including the Charging-Rule-Report AVP to indicate the PCC Rules that were not accepted, the Rule-Failure-Code AVP set to UNSUCCESSFUL-QoS-VALIDATION, and the acceptable QoS Information for the service. +- 10b. The H-PCRF may provide new modified PCC rules to the V-PCRF. +11. The V-PCRF acknowledges the IP-CAN session modification request by sending a Diameter CCA to the PCEF. The V-PCRF includes updated PCC rules and event triggers (if applicable) +12. The V-PCRF initiates the Gateway Control Session and QoS rules provisions by sending a Diameter RAR to the BBERF policy decisions and event triggers to the target BBERF. +13. The BBERF installs the received QoS Rules. +14. The BBERF acknowledges the Gateway Control and QoS Rules Provision request by sending a Diameter RAA to the V-PCRF. + +#### 4.5.2.3 PCEF-Initiated IP-CAN session modification - S2c-based IP flow mobility + +The following signalling flow describes an example of S2c-based IP flow mobility. In this case, the H-PCRF receives an IP flow mobility event by the PCEF and derives QoS rules based on the IP flow mobility routing rules. + +![Sequence diagram for PCEF-initiated IP-CAN session modification – S2c-based IP flow mobility. The diagram shows interactions between BBERF #1, BBERF #2, PCEF, V-PCRF, and H-PCRF. The process starts with an indication of IP flow mobility from BBERFs to PCEF. PCEF sends a Diameter CCR to V-PCRF. V-PCRF stores information and changes IP flow mobility routing rules. V-PCRF then sends a Diameter CCR to H-PCRF. H-PCRF stores information, makes a PCC rules decision, and stores it. H-PCRF sends a Diameter CCA back to V-PCRF. V-PCRF extracts QoS rules based on PCC rules and IP flow mobility rules. V-PCRF sends Diameter CCR and CCA messages to H-PCRF. Finally, PCEF performs steps 11-14 as specified in Figure 4.5.2.2.1: PCEF-initiated IP-CAN session modification – Handover. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A light blue shaded area on the left is labeled 'ROAMING CASE (Visited access)'.](54a53f959bb7758332532c1cd5f0ad75_img.jpg) + +Sequence diagram for PCEF-initiated IP-CAN session modification – S2c-based IP flow mobility. The diagram shows interactions between BBERF #1, BBERF #2, PCEF, V-PCRF, and H-PCRF. The process starts with an indication of IP flow mobility from BBERFs to PCEF. PCEF sends a Diameter CCR to V-PCRF. V-PCRF stores information and changes IP flow mobility routing rules. V-PCRF then sends a Diameter CCR to H-PCRF. H-PCRF stores information, makes a PCC rules decision, and stores it. H-PCRF sends a Diameter CCA back to V-PCRF. V-PCRF extracts QoS rules based on PCC rules and IP flow mobility rules. V-PCRF sends Diameter CCR and CCA messages to H-PCRF. Finally, PCEF performs steps 11-14 as specified in Figure 4.5.2.2.1: PCEF-initiated IP-CAN session modification – Handover. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A light blue shaded area on the left is labeled 'ROAMING CASE (Visited access)'. + +**Figure 4.5.2.3.1: PCEF-initiated IP-CAN session modification – S2c-based IP flow mobility** + +1. The PCEF receives a message or indication that a handover occurred. +2. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the V-PCRF. The PCEF includes the ROUTING\_RULE\_CHANGE event trigger to indicate that a change in the IP flow mobility routing rules has occurred. The PCEF includes in the CCR Routing-Rule-Install and/or Routing-Rule-Removal AVPs. +3. The V-PCRF stores the information received in the Diameter CCR. +4. Based on the information received the V-PCRF determines that there is a change in the IP flow routing in the multiple BBERF(s) as described in clause 4a.5.7 of 3GPP TS 29.212 [9]. + +If either the AN\_GW\_CHANGE or the IP-CAN\_CHANGE event is subscribed by H-PCRF and this event trigger is received steps 5~8 are executed. Otherwise steps 5~8 are skipped. + +5. The V-PCRF initiates an IP-CAN Session Modification procedure by sending a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2. +6. The H-PCRF stores the information received in the Diameter CCR. +7. The H-PCRF decides PCC rules for the PCEF and stores PCC rules. Based on the IP flow mobility routing rule as defined in clause 4a.5.7 of 3GPP TS 29.212 [9] +8. The H-PCRF sends a Diameter CCA to the V-PCRF to provide the PCC Rules. The H-PCRF sends applicable PCC rules. +9. If the steps 5~8 are executed, the V-PCRF establishes QoS Rules based on received IP flow mobility routing rules and enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. + +Steps 9a and 9b are executed if the V-PCRF denies authorisation for one or more PCC rules. + +- 9a. If V-PCRF denies authorization, it informs the H-PCRF by sending a CCR command including the Charging-Rule-Report AVP to indicate the PCC Rules that were not accepted, the Rule-Failure-Code AVP set to UNSUCCESSFUL-QoS-VALIDATION, and the acceptable QoS Information for the service. + - 9b. The H-PCRF may provide new modified PCC rules to the V-PCRF. +10. Step 11 through step 14: as specified in Figure 4.5.2.2.1: PCEF-initiated IP-CAN session modification- Handover are executed, as needed. If the IP flows were moved from one access to another (e.g. 3GPP to WLAN, or vice versa), the PCRF may also initiate a RAR command towards BBERF#1 to modify or release the related resources associated with the flows that were moved to BBERF#2. + +#### 4.5.2.4 Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility + +The following signalling flow describes an example of IP flow mobility. In this case, the V-PCRF receives a Gateway Control session establishment by a BBERF and an IP flow mobility event by the PCEF. V-PCRF associates the IP-CAN session to multiple Gateway Control Sessions and derives QoS rules based on the IP flow mobility routing rules. + +![Sequence diagram for Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility. Lifelines: BBERF #1, BBERF #2, PCEF, V-PCRF, H-PCRF. The diagram shows a 'ROAMING CASE (Visited access)'. Step 1: Gateway Control Session Establishment. Step 2: Indication of IP flow mobility from BBERF #2 to PCEF. Step 3: Diameter CCR from PCEF to V-PCRF. Step 4: Store Information in V-PCRF. Step 5: Evaluate IP flow mobility routing rules in V-PCRF. Step 6: Diameter CCR from V-PCRF to H-PCRF (conditional). Step 7: Store Information in H-PCRF (conditional). Step 8: PCC Rules decision and store in H-PCRF (conditional). Step 9: Diameter CCA from H-PCRF to V-PCRF (conditional). Step 10: PCEF-initiated IP-CAN session modification.](69edc2887e907309499ac95b47ab6905_img.jpg) + +The diagram illustrates the interaction between network elements for S2c-based IP flow mobility. It begins with a common step (1) for Gateway Control Session Establishment. The main sequence starts with an indication of IP flow mobility (2) from BBERF #2 to PCEF. The PCEF then sends a Diameter CCR (3) to the V-PCRF, which stores the information (4) and evaluates routing rules (5). Depending on whether the H-PCRF is subscribed to the event, a conditional sequence of Diameter CCR (6), Store Information (7), PCC Rules decision and store (8), and Diameter CCA (9) occurs between the V-PCRF and H-PCRF. Finally, the PCEF initiates an IP-CAN session modification (10). + +**Legend:** + +- Mandatory**: Solid line with arrow +- Conditional**: Dashed line with arrow + +Sequence diagram for Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility. Lifelines: BBERF #1, BBERF #2, PCEF, V-PCRF, H-PCRF. The diagram shows a 'ROAMING CASE (Visited access)'. Step 1: Gateway Control Session Establishment. Step 2: Indication of IP flow mobility from BBERF #2 to PCEF. Step 3: Diameter CCR from PCEF to V-PCRF. Step 4: Store Information in V-PCRF. Step 5: Evaluate IP flow mobility routing rules in V-PCRF. Step 6: Diameter CCR from V-PCRF to H-PCRF (conditional). Step 7: Store Information in H-PCRF (conditional). Step 8: PCC Rules decision and store in H-PCRF (conditional). Step 9: Diameter CCA from H-PCRF to V-PCRF (conditional). Step 10: PCEF-initiated IP-CAN session modification. + +**Figure 4.5.2.4.1: Gateway Control Session Establishment and PCEF IP-CAN session modification – S2c-based IP flow mobility** + +1. Step 1 through step 10: as specified in Figure 4.4.1.1: Gateway Control Session Establishment are executed, as needed. The Gateway Control Session is established for BBERF #2. The Gateway Control Session for BBERF #1 was previously established. + +NOTE: If the Gateway Control Session is established for WLAN access, only case 2a is possible. + +2. The PCEF receives a message or indication that an IP flow mobility event occurred. +3. The PCEF initiates an IP-CAN Session Modification procedure by sending a CCR using the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the V-PCRF. The PCEF includes the ROUTING\_RULE\_CHANGE event trigger to indicate that a change in the IP flow mobility routing rules has occurred. The PCEF includes in the CCR Routing-Rule-Install and/or Routing-Rule-Removal AVPs. +4. The V-PCRF stores the information received in the Diameter CCR. +5. Based on the received information, the V-PCRF does not differentiate between primary and non-primary BBFs and determines that there are IP flows routed through multiple BBERF(s) as described in clause 4a.5.7 of 3GPP TS 29.212 [9]. + +If either the AN\_GW\_CHANGE or the IP-CAN\_CHANGE event is subscribed by H-PCRF and this event trigger is received steps 6~9 are executed. Otherwise steps 6~9 are skipped. + +6. The V-PCRF initiates an IP-CAN Session Modification procedure by sending a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes in the CCR the information received in step 2. +7. The H-PCRF stores the information received in the Diameter CCR. +8. The H-PCRF decides PCC rules for the PCEF and stores PCC rules. Based on the IP flow mobility routing rule as defined in clause 4a.5.7 of 3GPP TS 29.212 [9]. +9. The H-PCRF sends a Diameter CCA to the V-PCRF to provide the PCC Rules. The H-PCRF sends applicable PCC rules. +10. Step 9 through step 10: as specified in Figure 4.5.2.3.1: PCEF-initiated IP-CAN session modification- IPFlow mobility are executed, as needed. + +## 4.6 Application Detection and Enforcement Procedures + +### 4.6.1 TDF Session Establishment in case of solicited reporting + +In the following procedure, the PCRF is the H-PCRF for the roaming UE with home routed access and the V-PCRF for the roaming UE with visited access. + +As part of the IP-CAN Session Establishment or Modification procedure, in case of solicited application reporting with a TDF, the PCRF initiates a TDF Session Establishment with the selected TDF. The TDF is selected based on data received from the PCEF or a local configuration at the PCRF. + +![Sequence diagram showing TDF Session Establishment in case of solicited reporting. The diagram involves two main entities: TDF and PCRF. The sequence of messages is: 1. PCRF sends a Diameter TSR to TDF. 2. TDF performs '1a. Credit session establishment with the OCS.' 3. TDF sends a Diameter TSA to PCRF.](6324b252294c0f5d4e34dad4a1202075_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant TDF + Note left of TDF: 1a. Credit session establishment with the OCS. + PCRF->>TDF: 1. Diameter TSR + TDF->>PCRF: 2. Diameter TSA +``` + +Sequence diagram showing TDF Session Establishment in case of solicited reporting. The diagram involves two main entities: TDF and PCRF. The sequence of messages is: 1. PCRF sends a Diameter TSR to TDF. 2. TDF performs '1a. Credit session establishment with the OCS.' 3. TDF sends a Diameter TSA to PCRF. + +**Figure 4.6.1.1: TDF Session Establishment in case of solicited reporting** + +1. PCRF initiates a session towards the TDF. The PCRF provisions the applicable ADC Rules for the corresponding TDF session by sending a Diameter TS-Request to the TDF, including user identity information, the UE Ipv4 address and/or UE Ipv6 prefix and, if available, PDN identifier, IP-CAN type, RAT type and additional parameters as defined in clause 4b.5.1.1 of 3GPP TS 29.212 [9]. PCRF may also subscribe to the Event Triggers (e.g. APPLICATION\_START and APPLICATION\_STOP). + +**NOTE:** For PDN type Ipv4v6, in case the UE Ipv4 address is not available in the PCRF, the PCRF initiates the TDF session establishment providing the UE Ipv6 prefix, and will subsequently provide UE Ipv4 address to the TDF using Event-Report-Indication AVP to the TDF. + +- 1a. This step applies to the IP-CAN Session Establishment procedure. If online charging is applicable for the TDF, and at least one ADC rule with charging parameters was activated, then the TDF requests credit information from the OCS over the Gyn interface. If the TDF receives credit re-authorisation triggers from + +the OCS then it requests the PCRF via a TSA message to provision the triggers at the PCEF and/or BBERF. The triggers to be provisioned are specified in the Event-Report-Indication AVP in the TSA message. + +2. The TDF acknowledges the session establishment by sending a Diameter TS-Answer. The TDF may include Event-Report-Indication in the response. + +### 4.6.1A TDF Session Establishment in case of unsolicited reporting + +In the following procedure, the PCRF is the H-PCRF for the roaming UE with home routed access and the V-PCRF for the roaming UE with visited access. + +When the TDF detects for an Ipv4 address or Ipv6 address the first application start, the TDF shall initiate the TDF Session Establishment procedure with the PCRF. + +![Sequence diagram showing TDF Session Establishment in case of unsolicited reporting. The diagram shows two vertical lifelines: TDF on the left and PCRF on the right. A horizontal arrow labeled '1. Diameter CCR' points from the TDF lifeline to the PCRF lifeline. A return horizontal arrow labeled '2. Diameter CCA' points from the PCRF lifeline back to the TDF lifeline.](d980a3f9608055996a07f31788baf827_img.jpg) + +``` + +sequenceDiagram + participant TDF + participant PCRF + Note left of TDF: TDF detects first application start + TDF->>PCRF: 1. Diameter CCR + PCRF-->>TDF: 2. Diameter CCA + +``` + +Sequence diagram showing TDF Session Establishment in case of unsolicited reporting. The diagram shows two vertical lifelines: TDF on the left and PCRF on the right. A horizontal arrow labeled '1. Diameter CCR' points from the TDF lifeline to the PCRF lifeline. A return horizontal arrow labeled '2. Diameter CCA' points from the PCRF lifeline back to the TDF lifeline. + +**Figure 4.6.1A.1: TDF Session Establishment in case of unsolicited reporting** + +1. The TDF initiates a session by sending a CCR to the PCRF using the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The TDF provides the full UE IP address using either Framed-IP-Address AVP or Framed-Ipv6-Prefix AVP and, if available, the PDN identifier. The TDF also includes the TDF-Application-Identifier AVP, the Flow-Information AVP of the detected application when service data flow descriptions are deducible, within the Application-Detection-Information AVP and sets the event trigger value with APPLICATION\_START. If Flow-Information AVP is included, the TDF-Application-Instance-Identifier shall also be included within the Application-Detection-Information AVP in order to allow correlation of APPLICATION\_START. +- 2 The PCRF stores the information and acknowledges the session establishment by sending a CCA. The PCRF may include the Ipv6 prefix within the Framed-Ipv6-Prefix AVP if the established TDF session is Ipv6 address related. + +NOTE 1: The TDF handles each Ipv4 address and Ipv6 prefix within a separate TDF session. + +NOTE 2: In the scenario where the TDF performs initial Application Detection on 5vailable simultaneous traffic flows for the same Ipv6 prefix (i.e. two or more from Ipv6 addresses of the same IP-CAN session) the TDF could not be aware that those flows belong to the same IP-CAN session until a response is received from the PCRF, containing the Ipv6 prefix. This leads to using separate TDF sessions for the Ipv6 addresses for the same IP-CAN session. The TDF reports new application detection information related to that Ipv6 prefix via any of the TDF sessions at a later stage. + +### 4.6.2 TDF Session termination + +In the following procedures, the PCRF is the H-PCRF for the roaming UE with home routed access and the V-PCRF for the roaming UE with visited access. + +This procedure applies in any of the following cases: + +- the corresponding IP-CAN session is terminated; + +- the Ipv4 address of a dual stack IP-CAN session is released and there is an active Ipv4 address related TDF session for the IP-CAN session (only for unsolicited application reporting); +- at any point of time when the PCRF decides that the session with TDF is to be terminated (e.g. subscriber profile changes). + +![Sequence diagram for TDF Session Termination between TDF and PCRF.](f6d72d7c790e7f585532140f3971639a_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant TDF + Note right of TDF: 2. Removal/deactivation of all ADC Rules. + PCRF->>TDF: 1. Diameter RAR + TDF-->>PCRF: 3. Diameter RAA + TDF->>PCRF: 4. Diameter CCR + PCRF-->>TDF: 5. Diameter CCA +``` + +The diagram illustrates the sequence of messages for TDF Session Termination. It starts with the PCRF sending a Diameter RAR (1) to the TDF. The TDF then performs the removal/deactivation of all ADC Rules (2). Following this, the TDF sends a Diameter RAA (3) to acknowledge the RAR. Next, the TDF sends a Diameter CCR (4) to the PCRF, indicating the session termination and reporting resource usage. Finally, the PCRF sends a Diameter CCA (5) to acknowledge the termination. + +Sequence diagram for TDF Session Termination between TDF and PCRF. + +**Figure 4.6.2.1: TDF Session Termination** + +1. The PCRF sends a RAR including the Session-Release-Cause AVP to request that the TDF terminates the TDF session. +2. For the solicited application reporting, the TDF removes/deactivates all the ADC Rules which are applied to the TDF session. +3. The TDF sends a RAA to acknowledge the RAR. +4. The TDF sends a CCR to the PCRF, indicating the TDF Session termination. The TDF requests the termination of the Sd session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. For solicited application reporting, if the usage monitoring is enabled, the TDF informs the PCRF about the resources that have been consumed by the user since the last report in the same request. +5. The PCRF acknowledges the TDF session termination by sending a CCA to the TDF. + +### 4.6.3 TDF Session modification + +#### 4.6.3.1 Application Detection, Reporting and Control Rules Request + +In the following procedure, the PCRF is the H-PCRF for the roaming UE with home routed access and the V-PCRF for the roaming UE with visited access. + +![Sequence diagram for Application Detection, Reporting and Control Rules Request](0236eff05bcb8f3a343ea7933aaa306b_img.jpg) + +``` +sequenceDiagram + participant TDF + participant PCRF + Note left of TDF: 1. Trigger to report the events. + TDF->>PCRF: 2. Diameter CCR + Note right of PCRF: 3. Makes the PCC/QoS/ADC decisions + PCRF->>TDF: 4. Diameter CCA + Note left of TDF: 5. Installation, modification and removal of the ADC Rules. +``` + +The diagram illustrates a sequence of interactions between a TDF (Traffic Detection Function) and a PCRF (PDN Gateway Control Function). The sequence starts with the TDF triggering an event (1). It then sends a Diameter CCR (Credit Control Request) to the PCRF (2). The PCRF makes PCC/QoS/ADC decisions (3) and responds with a Diameter CCA (Credit Control Answer) (4). Finally, the TDF performs the installation, modification, and removal of the ADC Rules (5), which is shown in a dashed box. + +Sequence diagram for Application Detection, Reporting and Control Rules Request + +**Figure 4.6.3.1.1 Application Detection, Reporting and Control Rules Request** + +1. TDF is triggered to report an event(s) (e.g. The TDF detects the start/stop of an application traffic that matches with one or more activated ADC rules that do not contain the Mute-Notification AVP) for a TDF session. For the start of traffic detection, in case the enforcement actions were provided as a part of ADC rules, the TDF enforces corresponding actions for solicited application reporting. +2. The TDF sends a Diameter CCR to the PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report an event. For the start of traffic detection, if PCRF has previously subscribed to the APPLICATION\_START/APPLICATION\_STOP Event-Triggers, the TDF includes TDF-Application-Identifier AVP, the Flow-Information AVP of the detected application when service data flow descriptions are deducible, within the Application-Detection-Information AVP and sets the event trigger value with + +APPLICATION\_START. If Flow-Information AVP is included, the TDF-Application-Instance-Identifier shall also be included within the Application-Detection-Information AVP in order to allow correlation of APPLICATION\_START. For the stop of traffic detection, if PCRF has previously subscribed to the APPLICATION\_START/APPLICATION\_STOP Event-Triggers, the TDF includes TDF-Application-Identifier AVP, the TDF-Application-Instance-Identifier AVP, if provided in the report of the start of application traffic detection within the Application-Detection-Information AVP and sets the event trigger value with APPLICATION\_STOP. For the solicited application reporting, if usage monitoring is enabled and the usage threshold is reached or the PCRF removes the last ADC rule applicable for certain monitoring key or disables usage monitoring or requests usage report, the TDF may inform the PCRF about the corresponding usage that have been consumed by the user since the last report. + +3. The PCRF stores the information, received in the Diameter CCR and makes the PCC/QoS and – in the solicited reporting case – ADC decisions. +4. The PCRF acknowledges to the TDF by sending a Diameter CCA. For the solicited application reporting, the PCRF may provide a new ADC decisions by including the ADC-Rule-Install AVP and/or ADC-Rule-Remove AVP to the TDF within this acknowledge. +5. For the solicited application reporting, the TDF installs, modifies and removes the ADC rules according the new ADC decisions provided in step 4. + +NOTE: If the installation or modification of one or more ADC rules fails, the TDF reports the failure to the PCRF as defined in clause 4b.5.5 of 3GPP TS 29.212 [9]. + +#### 4.6.3.2 Application Detection and Control Rules Provision + +In the following procedure, the PCRF is the H-PCRF for the roaming UE with home routed access and the V-PCRF for the roaming UE with visited access. This procedure is applicable only for the solicited application reporting. + +![Sequence diagram for Application Detection and Control Rules Provision between TDF and PCRF.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +``` +sequenceDiagram + participant TDF + participant PCRF + Note right of PCRF: 1. Trigger to update the ADC decisions. + PCRF->>TDF: 2. Diameter RAR + Note left of TDF: 3. Installation, modification and removal of the ADC Rules. + TDF->>PCRF: 4. Diameter RAA +``` + +The diagram is a sequence diagram illustrating the interaction between a TDF (Traffic Detection Function) and a PCRF (PDN Gateway Control Function). It consists of four numbered steps: 1. A trigger to update the ADC decisions occurs at the PCRF. 2. The PCRF sends a Diameter RAR (Re-Auth-Request) message to the TDF. 3. The TDF performs the installation, modification, and removal of the ADC Rules. 4. The TDF sends a Diameter RAA (Re-Auth-Answer) message back to the PCRF. + +Sequence diagram for Application Detection and Control Rules Provision between TDF and PCRF. + +**Figure 4.6.3.2.1 Application Detection and Control Rules Provision** + +1. The PCRF receives an internal or external trigger (e.g. the subscriber's profile configuration is changed) to update the ADC rule or notify the event occurred at the PCEF/BBERF for a TDF session. +2. The PCRF sends a Diameter RAR to provide a new ADC decision by including the ADC-Rule-Install AVP and/or ADC-Rule-Remove AVP or notify the event occurred at the PCEF/BBERF by including the Event-Report-Indication AVP. + +3. The TDF stores the information, received in the Diameter RAR. The TDF installs, modifies and removes the ADC rules according to the new ADC decisions provided in step 2. +4. The TDF acknowledges to the PCRF by sending a Diameter RAA to inform the PCRF about the outcome of the actions related to the decision(s). + +## 4.7 Spending limits Procedures over Sy reference point + +### 4.7.1 Initial Spending Limit Report Request + +In the following procedure, the signalling flow for the H-PCRF to request the status of the policy counters available at the OCS, and to subscribe to updates of these policy counters by the OCS. If the H-PCRF provides the list of policy counter identifier(s), the OCS returns the policy counter status per policy counter identifier provided by the PCRF. If the H-PCRF does not provide the list of policy counter identifier(s), the OCS returns the policy counter status for all policy counter identifier(s), which are available for this subscriber. + +![Sequence diagram showing the Initial Spending Limit Report Request procedure between H-PCRF and OCS. The H-PCRF sends a Diameter SLR (Step 2) to the OCS, and the OCS responds with a Diameter SLA (Step 3). A box labeled '1. Policy decision depends on spending info' is shown above the SLR message.](0b87abe67b21a93777287649c33e755d_img.jpg) + +``` + +sequenceDiagram + participant H-PCRF + participant OCS + Note left of H-PCRF: 1. Policy decision depends on spending info + H-PCRF->>OCS: 2. Diameter SLR + OCS-->>H-PCRF: 3. Diameter SLA + +``` + +Sequence diagram showing the Initial Spending Limit Report Request procedure between H-PCRF and OCS. The H-PCRF sends a Diameter SLR (Step 2) to the OCS, and the OCS responds with a Diameter SLA (Step 3). A box labeled '1. Policy decision depends on spending info' is shown above the SLR message. + +**Figure 4.7.1: Initial Spending Limit Report Request** + +1. The H-PCRF retrieves subscription information that indicates that policy decisions depend on policy counter(s) held at the OCS and optionally the list of policy counter identifier(s). +2. The H-PCRF sends a Diameter SLR command if no Sy session yet has been established for this subscriber. The Diameter SLR command includes the Subscription-Id AVP (e.g. IMSI) and optionally the list of policy counter identifier(s) within Policy-Counter-Identifier AVPs. The request also includes the SL-Request-Type AVP which set to the value INITIAL\_REQUEST (0). +3. The OCS sends a Diameter SLA command to the PCRF. The Diameter SLA includes a Policy-Counter-Status-Report AVP for each requested policy counter identifier containing the policy counter identifier and the current status value, optionally pending policy counter statuses with the activation times, and Result-Code AVP contains the result of the operation. When no policy counter identifier(s) was provided, the Diameter SLA includes a Policy-Counter-Status-Report AVP for all policy counter identifiers applicable to the subscriber. The OCS stores the H-PCRF's subscription to changes in the status of all policy counter identifiers provided to the H-PCRF in the Diameter SLA. + +### 4.7.2 Intermediate Spending Limit Report Request + +This clause describes the signalling flow for the H-PCRF to request the status of additional policy counters available at the OCS or to remove the request for the status of policy counters available at OCS. If the H-PCRF provides the list of policy counter identifier(s), the OCS returns the policy counter status per policy counter identifier provided by the PCRF. + +![Sequence diagram for Intermediate Spending Limit Report Request](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` +sequenceDiagram + participant H-PCRF + participant OCS + Note left of H-PCRF: 1. Additional or fewer policy counters are determined to be relevant for policy decision + H-PCRF->>OCS: 2. Diameter SLR + OCS-->>H-PCRF: 3. Diameter SLA + Note left of H-PCRF: 4. Policy Decision +``` + +The diagram illustrates the interaction between H-PCRF and OCS for an Intermediate Spending Limit Report Request. It starts with a note on the H-PCRF side indicating that additional or fewer policy counters are determined to be relevant for a policy decision. The H-PCRF then sends a Diameter SLR (Spending Limit Report) message to the OCS. The OCS responds with a Diameter SLA (Spending Limit Answer) message. Finally, a note on the H-PCRF side indicates a policy decision is made. + +Sequence diagram for Intermediate Spending Limit Report Request + +**Figure 4.7.2: Intermediate Spending Limit Report Request** + +1. The H-PCRF decides to modify the list of subscribed policy counters, e.g. PCRF determines that policy decisions depend on additional policy counter identifier(s) held at the OCS or that notifications of policy counter status changes for some policy counters are no longer required. +2. The H-PCRF sends a Diameter SLR command, optionally including the list of policy counter identifier(s) within Policy-Counter-Identifier(s) AVPs. The request also includes the SL-Request-Type AVP which set to the value INTERMEDIATE\_REQUEST (1). +3. The OCS sends the Diameter SLA command to the PCRF including Policy-Counter-Status-Report AVP(s) containing the policy counter identifier, the current status value and optionally pending policy counter statuses with the activation times. Result-Code contains the result of the operation is also included in the response. +4. The PCRF makes the policy decision based on the information provided by the OCS. + +### 4.7.3 Final Spending Limit Report Request + +This clause describes the signalling flow for the H-PCRF to unsubscribe to any future updates of policy counters for a given subscriber by the OCS. It cancels the request for reporting the change of the status of the policy counters available at the OCS. + +![Sequence diagram for Final Spending Limit Report Request](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +``` +sequenceDiagram + participant H-PCRF + participant OCS + Note left of H-PCRF: 1. Decision to unsubscribe to changes in the PolicyCounter-Status + H-PCRF->>OCS: 2. Diameter STR + OCS-->>H-PCRF: 3. Diameter STA +``` + +The diagram illustrates the interaction between H-PCRF and OCS for a Final Spending Limit Report Request. It starts with a note on the H-PCRF side indicating a decision to unsubscribe to changes in the PolicyCounter-Status. The H-PCRF then sends a Diameter STR (Spending Limit Termination Request) message to the OCS. The OCS responds with a Diameter STA (Spending Limit Termination Answer) message. + +Sequence diagram for Final Spending Limit Report Request + +**Figure 4.7.3: Final Spending Limit Report Request** + +1. The PCRF decides that policy decisions for a given user no longer depend on policy counter(s) to which the PCRF has existing subscriptions for status change notification. + +2. The H-PCRF sends the Diameter STR command to the OCS to cancel the notification request from the OCS on policy counter status. The request includes the Termination-Cause which contains the reason why the session was terminated set to "DIAMETER\_LOGOUT". +3. The OCS sends the Diameter STA command to the H-PCRF with Result-Code contains the result of the operation. + +### 4.7.4 Spending Limit Report + +This clause describes the signalling flow for the OCS to notify the changes of the status of a subscribed policy counter(s) available at the OCS for that subscriber. Alternatively, the signalling flow can be re-used by the OCS to provide one or more pending statuses for a subscribed policy counter together with the time that have to be applied. + +![Sequence diagram for Spending Limit Report showing interactions between H-PCRF and OCS.](5e92d9e8e9ce204e405bff2367f88176_img.jpg) + +``` + +sequenceDiagram + participant H-PCRF + participant OCS + Note right of OCS: 1. Policy Counter Status change (e.g. Threshold reached) + OCS->>H-PCRF: 2. Diameter SNR + H-PCRF->>OCS: 3. Diameter SNA + +``` + +The diagram illustrates the signalling flow for the Spending Limit Report. It features two vertical lifelines: H-PCRF on the left and OCS on the right. + 1. A message box on the OCS lifeline indicates the initial event: "1. Policy Counter Status change (e.g. Threshold reached)". + 2. A thick horizontal arrow labeled "2. Diameter SNR" points from the OCS lifeline to the H-PCRF lifeline. + 3. A thick horizontal arrow labeled "3. Diameter SNA" points from the H-PCRF lifeline back to the OCS lifeline. + +Sequence diagram for Spending Limit Report showing interactions between H-PCRF and OCS. + +**Figure 4.7.4: Spending Limit Report** + +1. The OCS detects that status of a policy counter identifier(s) has changed and the PCRF requested notification of changes in the status of a policy counter(s). Alternatively, if the OCS detects a policy counter status will change at a future point in time, the OCS shall be able to instruct the PCRF to apply one or more pending statuses for a requested policy counter. +2. When the status of a specific policy counter changes, or the OCS detects that a policy counter status will change at a future point in time and decides to instruct the PCRF to apply one or more pending statuses for a requested policy counter, the OCS shall determine the Sy sessions impacted by the change (i.e. those Sy sessions that have subscribed to status change notifications for the changed policy counter) and send the Diameter SNR command to the PCRF associated with each affected Sy session including one Policy-Counter-Status-Report AVP. If several counters change status at the same time, the OCS may group the status change notifications into a single Spending Limit Report request to the PCRF by sending multiple Policy-Counter-Status-Report AVPs in the request. + +NOTE: Sy session is per UE. And more than one Sy session will exist when the UE has IP-CAN session connection with more than one PCRF. + +3. The H-PCRF acknowledges the request by sending a Diameter SNA command with a Result-Code AVP set to DIAMETER\_SUCCESS and use the status of the received policy counter(s) as input to its policy decision to apply operator defined actions, e.g. downgrade the QoS. The PCRF shall ignore an unknown policy counter status report for all unknown policy counter identifiers in the SNR from the OCS. + +## 4.8 Call flows for User Plane Congestion Management + +### 4.8.1 General + +The call flows for User Plane Congestion Management (UPCON) over Np reference point are specified as follows: + +- RAN User Plane Congestion Information (RUCI) reporting, in which non-aggregated RUCI reporting and aggregated RUCI reporting are included. + +- Reporting restriction provisioning +- UE mobility between RAN Congestion Awareness Functions (RCAF) +- Removal of UE context + +### 4.8.2 RUCI reporting + +#### 4.8.2.1 Non-aggregated RUCI report procedure + +![Sequence diagram for Non-aggregated RUCI reporting between RCAF and PCRF.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` +sequenceDiagram + participant RCAF + participant PCRF + Note left of RCAF: RUCI reporting + RCAF->>PCRF: 1. Diameter NRR + PCRF-->>RCAF: 2. Diameter NRA +``` + +The diagram shows a sequence of two messages between RCAF and PCRF. RCAF sends a '1. Diameter NRR' message to PCRF, and PCRF responds with a '2. Diameter NRA' message. + +Sequence diagram for Non-aggregated RUCI reporting between RCAF and PCRF. + +**Figure 4.8.2.1.1: Non-aggregated RUCI reporting** + +1. The RCAF sends a diameter NR-Request command to the PCRF, including the user id, PDN ID, the congestion level info and additional parameters as defined in clause 4.4.1.2 of 3GPP TS 29.217 [36]. +2. The PCRF stores the related information and acknowledges the RUCI reporting by sending a Diameter NR-Answer including the PCRF id. + +#### 4.8.2.2 Aggregated RUCI report procedure + +![Sequence diagram for Aggregated RUCI reporting between RCAF and PCRF.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` +sequenceDiagram + participant RCAF + participant PCRF + Note left of RCAF: Aggregated RUCI reporting + RCAF->>PCRF: 1. Diameter ARR + PCRF-->>RCAF: 2. Diameter ARA +``` + +The diagram shows a sequence of two messages between RCAF and PCRF. RCAF sends a '1. Diameter ARR' message to PCRF, and PCRF responds with a '2. Diameter ARA' message. + +Sequence diagram for Aggregated RUCI reporting between RCAF and PCRF. + +**Figure 4.8.2.2.1: Aggregated RUCI reporting** + +1. The RCAF sends a Diameter AR-Request command to the PCRF, including one or more Aggregated-RUCI-Report AVP and additional parameters as defined in clause 4.4.1.3 of 3GPP TS 29.217 [36]. The PCRF is the common destination PCRF for a set of user id and PDN ID and identified by the PCRF id returned in the previous non-aggregating RUCI reporting. +2. The PCRF stores the related information and acknowledges the RUCI reporting by sending a Diameter AR-Answer back to the RCAF. + +### 4.8.3 Np reporting restriction provisioning + +The Np reporting restriction provisioning is used by the PCRF to stop RUCI reporting for a specific user id and PDN ID. It is also used by the PCRF to specify, modify or disable restrictions for RUCI reporting. + +![Sequence diagram for Np reporting restriction provisioning between RCAF and PCRF.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +``` +sequenceDiagram + participant RCAF + participant PCRF + Note right of PCRF: 1. Diameter MUR + PCRF->>RCAF: 1. Diameter MUR + Note left of RCAF: 2. Diameter MUA + RCAF->>PCRF: 2. Diameter MUA +``` + +The diagram shows a sequence of two messages between RCAF and PCRF. The PCRF sends a '1. Diameter MUR' message to the RCAF, and the RCAF responds with a '2. Diameter MUA' message to the PCRF. + +Sequence diagram for Np reporting restriction provisioning between RCAF and PCRF. + +**Figure 4.8.3.1: Np reporting restriction provisioning** + +1. The PCRF sends a Diameter MUR command to the RCAF for the provisioning of RUCI reporting restriction including the parameters as defined in clause 4.4.2 of 3GPP TS 29.217 [36]. +2. The RCAF responds a Diameter MUA command to the PCRF including the parameters as defined in clause 4.4.2 of 3GPP TS 29.217 [36]. + +### 4.8.4 UE mobility between RCAFs + +This signalling flow describes the mobility handling of a UE from one RCAF to another RCAF. The UE is affected by congestion for both RCAFs. + +![Sequence diagram for UE mobility from RCAF1 to RCAF2.](5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg) + +``` +sequenceDiagram + participant RCAF1 + participant RCAF2 + participant PCRF + Note right of RCAF1: 1. Diameter NRR + RCAF1->>PCRF: 1. Diameter NRR + Note left of RCAF1: 2. Diameter NRA + PCRF->>RCAF1: 2. Diameter NRA + Note right of RCAF1: ... + Note left of RCAF2: ... + Note right of PCRF: ... + Note left of RCAF2: UE moves to RCAF2 + Note right of RCAF2: 3. Diameter NRR + RCAF2->>PCRF: 3. Diameter NRR + Note left of RCAF2: 4. Diameter NRA + PCRF->>RCAF2: 4. Diameter NRA + Note right of RCAF2: 5. Removal of UE context in RCAF1 + RCAF2->>RCAF1: 5. Removal of UE context in RCAF1 +``` + +The diagram illustrates the signalling flow for UE mobility from RCAF1 to RCAF2. It starts with RCAF1 sending a '1. Diameter NRR' to the PCRF and receiving a '2. Diameter NRA' in response. After a period of time (indicated by dots), the UE moves to RCAF2. RCAF2 then sends a '3. Diameter NRR' to the PCRF and receives a '4. Diameter NRA'. Finally, RCAF2 sends a '5. Removal of UE context in RCAF1' message to RCAF1. + +Sequence diagram for UE mobility from RCAF1 to RCAF2. + +**Figure 4.8.4.1: UE mobility from RCAF1 to RCAF2 (the UE is affected by congestion at RCAF2 after the UE was earlier affected by congestion at RCAF1)** + +1. The UE is located in the RCAF1 which is affected by congestion. The RCAF1 sends a Diameter NRR command to the PCRF for reporting RUCI including the parameters as defined in clause 4.4.1.2 of 3GPP TS 29.217 [36]. +2. The PCRF stores the identity of RCAF1 for the given UE and responds a Diameter NRA command to the RCAF1 including the parameters as defined in clause 4.4.1.2 of 3GPP TS 29.217 [36]. +3. The UE moves to the RCAF2 which is also affected by congestion. The RCAF2 sends a Diameter NRR command to the PCRF for reporting RUCI of the same UE including the parameters as defined in clause 4.4.1.2 of 3GPP TS 29.217 [36]. +4. The PCRF stores the identity of RCAF2 for the given UE and responds a Diameter NRA command to the RCAF2 including the parameters as defined in clause 4.4.1.2 of 3GPP TS 29.217 [36]. +5. The PCRF initiates a removal of the UE context to RCAF1 to release the context of the given user id and PDN ID, including the parameters as defined in clause 4.4.4 of 3GPP TS 29.217 [36]. + +### 4.8.5 Removal of UE context + +This signalling flow describes the removal of a UE context from the RCAF. + +![Sequence diagram showing UE context removal in RCAF. The diagram consists of two vertical lifelines labeled RCAF and PCRF. A horizontal arrow labeled '1. Diameter MUR' points from the PCRF lifeline to the RCAF lifeline. A horizontal arrow labeled '2. Diameter MUA' points from the RCAF lifeline to the PCRF lifeline.](1b5a812c8aa20fd5cba28e97001d32de_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant RCAF + Note right of PCRF: 1. Diameter MUR + PCRF->>RCAF: 1. Diameter MUR + Note left of RCAF: 2. Diameter MUA + RCAF->>PCRF: 2. Diameter MUA +``` + +Sequence diagram showing UE context removal in RCAF. The diagram consists of two vertical lifelines labeled RCAF and PCRF. A horizontal arrow labeled '1. Diameter MUR' points from the PCRF lifeline to the RCAF lifeline. A horizontal arrow labeled '2. Diameter MUA' points from the RCAF lifeline to the PCRF lifeline. + +**Figure 4.8.5.1: UE context removal in RCAF** + +1. The PCRF sends a Diameter MUR command to the RCAF to release the context of the given user id and PDN ID, including the parameters as defined in clause 4.4.4 of 3GPP TS 29.217 [36]. +2. The RCAF responds with a Diameter MUA command to the PCRF including the parameters as defined in clause 4.4.4 of 3GPP TS 29.217 [36]. The RCAF releases the context corresponding to the given user id and PDN ID, including any reporting restriction. + +## 4.9 Traffic Steering Control Procedures over St reference point + +### 4.9.1 St Session Establishment + +In the following procedure, the PCRF initiates the St session establishment procedure and provides the traffic steering control information to the TSSF due to the PCRF determines that the traffic steering control is needed for the IP-CAN session. + +![Sequence diagram for St Session Establishment between PCRF and TSSF.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant TSSF + Note right of PCRF: 1. Diameter TSR + PCRF->>TSSF: 1. Diameter TSR + Note left of TSSF: 2. Diameter TSA + TSSF->>PCRF: 2. Diameter TSA +``` + +A sequence diagram illustrating the St Session Establishment between a PCRF and a TSSF. The PCRF sends a '1. Diameter TSR' message to the TSSF, and the TSSF responds with a '2. Diameter TSA' message. + +Sequence diagram for St Session Establishment between PCRF and TSSF. + +**Figure 4.9.1.1: St Session Establishment** + +1. The PCRF initiates session between the PCRF and TSSF and provisions the applicable ADC Rules for the corresponding IP-CAN session by sending a Diameter TSR to the TSSF, including the Request-Type AVP set to the value "0" and other parameters as defined in subclause 4c.4.1 of 3GPP TS 29.212 [9]. +2. The TSSF installs and/or activates the ADC rules and acknowledges to the PCRF by sending a Diameter TSA command. + +### 4.9.2 St Session Modification + +In the following procedure, the PCRF updates the traffic steering control information at the TSSF due to the PCRF determines that the traffic steering control information needs to be updated for the IP-CAN session (e.g. Subscription is changed) or notifies the TSSF that the IPv4 address is allocated/released. + +![Sequence diagram for St Session Modification between PCRF and TSSF.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant TSSF + Note right of PCRF: 1. Diameter TSR + PCRF->>TSSF: 1. Diameter TSR + Note left of TSSF: 2. Diameter TSA + TSSF->>PCRF: 2. Diameter TSA +``` + +A sequence diagram illustrating the St Session Modification between a PCRF and a TSSF. The PCRF sends a '1. Diameter TSR' message to the TSSF, and the TSSF responds with a '2. Diameter TSA' message. + +Sequence diagram for St Session Modification between PCRF and TSSF. + +**Figure 4.9.2.1: St Session Modification** + +1. The PCRF provisions the new, updated and/or requests to remove ADC rules for the corresponding IP-CAN session or notifies the TSSF that the IPv4 address is allocated/released by sending a Diameter TSR command to the TSSF, including the Request-Type AVP set to the value "1" and other parameters as defined in subclause 4c.4.1 or 4c.4.4 of 3GPP TS 29.212 [9]. +2. The TSSF installs, modifies and/or removes the ADC rules or activates and/or deactivates the ADC rules and acknowledges to the PCRF by sending a Diameter TSA commands. + +### 4.9.3 St Session Termination + +In the following procedure, the the PCRF initiates the St session termination procedure and removes all the traffic steering control information to the TSSF due to the corresponding IP-CAN session is terminated or the H-PCRF determines that the traffic steering control information is not needed for the IP-CAN session any longer (e.g. Subscription has changed). + +![Sequence diagram for St Session Termination](a83ba9e3e2c1e21dd69953a7b09e45b4_img.jpg) + +``` +sequenceDiagram + participant PCRF + participant TSSF + Note right of TSSF: 2. Removes/deactivates all the ADC rules + PCRF->>TSSF: 1. Diameter STR + TSSF->>PCRF: 3. Diameter STA +``` + +The diagram illustrates the St Session Termination procedure. It features two vertical lifelines: PCRF on the left and TSSF on the right. The sequence of messages is as follows: 1. A 'Diameter STR' message is sent from the PCRF to the TSSF. 2. Upon receiving the STR, the TSSF performs an internal action labeled 'Removes/deactivates all the ADC rules'. 3. Finally, a 'Diameter STA' message is sent from the TSSF back to the PCRF to acknowledge the termination. + +Sequence diagram for St Session Termination + +**Figure 4.9.3.1: St Session Termination** + +1. The PCRF sends an STR to the TSSF to terminate the session between the PCRF and the TSSF. +2. The TSSF removes/deactivates all the ADC Rules which are applied to the session. +3. The TSSF sends an STA to acknowledge the STR. + +### 4.9.4 St notification initiated by the TSSF + +In the following procedure, the TSSF reports the ADC rule error when the ADC rule can't be enforced any longer. + +![Sequence diagram for St notification initiated by the TSSF](f57a881fcbcaf494a7dedc4f61224991_img.jpg) + +``` +sequenceDiagram + participant TSSF + participant PCRF + TSSF->>PCRF: 1. Diameter TNR + PCRF->>TSSF: 2. Diameter TNA +``` + +The diagram illustrates the St notification initiated by the TSSF. It features two vertical lifelines: TSSF on the left and PCRF on the right. The sequence of messages is as follows: 1. A 'Diameter TNR' message is sent from the TSSF to the PCRF. 2. Upon receiving the TNR, the PCRF responds with a 'Diameter TNA' message back to the TSSF. + +Sequence diagram for St notification initiated by the TSSF + +**Figure 4.9.4.1: St notification initiated by the TSSF** + +1. The TSSF reports the ADC rules error by sending a Diameter TNR command to the PCRF as defined in subclause 4c.4.3 of 3GPP TS 29.212 [9]. +2. The PCRF acknowledges to the TSSF by sending a Diameter TNA command. + +## 4.10 Negotiation for future background data transfer procedure over Nt reference point + +The following procedure shows the signaling flow for the SCEF to request the transfer policy for future background data transfer determined by the H-PCRF. + +![Sequence diagram showing the negotiation for future background data transfer over the Nt reference point between H-PCRF and SCEF.](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant H-PCRF + Note left of H-PCRF: 2.H-PCRF determines the transfer policies + SCEF->>H-PCRF: 1. Diameter BTR + H-PCRF->>SCEF: 3. Diameter BTA + SCEF-->>H-PCRF: 4. Diameter BTR + H-PCRF-->>SCEF: 5. Diameter BTA +``` + +The diagram illustrates a sequence of five messages between the SCEF and the H-PCRF. The SCEF sends a Diameter BTR command (1) to the H-PCRF. The H-PCRF then determines the transfer policies (2). The H-PCRF sends a Diameter BTA command (3) to the SCEF. The SCEF sends a Diameter BTR command (4) to the H-PCRF. The H-PCRF sends a Diameter BTA command (5) to the SCEF. The messages 4 and 5 are shown as dashed arrows. + +Sequence diagram showing the negotiation for future background data transfer over the Nt reference point between H-PCRF and SCEF. + +**Figure 4.10.1: Negotiation for future background data transfer** + +1. Based on the SCS/AS request, the SCEF sends a Diameter BTR command to the H-PCRF for the request of transfer policy including the parameters as defined in subclause 4.4.1 of 3GPP TS 29.154 [56]. +2. The H-PCRF determines one or more transfer policies based on the information received from the SCEF and other available information (e.g. network policy, existing transfer policies). +3. The H-PCRF sends a Diameter BTA command to the SCEF including the parameters as defined in subclause 4.4.1 of 3GPP TS 29.154 [56]. +4. If there is more than one transfer policy provided from the H-PCRF to the SCEF in the BTA command, when the SCEF receives the selected transfer policy from the SCS/AS, the SCEF sends a Diameter BTR command to the H-PCRF with the selected transfer policy. +5. The H-PCRF acknowledges the BTR command by sending BTA command. + +# 5 Binding Mechanism + +## 5.1 Overview + +The binding mechanism associates the session information with the IP-CAN bearer that is intended to carry the service data flow. + +For PCC rules with application identifier, and for certain IP-CAN types, up-link traffic can be received on other/additional IP-CAN bearers than the one determined by the binding mechanism (further details provided in clause 6.2.2.2 and the IP-CAN specific annexes of 3GPP TS 23.203 [2]). + +The binding mechanism includes three steps as defined in 3GPP TS 23.203 [2]: + +1. Session binding. +2. PCC Rule authorization and QoS Rule generation. +3. Bearer binding. + +The Session Binding function receives the Session Information and determines the relevant IP-CAN session. With this information the PCC Rule Authorization and QoS Rule generation function runs the policy rules and constructs the PCC rule(s) and if applicable, the QoS rule(s) if the authorization is granted. Finally the Bearer Binding function selects the IP-CAN bearer where the PCC rule(s) or QoS rule(s) should be installed within the IP-CAN session already known. + +PCC Rule Authorization and QoS Rule generation function and Bearer Binding function can take place without Session Binding at certain IP-CAN Session events (e.g. IP-CAN Session Establishment). + +## 5.2 Session Binding + +Session binding is the association of the AF session information to an IP-CAN session. + +When the PCRF accepts an AA-Request from the AF over the Rx interface with service information, the PCRF shall perform session binding and associate the described service IP flows within the AF session information (and therefore the applicable PCC rules) to one and only one existing IP-CAN session. When the PCRF receives an AA-Request from the P-CSCF acting as an AF over the Rx interface for P-CSCF Restoration, the PCRF shall perform session binding and associate the request to the existing IMS PDN connection and perform P-CSCF Restoration for that impacted IMS PDN connection. This association is done comparing the user IP address received via the Rx interface in either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP with the Ipv4 address or Ipv6 prefix received via the Gx interface. The UE Identity if present in the Subscription-Id AVP and the PDN information if available in the Called-Station-Id AVP may also assist on this association. The Domain identity if available in the IP-Domain-Id AVP may also assist on this association, e.g. if other user identity information than the UE IP address is unavailable and the UE IP addresses is not unique for a certain APN. + +NOTE 1: The UE IP address is unique per Domain identity. + +NOTE 2: The IP-Domain-Id AVP is helpful in the following scenario: Within a PLMN, there are several separate IP address domains, with PCEF(s) that allocate Ipv4 IP addresses out of the same private address range to Ues. The same IP address can thus be allocated to Ues served by PCEFs in different address domains. If one PCRF controls several PCEFs in different IP address domains, the UE IP address is thus not sufficient for the session binding. An AF can serve Ues in different IP address domains, either by having direct IP interfaces to those domains, or by having interconnections via NATs in the user plane between PCEFs and the AF. If a NAT is used, the AF obtains the IP address allocated to the UE via application level signalling and supplies it for the session binding as Framed-IP-Address to the PCRF. The AF supplies an IP-Domain-Id value denoting the IP address domain behind the NAT in addition. The AF can derive the appropriate value from the source address (allocated by the NAT) of incoming user plane packets. + +NOTE 3: When the scenario described in NOTE 2 applies and the AF is a P-CSCF it is assumed that the P-CSCF has direct IP interfaces to the different IP address domains and that no NAT is located between P-GW and P-CSCF. How a non-IMS AF obtains the UE private IP address to be provided to the PCRF is out of scope of the present release; it is unspecified how to support applications that use a protocol that does not retain the original UE's private IP address. + +If the Domain identity is not used to assist association, the PCRF will determine that the UE has an IP-CAN session if the IP address (Ipv4 or Ipv6) received over the Rx interface matches the Ipv4 address or Ipv6 prefix received via one or more of the following interfaces: Gx interface and S9 interface, and if the UE identity is used to assist the association, the UE identity received over the Rx interface matches the UE identity received via one or more of the following interfaces: Gx interface and S9 interface. + +If the Domain identity is used to assist association, the PCRF will determine that the UE has an IP-CAN session if the Domain identity received over the Rx interface matches the PCEF Identity received via the Gx interface, and the IP address (Ipv4) received over the Rx interface matches the Ipv4 address received via the Gx interface. + +For the roaming scenario, the Domain identity may be used for session binding when the AF and PCEF are located in same PLMN, i.e. for the home routed case, the Domain identity may be used by the (H-)PCRF for session binding, and for the visited case, Domain identity could be used by the V-PCRF for session binding. + +For an IP-CAN session associated to a dedicated APN for the purpose of offering services to remote UEs via a ProSe UE-to-network relay UE, the PCRF shall use the UE IPv6 prefix alone in the session binding. + +- NOTE 4: In case the UE identity in the IP-CAN and the application level identity for the user are of different kinds, the PCRF needs to maintain, or have access to, the mapping between the identities. Such mapping is not subject to specification within this TS. +- NOTE 5: An IPv6 address provided over Rx matches an IPv6 prefix provided over Gx or S9 if the IPv6 address belongs to the IPv6 (sub-)network prefix. +- NOTE 6: The PCRF derives the PCEF identity from the Origin-Host AVP of the CCR command received from the PCEF. In order to correlate the PCEF Identity and the domain identity received over the Rx interface, the PCRF uses configured mapping between those identities. The Domain Identity is useful for assistance in session binding if the Origin-Host of the Gx CCR command is not modified by intermediate Diameter proxies deployed between the PCEF and the PCRF. +- NOTE 7: The PCEF identity is not transported over S9 reference point in the present release. So for the visited access with AF located in HPLMN case, session binding assisted with Domain identity is not supported in the present release. Session binding is still possible based on other available information in addition to the IP address when provided by the AF, according to the current procedures. + +If the PCRF uses the Called-Station-Id AVP to assist the association, the PCRF shall apply the procedures in Annex I to match APN information. + +As a result from the session binding function, the PCRF identifies what IP-CAN session the current AF session is related with. If the PCRF is not capable of executing the Session Binding, the PCRF shall issue an AA-Answer command to the AF with a negative response. + +## 5.3 PCC Rule Authorization and QoS Rule Generation + +The PCRF shall perform the PCC rule authorization and QoS rule generation when the PCRF receives session information from an AF over Rx interface, when the PCRF receives notification of IP-CAN session events (e.g. establishment, modification) from the PCEF over Gx or S9 interface, when the PCRF receives IP-CAN events from the BBERF over Gxa/Gxc interface, or the PCRF receives a notification from the SPR that calls for a policy decision. The PCRF shall also perform PCC Rule Authorization and QoS Rule generation for dynamic PCC Rules already provisioned to the PCEF and dynamic QoS rules already provisioned to the BBERF due to internal PCRF triggers (e.g. policies are included or modified within PCRF). + +If the PCRF receives any traffic mapping information from the BBF that does not match any service data flow filter, the PCRF shall also perform PCC and/or QoS rule authorization when the UE's subscriber profile allows subscription based authorization. In this case, the PCRF shall treat the received traffic mapping information as if it is service data flow filter information. + +If the PCRF receives from the AF a reference ID together with the AF session information, the PCRF may provide it to the SPR in order to retrieve the corresponding transfer policy. The PCRF shall derive the PCC rules for the background data transfer according to the retrieved transfer policy. + +- NOTE 1: A transfer policy is only valid within its time window. The removal of outdated transfer policies from the SPR is up to implementation. + +If the PCRF receives information from the SPR for the invocation/revocation of a Priority EPS Bearer service (i.e. the MPS EPS Priority is set/removed or the MPS Priority Level changes while the MPS EPS Priority is set), then the PCRF should change the QCI/ARP of the dynamic PCC/QoS rules that have the same QCI/ARP as for the present default EPS bearer with the new QCI/ARP assigned to the default EPS bearer unless those PCC rules contain an indication that they have to be bound to the default EPS bearer. If there are active non-MPS services, the QCI/ARP of the PCC/QoS rules related to the non-MPS services shall also be changed. + +If the PCRF receives a request from the AF for the invocation/revocation of MPS for DTS (i.e., the MPS-Action AVP is set to enabled or to disabled, see 3GPP TS 29.214 [10]), then the PCRF shall behave according to clause 4.5.19.1 of 3GPP TS 29.212 [9]. + +If the PCRF receives information from the SPR that invokes/revokes the IMS Signalling Priority or changes the MPS Priority Level while IMS Signaling Priority is enabled, then the PCRF should + +- change the ARP of the dynamic PCC/QoS rules applicable to the IM CN signalling +- replace the predefined PCC rules applicable to the IM CN signalling by predefined rules that apply when the IMS Signalling Priority is set according to operator policies + +When IMS Signalling Priority is set, the PCRF should keep the ARP assigned to the default EPS bearer higher than the ARP related to the IM CN signalling bearer. + +NOTE 2. IMS Signalling Priority only applies to an APN enabled for IMS. + +The PCRF assigns appropriate QoS parameters (QCI, ARP, GBR, MBR, etc.) to each PCC or QoS rule. The PCRF takes the information received over Rx into account for determining the appropriate QCI/ARP. If the Rx authorization indicates IMS Multimedia Priority Service, then the PCRF shall allow the prioritization of the MPS session according to clauses 4.5.19.1.3 and 4a.5.14.1.3 in 3GPP TS 29.212 [9] for Gx/Gxx respectively. If the Rx authorization indicates Group Communication Service prioritization as described in 3GPP TS 23.468 [34], then the PCRF shall allow the prioritization of the Group Communication session according to clause 4.5.19 in 3GPP TS 29.212 [9]. + +The PCRF authorizes the affected PCC rules and /or QoS rules after successful Session Binding. By the authorization process the PCRF will determine whether the user can have access to the requested services and under what constraints. If so, the PCC rules and QoS rules are created or modified. If the Session Information is not authorized, a negative answer shall be issued to the AF by sending an AA-Answer command. + +The PCRF assigns an appropriate QCI to each PCC or QoS rule. IP-CAN specific restrictions and other information available to the PCRF (e.g. users subscription information, operator policies) shall be taken into account. Each PCC or QoS rule shall receive a QCI that can be supported by the IP-CAN. The PCRF shall ensure consistency between the QoS rules and PCC rules authorized for the same service data flow when QoS rules are derived from corresponding PCC rules. + +If PrioritySharing feature is supported over Rx reference point as described in 3GPP TS 29.214 [10], the PCRF shall apply the priority sharing procedures as described in 3GPP TS 29.212 [9], subclauses 4.5.27 and 4a.5.17, if applicable. + +In roaming scenarios, the V-PCRF may further authorize the rules received from the H-PCRF based on local operator policy. Depending on the local policy, the V-PCRF may change the authorized QoS for the affected rules. If local authorization of the rules fails, the V-PCRF shall issue a negative answer to the H-PCRF. + +## 5.4 Bearer Binding + +The Bearer Binding function is responsible for associating a PCC rule and QoS rule (if applicable) to an IP-CAN bearer within the IP-CAN session. The QoS demand in the rule, as well as the service data flow template, is input to the bearer binding. The selected bearer shall have the same QCI and ARP as the one indicated by the PCC or QoS rule. + +When Rule-Bound-to-Default-Bearer feature is supported as described in 3GPP TS 29.212 [9], the value included within the Default-Bearer-Indication AVP shall be used as input for the bearer binding instead of the QoS demand in the rule. + +NOTE 1: The PCRF provides the appropriate ARP/QCI for both PCC Rules and default bearer QoS so that the PCEF can perform a valid bearer binding. Alternatively, when Rule-Bound-to-Default-Bearer feature is supported, the PCRF can provide the Default-Bearer-Indication AVP within the PCC Rules to indicate that these PCC Rules have to be bound to the default bearer regardless of the provisioned ARP/QCI. + +The Bearer Binding Function (BBF) is located either at the BBERF or at the PCEF. + +The PCRF shall supply the PCC rules to be installed, modified or removed over Gx interface to PCEF. If there are gateway controls sessions associated with the Gx session, the PCRF shall also supply the QoS rules to be installed, modified, or removed over Gxa/Gxc interface to the BBERF. + +When Rule-Bound-to-Default-Bearer feature is supported, the BBF located at the PCEF shall bind to the default bearer the PCC rules that have indicated so. + +For the rules that do not contain an indication that they have to be bound to the default bearer, the BBF shall then check the QoS class identifier and ARP indicated by the rule and bind the rule with an IP-CAN bearer that has the same QoS class identifier and ARP. The BBF shall evaluate whether it is possible to use one of the existing IP-CAN bearers or not and, if applicable, whether to initiate IP-CAN bearer modification or not. If none of the existing bearers are possible to use, the BBF should initiate the establishment of a suitable IP-CAN bearer. The BBF should not bind rules with the PS to CS session continuity indicator to the same bearer as the rules without the PS to CS session continuity indicator. + +NOTE 2: For an IP-CAN, limited to a single IP-CAN bearer per IP-CAN session, the bearer is implicit, so finding the IP-CAN session is sufficient for successful bearer binding. + +NOTE 3: The handling of a rule with MBR>GBR is up to operator policy (e.g. an independent IP-CAN bearer may be maintained for that SDF to prevent unfairness between competing SDFs). + +NOTE 4: The QCI and ARP (including the Priority-Level, Pre-emption-Capability and Pre-emption-Vulnerability) are used for the bearer binding. Depending on operator policy, only the QCI and ARP Priority-Level can be used for bearer binding. In such a case, it is left to operator policy to determine whether different PCC rules with the same QCI and ARP Priority-Level but different Pre-emption-Capability and Pre-emption-Vulnerability can be bound to the same bearer. + +For an IP-CAN, where the BBF gains no information on what IP-CAN bearer the UE selects to send an uplink IP flow on, the binding mechanism shall assume that, for bi-directional service data flows, both downlink and uplink packets travel on the same IP-CAN bearer. + +Whenever the service data flow template, the QoS authorization of a PCC/QoS rule or the negotiated traffic mapping information change, the existing bearer bindings shall be re-evaluated. The re-evaluation may, for a service data flow, require a new binding with another IP-CAN bearer. The BBF should, if the PCRF requests the same change to the ARP/QCI for all PCC/QoS Rules bound to the same bearer, modify the bearer ARP/QCI as requested. + +NOTE 5: A QoS change of the default EPS bearer causes the bearer binding for PCC/QoS rules previously bound to the default EPS bearer to be re-evaluated. + +During PCC/QoS rules enforcement, if packet filters are provided to the UE, the BBF shall provide packet filters with the same content as that in the SDF template filters received over the Gx/Gxx interface from the PCRF within the Flow-Description or the Flow-Information AVP. The representation/format of the packet filters provided by the network to the UE is access-system dependent and may vary between accesses and also may be different from that of the SDF template filter on the Gx/Gxx interface. The PCRF may control the provisioning of packet filters to the UE, i.e. which filters are required to be sent to the UE, as described in 3GPP TS 29.212 [9]. + +If PCC rule(s) with application identifier(s) are the only PCC rule(s) that are bound to a bearer which requires traffic mapping information, the PCEF shall derive traffic mapping information based on implementation specific logic (e.g. traffic mapping information that effectively disallows any useful packet flows in uplink direction as described in clause 15.3.3.4 of 3GPP TS 23.060 [3]) and provides it to the UE. + +NOTE 6: For GPRS and EPS, the state of TFT packet filters, as defined in 3GPP TS 23.060 [3], for an IP-CAN session requires that there is at most one bearer with no TFT packet filter for the uplink direction. + +Requirements specific for each type of IP-CAN are defined in the IP-CAN specific Annex. The Bearer Binding Function may also be located in the PCRF (e.g. as specified in Annex D for GPRS running UE only IP-CAN bearer establishment mode). Selection of the Bearer Binding location shall be based on the Bearer Control Mode selected by the PCRF. + +# --- 6 QoS Parameters Mapping + +## 6.1 Overview + +Several QoS parameters mapping functions are needed during PCC interaction. These functions are located at the AF, PCRF, PCEF and UE. The main purpose of these mapping functions is the conversion of QoS parameters from one format to another. Examples of QoS information are: + +- Parts of a session description language (SDI), e.g. SDP, MPD. +- IP QoS parameters. +- Access specific QoS parameters. + +One QoS mapping function is located at the AF, which maps the application specific information into the appropriate AVPs that are carried over the Rx interface. The AF derives information about the service from the SDI or from other sources. The mapping is application specific. If SDP (IETF RFC 2327 [11]) is used as SDI, the AF should apply the mapping described in clause 6.2. If MPD (3GPP TS 26.247 [30]) is used, the AF may apply the mapping described in Annex X in 3GPP TS 26.247 [30]. For IMS, the mapping rules in clause 6.2 shall be used at the P-CSCF. The AF passes service information to the PCRF over the Rx interface. Subclause 6.2 specifies the QoS parameter mapping functions at the AF applicable for all IMS P-CSCFs regardless of the access technology. + +One QoS mapping function is located at the PCRF, which maps the service information received over the Rx interface into IP QoS parameters (e.g. QCI, GBR, MBR, ARP, ...). This mapping is access independent. Subclause 6.3 specifies the QoS mapping functions at the PCRF applicable for all accesses. + +The other mapping functions located at PCEF, BBERF, and UE are implementation dependent and are not specified within this specification except for GPRS case. + +The PCRF notes and authorizes the IP flows described within this service information by mapping from service information to Authorized IP QoS parameters for transfer to the PCEF/BBERF via the Gx/Gxx interface. Both the PCEF and BBERF will map from the Authorized IP QoS parameters to the access specific QoS parameters. For GPRS, the GGSN acting as PCEF will map from the Authorized IP QoS parameters to the Authorized UMTS QoS parameters. + +The general QoS mapping framework is shown in figure 6.1.1. + +![Figure 6.1.1: Framework for QoS mapping. This diagram illustrates the interaction between the User Equipment (UE), the Application Function (AF), the Policy and Charging Rules Function (PCRF), and the Gateway (GW) for QoS mapping. The UE (3) contains an Application, IP BS Manager, Translation / Mapping function, and Access-Specific BS Manager. The AF (1) contains an SDI Mapping function. The PCRF (2) contains a Policy Engine. The GW contains a PCEF/BBERF block with IP BS Manager, Translation / Mapping function (4), and Access-Specific BS Manager (5). Signalling paths are shown between the Application and AF (AF session signalling, possibly with SDI), between the AF and PCRF (Rx, Service information), between the PCRF and GW (Gx/Gxx, Authz IP QoS parameters), and between the GW and UE (Access-specific QoS parameters). A legend indicates that double-headed arrows represent signalling paths.](627c5195eaae3bc7e34cbc4dbdb6f9a8_img.jpg) + +Figure 6.1.1: Framework for QoS mapping. This diagram illustrates the interaction between the User Equipment (UE), the Application Function (AF), the Policy and Charging Rules Function (PCRF), and the Gateway (GW) for QoS mapping. The UE (3) contains an Application, IP BS Manager, Translation / Mapping function, and Access-Specific BS Manager. The AF (1) contains an SDI Mapping function. The PCRF (2) contains a Policy Engine. The GW contains a PCEF/BBERF block with IP BS Manager, Translation / Mapping function (4), and Access-Specific BS Manager (5). Signalling paths are shown between the Application and AF (AF session signalling, possibly with SDI), between the AF and PCRF (Rx, Service information), between the PCRF and GW (Gx/Gxx, Authz IP QoS parameters), and between the GW and UE (Access-specific QoS parameters). A legend indicates that double-headed arrows represent signalling paths. + +**Figure 6.1.1: Framework for QoS mapping** + +NOTE 1: The AF can derive the Service information from the AF session signalling. + +NOTE 2: Service Information on Rx interface to Authorized IP QoS parameters mapping. + +NOTE 3: For the UE initiated bearer setup, the UE may derive IP QoS parameters, requested Access-Specific QoS parameters mapping and Authorized Access-Specific QoS parameters from the AF session signalling. + +NOTE 4: Authorized IP QoS parameters to Authorized Access-Specific QoS parameters mapping. + +NOTE 5: Access Specific QoS parameters with Authorized Access-Specific QoS parameters comparison. + +### 6.1.1 UE-Initiated IP-CAN bearers + +This clause covers the case where the UE is capable to initiate/modify the IP-CAN bearers sending requests to the PCEF/BBERF. When a UE desires to establish/modify an IP-CAN bearer the following steps are followed: + +1. The AF can map from SDI within the AF session signalling to service information passed to the PCRF over the Rx interface. (see clause 6.2 if SDP is used as SDI). +2. The PCRF shall map from the service information received over the Rx interface to the Authorized IP QoS parameters that shall be passed to the PCEF/BBERF via the Gx/Gxx interface. The mapping is performed for each IP flow. Upon a request from the PCEF/BBERF, the PCRF combines per direction the individual Authorized IP QoS parameters per flow (see clause 6.3). +3. The UE derives access specific QoS parameters, e.g. UMTS QoS parameters, and, if an IP BS manager is present, IP QoS parameters from the AF session signalling in an application specific manner. The IP and access specific QoS parameters should be generated according to application demands. + +For GPRS, the recommendations for conversational (3GPP TS 26.114 [29]) or streaming applications (3GPP TS 26.234 [6]) should also be taken into account when the UE derives the IP and UMTS QoS parameters. If SDP is used as SDI, e.g. for IMS, the UE should apply clause 6.5.1. and should also apply mapping rules for the authorised QoS parameters in clause 6.5.2 to derive the maximum values for the different requested bit rates and traffic classes. In case the UE multiplexes several IP flows onto the same PDP Context, it has to combine their IP and UMTS QoS parameters. If an IP BS manager is present, the Translation/Mapping function maps the IP QoS parameters to the corresponding UMTS QoS parameters. + +4. The PCEF/BBERF shall map from the Authorized IP QoS parameters received from PCRF to the Authorized access specific QoS parameters. + +For GPRS. The GGSN shall map to the Authorized UMTS QoS parameters (see clause 6.4.1.1). + +5. The PCEF/BBERF shall compare the requested access specific QoS parameters against the authorized access specific QoS parameters. + +For GPRS, the GGSN shall compare the UMTS QoS parameters of the PDP context against the Authorized UMTS QoS parameters (see clause 6.4.1.2). + +The mapping that takes place in the UE and the network should be compatible in order to ensure that the PCEF will be able to correctly authorize the session. + +Figure 6.1.1.1 shows the different kind of QoS parameters in the different points of QoS mapping figure. Due to the UE requests, there are bidirectional flows between the UE and the PCRF. + +![Diagram of QoS mapping for UE initiated IP CAN bearers showing interactions between UE, GW, AF, and PCRF.](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +The diagram illustrates the QoS mapping process for UE initiated IP CAN bearers across three main entities: UE (User Equipment), GW (Gateway), and AF (Application Function) / PCRF (PDN Gateway Control and Policy Function). + +- 3) UE:** Contains an **Application**, an **IP BS Manager** (dashed box), a **Translation / Mapping function**, and an **Access-Specific BS Manager**. + - The **Application** sends *AF session signalling, possibly with SDI* to the **AF**. + - There is a bidirectional signalling path between the **Application** and the **IP BS Manager**. + - The **IP BS Manager** sends *Authorized IP QoS parameters* to the **Translation / Mapping function** and receives *IP QoS parameters* from it. + - The **Translation / Mapping function** sends *Authorized Access-Specific QoS parameters* to the **Access-Specific BS Manager** and receives *Access-Specific QoS parameters* from it. +- GW:** Contains a sub-block **PCEF/BBRF** which includes an **IP BS Manager**, a **Translation / Mapping function** (labeled 4), and an **Access-Specific BS Manager** (labeled 5). + - The **IP BS Manager** in the GW sends *IP QoS parameters* to the **PCRF** and receives *Gx/Gxx* and *Authorized IP QoS parameters* from it. + - There is a bidirectional signalling path between the **IP BS Manager** and the **Translation / Mapping function** (4). + - The **Translation / Mapping function** (4) sends *Authorized IP QoS parameters* to the **Access-Specific BS Manager** (5) and receives *Access-Specific QoS parameters* from it. + - The **Access-Specific BS Manager** (5) sends *Access-specific QoS parameters* to the **Access-Specific BS Manager** in the UE and receives *Authorized Access-specific QoS parameters* from it. +- AF:** Contains **1) SDI Mapping function**. It receives *AF session signalling, possibly with SDI* from the UE and sends *Service information* to the **PCRF** via an **Rx** interface. +- PCRF:** Contains **2) Policy Engine**. It receives *Service information* from the **AF** and exchanges *IP QoS parameters* and *Gx/Gxx* / *Authorized IP QoS parameters* with the **GW**. + +**LEGEND:** A dashed box with a double-headed arrow indicates a **Signalling path**. + +Diagram of QoS mapping for UE initiated IP CAN bearers showing interactions between UE, GW, AF, and PCRF. + +Figure 6.1.1.1: QoS mapping for UE initiated IP CAN bearers + +### 6.1.2 Network-Initiated IP-CAN bearers + +When the IP-CAN session supports Network-Initiated bearers, the network sets up IP CAN bearer(s) with a suitable QoS. If the type of IP CAN supports such an indication, the network indicates to the terminal the QoS characteristics of those IP-CAN bearer(s). Therefore the flow of QoS related information will be unidirectional as indicated in the figure 6.1.2.1. + +![Figure 6.1.2.1: QoS mapping for network initiated IP CAN bearers. The diagram shows the flow of QoS parameters from the AF through the PCRF and PCEF/BBERF to the UE. The AF contains an SDI Mapping function (1) and a Policy Engine (2). The PCRF contains the Policy Engine. The PCEF/BBERF contains an IP BS Manager, a Translation/Mapping function (3), and an Access-Specific BS Manager. The UE contains an Application, an IP BS Manager, a Translation/Mapping function, and an Access-Specific BS Manager. Arrows indicate the flow of 'Authorized IP QoS parameters' and 'Authorized Access-Specific QoS parameters'. A legend indicates that dashed boxes represent components 'Only for some IP CAN Types and terminals'.](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +The diagram illustrates the QoS mapping process for network-initiated IP CAN bearers across three main entities: UE, GW, and AF. + +- UE (User Equipment):** Contains an **Application**, a dashed **IP BS Manager**, a dashed **Translation / Mapping function**, and a dashed **Access-Specific BS Manager**. The Application sends *AF session signalling, possibly with SDI* to the AF. The IP BS Manager receives *Authorized IP QoS parameters* from the Translation / Mapping function. The Translation / Mapping function receives *Authorized Access-Specific QoS parameters* from the Access-Specific BS Manager. The Access-Specific BS Manager receives *Authorized Access-specific QoS parameters* from the GW. +- GW (Gateway):** Contains a **PCEF/BBERF** block. Inside PCEF/BBERF, there is an **IP BS Manager**, a **Translation / Mapping function (3)**, and an **Access-Specific BS Manager**. The IP BS Manager receives *Service information* from the PCRF and sends *Authorized IP QoS parameters* to the Translation / Mapping function (3). The Translation / Mapping function (3) sends *Authorized IP QoS parameters* to the IP BS Manager and *Authorized Access-Specific QoS parameters* to the Access-Specific BS Manager. The Access-Specific BS Manager sends *Authorized Access-specific QoS parameters* to the UE. +- AF (Application Function):** Contains **1) SDI Mapping function** and **2) Policy Engine**. The SDI Mapping function sends *Service information* over the **Rx** interface to the PCRF. +- PCRF (PDN Gateway Control Function):** Contains the **2) Policy Engine**. It receives *Service information* from the AF and sends *Authorized IP QoS parameters* over the **Gx/Gxx** interface to the PCEF/BBERF. + +**LEGEND** + +- Signalling path:** Represented by a solid double-headed arrow. +- Only for some IP CAN Types and terminals:** Represented by a dashed box. + +Figure 6.1.2.1: QoS mapping for network initiated IP CAN bearers. The diagram shows the flow of QoS parameters from the AF through the PCRF and PCEF/BBERF to the UE. The AF contains an SDI Mapping function (1) and a Policy Engine (2). The PCRF contains the Policy Engine. The PCEF/BBERF contains an IP BS Manager, a Translation/Mapping function (3), and an Access-Specific BS Manager. The UE contains an Application, an IP BS Manager, a Translation/Mapping function, and an Access-Specific BS Manager. Arrows indicate the flow of 'Authorized IP QoS parameters' and 'Authorized Access-Specific QoS parameters'. A legend indicates that dashed boxes represent components 'Only for some IP CAN Types and terminals'. + +**Figure 6.1.2.1: QoS mapping for network initiated IP CAN bearers** + +1. The AF can map from SDI within the AF session signalling to service information passed to the PCRF over the Rx interface (see subclause 6.2 if SDP is used as SDI). +2. The PCRF shall map from the service information received over the Rx interface to the Authorized IP QoS parameters that shall be passed to the PCEF/BBERF via the Gx/Gxx interface. The mapping is performed for each IP flow. Upon a request from the PCEF/BBERF, the PCRF combines per direction the individual Authorized IP QoS parameters per flow (see subclause 6.3). +3. The PCEF/BBERF shall map from the Authorized IP QoS parameters received from PCRF to the access specific QoS parameters. For GPRS, the GGSN shall map to the UMTS QoS parameters (see clause 6.4.1.1). + +## 6.2 QoS parameter mapping Functions at AF + +The mapping described in this clause is mandatory for the P-CSCF and should also be applied by other AFs, if the SDI is SDP. + +When a session is initiated or modified the P-CSCF shall use the mapping rules in table 6.2.1 for each SDP media component to derive a Media-Component-Description AVP from the SDP Parameters. The mapping shall not apply to media components where the SDP payload is proposing to use a circuit-switched bearer (i.e. "c=" line set to "PSTN" and an "m=" line set to "PSTN", refer to 3GPP TS 24.292 [24]). Circuit-switched bearer related media shall not be included in the service information sent to the PCRF. + +**Table 6.2.1: Rules for derivation of service information within +Media-Component-Description AVP from SDP media component** + +| service information per Media-Component-Description AVP (see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Media-Component-Number | ordinal number of the position of the "m=" line in the SDP | +| AF-Application-Identifier | The AF-Application-Identifier AVP may be supplied or omitted, depending on the application.
For IMS, if the AF-Application-Identifier AVP is supplied, its value should not demand application specific bandwidth or QoS class handling unless the IMS application is capable of handling a QoS downgrading. | +| Media-Type | The Media Type AVP shall be included with the same value as supplied for the media type in the "m=" line. | +| Flow-Status | 
 IF port in m-line = 0 THEN   Flow-Status:= REMOVED; ELSE   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN (NOTE 9)     Flow-Status := ENABLED;   ELSE /* UDP or RTP/AVP transport     IF a=rtcp-mux is negotiated THEN       Flow-Status :=ENABLED; (NOTE 12 and 13)     ELSE       IF a=recvonly THEN         IF <SDP direction> = UE originated (NOTE 8) THEN           Flow-Status := ENABLED_DOWNLINK; (NOTE 4)         ELSE /* UE terminated (NOTE 8) */           Flow-Status := ENABLED_UPLINK; (NOTE 4)         ENDIF;       ELSE         IF a=sendonly THEN           IF <SDP direction> = UE originated (NOTE 8) THEN             Flow-Status := ENABLED_UPLINK; (NOTE 4)           ELSE /* UE terminated (NOTE 8) */             Flow-Status := ENABLED_DOWNLINK; (NOTE 4)           ENDIF;         ELSE           IF a=inactive THEN             Flow-Status :=DISABLED;           ELSE /* a=sendrecv or no direction attribute */             Flow-Status := ENABLED (NOTE 4)           ENDIF;         ENDIF;       ENDIF;     ENDIF;   ENDIF; ENDIF; (NOTE 5)
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max-Requested-Bandwidth-UL | 
 IF <SDP direction> = UE terminated (NOTE 8) THEN   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN     (NOTE 9)     IF a=recvonly or a=sendrecv or no direction attribute THEN       IF b=AS:<bandwidth> is present and         ( b=TIAS:<Tibandwidth> is not           present or is present but not supported ) THEN         Max-Requested-Bandwidth-UL:= <bandwidth> * 1000; /* Unit bit/s       ELSE         IF b=TIAS:<Tibandwidth> is present and supported THEN           Max-Requested-Bandwidth-UL:= <Transport-dependent bandwidth>           (NOTE 11) /* Unit bit/s         ELSE           Max-Requested-Bandwidth-UL:= <Operator specific setting>;         ENDIF;       ENDIF;     ELSE       Max-Requested-Bandwidth-UL:= <Operator specific setting>,       (NOTE 10)     ENDIF;   ELSE /* UDP or RTP/AVP transport     IF b=AS:<bandwidth> is present and       ( b=TIAS:<Tibandwidth> is not         present or is present but not supported ) THEN       IF a=rtcp-mux is negotiated (NOTE 13) THEN         IF b=RR:<rrbandwidth> is present           OR b=RS:<rsbandwidth> is present THEN           Max-Requested-Bandwidth-UL:= <bandwidth> * 1000 +           <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)         ELSE           Max-Requested-Bandwidth-UL:= <bandwidth> * 1050;           /* Unit is bit/s         ENDIF       ELSE         Max-Requested-Bandwidth-UL:= <bandwidth> * 1000;         /* Unit is bit/s       ENDIF;     ELSE       IF b=TIAS:<Tibandwidth> is present and supported THEN         IF a=rtcp-mux is negotiated (NOTE 13) THEN           IF b=RR:<rrbandwidth> is present             OR b=RS:<rsbandwidth> is present THEN             Max-Requested-Bandwidth-UL:=             <Transport-dependent bandwidth> (NOTE 11) +             <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)           ELSE             Max-Requested-Bandwidth-UL:=             <Transport-dependent bandwidth>             * 1.05 (NOTE 11) /* Unit bit/s           ENDIF         ELSE           Max-Requested-Bandwidth-UL:= <Transport-dependent bandwidth>           (NOTE 11) /* Unit bit/s         ENDIF;       ELSE         Max-Requested-Bandwidth-UL:= <Operator specific setting>,         or AVP not supplied;       ENDIF;     ENDIF;   ENDIF ELSE   Consider SDP in opposite direction ENDIF
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max-Requested-Bandwidth-DL
(NOTE 17) | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN     (NOTE 9)     IF a=recvonly or a=sendrecv or no direction attribute THEN       IF b=AS:<bandwidth> is present and         ( b=TIAS:<Tibandwidth> is not present or           is present but not supported ) THEN         Max-Requested-Bandwidth-DL:= <bandwidth> * 1000; /* Unit bit/s       ELSE         IF b=TIAS:<Tibandwidth> is present and supported THEN           Max-Requested-Bandwidth-DL:= <Transport-dependant bandwidth>           /* Unit bit/s (see NOTE 11)         OR Operator specific setting       ELSE         Max-Requested-Bandwidth-DL:= <Operator specific setting>;       ENDIF;     ELSE       Max-Requested-Bandwidth-DL:= <Operator specific setting>,       (NOTE 10)     ENDIF;   ELSE /* UDP or RTP/AVP transport     IF b=AS:<bandwidth> is present and b=TIAS:<Tibandwidth> is not       present THEN       IF a=rtcp-mux is negotiated(NOTE 13) THEN         IF b=RR:<rrbandwidth> is present           OR b=RS:<rsbandwidth> is present THEN           Max-Requested-Bandwidth-DL:= <bandwidth> * 1000 +           <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)         ELSE           Max-Requested-Bandwidth-DL:= <bandwidth> * 1050;           /* Unit is bit/s         ENDIF       ELSE         Max-Requested-Bandwidth-DL:= <bandwidth> * 1000         ;/* Unit is bit/s       ENDIF;     ELSE       IF b=TIAS:<Tibandwidth> is present THEN         IF a=rtcp-mux is negotiated (NOTE 13) THEN           IF b=RR:<rrbandwidth> is present             OR b=RS:<rsbandwidth> is present THEN             Max-Requested-Bandwidth-DL:=             <Transport-dependent bandwidth> (NOTE 11) +             <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)           ELSE             Max-Requested-Bandwidth-DL:=             <Transport-dependent bandwidth>             * 1.05 (NOTE 11) /* Unit bit/s           ENDIF         ELSE           Max-Requested-Bandwidth-DL:= <Transport-dependent bandwidth>           (NOTE 11) /* Unit bit/s         ENDIF;       ELSE         Max-Requested-Bandwidth-DL:= <Operator specific setting>,         or AVP not supplied;       ENDIF;     ENDIF;   ENDIF   ELSE     Consider SDP in opposite direction   ENDIF
| +| Max-Supported-Bandwidth-UL
(NOTE 18) | 
 IF a=bw-info is present and includes MaxSupBw: <bandwidth> and direction: recv (UE terminated) or send (UE originated) or sendrecv (NOTE 14) THEN   Max-Supported-Bandwidth-UL:= [supplied <bandwidth>] * 1000 /Unit bit/s/   (NOTE 16) ELSE /* a=bw-info is not present or is present but MaxSupBw is not   included or direction is the opposite   AVP not supplied ENDIF; (NOTE 15)
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max-Supported-Bandwidth-DL
(NOTE 18) | IF a=bw-info is present and includes MaxSupBw : and direction:
send (UE terminated) or recv (UE originated) or sendrecv (NOTE 14) THEN
Max-Supported-Bandwidth-DL:= [supplied ] * 1000 /Unit bit/s/

(NOTE 16)
ELSE /* a=bw-info is not present or is present but MaxSupBw is not
included or direction is the opposite
AVP not supplied
ENDIF;
(NOTE 15) | +| Min-Desired-Bandwidth-UL
(NOTE 19) | IF a=bw-info is present and includes MinDesBw : and direction:
recv (UE terminated) or send (UE originated) or sendrecv (NOTE 14) THEN
Min-Desired-Bandwidth-UL:= supplied * 1000 /Unit bit/s/

(NOTE 16)
ELSE /* a=bw-info is not present or is present but MinDesBw is not
included or direction is the opposite
AVP not supplied
ENDIF; | +| Min-Desired-Bandwidth-DL
(NOTE 19) | IF a=bw-info is present and includes MinDesBw : and direction:
send (UE terminated) or recv (UE originated) or sendrecv (NOTE 14) THEN
Min-Desired-Bandwidth-DL:= [supplied ] * 1000 /Unit bit/s/

(NOTE 16)
ELSE /* a=bw-info is not present or is present but MinDesBw is not
included or direction is the opposite
AVP not supplied
ENDIF; | +| RR-Bandwidth | IF b=RR: is present THEN
RR-Bandwidth:= ;
ELSE
AVP not supplied
ENDIF;
(NOTE 3; NOTE 6) | +| RS-Bandwidth | IF b=RS: is present THEN
RS-Bandwidth:= ;
ELSE
AVP not supplied
ENDIF;
(NOTE 3, NOTE 6) | + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Media-Sub-Component | Supply one AVP for bidirectional combination of two corresponding IP flows, if available, and for each single IP flow without a corresponding IP flow in opposite direction.
If a media component comprises separate IP flows for RTP and RTCP, they are described in two separate Media-Sub-Component AVPs. However, if a=rtcp-mux is negotiated, RTP and RTCP use the same IP flow and shall be described in a single Media-Sub-Component AVP.
The encoding of the AVP is described in Table 6.2.2 | +| Reservation-Priority | The AF may supply or omit this AVP. | +| Codec-Data | Codec Data AVP(s) are provisioned as specified in clause 5.3.16 of 3GPP TS 29.214 [10], including the codec-related information detailed in clause 5.3.7 of 3GPP TS 29.214 [10]. | +| Max-PLR-DL | 
 IF a= PLR adapt line is NOT present in both SDP OFFER and ANSWER THEN   /* As UE don't support CHEM feature, AF should not use packet loss rates      in either the uplink or downlink direction */   Max-PLR-DL AVP not supplied ELSE   IF P-CSCF serving the OFFERER THEN     FOR each RTP payload type of the same media line       IF MAXimum-e2e-PLR line is present in the SDP OFFER THEN         IF maxUL-PLR is present in the SDP ANSWER           Max-PLR-DL = value of maxe2e-PLR in the SDP OFFER - maxUL-PLR                            in the SDP ANSWER         ELSE /* maxUL-PLR is not present in the SDP ANSWER */           Max-PLR-DL = the default value is ½ maxe2e-PLR value present                            in the SDP OFFER         ELSE /* MAXimum-e2e-PLR line is not present in the SDP OFFER */           IF maxUL-PLR is present in the SDP ANSWER THEN             Max-PLR-DL = (the default value is end-to-end Maximum                              End-to-End Packet Loss Rate for the decoder of                              the RTP payload type as recommended in 3GPP                              TS 26.114 [29] clause X.1.2 for application                              layer redundancy or X.1.1 for partial redundancy)                              - maxUL-PLR in the SDP ANSWER           ELSE /* maxUL-PLR is not present in the SDP ANSWER */             Max-PLR-DL = the default value is ½ end-to-end Maximum End-to-End                              Packet Loss Rate for the decoder of the RTP payload                              type as recommended in 3GPP TS 26.114 [29]                              clause X.1.2 for application layer redundancy                              or X.1.1 for partial redundancy           ENDIF;         ENDIF;       END FOR LOOP of each RTP payload type of the same media       Max-PLR-DL = maximum value of Max-PLR-DL among all the RTP payload                    types     ELSE /* For P-CSCF serving the ANSWERER */       FOR each RTP payload type of the same media line         IF MAXimum-e2e-PLR line is present in the SDP ANSWER THEN           IF maxDL-PLR is present in the SDP ANSWER             Max-PLR-DL = value of maxDL-PLR in the SDP ANSWER           ELSE /* maxDL-PLR is not present in the SDP ANSWER */             Max-PLR-DL = the default value is ½ maxe2e-PLR value present                              in the SDP ANSWER           ELSE /* MAXimum-e2e-PLR line is not present in the SDP ANSWER */             Max-PLR-DL = the default value is ½ end-to-end Maximum End-to-End                              Packet Loss Rate for the decoder of the RTP payload                              type as recommended in 3GPP TS 26.114 [29]                              clause X.1.2 for application layer redundancy                              or X.1.1 for partial redundancy           ENDIF;         END FOR LOOP of each RTP payload type of the same media         Max-PLR-DL = maximum value of Max-PLR-DL among all the RTP payload                    types       ENDIF;     ENDIF;   ENDIF; ENDIF;
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max-PLR-UL | 
 IF a= PLR_adapt line is NOT present in both SDP OFFER and ANSWER THEN   /* As UE don't support CHEM feature, AF should not use packet loss rates      in either the uplink or downlink direction */   Max-PLR-UL AVP not supplied ELSE   IF P-CSCF serving the OFFERER THEN     FOR each RTP payload type of the same media line       IF MAXimum-e2e-PLR line is present in the SDP ANSWER THEN         IF maxDL-PLR is present in the SDP ANSWER           Max-PLR-UL = value of maxe2e-PLR in the SDP ANSWER - maxDL-PLR           in the SDP ANSWER         ELSE /* maxDL-PLR is not present in the SDP ANSWER */           Max-PLR-UL = the default value is ½ maxe2e-PLR value present           in the SDP ANSWER         ELSE /* MAXimum-e2e-PLR line is not present in the SDP ANSWER */           Max-PLR-UL = the default value is ½ end-to-end Maximum End-to-End           Packet Loss Rate for the decoder of the RTP payload           type as recommended in 3GPP TS 26.114 [29]           clause X.1.2 for Application layer redundancy           or X.1.1 for partial redundancy         ENDIF;       END FOR LOOP of each RTP payload type of the same media       Max-PLR-UL = maximum value of Max-PLR-UL among all the RTP payload       types     ELSE /* For P-CSCF serving the ANSWERER */       FOR each RTP payload type of the same media line         IF MAXimum-e2e-PLR line is present in the SDP OFFER THEN           IF maxUL-PLR is present in the SDP ANSWER             Max-PLR-UL = value of maxUL-PLR in the SDP ANSWER           ELSE /* maxUL-PLR is not present in the SDP ANSWER */             Max-PLR-UL = the default value is ½ maxe2e-PLR value present             in the SDP OFFER           ELSE /* MAXimum-e2e-PLR line is not present in the SDP OFFER */             Max-PLR-UL = the default value is ½ end-to-end Maximum End-to-End             Packet Loss Rate for the decoder of the RTP payload             type as recommended in 3GPP TS 26.114 [29]             clause X.1.2 for Application layer redundancy             or X.1.1 for partial redundancy           ENDIF;         END FOR LOOP of each RTP payload type of the same media         Max-PLR-UL = maximum value of Max-PLR-UL among all the RTP payload         types       ENDIF;     ENDIF;   ENDIF; ENDIF;
| +| Desired-Max-Latency | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF a=3gpp-qos-hint is present and includes a qos-hint-property that   indicates "latency"     IF qos-hint-split-value for "local" is not present       Desired-Max-Latency = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present       Desired-Max-Latency = <qos-hint-split-value>     ENDIF   ELSE     AVP not supplied   ENDIF ELSE /* <SDP direction> = UE terminated (NOTE 8)/   IF a=3gpp-qos-hint is present and includes a qos-hint-property that   indicates "latency"     IF qos-hint-split-value for "local" is not present       Desired-Max-Latency = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       Desired-Max-Latency = <qos-hint-end-to-end-value> - <qos-hint-split- value>     ENDIF   ELSE     AVP not supplied   ENDIF ENDIF
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|---------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Desired-Max-Loss | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "loss"     IF qos-hint-split-value for "local" is not present       Desired-Max-Loss = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       Desired-Max-Loss = <qos-hint-split-value>     ENDIF   ELSE     AVP not supplied   ENDIF ELSE /* <SDP direction> = UE terminated (NOTE 8)/   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "loss"     IF qos-hint-split-value for "local" is not present       Desired-Max-Loss = < qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       Desired-Max-Loss = <qos-hint-end-to-end-value> - <qos-hint-split- value>     ENDIF   ELSE     AVP not supplied   ENDIF ENDIF
| + +| service information per
Media-Component-
Description AVP
(see notes 1 and 7) | Derivation from SDP Parameters
(see Note 2) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| NOTE 1: The encoding of the service information is defined in 3GPP TS 29.214 [10].
NOTE 2: The SDP parameters are described in IETF RFC 2327 [11].
NOTE 3: The "b=RS:" and "b=RR:" SDP bandwidth modifiers are defined in IETF RFC 3556 [13].
NOTE 4: As an operator policy to disable forward and/or backward early media, for media with UDP as transport protocol only the Flow-Status AVP may be downgraded by using the gate control procedures defined in the annex A of 3GPP TS 29.214 [10] before a SIP confirmed dialogue is established, i.e. until a 200 (OK) response to an INVITE request is received.
NOTE 5: If the SDP answer is available when the session information is derived, the direction attributes and port number from the SDP answer shall be used to derive the flow status. However, to enable interoperability with SIP clients that do not understand the inactive SDP attribute, if "a=inactive" was supplied in the SDP offer, this shall be used to derive the flow status. If the SDP answer is not available when the session information is derived, the direction attributes from the SDP offer shall be used.
NOTE 6: Information from the SDP answer is applicable, if available.
NOTE 7: The AVPs may be omitted if they have been supplied in previous service information and have not changed, as detailed in 3GPP TS 29.214 [10].
NOTE 8: "Uplink SDP" indicates that the SDP was received from the UE and sent to the network. This is equivalent to = UE originated.
"Downlink SDP" indicates that the SDP was received from the network and sent to the UE. This is equivalent to = UE terminated.
NOTE 9: Support for TCP at a P-CSCF acting as AF is only required if services with TCP transport are used in the corresponding IMS system.
As an operator policy to disable forward and/or backward early media, for media with TCP as transport protocol, the Max-Requested-Bandwidth-UL/DL values may be downgraded before a SIP confirmed dialogue is established, i.e. until a 200 (OK) response to an INVITE request is received. Only a small bandwidth in both directions is required in this case in order for TCP control packets to flow.
NOTE 10: TCP uses IP flows in the directionality opposite to the transferred media for feedback. To enable these flows, a small bandwidth in this direction is required.
NOTE 11: TIAS is defined in IETF RFC 3890 [23]. IETF RFC 3890 clause 6.4 provides procedures for converting TIAS to transport-dependant values. This procedure relies on the presence of maxprate (also defined in IETF RFC 3890).
NOTE 12: Multiplexed RTP/RTCP flows need to have Flow-Status set to "ENABLED" in order to always permit the RTCP traffic.
NOTE 13: RTP/RTCP multiplexing is defined in IETF RFC 5761 [39].
NOTE 14: This AVP is derived from the SDP answer information and is omitted if E2EQOSMTSI feature is not supported.
NOTE 15: When both "b =" line and "a=bw-info" including MaxSupBw are present when sending the SDP, it is expected that the values are aligned.
NOTE 16: When the supplied bandwidth does not correspond to the bandwidth applicable to the IP version used by the UE, the AF shall re-compute it considering the IP version used by the UE as defined in 3GPP TS 26.114 [29].
NOTE 17: When the Extended-Max-Requested-BW-NR feature is supported and if the bandwidth values are higher than 2^32-1 bps, Extended-Max-Requested-BW-UL/DL shall be derived instead of Max-Requested-Bandwidth-UL/DL. The same derivation procedure shall apply, with the exception that the units for the derived bandwidth shall be kbit per second instead of bit per second.
NOTE 18: When the Extended-BW-E2EQOSMTSI-NR feature is supported and if the bandwidth values are higher than 2^32-1 bps, Extended-Max-Supported-BW-UL/DL shall be derived instead of Max-Supported-Bandwidth-UL/DL. The same derivation procedure shall apply, with the exception that the units for the derived bandwidth shall be kbit per second instead of bit per second.
NOTE 19: When the Extended-BW-E2EQOSMTSI-NR feature is supported and if the bandwidth values are higher than 2^32-1 bps, Extended-Min-Desired-BW-UL/DL shall be derived instead of Min-Desired-Bandwidth-UL/DL. The same derivation procedure shall apply, with the exception that the units for the derived bandwidth shall be kbit per second instead of bit per second. | | + +###### **Table 6.2.2: Rules for derivation of Media-Sub-Component AVP from SDP media component** + +| service information per
Media-Sub-Component
AVP
(see notes 1 and 5) | Derivation from SDP Parameters
(see Note 2) | +|------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow-Number |

The AF shall assign a number to the media-subcomponent AVP that is unique within the surrounding media component AVP and for the entire lifetime of the AF session. The AF shall select the ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing downlink destination port numbers, if downlink destination port numbers are available. For uplink or inactive unicast media IP flows, a downlink destination port number is nevertheless available, if SDP offer-answer according to IETF RFC 3264 is used.

The AF shall select the ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing uplink destination port numbers, if no downlink destination port numbers are available.

| +| Flow-Status | AVP not supplied | +| Max-Requested-Bandwidth-UL | AVP not supplied | +| Max-Requested-Bandwidth-DL | AVP not supplied | + +| | | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow-Description |

For uplink and downlink direction, a Flow-Description AVP shall be provided unless no IP Flows in this direction are described within the media component.

If UDP is used as transport protocol, the SDP direction attribute (NOTE 4) indicates the direction of the media IP flows within the media component as follows:

 IF a=recvonly THEN (NOTE 3)   IF <SDP direction> = UE originated (NOTE 7) THEN     Provide only downlink Flow-Description AVP   ELSE /* UE terminated (NOTE 7) */     Provide only uplink Flow-Description AVP   ENDIF; ELSE   IF a=sendonly THEN (NOTE 3)     IF <SDP direction> = UE originated (NOTE 7) THEN       Provide only uplink Flow-Description AVP     ELSE /* UE terminated (NOTE 7) */       Provide only downlink Flow-Description AVP     ENDIF;   ELSE /* a=sendrecv or a=inactive or no direction attribute */     Provide uplink and downlink Flow-Description AVPs   ENDIF; ENDIF;

However, for RTCP and RTP/RTCP multiplexed IP flows uplink and downlink Flow-Description AVPs shall be provided irrespective of the SDP direction attribute.

If TCP is used as transport protocol (NOTE 8), IP flows in uplink and downlink direction are described in SDP irrespective of the SDP direction attribute, as TCP uses an IP flow for feedback even if contents are transferred only in the opposite direction. Thus, both uplink and downlink Flow-Description AVPs shall be provided.

The uplink destination address shall be copied from the "c=" line of downlink SDP. (NOTE 6) (NOTE 7)

The uplink destination port shall be derived from the "m=" line of downlink SDP. (NOTE 6) (NOTE 7) However, for TCP transport the uplink destination port shall be wildcarded, if the local UE is the passive endpoint (NOTE 9)

The downlink destination address shall be copied from the "c=" line of uplink SDP. (NOTE 6) However, a P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the downlink destination address using those procedures.

The downlink destination port shall be derived from the "m=" line of uplink SDP. (NOTE 6) (NOTE 7) However, for TCP transport the downlink destination port shall be wildcarded, if the local UE is the active endpoint (NOTE 9). A P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the downlink destination port using those procedures.

For IPv6, uplink and downlink source addresses shall either be derived from the prefix of the destination address or be wildcarded by setting to "any", as specified in 3GPP TS 29.214 [10]. However, a P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the uplink source address using those procedures.

If IPv4 is being utilized, the uplink source address shall either be set to the address contained in the "c=" line of the uplink SDP or be wildcarded, and the downlink source address shall either be set to the address contained in the "c=" line of the downlink SDP or be wildcarded. However, for TCP transport, if the local UE is the passive endpoint (NOTE 9), the uplink source address shall not be wildcarded. If the local UE is the active endpoint (NOTE 9), the downlink source address shall not be wildcarded. A P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the uplink source address using those procedures.

Source ports shall not be supplied. However, for TCP transport, if the local UE is the passive end point (NOTE 9), the uplink source port shall be derived from the "m=" line of the uplink SDP. If the local UE is the active end point (NOTE 9), the downlink source port shall be derived from the "m=" line of the downlink SDP. A P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the downlink source ports using those procedures.

Proto shall be derived from the transport of the "m=" line. For "UDP/DTLS/SCTP" as defined in IETF RFC 8864 [69] or "RTP/AVP", proto is 17(UDP). For "TCP", as defined in IETF RFC 4145 [16], or "TCP/MSRP", as defined in IETF RFC 4975 [17], proto is 6(TCP).

| +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| service information per
Media-Sub-Component
AVP
(see notes 1 and 5) | Derivation from SDP Parameters
(see Note 2) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow-Usage | The Flow-Usage AVP shall be supplied with value "RTCP" if the IP flow(s) described in the Media-Sub-Component AVP are used to transport RTCP only. Otherwise the Flow-Usage AVP shall not be supplied. IETF RFC 2327 [11] specifies how RTCP flows are described within SDP. If the IP flows(s) are used to transport signalling the value should be "AF-SIGNALLING". | +| NOTE 1: The encoding of the service information is defined in 3GPP TS 29.214 [10].
NOTE 2: The SDP parameters are described in IETF RFC 2327 [11].
NOTE 3: If the SDP direction attribute for the media component negotiated in a previous offer-answer exchange was sendrecv, or if no direction attribute was provided, and the new SDP direction attribute sendonly or recvonly is negotiated in a subsequent SDP offer-answer exchange, uplink and downlink Flow-Description AVPs shall be supplied.
NOTE 4: If the SDP answer is available when the session information is derived, the direction attributes from the SDP answer shall be used to derive the flow description. However, to enable interoperability with SIP clients that do not understand the inactive SDP attribute, if "a=inactive" was supplied in the SDP offer, this shall be used. If the SDP answer is not available when the session information is derived, the direction attributes from the SDP offer shall be used.
NOTE 5: The AVPs may be omitted if they have been supplied in previous service information and have not changed, as detailed in 3GPP TS 29.214 [10].
NOTE 6: If the session information is derived from an SDP offer, the required SDP may not yet be available. The corresponding Flow Description AVP shall nevertheless be included and the unavailable fields (possibly all) shall be wildcarded.
NOTE 7: "Uplink SDP" indicates that the SDP was received from the UE and sent to the network. This is equivalent to = UE originated.
"Downlink SDP" indicates that the SDP was received from the network and sent to the UE. This is equivalent to = UE terminated.
NOTE 8: Support for TCP at a P-CSCF acting as AF is only required if services with TCP transport are used in the corresponding IMS system.
NOTE 9: For TCP transport, the passive endpoints is derived from the SDP "a=setup" attribute according to the rules in IETF RFC 4145 [16], or, if that attribute is not present, from the rules in IETF RFC 4975 [17]. | | + +## 6.3 QoS parameter mapping Functions at PCRF + +The QoS authorization process consists of the derivation of the parameters Authorized QoS Class Identifier (QCI), Allocation and Retention Priority (ARP), and Authorized Maximum/Guaranteed Data Rate UL/DL. + +When a session is initiated or modified the PCRF shall derive Authorized IP QoS parameters (i.e. QCI, Authorized Maximum/Guaranteed Data Rate DL/UL (if bandwidth values are lower or equal to $2^{32}-1$ bps), Extended Authorized Maximum/Guaranteed Data Rate DL/UL (if bandwidth values are higher than $2^{32}-1$ bps and if the Extended-BW-NR feature is supported), ARP) from the service information. If the selected Bearer Control Mode (BCM) is UE-only this process shall be performed according to the mapping rules in table 6.3.1 to avoid undesired misalignments with the UE QoS parameters mapping. + +In the case of forking, the various forked responses may have different QoS requirements for the IP flows of the same media component. Each Authorized IP QoS Parameter should be set to the highest value requested for the IP flow(s) of that media component by any of the active forked responses. + +**Table 6.3.1: Rules for derivation of the Maximum Authorized Data Rates, Authorized Guaranteed Data Rates and Maximum Authorized QoS Class per IP flow or bidirectional combination of IP flows in the PCRF** + +| Authorized IP QoS
Parameter | Derivation from service information
(see Note 4) | +|----------------------------------------|-------------------------------------------------------------| +|----------------------------------------|-------------------------------------------------------------| + +### **Maximum Authorized Data Rate DL (Max\_DR\_DL) and UL (Max\_DR\_UL) (NOTE 21)** + +``` + +IF operator special policy exists THEN + + Max_DR_UL:= as defined by operator specific algorithm; + Max_DR_DL:= as defined by operator specific algorithm; + +ELSE + + IF AF-Application-Identifier AVP demands application specific data rate + handling THEN + Max_DR_UL:= as defined by application specific algorithm; + Max_DR_DL:= as defined by application specific algorithm; + + ELSE IF Codec-Data AVP provides Codec information for a codec that is + supported by a specific algorithm (NOTE 19,20) THEN + Max_DR_UL:= as defined by specific algorithm; + Max_DR_DL:= as defined by specific algorithm; + + ELSE + IF not RTCP flow(s) according to Flow-Usage AVP THEN + IF Flow-Status = REMOVED THEN + Max_DR_UL:= 0; + Max_DR_DL:= 0; + ELSE + IF uplink Flow Description AVP is supplied THEN + IF Max-Supported-Bandwidth-UL is present and supported THEN + Max_DR_UL:= Max-Supported-Bandwidth-UL; + ELSE IF Max-Requested-Bandwidth-UL is present THEN + Max_DR_UL:= Max-Requested-Bandwidth-UL; + ELSE + Max_DR_UL:= as set by the operator; + ENDIF; + ELSE + Max_DR_UL:= 0; + ENDIF; + + IF downlink Flow Description AVPs is supplied THEN + IF Max-Supported-Bandwidth-DL is present and supported THEN + Max_DR_DL:= Max-Supported-Bandwidth-DL; + ELSE IF Max-Requested-Bandwidth-DL is present THEN + Max_DR_DL:= Max-Requested-Bandwidth-DL; + ELSE + Max_DR_DL:= as set by the operator; + ENDIF; + ELSE + Max_DR_DL:= 0; + ENDIF; + ENDIF; + + ELSE /* RTCP IP flow(s) */ + IF RS-Bandwidth is present and RR-Bandwidth is present THEN + Max_DR_UL:= (RS-Bandwidth + RR-Bandwidth); + Max_DR_DL:= (RS-Bandwidth + RR-Bandwidth); + ELSE + IF Max-Requested-Bandwidth-UL is present THEN + IF RS-Bandwidth is present and RR-Bandwidth is not present THEN + Max_DR_UL:= MAX[0.05 * Max-Requested-Bandwidth-UL,RS-Bandwidth]; + ENDIF; + + IF RS-Bandwidth is not present and RR-Bandwidth is present THEN + Max_DR_UL:= MAX[0.05 * Max-Requested-Bandwidth-UL,RR-Bandwidth]; + ENDIF; + + IF RS-Bandwidth and RR-Bandwidth are not present THEN + Max_DR_UL:= 0.05 * Max-Requested-Bandwidth-UL; + ENDIF; + } + ELSE + Max_DR_UL:= as set by the operator; + ENDIF; + + IF Max-Requested-Bandwidth-DL is present THEN + IF RS-Bandwidth is present and RR-Bandwidth is not present THEN + Max_DR_DL:= MAX[0.05 * Max-Requested-Bandwidth-DL,RS-Bandwidth]; + ENDIF; + + IF RS-Bandwidth is not present and RR-Bandwidth is present THEN + Max_DR_DL:= MAX[0.05 * Max-Requested-Bandwidth-DL,RR-Bandwidth]; + ENDIF; + } + ENDIF; + ENDIF; + ENDIF; +} + +``` + +| Authorized IP QoS
Parameter | Derivation from service information
(see Note 4) | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | 
        IF RS-Bandwidth and RR-Bandwidth are not present THEN             Max_DR_DL:= 0.05 * Max-Requested-Bandwidth-DL;         ENDIF;          ELSE             Max_DR_DL:= as set by the operator;         ENDIF;      ENDIF; ENDIF; ENDIF;  ENDIF;  IF SIP-Forking-Indication AVP indicates SEVERAL DIALOGUES THEN     Max_DR_UL = MAX[Max_DR_UL, previous Max_DR_UL]     Max_DR_DL = MAX[Max_DR_DL, previous Max_DR_DL] ENDIF;
| + +| Authorized IP QoS Parameter | Derivation from service information
(see Note 4) | +|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized Guaranteed Data Rate DL (Gua_DR_DL) and UL (Gua_DR_UL) (see NOTE 11, 13, 15, 16. 21) | 
 IF operator special policy exists THEN   Gua_DR_UL:= as defined by operator specific algorithm;   Gua_DR_DL:= as defined by operator specific algorithm;  ELSE   IF AF-Application-Identifier AVP demands application specific data rate handling THEN     Gua_DR_UL:= as defined by application specific algorithm;     Gua_DR_DL:= as defined by application specific algorithm;    ELSE IF Codec-Data AVP provides Codec information for a codec that is supported by a specific algorithm (NOTE 5,19,20) THEN     Gua_DR_UL:= as defined by specific algorithm;     Gua_DR_DL:= as defined by specific algorithm;    ELSE     IF uplink Flow-Description AVP is supplied THEN       IF Min-Desired-Bandwidth-UL is present and supported THEN         Gua_DR_UL:= Min-Desired-Bandwidth-UL ;       ELSE IF Min-Requested-Bandwidth-UL is present THEN         Gua_DR_UL:= Min-Requested-Bandwidth-UL ;       ELSE         Gua_DR_UL:= as set by the operator;       ENDIF;     ELSE       Gua_DR_UL:= Max DR UL;     ENDIF;      IF downlink Flow-Description AVP is supplied THEN       IF Min-Desired-Bandwidth-DL is present and supported THEN         Gua_DR_DL:= Min-Desired-Bandwidth-DL       ELSE IF Min-Requested-Bandwidth-DL is present THEN         Gua_DR_DL:= Min-Requested-Bandwidth-DL ;       ELSE         Gua_DR_DL:= as set by the operator;       ENDIF;     ELSE       Gua_DR_DL:= Max DR DL;     ENDIF;   ENDIF; ENDIF;  IF SIP-Forking-Indication AVP indicates SEVERAL DIALOGUES THEN   Gua_DR_UL = MAX[Gua_DR_UL, previous Gua_DR_UL]   Gua_DR_DL = MAX[Gua_DR_DL, previous Gua_DR_DL] ENDIF;
| + +| Authorized IP QoS Parameter | Derivation from service information
(see Note 4) | +|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized QoS Class Identifier [QCI]
(see NOTE 1, 2, 7, 12, 14 and 23) | 
 IF an operator special policy exists THEN   QCI:= as defined by operator specific algorithm;  ELSE IF MPS-Identifier AVP demands MPS specific QoS Class handling THEN   QCI:= as defined by MPS specific algorithm (NOTE 18); ELSE IF GCS-Identifier AVP demands Group Communication specific handling THEN   QCI:= as defined by GCS specific algorithm (NOTE 17); ELSE IF AF-Application-Identifier AVP demands application specific QoS Class handling THEN   QCI:= as defined by application specific algorithm;  ELSE IF Codec-Data AVP provides Codec information for a codec that is supported by a specific algorithm THEN   QCI:= as defined by specific algorithm; (NOTE 5)  ELSE IF FLUS-Identifier AVP demands specific QoS Class handling THEN   QCI:= as defined by specific algorithm; (NOTE 22)  ELSE   /* The following QCI derivation is an example of how to obtain the QCI values in a GPRS network */   IF Media-Type is present THEN     /* for GPRS: streaming */     IF (only uplink Flow Description AVPs are supplied for all IP flows of the AF session, which have media type "audio" or "video" and no flow usage "RTCP", or only downlink Flow Description AVPs are supplied for all IP flows of the AF session, which have media type "audio" or "video" and no flow usage "RTCP") THEN       CASE Media-Type OF         "audio":      MaxClassDerivation := 3 OR 4; (NOTE 9)         "video":      MaxClassDerivation := 4       END;        /* for GPRS: conversational */       ELSE         CASE Media-Type OF           "audio":      MaxClassDerivation:= 1 OR 2; (NOTE 6)           "video":      MaxClassDerivation:= 2         END;        ENDIF;        CASE Media-Type OF         "audio":      QCI := MaxClassDerivation         "video":      QCI := MaxClassDerivation         "application": QCI := 1 OR 2; (NOTE 6)         /*e.g. for GPRS: conversational*/         "data":      QCI := 6 OR 7 OR 8; (NOTE 8)         /*e.g. for GPRS: interactive with prio 1, 2 AND 3 respectively*/         "control":  QCI := 6;         /*e.g. for GPRS: interactive with priority 1*/        /* NOTE: include new media types here */        OTHERWISE:  QCI := 9;       /*e.g. for GPRS: background*/        END;     ENDIF;   ENDIF;    IF SIP-Forking-Indication AVP indicates SEVERAL_DIALOGUES THEN     QCI = MAX[QCI, previous QCI] (NOTE 10)   ENDIF ;
| + +| Authorized IP QoS Parameter | Derivation from service information
(see Note 4) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------| +| NOTE 1: The QCI assigned to a RTCP IP flow is the same as for the corresponding RTP media IP flow.
NOTE 2: When audio or video IP flow(s) are removed from a session, the parameter MaxClassDerivation shall keep the originally assigned value.
NOTE 3: When audio or video IP flow(s) are added to a session, the PCRF shall derive the parameter MaxClassDerivation taking into account the already existing media IP flow(s) within the session.
NOTE 4: The encoding of the service information is defined in 3GPP TS 29.214 [10]. Possible Bandwidth information and Flow-Status information provided within the Media-Sub-Component AVP takes precedence over information within the encapsulating Media-Component-Description AVP as specified in 3GPP TS 29.214 [10]. If AVPs are omitted within a Media-Component-Description AVP or Media-Sub-Component AVP of the service information, the corresponding information from previous service information shall be used, as specified in 3GPP TS 29.214 [10].
NOTE 5: 3GPP TS 26.234 [6], 3GPP TS 26.114 [29], 3GPP2 C.S0046 [18], and 3GPP2 C.S0055 [19] contain examples of QoS parameters for codecs of interest. The support of any codec specific algorithm in the PCRF is optional.
NOTE 6: For GPRS, the final QCI value will depend on the value of SSD (speech/unknown) according to 3GPP TS 23.107 [4] and table A.3 of 3GPP TS 23.203 [2]. If the PCRF is not able to determine the SSD, it should use the QCI value 2 that corresponds to SSD unknown. For UE-init and mixed mode, the PCRF may derive from the requested QoS of an IP CAN bearer which SSD is applicable.
NOTE 7: The numeric value of the QCI are based on 3GPP TS 29.212 [9].
NOTE 8: The QCI value also encodes the traffic handling priority for GPRS. If the PCRF is not able to determine a traffic handling priority, it should choose QCI 8 that corresponds to priority 3. Also, for UE-initiated bearers the PCRF should only use QCI 8 in order to have the same mapping rules in both UE and PCRF.
NOTE 9: For GPRS, the final QCI value will depend on the value of SSD (speech/unknown) according to 3GPP TS 23.107 [4] and table A.3 of 3GPP TS 23.203 [2]. If the PCRF is not able to determine the SSD, it should use the QCI value 4 that corresponds to SSD unknown. For UE-init and mixed mode, the PCRF may derive from the requested QoS of an IP CAN bearer which SSD is applicable.
NOTE 10: The Max function shall use the following precedence order for the QCI values: $2 > 1 > 4 > 3 > 5 > 6 > 7 > 8 > 9$
NOTE 11: Authorized Guaranteed Data Rate DL and UL shall not be derived for QCI values 5, 6, 7, 8 and 9.
NOTE 12: Recommended QCI values for standardised QCI characteristics are shown in table 6.1.7 in 3GPP TS 23.203 [2].
NOTE 13: The PCRF may be configured with operator specific preconditions for setting the Authorized Guaranteed Data Rate lower than the corresponding Maximum Authorized Data Rate.
NOTE 14: In a network where SRVCC is enabled, the QCI=1 shall be used for IMS services in accordance to 3GPP TS 23.216 [27]. Non-IMS services using QCI=1 may suffer service interruption and/or inconsistent service experience if SRVCC is triggered. Triggering SRVCC for WebRTC IMS session will cause service interruption and/or inconsistent service experience when using QCI=1. Operator policy (e.g. use of specific AF application identifier) may be used to avoid using QCI 1 for a voice service, e.g. WebRTC IMS session.
NOTE 15: For certain services (e.g. DASH services according to 3GPP TS 26.247 [30]), the AF may also provide a minimum required bandwidth so that the PCRF can derive an Authorized Guaranteed Data Rate lower than the Maximum Authorized Data Rate.
NOTE 16: For GPRS and EPS, the PCRF shall assign an Authorized Guaranteed Data Rate UL/DL value within the limit supported by the serving network.
NOTE 17: The GCS specific algorithm shall consider various inputs, including the received Reservation-Priority AVP, for deriving the QCI.
NOTE 18: The MPS specific algorithm shall consider various inputs, including the received MPS-Identifier AVP and Reservation-Priority AVP, for deriving the QCI.
NOTE 19: When multiple codecs are supported per media stream (e.g. as part of multi-stream multiparty conferencing media handling are negotiated as described in 3GPP TS 26.114 [29]) the codec specific algorithm shall consider the bandwidth related to each codec when calculating the total bandwidth.
NOTE 20: 3GPP TS 26.114 [29] contains examples of how the Authorized Guaranteed Data Rate and Maximum Authorized Data Rate are assumed to be derived for multi-party multimedia conference media handling support. The support of this behaviour is optional.
NOTE 21: For bandwidth values higher than $2^{32}-1$ bps and if the Extended-BW-NR feature is supported over Gx/Gxx interface, Extended-Max_DR_DL/UL and Extended-Gua_DR_DL/UL shall be derived instead of Max_DR_DL/UL and Gua_DR_DL/UL.
NOTE 22: The "live" uplink streaming algorithm may consider various inputs, including the received FLUS-Identifier AVP, Desired-Max-Latency AVP, Desired-Max-Loss AVP, AF-Application-Identifier AVP and Media-Type AVP for deriving the QCI. When Desired-Max-Latency AVP and/or Desired-Max-Loss AVP are present, non-authority QCI mapping may be done according to table 6.1.7-A in 3GPP TS 23.203 [2].
NOTE 23: The algorithm to support applications with specific QoS hints (e.g. loss and/or latency demands) may consider various inputs, including the received Desired-Max-Latency AVP, Desired-Max-Loss AVP and AF-Application-Identifier AVP for deriving the QCI, as shown in table E.0 in 3GPP TS 26.114 [29]. Non-authority QCI mapping may be done according to table 6.1.7-A in 3GPP TS 23.203 [2]. | | + +The PCRF should per ongoing session store the Authorized IP QoS parameters per for each IP flow or bidirectional combination of IP flows (as described within a Media Subcomponent AVP). + +If the PCRF provides a QoS-Information AVP within a Charging-Rule-Definition AVP it may apply the rules in table 6.3.2 to combine the Authorized QoS per IP flow or bidirectional combination of IP flows (as derived according to table 6.3.1) for all IP flows described by the corresponding PCC rule. + +If the PCRF provides a QoS-Information AVP for an entire IP CAN bearer (for a UE-initiated IP-CAN bearer in the GPRS case) or IP CAN session, it may apply the rules in table 6.3.2 to combine the Authorized QoS per IP flow or bidirectional combination of IP flows (as derived according to table 6.3.1) for all IP flows allowed to be transported within the IP CAN bearer or session. It is recommended that the rules in table 6.3.2 are applied for all IP flows with corresponding AF session. The PCRF may increase the authorized QoS further to take into account the requirements of predefined PCC rules without ongoing AF sessions. + +NOTE 1: QoS-Information AVP provided at IP-CAN session level is not derived based on mapping tables, but based on subscription and operator specific policies. + +NOTE 2: Allocation-Retention-Priority AVP is always calculated at PCC rule level according to table 6.3.2. + +For a UE initiated PDP context within GPRS, the PCRF applies the binding mechanism described in clause 5 to decide which flows are allowed to be transported within the IP CAN bearer. + +**Table 6.3.2: Rules for calculating the Maximum Authorized/Guaranteed Data Rates, QCI and ARP in the PCRF** + +| Authorized IP QoS Parameter | Calculation Rule | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL and UL (see NOTE 6) |

Maximum Authorized Data Rate DL/UL is the sum of all Maximum Authorized Data Rate DL/UL for all the IP flows or bidirectional combinations of IP flows (as according to table 6.3.1).

 IF Network = GPRS AND Maximum Authorized Data Rate DL/UL > 256 Mbps THEN   Maximum Authorized Data Rate DL/UL = 256 Mbps /* See 3GPP TS 23.107 [4] */ ENDIF;
| +| Guaranteed Authorized Data Rate DL and UL (see NOTE 3,6) |

Guaranteed Authorized Data Rate DL/UL is the sum of all Guaranteed Authorized Data Rate DL/UL for all the IP flows or bidirectional combinations of IP flows (as according to table 6.3.1).

| +| QCI |

QCI = MAX [needed QoS parameters per IP flow or bidirectional combination of IP flows (as operator's defined criteria) among all the IP flows or bidirectional combinations of IP flows.]

| +| ARP (see NOTE 1) | 
 IF an operator special policy exists THEN   ARP:= as defined by operator specific algorithm;  ELSE IF MPS-Identifier AVP demands MPS specific ARP handling THEN   ARP:= as defined by MPS specific algorithm (NOTE 2); ELSE IF GCS-Identifier AVP demands Group Communication Service specific ARP handling THEN   ARP:= as defined by GCS specific algorithm (NOTE 4); ELSE IF MCPTT-Identifier AVP demands MCPTT specific ARP handling THEN   ARP:= as defined by MCPTT specific algorithm (NOTE 5); ELSE IF MCVideo-Identifier AVP demands MCVideo specific ARP handling THEN   ARP:= as defined by MCVideo specific algorithm (NOTE 7); ELSE IF AF-Application-Identifier AVP demands application specific ARP handling THEN   ARP:= as defined by application specific algorithm; ELSE IF Reservation-Priority AVP demands application specific ARP handling THEN   ARP:= as defined by application specific algorithm; ENDIF;
| +|

NOTE 1: The ARP priority levels 1-8 should only be assigned to resources for services that are authorized to receive prioritized treatment within an operator domain.

NOTE 2: The MPS specific algorithm shall consider various inputs, including the received MPS-Identifier AVP and Reservation-Priority AVP, for deriving the ARP.

NOTE 3: For GPRS and EPS, the PCRF may check that the Guaranteed Authorized Data Rate DL/UL does not exceed the limit supported by the serving network to minimize the risk of rejection of the bearer by the serving network.

NOTE 4: The GCS specific algorithm shall consider various inputs, including the received Reservation-Priority AVP, for deriving the ARP.

NOTE 5: The MCPTT specific algorithm shall consider the value of the MCPTT-Identifier AVP and the value of the Reservation-Priority AVP.

NOTE 6: For bandwidth values higher than 232-1 bps and if the Extended-BW-NR feature is supported, Extended Guaranteed Authorized Data Rate DL/UL and Extended Maximum Data Rate DL/UL shall be used instead of Maximum Authorized Data Rate DL/UL and Guaranteed Authorized Data Rate DL/UL.

NOTE 7: The MCVideo specific algorithm shall consider the value of the MCVideo-Identifier AVP and the value of the Reservation-Priority AVP.

| | + +## 6.4 QoS parameter mapping Functions at PCEF + +### 6.4.1 GPRS + +#### 6.4.1.1 Authorized IP QoS parameters per PDP Context to Authorized UMTS QoS parameters mapping in GGSN + +The Translation/Mapping function in the GGSN shall derive the Authorized UMTS QoS parameters from the Authorized IP QoS parameters received from the PCRF according to the rules in table 6.4.1. + +**Table 6.4.1: Rules for derivation of the Authorized UMTS QoS Parameters per PDP context from the Authorized IP QoS Parameters in GGSN** + +| Authorized UMTS QoS Parameter per PDP context | Derivation from Authorized IP QoS Parameters | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL and UL per PDP context (see NOTE 2) | Maximum Authorized Bandwidth DL/UL per PDP context = Maximum Authorized Data Rate DL/UL | +| Guaranteed Authorized Data Rate DL and UL per PDP context | Guaranteed Authorized Data Rate DL/UL per PDP context = Guaranteed Authorized Data Rate DL/UL | +| Maximum Authorized Traffic Class per PDP context | 
 IF QCI = 1 OR 2 THEN     Maximum Authorized Traffic Class = "Conversational" ELSEIF QCI = 3 OR 4 THEN     Maximum Authorized Traffic Class = "Streaming" ELSEIF QCI = 5 OR 6 OR 7 OR 8 THEN     Maximum Authorized Traffic Class = "Interactive"; ELSE Maximum Authorized Traffic Class = "Background" ENDIF ;
| +| Traffic Handling Priority | 
 IF QCI = 5 OR 6 THEN     Maximum Authorized Traffic Handling Priority = "1"; ELSE IF QCI = 7 THEN     Maximum Authorized Traffic Handling Priority = "2"; ELSE IF QCI = 8 THEN     Maximum Authorized Traffic Handling Priority = "3"; ELSE the GGSN shall not derive Traffic Handling Priority ENDIF ;
| +| Signalling Indication | 
 IF QCI = 5 THEN     Signalling Indication = "Yes"; ELSE IF QCI = 6 OR 7 OR 8 THEN     Signalling Indication = "No"; ELSE the GGSN shall not derive Signalling Indication ENDIF ;
| +| Source Statistics Descriptor | 
 IF QCI = (1 OR 3) THEN     Source Statistics Descriptor = "speech"; ELSE IF QCI = 2 OR 4 THEN     Source Statistics Descriptor = "unknown"; ELSE the GGSN shall not derive Source Statistics Descriptor ENDIF ;
| +| Evolved Allocation/Retention Priority (see NOTE 1) | 
 Evolved Allocation/Retention Priority = Allocation-Retention-Priority as follows :      PL := Priority-Level ;     PVI := Pre-emption-Vulnerability ;     PCI := Pre-emption-Capability ;
| +| APN-AMBR UL and DL | For non-GBR PDP Contexts, APN-AMBR DL/UL = APN-Aggregate-Max-Bitrate DL/UL | +| NOTE 1: Evolved Allocation/Retention Priority is derived only if supported by the SGSN.
NOTE 2: When APN-AMBR is supported in GPRS and the PCEF performs the bearer binding, the MBR for non-GBR PDP-Contexts is not derived | | + +#### 6.4.1.2 Comparing UMTS QoS Parameters against the Authorized UMTS QoS parameters in GGSN for UE initiated PDP context + +Upon receiving a PDP context activation, the GGSN requests PCC rules from the PCRF (see 3GPP TS 29.212 [9] for details). The PCRF may supply Authorized IP QoS Parameters per PDP context together with the PCC rules. The GGSN maps the Authorized IP QoS parameters per PDP Context to Authorized UMTS QoS parameters according to subclause 6.4.1.1 and then compares the requested UMTS QoS parameters against the corresponding Authorized UMTS QoS parameters. The following criteria shall be fulfilled: + +- If the requested Guaranteed Bitrate DL/UL (if the requested Traffic Class is Conversational or Streaming) is equal to the Authorized Guaranteed data rate DL/UL; and +- if received, the requested Maximum Bitrate DL/UL (if the requested Traffic Class is Interactive or Background) is equal to Maximum Authorized data rate DL/UL; and +- the requested Traffic Class is equal to Maximum Authorized Traffic Class; and +- if received, the requested Evolved Allocation/Retention Priority is equal to Allocation-Retention-Priority. +- if received, the requested APN-AMBR DL/UL is equal to the APN-Aggregate-Max-Bitrate DL/UL. + +Then, the GGSN shall accept the PDP context activation or modification with the UE requested parameters. Otherwise, the GGSN is adjusted (downgrade or upgrade) the requested UMTS QoS parameters to the values that were authorized. + +### 6.4.2 3GPP- EPS + +#### 6.4.2.1 Authorized IP QoS parameters per PDP Context to Authorized UMTS QoS parameters mapping in P-GW. + +This Translation/Mapping function in the P-GW applies when the P-GW interacts with a Gn/Gp SGSN. + +The Translation/Mapping function in the P-GW shall derive the Authorized UMTS QoS parameters from the Authorized IP QoS parameters derived for the bearer applying the rules in table 6.4.2. + +**Table 6.4.2: Rules for derivation of the Authorized UMTS QoS Parameters per PDP context from the Authorized IP QoS Parameters in P-GW.** + +| Authorized UMTS QoS Parameter per PDP context | Derivation from Authorized IP QoS Parameters | +|----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL and UL per PDP context (see NOTE 2) | For non-GBR bearers, Maximum Authorized Bandwidth DL/UL per PDP context = APN-Aggregate-Max-Bitrate DL/UL
For GBR bearers, Maximum Authorized Bandwidth DL/UL per PDP context = Sum of Maximum Authorized Data Rate DL/UL for all PCC Rules bound to that bearer | +| Guaranteed Authorized Data Rate DL and UL per PDP context | Guaranteed Authorized Data Rate DL/UL per PDP context = Sum of Guaranteed Authorized Data Rate DL/UL for all PCC Rules bound to that bearer | +| Maximum Authorized Traffic Class per PDP context | 
 IF QCI = 1 OR 2 OR 3 THEN     Maximum Authorized Traffic Class = "Conversational" ELSEIF QCI = 4 THEN     Maximum Authorized Traffic Class = "Streaming" ELSEIF QCI = 5 OR 6 OR 7 OR 8 THEN     Maximum Authorized Traffic Class = "Interactive"; ELSE Maximum Authorized Traffic Class = "Background" ENDIF ;
| +| Traffic Handling Priority | 
 IF QCI = 5 OR 6 THEN     Maximum Authorized Traffic Handling Priority = "1"; ELSE IF QCI = 7 THEN     Maximum Authorized Traffic Handling Priority = "2"; ELSE IF QCI = 8 THEN     Maximum Authorized Traffic Handling Priority = "3"; ELSE the P-GW shall not derive Traffic Handling Priority ENDIF ;
| +| Signalling Indication | 
 IF QCI = 5 THEN     Signalling Indication = "Yes"; ELSE IF QCI = 6 OR 7 OR 8 THEN     Signalling Indication = "No"; ELSE the P-GW shall not derive Signalling Indication ENDIF ;
| +| Source Statistics Descriptor | 
 IF QCI = 1 THEN     Source Statistics Descriptor = "speech"; ELSE IF QCI = 2 OR 3 OR 4 THEN     Source Statistics Descriptor = "unknown"; ELSE the P-GW shall not derive Source Statistics Descriptor ENDIF ;
| +| APN-AMBR DL and UL (see NOTE 3) | For non-GBR bearers, APN-AMBR = APN-Aggregate-Max-Bitrate DL/UL | +| Transfer Delay (see NOTE 1) | 
 IF QCI = 2 THEN     Transfer Delay = 150 ms ELSE IF QCI = 3 THEN     Transfer Delay >= 80 ms ELSE IF QCI = 1 OR 4 the P-GW shall set the Transfer Delay as the Packet Delay Budget for that QCI ELSE the P-GW shall not derive Transfer Delay. ENDIF ;
| + +| | | +|---------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Evolved Allocation/Retention Priority (see NOTE 4) |

Evolved Allocation/Retention Priority = Allocation-Retention-Priority as follows :

PL := Priority-Level ;
PVI := Pre-emption-Vulnerability ;
PCI := Pre-emption-Capability ;

| +| NOTE 1: Recommended Packet Delay Budget values for the different QCI values are defined in subclause 6.1.7, 3GPP TS 23.203 [2]. | | +| NOTE 2: For non-GBR bearers, applicable only if APN-AMBR is not supported by the SGSN. | | +| NOTE 3: Applicable to all non-GBR PDP-Contexts when supported by the SGSN. | | +| NOTE 4: Evolved Allocation/Retention Priority is derived only if supported by the SGSN. | | + +#### 6.4.2.2 Comparing UMTS QoS Parameters against the Authorized UMTS QoS parameters in P-GW for UE initiated PDP context + +Upon receiving a PDP context activation, the P-GW requests PCC rules from the PCRF (see 3GPP TS 29.212 [9] for details). The PCRF may supply Authorized IP QoS Parameters applicable for the provided PCC rules. The P-GW calculates the Authorized IP QoS parameters per bearer and maps the Authorized IP QoS parameters per bearer to Authorized UMTS QoS parameters according to subclause 6.4.2.1 and then compares the requested UMTS QoS parameters against the corresponding Authorized UMTS QoS parameters. The following criteria shall be fulfilled: + +- If the requested Guaranteed Bitrate DL/UL (if the requested Traffic Class is Conversational or Streaming) is equal to the Authorized Guaranteed data rate DL/UL; and +- the requested Maximum Bitrate DL/UL (if the requested Traffic Class is Interactive or Background) is equal to Maximum Authorized data rate DL/UL; and +- the requested Traffic Class is equal to Maximum Authorized Traffic Class; and +- if received, the requested Evolved Allocation/Retention Priority is equal to Allocation-Retention-Priority. + +Then, the P-GW shall accept the PDP context activation with the UE requested parameters. Otherwise, the P-GW shall accept the request and adjust (downgrade or upgrade) the requested UMTS QoS parameters to the values that were authorized. + +## 6.5 QoS parameter mapping Functions at UE for a UE-initiated GPRS PDP Context + +Figure 6.5.1 indicates the entities participating in the generation of the requested QoS parameters when the UE activates or modifies a PDP Context. The steps are: + +1. The Application provides the UMTS BS Manager, possibly via the IP BS Manager and the Translation/Mapping function, with relevant information to perform step 2 or step 4. (Not subject to standardization within 3GPP). +2. If needed, information from step 1 is used to access a proper set of UMTS QoS Parameters. See 3GPP TS 26.114 [29] for Conversational Codec Applications and 3GPP TS 26.234 [6] for Streaming Codec Applications. +3. If SDP is available then the SDP Parameters should give guidance for the UMTS BS Manager (possibly via the IP Manager and the Translation/Mapping function), according to the rules in clause 6.5.1, to set the Maximum Bitrate UL/DL and the Guaranteed Bitrate UL/DL. Furthermore the Maximum Authorized Bandwidth UL/DL and Maximum Authorised Traffic Class should be derived according to the rules in clause 6.5.2. +4. A set of UMTS QoS Parameters values from step 2 (or directly from step 1) is possibly merged together with the Maximum Bitrate UL/DL and the Guaranteed Bitrate UL/DL from step 3. The result should constitute the requested UMTS QoS Parameters. The UE should check that the requested Guaranteed Bitrate UL/DL or requested Maximum Bitrate UL/DL (depending on the requested Traffic Class) does not exceed the Maximum Authorized Bandwidth UL/DL derived in step 3. Furthermore, if the UE has implemented the mapping rule for Maximum Authorized Traffic Class, as defined in clause 6.5.2, the UE should check that the requested Traffic Class does not exceed the Maximum Authorised Traffic Class derived in step 3. + +![A block diagram showing the framework for generating requested QoS parameters in the UE. The UE contains an Application, SDP Handler, IP BS Manager, Translation/Mapping, UMTS BS Manager, and Session Manager. The SDP Handler receives (SDP) from outside. Arrows 1) and 3) go from Application to IP BS Manager. Arrows 2) and 4) go from IP BS Manager to UMTS BS Manager and Session Manager respectively. A stack of boxes labeled 'UMTS QoS Param. Per Applic Type' is connected to the UMTS BS Manager. The Session Manager sends 'PDP Context Activation and Modification' to the SGSN's Session Manager.](dd5771673aececa53d42ece89218299d_img.jpg) + +The diagram illustrates the internal components of a User Equipment (UE) and its interaction with an SGSN. Inside the UE, an **Application** sends data to an **SDP Handler** (labeled 1)). The **SDP Handler** receives external **(SDP)** data and sends it to the **IP BS Manager** (labeled 3)). The **IP BS Manager** passes data to **Translation / Mapping**, which then sends it to the **UMTS BS Manager** (labeled 2)). The **UMTS BS Manager** interacts with a stack of boxes representing **UMTS QoS Param. Per Applic Type** and sends data to the **Session Manager** (labeled 4)). Finally, the **Session Manager** sends a **PDP Context Activation and Modification** message to the **Session Manager** inside the **SGSN**. + +A block diagram showing the framework for generating requested QoS parameters in the UE. The UE contains an Application, SDP Handler, IP BS Manager, Translation/Mapping, UMTS BS Manager, and Session Manager. The SDP Handler receives (SDP) from outside. Arrows 1) and 3) go from Application to IP BS Manager. Arrows 2) and 4) go from IP BS Manager to UMTS BS Manager and Session Manager respectively. A stack of boxes labeled 'UMTS QoS Param. Per Applic Type' is connected to the UMTS BS Manager. The Session Manager sends 'PDP Context Activation and Modification' to the SGSN's Session Manager. + +Figure 6.5.1: Framework for generating requested QoS parameters in the UE + +### 6.5.1 SDP to UMTS QoS parameter mapping in UE + +If SDP Parameters are available, then before activating or modifying a PDP Context the UE should check if the SDP Parameters give guidance for setting the requested UMTS QoS Parameters. The UE should use the mapping rule in table 6.5.1.1 to derive the Maximum and Guaranteed Bitrate DL/UL from the SDP Parameters. + +**Table 6.5.1.1: Recommended rules for derivation of the requested Maximum and Guaranteed Bitrate DL/UL per media component in the UE** + +| UMTS QoS Parameter per media component | Derivation from SDP Parameters | +|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Bitrate DL/UL and Guaranteed Bitrate DL/UL per media component | 
 /* Check if the media use codec(s) */ IF [<media> = ("audio" or "video")] and [<transport> = "RTP/AVP"] THEN     /* Check if Streaming */     IF a= ("sendonly" or "recvonly") THEN         Maximum Bitrate DL/UL and Guaranteed Bitrate DL/UL per media component as specified in 3GPP TS 26.234 [6] ;         /* Conversational as default !*/     ELSE         Maximum Bitrate DL/UL and Guaranteed Bitrate DL/UL per media component as specified in reference 3GPP TS 26.114 [29] ;     ENDIF ;      /* Check for presence of bandwidth attribute for each media component */ ELSEIF b=AS:<bandwidth-value> is present THEN     IF media stream only downlink THEN         Maximum Bitrate DL = Guaranteed Bitrate DL =<bandwidth-value> ;     ELSEIF mediastream only uplink THEN         Maximum Bitrate UL = Guaranteed Bitrate UL =<bandwidth-value> ;     ELSEIF mediastreams both downlink and uplink THEN         Maximum Bitrate DL = Guaranteed Bitrate DL =<bandwidth-value> ;         Maximum Bitrate UL = Guaranteed Bitrate UL =<bandwidth-value> ;     ENDIF; ELSE     /* SDP does not give any guidance ! */     Maximum Bitrate DL/UL and Guaranteed Bitrate DL/UL per media component as specified by the UE manufacturer; ENDIF ;
| + +### 6.5.2 SDP parameters to Authorized UMTS QoS parameters mapping in UE + +If the PDP Context is activated or modified the UE should use the mapping rules in table 6.5.2.1 for all applications using SDP to derive the Maximum Authorized Bandwidth UL/DL per IP flow or bidirectional combinations of IP flows. + +Table 6.5.2.1 also has a mapping rule for derivation of Maximum Authorized Traffic Class per IP flow or bidirectional combinations of IP flows which applies for session initiation and modification. + +In future releases this mapping rule may change. + +In the case of forking, the various forked responses may have different QoS requirements for the same IP flows of a media component. When the Authorized UMTS QoS Parameters are used by the UE, they shall be set equal to the highest values requested for the IP flows of that media component by any of the active forked responses. The UE should use the mapping rule in table 6.5.2.1 for each forked response. + +**Table 6.5.2.1: Rules for derivation of the Maximum Authorized Bandwidth DL/UL and the Maximum Authorized Traffic Class per IP flow or bidirectional combination of IP flows in the UE** + +| Authorized UMTS QoS
Parameter | Derivation from SDP Parameters
(see Note 4) | +|------------------------------------------|--------------------------------------------------------| +|------------------------------------------|--------------------------------------------------------| + +### **Maximum Authorized Bandwidth DL (Max\_BW\_DL) and UL (Max\_BW\_UL) (see NOTE 5)** + +``` + +IF a=recvonly THEN + IF = mobile originated THEN + Direction:= downlink; + + ELSE /* mobile terminated */ + Direction:= uplink; + ENDIF; + + ELSE /* a!= recvonly */ + IF a=sendonly THEN + IF = mobile originated THEN + Direction:= uplink; + ELSE /* mobile terminated */ + Direction:= downlink; + ENDIF; + ELSE /*sendrecv, inactive or no direction attribute*/ + Direction:=both; + ENDIF; + ENDIF; + + /* Max_BW_UL and Max_BW_DL */ + + IF media IP flow(s) THEN + IF bAS=AS: is present and + ( bTIAS=TIAS: is not present or + is present but not supported ) THEN + IF Direction=downlink THEN + Max_BW_UL:= 0; + Max_BW_DL:= bAS; + ELSE + IF Direction=uplink THEN + Max_BW_UL := bAS ; + Max_BW_DL := 0 ; + ELSE /*Direction=both*/ + Max_BW_UL:= bAS; + Max_BW_DL := bAS ; + ENDIF ; + ENDIF; + ELSE + IF bTIAS=TIAS: is present and supported THEN + bTDBW= bTIAS + transport-overhead; (NOTE 6) + + IF Direction=downlink THEN + Max_BW_UL:= 0; + Max_BW_DL:= bTDBW; (NOTE 6) + + ELSE + IF Direction=uplink THEN + Max_BW_UL:= bTDBW; (NOTE 6) + Max_BW_DL:= 0; + + ELSE /*Direction=both*/ + Max_BW_UL:= bTDBW; (NOTE 6) + Max_BW_DL:= bTDBW; (NOTE 6) + ENDIF; + ENDIF; + ELSE /* bTIAS=TIAS: is NOT present or is present but not supported*/ + bw:= as set by the UE manufacturer; + IF Direction=downlink THEN + Max_BW_UL:= 0; + Max_BW_DL:= bw; + ELSE + IF Direction=uplink THEN + Max_BW_UL:= bw; + Max_BW_DL:= 0; + + ELSE /*Direction=both*/ + Max_BW_UL:= bw; + Max_BW_DL:= bw; + ENDIF; + ENDIF; + ENDIF; + ENDIF; + ENDIF; + +``` + +| Authorized UMTS QoS Parameter | Derivation from SDP Parameters
(see Note 4) | +|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | 
         ENDIF;          ENDIF;         ENDIF;         ENDIF;          ELSE /* RTCP IP flow(s) */         IF bRS=RS:<bandwidth> and bRR=RR:<bandwidth> is present THEN           Max_BW_UL:= (bRS + bRR) / 1000;           Max_BW_DL:= (bRS + bRR) / 1000;         ELSE           IF bAS=AS:<bandwidth> is present and             ( bTIAS=TIAS:<Tibandwidth> is not present or               is present but not supported ) THEN             IF bRS=RS:<bandwidth> is present and bRR=RR:<bandwidth> is not present             THEN               Max_BW_UL := MAX[0.05 * bAS, bRS / 1000] ;               Max_BW_DL := MAX[0.05 * bAS, bRS / 1000] ;             ENDIF;              IF bRS=RS:<bandwidth> is not present and bRR=RR:<bandwidth> is present             THEN               Max_BW_UL:= MAX[0.05 * bAS, bRR / 1000];               Max_BW_DL:= MAX[0.05 * bAS, bRR / 1000];             ENDIF;              IF bRS=RS:<bandwidth> and bRR=RR:<bandwidth> is not present THEN               Max_BW_UL := 0.05 * bAS ;               Max_BW_DL := 0.05 * bAS ;             ENDIF;           ELSE             IF bTIAS=TIAS:<Tibandwidth> is present and supported THEN               bTDBW= bTIAS + transport-overhead; (NOTE 6)                IF bRS=RS:<bandwidth> is present and                 bRR=RR:<bandwidth> is not present THEN                   Max_BW_UL:= MAX[0.05 * bTDBW, bRS]/1000;                   Max_BW_DL:= MAX[0.05 * bTDBW, bRS]/1000;                 ENDIF;                  IF bRS=RS:<bandwidth> is not present and                   bRR=RR:<bandwidth> is present THEN                     Max_BW_UL:= MAX[0.05 * bTDBW, bRR]/1000;                     Max_BW_DL:= MAX[0.05 * bTDBW, bRR]/1000;                   ENDIF;                    IF bRS=RS:<bandwidth> and                     bRR=RR:<bandwidth> is not present THEN                       Max_BW_UL:= 0.05 * bTDBW /1000;                       Max_BW_DL:= 0.05 * bTDBW /1000;                     ENDIF;                  ELSE                   Max_BW_UL:= as set by the UE manufacture;                   Max_BW_DL:= as set by the UE manufacture;                  ENDIF;               ENDIF;             ENDIF;           ENDIF;         ENDIF;
| + +| Authorized UMTS QoS Parameter | Derivation from SDP Parameters
(see Note 4) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Traffic Class [MaxTrafficClass] (see NOTE 1, 2 and 3) | 
 IF (all media IP flows of media type "audio" or "video" for the session are     unidirectional and have the same direction) THEN     MaxService:= streaming; ELSE     MaxService:= conversational; ENDIF;  CASE <media> OF     "audio":      MaxTrafficClass:= MaxService;     "video":      MaxTrafficClass:= MaxService;     "application": MaxTrafficClass:=conversational;     "data":       MaxTrafficClass:=interactive with priority 3;     "control":    MaxTrafficClass:=interactive with priority 1;     /*new media type*/     OTHERWISE:    MaxTrafficClass:=background; END;
| +| NOTE 1: The Maximum Authorized Traffic Class for a RTCP IP flow is the same as for the corresponding RTP media IP flow. | | +| NOTE 2: When audio or video IP flow(s) are removed from a session, the parameter MaxService shall keep the originally assigned value. | | +| NOTE 3: When audio or video IP flow(s) are added to a session, the UE shall derive the parameter MaxService taking into account the already existing media IP flows within the session. | | +| NOTE 4: The SDP parameters are described in RFC 2327 [11]. | | +| NOTE 5: The 'b=RS:' and 'b=RR:' SDP bandwidth modifiers are defined in RFC 3556 [13]. | | +| NOTE 6: TIAS is defined in IETF RFC 3890 [23]. RFC 3890 clause 6.4 provides procedures for converting TIAS to transport-dependant values. This procedure relies on the presence of maxprate (also defined in RFC 3890). | | + +The UE should per ongoing session store the Authorized UMTS QoS parameters per IP flow or bidirectional combination of IP flows. + +Before activating or modifying a PDP context the UE should check that the requested Guaranteed Bitrate UL/DL (if the Traffic Class is Conversational or Streaming) or the requested Maximum Bitrate UL/DL (if the Traffic Class is Interactive or Background) does not exceed the Maximum Authorized Bandwidth UL/DL per PDP context (calculated according to the rule in table 6.5.2.2). If the requested Guaranteed Bitrate UL/DL or the requested Maximum Bitrate UL/DL exceeds the Maximum Authorized Bandwidth UL/DL per PDP context, the UE should reduce the requested Guaranteed Bitrate UL/DL or the requested Maximum Bitrate UL/DL to the Maximum Authorized Bandwidth UL/DL per PDP context. Furthermore, if the rule in table 6.5.2.1 for calculating Traffic Class per IP flow or bidirectional combination of IP flows is implemented, the UE should check that the requested UMTS QoS parameter Traffic Class does not exceed the Maximum Authorized Traffic Class per PDP context (calculated according to the rule in table 6.5.2.2). If the requested UMTS QoS parameter Traffic Class exceeds the Maximum Authorized Traffic Class per PDP context, the UE should reduce the requested UMTS QoS parameter Traffic Class to the Maximum Authorized Traffic Class per PDP context. + +**Table 6.5.2.2: Rules for calculating the Maximum Authorized Bandwidths and Maximum Authorized Traffic Class per PDP Context in the UE** + +| Authorized UMTS QoS Parameter per PDP Context | Calculation Rule | +|---------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL and UL per PDP Context |

Maximum Authorized Bandwidth DL/UL per PDP Context is the sum of all Maximum Authorized Bandwidth DL/UL for all the IP flows or bidirectional combinations of IP flows (as derived according to table 6.5.2.1) associated with that PDP Context ;

 IF Maximum Authorized Bandwidth DL/UL per PDP Context > 256 Mbps THEN     Maximum Authorized Bandwidth DL/UL per PDP Context = 256 Mbps     /* See 3GPP TS 23.107 [4] */ END;
| +| Maximum Authorized Traffic Class per PDP Context |

Maximum Authorized Traffic Class per PDP Context = MAX [Maximum Authorized QoS Class per IP flow or bidirectional combination of IP flows (as derived according to table 6.5.2.1) among all the IP flows or bidirectional combinations of IP flows associated with that PDP Context] ;

(The MAX function ranks the possible Maximum Authorized Traffic Class values as follows: Conversational > Streaming > Interactive with priority 1 > Interactive with priority 2 > Interactive with priority 3 > Background)

| + +# 7 PCRF addressing + +## 7.1 General + +The PCRF discovery procedures are needed where more than one PCRF is present in an operator's network realm. Within such a deployment, an additional functional element, called DRA, is needed. PCRF discovery procedures include all the procedures that involve a DRA functional element. + +Routing of Diameter messages from a network element towards the right Diameter realm in a PLMN is based on standard Diameter realm-based routing, as specified in IETF RFC 6733 [61] using the UE-NAI domain part. If PLMN is separated into multiple realms based on PDN information or IP address range (if applicable); the PDN information available in the Called-Station-Id AVP, or the UE's Ipv4 address available in the Framed-IP-Address AVP or the UE's Ipv6 address or prefix provided within the Framed-Ipv6-Prefix AVP may be used to assist routing PCC message to the appropriate Diameter realm. + +The DRA keeps status of the assigned PCRF for a certain UE and IP-CAN session across all reference points, e.g. Gx, Gxx, S9, Rx and for unsolicited application reporting, the Sd interfaces. + +The DRA shall support the functionality of a proxy agent and a redirect agent as defined in IETF RFC 6733 [61]. The mode in which it operates (i.e. proxy or redirect) shall be based on operator's requirements. + +Diameter clients of the DRA, i.e. AF, PCEF, BBERF, RCAF and PCRF in roaming scenarios shall support all procedures required to properly interoperate with the DRA in both the proxy and redirect modes. + +NOTE: The proxy mode includes two variants: + +PA1: Proxy agent based on the standard Diameter proxy agent functionality. All the messages need to go through the DRA. + +PA2: Proxy agent based on the standard Diameter proxy agent functionality. Session establishment messages always go through the DRA. Gx, Gxx and S9 session termination messages always go through the DRA. All other messages bypass the DRA. + +## 7.2 DRA Definition + +The DRA (Diameter Routing Agent) is a functional element that ensures that all Diameter sessions established over the Gx, S9, Gxx, Rx interfaces and for unsolicited application reporting, the Sd interface for a certain IP-CAN session reach the same PCRF when multiple and separately addressable PCRFs have been deployed in a Diameter realm. The DRA also ensures that the NRR commands over Np interface reach the same PCRF for a certain IP-CAN session. The DRA is not required in a network that deploys a single PCRF per Diameter realm. + +## 7.3 DRA Procedures + +### 7.3.1 General + +A DRA implemented as a Diameter Redirect Agent or a Diameter Proxy Agent shall be compliant to IETF RFC 6733 [61], except when noted otherwise in this document. + +### 7.3.2 DRA Information Storage + +The DRA shall maintain PCRF routing information per IP-CAN session or per UE-NAI, depending on the operator's configuration. + +The DRA shall select the same PCRF for all the Diameter sessions established for the same UE in case 2a. + +As there's only one S9 session per UE, the V-DRA/H-DRA shall select the same V-PCRF/H-PCRF respectively for the same UE in the roaming case. + +The DRA has information about the user identity (UE NAI), the UE IPv4 address and/or IPv6 prefix, the APN (if available), the PCEF identity (if available) and the selected PCRF identity for a certain IP-CAN Session. + +NOTE 1: The DRA derives the PCEF identity from the Origin-Host AVP of the CCR command received from the PCEF. + +The DRA finds the correct PCRF by matching the user identity (if available), IPv4 address or IPv6 address/prefix (if available) and APN (if available) received in the message from the BBERF/PCEF/AF/TDF/ RCAf/V-PCRF with the corresponding information stored the DRA. + +NOTE 2: If the DRA does not use the IP address to find the PCRF and the user identity in the IP-CAN and the application level identity for the user are of different kinds (e.g. user identity is the IP-CAN is IMSI and application level identity for the user is SIPURI), the DRA needs to maintain, or have access to, the mapping between the identities. Such mapping is not subject to specification within this TS. + +NOTE 3: An IPv6 address provided over Rx matches an IPv6 prefix stored in the DRA binding if the IPv6 address belongs to the IPv6 (sub-)network prefix. + +When matching the APNs to each other, the DRA shall apply the procedures in Annex I. + +For the PCRF selection over the Rx reference point, the DRA may additionally match the IP domain Id received in the message from the AF with the PCEF identity stored in the DRA to find the correct PCRF. + +NOTE 4: In order to correlate the PCEF Identity and the domain identity, the DRA uses configured mapping between those identities. + +For the PCRF selection over the Rx reference point, when the APN related to the IP-CAN session is dedicated for the purpose of offering services to remote UEs via a ProSe UE-to-network relay UE, the DRA shall use the UE IPv6 prefix alone to find the correct PCRF. + +The PCRF routing information stored for an IP-CAN session in the DRA shall be removed after the IP-CAN session is terminated. In case of DRA change (e.g. inter-operator handover), the information about the IP-CAN session stored in the old DRA shall be removed. + +The PCRF routing information stored per UE in the DRA may be removed when no more IP-CAN and gateway control sessions are active for the UE. + +### 7.3.3 Capabilities Exchange + +In addition to the capabilities exchange procedures defined in IETF RFC 6733 [61], the Redirect DRA and Proxy DRA shall advertise the specific applications it supports (e.g., Gx, Gxx, Rx, Np,S9 and for unsolicited application reporting, Sd) by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +### 7.3.4 Redirect DRA + +#### 7.3.4.1 Redirecting Diameter Requests + +A DRA implemented as a Diameter redirect agent shall redirect the received Diameter request message by carrying out the procedures defined in clause 6.1.7 of IETF RFC 6733 [61]. The Client shall use the value within the Redirect-Host AVP of the redirect response in order to obtain the PCRF identity. The DRA may provide the Redirect-Host-Usage AVP in the redirect response to provide a hint to the Client about how the cached route table entry created from the Redirect-Host AVP is to be used as described in clause 6.13 of IETF RFC 6733 [61]. + +The two most relevant redirect host usage scenarios for PCC from IETF RFC 6733 [61] are: + +- If the PCRF routing information is per UE-NAI, the DRA shall set the Redirect-Host-Usage AVP to ALL\_USER. The DRA client may contact the DRA on IP-CAN session termination. +- If the PCRF routing information is per IP-CAN session, the DRA shall set the Redirect-Host-Usage AVP to ALL\_SESSION. The DRA client shall contact the DRA on IP-CAN session termination. + +The DRA may also provide the Redirect-Max-Cache-Time AVP in the redirect response to indicate to the Client the lifetime of the cached route table entry created from the Redirect-Host and Redirect-Host-Usage AVP values as described in clause 6.14 of IETF RFC 6733 [61]. + +If the DRA is maintaining PCRF routing information per IP-CAN session, the DRA shall be aware of Gx and Gxx Diameter termination requests as defined in 3GPP TS 29.212 [9] in order to detect whether release of DRA bindings is required. Otherwise the DRA clients shall use cached route table entry created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs to determine whether DRA interaction is required. + +The DRA shall be aware of IP-CAN Session modification requests over Gx which is to update the Ipv4 address of the UE by the PCEF. + +If the client is the AF, the DRA (redirect) does not need to maintain Diameter sessions and Diameter Base redirect procedures are applicable. Therefore, an AF should not send an AF session termination request to the DRA. + +#### 7.3.4.2 DRA binding removal + +If the DRA binding is per IP-CAN session and the IP-CAN session is terminated or if the DRA binding is per UE and the last IP-CAN session is terminated (eg. From an indication by the BBERF/PCEF) the Redirect DRA shall remove the associated DRA binding information and responds with a Diameter redirect answer message. + +### 7.3.5 Proxy DRA + +The DRA shall support the functionality of a Diameter proxy agent as defined in IETF RFC 6733 [61]. + +When the DRA receives a request from a client, it shall check whether it already has selected a PCRF for the UE or the UE's IP-CAN session; if it does have a PCRF already selected for that UE or UE's IP-CAN session, it shall proxy the request to the corresponding PCRF. If the request is an IP-CAN session termination or gateway control session termination, the DRA shall check whether PCRF routing information shall be removed as specified in clause 7.3.3. If the DRA does not have a PCRF already selected, it shall follow one of the procedures below: + +- If the request is an IP-CAN session establishment or gateway control session establishment, it shall select a PCRF to handle all sessions for that UE or UE's IP-CAN session. It shall then proxy the request to the selected PCRF. +- Otherwise, if the request is not an IP-CAN session establishment or gateway control session establishment, it shall reject the request by returning a DIAMETER\_UNABLE\_TO\_COMPLY error code. + +If a DRA is deployed in a PCRF's realm, clients of the DRA shall send the first request of a session to the DRA handling the PCRF's realm. Clients of the DRA shall as well send IP-CAN session termination and gateway control termination requests to the DRA. A client of the DRA shall be capable of sending every message of a session to the DRA. A client of the DRA may be configured to bypass the DRA on session modification messages and AF session termination messages by sending these types of messages directly to the PCRF. + +### 7.3.6 PCRF selection by BBERF/PCEF (non-roaming case) + +The PCEF (e.g. P-GW) or BBERF (e.g. Non-3GPP Access, S-GW) shall provide the DRA of the PCRF realm with identity parameters upon the first interaction between the access entity and the PCRF realm. + +If the redirect agent is used for DRA, the DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the PCEF or the BBERF. + +If proxy agent is used for DRA, the DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. For PA2 solution (described in clause 7.1), only session establishment, session modification with the UE's Ipv4 address updated and session termination messages shall be sent through the DRA. + +The identity parameters from the PCEF or BBERF may comprise the UE's Ipv4 address in the Framed-IP-Address AVP and/or the UE's Ipv6 prefix in the Framed-Ipv6-Prefix AVP, PDN information in the Called-Station-Id AVP and user identity in the Subscription-Id AVP. + +### 7.3.7 PCRF selection by AF + +If the AF has the realm identification (i.e. FQDN from a UE NAI) and is located in the HPLMN, the AF sends the user identity in the Subscription-Id AVP and PDN information (i.e. APN) if available in the Called-Station-Id AVP in a Diameter request to the DRA which acts as a Diameter agent. + +For an AF serving mission critical communication services (e.g. MCPTT), the AF shall derive the realm of the PCRF based on the IP address and, based on the PLMN ID, construct the Diameter destination realm and use that destination realm in the initial request to address the DRA. + +NOTE 1: An AF serving mission critical communication services as defined in 3GPP TS 23.280 [64] can be independent from a PLMN and is not guaranteed to have any realm identification. + +If the AF does not have proper knowledge about the user identity and the AF is located in the HPLMN, the AF may use pre-configured information to find the DRA. + +NOTE 1A: How the AF which is a third party or non-IMS application server finds the DRA if it does not have the proper knowledge about the user identity is out of scope of this specification. + +The AF shall provide the DRA of the PCRF realm with identity parameters upon the first interaction between the AF and the PCRF realm. + +If redirect agent is used for DRA, the DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the AF. + +If proxy agent is used for DRA, the DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. For PA2 solution (described in clause 7.1), only AF session establishment messages shall be sent through the DRA. + +The parameters from the AF may comprise the UE IP address in either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP, PDN information in the Called-Station-Id AVP, user identity in the Subscription-Id AVP and domain Identity in the IP-Domain-Id AVP (3GPP TS 23.203 [2]). + +NOTE 2: In case the user identity in the IP-CAN and the application level identity for the user are of different kinds (e.g. user identity in the IP-CAN is IMSI and application level identity for the user is SIPURI), the DRA needs to maintain, or have access to, the mapping between the identities. Such mapping is not subject to specification within this TS. + +### 7.3.8 PCRF selection in a roaming scenario + +In the roaming case, a V-DRA is needed in the visited PLMN when there are more than one PCRFs per realm. The V-DRA will ensure that all the related Diameter sessions for a UE are handled by the same V-PCRF. + +The BBERF in the visited access and home routed cases, the PCEF in the case of visited access and the AF when located in the visited PLMN may use pre-configured information (e.g. based on PDN) to find the V-DRA, and then find the V-PCRF. Other possible options are Dynamic peer discovery, or DNS-based. + +The V-PCRF can find the H-DRA based on the UE NAI, and then find the H-PCRF by the H-DRA. + +The V-PCRF shall provide the H-DRA of the H-PCRF realm with identity parameters upon the first interaction between the V-PCRF and the H-PCRF realm. + +If redirect agent is used for H-DRA, the H-DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the H-PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the V-PCRF. + +If proxy agent is used for H-DRA, the H-DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. For PA2 solution (described in clause 7.1), only session establishment, session modification with the UE's Ipv4 address updated and, only for the Gx, Gxx and S9 interfaces, termination messages shall be sent through the H-DRA. + +The identity parameters from the V-PCRF may comprise the same parameters sent by the PCEF or the BBERF to the V-PCRF, i.e. the user identity (UE NAI), APN, the UE's Ipv4 address and/or Ipv6 prefix (3GPP TS 23.203 [2]). + +If redirect agent or PA2 is used for H-DRA, and the V-PCRF receives establishment message from the AF in the VPLMN, the V-PCRF may send the message to the H-PCRF directly (e.g. based on the stored information provided by H-DRA during the IP-CAN session establishment). + +### 7.3.9 PCRF selection by TDF for unsolicited application reporting + +The TDF uses pre-configured information to find the DRA. + +The TDF shall provide the DRA of the PCRF realm with identity parameters upon the first interaction between the TDF and the PCRF realm. + +If redirect agent is used for DRA, the DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the TDF. + +If proxy agent is used for DRA, the DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. For PA2 solution (described in subclause 7.1), only TDF session establishment messages shall be sent through the DRA. + +The parameters from the TDF may comprise the UE IP address in either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP and PDN information in the Called-Station-ID AVP. + +NOTE: The TDF located in the HPLMN finds the H-PCRF for the roaming UE with home routed access case. +The TDF located in the VPLMN finds the V-PCRF for the roaming UE with visited access case. + +### 7.3.10 PCRF selection by RCAF + +For initial Non-Aggregated RUCI reporting, the RCAF shall provide the identity parameters to the DRA of the PCRF realm. + +The identity parameters from the RCAF may comprise PDN information in the Called-Station-Id AVP and user identity in the Subscription-Id AVP. + +In the roaming with home-routed access case, the RCAF can find the H-DRA based on the IMSI, and then find the H-PCRF by the H-DRA. The RCAF shall provide the H-DRA of the H-PCRF realm with identity parameters upon the first interaction between the RCAF and the H-PCRF realm. + +In the roaming with visited case, the RCAF shall provide the V-DRA of the V-PCRF realm with identity parameters upon the first interaction between the RCAF and the V-PCRF realm. + +If the redirect agent is used for DRA, the DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the RCAF. + +If proxy agent is used for DRA, the DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. + +For subsequent non-aggregated or aggregated RUCI reporting, the RCAF shall include the PCRF identity within the Destination-Host AVP for direct PCRF selection. The PCRF identity shall be responded by the PCRF within the PCRF-Address AVP in the initial non-aggregated RUCI reporting, for identifying the same destination PCRF in the subsequent non-aggregated or aggregated RUCI reporting. + +## 7.4 DRA flows + +### 7.4.1 Proxy DRA + +#### 7.4.1.1 Establishment of Diameter Sessions + +##### 7.4.1.1.1 Non-roaming cases + +Establishment of Diameter sessions may occur at any of the following cases: + +- Gateway control establishment +- IP-CAN session establishment + +- AF session establishment +- For unsolicited application reporting, TDF session establishment + +![Sequence diagram showing the establishment of Diameter sessions using a DRA (proxy). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The sequence starts with an external trigger to the Client. The Client sends a Diameter Request (Rx/Gx/Gxx/Sd) to the DRA. The DRA performs a binding creation/retrieval. The DRA proxies the request to PCRF-1. PCRF-1 returns a Diameter Answer to the DRA. The DRA proxies the answer back to the Client. A shaded region labeled PA2 contains step 7, 'PCRF address storage', which is a conditional step. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages.](838c31609fac483fa2c01c7896a2fd6d_img.jpg) + +``` + +sequenceDiagram + participant Client as Client (AF/BBERF/PCEF/TDF) + participant DRA as DRA (proxy) + participant PCRF1 as PCRF-1 + participant PCRF2 as PCRF-2 + + Note left of Client: External trigger + Client->>DRA: 2. Rx/Gx/Gxx/Sd Diameter Request + Note right of DRA: 3. DRA binding creation/retrieval + DRA->>PCRF1: 4. Proxy Rx/Gx/Gxx/Sd Diameter Request + PCRF1-->>DRA: 5. Rx/Gx/Gxx/Sd Diameter Answer + DRA-->>Client: 6. Proxy Rx/Gx/Gxx/Sd Diameter Answer + Note right of Client: 7. PCRF address storage + Note right of PCRF2: Legend: + Note right of PCRF2: --> Mandatory + Note right of PCRF2: -.-> Conditional + +``` + +Sequence diagram showing the establishment of Diameter sessions using a DRA (proxy). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The sequence starts with an external trigger to the Client. The Client sends a Diameter Request (Rx/Gx/Gxx/Sd) to the DRA. The DRA performs a binding creation/retrieval. The DRA proxies the request to PCRF-1. PCRF-1 returns a Diameter Answer to the DRA. The DRA proxies the answer back to the Client. A shaded region labeled PA2 contains step 7, 'PCRF address storage', which is a conditional step. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +**Figure 7.4.1.1.1.1: Establishment of Diameter sessions using DRA (proxy)** + +1. A Client receives an external trigger (e.g. IP-CAN session establishment request) that requires the establishment of a Diameter session with a PCRF. +2. A Diameter Request (e.g. a Diameter CCR sent by PGW to indicate establishment of an IP-CAN session as defined in clauses 4.5.1, 4a.5.1 of 3GPP TS 29.212 [9]) is sent by the Client and received by a DRA (proxy). +3. The DRA (proxy) stores the user information (e.g. UE-NAI) and checks whether an active DRA binding exists. If not, the DRA creates a dynamic DRA binding (assignment of a PCRF node per UE or per IP-CAN session). + +NOTE 1: When the AF establishes an Rx session or TDF establishes a TDF session with the DRA, there is already a DRA binding active. + +4. The DRA (proxy) proxies the Diameter Request to the target PCRF. The proxied Diameter Request maintains the same Session-Id AVP value. +5. PCRF-1 returns a Diameter Answer as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9] to the DRA (proxy). +6. DRA (proxy) proxies the Diameter Answer to the Client. The proxied Diameter Answer maintains the same Session-Id AVP value. + +7. If PA2 option is implemented, the Client uses the Origin-Host AVP value provided in the Diameter Answer of step 6. This value is the identity of the target PCRF. The client populates the Destination-Host AVP with this address and sends any subsequent Diameter messages directly to this PCRF bypassing the DRA (proxy). + +NOTE 2: Figure 7.4.1.1.1.1 is also applicable when the AF/BBERF/PCEF/TDF in the VPLMN contacts the V-DRA to locate the V-PCRF. + +##### 7.4.1.1.2 Roaming cases + +Establishment of Diameter sessions may occur at any of the following cases: + +- V-PCRF initiates S9 Diameter session to H-PCRF + +- V-PCRF proxies Rx Diameter session to H-PCRF + +![Sequence diagram illustrating the establishment of Diameter sessions using DRA (proxy) in a roaming case. The diagram shows interactions between V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. Steps include: 1. External trigger to V-PCRF; 2. Rx/S9 Diameter Request from V-PCRF to H-DRA; 3. DRA binding creation/retrieval at H-DRA; 4. Proxy Rx/S9 Diameter Request from H-DRA to H-PCRF-1; 5. Rx/S9 Diameter Answer from H-PCRF-1 to H-DRA; 6. Proxy Rx/S9 Diameter Answer from H-DRA to V-PCRF; 7. PCRF address storage at V-PCRF (conditional, PA2 option). A legend indicates solid arrows are Mandatory and dashed arrows are Conditional.](ddee3e67e0dfc22e25188fa635a19558_img.jpg) + +``` + +sequenceDiagram + participant External + participant V-PCRF + participant H-DRA as H-DRA (proxy) + participant H-PCRF-1 + participant H-PCRF-2 + + Note left of V-PCRF: PA2 + External->>V-PCRF: 1. External trigger + V-PCRF->>H-DRA: 2. Rx/S9 Diameter Request + H-DRA->>H-DRA: 3. DRA binding creation/retrieval + H-DRA->>H-PCRF-1: 4. Proxy Rx/S9 Diameter Request + H-PCRF-1->>H-DRA: 5. Rx/S9 Diameter Answer + H-DRA->>V-PCRF: 6. Proxy Rx/S9 Diameter Answer + V-PCRF-->>V-PCRF: 7. PCRF address storage + +``` + +**Legend:** + → *Mandatory* + - - - - → *Conditional* + +Sequence diagram illustrating the establishment of Diameter sessions using DRA (proxy) in a roaming case. The diagram shows interactions between V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. Steps include: 1. External trigger to V-PCRF; 2. Rx/S9 Diameter Request from V-PCRF to H-DRA; 3. DRA binding creation/retrieval at H-DRA; 4. Proxy Rx/S9 Diameter Request from H-DRA to H-PCRF-1; 5. Rx/S9 Diameter Answer from H-PCRF-1 to H-DRA; 6. Proxy Rx/S9 Diameter Answer from H-DRA to V-PCRF; 7. PCRF address storage at V-PCRF (conditional, PA2 option). A legend indicates solid arrows are Mandatory and dashed arrows are Conditional. + +**Figure 7.4.1.1.2.1: Establishment of Diameter sessions using DRA (proxy) – Roaming case** + +1. V-PCRF receives a trigger to establish a Diameter session to H-PCRF (e.g. S9 session establishment request). +2. A Diameter Request involving either the Rx or S9 protocol is sent by the V-PCRF and received by a H-DRA (proxy) in the home PLMN. +3. The H-DRA (proxy) stores the user information (e.g. UE-NAI) and checks whether an active DRA binding exists. If not, the H-DRA creates a dynamic DRA binding (assignment of a PCRF node per UE or per IP-CAN session). +4. The H-DRA (proxy) proxies the Diameter Request to the target PCRF in the home PLMN. The proxied Diameter Request maintains the same Session-Id AVP value. +5. H-PCRF-1 returns a Diameter Answer to the H-DRA (proxy). +6. H-DRA (proxy) proxies the Diameter Answer to the V-PCRF. The proxied Diameter Answer maintains the same Session-Id AVP value. +7. If PA2 option is implemented, the V-PCRF uses the Origin-Host AVP value provided in the Diameter Answer of step 6. This value is the identity of the target H-PCRF. The V-PCRF populates the Destination-Host AVP with this address and sends any subsequent Diameter messages directly to this H-PCRF bypassing the H-DRA. + +#### 7.4.1.2 Modification of Diameter Sessions + +##### 7.4.1.2.1 Non-roaming cases + +###### 7.4.1.2.1.1 Client-initiated + +Modification of Diameter sessions may occur in any of the following cases: + +- Gateway control session modification +- IP-CAN session modification +- AF session modification +- For unsolicited application reporting, TDF session modification + +If PA1 option is implemented, only steps 2, 3, 4, 5, 6 are carried out. If PA2 option is implemented, only steps 2a, 5a are carried out. + +![Sequence diagram showing the modification of Diameter sessions through DRA (proxy) for AF/BBERF/PCEF/TDF interaction. The diagram involves four lifelines: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Subsequent Diameter Request to the DRA (step 2). If the PA2 option is implemented, the Client also sends a Subsequent Diameter Request directly to PCRF-1 (step 2a). The DRA then verifies its binding (step 3) and proxies the request to PCRF-1 (step 4). PCRF-1 returns a Diameter Answer to the DRA (step 5). If the PA2 option is implemented, PCRF-1 also returns a Diameter Answer directly to the Client (step 5a). Finally, the DRA proxies the Diameter Answer to the Client (step 6). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages.](cf8bd014a50b7c69435e804f67f9617f_img.jpg) + +``` + +sequenceDiagram + participant Client as Client (AF/BBERF/PCEF/TDF) + participant DRA as DRA (proxy) + participant PCRF1 as PCRF-1 + participant PCRF2 as PCRF-2 + + Note left of Client: 1. External trigger + Client->>DRA: 2. Subsequent Rx/Gx/Gxx/Sd Diameter Request + Note right of Client: PA2 + Client->>PCRF1: 2a. Subsequent Rx/Gx/Gxx/Sd Diameter Request + Note right of DRA: 3. Verify DRA Binding + DRA->>PCRF1: 4. Proxy Rx/Gx/Gxx/Sd Diameter Request + PCRF1->>DRA: 5. Rx/Gx/Gxx/Sd Diameter Answer + Note right of PCRF1: PA2 + PCRF1->>Client: 5a. Rx/Gx/Gxx/Sd Diameter Answer + DRA->>Client: 6. Proxy Rx/Gx/Gxx/Sd Diameter Answer + + Note right of PCRF2: Legend: + Note right of PCRF2: --> Mandatory + Note right of PCRF2: -.-> Conditional + +``` + +Sequence diagram showing the modification of Diameter sessions through DRA (proxy) for AF/BBERF/PCEF/TDF interaction. The diagram involves four lifelines: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Subsequent Diameter Request to the DRA (step 2). If the PA2 option is implemented, the Client also sends a Subsequent Diameter Request directly to PCRF-1 (step 2a). The DRA then verifies its binding (step 3) and proxies the request to PCRF-1 (step 4). PCRF-1 returns a Diameter Answer to the DRA (step 5). If the PA2 option is implemented, PCRF-1 also returns a Diameter Answer directly to the Client (step 5a). Finally, the DRA proxies the Diameter Answer to the Client (step 6). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +**Figure 7.4.1.2.1.1.1: Modification of Diameter sessions through DRA (proxy)- AF/BBERF/PCEF/TDF interaction** + +1. A Client receives an external trigger (e.g. IP-CAN session modification) that requires a subsequent Diameter message to be sent to the PCRF. +2. A subsequent Diameter Request (e.g. a Diameter CCR sent by PGW to indicate modification of an IP-CAN session) as defined in clauses 4.5.1, 4a.5.1 of 3GPP TS 29.212 [9] or clause 4.4 of 3GPP TS 29.214 [10]) is sent by the Client and received by the DRA (proxy). +- 2a If PA2 option is implemented, based on Client configuration and operator policy, the Client communicates directly to the PCRF, bypassing the DRA (proxy), by using the PCRF identity obtained through the Origin-Host AVP (see step 7 in clause 5.2.5.7.1.1). The Client uses the same active Session-Id AVP value on the Diameter Request sent to the PCRF. In such a case steps 2, 3, 4, 5, 6 are not carried out. +3. After receiving a Diameter Request (Step 2), the DRA (proxy) verifies that there is an active DRA binding for the session identified in the request. +4. The DRA (proxy) proxies the Diameter Request to the target PCRF. +5. PCRF-1 returns a Diameter Answer as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9] or clause 4.4 of 3GPP TS 29.214 [10]) to the DRA (proxy). +- 5a Upon receiving a Diameter Request (Step 2a), PCRF-1 returns a Diameter Answer directly to the Client, bypassing the DRA (proxy). +6. DRA (proxy) proxies the Diameter Answer to the Client. + +NOTE: Figure 7.4.1.2.1.1.1 is also applicable when the AF/BBERF/PCEF/TDF in the VPLMN modifies the Diameter session through the V-DRA. + +###### 7.4.1.2.1.2 PCEF-initiated + +Modification of Diameter sessions occur on PCEF initiated session modifications towards the clients (AF/BBERF/PCEF). + +If PA1 option is implemented, only steps 2, 3, 4, 5, 6 are carried out. If PA2 option is implemented, only steps 2a, 5a are carried out. + +![Sequence diagram showing the modification of Diameter sessions through DRA (proxy)- PCRF interaction. The diagram involves four lifelines: Client (AF/BBERF/PCEF), DRA (proxy), PCRF-1, and PCRF-2. The interaction starts with a 'Trigger' from PCRF-1 to PCRF-2. PCRF-2 sends a 'PCRF initiated Rx/Gx/Gxx Diameter Request' to PCRF-1. PCRF-1 then sends the same request to the DRA (proxy). The DRA (proxy) performs a 'Verify DRA Binding' step. It then proxies the request to the Client. The Client returns a 'Rx/Gx/Gxx Diameter Answer' to the DRA (proxy), which in turn proxies it back to PCRF-1. A 'Legend' box indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. Two shaded regions labeled 'PA2' indicate optional paths where PCRF-1 communicates directly with the Client, bypassing the DRA (proxy).](8e80de0cac529b2c3775d677c5203133_img.jpg) + +Sequence diagram showing the modification of Diameter sessions through DRA (proxy)- PCRF interaction. The diagram involves four lifelines: Client (AF/BBERF/PCEF), DRA (proxy), PCRF-1, and PCRF-2. The interaction starts with a 'Trigger' from PCRF-1 to PCRF-2. PCRF-2 sends a 'PCRF initiated Rx/Gx/Gxx Diameter Request' to PCRF-1. PCRF-1 then sends the same request to the DRA (proxy). The DRA (proxy) performs a 'Verify DRA Binding' step. It then proxies the request to the Client. The Client returns a 'Rx/Gx/Gxx Diameter Answer' to the DRA (proxy), which in turn proxies it back to PCRF-1. A 'Legend' box indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. Two shaded regions labeled 'PA2' indicate optional paths where PCRF-1 communicates directly with the Client, bypassing the DRA (proxy). + +**Figure 7.4.1.2.1.2.1: Modification of Diameter sessions through DRA (proxy)- PCRF interaction** + +1. PCRF receives an internal or external trigger that requires a Diameter message to be sent to the clients (either AF, BBERF, PCEF) +2. A PCRF-initiated Diameter Request (e.g. a Diameter RAR request sent to the PGW) is sent to the Clients and received by the DRA (proxy). +- 2a If PA2 option is implemented, the PCRF communicates directly to the client, bypassing the DRA (proxy). In such a case steps 2, 3, 4, 5, 6 are not carried out. +3. After receiving a Diameter Request (Step 2), the DRA (proxy) verifies that there is an active DRA binding for the session identified in the request. +4. The DRA (proxy) proxies the Diameter Request to the Client. The proxied Diameter Request maintains the same Session-Id AVP value. +5. Clients returns a Diameter Answer as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9] or clause 4.4 of 3GPP TS 29.214 [10]) to the DRA (proxy). +- 5a Upon receiving a Diameter Request (Step 2a), Client returns a Diameter Answer directly to the PCRF, bypassing the DRA (proxy). +6. DRA (proxy) proxies the Diameter Answer to the PCRF. + +NOTE: Figure 7.4.1.2.1.2.1 is also applicable when the V-PCRF modifies the Diameter session through the V-DRA. + +##### 7.4.1.2.2 Roaming cases + +###### 7.4.1.2.2.1 V-PCRF initiated + +In roaming scenarios modification of Diameter sessions may occur at any of the following cases: + +- V-PCRF S9 Diameter session modification to H-PCRF +- V-PCRF proxies Rx Diameter session modification to H-PCRF + +If PA1 option is implemented, only steps 2, 3, 4, 5, 6 are carried out. If PA2 option is implemented, only steps 2a, 5a are carried out. + +![Sequence diagram showing modification of Diameter sessions through DRA (proxy) on roaming scenarios – V-PCRF initiated. The diagram involves four lifelines: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence starts with a 'Trigger' (1) at V-PCRF. V-PCRF sends an 'Rx/S9 Diameter session update' (2) to H-DRA (proxy). A conditional path (dashed line) labeled '2a' shows V-PCRF sending the update directly to H-PCRF-1. H-DRA (proxy) performs 'Verify DRA Binding' (3) and then proxies the update (4) to H-PCRF-1. H-PCRF-1 returns an 'Rx/S9 Diameter Answer' (5) to H-DRA (proxy). A conditional path (dashed line) labeled '5a' shows H-PCRF-1 returning the answer directly to V-PCRF. Finally, H-DRA (proxy) proxies the answer (6) to V-PCRF. A legend indicates that solid arrows are 'Mandatory' and dashed arrows are 'Conditional'. Two light blue shaded regions are labeled 'PA2'.](4e85fe330de2c4f5eea6de4b2a53c77f_img.jpg) + +Sequence diagram showing modification of Diameter sessions through DRA (proxy) on roaming scenarios – V-PCRF initiated. The diagram involves four lifelines: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence starts with a 'Trigger' (1) at V-PCRF. V-PCRF sends an 'Rx/S9 Diameter session update' (2) to H-DRA (proxy). A conditional path (dashed line) labeled '2a' shows V-PCRF sending the update directly to H-PCRF-1. H-DRA (proxy) performs 'Verify DRA Binding' (3) and then proxies the update (4) to H-PCRF-1. H-PCRF-1 returns an 'Rx/S9 Diameter Answer' (5) to H-DRA (proxy). A conditional path (dashed line) labeled '5a' shows H-PCRF-1 returning the answer directly to V-PCRF. Finally, H-DRA (proxy) proxies the answer (6) to V-PCRF. A legend indicates that solid arrows are 'Mandatory' and dashed arrows are 'Conditional'. Two light blue shaded regions are labeled 'PA2'. + +**Figure 7.4.1.2.2.1.1: Modification of Diameter sessions through DRA (proxy) on roaming scenarios – V-PCRF initiated** + +1. V-PCRF receives an internal or external trigger that requires a Diameter message to be sent to H-PCRF over the S9 reference point +2. V-PCRF sends a Diameter session update (e.g. an S9 session modification request) over the S9 reference point that is received by the DRA (proxy) in the home PLMN. +- 2a If PA2 option is implemented, the V-PCRF communicates directly to the H-PCRF, bypassing the H-DRA (proxy). In such a case steps 2, 3, 4, 5, 6 are not carried out. +3. After receiving a Diameter Request (Step 2), the H-DRA (proxy) verifies that there is an active DRA binding for the session identified in the request. +4. The H-DRA (proxy) proxies the Diameter Request to the H-PCRF. The proxied Diameter Request maintains the same Session-Id AVP value. +5. H-PCRF returns a Diameter Answer to the H-DRA (proxy) in the home PLMN. +- 5a Upon receiving a Diameter Request (Step 2a), Client returns a Diameter Answer directly to the PCRF, bypassing the H-DRA (proxy). +6. H-DRA (proxy) proxies the Diameter Answer to the PCRF. + +###### 7.4.1.2.2.2 H-PCRF initiated + +In roaming scenarios modification of Diameter sessions may occur at any of the following cases: + +- H-PCRF S9 Diameter session modification to V-PCRF + +If PA1 option is implemented, only steps 2, 3, 4, 5, 6 are carried out. If PA2 option is implemented, only steps 2a, 5a are carried out. + +![Sequence diagram showing modification of Diameter sessions through DRA (proxy) on roaming scenarios – H-PCRF initiated. The diagram involves four entities: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence starts with H-PCRF-1 sending a 'Trigger' (1) to H-DRA (proxy). H-DRA (proxy) sends an 'S9 Diameter Request' (2) to H-PCRF-1. H-PCRF-1 then sends an 'S9 Diameter Request' (2a) to V-PCRF. H-DRA (proxy) performs a 'Verify DRA Binding' (3). H-DRA (proxy) sends a 'Proxy S9 Diameter Request' (4) to V-PCRF. V-PCRF returns an 'S9 Diameter Answer' (5) to H-DRA (proxy). H-DRA (proxy) then sends a 'Proxy S9 Diameter Answer' (6) to H-PCRF-1. A 'Legend' box indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. The diagram is divided into two sections labeled PA2.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +sequenceDiagram + participant H-PCRF-1 + participant H-DRA as H-DRA (proxy) + participant V-PCRF + participant H-PCRF-2 + + Note left of H-PCRF-1: PA2 + H-PCRF-1->>H-DRA: 1. Trigger + H-DRA->>H-PCRF-1: 2. S9 Diameter Request + H-PCRF-1->>V-PCRF: 2a. S9 Diameter Request + Note right of H-DRA: 3. Verify DRA Binding + H-DRA->>V-PCRF: 4. Proxy S9 Diameter Request + V-PCRF->>H-DRA: 5. S9 Diameter Answer + Note left of H-PCRF-1: PA2 + V-PCRF->>H-PCRF-1: 5a. S9 Diameter Answer + H-DRA->>H-PCRF-1: 6. Proxy S9 Diameter Answer + + Note right of H-PCRF-2: Legend: + solid arrow --> Mandatory + dashed arrow --> Conditional + +``` + +Sequence diagram showing modification of Diameter sessions through DRA (proxy) on roaming scenarios – H-PCRF initiated. The diagram involves four entities: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence starts with H-PCRF-1 sending a 'Trigger' (1) to H-DRA (proxy). H-DRA (proxy) sends an 'S9 Diameter Request' (2) to H-PCRF-1. H-PCRF-1 then sends an 'S9 Diameter Request' (2a) to V-PCRF. H-DRA (proxy) performs a 'Verify DRA Binding' (3). H-DRA (proxy) sends a 'Proxy S9 Diameter Request' (4) to V-PCRF. V-PCRF returns an 'S9 Diameter Answer' (5) to H-DRA (proxy). H-DRA (proxy) then sends a 'Proxy S9 Diameter Answer' (6) to H-PCRF-1. A 'Legend' box indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. The diagram is divided into two sections labeled PA2. + +**Figure 7.4.1.2.2.2.1: Modification of Diameter sessions through DRA (proxy) on roaming scenarios – H-PCRF initiated** + +1. H-PCRF receives an internal or external trigger that requires a Diameter message to be sent to V-PCRF over the S9 reference point. +2. H-PCRF sends a Diameter session update (e.g. an S9 session modification request) over the S9 reference point that is received by the H-DRA (proxy) in the home PLMN. +- 2a If PA2 option is implemented, the H-PCRF communicates directly to the V-PCRF, bypassing the H-DRA (proxy). In such a case steps 2, 3, 4, 5, 6 are not carried out. +3. After receiving a Diameter Request (Step 2), the H-DRA (proxy) verifies that there is an active DRA binding for the session identified in the request. +4. The H-DRA (proxy) proxies the Diameter Request to the V-PCRF. The proxied Diameter Request maintains the same Session-Id AVP value. +5. V-PCRF returns a Diameter Answer to the H-DRA (proxy) in the home PLMN. +- 5a Upon receiving a Diameter Request (Step 2a), V-PCRF returns a Diameter Answer directly to the H-PCRF, bypassing the H-DRA (proxy). +6. H-DRA (proxy) proxies the Diameter Answer to the H-PCRF. + +#### 7.4.1.3 Termination of Diameter Sessions + +##### 7.4.1.3.1 Non-roaming cases + +The procedures required are identical for both PA1 and PA2 options + +Termination of Diameter sessions occur at the following cases: + +- Gateway control session termination +- IP-CAN session termination +- AF session termination +- For unsolicited application reporting, TDF session termination + +![Sequence diagram showing the termination of Diameter sessions through a DRA (proxy). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The sequence of messages is: 1. External trigger to Client; 2. Rx/Gx/Gxx/Sd Diameter Termination Request from Client to DRA; 3. Verify DRA binding (conditional) from DRA; 4. Proxy Rx/Gx/Gxx/Sd Diameter Termination Request from DRA to PCRF-1; 5. Rx/Gx/Gxx/Sd Diameter Answer from PCRF-1 to DRA; 6. Remove DRA binding (conditional) from DRA; 7. Proxy Rx/Gx/Gxx/Sd Diameter Answer from DRA to Client. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant Client as Client (AF/BBERF/PCEF/TDF) + participant DRA as DRA (proxy) + participant PCRF1 as PCRF-1 + participant PCRF2 as PCRF-2 + + Note left of Client: 1. External trigger + Client->>DRA: 2. Rx/Gx/Gxx/Sd Diameter Termination Request + Note right of DRA: 3. Verify DRA binding + DRA->>PCRF1: 4. Proxy Rx/Gx/Gxx/Sd Diameter Termination Request + PCRF1-->>DRA: 5. Rx/Gx/Gxx/Sd Diameter Answer + Note right of DRA: 6. Remove DRA binding + DRA-->>Client: 7. Proxy Rx/Gx/Gxx/Sd Diameter Answer + + Note right of PCRF2: Legend: + Note right of PCRF2: --> Mandatory + Note right of PCRF2: -.-> Conditional + +``` + +Sequence diagram showing the termination of Diameter sessions through a DRA (proxy). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (proxy), PCRF-1, and PCRF-2. The sequence of messages is: 1. External trigger to Client; 2. Rx/Gx/Gxx/Sd Diameter Termination Request from Client to DRA; 3. Verify DRA binding (conditional) from DRA; 4. Proxy Rx/Gx/Gxx/Sd Diameter Termination Request from DRA to PCRF-1; 5. Rx/Gx/Gxx/Sd Diameter Answer from PCRF-1 to DRA; 6. Remove DRA binding (conditional) from DRA; 7. Proxy Rx/Gx/Gxx/Sd Diameter Answer from DRA to Client. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +**Figure 7.4.1.3.1.1: Termination of Diameter sessions through DRA (proxy)** + +1. A Client receives an external trigger (e.g. an IP-CAN session termination is initiated by the UE or PCRF) that requires the sending of a Diameter Termination Request. +2. A Diameter Termination Request (e.g., a Diameter CCR sent by PGW to indicate termination of an IP-CAN session) as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9]) is sent by the Client to the DRA (proxy). The message uses the same Session-Id AVP value of the active Diameter session established between the Client and PCRF-1. +3. The DRA (proxy) verifies that there is an active DRA binding for the IP-CAN session based on the Session-Id AVP in the request. +4. The DRA (proxy) proxies the Diameter Termination Request to the target PCRF. The proxied Diameter Request maintains the same Session-Id AVP value. +5. PCRF-1 acknowledges termination of the session. PCRF-1 sends a Diameter Answer, (e.g., as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9]) to DRA (proxy). +6. The DRA marks the Diameter session terminated. If the DRA binding is per IP-CAN session and all the Diameter sessions (i.e. the Gx session or the Gxx session) of the IP-CAN session are terminated or if the DRA binding is per UE and all the Diameter sessions (i.e. the Gx session or the Gxx session) of that UE are terminated the DRA (proxy) removes the DRA binding. +7. DRA (proxy) proxies the Diameter Answer to the Client. The proxied Diameter Answer maintains the same Session-Id AVP value. + +NOTE 1: Figure 7.4.1.3.1.1 is also applicable when the AF/BBERF/PCEF/TDF in the VPLMN terminates the Diameter sessions through the V-DRA. + +NOTE 2: AF/TDF is not required to send Diameter session termination request to DRA (PA2). + +##### 7.4.1.3.2 Roaming cases + +In roaming cases (over S9 reference point) termination of Diameter sessions occur at the following cases: + +- S9 session termination +- AF session termination + +![Sequence diagram illustrating the termination of Diameter sessions through H-DRA (proxy) in roaming cases. The diagram shows four lifelines: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence of messages is: 1. External trigger (solid arrow) to V-PCRF; 2. S9/Rx Diameter Termination Request (solid arrow) from V-PCRF to H-DRA (proxy); 3. Verify DRA binding (dashed arrow) from H-DRA (proxy) to itself; 4. Proxy S9/Rx Diameter Termination Request (solid arrow) from H-DRA (proxy) to H-PCRF-1; 5. S9/Rx Diameter Answer (solid arrow) from H-PCRF-1 to H-DRA (proxy); 6. Remove DRA binding (dashed arrow) from H-DRA (proxy) to itself; 7. Proxy S9/Rx Diameter Answer (solid arrow) from H-DRA (proxy) to V-PCRF. A legend indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages.](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +Sequence diagram illustrating the termination of Diameter sessions through H-DRA (proxy) in roaming cases. The diagram shows four lifelines: V-PCRF, H-DRA (proxy), H-PCRF-1, and H-PCRF-2. The sequence of messages is: 1. External trigger (solid arrow) to V-PCRF; 2. S9/Rx Diameter Termination Request (solid arrow) from V-PCRF to H-DRA (proxy); 3. Verify DRA binding (dashed arrow) from H-DRA (proxy) to itself; 4. Proxy S9/Rx Diameter Termination Request (solid arrow) from H-DRA (proxy) to H-PCRF-1; 5. S9/Rx Diameter Answer (solid arrow) from H-PCRF-1 to H-DRA (proxy); 6. Remove DRA binding (dashed arrow) from H-DRA (proxy) to itself; 7. Proxy S9/Rx Diameter Answer (solid arrow) from H-DRA (proxy) to V-PCRF. A legend indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. + +**Figure 7.4.1.3.2.1: Termination of Diameter sessions through H-DRA (proxy) – Roaming cases** + +1. The V-PCRF receives an external trigger (e.g., session termination request from the BBERF or the PCEF) that requires the sending of a Diameter Termination Request. +2. A Diameter Termination Request (e.g., an S9 termination request) is sent by the V-PCRF and received by the H-DRA (proxy) in the home PLMN. The message uses the same Session-Id AVP value of the active Diameter session established between V-PCRF and H-PCRF-1. +3. The H-DRA (proxy) verifies that there is an active DRA binding for the IP-CAN session based on the Session-Id AVP in the request. +4. The H-DRA (proxy) proxies the Diameter Termination Request to the target H-PCRF-1. The proxied Diameter Request maintains the same Session-Id AVP value. +5. H-PCRF-1 acknowledges termination of the session. H-PCRF-1 sends a Diameter Answer to H-DRA (proxy) in the home PLMN. +6. The H-DRA marks the Diameter session terminated. If all the Diameter sessions (i.e. the S9 session, the Gxx session, and the Gx session) of that UE are terminated the H-DRA (proxy) removes the DRA binding. +7. H-DRA (proxy) proxies the Diameter Answer to the V-PCRF. The proxied Diameter Answer maintains the same Session-Id AVP value. + +NOTE: V-PCRF does not need to send Rx Diameter termination messages to proxy H-DRA (PA2 option) since Rx Diameter termination messages do not affect the DRA binding. + +### 7.4.2 Redirect DRA + +#### 7.4.2.1 Establishment of Diameter Sessions + +##### 7.4.2.1.1 Non-roaming cases + +Establishment of Diameter sessions may occur at the following cases: + +- Gateway control session establishment +- IP-CAN session establishment + +- AF session establishment +- For unsolicited application reporting, TDF session establishment + +The DRA client (AF/BBERF/PCEF/TDF) shall follow the procedure below if an appropriate cached route table entry created from previous DRA (redirect) interactions does not exist. Cached route table entries are created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs as described in sections 6.12, 6.13 and 6.14 of IETF RFC 6733 [61]. + +![Sequence diagram showing the establishment of a Diameter session through DRA (redirect). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (redirect), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Diameter Establishment Request to the DRA. The DRA performs a binding creation/retrieval. The DRA sends a Diameter Answer (redirect) to the Client. The Client then re-sends the Diameter Establishment Request to PCRF-1. PCRF-1 sends a Diameter Answer back to the Client. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages.](6d6670b8e65d3ff8126e5ab9aeaffbd8_img.jpg) + +``` + +sequenceDiagram + participant Client as Client (AF/BBERF/PCEF/TDF) + participant DRA as DRA (redirect) + participant PCRF1 as PCRF-1 + participant PCRF2 as PCRF-2 + + Note left of Client: 1. External trigger + Client->>DRA: 2. Rx/Gx/Gxx/Sd Diameter Establishment Request + Note right of DRA: 3. DRA binding creation/retrieval + DRA-->>Client: 4. Diameter Answer (redirect) + Client->>PCRF1: 5. Rx/Gx/Gxx/Sd Diameter Establishment Request + PCRF1-->>Client: 6. Rx/Gx/Gxx/Sd Diameter Answer + +``` + +Sequence diagram showing the establishment of a Diameter session through DRA (redirect). The diagram involves four main entities: Client (AF/BBERF/PCEF/TDF), DRA (redirect), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Diameter Establishment Request to the DRA. The DRA performs a binding creation/retrieval. The DRA sends a Diameter Answer (redirect) to the Client. The Client then re-sends the Diameter Establishment Request to PCRF-1. PCRF-1 sends a Diameter Answer back to the Client. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +**Figure 7.4.2.1.1.1: Establishment of Diameter session through DRA (redirect)** + +1. A Client receives an external trigger (e.g., IP-CAN session establishment request) that requires the establishment of a Diameter session with a PCRF. +2. A Diameter Establishment request (e.g., a Diameter CCR sent by PGW to indicate establishment of an IP-CAN session as defined in clauses 4.5.1, 4a.5.1 of 3GPP TS 29.212 [9]) with user information (e.g., UE-NAI) is sent by the Client and received by the DRA (redirect). +3. The DRA (redirect) stores the user information (e.g., UE-NAI) and checks whether an active DRA binding exists. If not the DRA creates a dynamic DRA binding (assignment of a PCRF node per UE or per IP-CAN session); if the DRA (redirect) find there has been a DRA binding for the user, the DRA shall select the PCRF from the binding for the client. +4. The DRA (redirect) sends a Diameter Answer indicating redirection as defined in IETF RFC 6733 [61]. The target PCRF identity is included in the Redirect-Host AVP. +5. The Client re-sends the Diameter Establishment Request of step 2 to the target PCRF. +6. PCRF-1 returns a Diameter Answer, as defined in clauses 4.5, 4a.5 of 3GPP TS 29.212 [9], to the Client. + +NOTE: Figure 7.4.2.1.1.1 is also applicable when the AF/BBERF/PCEF/TDF in the VPLMN contacts the V-DRA to locate the V-PCRF. + +##### 7.4.2.1.2 Roaming cases + +Establishment of Diameter sessions may occur at the following cases: + +- S9 session availability +- AF session establishment + +The DRA client (AF/BBERF/PCEF) shall follow the procedure below if an appropriate cached route table entry created from previous DRA (redirect) interactions does not exist. Cached route table entries are created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs as described in clause 6.12, 6.13 and 6.14 of IETF RFC 6733 [61]. + +![Sequence diagram showing the establishment of a Diameter session through DRA (redirect) in a roaming scenario. The diagram involves four main entities: V-PCRF, H-DRA (redirect), H-PCRF-1, and H-PCRF-2. The sequence of messages is: 1. External trigger to V-PCRF; 2. Rx/S9 Diameter Establishment Request from V-PCRF to H-DRA; 3. DRA binding creation/retrieval at H-DRA; 4. Diameter Answer (redirect) from H-DRA to V-PCRF; 5. Rx/S9 Diameter Establishment Request from V-PCRF to H-PCRF-1; 6. Rx/S9 Diameter Answer from H-PCRF-1 to V-PCRF. A legend indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages.](163688ca8da9787f5d48edd68d8cc75b_img.jpg) + +``` + +sequenceDiagram + participant External + participant V-PCRF + participant H-DRA as H-DRA (redirect) + participant H-PCRF-1 + participant H-PCRF-2 + + Note right of H-PCRF-2: Legend: + + -->> Mandatory + + -.->> Conditional + + External->> V-PCRF: 1. External trigger + V-PCRF->> H-DRA: 2. Rx/S9 Diameter Establishment Request + Note right of H-DRA: 3. DRA binding creation/retrieval + H-DRA-->> V-PCRF: 4. Diameter Answer (redirect) + V-PCRF->> H-PCRF-1: 5. Rx/S9 Diameter Establishment Request + H-PCRF-1-->> V-PCRF: 6. Rx/S9 Diameter Answer + +``` + +Sequence diagram showing the establishment of a Diameter session through DRA (redirect) in a roaming scenario. The diagram involves four main entities: V-PCRF, H-DRA (redirect), H-PCRF-1, and H-PCRF-2. The sequence of messages is: 1. External trigger to V-PCRF; 2. Rx/S9 Diameter Establishment Request from V-PCRF to H-DRA; 3. DRA binding creation/retrieval at H-DRA; 4. Diameter Answer (redirect) from H-DRA to V-PCRF; 5. Rx/S9 Diameter Establishment Request from V-PCRF to H-PCRF-1; 6. Rx/S9 Diameter Answer from H-PCRF-1 to V-PCRF. A legend indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. + +**Figure 7.4.2.1.2.1: Establishment of Diameter session through DRA (redirect) – Roaming scenario** + +1. The V-PCRF receives an external trigger (e.g., IP-CAN session establishment request) that requires the establishment of a Diameter session with an H-PCRF over the S9 reference point. +2. A Rx/S9 Diameter Establishment Request with user information (e.g., UE-NAI) is sent by the V-PCRF and received by the H-DRA (redirect) in the home PLMN. +3. The H-DRA (redirect) stores the user information (e.g., UE-NAI) and checks whether an active DRA binding exists. If not the H-DRA creates a dynamic DRA binding (assignment of a PCRF node per UE); if the DRA (redirect) find there has been a DRA binding for the user, the DRA shall select the PCRF from the binding for the client. +4. The H-DRA (redirect) sends a Diameter Answer indicating redirection as defined in IETF RFC 6733 [61]. The target PCRF identity is included in the Redirect-Host AVP. +5. The V-PCRF re-sends the Rx/S9 Diameter Establishment Request of step 2 to the target H-PCRF. +6. H-PCRF-1 returns a corresponding Diameter Answer to the V-PCRF. + +NOTE: The V-PCRF may proxy the Rx Diameter Establishment Request to the H-PCRF directly (e.g. based on the stored information provided by H-DRA during the S9 Diameter session establishment). + +#### 7.4.2.2 Modification of Diameter sessions + +The PCEF shall send the Diameter session modification message to the DRA to update the DRA binding information only if the UE's address(es) is updated and the DRA (redirect) is maintaining PCRF routing information per IP-CAN session. For visited access case, the V-PCRF shall send the Diameter session modification message to the H-DRA to update the DRA binding information only if the UE's address(es) is updated. The detailed procedure is similar to the Establishment of Diameter sessions, which is described in the clause 7.4.2.1. + +#### 7.4.2.3 Termination of Diameter Sessions + +##### 7.4.2.3.1 Non-roaming cases + +Termination of Diameter sessions that impact the DRA binding occur at the following cases: + +- Gateway control session termination +- IP-CAN session termination + +The DRA client (BBERF/PCEF) shall follow the procedure below if the DRA (redirect) is maintaining PCRF routing information per IP-CAN session or an appropriate cached route table entry created from previous DRA (redirect) interactions does not exist. Cached route table entries are created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs as described in clause 6.12, 6.13 and 6.14 of IETF RFC 6733 [61]. + +![Sequence diagram showing the termination of Diameter sessions through DRA (redirect). The diagram involves four entities: Client (BBERF/PCEF), DRA (redirect), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Gx/Gxx Diameter Termination Request to the DRA (step 2) and another to PCRF-1 (step 3). The DRA performs a binding verification/release (step 4) and sends a Diameter Redirect Answer to the Client (step 5). Finally, PCRF-1 sends a Gx/Gxx Diameter Answer to the Client (step 6). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages.](6324b252294c0f5d4e34dad4a1202075_img.jpg) + +``` + +sequenceDiagram + participant Client as Client (BBERF/PCEF) + participant DRA as DRA (redirect) + participant PCRF1 as PCRF-1 + participant PCRF2 as PCRF-2 + + Note left of Client: 1. External trigger + Client->>DRA: 2. Gx/Gxx Diameter Termination Request + Client->>PCRF1: 3. Gx/Gxx Diameter Termination Request + Note right of DRA: 4. DRA binding verification/release + DRA-->>Client: 5. Diameter Redirect Answer + PCRF1-->>Client: 6. Gx/Gxx Diameter Answer + +``` + +Sequence diagram showing the termination of Diameter sessions through DRA (redirect). The diagram involves four entities: Client (BBERF/PCEF), DRA (redirect), PCRF-1, and PCRF-2. The process starts with an external trigger to the Client. The Client sends a Gx/Gxx Diameter Termination Request to the DRA (step 2) and another to PCRF-1 (step 3). The DRA performs a binding verification/release (step 4) and sends a Diameter Redirect Answer to the Client (step 5). Finally, PCRF-1 sends a Gx/Gxx Diameter Answer to the Client (step 6). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +**Figure 7.4.2.3.1.1: Termination of Diameter sessions through DRA (redirect)** + +1. Client receives an external trigger (e.g. an IP-CAN session termination is initiated by the UE or PCRF) that triggers the client to terminate Diameter session with server (i.e. PCRF) +- 2 A Diameter Termination Request (e.g., as defined in clauses 4.5.7 (Gx) and 4a.5.3 (Gxx) of 3GPP TS 29.212 [9]) is sent by the Client to the DRA (redirect). +3. A Diameter Termination Request (e.g., as defined in clauses 4.5.7 (Gx) and 4a.5.3 (Gxx) of 3GPP TS 29.212 [9]) is sent by the Client to PCRF-1. The message uses the same Session-Id AVP value of the active Diameter session established between the Client and PCRF-1. + +NOTE: Steps 2, 3 may be carried out in parallel. Otherwise, the client after step 2 may need to wait for the redirect answer before sending the Diameter termination request to the PCRF. + +4. DRA (redirect) verifies that there is an active DRA binding for the IP-CAN session based on the Session-Id AVP and marks the Diameter session terminated. If the DRA binding is per IP-CAN session and all the Diameter sessions (i.e. Gx session or Gxx session) of that IP-CAN session are terminated or if the DRA binding is per UE and all the Diameter sessions (i.e. Gx session or Gxx session) of that UE are terminated the DRA removes the DRA binding. +- 5 DRA (redirect) acknowledges termination of the session by sending a Diameter redirect answer to the client. +- 6 PCRF-1 acknowledges termination of session. PCRF-1 sends a Diameter Answer (e.g., as defined in clauses 4.5.7 (Gx) and 4a.5.3 (Gxx) of 3GPP TS 29.212 [9]) to the Client. + +**NOTE:** Figure 7.4.2.3.1.1 is also applicable when the BBERF/PCEF in the VPLMN terminates the Diameter sessions through the V-DRA. + +##### 7.4.2.3.2 Roaming cases + +Termination of Diameter sessions occur at the following cases: + +- S9 session termination + +The DRA client (AF/BBERF/PCEF) shall follow the procedure below) if the DRA (redirect) is maintaining PCRF routing information per IP-CAN session or an appropriate cached route table entry created from previous DRA (redirect) interactions does not exist. Cached route table entries are created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs as described in clause 6.12, 6.13 and 6.14 of IETF RFC 6733 [61]. + +![Sequence diagram showing the termination of Diameter sessions through DRA (redirect) in a roaming case. Lifelines: V-PCRF, H-DRA (redirect), H-PCRF-1, H-PCRF-2. 1. External trigger at V-PCRF. 2. V-PCRF sends S9 Diameter Termination Request to H-DRA. 3. V-PCRF sends S9 Diameter Termination Request to H-PCRF-1. 4. H-DRA performs DRA binding verification/release. 5. H-DRA sends Diameter Redirect Answer to V-PCRF. 6. H-PCRF-1 sends S9 Diameter Answer to V-PCRF.](d980a3f9608055996a07f31788baf827_img.jpg) + +``` + +sequenceDiagram + participant V-PCRF + participant H-DRA as H-DRA (redirect) + participant H-PCRF-1 + participant H-PCRF-2 + + Note left of V-PCRF: 1. External trigger + V-PCRF->>H-DRA: 2. S9 Diameter Termination Request + V-PCRF->>H-PCRF-1: 3. S9 Diameter Termination Request + Note over H-DRA: 4. DRA binding verification/release + H-DRA->>V-PCRF: 5. Diameter Redirect Answer + H-PCRF-1->>V-PCRF: 6. S9 Diameter Answer + +``` + +**Legend:** + → Mandatory + - - → Conditional + +Sequence diagram showing the termination of Diameter sessions through DRA (redirect) in a roaming case. Lifelines: V-PCRF, H-DRA (redirect), H-PCRF-1, H-PCRF-2. 1. External trigger at V-PCRF. 2. V-PCRF sends S9 Diameter Termination Request to H-DRA. 3. V-PCRF sends S9 Diameter Termination Request to H-PCRF-1. 4. H-DRA performs DRA binding verification/release. 5. H-DRA sends Diameter Redirect Answer to V-PCRF. 6. H-PCRF-1 sends S9 Diameter Answer to V-PCRF. + +**Figure 7.4.2.3.2.1: Termination of Diameter sessions through DRA (redirect) – Roaming case** + +1. V-PCRF receives an external trigger (e.g. session termination request from the BBERF, PCEF) that requires the sending of a Diameter Termination Reqeust. +- 2 A Diameter Termination Request is sent by the V-PCRF and received by the H-DRA (redirect) in the home PLMN. +3. A Diameter Termination Request is sent by the V-PCRF to H-PCRF-1. The message uses the same Session-Id AVP value of the active Diameter session established between theV-PCRF and H-PCRF-1. + +**NOTE:** Steps 2, 3 may be carried out in parallel. Otherwise, the V-PCRF after step2 may need to wait for the redirect answer before sending the Diameter termination request to the H-PCRF + +4. H-DRA (redirect) verifies that there is an active DRA binding for the IP-CAN session based on the Session-Id AVP and marks the Diameter session terminated. If all the Diameter sessions (i.e. S9 session, Gxx session, Gx session) of that UE are terminated the H-DRA removes the DRA binding. +- 5 H-DRA (redirect) acknowledges termination of the session by sending a Diameter redirect answer to the V-PCRF. +- 6 H-PCRF-1 acknowledges termination of the session by sending a Diameter answer to the V-PCRF. + +**NOTE:** Rx Diameter termination messages are not required to be sent to H-DRA (redirect) since such messages do not affect the DRA binding + +# 8 Diameter race condition handling + +## 8.1 Overview + +Certain Diameter PCC applications (Gx, Gxx, Sd, S9) allow the server (PCRF for Gx, Gxx, Sd, H-PCRF for S9) to update a session in two ways: unsolicited and solicited. The PCRF can push policy decisions and provision event triggers in an unsolicited fashion using an RAR. It can also install policy decisions in a solicited manner by responding to a CCR sent by the client (BBERF for Gxx, PCEF for Gx, TDF for Sd, V-PCRF for S9). + +The client and the server can initiate transactions that modify the state of the session independently (e.g. CCR from the client and RAR from the server) and potentially concurrently. Additionally, there may be Diameter agents in between the client and server (e.g. DRA or in general Diameter relays/proxies) that could cause messages to be delivered out of order. This can lead to race conditions that may result in the wrong information maintained by the client and/or server for a session. + +Note that race conditions occur in different ways based on the application. Also, their impact is specific to the application. For example, even though Gx is based on DCCA (RFC 4006), Gx is much more vulnerable to race conditions as Gx allows sessions to be updated based on RARs and CCAs whereas DCCA only allows the server to update the session based on a CCA. The RAR is merely used to solicit the client to send a CCR. + +## 8.2 Procedures for Gx, Gxx, Sd and S9 + +This clause describes the optional procedures for handling Diameter race conditions in a deterministic manner for the following interfaces: Gx, Gxx, Sd and S9. These procedures apply to the PCEF (Gx), BBERF (Gxx), TDF (Sd) and PCRF (Gx, Gxx, Sd and S9). + +In this clause, the terms “client” and “server” are relative to the session context. As an example, for the Gx interface, the client is the PCEF and the server is the PCRF. The term “node” can refer to either a client or a server. The term “transaction” refers to a Diameter request and its associated answer. The term “ongoing transaction” refers to a transaction that has an outstanding answer. + +A node that supports the procedures defined in this clause and is configured to comply with them, shall advertise such support by setting the corresponding PendingTransaction feature bit in the Supported-Features AVP during session establishment as defined in 3GPP TS 29.212 [9] for Gx, Gxx and Sd and 3GPP TS 29.215 [22] for S9. + +On receipt of a Diameter request for an existing Diameter session, the recipient Diameter node shall check if it has an ongoing transaction on that session: + +1. If there are no ongoing transactions on the session, the node shall process the incoming request normally. +2. If there is an ongoing transaction on the session and optionally, if the recipient node cannot determine that the incoming request can be safely handled without creating a state mismatch: + - a. The client shall reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION as defined in 3GPP TS 29.212 [9]. + - b. The server shall either reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION or shall wait for one of the following conditions to occur: + - i. The ongoing transaction completes. In this case, the session is updated at the server based on the completion of the ongoing transaction and afterwards, the incoming request (e.g. CCR) is processed normally based on the updated session state. + - ii. The waiting period has exceeded its allotted time. In this case, the server shall reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION. + +NOTE 1: If there is an ongoing transaction on the session and optionally, if the recipient node can determine that the incoming request can be safely handled without creating a state mismatch, the client and the server could handle the incoming request normally. + +3. On receipt of a DIAMETER\_PENDING\_TRANSACTION result code, a client shall retry the request. On the other hand, if a server had rejected a request from the client with a DIAMETER\_PENDING\_TRANSACTION, the server should not retry the failed request until it responds to the re-attempted request from the client. This is to avoid having both the client and server concurrently retry their requests. In all other cases, if the session on the client still needs to be updated, the server shall retry the request. + +NOTE 2: The server retries the request either by resending the command (e.g. RAR) or by including the initial requested information in the command (e.g. CCA) answering the re-attempted request from the client. However, including the initial requested information in the command (e.g. CCA) answering the re-attempted request is only possible if the server does not require a response to the command. + +4. Nodes should limit the number of times they re-attempt the same request due to receipt of a DIAMETER\_PENDING\_TRANSACTION. +5. The only exception to the rules above is a session termination request (e.g. CCR with a CC-Request-Type AVP set to TERMINATION\_REQUEST) or a request for session release (e.g. RAR with Session-Release-Cause AVP). In both cases, the request should be handled as follows: + - a. When receiving a request for a session release that requires new transactions to be initiated, a client shall acknowledge the request immediately (e.g. a RAR command with Session-Release-Cause AVP shall be acknowledged with a RAA command). The client shall wait for the current transaction to complete (either by the server acknowledging the request or rejecting it with DIAMETER\_PENDING\_TRANSACTION) before completing the session termination procedure (e.g. before sending the CCR command with the CC-Request-Type set to TERMINATION\_REQUEST). + +NOTE 3: The client needs to wait for the outcome of the session modification to determine if the session termination procedure will be used to report information that could not be reported as part of the session modification procedure. + +NOTE 4: After having sent a request for session termination, the server acknowledges any unrelated incoming request immediately (either by the server acknowledging the request or rejecting it with DIAMETER\_PENDING\_TRANSACTION) without a waiting period. + +- b. When receiving a session termination request the server shall handle it immediately. + +# --- Annex A (informative): Examples of deriving the Maximum Authorized parameters from the SDP parameters + +# --- Annex B (normative): Signalling Flows for IMS + +The signalling flows in clause 4 are also applicable for IMS. This Annex adds flows that show interactions with SIP/SDP signalling of the IMS. + +## --- B.0 General + +The following is applicable for Emergency Services and PSAP call back request: + +- The P-CSCF includes an Emergency indication when service information is sent over Rx and when required by the IMS deployment, the P-CSCF may also indicate that it requires EPC-level user information as defined in 3GPP TS 29.214 [10]. +- The PCRF only allows Emergency Sessions that are bound to an IP-CAN session established to an Emergency APN. +- Upon request from the P-CSCF, the PCRF provides the P-CSCF with EPC-level user information corresponding to the established IP-CAN session. + +The following is not applicable for Emergency Services and PSAP call back request: + +- Pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. +- Subscription to notification of Signalling Path Status at IMS Registration, subscription to notification of changes of IP-CAN type at IMS Registration and Provisioning of SIP Signalling flow information at IMS Registration procedures. + +### --- B.1 Subscription to Notification of Signalling Path Status at IMS Registration + +This clause covers the optional Subscription to Notifications of IMS Signalling Path Status upon an initial successful IMS Registration procedure. + +![Sequence diagram showing the subscription to notification of IMS signaling path status at initial IMS registration. The diagram involves three entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. SIP REGISTER (P-CSCF to external), 3. 200 OK (external to P-CSCF), 4. 200 OK (P-CSCF to UE), 5. Diameter AAR (P-CSCF to PCRF), 6. Session Binding (PCRF internal), 7. Diameter AAA (PCRF to P-CSCF), 8. Subscribe to Bearer Level Event (PCRF internal, optional). A legend indicates that solid arrows are mandatory and dashed arrows are optional. Solid arrow Dashed arrow](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>External: 2. SIP REGISTER + External->>P-CSCF: 3. 200 OK + P-CSCF->>UE: 4. 200 OK + P-CSCF->>PCRF: 5. Diameter AAR + Note over PCRF: 6. Session Binding + PCRF->>P-CSCF: 7. Diameter AAA + Note over PCRF: 8. Subscribe to Bearer Level Event + +``` + +Legend: + +Mandatory + Optional + +Sequence diagram showing the subscription to notification of IMS signaling path status at initial IMS registration. The diagram involves three entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. SIP REGISTER (P-CSCF to external), 3. 200 OK (external to P-CSCF), 4. 200 OK (P-CSCF to UE), 5. Diameter AAR (P-CSCF to PCRF), 6. Session Binding (PCRF internal), 7. Diameter AAA (PCRF to P-CSCF), 8. Subscribe to Bearer Level Event (PCRF internal, optional). A legend indicates that solid arrows are mandatory and dashed arrows are optional. Solid arrow Dashed arrow + +**Figure B.1.1: Subscription to Notification of IMS Signaling Path Status at initial IMS Registration** + +- 1-4. The user initiates an initial SIP Registration procedure. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +5. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to the status of the IMS Signaling path. The P-CSCF sends a Diameter AAR command to the PCRF. +6. The PCRF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. +7. The PCRF confirms the subscription to IMS Signaling path status and replies with a Diameter AAA command back to the P-CSCF. +8. If the PCRF had not previously subscribed to the required bearer level events from the IP-CAN for the affected PCC/QoS Rules, then the PCRF shall do so now. The PCRF initiates procedures according to figure 4.3.1.1.1. + +#### B.1a Subscription to Notification of Change of IP-CAN Type at IMS Registration + +This clause covers the optional Subscription to Notifications of change in the type of IP-CAN upon an initial IMS Registration procedure. + +![Sequence diagram showing the subscription to notification of change of IP-CAN Type at initial IMS Registration. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Session Binding (internal PCRF process), 4. Diameter AAA (PCRF to P-CSCF), 5. SIP REGISTER (P-CSCF to external server), 6. 200 OK (external server to P-CSCF), 7. 200 OK (P-CSCF to UE), and 8. Subscribe to Bearer Level Event (PCRF to P-CSCF, optional). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent optional messages.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>PCRF: 2. Diameter AAR + Note over PCRF: 3. Session Binding + PCRF->>P-CSCF: 4. Diameter AAA + P-CSCF->>External: 5. SIP REGISTER + External-->>P-CSCF: 6. 200 OK + P-CSCF-->>UE: 7. 200 OK + PCRF-->>P-CSCF: 8. Subscribe to Bearer Level Event + +``` + +Legend: + +- > Mandatory +- - - -> Optional + +Sequence diagram showing the subscription to notification of change of IP-CAN Type at initial IMS Registration. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Session Binding (internal PCRF process), 4. Diameter AAA (PCRF to P-CSCF), 5. SIP REGISTER (P-CSCF to external server), 6. 200 OK (external server to P-CSCF), 7. 200 OK (P-CSCF to UE), and 8. Subscribe to Bearer Level Event (PCRF to P-CSCF, optional). A legend indicates that solid arrows represent mandatory messages and dashed arrows represent optional messages. + +**Figure B.1.2: Subscription to Notification of change of IP-CAN Type at initial IMS Registration** + +- 1.- The user initiates an initial SIP Registration procedure. + 2. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to the notification of IP-CAN Type Change. The P-CSCF sends a Diameter AAR command to the PCRF. +- NOTE: It should be possible for the P-CSCF to request the subscription to notification of IMS Signalling path status and PLMN changes also in this step. +3. The PCRF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. + 4. The PCRF confirms the subscription to notification of change of IP-CAN type and replies with a Diameter AAA command back to the P-CSCF. The PCRF includes in the response the type of IP-CAN currently in use. + - 5-7. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). + 8. If the PCRF had not previously subscribed to the required bearer level event from the IP-CAN (i.e. IP-CAN type change and RAT type change, if applicable), then the PCRF shall do so now. The PCRF initiates procedures according to figure 4.3.1.1.1. + +#### B.1b Provisioning of SIP signalling flow information at IMS Registration + +This clause covers the optional Provisioning of SIP signalling flow information upon an initial successful IMS Registration procedure. + +![Sequence diagram showing the provisioning of SIP signalling flow information at initial IMS registration between UE, PCRF, and P-CSCF.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>+P-CSCF: 2. SIP REGISTER + P-CSCF-->>-P-CSCF: 3. 200 OK + P-CSCF->>UE: 4. 200 OK + P-CSCF->>PCRF: 5. Diameter AAR + Note over PCRF: 6. Session Binding + PCRF->>P-CSCF: 7. Diameter AAA + Note over PCRF: 8. Provisioning of PCC/QoS Rules +``` + +Legend: + ——> Mandatory + - - - -> Optional + +Sequence diagram showing the provisioning of SIP signalling flow information at initial IMS registration between UE, PCRF, and P-CSCF. + +**Figure B.1.3: Provisioning of SIP Signalling Flow Information at initial IMS Registration** + +- 1-4. The user initiates an initial SIP Registration procedure. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +5. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to provision the information about the SIP signalling flows established between the UE and the P-CSCF. The P-CSCF sends a Diameter AAR command to the PCRF. +6. The PCRF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. +7. The PCRF replies to the P-CSCF with a Diameter AAA. +8. If the PCRF had not previously provisioned PCC/QoS rules corresponding to the received SIP signalling flows, then the PCRF executes interactions according to figure 4.3.1.1.1. This step implies provisioning of PCC/QoS rules. + +#### B.1c Subscription to Notification of Change of PLMN Identifier at IMS Registration + +This clause covers the optional Subscription to Notifications of change in the PLMN identifier upon an initial IMS Registration procedure. + +![Sequence diagram showing the subscription to notification of change of PLMN Identifier at initial IMS Registration. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Session Binding (internal to PCRF), 4. Diameter AAA (PCRF to P-CSCF), 5. SIP REGISTER (P-CSCF to UE), 6. 200 OK (UE to P-CSCF), 7. 200 OK (P-CSCF to UE), and 8. Subscribe to Bearer Level Event (PCRF to P-CSCF). Step 8 is optional, indicated by a dashed box and dashed arrow.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of PCRF: 3. Session Binding + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>PCRF: 2. Diameter AAR + PCRF->>P-CSCF: 4. Diameter AAA + P-CSCF->>UE: 5. SIP REGISTER + UE->>P-CSCF: 6. 200 OK + P-CSCF->>UE: 7. 200 OK + Note right of PCRF: 8. Subscribe to Bearer Level Event + PCRF-->>P-CSCF: + +``` + +Legend: + +- Mandatory +- - - - → Optional + +Sequence diagram showing the subscription to notification of change of PLMN Identifier at initial IMS Registration. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP REGISTER (UE to P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Session Binding (internal to PCRF), 4. Diameter AAA (PCRF to P-CSCF), 5. SIP REGISTER (P-CSCF to UE), 6. 200 OK (UE to P-CSCF), 7. 200 OK (P-CSCF to UE), and 8. Subscribe to Bearer Level Event (PCRF to P-CSCF). Step 8 is optional, indicated by a dashed box and dashed arrow. + +**Figure B.1.4: Subscription to Notification of change of PLMN Identifier at initial IMS Registration** + +- The user initiates an initial SIP Registration procedure. + - The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to the notification of PLMN Identifier Change. The P-CSCF sends a Diameter AAR command to the PCRF. +- NOTE 1: It should be possible for the P-CSCF to request the subscription to notification of IMS Signalling path status and IP-CAN Type changes also in this step. +- The PCRF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. + - The PCRF confirms the subscription to notification of change of PLMN identifier and replies with a Diameter AAA command back to the P-CSCF. The PCRF includes in the response the PLMN Identifier currently in use, if available. +- 5-7. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +- If the PCRF had not previously subscribed to the required bearer level event from the PLMN where the UE is located (i.e. PLMN change event), then the PCRF shall do so now. The PCRF initiates procedures according to figure 4.3.1.1.1. +- NOTE 2: If the PLMN identifier is not available in step 4, the P-CSCF will wait to get it in step 8 before progressing the SIP Register, i.e. steps 5, 6 and 7 will occur after step 8. + +### B.2 IMS Session Establishment + +#### B.2.1 Provisioning of service information at Originating P-CSCF and PCRF + +This clause covers the PCC procedures at the originating P-CSCF and PCRF at IMS session establishment. + +In figure B.2.1.1 the P-CSCF derives the provisioning of service information to the PCRF from the SDP offer/answer exchange. + +![Sequence diagram of PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF. The diagram shows interactions between UE, PCRF, and P-CSCF. UE sends an SDP offer to P-CSCF. P-CSCF defines downlink connection info and forwards the SDP offer. PCRF defines uplink connection info and stores session information. P-CSCF sends Diameter AAR to PCRF. PCRF sends Diameter AAA to P-CSCF. P-CSCF sends an SDP answer to UE. PCRF provisions PCC/QoS Rules to P-CSCF. P-CSCF sends Diameter RAR to PCRF. PCRF sends Diameter RAA to P-CSCF. P-CSCF sends SIP with NPLI to UE. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A note indicates that steps 11 and 12 are conditional if access network information is requested.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + + Note left of UE: NPLI: user location and/or UE timezone information + + UE->>P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Define downlink connection info + P-CSCF->>P-CSCF: 3. SDP offer + P-CSCF->>P-CSCF: 4. SDP answer + P-CSCF->>P-CSCF: 5. Define up link connection info + P-CSCF->>PCRF: 6. Diameter AAR + PCRF->>PCRF: 7. Store Session Information and identify IP CAN Session + PCRF->>P-CSCF: 8. Diameter AAA + PCRF->>UE: 9. SDP answer + PCRF->>P-CSCF: 10. PCC/QoS Rules provisioning + P-CSCF-->>PCRF: 11. Diameter RAR + PCRF-->>P-CSCF: 12. Diameter RAA + P-CSCF-->>UE: 13. SIP with NPLI + + Note right of P-CSCF: If access network information is requested + + Note right of UE: Legend + Note right of UE: --> Mandatory + Note right of UE: -.-> Conditional + +``` + +Sequence diagram of PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF. The diagram shows interactions between UE, PCRF, and P-CSCF. UE sends an SDP offer to P-CSCF. P-CSCF defines downlink connection info and forwards the SDP offer. PCRF defines uplink connection info and stores session information. P-CSCF sends Diameter AAR to PCRF. PCRF sends Diameter AAA to P-CSCF. P-CSCF sends an SDP answer to UE. PCRF provisions PCC/QoS Rules to P-CSCF. P-CSCF sends Diameter RAR to PCRF. PCRF sends Diameter RAA to P-CSCF. P-CSCF sends SIP with NPLI to UE. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. A note indicates that steps 11 and 12 are conditional if access network information is requested. + +**Figure B.2.1.1: PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF** + +1. The P-CSCF receives the SDP parameters defined by the originator within an SDP offer in SIP signalling. +2. The P-CSCF identifies the connection information needed (IP address of the down link IP flow(s), port numbers to be used etc...). +3. The P-CSCF forwards the SDP offer in SIP signalling. +4. The P-CSCF gets the negotiated SDP parameters from the terminating side through SIP signalling interaction. + +5. The P-CSCF identifies the connection information needed (IP address of the up-link media IP flow(s), port numbers to be used etc...). +6. The P-CSCF forwards the derived session information to the PCRF by sending a Diameter AAR over a new Rx Diameter session. +7. The PCRF stores the received session information, and performs session binding. +8. The PCRF replies to the P-CSCF with a Diameter AAA. +9. Upon reception of the acknowledgement from the PCRF, the SDP parameters are passed to the UE in SIP signalling. +10. The PCRF executes interactions according to figure 4.3.1.1.1 . This step implies provisioning of PCC/QoS rules and is executed in parallel with steps 8 and 9. +11. If the P-CSCF requested access network information in step 6, the PCRF forwards the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs, the P-CSCF forwards the access network information as the network provided location information when a suitable SIP message is received. + +Optionally, the provisioning of service information may be derived already from the SDP offer to enable that a possible rejection of the service information by the PCRF is obtained by the P-CSCF in time to reject the service with appropriate SIP signalling, to allow the P-CSCF to request network provided location information for inclusion in the SDP offer, to support authentication of roaming users in deployments with no IMS-level roaming interfaces or to support PSAP callback functionality for anonymous IMS emergency sessions. This is described in figure B.2.1.2. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence starts with an SDP offer from the UE to the P-CSCF. The P-CSCF extracts down-link service information and sends a Diameter AAR to the PCRF. The PCRF responds with AuthorizeService Information and a Diameter AAA. The P-CSCF then sends an SDP offer (without NPLI) to the UE. A conditional block for provisioning PCC/QoS rules is shown. The P-CSCF extracts up-link service information and sends another Diameter AAR to the PCRF. The PCRF stores session information and responds with a Diameter AAA. Finally, the PCRF provisions PCC/QoS rules and the P-CSCF sends an SDP answer to the UE. A legend indicates that solid arrows are mandatory and dashed arrows are conditional. A note defines NPLI as user location and/or UE timezone information.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + + Note right of P-CSCF: If access network information is requested + Note left of UE: NPLI: user location and/or UE timezone information + + UE->>P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Extractdown- link service information + P-CSCF->>PCRF: 3. Diameter AAR + PCRF->>PCRF: 4. AuthorizeService Information + PCRF->>P-CSCF: 5. Diameter AAA + P-CSCF->>UE: 6. SDP offer (without NPLI) + Note right of PCRF: 7. Provisioning of PCC/QoS Rules + PCRF->>P-CSCF: 8. Diameter RAR + P-CSCF->>PCRF: 9. Diameter RAA + Note right of P-CSCF: SDP offer + Note right of P-CSCF: 10a. (With NPLI) + Note right of P-CSCF: 10b. SIP (With NPLI) + P-CSCF->>UE: 11. SDP answer + P-CSCF->>P-CSCF: 12. Extractup- link service information + P-CSCF->>PCRF: 13. Diameter AAR + PCRF->>PCRF: 14. Store Session Information + PCRF->>P-CSCF: 15. Diameter AAA + Note right of PCRF: 16. Provisioning of PCC/QoS Rules + PCRF->>P-CSCF: 17. SDP answer + P-CSCF->>UE: + +``` + +**Legend** + +- Mandatory** +- Conditional** + +**NPLI:** +user location and/or UE +timezone information + +Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence starts with an SDP offer from the UE to the P-CSCF. The P-CSCF extracts down-link service information and sends a Diameter AAR to the PCRF. The PCRF responds with AuthorizeService Information and a Diameter AAA. The P-CSCF then sends an SDP offer (without NPLI) to the UE. A conditional block for provisioning PCC/QoS rules is shown. The P-CSCF extracts up-link service information and sends another Diameter AAR to the PCRF. The PCRF stores session information and responds with a Diameter AAA. Finally, the PCRF provisions PCC/QoS rules and the P-CSCF sends an SDP answer to the UE. A legend indicates that solid arrows are mandatory and dashed arrows are conditional. A note defines NPLI as user location and/or UE timezone information. + +**Figure B.2.1.2: PCC Procedures for IMS Session Establishment at originating P-CSCF and PCRF, provisioning of service information derived from SDP offer and answer** + +1. The P-CSCF receives the first SDP offer for a new SIP dialogue within a SIP INVITE request. +2. The P-CSCF extracts service information from the SDP offer (IP address of the down link IP flow(s), port numbers to be used etc...). +3. The P-CSCF forwards the derived service information to the PCRF by sending a Diameter AAR over a new Rx Diameter session. It indicates that only an authorization check of the service information is requested. +4. The PCRF checks and authorizes the service information, performs session binding, but does not provision PCC/QoS rules at this stage. +5. The PCRF replies to the P-CSCF with a Diameter AAA. +6. If the P-CSCF did not request access network information in step 3, or if the P-CSCF requested access network information but does not require the access network information for inclusion in the SDP offer, or the P-CSCF requested EPC-level user information in step 3 the P-CSCF forwards the SDP offer in SIP signalling. + +7. If the P-CSCF requested access network information in step 3, the PCRF executes interactions according to Figure 4.3.1.1.1. This step implies provisioning of PCC/QoS rules. +8. If the P-CSCF requested access network information in step 3, the PCRF forwards the access network information received in step 7 in a Diameter RAR. +9. If step 8 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +- 10a. If step 8 occurs, and if the P-CSCF requires the access network information for inclusion in the SDP offer, the P-CSCF forwards the SDP offer and adds the access network information as the network provided location information to the corresponding SIP message. +- 10b. If step 8 occurs, and if the P-CSCF does not require the access network information for inclusion in the SDP offer, the P-CSCF forwards the access network information as the network provided location information in a suitable SIP message. This step normally occurs only after step 17. +11. The P-CSCF receives the negotiated SDP parameters from the terminating side within a SDP answer in SIP signalling. +12. The P-CSCF extracts service information from the SDP answer (IP address of the up-link media IP flow(s), port numbers to be used etc...). +13. The P-CSCF forwards the derived service information to the PCRF by sending a Diameter AAR over the existing Rx Diameter session. Access network information is not requested if done in step 7. +14. The PCRF stores the received session information. +15. The PCRF replies to the P-CSCF with a Diameter AAA. +16. The PCRF authorizes the session information. The PCRF executes interactions according to Figure 4.3.1.1.1. This step implies provisioning of PCC/QoS rules and authorized QoS. +17. Upon successful authorization of the session, the SDP parameters are passed to the UE in SIP signalling. This step is executed in parallel with step 16. + +#### B.2.2 Provisioning of service information at terminating P-CSCF and PCRF + +This clause covers the PCC procedures at the terminating P-CSCF and PCRF at IMS session establishment. + +In figure B.2.2.1 the P-CSCF derives the provisioning of service information to the PCRF from the SDP offer/answer exchange. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF. The diagram involves three main entities: P-CSCF, PCRF, and UE. The sequence starts with an SDP offer from an external source to the P-CSCF. The P-CSCF then defines up-link connection info and sends an SDP offer to the UE. The UE responds with an SDP answer. The P-CSCF then defines down-link connection info and sends a Diameter AAR to the PCRF. The PCRF stores session information and identifies an IP CAN session, then sends a Diameter AAA back to the P-CSCF. The P-CSCF sends an SDP answer (without NPLI) to the external source. The PCRF then provisions PCC/QoS rules and sends a Diameter RAR to the P-CSCF. The P-CSCF sends a Diameter RAA back to the PCRF. Finally, the P-CSCF sends an SDP answer (with NPLI) to the external source. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. A note indicates that if access network information is requested, the PCRF will include NPLI in the SDP answer.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +**Legend** + +- Mandatory** (Solid arrow) +- Conditional** (Dashed arrow) + +**NPLI:** +user location and/or UE +timezone information + +*If access network information is requested* + +Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF. The diagram involves three main entities: P-CSCF, PCRF, and UE. The sequence starts with an SDP offer from an external source to the P-CSCF. The P-CSCF then defines up-link connection info and sends an SDP offer to the UE. The UE responds with an SDP answer. The P-CSCF then defines down-link connection info and sends a Diameter AAR to the PCRF. The PCRF stores session information and identifies an IP CAN session, then sends a Diameter AAA back to the P-CSCF. The P-CSCF sends an SDP answer (without NPLI) to the external source. The PCRF then provisions PCC/QoS rules and sends a Diameter RAR to the P-CSCF. The P-CSCF sends a Diameter RAA back to the PCRF. Finally, the P-CSCF sends an SDP answer (with NPLI) to the external source. A legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. A note indicates that if access network information is requested, the PCRF will include NPLI in the SDP answer. + +**Figure B.2.2.1: PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF** + +1. The P-CSCF receives the SDP parameters defined by the originator. +2. The P-CSCF identifies the connection information needed (IP address of the up-link IP flow(s), port numbers to be used etc...). +3. The P-CSCF sends the SDP offer to the UE. +4. The P-CSCF receives the negotiated SDP parameters from the UE. +5. The P-CSCF identifies the connection information needed (IP address of the down-link IP flow(s), port numbers to be used etc...). +6. The P-CSCF forwards the derived service information to the PCRF by sending a Diameter AAR over a new Rx Diameter session. +7. The PCRF stores the received session information, and performs session binding. +8. The PCRF sends a Diameter AAA to the P-CSCF. + +9. If the P-CSCF did not request access network information in step 6, upon reception of the acknowledgement from the PCRF, the SDP parameters in the SDP answer are passed to the originator. +10. The PCRF executes interactions according to clause 4.3.1.1.1. This step implies provisioning of PCC/QoS rules and is executed in parallel with steps 8 and 9. +11. If the P-CSCF requested access network information in step 6, the PCRF forwards the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs, the P-CSCF forwards the SDP answer and adds the access network information as the network provided location information to the corresponding SIP message. + +Optionally, the provisioning of service information may be derived already from the SDP offer to enable that a possible rejection of the service information by the PCRF is obtained by the P-CSCF in time to reject the service with appropriate SIP signalling or to enable pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. This is described in figure B.2.2.2. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF. Lifelines: P-CSCF, PCRF, UE. The diagram shows the flow of SDP offers, Diameter messages (AAR, AAA, RAR, RAA), and provisioning of PCC/QoS rules. A legend indicates mandatory (solid line) and conditional (dashed line) messages. A note defines NPLI as user location and/or UE timezone information. A bracket indicates that steps 14 and 15 are conditional if access network information is requested.](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` + +sequenceDiagram + participant External + participant P-CSCF + participant PCRF + participant UE + + Note left of P-CSCF: NPLI: user location and/or UE timezone information + + External->>P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Extract up link service information + P-CSCF->>PCRF: 3. Diameter AAR + PCRF->>P-CSCF: 4. Authorize Service Information + PCRF->>P-CSCF: 5. Diameter AAA + PCRF->>UE: 6. SDP offer + Note right of PCRF: 7. Provisioning of PCC/QoS Rules + UE->>PCRF: 8. SDP answer + P-CSCF->>P-CSCF: 9. Extract downlink service information + P-CSCF->>PCRF: 10. Diameter AAR + PCRF->>P-CSCF: 10a. Store Session Information + PCRF->>P-CSCF: 11. Diameter AAA + Note right of PCRF: 12. Provisioning of PCC/QoS Rules + P-CSCF->>External: 13. SDP answer (without NPLI) + Note right of PCRF: If access network information is requested + PCRF->>P-CSCF: 14. Diameter RAR + P-CSCF->>PCRF: 15. Diameter RAA + P-CSCF->>External: 16. SDP answer (With NPLI) + + Note right of UE: Legend + Note right of UE: --> Mandatory + Note right of UE: -.-> Conditional + +``` + +Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF. Lifelines: P-CSCF, PCRF, UE. The diagram shows the flow of SDP offers, Diameter messages (AAR, AAA, RAR, RAA), and provisioning of PCC/QoS rules. A legend indicates mandatory (solid line) and conditional (dashed line) messages. A note defines NPLI as user location and/or UE timezone information. A bracket indicates that steps 14 and 15 are conditional if access network information is requested. + +**Figure B.2.2.2: PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCRF, provisioning of service information derived from SDP offer and answer** + +1. The P-CSCF receives the first SDP offer for a new SIP dialogue within SIP signalling, e.g. within a SIP INVITE request. +2. The P-CSCF extracts the service information from the SDP offer (IP address of the up-link IP flow(s), port numbers to be used etc...). + +3. The P-CSCF forwards the derived session information to the PCRF by sending a Diameter AAR over a new Rx Diameter session. It indicates that the service information that the AF has provided to the PCRF is preliminary and needs to be further negotiated between the two ends. +4. The PCRF checks and authorizes the session information, performs session binding, but does not provision PCC/QoS Rules at this stage. +5. The PCRF replies to the P-CSCF with a Diameter AAA. +6. The P-CSCF sends the SDP offer to the UE. +7. If the UE initiates a bearer resource modification request, the PCRF provides the PCEF/BBERF with PCC/QoS rules according to figure 4.3.1.1.1 based on the SDP offer. + +NOTE: Step 7 is not applicable for IMS Emergency Sessions. + +8. The P-CSCF receives the negotiated SDP parameters from the UE within an SDP answer in SIP signalling. +9. The P-CSCF extracts service information from the SDP answer (IP address of the down-link IP flow(s), port numbers to be used etc...). +10. The P-CSCF forwards the derived service information to the PCRF by sending a Diameter AAR over the existing Rx Diameter session. +- 10a. The PCRF stores the received session information. +11. The PCRF sends a Diameter AAA to the P-CSCF. +12. The PCRF authorizes the session information. The PCRF executes interactions according to Figure 4.3.1.1.1. This step implies provisioning of PCC/QoS rules and authorized QoS. +13. If the P-CSCF did not request access network information in step 3 or 10, upon successful authorization of the session the SDP parameters in the SDP answer are passed to the originator. This step is executed in parallel with step 12. +14. If the P-CSCF requested access network information in step 3 or 10, the PCRF forwards the access network information received in step 12 in a Diameter RAR. +15. If step 14 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +16. If step 14 occurs, the P-CSCF forwards the SDP answer and adds the access network information as the network provided location information to the corresponding SIP message. + +### --- B.3 IMS Session Modification + +#### B.3.1 Provisioning of service information + +This clause covers the provisioning of service information at IMS session modification both at the originating and terminating side. + +In figure B.3.1.1 the P-CSCF derives the provisioning of service information to the PCRF from the SDP offer/answer exchange. + +![Sequence diagram showing the provisioning of service information at IMS session modification between PCRF and P-CSCF. The diagram includes 13 numbered steps, a legend for mandatory and conditional messages, and a note about NPLI (user location and/or UE timezone information).](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +The diagram illustrates the interaction between a PCRF and a P-CSCF for provisioning service information during an IMS session modification. The sequence of messages is as follows: + +1. SDP offer (Mandatory) +2. extract changes in service information from SDP offer (Internal P-CSCF action) +3. SDP offer (Mandatory) +4. SDP answer (Mandatory) +5. extract changes in service information from SDP answer (Internal P-CSCF action) +6. Diameter AAR (Mandatory) +7. Store Session Info and Identify IP-CAN Session (Internal PCRF action) +8. Diameter AAA (Mandatory) +9. SDP answer (without NPLI) (Conditional) +10. Interactions in Figure 4.3.1.1.1 (Internal PCRF action) +11. Diameter RAR (Conditional) +12. Diameter RAA (Conditional) +13. SDP answer (with NPLI) (Conditional) + +**NPLI:** +user location and/or UE +timezone information + +**Legend** + +- Mandatory (solid line) +- Conditional (dashed line) + +*If access network Information is requested* + +Sequence diagram showing the provisioning of service information at IMS session modification between PCRF and P-CSCF. The diagram includes 13 numbered steps, a legend for mandatory and conditional messages, and a note about NPLI (user location and/or UE timezone information). + +Figure B.3.1.1: Provisioning of service information at IMS session modification + +1. The P-CSCF receives the SDP parameters defined by the originator within an SDP offer in SIP signalling. +2. The P-CSCF identifies the relevant changes in the SDP. +3. The P-CSCF forwards the SDP offer in SIP signalling. +4. The P-CSCF gets the negotiated SDP parameters from the terminating side through SIP signalling interaction. +5. The P-CSCF identifies the relevant changes in the SDP. +6. The P-CSCF sends a Diameter AAR for an existing Diameter session and includes the derived updated service information. + +7. The PCRF stores the received updated session information and identifies the affected established IP-CAN Session(s). +8. The PCRF answers with a Diameter AAA. +9. If the P-CSCF did not request access network information in step 6, the P-CSCF forwards the SDP answer in SIP signalling. +10. The PCRF executes interactions according to figure 4.3.1.1.1. Due to the updated service information, this step may imply provisioning of PCC/QoS rules or the need to enable or disable IP Flows (see clauses B.3.2 and B.3.3, respectively). +11. If the P-CSCF requested access network information in step 6, the PCRF forwards the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs, the P-CSCF forwards the SDP answer and adds the access network information as the network provided location information to the corresponding SIP message. + +Optionally, the provisioning of service information may be derived already from the SDP offer to enable that a possible rejection of the service information by the PCRF is obtained by the P-CSCF in time to reject the service with appropriate SIP signalling or to enable pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. This is described in figure B.3.1.2. + +![Sequence diagram showing the provisioning of service information derived from SDP offer and answer at IMS session modification between PCRF and P-CSCF. The diagram includes 16 numbered steps, process boxes for 'authorize service information', 'Provisioning of PCC/QoS Rules', and 'extract changes in service information'. It also features a legend for 'Mandatory' (solid line) and 'Conditional' (dashed line) messages, and a box defining NPLI as user location and/or UE timezone information.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +**Sequence Diagram: Provisioning of service information derived from SDP offer and answer at IMS session modification** + +**Participants:** PCRF, P-CSCF + +**Legend:** + +- Mandatory:** Solid line with arrowhead +- Conditional:** Dashed line with arrowhead + +**NPLI:** user location and/or UE timezone information + +**Sequence of Messages:** + +- SDP offer (Mandatory) from UE to P-CSCF +- extract changes in service information from SDP offer (Process) at P-CSCF +- Diameter AAR (Mandatory) from P-CSCF to PCRF +- authorize service information (Process) at PCRF +- Diameter AAA (Mandatory) from PCRF to P-CSCF +- Provisioning of PCC/QoS Rules (Process) at PCRF +- SDP offer (Mandatory) from P-CSCF to UE +- SDP answer (Mandatory) from UE to P-CSCF +- extract changes in service information from SDP answer (Process) at P-CSCF +- Diameter AAR (Mandatory) from P-CSCF to PCRF +- Diameter AAA (Mandatory) from PCRF to P-CSCF +- Provisioning of PCC/QoS Rules (Process) at PCRF +- SDP answer (without NPLI) (Conditional) from PCRF to UE +- Diameter RAR (Conditional) from PCRF to P-CSCF +- Diameter RAA (Conditional) from P-CSCF to PCRF +- SDP answer (With NPLI) (Conditional) from PCRF to UE + +*Note: Steps 14 and 15 are grouped by a bracket indicating they occur "If access network information is requested".* + +Sequence diagram showing the provisioning of service information derived from SDP offer and answer at IMS session modification between PCRF and P-CSCF. The diagram includes 16 numbered steps, process boxes for 'authorize service information', 'Provisioning of PCC/QoS Rules', and 'extract changes in service information'. It also features a legend for 'Mandatory' (solid line) and 'Conditional' (dashed line) messages, and a box defining NPLI as user location and/or UE timezone information. + +Figure B.3.1.2: Provisioning of service information derived from SDP offer and answer at IMS session modification + +1. The P-CSCF receives an SDP offer in SIP signalling for an exiting SIP dialogue. +2. The P-CSCF identifies the relevant changes in the SDP and extracts the corresponding service information. + +3. The P-CSCF forwards the derived service information to the PCRF by sending a Diameter AAR over the existing Rx Diameter session for the corresponding SIP session. It indicates that the service information that the AF has provided to the PCRF is preliminary and needs to be further negotiated between the two ends. +4. The PCRF checks and authorizes the session information, but does not provision PCC/QoS rules at this stage. +5. The PCRF replies to the P-CSCF with a Diameter AAA. +6. If the UE initiates a bearer resource modification request, the PCRF provides the PCEF/BBERF with PCC/QoS rules according to figure 4.3.1.1.1 based on the SDP offer. + +NOTE: Step 6 is not applicable for IMS Emergency Sessions. + +7. The P-CSCF forwards the SDP offer in SIP signalling. +8. The P-CSCF receives the negotiated SDP parameters within an SDP answer in SIP signalling from the terminating side. +9. The P-CSCF identifies the relevant changes in the SDP and extracts the corresponding service information. +10. The P-CSCF sends a Diameter AAR for an existing Diameter session and includes the derived updated service information. +11. The PCRF answers with a Diameter AAA. +12. The PCRF interacts with the GW according to figure 4.3.1.1.1. This step may imply provisioning of PCC/QoS rules and authorized QoS. The PCRF may need to enable or disable IP Flows (see clauses B.3.2 and B.3.3, respectively) due to the updated service information. +13. If the P-CSCF did not request access network information in step 3 or 10, the P-CSCF forwards the SDP answer in SIP signalling. This step is executed in parallel with step 12. +14. If the P-CSCF requested access network information in step 3 or 10, the PCRF forwards the access network information received in step 12 in a Diameter RAR. +15. If step 14 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +16. If step 14 occurs, the P-CSCF forwards the SDP answer and adds the access network information as the network provided location information to the corresponding SIP message. + +#### B.3.2 Enabling of IP Flows + +The PCRF makes a final decision to enable the allocated QoS resource for the authorized IP flows of the media component(s) if the QoS resources are not enabled at the time they are authorized by the PCRF or if the media IP flow(s) previously placed on hold are resumed, i.e. the media IP flow(s) of the media component that was placed on hold at the time of the resource authorization or at a later stage is reactivated (with SDP direction sendrecv, sendonly, recvonly or none direction). + +The Enabling of IP Flows procedure is triggered by the P-CSCF receiving any 2xx success response to an INVITE request or a 2xx success response to an UPDATE request within a confirmed dialogue that is not embedded as part of another INVITE Transaction (in both cases a 200 OK response is usually received). When receiving such responses, the PCRF shall take the SDP direction attribute in the latest received SDP (either within the 2xx success or a previous SIP message) into account when deciding, which gates shall be opened: + +- For a unidirectional SDP media component, IP flows in the opposite direction shall not be enabled. +- For an inactive SDP media component, no IP flows shall be enabled. + +Figure B.3.2.1 is applicable to the Mobile Originating (MO) side and the Mobile Terminating (MT) side. + +![Sequence diagram for Enabling of IP Flows](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +The diagram is a sequence diagram illustrating the 'Enabling of IP Flows' procedure. It features three lifelines: UE, PCRF, and P-CSCF. The sequence of messages is as follows: 1. An external '2xx Success' message is received by the P-CSCF. 2. The P-CSCF sends a 'Diameter AAR' message to the PCRF. 3. The PCRF performs an internal action: 'PCRF updates flow status of affected PCC rules'. 4. The PCRF sends a 'Diameter AAA' message to the P-CSCF. 5. The P-CSCF sends a '2xx Success' message to the UE. 6. The PCRF performs another internal action: 'PCRF opens the gates'. A legend at the bottom left shows a solid arrow pointing right, labeled 'Mandatory'. + +Sequence diagram for Enabling of IP Flows + +**Figure B.3.2.1: Enabling of IP Flows** + +1. The P-CSCF receives the 2xx Success message complying with the conditions specified in the paragraphs above. +2. The P-CSCF sends a Diameter AAR message to the PCRF, requesting that gates shall be opened. +3. The PCRF approves the enabling of IP flows and PCRF updates flow status of affected PCC rules. +4. The PCRF sends a Diameter AAA to the P-CSCF. +5. The P-CSCF forwards the 2xx Success message. +6. The PCRF executes interactions according to figure 4.3.1.1.1. This step implies opening the 'gates' by updating the flow status of PCC rules. + +### B.3.3 Disabling of IP Flows + +The “Disabling of IP Flows” procedure is used when media IP flow(s) of a session are put on hold (e.g. in case of a media re-negotiation or call hold). + +Media is placed on hold as specified in RFC 3264 [12]. Media modified to become inactive (SDP direction attribute) shall also be considered to be put on hold. + +If a bidirectional media component is placed on hold by making it unidirectional, the IP flows shall only be disabled in the deactivated direction. If a media component is placed on hold by making it inactive, the IP flows shall be disabled in both directions. + +Figure B.3.3.1 presents the “Disabling of IP Flows” procedure at media on hold for both the Mobile Originating (MO) side and the Mobile Terminating (MT) side. + +![Sequence diagram showing the disabling of IP flows at media on hold. Lifelines: UE, PCRF, P-CSCF. The sequence starts with an external SDP answer to the P-CSCF. The P-CSCF sends a Diameter AAR to the PCRF. The PCRF updates flow status and sends a Diameter AAA back. The P-CSCF then sends an SDP answer to the UE. Finally, the PCRF closes the related gate.](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of P-CSCF: 1. SDP answer putting media on hold + P-CSCF->>PCRF: 2. Diameter AAR + Note over PCRF: 3. PCRF updates flow status of affected PCC rules + PCRF->>P-CSCF: 4. Diameter AAA + P-CSCF->>UE: 5. SDP answer putting media on hold + Note over PCRF: 7. PCRF closes the related gate + +``` + +Legend: + → Mandatory + +Sequence diagram showing the disabling of IP flows at media on hold. Lifelines: UE, PCRF, P-CSCF. The sequence starts with an external SDP answer to the P-CSCF. The P-CSCF sends a Diameter AAR to the PCRF. The PCRF updates flow status and sends a Diameter AAA back. The P-CSCF then sends an SDP answer to the UE. Finally, the PCRF closes the related gate. + +**Figure B.3.3.1: Disabling of IP Flows at Media on Hold** + +1. The P-CSCF receives an SDP answer putting media on hold within a SIP message. (NOTE) +2. The P-CSCF sends a Diameter AAR request to the PCRF, requesting that gates shall be closed. +3. The PCRF updates flow status of affected PCC rules for the media on hold. +4. The PCRF sends a Diameter AAA message back to the P-CSCF. +5. The P-CSCF forwards the SDP answer putting media on hold within a SIP message. +6. The PCRF executes interactions according to figure 4.3.1.1.1. This step implies closing the relevant media IP flow gate(s), leaving the possible related RTCP gate(s) open to keep the connection alive. + +NOTE: This procedure occurs whenever a bidirectional media is made unidirectional or when a media is changed to inactive. + +### B.3.4 Media Component Removal + +Figure B.3.4.1 presents the flows of PCC procedures at the removal of media component(s) from an IMS session which is not being released for both the Mobile Originating (MO) side and the Mobile Terminating (MT) side. + +![Sequence diagram showing the interaction between UE, PCRF, and P-CSCF for revoking authorization for IP resources at media component removal. The diagram includes six steps: 1. SDP answer removing media component (received by P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Store Session Information and Identify IP-CAN session (internal to PCRF), 4. Diameter AAA (PCRF to P-CSCF), 5. SDP answer removing media component (P-CSCF to UE), and 6. Remove/Modify PCC/QoS Rules (internal to PCRF). A legend indicates that solid arrows represent mandatory actions.](69edc2887e907309499ac95b47ab6905_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of P-CSCF: 1. SDP answer removing media component + P-CSCF->>PCRF: 2. Diameter AAR + Note right of PCRF: 3. Store Session Information and Identify IP-CAN session + PCRF->>P-CSCF: 4. Diameter AAA + P-CSCF->>UE: 5. SDP answer removing media component + Note right of PCRF: 6. Remove/Modify PCC/QoS Rules + +``` + +Legend: +→ Mandatory + +Sequence diagram showing the interaction between UE, PCRF, and P-CSCF for revoking authorization for IP resources at media component removal. The diagram includes six steps: 1. SDP answer removing media component (received by P-CSCF), 2. Diameter AAR (P-CSCF to PCRF), 3. Store Session Information and Identify IP-CAN session (internal to PCRF), 4. Diameter AAA (PCRF to P-CSCF), 5. SDP answer removing media component (P-CSCF to UE), and 6. Remove/Modify PCC/QoS Rules (internal to PCRF). A legend indicates that solid arrows represent mandatory actions. + +**Figure B.3.4.1: Revoke authorization for IP resources at media component removal for both Mobile Originating (MO) and Mobile Terminating (MT) side** + +1. A SIP message containing SDP indicating the removal of media component(s) is received by the P-CSCF. +2. The P-CSCF sends Diameter AAR to the PCRF with modified service information. +3. The PCRF stores the Session information and identifies the affected IP-CAN Session(s). +4. The PCRF sends a Diameter AAA message back to the P-CSCF. +5. The P-CSCF forwards the SDP answer removing a media component. +6. The PCRF makes a decision on what PCC/QoS rules need to be modified or removed and executes interactions according to figure 4.3.1.1.1. + +## B.4 IMS Session Termination + +### B.4.1 Mobile initiated session release / Network initiated session release + +Figure B.4.1.1 presents the mobile or network initiated IMS session release without access network information retrieval. The session release may be signalled by a SIP BYE message, or any SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response to an initial INVITE request. If any 4xx, 5xx, or 6xx SIP final error response to Re-INVITE or UPDATE request just terminates the transaction, then the session is not released, otherwise if the error response terminates the dialog then the session is released. + +Figures B.4.1.2 and B.4.1.3 presents the network initiated and the mobile initiated IMS session release with access network information retrieval, respectively. + +![Sequence diagram for IMS session termination without access network information retrieval. Lifelines: UE, PCRF, P-CSCF. Step 1: BYE message from P-CSCF to UE. Step 2: BYE, 3xx, 4xx, 5xx, or 6xx response from P-CSCF to UE. Step 3: Removal of PCC/QoS Rules at AF session release (parallel interaction with PCRF).](d3ca266c298aeb34b019960c6c36f187_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of P-CSCF: 1. BYE, 3xx, 4xx, 5xx, or 6xx + P-CSCF->>UE: 2. BYE, 3xx, 4xx, 5xx, or 6xx + Note over PCRF, P-CSCF: 3. Removal of PCC/QoS Rules at AF session release +``` + +Sequence diagram for IMS session termination without access network information retrieval. Lifelines: UE, PCRF, P-CSCF. Step 1: BYE message from P-CSCF to UE. Step 2: BYE, 3xx, 4xx, 5xx, or 6xx response from P-CSCF to UE. Step 3: Removal of PCC/QoS Rules at AF session release (parallel interaction with PCRF). + +**Figure B.4.1.1: IMS session termination without access network information retrieval** + +1. SIP BYE message, a SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response to an initial INVITE or any 4xx, 5xx, or 6xx SIP final error response to Re-INVITE or UPDATE which terminates the dialog is received by the P-CSCF. +2. P-CSCF forwards the BYE message, or the SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response. +3. The Interactions in in Figure 4.3.1.2.3.1.1 or Figure 4.3.1.2.3.2.1 are applicable. + +![Sequence diagram for network initiated IMS session termination with access network information retrieval. Lifelines: UE, PCRF, P-CSCF. Step 1: BYE message from P-CSCF to UE. Step 2: BYE message from P-CSCF to UE. Step 3: Removal of PCC/QoS Rules at AF session release (parallel interaction with PCRF). Step 4: 200 OK (BYE) response from UE to P-CSCF. Step 5: 200 OK (BYE) response from P-CSCF to UE.](12a6537c92844d5b393104c02e8dfc2f_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of P-CSCF: 1. BYE + P-CSCF->>UE: 2. BYE + Note over PCRF, P-CSCF: 3. Removal of PCC/QoS Rules at AF session release + UE->>P-CSCF: 4. 200 OK (BYE) + P-CSCF->>UE: 5. 200 OK (BYE) +``` + +Sequence diagram for network initiated IMS session termination with access network information retrieval. Lifelines: UE, PCRF, P-CSCF. Step 1: BYE message from P-CSCF to UE. Step 2: BYE message from P-CSCF to UE. Step 3: Removal of PCC/QoS Rules at AF session release (parallel interaction with PCRF). Step 4: 200 OK (BYE) response from UE to P-CSCF. Step 5: 200 OK (BYE) response from P-CSCF to UE. + +**Figure B.4.1.2: network initiated IMS session termination with access network information retrieval** + +1. SIP BYE message is received by the P-CSCF. +2. The P-CSCF forwards the BYE message. +3. In parallel to step 2, the Interactions in Figure 4.3.1.2.3.1.1 or Figure 4.3.1.2.3.2.1 take place. Within those interactions, the P-CSCF requests and receives the access network information. +4. The P-CSCF receives the SIP 200 OK (BYE) SIP message. +5. The P-CSCF forwards the SIP 200 OK (BYE) SIP message. It includes the access networking information obtained in step 3 as the network provided location information. + +![Sequence diagram for mobile initiated IMS session termination with access network information retrieval. Lifelines: PCRF, P-CSCF, UE. Step 1: UE sends BYE to P-CSCF. Step 2: P-CSCF sends a request to PCRF for removal of PCC/QoS Rules at AF session release. Step 3: P-CSCF forwards the BYE message to the UE.](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant PCRF + Note right of UE: 1. BYE + UE->>P-CSCF: 1. BYE + Note right of P-CSCF: 2. Removal of PCC/QoS Rules at AF session release + P-CSCF->>PCRF: 2. Removal of PCC/QoS Rules at AF session release + Note left of PCRF: 3. BYE + PCRF->>P-CSCF: 3. BYE +``` + +Sequence diagram for mobile initiated IMS session termination with access network information retrieval. Lifelines: PCRF, P-CSCF, UE. Step 1: UE sends BYE to P-CSCF. Step 2: P-CSCF sends a request to PCRF for removal of PCC/QoS Rules at AF session release. Step 3: P-CSCF forwards the BYE message to the UE. + +**Figure B.4.1.3: mobile initiated IMS session termination with access network information retrieval** + +1. SIP BYE message is received by the P-CSCF. +2. The Interactions in Figure 4.3.1.2.3.1.1 or Figure 4.3.1.2.3.2.1 are applicable. Within those interactions, the P-CSCF requests and receives the access network information. +3. The P-CSCF forwards the BYE message. It includes the access network information obtained in step 2 as the network provided location information. + +### B.4.2 IP-CAN Bearer Release/Loss + +An IP-CAN Bearer Release or Loss event may affect all IP-Flows within an IMS Session. Flows in clause 4.3.2.2.1 (AF located in the HPLMN) or 4.3.2.2.2 (AF located in the VPLMN) apply for case 1. Flows in clause 4.4.2.1.1 (Home Routed case) or 4.4.2.2.1 (Visited Access case) apply for case 2a and case 2b. + +## B.5 P-CSCF Restoration + +This clause is applicable if P-CSCF Restoration is to be performed. + +![Sequence diagram for P-CSCF Restoration showing interactions between UE, PCEF, V-PCRF, H-PCRF, and P-CSCF. The diagram shows Diameter AAR/AAA and RAR/RAA exchanges for both non-roaming and roaming with local breakout scenarios.](573c8f9e728e343b6864e1070c14b8cf_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCEF + participant V-PCRF + participant H-PCRF + participant P-CSCF + + Note right of P-CSCF: SIP message + P-CSCF->>H-PCRF: 1. Diameter AAR + H-PCRF-->>P-CSCF: 2. Diameter AAA + H-PCRF->>PCEF: 3. Diameter RAR + PCEF-->>H-PCRF: 4. Diameter RAA + + rect rgb(220, 255, 255) + Note over PCEF, P-CSCF: Roaming with local breakout when the P-CSCF is located in the VPLMN + P-CSCF->>V-PCRF: 1a. Diameter AAR + V-PCRF-->>P-CSCF: 2a. Diameter AAA + V-PCRF->>PCEF: 3a. Diameter RAR + PCEF-->>V-PCRF: 4a. Diameter RAA + end + + Note over UE, PCEF: P-CSCF Restoration Procedure + +``` + +Sequence diagram for P-CSCF Restoration showing interactions between UE, PCEF, V-PCRF, H-PCRF, and P-CSCF. The diagram shows Diameter AAR/AAA and RAR/RAA exchanges for both non-roaming and roaming with local breakout scenarios. + +**Figure B.5.1: P-CSCF Restoration** + +1. The P-CSCF sends an AAR command to PCRF to initiate a P-CSCF Restoration procedure, as defined in the 3GPP TS 23.380 [35]. The AAR command contains a Rx-Request-Type AVP with value set to PCSCF\_RESTORATION and can contain the IP address of the UE within Framed-IP-Address AVP (if available) or the Framed-IPv6-Prefix AVP (if available), IMSI (if available) within the Subscription-Id AVP, the IMS APN (if available) within the Called-Station-Id AVP and/or the IP address domain (if available) within the IP-Domain-Id AVP. + +For the non-roaming case and the home routed case, the H-PCRF receives the AAR command, i.e. step 1 is executed. + +- 1a. For the roaming case with visited access, when the P-CSCF is located in the VPLMN, step 1 is executed with the exception that the V-PCRF receives the AAR command and responds with the AAA command +2. When receiving the AAR command for P-CSCF Restoration from the P-CSCF, the PCRF acknowledges the AAR by sending an AAA command to the P-CSCF. + +For the non-roaming case and the home routed case, the H-PCRF sends an AAA command to the P-CSCF, i.e. step 2 is executed. + +- 2a. For the roaming case with visited access, when the P-CSCF is located in the VPLMN, step 2 is executed with the exception that the V-PCRF sends an AAA command to the P-CSCF. + +For the roaming case with local breakout when the P-CSCF is located in the HPLMN, when the H-PCRF receives the AAR command from the P-CSCF, the H-PCRF sends an RAR command to the V-PCRF, i.e. step 1b is executed. + +3. When receiving the AAR command for P-CSCF Restoration, the PCRF finds the corresponding IP-CAN session according to the received information within the AAR command, and sends an RAR command for the corresponding IP-CAN session (IMS PDN connection) to the PCEF for P-CSCF Restoration. The RAR contains a PCSCF-Restoration-Indication AVP with value set to PCSCF\_RESTORATION. + +For the non-roaming case and the home routed case, when receiving the AAR command from the P-CSCF, the H-PCRF sends the RAR command to the PCEF, i.e. step 3 is executed. + +- 3a. For the roaming case with visited access, when the P-CSCF is located in the VPLMN, step 3 is executed with the exception that when receiving the AAR command from the P-CSCF, the V-PCRF sends the RAR command to the PCEF. + +For the roaming case with local breakout when the P-CSCF is located in the HPLMN, when receiving the RAR command from the H-PCRF, the V-PCRF sends an RAR command to the PCEF, i.e. step 2a is executed. + +4. When receiving the RAR command for P-CSCF Restoration, the PCEF acknowledges the RAR by sending an RAA command to the PCRF and performs the subsequent P-CSCF Restoration procedure as specified in 3GPP TS 23.380 [35]. + +NOTE 1: If the IMS PDN disconnection is performed for P-CSCF Restoration, the PCEF sends a CCR command to the PCRF to terminate the corresponding Gx session. + +For the non-roaming case and the home routed case, when receiving the RAR command from the H-PCRF, the PCEF acknowledges this message by sending an RAA command to the H-PCRF, i.e. step 4 is executed. + +- 4a. For the roaming case with visited access, when the P-CSCF is located in the VPLMN, step 4 is executed with the exception that when receiving the RAR command from the V-PCRF, the PCEF acknowledges this message by sending an RAA command to the V-PCRF. + +NOTE 2: This P-CSCF Restoration procedure is applicable to the cases that both the P-CSCF and the PCEF are located in the same PLMN. + +## --- B.6 IMS Restricted Local Operator Services + +RLOS may be supported as described in subclause B.0 with the following differences: + +- emergency service is replaced by RLOS; +- emergency indication is replaced by RLOS indication; +- emergency session is replaced by RLOS session; +- emergency APN is replaced by RLOS APN; and +- the call back functionality is not applicable to RLOS. + +Subclause B.2.2 is not supported for RLOS, because only UE originated RLOS requests are supported and there is no support for mobile terminated services as specified in 3GPP TS 23.221 [66]. + +## --- B.7 Retrieval of Network Provided Location Information for SMS over IP at Originating side + +This clause covers the optional request of access network information for SMS over IP. + +![Sequence diagram showing the retrieval of access network information for SMS over IP at the originating side. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP MESSAGE from UE to P-CSCF; 2. Diameter AAR from P-CSCF to PCRF; 3. Session Binding (internal to PCRF); 4. Diameter AAA from PCRF to P-CSCF; 5. Request Access Network Info (internal to PCRF); 6. Diameter RAR from PCRF to P-CSCF; 7. Diameter RAA from P-CSCF to PCRF; 8. SIP MESSAGE from P-CSCF to the right (out of the diagram).](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + Note right of PCRF: 3. Session Binding + Note right of PCRF: 5. Request Access Network Info + UE->>P-CSCF: 1. SIP MESSAGE + P-CSCF->>PCRF: 2. Diameter AAR + PCRF-->>P-CSCF: 4. Diameter AAA + PCRF->>P-CSCF: 6. Diameter RAR + P-CSCF-->>PCRF: 7. Diameter RAA + P-CSCF->>Note right of P-CSCF: 8. SIP MESSAGE +``` + +Sequence diagram showing the retrieval of access network information for SMS over IP at the originating side. The diagram involves three main entities: UE, PCRF, and P-CSCF. The sequence of messages is: 1. SIP MESSAGE from UE to P-CSCF; 2. Diameter AAR from P-CSCF to PCRF; 3. Session Binding (internal to PCRF); 4. Diameter AAA from PCRF to P-CSCF; 5. Request Access Network Info (internal to PCRF); 6. Diameter RAR from PCRF to P-CSCF; 7. Diameter RAA from P-CSCF to PCRF; 8. SIP MESSAGE from P-CSCF to the right (out of the diagram). + +**Figure B.7.1: Retrieval of Access Network Information for SMS over IP at originating side** + +- 1.- The UE sends a SIP MESSAGE request to IMS. +2. The P-CSCF requests the establishment of a new Diameter Rx session with the intention of retrieval the access network information. The P-CSCF sends a Diameter AAR command to the PCRF. +3. The PCRF performs session binding. +4. The PCRF replies with a Diameter AAA command back to the P-CSCF. +5. The PCRF requires access network information according to figure 5.2.2.2.1-1. +6. The PCRF forwards the access network information received in step 5 in a Diameter RAR. +7. The P-CSCF acknowledges the receipt of Diameter RAR. +8. IMS sends a SIP MESSAGE to the terminating side including the network provided location information. + +After, the P-CSCF terminates the AF session as described in subclause 4.3.1.2.3. + +## --- B.8 Retrieval of Network Provided Location Information for SMS over IP at Terminating side + +This clause covers the optional request of access network information for SMS over IP. + +![Sequence diagram showing the retrieval of access network information for SMS over IP at the terminating side. Entities: UE, PCRF, P-CSCF. 1. UE to P-CSCF: 200 OK. 2. P-CSCF to PCRF: Diameter AAR. 3. PCRF internal: Session Binding. 4. PCRF to P-CSCF: Diameter AAA. 5. PCRF internal: Request Access Network Info. 6. PCRF to P-CSCF: Diameter RAR. 7. P-CSCF to PCRF: Diameter RAA. 8. P-CSCF to external: 200 OK.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCRF + participant P-CSCF + UE->>P-CSCF: 1. 200 OK + P-CSCF->>PCRF: 2. Diameter AAR + Note over PCRF: 3. Session Binding + PCRF->>P-CSCF: 4. Diameter AAA + Note over PCRF: 5. Request Access Network Info + PCRF->>P-CSCF: 6. Diameter RAR + P-CSCF->>PCRF: 7. Diameter RAA + P-CSCF->>External: 8. 200 OK +``` + +Sequence diagram showing the retrieval of access network information for SMS over IP at the terminating side. Entities: UE, PCRF, P-CSCF. 1. UE to P-CSCF: 200 OK. 2. P-CSCF to PCRF: Diameter AAR. 3. PCRF internal: Session Binding. 4. PCRF to P-CSCF: Diameter AAA. 5. PCRF internal: Request Access Network Info. 6. PCRF to P-CSCF: Diameter RAR. 7. P-CSCF to PCRF: Diameter RAA. 8. P-CSCF to external: 200 OK. + +**Figure B.8.1: Retrieval of Access Network Information for SMS over IP at terminating side** + +- 1.- The P-CSCF receives the 200 OK message on SIP MESSAGE request. +2. The P-CSCF requests the establishment of a new Diameter Rx session with the intention of retrieval the access network information. The P-CSCF sends a Diameter AAR command to the PCRF. +3. The PCRF performs session binding. +4. The PCRF replies with a Diameter AAA command back to the P-CSCF. +5. The PCRF requires access network information according to figure 5.2.2.2.1-1. +6. PCRF forwards the access network information received in step 5 in a Diameter RAR. +7. The P-CSCF acknowledges the receipt of Diameter RAR. +8. The P-CSCF forwards the 200 OK including the network provided location information. + +After, the P-CSCF terminates the AF session as described in subclause 4.3.1.2.3. + +# --- Annex C (normative): NAT Related Procedures + +## C.1 Support for media traversal of NATs using ICE + +The IMS calls out procedures for NAT traversal for media and signalling within IMS. One of the methods supported by IMS for media traversal of NATs is a UE controlled NAT traversal solution based on the IETF Interactive Connectivity Establishment (ICE) protocol, IETF RFC 8445 [67]. When a UE uses the ICE protocol for media traversal of NATs, additional enhancements to the existing PCC procedures are necessary to allow for proper ICE operation. + +This annex presents a set of rules that PCC network elements use to build flow descriptors, identify the proper UE IP addresses used by the PCRF for session and bearer binding, and gating control when the ICE procedures are invoked by the UE. + +In order for the ICE procedures to work a static, preconfigured PCC rule needs to be in place at the PCEF which allows the UE to perform STUN binding requests prior to offering or answering an SDP. + +- NOTE 1: Predefined PCC rules can be created to allow the UE to communicate with the STUN relay much in the same way the UE is allowed to communicate with the IMS network for session management. +- NOTE 2: Given that a STUN relay is a forwarding server under the direction of the UE, necessary precaution needs to be taken by the operator in how it chooses to craft these rules. It is recommended that such predefined rules only guarantee the minimal amount of bandwidth necessary to accomplish the necessary UE to STUN relay communication. Such an approach helps reduce the resources required to support NAT traversal mechanisms. Finally, such an approach allows the preconfigured rule to be over-ridden by dynamic rules which allow for the necessary bandwidth needed by the session. +- NOTE 3: The dynamic PCC rule will need to differentiate between different media traffic between UE and STUN relay (e.g. voice vs. video), which can be identified by the different ports assigned by the residential NAT. Session bindings need to take into account that the relevant terminal IP address may be contained within the ICE candidates contained in the session description, rather than in the normal media description. +- NOTE 4: It is assumed that the NAT device is located between the UE and the PCEF. NAT traversal outside of IMS in FBI services is considered FFS in the current 3GPP stage 2 specifications. +- NOTE 5: When a NAT device is located between the UE and the PCEF, it is assumed that the IP CAN session signalling will contain the IP address assigned by the residential NAT, rather than the UE IP address. +- NOTE 6: It is assumed that NAT devices that assign multiple IP addresses for the UE are outside the scope of release 7. +- NOTE 7: In this release, only one IP address per subscription is supported by session binding at the PCRF. Multiple Ues behind a NAT will use the same IP CAN session and IP address. + +## --- C.2 P-CSCF procedures + +### C.2.1 General + +The procedures in clause C.2 are only invoked in the case where the local UE (uplink SDP) has utilized the ICE protocol for media traversal of NATs. The P-CSCF can determine this by inspecting the UE provided SDP (uplink) for the "a=candidate" attribute(s). If such attributes are present this is an indication that the UE has invoked the ICE procedures as defined in IETF RFC 8445 [67] and IETF RFC 8839 [68] for media traversal of NATs and the P-CSCF shall follow the requirements in clause C.2. + +### C.2.2 Deriving the Ues IP address + +The P-CSCF shall set the Framed-IP-Address AVP or Framed-Ipv6-Prefix AVP to the source IP address of SIP messages received from the UE. + +### C.2.3 Deriving flow descriptions + +In the case where STUN Relay and ICE are used for NAT traversal, the UE is required to place the STUN Relay provided address in the “m=” and “c=” lines of its SDP. Given that these addresses cannot be used by the P-CSCF for building a valid flow description, the P-CSCF will need to determine if a STUN Relay address has been provided in the “m=” and “c=” lines of the UE provided SDP (uplink only). The P-CSCF shall make this determination by inspecting the uplink SDP for “a=candidate” attributes and compare the candidate address with that contained in the “c=” line. If a match is found, the P-CSCF shall then look at the candidate type. If the candidate type is “relay” then the address in the “c=” line is that of a STUN Relay server. In this case, the P-CSCF shall derive the Flow-Description AVP within the service information from the SDP candidate type of “relay” as follows: + +#### Uplink Flow-Description + +- Destination Address and Port: If the P-CSCF knows the destination address and port of the STUN Relay allocation that the UE is sending media to, it should use that information. If the P-CSCF does not know this address and port, it shall wildcard the uplink destination address and port. +- Source Address and Port: The P-CSCF shall populate the uplink source address with the “rel-addr” address and the uplink source port with the “rel-port” port contained within the “a=candidate” attribute. + +#### Downlink Flow-Description + +- Destination Address and Port: The P-CSCF shall populate the downlink destination address with the “rel-addr” address and the downlink destination port with the “rel-port” port contained within the “a=candidate” attribute. +- Source Address and Port: If the P-CSCF knows the source address and port of the STUN Relay allocation that the UE is receiving media from, it should use that information. If the P-CSCF does not know this address and port, it shall wildcard the downlink source address and port. + +For the other candidate types, the address in the “c=” and “m=” SDP attributes can be used for building the flow descriptor and the P-CSCF shall follow the rules to derive the Flow-Description AVP as described in table 6.2.2 of clause 6.2 of this TS. + +### C.2.4 Gating control + +If both endpoints have indicated support for ICE (both the SDP offer and answer contain SDP attributes of type “a=candidate”) ICE connectivity checks will take place between the two Ues. In order to allow these checks to pass through the PCEF, the P-CSCF shall enable each flow description for each media component upon receipt of the SDP answer. + +### C.2.5 Bandwidth impacts + +ICE has been designed such that connectivity checks are paced inline with RTP data (sent no faster than 20ms) and thus consumes a lesser or equal amount of bandwidth compared to the media itself (given the small packet size of a STUN connectivity check it is expected that the STUN connectivity checks will always have a smaller payload than the media stream itself). Thus, there are no additional requirements on the P-CSCF for bandwidth calculations for a given media flow. + +## --- C.3 PCRF procedures + +### C.3.1 General + +The procedures in clause C.3 are only invoked when the following two conditions are met: + +1. Both the local and remote UE have utilized the ICE protocol for media traversal of NATs (see clause C.2.1 for details on how this is determined); and +2. The IP-CAN which is servicing the IMS session does not support the concept of a default bearer. + +### C.3.2 Deriving additional flow descriptions + +The PCRF may need to develop additional flow descriptions (beyond those provided by the P-CSCF) for a media component based on additional candidate addresses present in the SDP offer/answer exchange. The PCRF shall follow the procedures defined in IETF RFC 8445 [67] and IETF RFC 8839 [68] for forming candidate pairs based on the data contained within the received Codec-Data AVP. For each candidate pair created based on the ICE procedures and not already present in the received flow descriptions, the PCRF shall add an uplink and downlink flow description for each media component. + +NOTE 1: The uplink SDP represents the local candidates while the downlink SDP represents the remote candidates. + +Following the ICE procedures for forming candidate pairs will result in some flow descriptions which would never be exercised. In particular, while the UE will send connectivity checks (and ultimately its media stream) from its host candidate, from the PCEF perspective, this will appear as being from the server reflexive address. Given this, the PCRF should not form flow descriptions using host candidate addresses and should only form additional flows based on server reflexive addresses and relay addresses. + +As candidates are removed from the SDP via subsequent offer/answer exchanges, the PCRF shall update its candidate pair list and shall remove any flow descriptors no longer being used. + +NOTE 2: If the default candidate (the candidate used to populate the "c=" and "m=" lines of both the uplink and downlink SDP) is chosen, then an updated SDP offer/answer will not be done, and any extra flow descriptions not being used by the session will not be removed. + +### C.3.3 Gating control + +For each additional flow description the PCRF adds to a media component (per clause C.3.2), the PCRF shall enable the flow in order to allow connectivity checks to pass. + +### C.3.4 Bandwidth impacts + +Per clause C.2.5 ICE is designed to have minimal impact on bandwidth policy control. However, it is possible that media will begin flowing while the ICE connectivity checks are still in progress. Given the possibility that no session update will be made (the default candidates will be chosen by the ICE protocol), it is not recommended that the PCRF adjust the bandwidth parameters provided by the P-CSCF. + +## --- C.4 P\_CSCF procedures to support media traversal through hosted NAT without ICE + +Both the media flows and the SIP signalling can traverse a NA(P)T device located in the customer premises domain, or “hosted NAT”, as described in Annex F of 3GPP TS 24.229 [5]. The hosted NAT will modify the source IP address and source port of uplink IP packets, and the destination IP address and port of downlink IP packets. The IP address and port information provided by the UE are thus not appropriate to configure PCC rules. + +The UE may use ICE procedures for hosted NAT traversal, and related PCC procedures are described in clauses C.1 to C.3. The present clause provides procedures to cover the case where ICE is not used. + +If the P-CSCF determines that the UE is located behind a hosted NAT (using procedures in Annex F of 3GPP TS 24.229 [5]) and that ICE is not used (using procedures in clause C.2.1), the P-CSCF shall, within the service information sent to the PCRF: + +- provide the source IP address of IP packets transporting incoming SIP messages from the UE as destination IP address of downlink media streams; +- for IPv4, provide the source IP address of IP packets transporting incoming SIP messages from the UE as source address of uplink media streams; +- for IPv6, derive the source address of uplink media streams from the prefix of the source IP address of IP packets transporting incoming SIP messages from the UE; +- wildcard source ports of uplink media streams; and +- wildcard destination ports of downlink media streams. +- provide the port information within SDP sent towards the served UE as source ports of corresponding downlink media streams. +- provide the port information within SDP sent towards the served UE as destination ports of corresponding uplink media streams. + +# --- Annex D (normative): Access specific procedures for GPRS + +## D.1 General + +The present annex defines IP-CAN specific requirements for General Packet Radio Service (GPRS). + +## --- D.2 Binding Mechanisms + +Depending on the bearer control mode, bearer binding can be executed either by PCRF, PCEF or both PCRF and PCEF. + +- For “UE-only” IP-CAN bearer establishment mode, the PCRF performs bearer binding. +- For “UE/NW” IP-CAN bearer establishment mode, the PCRF performs the binding of the PCC rules for user controlled services while the PCEF performs the binding of the PCC rules for the network controlled services. + +If the PCEF performs the bearer binding, the PCRF shall follow the procedures as described in clause 5.4 with the exceptions described in this subclause. + +If the Bearer Binding function is located at the PCEF, the PCEF shall check the QCI and ARP indicated by the PCC Rule(s) and bind the PCC rule with an IP-CAN bearer that has the same QCI and Evolved ARP (if this is supported by the SGSN). + +If there is no suitable PDP-Context to accommodate a PCC rule when PCEF performs the bearer binding, the PCEF shall initiate the establishment of PDP-Contexts as specified in 3GPP TS 23.060 [3]. + +The PCEF shall not combine PCC rules with different ARP to the same bearer. If the Evolved ARP parameter is not supported by the SGSN, the PCEF shall map the Evolved ARP to Rel-99 ARP as specified in clause B.3.3.3 of 3GPP TS 29.212 [9]. + +NOTE: If Evolved ARP is not supported by the SGSN then this enables a modification of the PDP context ARP without impacting the bearer binding after relocation to a SGSN that supports Evolved ARP. + +If the Bearer Binding function is located at the PCRF, the PCRF shall compare the TFT(s) of all IP-CAN bearer(s) within the IP-CAN session received via PCEF from the UE with the existing service data flow filter information. The PCRF shall indicate to the PCEF the IP-CAN bearer within the IP-CAN session where the PCC Rules shall be installed, modified or removed. This is done including the Bearer-Identifier AVP together with the associated PCC Rules within the corresponding RAR and/or CCA commands. + +- When the PCRF does not require additional filter information coming from the UE in order to decide on bearer binding, the PCRF shall supply the PCC rules to be installed over the Gx interface to the PCEF within a RAR command. +- Otherwise, the PCRF shall wait for the PCEF requesting a policy decision for the establishment of a new IP-CAN bearer or the modification of an existing one within a CCR command over the Gx interface. +- When the PCEF reports the bearer event, it shall include within the CCR command a bearer reference together with the new or modified TFT information, the QCI and associated bitrates for new or modified PDP-Contexts. + +## --- D.3 PCC Procedures + +### D.3.1 IP-CAN Session Modification + +#### D.3.1.1 Network-initiated IP-CAN Session Modification + +Network-initiated IP-CAN session modification is executed according to clause 4.3.1.1 with the following differences: + +- The timer in step 4 will also be activated waiting for one of the following cases: + - If the authorized QoS for an IP-CAN bearer is changed or + - If one or more Flow Descriptions need to be added, deactivated or removed in any of the PCC rules bound to an IP-CAN bearer +- If the timer in step 4 expires and the PCRF still requires additional filter information coming from the UE in order to decide on bearer binding for new PCC rules to be installed, all subsequent steps in figure 4.3.1.1.1 shall not be executed, and further reactions of the PCRF are left unspecified. As a possible option, the PCRF could abort the AF session. +- When the PCRF performs the bearer binding, once the PCC rules are selected, the PCRF identifies the IP-CAN bearer for each of the PCC rules and the authorized QoS. The PCRF may provision PCC Rules and authorized QoS for several IP-CAN Bearers within the same RAR command. +- For step 9, IP-CAN session signalling, the subsequent steps are executed separately for each IP-CAN bearer under the following conditions: + - if all PCC rules bound to a PDP context have been removed or deactivated (PDP Context deactivation is applicable) + - if one or more PDP contexts have to be modified + - if in UE/NW Bearer Control Mode, the GGSN needs to establish a new PDP context(PDP Context establishment is applicable) if the bearer binding is located at the PCEF. + +The GGSN initiates the procedure to Create/Update or Terminate PDP Context Request message to the SGSN. If in the case of updating the PDP Context the authorized QoS for the bearer has changed, the GGSN will modify the UMTS QoS parameters accordingly. + +When the procedure in step 9 is completed and requires notifications from the GW, for an IP-CAN Bearer termination in UE-Only Bearer Control Mode, the GGSN sends a Diameter CCR with the Bearer-Identifier and Bearer-Operation AVPs to indicate “Termination”. + +#### D.3.1.2 PCEF-initiated IP-CAN Session Modification + +PCEF-initiated IP-CAN Session Modification procedure shall take place according to clauses 4.3.2.1 and 4.3.2.2 except for those procedures initiated by the UE, as described in the clauses below. + +##### D.3.1.2.1 UE-initiated IP-CAN Bearer Establishment or IP-CAN Bearer Modification + +This clause is applicable for the establishment of a new IP-CAN Bearer (other than the one which created the IP-CAN session) and for the modification of an already established IP-CAN Bearer. The signalling flows for these cases are as per Figure 4.3.1.2.1. + +A bearer-event-initiated Request of PCC Rules occurs when a new bearer is established or when an existing bearer is modified. For GPRS, these are PDP Context Modification(s) or secondary PDP context Activation(s). An IP-CAN Session modification triggers a PCC Rule request only if the PCRF has previously requested a PCC Rule request for the given modification event. + +![Sequence diagram for UE-initiated IP-CAN Bearer Establishment and Modification. Lifelines: GW, PCRF, SPR, AF. The diagram shows 15 steps of interaction between these entities. Solid arrows represent mandatory messages, and dashed arrows represent conditional messages. Annotations explain the conditions for steps 5, 7, 14, and 15.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant UE + participant GW + participant PCRF + participant SPR + participant AF + + Note left of GW: 1. IP-CAN Bearer signalling + GW->>PCRF: 2. Diameter CCR + Note right of PCRF: 3. Store Bearer Information + Note right of PCRF: 4. Bind IP CAN session to any existing AF session(s) + Note right of PCRF: 5. Profile Request (Conditional: If the PCRF needs subscription-related information and does not have it) + PCRF-->>SPR: 6. Profile Response + Note right of PCRF: 7. Diameter RAR (Conditional: For IP CAN session modification, if requested by AF at initial authorisation) + PCRF-->>AF: 8. Diameter RAA + Note right of PCRF: 9. PCC Rules Decision, Policy Decision + Note right of PCRF: 10. Store PCC Rules + PCRF->>GW: 11. Diameter CCA + Note right of GW: 12. Installation Modification or Removal of PCC Rules, Policy Enforcement + Note left of GW: 13. IP CAN Bearer signalling response + Note right of PCRF: 14. Start of Timer. (Conditional: For GPRS, for each affected other bearer where previous authorized QoS is modified) + Note right of PCRF: 15. Interactions in Figure 4.3.1.1.1 (Conditional) + +``` + +**Legend:** + +- **Mandatory** +- **Conditional** + +Sequence diagram for UE-initiated IP-CAN Bearer Establishment and Modification. Lifelines: GW, PCRF, SPR, AF. The diagram shows 15 steps of interaction between these entities. Solid arrows represent mandatory messages, and dashed arrows represent conditional messages. Annotations explain the conditions for steps 5, 7, 14, and 15. + +**Figure D.3.1.2.1: UE-initiated IP-CAN Bearer Establishment and Modification.** + +- The GW receives IP-CAN Bearer signalling that is a trigger for a PCC Rule request. For GPRS, the GGSN receives a secondary Establish PDP Context Request or an Update PDP Context Request. +- The GW informs the PCRF of the modification of the IP-CAN Session due to the IP-CAN Bearer signalling in step 1, using a Diameter CCR with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The GW reuses the existing Gx DCC session corresponding to the IP-CAN Session. + +If the IP-CAN Bearer signalling in step 1 established a new IP-CAN Bearer, the GW assigns a new bearer identifier to this IP-CAN Bearer. The GW provides information about the new or modified bearer, e.g. requested QoS and TFT filters. If the event that caused the bearer modification applies uniquely to that bearer and PCRF performs the bearer binding, then, the bearer identifier should be provided within the CCR. If no bearer identifier is provided, the event trigger will apply to the IP-CAN session. + +3. The PCRF stores the received information in the Diameter CCR. +4. The PCRF binds the IP-CAN Session to existing AF session(s) using the information received from the GW and the Service Information included in the stored PCC rules, which was previously received from the AF(s) , as depicted in figure 4.3.1.1.1. +The PCRF also binds the IP-CAN Bearers within the IP-CAN Session to all matching IP flow(s) of existing AF session(s) using the bearer information received from the GW and the Service Information received from the AF(s). If IP flow(s), which have previously been bound to other bearers, have been bound to the modified bearer, PCC Rules in other bearer(s) may need to be removed. For GPRS, an IP flow may need to be removed if a matching higher priority TFT filter in the newly established PDP context takes precedence over a matching lower priority TFT filter in another PDP context. Furthermore, if IP Flow(s), which have previously been bound to the modified bearer are bound to other bearer(s), PCC Rules may need to be installed in other bearers. For GPRS, an IP flow may be bound to another PDP context if it was previously bound to the modified PDP context due to a removed higher priority TFT filter, and a lower priority TFT filter in the other PDP context matches the IP flow. +5. If the PCRF requires subscription-related information and does not have it, the PCRF sends a request to the SPR in order to receive the information. +6. The SPR replies with the subscription related information containing the information about the allowed service(s) and PCC Rules information. + +NOTE: For steps 5 and 6: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +7. For IP CAN session modification, if the AF requested a notification of the corresponding event at the initial authorisation of the AF session, the PCRF shall sent a Diameter RAR with the Specific-Action AVP set to indicate the trigger event that caused the request. +8. If step 7 happens, the AF replies with a Diameter RAA and may provide updated service information within. +9. The PCRF selects the new PCC Rule(s) to be installed. The PCRF can also identify existing PCC Rules that need to be modified or removed. The PCC Rules may relate to any of the matching AF sessions identified in step 4 or may exist in the PCRF without matching to any AF session. The PCRF may also make a policy decision by defining an authorized QoS and by deciding whether service flows described in the PCC Rules are to be enabled or disabled. + +For types of IP-CAN, where the PCRF controls IP-CAN Bearers, e.g. GPRS, the PCC Rules may affect the IP-CAN Bearer identified in the CCR of step 2 or any other IP-CAN Bearer identified in step 4. + +10. The PCRF stores the modified PCC Rules. +11. The PCC Rules are provisioned by the PCRF to the GW using Diameter CCA. The PCRF may also provide authorized QoS. The PCRF identifies the affected IP-CAN Bearer for each of the PCC Rules and the authorized QoS. The PCRF may provision PCC Rules and authorized QoS for several IP-CAN Bearers within the same CCA. +12. The GW installs the received PCC Rules. The GW also enforces the authorized QoS and enables or disables service flow according to the flow status of the corresponding PCC Rules. +13. The GW sends a response to the IP-CAN Bearer signalling in step 1. +For GPRS, the GGSN accepts the secondary Establish PDP Context Request or the Update PDP Context Request based on the results of the authorisation policy decision enforcement and sends an Establish PDP Context Response or Update PDP Context Response. If the requested QoS parameters do not correspond to the authorized QoS, the GGSN adjusts (downgrades/upgrades) the requested UMTS QoS parameters to the authorized values. + +The PCRF may have decided in step 4 to modify PCC Rules and/or authorized QoS of other IP CAN bearers than the IP-CAN Bearer identified in the CCR of step 2. For each such other IP-CAN Bearer identified in step 4, the GGSN executes the following steps. + +14. The PCRF may start a timer to wait for PDP context modification requests from the UE. +15. The PCRF interacts with the GW according to figure 4.3.1.1.1. + +##### D.3.1.2.2 UE-initiated IP-CAN Bearer Termination + +This clause is applicable if an IP-CAN Bearer is being released while other IP-CAN Bearers and thus the IP-CAN Session are not released. + +For the termination of IP-CAN Bearers, three cases are covered: + +- Bearer release that does not cause service data flow(s) within an AF session to be disabled; +- Bearer release that causes at least one but not all the service data flow(s) within an AF session to be disabled; and +- Bearer release that causes all the service data flows within an AF session to be disabled. + +A Bearer release may not cause a service data flow within this bearer to be disabled if the IP flow can be bound to another bearer. For GPRS, an IP flow can be bound to another PDP context if a lower precedence TFT filter matching the IP flow is installed at the other PDP context. + +![Sequence diagram for UE-Initiated IP-CAN Bearer Termination showing interactions between GW, PCRF, and AF.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +The sequence diagram illustrates the interaction between the Gateway (GW), Policy and Charging Rules Function (PCRF), and Application Function (AF) for UE-Initiated IP-CAN Bearer Termination. The process begins with an external 'Remove IP-CAN Bearer Request' to the GW. The GW sends a 'Diameter CCR' to the PCRF. The PCRF identifies IP flows, makes a PCC rule decision, and stores PCC rules. The PCRF sends a 'Diameter CCA' back to the GW. The GW then removes PCC rules and sends a 'Remove IP-CAN Bearer Response' back to the requester. The PCRF also installs PCC rules for policy enforcement. There are two conditional branches: one if IP flows were moved to other bearers, and another if all service data flows within the AF session are affected. The legend indicates that solid arrows represent mandatory messages and dashed arrows represent conditional messages. + +``` +sequenceDiagram + participant UE + participant GW + participant PCRF + participant AF + + Note left of UE: Remove IP-CAN Bearer Request + UE->>GW: 1. Remove IP-CAN Bearer Request + GW->>PCRF: 2. Diameter CCR + Note right of PCRF: 3. Identify the IP flows bound to the session or bearer. + Note right of PCRF: 4. PCC Rules Decision. Policy Decision + Note right of PCRF: 5. Store PCC Rules + PCRF->>GW: 6. Diameter CCA + Note right of GW: 7. Remove PCC Rules + GW->>UE: 8. Remove IP-CAN Bearer Response + Note right of GW: 9. Install PCC Rules. Policy Enforcement + + Note right of PCRF: If IP Flow(s) were moved to other bearer(s) + Note right of AF: If IP Flow(s) were moved to other bearer(s) + + Note right of PCRF: If all the service data flows within AF session are affected + PCRF->>AF: 10. Diameter ASR + AF->>PCRF: 11. Diameter ASA + PCRF->>AF: 12. Diameter STR + AF->>PCRF: 13. Diameter STA + + Note right of PCRF: If not all the service data flows within AF session are affected + PCRF->>AF: 10a. Diameter RAR + AF->>PCRF: 11a. Diameter RAA + PCRF->>AF: 12a. Diameter AAR + AF->>PCRF: 13a. Diameter AAA +``` + +**Legend:** + +- > **Mandatory** +- - - - -> **Conditional** + +Sequence diagram for UE-Initiated IP-CAN Bearer Termination showing interactions between GW, PCRF, and AF. + +Figure D.3.1.2.2: UE-Initiated IP-CAN Bearer Termination + +1. The GW receives a Remove IP-CAN Bearer Request that request the deactivation of an IP-CAN Bearer while other IP-CAN Bearers and thus the IP-CAN Session are not released. The form of the Remove IP-CAN Bearer Request depends upon the type of the IP-CAN. For GPRS, the GGSN receives a Delete PDP Context Request. +2. The GW sends a Diameter CCR message with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to the PCRF, indicating the IP-CAN Bearer termination. +3. The PCRF identifies the IP flows bound to the removed bearer and updates the stored bearer information. The PCRF re-evaluates the binding of IP flows, as IP flows may now be bound to other bearers. For GPRS, an IP flow may be bound to another PDP Context if it was previously bound to the removed PDP context due to a higher priority TFT filter, and a lower priority TFT filter in another PDP context matches the IP flow. + +The following steps 4 and 5 are performed for each of the other bearers identified in step 3: + +4. The PCRF selects the PCC Rule(s) to be installed or modified for the affected bearer. The PCRF may also update the policy decision for this bearer. +5. The PCRF stores the updated PCC Rules for the affected bearer. +6. The PCRF acknowledges the bearer termination by sending a Diameter CCA message. +The PCRF provides PCC Rules and possibly updated authorized QoS for each of the other bearers identified in step 3. The PCRF identifies the affected IP-CAN Bearer for each of the PCC Rules and the authorized QoS. +7. The GW removes those PCC Rules, which have not been moved to other IP CAN bearers by the CCA message and are installed in the IP-CAN bearer, for which a termination has been requested in step 1. +8. The GW sends a Remove IP-CAN Bearer Response. For GPRS, the GGSN sends the Delete PDP Context Response message. +9. If the PCRF has provided PCC Rules and possibly updated authorized QoS for other bearers in step 6, the GW installs or modifies the identified PCC Rules. The GW also enforces the authorized QoS and enables or disables service flow according to the flow status of the corresponding PCC Rules. + +The following steps 10 to 13 or 10a to 13a apply for the case where at least one IP Flow within an AF session is being disabled, i.e. if the IP Flow is not bound to any other bearer that is still established. The steps shall be performed separately for each ongoing AF session that is affected by the bearer release as explained below. + +If all IP flow(s) within the AF session are disabled by the bearer release: + +10. The PCRF indicates the session abort to the AF by sending a Diameter ASR message to the AF. +11. The AF responds by sending a Diameter ASA message to the PCRF. +12. The AF sends a Diameter STR message to the PCRF to indicate that the session has been terminated. +13. The PCRF responds by sending a Diameter STA message to the AF. + +If at least one but not all of the IP flow(s) within the AF session are disabled by the bearer release, and the AF has requested notification of bearer removal: + +- 10a. The PCRF indicates the release of the bearer by sending a Diameter RAR to the AF. +- 11a. The AF responds by sending a Diameter RAA to the PCRF. +- 12a. The AF may send an AAR to the PCRF to update the session information. +- 13a. If step 12a occurs, the PCRF responds by sending a AAA to the AF. + +# --- Annex E (normative): Fixed Broadband Access Interworking with EPC + +## E.1 General + +The present annex defines specific requirements for Fixed Broadband Access Interworking with EPC. + +## --- E.2 Definitions and abbreviations + +### E.2.1 Definitions + +**UE local IP address** is defined as: either the public Ipv4 address and/or Ipv6 address/Ipv6 network prefix assigned to the UE by the BBF domain in the no-NAT case, or the public Ipv4 address assigned by the BBF domain to the NATed RG that is used for this UE. + +**H(e)NB local IP address** is defined as: either the public Ipv4 address and/or Ipv6 address/Ipv6 network prefix assigned to the H(e)NB by the BBF domain in the no-NAT case, or the public Ipv4 address assigned by the BBF domain to the NATed RG that is used for this H(e)NB. + +**Non-seamless WLAN offload (NSWO)** is defined as: a capability of routing specific IP flows over the WLAN access without traversing the EPC as defined in clause 4.1.5 of 3GPP TS 23.402 [21]. + +**Non-seamless WLAN offload APN (NSWO-APN)** is defined as: an APN allowing the BPCF to indicate to PCRF that for subscribers of a certain HPLMN the IP-CAN session is related to NSWO traffic. + +**EPC-routed traffic** is defined as: User plane traffic that is routed via a PDN GW in EPC as part of a PDN Connection. EPC-routed traffic applies to non-roaming, roaming with home routed and roaming with visited access cases. + +### E.2.2 Abbreviations + +The following abbreviations are relevant for this annex only: + +| | | +|----------|------------------------------------| +| BBF | Broadband Forum | +| BPCF | Broadband Policy Control Function | +| NA(P)T | Network Address (Port) Translation | +| NSWO | Non-Seamless WLAN offload | +| NSWO-APN | Non-Seamless WLAN offload APN | +| RG | Residential Gateway | + +## --- E.3 Binding Mechanisms + +### E.3.1 EPC-routed traffic + +For EPC- routed traffic, binding mechanisms apply as defined insub clause 5.1 by PCRF, PCEF and BBERF. In addition, if both a Gx and associated S9a session exist for the same IP-CAN session, the PCRF shall generate QoS Rules for all the authorized PCC rules. + +### E.3.2 NSWO traffic + +The binding mechanism includes two steps for the NSWO traffic: + +1. Session binding. +2. PCC rule authorization. + +For NSWO traffic, session binding of AF session to an IP-CAN session is performed by the PCRF for the purpose of policy control in the Fixed Broadband access network. + +When the PCRF accepts an AA-Request from the AF over the Rx interface with service information, the PCRF shall perform session binding and associate the described service IP flows within the AF session information (and therefore the applicable PCC rules) to one and only one existing IP-CAN session. This association is done comparing the user IP address received via the Rx interface in either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP with the Ipv4 address or Ipv6 address/Ipv6 prefix received via the S9a or S9 interface. The user identity if present in the Subscription-Id AVP and the PDN information if available in the Called-Station-Id AVP may also assist on this association. + +The PCRF determines that the UE has an IP-CAN session if the IP address (Ipv4 or Ipv6) received over the Rx interface matches the Ipv4 address or Ipv6 address/Ipv6 prefix received via one or more of the following interfaces: S9a interface and S9 interface, and if the user identity is used to assist the association, the user identity received over the Rx interface matches the user identity received via one or more of the following interfaces: S9a interface and S9 interface. + +NOTE 1: In case the user identity in the IP-CAN and the application level identity for the user are of different kinds, the PCRF needs to obtain the mapping between the identities. Such mapping is not subject to specification within this TS. + +NOTE 2: An Ipv6 address provided over Rx matches an Ipv6 prefix provided over S9a or S9 if the Ipv6 address belongs to the Ipv6 (sub-)network prefix. + +As a result from the session binding function, the PCRF identifies what IP-CAN session the current AF session is related with. If the PCRF is not capable of executing the Session Binding, the PCRF shall issue an AA-Answer command to the AF with a negative response. + +NOTE: For roaming cases, the H-PCRF performs session binding of the AF session to an IP-CAN session. + +The PCRF derives and authorises PCC rules as described in clause 5. + +## --- E.4 PCC Procedures + +### E.4.1 Introduction + +From the network scenarios listed in clause 4.0, in order to support interworking with Fixed Broadband access network, three distinct network scenarios are defined as follows: + +- the Case 1 (no Gateway Control Session over Gxx reference point) applies to GTP-based S2a or GTP-based S2b, trusted S2c and GTP-based S5/S8 H(e)NB scenarios. +- the Case 2a (the same Gateway Control Session over Gxx reference point) applies to untrusted S2c. +- the Case 2b (a Gateway Control Session over Gxx reference point per IP-CAN Session) applies to PMIP-based S2b and PMIP-based S5/S8 H(e)NB scenarios. + +NOTE: No policy interworking solution based on S9a is defined for Fixed Broadband access interworking via S2a in this Release. + +Additionally, for case 1, the PCRF checks whether the CoA information is included in the CC-Request command to differentiate the GTP-based S2b case and trusted S2c case. If it is included, the trusted S2c case applies; otherwise, the GTP-based S2b case applies. + +### E.4.2 IP-CAN Session Establishment + +#### E.4.2.1 IP-CAN Session Establishment for EPC- routed traffic + +This procedure is applicable for WLAN and H(e)NB scenarios for EPC-routed traffic. This procedure is same as described in clause 4.1 with the exceptions described in this clause. + +![Sequence diagram for IP-CAN Session Establishment for EPC-routed traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, SPR, OCS. The diagram shows two main phases: Step 1-6 and Step 7-15. Step 1-6 involves Diameter messages (TER/RAR, TEA/RAA, CCR, CCA) between BPCF, V-PCRF, and H-PCRF, with internal processing steps like 'Store information'. Background shading indicates different roaming cases: Roaming case (Home Routed, case 1), Roaming case (Visited Access, case 2a or case 2b).](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +The diagram illustrates the IP-CAN Session Establishment for EPC-routed traffic across various roaming scenarios. The lifelines involved are BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, SPR, and OCS. + +**Phase 1: Perform step 1 through step 6: as specified in Figure 4.1.1: IP-CAN session establishment** + +- Roaming case (Home Routed, case 1):** + - BPCF sends 2. Diameter TER/RAR to H-PCRF. + - H-PCRF sends 2a. Diameter TER/RAR to V-PCRF. + - V-PCRF sends 2b. Diameter TER/RAR to BPCF. + - BPCF sends 3. Diameter TEA/RAA to H-PCRF. + - H-PCRF sends 3a. Diameter TEA/RAA to V-PCRF. + - V-PCRF sends 3b. Diameter TEA/RAA to BPCF. + - BPCF sends 4. Diameter CCR to H-PCRF. + - H-PCRF sends 4a. Diameter CCR to V-PCRF. + - V-PCRF performs 4b. Store information. + - V-PCRF sends 4c. Diameter CCR to H-PCRF. + - H-PCRF sends 6. Diameter CCA to BPCF. + - H-PCRF sends 6a. Diameter CCA to V-PCRF. + - V-PCRF sends 6b. Diameter CCA to BPCF. +- Roaming case (Visited Access, case 2a or case 2b):** + - BPCF sends 2c. Diameter TER/RAR to H-PCRF. + - BPCF sends 3c. Diameter TEA/RAA to H-PCRF. + - BPCF sends 4d. Diameter CCR to H-PCRF. + - H-PCRF performs 4e. Store information. + - H-PCRF performs 5. Store information. + - H-PCRF sends 6c. Diameter CCA to BPCF. + +**Phase 2: Perform step 7 through step 15: as specified in Figure 4.1.1: IP-CAN session establishment** + +Sequence diagram for IP-CAN Session Establishment for EPC-routed traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, SPR, OCS. The diagram shows two main phases: Step 1-6 and Step 7-15. Step 1-6 involves Diameter messages (TER/RAR, TEA/RAA, CCR, CCA) between BPCF, V-PCRF, and H-PCRF, with internal processing steps like 'Store information'. Background shading indicates different roaming cases: Roaming case (Home Routed, case 1), Roaming case (Visited Access, case 2a or case 2b). + +**Figure E.4.2.1.1 IP-CAN Session Establishment for EPC-routed traffic** + +1. Step 1 through step 6: as specified in Figure 4.1.1: IP-CAN session establishment are executed towards the H-PCRF (non-roaming case or home routed case) or towards the V-PCRF (roaming case). + +For case 2a and case 2b of the WLAN scenario and for case 2b of the H(e)NB scenario, the BBERF provides the data as described in 3GPP TS 29.212 [9], clause E.5.2. + +For case 1, the PCEF provides the data as described in 3GPP TS 29.212 [9], clause E.5.1. + +For case 1 (visited access), case 2a and case 2b (home routed and visited access) the V-PCRF forwards the data towards the H-PCRF. + +NOTE: For the roaming case, the V-PCRF omits the UE Local IP address (WLAN scenario), the H(e)NB Local IP address and the UDP port in the S9 reference point. + +2. For GTP/PMIP-based S2b of the WLAN scenario (non-roaming case) the PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure triggered by the Gateway Control session establishment or Indication of IP-CAN session establishment in step 1. + +For trusted and untrusted S2c of the WLAN scenario (non roaming case), when there is not an already established S9a session for the user, the PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure triggered by the Gateway Control session establishment in step 1; otherwise, the PCRF may send a RAR command to BPCF to provide the QoS rules to the BPCF. + +For H(e)NB scenario (non roaming case), when there is not an already established S9a session for the H(e)NB Local IP address, the PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure triggered by the Gateway Control session establishment or Indication of IP-CAN session establishment in step 1; otherwise, the PCRF may send a RAR command to BPCF to provide the QoS rules to the BPCF. + +The PCRF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.1 + +For case 1 (roaming with home routed case), the steps 2a and step 2b are executed instead of step 2. + +- 2a. If there is not an already established S9 session for the user, the H-PCRF sends a TER command to V-PCRF to trigger an S9 session establishment procedure triggered by the Indication of IP-CAN session establishment in step 1; otherwise, the H-PCRF sends a RAR command to V-PCRF to trigger an S9 subsession establishment procedure. + +The H-PCRF trigger an S9 session/subsession establishment procedure as described in 3GPP TS 29.215 [22], clause A.6.1.1.1 or A.6.3.1.0. + +- 2b. For GTP-based S2b of the WLAN scenario, the V-PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure. + +For trusted S2c of the WLAN scenario, if there is not an already established S9a session for the user, the V-PCRF sends a TER command to BPCF; otherwise, the PCRF may send a RAR command to BPCF to provide the QoS rules to the BPCF. + +For the H(e)NB scenario and if there is not an already established S9a session for the H(e)NB local IP address, the V-PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure; otherwise the V-PCRF may send a RAR command to BPCF to provide the QoS rules to the BPCF. + +The V-PCRF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.1. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 2c is executed instead of step 2. + +- 2c. For trusted and untrusted S2c of the WLAN scenario when there is not an already established S9a session for the user, the V-PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure; otherwise, the PCRF may send a RAR command to BPCF to provide the QoS rules to the BPCF. + +For GTP/PMIP-based S2b of the WLAN scenario the V-PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure. + +For case 1 and case 2b of the H(e)NB scenario when there is not an already established S9a session for the H(e)NB local IP address, the V-PCRF sends a TER command to BPCF to trigger an S9a session establishment procedure; otherwise, the V-PCRF may send a RAR command to provide the QoS rules to the BPCF. + +The V-PCRF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.1. + +3. The BPCF acknowledges to the PCRF by sending the TEA /RAA command. + +For case 1(roaming with home routed case), steps 3a and step 3b are executed instead of step 3. + +- 3a. The BPCF acknowledges to the V-PCRF by sending the TEA /RAA command. + +- 3b. The V-PCRF acknowledges to the H-PCRF by sending the TEA/RAA command. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 3c is executed instead of step 3. + +- 3c. The BPCF acknowledges to the V-PCRF by sending the TEA/RAA command. + +4. For the non-roaming case, triggered by step 2, the BPCF initiates an S9a session establishment with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.2. + +For case 1 (roaming with home routed case), the steps 4a~4c are executed instead of step 4. + +- 4a. Triggered by step 2b, the BPCF initiates an S9a session establishment with the V-PCRF by sending a CCR to the V-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.2. + +- 4b. The V-PCRF determines that the request is for a roaming user and stores the received information. + +- 4c. If there is not an already established S9 session for the user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. If there is an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), the steps 4d~step 4e are executed instead of step 4. + +4d. Triggered by step 2c, the BPCF initiates an S9a session establishment with the V-PCRF by sending a CCR to the V-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF provides the data as described in 3GPP TS 29.215 [22], clause A.5.1.2. + +4e. The V-PCRF determines that the request is for a roaming user and stores the received information. + +5. The H-PCRF stores the information received in the CCR. + +6. For the non-roaming case, the H-PCRF acknowledges the S9a session establishment by sending a CCA to the BPCF. + +For case 1 (roaming with home routed case), steps 6a~6b are executed instead of step 6. + +6a. The H-PCRF acknowledges the S9 session establishment/modification by sending a CCA to the V-PCRF. + +6b. The V-PCRF acknowledges the S9a session establishment by sending a CCA to the BPCF. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), the step 6c is executed instead of step 6. + +6c. The V-PCRF acknowledges the S9a session establishment by sending a CCA to the BPCF. + +7. Step 7 through step 15: as specified in Figure 4.1.1: IP-CAN session establishment are executed. Step 13 is only applicable to case 2b of H(e)NB scenario. + +#### E.4.2.2 IP-CAN Session Establishment for NSWO traffic + +![Sequence diagram for IP-CAN Session Establishment for NSWO traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, SPR. The diagram shows a non-roaming case and two roaming cases. The non-roaming case involves BPCF sending a Diameter CCR to H-PCRF, which then performs steps 5-11. The first roaming case involves BPCF sending a Diameter CCR to V-PCRF, which stores information and sends a Diameter CCR to H-PCRF. The second roaming case involves H-PCRF sending a Diameter CCA to V-PCRF, which stores PCC rules and sends a Diameter CCR to H-PCRF. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional.](164d1b48231be457522b31965610ea3b_img.jpg) + +``` + +sequenceDiagram + participant BPCF + participant V-PCRF + participant H-PCRF + participant TDF + participant SPR + + Note left of BPCF: 1. Trigger + BPCF->>H-PCRF: 2. Diameter CCR + Note right of BPCF: ROAMING CASE + BPCF->>V-PCRF: 2a. Diameter CCR + V-PCRF->>V-PCRF: 2b. Store Information + V-PCRF->>H-PCRF: 2c. Diameter CCR + H-PCRF->>H-PCRF: 3. Store Information + H-PCRF->>TDF: 4. Perform step 5 through 11: as specified in Figure 4.1.1: IP-CAN session establishment + H-PCRF->>BPCF: 5. Diameter CCA + Note right of BPCF: ROAMING CASE + H-PCRF->>V-PCRF: 5a. Diameter CCA + V-PCRF->>V-PCRF: 5b. Store PCC Rules, if available, Policy Decision + V-PCRF->>H-PCRF: 5c. Diameter CCR + H-PCRF->>V-PCRF: 5d. Diameter CCA + V-PCRF->>TDF: 5e. TDF session establishment + V-PCRF->>BPCF: 5f. Diameter CCA + + Note right of SPR: Legend + solid arrow: Mandatory + dashed arrow: Conditional + +``` + +Sequence diagram for IP-CAN Session Establishment for NSWO traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, SPR. The diagram shows a non-roaming case and two roaming cases. The non-roaming case involves BPCF sending a Diameter CCR to H-PCRF, which then performs steps 5-11. The first roaming case involves BPCF sending a Diameter CCR to V-PCRF, which stores information and sends a Diameter CCR to H-PCRF. The second roaming case involves H-PCRF sending a Diameter CCA to V-PCRF, which stores PCC rules and sends a Diameter CCR to H-PCRF. A legend indicates that solid arrows are Mandatory and dashed arrows are Conditional. + +Figure E.4.2.2.1: IP-CAN Session Establishment for NSWO traffic + +1. The broadband access network becomes aware of the IMSI of the 3GPP UE if 3GPP-based access authentication (EAP-AKA/AKA') is performed. The BPCF also becomes aware of the UE local IP address. +2. For the non-roaming case, the BPCF initiates an S9a\* session establishment procedure with the H-PCRF by sending a CCR using the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF shall provide the data as described in 3GPP TS 29.215 [22], clause A.5.1.2.1. + +For the roaming case, steps 2a~2c are executed instead of step 2. + +- 2a. The BPCF initiates an S9a\* session establishment procedure with the V-PCRF by sending a CCR to the V-PCRF using the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF shall provide the data as described in 3GPP TS 29.215 [22], clause A.5.1.2.1. +- 2b. The V-PCRF determines that the request is for a roaming user and stores the received information. +- 2c. If there is not an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. + +If there is an already established S9 session for this roaming user, the V-PCRF sends a CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The V-PCRF includes the Subsession-Enforcement-Info AVP within the CCR with a new S9 subsession identifier assigned by the V-PCRF to this IP-CAN session within the Subsession-Id AVP, and the Subsession-Operation AVP set to the value ESTABLISHMENT. + +3. The H-PCRF stores the information received in the CCR. +4. Perform step 5 through 11: as specified in Figure 4.1.1: IP-CAN session establishment. Additionally, an indication on whether policy control for NSWO traffic should be performed for the UE may be retrieved from the SPR. The H-PCRF enables policy control for NSWO traffic for that UE based on operator policies and user profile information that may depend on e.g. NSWO-APN being used by the UE. +5. For the non-roaming case, the H-PCRF provisions the PCC Rules to the BPCF using CCA if policy control is enabled. + +For the roaming case, steps 5a~5f are executed instead of step 5. + +- 5a. The H-PCRF provisions the PCC Rules if available to the V-PCRF using CCA if policy control is enabled. The H-PCRF includes PCC Rules and ADC Rules if available in the Subsession-Decision AVP of the CCA, along with the S9 subsession identifier as received in step 2c within the Subsession-Id AVP. +- 5b. If policy control is enabled in step 5a, the V-PCRF stores the received PCC rules if available. The V-PCRF enforces visited operator policies regarding QoS authorization requested by the H-PCRF as indicated by the roaming agreements. +- 5c. The V-PCRF informs the H-PCRF when a request has been denied and may provide the acceptable QoS information for the service. +- 5d. The H-PCRF acknowledges the CCR and may additionally include new or modified PCC rules to the V-PCRF. When user profile configuration indicates that Application Detection and Control function is enabled, the H-PCRF may additionally include new or modified PCC rules for application detection and control. +- 5e. In case of solicited application reporting with a TDF, the V-PCRF initiates a TDF Session Establishment procedure, according to clause 4.6.1, with the selected TDF. +- 5f. The V-PCRF provisions PCC rules received from the H-PCRF to the BPCF by using CCA. + +### E.4.3 IP-CAN Session Termination + +#### E.4.3.1 IP-CAN Session Termination for EPC- routed traffic + +![Sequence diagram for IP-CAN Session Termination for EPC-routed traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, H/V-AF, SPR, OCS. The diagram shows message exchanges for various roaming cases (Home Routed, Visited Access) and initiation types (UE-initiated, PCEF-initiated, PCRF-initiated).](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +The diagram illustrates the interaction between network elements for IP-CAN session termination. The lifelines are BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, H/V-AF, SPR, and OCS. + +**Step 1:** Perform the step 1 through step 3: as defined in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN, step 1 through step 5: as defined in Figure 4.2.2.1: PCEF-initiated IP-CAN session termination-AF located in HPLMN or step 1 through step 8: as defined in Figure 4.2.3.1: PCRF-initiated IP-CAN session termination-AF located in HPLMN + +**Roaming case (Home Routed and case 1):** + +- 2. Diameter RAR (BPCF to V-PCRF) +- 2a. Diameter RAR (V-PCRF to H-PCRF) +- 2b. Diameter RAR (H-PCRF to BPCF) +- 3. Diameter RAA (V-PCRF to BPCF) +- 3a. Diameter RAA (BPCF to V-PCRF) +- 3b. Diameter RAA (V-PCRF to H-PCRF) + +**Roaming case (Visited Access, case 2a or case 2b):** + +- 2c. Diameter RAR (BPCF to V-PCRF) +- 3c. Diameter RAA (V-PCRF to BPCF) + +**Roaming case (Home Routed and case 1):** + +- 4. Diameter CCR (BPCF to V-PCRF) +- 4a. Diameter CCR (V-PCRF to BPCF) +- 4b. Diameter CCR (V-PCRF to H-PCRF) + +**Roaming case (Visited Access, case 2a or case 2b):** + +- 5. Diameter CCA (BPCF to V-PCRF) +- 5a. Diameter CCA (V-PCRF to BPCF) +- 5b. Diameter CCA (V-PCRF to H-PCRF) +- 5c. Diameter CCA (BPCF to V-PCRF) + +**Step 6:** Perform the step 3 through step 7 :as specified in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN + +**Step 7:** Perform the step 8 through step 11 :As Specified in Figure 4.2.1.1 for AF located in HPLMN or step 2 through step 9 :as specified in Figure 4.2.1.2 for AF located in VPLMN + +**Step 8:** Perform the step 12 through step 15 :as specified in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN + +Sequence diagram for IP-CAN Session Termination for EPC-routed traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, H/V-AF, SPR, OCS. The diagram shows message exchanges for various roaming cases (Home Routed, Visited Access) and initiation types (UE-initiated, PCEF-initiated, PCRF-initiated). + +Figure E.4.3.1.1: IP-CAN Session Termination for EPC-routed traffic + +1. Perform the step 1 through step 3: as defined in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN, step 1 through step 5: as defined in Figure 4.2.2.1: PCEF-initiated IP-CAN session termination-AF located in HPLMN or step 1 through step 8: as defined in Figure 4.2.3.1: PCRF-initiated IP-CAN session termination-AF located in HPLMN. +2. For GTP/PMIP-based S2b of the WLAN scenario (non-roaming case), triggered by a Gateway control session termination from BBERF(ePDG) or by an Indication of IP-CAN session termination from PCEF, the H-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session. + +For trusted and untrusted S2c of the WLAN scenario (non-roaming case), triggered by the Indication of IP-CAN session termination, the H-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session when the last PDN connection is released for this user; otherwise, the H-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection. + +For H(e)NB scenario (non-roaming case), triggered by a Gateway control session termination from BBERF(S-GW) or by an indication of IP-CAN session termination, the H-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session when last PDN connection is released for this H(e)NB Local IP address; otherwise, the H-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection. + +For case 1 (roaming with home routed case), the steps 2a and step 2b are executed instead of step 2. + +- 2a. If the subsession being terminated is the last subsession over S9, the H-PCRF sends a RAR including the Session-Release-Cause AVP to the V-PCRF to indicate the termination of the S9 session. Otherwise, the H-PCRF sends a RAR to the V-PCRF including the Subsession-Decision-Info AVP with the Session-Release-Cause AVP to indicate the request for terminating the S9 subsession corresponding to the IP-CAN session. +- 2b. For GTP-based S2b of the WLAN scenario, the V-PCRF sends a RAR including the Session-Release-Cause AVP to the BPCF to indicate the request for terminating the S9a session. + +For trusted S2c of the WLAN scenario, the V-PCRF sends a RAR including the Session-Release-Cause AVP to the BPCF to indicate the request for terminating the S9a session when the last PDN connection is released for this user; otherwise, the V-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection. + +For the H(e)NB scenario, the V-PCRF sends a RAR including the Session-Release-Cause AVP to the BPCF to indicate the request for terminating the S9a session when the last PDN connection is released for this H(e)NB Local IP address; otherwise, the V-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 2c is executed instead of step 2. + +- 2c. For GTP/PMIP-based S2b of the WLAN scenario, triggered by a Gateway control session termination from BBERF(ePDG) or by an Indication of IP-CAN session termination, the V-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session. + +For trusted and untrusted S2c of the WLAN scenario, triggered by the Indication of IP-CAN session termination or S9 session/subsession termination request from the H-PCRF, the V-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session when the last PDN connection is released for this user; otherwise, the V-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection + +For case 1 and case 2b of H(e)NB scenario, triggered by a Gateway control session termination from the BBERF(S-GW) or by an Indication of IP-CAN session termination, the V-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a session when the last PDN connection is released for this H(e)NB Local IP address; otherwise, the H-PCRF sends a RAR to BPCF to remove all the QoS rules related to the released PDN connection. + +3. For the non-roaming case, the BPCF sends a RAA to acknowledge the RAR. + +For case 1 (roaming with home routed case), the steps 3a and 3b are executed instead of step 3. + +- 3a. The BPCF sends a RAA to the V-PCRF. + +3b. The V-PCRF sends a RAA to the H-PCRF. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 2c is executed instead of step 2. + +3c. The BPCF sends a RAA to the V-PCRF. + +4. For the non-roaming case, the BPCF sends a CCR to the H-PCRF to indicate the S9a session termination if the H-PCRF requests that the BPCF terminates the S9a session in step 2. The BPCF requests the termination of the S9a session using the CC-Request-Type set to the value TERMINATION\_REQUEST. + +For case 1(roaming with home routed case), the steps 4a and 4b are executed instead of step 4 + +4a. The BPCF sends a CCR to the V-PCRF to indicate the S9a session termination if the V-PCRF requests that the BPCF terminates the S9a session in step 2b. The BPCF requests the termination of the S9a session using the CC-Request-Type set to the value TERMINATION\_REQUEST. + +4b. The V-PCRF sends a CCR to the H-PCRF to indicate the S9 session termination if the H-PCRF requests that the V-PCRF terminates the S9 session in step 2a. The V-PCRF requests the termination of the S9 session using the CC-Request-Type set to the value TERMINATION\_REQUEST. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 4c is executed instead of step 4. + +4c. The BPCF sends a CCR to the V-PCRF to indicate the S9a session termination if the V-PCRF request that the BPCF terminates the S9a session in step 2c. The BPCF requests the termination of the S9a session using the CC-Request-Type set to the value TERMINATION\_REQUEST. + +5. For the non-roaming case, the H-PCRF sends a CCA to acknowledge the CCR. + +For case 1 (roaming with home routed case), the steps 5a and 5b are executed instead of step 5 + +5a. The H-PCRF sends a CCA to acknowledge the CCR. + +5b. The V-PCRF sends a CCA to acknowledge the CCR. + +For case 1 (visited access) and for case 2a and case 2b (visited access or home routed case), step 5c is executed instead of step 5. + +5c. The V-PCRF sends a CCA to acknowledge the CCR. + +6. Perform the step 3 through step 7: as defined in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN, +7. Perform the step 8 through step 11 :As Specified in Figure 4.2.1.1 for AF located in HPLMN or step 2 through step 9 :as specified in Figure 4.2.1.2 for AF located in VPLMN +8. Perform the step 12 through step 15: as defined in Figure 4.2.1.1: UE-initiated IP-CAN session termination-AF located in HPLMN. + +#### E.4.3.2 IP-CAN Session Termination for NSWO traffic + +##### E.4.3.2.1 BPCF-initiated IP-CAN Session Termination for NSWO traffic + +![Sequence diagram for BPCF-initiated IP-CAN Session Termination for NSWO Traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, H-AF, SPR. The diagram shows a non-roaming case and two roaming cases. The non-roaming case involves BPCF sending a Diameter CCR to H-PCRF, H-PCRF identifying the AF session, and returning Diameter CCA messages. The roaming cases involve BPCF sending Diameter CCR to V-PCRF, which then forwards it to H-PCRF. Conditional steps include TDF session termination and removing information related to the terminated session. A legend indicates solid arrows for mandatory messages and dashed arrows for conditional messages.](c0e88e4bd3a209b66ee7cb67e1cec2be_img.jpg) + +``` + +sequenceDiagram + participant BPCF + participant V-PCRF + participant H-PCRF + participant TDF + participant H-AF + participant SPR + + Note left of BPCF: 1. Trigger + BPCF->>H-PCRF: 2. Diameter CCR + Note right of V-PCRF: ROAMING CASE + BPCF->>V-PCRF: 2a. Diameter CCR + V-PCRF-->>TDF: 2b. TDF session termination + V-PCRF->>H-PCRF: 2c. Diameter CCR + Note right of H-PCRF: 3. Identify AF Session bound to the remove IP-CAN session + H-PCRF->>BPCF: 4. Diameter CCA + Note right of V-PCRF: ROAMING CASE + H-PCRF->>V-PCRF: 4a. Diameter CCA + Note right of BPCF: 4b. Removes the information related to the terminated IP-CAN session + V-PCRF->>BPCF: 4c. Diameter CCA + Note right of TDF: 5. TDF session termination + Note right of SPR: 6. Perform step 8 through 12: as specified in Figure 4.2.1.1: UE-Initiated IP-CAN Session Termination – AF located in the HPLMN + +``` + +Sequence diagram for BPCF-initiated IP-CAN Session Termination for NSWO Traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, H-AF, SPR. The diagram shows a non-roaming case and two roaming cases. The non-roaming case involves BPCF sending a Diameter CCR to H-PCRF, H-PCRF identifying the AF session, and returning Diameter CCA messages. The roaming cases involve BPCF sending Diameter CCR to V-PCRF, which then forwards it to H-PCRF. Conditional steps include TDF session termination and removing information related to the terminated session. A legend indicates solid arrows for mandatory messages and dashed arrows for conditional messages. + +Figure E.4.3.2.1.1: BPCF-initiated IP-CAN Session Termination for NSWO Traffic + +1. The Fixed Broadband Access network is aware of the UE is detached from the broadband access network +2. For the non-roaming case, the BPCF sends a CCR to the H-PCRF to indicate the S9a\* session termination. The BPCF requests the termination of the S9a\* session using the CC-Request-Type set to the value TERMINATION\_REQUEST. + +For the roaming case, the steps 2a and 2c are executed instead of step 2. + +- 2a. The BPCF sends a CCR to the V-PCRF to indicate the S9a\* session termination. The BPCF requests the termination of the S9a\* session using the CC-Request-Type set to the value TERMINATION\_REQUEST. +- 2b. If there is an active TDF session between TDF and V-PCRF, the TDF session termination is initiated as defined in clause 4.6.2. For this case, the PCRF described in clause 4.6.2 acts as a V-PCRF. + +- 2c. The V-PCRF sends the CCR to the H-PCRF. If this is the last subsession associated with the S9 session, the V-PCRF sends a CCR to the H-PCRF to request the termination of the S9 session using the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. Otherwise, the V-PCRF sends a CCR to the H-PCRF with a CC-Request-Type AVP set to the value UPDATE\_REQUEST and a Subsession-Enforcement-Info within which the Subsession-Operation AVP set to value TERMINATION to request the termination of the corresponding S9 subsession. +3. The H-PCRF identifies the AF sessions that are bound to IP flows of the removed IP-CAN Session. +4. For the non-roaming case, the H-PCRF acknowledges the S9a\* session termination by sending a CCA to the BPCF. + +For the roaming case, steps 4a~4c are executed instead of step 4: + +- 4a. The H-PCRF acknowledges the S9 session or subsession termination by sending a CCA to the V-PCRF. + - 4b. The V-PCRF removes the information related to the terminated IP-CAN Session. + - 4c. The V-PCRF acknowledges the S9a\* session termination by sending a CCA to the BPCF. +5. If there is an active TDF session between TDF and H-PCRF, the TDF session termination is initiated as defined in clause 4.6.2. + 6. Perform step 8 through step 12: as specified in Figure 4.2.1.1: UE-Initiated IP-CAN Session Termination – AF located in the HPLMN + +##### E.4.3.2.2 PCRF-initiated IP-CAN Session Termination for NSWO traffic + +![Sequence diagram for PCRF-initiated IP-CAN Session Termination for NSWO traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, H-AF, SPR. The diagram shows a non-roaming case and two roaming cases. Step 1: H-PCRF detects termination. Step 2: H-PCRF sends Diameter RAR to BPCF (non-roaming) or V-PCRF (roaming). Step 2a: H-PCRF sends Diameter RAR to V-PCRF (roaming). Step 2b: V-PCRF sends Diameter RAR to BPCF (roaming). Step 3: BPCF removes PCC rules. Step 4: BPCF sends Diameter RAA to H-PCRF (non-roaming) or V-PCRF (roaming). Step 4a: BPCF sends Diameter RAA to V-PCRF (roaming). Step 4b: V-PCRF sends Diameter RAA to H-PCRF (roaming). Step 5: BPCF performs steps 2 through 6 as specified in Figure E.4.3.2.1.1.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +``` + +sequenceDiagram + participant BPCF + participant V-PCRF + participant H-PCRF + participant TDF + participant H-AF + participant SPR + + Note right of H-PCRF: 1. Detection that IP-CAN session termination is required + H-PCRF->>BPCF: 2. Diameter RAR + Note left of BPCF: ROAMING CASE + H-PCRF->>V-PCRF: 2a. Diameter RAR + V-PCRF->>BPCF: 2b. Diameter RAR + Note left of BPCF: 3. Remove all the PCC rules + BPCF->>H-PCRF: 4. Diameter RAA + Note left of BPCF: ROAMING CASE + BPCF->>V-PCRF: 4a. Diameter RAA + V-PCRF->>H-PCRF: 4b. Diameter RAA + Note right of BPCF: 5. Perform step 2 through 6: as specified in Figure E.4.3.2.1.1: BPCF-initiated IP-CAN session Termination for NSWO traffic + +``` + +**Legend** + → **Mandatory** + - - - - → **Conditional** + +Sequence diagram for PCRF-initiated IP-CAN Session Termination for NSWO traffic. Lifelines: BPCF, V-PCRF, H-PCRF, TDF, H-AF, SPR. The diagram shows a non-roaming case and two roaming cases. Step 1: H-PCRF detects termination. Step 2: H-PCRF sends Diameter RAR to BPCF (non-roaming) or V-PCRF (roaming). Step 2a: H-PCRF sends Diameter RAR to V-PCRF (roaming). Step 2b: V-PCRF sends Diameter RAR to BPCF (roaming). Step 3: BPCF removes PCC rules. Step 4: BPCF sends Diameter RAA to H-PCRF (non-roaming) or V-PCRF (roaming). Step 4a: BPCF sends Diameter RAA to V-PCRF (roaming). Step 4b: V-PCRF sends Diameter RAA to H-PCRF (roaming). Step 5: BPCF performs steps 2 through 6 as specified in Figure E.4.3.2.1.1. + +**Figure E.4.3.2.2.1: PCRF-initiated IP-CAN Session Termination for NSWO Traffic** + +1. The H-PCRF detects that the termination of an IP-CAN Session is required. +2. For the non-roaming case, the H-PCRF sends a RAR including the Session-Release-Cause AVP to request that the BPCF terminates the S9a\* session. + +For the roaming case, steps 2a~2b are executed instead of step 2: + +- 2a. If the subsession being terminated is the last subsession over S9, the H-PCRF sends a RAR including the Session-Release-Cause AVP to the V-PCRF to indicate the termination of the S9 session. Otherwise, the H-PCRF sends a RAR to the V-PCRF including the Subsession-Decision-Info AVP with the Session-Release-Cause AVP to indicate the request for terminating the S9 subsession corresponding to the IP-CAN session. + +- 2b. The V-PCRF sends a RAR including the Session-Release-Cause AVP to the BPCF. + +3. The Fixed Broadband access network removes all the PCC rules which are applied to the IP-CAN session. + +4. For the non-roaming case, the BPCF sends a RAA to acknowledge the RAR. + +For the roaming case, steps 4a~4b are executed instead of step 4: + +- 4a. The BPCF sends a RAA to the V-PCRF. + +- 4b. The V-PCRF sends a RAA to the H-PCRF and acknowledges the request for terminating the S9 session or the S9 subsession corresponding to the IP-CAN session. +5. Step 2 through 6: as specified in Figure E.4.3.2.1.1:BPCF-initiated IP-CAN session termination for NSWO traffic. + +### E.4.4 IP-CAN Session Modification + +#### E.4.4.1 IP-CAN Session Modification for EPC-routed traffic + +##### E.4.4.1.1 PCRF-initiated IP-CAN Session Modification + +This procedure is applicable both for WLAN and H(e)NB scenario. + +![Sequence diagram for PCRF-initiated IP-CAN Session Modification for EPC routed traffic. The diagram shows interactions between BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, and OCS. It includes steps 1-3, 2a-2c, 3, 4a-4b, and 5-12. A legend indicates solid arrows are Mandatory and dashed arrows are Conditional. Roaming cases are highlighted for steps 2 and 4.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +The sequence diagram illustrates the PCRF-initiated IP-CAN Session Modification for EPC routed traffic. The participants are BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, and OCS. + +The sequence of messages is as follows: + +- 1. Steps 1 to 3 as specified in figure 4.3.1.1.1**: Initial setup and trigger. +- 2. Diameter RAR**: V-PCRF sends a Diameter RAR to H-PCRF. + - 2a. Diameter RAR**: Conditional message from H-PCRF to V-PCRF. + - 2b. Perform authorization**: Internal process within H-PCRF. + - 2c. Diameter RAR**: Conditional message from V-PCRF to BPCF. +- 3. Translates QoS rule into access specific QoS**: Internal process within BPCF. +- 4. Diameter RAA**: H-PCRF sends a Diameter RAA to V-PCRF. + - 4a. Diameter RAA**: Conditional message from V-PCRF to BPCF. + - 4b. Diameter RAA**: Conditional message from BPCF to H-PCRF. +- 5. Steps 5 to 12 as specified in figure 4.3.1.1.1**: Finalization and response. + +**Legend:** + +- Mandatory**: Solid arrow +- Conditional**: Dashed arrow + +**Roaming Case:** The diagram highlights two roaming cases with light blue background shading: + + +- One for step 2 (Diameter RAR and its sub-messages). +- Another for step 4 (Diameter RAA and its sub-messages). + +Sequence diagram for PCRF-initiated IP-CAN Session Modification for EPC routed traffic. The diagram shows interactions between BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, and OCS. It includes steps 1-3, 2a-2c, 3, 4a-4b, and 5-12. A legend indicates solid arrows are Mandatory and dashed arrows are Conditional. Roaming cases are highlighted for steps 2 and 4. + +Figure E.4.4.1.1.1: PCRF-Initiated IP-CAN Session Modification for EPC routed traffic + +- 1 Step 1 to 3 as specified in figure 4.3.1.1.1 are executed. The H-PCRF receives an internal or external trigger to update PCC/QoS Rules. External trigger in Step 1 in figure 4.3.1.1.1 only applies to AF session interactions (as described in clause 4.3.1.2) and TDF session interactions (as described in clause 4.3.1.2). For V-PCRF initiated IP-CAN session modification, the V-PCRF always asks the H-PCRF for policy decision. + +NOTE: If the AF/TDF is located in the V-PLMN, upon a request from the AF/TDF, the V-PCRF will proxy the request to the H-PCRF, this may also trigger the PCRF-Initiated IP-CAN Session Modification for EPC routed traffic. + +- 2 The H-PCRF sends a Diameter RAR to update the QoS information to the BPCF. + +If the UE is roaming, then steps 2a ~ 2c are executed instead of step 2: + +- 2a. The H-PCRF sends a Diameter RAR to the V-PCRF to install, modify or remove PCC rules for Visited Access scenario, or QoS Rules for Home Routed scenario. + - 2b. The V-PCRF performs local authorization of the received PCC rules or QoS rules when necessary. + - 2c. The V-PCRF sends a Diameter RAR to the BPCF to update the QoS information. +3. The BPCF shall perform QoS validation and translates the QoS rule as received (i.e. SDF template, QCI, MBR, GBR and ARP) into access specific QoS parameters applicable in the BBF domain (the details of the mapping from 3GPP QoS parameters on S9a to QoS parameters applicable in the BBF domain is out of 3GPP scope). + 4. The BPCF sends RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the QoS rule operation. If the BPCF cannot provide the requested QoS by the H-PCRF, the BPCF may respond with the acceptable QoS. + +If the UE is roaming, then steps 4a ~ 4b are executed instead of step 4: + +- 4a. The BPCF sends RAA to the V-PCRF to acknowledge the RAR and informs the V-PCRF about the outcome of the QoS rule operation. If the BPCF cannot provide the QoS requested by the V-PCRF, the BPCF may respond with the acceptable QoS. +- 4b. The V-PCRF forwards the RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the QoS rule operation. + +NOTE: If the H-PCRF is informed that the BPCF cannot provide the requested QoS, the H-PCRF can decide to install, modify or remove QoS rules. In that case, the same flow as described in this clause will be executed. + +5. Step 5 to 12 as specified in figure 4.3.1.1.1 are executed. + +##### E.4.4.1.2 BPCF-initiated IP-CAN Session Modification + +This procedure is applicable both for WLAN and H(e)NB scenario. + +![Sequence diagram for BPCF-Initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, OCS. The diagram shows a trigger from TDF to BPCF, followed by Diameter CCR messages from BPCF to H-PCRF (step 2) or V-PCRF (step 2a). In a roaming case, V-PCRF stores info (2b) and forwards CCR to H-PCRF (2c). H-PCRF sends CCA to BPCF (step 3) or V-PCRF (step 3a). In a roaming case, V-PCRF then sends CCA to BPCF (step 3b). Finally, a PCRF-initiated IP-CAN session modification is performed (step 4). A legend indicates solid arrows are mandatory and dashed arrows are conditional.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant TDF + participant BPCF + participant V-PCRF + participant H-PCRF + participant AF + participant OCS + + Note right of TDF: 1. Trigger + TDF->>BPCF: 1. Trigger + BPCF->>H-PCRF: 2. Diameter CCR + Note right of BPCF: 2a. Diameter CCR + BPCF->>V-PCRF: 2a. Diameter CCR + Note right of V-PCRF: 2b. Store Information + V-PCRF->>H-PCRF: 2c. Diameter CCR + Note right of H-PCRF: 3. Diameter CCA + H-PCRF->>BPCF: 3. Diameter CCA + Note right of H-PCRF: 3a. Diameter CCA + H-PCRF->>V-PCRF: 3a. Diameter CCA + Note right of V-PCRF: 3b. Diameter CCA + V-PCRF->>BPCF: 3b. Diameter CCA + Note right of BPCF: 4. PCRF-initiated IP-CAN Session Modification as described in E.4.4.1.1 + +``` + +Sequence diagram for BPCF-Initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, OCS. The diagram shows a trigger from TDF to BPCF, followed by Diameter CCR messages from BPCF to H-PCRF (step 2) or V-PCRF (step 2a). In a roaming case, V-PCRF stores info (2b) and forwards CCR to H-PCRF (2c). H-PCRF sends CCA to BPCF (step 3) or V-PCRF (step 3a). In a roaming case, V-PCRF then sends CCA to BPCF (step 3b). Finally, a PCRF-initiated IP-CAN session modification is performed (step 4). A legend indicates solid arrows are mandatory and dashed arrows are conditional. + +**Figure E.4.4.1.2.1: BPCF-Initiated IP-CAN Session Modification** + +1. The trigger for this procedure is that the Fixed Broadband Access has pre-empted some resources and wants to report a QoS rule failure to the PCRF, or when the Fixed Broadband Access network cannot sustain the bandwidth allocated to a particular traffic class/DSCP aggregate. +2. The BPCF sends a Diameter CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report QoS Rule failure. + +When the UE is in roaming case, steps 2a ~ 2c are executed instead of step 2: + +- 2a. The BPCF sends a Diameter CCR to the V-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report QoS Rule failure. +- 2b. The V-PCRF stores the information received. +- 2c. For Visited Access scenario, the V-PCRF sends a Diameter CCR to the H-PCRF to report PCC Rule failure. For Home Routed scenario, the V-PCRF sends a Diameter CCR to the H-PCRF to report QoS Rule failure. + +- 3 The H-PCRF sends a Diameter CCA to the BPCF to acknowledge the CCR command. + +When the UE is in roaming case, steps 3a ~ 3b are executed instead of step 3: + +- 3a. The H-PCRF sends a Diameter CCA to the V-PCRF to acknowledge the CCR command. + +3b. The V-PCRF forwards the Diameter CCA to the BPCF to acknowledge the CCR. + +4. The PCRF-initiated IP-CAN Session Modification as described in E.4.4.1.1 may take place. + +##### E.4.4.1.3 PCEF-initiated IP-CAN Session Modification + +This procedure is applicable both for WLAN and H(e)NB scenario. + +![Sequence diagram for PCEF-initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a sequence of messages between these entities, with specific steps for roaming cases. A legend indicates solid arrows for mandatory messages and dashed arrows for conditional messages.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +The sequence diagram illustrates the PCEF-initiated IP-CAN Session Modification procedure. The lifelines are BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, and OCS. The process is divided into two main phases: Steps 1 to 3 and Steps 4 to 18. + +- Steps 1 to 3:** This phase is common to both non-roaming and roaming cases. It involves the PCEF sending a Diameter RAR to the BPCF (Step 2). In a roaming case, the BPCF sends a Diameter RAR to the V-PCRF (Step 2a), which then performs QoS rule validation (Step 2b) and sends a Diameter RAR to the BPCF (Step 2c). The PCEF then translates the QoS rule into access specific QoS (Step 3). +- Steps 4 to 18:** This phase is also common. The BPCF sends a Diameter RAA to the PCEF (Step 4). In a roaming case, the PCEF sends a Diameter RAA to the BPCF (Step 4a), which then sends a Diameter RAA to the V-PCRF (Step 4b). + +**Legend:** + +- Solid arrow: **Mandatory** +- Dashed arrow: **Conditional** + +Sequence diagram for PCEF-initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a sequence of messages between these entities, with specific steps for roaming cases. A legend indicates solid arrows for mandatory messages and dashed arrows for conditional messages. + +**Figure E.4.4.1.3.1: PCEF-Initiated IP-CAN Session Modification** + +1. Step 1 to 3 (3a-3c for the Visited Access case) is the same as specified in figure 4.3.2.1.1. In step 3 (3c for the Visited Access case), when the UE Local IP address, H(e)NB Local IP address or the UDP port number is changed, the PCEF may provide the updated UE local IP address, the updated H(e)NB IP address, and/or UDP port number if available, to the PCRF; or the PCEF cannot enforce the PCC rule(s) and need report the PCC rule failure to the PCRF. +2. The H-PCRF sends a Diameter RAR to request that the BPCF installs, modifies or removes QoS Rules (i.e. SDF template, QCI, ARP, MBR and GBR). + +When the UE is in roaming case, steps 2a ~ 2c are executed instead of step 2: + +- 2a. For Visited Access scenario, the H-PCRF may provision the PCC rule(s) to the V-PCRF. For Home Routed scenario the H-PCRF may provision the QoS rule(s) to the V-PCRF. The H-PCRF may provision for WLAN case the UE local IP address, and UDP port number (if available) and for H(e)NB case the H(e)NB local IP address, and UDP port number (if available) to the V-PCRF. + - 2b. The V-PCRF performs local authorization of the QoS Rules or PCC rules when necessary. + - 2c. The V-PCRF may provision QoS rules to the BPCF by using RAR command. The V-PCRF may provision for WLAN case the UE local IP address, and UDP port number (if available) and for H(e)NB case the H(e)NB local IP address, and UDP port number (if available) to the BPCF. + - 3 The BPCF shall perform QoS validation and translates the QoS information as received (i.e. QCI, MBR, GBR and ARP) into access specific QoS parameters applicable in the Fixed Broadband Access. +- NOTE The detail of the mapping from 3GPP QoS parameters on S9a to QoS parameters applicable in the Fixed Broadband Access is out of 3GPP scope. +4. The BPCF sends RAA to the H-PCRF to acknowledge the RAR command. If the QoS validation for admission control fails, the BPCF may include the acceptable QoS in the Fixed Broadband Access using 3GPP QoS parameters on S9a interface. +- When the UE is in roaming case, steps 4a ~ 4b are executed instead of step 2: +- 4a. The BPCF sends RAA to the V-PCRF to acknowledge the RAR command. + - 4b. The V-PCRF forwards the RAA to the H-PCRF to acknowledge the RAR command. +5. Step 4 to 18 is the same as specified in figure 4.3.2.1.1. + +##### E.4.4.1.4 BBERF-initiated IP-CAN Session Modification + +This procedure is applicable for both WLAN and H(e)NB scenario. + +![Sequence diagram for BBERF-Initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a sequence of messages between these entities, with steps 1-3 and 4-18 referenced from figure 4.3.2.1.1. It includes a 'Roaming Case' section with sub-steps 2a, 2b, and 2c, and a legend indicating mandatory and conditional messages.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The diagram illustrates the BBERF-Initiated IP-CAN Session Modification process. It features nine lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, and OCS. The sequence is divided into two main parts: '1. Steps 1 to 3 as specified in figure 4.3.2.1.1' and '5. Steps 4 to 18 as specified in figure 4.3.2.1.1'. A 'Roaming Case' is highlighted in the middle section. Within this case, step 2 is expanded into 2a (Diameter RAR from H-PCRF to V-PCRF), 2b (QoS Rule Validation in V-PCRF), and 2c (Diameter RAR from V-PCRF to BPCF). Step 3 involves translating a QoS rule into access-specific QoS. Step 4 shows Diameter RAA messages from BPCF to H-PCRF, with 4a and 4b being conditional responses. A legend at the bottom right indicates that solid arrows represent 'Mandatory' messages and dashed arrows represent 'Conditional' messages. + +Sequence diagram for BBERF-Initiated IP-CAN Session Modification. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a sequence of messages between these entities, with steps 1-3 and 4-18 referenced from figure 4.3.2.1.1. It includes a 'Roaming Case' section with sub-steps 2a, 2b, and 2c, and a legend indicating mandatory and conditional messages. + +**Figure E.4.4.1.4.1: BBERF-Initiated IP-CAN Session Modification** + +- 1 Step 1 to 3(3a-3c for the Visited Access case) is the same as specified in figure 4.3.2.1.1. + +In step 1, in case 2b and case 2a for WLAN scenario, when the UE Local IP address, and/or the UDP port number is changed, the BBERF (ePDG) may provide these information to the PCRF. For H(e)NB scenario, when the H(e)NB local IP address and the UDP port number is changed, the BBERF (S-GW) may provide these information to the PCRF. + +- 2 The H-PCRF sends a Diameter RAR to request that the BPCF installs, modifies or removes QoS Rules (e.g. SDF template, QCI, ARP, MBR and GBR). + +When the UE is in roaming case, steps 2a ~ 2c are executed instead of step 2: + +- 2a. For Visited Access scenario, the H-PCRF may provision the PCC rule(s) to the V-PCRF. For Home Routed scenario the H-PCRF may provision the QoS rule(s) to the V-PCRF. The H-PCRF provisions for WLAN case the UE local IP address and/or UDP port number, and for H(e)NB case the H(e)NB local IP address and UDP port number to the V-PCRF. +- 2b. The V-PCRF performs local authorization of the QoS Rules or PCC rules when necessary. +- 2c. The V-PCRF may provision QoS rules to the BPCF by using RAR command. The V-PCRF provisions for WLAN case the UE local IP address and/or UDP port number, and for H(e)NB case the H(e)NB local IP address and/or UDP port number to the BPCF. + +- 3 The BPCF shall perform QoS validation and translates the QoS information as received (i.e. QCI, MBR, GBR and ARP) into access specific QoS parameters applicable in the Fixed Broadband Access. + +NOTE: The detail of the mapping from 3GPP QoS parameters on S9a to QoS parameters applicable in the Fixed Broadband Access is out of 3GPP scope. + +4. The BPCF sends RAA to the H-PCRF to acknowledge the RAR command. If the QoS validation for admission control fails, the BPCF may include the acceptable QoS in the Fixed Broadband Access using 3GPP QoS parameters on S9a interface. + +When the UE is in roaming case, steps 4a ~ 4b are executed instead of step 4: + +- 4a. The BPCF sends RAA to the V-PCRF to acknowledge the RAR. + +- 4b. The V-PCRF forwards the RAA to the H-PCRF to acknowledge the RAR. + +5. Step 4 to 18 is the same as specified in figure 4.3.2.1.1. + +#### E.4.4.2 IP-CAN Session Modification for NSWO traffic + +##### E.4.4.2.1 PCRF-initiated IP-CAN Session Modification + +This procedure is applicable for WLAN scenario. + +![Sequence diagram for PCRF-Initiated IP-CAN Session Modification for NSWO traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows steps 1 to 5, with steps 2a-2c and 4a-4b representing roaming cases. A legend indicates solid arrows are mandatory and dashed arrows are conditional.](4356776ca004ecba5d599667a155d7d4_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant TDF + participant BPCF + participant V-PCRF + participant H-PCRF + participant AF + participant SPR + participant OCS + + Note right of H-PCRF: 1. Steps 1 to 3 as specified in figure 4.3.1.1.1 + H-PCRF->>BPCF: 2. Diameter RAR + Note left of BPCF: 2b. Perform authorization + BPCF->>V-PCRF: 2a. Diameter RAR + V-PCRF->>BPCF: 2c. Diameter RAR + Note right of BPCF: 3. Translates QoS rule into access specific QoS + BPCF->>H-PCRF: 4. Diameter RAA + H-PCRF->>V-PCRF: 4a. Diameter RAA + V-PCRF->>H-PCRF: 4b. Diameter RAA + Note right of V-PCRF: 5. PCRF notifies the AF + +``` + +**Legend:** + +- Solid arrow: **Mandatory** +- Dashed arrow: **Conditional** + +Sequence diagram for PCRF-Initiated IP-CAN Session Modification for NSWO traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows steps 1 to 5, with steps 2a-2c and 4a-4b representing roaming cases. A legend indicates solid arrows are mandatory and dashed arrows are conditional. + +**Figure E.4.4.2.1.1.1: PCRF-Initiated IP-CAN Session Modification for NSWO traffic** + +- 1 Step 1 to 3 as specified in figure 4.3.1.1.1 are executed. The H-PCRF receives an internal or external trigger to update PCC Rules for NSWO traffic (e.g. upon a request from the AF, a request from the TDF in the non roaming case or due to operator policies). External trigger in Step 1 in figure 4.3.1.1.1 only applies to AF session interactions (as described in clause 4.3.1.2), TDF session interactions (as described in clause 4.3.1.1) and SPR subscription data modification (as described in clause 4.3.1.1). + +NOTE: In the roaming case, the TDF is located in the V-PLMN, upon a request from the TDF, the V-PCRF will proxy the request to the H-PCRF, this may also trigger the PCRF-Initiated IP-CAN Session Modification for NSWO traffic. + +- 2 The H-PCRF sends a Diameter RAR to update the QoS information to the BPCF. + +If the UE is roaming, then steps 2a ~ 2c are executed instead of step 2: + +- 2a. The H-PCRF sends a Diameter RAR to the V-PCRF to install, modify or remove PCC Rules. + +- 2b. The V-PCRF performs local authorization of the received PCC rules when necessary. + +- 2c. The V-PCRF sends a Diameter RAR to the BPCF to update the QoS information. + +- 3 The BPCF shall perform QoS validation and translates the PCC rule as received (i.e. SDF template, QCI, MBR, GBR and ARP) into access specific QoS parameters applicable in the Fixed Broadband Access. + +NOTE: The detail of the mapping from 3GPP QoS parameters on S9a to QoS parameters applicable in the Fixed Broadband Access is out of 3GPP scope. + +4. The BPCF sends RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the PCC rule operation. If the BPCF cannot provide the requested QoS from the PCRF, the BPCF may respond with the acceptable QoS. + +If the UE is roaming, then steps 4a ~ 4b are executed instead of step 4: + +- 4a. The BPCF sends RAA to the V-PCRF to acknowledge the RAR and informs the V-PCRF about the outcome of the PCC rule operation. If the BPCF cannot provide the QoS requested by the H-PCRF, the BPCF may respond with the acceptable QoS. + +- 4b. The V-PCRF forwards the RAA to the H-PCRF to acknowledge the RAR and informs the H-PCRF about the outcome of the PCC rule operation. + +NOTE: If the H-PCRF is informed that the BPCF cannot provide the requested QoS, the H-PCRF may decide to install, modify or remove PCC rules. In that case, the same flow as described in this clause will be executed. + +5. If the AF requested it, the PCRF notifies the AF as described in steps 6-11 in clause 4.3.2.1.1. + +##### E.4.4.2.2 BPCF-initiated IP-CAN Session Modification + +This procedure is applicable for WLAN scenario. + +![Sequence diagram for BPCF-Initiated IP-CAN Session Modification for NSWO traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a trigger from TDF to BPCF, followed by Diameter CCR messages from BPCF to H-PCRF (step 2) or V-PCRF (step 2a). In a roaming case, V-PCRF stores info (2b) and forwards CCR to H-PCRF (2c). H-PCRF sends Diameter CCA to BPCF (step 3) or V-PCRF (step 3a). In a roaming case, V-PCRF forwards CCA to BPCF (step 3b). Finally, a PCRF-initiated IP-CAN session modification is performed (step 4). A legend indicates solid arrows are mandatory and dashed arrows are conditional.](68d50e85fb8de4fae0e0eafaf20e63c0_img.jpg) + +``` + +sequenceDiagram + participant BBERF + participant PCEF + participant TDF + participant BPCF + participant V-PCRF + participant H-PCRF + participant AF + participant SPR + participant OCS + + Note right of TDF: 1. Trigger + TDF->>BPCF: 1. Trigger + BPCF->>H-PCRF: 2. Diameter CCR + Note right of BPCF: 2a. Diameter CCR + BPCF->>V-PCRF: 2a. Diameter CCR + Note right of V-PCRF: 2b. Store information + V-PCRF->>H-PCRF: 2c. Diameter CCR + Note right of H-PCRF: 3. Diameter CCA + H-PCRF->>BPCF: 3. Diameter CCA + Note right of H-PCRF: 3a. Diameter CCA + H-PCRF->>V-PCRF: 3a. Diameter CCA + Note right of V-PCRF: 3b. Diameter CCA + V-PCRF->>BPCF: 3b. Diameter CCA + Note right of BPCF: 4. PCRF-initiated IP-CAN Session Modification as described in E.4.4.2.1 + +``` + +Sequence diagram for BPCF-Initiated IP-CAN Session Modification for NSWO traffic. Lifelines: BBERF, PCEF, TDF, BPCF, V-PCRF, H-PCRF, AF, SPR, OCS. The diagram shows a trigger from TDF to BPCF, followed by Diameter CCR messages from BPCF to H-PCRF (step 2) or V-PCRF (step 2a). In a roaming case, V-PCRF stores info (2b) and forwards CCR to H-PCRF (2c). H-PCRF sends Diameter CCA to BPCF (step 3) or V-PCRF (step 3a). In a roaming case, V-PCRF forwards CCA to BPCF (step 3b). Finally, a PCRF-initiated IP-CAN session modification is performed (step 4). A legend indicates solid arrows are mandatory and dashed arrows are conditional. + +**Figure E.4.4.2.2.1: BPCF-Initiated IP-CAN Session Modification for NSWO traffic** + +1. The trigger for this procedure is that the Fixed Broadband Access network has pre-empted some resources and wants to report a PCC rule failure to the PCRF, or when the Fixed Broadband Access network cannot sustain the bandwidth allocated to a particular traffic class/DSCP aggregate. +2. The BPCF sends a Diameter CCR to the H-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report PCC Rule failure. + +When the UE is roaming, steps 2a ~ 2c are executed instead of step 2: + +2a. The BPCF sends a Diameter CCR to the V-PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST to report PCC Rule failure. + +2b. The V-PCRF stores the information received. + +2c. The V-PCRF sends a Diameter CCR to the H-PCRF within the information received in step 2a to report PCC Rule failure. The V-PCRF shall link the S9a\* session to S9 session. + +- 3 The H-PCRF sends a Diameter CCA to the BPCF to acknowledge the CCR command. + +When the UE is roaming, steps 3a ~ 3b are executed instead of step 3: + +- 3a. The H-PCRF sends a Diameter CCA to the BPCF to acknowledge the CCR command.. +- 3b. The V-PCRF sends a Diameter CCA to the BPCF to acknowledge the CCR command. +4. The PCRF-initiated IP-CAN Session Modification as described in E.4.4.2.1 may take place. + +## E.5 3GPP HNB Procedures – CS Support + +### E.5.1 S9a CS Session Establishment + +In the following procedure, the PCRF is the V-PCRF for the roaming UE. + +![Sequence diagram for S9a CS session Establishment showing interactions between BPCF, HNB GW, and PCRF.](715219db84ec2a5622d09f9d822b4550_img.jpg) + +``` +sequenceDiagram + participant BPCF + participant HNB GW + participant PCRF + Note right of HNB GW: 1. Trigger + HNB GW->>PCRF: 2.Diameter CCR + Note right of PCRF: 3. Store information + PCRF->>HNB GW: 4.Diameter CCA + PCRF->>BPCF: 5.Diameter TER + BPCF->>PCRF: 6.Diameter TEA + BPCF->>PCRF: 7.Diameter CCR + PCRF->>BPCF: 8.Diameter CCA +``` + +The diagram illustrates the S9a CS session establishment procedure. It features three main entities: BPCF, HNB GW, and PCRF. The sequence of events is as follows: 1. A 'Trigger' is received by the HNB GW. 2. The HNB GW sends a 'Diameter CCR' message to the PCRF. 3. The PCRF performs a 'Store information' action. 4. The PCRF sends a 'Diameter CCA' message back to the HNB GW. 5. The PCRF sends a 'Diameter TER' message to the BPCF. 6. The BPCF sends a 'Diameter TEA' message to the PCRF. 7. The BPCF sends a 'Diameter CCR' message to the PCRF. 8. The PCRF sends a 'Diameter CCA' message back to the BPCF. + +Sequence diagram for S9a CS session Establishment showing interactions between BPCF, HNB GW, and PCRF. + +**Figure E.5.1.1: S9a CS session Establishment** + +1. The HNB GW receives a trigger to establish an S15 session with the PCRF when the HNB performs the registration to the HNB GW. +2. The HNB GW initiates an S15 session with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The HNB GW provides the HNB Local IP address and the UDP source port number of IPSec tunnel if NA(P)T is detected. +3. The PCRF stores the information received in the CCR. +4. The PCRF acknowledges the session establishment by sending a CCA message. +5. The PCRF shall send a TER command to BPCF to trigger an S9a session establishment procedure. The PCRF provides HNB Local IP address and UDP source port number if available. The PCRF shall include the Auth-Session-State AVP set to NO\_STATE\_MAINTAINED. + +NOTE: When the HNB performs the registration to the HNB GW, there is no PS service handled by the HNB. So there is no already established S9a session for the HNB. + +6. The BPCF acknowledges the TER command by sending a TEA command. +7. The BPCF initiates an S9a session establishment with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value INITIAL\_REQUEST. The BPCF provides HNB local IP address and UDP source port number if available. +8. The PCRF acknowledges the S9a Session establishment by sending a CCA to the BPCF. + +### E.5.2 PCRF initiated S9a CS Session Modification + +In the following procedure, the PCRF is the V-PCRF for the roaming UE. + +![Sequence diagram for S9a CS session Modification showing interactions between BPCF, HNB GW, and PCRF.](7a1dee155822446f7828dcb055c465c3_img.jpg) + +``` +sequenceDiagram + participant BPCF + participant HNB_GW as HNB GW + participant PCRF + Note right of HNB_GW: 1. Trigger + HNB_GW->>PCRF: 2.Diameter CCR + PCRF->>BPCF: 3.Diameter RAR + BPCF->>PCRF: 4.Diameter RAA + PCRF->>HNB_GW: 5.Diameter CCA + Note right of HNB_GW: 6. Complete the procedure for CS service +``` + +The diagram illustrates the sequence of messages for S9a CS session modification. It involves three main entities: BPCF, HNB GW, and PCRF. The process starts with a 'Trigger' at the HNB GW. The HNB GW sends a 'Diameter CCR' to the PCRF. The PCRF responds with a 'Diameter RAR' to the BPCF. The BPCF then sends a 'Diameter RAA' back to the PCRF. The PCRF sends a 'Diameter CCA' to the HNB GW. Finally, the HNB GW completes the procedure for the CS service. + +Sequence diagram for S9a CS session Modification showing interactions between BPCF, HNB GW, and PCRF. + +Figure E.5.2.1: S9a CS session Modification + +This procedure is performed when the first UE or a subsequent UE connected to a HNB requesting a CS service. + +1. The HNB GW receives RAB assignment message to request the resource for the CS service. +2. The HNB GW initiates an S15 session modification with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The HNB GW provides QoS information derived from the RAB assignment message by the HNB GW. +3. The PCRF initiates an S9a session modification procedure to the BPCF by sending a RAR to the BPCF. The PCRF provides QoS rule generated by the PCRF based on the QoS information received in step 2. +4. Fixed Broadband access network performs the admission control based on the QoS rule received in step 3 and responds with the outcome of the admission control by sending a RAA to the PCRF. +5. The PCRF responds with outcome of the admission control to the HNB GW by sending a CCA. +6. The HNB GW complete the procedure for the CS service. + +### E.5.2a BPCF initiated S9a CS Session Modification + +In the following procedure, the PCRF is the V-PCRF for the roaming UE. + +![Sequence diagram for S9a CS session Modification. Lifelines: BPCF, HNB GW, and PCRF. The sequence starts with a '1. Trigger' on the BPCF lifeline. Step 2: BPCF sends a 'Diameter CCR' to the PCRF. Step 3: PCRF sends a 'Diameter CCA' back to the BPCF. Step 4: PCRF sends a 'Diameter RAR' to the HNB GW. Step 5: HNB GW sends a 'Diameter RAA' back to the PCRF. Step 6: A box labeled 'Complete the procedure for CS service' is shown on the HNB GW lifeline.](f0bae10b54c4f3cf8d0e33f5e2fb7cfa_img.jpg) + +``` +sequenceDiagram + participant BPCF + participant HNB GW + participant PCRF + Note left of BPCF: 1. Trigger + BPCF->>PCRF: 2. Diameter CCR + PCRF-->>BPCF: 3. Diameter CCA + PCRF->>HNB GW: 4. Diameter RAR + HNB GW-->>PCRF: 5. Diameter RAA + Note right of HNB GW: 6. Complete the procedure for CS service +``` + +Sequence diagram for S9a CS session Modification. Lifelines: BPCF, HNB GW, and PCRF. The sequence starts with a '1. Trigger' on the BPCF lifeline. Step 2: BPCF sends a 'Diameter CCR' to the PCRF. Step 3: PCRF sends a 'Diameter CCA' back to the BPCF. Step 4: PCRF sends a 'Diameter RAR' to the HNB GW. Step 5: HNB GW sends a 'Diameter RAA' back to the PCRF. Step 6: A box labeled 'Complete the procedure for CS service' is shown on the HNB GW lifeline. + +**Figure E.5.2a.1: S9a CS session Modification** + +This procedure is performed when the first UE or a subsequent UE is connected to a HNB requesting a CS service. + +1. The BPCF receives the report of the QoS rule failure +2. The BPCF initiates an S9a session modification with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value UPDATE\_REQUEST. The BPCF includes QoS-Rule-Report AVP to identify the QoS rules that failed and PCC-Rule-Status AVP set to the value “INACTIVE”. +3. The PCRF acknowledges to the BPCF by sending a CCA. +4. The PCRF initiates the S15 session modification procedure by sending a RAR command to the HNB GW and includes the information as defined in clause E.5.3.2.2 of 3GPP TS 29.212 [9]. +5. The HNB GW acknowledges to the PCRF by sending a RAA. +6. The HNB GW completes the procedure for the CS service. + +### E.5.3 S9a CS Session Termination + +In the following procedure, the PCRF is the V-PCRF for the roaming UE. + +![Sequence diagram for S9a CS Session Termination showing interactions between BPCF, HNB GW, and PCRF.](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +``` +sequenceDiagram + participant BPCF + participant HNB_GW as HNB GW + participant PCRF + Note right of HNB_GW: 1. Trigger + HNB_GW->>PCRF: 2. Diameter CCR + PCRF-->>HNB_GW: 3. Diameter CCA + PCRF-->>BPCF: 4. Diameter RAR + BPCF-->>PCRF: 5. Diameter RAA + BPCF->>PCRF: 6. Diameter CCR + PCRF-->>BPCF: 7. Diameter CCA +``` + +The diagram illustrates the sequence of messages for S9a CS Session Termination. It involves three main entities: BPCF, HNB GW, and PCRF. The process begins with a 'Trigger' at the HNB GW. The HNB GW sends a 'Diameter CCR' (2) to the PCRF. The PCRF responds with a 'Diameter CCA' (3). The PCRF then sends a 'Diameter RAR' (4) to the BPCF. The BPCF acknowledges with a 'Diameter RAA' (5). The BPCF sends a 'Diameter CCR' (6) to the PCRF. Finally, the PCRF sends a 'Diameter CCA' (7) to the BPCF. + +Sequence diagram for S9a CS Session Termination showing interactions between BPCF, HNB GW, and PCRF. + +**Figure E.5.3.1: S9a CS Session Termination** + +1. The HNB GW initiates deregistration for the HNB or receives a deregistration request from the HNB. +2. The HNB GW initiates an S15 session termination with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. +3. The PCRF acknowledges the session termination by sending a Diameter CCA message to HNB GW. +4. The PCRF sends a Diameter RAR message to the BPCF including a Session-Release-Cause AVP to indicate request for terminating the S9a session. + +NOTE: When the HNB is deregistered, there is no PS service which can be handled by the HNB any more. So S9a session for the HNB can be terminated. + +5. The BPCF acknowledges the S9a session termination request by sending a Diameter RAA message. +6. The BPCF initiates the S9a session termination with the PCRF by sending a CCR to the PCRF with the CC-Request-Type AVP set to the value TERMINATION\_REQUEST. +7. The PCRF acknowledges the session termination by sending a Diameter CCA message to BPCF. + +## E.6 PCRF Addressing + +### E.6.1 General + +PCRF discovery at the DRA shall be done according to clause 7.1 with the additions described in this clause. + +For EPC-routed scenario, the DRA keeps status of the assigned PCRF for a certain UE for the applicable reference points, i.e. Gx, Gxx, Rx, Sd (Unsolicited application reporting), S9a and S9 (for roaming cases). + +For NSWO scenario, the DRA keeps status of the assigned PCRF for a certain UE for the applicable references points, i.e. Rx, Sd (Unsolicited application reporting) and S9a. The H-DRA keeps status of the assigned H-PCRF for a certain UE for Rx and S9 reference points. The V-DRA keeps the status of the assigned V-PCRF for a certain UE for the S9a and Sd (Unsolicited application reporting) reference points. + +The BPCF, as a Diameter client of the DRA, shall support all procedures required to properly interoperate with the DRA in both the proxy and redirect modes. + +### E.6.2 DRA Definition + +For the EPC-routed scenario, DRA is defined as specified in clause 7.2 with the additions described in this clause. + +The DRA is a functional element that ensures that all Diameter sessions established over the Gx, S9, Gxx, Rx, S9a and for unsolicited application reporting, the Sd reference points for a certain IP-CAN session reach the same PCRF when multiple and separately addressable PCRFs have been deployed in a Diameter realm. + +For the NSWO scenario, the DRA shall ensure that all Diameter sessions established over the Rx, S9a and for unsolicited application reporting, the Sd reference points for a certain UE reach the same PCRF. The H-DRA shall ensure that all Diameter sessions established over Rx and S9 reference points for a certain UE reach the same PCRF. The V-DRA shall ensure that all Diameter sessions established over S9a and for unsolicited application reporting, the Sd reference points for a certain UE reach the same V-PCRF. + +### E.6.3 DRA Procedure + +#### E.6.3.1 DRA Information Storage + +For EPC-routed traffic, DRA Information Storage shall be done according to clause 7.3.1 with the additions described in this subclause. The V-PCRF routing information (i.e. DRA binding) in the V-DRA is created when the S9 session establishment trigger is received. + +The V-PCRF routing information stored in the V-DRA shall be removed when the S9 session termination notification is received. + +The DRA has information about the user identity (UE NAI), the UE Local IP address/H(e)NB Local IP address, the PDN Id (if available) and the selected PCRF identity for a certain IP-CAN Session or a certain user. + +For NSWO traffic, the DRA Information Storage shall be done as specified below: + +- The DRA shall maintain PCRF routing information per UE-NAI and APN. +- The DRA has information about the user identity (UE NAI), the local UE Ipv4 address and/or the local UE Ipv6 address/prefix, the APN (i.e. NSWO\_APN) and the selected PCRF identity for a certain UE. +- The PCRF routing information stored for an S9a\* session in the DRA shall be removed after the S9a\* session is terminated. + +When both EPC-routed and NSWO traffic exist, the DRA Information Storage shall be done as specified below: + +- The DRA shall maintain PCRF routing information per UE-NAI or per UE-NAI and APN. +- The DRA has information received for both EPC-Routed and NSWO scenarios and the selected PCRF identity per UE-NAI or per UE-NAI and APN. +- The PCRF routing information stored per UE in the DRA shall be removed when no more S9a sessions and S9a\* sessions are active for the UE. + +#### E.6.3.2 Capabilities Exchange + +For EPC-routed traffic, capabilities exchange shall be done according to clause 7.3.2. + +For NSWO traffic, the Redirect DRA and Proxy DRA shall advertise the support of S9a\*, Rx and Sd (for unsolicited application reporting) applications according to clause 7.3.3. + +#### E.6.3.3 Redirect DRA + +Redirect DRA is specified in clause 7.3.4 with the additions described in this subclause. + +For EPC-routed traffic, for case 1 (home routed case), the V-DRA shall behave as follows: + +- If the request is an S9 session establishment trigger from the H-PCRF, it shall select a V-PCRF to handle the S9 session for that UE. It shall then send the redirect message including selected V-PCRF to the H-PCRF. +- If the request is an S9 session termination notification from H-PCRF, the V-DRA shall remove the PCRF routing information (i.e. DRA binding). If the V-DRA does not have a V-PCRF already selected, it shall reject the request. + +The S9 session establishment trigger and the S9 session termination notification request shall have the same information of user identity (UE NAI), the UE Local IP address/H(e)NB Local IP address, the PDN Id(if available). The DRA shall remove the DRA binding based on the above information when the DRA receives the S9 session termination notification (i.e. a TER command including DRA- Binding AVP set to the value DRA\_BINDING\_DELETION). + +For NSWO traffic, the DRA is maintaining PCRF routing information per UE-NAI and APN. The DRA shall be aware of the S9a\* Diameter termination request as defined in 3GPP TS 29.215 [22] in order to release the DRA binding information. + +#### E.6.3.4 Proxy DRA + +Proxy DRA is specified in clause 7.3.5 with the additions described in this subclause. + +For EPC-routed traffic for case 1 (home routed case), when the V-DRA receives a message from the H-PCRF, it shall behave as follows: + +- If the message is an S9 session establishment trigger from the H-PCRF, it shall select a V-PCRF to handle the S9 session for that UE. It shall then proxy the request to the selected V-PCRF. The V-DRA indicates that there is a V-DRA deployed in the visited PLMN by including the DRA-Deployment AVP in TEA command. +- If the message is an S9 session termination notification from the H-PCRF, the V-DRA shall remove the PCRF routing information (i.e. DRA binding). If the V-DRA does not have a V-PCRF already selected, it shall reject the request. + +The S9 session establishment trigger and the S9 session termination notification shall have the same information of user identity (UE NAI), the UE Local IP address/H(e)NB Local IP address and the PDN Id (if available). The DRA shall remove the DRA binding based on the above information when the DRA receives the S9 session termination notification (i.e. a TER command including DRA-Binding AVP set to the value DRA\_BINDING\_DELETION). + +Proxy DRA is specified in clause 7.3.5 with the additions described in this subclause. + +For NSWO traffic in both non-roaming and roaming cases, when the (V-) DRA receives an S9a\* request from the BPCF, it shall behave as follows: + +- If the request is an S9a\* session establishment, it shall select a V-PCRF to handle the S9 session for that UE and APN. It shall then proxy the request to the selected V-PCRF. +- If the request is an S9a\* session termination, the (V-) DRA shall remove the PCRF routing information and proxy the request to the (V-) PCRF. If the (V-) DRA does not have a (V-) PCRF already selected, it shall reject the request. +- If the request is an S9a\* session modification, the (V-) DRA shall proxy the request. + +The BPCF shall be capable of sending every message of a session to the DRA. The BPCF may be configured to bypass the (V-) DRA on S9a\* session modification messages by sending these types of messages directly to the (V-) PCRF. + +#### E.6.3.5 PCRF selection by BPCF + +For EPC-routed traffic, when the S9a Session Establishment request is triggered by the (V-) PCRF, the BPCF may use the (V-) PCRF identity provided within the PCRF-Address AVP in the S9a Session Establishment Trigger. + +The BPCF may also use the DRA procedures as described in clause 7.3. In order to do so, the BPCF shall provide the DRA of the PCRF realm with identity parameters during the S9a Session Establishment procedure. The identity parameters from the BPCF may comprise the UE Local Ipv4 or UE local Ipv6 address in the UE-Local-IP-Address AVP (WLAN scenario), H(e)NB Local IP address in the HeNB-Local-IP-Address AVP (H(e)NB scenario), PDN information in the Called-Station-Id AVP if available and user identity in the Subscription-Id AVP. The BPCF obtains these data from the S9a Session Establishment Trigger procedure initiated by the (V-) PCRF. + +For NSWO traffic, the BPCF finds the PCRF using the DRA procedures as described in clause 7.3. In order to do so, the BPCF shall provide the DRA of the PCRF realm with identity parameters during the S9a\* Session Establishment procedure. The identity parameters from the BPCF shall comprise the UE local Ipv4 address or UE local Ipv6 prefix/address in the UE-Local-IP-Address AVP or UE-Local-IP-Prefix AVP, the APN in the Called-Station-Id AVP and user identity in the Subscription-Id AVP. + +For both EPC-routed traffic and NSWO traffic, if the redirect agent is used for DRA, the DRA shall use the redirecting requests procedure as specified in IETF RFC 6733 [61], and include the PCRF identity in the Redirect-Host AVP in the Diameter reply sent to the BPCF. + +If proxy agent is used for DRA, the DRA should use the proxy procedure as specified in IETF RFC 6733 [61]. For PA2 solution (described in clause 7.1) only S9a/S9a\* session establishment and S9a/S9a\* session termination messages shall be sent through the DRA. + +For NSWO traffic in a roaming scenario the selected V-PCRF shall belong to the same VPLMN selected during the 3GPP –based authentication procedure. The BPCF uses the VPLMN-Id to find the V-DRA in the VPLMN. The V-PCRF finds the DRA in the HPLMN according to clause 7.3.8. + +NOTE: The BPCF will use the VPLMN-Id to obtain the Destination-Realm AVP used to find the V-DRA and then to find the V-PCRF using Diameter based procedures as described in IETF RFC 6733 [61]. + +#### E.6.3.6 PCRF selection by AF and TDF in Unsolicited application reporting mode for NSWO traffic + +PCRF selection by the AF shall be done according to clause 7.3.7. + +PCRF selection by the TDF shall be done according to clause 7.3.9. + +NOTE: The DRA matches the received UE IP address received in either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP in the Rx and Sd reference point with the UE Local IP Address received in UE-Local-IP-Address AVP or UE Local Ipv6 Prefix in the UE-Local-IP-Prefix AVP in the S9a reference point in order to select the same PCRF. + +#### E.6.3.7 PCRF selection in a roaming scenario + +For both EPC-routed traffic and NSWO traffic, the V-PCRF uses the DRA procedures as described in clause 7.3.8 to address the H-PCRF. In order to do so, the V-PCRF shall provide the DRA of the H-PCRF realm with identity parameters during the S9 Session Establishment procedure. + +For EPC-routed traffic, the identity parameters from the V-PCRF may comprise the UE Local Ipv4 or UE local Ipv6 address in the UE-Local-IP-Address AVP (WLAN scenario), H(e)NB Local IP address in the HeNB-Local-IP-Address AVP (H(e)NB scenario), PDN information in the Called-Station-Id AVP if available and user identity in the Subscription-Id AVP obtained from the S9 Session Establishment Trigger procedure initiated by the H-PCRF. + +For NSWO traffic, the identity parameters from the V-PCRF may comprise the UE Local Ipv4 or Ipv6 address in the UE-Local-IP-Address AVP or UE local Ipv6 prefix in the UE-Local-IP-Prefix AVP, PDN information in the Called-Station-Id AVP and user identity in the Subscription-Id AVP obtained from the S9a\* Session Establishment procedure. + +#### E.6.3.8 PCRF selection for the HNB CS Service + +When the DRA receives a request for a certain S15 Session establishment from the HNB GW, the DRA selects a suitable PCRF for the S15 Session based on the HNB local IP address within the HeNB-Local-IP-Address AVP. When the S15 Session is terminated, the DRA shall remove the information about the S15 Session. + +### E.6.4 DRA flows + +#### E.6.4.1 General + +For the EPC-routed traffic case and for the non-roaming case, the flows for the non-roaming case in the clauses 7.4.1 and 7.4.2 are applied with the following exception: + +- BPCF acts as a client and messages are S9a Diameter messages; +- The external trigger in the Establishment of Diameter Sessions is an S9a session establishment trigger message from the PCRF + +For the EPC-routed traffic case and for the roaming case, the flows for the roaming case in clauses 7.4.1 and 7.4.2 are applied with the following exception: + +- The external trigger in the Establishment of Diameter Sessions is an S9 session establishment trigger message from the PCRF for case 1 and home routed case. + +The flows in clauses E.6.4.2 and E.6.4.3 are applicable to the EPC-routed traffic and for case 1 and UE roaming in the home routed scenario. + +For the NSWO traffic case and for the non-roaming case, the flows for the non-roaming and roaming case in the clauses 7.4.1 and 7.4.2 are applied with following exception: + +- BPCF acts as a client and messages are S9a\* Diameter messages for the non-roaming case. + +#### E.6.4.2 Proxy DRA + +##### E.6.4.2.1 S9 session establishment trigger + +![Sequence diagram illustrating the S9 session establishment trigger using DRA (proxy) for a roaming case. The diagram shows four lifelines: H-PCRF, V-DRA (proxy), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. External trigger (arrow to H-PCRF), 2. TER (H-PCRF to V-DRA), 3. DRA binding creation (internal message on V-DRA), 4. Proxy TER (V-DRA to V-PCRF-1), 5. TEA (V-PCRF-1 to V-DRA), 6. Proxy TEA (V-DRA to H-PCRF).](5a24ac755b962fd5f0183f13de0726de_img.jpg) + +``` + +sequenceDiagram + participant External + participant H-PCRF + participant V-DRA as V-DRA (proxy) + participant V-PCRF-1 + participant V-PCRF-2 + + External->>H-PCRF: 1. External trigger + H-PCRF->>V-DRA: 2. TER + Note right of V-DRA: 3. DRA binding creation + V-DRA->>V-PCRF-1: 4. Proxy TER + V-PCRF-1->>V-DRA: 5. TEA + V-DRA->>H-PCRF: 6. Proxy TEA + +``` + +Sequence diagram illustrating the S9 session establishment trigger using DRA (proxy) for a roaming case. The diagram shows four lifelines: H-PCRF, V-DRA (proxy), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. External trigger (arrow to H-PCRF), 2. TER (H-PCRF to V-DRA), 3. DRA binding creation (internal message on V-DRA), 4. Proxy TER (V-DRA to V-PCRF-1), 5. TEA (V-PCRF-1 to V-DRA), 6. Proxy TEA (V-DRA to H-PCRF). + +**Figure E.6.4.2.1.1: S9 session establishment trigger using DRA (proxy) – Roaming case** + +1. The H-PCRF receives an external trigger (e.g. IP-CAN session establishment request) and determines that an S9 session shall be established. +2. A TER command including user identity, PDN ID if available, UE Local IP address/H(e)NB Local IP address and UDP source port number(if NA(P)T is detected) is sent by the H-PCRF and received by a V-DRA (proxy) in + +the visited PLMN. The Auth-Session-State AVP set to NO\_STATE\_MAINTAINED shall be included in the TER. + +3. The V-DRA (proxy) stores the user identity and creates a dynamic DRA binding for this user. (assignment of a PCRF node per UE). +4. The V-DRA (proxy) proxies the TER to the target PCRF in the visited PLMN. +5. V-PCRF-1 returns a TEA to the V-DRA (proxy). +6. V-DRA (proxy) proxies the TEA to the H-PCRF and indicates there is a DRA deployed in the visited PLMN by including the DRA-Deployment AVP in the TEA. + +NOTE: The H-PCRF is aware that there is a V-DRA (proxy) deployed in the network at this stage. + +##### E.6.4.2.2 S9 session termination notification + +![Sequence diagram for S9 session termination notification using V-DRA (proxy) in roaming cases. The diagram shows four lifelines: H-PCRF, V-DRA (proxy), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. H-PCRF initiates S9 session termination; 2. H-PCRF sends a TER message to V-DRA (proxy); 3. V-DRA (proxy) performs DRA binding verification and release; 4. V-DRA (proxy) sends a TEA message back to H-PCRF.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +``` +sequenceDiagram + participant H-PCRF + participant V-DRA as V-DRA (proxy) + participant V-PCRF-1 + participant V-PCRF-2 + Note left of H-PCRF: 1. H-PCRF initiated S9 session termination + H-PCRF->>V-DRA: 2. TER + Note right of V-DRA: 3. DRA binding verification and release + V-DRA->>H-PCRF: 4. TEA +``` + +Sequence diagram for S9 session termination notification using V-DRA (proxy) in roaming cases. The diagram shows four lifelines: H-PCRF, V-DRA (proxy), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. H-PCRF initiates S9 session termination; 2. H-PCRF sends a TER message to V-DRA (proxy); 3. V-DRA (proxy) performs DRA binding verification and release; 4. V-DRA (proxy) sends a TEA message back to H-PCRF. + +**Figure E.6.4.2.2.1: S9 session termination notification using V-DRA (proxy) – Roaming cases** + +1. The H-PCRF receives an external trigger (e.g. IP-CAN session termination request from the BBERF or the PCEF) and initiates S9 session termination procedure. +2. If the V-DRA is deployed in the VPLMN as indicated in step 6 of clause E.6.4.2.1, a TER command including DRA-Binding AVP set to the value DRA\_BINDING\_DELETION is sent by the H-PCRF and received by the V-DRA (proxy) in the visited PLMN. The message includes the same user identity as the S9 session establishment trigger message. +3. The V-DRA (proxy) verifies that there is an active DRA binding for the user based on the user identity in the request and removes the DRA binding. +4. V-DRA (proxy) returns the TEA to the H-PCRF. + +#### E.6.4.3 Redirect DRA + +##### E.6.4.3.1 S9 session establishment trigger + +![Sequence diagram for S9 session establishment trigger using DRA (Redirect) – Roaming case. The diagram shows four lifelines: H-PCRF, V-DRA (Redirect), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. External trigger to H-PCRF; 2. TER from H-PCRF to V-DRA; 3. DRA binding creation (internal to V-DRA); 4. TEA(redirect) from V-DRA to H-PCRF; 5. TER from H-PCRF to V-PCRF-1; 6. TEA from V-PCRF-1 to H-PCRF.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +``` + +sequenceDiagram + participant External + participant H-PCRF + participant V-DRA as V-DRA (Redirect) + participant V-PCRF-1 + participant V-PCRF-2 + + External->>H-PCRF: 1. External trigger + H-PCRF->>V-DRA: 2. TER + Note right of V-DRA: 3. DRA binding creation + V-DRA->>H-PCRF: 4. TEA(redirect) + H-PCRF->>V-PCRF-1: 5. TER + V-PCRF-1->>H-PCRF: 6. TEA + +``` + +Sequence diagram for S9 session establishment trigger using DRA (Redirect) – Roaming case. The diagram shows four lifelines: H-PCRF, V-DRA (Redirect), V-PCRF-1, and V-PCRF-2. The sequence of messages is: 1. External trigger to H-PCRF; 2. TER from H-PCRF to V-DRA; 3. DRA binding creation (internal to V-DRA); 4. TEA(redirect) from V-DRA to H-PCRF; 5. TER from H-PCRF to V-PCRF-1; 6. TEA from V-PCRF-1 to H-PCRF. + +**Figure E.6.4.3.1.1: S9 session establishment trigger using DRA (Redirect) – Roaming case** + +1. The H-PCRF receives an external trigger (e.g. IP-CAN session establishment request) and determines that an S9 session shall be established. +2. A TER command including user identity, PDN ID if available, UE Local IP address/H(e)NB Local IP address, UDP source port number(if NA(P)T is detected) and the FQDN of Fixed Broadband network where the H(e)NB is connected to if available is sent by the H-PCRF and received by a V-DRA (proxy) in the visited PLMN. The Auth-Session-State AVP set to NO\_STATE\_MAINTAINED shall be included in the TER. +3. The V-DRA (redirect) stores the user identity and creates a dynamic DRA binding for this user. (assignment of a PCRF node per UE). +4. The V-DRA (redirect) sends a TEA command indicating redirection as defined in IETF RFC 6733 [61]. The target V-PCRF identity is included in the Redirect-Host AVP. + +NOTE: The H-PCRF is aware that there is a V-DRA (redirect) deployed in the network at this stage. + +5. The H-PCRF re-sends the TER command of step 2 to the target V-PCRF-1. +6. The V-PCRF-1 returns a TEA 11vailab. + +##### E.6.4.3.2 S9 session termination notification + +The detailed procedure is the same as the S9 session termination notification using DRA (Proxy), which is described in clause E.6.4.2.2. + +If the H-PCRF was aware that there is a V-DRA deployed in the V-PLMN (step 4 of S9 session establishment procedure according to clause E.6.4.3.1), this procedure shall apply. + +## --- E.7 BPCF Addressing + +### E.7.1 General + +For S9a session establishment trigger procedure initiated by the (V-)PCRF, the PCRF (for non-roaming case) and the V-PCRF (for roaming case) is configured with IP address range mappings { (Ipx..Ipy) -> BBF network entry point}. The PCRF (for non-roaming) and the V-PCRF (for roaming cases) selects the correct BBF network entry point based on UE Local IP address for WLAN scenario and based on H(e)NB IP address and FQDN if available for H(e)NB case received from the PCEF/BBERF/HNB GW for H(e)NB scenario. The implementation of a BBF network entry point is out-of-scope for 3GPP e.g. be a BPCF or a DRA. + +For case 1 and roaming with home routed, for S9 session establishment trigger procedure initiated by the H-PCRF, H-PCRF finds the VPLMN according to the PLMN Id of the visited network in 3GPP-SGSN-MCC-MNC AVP if received at IP-CAN session establishment received over Gx reference point, and then discovers V-PCRF by V-DRA if there are more than one PCRF deployed in the visited network. The H-PCRF sends the H(e)NB Local IP address within HeNB-Local-IP-Address AVP and optionally the FQDN of BBF access network within the HeNB-BBF-FQDN AVP for H(e)NB scenario or the UE local IP address within the UE-Local-IP-Address AVP for WLAN scenario to the V-PCRF over the S9 reference point. + +## --- E.8 Session Linking Function + +PCRF and BPCF needs to support session linking function. The PCRF shall be able to perform the linking between multiple Gx and Gateway Control Session to the same S9a session. + +When receiving an IP-CAN Session Establishment request or an IP-CAN Session modification request with an UE local IP address or H(e)NB local IP address, the PCRF shall perform the session linking between the S9a session and the corresponding Gx session according to the UE Local IP address/ H(e)NB local IP address. + +When receiving a Gateway Control Session Establishment Request or a Gateway Control and QoS Rule Request with UE local IP Address or a H(e)NB local IP Address change, the PCRF shall perform the session linking between the S9a session and the Gateway Control Session according to the UE Local IP address/ H(e)NB local IP address. + +If there is not an established S9a session which could be linked to the Gx or Gateway Control Session, the PCRF shall initiate the S9a Session Establishment trigger procedure. + +For 3GPP HNB Procedures with CS support, the PCRF shall be able to perform the linking between S15 sessions and the S9a session. + +NOTE 1: There is a single S15 session per HNB for CS calls for all Ues connected to the HNB in order to improve performance. In addition, for CS calls there are no UE specific policies and therefore a single PCRF can handle CS calls for all Ues. + +# --- Annex F (normative): Access specific aspects, Fixed Broadband Access network convergence + +## F.1 General + +This annex defines the enhancement to PCC framework for supporting policy and charging control in the fixed broadband access network in the convergent scenario where the PCRF controls directly the network element(s) in the fixed broadband access without the mediation of a different policy server, such as the Broadband Policy Control Function (BPCF). + +Policy and charging control is provided for both Non-seamless WLAN offload traffic from a 3GPP UE and the traffic from fixed devices. + +## --- F.2 Definitions and abbreviations + +### F.2.1 Definitions + +The definitions in the following are relevant for this Annex only. + +**UE local IP address** is defined as either the public IP address assigned to the UE by the Broadband Forum domain in the no-NAT case, or the public IP address assigned by the Broadband Forum domain to the NATed RG. + +**IP-CAN session** as defined in clause 3.1 applies with the following clarifications for fixed broadband access. The term UE corresponds to the device that accesses the services provided by the network (i.e. either RG, or 3GPP UE or fixed end-device), the PDN identifies the IP network where the device gets IP connectivity and the UE identity information may be the IMSI, the user-name or the access line identifier (if available). In a Fixed Broadband Access an IP-CAN session corresponds to a Subscriber IP Session defined in Broadband Forum TR-146. + +NOTE: The PDN connection concept and APN are not applicable to a Subscriber IP session for a fixed device. + +### F.2.2 Abbreviations + +The following abbreviations are relevant for this annex only: + +| | | +|----------|-----------------------------------| +| BBF | Broadband Forum | +| BPCF | Broadband Policy Control Function | +| NSWO | Non-Seamless WLAN offload | +| NSWO-APN | Non-Seamless WLAN offload APN | +| RG | Residential Gateway | + +## --- F.3 Binding Mechanisms + +### F.3.1 NSWO traffic + +The binding mechanism in clause 5 applies, except that the QoS rule generation as described in clause 5.4 and the bearer binding as described in clause 5.4 do not apply since the Fixed Broadband Access network does not support the concept of a bearer and multiple bearers as defined in 3GPP network. + +The following exceptions or modifications in PCC rule authorization also apply: + +- The PCRF does not authorize traffic mapping information from the UE. + +- The PCEF in the IP Edge would map the received QoS information over Gx into the relevant data as specified in Broadband Forum. +- MPS, RLOS and emergency services are not supported. +- BCM concept is not applied. + +### F.3.2 Traffic from fixed devices + +The binding mechanism as described in Annex F.3.1 applies to the scenario of traffic from fixed devices with the following exceptions or modifications: + +- S9 reference point is not applicable. +- The Subscriber Identifier used by fixed device at establishment of Subscriber IP session in Fixed Broadband Access network can be the Access Line Identifier (Physical-Access-ID AVP and Logical-Access-ID AVP) or the username (Subscription-Id AVP), for example when the Subscriber IP session is a PPP Session. + +NOTE: In case the Subscriber Identifier in the IP-CAN and the application level identity for the fixed device are of different kinds, the PCRF needs to map between them. Such mapping is not subject to specification within this TS. + +## --- F.4 PCC procedures + +### F.4.1 Introduction + +The PCC procedures specified in clause 4.1, 4.2 and 4.3 apply to the Fixed Broadband Access network convergence with the following exceptions or restrictions: + +- Roaming scenarios are not applicable to fixed devices and RGs. +- Gxx reference point is not used. +- UE requested bearer resource initiation, modification or termination procedure is not supported. +- Bearer procedures are not supported in the fixed network. +- Bearer Control Mode (BCM) concept does not apply. +- Authorized QoS per bearer and authorized MBR per QCI are not applicable +- MPS Services, RLOS and IMS Emergency Services are not supported. + +### F.4.2 IP-CAN Session Establishment + +The PCEF in the IP Edge initiates the IP-CAN session establishment as specified in clause 4.1, with the exceptions as described in Annex F.4.1. The PCRF shall provide parameters to the PCEF in the IP Edge at IP-CAN session establishment as described in 3GPP TS 29.212 [9] Annex G.5.2. + +### F.4.3 IP-CAN Session Termination + +#### F.4.3.1 UE-Initiated + +UE-initiated IP-CAN session termination is not applicable to convergent scenario. + +#### F.4.3.2 PCEF-Initiated + +For PCEF-Initiated IP-CAN session termination the procedures described in clause 4.2.2 apply, with the exceptions described in clause F.4.1. + +#### F.4.3.3 PCRF-Initiated + +For PCRF-Initiated IP-CAN session termination the procedures described in clause 4.2.3 apply, with the exceptions described in clause F.4.1. + +### F.4.4 IP-CAN Session Modification + +#### F.4.4.1 PCRF-Initiated IP-CAN Session Modification + +For PCRF-Initiated IP-CAN session modification, the procedures described in clause 4.3.1 apply, with the exceptions described in clause F.4.1. The PCRF shall provide parameters to the PCEF in the IP Edge at IP-CAN session modification as described in 3GPP TS 29.212 [9] Annex G.5.4.2. + +#### F.4.4.2 PCEF-Initiated IP-CAN Session Modification + +For PCEF-Initiated IP-CAN session modification, the procedures described in clause 4.3.2 apply, with the exceptions described in clause F.4.1. The PCRF shall provide parameters to the PCEF in the IP Edge at IP-CAN session modification as described in 3GPP TS 29.212 [9] Annex G.5.4.1. + +## --- F.5 PCRF Addressing + +### F.5.1 General + +PCRF discovery and selection shall be done according to clause 7.1 with the modifications or exceptions described in this subclause. + +- Gxx reference point is not used. +- The Subscriber Identifier specified in 3GPP TS 23.203 [2] clause S.5.1.2 is used as user identity. +- For a 3GPP UE, the NSWO-APN is also available. +- The IPv6 address within the Framed-IPv6-Prefix may be included in the CCR command in the case of bridge-mode RG. + +### F.5.2 DRA Definition + +The DRA definition in clause 7.2 applies with the modifications or exceptions as described in Annex F.5.1. + +### F.5.3 DRA Procedure + +#### F.5.3.1 Redirect DRA + +Redirect DRA is specified in clause 7.3.4 with the adaptions listed in F.5.1. + +#### F.5.3.2 Proxy DRA + +Proxy DRA is specified in clause 7.3.5 with the adaptions listed in F.5.1. + +#### F.5.3.3 PCRF selection by AF and TDF in unsolicited application reporting mode + +PCRF selection by the AF shall be done according to clause 7.3.7 with the modifications or exceptions as described in Annex F.5.1. PCRF selection by the TDF shall be done according to clause 7.3.9 with the modifications or exceptions as described in Annex F.5.1. + +#### F.5.3.4 PCRF selection in a roaming scenario + +The procedures as described in clause 7.3.8 for the V-PCRF to select the H-PCRF apply with the modifications or exceptions as described in Annex F.5.1. + +### F.5.4 DRA flows + +The DRA procedures specified in clause 7.4.1 and 7.4.2 apply to the Fixed Broadband Access network convergence with the following exceptions or restrictions: + +- Gxx reference point is not used. +- Roaming scenarios are not applicable to fixed devices and RGs. + +# --- Annex G (normative): Diameter overload control mechanism + +## G.1 General + +Support for Diameter overload control by PCC functional elements is optional. Unless otherwise stated, the procedures defined in this Annex assume that a PCC functional element supports the Diameter overload control mechanism. + +IETF RFC 7683 [33] specifies the Diameter overload control mechanism. This includes the definition of Diameter overload related AVPs and the Diameter overload related behavior. + +To indicate support of the Diameter overload control mechanism, each PCC functional element shall include the OC-Supported-Features AVP in every Diameter request and answer as defined in IETF RFC 7683 [33]. + +Each PCC functional element (e.g. PCRF, PCEF, AF, etc) shall act as a reacting node and as a reporting node as defined in IETF RFC 7683 [33]. + +## --- G.2 Reporting Node + +When a PCC functional element determines the need to request a reduction in the traffic it is handling due to an overload condition, it shall include the OC-OLR AVP in answer messages, as defined in IETF RFC 7683 [33]. + +How it determines that it is in an overload situation and the severity of the overload is implementation dependent and based on operator policy. + +How it determines the specific contents of the OC-OLR AVP is implementation dependent and based on operator policy. + +## --- G.3 Reacting Node + +A PCC functional element acting as a reacting node applies the requested traffic reduction received in OC-OLR AVPs in answer messages to corresponding applicable requests, as per IETF RFC 7683 [33]. + +How it achieves the requested traffic reduction is implementation dependent. + +Diameter requests related to priority traffic (e.g. MPS) as described in 3GPP TS 22.153 [58] and emergency have the highest priority. If required by the regional/national regulatory and operator policies, and when the reacting node is able to detect priority traffic, priority traffic shall be exempted from throttling due to Diameter overload control up to the point where requested traffic reduction cannot be achieved without throttling the priority traffic. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +## --- G.4 DRA Diameter Overload Behavior + +The DRA may optionally incorporate agent behavior specified in IETF RFC 7683 [33]. + +### G.4.1 DRA reacting to Host Reports + +The procedures defined in this clause are only applicable to the proxy DRA (PA1 and PA2) as the redirect DRA is not in the path of application answers and as such does not have access to overload reports from other nodes. + +The proxy DRA shall use host reports as one of the inputs when making routing decisions for realm-routed requests, i.e. requests that do not contain a Destination-Host AVP. This is needed because entities sending such requests are not aware of the final recipient of the request (e.g. specific PCRF instance). + +The following scenarios shall be addressed: + +- No binding exists for the request and the request can result in a new binding (e.g. IP-CAN session establishment); in this case the DRA is selecting the PCRF that will handle the binding. The DRA should use any active and relevant Diameter overload host reports as one of the inputs to the selection of the PCRF. If all PCRFs are in an overload state, the DRA should reduce traffic sent to each of the PCRFs based on the individual host requested traffic reduction. This may result in the DRA rejecting the request. +- A binding already exists for the request – In this case the DRA should reduce the traffic sent to the overloaded node by the host requested traffic reduction. This may result in the DRA rejecting the request. + +NOTE: Result-Code when rejecting a request in the above cases need to be used according to the IETF RFC 7683 [33]. + +How the DRA achieves any requested traffic reduction is implementation dependent and/or based on operator policy. + +# --- Annex H (normative): Access specific procedures for 3GPP EPS + +## H.1 General + +The present annex defines IP-CAN specific requirements for 3GPP Evolved Packet System (EPS). + +## --- H.2 Binding Mechanisms + +The procedures defined in clause 5.4 apply. + +Whenever the PCRF modifies the Authorized QoS of the default bearer, the BBF shall re-evaluate the bearer binding taking into account the default bearer QoS change the default bearer binding indication in the PCC Rule if applicable and any PCC Rule/QoS Rule operation requested by the PCRF. + +# --- Annex I (normative): APN matching procedures + +A PCRF or DRA needs to compare APN information received over different interfaces, for instance within the Called-Station-Id AVP, for certain purposes such as session binding. To do so, the PCRF or DRA shall apply the procedures in the present Annex. + +The PCRF or DRA shall consider the different possible encoding formats of the APN defined in 3GPP TS 23.003 [37], clause 9.1. When the PCRF or DRA needs to compare an APN only containing the APN Network Identifier, with an APN containing both APN Network Identifier and APN Operator Identifier, the PCRF shall consider those APNs as matching if their APN Network Identifiers match. The PCRF shall perform a case-insensitive comparison for APN Network Identifiers and APN Operator Identifiers. + +# --- Annex J (normative): Diameter message priority mechanism + +## J.1 General + +The support of the Diameter message priority mechanism by PCC functional elements is optional. PCC functional elements that support Diameter message priority mechanism shall comply with the procedures specified in this annex. + +IETF RFC 7944 [40] specifies the Diameter message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes can leverage the relative priority of Diameter messages into routing, resource allocation, set the DSCP marking for transport of the associated Diameter message, and also abatement decisions when overload control is applied. This includes the definition of Diameter message priority related AVPs and the Diameter message priority related behaviour. + +## --- J.2 PCC functional element behaviour + +A PCC functional entity supporting the Diameter message priority mechanism shall comply with IETF RFC 7944 [40]. + +A PCC functional element sending a request shall determine the required priority according to its policies. When priority is required, the PCC functional element shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the request according to the required priority level + +When the PCC functional element receives the corresponding response, it shall prioritise the received response according to the priority level received within the DRMP AVP if present in the response, otherwise according to the priority level of the corresponding request. + +When a PCC functional element receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, it may modify the priority level received in the DRMP AVP according to its policies and shall handle the response according to the required priority level. If the required priority level is different from the priority level received in the request, it shall include the DRMP AVP in the response. + +If: + +- a PCC functional element supports using the Diameter message priority mechanism for DSCP marking purposes, +- the transport network utilizes DSCP marking, and +- message-dependant DSCP marking is possible for the protocol stack transporting Diameter, + +then the PCC functional element shall set the DSCP marking for transport of the request or response according to the required priority level. + +The PCC functional element decisions for a required priority and the priority level value are implementation specific. + +Diameter requests related to high priority traffic (e.g. MPS, emergency) shall contain a DRMP AVP with a high priority of which the level is operator dependent. + +## --- J.3 Interactions + +If the PCC entity supporting the Diameter message priority mechanism receives the request message containing both the Reservation-Priority AVP and DRMP AVP, the PCC entity shall prioritise the request according to priority level received within the DRMP AVP. This procedure also applies for MPS. + +NOTE: Upon receipt of the request message containing the DRMP AVP, the PCRF will use the DRMP AVP to prioritize other PCC interfaces related to that IP-CAN session. + +# --- Annex K (normative): Diameter load control mechanism + +## K.1 General + +IETF RFC 8583 [60] specifies the Diameter load control mechanism. This includes the definition of Diameter Load AVP and the Diameter load related behaviour. + +Whether Diameter load control mechanism is applicable for a specific interface is specified in the 3GPP specification for that interface. For PCC related interfaces where the Diameter load control mechanism is applicable, the procedures in this Annex apply. + +Support for Diameter load control is optional for all PCC functional elements. + +NOTE: The Diameter Load AVP will simply be ignored by peers not supporting Diameter load control. + +If a PCC functional element supports the Diameter load control mechanism, it shall apply the procedures in the present Annex. + +The PCC functional elements that are recipients of realm-routed requests (e.g. PCRF, H-PCRF, TDF for solicited application reporting, TSSF, OCS) shall for that interface act as Endpoint Reporting Node as defined in IETF RFC 8583 [60]. + +The PCC functional elements that send realm-routed requests (e.g. PCRF, V-PCRF, PCEF, AF) shall for that interface act as Reacting Node as defined in IETF RFC 8583 [60]. + +## --- K.2 Endpoint or Agent Reporting Node + +The reporting shall include load information in the Load AVP as defined in IETF RFC 8583 [60] in Diameter answer messages. + +When and in which frequency to include the Load AVP is implementation dependent and based on operator policy. + +How the reporting node determines the specific contents of the Load-Value AVP within the Load AVP is also implementation dependent and based on operator policy. + +## --- K.3 Reacting Node + +A PCC functional element acting as a Reacting Node may use the load information in implementation dependent manner, e.g. when deciding where to route requests for new Diameter sessions. + +## --- K.4 DRA Behaviour + +The DRA may optionally incorporate Reacting Node behaviour as defined in IETF RFC 8583 [60]. Support of Agent Reporting Node behaviour as defined in IETF RFC 8583 [60] is not required. + +NOTE: Only one logical DRA is specified in the PCC architecture. The Agent Reporting Node behaviour as defined in IETF RFC 8583 [60] is only useful if several Diameter routing agents are deployed. i.e. not in the PCC architecture. + +The procedures defined in this clause are only applicable to the proxy DRA (PA1 and PA2) as the redirect DRA is not in the path of application answers and as such does not have access to load reports from other nodes. + +The proxy DRA should use load reports as one of the inputs when making routing decisions and selection of the PCRF for realm-routed requests, i.e. requests that do not contain a Destination-Host AVP. This is needed because entities sending such requests are not aware of the final recipient of the request (e.g. specific PCRF instance). If no binding exists for the request and the request can result in a new binding (e.g. IP-CAN session establishment), the DRA is selecting the PCRF that will handle the binding. + +# Annex L (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|-------|-----------|------|-----|-------------------------------------------------------------------------------------|--------|--------| +| 12-2014 | CT-66 | CP-140922 | 0575 | 2 | Call flows over Np reference point | 12.5.0 | 13.0.0 | +| 12-2014 | CT-66 | CP-140935 | 0576 | 2 | Double Resource Reuse procedures | 12.5.0 | 13.0.0 | +| 03-2015 | CT-67 | CP-150131 | 0579 | | IPCAN Session modification after bearer procedure | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150134 | 0580 | | P-CSCF Restoration Procedure for Local Breakout | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150136 | 0581 | | Priority Consideration for Diameter Overload Control | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150132 | 0582 | | Correction to the Gateway Control Session establishment procedure | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150136 | 0583 | | PCRF discovery for the HNB CS Service | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150094 | 0590 | | Corrections to the Gateway Control and QoS rules Provision procedure | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150125 | 0592 | | Add missing definition of RAN user plane congestion | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150125 | 0593 | 2 | DRA procedure to support PCRF selection by the RCAF | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150111 | 0595 | | Remove editor's Note on access line identifier | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150125 | 0596 | 2 | UE context removal in IP-CAN session termination procedure | 13.0.0 | 13.1.0 | +| 06-2015 | CT-68 | CP-150342 | 0601 | 1 | Remove the user identity from the intermediate spending limit report request | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150342 | 0604 | 2 | Correction to the IP-CAN session termination for spending limit report | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150355 | 0605 | 1 | Alignment with the changes of 29.217 | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150355 | 0606 | 1 | Reference update to align with new title of TS 29.217 | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150361 | 0607 | 1 | Correction of the editorial errors in Network-initiated IP-CAN session modification | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150354 | 0609 | 2 | QoS change of default bearer | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150362 | 0610 | 3 | APN matching procedures | 13.1.0 | 13.2.0 | +| 09-2015 | CT-69 | CP-150480 | 0612 | - | Procedures for monitoring when using the PCC architecture | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150482 | 0614 | 1 | Procedures to allow changing the chargeable party when sponsor connectivity applies | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150490 | 0616 | 2 | Correction on bearer binding on QoS rules | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150477 | 0617 | 5 | Clarification of the PCRF addressing for UPON | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150491 | 0618 | 2 | PCC signalling update to support NBIFOM | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150485 | 0619 | 2 | Clarification of PCRF address | 13.2.0 | 13.3.0 | +| 12-2015 | CT-70 | CP-150649 | 0620 | 1 | Authorized QCI value in PCRF to avoid SRVCC | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150650 | 0621 | 6 | Update the procedures to support traffic steering control | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150809 | 0622 | 3 | Include the PCC architecture figures in 29.213l | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150632 | 0625 | 2 | Overlapping transactions over Gx | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150666 | 0626 | - | RTP/RTCP transport multiplexing | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150730 | 0629 | 6 | Diameter message priority for PCC | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150663 | 0630 | 4 | Support of new bandwidth information over Rx | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150631 | 0633 | 1 | Update the reference of draft-ietf-dime-ovli | 13.3.0 | 13.4.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-03 | CT#71 | CP-160107 | 0638 | - | F | Network-initiated removal of one access from the PDN connection | 13.5.0 | +| 2016-03 | CT#71 | CP-160091 | 0639 | 2 | B | ADC rule error handling report initiated by the TSSF | 13.5.0 | +| 2016-03 | CT#71 | CP-160091 | 0640 | - | F | IPv4 address provisioning | 13.5.0 | +| 2016-03 | CT#71 | CP-160095 | 0641 | 2 | F | Update the scope to include the Nt interface | 13.5.0 | +| 2016-03 | CT#71 | CP-160091 | 0645 | 2 | F | Update the scope to include the St interface | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0646 | - | D | Correction of command name for Rx session termination | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0648 | 2 | F | Completion of RAN-NAS cause handling procedures | 13.5.0 | +| 2016-03 | CT#71 | CP-160095 | 0650 | - | B | Support of background data transfer per UE in the PCRF | 13.5.0 | +| 2016-03 | CT#71 | CP-160092 | 0651 | 1 | B | UE-to-network relay PCC handling | 13.5.0 | +| 2016-03 | CT#71 | CP-160106 | 0652 | - | D | Removal of the reference to draft-ietf-dime-ovli | 13.5.0 | +| 2016-03 | CT#71 | CP-160095 | 0653 | - | B | Rx impact for background data transfer | 13.5.0 | +| 2016-03 | CT#71 | CP-160093 | 0654 | 2 | B | Reservation-Priority AVP and DRMP AVP Interaction | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0656 | 1 | F | Removal of references to TS 26.236 | 13.5.0 | +| 2016-03 | CT#71 | CP-160087 | 0657 | 1 | B | The value of ARP for MCPTT emergency | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0658 | - | F | Correction to eMPS algorithm | 13.5.0 | +| 2016-06 | CT#72 | CP-160270 | 0660 | 2 | F | Support of enhanced bandwidth mechanisms in MTSI sessions | 13.6.0 | +| 2016-06 | CT#72 | CP-160265 | 0661 | 1 | F | Editorial corrections | 13.6.0 | +| 2016-06 | CT#72 | CP-160278 | 0662 | 2 | F | Priority sharing for concurrent sessions | 13.6.0 | +| 2016-06 | CT#72 | CP-160267 | 0665 | - | A | P-CSCF restoration indication by Rx-Request-Type AVP | 13.6.0 | +| 2016-06 | CT#72 | CP-160251 | 0666 | - | F | Correction to sponsor status change | 13.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------|--------| +| 2016-06 | CT#72 | CP-160265 | 0667 | 2 | F | Delete the Editor's Note in subclause of DRA diameter overload behavior | 13.6.0 | +| 2016-06 | CT#72 | CP-160253 | 0669 | 2 | A | Diameter requests for priority traffic during overload control mechanism | 13.6.0 | +| 2016-06 | CT#72 | CP-160274 | 0659 | 2 | B | Adding the reference to the gate control procedure over Rx interface | 14.0.0 | +| 2016-06 | CT#72 | CP-160265 | 0661 | 1 | F | Editorial corrections | 14.0.0 | +| 2016-09 | CT#73 | CP-160442 | 0671 | - | A | Correction of IETF drmp draft version | 14.1.0 | +| 2016-09 | CT#73 | CP-160443 | 0676 | - | A | Correction to eMPS Algorithm | 14.1.0 | +| 2016-09 | CT#73 | CP-160445 | 0678 | - | A | Update the AF session procedures to support priority sharing | 14.1.0 | +| 2016-09 | CT#73 | CP-160453 | 0680 | 1 | A | Correction to the PCRF addressing by RCAF | 14.1.0 | +| 2016-09 | CT#73 | CP-160456 | 0681 | 3 | B | Flows for Subscription to notification of PLMN id change in IMS | 14.1.0 | +| 2016-09 | CT#73 | CP-160457 | 0682 | 2 | B | Correction to the PCRF addressing by RCAF | 14.1.0 | +| 2016-12 | CT#74 | CP-160615 | 0683 | 4 | B | Diameter Load Control Mechanism | 14.2.0 | +| 2016-12 | CT#74 | CP-160614 | 0685 | - | A | Correction to change IETF drmp draft version to official RFC 7944 | 14.2.0 | +| 2016-12 | CT#74 | CP-160633 | 0686 | 3 | B | Provision of EPC-level identities for IMS emergency sessions over Rx | 14.2.0 | +| 2016-12 | CT#74 | CP-160625 | 0687 | 1 | B | PCC impacts due to multi-stream multiparty conferencing media handling | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0688 | 5 | F | Handling of pending transactions for session termination requests | 14.2.0 | +| 2016-12 | CT#74 | CP-160619 | 0690 | - | A | Correction to St session description in PCEF-initiated IP-CAN Session Modification | 14.2.0 | +| 2016-12 | CT#74 | CP-160628 | 0691 | 1 | B | Signalling for the sponsored data connectivity supported by the TDF | 14.2.0 | +| 2016-12 | CT#74 | CP-160612 | 0692 | 2 | B | Support of Multiple PRAs | 14.2.0 | +| 2016-12 | CT#74 | CP-160616 | 0693 | 1 | F | Diameter base protocol specification update | 14.2.0 | +| 2016-12 | CT#74 | CP-160627 | 0695 | - | A | Correction to information flow of PCEF-initiated IP-CAN Session Modification with AF located in HPLMN | 14.2.0 | +| 2016-12 | CT#74 | CP-160628 | 0697 | 1 | B | Add specification references of Nu, Gw, Gwn | 14.2.0 | +| 2017-03 | CT#75 | CP-170086 | 0699 | 1 | F | Bearer binding for PCC rules that have indicated to be bound to the default bearer | 14.3.0 | +| 2017-03 | CT#75 | CP-170083 | 0700 | 1 | B | QoS guidelines for MMCMH sessions | 14.3.0 | +| 2017-03 | CT#75 | CP-170081 | 0701 | 1 | C | Pre-emption control for priority sharing | 14.3.0 | +| 2017-03 | CT#75 | CP-170086 | 0702 | 1 | F | Correction in IP-CAN session termination procedure | 14.3.0 | +| 2017-03 | CT#75 | CP-170086 | 0703 | 2 | F | Correction in DRA procedures | 14.3.0 | +| 2017-06 | CT#76 | CP-171119 | 0704 | 1 | F | Reference update for draft-ietf-dime-load | 14.4.0 | +| 2017-06 | CT#76 | CP-171132 | 0707 | 2 | A | References update | 14.4.0 | +| 2017-06 | CT#76 | CP-171133 | 0714 | 2 | A | Support for signaling transport level packet marking | 14.4.0 | +| 2017-06 | CT#76 | CP-171126 | 0715 | 1 | F | Updating references to align with rel-14 MCPTT stage 1 and stage 2 restructuring | 14.4.0 | +| 2017-06 | CT#76 | CP-171117 | 0716 | 1 | F | Impacts of CUPS to PCC reference model | 14.4.0 | +| 2017-06 | CT#76 | CP-171118 | 0717 | - | F | Corrections of DRMP procedures | 14.4.0 | +| 2017-06 | CT#76 | CP-171136 | 0709 | 2 | F | Corrections in IP-CAN Session Establishment | 15.0.0 | +| 2017-06 | CT#76 | CP-171136 | 0710 | 1 | F | Update scope of 29.213 | 15.0.0 | +| 2017-06 | CT#76 | CP-171136 | 0711 | 3 | F | Clarifications on Diameter race condition | 15.0.0 | +| 2017-09 | CT#77 | CP-172038 | 0718 | 1 | B | Extension of QoS values | 15.1.0 | +| 2017-09 | CT#77 | CP-172043 | 0721 | 2 | A | Clarification of Max-Requested-Bandwidth | 15.1.0 | +| 2018-03 | CT#79 | CP-180056 | 0722 | 3 | B | Update procedures to enhance VoLTE performance | 15.2.0 | +| 2018-06 | CT#80 | CP-181023 | 0723 | - | D | Correcting heading levels | 15.3.0 | +| 2018-06 | CT#80 | CP-181171 | 0726 | 1 | A | Support priority for MCVideo services | 15.3.0 | +| 2018-09 | CT#81 | CP-182026 | 0727 | 1 | F | Correction of abbreviation "SSID" to "SSD" | 15.4.0 | +| 2018-12 | CT#82 | CP-183119 | 0735 | - | A | Removal of editor's notes | 15.5.0 | +| 2019-09 | CT#85 | CP-192154 | 0739 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.6.0 | +| 2019-09 | CT#85 | CP-192164 | 0737 | 1 | B | Support for Restricted Local Operator Services | 16.0.0 | +| 2019-12 | CT#86 | CP-193221 | 0740 | 6 | B | Coverage and Handover Enhancements for Media (CHEM) | 16.1.0 | +| 2020-03 | CT#87e | CP-200215 | 0741 | - | B | Impacts on QoS mapping to support FLUS functionality | 16.2.0 | +| 2020-06 | CT#88e | CP-201246 | 0742 | - | B | Support of applications with specific QoS hints | 16.3.0 | +| 2021-06 | CT#92e | CP-211226 | 0743 | 1 | B | PCRF control of MPS for DTS | 17.0.0 | +| 2021-09 | CT#93e | CP-212212 | 0744 | 1 | B | 29.213 MPS for DTS note fix | 17.1.0 | +| 2022-03 | CT#95e | CP-220209 | 0745 | - | B | Update of IETF references for ICE | 17.2.0 | +| 2022-03 | CT#95e | CP-220196 | 0747 | - | F | Correction to enable retrieval of Network Provided Location information in a MESSAGE request | 17.2.0 | +| 2023-12 | CT#102 | CP-233275 | 0748 | - | B | Data channel update for Rx interface | 18.0.0 | \ No newline at end of file diff --git a/gsma/29_series/29214/raw.md b/gsma/29_series/29214/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bc449086c458b1039d8b00b507e769cdf4434613 --- /dev/null +++ b/gsma/29_series/29214/raw.md @@ -0,0 +1,3930 @@ + + +# 3GPP TS 29.214 V18.1.0 (2023-06) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control over Rx reference point (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a small red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +UMTS, LTE, QoS, Charging, Policy + +--- + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles – Sophia Antipolis +Valbonne – France +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +--- + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Abbreviations ..... | 12 | +| 4 Rx reference point..... | 13 | +| 4.1 Overview ..... | 13 | +| 4.2 Rx reference model ..... | 13 | +| 4.3 Functional elements..... | 13 | +| 4.3.1 AF ..... | 13 | +| 4.3.2 PCRF ..... | 14 | +| 4.4 PCC procedures over Rx reference point..... | 14 | +| 4.4.1 Initial Provisioning of Session Information ..... | 14 | +| 4.4.2 Modification of Session Information..... | 19 | +| 4.4.3 Gate Related Procedures..... | 22 | +| 4.4.4 AF Session Termination ..... | 23 | +| 4.4.5 Subscription to Notification of Signalling Path Status ..... | 23 | +| 4.4.5A Provisioning of AF Signalling Flow Information ..... | 24 | +| 4.4.6 Traffic Plane Events ..... | 25 | +| 4.4.6.1 IP-CAN Session Termination ..... | 25 | +| 4.4.6.2 Service Data Flow Deactivation and Resource Allocation Failure ..... | 25 | +| 4.4.6.3 Notification of Signalling Path Status ..... | 25 | +| 4.4.6.4 IP-CAN type change Notification..... | 26 | +| 4.4.6.5 Access Network Charging Information Notification ..... | 26 | +| 4.4.6.6 Reporting Usage for Sponsored Data Connectivity..... | 26 | +| 4.4.6.7 Reporting Access Network Information ..... | 27 | +| 4.4.6.8 Temporary Network Failure handling ..... | 28 | +| 4.4.6.9 PLMN information change Notification ..... | 28 | +| 4.4.7 P-CSCF Restoration Enhancement Support ..... | 28 | +| 4.4.8 Priority Sharing Request..... | 29 | +| 4.4.9 Support for media component versioning ..... | 29 | +| 4.4.10 Extended bandwidth support for EPC supporting Dual Connectivity (E-UTRAN and 5G NR) ..... | 30 | +| 4.4.11 MPS for DTS Control..... | 30 | +| 4.4.12 Provisioning of MPS for DTS AF Signalling Flow Information ..... | 31 | +| 5 Rx protocol..... | 32 | +| 5.1 Protocol support ..... | 32 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 32 | +| 5.3 Rx specific AVPs ..... | 32 | +| 5.3.0 General ..... | 32 | +| 5.3.1 Abort-Cause AVP..... | 35 | +| 5.3.2 Access-Network-Charging-Address AVP..... | 36 | +| 5.3.3 Access-Network-Charging-Identifier AVP ..... | 36 | +| 5.3.4 Access-Network-Charging-Identifier-Value AVP ..... | 36 | +| 5.3.5 AF-Application-Identifier AVP..... | 36 | +| 5.3.6 AF-Charging-Identifier AVP..... | 37 | +| 5.3.7 Codec-Data AVP ..... | 37 | +| 5.3.8 Flow-Description AVP..... | 37 | +| 5.3.9 Flow-Number AVP ..... | 38 | +| 5.3.10 Flows AVP ..... | 38 | +| 5.3.11 Flow-Status AVP..... | 38 | +| 5.3.12 Flow-Usage AVP..... | 39 | +| 5.3.13 Specific-Action AVP..... | 39 | +| 5.3.14 Max-Requested-Bandwidth-DL AVP ..... | 43 | + +| | | | +|---------|-----------------------------------------------------------------------------|----| +| 5.3.15 | Max-Requested-Bandwidth-UL AVP ..... | 43 | +| 5.3.16 | Media-Component-Description AVP ..... | 43 | +| 5.3.17 | Media-Component-Number AVP ..... | 45 | +| 5.3.18 | Media-Sub-Component AVP ..... | 45 | +| 5.3.19 | Media-Type AVP ..... | 46 | +| 5.3.20 | RR-Bandwidth AVP ..... | 46 | +| 5.3.21 | RS-Bandwidth AVP ..... | 46 | +| 5.3.22 | SIP-Forking-Indication AVP ..... | 46 | +| 5.3.23 | Service-URN AVP ..... | 47 | +| 5.3.24 | Acceptable-Service-Info AVP ..... | 47 | +| 5.3.25 | Service-Info-Status-AVP ..... | 47 | +| 5.3.26 | AF-Signalling-Protocol-AVP ..... | 47 | +| 5.3.27 | Sponsored-Connectivity-Data AVP ..... | 48 | +| 5.3.28 | Sponsor-Identity AVP ..... | 48 | +| 5.3.29 | Application-Service-Provider-Identity AVP ..... | 48 | +| 5.3.30 | MPS-Identifier AVP ..... | 48 | +| 5.3.31 | Rx-Request-Type AVP ..... | 48 | +| 5.3.32 | Min-Requested-Bandwidth-DL AVP ..... | 49 | +| 5.3.33 | Min-Requested-Bandwidth-UL AVP ..... | 49 | +| 5.3.34 | Required-Access-Info AVP ..... | 49 | +| 5.3.35 | IP-Domain-Id AVP ..... | 49 | +| 5.3.36 | GCS-Identifier AVP ..... | 49 | +| 5.3.37 | Sharing-Key-DL AVP ..... | 50 | +| 5.3.38 | Sharing-Key-UL AVP ..... | 50 | +| 5.3.39 | Retry-Interval AVP ..... | 50 | +| 5.3.40 | Sponsoring-Action AVP ..... | 50 | +| 5.3.41 | Max-Supported-Bandwidth-DL AVP ..... | 50 | +| 5.3.42 | Max-Supported-Bandwidth-UL AVP ..... | 51 | +| 5.3.43 | Min-Desired-Bandwidth-DL AVP ..... | 51 | +| 5.3.44 | Min-Desired-Bandwidth-UL AVP ..... | 51 | +| 5.3.45 | MCPTT-Identifier AVP ..... | 51 | +| 5.3.45A | MCVideo-Identifier AVP ..... | 51 | +| 5.3.46 | Service-Authorization-Info AVP ..... | 51 | +| 5.3.47 | Priority-Sharing-Indicator AVP ..... | 51 | +| 5.3.48 | Media-Component-Status AVP ..... | 52 | +| 5.3.49 | Content-Version AVP ..... | 52 | +| 5.3.50 | AF-Requested-Data AVP ..... | 52 | +| 5.3.51 | Pre-emption-Control-Info AVP ..... | 52 | +| 5.3.52 | Extended-Max-Requested-BW-DL AVP ..... | 53 | +| 5.3.53 | Extended-Max-Requested-BW-UL AVP ..... | 53 | +| 5.3.54 | Extended-Max-Supported-BW-DL AVP ..... | 53 | +| 5.3.55 | Extended-Max-Supported-BW-UL AVP ..... | 53 | +| 5.3.56 | Extended-Min-Desired-BW-DL AVP ..... | 53 | +| 5.3.57 | Extended-Min-Desired-BW-UL AVP ..... | 53 | +| 5.3.58 | Extended-Min-Requested-BW-DL AVP ..... | 54 | +| 5.3.59 | Extended-Min-Requested-BW-UL AVP ..... | 54 | +| 5.3.60 | IMS-Content-Identifier AVP ..... | 54 | +| 5.3.61 | IMS-Content-Type AVP ..... | 54 | +| 5.3.62 | Callee-Information AVP ..... | 54 | +| 5.3.63 | FLUS-Identifier AVP ..... | 54 | +| 5.3.64 | Desired-Max-Latency AVP ..... | 55 | +| 5.3.65 | Desired-Max-Loss AVP ..... | 55 | +| 5.3.66 | MA-Information AVP ..... | 55 | +| 5.3.67 | MA-Information-Action AVP ..... | 55 | +| 5.3.68 | NID AVP ..... | 55 | +| 5.3.69 | 5GS-RAN-NAS-Release-Cause AVP (3GPP-5GS and Non-3GPP-5GS access type) ..... | 55 | +| 5.3.70 | 5GMM-Cause AVP ..... | 56 | +| 5.3.71 | 5GSM-Cause AVP ..... | 56 | +| 5.3.72 | NGAP-Cause AVP ..... | 56 | +| 5.3.73 | NGAP-Group AVP ..... | 56 | +| 5.3.74 | NGAP-Value AVP ..... | 56 | +| 5.3.75 | Wireline-User-Location-Info AVP ..... | 56 | + +| | | | +|------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|-----------| +| 5.3.76 | HFC-Node-Identifier AVP ..... | 57 | +| 5.3.77 | GLI-Identifier AVP ..... | 57 | +| 5.3.78 | Line-Type AVP ..... | 57 | +| 5.3.79 | MPS-Action AVP ..... | 57 | +| 5.4 | Rx re-used AVPs..... | 58 | +| 5.4.0 | General ..... | 58 | +| 5.4.1 | Use of the Supported-Features AVP on the Rx reference point..... | 62 | +| 5.5 | Rx specific Experimental-Result-Code AVP values..... | 67 | +| 5.5.1 | Permanent Failures ..... | 67 | +| 5.5.2 | Transient Failures ..... | 68 | +| 5.6 | Rx messages ..... | 68 | +| 5.6.0 | General ..... | 68 | +| 5.6.1 | AA-Request (AAR) command ..... | 68 | +| 5.6.2 | AA-Answer (AAA) command ..... | 69 | +| 5.6.3 | Re-Auth-Request (RAR) command ..... | 69 | +| 5.6.4 | Re-Auth-Answer (RAA) command..... | 70 | +| 5.6.5 | Session-Termination-Request (STR) command..... | 70 | +| 5.6.6 | Session-Termination-Answer (STA) command..... | 71 | +| 5.6.7 | Abort-Session-Request (ASR) command..... | 71 | +| 5.6.8 | Abort-Session-Answer (ASA) command ..... | 72 | +| Annex A (normative): IMS Related P-CSCF Procedures over Rx..... | | 73 | +| A.1 | Provision of Service Information at P-CSCF..... | 73 | +| A.2 | Enabling of IP Flows..... | 75 | +| A.2.0 | General ..... | 75 | +| A.2.1 | Gate control procedures considering the P-Early-Media header field ..... | 75 | +| A.2.2 | Gate control procedures based on the configuration in the P-CSCF..... | 77 | +| A.3 | Support for SIP forking..... | 77 | +| A.3.0 | General ..... | 77 | +| A.3.1 | PCC rule provisioning for early media for forked responses..... | 77 | +| A.3.2 | Updating the provisioned PCC rules at the final answer ..... | 78 | +| A.4 | Notification of AF Signalling Transmission Path Status ..... | 79 | +| A.5 | Indication of Emergency Registration and Session Establishment..... | 79 | +| A.6 | Notification IP-CAN Type Change..... | 80 | +| A.7 | Support for Early Session disposition SDP..... | 80 | +| A.7.1 | General ..... | 80 | +| A.7.2 | Service Information Provisioning for Early Media..... | 80 | +| A.7.3 | Updating the Provisioned Service Information when Dialogue is established ..... | 81 | +| A.8 | Provision of Signalling Flow Information at P-CSCF ..... | 82 | +| A.9 | Handling of MPS Session ..... | 82 | +| A.10 | Retrieval of network provided location information..... | 82 | +| A.10.1 | General ..... | 82 | +| A.10.2 | Retrieval of network provided location information at originating P-CSCF for inclusion in SIP Request..... | 83 | +| A.10.3 | Retrieval of network provided location information at originating P-CSCF for inclusion in SIP response confirmation ..... | 83 | +| A.10.4 | Retrieval of network provided location information at terminating P-CSCF ..... | 84 | +| A.10.5 | Provisioning of network provided location information at SIP session release..... | 85 | +| A.10.6 | Provisioning of network provided location information at mid call ..... | 85 | +| A.11 | Handling of RAN/NAS release cause values..... | 86 | +| A.12 | Resource Sharing ..... | 86 | +| A.13 | Handling of MCPTT priority call ..... | 86 | +| A.13.1 | General ..... | 86 | +| A.13.2 | Determination of MCPTT priority parameter values..... | 87 | + +| | | +|----------------------------------------------------------------------------------------------|------------| +| A.14 Notification of PLMN Change..... | 87 | +| A.15 Handling of MCVideo priority call..... | 87 | +| A.15.1 General ..... | 87 | +| A.15.2 Determination of MCVideo priority parameter values ..... | 88 | +| A.16 Support for volume based charging of IMS services..... | 88 | +| A.17 Indication of Restricted Local Operator Services Support ..... | 89 | +| A.18 Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM)..... | 89 | +| A.19 Handling of a FLUS session ..... | 90 | +| A.20 QoS hint support for data channel media..... | 91 | +| Annex B (normative): Flow identifiers: Format definition and examples..... | 92 | +| B.1 Format of a flow identifier ..... | 92 | +| B.1.1 General ..... | 92 | +| B.1.2 Derivation of Flow Identifiers from SDP..... | 93 | +| B.1.2.1 Standard Procedure..... | 93 | +| B.1.2.2 SDP with "early session" disposition type ..... | 93 | +| B.2 Example 1 ..... | 93 | +| B.3 Example 2 ..... | 94 | +| B.4 Example 3 without media components..... | 95 | +| B.5 Example 4 ..... | 96 | +| Annex C (informative): Void..... | 98 | +| Annex D (normative): Monitoring Related SCEF Procedures over Rx..... | 99 | +| D.1 Monitoring events support, using SCEF procedures over Rx..... | 99 | +| Annex E (normative): Interworking with 5GS via Rx interface..... | 99 | +| E.1 General..... | 99 | +| E.2 Mapping table for IP-CAN types and Access types ..... | 100 | +| E.3 Reporting EPS Fallback..... | 100 | +| E.4 IP-CAN type change Notification for a MA PDU session ..... | 101 | +| E.5 Reporting serving network identity..... | 101 | +| E.6 Trusted non-3GPP Access Network Information ..... | 102 | +| E.7 Untrusted non-3GPP Access Network Information..... | 103 | +| E.8 Wireline non-3GPP Access Network Information..... | 103 | +| E.9 5GS-Level Identities report..... | 104 | +| E.10 Reporting Access Network Information ..... | 104 | +| E.11 Access Network Charging Information Notification..... | 104 | +| E.12 3GPP Access Network Information..... | 104 | +| Annex F (informative): Change history ..... | 106 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document provides the stage 3 specification of the Rx reference point for the present release. The functional requirements and the stage 2 specifications of the Rx reference point are contained in 3GPP TS 23.203 [2]. + +The Rx reference point lies between the Application Function (AF) and the Policy and Charging Rule Function (PCRF). In the 5GS the Rx reference point resides between the AF and the Policy Control Function (PCF) as specified in 3GPP TS 23.501 [55] and 3GPP TS 23.503 [56]. + +NOTE: Interactions between the PCF and the AF using the 5GS Npcf\_PolicyAuthorization service (the N5 reference point) are defined in 3GPP TS 29.514 [57]. + +The Rx interface which is based on RESTful HTTP and XML is specified in 3GPP TS 29.201 [37]. + +Whenever it is possible the present document specifies the requirements for the protocol by reference to specifications produced by the IETF within the scope of Diameter. Where this is not possible, extensions to Diameter are defined within the present document. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication and/or edition number or version number) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.203: "Policy and Charging Control architecture". +- [3] Void. +- [4] Void. +- [5] 3GPP TS 29.209: "Policy control over Gq interface", latest Rel-6 version. +- [6] Void. +- [7] 3GPP TS 29.211: "Rx Interface and Rx/Gx signalling flows", latest Rel-6 version. +- [8] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [9] 3GPP TS 29.213: "Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping". +- [10] Void. +- [11] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [12] IETF RFC 4005: "Diameter Network Access Server Application". +- [13] IETF RFC 4566: "SDP: Session Description Protocol". +- [14] Void. + +- [15] ETSI TS 183 017 v3.2.1: "Telecommunications and Internet Converged Services and Protocols for Advanced Networking (TISPAN); Resource and Admission Control: DIAMETER protocol for session based policy set-up information exchange between the Application Function (AF) and the Service Policy Decision Function (SPDF); Protocol specification". +- [16] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [17] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3". +- [18] IETF RFC 3264: "An Offer/Answer Model with the Session Description Protocol (SDP)". +- [19] Void. +- [20] IETF RFC 3162: "Radius and IPv6". +- [21] IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services". +- [22] Void. +- [23] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles". +- [24] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [25] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; Protocol details" +- [26] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [27] IETF RFC 3959 (December 2004): "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [28] 3GPP TS 23.380: "IMS Restoration Procedures". +- [29] Void. +- [30] Void. +- [31] 3GPP TS 22.153: "Multimedia Priority Service". +- [32] Void. +- [33] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [34] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [35] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [36] 3GPP TS 23.468: "Group Services and System Aspects; Group Communication System Enablers for LTE (GCSE LTE)". +- [37] 3GPP TS 29.201: "Representational State Transfer (REST) reference point between Application Function (AF) and Protocol Converter (PC)". +- [38] 3GPP TS 23.003: "Numbering, addressing and identification". +- [39] 3GPP TS 29.273: "3GPP EPS AAA interfaces". +- [40] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [41] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia telephony; Media handling and interaction". + +- [42] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [43] IETF RFC 7944: "Diameter Routing Message Priority". +- [44] Void. +- [45] IETF RFC 8101: "IANA Registration of New Session Initiation Protocol (SIP) Resource-Priority Namespace for Mission Critical Push To Talk service". +- [46] 3GPP TS 23.303: "Proximity-based services (ProSe); Stage 2". +- [47] 3GPP TS 29.154: "Service capability exposure functionality over Nt reference point". +- [48] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [49] IETF RFC 3948: "UDP Encapsulation of IPsec ESP Packets". +- [50] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks; stage 3". +- [51] IETF RFC 8583: "Diameter Load Information Conveyance". +- [52] IETF RFC 6733: "Diameter Base Protocol". +- [53] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [54] 3GPP TS 23.379: "Functional architecture and information flows to support Mission Critical Push To Talk (MCPTT); Stage 2". +- [55] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [56] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [57] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [58] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [59] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [60] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [61] 3GPP TS 23.281: "Functional architecture and information flows to support Mission Critical Video (MCVideo); Stage 2". +- [62] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [63] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem; Stage 3". +- [64] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [65] 3GPP TS 22.101: "Service aspects; Service principles". +- [66] 3GPP TS 23.221: "Architectural requirements". +- [67] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [68] IETF RFC 4574: "The Session Description Protocol (SDP) Label Attribute". +- [69] 3GPP TS 26.238: "Uplink Streaming". +- [70] 3GPP TS 24.501: "Non-Access-Stratum (NAS) Protocol for 5G System (5GS); Stage 3". +- [71] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". + +- [72] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [73] CableLabs WR-TR-5WWC-ARCH: "5G Wireless Wireline Converged Core Architecture". +- [74] BBF WT-470: "5G FMC Architecture". +- [75] IETF RFC 8506: "Diameter Credit Control Application". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply: + +**Application Function (AF):** element offering application(s) that use IP bearer resources + +NOTE: One example of an AF is the P-CSCF of the IM CN subsystem. + +**AF Session:** application level session established by an application level signalling protocol offered by the AF that requires a session set-up with explicit session description before the use of the service. + +NOTE: One example of an application session is an IMS session. + +**Attribute-Value Pair (AVP):** See IETF RFC 6733 [52], corresponds to an Information Element in a Diameter message. + +**Binding:** PCRF process of associating IP flows described in AF Service Information with IP-CAN bearers. + +**Bit rate:** The number of bits (denoted in units of bits, kbits, etc.) that are conveyed or processed per unit of time. The bit rate in bit/s can be abbreviated with bps. This specification uses SI (International System of Units) prefixes as unit prefixes, which strictly refer to the power of 10, and shall not be used for the power of 2. For example, 1 kbit/s represents 1000 bit/s or 1 Mbit/s represents 1000 kbit/s and so on. + +**IP-CAN bearer:** IP transmission path of defined capacity, delay and bit error rate, etc. +See 3GPP TR 21.905 [1] for the definition of bearer. + +**IP-CAN session:** association between a UE and an IP network (for GPRS, APN). + +The association is identified by one UE Ipv4 address and/or one Ipv6 prefix together with a UE identity information, if available, and a PDN represented by a PDN ID (e.g. an APN). An IP-CAN session incorporates one or more IP-CAN bearers. Support for multiple IP-CAN bearers per IP-CAN session is IP-CAN specific. An IP-CAN session exists as long as the related UE Ipv4 address and/or Ipv6 prefix are assigned and announced to the IP network. + +**IP flow:** unidirectional flow of IP packets with the same source IP address and port number and the same destination IP address and port number and the same transport protocol +Port numbers are only applicable if used by the transport protocol. + +**MPS session:** A session for which priority treatment is applied for allocating and maintaining radio and network resources to support the Multimedia Priority Service (MPS). MPS is defined in 3GPP TS 22.153 [31]. + +**Packet flow:** A specific user data flow carried through the PCEF. A packet flow can be an IP flow. + +**PCC rule:** set of information enabling the detection of a service data flow and providing parameters for policy control and/or charging control. + +**RESTful HTTP:** is an architectural style consisting of a coordinated set of architectural constraints applied to components, connectors, and data elements, within a distributed hypermedia system applied to the development of web services. + +**Restricted local operator services:** communication services provided by an operator that involve either automated or human assistance (e.g. credit card billing, directory assistance, customer care) for which successful authentication is not necessary. + +**service information:** set of information conveyed from the AF to the PCRF over the Rx interface to be used as a basis for PCC decisions at the PCRF, including information about the AF session (e.g. application identifier, type of media, bandwidth, IP address and port number). + +**service data flow:** An aggregate set of packet flows. + +## 3.2 Abbreviations + +For the purpose of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply: + +| | | +|--------|-----------------------------------------------------------------------------| +| 5GMM | 5G Mobility Management protocol | +| 5GS | 5G System | +| 5GSM | 5G Session Management protocol | +| ADC | Application Detection and Control | +| AF | Application Function | +| AS | Application Server | +| ASP | Application Service Provider | +| ATSSS | Access Traffic Steering, Switching and Splitting | +| AVP | Attribute Value Pair | +| BBF | Broadband Forum | +| CHEM | Coverage and Handoff Enhancements using Multimedia error robustness feature | +| CRF | Charging Rules Function | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| DTS | Data Transport Service | +| DSL | Digital Subscriber Line | +| FLUS | Framework for Live Uplink Streaming | +| GCS | Group Communication Service | +| GCS AS | Group Communication Service Application Server | +| HFC | Hybrid Fiber Coax | +| IP-CAN | IP Connectivity Access Network | +| MA | Multi-Access | +| MPS | Multimedia Priority Service | +| N3IWF | Non-3GPP Interworking Function | +| N5CW | Non-5G-Capable over WLAN | +| NGAP | NG Application Protocol | +| NID | Network Identifier | +| PCC | Policy and Charging Control | +| PCEF | Policy and Charging Enforcement Function | +| PCF | Policy Control Function | +| PCRF | Policy and Charging Rule Function | +| PDF | Policy Decision Function | +| P-CSCF | Proxy-Call Session Control Function | +| PON | Passive Optical Network | +| PSAP | Public Safety Answering Point | +| QoS | Quality of Service | +| RCAF | RAN Congestion Awareness Function | +| RLOS | Restricted Local Operator Services | +| SCEF | Service Capability Exposure Function | +| SCS | Service Capability Server | +| SDF | Service Data Flow | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SPR | Subscriber Profile Repository | +| TDF | Traffic Detection Function | +| TNAP | Trusted Non-3GPP Access Point | +| TNGF | Trusted Non-3GPP Gateway Function | +| TWAP | Trusted WLAN Access Point | +| TWIF | Trusted WLAN Interworking Function | +| UDC | User Data Convergence | +| UE | User Equipment | + +UDR User Data Repository +XML Extensible Markup Language + +# 4 Rx reference point + +## 4.1 Overview + +The Rx reference point is used to exchange application level session information: + +- and the Application Function (AF); and +- in the 5GS, between the Policy Control Function (PCF) between + +the Policy and Charging Rules Function (PCRF) and the Application Function (AF). As defined in the stage 2 specifications (3GPP TS 23.203 [2]), this information is part of the input used by the PCRF for the Policy and Charging Control (PCC) decisions. The PCRF exchanges the PCC rules with the Policy and Charging Enforcement Function (PCEF) and QoS rules with the Bearer Binding and Event Reporting Function (BBERF) as specified in 3GPP TS 29.212 [8]. + +Policy and Charging Control over Rx interface in the 5GS is specified in annex E. + +Signalling flows related to the both Rx and Gx interfaces are specified in 3GPP TS 29.213 [9]. + +Refer to Annex G of 3GPP TS 29.213 [9] for Diameter overload control procedures over the Rx interface. + +Refer to Annex J of 3GPP TS 29.213 [9] for Diameter message priority mechanism procedures over the Rx interface. + +Refer to Annex K of 3GPP TS 29.213 [9] for Diameter load control procedures over the Rx interface. + +## 4.2 Rx reference model + +The Rx reference point is defined between the PCRF and the AF. The relationships between the different functional entities involved are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [9]. + +![Figure 4.2.1: Rx reference model diagram showing the AF and PCRF connected via the Rx interface.](ea37ab05b033e59cfdf7b074161aaf5a_img.jpg) + +The diagram shows two rectangular boxes, 'AF' on the left and 'PCRF' on the right, both filled with a light green color. A horizontal line connects the two boxes. Above this line, the label 'Rx' is centered. There is a small vertical tick mark on the line between the two boxes. + +Figure 4.2.1: Rx reference model diagram showing the AF and PCRF connected via the Rx interface. + +Figure 4.2.1: Rx reference model + +Figure 4.2.2: Void + +## 4.3 Functional elements + +### 4.3.1 AF + +The AF is an element offering applications that require the Policy and Charging Control of traffic plane resources (e.g. UMTS PS domain/GPRS domain resources). One example of an application function is the P-CSCF. The AF shall use the Rx reference point to provide session information to the PCRF. + +NOTE: The AFs may be deployed by the same operator offering the IP-CAN or may be provided by external third party service provider. + +### 4.3.2 PCRF + +The PCRF (Policy Control and Charging Rules Function) is a functional element that encompasses policy control decision and flow based charging control functionalities. These 2 functionalities are the heritage of the release 6 logical entities PDF and CRF respectively. The PCRF provides network control regarding the service data flow detection, gating, QoS and flow based charging (except credit management) towards the PCEF. The PCRF receives session and media related information from the AF and informs AF of traffic plane events. + +The PCRF may check that the service information provided by the AF is consistent with the operator defined policy rules before storing the service information. The service information shall be used to derive the QoS for the service. The PCRF may reject the request received from the AF and as a result the PCRF shall indicate, in the response to the AF, the service information that can be accepted by the PCRF. + +The PCRF may temporarily not be able to provide the service delivery that AF requested (e.g. due to RAN user plane congestion). In this case, the PCRF may send a re-try interval information to the AF. The re-try interval indicates when service delivery may be retried by the AF over Rx. + +NOTE 1: Additionally, existing bandwidth limitation parameters (e.g. Max-Requested-Bandwidth-DL AVP, Max-Requested-Bandwidth-UL AVP within the Acceptable-Service-Info AVP) provided by the PCRF to the AF in AA-Answer command during the Rx session establishment are available in order to mitigate RAN user plane congestion. + +The PCRF may use the subscription information as basis for the policy and charging control decisions. The subscription information may apply for both session based and non-session based services. The subscription specific information for each service may contain e.g. max QoS class and max bit rate. + +If the AF requests it, the PCRF shall report IP-CAN session events (including bearer events and events on AF signalling transport) to the AF via the Rx reference point. + +The PCRF PCC/QoS Rule decisions may be based on one or more of the following: + +- the session and media related information obtained from the AF via the Rx reference point; +- the bearer and subscriber related information obtained from the PCEF over the Gx reference point; +- the bearer and subscriber related information obtained from the BBERF over the Gxx reference point; +- subscriber and service related data the PCRF may be aware of by configuration or through the Sp reference point; +- pre-configured information in the PCRF. + +NOTE 2: The details associated with the Sp reference point are not specified in this Release. The SPR's relation to existing subscriber databases is not specified in this Release. + +The PCRF shall provision PCC/QoS Rules to the PCEF/BBERF via the Gx/Gxx reference point. + +## 4.4 PCC procedures over Rx reference point + +### 4.4.1 Initial Provisioning of Session Information + +When a new AF session is being established and media information for this AF session is available at the AF and the related media require PCC supervision, the AF shall open an Rx Diameter session with the PCRF for the AF session using an AA-Request command, unless an Rx session has already been established for the AF session (e.g. as per clause 4.4.6.7). If an Rx Diameter session already exists for the AF session, the AF uses the existing Rx Diameter session. The AF shall provide the full IP address of the UE using either Framed-IP-Address AVP or Framed-Ipv6-Prefix AVP, and the corresponding Service Information within Media-Component-Description AVP(s). The AF shall not include circuit-switched bearer related media in the service information sent to the PCRF. The AF shall indicate to the PCRF as part of the Media-Component-Description whether the media IP flow(s) should be enabled or disabled with the Flow-Status AVP. + +NOTE 1: The AF does not need to open an Rx Diameter session with the PCRF, if the SDP payload is only proposing to use a circuit-switched bearer (i.e. "c=" line set to "PSTN" and an "m=" line set to "PSTN", refer to 3GPP TS 24.292 [26]). + +NOTE 2: The Rx Diameter session used for an AF session is different from the Rx Diameter session possibly used for the notifications of the status of the AF signalling transmission path. A new Rx Diameter session is established for each new AF session. + +The AF may include the AF-Application-Identifier AVP into the AA-Request in order to indicate the particular service that the AF session belongs to. This AVP can be provided at both AF session level, and Media-Component-Description level. When provided at both levels, the AF-Application Identifier provided within the Media-Component-Description AVP will have precedence. The AF may also include an AF application identifier within the AF-Application-Identifier AVP at the AF session level to trigger the PCRF to indicate to the PCEF/TDF to perform the application detection based on the operator's policy as defined in 3GPP TS 29.212 [8]. + +The AF may include the AF-Charging-Identifier AVP into the AA-Request for charging correlation purposes. The AF may also include the Specific-Action AVP to request notification for certain user plane events, e.g. bearer termination. + +The AF may include the Service-URN AVP in order to indicate that the new AF session relates to emergency or RLOS traffic and additionally it may include the AF-Requested-Data AVP to indicate the information required by the AF. If the PCRF receives the Service-URN AVP indicating an emergency session, the PCRF may apply special policies, for instance prioritising service flows relating to the new AF session or allowing these service flows free of charge. If the Service-URN AVP indicates that the new AF session relates to emergency traffic and the AF-Requested-Data AVP is received, the PCRF shall provide the requested available user information as part of the AA-Answer command. + +The AF may include the MPS-Identifier AVP in order to indicate that the new AF session relates to an MPS session. If the PCRF receives the MPS-Identifier AVP indicating an MPS session, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the MPS session is prioritized as specified in 3GPP TS 29.212 [8]. For Multimedia Priority Service handling for IMS, see Annex A.9. + +The AF may include the MCPTT-Identifier AVP in order to indicate that the new AF session relates to an MCPTT session with priority call. If the PCRF receives the MCPTT-Identifier AVP related to that MCPTT session, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the MCPTT session is prioritized. For the handling of MCPTT session with priority call, see Annex A.13. + +The AF may include the MCVideo-Identifier AVP in order to indicate that the new AF session relates to an MCVideo session with priority call. If the PCRF receives the MCVideo-Identifier AVP related to that MCVideo session, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the MCVideo session is prioritized. For the handling of MCVideo session with priority call, see Annex A.15. + +If the QoSHint feature is supported by the AF, the AF may include the Desired-Max-Latency AVP and/or Desired-Max-Loss AVP within the Media-Component-Description AVP to indicate to the PCRF that the related application media has specific latency and/or loss demands. + +The AF may include the FLUS-Identifier AVP within the Media-Component-Description AVP in order to indicate to the PCRF that the media flow(s) correspond to a FLUS media stream. Additional QoS information for the treatment of FLUS media may be provided within Desired-Max-Latency AVP and/or Desired-Max-Loss AVP. + +The AF may include the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP in order to indicate to the PCRF that the related media flow is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions as described in clause 4.4.8. In this case, if the MCPTT-Preemption is supported, the AF may also include the Pre-emption-Capability AVP containing the suggested pre-emption capability value and the Pre-emption-Vulnerability AVP containing the suggested pre-emption vulnerability value within the Media-Component-Description AVP for the PCRF to determine the ARP values. The AF may also include the Pre-emption-Control-Info AVP containing the pre-emption control information at the AAR command level for the PCRF to perform the pre-emption control as defined in clause 4.5.27 or 4a.5.17 of 3GPP TS 29.212 [8]. + +The AF may include the Sharing-Key-UL and/or Sharing-Key-DL AVP within the Media-Component-Description AVP in order to indicate that the related media of the new AF session may share resources with other media components in the related direction that include the same value for the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP. + +When the AF is a GCS AS, it may include the GCS-Identifier AVP at command level and Reservation-Priority AVP at command level or media component level in order to indicate that the new AF session relates to a prioritized Group + +Communication session. Based on this information, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the Group Communication session is prioritized as specified in 3GPP TS 29.212 [8]. + +If the AF provides service information that has been fully negotiated (e.g. based on the SDP answer), the AF may include the Service-Info-Status AVP set to FINAL\_SERVICE\_INFORMATION. In this case the PCRF shall authorize the session and provision the corresponding PCC/QoS rules to the PCEF/BBERF. + +The AF may additionally provide preliminary service information not fully negotiated yet (e.g. based on the SDP offer) at an earlier stage. To do so, the AF shall include the Service-Info-Status AVP with the value set to PRELIMINARY SERVICE INFORMATION. Upon receipt of such preliminary service information, the PCRF shall perform an early authorization check of the service information. For GPRS, the PCRF shall not provision PCC rules towards the PCEF unsolicitedly. However, the PCRF may authorize a PCC/QoS rule request received from the PCEF/BBERF as per 3GPP TS 29.212 [8]. Further, if the AF requests the PCRF to report the access network information together with preliminary service information, the PCRF shall immediately configure the PCEF (or BBERF) to provide the access network information. + +For sponsored data connectivity and if SponsoredConnectivity is supported, the AF shall provide the application service provider identity and the sponsor identity to the PCRF by including the Application-Service-Provider-Identity AVP and the Sponsor-Identity AVP in the Sponsored-Connectivity-Data AVP in the AA-Request. Additionally if SponsorChange is supported the AF shall provide an indication whether to enable or not enable sponsored data connectivity to the PCRF by including the Sponsoring-Action AVP set to the applicable value. + +NOTE 3: The relationship between the AF and Sponsor is out of scope of this specification. A single AF can serve multiple ASPs and multiple sponsors, An ASP can also be a sponsor. + +To support the usage monitoring of sponsored data connectivity, the AF may also include the Granted-Service-Unit AVP in the Sponsored-Connectivity-Data AVP and the Specific-Action AVP set to the value USAGE\_REPORT in the AA-Request to request notification when the usage threshold has been reached. + +NOTE 4: If the AF is in the user plane, the AF can handle the usage monitoring and therefore it is not required to provide a usage threshold to the PCRF as part of the sponsored data connectivity information. + +When SponsoredConnectivity is supported or when SponsorChange is supported and the AF indicated to enable sponsored data connectivity, the following procedures apply: + +- If the UE is roaming with the visited access case and the AF is located in the HPLMN or roaming with the home routed case and operator policies do not allow accessing the sponsored data connectivity with this roaming case, the H-PCRF shall reject the service request indicating UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY to the AF. +- If the UE is roaming with the visited access case and the AF is located in the VPLMN, the V-PCRF shall reject the service request indicating UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY to the AF. + +When SponsoredConnectivity is supported or when SponsorChange is supported and the AF indicated to enable sponsored data connectivity, if the UE is in the non-roaming case or roaming with the home routed case and the operator policies allow accessing the sponsored data connectivity with this roaming case, the following procedures apply: + +- If the PCEF/TDF does not support sponsored connectivity and the required reporting level for that service indicates a sponsored connectivity level according to 3GPP TS 29.212 [8], then the PCRF shall reject the request indicating REQUESTED\_SERVICE\_NOT\_AUTHORIZED. +- If the PCEF/TDF supports sponsored data connectivity feature or the required reporting level is different from sponsored connectivity level as described in 3GPP TS 29.212 [8], then the PCRF, based on operator policies, shall check whether it is required to validate the sponsored connectivity data. If it is required, it shall perform the authorizations based on sponsored data connectivity profiles. If the authorization fails, the PCRF responds to the AF with an AA-Answer including the Experimental-Result-Code AVP set to the value UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY. The profile may include a list of Application Service Providers and their applications per sponsor. + +NOTE 5: If the AF is in the operator's network and is based on the OSA/Parlay-X GW, the PCRF is not required to verify that a trust relationship exists between the operator and the sponsors. + +When CHEM feature is supported, the AF includes the Max-PLR-DL AVP and/or Max-PLR-UL AVP within the Media-Component-Description AVP, to indicate the downlink maximum packet loss rate and/or uplink maximum packet loss rate for each payload type. For CHEM feature, see Annex A.18. + +When the PCRF receives an initial AA-Request from the AF, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9]. To allow the PCRF to identify the IP-CAN session for which this request applies, the AF shall provide either the Framed-IP-Address or the Framed-Ipv6-Prefix containing the full IP address applicable to an IP flow or IP flows towards the UE. In case of private IP address being used, the AF may provide PDN information if available in the Called-Station-Id AVP for session binding. The AF may provide the domain identity in the IP-Domain-Id AVP for session binding. + +NOTE 6: The IP-Domain-Id AVP is helpful in the following scenario: Within a PLMN, there are several separate IP address domains, with PCEF(s) that allocate Ipv4 IP addresses out of the same private address range to UEs. The same IP address can thus be allocated to UEs served by PCEFs in different address domains. If one PCRF controls several PCEFs in different IP address domains, the UE IP address is thus not sufficient for the session binding. An AF can serve UEs in different IP address domains, either by having direct IP interfaces to those domains, or by having interconnections via NATs in the user plane between PCEFs and the AF. If a NAT is used, the AF obtains the IP address allocated to the UE via application level signalling and supplies it for the session binding as Framed-IP-Address to the PCRF. The AF supplies an IP-Domain-Id value denoting the IP address domain behind the NAT in addition. The AF can derive the appropriate value from the source address (allocated by the NAT) of incoming user plane packets. The value provided in the IP-Domain-Id AVP is operator configurable. + +NOTE 7: When the scenario described in NOTE 6 applies and the AF is a P-CSCF it is assumed that the P-CSCF has direct IP interfaces to the different IP address domains and that no NAT is located between P-GW and P-CSCF. How a non-IMS AF obtains the UE private IP address to be provided to the PCRF is out of scope of the present release; it is unspecified how to support applications that use a protocol that does not retain the original UE's private IP address. + +If the PCRF fails in executing session binding, the PCRF responds to the AF with an AA-Answer including the Experimental-Result-Code AVP set to the value IP-CAN\_SESSION\_NOT\_AVAILABLE. Further details on how the PCRF identifies suitable IP-CAN sessions can be found in the binding mechanism described in 3GPP TS 29.213 [9]. + +If the request contains Media-Component-Description Attribute-Value Pair(s) (AVP(s)) the PCRF shall store the received Service Information. The PCRF shall process the received Service Information according to the operator policy and may decide whether the request is accepted or not. The PCRF may take the priority information within the Reservation-Priority AVP into account when making this decision. + +For an IP-CAN session associated to a dedicated APN for the purpose of offering services to remote UEs via a ProSe UE-to-network relay UE, as defined in 3GPP TS 23.303 [46], the PCRF shall validate the service information based on the service/roaming agreement and the operator policies related to that PDN information. + +NOTE 8: The PCRF is not required to be aware of the remote UE. + +If the service information provided in the AA-Request command is rejected (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded), the PCRF shall indicate in the AA-Answer command the cause for the rejection with the Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_NOT\_AUTHORIZED. If the service information provided in the AA-Request command is rejected by the PCRF due to a temporary condition in the network (e.g. the user plane in the cell the user is located is congested), the PCRF may indicate in the AA-Answer the cause for the rejection with the Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED (4261). The PCRF may also provide a retry-interval within the Retry-Interval AVP in the AA-Answer command to the AF. When the AF receives the re-try interval within the Retry-Interval AVP, the AF shall not send the same service information to the PCRF again (for the same IP-CAN session) until the re-try interval has elapsed. The PCRF may additionally provide the acceptable bandwidth within the Acceptable-Service-Info AVP in AA-Answer command. + +NOTE 9: How the PCRF derives the re-try interval is up to implementation. + +To allow the PCRF and PCEF to perform PCC rule authorization and bearer binding for the described service IP flows, the AF shall supply both source and destination IP addresses and port numbers within the Flow-Description AVP, if such information is available. + +NOTE 10: In SDP source port information is usually not available. + +The AF may specify the ToS-Traffic-Class AVP for the described service data flows together with the Flow-Description AVP. + +NOTE 11: The ToS-Traffic-Class AVP can be useful when another packet filter attribute is needed to differentiate between flows. For example, (when EPS bearers are used for group communication services) flows encapsulated and encrypted by a tunneling protocol and thus having their IP five-tuple attributes obscured can be differentiated by the Type of Service (or Traffic Class) value of the outer header. + +NOTE 12: The use of ToS-Traffic-Class AVP by the AF assumes that no DSCP re-marking is applied from the application to the PGW. + +The AF may specify the Reservation-Priority AVP at request level in the AA-Request in order to assign a priority to the AF Session as well as specify the Reservation-Priority AVP at the media-component-description AVP level to assign a priority to the IP flow. The presence of the Reservation-Priority in both levels does not constitute a conflict as they each represent different types of priority. Specifically the Reservation-Priority at the AA-Request level provides the relative priority for a session while the Reservation-Priority at the media-component-description level provides the relative priority for an IP flow within a session. If the Reservation-Priority AVP is not specified the requested priority is DEFAULT (0). + +The AF may request notifications of specific IP-CAN session events through the usage of the Specific-Action AVP in the AA-Request command. The PCRF shall make sure to inform the AF of the requested notifications in the event that they take place. + +The AF may include the Rx-Request-Type AVP set to INITIAL\_REQUEST in the AAR. + +The AF may include a Reference Id within the Reference-Id AVP related to a transfer policy negotiated for background data transfer via the Nt reference point as described in 3GPP TS 29.154 [47]. The PCRF shall retrieve the corresponding transfer policy from the SPR based on the Reference Id. If the PCRF can not retrieve the transfer policy, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 0 set to indicate that the transfer policy is unknown. If the time window of the received transfer policy has expired, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 1 set to indicate that the transfer policy has expired. Otherwise, if the time window of the received transfer policy has not yet occurred, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 2 set to indicate that the time window of the transfer policy has not yet occurred. + +NOTE 13: In the case that the PCRF can not retrieve the transfer policy or the transfer policy expired, the PCRF makes the decision without considering the transfer policy. + +NOTE 14: When receiving the reference id from the 3rd party SCS/AS as described in 3GPP TS 23.682 [40], the SCEF (acting as an AF) can provide the reference id together with the sponsored data connectivity information if SponsorChange is supported as described in this clause. + +The AF may include the IMS-Content-Type AVP into the AA-Request in order to indicate the type of IMS communication service (e.g. CAT service, 3PTY conference) the AF session refers to. + +The AF may include the IMS-Content-Identifier AVP into the AA-Request in order to indicate the particular IMS communication service or communication dialogue that the AF session refers to. + +The AF may include the Calling-Party-Address AVP and the Callee-Information AVP into the AA-Request in order to indicate the caller and the callee information that the AF session refers to. + +The PCRF shall check whether the received Service Information requires PCC/QoS Rules to be created and provisioned and/or authorized QoS to be provisioned as specified in 3GPP TS 29.213 [9]. Provisioning of PCC/QoS Rules and Authorized QoS to the PCEF/BBRF shall be carried out as specified at 3GPP TS 29.212 [8]. + +If the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP are provided within the Media-Component-Description AVP, the PCRF may apply the mechanisms for resource sharing as specified at 3GPP TS 29.212 [8]. + +The PCRF shall reply with an AA-Answer to the AF. The acknowledgement towards the AF should take place before or in parallel with any required PCC Rule provisioning towards the PCEF and shall include the Access-Network-Charging-Identifier(s) and may include the Access-Network-Charging-Address AVP, if they are available. The AA- + +Answer message shall also include the AN-GW-Address AVP, if the PCRF has previously requested to be updated with this information in the PCEF. The AA-Answer message shall also include the PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP if the PCRF has previously requested to be updated with this information in the PCEF/BBERF. The AA-Answer message shall also include the IP-CAN-Type AVP, if the PCRF has previously requested to be updated with this information in the PCEF/BBERF. In that case, the AA-Answer message shall also include the RAT type information within the RAT-Type AVP and AN-Trusted AVP when applicable for the specific IP-CAN Type. In addition, if IP flow mobility applies to service data flows as specified in 3GPP TS 29.212 [8], such that a subset of the flows within the AF session are affected, the PCRF shall also include IP-CAN-type and RAT type information (if applicable) to IP flow mobility related flows, if such information is available. The IP flow mobility affected service data flows are included within the Flows AVP at command level. If the PCRF needs to terminate the Rx session before it has sent the AA Answer, the PCRF shall send the AA Answer immediately and before the AS Request. + +The behaviour when the AF does not receive the AA Answer, or when it arrives after the internal timer waiting for it has expired, or when it arrives with an indication different than DIAMETER\_SUCCESS, are outside the scope of this specification and based on operator policy. + +If the PCRF fails in installing PCC/QoS rules based on the provided service information due to resource allocation failure as specified in 3GPP TS 29.212 [8] and if requested by the AF, the PCRF shall send an RAR command to the AF with the Specific-Action AVP set to the value INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION to report the resource allocation failure, the Flows AVP containing the service data flows corresponding to the resources that could not be allocated, and the content version within the Content-Version AVP if it was included when the corresponding media component was provisioned. The AF shall send an RAA command to acknowledge the RAR command. + +### 4.4.2 Modification of Session Information + +The AF may modify the session information at any time (e.g. due to an AF session modification or internal AF trigger) by sending an AA-Request command to the PCRF containing the Media-Component-Description AVP(s) with the updated Service Information. The AF shall send an AA-Request command to the PCRF, only after the previous AA-Request has been acknowledged. + +If the AF provides service information that has been fully negotiated (e.g. based on the SDP answer), the AF may include the Service-Info-Status AVP set to FINAL\_SERVICE\_INFORMATION. In this case the PCRF shall authorize the session and provision the corresponding PCC rules to the PCEF. + +The AF may additionally provide preliminary service information not fully negotiated yet (e.g. based on the SDP offer) at an earlier stage. To do so, the AF shall include the Service-Info-Status AVP with the value set to PRELIMINARY SERVICE INFORMATION. Upon receipt of such preliminary service information, the PCRF shall perform an early authorization check of the service information. For GPRS, the PCRF shall not provision PCC rules towards the PCEF unsolicitedly. However, the PCRF may authorize a PCC/QoS rule request received from the PCEF/BBERF as per 3GPP TS 29.212 [8]. Further, if the AF requests the PCRF to report the access network information together with preliminary service information, the PCRF shall immediately configure the PCEF (or BBERF) to provide the access network information. + +The AF may include the Rx-Request-Type AVP set to UPDATE\_REQUEST in the AAR. + +The AF may include a Reference Id within the Reference-Id AVP related to a transfer policy negotiated for background data transfer via the Nt reference point as described in 3GPP TS 29.154 [47]. The AF shall retrieve the corresponding transfer policy from the SPR based on the Reference Id. If the PCRF can not retrieve the transfer policy, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 0 set to indicate that the transfer policy is unknown. If the time window of the received transfer policy has expired, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 1 set to indicate that the transfer policy has expired. Otherwise, if the time window of the received transfer policy has not yet occurred, the PCRF shall include in the AA-Answer the Service-Authorization-Info AVP with the bit 2 set to indicate that the time window of the transfer policy has not yet occurred. + +NOTE 1: In the case that the PCRF can not retrieve the transfer policy or the transfer policy expired, the PCRF makes the decision without considering the transfer policy. + +NOTE 2: When receiving the reference id from the 3rd party SCS/AS as described in 3GPP TS 23.682 [40], the SCEF (acting as an AF) can provide the reference id together with the sponsored data connectivity information if SponsorChange is supported as described in this clause. + +The AF may include the MPS-Identifier AVP in order to indicate that the modified AF session relates to an MPS session. If the PCRF receives the MPS-Identifier AVP, it may take specific actions on the corresponding IP-CAN to ensure that the MPS session is prioritized as defined in 3GPP TS 29.212 [8]. For Multimedia Priority Service handling for IMS, see Annex A.9. + +The AF may include the MCPTT-Identifier AVP in order to indicate that the modified AF session relates to the priority adjustment of an MCPTT session. If the PCRF receives the MCPTT-Identifier AVP related to that MCPTT session, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the MCPTT session is prioritized. For the handling of MCPTT session with priority call, see Annex A.13. + +The AF may include the MCVideo-Identifier AVP in order to indicate that the modified AF session relates to the priority adjustment of an MCVideo session. If the PCRF receives the MCVideo-Identifier AVP related to that MCVideo session, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the MCVideo session is prioritized. For the handling of MCVideo session with priority call, see Annex A.15. + +If the QoSHint feature is supported by the AF, the AF may include the Desired-Max-Latency AVP and/or Desired-Max-Loss AVP within the Media-Component-Description AVP to indicate to the PCRF that the related application media has specific latency and/or loss demands. + +The AF may include the FLUS-Identifier AVP within the Media-Component-Description AVP in order to indicate to the PCRF that the media flow(s) correspond to a FLUS media stream. Additional QoS information for the treatment of FLUS media may be provided within Desired-Max-Latency AVP and/or Desired-Max-Loss AVP. + +The AF may include the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP in order to indicate to the PCRF that the related media flow is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other AF sessions as described in clause 4.4.8. In this case, if the MCPTT-Preemption is supported, the AF may also include the Pre-emption-Capability AVP containing the suggested pre-emption capability value and the Pre-emption-Vulnerability AVP containing the suggested pre-emption vulnerability value within the Media-Component-Description AVP for the PCRF to determine the ARP values. The AF may also include the Pre-emption-Control-Info AVP containing the pre-emption control information at the AAR command level for the PCRF to perform the pre-emption control as defined in clause 4.5.27 or 4a.5.17 of 3GPP TS 29.212 [8]. + +The AF may include the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP in order to indicate that the related media of the modified AF session may share resources with other media components in the related direction that include the same Sharing-Key-UL and or Sharing-Key-DL AVP. The AF may modify the conditions for resource sharing by including a new value of the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP for that media component. + +When the AF is a GCS AS, it may include the GCS-Identifier AVP at command level and Reservation-Priority AVP at command level or media component level in order to modify the priority of an AF session that relates to a prioritized Group Communication session. Based on this information, the PCRF may take specific actions on the corresponding IP-CAN to ensure that the Group Communication session is prioritized as specified in 3GPP TS 29.212 [8]. + +For sponsored data connectivity and if SponsoredConnectivity is supported, the AF shall provide the application service provider identity and the sponsor identity to the PCRF by including Application-Service-Provider-Identity AVP and the Sponsor-Identity AVP in the Sponsored-Connectivity-Data AVP in the AA-Request. + +If SponsorChange is supported and the AF requests to enable sponsored data connectivity the AF shall provide the application service provider identity, the sponsor identity and an indication to enable sponsored data connectivity to the PCRF by including Application-Service-Provider-Identity AVP, the Sponsor-Identity AVP and the Sponsoring-Action AVP set to the value ENABLE\_SPONSORING (1) in the Sponsored-Connectivity-Data AVP in the AA-Request. + +If the AF requests to disable sponsored data connectivity the AF shall provide an indication to disable sponsored data connectivity to the PCRF by including the Sponsoring-Action AVP set to the value DISABLE\_SPONSORING (0) in the Sponsored-Connectivity-Data AVP in the AA-Request. + +To support the usage monitoring of sponsored data connectivity, the AF may also include the Granted-Service-Unit AVP in the Sponsored-Connectivity-Data AVP in the AA-Request. + +NOTE 3: If the AF is in the user plane, the AF can handle the usage monitoring and therefore it is not required to provide a usage threshold to the PCRF as part of the sponsored data connectivity information. + +When sponsored data connectivity is requested to be enabled the following procedures apply: + +- If the UE is roaming with the visited access case and the AF is located in the HPLMN or roaming with the home routed case and operator policies do not allow accessing the sponsored data connectivity with this roaming case, the H-PCRF shall reject the service request indicating UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY to the AF. +- If the UE is roaming with the visited access case and the AF is located in the VPLMN, the V-PCRF shall reject the service request indicating UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY to the AF. + +When sponsored data connectivity is requested to be enabled, if the UE is in the non-roaming case or roaming with the home routed case and the operator policies allow accessing the sponsored data connectivity with this roaming case, the following procedures apply: + +- If the PCEF/TDF does not support sponsored connectivity and the required reporting level for that service indicates a sponsored connectivity level according to 3GPP TS 29.212 [8], then the PCRF shall reject the request indicating REQUESTED\_SERVICE\_NOT\_AUTHORIZED. +- If the PCEF/TDF supports sponsored data connectivity feature or the required reporting level is different from sponsored connectivity level as described in 3GPP TS 29.212 [8], then the PCRF, based on operator policies, shall check whether it is required to validate the sponsored connectivity data. If it is required, it shall perform the authorizations based on sponsored data connectivity profiles. If the authorization fails, the PCRF responds to the AF with an AA-Answer including the Experimental-Result-Code AVP set to the value UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY. The profile may include a list of Application Service Providers and their applications per sponsor. + +NOTE 4: If the AF is in the operator's network and is based on the OSA/Parlay-X GW, the PCRF is not required to verify that a trust relationship exists between the operator and the sponsors. + +When CHEM feature is supported, the AF includes the Max-PLR-DL AVP and/or Max-PLR-UL AVP within the Media-Component-Description AVP, to indicate the downlink maximum packet loss rate and/or uplink maximum packet loss rate for each payload type. For CHEM feature, see Annex A.18. + +The AF may include an AF application identifier within the AF-Application-Identifier AVP at the session level to trigger the PCRF to indicate to the PCEF/TDF to perform the application detection based on the operator's policy as defined in 3GPP TS 29.212 [8]. + +The AF may include the IMS-Content-Type AVP into the AA-Request in order to indicate the type of IMS communication service (e.g. CAT service, 3PTY conference) the AF session refers to. + +The AF may include the IMS-Content-Identifier AVP into the AA-Request in order to indicate the particular IMS communication service or communication dialogue that the AF session refers to. + +The AF may include the Callee-Information AVP into the AA-Request in order to indicate the callee information that the AF session refers to. + +The PCRF shall process the received Service Information according the operator policy and may decide whether the request is accepted or not. If the updated Service Information is not acceptable (e.g. subscribed guaranteed bandwidth for a particular user is exceeded), the PCRF shall indicate in the AA-Answer command the cause for the rejection with the Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_NOT\_AUTHORIZED. If the service information provided in the AA-Request command is rejected by the PCRF due to a temporary condition in the network (e.g. the user plane in the cell the user is located is congested), the PCRF may indicate in the AA-Answer the cause for the rejection with the Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED (4261). The PCRF may also provide a retry-interval within the Retry-Interval AVP in the AA-Answer command to the AF. When the AF receives the re-try interval within the Retry-Interval AVP, the AF shall not send the same service information to the PCRF again (for the same IP-CAN session) until the re-try interval has elapsed. The PCRF may additionally provide the acceptable bandwidth within the Acceptable-Service-Info AVP in the AA-Answer command. + +NOTE 5: How the PCRF derives the re-try interval is up to implementation. + +If accepted, the PCRF shall update the Service Information with the new information received. Due to the updated Service Information, the PCRF may need to create, modify or delete the related PCC rules as specified in 3GPP TS 29.213 [9] and provide the updated information towards the PCEF following the corresponding procedures + +specified at 3GPP TS 29.212 [8]. The procedures to update the Authorized QoS for the affected IP-CAN bearer are also specified at 3GPP TS 29.212 [8]. + +If the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP are provided within the Media-Component-Description AVP, the PCRF may apply the mechanisms for resource sharing as specified at 3GPP TS 29.212 [8]. + +The PCRF shall reply with an AA-Answer to the AF. The acknowledgement towards the AF should take place before or in parallel with any required PCC Rule provisioning towards the PCEF and shall include the Access-Network-Charging-Identifier(s) and may include the Access-Network-Charging-Address AVP, if they are available at this moment and have not been yet supplied earlier to the AF. The AA-Answer message shall include the AN-GW-Address AVP if the PCRF has previously requested to be updated with this information in the PCEF. The AA-Answer message shall also include the PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP if the PCRF has previously requested to be updated with this information in the PCEF/BBERF. The AA-Answer message shall also include the IP-CAN-Type AVP if the PCRF has previously requested to be updated with this information in the PCEF/BBERF. In that case, the AA-Answer message shall also include the RAT type information within the RAT-Type AVP and AN-Trusted AVP when applicable for the specific IP-CAN Type. In addition, if IP flow mobility applies to service data flows as specified in 3GPP TS 29.212 [8], such that a subset of the flows within the AF session are affected, the PCRF shall also include IP-CAN-type and RAT type information (if applicable) to IP flow mobility related flows, if the PCRF has previously requested to be updated with this information in the PCEF. The IP flow mobility affected service data flows are included within the Flows AVP at command level. If the PCRF needs to terminate the Rx session before it has sent the AA Answer, the PCRF shall send the AA Answer immediately and before the AS Request. If the PCRF does not have an existing session for the Rx session being modified (such as after a PCRF failure), the PCRF may reject the request with an AA-Answer with the result code set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +If the PCRF installs PCC/QoS rules or modifies existing PCC/QoS rules based on the updated service information and the installation or modification fails due to resource allocation failure as specified in 3GPP TS 29.212 [8] and if requested by the AF, the PCRF shall send an RAR command to the AF with the Specific-Action AVP set to the value INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION to report the modification failure, the Flows AVP containing the service data flows corresponding to the resources that could not be allocated, and the content version(s) within the Content-Version AVP(s) if it was included when the corresponding media component was provisioned. If the modification of the existing PCC/QoS rules fails, the PCRF may also provide the status of the service information within the Media-Component-Status AVP. The AF shall send an RAA command to acknowledge the RAR command. + +NOTE 6: The PCRF will report the Media-Component-Status AVP according to the status reported for the related PCC/QoS rules when the modification fails over the Gx/Gxx reference points as described in 3GPP TS 29.212 [8]. + +### 4.4.3 Gate Related Procedures + +Depending on the application, in the Service Information provision, the AF may instruct the PCRF when the IP flow(s) are to be enabled or disabled to pass through the IP-CAN. The AF does this by sending the AA-Request message containing the Media-Component- Description AVP(s) that contains the flow status information (in the Flow-Status AVP) for the flows to be enabled or disabled. + +In response to this action the PCRF shall set the appropriate gate status for the corresponding active PCC rule(s). + +If a Media-Sub-Component AVP under a Media-Component-Description AVP contains a Flow-Usage AVP with the value RTCP, then the corresponding RTCP IP Flows in both directions shall be enabled even if the Flow-Status AVP under the Media-Sub-Component AVP is set to ENABLED-UPLINK, ENABLED-DOWNLINK, ENABLED, or DISABLED. + +The PCRF shall reply with an AA-Answer and shall include the Access-Network-Charging-Identifier(s) available at this moment. The PCRF forwards the AF decision to enable or disable the authorized IP flows. + +The behaviour when the AF does not receive the AAA, or when it arrives after the internal timer waiting for it has expired, or when it arrives with an indication different than DIAMETER\_SUCCESS, are outside the scope of this specification and based on operator policy. + +### 4.4.4 AF Session Termination + +When an AF session is terminated, if the AF had received a successful AA-Answer for the initial AA-Request, the AF shall send a Session-Termination-Request command to the PCRF. Otherwise, the AF shall wait for the initial AA-Answer to be received prior to sending the Session-Termination-Request command to the PCRF. + +When the PCRF receives a ST-Request from the AF, indicating an AF session termination, it shall acknowledge that request by sending a ST-Answer to the AF. Afterwards, it shall free the resources allocated for the corresponding Service Data Flow(s). In order to do that, the PCRF shall initiate the request for the removal of any related PCC/QoS rules from the PCEF/BBRF and for the update of the Authorized QoS for the affected IP-CAN bearer following the corresponding procedures specified at 3GPP TS 29.212 [8]. However, if the AF requests the reporting of access network information within the ST-Request or if the AF provided a threshold for the sponsored data connectivity, the PCRF shall defer sending the ST-Answer. + +If the AF session being terminated corresponds to an MPS session, the PCRF may revoke the actions related to the prioritization of the MPS session in the corresponding IP-CAN as defined in 3GPP TS 29.212 [8]. For Multimedia Priority Service handling for IMS, see Annex A.9. + +If the AF session being terminated corresponds to the last Group Communication session for the IP-CAN session, the PCRF may revoke the actions related to the prioritization of the Group Communication session as specified in 3GPP TS 29.212 [8]. + +If the AF session being terminated corresponds to a session that included the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP, the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing priority as described in clause 4.4.8. + +For sponsored data connectivity, and if a usage threshold was provided for the sponsored data connection at initial provisioning of session information (clause 4.4.1) or modification of session information (clause 4.4.2) procedures, the PCRF shall provide the usage consumed to the AF. For such purpose, the PCRF shall initiate the IP-CAN session modification procedure according 3GPP TS 29.212 [8] in order to obtain the consumed usage. The PCRF shall send then the ST-Answer to the AF including the Used-Service-Unit AVP for reporting accumulated usage within the Sponsored-Connectivity-Data AVP. + +If the AF requires access network information at this step, the AF shall include the Required-Access-Info AVP within the ST-Request command, indicating the required information. In this case, the PCRF shall initiate the IP-CAN session modification procedure according to 3GPP TS 29.212 [8]. The PCRF shall send then the ST-Answer to the AF including the required data within the 3GPP-User-Location-Info AVP (if available), TWAN-Identifier AVP (if available), User-Location-Info-Time AVP (if available), UE-Local-IP-Address AVP (if available), UDP-Source-Port AVP (if available), TCP-Source-Port AVP (if available), 3GPP-SGSN-MCC-MNC AVP (if location info is not available) and/or 3GPP-MS-TimeZone AVP (if available). + +If the RAN-NAS-Cause feature is supported and the AF initiated the termination of the AF session, upon reception of the ST-Request command, the PCRF shall initiate the IP-CAN session modification procedure according to 3GPP TS 29.212 [8]. + +If the RAN-NAS-Cause feature is supported , in all the AF session termination cases , t he PCRF shall send the ST-Answer to the AF including the access network information within the 3GPP-User-Location-Info AVP (if available), TWAN-Identifier (if available and Netloc-Trusted-WLAN feature is supported) User-Location-Info-Time AVP (if available), 3GPP-SGSN-MCC-MNC AVP (if location info is not available) and/or 3GPP-MS-TimeZone AVP (if available). Additionally, if the PCRF received from the PCEF the RAN cause and/or NAS cause, TWAN cause or untrusted WLAN cause, the PCRF shall provide the received cause(s) in the RAN-NAS-Release-Cause AVP in the ST-Answer command. + +NOTE: The PCRF will apply the procedures described in 3GPP TS 29.212 [8] to get updated about the outcome of the resource release over Gx reference point in order to get the location and failure cause(s) when applicable. + +### 4.4.5 Subscription to Notification of Signalling Path Status + +An AF may subscribe to notifications of the status of the AF Signalling transmission path. To do so, the AF shall open an Rx Diameter session with the PCRF for the AF signalling using an AA-Request command. The AF shall provide the UE's IP address (using either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP) and the Specific-Action + +AVP requesting the subscription to "INDICATION\_OF\_LOSS\_OF\_BEARER" and/or "INDICATION\_OF\_RELEASE\_OF\_BEARER". The AF shall additionally provide a Media-Component-Description AVP including a single Media-Sub-Component AVP with the Flow-Usage AVP set to the value "AF\_SIGNALLING". The Media-Component-Description AVP shall contain the Media-Component-Number AVP set to "0". + +If the procedures in Clause 4.4.5A are not applied, the Media-Sub-Component AVP shall contain the Flow-Number AVP set to "0", and the rest of AVPs within the Media-Component-Description and Media-Sub-Component AVPs shall not be used in this case. + +When the PCRF receives an AA-Request as described in the preceding paragraph from the AF, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9] and acknowledges the AAR command by sending an AA-Answer command to the AF. + +PCC/QoS Rules related to AF Signalling IP Flows should be provisioned to PCEF/BBERF using the corresponding procedures specified at 3GPP TS 29.212 [8] at an earlier stage (e.g. typically at the establishment of the IP-CAN bearer dedicated for AF Signalling IP Flows). The PCRF may install the corresponding dynamic PCC/QoS rule for the AF signalling IP flows if none has been installed before. + +NOTE 1: Well-known ports (e.g. 3GPP TS 24.229 [17] for SIP) or wildcard ports can be used by PCRF to derive the dynamic PCC/QoS rule for the AF signalling IP flows. + +If the Rx Diameter Session is only used for subscription to Notification of Signalling Path Status, the AF may cancel the subscription to notifications of the status of the AF Signalling transmission path. In that case, the AF shall use a Session-Termination-Request (STR) command to the PCRF, which shall be acknowledged with a Session-Termination-Answer (STA) command. + +NOTE 2: The Rx Diameter Session created for the AF signalling can also be used when the AF requests notifications of IP-CAN type change, PLMN change, access network information for SMS over IP and/or when the AF provisions AF Signalling Flow Information. + +### 4.4.5A Provisioning of AF Signalling Flow Information + +This clause is applicable when IMS restoration is supported according to supported feature ProvAFsignalFlow as described in clause 5.4.1. + +An AF may provision information about the AF signalling IP flows between the UE and the AF. To do so, the AF shall make use of an Rx Diameter session already opened with the PCRF if an Rx Diameter session related to the AF signalling is already established. The AF may modify an already open Rx Diameter session related to the AF signalling (e.g. an Rx Diameter session established for the purpose of subscription to notification of signalling path status as described in 4.4.5) or it may open a new Rx Diameter session related to the AF signalling if none exists. + +To provision the AF signalling flow information the AF shall provide the UE's IP address using either Framed-IP-Address AVP or Framed-Ipv6-Prefix AVP. The AF shall additionally provide a Media-Component-Description AVP including one or more Media-Sub-Component AVP(s) representing the AF signalling IP flows. The Media-Component-Description AVP shall contain the Media-Component-Number AVP set to "0". Each Media-Sub-Component AVP representing an AF signalling IP flow shall contain the Flow-Number AVP set according to the rules described in Annex B and one or two Flow-Description AVP(s) set to the IP flows of the AF signalling. Additionally, the Media-Sub-Component AVP shall include the Flow-Usage AVP set to the value "AF\_SIGNALLING", the Flow-Status AVP set to "ENABLED" and the AF-Signalling-Protocol AVP set to the value corresponding to the signalling protocol used between the UE and the AF. + +When the PCRF receives from the AF an AA-Request as described in the preceding paragraph, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9] and shall acknowledge the AAR command by sending an AA-Answer command to the AF. + +PCC/QoS Rules related to the AF signalling IP flows could have been provisioned to PCEF/BBERF using the corresponding procedures specified in 3GPP TS 29.212 [8] at an earlier stage (e.g. typically at the establishment of the IP-CAN bearer dedicated for AF Signalling IP Flows). The PCRF shall install the corresponding dynamic PCC/QoS rule for the AF signalling IP flows. + +The AF may de-provision the information about the AF signalling IP flows at any time. To do that, if the Rx Diameter session is only used to provide information about the AF Signalling IP flows, the AF shall close the Rx Diameter + +session by sending a Session-Termination-Request (STR) command to the PCRF, which shall be acknowledged with a Session-Termination-Answer (STA) command. Otherwise, the AF shall remove the IP flows within the Media-Sub-Component AVP by supplying the Flow-Status AVP with value "REMOVED". In both cases, the PCRF shall remove the corresponding dynamic PCC/QoS rule for the AF signalling IP flows. + +### 4.4.6 Traffic Plane Events + +#### 4.4.6.1 IP-CAN Session Termination + +When an IP-CAN session is terminated, the PCRF shall inform the AF about the IP-CAN session termination by sending an ASR (abort session request) command to the AF on each active Rx Diameter session. + +When the AF receives the ASR command, it shall acknowledge the command by sending an ASA (abort session answer) command to the PCRF. After that the AF shall initiate an AF session termination procedure as defined in clause 4.4.4. + +Signalling flows for IP-CAN session termination cases are presented in 3GPP TS 29.213 [9]. + +#### 4.4.6.2 Service Data Flow Deactivation and Resource Allocation Failure + +It may happen that one or more PCC/QoS Rules (i.e. Service Data Flows) are deactivated at the PCEF/BBERF at a certain time, either permanently or temporarily or resource allocation for one or more PCC rules is unsuccessful at the PCEF/BBERF when the PCC rule(s) are installed. When the PCRF gets the knowledge that one or more SDFs have been deactivated, (e.g. due to a bearer release or loss of bearer or out of credit condition), or the resource allocation failed the PCRF shall inform the AF accordingly if the AF has previously subscribed using the Specific-Action AVP in the AAR command. + +When not all the service data flows within the AF session are affected, the PCRF shall inform the AF by sending an RAR (re-authorization request) command. The RAR command shall include the affected IP Flows encoded in the Flows AVP, the cause encoded in the Specific-Action AVP and the content version of a media component within the Content-Version AVP if it was included when the media component was provisioned. + +If the RAN-NAS-Cause feature is supported and the PCRF received the access network information from the PCEF/BBERF due to bearer termination or unsuccessful bearer establishment/modification, the PCRF shall include in the RAR command the access network information within the 3GPP-User-Location-Info AVP (if available), TWAN-Identifier (if available and Netloc-Trusted-WLAN feature is supported) User-Location-Info-Time AVP (if available), 3GPP-SGSN-MCC-MNC AVP (if location info is not available) and/or 3GPP-MS-TimeZone AVP (if available). Additionally, if the PCRF received from the PCEF the RAN cause and/or NAS cause, TWAN cause or untrusted WLAN cause due to bearer termination, the PCRF shall provide the received cause(s) in the RAN-NAS-Release-Cause AVP in the RAR command. + +When the AF receives the RAR command, it shall acknowledge the command by sending an RAA (re-authorization answer) command to the PCRF. The AF may also update the session information by sending an AAR (AA-request) command to the PCRF. + +If the PCRF receives the AAR command, it shall acknowledge the command by sending an AAA (AA-answer) command to the AF. + +When all the service data flows within the AF session are affected, the PCRF shall inform the AF by sending an ASR command on the Rx Diameter session related to the AF session. When the AF receives the ASR command, it shall acknowledge the command by sending an ASA (abort session answer) command to the PCRF. After that the AF shall initiate an AF session termination procedure as defined in clause 4.4.4. + +Signalling flows for Service Data Flow Deactivation and Resource Allocation Failure cases are presented in 3GPP TS 29.213 [9]. + +#### 4.4.6.3 Notification of Signalling Path Status + +In the event that the PCRF is notified of the loss or release of resources associated to the PCC/QoS Rules corresponding with AF Signalling IP Flows, the PCRF shall inform the AF about the Loss of the Signalling Transmission path by sending a Re-Authorization Request (RAR) command to the AF. The RAR shall include the Specific-Action AVP set to + +the value "INDICATION\_OF\_LOSS\_OF\_BEARER" or "INDICATION\_OF\_RELEASE\_OF\_BEARER" and the deactivated IP Flow encoded in the Flows AVP. + +NOTE: According to the standardized QCI characteristics as defined in 3GPP TS 23.203 [2], the IMS signalling specific PCC rules include a QCI corresponding to a non-GBR bearer. When these guidelines are followed, the INDICATION\_OF\_LOSS\_OF\_BEARER will not be reported. + +If the RAN-NAS-Cause feature is supported and the PCRF received the access network information from the PCEF/BBERF due to bearer termination, the PCRF shall include in the RAR command the access network information within the 3GPP-User-Location-Info AVP (if available), TWAN-Identifier (if available and Netloc-Trusted-WLAN feature is supported) User-Location-Info-Time AVP (if available), 3GPP-SGSN-MCC-MNC AVP (if location info is not available) and/or 3GPP-MS-TimeZone AVP (if available). Additionally, if the PCRF received from the PCEF the RAN cause and/or NAS cause, TWAN cause or untrusted WLAN cause due to bearer termination, the PCRF shall provide the received cause(s) in the RAN-NAS-Release-Cause AVP in the RAR command. + +When the AF receives the RAR command, it shall acknowledge the command by sending an RAA command to the PCRF. + +The AF may then decide to terminate the Rx Diameter session used for the notification of the status of the AF Signalling transmission path. The AF may also decide to terminate any other active Rx Diameter session with the PCRF related to the AF Signalling which is not available any longer. In that case, the AF shall then initiate the AF Termination procedure towards the PCRF as defined in clause 4.4.4. + +#### 4.4.6.4 IP-CAN type change Notification + +If the AF has successfully subscribed to change notifications in UE's IP-CAN type and RAT type, the PCRF shall send an RAR command when the corresponding event occurs, i.e. when the UE's IP-CAN type or RAT type changes or becomes available. In this case the RAR from the PCRF shall include the Specific-Action AVP for the subscribed event and include the IP-CAN-Type AVP, RAT-Type AVP (if applicable) and AN-Trusted AVP (if applicable) and AN-GW-Address AVP (if applicable) for the UE's new IP-CAN/RAT. If the PCRF is informed of an IP-CAN type change due to IP flow mobility as specified in 3GPP TS 29.212 [8], where a subset of the flows within the AF session are affected, the PCRF shall include IP-CAN type and RAT type information (if applicable) to IP flow mobility affected service data flows. The IP flow mobility affected service data flows are included within the Flows AVP at command level. + +#### 4.4.6.5 Access Network Charging Information Notification + +If the AF has subscribed to a notification about Access Network Charging Information, the PCRF shall provide the Access Network Charging Information in the response, if already known by the PCRF. If not available, the PCRF shall provide the Access Network Charging Information by sending a Re-Authorization-Request (RAR) command when the Access Network Charging Information is received from the PCEF. If different Access Network Charging Information is applicable to the IP-CAN session, the PCRF shall notify the AF about the Access Network Charging Information that applies to each authorized flow. The RAR shall include the Specific-Action AVP set to the value "CHARGING\_CORRELATION\_EXCHANGE" and shall include the assigned Access-Network-Charging-Identifier(s) and may include the Access-Network-Charging-Address AVP. + +#### 4.4.6.6 Reporting Usage for Sponsored Data Connectivity + +When SponsoredConnectivity is supported or when SponsorChange is supported and the AF indicated to enable sponsored data connectivity and the AF provided usage monitoring thresholds for such sponsor to the PCRF when the Rx Diameter session was established or modified, the PCRF shall report accumulated usage to the AF, when + +- the PCRF detects that the usage threshold provided by the AF has been reached; or +- the AF session is terminated by the AF; +- the AF disables the sponsored data connectivity; or +- the AF session is terminated by the PCRF due to the IP-CAN session termination, the termination of all the service data flows of the AF session or the home operator policy disallowing the UE accessing the sponsored data connectivity in the roaming case. + +When the PCRF detects that the usage threshold has been reached or the AF disables the sponsored data connectivity, the PCRF shall report the accumulated usage as provided by the PCEF/TDF to the AF in a RA-Request (RAR) + +command with the Specific-Action AVP set to the value USAGE\_REPORT; Otherwise, when the AF session is terminated by the AF or the PCRF, the PCRF shall report the accumulated usage as provided by the PCEF/TDF to the AF in ST-Answer (STA) command. The accumulated usage reported by the PCRF corresponds to the usage since the last report to the AF. + +The accumulated usage shall be reported in the Used-Service-Unit AVP within the Sponsored-Connectivity-Data AVP. + +If the AF receives a RAR command indicating the usage threshold is reached, the AF may terminate the AF session or provide a new usage threshold in the Granted-Service-Unit AVP within the Sponsored-Connectivity-Data AVP to the PCRF in the AAR command. Alternatively, the AF may allow the session to continue without providing new usage threshold in the AAR command. + +NOTE: After the PCRF reports the accumulated usage to the AF, the AF can provide a new usage threshold to the PCRF. The monitoring will not start until the PCRF receives the new threshold from the AF and provide it to the PCEF + +#### 4.4.6.7 Reporting Access Network Information + +If the AF requests the PCRF to report the access network information (i.e. user location and/or user timezone information), the AF shall subscribe to the "ACCESS\_NETWORK\_INFO\_REPORT" within the Specific-Action AVP and shall include the required access network information within the Required-Access-Info AVP. The AF may request the PCRF to report the access network information in conjunction with providing the PCRF with the AF session information, refer to clause 4.4.1. Optionally, the AF may request the PCRF to report the access network information without providing service information (see clause A.10.2). In the latter case the AF establishes an Rx session for the AF session upon requesting the access network information from the PCRF with an AA-Request command, containing information required for the session binding in the Framed-IP-Address AVP, the Framed-Ipv6-Prefix AVP Subscription-Id AVP, the Called-Station-Id AVP and/or the IP-Domain-Id AVP. + +The AF may also request the PCRF to report the access network information at Rx session termination. To do so, the AF shall include the required access network information within the Required-Access-Info AVP in the corresponding ST-Request. + +When the PCRF receives a request to report the access network information from the AF in an AAR command or in an STR command triggered by the AF, if the PCRF determines that the access network does not support the access network information reporting based on the currently used IP-CAN type or the values of the RAT-Type AVP or the PCEF/BBERF does not support the NetLoc feature as described in clause 5.4.1, the PCRF shall respond to AF with an AAA or STA command including the NetLoc-Access-Support AVP set to the value of 0 (NETLOC\_ACCESS\_NOT\_SUPPORTED); otherwise, it shall immediately configure the PCEF or BBERF to provide such access network information. + +When the PCRF then receives the access network information from the PCEF/BBERF, the PCRF shall provide the corresponding access network information to the AF within the 3GPP-User-Location-Info AVP (if available), TWAN-Identifier AVP (if available), User-Location-Info-Time AVP (if available), UE-Local-IP-Address AVP (if available), UDP-Source-Port AVP (if available), TCP-Source-Port AVP (if available), 3GPP-SGSN-MCC-MNC AVP (if location info is not available) and/or 3GPP-MS-TimeZone AVP in the RAR command if the Rx session is not being terminated or in the STA command if the Rx session is being terminated. If the information is provided in the RAR command, PCRF shall also provide the ACCESS\_NETWORK\_INFO\_REPORT within Specific-Action AVP. + +NOTE 1: The PCRF receives the access network information from the PCEF/BBERF if it is requested by the AF previously or the IP-CAN bearer/IP-CAN session is terminated. + +When the PCRF receives the NetLoc-Access-Support AVP set to the value of 0 (NETLOC\_ACCESS\_NOT\_SUPPORTED) from the PCEF/BBERF, the PCRF shall send a RAR command including the Specific-Action AVP set to INDICATION\_OF\_ACCESS\_NETWORK\_INFO\_REPORTING\_FAILURE and the NetLoc-Access-Support AVP set to the value of 0 (NETLOC\_ACCESS\_NOT\_SUPPORTED) if the AF requested the access network information in an AAR command or send an STA command including the NetLoc-Access-Support AVP set to the value of 0 (NETLOC\_ACCESS\_NOT\_SUPPORTED) if the AF requested the access network information in an STR command. + +NOTE 2: The 3GPP GPRS, 3GPP EPS, Untrusted WLAN and Trusted WLAN support access network information reporting in this release. + +The PCRF shall not send an RAR command with the ACCESS\_NETWORK\_INFO\_REPORT value within a Specific-Action AVP to report any subsequently received access network information to the AF, unless the AF sends a new request for access network information. + +#### 4.4.6.8 Temporary Network Failure handling + +If the PCRF detects that a temporary network failure has occurred (e.g. the SGW has failed for 3GPP-EPS access as defined in clause B.3.14 of 3GPP TS 29.212 [8]) and the AF requests an AF session establishment or modification in an AA-Request command, the PCRF shall respond to the AF with an AA-Answer including the Experimental-Result-Code AVP set to the value TEMPORARY\_NETWORK\_FAILURE. + +If the PCRF detects that a temporary network failure has occurred (e.g. the SGW has failed for 3GPP-EPS access) and the AF requests an AF session termination in a ST-Request command, the PCRF shall respond with successful Result-Code AVP to the AF. + +NOTE 1: If the AF includes the Required-Access-Info AVP in the ST-Request command to request the access network information, the PCRF will not include the access network information in the ST-Answer command. + +NOTE 2: Actions over Gx/Gxx reference point when there is a temporary network failure are described in 3GPP TS 29.212 [8]. For example, for S-GW Restoration procedures the PCRF will wait for the SGW recovery before deleting the corresponding PCC/QoS rules, according to clause B.3.14 in that specification. + +If the PCRF detects that the PCC/QoS rules related to an AF session cannot be installed or modified because there is a temporary network failure (e.g. SGW failed according to clause B.3.14 in 3GPP TS 29.212 [8]) and if requested by the AF, the PCRF shall send a RA-Request command to the AF with the Specific-Action AVP set to INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION and the content version of a media component within the Content-Version AVP if it was included when the media component was provisioned. If the modification of the PCC/QoS rules fails, the PCRF may provide the status of the related service information within the Media-Component-Status AVP. + +#### 4.4.6.9 PLMN information change Notification + +If the AF has successfully subscribed to PLMN\_CHANGE notification, the PCRF shall send an RAR command when the corresponding event occurs, i.e. when the PLMN where the UE is located has been updated or becomes available. In this case the RAR from the PCRF shall include the Specific-Action AVP set to PLMN\_CHANGE and include the 3GPP-SGSN-MCC-MNC AVP for the PLMN where the UE is located. + +### 4.4.7 P-CSCF Restoration Enhancement Support + +This clause is applicable when the PCRF-based P-CSCF Restoration Enhancement, as defined in 3GPP TS 23.380 [28], is supported by both P-CSCF and PCRF. + +The P-CSCF acting as AF shall send an AAR command including the Rx-Request-Type AVP set to the value PCSCF\_RESTORE (2) to the PCRF in the case P-CSCF Restoration needs to be performed. This AAR shall include the following information required by the DRA or PCRF to find the corresponding IP-CAN session: + +- The UE's IP address as applicable in the Framed-IP-Address AVP or in the Framed-Ipv6-Prefix AVP. If the IP address is not unique (e.g. private IPv4 case), the P-CSCF shall also include the IP-Domain-ID AVP if available. +- If the IP address is not available or if the IP address is not unique and the IP-Domain-ID is not available, the P-CSCF shall include the IMSI in the Subscription-Id AVP and the APN in the Called-Station-Id AVP. + +The AF shall also include the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1) in the AAR command, as described in IETF RFC 6733 [52]. As a consequence, the PCRF shall not maintain any state information about this session. + +The PCRF shall acknowledge the AAR command by sending an AAA command to the P-CSCF acting as AF and shall include the Auth-Session-State AVP set to NO\_STATE\_MAINTAINED (1). The PCRF shall send a request for P-CSCF Restoration to the PCEF for the corresponding IP-CAN session. + +### 4.4.8 Priority Sharing Request + +If PrioritySharing feature is supported, the AF may include the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component-Description AVP in order to indicate to the PCRF that the related media flow is allowed to use the same Allocation and Retention Priority as media flows which are assigned the same QCI in the PCRF belonging to other AF sessions for the same IP-CAN session that also contain the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED. If the MCPTT-Preemption feature is supported, the AF may also include the Pre-emption-Capability AVP containing the suggested pre-emption capability value and the Pre-emption-Vulnerability AVP containing the suggested pre-emption vulnerability value within the Media-Component-Description AVP for the PCRF to determine ARP values and include the Pre-emption-Control-Info AVP containing the pre-emption control information at the AAR command level for the PCRF to perform pre-emption control. The AF may also include the INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION within Specific-Action AVP to request notification for resource allocation failure. Upon reception of this information, the PCRF shall behave as described in 3GPP TS 29.212 [8], clauses 4.5.27 and 4a.5.17. For the handling of MCPTT sessions, see Annex A.13. + +NOTE 1: Service data flow deactivation procedures will apply according to clause 4.4.6.2. + +NOTE 2: This enhancement avoids the risk that a bearer establishment request is rejected if the maximum number of active bearers is exceeded. + +If the AF earlier has indicated a media flow priority sharing to the PCRF by setting the Priority-Sharing-Indicator AVP to PRIORITY\_SHARING\_ENABLED, the AF may include the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_DISABLED within the Media-Component-Description AVP in order to indicate to the PCRF that the related media flow shall not be part of the mechanism for sharing the Allocation and Retention Priority with other media flows any longer. + +If this media flow was in priority sharing with other media flows the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing priority as described in 3GPP TS 29.212 [8], clauses 4.5.27 and 4a.5.17 and handle the media flow excluded from priority sharing according to normal PCC/QoS rule provisioning procedures described in 3GPP TS 29.212 [8], clauses 4.5.2 and 4a.5.2. + +If the AF earlier has indicated media flow priority sharing to the PCRF by setting the Priority-Sharing-Indicator AVP to PRIORITY\_SHARING\_ENABLED for media flows and the AF indicates to remove one or more of the media flows in priority sharing with other media flows, the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing priority as described in 3GPP TS 29.212 [8], clauses 4.5.27 and 4a.5.17 and handle the media flow removed according to normal PCC/QoS rule provisioning procedures described in 3GPP TS 29.212 [8], clauses 4.5.2 and 4a.5.2. + +If the AF session being terminated corresponds to a session that included the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED within the Media-Component Description AVP, if the related media flow(s) was in priority sharing with other media flows the PCRF should readjust the Allocation and Retention Priority for the remaining services sharing Allocation and Retention Priority as described in 3GPP TS 29.212 [8], clauses 4.5.27 and 4a.5.17 and handle the media flow removed according to normal PCC/QoS rule provisioning procedures described in 3GPP TS 29.212 [8], clauses 4.5.2 and 4a.5.2. + +### 4.4.9 Support for media component versioning + +The support of the media component versioning is optional. When the MediaComponentVersioning feature is supported, the AF and the PCRF shall comply with the procedures specified in this clause. + +If required by operator policies, the AF shall assign a content version to the media component related to certain service and provide the PCRF within the Content-Version AVP as part of the Media-Component-Description AVP. Upon each media component modification, if the content version was assigned to a media component, the AF shall assign a new content version. In this case, all the content related to that media component shall be included. The content version shall be unique for the lifetime of the media component. + +NOTE 1: The AF will include all the content of the media component in each media component modification in order to ensure that the media component is installed with the proper information regardless of the outcome of the bearer procedure related to previous interactions that are not reported to the PCRF yet. + +If the PCRF receives the Content-Version AVP including an content version for certain media component, the PCRF will follow the procedures described in 3GPP TS 29.212 [8], clause 4.5.28 and clause 4a.5.18. + +When the PCRF is notified about the outcome of the resource allocation related to one content version of a media component as described in clause 4.5.28 or clause 4a.5.18 in 3GPP TS 29.212 [8] and if the PCRF is required to notify the AF, the PCRF shall provide the content version of the media component within the Content-Version AVP corresponding to the value of content version of the PCC/QoS rule and the status of the media component within the Media-Component-Status AVP corresponding to the status of the PCC/QoS rule to the AF as part of the Flows AVP. + +The PCRF shall include more than one Content-Version AVPs for the same media component within the Flows AVP in a RAR command if it has received multiple content versions as described in clause 4.5.28 or clause 4a.5.18 in 3GPP TS 29.212 [8]. + +NOTE 2: The AF will use the content version to identify the media component version that failed or succeed when multiple provisions of the same media component occur in a short period of time. How the AF handles such situations is not specified. + +### 4.4.10 Extended bandwidth support for EPC supporting Dual Connectivity (E-UTRAN and 5G NR) + +When the Extended-Max-Requested-BW-NR feature, the Extended-Min-Requested-BW-NR feature, and/or the Extended-BW-E2EQOSMTSI-NR features are supported, extended bandwidth AVPs representing bitrates in kbps shall be used to represent bandwidth values higher than $2^{32}-1$ bps instead of the bandwidth AVPs with a maximum value of $2^{32}-1$ bps that represent bitrates in bps. + +For the Extended-Max-Requested-BW-NR feature: + +- Extended-Max-Requested-BW-DL/UL AVPs shall be used instead of Max-Requested-Bandwidth-DL/UL AVPs. + +For the Extended-BW-E2EQOSMTSI-NR feature: + +- Extended-Max-Supported-BW-DL/UL AVPs shall be used instead of Max-Supported-Bandwidth-DL/UL AVPs. +- Extended-Min-Desired-BW-DL/UL AVPs shall be used instead of Min-Desired-Bandwidth-DL/UL AVPs. + +For the Extended-Min-Requested-BW-NR feature: + +- Extended-Min-Requested-BW-DL/UL AVPs shall be used instead of Min-Requested-Bandwidth-DL/UL AVPs. + +For values lower or equal to $2^{32}-1$ bps AVPs representing bitrates in bps shall be used. + +When the Rx session is being established, if the AF supports the corresponding feature (as listed above) and needs to indicate bandwidth values higher than $2^{32}-1$ bps, AVPs representing bitrate in bps shall be provided with value set to $2^{32}-1$ bps and bandwidth AVPs representing bitrate in kbps shall be provided with the actual required bandwidth. + +NOTE: When the Diameter session is being established, the originator node does not know yet the features supported by the peer node. + +### 4.4.11 MPS for DTS Control + +The support of the MPSforDTS feature is optional. When the MPSforDTS feature is supported as described in clause 5.4.1, the AF and the PCRF shall comply with the procedures specified in this clause. + +MPS for DTS is the means for an AF to invoke/revoke the Priority EPS Bearer Service for the default bearer only, i.e. without designating a particular service data flow for priority service. MPS for DTS applies only to non-IMS APNs. + +To invoke/revoke MPS for DTS, the AF shall include the MPS-Action AVP in the AAR command. The MPS-Action AVP signals a change to the default bearer and IP flows mapped to the default bearer. + +When the MPS-Action AVP is set to ENABLE\_MPS\_FOR\_DTS (1) and included in the AAR command, and if allowed by local policy, the PCRF does not check the user's MPS subscription details and shall upgrade the QoS of the default bearer to MPS, as specified in 3GPP TS 29.212 [8]. + +When the MPS-Action AVP is set to AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS (2) and included in the AAR command, and if allowed by local policy, the PCRF shall check the user's MPS subscription details and if valid, shall upgrade the QoS of the default bearer to MPS, as specified in 3GPP TS 29.212 [8]. If the request is not allowed, the PCRF shall reject the request indicating REQUESTED\_SERVICE\_NOT\_AUTHORIZED. + +When the MPS-Action AVP is set to DISABLE\_MPS\_FOR\_DTS (0) and included in the AAR command, and if allowed by local policy, the PCRF does not check the user's MPS subscription details and shall downgrade the QoS of the default bearer to non-MPS priority, as specified in 3GPP TS 29.212 [8]. + +NOTE: How the AF authorizes the request is out of scope of the present document. + +The AF may also include in the AAR command the Specific-Action AVP with the value SUCCESSFUL\_QOS\_UPDATE to request notification when the PCRF has successfully acted upon the invocation/revocation request indicated in the MPS-Action AVP. The PCRF shall inform the AF of successful MPS for DTS invocation/revocation with a RAR command with the Specific-Action AVP with the value SUCCESSFUL\_QOS\_UPDATE. + +The AF may also include in the AAR command the Specific-Action AVP with the value FAILED\_QOS\_UPDATE to request notification when the invocation/revocation request indicated in the MPS-Action AVP has failed. The PCRF shall inform the AF of the failure of the MPS for DTS invocation/revocation with a RAR command with the Specific-Action AVP with the value FAILED\_QOS\_UPDATE. + +When the PCRF receives from the AF an AA-Request as described in the preceding paragraphs, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9] and shall acknowledge the AAR command by sending an AA-Answer command to the AF. + +The PCRF shall install the event trigger for the MPS for DTS request using the corresponding procedures specified in 3GPP TS 29.212 [8] if the AF requests the notification. + +The AF may use the procedure specified in clause 4.4.12 to establish a priority signalling IP flow between the UE and AF. + +### 4.4.12 Provisioning of MPS for DTS AF Signalling Flow Information + +This clause is applicable when MPS for DTS is supported according to the supported feature MPSforDTS as described in clause 5.4.1. + +An AF may provision information about the AF signalling IP flows between the UE and the AF. To do so, the AF may modify an already open Rx Diameter session related to the AF signalling (e.g. an Rx Diameter session established for the purpose of DTS control as described in clause 4.4.11) or it may open a new Rx Diameter session related to the AF signalling if none exists. + +To provision the AF signalling flow information, the AF shall provide the UE's IP address using either Framed-IP-Address AVP or Framed-Ipv6-Prefix AVP. The AF shall additionally provide the MPS-Identifier AVP and a Media-Component-Description AVP containing a Media-Component-Number AVP set to "0", and including a Media-Sub-Component AVP that contains the Flow-Description AVP set to the AF signalling IP flow. If the AuthorizationForMpsSignalling feature is supported, the AF shall provide the MPS-Action AVP set to value AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_AF\_SIGNALLING (3). The Media-Sub-Component AVP shall include the Flow-Number AVP set according to the rules described in Annex B and the Flow-Usage AVP set to the value "AF\_SIGNALLING" and the Flow-Status AVP set to "ENABLED". + +When the PCRF receives from the AF an AA-Request as described in the preceding paragraph, the PCRF shall determine whether the request is accepted or not. If accepted, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9] and shall acknowledge the AAR command by sending an AA-Answer command to the AF. If rejected, the PCRF shall indicate the cause for the rejection with the Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_NOT\_AUTHORIZED. + +The PCRF shall set appropriate QoS values for the AF signalling IP flow and install the corresponding dynamic PCC rule at the PCEF and the QoS rule at BBERF if applicable. + +The AF may de-provision the information about the AF signalling IP flows at any time. To do that, if the Rx Diameter session is only used to provide information about the AF Signalling IP flows, the AF shall close the Rx Diameter session by sending a Session-Termination-Request (STR) command to the PCRF, which shall be acknowledged with a Session-Termination-Answer (STA) command. Otherwise, the AF shall remove the IP flows within the Media-Sub-Component AVP by supplying the Flow-Status AVP with value "REMOVED". In both cases, the PCRF shall remove the corresponding dynamic PCC and QoS rule if applicable for the AF signalling IP flows. + +NOTE: Combining the request for the AF signalling flow with an MPS for DTS invocation/revocation request is not supported in this release. + +# 5 Rx protocol + +## 5.1 Protocol support + +The Rx interface in the present release is based on Rx and Gq protocols defined for Release 6 as specified in 3GPP TS 29.211 [7] and 3GPP TS 29.209 [5] respectively. However, to be able to separate the policy and charging rules function (PCRF) of the present release from the policy decision function (PDF) and charging rules function (CRF) of Release 6, the Rx application in the present release has an own vendor specific Diameter application. + +The Rx application is defined as an IETF vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Rx application in the present release is 16777236. The vendor identifier assigned by IANA to 3GPP () is 10415. + +NOTE: A route entry can have a different destination based on the application identification AVP of the message. Therefore, Diameter agents (relay, proxy, redirection, translation agents) must be configured appropriately to identify the 3GPP Rx application within the Auth-Application-Id AVP in order to create suitable routing tables. + +The Rx application identification shall be included in the Auth-Application-Id AVP. + +With regard to the Diameter protocol defined over the Rx reference point, the PCRF acts as a Diameter server, in the sense that it is the network element that handles AF session authorization requests for a particular realm. The AF acts as the Diameter client, in the sense that it is the network element requesting the authorization of resources for an AF session. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between each AF and PCRF pair is defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes is described in IETF RFC 6733 [52]. + +After establishing the transport connection, the PCRF and the AF shall advertise the support of the Rx specific Application by including the value of the application identifier in the Auth-Application-Id AVP and the value of the 3GPP (10415) in the Vendor-Id AVP of the Vendor-Specific-Application-Id AVP contained in the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. The Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands are specified in the Diameter Base Protocol (IETF RFC 6733 [52]). + +The termination of the Diameter user session is specified in IETF RFC 6733 [52] in clauses 8.4 and 8.5. The description of how to use of these termination procedures in the normal cases is embedded in the procedures description (clause 4.4). + +## 5.3 Rx specific AVPs + +### 5.3.0 General + +Table 5.3.0.1 describes the Diameter AVPs defined for the Rx interface protocol, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported feature the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +NOTE: Most of these AVPs have already been defined in 3GPP TS 29.209 [5] for Rel-6. Their definition is based on the one used for Rel-6 with some possible modifications to be applied to the Rel-7 protocols. + +**Table 5.3.0.1: Rx specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (Note 2) | AVP Flag rules (Note 1) | | | | | Applicability (Note 3) | +|------------------------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------------| +| | | | | Must | May | Should not | Must not | May Encr. | | +| 5GMM-Cause | 573 | 5.3.70 | Unsigned32 | V | P | | M | Y | RAN-NAS-Cause | +| 5GS-RAN-NAS-Release-Cause | 572 | 5.3.69 | Grouped | V | P | | M | Y | RAN-NAS-Cause | +| 5GSM-Cause | 574 | 5.3.71 | Unsigned32 | V | P | | M | Y | RAN-NAS-Cause | +| Abort-Cause | 500 | 5.3.1 | Enumerated | M,V | P | | | Y | | +| Access-Network-Charging-Address | 501 | 5.3.2 | Address | M,V | P | | | Y | | +| Access-Network-Charging-Identifier | 502 | 5.3.3 | Grouped | M,V | P | | | Y | | +| Access-Network-Charging-Identifier-Value | 503 | 5.3.4 | OctetString | M,V | P | | | Y | | +| Acceptable-Service-Info | 526 | 5.3.24 | Grouped | M,V | P | | | Y | | +| AF-Application-Identifier | 504 | 5.3.5 | OctetString | M,V | P | | | Y | | +| AF-Charging-Identifier | 505 | 5.3.6 | OctetString | M,V | P | | | Y | | +| AF-Requested-Data | 551 | 5.3.50 | Unsigned32 | V | P | | M | Y | | +| AF-Signalling-Protocol | 529 | 5.3.26 | Enumerated | V | P | | M | Y | ProvAFsignalFlow | +| Application-Service-Provider-Identity | 532 | 5.3.29 | UTF8String | V | P | | M | Y | SponsoredConnectivity | +| Callee-Information | 565 | 5.3.62 | Grouped | V | P | | M | Y | VBCLTE | +| Codec-Data | 524 | 5.3.7 | OctetString | M,V | P | | | Y | | +| Content-Version | 552 | 5.3.49 | Unsigned64 | V | P | | M | Y | MediaComponentVersioning | +| Desired-Max-Latency | 567 | 5.3.64 | Float32 | V | P | | M | Y | FLUS
QoSHint | +| Desired-Max-Loss | 568 | 5.3.65 | Float32 | V | P | | M | Y | FLUS
QoSHint | +| Extended-Max-Requested-BW-DL | 554 | 5.3.52 | Unsigned32 | V | P | | M | Y | Extended-Max-Requested-BW-NR | +| Extended-Max-Requested-BW-UL | 555 | 5.3.53 | Unsigned32 | V | P | | M | Y | Extended-Max-Requested-BW-NR | +| Extended-Max-Supported-BW-DL | 556 | 5.3.54 | Unsigned32 | V | P | | M | Y | Extended-BW-E2EQOSMTSI-NR | +| Extended-Max-Supported-BW-UL | 557 | 5.3.55 | Unsigned32 | V | P | | M | Y | Extended-BW-E2EQOSMTSI-NR | +| Extended-Min-Desired-BW-DL | 558 | 5.3.56 | Unsigned32 | V | P | | M | Y | Extended-BW-E2EQOSMTSI-NR | +| Extended-Min-Desired-BW-UL | 559 | 5.3.57 | Unsigned32 | V | P | | M | Y | Extended-BW-E2EQOSMTSI-NR | +| Extended-Min-Requested-BW-DL | 560 | 5.3.58 | Unsigned32 | V | P | | M | Y | Extended-Min-Requested-BW-NR | +| Extended-Min-Requested-BW-UL | 561 | 5.3.59 | Unsigned32 | V | P | | M | Y | Extended-Min-Requested-BW-NR | +| Flow-Description | 507 | 5.3.8 | IPFilterRule | M,V | P | | | Y | | +| Flow-Number | 509 | 5.3.9 | Unsigned32 | M,V | P | | | Y | | +| Flows | 510 | 5.3.10 | Grouped | M,V | P | | | Y | | +| Flow-Status | 511 | 5.3.11 | Enumerated | M,V | P | | | Y | | +| Flow-Usage | 512 | 5.3.12 | Enumerated | M,V | P | | | Y | | +| FLUS-Identifier | 566 | 5.3.63 | OctetString | V | P | | M | Y | FLUS | +| GCS-Identifier | 538 | 5.3.36 | OctetString | V | P | | M | Y | GroupComService | +| GLI-Identifier | 580 | 5.3.77 | OctetString | V | P | | M | Y | NetLoc-Wireline | +| HFC-Node-Identifier | 579 | 5.3.76 | OctetString | V | P | | M | Y | NetLoc-Wireline | +| IMS-Content-Identifier | 563 | 5.3.60 | OctetString | V | P | | | Y | VBC | +| IMS-Content-Type | 564 | 5.3.61 | Enumerated | V | P | | | Y | VBC | +| IP-Domain-Id | 537 | 5.3.35 | OctetString | V | P | | M | Y | | +| Line-Type | 581 | 5.3.78 | Unsigned32 | V | P | | M | Y | NetLoc-Wireline | +| MA-Information | 570 | 5.3.66 | Grouped | V | P | | M | Y | ATSSS | +| MA-Information-Action | 571 | 5.3.67 | Unsigned32 | V | P | | M | Y | ATSSS | +| Max-Requested-Bandwidth-DL | 515 | 5.3.14 | Unsigned32 | M,V | P | | | Y | | +| Max-Requested-Bandwidth-UL | 516 | 5.3.15 | Unsigned32 | M,V | P | | | Y | | + +| | | | | | | | | | | +|--------------------------------------|-----|---------|-------------|-----|---|--|---|---|----------------------------------------| +| Max-Supported-Bandwidth-DL | 543 | 5.3.41 | Unsigned32 | V | P | | M | Y | E2EQOSMTSI | +| Max-Supported-Bandwidth-UL | 544 | 5.3.42 | Unsigned32 | V | P | | M | Y | E2EQOSMTSI | +| MCPPT-Identifier | 547 | 5.3.45 | OctetString | V | P | | M | Y | MCPPT | +| MCVideo-Identifier | 562 | 5.3.45A | OctetString | V | P | | M | Y | MCVideo | +| Media-Component-Description | 517 | 5.3.16 | Grouped | M,V | P | | | Y | | +| Media-Component-Number | 518 | 5.3.17 | Unsigned32 | M,V | P | | | Y | | +| Media-Component-Status | 549 | 5.3.48 | Unsigned32 | V | P | | M | Y | | +| Media-Sub-Component | 519 | 5.3.18 | Grouped | M,V | P | | | Y | | +| Media-Type | 520 | 5.3.19 | Enumerated | M,V | P | | | Y | | +| MPS-Identifier | 528 | 5.3.30 | OctetString | V | P | | M | Y | Rel10 | +| Min-Desired-Bandwidth-DL | 545 | 5.3.43 | Unsigned32 | V | P | | M | | E2EQOSMTSI | +| Min-Desired-Bandwidth-UL | 546 | 5.3.44 | Unsigned32 | V | P | | M | | E2EQOSMTSI | +| Min-Requested-Bandwidth-DL | 534 | 5.3.32 | Unsigned32 | V | P | | M | Y | Rel10 | +| Min-Requested-Bandwidth-UL | 535 | 5.3.33 | Unsigned32 | V | P | | M | Y | Rel10 | +| MPS-Action | 582 | 5.3.79 | Enumerated | V | P | | M | Y | MPSforDTS | +| NGAP-Cause | 575 | 5.3.72 | Grouped | V | P | | M | Y | RAN-NAS-Cause | +| NGAP-Group | 576 | 5.3.73 | Unsigned32 | V | P | | M | Y | RAN-NAS-Cause | +| NGAP-Value | 577 | 5.3.74 | Unsigned32 | V | P | | M | Y | RAN-NAS-Cause | +| NID | 569 | 5.3.68 | OctetString | V | P | | M | Y | | +| Priority-Sharing-Indicator | 550 | 5.3.47 | Enumerated | V | P | | M | Y | PrioritySharing | +| Pre-emption-Control-Info | 553 | 5.3.51 | Unsigned32 | V | P | | M | Y | MCPPT-Preemption | +| Required-Access-Info | 536 | 5.3.34 | Enumerated | V | P | | M | Y | NetLoc | +| Retry-Interval | 541 | 5.3.39 | Unsigned32 | V | P | | M | Y | DeferredService | +| Rx-Request-Type | 533 | 5.3.31 | Enumerated | V | P | | M | Y | | +| RR-Bandwidth | 521 | 5.3.20 | Unsigned32 | M,V | P | | | Y | | +| RS-Bandwidth | 522 | 5.3.21 | Unsigned32 | M,V | P | | | Y | | +| Service-Authorization-Info | 548 | 5.3.46 | Unsigned32 | V | P | | M | Y | | +| Service-URN | 525 | 5.3.23 | OctetString | M,V | P | | | Y | | +| Service-Info-Status | 527 | 5.3.25 | Enumerated | M,V | P | | | Y | | +| Sharing-Key-DL | 539 | 5.3.37 | Unsigned32 | V | P | | M | Y | ResShare | +| Sharing-Key-UL | 540 | 5.3.38 | Unsigned32 | V | P | | M | Y | ResShare | +| Specific-Action | 513 | 5.3.13 | Enumerated | M,V | P | | | Y | | +| SIP-Forking-Indication | 523 | 5.3.22 | Enumerated | M,V | P | | | Y | | +| Sponsor-Identity | 531 | 5.3.28 | UTF8String | V | P | | M | Y | SponsoredConnectivity | +| Sponsored-Connectivity-Data (NOTE 4) | 530 | 5.3.27 | Grouped | V | P | | M | Y | SponsoredConnectivity
SCTimeBasedUM | +| Sponsoring-Action | 542 | 5.3.40 | Enumerated | V | P | | M | Y | SponsorChange | +| Wireline-User-Location-Info | 578 | 5.3.75 | Grouped | V | P | | M | Y | NetLoc-Wireline | + +NOTE 1: The AVP header bit denoted as 'M', indicates whether support of the AVP is required. The AVP header bit denoted as 'V', indicates whether the optional Vendor-ID field is present in the AVP header. For further details, see IETF RFC 6733 [52]. + +NOTE 2: The value types are defined in IETF RFC 6733 [52]. + +NOTE 3: AVPs marked with a supported feature (e.g. "ProvAFsignalFlow", "SponsoredConnectivity", "Rel10" or "NetLoc") are applicable as described in clause 5.4.1 + +NOTE 4: Volume Usage monitoring control functionality is applicable for SponsoredConnectivity supported feature. Time Based Usage monitoring control is applicable for SCTimeBasedUM supported feature. + +### 5.3.1 Abort-Cause AVP + +The Abort-Cause AVP (AVP code 500) is of type Enumerated, and determines the cause of an abort session request (ASR) or of a RAR indicating a bearer release. The following values are defined: + +BEARER\_RELEASED (0) + +This value is used when the bearer has been deactivated as a result from normal signalling handling. For GPRS the bearer refers to the PDP Context. It is also used when all the resource allocation corresponding to an AF session fails. + +#### **INSUFFICIENT\_SERVER\_RESOURCES (1)** + +This value is used to indicate that the server is overloaded and needs to abort the session. + +#### **INSUFFICIENT\_BEARER\_RESOURCES (2)** + +This value is used when the bearer has been deactivated due to insufficient bearer resources at a transport gateway (e.g. GGSN for GPRS). + +#### **PS\_TO\_CS\_HANDOVER (3)** + +This value is used when the PCRF needs to initiate the AF session termination due to PS to CS handover. + +#### **SPONSORED\_DATA\_CONNECTIVITY\_DISALLOWED (4)** + +This value is used in the ASR when the PCRF needs to initiate the AF session termination due to the operator policy (e.g. disallowing the UE accessing the sponsored data connectivity in the roaming case). + +### 5.3.2 Access-Network-Charging-Address AVP + +The Access-Network-Charging-Address AVP (AVP code 501) is of type Address, and it indicates the IP Address of the network entity within the access network performing charging (e.g. the GGSN IP address). The Access-Network-Charging-Address AVP should not be forwarded over an inter-operator interface. + +### 5.3.3 Access-Network-Charging-Identifier AVP + +The Access-Network-Charging-Identifier AVP (AVP code 502) is of type Grouped, and contains a charging identifier (e.g. GCID) within the Access-Network-Charging-Identifier-Value AVP along with information about the flows transported within the corresponding bearer within the Flows AVP. If no Flows AVP is provided, the Access-Network-Charging-Identifier-Value applies for all flows within the AF session. + +The Access-Network-Charging-Identifier AVP can be sent from the PCRF to the AF. The AF may use this information for charging correlation with session layer. + +AVP Format: + +``` +Access-Network-Charging-Identifier ::= < AVP Header: 502 > + { Access-Network-Charging-Identifier-Value } + *[ Flows ] +``` + +### 5.3.4 Access-Network-Charging-Identifier-Value AVP + +The Access-Network-Charging-Identifier-Value AVP (AVP code 503) is of type OctetString, and contains a charging identifier (e.g. GCID). + +### 5.3.5 AF-Application-Identifier AVP + +The AF-Application-identifier AVP (AVP code 504) is of type OctetString, and it contains information that identifies the particular service that the AF service session belongs to. This information may be used by the PCRF to differentiate QoS for different application services. + +For example the AF-Application-Identifier may be used as additional information together with the Media-Type AVP when the QoS class for the bearer authorization at the Gx interface is selected. The AF-Application-Identifier may be used also to complete the QoS authorization with application specific default settings in the PCRF if the AF does not provide full service information. + +The AF-Application-Identifier AVP may also be used to trigger the PCRF to indicate to the PCEF/TDF to perform the application detection based on the operator's policy. + +### 5.3.6 AF-Charging-Identifier AVP + +The AF-Charging-Identifier AVP (AVP code 505) is of type OctetString, contains the AF Charging Identifier that is sent by the AF. This information may be used for charging correlation with bearer layer. + +### 5.3.7 Codec-Data AVP + +The Codec-Data AVP (AVP code 524) is of type OctetString. + +The Codec-Data AVP shall contain codec related information known at the AF. This information shall be encoded as follows: + +- The first line of the value of the Codec-Data AVP shall consist of either the word "uplink" or the word "downlink" (in ASCII, without quotes) followed by a new-line character. The semantics of these words are the following: + - "uplink" indicates that the SDP was received from the UE and sent to the network. + - "downlink" indicates that the SDP was received from the network and sent to the UE. + +NOTE 1: The first line indicates the direction of the source of the SDP used to derive the information. The majority of the information within the Codec-Data AVP indicating "downlink" describes properties, for instance receiver capabilities, of the sender of the SDP, the network in this case and is therefore applicable for IP flows in the uplink direction. Similarly, the majority of the information within the Codec-Data AVP indicating "uplink" describes properties, for instance receiver capabilities, of the sender of the SDP, the UE in this case and is therefore applicable for IP flows in the downlink direction. + +- The second line of the value of the Codec-Data AVP shall consist of either the word "offer" or the word "answer", or the word "description" (in ASCII, without quotes) followed by a new-line character. The semantics of these words are the following: + - "offer" indicates that SDP lines from an SDP offer according to RFC 3264 [18] are being provisioned in the Codec-Data AVP; + - "answer" indicates that SDP lines from an SDP answer according to RFC 3264 [18] are being provisioned in the Codec-Data AVP; + - "description" indicates that SDP lines from a SDP session description in a scenario where the offer-answer mechanism of RFC 3264 [18] is not being applied are being provisioned in the Codec-Data AVP. For instance, SDP from an RTSP "Describe" reply may be provisioned. +- The rest of the value shall consist of SDP line(s) in ASCII encoding separated by new-line characters, as specified in IETF RFC 4566 [13]. The first of these line(s) shall be an "m" line. The remaining lines shall be any available SDP "a" and "b" lines related to that "m" line. However, to avoid duplication of information, the SDP "a=sendrecv", "a=recvonly", "a=sendonly", "a=inactive", "a=bw-info", "b:AS", "b:RS" and "b:RR" lines do not need to be included. + +NOTE 2: For backwards compatibility, it is expected that the codec algorithms in the PCRF described in 3GPP TS 29.213 [9] allow the introduction of new SDP lines without rejecting the request when Codec-Data AVP is provided as part of the Media-Component-Description AVP. The QoS derivation in that case will not take the new SDP line(s) into account. + +### 5.3.8 Flow-Description AVP + +The Flow-Description AVP (AVP code 507) is of type IPFilterRule, and defines a packet filter for an IP flow with the following information: + +- Direction (in or out). The direction "in" refers to uplink IP flows, and the direction "out" refers to downlink IP flows. +- Source and destination IP address (possibly masked). + +- Protocol. +- Source and destination port. + +NOTE 1: When "ip" as key word is used in the protocol, the port(s) are used to describe the port(s) of any protocol if available. + +The IPFilterRule type shall be used over Rx interface with the following restrictions: + +- The Source Port may be omitted to indicate that any source port is allowed. Lists or ranges shall not be used. +- Only the Action "permit" shall be used. +- No "options" shall be used. +- The invert modifier "!" for addresses shall not be used. +- The keyword "assigned" shall not be used. + +NOTE 2: For TCP protocol, destination port can also be omitted. + +If any of these restrictions is not observed by the AF, the server shall send an error response to the AF containing the Experimental-Result-Code AVP with value FILTER\_RESTRICTIONS. + +For the Rx interface, the Flow description AVP shall be used to describe a single IP flow. + +### 5.3.9 Flow-Number AVP + +The Flow-Number AVP (AVP code 509) is of type Unsigned32, and it contains the ordinal number of the IP flow(s), assigned according to the rules in Annex B. + +### 5.3.10 Flows AVP + +The Flows AVP (AVP code 510) is of type Grouped, and it indicates IP flows via their flow identifiers. + +When reporting an out of credit condition, the Final-Unit-Action AVP indicates the termination action applied to the impacted flows. + +If no Flow-Number AVP(s) are supplied, the Flows AVP refers to all Flows matching the media component number. + +When reporting a resource allocation failure related to the modification of session information, the Media-Component-Status AVP may be included to report the status of the PCC/QoS rules related to the media component. + +The Content-Version AVP(s) shall be included if it was included in the Media-Component-Description AVP when the corresponding media component was provisioned. + +AVP Format: + +``` +Flows ::= < AVP Header: 510 > + {Media-Component-Number} + * [Flow-Number] + * [ Content-Version ] + [Final-Unit-Action] + [Media-Component-Status] + * [AVP] +``` + +### 5.3.11 Flow-Status AVP + +The Flow-Status AVP (AVP code 511) is of type Enumerated, and describes whether the IP flow(s) are enabled or disabled. The following values are defined: + +ENABLED-UPLINK (0) + +This value shall be used to enable associated uplink IP flow(s) and to disable associated downlink IP flow(s). + +ENABLED-DOWNLINK (1) + +This value shall be used to enable associated downlink IP flow(s) and to disable associated uplink IP flow(s). + +#### ENABLED (2) + +This value shall be used to enable all associated IP flow(s) in both directions. + +#### DISABLED (3) + +This value shall be used to disable all associated IP flow(s) in both directions. + +#### REMOVED (4) + +This value shall be used to remove all associated IP flow(s). The IP Filters for the associated IP flow(s) shall be removed. The associated IP flows shall not be taken into account when deriving the authorized QoS. + +NOTE 1: The interpretation of values for the RTCP flows in the Rx interface is described within the procedures in clause 4.4.3. + +NOTE 2: The interpretation of values for IMS flows when SIP Forking is supported is described within the procedures in Annex A.3.1. + +### 5.3.12 Flow-Usage AVP + +The Flow-Usage AVP (AVP code 512) is of type Enumerated, and provides information about the usage of IP Flows. The following values are defined: + +#### NO\_INFORMATION (0) + +This value is used to indicate that no information about the usage of the IP flow is being provided. + +#### RTCP (1) + +This value is used to indicate that an IP flow is used to transport RTCP. + +#### AF\_SIGNALLING (2) + +This value is used to indicate that the IP flow is used to transport AF Signalling Protocols (e.g. SIP/SDP). + +NO\_INFORMATION is the default value. + +NOTE: An AF may choose not to identify RTCP flows, e.g. in order to avoid that RTCP flows are always enabled by the server. + +### 5.3.13 Specific-Action AVP + +The Specific-Action AVP (AVP code 513) is of type Enumerated. + +Within a PCRF initiated Re-Authorization Request, the Specific-Action AVP determines the type of the action. + +Within an initial AA request the AF may use the Specific-Action AVP to request any specific actions from the server at the bearer events and to limit the contact to such bearer events where specific action is required. If the Specific-Action AVP is omitted within the initial AA request, no notification of any of the events defined below is requested at this time. + +For one time specific actions, as identified in the value descriptions below, the AF may also provide the Specific-Action AVP with the applicable one-time-specific-action value(s) in subsequent AA-Requests. Non-one-time-specific-action value(s) may only be provided in the initial AA-Request and shall then be applicable for the entire lifetime of the Rx session. + +NOTE 1: One time specific actions are reported once the required action is fulfilled and are not reported again unless the AF sends a new request. + +NOTE 2: Unless otherwise stated in the definition of the specific action value, when the AF requests specific actions in the initial AA-Request, the PCRF reports that action whenever new related information is available during the lifetime of the Rx session. + +NOTE 2a: Whether the PCRF decides to report INDICATION\_OF\_RELEASE\_OF\_BEARER (4) or INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION (9) upon receipt of a bearer failure from the PCEF is left to the implementation. + +The following values are defined: + +Void (0) + +#### CHARGING\_CORRELATION\_EXCHANGE (1) + +Within a RAR, this value shall be used when the server reports the access network charging identifier to the AF. The Access-Network-Charging-Identifier AVP shall be included within the request. In the AAR, this value indicates that the AF requests the server to provide the access network charging identifier to the AF for each authorized flow, when the access network charging identifier becomes known at the PCRF. + +#### INDICATION\_OF\_LOSS\_OF\_BEARER (2) + +Within a RAR, this value shall be used when the server reports a loss of a bearer (in the case of GPRS PDP context bandwidth modification to 0 kbit for GBR bearers) to the AF. The SDFs that are deactivated as a consequence of this loss of bearer shall be provided within the Flows AVP. In the AAR, this value indicates that the AF requests the server to provide a notification at the loss of a bearer. + +#### INDICATION\_OF\_RECOVERY\_OF\_BEARER (3) + +Within a RAR, this value shall be used when the server reports a recovery of a bearer (in the case of 3GPP-GPRS or 3GPP-EPS when PGW interoperates with a Gn/Gp SGSN, PDP context bandwidth modification from 0 kbit to another value for GBR bearers) to the AF. The SDFs that are re-activated as a consequence of the recovery of bearer shall be provided within the Flows AVP. In the AAR, this value indicates that the AF requests the server to provide a notification at the recovery of a bearer. + +#### INDICATION\_OF\_RELEASE\_OF\_BEARER (4) + +Within a RAR, this value shall be used when the server reports the release of a bearer (e.g. PDP context removal for 3GPP-GPRS or bearer/PDP context removal for 3GPP-EPS) to the AF. The SDFs that are deactivated as a consequence of this release of bearer shall be provided within the Flows AVP. In the AAR, this value indicates that the AF requests the server to provide a notification at the removal of a bearer. The content version corresponding to the affected media component may be provided in the Content-Version AVP included within the Flows AVP. + +Void (5) + +#### IP-CAN\_CHANGE (6) + +This value shall be used in RAR command by the PCRF to indicate a change in the IP-CAN type or RAT type (if applicable). When used in an AAR command, this value indicates that the AF is requesting subscription to IP-CAN change and RAT change notification. When used in RAR it indicates that the PCRF generated the request because of an IP-CAN or RAT change. IP-CAN-Type AVP, RAT-Type AVP (if applicable), AN-Trusted AVP (if applicable) and AN-GW-Address AVP (if applicable) shall be provided in the same request with the new/valid value(s). + +If an IP-CAN type or RAT type change is due to IP flow mobility and a subset of the flows within the AF session is affected, the affected service data flows shall be provided in the same request. + +If ATSSS feature is supported, and the PDU session is a MA PDU session, the PCF may include the MA-Information AVP in the RAR command with the additional/released IP-CAN type and RAT type (if applicable), with the new/valid values as described in clause E.4. + +#### INDICATION\_OF\_OUT\_OF\_CREDIT (7) + +Within a RAR, this value shall be used when the PCRF reports to the AF that SDFs have run out of credit, and that the termination action indicated by the corresponding Final-Unit-Action AVP applies (3GPP TS 32.240 [23] and 3GPP TS 32.299 [24]). The SDFs that are impacted as a consequence of the out of credit condition shall be provided within the Flows AVP. In the AAR, this value indicates that the AF requests the PCRF to provide a notification of SDFs for which credit is no longer available. Applicable to functionality introduced with the Rel8 feature as described in clause 5.4.1. + +#### INDICATION\_OF\_SUCCESSFUL\_RESOURCES\_ALLOCATION (8) + +Within a RAR, this value shall be used by the PCRF to indicate that the resources requested for particular service information have been successfully allocated. The SDFs corresponding to the resources successfully allocated shall be provided within the Flows AVP and the content version within the Content-Version AVP as included when the corresponding media component was provisioned. + +In the AAR, this value indicates that the AF requests the PCRF to provide a notification when the resources associated to the corresponding service information have been allocated. + +Applicable to functionality introduced with the Rel8 feature as described in clause 5.4.1. + +NOTE 3: This value applies to applications for which the successful resource allocation notification is required for their operation since subscription to this value impacts the resource allocation signalling overhead towards the PCEF/BBERF. + +#### INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION (9) + +Within a RAR, this value shall be used by the PCRF to indicate that the resources requested for a particular service information cannot be successfully allocated. The SDFs corresponding to the resources that could not be allocated shall be provided within the Flows AVP. In case of session modification failure, the status of the related service information may be reported in the Media-Component-Status AVP included within the Flows AVP and the content version within the Content-Version AVP as included when the corresponding media component was provisioned. + +In the AAR, this value indicates that the AF requests the PCRF to provide a notification when the resources associated to the corresponding service information cannot be allocated. Applicable to functionality introduced with the Rel8 feature as described in clause 5.4.1. + +NOTE 4: This value applies to applications for which the unsuccessful resource allocation notification is required for their operation since subscription to this value impacts the resource allocation signalling overhead towards the PCEF/BBERF. + +#### INDICATION\_OF\_LIMITED\_PCC\_DEPLOYMENT (10) + +Within a RAR, this value shall be used when the PCRF reports the limited PCC deployment (i.e. dynamically allocated resources are not applicable) as specified at Annex K and Annex L in 3GPP TS 23.203 [2] to the AF. In the AAR, this value indicates that the AF requests the PCRF to provide a notification for the limited PCC deployment. Applicable to functionality introduced with the Rel8 feature as described in clause 5.4.1. + +#### USAGE\_REPORT (11) + +In the RA-Request (RAR), this value shall be used by the PCRF to report accumulated usage volume and/or time of usage when the usage threshold provided by the AF has been reached. + +In the AA-Request (AAR), this value indicates that the AF requests PCRF to report accumulated usage volume and /or time of usage when it reaches the threshold. + +Applicable to functionality introduced with the SponsoredConnectivity feature for volume usage reporting and with SCTimeBased UM feature for time usage reporting as described in clause 5.4.1. + +#### ACCESS\_NETWORK\_INFO\_REPORT (12) + +In the RA-Request (RAR), this value shall be used by the PCRF to report access network information (i.e. user location and/or user timezone information) when the PCRF receiving an Access Network Information report corresponding to the AF session from the PCEF/BBERF. + +In the AA-Request (AAR), this value indicates that the AF requests PCRF to report one time access network information when the PCRF receives the first Access Network Information report corresponding to the AF session from the PCEF/BBERF after the AF request for the access network information. The required access information is provided within the Required-Access-Info AVP. Applicable to functionality introduced with the NetLoc feature as described in clause 5.4.1. + +The Specific-Action AVP with this value indicates a one time specific action. + +##### INDICATION\_OF\_RECOVERY\_FROM\_LIMITED\_PCC\_DEPLOYMENT (13) + +Within a RAR, this value shall be used when the PCRF reports the recovery from limited PCC deployment (i.e. the UE moves from the VPLMN to the HPLMN as specified at Annex K in 3GPP TS 23.203 [2]) to the AF. In the AAR, this value indicates that the AF requests the PCRF to provide a notification for the recovery from limited PCC deployment. Applicable to functionality introduced with the Rel8 feature as described in clause 5.4.1. + +NOTE 5: This value is optional and only applicable to the scenario where PCC is deployed in the HPLMN but not in the VPLMN and dynamic policy provisioning only occurs in the home routed roaming cases if no BBERF is employed. + +#### INDICATION\_OF\_ACCESS\_NETWORK\_INFO\_REPORTING\_FAILURE (14) + +In the RAR, this value shall be used when the PCRF reports the access network information reporting failure. When applicable, the NetLoc-Access-Support AVP may be provided as well to indicate the reason for the access network information reporting failure. This specific action does not require to be provisioned by the AF. Applicable to functionality introduced with the NetLoc feature as described in clause 5.4.1. + +#### INDICATION\_OF\_TRANSFER\_POLICY\_EXPIRED (15) + +In the RAR, this value shall be used when the PCRF determines that the transfer policy has expired. This specific action does not require to be provisioned by the AF. + +#### PLMN\_CHANGE (16) + +In the AA-Request (AAR), this value indicates that the AF requests PCRF to report changes of PLMN. In the RA-Request (RAR), this value shall be used by the PCRF to indicate that there was a change of PLMN. 3GPP-SGSN-MCC-MNC AVP shall be provided in the same RAR command with the new value and, if available, the NID AVP. Applicable to functionality introduced with the PLMNInfo feature as described in clause 5.4.1. + +The NID AVP is only applicable in 5GS when the serving network is an SNPN, as described in Annex E. + +#### EPS\_FALLBACK (17) + +In the RA-Request (RAR), this value shall be used to report EPS Fallback for the resources requested for a particular service information (media type voice). + +In the AA-Request (AAR), this value indicates that the AF requests to provide a notification when the access network initiates EPS Fallback for the requested resources associated to service information for voice media type. + +Applicable to functionality introduced with the EPSFallbackReport feature as described in clause 5.4.1. + +This value is only applicable to 5GS as described in Annex E. + +#### INDICATION\_OF\_REALLOCATION\_OF\_CREDIT (18) + +Within a RAR, this value shall be used to report to the AF the SDFs for which credit has been reallocated after the former out of credit indication (3GPP TS 32.240 [23] and 3GPP TS 32.299 [24]). The SDFs that are impacted as a consequence of the reallocation of credit condition shall be provided within the Flows AVP. In the AAR, this value indicates the AF requests to provide a notification of SDFs for which credit has been reallocated after the former out of credit indication. Applicable to functionality introduced with the ReallocationOfCredit feature as described in clause 5.4.1. + +This value is only applicable to 5GS as described in Annex E. + +#### SUCCESSFUL\_QOS\_UPDATE (19) + +Within a RAR, this value shall be used by the PCRF to indicate that the QoS of the default bearer has been successfully updated. + +In the AAR, this value indicates that the AF requests the PCRF to provide a notification when the QoS of the default bearer has been successfully updated. + +Applicable to functionality introduced with the MPSforDTS feature as described in clause 5.4.1. + +##### FAILED\_QOS\_UPDATE (20) + +Within a RAR, this value shall be used by the PCRF to indicate that the QoS of the default bearer has failed to update. + +In the AAR, this value indicates that the AF requests the PCRF to provide a notification when the QoS of the default bearer has failed to update. + +Applicable to functionality introduced with the MPSforDTS feature as described in clause 5.4.1. + +### 5.3.14 Max-Requested-Bandwidth-DL AVP + +The Max-Requested-Bandwidth-DL AVP (AVP code 515) is of type Unsigned32, and it indicates the maximum bandwidth in bits per second for a downlink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the maximum requested bandwidth. When provided in an AA-Answer, it indicates the maximum bandwidth acceptable by PCRF. + +When the Extended-Max-Requested-BW-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Max-Requested-Bandwidth-DL AVP shall be used, see clause 4.4.10 and clause 5.3.52. + +### 5.3.15 Max-Requested-Bandwidth-UL AVP + +The Max -Bandwidth-UL AVP (AVP code 516) is of type Unsigned32, and it indicates the maximum requested bandwidth in bits per second for an uplink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the maximum requested bandwidth. When provided in an AA-Answer, it indicates the maximum bandwidth acceptable by PCRF. + +When the Extended-Max-Requested-BW-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Max-Requested-Bandwidth-UL AVP shall be used, see clause 4.4.10 and clause 5.3.53. + +### 5.3.16 Media-Component-Description AVP + +The Media-Component-Description AVP (AVP code 517) is of type Grouped, and it contains service information for a single media component within an AF session or the AF signalling information. The service information may be based on the SDI exchanged between the AF and the AF session client in the UE. The information may be used by the PCRF to determine authorized QoS and IP flow classifiers for bearer authorization and PCC rule selection. + +Within one Diameter message, a single IP flow shall not be described by more than one Media-Component-Description AVP. + +Bandwidth information and Flow-Status information provided within the Media-Component-Description AVP applies to all those IP flows within the media component, for which no corresponding information is being provided within Media-Sub-Component AVP(s). As defined in 3GPP TS 29.213 [9], the bandwidth information within the media component level Max-Requested-Bandwidth-DL and Max-Requested-Bandwidth-UL AVPs applies separately to each media subcomponent except for RTCP media subcomponent. + +The mapping of bandwidth information for RTCP media subcomponent is defined in 3GPP TS 29.213 [9] clause 6.2. + +If CHEM feature is supported, Max-PLR-DL AVP and Max-PLR-UL AVP information is provided within the Media-Component-Description AVP as defined in 3GPP TS 29.213 [9]. + +If the QoSHint feature is supported the Desired-Max-Latency AVP and/or Desired-Max-Loss AVP may be provided within the Media-Component-Description AVP as defined in 3GPP TS 29.213 [9]. + +If FLUS feature is supported the FLUS-Identifier AVP may be provided within the Media-Component-Description AVP. Additionally, the Desired-Max-Latency AVP and/or the Desired-Max-Loss AVP may be provided as defined in 3GPP TS 29.213 [9]. + +The Max-Requested-Bandwidth-UL, Max-Requested-Bandwidth-DL, Max-Supported-Bandwidth-UL, Max-Supported-Bandwidth-DL, Min-Desired-Bandwidth-UL, Min-Desired-Bandwidth-DL, Min-Requested-Bandwidth-UL and Min-Requested-Bandwidth-DL AVPs only represent bandwidth values up $2^{32}-1$ bps. To represent higher values, the + +Extended-Max-Requested-Bandwidth-UL, Extended-Max-Requested-Bandwidth-DL, Extended-Max-Supported-Bandwidth-UL, Extended-Max-Supported-Bandwidth-DL, Extended-Min-Desired-Bandwidth-UL, Extended-Min-Desired-Bandwidth-DL, Extended-Min-Requested-Bandwidth-UL and Extended-Min-Requested-Bandwidth-DL AVPs may be used as described in clause 4.4.10. + +If a Media-Component-Description AVP is not supplied by the AF, or if optional AVP(s) within a Media-Component-Description AVP are omitted, but corresponding information has been provided in previous Diameter messages, the previous information for the corresponding IP flow(s) remains valid. + +All IP flows within a Media-Component-Description AVP are permanently disabled by supplying a Flow Status AVP with value "REMOVED". The server may delete corresponding filters and state information. + +Reservation-Priority provided within the Media-Component-Description AVP in the request from the AF applies to all those IP flows within the media component and describes the relative importance of the IP flow as compared to other IP flows. The PCRF may use this value to implement priority based admission. If the Reservation-Priority AVP is not specified the IP flow priority is DEFAULT (0). + +Each Media-Component-Description AVP shall contain either zero, or one, or two Codec-Data AVPs. In the case of conflicts, information contained in other AVPs either within this Media-Component-Description AVP, or within the corresponding Media-Component-Description AVP in a previous message, shall take precedence over information within the Codec-Data AVP(s). The AF shall provision all the available information in other applicable AVPs in addition to the information in the Codec-Data AVP, if such other AVPs are specified. + +If the SDP offer-answer procedures of IETF RFC 3264 [18] are applicable for the session negotiation between the two ends taking part in the communication (e.g. for IMS), the following applies: + +- The AF shall provision information derived from an SDP answer and shall also provision information derived from the corresponding SDP offer. +- If the Media-Component-Description AVP contains two Codec-Data AVPs, one of them shall represent an SDP offer and the other one the corresponding SDP answer. +- If the Media-Component-Description AVP contains one Codec-Data AVP, and this AVP represents an SDP offer, the AF shall provision the corresponding SDP answer information in a Codec-Data AVP within a subsequent Rx message. + +NOTE 1: Some SDP parameters for the same codec in the SDP offer and answer are independent of each other and refer to IP flows in opposite directions, for instance some MIME parameters conveyed within "a=fmtp" SDP lines and the packetization time within the "a=ptime" line. Other parameters within the SDP answer take precedence over corresponding parameters within the SDP offer. + +If SDP is applied without using the offer-answer procedures, zero or one Codec-Data AVP shall be provisioned. + +Sharing-Key-DL AVP and/or Sharing-Key-UL AVP provided within the Media-Component-Description AVP indicates that the media components that include the same value of the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP may share resources in the related direction. + +NOTE 2: RTCP traffic is not subject to resource sharing. + +The Content-Version AVP may be included in order to indicate the content version of a media component. + +The Priority-Sharing-Indicator AVP may be included to indicate that the media component can use the same Allocation and Retention Priority as media flows which are assigned the same QCI in the PCRF belonging to other AF sessions for the same IP-CAN session that also contain the Priority-Sharing-Indicator AVP. + +The Pre-emption-Capability AVP and Pre-emption-Vulnerability AVP may be included together with Priority-Sharing-Indicator AVP for PCRF Allocation and Retention Priority decision. + +The PCRF may provide the Media-Component-Description AVP(s) within the Acceptable-Service-Info AVP in the AA-Answer command if the service information received from the AF is rejected. For this usage, the Media-Component-Description AVP shall only include the appropriate Media-Component-Number AVP and the Max-Requested-Bandwidth-UL and/or Max-Requested-Bandwidth-DL AVPs and/ or the Extended-Max-Requested-BW-UL AVP and/or the Extended-Max-Requested-BW-DL AVP (see clause 4.4.10) indicating the maximum acceptable bandwidth. + +AVP format: + +``` +Media-Component-Description ::= < AVP Header: 517 > + { Media-Component-Number } ; Ordinal number of the media comp. + *[ Media-Sub-Component ] ; Set of flows for one flow identifier + [ AF-Application-Identifier ] + [ FLUS-Identifier ] + [ Media-Type ] + [ Max-Requested-Bandwidth-UL ] + [ Max-Requested-Bandwidth-DL ] + [ Max-Supported-Bandwidth-UL ] + [ Max-Supported-Bandwidth-DL ] + [ Min-Desired-Bandwidth-UL ] + [ Min-Desired-Bandwidth-DL ] + [ Min-Requested-Bandwidth-UL ] + [ Min-Requested-Bandwidth-DL ] + [ Extended-Max-Requested-BW-UL ] + [ Extended-Max-Requested-BW-DL ] + [ Extended-Max-Supported-BW-UL ] + [ Extended-Max-Supported-BW-DL ] + [ Extended-Min-Desired-BW-UL ] + [ Extended-Min-Desired-BW-DL ] + [ Extended-Min-Requested-BW-UL ] + [ Extended-Min-Requested-BW-DL ] + [ Flow-Status ] + [ Priority-Sharing-Indicator ] + [ Pre-emption-Capability ] + [ Pre-emption-Vulnerability ] + [ Reservation-Priority ] + [ RS-Bandwidth ] + [ RR-Bandwidth ] + 0*2[ Codec-Data ] + [ Sharing-Key-DL ] + [ Sharing-Key-UL ] + [ Content-Version ] + [ Max-PLR-DL ] + [ Max-PLR-UL ] + [ Desired-Max-Latency ] + [ Desired-Max-Loss ] + *[ AVP ] +``` + +### 5.3.17 Media-Component-Number AVP + +The Media-Component-Number AVP (AVP code 518) is of type Unsigned32, and it contains the ordinal number of the media component, assigned according to the rules in Annex B. + +When this AVP refers to AF signalling, this is indicated by using the value 0 according to the rules in Annex B. + +### 5.3.18 Media-Sub-Component AVP + +The Media-Sub-Component AVP (AVP code 519) is of type Grouped, and it contains the requested bitrate and filters for the set of IP flows identified by their common Flow-Identifier. The Flow-Identifier is defined in Annex B. + +Possible Bandwidth information and Flow-Status information provided within the Media-Sub-Component AVP takes precedence over information within the encapsulating Media Component Description AVP. If a Media-Sub-Component AVP is not supplied, or if optional AVP(s) within a Media-Sub-Component AVP are omitted, but corresponding information has been provided in previous Diameter messages, the previous information for the corresponding IP flow(s) remains valid, unless new information is provided within the encapsulating Media-Component-Description AVP. If Flow-Description AVP(s) are supplied, they replace all previous Flow-Description AVP(s), even if a new Flow-Description AVP has the opposite direction as the previous Flow-Description AVP. The AF may also include the ToS-Traffic-Class AVP for requesting Type of Service or Traffic Class (for IPv4 and IPv6 respectively) based packet filter for the related flow. + +The AF-Signalling-Protocol AVP may be included only if the Flow-Usage AVP has a value of 'AF\_SIGNALLING'. + +All IP flows within a Media-Sub-Component AVP are permanently disabled by supplying a Flow Status AVP with value "REMOVED". The server may delete corresponding filters and state information. + +AVP format: + +``` + +Media-Sub-Component ::= < AVP Header: 519 > + { Flow-Number } ; Ordinal number of the IP flow + 0*2 [ Flow-Description ] ; UL and/or DL + [ Flow-Status ] + [ Flow-Usage ] + [ Max-Requested-Bandwidth-UL ] + [ Max-Requested-Bandwidth-DL ] + [ Extended-Max-Requested-BW-UL ] + [ Extended-Max-Requested-BW-DL ] + [ AF-Signalling-Protocol ] + [ ToS-Traffic-Class ] + *[ AVP ] + +``` + +### 5.3.19 Media-Type AVP + +The Media-Type AVP (AVP code 520) is of type Enumerated, and it determines the media type of a session component. The media types indicate the type of media in the same way as the SDP media types with the same names defined in RFC 4566 [13]. The following values are defined: + +- AUDIO (0) +- VIDEO (1) +- DATA (2) +- APPLICATION (3) +- CONTROL (4) +- TEXT (5) +- MESSAGE (6) +- OTHER (0xFFFFFFFF) + +### 5.3.20 RR-Bandwidth AVP + +The RR-Bandwidth AVP (AVP code 521) is of type Unsigned32, and it indicates the maximum required bandwidth in bits per second for RTCP receiver reports within the session component, as specified in IETF RFC 3556 [11]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. + +### 5.3.21 RS-Bandwidth AVP + +The RS-Bandwidth AVP (AVP code 522) is of type Unsigned32, and it indicates the maximum required bandwidth in bits per second for RTCP sender reports within the session component, as specified in RFC 3556 [11]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. + +### 5.3.22 SIP-Forking-Indication AVP + +The SIP-Forking-Indication AVP (AVP code 523) is of type Enumerated, and describes if several SIP dialogues are related to one Diameter session: + +SINGLE\_DIALOGUE (0) + +This value is used to indicate that the Diameter session relates to a single SIP dialogue. +This is the default value applicable if the AVP is omitted. + +SEVERAL\_DIALOGUES (1) + +This value is used to indicate that the Diameter session relates to several SIP dialogues. + +### 5.3.23 Service-URN AVP + +The Service-URN AVP (AVP code 525) is of type OctetString, and it indicates that an AF session is used for emergency or RLOS traffic. + +It contains values of the service URN and it may include subservices, as defined in [21] for emergency and other well-known services or registered at IANA. The string "urn:service:" in the beginning of the URN shall be omitted in the AVP and all subsequent text shall be included. Examples of valid values of the AVP are "sos", "sos.fire", "sos.police" and "sos.ambulance". + +### 5.3.24 Acceptable-Service-Info AVP + +The Acceptable-Service-Info AVP (AVP code 526) is of type Grouped, and contains the maximum bandwidth for an AF session and/or for specific media components that will be authorized by the PCRF. The Max-Requested-Bandwidth-DL AVP, the Max-Requested-Bandwidth-UL AVP, the Extended-Max-Requested-BW-DL AVP and the Extended-Max-Requested-BW-UL AVP (see clause 4.4.10) directly within the Acceptable-Service-Info AVP indicate the acceptable bandwidth for the entire AF session. The Max-Requested-Bandwidth-DL AVP, Max-Requested-Bandwidth-UL AVP, Extended-Max-Requested-BW-DL AVP and Extended-Max-Requested-BW-UL AVP within a Media-Component-Description AVP included in the Acceptable-Service-Info AVP indicate the acceptable bandwidth for the corresponding media component. + +If the acceptable bandwidth applies to one or more media components, only the Media-Component-Description AVP will be provided. If the acceptable bandwidth applies to the whole AF session, only the Max-Requested-Bandwidth-DL AVP, the Max-Requested-Bandwidth-UL AVP, the Extended-Max-Requested-BW-DL AVP and the Extended-Max-Requested-BW-UL AVP will be included. + +``` +Acceptable-Service-Info ::= < AVP Header: 526 > + *[ Media-Component-Description ] + [ Max-Requested-Bandwidth-DL ] + [ Max-Requested-Bandwidth-UL ] + [ Extended-Max-Requested-BW-DL ] + [ Extended-Max-Requested-BW-UL ] + *[ AVP ] +``` + +### 5.3.25 Service-Info-Status-AVP + +The Service-Info-Status AVP (AVP code 527) is of type Enumerated, and indicates the status of the service information that the AF is providing to the PCRF. If the Service-Info-Status AVP is not provided in the AA request, the value FINAL SERVICE INFORMATION shall be assumed. + +#### FINAL SERVICE INFORMATION (0) + +This value is used to indicate that the service has been fully negotiated between the two ends and service information provided is the result of that negotiation. + +#### PRELIMINARY SERVICE INFORMATION (1) + +This value is used to indicate that the service information that the AF has provided to the PCRF is preliminary and needs to be further negotiated between the two ends (e.g. for IMS when the service information is sent based on the SDP offer). + +### 5.3.26 AF-Signalling-Protocol-AVP + +The AF-Signalling-Protocol AVP (AVP code 529) is of type Enumerated, and indicates the protocol used for signalling between the UE and the AF. If the AF-Signalling-Protocol AVP is not provided in the AA-Request, the value NO\_INFORMATION shall be assumed. + +#### NO\_INFORMATION (0) + +This value is used to indicate that no information about the AF signalling protocol is being provided. + +#### SIP (1) + +This value is used to indicate that the signalling protocol is Session Initiation Protocol. + +### 5.3.27 Sponsored-Connectivity-Data AVP + +The Sponsored-Connectivity-Data AVP (AVP code 530) is of type Grouped, and contains the data associated with the sponsored data connectivity. + +The Sponsor-Identity AVP identifies the sponsor. It shall be included by the AF in the Sponsored-Connectivity-Data AVP except for the case of disabling sponsored data connectivity. + +The Application-Service-Provider-Identity AVP identifies the application service provider. It shall be included by the AF in the Sponsored-Connectivity-Data AVP except for the case of disabling sponsored data connectivity. + +The Granted-Service-Unit AVP shall be used by the AF to provide usage threshold to the PCRF if the volume and/or time of traffic allowed during the sponsored data connectivity is to be monitored. + +The Used-Service-Unit AVP shall be used by the PCRF to provide the measured usage to the AF. Reporting shall be done, as requested by the AF, in CC-Total-Octets, CC-Input-Octets, CC-Output-Octets or CC-Time of the Used-Service-Unit AVP. + +Sponsoring-Action AVP shall be used by the AF to provide the indication to the PCRF if sponsored data connectivity is to be enabled or disabled. + +AVP format: + +``` +Sponsored-Connectivity-Data ::= < AVP Header: 530 > + [ Sponsor-Identity ] + [ Application-Service-Provider-Identity ] + [ Granted-Service-Unit ] + [ Used-Service-Unit ] + [ Sponsoring-Action ] + *[ AVP ] +``` + +### 5.3.28 Sponsor-Identity AVP + +The Sponsor-Identity AVP (AVP code 531) is of type UTF8String and is used for sponsored data connectivity purposes as an identifier of the sponsor. + +### 5.3.29 Application-Service-Provider-Identity AVP + +The Application-Service-Provider-Identity AVP (AVP code 532) is of type UTF8String and is used for sponsored data connectivity purposes as an identifier of the application service provider. + +### 5.3.30 MPS-Identifier AVP + +The MPS-Identifier AVP (AVP code 528) is of type OctetString, and it indicates that an AF session relates to an MPS session. It contains the national variant for MPS service name (e.g., NGN GETS). + +### 5.3.31 Rx-Request-Type AVP + +The Rx-Request-Type AVP (AVP code 533) is of type Enumerated, and contains the reason for sending the AA-Request message. + +The following values are defined: + +INITIAL\_REQUEST (0) + +An initial request is used to initiate an Rx session and contains information that is relevant to initiation. + +UPDATE\_REQUEST (1) + +An update request is used to update an existing Rx session. + +PCSCF\_RESTORATION (2) + +A P-CSCF Restoration is requested. This value is only applicable to the PCSCF-Restoration-Enhancement feature defined in clause 5.4.1. + +### 5.3.32 Min-Requested-Bandwidth-DL AVP + +The Min-Requested-Bandwidth-DL AVP (AVP code 534) is of type Unsigned32, and it indicates the minimum requested bandwidth in bits per second for a downlink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, TCP, UDP, HTTP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the minimum requested bandwidth. + +When the Extended-Min-Requested-BW-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Min-Requested-Bandwidth-DL AVP shall be used, see clause 4.4.10 and clause 5.3.58. + +### 5.3.33 Min-Requested-Bandwidth-UL AVP + +The Min-Requested-Bandwidth-UL AVP (AVP code 535) is of type Unsigned32, and it indicates the minimum requested bandwidth in bits per second for an uplink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, TCP, UDP, HTTP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the minimum requested bandwidth. + +When the Extended-Min-Requested-BW-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Min-Requested-Bandwidth-UL AVP shall be used, see clause 4.4.10 and clause 5.3.59. + +### 5.3.34 Required-Access-Info AVP + +The Required-Access-Info AVP (AVP code 536) is of type Enumerated, and contains the access network information required for that AF session. + +The following values are defined: + +#### USER\_LOCATION (0) + +Indicates that the user location information shall be reported, the PCRF shall report the user location information within the 3GPP-User-Location-Info AVP (if available), the serving network identifier containing PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP (if available) and NID AVP (if available), the user location information within the TWAN-Identifier (if available) , UE-Local-IP-Address AVP (if available) , UDP-Source-Port AVP (if available), TCP-Source-Port AVP (if available) and User-Location-Info-Time AVP (if available). + +The NID AVP is only applicable in 5GS when the serving network is an SNPn, as described in Annex E. + +#### MS\_TIME\_ZONE (1) + +Indicates that the user timezone information shall be reported, the PCRF shall report the user timezone information within the 3GPP-MS-TimeZone AVP. + +### 5.3.35 IP-Domain-Id AVP + +The IP-Domain-Id AVP (AVP code 537) is of type (OctetString), and indicates the domain information which assists session binding. + +### 5.3.36 GCS-Identifier AVP + +The GCS-Identifier AVP (AVP code 538) is of type OctetString, and it indicates that an AF session relates to a Group Communication session that requires prioritization. The values that identify the Group Communication session are not specified. + +### 5.3.37 Sharing-Key-DL AVP + +The Sharing-Key-DL AVP (AVP code 539) is of type Unsigned32 and is used to identify what media components may share resource in the downlink direction. + +The Sharing-Key-DL AVP shall be used as follows: + +- If resource sharing applies between media components across AF sessions for the same user, the same value of the Sharing-Key-DL AVP shall be used; +- If resource sharing does not apply between media components across AF sessions for the same user, a different value of the Sharing-Key-DL AVP shall be used for each media component. + +### 5.3.38 Sharing-Key-UL AVP + +The Sharing-Key-UL AVP (AVP code 540) is of type Unsigned32 and is used to identify what media components may share resource in the uplink direction. + +The Sharing-Key-UL AVP shall be used as follows: + +- If resource sharing applies between media components across AF sessions for the same user, the same value of the Sharing-Key-UL AVP shall be used; +- If resource sharing does not apply between media components across AF sessions for the same user, a different value of the Sharing-Key-UL AVP shall be used for each media component. + +### 5.3.39 Retry-Interval AVP + +The Retry-Interval AVP (AVP code 541) is of type Unsigned32, and it indicates a time interval in seconds to wait until which the AF retries to send the same service information to the PCRF (for the same IP-CAN session) when the service information is temporarily rejected by the PCRF (e.g. due to the detected congestion status of the cell the user is located in). + +### 5.3.40 Sponsoring-Action AVP + +The Sponsoring-Action AVP (AVP code 542) is of type Enumerated, and contains the indication whether to enable or disable/not enable sponsored data connectivity. + +The following values are defined: + +DISABLE\_SPONSORING (0) + +Disable sponsored data connectivity or not enable sponsored data connectivity + +ENABLE\_SPONSORING (1) + +Enable sponsored data connectivity. + +NOTE: The use of value DISABLE\_SPONSORING (0) to "not enable" sponsored data connectivity is used at initial provisioning of session information to provide sponsor information but not enable it at that point in time and to "disable" sponsored data connectivity is used at modification of session information when disabling sponsored data connectivity previously enabled. + +### 5.3.41 Max-Supported-Bandwidth-DL AVP + +The Max-Supported-Bandwidth-DL AVP (AVP code 543) is of type Unsigned32, and it indicates the maximum supported bandwidth in bits per second for a downlink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When the Extended-BW-E2EQOSMTSI-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Max-Supported-Bandwidth-DL AVP shall be used, see clause 4.4.10 and clause 5.3.54. + +### 5.3.42 Max-Supported-Bandwidth-UL AVP + +The Max-Supported-Bandwidth-UL AVP (AVP code 544) is of type Unsigned32, and it indicates the maximum supported bandwidth in bits per second for an uplink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When the Extended-BW-E2EQOSMTSI-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Max-Supported-Bandwidth-UL AVP shall be used, see clause 4.4.10 and clause 5.3.55. + +### 5.3.43 Min-Desired-Bandwidth-DL AVP + +The Min-Desired-Bandwidth-DL AVP (AVP code 545) is of type Unsigned32, and it indicates the minimum desired bandwidth in bits per second for a downlink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When the Extended-BW-E2EQOSMTSI-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Min-Desired-Bandwidth-DL AVP shall be used, see clause 4.4.10 and clause 5.3.56. + +### 5.3.44 Min-Desired-Bandwidth-UL AVP + +The Min-Desired-Bandwidth-DL AVP (AVP code 546) is of type Unsigned32, and it indicates the minimum desired bandwidth in bits per second for an uplink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When the Extended-BW-E2EQOSMTSI-NR feature is supported and the value to be transmitted exceeds $2^{32}-1$ , the Extended-Min-Desired-Bandwidth-UL AVP shall be used, see clause 4.4.10 and clause 5.3.57. + +### 5.3.45 MCPTT-Identifier AVP + +The MCPTT-Identifier AVP (AVP code 547) is of type OctetString, and it includes either one of the namespace values used for MCPTT (see IETF RFC 8101 [45]) and it may include the name of the MCPTT service provider. + +### 5.3.45A MCVideo-Identifier AVP + +The MCVideo-Identifier AVP (AVP code 562) is of type OctetString, and it includes the name of the MCVideo service provider. + +### 5.3.46 Service-Authorization-Info AVP + +The Service-Authorization-Info AVP (AVP code 548) is of type Unsigned32, it shall contain a bit mask and indicate the result of the authorization for the service request from the AF. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table 5.3.46: Service-Authorization-Info** + +| Bit | Name | Description | +|-----|--------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 0 | The transfer policy is known/unknown. | This bit, when set, indicates that the transfer policy is unknown. | +| 1 | The transfer policy has expired/has not expired | This bit, when set, indicates that the transfer policy has expired. | +| 2 | The time window of the transfer policy has occurred/has not yet occurred | This bit, when set, indicates that the time window of the transfer policy has not yet occurred. | + +### 5.3.47 Priority-Sharing-Indicator AVP + +The Priority-Sharing-Indicator AVP (AVP code 550) is of type Enumerated and is used to indicate that the related media component can use the same Allocation and Retention Priority as media component(s) which are assigned the same QCI in the PCRF belonging to other AF sessions for the same IP-CAN session that also contain the Priority-Sharing-Indicator AVP set to PRIORITY\_SHARING\_ENABLED. + +The following values are defined: + +#### **PRIORITY\_SHARING\_ENABLED (0)** + +This value indicates that the related media component is allowed to share the Allocation and Retention Priority with media components belonging to other AF sessions that have also indicated that priority sharing is enabled. + +#### **PRIORITY\_SHARING\_DISABLED (1)** + +This value indicates that the related media component is not allowed to share the Allocation and Retention Priority with media components belonging to other AF sessions. This is the default value applicable if this AVP is not supplied. + +### 5.3.48 Media-Component-Status AVP + +The Media-Component-Status AVP (AVP code 549) is of type Unsigned32, and it describes the status of the PCC/QoS rule(s) related to a media component. + +The following values are defined in this specification: + +#### **0 (ACTIVE):** + +This value shall be used to indicate that the PCC/QoS rule(s) related to certain media component are active. + +##### **1 (INACTIVE):** + +This value shall be used to indicate that the PCC/QoS rule(s) related to certain media component are inactive. This is the default value applicable if this AVP is not supplied. + +**NOTE:** It is assumed that the AF considers the PCC/QoS rule(s) related to the media component(s) for which the Media-Component-Status AVP(s) are not received as inactive when the *Specific-Action AVP* set to **INDICATION\_OF\_FAILED\_RESOURCES\_ALLOCATION (9)** is received. + +### 5.3.49 Content-Version AVP + +The Content-Version AVP (AVP code 552) is of type Unsigned64, and it indicates the version of some content, e.g. of the content of a media component included within the Media-Component-Description AVP. The content version shall be unique for the content and for the lifetime of that content. + +**NOTE:** The method of assigning content versions within the Content-Version AVPs is implementation specific. Example implementations are a monotonically increasing number or a value based on a timestamp. + +### 5.3.50 AF-Requested-Data AVP + +The AF-Requested-Data AVP (AVP code 551) is of type Unsigned32 and indicates the information that the AF requested to be exposed, it shall contain a bit mask. The bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +**Table 5.3.50.1: AF-Requested-Data** + +| Bit | Name | Description | +|-----|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | EPC-level identities required | This bit, when set, indicates that the AF requests the PCRF to provide the EPC-level identities (MSISDN, IMSI, IMEI(SV)) available for that IP-CAN session. | + +### 5.3.51 Pre-emption-Control-Info AVP + +The Pre-emption-Control-Info (AVP code 553) is of type Unsigned32, it shall contain a bit mask and indicate that how the PCRF to perform pre-emption among multiple potential media flow candidates of same priority. Pre-emption-Control-Info AVP is provided at the AAR command level and the latest provided value within the Pre-emption-Control-Info AVP shall be applied to all potential media flow candidates. The bit 0 shall be the least significant bit. For + +example, to get the value of bit 0, a bit mask of 0x0001 should be used. The meaning of the bits shall be as defined below: + +The following values are defined, only one bit shall be set at the same time: + +**Table 5.3.51: Pre-emption-Control-Info** + +| Bit | Name | Description | +|-----|-------------------------|-------------------------------------------------------------------------------------| +| 0 | Most recent added flow | This bit, when set, indicates that the most recent added flow is to be pre-empted. | +| 1 | Least recent added flow | This bit, when set, indicates that the least recent added flow is to be pre-empted. | +| 2 | Highest bandwidth flow | This bit, when set, indicates that the highest bandwidth flow is to be pre-empted. | + +### 5.3.52 Extended-Max-Requested-BW-DL AVP + +The Extended-Max-Requested-BW-DL AVP (AVP code 554) is of type Unsigned32, and it indicates the maximum requested bandwidth in kbit per second for a downlink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the maximum requested bandwidth. When provided in an AA-Answer, it indicates the maximum bandwidth acceptable by PCRF. + +### 5.3.53 Extended-Max-Requested-BW-UL AVP + +The Extended-Max-Requested-BW-UL AVP (AVP code 555) is of type Unsigned32, and it indicates the maximum requested bandwidth in kbit per second for an uplink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the maximum requested bandwidth. When provided in an AA-Answer, it indicates the maximum bandwidth acceptable by PCRF. + +### 5.3.54 Extended-Max-Supported-BW-DL AVP + +The Extended-Max-Supported-BW-DL AVP (AVP code 556) is of type Unsigned32, and it indicates the maximum supported bandwidth in kbit per second for a downlink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +### 5.3.55 Extended-Max-Supported-BW-UL AVP + +The Extended-Max-Supported-BW-UL AVP (AVP code 557) is of type Unsigned32, and it indicates the maximum supported bandwidth in kbit per second for an uplink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +### 5.3.56 Extended-Min-Desired-BW-DL AVP + +The Extended-Min-Desired-BW-DL AVP (AVP code 558) is of type Unsigned32, and it indicates the minimum desired bandwidth in kbit per second for a downlink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +### 5.3.57 Extended-Min-Desired-BW-UL AVP + +The Extended-Min-Desired-BW-UL AVP (AVP code 559) is of type Unsigned32, and it indicates the minimum desired bandwidth in kbit per second for an uplink IP flow as defined in 3GPP TS 26.114 [41]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTP payload. + +### 5.3.58 Extended-Min-Requested-BW-DL AVP + +The Extended-Min-Requested-BW-DL AVP (AVP code 560) is of type Unsigned32, and it indicates the minimum requested bandwidth in kbit per second for a downlink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, TCP, UDP, HTTP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the minimum requested bandwidth. + +### 5.3.59 Extended-Min-Requested-BW-UL AVP + +The Extended-Min-Requested-Bandwidth-UL AVP (AVP code 561) is of type Unsigned32, and it indicates the minimum requested bandwidth in kbit per second for an uplink IP flow. The bandwidth contains all the overhead coming from the IP-layer and the layers above, e.g. IP, TCP, UDP, HTTP, RTP and RTP payload. + +When provided in an AA-Request, it indicates the minimum requested bandwidth. + +### 5.3.60 IMS-Content-Identifier AVP + +The IMS-Content-Identifier AVP (AVP code 563) is of type OctetString, and it contains information that identifies the particular IMS communication service or communication dialogue that the AF service session belongs to. This information may be used by the PCRF, for example, to differentiate Charging for different communication dialogs in the IMS session. + +### 5.3.61 IMS-Content-Type AVP + +The IMS-Content-Type AVP (AVP code 564) is of type Enumerated, and it indicates the type of IMS communication service the AF session refers to. The following values are defined: + +NO\_CONTENT\_DETAIL (0) + +This value is used to indicate that no information about the type of IMS communication service is being provided + +CAT (1) + +This value is used to indicate that the type of IMS communication service is Customized Alerting Tones + +CONFERENCE (2) + +This value is used to indicate that the type of IMS communication service is 3PTY conference + +### 5.3.62 Callee-Information AVP + +The Callee-Information AVP (AVP code 565) is of type Grouped, and it contains information that identifies the callee information of the AF service session. This information may be used by the PCRF, for example, to provide the callee information in the PCC rule decision for further volume based charging. + +AVP Format: + +``` +Callee-Information ::= < AVP Header: 565 > + [Called-Party-Address] + * [Requested-Party-Address] + * [Called-Asserted-Identity] + * [AVP] +``` + +### 5.3.63 FLUS-Identifier AVP + +The FLUS-Identifier AVP (AVP code 566) is of type OctetString, and it indicates that a media component is used for FLUS media. + +It is derived from the media level attribute "a=label:" (see IETF RFC 4574 [68]) obtained from the SDP body. It contains the string after "a=label:" starting with "flus" and may be followed by more characters as described in 3GPP TS 26.238 [69]. + +### 5.3.64 Desired-Max-Latency AVP + +The Desired-Max-Latency AVP (AVP code 567) is of type Float32 and describes the maximum desirable end to end transport level packet latency in milliseconds as a zero-based integer or as a non-zero real value. The value excludes any application level processing in the sender and receivers, such as e.g. application-level retransmission or encoding/decoding. + +### 5.3.65 Desired-Max-Loss AVP + +The Desired-Max-Loss AVP (AVP code 568) is of type Float32 and describes the maximum desirable end to end transport level packet loss rate in percent (without "%" sign) as a zero-based integer or as a non-zero real value. + +### 5.3.66 MA-Information AVP + +The MA-Information AVP (AVP code 570) is of type Grouped, and contains the additional or released IP-CAN type and RAT type for a MA PDU session. + +``` +MA-Information ::= < AVP Header: 570 > + [ IP-CAN-Type ] + [ RAT-Type ] + [ MA-Information-Action ] + *[ AVP ] +``` + +### 5.3.67 MA-Information-Action AVP + +The MA-Information-Action AVP (AVP code 571) is of type Unsigned32, and it indicates the action to apply to the IP-CAN type and RAT type values included in the MA-Information AVP. + +The following values are defined in this specification: + +0 (ADD): + +This value shall be used to indicate that the IP-CAN Type/RAT Type included in the MA-Information AVP are available for the MA PDU session. + +1 (RELEASE): + +This value shall be used to indicate that the IP-CAN Type/RAT Type included in the MA-Information AVP are released and not available for the MA PDU session. + +0 (ADD) is the default value. + +### 5.3.68 NID AVP + +The NID AVP (AVP code 569) is of type OctetString, and it indicates Network Identifier (NID) consisting on 44 bits (11 hexadecimal digits), as specified in 3GPP TS 23.003 [38], clause 12.7. + +The NID AVP is only applicable in 5GS when the serving network is an SNPN, as described in Annex E. + +### 5.3.69 5GS-RAN-NAS-Release-Cause AVP (3GPP-5GS and Non-3GPP-5GS access type) + +The 5GS-RAN-NAS-Release-Cause AVP (AVP code 572) is of type Grouped, and indicates the RAN or NAS release cause code information in 3GPP-5GS and non-3GPP-5GS access types. + +AVP Format: + +``` +5GS-RAN-NAS-Release-Cause ::= < AVP Header: 572 > + [5GMM-Cause] + [5GSM-Cause] + [NGAP-Cause] + *[ AVP ] +``` + +### 5.3.70 5GMM-Cause AVP + +The 5GMM-Cause AVP (AVP code 573) is of type Unsigned32 and indicates the 5GMM cause code information. The AVP shall be coded as per the 5GMM Cause in clause 9.11.3.2 of 3GPP TS 24.501 [70]. + +### 5.3.71 5GSM-Cause AVP + +The 5GSM-Cause AVP (AVP code 574) is of type Unsigned32 and indicates the 5GSM cause code information. The AVP shall be coded as per the 5GSM Cause in clause 9.11.4.2 of 3GPP TS 24.501 [70]. + +### 5.3.72 NGAP-Cause AVP + +The NGAP-Cause AVP (AVP code 575) is of type Grouped and indicates the NG Application Protocol cause value as specified in clause 9.4.5 of 3GPP TS 38.413 [71]. + +AVP Format: + +``` +NGAP-Cause ::= < AVP Header: 575 > + {NGAP-Group} + {NGAP-Value} +``` + +### 5.3.73 NGAP-Group AVP + +The NGAP-Group AVP (AVP code 576) is of type Unsigned32, and it indicates the group of the NGAP cause. The value of this IE shall equal to the ASN.1 value of the specified NGAP cause group + +NGAP supports cause groups defined as separate enumerations, as specified in clause 9.4.5 of 3GPP TS 38.413 [71]. The following values are defined in this specification: + +0: + +This value indicates the NGAP cause group is "radioNetwork". + +1: + +This value indicates the NGAP cause group is "transport". + +2: + +This value indicates the NGAP cause group is "nas". + +3: + +This value indicates the NGAP cause group is "protocol". + +4: + +This value indicates the NGAP cause group is "misc". + +### 5.3.74 NGAP-Value AVP + +The NGAP-Value AVP (AVP code 577) is of type Unsigned32 and indicates the NG AP cause value in specific cause group identified by the NGAP-Group AVP, as specified in clause 9.4.5 of 3GPP TS 38.413 [71]. + +### 5.3.75 Wireline-User-Location-Info AVP + +The Wireline-User-Location-Info AVP (AVP code 578) is of type Grouped and contains either wireline Cable or wireline BBF user location information. + +The HFC-Node-Identifier AVP indicates wireline cable location and contains an HFC Node Identifier. + +The GLI-Identifier AVP indicates wireline BBF location and contains a Global Line Identifier. The Line-Type AVP indicates the type of line included in the GLI-Identifier AVP. + +AVP Format: + +``` +Wireline-User-Location-Info ::= < AVP Header: 578 > + [ HFC-Node-Identifier ] + [ GLI-Identifier ] + [ Line-Type ] + *[ AVP ] +``` + +### 5.3.76 HFC-Node-Identifier AVP + +The HFC-Node-Identifier AVP (AVP code 579) is of type OctetString and contains an HFC Node Identifier as specified in CableLabs WR-TR-5WWC-ARCH [73]. + +### 5.3.77 GLI-Identifier AVP + +The GLI-Identifier AVP (AVP code 580) is of type OctetString and contains a Global Line Identifier (see clause 28.16.3 of 3GPP TS 23.003 [38]) encoded as base64-encoded characters, representing the GLI value (up to 150 bytes) as specified in BBF WT-470 [74]. + +### 5.3.78 Line-Type AVP + +The Line-Type AVP (AVP code 581) is of type Unsigned32 and it indicates the type of wireline (DSL or PON) for the wireline BBF access. + +The following values are defined in this specification: + +0 (DSL): + +This value shall be used to indicate DSL line. + +1 (PON): + +This value shall be used to indicate PON line. + +### 5.3.79 MPS-Action AVP + +The MPS-Action AVP (AVP code 582) is of type Enumerated, and contains the indication whether to enable or disable MPS for DTS. + +The following values are defined: + +DISABLE\_MPS\_FOR\_DTS (0) + +Disable MPS for DTS. + +ENABLE\_MPS\_FOR\_DTS (1) + +Enable MPS for DTS. + +AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS (2) + +The PCRF shall check the user's MPS subscription and enable MPS for DTS. + +AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_AF\_SIGNALLING (3) + +The PCRF shall check the user's MPS subscription and enable MPS for AF signalling. + +## 5.4 Rx re-used AVPs + +### 5.4.0 General + +Table 5.4.0.1 lists the Diameter AVPs re-used by the Rx reference point from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their usage within the Rx reference point. Other AVPs from existing Diameter Applications, except for the AVPs from Diameter Base Protocol, do not need to be supported. The AVPs from Diameter Base Protocol are not included in table 5.4.0.1, but they are re-used for the Rx protocol. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where 3GPP Radius VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [12] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 5.4.0.1: Rx re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | Applicability (notes 1, 2) | +|--------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| 3GPP-MS-TimeZone | 3GPP TS 29.061 [34] | Indicates the offset between universal time and local time in steps of 15 minutes of where the MS currently resides.
This AVP shall have the 'M' bit cleared. | NetLoc
RAN-NAS-Cause | +| 3GPP-SGSN-MCC-MNC | 3GPP TS 29.061 [34] | Indicates the serving core network operator ID. For GPRS accesses the MCC and the MNC of the SGSN.
For EPS 3GPP/non-3GPP accesses, the MCC and the MNC provided by the SGW, ePDG or TWAG.
This AVP shall have the 'M' bit cleared. | NetLoc, RAN-NAS-Cause | +| 3GPP-User-Location-Info | 3GPP TS 29.061 [34] | Indicates details of where the UE is currently located (e.g. SAI or CGI), Coding for type values between 0 and 134 shall be done as defined in 3GPP TS 29.274 [33]. The values 135 and 137 corresponding to "NCGI" and "5GS TAI and NCGI" (which are not applicable in some specification using this AVP) shall be applicable. Coding for these type values shall be done as defined in 3GPP TS 29.061 [34]
This AVP shall have the 'M' bit cleared. | NetLoc
RAN-NAS-Cause | +| AN-GW-Address | 3GPP TS 29.212 [8] | Carries the IP address of the ePDG used as IPSec tunnel endpoint with the UE.
This AVP shall have the 'M' bit cleared. | | +| AN-Trusted | 3GPP TS 29.273 [39] | Indicates whether the access network is trusted or untrusted for the Non-3GPP access network. This AVP shall have the 'M' bit cleared. | | +| Called-Asserted-Identity | 3GPP TS 32.299 [24] | The address (Public User ID: SIP URI, E.164, etc.) of the finally asserted called party. | VBCLTE | +| Called-Party-Address | 3GPP TS 32.299 [24] | The address (SIP URI, Tel URI or URN) of the party to whom the call is addressed. | VBCLTE | +| Called-Station-Id | IETF RFC 4005 [12] | The PDN the user is connected to. For GPRS and EPS the APN. When used to contain the APN, the APN is composed of the APN Network Identifier only, or the APN Network Identifier and the APN Operator Identifier as specified in TS 23.003 [38], clause 9.1. The inclusion of the APN Operator Identifier can be configurable. | Rel8 | +| Calling-Party-Address | 3GPP TS 32.299 [24] | The address (SIP URI or Tel URI) which identifies the party (Public User Identity or Public Service Identity) initiating a SIP transaction.
This information may be used by the PCRF, for example, to provide the caller information in the PCC rule decision for further volume based charging. | VBCLTE | +| DRMP | IETF RFC 7944 [43] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Final-Unit-Action | IETF RFC 8506 [75] | The action applied by the PCEF when the user's account cannot cover the service cost. | Rel8 | +| Framed-IP-Address | IETF RFC 4005 [12] | The valid routable IPv4 address that is applicable for the IP Flows towards the UE at the PCEF. The PCRF shall use this address to identify the correct IP-CAN session (session binding). For example, the IP address may actually be that of the network interface of a NAT device between the UE and the GW. The values 0xFFFFFFFF and 0x00000000 are not applicable as described in RFC 4005 [12]. | | + +| Attribute Name | Reference | Comments | Applicability (notes 1, 2) | +|-------------------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| Framed-Ipv6-Prefix | IETF RFC 4005 [12] | A valid full Ipv6 address that is applicable to an IP flow or IP flows towards the UE at the PCEF. The PCRF shall use this address to identify the correct IP-CAN session (session binding, refer to TS 29.213 [9]). For example, the IP address may actually be that of the network interface of a NAT device between the UE and the GW. The encoding of the value within this Octet String type AVP shall be as defined in RFC 3162 [20], clause 2.3. The "Reserved", "Prefix-Length" and "Prefix" fields shall be included in this order. The AF shall set the "Prefix Length" to 128 and encode the Ipv6 address of the UE within the "Prefix" field. | | +| Granted-Service-Unit (NOTE 3) | IETF RFC 8506 [75] | The volume and/or time thresholds for sponsored data connectivity. Only CC-Total-Octets, one of the CC-Input-Octets and CC-Output-Octets, or CC-Time AVPs are reused. This AVP shall have the 'M' bit cleared. | SponsoredConnectivity, SCTimeBase dUM | +| IP-CAN-Type | 3GPP TS 29.212 [8] | IP-CAN type of the user. | | +| Load | IETF RFC 8583 [51] | The AVP used to convey load information between Diameter nodes. This AVP and all AVPs within this grouped AVP shall have the 'M' bit cleared. | | +| Max-PLR-DL | 3GPP TS 29.212 [8] | indicates ratio of lost packets per number of packets sent in unit of tenth of percent for a downlink voice service data flow. | CHEM | +| Max-PLR-UL | 3GPP TS 29.212 [8] | indicates ratio of lost packets per number of packets sent in unit of tenth of percent for an uplink voice service data flow. | CHEM | +| NetLoc-Access-Support | 3GPP TS 29.212 [8] | Indicates the level of support for NetLoc procedures provided by the current access network. | NetLoc | +| OC-OLR | IETF RFC 7683 [35] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [35] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| Pre-emption-Capability | 3GPP TS 29.212 [8] | Indicates whether a service data flow can get resources that were already assigned to another service data flow with a lower priority level. | MCPTT-Preemption | +| Pre-emption-Vulnerability | 3GPP TS 29.212 [8] | Indicates whether a service data flow can lose the resources assigned to it in order to admit a service data flow with higher priority level. | MCPTT-Preemption | +| RAN-NAS-Release-Cause | 3GPP TS 29.212 [8] | Indicates RAN and/or NAS release cause code information. TWAN release cause code information or untrusted WLAN release cause code information. | RAN-NAS-Cause | +| RAT-Type | 3GPP TS 29.212 [8] | Indicate which Radio Access Technology is currently serving the UE. | Rel8 | +| Requested-Party-Address | 3GPP TS 32.299 [24] | The address (SIP URI, Tel URI or URN) of the party to whom the call was originally addressed. | VBCLTE | +| Reference-Id | 3GPP TS 29.154 [47] | Indicates the transfer policy stored in the SPR. | | +| Reservation-Priority | 3GPP TS 183.017 [15] | The vendor-id shall be set to ETSI (13019) [15]. The support of this AVP shall be advertised in the capabilities exchange mechanisms (CER/CEA) by including the ETSI parameter in the Supported-Vendor-Id AVP. | | +| Subscription-Id | IETF RFC 8506 [75] | The identification of the subscription (IMSI, MSISDN, etc.). | | +| Supported-Features | 3GPP TS 29.229 [25] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange. | Rel8 | + +| Attribute Name | Reference | Comments | Applicability (notes 1, 2) | +|-------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| +| TCP-Source-Port | 3GPP TS 29.212 [8] | Contains the TCP source port number in the case that a NAT and firewall are detected and the IKEv2 messages exchanged between the UE and the ePDG are transported using the firewall traversal tunnel as described in 3GPP TS 24.302 [50]. This AVP shall have the 'M' bit cleared. | NetLoc-Untrusted-WLAN | +| TWAN-Identifier | 3GPP TS 29.061 [34] | Indicates the UE location in a Trusted WLAN or Untrusted WLAN Access Network. This AVP shall have the 'M' bit cleared. | NetLoc-Trusted-WLAN
RAN-NAS-Cause
NetLoc-Untrusted-WLAN | +| ToS-Traffic-Class | 3GPP TS 29.212 [8] | Indicates the DSCP code to be used for packet filter. The first octet contains the DSCP code and the second octet contains the mask field set to 11111100. | DSCP | +| UDP-Source-Port | 3GPP TS 29.212 [8] | Contains the UDP source port number in the case that NAT is detected and the IKEv2 messages exchanged between the UE and the ePDG are encapsulated in the UDP messages according to IETF RFC 3948 [49]. This AVP shall have the 'M' bit cleared. | NetLoc-Untrusted-WLAN | +| UE-Local-IP-Address | 3GPP TS 29.212 [8] | Indicates the local IP address of the UE. This AVP shall have the 'M' bit cleared. | NetLoc-Untrusted-WLAN | +| Used-Service-Unit (NOTE 3) | IETF RFC 8506 [75] | The measured volume and/or time for sponsored data connectivity. Only CC-Total-Octets, one of the CC-Input-Octets and CC-Output-Octets, or CC-Time AVPs are reused. This AVP shall have the 'M' bit cleared. | SponsoredConnectivity
SCTimeBasedUM | +| User-Equipment-Info | IETF RFC 8506 [75] | The identification and capabilities of the terminal (IMEISV, etc.) When the User-Equipment-Info-Type is set to IMEISV(0), the value within the User-Equipment-Info-Value shall be a UTF-8 encoded decimal. | | +| User-Equipment-Info-Extension | IETF RFC 8506 [75] | The identification and capabilities of the terminal (IMEISV, IMEI, etc.) When the User-Equipment-Info-IMEISV or the User-Equipment-Info-IMEI is used, it shall be a UTF-8 encoded decimal. | User-Equipment-Info-Extension | +| User-Location-Info-Time | 3GPP TS 29.212 [8] | Indicates the time the UE was last known to be in the location. | NetLoc
RAN-NAS-Cause | + +NOTE 1: AVPs marked with "Rel8" are applicable as described in clause 5.4.1. +NOTE 2: AVPs marked with "SponsoredConnectivity" are applicable for sponsored data connectivity. +NOTE 3: Volume Usage monitoring control functionality is applicable for SponsoredConnectivity supported feature. Time Based Usage monitoring control is applicable for SCTimeBasedUM supported feature. + +### 5.4.1 Use of the Supported-Features AVP on the Rx reference point + +The Supported-Features AVP is used during session establishment to inform the destination host about the required and optional features that the origin host supports. The client shall, in the first request of a Diameter session indicate the set of supported features. The server shall, in the first answer within the Diameter session indicate the set of features that it has in common with the client and that the server shall support within the same Diameter session. Any further command messages shall always be compliant with the list of supported features indicated in the Supported-Features AVPs during session establishment. Features that are not advertised as supported shall not be used to construct the command messages for that Diameter session. Unless otherwise stated, the use of the Supported-Features AVP on the Rx reference point shall be compliant with the requirements for dynamic discovery of supported features and associated error handling on the Cx reference point as defined in clause 7.2.1 of 3GPP TS 29.229 [25]. + +The base functionality for the Rx reference point is the 3GPP Rel-7 standard and a feature is an extension to that functionality. If the origin host does not support any features beyond the base functionality, the Supported-Features AVP may be absent from the Rx commands. As defined in clause 7.1.1 of 3GPP TS 29.229 [25], when extending the application by adding new AVPs for a feature, the new AVPs shall have the M bit cleared and the AVP shall not be defined mandatory in the command ABNF. + +As defined in 3GPP TS 29.229 [25], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the Rx reference point, the Supported-Features AVP is used to identify features that have been defined by 3GPP and hence, for features defined in this document, the Vendor-Id AVP shall contain the vendor ID of 3GPP (10415). If there are multiple feature lists defined for the Rx reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +On receiving an initial request application message, the destination host shall act as defined in clause 7.2.1 of 3GPP TS 29.229 [25]. The following exceptions apply to the initial and stateless AAR/AAA command pair: + +- If the AF supporting post-Rel-7 Rx functionality is able to interoperate with a PCRF supporting Rel-7, the AAR shall include the features supported by the AF within Supported-Features AVP(s) with the 'M' bit cleared. Otherwise, the AAR shall include the supported features within the Supported-Features AVP(s) with the M-bit set. + +NOTE 1: One instance of Supported-Features AVP is needed per Feature-List-ID. + +- If the AAR command does not contain any Supported-Features AVP(s) and the PCRF supports Rel-7 Rx functionality, the AAA command shall not include the Supported-Features AVP. In this case, both AF and PCRF shall behave as specified in the Rel-7 version of this document. +- If the AAR command contains the Supported-Features AVP(s), the PCRF shall include the Supported-Features AVP(s) in the AAA command, with the 'M' bit cleared, indicating only the features that both the PCRF and AF support. In this case, the PCRF should not use the 'M' bit setting of the Supported-Features AVP(s) to determine if the AAR is accepted or rejected. + +NOTE 2: The client will always declare all features that are supported according to table 5.4.1.1. When more than one feature identifying a release is supported by both AF and PCRF, the AF will work according to the latest common supported release. + +Once the PCRF and AF have negotiated the set of supported features during session establishment, the set of common features shall be used during the lifetime of the Diameter session. + +The table below defines the features applicable to the Rx interfaces for the feature list with a Feature-List-ID of 1. + +**Table 5.4.1.1: Features of Feature-List-ID 1 used in Rx** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Rel8 | M | This feature indicates the support of the base 3GPP Rel-8 functionality, including the AVPs and corresponding procedures supported by the base 3GPP Rel-7 Rx standard, but excluding those features represented by separate feature bits. AVPs introduced with this feature are marked with "Rel8" in Table 5.4.0.1. | +| 1 | Rel9 | M | This feature indicates the support of the base 3GPP Rel-9 functionality, including the AVPs and corresponding procedures supported by the Rel8 feature bit, but excluding those features represented by separate feature bits. | +| 2 | ProvAFsignalFlow | O | This indicates support for the feature of provisioning of AF signalling flow information as described in clause 4.4.5A. If the PCRF supports this feature the AF may provision AF signalling flow information.
NOTE: This feature is used by the IMS Restoration Procedures to provide to the PDN-Gateway the address of the P-CSCF selected by the UE, refer to TS 23.380 [28]. | +| 3 | SponsoredConnectivity | O | This feature indicates support for sponsored data connectivity feature. If the PCRF supports this feature, the AF may provide sponsored data connectivity to the subscriber. | +| 4 | Rel10 | M | This feature indicates the support of the base 3GPP Rel-10 functionality, including the AVPs and corresponding procedures supported by the Rel8 and Rel9 feature bit, but excluding those features represented by separate feature bits. AVPs introduced with this feature are marked with "Rel10" in table 5.3.0.1. | +| 5 | NetLoc | O | This feature indicates the support of the Access Network Information Reporting. | +| 6 | ExtendedFilter | O | This feature indicates the support for the local (i.e. UE) address and mask being present in filters signalled between network and UE. | +| 7 | SCTimeBasedUM | O | This feature indicates support for sponsored data connectivity feature with time-based usage monitoring control required. If the PCRF supports this feature, the AF may provide time threshold for the usage monitoring control. | +| 8 | Netloc-Trusted-WLAN | O | This feature indicates the support for the Trusted WLAN access. It requires that NetLoc feature is also supported. | +| 9 | RAN-NAS-Cause | O | This feature indicates the support for the release cause code information (NOTE 1) from the access network. | +| 10 | GroupComService | O | This feature indicates the support of Group Communication services as described in TS 23.468 [36] for unicast services. | +| 11 | ResShare | O | This feature indicates the support of resource sharing among several AF sessions. | +| 12 | DeferredService | O | This feature indicates the support of deferred transfer of service information from the AF. | +| 13 | DSCP | O | This feature indicates that the AF may provide a DSCP value when describing a service flow by supplying the ToS-Traffic-Class AVP. | +| 14 | SponsorChange | O | This feature indicates that the AF provides information on whether it wants to enable or disable/not enable sponsoring a service. It requires that SponsoredConnectivity is also supported. | +| 15 | E2EQOSMTSI | O | This feature indicates that the AF supports QoS End-to-end MTSI extensions as defined in 3GPP TS 26.114 [41] | +| 16 | NetLoc-Untrusted-WLAN | O | This feature indicates the support of the Untrusted WLAN access as described in 3GPP TS 23.203 [2]. It requires that NetLoc feature is also supported. | +| 17 | MCPTT | O | This feature indicates the support of Mission Critical Push To Talk services as described in 3GPP TS 23.179 [44] | +| 18 | PrioritySharing | O | This feature indicates that Priority Sharing is supported as described in 3GPP TS 23.203 [2], clause 6.1.19. | +| 19 | PLMNInfo | O | This feature indicates that reporting on changes of PLMN info is supported. | +| 20 | MediaComponentVersioning | O | This feature indicates the support of media component versioning as defined in clause 4.4.9. | +| 21 | MCPTT-Preemption | O | This feature indicates the support of service pre-emption based on the information provided by the AF. It requires that both PrioritySharing and MCPTT features are also supported. | +| 22 | MCVideo | O | This feature indicates the support of Mission Critical Video services as described in 3GPP TS 23.281 [61]. | + +Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0". + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS". + +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). + +Description: A clear textual description of the feature. + +NOTE 1: In this release, 5GS and EPS release cause code information is supported. The 3GPP-EPS and Non-3GPP EPS release cause code information from the access network is encoded in the RAN-NAS-Release-Cause AVP and can include RAN/NAS release cause(s), a TWAN release cause or an untrusted WLAN release cause. The 3GPP 5GS and Non-3GPP 5GS release cause code is encoded in the 5GS-RAN-NAS-Release-Cause AVP and is only applicable to Rx interworking with N7 as specified in Annex E. + +**Table 5.4.1.2: Features of Feature-List-ID 2 used in Rx** + +| Feature bit | Feature | M/O | Description | +|-------------|-------------------------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | PCSCF-Restoration-Enhancement | O | This feature indicates support of P-CSCF Restoration Enhancement. It is used for the PCRF and the P-CSCF to indicate if they support P-CSCF Restoration Enhancement. | +| 1 | Extended-Max-Requested-BW-NR | O | This feature indicates the support of the extended Max-Requested-Bandwidth for NR. | +| 2 | Extended-Min-Requested-BW-NR | O | This feature indicates the support of the extended Min-Requested-Bandwidth for NR. It requires that Rel-10 feature is also supported. | +| 3 | Extended-BW-E2EQOSMTSI-NR | O | This feature indicates the support of the extended E2EQOSMTSI bandwidth values for NR. It requires that E2EQOSMTSI feature and the Extended-Max-Requested-BW-NR are also supported. | +| 4 | VBC | O | This feature indicates the support of Volume Based Charging of IMS services as defined in clause A.16. | +| 5 | CHEM | O | This feature indicates the support of Coverage and Handover Enhancements for Media (CHEM) | +| 6 | VBCLTE | O | This feature indicates the support of providing the caller and callee information as defined in clause A.16. | +| 7 | FLUS | O | This feature indicates the support of FLUS functionality as described in 3GPP TS 26.238 [69]. | +| 8 | EPSFallbackReport | O | This feature indicates the support of the report of EPS Fallback as defined in clause E.3. | +| 9 | ATSSS | O | This feature indicates the support of the report of multiple IP-CAN types for a MA PDU session as defined in clause E.4. | +| 10 | QoSHint | O | This feature indicates the support of specific QoS hint parameters as described in 3GPP TS 26.114 [41], clause 6.2.10. | +| 11 | ReallocationOfCredit | O | This feature indicates the support of the report of reallocation of credit. It only applies to 5GS as defined in Annex E. | +| 12 | Netloc-Trusted-N3GA | O | This feature indicates the support for the Trusted N3GA access. It requires that NetLoc-Trusted-WLAN feature is also supported. | +| 13 | NetLoc-Wireline | O | This feature indicates the support for the Wireline access as specified in 3GPP TS 23.316 [72]. It only applies to 5GS as defined in Annex E. It requires that NetLoc feature is also supported. | +| 14 | MPSforDTS | O | This feature indicates the support of MPS for DTS as defined in clauses 4.4.11. and 4.4.12 | +| 15 | User-Equipment-Info-Extension | O | This feature indicates the support of the User-Equipment-Info-Extension AVP as defined in IETF RFC 8506 [75]. | +| 16 | AuthorizationForMpsSignalling | O | This feature indicates support for use of the MPS-Action AVP to signal that the UE's MPS subscription shall be checked by the PCRF prior to enabling MPS for AF signalling. | + +Feature bit: The order number of the bit within the Feature-List AVP where the least significant bit is assigned number "0". + +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "EPS". + +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). + +Description: A clear textual description of the feature. + +## 5.5 Rx specific Experimental-Result-Code AVP values + +### 5.5.1 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request failed, and should not be attempted again. + +IETF RFC 6733 [52] specifies the Experimental-Result AVP containing Vendor-ID AVP and Experimental-Result-Code AVP. The Experimental-Result-Code AVP (AVP Code 298) is of type Unsigned32 and contains a vendor-assigned value representing the result of processing a request. The Vendor-ID AVP shall be set to 3GPP (10415). + +Specific values of the Rx specific Experimental-Result-Code AVP are: + +#### INVALID\_SERVICE\_INFORMATION (5061) + +The PCRF rejects new or modified service information the service information provided by the AF is invalid or insufficient for the server to perform the requested action. + +#### FILTER\_RESTRICTIONS (5062) + +The PCRF rejects new or modified service information because the Flow-Description AVP(s) cannot be handled by the server because restrictions defined in clause 5.3.8 are not observed. + +#### REQUESTED\_SERVICE\_NOT\_AUTHORIZED (5063) + +The PCRF rejects new or modified service information because the requested service, as described by the service information provided by the AF, is not consistent with either the related subscription information, operator defined policy rules and/or the supported features in the IP-CAN network. + +#### DUPLICATED\_AF\_SESSION (5064) + +The PCRF rejects a new Rx session setup because the new Rx session relates to an AF session with another related active Rx session, e.g. if the AF provided the same AF charging identifier for this new Rx session that is already in use for the other ongoing Rx session. + +#### IP-CAN\_SESSION\_NOT\_AVAILABLE (5065) + +The PCRF rejects a new Rx session setup when it fails to associate the described service IP flows within the session information received from the AF to an existing IP-CAN session. + +#### UNAUTHORIZED\_NON\_EMERGENCY\_SESSION (5066) + +The PCRF rejects a new Rx session setup because the session binding function associated a non-Emergency IMS session to an IP-CAN session established to an Emergency APN. + +#### UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY (5067) + +The PCRF rejects a new Rx session setup because the PCRF can't authorize the sponsored data connectivity based on the sponsored data connectivity profile or the operator policy (e.g. the sponsored data connectivity not authorized in the roaming case). + +#### TEMPORARY\_NETWORK\_FAILURE (5068) + +The PCRF rejects new or modified service information because there is a temporary failure in the access network (e.g. the SGW has failed). + +#### UNAUTHORIZED\_NON\_RLOS\_SESSION (5069) + +The PCRF rejects a new Rx session setup because the session binding function associated a non-RLOS IMS session to an IP-CAN session established to an RLOS APN. + +### 5.5.2 Transient Failures + +Errors that fall within the transient failures category are used to inform a peer that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. + +The Result-Code AVP values defined in Diameter Base IETF RFC 6733 [52] are applicable. Also the following specific Rx Experimental-Result-Code value is defined for transient failures: + +REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED (4261) + +The PCRF temporarily rejects new or modified service information because the network is temporarily not able to provide the service delivery that the AF requested, e.g. due to the service information is not consistent with the operator defined policy rules for the congestion status of the user. + +## 5.6 Rx messages + +### 5.6.0 General + +Existing Diameter command codes from the Diameter base protocol IETF RFC 6733 [52] and the NASREQ Diameter application (RFC 4005 [12]) are used with the Rx specific AVPs. An Rx specific Auth-Application id is used together with the command code to identify the Rx messages. + +NOTE 1: The notion of NAS (Network Access Server) is not used here, NASREQ is just used for protocol purposes, not for its functional meaning. + +NOTE 2: Some of the AVPs included in the messages formats below are in bold to highlight that these AVPs are used by this specific protocol and do not belong to the original Diameter Base Protocol IETF RFC 6733 [52]. + +NOTE3: Multiple instances of the Subscription-Id AVP in the AAR or RAR command correspond to multiple types of identifier for the same subscriber, for example IMSI and MSISDN. + +### 5.6.1 AA-Request (AAR) command + +The AAR command, indicated by the Command-Code field set to 265 and the 'R' bit set in the Command Flags field, is sent by an AF to the PCRF in order to provide it with the Session Information. + +Message Format: + +``` + ::= < Diameter Header: 265, REQ, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ IP-Domain-Id ] + [ Auth-Session-State ] + [ AF-Application-Identifier ] + *[ Media-Component-Description ] + [ Service-Info-Status ] + [ AF-Charging-Identifier ] + [ SIP-Forking-Indication ] + *[ Specific-Action ] + *[ Subscription-Id ] + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Reservation-Priority ] + [ Framed-IP-Address ] + [ Framed-Ipv6-Prefix ] + [ Called-Station-Id ] + [ Service-URN ] + [ Sponsored-Connectivity-Data ] + [ MPS-Identifier ] + [ GCS-Identifier ] + [ MCPTT-Identifier ] +``` + +``` + + [ MCVVideo-Identifier ] + [ IMS-Content-Identifier ] + [ IMS-Content-Type ] +* [ Calling-Party-Address ] + [ Callee-Information ] + [ Rx-Request-Type ] +* [ Required-Access-Info ] + [ AF-Requested-Data ] + [ Reference-Id ] + [ Pre-emption-Control-Info ] + [ MPS-Action ] + [ Origin-State-Id ] +* [ Proxy-Info ] +* [ Route-Record ] +* [ AVP ] + +``` + +### 5.6.2 AA-Answer (AAA) command + +The AAA command, indicated by the Command-Code field set to 265 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the AF in response to the AAR command. + +Message Format: + +``` + + ::= < Diameter Header: 265, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Auth-Session-State ] + * [ Access-Network-Charging-Identifier ] + [ Access-Network-Charging-Address ] + [ Acceptable-Service-Info ] + 0*2 [ AN-GW-Address ] + [ AN-Trusted ] + [ Service-Authorization-Info ] + [ IP-CAN-Type ] + [ MA-Information ] + [ NetLoc-Access-Support ] + [ RAT-Type ] + * [ Flows ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Supported-Features ] + * [ Subscription-Id ] + [ User-Equipment-Info ] + [ User-Equipment-Info-Extension ] + [ 3GPP-SGSN-MCC-MNC ] + [ NID ] + * [ Class ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Retry-Interval ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ Load ] + * [ AVP ] + +``` + +### 5.6.3 Re-Auth-Request (RAR) command + +The RAR command, indicated by the Command-Code field set to 258 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the AF in order to indicate an Rx specific action. + +Message Format: + +``` + + ::= < Diameter Header: 258, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + +``` + +``` + + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + *{ Specific-Action } + [ OC-Supported-Features ] + *{ Access-Network-Charging-Identifier } + [ Access-Network-Charging-Address ] + 0*2[ AN-GW-Address ] + [ AN-Trusted ] + *{ Flows } + *{ Subscription-Id } + [ Abort-Cause ] + [ IP-CAN-Type ] + [ MA-Information ] + [ NetLoc-Access-Support ] + [ RAT-Type ] + [ Sponsored-Connectivity-Data ] + [ 3GPP-User-Location-Info ] + [ User-Location-Info-Time ] + [ 3GPP-MS-TimeZone ] + *{ RAN-NAS-Release-Cause } + *{ 5GS-RAN-NAS-Release-Cause } + [ 3GPP-SGSN-MCC-MNC ] + [ NID ] + [ TWAN-Identifier ] + [ TCP-Source-Port ] + [ UDP-Source-Port ] + [ UE-Local-IP-Address ] + [ Wireline-User-Location-Info ] + [ Origin-State-Id ] + *{ Class } + *{ Proxy-Info } + *{ Route-Record } + *{ AVP } + +``` + +### 5.6.4 Re-Auth-Answer (RAA) command + +The RAA command, indicated by the Command-Code field set to 258 and the 'R' bit cleared in the Command Flags field, is sent by the AF to the PCRF in response to the RAR command. + +Message Format: + +``` + + ::= < Diameter Header: 258, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ OC-Supported-Features ] + [ OC-OLR ] + *{ Media-Component-Description } + [ Service-URN ] + [ Origin-State-Id ] + *{ Class } + [ Error-Message ] + [ Error-Reporting-Host ] + *{ Redirect-Host } + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + [ Failed-AVP ] + *{ Proxy-Info } + *{ AVP } + +``` + +### 5.6.5 Session-Termination-Request (STR) command + +The STR command, indicated by the Command-Code field set to 275 and the 'R' bit set in the Command Flags field, is sent by the AF to inform the PCRF that an established session shall be terminated. + +Message Format: + +``` + + ::= < Diameter Header: 275, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + +``` + +``` + + { Destination-Realm } + { Auth-Application-Id } + { Termination-Cause } + [ Destination-Host ] + [ OC-Supported-Features ] + *[ Required-Access-Info ] + *[ Class ] + [ Origin-State-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] + +``` + +### 5.6.6 Session-Termination-Answer (STA) command + +The STA command, indicated by the Command-Code field set to 275 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the AF in response to the STR command. + +Message Format: + +``` + + ::= < Diameter Header: 275, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Failed-AVP ] + [ Sponsored-Connectivity-Data ] + [ Origin-State-Id ] + [ 3GPP-User-Location-Info ] + [ User-Location-Info-Time ] + [ 3GPP-MS-TimeZone ] + *[ RAN-NAS-Release-Cause ] + *[ 5GS-RAN-NAS-Release-Cause ] + [ 3GPP-SGSN-MCC-MNC ] + [ NID ] + [ TWAN-Identifier ] + [ TCP-Source-Port ] + [ UDP-Source-Port ] + [ UE-Local-IP-Address ] + [ Netloc-Access-Support ] + [ Wireline-User-Location-Info ] + *[ Class ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Load ] + *[ AVP ] + +``` + +### 5.6.7 Abort-Session-Request (ASR) command + +The ASR command, indicated by the Command-Code field set to 274 and the 'R' bit set in the Command Flags field, is sent by the PCRF to inform the AF that bearer for the established session is no longer available. + +Message Format: + +``` + + ::= < Diameter Header: 274, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ OC-Supported-Features ] + { Abort-Cause } + [ Origin-State-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] + +``` + +### 5.6.8 Abort-Session-Answer (ASA) command + +The ASA command, indicated by the Command-Code field set to 274 and the 'R' bit cleared in the Command Flags field, is sent by the AF to the PCRF in response to the ASR command. + +Message Format: + +``` + ::= < Diameter Header: 274, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Origin-State-Id ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ AVP ] +``` + +# Annex A (normative): IMS Related P-CSCF Procedures over Rx + +## A.1 Provision of Service Information at P-CSCF + +The P-CSCF shall send service information to the PCRF upon every SIP message that includes an SDP answer payload for the purpose of authorizing the IP flows and the QoS resources required for a negotiated IMS session, unless the SDP payload only relates to a circuit-switched bearer (i.e. "c=" line set to "PSTN" and an "m=" line set to "PSTN", refer to 3GPP TS 24.292 [26]). The service information shall be derived both from the SDP offer and the SDP answer. This ensures that the PCRF receives proper information to perform media authorization for all possible IMS session set-up scenarios, and that the PCRF is also capable of handling session modifications. The P-CSCF may include the Service-Info-Status AVP with the value set to FINAL\_SERVICE\_INFORMATION. + +Additionally, the P-CSCF may send service information to the PCRF when receiving a SIP message that includes an SDP offer payload for the purpose of performing an early bandwidth authorization check, or for enabling pre-authorization for a UE terminated IMS session establishment or modification with UE initiated resource reservation, or for the retrieval of network provided access network information (see clause A.10.2). The P-CSCF shall send service information to the PCRF when receiving a SIP message that includes an SDP offer payload when the IMS session is an MPS session that requires priority treatment. For a UE terminated session the P-CSCF may send the service information derived from the SDP offer when the SDP offer either does not include any preconditions information or includes preconditions information indicating that the local preconditions (i.e. the preconditions related to the remote peer) are already met. In this case, the P-CSCF shall derive the service information only from the SDP offer and shall include the Service-Info-Status AVP with the value set to PRELIMINARY SERVICE INFORMATION. + +NOTE 1: For a UE terminated session setup, when the SDP offer either does not include any preconditions information or includes preconditions information indicating that the local preconditions (i.e. the preconditions related to the remote peer) are already met, the terminating UE can request a resource modification prior to sending the SDP answer. Even if the IP address and port information in the session information derived from the SDP offer can be insufficient for PCC rule authorization, the policy to handle such UE initiated requests at the PCRF can take into account the fact that an IMS session establishment is ongoing, for instance in deciding whether to authorize the request and in selecting an appropriate charging key and a gating policy. + +The P-CSCF shall derive Flow-Description AVP within the service information from the SDP as follows: + +- An uplink Flow-Description AVP shall be formed as follows: The destination address shall be taken from the SDP information received by the P-CSCF in downlink direction, while the source IP address may be formed from the address present in the SDP received by the P-CSCF in uplink direction (taking into account only the 64 bit prefix of the Ipv6 address) Source and destination ports shall be derived according to rules provided in 3GPP TS 29.213 [9] clause 6.2. + +EXAMPLE 1: Assuming UE A sends an SDP to UE B, the PCRF of UE B uses the address present in this SDP for the destination address of UE B's uplink Flow-Description AVP, while the PCRF of the UE A uses the 64 bit prefix of the same address for the source address of UE A's uplink Flow-Description AVP. If the source address is not formed from the 64 bit prefix, the source address shall be wildcarded. + +- A downlink Flow-Description AVP shall be formed as follows: The destination address shall be taken from the SDP information received by the P-CSCF in uplink direction, while the source IP address may be formed (in order to reduce the possibilities of bearer misuse) from the destination address in the SDP received by the P-CSCF in downlink direction (taking into account only the 64 bit prefix of the Ipv6 address) Source and destination ports shall be derived according to rules provided in 3GPP TS 29.213 [9] clause 6.2. + +EXAMPLE 2: Assuming UE A sends an SDP to UE B, the PCRF of UE A uses the address present in this SDP for the destination address of UE A's downlink Flow-Description AVP, while the PCRF of UE B uses the 64 bit prefix of the same address for the source address of UE B's downlink Flow-Description AVP. If the source address is not formed from the 64 bit prefix, the source address shall be wildcarded. + +The P-CSCF shall derive the bandwidth information within the service information, from the "b=AS" SDP parameter and "a=bw-info" SDP parameter, if available and if the E2EMTSIQOS feature is supported. If "a=bw-info" is used for bandwidth derivation, the P-CSCF shall use the SDP attribute line that contains the bandwidth properties for the IP version used by the UE, as detailed in 3GPP TS 29.213 [9] clause 6.2. If the received "a=bw-info" SDP attribute line(s) contain only bandwidth properties for an IP version that is not used by the UE, the P-CSCF shall re-compute the bandwidth properties for the used IP version and use that value for the bandwidth derivation as defined in 3GPP TS 26.114 [41]. + +NOTE 2: If no IP version is included for any of the "a=bw-info" SDP attribute lines related to a certain payload type and direction then IPv6 is assumed for all bandwidth properties related to the same direction and payload type, on all of the related "a=bw-info" SDP attribute lines, see clause 19 of 3GPP TS 26.114 [41]. + +If "a=bw-info" is used for bandwidth derivation and it includes both known and unknown bandwidth properties, the P-CSCF shall only consider the known bandwidth properties to derive the bandwidth information and ignore the unknown ones. If the "a=bw-info" line is received with an unknown directionality, then the entire "a=bw-info" line shall be ignored. + +For the possibly associated RTCP IP flows, the P-CSCF shall use the SDP "b=RR" and "b=RS" parameters, if present, as specified in 3GPP TS 29.213 [9] clause 6.2. The "b=AS", "b=RR" and "b=RS" parameters in the SDP contain all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTCP payload, or IP, UDP and RTCP. + +For multiplexed RTP/RTCP flows (as negotiated using the "a=rtcp-mux" SDP attribute defined in IETF RFC 5761 [42], a P-CSCF supporting RTP/RTCP transport multiplexing shall derive the bandwidth information within the service information as specified in 3GPP TS 29.213 [9] clause 6.2. + +However, if service information is received containing the "b=TIAS" SDP parameter that corresponds to an SDP answer payload, and if the P-CSCF supports this parameter, the P-CSCF may derive the bandwidth from this parameter rather than from the "b=AS" SDP parameter, as detailed in 3GPP TS 29.213 [9] clause 6.2. + +When available, the P-CSCF shall also indicate to PCRF, as a complement to the Service Information, the IMS Communication Service Identifier within the AF-Application-Identifier AVP. The originating P-CSCF shall take the IMS Communication Service Identifier value from the SIP response. The terminating P-CSCF shall take the IMS Communication Service Identifier value from the SIP request. Otherwise, the P-CSCF may not be able to provide an IMS Communication Service Identifier value to the PCRF. The format and specific headers where IMS communication service identifiers are transported within SIP are defined in 3GPP TS 24.229 [17]. + +NOTE 3: In order to indicate the IMS Communication Service Identifier to the PCRF, the originating P-CSCF sets the AF-Application-Identifier AVP to the ICSI contained in the topmost occurrence of the "+g.3gpp.icsi-ref" header field parameter of the Feature-Caps header field(s) of 18x or 2xx SIP response (Feature-Caps: \*;+g.3gpp.icsi-ref="urn%Aurn-7%A3gpp-service.ims.icsi.mmtel") and the terminating P-CSCF sets the AF-Application-Identifier AVP to the ICSI of the P-Asserted-Service header information received in the SIP request (e.g. P-Asserted-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel). Since the headers and the format of the ICSI can vary depending on the case, the PCRF has to be prepared to accept the complete ICSI information received in different formats, as described in clause 7.2A.8.2 in 3GPP TS 24.229 [17]. + +Additionally, the P-CSCF may include the Sharing-Key-DL AVP and/or Sharing-Key-UL AVP within the Media-Component-Description AVP in order to indicate the PCRF that resource sharing should apply for the media components in the related direction with the same value for the Sharing-Key-DL AVP and/or Sharing-Key-UL AVP. + +Additionally, if PrioritySharing feature is supported, the P-CSCF may provide the Priority-Sharing-Indicator AVP within the Media-Component-Description AVP as described in clause 4.4.47. + +NOTE 4: The P-CSCF obtains this information from the Application Server as described in 3GPP TS 23.228 [16], clause 5.4.7.9. + +NOTE 5: RTCP flows are not subject to resource sharing. This requirement cannot be met for multiplexed RTP/RTCP flows as in this case there is no mechanism in the current release to distinguish between RTP and RTCP flows. + +If the Service-URN AVP does not include an emergency service URN, i.e. a top-level service type of "sos" as specified in IETF RFC 5031 [21] and possibly additional sub-service information on the type of the emergency service and the PCRF binds the IMS service session to an IP-CAN session established to an Emergency APN, the PCRF shall return an AAA command with Experimental-Result-Code AVP set to the value UNAUTHORIZED\_NON\_EMERGENCY\_SESSION to the P-CSCF. Upon receiving an AAA with Experimental-Result-Code AVP set to the value UNAUTHORIZED\_NON\_EMERGENCY\_SESSION the P-CSCF shall apply the procedures defined in 3GPP TS 24.229 [17]. + +NOTE 6: The PCRF determines whether an IP-CAN session is established to an Emergency APN based on the information received over Gx and operator configuration. + +If the AF-Requested-Data AVP is provided in the AA-Request command indicating "EPC-level Identities required", the PCRF shall provide the available user information for the IP-CAN session within the Subscription-Id AVP(s) and/or User-Equipment-Info AVP or User-Equipment-Info-Extension AVP if the User-Equipment-Info-Extension feature is supported. + +The PCRF may decide not to authorize requested service information. The PCRF will indicate it to the P-CSCF by sending an AA-Answer with Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_NOT\_AUTHORIZED. Upon receiving an AA-Answer with Experimental-Result-Code AVP set to the value REQUESTED\_SERVICE\_NOT\_AUTHORIZED the P-CSCF shall apply the procedures defined in 3GPP TS 24.229 [17]. + +## --- A.2 Enabling of IP Flows + +### A.2.0 General + +Prior to the completion of the SIP session set-up, i.e. until the 2xx response to the INVITE request is received, the P-CSCF may enable or disable media IP flows depending on operator policy, thus allowing or forbidding early media in forward and/or backward direction. The P-CSCF may set the values of the Flow-Status AVPs derived from the SDP direction attributes as defined in 3GPP TS 29.213 [9] clause 6.2 or set the values of the Flow-Status AVPs considering the em-param of the P-Early-Media header field according to clause A.2.1 or downgrade the values of the Flow-Status AVPs derived from the SDP direction attribute based on the configuration in the P-CSCF according to clause A.2.2. However for multiplexed RTP/RTCP flows (as negotiated using the "a=rtcp-mux" SDP attribute defined in IETF RFC 5761 [42]), a P-CSCF supporting RTP/RTCP transport multiplexing shall set the Flow-Status set to "ENABLED" to prevent that RTCP is blocked. If the P-CSCF chooses to modify the values of the Flow-Status AVPs as received from the SDP direction attribute, the P-CSCF shall store the last received SDP. + +When a 2xx response is received, the P-CSCF shall enable all media IP flows according to the direction attribute within the last received SDP, as specified in 3GPP TS 29.213 [9] clause 6.2. When a 2xx response is received and the P-CSCF previously provided the values of the Flow-Status AVPs different from the value derived from the SDP direction attribute in the session information, the P-CSCF shall provide service information with values of the Flow-Status AVPs corresponding to the last received SDP. + +NOTE: In most cases a 2xx response is a 200 (OK) response. + +If the P-CSCF receives SDP answers after the completion of the SIP session set-up, i.e. after the 2xx response to the INVITE request is received, the P-CSCF shall provide the Flow-Status AVP, based on the last received SDP answer. The Flow-Status AVP shall be derived from the SDP according to 3GPP TS 29.213 [9] clause 6.2. + +#### A.2.1 Gate control procedures considering the P-Early-Media header field + +Prior to the completion of the SIP session set-up, the P-CSCF may use the em-param of the P-Early-Media header field defined in IETF RFC 5009 [48] in order to enable or disable early media in forward and/or backward direction. If the P-CSCF uses the em-param of the P-Early-Media header field for the gate control of early media, the P-CSCF shall perform the following procedures. + +In the terminating P-CSCF, when a SIP message with the P-Early-Media header field is received from the UE and the policies configured in the P-CSCF indicate that the UE is authorized to send early media, then: + +- 1) the P-CSCF shall set the Flow-Status AVP to "ENABLED" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "sendrecv" or no SDP direction attribute has been received; or +- 2) the P-CSCF shall set the Flow-Status AVP to "ENABLED-UPLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "sendonly"; or + - the received em-param(s) in the P-Early-Media header field includes "sendonly" and the last received SDP direction attribute from the UE is "sendrecv" or "sendonly" or no SDP direction attribute has been received; or +- 3) the P-CSCF shall set the Flow-Status AVP to "ENABLED-DOWNLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "recvonly"; or + - the received em-param(s) in the P-Early-Media header field includes "recvonly" and the last received SDP direction attribute from the UE is "sendrecv" or "recvonly" or no SDP direction attribute has been received; or +- 4) the P-CSCF shall set the Flow-Status AVP to "DISABLED" if either the received em-param(s) in the P-Early-Media header field or the last received SDP direction attribute from the UE includes "inactive"; or +- 5) the P-CSCF may set the Flow-Status AVP to "DISABLED" or apply the rules defined in clause A.2.2 if the received em-param(s) in the P-Early-Media header field includes "sendonly" or "recvonly" and the last received SDP direction attribute from the UE is "recvonly" or "sendonly" respectively. + +NOTE 1: If the UE is authorized to send early media, the P-CSCF will not remove or modify the P-Early-Media header field according to 3GPP TS 24.229 [17]. + +When a SIP message with the P-Early-Media header field is received from the functional entity within the trust domain, and if: + +- the P-Early-Media header field includes the "gated" parameter, then the P-CSCF may decide not to perform the gate control of early media; or +- the P-Early-Media header field does not include the "gated" parameter, then the P-CSCF shall perform the following procedures: + - 1) the P-CSCF shall set the Flow-Status AVP to "ENABLED" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "sendrecv" or no SDP direction attribute has been received; or + - 2) the P-CSCF shall set the Flow-Status AVP to "ENABLED-DOWNLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "sendonly"; or + +- the received em-param(s) in the P-Early-Media header field includes "sendonly" and the last received SDP direction attribute from the functional entity is "sendrecv" or "sendonly" or no SDP direction parameter has been received; or +- 3) the P-CSCF shall set the Flow-Status AVP to "ENABLED-UPLINK" if: +- the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "recvonly"; or + - the received em-param(s) in the P-Early-Media header field includes "recvonly" and the last received SDP direction attribute from the functional entity is "sendrecv" or "recvonly" or no SDP direction parameter has been received ; or +- 4) the P-CSCF shall set the Flow-Status AVP to "DISABLED" if either the received em-param(s) in the P-Early-Media header field or the last received SDP direction attribute from the functional entity includes "inactive"; or +- 5) the P-CSCF may set the Flow-Status AVP to "DISABLED" or apply the rules defined in clause A.2.2 if the received em-param(s) in the P-Early-Media header field includes "sendonly" or "recvonly" and the last received SDP direction attribute from the functional entity is "recvonly" or "sendonly" respectively. + +NOTE 2: According to IETF RFC 5009 [48], the non-direction parameter "gated" can be included after the direction parameter (e.g. "sendrecv") in the parameter list. The proxy performing gating of early media can add the parameter before forwarding the SIP message. + +When a SIP message without the P-Early-Media header field is received from either the functional entity within the trust domain or the UE that is authorized to send early media, then the P-CSCF may set the Flow-Status AVP to "DISABLED" or apply the rules defined in clause A.2.2 or apply the rules defined in 3GPP TS 29.213 [9] clause 6.2. + +NOTE 3: As indicated in IETF RFC 5009 [48] the applicable preconditions need to be met in order to allow early media in a particular direction. + +When a SIP message is received from the functional entity other than the functional entity within the trust domain or the UE that is authorized to send early media, then the P-CSCF shall not use the received em-param(s) in the P-Early-Media header field and may apply the rules defined in clause A.2.2 or apply the rules defined in 3GPP TS 29.213 [9] clause 6.2. + +NOTE 4: The P-CSCF will remove or modify the P-Early-Media header field in the above case. + +#### A.2.2 Gate control procedures based on the configuration in the P-CSCF + +Prior to the completion of the SIP session set-up, the P-CSCF may downgrade the values of the Flow-Status AVPs derived from the SDP direction attributes based on the configuration in the P-CSCF. If the P-CSCF has the configuration for the gate control of early media, the P-CSCF shall perform the following procedures. + +NOTE: The gate control of early media can be configured in the P-CSCF per UE basis. + +When the Flow-Status AVP derived from the SDP direction attribute is "ENABLED", then the P-CSCF may downgrade the value of the Flow-Status AVP to the value "DISABLED", "ENABLED\_UPLINK", or "ENABLED\_DOWNLINK" based on the configuration in the P-CSCF. + +When the Flow-Status AVP derived from the SDP direction attribute is "ENABLED\_UPLINK" or "ENABLED\_DOWNLINK", then the P-CSCF may downgrade the value of the Flow-Status AVP to the value "DISABLED" based on the configuration in the P-CSCF. + +## A.3 Support for SIP forking + +### A.3.0 General + +The P-CSCF shall be able to handle forking when PCC is applied. Forking can occur as specified in 3GPP TS 23.228 [16]. The related UE procedures are described in 3GPP TS 24.229 [17]. + +#### A.3.1 PCC rule provisioning for early media for forked responses + +When a SIP session has been originated by a connected UE, the P-CSCF may receive multiple provisional responses due to forking before the first final answer is received. Multiple early media session may be established during this process. + +The UE and the P-CSCF become aware of the forking only when a subsequent provisional response arrives for a new early dialogue. After the first early media session is established, for each subsequent provisional response establishing an additional early media session,, the P-CSCF shall use an AA request within the existing Diameter session containing the SIP-Forking-Indication AVP with value SEVERAL\_DIALOGUES and include the service information derived from the latest provisional response. + +The P-CSCF shall also provision the service information derived from any subsequent SDP offer-answer exchange within an early dialogue (e.g. in PRACK and OK(PRACK), or UPDATE and OK(UPDATE) ) using an AA request within the existing Diameter session containing the SIP-Forking-Indication AVP with value SEVERAL\_DIALOGUES and the derived service information. + +When receiving an AA request containing the SIP-Forking-Indication AVP with value SEVERAL\_DIALOGUES, the PCRF shall identify the existing authorization information for that AF session. The PCRF shall send additional PCC Rules or individual service data flow filters to already provide PCC rules as required by the Flow Description AVPs within the session information to the PCEF. The PCRF shall authorize any additional media components and any increased QoS requirements for the previously authorized media components, as requested within the service information. The PCRF shall authorize the maximum bandwidth required by any of the dialogues, but not the sum of the bandwidths required by all dialogues. Thus, the QoS authorized for a media component is equal to the highest QoS requested for that media component by any of the forked responses. The PCRF shall open or close the gates for service flows depending on the flow status that is being provisioned. However, if a flow ID has been enabled in uplink or downlink direction or both way within previous service information, it shall remain enabled even if the PCRF receives service information that disable this flow ID within an AA request containing the SIP-Forking-Indication AVP with value SEVERAL\_DIALOGUES. + +If the P-CSCF provides one or more Media-Component-Description AVP with the Flow-Status AVP set to "REMOVED" for previously authorized media component(s) the media component shall remain as authorized and the PCRF shall not take any action on that media component(s). + +**NOTE:** There can be cases where a forked response could not support some of the media components included in the SDP Offer (e.g. when early session disposition SDP as described in Annex A.7 applies, the forked response related to the early session could include the port set to zero for those media components not related to the early session or when a subsequent SDP Offer-Answer to indicate that some media is disabled). For those cases the P-CSCF will indicate the PCRF about the removal of the corresponding media component. However this media component is already supported by other UEs and the PCRF needs to maintain the corresponding PCC rules until the final SDP answer is received in the P-CSCF in order to avoid the release of resources in the network. + +#### A.3.2 Updating the provisioned PCC rules at the final answer + +The P-CSCF shall store the SDP information for each early dialogue separately till the first final SIP answer is received. Then the related early dialogue is progressed to an established dialogue to establish the final SIP session. All the other early dialogues are terminated. The service information for the SIP session is updated to match the requirements of the remaining early dialogue only. + +When receiving the first final SIP response, the P-CSCF shall send an AA request without the SIP-Forking-Indication AVP and include the service information derived from the SDP corresponding to the dialogue of the final response. The P-CSCF shall provision the full service information including the applicable Flow-Description AVP(s) and Flow-Status AVP(s). + +When receiving an AA request with no SIP-Forking-Indication AVP or with a SIP-Forking-Indication AVP with value SINGLE\_DIALOGUE, the PCRF shall update installed PCC Rules information and Authorized-QoS information to match only the requirements of the service information within this AA request. The PCRF should immediately remove PCC Rule(s) or individual service data flow filters not matching IP flow(s) in the updated Service Information, to reduce the risk for initial clipping of the media stream, and to minimize possible misuse of resources. The PCRF shall also open or close the gates for service flows according to the flow status in the received service information. + +## --- A.4 Notification of AF Signalling Transmission Path Status + +When the P-CSCF receives an initial REGISTER SIP message from an attached UE, the P-CSCF may subscribe to notifications of the status of the AF Signalling transmission path using the procedures specified in clause 4.4.5. Once the P-CSCF has subscribed, the P-CSCF may receive notifications from the PCRF according to clause 4.4.6.3. + +NOTE 1: When the Standardised QCI characteristics as defined in 3GPP TS 23.203 [2] are followed, the QCI for IMS signalling will correspond to a non-GBR bearer. In this case, the P-CSCF will not receive notifications related to the Specific-Action with value "INDICATION\_OF\_LOSS\_OF\_BEARER". + +NOTE 2: This procedure is not applicable for IMS registrations for Emergency sessions. + +The P-CSCF shall cancel the subscription to notification of the status of the AF Signalling transmission path when the AF Signalling to that particular user is terminated (i.e. when the user is de-REGISTERED from the IM CN subsystem). + +When the P-CSCF receives a notification of loss of signalling connectivity from the PCRF, the P-CSCF shall behave as defined in 3GPP TS 24.229 [17]. + +## --- A.5 Indication of Emergency Registration and Session Establishment + +When the P-CSCF receives an initial REGISTER SIP message for an IMS emergency registration or an INVITE SIP message for an emergency session and the P-CSCF determines that there are no IMS-level roaming interfaces, the P-CSCF may request the PCRF to provide the EPC-level identities (MSISDN, IMSI, IMEI(SV)) available for that IP-CAN session using the procedure as specified in this clause (for an IMS emergency registration) or A.1 (for an IMS emergency session establishment). An P-CSCF may request the PCRF to provide the EPC-level identities (MSISDN, IMSI, IMEI(SV)) available for that IP-CAN session when no service information is available in the AF. To do so, the P-CSCF shall open an Rx Diameter session with the PCRF for the AF signalling using an AA-Request command. The P-CSCF shall provide the UE's IP address (using either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP) and the AF-Requested-Data AVP set to "EPC-level identities required". The AF shall include the Service-URN AVP set to the value "sos", in order to indicate that the new AF session relates to emergency traffic that is not related to a specific emergency service. + +When the PCRF receives an AA-Request command as described in the preceding paragraphs from the P-CSCF, the PCRF shall perform session binding as described in 3GPP TS 29.213 [9]. When the PCRF receives the Service-URN AVP indicating an emergency session, the PCRF may apply special policies, for instance prioritising service flows relating to the AF session or allowing these service flows free of charge. When the Service-URN AVP indicates that the AF session relates to emergency traffic and the AF-Requested-Data AVP is received indicating "EPC-level Identities required", the PCRF shall provide the requested available user information (MSISDN, IMSI) for the IP-CAN session within the Subscription-Id AVP(s) and/or the IMEI(SV) within the User-Equipment-Info AVP or the User-Equipment-Info-Extension AVP if the User-Equipment-Info-Extension feature is supported, in the AA-Answer command. + +When the P-CSCF receives the AA-Answer with the EPC-level identities from the PCRF, the P-CSCF stores the information received within the Subscription-Id AVP(s) and/or User-Equipment-Info AVP or User-Equipment-Info- + +Extension AVP if the User-Equipment-Info-Extension feature is supported, provided by the PCRF and behaves as defined in 3GPP TS 24.229 [17]. + +NOTE: The user information received within the User-Equipment-Info AVP or the User-Equipment-Info-Extension AVP if the User-Equipment-Info-Extension feature is supported, and/or Subscription-Id AVP(s) can be used to support PSAP callback functionality for anonymous IMS emergency sessions. See 3GPP TS 23.167 [53] for further information. + +The P-CSCF may decide to terminate the Rx session at any time. In that case, the AF shall use a Session-Termination-Request (STR) command to the PCRF, which shall be acknowledged with a Session-Termination-Answer (STA) command. + +A SIP INVITE request can contain a service URN as defined in IETF RFC 5031 [21] within the request URI. If the service within this URN is "sos", possibly with additional sub-service information, the P-CSCF shall provision this service and sub-service information within the Service-URN AVP towards the PCRF. The P-CSCF may also provision possible information about other services received within the service URN. + +## --- A.6 Notification IP-CAN Type Change + +When the P-CSCF receives an initial REGISTER SIP message or an INVITE SIP message from an attached UE, the P-CSCF may request from the PCRF the information about the type of IP-CAN the UE is attached to using the procedure specified in clause 4.4.1. + +NOTE 1: This procedure is not applicable for IMS registrations for Emergency sessions. + +NOTE 2: The P-CSCF can request information about the type of IP-CAN as part of the SIP session setup when it is only interested in the related information when the IMS session is ongoing. + +If the P-CSCF requests information about the type of IP-CAN, the P-CSCF shall also subscribe within the same AAR command operation to notifications for changes of the IP-CAN type used by the UE. The P-CSCF shall include a Specific-Action AVP in the AAR that is set to the value of IP-CAN\_CHANGE. + +When the P-CSCF receives the AA-Answer or RA-Request from the PCRF, the P-CSCF stores the IP-CAN type information received within the IP-CAN-Type AVP and the RAT type information received within the RAT-Type AVP and AN-Trusted AVP (if also provided by the PCRF) and behaves as defined in 3GPP TS 24.229 [17]. + +The P-CSCF may receive notifications for changes of the IP-CAN type from the PCRF according to clause 4.4.6.4. When the P-CSCF receives a notification of the change of the IP-CAN used by the UE, the P-CSCF stores the new IP-CAN type information and RAT type information and behaves as defined in 3GPP TS 24.229 [17]. + +NOTE 3: The subscription to receive information about the type of IP-CAN will be cancelled when the corresponding Rx session is terminated by the AF (i.e. when the UE is de-REGISTERED or the related SIP call is torn down). + +## --- A.7 Support for Early Session disposition SDP + +### A.7.1 General + +As a network option, the P-CSCF may support the PCC procedures in the present Clause to handle "early session" disposition type SDP, as standardised in IETF RFC 3959 [27]. + +### A.7.2 Service Information Provisioning for Early Media + +The P-CSCF can receive "early session" disposition SDP in addition to "session" disposition SDP in SIP early dialogues. + +The P-CSCF shall then provision service information derived both from the "early session" disposition SDP and "session" disposition SDP applying the procedures in Clauses A.1, A.2, and A.3, and in the present Clause. + +The P-CSCF shall apply the mapping rules in Annex B.1.2.2.2 to derive the flow identifiers from "early session" disposition SDP. + +If a single media line with one media type (e.g. "audio" or "video") is contained in "early session" disposition SDP and a single media line with the same media type is contained in the "session" disposition SDP of the same SIP dialogue, and both media lines describe service flows of the same directionality (uplink, downlink, or bidirectional), the P-CSCF should describe those SDP media lines in the same session information media component (with the same flow ID). + +The "early session" disposition SDP can also contain media lines of a type not included in the "session" disposition SDP, or several media lines of the same type. Such media components shall be described in own media components in the service information. + +If the P-CSCF desires to invoke special policies or separate event notifications for an "early session" disposition media line, it may choose to provision a separate session information media component even if a media line with the same media type and directionality is contained in "session" disposition SDP. + +NOTE 1: A PCRF is then likely to supply separate PCC rules for early media and the corresponding final media. This may lead to an over provisioning of resources during call establishment and a subsequent reconfiguration of the radio bearer, or even to a call failure if the extra resources are not authorized or available. + +If the P-CSCF receives "early session" disposition SDP before any "session" disposition SDP and supplies service information derived from the "early session" disposition SDP at this point of time, it shall use dedicated media components relating only to the "early session" disposition SDP in the service information. + +NOTE 2: The "session" disposition SDP offer will frequently occur before the "early session" disposition SDP offer, but can also occur in parallel or in exceptional cases afterwards. The "session" disposition SDP answer can be contained in the same SIP message as the "early session" disposition SDP offer, or can be sent in a 200 OK (INVITE), i.e. after the "early session" disposition SDP answer. + +If the P-CSCF includes any media component relating both to "early session" disposition SDP and "session" disposition SDP in the service information, the P-CSCF shall: + +- provision the service information derived from "early session" disposition SDP and the service information derived from "session" disposition SDP in separate Rx AA-Requests, and shall send a new Rx AA-Request only after any previous Rx AA-Request has been acknowledged; and +- provision the first service information (either derived from "early session" disposition SDP or "session" disposition SDP) without the SIP-Forking-Indication AVP, or with the SIP-Forking-Indication AVP with value SINGLE\_DIALOGUE; and +- provision all subsequent service information during ongoing call establishment with the SIP-Forking-Indication AVP with value SEVERAL\_DIALOGUES; and +- if an SDP answer has been received and Codec-Data AVPs are provisioned within a Media-Component-Description AVP, provision a Codec-Data AVP derived from the corresponding offer together with a Codec-Data AVP derived from the SDP answer. + +NOTE 3: The P-CSCF needs to provision the service information derived from "early session" disposition SDP and the service information derived from "session" disposition SDP in separate Rx AA-Requests because the encoding of the media-component does not allow for the simultaneous provisioning of two corresponding filters. + +NOTE 4: The PCRF will treat service information containing the SIP-Forking-Indication AVP as described in Clause A.3. + +### A.7.3 Updating the Provisioned Service Information when Dialogue is established + +The P-CSCF shall store the SDP information for the "session" disposition type until the first final SIP answer is received. Then the early media described in the "early session" disposition type SDP are terminated. + +The P-CSCF shall then update the service information to match the requirements of the media described in the "session" disposition type SDP only: + +- If the P-CSCF included any media component relating both to "early session" disposition SDP and "session" disposition SDP in the service information, the P-CSCF shall send an AA request without the SIP-Forking-Indication AVP or with a SIP-Forking-Indication AVP with value SINGLE\_DIALOGUE and shall include the service information derived from the "session" disposition SDP. The P-CSCF shall provision the full service information including the applicable Flow-Description AVP(s) and Flow-Status AVP(s). +- The P-CSCF shall disable any media component(s) in the service information that relate to early media only by setting their flow status to "removed". + +## --- A.8 Provision of Signalling Flow Information at P-CSCF + +When the P-CSCF has successfully concluded the initial registration of an attached UE, i.e., when the P-CSCF has sent to the UE a SIP 200 (OK) response to the SIP REGISTER request, the P-CSCF may provision information about the SIP signalling flows between the UE and itself using the procedure specified in clause 4.4.5A. If the P-CSCF already has an open Rx Diameter session with the PCRF related to the signalling with the UE, e.g. one that has been opened according to the procedure described in clause A.6 and/or in clause A.4, the P-CSCF shall reuse the already open session to provision the SIP Signalling IP Flow information. + +NOTE: This procedure is not applicable for IMS registrations for Emergency sessions. + +If the P-CSCF provisions information about SIP signalling flows, the P-CSCF shall ensure that for each signalling IP flow information it provides, the Flow-Description AVP shall accurately reflect the IP flow information as seen in the IP header 'on the wire'. The P-CSCF shall set the value of the AF-Signalling-Protocol AVP to 'SIP'. + +When the P-CSCF de-registers the UE and terminates SIP Signalling to the UE, the P-CSCF shall de-provision the SIP Signalling IP flow information from the PCRF as described in clause 4.4.5A. + +## --- A.9 Handling of MPS Session + +When the P-CSCF receives an authorised Resource-Priority header field or a temporarily authorised Resource-Priority header field containing an appropriate namespace and priority value in SIP signaling, and recognizes the need for priority treatment as specified in 3GPP TS 24.229 [17], the P-CSCF shall include the MPS-Identifier AVP and Reservation-Priority AVP in the AAR command towards the PCRF. The MPS-Identifier AVP shall contain the national variant for MPS service name indicating an MPS session. The Reservation-Priority AVP shall include the priority value of the related priority service. The Reservation-Priority AVP shall be populated with a default value if the priority value is unknown. + +NOTE 1: Various mechanisms can be applied to recognize the need for priority treatment in the P-CSCF (e.g., based on the dialled digits), according to national regulation and network configuration, as stated in 3GPP TS 24.229 [17]. + +NOTE 2: Lowest user priority value is mapped in the corresponding lowest enumerated value of the Reservation-Priority AVP. + +If the P-CSCF supports the Diameter message priority mechanism for an MPS session, it shall include the DRMP AVP towards the PCRF as described in 3GPP TS 29.213 [9], Annex J. + +NOTE 3: If the P-CSCF supports the Diameter message priority mechanism for an MPS session, it includes the DRMP AVP with a priority value equivalent to the Reservation-Priority AVP priority value. Highest user priority value is mapped in the corresponding lowest enumerated value of the DRMP AVP. + +Upon reception of a request that requires MPS treatment, the PCRF shall derive the PCC/QoS Rules corresponding to the MPS session, as appropriate. The PCRF shall take specific actions on the corresponding IP-CAN to ensure that the MPS session is prioritized, as described in 3GPP TS 29.212 [8], clause 4.5.19.1.3. + +When the P-CSCF terminates the MPS session, the PCRF shall delete the PCC/QoS Rules corresponding to the MPS session. The PCRF shall revoke the actions related to the prioritization of the MPS session in the corresponding IP-CAN, as described in 3GPP TS 29.212 [8], clause 4.5.19.1.3. + +## --- A.10 Retrieval of network provided location information + +### A.10.1 General + +According to Annex E.7 of 3GPP TS 23.228 [16], the P-CSCF can use PCC to retrieve network provided location information. Information flows related to the distribution of network provided location information within the IMS are provided in Annex R of 3GPP TS 23.228 [16]. + +This subclause provides optional PCC procedures to support the retrieval of network provided location information. + +The originating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information either before sending the INVITE or MESSAGE towards the terminating side or upon reception of the SDP answer from the terminating side. + +The terminating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information either upon reception of a SIP INVITE or upon reception of a SIP response. + +The originating and terminating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information at mid call, e.g., when the P-CSCF learns about IP-CAN type change. + +### A.10.2 Retrieval of network provided location information at originating P-CSCF for inclusion in SIP Request + +If the originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding a SIP INVITE request, upon reception of an INVITE/UPDATE request, the P-CSCF shall send an AA-Request according to clause 4.4.1 (SIP INVITE request) or 4.4.2 (SIP INVITE/UPDATE request) including: + +- the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and +- the required access network information within the Required-Access-Info AVP. + +If the SIP INVITE request is an initial SIP INVITE request, the P-CSCF shall establish an Rx session for the new SIP session with the AA-Request according to clause 4.4.6.7 (if no session information is included) or 4.4.1 (if preliminary session information is included). + +The P-CSCF will receive the access network information from the PCRF in an RAR, and should include this access network information in the SIP INVITE/UPDATE requests that it forwards. When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +### A.10.3 Retrieval of network provided location information at originating P-CSCF for inclusion in SIP response confirmation + +If an originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding an SDP answer, the P-CSCF shall apply the following procedures: + +Upon reception of an SDP offer, the P-CSCF may send an AA-Request to the PCRF according to clause A.1 and may include in this AA-request: + +- the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and +- the required access network information within the Required-Access-Info AVP. + +Upon reception of an SDP answer, the P-CSCF will send an AA-Request to the PCRF according to clause A.1. If the P-CSCF has not requested access network information upon reception of the SDP offer, the P-CSCF shall include in this AA-request: + +- the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and +- the required access network information within the Required-Access-Info AVP. + +The P-CSCF will receive the access network information from the PCRF in an RAR, and should include this access network information in the SIP message with the response confirmation before forwarding it. When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +If the originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding a SIP MESSAGE request, upon reception of a MESSAGE request, the P-CSCF shall send an AA-Request including: + +- the UE's IP address (using either the Framed-IP-Address AVP or the Framed-Ipv6-Prefix AVP); +- a Media-Component-Description AVP including a single Media-Sub-Component AVP with the Flow-Usage AVP set to the value "AF\_SIGNALLING". The Media-Component-Description AVP shall contain the Media-Component-Number AVP set to "0". The Media-Sub-Component AVP shall contain the Flow-Number AVP set to "0", and the rest of AVPs within the Media-Component-Description and Media-Sub-Component AVPs shall not be used in this case; +- the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and +- the required access network information within the Required-Access-Info AVP. + +The P-CSCF will receive the access network information from the PCRF in an RAR and should include this access network information in the SIP MESSAGE requests that it forwards. When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +If the Rx Diameter Session is only used for retrieval of network provided location information, at reception of this information, the AF may terminate the AF session sending a Session-Termination-Request (STR) command to the PCRF, which shall be acknowledged with a Session-Termination-Answer (STA) command. + +### A.10.4 Retrieval of network provided location information at terminating P-CSCF + +If a terminating P-CSCF is required by operator policy to retrieve network provided location information at session establishment and/or modification, the P-CSCF shall apply the following procedures: + +The terminating P-CSCF may request network provided location information upon reception of a SIP INVITE request : in the following manner: + +- If the SIP INVITE request is an initial SIP INVITE request, the P-CSCF shall establish an Rx session for the new SIP session with the AA-Request according to clause 4.4.6.7 (if no session information is included) or 4.4.1 (if preliminary session information is included). +- If the SIP INVITE includes an SDP offer, the P-CSCF shall send an AA-Request including: + - the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; + - the required access network information within the Required-Access-Info AVP; + - service information derived from the SDP offer; and + - the Service-Info-Status AVP with the value set to PRELIMINARY SERVICE INFORMATION. +- If the SIP INVITE includes no SDP offer, the P-CSCF shall send an AA-Request including: + - the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and + - the required access network information within the Required-Access-Info AVP. + +Upon reception of a SIP response that requires the inclusion of access network information, if the P-CSCF has not already requested network provided location information upon reception of the corresponding SIP INVITE, the P-CSCF shall request network provided location information in the following manner: + +- If an Rx session related to service data has not yet been established, the P-CSCF shall establish an Rx session for the new SIP session with the AA-Request according to clause 4.4.6.7 (if no session information is included) or 4.4.1 (if session information is included). +- If the SIP response includes an SDP answer, the P-CSCF will send an AA-Request to the PCRF according to clause A.1; the P-CSCF shall include in this AA-request: + - the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and + - the required access network information within the Required-Access-Info AVP. +- If the SIP response includes no SDP, the P-CSCF shall send an AA-Request including: + - the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; and + - the required access network information within the Required-Access-Info AVP. +- If the SIP response includes an SDP offer, the P-CSCF shall send an AA-Request including: + - the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; + - the required access network information within the Required-Access-Info AVP; + - service information derived from an SDP offer within the SIP response; and + - the Service-Info-Status AVP with the value set to PRELIMINARY SERVICE INFORMATION. + +The P-CSCF will receive the access network information from the PCRF in an RAR, and should include this access network information in the appropriate SIP response before forwarding it. When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +If the terminating P-CSCF is required by operator policy to retrieve network provided location information upon reception of a SIP MESSAGE response, the P-CSCF shall behave according to A.10.2. + +### A.10.5 Provisioning of network provided location information at SIP session release + +If a P-CSCF is required by operator policy to include network provided location information in SIP session release signalling, the P-CSCF shall apply the following procedures: + +Upon reception of a SIP session release request that requires the inclusion of network provided location information, the P-CSCF will send an ST-Request and shall include in this request the required access network information within the Required-Access-Info AVP. + +The P-CSCF will receive the access network information from the PCRF in the corresponding ST-Answer, and should include this access network information either in the SIP session termination request (at the originating side) or a reply to the SIP session termination request (at the terminating side). When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +### A.10.6 Provisioning of network provided location information at mid call + +If a P-CSCF is required by operator policy to include network provided location information at mid call, the P-CSCF shall apply the following procedures: + +Upon reception of a trigger (e.g., when the P-CSCF learns about the access change) that requires the inclusion of network provided location information in a SIP message, the P-CSCF shall include in the AA-request: + +- the "ACCESS\_NETWORK\_INFO\_REPORT" value within the Specific-Action AVP; +- the required access network information within the Required-Access-Info AVP; and +- the service information related to the service according to clause 4.4.2. + +The P-CSCF will receive the access network information from the PCRF in an RAR, and should include this access network information in the appropriate SIP message before forwarding it. When the retrieved access network information corresponds to the TWAN-Identifier AVP, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in Annex E.8 of 3GPP TS 23.228 [16]. + +## --- A.11 Handling of RAN/NAS release cause values + +If the P-CSCF is required by operator policy to provide the RAN/NAS release cause information, it includes this information in the corresponding SIP message as specified in 3GPP TS 24.229 [17] when received from the PCRF (see clause 4.4.4, 4.4.6.1, 4.4.6.2, 4.4.6.3 and 4.4.6.7). + +## --- A.12 Resource Sharing + +The P-CSCF may indicate to the PCRF that media of an AF session may share resources with media belonging to other AF sessions according to 3GPP TS 23.228 [16]. + +If the P-CSCF determines that resource sharing is possible, it may at establishment of a new AF session, include the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP indicating that media resources may be shared in the related direction. The P-CSCF shall assign a distinct value for the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP for each media component identified by the Media-Component-Description AVP for the AF session. + +NOTE 1: When resource sharing applies to both directions for a certain media component, the P-CSCF can assign the same value for Sharing-Key-UL AVP and Sharing-Key-DL AVP within the same media component. + +The P-CSCF shall not include the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP within the Media-Component-Description AVP when the AF session relates to an Emergency Session. + +The PCRF shall not include the Sharing-Key-DL AVP and/or Sharing-Key-UL AVP for those PCC/QoS Rules related to the RTCP traffic. + +Trigger conditions that require applying or stopping resource sharing are described in 3GPP TS 24.229 [17]. + +NOTE 2: When P-CSCF needs to stop sharing according to the procedures described in 3GPP TS 24.229 [17], the P-CSCF will provide new values for the Sharing-Key-UL AVP and/or Sharing-Key-DL AVP that are not being used by any other AF sessions for the same user. + +## --- A.13 Handling of MCPTT priority call + +### A.13.1 General + +Within the framework of MCPTT, when the SIP Core (3GPP TS 23.379 [54]) is implemented by an IMS core network, if the P-CSCF receives a SIP request message including a Resource-Priority header field with a namespace field and priority value defined for MCPTT for adjusting the priority of an MCPTT session, the P-CSCF shall provide the Reservation-Priority AVP and the MCPTT-Identifier AVP in the AA-Request command as defined in clause A.13.2 to allow the PCRF to set the corresponding PCC rule(s) according to the prioritized MCPTT service. Additionally, if PrioritySharing feature is supported, the P-CSCF may provide the Priority-Sharing-Indicator AVP within the Media-Component-Description AVP as described in clause A.1. For MCPTT the service priority and the priority sharing indicator are defined in 3GPP TS 23.379 [54]. + +NOTE 1: The process of adjusting priority may occur several times during the course of one session, e.g. a normal MCPTT group call elevated to an MCPTT emergency group call, returned to a normal priority MCPTT group call, elevated to an MCPTT imminent peril group call and returned to a normal priority MCPTT group call. + +NOTE 2: Upon reception of a request that requires the adjustment of the MCPTT priority, the PCRF is expected to derive the PCC Rules corresponding to the this MCPTT session, as appropriate according to operator policies. + +NOTE 3: The PCRF can identify an MCPTT call using the IMS Communication Service Identifier specific to MCPTT, which is provided by the P-CSCF in the AF-Application-Identifier AVP in the AA-Request sent to PCRF. + +### A.13.2 Determination of MCPTT priority parameter values + +When the P-CSCF receives an authorized Resource-Priority header field containing an appropriate namespace and priority value used for MCPTT in SIP signaling, the P-CSCF shall include the MCPTT-Identifier AVP and Reservation-Priority AVP in the AAR command towards the PCRF. + +The MCPTT-Identifier AVP shall include the namespace defined for MCPTT as received within the Resource-Priority header field. + +NOTE: Two different values are defined for the MCPTT-Identifier AVP, one for each namespace value defined for MCPTT (see IETF RFC 8101 [45]). + +The Reservation-Priority AVP shall contain the priority value of the Resource-Priority header; the lowest priority shall be mapped to to DEFAULT (0), the next after the lowest to PRIORITY-ONE (1), and so on up to the highest priority which shall be mapped to PRIORITY-FIFTEEN (15). + +Additionally, when the P-CSCF receives information about priority sharing from an MCPTT server that supports simultaneous sessions and that needs to share a common priority for several MCPTT sessions and if PrioritySharing feature is supported, the P-CSCF may include the Priority-Sharing-Indicator AVP within the Media-Component-Description AVP in the AAR command. See 3GPP TS 23.379 [54] for further information. + +## --- A.14 Notification of PLMN Change + +When the P-CSCF receives an initial REGISTER SIP message from an attached UE, the P-CSCF may subscribe to notifications of PLMN ID changes corresponding to the PLMN where the UE is located using the procedure specified in clause 4.4.6.9. + +When the P-CSCF receives the AA-Answer or RA-Request from the PCRF, the P-CSCF stores the PLMN identifier received within 3GPP-SGSN-MCC-MNC AVP and behaves as defined in 3GPP TS 24.229 [17]. + +The P-CSCF shall cancel the subscription to notification for changes of the PLMN used by the UE when the user is de-registered from the IM CN subsystem. + +## --- A.15 Handling of MCVideo priority call + +### A.15.1 General + +Within the framework of MCVideo, when the SIP Core (3GPP TS 23.281 [61]) is implemented by an IMS core network, if the P-CSCF receives a SIP request message including a Resource-Priority header field with a namespace field and priority value defined for MCVideo for adjusting the priority of an MCVideo session, the P-CSCF shall provide the Reservation-Priority AVP and the MCVideo-Identifier AVP in the AA-Request command as defined in clause A.15.2 to allow the PCRF to set the corresponding PCC rule(s) according to the prioritized MCVideo service. + +- NOTE 1: The process of adjusting priority may occur several times during the course of one session, e.g. a normal MCVideo group call elevated to an MCVideo emergency group call and returned to a normal priority MCVideo group call, elevated to an MCVideo imminent peril group call and returned to a normal priority MCVideo group call. +- NOTE 2: Upon reception of a request that requires the adjustment of the MCVideo priority, the PCRF is expected to derive the PCC Rules corresponding to the this MCVideo session, as appropriate according to operator policies. +- NOTE 3: The PCRF can identify an MCVideo call using the IMS Communication Service Identifier specific to MCVideo, which is provided by the P-CSCF in the AF-Application-Identifier AVP in the AA-Request sent to PCRF. + +### A.15.2 Determination of MCVideo priority parameter values + +When the P-CSCF receives an authorized Resource-Priority header field containing an appropriate namespace and priority value used for MCVideo in SIP signaling, the P-CSCF shall include the MCVideo-Identifier AVP and Reservation-Priority AVP in the AAR command towards the PCRF. + +The MCVideo-Identifier AVP shall include the namespace defined for MCVideo as received within the Resource-Priority header field. + +The Reservation-Priority AVP shall contain the priority value of the Resource-Priority header; the lowest priority shall be mapped to to DEFAULT (0), the next after the lowest to PRIORITY-ONE (1), and so on up to the highest priority which shall be mapped to PRIORITY-FIFTEEN (15). + +## --- A.16 Support for volume based charging of IMS services + +As a network option, when VBC feature is supported, the P-CSCF may be able to indicate to the PCRF the establishment and termination of specific IMS communication services (e.g. CAT and voice calls, 3PTY conference) or the establishment and termination of different communication dialogues to separate parties. This enables PCC to apply different Policy and Charging control. During AF session establishment, the P-CSCF may include the IMS-Content-Identifier AVP and the IMS-Content-Type AVP in the AAR command towards the PCRF. The PCRF derives the PCC rules to categorise the service data flows by rating group or combination of rating group and service id. + +During AF session modification, the P-CSCF may include the IMS-Content-Identifier AVP and the IMS-Content-Type AVP in the AAR command towards the PCRF. The PCRF updates the PCC rules to categorise the service data flows by rating group or combination of rating group and service id. + +The IMS-Content-Type AVP indicates the type of IMS content of a session component. The P-CSCF determines the type of IMS content as follows: + +- If the SDP payload refers to the Customized Alerting Tones (CAT) service (i.e. SDP body contains a media-level "a=content" SDP attribute with a value "g.3gpp.cat" defined in 3GPP TS 24.182 [62]), the P-CSCF sets the IMS-Content-Type AVP with the value "CAT". +- If the SDP payload refers to the 3PTY conference service (i.e. SDP body contains an "a=content" media-level attribute line with value of "g.3gpp.conf" defined in 3GPP TS 24.147 [63]), the P-CSCF sets the IMS-Content-Type AVP with the value "CONFERENCE". +- Otherwise, the P-CSCF sets the IMS-Content-Type AVP with the value "NO\_CONTENT\_DETAIL". + +The IMS-Content-Identifier AVP contains information that identifies a particular IMS communication service or a particular communication dialogue in the IMS session. This information may be used by the PCRF to apply different charging characteristics to the different parties in a 3PTY conference scenario. + +As a network option, if VBCLTE feature is further supported, the P-CSCF shall be able to indicate to the PCRF caller and callee information. + +During AF session establishment, the P-CSCF may include the Calling-Party-Address AVP and the Callee-Information AVP in the AAR command towards the PCRF. The PCRF derives the PCC rules including the information of caller and callee. + +During AF session modification, the P-CSCF may include the Callee-Information AVP in the AAR command towards the PCRF. The PCRF updates the PCC rules to categorise the service data flows by rating group or combination of rating group and service id. + +The Calling-Party-Address AVP indicates the caller of the IMS service. The P-CSCF determines the caller as defined in clause 7.2.33 of 3GPP TS 32.299 [24]. + +The Callee-Information AVP indicates the callee of the IMS service. The P-CSCF determines the callee as follows: + +- The Called-Party-Address holds the address of the party (Public User ID or Public Service ID) to whom the SIP transaction is posted in the context of an end-to-end SIP transaction as defined in clause 7.2.32 in 3GPP TS 32.299 [24]. +- The Requested-Party-Address holds the address of the party (Public User ID or Public Service ID) to whom the SIP transaction was originally posted as defined in clause 7.2.176 in 3GPP TS 32.299 [24]. + +NOTE: This AVP is only applicable when the ATCF is collocated with the P-CSCF. + +- The Called-Asserted-Identity holds the address or addresses (SIP URI and/or Tel URI) of the party (Public User ID or Public Service ID) of the finally asserted called party as defined in clause 7.2.31 of 3GPP TS 32.299 [24]. + +## --- A.17 Indication of Restricted Local Operator Services Support + +RLOS is an optional feature supported in certain countries. Service requirements of RLOS are defined in 3GPP TS 22.101 [65] and the architectural requirements are defined in 3GPP TS 23.221 [66]. The RLOS stage 2 services description for the Evolved Packet System (EPS) is specified in 3GPP TS 23.401 [67]. The policy and charging control architecture is described in 3GPP TS 23.203 [2]. + +RLOS may be supported as described in clause A.5 with the following differences: + +- emergency registration is replaced by RLOS registration; +- emergency session is replaced by RLOS session; +- emergency traffic is replaced by RLOS traffic; +- value "sos" is replaced by "g.3gpp.rlos"; +- UNAUTHORIZED\_NON\_RLOS\_SESSION session is returned when the service-URN AVP does not include an RLOS value, and the PCRF binds the IMS session to an IP-CAN established to an RLOS APN; + +- RLOS services are not prioritized services; and +- the call back functionality is not required. + +## --- A.18 Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM) + +As a network option, the P-CSCF may support the PCC procedures in the present clause to handle the Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM) + +NOTE 1: When the CHEM feature is supported, improved error robustness can be enabled by packet-loss handling procedures of the codec, codec mode, or codec configuration to avoid, delay, or reduce the need to handoff a terminal due to degradation in the media quality. Communicating the level of robustness of the media to the network enables the eNB to use this information to determine a threshold for when the terminal should be handed off to another cell, domain (circuit-switched vs. packet-switched), or radio access technology. + +When a session is initiated or modified the P-CSCF supporting the CHEM feature shall derive the Max-PLR-DL AVP and Max-PLR-UL AVP based on the PLR\_adapt and maxe2e-PLR attribute values in both the SDP offer and/or SDP answer to determine the maximum tolerable end-to-end PLR budget distributed across the uplink and downlink in a media transport path as described in 3GPP TS 29.213 [9] clause 6.2. + +Upon reception of SDP offer and answer, P-CSCF should check whether a= PLR\_adapt line is present in both SDP offer and answer to derive Max-PLR-DL and Max-PLR-UL AVP in Media-Component-Description AVP else downlink and uplink maximum packet loss are not included by AF. + +The originating P-CSCF should derive Max-PLR-DL AVP to the maximum value of Max-PLR-DL among all the RTP payload types. For each RTP payload type Max-PLR-DL is computed as described in 3GPP TS 29.213 [9] clause 6.2. + +- If maxe2e-PLR is included in the SDP offer then Max-PLR-DL for a payload type is derived as value of maxe2e-PLR in the SDP offer - maxUL-PLR in the SDP answer if present else the default value is $\frac{1}{2}$ maxe2e-PLR value present in the SDP offer. +- If maxe2e-PLR is not included in the SDP offer then then Max-PLR-DL for a payload type is derived from the default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [41] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy - maxUL-PLR in the SDP answer if present else the default value is $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [41]. + +The originating P-CSCF should derive Max-PLR-UL AVP to the maximum value of Max-PLR-UL among all the RTP payload types. For each RTP payload type Max-PLR-UL is computed as described in 3GPP TS 29.213 [9] clause 6.2. + +- If maxe2e-PLR is included in the SDP answer then Max-PLR-UL for a payload type is derived as value of maxe2e-PLR in the SDP answer - maxDL-PLR in the SDP ANSWER if present else the default value is $\frac{1}{2}$ maxe2e-PLR value present in the SDP answer. +- If maxe2e-PLR is not included in the SDP answer then then Max-PLR-UL for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [41] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +The terminating P-CSCF should derive Max-PLR-DL AVP to the maximum value of Max-PLR-DL among all the RTP payload types. For each RTP payload type Max-PLR-DL is computed as described in 3GPP TS 29.213 [9] clause 6.2. + +- If maxe2e-PLR is included in the SDP answer then Max-PLR-DL for a payload type is derived as value of value of maxDL-PLR in the SDP answer if present else the default value is $\frac{1}{2}$ maxe2e-PLR value present in the SDP answer. +- If maxe2e-PLR is not included in the SDP answer then then Max-PLR-DL for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as + +recommended in 3GPP TS 26.114 [41] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +The terminating P-CSCF should derive Max-PLR-UL AVP to the maximum value of Max-PLR-UL among all the RTP payload types. For each RTP payload type Max-PLR-UL is computed as described in 3GPP TS 29.213 [9] clause 6.2. + +- If maxe2e-PLR is included in the SDP offer then Max-PLR-UL for a payload type is derived as value of value of maxUL-PLR in the SDP answer if present else the default value is $\frac{1}{2}$ maxe2e-PLR value present in the SDP offer. +- If maxe2e-PLR is not included in the SDP offer then then Max-PLR-UL for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [41] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +## --- A.19 Handling of a FLUS session + +If the P-CSCF receives a SIP request that requires provisioning of service information to the PCRF, the "FLUS" feature is supported and an SDP attribute "a=label:flus..." is included in one or more of the received SDP media descriptions, the P-CSCF shall provide the string after "a=label:" starting with "flus" within the FLUS-Identifier AVP within the affected Media-Component-Description AVP(s) in the AA-Request to the PCRF. + +NOTE: During the first interaction with the PCRF, the P-CSCF does not know if the "FLUS" feature is supported by the PCRF. In this case the P-CSCF will include the information as if supported. + +If additionally the P-CSCF receives the "a=3gpp-qos-hint" media-level SDP attribute in the SIP request, the P-CSCF shall provide the PCRF with the Desired-Max-Latency AVP and/or Desired-Max-Loss AVP as described in 3GPP TS 29.213 [9], clause 6.2. + +Upon receiving the information from the P-CSCF and if the "FLUS" feature is supported, the PCRF shall derive the QoS information as described in 3GPP TS 29.213 [9], clause 6.3. + +## --- A.20 QoS hint support for data channel media + +If the P-CSCF receives a SIP request that requires provisioning of a service information to the PCRF, the QoSHint feature is supported and an SDP attribute "a=3gpp-qos-hint" is included in one or more of the received data channel media descriptions, the P-CSCF may provide the Desired-Max-Latency AVP and/or Desired-Max-Loss AVP for each affected application media component within the Media-Component-Description AVP(s) in the AA-Request to the PCRF. + +NOTE: During the first interaction with the PCRF, the P-CSCF does not know if the QoSHint feature is supported by the PCRF. In this case the P-CSCF will include the information as if supported. + +Upon receiving the information from the P-CSCF and if the QoSHint feature is supported, the PCRF shall derive the QoS information as described in 3GPP TS 29.213 [9], clause 6.3. + +# Annex B (normative): Flow identifiers: Format definition and examples + +## B.1 Format of a flow identifier + +### B.1.1 General + +A flow identifier is expressed as a 2-tuple as follows: + + + +where both are numbered starting from 1. The encoding of the flow identifier is as indicated in 3GPP TS 24.008 [12]. + +If UE and AF share an algorithm for a given application, which guarantees that UE and AF assign the same ordinal number to each media component, the ordinal numbers of the IP Flows within a media component shall be assigned according to the following rules: + +- All IP flow(s) or bidirectional combinations of two IP flow(s) within the media component, for which a downlink destination port number is available, shall be assigned ordinal numbers in the order of downlink destination port numbers. +- All IP flows, where no downlink destination port number is available, shall be assigned the next higher ordinal numbers in the order of uplink destination port numbers. + +The ordinal number of a media component shall not be changed when the session description information is modified. + +If no SDI with fixed and unique positions for media components is exchanged between UE and AF, the UE and AF may assign the ordinal numbers of the media components in another application-dependent algorithm which guarantees that UE and AF assign the same ordinal number to each media component. + +If UE and AF do not share an algorithm for a given application, which guarantees that UE and AF assign the same ordinal number to each media component, the ordinal number of the media component shall be set to zero and the ordinal number of the IP flows shall be assigned according to the following rules: + +1. If ordinal numbers for several IP flows are assigned at the same time, all uplink IP flows shall be assigned lower ordinal number than all downlink IP flows. +2. If ordinal numbers for several IP flows are assigned at the same time, all uplink and all downlink IP flows shall separately be assigned ordinal numbers according to increasing internet protocol number assigned by IANA (e.g. 6 for TCP and 17 for UDP) +3. If ordinal numbers for several IP flows are assigned at the same time, for each internet protocol with a port concept, all uplink and all downlink IP flows of this internet protocol shall separately be assigned ordinal numbers according to increasing port numbers. +4. If IP flows are removed from an existing session, the previously assigned binding info shall remain unmodified for the remaining IP flows. +5. If IP flows are added to an existing session, the previously assigned binding info shall remain unmodified and the new IP flows shall be assigned ordinal numbers following the rules 1. To 3., starting with the first previously unused ordinal number. The numbers freed in step 4. Shall not be reused. + +If the IP flows correspond to AF signalling (e.g. SIP signalling IP Flows), and no IP flow information is provided both the ordinal number of the media component and the IP flows shall be set to zero. In the case when the IP flow information of the AF signalling is provided, the ordinal number of the media component will be set to zero, and the ordinal number(s) of the IP flows shall follow the rules set above for the case when the UE and AF do not share an algorithm for a given application. + +### B.1.2 Derivation of Flow Identifiers from SDP + +#### B.1.2.1 Standard Procedure + +The procedure in Table B.1.2.1.1 shall be applied for SDP of "session" disposition type within SIP and for all SDP outside SIP. + +**Table B.1.2.1.1: Standard Procedure to derive Flow Identifiers from SDP** + +| The ordinal number of the position of the media component | The ordinal number of the IP flow(s) within the media component description | +|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The ordinal number of the position of the "m=" line in the SDP |

The ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing downlink destination port numbers, if downlink destination port numbers are available. For uplink or inactive unicast media IP flows, a downlink destination port number is nevertheless available, if SDP offer-answer according to RFC 3264 is used.

The ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing uplink destination port numbers, if no downlink destination port numbers are available.

| + +#### B.1.2.2 SDP with "early session" disposition type + +The procedure in Table B.1.2.2.1 shall be applied for SDP of "early session" disposition type within SIP. The "early session" disposition type is specified within IETF RFC 3959 [27]. + +**Table B.1.2.2.1: Procedure to derive Flow Identifiers from "early session" disposition SDP** + +| The ordinal number of the position of the media component | The ordinal number of the IP flow(s) within the media component description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| +|

If a single media component with one media type (e.g. "audio" or "video") is contained in "early session" disposition SDP and a single media component with the same media type is contained in the "session" disposition SDP of the same SIP dialogue, and if both SDP media components are described in a single Rx service information media component, that Rx service information media component shall obtain the media component number derived from "session" disposition SDP following the rules in table B.1.2.1.1.

Otherwise each media component shall obtain the ordinal number of the position of the "m=" line in the "early session" disposition SDP plus 1000 as media component ordinal number.

| As in table B.1.2.1.1. | + +## B.2 Example 1 + +An UE, as the offerer, sends a SDP session description, as shown in table B.2.1, to an application server (only relevant SDP parameters are shown): + +**Table B.2.1: The values of the SDP parameters sent by the UE in example 1.** + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| V=0
o=ecsreid 3262464865 3262464868 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A
s=MM01
i=One unidirectional audio media and one unidirectional video media and one bidirectional application | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +``` + +media +t=3262377600 3262809600 +m=video 50230 RTP/AVP 31 +c=IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +a=recvonly +m=audio 50330 RTP/AVP 0 +c=IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +a=sendonly +m=application 50430 udp wb +c=IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +a=sendrecv + +``` + +and receives the SDP parameters, as shown in table B.2.2, from the application server: + +**Table B.2.2: The values of the SDP parameters sent by the application server in example 1.** + +``` + +V=0 +o=ecsreid 3262464865 3262464868 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +s=MM01 +i=One unidirectional audio media and one unidirectional video media and one bidirectional application +media +t=3262377600 3262809600 +m=video 51372 RTP/AVP 31 +c=IN IP6 2001:0646:000A:03A7:02D0:59FF:FE40:2014 +a=sendonly +m=audio 49170 RTP/AVP 0 +c=IN IP6 2001:0646:000A:03A7:02D0:59FF:FE40:2014 +a=recvonly +m=application 32416 udp wb +c=IN IP6 2001:0646:000A:03A7:0250:DAFF:FE0E:C6F2 +a=sendrecv + +``` + +From this offer-answer exchange of SDP parameters the UE and the PCRF each creates a list of flow identifiers comprising the IP flows as shown in table B.2.3: + +**Table B.2.3: Flow identifiers in example 1.** + +| Order of 'm='-line | Type of IP flows | Destination IP address / Port number of the IP flows | Flow identifier | +|--------------------|----------------------|------------------------------------------------------|-----------------| +| 1 | RTP (Video) DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50230 | <1,1> | +| 1 | RTCP DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50231 | <1,2> | +| 1 | RTCP UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 51373 | <1,2> | +| 2 | RTP (Audio) UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 49170 | <2,1> | +| 2 | RTCP DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50331 | <2,2> | +| 2 | RTCP UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 49171 | <2,2> | +| 3 | UDP (application) DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50430 | <3,1> | +| 3 | UDP (application) UL | 2001:0646:000A:03A7:0250:DAFF:FE0E:C6F2 / 32416 | <3,1> | + +## B.3 Example 2 + +In the general case, multiple ports may be specified with a "number of ports" qualifier as follows, RFC 2327 [17]: + +``` + +m= / + +``` + +An UE, as the offerer, sends a SDP session description, as shown in table B.3.1, to an application server (only relevant SDP parameters are shown): + +**Table B.3.1: The values of the SDP parameters sent by the UE in example 2.** + +``` + +v=0 +o=ecsreid 3262464321 3262464325 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +s=MM02 +i=One unidirectional audio media consisting of two media IP flows described by one media +component +t=3262377600 3262809600 +m=audio 50330/2 RTP/AVP 0 +c=IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +a=recvonly + +``` + +and receives the SDP parameters, as shown in table B.3.2, from the application server: + +**Table B.3.2: The values of the SDP parameters sent by the application server in example 2.** + +``` + +v=0 +o=ecsreid 3262464321 3262464325 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +s=MM02 +i=One unidirectional audio media consisting of two media IP flows described by one media +component +t=3262377600 3262809600 +m=audio 49170/2 RTP/AVP 0 +c=IN IP6 2001:0646:000A:03A7:02D0:59FF:FE40:2014 +a=sendonly + +``` + +From this offer-answer exchange of SDP parameters the UE and the PCRF each creates a list of flow identifiers comprising the IP flows as shown in table B.3.3: + +**Table B.3.3: Flow identifiers in example 2.** + +| Order of 'm='-line | Type of IP flows | Destination IP address / Port number of the IP flows | Flow identifier | +|--------------------|------------------|------------------------------------------------------|-----------------| +| 1 | RTP (audio) DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50330 | <1,1> | +| 1 | RTCP DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50331 | <1,2> | +| 1 | RTCP UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 49171 | <1,2> | +| 1 | RTP (audio) DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50332 | <1,3> | +| 1 | RTCP DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50333 | <1,4> | +| 1 | RTCP UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 49173 | <1,4> | + +## B.4 Example 3 without media components. + +The UE and AF do not exchange SDP for an application and do not share an algorithm, which guarantees that UE and AF assign the same ordinal number to each media component. + +At the AF session initiation, the UE and AF agree to set up the following IP flows: + +- Uplink UDP flow with destination port 100. +- Downlink UDP flow with destination port 100. +- Downlink TCP flow with destination port 100. +- Uplink TCP flow with destination port 100. +- Uplink UDP flow with destination port 200. + +The following binding info is assigned to these IP flows. + +- Uplink UDP flow with destination port 100: (0, 2) +- Downlink UDP flow with destination port 100: (0, 5) +- Downlink TCP flow with destination port 100: (0, 4) +- Uplink TCP flow with destination port 100: (0, 1) +- Uplink UDP flow with destination port 200: (0, 3) + +At a later stage in the session, the TCP IP flows are removed and the following IP flows are added: + +- Uplink UDP flow with destination port 150. +- Downlink UDP flow with destination port 50. + +The following binding info is assigned to the IP flows existing at this stage: + +- Uplink UDP flow with destination port 100: (0, 2) +- Downlink UDP flow with destination port 100: (0, 5) +- Uplink UDP flow with destination port 200: (0, 3) +- Uplink UDP flow with destination port 150: (0, 6) +- Downlink UDP flow with destination port 50: (0, 7) + +## B.5 Example 4 + +In this example, the SDP "a=rtcp" attribute defined in IETF RFC 3605 is used. + +An UE, as the offerer, sends a SDP session description, as shown in table B.5.1, to an application server (only relevant SDP parameters are shown): + +**Table B.5.1: The values of the SDP parameters sent by the UE in example 1.** + +``` +V=0 +o=ecsreid 3262464865 3262464868 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +s=MM01 +i=One unidirectional video media +t=3262377600 3262809600 +m=video 50230 RTP/AVP 31 +c=IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +a=recvonly +a=rtcp: 49320 +``` + +and receives the SDP parameters, as shown in table B.5.2, from the application server: + +**Table B.5.2: The values of the SDP parameters sent by the application server in example 1.** + +``` +V=0 +o=ecsreid 3262464865 3262464868 IN IP6 2001:0646:00F1:0045:02D0:59FF:FE14:F33A +s=MM01 +i=One unidirectional video media +t=3262377600 3262809600 +m=video 51372 RTP/AVP 31 +c=IN IP6 2001:0646:000A:03A7:02D0:59FF:FE40:2014 +``` + +| | +|----------------------------| +| a=sendonly
a=rtcp:53020 | +|----------------------------| + +From this offer-answer exchange of SDP parameters the UE and the PCRF each creates a list of flow identifiers comprising the IP flows as shown in table B.5.3: + +**Table B.5.3: Flow identifiers in example 4.** + +| Order of 'm='-line | Type of IP flows | Destination IP address / Port number of the IP flows | Flow identifier | +|--------------------|------------------|------------------------------------------------------|-----------------| +| 1 | RTP (Video) DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 50230 | <1,2> | +| 1 | RTCP DL | 2001:0646:00F1:0045:02D0:59FF:FE14:F33A / 49320 | <1,1> | +| 1 | RTCP UL | 2001:0646:000A:03A7:02D0:59FF:FE40:2014 / 53020 | <1,1> | + +--- + +Annex C (informative): +Void + +# --- Annex D (normative): Monitoring Related SCEF Procedures over Rx + +## D.1 Monitoring events support, using SCEF procedures over Rx + +If SCS/AS has requested monitoring of events and operator policies in the SCEF indicate that monitoring shall be performed via PCRF, the SCEF shall initiate the applicable Rx procedures acting as an AF as described in 3GPP TS 23.682 [40]. + +The following monitoring events are supported; + +- Location reporting according to the Access Network Information Report procedures described in clause 4.4.6.7. This functionality requires the support of NetLoc, NetLoc-Untrusted-WLAN and/or NetLoc-Trusted-WLAN supported features. +- Communication Failure reporting as described in clauses 4.4.4, 4.4.6.2 and 4.4.6.3. This functionality requires the support of RAN-NAS-Cause supported feature. + +# --- Annex E (normative): Interworking with 5GS via Rx interface + +## E.1 General + +In the 5GS the Rx reference point is defined between the the PCF and the AF. The relationship between the involved functional entities is depicted in figure E.1.1. The overall PCC architecture is depicted in clause 4 of 3GPP TS 29.513 [59]. + +![Diagram of the Rx reference model in 5GS. It shows two rectangular boxes, 'AF' on the left and 'PCF' on the right, connected by a horizontal line labeled 'Rx' above it.](cdd0f1dd36631f2c4b17d7ca0f174d80_img.jpg) + +``` +graph LR; AF[AF] ---|Rx| PCF[PCF] +``` + +Diagram of the Rx reference model in 5GS. It shows two rectangular boxes, 'AF' on the left and 'PCF' on the right, connected by a horizontal line labeled 'Rx' above it. + +**Figure E.1.1: Rx reference model in 5GS** + +5GS supports an interworking with AFs via the Rx interface. Interworking with AFs related to existing IMS services is described in 3GPP TS 23.228 [16]. Interworking with AFs related to existing Mission Critical services is described in TS 23.280 [60]. The PCF in 5GS supports the corresponding Rx procedures and requirements defined in 3GPP TS 23.203 [2]. The stage 2 requirements for 5GS supporting Rx interface are described in 3GPP TS 23.503 [56]. + +The PCF exchanges PCC rules with the SMF over the N7 interface as specified in 3GPP TS 29.512 [57]. + +Signalling flows related to the both Rx and N7 interfaces are specified in 3GPP TS 29.513 [59]. + +The generic mechanisms for interaction between the AF and the PCF are described in main clauses in this specification and with the following clarifications: + +- description of the PCRF and the PCEF applies to the PCF and the SMF respectively; +- description of the SPR applies to the UDR; +- BBERF is not applicable in 5GS; +- an IP-CAN bearer in this specification shall be interpreted as a 5GS QoS flow; + +- an IP-CAN session in this specification shall be interpreted as a 5GS PDU session of type IP; +- APN is equivalent to DNN; +- the following values of the Specific-Action AVP defined in clause 5.3.13 are applicable only to a PCF: EPS\_FALLBACK (17) and INDICATION\_OF\_REALLOCATION\_OF\_CREDIT (18); +- when the serving network is an SNPN and the serving network information is provided to the AF, the NID may optionally be part of the serving network identifier, as specified in clause E.5; and +- the 5G-RAN-NAS-Release-Cause AVP defined in clause 5.3.69 is applicable only to a PCF. When the RAN-NAS-Cause feature is supported, it encodes the 5GS RAN cause and/or NAS cause, when available. + +The specific mechanisms for the interaction between the AF and the PCF are described in the subclauses below. + +## E.2 Mapping table for IP-CAN types and Access types + +Table E.2-1 maps the values of the Access types and RAT types used for N7 interface in 3GPP TS 29.512 [58] with the values of the IP-CAN types and RAT types used in this specification. + +**Table E.2-1: Mapping table for IP-CAN types and Access types values** + +| AccessType specified for N7, see 3GPP TS 29.571 [64] clause 5.4.3.1 | RatType specified for N7, see 3GPP TS 29.571 [64] clause 5.4.3.2 (NOTE 1) | RAT-Type, see 3GPP TS 29.212 [8] clause 5.3.31 | | IP-CAN-Type, see 3GPP TS 29.212 [8] clause 5.3.27 | | +|---------------------------------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------|-----------------|---------------------------------------------------|--------------| +| | | Value | Description | Value | Description | +| 3GPP_ACCESS | NR | 1006 | NR | 8 | 3GPP-5GS | +| | EUTRA | 1004 | EUTRAN | | | +| | NBIOT | 1005 | EUTRAN-NB-IoT | | | +| | LTE M | 1007 | LTE-M | | | +| | NR U | 1008 | NR-U | | | +| | NR LEO | 1035 | NR(LEO) | | | +| | NR MEO | 1036 | NR(MEO) | | | +| | NR GEO | 1037 | NR(GEO) | | | +| | NR_OTHER_SAT | 1038 | NR(OTHERSAT) | | | +| | NR REDCAP | 1039 | NR-REDCAP | | | +| NON_3GPP_ACCESS | WLAN | 0 | WLAN (NOTE 2) | 9 | Non-3GPP-5GS | +| | VIRTUAL | 1 | VIRTUAL | | | +| | TRUSTED_N3GA | 2 | TRUSTED-N3GA | | | +| | TRUSTED_WLAN | 0 | WLAN (NOTE 2) | | | +| | WIREDLINE | 3 | WIREDLINE | | | +| | WIREDLINE_CABLE | 4 | WIREDLINE-CABLE | | | +| | WIREDLINE_BBF | 5 | WIREDLINE-BBF | | | + +NOTE 1: Other values of RAT Types specified in 3GPP TS 29.571 [64] and not shown in this table are not applicable to this specification. + +NOTE 2: When the received RAT Type in N7 indicates "WLAN", the AN-Trusted AVP set to "Untrusted" indicates the access type is not trusted. When the received RAT Type in N7 indicates "TRUSTED\_WLAN", the AN-Trusted AVP set to "Trusted" indicates the access type is trusted. + +## E.3 Reporting EPS Fallback + +When the feature "EPSFallbackReport" is supported, if the AF requests the PCF to report EPS Fallback, the AF shall subscribe to the "EPS\_FALLBACK" within the Specific-Action AVP as described in clause 5.3.13. The AF shall request the PCF to report the EPS Fallback in conjunction with providing the PCF with the AF session information as described in clause 4.4.1 for the initial provisioning of session information, and the subscription to "EPS\_FALLBACK" shall apply for voice media type requests along the AF session lifetime. + +When the PCF then receives the EPS Fallback indication from the SMF, the PCF shall provide the corresponding EPS Fallback indication to the AF by sending an RAR (re-authorization request) command. The RAR command shall include the EPS\_FALLBACK cause encoded in the Specific-Action AVP. + +When the AF receives the RAR command, it shall acknowledge the command by sending an RAA (re-authorization answer) command to the PCF. + +## --- E.4 IP-CAN type change Notification for a MA PDU session + +If the AF has successfully subscribed to change notifications in UE's IP-CAN type and RAT type, the ATSSS feature is supported and the PDU session is a MA PDU session: + +- if the PCF previously requested to the SMF to be updated with access type changes, the PCF shall include in the AAA command: + - i. the IP-CAN-Type AVP, RAT-Type AVP (if applicable) for the UE's IP-CAN/RAT type values; and + - ii. if both, 3GPP and non-3GPP access information is available, the additional IP-CAN type information and RAT type information (if available) in the MA-Information AVP; +- otherwise, the PCF shall subscribe to access type changes as described in clause 4.2.6.4 of 3GPP TS 29.512 [57] and shall send an RAR command when the corresponding IP-CAN event occurs, i.e.: + - a) when a UE's IP-CAN type or RAT type (if applicable) changes; or + - b) a new IP-CAN type and RAT type (if applicable) become available for the UE and the MA PDU session; or + - c) an IP-CAN type and RAT type (if applicable) become unavailable (are released) for the UE and the MA PDU session. + +The RAR from the PCF shall include the Specific-Action AVP for the subscribed event and: + +- a. if it is the first IP-CAN change report: + - i. the IP-CAN-Type AVP, RAT-Type AVP (if applicable) for the UE's IP-CAN/RAT type values; and + - ii. if both, 3GPP and non-3GPP access information is available, the additional IP-CAN type information and RAT type information (if available) in the MA-Information AVP; +- b. if it is a subsequent IP-CAN change report: + - i. if a new IP-CAN type is added to the MA PDU session, the MA-Information AVP with the added IP-CAN type information encoded in the IP-CAN-Type AVP and the RAT type information encoded within the RAT-Type AVP if applicable; + - ii. if an IP-CAN type is released in the MA PDU session, the MA-Information AVP with the released IP-CAN type information encoded in the IP-CAN-Type AVP, the RAT type information encoded within the RAT-Type AVP, if applicable, and the MA-Information-Action AVP set to 1 (RELEASE). + +NOTE: For a MA PDU session, if the ATSSS feature is not supported by the AF the PCF includes the IP-CAN-Type AVP and the RAT-Type AVP with a currently active combination of IP-CAN type and RAT type (if applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +## --- E.5 Reporting serving network identity + +When a new AF session is being established as described in clause 4.4.1 or is being modified as described in clause 4.4.2, the AAA command shall also contain the PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP and, if available, the NID within the NID AVP if the PCF has previously requested the SMF to be updated with the serving network identity. + +NOTE: The combination of a PLMN identifier and a NID identifies an SNPN, as specified in 3GPP TS 23.501 [55] clause 5.30.2. + +When the AF initiates a session termination, the PCF shall include in the STA command the PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP and, if available, the NID within the NID AVP: + +- if the PCF received an ST-Request from the AF, indicating an AF session termination and if location info is not available, as specified in clause 4.4.4; and +- if the AF requested the PCF to report the access network information, the Rx session is being terminated and if location info is not available, as specified in clause 4.4.6.7. + +When the PCF needs to inform the AF about a traffic plane event, the PCF shall include in the RAR command the PLMN identifier within the 3GPP-SGSN-MCC-MNC AVP and, if available, the NID within the NID AVP: + +- when the PCF gets the knowledge that one or more SDFs have been deactivated, if the RAN-NAS-Cause feature is supported and if location info is not available, as specified in clause 4.4.6.2; +- when the PCF is notified of the loss or release of resources associated to the PCC rules corresponding with AF signalling IP flows, if the RAN-NAS-Cause feature is supported and if location info is not available, as specified in clause 4.4.6.3; +- if the AF requested the PCF to report the access network information, the Rx session is not being terminated and if location info is not available, as specified in clause 4.4.6.7; and +- when the PCF gets the knowledge that the service network where the UE is located has been updated or becomes available and the AF subscribed to PLMN\_CHANGE has described in clause 4.4.6.9. + +## --- E.6 Trusted non-3GPP Access Network Information + +The PCF provides the AF with the access network information as described in clause 4.4.1, with the following differences: + +- The RAT-Type AVP shall be set to "WLAN" and AN-Trusted AVP shall be set to "Trusted" when over the N7 reference point: + - a) the received "ratType" attribute is "TRUSTED\_WLAN"; or + - b) the received "ratType" attribute is "TRUSTED\_N3GA" and the "Netloc-Trusted-N3GA" feature is not supported. +- The RAT-Type AVP shall be set to "TRUSTED-N3GA" when the "Netloc-Trusted-N3GA" feature is supported and the received "ratType" attribute over the N7 reference point is "TRUSTED\_N3GA". + +If the NetLoc-Trusted-WLAN is supported, the procedure described in clauses 4.4.4 and 4.4.6.7 shall apply with the exceptions specified in clause E.1 and with the exception of the user location information that is encoded as follows: + +- a) The TNAP/TWAP Identifier received over the N7 reference point in the "tnapId"/"twapId" attributes of the "n3gaLocation" attribute, if available, is encoded in the TWAN-Identifier AVP. + +NOTE 1: The received SSID, BSSID and Civic Address values, if available, are encoded within the TWAN-Identifier AVP as specified in 3GPP TS 29.061 [34]. + +- b) The UE/N5CW device local IP address (used to reach the TNGF/TWIF) received over the N7 reference point in the "ueIpv4Addr" or "ueIpv6Addr" attribute of the "n3gaLocation" attribute, if available, is encoded in the UE-Local-IP-Address AVP. +- c) The UDP source port number received over the N7 reference point in the "portNumber" attribute if available, is encoded within the UDP-Source-Port AVP + +NOTE 2: The UDP protocol can be used between the UE and TNGF to enable NAT traversal. When reporting IP-CAN\_CHANGE specific action, the PCF shall, in addition to the IP-CAN-Type AVP and RAT-Type AVP, provide the AN-Trusted AVP set to "Trusted" when the provided RAT-Type AVP value is "WLAN". + +## E.7 Untrusted non-3GPP Access Network Information + +The PCF provides the AF with the access network information as described in clause 4.4.1, with the following differences: + +- The RAT-Type AVP shall be set to "WLAN" and AN-Trusted AVP shall be set to "Untrusted" when over the N7 reference point the received "ratType" attribute is "WLAN". +- The ePDG address used as IPSec tunnel endpoint with the UE, received over the N7 reference point within the "anGwAddr" attribute included in the "servNfId" attribute, is encoded in the AN-GW-Address AVP. +- The serving network identifier received over the N7 reference point within the "servingNetwork" attribute is encoded in the 3GPP-SGSN-MCC-MNC AVP. + +If the NetLoc-Untrusted-WLAN feature is supported, reporting access network information procedure described in clauses 4.4.4 and 4.4.6.7 shall apply with the exceptions specified in clause E.1 and with the exception of: + +- The user location information is encoded as follows: + - a) The UE local IP address (used to reach the N3IWF or ePDG) received over the N7 reference point in the "ueIpv4Addr" or "ueIpv6Addr" attribute of the "n3gaLocation" attribute, if available, is encoded in the UE-Local-IP-Address AVP. + - b) The UDP source port or the TCP source port received over the N7 reference point in the "portNumber" attribute if available, is encoded within the UDP-Source-Port AVP or the TCP-Source-Port AVP as indicated by the "protocol" attribute, if available. + +NOTE 1: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute received over the N7 reference point. + +- c) The WLAN location information received in the "twapId" attribute of the "n3gaLocation" attribute, if available, is encoded in the TWAN-Identifier AVP. +- The UE time zone information is included within 3GPP-MS-TimeZone AVP, if available. + +NOTE 2: EPC does not support time zone reporting when the access network is untrusted WLAN. + +When reporting IP-CAN\_CHANGE specific action, the PCF shall, in addition to the IP-CAN-Type AVP and RAT-Type AVP, provide the AN-Trusted AVP set to "Untrusted". The PCF provides also the AF with the ePDG IP address used as IPSec tunnel endpoint with the UE, if received, encoded in the AN-GW-Address AVP. + +## E.8 Wireline non-3GPP Access Network Information + +The PCF provides the AF with the wireline access network information as described in clause 4.4.1, with the following differences: + +- The RAT-Type AVP shall be set to "WIRELINE", "WIRELINE\_CABLE" or "WIRELINE\_BBF" according to the received "ratType" attribute. + +If the NetLoc-Wireline is supported, the procedure described in clauses 4.4.4 and 4.4.6.7 shall apply with the exceptions specified in clause E.1 and the exception of the user location information that is encoded as follows: + +- The wireline location is encoded in the Wireline-User-Location-Info AVP, where: + - a) The HFC Node Identifier received over NGAP in the "hfcNodeId" attribute of the "n3gaLocation", if available, is encoded in the HFC-Node-Identifier AVP. + - b) The Global Line Identifier in the "gli" attribute of the "n3gaLocation", if available, is encoded in the GLI-Identifier AVP. + - c) The type of wireline access in the "w5gbnLineType" attribute of the "n3gaLocation", if available, is encoded in the Line-Type AVP. + +## E.9 5GS-Level Identities report + +The PCF provides 5GS-Level Identities as defined in annex A.1 and A.5 with the following differences: + +- the IMSI is included within the Subscription-Id AVP if the IMSI is received within the "supi" attribute; +- the MSISDN is included within the Subscription-Id AVP if the MSISDN is received within the "gpsi" attribute; +- the NAI is included within the Subscription-Id AVP if the NAI is received within the "supi" attribute; +- the IMEISV is included with the User-Equipment-Info AVP if the IMEISV is received within the "pei" attribute; +- the IMEI is included with the the User-Equipment-Info-Extension AVP if the User-Equipment-Info-Extension feature is supported and the IMEI is received within the "pei" attribute. + +NOTE 1: UE identities for wireless and wireline convergence access are not considered to be used for the IMS. + +NOTE 2: When the UE accesses a PLMN, the PCF provides the IMSI and the MSISDN within the Subscription-Id AVP(s), if available. When the UE accesses a SNPN, the PCF provides the IMSI or the NAI, and the MSISDN within the Subscription-Id AVP(s), if available. For both, SNPN and PLMN accesses, the PCF provides the IMEI(SV) in the concerned AVP(s) as specified above. + +## E.10 Reporting Access Network Information + +When the PCF receives the access network information, the PCF shall provide the corresponding access network information to the AF as defined in clause 4.4.6.7, + +When the AF requested UE location, the PCF shall forward both, the received 3GPP access (NR or E-UTRA) and non-3GPP access (Trusted, Untrusted, or Wireline network) UE location, if available. + +The PCF encodes 3GPP UE location received in the "eutraLocation" or "nrLocation" attribute into the 3GPP-User-Location-Info AVP as described in 3GPP TS 29.061 [34]. + +The PCF encodes the non-3GPP Trusted, Untrusted or Wireline access UE location as described in clauses E.6, E.7 and E.8. When the PCF received the "userLocationInfoTime" attribute, the PCF includes the User-Location-Info-Time AVP in the access network report to the AF to indicate when the UE location was last known. + +NOTE: When the PCF receives both, the 3GPP and non-3GPP access UE locations, the "userLocationInfoTime" attribute, if received, indicates the last known 3GPP access UE location, and consequently, the User-Location-Info-Time AVP also indicates the last known 3GPP access UE location. + +## E.11 Access Network Charging Information Notification + +When the PCF receives the access network charging information, the PCF shall provide the corresponding access network information to the AF as defined in clause 4.4.6.5. + +If the PCF received from the SMF both, the IPv4 and IPv6 addresses within the "anChargIpv4Addr" and "anChargIpv6Addr" attributes respectively, the PCF may select, based on local configuration, one of the received addresses and report it within the Access-Network-Charging-Address AVP. + +## E.12 3GPP Access Network Information + +The PCF provides the AF with the access network information as described in clause 4.4.1 by including the mapped RAT Type within the RAT-Type AVP according to Table E.2-1. + +If the NetLoc is supported, the procedure described in clauses 4.4.4 and 4.4.6.7 shall apply with the exceptions specified in clause E.1 and with the exception of the user location information that is encoded as follows: + +- a) The TAI and NCGI received over the N7 reference point in the "tai" attribute and "ncgi" attribute of the "nrLocation" attribute respectively, if available, are encoded in the 3GPP-User-Location AVP; or +- b) The TAI and ECGI received over the N7 reference point in the "tai" attribute and "ecgi" attribute of the "eutraLocation" attribute respectively, if available, are encoded in the 3GPP-User-Location AVP. + +## Annex F (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +|---------|-------|-----------|------|-----|---------------------------------------------------------------------------------------|--------|--------| +| 12-2014 | CT-66 | CP-140922 | 0361 | 1 | UPCON related update about definition, abbreviation and architecture part | 12.5.0 | 13.0.0 | +| 12-2014 | CT-66 | CP-140935 | 0364 | 3 | Double resource reuse support over Rx | 12.5.0 | 13.0.0 | +| 12-2014 | CT-66 | CP-140934 | 0365 | 2 | Mitigating RAN user plane congestion over Rx | 12.5.0 | 13.0.0 | +| 03-2015 | CT-67 | CP-150131 | 0370 | | Reporting RAN/NAS cause during bearer creation/modification failure scenarios | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150134 | 0371 | | Removal of Editor's Note | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150131 | 0372 | | Access network information reporting during the IP-CAN session termination | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150136 | 0373 | | Introduction of a reference to the Rest-Rx interface | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150131 | 0374 | | Inclusion of RAN/NAS cause values into SIP signalling by P-CSCF | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150101 | 0380 | | Correction to the usage monitoring control for sponsored data connectivity | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150104 | 0383 | 2 | Access network information report in case of IP-CAN bearer/IP-CAN session termination | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150136 | 0386 | 1 | Correction to temporary network failure handling | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150114 | 0388 | | TWAN supports access network information report | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150127 | 0389 | 2 | Uniqueness of Sharing Key for resource sharing over Rx | 13.0.0 | 13.1.0 | +| 03-2015 | CT-67 | CP-150133 | 0394 | 2 | Add the ToS-Traffic-Class AVP to the Rx to be sent by AF | 13.0.0 | 13.1.0 | +| 06-2015 | CT-68 | CP-150362 | 0390 | 3 | Clarification of the Called-Station-Id | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150361 | 0395 | 1 | Removing restrictions to report RAT type to the AF | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150356 | 0396 | 2 | Alignment with SDP procedures for resource sharing | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150363 | 0398 | 1 | Adding TWAN and untrusted WLAN release cause | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150356 | 0399 | - | Sharing-Key-UL | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150344 | 0405 | 2 | Non-3GPP access for 3GPP-SGSN-MCC-MNC | 13.1.0 | 13.2.0 | +| 06-2015 | CT-68 | CP-150362 | 0406 | - | Correcting Hanging Paragraphs | 13.1.0 | 13.2.0 | +| 09-2015 | CT-69 | CP-150485 | 0401 | 4 | Clarification of the IP-Domain-Id | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150476 | 0408 | 2 | Corrections to the PCRF-based P-CSCF Restoration Enhancement | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150472 | 0410 | - | AVPs applicability for RAN-NAS-Cause | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150480 | 0411 | 1 | Events applicability to support monitoring | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150482 | 0412 | 2 | Change of chargeable party when sponsor connectivity applies | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150476 | 0415 | 1 | Correction to the P-CSCF restoration enhancement | 13.2.0 | 13.3.0 | +| 09-2015 | CT-69 | CP-150468 | 0421 | 2 | Fixing Ambiguous Flag Rules for AVPs reused from TS 29.061 | 13.2.0 | 13.3.0 | +| 12-2015 | CT-70 | CP-150797 | 0422 | 1 | Update the PCC architecture figures in 29.214 | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150666 | 0423 | 1 | RTP/RTCP transport multiplexing | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150663 | 0424 | 2 | Support of new bandwidth information over Rx | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150789 | 0425 | - | Incorrect command name to request access network information | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150631 | 0427 | 1 | Update the reference of draft-ietf-dime-ovli | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150730 | 0428 | 1 | Diameter message priority for PCC i | 13.3.0 | 13.4.0 | +| 12-2015 | CT-70 | CP-150668 | 0432 | 2 | Location report to support emergency service in Untrusted WLAN access | 13.3.0 | 13.4.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-03 | CT#71 | CP-160095 | 0435 | 2 | F | Rx impact for background data transfer | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0436 | - | F | ICSI format specification over Rx | 13.5.0 | +| 2016-03 | CT#71 | CP-160100 | 0437 | 3 | A | Reporting of NAS/RAN cause in the STA command | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0438 | 2 | F | RAN-NAS-Cause handling upon unsuccessful bearer termination over Rx | 13.5.0 | +| 2016-03 | CT#71 | CP-160092 | 0441 | 1 | B | UE-to-network relay PCC handling over Rx | 13.5.0 | +| 2016-03 | CT#71 | CP-160101 | 0442 | 1 | F | Support of removed filters when SIP Forking applies over Rx | 13.5.0 | +| 2016-03 | CT#71 | CP-160094 | 0443 | - | F | Missing experimental result code value | 13.5.0 | +| 2016-03 | CT#71 | CP-160104 | 0444 | - | F | Location reporting for IMS sessions over S2b | 13.5.0 | +| 2016-03 | CT#71 | CP-160093 | 0446 | 2 | B | Reservation-Priority AVP and DRMP AVP Interaction | 13.5.0 | +| 2016-03 | CT#71 | CP-160087 | 0448 | 2 | B | New clause to Appendix A for the handling of MCPTT emergency calls | 13.5.0 | +| 2016-06 | CT#72 | CP-160282 | 0450 | 2 | F | Support of IP version as part of the enhanced bandwidth mechanisms for MTSI sessions | 13.6.0 | +| 2016-06 | CT#72 | CP-160287 | 0451 | 4 | F | Priority sharing for concurrent sessions | 13.6.0 | +| 2016-06 | CT#72 | CP-160271 | 0453 | 1 | F | Reuse of TWAN-Identifier AVP in the Untrusted WLAN Access | 13.6.0 | +| 2016-06 | CT#72 | CP-160275 | 0455 | - | A | Correction to the time-based usage monitoring for sponsored data connectivity | 13.6.0 | +| 2016-06 | CT#72 | CP-160251 | 0456 | 4 | F | Authorization based on transfer policy | 13.6.0 | +| 2016-06 | CT#72 | CP-160251 | 0457 | 1 | F | Correction to the usage monitoring when the sponsoring is disabled | 13.6.0 | +| 2016-06 | CT#72 | CP-160251 | 0458 | 2 | F | Code of Sponsoring-Action AVP | 13.6.0 | +| 2016-06 | CT#72 | CP-160263 | 0459 | 1 | F | Correction to MCPTT priority call handling | 13.6.0 | +| 2016-06 | CT#72 | CP-160276 | 0461 | - | F | Inclusion of Transient failure code | 13.6.0 | +| 2016-06 | CT#72 | CP-160274 | 0449 | 3 | B | Clarification on the gate control procedure over Rx interface | 14.0.0 | +| 2016-06 | CT#72 | CP-160274 | 0452 | 2 | B | Report of modification failure over Rx reference point | 14.0.0 | +| 2016-09 | CT#73 | CP-160461 | 0463 | 2 | A | Addition of UDP/TCP port and ePDG address as untrusted WLAN location information | 14.1.0 | +| 2016-09 | CT#73 | CP-160445 | 0467 | 1 | A | Disabling/removing priority sharing for media flow | 14.1.0 | +| 2016-09 | CT#73 | CP-160442 | 0469 | - | A | Correction of IETF drmp draft version | 14.1.0 | +| 2016-09 | CT#73 | CP-160458 | 0471 | 2 | A | IP-CAN type and RAT type report over Rx | 14.1.0 | +| 2016-09 | CT#73 | CP-160452 | 0472 | - | F | Correction of the reference name for UMTS | 14.1.0 | +| 2016-09 | CT#73 | CP-160452 | 0473 | - | F | Gate control procedures based on the configuration in the P-CSCF | 14.1.0 | +| 2016-09 | CT#73 | CP-160444 | 0475 | 1 | A | PCRF authorization when the transfer policy has not been valid | 14.1.0 | +| 2016-09 | CT#73 | CP-160444 | 0477 | 1 | A | Transfer policy expires when the session is ongoing | 14.1.0 | +| 2016-09 | CT#73 | CP-160456 | 0480 | 1 | B | Subscription to notification of PLMN id change over Rx | 14.1.0 | +| 2016-09 | CT#73 | CP-160463 | 0481 | 1 | B | Support of sponsored data connectivity for TDF | 14.1.0 | +| 2016-12 | CT#74 | CP-160636 | 0484 | 4 | A | Remove "same media type" requirement for Priority Sharing | 14.2.0 | +| 2016-12 | CT#74 | CP-160615 | 0487 | 1 | B | Diameter Load Control Mechanism | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0488 | 1 | B | Support for subscription to changes to IP-CAN by P-CSCF for session setup | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0489 | 5 | B | Provision of EPC-level identities for IMS emergency sessions over Rx | 14.2.0 | +| 2016-12 | CT#74 | CP-160633 | 0490 | 1 | F | Inclusion of 3GPP-SGSN-MCC-MNC AVP in the AAA command | 14.2.0 | +| 2016-12 | CT#74 | CP-160625 | 0491 | 2 | B | PCC impacts due to multi-stream multiparty conferencing media handling | 14.2.0 | +| 2016-12 | CT#74 | CP-160622 | 0494 | 1 | A | Reference update draft-holmberg-dispatch-mcptt-rp-namespace | 14.2.0 | +| 2016-12 | CT#74 | CP-160628 | 0495 | 2 | B | AF triggers the activation of PCC/ADC rule with application identifier | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0497 | - | F | Enhance the description about Permanent Failures | 14.2.0 | +| 2016-12 | CT#74 | CP-160614 | 0500 | - | A | Correction to change IETF drmp draft version to official RFC 7944 | 14.2.0 | +| 2016-12 | CT#74 | CP-160616 | 0501 | 1 | F | Diameter base protocol specification update | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0502 | 6 | B | Handling of multiple Rx interactions for the same media component | 14.2.0 | +| 2016-12 | CT#74 | CP-160630 | 0503 | 1 | F | Correction to the usage of Media-Component-Status AVP | 14.2.0 | +| 2017-03 | CT#75 | CP-170081 | 0506 | - | A | Reference update draft-holmberg-dispatch-mcptt-rp-namespace | 14.3.0 | +| 2017-03 | CT#75 | CP-170076 | 0507 | 1 | F | Handling of Vendor-Specific-Application-Id AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170086 | 0509 | 3 | F | Network provided location information retrieval at SDP offer time for mobile terminating call | 14.3.0 | +| 2017-03 | CT#75 | CP-170086 | 0510 | 2 | F | Correction to the Media-Component-Status AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170081 | 0511 | 2 | C | Pre-emption control for priority sharing | 14.3.0 | +| 2017-03 | CT#75 | CP-170076 | 0512 | - | F | Update instance number for the Failed-AVP in answer commands | 14.3.0 | +| 2017-06 | CT#76 | CP-171119 | 0514 | 1 | F | Reference update for draft-ietf-dime-load | 14.4.0 | +| 2017-06 | CT#76 | CP-171133 | 0517 | 1 | F | Network provided location information retrieval at SDP offer time for mobile terminating call | 14.4.0 | +| 2017-06 | CT#76 | CP-171138 | 0518 | 1 | F | PCC Support of emergency IMS registration for S8HR cases | 14.4.0 | +| 2017-06 | CT#76 | CP-171128 | 0520 | - | A | Reference update draft-holmberg-dispatch-mcptt-rp-namespace | 14.4.0 | +| 2017-06 | CT#76 | CP-171133 | 0530 | 1 | F | Correction to pre-emption control for priority sharing | 14.4.0 | +| 2017-06 | CT#76 | CP-171133 | 1573 | 1 | F | Correction to the priority sharing | 14.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------|--------| +| 2017-06 | CT#76 | CP-171126 | 1576 | 2 | F | Updating references to align with rel-14 MCPTT stage 2 restructuring | 14.4.0 | +| 2017-06 | CT#76 | CP-171133 | 1577 | 2 | F | Correction to the supported feature value for MCPTT Pre-emption | 14.4.0 | +| 2017-06 | CT#76 | CP-171138 | 1579 | 2 | F | PCC Support of emergency IMS registration for S8HR cases | 14.4.0 | +| 2017-06 | CT#76 | CP-171136 | 1578 | 2 | F | Activate the transfer policy via chargeable party change procedure | 15.0.0 | +| 2017-09 | CT#77 | CP-172038 | 1580 | 1 | B | Extension of QoS values. | 15.1.0 | +| 2017-09 | CT#77 | CP-172042 | 1584 | - | A | NetLoc corrections in trusted WLAN. | 15.1.0 | +| 2017-09 | CT#77 | CP-172048 | 1587 | 1 | A | NetLoc corrections in untrusted WLAN. | 15.1.0 | +| 2017-09 | CT#77 | CP-172041 | 1590 | - | A | Correction for Monitoring Event support. | 15.1.0 | +| 2017-09 | CT#77 | CP-172051 | 1593 | 2 | F | Some corrections of 29.214. | 15.1.0 | +| 2017-12 | CT#78 | CP-173101 | 1596 | - | A | AN-GW-Address correction. | 15.2.0 | +| 2017-12 | CT#78 | CP-173103 | 1602 | - | F | Correction on Codec-Data AVP | 15.2.0 | +| 2018-03 | CT#79 | CP-180047 | 1602 | 3 | A | Clarification of Max-Requested-Bandwidth | 15.3.0 | +| 2018-03 | CT#79 | CP-180043 | 1607 | - | A | Timezone correction for NetLoc in untrusted WLAN | 15.3.0 | +| 2018-03 | CT#79 | CP-180037 | 1608 | 1 | B | Extending the TS scope to cover 5GS impacts | 15.3.0 | +| 2018-03 | CT#79 | CP-180037 | 1609 | 1 | B | Policy and Charging Control over Rx interface in the 5GS | 15.3.0 | +| 2018-03 | CT#79 | CP-180045 | 1612 | 2 | A | Erroneous M bit setting on Supported-Features | 15.3.0 | +| 2018-06 | CT#80 | CP-181023 | 1613 | 1 | F | Definition of Bit Rate | 15.4.0 | +| 2018-06 | CT#80 | CP-181019 | 1614 | 3 | B | Support for volume based charging of IMS services | 15.4.0 | +| 2018-06 | CT#80 | CP-181013 | 1616 | 1 | B | Updates to 3GPP-User-Location-Info AVP | 15.4.0 | +| 2018-06 | CT#80 | CP-181171 | 1618 | 1 | A | Support priority for MCVideo services | 15.4.0 | +| 2018-12 | CT#82 | CP-183118 | 1622 | 1 | F | Removal of editor's note on Volume Based Charging | 15.5.0 | +| 2019-03 | CT#83 | CP-190118 | 1623 | 2 | F | The mapping of Access-Type with IP-CAN-Type | 15.6.0 | +| 2019-09 | CT#85 | CP-192154 | 1626 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.7.0 | +| 2019-09 | CT#85 | CP-192164 | 1624 | 1 | B | Support for Restricted Local Operator Services | 16.0.0 | +| 2019-12 | CT#86 | CP-193215 | 1628 | 6 | B | Coverage and Handover Enhancements for Media (CHEM) | 16.1.0 | +| 2019-12 | CT#86 | CP-193221 | 1631 | 5 | B | Adding Caller and Callee information | 16.1.0 | +| 2020-03 | CT#87e | CP-200215 | 1632 | 1 | B | Support of Framework for Live Uplink Streaming (FLUS) in Rx interface | 16.2.0 | +| 2020-03 | CT#87e | CP-200231 | 1635 | 1 | B | Report of EPS Fallback | 16.2.0 | +| 2020-03 | CT#87e | CP-200201 | 1636 | 2 | B | 5G SRVCC impacts on Rx | 16.2.0 | +| 2020-06 | CT#88e | CP-201245 | 1639 | - | A | Missing annex A.10.5 (network provided location information at SIP session release) | 16.3.0 | +| 2020-06 | CT#88e | CP-201229 | 1640 | 3 | B | Access Type Report for a MA PDU session | 16.3.0 | +| 2020-06 | CT#88e | CP-201245 | 1642 | 2 | A | Clarification on FlowDescription | 16.3.0 | +| 2020-06 | CT#88e | CP-201246 | 1643 | 1 | B | Support of applications with specific QoS hints | 16.3.0 | +| 2020-06 | CT#88e | CP-201269 | 1644 | 1 | B | Reallocation of credit reporting to the AF | 16.3.0 | +| 2020-06 | CT#88e | CP-201252 | 1646 | 2 | B | Providing NID to the P-CSCF | 16.3.0 | +| 2020-09 | CT#89e | CP-202051 | 1648 | 1 | A | Correction to RAN-NAS Release Cause feature | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 1649 | 1 | F | Correction to E.2 | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 1650 | 1 | F | Support of 5GS non-3GPP Trusted Access | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 1651 | 1 | F | Support of 5GS Wireline Access | 16.4.0 | +| 2021-06 | CT#92e | CP-211253 | 1653 | 3 | B | IMEI over Rx reference point | 17.0.0 | +| 2021-06 | CT#92e | CP-211226 | 1654 | 3 | B | AF Session for Control of MPS for DTS | 17.0.0 | +| 2021-06 | CT#92e | CP-211254 | 1655 | - | F | Correction to Netloc-Untrusted-WLAN | 17.0.0 | +| 2021-09 | CT#93e | CP-211254 | 1656 | 1 | B | 29.214 Authorization for MPS for DTS | 17.1.0 | +| 2021-09 | CT#93e | CP-212201 | 1657 | 1 | B | 5GS-Level UE identities | 17.1.0 | +| 2021-09 | CT#93e | CP-212224 | 1658 | - | F | Clarification of resource allocation failure | 17.1.0 | +| 2021-09 | CT#93e | CP-212224 | 1661 | 1 | F | Report of 3GPP and non-3GPP user location | 17.1.0 | +| 2021-09 | CT#93e | CP-212200 | 1663 | 1 | A | Support of TCP and UDP ports in non-3GPP UE location | 17.1.0 | +| 2021-12 | CT#94e | CP-213225 | 1664 | 1 | B | 5GS-Level Identify for NAI | 17.2.0 | +| 2021-12 | CT#94e | CP-213215 | 1669 | - | A | Correction of an invalid 3GPP-User-Location-Info value | 17.2.0 | +| 2021-12 | CT#94e | CP-213229 | 1671 | 1 | B | 5GS Level Identities in SNPN scenarios | 17.2.0 | +| 2022-03 | CT#95e | CP-220196 | 1673 | 1 | F | Correction to enable retrieval of Network Provided Location information in a MESSAGE request | 17.3.0 | +| 2022-03 | CT#95e | CP-220171 | 1675 | - | A | Correction to EPS Fallback | 17.3.0 | +| 2022-03 | CT#95e | CP-220195 | 1676 | 1 | B | Correction to enable retrieval of Network Provided Location information at mid-call access change | 17.3.0 | +| 2022-09 | CT#97e | CP-222125 | 1677 | 1 | F | Untrusted WLAN location information | 17.4.0 | +| 2022-09 | CT#97e | CP-222115 | 1678 | - | F | Allocate the value to FAILED_QOS_UPDATE | 17.4.0 | +| 2022-09 | CT#97e | CP-222125 | 1679 | - | F | Report of Access Network Charging Address | 17.4.0 | +| 2023-03 | CT#99 | CP-230175 | 1680 | 1 | F | EPC AF signalling note | 18.0.0 | +| 2023-03 | CT#99 | CP-230174 | 1681 | - | F | Flow Description for MPS for DTS AF signalling flow | 18.0.0 | +| 2023-03 | CT#99 | CP-230174 | 1682 | - | F | Format handling for 3GPP-User-Location-Info AVP | 18.0.0 | +| 2023-06 | CT#100 | CP-231133 | 1683 | 1 | F | Handling of 3GPP User Location | 18.1.0 | +| 2023-06 | CT#100 | CP-231170 | 1686 | - | A | Corrections for the RAT types | 18.1.0 | \ No newline at end of file diff --git a/gsma/29_series/29222/raw.md b/gsma/29_series/29222/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3decedac0d3b08edb40d403fa4cab332cd61eee2 --- /dev/null +++ b/gsma/29_series/29222/raw.md @@ -0,0 +1,10083 @@ + + +# 3GPP TS 29.222 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Common API Framework for 3GPP Northbound APIs; (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above it and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +Keywords +5G System + +**3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +**3GPP** + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 14 | +| 1 Scope..... | 15 | +| 2 References..... | 15 | +| 3 Definitions and abbreviations..... | 16 | +| 3.1 Definitions..... | 16 | +| 3.2 Abbreviations..... | 16 | +| 4 Overview..... | 17 | +| 4.1 Introduction..... | 17 | +| 4.2 Service Architecture..... | 17 | +| 4.3 Functional Entities..... | 17 | +| 4.3.1 API invoker..... | 17 | +| 4.3.2 CAPIF core function..... | 17 | +| 4.3.3 API exposing function..... | 17 | +| 4.3.4 API publishing function..... | 17 | +| 4.3.5 API management function..... | 17 | +| 5 Services offered by the CAPIF Core Function..... | 17 | +| 5.1 Introduction of Services..... | 17 | +| 5.2 CAPIF_Discover_Service_API..... | 19 | +| 5.2.1 Service Description..... | 19 | +| 5.2.1.1 Overview..... | 19 | +| 5.2.2 Service Operations..... | 19 | +| 5.2.2.1 Introduction..... | 19 | +| 5.2.2.2 Discover_Service_API..... | 20 | +| 5.2.2.2.1 General..... | 20 | +| 5.2.2.2.2 Consumer discovering service API using Discover_Service_API service operation..... | 20 | +| 5.3 CAPIF_Publish_Service_API..... | 20 | +| 5.3.1 Service Description..... | 20 | +| 5.3.1.1 Overview..... | 20 | +| 5.3.2 Service Operations..... | 21 | +| 5.3.2.1 Introduction..... | 21 | +| 5.3.2.2 Publish_Service_API..... | 21 | +| 5.3.2.2.1 General..... | 21 | +| 5.3.2.2.2 API publishing function publishing service APIs on CAPIF core function using Publish_Service_API service operation..... | 21 | +| 5.3.2.2.3 CAPIF core function publishing service APIs on other CAPIF core function using Publish_Service_API service operation..... | 22 | +| 5.3.2.3 Unpublish_Service_API..... | 23 | +| 5.3.2.3.1 General..... | 23 | +| 5.3.2.3.2 Consumer un-publishing service APIs from CAPIF core function using Unpublish_Service_API service operation..... | 23 | +| 5.3.2.4 Get_Service_API..... | 23 | + +# Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|-----------|-----------------------------------------------------------------------------------------------------------------|----| +| 5.3.2.4.1 | General..... | 23 | +| 5.3.2.4.2 | Consumer retrieving service APIs from CAPIF core function using Get_Service_API service operation..... | 23 | +| 5.3.2.5 | Update_Service_API..... | 24 | +| 5.3.2.5.1 | General..... | 24 | +| 5.3.2.5.2 | Consumer updating published service APIs on CAPIF core function using Update_Service_API service operation..... | 24 | +| 5.4 | CAPIF_Events_API..... | 25 | +| 5.4.1 | Service Description..... | 25 | +| 5.4.1.1 | Overview..... | 25 | +| 5.4.2 | Service Operations..... | 25 | +| 5.4.2.1 | Introduction..... | 25 | +| 5.4.2.2 | Subscribe_Event..... | 25 | +| 5.4.2.2.1 | General..... | 25 | +| 5.4.2.2.2 | Subscribing to CAPIF events using Subscribe_Event service operation..... | 25 | +| 5.4.2.3 | Unsubscribe_Event..... | 26 | +| 5.4.2.3.1 | General..... | 26 | +| 5.4.2.3.2 | Unsubscribing from CAPIF events using Unsubscribe_Event service operation..... | 26 | +| 5.4.2.4 | Notify_Event..... | 27 | +| 5.4.2.4.1 | General..... | 27 | +| 5.4.2.4.2 | Notifying CAPIF events using Notify_Event service operation..... | 27 | +| 5.4.2.5 | Update_Event_Subscription..... | 27 | +| 5.4.2.5.1 | General..... | 27 | +| 5.4.2.5.2 | Update Subscription to CAPIF events using Update_Event_Subscription service operation..... | 27 | +| 5.5 | CAPIF_API_Invoker_Management_API..... | 28 | +| 5.5.1 | Service Description..... | 28 | +| 5.5.1.1 | Overview..... | 28 | +| 5.5.2 | Service Operations..... | 28 | +| 5.5.2.1 | Introduction..... | 28 | +| 5.5.2.2 | Onboard_API_Invoker..... | 28 | +| 5.5.2.2.1 | General..... | 28 | +| 5.5.2.2.2 | API invoker on-boarding itself as a recognized user of CAPIF using Onboard_API_Invoker service operation..... | 28 | +| 5.5.2.3 | Offboard_API_Invoker..... | 29 | +| 5.5.2.3.1 | General..... | 29 | +| 5.5.2.3.2 | API invoker off-boarding itself as a recognized user of CAPIF using Offboard_API_Invoker service operation..... | 29 | +| 5.5.2.4 | Notify_Onboarding_Completion..... | 30 | +| 5.5.2.4.1 | General..... | 30 | +| 5.5.2.4.2 | Notifying Onboarding completion using Notify_Onboarding_Completion service operation..... | 30 | +| 5.5.2.5 | Update_API_Invoker_Details..... | 30 | +| 5.5.2.5.1 | General..... | 30 | +| 5.5.2.5.2 | API invoker updating its details on CAPIF using Update_API_Invoker_Details service operation..... | 30 | +| 5.5.2.6 | Notify_Update_Completion..... | 31 | +| 5.5.2.6.1 | General..... | 31 | +| 5.5.2.6.2 | Notifying API invoker update completion using Notify_Update_Completion service operation..... | 31 | +| 5.6 | CAPIF_Security_API..... | 32 | +| 5.6.1 | Service Description..... | 32 | +| 5.6.1.1 | Overview..... | 32 | +| 5.6.2 | Service Operations..... | 32 | +| 5.6.2.1 | Introduction..... | 32 | +| 5.6.2.2 | Obtain_Security_Method..... | 32 | +| 5.6.2.2.1 | General..... | 32 | +| 5.6.2.2.2 | Request service API security method from CAPIF using Obtain_Security_Method service operation..... | 33 | +| 5.6.2.3 | Obtain_Authorization..... | 33 | +| 5.6.2.3.1 | General..... | 33 | +| 5.6.2.3.2 | Obtain authorization using Obtain_Authorization service operation..... | 33 | +| 5.6.2.3.3 | Obtain authorization code using Obtain_Authorization service operation..... | 34 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.6.2.4 | Obtain_API_Invoker_Info..... | 34 | +| 5.6.2.4.1 | General..... | 34 | +| 5.6.2.4.2 | Obtain API invoker's security information using Obtain_API_Invoker_Info service operation..... | 34 | +| 5.6.2.5 | Revoke_Authentication..... | 35 | +| 5.6.2.5.1 | General..... | 35 | +| 5.6.2.5.2 | Invalidate authorization using Revoke_Authorization service operation..... | 35 | +| 5.7 | CAPIF_Monitoring_API..... | 35 | +| 5.8 | CAPIF_Logging_API_Invocation_API..... | 35 | +| 5.8.1 | Service Description..... | 35 | +| 5.8.1.1 | Overview..... | 35 | +| 5.8.2 | Service Operations..... | 36 | +| 5.8.2.1 | Introduction..... | 36 | +| 5.8.2.2 | Log_API_Invocation_API..... | 36 | +| 5.8.2.2.1 | General..... | 36 | +| 5.8.2.2.2 | Logging service API invocations using Log_API_Invocation service operation..... | 36 | +| 5.9 | CAPIF_Auditing_API..... | 36 | +| 5.9.1 | Service Description..... | 36 | +| 5.9.1.1 | Overview..... | 36 | +| 5.9.2 | Service Operations..... | 37 | +| 5.9.2.1 | Introduction..... | 37 | +| 5.9.2.2 | Query_Invocation_Logs_API..... | 37 | +| 5.9.2.2.1 | General..... | 37 | +| 5.9.2.2.2 | Query API invocation information logs using Query_Invocation_Logs service operation..... | 37 | +| 5.10 | CAPIF_Access_Control_Policy_API..... | 37 | +| 5.10.1 | Service Description..... | 37 | +| 5.10.1.1 | Overview..... | 37 | +| 5.10.2 | Service Operations..... | 38 | +| 5.10.2.1 | Introduction..... | 38 | +| 5.10.2.2 | Obtain_Access_Control_Policy..... | 38 | +| 5.10.2.2.1 | General..... | 38 | +| 5.10.2.2.2 | API exposing function obtaining access control policy from the CAPIF core function using Obtain_Access_Control_Policy service operation..... | 38 | +| 5.10.3 | Related Events..... | 38 | +| 5.11 | CAPIF_API_Provider_Management_API..... | 38 | +| 5.11.1 | Service Description..... | 38 | +| 5.11.1.1 | Overview..... | 38 | +| 5.11.2 | Service Operations..... | 39 | +| 5.11.2.1 | Introduction..... | 39 | +| 5.11.2.2 | Register_API_Provider..... | 39 | +| 5.11.2.2.1 | General..... | 39 | +| 5.11.2.2.2 | API provider domain functions registering as a recognized API provider domain function of CAPIF using Register_API_Provider service operation..... | 39 | +| 5.11.2.3 | Update_API_Provider..... | 39 | +| 5.11.2.3.1 | General..... | 39 | +| 5.11.2.3.2 | API management function updating API provider domain function details on CAPIF using Update_API_Provider service operation..... | 40 | +| 5.11.2.4 | Deregister_API_Provider..... | 40 | +| 5.11.2.4.1 | General..... | 40 | +| 5.11.2.4.2 | API provider domain functions deregistering as a recognized API provider domain function of CAPIF using Deregister_API_Provider service operation..... | 40 | +| 5.12 | CAPIF_Routing_Info_API..... | 41 | +| 5.12.1 | Service Description..... | 41 | +| 5.12.1.1 | Overview..... | 41 | +| 5.12.2 | Service Operations..... | 41 | +| 5.12.2.1 | Introduction..... | 41 | +| 5.12.2.2 | Obtain_Routing_Info..... | 41 | +| 5.12.2.2.1 | General..... | 41 | +| 5.12.2.2.2 | API exposing function obtaining API routing information from the CAPIF core function using Obtain_Routing_Info service operation..... | 41 | +| 6 | Services offered by the API exposing function..... | 42 | +| 6.1 | Introduction of Services..... | 42 | + +| | | | +|-------------|---------------------------------------------------------------------------------------------|----| +| 6.2 | AEF_Security_API..... | 42 | +| 6.2.1 | Service Description..... | 42 | +| 6.2.1.1 | Overview..... | 42 | +| 6.2.2 | Service Operations..... | 42 | +| 6.2.2.1 | Introduction..... | 42 | +| 6.2.2.2 | Initiate_Authentication..... | 43 | +| 6.2.2.2.1 | General..... | 43 | +| 6.2.2.2.2 | API invoker initiating authentication using Initiate_Authentication service operation..... | 43 | +| 6.2.2.3 | Revoke_Authorization..... | 43 | +| 6.2.2.3.1 | General..... | 43 | +| 6.2.2.3.2 | CAPIF core function initiating revocation using Revoke_Authorization service operation..... | 43 | +| 7 | CAPIF Design Aspects Common for All APIs..... | 43 | +| 7.1 | General..... | 43 | +| 7.2 | Data Types..... | 44 | +| 7.2.1 | General..... | 44 | +| 7.2.2 | Referenced structured data types..... | 44 | +| 7.2.3 | Referenced Simple data types and enumerations..... | 44 | +| 7.3 | Usage of HTTP..... | 45 | +| 7.4 | Content type..... | 45 | +| 7.5 | URI structure..... | 45 | +| 7.6 | Notifications..... | 46 | +| 7.7 | Error handling..... | 46 | +| 7.8 | Feature negotiation..... | 46 | +| 7.9 | HTTP headers..... | 46 | +| 7.10 | Conventions for Open API specification files..... | 46 | +| 7.11 | CAPIF vendor-specific extensions..... | 46 | +| 8 | CAPIF API Definition..... | 47 | +| 8.1 | CAPIF_Discover_Service_API..... | 47 | +| 8.1.1 | API URI..... | 47 | +| 8.1.2 | Resources..... | 47 | +| 8.1.2.1 | Overview..... | 47 | +| 8.1.2.2 | Resource: All published service APIs..... | 48 | +| 8.1.2.2.1 | Description..... | 48 | +| 8.1.2.2.2 | Resource Definition..... | 48 | +| 8.1.2.2.3 | Resource Standard Methods..... | 48 | +| 8.1.2.2.3.1 | GET..... | 48 | +| 8.1.2.2.4 | Resource Custom Operations..... | 50 | +| 8.1.2A | Custom Operations without associated resources..... | 50 | +| 8.1.3 | Notifications..... | 50 | +| 8.1.4 | Data Model..... | 50 | +| 8.1.4.1 | General..... | 50 | +| 8.1.4.2 | Structured data types..... | 51 | +| 8.1.4.2.1 | Introduction..... | 51 | +| 8.1.4.2.2 | Type: DiscoveredAPIs..... | 51 | +| 8.1.4.2.3 | Void..... | 51 | +| 8.1.4.2.4 | Type: IpAddrInfo..... | 51 | +| 8.1.4.3 | Simple data types and enumerations..... | 52 | +| 8.1.5 | Error Handling..... | 52 | +| 8.1.5.1 | General..... | 52 | +| 8.1.5.2 | Protocol Errors..... | 52 | +| 8.2.5.3 | Application Errors..... | 52 | +| 8.1.6 | Feature negotiation..... | 52 | +| 8.2 | CAPIF_Publish_Service_API..... | 52 | +| 8.2.1 | API URI..... | 52 | +| 8.2.2 | Resources..... | 53 | +| 8.2.2.1 | Overview..... | 53 | +| 8.2.2.2 | Resource: APF published APIs..... | 53 | +| 8.2.2.2.1 | Description..... | 53 | +| 8.2.2.2.2 | Resource Definition..... | 54 | +| 8.2.2.2.3 | Resource Standard Methods..... | 54 | + +| | | | +|-------------|-----------------------------------------------------|----| +| 8.2.2.2.3.1 | POST..... | 54 | +| 8.2.2.2.3.2 | GET..... | 54 | +| 8.2.2.2.4 | Resource Custom Operations..... | 55 | +| 8.2.2.3 | Resource: Individual APF published API..... | 55 | +| 8.2.2.3.1 | Description..... | 55 | +| 8.2.2.3.2 | Resource Definition..... | 56 | +| 8.2.2.3.3 | Resource Standard Methods..... | 56 | +| 8.2.2.3.3.1 | GET..... | 56 | +| 8.2.2.3.3.2 | PUT..... | 57 | +| 8.2.2.3.3.3 | DELETE..... | 58 | +| 8.2.2.3.3.4 | PATCH..... | 58 | +| 8.2.2.3.4 | Resource Custom Operations..... | 59 | +| 8.2.2A | Custom Operations without associated resources..... | 59 | +| 8.2.3 | Notifications..... | 59 | +| 8.2.4 | Data Model..... | 60 | +| 8.2.4.1 | General..... | 60 | +| 8.2.4.2 | Structured data types..... | 62 | +| 8.2.4.2.1 | Introduction..... | 62 | +| 8.2.4.2.2 | Type: ServiceAPIDescription..... | 62 | +| 8.2.4.2.3 | Type: InterfaceDescription..... | 63 | +| 8.2.4.2.4 | Type: AefProfile..... | 63 | +| 8.2.4.2.5 | Type: Version..... | 64 | +| 8.2.4.2.6 | Type: Resource..... | 64 | +| 8.2.4.2.7 | Type: CustomOperation..... | 65 | +| 8.2.4.2.8 | Type: ShareableInformation..... | 65 | +| 8.2.4.2.9 | Type: PublishedApiPath..... | 65 | +| 8.2.4.2.10 | Type: AefLocation..... | 65 | +| 8.2.4.2.11 | Type: ServiceAPIDescriptionPatch..... | 66 | +| 8.2.4.2.12 | Type: ApiStatus..... | 66 | +| 8.2.4.2.13 | Type: ServiceKpi..... | 67 | +| 8.2.4.2.14 | Type: IpAddrRange..... | 68 | +| 8.2.4.3 | Simple data types and enumerations..... | 68 | +| 8.2.4.3.1 | Introduction..... | 68 | +| 8.2.4.3.2 | Simple data types..... | 68 | +| 8.2.4.3.3 | Enumeration: Protocol..... | 68 | +| 8.2.4.3.4 | Enumeration: DataFormat..... | 69 | +| 8.2.4.3.5 | Enumeration: CommunicationType..... | 69 | +| 8.2.4.3.6 | Enumeration: SecurityMethod..... | 69 | +| 8.2.4.3.7 | Enumeration: Operation..... | 69 | +| 8.2.5 | Error Handling..... | 69 | +| 8.2.5.1 | General..... | 69 | +| 8.2.5.2 | Protocol Errors..... | 70 | +| 8.2.5.3 | Application Errors..... | 70 | +| 8.2.6 | Feature negotiation..... | 70 | +| 8.3 | CAPIF_Events_API..... | 70 | +| 8.3.1 | API URI..... | 70 | +| 8.3.2 | Resources..... | 71 | +| 8.3.2.1 | Overview..... | 71 | +| 8.3.2.2 | Resource: CAPIF Events Subscriptions..... | 72 | +| 8.3.2.2.1 | Description..... | 72 | +| 8.3.2.2.2 | Resource Definition..... | 72 | +| 8.3.2.2.3 | Resource Standard Methods..... | 72 | +| 8.3.2.2.3.1 | POST..... | 72 | +| 8.3.2.2.4 | Resource Custom Operations..... | 73 | +| 8.3.2.3 | Resource: Individual CAPIF Events Subscription..... | 73 | +| 8.3.2.3.1 | Description..... | 73 | +| 8.3.2.3.2 | Resource Definition..... | 73 | +| 8.3.2.3.3 | Resource Standard Methods..... | 73 | +| 8.3.2.3.3.1 | DELETE..... | 73 | +| 8.3.2.3.3.2 | PUT..... | 74 | +| 8.3.2.3.3.3 | PATCH..... | 75 | + +| | | | +|-------------|-----------------------------------------------------|----| +| 8.3.2.3.4 | Resource Custom Operations..... | 76 | +| 8.3.2A | Custom Operations without associated resources..... | 76 | +| 8.3.3 | Notifications..... | 76 | +| 8.3.3.1 | General..... | 76 | +| 8.3.3.2 | Event Notification..... | 76 | +| 8.3.3.2.1 | Description..... | 76 | +| 8.3.3.2.2 | Notification definition..... | 76 | +| 8.3.4 | Data Model..... | 77 | +| 8.3.4.1 | General..... | 77 | +| 8.3.4.2 | Structured data types..... | 78 | +| 8.3.4.2.1 | Introduction..... | 78 | +| 8.3.4.2.2 | Type: EventSubscription..... | 79 | +| 8.3.4.2.3 | Type: EventNotification..... | 79 | +| 8.3.4.2.4 | Type: CAPIFEventFilter..... | 80 | +| 8.3.4.2.5 | Type: CAPIFEventDetail..... | 80 | +| 8.3.4.2.6 | Type: AccessControlPolicyListExt..... | 80 | +| 8.3.4.2.7 | Type: TopologyHiding..... | 80 | +| 8.3.4.2.8 | Type: EventSubscriptionPatch..... | 81 | +| 8.3.4.3 | Simple data types and enumerations..... | 81 | +| 8.3.4.3.1 | Introduction..... | 81 | +| 8.3.4.3.2 | Simple data types..... | 81 | +| 8.3.4.3.3 | Enumeration: CAPIFEvent..... | 82 | +| 8.3.5 | Error Handling..... | 82 | +| 8.3.5.1 | General..... | 82 | +| 8.3.5.2 | Protocol Errors..... | 82 | +| 8.3.5.3 | Application Errors..... | 82 | +| 8.3.6 | Feature negotiation..... | 83 | +| 8.4 | CAPIF_API_Invoker_Management_API..... | 83 | +| 8.4.1 | API URI..... | 83 | +| 8.4.2 | Resources..... | 83 | +| 8.4.2.1 | Overview..... | 83 | +| 8.4.2.2 | Resource: On-boarded API invokers..... | 84 | +| 8.4.2.2.1 | Description..... | 84 | +| 8.4.2.2.2 | Resource Definition..... | 84 | +| 8.4.2.2.3 | Resource Standard Methods..... | 85 | +| 8.4.2.2.3.1 | POST..... | 85 | +| 8.4.2.2.4 | Resource Custom Operations..... | 85 | +| 8.4.2.3 | Resource: Individual On-boarded API Invoker..... | 86 | +| 8.4.2.3.1 | Description..... | 86 | +| 8.4.2.3.2 | Resource Definition..... | 86 | +| 8.4.2.3.3 | Resource Standard Methods..... | 86 | +| 8.4.2.3.3.1 | DELETE..... | 86 | +| 8.4.2.3.3.2 | PUT..... | 87 | +| 8.4.2.3.3.3 | PATCH..... | 88 | +| 8.4.2.3.4 | Resource Custom Operations..... | 89 | +| 8.4.2A | Custom Operations without associated resources..... | 89 | +| 8.4.3 | Notifications..... | 89 | +| 8.4.3.1 | General..... | 89 | +| 8.4.3.2 | Notify_Onboarding_Completion..... | 90 | +| 8.4.3.2.1 | Description..... | 90 | +| 8.4.3.2.2 | Notification definition..... | 90 | +| 8.4.3.3 | Notify_Update_Completion..... | 91 | +| 8.4.3.3.1 | Description..... | 91 | +| 8.4.3.3.2 | Notification definition..... | 91 | +| 8.4.4 | Data Model..... | 92 | +| 8.4.4.1 | General..... | 92 | +| 8.4.4.2 | Structured data types..... | 94 | +| 8.4.4.2.1 | Introduction..... | 94 | +| 8.4.4.2.2 | Type: APIInvokerEnrolmentDetails..... | 94 | +| 8.4.4.2.3 | Type: Void..... | 94 | +| 8.4.4.2.4 | Type: APIList..... | 94 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 8.4.4.2.5 | Type: OnboardingInformation..... | 95 | +| 8.4.4.2.6 | Type: Void..... | 95 | +| 8.4.4.2.7 | Type: OnboardingNotification..... | 95 | +| 8.4.4.2.8 | Type: APIInvokerEnrolmentDetailsPatch..... | 96 | +| 8.4.4.3 | Simple data types and enumerations..... | 96 | +| 8.4.5 | Error Handling..... | 96 | +| 8.4.5.1 | General..... | 96 | +| 8.4.5.2 | Protocol Errors..... | 96 | +| 8.4.5.3 | Application Errors..... | 96 | +| 8.4.6 | Feature negotiation..... | 96 | +| 8.5 | CAPIF_Security_API..... | 97 | +| 8.5.1 | API URI..... | 97 | +| 8.5.2 | Resources..... | 97 | +| 8.5.2.1 | Overview..... | 97 | +| 8.5.2.2 | Resource: Trusted API invokers..... | 98 | +| 8.5.2.2.1 | Description..... | 98 | +| 8.5.2.2.2 | Resource Definition..... | 98 | +| 8.5.2.2.3 | Resource Standard Methods..... | 98 | +| 8.5.2.2.3.1 | Void..... | 98 | +| 8.5.2.2.4 | Resource Custom Operations..... | 98 | +| 8.5.2.3 | Resource: Individual trusted API invokers..... | 99 | +| 8.5.2.3.1 | Description..... | 99 | +| 8.5.2.3.2 | Resource Definition..... | 99 | +| 8.5.2.3.3 | Resource Standard Methods..... | 99 | +| 8.5.2.3.3.1 | GET..... | 99 | +| 8.5.2.3.3.2 | DELETE..... | 100 | +| 8.5.2.3.3.3 | PUT..... | 101 | +| 8.5.2.3.4 | Resource Custom Operations..... | 102 | +| 8.5.2.3.4.1 | Overview..... | 102 | +| 8.5.2.3.4.2 | Operation: update..... | 102 | +| 8.5.2.3.4.2.1 | Description..... | 102 | +| 8.5.2.3.4.2.2 | Operation Definition..... | 102 | +| 8.5.2.3.4.3 | Operation: delete..... | 103 | +| 8.5.2.3.4.3.1 | Description..... | 103 | +| 8.5.2.3.4.3.2 | Operation Definition..... | 103 | +| 8.5.2.3.4.4 | Operation: token..... | 104 | +| 8.5.2.3.4.4.1 | Description..... | 104 | +| 8.5.2.3.4.4.2 | Operation Definition..... | 104 | +| 8.5.2.3.4.5 | Operation: code..... | 106 | +| 8.5.2.3.4.5.1 | Description..... | 106 | +| 8.5.2.3.4.5.2 | Operation Definition..... | 106 | +| 8.5.2A | Custom Operations without associated resources..... | 107 | +| 8.5.3 | Notifications..... | 107 | +| 8.5.3.1 | General..... | 107 | +| 8.5.3.2 | Authorization revoked notification..... | 107 | +| 8.5.3.2.1 | Description..... | 107 | +| 8.5.3.2.2 | Notification definition..... | 107 | +| 8.5.4 | Data Model..... | 108 | +| 8.5.4.1 | General..... | 108 | +| 8.5.4.2 | Structured data types..... | 110 | +| 8.5.4.2.1 | Introduction..... | 110 | +| 8.5.4.2.2 | Type: ServiceSecurity..... | 110 | +| 8.5.4.2.3 | Type: SecurityInformation..... | 110 | +| 8.5.4.2.4 | Void..... | 111 | +| 8.5.4.2.5 | Type: SecurityNotification..... | 111 | +| 8.5.4.2.6 | Type: AccessTokenReq..... | 112 | +| 8.5.4.2.7 | Type: AccessTokenRsp..... | 113 | +| 8.5.4.2.8 | Type: AccessTokenClaims..... | 114 | +| 8.5.4.2.9 | Type: AccessTokenErr..... | 115 | +| 8.5.4.2.10 | Type: AuthorizationCodeRsp..... | 115 | +| 8.5.4.3 | Simple data types and enumerations..... | 115 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 8.5.4.3.1 | Introduction..... | 115 | +| 8.5.4.3.2 | Simple data types..... | 115 | +| 8.5.4.3.3 | Enumeration: Cause..... | 116 | +| 8.5.4.3.4 | Enumeration: AuthorizationFlow..... | 116 | +| 8.5.5 | Error Handling..... | 116 | +| 8.5.5.1 | General..... | 116 | +| 8.5.5.2 | Protocol Errors..... | 116 | +| 8.5.5.3 | Application Errors..... | 116 | +| 8.5.6 | Feature negotiation..... | 117 | +| 8.6 | CAPIF_Access_Control_Policy_API..... | 117 | +| 8.6.1 | API URI..... | 117 | +| 8.6.2 | Resources..... | 117 | +| 8.6.2.1 | Overview..... | 117 | +| 8.6.2.2 | Resource: Access Control Policy List..... | 118 | +| 8.6.2.2.1 | Description..... | 118 | +| 8.6.2.2.2 | Resource Definition..... | 118 | +| 8.6.2.2.3 | Resource Standard Methods..... | 119 | +| 8.6.2.2.3.1 | GET..... | 119 | +| 8.6.2.2.4 | Resource Custom Operations..... | 119 | +| 8.6.2A | Custom Operations without associated resources..... | 120 | +| 8.6.3 | Notifications..... | 120 | +| 8.6.4 | Data Model..... | 120 | +| 8.6.4.1 | General..... | 120 | +| 8.6.4.2 | Structured data types..... | 120 | +| 8.6.4.2.1 | Introduction..... | 120 | +| 8.6.4.2.2 | Type: AccessControlPolicyList..... | 120 | +| 8.6.4.2.3 | Type: ApiInvokerPolicy..... | 121 | +| 8.6.4.2.4 | Type: TimeRangeList..... | 121 | +| 8.6.4.3 | Simple data types and enumerations..... | 121 | +| 8.6.5 | Error Handling..... | 121 | +| 8.6.5.1 | General..... | 121 | +| 8.6.5.2 | Protocol Errors..... | 121 | +| 8.6.5.3 | Application Errors..... | 121 | +| 8.6.6 | Feature negotiation..... | 122 | +| 8.7 | CAPIF_Logging_API_Invocation_API..... | 122 | +| 8.7.1 | API URI..... | 122 | +| 8.7.2 | Resources..... | 122 | +| 8.7.2.1 | Overview..... | 122 | +| 8.7.2.2 | Resource: Logs..... | 123 | +| 8.7.2.2.1 | Description..... | 123 | +| 8.7.2.2.2 | Resource Definition..... | 123 | +| 8.7.2.2.3 | Resource Standard Methods..... | 123 | +| 8.7.2.2.3.1 | POST..... | 123 | +| 8.7.2.2.4 | Resource Custom Operations..... | 124 | +| 8.7.2A | Custom Operations without associated resources..... | 124 | +| 8.7.3 | Notifications..... | 124 | +| 8.7.4 | Data Model..... | 124 | +| 8.7.4.1 | General..... | 124 | +| 8.7.4.2 | Structured data types..... | 125 | +| 8.7.4.2.1 | Introduction..... | 125 | +| 8.7.4.2.2 | Type: InvocationLog..... | 125 | +| 8.7.4.2.3 | Type: Log..... | 126 | +| 8.7.4.3 | Simple data types and enumerations..... | 126 | +| 8.7.4.3.1 | Introduction..... | 126 | +| 8.7.4.3.2 | Simple data types..... | 126 | +| 8.7.5 | Error Handling..... | 127 | +| 8.7.5.1 | General..... | 127 | +| 8.7.5.2 | Protocol Errors..... | 127 | +| 8.7.5.3 | Application Errors..... | 127 | +| 8.7.6 | Feature negotiation..... | 127 | +| 8.8 | CAPIF_Auditing_API..... | 127 | + +| | | | +|-------------|---------------------------------------------------------------------------------|-----| +| 8.8.1 | API URI..... | 127 | +| 8.8.2 | Resources..... | 128 | +| 8.8.2.1 | Overview..... | 128 | +| 8.8.2.2 | Resource: All service API invocation logs..... | 128 | +| 8.8.2.2.1 | Description..... | 128 | +| 8.8.2.2.2 | Resource Definition..... | 128 | +| 8.8.2.2.3 | Resource Standard Methods..... | 129 | +| 8.8.2.2.3.1 | GET..... | 129 | +| 8.8.2.2.4 | Resource Custom Operations..... | 130 | +| 8.8.2A | Custom Operations without associated resources..... | 130 | +| 8.8.3 | Notifications..... | 130 | +| 8.8.4 | Data Model..... | 130 | +| 8.8.4.1 | General..... | 130 | +| 8.8.4.2 | Structured data types..... | 131 | +| 8.8.4.2.1 | Introduction..... | 131 | +| 8.8.4.2.2 | Type: InvocationLogs..... | 131 | +| 8.8.4.3 | Simple data types and enumerations..... | 131 | +| 8.8.4.4 | Data types describing alternative data types or combinations of data types..... | 131 | +| 8.8.4.4.1 | Type: InvocationLogsRetrieveRes..... | 131 | +| 8.8.5 | Error Handling..... | 131 | +| 8.8.5.1 | General..... | 131 | +| 8.8.5.2 | Protocol Errors..... | 132 | +| 8.8.5.3 | Application Errors..... | 132 | +| 8.8.6 | Feature negotiation..... | 132 | +| 8.9 | CAPIF_API_Provider_Management_API..... | 132 | +| 8.9.1 | API URI..... | 132 | +| 8.9.2 | Resources..... | 132 | +| 8.9.2.1 | Overview..... | 132 | +| 8.9.2.2 | Resource: All API Provider Domains Registrations..... | 133 | +| 8.9.2.2.1 | Description..... | 133 | +| 8.9.2.2.2 | Resource Definition..... | 133 | +| 8.9.2.2.3 | Resource Standard Methods..... | 134 | +| 8.9.2.2.3.1 | POST..... | 134 | +| 8.9.2.2.4 | Resource Custom Operations..... | 134 | +| 8.9.2.3 | Resource: Individual API Provider Domain Registration..... | 134 | +| 8.9.2.3.1 | Description..... | 134 | +| 8.9.2.3.2 | Resource Definition..... | 134 | +| 8.9.2.3.3 | Resource Standard Methods..... | 135 | +| 8.9.2.3.3.1 | PUT..... | 135 | +| 8.9.2.3.3.2 | DELETE..... | 136 | +| 8.9.2.3.3.3 | PATCH..... | 137 | +| 8.9.2.3.4 | Resource Custom Operations..... | 138 | +| 8.9.2A | Custom Operations without associated resources..... | 138 | +| 8.9.3 | Notifications..... | 138 | +| 8.9.4 | Data Model..... | 138 | +| 8.9.4.1 | General..... | 138 | +| 8.9.4.2 | Structured data types..... | 139 | +| 8.9.4.2.1 | Introduction..... | 139 | +| 8.9.4.2.2 | Type: APIProviderEnrolmentDetails..... | 139 | +| 8.9.4.2.3 | Type: APIProviderFunctionDetails..... | 140 | +| 8.9.4.2.4 | Type: RegistrationInformation..... | 140 | +| 8.9.4.2.5 | Type: APIProviderEnrolmentDetailsPatch..... | 141 | +| 8.9.4.3 | Simple data types and enumerations..... | 141 | +| 8.9.4.3.1 | Introduction..... | 141 | +| 8.9.4.3.2 | Simple data types..... | 141 | +| 8.9.4.3.3 | Enumeration: ApiProviderFuncRole..... | 141 | +| 8.9.5 | Error Handling..... | 141 | +| 8.9.5.1 | General..... | 141 | +| 8.9.5.2 | Protocol Errors..... | 141 | +| 8.9.5.3 | Application Errors..... | 142 | +| 8.9.6 | Feature negotiation..... | 142 | + +| | | | +|--------------|-------------------------------------------------------------|-----| +| 8.10 | CAPIF_Routing_Info_API..... | 142 | +| 8.10.1 | API URI..... | 142 | +| 8.10.2 | Resources..... | 142 | +| 8.10.2.1 | Overview..... | 142 | +| 8.10.2.2 | Resource: Individual Service API routing info..... | 143 | +| 8.10.2.2.1 | Description..... | 143 | +| 8.10.2.2.2 | Resource Definition..... | 143 | +| 8.10.2.2.3 | Resource Standard Methods..... | 143 | +| 8.10.2.2.3.1 | GET..... | 143 | +| 8.10.2.2.4 | Resource Custom Operations..... | 144 | +| 8.10.2A | Custom Operations without associated resources..... | 144 | +| 8.10.3 | Notifications..... | 145 | +| 8.10.4 | Data Model..... | 145 | +| 8.10.4.1 | General..... | 145 | +| 8.10.4.2 | Structured data types..... | 145 | +| 8.10.4.2.1 | Introduction..... | 145 | +| 8.10.4.2.2 | Type: RoutingInfo..... | 145 | +| 8.10.4.2.3 | Type: RoutingRule..... | 146 | +| 8.10.4.2.4 | Type: Ipv6AddressRange..... | 146 | +| 8.10.4.3 | Simple data types and enumerations..... | 146 | +| 8.10.5 | Error Handling..... | 146 | +| 8.10.5.1 | General..... | 146 | +| 8.10.5.2 | Protocol Errors..... | 146 | +| 8.10.5.3 | Application Errors..... | 146 | +| 8.10.6 | Feature negotiation..... | 146 | +| 9 | AEF API Definition..... | 147 | +| 9.1 | AEF_Security_API..... | 147 | +| 9.1.1 | API URI..... | 147 | +| 9.1.2 | Resources..... | 147 | +| 9.1.2A | Custom Operations without associated resources..... | 147 | +| 9.1.2A.1 | Overview..... | 147 | +| 9.1.2A.2 | Operation: check-authentication..... | 147 | +| 9.1.2A.2.1 | Description..... | 147 | +| 9.1.2A.2.2 | Operation Definition..... | 148 | +| 9.1.2A.3 | Operation: revoke-authorization..... | 148 | +| 9.1.2A.3.1 | Description..... | 148 | +| 9.1.2A.3.2 | Operation Definition..... | 149 | +| 9.1.3 | Notifications..... | 149 | +| 9.1.4 | Data Model..... | 150 | +| 9.1.4.1 | General..... | 150 | +| 9.1.4.2 | Structured data types..... | 150 | +| 9.1.4.2.1 | Introduction..... | 150 | +| 9.1.4.2.2 | Type: CheckAuthenticationReq..... | 150 | +| 9.1.4.2.3 | Type: CheckAuthenticationRsp..... | 150 | +| 9.1.4.2.4 | Type: RevokeAuthorizationReq..... | 151 | +| 9.1.4.2.5 | Type: RevokeAuthorizationRsp..... | 151 | +| 9.1.4.3 | Simple data types and enumerations..... | 151 | +| 9.1.5 | Error Handling..... | 151 | +| 9.1.5.1 | General..... | 151 | +| 9.1.5.2 | Protocol Errors..... | 151 | +| 9.1.5.3 | Application Errors..... | 151 | +| 9.1.6 | Feature negotiation..... | 151 | +| 10 | Security..... | 152 | +| 10.1 | General..... | 152 | +| 10.2 | CAPIF-1/1e security..... | 152 | +| 10.3 | CAPIF-2/2e security and securely invoking service APIs..... | 152 | + +| | | +|--------------------------------------------------------|------------| +| Annex A (normative): OpenAPI specification..... | 152 | +| A.1 General..... | 152 | +| A.2 CAPIF_Discover_Service_API..... | 152 | +| A.3 CAPIF_Publish_Service_API..... | 155 | +| A.4 CAPIF_Events_API..... | 165 | +| A.5 CAPIF_API_Invoker_Management_API..... | 171 | +| A.6 CAPIF_Security_API..... | 176 | +| A.7 CAPIF_Access_Control_Policy_API..... | 183 | +| A.8 CAPIF_Logging_API_Invocation_API..... | 185 | +| A.9 CAPIF_Auditing_API..... | 188 | +| A.10 AEF_Security_API..... | 190 | +| A.11 CAPIF_API_Provider_Management_API..... | 192 | +| A.12 CAPIF_Routing_Info_API..... | 196 | +| Annex B (informative): Change history..... | 199 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification describes the protocol for the Common API Framework (CAPIF) for 3GPP Northbound APIs. The CAPIF and the related stage 2 architecture and functional requirements are defined in 3GPP TS 23.222 [2]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.222: "Functional architecture and information flows to support Common API Framework for 3GPP Northbound APIs; Stage 2". +- [3] Open API: "OpenAPI Specification Version 3.0.0", . +- [4] IETF RFC 9112: "HTTP/1.1". +- [5] IETF RFC 9110: "HTTP Semantics". +- [6] Void. +- [7] Void. +- [8] IETF RFC 9111: "HTTP Caching". +- [9] Void. +- [10] IETF RFC 9113: "HTTP/2". +- [11] Void. +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 6455: "The Websocket Protocol". +- [14] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [15] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [16] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [17] Void. +- [18] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [19] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [20] IETF RFC 7239: "Forwarded HTTP Extension". +- [21] Void. + +- [22] W3C HTML 4.01 Specification, . +- [23] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [24] IETF RFC 7519: "JSON Web Token (JWT)". +- [25] IETF RFC 7515: "JSON Web Signature (JWS)". +- [26] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [27] 3GPP TR 21.900: "Technical Specification Group working methods". +- [28] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3" +- [29] IETF RFC 5280: "Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile". +- [30] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the terms and definitions given in clause 3 of 3GPP TS 23.222 [2] shall also apply: + +**API registry:** API registry is a registry maintained by the CAPIF core function to store information about the service APIs based on the data models defined in this specification. The structure of the API registry is out of scope of this specification. + +**Subscriber:** A functional entity that subscribes to another functional entity for notifications. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|--------------------------------------------| +| AEF | API Exposing Function | +| AMF | API Management Function | +| APF | API Publishing Function | +| AS | Application Server | +| CAPIF | Common API Framework | +| CCF | CAPIF Core Function | +| JSON | JavaScript Object Notation | +| REST | Representational State Transfer | +| RNAA | Resource owner-aware Northbound API Access | +| SCEF | Service Capability Exposure Function | +| SCS | Service Capability Server | +| SNPN | Stand-alone Non-Public Network | + +--- + +## 4 Overview + +### 4.1 Introduction + +In 3GPP, there are multiple northbound API-related specifications. To avoid duplication and inconsistency of approaches between different API specifications and to specify common services (e.g. authorization), 3GPP has considered in 3GPP TS 23.222 [2] the development of a common API framework (CAPIF) that includes common aspects applicable to any northbound service APIs. + +The present document specifies the APIs needed to support CAPIF. + +### 4.2 Service Architecture + +3GPP TS 23.222 [2] clause 6 specifies the functional entities and domains of the functional model. + +### 4.3 Functional Entities + +#### 4.3.1 API invoker + +The API invoker is typically provided by a 3rd party application provider who has service agreement with PLMN operator or SNPN. The API invoker may reside within the same trust domain as the PLMN operator network or SNPN. + +The API invoker supports several capabilities as defined in 3GPP TS 23.222 [2]. + +#### 4.3.2 CAPIF core function + +The CAPIF core function (CCF) supports the capabilities as defined in 3GPP TS 23.222 [2]. + +#### 4.3.3 API exposing function + +The API exposing function (AEF) is the provider of the Service APIs and is also the service communication entry point of the service API to the API invokers as defined in 3GPP TS 23.222 [2]. + +#### 4.3.4 API publishing function + +The API publishing function (APF) enables the API provider to publish the Service APIs information as defined in 3GPP TS 23.222 [2]. + +#### 4.3.5 API management function + +The API management function (AMF) enables the API provider to perform administration of the Service APIs. The API capabilities are defined in 3GPP TS 23.222 [2]. + +--- + +## 5 Services offered by the CAPIF Core Function + +### 5.1 Introduction of Services + +The table 5.1-1 lists the CAPIF Core Function APIs below the service name. A service description clause for each API gives a general description of the related API. + +**Table 5.1-1: List of CAPIF Services** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------|--------------------------------------------------------------------------------------| +| CAPIF_Discover_Service_API | Discover_Service_API | Request/ Response | API Invoker, CAPIF core function | +| | Event operations (NOTE) | (NOTE) | API Invoker | +| CAPIF_Publish_Service_API | Publish_Service_API | Request/ Response | API Publishing Function, CAPIF core function | +| | Unpublish_Service_API | Request/ Response | API Publishing Function, CAPIF core function | +| | Update_Service_API | Request/ Response | API Publishing Function, CAPIF core function | +| | Get_Service_API | Request/ Response | API Publishing Function, CAPIF core function | +| CAPIF_Events_API | Subscribe_Event | Subscribe/Notify | API Invoker, API Publishing Function, API Management Function, API Exposing Function | +| | Update_Event_Subscription | Subscribe/Notify | API Invoker, API Publishing Function, API Management Function, API Exposing Function | +| | Notify_Event | Subscribe/Notify | API Invoker, API Publishing Function, API Management Function, API Exposing Function | +| | Unsubscribe_Event | Subscribe/Notify | API Invoker, API Publishing Function, API Management Function, API Exposing Function | +| CAPIF_API_Invoker_Management_API | Onboard_API_Invoker | Request/ Response | API Invoker | +| | Offboard_API_Invoker | Request/ Response | API Invoker | +| | Notify_Onboarding_Completion | Subscribe/Notify | API Invoker | +| | Update_API_Invoker_Details | Request/Response | API Invoker | +| | Notify_Update_Completion | Subscribe/Notify | API Invoker | +| CAPIF_Security_API | Obtain_Security_Method | Request/ Response | API Invoker | +| | Obtain_Authorization | Request/ Response | API Invoker | +| | Obtain_API_Invoker_Info | Request/ Response | API exposing function | +| | Revoke_Authorization | Request/ Response | API exposing function | +| CAPIF_Monitoring_API | Event operations (NOTE) | (NOTE) | API Management Function | +| CAPIF_Logging_API_Invocation_API | Log_API_Invocation | Request/ Response | API exposing function | +| CAPIF_Auditing_API | Query_API_Invocation_Log | Request/ Response | API management function | +| CAPIF_Access_Control_Policy_API | Obtain_Access_Control_Policy | Request/Response | API Exposing Function | +| CAPIF_API_Provider_Management_API | Register_API_Provider | Request/Response | API Management Function | +| | Update_API_Provider | Request/Response | API Management Function | +| | Deregister_API_Provider | Request/Response | API Management Function | +| CAPIF_Routing_Info_API | Obtain_Routing_Info | Request/Response | API exposing function | +| NOTE: The service operations of CAPIF Events API are reused by the CAPIF_Discover_Service_API, CAPIF_Publish_Service_API and CAPIF_Monitoring_API for events related services. | | | | + +Table 5.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|-------------|----------------------------|---------|-------| +|--------------|--------|-------------|----------------------------|---------|-------| + +| CAPIF_Discover_Service_API | 8.1 | CAPIF API discovery service | TS29222_CAPIF_Discover_Service_API.yaml | service-apis | A.2 | +|-----------------------------------|------|-------------------------------------------|------------------------------------------------|-------------------------|------| +| CAPIF_Publish_Service_API | 8.2 | CAPIF API Publish Service | TS29222_CAPIF_Publish_Service_API.yaml | published-apis | A.3 | +| CAPIF_Events_API | 8.3 | CAPIF event service | TS29222_CAPIF_Events_API.yaml | capif-events | A.4 | +| CAPIF_API_Invoker_Management_API | 8.4 | CAPIF API Invoker Management Service | TS29222_CAPIF_API_Invoker_Management_API.yaml | api-invoker-management | A.5 | +| CAPIF_Security_API | 8.5 | CAPIF Security Service | TS29222_CAPIF_Security_API.yaml | capif-security | A.6 | +| CAPIF_Access_Control_Policy_API | 8.6 | CAPIF Access Control Policy API Service | TS29222_CAPIF_Access_Control_Policy_API.yaml | access-control-policy | A.7 | +| CAPIF_Logging_API_Invocation_API | 8.7 | CAPIF Logging API Invocation Service | TS29222_CAPIF_Logging_API_Invocation_API.yaml | api-invocation-logs | A.8 | +| CAPIF_Auditing_API | 8.8 | CAPIF Auditing API Service | TS29222_CAPIF_Auditing_API.yaml | logs | A.9 | +| CAPIF_API_Provider_Management_API | 8.9 | CAPIF API Provider Management API Service | TS29222_CAPIF_API_Provider_Management_API.yaml | api-provider-management | A.11 | +| CAPIF_Routing_Info_API | 8.10 | CAPIF Routing Information API Service | TS29222_CAPIF_Routing_Info_API.yaml | capif-routing-info | A.12 | + +## 5.2 CAPIF\_Discover\_Service\_API + +### 5.2.1 Service Description + +#### 5.2.1.1 Overview + +The CAPIF discover service APIs, as defined in 3GPP TS 23.222 [2], allow API invokers via CAPIF-1/1e reference points to discover service API available at the CAPIF core function, and allow CAPIF core function via CAPIF-6 and CAPIF-6e reference points to discover service API available at other CAPIF core function. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operation defined for CAPIF\_Discover\_Service\_API is shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Operations of the CAPIF\_Discover\_Service\_API** + +| Service operation name | Description | Initiated by | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| Discover_Service_API | This service operation is used by an API invoker to discover service API available at the CAPIF core function. This service operation is also used by CAPIF core function to discover service APIs available at other CAPIF core function. | API invoker, CAPIF core function | + +## 5.2.2.2 Discover\_Service\_API + +### 5.2.2.2.1 General + +This service operation is used by: + +- an API invoker to discover service API available at the CAPIF core function; or +- a CAPIF core function to discover service API available at other CAPIF core function in interconnection scenario. + +### 5.2.2.2.2 Consumer discovering service API using Discover\_Service\_API service operation + +To discover service APIs available at the CAPIF core function, the consumer (e.g. API invoker) shall send an HTTP GET message with the API invoker Identifier or CAPIF core function Identifier and query parameters to the CAPIF core function as specified in clause 8.1.2.2.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall: + +1. verify the identity of the consumer (e.g. API invoker) and check if the consumer is authorized to discover the service APIs; +2. if the consumer is authorized to discover the service APIs, the CAPIF core function shall: + - a. search the CAPIF core function (API registry) for APIs matching the query criteria; + - b. apply the discovery policy, if any, on the search results and filter the search results to obtain the list of service API description or the information of the CAPIF core function which is required to be contacted further for discovering the service APIs; and + - c. return the filtered search results or the information of the CAPIF core function in the response message. The shareableInformation for each of serviceAPIDescription is not provided in the filtered search results; + +NOTE: The {apiRoot} part of the URI structure (defined in clause 5.2.4 of 3GPP TS 29.122 [14]) for the discovered APIs can be constructed by the API invoker based on either the "domainName" attribute (which contains all the required information, e.g. FQDN or IP address, port, a deployment specific string in the form of a sequence of path segments) or the "interfaceDescriptions" attribute of the AefProfile data type. + +and + +3. if errors occur when processing the request, the CAPIF core function shall respond to the consumer with an appropriate error status code as defined in clause 8.1.5. + +## 5.3 CAPIF\_Publish\_Service\_API + +### 5.3.1 Service Description + +#### 5.3.1.1 Overview + +The CAPIF publish service APIs, as defined in 3GPP TS 23.222 [2], allow API publishing function via CAPIF-4 and CAPIF-4e reference points to publish and manage published service APIs at the CAPIF core function, and allow CAPIF core function via CAPIF-6 and CAPIF-6e reference points to publish and manage published service APIs at other CAPIF core function. + +NOTE: Functions from 3rd party API provider domain can also access this API with sufficient permissions. + +## 5.3.2 Service Operations + +### 5.3.2.1 Introduction + +The service operations defined for the CAPIF\_Publish\_Service API are shown in table 5.3.2.1-1. + +**Table 5.3.2.1-1: Operations of the CAPIF\_Publish\_Service\_API** + +| Service operation name | Description | Initiated by | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| Publish_Service_API | This service operation is used by an API publishing function to publish service APIs on the CAPIF core function. This service operation is also used by CAPIF core function to publish service APIs on other CAPIF core function. | API publishing function, CAPIF core function | +| Unpublish_Service_API | This service operation is used by an API publishing function to un-publish service APIs from the CAPIF core function. This service operation is also used by CAPIF core function to un-publish service APIs on other CAPIF core function. | API publishing function, CAPIF core function | +| Get_Service_API | This service operation is used by an API publishing function to retrieve service APIs from the CAPIF core function. This service operation is also used by CAPIF core function to retrieve service APIs on other CAPIF core function. | API publishing function, CAPIF core function | +| Update_Service_API | This service operation is used by an API publishing function to update published service APIs on the CAPIF core function. This service operation is also used by CAPIF core function to update published service APIs on other CAPIF core function. | API publishing function, CAPIF core function | + +### 5.3.2.2 Publish\_Service\_API + +#### 5.3.2.2.1 General + +This service operation is used by: + +- an API publishing function to publish service APIs on the CAPIF core function; or +- a CAPIF core function to publish service APIs on other CAPIF core function in interconnection scenario. + +#### 5.3.2.2.2 API publishing function publishing service APIs on CAPIF core function using Publish\_Service\_API service operation + +To publish service APIs at the CAPIF core function, the API publishing function shall send an HTTP POST message to the CAPIF core function. The body of the HTTP POST message shall include API Information as specified in clause 8.2.2.2.3.1. + +Upon receiving the above described HTTP POST message, the CAPIF core function shall: + +1. verify the identity of the API publishing function and check if the API publishing function is authorized to publish service APIs; +2. if the API publishing function is authorized to publish service APIs, the CAPIF core function shall: + - a. verify the API Information present in the HTTP POST message and add the service APIs in the CAPIF core function (API registry); + - b. If topology hiding is enabled as per policy, the CAPIF core function shall: + - i. determine the service APIs which require topology hiding as per policy; + - ii. determine the API exposing function(s) responsible for the topology hiding for each service API which requires topology hiding; + +- iii. create a API topology hiding information for each service API which requires topology hiding by extracting the API identification information and the API exposing function(s) information from the service API information added to the CAPIF core function (API registry); + - iv. replace the API exposing function(s) information in the service API information added to the CAPIF core function (API registry) with the corresponding API exposing function(s) information responsible for the topology hiding for service API; + - v. send a notification message with the API topology hiding information to the API exposing function(s) which is responsible for the topology hiding for a service API and that has subscribed to the API\_TOPOLOGY HIDING\_CREATED event; and + - vi. store the API topology hiding information in the CAPIF core function; +- c. create a new resource using the service API information in the CAPIF core function (API registry) as specified in clause 8.2.2.1; + - d. send a notification message with the updated service API, to all API Invokers that subscribed to the Service API Update event; and + - e. return the CAPIF Resource URI in the response message; +- and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API publishing function with an appropriate error status code as defined in clause 8.2.5. + +### 5.3.2.2.3 CAPIF core function publishing service APIs on other CAPIF core function using Publish\_Service\_API service operation + +To publish service APIs at other CAPIF core function, the requesting CAPIF core function shall send an HTTP POST message to the peer CAPIF core function. The body of the HTTP POST message shall include API Information as specified in clause 8.2.2.2.3.1. For service API publishing on CAPIF-6 reference point, the requesting CAPIF core function shall also include the published API path "pubApiPath" as specified in clause 8.2.4.2.2. The "pubApiPath" includes a list of CAPIF core function Identifiers within the same CAPIF provider domain, such list includes own CAPIF core function identifier of the requesting CAPIF core function and received CAPIF core function identifier(s) from other CAPIF core function. + +If the requesting CAPIF core function knows the peer CAPIF core function identifier, it shall not send the HTTP POST message to the peer CAPIF core function if the peer CAPIF core function identifier is included in the published API path. + +Upon receiving the above described HTTP POST message, the peer CAPIF core function shall: + +1. verify the identity of the requesting CAPIF core function in the URI and check if the requesting CAPIF core function is authorized to publish service APIs; + 2. if the requesting CAPIF core function is authorized to publish service APIs, the peer CAPIF core function shall check if own CAPIF core function identifier is within the published API path (if received). If it is not within the path, the peer CAPIF core function shall add its own identifier in the path; otherwise reject the HTTP POST request and skip step 3; + 3. then the peer CAPIF core function shall: + - a. verify the rest API Information present in the HTTP POST message and add the service APIs in the peer CAPIF core function (API registry); + - b. create a new resource as specified in clause 8.2.2.1; + - c. send a notification message with the updated service API, to all API Invokers that subscribed to the Service API Update event; and + - d. return the CAPIF Resource URI in the response message; +- and + +4. if errors occur when processing the request, the peer CAPIF core function shall respond to the peer CAPIF core function with an appropriate error status code as defined in clause 8.2.5. + +### 5.3.2.3 Unpublish\_Service\_API + +#### 5.3.2.3.1 General + +This service operation is used by: + +- an API publishing function to un-publish service APIs from the CAPIF core function; or +- a CAPIF core function to un-publish service APIs on other CAPIF core function in interconnection scenario. + +#### 5.3.2.3.2 Consumer un-publishing service APIs from CAPIF core function using Unpublish\_Service\_API service operation + +To un-publish service APIs from the CAPIF core function, the consumer (e.g. API publishing function) shall send an HTTP DELETE message using the CAPIF Resource URI received during the publish operation to the CAPIF core function as specified in clause 8.2.2.3.3.3. + +Upon receiving the above described HTTP DELETE message, the CAPIF core function shall + +1. verify the identity of the consumer (e.g. API publishing function) and check if the consumer is authorized to un-publish service APIs; +2. if the consumer is authorized to un-publish service APIs, the CAPIF core function shall: + - a. delete the resource pointed by the CAPIF Resource URI; + - b. delete the relevant service APIs from the CAPIF core function (API registry); + - c. If topology hiding is enabled as per policy, the CAPIF core function shall: + - i. determine the API topology hiding information associated with the service API and delete the corresponding API topology hiding information in the CAPIF core function; and + - ii. send a notification message with the deleted API topology hiding information to the corresponding API exposing function(s) which were responsible for the topology hiding of the service API and that subscribed to the API\_TOPOLOGY HIDING\_REVOKED event; and + - d. send a notification message with the deleted service API, to all API Invokers that subscribed to the Service API Update event; + +and + +3. if errors occur when processing the request, the CAPIF core function shall respond to the consumer with an appropriate error status code as defined in clause 8.2.5. + +### 5.3.2.4 Get\_Service\_API + +#### 5.3.2.4.1 General + +This service operation is used by: + +- an API publishing function to retrieve service APIs from the CAPIF core function; or +- a CAPIF core function to retrieve service APIs from other CAPIF core function in interconnection scenario. + +#### 5.3.2.4.2 Consumer retrieving service APIs from CAPIF core function using Get\_Service\_API service operation + +To retrieve information about the published service APIs from the CAPIF core function, the consumer (e.g. API publishing function) shall send an HTTP GET message to the CAPIF core function. For retrieving the entire list of + +service APIs, the HTTP GET message shall be sent to the collection of service APIs resource representation URI as specified in clause 8.2.2.3.3.2. For retrieving a specific service API, the HTTP GET message shall be sent to that service API's resource representation URI as described in clause 8.2.2.3.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall: + +1. verify the identity of the consumer (e.g. API publishing function) and check if the consumer is authorized to retrieve information about the published service APIs; +2. if the consumer is authorized to retrieve information about the published service APIs, the CAPIF core function shall: + - a. respond with the requested API Information;and +3. if errors occur when processing the request, the CAPIF core function shall respond to the consumer with an appropriate error status code as defined in clause 8.2.5. + +### 5.3.2.5 Update\_Service\_API + +#### 5.3.2.5.1 General + +This service operation is used by: + +- an API publishing function to update published service APIs on the CAPIF core function; or +- a CAPIF core function to update published service APIs on other CAPIF core function in interconnection scenario. + +#### 5.3.2.5.2 Consumer updating published service APIs on CAPIF core function using Update\_Service\_API service operation + +To update information of published service APIs, the consumer (e.g. API publishing function) shall send an HTTP PUT message to that service API's resource representation URI in the CAPIF core function. The body of the HTTP PUT message shall include updated API Information as specified in clause 8.2.2.3.3.2; otherwise, if the "PatchUpdate" feature defined in clause 8.2.6 is supported, the consumer (e.g. API publishing function) may send an HTTP PATCH request message to the concerned service API resource URI in the CAPIF core function. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 8.2.2.3.3.4. + +Upon receiving the above described HTTP PUT or PATCH request message, the CAPIF core function shall: + +1. verify the identity of the consumer (e.g. API publishing function) and check if the consumer is authorized to update information of published service APIs; +2. if the consumer is authorized to update information of published service APIs, the CAPIF core function shall: + - a. verify the API Information present in the HTTP PUT or PATCH request message and replace/modify the service APIs in the CAPIF core function (API registry); + - b. if topology hiding is enabled as per policy, the CAPIF core function shall: + - i. if the service API being updated has a corresponding API topology hiding information in the CAPIF core function, then update the API topology hiding information with any updated API exposing function(s) information from the service API information replaced at the CAPIF core function (API registry); + - ii. replace/modify the API exposing function(s) information in the service API information added to the CAPIF core function (API registry) with the corresponding API exposing function(s) information responsible for the topology hiding for service API; + - iii. send a notification message with the API topology hiding information to the API exposing function(s) which is responsible for the topology hiding for a service API and that has subscribed to the API\_TOPOLOGY HIDING\_CREATED event; and + +- iv. update the API topology hiding information in the CAPIF core function; + - c. replace/modify the existing resource accordingly using the updated service API information in the CAPIF core function (API registry); and + - d. send a notification message with the updated service API, to all API Invokers that subscribed to the Service API Update event; +- and +- 3. if errors occur when processing the request, the CAPIF core function shall respond to the consumer with an appropriate error status code as defined in clause 8.2.5. + +## 5.4 CAPIF\_Events\_API + +### 5.4.1 Service Description + +#### 5.4.1.1 Overview + +The CAPIF events APIs, as defined in 3GPP TS 23.222 [2], allow an API invoker via CAPIF-1/1e reference points, API exposure function via CAPIF-3/3e reference points, API publishing function via CAPIF-4/4e reference points and API management function via CAPIF-5/5e reference points to subscribe to and unsubscribe from CAPIF events and to receive notifications from CAPIF core function. + +NOTE: The functional elements listed above are referred to as Subscriber in the service operations described in the clauses below. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The service operations defined for the CAPIF\_Events\_API are shown in table 5.4.2.1-1. + +**Table 5.4.2.1-1: Operations of the CAPIF\_Events\_API** + +| Service operation name | Description | Initiated by | +|---------------------------|----------------------------------------------------------------------------------------------|---------------------| +| Subscribe_Event | This service operation is used by a Subscriber to subscribe to CAPIF events. | Subscriber | +| Unsubscribe_Event | This service operation is used by a Subscriber to unsubscribe from CAPIF events | Subscriber | +| Notify_Event | This service operation is used by CAPIF core function to send a notification to a Subscriber | CAPIF core function | +| Update_Event_Subscription | This service operation is used by a Subscriber to update the subscription to CAPIF events | Subscriber | + +#### 5.4.2.2 Subscribe\_Event + +##### 5.4.2.2.1 General + +This service operation is used by a Subscriber to subscribe to CAPIF events. + +##### 5.4.2.2.2 Subscribing to CAPIF events using Subscribe\_Event service operation + +To subscribe to CAPIF events, the Subscriber shall send an HTTP POST message to the CAPIF core function. The body of the HTTP POST message shall include Subscriber's Identifier, Event Type and a Notification Destination URI as specified in clause 8.3.2.2.3.1. + +For all events included in the HTTP POST message, if the Enhanced\_event\_report feature is supported, the Subscriber may include an event report requirement in the "eventReq" attribute including: + +- event notification method (periodic, one time, on event detection) in the "notifMethod" attribute; +- maximum Number of Reports in the "maxReportNbr" attribute; +- monitoring duration in the "monDur" attribute; +- repetition period for periodic reporting in the "repPeriod" attribute; and/or +- immediate reporting indication in the "immRep" attribute. + +If the Enhanced\_event\_report feature is supported, the Subscriber may also include an event filter in the "eventFilters" attribute. The "eventFilters" attribute shall include: + +- if the event is SERVICE\_API\_AVAILABLE, SERVICE\_API\_UNAVAILABLE or SERVICE\_API\_UPDATE, the API IDs in the "apiIds" attribute; +- if the event is API\_INVOKER\_ONBOARDED or API\_INVOKER\_OFFBOARDED or API\_INVOKER\_UPDATED, the API invoker IDs in the "apiInvokerIds" attribute; +- if the event is ACCESS\_CONTROL\_POLICY\_UPDATE, the API invoker IDs in the "apiInvokerIds" attribute and/or API identifications in the "apiIds" attribute; and/or +- if the event is SERVICE\_API\_INVOCATION\_SUCCESS or SERVICE\_API\_INVOCATION\_FAILURE, the API invoker IDs in the "apiInvokerIds" attribute, AEF identifiers in the "aefIds" attribute and/or API IDs in the "apiIds" attribute. + +Upon receiving the above described HTTP POST message, the CAPIF core function shall: + +1. verify the identity of the Subscriber and check if the Subscriber is authorized to subscribe to the CAPIF events mentioned in the HTTP POST message; +2. if the Subscriber is authorized to subscribe to the CAPIF events, the CAPIF core function shall: + - a. create a new resource as specified in clause 8.3.2.1; and + - b. return the CAPIF Resource URI in the response message;and +3. if errors occur when processing the request, the CAPIF core function shall respond to the Subscriber with an appropriate error status code as defined in clause 8.3.5. + +### 5.4.2.3 Unsubscribe\_Event + +#### 5.4.2.3.1 General + +This service operation is used by a Subscriber to un-subscribe from CAPIF events. + +#### 5.4.2.3.2 Unsubscribing from CAPIF events using Unsubscribe\_Event service operation + +To unsubscribe from CAPIF events, the Subscriber shall send an HTTP DELETE message to the resource representing the event in the CAPIF core function as specified in clause 8.3.2.3.1.1. + +Upon receiving the HTTP DELETE message, the CAPIF core function shall: + +1. verify the identity of the Unsubscribing functional entity and check if the Unsubscribing functional entity is authorized to Unsubscribe from the CAPIF event associated with the CAPIF Resource URI; +2. if the Unsubscribing functional entity is authorized to unsubscribe from the CAPIF events, the CAPIF core function shall delete the resource pointed by the CAPIF Resource URI; and + +3. if errors occur when processing the request, the CAPIF core function shall respond to the Subscriber with an appropriate error status code as defined in clause 8.3.5. + +#### 5.4.2.4 Notify\_Event + +##### 5.4.2.4.1 General + +This service operation is used by CAPIF core function to send a notification to a Subscriber. + +##### 5.4.2.4.2 Notifying CAPIF events using Notify\_Event service operation + +To notify CAPIF events, the CAPIF core function shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include an Event Notification and CAPIF Resource URI. + +If the Enhanced\_event\_report feature is supported, the CAPIF core function may include an event detail in the "eventDetail" attribute. The "eventDetail" attribute shall include: + +- if the event is SERVICE\_API\_AVAILABLE or SERVICE\_API\_UNAVAILABLE, the API IDs in the "apiIds" attribute and, if the "ApiStatusMonitoring" feature is supported, additionally, the service API descriptions in the "serviceAPIDescriptions" attribute; +- if the event is SERVICE\_API\_UPDATE, the API descriptions in the "serviceAPIDescriptions" attribute; +- if the event is API\_INVOKER\_ONBOARDED or API\_INVOKER\_OFFBOARDED or API\_INVOKER\_UPDATED, the API invoker IDs in the "apiInvokerIds" attribute; +- if the event is ACCESS\_CONTROL\_POLICY\_UPDATE, the access control policy information in the "accCtrlPolList" attribute; +- if the event is SERVICE\_API\_INVOCATION\_SUCCESS or SERVICE\_API\_INVOCATION\_FAILURE, the API invocation logs in the "invocationLogs" attribute; or +- if the event is API\_TOPOLOGY HIDING\_CREATED or API\_TOPOLOGY HIDING\_REVOKED, the API topology hiding information in the "apiTopoHide" attribute. + +Upon receiving the HTTP POST message, the Subscriber shall process the Event Notification. + +#### 5.4.2.5 Update\_Event\_Subscription + +##### 5.4.2.5.1 General + +This service operation is used by a Subscriber to update the subscription to CAPIF events. + +##### 5.4.2.5.2 Update Subscription to CAPIF events using Update\_Event\_Subscription service operation + +To update the subscription details to CAPIF events, the Subscriber shall send an HTTP PUT/PATCH request message to the CAPIF core function. The body of the HTTP PUT request message shall include the EventSubscription data structure specified in clause 8.3.4.2.2. The body of the HTTP PATCH request message shall include the EventSubscriptionPatch data structure specified in clause 8.3.4.2.8. + +Upon receiving the HTTP PUT or PATCH message described above, the CAPIF core function shall: + +1. verify the identity of the Subscriber and check if the Subscriber is authorized to update/modify the subscription; +2. update the resource and respond to the CAPIF core function with either a "200 OK" status code with the response body containing an updated representation of the resource within the EventSubscription data structure, or a "204 No Content" status code. + +## 5.5 CAPIF\_API\_Invoker\_Management\_API + +### 5.5.1 Service Description + +#### 5.5.1.1 Overview + +The CAPIF API invoker management APIs, as defined in 3GPP TS 23.222 [2], allow API invokers via CAPIF-1/1e reference points to on-board and off-board itself as a recognized user of the CAPIF or update the API invoker's details on the CAPIF core function. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +The service operations defined for the CAPIF API Invoker Management API are shown in table 5.5.2.1-1. + +**Table 5.5.2.1-1: Operations of the CAPIF\_API\_Invoker\_Management\_API** + +| Service operation name | Description | Initiated by | +|------------------------------|---------------------------------------------------------------------------------------------------------------|---------------------| +| Onboard_API_Invoker | This service operation is used by an API invoker to on-board itself as a recognized user of CAPIF | API invoker | +| Offboard_API_Invoker | This service operation is used by an API invoker to off-board itself as a recognized user of CAPIF | API invoker | +| Notify_Onboarding_Completion | This service operation is used by CAPIF core function to send an on-boarding notification to the API invoker. | CAPIF core function | +| Update_API_Invoker_Details | This service operation is used by an API invoker to update API invoker's details in the CAPIF core function. | API Invoker | +| Notify_Update_Completion | This service operation is used by CAPIF core function to send an update notification to the API invoker | CAPIF core function | + +#### 5.5.2.2 Onboard\_API\_Invoker + +##### 5.5.2.2.1 General + +This service operation is used by an API invoker to on-board itself as a recognized user of CAPIF + +##### 5.5.2.2.2 API invoker on-boarding itself as a recognized user of CAPIF using Onboard\_API\_Invoker service operation + +To on-board itself as a recognized user of the CAPIF, the API invoker shall send an HTTP POST message to the CAPIF core function. The body of the HTTP POST message shall include API invoker Enrolment Details, API List and a Notification Destination URI for on-boarding notification as specified in clause 8.4.2.2.3.1. + +Upon receiving the above described HTTP POST message, the CAPIF core function shall check if it can determine authorization of the request and on-board the API invoker automatically. If the CAPIF core function: + +1. can determine authorization of the request and on-board the API invoker automatically, the CAPIF core function: + - a. shall process the API invoker Enrolment Details and the API List received in the HTTP POST message and determine if the request sent by the API invoker is authorized or not; and + - b. if the API invoker's request is authorized, the CAPIF core function shall: + - i. create the API invoker Profile consisting of an API invoker Identifier, Authentication Information, Authorization Information and CAPIF Identity Information; + +- ii. verify the API List present in the HTTP POST message and create a API List of APIs the API invoker is allowed to access; + - iii. create a new resource as defined in clause 8.4.2.1; + - iv. return the API invoker Profile, API List of APIs the API invoker is allowed to access and the CAPIF Resource URI in the response message. + - 2. cannot determine authorization of the request to on-board the API invoker automatically, the CAPIF core function: + - a. shall acknowledge the receipt of the on-boarding request to the API invoker. + - b. shall request the CAPIF administrator to validate the on-boarding request or the API management to validate the on-boarding request by sharing the API invoker Enrolment Details and the API List received in the HTTP POST message; + - c. on receiving confirmation of successful validation of the on-boarding request from the CAPIF administrator or the API management, the CAPIF core function shall: + - i. create the API invoker Profile consisting of an API invoker Identifier, Authentication Information, Authorization Information and CAPIF Identity Information; + - ii. create a new resource as defined in clause 8.4.3; and + - iii. deliver the API invoker Profile, API List of APIs the API invoker is allowed to access and the CAPIF Resource URI to the API invoker in a notification; +- and +- 3. if errors occur when processing the request, the CAPIF core function shall respond to the API invoker with an appropriate error status code as defined in clause 8.4.5. + +NOTE 1: How the CAPIF core function determines that the CAPIF core function can process the request and on-board the API invoker automatically is out-of-scope of this specification. + +NOTE 2: How the CAPIF core function determines that the API invoker's request to on-board is authorized is specified in 3GPP TS 33.122 [16]. + +NOTE 3: Interactions between the CAPIF core function and the CAPIF administrator or the API management is out-of-scope of this specification. + +NOTE 4: The onboarding credential received by the API invoker from the service provider as specified in 3GPP TS 33.122 [16] is included in the Authorization header field of the HTTP request message as described in IETF RFC 9110 [5]. + +NOTE 5: After the onboarding operation is completed the API Invoker no longer needs to maintain the Notification Destination URI and may delete it. + +### 5.5.2.3 Offboard\_API\_Invoker + +#### 5.5.2.3.1 General + +This service operation is used by an API invoker to stop being as a recognized user of CAPIF + +#### 5.5.2.3.2 API invoker off-boarding itself as a recognized user of CAPIF using Offboard\_API\_Invoker service operation + +To off-board itself as a recognized user of the CAPIF, the API invoker shall send an HTTP DELETE message to its resource representation in the CAPIF core function as specified in clause 8.4.2.3.3.1. + +Upon receiving the HTTP DELETE message, the CAPIF core function shall: + +- 1. determine if the request sent by the API invoker is authorized or not; + +2. if the API invoker's request is authorized, the CAPIF core function shall: + - a. delete the resource representation pointed by the CAPIF Resource Identifier; and + - b. delete the related API invoker profile; +- and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API invoker with an appropriate error status code as defined in clause 8.4.5. + +#### 5.5.2.4 Notify\_Onboarding\_Completion + +##### 5.5.2.4.1 General + +This service operation is used by the CAPIF core function to send a notification about the completion of the Onboarding operation to the API Invoker. + +##### 5.5.2.4.2 Notifying Onboarding completion using Notify\_Onboarding\_Completion service operation + +When the CAPIF core function cannot immediately authorize the API invoker that issued an Onboarding request (see clause 5.5.2.2.2) it will send a response acknowledging the request and begin processing it. After completion, the CAPIF core function shall send an HTTP POST message using the Notification Destination URI received in the Onboarding request. The body of the HTTP POST message shall include the API Invoker Profile, API List of the APIs the API invoker is allowed to access and the CAPIF Resource URI. + +Upon receiving the HTTP POST message, the API invoker shall process the message in the same manner it would have processed an immediate response to the Onboarding request, and respond to the HTTP POST message with an acknowledgement and no body. + +#### 5.5.2.5 Update\_API\_Invoker\_Details + +##### 5.5.2.5.1 General + +This service operation is used by an API invoker to update the API invoker's profile details on the CAPIF core function. + +##### 5.5.2.5.2 API invoker updating its details on CAPIF using Update\_API\_Invoker\_Details service operation + +To update the API invoker's profile details on the CAPIF core function, the API invoker shall send a HTTP PUT message to the CAPIF core function to its resource representation, requesting to replace all properties in the existing resource, addressed by the URI received in the response to the request that has created the API invoker profile resource. The properties "apiInvokerId" and "onboardingInformation" shall remain unchanged from the previously provided values. The body of the HTTP PUT message shall include the APIInvokerEnrolmentDetails data structure with API invoker identity information, API invoker details that need to be updated and a Notification Destination URI for update notification as specified in clause 8.4.2.3.3.2. API invoker details may include API invoker information and API List. Otherwise, if the "PatchUpdate" feature defined in clause 8.4.6 is supported, the consumer (e.g. API invoker function) may send an HTTP PATCH request message to the concerned service API resource URI in the CAPIF core function to modify the API invoker's profile. The body of the HTTP PATCH request message shall include the APIInvokerEnrolmentDetailsPatch data structure. + +Upon receiving the above described HTTP PUT or PATCH request message: + +1. if the CAPIF core function decides to update the API list of the API invoker without validation by CAPIF administrator, then the CAPIF core function: + - a. shall determine if the request in the HTTP PUT or PATCH request message by the API invoker is authorized or not; + +- b. verify that the "apiInvokerId" and "onboardingInformation" properties are same as in API invoker resource on CAPIF core function; + - c. if the API invoker's request is authorized and the properties "apiInvokerId" and "onboardingInformation" match, the CAPIF core function shall: + - i. if the request contains an API list: + - create a list of APIs the API invoker is allowed to access; and + - update the resource identified by the CAPIF Resource URI of the API invoker's HTTP PUT or PATCH request with the updated information in the request and the API list created in step A; + - ii. if the request does not contain an API list, update the resource identified by the CAPIF Resource URI of the API invoker's HTTP PUT or PATCH request with the updated information in the request; and + - iii. return the updated API invoker details; +2. otherwise, the CAPIF core function: +- a. shall acknowledge the receipt of the update API invoker details request to the API invoker; + - b. verify that the "apiInvokerId" and "onboardingInformation" properties are same as in API invoker resource on CAPIF core function; + - c. if the properties "apiInvokerId" and "onboardingInformation" match, then shall request the CAPIF administrator to validate the request or the API management to validate the request by sharing the API invoker identity information and the updated information received in the HTTP PUT message or PATCH request; + - d. on receiving confirmation of successful validation of the request from the CAPIF administrator or the API management, the CAPIF core function shall: + - i. update the resource identified by the CAPIF Resource URI of the API invoker's HTTP PUT or PATCH request, with validated information; and + - ii. return the updated API invoker details; + +and + +- 3. if errors occur when processing the request, the CAPIF core function shall respond to the API invoker with an appropriate error status code as defined in clause 8.4.5. + +NOTE 1: How the CAPIF core function determines that the CAPIF core function can process the request and update the API list of the API invoker automatically is out-of-scope of this specification. + +NOTE 2: Interactions between the CAPIF core function and the CAPIF administrator or the API management is out-of-scope of this specification. + +NOTE 3: After the operation is completed the API Invoker no longer needs to maintain the Notification Destination URI and may delete it. + +## 5.5.2.6 Notify\_Update\_Completion + +### 5.5.2.6.1 General + +This service operation is used by the CAPIF core function to send a notification about the completion of the update of API invoker's details. + +### 5.5.2.6.2 Notifying API invoker update completion using Notify\_Update\_Completion service operation + +When the CAPIF core function cannot immediately grant the update request (see clause 5.5.2.5.2) it will send a response acknowledging the request and begin processing it. After completion, the CAPIF core function shall send an + +HTTP POST message using the Notification Destination URI received in the update details request. The body of the HTTP POST message shall include the updated API Invoker details. + +Upon receiving the HTTP POST message, the API invoker shall process the message in the same manner it would have processed an immediate response to the update the details of the API invoker request, and respond to the HTTP POST message with HTTP response 204 No content. + +## 5.6 CAPIF\_Security\_API + +### 5.6.1 Service Description + +#### 5.6.1.1 Overview + +The CAPIF security APIs, as defined in 3GPP TS 23.222 [2], allow: + +- API invokers via CAPIF-1/1e reference points to (re-)negotiate the service security method and obtain authorization for invoking service APIs; and +- API exposing function via CAPIF-3/3e reference points to obtain authentication information of the API invoker for authentication of the API invoker and revoke the authorization for service APIs. + +### 5.6.2 Service Operations + +#### 5.6.2.1 Introduction + +The service operations defined for CAPIF\_Security\_API are shown in table 5.6.2.1-1. + +**Table 5.6.2.1-1: Operations of the CAPIF\_Security\_API** + +| Service operation name | Description | Initiated by | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Obtain_Security_Method | This service operation is used by an API invoker to negotiate and obtain service API security methods from the CAPIF core function. This information is used by the API invoker for service API invocations at the API Exposing Function. | API invoker | +| Obtain_Authorization | This service operation is used by an API invoker to obtain authorization to access service APIs. | API invoker | +| Obtain_API_Invoker_Info | This service operation is used by an API exposing function to obtain the authentication or authorization information related to an API invoker. | API exposing function | +| Revoke_Authorization | This service operation is used by an API exposing function to invalidate the authorization of an API invoker. | API exposing function | + +Security information is generated when requested by an API invoker, and is stored in the CAPIF Core function. The information can be accessed via a resource representation URI using the API invoker ID as described in clause 8.5.2.3. The URI is provided to the API invoker in the HTTP response to the creation request (via the Obtain\_Security\_Method service operation name). + +Refer to clause 9.1.2a.2 for details about verifying that the API Exposing function has the ability to authorize API invokers prior to invoking service APIs. + +#### 5.6.2.2 Obtain\_Security\_Method + +##### 5.6.2.2.1 General + +This service operation is used by an API invoker to negotiate and obtain service API security method from the CAPIF core function. The information received by API invoker shall be used for authentication with the API exposing function. + +### 5.6.2.2.2 Request service API security method from CAPIF using Obtain\_Security\_Method service operation + +To negotiate and obtain service API security method information from the CAPIF core function, the API invoker shall send an HTTP PUT message to the CAPIF core function. The body of the HTTP PUT message shall include Security Method Request and a Notification Destination URI for security related notifications. The Security Method Request from the API invoker contains the unique interface details of the service APIs and may contain a preferred method for each unique service API interface as specified in clause 8.5.2.3.3.3. + +Upon receiving the above described HTTP PUT message, the CAPIF core function shall: + +1. determine the security method for each service API interface as specified in 3GPP TS 33.122 [16]; +2. store the Notification Destination URI for security related notification; +3. create a new resource as defined in clause 8.5.2.1; +4. return the security method information and the CAPIF Resource URI in the response message; and +5. if errors occur when processing the request, the CAPIF core function shall respond to the API invoker with an appropriate error status code as defined in clause 8.5.5. + +### 5.6.2.3 Obtain\_Authorization + +#### 5.6.2.3.1 General + +This service operation is used by an API invoker to negotiate and obtain authorization information from the CAPIF core function. The information received by API invoker shall be used for authorization to invoke service APIs exposed by the API exposing function. + +#### 5.6.2.3.2 Obtain authorization using Obtain\_Authorization service operation + +To obtain authorization information from the CAPIF core function to invoke service APIs, the API invoker shall perform the functions of the resource owner, client and redirection endpoints as described in clause 6.5.2.3 of 3GPP TS 33.122 [16]. + +The API invoker shall send a POST request to the "Token Endpoint", as described in IETF RFC 6749 [23], clause 3.2. The "Token Endpoint" URI shall be: + +`{apiRoot}/capif-security/v1/securities/{securityId}/token` + +where {securityId} is the API invoker identifier and represents the "Individual trusted API invoker" resource created during obtain security method, as described in clause 5.6.2.2. + +The body of the HTTP POST request shall indicate that the required OAuth2 grant must be of type "client\_credentials" or "authorization\_code". The grant type shall be set as "authorization\_code" when API invoker uses authorization code flow. **The grant type shall be set as "client\_credentials" when API invoker uses client credentials flow.** The "scope" parameter (if present) shall include a list of AEF identifiers and its associated API names the API invoker is trying to access (i.e., the API invoker expected scope). If the request is sent for authorization code flow, the request shall include the authorization code obtained through interaction with the "Authorization Endpoint" as specified in clause 5.6.2.3.3. If the request is sent for client credentials flow in RNAA scenarios, the request may include the resource owner ID (i.e. the GPSI as defined in clause 6.5.3.1 of TS 33.122 [16]). + +**Editor's Note: It is FFS to clarify the scenarios where client credential may be used for RNAA use cases.** + +The API invoker may use HTTP Basic authentication towards this endpoint, using the API invoker identifier as "username" and the onboarding secret as "password". Such username and password may be included in the header or body of the HTTP POST request. + +On success, "200 OK" shall be returned. The content of the POST response shall contain the requested access token, the token type and the expiration time for the token. The access token shall be a JSON Web Token (JWT) as specified in IETF RFC 7519 [24]. The access token returned by the CAPIF core function shall include the claims encoded as a + +JSON object as specified in clause 8.5.4.2.8 and then digitally signed using JWS as specified in IETF RFC 7515 [25] and in Annex C.1 of 3GPP TS 33.122 [16]. + +The digitally signed access token shall be converted to the JWS Compact Serialization encoding as a string as specified in clause 7.1 of IETF RFC 7515 [25]. + +If the access token request fails at the CAPIF core function, the CAPIF core function shall return "400 Bad Request" status code, including a JSON object in the response content, that includes details about the specific error that occurred. + +### 5.6.2.3.3 Obtain authorization code using Obtain\_Authorization service operation + +This service operation is used by the API invoker to obtain the authorization code from the CAPIF core function. + +If the API invoker uses the authorization code flow, the API invoker shall send a GET request to the "Authorization Endpoint", as described in IETF RFC 6749 [23], clause 4.1. The "Authorization Endpoint" URI shall be: + +`{apiRoot}/capif-security/v1/securities/{securityId}/code` + +where {securityId} is the API invoker identifier and represents the "Individual trusted API invoker" resource created during obtain security method, as described in clause 5.6.2.2. + +As per clause 4.1 of IETF RFC 6749 [23], the HTTP GET request shall indicate the response type as type "code" and other required parameters within query parameters. The "resource\_owner\_id" parameter shall include the resource owner ID. + +The API invoker may use HTTP Basic authentication towards this endpoint, using the API invoker identifier as "username" and the onboarding secret as "password". Such username and password may be included in the header or body of the HTTP GET request. + +On success, "302 Found" shall be returned. The payload body of the GET response shall contain the requested authorization code, as described in clause 4.1 IETF RFC 6749 [23]. + +**Editor's Note:** Whether this Obtain\_Authorization\_Code operation is needed or not and the corresponding details are FFS. + +### 5.6.2.4 Obtain\_API\_Invoker\_Info + +#### 5.6.2.4.1 General + +This service operation is used by an API exposing function to obtain the security information of API Invokers to be able to authenticate them and authorize each service API invocation by them. + +#### 5.6.2.4.2 Obtain API invoker's security information using Obtain\_API\_Invoker\_Info service operation + +To obtain authentication or authorization information from the CAPIF core function to authenticate or authorize an API invoker, the API exposing function shall send an HTTP GET message to that API invoker's resource representation URI in the CAPIF core function with an indication to request authentication and/or authorization information, as specified in clause 8.5.2.3.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall: + +1. determine the security information of API invoker for all the service API interfaces of the API exposing function; +2. return the security information in the response message; and + +NOTE: Functions from 3rd party API provider domain can also access this service operation with sufficient permissions. + +3. if errors occur when processing the request, the CAPIF core function shall respond to the API invoker with an appropriate error status code as defined in clause 8.5.5. + +## 5.6.2.5 Revoke\_Authentication + +### 5.6.2.5.1 General + +This service operation is used by an API exposing function to invalidate the authorization of a specified API Invoker to invoke service APIs exposed by the calling API exposing function. + +### 5.6.2.5.2 Invalidate authorization using Revoke\_Authorization service operation + +To invalidate authorization of an API invoker for all service APIs, the API exposing function shall send an HTTP DELETE message to that API invoker's resource representation URI in the CAPIF core function using the API invoker ID as specified in clause 8.5.2.3.3.2. + +Upon receiving the HTTP DELETE message, the CAPIF core function shall delete the resource representation and shall notify the API invoker of the authorization invalidation using the Notification Destination URI received in the Obtain\_Security\_Method message. + +The CAPIF core function shall also invalidate the previously assigned access token when the authorization of all service APIs are revoked for the API invoker. + +To invalidate authorization of an API invoker for some service APIs, the API exposing function shall send an HTTP POST message to that API invoker's "delete" custom resource representation URI in the CAPIF core function with a list of the service APIs that should be revoked. + +Upon receiving the HTTP POST message, the CAPIF core function shall revoke the authorization of the API invoker for the indicated service APIs (e.g. it may update the list of unauthorized APIs locally); and shall notify the API invoker of the authorization invalidation using the Notification Destination URI received in the Obtain\_Security\_Method message. + +In both alternatives, the CAPIF core function shall acknowledge the HTTP request from the API exposing function. + +NOTE: Functions from 3rd party API provider domain can also access this service operation with sufficient permissions. + +## 5.7 CAPIF\_Monitoring\_API + +The CAPIF monitoring API as defined in 3GPP TS 23.222 [2], allow the API management function via CAPIF-5/5e reference points to monitor service API invocations and receive such monitoring events from the CAPIF core function. + +The CAPIF\_Monitoring\_API shall use the CAPIF\_Events\_API as described in clause 8.3 by setting the CAPIFEvent to one of the events as described in clause 8.3.4.3.3. + +## 5.8 CAPIF\_Logging\_API\_Invocation\_API + +### 5.8.1 Service Description + +#### 5.8.1.1 Overview + +The Logging API invocations APIs, as defined in 3GPP TS 23.222 [2], allow API exposing functions via CAPIF-3/3e reference points to log the information related to service API invocations on the CAPIF core function. + +NOTE: Functions from 3rd party API provider domain can also access this API with sufficient permissions. + +## 5.8.2 Service Operations + +### 5.8.2.1 Introduction + +**Table 5.8.2.1-1: Operations of the CAPIF\_Logging\_API\_Invocation\_API** + +| Service operation name | Description | Initiated by | +|------------------------|----------------------------------------------------------------------------------------------------------------------|-----------------------| +| Log_API_Invocation | This service operation is used by an API exposing function to log API invocation information on CAPIF core function. | API exposing function | + +### 5.8.2.2 Log\_API\_Invocation\_API + +#### 5.8.2.2.1 General + +This service operation is used by an API exposing function to log API invocation information on CAPIF core function. + +#### 5.8.2.2.2 Logging service API invocations using Log\_API\_Invocation service operation + +To log service API invocations at the CAPIF core function, the API exposing function shall send an HTTP POST message to the CAPIF core function. The body of the HTTP POST message shall include API exposing function identity information and API invocation log information as specified in clause 8.7.2.2.3.1. + +Upon receiving the above described HTTP POST message, the CAPIF core function shall: + +1. verify the identity of the API exposing function and check if the API exposing function is authorized to create service API invocation logs; +2. if the API exposing function is authorized to create service API invocation logs, the CAPIF core function shall: + - a. process the API invocation log information received in the HTTP POST message and store the API invocation log information in the API repository; + - b. create a new resource as defined in clause 8.7.2.1; and + - c. return the CAPIF Resource Identifier in the response message; + and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API exposing function with an appropriate error status code as defined in clause 8.7.5. + +## 5.9 CAPIF\_Auditing\_API + +### 5.9.1 Service Description + +#### 5.9.1.1 Overview + +The Auditing API, as defined in 3GPP TS 23.222 [2], allows API management functions via CAPIF-5/5e reference points to query the log information stored on the CAPIF core function. + +NOTE: Functions from 3rd party API provider domain can also access this API with sufficient permissions. + +## 5.9.2 Service Operations + +### 5.9.2.1 Introduction + +**Table 5.9.2.1-1: Operations of the CAPIF\_Auditing\_API** + +| Service operation name | Description | Initiated by | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Query_Invocation_Logs | This service operation is used by an API management function to query API invocation information logs stored on CAPIF core function. | API management function | + +### 5.9.2.2 Query\_Invocation\_Logs\_API + +#### 5.9.2.2.1 General + +This service operation is used by an API management function to query API invocation information logs stored on CAPIF core function. + +#### 5.9.2.2.2 Query API invocation information logs using Query\_Invocation\_Logs service operation + +To query service API invocation logs at the CAPIF core function, the API management function shall send an HTTP GET message with the API management function identity information and optionally a set of log query parameters to the CAPIF core function as specified in clause 8.8.2.2.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall: + +1. verify the identity of the API management function and check if the API management function is authorized to query the service API invocation logs; + 2. if the API management function is authorized to query the service API invocation logs, the CAPIF core function shall: + - a. search the API invocation logs for logs matching the log query parameters, if any; and + - b. return the search results in the response message; +- and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API management function with an appropriate error status code as defined in clause 8.8.5. + +## 5.10 CAPIF\_Access\_Control\_Policy\_API + +### 5.10.1 Service Description + +#### 5.10.1.1 Overview + +The CAPIF access control policy APIs allow API exposing function via CAPIF-3/3e reference points to obtain the service API access policy from the CAPIF core function. + +NOTE: Functions from 3rd party API provider domain can also access this API with sufficient permissions. + +## 5.10.2 Service Operations + +### 5.10.2.1 Introduction + +**Table 5.3.2.1-1: Operations of the CAPIF\_Access\_Control\_Policy\_API** + +| Service operation name | Description | Initiated by | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Obtain_Access_Control_Policy | This service operation is used by an API exposing function to obtain the access control policy from the CAPIF core function. | API exposing function | + +### 5.10.2.2 Obtain\_Access\_Control\_Policy + +#### 5.10.2.2.1 General + +This service operation is used by an API exposing function to obtain the access control policy from the CAPIF core function. + +#### 5.10.2.2.2 API exposing function obtaining access control policy from the CAPIF core function using Obtain\_Access\_Control\_Policy service operation + +To obtain the access control policy from the CAPIF core function, the API exposing function shall send an HTTP GET message to the CAPIF core function with the API exposing function Identifier and API identification. The GET message may include API invoker ID for retrieving access control policy of the requested API invoker as specified in clause 8.6.2.2.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall: + +1. verify the identity of the API exposing function and check if the API exposing function is authorized to obtain the access control policy corresponding to the API identification; +2. if the API exposing function is authorized to obtain the access control policy, the CAPIF core function shall respond with the access control policy information corresponding to the API identification and API invoker ID (if present) in the HTTP GET message; and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API exposing function with an appropriate error status code as defined in clause 8.6.5. + +## 5.10.3 Related Events + +The CAPIF\_Access\_Control\_Policy\_API supports the subscription and notification of the status of access control information via the CAPIF\_Events\_API. The related events are specified in clause 8.3.4.3.3. + +# 5.11 CAPIF\_API\_Provider\_Management\_API + +## 5.11.1 Service Description + +### 5.11.1.1 Overview + +The CAPIF API provider management APIs, as defined in 3GPP TS 23.222 [2], allow API management functions via CAPIF-5 and CAPIF-5e reference points to register, deregister and update registration information of API provider domain functions (API Exposing Function, API Publishing Function, API management Function) as a recognized API provider domain of the CAPIF domain. + +## 5.11.2 Service Operations + +### 5.11.2.1 Introduction + +The service operations defined for the CAPIF API Provider Management API are shown in table 5.11.2.1-1. + +**Table 5.11.2.1-1: Operations of the CAPIF\_API\_Provider\_Management\_API** + +| Service operation name | Description | Initiated by | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| Register_API_Provider | This service operation is used by an API management function to register API provider domain functions as a recognized API provider domain of the CAPIF domain. | API Management Function | +| Update_API_Provider | This service operation is used by an API management function to update the API provider domain functions details in the CAPIF domain. | API Management Function | +| Deregister_API_Provider | This service operation is used by an API management function to deregister API provider domain functions as a recognized API provider domain of the CAPIF domain. | API Management Function | + +### 5.11.2.2 Register\_API\_Provider + +#### 5.11.2.2.1 General + +This service operation is used by an API management function to register API provider domain functions as a recognized API provider of CAPIF domain. + +#### 5.11.2.2.2 API provider domain functions registering as a recognized API provider domain function of CAPIF using Register\_API\_Provider service operation + +To register API provider domain as a recognized API provider of the CAPIF, the API management function shall send a HTTP POST message to the CAPIF core function. The body of the HTTP POST message shall include API provider Enrolment Details, consisting of details of all API provider domain functions and security information for CAPIF core function to validate the registration request. + +Upon receiving the above described HTTP POST message, the CAPIF core function validates the security information and determine if the request sent by API management function is authorized or not. If the API management function is authorized, CAPIF core function shall: + +- create the API provider domain profile consisting of API provider domain ID, API provider domain functions profiles as per the request. CAPIF core function shall assign the identities for the API provider domain functions; +- create a new resource as defined in clause 8.9.2.2.3.1; +- return the API provider domain profile, the CAPIF Resource URI in the response message and registration failure information specific to individual API provider domain functions; and +- if errors occur when processing the request, the CAPIF core function shall respond to the API management function with an appropriate error status code as defined in clause 8.9.5. + +### 5.11.2.3 Update\_API\_Provider + +#### 5.11.2.3.1 General + +This service operation is used by an API management function to update API provider domain function details on the CAPIF domain. + +### 5.11.2.3.2 API management function updating API provider domain function details on CAPIF using Update\_API\_Provider service operation + +To update the API provider domain profile and its individual functions details on CAPIF domain, the API management function shall send a HTTP PUT message to its resource representation in the CAPIF core function as specified in clause 8.9.2.3.3.1, requesting to replace all properties in the existing resource, addressed by the URI received in the response to the request that has created the API provider domain profile resource. The property "apiProviderDomainId", shall remain unchanged from the previously provided values. The body of the HTTP PUT message shall include the APIProviderEnrolmentDetails data structure that need to be updated. If the "PatchUpdate" feature defined in clause 8.9.6 is supported for modification of the API provider domain profile, the consumer (e.g. API publishing function) may send an HTTP PATCH request message to the concerned service API resource URI in the CAPIF core function. The body of the HTTP PATCH request message shall include the APIProviderEnrolmentDetailsPatch data structure. + +Upon receiving the described HTTP PUT or PATCH request message: + +1. the CAPIF core function shall process the updates received in the HTTP PUT or PATCH request message and determine if the request sent by API management function is authorized or not; + 2. verify that the "apiProviderDomainId" property is same as in the API provider domain resource on CAPIF Core Function; + 3. if the API management function is authorized and the property "apiProviderDomainId" matches, then the CAPIF core function shall: + - a. replace/modify the representation of the resource identified by the CAPIF Resource URI of the API management function's HTTP PUT or PATCH request with updated information in the request; + - b. update the individual API provider domain function profiles as per the request. CAPIF core function shall create new API provider domain function profiles along with assignment of identities, if the API provider domain functions profiles in the request do not exist in CAPIF; and + - c. return a "200 OK" status code with the updated API provider domain information, or a "204 No Content" status code; +- and +4. if errors occur when processing the request, the CAPIF core function shall respond to the API management function with an appropriate error status code as defined in clause 8.9.5. + +### 5.11.2.4 Deregister\_API\_Provider + +#### 5.11.2.4.1 General + +This service operation is used by an API management function to deregister the API provider domain function as a recognized API provider of the CAPIF domain. + +#### 5.11.2.4.2 API provider domain functions deregistering as a recognized API provider domain function of CAPIF using Deregister\_API\_Provider service operation + +To deregister API provider domain as a recognized API provider of the CAPIF domain, the API management function shall send an HTTP DELETE message to its resource representation in the CAPIF core function as specified in clause 8.9.2.3.3.2. + +Upon receiving the HTTP DELETE message, the CAPIF core function shall: + +1. determine if the request sent by the API management functions is authorized or not; +2. if the API management function's request is authorized, the CAPIF core function shall: + - a. delete the resource representation pointed by the CAPIF Resource Identifier; and + - b. delete the related API provider domain profile; + +and + +3. if errors occur when processing the request, the CAPIF core function shall respond to the API management function with an appropriate error status code as defined in clause 8.9.5. + +## 5.12 CAPIF\_Routing\_Info\_API + +### 5.12.1 Service Description + +#### 5.12.1.1 Overview + +The CAPIF routing info API allows an API exposing function via CAPIF-3/3e reference point to obtain the API routing information from the CAPIF core function. + +NOTE: Functions from 3rd party API provider domain can also access this API routing information with sufficient permissions. + +### 5.12.2 Service Operations + +#### 5.12.2.1 Introduction + +**Table 5.12.2.1-1: Operations of the CAPIF\_Routing\_Info\_API** + +| Service operation name | Description | Initiated by | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| Obtain_Routing_Info | This service operation is used by an API exposing function to obtain the API routing information from the CAPIF core function. | API exposing function | + +#### 5.12.2.2 Obtain\_Routing\_Info + +##### 5.12.2.2.1 General + +This service operation is used by an API exposing function to obtain the API routing information from the CAPIF core function. + +##### 5.12.2.2.2 API exposing function obtaining API routing information from the CAPIF core function using Obtain\_Routing\_Info service operation + +To obtain the API routing information from the CAPIF core function, the API exposing function shall send an HTTP GET request message to the CAPIF core function with the API exposing function Identifier and API identification as specified in clause 8.10.2.2.3.1. + +Upon receiving the above described HTTP GET message, the CAPIF core function shall + +1. verify the identity of the API exposing function and check if the API exposing function is authorized to obtain the API routing information corresponding to the API identification; +2. if the API exposing function is authorized to obtain the API routing information, the CAPIF core function shall respond with the API routing information corresponding to the API identification in the HTTP GET response message; and +3. if errors occur when processing the request, the CAPIF core function shall respond to the API exposing function with an appropriate error status code as defined in clause 8.10.5. + +## 6 Services offered by the API exposing function + +### 6.1 Introduction of Services + +The table 6.1-1 lists the API exposing function APIs below the service name. A service description clause for each API gives a general description of the related API. + +**Table 6.1-1: List of AEF Services** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|------------------|-------------------------|---------------------|---------------------| +| AEF_Security_API | Initiate_Authentication | Request/ Response | API Invoker | +| | Revoke_Authorization | Request/ Response | CAPIF core function | + +Table 6.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 6.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|------------------|--------|--------------------------|-------------------------------|--------------|-------| +| AEF_Security_API | 9.1 | AEF Security API Service | TS29222_AEF_Security_API.yaml | aef-security | A.10 | + +## 6.2 AEF\_Security\_API + +### 6.2.1 Service Description + +#### 6.2.1.1 Overview + +The AEF security API, allows an API invokers via CAPIF-2/2e reference points to request API exposing function to ensure that authentication parameters necessary for authentication of the API invoker are available with the API exposing function. If the necessary authentication parameters are not available, the API exposing function fetches necessary authentication parameters from CAPIF core function to authenticate the API invoker. + +The AEF security API, also allows the CAPIF core function via CAPIF-3/3e reference points to request API exposing function to revoke the authorization of service APIs for an API invoker. + +### 6.2.2 Service Operations + +#### 6.2.2.1 Introduction + +The service operation defined for AEF\_Security\_API is shown in table 6.2.2.1-1. + +**Table 6.2.2.1-1: Operations of the AEF\_Security\_API** + +| Service operation name | Description | Initiated by | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Initiate_Authentication | This service operation is used by an API invoker to request API exposing function to confirm necessary authentication data is available to authenticate the API invoker | API invoker | +| Revoke_Authorization | This service operation is used by the CAPIF core function to request the API exposing function to revoke the authorization of service APIs for an API invoker. | CAPIF core function | + +## 6.2.2.2 Initiate\_Authentication + +### 6.2.2.2.1 General + +This service operation is used by an API invoker to initiate authentication with the API exposing function. On receiving the Initiate\_Authentication the API exposing function fetches the authentication information of the API invoker from the CAPIF core function, if required. + +### 6.2.2.2.2 API invoker initiating authentication using Initiate\_Authentication service operation + +To initiate authentication with the API exposing function, the API invoker shall send an HTTP POST message to the API exposing function with the API invoker ID to the URI "{apiRoot}/aef-security/v1/check-authentication". + +Upon receiving the above described HTTP POST message, the API exposing function shall check if the credentials of the API invoker for authentication are available with the API exposing function. If the credentials of the API invoker for authentication are not available, the API exposing function shall use the service defined in clause 5.6.2.4.2 to fetch the credentials from the CAPIF core function. + +The API exposing function shall store the received credentials and respond to the API invoker with 200 OK status code. + +## 6.2.2.3 Revoke\_Authorization + +### 6.2.2.3.1 General + +This service operation is used by CAPIF core function to revoke authorization of service APIs (e.g. due to policy change in the CAPIF core function). On receiving the Revoke\_Authorization the API exposing function revokes authorization of the API invoker for the service APIs indicated in the request. + +### 6.2.2.3.2 CAPIF core function initiating revocation using Revoke\_Authorization service operation + +To revoke authorization, the CAPIF core function shall send an HTTP POST message to the API exposing function with the API invoker ID and a list of service API IDs on the URI "{apiRoot}/aef-security/v1/revoke-authorization". + +Upon receiving the HTTP POST message, the API exposing function shall revoke the authorization of the API invoker for the indicated service APIs (e.g. it may update the list of unauthorized APIs locally), and then respond to the CAPIF core function with 200 OK status code. + +The CAPIF core function shall also notify the API invoker of the authorization invalidation using the Notification Destination URI received in the Obtain\_Security\_Method message. + +--- + +# 7 CAPIF Design Aspects Common for All APIs + +## 7.1 General + +CAPIF APIs are RESTful APIs that allow secure access to the capabilities provided by CAPIF. + +This document specifies the procedures triggered at different functional entities as a result of API invocation requests and event notifications. The stage-2 level requirements and signalling flows are defined in 3GPP TS 23.222 [2]. + +Several design aspects, as mentioned in the following clauses, are specified in 3GPP TS 29.122 [14] and referenced by this specification. + +## 7.2 Data Types + +### 7.2.1 General + +This clause defines structured data types, simple data types and enumerations that are applicable to several APIs defined in the present specification and can be referenced from data structures defined in the subsequent clauses. + +In addition, data types that are defined in OpenAPI Specification [3] can also be referenced from data structures defined in the subsequent clauses. + +NOTE: As a convention, data types in the present specification are written with an upper-case letter in the beginning. Parameters are written with a lower-case letter in the beginning. Enumerations are written using UPPER\_WITH\_UNDERSCORE case convention. As an exception, data types that are also defined in OpenAPI Specification [3] can use a lower-case case letter in the beginning for consistency. + +Table 7.2.1-1 specifies data types re-used by the CAPIF from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the CAPIF. + +**Table 7.2.1-1: Re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|---------------------|------------------------------------------------------------------------------------------------------------------| +| Uri | 3GPP TS 29.122 [14] | | +| TestNotification | 3GPP TS 29.122 [14] | Following clarifications apply:
- The SCEF is the CAPIF core function; and
- The SCS/AS is the Subscriber. | +| WebsockNotifConfig | 3GPP TS 29.122 [14] | Following clarifications apply:
- The SCEF is the CAPIF core function; and
- The SCS/AS is the Subscriber. | + +### 7.2.2 Referenced structured data types + +Table 7.2.2-1 lists structured data types defined in this specification referenced by multiple services: + +**Table 7.2.2-1: Referenced Structured Data Types** + +| Data type | Reference | Description | +|-----------------------|------------------|----------------------------------| +| Log | Clause 8.7.4.2.3 | Individual log entries | +| InterfaceDescription | Clause 8.2.4.2.3 | Description of the API interface | +| ServiceAPIDescription | Clause 8.2.4.2.2 | Description of the service API | + +### 7.2.3 Referenced Simple data types and enumerations + +Following simple data types defined in Table 7.2.3.1-1 are applicable to several APIs in this document: + +**Table 7.2.3.1-1: Simple data types applicable to several APIs** + +| Type name | Reference | Description | +|-----------------|------------------|------------------------------------------------------------------------------------| +| CAPIFResourceId | n/a | string chosen by the CAPIF core function to serve as identifier in a resource URI. | +| DataFormat | Clause 8.2.4.3.4 | Data format used by the API | +| Protocol | Clause 8.2.4.3.3 | Protocol used by the API | + +## 7.3 Usage of HTTP + +For CAPIF APIs, support of HTTP/1.1 (IETF RFC 9112 [4], IETF RFC 9110 [5], and IETF RFC 9111 [8]) over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [10]) over TLS is recommended. TLS shall be used as specified in 3GPP TS 33.122 [16]. + +A functional entity desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 9113 [10]. + +## 7.4 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [12]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [12], unless specified otherwise in the API definition. + +The JSON objects defined in clause 5.2.3 of 3GPP TS 29.122 [14] for the HTTP PATCH request shall be supported. + +## 7.5 URI structure + +### 7.5.1 Resource URI structure + +All API URIs of CAPIF APIs shall be: + +**{apiRoot}** + +"apiRoot" is configured by means outside the scope of the present document. It includes the scheme ("https"), host and optional port, and an optional prefix string. "apiName" and "apiVersion" shall be set dependent on the API, as defined in the corresponding clauses below. + +All resource URIs in the clauses below are defined relative to the above root API URI. + +NOTE 1: The "apiVersion" will only be increased if the new API version contains backward incompatible changes. Otherwise, the supported feature mechanism defined in clause 7.8 can be used to negotiate extensions. + +NOTE 2: A different root structure can be used when the resource URI is preconfigured in the API invoking entity. + +The root structure may be followed by "apiSpecificSuffixes" that are dependent on the API and are defined separately for each API as resource URI where they apply: + +**{apiRoot}** + +The naming conventions defined in subclause 5.2.4 of 3GPP TS 29.122 [14] shall apply. + +### 7.5.2 Custom operations URI structure + +The custom operation definition is in Annex C of 3GPP TS 29.501 [18]. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 7.5.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2 of 3GPP TS 29.501 [18]. + +## 7.6 Notifications + +The functional entities + +- shall support the delivery of notifications using a separate HTTP connection towards an address; +- may support testing delivery of notifications; and +- may support the delivery of notification using WebSocket protocol (see IETF RFC 6455 [13]), + +as described in 3GPP TS 29.122 [14], with the following clarifications: + +- the SCEF is the CAPIF core function; and +- the SCS/AS is the Subscriber. + +## 7.7 Error handling + +HTTP error handling described in clause 5.2.6 of 3GPP TS 29.122 [14] is applicable to all APIs in the present specification unless specified otherwise, with the following clarifications: + +- the SCEF is the CAPIF core function; and +- the SCS/AS is the functional entity invoking an API. + +## 7.8 Feature negotiation + +The functional entity invoking an API (i.e. the API invoker, the API exposing function, the API publishing function or the API management function) and the CAPIF core function use feature negotiation procedures defined in 3GPP TS 29.122 [14] to negotiate the supported features, with the following clarifications: + +- description of the SCEF applies to the CAPIF core function; +- description of the SCS/AS applies to the functional entity invoking an API; +- the CAPIF Core Function should not register any feature in the NRF; and +- the AEF should not register any feature for AEF\_Security\_API in the NRF. + +## 7.9 HTTP headers + +The HTTP headers and the HTTP custom headers described in 3GPP TS 29.122 [14] are applicable to all APIs in this document. + +## 7.10 Conventions for Open API specification files + +The conventions for Open API specification files as specified in clause 5.2.9 of 3GPP TS 29.122 [14] shall be applicable for all APIs in this document. + +## 7.11 CAPIF vendor-specific extensions + +Information elements exchanged on the CAPIF APIs shall be extensible with vendor-specific data as specified in clause 5.2.13.2 of 3GPP TS 29.122 [14]. + +## 8 CAPIF API Definition + +### 8.1 CAPIF\_Discover\_Service\_API + +#### 8.1.1 API URI + +The CAPIF\_Discover\_Service\_API service shall use the CAPIF\_Discover\_Service\_API. + +The request URIs used in HTTP requests from the API invoker towards the CAPIF core function shall have the Resource URI structure defined in clause 7.5 with the following clarifications: + +- The shall be "service-apis". +- The shall be "v1". +- The shall be set as described in clause 8.1.2.\ + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +#### 8.1.2 Resources + +##### 8.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.1.2.1-1 depicts the resource URIs structure for the CAPIF\_Discover\_Service\_API. + +![Diagram showing the resource URI structure for the CAPIF_Discover_Service_API. It consists of two boxes connected by a line. The top box contains the base URI path: {apiRoot}/service-apis/. The bottom box contains the specific resource path: /allServiceAPIs. A line connects the bottom box to the top box, indicating that the resource path is relative to the base URI path.](fc07df3b799d63e7e6c7760ca077ee99_img.jpg) + +``` + +graph TD + A["{apiRoot}/service-apis/"] --- B["/allServiceAPIs"] + +``` + +Diagram showing the resource URI structure for the CAPIF\_Discover\_Service\_API. It consists of two boxes connected by a line. The top box contains the base URI path: {apiRoot}/service-apis/. The bottom box contains the specific resource path: /allServiceAPIs. A line connects the bottom box to the top box, indicating that the resource path is relative to the base URI path. + +**Figure 8.1.2.1-1: Resource URI structure of the CAPIF\_Discover\_Service\_API** + +Table 8.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------| +| All published service APIs (Store) | /allServiceAPIs
(NOTE) | GET | Discover published service APIs and retrieve a collection of APIs according to certain filter criteria. | +| NOTE: The path segment "allServiceAPIs" does not follow the related naming convention defined in subclause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. | | | | + +## 8.1.2.2 Resource: All published service APIs + +### 8.1.2.2.1 Description + +The All published service APIs resource represents a collection of published service APIs on a CAPIF core function. The resource is modelled as a Store resource archetype (see Annex C.3 of 3GPP TS 29.501 [18]) + +### 8.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/service-apis//allServiceAPIs + +This resource shall support the resource URI variables defined in table 8.1.2.2.2-1. + +**Table 8.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.1.2.2.3 Resource Standard Methods + +#### 8.1.2.2.3.1 GET + +This operation enables to retrieve a list of APIs currently registered in the CAPIF core function, satisfying a number of filter criteria. + +**Table 8.1.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| api-invoker-id | string | M | 1 | It represents the identifier (assigned by the CCF) of the API invoker that is sending the request. It may also represent the identifier of the CCF that is sending the request if the request is sent over the CAPIF-6/6e reference point. (NOTE 1) | | +| api-name | string | O | 0..1 | Contains the API name as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| api-version | string | O | 0..1 | Contains the API major version conveyed in the URI (e.g. v1). | | +| comm-type | CommunicationType | O | 0..1 | Communication type used by the API (e.g. REQUEST_RESPONSE). | | +| protocol | Protocol | O | 0..1 | Protocol used by the API. | | +| aef-id | string | O | 0..1 | AEF identifier. | | +| data-format | DataFormat | O | 0..1 | Data format used by the API (e.g. serialization protocol JSON). | | +| api-cat | string | O | 0..1 | The service API category to which the service API belongs. | | +| preferred-aef-loc | AefLocation | O | 0..1 | The preferred AEF location. If this parameter is present, the CCF shall try to discover a matched AEF location the service API supports. This parameter is ignored by the CCF if there is no matching record found. | | +| req-api-prov-name | string | O | 0..1 | Represents the required API provider name. | RNAA | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | | +| api-supported-features | SupportedFeatures | C | 0..1 | Features supported by the discovered service API indicated by api-name parameter. This may only be present if the api-name query parameter is present. | ApiSupportedFeatureQuery | +| ue-ip-addr | IpAddrInfo | O | 0..1 | Represents the UE IP address information. | RNAA | +| service-kpis | ServiceKpis | O | 0..1 | Contains information about service characteristics provided by the targeted service API(s). | EdgeApp_2 | +| NOTE 1: This parameter is not part of API filter criteria so that it is not used in matching APIs published in the CCF. | | | | | | +| NOTE 2: In addition to the standardized query parameters defined in table 8.1.2.2.3.1-1 above, the service consumer may also provide vendor-specific query parameters as specified in clause 5.2.13.3 of 3GPP TS 29.122 [14]. The CCF shall use any received vendor-specific query parameters in the filtering process of the results to be returned in the response in a similar way and in addition to the standardized query parameters defined in this table. This capability may be signalled by the feature VendSpecQueryParams. | | | | | | + +This method shall support the request data structures specified in table 8.1.2.2.3.1-2 and the response data structures and response codes specified in table 8.1.2.2.3.1-3. + +**Table 8.1.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.1.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DiscoveredAPIs | M | 1 | 200 OK | The response body contains the result of the search over the list of registered APIs. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| ProblemDetails | O | 0..1 | 414 URI Too Long | Indicates that the server refuses to process the request because the request-target is too long. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.1.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.1.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.1.2.2.4 Resource Custom Operations + +None. + +### 8.1.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 8.1.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 8.1.4 Data Model + +#### 8.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.1.4.1-1 specifies the data types defined specifically for the CAPIF\_Discover\_Service\_API. + +**Table 8.1.4.1-1: CAPIF\_Discover\_Service\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DiscoveredAPIs | Clause 8.1.4.2.2 | Represents a list of APIs currently registered in the CAPIF core function and satisfying a number of filter criteria provided by the API consumer. | | +| IpAddrInfo | Clause 8.1.4.2.4 | Represents the UE IP address information. | RNAA | + +Table 8.1.4.1-2 specifies data types re-used by the CAPIF\_Discover\_Service\_API service. + +**Table 8.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-------------------------------------------------------------------------------------|---------------| +| AefLocation | Clause 8.2.4.2.10 | Used to indicate the AEF location. | | +| CommunicationType | Clause 8.2.4.3.5 | Used to indicate the communication type used by the API. | | +| Ipv4Addr | 3GPP TS 29.122 [14] | Used to indicate an IPv4 address. | RNAA | +| Ipv6Addr | 3GPP TS 29.122 [14] | Used to indicate an IPv6 address. | RNAA | +| ProblemDetails | 3GPP TS 29.122 [14] | Used to represent additional information and details on an error response. | | +| ServiceKpis | Clause 8.2.4.2.13 | Represents information about the service characteristics provided by a service API. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.1.6-1. | | + +## 8.1.4.2 Structured data types + +### 8.1.4.2.1 Introduction + +This clause defines the structured data types to be used in resource representations of the CAPIF\_Discover\_Service\_API. + +### 8.1.4.2.2 Type: DiscoveredAPIs + +**Table 8.1.4.2.2-1: Definition of type DiscoveredAPIs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------------|---|-------------|--------------------------------------------------------------------|---------------| +| serviceAPIDescriptions | array(ServiceAPIDescription) | O | 1..N | Description of the service API as published by the service. (NOTE) | | + +NOTE: For the CAPIF\_Discover\_Service\_API, the supportedFeatures attribute of the ServiceAPIDescription data type shall be provided in the HTTP GET response of a successful query. In addition, the supportedFeatures attribute may include one or more supported feature(s) as defined in clause 8.1.6. + +8.1.4.2.3 Void + +8.1.4.2.4 Type: IpAddrInfo + +**Table 8.1.4.2.4-1: Definition of type IpAddrInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------|---------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | Represents the IPv4 address of the UE.
(NOTE) | | +| ipv6Addr | Ipv6Addr | C | 0..1 | Represents the IPv6 address of the UE.
(NOTE) | | + +NOTE: These attributes are mutually exclusive. Either one of them shall be present. + +### 8.1.4.3 Simple data types and enumerations + +None. + +## 8.1.5 Error Handling + +### 8.1.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Discover\_Service\_API. + +### 8.2.5.3 Application Errors + +The application errors defined for the CAPIF\_Publish\_Service\_API are listed in table 8.2.5.3-1. + +**Table 8.2.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.1.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 8.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ApiSupportedFeatureQuery | Indicates the support of the query filter indicating the supported feature(s) of a service API. | +| 2 | VendSpecQueryParams | Indicates the support of vendor specific API discovery query filter parameters. | +| 3 | RNAA | Indicates the support of the RNAA functionality.

This feature enables the following functionality:
  • - provisioning the API provider name and the related filtering criteria enhancement.
  • - provisioning the UE IP address information and the related filtering criteria enhancement.
| + +## 8.2 CAPIF\_Publish\_Service\_API + +### 8.2.1 API URI + +The CAPIF\_Publish\_Service\_API service shall use the CAPIF\_Publish\_Service\_API. + +The request URIs used in HTTP requests from the API publishing function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "published-apis". +- The shall be "v1". +- The shall be set as described in clause 8.2.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.2.2 Resources + +#### 8.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.2.2.1-1 depicts the resource URIs structure for the CAPIF\_Publish\_Service\_API. + +![Figure 8.2.2.1-1: Resource URI structure of the CAPIF_Publish_Service_API. The diagram shows a hierarchical tree structure starting with {apiRoot}/published-apis/. A branch from this root leads to /{apfId}, which then leads to /service-apis (shown in a box). From /service-apis, a branch leads to /{serviceApiId} (also shown in a box).](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +graph TD + Root["{apiRoot}/published-apis/"] --> apfId["/{apfId}"] + apfId --> serviceApis["/service-apis"] + serviceApis --> serviceApiId["/{serviceApiId}"] + +``` + +Figure 8.2.2.1-1: Resource URI structure of the CAPIF\_Publish\_Service\_API. The diagram shows a hierarchical tree structure starting with {apiRoot}/published-apis/. A branch from this root leads to /{apfId}, which then leads to /service-apis (shown in a box). From /service-apis, a branch leads to /{serviceApiId} (also shown in a box). + +**Figure 8.2.2.1-1: Resource URI structure of the CAPIF\_Publish\_Service\_API** + +Table 8.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------|--------------------------------------|---------------------------------|-------------------------------------| +| APF published APIs | /{apfId}/service-apis | POST | Publish a new API | +| | | GET | Retrieve all published service APIs | +| Individual APF published API | /{apfId}/service-apis/{serviceApiId} | GET | Retrieve a published service API | +| | | PUT | Update a published service API | +| | | PATCH | Modify a published service API. | +| | | DELETE | Unpublish a published service API. | + +## 8.2.2.2 Resource: APF published APIs + +### 8.2.2.2.1 Description + +The APF published APIs resource represents all published service APIs of a API publishing function. + +### 8.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/published-apis//{apfId}/service-apis + +This resource shall support the resource URI variables defined in table 8.2.2.2-1. + +**Table 8.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| apfId | string | Identifies the API publishing function; for CAPIF interconnection case, this string also identifies the CCF which is publishing the service API. | + +### 8.2.2.2.3 Resource Standard Methods + +#### 8.2.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.2.2.2.3.1-1. + +**Table 8.2.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.2.3.1-2 and the response data structures and response codes specified in table 8.2.2.2.3.1-3. + +**Table 8.2.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------| +| ServiceAPIDescription | M | 1 | Definition of the service API being published | + +**Table 8.2.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| ServiceAPIDescription | M | 1 | 201
Created | Service API published successfully.

The URI of the created resource shall be returned in the "Location" HTTP header | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.2.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/published-apis///service-apis/{serviceApId} | + +#### 8.2.2.2.3.2 GET + +This method shall support the URI query parameters specified in table 8.2.2.2.3.2-1. + +**Table 8.2.2.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.2.3.2-2 and the response data structures and response codes specified in table 8.2.2.2.3.2-3. + +**Table 8.2.2.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.2.2.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(ServiceAPIDescription) | O | 0..N | 200 OK | Definition of all service API(s) published by the API publishing function. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.2.2.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.2.2.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.2.2.2.4 Resource Custom Operations + +None. + +#### 8.2.2.3 Resource: Individual APF published API + +##### 8.2.2.3.1 Description + +The Individual APF published API resource represents an individual published service API. + +##### 8.2.2.3.2 Resource Definition + +Resource URI: {apiRoot}/published-apis/{apiVersion}/{apfId}/service-apis/{serviceApiId} + +This resource shall support the resource URI variables defined in table 8.2.2.3.2-1. + +**Table 8.2.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|--------------|-----------|------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| apfId | string | Identifies the API publishing function | +| serviceApiId | string | Identifies an individual published service API | + +### 8.2.2.3.3 Resource Standard Methods + +#### 8.2.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 8.2.2.3.3.1-1. + +**Table 8.2.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.1-2 and the response data structures and response codes specified in table 8.2.2.3.3.1-3. + +**Table 8.2.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.2.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceAPIDescription | M | 1 | 200 OK | Definition of individual service API published by the API publishing function. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.2.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.2.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.2.2.3.3.2 PUT + +This method shall support the URI query parameters specified in table 8.2.2.3.3.2-1. + +**Table 8.2.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.2-2 and the response data structures and response codes specified in table 8.2.2.3.3.2-3. + +**Table 8.2.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------| +| ServiceAPIDescription | M | 1 | Updated definition of the service API. | + +**Table 8.2.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceAPIDescription | M | 1 | 200 OK | Definition of the service API updated successfully and the updated service API definition is returned. | +| n/a | | | 204 No Content | Definition of the service API updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.2.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.2.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.2.2.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 8.2.2.3.3.3-1. + +**Table 8.2.2.3.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.3-2 and the response data structures and response codes specified in table 8.2.2.3.3.3-3. + +**Table 8.2.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.2.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual published service API matching the serviceApiId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.2.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.2.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.2.2.3.3.4 PATCH + +This method shall support the URI query parameters specified in table 8.2.2.3.3.4-1. + +**Table 8.2.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.2.2.3.3.4-2 and the response data structures and response codes specified in table 8.2.2.3.3.4-3. + +**Table 8.2.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------| +| ServiceAPIDescriptionPatch | M | 1 | Contains the modifications to be applied to the concerned Individual APF published API resource. | + +**Table 8.2.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceAPIDescription | M | 1 | 200 OK | The definition of the service API is updated successfully and a representation of the modified service API definition is returned. | +| n/a | | | 204 No Content | The definition of the service API is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.2.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.2.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.2.2.3.4 Resource Custom Operations + +None. + +## 8.2.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.2.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8.2.4 Data Model + +### 8.2.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.2.4.1-1 specifies the data types defined specifically for the CAPIF\_Publish\_Service\_API service. + +specifies the data types defined specifically for the CAPIF\_Publish\_Service\_API service. + +**Table 8.2.4.1-1: CAPIF\_Publish\_Service\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| ApiStatus | Clause 8.2.4.2.12 | Represents the API status. | ApiStatusMonitoring | +| AefLocation | Clause 8.2.4.2.10 | Represents the location information (e.g. civic address, GPS coordinates, data center ID) where the AEF providing the service API is located. | | +| AefProfile | Clause 8.2.4.2.4 | Represents the AEF profile data. | | +| CommunicationType | Clause 8.2.4.3.5 | Indicates a communication type of the resource or a custom operation. | | +| CustomOperation | Clause 8.2.4.2.7 | Represents the description of a custom operation. | | +| DateFormat | Clause 8.2.4.3.4 | Indicates a data format, e.g., JSON. | | +| InterfaceDescription | Clause 8.2.4.2.3 | Represents the description of the API interface. | | +| IpAddrRange | Clause 8.2.4.2.14 | Represents the list of IP address ranges information. | | +| Operation | Clause 8.2.4.3.7 | Indicates an HTTP method (e.g. PUT). | | +| Protocol | Clause 8.2.4.3.3 | Indicates a protocol and protocol version used by the API. | | +| PublishedApiPath | Clause 8.2.4.2.9 | Represents the published API path within the same CAPIF provider domain. | | +| Resource | Clause 8.2.4.2.6 | Represents the API resource data. | | +| SecurityMethod | Clause 8.2.4.3.6 | Indicates the security method (e.g. PKI). | | +| ServiceAPIDescription | Clause 8.2.4.2.2 | Represents the description of a service API as published by the APF. | | +| ServiceAPIDescriptionPatch | Clause 8.2.4.2.11 | Represents the parameters to request the modification of an APF published API resource. | PatchUpdate | +| ServiceKpis | Clause 8.2.4.2.13 | Represents information about the service characteristics provided by a service API. | | +| ShareableInformation | Clause 8.2.4.2.8 | Indicates whether the service API and/or the service API category can be shared to the list of CAPIF provider domains. | | +| Version | Clause 8.2.4.2.5 | Represents the API version information | | + +Table 8.2.4.1-2 specifies data types re-used by the CAPIF\_Publish\_Service\_API service: + +**Table 8.2.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|----------------------------------------------------------------------------------------|-------------------------------| +| CivicAddress | 3GPP TS 29.572 [30] | Used to indicate a civic address. | | +| DateTime | 3GPP TS 29.122 [14] | Used to indicate an expiration timer. | | +| DurationSec | 3GPP TS 29.122 [14] | Indicates the duration in seconds. | | +| Fqdn | 3GPP TS 29.571 [19] | Used to indicate a FQDN. | | +| GeographicArea | 3GPP TS 29.572 [30] | Used to indicate a geographic area. | | +| Ipv4Addr | 3GPP TS 29.122 [14] | Used to indicate an IPv4 address. | | +| Ipv6Addr | 3GPP TS 29.122 [14] | Used to indicate an IPv6 address. | | +| Ipv4AddressRange | 3GPP TS 29.571 [19] | Used to indicate the IPv4 address range. | RNAA | +| Ipv6AddressRange | 3GPP TS 29.571 [19] | Used to indicate the IPv6 address range. | RNAA | +| Port | 3GPP TS 29.122 [14] | Used to indicate a port. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.2.6-1. | ApiSupportedFeaturePublishing | +| Uinteger | 3GPP TS 29.571 [19] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. Minimum = 0. | | + +## 8.2.4.2 Structured data types + +### 8.2.4.2.1 Introduction + +### 8.2.4.2.2 Type: ServiceAPIDescription + +**Table 8.2.4.2.2-1: Definition of type ServiceAPIDescription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| apiName | string | M | 1 | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| apiId | string | O | 0..1 | API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API). | | +| apiStatus | ApiStatus | O | 0..1 | Indicates the API status.
If this attribute is omitted, the Service API is active at all AEF(s) present in the "aefProfiles" attribute. | ApiStatusMonitoring | +| aefProfiles | array(AefProfile) | C | 1..N | AEF profile information, which includes the exposed API details (e.g. protocol). For CAPIF-4/4e interface, API publishing function shall provide this attribute to the CAPIF core function in service API publishing. For CAPIF-1/1e interface, the CAPIF core function shall provide this attribute to the API Invoker during service API discovery. (NOTE 2) | | +| description | string | O | 0..1 | Text description of the API | | +| supportedFeatures | Supported Features | O | 0..1 | The supported optional features of the CAPIF API. (NOTE 1) | | +| shareableInfo | Shareable Information | O | 0..1 | Represents whether the service API and/or the service API category can be published to other CCFs. | | +| serviceAPICategory | string | C | 0..1 | The service API category to which the service API belongs to. This attribute is only applicable for CAPIF-6/6e interface. (NOTE 2) | | +| ccfId | string | C | 0..1 | CAPIF core function identifier which can be contacted further for discovering the details of service API information. This attribute is only applicable for CAPIF-6/6e interface and shall be provided with serviceAPICategory. (NOTE 2) | | +| apiSuppFeats | Supported Features | O | 0..1 | Provided by the consumer to indicate the features supported by the service API. | ApiSupportedFeaturePublishing | +| pubApiPath | Published ApiPath | C | 0..1 | It contains the published API path within the same CAPIF provider domain. it shall be provided by the CCF when publishing the service API to other CCF via the CAPIF-6 reference point. | | + +NOTE 1: For CAPIF\_Publish\_Service\_API, the supported features attribute shall be provided in the HTTP POST request and in the response of successful resource creation. In addition, the supportedFeatures attribute may include one or more the supported features as defined in clause 8.2.6. + +NOTE 2: For CAPIF-6/6e interface, at least one of aefProfiles or serviceAPICategory and the corresponding ccfId shall be provided. + +### 8.2.4.2.3 Type: InterfaceDescription + +**Table 8.2.4.2.3-1: Definition of type InterfaceDescription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | String identifying an IPv4 address (NOTE 1, NOTE 2) | | +| ipv6Addr | Ipv6Addr | C | 0..1 | String identifying an IPv6 address (NOTE 1, NOTE 2) | | +| fqdn | Fqdn | C | 0..1 | String containing a Fully Qualified Domain Name. (NOTE 1, NOTE 2) | ExtendedIntfDesc | +| port | Port | O | 0..1 | Port (NOTE 2) | | +| apiPrefix | string | O | 0..1 | A string representing an optional deployment-specific string (API prefix) in the form of a sequence of path segments that starts with a "/" character. (NOTE 2) | ExtendedIntfDesc | +| securityMethods | array(SecurityMethod) | M | 1..N | Security methods supported by the interface. It takes precedence over the security methods provided in AefProfile, for this specific interface | | + +NOTE 1: Exactly one of the attributes "ipv4Addr", "ipv6Addr" and "fqdn" shall be included. +NOTE 2: When the contents of this data type are used to construct the apiRoot of an API, they are used as described in clause 4.4.1 of 3GPP TS 29.501 [18]. + +### 8.2.4.2.4 Type: AefProfile + +**Table 8.2.4.2.4-1: Definition of type AefProfile** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| aefId | string | M | 1 | AEF identifier | | +| versions | array(Vers ion) | M | 1..N | API version | | +| protocol | Protocol | O | 0..1 | Protocol used by the API.
(NOTE 3) | | +| dataFormat | DataForm at | O | 0..1 | Data format used by the API
(NOTE 3) | | +| securityMethods | array(SecurityMethod) | O | 1..N | Security methods supported by the AEF for all interfaces. Certain interfaces may have different security methods supported in the attribute interfaceDescriptions. | | +| domainName | string | O | 0..1 | Domain to which API belongs to (NOTE 1) | | +| interfaceDescriptions | array(Inter faceDescr iption) | O | 1..N | Interface details (NOTE 1) | | +| aefLocation | AefLocatio n | O | 0..1 | The location information (e.g. civic address, GPS coordinates, data center ID) where the AEF providing the service API is located. | | +| serviceKpis | ServiceKpi s | O | 0..1 | Contains information about the service characteristics provided by the service API. | EdgeApp_2 | +| ueIpRange | IpAddrRan ge | O | 0..1 | The list of public IP ranges of UEs. | RNAA | + +NOTE 1: Only one of the attributes "domainName" or "interfaceDescriptions" shall be included. +NOTE 2: Notification or callback type of resource is not included. +NOTE 3: The protocol and/or data format to be used for AEFs defined outside 3GPP (e.g. by other SDOs) may alternatively be indicated via vendor-specific extensions to the AefProfile data structure using the mechanism defined in clause 7.11. + +## 8.2.4.2.5 Type: Version + +Table 8.2.4.2.5-1: Definition of type Version + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiVersion | string | M | 1 | API major version in URI (e.g. v1) | | +| expiry | DateTime | O | 0..1 | Expiry date and time of the AEF service. This represents the planned retirement date as specified in clause 4.3.1.5 of 3GPP TS 29.501 [18]. | | +| resources | array(Resource) | O | 1..N | Resources supported by the API. It may include the custom operations with resource association. | | +| custOperations | array(CustomOperation) | O | 1..N | Custom operations without resource association. | | + +## 8.2.4.2.6 Type: Resource + +Table 8.2.4.2.6-1: Definition of type Resource + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| resourceName | string | M | 1 | Resource name. | | +| commType | CommunicationType | M | 1 | Communication type used by the API resource. (NOTE 1) | | +| uri | string | M | 1 | Relative URI of the API resource, it is set as {apiSpecificSuffixes} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| custOpName | string | O | 0..1 | it is set as {custOpName} part of the URI structure for the case where there is only a single custom operation associated with this resource as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. (NOTE 2) | | +| custOperations | array(CustomOperation) | O | 1..N | List of custom operations associated to this resource. (NOTE 2) | MultipleCustomOperations | +| operations | array(Operation) | C | 1..N | Supported HTTP methods for the API resource. Only applicable when the protocol in AefProfile indicates HTTP. | | +| description | string | O | 0..1 | Text description of the API resource. | | + +NOTE 1: The communication type refers to the semantics of the resource or custom operation and is independent of the HTTP methods that are supported (e.g. if a resource is used for subscriptions then its CommunicationType shall be SUBSCRIBE\_NOTIFY even if it supports also the GET method for retrieving the subscriptions). + +NOTE 2: The attributes "custOpName" and "custOperations" are mutually exclusive. + +## 8.2.4.2.7 Type: CustomOperation + +Table 8.2.4.2.7-1: Definition of type CustomOperation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| commType | CommunicationType | M | 1 | Communication type used by the custom operation. | | +| custOpName | string | M | 1 | it is set as {custOpName} part of the URI structure for a custom operation without resource association as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| operations | array(Operation) | C | 1..N | Supported HTTP methods for the custom operation. Only applicable when the protocol in AefProfile indicates HTTP. | | +| description | string | O | 0..1 | Text description of the custom operation. | | + +## 8.2.4.2.8 Type: ShareableInformation + +Table 8.2.4.2.8-1: Definition of type ShareableInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| isShareable | boolean | M | 1 | Set to "true" indicates that the service API and/or the service API category can be shared to the list of CAPIF provider domain information. Otherwise set to "false". Default value is "false" if omitted. | | +| capifProvDoms | array(string) | O | 1..N | List of CAPIF provider domains to which the service API information to be shared.
(NOTE) | | + +NOTE: Only one CAPIF provider domain information shall be provided via the CAPIF-6e interface. + +## 8.2.4.2.9 Type: PublishedApiPath + +Table 8.2.4.2.9-1: Definition of type PublishedApiPath + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------|---------------| +| ccfIds | array(string) | O | 1..N | A list of CCF identifiers where the service API is already published. | | + +## 8.2.4.2.10 Type: AefLocation + +Table 8.2.4.2.10-1: Definition of type AefLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| civicAddr | CivicAddress | O | 0..1 | Identifies the civic address where the AEF providing the service API is located.
(NOTE) | | +| geoArea | GeographicArea | O | 0..1 | Identifies the geographic area where the AEF providing the service API is located.
(NOTE) | | +| dcId | string | O | 0..1 | Identifies the data center where the AEF providing the service API is located.
(NOTE) | | + +NOTE: At least one of the attributes shall be included. + +## 8.2.4.2.11 Type: ServiceAPIDescriptionPatch + +Table 8.2.4.2.11-1: Definition of type ServiceAPIDescriptionPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| apiStatus | ApiStatus | O | 0..1 | Indicates the API status. | ApiStatusMonitoring | +| aefProfiles | array(AefProfile) | O | 1..N | AEF profile information, which includes the exposed API details (e.g. protocol). | | +| description | string | O | 0..1 | Text description of the API | | +| shareableInfo | Shareable Information | O | 0..1 | Represents whether the service API and/or the service API category can be published to other CCFs. | | +| serviceAPICategory | string | O | 0..1 | The service API category to which the service API belongs. This attribute is only applicable for CAPIF-6/6e interface. (NOTE) | | +| ccfld | string | C | 0..1 | CAPIF core function identifier which can be contacted further for discovering the details of service API information. This attribute is only applicable for CAPIF-6/6e interface and shall be provided if the "serviceAPICategory" attribute is provided. (NOTE) | | +| apiSuppFeats | Supported Features | O | 0..1 | Indicates the features supported by the service API. | ApiSupportedFeaturePublishing | +| pubApiPath | Published ApiPath | O | 0..1 | It contains the published API path within the same CAPIF provider domain. It is applicable only for the CAPIF-6 reference point. | | +| NOTE: For CAPIF-6/6e interface, either the "aefProfiles" attribute or the "serviceAPICategory" attribute and the corresponding "ccfld" attribute may be provided. | | | | | | + +## 8.2.4.2.12 Type: ApiStatus + +Table 8.2.4.2.12-1: Definition of type ApiStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| aefIds | array(string) | M | 0..N | Indicates the list of AEF ID(s) where the API is active. If an empty array is provided, it indicates that the API is inactive in all AEF(s). | | + +## 8.2.4.2.13 Type: ServiceKpi + +**Table 8.2.4.2.13-1: Definition of type ServiceKpi** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| maxReqRate | UInteger | O | 0..1 | Contains the maximum request rate (i.e., number of requests per second) from the API Invoker that is supported by any service producer of the service API. | | +| maxRestime | DurationSec | O | 0..1 | Contains the maximum response time (expressed in seconds) supported for the API Invoker's service requests. | | +| availability | UInteger | O | 0..1 | Contains the advertised percentage of time any service producer of the service API is available for the API Invoker's use.

Minimum: 0
Maximum: 100 | | +| avalComp | string | O | 0..1 | Contains the maximum compute resource available for the API Invoker.

It is encoded as a string representing a compute resource in FLOPS that shall be formatted as follows:
Pattern: '^d+(\.\d+)? (kFLOPS MFLOPS GFLOPS TFLOPS PFLOPS EFLOPS ZFLOPS)\$'

Examples:
"125 PFLOPS", "0.125 EFLOPS",
"125000 TFLOPS" | | +| avalGraComp | string | O | 0..1 | Contains the maximum graphical compute resource available for the API Invoker.

It is encoded as a string representing a graphical compute resource in FLOPS that shall be formatted as follows:
Pattern: '^d+(\.\d+)? (kFLOPS MFLOPS GFLOPS TFLOPS PFLOPS EFLOPS ZFLOPS)\$'

Examples:
"1250 TFLOPS", "1.25 PFLOPS",
"1250000 GFLOPS" | | +| avalMem | string | O | 0..1 | Contains the maximum memory resource available for the API Invoker.

It is encoded as a string representing a memory resource that shall be formatted as follows:
Pattern: '^d+(\.\d+)? (KB MB GB TB PB EB ZB YB)\$'

Examples:
"128 GB", "0.128 TB", "128000 MB" | | +| avalStor | string | O | 0..1 | Contains the maximum storage resource available for the API Invoker.

It is encoded as a string representing a storage resource that shall be formatted as follows:
Pattern: '^d+(\.\d+)? (KB MB GB TB PB EB ZB YB)\$'

Examples:
"128 TB", "0.128 PB", "128000 GB" | | +| conBand | UInteger | O | 0..1 | Contains the connection bandwidth (expressed in kbps) advertised for the API Invoker's use. | | + +NOTE: At least one of the attributes of this data structure shall be present. + +## 8.2.4.2.14 Type: IpAddrRange + +Table 8.2.4.2.14-1: Definition of type IpAddrRange + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|----------------------------------------------------------------|---------------| +| ueIpv4AddrRanges | array(Ipv4AddressRange) | C | 1..N | Represents the IPv4 Address ranges of the UE(s).

(NOTE) | | +| ueIpv6AddrRanges | array(Ipv6AddressRange) | C | 1..N | Represents the IPv6 Address ranges of the UE(s).

(NOTE) | | + +NOTE: At least one of these attributes shall be provided. + +## 8.2.4.3 Simple data types and enumerations + +## 8.2.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.2.4.3.2 Simple data types + +The simple data types defined in table 8.2.4.3.2-1 shall be supported. + +Table 8.2.4.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +## 8.2.4.3.3 Enumeration: Protocol + +Table 8.2.4.3.3-1: Enumeration Protocol + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------|------------------------| +| HTTP_1_1 | Indicates that the protocol is HTTP version 1.1. | | +| HTTP_2 | Indicates that the protocol is HTTP version 2. | | +| MQTT | Indicates that the protocol is Message Queuing Telemetry Transport.

(NOTE) | ProtocDataFormats_Ext1 | +| WEBSOCKET | Indicates that the protocol is Websocket.

(NOTE) | ProtocDataFormats_Ext1 | + +NOTE: In this release of the specification, this enumeration value shall not be provided for AEFs defined by 3GPP (e.g. SCEF, NEF). It may only be provided for AEFs defined outside 3GPP (e.g. by other SDOs). + +#### 8.2.4.3.4 Enumeration: DataFormat + +**Table 8.2.4.3.4-1: Enumeration DataFormat** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------|------------------------| +| JSON | Indicates that the data format is JSON (JavaScript Object Notation). | | +| XML | Indicates that the data format is Extensible Markup Language.
(NOTE) | ProtocDataFormats_Ext1 | +| PROTOBUF3 | Indicates that the data format is Protocol buffers version 3.
(NOTE) | ProtocDataFormats_Ext1 | + +NOTE: In this release of the specification, this enumeration value shall not be provided for AEFs defined by 3GPP (e.g. SCEF, NEF). It may only be provided for AEFs defined outside 3GPP (e.g. by other SDOs). + +#### 8.2.4.3.5 Enumeration: CommunicationType + +**Table 8.2.4.3.5-1: Enumeration CommunicationType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------|---------------| +| REQUEST_RESPONSE | The communication is of the type request-response. | | +| SUBSCRIBE_NOTIFY | The communication is of the type subscribe-notify | | + +#### 8.2.4.3.6 Enumeration: SecurityMethod + +**Table 8.2.4.3.6-1: Enumeration SecurityMethod** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| PSK | Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122 [16]. | | +| PKI | Security method 2 (Using PKI) as described in 3GPP TS 33.122 [16]. | | +| OAUTH | Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122 [16]. | | + +#### 8.2.4.3.7 Enumeration: Operation + +**Table 8.2.4.3.7-1: Enumeration Operation** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------|---------------| +| GET | HTTP GET method | | +| POST | HTTP POST method | | +| PUT | HTTP PUT method | | +| PATCH | HTTP PATCH method | | +| DELETE | HTTP DELETE method | | + +### 8.2.5 Error Handling + +#### 8.2.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.2.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Publish\_Service\_API. + +### 8.2.5.3 Application Errors + +The application errors defined for the CAPIF\_Publish\_Service\_API are listed in table 8.2.5.3-1. + +**Table 8.2.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.2.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 8.2.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ApiSupportedFeaturePublishing | Indicates the support of publishing with supported feature for a service API. | +| 2 | PatchUpdate | Indicates the support of the PATCH method for updating an APF published API resource. | +| 3 | ExtendedIntfDesc | Indicates the support of extended interface descriptions. | +| 4 | MultipleCustomOperations | Indicates the support of modelling multiple custom operations associated with a resource. | +| 5 | ProtocDataFormats_Ext1 | Indicates the support of additional protocols and data formats with standardized values.

(NOTE) | +| 6 | ApiStatusMonitoring | Indicates the support of the API status monitoring in CAPIF layer as a part of enhancement of SEAL framework.

This feature enables the following functionality:
- support API status information management. | +| 7 | EdgeApp_2 | This feature indicates the support of the enhancements to the Edge Applications. Within this feature, the following enhancements are covered:
- support of Service KPI. | +| 8 | RNAA | Indicates the support of the RNAA functionality.

This feature enables the following functionality:
- provisioning the list of public IP ranges of UEs for service API publish and update enhancements. | +| NOTE: In this release of the specification, this feature is only applicable for AEFs defined outside 3GPP (e.g. by other SDOs). It does not apply to AEFs defined by 3GPP (e.g. SCEF, NEF). | | | + +## 8.3 CAPIF\_Events\_API + +### 8.3.1 API URI + +The CAPIF\_Events\_API service shall use the CAPIF\_Events\_API. + +The request URIs used in HTTP requests from the Subscriber towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "capif-events". +- The shall be "v1". +- The shall be set as described in clause 8.3.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.3.2 Resources + +#### 8.3.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.3.2.1-1 depicts the resource URIs structure for the CAPIF\_Events\_API. + +![A hierarchical diagram showing the resource URI structure for the CAPIF_Events_API. The root is {apiRoot}/capif-events/. A line descends from this root to a branch labeled /{subscriberId}. From /{subscriberId}, a line descends to a rounded rectangular box containing /subscriptions. From this box, a line descends to another rounded rectangular box containing /{subscriptionId}.](a6f9ef297168667527ab18da412f917d_img.jpg) + +``` + +graph TD + Root["{apiRoot}/capif-events/"] --> SubId["/{subscriberId}"] + SubId --> Subs["/subscriptions"] + Subs --> SubId2["/{subscriptionId}"] + +``` + +A hierarchical diagram showing the resource URI structure for the CAPIF\_Events\_API. The root is {apiRoot}/capif-events/. A line descends from this root to a branch labeled /{subscriberId}. From /{subscriberId}, a line descends to a rounded rectangular box containing /subscriptions. From this box, a line descends to another rounded rectangular box containing /{subscriptionId}. + +**Figure 8.3.2.1-1: Resource URI structure of the CAPIF\_Events\_API** + +Table 8.3.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.3.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------|------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------| +| CAPIF Events Subscriptions | /{subscriberId}/subscriptions | POST | Creates a new individual CAPIF Event Subscription | +| Individual CAPIF Events Subscription | /{subscriberId}/subscriptions/{subscriptionId} | DELETE | Deletes an individual CAPIF Event Subscription identified by the subscriptionId | + +### 8.3.2.2 Resource: CAPIF Events Subscriptions + +#### 8.3.2.2.1 Description + +The CAPIF Events Subscriptions resource represents all subscriptions of aSubscriber. + +#### 8.3.2.2.2 Resource Definition + +Resource URI: {apiRoot}/capif-events//{subscriberId}/subscriptions + +This resource shall support the resource URI variables defined in table 8.3.2.2.2-1. + +**Table 8.3.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|--------------|-----------|----------------------| +| apiRoot | string | See clause 7.5 | +| subscriberId | string | ID of the Subscriber | + +#### 8.3.2.2.3 Resource Standard Methods + +##### 8.3.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.3.2.2.3.1-1. + +**Table 8.3.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.3.2.2.3.1-2 and the response data structures and response codes specified in table 8.3.2.2.3.1-3. + +**Table 8.3.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------| +| EventSubscription | M | 1 | Create a new individual CAPIF Events Subscription resource. | + +**Table 8.3.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| EventSubscription | M | 1 | 201
Created | CAPIF Events Subscription resource created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.3.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/capif-events//{subscriberId}/subscriptions/{subscriptionId} | + +#### 8.3.2.2.4 Resource Custom Operations + +None. + +#### 8.3.2.3 Resource: Individual CAPIF Events Subscription + +##### 8.3.2.3.1 Description + +The Individual CAPIF Events Subscription resource represents an individual event subscription of aSubscriber. + +##### 8.3.2.3.2 Resource Definition + +Resource URI: {apiRoot}/capif-events//{subscriberId}/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 8.3.2.3.2-1. + +**Table 8.3.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|----------------------------------------------| +| apiRoot | string | See clause 7.5 | +| subscriberId | string | ID of the Subscriber | +| subscriptionId | string | Identifies an individual Events Subscription | + +##### 8.3.2.3.3 Resource Standard Methods + +###### 8.3.2.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 8.3.2.3.3.1-1. + +**Table 8.3.2.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.3.2.3.3.1-2 and the response data structures and response codes specified in table 8.3.2.3.3.1-3. + +**Table 8.3.2.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.3.2.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual CAPIF Events Subscription matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.3.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.3.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.3.2.3.3.2 PUT + +The PUT method is used to update an existing subscription resource. + +The subscribing entity shall initiate the HTTP PUT request message and the CAPIF core function shall respond to the message. + +This method shall support the request data structures specified in table 8.3.2.3.3.2-1 and the response data structures and response codes specified in table 8.3.2.3.3.2-2. + +**Table 8.3.2.3.3.2-1: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|----------------------------------------------------------------------------------------------------| +| EventSubscription | M | 1 | Contains the updated representation of the existing individual CAPIF Events Subscription resource. | + +**Table 8.3.2.3.3.2-2: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventSubscription | M | 1 | 200 OK | The event subscription was successfully updated, and a representation of the updated resource is returned. | +| N/A | | | 204 No Content | The event subscription was successfully updated and no content is returned in the response body. | +| N/A | | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------|--|--|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| N/A | | | 308
Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. | | | | | + +**Table 8.3.2.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.3.2.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.3.2.3.3.3 PATCH + +The PATCH method allows to modify an existing subscription. + +The subscribing entity shall initiate the HTTP PATCH request message and the CAPIF core function shall respond to the message. + +This method shall support the request data structures specified in table 8.3.2.3.3.3-1 and the response data structures and response codes specified in table 8.3.2.3.3.3-2. + +**Table 8.3.2.3.3.3-1: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| EventSubscriptionPatch | M | 1 | Contains the parameters to request the modification of the existing individual CAPIF Events Subscription resource. | + +**Table 8.3.2.3.3.3-2: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventSubscription | M | 1 | 200 OK | The subscription was successfully modified and a representation of the updated resource is returned in the response body. | +| N/A | | | 204 No Content | The subscription was successfully modified and no content was returned in the response body. | +| N/A | | | 307 Temporary Redirect | Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| N/A | | | 308 Permanent Redirect | Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------|--|--|--|---------------------------------------------------------------------------------------------| +| | | | | core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply. | | | | | + +**Table 8.3.2.3.3.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.3.2.3.3.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.3.2.3.4 Resource Custom Operations + +None. + +## 8.3.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.3.3 Notifications + +### 8.3.3.1 General + +The delivery of notifications shall conform to clause 7.6. + +**Table 8.3.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|---------------------------|---------------------------------|--------------------------------------| +| Event notification | {notificationDestination} | POST | Notifies Subscriber of a CAPIF Event | + +### 8.3.3.2 Event Notification + +#### 8.3.3.2.1 Description + +Event Notification is used by the CAPIF core function to notify a Subscriber of an Event. The Subscriber shall be subscribed to such Event Notification via the Individual CAPIF Events Subscription Resource. + +#### 8.3.3.2.2 Notification definition + +The POST method shall be used for Event notification and the URI shall be the one provided by the Subscriber during the subscription to the event. + +Callback URI: {notificationDestination} + +This method shall support the URI query parameters specified in table 8.3.3.2.2.1-1. + +**Table 8.3.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.3.3.2.2-2 and the response data structures and response codes specified in table 8.3.3.2.2-3. + +**Table 8.3.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------| +| EventNotification | M | 1 | Notification information of a CAPIF Event | + +**Table 8.3.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.3.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 8.3.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +## 8.3.4 Data Model + +### 8.3.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.3.4.1-1 specifies the data types defined specifically for the CAPIF\_Events\_API service. + +**Table 8.3.4.1-1: CAPIF\_Events\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------|------------------|-----------------------------------------------------------------|-----------------------| +| AccessControlPolicyListExt | Clause 8.3.4.2.6 | Represents the extension for access control policies. | | +| CAPIFEvent | Clause 8.3.4.3.2 | Describes the CAPIF event. | | +| CAPIFEventDetail | Clause 8.3.4.2.5 | Represents the CAPIF event detail. | Enhanced_event_report | +| CAPIFEventFilter | Clause 8.3.4.2.4 | Represents the CAPIF event filter. | Enhanced_event_report | +| EventNotification | Clause 8.3.4.2.3 | Represents an individual CAPIF Event Subscription Notification. | | +| EventSubscription | Clause 8.3.4.2.2 | Represents an individual CAPIF Event Subscription resource. | | +| TopologyHiding | Clause 8.3.4.2.7 | Represents the routing rules information of a service API. | | + +Table 8.3.4.1-2 specifies data types re-used by the CAPIF\_Events\_API service: + +**Table 8.3.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| ReportingInformation | 3GPP TS 29.523 [26] | Used to indicate the reporting requirement, only the following information are applicable for CAPIF:
  • - immRep
  • - notifMethod
  • - maxReportNbr
  • - monDur
  • - repPeriod
| Enhanced_event_report | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.3.6-1. | | + +## 8.3.4.2 Structured data types + +### 8.3.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 8.3.4.2.2 Type: EventSubscription + +Table 8.3.4.2.2-1: Definition of type EventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| events | array(CAPIFEvent) | M | 1..N | Subscribed events | | +| eventFilters | array(CAPIFEventFilter) | O | 1..N | Subscribed event filters.
The n th entry in the "eventFilters" attribute shall correspond to the n th entry in the "events" attribute. For event not having event filter, an empty event filter entry without any sub-attribute shall be provided. | Enhanced_event_report | +| eventReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. | Enhanced_event_report | +| notificationDestination | Uri | M | 1 | URI where the notification should be delivered to. | | +| requestTestNotification | boolean | O | 0..1 | Set to "true" by Subscriber to request the CAPIF core function to send a test notification as defined in clause 7.6. Set to "false" not request the CAPIF core function to send a test notification. Default value is "false" if omitted. | Notification_test_event | +| websocketNotifConfig | WebsocketNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6. | Notification_websocket | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +## 8.3.4.2.3 Type: EventNotification + +Table 8.3.4.2.3-1: Definition of type EventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------|-----------------------| +| subscriptionId | string | M | 1 | Identifier of the subscription resource to which the notification is related – CAPIF resource identifier | | +| events | CAPIFEvent | M | 1 | Notifications of individual events | | +| eventDetail | CAPIFEventDetail | C | 0..1 | Detailed information for the event.
(NOTE) | Enhanced_event_report | + +**NOTE:** Within the CAPIFEventDetail data type, the "serviceAPIDescriptions" attribute shall be provided if the event is SERVICE\_API\_UPDATE, the "apiIds" attribute shall be provided if the event is SERVICE\_API\_AVAILABLE, SERVICE\_API\_UNAVAILABLE, the "apiInvokerIds" attribute shall be provided only if the event is API\_INVOKER\_ONBOARDED or API\_INVOKER\_OFFBOARDED, or API\_INVOKER\_UPDATED, the "accCtrlPolList" attribute shall be provided if the event is ACCESS\_CONTROL\_POLICY\_UPDATE, the "invocationLogs" attribute shall be provided if the event is SERVICE\_API\_INVOCATION\_SUCCESS or SERVICE\_API\_INVOCATION\_FAILURE, the "apiTopoHide" attribute shall be provided if the event is API\_TOPOLOGY HIDING\_CREATED or API\_TOPOLOGY HIDING\_REVOKED. + +## 8.3.4.2.4 Type: CAPIEventFilter + +**Table 8.3.4.2.4-1: Definition of type CAPIEventFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------|---------------| +| apiIds | array(string) | O | 1..N | API identifiers that the event subscriber wants to know in the interested event. | | +| apiInvokerIds | array(string) | O | 1..N | API invokers that the event subscriber wants to know in the interested event. | | +| aefIds | array(string) | O | 1..N | String identifying the AEF. | | + +## 8.3.4.2.5 Type: CAPIEventDetail + +**Table 8.3.4.2.5-1: Definition of type CAPIEventDetail** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------------|---|-------------|---------------------------------------------------------|---------------| +| serviceAPIDescriptions | array(ServiceAPIDescription) | O | 1..N | Description of the service API as published by the APF. | | +| apiIds | array(string) | O | 1..N | API identifiers. | | +| apiInvokerIds | array(string) | O | 1..N | API invokers that are onboarded/offboarded. | | +| accCtrlPolList | AccessControlPolicyListExt | O | 0..1 | Access control policy updated list. | | +| invocationLogs | array(InvocationLog) | O | 1..N | Invocation logs | | +| apiTopoHide | TopologyHiding | O | 0..1 | Topology hiding information for a service API | | + +## 8.3.4.2.6 Type: AccessControlPolicyListExt + +**Table 8.3.4.2.6-1: Definition of type AccessControlPolicyListExt** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------|-----------|---|-------------|-------------------------------|---------------| +| apiId | string | M | 1 | Identifier of the service API | | +| NOTE: This data type also contains all the properties defined for AccessControlPolicyList data type. | | | | | | + +## 8.3.4.2.7 Type: TopologyHiding + +**Table 8.3.4.2.7-1: Definition of type TopologyHiding** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------|---------------| +| apiId | string | M | 1 | Identifier of the service API | | +| routingRules | array(RoutingRule) | M | 1..N | Routing rules | | + +### 8.3.4.2.8 Type: EventSubscriptionPatch + +**Table 8.3.4.2.8-1: Definition of type EventSubscriptionPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|----------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(CAP
IFEEvent) | O | 1..N | Subscribed events (NOTE). | | +| eventFilters | array(CAP
IFEEventFilt
er) | O | 1..N | Subscribed event filters.
The n th entry in the "eventFilters" attribute shall correspond to the n th entry in the "events" attribute. For event not having event filter, an empty event filter entry without any sub-attribute shall be provided (NOTE). | | +| eventReq | ReportingI
nformation | O | 0..1 | Represents the reporting requirements of the event subscription (NOTE). | | +| notificationDesti
nation | Uri | O | 0..1 | URI where the notification should be delivered to (NOTE). | | + +NOTE: At least one attribute shall be present. + +**Editor's Note:** Whether the list of subscribed events can be updated is FFS. + +### 8.3.4.3 Simple data types and enumerations + +#### 8.3.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 8.3.4.3.2 Simple data types + +None. + +The simple data types defined in table 8.3.4.3.2-1 shall be supported. + +**Table 8.3.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +### 8.3.4.3.3 Enumeration: CAPIFEvent + +**Table 8.3.4.3.3-1: Enumeration CAPIFEvent** + +| Enumeration value | Description | Applicability | +|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SERVICE_API_AVAILABLE | Events related to the availability of service APIs after the service APIs are published. | | +| SERVICE_API_UNAVAILABLE | Events related to the unavailability of service APIs after the service APIs are unpublished. | | +| SERVICE_API_UPDATE | Events related to change in service API information | | +| API_INVOKER_ONBOARDED | Events related to API invoker onboarded to CAPIF | | +| API_INVOKER_OFFBOARDED | Events related to API invoker offboarded from CAPIF | | +| SERVICE_API_INVOCATION_SUCCESS | Events related to the successful invocation of service APIs | | +| SERVICE_API_INVOCATION_FAILURE | Events related to the failed invocation of service APIs | | +| ACCESS_CONTROL_POLICY_UPDATE | Events related to the update for the access control policy related to the service APIs | | +| ACCESS_CONTROL_POLICY_UNAVAILABLE | Events related to the unavailability of the access control policy related to the service APIs (NOTE) | | +| API_INVOKER_AUTHORIZATION_REVOKED | Events related to the revocation of the authorization of API invokers to access the service APIs. (NOTE) | | +| API_INVOKER_UPDATED | Events related to API invoker profile updated to CAPIF. | | +| API_TOPOLOGY HIDING_CREATED | Events related to the creation or update of the API topology hiding information of the service API after the service APIs are published | | +| API_TOPOLOGY HIDING_REVOKED | Events related to the revocation of the API topology information of the service API after the service APIs are unpublished | | +| NOTE: The present release does not specify further details (e.g. event filters) for this event. | | | + +## 8.3.5 Error Handling + +### 8.3.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.3.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Events\_API. + +### 8.3.5.3 Application Errors + +The application errors defined for the CAPIF\_Events\_API are listed in table 8.3.5.3-1. + +**Table 8.3.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.3.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.3.6-1 lists the supported features for CAPIF\_Events\_API. + +**Table 8.3.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | Enhanced_event_report | This feature supports the enhanced event report including event reporting requirement and event reporting details as defined in clause 5.4.2.2.2. | +| 4 | ApiStatusMonitoring | Indicates the support of the API status monitoring in CAPIF layer as a part of enhancement of SEAL framework.

This feature enables the following functionality:
- enhancement of the CAPIF event notification. | + +## 8.4 CAPIF\_API\_Invoker\_Management\_API + +### 8.4.1 API URI + +The CAPIF\_API\_Invoker\_Management\_API service shall use the CAPIF\_API\_Invoker\_Management\_API. + +The request URIs used in HTTP requests from the API invoker towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "api-invoker-management". +- The shall be "v1". +- The shall be set as described in clause 8.4.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.4.2 Resources + +#### 8.4.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.4.2.1-1 depicts the resource URIs structure for the CAPIF\_API\_Invoker\_Management\_API. + +![Diagram showing the resource URI structure. A root URI '{apiRoot}/api-invoker-management/' has a line pointing to a box containing '/onboardedInvokers'. From this box, another line points to a second box containing '/{onboardingId}'.](c07e21a8d65991db04263322f859c94f_img.jpg) + +{apiRoot}/api-invoker-management/ + +``` + +graph TD + Root["{apiRoot}/api-invoker-management/"] --> Box1["/onboardedInvokers"] + Box1 --> Box2["/{onboardingId}"] + +``` + +Diagram showing the resource URI structure. A root URI '{apiRoot}/api-invoker-management/' has a line pointing to a box containing '/onboardedInvokers'. From this box, another line points to a second box containing '/{onboardingId}'. + +**Figure 8.4.2.1-1: Resource URI structure of the CAPIF\_API\_Invoker\_Management\_API** + +Table 8.4.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.4.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------|---------------------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------| +| On-boarded API Invokers | /onboardedInvokers
(NOTE) | POST | On-boards a new API invoker by creating an API invoker profile | +| Individual On-boarded API Invoker | /onboardedInvokers/{onboardingId}
(NOTE) | DELETE | Off-boards an individual API invoker by deleting the associated API invoker profile identified by {onboardingId} | +| | | PATCH | Modifies the API invoker details of an individual API invoker identified by the {onboardingId} | +| | | PUT | Updates the API invoker details of an individual API invoker identified by the {onboardingId} | + +NOTE: The path segment "onboardedInvokers" does not follow the related naming convention defined in subclause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. + +## 8.4.2.2 Resource: On-boarded API invokers + +### 8.4.2.2.1 Description + +The On-boarded API Invokers resource represents all the API invokers that are on-boarded at a given CAPIF core function. + +### 8.4.2.2.2 Resource Definition + +Resource URI: {apiRoot}/api-invoker-management//onboardedInvokers + +This resource shall support the resource URI variables defined in table 8.4.2.2.2-1. + +**Table 8.4.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.4.2.2.3 Resource Standard Methods + +#### 8.4.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.4.2.2.3.1-1. + +**Table 8.4.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.2.3.1-2 and the response data structures and response codes specified in table 8.4.2.2.3.1-3. + +**Table 8.4.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrolmentDetails | M | 1 | Enrolment details of the API invoker including notification destination URI for any on-boarding related notifications and an optional list of APIs the API invoker intends to invoke while on-board. | + +**Table 8.4.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrolmentDetails | M | 1 | 201
Created | API invoker on-boarded successfully

The URI of the created resource shall be returned in the "Location" HTTP header. A list of APIs the API invoker is allowed to invoke while on-board may also be included as part of the APIInvokerEnrolmentDetails which is provided in the response body, if requested in the POST request. | +| n/a | | | 202
Accepted | The CAPIF core has accepted the Onboarding request and is processing it. When processing is completed, the CAPIF core function will send a Notify_Onboarding_Completion notification to the requesting API invoker. See clause 8.4.3.2. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/api-invoker-management//onboardedInvokers/{onboardingId} | + +### 8.4.2.2.4 Resource Custom Operations + +None. + +## 8.4.2.3 Resource: Individual On-boarded API Invoker + +### 8.4.2.3.1 Description + +The Individual On-boarded API Invokers resource represents an individual API invoker that is on-boarded at a given CAPIF core function. + +### 8.4.2.3.2 Resource Definition + +Resource URI: {apiRoot}/api-invoker-management//onboardedInvokers/{onboardingId} + +This resource shall support the resource URI variables defined in table 8.4.2.3.2-1. + +**Table 8.4.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|--------------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| onboardingId | string | String identifying an individual on-boarded API invoker resource | + +### 8.4.2.3.3 Resource Standard Methods + +#### 8.4.2.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 8.4.2.3.3.1-1. + +**Table 8.4.2.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the response codes specified in table 8.4.2.3.3.1-2 and the response data structures and response codes specified in table 8.4.2.3.3.1-3. + +**Table 8.4.2.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.4.2.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual on-boarded API invoker matching the onboardingId is deleted | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.4.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.4.2.3.3.2 PUT + +The PUT method allows updating the API invoker details of the onboarded API invoker. This method shall support the URI query parameters specified in table 8.4.2.3.3.2-1. + +**Table 8.4.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in the table 8.4.2.3.3.2-2 and the response data structures and response codes specified in the table 8.4.2.3.3.2-3. + +**Table 8.4.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrollmentDetails | M | 1 | Updated details of the API invoker and a notification destination URI for any update request related notifications. | + +**Table 8.4.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrolmentDetails | M | 1 | 200 OK | API invoker's information updated successfully.

Updated details of the API invoker as part of the APIInvokerEnrolmentDetails, which is provided in the response body. | +| n/a | | | 202 Accepted | The CAPIF core has accepted the Update details request and is processing it. When processing is completed, the CAPIF core function will send a Notify_Update_Completion notification to the requesting API invoker. See clause 8.4.3.3. | +| n/a | | | 204 No Content | API invoker's information updated successfully, with no content to be sent in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.4.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.4.2.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 8.4.2.3.3.3-1. + +**Table 8.4.2.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.2.3.3.3-2 and the response data structures and response codes specified in table 8.4.2.3.3.3-3. + +**Table 8.4.2.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrolmentDetailsPatch | M | 1 | Modified details of the API invoker and a notification destination URI for any modify request related notifications. | + +**Table 8.4.2.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIInvokerEnrolmentDetails | M | 1 | 200 OK | API invoker's information modified successfully.

Modified details of the API invoker as part of the APIInvokerEnrolmentDetails, which is provided in the response body. | +| n/a | | | 202 Accepted | The CAPIF core has accepted the modify details request and is processing it. When processing is completed, the CAPIF core function will send a Notify_Update_Completion notification to the requesting API invoker. See sub clause 8.4.3.3. | +| n/a | | | 204 No Content | API invoker's information modified successfully, with no content to be sent in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.4.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.4.2.3.4 Resource Custom Operations + +None. + +### 8.4.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.4.3 Notifications + +### 8.4.3.1 General + +The delivery of notifications shall conform to clause 7.6. + +**Table 8.4.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------|---------------------------|---------------------------------|----------------------------------------------| +| Notify_Onboarding_Completion | {notificationDestination} | POST | Notify API invoker of on-boarding result | +| Notify_Update_Completion | {notificationDestination} | POST | Notify API invoker of update result details. | + +### 8.4.3.2 Notify\_Onboarding\_Completion + +#### 8.4.3.2.1 Description + +Notify\_Onboarding\_Completion is used by the CAPIF core function to notify an API invoker of the on-boarding result. + +#### 8.4.3.2.2 Notification definition + +The POST method shall be used for Notify\_Onboarding\_Completion and the URI shall be the one provided by the API invoker during the on-boarding request. + +Callback URI: {notificationDestination} + +This method shall support the URI query parameters specified in table 8.4.3.2.2-1. + +**Table 8.4.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.3.2.2-2 and the response data structures and response codes specified in table 8.4.3.2.2-3. + +**Table 8.4.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------| +| OnboardingNotification | M | 1 | Notification with on-boarding result | + +**Table 8.4.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 8.4.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +### 8.4.3.3 Notify\_Update\_Completion + +#### 8.4.3.3.1 Description + +Notify\_Update\_Completion is used by the CAPIF core function to notify of the update of API Invoker's details result. + +#### 8.4.3.3.2 Notification definition + +The POST method shall be used for Notify\_Update\_Completion and the URI shall be the one provided by the API invoker during the API invoker details update request. + +Callback URI: {notificationDestination} + +This method shall support the URI query parameters specified in table 8.4.3.3.2-1. + +**Table 8.4.3.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.4.3.3.2-2 and the response data structures and response codes specified in table 8.4.3.3.2-3. + +**Table 8.4.3.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------| +| OnboardingNotification | M | 1 | Notification with API Invoker's details update result. | + +**Table 8.4.3.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.4.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 8.4.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +## 8.4.4 Data Model + +### 8.4.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.4.4.1-1 specifies the data types defined specifically for the CAPIF\_API\_Invoker\_Management\_API service. + +**Table 8.4.4.1-1: CAPIF\_API\_Invoker\_Management\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------------|------------------------|-------------------------------------------------------------------------|----------------------| +| APIInvokerEnrolmentDetails | Clause 8.4.4.2.2 | Represents information about the API Invoker that requested to onboard. | | +| APIInvokerEnrolmentDetailsPatch | Clause 8.4.4.2.8 | Represents an API Invoker's enrolment details to be updated. | PatchUpdate | +| APIList | Clause 8.4.4.2.4 | The list of service APIs that the API Invoker is allowed to invoke. | | +| OnboardingInformation | Clause 8.4.4.2.5 | Represents on-boarding information of the API invoker. | | +| OnboardingNotification | Clause 8.4.4.2.7 | Represents the notification with on-boarding or update result. | | + +Table 8.4.4.1-2 specifies data types re-used by the CAPIF\_API\_Invoker\_Management\_API service. + +**Table 8.4.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------------------------------------------------|----------------------| +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.4.6-1. | | + +## 8.4.4.2 Structured data types + +### 8.4.4.2.1 Introduction + +### 8.4.4.2.2 Type: APIInvokerEnrolmentDetails + +**Table 8.4.4.2.2-1: Definition of type APIInvokerEnrolmentDetails** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| apiInvokerId | string | O | 0..1 | API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. | | +| onboardingInformation | OnboardingInformation | M | 1 | On-boarding information about the API invoker necessary for the CAPIF core function to on-board the API invoker. | | +| notificationDestination | Uri | M | 1 | URI where the notification should be delivered to. | | +| requestTestNotification | boolean | O | 0..1 | CAPIF core function to send a test notification as defined in in clause 7.6. Set to "false" to request the CAPIF core function not to send a test notification.Default value is "false" if omitted. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6. | Notification_websocket | +| apiList | APIList | O | 0..1 | A list of APIs. When included by the API invoker in the HTTP request message, it lists the APIs that the API invoker intends to invoke while onboard or API invoker update. When included by the CAPIF core function in the HTTP response message, it lists the APIs that the API invoker is allowed to invoke while onboard or API invoker update. | | +| apiInvokerInformation | string | O | 0..1 | Generic information related to the API invoker such as details of the device or the application. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +### 8.4.4.2.3 Type: Void + +### 8.4.4.2.4 Type: APIList + +**Table 8.4.4.2.4-1: Definition of type APIList** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------------|---|-------------|--------------------------------|---------------| +| serviceAPIDescriptions | array(ServiceAPIDescription) | O | 1..N | Definition of the service API. | | + +## 8.4.4.2.5 Type: OnboardingInformation + +Table 8.4.4.2.5-1: Definition of type OnboardingInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiInvokerPublicKey | string | M | 1 | Public Key of API Invoker | | +| apiInvokerCertificate | string | O | 0..1 | API invoker's generic client certificate. The subject field in the certificate shall be encoded with API invoker ID as Common Name as specified in IETF RFC 5280 [29]. | | +| onboardingSecret | string | O | 0..1 | API invoker's onboarding secret, provided by the CAPIF core function. | | + +## 8.4.4.2.6 Type: Void + +## 8.4.4.2.7 Type: OnboardingNotification + +Table 8.4.4.2.7-1: Definition of type OnboardingNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| result | boolean | M | 1 | Set to "true" indicate successful onboarding. Set to "false" indicate unsuccessful onboarding. Default value is "false" if omitted. | | +| resourceLocation | Uri | C | 0..1 | URI pointing to the new CAPIF resource created as a result of successful onboarding. This attribute shall be present if 'result' attribute is set to "true". Otherwise it shall not be present. | | +| apiInvokerEnrolmentDetails | APIInvokerEnrolmentDetails | C | 0..1 | Enrolment details of the API invoker which are verified by the CAPIF administrator or API management. This attribute shall be present if 'result' attribute is set to "true". Otherwise it shall not be present. | | +| apiList | APIList | O | 0..1 | List of APIs API invoker is allowed to access. This attribute may be present if 'result' attribute is set to "true". Otherwise it shall not be present. | | + +## 8.4.4.2.8 Type: APIInvokerEnrolmentDetailsPatch + +Table 8.4.4.2.8-1: Definition of type APIInvokerEnrolmentDetailsPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| onboardingInformation | OnboardingInformation | O | 0..1 | On-boarding information about the API invoker necessary for the CAPIF core function to on-board the API invoker. | | +| notificationDestination | Uri | O | 0..1 | URI where the notification should be delivered to. | | +| apiList | APIList | O | 0..1 | A list of APIs. When included by the API invoker in the HTTP request message, it lists the APIs that the API invoker intends to invoke while onboard or API invoker update. | | +| apiInvokerInformation | string | O | 0..1 | Generic information related to the API invoker such as details of the device or the application. | | + +#### 8.4.4.3 Simple data types and enumerations + +None. + +### 8.4.5 Error Handling + +#### 8.4.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +#### 8.4.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_API\_Invoker\_Management\_API. + +#### 8.4.5.3 Application Errors + +The application errors defined for the CAPIF\_API\_Invoker\_Management\_API are listed in table 8.4.5.3-1. + +**Table 8.4.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 8.4.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.4.6-1 lists the supported features for CAPIF\_API\_Invoker\_Management\_API. + +**Table 8.4.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | PatchUpdate | Indicates the support of the PATCH method for updating an On-boarded API Invoker resource. | + +## 8.5 CAPIF\_Security\_API + +### 8.5.1 API URI + +The CAPIF\_Security\_API service shall use the CAPIF\_Security\_API. + +The request URIs used in HTTP requests from the API invoker or the API exposing function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "capif-security". +- The shall be "v1". + +- The shall be set as described in clause 8.5.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +## 8.5.2 Resources + +### 8.5.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.5.2.1-1 depicts the resource URIs structure for the CAPIF\_Security\_API. + +![Resource URI structure of the CAPIF_Security_API diagram](896f6ec457b6252d4af32a634299218c_img.jpg) + +``` +graph TD; Root["{apiRoot}/capif-security/{apiVersion}"] --- T["/trustedInvokers"]; Root --- S["/securities/{securityId}"]; T --- Id["/{apiInvokerId}"]; Id --- Update["/update"]; Id --- Delete["/delete"]; S --- Token["/token"]; +``` + +The diagram illustrates the hierarchical structure of resource URIs for the CAPIF\_Security\_API. It starts with a root path: {apiRoot}/capif-security/{apiVersion}. From this root, two main branches emerge: /trustedInvokers and /securities/{securityId}. The /trustedInvokers branch further leads to a specific invoker resource: /{apiInvokerId}, which in turn has two associated operations: /update and /delete. The /securities/{securityId} branch leads to a token resource: /token. + +Resource URI structure of the CAPIF\_Security\_API diagram + +**Figure 8.5.2.1-1: Resource URI structure of the CAPIF\_Security\_API** + +Table 8.5.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.5.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------|--------------------------------------------------|---------------------------------|-----------------------------------------------------------------------| +| Trusted API invokers | /trustedInvokers
(NOTE) | n/a | | +| Individual trusted API invoker | /trustedInvokers/{apiInvokerId}
(NOTE) | GET | Retrieve authentication information of an API invoker | +| | | PUT | Create a security context for individual API invoker | +| | | DELETE | Revoke the authorization of the API invoker | +| | /trustedInvokers/{apiInvokerId}/update
(NOTE) | update (POST) | Update the security context (e.g. re-negotiate the security methods). | +| | /trustedInvokers/{apiInvokerId}/delete
(NOTE) | delete (POST) | Revoke the authorization of the API invoker for some APIs | +| | /securities/{securityId}/token
(NOTE) | token (POST) | Obtain the OAuth 2.0 authorization information | + +NOTE: The path segment "trustedInvokers" does not follow the related naming convention defined in subclause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. + +## 8.5.2.2 Resource: Trusted API invokers + +### 8.5.2.2.1 Description + +The Trusted API Invokers resource represents all the API invokers that are trusted by the CAPIF core function and have received authentication information from the CAPIF core function. + +### 8.5.2.2.2 Resource Definition + +Resource URI: {apiRoot}/capif-security//trustedInvokers + +This resource shall support the resource URI variables defined in table 8.5.2.2.2-1. + +**Table 8.5.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.5.2.2.3 Resource Standard Methods + +#### 8.5.2.2.3.1 Void + +### 8.5.2.2.4 Resource Custom Operations + +None. + +### 8.5.2.3 Resource: Individual trusted API invokers + +#### 8.5.2.3.1 Description + +The Individual trusted API Invokers resource represents an individual API invokers that is trusted by the CAPIF core function and have received security related information from the CAPIF core function. + +#### 8.5.2.3.2 Resource Definition + +Resource URI: {apiRoot}/capif-security//trustedInvokers/{apiInvokerId} + +This resource shall support the resource URI variables defined in table 8.5.2.3.2-1. + +**Table 8.5.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|--------------|-----------|--------------------------------------| +| apiRoot | string | See clause 7.5 | +| apiInvokerId | string | Identifies an individual API invoker | + +#### 8.5.2.3.3 Resource Standard Methods + +##### 8.5.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 8.5.2.3.3.1-1. + +**Table 8.5.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authenticationInfo | boolean | O | 0..1 | When set to "true", it indicates the CAPIF core function to send the authentication information of the API invoker. Set to "false" or omitted.
(NOTE) | +| authorizationInfo | boolean | O | 0..1 | When set to "true", it indicates the CAPIF core function to send the authorization information of the API invoker. Set to "false" indicates the CAPIF core function not to send the authorization information of the API invoker. Default value is "false" if omitted.
(NOTE) | + +NOTE: The query parameters "authenticationInfo" and "authorizationInfo" do not follow the related naming convention defined in subclause 7.5.1. These query parameters are however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 8.5.2.3.3.1-2 and the response data structures and response codes specified in table 8.5.2.3.3.1-3. + +**Table 8.5.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSecurity | M | 1 | 200 OK | The security related information of the API Invoker based on the request from the API exposing function. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.5.2.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 8.5.2.3.3.2-1. + +**Table 8.5.2.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.2-2 and the response data structures and response codes specified in table 8.5.2.3.3.2-3. + +**Table 8.5.2.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Authorization of the API invoker revoked, and a notification is sent to the API invoker as specified in clause 8.5.3.2 | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.5.2.3.3.3 PUT + +This method shall support the URI query parameters specified in table 8.5.2.3.3.3-1. + +**Table 8.5.2.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.2.3.3.3-2 and the response data structures and response codes specified in table 8.5.2.3.3.3-3. + +**Table 8.5.2.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSecurity | M | 1 | Security method request from the API invoker to the CAPIF core function. The request indicates a list of service APIs and a preferred method of security for the service APIs.

The request also includes a notification destination URI for security related notifications. | + +**Table 8.5.2.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSecurity | M | 1 | 201
Created | Security method from the CAPIF core function to the API invoker is based on the received request. The response indicates the security method to be used for the service APIs

The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.5.2.3.3.3-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId} | + +## 8.5.2.3.4 Resource Custom Operations + +### 8.5.2.3.4.1 Overview + +**Table 8.5.2.3.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------------------------|--------------------|------------------------------------------------------------------------| +| update | /trustedInvokers/{apiInvokerId}/update | POST | Update the security instance (e.g. re-negotiate the security methods). | +| delete | /trustedInvokers/{apiInvokerId}/delete | POST | Revoke the authorization of the API invoker for some APIs | +| token | /securities/{securityId}/token | POST | Obtain the OAuth 2.0 authorization information | + +### 8.5.2.3.4.2 Operation: update + +#### 8.5.2.3.4.2.1 Description + +This custom operation updates an existing Individual security instance resource in the CAPIF core function. + +#### 8.5.2.3.4.2.2 Operation Definition + +This method shall support the URI query parameters specified in table 8.5.2.3.4.2.2-1. + +**Table 8.5.2.3.4.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This operation shall support the request data structures specified in table 8.5.2.3.4.2.2-2 and the response data structure and response codes specified in table 8.5.2.3.4.2.2-3. + +**Table 8.5.2.3.4.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSecurity | M | 1 | Security method request from the API invoker to the CAPIF core function. The request indicates a list of service APIs and a preferred method of security for the service APIs.

The request also includes a notification destination URI for security related notifications. | + +**Table 8.5.2.3.4.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceSecurity | M | 1 | 200 OK | Security method from the CAPIF core function to the API invoker is based on the received request. The response indicates the security method to be used for the service APIs | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during security instance modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during security instance modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.4.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.4.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +8.5.2.3.4.3 Operation: delete + +8.5.2.3.4.3.1 Description + +This custom operation revokes authorization for some service APIs of an existing Individual security instance resource in the CAPIF core function. + +8.5.2.3.4.3.2 Operation Definition + +This method shall support the URI query parameters specified in table 8.5.2.3.4.3.2-1. + +**Table 8.5.2.3.4.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This operation shall support the request data structures specified in table 8.5.2.3.4.3.2-2 and the response data structure and response codes specified in table 8.5.2.3.4.3.2-3. + +**Table 8.5.2.3.4.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| SecurityNotification | M | 1 | It includes a list of API identifiers for which authorization needs to be revoked for an API invoker. | + +**Table 8.5.2.3.4.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The CAPIF core function revoked the authorization of the API invoker for the requested APIs. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during authorization revocation.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during authorization revocation.
The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.5.2.3.4.4 Operation: token + +##### 8.5.2.3.4.4.1 Description + +This custom operation obtains OAuth 2.0 authorization information from an existing Individual security instance resource in the CAPIF core function. + +##### 8.5.2.3.4.4.2 Operation Definition + +This method shall support the URI query parameters specified in table 8.5.2.3.4.4.2-1. + +**Table 8.5.2.3.4.4.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This operation shall support the request data structures specified in table 8.5.2.3.4.4.2-2 and the response data structure and response codes specified in table 8.5.2.3.4.4.2-3. + +**Table 8.5.2.3.4.4.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------| +| AccessTokenReq | M | 1 | This IE shall contain the request information for the access token request. | + +**Table 8.5.2.3.4.4.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessTokenRsp | M | 1 | 200 OK | This IE shall contain the access token response information. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during obtaining authorization information. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during obtaining authorization information. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| AccessTokenErr | M | 1 | 400 Bad Request | See IETF RFC 6749 [23] clause 5.2.
The specific error shall be indicated in the "error" attribute of the AccessTokenErr data type, containing any of the values:
- invalid_request
- invalid_client
- invalid_grant
- unauthorized_client
- unsupported_grant_type
- invalid_scope | +| AccessTokenErr | M | 1 | 401 Unauthorized | See IETF RFC 6749 [23] clause 5.2.
The specific error shall be indicated in the "error" attribute of the AccessTokenErr data type, containing value:
- invalid_client | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.4.4.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.4.4.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +## 8.5.2.3.4.5 Operation: code + +## 8.5.2.3.4.5.1 Description + +This custom operation obtains authorization code from an existing Individual security instance resource in the CAPIF core function. + +## 8.5.2.3.4.5.2 Operation Definition + +This method shall support the URI query parameters specified in table 8.5.2.3.4.5.2-1. + +**Table 8.5.2.3.4.5.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| response-type | string | M | 1 | The response type shall be set as "code" as defined in clause 4.1.1 of IETF 6749 [23] | +| api-invoker-id | string | M | 1 | String identifying the API invoker as defined as client_id in clause 4.1.1 of IETF 6749 [23] | +| resource-owner-id | string | O | 0..1 | String identifying resource owner as defined in clause 6.5.3.3 of TS 33.122 [16] | + +This method shall support the request data structures specified in table 8.5.2.3.4.5.2-2 and the response data structures and response codes specified in table 8.5.2.3.4.5.2-3. + +**Table 8.5.2.3.4.5.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.5.2.3.4.5.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizationCodeRsp | M | 1 | 302 Found | Authorization code requested by the API invoker. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.2.3.4.5.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.5.2.3.4.5.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +## 8.5.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.5.3 Notifications + +### 8.5.3.1 General + +The delivery of notifications shall conform to clause 7.6. + +**Table 8.5.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------|---------------------------|---------------------------------|--------------------------------------------------------------------------------------------| +| Authorization revoked notification | {notificationDestination} | POST | Notify API invoker that the authorization rights are revoked by the API exposing function. | + +### 8.5.3.2 Authorization revoked notification + +#### 8.5.3.2.1 Description + +Authorization revoked notification is used by the CAPIF core function to notify an API invoker that the authorization rights are revoked by the API exposing function. + +#### 8.5.3.2.2 Notification definition + +The POST method shall be used for Authorization revoked notification and the URI shall be the one provided by the API invoker during the Obtain\_Security\_Method service operation. + +Callback URI: {**notificationDestination**} + +This method shall support the URI query parameters specified in table 8.5.3.2.2-1. + +**Table 8.5.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.5.3.2.2-2 and the response data structures and response codes specified in table 8.5.3.2.2-3. + +**Table 8.5.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------| +| SecurityNotification | M | 1 | Notification with information related to revoked authorization. | + +**Table 8.5.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.5.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 8.5.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +## 8.5.4 Data Model + +### 8.5.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.5.4.1-1 specifies the data types defined specifically for the CAPIF\_Security\_API service. + +**Table 8.5.4.1-1: CAPIF\_Security\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| AccessTokenClaims | Clause 8.5.4.2.8 | Represents the claims data structure for the access token. | | +| AccessTokenErr | Clause 8.5.4.2.9 | Represents an error in the access token request. | | +| AccessTokenReq | Clause 8.5.4.2.6 | Represents the access token request information. | | +| AccessTokenRsp | Clause 8.5.4.2.7 | Represents the access token response information. | | +| Cause | Clause 8.5.4.3.3 | Indicates the cause for revoking the API invoker's authorization to the service API. | | +| SecurityInformation | Clause 8.5.4.2.3 | Represents the interface details and the security method. | | +| SecurityNotification | Clause 8.5.4.2.5 | Represents the revoked authorization notification details. | | +| ServiceSecurity | Clause 8.5.4.2.2 | Represents the details of the security method for each service API interface. When included by the API invoker, it shall indicate the preferred method of security. When included by the CAPIF core function, it shall indicate the security method to be used for the service API interface. | | +| AuthorizationCodeRsp | Clause 8.5.4.2.10 | Represents the authorization code response information. | RNAA | +| AuthorizationFlow | Clause 8.5.4.3.4 | Represents the authorization flows to support RNAA | RNAA | + +Editor's Note: Details on AuthorizationCodeRsp are FFS. + +Table 8.5.4.1-2 specifies data types re-used by the CAPIF\_Security\_API service based interface: + +**Table 8.5.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------------------------------------------------|----------------------| +| DurationSec | 3GPP TS 29.122 [14] | Indicates the duration in seconds. | | +| SecurityMethod | Clause 8.2.4.3.6 | Indicates the security method (e.g. PKI). | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.5.6-1. | | + +## 8.5.4.2 Structured data types + +### 8.5.4.2.1 Introduction + +### 8.5.4.2.2 Type: ServiceSecurity + +**Table 8.5.4.2.2-1: Definition of type ServiceSecurity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| securityInfo | array(SecurityInformation) | M | 1..N | Security information for each API interface. | | +| notificationDestination | Uri | M | 1 | URI where the notification should be delivered to. | | +| requestTestNotification | boolean | O | 0..1 | Set to "true" by API invoker to request the CAPIF core function to send a test notification as defined in clause 7.6. Set to "false" not to request the CAPIF core function to send a test notification. Default value is "false" if omitted. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6. | Notification_websocket | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8. This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +### 8.5.4.2.3 Type: SecurityInformation + +**Table 8.5.4.2.3-1: Definition of type SecurityInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| interfaceDetails | InterfaceDescription | O | 0..1 | Details of the interface (NOTE) | | +| aefId | string | O | 0..1 | AEF identifier (NOTE) | | +| apiId | string | C | 0..1 | API identifier. If API invoker supplies this IE in the PUT request, CCF shall respond back with this IE and its associated security information. | SecurityInfoPerAPI | +| prefSecurityMethods | array(SecurityMethod) | M | 1..N | Security methods preferred by the API invoker for the API interface | | +| selSecurityMethod | SecurityMethod | O | 0..1 | Supplied by the CAPIF core function, it indicates the selected security method for the API interface. If it is not provided, it means no common supported security method by the API invoker and the AEF, or the selected security method is not allowed by the local policy in the CAPIF core function. | | +| authenticationInfo | string | O | 0..1 | Authentication related information | | +| authorizationInfo | string | O | 0..1 | Authorization related information | | +| authorizationFlow | array(AuthorizationFlow) | O | 1..N | The authorization flows to support RNAA as defined in clause 6.5.3 of TS 33.122 [16]. | RNAA | + +NOTE: Only one of the attributes "aefId" or "interfaceDetails" shall be included. + +8.5.4.2.4 Void + +8.5.4.2.5 Type: SecurityNotification + +**Table 8.5.4.2.5-1: Definition of type SecurityNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| apiInvokerId | string | M | 1 | String identifying the API invoker assigned by the CAPIF core function | | +| aefId | string | O | 0..1 | String identifying the AEF. | | +| apiIds | array(string) | M | 1..N | Identifier of the service API | | +| cause | Cause | M | 1 | The cause for revoking the API invoker authorization to the service API | | + +## 8.5.4.2.6 Type: AccessTokenReq + +Table 8.5.4.2.6-1: Definition of type AccessTokenReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| grant_type | string | M | 1 | This IE shall contain the grant type as "client_credentials", or when the "RNAA" feature is supported, either "client_credentials" or "authorization_code".
(NOTE 3, NOTE 4) | | +| client_id | string | M | 1 | This IE shall contain the API invoker Identifier.
(NOTE 3) | | +| resOwnerId | string | O | 0..1 | This attribute shall contain the resource owner ID. | RNAA | +| client_secret | string | O | 0..1 | This IE when present shall contain the onboarding secret which is got during API invoker onboarding.
(NOTE 3) | | +| scope | string | O | 0..1 | This IE when present shall contain a list of AEF identifiers and its associated API names for which the access_token is authorized for use.

It takes the format of
3gpp#aefld1:apiName1,apiName2,...
apiNameX;aefld2:apiName1,apiName2,...
apiNameY;...aefldN:apiName1,apiName2,...
apiNameZ

Using delimiter "#" after the discriminator "3gpp", ":" after AEF identifier, "," between API names and ";" between the last API name of the previous AEF identifier and the next AEF identifier.
(NOTE 2)

Example: '3gpp#aef-jiangsu-nanjing:3gpp-monitoring-event,3gpp-as-session-with-qos;aef-zhejiang-hangzhou:3gpp-cp-parameter-provisioning,3gpp-pfd-management' | | +| authCode | string | O | 0..1 | This attribute shall be included If the authorization code flow is selected in RNAA scenarios. This attribute, when present, shall contain authorization code. | RNAA | +| NOTE 1: This data structure shall not be treated as a JSON object. It shall be treated as a key, value pair data structure to be encoded using x-www-urlencoded format as specified in clause 17.13.4.1 of W3C HTML 4.01 Specification [22]. | | | | | | +| NOTE 2: The scope may contain more space-delimited strings which further add additional access ranges to the scope, the definition of those additional strings is out of the scope of the present document. | | | | | | +| NOTE 3: The "grant_type", "client_id" and "client_secret" attributes do not follow the related naming convention defined in subclause 7.2.1. These attributes are however kept as currently defined in this specification for backward compatibility considerations. | | | | | | +| NOTE 4: The enumeration value "client_credentials" of the "grant_type" attribute does not follow the related naming convention defined in subclause 7.2.1. This enumeration is however kept as currently defined in this specification for backward compatibility considerations. | | | | | | + +## 8.5.4.2.7 Type: AccessTokenRsp + +Table 8.5.4.2.7-1: Definition of type AccessTokenRsp + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| access_token | string | M | 1 | This IE shall contain JWS Compact Serialized representation of the JWS signed JSON object containing AccessTokenClaims (see clause 8.5.4.2.8).

(NOTE 2) | +| token_type | string | M | 1 | This IE shall contain the token type (i.e. "Bearer").

(NOTE 2, NOTE 3) | +| expires_in | DurationSec | M | 1 | This IE when present shall contain the number of seconds after which the access_token is considered to be expired.

(NOTE 2) | +| scope | string | O | 0..1 | This IE when present shall contain a list of AEF identifiers and its associated API names for which the access_token is authorized for use.

It takes the format of
3gpp#aefld1:apiName1,apiName2,...
apiNameX:aefld2:apiName1,apiName2,...
apiNameY:...aefldN:apiName1,apiName2,...
apiNameZ

Using delimiter "#" after the discriminator "3gpp", ":" after AEF identifier, "," between API names and ";" between the last API name of the previous AEF identifier and the next AEF identifier. (NOTE 1)

Example: '3gpp#aef-jiangsu-nanjing:3gpp-monitoring-event,3gpp-as-session-with-qos;aef-zhejiang-hangzhou:3gpp-cp-parameter-provisioning,3gpp-pfd-management' | + +NOTE 1: The scope may contain more space-delimited strings which further add additional access ranges to the scope, the definition of those additional strings is out of the scope of the present document. + +NOTE 2: The "access\_token", "token\_type" and "expires\_in" attributes do not follow the related naming convention defined in clause 7.2.1. These attributes are however kept as currently defined in this specification for backward compatibility considerations. + +NOTE 3: The enumeration value "Bearer" of the "token\_type" attribute does not follow the related naming convention defined in clause 7.2.1. This enumeration is however kept as currently defined in this specification for backward compatibility considerations. + +## 8.5.4.2.8 Type: AccessTokenClaims + +Table 8.5.4.2.8-1: Definition of type AccessTokenClaims + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| iss | string | M | 1 | This IE shall contain the API invoker Identifier. | | +| scope | string | M | 1 | This IE shall contain a list of AEF identifiers and its associated API names for which the access_token is authorized for use.

It takes the format of
3gpp#aefId1:apiName1,apiName2,...
apiNameX;aefId2:apiName1,apiName2,...
apiNameY;...aefIdN:apiName1,apiName2,...
apiNameZ

Using delimiter "#" after the discriminator "3gpp", ":" after AEF identifier, "," between API names and ";" between the last API name of the previous AEF identifier and the next AEF identifier. (NOTE)

Example: '3gpp#aef-jiangsu-nanjing:3gpp-monitoring-event,3gpp-as-session-with-qos;aef-zhejiang-hangzhou:3gpp-cp-parameter-provisioning,3gpp-pfd-management' | | +| exp | DurationSec | M | 1 | This IE shall contain the number of seconds after which the access_token is considered to be expired. | | +| resOwnerId | string | O | 0..1 | This attribute shall contain the resource owner ID. | RNAA | +| NOTE: The scope may contain more space-delimited strings which further add additional access ranges to the scope, the definition of those additional strings is out of the scope of the present document. | | | | | | + +## 8.5.4.2.9 Type: AccessTokenErr + +Table 8.5.4.2.9-1: Definition of type AccessTokenErr + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| error | string | M | 1 | This IE shall contain the error described in IETF RFC 6749 [23], clause 5.2.
Enum:
"invalid_request"
"invalid_client"
"invalid_grant"
"unauthorized_client"
"unsupported_grant_type"
"invalid_scope"

(NOTE 1) | +| error_description | string | O | 0..1 | When present, this IE shall contain the human-readable additional information to indicate the error that occurred, as described in IETF RFC 6749 [23], clause 5.2.

(NOTE 2) | +| error_uri | string | O | 0..1 | When present, this IE shall contain the URI identifying a human-readable additional information about the error, as described in IETF RFC 6749 [23], clause 5.2.

(NOTE 2) | + +NOTE 1: The enumeration values "invalid\_request", "invalid\_client", "invalid\_grant", "unauthorized\_client", "unsupported\_grant\_type" and "invalid\_scope" of the "error" attribute do not follow the related naming convention defined in clause 7.2.1. These enumeration values are however kept as currently defined in this specification for alignment with definitions in IETF RFC 6749 [23] and backward compatibility considerations. + +NOTE 2: The "error\_description" and "error\_uri" attributes do not follow the related naming convention defined in clause 7.2.1. These attributes are however kept as currently defined in this specification for alignment with definitions in IETF RFC 6749 [23] and backward compatibility considerations. + +## 8.5.4.2.10 Type: AuthorizationCodeRsp + +Table 8.5.4.2.10-1: Definition of type AuthorizationCodeRsp + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------| +| authCode | string | M | 1 | This IE shall contain authorization code. | + +## 8.5.4.3 Simple data types and enumerations + +## 8.5.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 8.5.4.3.2 Simple data types + +The simple data types defined in table 8.5.4.3.2-1 shall be supported. + +Table 8.5.4.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +### 8.5.4.3.3 Enumeration: Cause + +**Table 8.5.4.3.3-1: Enumeration Cause** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------|---------------| +| OVERLIMIT_USAGE | The revocation of the authorization of the API invoker is due to the overlimit usage of the service API | | +| UNEXPECTED_REASON | The revocation of the authorization of the API invoker is due to unexpected reason. | | + +### 8.5.4.3.4 Enumeration: AuthorizationFlow + +**Table 8.5.4.3.4-1: Enumeration AuthorizationFlow** + +| Enumeration value | Description | Applicability | +|-----------------------------------|------------------------------------------------------------------------------|---------------| +| CLIENT_CREDENTIALS_FLOW | Client credentials flow as described in clause 6.5.2 of TS 33.122 [16]. | | +| AUTHORIZATION_CODE_FLOW | Authorization code flow defined in clause 6.5.3 of TS 33.122 [16]. | | +| AUTHORIZATION_CODE_FLOW_WITH_PKCE | Authorization code flow with PKCE defined in clause 6.5.3 of TS 33.122 [16]. | | + +**Editor's Note:** The AuthorizationFlow enumeration is FFS. + +## 8.5.5 Error Handling + +### 8.5.5.1 General + +General error responses are defined in clause 7.7. + +In addition, the requirements in the following subclauses shall apply. + +### 8.5.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Security\_API. + +### 8.5.5.3 Application Errors + +The application errors defined for the Obtain\_Authorization service operation are listed in Table 8.5.5.3-1, and correspond to the values of the "error" attribute (see clause 8.5.4.2.9). + +**Table 8.5.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------------------------| +| invalid_request | 400 Bad Request | See IETF RFC 6749 [23] | +| invalid_client | 400 Bad Request,
401 Unauthorized | See IETF RFC 6749 [23] | +| invalid_grant | 400 Bad Request | See IETF RFC 6749 [23] | +| unauthorized_client | 400 Bad Request | See IETF RFC 6749 [23] | +| unsupported_grant_type | 400 Bad Request | See IETF RFC 6749 [23] | +| invalid_scope | 400 Bad Request | See IETF RFC 6749 [23] | +| NOTE: These enumeration values defined in this table do not follow the related naming convention defined in clause 7.2.1. These enumeration values are however kept as currently defined in this specification for alignment with definitions in IETF RFC 6749 [23]. | | | + +## 8.5.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.5.6-1 lists the supported features for CAPIF\_Security\_API. + +**Table 8.5.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 7.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | SecurityInfoPerAPI | Indicates the support of negotiating and obtaining service API security method information per API. | +| 4 | RNAA | Indicates the support of resource owner awareness authorization. | + +## 8.6 CAPIF\_Access\_Control\_Policy\_API + +### 8.6.1 API URI + +The CAPIF\_Access\_Control\_Policy\_API service shall use the CAPIF\_Access\_Control\_Policy\_API. + +The request URIs used in HTTP requests from the API exposing function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "access-control-policy". +- The shall be "v1". +- The shall be set as described in clause 8.6.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.6.2 Resources + +#### 8.6.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.6.2.1-1 depicts the resource URIs structure for the CAPIF\_Access\_Control\_Policy\_API. + +This resource is created by the CAPIF administrator on the CAPIF core function. + +NOTE: The details of the mechanisms used to create the Access Control Policy List resource on the CAPIF core function is out of the scope of the present document. + +![Figure 8.6.2.1-1: Resource URI structure of the CAPIF Access Control Policy API. The diagram shows a hierarchical URI structure. The root is {apiRoot}/access-control-policy/. A line descends from this root to a segment /accessControlPolicyList. From /accessControlPolicyList, another line descends to a segment /{serviceApiId}, which is enclosed in a rounded rectangular box.](9cd6ff4a43174e4afe1cc5e4ea2fcae4_img.jpg) + +``` + +graph TD + Root["{apiRoot}/access-control-policy/"] --> List["/accessControlPolicyList"] + List --> ServiceId["/{serviceApiId}"] + style ServiceId stroke-width:2px,rx:10,ry:10 + +``` + +Figure 8.6.2.1-1: Resource URI structure of the CAPIF Access Control Policy API. The diagram shows a hierarchical URI structure. The root is {apiRoot}/access-control-policy/. A line descends from this root to a segment /accessControlPolicyList. From /accessControlPolicyList, another line descends to a segment /{serviceApiId}, which is enclosed in a rounded rectangular box. + +**Figure 8.6.2.1-1: Resource URI structure of the CAPIF Access Control Policy API** + +Table 8.6.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.6.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------|-----------------------------------------------------------------------| +| Access Control Policy List | /accessControlPolicyList/{serviceApiId}
(NOTE) | GET | Retrieves the access control policy list for a published service API. | +| NOTE: The path segment "accessControlPolicyList" does not follow the related naming convention defined in clause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. | | | | + +## 8.6.2.2 Resource: Access Control Policy List + +### 8.6.2.2.1 Description + +The Access Control Policy List resource represents the access control information for all the service APIs per API invoker. + +### 8.6.2.2.2 Resource Definition + +Resource URI: {apiRoot}/access-control-policy//accessControlPolicyList/{serviceApiId} + +This resource shall support the resource URI variables defined in table 8.6.2.2.2-1. + +**Table 8.6.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|--------------|-----------|------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| serviceApiId | string | Identifies an individual published service API | + +### 8.6.2.2.3 Resource Standard Methods + +#### 8.6.2.2.3.1 GET + +This method shall support the URI query parameters specified in table 8.6.2.2.3.1-1. + +**Table 8.6.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------------------------------------| +| aef-id | string | M | 1 | AEF identifier | +| api-invoker-id | string | O | 1 | String identifying the API invoker | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +This method shall support the request data structures specified in table 8.6.2.2.3.1-2 and the response data structures and response codes specified in table 8.6.2.2.3.1-3. + +**Table 8.6.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.6.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessControlPolicyList | M | 1 | 200 OK | List of the access control policy applicable for the service API requested. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.6.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.6.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +### 8.6.2.2.4 Resource Custom Operations + +There are no notifications defined for this API in this release of the specification. + +## 8.6.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.6.3 Notifications + +None. + +## 8.6.4 Data Model + +### 8.6.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.6.4.1-1 specifies the data types defined specifically for the CAPIF\_Access\_Control\_Policy\_API service. + +**Table 8.6.4.1-1: CAPIF\_Access\_Control\_Policy\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------|------------------|-------------------------------------------------------------------------------------------------------|---------------| +| AccessControlPolicyList | Clause 8.6.4.2.2 | Represents the access control policy list for a published service API. | | +| ApiInvokerPolicy | Clause 8.6.4.2.3 | Represents the policy of an API Invoker. | | +| TimeRangeList | Clause 8.6.4.2.4 | Represents the time range during which the invocation of a service API is allowed by the API invoker. | | + +Table 8.6.4.1-2 specifies data types re-used by the CAPIF\_Access\_Control\_Policy\_API service. + +**Table 8.6.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.122 [14] | Used to indicate start and end times. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.6.6-1. | | + +### 8.6.4.2 Structured data types + +#### 8.6.4.2.1 Introduction + +This clause defines data structures to be used in resource representations. + +#### 8.6.4.2.2 Type: AccessControlPolicyList + +**Table 8.6.4.2.2-1: Definition of type AccessControlPolicyList** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------|---|-------------|-----------------------------|---------------| +| apiInvokerPolicies | array(ApiInvokerPolicy) | O | 0..N | Policy of each API invoker. | | + +### 8.6.4.2.3 Type: ApiInvokerPolicy + +**Table 8.6.4.2.3-1: Definition of type ApiInvokerPolicy** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| apiInvokerId | string | M | 1 | API invoker ID assigned by the CAPIF core function | | +| allowedTotalInvocations | integer | O | 0..1 | Total number of invocations allowed on the service API by the API invoker. | | +| allowedInvocationsPerSecond | integer | O | 0..1 | Invocations per second allowed on the service API by the API invoker. | | +| allowedInvocationsTimeRangeList | array(TimeRangeList) | O | 0..N | The time ranges during which the invocations are allowed on the service API by the API invoker. | | + +### 8.6.4.2.4 Type: TimeRangeList + +**Table 8.6.4.2.4-1: Definition of type TimeRangeList** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | The start time for the invocations to be allowed on the service API by the API invoker. | | +| stopTime | DateTime | M | 1 | The end time for the invocations to be allowed on the service API by the API invoker. | | + +## 8.6.4.3 Simple data types and enumerations + +None. + +## 8.6.5 Error Handling + +### 8.6.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.6.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Access\_Control\_Policy\_API. + +### 8.6.5.3 Application Errors + +The application errors defined for the CAPIF\_Access\_Control\_Policy\_API are listed in table 8.6.5.3-1. + +**Table 8.6.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.6.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 8.6.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +## 8.7 CAPIF\_Logging\_API\_Invocation\_API + +### 8.7.1 API URI + +The CAPIF\_Logging\_API\_Invocation\_API service shall use the CAPIF\_Logging\_API\_Invocation\_API. + +The request URIs used in HTTP requests from the API exposing function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "api-invocation-logs". +- The shall be "v1". +- The shall be set as described in clause 8.7.2 + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.7.2 Resources + +#### 8.7.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.7.2.1-1 depicts the resource URIs structure for the CAPIF\_Logging\_API\_Invocation\_API. + +![Diagram showing the resource URI structure for the CAPIF_Logging_API_Invocation_API. The root URI is {apiRoot}/api-invocation-logs/. It branches into /{aeFId}, which then branches into /logs (shown in a box), which finally branches into /{logId} (shown in a box).](9a7872f64558de06ee8b85b87e920b7e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/api-invocation-logs/"] --> aeFId["/{aeFId}"] + aeFId --> logs["/logs"] + logs --> logId["/{logId}"] + style logs stroke-width:2px + style logId stroke-width:2px + +``` + +Diagram showing the resource URI structure for the CAPIF\_Logging\_API\_Invocation\_API. The root URI is {apiRoot}/api-invocation-logs/. It branches into /{aeFId}, which then branches into /logs (shown in a box), which finally branches into /{logId} (shown in a box). + +**Figure 8.7.2.1-1: Resource URI structure of the CAPIF\_Logging\_API\_Invocation\_API** + +Table 8.7.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.7.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------|------------------------|---------------------------------|-----------------------------------------------------| +| Logs | /{aeflId}/logs | POST | Creates a new log entry for service API invocations | +| Individual log | /{aeflId}/logs/{logId} | n/a | Individual log entry | + +## 8.7.2.2 Resource: Logs + +### 8.7.2.2.1 Description + +The Logs resource represents all the log entries created by a API exposing function at CAPIF core function. + +### 8.7.2.2.2 Resource Definition + +Resource URI: {apiRoot}/api-invocation-logs//{aeflId}/logs + +This resource shall support the resource URI variables defined in table 8.7.2.2.2-1. + +**Table 8.7.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 7.5 | +| aeflId | string | Identifies of the API exposing function | + +### 8.7.2.2.3 Resource Standard Methods + +#### 8.7.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.7.2.2.3.1-1. + +**Table 8.7.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.7.2.2.3.1-2 and the response data structures and response codes specified in table 8.7.2.2.3.1-3. + +**Table 8.7.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| InvocationLog | M | 1 | Log of service API invocations provided by API exposing function to store on the CAPIF core function. | + +**Table 8.7.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| InvocationLog | M | 1 | 201
Created | Log of service API invocations provided by API exposing function successfully stored on the CAPIF core function.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.7.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/api-invocation-logs///logs/ | + +#### 8.7.2.2.4 Resource Custom Operations + +None. + +### 8.7.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 8.7.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 8.7.4 Data Model + +#### 8.7.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.7.4.1-1 specifies the data types defined specifically for the CAPIF\_Logging\_API\_Invocation\_API service. + +**Table 8.7.4.1-1: CAPIF\_Logging\_API\_Invocation\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------|------------------|----------------------------------------------------------------------------------------|---------------| +| DurationMs | Clause 8.7.4.3.2 | Represents the period of time in units of milliseconds. | | +| InvocationLog | Clause 8.7.4.2.2 | Represents the set of Service API invocation logs to be stored on CAPIF core function. | | +| Log | Clause 8.7.4.2.3 | Represents the individual service API invocation log entry. | | + +Table 8.7.4.1-2 specifies data types re-used by the CAPIF\_Logging\_API\_Invocation\_API service. + +**Table 8.7.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.122 [14] | Used to indicate the invocation time. | | +| Operation | Clause 8.2.4.3.7 | Used to indicate the HTTP operation | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.7.6-1. | | + +## 8.7.4.2 Structured data types + +### 8.7.4.2.1 Introduction + +This clause defines the structured data types to be used in resource representations of the CAPIF\_Logging\_API\_Invocation\_API. + +### 8.7.4.2.2 Type: InvocationLog + +**Table 8.7.4.2.2-1: Definition of type InvocationLog** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| aefId | string | M | 1 | Identity information of the API exposing function requesting logging of service API invocations | | +| apiInvokerId | string | M | 1 | Identity of the API invoker which invoked the service API | | +| logs | array(Log) | M | 1..N | Service API invocation log | | +| supportedFeatures | Supported Features | O | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +### 8.7.4.2.3 Type: Log + +**Table 8.7.4.2.3-1: Definition of type Log** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiId | string | M | 1 | String identifying the API invoked. | | +| apiName | string | M | 1 | Name of the API which was invoked, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| apiVersion | string | M | 1 | Version of the API which was invoked | | +| resourceName | String | M | 1 | Name of the specific resource invoked | | +| uri | Uri | O | 0..1 | Full URI of the API resource as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | | +| protocol | Protocol | M | 1 | Protocol invoked. | | +| operation | Operation | C | 0..1 | Operation that was invoked on the API, only applicable for HTTP protocol. | | +| result | string | M | 1 | For HTTP protocol, it contains HTTP status code of the invocation | | +| invocationTime | DateTime | O | 0..1 | Date on which it was invoked | | +| invocationLatency | DurationMs | O | 0..1 | Latency for the API invocation. | | +| inputParameters | ANY TYPE (NOTE) | O | 0..1 | List of input parameters | | +| OutputParameters | ANY TYPE (NOTE) | O | 0..1 | List of output parameters | | +| srcInterface | InterfaceDescription | O | 0..1 | Interface description of the API invoker. | | +| destInterface | InterfaceDescription | O | 0..1 | Interface description of the API invoked. | | +| fwdInterface | string | O | 0..1 | It includes the node identifier (as defined in IETF RFC 7239 [20] of all forwarding entities between the API invoker and the AEF, concatenated with comma and space, e.g. 192.0.2.43:80, unknown:_OBFport, 203.0.113.60 | | + +NOTE: Any basic data type defined in OpenAPI Specification [3] may be used. + +### 8.7.4.3 Simple data types and enumerations + +#### 8.7.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 8.7.4.3.2 Simple data types + +The simple data types defined in table 8.7.4.3.2-1 shall be supported. + +**Table 8.7.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------|-----------------|-------------------------------------------------------------------------|---------------| +| DurationMs | integer | Unsigned integer identifying a period of time in units of milliseconds. | | + +## 8.7.5 Error Handling + +### 8.7.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.7.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Logging\_API\_Invocation\_API. + +### 8.7.5.3 Application Errors + +The application errors defined for the CAPIF\_Logging\_API\_Invocation\_API are listed in table 8.7.5.3-1. + +**Table 8.7.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.7.6 Feature negotiation + +**Table 8.7.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +## 8.8 CAPIF\_Auditing\_API + +### 8.8.1 API URI + +The CAPIF\_Auditing\_API service shall use the CAPIF\_Auditing\_API. + +The request URIs used in HTTP requests from the API management function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "logs". +- The shall be "v1". +- The shall be set as described in clause 8.8.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +## 8.8.2 Resources + +### 8.8.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.8.2.1-1 depicts the resource URIs structure for the CAPIF\_Auditing\_API. + +![Diagram showing the resource URI structure for the CAPIF_Auditing_API. The base URI is {apiRoot}/logs/. A callout box points to the path segment /apiInvocationLogs, indicating it is a sub-resource under the logs directory.](471c91d9988fb84924ddb6b71bb16fa1_img.jpg) + +``` + + {apiRoot}/logs/ + | + +-- /apiInvocationLogs + +``` + +Diagram showing the resource URI structure for the CAPIF\_Auditing\_API. The base URI is {apiRoot}/logs/. A callout box points to the path segment /apiInvocationLogs, indicating it is a sub-resource under the logs directory. + +**Figure 8.8.2.1-1: Resource URI structure of the CAPIF\_Auditing\_API** + +Table 8.8.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.8.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------| +| All service API invocation logs (Store) | /apiInvocationLogs
(NOTE) | GET | Query and retrieve service API invocation logs stored on the CAPIF core function | +| NOTE: The path segment "apiInvocationLogs" does not follow the related naming convention defined in clause 7.5.1. The path segment is however kept as currently defined in this specification for backward compatibility considerations. | | | | + +### 8.8.2.2 Resource: All service API invocation logs + +#### 8.8.2.2.1 Description + +The All service API invocation logs resource represents a collection of service API invocation logs stored on the CAPIF core function. The resource is modelled as a Store resource archetype (see annex C.3 of 3GPP TS 29.501 [18]) + +#### 8.8.2.2.2 Resource Definition + +Resource URI: {apiRoot}/logs//apiInvocationLogs + +This resource shall support the resource URI variables defined in table 8.8.2.2-1. + +**Table 8.8.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.8.2.2.3 Resource Standard Methods + +#### 8.8.2.2.3.1 GET + +This method shall support the URI query parameters specified in table 8.8.2.2.3.1-1. + +**Table 8.8.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| aef-id | string | O | 0..1 | String identifying the API exposing function | +| api-invoker-id | string | O | 0..1 | String identifying the API invoker which invoked the service API | +| time-range-start | DateTime | O | 0..1 | Start time of the invocation time range | +| time-range-end | DateTime | O | 0..1 | End time of the invocation time range | +| api-id | string | O | 0..1 | String identifying the API invoked. | +| api-name | string | O | 0..1 | API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122 [14]. | +| api-version | string | O | 0..1 | Version of the API which was invoked | +| protocol | Protocol | O | 0..1 | Protocol invoked | +| operation | Operation | O | 0..1 | Operation that was invoked on the API | +| result | string | O | 0..1 | HTTP status code of the invocation | +| resource-name | string | O | 0..1 | Name of the specific resource invoked | +| src-interface | InterfaceDescription | O | 0..1 | Interface description of the API invoker. | +| dest-interface | InterfaceDescription | O | 0..1 | Interface description of the API invoked. | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +This method shall support the request data structures specified in table 8.8.2.2.3.1-2 and the response data structures and response codes specified in table 8.8.2.2.3.1-3. + +**Table 8.8.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.8.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| InvocationLogsRetrieveRes | O | 0..1 | 200 OK | Result of the query operation along with fetched service API invocation log data. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| ProblemDetails | O | 0..1 | 414 URI Too Long | Indicates that the server is refusing to service the request because the request-target is too long. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.8.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.8.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.8.2.2.4 Resource Custom Operations + +None. + +### 8.8.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +## 8.8.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 8.8.4 Data Model + +### 8.8.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.8.4.1-1 specifies the data types defined specifically for the CAPIF\_Auditing\_API service. + +**Table 8.8.4.1-1: CAPIF\_Auditing\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------------|-----------------|--------------------------------------------------------------|------------------| +| InvocationLogs | 8.8.4.2.2 | Contains multiple invocation logs. | EnQueryInvokeLog | +| InvocationLogsRetrieveResults | 8.8.4.2.3 | Contains the result of an invocation logs retrieval request. | | + +Table 8.8.4.1-2 specifies data types re-used by the CAPIF\_Auditing\_API service: + +**Table 8.8.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.122 [14] | Used to indicate the start and end times. | | +| InvocationLog | Clause 8.7.4.2.2 | Used to represent logs of service API invocations stored on the CAPIF core function. | | +| Operation | Clause 8.2.4.3.7 | Used to indicate the HTTP operation. | | +| ProblemDetails | 3GPP TS 29.122 [14] | Used to represent the problem details in an error message. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.8.6-1. | | + +## 8.8.4.2 Structured data types + +### 8.8.4.2.1 Introduction + +This clause defines the structured data types to be used in resource representations of the CAPIF\_Auditing\_API. + +### 8.8.4.2.2 Type: InvocationLogs + +**Table 8.8.4.2.2-1: Definition of type InvocationLogs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| multipleInvocationLogs | array(InvocationLog) | M | 1..N | Contains a multiple API invocation logs.

The "supportedFeatures" attribute within the InvocationLog data type shall not be provided. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 8.8.6.
This parameter shall be included in HTTP GET response, if the consumer includes "supported-features" in the GET request. | | + +## 8.8.4.3 Simple data types and enumerations + +None. + +## 8.8.4.4 Data types describing alternative data types or combinations of data types + +### 8.8.4.4.1 Type: InvocationLogsRetrieveRes + +**Table 8.8.4.4.1-1: Definition of type InvocationLogsRetrieveRes as a list of mutually exclusive alternatives** + +| Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------------------------------------------------------------|------------------| +| InvocationLog | C | 0..1 | Contains a single API invocation log.

(NOTE) | | +| InvocationLogs | C | 0..1 | Contains multiple (more than one) API invocation logs.

(NOTE) | EnQueryInvokeLog | +| NOTE: The InvocationLogs attribute shall be provided if the EnQueryInvokeLog feature is supported and requested by the API invoker, otherwise only the InvocationLog data type shall be provided. | | | | | + +## 8.8.5 Error Handling + +### 8.8.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.8.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Auditing\_API. + +### 8.8.5.3 Application Errors + +The application errors defined for the CAPIF\_Auditing\_API are listed in table 8.8.5.3-1. + +**Table 8.8.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.8.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 8.8.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|------------------|------------------------------------------------------------------------------| +| 1 | EnQueryInvokeLog | This feature indicates support for the enhancements of query invocation log. | + +## 8.9 CAPIF\_API\_Provider\_Management\_API + +### 8.9.1 API URI + +The CAPIF\_API\_Provider\_Management\_API service shall use the CAPIF\_API\_Provider\_Management\_API. + +The request URIs used in HTTP requests from the API management function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "api-provider-management". +- The shall be "v1". +- The shall be set as described in clause 8.9.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.9.2 Resources + +#### 8.9.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.9.2.1-1 depicts the resource URIs structure for the CAPIF\_API\_Provider\_Management\_API. + +![Diagram showing the resource URI structure. A root URI '{apiRoot}/api-provider-management/' branches to a box containing '/registrations'. This box further branches to another box containing '/{registrationId}'.](8faeb7db381e28ab1ba06e9f48c19c6e_img.jpg) + +{apiRoot}/api-provider-management/ + +``` + +graph TD + Root["{apiRoot}/api-provider-management/"] --> Regs["/registrations"] + Regs --> RegId["/{registrationId}"] + +``` + +Diagram showing the resource URI structure. A root URI '{apiRoot}/api-provider-management/' branches to a box containing '/registrations'. This box further branches to another box containing '/{registrationId}'. + +**Figure 8.9.2.1-1: Resource URI structure of the CAPIF\_API\_Provider\_Management\_API** + +Table 8.9.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.9.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------| +| All API Provider Domains Registrations | /registrations | POST | Registers a new API provider domain by creating an API provider domain with API provider domain functions profiles. | +| Individual API Provider Domain Registration | /registrations/{registrationId} | PUT | Updates an individual API provider domain identified by {registrationId} | +| | | PATCH | Modifies an individual API provider domain identified by {registrationId} | +| | | DELETE | Deregisters an API provider domain by deleting the API provider domain and functions, identified by {registrationId}. | + +## 8.9.2.2 Resource: All API Provider Domains Registrations + +### 8.9.2.2.1 Description + +The All API provider domains registrations resource represents all the API provider domains that are registered at a given CAPIF core function. + +### 8.9.2.2.2 Resource Definition + +Resource URI: {apiRoot}/api-provider-management//registrations + +This resource shall support the resource URI variables defined in table 8.9.2.2.2-1. + +**Table 8.9.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 7.5 | + +### 8.9.2.2.3 Resource Standard Methods + +#### 8.9.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 8.9.2.2.3.1-1. + +**Table 8.9.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.9.2.2.3.1-2 and the response data structures and response codes specified in table 8.9.2.2.3.1-3. + +**Table 8.9.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| APIProviderEnrolmentDetails | M | 1 | Enrolment details of the API provider domain including individual API provider domain function details. | + +**Table 8.9.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIProviderEnrolmentDetails | M | 1 | 201
Created | API provider domain registered successfully

The URI of the created resource shall be returned in the "Location" HTTP header.
The list of successfully registered individual API provider domain functions, registration specific failure information of failed API provider domain function registrations, are included in APIProviderEnrolmentDetails which is provided in the response body. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.9.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/api-provider-management//registrations/{registrationId} | + +### 8.9.2.2.4 Resource Custom Operations + +None. + +## 8.9.2.3 Resource: Individual API Provider Domain Registration + +### 8.9.2.3.1 Description + +The Individual API Provide Domain Registration resource represents an individual API provider domain that is registered at a given CAPIF core function. + +### 8.9.2.3.2 Resource Definition + +Resource URI: {apiRoot}/api-provider-management//registrations/{registrationId} + +This resource shall support the resource URI variables defined in table 8.9.2.3.2-1. + +**Table 8.9.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| registrationId | string | Identifies an individual registered API Provider domain resource | + +### 8.9.2.3.3 Resource Standard Methods + +#### 8.9.2.3.3.1 PUT + +The PUT method allows updating the registered API provider domain's detail. The properties "apiProviderDomainId", and "supportedFeatures" shall remain unchanged from previously provided values. This method shall support the URI query parameters specified in table 8.9.2.3.3.1-1. + +**Table 8.9.2.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in the table 8.9.2.3.3.1-2 and the response data structures and response codes specified in the table 8.9.2.3.3.1-3. + +**Table 8.9.2.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------| +| APIProviderEnrolmentDetails | M | 1 | Updated details of the API provider domain. | + +**Table 8.9.2.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIProviderEnrolmentDetails | M | 1 | 200 OK | API provider domain's information updated successfully.

Updated details of the API provider domain is part of the APIProviderEnrolmentDetails, which is provided in the response body. The list of successfully updated individual API provider domain functions, registration update specific failure information of failed API provider domain function registration updates, are included in APIProviderEnrolmentDetails which is provided in the response body. | +| n/a | | | 204 No Content | API provider domain's information updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.9.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.9.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.9.2.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 8.9.2.3.3.2-1. + +**Table 8.9.2.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the response codes specified in table 8.9.2.3.3.2-2 and the response data structures and response codes specified in table 8.9.2.3.3.2-3. + +**Table 8.9.2.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.9.2.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual registered API provider domain matching the registrationId is deleted. All the individual API provider domain functions of the API provider domain are deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.9.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.9.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.9.2.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 8.9.2.3.3.3-1. + +**Table 8.9.2.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 8.9.2.3.3.3-2 and the response data structures and response codes specified in table 8.9.2.3.3.3-3. + +**Table 8.9.2.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|----------------------------------------------| +| APIProviderEnrolmentDetailsPatch | M | 1 | Modified details of the API provider domain. | + +**Table 8.9.2.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| APIProviderEnrolmentDetails | M | 1 | 200 OK | API provider domain's information updated successfully.

Updated details of the API provider domain is part of the APIProviderEnrolmentDetails, which is provided in the response body. The list of successfully updated individual API provider domain functions, registration update specific failure information of failed API provider domain function registration updates, are included in APIProviderEnrolmentDetails which is provided in the response body. | +| n/a | | | 204 No Content | API provider domain's information modified successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| NOTE: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. | | | | | + +**Table 8.9.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.9.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +#### 8.9.2.3.4 Resource Custom Operations + +None. + +### 8.9.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 8.9.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 8.9.4 Data Model + +#### 8.9.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.9.4.1-1 specifies the data types defined specifically for the CAPIF\_API\_Provider\_Management\_API service. + +**Table 8.9.4.1-1: CAPIF\_API\_Provider\_Management\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------------|------------------|---------------------------------------------------------------------------------------|---------------| +| APIProviderEnrolmentDetails | Clause 8.9.4.2.2 | Represents the API provider domain's enrolment details. | | +| APIProviderEnrolmentDetailsPatch | Clause 8.9.4.2.5 | Represents the list of modifications for the API provider domain's enrolment details. | PatchUpdate | +| ApiProviderFuncRole | Clause 8.9.4.3.3 | Indicates the role (e.g. AEF, APF, etc.) of an API provider domain function. | | +| APIProviderFunctionDetails | Clause 8.9.4.2.3 | Represents the API provider domain function's details. | | +| RegistrationInformation | Clause 8.9.4.2.4 | Represents registration information of an individual API provider domain function. | | + +Table 8.9.4.1-2 specifies data types re-used by the CAPIF\_API\_Provider\_Management\_API service. + +**Table 8.9.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|------------------------------------------------------------------------------------|---------------| +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.9.6-1. | | + +## 8.9.4.2 Structured data types + +### 8.9.4.2.1 Introduction + +### 8.9.4.2.2 Type: APIProviderEnrolmentDetails + +**Table 8.9.4.2.2-1: Definition of type APIProviderEnrolmentDetails** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiProvDomId | string | O | 0..1 | API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses. | | +| regSec | string | M | 1 | Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP request from API management function to CAPIF core function for API provider domain registration. | | +| apiProvFuncs | array(API ProviderFunctionDetails) | O | 1..N | A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully. | | +| apiProvDomInfo | string | O | 0..1 | Generic information related to the API provider domain such as details of the API provider applications. | | +| suppFeat | Supported Features | C | 0..1 | Used to negotiate the supported optional features of the API as described in clause 7.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | +| failReason | string | C | 0..1 | Registration or update specific failure information of failed API provider domain function registrations.
Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails. | | + +## 8.9.4.2.3 Type: APIProviderFunctionDetails + +**Table 8.9.4.2.3-1: Definition of type APIProviderFunctionDetails** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiProvFuncId | string | C | 0..1 | API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses. | | +| regInfo | RegistrationInformation | M | 1 | Information necessary for the CAPIF core function to register the API provider domain function.

This information shall be present in HTTP POST/PUT request from API management function to CAPIF core function for API provider domain registration. In the HTTP response message from CAPIF core function, shall include the updated registration information for API provider domain function. | | +| apiProvFuncRole | ApiProviderFuncRole | M | 1 | Role of API provider domain function.

The role shall be present in the HTTP POST/PUT request that the API management function intends to register/update the API provider domain function as. CAPIF core function shall register the role of API provider domain function as per the request. | | +| apiProvFuncInfo | string | O | 0..1 | Generic information related to the API provider domain function such as details of the API provider applications. | | + +## 8.9.4.2.4 Type: RegistrationInformation + +**Table 8.9.4.2.4-1: Definition of type RegistrationInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------|---------------| +| apiProvPubKey | string | M | 1 | Public Key of API Provider domain function. | | +| apiProvCert | string | O | 0..1 | API provider domain function's generic client certificate | | + +#### 8.9.4.2.5 Type: APIProviderEnrolmentDetailsPatch + +**Table 8.9.4.2.5-1: Definition of type APIProviderEnrolmentDetailsPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| apiProvFuncs | array(API ProviderFunctionDetails) | O | 1..N | A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. | | +| apiProvDomInfo | string | O | 0..1 | Generic information related to the API provider domain such as details of the API provider applications. | | + +#### 8.9.4.3 Simple data types and enumerations + +##### 8.9.4.3.1 Introduction + +This clause defines simple data types and enumerations that will be referenced from data structures defined in the previous clauses. + +##### 8.9.4.3.2 Simple data types + +The simple data types defined in table 8.9.4.3.2-1 shall be supported. + +**Table 8.9.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +##### 8.9.4.3.3 Enumeration: ApiProviderFuncRole + +**Table 8.9.4.3.3-1: Enumeration ApiProviderFuncRole** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------|---------------| +| AEF | API provider function is API Exposing Function. | | +| APF | API provider function is API Publishing Function. | | +| AMF | API provider function is API Management Function. | | + +#### 8.9.5 Error Handling + +##### 8.9.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +##### 8.9.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_API\_Provider\_Management\_API. + +### 8.9.5.3 Application Errors + +The application errors defined for the CAPIF\_API\_Provider\_Management\_API are listed in table 8.9.5.3-1. + +**Table 8.9.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 8.9.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. Table 8.9.6-1 lists the supported features for CAPIF\_API\_Invoker\_Management\_API. + +**Table 8.9.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|------------------------------------------------------------------------------------------------------| +| 1 | PatchUpdate | Indicates the support of the PATCH method for updating an API Provider Domain Registration resource. | + +## 8.10 CAPIF\_Routing\_Info\_API + +### 8.10.1 API URI + +The CAPIF\_Routing\_Info\_API service shall use the CAPIF\_Routing\_Info\_API. + +The request URIs used in HTTP requests from the API exposing function towards the CAPIF core function shall have the Resource URI structure as defined in clause 7.5 with the following clarifications: + +- The shall be "capif-routing-info". +- The shall be "v1". +- The shall be set as described in clause 8.10.2. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +### 8.10.2 Resources + +#### 8.10.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 8.10.2.1-1 depicts the resource URIs structure for the CAPIF\_Routing\_Info\_API. + +![Figure 8.10.2.1-1: Resource URI structure of the CAPIF_Routing_Info_API. The diagram shows a hierarchical tree structure starting with {apiRoot}/capif-routing-info/. A vertical line descends from this root to a horizontal line that branches to /service-apis. From /service-apis, another vertical line descends to a horizontal line that branches to a rounded rectangle containing /{serviceApiId}.](b02ba0b73e95416eb547976f6145b169_img.jpg) + +``` + +graph TD + Root["{apiRoot}/capif-routing-info/"] --> SApis[/service-apis/] + SApis --> ServiceApiId[/{serviceApiId}] + +``` + +Figure 8.10.2.1-1: Resource URI structure of the CAPIF\_Routing\_Info\_API. The diagram shows a hierarchical tree structure starting with {apiRoot}/capif-routing-info/. A vertical line descends from this root to a horizontal line that branches to /service-apis. From /service-apis, another vertical line descends to a horizontal line that branches to a rounded rectangle containing /{serviceApiId}. + +**Figure 8.10.2.1-1: Resource URI structure of the CAPIF\_Routing\_Info\_API** + +Table 8.10.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 8.10.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------|------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Individual Service API routing info | /service-apis/{serviceApiId} | GET | Retrieves the API routing information for a published service API and API exposing function which applies the topology hiding. | + +## 8.10.2.2 Resource: Individual Service API routing info + +### 8.10.2.2.1 Description + +The API Routing Information resource represents the API routing information for the service API per API Exposing Function. + +### 8.10.2.2.2 Resource Definition + +Resource URI: {apiRoot}/capif-routing-info//service-apis/{serviceApiId} + +This resource shall support the resource URI variables defined in table 8.10.2.2.2-1. + +**Table 8.10.2.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|------------------------------------------------| +| apiRoot | string | See clause 7.5 | +| serviceApiId | string | Identifies an individual published service API | + +### 8.10.2.2.3 Resource Standard Methods + +#### 8.10.2.2.3.1 GET + +This method shall support the URI query parameters specified in table 8.10.2.2.3.1-1. + +**Table 8.10.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-----------------------------------------------------------------| +| aef-id | string | M | 1 | AEF identifier | +| supp-feat | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +This method shall support the request data structures specified in table 8.10.2.2.3.1-2 and the response data structures and response codes specified in table 8.10.2.2.3.1-3. + +**Table 8.10.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 8.10.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|-------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RoutingInfo | M | 1 | 200 OK | The Routing information applicable for the service API requested. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CAPIF core function. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 8.10.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +**Table 8.10.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CAPIF core function. | + +## 8.10.2.2.4 Resource Custom Operations + +None. + +## 8.10.2A Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 8.10.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +### 8.10.4 Data Model + +#### 8.10.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 also apply to this API. + +Table 8.10.4.1-1 specifies the data types defined specifically for the CAPIF\_Routing\_Info\_API service. + +**Table 8.10.4.1-1: CAPIF\_Routing\_Info\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------|-------------------|-------------------------------------|---------------| +| Ipv6AddressRange | Clause 8.10.4.2.4 | Represents IPv6 address range. | | +| RoutingInfo | Clause 8.10.4.2.2 | Represents API routing information. | | +| RoutingRule | Clause 8.10.4.2.3 | Represents API routing rule. | | + +Table 8.10.4.1-2 specifies data types re-used by the CAPIF\_Routing\_Info\_API service. + +**Table 8.10.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-------------------------------------------------------------------------------------|---------------| +| AefProfile | Clause 8.2.4.2.4 | Used to indicate the AEF profile. | | +| Ipv4AddressRange | 3GPP TS 29.510 [28] | Used to indicate the IPv4 address range. | | +| Ipv6Addr | 3GPP TS 29.122 [14] | Used to indicate the IPv6 address. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 8.10.6-1. | | + +#### 8.10.4.2 Structured data types + +##### 8.10.4.2.1 Introduction + +This clause defines data structures to be used in resource representations. + +##### 8.10.4.2.2 Type: RoutingInfo + +**Table 8.10.4.2.2-1: Definition of type RoutingInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------|---------------| +| routingRules | array(RoutingRule) | M | 1..N | Routing rules | | + +### 8.10.4.2.3 Type: RoutingRule + +**Table 8.10.4.2.3-1: Definition of type RoutingRule** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------|---------------| +| ipv4AddrRanges | array(Ipv4AddressRange) | O | 1..N | The IPv4 address range for the API invocation source IP address. (NOTE) | | +| ipv6AddrRanges | array(Ipv6AddressRange) | O | 1..N | The IPv6 address range for the API invocation source IP address. (NOTE) | | +| aefProfile | AefProfile | M | 1 | The target AEF profile | | + +NOTE: If no IP address range is provided, it means the service API invocation from any source IP address can be routed to the target AEF. + +### 8.10.4.2.4 Type: Ipv6AddressRange + +**Table 8.10.4.2.4-1: Definition of type Ipv6AddressRange** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------|---------------| +| start | Ipv6Addr | M | 1 | First value identifying the start of an IPv6 address range | | +| end | Ipv6Addr | M | 1 | Last value identifying the end of an IPv6 address range | | + +### 8.10.4.3 Simple data types and enumerations + +None. + +## 8.10.5 Error Handling + +### 8.10.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +### 8.10.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the CAPIF\_Routing\_Info\_API. + +### 8.10.5.3 Application Errors + +The application errors defined for the CAPIF\_Routing\_Info\_API are listed in table 8.10.5.3-1. + +**Table 8.10.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 8.10.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 8.10.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +## 9 AEF API Definition + +### 9.1 AEF\_Security\_API + +#### 9.1.1 API URI + +The AEF\_Security\_API service shall use the AEF\_Security\_API. + +The request URIs used in HTTP requests from the API invoker towards the API exposing function shall have the Resource URI structure defined in clause 7.5 with the following clarifications: + +- The shall be "aef-security". +- The shall be "v1". +- The shall be set as described in clause 9.1.2a. + +All the resource URIs and the custom operation URIs specified in the clauses below are defined relative to the above API URI. + +#### 9.1.2 Resources + +There is no resource defined for this API. + +#### 9.1.2A Custom Operations without associated resources + +##### 9.1.2A.1 Overview + +Custom operations used for this API are summarized in table 9.1.2A.1-1. "{apiRoot}" and "" are set as described in clause 7.5 and clause 9.1.1 respectively. + +**Table 9.1.2A.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|-----------------------|-----------------------|--------------------|----------------------------------------| +| check-authentication | /check-authentication | POST | Check authentication request. | +| revoke-authentication | /revoke-authorization | POST | Revoke authorization for service APIs. | + +##### 9.1.2A.2 Operation: check-authentication + +###### 9.1.2A.2.1 Description + +This custom operation allows the API invoker to confirm from the API exposing function, that necessary authentication data is available to authenticate the API invoker on API invocation. + +### 9.1.2A.2.2 Operation Definition + +This method shall support the URI query parameters specified in table 9.1.2A.2.2-1. + +**Table 9.1.2A.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This operation shall support the request and response data structures, and response codes specified in tables 9.1.2A.2.2-2 and 9.1.2A.2.2-3. + +**Table 9.1.2A.2.2-2: Data structures supported by the POST Request Body on this operation** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------| +| CheckAuthenticationReq | M | 1 | Authentication check request data | + +**Table 9.1.2A.2.2-3: Data structures supported by the POST Response Body on this operation** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CheckAuthenticationRsp | M | 1 | 200 OK | The request was successful. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during authentication confirmation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative API exposing function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during authentication confirmation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative API exposing function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 9.1.2A.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative API exposing function. | + +**Table 9.1.2A.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative API exposing function. | + +### 9.1.2A.3 Operation: revoke-authorization + +#### 9.1.2A.3.1 Description + +This custom operation allows the CAPIF core function to request the API exposing function to revoke the authorization of the API invoker for the indicated service APIs. + +### 9.1.2A.3.2 Operation Definition + +This method shall support the URI query parameters specified in table 9.1.2A.3.2-1. + +**Table 9.1.2A.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This operation shall support the request and response data structures, and response codes specified in tables 9.1.2A.3.2-2 and 9.1.2A.3.2-3. + +**Table 9.1.2A.3.2-2: Data structures supported by the POST Request Body on this operation** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|---------------------------------------| +| RevokeAuthorizationReq | M | 1 | Authorization revocation request data | + +**Table 9.1.2A.3.2-3: Data structures supported by the POST Response Body on this operation** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RevokeAuthorizationRsp | M | 1 | 200 OK | The request was successful. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during authorization revocation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative API exposing function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during authorization revocation. The response shall include a Location header field containing an alternative URI of the resource located in an alternative API exposing function.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [14]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [14] also apply. + +**Table 9.1.2A.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative API exposing function. | + +**Table 9.1.2A.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative API exposing function. | + +### 9.1.3 Notifications + +There are no notifications defined for this API in this release of the specification. + +## 9.1.4 Data Model + +### 9.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 7.2 apply to this API. + +Table 9.1.4.1-1 specifies the data types defined specifically for the AEF\_Security\_API service. + +**Table 9.1.4.1-1: AEF\_Security\_API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------|------------------|----------------------------------------------------|---------------| +| CheckAuthenticationReq | Clause 9.1.4.2.2 | Represents authentication check request data. | | +| CheckAuthenticationRsp | Clause 9.1.4.2.3 | Represents authentication check response data. | | +| RevokeAuthorizationReq | Clause 9.1.4.2.4 | Represents authorization revocation request data. | | +| RevokeAuthorizationRsp | Clause 9.1.4.2.5 | Represents authorization revocation response data. | | + +Table 9.1.4.1-2 specifies data types re-used by the AEF\_Security\_API service. + +**Table 9.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|------------------------------------------------------------------------------------|---------------| +| SecurityNotification | Clause 8.5.4.2.5 | Used to indicate information about the revoked APIs. | | +| SupportedFeatures | 3GPP TS 29.571 [19] | Used to negotiate the applicability of optional features defined in table 9.1.6-1. | | + +### 9.1.4.2 Structured data types + +#### 9.1.4.2.1 Introduction + +This clause defines the structures to be used in resource representations for the AEF\_Security\_API. + +#### 9.1.4.2.2 Type: CheckAuthenticationReq + +**Table 9.1.4.2.2-1: Definition of type CheckAuthenticationReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| apiInvokerId | string | M | 1 | API invoker ID assigned by the CAPIF core function to the API invoker while onboarding the API invoker. | | +| supportedFeatures | Supported Features | M | 1 | Used to negotiate the supported optional features of the API as described in clause 7.8. | | + +#### 9.1.4.2.3 Type: CheckAuthenticationRsp + +**Table 9.1.4.2.3-1: Definition of type CheckAuthenticationRsp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | Supported Features | M | 1 | Used to negotiate the supported optional features of the API as described in clause 7.8. | | + +#### 9.1.4.2.4 Type: RevokeAuthorizationReq + +**Table 9.1.4.2.4-1: Definition of type RevokeAuthorizationReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| revokeInfo | SecurityNotification | M | 1 | It contains detailed revocation information. | | +| supportedFeatures | Supported Features | M | 1 | Used to negotiate the supported optional features of the API as described in clause 7.8. | | + +#### 9.1.4.2.5 Type: RevokeAuthorizationRsp + +**Table 9.1.4.2.5-1: Definition of type RevokeAuthorizationRsp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| supportedFeatures | Supported Features | M | 1 | Used to negotiate the supported optional features of the API as described in clause 7.8. | | + +#### 9.1.4.3 Simple data types and enumerations + +None. + +### 9.1.5 Error Handling + +#### 9.1.5.1 General + +HTTP error handling shall be supported as specified in clause 7.7. + +In addition, the requirements in the following clauses shall apply. + +#### 9.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the AEF\_Security\_API. + +#### 9.1.5.3 Application Errors + +The application errors defined for the AEF\_Security\_API are listed in table 9.1.5.3-1. + +**Table 9.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 9.1.6 Feature negotiation + +General feature negotiation procedures are defined in clause 7.8. + +**Table 9.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +--- + +## 10 Security + +### 10.1 General + +Security methods for CAPIF are specified in 3GPP TS 33.122 [16]. + +### 10.2 CAPIF-1/1e security + +Secure communication between API invoker and CAPIF core function over CAPIF-1/1e reference points, using a TLS protocol based connection is defined in 3GPP TS 33.122 [16]. + +For Onboard\_API\_Invoker service operation of the CAPIF\_API\_Invoker\_Management\_API, the TLS protocol based connection shall be established using server certificate as defined in 3GPP TS 33.122 [16]. + +For rest of the CAPIF APIs, the TLS protocol based connection shall be established with certificate based mutual authentication as defined in 3GPP TS 33.122 [16]. + +### 10.3 CAPIF-2/2e security and securely invoking service APIs + +For secure communication between API invoker and API exposing function and ensuring secure invocations of service APIs, the API invoker: + +- shall negotiate the security method with the CAPIF core function using the Obtain\_Security\_Method service operation of the CAPIF\_Security\_API; +- shall initiate the authentication with the API exposing function using the Initiate\_Authentication service operation of the AEF\_Security\_API; and +- shall establish a secure connection with the API exposing function as defined in 3GPP TS 33.122 [16], using the method negotiated with the CAPIF core function. + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex is based on the OpenAPI Specification [3] and provides corresponding representations of all APIs defined in the present specification, in YAML format. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +- NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of 3GPP TR 21.900 [27] and clause 5.3.1 of 3GPP TS 29.501 [18] for further information). + +--- + +### A.2 CAPIF\_Discover\_Service\_API + +openapi: 3.0.0 + +``` +info: + title: CAPIF_Discover_Service_API + description: | + API for discovering service APIs. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.2" + +externalDocs: + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/service-apis/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222. + +paths: + /allServiceAPIs: + get: + description: > + Discover published service APIs and retrieve a collection of APIs according + to certain filter criteria. + parameters: + - name: api-invoker-id + in: query + description: > + String identifying the API invoker assigned by the CAPIF core function. + It also represents the CCF identifier in the CAPIF-6/6e interface. + required: true + schema: + type: string + - name: api-name + in: query + description: > + API name, it is set as {apiName} part of the URI structure as defined + in clause 5.2.4 of 3GPP TS 29.122. + schema: + type: string + - name: api-version + in: query + description: API major version the URI (e.g. v1). + schema: + type: string + - name: comm-type + in: query + description: Communication type used by the API (e.g. REQUEST_RESPONSE). + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/CommunicationType' + - name: protocol + in: query + description: Protocol used by the API. + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol' + - name: aef-id + in: query + description: AEF identifier. + schema: + type: string + - name: data-format + in: query + description: Data formats used by the API (e.g. serialization protocol JSON used). + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/DataFormat' + - name: api-cat + in: query + description: The service API category to which the service API belongs to. + schema: + type: string + - name: preferred-aef-loc + in: query + description: The preferred AEF location. + content: + application/json: + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/AefLocation' +``` + +``` + +- name: req-api-prov-name + in: query + description: Represents the required API provider name. + schema: + type: string +- name: supported-features + in: query + description: Features supported by the NF consumer for the CAPIF Discover Service API. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: api-supported-features + in: query + description: > + Features supported by the discovered service API indicated by api-name parameter. + This may only be present if api-name query parameter is present. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: ue-ip-addr + in: query + description: Represents the UE IP address information. + schema: + $ref: '#/components/schemas/IpAddrInfo' +- name: service-kpis + in: query + description: > + Contains information about service characteristics provided by the targeted + service API(s). + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceKpis' +responses: + '200': + description: > + The response body contains the result of the search over the list of registered APIs. + content: + application/json: + schema: + $ref: '#/components/schemas/DiscoveredAPIs' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + DiscoveredAPIs: + type: object + description: > + Represents a list of APIs currently registered in the CAPIF core function + and satisfying a number of filter criteria provided by the API consumer. + properties: + serviceAPIDescriptions: + type: array + items: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceAPIDescription' + minItems: 1 + description: > + Description of the service API as published by the service. Each service + API description shall include AEF profiles matching the filter criteria. + +``` + +``` + +IpAddrInfo: + type: object + description: Represents the UE IP address information. + properties: + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + oneOf: + - required: [ipv4Addr] + - required: [ipv6Addr] + +``` + +## A.3 CAPIF\_Publish\_Service\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_Publish_Service_API + description: | + API for publishing service APIs. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.4" + +``` + +``` + +externalDocs: + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +``` + +``` + +servers: + - url: '{apiRoot}/published-apis/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222. + +``` + +``` + +paths: + # APF published API + /{apfId}/service-apis: + post: + description: Publish a new API. + parameters: + - name: apfId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + responses: + '201': + description: > + Service API published successfully The URI of the created resource + shall be returned in the "Location" HTTP header. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId} + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + +``` + +``` + + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +get: + description: Retrieve all published APIs. + parameters: + - name: apfId + in: path + required: true + schema: + type: string + responses: + '200': + description: Definition of all service API(s) published by the API publishing function. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceAPIDescription' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Individual APF published API +/{apfId}/service-apis/{serviceApiId}: + get: + description: Retrieve a published service API. + parameters: + - name: serviceApiId + in: path + required: true + schema: + type: string + - name: apfId + in: path + required: true + schema: + type: string + responses: + '200': + description: > + Definition of individual service API published by the API publishing function. + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + description: Update a published service API. + parameters: + - name: serviceApiId + in: path + required: true + schema: + type: string + - name: apfId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + responses: + '200': + description: Definition of service API updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +``` + +``` + +patch: + description: Modify an existing published service API. + operationId: ModifyIndAPFPubAPI + tags: + - Individual APF published API + parameters: + - name: serviceApiId + in: path + required: true + schema: + type: string + - name: apfId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServiceAPIDescriptionPatch' + responses: + '200': + description: > + The definition of the service API is modified successfully and a + representation of the updated service API is returned in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAPIDescription' + '204': + description: No Content. The definition of the service API is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + description: Unpublish a published service API. + parameters: + - name: serviceApiId + in: path + required: true + schema: + type: string + - name: apfId + in: path + required: true + schema: + type: string + responses: + '204': + description: The individual published service API matching the serviceApiId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +# Components + +components: + schemas: +# Data Type for representations + ServiceAPIDescription: + type: object + description: Represents the description of a service API as published by the APF. + properties: + apiName: + type: string + description: > + API name, it is set as {apiName} part of the URI structure as defined in + clause 5.2.4 of 3GPP TS 29.122. + apiId: + type: string + description: > + API identifier assigned by the CAPIF core function to the published service API. + Shall not be present in the HTTP POST request from the API publishing function + to the CAPIF core function. Shall be present in the HTTP POST response from the + CAPIF core function to the API publishing function and in the HTTP GET response + from the CAPIF core function to the API invoker (discovery API). + apiStatus: + $ref: '#/components/schemas/ApiStatus' + aefProfiles: + type: array + items: + $ref: '#/components/schemas/AefProfile' + minItems: 1 + description: > + AEF profile information, which includes the exposed API details (e.g. protocol). + description: + type: string + description: Text description of the API + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + shareableInfo: + $ref: '#/components/schemas/ShareableInformation' + serviceAPICategory: + type: string + description: The service API category to which the service API belongs to. + apiSuppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pubApiPath: + $ref: '#/components/schemas/PublishedApiPath' + ccfId: + type: string + description: CAPIF core function identifier. + required: + - apiName + + InterfaceDescription: + type: object + description: Represents the description of an API's interface. + properties: + ipv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + fqdn: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +port: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' +apiPrefix: + type: string + description: > + A string representing a sequence of path segments that starts with the slash character. +securityMethods: + type: array + items: + $ref: '#/components/schemas/SecurityMethod' + minItems: 1 + description: > + Security methods supported by the interface, it take precedence over + the security methods provided in AefProfile, for this specific interface. +oneOf: +- required: [ipv4Addr] +- required: [ipv6Addr] +- required: [fqdn] + +AefProfile: + type: object + description: Represents the AEF profile data. + properties: + aefId: + type: string + description: Identifier of the API exposing function + versions: + type: array + items: + $ref: '#/components/schemas/Version' + minItems: 1 + description: API version + protocol: + $ref: '#/components/schemas/Protocol' + dataFormat: + $ref: '#/components/schemas/DataFormat' + securityMethods: + type: array + items: + $ref: '#/components/schemas/SecurityMethod' + minItems: 1 + description: Security methods supported by the AEF + domainName: + type: string + description: Domain to which API belongs to + interfaceDescriptions: + type: array + items: + $ref: '#/components/schemas/InterfaceDescription' + minItems: 1 + description: Interface details + aefLocation: + $ref: '#/components/schemas/AefLocation' + serviceKpis: + $ref: '#/components/schemas/ServiceKpis' + ueIpRange: + $ref: '#/components/schemas/IpAddrRange' + required: + - aefId + - versions + oneOf: + - required: [domainName] + - required: [interfaceDescriptions] + +Resource: + type: object + description: Represents the API resource data. + properties: + resourceName: + type: string + description: Resource name + commType: + $ref: '#/components/schemas/CommunicationType' + uri: + type: string + description: > + Relative URI of the API resource, it is set as {apiSpecificSuffixes} part +``` + +``` + + of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122. +custOpName: + type: string + description: > + it is set as {custOpName} part of the URI structure for a custom operation + associated with a resource as defined in clause 5.2.4 of 3GPP TS 29.122. +custOperations: + type: array + items: + $ref: '#/components/schemas/CustomOperation' + minItems: 1 + description: > + Custom operations associated with this resource. +operations: + type: array + items: + $ref: '#/components/schemas/Operation' + minItems: 1 + description: > + Supported HTTP methods for the API resource. Only applicable when the + protocol in AefProfile indicates HTTP. +description: + type: string + description: Text description of the API resource +required: +- resourceName +- commType +- uri + +CustomOperation: + type: object + description: Represents the description of a custom operation. + properties: + commType: + $ref: '#/components/schemas/CommunicationType' + custOpName: + type: string + description: > + it is set as {custOpName} part of the URI structure for a custom operation + without resource association as defined in clause 5.2.4 of 3GPP TS 29.122. + operations: + type: array + items: + $ref: '#/components/schemas/Operation' + minItems: 1 + description: > + Supported HTTP methods for the API resource. Only applicable when the + protocol in AefProfile indicates HTTP. + description: + type: string + description: Text description of the custom operation + required: + - commType + - custOpName + +Version: + type: object + description: Represents the API version information. + properties: + apiVersion: + type: string + description: API major version in URI (e.g. v1) + expiry: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + resources: + type: array + items: + $ref: '#/components/schemas/Resource' + minItems: 1 + description: Resources supported by the API. + custOperations: + type: array + items: + $ref: '#/components/schemas/CustomOperation' + minItems: 1 + description: Custom operations without resource association. + required: + - apiVersion + +``` + +``` +ShareableInformation: + type: object + description: > + Indicates whether the service API and/or the service API category can be shared + to the list of CAPIF provider domains. + properties: + isShareable: + type: boolean + description: > + Set to "true" indicates that the service API and/or the service API + category can be shared to the list of CAPIF provider domain information. + Otherwise set to "false". + capifProvDoms: + type: array + items: + type: string + minItems: 1 + description: > + List of CAPIF provider domains to which the service API information to be shared. + required: + - isShareable + +PublishedApiPath: + type: object + description: Represents the published API path within the same CAPIF provider domain. + properties: + ccfIds: + type: array + items: + type: string + minItems: 1 + description: A list of CCF identifiers where the service API is already published. + +AefLocation: + description: > + Represents the location information (e.g. civic address, GPS coordinates, data center ID) + where the AEF providing the service API is located. + type: object + properties: + civicAddr: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + geoArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + dcId: + type: string + description: > + Identifies the data center where the AEF providing the service API is located. + +ServiceAPIDescriptionPatch: + type: object + description: > + Represents the parameters to request the modification of an APF published API resource. + properties: + apiStatus: + $ref: '#/components/schemas/ApiStatus' + aefProfiles: + type: array + items: + $ref: '#/components/schemas/AefProfile' + description: AEF profile information, which includes the exposed API details. + minItems: 1 + description: + type: string + description: Text description of the API + shareableInfo: + $ref: '#/components/schemas/ShareableInformation' + serviceAPICategory: + type: string + description: The service API category to which the service API belongs to. + apiSuppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pubApiPath: + $ref: '#/components/schemas/PublishedApiPath' + ccfId: + type: string + description: CAPIF core function identifier. +``` + +``` + +ApiStatus: + type: object + description: > + Represents the API status. + properties: + aefIds: + type: array + items: + type: string + description: > + Indicates the list of AEF ID(s) where the API is active. + If this attribute is omitted, the API is inactive at all AEF(s) + defined in the "aefProfiles" attribute within + the ServiceAPIDescription data structure. + required: + - aefIds + +ServiceKpis: + type: object + description: > + Represents information about the service characteristics provided by a service API. + properties: + maxReqRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: > + Unsigned integer identifying maximum request rate per second from the API Invoker + supported by the server. + maxRestime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + availability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avalComp: + type: string + pattern: '^\\d+(\\.\\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$' + description: > + The maximum compute resource available in FLOPS for the API Invoker. + avalGraComp: + type: string + pattern: '^\\d+(\\.\\d+)? (kFLOPS|MFLOPS|GFLOPS|TFLOPS|PFLOPS|EFLOPS|ZFLOPS)$' + description: > + The maximum graphical compute resource in FLOPS available for the API Invoker. + avalMem: + type: string + pattern: '^\\d+(\\.\\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$' + description: > + The maximum memory resource available for the API Invoker. + avalStor: + type: string + pattern: '^\\d+(\\.\\d+)? (KB|MB|GB|TB|PB|EB|ZB|YB)$' + description: > + The maximum storage resource available for the API Invoker. + conBand: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: > + The connection bandwidth in kbps advertised for the API Invoker's use. + +IpAddrRange: + description: Represents the list of public IP ranges + type: object + properties: + ueIpv4AddrRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddressRange' + description: Represents the IPv4 Address ranges of the UE(s). + minItems: 1 + ueIpv6AddrRanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddressRange' + description: Represents the Ipv6 Address ranges of the UE(s). + minItems: 1 + anyOf: + - required: [ueIpv4AddrRanges] + - required: [ueIpv6AddrRanges] + +Protocol: + anyOf: + +``` + +``` +- type: string +enum: + - HTTP_1_1 + - HTTP_2 + - MQTT + - WEBSOCKET +- type: string +description: > + 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. +description: | + Indicates a protocol and protocol version used by the API. + Possible values are: + - HTTP_1_1: Indicates that the protocol is HTTP version 1.1. + - HTTP_2: Indicates that the protocol is HTTP version 2. + - MQTT: Indicates that the protocol is Message Queuing Telemetry Transport. + - WEBSOCKET: Indicates that the protocol is Websocket. + +CommunicationType: +anyOf: +- type: string +enum: + - REQUEST_RESPONSE + - SUBSCRIBE_NOTIFY +- type: string +description: > + 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. +description: | + Indicates a communication type of the resource or the custom operation. + Possible values are: + - REQUEST_RESPONSE: The communication is of the type request-response. + - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify. + +DataFormat: +anyOf: +- type: string +enum: + - JSON + - XML + - PROTOBUF3 +- type: string +description: > + 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. +description: | + Indicates a data format. + Possible values are: + - JSON: Indicates that the data format is JSON. + - XML: Indicates that the data format is Extensible Markup Language. + - PROTOBUF3: Indicates that the data format is Protocol buffers version 3. + +SecurityMethod: +anyOf: +- type: string +enum: + - PSK + - PKI + - OAUTH +- type: string +description: > + 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. +description: | + Indicates the security method. + Possible values are: + - PSK: Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122. + - PKI: Security method 2 (Using PKI) as described in 3GPP TS 33.122. + - OAUTH: Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122. + +Operation: +anyOf: +- type: string +enum: +``` + +``` + + - GET + - POST + - PUT + - PATCH + - DELETE +- type: string + description: > + 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. +description: | + Indicates an HTTP method. +Possible values are: +- GET: HTTP GET method. +- POST: HTTP POST method. +- PUT: HTTP PUT method. +- PATCH: HTTP PATCH method. +- DELETE: HTTP DELETE method. + +``` + +## A.4 CAPIF\_Events\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_Events_API + description: | + API for event subscription management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.4" + +externalDocs: + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: +- url: '{apiRoot}/capif-events/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: + /{subscriberId}/subscriptions: + post: + description: Creates a new individual CAPIF Event Subscription. + parameters: + - name: subscriberId + in: path + description: Identifier of the Subscriber + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventSubscription' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Created (Successful creation of subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/EventSubscription' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/capif-events/v1/{subscriberId}/subscriptions/{subscriptionId} + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/{subscriberId}/subscriptions/{subscriptionId}: + delete: + description: Deletes an individual CAPIF Event Subscription. + parameters: + - name: subscriberId + in: path + description: Identifier of the Subscriber + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of an individual Events Subscription + required: true + schema: + type: string + responses: +``` + +``` + +'204': + description: > + The individual CAPIF Events Subscription matching the subscriptionId is deleted. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + description: Update of an existing individual CAPIF Event Subscription. + parameters: + - name: subscriberId + in: path + description: Identifier of the Subscriber + required: true + schema: + type: string + - name: subscriptionId + in: path + description: Identifier of the individual Subscriber + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventSubscription' + responses: + '200': + description: OK (Successful update of the subscription). + content: + application/json: + schema: + $ref: '#/components/schemas/EventSubscription' + '204': + description: No Content + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + +``` + +``` +description: Modification of an existing individual CAPIF Event Subscription. +parameters: +- name: subscriberId + in: path + description: Identifier of the Subscriber + required: true + schema: + type: string +- name: subscriptionId + in: path + description: Identifier of the individual Subscriber + required: true + schema: + type: string +requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/EventSubscriptionPatch' +responses: + '200': + description: OK (Successful update of the subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/EventSubscription' + '204': + description: No Content + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + EventSubscription: + type: object + description: Represents an individual CAPIF Event Subscription resource. + properties: + events: + type: array + items: + $ref: '#/components/schemas/CAPIFEvent' + minItems: 1 + description: Subscribed events + eventFilters: + type: array + items: + $ref: '#/components/schemas/CAPIFEventFilter' + minItems: 1 + description: Subscribed event filters + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by Subscriber to request the CAPIF core function to send a +``` + +``` + test notification as defined in in clause 7.6. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - notificationDestination + +EventNotification: + type: object + description: Represents an individual CAPIF Event notification. + properties: + subscriptionId: + type: string + description: > + Identifier of the subscription resource to which the notification + is related - CAPIF resource identifier + events: + $ref: '#/components/schemas/CAPIFEvent' + eventDetail: + $ref: '#/components/schemas/CAPIFEventDetail' + required: + - subscriptionId + - events + +CAPIFEventFilter: + type: object + description: Represents a CAPIF event filter. + properties: + apiIds: + type: array + items: + type: string + minItems: 1 + description: Identifier of the service API + apiInvokerIds: + type: array + items: + type: string + minItems: 1 + description: Identity of the API invoker + aefIds: + type: array + items: + type: string + minItems: 1 + description: Identifier of the API exposing function + +CAPIFEventDetail: + type: object + description: Represents a CAPIF event details. + properties: + serviceAPIDescriptions: + type: array + items: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceAPIDescription' + minItems: 1 + description: Description of the service API as published by the APF. + apiIds: + type: array + items: + type: string + minItems: 1 + description: Identifier of the service API + apiInvokerIds: + type: array + items: + type: string + minItems: 1 + description: Identity of the API invoker + accCtrlPolList: + $ref: '#/components/schemas/AccessControlPolicyListExt' + invocationLogs: + type: array + items: + $ref: 'TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog' + minItems: 1 +``` + +``` + + description: Invocation logs. + apiTopoHide: + $ref: '#/components/schemas/TopologyHiding' + +AccessControlPolicyListExt: + description: Represents the extension for access control policies. + allOf: + - $ref: 'TS29222_CAPIF_Access_Control_Policy_API.yaml#/components/schemas/AccessControlPolicyList' + - type: object + properties: + apiId: + type: string + required: + - apiId + +TopologyHiding: + type: object + description: Represents the routing rules information of a service API. + properties: + apiId: + type: string + routingRules: + type: array + items: + $ref: 'TS29222_CAPIF_Routing_Info_API.yaml#/components/schemas/RoutingRule' + minItems: 1 + required: + - apiId + - routingRules + +EventSubscriptionPatch: + type: object + description: > + Represents the parameters to request the updated of an individual CAPIF Event + Subscription resource. + properties: + events: + type: array + items: + $ref: '#/components/schemas/CAPIFEvent' + minItems: 1 + description: Subscribed events + eventFilters: + type: array + items: + $ref: '#/components/schemas/CAPIFEventFilter' + minItems: 1 + description: Subscribed event filters + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +CAPIFEvent: + anyOf: + - type: string + enum: + - SERVICE_API_AVAILABLE + - SERVICE_API_UNAVAILABLE + - SERVICE_API_UPDATE + - API_INVOKER_ONBOARDED + - API_INVOKER_OFFBOARDED + - SERVICE_API_INVOCATION_SUCCESS + - SERVICE_API_INVOCATION_FAILURE + - ACCESS_CONTROL_POLICY_UPDATE + - ACCESS_CONTROL_POLICY_UNAVAILABLE + - API_INVOKER AUTHORIZATION_REVOKED + - API_INVOKER_UPDATED + - API_TOPOLOGY HIDING_CREATED + - API_TOPOLOGY HIDING_REVOKED + - type: string + description: > + 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. + description: | + Describes the CAPIF event. + +``` + +Possible values are: + +- SERVICE\_API\_AVAILABLE: +Events related to the availability of service APIs after the service APIs are published. +- SERVICE\_API\_UNAVAILABLE: +Events related to the unavailability of service APIs after the service APIs are unpublished. +- SERVICE\_API\_UPDATE: Events related to change in service API information. +- API\_INVOCKER\_ONBOARDED: Events related to API invoker onboarded to CAPIF. +- API\_INVOCKER\_OFFBOARDED: Events related to API invoker offboarded from CAPIF. +- SERVICE\_API\_INVOCATION\_SUCCESS: +Events related to the successful invocation of service APIs. +- SERVICE\_API\_INVOCATION\_FAILURE: Events related to the failed invocation of service APIs. +- ACCESS\_CONTROL\_POLICY\_UPDATE: +Events related to the update for the access control policy related to the service APIs. +- ACCESS\_CONTROL\_POLICY\_UNAVAILABLE: +Events related to the unavailability of the access control policy related to the service APIs. +- API\_INVOCKER\_AUTHORIZATION\_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs. +- API\_INVOCKER\_UPDATED: Events related to API invoker profile updated to CAPIF. +- API\_TOPOLOGY HIDING\_CREATED: +Events related to the creation or update of the API topology hiding information of the service APIs after the service APIs are published. +- API\_TOPOLOGY HIDING\_REVOKED: +Events related to the revocation of the API topology hiding information of the service APIs after the service APIs are unpublished. + +## A.5 CAPIF\_API\_Invoker\_Management\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_API_Invoker_Management_API + description: | + API for API invoker management. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.1" + +externalDocs: + description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/api-invoker-management/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: + /onboardedInvokers: + post: + description: Creates a new individual API Invoker profile. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + description: Notify the API Invoker about the onboarding completion + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingNotification' + responses: + '204': + description: No Content (successful onboarding notification) + +``` + +``` + + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: API invoker on-boarded successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/api-invoker-management/v1/onboardedInvokers/{onboardingId} + required: true + schema: + type: string + '202': + description: The CAPIF core has accepted the Onboarding request and is processing it. + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/onboardedInvokers/{onboardingId}: + delete: + description: Deletes an individual API Invoker. + parameters: + - name: onboardingId + in: path + description: String identifying an individual on-boarded API invoker resource + required: true + schema: + type: string + responses: + '204': + +``` + +``` + + description: The individual API Invoker matching onboardingId was offboarded. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + description: Updates an individual API invoker details. + parameters: + - name: onboardingId + in: path + description: String identifying an individual on-boarded API invoker resource + required: true + schema: + type: string + requestBody: + description: representation of the API invoker details to be updated in CAPIF core function + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + description: Notify the API Invoker about the API invoker update completion + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OnboardingNotification' + responses: + '204': + description: No Content (successful API invoker update notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + +``` + +``` +'200': + description: API invoker details updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' +'202': + description: > + The CAPIF core has accepted the API invoker update details request and is processing it. +'204': + description: > + API invoker's information updated successfully, with no content to be + sent in the response body. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + description: Modify an individual API invoker details. + operationId: ModifyIndApiInvokeEnrolment + tags: + - Individual API Invoker enrolment details + parameters: + - name: onboardingId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetailsPatch' + responses: + '200': + description: > + The definition of the service API is modified successfully and a + representation of the updated service API is returned in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' + '202': + description: The request is accepted and under processing. + '204': + description: No Content. The definition of the service API is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +components: + schemas: + OnboardingInformation: + type: object + description: Represents on-boarding information of the API invoker. + properties: + apiInvokerPublicKey: + type: string + description: The API Invoker's public key + apiInvokerCertificate: + type: string + description: > + The API Invoker's generic client certificate, provided by the CAPIF core function. + onboardingSecret: + type: string + description: > + The API Invoker's onboarding secret, provided by the CAPIF core function. + required: + - apiInvokerPublicKey + + APIList: + type: object + description: Represents a list of APIs. + properties: + serviceAPIDescriptions: + type: array + items: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/ServiceAPIDescription' + minItems: 1 + description: Represents the list of service APIs that the API Invoker is allowed to +invoke. + + APIInvokerEnrolmentDetails: + type: object + properties: + apiInvokerId: + type: string + description: > + API invoker ID assigned by the CAPIF core function to the API invoker while + on-boarding the API invoker. Shall not be present in the HTTP POST request + from the API invoker to the CAPIF core function, to on-board itself. Shall be + present in all other HTTP requests and responses. + readOnly: true + onboardingInformation: + $ref: '#/components/schemas/OnboardingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by Subscriber to request the CAPIF core function to send a + test notification as defined in in clause 7.6. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + apiList: + $ref: '#/components/schemas/APIList' + apiInvokerInformation: + type: string + description: > + Generic information related to the API invoker such as details of + the device or the application. +``` + +``` + + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - onboardingInformation + - notificationDestination + description: Represents information about the API Invoker that requested to onboard. + +OnboardingNotification: + type: object + description: Represents a notification of on-boarding or update result. + properties: + result: + type: boolean + description: Set to "true" indicate successful on-boarding. Otherwise set to "false" + resourceLocation: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + apiInvokerEnrolmentDetails: + $ref: '#/components/schemas/APIInvokerEnrolmentDetails' + apiList: + $ref: '#/components/schemas/APIList' + required: + - result + +APIInvokerEnrolmentDetailsPatch: + type: object + description: Represents an API Invoker's enrolment details to be updated. + properties: + onboardingInformation: + $ref: '#/components/schemas/OnboardingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + apiList: + $ref: '#/components/schemas/APIList' + apiInvokerInformation: + type: string + description: > + Generic information related to the API invoker such as details of + the device or the application. + +``` + +## A.6 CAPIF\_Security\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_Security_API + description: | + API for CAPIF security management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.3" + +externalDocs: + description: 3GPP TS 29.222 V18.4.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: +- url: '{apiRoot}/capif-security/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222. + +paths: +/trustedInvokers/{apiInvokerId}: + get: + parameters: + - name: apiInvokerId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + - name: authenticationInfo + in: query + description: > + +``` + +``` + + When set to 'true', it indicates the CAPIF core function to send the + authentication information of the API invoker. Set to false or omitted otherwise. + schema: + type: boolean +- name: authorizationInfo + in: query + description: > + When set to 'true', it indicates the CAPIF core function to send the + authorization information of the API invoker. Set to false or omitted otherwise. + schema: + type: boolean +responses: + '200': + description: > + The security related information of the API Invoker based on the request + from the API exposing function. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSecurity' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + parameters: + - name: apiInvokerId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + requestBody: + description: create a security context for an API invoker + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSecurity' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + +``` + +``` + + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +responses: + '201': + description: Successful created. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSecurity' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId} + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + parameters: + - name: apiInvokerId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of the existing subscription) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + +``` + +``` +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/trustedInvokers/{apiInvokerId}/update: + post: + parameters: + - name: apiInvokerId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + requestBody: + description: Update the security context (e.g. re-negotiate the security methods). + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSecurity' + responses: + '200': + description: Successful updated. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceSecurity' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/trustedInvokers/{apiInvokerId}/delete: + post: + parameters: + - name: apiInvokerId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + requestBody: + description: Revoke the authorization of the API invoker for APIs. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SecurityNotification' + responses: + '204': +``` + +``` + description: Successful revoked. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/securityId/token: + post: + parameters: + - name: securityId + in: path + description: Identifier of an individual API invoker + required: true + schema: + type: string + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AccessTokenReq' + responses: + '200': + description: Successful Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenRsp' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + description: Error in the Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenErr' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenErr' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +``` + +``` + + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: + ServiceSecurity: + type: object + description: > + Represents the details of the security method for each service API interface. + When included by the API invoker, it indicates the preferred method of security. + When included by the CAPIF core function, it indicates the security method to be + used for the service API interface. + properties: + securityInfo: + type: array + items: + $ref: '#/components/schemas/SecurityInformation' + minimum: 1 + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by API invoker to request the CAPIF core function to send a + test notification as defined in in clause 7.6. Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - securityInfo + - notificationDestination + + SecurityInformation: + type: object + description: Represents the interface details and the security method. + properties: + interfaceDetails: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' + aefId: + type: string + description: Identifier of the API exposing function + apiId: + type: string + description: API identifier + prefSecurityMethods: + type: array + items: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/SecurityMethod' + minItems: 1 + description: Security methods preferred by the API invoker for the API interface. + selSecurityMethod: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/SecurityMethod' + authenticationInfo: + type: string + description: Authentication related information + authorizationInfo: + type: string + description: Authorization related information + authorizationFlow: + type: array + items: + $ref: '#/components/schemas/AuthorizationFlow' + minItems: 1 + required: + - prefSecurityMethods + oneOf: + - required: [interfaceDetails] + - required: [aefId] + + SecurityNotification: + type: object + description: Represents the revoked authorization notification details. + properties: + +``` + +``` +apiInvokerId: + type: string + description: String identifying the API invoker assigned by the CAPIF core function. +aeId: + type: string + description: String identifying the AEF. +apiIds: + type: array + items: + type: string + minItems: 1 + description: Identifier of the service API +cause: + $ref: '#/components/schemas/Cause' +required: +- apiInvokerId +- apiIds +- cause + +AccessTokenReq: + format: x-www-form-urlencoded + description: Represents the access token request information. + properties: + grant_type: + type: string + enum: + - client_credentials + client_id: + type: string + resOwnerId: + type: string + client_secret: + type: string + scope: + type: string + authCode: + type: string + required: + - grant_type + - client_id + +AccessTokenRsp: + type: object + description: Represents the access token response information. + properties: + access_token: + type: string + description: > + JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims) + token_type: + type: string + enum: + - Bearer + expires_in: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + scope: + type: string + required: + - access_token + - token_type + - expires_in + +AccessTokenClaims: + type: object + description: Represents the claims data structure for the access token. + properties: + iss: + type: string + resOwnerId: + type: string + scope: + type: string + exp: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + required: + - iss + - scope + - exp +``` + +``` + +AccessTokenErr: + type: object + description: Represents an error in the access token request. + properties: + error: + type: string + enum: + - invalid_request + - invalid_client + - invalid_grant + - unauthorized_client + - unsupported_grant_type + - invalid_scope + error_description: + type: string + error_uri: + type: string + required: + - error + +AuthorizationCodeRsp: + type: object + description: Represents the authorization code response information. + properties: + authCode: + type: string + required: + - authCode + +Cause: + anyOf: + - type: string + enum: + - OVERLIMIT_USAGE + - UNEXPECTED_REASON + - type: string + description: > + 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. + description: | + Indicates the cause for revoking the API invoker's authorization to the service API. + Possible values are: + - OVERLIMIT_USAGE: + The revocation of the authorization of the API invoker is due to the overlimit + usage of the service API + - UNEXPECTED_REASON: + The revocation of the authorization of the API invoker is due to unexpected reason. + +AuthorizationFlow: + anyOf: + - type: string + enum: + - CLIENT_CREDENTIALS_FLOW + - AUTHORIZATION_CODE_FLOW + - AUTHORIZATION_CODE_FLOW_WITH_PKCE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration and + is not used to encode content defined in the present version of this API. + description: | + Indicates the supported authorization flow (e.g. client credentials flow, authorization code + flow, etc.) to the API invoker. + Possible values are: + - CLIENT_CREDENTIALS_FLOW: + The supported authorization flow is client credentials flow. + - AUTHORIZATION_CODE_FLOW: + The supported authorization flow is authorization code flow. + - AUTHORIZATION_CODE_FLOW_WITH_PKCE: + The supported authorization flow is authorization code flow with PKCE. + +``` + +## A.7 CAPIF Access Control Policy API + +openapi: 3.0.0 + +``` +info: + title: CAPIF_Access_Control_Policy_API + description: | + API for access control policy. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.1" + +externalDocs: + description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/access-control-policy/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: + /accessControlPolicyList/{serviceApiId}: + get: + description: Retrieves the access control policy list. + parameters: + - name: serviceApiId + in: path + description: Identifier of a published service API + required: true + schema: + type: string + - name: aef-id + in: query + required: true + description: Identifier of the AEF + schema: + type: string + - name: api-invoker-id + in: query + description: Identifier of the API invoker + schema: + type: string + - name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessControlPolicyList' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` + +components: + schemas: + AccessControlPolicyList: + type: object + description: Represents the access control policy list for a published service API. + properties: + apiInvokerPolicies: + type: array + items: + $ref: '#/components/schemas/ApiInvokerPolicy' + minItems: 0 + description: Policy of each API invoker. + + ApiInvokerPolicy: + type: object + description: Represents the policy of an API Invoker. + properties: + apiInvokerId: + type: string + description: API invoker ID assigned by the CAPIF core function + allowedTotalInvocations: + type: integer + description: Total number of invocations allowed on the service API by the API invoker. + allowedInvocationsPerSecond: + type: integer + description: Invocations per second allowed on the service API by the API invoker. + allowedInvocationTimeRangeList: + type: array + items: + $ref: '#/components/schemas/TimeRangeList' + minItems: 0 + description: > + The time ranges during which the invocations are allowed on the service API + by the API invoker. + required: + - apiInvokerId + + TimeRangeList: + type: object + description: > + Represents the time range during which the invocation of a service API is allowed + by the API invoker. + properties: + startTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + +``` + +## A.8 CAPIF\_Logging\_API\_Invocation\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_Logging_API_Invocation_API + description: | + API for invocation logs. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.1" + +externalDocs: + description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/api-invocation-logs/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: + /{aefId}/logs: + post: + +``` + +``` + +description: Creates a new log entry for service API invocations. +parameters: +- name: aefId + in: path + description: Identifier of the API exposing function + required: true + schema: + type: string +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InvocationLog' +responses: + '201': + description: > + Log of service API invocations provided by API exposing function successfully + stored on the CAPIF core function. + content: + application/json: + schema: + $ref: '#/components/schemas/InvocationLog' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/api-invocation-logs/v1/{aefId}/logs/{logId} + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/{aefId}/logs/{logId}: + description: Creates a new log entry for service API invocations. + parameters: + - name: aefId + in: path + description: Identifier of the API exposing function + required: true + schema: + type: string + - name: logId + in: path + description: Identifier of individual log entry + required: true + schema: + type: string +components: + schemas: + InvocationLog: + type: object + description: > + Represents a set of Service API invocation logs to be stored in a CAPIF core function. + properties: + aefId: + type: string + description: > + +``` + +``` +Identity information of the API exposing function requesting logging of +service API invocations +apiInvokerId: + type: string + description: Identity of the API invoker which invoked the service API +logs: + type: array + items: + $ref: '#/components/schemas/Log' + minItems: 1 + description: Service API invocation log +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +required: +- aefId +- apiInvokerId +- logs + +Log: + type: object + description: Represents an individual service API invocation log entry. + properties: + apiId: + type: string + description: String identifying the API invoked. + apiName: + type: string + description: > + Name of the API which was invoked, it is set as {apiName} part of the URI + structure as defined in clause 5.2.4 of 3GPP TS 29.122. + apiVersion: + type: string + description: Version of the API which was invoked + resourceName: + type: string + description: Name of the specific resource invoked + uri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + protocol: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol' + operation: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Operation' + result: + type: string + description: For HTTP protocol, it contains HTTP status code of the invocation + invocationTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + invocationLatency: + $ref: '#/components/schemas/DurationMs' + inputParameters: + description: > + List of input parameters. Can be any value - string, number, boolean, array or object. + outputParameters: + description: > + List of output parameters. Can be any value - string, number, boolean, array or object. + srcInterface: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' + destInterface: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' + fwdInterface: + type: string + description: > + It includes the node identifier (as defined in IETF RFC 7239 of all forwarding + entities between the API invoker and the AEF, concatenated with comma and space, + e.g. 192.0.2.43:80, unknown_OBFport, 203.0.113.60 + required: + - apiId + - apiName + - apiVersion + - resourceName + - protocol + - result + +DurationMs: + type: integer + description: Represents a period of time in units of milliseconds. + minimum: 0 +``` + +## A.9 CAPIF\_Auditing\_API + +``` +openapi: 3.0.0 + +info: + title: CAPIF_Auditing_API + description: | + API for auditing. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.2" + +externalDocs: + description: 3GPP TS 29.222 V18.1.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/logs/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222. + +paths: + /apiInvocationLogs: + get: + description: Query and retrieve service API invocation logs stored on the CAPIF core function. + parameters: + - name: aef-id + in: query + description: String identifying the API exposing function. + schema: + type: string + - name: api-invoker-id + in: query + description: String identifying the API invoker which invoked the service API. + schema: + type: string + - name: time-range-start + in: query + description: Start time of the invocation time range. + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + - name: time-range-end + in: query + description: End time of the invocation time range. + schema: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + - name: api-id + in: query + description: String identifying the API invoked. + schema: + type: string + - name: api-name + in: query + description: > + API name, it is set as {apiName} part of the URI structure as defined in + clause 5.2.4 of 3GPP TS 29.122. + schema: + type: string + - name: api-version + in: query + description: Version of the API which was invoked. + schema: + type: string + - name: protocol + in: query + description: Protocol invoked. + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Protocol' + - name: operation + in: query + description: Operation that was invoked on the API. + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/Operation' + - name: result + in: query +``` + +``` + +description: Result or output of the invocation. +schema: + type: string +- name: resource-name + in: query + description: Name of the specific resource invoked. + schema: + type: string +- name: src-interface + in: query + description: Interface description of the API invoker. + content: + application/json: + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' +- name: dest-interface + in: query + description: Interface description of the API invoked. + content: + application/json: + schema: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/InterfaceDescription' +- name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Result of the query operation along with fetched service API invocation log data. + content: + application/json: + schema: + $ref: '#/components/schemas/InvocationLogsRetrieveRes' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + InvocationLogs: + type: object + description: > + Represents several (more than one) invocation logs. + properties: + multipleInvocationLogs: + type: array + items: + $ref: 'TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - multipleInvocationLogs + +``` + +``` +InvocationLogsRetrieveRes: + description: > + Represents the result of an invocation logs retrieval request. + oneOf: + - $ref: 'TS29222_CAPIF_Logging_API_Invocation_API.yaml#/components/schemas/InvocationLog' + - $ref: '#/components/schemas/InvocationLogs' +``` + +--- + +## A.10 AEF\_Security\_API + +``` +openapi: 3.0.0 + +info: + title: AEF_Security_API + description: | + API for AEF security management. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.3.0-alpha.1" + +externalDocs: + description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/aeF-security/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222. + +paths: + /check-authentication: + post: + summary: Check authentication. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAuthenticationReq' + responses: + '200': + description: The request was successful. + content: + application/json: + schema: + $ref: '#/components/schemas/CheckAuthenticationRsp' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` +/revoke-authorization: + post: + summary: Revoke authorization. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RevokeAuthorizationReq' + responses: + '200': + description: The request was successful. + content: + application/json: + schema: + $ref: '#/components/schemas/RevokeAuthorizationRsp' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + CheckAuthenticationReq: + type: object + description: Represents authentication check request data. + properties: + apiInvokerId: + type: string + description: > + API invoker ID assigned by the CAEIF core function to the API invoker + while on-boarding the API invoker. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - apiInvokerId + - supportedFeatures + + CheckAuthenticationRsp: + type: object + description: Represents authentication check response data. + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supportedFeatures + + RevokeAuthorizationReq: + type: object + description: Represents authorization revocation request data. + properties: + revokeInfo: + $ref: 'TS29222_CAEIF_Security_API.yaml#/components/schemas/SecurityNotification' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` + + required: + - revokeInfo + - supportedFeatures + +RevokeAuthorizationRsp: + type: object + description: Represents authorization revocation response data. + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supportedFeatures + +``` + +## A.11 CAPIF\_API\_Provider\_Management\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_API_Provider_Management_API + description: | + API for API provider domain functions management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.2.0-alpha.2" + +externalDocs: + description: 3GPP TS 29.222 V18.1.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: + - url: '{apiRoot}/api-provider-management/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: + /registrations: + post: + description: Registers a new API Provider domain with API provider domain functions profiles. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetails' + responses: + '201': + description: API provider domain registered successfully + content: + application/json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetails' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/api-provider-management/v1/registrations/{registrationId} + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + +``` + +``` + + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/registrations/{registrationId}: + delete: + description: Deregisters API provider domain by deleting API provider domain and functions. + parameters: + - name: registrationId + in: path + description: String identifying an registered API provider domain resource. + required: true + schema: + type: string + responses: + '204': + description: The API provider domain matching registrationId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + description: Updates an API provider domain's registration details. + parameters: + - name: registrationId + in: path + description: String identifying an registered API provider domain resource. + required: true + schema: + type: string + requestBody: + description: > + Representation of the API provider domain registration details to be updated + in CAPIF core function. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetails' + responses: + '200': + description: API provider domain registration details updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetails' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + description: Modify an individual API provider details. + operationId: ModifyIndApiProviderEnrolment + tags: + - Individual API Provider enrolment details + parameters: + - name: registrationId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetailsPatch' + responses: + '200': + description: > + The definition of the service API is modified successfully and a + representation of the updated service API is returned in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/APIProviderEnrolmentDetails' + '204': + description: No Content. The definition of the service API is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + APIProviderEnrolmentDetails: + type: object + description: Represents an API provider domain's enrolment details. + properties: + +``` + +``` +apiProvDomId: + type: string + description: > + API provider domain ID assigned by the CAPIF core function to the API management + function while registering the API provider domain. Shall not be present in the + HTTP POST request from the API Management function to the CAPIF core function, + to on-board itself. Shall be present in all other HTTP requests and responses. + readOnly: true +regSec: + type: string + description: > + Security information necessary for the CAPIF core function to validate the + registration of the API provider domain. Shall be present in HTTP POST request + from API management function to CAPIF core function for API provider domain + registration. +apiProvFuncs: + type: array + items: + $ref: '#/components/schemas/APIProviderFunctionDetails' + minItems: 1 + description: > + A list of individual API provider domain functions details. When included by + the API management function in the HTTP request message, it lists the API + provider domain functions that the API management function intends to + register/update in registration or update registration procedure. When + included by the CAPIF core function in the HTTP response message, it lists + the API domain functions details that are registered or updated successfully. +apiProvDomInfo: + type: string + description: > + Generic information related to the API provider domain such as details + of the API provider applications. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +failReason: + type: string + description: > + Registration or update specific failure information of failed API provider + domain function registrations. Shall be present in the HTTP response + body if atleast one of the API provider domain function registration or update + registration fails. +required: + - regSec + +APIProviderFunctionDetails: + type: object + description: Represents an API provider domain function's details. + properties: + apiProvFuncId: + type: string + description: > + API provider domain functionID assigned by the CAPIF core function to the + API provider domain function while registering/updating the API provider domain. + Shall not be present in the HTTP POST request from the API management function to + the CAPIF core function, to register itself. Shall be present in all other HTTP + requests and responses. + regInfo: + $ref: '#/components/schemas/RegistrationInformation' + apiProvFuncRole: + $ref: '#/components/schemas/ApiProviderFuncRole' + apiProvFuncInfo: + type: string + description: > + Generic information related to the API provider domain function such as details + of the API provider applications. + required: + - regInfo + - apiProvFuncRole + +RegistrationInformation: + type: object + description: > + Represents registration information of an individual API provider domain function. + properties: + apiProvPubKey: + type: string + description: Public Key of API Provider domain function. + apiProvCert: +``` + +``` + + type: string + description: API provider domain function's client certificate + required: + - apiProvPubKey + +APIProviderEnrolmentDetailsPatch: + type: object + description: > + Represents a list of modifications for the API provider domain's enrolment details. + properties: + apiProvFuncs: + type: array + items: + $ref: '#/components/schemas/APIProviderFunctionDetails' + minItems: 1 + description: > + A list of individual API provider domain functions details. When included by + the API management function in the HTTP request message, it lists the API + provider domain functions that the API management function intends to + register/update in registration or update registration procedure. + apiProvDomInfo: + type: string + description: > + Generic information related to the API provider domain such as details + of the API provider applications. + +# Simple data types and enumerations +ApiProviderFuncRole: + anyOf: + - type: string + enum: + - AEF + - APF + - AMF + - type: string + description: > + 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. + description: | + Indicates the role (e.g. AEF, APF, etc.) of an API provider domain function. + Possible values are: + - AEF: API provider function is API Exposing Function. + - APF: API provider function is API Publishing Function. + - AMF: API Provider function is API Management Function. + +``` + +## A.12 CAPIF\_Routing\_Info\_API + +openapi: 3.0.0 + +``` + +info: + title: CAPIF_Routing_Info_API + description: | + API for Routing information. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.2.0-alpha.1" + +externalDocs: + description: 3GPP TS 29.222 V18.0.0 Common API Framework for 3GPP Northbound APIs + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/ + +servers: +- url: '{apiRoot}/capif-routing-info/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 7.5 of 3GPP TS 29.222 + +paths: +/service-apis/{serviceApiId}: + get: + description: Retrieves the API routing information. + parameters: + - name: serviceApiId + in: path + +``` + +``` + description: Identifier of a published service API + required: true + schema: + type: string +- name: aef-id + in: query + required: true + description: Identifier of the AEF + schema: + type: string +- name: supp-feat + in: query + required: false + description: To filter irrelevant responses related to unsupported features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: OK. + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingInfo' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29122_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + schemas: + RoutingInfo: + type: object + description: Represents an API routing information. + properties: + routingRules: + type: array + items: + $ref: '#/components/schemas/RoutingRule' + minItems: 1 + required: + - routingRules + + RoutingRule: + type: object + description: Represents an API routing rule. + properties: + ipv4AddrRanges: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6AddressRange' + minItems: 1 + aefProfile: + $ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/AefProfile' +``` + +``` +required: + - aefProfile + +Ipv6AddressRange: + type: object + description: Represents IPv6 address range. + properties: + start: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + end: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + required: + - start + - end +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-03 | CT3#95 | C3-181278 | | | | TS skeleton of Common API Framework for 3GPP Northbound APIs | 0.0.0 | +| 2018-03 | CT3#95 | C3-181378 | | | | Inclusion of documents agreed in CT3#95:
C3-181281, C3-181282, C3-181283, C3-181284, C3-181285, C3-181286, C3-181287, C3-181321, C3-181322, Rapporteur changes | 0.1.0 | +| 2018-04 | CT3#96 | C3-182527 | | | | Inclusion of documents agreed in CT3#96:
C3-182204, C3-182387, C3-182393, C3-182395, C3-182468, C3-182469, C3-182470, C3-182483, C3-182484, C3-182485 | 0.2.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of documents agreed in CT3#97:
C3-183271, C3-183274, C3-183275, C3-183372, C3-183376, C3-183377, C3-183378, C3-183379, C3-183598, C3-183599, C3-183602, C3-183603, C3-183604, C3-183798, C3-183799, C3-183809, C3-183841, C3-183842 | 0.3.0 | +| 2018-06 | CT#80 | CP-181037 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181037 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182016 | 0001 | 1 | F | Changes to clause 4 – Overview | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0003 | 2 | F | Changes to CAPIF Publish Service API clause | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0004 | 2 | F | Changes to CAPIF Events API clause | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0005 | 4 | F | Changes to CAPIF API Invoker Management API clause | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0006 | 4 | F | Changes to CAPIF Authentication Authorization API clause | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0007 | 3 | F | Update to data types for ServiceAPIDescription and APIQuery | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0008 | 5 | F | Definition of CAPIF_Access_Control_Policy_API, and OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0009 | 4 | F | CAPIF_Events_API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0010 | 4 | F | AEF_Authentication_API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0011 | 1 | F | CAPIF_Discover_Service API - Corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0012 | 3 | F | CAPIF_discovery_service API OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0013 | 4 | F | CAPIF_Publish_Service API - Corrections and OpenAPI file | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0014 | 4 | F | AEF_Authentication API - Editor's notes | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0015 | 4 | F | Corrections to data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0016 | 1 | F | API Invoker's Information in APIInvokerEnrolmentDetails | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0017 | 1 | F | Corrections to OnboardingInformation data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0018 | 2 | F | Security method preference | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0019 | 1 | F | Clarifications to Obtain_API_Invoker_Info service operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0020 | 1 | F | Subscribed and Subscribing functional entity | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0021 | 1 | F | Miscellaneous corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0023 | 1 | F | Definitions and abbreviations | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0024 | 1 | F | Referenced data types and enumerations | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0025 | 2 | F | CAPIF_Security_API OpenAPI schema | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0026 | 1 | F | CAPIF discovery service API – API invoker retrieves API information using GET | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0028 | 2 | F | CAPIF_Auditing_API – API management function retrieves API information logs using GET – OpenAPI document | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0029 | 3 | F | API Names changes in clause 5 | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0030 | | F | Change security-related API names in clause 8 and 10 | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0031 | 2 | F | Describe response code 202 for Onboard_API_Invoker POST method | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0032 | | F | Correct cardinality for onboardingNotificationDestination | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0033 | | F | Correct cardinality for securityNotificationDestination | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0034 | 1 | F | Correct protocol type in Interface Description | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0036 | 1 | F | Query parameter in retrieving access control | 15.1.0 | +| 2018-09 | CT#81 | CP-182037 | 0037 | 1 | F | Authorization endpoint and token request | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0038 | 1 | F | CAPIF Events | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0040 | 1 | F | Corrections to resource figures | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0041 | 1 | F | CAPIF_Auditing_API - 'query' custom operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0042 | 2 | F | OpenAPI - CAPIF_API_Invoker_Management API | 15.1.0 | +| 2018-09 | CT#81 | CP-182016 | 0043 | 2 | F | OpenAPI - CAPIF_Logging_API_Invocation API | 15.1.0 | +| 2018-12 | CT#82 | CP-183109 | 0047 | | F | Correct server definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0027 | 2 | F | Security adaptation for Nnef northbound APIs with CAPIF | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0045 | 1 | F | Correct security API name in clause 5.6.2.1 | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0046 | 1 | F | Remove Event operations from CAPIF_Publish_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0048 | | F | Correct CAPIF services | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0049 | 2 | F | Correct api name and service name for CAPIF_Publish_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0050 | 2 | F | Correct api name and service name for CAPIF_Discover_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0051 | 4 | F | Correct CAPIF_Publish_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0052 | 1 | F | Correct CAPIF_Discover_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0053 | 4 | F | Correct CAPIF_Logging_API_Invocation_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0054 | 3 | F | Correct CAPIF_Auditing_API | 15.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183109 | 0055 | 2 | F | Correct CAPIF_Security_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0055 | 3 | F | Correct CAPIF_Security_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0057 | | F | Correct CAPIF_Access_Control_Policy_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0058 | 2 | F | supportedFeatures - CAPIF_Discover_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0059 | | F | supportedFeatures 002 - CAPIF_Publish_Service_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0060 | 1 | F | supportedFeatures 003 - CAPIF_Events_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0061 | | F | supportedFeatures 004 - CAPIF_API_Invoker_Management_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0062 | | F | supportedFeatures 005 - CAPIF_Security_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0063 | 2 | F | supportedFeatures - CAPIF_Access_Control_Policy_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0064 | | F | supportedFeatures 007 - CAPIF_Logging_API_Invocation_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0065 | 2 | F | supportedFeatures - CAPIF_Auditing_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0067 | | F | Redundant Editor's note | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0068 | 1 | F | Correct CAPIF_API_Invoker_Management_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0070 | | F | Missing general description in A.1 | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0071 | 1 | F | Update mandatory error status code | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0072 | 3 | F | Correct resource model and add missing functions in CAPIF_Security_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0074 | 2 | F | Correct resource model and add missing function in AEF_Authentication_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0075 | 1 | F | externalDocs field in OpenAPI documents | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0076 | 3 | F | location header in OpenAPI documents | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0077 | 1 | F | version number in OpenAPI documents | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0078 | 2 | F | corrections to CAPIF_Access_Control_Policy_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0079 | 1 | F | corrections to CAPIF_Logging_API_Invocation_API | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0079 | 2 | F | Security adaptation for T8 APIs with CAPIF | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0080 | | F | corrections to EventNotification | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0081 | | F | corrections to theSubscriber | 15.2.0 | +| 2018-12 | CT#82 | CP-183109 | 0082 | | F | remove 'OnboardingRequestAck' data type | 15.2.0 | +| 2019-03 | CT#83 | CP-190119 | 0083 | 1 | F | Correct GET description for retrieving service API information | 15.3.0 | +| 2019-03 | CT#83 | CP-190119 | 0084 | 1 | F | Correct PUT message for updating service APIs | 15.3.0 | +| 2019-03 | CT#83 | CP-190119 | 0085 | 2 | F | Correct AEF operations related to obtaining security info or revoking API invokers | 15.3.0 | +| 2019-03 | CT#83 | CP-190119 | 0086 | 1 | F | Correction of definition of obtaining the correct resource in Security APIs | 15.3.0 | +| 2019-03 | CT#83 | CP-190119 | 0089 | 1 | F | Correct several descriptions in clause 8 tables | 15.3.0 | +| 2019-06 | CT#84 | CP-191088 | 0090 | 1 | F | Correct CAPIF_Logging_API yaml file | 15.4.0 | +| 2019-06 | CT#84 | CP-191221 | 0091 | 1 | F | Copyright notice in the YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191222 | 0092 | 1 | F | API version update | 15.4.0 | +| 2019-09 | CT#85 | CP-192158 | 0093 | 3 | F | Northbound API registration and discovery | 16.0.0 | +| 2019-12 | CT#86 | CP-193194 | 0095 | 1 | A | Correct cardinality in event API | 16.1.0 | +| 2019-12 | CT#86 | CP-193199 | 0096 | 4 | B | Reference update: RFC 8259 | 16.1.0 | +| 2019-12 | CT#86 | CP-193199 | 0097 | | F | Detailed information in CAPIF event notification | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0101 | 4 | B | Updates to Service Architecture and functional entities | 16.1.0 | +| 2019-12 | CT#86 | CP-193194 | 0103 | 1 | A | Clause reference corrections | 16.1.0 | +| 2019-12 | CT#86 | CP-193194 | 0105 | 1 | A | Conventions for Open API specification files | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0106 | 1 | B | Update-to-Service-Architecture | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0107 | 2 | B | Update-to-Service-API-Publish | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0108 | 1 | B | Interconnection-Service-API-Publish | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0109 | 2 | B | Update-to-Discover-Service-API | 16.1.0 | +| 2019-12 | CT#86 | CP-193199 | 0111 | 1 | B | Supported feature in API publish service | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0112 | 1 | B | API invoker details update – Service Definition | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0113 | 1 | B | API invoker details update – API Definition | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0114 | 1 | B | API Provider Registration and Update – Service Definition | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0115 | 3 | B | API Provider Registration and Update – API Definition | 16.1.0 | +| 2019-12 | CT#86 | CP-193195 | 0116 | 1 | B | Support for 3rd party API provider domain | 16.1.0 | +| 2019-12 | CT#86 | CP-193194 | 0118 | 1 | A | Correct the notificationDestination of ServiceSecurity object in yaml file | 16.1.0 | +| 2019-12 | CT#86 | CP-193194 | 0120 | 1 | A | Align the API name of Initiate_Authentication | 16.1.0 | +| 2019-12 | CT#86 | CP-193212 | 0121 | | F | Update of API version and TS version in OpenAPI file | 16.1.0 | +| 2020-03 | CT#87e | CP-200205 | 0123 | 1 | B | Published API path | 16.2.0 | +| 2020-03 | CT#87e | CP-200205 | 0124 | | B | API Invoker Update – Event Updates | 16.2.0 | +| 2020-03 | CT#87e | CP-200205 | 0125 | 2 | B | API Provider Management – Open API | 16.2.0 | +| 2020-03 | CT#87e | CP-200216 | 0126 | | F | 29.222 Rel-16 Update of OpenAPI version and TS version in externalDocs field | 16.2.0 | +| 2020-06 | CT#88e | CP-201277 | 0128 | 3 | B | Service description and operations for CAPIF_API_Routing_Policy_API | 16.3.0 | +| 2020-06 | CT#88e | CP-201277 | 0129 | 3 | B | API definition for CAPIF_API_Routing_Policy_API | 16.3.0 | +| 2020-06 | CT#88e | CP-201278 | 0130 | 3 | B | API Topology hiding | 16.3.0 | +| 2020-06 | CT#88e | CP-201230 | 0133 | | A | Correct API publish procedure | 16.3.0 | +| 2020-06 | CT#88e | CP-201231 | 0131 | 1 | F | API Provider management API attribute name optimization | 16.3.0 | +| 2020-06 | CT#88e | CP-201231 | 0135 | 1 | F | Correct ServiceAPIDescription | 16.3.0 | +| 2020-06 | CT#88e | CP-201231 | 0136 | 2 | F | Correct service API discovery in interconnection | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201231 | 0137 | 1 | F | Correct shareable information | 16.3.0 | +| 2020-06 | CT#88e | CP-201235 | 0138 | 1 | F | Correct the supported features in the published API | 16.3.0 | +| 2020-06 | CT#88e | CP-201235 | 0139 | 1 | F | Update general clause for OpenAPI specification | 16.3.0 | +| 2020-06 | CT#88e | CP-201256 | 0140 | 1 | F | URI of the CAPIF APIs | 16.3.0 | +| 2020-06 | CT#88e | CP-201231 | 0141 | 1 | B | Add API category in discovery | 16.3.0 | +| 2020-06 | CT#88e | CP-201235 | 0142 | | F | Optionality of ProblemDetails | 16.3.0 | +| 2020-06 | CT#88e | CP-201230 | 0144 | 1 | A | Clause and reference point correction | 16.3.0 | +| 2020-06 | CT#88e | CP-201231 | 0145 | 1 | F | Align interface names | 16.3.0 | +| 2020-06 | CT#88e | CP-201235 | 0146 | 1 | F | Supported headers, Resource Data type, Operation Name and yaml mapping | 16.3.0 | +| 2020-06 | CT#88e | CP-201255 | 0147 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201319 | 0149 | | A | Required attribute corrections to CAPIF Open APIs | 16.3.0 | +| 2020-09 | CT#89e | CP-202064 | 0151 | 1 | F | Missing and inconsistent "apiVersion" notations and Location header | 16.4.0 | +| 2020-09 | CT#89e | CP-202064 | 0152 | 1 | F | CAPIF Routing Info API corrections | 16.4.0 | +| 2020-09 | CT#89e | CP-202064 | 0153 | | F | CAPIF topology hiding correction | 16.4.0 | +| 2020-09 | CT#89e | CP-202233 | 0155 | 3 | A | Correct CAPIF security API | 16.4.0 | +| 2020-09 | CT#89e | CP-202063 | 0157 | 1 | A | Correct api invoker certificate in onboarding | 16.4.0 | +| 2020-09 | CT#89e | CP-202084 | 0158 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-12 | CT#90e | CP-203139 | 0160 | 1 | F | Essential corrections and alignments | 16.5.0 | +| 2020-12 | CT#90e | CP-203126 | 0162 | 1 | A | Correct inconsistency in SecurityNotification | 16.5.0 | +| 2020-12 | CT#90e | CP-203139 | 0163 | 1 | F | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2021-03 | CT#91e | CP-210239 | 0164 | 1 | F | CAPIF_Security API externalDocs version correction | 16.6.0 | +| 2021-03 | CT#91e | CP-210221 | 0165 | 1 | F | Corrections to HTTP custom headers handling for Northbound APIs | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0166 | | F | OpenAPI reference | 17.0.0 | +| 2021-06 | CT#92e | CP-211239 | 0177 | 1 | F | Missing data type in the CAPIF_API_Provider_Management_API Data Types tables | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0178 | 2 | F | Missing data type in the CAPIF_Routing_Info_API Data Types tables | 17.1.0 | +| 2021-06 | CT#92e | CP-211123 | 0179 | 1 | F | Missing data type in the CAPIF_Security_API Data Types tables | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0180 | 1 | F | Missing data types in the CAPIF_Access_Control_Policy_API Data Types tables | 17.1.0 | +| 2021-06 | CT#92e | CP-211124 | 0181 | 3 | F | Missing data types in the CAPIF_Publish_Service_API Data Types tables | 17.1.0 | +| 2021-06 | CT#92e | CP-211216 | 0185 | | A | SecurityMethod data type incorrectly written some parts of the CAPIF_Publish_Service_API description clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0186 | 1 | F | DiscoverService: Unbreakable spaces and missing "description" field | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0187 | 1 | F | PublishService API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0188 | 1 | F | Events API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0189 | 1 | F | InvokerManagement API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0190 | 1 | F | Security API: Unbreakable space and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0191 | 1 | F | AccessControlPolicy API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0192 | 1 | F | LoggingAPIInvocation API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0193 | 1 | F | Auditing API: Unbreakable spaces | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0194 | 1 | F | AEFSecurity API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0195 | 1 | F | API_Provider_Management API: Missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0196 | 1 | F | RoutingInfo API: Unbreakable spaces and missing "description" fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0197 | | F | Correction of the clause clause terminology | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0198 | | F | Corrections to the CAPIF_API_Invoker_Management_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0199 | 1 | F | Corrections to the CAPIF_Auditing_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0200 | | F | Corrections to the CAPIF_Events_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0201 | | F | Corrections to the CAPIF_Logging_API_Invocation_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0202 | | F | Corrections to the CAPIF_Publish_Service_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211239 | 0203 | | F | Corrections to the CAPIF_Security_API Data Model clause | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0204 | 1 | F | Miscellaneous corrections to the CAPIF_Discover_Service_API | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0205 | 1 | F | Miscellaneous corrections to the AEF_Security_API | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0206 | 1 | B | Support of 204 No content response code for service API definition update(NB17) | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0207 | 1 | F | Support redirection and mandatory error codes for CAPIF APIs | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0208 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212224 | 0209 | | F | Correction of cardinality of InvocationLogs in POST request | 17.2.0 | +| 2021-09 | CT#93e | CP-212214 | 0210 | | F | Resource URI correction on CAPIF APIs | 17.2.0 | +| 2021-09 | CT#93e | CP-212214 | 0211 | | F | 204 No Content during modification procedure on CAPIF_API_Provider_Management_API | 17.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93e | CP-212214 | 0212 | | F | Correction of some remaining invalid characters in OpenAPI specification files | 17.2.0 | +| 2021-09 | CT#93e | CP-212214 | 0213 | | F | Updates 204 No Content in CAPIF_API_Invoker_Management_API | 17.2.0 | +| 2021-09 | CT#93e | CP-212223 | 0214 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-12 | CT#94e | CP-213221 | 0215 | 2 | B | AEF location support | 17.3.0 | +| 2021-12 | CT#94e | CP-213220 | 0216 | | B | Alignment with SA3 supported TLS profiles | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0217 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-03 | CT#95e | CP-220203 | 0218 | 1 | F | Clarify the query logic for API invoker id | 17.4.0 | +| 2022-03 | CT#95e | CP-220168 | 0221 | | A | Correct inconsistencies | 17.4.0 | +| 2022-03 | CT#95e | CP-220204 | 0222 | 1 | B | Obtain security info with API ID | 17.4.0 | +| 2022-03 | CT#95e | CP-220204 | 0223 | 1 | F | Clarification about building the apiRoot of a discovered API | 17.4.0 | +| 2022-03 | CT#95e | CP-220323 | 0224 | 2 | B | Support PATCH for the update of an API Provider Domain Registration resource. | 17.4.0 | +| 2022-03 | CT#95e | CP-220350 | 0225 | 3 | B | Support PATCH for the update of an On-boarded API resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220204 | 0226 | | B | Support PATCH for the update of an APF published API resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0227 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221147 | 0230 | 3 | F | Resolving the naming convention issues | 17.5.0 | +| 2022-06 | CT#96 | CP-221275 | 0231 | 2 | F | Token request error | 17.5.0 | +| 2022-06 | CT#96 | CP-221147 | 0232 | | F | CAPIF_Discover_Service_API: formatting of preferred-aef-loc query parameter | 17.5.0 | +| 2022-06 | CT#96 | CP-221147 | 0233 | | F | Resource URI overview and apiVersion placeholder | 17.5.0 | +| 2022-06 | CT#96 | CP-221148 | 0234 | 1 | F | OpenAPI long descriptions | 17.5.0 | +| 2022-06 | CT#96 | CP-221124 | 0237 | 1 | A | Correcting the data type of the APF identifier | 17.5.0 | +| 2022-06 | CT#96 | CP-221124 | 0240 | 1 | A | Correcting the data type of the service API Identifier | 17.5.0 | +| 2022-06 | CT#96 | CP-221124 | 0243 | | A | Correcting query parameters names in the CAPIF_Security_API | 17.5.0 | +| 2022-06 | CT#96 | CP-221263 | 0244 | 2 | F | Missing definition of the AccessTokenErr data type in the main body | 17.5.0 | +| 2022-06 | CT#96 | CP-221124 | 0247 | 1 | A | Correct token request content type | 17.5.0 | +| 2022-06 | CT#96 | CP-221151 | 0248 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222118 | 0251 | 2 | F | Corrections to the references for URI structure from TS 29.501 to TS 29.122. | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0252 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223235 | 0262 | 2 | A | Corrections for CAPIF_API_Invoker_Management_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223184 | 0266 | | F | Add the missing status code for CAPIF_API_Invoker_Management_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223169 | 0267 | 1 | A | Corrections for data type of CAPIF services | 17.7.0 | +| 2022-12 | CT#98e | CP-223169 | 0270 | | A | Corrections on Enumeration Protocol for CAPIF_Publish_Service_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223169 | 0273 | | A | Corrections on POST request body for CAPIF_Logging_API_Invocation_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223169 | 0276 | | A | Corrections on resource URI for CAPIF_Discover_Service_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223169 | 0279 | | A | Corrections on Time Range List for CAPIF_Access_Control_Policy_API | 17.7.0 | +| 2022-12 | CT#98e | CP-223188 | 0284 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223185 | 0253 | 1 | B | Completing the interface descriptions | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0254 | 1 | B | Custom Operations modelling | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0256 | 1 | F | Correction of the tables for the re-used, API-specific data structures in CAPIF APIs | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0257 | | F | Correction of the OpenAPI file formatting and descriptions in the CAPIF APIs | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0258 | | F | "Error handling" clause: alignment with other NBI and 5GS APIs | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0259 | | F | Corrections on CAPIF_API_Provider_Management_API | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0285 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230156 | 0286 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0287 | 1 | B | Vendor specific extensions | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0290 | 1 | B | Support of CAPIF extensibility requirements | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0294 | 1 | B | Update for CAPIF_Auditing_API to support carrying multiple invocation logs and feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0295 | | F | Update the description field of CAPIF_Publish_Service_API | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0296 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231140 | 0297 | 3 | B | Completing the support of CAPIF protocol and data formats extensibility requirements | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0298 | | F | Corrections on presence of the attributes in CAPIF APIs | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0299 | | F | Support CAPIF model in SNPN | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0305 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232091 | 0306 | 1 | F | CAPIF security method clarification | 18.3.0 | +| 2023-09 | CT#101 | CP-232091 | 0307 | 1 | B | Update definitions of CAPIF provider domain and SNPN trust domain | 18.3.0 | +| 2023-09 | CT#101 | CP-232091 | 0308 | 1 | F | Clarify CCF role in service publish | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0309 | 1 | B | CAPIF Events API update subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232091 | 0310 | 1 | F | Various corrections | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0311 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233231 | 0300 | 4 | B | Supporting query parameters extensibility for the | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| | | | | | | CAPIF_Discover_Service_API | | +| 2023-12 | CT#102 | CP-233261 | 0312 | 2 | B | Authorization code flow for resource owner-aware northbound api access | 18.4.0 | +| 2023-12 | CT#102 | CP-233261 | 0313 | 2 | B | Update authorization obtaining part to support resource owner-aware northbound API access | 18.4.0 | +| 2023-12 | CT#102 | CP-233261 | 0314 | 2 | B | Update securitymethod data type for Resource owner-aware northbound API access | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0316 | 1 | B | Service API status monitoring in the CAPIF APIs | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0317 | 2 | F | Error handling in the CAPIF layer | 18.4.0 | +| 2023-12 | CT#102 | CP-233232 | 0318 | 2 | F | Update of the CAPIF layer architecture description | 18.4.0 | +| 2023-12 | CT#102 | CP-233261 | 0319 | 1 | B | Discovering of APIs based on the API provider name in the CAPIF_Discover_Service_API | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0320 | 1 | F | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0321 | 1 | F | Correction of the InterfaceDescription data structure | 18.4.0 | +| 2023-12 | CT#102 | CP-233261 | 0322 | 1 | B | Discovering of APIs based on the IP address of UE in the CAPIF_Discover_Service_API | 18.4.0 | +| 2023-12 | CT#102 | CP-233232 | 0325 | 2 | F | Corrections to boolean type definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233231 | 0326 | | F | Corrections on the CAPIF service | 18.4.0 | +| 2023-12 | CT#102 | CP-233232 | 0327 | 1 | F | CAPIFEventDetail data type clarification | 18.4.0 | +| 2023-12 | CT#102 | CP-233232 | 0328 | 1 | D | Correcting an incorrect clause number | 18.4.0 | +| 2023-12 | CT#102 | CP-233241 | 0331 | 1 | B | New IE(Service KPI) in Service API publish request | 18.4.0 | +| 2023-12 | CT#102 | CP-233261 | 0332 | 1 | B | CAPIF_Publish_Service_API – Publish the Public IP ranges information | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0333 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29230/raw.md b/gsma/29_series/29230/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c2218c36f2cf30b1785a79b402764f1ee37be956 --- /dev/null +++ b/gsma/29_series/29230/raw.md @@ -0,0 +1,2864 @@ + + +# 3GPP TS 29.230 V18.2.0 (2023-09) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Diameter applications; 3GPP specific codes and identifiers (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. The 'P' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|----------------------------------------------------------------------------------------------|-----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Application identifiers..... | 7 | +| 4.1 3GPP specific application identifiers ..... | 7 | +| 5 Command codes..... | 9 | +| 5.1 Command codes allocated for 3GPP..... | 9 | +| 6 Vendor identifier..... | 11 | +| 6.1 3GPP's vendor identifier ..... | 11 | +| 7 Attribute-Value-Pair codes ..... | 12 | +| 7.1 3GPP specific AVP codes..... | 13 | +| 8 Experimental result codes ..... | 38 | +| 8.1 3GPP specific result codes ..... | 38 | +| 8.1.1 Informational ..... | 38 | +| 8.1.2 Success ..... | 39 | +| 8.1.3 Transient Failures ..... | 39 | +| 8.1.4 Permanent Failures ..... | 40 | +| Annex A (informative): Assignment of the Diameter codes and identifiers in 3GPP ..... | 44 | +| A.1 Application identifiers..... | 44 | +| A.2 Command codes..... | 44 | +| A.3 AVP codes..... | 44 | +| A.4 Result codes ..... | 44 | +| Annex B (informative): Change history..... | 46 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document lists the 3GPP specific Diameter protocol codes, including the AVP codes and Experimental result codes. + +This document lists also the application identifiers assigned to 3GPP specific Diameter applications by IANA and the Diameter command code range which is assigned to 3GPP by IANA. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents". +- [2] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; Protocol details". +- [3] 3GPP TS 29.328: "IP Multimedia (IM) Subsystem Sh interface; Signalling flows and message contents". +- [4] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; Protocol details". +- [5] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [6] 3GPP TS 29.234, Release 11: "3GPP system to Wireless Local Area Network (WLAN) interworking; Stage 3". +- [7] 3GPP TS 29.109: "Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol; Stage 3". +- [8] 3GPP TS 29.209, Release 6: "Policy control over Gq interface". +- [9] IETF RFC 3588: "Diameter Base Protocol". +- [10] IETF RFC 3589: "Diameter Command Codes for Third Generation Partnership Project (3GPP) Release 5". +- [11] IANA's Enterprise-Numbers: +- [12] IANA's AAA parameters register: + +- [13] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [14] 3GPP TS 32.296: "Telecommunication management; Charging management; Online Charging System (OCS): Applications and interfaces". +- [15] 3GPP TS 29.210, Release 6: "Charging rule provisioning over Gx interface". +- [16] 3GPP TS 29.140, Release 6: "Multimedia Messaging Service (MMS); MM10 interface based on Diameter protocol; Stage 3". +- [17] 3GPP TS 29.211, Release 6: "Rx Interface and Rx/Gx signalling flows". +- [18] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC);Reference points". +- [20] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [21] 3GPP TS 29.272: "Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [22] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3". +- [23] IETF RFC 5516: "Diameter Command Code Registration for Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)". +- [24] 3GPP TS 29.172: "Location Services (LCS); Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME); SLg interface". +- [25] 3GPP TS 29.173: "Location Services (LCS); Diameter-based SLh interface for Control Plane LCS". +- [26] 3GPP TS 29.219: "Policy and Charging Control: Spending Limit Reporting over Sy reference point". +- [27] 3GPP TS 29.368: "Tsp interface protocol between the MTC Interworking Function (MTC-IWF) and Service Capability Server (SCS)". +- [28] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [29] 3GPP TS 29.337: "Diameter-based T4 interface for communications with packet data networks and applications". +- [30] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". +- [31] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE)". +- [32] 3GPP TS 29.343: "Proximity-services (ProSe) function to ProSe application server aspects (PC2)". +- [33] 3GPP TS 29.344: "Proximity-services (ProSe) Function to Home Subscriber Server (HSS) aspects". +- [34] 3GPP TS 29.345: "Inter-Proximity-services (Prose) function signalling aspects; Stage 3". +- [35] 3GPP TS 29.217: "Policy and Charging Control over Np reference point". +- [36] 3GPP TS 29.128: "Diameter based T6a/T6b interface between the MME/SGSN and the SCEF". +- [37] 3GPP TS 29.153: "Service exposure functionality between SCEF and RCAF reference point". +- [38] 3GPP TS 29.154: "Service capability exposure functionality over Nt Reference point". +- [39] 3GPP TS 29.283: "Diameter Data Management applications". + +- [40] 3GPP TS 29.388: "V2X Control Function to V2X Control Function to Home Subscriber Server (HSS) aspects (V4)". +- [41] 3GPP TS 29.389: "Inter-V2X Control Function Signalling aspects (V6)". +- [42] 3GPP TS 29.561: "Interworking between 5G Network and external Data Networks; Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**3GPP specific:** A definition which is used in conjunction with the 3GPP's vendor identifier. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|------|-------------------------------------| +| AVP | Attribute-Value-Pair | +| CR | Change Request | +| IANA | Internet Assigned Numbers Authority | +| IETF | Internet Engineering Task Force | +| LS | Liaison Statement | + +# --- 4 Application identifiers + +The Diameter applications are identified with the application identifiers as specified in the RFC 3588 [9]. There are two kind of applications: IETF standards track applications and vendor specific applications. All application identifiers are assigned by IANA [12]. This chapter lists the application identifiers assigned by IANA to all 3GPP Diameter applications. + +The application identifiers are transferred in Diameter command's header in the Application-ID field. + +## 4.1 3GPP specific application identifiers + +The 3GPP specific application identifiers allocated by IANA are listed in the following table. + +Table 4.1: 3GPP specific application identifiers + +| Application identifier | Application | 3GPP TS | +|------------------------|-------------------------------|---------------------------| +| 16777216 | 3GPP Cx/Px | 29.228 [1] and 29.229 [2] | +| 16777217 | 3GPP Sh/Ph | 29.328 [3] and 29.329 [4] | +| 16777218 | 3GPP Re | 32.296 [14] | +| 16777219 | 3GPP Wx | 29.234 [6] | +| 16777220 | 3GPP Zn | 29.109 [7] | +| 16777221 | 3GPP Zh | 29.109 [7] | +| 16777222 | 3GPP Gq | 29.209 [8] | +| 16777223 | 3GPP Gmb | 29.061 [13] | +| 16777224 | 3GPP Gx | 29.210 [15] | +| 16777225 | 3GPP Gx over Gy | 29.210 [15] | +| 16777226 | 3GPP MM10 | 29.140 [16] | +| 16777229 | 3GPP Rx | 29.211 [17] | +| 16777230 | 3GPP Pr | 29.234 [6] | +| 16777236 | 3GPP Rx | 29.214 [18] | +| 16777238 | 3GPP Gx | 29.212 [19] | +| 16777250 | 3GPP STa | 29.273 [20] | +| 16777251 | 3GPP S6a | 29.272 [21] | +| 16777252 | 3GPP S13/S13' | 29.272 [21] | +| 16777255 | 3GPP SLg | 29.172 [24] | +| 16777264 | 3GPP SWm | 29.273 [20] | +| 16777265 | 3GPP SWx | 29.273 [20] | +| 16777266 | 3GPP Gxx | 29.212 [19] | +| 16777267 | 3GPP S9 | 29.215 [22] | +| 16777268 | 3GPP Zpn | 29.109 [7] | +| 16777272 | 3GPP S6b | 29.273 [20] | +| 16777291 | 3GPP SLh | 29.173 [25] | +| 16777292 | 3GPP SGmb | 29.061 [13] | +| 16777302 | 3GPP Sy | 29.219 [26] | +| 16777303 | 3GPP Sd | 29.212 [19] | +| 16777308 | 3GPP S7a | 29.272 [21] | +| 16777309 | 3GPP Tsp | 29.368 [27] | +| 16777310 | 3GPP S6m | 29.336 [28] | +| 16777311 | 3GPP T4 | 29.337 [29] | +| 16777312 | 3GPP S6c | 29.338 [30] | +| 16777313 | 3GPP SGd | 29.338 [30] | +| 16777318 | 3GPP S15 | 29.212 [19] | +| 16777319 | 3GPP S9a | 29.215 [22] | +| 16777320 | 3GPP S9a* | 29.215 [22] | +| 16777335 | 3GPP MB2-C | 29.468 [31] | +| 16777336 | 3GPP PC4a | 29.344 [33] | +| 16777337 | 3GPP PC2 | 29.343 [32] | +| 16777340 | 3GPP PC6/PC7 | 29.345 [34] | +| 16777342 | 3GPP Np | 29.217 [35] | +| 16777345 | 3GPP S6t | 29.336 [28] | +| 16777346 | 3GPP T6a/T6b | 29.128 [36] | +| 16777347 | 3GPP Ns | 29.153[37] | +| 16777348 | 3GPP Nt | 29.154[38] | +| 16777349 | 3GPP St | 29.212 [19] | +| 16777350 | 3GPP PC2 | 29.343 [32] | +| 16777351 | 3GPP Diameter Data Management | 29.283 [39] | +| 16777355 | 3GPP V4 | 29.388 [40] | +| 16777356 | 3GPP V6 | 29.389 [41] | +| 16777358 | 3GPP Nta | 29.154 [38] | + +# 5 Command codes + +The command codes are used for communicating the command associated with the Diameter message. The command code is carried in the Diameter header's Command-Code field. The command codes can be divided into standard command codes allocated by IANA and experimental command codes for testing purposes only. + +## 5.1 Command codes allocated for 3GPP + +Based on the IETF RFC 3589 [10] the IANA has allocated a standard command code range 300 - 313 for 3GPP. The command codes are presented in the following table. + +**Table 5.1/1: Command code values allocated for 3GPP** + +| Command code value | Command name | Abbreviation | Specified in 3GPP TS | +|--------------------|------------------------------------------|--------------|----------------------| +| 300 | User-Authorization-Request/-Answer | UAR/UAA | 29.229 [2] | +| 301 | Server-Assignment-Request/-Answer | SAR/SAA | | +| 302 | Location-Info-Request/-Answer | LIR/LIA | | +| 303 | Multimedia-Auth-Request/-Answer | MAR/MAA | | +| 304 | Registration-Termination-Request/-Answer | RTR/RTA | | +| 305 | Push-Profile-Request/-Answer | PPR/PPA | | +| 306 | User-Data-Request/-Answer | UDR/UDA | 29.329 [4] | +| 307 | Profile-Update-Request/-Answer | PUR/PUA | | +| 308 | Subscribe-Notifications-Request/-Answer | SNR/SNA | | +| 309 | Push-Notification-Request/-Answer | PNR/PNA | | +| 310 | Boostrapping-Info-Request/Answer | BIR/BIA | 29.109 [7] | +| 311 | Message-Process-Request/Answer | MPR/MPA | 29.140 [16] | +| 312 | GBAPush-Info-Request/Answer | GPR/GPI | 29.109 [7] | + +**Editor's Note:** The following command codes have been allocated to 3GPP, but they have not been used yet. + +**Table 5.1/2: Command codes allocated for 3GPP** + +| Command code value | Command name | Abbreviation | Specified in 3GPP TS | +|--------------------|--------------|--------------|----------------------| +| 313 | | | | + +As defined in the IETF RFC 5516 [23], IANA has allocated the following command code values for the S6a/S6d interface application and S13/S13' interface application. + +**Table 5.1/3: SAE related Standard Command code values allocated for 3GPP** + +| Command code value | Command name | Abbreviation | Specified in 3GPP TS | +|--------------------|----------------------------------------------|--------------|----------------------| +| 316 | Update-Location-Request/Answer | ULR/ULA | 29.272 [21] | +| 317 | Cancel-Location-Request/Answer | CLR/CLA | | +| 318 | Authentication- Information - Request/Answer | AIR/AIA | | +| 319 | Insert Subscriber Data-Request/Answer | IDR/IDA | | +| 320 | Delete-Subscriber-Data-Request/Answer | DSR/DSA | | +| 321 | Purge-UE-Request/Answer | PUR/PUA | | +| 322 | Reset-Request/Answer | RSR/RSA | | +| 323 | Notify-Request/Answer | NOR/NOA | | +| 324 | ME-Identity-Check-Request/Answer | ECR/ECA | | + +Besides the standard command code values allocated for 3GPP, IANA has allocated the following vendor-specific command code values for 3GPP vendor-specific Diameter applications: + +Table 5.1/4: Vendor-specific command codes allocated for 3GPP + +| Command code value | Command name | Abbreviation | Specified in 3GPP TS | +|--------------------|---------------------------------------------------|--------------|----------------------| +| 8388620 | Provide-Location-Request/Answer | PLR/PLA | 29.172 [24] | +| 8388621 | Location-Report-Request/Answer | LRR/LRA | | +| 8388622 | LCS-Routing-Info-Request/Answer | RIR/RIA | 29.173 [25] | +| 8388635 | Spending-Limit-Request/Answer | SLR/SLA | 29.219 [26] | +| 8388636 | Spending-Status-Notification-Request/Answer | SNR/SNA | | +| 8388637 | TDF-Session-Request/Answer | TSR/TSA | 29.212 [19] | +| 8388731 | TSSF-Notification-Request/Answer | TNR/TNA | | +| 8388638 | Update-VCSG-Location-Request/Answer | UVR/UVA | 29.272 [21] | +| 8388642 | Cancel-VCSG-Location-Request/Answer | CVR/CVA | | +| 8388639 | Device-Action-Request/Answer | DAR/DAA | 29.368 [27] | +| 8388640 | Device-Notification-Request/Answer | DNR/DNA | | +| 8388641 | Subscriber-Information-Request/Answer | SIR/SIA | 29.336 [28] | +| 8388718 | Configuration-Information-Request/Answer | CIR/CIA | 29.336 [28] | +| 8388719 | Reporting-Information-Request/Answer | RIR/RIA | | +| 8388726 | NIDD-Information-Request/Answer | NIR/NIA | | +| 8388643 | Device-Trigger-Request/Answer | DTR/DTA | 29.337 [29] | +| 8388644 | Delivery-Report-Request/Answer | DRR/DRA | | +| 8388645 | MO-Forward-Short-Message Request/Answer | OFR/OFA | 29.338 [30] | +| 8388646 | MT-Forward-Short-Message Request/Answer | TFR/TFA | | +| 8388647 | Send-Routing-Info-for-SM-Request/Answer | SRR/SRA | | +| 8388648 | Alert-Service-Centre-Request/Answer | ALR/ALA | | +| 8388649 | Report-SM-Delivery-Status-Request/Answer | RDR/RDA | | +| 8388656 | Trigger-Establishment-Request/Answer | TER/TEA | 29.215 [30] | +| 8388662 | GCS-Action-Request/Answer | GAR/GAA | 29.468 [31] | +| 8388663 | GCS-Notification-Request/Answer | GNR/GNA | | +| 8388664 | ProSe-Subscriber-Information-Request/Answer | PIR/PIA | 29.344 [33] | +| 8388665 | Update-ProSe-Subscriber-Data-Request/Answer | UPR/UPA | | +| 8388666 | ProSe-Notify-Request/Answer | PNR/PNA | | +| 8388713 | ProSe-Initial-Location-Information-Request/Answer | PSR/PSA | | +| 8388668 | ProSe-Authorization-Request/Answer | PAR/PAA | 29.345 [34] | +| 8388669 | ProSe-Discovery-Request/Answer | PDR/PDA | | + +| | | | | +|---------|-------------------------------------------------|---------|-------------| +| 8388670 | ProSe-Match-Request/Answer | PMR/PMA | | +| 8388671 | ProSe-Match-Report-Info-Request/Answer | PIR/PIA | | +| 8388672 | ProSe-Proximity-Request/Answer | PRR/PRA | | +| 8388673 | ProSe-Location-Update-Request/Answer | PLR/PLA | | +| 8388674 | ProSe-Alert-Request/Answer | ALR/ALA | | +| 8388675 | ProSe-Cancellation-Request/Answer | RPR/RPA | | +| 8388676 | ProXimity-Action-Request/Answer | PXR/PXA | | +| 8388727 | ProXimity-Application-Request/Answer | XAR/XAA | 29.343 [32] | +| 8388720 | Non-Aggregated-RUCI-Report-Request/Answer | NRR/NRA | | +| 8388721 | Aggregated-RUCI-Report-Request/Answer | ARR/ARA | 29.217 [35] | +| 8388722 | Modify-Uecontext-Request/Answer | MUR/MUA | | +| 8388724 | Network-Status-Request/Answer | NSR/NSA | | +| 8388725 | Network-Status-Continuous-Report-Request/Answer | NCR/NCA | 29.153 [37] | +| 8388723 | Background-Data-Transfer-Request/Answer | BTR/BTA | 29.154 [38] | +| 8388728 | Data-Pull-Request/Answer | DPR/DPA | | +| 8388729 | Data-Update-Request/Answer | DUR/DUA | 29.283 [39] | +| 8388730 | Notification-Data-Request/Answer | NDR/NDA | | +| 8388732 | Connection-Management-Request/Answer | CMR/CMA | | +| 8388733 | MO-Data-Request/Answer | ODR/ODA | 29.128 [36] | +| 8388734 | MT-Data-Request/Answer | TDR/TDA | | +| 8388735 | Event-Configuration-Request/Answer | ECR/ECA | | +| 8388736 | Event-Reporting-Request/Answer | ERR/ERA | 29.154 [38] | + +# 6 Vendor identifier + +The vendor identifier (also known as Enterprise number) indicates the vendor specific attributes, result codes and application identifiers in Diameter commands. The vendor identifier is used in the Vendor-ID field of the AVP header and in the Vendor-Id AVP. The Vendor-Id AVP is used to identify the vendor in the Vendor-Specific-Application-Id and Experimental-Result-Code grouped AVPs. + +## 6.1 3GPP's vendor identifier + +The IANA has allocated a vendor identifier value 10415 for 3GPP [11]. + +# --- 7 Attribute-Value-Pair codes + +The AVP codes are used together with the vendor identifier to identify each attribute uniquely. There are multiple AVP namespaces. The IETF IANA namespace, that is, the AVPs with vendor identifier zero or without vendor identifier, is controlled by IANA. Each vendor controls the AVP codes within their AVP namespaces. + +## 7.1 3GPP specific AVP codes + +The 3GPP specific AVPs have the Vendor-Specific bit ('V' bit) set in the AVP header and they carry the 3GPP's vendor identifier in the Vendor-ID field of the AVP header. The 3GPP specific AVP codes are presented in the following table. + +**Table 7.1: 3GPP specific AVP codes** + +| AVP Code | Attribute Name | Data Type | Specified in the 3GPP TS | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|------------------|--------------------------| +| 100 | 3GPP-WLAN-APN-Id | OctetString | | +| 101 | 3GPP-WLAN-QoS-Filter-Rule | UTF8String | 29.234 [6] | +| 102 | 3GPP-WLAN-QoS-Filter-Support | OctetString | | +| Note: The AVP codes from 1 to 255 are reserved for backwards compatibility with 3GPP RADIUS Vendor Specific Attributes (See 3GPP TS 29.061 [13], 3GPP TS 29.561 [42] and 3GPP TS 29.234 [6]) | | | | +| Note: The AVP codes from 256 to 299 are reserved for future use. | | | | +| 300 | Authentication-Method | Enumerated | | +| 301 | Authentication-Information-SIM | OctetString | | +| 302 | Authorization -Information-SIM | OctetString | | +| 303 | WLAN-User-Data | Grouped | | +| 304 | Charging-Data | Grouped | | +| 305 | WLAN-Access | Enumerated | | +| 306 | WLAN- 3GPP-IP-Access | Enumerated | | +| 307 | APN-Authorized | Grouped | | +| 308 | APN-Id | | | +| 309 | APN-Barring-Type | Enumerated | | +| 310 | WLAN-Direct-IP-Access | Enumerated | 29.234 [6] | +| 311 | Session-Request-Type | Enumerated | | +| 312 | Routing-Policy | IPFilterRule | | +| 313 | Max-Requested-Bandwidth | OctetString | | +| 314 | Charging-Characteristics | Integer | | +| 315 | Charging-Nodes | Grouped | | +| 316 | Primary-OCS-Charging-Function-Name | DiameterIdentity | | +| 317 | Secondary-OCS-Charging-Function-Name | DiameterIdentity | | +| 318 | 3GPP-AAA-Server-Name | DiameterIdentity | | +| 319 | Maximum-Number-Accesses | Unsigned32 | | +| Note 1: The AVP codes from 320 to 399 are reserved for TS 29.234 | | | | +| Note 2: The 3GPP-AAA-Server-Name definition is moved to TS 29.273 starting from Rel-12. | | | | +| 400 | GBA-UserSecSettings | OctetString | | +| 401 | Transaction-Identifier | OctetString | | +| 402 | NAF-Hostname | OctetString | | +| 403 | GAA-Service-Identifier | OctetString | | +| 404 | Key-ExpiryTime | Time | | +| 405 | ME-Key-Material | OctetString | | +| 406 | UICC-Key-Material | OctetString | | +| 407 | GBA_U-Awareness-Indicator | Enumerated | | +| 408 | BootstrapInfoCreationTime | Time | | +| 409 | GUSS-Timestamp | Time | | +| 410 | GBA-Type | Enumerated | 29.109 [7] | +| 411 | UE-Id | OctetString | | +| 412 | UE-Id-Type | Enumerated | | +| 413 | UICC-App-Label | OctetString | | +| 414 | UICC-ME | Enumerated | | +| 415 | Requested-Key-Lifetime | Time | | +| 416 | Private-Identity-Request | Enumerated | | +| 417 | GBA-Push-Info | OctetString | | +| 418 | NAF-SA-Identifier | OctetString | | +| 419 | Security-Feature-Request | OctetString | | +| 420 | Security-Feature-Response | OctetString | | +| Note: The AVP codes from 421 to 499 are reserved for TS 29.109 | | | | +| 500 | Abort-Cause | Enumerated | | +| 501 | Access-Network-Charging-Address | Address | 29.209 [8], | +| 502 | Access-Network-Charging-Identifier | Grouped | 29.211 | +| 503 | Access-Network-Charging-Identifier-Value | OctetString | [17] , | +| 504 | AF-Application-Identifier | OctetString | 29.214 | +| 505 | AF-Charging-Identifier | OctetString | [18] | +| 506 | Authorization-Token | OctetString | | + +| | | | +|-----|---------------------------------------|--------------| +| 507 | Flow-Description | IPFilterRule | +| 508 | Flow-Grouping | Grouped | +| 509 | Flow-Number | Unsigned32 | +| 510 | Flows | Grouped | +| 511 | Flow-Status | Enumerated | +| 512 | Flow-Usage | Enumerated | +| 513 | Specific-Action | Enumerated | +| 514 | Max-Requested-Bandwidth | Unsigned32 | +| 515 | Max-Requested-Bandwidth-DL | Unsigned32 | +| 516 | Max-Requested-Bandwidth-UL | Unsigned32 | +| 517 | Media-Component-Description | Grouped | +| 518 | Media-Component-Number | Unsigned32 | +| 519 | Media-Sub-Component AVP | Grouped | +| 520 | Media-Type | Enumerated | +| 521 | RR-Bandwidth | Unsigned32 | +| 522 | RS-Bandwidth | Unsigned32 | +| 523 | SIP-Forking-Indication | Enumerated | +| 524 | Codec-Data | OctetString | +| 525 | Service-URN | OctetString | +| 526 | Acceptable-Service-Info | Grouped | +| 527 | Service-Info-Status | Enumerated | +| 528 | MPS-Identifier | OctetString | +| 529 | AF-Signalling-Protocol | Enumerated | +| 530 | Sponsored-Connectivity-Data | Grouped | +| 531 | Sponsor-Identity | OctetString | +| 532 | Application-Service-Provider-Identity | OctetString | +| 533 | Rx-Request-Type | Enumerated | +| 534 | Min-Requested-Bandwidth-DL | Unsigned32 | +| 535 | Min-Requested-Bandwidth-UL | Unsigned32 | +| 536 | Required-Access-Info | Enumerated | +| 537 | IP-Domain-Id | OctetString | +| 538 | GCS-Identifier | OctetString | +| 539 | Sharing-Key-DL | Unsigned32 | +| 540 | Sharing-Key-UL | Unsigned32 | +| 541 | Retry-Interval | Unsigned32 | +| 542 | Sponsoring-Action | Enumerated | +| 543 | Max-Supported-Bandwidth-DL | Unsigned32 | +| 544 | Max-Supported-Bandwidth-UL | Unsigned32 | +| 545 | Min-Desired-Bandwidth-DL | Unsigned32 | +| 546 | Min-Desired-Bandwidth-UL | Unsigned32 | +| 547 | MCPTT-Identifier | OctetString | +| 548 | Service-Authorization-Info | Unsigned32 | +| 549 | Media-Component-Status | Unsigned32 | +| 550 | Priority-Sharing-Indicator | Enumerated | +| 551 | AF-Requested-Data | Unsigned32 | +| 552 | Content-Version | Unsigned64 | +| 553 | Pre-emption-Control-Info | Unsigned32 | +| 554 | Extended-Max-Requested-BW-DL | Unsigned32 | +| 555 | Extended-Max-Requested-BW-UL | Unsigned32 | +| 556 | Extended-Max-Supported-BW-DL | Unsigned32 | +| 557 | Extended-Max-Supported-BW-UL | Unsigned32 | +| 558 | Extended-Min-Desired-BW-DL | Unsigned32 | +| 559 | Extended-Min-Desired-BW-UL | Unsigned32 | +| 560 | Extended-Min-Requested-BW-DL | Unsigned32 | +| 561 | Extended-Min-Requested-BW-UL | Unsigned32 | +| 562 | MCVideo-Identifier | OctetString | +| 563 | IMS-Content-Identifier | OctetString | +| 564 | IMS-Content-Type | Enumerated | +| 565 | Callee-Information | Grouped | +| 566 | FLUS-Identifier | OctetString | +| 567 | Desired-Max-Latency | Float32 | +| 568 | Desired-Max-Loss | Float32 | +| 569 | NID | OctetString | +| 570 | MA-Information | Grouped | +| 571 | MA-Information-Action | Unsigned32 | + +| | | | | +|-----------------------------------------------------------------------------------------|---------------------------------------------|-------------|------------| +| 572 | 5GS-RAN-NAS-Release-Cause | Grouped | | +| 573 | 5GMM-Cause | Unsigned32 | | +| 574 | 5GSM-Cause | Unsigned32 | | +| 575 | NGAP-Cause | Grouped | | +| 576 | NGAP-Group | Unsigned32 | | +| 577 | NGAP-Value | Unsigned32 | | +| 578 | Wireline-User-Location-Info | Grouped | | +| 579 | HFC-Node-Identifier | OctetString | | +| 580 | GLI-Identifier | OctetString | | +| 581 | Line-Type | Unsigned32 | | +| Note: The AVP codes from 582 to 599 are reserved for TS 29.209, TS 29.211 and TS 29.214 | | | | +| 600 | Visited-Network-Identifier | OctetString | | +| 601 | Public-Identity | UTF8String | | +| 602 | Server-Name | UTF8String | | +| 603 | Server-Capabilities | Grouped | | +| 604 | Mandatory-Capability | Unsigned32 | | +| 605 | Optional-Capability | Unsigned32 | | +| 606 | User-Data | OctetString | | +| 607 | SIP-Number-Auth-Items | Unsigned32 | | +| 608 | SIP-Authentication-Scheme | UTF8String | | +| 609 | SIP-Authenticate | OctetString | | +| 610 | SIP-Authorization | OctetString | | +| 611 | SIP-Authentication-Context | OctetString | | +| 612 | SIP-Auth-Data-Item | Grouped | | +| 613 | SIP-Item-Number | Unsigned32 | | +| 614 | Server-Assignment-Type | Enumerated | | +| 615 | Deregistration-Reason | Grouped | | +| 616 | Reason-Code | Enumerated | | +| 617 | Reason-Info | UTF8String | | +| 618 | Charging-Information | Grouped | | +| 619 | Primary-Event-Charging-Function-Name | DiameterURI | | +| 620 | Secondary-Event-Charging-Function-Name | DiameterURI | | +| 621 | Primary-Charging-Collection-Function-Name | DiameterURI | | +| 622 | Secondary-Charging-Collection-Function-Name | DiameterURI | | +| 623 | User-Authorization-Type | Enumerated | | +| 624 | User-Data-Already-Available | Enumerated | | +| 625 | Confidentiality-Key | OctetString | | +| 626 | Integrity-Key | OctetString | | +| 627 | User-Data-Request-Type | Enumerated | 29.229 [2] | +| 628 | Supported-Features | Grouped | | +| 629 | Feature-List-ID | Unsigned32 | | +| 630 | Feature-List | Unsigned32 | | +| 631 | Supported-Applications | Grouped | | +| 632 | Associated-Identities | Grouped | | +| 633 | Originating-Request | Enumerated | | +| 634 | Wildcarded-Public-Identity | UTF8String | | +| 635 | SIP-Digest-Authenticate | Grouped | | +| 636 | Wildcarded-IMPU | UTF8String | | +| 637 | UAR-Flags | Unsigned32 | | +| 638 | Loose-Route-Indication | Enumerated | | +| 639 | SCSCF-Restoration-Info | Grouped | | +| 640 | Path | OctetString | | +| 641 | Contact | OctetString | | +| 642 | Subscription-Info | Grouped | | +| 643 | Call-ID-SIP-Header | OctetString | | +| 644 | From-SIP-Header | OctetString | | +| 645 | To-SIP-Header | OctetString | | +| 646 | Record-Route | OctetString | | +| 647 | Associated-Registered-Identities | Grouped | | +| 648 | Multiple-Registration-Indication | Enumerated | | +| 649 | Restoration-Info | Grouped | | +| 650 | Session-Priority | Enumerated | | +| 651 | Identity-with-Emergency-Registration | Grouped | | +| 652 | Privileged-Sender-Indication | Enumerated | | +| 653 | LIA-Flags | Unsigned32 | | + +| | | | | +|-----------------------------------------------------------------|-------------------------------------------|------------------|------------| +| 654 | Initial-CSeq-Sequence-Number | Unsigned32 | | +| 655 | SAR-Flags | Unsigned32 | | +| 656 | Allowed-WAF-WWSF-Identities | Grouped | | +| 657 | WebRTC-Authentication-Function-Name | UTF8String | | +| 658 | WebRTC-Web-Server-Function-Name | UTF8String | | +| 659 | RTR-Flags | Unsigned32 | | +| 660 | P-CSCF-Subscription-Info | Grouped | | +| 661 | Registration-Time-Out | Time | | +| 662 | Alternate-Digest-Algorithm | UTF8String | | +| 663 | Alternate-Digest-HA1 | UTF8String | | +| 664 | Failed-PCSCF | Grouped | | +| 665 | PCSCF-FQDN | DiameterIdentity | | +| 666 | PCSCF-IP-Address | Address | | +| Note: The AVP codes from 667 to 699 are reserved for TS 29.229. | | | | +| 700 | User-Identity | Grouped | | +| 701 | MSISDN | OctetString | | +| 702 | User-Data | OctetString | | +| 703 | Data-Reference | Enumerated | | +| 704 | Service-Indication | OctetString | | +| 705 | Subs-Req-Type | Enumerated | | +| 706 | Requested-Domain | Enumerated | | +| 707 | Current-Location | Enumerated | | +| 708 | Identity-Set | Enumerated | | +| 709 | Expiry-Time | Time | | +| 710 | Send-Data-Indication | Enumerated | | +| 711 | DSAI-Tag | OctetString | 29.329 [4] | +| 712 | One-Time-Notification | Enumerated | | +| 713 | Requested-Nodes | Unsigned32 | | +| 714 | Serving-Node-Indication | Enumerated | | +| 715 | Repository-Data-ID | Grouped | | +| 716 | Sequence-Number | Unsigned32 | | +| 717 | Pre-paging-Supported | Enumerated | | +| 718 | Local-Time-Zone-Indication | Enumerated | | +| 719 | UDR-Flags | Unsigned32 | | +| 720 | Call-Reference-Info | Grouped | | +| 721 | Call-Reference-Number | OctetString | | +| 722 | AS-Number | OctetString | | +| Note: The AVP codes from 723 to 799 are reserved for TS 29.329. | | | | +| Note: The AVP codes from 800 to 822 are reserved for TS 32.299. | | | | +| 823 | Event-Type | Grouped | | +| 824 | SIP-Method | UTF8String | | +| 825 | Event | UTF8String | | +| 826 | Content-Type | UTF8String | | +| 827 | Content-Length | Unsigned32 | | +| 828 | Content-Disposition | UTF8String | | +| 829 | Role-of-Node | Enumerated | | +| 830 | User-Session-Id | UTF8String | | +| 831 | Calling-Party-Address | UTF8String | | +| 832 | Called-Party-Address | UTF8String | | +| 833 | Time-Stamps | Grouped | | +| 834 | SIP-Request-Timestamp | Time | | +| 835 | SIP-Response-Timestamp | Time | | +| 836 | Application-Server | UTF8String | 32.299 [5] | +| 837 | Application-provided-called-party-address | UTF8String | | +| 838 | Inter-Operator-Identifier | Grouped | | +| 839 | Originating-IOI | UTF8String | | +| 840 | Terminating-IOI | UTF8String | | +| 841 | IMS-Charging-Identifier | UTF8String | | +| 842 | SDP-Session-Description | UTF8String | | +| 843 | SDP-Media-Component | Grouped | | +| 844 | SDP-Media-Name | UTF8String | | +| 845 | SDP-Media-Description | UTF8String | | +| 846 | CG-Address | Address | | +| 847 | GGSN-Address | Address | | +| 848 | Served-Party-IP-Address | Address | | + +| | | | | +|-----|-----------------------------------------|-------------|----------------| +| 849 | Authorized-QoS | UTF8String | | +| 850 | Application-Server-Information | Grouped | | +| 851 | Trunk-Group-Id | Grouped | | +| 852 | Incoming-Trunk-Group-Id | UTF8String | | +| 853 | Outgoing-Trunk-Group-Id | UTF8String | | +| 854 | Bearer-Service | OctetString | | +| 855 | Service-Id | UTF8String | | +| 856 | Associated-URI | UTF8String | | +| 857 | Charged-Party | UTF8String | | +| 858 | PoC-Controlling-Address | UTF8String | | +| 859 | PoC-Group-Name | UTF8String | | +| 860 | Cause | Grouped | | +| 861 | Cause-Code | Integer32 | | +| 862 | Node-Functionality | Enumerated | | +| 863 | Service-Specific-Data | UTF8String | | +| 864 | Originator | Enumerated | | +| 865 | PS-Furnish-Charging-Information | Grouped | | +| 866 | PS-Free-Format-Data | OctetString | | +| 867 | PS-Append-Free-Format-Data | Enumerated | | +| 868 | Time-Quota-Threshold | Unsigned32 | | +| 869 | Volume-Quota-Threshold | Unsigned32 | | +| 870 | Trigger-Type | Enumerated | | +| 871 | Quota-Holding-Time | Unsigned32 | | +| 872 | Reporting-Reason | Enumerated | | +| 873 | Service-Information | Grouped | | +| 874 | PS-Information | Grouped | | +| 875 | Reserved | - | | +| 876 | IMS-Information | Grouped | | +| 877 | MMS-Information | Grouped | | +| 878 | LCS-Information | Grouped | | +| 879 | PoC-Information | Grouped | | +| 880 | MBMS-Information | Grouped | | +| 881 | Quota-Consumption-Time | Unsigned32 | | +| 882 | Media-Initiator-Flag | Enumerated | | +| 883 | PoC-Server-Role | Enumerated | | +| 884 | PoC-Session-Type | Enumerated | | +| 885 | Number-Of-Participants | Unsigned32 | | +| 886 | Originator-Address | Grouped | | +| 887 | Participants-Involved | UTF8String | | +| 888 | Expires | Unsigned32 | | +| 889 | Message-Body | Grouped | | +| 890 | Reserved | - | | +| 891 | Reserved | - | | +| 892 | Reserved | - | | +| 893 | Reserved | - | | +| 894 | Reserved | - | | +| 895 | Reserved | - | | +| 896 | Reserved | - | | +| 897 | Address-Data | UTF8String | | +| 898 | Address-Domain | Grouped | | +| 899 | Address-Type | Enumerated | | +| | | | | +| 900 | TMGI | OctetString | 29.061
[13] | +| 901 | Required-MBMS-Bearer-Capabilities | UTF8String | | +| 902 | MBMS-StartStop-Indication | Enumerated | | +| 903 | MBMS-Service-Area | OctetString | | +| 904 | MBMS-Session-Duration | Unsigned32 | | +| 905 | Alternative-APN | UTF8String | | +| 906 | MBMS-Service-Type | Enumerated | | +| 907 | MBMS-2G-3G-Indicator | Enumerated | | +| 908 | MBMS-Session-Identity | OctetString | | +| 909 | RAI | UTF8String | | +| 910 | Additional-MBMS-Trace-Info | OctetString | | +| 911 | MBMS-Time-To-Data-Transfer | Unsigned32 | | +| 912 | MBMS-Session-Identity-Repetition-Number | Unsigned32 | | + +| | | | +|-----|--------------------------------|-------------| +| 913 | MBMS-Required-QoS | UTF8String | +| 914 | MBMS-Counting-Information | Enumerated | +| 915 | MBMS-User-Data-Mode-Indication | Enumerated | +| 916 | MBMS-GGSN-Address | UTF8String | +| 917 | MBMS-GGSN-IPv6-Address | UTF8String | +| 918 | MBMS-BMSC-SSM-IP-Address | UTF8String | +| 919 | MBMS-BMSC-SSM-IPv6-Address | UTF8String | +| 920 | MBMS-Flow-Identifier | OctetString | +| 921 | CN-IP-Multicast-Distribution | Enumerated | +| 922 | MBMS-HC-Indicator | Enumerated | +| 923 | MBMS-Access-Indicator | Enumerated | +| 924 | MBMS-GW-SSM-IP-Address | OctetString | +| 925 | MBMS-GW-SSM-IPv6-Address | OctetString | +| 926 | MBMS-BMSC-SSM-UDP-Port | OctetString | +| 927 | MBMS-GW-UDP-Port | OctetString | +| 928 | MBMS-GW-UDP-Port-Indicator | Enumerated | +| 929 | MBMS-Data-Transfer-Start | Unsigned64 | +| 930 | MBMS-Data-Transfer-Stop | Unsigned64 | +| 931 | MBMS-Flags | Unsigned32 | +| 932 | Restart-Counter | Unsigned32 | +| 933 | Diagnostic-Info | Unsigned32 | +| 934 | MBMS-Cell-List | OctetString | + +Note: The AVP codes from 935 to 999 are reserved for TS 29.061 + +| | | | | +|------|---------------------------------------|--------------|-------------| +| 1000 | Bearer-Usage | Enumerated | | +| 1001 | Charging-Rule-Install | Grouped | | +| 1002 | Charging-Rule-Remove | Grouped | | +| 1003 | Charging-Rule-Definition | Grouped | | +| 1004 | Charging-Rule-Base-Name | UTF8String | | +| 1005 | Charging-Rule-Name | OctetString | | +| 1006 | Event-Trigger | Enumerated | | +| 1007 | Metering-Method | Enumerated | | +| 1008 | Offline | Enumerated | | +| 1009 | Online | Enumerated | | +| 1010 | Precedence | Unsigned32 | | +| 1011 | Reporting-Level | Enumerated | | +| 1012 | TFT-Filter | IPFilterRule | | +| 1013 | TFT-Packet-Filter-Information | Grouped | | +| 1014 | ToS-Traffic-Class | OctetString | | +| 1016 | QoS-Information | Grouped | | +| 1018 | Charging-Rule-Report | Grouped | | +| 1019 | PCC-Rule-Status | Enumerated | | +| 1020 | Bearer-Identifier | OctetString | | +| 1021 | Bearer-Operation | Enumerated | | +| 1022 | Access-Network-Charging-Identifier-Gx | Grouped | | +| 1023 | Bearer-Control-Mode | Enumerated | 29.212 [19] | +| 1024 | Network-Request-Support | Enumerated | | +| 1025 | Guaranteed-Bitrate-DL | Unsigned32 | | +| 1026 | Guaranteed-Bitrate-UL | Unsigned32 | | +| 1027 | IP-CAN-Type | Enumerated | | +| 1028 | QoS-Class-Identifier | Enumerated | | +| 1029 | QoS-Negotiation | Enumerated | | +| 1030 | QoS-Upgrade | Enumerated | | +| 1031 | Rule-Failure-Code | Enumerated | | +| 1032 | RAT-Type | Enumerated | | +| 1033 | Event-Report-Indication | Grouped | | +| 1034 | Allocation-Retention-Priority | Grouped | | +| 1035 | CoA-IP-Address | Address | | +| 1036 | Tunnel-Header-Filter | IPFilterRule | | +| 1037 | Tunnel-Header-Length | Unsigned32 | | +| 1038 | Tunnel-Information | Grouped | | +| 1039 | CoA-Information | Grouped | | +| 1040 | APN-Aggregate-Max-Bitrate-DL | Unsigned32 | | +| 1041 | APN-Aggregate-Max-Bitrate-UL | Unsigned32 | | +| 1042 | Revalidation-Time | Time | | +| 1043 | Rule-Activation-Time | Time | | + +| | | | | +|------------------------------------------------------------------|-----------------------------------|------------------|-------------| +| 1044 | Rule-DeActivation-Time | Time | | +| 1045 | Session-Release-Cause | Enumerated | | +| 1046 | Priority-Level | Unsigned32 | | +| 1047 | Pre-emption-Capability | Enumerated | | +| 1048 | Pre-emption-Vulnerability | Enumerated | | +| 1049 | Default-EPS-Bearer-QoS | Grouped | | +| 1050 | AN-GW-Address | Address | | +| 1051 | QoS-Rule-Install | Grouped | | +| 1052 | QoS-Rule-Remove | Grouped | | +| 1053 | QoS-Rule-Definition | Grouped | | +| 1054 | QoS-Rule-Name | OctetString | | +| 1055 | QoS-Rule-Report | Grouped | | +| 1056 | Security-Parameter-Index | OctetString | | +| 1057 | Flow-Label | OctetString | | +| 1058 | Flow-Information | Grouped | | +| 1059 | Packet-Filter-Content | IPFilterRule | | +| 1060 | Packet-Filter-Identifier | OctetString | | +| 1061 | Packet-Filter-Information | Grouped | | +| 1062 | Packet-Filter-Operation | Enumerated | | +| 1063 | Resource-Allocation-Notification | Enumerated | | +| 1064 | Session-Linking-Indicator | Enumerated | | +| 1065 | PDN-Connection-ID | OctetString | | +| 1066 | Monitoring-Key | OctetString | | +| 1067 | Usage-Monitoring-Information | Grouped | | +| 1068 | Usage-Monitoring-Level | Enumerated | | +| 1069 | Usage-Monitoring-Report | Enumerated | | +| 1070 | Usage-Monitoring-Support | Enumerated | | +| 1071 | CSG-Information-Reporting | Enumerated | | +| 1072 | Packet-Filter-Usage | Enumerated | | +| 1073 | Charging-Correlation-Indicator | Enumerated | | +| 1074 | QoS-Rule-Base-Name | UTF8String | | +| 1075 | Routing-Rule-Remove | Grouped | | +| 1076 | Routing-Rule-Definition | Grouped | | +| 1077 | Routing-Rule-Identifier | OctetString | | +| 1078 | Routing-Filter | Grouped | | +| 1079 | Routing-IP-Address | Address | | +| 1080 | Flow-Direction | Enumerated | | +| 1081 | Routing-Rule-Install | Grouped | | +| 1082 | Credit-Management-Status | Unsigned32 | | +| 1085 | Redirect-Information | Grouped | | +| 1086 | Redirect- Support | Enumerated | | +| 1087 | TDF-Information | Grouped | | +| 1088 | TDF-Application-Identifier | OctetString | | +| 1089 | TDF-Destination-Host | DiameterIdentity | | +| 1090 | TDF-Destination-Realm | DiameterIdentity | | +| 1091 | TDF-IP-address | Address | | +| 1092 | ADC-Rule-Install | Grouped | | +| 1093 | ADC-Rule-Remove | Grouped | | +| 1094 | ADC-Rule-Definition | Grouped | | +| 1095 | ADC-Rule-Base-Name | UTF8String | | +| 1096 | ADC-Rule-Name | OctetString | | +| 1097 | ADC-Rule-Report | Grouped | | +| 1098 | Application-Detection-Information | Grouped | | +| 1099 | PS-to-CS-Session-Continuity | Enumerated | | +| Note: The AVP codes from 1083 to 1084 are reserved for TS 29.212 | | | | +| 1100 | Served-User-Identity | Groupe | 29.140 [16] | +| 1101 | VASP-ID | UTF8Str | | +| 1102 | VAS-ID | UTF8String | | +| 1103 | Trigger-Event | Enumerated | | +| 1104 | Sender-Address | UTF8String | | +| 1105 | Initial-Recipient-Address | Grouped | | +| 1106 | Result-Recipient-Address | Grouped | | +| 1107 | Sequence-Number | Unsigned32 | | +| 1108 | Recipient-Address | UTF8String | | +| 1109 | Routeing-Address | UTF8String | | + +| | | | | +|------------------------------------------------------------------|--------------------------------|-------------|------------| +| 1110 | Originating-Interface | Enumerated | | +| 1111 | Delivery-Report | Enumerated | | +| 1112 | Read-Reply | Enumerated | | +| 1113 | Sender-Visibility | Enumerated | | +| 1114 | Service-Key | UTF8String | | +| 1115 | Billing-Information | UTF8String | | +| 1116 | Status | Grouped | | +| 1117 | Status-Code | UTF8String | | +| 1118 | Status-Text | UTF8String | | +| Note: The AVP codes from 1119 to 1199 are reserved for TS 29.140 | | | | +| 1200 | Domain-Name | UTF8String | | +| 1201 | Recipient-Address | Grouped | | +| 1202 | Submission-Time | Time | | +| 1203 | MM-Content-Type | Grouped | | +| 1204 | Type-Number | Enumerated | | +| 1205 | Additional-Type-Information | UTF8String | | +| 1206 | Content-Size | Unsigned32 | | +| 1207 | Additional-Content-Information | Grouped | | +| 1208 | Addressee-Type | Enumerated | | +| 1209 | Priority | Enumerated | | +| 1210 | Message-ID | UTF8String | | +| 1211 | Message-Type | Enumerated | | +| 1212 | Message-Size | Unsigned32 | | +| 1213 | Message-Class | Grouped | | +| 1214 | Class-Identifier | Enumerated | | +| 1215 | Token-Text | UTF8String | | +| 1216 | Delivery-Report-Requested | Enumerated | | +| 1217 | Adaptations | Enumerated | | +| 1218 | Applic-ID | UTF8String | | +| 1219 | Aux-Applic-Info | UTF8String | | +| 1220 | Content-Class | Enumerated | | +| 1221 | DRM-Content | Enumerated | | +| 1222 | Read-Reply-Report-Requested | Enumerated | | +| 1223 | Reply-Applic-ID | UTF8String | | +| 1224 | File-Repair-Supported | Enumerated | | +| 1225 | MBMS-User-Service-Type | Enumerated | | +| 1226 | Unit-Quota-Threshold | Unsigned32 | | +| 1227 | PDP-Address | Address | 32.299 [5] | +| 1228 | SGSN-Address | Address | | +| 1229 | PoC-Session-Id | UTF8String | | +| 1230 | Deferred-Location-Even-Type | UTF8String | | +| 1231 | LCS-APN | UTF8String | | +| 1232 | LCS-Client-Id | Grouped | | +| 1233 | LCS-Client-Dialed-By-MS | UTF8String | | +| 1234 | LCS-Client-External-ID | UTF8String | | +| 1235 | LCS-Client-Name | Grouped | | +| 1236 | LCS-Data-Coding-Scheme | UTF8String | | +| 1237 | LCS-Format-Indicator | Enumerated | | +| 1238 | LCS-Name-String | UTF8String | | +| 1239 | LCS-Requestor-Id | Grouped | | +| 1240 | LCS-Requestor-Id-String | UTF8String | | +| 1241 | LCS-Client-Type | Enumerated | | +| 1242 | Location-Estimate | OctetString | | +| 1243 | Location-Estimate-Type | Enumerated | | +| 1244 | Location-Type | Grouped | | +| 1245 | Positioning-Data | UTF8String | | +| 1246 | Reserved | - | | +| 1247 | PDP-Context-Type | Enumerated | | +| 1248 | MMBox-Storage-Requested | Enumerated | | +| 1249 | Service-Specific-Info | Grouped | | +| 1250 | Called-Asserted-Identity | UTF8String | | +| 1251 | Requested-Party-Address | UTF8String | | +| 1252 | PoC-User-Role | Grouped | | +| 1253 | PoC-User-Role-IDs | UTF8String | | +| 1254 | PoC-User-Role-info-Units | Enumerated | | + +| | | | | +|-------------------------------------------------------------------|--------------------------------------|-------------|-------------| +| 1255 | Talk-Burst-Exchange | Grouped | | +| 1256 | Service-Generic-Information | Grouped | | +| 1257 | Service-Specific-Type | Unsigned32 | | +| 1258 | Event-Charging-TimeStamp | Time | | +| 1259 | Participant-Access-Priority | Enumerated | | +| 1260 | Participant-Group | Grouped | | +| 1261 | PoC-Change-Conditions | Enumerated | | +| 1262 | PoC-Change-Time | Time | | +| 1263 | Access-Network-Information | OctetString | | +| 1264 | Trigger | Grouped | | +| 1265 | Base-Time-Interval | Unsigned32 | | +| 1266 | Envelope | Grouped | | +| 1267 | Envelope-End-Time | Time | | +| 1268 | Envelope-Reporting | Enumerated | | +| 1269 | Envelope-Start-Time | Time | | +| 1270 | Time-Quota-Mechanism | Grouped | | +| 1271 | Time-Quota-Type | Enumerated | | +| 1272 | Early-Media-Description | Grouped | | +| 1273 | SDP-TimeStamps | Grouped | | +| 1274 | SDP-Offer-Timestamp | Time | | +| 1275 | SDP-Answer-Timestamp | Time | | +| 1276 | AF-Correlation-Information | Grouped | | +| 1277 | PoC-Session-Initiation-type | Enumerated | | +| 1278 | Offline-Charging | Grouped | | +| 1279 | User-Participating-Type | Enumerated | | +| 1280 | Alternate-Charged-Party-Address | UTF8String | | +| 1281 | IMS-Communication-Service-Identifier | UTF8String | | +| 1282 | Number-Of-Received-Talk-Bursts | Unsigned32 | | +| 1283 | Number-Of-Talk-Bursts | Unsigned32 | | +| 1284 | Received-Talk-Burst-Time | Unsigned32 | | +| 1285 | Received-Talk-Burst-Volume | Unsigned32 | | +| 1286 | Talk-Burst-Time | Unsigned32 | | +| 1287 | Talk-Burst-Volume | Unsigned32 | | +| 1288 | Media-Initiator-Party | UTF8String | | +| Note: The AVP codes from 1289 to 1299 are reserved for TS 32.299 | | | | +| 1300 | PC5-Radio-Technology | Enumerated | | +| 1301 | RAN-End-Time | Time | | +| 1302 | RAN-Secondary-RAT-Usage-Report | Grouped | | +| 1303 | RAN-Start-Time | Time | | +| 1304 | Secondary-RAT-Type | OctetString | | +| 1305 | Civic-Address-Information | UTF8String | | +| 1306 | WLAN-Operator-Id | Grouped | | +| 1307 | WLAN-Operator-Name | UTF8String | | +| 1308 | WLAN-PLMN-Id | UTF8String | | +| 1309 | API-Content | UTF8String | | +| 1310 | API-Direction | Enumerated | | +| 1311 | API-Identifier | OctetString | | +| 1312 | API-Invocation-Timestamp | Time | | +| 1313 | API-Result-Code | Unsigned32 | | +| 1314 | API-Size | Unsigned64 | | +| 1315 | API-Network-Service-Node | Enumerated | | +| 1316 | Exposure-Function-API-Information | Grouped | | +| 1317 | SCEF-Address | Address | | +| 1318 | TLTRI | Unsigned32 | | +| 1319 | TTRI | Unsigned32 | | +| 1320 | 3GPP-OC-Specific-Reduction | Grouped | | +| 1321 | 3GPP-OC-Rating-Group | Unsigned32 | | +| 1322 | 3GPP-OC-Request-Type | Enumerated | | +| 1323 | VoLTE-Information | Grouped | | +| Note: The AVP codes from 1324 to 1399 are reserved for TS 32.229. | | | | +| 1400 | Subscription-Data | Grouped | | +| 1401 | Terminal-Information | Grouped | | +| 1402 | IMEI | UTF8String | 29.272 [21] | +| 1403 | Software-Version | UTF8String | | +| 1404 | QoS-Subscribed | UTF8String | | + +| | | | +|------|-----------------------------------------------|-------------| +| 1405 | ULR-Flags | Unsigned32 | +| 1406 | ULA-Flags | Unsigned32 | +| 1407 | Visited PLMN Id | OctetString | +| 1408 | Requested-EUTRAN-Authentication-Info | Grouped | +| 1409 | Requested-UTRAN- GERAN-Authentication-Info | Grouped | +| 1410 | Number-Of-Requested-Vectors | Unsigned32 | +| 1411 | Re-Synchronization-Info | OctetString | +| 1412 | Immediate-Response-Preferred | Unsigned32 | +| 1413 | Authentication-Info | Grouped | +| 1414 | E-UTRAN-Vector | Grouped | +| 1415 | UTRAN-Vector | Grouped | +| 1416 | GERAN-Vector | Grouped | +| 1417 | Network-Access-Mode | Enumerated | +| 1418 | HPLMN-ODB | Enumerated | +| 1419 | Item-Number | Unsigned32 | +| 1420 | Cancellation-Type | Enumerated | +| 1421 | DSR-Flags | Unsigned32 | +| 1422 | DSA-Flags | Unsigned32 | +| 1423 | Context-Identifier | Unsigned32 | +| 1424 | Subscriber-Status | Enumerated | +| 1425 | Operator-Determined-Barring | Unsigned32 | +| 1426 | Access-Restriction-Data | Unsigned32 | +| 1427 | APN-OI-Replacement | UTF8String | +| 1428 | All-APN-Configurations-Included-Indicator | Enumerated | +| 1429 | APN-Configuration-Profile | Grouped | +| 1430 | APN-Configuration | Grouped | +| 1431 | EPS-Subscribed-QoS-Profile | Grouped | +| 1432 | VPLMN-Dynamic-Address-Allowed | Enumerated | +| 1433 | STN-SR | OctetString | +| 1434 | Alert-Reason | Enumerated | +| 1435 | AMBR | Grouped | +| 1436 | CSG-Subscription-Data | Grouped | +| 1437 | CSG-Id | Unsigned32 | +| 1438 | PDN-GW-Allocation-Type | Enumerated | +| 1439 | Expiration-Date | Time | +| 1440 | RAT-Frequency-Selection-Priority-ID | Unsigned32 | +| 1441 | IDA-Flags | Unsigned32 | +| 1442 | PUA-Flags | Unsigned32 | +| 1443 | NOR-Flags | Unsigned32 | +| 1444 | User-Id | UTF8String | +| 1445 | Equipment-Status | Enumerated | +| 1446 | Regional-Subscription-Zone-Code | OctetString | +| 1447 | RAND | OctetString | +| 1448 | XRES | OctetString | +| 1449 | AUTN | OctetString | +| 1450 | KASME | OctetString | +| 1451 | Reserved | - | +| 1452 | Trace-Collection-Entity | Address | +| 1453 | Kc | OctetString | +| 1454 | SRES | OctetString | +| 1455 | Reserved | - | +| 1456 | PDN-Type | Enumerated | +| 1457 | Roaming-Restricted-Due-To-Unsupported-Feature | Enumerated | +| 1458 | Trace-Data | Grouped | +| 1459 | Trace-Reference | OctetString | +| 1460 | Reserved | - | +| 1461 | Reserved | - | +| 1462 | Trace-Depth | Enumerated | +| 1463 | Trace-NE-Type-List | OctetString | +| 1464 | Trace-Interface-List | OctetString | +| 1465 | Trace-Event-List | OctetString | +| 1466 | OMC-Id | OctetString | +| 1467 | GPRS-Subscription-Data | Grouped | +| 1468 | Complete-Data-List-Included-Indicator | Enumerated | +| 1469 | PDP-Context | Grouped | + +| | | | | +|------|---------------------------------------------------|-------------|-------------| +| 1470 | PDP-Type | OctetString | | +| 1471 | 3GPP2-MEID | OctetString | | +| 1472 | Specific-APN-Info | Grouped | | +| 1473 | LCS-Info | Grouped | | +| 1474 | GMLC-Number | OctetString | | +| 1475 | LCS-PrivacyException | Grouped | | +| 1476 | SS-Code | OctetString | | +| 1477 | SS-Status | OctetString | | +| 1478 | Notification-To-UE-User | Enumerated | | +| 1479 | External-Client | Grouped | | +| 1480 | Client-Identity | OctetString | | +| 1481 | GMLC-Restriction | Enumerated | | +| 1482 | PLMN-Client | Enumerated | | +| 1483 | Service-Type | Grouped | | +| 1484 | ServiceTypeIdentity | Unsigned32 | | +| 1485 | MO-LR | Grouped | | +| 1486 | Teleservice-List | Grouped | | +| 1487 | TS-Code | Enumerated | | +| 1488 | Call-Barring-Info | Grouped | | +| 1489 | SGSN-Number | OctetString | | +| 1490 | IDR-Flags | Unsigned32 | | +| 1491 | ICS-Indicator | Enumerated | | +| 1492 | IMS-Voice-Over-PS-Sessions-Supported | Enumerated | | +| 1493 | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | Enumerated | | +| 1494 | Last-UE-Activity-Time | Time | | +| 1495 | EPS-User-State | Grouped | | +| 1496 | EPS-Location-Information | Grouped | | +| 1497 | MME-User-State | Grouped | | +| 1498 | SGSN-User-State | Grouped | | +| 1499 | User-State | Enumerated | | +| | | | | +| 1500 | Non-3GPP-User-Data | Grouped | 29.273 [20] | +| 1501 | Non-3GPP-IP-Access | Enumerated | | +| 1502 | Non-3GPP-IP-Access-APN | Enumerated | | +| 1503 | AN-Trusted | Enumerated | | +| 1504 | ANID | UTF8String | | +| 1505 | Trace-Info | Grouped | | +| 1506 | MIP-FA-RK | OctetString | | +| 1507 | MIP-FA-RK-SPI | Unsigned32 | | +| 1508 | PPR-Flags | Unsigned32 | | +| 1509 | WLAN-Identifier | Grouped | | +| 1510 | TWAN-Access-Info | Grouped | | +| 1511 | Access-Authorization-Flags | Unsigned32 | | +| 1512 | TWAN-Default-APN-Context-Id | Unsigned32 | | +| 1513 | Reserved | - | | +| 1514 | Reserved | - | | +| 1515 | Reserved | - | | +| 1516 | Full-Network-Name | OctetString | | +| 1517 | Short-Network-Name | OctetString | | +| 1518 | AAA-Failure-Indication | Unsigned32 | | +| 1519 | Transport-Access-Type | Enumerated | | +| 1520 | DER-Flags | Unsigned32 | | +| 1521 | DEA-Flags | Unsigned32 | | +| 1522 | RAR-Flags | Unsigned32 | | +| 1523 | DER-S6b-Flags | Unsigned32 | | +| 1524 | SSID | UTF8String | | +| 1525 | HESSID | UTF8String | | +| 1526 | Access-Network-Info | Grouped | | +| 1527 | TWAN-Connection-Mode | Unsigned32 | | +| 1528 | TWAN-Connectivity-Parameters | Grouped | | +| 1529 | Connectivity-Flags | Unsigned32 | | +| | | | | +| 1530 | TWAN-PCO | OctetString | | +| 1531 | TWAG-CP-Address | Address | | +| 1532 | TWAG-UP-Address | UTF8String | | +| 1533 | TWAN-S2a-Failure-Cause | Unsigned32 | | + +| | | | | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|------------------|--| +| 1534 | SM-Back-Off-Timer | Unsigned32 | | +| 1535 | WLCP-Key | OctetString | | +| 318 | 3GPP-AAA-Server-Name | DiameterIdentity | | +| 1536 | Origination-Time-Stamp | Unsigned64 | | +| 1537 | Maximum-Wait-Time | Unsigned32 | | +| 1538 | Emergency-Services | Unsigned32 | | +| 1539 | AAR-Flags | Unsigned32 | | +| 1540 | IMEI-Check-In-VPLMN-Result | Unsigned32 | | +| 1541 | ERP-Authorization | Unsigned32 | | +| 1542 | High-Priority-Access-Info | Unsigned32 | | +| Note 1: The AVP codes from 1543 to 1599 are reserved for TS 29.273 | | | | +| Note 2: The AVP 3GPP-AAA-Server-Name was originally defined in 3GPP TS 29.234 and is now defined in 3GPP TS 29.273 from Rel-12. | | | | +| 1600 | MME-Location-Information | Grouped | | +| 1601 | SGSN-Location-Information | Grouped | | +| 1602 | E-UTRAN-Cell-Global-Identity | OctetString | | +| 1603 | Tracking-Area-Identity | OctetString | | +| 1604 | Cell-Global-Identity | OctetString | | +| 1605 | Routing-Area-Identity | OctetString | | +| 1606 | Location-Area-Identity | OctetString | | +| 1607 | Service-Area-Identity | OctetString | | +| 1608 | Geographical-Information | OctetString | | +| 1609 | Geodetic-Information | OctetString | | +| 1610 | Current-Location-Retrieved | Enumerated | | +| 1611 | Age-Of-Location-Information | Unsigned32 | | +| 1612 | Active-APN | Grouped | | +| 1613 | SIPTO-Permission | Enumerated | | +| 1614 | Error-Diagnostic | Enumerated | | +| 1615 | UE-SRVCC-Capability | Enumerated | | +| 1616 | MPS-Priority | Unsigned32 | | +| 1617 | VPLMN-LIPA-Allowed | Enumerated | | +| 1618 | LIPA-Permission | Enumerated | | +| 1619 | Subscribed-Periodic-RAU-TAU-Timer | Unsigned32 | | +| 1620 | Ext-PDP-Type | OctetString | | +| 1621 | Ext-PDP-Address | Address | | +| 1622 | MDT-Configuration | Grouped | | +| 1623 | Job-Type | Enumerated | | +| 1624 | Area-Scope | Grouped | | +| 1625 | List-Of-Measurements | Unsigned32 | | +| 1626 | Reporting-Trigger | Unsigned32 | | +| 1627 | Report-Interval | Enumerated | | +| 1628 | Report-Amount | Enumerated | | +| 1629 | Event-ThresholdRSRP | Unsigned32 | | +| 1630 | Event-ThresholdRSRQ | Unsigned32 | | +| 1631 | Logging-Interval | Enumerated | | +| 1632 | Logging-Duration | Enumerated | | +| 1633 | Relay-Node-Indicator | Enumerated | | +| 1634 | MDT-User-Consent | Enumerated | | +| 1635 | PUR-Flags | Unsigned32 | | +| 1636 | Subscribed-VSRVCC | Enumerated | | +| 1637 | Equivalent-PLMN-List | Grouped | | +| 1638 | CLR-Flags | Unsigned32 | | +| 1639 | UVR-Flags | Unsigned32 | | +| 1640 | UVA-Flags | Unsigned32 | | +| 1641 | VPLMN-CSG-Subscription-Data | Grouped | | +| 1642 | Time-Zone | UTF8String | | +| 1643 | A-MSISDN | OctetString | | +| 1644 | Reserved | - | | +| 1645 | MME-Number-for-MT-SMS | OctetString | | +| 1646 | Reserved | - | | +| 1647 | Reserved | - | | +| 1648 | SMS-Register-Request | Enumerated | | +| 1649 | Local-Time-Zone | Grouped | | +| 1650 | Daylight-Saving-Time | Enumerated | | +| 1651 | GMLC-Info | Grouped | | + +29.272 +[21] + +| | | | +|------|------------------------------------------|------------------| +| 1652 | GMLC-Name | DiameterIdentity | +| 1653 | GMLC-Realm | DiameterIdentity | +| 1654 | Subscription-Data-Flags | Unsigned32 | +| 1655 | Measurement-Period-LTE | Enumerated | +| 1656 | Measurement-Period-UMTS | Enumerated | +| 1657 | Collection-Period-RRM-LTE | Enumerated | +| 1658 | Collection-Period-RRM-UMTS | Enumerated | +| 1659 | Positioning-Method | OctetString | +| 1660 | Measurement-Quantity | OctetString | +| 1661 | Event-Threshold-Event-1F | Integer32 | +| 1662 | Event-Threshold-Event-1I | Integer32 | +| 1663 | Restoration-Priority | Unsigned32 | +| 1664 | SGs-MME-Identity | UTF8String | +| 1665 | SIPTO-Local-Network-Permission | Unsigned32 | +| 1666 | Coupled-Node-Diameter-ID | DiameterIdentity | +| 1667 | WLAN-offloadability | Grouped | +| 1668 | WLAN-offloadability-EUTRAN | Unsigned32 | +| 1669 | WLAN-offloadability-UTRAN | Unsigned32 | +| 1670 | Reset-ID | OctetString | +| 1671 | MDT-Allowed-PLMN-Id | OctetString | +| 1672 | Adjacent-PLMNs | Grouped | +| 1673 | Adjacent-Access-Restriction-Data | Grouped | +| 1674 | DL-Buffering-Suggested-Packet-Count | Integer32 | +| 1675 | IMSI-Group-Id | Grouped | +| 1676 | Group-Service-Id | Unsigned32 | +| 1677 | Group-PLMN-Id | OctetString | +| 1678 | Local-Group-Id | OctetString | +| 1679 | AIR-Flags | Unsigned32 | +| 1680 | UE-Usage-Type | Unsigned32 | +| 1681 | Non-IP-PDN-Type-Indicator | Enumerated | +| 1682 | Non-IP-Data-Delivery-Mechanism | Unsigned32 | +| 1683 | Additional-Context-Identifier | Unsigned32 | +| 1684 | SCEF-Realm | DiameterIdentity | +| 1685 | Subscription-Data-Deletion | Grouped | +| 1686 | Preferred-Data-Mode | Unsigned32 | +| 1687 | Emergency-Info | Grouped | +| 1688 | V2X-Subscription-Data | Grouped | +| 1689 | V2X-Permission | Unsigned32 | +| 1690 | PDN-Connection-Continuity | Unsigned32 | +| 1691 | eDRX-Cycle-Length | Grouped | +| 1692 | eDRX-Cycle-Length-Value | OctetString | +| 1693 | UE-PC5-AMBR | Unsigned32 | +| 1694 | MBSFN-Area | Grouped | +| 1695 | MBSFN-Area-ID | Unsigned32 | +| 1696 | Carrier-Frequency | Unsigned32 | +| 1697 | RDS-Indicator | Enumerated | +| 1698 | Service-Gap-Time | Unsigned32 | +| 1699 | Aerial-UE-Subscription-Information | Unsigned32 | +| 1700 | Broadcast-Location-Assistance-Data-Types | Unsigned64 | +| 1701 | Paging-Time-Window | Grouped | +| 1702 | Operation-Mode | Unsigned32 | +| 1703 | Paging-Time-Window-Length | OctetString | +| 1704 | Core-Network-Restrictions | Unsigned32 | +| 1705 | eDRX-Related-RAT | Grouped | +| 1706 | Interworking-5GS-Indicator | Enumerated | +| 1707 | Ethernet-PDN-Type-Indicator | Enumerated | +| 1708 | Subscribed-ARPI | Unsigned32 | +| 1709 | IAB-Operation-Permission | Enumerated | +| 1710 | V2X-Subscription-Data-Nr | Grouped | +| 1711 | UE-PC5-QoS | Grouped | +| 1712 | PC5-QoS-Flow | Grouped | +| 1713 | 5QI | Integer32 | +| 1714 | PC5-Flow-Bitrates | Grouped | +| 1715 | Guaranteed-Flow-Bitrates | Integer32 | +| 1716 | Maximum-Flow-Bitrates | Integer32 | + +| | | | | +|-------------------------------------------------------------------|----------------------------------------|-------------|------------| +| 1717 | PC5-Range | Integer32 | | +| 1718 | PC5-Link-AMBR | Integer32 | | +| 1719 | Third-Context-ID | Unsigned32 | | +| Note: The AVP codes from 1720 to 1799 are reserved for TS 29.272. | | | | +| 2000 | SMS-Information | Grouped | | +| 2001 | Data-Coding-Scheme | Integer32 | | +| 2002 | Destination-Interface | Grouped | | +| 2003 | Interface-Id | UTF8String | | +| 2004 | Interface-Port | UTF8String | | +| 2005 | Interface-Text | UTF8String | | +| 2006 | Interface-Type | Enumerated | | +| 2007 | SM-Message-Type | Enumerated | | +| 2008 | Originating-SCCP-Address | Address | | +| 2009 | Originator-Interface | Grouped | | +| 2010 | Recipient-SCCP-Address | Address | | +| 2011 | Reply-Path-Requested | Enumerated | | +| 2012 | SM-Discharge-Time | Time | | +| 2013 | SM-Protocol-ID | OctetString | | +| 2014 | SM-Status | OctetString | | +| 2015 | SM-User-Data-Header | OctetString | | +| 2016 | SMS-Node | Enumerated | | +| 2017 | SMSC-Address | Address | | +| 2018 | Client-Address | Address | | +| 2019 | Number-of-Messages-Sent | Unsigned32 | | +| 2020 | Low-Balance-Indication | Enumerated | | +| 2021 | Remaining-Balance | Grouped | | +| 2022 | Refund-Information | OctetString | | +| 2023 | Carrier-Select-Routing-Information | UTF8String | | +| 2024 | Number-Portability-Routing-Information | UTF8String | | +| 2025 | PoC-Event-Type | Enumerated | | +| 2026 | Recipient-Info | Grouped | | +| 2027 | Originator-Received-Address | Grouped | | +| 2028 | Recipient-Received-Address | Grouped | | +| 2029 | SM-Service-Type | Enumerated | | +| 2030 | MMTel-Information | Grouped | 32.299 [5] | +| 2031 | MMTel-Sservice-Type | Unsigned32 | | +| 2032 | Service-Mode | Unsigned32 | | +| 2033 | Subscriber-Role | Enumerated | | +| 2034 | Number-Of-Divertions | Unsigned32 | | +| 2035 | Associated-Party-Address | UTF8String | | +| 2036 | SDP-Type | Enumerated | | +| 2037 | Change-Condition | Integer32 | | +| 2038 | Change-Time | Time | | +| 2039 | Diagnostics | Integer32 | | +| 2040 | Service-Data-Container | Grouped | | +| 2041 | Start-Time | Time | | +| 2042 | Stop-Time | Time | | +| 2043 | Time-First-Usage | Time | | +| 2044 | Time-Last-Usage | Time | | +| 2045 | Time-Usage | Unsigned32 | | +| 2046 | Traffic-Data-Volumes | Grouped | | +| 2047 | Serving-Node-Type | Enumerated | | +| 2048 | Supplementary-Service | Grouped | | +| 2049 | Participant-Action-Type | Enumerated | | +| 2050 | PDN-Connection-Charging-ID | Unsigned32 | | +| 2051 | Dynamic-Address-Flag | Enumerated | | +| 2052 | Accumulated-Cost | Grouped | | +| 2053 | AoC-Cost-Information | Grouped | | +| 2054 | AoC-Information | Grouped | | +| 2055 | AoC-Request-Type | Enumerated | | +| 2056 | Current-Tariff | Grouped | | +| 2057 | Next-Tariff | Grouped | | +| 2058 | Rate-Element | Grouped | | +| 2059 | Scale-Factor | Grouped | | +| 2060 | Tariff-Information | Grouped | | + +| | | | | +|-------------------------------------------------------------------|------------------------------------------|------------------|------------| +| 2061 | Unit-Cost | Grouped | | +| 2062 | Incremental-Cost | Grouped | | +| 2063 | Local-Sequence-Number | Unsigned32 | | +| 2064 | Node-Id | UTF8String | | +| 2065 | SGW-Change | Enumerated | | +| 2066 | Charging-Characteristic-Selection-Mode | Enumerated | | +| 2067 | SGW-Address | Address | | +| 2068 | Dynamic-Address-Flag-Extension | Enumerated | | +| Note: The AVP codes from 2069 to 2099 are reserved for TS 32.299. | | | | +| 2100 | reserved | - | | +| 2101 | Application-Server-ID | UTF8String | | +| 2102 | Application-Service-Type | Enumerated | | +| 2103 | Application-Session-ID | Unsigned32 | | +| 2104 | Delivery-Status | UTF8String | | +| 2105 | reserved | - | | +| 2106 | reserved | - | | +| 2107 | reserved | - | | +| 2108 | reserved | - | | +| 2109 | reserved | - | 32.299 [5] | +| 2110 | IM-Information | Grouped | | +| 2111 | Number-Of-Messages-Successfully-Exploded | Unsigned32 | | +| 2112 | Number-Of-Messages-Successfully-Sent | Unsigned32 | | +| 2113 | Total-Number-Of-Messages-Exploded | Unsigned32 | | +| 2114 | Total-Number-Of-Messages-Sent | Unsigned32 | | +| 2115 | DCD-Information | Grouped | | +| 2116 | Content-ID | UTF8String | | +| 2117 | Content-provider-ID | UTF8String | | +| 2118 | Charge-Reason-Code | Enumerated | | +| Note: The AVP codes from 2119 to 2199 are reserved for TS 32.299. | | | | +| 2200 | Subsession-Decision-Info | Grouped | | +| 2201 | Subsession-Enforcement-Info | Grouped | | +| 2202 | Subsession-Id | Unsigned32 | | +| 2203 | Subsession-Operation | Enumerated | | +| 2204 | Multiple-BBERF-Action | Enumerated | | +| 2205 | UE-Local-IPv6-Prefix | OctetString | | +| 2206 | DRA-Deployment | Enumerated | | +| 2207 | PCRF-Address | DiameterIdentity | | +| 2208 | DRA-Binding | Enumerated | | +| Note: The AVP codes from 2209 to 2299 are reserved for TS 29.215. | | | | +| 2300 | reserved | - | | +| 2301 | SIP-Request-Timestamp-Fraction | Unsigned32 | | +| 2302 | SIP-Response-Timestamp-Fraction | Unsigned32 | | +| 2303 | Online-Charging-Flag | Enumerated | | +| 2304 | CUG-Information | OctetString | | +| 2305 | Real-Time-Tariff-Information | Grouped | | +| 2306 | Tariff-XML | UTF8String | | +| 2307 | MBMS GW-Address | Address | | +| 2308 | IMSI-Unauthenticated-Flag | Enumerated | | +| 2309 | Account-Expiration | Time | | +| 2310 | AoC-Format | Enumerated | | +| 2311 | AoC-Service | Enumerated | | +| 2312 | AoC-Service-Obligatory-Type | Grouped | | +| 2313 | AoC-Service-Type | Enumerated | | +| 2314 | AoC-Subscription-Information | Grouped | | +| 2315 | Preferred-AoC-Currency | Unsigned32 | | +| 2316 | Reserved | - | | +| 2317 | CSG-Access-Mode | Enumerated | | +| 2318 | CSG-Membership-Indication | Enumerated | | +| 2319 | User-CSG-Information | Grouped | | +| 2320 | Outgoing-Session-Id | UTF8String | | +| 2321 | Initial-IMS-Charging-Identifier | UTF8String | | +| 2322 | IMS-Emergency-Indicator | Enumerated | | +| 2323 | MBMS-Charged-Party | Enumerated | | +| Note: The AVP codes from 2324 to 2399 are reserved for TS 32.299. | | | | +| 2400 | LMSI | OctetString | 29.173 | + +| | | | | +|-------------------------------------------------------------------|-------------------------------------|------------------|----------------| +| 2401 | Serving-Node | Grouped | [25] | +| 2402 | MME-Name | DiameterIdentity | | +| 2403 | MSC-Number | OctetString | | +| 2404 | LCS-Capabilities-Sets | Unsigned32 | | +| 2405 | GMLC-Address | Address | | +| 2406 | Additional-Serving-Node | Grouped | | +| 2407 | PPR-Address | Address | | +| 2408 | MME-Realm | DiameterIdentity | | +| 2409 | SGSN-Name | DiameterIdentity | | +| 2410 | SGSN-Realm | DiameterIdentity | | +| 2411 | RIA-Flags | Unsigned32 | | +| Note: The AVP codes from 2412 to 2499 are reserved for TS 29.173. | | | | +| 2500 | SLG-Location-Type | Enumerated | 29.172
[24] | +| 2501 | LCS-EPS-Client-Name | Grouped | | +| 2502 | LCS-Requestor-Name | Grouped | | +| 2503 | LCS-Priority | Unsigned32 | | +| 2504 | LCS-QoS | Grouped | | +| 2505 | Horizontal-Accuracy | Unsigned32 | | +| 2506 | Vertical-Accuracy | Unsigned32 | | +| 2507 | Vertical-Requested | Enumerated | | +| 2508 | Velocity-Requested | Enumerated | | +| 2509 | Response-Time | Enumerated | | +| 2510 | Supported-GAD-Shapes | Unsigned32 | | +| 2511 | LCS-Codeword | UTF8String | | +| 2512 | LCS-Privacy-Check | Enumerated | | +| 2513 | Accuracy-Fulfilment-Indicator | Enumerated | | +| 2514 | Age-Of-Location-Estimate | Unsigned32 | | +| 2515 | Velocity-Estimate | OctetString | | +| 2516 | EUTRAN-Positioning-Data | OctetString | | +| 2517 | ECGI | OctetString | | +| 2518 | Location-Event | Enumerated | | +| 2519 | Pseudonym-Indicator | Enumerated | | +| 2520 | LCS-Service-Type-ID | Unsigned32 | | +| 2521 | LCS-Privacy-Check-Non-Session | Grouped | | +| 2522 | LCS-Privacy-Check-Session | Grouped | | +| 2523 | LCS-QoS-Class | Enumerated | | +| 2524 | GERAN-Positioning-Info | Grouped | | +| 2525 | GERAN-Positioning-Data | OctetString | | +| 2526 | GERAN-GANSS-Positioning-Data | OctetString | | +| 2527 | UTRAN-Positioning-Info | Grouped | | +| 2528 | UTRAN-Positioning-Data | OctetString | | +| 2529 | UTRAN-GANSS-Positioning-Data | OctetString | | +| 2530 | LRR-Flags | Unsigned32 | | +| 2531 | LCS-Reference-Number | OctetString | | +| 2532 | Deferred-Location-Type | Unsigned32 | | +| 2533 | Area-Event-Info | Grouped | | +| 2534 | Area-Definition | Grouped | | +| 2535 | Area | Grouped | | +| 2536 | Area-Type | Unsigned32 | | +| 2537 | Area-Identification | Grouped | | +| 2538 | Occurrence-Info | Enumerated | | +| 2539 | Interval-Time | Unsigned32 | | +| 2540 | Periodic-LDR-Information | Grouped | | +| 2541 | Reporting-Amount | Unsigned32 | | +| 2542 | Reporting-Interval | Unsigned32 | | +| 2543 | Reporting-PLMN-List | Grouped | | +| 2544 | PLMN-ID-List | Grouped | | +| 2545 | PLR-Flags | Unsigned32 | | +| 2546 | PLA-Flags | Unsigned32 | | +| 2547 | Deferred-MT-LR-Data | Grouped | | +| 2548 | Termination-Cause | Unsigned32 | | +| 2549 | LRA-Flags | Unsigned32 | | +| 2550 | Periodic-Location-Support-Indicator | Enumerated | | +| 2551 | Prioritized-List-Indicator | Enumerated | | +| 2552 | ESMLC-Cell-Info | Grouped | | + +| | | | | +|-------------------------------------------------------------------|---------------------------------------|-------------|-------------| +| 2553 | Cell-Portion-ID | Unsigned32 | | +| 2554 | 1xRTT-RCID | OctetString | | +| 2555 | Delayed-Location-Reporting-Data | Grouped | | +| 2556 | Civic-Address | UTF8String | | +| 2557 | Barometric-Pressure | Unsigned32 | | +| 2558 | UTRAN-Additional-Positioning-Data | OctetString | | +| 2559 | Motion-Event-Info | Grouped | | +| 2560 | Linear-Distance | Unsigned32 | | +| 2561 | Maximum-Interval | Unsigned32 | | +| 2562 | Sampling-Interval | Unsigned32 | | +| 2563 | Reporting-Duration | Unsigned32 | | +| 2564 | Reporting-Location-Requirements | Unsigned32 | | +| 2565 | Additional-Area | Grouped | | +| 2566 | AMF-Instance-Id | UTF8String | | +| Note: The AVP codes from 2567 to 2599 are reserved for TS 29.172. | | | | +| 2600 | reserved | - | | +| 2601 | IMS-Application-Reference-Identifier | UTF8String | | +| 2602 | Low-Priority-Indicator | Enumerated | | +| 2603 | IP-Realm-Default-Indicator | Enumerated | 32.299 [5] | +| 2604 | Local-GW-Inserted-Indicator | Enumerated | | +| 2605 | Transcoder-Inserted-Indicator | Enumerated | | +| 2606 | PDP-Address-Prefix-Length | Unsigned32 | | +| Note: The AVP codes from 2607 to 2699 are reserved for TS 32.299. | | | | +| 2700 | Reserved | - | | +| 2701 | Transit-IOI-List | UTF8String | | +| 2702 | Status-AS-Code | Enumerated | | +| 2703 | NNI-Information | Grouped | | +| 2704 | NNI-Type | Enumerated | | +| 2705 | Neighbour-Node-Address | Address | | +| 2706 | Relationship-Mode | Enumerated | | +| 2707 | Session-Direction | Enumerated | | +| 2708 | From-Address | UTF8String | 32.299 [5] | +| 2709 | Access-Transfer-Information | Grouped | | +| 2710 | Access-Transfer-Type | Enumerated | | +| 2711 | Related-IMS-Charging-Identifier | UTF8String | | +| 2712 | Related-IMS-Charging-Identifier-Node | Address | | +| 2713 | IMS-Visited-Network-Identifier | UTF8String | | +| 2714 | TWAN-User-Location-Info | Grouped | | +| 2715 | Reserved | - | | +| 2716 | BSSID | UTF8String | | +| 2717 | TAD-Identifier | Enumerated | | +| Note: The AVP codes from 2718 to 2799 are reserved for TS 32.299. | | | | +| 2800 | Reserved | - | | +| 2801 | ADC-Revalidation-Time | Time | | +| 2802 | TDF-Application-Instance-Identifier | OctetString | | +| 2803 | HeNB-BBF-FQDN | UTF8String | | +| 2804 | HeNB-Local-IP-Address | Address | | +| 2805 | UE-Local-IP-Address | Address | | +| 2806 | UDP-Source-Port | Unsigned32 | | +| 2807 | CS-Service-QoS-Request-Identifier | OctetString | | +| 2808 | CS-Service-QoS-Request-Operation | Enumerated | | +| 2809 | Mute-Notification | Enumerated | | +| 2810 | Monitoring-Time | Time | | +| 2811 | AN-GW-Status | Enumerated | 29.212 [19] | +| 2812 | User-Location-Info-Time | Grouped | | +| 2813 | CS-Service-Resource-Report | Time | | +| 2814 | CS-Service-Resource-Failure-Cause | Enumerated | | +| 2815 | CS-Service-Resource-Result-Operation | Enumerated | | +| 2816 | Default-QoS-Information | Grouped | | +| 2817 | Default-QoS-Name | UTF8String | | +| 2818 | Conditional-APN-Aggregate-Max-Bitrate | Grouped | | +| 2819 | RAN-NAS-Release-Cause | OctetString | | +| 2820 | Presence-Reporting-Area-Elements-List | OctetString | | +| 2821 | Presence-Reporting-Area-Identifier | OctetString | | +| 2822 | Presence-Reporting-Area-Information | Grouped | | + +| | | | | +|-------------------------------------------------------------------|---------------------------------------|------------------|----------------| +| 2823 | Presence-Reporting-Area-Status | Unsigned32 | | +| 2824 | NetLoc-Access-Support | Unsigned32 | | +| 2825 | Fixed-User-Location-Info | Grouped | | +| 2826 | PCSCF-Restoration-Indication | Unsigned32 | | +| 2827 | IP-CAN-Session-Charging-Scope | Enumerated | | +| 2828 | Monitoring-Flags | Unsigned32 | | +| 2829 | Default-Access | Enumerated | | +| 2830 | NBIFOM-Mode | Enumerated | | +| 2831 | NBIFOM-Support | Enumerated | | +| 2832 | RAN-Rule-Support | Unsigned32 | | +| 2833 | Access-Availability-Change-Reason | Unsigned32 | | +| 2834 | Routing-Rule-Failure-Code | Unsigned32 | | +| 2835 | Routing-Rule-Report | Grouped | | +| 2836 | Traffic-Steering-Policy-Identifier-DL | OctetString | | +| 2837 | Traffic-Steering-Policy-Identifier-UL | OctetString | | +| 2838 | Request-Type | Unsigned32 | | +| 2839 | Execution-Time | Time | | +| 2840 | Conditional-Policy-Information | Grouped | | +| 2841 | Resource-Release-Notification | Enumerated | | +| 2842 | Removal-Of-Access | Enumerated | | +| 2843 | TCP-Source-Port | Unsigned32 | | +| 2844 | Default-Bearer-Indication | Enumerated | | +| 2845 | PRA-Install | Grouped | | +| 2846 | PRA-Remove | Grouped | | +| 2847 | 3GPP-PS-Data-Off-Status | Enumerated | | +| 2848 | Extended-APN-AMBR-DL | Unsigned32 | | +| 2849 | Extended-APN-AMBR-UL | Unsigned32 | | +| 2850 | Extended-GBR-DL | Unsigned32 | | +| 2851 | Extended-GBR-UL | Unsigned32 | | +| 2852 | Max-PLR-DL | Unsigned32 | | +| 2853 | Max-PLR-UL | Unsigned32 | | +| 2854 | UE-Status | Unsigned32 | | +| Note: The AVP codes from 2855 to 2899 are reserved for TS 29.212. | | | | +| 2900 | reserved | - | | +| 2901 | Policy-Counter-Identifier | Grouped | 29.219
[26] | +| 2902 | Policy-Counter-Status | UTF8String | | +| 2903 | Policy-Counter-Status-Report | Grouped | | +| 2904 | SL-Request-Type | Enumerated | | +| 2905 | Pending-Policy-Counter-Information | Grouped | | +| 2906 | Pending-Policy-Counter-Change-Time | Time | | +| 2907 | SN-Request-Type | Unsigned32 | | +| Note: The AVP codes from 2908 to 2999 are reserved for TS 29.219. | | | | +| 3000 | reserved | - | | +| 3001 | Device-Action | Grouped | 29.368
[27] | +| 3002 | Device-Notification | Grouped | | +| 3003 | Trigger-Data | Grouped | | +| 3004 | Payload | OctetString | | +| 3005 | Action-Type | Enumerated | | +| 3006 | Priority-Indication | Enumerated | | +| 3007 | Reference-Number | Unsigned32 | | +| 3008 | Request-Status | Enumerated | | +| 3009 | Delivery-Outcome | Enumerated | | +| 3010 | Application-Port-Identifier | Unsigned32 | | +| 3011 | Old-Reference-Number | Unsigned32 | | +| 3012 | Feature-Supported-In-Final-Target | Unsigned32 | | +| Note: The AVP codes from 3013 to 3099 are reserved for TS 29.368. | | | | +| 3100 | IP-SM-GW-Number | OctetString | 29.336
[28] | +| 3101 | IP-SM-GW-Name | DiameterIdentity | | +| 3102 | User-Identifier | Grouped | | +| 3103 | Service-ID | Enumerated | | +| 3104 | SCS-Identity | OctetString | | +| 3105 | Service-Parameters | Grouped | | +| 3106 | T4-Parameters | Grouped | | +| 3107 | Service-Data | Grouped | | +| 3108 | T4-Data | Grouped | | + +| | | | +|------|------------------------------------------|------------------| +| 3109 | HSS-Cause | Unsigned32 | +| 3110 | SIR-Flags | Unsigned32 | +| 3111 | External-Identifier | UTF8String | +| 3112 | IP-SM-GW-Realm | DiameterIdentity | +| 3113 | AESE-Communication-Pattern | Grouped | +| 3114 | Communication-Pattern-Set | Grouped | +| 3115 | Periodic-Communication-Indicator | Unsigned32 | +| 3116 | Communication-Duration-Time | Unsigned32 | +| 3117 | Periodic-Time | Unsigned32 | +| 3118 | Scheduled-Communication-Time | Grouped | +| 3119 | Stationary-Indication | Unsigned32 | +| 3120 | AESE-Communication-Pattern-Config-Status | Grouped | +| 3121 | AESE-Error-Report | Grouped | +| 3122 | Monitoring-Event-Configuration | Grouped | +| 3123 | Monitoring-Event-Report | Grouped | +| 3124 | SCEF-Reference-ID | Unsigned32 | +| 3125 | SCEF-ID | DiameterIdentity | +| 3126 | SCEF-Reference-ID-for-Deletion | Unsigned32 | +| 3127 | Monitoring-Type | Unsigned32 | +| 3128 | Maximum-Number-of-Reports | Unsigned32 | +| 3129 | UE-Reachability-Configuration | Grouped | +| 3130 | Monitoring-Duration | Time | +| 3131 | Maximum-Detection-Time | Unsigned32 | +| 3132 | Reachability-Type | Unsigned32 | +| 3133 | Maximum-Latency | Unsigned32 | +| 3134 | Maximum-Response-Time | Unsigned32 | +| 3135 | Location-Information-Configuration | Grouped | +| 3136 | MONTE-Location-Type | Unsigned32 | +| 3137 | Accuracy | Unsigned32 | +| 3138 | Association-Type | Unsigned32 | +| 3139 | Roaming-Information | Unsigned32 | +| 3140 | Reachability-Information | Unsigned32 | +| 3141 | IMEI-Change | Unsigned32 | +| 3142 | Monitoring-Event-Config-Status | Grouped | +| 3143 | Supported-Service | Grouped | +| 3144 | Supported-Monitoring-Event | Unsigned64 | +| 3145 | CIR-Flags | Unsigned32 | +| 3146 | Service-Result | Grouped | +| 3147 | Service-Result-Code | Unsigned32 | +| 3148 | Reference-ID-Validity-Time | Time | +| 3149 | Event-handling | Unsigned32 | +| 3150 | NIDD-Authorization-Request | Grouped | +| 3151 | NIDD-Authorization-Response | Grouped | +| 3152 | Service-Report | Grouped | +| 3153 | Node-Type | Unsigned32 | +| 3154 | S6t-HSS-Cause | Unsigned32 | +| 3155 | Enhanced-Coverage-Restriction | Grouped | +| 3156 | Enhanced-Coverage-Restriction-Data | Grouped | +| 3157 | Restricted-PLMN-List | Grouped | +| 3158 | Allowed-PLMN-List | Grouped | +| 3159 | Requested-Validity-Time | Time | +| 3160 | Granted-Validity-Time | Time | +| 3161 | NIDD-Authorization-Update | Grouped | +| 3162 | Loss-Of-Connectivity-Reason | Unsigned32 | +| 3163 | Group-Reporting-Guard-Timer | Unsigned32 | +| 3164 | CIA-Flags | Unsigned32 | +| 3165 | Group-Report | Grouped | +| 3166 | Group-Report-Item | Grouped | +| 3167 | RIR-Flags | Unsigned32 | +| 3168 | Type-Of-External-Identifier | Unsigned32 | +| 3169 | APN-Validity-Time | Grouped | +| 3170 | Suggested-Network-Configuration | Grouped | +| 3171 | Monitoring-Event-Report-Status | Grouped | +| 3172 | PLMN-ID-Requested | Enumerated | +| 3173 | AdditionalIdentifiers | Grouped | + +| | | | | +|-------------------------------------------------------------------|-------------------------------------------|------------------|----------------| +| 3174 | NIR-Flags | Unsigned32 | | +| 3175 | Reporting-Time-Stamp | Time | | +| 3176 | Group-User-Identifier | Grouped | | +| 3177 | NIA-Flags | Unsigned32 | | +| 3178 | MTC-Provider-Info | Grouped | | +| 3179 | MTC-Provider-ID | UTF8String | | +| 3180 | PDN-Connectivity-Status-Configuration | Grouped | | +| 3181 | PDN-Connectivity-Status-Report | Grouped | | +| 3182 | PDN-Connectivity-Status-Type | Unsigned32 | | +| 3183 | Traffic-Profile | Unsigned32 | | +| 3184 | Updated-Network-Configuration | Grouped | | +| 3185 | Battery-Indicator | Unsigned32 | | +| 3186 | SCEF-Reference-ID-Ext | Unsigned64 | | +| 3187 | SCEF-Reference-ID-for-Deletion-Ext | Unsigned64 | | +| 3188 | Exclude-Identifiers | Grouped | | +| 3189 | Include-Identifiers | Grouped | | +| Note: The AVP codes from 3190 to 3199 are reserved for TS 29.336. | | | | +| 3200 | SM-Delivery-Outcome-T4 | Enumerated | 29.337
[29] | +| 3201 | Absent-Subscriber-Diagnostic-T4 | Enumerated | | +| 3202 | Trigger-Action | Unsigned32 | | +| 3203 | MTC-Error-Diagnostic | Unsigned32 | | +| Note: The AVP codes from 3204 to 3299 are reserved for TS 29.337. | | | | +| 3300 | SC-Address | OctetString | 29.338
[30] | +| 3301 | SM-RP-UI | OctetString | | +| 3302 | TFR-Flags | Unsigned32 | | +| 3303 | SM-Delivery- Failure-Cause | Grouped | | +| 3304 | SM-Enumerated-Delivery-Failure-Cause | Enumerated | | +| 3305 | SM-Diagnostic-Info | OctetString | | +| 3306 | SM-Delivery-Timer | Unsigned32 | | +| 3307 | SM-Delivery-Start-Time | Time | | +| 3308 | SM-RP-MTI | Enumerated | | +| 3309 | SM-RP-SMEA | OctetString | | +| 3310 | SRR-Flags | Unsigned32 | | +| 3311 | SM-Delivery-Not-Intended | Enumerated | | +| 3312 | MWD-Status | Unsigned32 | | +| 3313 | MME-Absent-User-Subscriber-Diagnostic-SM | Unsigned32 | | +| 3314 | MSC-Absent-User-Subscriber-Diagnostic-SM | Unsigned32 | | +| 3315 | SGSN-Absent-User-Subscriber-Diagnostic SM | Unsigned32 | | +| 3316 | SM-Delivery-Outcome | Grouped | | +| 3317 | MME-SM-Delivery-Outcome | Grouped | | +| 3318 | MSC-SM-Delivery-Outcome | Grouped | | +| 3319 | SGSN-SM-Delivery-Outcome | Grouped | | +| 3320 | IP-SM-GW-SM-Delivery-Outcome | Grouped | | +| 3321 | SM-Delivery-Cause | Enumerated | | +| 3322 | Absent-User-Diagnostic-SM | Unsigned32 | | +| 3323 | RDR-Flags | Unsigned32 | | +| 3324 | SMSMI-Correlation-ID | Unsigned32 | | +| 3325 | HSS-ID | UTF8String | | +| 3326 | Originating-SIP-URI | UTF8String | | +| 3327 | Destination-SIP-URI | UTF8String | | +| 3328 | OFR-Flags | Unsigned32 | | +| 3329 | Maximum-UE-Availability-Time | Time | | +| 3330 | Maximum-Retransmission-Time | Time | | +| 3331 | Requested-Retransmission-Time | Time | | +| 3332 | SMS-GMSC-Address | OctetString | | +| 3333 | SMS-GMSC-Alert-Event | Unsigned32 | | +| 3334 | SMSF-3GPP-Absent-User-Diagnostic-SM | Unsigned32 | | +| 3335 | SMSF-Non-3GPP-Absent-User-Diagnostic-SM | Unsigned32 | | +| 3336 | SMSF-3GPP-SM-Delivery-Outcome | Grouped | | +| 3337 | SMSF-Non-3GPP-SM-Delivery-Outcome | Grouped | | +| 3338 | SMSF-3GPP-Number | OctetString | | +| 3339 | SMSF-Non-3GPP-Number | OctetString | | +| 3340 | SMSF-3GPP-Name | DiameterIdentity | | +| 3341 | SMSF-Non-3GPP-Name | DiameterIdentity | | +| 3342 | SMSF-3GPP-Realm | DiameterIdentity | | + +| | | | | +|-------------------------------------------------------------------|--------------------------------------------------------|------------------|------------| +| 3343 | SMSF-Non-3GPP-Realm | DiameterIdentity | | +| 3344 | SMSF-3GPP-Address | Grouped | | +| 3345 | SMSF-Non-3GPP-Address | Grouped | | +| 3346 | SMSF-3GPP-SBI-Support-Indicator | Enumerated | | +| 3347 | SMSF-Non-3GPP-SBI-Support-Indicator | Enumerated | | +| 3348 | IP-SM-GW-SBI-Support-Indicator | Enumerated | | +| Note: The AVP codes from 3349 to 3399 are reserved for TS 29.338. | | | | +| 3400 | reserved | - | | +| 3401 | Reason-Header | UTF8String | | +| 3402 | Instance-Id | UTF8String | | +| 3403 | Route-Header-Received | UTF8String | | +| 3404 | Route-Header-Transmitted | UTF8String | | +| 3405 | SM-Device-Trigger-Information | Grouped | | +| 3406 | MTC-IWF-Address | Address | | +| 3407 | SM-Device-Trigger-Indicator | Enumerated | | +| 3408 | SM-Sequence-Number | Unsigned32 | | +| 3409 | SMS-Result | Unsigned32 | | +| 3410 | VCS-Information | Grouped | | +| 3411 | Basic-Service-Code | Grouped | | +| 3412 | Bearer-Capability | OctetString | | +| 3413 | Teleservice | OctetString | | +| 3414 | ISUP-Location-Number | OctetString | | +| 3415 | Forwarding-Pending | Enumerated | | +| 3416 | ISUP-Release-Cause | Unsigned32 | | +| 3417 | MSC-Address | OctetString | | +| 3418 | Network-Call-Reference-Number | OctetString | | +| 3419 | Start-of-Charging | Time | | +| 3420 | VLR-Number | OctetString | | +| 3421 | CN-Operator-Selection-Entity | Enumerated | | +| 3422 | ISUP-Cause-Diagnostics | OctetString | | +| 3423 | ISUP-Cause-Location | Unsigned32 | | +| 3424 | ISUP-Cause-Value | Unsigned32 | | +| 3425 | EPDG-Address | Address | | +| 3426 | Announcing-UE-HPLMN-Identifier | UTF8String | | +| 3427 | Announcing-UE-VPLMN-Identifier | UTF8String | | +| 3428 | Coverage-Status | Enumerated | | +| 3429 | Layer-2-Group-ID | OctetString | 32.299 [5] | +| 3430 | Monitored-PLMN-Identifier | UTF8String | | +| 3431 | Monitoring-UE-HPLMN-Identifier | UTF8String | | +| 3432 | Monitoring-UE-Identifier | UTF8String | | +| 3433 | Monitoring-UE-VPLMN-Identifier | UTF8String | | +| 3434 | ProSe-PC3-Control-Protocol-Cause | Integer32 | | +| 3435 | ProSe-PC3-EPC-Control-Protocol-Cause | Integer32 | | +| 3436 | Requested-PLMN-Identifier | UTF8String | | +| 3437 | Requestor-PLMN-Identifier | UTF8String | | +| 3438 | Role-Of-ProSe-Function | Enumerated | | +| 3439 | Usage-Information-Report-Sequence-Number | Integer32 | | +| 3440 | ProSe-3rd-Party-Application-ID | UTF8String | | +| 3441 | ProSe-Direct-Communication-Transmission-Data-Container | Grouped | | +| 3442 | ProSe-Direct-Discovery-Model | Enumerated | | +| 3443 | ProSe-Event-Type | Enumerated | | +| 3444 | ProSe-Function-IP-Address | Address | | +| 3445 | ProSe-Functionality | Enumerated | | +| 3446 | ProSe-Group-IP-Multicast-Addresses | Address | | +| 3447 | ProSe-Information | Grouped | | +| 3448 | ProSe-Range-Class | Enumerated | | +| 3449 | ProSe-Reason-For-Cancellation | Enumerated | | +| 3450 | ProSe-Request-Timestamp | Time | | +| 3451 | ProSe-Role-Of-UE | Enumerated | | +| 3452 | ProSe-Source-IP-Address | Address | | +| 3453 | ProSe-UE-ID | OctetString | | +| 3454 | Proximity-Alert-Indication | Enumerated | | +| 3455 | Proximity-Alert-Timestamp | Time | | +| 3456 | Proximity-Cancellation-Timestamp | Time | | +| 3457 | ProSe-Function-PLMN-Identifier | UTF8String | | + +| | | | | +|-------------------------------------------------------------------|-----------------------------------------------------|-------------|-------------| +| 3458 | Application-Specific-Data | OctetString | | +| 3459 | Coverage-Info | Grouped | | +| 3460 | Location-Info | Grouped | | +| 3461 | ProSe-Direct-Communication-Reception-Data-Container | Grouped | | +| 3462 | Radio-Frequency | OctetString | | +| 3463 | Radio-Parameter-Set-Info | Grouped | | +| 3464 | Radio-Parameter-Set-Values | OctetString | | +| 3465 | Radio-Resources-Indicator | Integer32 | | +| 3466 | Time-First-Reception | Time | | +| 3467 | Time-First-Transmission | Time | | +| 3468 | Transmitter-Info | Grouped | | +| Note: The AVP codes from 3469 to 3499 are reserved for TS 32.299. | | | | +| 3500 | BMSC-Address | Address | | +| 3501 | BMSC-Port | Unsigned32 | | +| 3502 | MBMS-Bearer-Event | Unsigned32 | | +| 3503 | MBMS-Bearer-Event-Notification | Grouped | | +| 3504 | MBMS-Bearer-Request | Grouped | | +| 3505 | MBMS-Bearer-Response | Grouped | | +| 3506 | MBMS-Bearer-Result | Unsigned32 | | +| 3507 | MBMS-Start-Time | Time | | +| 3508 | Radio-Frequency | Unsigned32 | | +| 3509 | TMGI-Allocation-Request | Grouped | | +| 3510 | TMGI-Allocation-Response | Grouped | | +| 3511 | TMGI-Allocation-Result | Unsigned32 | | +| 3512 | TMGI-Deallocation-Request | Grouped | | +| 3513 | TMGI-Deallocation-Response | Grouped | | +| 3514 | TMGI-Deallocation-Result | Unsigned32 | | +| 3515 | TMGI-Expiry | Grouped | | +| 3516 | TMGI-Number | Unsigned32 | | +| 3517 | MB2U-Security | Unsigned32 | | +| 3518 | Local-M1-Information | Grouped | | +| 3519 | Local-MB2-U-Information | Grouped | | +| 3520 | MBMS-eNB-IP-Multicast-Address | Address | | +| 3521 | MBMS-eNB-IPv6-Multicast-Address | Address | | +| 3522 | MBMS-GW-SSM-IP-Address | Address | | +| 3523 | MBMS-GW-SSM-IPv6-Address | Address | | +| 3524 | Common-Tunnel-Endpoint-Identifier | OctetString | | +| 3525 | FEC-Request | OctetString | | +| 3526 | ROHC-Request | Grouped | | +| 3527 | ROHC-Full-Header-Periodicity | Float32 | | +| 3528 | ROHC-Profile | Unsigned32 | | +| 3529 | Userplane-Protocol-Result | Grouped | | +| 3530 | ROHC-Result | Unsigned32 | | +| 3531 | FEC-Result | Unsigned32 | | +| 3532 | ROHC-Max-CID | Unsigned32 | | +| 3533 | MBMS-Bearer-Event-Diagnostic-Info | Unsigned32 | 29.468 [31] | +| Note: The AVP codes from 3534 to 3599 are reserved for TS 29.468. | | | | +| 3600 | Origin-App-Layer-User-Id | UTF8String | | +| 3601 | Target-App-Layer-User-Id | UTF8String | | +| 3602 | ProSe-Function-ID | OctetString | | +| 3603 | ProSe-Request-Type | Unsigned32 | | +| 3604 | PDUID | OctetString | | +| 3605 | Application-Data | UTF8String | | +| 3606 | Allowed-Suffixes-Number | Unsigned32 | | +| 3607 | Monitor-Target | Grouped | | +| 3608 | ProSe-Code-Suffix-Mask | Grouped | | +| 3609 | Suffix-Code | OctetString | | +| 3610 | Suffix-Mask | OctetString | | +| 3611 | Banned-User-Target | Grouped | | +| 3612 | Metadata-Indicator | Unsigned32 | 29.343 [32] | +| Note: The AVP codes from 3613 to 3699 are reserved for TS 29.343. | | | | +| 3701 | ProSe-Subscription-Data | Grouped | | +| 3702 | ProSe-Permission | Unsigned32 | | +| 3703 | ProSe-Allowed-PLMN | Grouped | | +| 3704 | ProSe-Direct-Allowed | Unsigned32 | 29.344 [33] | + +| | | | | +|-------------------------------------------------------------------|------------------------------------|-------------|--| +| 3705 | UPR-Flags | Unsigned32 | | +| 3706 | PNR-Flags | Unsigned32 | | +| 3707 | ProSe-Initial-Location-Information | Grouped | | +| 3708 | Authorized-Discovery-Range | Unsigned32 | | +| Note: The AVP codes from 3709 to 3799 are reserved for TS 29.344. | | | | +| 3800 | Reserved | | | +| 3801 | App-Layer-User-Id | UTF8String | | +| 3802 | Assistance-info | Grouped | | +| 3803 | Assistance-Info-Validity-Timer | Unsigned32 | | +| 3804 | Discovery-Type | Unsigned32 | | +| 3805 | Filter-Id | OctetString | | +| 3806 | MAC-Address | UTF8String | | +| 3807 | Match-Report | Grouped | | +| 3808 | Operating-Channel | Unsigned32 | | +| 3809 | P2P-Features | Unsigned32 | | +| 3810 | ProSe-App-Code | UTF8String | | +| 3811 | ProSe-App-Id | UTF8String | | +| 3812 | ProSe-App-Mask | UTF8String | | +| 3813 | ProSe-Discovery-Filter | Grouped | | +| 3814 | PRR-Flags | Unsigned32 | | +| 3815 | ProSe-Validity-Timer | Unsigned32 | | +| 3816 | Requesting-EPUID | UTF8String | | +| 3817 | Targeted-EPUID | UTF8String | | +| 3818 | Time-Window | Unsigned32 | | +| 3819 | WiFi-P2P-Assistance-Info | Grouped | | +| 3820 | WLAN-Assistance-Info | Grouped | | +| 3821 | WLAN-Link-Layer-Id | OctetString | | +| 3822 | WLAN-Link-Layer-Id-List | Grouped | | +| 3823 | Location-Update-Trigger | Grouped | | +| 3824 | Location-Update-Event-Type | Unsigned32 | | +| 3825 | Change-Of-Area-Type | Grouped | | +| 3826 | Location-Update-Event-Trigger | Unsigned32 | | +| 3827 | Report-Cardinality | Enumerated | | +| 3828 | Minimum-Interval-Time | Unsigned32 | | +| 3829 | Periodic-Location-Type | Grouped | | +| 3830 | Location-Report-Interval-Time | Unsigned32 | | +| 3831 | Total-Number-Of-Reports | Unsigned32 | | +| 3832 | Validity-Time-Announce | Unsigned32 | | +| 3833 | Validity-Time-Monitor | Unsigned32 | | +| 3834 | Validity-Time-Communication | Unsigned32 | | +| 3835 | ProSe-App-Code-Info | Grouped | | +| 3836 | MIC | OctetString | | +| 3837 | UTC-based-Counter | Unsigned32 | | +| 3838 | ProSe-Match-Refresh-Timer | Unsigned32 | | +| 3839 | ProSe-Metadata-Index-Mask | OctetString | | +| 3840 | App-Identifier | Grouped | | +| 3841 | OS-ID | OctetString | | +| 3842 | OS-App-ID | UTF8String | | +| 3843 | Requesting-RPAUID | UTF8String | | +| 3844 | Target-RPAUID | UTF8String | | +| 3845 | Target-PDUID | OctetString | | +| 3846 | ProSe-Restricted-Code | OctetString | | +| 3847 | ProSe-Restricted-Code-Suffix-Range | OctetString | | +| 3848 | Beginning-Suffix | OctetString | | +| 3849 | Ending-Suffix | OctetString | | +| 3850 | Discovery-Entry-ID | Unsigned32 | | +| 3851 | Match-Timestamp | Time | | +| 3852 | PMR-Flags | Unsigned32 | | +| 3853 | ProSe-Application-Metadata | UTF8String | | +| 3854 | Discovery-Auth-Request | Grouped | | +| 3855 | Discovery-Auth-Response | Grouped | | +| 3856 | Match-Request | Grouped | | +| 3857 | Match-Report-Info | Grouped | | +| 3858 | Banned-RPAUID | UTF8String | | +| 3859 | Banned-PDUID | OctetString | | + +29.345 +[34] + +| | | | | +|-------------------------------------------------------------------|-----------------------------------------|------------------|-------------| +| 3860 | Code-Receiving-Security-Material | Grouped | | +| 3861 | Code-Sending-Security-Material | Grouped | | +| 3862 | DUSK | OctetString | | +| 3863 | DUIK | OctetString | | +| 3864 | DUCK | OctetString | | +| 3865 | MIC-Check-indicator | Unsigned32 | | +| 3866 | Encrypted-Bitmask | OctetString | | +| 3867 | ProSe-App-Code-Suffix-Range | OctetString | | +| 3868 | PC5-tech | OctetString | | +| Note: The AVP codes from 3869 to 3899 are reserved for TS 29.345. | | | | +| 3900 | Reserved | | | +| 3901 | Enhanced-Diagnostics | Grouped | | +| 3902 | Inter-UE-Transfer | Enumerated | | +| 3903 | TWAG-Address | Address | | +| 3904 | Announcement-Information | Grouped | | +| 3905 | Announcement-Identifier | Unsigned32 | | +| 3906 | Announcement-Order | Unsigned32 | | +| 3907 | Variable-Part | Grouped | | +| 3908 | Variable-Part-Order | Unsigned32 | | +| 3909 | Variable-Part-Type | Unsigned32 | | +| 3910 | Variable-Part-Value | UTF8String | | +| 3911 | Time-Indicator | Unsigned32 | | +| 3912 | Quota-Indicator | Enumerated | | +| 3913 | Play-Alternative | Enumerated | | +| 3914 | Language | UTF8String | | +| 3915 | Privacy-Indicator | Enumerated | | +| 3916 | Called-Identity | UTF8String | | +| 3917 | Called-Identity-Change | Grouped | | +| 3918 | UWAN-User-Location-Info | Grouped | | +| 3919 | Monitoring-Event-Configuration-Activity | Integer32 | | +| 3920 | Monitoring-Event-Report-Data | Grouped | | +| 3921 | Monitoring-Event-Information | Grouped | 32.299 [5] | +| 3922 | Monitoring-Event-Functionality | Integer32 | | +| 3923 | Monitoring-Event-Report-Number | Unsigned32 | | +| 3924 | Cellular-Network-Information | OctetString | | +| 3925 | Related-Change-Condition-Information | Grouped | | +| 3926 | Related-Trigger | Grouped | | +| 3927 | CPDT-Information | Grouped | | +| 3928 | NIDD-Submission | Grouped | | +| 3929 | Serving-Node-Identity | DiameterIdentity | | +| 3930 | CP-CIoT-EPS-Optimisation-Indicator | Enumerated | | +| 3931 | SGi-PtP-Tunnelling-Method | Enumerated | | +| 3932 | UNI-PDU-CP-Only-Flag | Enumerated | | +| 3933 | APN-Rate-Control | Grouped | | +| 3934 | APN-Rate-Control-Downlink | Grouped | | +| 3935 | APN-Rate-Control-Uplink | Grouped | | +| 3936 | Additional-Exception-Reports | Enumerated | | +| 3937 | Rate-Control-Max-Message-Size | Unsigned32 | | +| 3938 | Rate-Control-Max-Rate | Unsigned32 | | +| 3939 | Rate-Control-Time-Unit | Unsigned32 | | +| 3940 | SCS-AS-Address | Grouped | | +| 3941 | SCS-Address | Address | | +| 3942 | SCS-Realm | DiameterIdentity | | +| Note: The AVP codes from 3943 to 3999 are reserved for TS 32.299. | | | | +| 4000 | Aggregated-Congestion-Info | Grouped | | +| 4001 | Aggregated-RUCI-Report | Grouped | | +| 4002 | Congestion-Level-Definition | Grouped | | +| 4003 | Congestion-Level-Range | Unsigned32 | | +| 4004 | Congestion-Level-Set-Id | Unsigned32 | | +| 4005 | Congestion-Level-Value | Unsigned32 | | +| 4006 | Congestion-Location-Id | Grouped | | +| 4007 | Conditional-Restriction | Unsigned32 | | +| 4008 | eNodeB-Id | OctetString | | +| 4009 | IMSI-List | OctetString | | +| 4010 | RCAF-Id | DiameterIdentity | 29.217 [35] | + +| | | | | +|-------------------------------------------------------------------|-----------------------------------------|-------------|----------------| +| 4011 | Reporting-Restriction | Unsigned32 | | +| 4012 | RUCI-Action | Unsigned32 | | +| 4013 | Extended-eNodeB-ID | OctetString | | +| Note: The AVP codes from 4014 to 4099 are reserved for TS 29.217. | | | | +| 4101 | Network-Congestion-Area-Report | Grouped | 29.153
[37] | +| 4102 | Ns-Request-Type | Unsigned32 | | +| Note: The AVP codes from 4103 to 4199 are reserved for TS 29.153. | | | | +| 4201 | Network-Area-Info-List | OctetString | 29.154
[38] | +| 4202 | Reference-Id | OctetString | | +| 4203 | Transfer-Request-Type | Unsigned32 | | +| 4204 | Time-Window | Grouped | | +| 4205 | Transfer-End-Time | Time | | +| 4206 | Transfer-Start-Time | Time | | +| 4207 | Transfer-Policy | Grouped | | +| 4208 | Transfer-Policy-Id | Unsigned32 | | +| 4209 | Number-Of-UEs | Unsigned32 | | +| 4210 | Access-Network-Reports | Grouped | | +| 4211 | Event-Configuration | Grouped | | +| 4212 | Event-Configuration-State | Unsigned32 | | +| 4213 | Event-Configuration-Status | Grouped | | +| 4214 | Event-Reporting-Results | Unsigned32 | | +| 4215 | Event-Reports | Grouped | | +| 4216 | Extended-SCEF-Reference-ID | Unsigned64 | | +| Note: The AVP codes from 4217 to 4299 are reserved for TS 29.154. | | | | +| 4300 | Communication-Failure-Information | Grouped | 29.128
[36] | +| 4301 | Cause-Type | Unsigned32 | | +| 4302 | S1AP-Cause | Unsigned32 | | +| 4303 | RANAP-Cause | Unsigned32 | | +| 4304 | GMM-Cause | Unsigned32 | | +| 4305 | SM-Cause | Unsigned32 | | +| 4306 | Number-of-UE-Per-Location-Configuration | Grouped | | +| 4307 | Number-of-UE-Per-Location-Report | Grouped | | +| 4308 | UE-Count | Unsigned32 | | +| 4309 | BSSGP-Cause | Unsigned32 | | +| 4310 | Serving-PLMN-Rate-Control | Grouped | | +| 4311 | Uplink-Rate-Limit | Unsigned32 | | +| 4312 | Downlink-Rate-Limit | Unsigned32 | | +| 4313 | Extended-PCO | OctetString | | +| 4314 | Connection-Action | Unsigned32 | | +| 4315 | Non-IP-Data | OctetString | | +| 4316 | SCEF-Wait-Time | Time | | +| 4317 | CMR-Flags | Unsigned32 | | +| 4318 | RRC-Cause-Counter | Grouped | | +| 4319 | Counter-Value | Unsigned32 | | +| 4320 | RRC-Counter-Timestamp | Time | | +| 4321 | TDA-Flags | Unsigned32 | | +| 4322 | Idle-Status-Indication | Grouped | | +| 4323 | Idle-Status-Timestamp | Time | | +| 4324 | Active-Time | Unsigned32 | | +| 4325 | Reachability-Cause | Unsigned32 | | +| 4326 | APN-Rate-Control-Status | Grouped | | +| 4327 | Uplink-Number-Of-Packets-Allowed | Unsigned32 | | +| 4328 | Number-Of-Additional-Exception-Reports | Unsigned32 | | +| 4329 | Downlink-Number-Of-Packets-Allowed | Unsigned32 | | +| 4330 | APN-Rate-Control-Status-Validity-Time | Unsigned64 | | +| Note: The AVP codes from 4331 to 4399 are reserved for TS 29.128. | | | | +| 4400 | Charging-Per-IP-CAN-Session-Indicator | Enumerated | 32.299 [5] | +| 4401 | Access-Network-Info-Change | Enumerated | | +| 4402 | Discoveree-UE-HPLMN-Identifier | UTF8String | | +| 4403 | Discoveree-UE-VPLMN-Identifier | UTF8String | | +| 4404 | Discoverer-UE-HPLMN-Identifier | UTF8String | | +| 4405 | Discoverer-UE-VPLMN-Identifier | UTF8String | | +| 4406 | 3GPP-PS-Data-Off-Status | Enumerated | | +| 4407 | Unused-Quota-Timer | Unsigned32 | | +| 4408 | Announcing-PLMN-ID | UTF8String | | + +| | | | | +|--------------------------------------------------------------------------|---------------------------------|-------------|----------------| +| 4409 | ProSe-UE-to-Network-Relay-UE-ID | OctetString | | +| 4410 | ProSe-Target-Layer-2-ID | OctetString | | +| 4411 | Relay-IP-address | Address | | +| 4412 | Target-IP-Address | Address | | +| 4413 | FE-Identifier-List | UTF8String | | +| Note: The AVP codes from 4414 to 4499 are reserved for TS 32.299 | | | | +| 4500 | MCPTT-ID | UTF8String | | +| 4501 | Data-Identification | Grouped | | +| 4502 | Data-Identification-Prefix | Unsigned32 | | +| 4503 | Data-Identification-Flags | Unsigned64 | | +| 4504 | DPR-Flags | Unsigned32 | | +| 4505 | DPA-Flags | Unsigned32 | | +| 4506 | DUR-Flags | Unsigned32 | | +| 4507 | DUA-Flags | Unsigned32 | | +| 4508 | NDR-Flags | Unsigned32 | | +| 4509 | NDA-Flags | Unsigned32 | | +| 4510 | User-Data-Id | Unsigned32 | | +| 4511 | MC-Service-User-Profile-Data | Grouped | | +| 4512 | Sequence-Number | Unsigned32 | | +| 4513 | MCVideo-ID | UTF8String | | +| 4514 | MC-Data-ID | UTF8String | | +| Note: The AVP codes from 4515 to 4599 are reserved for TS 29.283. | | | | +| 4600 | V2X-PC5-Allowed-PLMN | Grouped | | +| 4601 | V2X-Update-Flags | Unsigned32 | | +| 4602 | V2X-Notify-Flags | Unsigned32 | | +| 4603 | PLMN-Allowed-PC5-RATs | Grouped | | +| 4604 | PC5-RAT-Type | Enumerated | | +| Note: The AVP codes from 4605 to 4799 are reserved for TS 29.388. | | | | +| 4700 | V2X-Authorization-Data | Grouped | | +| 4701 | V2X-Permission-in-VPLMN | Unsigned32 | | +| 4702 | V2X-Application-Server | Grouped | | +| Note: The AVP codes from 4703 to 4799 are reserved for TS and TS 29.389. | | | | +| | | | 29.561
[42] | +| Note: The AVP codes from 4800 to 4999 are reserved for TS and TS 29.561. | | | | + +# 8 Experimental result codes + +The Diameter answer messages must carry either Result-Code AVP or Experimental-Result AVP. The values of Result-Code AVP are controlled by IANA. The Experimental-Result AVP is a grouped AVP containing the Vendor-Id AVP and Experimental-Result-Code AVP, thus the experimental result codes are controlled in a vendor-specific manner. + +## 8.1 3GPP specific result codes + +The 3GPP specific result codes are always transferred in the Experimental-Result AVP, which has the Vendor-Id with value of 3GPP's vendor identifier. The 3GPP specific result codes shall follow the same classification as defined for the values of Result-Code AVP in IETF RFC 3588 [9]. That means, the result codes are grouped to following ranges: + +- 1xxx (Informational) +- 2xxx (Success) +- 4xxx (Transient Failures) +- 5xxx (Permanent Failures) + +### 8.1.1 Informational + +The Informational result codes shall use the values from 1001 to 1999 in the Experimental-Result-Code AVP. + +Editor's note: No informational result codes have been yet defined in 3GPP. + +### 8.1.2 Success + +The Success result codes shall use the values from 2001 to 2999 in the Experimental-Result-Code AVP. The reserved 3GPP specific Success result codes are presented in the following table. + +**Table 8.1.2: 3GPP specific Success result codes** + +| Experimental Result Code | Result text | Specified in the TS | +|---------------------------------------------------------------------------------------|------------------------------------------|---------------------| +| 2001 | DIAMETER_FIRST_REGISTRATION | 29.229 [2] | +| 2002 | DIAMETER_SUBSEQUENT_REGISTRATION | | +| 2003 | DIAMETER_UNREGISTERED_SERVICE | | +| 2004 | DIAMETER_SUCCESS_SERVER_NAME_NOT_STORED | | +| 2005 | Deprecated value | | +| Note: The Experimental Result Codes from 2006 to 2020 are reserved for the TS 29.229. | | | +| 2021 | DIAMETER_PDP_CONTEXT_DELETION_INDICATION | 29.061 [13] | +| Note: The Experimental Result Codes from 2022 to 2040 are reserved for the TS 29.061 | | | +| | | 29.109 [7] | +| Note: The Experimental Result Codes from 2401 to 2420 are reserved for the TS 29.109. | | | +| 2421 | DIAMETER_QOS_FLOW_DELETION_INDICATION | 29.561 [42] | +| Note: The Experimental Result Codes from 2422 to 2440 are reserved for the TS 29.561. | | | + +### 8.1.3 Transient Failures + +The Transient Failure result codes shall use the values from 4001 to 4999 in the Experimental-Result-Code AVP. The reserved 3GPP specific Transient Failure result codes are presented in the following table. + +Table 8.1.3: 3GPP specific Transient Failure result codes + +| Experimental Result Code | Result text | Specified in the TS | +|---------------------------------------------------------------------------------------|-----------------------------------------------|---------------------| +| 4100 | DIAMETER_USER_DATA_NOT_AVAILABLE | 29.329 [4] | +| 4101 | DIAMETER_PRIOR_UPDATE_IN_PROGRESS | | +| Note: The Experimental Result Codes from 4102 to 4120 are reserved for the TS 29.329. | | | +| 4121 | DIAMETER_ERROR_OUT_OF_RESOURCES | 29.061 [13] | +| Note: The Experimental Result Codes from 4122 to 4140 are reserved for the TS 29.061. | | | +| 4141 | DIAMETER_PCC_BEARER_EVENT | 29.212 [19] | +| 4142 | DIAMETER_BEARER_EVENT | | +| 4143 | DIAMETER_AN_GW_FAILED | | +| 4144 | DIAMETER_PENDING_TRANSACTION | | +| 4145 | DIAMETER_UE_STATUS_SUSPEND | | +| Note: The Experimental Result Codes from 4146 to 4160 are reserved for the TS 29.212 | | | +| | | 32.299 [5] | +| Note: The Experimental Result Codes from 4161 to 4180 are reserved for the TS 32.299. | | | +| 4181 | DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE | 29.272 [21] | +| 4182 | DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT | | +| Note: The Experimental Result Codes from 4182 to 4200 are reserved for the TS 29.272. | | | +| 4201 | DIAMETER_ERROR_ABSENT_USER | 29.173 [25] | +| Note: The Experimental Result Codes from 4202 to 4220 are reserved for the TS 29.173. | | | +| 4221 | DIAMETER_ERROR_UNREACHABLE_USER | 29.172 [24] | +| 4222 | DIAMETER_ERROR_SUSPENDED_USER | | +| 4223 | DIAMETER_ERROR_DETACHED_USER | | +| 4224 | DIAMETER_ERROR_POSITIONING_DENIED | | +| 4225 | DIAMETER_ERROR_POSITIONING_FAILED | | +| 4226 | DIAMETER_ERROR_UNKNOWN_UNREACHABLE_LCS_CLIENT | | +| Note: The Experimental Result Codes from 4227 to 4240 are reserved for the TS 29.172. | | | +| 4241 | DIAMETER_ERROR_NO_AVAILABLE_POLICY_COUNTERS | 29.219 [26] | +| Note: The Experimental Result Codes from 4242 to 4260 are reserved for the TS 29.219. | | | +| 4261 | REQUESTED_SERVICE_TEMPORARILY_NOT_AUTHORIZED | 29.214 [18] | +| Note: The Experimental Result Codes from 4262 to 4280 are reserved for the TS 29.214. | | | + +### 8.1.4 Permanent Failures + +The Permanent Failure result codes shall use the values from 5001 to 5999 in the Experimental-Result-Code AVP. The reserved 3GPP specific Permanent Failure result codes are presented in the following table. + +Table 8.1.4: 3GPP specific Permanent Failure result codes + +| Experimental Result Code | Result text | Specified in the TS | +|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------------------------------------------| +| 5001 | DIAMETER_ERROR_USER_UNKNOWN | 29.229 [2] | +| 5002 | DIAMETER_ERROR_IDENTITIES_DONT_MATCH | | +| 5003 | DIAMETER_ERROR_IDENTITY_NOT_REGISTERED | | +| 5004 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED | | +| 5005 | DIAMETER_ERROR_IDENTITY_ALREADY_REGISTERED | | +| 5006 | DIAMETER_ERROR_AUTH_SCHEME_NOT_SUPPORTED | | +| 5007 | DIAMETER_ERROR_IN_ASSIGNMENT_TYPE | | +| 5008 | DIAMETER_ERROR_TOO_MUCH_DATA | | +| 5009 | DIAMETER_ERROR_NOT_SUPPORTED_USER_DATA | | +| 5010 | unassigned | | +| 5011 | DIAMETER_ERROR_FEATURE_UNSUPPORTED | | +| 5012 | DIAMETER_ERROR_SERVING_NODE_FEATURE_UNSUP
PORTED | | +| Note: The Experimental Result Codes from 5013 to 5020 are reserved for the TS 29.229. | | 32.299 [5] | +| Note: The Experimental Result Codes from 5021 to 5040 are reserved for the TS 32.299. | | | +| 5041 | DIAMETER_ERROR_USER_NO_WLAN_SUBSCRIPTION | 29.234 [6] | +| 5042 | DIAMETER_ERROR_W-APN_UNUSED_BY_USER | | +| 5043 | DIAMETER_ERROR_NO_ACCESS_INDEPENDENT_SUBS
CRIPTION | | +| 5044 | DIAMETER_ERROR_USER_NO_W-APN_SUBSCRIPTION | | +| 5045 | DIAMETER_ERROR_UNSUITABLE_NETWORK | | +| Note: The Experimental Result Codes from 5046 to 5060 are reserved for the TS 29.234. | | | +| 5061 | INVALID_SERVICE_INFORMATION | 29.209 [8],
29.211 [17],
29.214 [18] | +| 5062 | FILTER_RESTRICTIONS | | +| 5063 | REQUESTED_SERVICE_NOT_AUTHORIZED | | +| 5064 | DUPLICATED_AF_SESSION | | +| 5065 | IP-CAN_SESSION_NOT_AVAILABLE | | +| 5066 | UNAUTHORIZED_NON_EMERGENCY_SESSION | | +| 5067 | UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY | | +| 5068 | TEMPORARY_NETWORK_FAILURE | | +| Note: The Experimental Result Codes from 5069 to 5080 are reserved for TS 29.209, TS 29.211 and TS 29.214. | | | +| 5100 | DIAMETER_ERROR_USER_DATA_NOT_RECOGNIZED | 29.329 [4] | +| 5101 | DIAMETER_ERROR_OPERATION_NOT_ALLOWED | | +| 5102 | DIAMETER_ERROR_USER_DATA_CANNOT_BE_READ | | +| 5103 | DIAMETER_ERROR_USER_DATA_CANNOT_BE_MODIFIE
D | | +| 5104 | DIAMETER_ERROR_USER_DATA_CANNOT_BE_NOTIFIE
D | | +| 5105 | DIAMETER_ERROR_TRANSPARENT_DATA
OUT_OF_SYNC | | +| 5106 | DIAMETER_ERROR_SUBS_DATA_ABSENT | | +| 5107 | DIAMETER_ERROR_NO_SUBSCRIPTION_TO_DATA | | +| 5108 | DIAMETER_ERROR_DSAI_NOT_AVAILABLE | | +| Note: The Experimental Result Codes from 5109 to 5119 are reserved for the TS 29.329. | | | +| 5120 | DIAMETER_ERROR_START_INDICATION | 29.061 [13] | +| 5121 | DIAMETER_ERROR_STOP_INDICATION | | +| 5122 | DIAMETER_ERROR_UNKNOWN_MBMS_BEARER_SERVI
CE | | +| 5123 | DIAMETER_ERROR_SERVICE_AREA | | +| Note: The Experimental Result Codes from 5124 to 5139 are reserved for the TS 29.061. | | | +| 5140 | DIAMETER_ERROR_INITIAL_PARAMETERS | 29.212 [19] | +| 5141 | DIAMETER_ERROR_TRIGGER_EVENT | | +| 5142 | DIAMETER_PCC_RULE_EVENT | | +| 5143 | DIAMETER_ERROR_BEARER_NOT_AUTHORIZED | | +| 5144 | DIAMETER_ERROR_TRAFFIC_MAPPING_INFO_REJECTE
D | | +| 5145 | DIAMETER_QOS_RULE_EVENT | | +| 5146 | reserved | | +| 5147 | DIAMETER_ERROR_CONFLICTING_REQUEST | | +| 5148 | DIAMETER_ADC_RULE_EVENT | | + +| | | | +|---------------------------------------------------------------------------------------|-----------------------------------------------------------|-------------| +| 5149 | DIAMETER_ERROR_NBIFOM_NOT_AUTHORIZED | | +| Note: The Experimental Result Codes from 5150 to 5159 are reserved for the TS 29.212. | | | +| 5401 | DIAMETER_ERROR_IMPI_UNKNOWN | 29.109 [7] | +| 5402 | DIAMETER_ERROR_NOT_AUTHORIZED | | +| 5403 | DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID | | +| Note: The Experimental Result Codes from 5404 to 5419 are reserved for the TS 29.109. | | | +| 5420 | DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION | 29.272 [21] | +| 5421 | DIAMETER_ERROR_RAT_NOT_ALLOWED | | +| 5422 | DIAMETER_ERROR_EQUIPMENT_UNKNOWN | | +| 5423 | DIAMETER_ERROR_UNKNOWN_SERVING_NODE | | +| Note: The Experimental Result Codes from 5424 to 5449 are reserved for the TS 29.272. | | | +| 5450 | DIAMETER_ERROR_USER_NO_NON_3GPP_SUBSCRIPTION | 29.273 [20] | +| 5451 | DIAMETER_ERROR_USER_NO_APN_SUBSCRIPTION | | +| 5452 | DIAMETER_ERROR_RAT_TYPE_NOT_ALLOWED | | +| 5453 | DIAMETER_ERROR_LATE_OVERLAPPING_REQUEST | | +| 5454 | DIAMETER_ERROR_TIMED_OUT_REQUEST | | +| 5455 | DIAMETER_ERROR_TRUSTED_NON_3GPP_ACCESS_NOT_ALLOWED | | +| 5456 | DIAMETER_ERROR_UNTRUSTED_NON_3GPP_ACCESS_NOT_ALLOWED | | +| Note: The Experimental Result Codes from 5455 to 5469 are reserved for the TS 29.273. | | | +| 5470 | DIAMETER_ERROR_SUBSESSION | 29.215 [22] | +| 5471 | DIAMETER_ERROR_ONGOING_SESSION_ESTABLISHMENT | | +| Note: The Experimental Result Codes from 5472 to 5489 are reserved for the TS 29.215. | | | +| 5490 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK | 29.173 [25] | +| Note: The Experimental Result Codes from 5491 to 5509 are reserved for the TS 29.173. | | | +| 5510 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY | 29.336 [28] | +| 5511 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE | | +| 5512 | DIAMETER_ERROR_REQUESTED_RANGE_IS_NOT_ALLOWED | | +| 5513 | DIAMETER_ERROR_CONFIGURATION_EVENT_STORAGE_NOT_SUCCESSFUL | | +| 5514 | DIAMETER_ERROR_CONFIGURATION_EVENT_NON_EXISTANT | | +| 5515 | DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN | | +| 5516 | DIAMETER_ERROR_UNAUTHORIZED_MTC_PROVIDER | | +| Note: The Experimental Result Codes from 5517 to 5529 are reserved for the TS 29.336. | | | +| 5530 | DIAMETER_ERROR_INVALID_SME_ADDRESS | 29.337 [29] | +| 5531 | DIAMETER_ERROR_SC_CONGESTION | | +| 5532 | DIAMETER_ERROR_SM_PROTOCOL | | +| 5533 | DIAMETER_ERROR_TRIGGER_REPLACE_FAILURE | | +| 5534 | DIAMETER_ERROR_TRIGGER_RECALL_FAILURE | | +| 5535 | DIAMETER_ERROR_ORIGINAL_MESSAGE_NOT_PENDIN G | | +| Note: The Experimental Result Codes from 5536 to 5549 are reserved for the TS 29.337. | | | +| 5550 | DIAMETER_ERROR_ABSENT_USER | 29.338 [30] | +| 5551 | DIAMETER_ERROR_USER_BUSY_FOR_MT_SMS | | +| 5552 | DIAMETER_ERROR_FACILITY_NOT_SUPPORTED | | +| 5553 | DIAMETER_ERROR_ILLEGAL_USER | | +| 5554 | DIAMETER_ERROR_ILLEGAL_EQUIPMENT | | +| 5555 | DIAMETER_ERROR_SM_DELIVERY_FAILURE | | +| 5556 | DIAMETER_ERROR_SERVICE_NOT_SUBSCRIBED | | +| 5557 | DIAMETER_ERROR_SERVICE_BARRED | | +| 5558 | DIAMETER_ERROR_MWD_LIST_FULL | | +| Note: The Experimental Result Codes from 5559 to 5569 are reserved for the TS 29.338. | | | +| 5570 | DIAMETER_ERROR_UNKNOWN_POLICY_COUNTERS | 29.219 [26] | +| Note: The Experimental Result Codes from 5571 to 5589 are reserved for the TS 29.219. | | | +| 5590 | DIAMETER_ERROR_ORIGIN_ALUID_UNKNOWN | 29.343 [32] | +| 5591 | DIAMETER_ERROR_TARGET_ALUID_UNKNOWN | | +| 5592 | DIAMETER_ERROR_PPID_UNKNOWN | | +| 5593 | DIAMETER_ERROR_APP_REGISTER_REJECT | | + +| | | | +|---------------------------------------------------------------------------------------|--------------------------------------------------|-------------| +| 5594 | DIAMETER_ERROR_PROSE_MAP_REQUEST_DISALLOWED | | +| 5595 | DIAMETER_ERROR_MAP_REQUEST_REJECT | | +| 5596 | DIAMETER_ERROR_REQUESTING_RPAUID_UNKNOWN | | +| 5597 | DIAMETER_ERROR_UNKNOWN_OR_INVALID_TARGET_SET | | +| 5598 | DIAMETER_ERROR_MISSING_APPLICATION_DATA | | +| 5599 | DIAMETER_ERROR_AUTHORIZATION_REJECT | | +| 5600 | DIAMETER_ERROR_DISCOVERY_NOT_PERMITTED | | +| 5601 | DIAMETER_ERROR_TARGET_RPAUID_UNKNOWN | | +| 5602 | DIAMETER_ERROR_INVALID_APPLICATION_DATA | | +| Note: The Experimental Result Codes from 5603 to 5609 are reserved for the TS 29.343. | | | +| 5610 | DIAMETER_ERROR_UNKNOWN_PROSE_SUBSCRIPTION | 29.344 [33] | +| 5611 | DIAMETER_ERROR_PROSE_NOT_ALLOWED | | +| 5612 | DIAMETER_ERROR_UE_LOCATION_UNKNOWN | | +| Note: The Experimental Result Codes from 5613 to 5629 are reserved for the TS 29.344. | | | +| 5630 | DIAMETER_ERROR_NO_ASSOCIATED_DISCOVERY_FILTER | 29.345 [34] | +| 5631 | DIAMETER_ERROR_ANNOUNCING_UNAUTHORIZED_IN_PLMN | | +| 5632 | DIAMETER_ERROR_INVALID_APPLICATION_CODE | | +| 5633 | DIAMETER_ERROR_PROXIMITY_UNAUTHORIZED | | +| 5634 | DIAMETER_ERROR_PROXIMITY_REJECTED | | +| 5635 | DIAMETER_ERROR_NO_PROXIMITY_REQUEST | | +| 5636 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE_IN_THIS_PLMN | | +| 5637 | DIAMETER_ERROR_PROXIMITY_CANCELLED | | +| 5638 | DIAMETER_ERROR_INVALID_TARGET_PDUID | | +| 5639 | DIAMETER_ERROR_INVALID_TARGET_RPAUID | | +| 5640 | DIAMETER_ERROR_NO_ASSOCIATED_RESTRICTED_CODE | | +| 5641 | DIAMETER_ERROR_INVALID_DISCOVERY_TYPE | | +| Note: The Experimental Result Codes from 5642 to 5649 are reserved for the TS 29.345. | | | +| 5650 | DIAMETER_ERROR_REQUESTED_LOCATION_NOT_SERVED | 29.128 [36] | +| 5651 | DIAMETER_ERROR_INVALID_EPS_BEARER | | +| 5652 | DIAMETER_ERROR_NIDD_CONFIGURATION_NOT_AVAILABLE | | +| 5653 | DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE | | +| Note: The Experimental Result Codes from 5654 to 5669 are reserved for the TS 29.128. | | | +| 5670 | DIAMETER_ERROR_UNKNOWN_DATA | 29.283 [39] | +| 5671 | DIAMETER_ERROR_REQUIRED_KEY_NOT_PROVIDED | | +| Note: The Experimental Result Codes from 5672 to 5689 are reserved for the TS 29.128. | | | +| 5690 | DIAMETER_ERROR_UNKNOWN_V2X_SUBSCRIPTION | 29.388 [40] | +| 5691 | DIAMETER_ERROR_V2X_NOT_ALLOWED | | +| Note: The Experimental Result Codes from 5692 to 5709 are reserved for the TS 29.388. | | | + +# --- Annex A (informative): Assignment of the Diameter codes and identifiers in 3GPP + +This annex defines the recommended assignment procedure of Diameter codes and identifiers within the 3GPP. + +## --- A.1 Application identifiers + +If a working group detects it will require a new application identifier, it should contact the 3GPP TSG-CN WG 4 via a Liaison Statement. The LS shall contain the name of the Diameter application and a reference to the corresponding 3GPP TS. The 3GPP TSG-CN WG 4 will then request the application identifier from IANA. When the application identifier is received, the corresponding working group will be informed by 3GPP TSG-CN WG 4 and the table 4.1 in this specification will be updated. + +According to RFC 3588 the creation of a new application should be avoided if at all possible and therefore it is recommended to use the existing application identifiers whenever possible. + +## --- A.2 Command codes + +If a working group detects there is a need for a new command code(s) from the 3GPP's range, it should contact the 3GPP TSG-CN WG 4 via an LS. The LS shall contain the reference to the 3GPP TS, which specifies the command(s). The 3GPP TSG-CN WG 4 will inform the assigned command code(s) to the corresponding working group and the table 5.1 in this specification will be updated. + +It should be noted that the standard command codes allocated for 3GPP are scarce resource and getting new ones would require IETF specification work to be done. Therefore it is recommended to use the existing command codes whenever possible. + +## --- A.3 AVP codes + +If a working group detects a Diameter application needs new 3GPP specific AVP codes, it should contact the 3GPP TSG-CN WG 4 via an LS. The LS shall contain the name of the Diameter application and a reference to the corresponding 3GPP TS. The 3GPP TSG-CN WG 4 will allocate a range of 100 AVP codes for the application. The range will be informed to the corresponding working group and the table 7.1 will be updated in this specification to show the reserved range. The working group can use the allocated range as a working assumption when defining the actual AVPs. + +When the corresponding working group has specified the AVPs, and the specification has been approved and is under CR control, it should inform the AVPs to the 3GPP TSG-CN WG 4 via an LS. The LS should list the used AVP codes in the form of the table 7.1. + +If there will be defined new AVPs for a Diameter application through the CR procedure, the assigned AVP range can be used, but the 3GPP TSG-CN WG 4 should be also informed about the new AVP codes via an LS. + +Re-using of the existing AVPs is recommended, but special attention should be paid on the use of enumerated AVPs. Defining new values for an enumerated AVP should be agreed case by case with the working group responsible of the particular enumerated AVP. 3GPP TSG-CN WG 4 shall be informed via an LS about the new values assigned to the enumerated AVP. + +## --- A.4 Result codes + +If a working group detects a Diameter application needs new 3GPP specific result codes, it should contact the 3GPP TSG-CN WG 4 via an LS. The LS shall contain the name of the Diameter application and a reference to the corresponding 3GPP TS. The 3GPP TSG-CN WG 4 will allocate a range of 20 result codes from each required result + +code group for the application. The ranges will be informed to the corresponding working group and the tables in the chapter 8 of this specification will be updated to show the reserved ranges. The working group can use the allocated ranges as a working assumption when defining the actual result codes. + +When the corresponding working group has specified the result codes, and the specification has been approved and is under CR control, it should convey the codes to the 3GPP TSG-CN WG 4 via an LS. The LS should list the used result codes in the form of the tables in chapter 8. + +If there will be defined new result codes for a Diameter application through the CR procedure, the assigned result code ranges can be used, but the 3GPP TSG-CN WG 4 should be also informed about the new result codes via an LS. + +Re-using of the existing result codes is recommended. + +# Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Ca
t | Subject/Comment | New | +|---------|-------|-----------|------|-----|---------|-----------------------------------------------------------------------------------------------------------|-------| +| 2004-06 | CN#24 | NP-040292 | | | | Version 2.0.0 presented for information and approval | 6.0.0 | +| 2004-09 | CN#25 | NP-040401 | 001 | | | Correction of Charging application reference | 6.1.0 | +| 2004-09 | CN#25 | NP-040401 | 002 | | | Correction of the Application-Id code | 6.1.0 | +| 2004-09 | CN#25 | NP-040401 | 003 | | | Removal of User Data Request Type AVP | 6.1.0 | +| 2004-09 | CN#25 | NP-040412 | 004 | 1 | | Re-numbering of 3GPP specific AVP codes. | 6.1.0 | +| 2004-12 | CN#26 | NP-040579 | 006 | | | Inclusion of missing Cx AVPs | 6.2.0 | +| 2004-12 | CN#26 | NP-040580 | 007 | 1 | | Reservation of command code 310 | 6.2.0 | +| 2004-12 | CN#26 | NP-040579 | 009 | 1 | | Addition of Gmb interface | 6.2.0 | +| 2004-12 | CN#26 | NP-040600 | 010 | 2 | | Documenting the Reuse of the 3GPP specific application identifier of Ro for Re on the Charging Interfaces | 6.2.0 | +| 2004-12 | CN#26 | NP-040579 | 011 | | | Gq interface allocations | 6.2.0 | +| 2004-12 | CN#26 | NP-040579 | 012 | | | Addition of Gx interface | 6.2.0 | +| 2005-03 | CN#27 | NP-050047 | 040 | 1 | | WLAN Diameter AVP and result codes | 6.3.0 | +| | | NP-050039 | 043 | | | Allocations for Gx interface | | +| | | NP-050039 | 045 | | | Allocations for Gmb interface | | +| | | NP-050039 | 046 | | | Allocations for MMS, MM10 Interface | | +| 2005-06 | CT#28 | CP-050088 | 0050 | | | Gx interface allocation correction | 6.4.0 | +| | | CP-050196 | 0051 | 1 | | Addition of Maximum-Number-Accesses AVP | | +| 2005-09 | CT#29 | CP-050440 | 0052 | 1 | | Private identities on the Cx | 6.5.0 | +| | | CP-050310 | 0053 | | | Addition of Pr reference point to TS 29.230 | | +| | | CP-050310 | 0054 | | | Error code cleanup | | +| | | CP-050310 | 0056 | | | Addition of Rx ref. point and renaming of Experimental Result Codes | | +| 2005-09 | CT#29 | CP-050317 | 0055 | | | Addition of GUSS timestamp AVP | 7.0.0 | +| 2005-12 | CT#30 | CP-050624 | 0058 | | | Addition of GBA-Type AVP | 7.1.0 | +| | | CP-050612 | 0063 | | | Additional Gmb AVP Allocation | | +| | | CP-050612 | 0065 | | | Reservation of AVP codes for 32.299 | | +| | | CP-050625 | 0066 | | | Management of Sh subscriptions | | +| 2006-03 | CT#31 | CP-060073 | 0069 | | | Adding data type of some of WLAN-related AVPs | 7.2.0 | +| | | CP-060084 | 0071 | | | User-Data in the response to Sh-Subs-Notif | | +| | | CP-060084 | 0072 | 1 | | New error indications for the Sh-Subs-Notif procedure | | +| 2006-06 | CT#32 | CP-060302 | 0075 | | | S-CSCF reselection removal | 7.3.0 | +| 2006-09 | CT#33 | CP-060417 | 0077 | 3 | | New AVP Code | 7.4.0 | +| | | CP-060417 | 0080 | | | Errors to be sent in response to Sh-Notif | | +| | | CP-060417 | 0081 | | | Definition of specific Diameter codes for DSAI | | +| 2006-12 | CT#34 | CP-060566 | 0085 | 1 | | Optimization of handling of Wildcarded PSIs | 7.5.0 | +| | | CP-060562 | 0086 | | | Addition of Diameter Error Code for Emergency Purposes | | +| | | CP-060555 | 0087 | | | Allocation of new AVP codes for Gmb | | +| | | CP-060555 | 0089 | | | AVP code allocations for Rf and Ro interfaces | | +| | | CP-060566 | 0091 | | | Allocation of Success Result Code Range for Gi Interface | | +| 2007-03 | CT#35 | CP-070020 | 0093 | | | C3 requested addition of new AVP code values to 3GPP TS 29.230 | 7.6.0 | +| | | CP-070020 | 0093 | | | Allocation of new AVP code for DSAI-Tag AVP | | +| | | CP-070020 | 0093 | | | Allocation of Experimental-Result-Code AVP for Gi Interface | | +| 2007-06 | CT#36 | CP-070318 | 0096 | | | Diameter application ID for the Rel-7 Rx interface | 7.7.0 | +| | | CP-070312 | 0098 | | | Experimental-Result-Codes for Gmb interface | | +| | | CP-070312 | 0100 | | | Correction of Diameter AVP code allocation | | +| 2007-09 | CT#37 | CP-070527 | 0102 | | | Application ID for Gx protocol | 7.8.0 | +| 2007-12 | CT#38 | CP-070743 | 0104 | | | AVP code reservation for 32.299 in Rel-7 | 7.9.0 | +| | | | 0105 | | | Allocation of 3GPP specific AVP codes and Experimental Result Codes for Gx protocol | | +| 2007-12 | CT#38 | CP-070755 | 0101 | 4 | | AVP assignments to support SIP Digest Authentication | 8.0.0 | +| | | | 0103 | | | AVP code reservation for 32.299 in Rel-8 | | +| 2008-03 | CT#39 | CP-080015 | 0109 | | | Correction of reference to TS 29.140 | 8.1.0 | +| | | CP-080019 | 0111 | | | AVP code reservation for TS 32.299 in Rel-8 | | +| | | CP-080019 | 0107 | | | Wildcarded Public User Identities | | +| | | CP-080191 | 0112 | 1 | | Correction on AVP code allocation reservation for TS 32.299 in Rel-7 | | +| | | CP-080204 | 0113 | 1 | | Correction on AVP code allocation reservation for TS 32.299 | | +| 2008-06 | CT#40 | CP-080267 | 0117 | 1 | | A new Diameter Permanent Failure Code for Gx | 8.2.0 | +| 2008-09 | CT#41 | CP-080456 | 0119 | | | Emergency Public User Identity Removal | 8.3.0 | +| 2008-09 | CT#41 | CP-080460 | 0121 | 1 | | Support of "Loose-Route" indication from HSS | | +| 2008-09 | CT#41 | CP-080460 | 0122 | 1 | | STaMIP Application Id | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|----------------------------------------------------------------------------|--------| +| 2008-09 | CT#41 | CP-080463 | 0123 | | | Cx Impacts of IMS Restoration Procedures (New AVP Codes Assignment) | | +| 2008-09 | CT#41 | CP-080463 | 0124 | | | New AVP Code Assignment for Forking Service Restoration | 8.3.0 | +| 2008-12 | CT#42 | CP-080691 | 0127 | 2 | | Diameter Protocol Codes Assignments for S6a/S6d/S13 | 8.4.0 | +| 2008-12 | CT#42 | CP-080691 | 0128 | 1 | | Diameter code assignments for 3GPP TS 29.273 | 8.4.0 | +| 2009-03 | CT#43 | CP-090044 | 0130 | 1 | | Update for ReadyForSM | 8.5.0 | +| 2009-03 | CT#43 | CP-090044 | 0131 | 1 | | Handling LCS Subscription Data | 8.5.0 | +| 2009-03 | CT#43 | CP-090026 | 0132 | | | Update for Restoration | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0133 | | | AppIds for Gxx and S9 | 8.5.0 | +| 2009-03 | CT#43 | CP-090033 | 0134 | 2 | | AppId and command code for Zpn | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0137 | 1 | | AVP codes for S9 protocol | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0138 | 1 | | Diameter AVP Code allocation | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0140 | 1 | | Location of Permanent Failure result code range for the S9 application | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0141 | | | AVPs for TS 29.273 | 8.5.0 | +| 2009-03 | CT#43 | CP-090024 | 0142 | 1 | | Error code allocation for authentication failure | 8.5.0 | +| 2009-06 | CT#44 | CP-090299 | 0129 | 4 | | Update of the AVP Codes | 8.6.0 | +| | | CP-090299 | 0143 | | | AVP code reservation for TS 32.299 | | +| | | CP-090299 | 0145 | | | Diameter Command Codes for S6a/S6d/S13/S13' | | +| | | CP-090299 | 0146 | | | Removal of Requesting Node Type from AIR | | +| | | CP-090299 | 0147 | | | S6b Application ID | | +| 2009-09 | CT#45 | CP-090530 | 0149 | | | Allocation of Experimental-Result-Codes for S9 protocol | 8.7.0 | +| | | CP-090530 | 0152 | | | AVP code allocation for TS 29.212 | | +| | | CP-090531 | 0150 | | | Update of the AVP type for the User-Id | | +| | | CP-090531 | 0153 | | | Trace Depth per session | | +| 2009-09 | CT#45 | CP-090557 | 0148 | | | AVP code range for charging | 9.0.0 | +| 2009-12 | CT#46 | CP-090800 | 0154 | 1 | | ICS-Flag | 9.1.0 | +| | | CP-091032 | 0156 | | | From GMLC-Address to GMLC-Number | | +| | | | 0160 | | | Session-Priority AVP | | +| | | | 0163 | 2 | | Introduction of SLh application related AVPs and Experimental Result codes | | +| | | | 0166 | | | Missing AVP error codes | | +| | | CP-090797 | 0167 | 1 | | Introduction of SLg application related AVPs and Application Identifier | | +| 2010-03 | CT#47 | CP-100031 | 0158 | 1 | | Wildcarded Public Identity | 9.2.0 | +| | | CP-100034 | 0168 | 1 | | Correction on AVP code allocation reservation for TS 32.299 in Rel-9 | | +| | | CP-100046 | 0169 | 1 | | AVP code allocation for 29.172 | | +| | | CP-100036 | 0172 | | | GPL_U support in TS 29.109 | | +| | | CP-100046 | 0173 | | | Error codes in 29.172 for SLg | | +| | | CP-100048 | 0174 | 1 | | AVPs in 29.272 for TADS support | | +| | | CP-100040 | 0175 | | | Error codes in 29.272 for Unknown MME | | +| | | CP-100236 | 0176 | 4 | | EPS Subscriber State and Location Information Request | | +| | | CP-100033 | 0180 | | | One time notification AVP allocation | | +| | | CP-100046 | 0181 | | | Addition of the LCS-QoS-Class attribute value | | +| 2010-06 | CT#48 | CP-100175 | 0182 | | | Introduction of the LCS-Capabilities-Sets AVP in SLh interface | 9.3.0 | +| | | CP-100263 | 0188 | 1 | | AVP Codes for PCC | | +| | | | 0183 | | | EPS state and location retrieval | | +| | | CP-100287 | 0186 | | | SGmb Application ID | | +| 2010-09 | CT#49 | CP-100277 | 0190 | 1 | | New APVs in S6a protocol | 9.4.0 | +| | | CP-100463 | 0197 | 1 | | Addition of Diameter codes and identifiers for the SLg and SLh interfaces | | +| 2010-09 | CT#49 | CP-100464 | 0196 | | | AVP Codes Allocation for PCC | 10.0.0 | +| | | CP-100465 | 0193 | 1 | | SIPTO Permission Indicator | | +| | | CP-100466 | 0198 | 2 | | Location data including only serving node address | | +| 2010-12 | CT#50 | CP-100466 | 0199 | 1 | | AVP for Update-Eff feature | 10.1.0 | +| | | CP-100699 | 0205 | | | Enhanced SRVCC Subscriber Data | | +| | | CP-100687 | 0201 | 1 | | Allocate codes for AVPs on eMPS | | +| | | CP-100683 | 0200 | 1 | | Allocate codes for AVPs on LIPA | | +| | | CP-100688 | 0206 | 1 | | Periodic TAU/RAU timer in HSS subscription | | +| 2011-03 | CT#51 | CP-100846 | 0203 | 1 | | S6a Error Diagnostic | 10.2.0 | +| | | CP-110051 | 0212 | | | PDP-Address correction | | +| | | CP-110054 | 0215 | | | Essential correction on the value type of the ELP Application AVPs | | +| | | CP-110087 | 0207 | 2 | | Minimization of Drive Tests (MDT) | | +| 2011-06 | CT#52 | CP-110088 | 0209 | 1 | | Relay Node Indicator AVPs | 10.3.0 | +| | | CP-110349 | 0219 | 2 | | Handling of RTR for Emergency Registration | | +| | | CP-110347 | 0231 | 1 | | Add AVPs from QSPEC cleanup | | +| | | CP-110359 | 0226 | | | MIPv4 security parameters on the STa and S6b interfaces | | +| | | CP-110380 | 0216 | | | MDT user consent | | +| | | CP-110370 | 0223 | | | AVP Code Allocation for Pre-paging | | +| 2011-09 | CT#53 | CP-110375 | 0227 | 1 | | PUR-Flags AVP | 10.4.0 | +| | | CP-110559 | 0236 | 1 | | AVP code alignment with 29.212 | | +| | | CP-110555 | 0239 | 1 | | AVP code alignment with 32.299 | | +| | | CP-110554 | 0244 | 1 | | AVP code alignment with 29.214 | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-----------------------------------------------------------------------------------|--------| +| | | CP-110552 | 0249 | | | Experimental Result Code Alignment with 29.061 | | +| | | CP-110555 | 0252 | | | Failure code and AVP code alignment with 29.212 | | +| | | CP-110722 | 0257 | 2 | | Privileged sender | | +| 2011-09 | CT#53 | CP-110584 | 0234 | 1 | | Add vSRVCC updates to the Diameter AVP code table | 11.0.0 | +| | | CP-110579 | 0240 | | | AVP code alignment with 32.299 | | +| | | CP-110555 | 0253 | | | AVP code reservation for 29.212 | | +| 2011-12 | CT#54 | CP-110812 | 0258 | 1 | | SWx Restoration AVPs | 11.1.0 | +| | | CP-110812 | 0259 | | | Sy and Sd Application IDs | | +| | | CP-110775 | 0262 | | | New AVP codes for MBMS IP unicast encapsulation | | +| | | CP-110775 | 0265 | | | New AVP codes for MBMS IP multicast encapsulation | | +| | | CP-110786 | 0271 | 1 | | MME-Realm AVP code allocation | | +| | | CP-110811 | 0277 | | | Equivalent PLMN CSG Subscription Request | | +| | | CP-110781 | 0281 | 1 | | Restoration of Wildcarded-IMPU AVP | | +| 2012-03 | CT#55 | CP-120025 | 0286 | 1 | | Codes Allocation for AVPs on Initial Attach | 11.2.0 | +| | | CP-120038 | 0288 | | | New AVP codes for Absolute Time of MBMS Data Transfer over SGmb | | +| | | CP-120038 | 0291 | 1 | | Allocating Diameter AVP codes for TS 29.219 and TS 29.212 | | +| 2012-06 | CT#56 | CP-120240 | 0287 | 5 | | Codes Allocation for AVPs on NPLI | 11.3.0 | +| | | CP-120238 | 0294 | 1 | | Adding new Diameter AVPs to Diameter table to support Trusted WLAN Access feature | | +| | | CP-120225 | 0296 | 1 | | Trust Relationship Indication | | +| | | CP-120251 | 0297 | 1 | | Corrections to reference titles | | +| | | CP-120251 | 0298 | 1 | | Diameter Code Allocation for TS 29.219 | | +| | | CP-120247 | 0300 | - | | Network Name AVP codes | | +| | | CP-120219 | 0304 | - | | Duplicated AVP names | | +| 2012-09 | CT#57 | CP-120481 | 0289 | 3 | | PS additional number allocation | 11.4.0 | +| | | CP-120473 | 0293 | 4 | | SMS in MME/SGSN | | +| | | CP-120461 | 0299 | 2 | | AAA Failure Recovery AVP codes | | +| | | CP-120474 | 0305 | - | | Transport Access Type AVP for BBAI | | +| | | CP-120480 | 0307 | 1 | | Local Time Zone | | +| | | CP-120472 | 0308 | - | | Allocating Application Identifier and command code for Tsp interface | | +| | | CP-120472 | 0309 | - | | Application Identifier, Command Codes and AVP range for S6m interface | | +| | | CP-120667 | 0312 | 1 | | GMLC-Name | | +| | | CP-120667 | 0313 | 1 | | Reference list correction to align with the corrected TS 29.212 title | | +| 2012-12 | CT#58 | CP-120731 | 0315 | 2 | | T4 device triggering via IMS | 11.5.0 | +| | | CP-120731 | 0318 | 1 | | Codes and Identifier Allocation for T4 Specification | | +| | | CP-120731 | 0324 | - | | AVP Code Allocation for 29.336 | | +| | | CP-120731 | 0329 | - | | Diameter AVP code value allocation in TS 29.368 | | +| | | CP-120732 | 0319 | 2 | | Application Identifier, Command Codes and AVP codes for SGd, S6c | | +| | | CP-120716 | 0324 | 1 | | AVP name modification in TS 32.299 | | +| | | CP-120742 | 0325 | - | | UE Time Zone AVP | | +| | | CP-120741 | 0328 | 1 | | Use of Flag instead of Enumerated AVPs | | +| | | CP-120741 | 0332 | - | | Use of Flag instead of Enumerated AVPs | | +| | | CP-120743 | 0330 | - | | PSI direct routing with restoration procedures | | +| | | CP-120743 | 0333 | - | | EPS LocationInformation Support | | +| 2013-03 | CT#59 | CP-130026 | 0334 | 1 | | Diameter error code for TS 29.219 | 11.6.0 | +| | | CP-130026 | 0336 | - | | MDT parameters | | +| 2013-03 | CT#59 | CP-130156 | 0337 | 1 | | New AVPs for Lgd interface | 12.0.0 | +| | | CP-130030 | 0341 | - | | Validity Time of Short Message | | +| 2013-06 | CT#60 | CP-130288 | 0362 | 1 | | Add new DER-S6b-flag AVP | 12.1.0 | +| | | CP-130298 | 0360 | - | | Failure Result Codes Allocation for TS 29.219 | | +| | | CP-130292 | 0358 | - | | Diameter AVP codes for new TS 32.299 AVPs | | +| | | CP-130279 | 0354 | 1 | | Definition of SS Status for Call Barring | | +| | | CP-130380 | 0363 | - | | New SGs-MME-Identity AVP | | +| | | CP-130291 | 0348 | 2 | | New AVPs for deferred MT-LR and periodic MO-LR TTTP procedures over Lgd interface | | +| | | CP-130297 | 0347 | 1 | | Application Port Identifier | | +| | | CP-130374 | 0345 | 1 | | MTRR on Sh | | +| | | CP-130295 | 0344 | - | | Restoration Priority during SGW and PGW restoration procedures | | +| | | CP-130378 | 0349 | 1 | | SIPTO permission for Local Network enhancements | | +| | | CP-130454 | 0364 | 2 | | New MBMS flag for eMBMS restoration | | +| | | CP-130461 | 0366 | - | | AVP code reservation for TS 32.299 Rel-12 | | +| | | CP-130460 | 0368 | - | | Allocation of Diameter codes and identifiers for 29.212 and 29.215 | | +| 2013-09 | | | | - | | Vendor-specific command code for Trigger-Establishment-Request/Answer corrected | 12.2.1 | +| 2013-12 | CT#62 | CP-130624 | 0369 | - | | New AVP for optimized LCS procedure for combined MME/SGSN | 12.3.0 | +| | | CP-130631 | 0370 | 1 | | Adding E-SMLC provided Cell info and Cell Portion | | +| | | CP-130800 | 0371 | - | | New AVPs for SMS for IMS UE without MSISDN in TS 29.338 | | +| | | CP-130600 | 0376 | 1 | | Allocation of Diameter codes for 32.299 | | +| | | CP-130605 | 0378 | - | | Allocation of Diameter codes for 29.212 | | +| | | CP-130639 | 0380 | - | | SGSN CAMEL Subscription Indication | | +| 2014-03 | CT#63 | CP-140180 | 0381 | 2 | | Protocol enhancements for the support of device replace | 12.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-----------------------------------------------------------------------------------------------------------------------|--------| +| | | | | | | procedure | | +| | | CP-140035 | 0384 | - | | New AVP for the support of combined MME/SGSN | | +| | | CP-140023 | 0383 | 1 | | Definition of WLAN-related AVPs | | +| 2014-06 | CT#64 | CP-140211 | 0385 | 1 | | Protocol enhancements to indicate support of device recall and replace by SMS-SC | 12.5.0 | +| | | CP-140251 | 0402 | 1 | | AVP allocation for Error handling, MTC error diagnostic | | +| | | CP-140257 | 0391 | 1 | | SS-Status AVP Definition | | +| | | CP-140252 | 0392 | - | | Definition of AVPs for Network Location in TWLAN | | +| | | CP-140236 | 0399 | - | | TWAN-BSSID AVP re-naming | | +| | | CP-140247 | 0397 | - | | New AVPs for Trusted WLAN access | | +| | | CP-140231 | 0390 | 1 | | Adding Codes for 29.214 | | +| 2014-09 | CT#65 | CP-140515 | 0403 | 1 | | T-GRUU restoration | 12.6.0 | +| | | CP-140517 | 0404 | 1 | | MB2-C codes | | +| | | CP-140505 | 0405 | 1 | | New AVPs for Trusted WLAN access | | +| | | CP-140506 | 0406 | 1 | | P-CSCF Restoration indication | | +| | | CP-140516 | 0407 | 2 | | Closing TS 29.234 and reused AVP in TS 29.273 | | +| | | CP-140513 | 0408 | - | | Identification of the HSS | | +| | | | | | | Editorial: WLAN-offloadability AVP codes added as in CR C4-141648. | | +| 2014-12 | CT#66 | CP-140785 | 0409 | 1 | | New AVP for MBMS restoration | 12.7.0 | +| | | | 0430 | - | | New Diagnostic-Info AVP for MBMS restoration | | +| | | | 0410 | 1 | | WLCP key for WLCP signalling protection | | +| | | | 0411 | - | | Reset-ID | | +| | | | 0416 | 1 | | Code definitions for 32.299 | | +| | | | 0428 | - | | Removal of I-WLAN AVPs | | +| | | | 0429 | 1 | | Reference correction | | +| | | | 0433 | - | | Code allocation for 29.212 | | +| | | | 0418 | - | | MDT PLMN List | | +| | | | 0422 | 1 | | Codes Allocation for PC2 Protocol | | +| | | | 0423 | 4 | | Codes Allocation for PC4a Protocol | | +| | | | 0431 | 3 | | Allocation of values for Application ID, Command codes, AVP codes and Experimental-Result codes used in the TS 29.345 | | +| | | | 0434 | 1 | | Command Code and Error Code for ProSe Initial Location Information Retrieval | | +| | | | 0425 | - | | Corrections of the type of some AVPs | | +| | | | 0426 | 1 | | OFR-Flags AVP code | | +| | | | 0427 | 1 | | P-CSCF Restoration mechanism new error | | +| 2015-03 | CT#67 | CP-150015 | 0447 | - | | Renaming of Location-Type AVP | 12.8.0 | +| | | | 0437 | 1 | | Location reporting in emergency 1xSRVCC | | +| | | | 0435 | - | | AVP codes for GCSE MB2-C | | +| | | | 0442 | 1 | | New AVPs and range of transient failure result codes in TS 29.214 | | +| | | | 0438 | 1 | | Allocation of code for Authorized-Discovery-Range AVP (TS 29.344) | | +| | | | 0440 | 2 | | Location Update Trigger | | +| | | | 0441 | 1 | | AVP codes allocation for Validity related AVPs for TS 29.345 | | +| | | | 0443 | - | | Allocation of codes for the Integrity Checks. Aspect AVPs | | +| 2015-03 | CT#67 | CP-150039 | 0439 | 1 | | Diameter Application Identifier for Np protocol | 13.0.0 | +| 2015-06 | CT#68 | CP-150257 | 0450 | 1 | | AVP code allocation for Match Refresh Timer AVP in TS 29.345 | 13.1.0 | +| | | CP-150247 | 0457 | - | | Wrong CR implementation of CR 0416r1 | | +| | | CP-150249 | 0459 | 1 | | AVP code allocation for 32.299 | | +| | | CP-150263 | 0452 | 1 | | AVP codes for Access Restriction Data per PLMN | | +| | | CP-150372 | 0461 | - | | IP-SM-GW-Realm | | +| 2015-09 | CT#69 | CP-150454 | 0462 | - | | Subscription data for extended buffering at the SGW | 13.2.0 | +| | | CP-150442 | 0463 | - | | Overlapping transaction over S6b | | +| | | CP-150453 | 0464 | 2 | | Addition of IMSI Group Id AVP definition | | +| | | CP-150449 | 0465 | 3 | | Addition of CP parameter AVP definition | | +| | | CP-150431 | 0470 | 1 | | AVP codes for TS 29.212 | | +| | | CP-150456 | 0471 | 3 | | AVP definition for S6t | | +| 2015-12 | CT#70 | CP-150761 | 0473 | - | | Addition of MBMS-Cell-List AVP | 13.3.0 | +| | | CP-150778 | 0474 | - | | S6t Application ID and Command Codes | | +| | | CP-150778 | 0474 | 1 | | Bitmask to inform the SCEF of the Monitoring capabilities | | +| | | CP-150778 | 0490 | 1 | | AVP codes for MONTE T6a/b interface | | +| | | CP-150778 | 0491 | 1 | | Correction to SCEF-Reference-ID and SCEF-Reference-ID-For-Deletion data types | | +| | | CP-150778 | 0494 | 2 | | Definition of AVP for deletion of all Monitoring events assigned to a subscriber (UE) | | +| | | CP-150778 | 0501 | 1 | | Definition of AVP SCEF-ID | | +| | | CP-150778 | 0502 | 2 | | Service result per Event configuration | | +| | | CP-150770 | 0475 | 1 | | Emergency PDN connection over untrusted WLAN access | | +| | | CP-150776 | 0476 | - | | EPC-MT-LR and PS-MT-LR procedure for UEs transiently not reachable due to power saving | | +| | | CP-150776 | 0497 | 1 | | Mobile Terminating SMS handling for extended Idle mode DRX | | +| | | CP-150776 | 0498 | 1 | | Mobile Terminating SMS handling for extended Idle mode DRX – Additional Option | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|--------------------------------------------------------------------------------------------------------------------------------|--------| +| | | CP-150777 | 0477 | 3 | | Commands and codes for Np protocol | | +| | | CP-150772 | 0479 | 1 | | Definition of ProSe-Metadata-Index-Mask | | +| | | CP-150772 | 0489 | - | | Addition of AVPs and result-codes | | +| | | CP-150772 | 0500 | - | | Addition of AVP used in match report procedure for eProSe-Ext-CT | | +| | | CP-150754 | 0481 | 1 | | Allowed WAF and/or WWSF Identities | | +| | | CP-150773 | 0482 | - | | Add the default access type to 3GPP specific AVP | | +| | | CP-150781 | 0484 | 1 | | AVP code allocation for "UE Usage Type" | | +| | | CP-150755 | 0486 | - | | Metadata in Match-Report | | +| | | CP-150755 | 0488 | - | | New Group AVP for ProSe direct discovery procedures | | +| | | CP-150771 | 0492 | 1 | | Definition of AVP for AESE-CT | | +| | | CP-150771 | 0496 | 1 | | Command codes and AVP range for TS 29.154 and TS 29.153 | | +| | | CP-150776 | 0495 | 1 | | AVP codes for Indoor Positioning support in SLg/Lgd | | +| 2016-03 | CT#71 | CP-160041 | 0503 | - | | Application ID for St | 13.4.0 | +| | | CP-160041 | 0506 | 1 | | Correction on TS numbers | | +| | | CP-160041 | 0510 | - | | AVPs for the Rx Diameter application | | +| | | CP-160041 | 0514 | 2 | | AVP code reservation for 32.299 | | +| | | CP-160041 | 0518 | 1 | | Codes for 29.212 | | +| | | CP-160029 | 0505 | 3 | | New AVP assignment for MONTE | | +| | | CP-160029 | 0509 | - | | Change of type of Monitoring-Duration AVP to represent an absolute time | | +| | | CP-160035 | 0507 | - | | Remove the default access AVP | | +| | | CP-160035 | 0508 | - | | Specific AVP codes for NBIFOM | | +| | | CP-160030 | 0511 | - | | Alert procedure from MME/SGSN to SMS-GMSC for MT SMS to UE using eDRX | | +| | | CP-160037 | 0512 | - | | ePDG retrieval of WLAN Location Information | | +| | | CP-160033 | 0513 | 2 | | Definition of AVP Authorization of NIDD | | +| | | CP-160033 | 0520 | 2 | | New PDN-Type for Cellular IoT | | +| | | CP-160036 | 0517 | 1 | | Monitoring update and Reporting of update result | | +| | | CP-160036 | 0519 | 3 | | Allocation of new Diameter Application ID and commands code for PC2 protocol | | +| 2016-03 | CT#71 | CP-160018 | 0515 | 1 | | AVP code reservation for 32.299 | 14.0.0 | +| 2016-06 | CT#72 | CP-160236 | 0526 | 1 | | Command Codes for 29.212 | 14.1.0 | +| 2016-06 | CT#72 | CP-160236 | 0543 | - | | AVP code range 3900-3999 | 14.1.0 | +| 2016-06 | CT#72 | CP-160236 | 0557 | 1 | | New AVPs in TS 29.214 | 14.1.0 | +| 2016-06 | CT#72 | CP-160236 | 0565 | - | | AVP codes for 29.212 | 14.1.0 | +| 2016-06 | CT#72 | CP-160232 | 0528 | 2 | | AVP Codes for 29.343 | 14.1.0 | +| 2016-06 | CT#72 | CP-160232 | 0533 | 3 | | Addition of new AVPs for ProSe direct discovery security and open ProSe direct discovery with application-controlled extension | 14.1.0 | +| 2016-06 | CT#72 | CP-160232 | 0540 | - | | Reserved Experimental Result Codes for TS 29.343 | 14.1.0 | +| 2016-06 | CT#72 | CP-160232 | 0549 | - | | Assignment of application ID and command code for PC2 reference point | 14.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0531 | - | | IANA Command Code Registration | 14.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0541 | 1 | | CloT new commands and Diameter error | 14.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0550 | - | | NIDD authorisation update | 14.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0560 | 3 | | Serving PLMN Rate Control | 14.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0563 | - | | New AVP for APN Rate Control | 14.1.0 | +| 2016-06 | CT#72 | CP-160233 | 0537 | 1 | | Renaming of Validity-Time AVP | 14.1.0 | +| 2016-06 | CT#72 | CP-160233 | 0562 | 1 | | New AVPs allocated for 29.153 and 29.154 | 14.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0545 | 3 | | SCEF Realm | 14.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0548 | - | | Cleanup up on MONTE AVP's | 14.1.0 | +| 2016-06 | CT#72 | CP-160227 | 0546 | - | | IANA assigned application Id and command code values | 14.1.0 | +| 2016-06 | CT#72 | CP-160227 | 0547 | 2 | | Allocation of AVP codes and Experimental Result codes for Diameter Data Management application | 14.1.0 | +| 2016-06 | CT#72 | CP-160231 | 0553 | 1 | | 3GPP specific AVP for NBIFOM | 14.1.0 | +| 2016-06 | CT#72 | CP-160222 | 0555 | 1 | | Shared Subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160424 | 0570 | 1 | | Missing AVP codes and Experimental-Result codes for T6a | 14.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0574 | 1 | | Allocate of AVP Handling of Exception Reports in the Core Network | 14.2.0 | +| 2016-09 | CT#73 | CP-160419 | 0572 | 1 | | AVP codes for 32.299 | 14.2.0 | +| 2016-09 | CT#73 | CP-160419 | 0576 | 1 | | AVP code for 29.214 | 14.2.0 | +| 2016-09 | CT#73 | CP-160419 | 0578 | 1 | | AVP code for 29.212 | 14.2.0 | +| 2016-09 | CT#73 | CP-160436 | 0568 | 1 | | STa and SWm extensions for IMEI check | 14.2.0 | +| 2016-12 | CT#74 | CP-160650 | 0582 | - | | AVP code alignment with 29.272 | 14.3.0 | +| 2016-12 | CT#74 | CP-160679 | 0579 | 1 | | AVPs for Handover of Emergency PDN Connections | 14.3.0 | +| 2016-12 | CT#74 | CP-160678 | 0583 | 1 | | New Diameter Application Code, AVP and Result Code for V2X | 14.3.0 | +| 2016-12 | CT#74 | CP-160653 | 0585 | 1 | | Renaming of Emergency-Indication AVP | 14.3.0 | +| 2016-12 | CT#74 | CP-160670 | 0586 | 2 | | New AVPs for TS 29.214 | 14.3.0 | +| 2016-12 | CT#74 | CP-160660 | 0590 | - | | S6t-HSS-Cause | 14.3.0 | +| 2016-12 | CT#74 | CP-160669 | 0591 | - | | AVP codes for 29.468 | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0592 | 1 | | Enhanced Coverage | 14.4.0 | +| 2017-03 | CT#75 | CP-170039 | 0593 | 1 | | Inter-RAT PDN-Continuity | 14.4.0 | +| 2017-03 | CT#75 | CP-170039 | 0595 | 1 | | NIDD Authorization revocation | 14.4.0 | +| 2017-03 | CT#75 | CP-170036 | 0594 | 1 | | Loss Of Connectivity Reason | 14.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|--|---------------------------------------------------------------|--------| +| 2017-03 | CT#75 | CP-170036 | 0602 | 1 | | Subscription parameters for eDRX | 14.4.0 | +| 2017-03 | CT#75 | CP-170036 | 0607 | 1 | | Support of long and short Macro eNodeB IDs | 14.4.0 | +| 2017-03 | CT#75 | CP-170025 | 0597 | - | | AVP codes for 32.299 | 14.4.0 | +| 2017-03 | CT#75 | CP-170043 | 0598 | 1 | | New AVP for UE-PC5-AMBR | 14.4.0 | +| 2017-03 | CT#75 | CP-170043 | 0603 | 1 | | Correct Diameter Result Code Allocated for V2X | 14.4.0 | +| 2017-03 | CT#75 | CP-170049 | 0601 | 1 | | AVPs for ERP in 29.273 | 14.4.0 | +| 2017-03 | CT#75 | CP-170052 | 0605 | - | | Update of the name of MCPTT-User-Profile-Data AVP | 14.4.0 | +| 2017-03 | CT#75 | CP-170045 | 0606 | - | | Support of MCVideo and MCData Services | 14.4.0 | +| 2017-06 | CT#76 | CP-171029 | 0600 | 4 | | New AVP for Group Based MONTE Event Configuration via HSS | 14.5.0 | +| 2017-06 | CT#76 | CP-171017 | 0609 | - | | New AVPs in 29.272 for MBSFN MDT | 14.5.0 | +| 2017-06 | CT#76 | CP-171026 | 0610 | - | | AVP codes for 29.212 | 14.5.0 | +| 2017-06 | CT#76 | CP-171026 | 0611 | - | | AVP codes for 29.214 | 14.5.0 | +| 2017-06 | CT#76 | CP-171030 | 0612 | 1 | | AVP code allocation for 29.172 for Location Services for CioT | 14.5.0 | +| 2017-06 | CT#76 | CP-171030 | 0613 | - | | Addition of APN-Validity-Time AVP | 14.5.0 | +| 2017-06 | CT#76 | CP-171026 | 0615 | - | | AVP codes for 32.299 | 14.5.0 | +| 2017-09 | CT#77 | CP-172018 | 0616 | 1 | | Reliable Data Service Success cause | 14.6.0 | +| 2017-09 | CT#77 | CP-172018 | 0617 | 1 | | Reliable Data Service | 14.6.0 | +| 2017-09 | CT#77 | CP-172026 | 0618 | 1 | | Enhancements for NAPPS | 15.0.0 | +| 2017-12 | CT#78 | CP-173011 | 0625 | - | | AVP codes for TS 29.219, TS 29.212 and TS 29.214 | 15.1.0 | +| 2017-12 | CT#78 | CP-173033 | 0619 | 1 | | Suggested Network Configuration Request | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0620 | - | | Monitoring Event Report Status | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0626 | - | | AVP code for PLMN-ID-Requested in S6t | 15.1.0 | +| 2017-12 | CT#78 | CP-173032 | 0627 | - | | New AVP for PC5-tech for WLAN based ProSe Direct Discovery | 15.1.0 | +| 2018-03 | CT#79 | CP-180021 | 0628 | 1 | | Service Gap Time AVP | 15.2.0 | +| 2018-03 | CT#79 | CP-180020 | 0629 | 1 | | AVP codes for 32.299 | 15.2.0 | +| 2018-03 | CT#79 | CP-180025 | 0630 | - | | IMSI-Group-Id retrieval | 15.2.0 | +| 2018-06 | CT#80 | CP-181120 | 0631 | 1 | | Supported-Services and Supported-Monitoring-Events | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0632 | 1 | | New AVPs in TS 29.212 for eVoLP | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0633 | 1 | | Reserve Diameter codes for TS 29.561 | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0635 | - | | Application ID for Diameter Nta | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0636 | 1 | | AVP codes for TS 29.154 | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0637 | 1 | | New AVP for subscription for Aerial UE in 3GPP system | 15.3.0 | +| 2018-06 | CT#80 | CP-181120 | 0639 | 1 | | AVP codes for 32.299 | 15.3.0 | +| 2018-06 | CT#80 | CP-181124 | 0640 | 1 | | Subscription data for ciphering keys | 15.3.0 | +| 2018-06 | CT#80 | CP-181127 | 0634 | - | | AVP code for NIR-Flags | 15.3.0 | +| 2018-09 | CT#81 | CP-182080 | 0642 | - | | AVP code for TS 29.214 | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0643 | - | | AVP codes for TS 29.468 | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0644 | - | | Update tables due to N6 | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0645 | 1 | | Change of value type of Maximum Packet Loss Rate | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0646 | 1 | | Subscribed PTW length | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0647 | 1 | | Policy Update when UE suspends | 15.4.0 | +| 2018-09 | CT#81 | CP-182073 | 0648 | 1 | | Command Codes for Nta Diameter Application | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0649 | - | | Core Network Restrictions | 15.4.0 | +| 2018-09 | CT#81 | CP-182071 | 0651 | - | | DSR-Flag for eDRX-Cycle-Length | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0653 | 1 | | Interworking-5GS-Indicator AVP definition | 15.5.0 | +| 2018-12 | CT#82 | CP-183095 | 0652 | 1 | | Monitoring event report | 15.5.0 | +| 2018-12 | CT#82 | CP-183102 | 0654 | - | | Wrong AVP type in Access-Restriction-Data | 15.5.0 | +| 2018-12 | CT#82 | CP-183102 | 0655 | - | | NIDD group authorization | 15.5.0 | +| 2019-03 | CT#83 | CP-190036 | 0656 | 1 | | New AVP for MB2 | 15.6.0 | +| 2019-03 | CT#83 | CP-190036 | 0657 | 1 | | RTR-Flags | 15.6.0 | +| 2019-03 | CT#83 | CP-190037 | 0658 | 1 | | Handling of multiple external IDs for the same UE | 15.6.0 | +| 2019-09 | CT#85 | CP-192125 | 0662 | - | | Add P-CSCF subscription info to Restoration information | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0661 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0664 | - | | Ethernet PDN Type AVP | 16.0.0 | +| 2019-09 | CT#85 | CP-192121 | 0663 | 1 | | Communication pattern enhancement | 16.0.0 | +| 2019-12 | CT#86 | CP-193035 | 0669 | 1 | | UE Status Suspend | 16.1.0 | +| 2019-12 | CT#86 | CP-103038 | 0666 | 1 | | New Error Code for TS 29.336 | 16.1.0 | +| 2019-12 | CT#86 | CP-103038 | 0671 | - | | Subscribed ARPI AVP | 16.1.0 | +| 2019-12 | CT#86 | CP-103038 | 0672 | - | | Network Parameter Configuration Reporting AVP | 16.1.0 | +| 2019-12 | CT#86 | CP-103038 | 0673 | 2 | | New AVP defined in TS 29.214 for Callee-Information | 16.1.0 | +| 2019-12 | CT#86 | CP-193040 | 0667 | - | | S-CSCF restoration after registration timer expiry | 16.1.0 | +| 2019-12 | CT#86 | CP-193052 | 0665 | 1 | | Battery Indication for Communication pattern enhancement | 16.1.0 | +| 2020-03 | CT#87e | CP-200041 | 0676 | 1 | | AVP codes for 32.299 | 16.2.0 | +| 2020-03 | CT#87e | CP-200041 | 0678 | - | | New AVPs in TS 29.214 | 16.2.0 | +| 2020-03 | CT#87e | CP-200027 | 0677 | 3 | | Addition of AVP code for IAB-Node-Information AVP | 16.2.0 | +| 2020-03 | CT#87e | CP-200036 | 0679 | - | | Subscription data for NR V2X | 16.2.0 | +| 2020-03 | CT#87e | CP-200050 | 0680 | - | | Reachability Cause | 16.2.0 | +| 2020-06 | CT#88e | CP-201016 | 0685 | - | | SMSF Address | 16.3.0 | +| 2020-06 | CT#88e | CP-201049 | 0681 | - | | Authorized PLMNs and RATs for V2X | 16.3.0 | +| 2020-06 | CT#88e | CP-201049 | 0682 | - | | Subscribed PC5 QoS Parameters for NR V2X | 16.3.0 | +| 2020-09 | CT#89e | CP-202094 | 0687 | 1 | | AVP Codes for TS 29.214 | 16.4.0 | +| 2020-12 | CT#90e | CP-203032 | 0688 | - | | Extended Reference ID | 16.5.0 | +| 2021-03 | CT#90e | CP-210057 | 0689 | - | | Default APN for Ethernet PDN types | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------|--------| +| 2021-09 | CT#93e | CP-212073 | 0690 | 1 | F | APN Rate Control Status | 16.7.0 | +| 2021-09 | CT#93e | CP-212037 | 0691 | 1 | B | New AVP Exclude-Identifiers | 17.0.0 | +| 2021-12 | CT#94e | CP-213128 | 0692 | 1 | F | AVP code for TS 29.468 | 17.1.0 | +| 2021-12 | CT#94e | CP-213110 | 0694 | 1 | B | New AVP Include-Identifiers | 17.1.0 | +| 2022-03 | CT#95e | CP-220052 | 0697 | 2 | B | Adding new Alternate-Digest AVPs | 17.2.0 | +| 2022-03 | CT#95e | CP-220054 | 0695 | - | B | Failed P-CSCF AVPs | 17.2.0 | +| 2022-12 | CT#98e | CP-223038 | 0702 | - | F | Experimental Result Codes for TS 29.273 | 18.0.0 | +| 2023-06 | CT#100 | CP-231039 | 0703 | - | B | Add SBI support indicator AVPs for S6c | 18.1.0 | +| 2023-09 | CT#101 | CP-232035 | 0705 | 1 | F | Add AMF-Instance-Id AVP | 18.2.0 | +| 2023-09 | CT#101 | CP-232055 | 0706 | - | B | AVP for MPS for WLAN | 18.2.0 | \ No newline at end of file diff --git a/gsma/29_series/29255/raw.md b/gsma/29_series/29255/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b6e7f554a6d6e72701f9e3e00816b619fab4fdaa --- /dev/null +++ b/gsma/29_series/29255/raw.md @@ -0,0 +1,1229 @@ + + +# 3GPP TS 29.255 V18.2.0 (2023-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Core Network and Terminals; +5G System; +Uncrewed Aerial System Service Supplier (USS) Services; +Stage 3 +(Release 18)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5G" text are three green, curved lines representing signal waves. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "G" has a red signal wave icon below it. To the right of the "P" is a small "TM" symbol. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Services offered by the USS ..... | 8 | +| 4.1 Introduction ..... | 8 | +| 4.2 Naf_Authentication Service ..... | 8 | +| 4.2.1 Service Description ..... | 8 | +| 4.2.1.1 Overview..... | 8 | +| 4.2.1.2 Service Architecture ..... | 9 | +| 4.2.1.3 Network Functions..... | 9 | +| 4.2.1.3.1 Uncrewed Aerial System Service Supplier (USS) ..... | 9 | +| 4.2.1.3.2 NF Service Consumers..... | 9 | +| 4.2.2 Service Operations..... | 10 | +| 4.2.2.1 Introduction..... | 10 | +| 4.2.2.2 Naf_Authentication_AuthenticateAuthorize Service operation ..... | 10 | +| 4.2.2.2.1 General ..... | 10 | +| 4.2.2.2.2 Authentication and Authorization of the UAV ..... | 10 | +| 4.2.2.3 Naf_Authentication_Notification Service operation ..... | 11 | +| 4.2.2.3.1 General ..... | 11 | +| 4.2.2.3.2 Notification for Reauthentication, Reauthorization or Revocation..... | 12 | +| 5 API Definitions ..... | 13 | +| 5.1 Naf_Authentication Service API..... | 13 | +| 5.1.1 Introduction ..... | 13 | +| 5.1.2 Usage of HTTP..... | 13 | +| 5.1.2.1 General..... | 13 | +| 5.1.2.2 HTTP standard headers..... | 13 | +| 5.1.2.2.1 General ..... | 13 | +| 5.1.2.2.2 Content type ..... | 13 | +| 5.1.2.3 HTTP custom headers..... | 13 | +| 5.1.3 Resources..... | 14 | +| 5.1.4 Custom Operations without associated resources ..... | 14 | +| 5.1.4.1 Overview..... | 14 | +| 5.1.4.2 Operation: request-auth..... | 14 | +| 5.1.4.2.1 Description ..... | 14 | +| 5.1.4.2.2 Operation Definition ..... | 14 | +| 5.1.5 Notifications ..... | 15 | +| 5.1.5.1 General..... | 15 | +| 5.1.5.2 UAV Notification ..... | 16 | +| 5.1.5.2.1 Description ..... | 16 | +| 5.1.5.2.2 Target URI..... | 16 | +| 5.1.5.2.3 Standard Methods..... | 16 | +| 5.1.5.2.3.1 POST ..... | 16 | +| 5.1.6 Data Model ..... | 17 | +| 5.1.6.1 General..... | 17 | +| 5.1.6.2 Structured data types..... | 17 | +| 5.1.6.2.1 Introduction ..... | 17 | +| 5.1.6.2.2 Type: UAVAuthInfo ..... | 18 | +| 5.1.6.2.3 Type: ReauthRevokeNotify..... | 19 | +| 5.1.6.2.4 Type: UAVAuthResponse..... | 20 | +| 5.1.6.2.5 Type: AdditionInfoAuthenticateAuthorize ..... | 20 | + +| | | | +|--------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.1.6.2.6 | Type: AuthContainer..... | 21 | +| 5.1.6.3 | Simple data types and enumerations..... | 21 | +| 5.1.6.3.1 | Introduction ..... | 21 | +| 5.1.6.3.2 | Simple data types ..... | 21 | +| 5.1.6.3.3 | Enumeration: AuthResult..... | 21 | +| 5.1.6.3.4 | Enumeration: NotifyType ..... | 21 | +| 5.1.6.3.5 | Void..... | 22 | +| 5.1.6.3.6 | Enumeration: AuthMsgType..... | 22 | +| 5.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 22 | +| 5.1.6.4.1 | Type: ProblemDetailsAuthenticateAuthorize ..... | 22 | +| 5.1.7 | Error Handling ..... | 22 | +| 5.1.7.1 | General..... | 22 | +| 5.1.7.2 | Protocol Errors ..... | 22 | +| 5.1.7.3 | Application Errors..... | 22 | +| 5.1.8 | Feature negotiation ..... | 22 | +| 5.1.9 | Security..... | 23 | +| Annex A (normative): OpenAPI specification..... | | 24 | +| A.1 | General..... | 24 | +| A.2 | Naf_Authentication API ..... | 24 | +| Annex B (informative): Change history ..... | | 29 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the UAS-specific Naf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UAS-specific AF. + +The 5G System stage 2 architecture and procedures are specified in TS 23.501 [2], TS 23.502 [3], and TS 23.256 [14]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in TS 29.500 [4], and TS 29.122 [16]. + +The UAS Service Supplier (USS) provides the UAS-specific AF services to NF service consumers (e.g. NEF (UAS-NF)). The USS is functionality within the AF. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 7807: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. For the purposes of the present document, the terms and definitions given in TS 23.256 [14] shall apply. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. + +| | | +|--------|-----------------------------------------| +| AA | Authorization/Authentication | +| AF | Application Function | +| NEF | Network Exposure Function | +| UAS | Uncrewed Aerial System | +| UAS-NF | Uncrewed Aerial System Network Function | +| UAV | Uncrewed Aerial Vehicle | +| USS | UAS Service Supplier | +| UUAA | USS UAV Authorization/Authentication | + +# 4 Services offered by the USS + +## 4.1 Introduction + +Table 4.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 4.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------------|--------|----------------------------------------------|---------------------------------|----------|-------| +| Naf_Authentication | 5.1 | USS Authentication and Authorization Service | TS29255_Naf_Authentication.yaml | naf-auth | A.2 | + +## 4.2 Naf\_Authentication Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Naf\_Authentication service as defined in TS 23.256 [14] is provided by the USS via the Naf service-based interface (see TS 23.256 [14]). + +This service: + +- allows NF consumers to authentication and authorization of the UAV with the USS; and +- notifies NF consumers about reauthentication, reauthorization and revocation. + +#### 4.2.1.2 Service Architecture + +The Application Function Authentication Service (Naf\_Authentication) is part of the Naf service-based interface exhibited by the Application Function (AF) which owns the functionality of USS. + +The known NF service consumers of the Naf\_Authentication are the Network Exposure Function (NEF) which owns the functionality of UAS-NF. + +Figures 4.2.1.2-1 and 4.2.1.2-2 provide the reference model (in service-based interface representation and in reference point representation), with focus on the USS and the scope of the present specification. + +![Figure 4.2.1.2-1: Reference architecture for Naf_Authentication service: SBI representation. The diagram shows an Application Function (AF) box containing a USS box and a Naf circle. Below the AF box is a UAS-NF box, which is inside a larger NEF box. A vertical line labeled 'Naf_Authentication' connects the Naf circle to the UAS-NF box.](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +Figure 4.2.1.2-1: Reference architecture for Naf\_Authentication service: SBI representation. The diagram shows an Application Function (AF) box containing a USS box and a Naf circle. Below the AF box is a UAS-NF box, which is inside a larger NEF box. A vertical line labeled 'Naf\_Authentication' connects the Naf circle to the UAS-NF box. + +**Figure 4.2.1.2-1: Reference architecture for Naf\_Authentication service: SBI representation** + +![Figure 4.2.1.2-2: Reference architecture for Naf_Authentication service: reference point representation. The diagram shows a NEF box containing a UAS-NF box on the left, connected by a horizontal line labeled 'N33' to a box on the right. The right box contains a USS box and an AF box.](99bae07626f60f9ede10e2e387ef7051_img.jpg) + +Figure 4.2.1.2-2: Reference architecture for Naf\_Authentication service: reference point representation. The diagram shows a NEF box containing a UAS-NF box on the left, connected by a horizontal line labeled 'N33' to a box on the right. The right box contains a USS box and an AF box. + +**Figure 4.2.1.2-2: Reference architecture for Naf\_Authentication service: reference point representation** + +The functionalities supported by the USS are listed in clause 4.3.2 of TS 23.256 [14]. + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Uncrewed Aerial System Service Supplier (USS) + +The UAS service supplier (USS) application provides authentication and authorization for the UAV. + +The UAS service supplier (USS) allows NF consumers to exchange communication messages needed for authentication and authorization procedure. It also notifies NF consumers about reauthentication, reauthorization or revocation of the UAV. + +##### 4.2.1.3.2 NF Service Consumers + +The Uncrewed Aerial System network function (UAS NF): + +- supports authentication and authorization of the UAV with the USS; +- supports subscription for notification of reauthentication, reauthorization and revocation of the UAV from the USS. + +### 4.2.2 Service Operations + +#### 4.2.2.1 Introduction + +#### 4.2.2.2 Naf\_Authentication\_AuthenticateAuthorize Service operation + +##### 4.2.2.2.1 General + +The Naf\_Authentication\_AuthenticateAuthorize service operation is used by the NF consumers during following procedure: + +- UUAA-MM and UUAA-SM procedures (see TS 23.256 [14], clause 5.2.2 and clause 5.2.3, respectively) +- C2 authorization (see TS 23.256 [14], clause 5.2.5.2 and clause 5.4.3) + +##### 4.2.2.2.2 Authentication and Authorization of the UAV + +The Naf\_Authentication\_AuthenticateAuthorize service operation is invoked by an NF Service Consumer (e.g. an NEF (UAS-NF)) towards the USS, when UUAA-MM is done during 5GS registration, UUAA-SM is done during PDU session establishment, or for authorization for C2 communication over Uu interface or Direct C2 communication over PC5 interface (see TS 23.256 [14]). + +The NF Service Consumer (e.g. the NEF (UAS-NF)) shall send the authentication message to USS by sending the HTTP POST request towards the "request-auth" resource as shown in Figure 4.2.2.2.2-1. + +![Sequence diagram showing the AuthenticateAuthorize Service Operation between an NF Service Consumer and a USS. The NF Service Consumer sends a POST request to the USS. The USS responds with either a 200 OK or a 4xx/5xx or 3xx status code.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant USS + Note left of NF Service Consumer: + NF Service Consumer->>USS: 1. POST.../request-auth + Note right of USS: + USS-->>NF Service Consumer: 2a. 200 OK + Note right of USS: + USS-->>NF Service Consumer: 2b. 4xx/5xx or 3xx + +``` + +Sequence diagram showing the AuthenticateAuthorize Service Operation between an NF Service Consumer and a USS. The NF Service Consumer sends a POST request to the USS. The USS responds with either a 200 OK or a 4xx/5xx or 3xx status code. + +**Figure 4.2.2.2.2-1: AuthenticateAuthorize Service Operation** + +1. The NF Service Consumer shall send a POST request to the resource with a UAVAuthInfo object in the request body. The UAVAuthInfo data type shall include: + +- "gpsi" attribute that carries the GPSI (in the format of External Identifier) of the UAV; +- "serviceLevelId" attribute that carries the Service Level Device Identity of the UAV; + +The UAVAuthInfo data type may include + +- "uavLocInfo" attribute that provides the UAV location; +- "notifyUri" attribute that provides the notification URI to receive notifications related to reauthentication, reauthorization or revocation triggered by the USS, which shall be present in the initial request; +- "notifyCorrId" attribute that represents the notification correlation ID and this attribute shall be present when the "notifyUri" attribute is provided; +- "authMsg" attribute that contains the authentication message based on the authentication method used, which is present in the intermediate round-trip messages and not in initial request. This attribute is deprecated; the attribute "authContainer" should be used instead. + +- "AuthContainer" data type that contains the AA related data provided by the UE (see TS 23.256 [14]). This attribute deprecates "authMsg" attribute and may contain: +- "authMsgType" attribute that indicates the type of the AA message payload; +- "authMsgPayload" attribute that carries the AA message payload; + +NOTE 1: The "authResult" attribute will not be present within the AuthContainer data type, when included within the request sent to USS. + +In case of UUAA-SM procedure, the UAVAuthInfo data type may also include: + +- "ipAddr" attribute that carries the IP Address associated with the PDU session; and +- "pei" attribute that carries the PEI of the UAV. + +- 2a. If the HTTP request message from the NF service consumer is accepted, the USS shall respond with "200 OK" status code with the message body containing the UAVAuthResponse data type in the response body, which shall include "gpsi" attribute. + +If the USS triggers more intermediate round-trip messages, the UAVAuthResponse data shall include a "authMsg" attribute that contains the authentication message or authorization data. + +Otherwise, the UAVAuthResponse data type shall contain the "authResult" attribute. If the UAV is authenticated successfully, the USS shall set the "authResult" attribute to "AUTH\_SUCCESS". The "authMsg" and "authResult" attributes are deprecated; the "authContainer" attribute should be used instead. The UAVAuthResponse data type shall include the "authContainer" data type that may include: + +- AA message payload type within "authMsgType" attribute; +- AA message payload containing the configuration information within "authMsgPayload" attribute; +- AA result within "authResult" attribute, which is set to either "AUTH\_SUCCESS" in case of successful AA procedure or to "AUTH\_FAIL" in case of failed AA procedure in the final response of the AA procedure. + +NOTE 2: The absence of "authResult" attribute within "AuthContainer" data type indicates that the AA procedure is ongoing. + +- The "serviceLevelId" attribute containing a new Service Level Device Identity as the authorized Service Level Device Identity to the UAV. + +The UAVAuthResponse data type may also include: + +- the DN authorization profile index within the "authProfIndex" attribute; +- the DN authorized Session-AMBR within the "authSessAmbr" attribute. + +- 2b. If the USS cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the USS shall send the HTTP error response as specified in clause 5.1.7. + +If the UAV authentication is failed, the USS shall reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetailsAuthenticateAuthorize data structure set to "FAILED\_AUTH". The USS shall also include an indication of "uasResRelInd" attribute in the ProblemDetailsAuthenticateAuthorize data type to indicate if an UAS service related network resource can be released or not, during re-authentication failure, when the service operation is used during Re-authentication procedure. + +If the USS determines the received HTTP POST request needs to be redirected, the USS shall send an HTTP redirect response as specified in clause 5.2.10 of TS 29.122 [16]. + +#### 4.2.2.3 Naf\_Authentication\_Notification Service operation + +##### 4.2.2.3.1 General + +The Naf\_Authentication\_Notification service operation is used by the NF consumers during the following procedure: + +- USS Initiated Re-authentication and Re-authorization (see TS 23.256 [14], clause 5.2.4) +- USS Initiated Revocation (see TS 23.256 [14], clause 5.2.7) + +##### 4.2.2.3.2 Notification for Reauthentication, Reauthorization or Revocation + +The Naf\_Authentication\_Notification service operation is invoked by the USS to inform a NF Service Consumer (e.g. NEF (UAS-NF)), when USS triggers reauthentication, update authorization data or revoke authorization of the UAV. + +The USS shall send the request by sending the HTTP POST method towards the Notification URI as shown in Figure 4.2.2.3.2-1. + +![Sequence diagram showing the UAV Notification Service Operation between an NF Service Consumer and a USS. The USS sends a POST {notifyUri} request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx or 3xx.](853f59c89931a666c07903b31d098277_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant USS + Note left of NF Service Consumer: + USS->>NF Service Consumer: 1. POST {notifyUri} + NF Service Consumer-->>USS: 2a. 204 No Content + NF Service Consumer-->>USS: 2b. 4xx/5xx or 3xx + +``` + +Sequence diagram showing the UAV Notification Service Operation between an NF Service Consumer and a USS. The USS sends a POST {notifyUri} request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx or 3xx. + +Figure 4.2.2.3.2-1: UAV Notification Service Operation + +1. The USS shall send a POST request towards the Notification URI received in the Authenticate service operation request (See clause 4.2.2.1). The request body shall contain a ReauthRevokeNotify object containing the reauthentication information, update authorization information or revoke authorization indication. The ReauthRevokeNotify data type shall include: + - the "gpsi" attribute is set to the GPSI (in the format of External Identifier) of the given UAV required to be reauthenticated, reauthorized or revoked; + - the "serviceLevelId" attribute is set to the Service Level Device Identity of the UAV; + - the "notifyCorrId" attribute is set to the same value as the "notifyCorrId" attribute of UAVAuthInfo data type received in the request; + - the "notifyType" attribute is set to REAUTHENTICATE for reauthentication or set to REAUTHORIZE for authorization data update or set to REVOKE for revocation of authorization. In addition, if "notifyType" attribute is set to REAUTHORIZE, then attribute "authMsg" containing the authorization data shall be included. "authMsg" attribute is deprecated; the "authContainer" attribute should be used instead, which carries the authorization data. + +NOTE: The "authResult" attribute will not be present within the AuthContainer data type, when included within the Notification request sent by the USS. + +The ReauthRevokeNotify may also include: + +- the "ipAddr" attribute carries the IP Address associated with the PDU session; +- 2a. On success, "204 No content" shall be returned without response body. If the "notifyType" attribute in the request indicated REVOKE, then UAS service related network resources are released. + - 2b. If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 5.2.10 of TS 29.122 [16]. + +# 5 API Definitions + +## 5.1 Naf\_Authentication Service API + +### 5.1.1 Introduction + +The Naf\_Authentication shall use the Naf\_Authentication API. + +The API URI of the Naf\_Authentication API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 5.2.4 of TS 29.122 [16], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 in 3GPP TS 29.122 [16]. +- The shall be "naf-auth". +- The shall be "v1". +- The shall be set as described in clause 5.1.3. + +### 5.1.2 Usage of HTTP + +#### 5.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in of TS 29.122 [16]. + +HTTP/2 shall be transported as specified in TS 29.122 [16]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Naf\_Authentication API is contained in Annex A. + +#### 5.1.2.2 HTTP standard headers + +##### 5.1.2.2.1 General + +See TS 29.122 [16] for the usage of HTTP standard headers. + +##### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in TS 29.122 [16]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 7807 [13]. + +NOTE: This release only supports the content type JSON. + +#### 5.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of TS 29.500 [4] may be supported. + +### 5.1.3 Resources + +None + +### 5.1.4 Custom Operations without associated resources + +#### 5.1.4.1 Overview + +The structure of the custom operation URIs of the Naf\_Authentication service is shown in Figure 5.1.4.1-1. + +![Diagram showing the URI structure {apiRoot}/naf-auth/v1 with a callout pointing to /request-auth.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +The diagram shows the URI structure `{apiRoot}/naf-auth/v1`. A line extends from the bottom of the URI to a dashed rectangular box containing the text `/request-auth`, indicating that this path is appended to the base URI for the custom operation. + +Diagram showing the URI structure {apiRoot}/naf-auth/v1 with a callout pointing to /request-auth. + +**Figure 5.1.4.1-1: Custom operation URI structure of the Naf\_Authentication API** + +Table 5.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 5.1.4.1-1: Custom operations without associated resources** + +| Custom operation URI | Mapped HTTP method | Description | +|-----------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------------------------| +| {apiRoot}/naf-auth/<apiVersion>/request-auth | POST | Request UAV authentication and authorization and subscribe to notifications triggered by the USS | + +#### 5.1.4.2 Operation: request-auth + +##### 5.1.4.2.1 Description + +The operation is used by the NF service consumer to request UAV authentication and authorization and subscribe to notifications triggered by the USS. + +##### 5.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 5.1.4.2.2-1 and 5.1.4.2.2-2. + +**Table 5.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------------------------| +| UAVAuthInfo | M | 1 | Represents the data to be used for UAV authentication and authorization | + +**Table 5.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UAVAuthResponse | M | 1 | 200 OK | Successful request of UAV authentication and authorization and subscription to notification of re-authentication and revocation triggered by the USS. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative AF. | +| ProblemDetailsAuthenticateAuthorize | O | 0..1 | 403 Forbidden | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.6-1 of TS 29.122 [16] also apply. + +NOTE 2: Failure cases are described in clause 5.1.7.3. + +**Table 5.1.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI representing the end point of an alternative AF. | + +**Table 5.1.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative AF. | + +### 5.1.5 Notifications + +#### 5.1.5.1 General + +This clause specifies the notifications provided by the Naf\_Authentication service. + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [16]. + +**Table 5.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------|--------------|---------------------------------|--------------------------------------------------------------| +| UAV Notification | {notifyUri} | notify (POST) | Reauthentication, Reauthorization or Revocation notification | + +#### 5.1.5.2 UAV Notification + +##### 5.1.5.2.1 Description + +The UAV Notification is used by the USS to trigger reauthentication, reauthorization or revocation notification to a NF service consumer that has subscribed to such notifications. The USS shall notify the NF Service Consumer when reauthentication is required. + +##### 5.1.5.2.2 Target URI + +The Callback URI "{notifyUri}" shall be used with the callback URI variables defined in table 5.1.5.2.2-1. + +**Table 5.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------|-----------------------------------------------| +| notifyUri | String formatted as URI with the Callback Uri | + +##### 5.1.5.2.3 Standard Methods + +###### 5.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.1.5.2.3.1-1 and the response data structures and response codes specified in table 5.1.5.2.3.2-1. + +**Table 5.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------------------------------------| +| ReauthRevokeNotify | M | 1 | Contains the reauthentication, reauthorization or revocation information. | + +**Table 5.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful notification of reauthentication or reauthorization or revocation. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative NEF. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative NEF. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.6-1 of TS 29.122 [16] also apply. + +**Table 5.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NEF. | + +**Table 5.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NEF. | + +### 5.1.6 Data Model + +#### 5.1.6.1 General + +This clause specifies the application data model supported by the Naf\_Authentication API. + +Table 5.1.6.1-1 specifies the data types defined for the Naf\_Authentication service based interface protocol. + +**Table 5.1.6.1-1: Naf\_Authentication specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------------------|----------------|--------------------------------------------------------------------------------------------------------|---------------| +| UAVAuthInfo | 5.1.6.2.2 | Information within Authenticate Request | | +| UAVAuthResponse | 5.1.6.2.4 | Information within Authenticate Response | | +| AuthResult | 5.1.6.3.3 | Enumeration indicating authentication result | | +| ReauthRevokeNotify | 5.1.6.2.3 | Information within notification | | +| NotifyType | 5.1.6.3.4 | Enumeration Notification type | | +| ProblemDetailsAuthenticateAuthorize | 5.1.6.4.1 | Data type that extends ProblemDetails. | | +| AdditionInfoAuthenticateAuthorize | 5.1.6.2.5 | Contains more details (not only the ProblemDetails) in case an UAV authentication request is rejected. | | +| AuthContainer | 5.1.6.2.6 | Carries the AA related data | | + +Table 5.1.6.1-2 specifies data types re-used by the Naf\_Authentication service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Naf\_Authentication service based interface. + +**Table 5.1.6.1-2: Naf\_Authentication re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|----------------|----------------------------------------------------------------------------------------|---------------| +| BitRate | TS 29.571 [15] | Bit Rate | | +| Pei | TS 29.571 [15] | Permanent Equipment Identifier | | +| Uri | TS 29.571 [15] | Uri | | +| Gpsi | TS 29.571 [15] | GPSI | | +| IpAddr | TS 29.571 [15] | IP address | | +| LocationArea5G | TS 29.122 [16] | User location | | +| ProblemDetails | TS 29.122 [16] | Represents additional information and details on an error response. | | +| SupportedFeatures | TS 29.571 [15] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| RefToBinaryData | TS 29.571 [15] | AA message payload data | | + +#### 5.1.6.2 Structured data types + +##### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.1.6.2.2 Type: UAVAuthInfo + +Table 5.1.6.2.2-1: Definition of type UAVAuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | | +| ipAddr | IpAddr | O | 0..1 | When present, this attribute indicates the IP address associated with the PDU session. | | +| authMsg | string | O | 0..1 | Contains the authentication message or authorization data (which is not present in the initial request) used in the subsequent request messages during multiple round trip message exchanges. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | O | 1..N | Contains the AA related data without the "authResult" attribute. This attribute deprecates "authMsg" attribute. | | +| pei | Pei | O | 0..1 | PEI associated with the UAV. | | +| notifyUri | Uri | C | 0..1 | This attribute shall be present in the initial authentication message.

It carries the notification URI to receive reauthentication, reauthorization or revocation related notifications | | +| notifyCorrId | string | C | 0..1 | Notification correlation ID assigned by the NF service consumer. Shall be present when the "notifyUri" attribute is provided. | | +| uavLocInfo | LocationArea5G | O | 0..1 | This attribute shall contain the UE location information if it is available. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE shall be present during the initial authentication and authorization request if at least one optional feature defined in clause 5.1.8 is supported. | | + +##### 5.1.6.2.3 Type: ReauthRevokeNotify + +Table 5.1.6.2.3-1: Definition of type ReauthRevokeNotify + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| serviceLevelId | string | M | 1 | Service Level Device Identity of the UAV | | +| authMsg | string | C | 0..1 | Contains the authentication message or authorization data.
This attribute shall be present when "notifyType" attribute is set to REAUTHORIZE. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data. This attribute shall be present when "notifyType" attribute is set to REAUTHORIZE. This attribute deprecates "authMsg" attribute. | | +| ipAddr | IpAddr | O | 0..1 | When present, this IE indicates the IP address associated with the PDU session. | | +| notifyCorrId | string | C | 0..1 | Notification correlation ID used to identify the request to which the notification relates.
It shall be present if the "notifyCorrId" attribute is provided in the request and set to the same value as the "notifyCorrId" attribute of UAVAuthInfo data type. | | +| notifyType | NotifyType | M | 1 | This attribute shall contain the notification type. | | + +##### 5.1.6.2.4 Type: UAVAuthResponse + +Table 5.1.6.2.4-1: Definition of type UAVAuthResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | C | 0..1 | GPSI of the UAV.
Shall be present except during PDU Session Modification for C2 Communication procedure. | | +| authResult | AuthResult | C | 0..1 | Conveys the UAV authentication result (success) .
Shall be present if there is no intermediate round-trip messages. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authMsg | string | C | 0..1 | Contains the authentication message or authorization data.
Shall be present if the USS triggers intermediate round-trip messages. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data. | | +| serviceLevelId | string | O | 0..1 | Contains a new Service Level Device Identity of the UAV | | +| authSessAmbr | BitRate | O | 0..1 | The DN Authorized Session-AMBR. | | +| authProfIndex | string | O | 0..1 | DN authorization profile index. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE shall be present during the initial authentication and authorization response if at least one optional feature defined in clause 5.1.8 is supported. | | + +##### 5.1.6.2.5 Type: AdditionInfoAuthenticateAuthorize + +Table 5.1.6.2.5-1: Definition of type AdditionInfoAuthenticateAuthorize + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasResRelInd | boolean | C | 0..1 | This attribute is used to indicate if an UAS service related network resource can be released or not, during re-authentication failure.
It shall be included if the "cause" attribute within the ProblemDetails data type is set to "FAILED_AUTH".
When present, it shall be set as follows:
- true: UAS resource release is requested;
- false (default): UAS resource release is not requested. | | + +##### 5.1.6.2.6 Type: AuthContainer + +Table 5.1.6.2.6-1: Definition of type AuthContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------| +| authMsgType | AuthMsgType | C | 0..1 | Type of AA message.
Shall be present if more than one AuthContainer's are carried in the UAVAuthResponse. | | +| authMsgPayload | RefToBinaryData | O | 0..1 | AA message payload data. | | +| authResult | AuthResult | C | 0..1 | Shall be present for the final AA response conveying the AA result. | | + +#### 5.1.6.3 Simple data types and enumerations + +##### 5.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 5.1.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +Table 5.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 5.1.6.3.3 Enumeration: AuthResult + +The enumeration AuthResult represents the result of authentication and/or authorization. It shall comply with the provisions defined in table 5.1.6.3.3-1. + +Table 5.1.6.3.3-1: Enumeration AuthResult + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------|---------------| +| AUTH_SUCCESS | The UUAA or C2 authorization has succeeded. | | +| AUTH_FAIL | The UUAA or C2 authorization has failed. | | + +##### 5.1.6.3.4 Enumeration: NotifyType + +The enumeration NotifyType represents the type of notification. It shall comply with the provisions defined in table 5.1.6.3.4-1. + +Table 5.1.6.3.4-1: Enumeration NotifyType + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------|---------------| +| REAUTHENTICATE | The UAV needs to be reauthenticated. | | +| REAUTHORIZE | Authorization data needs to be updated to UAV. | | +| REVOKE | Revoke UAV authentication and authorization | | + +##### 5.1.6.3.5 Void + +##### 5.1.6.3.6 Enumeration: AuthMsgType + +The enumeration AuthMsgType represents the type of AA message. It shall comply with the provisions defined in table 5.1.6.3.6-1. + +**Table 5.1.6.3.6-1: Enumeration AuthMsgType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| UUAA | UUAA payload. | | +| C2AUTH | C2 authorization payload. | | + +#### 5.1.6.4 Data types describing alternative data types or combinations of data types + +##### 5.1.6.4.1 Type: ProblemDetailsAuthenticateAuthorize + +**Table 5.1.6.4.1-1: Definition of type ProblemDetailsAuthenticateAuthorize as a list of to be combined data types** + +| Data type | Cardinality | Description | Applicability | +|-------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 1 | Details of the problem as defined in TS 29.122 [16]. | | +| AdditionalInfoAuthenticateAuthorize | 1 | Contains additional information to indicate the handling of the UAS service related network resource, during re-authentication failure. | | + +### 5.1.7 Error Handling + +#### 5.1.7.1 General + +Response bodies for error handling, as described in 3GPP TS 29.122 [16], are applicable to the APIs in the present specification unless specified otherwise, with the following clarifications: + +- the SCEF is the AF; and +- the SCS/AS is the NEF invoking an API. + +In addition, the requirements in the following clauses are applicable for the Naf\_Authentication API. + +#### 5.1.7.2 Protocol Errors + +No specific procedures for the Naf\_Authentication service are specified. + +#### 5.1.7.3 Application Errors + +The application errors defined for the Naf\_Authentication service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-----------------------------------------------------------------------------------| +| FAILED_AUTH | 403 Forbidden | The HTTP request is rejected because the UAV authentication is failed by the USS. | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Naf\_Authentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of TS 29.122 [16]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 5.1.9 Security + +TLS shall be used to support the security communication between the NEF and the AF over N33 interface. The access to the Naf\_Authentication API shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a client, prior to consuming services offered by the Naf\_Authentication API, shall obtain a "token" from the authorization server. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see TS 29.501 [5] clause 5.3.1 and TR 21.900 [7] clause 5B). + +## A.2 Naf\_Authentication API + +``` +openapi: 3.0.0 + +info: + title: Naf_Authentication + version: 1.1.0-alpha.1 + description: | + AF Authentication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.255 V18.0.0; 5G System;Uncrewed Aerial System Service Supplier (USS) Services; Stage + 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.255/ + +servers: + - url: '{apiRoot}/naf-auth/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /request-auth: + post: + operationId: UAVAuthRequest + summary: UAV authentication + tags: + - UAV authentication + requestBody: + description: UAV authentication + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UAVAuthInfo' + responses: + '200': + description: UAV Auth response or message exchange + content: +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/UAVAuthResponse' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + description: > + The request is rejected by the USS and more details (not only the ProblemDetails) are + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAuthenticateAuthorize' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + reauthRevokeNotification: + '{request.body#/notifyUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReauthRevokeNotify' +responses: + '204': + description: Successful Notification response + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: +``` + +``` +oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + +# +# STRUCTURED DATA TYPES +# + +UAVAuthInfo: + description: UAV auth data + type: object + required: + - gpsi + - serviceLevelId + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorrId: + type: string + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + authMsg: + type: string + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + uavLocInfo: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +UAVAuthResponse: + description: UAV auth response data + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + authMsg: + type: string + deprecated: true + authResult: + allOf: + - $ref: '#/components/schemas/AuthResult' + deprecated: true + serviceLevelId: + type: string + authSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + authProfIndex: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ReauthRevokeNotify: + description: UAV related notification + type: object +``` + +``` +required: + - gpsi + - serviceLevelId + - notifyType +properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + notifyCorrId: + type: string + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + authMsg: + type: string + deprecated: true + notifyType: + $ref: '#/components/schemas/NotifyType' + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + +AuthContainer: + description: Authentication/Authorization data + type: object + properties: + authMsgType: + $ref: '#/components/schemas/AuthMsgType' + authMsgPayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + authResult: + $ref: '#/components/schemas/AuthResult' + +ProblemDetailsAuthenticateAuthorize: + description: Extends ProblemDetails to indicate more details during Authentication failure + allOf: + - $ref: 'TS29122_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoAuthenticateAuthorize' + +AdditionInfoAuthenticateAuthorize: + description: Indicates additional information during authentication failure + type: object + properties: + uasResRelInd: + type: boolean + description: > + Indicates to release the UAV resources during authentication failure, when set to + "true". Default is set to "false". +``` + +# + +# SIMPLE DATA TYPES + +# + +# + +# ENUMERATIONS + +# + +``` +AuthResult: + anyOf: + - type: string + enum: + - AUTH_SUCCESS + - AUTH_FAIL + - type: string + description: > + 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. + description: | + Represents the result of authentication and/or authorization. + Possible values are: + - AUTH_SUCCESS: The UUAA or C2 authorization has succeeded. + - AUTH_FAIL: The UUAA or C2 authorization has failed. +``` + +``` +NotifyType: + anyOf: + - type: string + enum: +``` + +- REAUTHENTICATE +- REAUTHORIZE +- REVOKE +- type: string +description: > +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. + +description: | +Represents the type of notification. +Possible values are: + +- REAUTHENTICATE: The UAV needs to be reauthenticated. +- REAUTHORIZE: Authorization data needs to be updated to UAV. +- REVOKE: Revoke UAV authentication and authorization. + +AuthMsgType: +anyOf: + +- type: string +enum: +- UUAA +- C2AUTH +- type: string +description: > +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. + +description: | +Represents the type of AA message. +Possible values are: + +- UUAA: Indicates that the type of the AA message is UUAA payload. +- C2AUTH: Indicates that the type of the AA message is C2 authorization payload. + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2021-08 | CT3#117-e | C3-214483 | - | - | - | TS skeleton | | 0.0.0 | +| 2021-08 | CT3#117-e | C3-214588 | | | | Added scope, introduction, references, and abbreviations. | | 0.1.0 | +| 2021-10 | CT3#118-e | C3-215474 | | | | Added service description, operations for Naf_Authentication Service and Naf_Authentication_ReauthNotify, also added resources and data model. | | 0.2.0 | +| 2021-11 | CT3#119-e | C3-215474 | | | | Added specification related to reauthentication and revocation. Removed resource and added custom operation. | | 0.3.0 | +| 2021-12 | CT#94-e | CP-213207 | | | | Presented for information | | 1.0.0 | +| 2022-01 | CT3#119 bis-e | C3-220450 | | | | Inclusion of C3-220494, C3-220265, C3-220362, C3-220340, C3-220268, C3-220279, and C3-220280 | | 1.1.0 | +| 2022-02 | CT3#120 | C3-221513 | | | | Inclusion of C3-221241, C3-221242, C3-221686, and C3-221302 | | 1.2.0 | +| 2022-03 | CT#95e | CP-220156 | | | | Presentation to TSG CT for approval | | 2.0.0 | +| 2022-03 | CT#95e | CP-220156 | | | | Approved by TSG CT | | 17.0.0 | +| 2022-06 | CT#96 | CP-221143 | 0001 | | | EN resolution | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0002 | | | Updates to Naf_Authentication_Notification | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0003 | 1 | | Updates to Naf_Authentication_AuthenticateAuthorize service | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0004 | 2 | | Correction to remove revocation cause | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0005 | 1 | | Corrections to open API | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0007 | | | Update the data structures and OpenAPI for Naf_Authentication service | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0008 | | | Correction on data types for UAV Authentication and Authorization | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0009 | | | Correction on Security | | 17.1.0 | +| 2022-06 | CT#96 | CP-221143 | 0010 | | | Correction on status codes | | 17.1.0 | +| 2022-06 | CT#96 | CP-221151 | 0011 | | | Update of info and externalDocs fields | | 17.1.0 | +| 2022-09 | CT#97e | CP-222112 | 0013 | 2 | | Application errors reference update in the tables defining methods on the resources for Naf_Authentication API | | 17.2.0 | +| 2022-09 | CT#97e | CP-222112 | 0014 | 1 | | Incomplete implementation of CR #0007 | | 17.2.0 | +| 2022-09 | CT#97e | CP-222112 | 0016 | 1 | | Add CAA-Level UAV ID to the authorization response | | 17.2.0 | +| 2022-09 | CT#97e | CP-222112 | 0017 | 1 | | Missing description field for enumeration data types | | 17.2.0 | +| 2022-09 | CT#97e | CP-222112 | 0018 | 1 | | Operation identifier for Naf_Authentication API | | 17.2.0 | +| 2022-09 | CT#97e | CP-222112 | 0019 | 1 | | Update the presence condition of the attributes | | 17.2.0 | +| 2022-09 | CT#97e | CP-222121 | 0020 | | | Update of info and externalDocs fields | | 17.2.0 | +| 2022-12 | CT#98e | CP-223180 | 0012 | 4 | | Corrections for Auth message type | | 17.3.0 | +| 2022-12 | CT#98e | CP-223180 | 0021 | 1 | | Adding missing attributes DN Authorization Profile Index and DN authorized Session AMBR | | 17.3.0 | +| 2022-12 | CT#98e | CP-223188 | 0023 | | | Update of info and externalDocs fields | | 17.3.0 | +| 2023-03 | CT#99 | CP-230156 | 0024 | 1 | F | Correction of the description fields in enumerations | | 18.0.0 | +| 2023-03 | CT#99 | CP-230161 | 0026 | | F | Update of info and externalDocs fields | | 18.0.0 | +| 2023-06 | CT#100 | CP-231156 | 0028 | 1 | B | Support for A2X communications | | 18.1.0 | +| 2023-12 | CT#102 | CP-233279 | 0029 | 1 | B | Include support for authorization of direct C2 communication over PC5 | | 18.2.0 | \ No newline at end of file diff --git a/gsma/29_series/29380/raw.md b/gsma/29_series/29380/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..7151974825f4630e423cce36260b30e8e70f99a1 --- /dev/null +++ b/gsma/29_series/29380/raw.md @@ -0,0 +1,3407 @@ + + +# **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mission Critical Push To Talk (MCPTT) media plane control interworking with Land Mobile Radio (LMR) systems; Stage 3 (Release 18)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, featuring a stylized '5G' in black with a green signal wave icon above the '5'. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized black font with a red signal wave icon below the 'G'. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------|----| +| Foreword ..... | 8 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions of terms, symbols and abbreviations..... | 11 | +| 3.1 Terms..... | 11 | +| 3.2 Abbreviations ..... | 12 | +| 4 General..... | 13 | +| 4.1 Overview ..... | 13 | +| 4.1.1 Floor Control ..... | 13 | +| 4.1.1.1 General..... | 13 | +| 4.1.1.2 On-network floor control..... | 13 | +| 4.1.1.3 Off-network floor control ..... | 13 | +| 4.1.1.4 Determine effective priority..... | 13 | +| 4.1.1.5 Determine off-network effective priority ..... | 13 | +| 4.1.2 Pre-established session call control ..... | 14 | +| 4.1.3 MBMS subchannel control..... | 14 | +| 4.2 Internal structure of media plane control entities..... | 14 | +| 4.2.0 General ..... | 14 | +| 4.2.1 Controlling MCPTT function..... | 14 | +| 4.2.2 MCPTT client..... | 16 | +| 4.2.3 Participating MCPTT function..... | 16 | +| 4.2.3.1 General..... | 16 | +| 4.2.3.2 Internal structure of the IWF performing the participating role ..... | 16 | +| 4.2.4 Non-controlling MCPTT function of an MCPTT group..... | 17 | +| 4.3 The media plane control channel ..... | 17 | +| 4.3.1 General ..... | 17 | +| 4.3.2 Control channel realization..... | 17 | +| 4.3.3 Establishing a media plane control channel ..... | 17 | +| 4.3.3.1 General..... | 17 | +| 5 Roles..... | 18 | +| 5.1 General ..... | 18 | +| 5.2 Client..... | 18 | +| 5.3 IWF performing the controlling role..... | 18 | +| 5.4 IWF performing the participating role ..... | 18 | +| 5.5 IWF performing the non-controlling role..... | 19 | +| 6 Floor control..... | 19 | +| 6.1 General ..... | 19 | +| 6.2 Floor participant procedures..... | 19 | +| 6.3 Floor control server procedures..... | 19 | +| 6.3.1 General ..... | 19 | +| 6.3.2 IWF performing the controlling role procedures at MCPTT call initialization ..... | 20 | +| 6.3.2.1 General..... | 20 | +| 6.3.2.2 Initial procedures ..... | 20 | +| 6.3.2.3 Switching from a non-controlling to a controlling role ..... | 20 | +| 6.3.3 Floor control procedures at MCPTT call release..... | 21 | +| 6.3.4 Floor control server state transition diagram for general floor control operation ..... | 21 | +| 6.3.4.1 General..... | 21 | +| 6.3.4.2 State: 'Start-stop' ..... | 23 | +| 6.3.4.2.1 General ..... | 23 | +| 6.3.4.2.2 MCPTT call initialization..... | 23 | +| 6.3.4.3 State: 'G: Floor Idle' ..... | 23 | +| 6.3.4.3.1 General ..... | 23 | +| 6.3.4.3.2 Enter the 'G: Floor Idle' state..... | 23 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------|----| +| 6.3.4.3.3 | Receive Floor Request message (R: Floor Request)..... | 25 | +| 6.3.4.3.3a | IWF floor participant grant (I: IWF Floor Participant Grant)..... | 25 | +| 6.3.4.3.4 | Timer T7 (Floor Idle) expired ..... | 25 | +| 6.3.4.3.5 | Timer T4 (Inactivity) expired..... | 26 | +| 6.3.4.3.6 | Receive an implicit floor request (R: Implicit floor request) ..... | 26 | +| 6.3.4.4 | State: 'G: Floor Taken' ..... | 26 | +| 6.3.4.4.1 | General ..... | 26 | +| 6.3.4.4.2 | Enter the 'G: Floor Taken' state..... | 27 | +| 6.3.4.4.3 | Timer T1 (End of RTP media) expired ..... | 27 | +| 6.3.4.4.4 | Timer T2 (Stop talking) expired..... | 27 | +| 6.3.4.4.5 | Receive RTP media packets (R: RTP media) ..... | 28 | +| 6.3.4.4.6 | Receive Floor Release message (R: Floor Release)..... | 28 | +| 6.3.4.4.6a | IWF floor participant release (I: IWF floor participant release) ..... | 28 | +| 6.3.4.4.7 | Receive Floor Request message with pre-emptive priority (R: pre-emptive Floor Request) ..... | 28 | +| 6.3.4.4.7a | Receive Floor Request message multi-talker (R: multi-talker Floor Request)..... | 29 | +| 6.3.4.4.8 | Receive Floor request message from MCPTT floor participant (R: Floor Request) ..... | 29 | +| 6.3.4.4.9 | Timer T20 (Floor Granted) expired ..... | 29 | +| 6.3.4.4.10 | Timer T20 (Floor Granted) expired N times..... | 29 | +| 6.3.4.4.11 | MCPTT media endpoint release (R: client release) ..... | 30 | +| 6.3.4.4.12 | Receive an implicit floor request (R: Implicit floor request) ..... | 30 | +| 6.3.4.5 | State: 'G: pending Floor Revoke' ..... | 30 | +| 6.3.4.5.1 | General ..... | 30 | +| 6.3.4.5.2 | Enter the 'G: pending Floor Revoke' state..... | 30 | +| 6.3.4.5.3 | Receive RTP media packets (R: RTP media) ..... | 31 | +| 6.3.4.5.4 | Receive Floor Release message (R: Floor Release)..... | 31 | +| 6.3.4.5.5 | Timer T3 (Stop talking grace) expired..... | 31 | +| 6.3.4.5.6 | Timer T1 (End of RTP media) expired ..... | 31 | +| 6.3.4.6 | In any state ..... | 32 | +| 6.3.4.6.1 | General ..... | 32 | +| 6.3.4.6.2 | Receive MCPTT call release - 1 ..... | 32 | +| 6.3.4.6.3 | Receive an instruction to merge group calls (R: Merge) ..... | 32 | +| 6.3.4.7 | State: 'Releasing' ..... | 32 | +| 6.3.4.7.1 | General ..... | 32 | +| 6.3.4.7.2 | Receive MCPTT call release - 2 ..... | 32 | +| 6.3.4.8 | State: 'G: Floor Initialising' ..... | 32 | +| 6.3.4.8.1 | General ..... | 32 | +| 6.3.4.8.2 | Enter the 'G: Initialising' state ..... | 32 | +| 6.3.4.8.3 | Receiving a floor request from a constituent MCPTT group (R: mcptt-floor-request) ..... | 33 | +| 6.3.4.8.4 | All final SIP responses received (R: final SIP responses) ..... | 33 | +| 6.3.5 | Floor control server state transition diagram for basic floor control operation towards the floor participant..... | 34 | +| 6.3.5.1 | General ..... | 34 | +| 6.3.5.2 | State: 'Start-stop' ..... | 36 | +| 6.3.5.2.1 | General ..... | 36 | +| 6.3.5.2.2 | SIP Session initiated..... | 36 | +| 6.3.5.3 | State: 'U: not permitted and Floor Idle' ..... | 39 | +| 6.3.5.3.1 | General ..... | 39 | +| 6.3.5.3.2 | Enter state 'U: not permitted and Floor Idle' ..... | 39 | +| 6.3.5.3.3 | Send Floor Taken message (S: Floor Taken)..... | 40 | +| 6.3.5.3.4 | Receive Floor Request message (R: Floor Request)..... | 40 | +| 6.3.5.3.5 | Send Floor Grant message (S: Floor Grant)..... | 40 | +| 6.3.5.3.6 | Send Floor Deny message (S: Floor Deny)..... | 41 | +| 6.3.5.3.7 | Receive Floor Release message (R: Floor Release)..... | 41 | +| 6.3.5.3.8 | Receive RTP media packets (R: media)..... | 41 | +| 6.3.5.3.9 | Receive an implicit floor request (R: Implicit floor request) ..... | 42 | +| 6.3.5.3.10 | Send Floor Idle message (S: Floor Idle)..... | 42 | +| 6.3.5.4 | State 'U: not permitted and Floor Taken' ..... | 42 | +| 6.3.5.4.1 | General ..... | 42 | +| 6.3.5.4.2 | Enter state 'U: not permitted and Floor Taken'..... | 42 | +| 6.3.5.4.3 | Send Floor Idle message (S: Floor Idle)..... | 43 | +| 6.3.5.4.4 | Receive Floor Request message (R: Floor Request)..... | 43 | +| 6.3.5.4.5 | Receive Floor Release message (R: Floor Release)..... | 46 | + +| | | | +|------------|---------------------------------------------------------------------------------------------------------------------------------|----| +| 6.3.5.4.6 | Receive RTP media packets (R: media)..... | 47 | +| 6.3.5.4.7 | Send Floor Queue Position Info message (R: Floor Queue Position Request)..... | 48 | +| 6.3.5.4.8 | Receive an implicit floor request (R: Implicit floor request) ..... | 48 | +| 6.3.5.4.9 | Send Floor Granted message (S: Floor Granted) ..... | 48 | +| 6.3.5.4.10 | Send Floor Taken message (S: Floor Taken)..... | 49 | +| 6.3.5.4.11 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker) ..... | 49 | +| 6.3.5.5 | State: 'U: permitted' ..... | 49 | +| 6.3.5.5.1 | General ..... | 49 | +| 6.3.5.5.2 | Enter state 'U: permitted' ..... | 49 | +| 6.3.5.5.3 | Receive Floor Release message (R: Floor Release)..... | 49 | +| 6.3.5.5.4 | Send Floor Idle message (S: Floor Idle)..... | 50 | +| 6.3.5.5.5 | Send Floor Revoke message (S: Floor Revoke)..... | 50 | +| 6.3.5.5.6 | Receive RTP media packets (R: media)..... | 50 | +| 6.3.5.5.7 | Receive Floor Request message (R: Floor Request)..... | 50 | +| 6.3.5.5.8 | Send RTP Media (S: media)..... | 51 | +| 6.3.5.5.9 | Send Floor Taken message (S: Floor Taken)..... | 51 | +| 6.3.5.5.10 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker) ..... | 51 | +| 6.3.5.6 | State: 'U: pending Floor Revoke' ..... | 51 | +| 6.3.5.6.1 | General ..... | 51 | +| 6.3.5.6.2 | Enter state 'U pending Floor Revoke' ..... | 51 | +| 6.3.5.6.3 | Timer T8 (media Revoke) expired..... | 52 | +| 6.3.5.6.4 | Receive RTP media packets (R: media)..... | 52 | +| 6.3.5.6.5 | Receive Floor Release message (R: Floor Release)..... | 52 | +| 6.3.5.6.6 | Send Floor Idle message (S: Floor Idle)..... | 53 | +| 6.3.5.6.7 | Send Floor Taken message (S: Floor Taken)..... | 53 | +| 6.3.5.6.8 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker) ..... | 53 | +| 6.3.5.7 | State 'U: not permitted but sends media' ..... | 53 | +| 6.3.5.7.1 | General ..... | 53 | +| 6.3.5.7.2 | Enter state 'U: not permitted but sends media' ..... | 53 | +| 6.3.5.7.3 | Timer T8 (Floor Revoke) expired..... | 54 | +| 6.3.5.7.4 | Receive Floor Release message (R: Floor Release)..... | 54 | +| 6.3.5.7.5 | Send Floor Taken message (S: Floor Taken)..... | 55 | +| 6.3.5.7.6 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker) ..... | 55 | +| 6.3.5.8 | In any state ..... | 55 | +| 6.3.5.8.1 | General ..... | 55 | +| 6.3.5.8.2 | Receive MCPTT call release – 1..... | 55 | +| 6.3.5.8.3 | Receiving a merging instruction (R: Merge)..... | 55 | +| 6.3.5.9 | State: 'Releasing' ..... | 56 | +| 6.3.5.9.1 | General ..... | 56 | +| 6.3.5.9.2 | Receive MCPTT call release - 2 ..... | 56 | +| 6.3.5.10 | State: 'U: not permitted and initiating' ..... | 56 | +| 6.3.5.10.1 | General ..... | 56 | +| 6.3.5.10.2 | Enter the 'U: not permitted and initiating' state ..... | 56 | +| 6.3.5.10.3 | Send Floor Taken message (S: Floor Taken)..... | 56 | +| 6.3.5.10.4 | Send Floor Idle message (S: Floor Idle)..... | 56 | +| 6.3.5.10.5 | Receive Floor Request message (R: Floor Request)..... | 57 | +| 6.3.5.10.6 | Send Floor Granted message (S: Floor Granted) ..... | 57 | +| 6.3.5.10.7 | Receive a Floor Release message (S: Floor Release) ..... | 57 | +| 6.3.5.10.8 | Send Floor Release Multi Talker message (S: Floor Release Multi Talker) ..... | 58 | +| 6.3.6 | Dual floor control ..... | 58 | +| 6.3.6.1 | General ..... | 58 | +| 6.3.6.2 | State: 'Start-stop' ..... | 59 | +| 6.3.6.2.1 | General ..... | 59 | +| 6.3.6.2.2 | Receive Floor Request message with overriding pre-emptive floor priority (R: Floor Request) ... | 60 | +| 6.3.6.2.2A | Floor Grant to IWF floor participant with overriding pre-emptive floor priority (I: Floor Grant to IWF floor participant) ..... | 60 | +| 6.3.6.3 | State: 'D: Floor Taken' ..... | 60 | +| 6.3.6.3.1 | General ..... | 60 | +| 6.3.6.3.2 | Enter state 'D: Floor Taken'..... | 60 | +| 6.3.6.3.3 | Timer T11 (End of RTP dual) expired..... | 61 | +| 6.3.6.3.4 | Timer T12 (Stop talking dual) expired..... | 62 | +| 6.3.6.3.5 | Receive RTP media packets (R: media)..... | 63 | + +| | | | +|------------|-----------------------------------------------------------------------------------------------|----| +| 6.3.6.3.6 | Receive Floor Release message (R: Floor Release)..... | 63 | +| 6.3.6.3.6A | IWF Floor Release (I: Floor release by IWF floor participant) ..... | 64 | +| 6.3.6.3.7 | Receive Floor request message from permitted MCPTT floor participant (R: Floor Request) ..... | 64 | +| 6.3.6.3.8 | Permitted MCPTT participant release..... | 64 | +| 6.3.6.3.8A | Permitted IWF participant release (I: Call release by IWF floor participant)..... | 65 | +| 6.3.6.3.9 | Receive Terminate (Terminate) ..... | 65 | +| 6.3.6.4 | In any state ..... | 65 | +| 6.3.6.4.1 | General ..... | 65 | +| 6.3.6.4.2 | Receive MCPTT call release - 1 ..... | 65 | +| 6.3.6.5 | State: 'Releasing' ..... | 66 | +| 6.3.6.5.1 | General ..... | 66 | +| 6.3.6.5.2 | Receive MCPTT call release - 2 ..... | 66 | +| 6.4 | IWF performing the participating role floor control procedures..... | 66 | +| 6.4.1 | General ..... | 66 | +| 6.4.2 | IWF floor participant procedures at MCPTT session initialization ..... | 66 | +| 6.4.2.1 | General..... | 66 | +| 6.4.2.2 | MCPTT call initiated, IWF originating ..... | 66 | +| 6.4.2.3 | MCPTT call established, IWF terminating..... | 67 | +| 6.4.3 | IWF floor participant procedures at MCPTT call release ..... | 67 | +| 6.4.4 | IWF floor participant floor message handing..... | 67 | +| 6.4.4.1 | Receive Floor Idle message ..... | 67 | +| 6.4.4.2 | Receive Floor Taken message ..... | 67 | +| 6.4.4.3 | Receive RTP media packets ..... | 67 | +| 6.4.4.4 | Send Floor Request message ..... | 68 | +| 6.4.4.6 | Receive Floor Deny message..... | 68 | +| 6.4.4.7 | Send Floor Release message..... | 68 | +| 6.4.4.8 | Receive Floor Queue Position Info message ..... | 69 | +| 6.4.4.9 | Receive Floor Revoke message ..... | 69 | +| 6.4.4.10 | Receive MCPTT call release ..... | 69 | +| 6.5 | IWF performing the non-controlling role of an MCPTT group..... | 69 | +| 6.5.4 | Floor control server interface procedures..... | 69 | +| 6.5.4.1 | General..... | 69 | +| 6.5.4.2 | Receiving a Floor Request message ..... | 69 | +| 6.5.4.2A | IWF sends a Floor Request message ..... | 70 | +| 6.5.4.3 | Receive Floor Release message ..... | 70 | +| 6.5.4.3A | IWF sends a Floor Release message..... | 71 | +| 6.5.4.4 | Receive Floor Queue Position Request message ..... | 71 | +| 6.5.4.4A | IWF sends Floor Queue Position Request message..... | 71 | +| 6.5.4.5 | Receive Floor Ack message..... | 72 | +| 6.5.4.5A | IWF sends Floor Ack message ..... | 72 | +| 6.5.4.6 | Receive Floor Granted message ..... | 72 | +| 6.5.4.6A | IWF grants floor..... | 73 | +| 6.5.4.17 | Receive Floor Release Multi Talker message..... | 73 | +| 6.5.5 | Floor participant interface procedures..... | 73 | +| 6.5.5.1 | General ..... | 73 | +| 6.5.5.2 | State: 'Start-Stop' ..... | 75 | +| 6.5.5.2.1 | General ..... | 75 | +| 6.5.5.2.2 | Participant invited to session..... | 75 | +| 6.5.5.3 | State: 'P: has no permission'..... | 75 | +| 6.5.5.3.1 | General ..... | 75 | +| 6.5.5.3.2 | Receive Floor Idle message (R: Floor Idle) ..... | 75 | +| 6.5.5.3.3 | Receive Floor Taken message (R: Floor Taken)..... | 75 | +| 6.5.5.3.4 | Receive Floor Request message (R: Floor Request)..... | 75 | +| 6.5.5.3.5 | Receive Floor Granted message (R: Floor Granted) ..... | 75 | +| 6.5.5.3.6 | Receive Floor Deny message (R: Floor Deny) ..... | 76 | +| 6.5.5.3.7 | Receive Floor Queue Position Info message (R: Floor Queue Position Info) ..... | 76 | +| 6.5.5.3.8 | Receive Floor Queue Position Request message (R: Floor Queue Position Request)..... | 76 | +| 6.5.5.3.9 | Receive RTP media packets (R: RTP media) ..... | 76 | +| 6.5.5.3.10 | Receive Floor Release message (R: Floor Release)..... | 77 | +| 6.5.5.3.11 | Receive split instruction (R: Split) ..... | 77 | +| 6.5.5.3.12 | Receive Floor Release Multi Talker message (R: Floor Release Multi-talker) ..... | 77 | +| 6.5.5.4 | State: 'P: has permission'..... | 78 | + +| | | | +|---------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.5.5.4.1 | General ..... | 78 | +| 6.5.5.4.2 | Receive RTP media packets..... | 78 | +| 6.5.5.4.3 | Receive Floor Release message (R: Floor Release)..... | 78 | +| 6.5.5.4.4 | Receive Floor Ack message (R: Floor Ack) ..... | 78 | +| 6.5.5.4.5 | Receive Floor Idle message (R: Floor Idle) ..... | 78 | +| 6.5.5.4.6 | Receive Floor Taken message (R: Floor Taken)..... | 78 | +| 6.5.5.4.7 | Receive Floor Revoke message (R: Floor Revoke)..... | 78 | +| 6.5.5.4.8 | Receive split instruction (R: Split)..... | 79 | +| 6.5.5.4.9 | Receive Floor Release Multi Talker message (R: Floor Release Multi-talker) ..... | 79 | +| 6.5.5.5 | In any state ..... | 79 | +| 6.5.5.5.1 | General ..... | 79 | +| 6.5.5.5.2 | Receive Floor Ack message (R: Floor Ack) ..... | 79 | +| 6.5.5.5.3 | MCPTT session release step 1 (MCPTT call release - 1)..... | 80 | +| 6.5.5.6 | State: 'P: Releasing'..... | 80 | +| 6.5.5.6.1 | General ..... | 80 | +| 6.5.5.6.2 | MCPTT session release step 2 (MCPTT call release - 2)..... | 80 | +| 7 | Off-network floor control..... | 80 | +| 8 | Coding ..... | 80 | +| 8.1 | Introduction ..... | 80 | +| 8.2 | Floor control..... | 80 | +| 8.3 | Pre-established session call control..... | 81 | +| 8.4 | MBMS subchannel control..... | 81 | +| 8.5 | MBMS notifications..... | 81 | +| 9 | Call setup control over pre-established session ..... | 81 | +| 10 | MBMS procedures ..... | 81 | +| 11 | Configurable parameters ..... | 81 | +| 11.1 | Timers..... | 81 | +| 11.2 | Counters ..... | 81 | +| 12 | Extensions within the present document..... | 81 | +| 13 | Media plane security ..... | 81 | +| 13.1 | General ..... | 81 | +| 13.2 | Derivation of SRTP/SRTCP master keys..... | 83 | +| 13.3 | Media plane encryption and decryption ..... | 83 | +| 13.3.1 | General ..... | 83 | +| 13.3.2 | The IWF performing the participating role ..... | 83 | +| 13.3.3 | The IWF media endpoint..... | 84 | +| 13.3.4 | The IWF performing the controlling role ..... | 85 | +| 13.3.5 | The IWF performing the non-controlling role..... | 86 | +| 14 | SDP offer/ answer procedures..... | 87 | +| 14.1 | General ..... | 87 | +| 14.2 | Generating an SDP offer ..... | 87 | +| 14.3 | Generating the SDP answer..... | 87 | +| 14.4 | Offeror processing of the SDP answer..... | 87 | +| 14.5 | Modifying the media plane control channel..... | 88 | +| 14.6 | The use of SDP offer / answer procedures in off-network mode..... | 88 | +| Annex A (informative): Change history..... | | 89 | + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, certain modal verbs have the following meanings: + +**shall** indicates a mandatory requirement to do something + +**shall not** indicates an interdiction (prohibition) to do something + +NOTE 1: The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +NOTE 2: The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +**should** indicates a recommendation to do something + +**should not** indicates a recommendation not to do something + +**may** indicates permission to do something + +**need not** indicates permission not to do something + +NOTE 3: The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +**can** indicates that something is possible + +**cannot** indicates that something is impossible + +NOTE 4: The constructions "can" and "cannot" shall not to be used as substitutes for "may" and "need not". + +**will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document + +**might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +NOTE 5: The constructions "is" and "is not" do not indicate requirements. + +--- + +# 1 Scope + +The present document specifies the media plane control protocols and interactions with the media needed to support a Mission Critical Push To Talk (MCPTT) system interworking with a Land Mobile Radio (LMR) system. This interworking includes both the signalling and the media planes between the MCPTT system and the LMR system. The function between the MCPTT system and the LMR system is referred to as an Interworking Function (IWF). + +The IWF supports the basic group and other features as specified in 3GPP TS 23.283 [24]. + +--- + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control Protocol specification". +- [3] IETF RFC 3550: "RTP: A Transport Protocol for Real-Time Applications". +- [4] 3GPP TS 24.483: "Mission Critical Services (MCS) Management Object (MO)". +- [5] 3GPP TS 23.379: "Functional architecture and information flows to support mission critical communication services; Stage 2". +- [6] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE); MB2 Reference Point; Stage 3". +- [7] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [8] Void. +- [9] 3GPP TS 25.446: "MBMS synchronization protocol (SYNC)". +- [10] 3GPP TS 29.281: "General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)". +- [11] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [12] 3GPP TS 24.481: "Mission Critical Services (MCS) group management Protocol specification". +- [13] 3GPP TS 24.484: "Mission Critical Services (MCS) configuration management protocol specification". +- [14] Void. +- [15] IETF RFC 3830: "MIKEY: Multimedia Internet KEYing". +- [16] IETF RFC 3711: "The Secure Real-time Protocol (SRTP)". +- [17] IETF RFC 6509: "MIKEY-SAKKE: Sakai-Kashar Key Encryption in Multimedia Internet KEYing (MIKEY)". +- [18] 3GPP TS 33.180: "Security of the mission critical service". + +- [19] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [20] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework". +- [21] IETF RFC 3095: "RObust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed". +- [22] IETF RFC 5225: "RObust Header Compression Version 2 (ROHCv2): Profiles for RTP, UDP, IP, ESP and UDP-Lite". +- [23] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [24] 3GPP TS 23.283: "Mission Critical Communication Interworking with Land Mobile Radio Systems". +- [25] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) media plane control". +- [26] 3GPP TS 29.379: "Mission Critical Push To Talk (MCPTT) call control interworking with LMR systems". +- [27] 3GPP TS 22.179: "Mission Critical Push To Talk (MCPTT) Stage 1". + +--- + +## 3 Definitions of terms, symbols and abbreviations + +### 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Floor participant:** The floor participant functional entity is responsible for floor requests. In the present document this term can be a floor participant that can be in either an MCPTT system (ref. 3GPP TS 23.379 [5]) or in an IWF. + +**IWF floor control server:** A floor control server that is in the IWF. + +**IWF floor participant:** A floor participant that is in the IWF. + +**IWF media endpoint:** A media endpoint that is in the IWF. + +**Media endpoint:** The end producer or consumer of media and floor control traffic (see also "IWF media endpoint"). + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.379 [5] apply: + +- Floor control** +- Floor participant** +- Floor control server** +- Group call** +- MCPTT call** +- Mission critical push to talk** +- Private call** +- SIP core** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.283 [24] apply: + +#### **Interworking Function (IWF)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 29.379 [26] apply: + +- IWF performing the controlling role** +- IWF performing the non-controlling** +- IWF performing the participating role** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.380 [25] apply: + +**Active floor request queue** +**Conversation** +**Effective priority** +**Media burst** +**Media plane control protocols** +**Passive floor request queue** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 33.180 [18] apply: + +**Group Master Key (GMK)** +**Group Master Key Identifier (GMK-ID)** +**Private Call Key (PCK)** +**Private Call Key Identifier (PCK-ID)** +**Signalling Protection Key (SPK)** +**Signalling Protection Key Identifier (SPK-ID)** + +For the purposes of the present document, the following terms and definitions given in IETF RFC 3711 [16] apply: + +**SRTP master key (SRTP-MK)** +**SRTP master key identifier (SRTP-MKI)** +**SRTP master salt (SRTP-MS)** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|--------------------------------------------| +| GMK | Group Management Key | +| GMK-ID | Group Master Key Identifier | +| GMS | Group Management Server | +| GUK-ID | Group User Key Identifier | +| IP | Internet Protocol | +| MBMS | Multimedia Broadcast and Multicast Service | +| MCPTT | Mission Critical Push To Talk | +| PCK | Private Call Key | +| PCK-ID | Private Call Key Identifier | +| PTT | Push-To-Talk | +| RFC | Request For Comment | +| RTCP | RTP Control Protocol | +| RTP | Real-time Transport Protocol | +| SPK | Signalling Protection Key | +| SPK-ID | Signalling Protection Key Identifier | +| SRTCP | Secure RTCP | +| SRTP | Secure RTP | +| SRTP-MK | SRTP master key | +| SRTP-MKI | SRTP master key identifier | +| SRTP-MS | SRTP master salt | +| SSRC | Synchronization SouRCe | +| UE | User Equipment | + +## 4 General + +### 4.1 Overview + +#### 4.1.1 Floor Control + +##### 4.1.1.1 General + +In an MCPTT group call after the call is setup, at a given time only a single group member is allowed to talk, and all other affiliated group members listen to this talker. The control action for obtaining this mode of operation is known as floor control. The direct actors of floor control are the floor participants and the floor control server. A floor participant does the floor control related actions in MCPTT media endpoints and IWF media endpoints. The floor control server is the decision maker of the floor control. The floor control server is in the IWF when it is performing the controlling role. + +##### 4.1.1.2 On-network floor control + +For a general overview of floor control not specific to the IWF, see 3GPP TS 24.380 [25]. In that description, the IWF fulfills all of the described roles as a peer to the MCPTT server. The following features mentioned in 3GPP TS 24.380 [25] are not fully supported in the present document: cut-in, ambient listening and multi-talker. + +##### 4.1.1.3 Off-network floor control + +Off-network is not applicable to the IWF. + +##### 4.1.1.4 Determine effective priority + +The floor control server can determine how to handle a received Floor Request message using a number of input parameters. Examples of input parameters that the floor control server can use are: + +1. the floor priority, using the value of the Floor Priority field in the Floor Request message; +2. the element as specified in 3GPP TS 24.481 [12]; +3. the participant type, using the element specified in 3GPP TS 24.481 [12] or, in case a non-controlling MCPTT function is attached to a group call, the value in the Track Info field in the Floor Request message; +4. the type of call indicated in the Floor Indicator field; +5. the effective priority of the floor participant with the permission to send media, and the current type of the call (e.g. normal, imminent-peril, emergency, broadcast); and +6. any other information in the group document specified in 3GPP TS 24.481 [12] or information stored in the IWF outside the scope of the present document. + +Using a local policy and the above input parameters the floor control server can determine that a floor request is: + +1. pre-emptive such that the current talker is overridden; +2. pre-emptive such that the current talker is revoked; +3. not pre-emptive and put in the floor request queue, if queueing was negotiated; or +4. not-pre-emptive and rejected, if queueing was not negotiated. + +##### 4.1.1.5 Determine off-network effective priority + +Off-network is not applicable to the IWF. + +#### 4.1.2 Pre-established session call control + +Pre-established session call control is not applicable to the IWF. + +#### 4.1.3 MBMS subchannel control + +MBMS is not applicable to the IWF. + +### 4.2 Internal structure of media plane control entities + +#### 4.2.0 General + +For clarity, the present document describes media plane aspects of the IWF-1 reference point using the structure shown in 3GPP TS 24.380 [25] and further detailed in clause 4.2.1. The IWF need not implement the structure of media plane control entities given in the present document, but the resulting IWF behaviour on the IWF-1 interface must be as specified in the present document. + +The floor control interface towards LMR entities is out of scope of the present document. + +#### 4.2.1 Controlling MCPTT function + +According to 3GPP TS 23.379 [5], the controlling MCPTT function is divided into a floor control server and a media distribution function. In the present document an example of an internal structure of the IWF performing the controlling role is illustrated in figure 4.2-1. + +![Diagram of the internal structure of floor control in the IWF performing the controlling role.](e190b6ddb7c2e64b940749a1c5612256_img.jpg) + +The diagram illustrates the internal structure of the IWF performing the controlling role. It is contained within a large rectangular box labeled "IWF performing the controlling role". At the top, a box labeled "Application and signalling plane" is shown. Below it, the "Floor control server" is depicted as a large box containing three sub-components: "Floor control interface towards the MCPTT client", "Floor control arbitration logic", and "Floor request queue". The "Floor control interface towards the MCPTT client" is connected to an external "IWF-1" interface on the left. Below the floor control server, the "Media distribution function" is shown as a large box containing two sub-components: "Network media interface" and "Media distributor". The "Network media interface" is also connected to an external "IWF-1" interface on the left. Vertical lines connect the "Application and signalling plane" to the "Floor control server", the "Floor control server" to the "Media distribution function", and the "Floor control arbitration logic" to the "Media distributor". + +Diagram of the internal structure of floor control in the IWF performing the controlling role. + +NOTE: The real internal structure of the IWF is implementation specific but a possible internal structure is shown to illustrate the procedures. + +**Figure 4.2.1-1: Internal structure of floor control in the IWF performing the controlling role** + +All entities in the IWF performing the controlling role are assumed to have a direct communication interface to the application and signalling plane. The interface to the application and signaling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The reference point IWF-1 is described in 3GPP TS 23.283 [24]. The floor control interface towards the MCPTT media endpoint receives and transmits the floor control messages from and to the MCPTT media endpoint via the participating MCPTT function or non-controlling MCPTT function. The procedures are controlled by a state machine described in clause 6.3.5. One state machine is needed for each MCPTT media endpoint participating in an MCPTT call. A non-controlling MCPTT function is seen by the floor control interface towards the MCPTT client as an MCPTT media endpoint. + +The floor control arbitration logic performs the floor control. The floor control arbitration logic is controlled by a state machine described in clause 6.3.4. One state machine is needed per MCPTT call. + +The floor request queue is accessible both by the floor control interface towards the MCPTT client for all MCPTT media endpoint in the call and the floor control arbitration logic. + +The network media interface receives and sends media from and to the associated MCPTT media endpoint via the participating MCPTT function or non-controlling MCPTT function. The network media interface is out of scope of the present document. One network media interface is needed for each MCPTT media endpoint participating in an MCPTT call. A non-controlling MCPTT function is seen by the network media interface as an MCPTT media endpoint. + +The media distributor is controlled by the floor control arbitration logic. The media distributor is out of scope of the present document. One media distributor is needed per MCPTT call. + +The internal interfaces are assumed to transport the following types of information. + +1. The interface between the network media interface and the floor control interface towards the MCPTT client: + - a. Indication that the network media interface has started to receive media packets from the associated MCPTT media endpoint or that media packets are no longer received from the associated MCPTT media endpoint. + +NOTE: It is an implementation option whether an indication e.g. is sent for every received RTP media packet or only when the first packet is received and then when no more RTP packets are received. +2. The interface between the floor control interface towards the MCPTT media endpoint and the floor control arbitration logic: + - a. Floor control messages to and from the associated MCPTT media endpoint, requests to create or delete the state machine instance for the associated MCPTT media endpoint. The floor control messages to the floor control arbitration logic are limited to floor control messages that will change the state of the floor. +3. The interface between the network media interface and the media distributor: + - a. Media to and from associated MCPTT media endpoint. This interface is out of scope of the present document. +4. The interface between the floor control arbitration logic and the media distributor: + - a. Requests to start or stop distributing media to floor participants in the MCPTT call. Indication that the media distributor has started to receive media packets from the network media interface associated with the MCPTT media endpoint with the permission to send media or that media packets are no longer received from the network media interface from the associated MCPTT media endpoint. +5. The interface between the floor control interface towards the MCPTT client and the floor request queue: + - a. Requests to store received Floor Request messages in the queue or requests to remove Floor Request messages from the queue and the queue content for building the Floor Queue Position Info message. +6. The interface between the floor control arbitration logic and the floor request queue: + - a. Requests to store received Floor Request messages in the queue or requests to remove Floor Request messages from the queue. Indications that the queue is modified. + +## 4.2.2 MCPTT client + +A user homed in the IWF is represented as an "IWF media endpoint". Actions relative to an IWF media endpoint are described as appropriate in the procedures of this present document for the IWF performing the participating, controlling, and non-controlling roles. + +## 4.2.3 Participating MCPTT function + +### 4.2.3.1 General + +The IWF performing the participating role uses media plane control (non-SIP) messages when taking part in the floor control procedures as specified in clause 6. + +The following clauses describe the assumed internal structure of the IWF performing the participating role and its role in the floor control procedures. + +### 4.2.3.2 Internal structure of the IWF performing the participating role + +In the present document the internal structure of the IWF performing the participating role is illustrated in figure 4.2.3.2-1. + +![Diagram illustrating the internal structure of the IWF performing the participating role. The diagram shows a large box labeled 'IWF performing the participating role' containing two nested boxes: 'Application and signalling plane' and 'IWF media endpoint'. The 'IWF media endpoint' box contains a nested box labeled 'IWF floor participant'. A line labeled 'IWF-1' points to the left side of the 'IWF performing the participating role' box.](96b0240f56d14453b5da05ec30fd5c6e_img.jpg) + +``` +graph TD + subgraph IWF_performing_the_participating_role [IWF performing the participating role] + direction TB + subgraph Application_and_signalling_plane [Application and signalling plane] + end + subgraph IWF_media_endpoint [IWF media endpoint] + direction TB + subgraph IWF_floor_participant [IWF floor participant] + end + end + end + IWF_1[IWF-1] --- IWF_performing_the_participating_role +``` + +Diagram illustrating the internal structure of the IWF performing the participating role. The diagram shows a large box labeled 'IWF performing the participating role' containing two nested boxes: 'Application and signalling plane' and 'IWF media endpoint'. The 'IWF media endpoint' box contains a nested box labeled 'IWF floor participant'. A line labeled 'IWF-1' points to the left side of the 'IWF performing the participating role' box. + +NOTE: The real internal structure of the IWF performing the participating role is implementation specific, but a possible internal structure is shown to illustrate the logic and the procedures. + +**Figure 4.2.3.2-1: Internal structure of the IWF performing the participating role** + +All entities in the IWF performing the participating role have a direct communication interface to the application and signalling plane. The interface to the application and signalling plane carries information about SIP session initialisation and SIP session release, SDP content, etc. + +The reference point IWF-1 is described in 3GPP TS 23.283 [24]. + +The IWF floor participant in the IWF performing the participating role manages media sessions on behalf of users homed in the IWF for cases where the session is homed in the MCPTT system. The specifications for the IWF performing the participating role related to the floor control are in clause 6.4 for media and media plane control delivery. + +#### 4.2.4 Non-controlling MCPTT function of an MCPTT group + +According to 3GPP TS 24.379 [2] subclause 5.3 the MCPTT server can act in a non-controlling MCPTT function of an MCPTT group role. In the present document the internal structure of the non-controlling MCPTT function of the IWF of an MCPTT group is illustrated in figure 4.2.4-1. + +### 4.3 The media plane control channel + +#### 4.3.1 General + +The media plane control channel is used for transport of messages associated with the floor control protocol. + +#### 4.3.2 Control channel realization + +The media plane control channel is realized by sending RTCP APP packets on top of UDP/IP. RTCP APP packets are defined in IETF RFC 3550 [3]. The MCPTT specific coding of the RTCP APP packets is defined in clause 8 of the present document. + +#### 4.3.3 Establishing a media plane control channel + +##### 4.3.3.1 General + +The IWF uses the SDP offer/answer mechanism in order to negotiate the establishment of the media plane control channel. The SDP offer/answer procedures for negotiating media plane control channel capabilities are specified in clause 14. The ABNF is defined in clause 12. + +The media description ("m=" line) associated with the media plane control channel shall have the values as described in table 4.3.3.1-1. + +**Table 4.3.3.1-1: Media plane control channel media description** + +| Media description element | Value | +|---------------------------|---------------| +| | "application" | +| | RTCP port | +| | "udp" | +| | "MCPTT" | + +The port used for RTCP messages associated with the media plane control channel shall be different than ports used for RTCP messages associated with other "m=" lines (e.g. RTP) in the SDP. + +NOTE 1: As RTCP is used to transport messages on the media plane control channel, the "m=" line port value indicates an RTCP port. This is different from cases where an "m=" line is associated with an RTP-based stream, and the "m=" line port value indicates an RTP port. + +NOTE 2: In the case where the media plane control channel uses a different IP address than other media described in the SDP, a media plane control channel specific "c=" line also needs to be associated with the "m=" line associated with the media plane control channel. + +The format of the optional SDP fmtp attribute, when associated with the media plane control channel, is described in clause 12. + +The example below shows an SDP media description for a media plane control channel. + +m=application 20032 udp MCPTT + +a=fmtp:MCPTT mc\_queueing;mc\_priority=5;mc\_granted + +## 5 Roles + +### 5.1 General + +This clause associates the IWF with the MCPTT roles described in the stage 2 architecture document (see 3GPP TS 23.379 [5]). + +### 5.2 Client + +The IWF acts on behalf of all users homed in the IWF. There are no client procedures specified in the present document and specific client handling within the LMR system is out of scope. + +### 5.3 IWF performing the controlling role + +An IWF performing the controlling role shall: + +1. support the role of a controlling MCPTT function as specified in 3GPP TS 23.379 [5]; +2. support negotiating media plane control channel media level attributes as specified in clause 4.3; +3. provide floor control arbitration logic with an interface to MCPTT clients as described in clause 4.2.1 and support the related procedures as specified in clause 6.3; +4. provide a network media interface as described in clause 4.2.1 and support associated procedures as specified in clause 6.3; +5. provide a media distributor with a floor control interface towards the MCPTT clients as described in 3GPP TS 24.380 [25] clause 4.2.1 and support associated procedures in clause 6.3; +6. support the on-network mode floor control protocol elements as specified in clause 8; and +7. support media plane security as specified in clause 13. + +An IWF performing the controlling role may: + +1. provide a floor request queue as described in clause 4.2.1 and support the related procedures as specified in clause 6.3 and clause 4.3. + +### 5.4 IWF performing the participating role + +An IWF performing the participating role shall: + +1. support the role of a participating MCPTT function; +2. distribute floor control messages as described in clause 6.3 and support associated procedures as specified in clause 6.4; +3. perform endpoint floor control signalling as the floor participant on behalf of users homed in the IWF; and + +NOTE: Floor control is modelled as a floor participant that is part of the IWF performing the participating role, and sits "behind" the participating role. This is for modelling purposes only and does not impose any particular structure or implementation on the IWF. + +4. support media plane security as specified in clause 13. + +## 5.5 IWF performing the non-controlling role + +An IWF performing the non-controlling role of an MCPTT group shall: + +1. support floor control involving groups from multiple MCPTT systems as specified in 3GPP TS 29.379 [26]; +2. provide a floor control interface towards the controlling MCPTT function as described in clause 4.2.4 and support the related procedures as specified in clause 6.5; +3. provide a media interface towards the controlling MCPTT function as described in clause 4.2.4 and support the related procedure as specified in clause 6.5; +4. provide a media distributor as described in clause 4.2.4 and the related procedures as specified in clause 6.5; and +5. support media plane security as specified in clause 13. + +--- + +## 6 Floor control + +### 6.1 General + +This clause provides: + +1. the IWF floor participant in clause 6.2; +2. the IWF floor control server procedures in clause 6.3; +3. the IWF performing the participating floor control procedures in clause 6.4; and +4. the IWF performing the non-controlling role of an MCPTT group in clause 6.5. + +If media plane security is required, the IWF shall perform the additional procedures in clause 13. + +NOTE: It is possible that in a group re-group operation, the IWF can be performing both the controlling role for the re-grouped groups and the non-controlling role for one or more constituent groups. The actual implementation and internal communication among aspects of the IWF is out of scope. + +**Editor's Note:** The procedures of the IWF performing the non-controlling role are FFS. + +### 6.2 Floor participant procedures + +Procedures for IWF floor participants are addressed in the following: + +- the IWF performing the controlling role procedures in clause 6.3.4; and +- the IWF performing the participating role procedures in clause 6.4. + +**Editor's Note:** The IWF performing the non-controlling role is FFS. + +### 6.3 Floor control server procedures + +#### 6.3.1 General + +The floor control server arbitration logic in the IWF floor control server shall support the procedures in clauses 6.3.2 and 6.3.3 and shall behave according to the floor control server state transition diagram for 'general floor control operation' in clause 6.3.4. + +The floor control interface towards the MCPTT client in the IWF floor control server shall behave according to the floor control server state transition diagram for 'basic floor control operation towards the floor participant' as specified in clause 6.3.5. + +## 6.3.2 IWF performing the controlling role procedures at MCPTT call initialization + +### 6.3.2.1 General + +Clause 6.3.2.2 describes the initial procedures when a new SIP session is establishing a group session or a private session with floor control. + +Clause 6.3.2.3 describes the procedures when the IWF performing the non-controlling role switches from the non-controlling role to the controlling role. + +### 6.3.2.2 Initial procedures + +When an MCPTT call is established a new instance of the floor control server state machine for 'general floor control operation' is created. + +For each MCPTT media endpoint added to the MCPTT call, a new instance of the floor control server state machine for 'basic floor control operation towards the floor participant' is added. + +If the optional "mc\_queueing" feature is supported and has been negotiated as specified in clause 14, the IWF floor control server could queue the implicit floor control request for the MCPTT media endpoint. + +For cases where a SIP request originates in the MCPTT system, the initial SIP INVITE request or SIP REFER request to establish an MCPTT chat group call or to rejoin an ongoing MCPTT call is not handled as an implicit floor control request message by the IWF floor control server unless explicitly stated in the SIP INVITE request or in the SIP REFER request. + +The permission to send media to the inviting MCPTT media endpoint due to implicit floor control request is applicable to both confirmed indication and unconfirmed indication. + +When the first unconfirmed indication is received from the invited participating MCPTT function (see 3GPP TS 29.379 [26]) the IWF floor control server optionally can give an early indication to send RTP media packets, to the inviting MCPTT media endpoint. + +Before the IWF floor control server sends the first floor control message in the MCPTT call, the IWF floor control server has to assign itself an SSRC identifier to be included in media floor control messages and quality feedback messages if the IWF is supporting that option. A suitable algorithm to generate the SSRC identifier is described in IETF RFC 3550 [3]. + +The MCPTT floor participant and the IWF floor control server can negotiate the maximum priority level that the floor participant is permitted to request. The IWF floor control server can pre-empt the current sender based on the negotiated maximum priority level that the MCPTT floor participant is permitted to request, and the priority level included in the Floor Request message. + +**NOTE:** The maximum priority level that an MCPTT floor participant can use is negotiated as specified in clause 14.3.3 and is based on group configuration data retrieved by the IWF performing the controlling role from the group management server as described in 3GPP TS 24.481 [12] and local policies applied by the IWF performing the controlling role. + +The MCPTT floor participant and the IWF floor control server can negotiate queueing of floor requests using the "mc\_queueing" fmtp attribute as described in clause 14. If queueing is supported and negotiated, the IWF floor control server queues the floor control request if a Floor Request message is received when another floor participant has the floor and the priority of the current speaker is the same or higher. + +### 6.3.2.3 Switching from a non-controlling to a controlling role + +**Editor's Note:** The IWF non-controlling role procedures are FFS. + +### 6.3.3 Floor control procedures at MCPTT call release + +When an MCPTT media endpoint leaves an MCPTT call and the MCPTT call remains ongoing with the other media endpoints, the IWF floor control server follows a two-step procedure. + +- Step 1 The IWF stops sending floor control messages and RTP media packets to the MCPTT media endpoint leaving the MCPTT call and, the IWF discards floor control messages and RTP media packets received from the MCPTT media endpoint leaving the MCPTT call. +- Step 2 When the application and signalling plane has determined that the MCPTT call with this MCPTT floor participant has been released, the corresponding instance of the IWF floor control server state machine for 'basic floor control operation towards the floor participant' is released. + +When an MCPTT call is released, the IWF floor control server follows a two-step procedure. + +- Step 1 The IWF stops sending floor control messages and RTP media packets to all floor participants in the MCPTT call. +- Step 2 When the application and signalling plane has determined that the MCPTT call has been released, the corresponding instance of the floor control server state machine for 'general floor control operation' are also terminated, along with any 'basic floor control operation towards the floor participant' state machines for the floor participants of this call. + +The floor control server state machine for general floor control operation initiates the MCPTT call release depending on the release policy specified in 3GPP TS 29.379 [26]. + +### 6.3.4 Floor control server state transition diagram for general floor control operation + +#### 6.3.4.1 General + +The floor control server arbitration logic in the floor control server in the IWF shall behave according to the state diagram in Figure 6.3.4.1-1 and state transitions specified in this clause. The present clause is applicable for floor control of groups homed in the IWF. + +![Floor control server state transition diagram for 'general floor control operation'](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Any_state : R: Merge + [*] --> Releasing : R: MCPPT call release - 1 + Any_state --> Start_stop : R: Merge + Releasing --> Start_stop : R: MCPPT call release - 2 + Start_stop --> G: Initialising : MCPPT call initialization + Start_stop --> G: Floor Idle : MCPPT call initialization + Start_stop --> G: Floor Taken : MCPPT call initialization + G: Initialising --> G: Floor Idle : R: final SIP responses + G: Initialising --> G: Floor Taken : R: final SIP responses + G: Floor Idle --> G: Initialising : T4 (inactivity) expired + G: Floor Idle --> G: Floor Taken : T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release + G: Floor Idle --> G: Pending Floor Revoke : T7 (Floor Idle) expired OR R: Floor Request OR T4 (inactivity) expired OR R: Implicit Floor request + G: Floor Taken --> G: Floor Idle : T1 (end of RTP media) expired OR R: Floor Release OR R: client release OR I: IWF floor participant release + G: Floor Taken --> G: Pending Floor Revoke : T2 (stop talking) expired OR R: pre-emptive Floor request OR R: Implicit floor request + G: Pending Floor Revoke --> G: Floor Taken : R: Floor Release OR T3 (Stop talking grace) expired + G: Pending Floor Revoke --> G: Floor Idle : T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release + G: Pending Floor Revoke --> [*] : R: RTP Media OR T1 (end of RTP media) expired + +``` + +The diagram illustrates the state transitions for a floor control server. It starts with an initial state 'Any state' which can transition to 'Start-stop' (via 'R: Merge') or 'Releasing' (via 'R: MCPPT call release - 1'). 'Start-stop' transitions to 'G: Initialising', 'G: Floor Idle', or 'G: Floor Taken' (all via 'MCPPT call initialization'). 'Releasing' transitions to 'Start-stop' (via 'R: MCPPT call release - 2'). 'G: Initialising' transitions to 'G: Floor Idle' or 'G: Floor Taken' (both via 'R: final SIP responses'). 'G: Floor Idle' transitions to 'G: Initialising' (via 'T4 (inactivity) expired'), 'G: Floor Taken' (via 'T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release'), or 'G: Pending Floor Revoke' (via 'T7 (Floor Idle) expired OR R: Floor Request OR T4 (inactivity) expired OR R: Implicit Floor request'). 'G: Floor Taken' transitions to 'G: Floor Idle' (via 'T1 (end of RTP media) expired OR R: Floor Release OR R: client release OR I: IWF floor participant release'), 'G: Pending Floor Revoke' (via 'T2 (stop talking) expired OR R: pre-emptive Floor request OR R: Implicit floor request'), or back to 'G: Floor Taken' (via 'R: RTP Media OR R: Floor Request OR T20 (Floor Granted) expired OR T20 (Floor Granted) expired N times OR R: pre-emptive Floor Request OR T1 (end of RTP media) expired, OR R: Floor Release OR R: client release'). 'G: Pending Floor Revoke' transitions to 'G: Floor Taken' (via 'R: Floor Release OR T3 (Stop talking grace) expired'), 'G: Floor Idle' (via 'T1 (end of RTP media) expired OR T3 (Stop talking grace) expired OR R: Floor Release'), or back to the initial state (via 'R: RTP Media OR T1 (end of RTP media) expired'). + +Floor control server state transition diagram for 'general floor control operation' + +**Figure 6.3.4.1-1: Floor control server state transition diagram for 'general floor control operation'** + +The floor control arbitration logic in the floor control server shall keep one instance of the 'general floor control operation' state machine per MCPPT call. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following clauses the floor control arbitration logic in the IWF floor control server: + +1. shall discard the floor control message; +2. shall request the media distributor in the IWF to discard any received RTP media packet; and + +3. shall remain in the current state. + +State details are explained in the following clauses. + +#### 6.3.4.2 State: 'Start-stop' + +##### 6.3.4.2.1 General + +When a new instance of the 'general floor control operation' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly, when the call is released the state machine shall return to the 'Start-stop' state or the related MCPTT call is released. + +##### 6.3.4.2.2 MCPTT call initialization + +When an MCPTT call is initiated as specified in 3GPP TS 29.379 [26] and + +1. if a confirmed indication is required and at least one invited media endpoint has accepted the invitation; +2. if a confirmed indication is not required; or +3. if the initialised MCPTT call is a temporary group session; + +NOTE: An MCPTT group call is a temporary group session when the element is present in the element as specified in 3GPP TS 24.481 [12]. + +then the floor control arbitration logic in the floor control server: + +1. shall create an instance of the 'general floor control operation' state machine; +2. shall wait for the 'basic floor control operation towards the floor participant' to be initialized before continuing the following steps; +3. when the 'basic floor control operation towards the floor participant' state machine is initialized, and the initialised session is not a temporary group session: + - a. if the "mc\_granted" ftmp attribute is not negotiated as specified in clause 14: + - i. if the floor control server is granting an implicit floor request at MCPTT call establishment, shall act as if a Floor Request message was received and perform the actions specified in clause 6.3.4.3.3; or + - ii. if the floor control server is not granting an implicit floor request at MCPTT call establishment, shall enter the 'G: Floor Idle' state as specified in clause 6.3.4.3.2; or + - b. if the "mc\_granted" ftmp attribute is negotiated as specified in clause 14, shall enter the 'G: Floor Taken' state as specified in clause 6.3.4.4.2; and +4. if the 'basic floor control operation towards the floor participant' state machine is initialized, and the initialised session is a temporary group session, shall enter the 'G: Initialising' state as specified in the clause 6.3.4.8.1. + +#### 6.3.4.3 State: 'G: Floor Idle' + +##### 6.3.4.3.1 General + +The floor control arbitration logic in the IWF floor control server is in this state when no floor participant currently has permission to send media. + +Timer T4 (Inactivity) and timer T7 (Floor Idle) can be running when the floor control arbitration logic in the IWF floor control server is in this state. + +##### 6.3.4.3.2 Enter the 'G: Floor Idle' state + +When entering this state from any state except the 'Start-stop' state and if no MCPTT media endpoint negotiated support of queueing floor requests as described in clause 14, and the IWF does not require queueing for its IWF floor + +participants, and the state machine specified in clause 6.3.6 does not exist, the floor control arbitration logic in the IWF floor control server: + +1. if there is a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' stored, shall remove the Track Info field from the storage; +2. if the active floor request queue is empty the IWF floor control server: + - a. shall send Floor Idle message to all MCPTT floor participants. The Floor Idle message: + - i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + +NOTE 1: How the IWF informs IWF media endpoints of the idle floor is out of scope of the present document. + +- b. shall start timer T7 (Floor Idle) and initialise counter C7 (Floor Idle) to 1; + - c. shall start timer T4 (Inactivity); and + - d. shall set the general state to the 'G: Floor Idle' state; and +3. if the active floor request queue is not empty the IWF floor control server: + - a. shall select a queued floor request from the top of the active floor request queue; + - b. shall remove that queued floor request from the active floor request queue; + - c. if the queued floor request includes a Track Info field, shall store the Track Info field and associate it with the floor control server state transition diagram for 'general floor control operation'; and + - d. shall enter the 'G: Floor Taken' state as specified in the clause 6.3.4.4.2 with respect to that floor participant. + +When entering this state from any state except the 'Start-stop' state and the state machine specified in clause 6.3.6 exists, the floor control arbitration logic in the IWF floor control server: + +1. if there is a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' stored, shall remove the Track Info field from the storage; +2. shall send Floor Idle message to all MCPTT floor participants which are configured to listen to the overridden participant. The Floor Idle message: + - a. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + +NOTE 2: How the IWF informs IWF media endpoints of the idle floor is out of scope of the present document. + +3. shall send Floor Taken message to MCPTT floor participants which are configured to listen only to the overridden participant. The Floor Taken message: + - a. if privacy is not requested, shall include the granted MCPTT user's (overriding participant) MCPTT ID in the Granted Party's Identity field; + - b. shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + +NOTE 3: How the IWF informs IWF media endpoints of the taken floor is out of scope of the present document. + +4. shall set the general state to the 'G: Floor Taken' state; and + +5. shall send the termination instruction to the 'dual floor control operation' state machine. + +#### 6.3.4.3.3 Receive Floor Request message (R: Floor Request) + +Upon receiving a floor request message (from an MCPTT floor participant that is permitted to make a floor request) the floor control arbitration logic in the IWF floor control server: + +1. shall reject the request if one of the following conditions is fulfilled: + - a. if there is only one media endpoint in the MCPTT call; and + - b. element is present in the element as specified 3GPP TS 24.481 [12] for the associated floor participant; +2. if the floor request is rejected the IWF floor control server: + - a. shall send the Floor Deny message. The Floor Deny message: + - i. shall include in the Reject Cause field the value: + - A. cause #3 (Only one participant), if there is only one media endpoint in the MCPTT call; or + - B. cause #5 (Receive only), if the element is present in the element as specified in 3GPP TS 24.481 [12] for the associated MCPTT floor participant; + - ii. may include an additional text string explaining the reason for rejecting the floor request in the value of the Reject Cause field; and + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; + - b. shall remain in the 'G: Floor Idle' state; and +3. if the floor request is granted the IWF floor control server: + - a. shall stop timer T4 (Inactivity); + - b. shall stop timer T7 (Floor Idle); + - c. if the floor is being granted to an MCPTT floor participant, and if a Track Info field is included in the Floor Request message, shall store the received Track Info field, and + - d. shall enter the 'G: Floor Taken' state as specified in the clause 6.3.4.4.2. + +#### 6.3.4.3.3a IWF floor participant grant (I: IWF Floor Participant Grant) + +To grant floor to an IWF floor participant, the floor control arbitration logic in the IWF floor control server: + +1. shall stop timer T4 (Inactivity); +2. shall stop timer T7 (Floor Idle); +3. if the floor is being granted to an IWF floor participant, + - a. shall generate and store an SSRC; otherwise + - b. shall store the SSRC of the IWF floor participant granted the permission to send media until the floor is released associated to that floor request; and +4. shall enter the 'G: Floor Taken' state as specified in the clause 6.3.4.4.2. + +#### 6.3.4.3.4 Timer T7 (Floor Idle) expired + +On expiry of timer T7 (Floor Idle) the floor control arbitration logic in the IWF floor control server: + +1. shall restart timer T7 (Floor Idle) and increment counter C7 (Floor Idle) by 1 if counter C7 (Floor Idle) has not reached its upper limit; + +2. shall send a Floor Idle message to all MCPTT floor participants in the MCPTT call if counter C7 (Floor Idle) has not reached its upper limit. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; and + +NOTE: How the IWF informs IWF media endpoints of the idle floor is out of scope of the present document. + +3. shall remain in the 'G: Floor Idle' state. + +#### 6.3.4.3.5 Timer T4 (Inactivity) expired + +On expiry of timer T4 (Inactivity) the floor control arbitration logic in the IWF floor control server based on a configurable service provider policy either: + +1. shall indicate to the application and signalling plane that timer T4 (Inactivity) has expired; +2. if the application and signalling planes initiates MCPTT call release, shall enter the 'Releasing' state; and +3. if the application and signalling planes do not initiate MCPTT call release: + - a. should restart the T4 (Inactivity) timer; and + - b. shall remain in the 'G: Floor Idle' state. + +#### 6.3.4.3.6 Receive an implicit floor request (R: Implicit floor request) + +Upon receiving an implicit floor request due to an upgrade to an emergency group call or due to an upgrade to imminent peril call, the floor control arbitration logic in the IWF floor control server: + +1. shall reject the request if there is only one media endpoint in the MCPTT call; +2. if the floor request is rejected the IWF floor control server: + - a. shall send the Floor Deny message. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #3 (Only one participant); and + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - b. shall remain in the 'G: Floor Idle' state; and +3. if the floor request is granted the IWF floor control server: + - a. shall stop the timer T4 (Inactivity); + - b. shall stop the timer T7 (Floor Idle); and + - c. shall enter the 'G: Floor Taken' state as specified in the clause 6.3.4.4.2. + +#### 6.3.4.4 State: 'G: Floor Taken' + +##### 6.3.4.4.1 General + +The floor control arbitration logic in the IWF floor control server uses this state when it has permitted one or more media endpoints in the MCPTT call to send media. + +Timer T1 (End of RTP media) is running when the floor control server is in this state. + +Timer T2 (End talking) can be running when the IWF floor control server is in this state. + +Timer T20 (Floor Granted) is running to guarantee reliable delivery of the Floor Granted message, if the granted floor request was queued. + +#### 6.3.4.4.2 Enter the 'G: Floor Taken' state + +When entering this state, the floor control arbitration logic in the IWF floor control server: + +1. shall send a Floor Granted message to the MCPTT floor participant to which the floor is granted. The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if a Track Info field associated with the floor control server state transition diagram for 'general floor control operation' is stored, shall include the stored Track Info field; and + - d. if a group call is a broadcast group call, system call, emergency call, an imminent peril call or a temporary group session, shall include the Floor Indicator field with appropriate indications; + 2. shall start timer T20 (Floor Granted) if the floor request was queued for the participant to which the floor is granted and initialise the counter C20 (Floor Granted) to 1; + 3. shall send Floor Taken message to all MCPTT floor participants. The Floor Taken message: + - a. shall include the granted user's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; + - b. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; + - c. if the session is a broadcast group call, shall include the Permission to Request the Floor field set to '0'; + - d. if the session is not a broadcast group call, may include the Permission to Request the Floor field set to '1'; and + - e. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- NOTE: How the IWF informs IWF media endpoints of the taken floor is out of scope of the present document. +4. shall start timer T1 (End of RTP media) for the participant to which the floor is granted; and + 5. shall set the general state to 'G: Floor Taken' state. + +#### 6.3.4.4.3 Timer T1 (End of RTP media) expired + +On expiry of timer T1 (End of RTP media), the floor control arbitration logic in the IWF floor control server: + +1. shall stop the timer T2 (Stop talking) for the participant to which the floor is granted; if running; +2. shall stop timer T20 (Granted re-send) for the participant to which the floor is granted, if running; +3. shall request the media distributor to stop distributing RTP media packets received from the participant for which T1 (End of RTP media) has expired (with the exception of RTP media packets already in the buffer (if RTP media buffering is ongoing)) to other media endpoints; and +4. shall enter the 'G: Floor Idle' state as specified in the clause 6.3.4.3.2; + +#### 6.3.4.4.4 Timer T2 (Stop talking) expired + +On expiry of timer T2 (Stop talking), the floor control arbitration logic in the IWF floor control server: + +1. shall stop timer T1 (End of RTP media) for the MCPTT participant for which timer T2 has expired; +2. shall include the Reject Cause field with the value set to #2 (Media burst too long) in the Floor Revoke message sent in clause 6.3.4.5.2; and +3. shall enter the 'G: pending Floor Revoke' state as specified in the clause 6.3.4.5.2. + +#### 6.3.4.4.5 Receive RTP media packets (R: RTP media) + +Upon receiving an indication from the media distributor that RTP media packets are received from the MCPTT media endpoint, the floor control arbitration logic in the IWF floor control server: + +1. shall start timer T2 (Stop talking) for the MCPTT media endpoint from which the RTP packet has been received, if not running; +2. shall restart timer T1 (End of RTP media) for the participant from which the RTP packet has been received; +3. shall stop timer T20 (Floor Granted) for the participant from which the RTP packet has been received, if running; +4. shall forward the RTP media packets to media endpoints according to local policy; and + +NOTE: If dual floor control is ongoing as described in clause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +5. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.6 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message or upon determining that a user homed in the IWF has released the floor, the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor to stop forwarding RTP media packets received from the participant that sent the Floor Release message; +2. shall stop timer T2 (Stop talking) for the participant that sent the Floor Release message, if running; +3. shall stop timer T20 (Granted re-send) for the participant that sent the Floor Release message, if running; and +4. shall enter the 'G: Floor Idle' state as specified in the clause 6.3.4.3.2; + +#### 6.3.4.4.6a IWF floor participant release (I: IWF floor participant release) + +Upon deciding to release the floor, the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor to stop forwarding RTP media packets; and +2. shall enter the 'G: Floor Idle' state as specified in the clause 6.3.4.3.2. + +#### 6.3.4.4.7 Receive Floor Request message with pre-emptive priority (R: pre-emptive Floor Request) + +NOTE: This procedure is also invoked from the clause 6.3.5.4.4. + +On receipt of a floor request message with effective priority indicating pre-emptive priority, and if the effective priority of the floor participant with permission to send media is not the pre-emptive priority, the floor control arbitration logic in the IWF floor control server: + +1. based on local policy, select one of the following options: + - a. revoke the current speaker; or + - b. allow media from both the current speaker and from the participant now requesting floor with a pre-emptive floor priority; +2. if revoking current speaker is selected: + - a. shall stop timer T1 (End of RTP media), if running; + - b. shall stop timer T20 (Floor Granted), if running; + +- c. shall include a Reject Cause field with the value set to #4 (Media Burst pre-empted) in the Floor Revoke message sent in clause 6.3.4.5.2; + - d. shall enter the 'G: pending Floor Revoke' state as specified in the clause 6.3.4.5.2; + - e. shall insert the MCPTT floor participant into the active floor request queue to the position in front of all queued requests, if not inserted yet or update the position of the floor participant in the active floor request queue to the position in front of all other queued requests, if already inserted; and + - f. shall send a Floor Queue Position Info message to the requesting MCPTT floor participant, if negotiated support of queueing of floor requests as specified in clause 14. The Floor Queue Position Info message: + - i. include the queue position and floor priority in the Queue Info field; and + - ii. if the Floor Request message included a Track Info field, shall include the received Track Info field; and +3. if allow media from both the current speaker and from the participant now requesting floor with a pre-emptive priority is selected: +- a. shall perform the actions specified in the clause 6.3.6.2.2. + +#### 6.3.4.4.7a Receive Floor Request message multi-talker (R: multi-talker Floor Request) + +The multi-talker feature is not supported in this version of the present document. + +#### 6.3.4.4.8 Receive Floor request message from MCPTT floor participant (R: Floor Request) + +Upon receiving a floor request message from the MCPTT floor participant that has been granted permission to send media, the floor control arbitration logic in the IWF floor control server: + +- 1. shall send a Floor Granted message to the previously granted MCPTT floor participant. The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) running for this MCPTT floor participant in the Duration field; + - b. shall include the granted priority in the Floor priority field; and +- c. if the Floor Request message included a Track Info field, shall include the received Track Info field; and +- 2. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.9 Timer T20 (Floor Granted) expired + +On expiry of timer T20 (Floor Granted), the floor control arbitration logic in the IWF floor control server: + +- 1. shall send a Floor Granted message to the granted floor participant if counter C20 (Floor Granted) has not reached its upper limit: The Floor Granted message: + - a. shall include the value of timer T2 (Stop talking) in the Duration field; + - b. shall include the granted priority in the Floor priority field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 2. shall start timer T20 (Floor Granted) and increment counter C20 (Floor Granted) by 1 if counter C20 (Floor Granted) has not reached its upper limit; and +- 3. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.10 Timer T20 (Floor Granted) expired N times + +When timer T20 (Floor Granted) expires and counter C20 (Floor Granted) reaches its upper limit, the floor control arbitration logic in the IWF floor control server: + +1. shall remain in the 'G: Floor Taken' state. + +#### 6.3.4.4.11 MCPTT media endpoint release (R: client release) + +If the IWF floor control server receives an indication from the floor control interface towards the MCPTT client that the MCPTT media endpoint has started to disconnect from the MCPTT call, or the IWF decides to release the floor, the floor control arbitration logic in the floor control server: + +1. shall enter the 'G: Floor Idle' state as specified in the clause 6.3.4.3.2. + +#### 6.3.4.4.12 Receive an implicit floor request (R: Implicit floor request) + +Upon receiving an implicit floor request due to an upgrade to an emergency group call or due to an upgrade to imminent peril call, the floor control arbitration logic in the IWF floor control server: + +1. shall stop timer T1 (End of RTP media), if running; +2. shall stop timer T20 (Floor Granted), if running; +3. shall set the Reject Cause field in the Floor Revoke message to #4 (Media Burst pre-empted); +4. shall enter the 'G: pending Floor Revoke' state as specified in the clause 6.3.4.5.2; +5. shall insert the MCPTT floor participant into the active floor request queue to the position in front of all queued requests, if not inserted yet or update the position of the floor participant in the active floor request queue to the position in front of all other queued requests, if already inserted; and +6. shall send a Floor Queue Position Info message to the requesting MCPTT floor participant, if negotiated support of queueing floor requests as specified in clause 14. The Floor Queue Position Request message: + - a. shall include the queue position and floor priority in the Queue Info field; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications. + +#### 6.3.4.5 State: 'G: pending Floor Revoke' + +##### 6.3.4.5.1 General + +The floor control arbitration logic in the IWF floor control server uses this state after having sent a Floor Revoke message to the MCPTT floor participant. + +Timer T3 (Stop talking grace) is running when the floor control arbitration logic in the IWF floor control server is in this state. + +In this state, the IWF forwards RTP media packets to the MCPTT media endpoints in the MCPTT call. + +##### 6.3.4.5.2 Enter the 'G: pending Floor Revoke' state + +When entering this state, the floor control arbitration logic in the IWF floor control server: + +1. shall send the Floor Revoke message to the MCPTT floor participant. The Floor Revoke message: + - a. shall include the reason for sending the Floor Revoke message in the value in the Reject Cause field; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. shall start timer T3 (Stop talking grace) for which a Floor Revoke message has been sent; and +3. shall set the general state to 'G: pending Floor Revoke'. + +#### 6.3.4.5.3 Receive RTP media packets (R: RTP media) + +Upon receiving an indication from the media distributor that RTP media packets are received from the permitted floor participant the IWF floor control server: + +1. shall restart timer T1 (End of RTP media); + +NOTE 1: If the upper limit for timer T3 (Stop talking grace) is less than the upper limit of timer T1 (End of RTP media) then timer T1 (End of RTP media) will not expire. + +2. shall instruct the media distributor to forward the RTP media packets to MCPTT media endpoints according to local policy; and + +NOTE 2: If dual floor control is ongoing as described in clause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +3. shall remain in the 'G: pending Floor Revoke' state. + +#### 6.3.4.5.4 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message for which a Floor Revoke message has been sent, the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor to stop forwarding RTP media packets; +2. shall stop timer T1 (End of RTP media) , if running; +3. shall stop timer T3 (Stop talking grace); +4. if the active floor request queue is not empty the IWF floor control server shall enter the 'G: Idle' state as specified in the clause 6.3.4.3.2; and +5. if the active floor request queue is empty the IWF floor control server shall enter the 'G: Idle' state as specified in the clause 6.3.4.3.2. + +#### 6.3.4.5.5 Timer T3 (Stop talking grace) expired + +On expiry of timer T3 (Stop talking grace) for which a Floor Revoke message has been sent, the floor control arbitration logic in the IWF floor control server: + +1. shall indicate to the interface towards the MCPTT client that the general state machine is now 'G: Floor Idle'; and +2. shall enter the 'G: Idle' state as specified in the clause 6.3.4.3.2. + +#### 6.3.4.5.6 Timer T1 (End of RTP media) expired + +On expiry of timer T1 (End of RTP media) assigned to the MCPTT floor participant for which a Floor Revoke message has been sent, the floor control arbitration logic in the IWF floor control server: + +1. shall stop timer T3 (Stop talking grace); and +2. if the floor is now empty; shall enter the 'G: Floor Idle' state as specified in the clause 6.3.4.3.2. + +On expiry of timer T1 (End of RTP media) assigned to a participant different than the MCPTT floor participant for which a Floor Revoke message has been sent, the floor control arbitration logic in the IWF floor control server: + +1. shall stop forwarding related RTP media packets; +2. shall stop timer T2 (Stop talking) for the MCPTT floor participant for which timer T1 (End of RTP media) expired, if running; and +3. shall stop timer T20 (Granted re-send) for the participant, if running. + +#### 6.3.4.6 In any state + +##### 6.3.4.6.1 General + +This clause describes the actions to be taken in all states defined for the general state diagram with the exception of the 'Start-stop' state. + +##### 6.3.4.6.2 Receive MCPTT call release - 1 + +This clause is used by the floor control arbitration logic in the IWF floor control server when an MCPTT call is released. + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane or upon determining that a user homed in the IWF has released the call, the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor to stop sending RTP media packets to MCPTT media endpoints; and +2. shall enter the 'Releasing' state. + +##### 6.3.4.6.3 Receive an instruction to merge group calls (R: Merge) + +Upon receiving an instruction from the application and signalling plane to merge the ongoing group call with other group calls, the IWF floor control server: + +1. shall perform the actions in clause 6.5.2.3; and +2. shall enter the 'Start-stop' state. + +#### 6.3.4.7 State: 'Releasing' + +##### 6.3.4.7.1 General + +The floor control arbitration logic in the IWF floor control server uses this state while waiting for the application and signalling plane to finalize the disconnection of an MCPTT call. + +##### 6.3.4.7.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control arbitration logic in the IWF floor control server: + +1. shall release all resources reserved in the media plane including the instances used for the 'Floor control server state transition diagram for general floor control operation', and 'Floor control server state transition diagram for basic floor control operation towards the floor participant' state machines and any running timers associated with the state machines; and +2. shall enter the 'Start-stop' state. + +#### 6.3.4.8 State: 'G: Floor Initialising' + +##### 6.3.4.8.1 General + +The floor control arbitration logic in the IWF floor control server uses this state while waiting for all invited constituent MCPTT groups to reply with a final SIP response. + +There are no timers running in this state. The floor control arbitration logic is relying on SIP timers in the signalling and application plane. + +##### 6.3.4.8.2 Enter the 'G: Initialising' state + +When entering this state, the floor control arbitration logic: + +1. shall set the general state to the 'G: Initialising' state. + +#### 6.3.4.8.3 Receiving a floor request from a constituent MCPTT group (R: mcptt-floor-request) + +Upon receiving an indication from the application and signalling plane that a floor request is received from one of the invited constituent MCPTT groups in an application/vnd.3gpp.mcptt-floor-request+xml MIME body, the floor control arbitration logic: + +1. shall cache the application/vnd.3gpp.mcptt-floor-request+xml MIME body; and +2. remain in the 'G: Initialising' state. + +#### 6.3.4.8.4 All final SIP responses received (R: final SIP responses) + +Upon receiving an indication from the application and signalling plane that all invited constituent MCPTT groups have sent a final SIP response, the floor control arbitration logic: + +1. if at least one application/vnd.3gpp.mcptt-floor-request+xml MIME body exists with the element set to "general": + - a. shall select the floor participant with the highest priority as described in clause 4.1.1.4: + - i. among the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies with the element set to "general"; and + - ii. the floor participant initialising the temporary group session as described in clause 4.1.1.4, if the floor participant initialising the temporary group session negotiated implicit floor request as specified in clause 14; + - b. shall send a Floor Revoke message to all MCPTT floor participants in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" that are not granted the permission to send media. The Floor Revoke message: + - i. shall include the value set to '4' (Media Burst pre-empted) in the Reject Cause field; + - ii. shall include information taken from the element in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" in the Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +NOTE 1: How the IWF informs IWF media endpoints of the floor revoke is out of scope of the present document. + +- c. if the floor participant selected to be granted the floor is in one of invited constituent MCPTT groups: + - i. shall convert the element to a format of a Track Info field and cache the Track Info field associated with the floor control server state transition diagram for 'general floor control operation'; and + - ii. shall enter the 'G: Taken' state as specified in the clause 6.3.4.4.2 using the selected floor participant as the requesting floor participant; +2. if at least one application/vnd.3gpp.mcptt-floor-request+xml MIME body exists with the element set to "dual": + - a. shall select the floor participant with the highest priority as described in clause 4.1.1.4 among the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies with the element set to "dual"; and + - b. shall send a Floor Revoke message to all floor participants in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "dual" that are not granted the permission to send media. The Floor Revoke message: + - i. shall include the value set to '4' (Media Burst pre-empted) in the Reject Cause field; + +- ii. shall include information taken from the element in the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body with the element set to "general" in the Track Info field; +- iii. shall include the Floor Indicator with the G-bit set to '1' (Dual floor); +- iv. shall convert the element to a format of a Track Info field and cache the Track Info field associated with floor control server state transition diagram for 'dual floor control operation'; and +- v. shall enter the 'D: Floor Taken' state as specified in the clause 6.3.6.3.2 using the selected floor participant as the requesting floor participant; and + +NOTE 2: How the IWF informs IWF media endpoints of the floor revoke is out of scope of the present document. + +- 3. if no cached application/vnd.3gpp.mcptt-floor-request+xml MIME with the element set to "general" body exists: + - a. if an implicit floor request is negotiated as described in clause 14 when the temporary group session was established, shall enter the 'G: Taken' state as specified in the clause 6.3.4.4.2; and + - b. if an implicit floor request is not negotiated as described in clause 14 when the temporary group session was established, shall enter the 'G: Idle' state as specified in the clause 6.3.4.3.2. + +## 6.3.5 Floor control server state transition diagram for basic floor control operation towards the floor participant + +### 6.3.5.1 General + +The floor control interface towards the MCPTT client in the IWF floor control server shall behave according to the state diagram and state transitions specified in this clause. + +**Editor's Note:** procedures for the IWF performing the non-controlling role are FFS. + +The description of the floor control interface towards an IWF media endpoint is part of the general floor control server state diagram and state transitions specified in clause 6.3.4. + +Figure 6.3.5.1-1 shows the states and state transitions for an associated floor participant in the floor control server. + +![State transition diagram for MCPTT floor control. States include: Any state, Start-stop state, Releasing, U: not permitted and initiating, U: permitted, U: pending Floor Revoke, U: not permitted and Floor Idle, U: not permitted but sends media, U: not permitted and Floor Taken. Transitions are triggered by SIP session events, floor requests, grants, revokes, and media activity.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Start-stop state : R: Merge + [*] --> Releasing : R: MCPTT session release - 1 + Start-stop state --> Releasing : R: MCPTT session release - 2 + Start-stop state --> U: not permitted and initiating : SIP Session initiated + U: not permitted and initiating --> Start-stop state : R: Floor Request OR R: Floor Release + U: not permitted and initiating --> U: permitted : S: Floor Granted + U: not permitted and initiating --> U: not permitted and Floor Idle : S: Floor Idle + U: not permitted and initiating --> U: not permitted and Floor Taken : S: Floor Taken + U: permitted --> Start-stop state : R: Floor Request OR R: Floor Release + U: permitted --> U: not permitted and initiating : [SIP session initiated AND implicit floor request] + U: permitted --> U: permitted : R: Floor Request OR R: RTP media OR R: Floor Release + U: permitted --> U: pending Floor Revoke : S: Floor Revoke + U: permitted --> U: not permitted and Floor Idle : S: Floor Idle + U: permitted --> U: not permitted and Floor Taken : S: Floor Taken + U: pending Floor Revoke --> Start-stop state : R: Floor Request OR S: Floor Granted + U: pending Floor Revoke --> U: permitted : T8 (Floor Revoke) expired OR R: RTP media OR R: Floor Release + U: pending Floor Revoke --> U: not permitted and Floor Idle : S: Floor Idle + U: pending Floor Revoke --> U: not permitted and Floor Taken : S: Floor Taken + U: not permitted and Floor Idle --> Start-stop state : S: Floor Idle + U: not permitted and Floor Idle --> U: permitted : S: Floor Idle + U: not permitted and Floor Idle --> U: not permitted and Floor Taken : S: Floor Taken + U: not permitted and Floor Idle --> U: not permitted but sends media : Floor Request OR Floor Release OR R: Media OR S: Floor Deny OR R: Implicit floor request OR S: Floor Idle + U: not permitted and Floor Taken --> Start-stop state : S: Floor Idle + U: not permitted and Floor Taken --> U: permitted : S: Floor Idle + U: not permitted and Floor Taken --> U: not permitted and Floor Idle : S: Floor Idle + U: not permitted and Floor Taken --> U: not permitted but sends media : R: Floor Release + U: not permitted and Floor Taken --> U: pending Floor Revoke : R: Floor Request OR R: Floor Release OR R: Floor Queue Position Request OR R: Implicit floor request OR S: Floor Taken + U: not permitted but sends media --> Start-stop state : R: RTP media + U: not permitted but sends media --> U: not permitted and Floor Idle : R: Floor Release + U: not permitted but sends media --> U: not permitted and Floor Taken : R: RTP media + U: not permitted but sends media --> U: pending Floor Revoke : T8 (Floor Revoke) expired + +``` + +State transition diagram for MCPTT floor control. States include: Any state, Start-stop state, Releasing, U: not permitted and initiating, U: permitted, U: pending Floor Revoke, U: not permitted and Floor Idle, U: not permitted but sends media, U: not permitted and Floor Taken. Transitions are triggered by SIP session events, floor requests, grants, revokes, and media activity. + +**Figure 6.3.5.1-1: Floor control server state transition diagram for basic floor control operation towards the floor participant** + +The floor control interface towards the MCPTT client in the IWF floor control server shall create one instance of the 'basic floor control operations' state machine towards the MCPTT client for every floor participant served by the IWF floor control server as follows: + +1. For pre-arranged group call in case of an originating MCPTT call, the 'basic floor control operation towards the floor participant' state machine shall be created when the MCPTT server sends the SIP 200 (OK) response towards the originating MCPTT client. +2. For pre-arranged group call in case of a terminating MCPTT call, the 'basic floor control operation towards the floor participant' state machine shall be created when the IWF floor control server receives the SIP 200 (OK) response. +3. For chat group call the 'basic floor control operation state machine towards the floor participant' shall be created when the MCPTT server sends the SIP 200 (OK) response to the received initial SIP INVITE request. + +The floor participant associated to the 'basic floor control operation towards the floor participant' state machine is here referred to as the "associated floor participant". + +The external inputs to the state machine are: + +1. directives coming from the floor control arbitration logic; +2. floor messages sent by the floor participants; +3. media; and +4. in certain cases, SIP messages used for call handling. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following clauses, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall discard the floor control message; +2. shall request the network media interface in the MCPTT server to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following clauses. + +### 6.3.5.2 State: 'Start-stop' + +#### 6.3.5.2.1 General + +When a new instance of the 'basic floor control operations towards the floor participant' state machine is created, before any floor control related input is applied, the state machine is in the 'Start-stop' state. Similarly, when the call is released the state machine shall return to the Start-Stop state. + +An association between the IWF floor control server and a floor participant in the MCPTT client is created, when the state machine is created; and + +1. in case of an originating MCPTT call, when the MCPTT server sends the SIP 200 (OK) response to the originating MCPTT client; and +2. in case of a terminating MCPTT call, when the IWF floor control server receives the SIP 200 (OK) response sent from the terminating MCPTT client. + +#### 6.3.5.2.2 SIP Session initiated + +When a SIP Session is established and if: + +1. the session is not a temporary group call session; or + +2. the session is a temporary group call session and the associated floor participant is an invited MCPTT client (i.e. not a constituent MCPTT group); + +then: + +NOTE 1: A MCPTT group call is a temporary group session when the element is present in the element as specified in 3GPP TS 24.481 [12]. + +1. if an MCPTT client initiates an MCPTT call with an implicit floor request, and the MCPTT call does not exist yet, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall initialize a general state machine as specified in clause 6.3.4.2.2; and + +NOTE 2: In the clause 6.3.4.2.2 the 'general floor control operation' state machine will continue with the initialization of the 'general floor control operation' state machine. + +- b. shall enter the state 'U: permitted' as specified in the clause 6.3.5.5.2; +2. if the associated MCPTT client rejoins an ongoing MCPTT call without an implicit floor request or initiates or joins a chat group call without an implicit floor request or attempts to initiate an already existing MCPTT call without an implicit floor request, and + +- a. if an MCPTT call already exists but no MCPTT client has the permission to send a media, the floor control interface towards the MCPTT client in the IWF floor control server: + +- i. should send a Floor Idle message to the MCPTT client. The Floor Idle message: + +- A. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +- ii. shall enter the state 'U: not permitted and Floor Idle' as specified in the clause 6.3.5.5.2; + +- b. if an MCPTT call is initiated, the floor control interface towards the MCPTT client in the IWF floor control server: + +- i. shall enter the state 'U: not permitted and Floor Idle' as specified in the clause 6.3.5.5.2; and + - ii. shall initialize a general state machine as specified in clause 6.3.4.2.2; and + +NOTE 3: In the clause 6.3.4.2.2 the general state machine will continue with the initialization of the general state machine. + +- c. if another MCPTT client has the permission to send a media, the floor control interface towards the MCPTT client in the IWF floor control server: + +- i. should send a Floor Taken message to the MCPTT client. The Floor Taken message: + +- A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - B. shall include a Message Sequence Number field with a value increased with 1; + - C. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - D. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; and + - E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications + +- ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; + +3. if the associated floor participant attempts to initiate an already existing MCPTT call with an implicit floor request, and + - a. if no MCPTT client has the permission to send media, the floor control interface towards the MCPTT client in the IWF floor control server: + - i. shall process the implicit floor request as if a Floor Request message was received as specified in clause 6.3.4.3.3; and + - ii. shall enter the state 'U: permitted' as specified in the clause 6.3.5.5.2; + - b. if the MCPTT client negotiated support of queueing floor requests as specified in clause 14 and if another MCPTT client has the permission to send media, the floor control interface towards the MCPTT client in the IWF floor control server: + - i. shall set the priority level to the negotiated maximum priority level that the MCPTT client is permitted to request, except for pre-emptive priority, when high priority is used; +- NOTE 4: The maximum floor priority the floor participant is permitted to request is negotiated in the "mc\_priority" fmtp attribute as specified in clause 14. +- NOTE 5: The initial implicit floor request will not result in pre-emption when an MCPTT client is joining an ongoing MCPTT call. If the MCPTT client wants to pre-empt the current MCPTT client that is sending media, an explicit floor request with pre-emptive floor priority is required. +- ii. shall insert the MCPTT client into the active floor request queue to the position immediately following all queued floor requests with the same floor priority; + - iii. shall send a Floor Queue Position Info message to the MCPTT client. The Floor Queue Position Info message: + - A shall include the queue position and floor priority in the Queue Info field; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + - iv. should send a Floor Queue Position Info message with the updated status to the MCPTT clients in the active floor request queue which negotiated queueing of floor requests as specified in clause 14, which have requested the queue status, whose queue position has been changed since the previous Floor Queue Position Info message and which is not the joining MCPTT client. The Floor Queue Position Info message: + - A shall include the queue position and floor priority in the Queue Info field; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - v. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; and +- c. if the MCPTT client did not negotiate queueing of floor requests and if another MCPTT client has the permission to send a media, the floor control interface towards the MCPTT client in the IWF floor control server: + - i. shall send a Floor Taken message to the MCPTT client. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - B. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; + - C. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - D. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; and + +- E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; and +- 4. if the MCPTT client is invited to the MCPTT call and + - a. if another MCPTT client has permission to send a media, the floor control interface towards the MCPTT client in the IWF floor control server: + - i. should send a Floor Taken message to the MCPTT client. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - B. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; + - C. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - D. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; and + - E. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; and + - b. if no other MCPTT client has the permission to send a media; the floor control interface towards the MCPTT client in the IWF floor control server: + - i. should send a Floor Idle message to the MCPTT client. The Floor Idle message: + - A. shall include a Message Sequence Number field with a value increased with 1; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2. + +When a SIP Session is established and if the session is a temporary group call session and, + +- 1. if the associated floor participant is a constituent MCPTT group; or +- 2. if the associated floor participant is the initiator of the temporary group session; + +then the floor control interface towards the MCPTT client: + +- 1. shall initialize a general state machine as specified in clause 6.3.4.2.2, if not already initiated; and +- 2. shall enter the 'U: not permitted and initiating' state as specified in clause 6.3.5.10.2. + +### 6.3.5.3 State: 'U: not permitted and Floor Idle' + +#### 6.3.5.3.1 General + +The floor control interface towards the MCPTT client in the IWF floor control server uses this state when the associated floor participant is not permitted to send media. + +#### 6.3.5.3.2 Enter state 'U: not permitted and Floor Idle' + +When entering this state, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. if a Track Info field is stored, shall remove the Track Info field from the storage; and + +2. shall set the state for the associated floor participant to 'U: not permitted and Floor Idle'. + +#### 6.3.5.3.3 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control server arbitration logic, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Taken message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in clause 8.3.2, and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2. + +#### 6.3.5.3.4 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the session is not a broadcast group call or if the session is a broadcast group call and the associated floor participant is the initiator of the broadcast group call, shall forward the Floor Request message to the floor control server arbitration logic; + +NOTE 1: The Floor Request message can contain a Floor Indicator field indicating that the floor request is an attempt to upgrade a group call to a broadcast group call. If the floor control arbitration logic accepts the floor request, the ongoing group call will be upgraded accordingly by the Floor Granted message and, for other participants, by the Floor Taken message. + +NOTE 2 Initiating a broadcast group call is done in the application and signalling plane using SIP. Initiating or upgrading a call to an emergency call or an imminent peril call is done in the application and signalling plane using SIP. + +2. if the session is a broadcast group call and the associated floor participant is not the initiator of the broadcast group call, shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + +- a. shall include in the Reject Cause field the value cause #5 (Receive only); +- b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; +- c. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 3: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +3. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.5 Send Floor Grant message (S: Floor Grant) + +When a Floor Granted message is received from the floor control arbitration logic in the IWF, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: permitted' as specified in clause 6.3.5.5.2. + +#### 6.3.5.3.6 Send Floor Deny message (S: Floor Deny) + +When a Floor Deny message is received from the floor control arbitration logic in the IWF, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Deny messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.7 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. shall send a Floor Idle message to the associated floor participant. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; + - b. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +3. if a Track Info field is included in the Floor Release message, shall use the topmost value and the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; +4. if a no Track Info field is included in the Floor Release message, shall use the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; +5. if the floor participant has a floor request in the queue, shall remove the queued floor request from the queue; and +6. shall remain in the state 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.8 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface that RTP media packets are received with payload from the associated floor participant and if Floor Release message was received in the previous 'U: permitted' state, the floor control interface towards the MCPTT client in the IWF floor control server: + +NOTE: Reception of unauthorized RTP media packets can only happen if the associated floor participant is in an MCPTT client. If the associated floor participant is a floor control server interface in a non-controlling MCPTT function of an MCPTT group, the unauthorized RTP media packets are handled in the non-controlling MCPTT function. + +1. shall request the network media interface in the MCPTT server to not forward the received RTP media packets to the media distributor in the MCPTT server; +2. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall enter the 'U: not permitted but sends media' state as specified in the clause 6.3.5.7.2. + +#### 6.3.5.3.9 Receive an implicit floor request (R: Implicit floor request) + +When an ongoing session is upgraded to an emergency group call and when the application and signalling plane indicates that a subsequent SDP offer included the "mc\_implicit\_request" fmtp attribute as described in clause 14, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall indicate to the floor control server arbitration logic that an implicit floor request is received due to an upgrade to an emergency group call; and +2. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.3.10 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Idle' state. + +#### 6.3.5.4 State 'U: not permitted and Floor Taken' + +##### 6.3.5.4.1 General + +The floor control interface towards the MCPTT client in the IWF floor control server uses this state when another MCPTT client (i.e. not the associated floor participant) has been given permission to send media. + +In this state RTP media packets received from the media distributor in the MCPTT server are forwarded to the associated floor participant by the network media interface in the MCPTT server. + +##### 6.3.5.4.2 Enter state 'U: not permitted and Floor Taken' + +When entering this state, the IWF floor control server: + +1. if a Track Info field is stored, shall remove the Track Info field from the storage; and +2. shall set the state to 'U: not permitted and Floor Taken'. + +#### 6.3.5.4.3 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Idle message to the associated floor participant; +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in clause 8.3.2; + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if an indication is stored that the participant is listening to media from two sources, i.e. dual floor control is applied, + - a. shall remain in the 'U: not permitted and Floor Taken' state; and + - b. shall remove the indication that a participant is listening to media from two sources; and +4. if an indication for dual floor control is not stored, shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2. + +#### 6.3.5.4.4 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, if the group is configured for audio cut-in floor control, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Request message to the floor control server arbitration logic; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message, without a Floor Indicator field or with the Floor Indicator field included where the D-bit (Emergency call) and the E-bit (Imminent peril call) are set to '0', from the associated floor participant, and if the MCPTT client did not negotiate queueing of floor requests or did not include a priority in the "mc\_priority" fmtp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - c. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message from the associated floor participant and the session is a broadcast group call, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - a. shall include in the Reject Cause field the value cause #5 (Receive only); + +- b. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. may set the first bit in the subtype of the Floor Deny message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Request message from the associated floor participant and if the MCPTT client negotiated support of queueing of floor requests or included a floor priority in the "mc\_priority" or both as described in specified in clause 14 and according to local policy, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall determine the effective priority level as described in clause 4.1.1.4 by using the following parameters: + - a. the floor priority shall be: + - i. the lower of the floor priority included in Floor Request message and the negotiated maximum floor priority that the MCPTT client is permitted to request, if the MCPTT client negotiated floor priority "mc\_priority" and floor priority is included in the Floor Request message; + - ii. the receive only floor priority, if the MCPTT client negotiated floor priority in the "mc\_priority" fmtp attribute and if the negotiated maximum floor priority that the MCPTT client is permitted to request is "receive only"; + - iii. the default priority, if the MCPTT client negotiated floor priority in the "mc\_priority" fmtp attribute, if the negotiated maximum floor priority that the MCPTT client is permitted to request is not receive only and if the floor priority is not included in the Floor Request message; and + - iv. the default priority, if the MCPTT client did not negotiate floor priority in the "mc\_priority" fmtp attribute; and + - b. the type of the call shall be + - i. if the Floor Indicator field is included in the message and the D-bit (Emergency call bit) is set to '1', determined to be an emergency call; + - ii. if the Floor Indicator field is included in the message and the E-bit (Imminent peril call) is set to '1', determined to be an imminent peril call; and + - iii. if the Floor Indicator field is not included in the message or the Floor Indicator field is included and neither the D-bit (Emergency call bit) nor the E-bit (Imminent peril call) is set to '1', determined to be a normal call; +2. if the effective priority is "receive only", the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send a Floor Deny message to the floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #5 (Receive only) ; + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state; + +3. if + - a. a Track Info field is included in the Floor Request message, shall use the topmost value and the SSRC in the received Floor Request message to check if the floor participant has a queued floor request; or + - b. a Track Info field is not included in the Floor Request message, shall use the SSRC in the received Floor Request message to check if the floor participant has a queued floor request; +4. if the floor participant already has a queued floor request with the same effective priority level, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send a Floor Queue Position Info message to the requesting MCPTT client, if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14. The Floor Queue Position Info message: + - i. shall include the queue position and floor priority in the Queue Info field; + - ii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state +5. if the effective priority level is pre-emptive and there are no other pre-emptive requests in the active floor request queue and the effective priority level of the current MCPTT client with permission to send a media is not the pre-emptive priority, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall forward the Floor Request message to the floor control server arbitration logic indicating that a Floor Request message with pre-emptive priority is received; and + - b. shall remain in the 'U: not permitted and Floor Taken' state + +NOTE 3: The Floor control server arbitration logic initiates revoking the permission to send media towards the current MCPTT client with the permission to send media as specified in the clause 6.3.4.4.7; + +6. if the MCPTT client did not negotiate support of queueing of floor requests as specified in clause 14, the effective priority level is pre-emptive and either other pre-emptive request is queued or the effective priority level of the current MCPTT client with permission to send a media is the pre-emptive priority, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + - iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall remain in the 'U: not permitted and Floor Taken' state; +7. if the MCPTT client did not negotiate "queueing" and the effective priority level is not pre-emptive, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send a Floor Deny message to the associated floor participant. The Floor Deny message: + - i. shall include in the Reject Cause field the value cause #1 (Another MCPTT client has permission); + - ii. may include in the Reject Cause field an additional text string explaining the reason for rejecting the floor request in the value; + +- iii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iv. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- b. shall remain in the 'U: not permitted and Floor Taken' state; and +- 8. if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14 and the effective priority level is not pre-emptive, the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall insert the MCPTT client into the active floor request queue, if not inserted yet, or update the position of the MCPTT client in the active floor request queue, if already inserted, to the position immediately following all queued requests at the same effective priority level; + - b. the IWF floor control server shall send a Floor Queue Position Info message to the floor participant. The Floor Queue Position Info message: + - i. shall include the queue position and floor priority in the Queue Info field; + - ii. if the Floor Request included a Track Info field, shall include the received Track Info field; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + - c. shall remain in the 'U: not permitted and Floor Taken' state; and + - d. may set the first bit in the subtype of the Floor Queue Position message to '1' (Acknowledgment is required) as described in clause 8.3.2. + +NOTE 4: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +#### 6.3.5.4.5 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant and if the MCPTT client did not negotiate support of queueing of floor requests or included a floor priority in the "mc\_priority" fmtp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +- 2. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - a. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - b. shall include a Message Sequence Number field with a value increased with 1; + - c. shall include the Permission to Request the floor field set to '0', if the floor participants are not allowed to request the floor; + - d. if the Floor Release message included a Track Info field, shall include the received Track Info field; + - e. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- f. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +3. shall remain in the 'U: not permitted and Floor Taken' state. + +Upon receiving a Floor Release message from the associated floor participant and if the MCPTT client negotiated support of queueing of floor requests as specified in clause 14, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); + 2. if + - a. a Track Info field is included in the Floor Release message, shall use the topmost value and the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; or + - b. if a Track Info field is not included in the Floor Release message, shall use the SSRC in the received Floor Release message to check if the floor participant has a queued floor request; + 3. shall remove the MCPTT client from the active floor request queue, if the MCPTT client was in the active floor request queue; + 4. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - a. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - b. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - c. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; + - d. if a Track Info field is included in the Floor Release message, shall include the received Track Info field; + - e. shall include a Message Sequence Number field with a value increased with 1; and + - f. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; + 5. may set the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in clause 8.3.2; and +- NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. +6. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.6 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface in the MCPTT server that RTP media packets with payload are received from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +- NOTE: Reception of unauthorized RTP media packets can only happen if the associated floor participant is in an MCPTT client. If the associated floor participant is a floor control server interface in a non-controlling MCPTT function of an MCPTT group, the unauthorized RTP media packets are handled in the non-controlling MCPTT function. +1. shall request the network media interface to not forward the RTP media packets to the media distributor in the MCPTT server; + 2. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + +- a. shall include the Reject Cause field with the Reject Cause value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall enter the 'U: not permitted but sends media' state as specified in the clause 6.3.5.7.2. + +#### 6.3.5.4.7 Send Floor Queue Position Info message (R: Floor Queue Position Request) + +Upon receiving a Floor Queue Position Request message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send the Floor Queue Position Info message. The Floor Queue Position Info message: + - a. shall include the queue position and floor priority in the Queue Info field; + - b. if a Track Info field is included in the Floor Queue Position Info message, shall include the received Track Info field; + - c. may include the first bit in the subtype of the Floor Queue Position Info message set to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +3. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.8 Receive an implicit floor request (R: Implicit floor request) + +When an ongoing session is upgraded to an emergency group call and when the application and signalling plane indicates that a subsequent SDP offer included the "mc\_implicit\_request" fmtp attribute as specified in clause 14, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall indicate to the floor control server arbitration logic that an implicit floor request is received due to an upgrade to an emergency group call; and +2. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.9 Send Floor Granted message (S: Floor Granted) + +When a Floor Granted message is received from the floor control arbitration logic in the IWF, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in clause 8.3.2; + +NOTE 1: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if the G-bit in the Floor Indicator is set to '1' (Dual floor) shall store an indication that the participant is overriding without revoke; and + +NOTE 2: The G-bit in the Floor Indicator is set to '1' as specified in clause 6.3.6.3.2. + +4. shall enter the state 'U: permitted' as specified in clause 6.3.5.5.2. + +#### 6.3.5.4.10 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control arbitration logic in the IWF, if the G-bit in the Floor Indicator is set to '1' (Dual floor) the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the Floor Taken message to the associated floor participant; + 2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in clause 8.3.2; +- NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. +3. shall store an indication that the participant is listening to media from two sources; and + 4. shall remain in the 'U: not permitted and Floor Taken' state. + +#### 6.3.5.4.11 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +Multi-talker is not supported in the present document. + +### 6.3.5.5 State: 'U: permitted' + +#### 6.3.5.5.1 General + +The floor control interface towards the MCPTT client in the IWF floor control server uses this state when the associated floor participant has been given permission to send media. + +#### 6.3.5.5.2 Enter state 'U: permitted' + +When entering this state, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall set the state for the associated floor participant to 'U: permitted'. + +#### 6.3.5.5.3 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if an indication that the participant is overriding without revoke is stored, + - a. shall forward the Floor Release message to the 'dual floor control operation' state machine of the floor control arbitration logic in the IWF with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; + - b. shall remove the indication that the participant is overriding without revoke; and + - c. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; +3. if an indication that the participant is overridden without revoke is stored, + - a. shall forward the Floor Release message to the general floor control operation state machine of the floor control arbitration logic in the IWF with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; + - b. shall remove the indication that the participant is overridden without revoke; and + +- c. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; and +- 4. if no indication is stored: + - a. shall forward the Floor Release message to the general floor control operation state machine of the floor control arbitration logic in the IWF with the first bit in the subtype of the Floor Release message set to '0' (Acknowledgment is not required), if not already set; and + - b. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.4 Send Floor Idle message (S: Floor Idle) + +Upon receiving the Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. if the G-bit in the Floor Indicator is set to '1' (Dual Floor) and an indication that the participant is overridden without revoke is stored + - a. shall send Floor Idle message to the associated floor participant; + - b. shall remove the indication that a participant is overridden without revoke; and + - c. shall remain in 'U: permitted state'; +- 2. if no indication is stored shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2; and +- 3. if an indication that the participant is overriding without revoke is stored + - a. shall send Floor Idle message to the associated floor participant; + - b. shall remove the indication that a participant is overriding without revoke; and + - c. shall remain in 'U: permitted state'. + +#### 6.3.5.5.5 Send Floor Revoke message (S: Floor Revoke) + +When receiving the Floor Revoke message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. shall forward the Floor Revoke message to the floor participant; +- 2. if the Floor Revoke message includes the Track Info field, shall store the Track Info field; and +- 3. shall enter the state 'U pending Floor Revoke' as specified in the clause 6.3.5.6.2. + +#### 6.3.5.5.6 Receive RTP media packets (R: media) + +Upon receiving an indication from the network media interface in the MCPTT server that RTP media packets with payload are received from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. if an indication that the participant is overriding without revoke is not stored, + - a. shall request the network media interface in the MCPTT server to forward RTP media packets to the media distributor in the MCPTT server. + +#### 6.3.5.5.7 Receive Floor Request message (R: Floor Request) + +Upon receiving a Floor Request message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. shall forward the Floor Request message to the floor control server arbitration logic in the MCPTT server; and +- b. shall instruct the media distributor to act as in clause 6.3.4.4.5. + +2. if an indication that the participant is overriding without revoke is stored, + - a. shall request the network media interface in the MCPTT server to forward RTP media packets to the media distributor in the MCPTT server; and + - b. shall instruct the media distributor to act as in clause 6.3.6.3.5; and +3. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.8 Send RTP Media (S: media) + +When RTP packets are received from the media distributor, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward the RTP packet to the associated floor participant if the indication that the participant is overridden without revoke is stored; +2. shall forward the RTP packet to the associated floor participant if the indication that the participant is overriding without revoke is stored; and +3. shall remain in the 'U: permitted' state. + +#### 6.3.5.5.9 Send Floor Taken message (S: Floor Taken) + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the G-bit in the Floor Indicator set to '1' (Dual Floor), the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send the Floor Taken message to the associated floor participant; +2. shall store an indication that the participant is overridden without revoke; and +3. shall remain in the 'U: permitted' state. + +When receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the G-bit in the Floor Indicator set to '0' (Not dual floor), the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send the Floor Taken message to the associated floor participant; and +2. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2. + +#### 6.3.5.5.10 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +Multi-talker is not supported in the present document. + +#### 6.3.5.6 State: 'U: pending Floor Revoke' + +##### 6.3.5.6.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state during the grace period after sending the Floor Revoke message. + +In this state timer T8 (Floor Revoke) is running. + +##### 6.3.5.6.2 Enter state 'U pending Floor Revoke' + +When entering this state, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall start timer T8 (Floor Revoke); and +2. shall enter the state 'U: pending Floor Revoke'. + +#### 6.3.5.6.3 Timer T8 (media Revoke) expired + +On expiry of timer T8 (Floor Revoke) the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall retransmit the Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include the same Rejection Cause field and the same Floor Indicator field as in the previous sent Floor Revoke message; +2. shall start timer T8 (Floor Revoke); and +3. shall remain in the 'U: pending Floor Revoke' state. + +NOTE: The number of times the IWF floor control server retransmits the Floor Revoke message and the action to take when the IWF floor control server gives up is an implementation option. However, it is recommended that the MCPTT client is disconnected from the MCPTT call when the IWF floor control server gives up. + +#### 6.3.5.6.4 Receive RTP media packets (R: media) + +Upon receiving an RTP media packet with payload from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall forward RTP media packets to the media distributor; and +2. shall remain in the 'U: pending Floor Revoke' state. + +#### 6.3.5.6.5 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if the G-bit in the Floor Indicator is set to '1' (Dual floor): + - a. if the state in the 'general floor control operation' state machine is 'G: Taken': + - i. shall send a Floor Taken message to the associated floor participant. The Floor Taken message: + - A. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field of the permitted MCPTT client if privacy is not requested; and + - B. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - ii. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2; and + - b. if the state in the 'general floor control operation' state machine is 'G: Idle': + - i. shall send a Floor Idle message to the associated floor participant; + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - iii. shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2; and +3. if the G-bit in the Floor Indicator is set to '0': + - a. shall forward the Floor Release message to the floor control server arbitration logic; and + +- b. shall remain in the state 'U: pending Floor Revoke'. + +#### 6.3.5.6.6 Send Floor Idle message (S: Floor Idle) + +Upon receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +NOTE 1: The Floor Idle message is sent when timer T3 (Stop talking grace) expires and when timer T1 (End of RTP media) expires and when there are no queued floor requests. + +- 1. shall send the Floor Idle message to the associated floor participant; +- 2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- 3. shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2. + +#### 6.3.5.6.7 Send Floor Taken message (S: Floor Taken) + +Upon receiving a Floor Taken message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client in the IWF floor control server: + +NOTE 1: The Floor Taken message is sent when timer T3 (Stop talking grace) expires or when timer T1 (End of RTP media) expires and if there are queued floor requests. + +- 1. shall send the Floor Taken message to the associated floor participant; +- 2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE 2: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- 3. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.3.2. + +#### 6.3.5.6.8 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +Multi-talker is not supported in the present document. + +### 6.3.5.7 State 'U: not permitted but sends media' + +#### 6.3.5.7.1 General + +The floor control interface towards the MCPTT client in the floor control server uses this state when it receives RTP media packets from the MCPTT client and the MCPTT client is not permitted to send media. + +Timer T8 (Floor Revoke) is running in this state. + +#### 6.3.5.7.2 Enter state 'U: not permitted but sends media' + +When entering this state, the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. shall start timer T8 (Floor Revoke); and +- 2. shall enter the state 'U: not permitted but sends media'. + +In this state the floor control interface towards the MCPTT client in the IWF floor control server: + +- 1. shall not request the network media interface in the MCPTT server to forward RTP media packets from the MCPTT client to the media distributor in the MCPTT server. + +#### 6.3.5.7.3 Timer T8 (Floor Revoke) expired + +On expiry of timer T8 (Floor Revoke), the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall send a Floor Revoke message to the associated floor participant. The Floor Revoke message: + - a. shall include in the Rejection Cause field the value set to #3 (No permission to send a Media Burst); and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +2. shall restart timer T8 (Floor Revoke); and +3. shall remain in the 'U: not permitted but sends media' state. + +NOTE: The number of times the IWF floor control server retransmits the Floor Revoke message and the action to take when the IWF floor control server gives up is an implementation option. However, the recommended action is that the MCPTT client is disconnected from the MCPTT call. + +#### 6.3.5.7.4 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. if the general state is 'G: Floor Idle', the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send the Floor Idle message. The Floor Idle message: + - i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - b. shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2; and +3. if the general state is 'G: Floor Taken', the floor control interface towards the MCPTT client in the IWF floor control server: + - a. shall send a Floor Taken message. The Floor Taken message: + - i. shall include the granted MCPTT user's MCPTT ID in the Granted Party's Identity field if privacy is not requested; + - ii. if the session is a broadcast group call, shall include the Permission to Request the floor field set to '0'; + - iii. if the session is not a broadcast group call, may include the Permission to Request the floor field set to '1'; + - iv. may include the first bit in the subtype of the Floor Taken message set to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +- v. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + +- c. shall enter the 'U: not permitted and Floor Taken' state as specified in the clause 6.3.5.4.2. + +#### 6.3.5.7.5 Send Floor Taken message (S: Floor Taken) + +Receiving the Floor Taken message from the floor control server arbitration logic in the MCPTT server with the I-bit in the Floor Indicator set to '1' (multi-talker) is not supported in the present document. + +#### 6.3.5.7.6 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +Multi-talker is not supported in the present document. + +#### 6.3.5.8 In any state + +##### 6.3.5.8.1 General + +This clause describes the actions to be taken in all states defined for the basic state diagram with the exception of the 'Start-stop' and 'Releasing' states. + +##### 6.3.5.8.2 Receive MCPTT call release – 1 + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane e.g. when the MCPTT call is going to be released or when the MCPTT client leaves the MCPTT call, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall stop sending floor control messages to the associated floor participant; +2. shall request the network media interface to stop sending RTP media packets towards to the associated MCPTT client; +3. shall ignore any floor control messages received from the associated floor participant; +4. shall request the network media interface to stop forwarding RTP media packets from the associated MCPTT client to the media distributor in the MCPTT server; +5. shall indicate to the floor control server arbitration logic in the MCPTT server that the MCPTT client has started to disconnect from the MCPTT call; and +6. shall enter the 'Releasing' state. + +##### 6.3.5.8.3 Receiving a merging instruction (R: Merge) + +Upon receipt of an instruction to merge with another group due to the group regrouping function, the floor control interface towards the MCPTT client: + +1. shall create an instance of the 'floor participant interface state transition' as specified in clause 6.5.5; +2. shall move information associated with the instance used for 'floor participant interface state transition' to the 'basic floor control operation towards the floor participant' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'basic floor control operation towards the floor participant' state machine associated with this floor participant and this MCPTT call; +4. if the state was 'U: not permitted and Floor Idle', 'U: not permitted Floor Taken', 'U: pending Floor Revoke', 'U: not permitted and initiating' or 'U: not permitted but sends media': + - a. shall enter the 'P: has no permission' state as specified in clause 6.5.5; and + - b. shall perform actions specified in clause 6.5.5.3; and +5. if the state was 'U: permitted': + +- a. shall enter the 'P: has permission' state; and +- b. shall perform actions specified in clause 6.5.5.4. + +### 6.3.5.9 State: 'Releasing' + +#### 6.3.5.9.1 General + +The floor control interface towards the MCPTT client in the IWF floor control server uses this state while waiting for the application and signalling plane to finalize the release of the MCPTT call or finalizing the removal of the MCPTT client from the MCPTT call. + +#### 6.3.5.9.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control interface towards the MCPTT client in the IWF floor control server: + +1. shall request the network media interface to release all resources associated with this MCPTT client for this MCPTT call; and +2. shall enter the 'Start-stop' state and terminate the 'basic floor control operation towards the floor participant' state machine associated with this floor participant and this MCPTT call. + +### 6.3.5.10 State: 'U: not permitted and initiating' + +#### 6.3.5.10.1 General + +The floor control interface towards the MCPTT client uses this state when waiting for the floor control arbitration logic to finalize the initialisation of the state machine to be used for a temporary group session. + +During this state Floor Request messages can be received from the non-controlling MCPTT function. Any Floor Request message received will be added to the queue according to the priority of the floor request determine as described in clause 4.1.1.4. + +#### 6.3.5.10.2 Enter the 'U: not permitted and initiating' state + +The floor control interface towards the MCPTT client: + +1. shall set the state for the associated floor participant to 'U: not permitted and Initiating'. + +#### 6.3.5.10.3 Send Floor Taken message (S: Floor Taken) + +When a Floor Taken message is received from the floor control arbitration logic in the IWF, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Taken messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Taken message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: not permitted and Floor Taken' as specified in clause 6.3.5.4.2. + +#### 6.3.5.10.4 Send Floor Idle message (S: Floor Idle) + +When receiving a Floor Idle message from the floor control server arbitration logic in the MCPTT server, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Idle message to the associated floor participant; + +2. may set the first bit in the subtype of the Floor Idle message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the 'U: not permitted and Floor Idle' state as specified in the clause 6.3.5.3.2. + +#### 6.3.5.10.5 Receive Floor Request message (R: Floor Request) + +Upon receipt of a Floor Request message, the floor control interface towards the MCPTT client: + +1. shall determine the effective priority level as described in clause 4.1.1.4; +2. shall put the Floor Request message in the floor request queue according to the determined effective priority level; +3. if the value in the Track Info field is set to '1' (the floor participant in the MCPTT client supports queueing), shall send a Floor Queue Position Info message to the requesting non-Controlling MCPTT function, The Floor Queue Position Info message: + - a. shall include the queue position and floor priority in the Queue Info field; + - b. shall include the received Track Info field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +4. if the value in the Track Info field is set to '0' (the floor participant in the MCPTT client does not support queueing), shall send the Floor Deny message. The floor Deny message: + +NOTE: A Floor Request from a MCPTT client in a constituent group can be received without the queueing capability if a floor participant in an ongoing constituent MCPTT group request floor while the floor was idle during the merging process. + +- a. shall include in the Reject Cause field the value cause '1' (Another MCPTT client has permission); + - b. shall include the received Track Info field; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +5. shall remain in the 'U: not permitted and initiating' state. + +#### 6.3.5.10.6 Send Floor Granted message (S: Floor Granted) + +When a Floor Granted message is received from the floor control arbitration logic, the floor control interface towards the MCPTT client: + +1. shall forward the Floor Granted messages to the associated floor participant; +2. may set the first bit in the subtype of the Floor Granted message to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. shall enter the state 'U: permitted' as specified in clause 6.3.5.5.2. + +#### 6.3.5.10.7 Receive a Floor Release message (S: Floor Release) + +Upon receiving a Floor Release message from the associated floor participant, the floor control interface towards the MCPTT client: + +1. if the first bit in the subtype of the Floor Release message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '4' (Floor Release); and + - b. shall include the Source field set to '2' (the controlling MCPTT function is the source); +2. shall use the topmost value and the SSRC in the Track Info field of the received Floor Release message to check if the floor participant has a queued floor request and if not, check if there is a floor request in one of the cached application/vnd.3gpp.mcptt-floor-request+xml MIME bodies; +3. shall remove the MCPTT client from the active floor request queue or the cached application/vnd.3gpp.mcptt-floor-request+xml MIME body, if the MCPTT client was in the active floor request queue or in the application/vnd.3gpp.mcptt-floor-request+xml MIME body; and +4. shall remain in the 'U: not permitted and initiating' state. + +#### 6.3.5.10.8 Send Floor Release Multi Talker message (S: Floor Release Multi Talker) + +Multi-talker is not supported in the present document. + +### 6.3.6 Dual floor control + +#### 6.3.6.1 General + +**Editor's Note:** The procedures of the IWF performing the non-controlling role are FFS. + +Dual floor control is used when a floor participant requests floor with a pre-emptive floor priority allowing the floor control in clause 6.3.4 to continue without revoking the floor from the floor participant permitted to send media as specified in 3GPP TS 23.379 [5] clause 10.9.1.3.2.2. + +The floor control server arbitration logic in the IWF floor control server shall behave according to the state diagram and state transitions specified in this clause. + +Figure 6.3.6.1-1 shows the 'dual floor control operation' states (D states) and the state transition diagram. + +![Floor control server state transition diagram for 'dual floor control operation'](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Start-stop + Start-stop --> Releasing : R: MCPTT call release - 2 + Any state --> Releasing : R: MCPTT call release - 1 + Start-stop --> D: Floor Taken : R: Floor Request OR I: Floor grant to IWF floor participant + D: Floor Taken --> Start-stop : T11 (End of RTP dual) expired OR T12 (Stop talking dual) expired OR R: Floor Release OR R: Termination instruction from the floor control arbitration logic OR I: Floor release by IWF floor participant OR I: Call release by IWF floor participant + D: Floor Taken --> D: Floor Taken : R: RTP media OR R: Floor Request + +``` + +The diagram illustrates the state transitions for a 'dual floor control operation' state machine. It features three main states: 'Start-stop', 'Releasing', and 'D: Floor Taken'. Transitions are triggered by specific events or messages, categorized as 'R' (Receive) or 'I' (IWF determined event). A legend defines these categories. The 'Start-stop' state is the initial state. Transitions to 'Releasing' occur from 'Start-stop' (R: MCPTT call release - 2) or 'Any state' (R: MCPTT call release - 1). A transition to 'D: Floor Taken' occurs from 'Start-stop' (R: Floor Request OR I: Floor grant to IWF floor participant). Transitions back to 'Start-stop' from 'D: Floor Taken' occur based on a complex set of conditions including RTP dual expiration, stop talking dual expiration, floor release, termination instructions, or IWF participant releases. A self-loop on 'D: Floor Taken' handles RTP media or floor requests. + +Floor control server state transition diagram for 'dual floor control operation' + +**Figure 6.3.6.1-1: Floor control server state transition diagram for 'dual floor control operation'** + +The floor control arbitration logic in the IWF floor control server shall keep one instance of the 'dual floor control operation' state machine for a floor participant with pre-emptive floor priority where this MCPTT user or user homed in the IWF is allowed to talk without revoking a current speaker with lower floor priority. + +NOTE: Only one media endpoint with this type of pre-emptive floor priority can exist within an MCPTT call. + +The floor participant associated to the 'dual floor control operation' state machine is in the following clauses referred to as the overriding media endpoint. + +If floor control messages or RTP media packets arrive in a state where there is no procedure specified in the following clauses the floor control arbitration logic in the IWF floor control server: + +1. shall discard the floor control message; +2. shall request the media distributor in the IWF to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following clauses. + +### 6.3.6.2 State: 'Start-stop' + +#### 6.3.6.2.1 General + +When a new instance of the 'dual floor control operation' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly, when the media burst is released the state machine shall return to the 'Start-Stop' state or the related MCPTT call is released. + +#### 6.3.6.2.2 Receive Floor Request message with overriding pre-emptive floor priority (R: Floor Request) + +When an MCPTT floor participant that requests the floor with an overriding pre-emptive priority is granted the floor the floor control arbitration logic in the IWF floor control server: + +1. shall create one instance of the 'dual floor control operation' state machine; +2. shall store the SSRC of the floor participant; +3. if a Track Info field is included in the Floor Request message, shall store the received Track Info field associated with the floor control server state transition diagram for 'dual floor control operation', and +- 4 shall enter the state 'D: Floor Taken' as specified in the clause 6.3.6.3.2. + +#### 6.3.6.2.2A Floor Grant to IWF floor participant with overriding pre-emptive floor priority (I: Floor Grant to IWF floor participant) + +When the IWF determines that an IWF floor participant with an overriding pre-emptive priority is to be granted the floor the floor control arbitration logic in the IWF floor control server: + +1. shall create one instance of the 'dual floor control operation' state machine; +2. shall determine an SSRC for the IWF floor participant and shall store the SSRC of the IWF floor participant; and +- 3 shall enter the state 'D: Floor Taken' as specified in the clause 6.3.6.3.2. + +### 6.3.6.3 State: 'D: Floor Taken' + +#### 6.3.6.3.1 General + +The floor control arbitration logic in the IWF floor control server uses this state when it has permitted one floor participant to override a current speaker in an MCPTT call to send media. + +Timer T11 (End of RTP dual) can be running when the IWF floor control server is in this state. + +Timer T12 (Stop talking dual) can be running when the IWF floor control server is in this state. + +#### 6.3.6.3.2 Enter state 'D: Floor Taken' + +When entering this state, the floor control arbitration logic in the IWF floor control server: + +1. if the requesting floor participant is an MCPTT floor participant, shall send a Floor Granted message to the requesting MCPTT floor participant. The Floor Granted message: + - a. shall include the value of the T12 (Stop talking dual) timer in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if a Track Info field associated with the floor control server state transition diagram for 'dual floor control operation' state machine is stored, shall include the stored Track Info field; + - d. shall include the Floor Indicator field with the G-bit set to '1' (Dual floor); + - e. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and + - f. if non-controlling MCPTT functions are involved, shall include the SSRC of the granted floor participant; +2. shall send a Floor Idle message to any non-controlling MCPTT functions involved in the session and to those MCPTT floor participants controlled by the IWF performing the controlling role that will only listen to RTP media from the overriding media endpoint according to local policy. The Floor Idle message: + +NOTE 1: The non-controlling MCPTT function will send the Floor Idle message to those MCPTT floor participants controlled by the non-controlling MCPTT function that will only listen to RTP media from the overriding media endpoint according to local policy when the non-controlling MCPTT function receives the Floor Taken with the G-bit set to '1' (Dual floor) in the Floor Indicator field. + +- i. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - ii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +3. shall send a Floor Taken message to any non-controlling MCPTT functions involved and to MCPTT floor participants controlled by the IWF performing the controlling role that will listen to the RTP media from the overriding media endpoint according to local policy. The Floor Taken message: + +NOTE 2: The media endpoint overridden by the overriding media endpoint is still sending voice (overridden). The list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +- a. shall include the granted floor participant's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; + - b. shall include a Message Sequence Number field with a value increased with 1; + - c. shall include the Floor Indicator field with the G-bit set to '1' (Dual floor); and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +4. shall start the T11 (End of RTP dual) timer; and + 5. shall enter the state 'D: Floor Taken'. + +### 6.3.6.3.3 Timer T11 (End of RTP dual) expired + +On expiry of timer T11 (End of RTP dual), the floor control arbitration logic in the IWF floor control server: + +1. shall stop the T12 (Stop talking dual) timer; if running; +2. shall request the media distributor in the IWF to stop distributing RTP media packets received from the overriding media endpoint to other media endpoints; + +NOTE: If dual floor control is ongoing as described in clause 6.3.6, the list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +3. shall release all resources reserved in the media plane including the instances used for the 'dual floor control operation' state machine and any running timers associated with the state machine; +4. shall send a Floor Idle message to any non-controlling MCPTT functions and to those MCPTT floor participants controlled by the IWF performing the controlling role receiving RTP media from the overriding media endpoint. The Floor Idle message: + - a. shall include a Floor Indicator field with the G-bit set to '1' (Dual floor); + - b. shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +5. if the state in the 'general floor control operation' state machine is 'G: Taken'; + - a. shall send a Floor Taken message to any non-controlling MCPTT functions and to those MCPTT floor participants controlled by the IWF performing the controlling role that only received RTP media from the overriding media endpoint. The Floor Taken message: + +- i. shall include the granted floor participant's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; + - ii. shall include a Message Sequence Number field with a value increased with 1; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 6. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all MCPTT floor participants. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 7. shall enter the 'Start-stop' state. + +#### 6.3.6.3.4 Timer T12 (Stop talking dual) expired + +On expiry of the T12 (Stop talking dual) timer the floor control arbitration logic in the IWF floor control server: + +- 1. shall stop the T11 (End of RTP dual) timer; +- 2. shall request the media distributor in the IWF to stop distributing RTP media packets to other media endpoints; +- 3. if the floor participant is an MCPTT floor participant, shall send the Floor Revoke message to the permitted MCPTT floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #2 (Media burst too long) in the Floor Revoke message sent in clause 6.3.4.5.2; + - b. shall include the Floor Indicator with the G-bit set to '1' (Dual floor); + - c. if a Track Info field associated with the dual floor is stored, shall include the stored Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 4. shall remove the stored Track info field associated with the dual floor; +- 5. if the state in the 'general floor control operation' state machine is 'G: Taken'; + - a. shall send a Floor Taken message to all non-controlling MCPTT functions (if the session is a temporary group session involving non-controlling MCPTT functions) and to those MCPTT floor participants that only received RTP media from the overriding media endpoint. The Floor Taken message: + - i. shall include the granted floor participant's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; and + - ii. shall include a Message Sequence Number field with a value increased with 1; +- 6. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all MCPTT floor participants. The Floor Idle message: + - a. shall include a Message Sequence Number field with a value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 7. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation'; and + +8. shall enter the 'Start-stop' state. + +#### 6.3.6.3.5 Receive RTP media packets (R: media) + +Upon receiving an indication from the media distributor in the IWF that RTP media packets are received from the permitted media endpoint, the floor control arbitration logic in the IWF floor control server: + +1. if the media endpoint is an MCPTT media endpoint, shall start the T12 (Stop talking dual) timer, if not already running; +2. shall restart the T11 (End of RTP dual) timer; +3. shall instruct the media distributor to forward the received RTP media packets to any non-controlling MCPTT functions, to the overridden media endpoint and to those media endpoints receiving RTP media from the overriding media endpoint controlled by the IWF performing the controlling role according to local policy; and + +NOTE 1: The RTP media is sent to the media endpoints subjected to the maximum number of simultaneous transmissions received in one group call for override (N7) as indicated in 3GPP TS 23.379 [5]. + +NOTE 2: The IWF performing the non-controlling role will forward the RTP media packets to media endpoints receiving RTP media from the overriding media endpoint according to local policy in the IWF performing the non-controlling role. + +4. shall remain in the 'D: Floor Taken' state. + +#### 6.3.6.3.6 Receive Floor Release message (R: Floor Release) + +Upon receiving a Floor Release message from the overriding MCPTT media endpoint or upon determining that the floor has been released by an overriding IWF media endpoint, the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor in the IWF to stop distributing RTP media packets received from the overriding media endpoint to other media endpoints; +2. shall stop the T12 (Stop talking dual) timer, if running; +3. shall stop the T11 (End of RTP dual) timer; +4. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation' and any running timers associated with the state machine; +5. if a Floor Release message has been received from an MCPTT media endpoint and if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in clause 8.2.2: + - a. shall send a Floor Ack message. The Floor Ack message: + - i. shall set the Source field to the value '2' (the IWF performing the controlling role is the source); and + - ii. shall set the Message Type field to the value '4' (Floor Release); +6. shall send a Floor Idle message to any non-controlling MCPTT functions, to the overridden participant if it is an MCPTT floor participant and to those MCPTT floor participants controlled by the IWF performing the controlling role receiving RTP media from the overriding media endpoint. The Floor Idle message: + - a. shall include an Floor Indicator field with the G-bit set to '1' (Dual floor); + - b. shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +7. if the state in the 'general floor control operation' state machine is 'G: Taken', + +- a. shall send a Floor Taken message to any non-controlling MCPTT functions and to those MCPTT floor participants that only received RTP media from the overriding media endpoint. The Floor Taken message: + - i. shall include the granted floor participant's MCPTT ID in the Granted Party's Identity field, if privacy is not requested; + - ii. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - iii. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 8. if the state in the 'general floor control operation' state machine is 'G: Idle', shall send a Floor Idle message to all MCPTT floor participants. The Floor Idle message: + - a. shall include a Message Sequence Number field with a Message Sequence Number value increased with 1; and + - b. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 9. shall enter the 'Start-stop' state. + +#### 6.3.6.3.6A IWF Floor Release (I: Floor release by IWF floor participant) + +The procedures in clause 6.3.6.3.6 are followed. + +#### 6.3.6.3.7 Receive Floor request message from permitted MCPTT floor participant (R: Floor Request) + +Upon receiving a Floor Request message from the MCPTT floor participant that has been granted permission to send overriding media, the floor control arbitration logic in the IWF floor control server: + +- 1. shall send a Floor Granted message to the previously granted MCPTT floor participant. The Floor Granted message: + - a. shall include the value of the T12 (Stop talking dual) timer in the Duration field; + - b. shall include the granted priority in the Floor priority field; + - c. if the Floor Request message included a Track Info field, shall include the received Track Info field; and + - d. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; and +- 2. shall remain in the 'D: Floor Taken' state. + +#### 6.3.6.3.8 Permitted MCPTT participant release + +If the IWF floor control server receives an indication from the floor control interface towards the MCPTT client that the overriding MCPTT media endpoint has started to disconnect from the MCPTT call, the floor control arbitration logic in the IWF floor control server: + +- 1. shall request the media distributor in the IWF to stop distributing RTP media packets received from the overriding MCPTT media endpoint to other media endpoints; +- 2. shall send a Floor Idle message to any non-controlling MCPTT functions and to those MCPTT floor participants controlled by the IWF performing the controlling role receiving RTP media from the overriding MCPTT media endpoint. The Floor Idle message: + - a. shall include an Floor Indicator field with the G-bit set to '1' (Dual floor); + - b. shall include a Message Sequence Number field with a value increased with 1; and + +- c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 3. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation' and any running timers associated with the state machine; and +- 4. shall enter the 'Start-stop' state. + +#### 6.3.6.3.8A Permitted IWF participant release (I: Call release by IWF floor participant) + +If the IWF floor control server determines that the overriding IWF media endpoint has started to disconnect from the MCPTT call, the floor control arbitration logic in the IWF floor control server: + +- 1. shall request the media distributor in the IWF to stop distributing RTP media packets received from the overriding IWF media endpoint to other media endpoints; +- 2. shall send a Floor Idle message to any non-controlling MCPTT functions and to those MCPTT floor participants controlled by the IWF performing the controlling role receiving RTP media from the overriding IWF media endpoint. The Floor Idle message: + - a. shall include an Floor Indicator field with the G-bit set to '1' (Dual floor); + - b shall include a Message Sequence Number field with a value increased with 1; and + - c. if a group call is a broadcast group call, a system call, an emergency call, an imminent peril call, or a temporary group session, shall include the Floor Indicator field with appropriate indications; +- 3. shall release all resources reserved in the media plane including the instances used for the Floor control server state transition diagram for 'dual floor control operation' and any running timers associated with the state machine; and +- 4. shall enter the 'Start-stop' state. + +#### 6.3.6.3.9 Receive Terminate (Terminate) + +Upon receiving the termination instruction, the floor control arbitration logic in the IWF floor control server: + +- 1. shall set the value of timer T1 (End of RTP media) to the value of timer T11 (End of RTP dual) and start timer T1, if timer T11 (End of RTP dual) is running; +- 2. shall set the value of timer T2 (Stop talking) to the value of timer T12 (Stop talking dual) and start timer T2, if timer T12 (Stop talking dual) is running; +- 3. shall release all resources reserved in the media plane including the instances used for the dual floor control operation' state machine and stop any running timers associated with the state machine; and +- 4. shall enter the 'Start-stop' state. + +NOTE: The overriding participant continues to have the floor until its current talk burst is terminated. + +#### 6.3.6.4 In any state + +##### 6.3.6.4.1 General + +This clause describes the actions to be taken in all states defined for the general state diagram with the exception of the 'Start-stop' state. + +##### 6.3.6.4.2 Receive MCPTT call release - 1 + +This clause is used by the floor control arbitration logic in the IWF floor control server when an MCPTT call is released. + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane the floor control arbitration logic in the IWF floor control server: + +1. shall request the media distributor in the IWF to stop sending RTP media packets to media endpoints; and +2. shall enter the 'Releasing' state. + +### 6.3.6.5 State: 'Releasing' + +#### 6.3.6.5.1 General + +The floor control arbitration logic in the IWF floor control server uses this state while waiting for the application and signalling plane to finalize the disconnection of an MCPTT call. + +#### 6.3.6.5.2 Receive MCPTT call release - 2 + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor control arbitration logic in the IWF floor control server: + +1. shall release all resources reserved in the media plane including the instances used for the dual floor control operation' state machine and any running timers associated with the state machine; and +2. shall enter the 'Start-stop' state. + +## 6.4 IWF performing the participating role floor control procedures + +### 6.4.1 General + +The IWF performing the participating role performs the procedures in this clause on behalf of each IWF media endpoint. + +### 6.4.2 IWF floor participant procedures at MCPTT session initialization + +#### 6.4.2.1 General + +Based on the negotiations during the call establishment specified in 3GPP TS 29.379 [26], a new instance of a media session shall be created for this call. + +The SIP INVITE request sent by the application and signalling plane: + +1. shall be regarded an implicit floor request when an implicit floor request is negotiated; and +2. shall not be regarded as an implicit floor request in case of a rejoin to an already on-going group call. + +NOTE: The IWF floor participant can negotiate the use of prioritization of the Floor Request message. In that case, the floor participant can request permission to send media at a priority level that is either the same as or lower than the highest priority that was permitted to the participant in the MCPTT call initialization. If a floor participant is authorized for pre-emptive priority in the MCPTT call it is good practise to always request permission to send RTP media packets at a priority level that is lower than pre-emptive priority unless the IWF explicitly needs to pre-empt the current RTP media packets' sender. In any case pre-emptive priority will have no effect for audio cut-in floor control. + +#### 6.4.2.2 MCPTT call initiated, IWF originating + +When a call is initiated as described in 3GPP TS 29.379 [26], the IWF floor participant: + +1. shall create a media session; + +2. if the originating IWF floor participant receives a floor control message before it receives the SIP 200 (OK) response, shall store the floor control message; and + +NOTE: The originating IWF floor participant might receive a floor control message before the SIP 200 (OK) response when initiating, joining or rejoining a call because of processing delays of the SIP 200 (OK) response in the SIP core. + +3. if a floor control message is received after a SIP INVITE request with implicit floor request and before the reception of the SIP 200 (OK), shall act upon the floor control message. + +### 6.4.2.3 MCPTT call established, IWF terminating + +When an MCPTT call is established, the terminating IWF floor participant shall create an instance of a media session. + +NOTE: From an IWF floor participant perspective the MCPTT call is established when the application and signalling plane sends the SIP 200 (OK) response. + +## 6.4.3 IWF floor participant procedures at MCPTT call release + +The MCPTT call release can be initiated by the IWF floor participant or the MCPTT floor control server. The following steps are performed: + +1. The IWF floor participant stops sending floor control messages and stops sending RTP media packets. +2. When the application and signalling plane has determined that the MCPTT call is released, the corresponding instance of the media session is terminated. + +The user plane can initiate release step 1, but the application and signalling plane always initiates release step 2. + +NOTE: A badly formatted RTP packet or floor control message received is ignored by the IWF floor participant. + +## 6.4.4 IWF floor participant floor message handling + +### 6.4.4.1 Receive Floor Idle message + +Upon receiving a Floor Idle message, the IWF floor participant: + +1. if the first bit in the subtype of the Floor Idle message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '5' (Floor Idle); and + - b. shall include the Source field set to '0' (the IWF floor participant is the source). + +### 6.4.4.2 Receive Floor Taken message + +Upon receiving the Floor Taken message, the IWF floor participant: + +1. if the first bit in the subtype of the Floor Taken message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); and + - b. shall include the Source field set to '0' (the IWF floor participant is the source). + +### 6.4.4.3 Receive RTP media packets + +The IWF can expect to receive RTP media packets at any time during a media session except after releasing a media session. + +NOTE: RTP media packets can be received from multiple sources when dual floor control is applied by the floor control server (see 3GPP TS 24.380 [25], clause 6.3.6). The IWF can differentiate between the different sources using the SSRC in the received RTP media packets. How the IWF mixes the different RTP media stream sources is out of scope of the present document. + +#### 6.4.4.4 Send Floor Request message + +Upon deciding to request permission to send media, the IWF floor participant: + +1. shall send the Floor Request message toward the MCPTT floor control server; The Floor Request message: + - a. if a different priority than the normal priority is required, shall include the Floor Priority field with the priority not higher than negotiated with the floor control server as specified in clause 14.3.3; + - b. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; and + - c. shall include the MCPTT ID associated with the requesting LMR user in a User ID field, if privacy is not requested. + +Upon receiving a Floor Granted message from the floor control server or a floor granted indication in a SIP 200 (OK) response in the application and signalling layer, the IWF floor participant: + +1. if the first bit in the subtype of the Floor Granted message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '1' (Floor Granted); and + - b. shall include the Source field set to '0' (the IWF floor participant is the source); +2. may send a Floor Release message at any time, even before sending any media; and +3. shall start encoding and forwarding media to the MCPTT server. + +#### 6.4.4.6 Receive Floor Deny message + +Upon receiving a Floor Deny message, the IWF floor participant: + +1. if the first bit in the subtype of the Floor Deny message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '3' (Floor Deny); and + - b. shall include the Source field set to '0' (the IWF floor participant is the source); and +2. shall not encode and forward voice packets. + +#### 6.4.4.7 Send Floor Release message + +Upon deciding to release permission to send media, the IWF floor participant: + +1. shall send a Floor Release message towards the floor control server; + - a. if the session is a broadcast call and if the session was established as a normal call, shall include the Floor Indicator with the A-bit set to '1' (Normal call); +2. may include the first bit in the subtype of the Floor Release message set to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if the Floor Granted message included the G-bit set to '1' (Dual floor), shall include the Floor Indicator with the G-bit set to '1' (Dual floor). + +#### 6.4.4.8 Receive Floor Queue Position Info message + +Upon receiving a Floor Queue Position Info message, the IWF floor participant: + +1. if the first bit in the subtype of the Floor Queue Position Info message is set to '1' (Acknowledgment is required) as described in clause 8.3.2, shall send a Floor Ack message. The Floor Ack message: + - a. shall include the Message Type field set to '9' (Floor Queue Position Info); and + - b. shall include the Source field set to '0' (the IWF floor participant is the source). + +NOTE: While in the queue, the IWF floor participant can receive RTP Media packets and the IWF floor participant can send and receive floor control messages. + +#### 6.4.4.9 Receive Floor Revoke message + +Upon receiving a Floor Revoke message, the IWF floor participant: + +1. shall discard any remaining buffered RTP media packets and to stop forwarding encoded voice to the MCPTT server; +2. shall send a Floor Release message. In the Floor Release message: + - a. shall include the Floor Indicator with the G-bit set to the value of the G-bit in the Floor Revoke message; and + - b. may set the first bit in the subtype to '1' (Acknowledgment is required) as described in clause 8.3.2. + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +#### 6.4.4.10 Receive MCPTT call release + +Upon receiving an MCPTT call release request from the application and signalling plane when the MCPTT call is going to be released or when the IWF floor participant is leaving the MCPTT call, the IWF floor participant: + +1. shall stop sending floor control messages; and +2. shall stop sending RTP media packets. + +### 6.5 IWF performing the non-controlling role of an MCPTT group + +#### 6.5.4 Floor control server interface procedures + +##### 6.5.4.1 General + +The floor control server interface is stateless with regards to the floor control message received and sent. + +The following subclauses specify what the floor control server interface shall do when receiving a floor control message sent by the controlling MCPTT function or received at the floor participant interface or initiated internally for an IWF media endpoint and how the floor control server controls the media distribution function in the non-controlling MCPTT function. + +**Editor's Note:** Existing clauses 6.3.5 and 6.3.6 should be evaluated for updates now that we support regroup. Search for "non-controlling" in TS 24.380 and TS 29.380. + +##### 6.5.4.2 Receiving a Floor Request message + +Upon receiving a Floor Request message from one floor participant interface, the floor control server interface: + +1. shall + +- a. forward the Floor Request message to the controlling MCPTT function if the controlling function is in the MCPTT system; or +- b. forward to the floor control server in the IWF if the controlling function is in the IWF. + +The Floor Request message: + +- a. shall include all fields included by the floor participant; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; + - c. if a Track Info field is not included, shall include a Track Info field populated as follows: + - i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; + - ii. shall include a value based on the element specified in 3GPP TS 24.481 [12], if value in the element is available, otherwise set the value to "unknown"; and + - iii. shall include the temporary identifier as the first value; and + - d. shall include the MCPTT ID of the requesting floor participant in a User ID field, if privacy is not requested; and +2. if the value of the in the Track Info is '1' (the floor participant in the MCPTT client supports queueing), shall store the outgoing Floor Request message in the passive floor request queue. + +#### 6.5.4.2A IWF sends a Floor Request message + +Upon deciding to request permission to send media when the controlling function is in the MCPTT system, the IWF: + +1. shall send the Floor Request message toward the MCPTT floor control server in the MCPTT system. The Floor Request message: + - a. if a different priority than the normal priority is required, shall include the Floor Priority field with the priority not higher than negotiated with the floor control server as specified in clause 14.3.3; + - b. if the floor request is a broadcast group call, system call, emergency call or an imminent peril call, shall include a Floor Indicator field indicating the relevant call types; and + - c. shall include the MCPTT ID associated with the requesting LMR user in a User ID field, if privacy is not requested. + +NOTE: If the IWF does not know the identity of the LMR user requesting the floor because of privacy settings in the LMR system, the IWF uses its own MCPTT ID + +#### 6.5.4.3 Receive Floor Release message + +Upon receiving a Floor Release message from one floor participant interface, the floor control server interface: + +NOTE: A Floor Release message can be received from the permitted floor participant and from any participant that is queued in the floor control server. + +1. shall forward a Floor Release message to the controlling MCPTT function if the controlling function is in the MCPTT system or to the floor control server state transition diagram for basic floor control operation towards the floor participant in the IWF if the controlling function is in the IWF. The Floor Release message: + - a. shall include all fields included by the floor participant in the Floor Release message; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field as follows: + +- i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; and + - ii. shall include the temporary identifier as the first value; and +2. if a Floor Request message received from this floor participant is in the passive floor request queue, shall remove the floor request from the passive floor request queue. + +#### 6.5.4.3A IWF sends a Floor Release message + +Upon deciding to release permission to send media when the controlling function is in the MCPTT system, the IWF floor participant: + +1. shall send a Floor Release message towards the floor control server in the MCPTT system; + - a. if the session is a broadcast call and if the session was established as a normal call, shall include the Floor Indicator with the A-bit set to '1' (Normal call); +2. may include the first bit in the subtype of the Floor Release message set to '1' (Acknowledgment is required) as described in clause 8.3.2; and + +NOTE: It is an implementation option to handle the receipt of the Floor Ack message and what action to take if the Floor Ack message is not received. + +3. if the Floor Granted message included the G-bit set to '1' (Dual floor), shall include the Floor Indicator with the G-bit set to '1' (Dual floor). + +#### 6.5.4.4 Receive Floor Queue Position Request message + +Upon receiving a Floor Queue Position Request message from one floor participant interface, the floor control server interface: + +1. shall forward the Floor Queue Position Request message to the controlling MCPTT function if the controlling function is in the MCPTT system or to the floor control server state transition diagram for basic floor control operation towards the floor participant in the IWF if the controlling function is in the IWF. The Floor Queue Position Request message: + - a. shall include all fields included by the floor participant; + - b. if a Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field as follows: + - i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; and + - ii. shall include the temporary identifier as the first value. + +#### 6.5.4.4A IWF sends Floor Queue Position Request message + +Upon deciding to request the queue position, when the controlling function is in the MCPTT system, the IWF: + +1. shall send the Floor Ack message towards the floor control server in the MCPTT system. The Floor Ack message: + - a. shall include the Message Type field set to '2' (Floor Taken); + - b. shall include the Source field set to '0' (the floor participant is the source); and + - c. shall include a Track Info field as follows: + - i. shall include the "mc\_queueing" fmtp attribute value negotiated as specified in clause 14 in the value; and + +- ii. shall include the temporary identifier as the first value. + +#### 6.5.4.5 Receive Floor Ack message + +Upon receiving a Floor Ack message from one floor participant interface the floor control server interface: + +1. shall send the Floor Ack message towards the controlling MCPTT function if the controlling function is in the MCPTT system or to the floor control server state transition diagram for basic floor control operation towards the floor participant in the IWF if the controlling function is in the IWF. The Floor Ack message: + - a. shall include all fields included by the floor participant in the Floor Ack message; + - b. if Track Info field is included, shall include the temporary identifier at the end of the value item; and + - c. if a Track Info field is not included, shall include a Track Info field with temporary identifier as the first . + +#### 6.5.4.5A IWF sends Floor Ack message + +Upon deciding to send a Floor Ack message, when the controlling function is in the MCPTT system, the IWF: + +1. shall send the Floor Ack message towards the floor control server in the MCPTT system. The Floor Ack message shall include a Track Info field as follows: + - a. shall include the temporary identifier as the first value. + +#### 6.5.4.6 Receive Floor Granted message + +Upon receiving a Floor Granted message sent from the controlling MCPTT function, the floor control server interface: + +1. shall send the Floor Granted to the floor participant interface identified by the value at the end of the Track Info field. The Floor Granted message: + - a. shall include the fields as received with the following exceptions: + - i. if the Track Info field only contains one value, shall remove the Track Info field from the outgoing Floor Granted message; and + - ii. if the Track Info field contains more than one value, shall remove the last value from the Track Info field from the outgoing Floor Granted message; and + - b. if the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '1' (Dual floor), shall store the SSRC of granted floor participant and associate the stored value with dual floor; +2. if: + - a. the SSRC of the granted floor participant associated with dual floor is not stored, shall send a Floor Taken message populated as specified in step d. below to all participant interfaces with the exception of the floor participant interface to which the Floor Granted message is sent; + - b. the SSRC of the granted floor participant associated with dual floor is stored and if the Floor Indicator field is not included in the Floor Granted message or if the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '0' (Not dual floor), shall send a Floor Taken message populated as specified in step d. below to all participant interfaces with the exception of: + - i. the floor participant interface to which the Floor Granted message is sent; and + - ii. the floor participants only listening to the overriding floor participant; + - c. the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '1' (Dual floor): + - i. shall send a Floor Taken message populated as specified in step d. below to floor participants that will listen to the RTP media from the overriding MCPTT client according to local policy; + +NOTE 1: The floor participant overridden by the overriding floor participant is still sending voice (overridden). The list of floor participants that receive the overriding, overridden, or both transmissions is based on configuration. + +d. The Floor Taken message: + +- i. shall include the granted user's MCPTT ID in the Granted Party's Identity field if privacy is not requested by the granted floor participant when the floor participant was invited to the session; + +NOTE 2: The privacy request was stored for each invited floor participant when the floor participant accepted the invitation as specified in subclause 6.5.2. + +- ii. shall include in the Message Sequence Number field the local value increased with 1; +- iii. shall include the Permission to Request Floor field to '0', if the group call is a broadcast group call; +- iv. may include the Permission to Request the Floor field set to '1', if the group call is not a broadcast group call; and +- v. shall set the first bit in the subtype of the Floor Taken message to '0' (acknowledgement is not required); and + +NOTE 3: A Floor Taken message sent to all participants does not require acknowledgement. + +e. if the Floor Indicator field was included in the Floor Granted message, shall include the received Floor Indicator field; and + +3. if the Floor Request message received from the floor participant is in the passive floor request queue, shall remove the floor request from the passive floor request queue; and + +4 if the Floor Indicator field is included in the Floor Granted message and the G-bit is set to '1' (Dual floor), shall send a Floor Idle message to those floor participants that will only listen to RTP media from the overriding MCPTT client. The Floor Idle message: + +- a. shall include the Floor Indicator field as received in the Floor Granted message with the G-bit set to '0' (Not dual floor); and +- b. shall include in the Message Sequence Number field the local value increased with 1. + +#### 6.5.4.6A IWF grants floor + +Upon deciding to grant floor, where the controlling function is in the IWF, the IWF floor control server interface: + +**Editor's Note:** Need to create a grant message for internally generated requests, need to also consider floor requests coming from IWF CF that originated in MCPTT, how do those make it here? Does IWF CF call this nCF? + +**Editor's note:** Need to add procedures for clauses 6.5.4.7 thru 6.5.4.16. + +#### 6.5.4.17 Receive Floor Release Multi Talker message + +Upon receiving a Floor Release Multi Talker message sent from the controlling MCPTT function, the IWF floor control server interface shall ignore the Floor Release Multi Talker message. + +NOTE: The multi-taker feature is not supported in the present document. + +### 6.5.5 Floor participant interface procedures + +#### 6.5.5.1 General + +The floor participant interface toward the MCPTT client shall behave according to the state diagram and state transitions specified in this clause. + +Figure 6.5.5.1-1 shows the general floor control operation states (P states) and the state transition diagram. + +![State transition diagram for the floor participant interface toward the MCPTT client. The diagram shows four states: 'Releasing', 'Start-stop', 'P: has permission', and 'P: has no permission'. Transitions are triggered by specific messages or events.](5bba23cc120ad806779f82df1c01bebf_img.jpg) + +``` + +stateDiagram-v2 + [*] --> Releasing + Releasing --> Start-stop : R: MCPTT call release - 2 + Releasing --> Any state : R: MCPTT call release - 1 + Start-stop --> P: has permission : R: Split + Start-stop --> P: has no permission : Participant invited to session + P: has permission --> Start-stop : R: Split + P: has permission --> P: has no permission : R: Floor Idle OR R: Floor Taken + P: has no permission --> Start-stop : R: Split + P: has no permission --> P: has permission : R: Floor Granted + P: has permission --> [*] : R: RTP media OR R: Floor Release OR R: Floor Ack OR R: Floor Revoke OR R: Floor Taken OR R: Floor Release Multi-talker + P: has no permission --> [*] : R: Floor Idle OR R: Floor Taken OR R: Floor Request OR R: Floor Deny OR R: Floor Queue Position Info OR R: Floor Queue Position Request OR R: RTP media OR R: Floor Release OR R: Floor Release Multi-talker + Any state --> Releasing : R: Floor Ack + +``` + +The diagram illustrates the state transitions for the floor participant interface. It consists of four main states: 'Releasing', 'Start-stop', 'P: has permission', and 'P: has no permission'. Transitions are triggered by specific messages or events. The 'Releasing' state is the initial state, reached from an initial state. It transitions to 'Start-stop' on 'R: MCPTT call release - 2' and to 'Any state' on 'R: MCPTT call release - 1'. 'Start-stop' transitions to 'P: has permission' on 'R: Split' and to 'P: has no permission' on 'Participant invited to session'. 'P: has permission' transitions to 'Start-stop' on 'R: Split', to 'P: has no permission' on 'R: Floor Idle OR R: Floor Taken', and to the final state on a set of messages including 'R: RTP media OR R: Floor Release OR R: Floor Ack OR R: Floor Revoke OR R: Floor Taken OR R: Floor Release Multi-talker'. 'P: has no permission' transitions to 'Start-stop' on 'R: Split', to 'P: has permission' on 'R: Floor Granted', and to the final state on a set of messages including 'R: Floor Idle OR R: Floor Taken OR R: Floor Request OR R: Floor Deny OR R: Floor Queue Position Info OR R: Floor Queue Position Request OR R: RTP media OR R: Floor Release OR R: Floor Release Multi-talker'. 'Any state' transitions to 'Releasing' on 'R: Floor Ack'. + +State transition diagram for the floor participant interface toward the MCPTT client. The diagram shows four states: 'Releasing', 'Start-stop', 'P: has permission', and 'P: has no permission'. Transitions are triggered by specific messages or events. + +**Figure 6.5.5.1-1: The 'floor participant interface toward the MCPTT client state transition' state diagram** + +The floor participant interface toward the MCPTT client shall keep one instance of the 'floor participant interface toward the MCPTT client state transition' state machine per MCPTT client in a session. The interface and procedures toward IWF media endpoints are out of scope of the present document. + +The floor participant associated to the 'floor participant interface toward the MCPTT client state transition' state machine is in the following clauses referred to as the MCPTT floor participant. + +If floor control messages or RTP media packets arrives in a state where there is no procedure specified in the following clauses the floor participant interface toward the MCPTT client: + +1. shall discard the floor control message; +2. shall request the network media interface to discard any received RTP media packet; and +3. shall remain in the current state. + +State details are explained in the following clauses. + +### 6.5.5.2 State: 'Start-Stop' + +#### 6.5.5.2.1 General + +When a new instance of the 'Floor participant interface toward the MCPTT client state transition' state machine is initiated, before any floor control related input is applied, the state machine is in 'Start-stop' state. Similarly, when the session is released the state machine shall return to the 'Start-stop' state. + +#### 6.5.5.2.2 Participant invited to session + +When the floor participant interface toward the MCPTT client receives an indication from the floor control server interface that an MCPTT client has accepted the invitation to a session (i.e. when the SIP 200 (OK) response to the initial SIP INVITE request is received as specified in 3GPP TS 24.379 [2]) , the floor participant interface toward the MCPTT client: + +1. shall enter the 'P: has no permission' state. + +### 6.5.5.3 State: 'P: has no permission' + +#### 6.5.5.3.1 General + +The floor participant interface toward the MCPTT client uses this state when the MCPTT floor participant is not permitted to send media. + +#### 6.5.5.3.2 Receive Floor Idle message (R: Floor Idle) + +When the floor participant interface toward the MCPTT client receives a Floor Idle message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Idle message to the MCPTT floor participant; +2. if the first bit in the subtype of the Floor Idle message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, shall store an indication that a Floor Ack message to a Floor Idle messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.3 Receive Floor Taken message (R: Floor Taken) + +When the floor participant interface toward the MCPTT client receives a Floor Taken message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Taken message to the MCPTT floor participant; +2. if the first bit in the subtype of the Floor Taken message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, shall store an indication that a Floor Ack message to a Floor Taken messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.4 Receive Floor Request message (R: Floor Request) + +When the floor participant interface toward the MCPTT client receives a Floor Request message from the MCPTT floor participant, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Request message to the floor control server interface; and +2. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.5 Receive Floor Granted message (R: Floor Granted) + +When the floor participant interface toward the MCPTT client receives a Floor Granted message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Granted message to the MCPTT floor participant; +2. if the first bit in the subtype of the Floor Granted message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, shall store an indication that a Floor Ack message to a Floor Granted messages is expected; and +3. shall enter the 'P: has permission' state. + +#### 6.5.5.3.6 Receive Floor Deny message (R: Floor Deny) + +When the floor participant interface toward the MCPTT client receives a Floor Deny message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Deny message to the MCPTT floor participant toward the MCPTT client; +2. if the first bit in the subtype of the Floor Deny message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, shall store an indication that a Floor Ack message to a Floor Deny messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.7 Receive Floor Queue Position Info message (R: Floor Queue Position Info) + +When the floor participant interface toward the MCPTT client receives a Floor Queue Position Info message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Queue Position Info message to the MCPTT floor participant; +2. if the first bit in the subtype of the Floor Queue Position Info message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, shall store an indication that a Floor Ack message to a Floor Queue Position Info messages is expected; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.8 Receive Floor Queue Position Request message (R: Floor Queue Position Request) + +When the floor participant interface toward the MCPTT client receives a Floor Queue Position Request message from the MCPTT floor participant, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Queue Position Request message to the floor control server interface; and +2. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.9 Receive RTP media packets (R: RTP media) + +When the floor participant interface toward the MCPTT client receives an indication from the network media interface that RTP media packets are received from the media distributor, the floor participant interface toward the MCPTT client: + +1. shall instruct the network media interface to send the received RTP media packets towards the MCPTT client; and +2. shall remain in the 'P: has no permission' state. + +When the floor participant interface toward the MCPTT client receives an indication from the network media interface that RTP media packets are received from the MCPTT client, the floor participant interface toward the MCPTT client: + +1. shall send a Floor Revoke message to the MCPTT floor participant. The Floor Revoke message: + - a. shall include the Reject Cause field with the value set to #3 (No permission to send a Media Burst); +2. shall store that a Floor Release message is expected from the MCPTT floor participant; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.10 Receive Floor Release message (R: Floor Release) + +When the floor participant interface toward the MCPTT client receives a Floor Release message from the MCPTT floor participant, the floor participant interface toward the MCPTT client: + +1. if a Floor Release message is not expected from the MCPTT floor participant: + - a. if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in clause 8.2.2, based on local policy: + - i. shall send a Floor Ack message to the MCPTT floor participant and set the first bit in the subtype of the Floor Release message to '0' (acknowledgement is not required) in the outgoing Floor Release message; or + - ii. wait for the Floor Ack from the floor control server; and +2. if a Floor Release message is expected from the MCPTT floor participant: + - a. if the first bit in the subtype of the Floor Release message is set to '1' (acknowledgement is required) as specified in clause 8.2.2: + - i. shall send a Floor Ack message to the MCPTT floor participant; and + - b. shall remove that a Floor Release message is expected from the floor participant; and +3. shall remain in the 'P: has no permission' state. + +#### 6.5.5.3.11 Receive split instruction (R: Split) + +Upon receiving an instruction to split the ongoing MCPTT call, to the floor participant interface toward the MCPTT client: + +1. shall create a new instance of the 'basic floor control operation towards the floor participant' state machine; +2. shall move information associated with the instance used for 'floor participant interface toward the MCPTT client state transition' to the 'basic floor control operation towards the floor participant' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this MCPTT floor participant and this session; +4. if the state in 'general floor control operation' state machine is 'G: Floor Idle' state; shall enter the 'U: not permitted and Floor Idle' state as specified in clause 6.3.5.3.2; and +5. if the state in 'general floor control operation' state machine is 'G: Floor Taken' state; shall enter the 'U: not permitted and Floor Taken' state as specified in clause 6.3.5.4.2. + +#### 6.5.5.3.12 Receive Floor Release Multi Talker message (R: Floor Release Multi-talker) + +When the floor participant interface toward the MCPTT client receives a Floor Release Multi Talker message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall remain in the 'P: has no permission' state. + +NOTE: The multi-talker feature is not supported in the present document. + +#### 6.5.5.4 State: 'P: has permission' + +##### 6.5.5.4.1 General + +The floor participant interface toward the MCPTT client uses this state when the floor participant has permission to send media + +##### 6.5.5.4.2 Receive RTP media packets + +When the floor participant interface toward the MCPTT client receives an indication from the network media interface that RTP media packets are received from the MCPTT client, the floor participant interface toward the MCPTT client: + +1. shall instruct the media interface to forward received RTP media packets towards the media distributor; and +2. shall remain in the 'P: has permission' state. + +##### 6.5.5.4.3 Receive Floor Release message (R: Floor Release) + +When the floor participant interface toward the MCPTT client receives a Floor Release message from the floor participant, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Release message to the floor control server interface; and +3. shall remain in the 'P: has permission' state. + +##### 6.5.5.4.4 Receive Floor Ack message (R: Floor Ack) + +When the floor participant interface toward the MCPTT client receives a Floor Ack message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Ack message to the floor participant; and +2. shall remain in the 'P: has permission' state. + +##### 6.5.5.4.5 Receive Floor Idle message (R: Floor Idle) + +When the floor participant interface toward the MCPTT client receives a Floor Idle message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Idle message to the floor participant; +2. if the first bit in the subtype of the Floor Idle message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Idle messages is expected; and +3. shall enter the 'P: has no permission' state. + +##### 6.5.5.4.6 Receive Floor Taken message (R: Floor Taken) + +When the floor participant interface toward the MCPTT client receives a Floor Taken message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Taken message to the floor participant; +2. if the first bit in the subtype of the Floor Taken message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Taken messages is expected; and +3. shall enter the 'P: has no permission' state. + +##### 6.5.5.4.7 Receive Floor Revoke message (R: Floor Revoke) + +When the floor participant interface toward the MCPTT client receives a Floor Revoke message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Revoke message to the MCPTT floor participant; +2. if the first bit in the subtype of the Floor Revoke message is set to '1' (acknowledgement is required), shall store an indication that a Floor Ack message to a Floor Revoke messages is expected; and +3. shall remain in the 'P: has permission' state. + +#### 6.5.5.4.8 Receive split instruction (R: Split) + +Upon receiving an instruction to split the ongoing MCPTT call, the floor participant interface toward the MCPTT client: + +1. shall create a new instance of the 'basic floor control operation towards the floor participant' state machine as specified in clause 6.3.5; +2. shall move information associated with the instance used for 'floor participant interface toward the MCPTT client state transition' to the 'basic floor control operation towards the floor participant' state machine; + +NOTE: Which information that needs to be moved is an implementation option. + +3. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this MCPTT floor participant and this session; and +4. shall enter the 'U: permitted' state as specified in clause 6.3.5.5.2. + +#### 6.5.5.4.9 Receive Floor Release Multi Talker message (R: Floor Release Multi-talker) + +When the floor participant interface toward the MCPTT client receives a Floor Release Multi Talker message from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall remain in the 'P: has permission' state. + +NOTE: The multi-talker feature is not supported in the present document. + +#### 6.5.5.5 In any state + +##### 6.5.5.5.1 General + +This clause describes the actions to be taken in all states defined for the 'floor participant state transition' diagram with the exception of the 'Start-stop' and 'Releasing' states. + +##### 6.5.5.5.2 Receive Floor Ack message (R: Floor Ack) + +If a Floor Ack message is received from the MCPTT floor participant, the floor participant interface toward the MCPTT client: + +1. if an indication exists that a Floor Ack message is expected for the message in the Message Type field; + - a. shall forward the Floor Ack message to the floor control server interface; and + - b. shall remove the indication that a Floor Ack message is expected for the message in the Message Type field; and + +NOTE: It is an implementation option what action to take if an indication exists that a Floor Ack message is expected for the message in the Message Type field, but the Floor Ack message is not received + +2. shall remain in the current state. + +If a Floor Ack message is received from the floor control server interface, the floor participant interface toward the MCPTT client: + +1. shall send the Floor Ack message to the MCPTT floor participant; and +2. shall remain in the current state. + +#### 6.5.5.5.3 MCPTT session release step 1 (MCPTT call release - 1) + +Upon receiving an MCPTT call release step 1 request from the application and signalling plane e.g. when the session is going to be released or when the MCPTT client leaves the session, the floor participant interface toward the MCPTT client: + +1. shall stop sending floor control messages to the MCPTT floor participant; +2. shall request the network media interface to stop sending RTP media packets towards to the MCPTT client; +3. shall ignore any floor control messages received from the MCPTT floor participant; +4. shall request the network media interface to stop forwarding RTP media packets from the MCPTT client to the media distributor; +5. shall indicate to the floor control server interface that the MCPTT client has started to disconnect from the session; and +6. shall enter the 'P: Releasing' state. + +#### 6.5.5.6 State: 'P: Releasing' + +##### 6.5.5.6.1 General + +The floor participant interface toward the MCPTT client uses this state while waiting for the application and signalling plane to finalize the release of the session or finalizing the removal of the MCPTT client from the session. + +##### 6.5.5.6.2 MCPTT session release step 2 (MCPTT call release - 2) + +Upon receiving an MCPTT call release step 2 request from the application and signalling plane, the floor participant interface toward the MCPTT client: + +1. shall request the network media interface to release all resources associated with this MCPTT client for this MCPTT call; and +2. shall enter the 'Start-stop' state and terminate the 'floor participant state transition' state machine associated with this MCPTT floor participant and this session. + +--- + +## 7 Off-network floor control + +Off-network floor control is not applicable to an IWF. + +--- + +## 8 Coding + +### 8.1 Introduction + +The message and field formats specified in 3GPP TS 24.380 [25] clause 8.1 shall be used. + +### 8.2 Floor control + +The procedures specified in 3GPP TS 24.380 [25] clause 8.2 shall be used with the following clarification. + +The field formats specified in 3GPP TS 24.380 [25] clause 8.2 shall be supported except for fields and field values used for the following features: + +- multi-talker; +- ambient listening; and + +- functional alias. + +The User ID field of the Floor Request message defined in 3GPP TS 24.380 [25] clause 8.2.4 is also used in Floor Request messages sent by an IWF to an MCPTT server. + +## 8.3 Pre-established session call control + +Pre-established session call control is not applicable to the IWF. + +## 8.4 MBMS subchannel control + +MBMS subchannel control is not applicable to the IWF. + +## 8.5 MBMS notifications + +MBMS notifications are not applicable to the IWF. + +--- + +# 9 Call setup control over pre-established session + +Call setup control over a pre-established session is not applicable to the IWF. + +--- + +# 10 MBMS procedures + +MBMS procedures are not applicable to the IWF. + +--- + +# 11 Configurable parameters + +## 11.1 Timers + +## 11.2 Counters + +--- + +# 12 Extensions within the present document + +No extensions are defined in the present document. + +The IWF shall support the session description types defined in 3GPP TS 24.380 [25] clause 12.1. + +--- + +# 13 Media plane security + +## 13.1 General + +Media plane security provides integrity and confidentiality protection of individual media streams and media plane control messages in MCPTT sessions. + +The media plane security is based on the 3GPP MCPTT security solution including key management and end-to-end media and floor control messages protection as defined in 3GPP TS 33.180 [18]. + +Various keys and associated key identifiers protect: + +1. RTP transported media; +2. RTCP transported media control messages (i.e. RTCP SR packets, RTCP RR packets, RTCP SDES packets); and +3. RTCP APP transported floor control messages. + +In an on-network group call of an MCPTT group which is not a constituent MCPTT group of a temporary MCPTT group: + +1. if protection of media is negotiated, the GMK and the GMK-ID of the MCPTT group protect the media sent and received by MCPTT clients and users homed in the IWF; +2. if protection of floor control messages between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the floor control messages sent and received between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function; and +3. if protection of media control messages between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the media control messages sent and received between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function. + +In an on-network group call of an MCPTT group which is a constituent MCPTT group of a temporary MCPTT group: + +1. if protection of media is negotiated, the GMK and the GMK-ID of the temporary MCPTT group protect the media sent and received by an MCPTT client and a user homed in the IWF; +2. if protection of floor control messages between the IWF performing the participating role and the non-controlling MCPTT function or between the IWF performing the non-controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the floor control messages sent and received between the IWF performing the participating role and the non-controlling MCPTT function or between the IWF performing the non-controlling role and participating MCPTT function; +3. if protection of floor control messages between the IWF performing the non-controlling role and the controlling MCPTT function or between the IWF performing the controlling role and the non-controlling MCPTT function is negotiated, the SPK and the SPK-ID protect the floor control messages sent and received between the IWF performing the non-controlling role and the controlling MCPTT function or between the IWF performing the controlling role and the non-controlling MCPTT function; +4. if protection of media control messages between the IWF performing the participating role and the non-controlling MCPTT function or between the IWF performing the non-controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the media control messages sent and received between the IWF performing the participating role and the non-controlling MCPTT function or between the IWF performing the non-controlling role and the participating MCPTT function; and +5. if protection of media control messages between the IWF performing the non-controlling role and the controlling MCPTT function or between the IWF performing the controlling role and the non-controlling MCPTT function is negotiated, the SPK and the SPK-ID protect the media control messages sent and received between the IWF performing the non-controlling role and the controlling MCPTT function or between the IWF performing the controlling role and the non-controlling MCPTT function. + +In an on-network private call: + +1. if protection of media is negotiated, the PCK and the PCK-ID protect media sent and received by the MCPTT client and the user homed in the IWF; +2. if protection of floor control messages between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the floor control messages sent and received between the IWF + +performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function; and + +3. if protection of media control messages between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function is negotiated, the SPK and the SPK-ID protect the media control messages sent and received between the IWF performing the participating role and the controlling MCPTT function or between the IWF performing the controlling role and the participating MCPTT function. + +The GMK and the GMK-ID are distributed to the MCPTT clients using the group document subscription and notification procedure specified in 3GPP TS 24.481 [12]. + +The GMK and the GMK-ID are distributed to the IWF by the MCPTT GMS per the procedures specified in 3GPP TS 24.481 [12] for distribution of the GMK and GMK-ID to an MCPTT server. + +How the GMK and the GMK-ID are distributed to floor participants homed in the IWF is out of scope of the present document. + +The SPK and the SPK-ID are configured in the IWF for all the roles it performs. + +If a private call that passes through the IWF is initiated by an MCPTT client, the PCK and the PCK-ID are generated by the MCPTT client initiating the private call and provided to the IWF using SIP signalling according to 3GPP TS 24.379 [2], using the Connect message described in clause 8.3.4. + +If a private call that passes through the IWF is initiated by a user homed in the IWF, the PCK and the PCK-ID are generated by the IWF and provided to the MCPTT client receiving the private call using SIP signalling according to 3GPP TS 24.379 [2], using the Connect message described in clause 8.3.4. + +NOTE: The distribution and provisioning of LMR keys by the LMR system to entities in the MCPTT system is out of scope. + +## 13.2 Derivation of SRTP/SRTCP master keys + +Each key (i.e. GMK, PCK, SPK) and its associated key identifier (i.e. GMK-ID, PCK-ID, SPK-ID) described in clause 13.1 are used to derive SRTP-MK, SRTP-MS and SRTP-MKI. + +SRTP-MK, SRTP-MS and SRTP-MKI are used in encryption of media or floor control messages in SRTP as specified in IETF RFC 3711 [16] and 3GPP TS 33.180 [18]. + +## 13.3 Media plane encryption and decryption + +### 13.3.1 General + +Void. + +### 13.3.2 The IWF performing the participating role + +The IWF performing the participating role: + +1. if protection of media is negotiated, shall be transparent to RTP media streams and shall forward encrypted RTP media streams without decrypting the payload; +2. if protection of floor control messages between the IWF performing the participating role and the controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the participating role: + - A) shall encrypt floor control messages sent to the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + +- B) shall decrypt floor control messages received from the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; +- 3. if protection of floor control messages between the IWF performing the participating role and the non-controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the participating role: + - A) shall encrypt floor control messages sent to the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt floor control messages received from the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; + - 4. if protection of media control messages between the IWF performing the participating role and the controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the participating role: + - A) shall encrypt media control messages sent to the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt media control messages received from the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - 5. if protection of media control messages between the IWF performing the participating role and the non-controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the participating role: + - A) shall encrypt media control messages sent to the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt media control messages received from the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2. + +### 13.3.3 The IWF media endpoint + +The IWF media endpoint: + +- 1. in an on-network group call of an MCPTT group which is not a constituent MCPTT group of a temporary MCPTT group: + - A) if protection of media is negotiated and the GMK and the GMK-ID of the MCPTT group were received using the group document subscription and notification procedure specified in 3GPP TS 24.481 [12] for the MCPTT group: + - i) shall encrypt sent media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the GMK and GMK-ID as specified in clause 13.2; and + - ii) shall decrypt received media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the GMK and GMK-ID as specified in clause 13.2; +- 2. in an on-network group call of an MCPTT group which is a constituent MCPTT group of a temporary MCPTT group: + - A) if protection of media is negotiated and the GMK and the GMK-ID of the temporary MCPTT group were received using the group document subscription and notification procedure specified in 3GPP TS 24.481 [12] for the constituent MCPTT group: + +- i) shall encrypt sent media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the GMK and GMK-ID of the temporary MCPTT group as specified in clause 13.2; and + - ii) shall decrypt received media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the GMK and GMK-ID of the temporary MCPTT group as specified in clause 13.2; and +3. in an on-network private call: +- A) if: + - i) protection of media is negotiated in an originating call and the PCK and the PCK-ID were sent to the remote MCPTT client using SIP signalling according to 3GPP TS 24.379 [2]; or + - ii) protection of media is negotiated in a terminating call and the PCK and the PCK-ID were received from the remote MCPTT client using SIP signalling according to 3GPP TS 24.379 [2]; + +then: + + - i) shall encrypt sent media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the PCK and PCK-ID as specified in clause 13.2; and + - ii) shall decrypt received media according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the PCK and PCK-ID as specified in clause 13.2. + +### 13.3.4 The IWF performing the controlling role + +The IWF performing the controlling role: + +- 1. if protection of media is negotiated, shall be transparent to RTP media streams and shall forward encrypted RTP media streams without decrypting the payload; +- 2. in an on-network group call of an MCPTT group which is not a constituent MCPTT group of a temporary MCPTT group: + - A) if protection of floor control messages between the IWF performing the controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt floor control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt floor control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) if protection of media control messages between the IWF performing the controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt media control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt media control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; +- 3. in an on-network group call of an MCPTT group which is a constituent MCPTT group of a temporary MCPTT group: + +- A) if protection of floor control messages between the IWF performing the controlling role and the non-controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt floor control messages sent to the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt floor control messages received from the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) if protection of media control messages between the IWF performing the controlling role and the non-controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt media control messages sent to the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt media control messages received from the non-controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and +4. in an on-network private call: +- A) if protection of floor control messages between the IWF performing the controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt floor control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt floor control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) if protection of media control messages between the IWF performing the controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the controlling role: + - i) shall encrypt media control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - ii) shall decrypt media control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2. + +### 13.3.5 The IWF performing the non-controlling role + +The IWF performing the non-controlling role: + +- 1. if protection of media is negotiated, shall be transparent to RTP media streams and shall forward encrypted RTP media streams without decrypting the payload; +- 2. if protection of floor control messages between the IWF performing the non-controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the non-controlling role: + - A) shall encrypt floor control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + +- B) shall decrypt floor control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; +- 3. if protection of floor control messages between the IWF performing the non-controlling role and the controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the non-controlling role: + - A) shall encrypt floor control messages sent to the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt floor control messages received from the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; +- 4) if protection of media control messages between the IWF performing the non-controlling role and the participating MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the non-controlling role: + - A) shall encrypt media control messages sent to the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt media control messages received from the participating MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and +- 5) if protection of media control messages between the IWF performing the non-controlling role and the controlling MCPTT function is negotiated and the SPK and the SPK-ID are configured in the IWF, then the IWF performing the non-controlling role: + - A) shall encrypt media control messages sent to the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2; and + - B) shall decrypt media control messages received from the controlling MCPTT function according to IETF RFC 3711 [16] and 3GPP TS 33.180 [18] using SRTP-MK, SRTP-MS and SRTP-MKI generated using the SPK and SPK-ID as specified in clause 13.2. + +--- + +## 14 SDP offer/ answer procedures + +### 14.1 General + +The IWF shall operate per 3GPP TS 24.380 [25] clause 14.1. + +### 14.2 Generating an SDP offer + +The IWF shall generate an SDP offer per 3GPP TS 24.380 [25] clause 14.2. + +### 14.3 Generating the SDP answer + +The IWF shall generate an SDP answer per 3GPP TS 24.380 [25] clause 14.3. + +### 14.4 Offeror processing of the SDP answer + +The IWF shall process an SDP answer per 3GPP TS 24.380 [25] clause 14.4. + +## 14.5 Modifying the media plane control channel + +The IWF shall support modification of the media plane control channel per 3GPP TS 24.380 [25] clause 14.5. + +## 14.6 The use of SDP offer / answer procedures in off-network mode + +The use of SDP offer / answer procedures in off-network mode is not applicable to the IWF. + +## Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-05 | | | | | | Initial version | 0.0.0 | +| 2019-05 | | | | | | Contains agreed P-CRs from CT1#117: C1-193602
C1-193273, C1-193644, C1-193645, C1-193647, C1-193648,
C1-193650, C1-193651, C1-193653, C1-193656, C1-193657,
C1-193678, C1-193679, C1-193681 | 0.1.0 | +| 2019-08 | | | | | | Contains agreed P-CRs from CT1#119: C1-194210, C1-194212,
C1-194213, C1-194805, C1-194806, C1-194807, C1-194808,
C1-194809, C1-194811, C1-194812 | 0.2.0 | +| 2019-09 | CT#85 | CP-192084 | | | | Presentation for information at TSG CT | 1.0.0 | +| 2019-10 | | | | | | Contains agreed P-CRs from CT1#120: C1-196629, C1-196818,
C1-196819 | 1.1.0 | +| 2019-12 | CT#86 | CP-193162 | | | | Presentation for approval at TSG CT | 2.0.0 | +| 2019-12 | CT#86 | CP-193297 | | | | A title updated | 2.0.1 | +| 2019-12 | CT#86 | | | | | Version 16.0.0 created after approval | 16.0.0 | +| 2021-03 | CT#91e | CP-210123 | 0001 | | F | Add missing 13.3 heading | 17.0.0 | +| 2023-06 | CT#100 | CP-231256 | 0002 | 2 | B | MCPTT Adding user ID in Floor Request message from IWF | 18.0.0 | \ No newline at end of file diff --git a/gsma/29_series/29509/raw.md b/gsma/29_series/29509/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3ce258187c1063f9df2ea7b702de0ba4e67d6f80 --- /dev/null +++ b/gsma/29_series/29509/raw.md @@ -0,0 +1,4352 @@ + + +# 3GPP TS 29.509 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Authentication Server Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - France + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTET™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Overview..... | 10 | +| 4.1 Introduction ..... | 10 | +| 5 Services offered by the AUSF ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Nausf_UEAuthentication Service ..... | 11 | +| 5.2.1 Service Description ..... | 11 | +| 5.2.2 Service Operations..... | 11 | +| 5.2.2.1 Introduction..... | 11 | +| 5.2.2.2 Authenticate ..... | 12 | +| 5.2.2.2.1 General ..... | 12 | +| 5.2.2.2.2 5G AKA ..... | 12 | +| 5.2.2.2.3 EAP-based authentication method ..... | 14 | +| 5.2.2.2.4 Authentication for FN-RG ..... | 15 | +| 5.2.2.2.5 Authentication Result Removal with 5G AKA method..... | 16 | +| 5.2.2.2.6 Authentication Result Removal with EAP-AKA' method ..... | 17 | +| 5.2.2.3 Deregister..... | 17 | +| 5.2.2.3.1 General ..... | 17 | +| 5.2.2.4 ProseAuthenticate ..... | 18 | +| 5.2.2.4.1 General ..... | 18 | +| 5.2.2.4.2 ProSe Authentication Result Removal with EAP-AKA' method ..... | 20 | +| 5.3 Nausf_SoRProtection Service..... | 20 | +| 5.3.1 Service Description ..... | 20 | +| 5.3.2 Service Operations..... | 21 | +| 5.3.2.1 Introduction..... | 21 | +| 5.3.2.2 Protect ..... | 21 | +| 5.3.2.2.1 General ..... | 21 | +| 5.4 Nausf_UPUProtection Service..... | 22 | +| 5.4.1 Service Description ..... | 22 | +| 5.4.2 Service Operations..... | 22 | +| 5.4.2.1 Introduction..... | 22 | +| 5.4.2.2 Protect ..... | 22 | +| 5.4.2.2.1 General ..... | 22 | +| 6 API Definitions ..... | 23 | +| 6.1 Nausf_UEAuthentication Service API..... | 23 | +| 6.1.1 API URI..... | 23 | +| 6.1.2 Usage of HTTP..... | 23 | +| 6.1.2.1 General..... | 23 | +| 6.1.2.2 HTTP standard headers..... | 23 | +| 6.1.2.2.1 General ..... | 23 | +| 6.1.2.2.2 Content type ..... | 23 | +| 6.1.2.3 HTTP custom headers..... | 23 | +| 6.1.2.3.1 General ..... | 23 | +| 6.1.3 Resources..... | 24 | +| 6.1.3.1 Overview..... | 24 | +| 6.1.3.2 Resource: ue-authentications (Collection)..... | 25 | +| 6.1.3.2.1 Description ..... | 25 | +| 6.1.3.2.2 Resource Definition..... | 25 | +| 6.1.3.2.3 Resource Standard Methods..... | 26 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.3.2.4 | Resource Custom Operations..... | 28 | +| 6.1.3.3 | Resource: 5g-aka-confirmation (Document) ..... | 29 | +| 6.1.3.3.1 | Description ..... | 29 | +| 6.1.3.3.2 | Resource Definition..... | 29 | +| 6.1.3.3.3 | Resource Standard Methods..... | 29 | +| 6.1.3.4 | Resource: eap-session (Document)..... | 31 | +| 6.1.3.4.1 | Description ..... | 31 | +| 6.1.3.4.2 | Resource Definition..... | 31 | +| 6.1.3.4.3 | Resource Standard Methods..... | 32 | +| 6.1.3.5 | Resource: rg-authentications (Collection) ..... | 34 | +| 6.1.3.5.1 | Description ..... | 34 | +| 6.1.3.5.2 | Resource Definition..... | 34 | +| 6.1.3.5.3 | Resource Standard Methods..... | 34 | +| 6.1.3.6 | Resource: prose-authentications (Collection)..... | 35 | +| 6.1.3.6.1 | Description ..... | 35 | +| 6.1.3.6.2 | Resource Definition..... | 36 | +| 6.1.3.6.3 | Resource Standard Methods..... | 36 | +| 6.1.3.7 | Resource: prose-auth (Document)..... | 38 | +| 6.1.3.7.1 | Description ..... | 38 | +| 6.1.3.7.2 | Resource Definition..... | 38 | +| 6.1.3.7.3 | Resource Standard Methods..... | 38 | +| 6.1.4 | Custom Operations without associated resources ..... | 40 | +| 6.1.4.1 | Overview..... | 40 | +| 6.1.5 | Notifications ..... | 40 | +| 6.1.5.1 | General..... | 40 | +| 6.1.6 | Data Model ..... | 41 | +| 6.1.6.1 | General..... | 41 | +| 6.1.6.2 | Structured data types..... | 42 | +| 6.1.6.2.1 | Introduction ..... | 42 | +| 6.1.6.2.2 | Type: AuthenticationInfo ..... | 43 | +| 6.1.6.2.3 | Type: UEAuthenticationCtx..... | 44 | +| 6.1.6.2.4 | Type: 5gAuthData..... | 44 | +| 6.1.6.2.5 | Type: Av5gAka..... | 44 | +| 6.1.6.2.6 | Type: ConfirmationData ..... | 44 | +| 6.1.6.2.7 | Type: EapSession..... | 45 | +| 6.1.6.2.8 | Type: ConfirmationDataResponse ..... | 45 | +| 6.1.6.2.9 | Type: RgAuthenticationInfo ..... | 45 | +| 6.1.6.2.10 | Type: RgAuthCtx..... | 46 | +| 6.1.6.2.11 | Type: DeregistrationInfo..... | 46 | +| 6.1.6.2.12 | Type: ProSeAuthenticationInfo..... | 46 | +| 6.1.6.2.13 | Type: ProSeAuthenticationCtx ..... | 46 | +| 6.1.6.2.14 | Type: ProSeEapSession..... | 47 | +| 6.1.6.2.15 | Type: ProSeAuthData ..... | 47 | +| 6.1.6.2.16 | Type: ProSeAuthenticationResult..... | 47 | +| 6.1.6.3 | Simple data types and enumerations..... | 48 | +| 6.1.6.3.1 | Introduction ..... | 48 | +| 6.1.6.3.2 | Simple data types ..... | 48 | +| 6.1.6.3.3 | Enumeration: AuthType..... | 48 | +| 6.1.6.3.4 | Enumeration: AuthResult..... | 48 | +| 6.1.6.3.5 | Relation Types..... | 48 | +| 6.1.6.4 | Binary data..... | 49 | +| 6.1.6.4.1 | Introduction ..... | 49 | +| 6.1.7 | Error Handling ..... | 49 | +| 6.1.7.1 | General..... | 49 | +| 6.1.7.2 | Protocol Errors ..... | 49 | +| 6.1.7.3 | Application Errors..... | 49 | +| 6.1.8 | Security ..... | 50 | +| 6.1.9 | Feature Negotiation ..... | 50 | +| 6.1.10 | HTTP redirection..... | 50 | +| 6.2 | Nausf_SoRProtection Service API..... | 51 | +| 6.2.1 | API URI..... | 51 | +| 6.2.2 | Usage of HTTP..... | 51 | + +| | | | +|-----------|------------------------------------------------------|----| +| 6.2.2.1 | General..... | 51 | +| 6.2.2.2 | HTTP standard headers..... | 51 | +| 6.2.2.2.1 | General ..... | 51 | +| 6.2.2.2.2 | Content type ..... | 51 | +| 6.2.2.3 | HTTP custom headers..... | 51 | +| 6.2.2.3.1 | General ..... | 51 | +| 6.2.3 | Resources..... | 51 | +| 6.2.3.1 | Overview..... | 51 | +| 6.2.3.2 | Resource: supi (Custom operation)..... | 52 | +| 6.2.3.2.1 | Description ..... | 52 | +| 6.2.3.2.2 | Resource Definition..... | 52 | +| 6.2.3.2.3 | Resource Standard Methods..... | 52 | +| 6.2.3.2.4 | Resource Custom Operations..... | 53 | +| 6.2.4 | Custom Operations without associated resources ..... | 54 | +| 6.2.4.1 | Overview..... | 54 | +| 6.2.5 | Notifications ..... | 54 | +| 6.2.5.1 | General..... | 54 | +| 6.2.6 | Data Model ..... | 54 | +| 6.2.6.1 | General..... | 54 | +| 6.2.6.2 | Structured data types..... | 55 | +| 6.2.6.2.1 | Introduction ..... | 55 | +| 6.2.6.2.2 | Type: SorInfo ..... | 55 | +| 6.2.6.2.3 | Type: SorSecurityInfo ..... | 55 | +| 6.2.6.2.4 | Type: SteeringInfo..... | 56 | +| 6.2.6.2.5 | Type: SteeringContainer ..... | 56 | +| 6.2.6.3 | Simple data types and enumerations..... | 56 | +| 6.2.6.3.1 | Introduction ..... | 56 | +| 6.2.6.3.2 | Simple data types ..... | 56 | +| 6.2.6.3.3 | Enumeration: AccessTech..... | 57 | +| 6.2.7 | Error Handling ..... | 57 | +| 6.2.7.1 | General..... | 57 | +| 6.2.7.2 | Protocol Errors ..... | 57 | +| 6.2.7.3 | Application Errors..... | 57 | +| 6.2.8 | Security ..... | 57 | +| 6.2.9 | Feature Negotiation ..... | 57 | +| 6.2.10 | HTTP redirection..... | 58 | +| 6.3 | Nausf_UPUProtection Service API ..... | 58 | +| 6.3.1 | API URI..... | 58 | +| 6.3.2 | Usage of HTTP..... | 58 | +| 6.3.2.1 | General..... | 58 | +| 6.3.2.2 | HTTP standard headers..... | 59 | +| 6.3.2.2.1 | General ..... | 59 | +| 6.3.2.2.2 | Content type ..... | 59 | +| 6.3.2.3 | HTTP custom headers..... | 59 | +| 6.3.2.3.1 | General ..... | 59 | +| 6.3.3 | Resources..... | 59 | +| 6.3.3.1 | Overview..... | 59 | +| 6.3.3.2 | Resource: supi (Custom operation)..... | 60 | +| 6.3.3.2.1 | Description ..... | 60 | +| 6.3.3.2.2 | Resource Definition..... | 60 | +| 6.3.3.2.3 | Resource Standard Methods..... | 60 | +| 6.3.3.2.4 | Resource Custom Operations..... | 60 | +| 6.3.4 | Custom Operations without associated resources ..... | 61 | +| 6.3.4.1 | Overview..... | 61 | +| 6.3.5 | Notifications ..... | 61 | +| 6.3.5.1 | General..... | 61 | +| 6.3.6 | Data Model ..... | 61 | +| 6.3.6.1 | General..... | 61 | +| 6.3.6.2 | Structured data types..... | 62 | +| 6.3.6.2.1 | Introduction ..... | 62 | +| 6.3.6.2.2 | Type: UpuInfo ..... | 63 | +| 6.3.6.2.3 | Type: UpuSecurityInfo..... | 63 | + +| | | | +|-------------------------------|-----------------------------------------|-----------| +| 6.3.6.2.4 | Type: UpuData ..... | 63 | +| 6.3.6.3 | Simple data types and enumerations..... | 64 | +| 6.3.6.3.1 | Introduction ..... | 64 | +| 6.3.6.3.2 | Simple data types ..... | 64 | +| 6.3.6.3.3 | Void..... | 64 | +| 6.3.7 | Error Handling ..... | 64 | +| 6.3.7.1 | General..... | 64 | +| 6.3.7.2 | Protocol Errors ..... | 64 | +| 6.3.7.3 | Application Errors..... | 64 | +| 6.3.8 | Security ..... | 64 | +| 6.3.9 | Feature Negotiation ..... | 65 | +| 6.3.10 | HTTP redirection..... | 65 | +| Annex A (normative): | OpenAPI specification ..... | 66 | +| A.1 | General..... | 66 | +| A.2 | Nausf_UEAuthentication API..... | 66 | +| A.3 | Nausf_SoRProtection API ..... | 79 | +| A.4 | Nausf_UPUProtection API ..... | 81 | +| Annex B (Informative): | Use of EAP-TLS ..... | 84 | +| B.1 | General..... | 84 | +| B.2 | EAP method: EAP-TLS ..... | 84 | +| Annex C (informative): | Withdrawn API versions ..... | 85 | +| C.1 | General..... | 85 | +| C.2 | Nausf_SoRProtection API ..... | 85 | +| Annex D (informative): | Change history ..... | 86 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nausf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the AUSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 33.501 [8]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] IETF RFC 9113: "HTTP/2". +- [7] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [8] 3GPP TS 33.501: "Security Architecture and Procedures for 5G System". +- [9] Void +- [10] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [14] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". + +- [15] 3GPP TS 31.102: "Characteristics of the Universal Subscriber Identity Module (USIM) application". +- [16] IETF RFC 5216: "The EAP-TLS Authentication Protocol". +- [17] IETF RFC 9048: "Improved Extensible Authentication Protocol Method for 3rd Generation Authentication and Key Agreement (EAP-AKA')". +- [18] IETF RFC 3748: "Extensible Authentication Protocol (EAP)". +- [19] IETF RFC 4648: "The Base16, Base32 and Base64 Data Encodings". +- [20] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [21] 3GPP TR 21.900: "Technical Specification Group working methods". +- [22] 3GPP TS 29.544: "5G System; SP-AF Services; Stage 3". +- [23] 3GPP TS 23.316: " Wireless and wireline convergence access support for the 5G System (5GS); Release 16". +- [24] 3GPP TS 29.524: "5G System; Cause codes mapping between 5GC interfaces; Stage 3". +- [25] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", +- [26] 3GPP TS 33.503: " Security Aspects of Proximity based Services (ProSe) in the 5G System (5GS)". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|-----------------------------------------| +| 5G Prose | 5G Proximity-based Services | +| AMF | Access and Mobility Management Function | +| API | Application Programming Interface | +| AUSF | Authentication Server Function | +| CH | Credentials Holder | +| DCS | Default Credentials Server | +| FN-RG | Fixed Network RG | +| MAC | Message Authentication Code | +| N5GC | Non-5G-Capable | +| NF | Network Function | +| RG | Residential Gateway | +| SEAF | SEcurity Anchor Function | +| SNPN | Stand-alone Non-Public Network | +| SoR | Steering of Roaming | +| URI | Uniform Resource Identifier | +| UPU | UE Parameters Update | +| W-AGF | Wireline Access Gateway Function | + +# 4 Overview + +## 4.1 Introduction + +The Network Function (NF) Authentication Server Function (AUSF) is the network entity in the 5G Core Network (5GC) supporting the following functionalities: + +- Authenticate the UE for the requester NF, +- Provide keying material to the requester NF, +- Protect the Steering Information List for the requester NF. +- Protect the UE Parameter Update Data for the requester NF. + +Figure 4-1 shows the reference architecture for the AUSF: + +![Diagram of AUSF in 5G System architecture showing connections to UDM, AMF/SEAF, and NSWOF in the HPLMN, and AMF/SEAF in the VPLMN via the Nausf interface.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +The diagram illustrates the AUSF (Authentication Server Function) as a central component. At the top, a light blue box labeled 'AUSF' is connected to a horizontal service interface line via a small oval labeled 'Nausf'. Below this line, on the left side (HPLMN), three boxes are connected: an orange 'UDM', a yellow 'AMF/SEAF', and an orange 'NSWOF'. On the right side (VPLMN), separated by a vertical dashed line, another yellow 'AMF/SEAF' box is connected to the same service interface line. The labels 'HPLMN' and 'VPLMN' are placed below their respective groups of network functions. + +Diagram of AUSF in 5G System architecture showing connections to UDM, AMF/SEAF, and NSWOF in the HPLMN, and AMF/SEAF in the VPLMN via the Nausf interface. + +**Figure 4-1: AUSF in 5G System architecture** + +This figure represents the AUSF architecture in the Service-based Architecture model. In the reference point model, the interface between the AMF and the AUSF is named N12, the interface between the NSWOF and the AUSF is named N60. In this release, the SEAF function is collocated with the AMF. The AUSF may provide the service to the UDM. + +Figure 4-1 illustrates PLMN level scenarios, but this architecture is also applicable to the SNPN scenarios, as explained below. + +In the case of SNPN, the AUSF provides services e.g. in the following scenarios: + +- For an SNPN for which roaming is not supported (see 3GPP TS 23.501 [2], clause 5.30.2.0) +- For the case of UE access to SNPN using credentials from Credentials Holder (see 3GPP TS 23.501 [2], clause 5.30.2.9) +- For the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clause 5.30.2.10) +- For the case of supports the authentication of a 5G ProSe Remote UE or a 5G ProSe End UE (see 3GPP TS 33.503 [26], clause 7.3) + +# 5 Services offered by the AUSF + +## 5.1 Introduction + +The AUSF offers to NF Service Consumers (e.g. AMF) the following services: + +- Nausf\_UEAuthentication +- Nausf\_SoRProtection +- Nausf\_UPUProtection + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|------------------------|--------|--------------------------------|-------------------------------------|---------------------|-------| +| Nausf_UEAuthentication | 6.1 | AUSF UE Authentication Service | TS29509_Nausf_UEAuthentication.yaml | nausf-auth | A.2 | +| Nausf_SoRProtection | 6.2 | AUSF SoR Protection Service | TS29509_Nausf_SoRProtection.yaml | nausf-sorprotection | A.3 | +| Nausf_UPUProtection | 6.3 | AUSF UPU Protection Service | TS29509_Nausf_UPUProtection.yaml | nausf-upuprotection | A.4 | + +AUSF provides services to the following SNPN scenarios (see clauses 5.30.2 in 3GPP TS 23.501 [2]): + +- In a SNPN where roaming is not supported; +- In the case of UE access to SNPN using credentials from Credentials Holder with AAA-S; +- In the case of UE access to SNPN using credentials from Credentials Holder with AUSF and UDM; +- In the case of Onboarding of UEs for SNPNs without using Default Credentials Server; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AAA-S; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AUSF and UDM. + +## 5.2 Nausf\_UEAuthentication Service + +### 5.2.1 Service Description + +The AUSF is acting as NF Service Producer. It provides UE authentication service to the requester NF. The NF Service Consumer is the AMF. + +For this service, the following service operations are defined: + +- Authenticate + +This service permits to authenticate the UE and to provide one or more master keys which are used by the AMF to derived subsequent keys. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operation defined for the Nausf\_UEAuthentication is as follows: + +- Authenticate: It allows the AMF to authenticate the UE and allows the AMF to inform AUSF to remove the UE authentication result in the UDM. +- Dereister: It allows UDM to request the AUSF to clear the Security Context. +- ProseAuthenticate: It allows the AUSF of the 5G ProSe Remote UE to support the authentication of a 5G ProSe Remote UE via the AMF of the 5G ProSe UE-to-Network Relay or allows the AUSF of the 5G ProSe End UE to support the authentication of a 5G ProSe End UE via the AMF of the 5G ProSe UE-to-UE Relay. + +#### 5.2.2.2 Authenticate + +##### 5.2.2.2.1 General + +The service operation "Authenticate" permits the requester NF to initiate the Authentication of the UE by providing the following information to the AUSF: + +- UE id (i.e. SUPI or SUCI) +- Serving Network Name + +The AUSF retrieves the UE's subscribed authentication method from the UDM and depending on the information provided by the UDM, the AUSF enters in one of the following procedures: + +- 5G-AKA +- EAP-based authentication' + +For those two different procedures a new resource is generated by the AUSF. The content of the resource will depend on the procedure and will be returned to the AMF. + +This service operation "Authenticate" also permits the requester NF to initiate the Authentication of the FN-RG registration via W-AGF by providing the following information to the AUSF: + +- UE id (i.e. SUCI) +- Indication that the W-AGF has authenticated the FN-RG + +The AUSF retrieves the UE's SUPI, indication that authentication is not required for the FN-RG from the UDM, and AUSF shall not perform the authentication. + +The service operation "Authenticate" also permits the requester NF to inform the AUSF to remove the UE authentication result in the UDM. + +##### 5.2.2.2.2 5G AKA + +In this procedure, the NF Service Consumer (AMF) requests the authentication of the UE by providing UE related information and the Serving Network Name to the NF Service Producer (AUSF), which retrieves UE related data and authentication method from the UDM. In this case the retrieved authentication method is 5G AKA. The NF Service Consumer (AMF) shall then return to the AUSF the result received from the UE: + +![Sequence diagram for 5G AKA authentication between NF Service Consumer and AUSF.](eefe19c5e14dc4d6c316b7f7fbb7d7d7_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note right of NF Service Consumer: 1. POST .../ue-authentications (AuthenticationInfo) + NF Service Consumer->>AUSF: 1. POST .../ue-authentications (AuthenticationInfo) + Note left of AUSF: 2a. 201 Created (UEAuthCtx) + AUSF-->>NF Service Consumer: 2a. 201 Created (UEAuthCtx) + Note left of AUSF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + Note right of NF Service Consumer: 3. PUT .../ue-authentications/{AuthCtxId}/5g-aka-confirmation (ConfirmationData) + NF Service Consumer->>AUSF: 3. PUT .../ue-authentications/{AuthCtxId}/5g-aka-confirmation (ConfirmationData) + Note left of AUSF: 4a. 200 OK (ConfirmationDataResponse) + AUSF-->>NF Service Consumer: 4a. 200 OK (ConfirmationDataResponse) + Note left of AUSF: 4b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 4b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for 5G AKA authentication between NF Service Consumer and AUSF. + +Figure 5.2.2.2.2-1: 5G AKA + +1. The NF Service Consumer (AMF) shall send a POST request to the AUSF. The content shall contain at least the UE Id and the Serving Network Name. +- 2a. On success, "201 Created" shall be returned. The content shall contain the representation of the resource created and the "Location" header shall contain the URI of the created resource (e.g. .../ue\_authentications/{authCtxId}). The AUSF generates a sub-resource "5g-aka-confirmation". There shall be only one sub-resource "5g-aka-confirmation" per UE per Serving Network identified by the supiOrSuci and servingNetworkName in AuthenticationInfo. The AUSF shall provide an hypermedia link towards this sub-resource in the content to indicate to the AMF where it shall send a PUT for the confirmation. +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. If the serving network is not authorized, the AUSF shall use the SERVING\_NETWORK\_NOT\_AUTHORIZED "cause". +3. Based on the relation type, the NF Service Consumer (AMF) deduces that it shall send a PUT containing the "RES\*" provided by the UE to the URI provided by the AUSF or derived by itself. The NF Service Consumer (AMF) shall also send a PUT containing null value in the RES\* to indicate the failure to the AUSF for the following cases: + - if the UE is not reached, and the RES\* is never received by the NF Service Consumer (AMF); + - the comparison of the HRES\* and HXRES\* is unsuccessful in the NF Service Consumer (AMF); + - the authentication failure is received from the UE, e.g. synchronization failure or MAC failure; +- 4a. On success, "200 OK" shall be returned. If the UE is not authenticated, e.g. the verification of the RES\* was not successful in the AUSF, the AUSF shall set the value of AuthResult to AUTHENTICATION\_FAILURE. + +In SNPN onboarding scenarios, if the UE is authenticated successfully, the AUSF may include in the response the FQDN(s) and/or IP address(es) of an onboarding Provisioning Server (PVS) to the NF Service Consumer (AMF); see 3GPP TS 23.501 [2], clause 5.30.2.10. + +- 4b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.3.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.3.1-3. + +##### 5.2.2.2.3 EAP-based authentication method + +###### 5.2.2.2.3.1 General + +In this procedure, the NF Service Consumer requests the authentication of the UE by providing UE related information and the serving network and the EAP-based authentication is selected (see IETF RFC 3748 [18]). EAP messages are exchanged between a UE acting as EAP peer, an NF Service Consumer (AMF/SEAF, NSWOF) acting as a pass-through authenticator and the AUSF acting as the EAP server. + +###### 5.2.2.2.3.2 EAP method: EAP-AKA' + +EAP-AKA' is the EAP method used in this procedure + +![Sequence diagram showing EAP-based authentication with EAP-AKA' method between NF Service Consumer and AUSF.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: + NF Service Consumer->>AUSF: 1. POST .../ue-authentications (AuthenticationInfo) + Note right of AUSF: + AUSF-->>NF Service Consumer: 2. 201 Created (UEAuthCtx) + Note right of AUSF: + AUSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NF Service Consumer: + NF Service Consumer->>AUSF: 3. POST .../ue-authentications/{authCtxId}/eap-session (EapSession) + Note right of AUSF: + AUSF-->>NF Service Consumer: 4a. 200 OK (EapSession) + Note right of AUSF: + AUSF-->>NF Service Consumer: 4b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NF Service Consumer: + NF Service Consumer->>AUSF: 5. POST .../ue-authentications/{authCtxId}/eap-session (EapSession) + Note right of AUSF: + AUSF-->>NF Service Consumer: 6a. 200 OK (EapSession) + Note right of AUSF: + AUSF-->>NF Service Consumer: 6b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing EAP-based authentication with EAP-AKA' method between NF Service Consumer and AUSF. + +**Figure 5.2.2.2.3-1: EAP-based authentication with EAP-AKA' method** + +- The NF Service Consumer (AMF, NSWOF) shall send a POST request to the AUSF. The content shall contain at least the UE Id, Serving Network Name. If the consumer is an NSWOF the NSWO Indicator shall be present in the content. +- On success, "201 Created" shall be returned. The content shall contain the representation of the resource generated and the "Location" header shall contain the URI of the generated resource (e.g. .../ue\_authentications/{authCtxId}). The AUSF generates a sub-resource "eap-session". There shall be only one sub-resource "eap-session" per UE per Serving Network identified by the supiOrSuci and servingNetworkName in AuthenticationInfo. The AUSF shall provide a hypermedia link towards this sub-resource in the payload to indicate to the AMF or NSWOF where it shall send a POST containing the EAP packet response. The content shall also contain the EAP packet EAP-Request/AKA'-Challenge. + +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. In particular, if the serving network is not authorized, the AUSF shall use the "Cause" SERVING\_NETWORK\_NOT\_AUTHORIZED. +3. Based on the relation type, the NF Service Consumer (AMF, NSOWF) shall send a POST request including the EAP-Response/AKA' Challenge received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF, NSWOF). +- 4a. On success, and if the AUSF and the UE have indicated the use of protected successful result indications as in IETF RFC 9048 [17], the AUSF shall reply with a "200 OK" HTTP message containing the EAP Request/AKA' Notification and an hypermedia link towards the sub-resource "eap-session". +- 4b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +NOTE: Steps 4 to 5 are optional. + +5. The NF Service Consumer (AMF, NSWOF) shall send a POST request including the EAP Response/AKA' Notification received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF, NSWOF). + - 6a. If the EAP authentication exchange is successfully completed (with or without the optional Notification Request/Response messages exchange), "200 OK" shall be returned to the NF Service Consumer (AMF, NSWOF). The content shall contain the result of the authentication, an EAP success/failure and if the authentication is successful the Kseaf if the consumer is an AMF or the MSK if the consumer is a NSWOF (as indicated by the NSWO indicator received in step 1). If the UE is not authenticated, the AUSF shall set the authResult to AUTHENTICATION\_FAILURE. +- In SNPN onboarding scenarios, if the UE is authenticated successfully, the AUSF may include in the response the FQDN(s) and/or IP address(es) of an onboarding Provisioning Server (PVS) to the NF Service Consumer (AMF) ; see 3GPP TS 23.501 [2], clause 5.30.2.10. +- 6b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +###### 5.2.2.2.3.3 EAP method: EAP-TLS + +The EAP-TLS method can be used in private networks as an EAP method (see 3GPP TS 33.501 [8] Annex B.1). The corresponding stage 3 implementation is described in Annex B. + +The EAP-TLS method is applicable for N5GC devices behind Cable RGs in private networks or in deployment scenarios with wireline access; see 3GPP TS 33.501 [8] Annex O. + +###### 5.2.2.2.3.4 EAP method: EAP-TTLS + +The EAP-TTLS method can be used as an EAP method (see 3GPP TS 33.501 [8] Annex U) in case of UE access to SNPN using credentials from Credential Holder with AAA Server. + +##### 5.2.2.2.4 Authentication for FN-RG + +In this procedure, the NF Service Consumer (AMF) requests the authentication of the FN-RG registration via W-AGF by providing the SUCI of the FN-RG and the authenticated indication. + +![Sequence diagram for Authentication for FN-RG. The NF Service Consumer sends a POST request to the AUSF. The AUSF returns a 201 Created response on success or a 4xx/5xx or 3xx response on failure or redirection.](0f985b39edc1d52ba3600c438bc8f0a5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: 1. POST ../rg-authentications (RgAuthenticationInfo) + NF Service Consumer->>AUSF: Request + Note right of AUSF: 2a. 201 Created (RgAuthCtx) + AUSF-->>NF Service Consumer: Success Response + Note right of AUSF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Authentication for FN-RG. The NF Service Consumer sends a POST request to the AUSF. The AUSF returns a 201 Created response on success or a 4xx/5xx or 3xx response on failure or redirection. + +**Figure 5.2.2.2.4-1: Authentication for FN-RG** + +1. The NF Service Consumer (AMF) shall send a POST request to the AUSF. The content shall contain at least the UE Id and the authenticated indication. +- 2a. On success, "201 Created" shall be returned. The content shall contain the representation of the resource created and the "Location" header shall contain the URI of the created resource (e.g. .../rg-authentications/{authCtxId}). +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +##### 5.2.2.2.5 Authentication Result Removal with 5G AKA method + +In the case that the Purge of subscriber data in AMF after the UE deregisters from the network or the NAS SMC fails following the successful authentication in the registration procedure, the NF Service Consumer (AMF) requests the AUSF to inform the UDM to remove the authentication result: + +![Sequence diagram for Authentication Result Removal with 5G AKA method. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF returns a 204 No Content response on success or a 4xx/5xx or 3xx response on failure or redirection.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: 1. DELETE ../ue-authentications/{authCtxId}/5g-aka-confirmation + NF Service Consumer->>AUSF: Request + Note right of AUSF: 2a. 204 No Content + AUSF-->>NF Service Consumer: Success Response + Note right of AUSF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Authentication Result Removal with 5G AKA method. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF returns a 204 No Content response on success or a 4xx/5xx or 3xx response on failure or redirection. + +**Figure 5.2.2.2.5-1: Authentication Result Removal with 5G AKA method** + +1. The NF Service Consumer (AMF) shall send a DELETE request to the resource URI representing the sub-resource "5g-aka-confirmation". The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The AUSF shall send a DELETE request to the UDM for removing the authentication result of the UE after receiving the above DELETE request message. +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.3.3.2-3.. + +##### 5.2.2.2.6 Authentication Result Removal with EAP-AKA' method + +In the case that the Purge of subscriber data in AMF after the UE deregisters from the network or the NAS SMC fails following the successful authentication the registration procedure, the NF Service Consumer (AMF) requests the AUSF to inform the UDM to remove the authentication result: + +![Sequence diagram showing the interaction between NF Service Consumer and AUSF for authentication result removal. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: 1. DELETE .../ue-authentications/{authCtxId}/eap-session + NF Service Consumer->>AUSF: 1. DELETE .../ue-authentications/{authCtxId}/eap-session + Note right of AUSF: -2a. 204 No Content + AUSF-->>NF Service Consumer: -2a. 204 No Content + Note right of AUSF: -2b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between NF Service Consumer and AUSF for authentication result removal. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection) response. + +**Figure 5.2.2.2.6-1: Authentication Result Removal with EAP-AKA' method** + +1. The NF Service Consumer (AMF) shall send a DELETE request to the resource URI representing the sub-resource "eap-session". The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The AUSF shall send a DELETE request to the UDM for removing the authentication result of the UE after receiving the above DELETE request message. +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.2-3. + +#### 5.2.2.3 Deregister + +##### 5.2.2.3.1 General + +The Deregister service operation is used in the following scenario: + +- Deletion of security context in AUSF + +The NF Service Consumer (e.g. UDM) uses this service operation to request the AUSF to clear the stale security context, after the UE has been successfully (re)authenticated in same or different Serving Network via another AUSF Instance, e.g. due to registration via another access-type; so as to ensure only latest Kausf is maintained in the network. The service may also be used by UDM when the UE is no longer registered via any access-type or serving-network. It is responsibility of NF Service Consumers to ensure that security context being deleted does not hold the latest Kausf if UE is also connected via another Serving-Network. + +![Sequence diagram showing UE Context Clean-up in AUSF. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 204 No Content (2a) or an error status code (2b).](dfe556fea00682b09a59427aaf72051c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: 1. POST ../ue-authentications/deregister (DeregistrationInfo) + NF Service Consumer->>AUSF: Request + Note right of AUSF: -2a. 204 No Content + AUSF-->>NF Service Consumer: Response 2a + Note right of AUSF: -2b. 4xx/5xx (ProblemDetails) or 3xx- + AUSF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing UE Context Clean-up in AUSF. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 204 No Content (2a) or an error status code (2b). + +**Figure 5.2.2.3.1-1: UE Context Clean-up in AUSF** + +1. The NF Service Consumer (e.g. UDM) shall send a POST request to the AUSF that was used to authenticate the UE. The content shall contain the UE id (e.g. SUPI). +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.4.2.2-2. + +#### 5.2.2.4 ProseAuthenticate + +##### 5.2.2.4.1 General + +The ProseAuthenticate service operation is used in the following scenario: + +- Authenticate the 5G ProSe Remote UE in AUSF or 5G ProSe End UE + +The NF Service Consumer (AMF) requests the authentication of the 5G ProSe Remote UE or the 5G ProSe End UE by providing 5G ProSe Remote UE or the 5G ProSe End UE related information (SUCI or CP-PRUK ID), the Relay Service Code and Nonce\_1 to the NF Service Producer (AUSF) in the initial authentication request. When CP-PRUK ID is provided, the AUSF shall retrieve the CP-PRUK from PANF; when SUCI is provided, the AUSF retrieves 5G ProSe Remote UE or the 5G ProSe End UE related data and authentication method from the UDM. In this case the retrieved authentication method is EAP-AKA. The NF Service Consumer (AMF) shall then return to the AUSF the result received from the 5G ProSe Remote UE or the 5G ProSe End UE to continue the authentication: + +![Sequence diagram for ProSe Authentication between NF Service Consumer and AUSF.](2b3a967f6ce4f23649be995a353e39f8_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note right of NF Service Consumer: 1. POST .../prose-authentications (ProSeAuthenticationInfo) + NF Service Consumer->>AUSF: 1. POST .../prose-authentications (ProSeAuthenticationInfo) + Note left of AUSF: 2a. 201 Created (ProSeAuthenticationCtx) + AUSF-->>NF Service Consumer: 2a. 201 Created (ProSeAuthenticationCtx) + Note left of AUSF: 2b. 200 OK (ProSeAuthenticationResult) + AUSF-->>NF Service Consumer: 2b. 200 OK (ProSeAuthenticationResult) + Note left of AUSF: 2c. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + Note right of NF Service Consumer: 3. POST .../prose-authentications/{authCtxId}/prose-auth (ProSeEapSession) + NF Service Consumer->>AUSF: 3. POST .../prose-authentications/{authCtxId}/prose-auth (ProSeEapSession) + Note left of AUSF: 4a. 200 OK (ProSeEapSession) + AUSF-->>NF Service Consumer: 4a. 200 OK (ProSeEapSession) + Note left of AUSF: 4b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 4b. 4xx/5xx (ProblemDetails) or 3xx + Note right of NF Service Consumer: 5. POST .../prose-authentications/{authCtxId}/prose-auth (ProSeEapSession) + NF Service Consumer->>AUSF: 5. POST .../prose-authentications/{authCtxId}/prose-auth (ProSeEapSession) + Note left of AUSF: 6a. 200 OK (ProSeEapSession) + AUSF-->>NF Service Consumer: 6a. 200 OK (ProSeEapSession) + Note left of AUSF: 6b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 6b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for ProSe Authentication between NF Service Consumer and AUSF. + +Figure 5.2.2.4.1-1: ProSe Authentication + +1. The NF Service Consumer (AMF) shall send a POST request to the AUSF. The content shall contain the UE Id (SUCI) or CP-PRUK ID, Relay Service Code and Nonce\_1. +- 2a. On success, "201 Created" shall be returned if UE Id (SUCI) is received. The content shall contain the representation of the resource generated and the "Location" header shall contain the URI of the generated resource (e.g. .../prose\_authentications/{authCtxId}). The AUSF generates a sub-resource "prose-auth". There shall be only one sub-resource "prose-auth" per UE identified by the supiOrSuci in ProSeAuthenticationInfo. The AUSF shall provide a hypermedia link towards this sub-resource in the content to indicate to the AMF where it shall send a POST containing the EAP packet response. The content shall also contain the EAP packet EAP-Request/AKA'-Challenge. +- 2b. On success, "200 OK" shall be returned if CP-PRUK ID is received. The payload body shall contain the KNR\_ProSe and Nonce\_2. Step 3 to 6 are skipped. +- 2c. On failure or redirection, one of the HTTP status code listed in table 6.1.3.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.2.3.1-3. +3. Based on the relation type, the NF Service Consumer (AMF) shall send a POST request including the EAP-Response/AKA' Challenge received from the 5G ProSe Remote UE or the 5G ProSe End UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF). +- 4a. On success, and if the AUSF and the UE have indicated the use of protected successful result indications as in IETF RFC 5448 [9] (to be superseded by draft-ietf-emu-rfc5448bis [17]), the AUSF shall reply with a "200 OK" HTTP message containing the EAP Request/AKA' Notification and an hypermedia link towards the sub-resource "prose-auth". + +- 4b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +NOTE: Steps 4 to 5 are optional. + +5. The NF Service Consumer (AMF) shall send a POST request including the EAP Response/AKA' Notification received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF). +- 6a. If the ProSe authentication exchange is successfully completed (with or without the optional Notification Request/Response messages exchange), "200 OK" shall be returned to the NF Service Consumer (AMF). The content shall contain the result of the authentication, an EAP success/failure. The content shall also contain the $K_{NR\_ProSe}$ , Nonce\_2 and CP-PRUK ID if the authentication is successful. If the 5G ProSe Remote UE or the 5G ProSe End UE is not authenticated, the AUSF shall set the authResult to AUTHENTICATION\_FAILURE. +- 6b. On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.1-3. + +##### 5.2.2.4.2 ProSe Authentication Result Removal with EAP-AKA' method + +In the case that the authentication of a 5G ProSe Remote UE or the 5G ProSe End UE fails, the NF Service Consumer (AMF) requests the AUSF to inform the UDM to remove the authentication result: + +![Sequence diagram showing the ProSe Authentication Result Removal with EAP-AKA' method. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection).](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: 1. DELETE .../prose-authentications/{authCtxId}/prose-auth + NF Service Consumer->>AUSF: 1. DELETE .../prose-authentications/{authCtxId}/prose-auth + Note right of AUSF: 2a. 204 No Content + AUSF-->>NF Service Consumer: 2a. 204 No Content + Note right of AUSF: 2b. 4xx/5xx (ProblemDetails) or 3xx + AUSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the ProSe Authentication Result Removal with EAP-AKA' method. The NF Service Consumer sends a DELETE request to the AUSF. The AUSF responds with either a 204 No Content (success) or a 4xx/5xx (ProblemDetails) or 3xx (failure/redirection). + +**Figure 5.2.2.4.2-1: ProSe Authentication Result Removal with EAP-AKA' method** + +- The NF Service Consumer (AMF) shall send a DELETE request to the resource URI representing the sub-resource "prose-auth". The request body shall be empty. +- On success, "204 No Content" shall be returned. The AUSF shall send a DELETE request to the UDM for removing the authentication result of the UE after receiving the above DELETE request message. +- On failure or redirection, one of the HTTP status code listed in table 6.1.3.4.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.4.3.2-3. + +## 5.3 Nausf\_SoRProtection Service + +### 5.3.1 Service Description + +The AUSF is acting as NF Service Producer. It provides SoRProtection service to the NF Service Consumer. + +This service permits to provide the NF Service Consumer (e.g. UDM) with the SoR-MAC-IAUSF and CounterSoR to protect the Steering Information from being tampered with or removed by the VPLMN. + +NOTE: If the Steering Information is not available or HPLMN determines that no steering of the UE is required, a SOR transparent container information element with an HPLMN indication that 'no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE protected by SoR-MAC-IAUSF and CounterSoR is still sent to the UE during registration. The Steering Information in such a case, the NF Service Consumer shall send an empty list to the AUSF when consuming the Nausf\_SoRProtection Service. + +In option this service also allows to provide the NF Service Consumer (e.g. UDM) with the SoR-XMAC-IUE that allows the NF Service Consumer (e.g. UDM) to verify that the UE received the Steering Information List. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operation defined for the Nausf\_SoRProtection is as follows: + +- Protect + +#### 5.3.2.2 Protect + +##### 5.3.2.2.1 General + +The Protect service operation is used in the following procedures: + +- Procedure for steering of UE in VPLMN during registration (see clause 6.14.2.1 of 3GPP TS 33.501 [8]); +- Procedure for steering of UE in VPLMN after registration (see clause 6.14.2.2 of 3GPP TS 33.501 [8]). + +The NF Service Consumer (e.g. UDM) uses this service operation to request the AUSF to compute the SoR-MAC-IAUSF and the CounterSoR by providing Steering Information. The NF Service Consumer (e.g. UDM) may also request the AUSF to compute the SoR-XMAC-IUE by providing the indication that an acknowledgement is requested from the UE. + +![Sequence diagram showing the interaction between NF Service Consumer and AUSF for steering of UE in VPLMN. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 200 OK (SorSecurityInfo) or a 4xx/5xx (ProblemDetails) or 3xx response.](c0e369274e53b2e5364666be6f786c7a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: NF Service Consumer + Note right of AUSF: AUSF + NF Service Consumer->>AUSF: 1. POST .../{supi}/ue-sor (SorInfo) + AUSF-->>NF Service Consumer: -2a. 200 OK (SorSecurityInfo) + Note left of NF Service Consumer: -2a. 200 OK (SorSecurityInfo) + AUSF-->>NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between NF Service Consumer and AUSF for steering of UE in VPLMN. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 200 OK (SorSecurityInfo) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.3.2.2.1-1: Steering of UE in VPLMN + +1. The NF Service Consumer (e.g. UDM) shall send a POST request to the AUSF that was used to authenticate the UE. The content shall contain the Steering Information and the acknowledge indication. +- 2a. On success, "200 OK" shall be returned. The content shall contain the requested security material (e.g. SoR-MAC-IAUSF, CounterSoR, SoR-XMAC-IUE) necessary to protect the Steering of Roaming procedure. + +SoR Header shall be used to form the input as one of multiple parameters to calculate the SoR-MAC-IAUSF. If SoRHeader attribute is not provided by NF Service Consumer (e.g. UDM) as part of SorInfo, SoR Header shall be constructed by AUSF based on the information received in the request and encoded as specified in clause 9.11.3.51 of 3GPP TS 24.501[20]. + +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.2.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.2.3.2.4.2.2-21. If the CounterSOR associated with the KAUSF of the UE, is about to wrap around, the AUSF shall use the "COUNTER-WRAP" cause. + +## 5.4 Nausf\_UPUProtection Service + +### 5.4.1 Service Description + +The AUSF is acting as NF Service Producer. It provides UPUProtection service to the NF Service Consumer. + +This service permits to provide the NF Service Consumer (e.g. UDM) with the UPU-MAC-IAUSF and CounterUPU to protect the UE Parameters Update Data from being tampered with or removed. + +In option this service also allows to provide the NF Service Consumer (e.g. UDM) with the UPU-XMAC-IUE that allows the NF Service Consumer (e.g. UDM) to verify that the UE received UE Parameters Update Data correctly. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The service operation defined for the Nausf\_UPUProtection is as follows: + +- Protect + +#### 5.4.2.2 Protect + +##### 5.4.2.2.1 General + +The Protect service operation is used in the following procedures: + +- Procedure for UE Parameters Update (see clause 6.15.2.1 of 3GPP TS 33.501 [8]). + +The NF Service Consumer (e.g. UDM) uses this service operation to request the AUSF to compute the UPU-MAC-IAUSF and CounterUPU by providing the UE Parameters Update Data (UPU Data). The NF Service Consumer (e.g. UDM) may also request the AUSF to compute the UPU-XMAC-IUE by providing the indication that an acknowledgement is requested from the UE. + +![Sequence diagram showing the interaction between an NF Service Consumer and an AUSF for UE Parameters Update. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 200 OK (UpuSecurityInfo) or a 4xx/5xx (ProblemDetails) or 3xx response.](6efcea66501271e9ea36cf33982f08d5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: UE Parameters Update in VPLMN + NF Service Consumer->>AUSF: 1. POST ...{supi}/ue-upu (UpuInfo) + Note right of AUSF: + AUSF-->>NF Service Consumer: 2a. 200 OK (UpuSecurityInfo) + Note right of AUSF: + AUSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an AUSF for UE Parameters Update. The NF Service Consumer sends a POST request to the AUSF. The AUSF responds with either a 200 OK (UpuSecurityInfo) or a 4xx/5xx (ProblemDetails) or 3xx response. + +Figure 5.4.2.2-1: UE Parameters Update in VPLMN + +1. The NF Service Consumer (e.g. UDM) shall send a POST request to the AUSF that was used to authenticate the UE and stores the latest KAUSF for the UE. The content shall contain the UE Parameters Update Data (UPU Data), the UPU Header and the acknowledge indication. +- 2a. On success, "200 OK" shall be returned. The content shall contain the requested security material necessary to protect the UE Parameters Update procedure. + +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.3.3.2.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.3.3.2.4.2.2-2. If the CounterUPU associated with the KAUSF of the UE, is about to wrap around, the AUSF shall use the "COUNTER-WRAP" cause. + +# --- 6 API Definitions + +## 6.1 Nausf\_UEAuthentication Service API + +### 6.1.1 API URI + +URIs of this API shall have the following root: + +{apiRoot} + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot} + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "nausf-auth". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [6], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers is specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [7], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [11]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json" +- The 3GPP hypermedia format as defined in 3GPP TS 29.501 [5]. The use of the 3GPP hypermedia format in a HTTP response body shall be signalled by the content type "application/3gppHal+json" + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The usage of HTTP custom headers shall be supported as specified in clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nausf\_UEAuthentication service is shown in Figure 6.1.3.1-1 + +![](7e1c9b51e067a48cd0fcc9748d8bd8d8_img.jpg) + +Diagram illustrating the Resource URI structure of the AUSF API: + +``` +graph TD; Root["//{apiRoot}/nausf-ausf/{apiVersion}"] --- UE["/ue-authentications"]; Root --- RG["/rg-authentications"]; Root --- PROSE["/prose-authentications"]; UE --- UE_Ctx["/{authCtxId}"]; UE_Ctx --- UE_5G["/5g-aka-confirmation"]; UE_Ctx --- UE_EAP["/eap-session"]; UE_Ctx --- UE_DEREG["/deregister"]; RG --- RG_Ctx["/{authCtxId}"]; PROSE --- PROSE_Ctx["/{authCtxId}"]; PROSE_Ctx --- PROSE_AUTH["/prose-auth"]; +``` + +The diagram shows the hierarchical structure of Resource URIs under the base path `//{apiRoot}/nausf-ausf/{apiVersion}`. The main branches are `/ue-authentications`, `/rg-authentications`, and `/prose-authentications`. The `/ue-authentications` branch further branches into `/{authCtxId}`, which then branches into `/5g-aka-confirmation`, `/eap-session`, and `/deregister` (indicated by a dashed box). The `/rg-authentications` branch branches into `/{authCtxId}`. The `/prose-authentications` branch branches into `/{authCtxId}`, which then branches into `/prose-auth`. + +**Figure 6.1.3.1-1: Resource URI structure of the AUSF API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------|-----------------------------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| ue-authentications (Collection) | /ue-authentications | POST | Initiate the authentication process by providing inputs related to the UE | +| | /ue-authentications/deregister | deregister (POST) | Clear the security context of the UE | +| Individual UE authentication (Document) | /ue-authentications/{authCtxId} | | See NOTE 1 | +| 5g-aka-confirmation (Document) | /ue-authentications/{authCtxId}/5g-aka-confirmation | PUT | Put the UE response from the 5G-AKA process. | +| | | DELETE | DELETE the authentication result. | +| eap-session (Document) | /ue-authentications/{authCtxId}/eap-session | POST | Post the EAP response from the UE.
See NOTE. | +| | | DELETE | DELETE the authentication result. | +| rg-authentications (Collection) | /rg-authentications | POST | Initiate the authentication process by providing inputs related to the FN-RG | +| Individual RG authentication (Document) | /rg-authentications/{authCtxId} | | See NOTE 3 | +| prose-authentications (Collection) | /prose-authentications | POST | Initiate the authentication process by providing inputs related to the 5G ProSe Remote UE or the 5G ProSe End UE. | +| prose-auth (Document) | /prose-authentications/{authCtxId}/prose-auth | POST | Post the EAP response from the 5G ProSe Remote UE or the 5G ProSe End UE.
See NOTE. | +| | | DELETE | DELETE the authentication result. | + +NOTE 1: This resource represents the created individual UE authentication, the URI of the created resource is contained in the "Location" header of the "201 Created" response (See step 2a of Figure 5.2.2.2.2-1 and Figure 5.2.2.3.2-1). There are no service operations defined on this resource. + +NOTE 2: This POST is used to provide EAP response to the AUSF in a sub-resource (Document) generated by the first POST operation. As this operation is not idempotent (it triggers subsequent EAP operations), a PUT was not adequate. + +NOTE 3: This resource represents the created individual RG authentication, the URI of the created resource is contained in the "Location" header of the "201 Created" response (See step 2a of Figure 5.2.2.2.4-1). There are no service operations defined on this resource. + +#### 6.1.3.2 Resource: ue-authentications (Collection) + +##### 6.1.3.2.1 Description + +This resource represents a collection of the ue-authentication resources generated by the AUSF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth//ue-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfo | M | 1 | Contains the UE id (i.e. SUCI or SUPI as specified in 3GPP TS 33.501 [8]) and the serving network name.
It may also contain Trace Data as specified in 3GPP TS 23.501 [2]. | + +Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response Codes | Description | +|---------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UEAuthenticationCtx | M | 1 | 201 Created | Upon success, if 5G AKA is selected, the response body will contain one AV and "link" for the AMF to PUT the confirmation. If an EAP-based method is selected, the response body will contain the EAP method selected, the corresponding EAP packet request and a "link" for the AMF to POST the EAP response.

The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents the failure to start authentication service because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- SERVING_NETWORK_NOT_AUTHORIZED
- INVALID_HN_PUBLIC_KEY_IDENTIFIER
- INVALID_SCHEME_OUTPUT | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER NOT FOUND | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This case represents the failure in starting the authentication service because of a server internal error.
If the error is due to a problem with UDM not able to generate the requested AV, the AUSF shall indicate the following application error: "AV_GENERATION_PROBLEM" | +| ProblemDetails | O | 0..1 | 501 Not Implemented | The "cause" attribute may be used to indicate one of the following application errors:
- UNSUPPORTED_PROTECTION_SCHEME

This response shall not be cached. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource according to the structure: {apiRoot}/nausf-auth//ue-authentications/{authCtxId} | + +Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|-----------------------------------------------------------------|--------------------|--------------------------------------| +| {apiRoot}/nausf-auth/{apiVersion}/ue-authentications/deregister | POST | Clear the Security Context of the UE | + +###### 6.1.3.2.4.2 Operation: deregister (POST) + +###### 6.1.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request the AUSF to clear the Security Context, after the UE has been successfully re-authenticated in same Serving Network, or has been successfully authenticated in another Serving Network, e.g. due to registration via another access-type. + +###### 6.1.3.2.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------| +| DeregistrationInfo | M | 1 | See 6.1.6.2.11. | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the handover is cancelled successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND

See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.4.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3 Resource: 5g-aka-confirmation (Document) + +##### 6.1.3.3.1 Description + +The subresource "5g-aka-confirmation" is generated by the AUSF. This subresource should not persist after the AUSF has read its content. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth//ue-authentications/{authCtxId}/5g-aka-confirmation + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-----------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| authCtxId | string | Represents a specific ue-authentication per UE per serving network | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------------| +| ConfirmationData | M | 1 | Contains the "RES*" generated by the UE and provided to the AMF. | + +**Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|---------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ConfirmationData Response | M | 1 | 200 OK | This case indicates that the AUSF has performed the verification of the 5G AKA confirmation. The response body shall contain the result of the authentication and the Kseaf if the authentication is successful. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents a 5G AKA confirmation failure because of input parameter error. This indicates that the AUSF was not able to confirm the authentication. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This case represents a 5G AKA confirmation failure because of a server internal error. | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Resource: eap-session (Document) + +##### 6.1.3.4.1 Description + +The "eap-session" is generated by the AUSF if an EAP-based authentication method is selected. This resource is used to handle the EAP session. This subresource should not persist after the EAP exchanges. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth/{apiVersion}/ue-authentications/{authCtxId}/eap-session + +This resource shall support the resource URI variables defined in table 6.1.3.4.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| authCtxId | string | Represents a specific ue-authentication per UE per serving network | + +##### 6.1.3.4.3 Resource Standard Methods + +###### 6.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.4.3.1-1. + +**Table 6.1.3.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.1-2 and the response data structures and response codes specified in table 6.1.3.4.3.1-3. + +**Table 6.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|--------------------------------------------------------------------------------------------------| +| EapSession | M | 1 | Contains the EAP packet response (see IETF RFC 3748 [18]) from the UE and transferred by the AMF | + +**Table 6.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EapSession | M | 1 | 200 OK | During an EAP session, the body response shall contain the EAP packet Response and a hypermedia link.
At the end of the EAP session, the body response shall contain the EAP packet Success or Failure (see IETF RFC 3748 [18]) and the Kseaf if the authentication is successful | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an EAP session failure because of input parameter error. This indicates that the AUSF was not able to continue the EAP session. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This case represents an EAP session failure because of a server internal error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4] + +**Table 6.1.3.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.4.3.2-1. + +**Table 6.1.3.4.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.4.3.2-2 and the response data structures and response codes specified in table 6.1.3.4.3.2-3. + +**Table 6.1.3.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.4.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.5 Resource: rg-authentications (Collection) + +##### 6.1.3.5.1 Description + +This resource represents a collection of the rg-authentication resources generated by the AUSF. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth//rg-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.5.3 Resource Standard Methods + +###### 6.1.3.5.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.1.3.5.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.5.3.1-2 and the response data structures and response codes specified in table 6.1.3.5.3.1-3. + +**Table 6.1.3.5.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------| +| RgAuthenticationInfo | M | 1 | Contains the UE id (i.e. SUCI as specified in 3GPP TS 23.316 [23] or 3GPP TS 33.501 [8]) and the authenticated indication. | + +**Table 6.1.3.5.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RgAuthCtx | M | 1 | 201
Created | Upon success, the response body will contain the SUPI of the UE and the authentication indication.

The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400
Bad Request | This case represents the failure to start authentication service because of input parameter error. | +| ProblemDetails | O | 0..1 | 403
Forbidden | This case represents when the UE is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- INVALID SCHEME OUTPUT | +| ProblemDetails | O | 0..1 | 404
Not Found | The "cause" attribute may be used to indicate the following application error:
- USER NOT FOUND | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.6 Resource: prose-authentications (Collection) + +##### 6.1.3.6.1 Description + +This resource represents a collection of the prose-authentication resources generated by the AUSF. + +##### 6.1.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth//prose-authentications + +This resource shall support the resource URI variables defined in table 6.1.3.6x.2-1. + +**Table 6.1.3.6x.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.6.3 Resource Standard Methods + +###### 6.1.3.6.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.6.3.1-1. + +**Table 6.1.3.6.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.6.3.1-2 and the response data structures and response codes specified in table 6.1.3.6x.3.1-3. + +**Table 6.1.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| ProSeAuthenticationInfo | M | 1 | Contains the UE Id (i.e. SUCI as specified in 3GPP TS 33.503 [26]) or the CP-PRUK ID, the Relay Service Code and Nonce 1. | + +Table 6.1.3.6.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response Codes | Description | +|---------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProSeAuthenticationCtx | M | 1 | 201 Created | Upon success, when UE Id (i.e. SUCI) was received in the request, the response body will contain the EAP method selected, the corresponding EAP packet request and a "link" for the AMF to POST the EAP response.

The HTTP response shall include a "Location" header that contains the resource URI of the created resource. | +| ProSeAuthenticationResult | M | 1 | 200 OK | Upon success, when CP-PRUK ID was received in the request, the response body will contain the K NR_ProSe and Nonce_2. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents the failure to start authentication service because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the 5G ProSe Remote UE or the 5G ProSe End UE is not allowed to be authenticated. The "cause" attribute may be used to indicate one of the following application errors:
- AUTHENTICATION_REJECTED
- INVALID_HN_PUBLIC_KEY_IDENTIFIER
- INVALID_SCHEME_OUTPUT | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This case represents the failure in starting the authentication service because of a server internal error. If the error is due to a problem with UDM not able to generate the requested AV, the AUSF shall indicate the following application error:
"AV_GENERATION_PROBLEM" | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.6.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource according to the structure: {apiRoot}/nausf-auth//prose-authentications/{authCtxId} | + +Table 6.1.3.6.3.1-5: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.6.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.7 Resource: prose-auth (Document) + +##### 6.1.3.7.1 Description + +The "prose-auth" is generated by the AUSF if an EAP-based authentication method is selected. This resource is used to handle the EAP session. This subresource should not persist after the EAP exchanges. + +##### 6.1.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nausf-auth//prose-authentications/{authCtxId}/prose-auth + +This resource shall support the resource URI variables defined in table 6.1.3.7.2-1. + +**Table 6.1.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|---------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| authCtxId | string | Represents a specific prose-authentication per UE | + +##### 6.1.3.7.3 Resource Standard Methods + +###### 6.1.3.7.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.7.3.1-1. + +**Table 6.1.3.7.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.7.3.1-2 and the response data structures and response codes specified in table 6.1.3.7.3.1-3. + +**Table 6.1.3.7.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| ProSeEapSession | M | 1 | Contains the EAP packet response (see IETF RFC 3748 [18]) from the 5G ProSe Remote UE or the 5G ProSe End UE and transferred by the AMF | + +**Table 6.1.3.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProSeEapSession | M | 1 | 200 OK | During an EAP session, the body response shall contain the EAP packet Response and an hypermedia link.
At the end of the EAP session, the body response shall contain the EAP packet Success or Failure (see IETF RFC 3748 [18]) and the K NR_ProSe if the authentication is successful | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an EAP session failure because of input parameter error. This indicates that the AUSF was not able to continue the EAP session. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | This case represents an EAP session failure because of a server internal error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4] + +**Table 6.1.3.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.7.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.1.3.7y.3.2-1. + +**Table 6.1.3.7.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.7.3.2-2 and the response data structures and response codes specified in table 6.1.3.7.3.2-3. + +**Table 6.1.3.7.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.1.3.7.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.7.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.7.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +There is no Custom Operation in the current version of this API. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +There is no use of notification in the current version of this API. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nausf service based interface protocol. + +**Table 6.1.6.1-1: Nausf specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthenticationInfo | 6.1.6.2.2 | Contains the UE id (i.e. SUCI or SUPI) and the Serving Network Name. | +| UEAuthenticationCtx | 6.1.6.2.3 | Contains the information related to the resource generated to handle the UE authentication. It contains at least the UE id, Serving Network, the Authentication Method and related EAP information or related 5G-AKA information. | +| 5gAuthData | 6.1.6.2.4 | Contains 5G authentication related information. | +| Av5gAka | 6.1.6.2.5 | Contains Authentication Vector for method 5G AKA. | +| ConfirmationData | 6.1.6.2.6 | Contains the "RES*" generated by the UE. | +| EapSession | 6.1.6.2.7 | Contains information related to the EAP session. | +| ConfirmationDataResponse | 6.1.6.2.8 | Contains the result of the authentication. | +| RgAuthenticationInfo | 6.1.6.2.9 | Contains the UE id (i.e. SUCI) and the authenticated indication. | +| RgAuthCtx | 6.1.6.2.10 | Contains the UE id (i.e. SUPI) and the authentication indication. | +| DeregistrationInfo | 6.1.6.2.11 | Contains the UE id (i.e. SUPI). | +| ProSeAuthenticationInfo | 6.1.6.2.12 | Contains the information related to the Prose authentication received from the 5G ProSe Remote UE or the 5G ProSe End UE. | +| ProSeAuthenticationCtx | 6.1.6.2.13 | Contains the information related to the resource generated to handle the ProSe authentication. | +| ProSeEapSession | 6.1.6.2.14 | Contains information related to the EAP session for the 5G ProSe Remote UE or the 5G ProSe End UE. | +| ProSeAuthData | 6.1.6.2.15 | Contains ProSe authentication related information. | +| ProSeAuthenticationResult | 6.1.6.2.16 | ProSe Authentication Result | +| EapPayload | 6.1.6.3.2 | Contains the EAP packets. | +| ResStar | 6.1.6.3.2 | Contains the RES*. | +| Kseaf | 6.1.6.3.2 | Contains the Kseaf. | +| HxresStar | 6.1.6.3.2 | Contains the HXRES*. | +| Suci | 6.1.6.3.2 | Contains the SUCI. | +| KnrProSe | 6.1.6.3.2 | Contains the $K_{NR\_ProSe}$ . | +| Nonce1 | 6.1.6.3.2 | Contains the Nonce1. | +| Nonce2 | 6.1.6.3.2 | Contains the Nonce2. | +| Msk | 6.1.6.3.2 | Contains the Master Session Key. | +| AuthType | 6.1.6.3.3 | Indicates the authentication method used. | +| AuthResult | 6.1.6.3.4 | Indicates the result of the authentication. | + +Table 6.1.6.1-2 specifies data types re-used by the Nausf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nausf service based interface. + +Table 6.1.6.1-2: Nausf re-used Data Types + +| Data type | Reference | Comments | +|-----------------------|---------------------|------------------------------------------| +| ResynchronizationInfo | 3GPP TS 29.503 [12] | | +| ServingNetworkName | 3GPP TS 29.503 [12] | | +| Autn | 3GPP TS 29.503 [12] | | +| Rand | 3GPP TS 29.503 [12] | | +| LinksValueSchema | 3GPP TS 29.571 [10] | 3GPP Hypermedia link | +| ProblemDetails | 3GPP TS 29.571 [10] | Common Data Type used in response bodies | +| Supi | 3GPP TS 29.571 [10] | | +| Uri | 3GPP TS 29.571 [10] | | +| SupiOrSuci | 3GPP TS 29.571 [10] | | +| Pei | 3GPP TS 29.571 [10] | | +| TraceData | 3GPP TS 29.571 [10] | | +| NfGroupId | 3GPP TS 29.571 [10] | | +| CagId | 3GPP TS 29.571 [10] | | +| SupportedFeatures | 3GPP TS 29.571 [10] | Supported Features | +| ServerAddressingInfo | 3GPP TS 29.571 [10] | | +| RelayServiceCode | 3GPP TS 29.571 [10] | | +| 5GPrunkId | 3GPP TS 29.571 [10] | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +The following clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: AuthenticationInfo + +Table 6.1.6.2.2-1: Definition of type AuthenticationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiOrSuci | SupiOrSuci | M | 1 | Contains the SUPI or SUCI of the UE. | +| servingNetworkName | ServingNetworkName | M | 1 | Contains the Serving Network Name. | +| resynchronizationInfo | ResynchronizationInfo | O | 0..1 | Contains RAND and AUTS; see 3GPP 33.501 [8] clause 9.4. | +| pei | Pei | O | 0..1 | Permanent Equipment Identifier | +| traceData | TraceData | O | 0..1 | Contains TraceData provided by the UDM to the AMF | +| udmGroupId | NfGroupId | O | 0..1 | Identity of the UDM group serving the SUPI | +| routingIndicator | String | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE.
Pattern: '[0-9]{1,4}\$' | +| cellCagInfo | array(CagId) | O | 1..N | CAGList of the CAG cell. | +| n5gcInd | boolean | O | 0..1 | N5GC device indicator (see 3GPP TS 33.501 [8])
When present, this IE shall be set as follows:
- true: authentication is for a N5GC device;
- false (default): authentication is not for a N5GC device.
See NOTE | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | FQDN(s) and/or IP address(es) of the SNPN UE onboarding Provisioning Servers (PVS). | +| nswoInd | boolean | O | 0..1 | NSWO Indicator (see 3GPP TS 33.501 [8])
When present, this IE shall be set as follows:
- true: Non-Seamless WLAN Offload is applied;
- false (default): Non-Seamless WLAN Offload is not applied. | +| disasterRoamingInd | boolean | O | 0..1 | Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).
When present, this IE shall be set as follows:
- true: Disaster Roaming service is applied;
- false (default): Disaster Roaming service is not applied. | +| onboardingInd | boolean | O | 0..1 | UE Onboarding Indicator for the authentication
When present, this IE shall be set as follows:
- true: authentication is for UE onboarding;
- false (default): authentication is not for UE onboarding. | +| aun3Ind | boolean | O | 0..1 | AUN3 Indicator (see 3GPP TS 33.501 [8])
When present, this IE shall be set as follows:
- true: authentication is for an AUN3 device behind RG;
- false (default): authentication is not for an AUN3 device behind RG. | + +NOTE: The attribute n5gcInd is used for EAP-TLS, which is described in the informative annex O of 3GPP TS 33.501 [8] and is not mandatory to support. + +##### 6.1.6.2.3 Type: UEAuthenticationCtx + +Table 6.1.6.2.3-1: Definition of type UEAuthenticationCtx + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authType | AuthType | M | 1 | Indicates the authentication method used for this UE i.e. "5G-AKA-Confirmation", "EAP-AKA"; "EAP-TLS" or "EAP-TTLS". See clause 6.1.6.3.3 | +| _links | map(LinksValueSchema) | M | 1..N | If 5G-AKA has been selected, this IE shall contain a member whose name is set to "5g-aka" and the URI to perform the confirmation.
If an EAP-based method has been selected, this IE shall contain a member whose name is set to "eap-session" and the URI to perform the EAP session.
See NOTE | +| 5gAuthData | 5gAuthData | M | 1 | Contains either 5G-AKA or EAP related information. | +| servingNetworkName | ServingNetworkName | O | 0..1 | Contains the Serving Network Name. | + +NOTE: In the current version of this API, only one hypermedia link is provided + +##### 6.1.6.2.4 Type: 5gAuthData + +Table 6.1.6.2.4-1: Definition of type 5gAuthData as a list of mutually exclusive alternatives + +| Data type | Cardinality | Description | +|------------|-------------|-------------------------------------------------| +| Av5gAka | 1 | Contains the 5G AV if 5G-AKA has been selected. | +| EapPayload | 1 | Contains the EAP packet request. | + +##### 6.1.6.2.5 Type: Av5gAka + +Table 6.1.6.2.5-1: Definition of type Av5gAka + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------| +| rand | Rand | M | 1 | | +| autn | Autn | M | 1 | | +| hxresStar | HxresStar | M | 1 | | + +##### 6.1.6.2.6 Type: ConfirmationData + +Table 6.1.6.2.6-1: Definition of type ConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| resStar | ResStar | M | 1 | Contains the "RES*" provided by the UE to the AMF. If no RES* has been provided by the UE the null value is conveyed to the AUSF. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +##### 6.1.6.2.7 Type: EapSession + +Table 6.1.6.2.7-1: Definition of type EapSession + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eapPayload | EapPayload | M | 1 | Contains the EAP packet (see IETF RFC 3748 [18]).
If no EAP packet has been provided by the UE the null value is conveyed to the AUSF. | +| kSeaf | Kseaf | C | 0..1 | Shall be absent for N5GC device authentication; otherwise:
If the authentication is successful and the consumer is an AMF, the Kseaf shall be included | +| _links | map(LinksValueSchema) | C | 1..N | If the EAP session requires another exchange e.g. for EAP-AKA' notification, this IE shall contain a member whose name is "eap-session" and the URI to continue the EAP session.
See NOTE. | +| authResult | AuthResult | C | 0..1 | Indicates the result of the authentication. | +| supi | Supi | C | 0..1 | If the authentication is successful and if the AMF had provided a SUCI, this IE shall contain the SUPI of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | FQDN(s) and/or IP address(es) of the SNPN UE onboarding Provisioning Servers (PVS). | +| msk | Msk | C | 0..1 | If the authentication is successful and the consumer is an NSWOF as indicated by the NSWOF indicator received within the AuthenticationInfo, the MSK shall be included (see 3GPP TS 33.501 [8] annex S)

If the authentication is successful and the MSK indicator is received from UDM, the MSK shall be included. (see clause 7B.7 of 3GPP TS 33.501 [8]) | + +NOTE: In the current version of this API, only 0 or 1 hypermedia link is provided. + +##### 6.1.6.2.8 Type: ConfirmationDataResponse + +Table 6.1.6.2.8-1: Definition of type ConfirmationDataResponse + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------| +| authResult | AuthResult | M | 1 | Indicates the result of the authentication | +| supi | Supi | C | 0..1 | If the authentication is successful and if the AMF had provided a SUCI, this IE shall contain the SUPI of the UE | +| kseaf | Kseaf | C | 0..1 | Contains the Kseaf if authentication is successful. | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | FQDN(s) and/or IP address(es) of the SNPN UE onboarding Provisioning Servers (PVS). | + +##### 6.1.6.2.9 Type: RgAuthenticationInfo + +Table 6.1.6.2.9-1: Definition of type RgAuthenticationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| suci | Suci | M | 1 | Contains the SUCI of the FN-RG. | +| authenticatedInd | boolean | M | 1 | This IE shall be set as follows:
  • - true: authenticated by the W-AGF;
  • - false (default): unauthenticated by the W-AGF.
| +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +6.1.6.2.10 Type: RgAuthCtx + +**Table 6.1.6.2.10-1: Definition of type RgAuthCtx** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| authResult | AuthResult | M | 1 | Indicates the result of the authentication | +| supi | Supi | C | 0..1 | If the authentication is successful and if the AMF had provided a SUCI, this IE shall contain the SUPI of the UE. | +| authInd | boolean | C | 0..1 | When present, this IE shall be set as follows:
  • - true: authentication is not required;
  • - false (default): authentication is required.
| + +6.1.6.2.11 Type: DeregistrationInfo + +**Table 6.1.6.2.11-1: Definition of type DeregistrationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +6.1.6.2.12 Type: ProSeAuthenticationInfo + +**Table 6.1.6.2.12-1: Definition of type ProSeAuthenticationInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiOrSuci | SupiOrSuci | C | 0..1 | This IE shall be present if received from 5G ProSe Remote UE or the 5G ProSe End UE.

When received, this IE shall contain the SUCI of the 5G ProSe Remote UE or the 5G ProSe End UE. | +| 5gPrukId | 5GPrukId | C | 0..1 | This IE shall be present if the CP-PRUK is received from 5G ProSe Remote UE or the 5G ProSe End UE.

When present, this IE shall indicate the CP-PRUK ID received from the 5G ProSe Remote UE or the 5G ProSe End UE. | +| relayServiceCode | RelayServiceCode | M | 1 | Indicates Relay Service Code. See 3GPP TS 29.571 [7] clause 5.4.2 | +| nonce1 | Nonce1 | M | 1 | Indicates Nonce 1. | +| servingNetworkName | ServingNetworkName | M | 1 | Serving network name of the UE-to-Network relay or the UE-to-UE relay | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +6.1.6.2.13 Type: ProSeAuthenticationCtx + +**Table 6.1.6.2.13-1: Definition of type ProSeAuthenticationCtx** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------| +| authType | AuthType | M | 1 | Indicates the authentication method used for this UE i.e. "EAP-AKA". | +| _links | map(LinksValueSchema) | M | 1..N | This IE shall contain a member whose name is set to "prose-auth" and the URI to perform the EAP session.
See NOTE | +| proSeAuthData | ProSeAuthData | M | 1 | Contains ProSe Authentication related information | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +NOTE: In the current version of this API, only one hypermedia link is provided + +##### 6.1.6.2.14 Type: ProSeEapSession + +Table 6.1.6.2.14-1: Definition of type ProSeEapSession + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eapPayload | EapPayload | M | 1 | Contains the EAP packet (see IETF RFC 3748 [18]).
If no EAP packet has been provided by the 5G ProSe Remote UE or the 5G ProSe End UE the null value is conveyed to the AUSF. | +| knrProSe | KnRProSe | C | 0..1 | If the authentication is successful and no EAP packet has been provided by the 5G ProSe Remote UE or the 5G ProSe End UE, the KN R _ProSe shall be included | +| or the 5G ProSe End UE | map(LinksValueSchema) | C | 1..N | If the EAP session requires another exchange e.g. for EAP-AKA' notification, this IE shall contain a member whose name is "prose-auth" and the URI to continue the EAP session.
See NOTE. | +| authResult | AuthResult | C | 0..1 | This IE shall be present if no EAP packet has been provided by the 5G ProSe Remote UE or the 5G ProSe End UE.

When present, this IE shall indicate the result of the authentication. | +| nonce2 | Nonce2 | C | 0..1 | If the authentication is successful and no EAP packet has been provided by the 5G ProSe Remote UE or the 5G ProSe End UE, the Nonce_2 shall be included. | +| 5gPrukId | 5GPrukId | C | 0..1 | This IE shall be present if authentication is successful and no EAP packet has been provided by the 5G ProSe Remote UE or the 5G ProSe End UE.

When present, this IE shall contain the CP-PRUK ID to the 5G ProSe Remote UE or the 5G ProSe End UE. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +NOTE: In the current version of this API, only 0 or 1 hypermedia link is provided. + +##### 6.1.6.2.15 Type: ProSeAuthData + +Table 6.1.6.2.15-1: Definition of type ProSeAuthData as a list of mutually exclusive alternatives + +| Data type | Cardinality | Description | +|------------|-------------|----------------------------------| +| EapPayload | 1 | Contains the EAP packet request. | + +##### 6.1.6.2.16 Type: ProSeAuthenticationResult + +Table 6.1.6.2.16-1: Definition of type ProSeAuthenticationResult + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| knrProSe | KnRProSe | C | 0..1 | If the authentication is successful, the KN R _ProSe shall be included | +| nonce2 | Nonce2 | C | 0..1 | If the authentication is successful, the Nonce_2 shall be included. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EapPayload | string | The EAP packet is encoded using base64 (see IETF RFC 4648 [19]) and represented as a String.
Format: byte | +| ResStar | string | pattern: "^[A-Fa-f0-9]{32}\$"; nullable | +| Kseaf | string | pattern: "^[A-Fa-f0-9]{64}\$" | +| HxresStar | string | pattern: "^[A-Fa-f0-9]{32}\$" | +| Suci | string | String containing a SUCI.
Pattern: "^(suci-(0-[0-9]{3}-[0-9]{2,3}[1-7]-.+)-[0-9]{1,4}-(0-0-.[a-fA-F1-9]-[1-9][0-9]{1}[0-9]{2}[2-4][0-9]{2}[5-7]-[a-fA-F0-9]+).+)\$" | +| KnRProSe | string | String contain the K NR_ProSe
pattern: "^[A-Fa-f0-9]{64}\$" | +| Nonce1 | string | The Nonce1 is encoded using base64 (see IETF RFC 4648 [19]) and represented as a String.
Format: byte | +| Nonce2 | string | The Nonce2 is encoded using base64 (see IETF RFC 4648 [19]) and represented as a String.
Format: byte | +| Msk | string | pattern: "^[A-Fa-f0-9]{128}\$" | + +##### 6.1.6.3.3 Enumeration: AuthType + +**Table 6.1.6.3.3-1: Enumeration AuthType** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------| +| 5G_AKA | 5G AKA | +| EAP_AKA_PRIME | EAP-AKA' | +| EAP_TLS | EAP-TLS is only used in the case where the Annex B is supported. | +| EAP_TTLS | EAP-TTLS is used in the case where the Annex U of 3GPP TS 33.501 [8] is supported. | + +##### 6.1.6.3.4 Enumeration: AuthResult + +**Table 6.1.6.3.4-1: Enumeration AuthResult** + +| Enumeration value | Description | +|------------------------|---------------------------------------------------------------------------------------------| +| AUTHENTICATION_SUCCESS | This value is used to indicate that the AUSF successfully authenticate the UE | +| AUTHENTICATION_FAILURE | This value is used to indicate that the AUSF fails to authenticate the UE. | +| AUTHENTICATION_ONGOING | This value is used during an EAP Session to indicate that the EAP session is still ongoing. | + +##### 6.1.6.3.5 Relation Types + +###### 6.1.6.3.5.1 General + +This clause describes the possible relation types defined within AUSF API. + +**Table 6.1.6.3.5-1: supported registered relation types** + +| Relation Name | +|---------------| +| 5g-aka | +| eap-session | + +###### 6.1.6.3.5.2 The "5g-aka" Link relation + +The value "5g-aka" specifies that the value of the href attribute is the URI where NF Service Consumer shall send a PUT containing the result "RES\*" received from the UE. + +###### 6.1.6.3.5.3 The "eap-session" Link relation + +The value "eap-session" specifies that the value of the href attribute is the URI that will be used by the NF Service Consumer to provide EAP packet response during an EAP exchange. The NF Service Consumer shall use a POST to provide the EAP Packet Response to the AUSF to the corresponding URI. + +#### 6.1.6.4 Binary data + +##### 6.1.6.4.1 Introduction + +There is no binary data in the current version of this API. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +The Cause codes mapping performed by AMF between the following HTTP responses returned by the AUSF services to the AMF and the 5GMM related values is specified in clause 4.2.2 of 3GPP TS 29.524 [24]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nausf\_UEAuthentication service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nausf\_UEAuthentication service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------|---------------------------|--------------------------------------------------------------------------------------------------| +| SERVING_NETWORK_NOT_AUTHORIZED | 403 Forbidden | The serving network is not authorized, e.g. serving PLMN. | +| AUTHENTICATION_REJECTED | 403 Forbidden | The user cannot be authenticated with this authentication method e.g. only SIM data available | +| INVALID_HN_PUBLIC_KEY_IDENTIFIER | 403 Forbidden | Invalid HN public key identifier received | +| INVALID_SCHEME_OUTPUT | 403 Forbidden | SUCI cannot be decrypted with received data | +| CONTEXT_NOT_FOUND | 404 Not Found | The AUSF cannot found the resource corresponding to the URI provided by the NF Service Consumer. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | No response is received from a remote peer, e.g. from the UDM | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| AV_GENERATION_PROBLEM | 500 Internal Server Error | The UDM has indicated that it was not able to generate AV. | +| UNSUPPORTED_PROTECTION_SCHEME | 501 Not implemented | The received protection scheme is not supported by HPLMN | + +### 6.1.8 Security + +As indicated in 3GPP TS 33.501 [8], the access to the Nausf\_UEAuthentication Service API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [13]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming service offered by the Nausf\_UEAuthentication Service API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nausf\_UEAuthentication service. + +The Nausf\_UEAuthentication Service API defines the following scopes. + +**Table 6.1.8-1: OAuth2 scopes defined in Nausf\_UEAuthentication API** + +| Scope | Description | +|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "nausf-auth" | Access to the Nausf_UEAuthentication API. | +| "nausf-auth:ue-authentications" | Access to service operations applying to the collection of the ue-authentication resources and the subresources, i.e. 5g-aka-confirmation and eap-session. | +| "nausf-auth:rg-authentications" | Access to service operations applying to the collection of the rg-authentication resources. | +| "nausf-auth:prose-authentications" | Access to service operations applying to the collection of the prose-authentication resources and the subresources, i.e. prose-auth. | + +### 6.1.9 Feature Negotiation + +The optional features in table 6.1.9-1 are defined for the Nausf\_UEAuthentication API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.9-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M |

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the UEAuthentication service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

| + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different AUSF service instance, within the same AUSF or a different AUSF of an AUSF set, e.g. when an AUSF service instance is part of an AUSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.10. + +An SCP that reselects a different AUSF producer instance will return the NF Instance ID of the new AUSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AUSF within an AUSF set redirects a service request to a different AUSF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AUSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nausf\_SoRProtection Service API + +### 6.2.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/ + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "nausf-sorprotection". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [6], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +The usage of HTTP standard headers is specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [7], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9475 [11]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json" + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this version of the API, no specific custom headers are defined for the "Nausf\_SoRProtection" service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nausf\_SoRProtection service is shown in Figure 6.2.3.1-1 + +![Diagram showing the URI structure: //{apiRoot}/nausf-sorprotection/ leads to /{supi}, which leads to /ue-sor/.](40ebe9179df298f1b6d76822f28d90aa_img.jpg) + +Diagram illustrating the Resource URI structure of the SoRProtection API: + +``` + + graph TD + Root["//{apiRoot}/nausf-sorprotection/"] --> Supi["/{supi}"] + Supi --> UeSor[/ue-sor/] + +``` + +Diagram showing the URI structure: //{apiRoot}/nausf-sorprotection/ leads to /{supi}, which leads to /ue-sor/. + +**Figure 6.2.3.1-1: Resource URI structure of the SoRProtection API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|-----------------|---------------------------------|------------------------------------------------| +| supi
(Custom operation) | /{supi}/ue-sor/ | ue-sor(POST) | Resource for SoR security material computation | + +#### 6.2.3.2 Resource: supi (Custom operation) + +##### 6.2.3.2.1 Description + +It is the resource to which the custom operation used to generate the SoR security material is associated with. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nausf-sorprotection//{supi}/ + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [10] | + +##### 6.2.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.2.3.2.4 Resource Custom Operations + +###### 6.2.3.2.4.1 Overview + +**Table 6.2.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ue-sor | /ue-sor | POST | The AUSF calculates the SoR-MAC-IAUSF and the CounterSoR to protect the Steering Information List provided. It may also calculate the SoR-XMAC-IUE to verify that the UE received the Steering Information List if the indication that an acknowledgement is requested from the UE. | + +###### 6.2.3.2.4.2 Operation: ue-sor + +###### 6.2.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request the AUSF to compute the security material (SoR-MAC-IAUSF, CounterSoR and SoR-XMAC-IUE) needed to ensure the protection of the SoR procedure (see 3GPP TS 33.501 [8]). + +###### 6.2.3.2.4.2.2 Operation Definition + +This method shall support the request data structures specified in table 6.2.3.2.4.2.2-1 and the response data structures and response codes specified in table 6.2.3.2.4.2.2-2. + +**Table 6.2.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorInfo | M | 1 | Contains the Steering Information List and shall contain the indication of whether an acknowledgement is requested from the UE or not (as specified in 3GPP TS 33.501 [8]). | + +**Table 6.2.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorSecurityInfo | M | 1 | 200 OK | Upon success, the response body will contain SoR-MAC-IAUSF and CounterSoR and may contain the SoR-XMAC-IUE. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be used to indicate one of the following application errors:
- COUNTER_WRAP
See table 6.2.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.4 Custom Operations without associated resources + +#### 6.2.4.1 Overview + +There is no Custom Operation in the current version of this API. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +There is no use of notification in the current version of this API. + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nausf-SORProtection service based interface protocol. + +**Table 6.2.6.1-1: Nausf specific Data Types** + +| Data type | Clause defined | Description | +|--------------------|----------------|-------------------------------------------------------------------------------------------------------------| +| SorInfo | 6.2.6.2.2 | Contains the Steering Information | +| SorSecurityInfo | 6.2.6.2.3 | Contains the material generated for securing of SoR. It contains at least the SoR-MAC-IAUSF and CounterSoR. | +| SteeringInfo | 6.2.6.2.4 | Contains a combination of one PLMN identity and zero or more access technologies. | +| SteeringContainer | 6.2.6.2.5 | Contains the information sent to UE. | +| SorMac | 6.2.6.3.2 | MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE) | +| CounterSor | 6.2.6.3.2 | CounterSoR | +| AckInd | 6.2.6.3.2 | Contains indication whether the acknowledgement from UE is needed | +| SecuredPacket | 6.2.6.3.2 | Contains a secure packet. | +| AccessTech | 6.2.6.3.3 | Access Technology | +| SorHeader | 6.2.6.3.2 | Contains the SoR Header. | +| SorTransparentInfo | 6.2.6.3.2 | Contains steering information encoded as transparent containers. | + +Table 6.2.6.1-2 specifies data types re-used by the Nausf-SORProtection service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nausf service based interface. + +**Table 6.2.6.1-2: Nausf re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|--------------------| +| PlmnId | 3GPP TS 29.571 [10] | PLMN ID | +| SupportedFeatures | 3GPP TS 29.571 [10] | Supported Features | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +The following clauses define the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: SorInfo + +**Table 6.2.6.2.2-1: Definition of type SorInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ackInd | AckInd | M | 1 | Contains the indication whether the acknowledgement from UE is needed. | +| steeringContainer | SteeringContainer | C | 0..1 | When present, this information contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM.
It may contain an array of preferred PLMN/AccessTechnologies combinations in priority order. The first entry in the array indicates the highest priority and the last entry indicates the lowest.
Or it may contain a secured packet.
If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM is needed then this attribute shall be absent. | +| sorHeader | SorHeader | O | 0..1 | This attribute contains SoR Header encoded as defined in clause 6.2.6.3.2 and shall be present if AUSF supports receiving SoR Information encoded as transparent containers. | +| sorTransparentInfo | SorTransparentInfo | O | 0..1 | This attribute contains steering information encoded as defined in clause 6.2.6.3.2, and may be present if AUSF supports receiving SoR Information encoded as transparent containers.

It may be absent if no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM is needed. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | + +##### 6.2.6.2.3 Type: SorSecurityInfo + +**Table 6.2.6.2.3-1: Definition of type SorSecurityInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| sorMacIausf | SorMac | M | 1 | Contains the SoR-MAC-IAUSF. | +| counterSor | CounterSor | M | 1 | Contains the CounterSoR. | +| sorXmacIue | SorMac | O | 0..1 | When present, contains the SoR-XMAC-IUE. It shall be included, if the UDM requests the acknowledgement from the UE. | + +##### 6.2.6.2.4 Type: SteeringInfo + +Table 6.2.6.2.4-1: Definition of type SteeringInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | Contains a preferred PLMN identity. | +| accessTechList | array(AccessTech) | C | 1..N | When present it contains the 56referred access technologies as listed in clause 4.2.5 of 3GPP TS 31.102 [15]. If absent it means that all access technologies are equivalently preferred in this PLMN. | + +##### 6.2.6.2.5 Type: SteeringContainer + +Table 6.2.6.2.5.-1: Definition of type SteeringContainer as a list of mutually exclusive alternatives + +| Data type | Cardinality | Description | +|---------------------|-------------|---------------------------------------------------------------------------------------------| +| array(SteeringInfo) | 1..N | List of PLMN/AccessTechnologies combinations. | +| SecuredPacket | 1 | A secured packet containing one or more APDUs commands dedicated to Remote File Management. | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +Table 6.2.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|--------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SorMac | string | pattern: "[A-Fa-f0-9]{32}\$" | +| CounterSor | string | pattern: "[A-Fa-f0-9]{4}\$" | +| AckInd | boolean | true indicates that the SoR-XMAC-IuE shall be computed and returned in the response | +| SecuredPacket | string | Contains a secure packet as specified in 3GPP TS 24.501 [20]. It is encoded using base64 and represented as a String.
Format: byte | +| SorHeader | Bytes | String with format "byte" as defined in OpenAPI Specification [25], i.e. base64-encoded characters, encoding the "SOR Header" IE as specified in clause 9.11.3.51 of 3GPP TS 24.501 [20] (octet 4). | +| SorTransparentInfo | Bytes | String with format "byte" as defined in OpenAPI Specification [25], i.e. base64-encoded characters, encoding the "SOR transparent container" IE as specified in clause 9.11.3.51 of 3GPP TS 24.501 [20] (starting from octet 23). | + +##### 6.2.6.3.3 Enumeration: AccessTech + +**Table 6.2.6.3.3-1: Enumeration AccessTech** + +| Enumeration value | Description | +|-------------------------------------|-------------| +| "NR" | | +| "EUTRAN IN WBS1 MODE AND NBS1 MODE" | | +| "EUTRAN IN NBS1 MODE ONLY" | | +| "EUTRAN IN WBS1 MODE ONLY" | | +| "UTRAN" | | +| "GSM AND ECGSM IoT" | | +| "GSM WITHOUT ECGSM IoT" | | +| "ECGSM IoT ONLY" | | +| "CDMA 1xRTT" | | +| "CDMA HRPD" | | +| "GSM COMPACT" | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nausf\_SoRProtection service. The following application errors listed in Table 6.2.7.3-1 are specific for the Nausf\_SoRProtection service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| COUNTER_WRAP | 503 Service Unavailable | The Counters SoR associated with the KAUSF of the UE is about to wrap around. The AUSF suspends the SoR protection service for the UE until a new KAUSF is generated. | + +### 6.2.8 Security + +As indicated in 3GPP TS 33.501 [8], the access to the Nausf\_SoRProtection API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nausf\_SoRProtection API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nausf\_SoRProtection service. + +The Nausf\_SoRProtection Service API defines a single scope nausf-sorprotection (as specified in 3GPP TS 33.501 [8]), and it does not define any additional scopes at resource or operation level. + +### 6.2.9 Feature Negotiation + +The optional features in table 6.2.9-1 are defined for the Nausf\_SoRProtection API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.9-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|-----------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. UDM) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the SoRProtection service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | sorTransparentSupport | O | This flag is used by AUSF to register (in NRF) its support of receiving SoR Transparent Information instead of individual IEs from UDM. | + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different AUSF service instance, within the same AUSF or a different AUSF of an AUSF set, e.g. when an AUSF service instance is part of an AUSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.2.9. + +An SCP that reselects a different AUSF producer instance will return the NF Instance ID of the new AUSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AUSF within an AUSF set redirects a service request to a different AUSF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AUSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.3 Nausf\_UPUProtection Service API + +### 6.3.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +{apiRoot}/{apiName}/{apiVersion}/{apiSpecificResourceUriPart} + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "nausf-upuprotection". +- The shall be "v1". +- The shall be set as described in clause 6.3.3. + +### 6.3.2 Usage of HTTP + +#### 6.3.2.1 General + +HTTP/2, as defined in IETF RFC 7540 [6], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +#### 6.3.2.2 HTTP standard headers + +##### 6.3.2.2.1 General + +The usage of HTTP standard headers is specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.3.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [7], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [11]. The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json" + +#### 6.3.2.3 HTTP custom headers + +##### 6.3.2.3.1 General + +In this version of the API, no specific custom headers are defined for the "Nausf\_UPUProtection" service. + +For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +The structure of the Resource URIs of the Nausf\_UPUProtection service is shown in Figure 6.3.3.1-1 + +![Diagram showing the Resource URI structure of the UPUProtection API. The base URI is ///nausf-upuprotection/. A line branches from this base to a box containing /{supi}. From this box, another line branches to a dashed box containing /ue-upu.](ec67eb0df9ed3c128f9bb311a2017bad_img.jpg) + +``` + +graph TD + Base["///nausf-upuprotection/"] --> Supi["/{supi}"] + Supi --> UeUpu["/ue-upu"] + style Supi stroke-width:2px + style UeUpu stroke-dasharray: 5 5 + +``` + +Diagram showing the Resource URI structure of the UPUProtection API. The base URI is ///nausf-upuprotection/. A line branches from this base to a box containing /{supi}. From this box, another line branches to a dashed box containing /ue-upu. + +**Figure 6.3.3.1-1: Resource URI structure of the UPUProtection API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|------------------|---------------------------------|------------------------------------------------| +| supi
(Custom operation) | //{supi}/ue-upu/ | ue-upu
(POST) | Resource for UPU security material computation | + +#### 6.3.3.2 Resource: supi (Custom operation) + +##### 6.3.3.2.1 Description + +It is the resource to which the custom operation used to generate the UPU security material is associated with. + +##### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nausf-upuprotection//{supi}/ + +This resource shall support the resource URI variables defined in table 6.3.3.2.2-1. + +**Table 6.3.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.3.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [10] | + +##### 6.3.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this resource. + +##### 6.3.3.2.4 Resource Custom Operations + +###### 6.3.3.2.4.1 Overview + +**Table 6.3.3.2.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ue-upu | /ue-upu | POST | The AUSF calculates the UPU-MAC-I AUSF and the Counter UPU to protect the UE Parameters Update Data provided. It may also calculate the UPU-XMAC-I UE to verify that the UE received the UE Parameters Update Data if the indication that an acknowledgement is requested from the UE is provided. | + +###### 6.3.3.2.4.2 Operation: ue-upu + +###### 6.3.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request the AUSF to compute the security material (UPU-MAC-IAUSF, CounterUPU and UPU-XMAC-IUE) needed to ensure the protection of the UPU procedure (see 3GPP TS 33.501 [8]). + +###### 6.3.3.2.4.2.2 Operation Definition + +This method shall support the request data structures specified in table 6.3.3.2.4.2.2-1 and the response data structures and response codes specified in table 6.3.3.2.4.2.2-2. + +**Table 6.3.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UpuInfo | M | 1 | Contains the UE Parameters Update Data and shall contain the indication of whether an acknowledgement is requested from the UE or not (as specified in 3GPP TS 33.501 [8]). | + +**Table 6.3.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UpuSecurityInfo | M | 1 | 200 OK | Upon success, the response body will contain UPU-MAC-I AUSF and CounterUPU and may contain the UPU-XMAC-I UE . | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 503 Service Unavailable | The "cause" attribute may be used to indicate one of the following application errors:
- COUNTER_WRAP
See table 6.3.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.3.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.3.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same AUSF or AUSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.3.4 Custom Operations without associated resources + +#### 6.3.4.1 Overview + +There is no Custom Operation in the current version of this API. + +### 6.3.5 Notifications + +#### 6.3.5.1 General + +There is no use of notification in the current version of this API. + +### 6.3.6 Data Model + +#### 6.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.6.1-1 specifies the data types defined for the Nausf-UPUProtection service based interface protocol. + +**Table 6.3.6.1-1: Nausf specific Data Types** + +| Data type | Clause defined | Description | +|--------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| UpuInfo | 6.3.6.2.2 | Contains the UE parameters update Information | +| UpuSecurityInfo | 6.3.6.2.3 | Contains the material generated for securing of UPU. It contains at least the UPU-MAC-I AUSF and Counter UPU . | +| UpuData | 6.3.6.2.4 | Contains UE parameters update data set (e.g., the updated Routing ID Data or the Default configured NSSAI). | +| UpuMac | 6.3.6.3.2 | MAC value for protecting UPU procedure (UPU-MAC-I AUSF and UPU-MAC-I IUE ) | +| CounterUpu | 6.3.6.3.2 | Counter UPU | +| UpuAckInd | 6.3.6.3.2 | Contains the indication of whether the acknowledgement from UE is needed | +| UpuHeader | 6.3.6.3.2 | Contains the "UPU Header" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 [20] (octet 4), | +| UpuTransparentInfo | 6.3.6.3.2 | Contains UPU information encoded as transparent container. | + +Table 6.3.6.1-2 specifies data types re-used by the Nausf-UPUProtection service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nausf service based interface. + +**Table 6.3.6.1-2: Nausf re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|--------------------------| +| Snssai | 3GPP TS 29.571 [10] | Default configured NSSAI | +| SecuredPacket | 6.2.6.3.2 | Secured Packet | +| RoutingId | 3GPP TS 29.544 [22] | Routing ID | +| SupportedFeatures | 3GPP TS 29.571 [10] | Supported Features | + +#### 6.3.6.2 Structured data types + +##### 6.3.6.2.1 Introduction + +The following clauses define the structures to be used in resource representations. + +##### 6.3.6.2.2 Type: UpuInfo + +Table 6.3.6.2.2-1: Definition of type UpuInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| upuDataList | array(UpuData) | M | 1..N | This information defines the UE Parameters Update (UPU). A secured packed with the Routing indicator update data and/or the Default configured NSSAI update data are included. See clause 6.3.6.2.4.

This attribute shall be ignored by AUSF when upuTransparentInfo is present. | | +| upuHeader | UpuHeader | O | 0..1 | This attribute contains UPU Header encoded as defined in clause 6.3.6.3.2. | | +| upuAckInd | UpuAckInd | M | 1 | Contains the indication of whether the acknowledgement from UE is needed. | | +| supportedFeatures | Supported Features | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.9 is supported. | | +| upuTransparentInfo | UpuTransparentInfo | O | 0..1 | This attribute contains UPU information encoded as defined in clause 6.3.6.3.2, and may be present if AUSF supports receiving UPU Information encoded as transparent container. | upuTransparentSupport | + +##### 6.3.6.2.3 Type: UpuSecurityInfo + +Table 6.3.6.2.3-1: Definition of type UpuSecurityInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| upuMaclausf | UpuMac | M | 1 | Contains the UPU-MAC-I AUSF . | +| counterUpu | CounterUpu | M | 1 | Contains the Counter UPU . | +| upuXmaclue | UpuMac | O | 0..1 | When present, contains the UPU-XMAC-I UE . It shall be included, if the UDM requests the acknowledgement from the UE. | + +##### 6.3.6.2.4 Type: UpuData + +Table 6.3.6.2.4-1: Definition of type UpuData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| secPacket | SecuredPacket | C | 0..1 | Presents if the Routing indicator update data is required to be updated, and contains a secured packet with the Routing indicator to be updated. | +| defaultConfNssai | array(SNSSAI) | C | 1..N | Presents if the Default configured NSSAI is required to be updated, and contains the Default configured NSSAI to be updated. | +| RoutingId | RoutingId | C | 0..1 | May be present when sent from UDR to UDM. The UDM shall make use of Nspaf services (see 3GPP TS 29.544 [22]) to encapsulate the routing id in a secured packet which is then conveyed to the AUSF and AMF. | + +#### 6.3.6.3 Simple data types and enumerations + +##### 6.3.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.3.6.3.2 Simple data types + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UpuMac | string | pattern: "[A-Fa-f0-9]{32}\$" | +| CounterUpu | string | pattern: "[A-Fa-f0-9]{4}\$" | +| UpuAckInd | boolean | true indicates that the UPU-XMAC-I UE shall be computed and returned in the response | +| UpuHeader | string | It contains the "UPU Header" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 [20] (octet 4), encoded as 2 hexadecimal characters.
Pattern: "[A-Fa-f0-9]{2}\$" | +| UpuTransparentInfo | Bytes | String with format "byte" as defined in OpenAPI Specification [25], i.e. base64-encoded characters, encoding the "UPU transparent container" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 [20] (starting from octet 23). | + +##### 6.3.6.3.3 Void + +### 6.3.7 Error Handling + +#### 6.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.3.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +#### 6.3.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nausf\_UPUProtection service. The following application errors listed in Table 6.3.7.3-1 are specific for the Nausf\_UPUProtection service. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| COUNTER_WRAP | 503 Service Unavailable | The Counter UPU associated with the K AUSF of the UE is about to wrap around. The AUSF suspends the UPU protection service for the UE until a new K AUSF is generated. | + +### 6.3.8 Security + +As indicated in 3GPP TS 33.501 [8], the access to the Nausf\_UPUProtection API may be authorized by means of the Oauth2 protocol (see IETF RFC 6749 [13]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [14]) plays the role of the authorization server. + +If Oauth2 is used, an NF Service Consumer, prior to consuming services offered by the Nausf\_UPUProtection API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [14], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nausf\_UPUProtection service. + +The Nausf\_UPUProtection Service API does not define any scopes for Oauth2 authorization as specified in 3GPP TS 33.501 [8]; it defines a single scope consisting on the name of the service (i.e., "nausf-upuprotection"), and it does not define any additional scopes at resource or operation level. + +### 6.3.9 Feature Negotiation + +The optional features in table 6.3.9-1 are defined for the Nausf\_UPUProtection API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.3.9-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|-----------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. UDM) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the UPUProtection service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | upuTransparentSupport | O | This flag is used by AUSF to register (in NRF) its support of receiving UPU Transparent Information instead of individual IEs from UDM | + +### 6.3.10 HTTP redirection + +An HTTP request may be redirected to a different AUSF service instance, within the same AUSF or a different AUSF of an AUSF set, e.g. when an AUSF service instance is part of an AUSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.3.9. + +An SCP that reselects a different AUSF producer instance will return the NF Instance ID of the new AUSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an AUSF within an AUSF set redirects a service request to a different AUSF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AUSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nausf Service API(s). It consists of OpenAPI 3.0.0 specifications in YAML format. + +NOTE 1: OpenAPI 3.0 does not support description of API using HATEOAS. Indeed, only relative paths can be used and as a consequence the URI provided in the "href" cannot be reused as it is. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 2: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [21] clause 5B). + +## A.2 Nausf\_UEAuthentication API + +``` +openapi: 3.0.0 +info: + version: 1.3.0-alpha.4 + title: AUSF API + description: | + AUSF UE Authentication Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.509 V18.3.0; 5G System; 3GPP TS Authentication Server services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' + +servers: + - url: '{apiRoot}/nausf-auth/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + +paths: + /ue-authentications: + post: + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthenticationInfo' + required: true + responses: + '201': + description: UEAuthenticationCtx +``` + +``` + +content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/UEAuthenticationCtx' +headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nausf-auth/{apiVersion}/ue-authentications/{authCtxId}' + required: true + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request from the AMF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Forbidden due to serving network not authorized + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: User does not exist in the HPLMN + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'501': + description: Received protection scheme is not supported by HPLMN + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +/ue-authentications/deregister: + post: + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeregistrationInfo' + required: true + responses: + '204': + description: Expected response to a successful removal of security context + +``` + +``` + +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +/ue-authentications/{authCtxId}/5g-aka-confirmation: + put: + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationData' + responses: + '200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/ConfirmationDataResponse' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` + + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +delete: + summary: Deletes the authentication result in the UDM + operationId: Delete5gAkaAuthenticationResult + tags: + - Authentication Result Deletion + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful authentication result removal + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/ue-authentications/{authCtxId}/eap-session: + post: + operationId: EapAuthMethod + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EapSession' + responses: + '200': + +``` + +``` + +description: Use to handle or close the EAP session +content: + application/json: + schema: + $ref: '#/components/schemas/EapSession' + + application/3gppHal+json: + schema: + type: object + properties: + eapPayload: + $ref: '#/components/schemas/EapPayload' + _links: + type: object + description: 'URI : {eapSessionUri}, a map(list of key-value pairs) where +member serves as key' + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + required: + - eapPayload + - _links + +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +delete: + summary: Deletes the authentication result in the UDM + operationId: DeleteEapAuthenticationResult + tags: + - Authentication Result Deletion + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:ue-authentications + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + responses: + '204': + description: Expected response to a successful authentication result removal + +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/rg-authentications: + post: + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:rg-authentications + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RgAuthenticationInfo' + required: true + responses: + '201': + description: RgAuthCtx + content: + application/json: + schema: + $ref: '#/components/schemas/RgAuthCtx' + headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nausf-auth//rg-authentications/{authCtxId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request from the AMF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: The UE is not allowed to be authenticated + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: User does not exist in the HPLMN + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + +``` + +``` + + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +/prose-authentications: + post: + security: + - {} + - oAuth2ClientCredentials: + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:prose-authentications + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProSeAuthenticationInfo' + required: true + responses: + '200': + description: Successful authentication with CP-PRUK ID + content: + application/json: + schema: + $ref: '#/components/schemas/ProSeAuthenticationResult' + '201': + description: ProSeAuthenticationCtx + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/ProSeAuthenticationCtx' + headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nausf-auth//prose-authentications/{authCtxId}' + required: true + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +/prose-authentications/{authCtxId}/prose-auth: + post: + +``` + +``` + +operationId: proseAuth +security: +- {} +- oAuth2ClientCredentials: +- nausf-auth +- oAuth2ClientCredentials: +- nausf-auth +- nausf-auth:prose-authentications +parameters: +- name: authCtxId + in: path + required: true + schema: + type: string +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/ProSeEapSession' +responses: +'200': + description: Use to handle or close the EAP session for 5G ProSe Remote UE or a 5G ProSe +End UE +content: + application/json: + schema: + $ref: '#/components/schemas/ProSeEapSession' + application/3gppHal+json: + schema: + type: object + properties: + eapPayload: + $ref: '#/components/schemas/EapPayload' + _links: + type: object + description: 'URI : {eapSessionUri}, a map(list of key-value pairs) where +member serves as key' + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + required: + - eapPayload + - _links +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + +delete: +summary: Deletes the authentication result in the UDM +operationId: DeleteProSeAuthenticationResult +tags: +- Authentication Result Deletion +security: +- {} +- oAuth2ClientCredentials: + +``` + +``` + + - nausf-auth + - oAuth2ClientCredentials: + - nausf-auth + - nausf-auth:prose-authentications +parameters: + - name: authCtxId + in: path + required: true + schema: + type: string +responses: + '204': + description: Expected response to a successful authentication result removal + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nausf-auth: Access to Nausf_UEAuthentication API + nausf-auth:ue-authentications: > + Access to service operations applying to the collection of the ue-authentication + resources and the subresources, i.e. 5g-aka-confirmation and eap-session + nausf-auth:rg-authentications: > + Access to service operations applying to the collection of the rg-authentication + resources + nausf-auth:prose-authentications: > + Access to service operations applying to the collection of the prose-authentication + resources and the subresources, i.e. prose-auth. + +schemas: + AuthenticationInfo: + description: Contains the UE id (i.e. SUCI or SUPI) and the Serving Network Name. + type: object + properties: + supiOrSuci: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupiOrSuci' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + resynchronizationInfo: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ResynchronizationInfo' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + traceData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + udmGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + routingIndicator: + type: string + pattern: '^[0-9]{1,4}$' + cellCagInfo: + type: array + +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/CagId' + minItems: 1 + n5gcInd: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nswoInd: + type: boolean + default: false + disasterRoamingInd: + type: boolean + default: false + onboardingInd: + type: boolean + default: false + aun3Ind: + type: boolean + default: false + required: + - supiOrSuci + - servingNetworkName + + UEAuthenticationCtx: + description: Contains the information related to the resource generated to handle the UE authentication. It contains at least the UE id, Serving Network, the Authentication Method and related EAP information or related 5G-AKA information. + type: object + properties: + authType: + $ref: '#/components/schemas/AuthType' + 5gAuthData: + oneOf: + - $ref: '#/components/schemas/Av5gAka' + - $ref: '#/components/schemas/EapPayload' + _links: + type: object + description: A map(list of key-value pairs) where member serves as key + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + required: + - authType + - 5gAuthData + - _links + + Av5gAka: + description: Contains Authentication Vector for method 5G AKA. + type: object + required: + - rand + - hxresStar + - autn + properties: + rand: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Rand' + hxresStar: + $ref: '#/components/schemas/HxresStar' + autn: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/Autn' + + ConfirmationData: + description: Contains the result of the authentication. + type: object + required: + - resStar + properties: + resStar: + $ref: '#/components/schemas/ResStar' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ConfirmationDataResponse: + description: Contains the result of the authentication + type: object + properties: + +``` + +``` +authResult: + $ref: '#/components/schemas/AuthResult' +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +kseaf: + $ref: '#/components/schemas/Kseaf' +pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 +required: +- authResult + +EapSession: + description: Contains information related to the EAP session. + type: object + properties: + eapPayload: + $ref: '#/components/schemas/EapPayload' + kSeaf: + $ref: '#/components/schemas/Kseaf' + _links: + type: object + description: A map(list of key-value pairs) where member serves as key + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + authResult: + $ref: '#/components/schemas/AuthResult' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 + msk: + $ref: '#/components/schemas/Msk' + required: + - eapPayload + +DeregistrationInfo: + description: Contains the UE id (i.e. SUPI). + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + +RgAuthenticationInfo: + description: Contains the UE id (i.e. SUCI) and the authenticated indication. + type: object + properties: + suci: + $ref: '#/components/schemas/Suci' + authenticatedInd: + type: boolean + default: false + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - suci + - authenticatedInd + +RgAuthCtx: + description: Contains the UE id (i.e. SUPI) and the authentication indication. + type: object + properties: + authResult: + $ref: '#/components/schemas/AuthResult' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + authInd: +``` + +``` + + type: boolean + default: false + required: + - authResult + +AuthResult: + description: Indicates the result of the authentication. + type: string + enum: + - AUTHENTICATION_SUCCESS + - AUTHENTICATION_FAILURE + - AUTHENTICATION_ONGOING + +EapPayload: + type: string + format: byte + description: contains an EAP packet + nullable: true + +Kseaf: + description: Contains the Kseaf. + type: string + pattern: '[A-Fa-f0-9]{64}' + +Msk: + description: Contains the Master Session Key. + type: string + pattern: '[A-Fa-f0-9]{128}' + +ResStar: + description: Contains the RES*. + type: string + pattern: '[A-Fa-f0-9]{32}' + nullable: true + +HxresStar: + description: Contains the HXRES*. + type: string + pattern: "[A-Fa-f0-9]{32}" + +Suci: + description: Contains the SUCI. + type: string + pattern: '^((suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-(0-0-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))-[a-fA-F0-9]+)|.+))$' + +AuthType: + description: Indicates the authentication method used. + anyOf: + - type: string + enum: + - 5G_AKA + - EAP_AKA_PRIME + - EAP_TLS + - EAP_TTLS + - type: string + +ProSeAuthenticationInfo: + description: > + Contains the UE id (i.e. SUCI) or CP-PRUK ID, Relay Service Code and Nonce_1. + type: object + properties: + supiOrSuci: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupiOrSuci' + 5gPrukId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GPrukId' + relayServiceCode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RelayServiceCode' + nonce1: + $ref: '#/components/schemas/Nonce1' + servingNetworkName: + $ref: 'TS29503_Nudm_UEAU.yaml#/components/schemas/ServingNetworkName' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - relayServiceCode + - nonce1 + - servingNetworkName + +``` + +``` +ProSeAuthenticationCtx: + description: Contains the information related to the resource generated to handle the ProSe +authentication. + type: object + properties: + authType: + $ref: '#/components/schemas/AuthType' + _links: + type: object + description: A map(list of key-value pairs) where member serves as key + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + proSeAuthData: + $ref: '#/components/schemas/ProSeAuthData' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - authType + - _links + - proSeAuthData + +ProSeEapSession: + description: Contains information related to the EAP session. If present the 5gPrukId IE shall +carry the CP-PRUK ID. + type: object + properties: + eapPayload: + $ref: '#/components/schemas/EapPayload' + knrProSe: + $ref: '#/components/schemas/KnrProSe' + _links: + type: object + description: A map(list of key-value pairs) where member serves as key + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + authResult: + $ref: '#/components/schemas/AuthResult' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nonce2: + $ref: '#/components/schemas/Nonce2' + 5gPrukId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GPrukId' + required: + - eapPayload + +ProSeAuthData: + description: Represents ProSe authentication related information. + oneOf: + - $ref: '#/components/schemas/EapPayload' + +ProSeAuthenticationResult: + description: Successful authentication for CP-PRUK ID. + type: object + properties: + knrProSe: + $ref: '#/components/schemas/KnrProSe' + nonce2: + $ref: '#/components/schemas/Nonce2' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +KnrProSe: + description: Contains the KNR_ProSe. + type: string + pattern: '[A-Fa-f0-9]{64}' + Nonce1: + type: string + format: byte + description: contains an Nonce1 + nullable: true + + Nonce2: + type: string + format: byte + description: contains an Nonce2 + nullable: true +``` + +## A.3 Nausf\_SoRProtection API + +``` + +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.1 + title: Nausf_SoRProtection Service + description: | + AUSF SoR Protection Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.509 V18.0.0; 5G System; Authentication Server Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' + +servers: + - url: '{apiRoot}/nausf-sorprotection/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nausf-sorprotection + +paths: + /{supi}/ue-sor: + post: + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SorInfo' + required: true + responses: + '200': + description: SorSecurityInfo + content: + application/json: + schema: + $ref: '#/components/schemas/SorSecurityInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nausf-sorprotection: Access to the Nausf_SoRProtection API + schemas: + +# +# COMPLEX TYPES: +# + +SorInfo: + description: Contains the Steering Information. + type: object + properties: + steeringContainer: + $ref: '#/components/schemas/SteeringContainer' + ackInd: + $ref: '#/components/schemas/AckInd' + sorHeader: + $ref: '#/components/schemas/SorHeader' + sorTransparentInfo: + $ref: '#/components/schemas/SorTransparentInfo' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ackInd + +SorSecurityInfo: + description: Contains the material generated for securing of SoR. It contains at least the + SoR-MAC-IAUSF and CounterSoR. + type: object + properties: + sorMacIausf: + $ref: '#/components/schemas/SorMac' + counterSor: + $ref: '#/components/schemas/CounterSor' + sorXmacIue: + $ref: '#/components/schemas/SorMac' + required: + - sorMacIausf + - counterSor + +SteeringContainer: + description: Contains the information sent to UE. + oneOf: + - type: array + items: + $ref: '#/components/schemas/SteeringInfo' + minItems: 1 + - $ref: '#/components/schemas/SecuredPacket' + +SteeringInfo: + description: Contains a combination of one PLMN identity and zero or more access technologies. + type: object + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + accessTechList: + type: array + items: + $ref: '#/components/schemas/AccessTech' + minItems: 1 + required: + - plmnId +``` + +``` + +# +# SIMPLE TYPES: +# + +SorMac: + description: MAC value for protecting SOR procedure (SoR-MAC-IAUSF and SoR-XMAC-IUE). + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +CounterSor: + description: CounterSoR. + type: string + pattern: '^[A-Fa-f0-9]{4}$' + +AckInd: + description: Contains indication whether the acknowledgement from UE is needed. + type: boolean + +SecuredPacket: + description: Contains a secure packet. + type: string + format: byte + +SorHeader: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +SorTransparentInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +# +# ENUMS: + +AccessTech: + description: Represents the access technology + anyOf: + - type: string + enum: + - NR + - EUTRAN_IN_WBS1_MODE_AND_NBS1_MODE + - EUTRAN_IN_NBS1_MODE_ONLY + - EUTRAN_IN_WBS1_MODE_ONLY + - UTRAN + - GSM_AND_ECGSM_IoT + - GSM_WITHOUT_ECGSM_IoT + - ECGSM_IoT_ONLY + - CDMA_1xRTT + - CDMA_HRPD + - GSM_COMPACT + - type: string + +``` + +## A.4 Nausf\_UPUProtection API + +``` + +openapi: 3.0.0 +info: + version: 1.3.0-alpha.1 + title: Nausf_UPUProtection Service + description: | + AUSF UPU Protection Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.509 V18.0.0; 5G System; Authentication Server Services + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.509' + +servers: + - url: '{apiRoot}/nausf-upuprotection/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nausf-upuprotection + +paths: + /{supi}/ue-upu: + post: + parameters: + - name: supi + in: path + description: Identifier of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpuInfo' + required: true + responses: + '200': + description: UpuSecurityInfo + content: + application/json: + schema: + $ref: '#/components/schemas/UpuSecurityInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nausf-upuprotection: Access to the Nausf_UPUProtection API + +schemas: + +# +# COMPLEX TYPES: +# + +UpuInfo: + description: Contains the UE parameters update Information. + type: object + +``` + +``` + +properties: + upuDataList: + type: array + items: + $ref: '#/components/schemas/UpuData' + minItems: 1 + upuHeader: + $ref: '#/components/schemas/UpuHeader' + upuAckInd: + $ref: '#/components/schemas/UpuAckInd' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + upuTransparentInfo: + $ref: '#/components/schemas/UpuTransparentInfo' +required: +- upuDataList +- upuAckInd + +UpuSecurityInfo: + description: Contains the material generated for securing of UPU. It contains at least the +UPU-MAC-IAUSF and CounterUPU. + type: object + properties: + upuMacIausf: + $ref: '#/components/schemas/UpuMac' + counterUpu: + $ref: '#/components/schemas/CounterUpu' + upuXMacIue: + $ref: '#/components/schemas/UpuMac' + required: + - upuMacIausf + - counterUpu + +UpuData: + description: Contains UE parameters update data set (e.g., the updated Routing ID Data or the +Default configured NSSAI). + type: object + properties: + secPacket: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SecuredPacket' + defaultConfNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + routingId: + $ref: 'TS29544_Nspaf_SecuredPacket.yaml#/components/schemas/RoutingId' + +# +# SIMPLE TYPES: +# + +UpuMac: + description: MAC value for protecting UPU procedure (UPU-MAC-IAUSF and UPU-MAC-IUE). + type: string + pattern: '^[A-Fa-f0-9]{32}$' + +CounterUpu: + description: CounterUPU. + type: string + pattern: '^[A-Fa-f0-9]{4}$' + +UpuAckInd: + description: Contains the indication of whether the acknowledgement from UE is needed. + type: boolean + +UpuHeader: + description: Contains the "UPU Header" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 +(octet 4), encoded as 2 hexadecimal characters. + type: string + pattern: '^[A-Fa-f0-9]{2}$' + +UpuTransparentInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +``` + +# Annex B (Informative): Use of EAP-TLS + +## B.1 General + +The Annex B of 3GPP TS 33.501 [8] describes the use of EAP-TLS as an alternative authentication method in the case of private network. This annex describes corresponding stage 3. + +## B.2 EAP method: EAP-TLS + +EAP-TLS as defined in IETF RFC 5216 [16] is the EAP method used in this procedure. This procedure is described in Annex B.2.1 of 3GPP TS 33.501 [8]. + +![Sequence diagram showing the EAP method interaction between NF Service Consumer and AUSF.](afd9ce64c136f2090b978ea5f3ef9d8d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant AUSF + Note left of NF Service Consumer: NF Service Consumer + Note right of AUSF: AUSF + NF Service Consumer->>AUSF: 1. POST ../ue-authentications (AuthenticationInfo) + AUSF-->>NF Service Consumer: 2a. 201 Created (UEAuthCtx) + Note right of AUSF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer->>AUSF: 3. POST ../ue-authentications/{authCtxId}/eap-session (EapSession) + AUSF-->>NF Service Consumer: 4a. 200 OK (EapSession) + Note right of AUSF: 4b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer->>AUSF: 5. POST ../ue-authentications/{authCtxId}/eap-session (EapSession) + AUSF-->>NF Service Consumer: 6a. 200 OK (EapSession) + Note right of AUSF: 6b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer->>AUSF: 7. POST ../ue-authentications/{authCtxId}/eap-session (EapSession) + AUSF-->>NF Service Consumer: 8a. 200 OK (EapSession) + Note right of AUSF: 8b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the EAP method interaction between NF Service Consumer and AUSF. + +Figure B.2-1: EAP method + +1. The NF Service Consumer (AMF) shall send a POST request to the AUSF. The content shall contain at least the UE Id and Serving Network Name. +- 2a. On success, "201 Created" shall be returned. The content shall contain the representation of the resource generated and the "Location" header shall contain the URI of the generated resource (e.g. `../ue_authentications/{authCtxId}/eap-session`). The AUSF generates a sub-resource "eap-session". The AUSF shall provide a hypermedia link towards this sub-resource in the content to indicate to the AMF where it shall send a POST containing the EAP packet response. The content shall also contain the EAP packet EAP-Request/EAP-Type=EAP-TLS (TLS Start) +- 2b. On failure or redirection, one of the HTTP status code listed in table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in + +Table 6.1.7.3-1. In particular, if the serving network is not authorized, the AUSF shall use the "Cause" `SERVING_NETWORK_NOT_AUTHORIZED`. + +3. Based on the relation type, the NF Service Consumer (AMF) shall send a POST request including the EAP-Response/EAP-Type=EAP-TLS (TLS client\_hello) received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF). +- 4a. On success, the AUSF shall reply with a "200 OK" HTTP message containing the EAP Request as described in Annex B.2.1 of 3GPP TS 33.501 [8] and a hypermedia link towards the sub-resource "eap-session". +- 4b. On failure or redirection, one of the HTTP status code listed in table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. +5. The NF Service Consumer (AMF) shall send a POST request including the EAP Response received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF). +- 6a. On success, the AUSF shall reply with a "200 OK" HTTP message containing the EAP Request as described in Annex B.2.1 of 3GPP TS 33.501 [8] and a hypermedia link towards the sub-resource "eap-session". +- 6b. On failure or redirection, one of the HTTP status code listed in table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. +7. The NF Service Consumer (AMF) shall send a POST request including the EAP Response received from the UE. The POST request is sent to the URI provided by the AUSF or derived by the NF Service Consumer (AMF). +- 8a. If the EAP authentication exchange is successfully completed (with or without the optional Notification Request/Response messages exchange), "200 OK" shall be returned to the NF Service Consumer (AMF). The content shall contain the result of the authentication, an EAP success/failure and the Kseaf if the authentication is successful. +- 8b. On failure or redirection, one of the HTTP status code listed in table 6.1.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. + +# Annex C (informative): Withdrawn API versions + +## C.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## C.2 Nausf\_SoRProtection API + +The API versions listed in table C.2-1 are withdrawn for the Nausf\_SoRProtection API. + +**Table C.2-1: Withdrawn API versions of the Nausf\_SoRProtection service** + +| API version number | Reason for withdrawal | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1.0.0 | The version 1.0.0 indicates that a 201 "Created" must be sent in response to the POST Custom Operations while it should be a "200 OK" as indicated in clause 6.2.3.2.4.2.2. The version 1.0.1 corrects this mistake. As a consequence, the version 1.0.0 is withdrawn in order to avoid interoperability problems with further version of the Nausf_SoRProtection service. | + +# --- Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | Tdoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175268 | | | | Initial Draft.(Agreed Skeleton) | 0.1.0 | +| 2017-10 | CT4#80 | C4-175394 | | | | Inclusion of pCR agreed during CT4#80: C4-175269 and C4-175270 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176437 | | | | Inclusion of pCR agreed during CT4#81: C4-176267, C4-176269, C4-176426, C4-17427 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181391 | | | | Inclusion of pCR agreed during CT4#82: C4-181341, C4-181342, C4-181343, C4-181344, C4-181345, C4-181346, C4-181347, C4-181155 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182434 | | | | Inclusion of pCRs agreed during CT4#83: C4-182283 and C4-182279 | 0.5.0 | +| 2018-03 | CT#79 | CP-180031 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183516 | | | | Inclusion of pCRs agreed during CT4#84: C4-183309, C4-183313, C4-183346, C4-183347 and C4-183448 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184623 | | | | Inclusion of pCRs agreed during CT4#83: C4-184219, C4-184220, C4-184224, C4-184227, C4-184227, C4-184362, C4-184363, C4-184367, C4-184368, C4-184370, C4-184376, C4-184380, C4-184584, C4-184624 | 1.2.0 | +| 2018-06 | CT#80 | CP-181104 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182059 | 0002 | 2 | F | Requester ID in Authentication Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0003 | 1 | F | HTTP method in figure 5.2.2.2.2-1 (Note: clause 6.1.3.1 is not included, already covered) | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0004 | 4 | F | SoRProtection service operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0010 | 1 | F | Adding TS 33.501 reference | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0011 | - | F | HTTP Custom Header | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0013 | 1 | F | SUPI sends to AMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0014 | 2 | B | 5G Trace for AUSF | 15.1.0 | +| 2018-09 | CT#81 | CP-182013 | 0015 | 2 | F | Making Oauth 2.0 optional in OAS description | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0016 | 1 | F | Editorial Corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0017 | 1 | F | Error code correction | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0018 | 1 | F | Add support to EAP-TLS (Optional) | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0019 | - | F | Correcting Presentation of resources for AUSF API | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0020 | 1 | F | Correcting confirmation message | 15.1.0 | +| 2018-09 | CT#81 | CP-182059 | 0021 | - | F | API version number update | 15.1.0 | +| 2018-12 | CT#82 | CP-183017 | 0026 | - | F | Remove the "supiOrSuci" in Confirmation Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0027 | - | F | Correcting Resource URI structure of the SoRProtection Service | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0030 | - | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0031 | - | F | Add supi and authResult to EapSession in OpenAPI definitions | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0022 | - | F | Requester ID not needed in initial request from AMF | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0023 | - | F | Delaying transmission of Kseaf | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0024 | 1 | F | Correcting the reference to EAP-AKA' | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0025 | 1 | F | Adding a reference to the Annex in the Specification | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0028 | 1 | F | Error handling in AUSF | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0029 | 1 | F | Add a reference to the IETF RFC 3748 on EAP Framework | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0032 | - | F | Base64 reference | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0033 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0034 | - | F | Reference correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0036 | - | F | OpenAPI version number for Nausf_UEAuthentication service | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0037 | 1 | F | OpenAPI version number for Nausf_SoRProtection | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0038 | 1 | F | Correct "externalDocs" for Nausf_UEAuthentication OAS | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0039 | 1 | F | Clarification on the 200 OK returned by AUSF in case of authentication failure | 15.2.0 | +| 2018-12 | CT#82 | CP-183017 | 0040 | - | F | Secured packet in SORInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183170 | 0035 | 2 | | Location Header in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183172 | 0041 | - | F | Alignment for Oauth scopes - Nausf_UEAuthentication | 15.2.0 | +| 2018-12 | CT#82 | CP-183173 | 0042 | - | F | Alignment for Oauth scopes - Nausf_SoRProtection | 15.2.0 | +| 2018-12 | CT#82 | CP-183203 | 0043 | - | F | externalDocs for Nausf_SoRProtection OpenAPI Annex | 15.2.0 | +| 2019-03 | CT#83 | CP-190022 | 0047 | 1 | F | Mandatory HTTP status codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190022 | 0049 | 1 | F | SoR Protection response code alignment | 15.3.0 | +| 2019-03 | CT#83 | CP-190022 | 0044 | 3 | F | Authentication Failure scenarios | 15.3.0 | +| 2019-03 | CT#83 | CP-190153 | 0046 | 7 | F | UE parameters update support (indicated as C4-190618 + C4-190618_rev7l) | 15.3.0 | +| 2019-03 | CT#83 | CP-19205 | 0050 | 1 | F | 3GPP TS 29.509 API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191033 | 0051 | - | F | Correct the expression of URI variables in 5g-aka-confirmation resource | 15.4.0 | +| 2019-06 | CT#84 | CP-191033 | 0053 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191033 | 0056 | - | F | AUSF Tracing Targeting a PEI | 15.4.0 | +| 2019-06 | CT#84 | CP-191033 | 0055 | 1 | F | Determination of the Authentication Method | 15.4.0 | +| 2019-06 | CT#84 | CP-191218 | 0059 | 4 | F | Add withdrawn API version Annex | 15.4.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|---------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191033 | 0058 | 1 | F | Essential correction to add Copyright on OpenAPI specifications | 15.4.0 | +| 2019-06 | CT#84 | CP-191057 | 0054 | 1 | F | Non cacheable 501 response | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0057 | 1 | B | UDM service discovery based on GroupID and/or RoutingID | 16.0.0 | +| 2019-06 | CT#84 | CP-191223 | 0060 | 2 | F | 3GPP TS 29.509 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192106 | 0063 | 1 | F | Missing status codes | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0066 | - | F | API version and ExternalDocs update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193063 | 0072 | - | F | Add UPU protection in AUSF functionality | 16.2.0 | +| 2019-12 | CT#86 | CP-193058 | 0067 | 1 | B | RoutingId | 16.2.0 | +| 2019-12 | CT#86 | CP-193134 | 0069 | 2 | B | Authentication Indication from W-AGF (tmp) | 16.2.0 | +| 2019-12 | CT#86 | CP-193241 | 0071 | 2 | F | Move ExternalDocs in OpenAPI specifications | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0068 | 1 | F | EAP Payload | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0070 | 1 | F | Add reference to TS 29.524 | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0074 | - | F | 3GPP TS 29.509 API version update | 16.2.0 | +| 2020-03 | CT#87-e | CP-200020 | 0076 | 1 | F | Reference to Data Type SteeringInfo | 16.3.0 | +| 2020-03 | CT#87-e | CP-200242 | 0082 | - | F | Initial Registration procedure on a CAG Cell | 16.3.0 | +| 2020-03 | CT#87-e | CP-200039 | 0075 | 1 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87-e | CP-200039 | 0077 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87-e | CP-200035 | 0078 | 2 | F | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87-e | CP-200035 | 0081 | 1 | F | SUPI pattern | 16.3.0 | +| 2020-03 | CT#87-e | CP-200242 | 0083 | 1 | F | AUSF service update for the authentication result removal | 16.3.0 | +| 2020-03 | CT#87-e | CP-200020 | 0079 | 2 | F | Optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87-e | CP-200052 | 0084 | - | F | 3GPP TS 29.509 Rel16 API version and External doc update | 16.3.0 | +| 2020-03 | CT#87-e | CP-200252 | 0085 | - | F | OTAF NF name change to SP-AF | 16.3.0 | +| 2020-06 | CT#88-e | CP-201034 | 0093 | - | D | Editorial Clarifications | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0095 | - | B | Maintain only latest Kausf in network | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0096 | - | F | AUSF service update for the authentication result removal | 16.4.0 | +| 2020-06 | CT#88-e | CP-201034 | 0097 | - | F | Miscellaneous Corrections | 16.4.0 | +| 2020-06 | CT#88-e | CP-201048 | 0094 | 1 | B | N5GC device Authentication | 16.4.0 | +| 2020-06 | CT#88-e | CP-201063 | 0086 | 1 | F | Supported Headers Tables for Response code 201 | 16.4.0 | +| 2020-06 | CT#88-e | CP-201063 | 0091 | 1 | F | Datatype column in Resource URI variables Table | 16.4.0 | +| 2020-06 | CT#88-e | CP-201063 | 0092 | 1 | F | Add custom operation Name | 16.4.0 | +| 2020-06 | CT#88-e | CP-201063 | 0088 | 2 | F | Editorial Error Corrections | 16.4.0 | +| 2020-06 | CT#88-e | CP-201073 | 0098 | - | F | 29.509 Rel16 API version and External doc update | 16.4.0 | +| 2020-09 | CT#89-e | CP-202088 | 0100 | - | F | Custom Operation Correction | 16.5.0 | +| 2020-09 | CT#89-e | CP-202043 | 0103 | - | F | SoR Header | 16.5.0 | +| 2020-09 | CT#89-e | CP-202115 | 0104 | - | F | Corrections on SoRProtection service | 16.5.0 | +| 2020-09 | CT#89-e | CP-202110 | 0105 | - | F | Corrections on UPUProtection service | 16.5.0 | +| 2020-09 | CT#89-e | CP-202089 | 0101 | 1 | F | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-12 | CT#90-e | CP-203042 | 0110 | 2 | F | Initial Registration procedure on a CAG Cell | 16.6.0 | +| 2020-12 | CT#90-e | CP-203036 | 0111 | - | F | API Version and External Doc Update (R16) | 16.6.0 | +| 2020-12 | CT#90-e | CP-203063 | 0108 | 1 | C | Evolution of SoR delivery mechanism – AUSF API Changes | 17.0.0 | +| 2020-12 | CT#90-e | CP-203055 | 0112 | - | F | API Version and External Doc Update (R17) | 17.0.0 | +| 2021-02 | | | | | | Clauses 5.2.2.X/5.2.2.X.1 numbered correctly | 17.0.1 | +| 2021-03 | CT#91-e | CP-210021 | 0114 | - | D | Miscellaneous Corrections | 17.1.0 | +| 2021-03 | CT#91-e | CP-210029 | 0121 | - | F | 29.509 Rel-17 API version and External Doc update | 17.1.0 | +| 2021-03 | CT#91-e | CP-210034 | 0120 | 1 | F | OpenAPI Reference and description field for map data types | 17.1.0 | +| 2021-03 | CT#91-e | CP-210037 | 0119 | 1 | F | HTTP 3xx redirection | 17.1.0 | +| 2021-06 | CT#92-e | CP-211028 | 0123 | - | F | Data Types Descriptions | 17.2.0 | +| 2021-06 | CT#92-e | CP-211028 | 0125 | 1 | F | Resource for Individual Authentication | 17.2.0 | +| 2021-06 | CT#92-e | CP-211046 | 0124 | - | F | Data Type Correction | 17.2.0 | +| 2021-06 | CT#92-e | CP-211050 | 0126 | - | F | 29.509 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93-e | CP-212082 | 0130 | 1 | A | UPU Header within UPU Data Protection | 17.3.0 | +| 2021-09 | CT#93-e | CP-212026 | 0131 | - | F | Base64 Encoding of binary attributes in JSON objects | 17.3.0 | +| 2021-09 | CT#93-e | CP-212059 | 0132 | - | F | 29.509 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94-e | CP-213085 | 0135 | - | F | Feature numbering | 17.4.0 | +| 2021-12 | CT#94-e | CP-213085 | 0136 | - | F | Corrections to the API URI | 17.4.0 | +| 2021-12 | CT#94-e | CP-213087 | 0138 | - | F | Corrections related to the description fields in the OpenAPI descriptions | 17.4.0 | +| 2022-03 | CT#95-e | CP-220026 | 0149 | - | F | Routing Indicator | 17.5.0 | +| 2022-03 | CT#95-e | CP-220047 | 0141 | - | F | SNPN onboarding impacts on AUSF services – R17 | 17.5.0 | +| 2022-03 | CT#95-e | CP-220047 | 0152 | - | B | EAP-TTLS support in SNPN (TS 29.509) | 17.5.0 | +| 2022-03 | CT#95-e | CP-220047 | 0144 | 3 | B | PVS Info | 17.5.0 | +| 2022-03 | CT#95-e | CP-220053 | 0143 | 1 | B | NSWO authentication | 17.5.0 | +| 2022-03 | CT#95-e | CP-220069 | 0151 | - | A | 307/308 redirection | 17.5.0 | +| 2022-03 | CT#95-e | CP-220066 | 0155 | - | F | 29.509 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221039 | 0162 | 1 | B | UPU Transparent Container | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0157 | - | F | Correction of typos in description fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221039 | 0158 | - | B | Disaster Roaming Indicator | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0161 | - | B | Overview of New ProseAuthenticate service operation | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221043 | 0160 | 1 | B | New ProseAuthenticate service operation | 17.6.0 | +| 2022-06 | CT#96 | CP-221053 | 0159 | - | F | Reused data types | 17.6.0 | +| 2022-06 | CT#96 | CP-221053 | 0164 | - | F | Editorial corrections | 17.6.0 | +| 2022-06 | CT#96 | CP-221056 | 0163 | 1 | A | IETF has published RFC 9048 | 17.6.0 | +| 2022-06 | CT#96 | CP-221338 | 0168 | 1 | F | 29.509 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0170 | - | F | Description alignment with yaml | 17.7.0 | +| 2022-09 | CT#97 | CP-222034 | 0171 | 1 | F | MSK in EapSession | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0172 | - | F | 5G ProSe Authentication Service Description Alignment | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0173 | 1 | F | 5G ProSe Authentication API Update | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0174 | 1 | F | Resolve EN For 5G AKA support | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0169 | - | F | PVS related alignment | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0176 | - | F | 29.509 Rel-17 API version and External doc update | 17.7.0 | +| 2022-12 | CT#98 | CP-223049 | 0180 | - | F | UE onboarding in authentication request | 17.8.0 | +| 2022-12 | CT#98 | CP-223054 | 0185 | 1 | F | Update on Nausf_UEAuthentication_Authenticate service operation | 17.8.0 | +| 2022-12 | CT#98 | CP-223054 | 0179 | 1 | F | 5GPRUK Name Alignment | 17.8.0 | +| 2022-12 | CT#98 | CP-223027 | 0178 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0186 | - | F | 29.509 Rel-18 API version and External doc update | 18.0.0 | +| 2022-12 | CT#98 | CP-223063 | 0181 | 1 | F | boolean type IEs definition correction | 18.0.0 | +| 2022-12 | CT#98 | CP-223063 | 0182 | 1 | D | Editorial corrections | 18.0.0 | +| 2023-06 | CT#100 | CP-231346 | 0191 | 1 | B | OAuth2 scopes in the Nausf_UEAuthentication API | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0189 | 3 | F | Location header description | 18.1.0 | +| 2023-06 | CT#100 | CP-231041 | 0195 | 1 | B | Update the reference model | 18.1.0 | +| 2023-06 | CT#100 | CP-231078 | 0194 | - | A | Add serving network name in ProSeAuthenticationInfo | 18.1.0 | +| 2023-06 | CT#100 | CP-231345 | 0198 | - | F | 29.509 Rel-18 API version and External doc update | 18.1.0 | +| 2023-09 | CT#101 | CP-232033 | 0202 | - | F | Adding the missing description fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232056 | 0199 | - | B | Authentication of AUN3 devices behind RG | 18.2.0 | +| 2023-09 | CT#101 | CP-232056 | 0200 | 1 | B | Update the description of MSK to support authentication for AUN3 devices behind 5G-RG | 18.2.0 | +| 2023-09 | CT#101 | CP-232060 | 0203 | - | F | 29.509 Rel-18 API version and External doc update | 18.2.0 | +| 2023-12 | CT#102 | CP-233027 | 0204 | - | F | HTTP RFC obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0207 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233055 | 0206 | 1 | B | Enhancement to support UE-to-UE relay | 18.3.0 | +| 2023-12 | CT#102 | CP-233060 | 0208 | - | F | 29.509 Rel-18 API version and External doc update | 18.3.0 | \ No newline at end of file diff --git a/gsma/29_series/29512/raw.md b/gsma/29_series/29512/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e614617a71aba759aefd5a622a983de41ab677bd --- /dev/null +++ b/gsma/29_series/29512/raw.md @@ -0,0 +1,11593 @@ + + +# 3GPP TS 29.512 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Policy Control Service; Stage 3 (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +--- + +## Keywords + +## **3GPP** + +## Postal address + +3GPP support office address +650 Route des Lucioles – Sophia Antipolis +Valbonne – FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet + + + +# Contents + +| | | +|-------------------------------------------------------------------------------------|----| +| Foreword..... | 11 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions, symbols and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 16 | +| 4 Npcf_SMPolicyControl Service..... | 17 | +| 4.1 Service Description..... | 17 | +| 4.1.1 Overview..... | 17 | +| 4.1.2 Service Architecture..... | 18 | +| 4.1.3 Network Functions..... | 18 | +| 4.1.3.1 Policy Control Function (PCF)..... | 18 | +| 4.1.3.2 NF Service Consumers..... | 19 | +| 4.1.4 Rules..... | 20 | +| 4.1.4.1 General..... | 20 | +| 4.1.4.2 PCC rules..... | 20 | +| 4.1.4.2.1 PCC rules definition..... | 20 | +| 4.1.4.2.2 PCC rules operation..... | 24 | +| 4.1.4.3 Session rule..... | 25 | +| 4.1.4.3.1 Session rules definition..... | 25 | +| 4.1.4.3.2 Session rules operation..... | 25 | +| 4.1.4.4 Policy Decision types..... | 25 | +| 4.1.4.4.1 General..... | 25 | +| 4.1.4.4.2 Traffic control data definition..... | 25 | +| 4.1.4.4.3 QoS data definition..... | 26 | +| 4.1.4.4.4 Charging data definition..... | 27 | +| 4.1.4.4.5 UsageMonitoring data definition..... | 27 | +| 4.1.4.4.6 QoS Monitoring data definition..... | 28 | +| 4.1.5 Policy control request trigger..... | 28 | +| 4.1.6 Requested rule data..... | 29 | +| 4.1.7 Requested usage data..... | 29 | +| 4.1.8 Condition data..... | 29 | +| 4.2 Service Operations..... | 29 | +| 4.2.1 Introduction..... | 29 | +| 4.2.2 Npcf_SMPolicyControl_Create Service Operation..... | 30 | +| 4.2.2.1 General..... | 30 | +| 4.2.2.2 SM Policy Association establishment..... | 31 | +| 4.2.2.3 Provisioning of charging related information for PDU session..... | 34 | +| 4.2.2.3.1 Provisioning of Charging Addresses..... | 34 | +| 4.2.2.3.2 Provisioning of Default Charging Method..... | 35 | +| 4.2.2.4 Provisioning of revalidation time..... | 36 | +| 4.2.2.5 Policy provisioning and enforcement of authorized AMBR per PDU session..... | 36 | + +# Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|------------|---------------------------------------------------------------------------------------------------------------------------------------|----| +| 4.2.2.6 | Policy provisioning and enforcement of authorized default QoS..... | 37 | +| 4.2.2.7 | Provisioning of PCC rule for Application Detection and Control..... | 37 | +| 4.2.2.8 | 3GPP PS Data Off Support..... | 37 | +| 4.2.2.9 | IMS Emergency Session Support..... | 38 | +| 4.2.2.10 | Request Usage Monitoring Control..... | 39 | +| 4.2.2.11 | Access Network Charging Identifier report..... | 39 | +| 4.2.2.12 | Request for the successful resource allocation notification..... | 39 | +| 4.2.2.13 | Request of Presence Reporting Area Change Report..... | 39 | +| 4.2.2.14 | Provisioning of IP Index Information..... | 39 | +| 4.2.2.15 | Negotiation of the QoS flow for IMS signalling..... | 39 | +| 4.2.2.16 | PCF resource cleanup..... | 40 | +| 4.2.2.17 | Access traffic steering, switching and splitting support..... | 40 | +| 4.2.2.18 | DNN Selection Mode Support..... | 41 | +| 4.2.2.19 | Detection of the SM Policy Association enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking..... | 41 | +| 4.2.2.20 | Support of Dual Connectivity end to end redundant User Plane paths..... | 42 | +| 4.2.2.21 | User Plane Remote Provisioning of UE SNPN Credentials in Onboarding Network..... | 42 | +| 4.2.2.22 | Network slice related data rate policy control..... | 43 | +| 4.2.2.23 | Group related data rate policy control..... | 43 | +| 4.2.2.24 | Network slice usage control..... | 43 | +| 4.2.3 | Npcf_SMPolicyControl_UpdateNotify Service Operation..... | 43 | +| 4.2.3.1 | General..... | 43 | +| 4.2.3.2 | SM Policy Association Update request..... | 44 | +| 4.2.3.3 | SM Policy Association termination request..... | 46 | +| 4.2.3.4 | Provisioning of revalidation time..... | 47 | +| 4.2.3.5 | Policy provisioning and enforcement of authorized AMBR per PDU session..... | 47 | +| 4.2.3.6 | Policy provisioning and enforcement of authorized default QoS..... | 47 | +| 4.2.3.7 | Provisioning of PCC rule for Application Detection and Control..... | 48 | +| 4.2.3.8 | 3GPP PS Data Off Support..... | 48 | +| 4.2.3.9 | IMS Emergency Session Support..... | 48 | +| 4.2.3.9.1 | Provisioning of PCC rule..... | 48 | +| 4.2.3.9.2 | Removal of PCC Rules for Emergency Services..... | 49 | +| 4.2.3.10 | Request of Access Network Information..... | 49 | +| 4.2.3.11 | Request Usage Monitoring Control..... | 49 | +| 4.2.3.12 | Ipv6 Multi-homing support..... | 49 | +| 4.2.3.13 | Request for the result of PCC rule removal..... | 49 | +| 4.2.3.14 | Access Network Charging Identifier request..... | 50 | +| 4.2.3.15 | Request for the successful resource allocation notification..... | 50 | +| 4.2.3.16 | PCC Rule Error Report..... | 50 | +| 4.2.3.17 | IMS Restoration Support..... | 50 | +| 4.2.3.18 | P-CSCF Restoration Enhancement Support..... | 51 | +| 4.2.3.19 | Request of Presence Reporting Area Change Report..... | 51 | +| 4.2.3.20 | Session Rule Error Report..... | 51 | +| 4.2.3.21 | Access traffic steering, switching and splitting support..... | 51 | +| 4.2.3.22 | Policy provisioning and enforcement of the AF session with required QoS..... | 52 | +| 4.2.3.23 | Forwarding of TSC user plane node management information and port management information received from the TSN AF or TSCTSF..... | 52 | +| 4.2.3.24 | Provisioning of TSCAI input information and TSC QoS related data..... | 53 | +| 4.2.3.25 | Policy provisioning of QoS Monitoring control..... | 55 | +| 4.2.3.25.1 | General..... | 55 | +| 4.2.3.25.2 | QoS Monitoring when dynamic Satellite Backhaul is used..... | 58 | +| 4.2.3.26 | Policy decision error handling..... | 58 | +| 4.2.3.26.1 | Policy decision types and condition data error handling..... | 58 | +| 4.2.3.26.2 | Policy decision types, condition data and other policy decisions error handling..... | 59 | +| 4.2.3.27 | Network slice related data rate policy control..... | 60 | +| 4.2.3.28 | Group related data rate policy control..... | 60 | +| 4.2.3.29 | Policy provisioning of Traffic Parameter to be measured..... | 60 | +| 4.2.3.30 | Network slice usage control..... | 60 | +| 4.2.4 | Npcf_SMPolicyControl_Update Service Operation..... | 60 | +| 4.2.4.1 | General..... | 60 | +| 4.2.4.2 | Requesting the update of the Session Management related policies..... | 62 | + +| | | | +|--------------|----------------------------------------------------------------------------------------------|-----| +| 4.2.4.3 | Request the policy based on revalidation time..... | 65 | +| 4.2.4.4 | Policy provisioning and enforcement of authorized AMBR per PDU session..... | 65 | +| 4.2.4.5 | Policy provisioning and enforcement of authorized default QoS..... | 66 | +| 4.2.4.6 | Application detection information reporting..... | 66 | +| 4.2.4.7 | Indication of QoS Flow Termination Implications..... | 67 | +| 4.2.4.8 | 3GPP PS Data Off Support..... | 68 | +| 4.2.4.9 | Request and Report of Access Network Information..... | 69 | +| 4.2.4.10 | Request Usage Monitoring Control and Reporting Accumulated Usage..... | 69 | +| 4.2.4.10.1 | General..... | 69 | +| 4.2.4.10.2 | PCC Rule Removal..... | 70 | +| 4.2.4.11 | Ipv6 Multi-homing support..... | 71 | +| 4.2.4.12 | Request and report for the result of PCC rule removal..... | 71 | +| 4.2.4.13 | Access Network Charging Identifier request and report..... | 72 | +| 4.2.4.14 | Request and report for the successful resource allocation notification..... | 72 | +| 4.2.4.15 | PCC Rule Error Report..... | 72 | +| 4.2.4.16 | Presence Reporting Area Information Report..... | 73 | +| 4.2.4.17 | UE initiates a resource modification support..... | 73 | +| 4.2.4.18 | Trace Control..... | 75 | +| 4.2.4.19 | Negotiation of the QoS flow for IMS signalling..... | 75 | +| 4.2.4.20 | Notification about Service Data Flow QoS target enforcement..... | 75 | +| 4.2.4.21 | Session Rule Error Report..... | 77 | +| 4.2.4.22 | Request the termination of SM Policy association..... | 77 | +| 4.2.4.23 | Reporting of TSC user plane node management information and port management information..... | 77 | +| 4.2.4.24 | Notification about Service Data Flow QoS Monitoring..... | 78 | +| 4.2.4.25 | Access traffic steering, switching and splitting support..... | 79 | +| 4.2.4.26 | Policy decision error handling..... | 80 | +| 4.2.4.26.1 | Policy decision types and condition data error handling..... | 80 | +| 4.2.4.26.2 | Policy decision types, condition data and other policy decisions error handling..... | 80 | +| 4.2.4.27 | Policy Control for DDN Events..... | 80 | +| 4.2.4.28 | Network slice related data rate policy control..... | 82 | +| 4.2.4.29 | Group related data rate policy control..... | 82 | +| 4.2.4.30 | Notification on network provided BAT Offset policy control trigger..... | 82 | +| 4.2.4.31 | Network slice usage control..... | 83 | +| 4.2.5 | Npcf_SMPolicyControl_Delete Service Operation..... | 83 | +| 4.2.5.1 | General..... | 83 | +| 4.2.5.2 | SM Policy Association termination..... | 83 | +| 4.2.5.3 | Report Accumulated Usage..... | 84 | +| 4.2.5.4 | Report Access Network Information..... | 84 | +| 4.2.5.5 | Void..... | 85 | +| 4.2.5.6 | Network slice related data rate policy control..... | 85 | +| 4.2.5.7 | Group related data rate policy control..... | 85 | +| 4.2.6 | Provisioning and Enforcement of Policy Decisions..... | 85 | +| 4.2.6.1 | General..... | 85 | +| 4.2.6.2 | PCC Rules..... | 87 | +| 4.2.6.2.1 | Overview..... | 87 | +| 4.2.6.2.2 | Gate Function..... | 89 | +| 4.2.6.2.3 | Policy enforcement for authorized QoS per PCC Rule..... | 90 | +| 4.2.6.2.4 | Redirect Function..... | 90 | +| 4.2.6.2.5 | Usage Monitoring Control..... | 91 | +| 4.2.6.2.6 | Traffic Steering Control support..... | 91 | +| 4.2.6.2.6.1 | Steering the traffic in the N6-LAN or steering the 5G-LAN type of services..... | 91 | +| 4.2.6.2.6.2 | Steering the traffic to a local access of the data network..... | 92 | +| 4.2.6.2.7 | Conditioned PCC rule..... | 95 | +| 4.2.6.2.8 | PCC rule for resource sharing..... | 97 | +| 4.2.6.2.9 | Resource reservation for services sharing priority..... | 97 | +| 4.2.6.2.10 | PCC rule bound to the default QoS flow..... | 99 | +| 4.2.6.2.11 | PCC rule for Application Detection and Control..... | 99 | +| 4.2.6.2.12 | Provisioning of PCC Rules for Multimedia Priority Services..... | 100 | +| 4.2.6.2.12.1 | General..... | 100 | +| 4.2.6.2.12.2 | Invocation/Revocation of Priority PDU connectivity services..... | 101 | +| 4.2.6.2.12.3 | Invocation/Revocation of IMS Multimedia Priority Services..... | 101 | + +| | | | +|--------------|---------------------------------------------------------------------------------------------------|-----| +| 4.2.6.2.12.4 | Invocation/Revocation of MPS for DTS..... | 102 | +| 4.2.6.2.13 | Sponsored Data Connectivity..... | 102 | +| 4.2.6.2.14 | Support for PCC rule versioning..... | 103 | +| 4.2.6.2.15 | Background data transfer support..... | 104 | +| 4.2.6.2.16 | Number of supported packet filter for signalled QoS rule limitation support..... | 104 | +| 4.2.6.2.17 | Access traffic steering, switching and splitting support..... | 104 | +| 4.2.6.2.18 | Void..... | 109 | +| 4.2.6.2.19 | Provisioning of PCC Rules for Mission Critical Services..... | 109 | +| 4.2.6.2.19.1 | General..... | 109 | +| 4.2.6.2.19.2 | Invocation/Revocation of Priority PDU connectivity services..... | 109 | +| 4.2.6.2.19.3 | Invocation/Revocation of IMS Mission Critical Services..... | 110 | +| 4.2.6.2.20 | PCC rules authorization with preliminary service information..... | 110 | +| 4.2.6.2.21 | Policy Control for L4S..... | 111 | +| 4.2.6.2.22 | UL/DL policy control based on Round-Trip latency requirements..... | 112 | +| 4.2.6.2.23 | Policy Decision for AF requested QoS for a UE or group of UEs not identified by a UE address..... | 112 | +| 4.2.6.3 | Session Rules..... | 113 | +| 4.2.6.3.1 | Overview..... | 113 | +| 4.2.6.3.2 | Conditioned Session rule..... | 113 | +| 4.2.6.3.2.1 | General..... | 113 | +| 4.2.6.3.2.2 | Time conditioned authorized Session-AMBR..... | 115 | +| 4.2.6.3.2.3 | Time conditioned authorized default QoS..... | 115 | +| 4.2.6.3.2.4 | Access type conditioned authorized Session-AMBR..... | 115 | +| 4.2.6.3.3 | Provisioning of authorized default QoS..... | 116 | +| 4.2.6.3.4 | Access traffic steering, switching and splitting support..... | 116 | +| 4.2.6.3.5 | Usage Monitoring Control..... | 116 | +| 4.2.6.4 | Policy control request triggers..... | 117 | +| 4.2.6.5 | Encoding of the request of information reporting..... | 117 | +| 4.2.6.5.1 | Request of Access Network Charging Identifier..... | 117 | +| 4.2.6.5.2 | RAN NAS Cause Support..... | 117 | +| 4.2.6.5.3 | Provisioning of the Usage Monitoring Control Policy..... | 117 | +| 4.2.6.5.3.1 | General..... | 117 | +| 4.2.6.5.3.2 | Disabling Usage Monitoring..... | 119 | +| 4.2.6.5.3.3 | PCF Requested Usage Report..... | 120 | +| 4.2.6.5.4 | Request for Access Network Information..... | 120 | +| 4.2.6.5.5 | Request for the successful resource allocation notification..... | 120 | +| 4.2.6.5.6 | Provisioning of Presence Reporting Area Information..... | 120 | +| 4.2.6.5.7 | Policy provisioning and enforcement of reflective QoS..... | 121 | +| 4.2.6.6 | Authorized QoS..... | 122 | +| 4.2.6.6.1 | General..... | 122 | +| 4.2.6.6.2 | Policy provisioning and enforcement of authorized QoS per service data flow..... | 123 | +| 4.2.6.6.3 | Policy provisioning and enforcement of authorized explicitly signalled QoS Characteristics..... | 124 | +| 4.2.6.7 | Monitoring the data rate per network slice for a UE..... | 124 | +| 4.2.6.8 | Network slice related data rate policy control..... | 125 | +| 4.2.6.8.1 | General..... | 125 | +| 4.2.6.8.2 | PCF-based network slice data rate policy control by using QoS parameters..... | 126 | +| 4.2.6.8.3 | Network slice data rate policy control with assistance of the NWDAF..... | 127 | +| 4.2.6.9 | Group related data rate policy control..... | 128 | +| 4.2.6.9.1 | General..... | 128 | +| 4.2.6.10 | Policy Provisioning for eXtended Reality and Interactive Media Services..... | 128 | +| 4.2.6.10.1 | Support for delivery of multi-modal services..... | 128 | +| 4.2.7 | Handling of requests which collide with an existing SM Policy Association..... | 129 | +| 4.2.8 | UE IP address support..... | 129 | +| 5 | Npcf_SMPolicyControl Service API..... | 129 | +| 5.1 | Introduction..... | 129 | +| 5.2 | Usage of HTTP..... | 130 | +| 5.2.1 | General..... | 130 | +| 5.2.2 | HTTP standard headers..... | 130 | +| 5.2.2.1 | General..... | 130 | +| 5.2.2.2 | Content type..... | 130 | +| 5.2.3 | HTTP custom headers..... | 130 | + +| | | | +|-------------|--------------------------------------------------------|-----| +| 5.2.3.1 | General..... | 130 | +| 5.2.3.2 | 3gpp-Sbi-Origination-Timestamp..... | 130 | +| 5.3 | Resources..... | 131 | +| 5.3.1 | Resource Structure..... | 131 | +| 5.3.2 | Resource: SM Policies..... | 131 | +| 5.3.2.1 | Description..... | 131 | +| 5.3.2.2 | Resource definition..... | 131 | +| 5.3.2.3 | Resource Standard Methods..... | 132 | +| 5.3.2.3.1 | POST..... | 132 | +| 5.3.2.4 | Resource Custom Operations..... | 132 | +| 5.3.3 | Resource: Individual SM Policy..... | 133 | +| 5.3.3.1 | Description..... | 133 | +| 5.3.3.2 | Resource definition..... | 133 | +| 5.3.3.3 | Resource Standard Methods..... | 133 | +| 5.3.3.3.1 | GET..... | 133 | +| 5.3.3.4 | Resource Custom Operations..... | 134 | +| 5.3.3.4.1 | Overview..... | 134 | +| 5.3.3.4.2 | Operation: delete..... | 134 | +| 5.3.3.4.2.1 | Description..... | 134 | +| 5.3.3.4.2.2 | Operation Definition..... | 134 | +| 5.3.3.4.3 | Operation: update..... | 135 | +| 5.3.3.4.3.1 | Description..... | 135 | +| 5.3.3.4.3.2 | Operation Definition..... | 135 | +| 5.4 | Custom Operations without associated resources..... | 136 | +| 5.5 | Notifications..... | 137 | +| 5.5.1 | General..... | 137 | +| 5.5.2 | Policy Update Notification..... | 137 | +| 5.5.2.1 | Description..... | 137 | +| 5.5.2.2 | Operation Definition..... | 137 | +| 5.5.3 | Request for termination of the policy association..... | 138 | +| 5.5.3.1 | Description..... | 138 | +| 5.5.3.2 | Operation Definition..... | 139 | +| 5.6 | Data Model..... | 139 | +| 5.6.1 | General..... | 139 | +| 5.6.2 | Structured data types..... | 147 | +| 5.6.2.1 | Introduction..... | 147 | +| 5.6.2.2 | Type SmPolicyControl..... | 147 | +| 5.6.2.3 | Type SmPolicyContextData..... | 148 | +| 5.6.2.4 | Type SmPolicyDecision..... | 151 | +| 5.6.2.5 | Type SmPolicyNotification..... | 153 | +| 5.6.2.6 | Type PccRule..... | 154 | +| 5.6.2.7 | Type SessionRule..... | 157 | +| 5.6.2.8 | Type QosData..... | 158 | +| 5.6.2.9 | Type ConditionData..... | 159 | +| 5.6.2.10 | Type TrafficControlData..... | 160 | +| 5.6.2.11 | Type ChargingData..... | 162 | +| 5.6.2.12 | Type UsageMonitoringData..... | 164 | +| 5.6.2.13 | Type RedirectInformation..... | 165 | +| 5.6.2.14 | Type FlowInformation..... | 166 | +| 5.6.2.15 | Type SmPolicyDeleteData..... | 167 | +| 5.6.2.16 | Type QosCharacteristics..... | 168 | +| 5.6.2.17 | Type ChargingInformation..... | 169 | +| 5.6.2.18 | Type AccuUsageReport..... | 170 | +| 5.6.2.19 | Type SmPolicyUpdateContextData..... | 171 | +| 5.6.2.20 | Type UpPathChgEvent..... | 174 | +| 5.6.2.21 | Type TerminationNotification..... | 175 | +| 5.6.2.22 | Type AppDetectionInfo..... | 175 | +| 5.6.2.23 | Type AccNetChId..... | 176 | +| 5.6.2.24 | Type RequestedRuleData..... | 176 | +| 5.6.2.25 | Type RequestedUsageData..... | 177 | +| 5.6.2.26 | Type UeCampingRep..... | 178 | + +| | | | +|----------|---------------------------------------------------|-----| +| 5.6.2.27 | Type RuleReport..... | 179 | +| 5.6.2.28 | Type RanNasRelCause..... | 179 | +| 5.6.2.29 | Type UeInitiatedResourceRequest..... | 180 | +| 5.6.2.30 | Type PacketFilterInfo..... | 181 | +| 5.6.2.31 | Type RequestedQos..... | 181 | +| 5.6.2.32 | Type QosNotificationControlInfo..... | 182 | +| 5.6.2.33 | Type PartialSuccessReport..... | 182 | +| 5.6.2.34 | Type AuthorizedDefaultQos..... | 183 | +| 5.6.2.35 | Type AccNetChargingAddress..... | 183 | +| 5.6.2.36 | Type ErrorReport..... | 184 | +| 5.6.2.37 | Type SessionRuleReport..... | 184 | +| 5.6.2.38 | Type ServingNfIdentity..... | 184 | +| 5.6.2.39 | Type SteeringMode..... | 185 | +| 5.6.2.40 | Type QosMonitoringData..... | 186 | +| 5.6.2.41 | Type TsnBridgeInfo..... | 188 | +| 5.6.2.42 | Type QosMonitoringReport..... | 189 | +| 5.6.2.43 | Type AdditionalAccessInfo..... | 189 | +| 5.6.2.44 | Void..... | 190 | +| 5.6.2.45 | Type PortManagementContainer..... | 190 | +| 5.6.2.46 | Type IpMulticastAddressInfo..... | 190 | +| 5.6.2.47 | Type BridgeManagementContainer..... | 190 | +| 5.6.2.48 | Type DownlinkDataNotificationControl..... | 191 | +| 5.6.2.49 | Type DownlinkDataNotificationControlRm..... | 191 | +| 5.6.2.50 | Type SgsnAddress..... | 191 | +| 5.6.2.51 | Void..... | 191 | +| 5.6.2.52 | Type ThresholdValue..... | 191 | +| 5.6.2.53 | Type NwdafData..... | 192 | +| 5.6.2.54 | Type CallInfo..... | 192 | +| 5.6.2.55 | Type CalleeInfo..... | 192 | +| 5.6.2.56 | Type TrafficParaData..... | 193 | +| 5.6.2.57 | Type L4sSupportInfo..... | 193 | +| 5.6.2.58 | Void..... | 193 | +| 5.6.2.59 | Type SliceUsgCtrlInfo..... | 193 | +| 5.6.3 | Simple data types and enumerations..... | 193 | +| 5.6.3.1 | Introduction..... | 193 | +| 5.6.3.2 | Simple data types..... | 193 | +| 5.6.3.3 | Enumeration: FlowDirection..... | 194 | +| 5.6.3.4 | Enumeration: ReportingLevel..... | 194 | +| 5.6.3.5 | Enumeration: MeteringMethod..... | 195 | +| 5.6.3.6 | Enumeration: PolicyControlRequestTrigger..... | 196 | +| 5.6.3.7 | Enumeration: RequestedRuleDataType..... | 203 | +| 5.6.3.8 | Enumeration: RuleStatus..... | 203 | +| 5.6.3.9 | Enumeration: FailureCode..... | 204 | +| 5.6.3.10 | Enumeration: AfSigProtocol..... | 206 | +| 5.6.3.11 | Enumeration: RuleOperation..... | 206 | +| 5.6.3.12 | Enumeration: RedirectAddressType..... | 206 | +| 5.6.3.13 | Enumeration: QosFlowUsage..... | 207 | +| 5.6.3.14 | Enumeration: FailureCause..... | 207 | +| 5.6.3.15 | Enumeration: FlowDirectionRm..... | 207 | +| 5.6.3.16 | Enumeration: CreditManagementStatus..... | 207 | +| 5.6.3.17 | Enumeration: SessionRuleFailureCode..... | 208 | +| 5.6.3.18 | Enumeration: SteeringFunctionality..... | 209 | +| 5.6.3.19 | Enumeration: SteerModeValue..... | 209 | +| 5.6.3.20 | Enumeration: MulticastAccessControl..... | 209 | +| 5.6.3.21 | Enumeration RequestedQosMonitoringParameter..... | 210 | +| 5.6.3.22 | Enumeration: ReportingFrequency..... | 210 | +| 5.6.3.23 | Enumeration: SmPolicyAssociationReleaseCause..... | 210 | +| 5.6.3.24 | Enumeration: PduSessionRelCause..... | 210 | +| 5.6.3.25 | Enumeration: MaPduIndication..... | 211 | +| 5.6.3.26 | Enumeration: AtsssCapability..... | 212 | +| 5.6.3.27 | Enumeration: NetLocAccessSupport..... | 213 | + +| | | | +|----------------------------------------------------------------------------|-------------------------------------------------------------------------------|------------| +| 5.6.3.28 | Enumeration: PolicyDecisionFailureCode..... | 213 | +| 5.6.3.29 | Enumeration: NotificationControlIndication..... | 213 | +| 5.6.3.31 | Enumeration: SteerModeIndicator..... | 213 | +| 5.6.3.32 | Enumeration TrafficParameterMeas..... | 214 | +| 5.7 | Error handling..... | 214 | +| 5.7.1 | General..... | 214 | +| 5.7.2 | Protocol Errors..... | 214 | +| 5.7.3 | Application Errors..... | 214 | +| 5.8 | Feature negotiation..... | 218 | +| 5.9 | Security..... | 223 | +| Annex A (normative): OpenAPI specification..... | | 225 | +| A.1 | General..... | 225 | +| A.2 | Npcf_SMPolicyControl API..... | 225 | +| Annex B (normative): 5GC and EPC interworking scenario support..... | | 266 | +| B.1 | Scope..... | 266 | +| B.2 | Npcf_SMPolicyControl Service..... | 266 | +| B.2.1 | Service Description..... | 266 | +| B.2.1.1 | Overview..... | 266 | +| B.2.1.2 | Service Architecture..... | 266 | +| B.3 | Service Operation..... | 267 | +| B.3.1 | Introduction..... | 267 | +| B.3.2 | Npcf_SMPolicyControl_Create Service Operation..... | 267 | +| B.3.2.0 | General..... | 267 | +| B.3.2.1 | UE Location related information..... | 268 | +| B.3.2.2 | Access Type related information..... | 269 | +| B.3.2.3 | Access Network Charging Identifier report..... | 269 | +| B.3.3 | Npcf_SMPolicyControl_UpdateNotify Service Operation..... | 270 | +| B.3.3.0 | General..... | 270 | +| B.3.3.1 | Policy Update When UE suspends..... | 270 | +| B.3.3.2 | Request report of EPS Fallback..... | 270 | +| B.3.3.3 | S-GW Restoration Support..... | 271 | +| B.3.3.4 | Request of Access Network Charging Identifier..... | 271 | +| B.3.3.5 | Forwarding of UE policy container for URSP provisioning in EPS..... | 272 | +| B.3.4 | Npcf_SMPolicyControl_Update Service Operation..... | 272 | +| B.3.4.0 | General..... | 272 | +| B.3.4.1 | Number of Supported Packet Filters Report..... | 273 | +| B.3.4.2 | Policy Update When UE suspends..... | 273 | +| B.3.4.2.1 | Policy Update Error Report..... | 273 | +| B.3.4.2.2 | UE State Change Report..... | 273 | +| B.3.4.3 | UE Location related information..... | 273 | +| B.3.4.4 | Presence Reporting Area Information Report..... | 274 | +| B.3.4.5 | Access Type related information..... | 274 | +| B.3.4.6 | Report of EPS Fallback..... | 275 | +| B.3.4.7 | MA PDU Session..... | 275 | +| B.3.4.8 | EPS RAN NAS Cause Support..... | 276 | +| B.3.4.9 | S-GW Restoration Support..... | 276 | +| B.3.4.10 | UE initiates a resource modification support..... | 277 | +| B.3.4.11 | Report of Access Charging Network Identifier..... | 278 | +| B.3.4.11a | Detection of the SM Policy Association enabling URSP provisioning in EPS..... | 278 | +| B.3.4.12 | Reporting of UE Policy container for URSP provisioning in EPS..... | 279 | +| B.3.5 | Npcf_SMPolicyControl_Delete Service Operation..... | 279 | +| B.3.5.1 | General..... | 279 | +| B.3.5.2 | EPS RAN NAS Cause Support..... | 279 | +| B.3.6 | Provisioning and Enforcement of Policy Decisions..... | 279 | +| B.3.6.1 | QoS mapping performed by the SMF+PGW-C..... | 279 | + +| | | | +|---------|----------------------------------------------------------------------------------------|-----| +| B.3.6.2 | Provisioning of Presence Reporting Area Information..... | 280 | +| B.3.6.3 | Request and Report of Access Network information..... | 280 | +| B.3.6.4 | MA PDU sessions with connectivity over E-UTRAN/EPC and non-3GPP access to 5GC..... | 281 | +| B.3.6.5 | MA PDU sessions with connectivity over 5GC and non-3GPP access to EPC..... | 281 | +| B.3.7 | Detection and handling of late arriving requests for interworking scenario..... | 281 | +| B.3.7.1 | Handling of requests which collide with an existing SM Policy Association..... | 281 | +| B.3.7.2 | Detection and handling of requests which have timed out at the originating entity..... | 281 | + +**Annex C (normative): Wireless and wireline convergence access support.....282** + +| | | | +|-----------|--------------------------------------------------------------------------------------------------------------------|-----| +| C.1 | Scope..... | 282 | +| C.2 | Npcf_SMPolicyControl Service..... | 282 | +| C.2.1 | Service Description..... | 282 | +| C.2.1.1 | Overview..... | 282 | +| C.2.1.2 | Service Architecture..... | 282 | +| C.2.1.3 | Network Functions..... | 282 | +| C.2.1.3.1 | Policy Control Function (PCF)..... | 282 | +| C.2.1.3.2 | NF Service Consumers..... | 282 | +| C.2.1.4 | Rules..... | 282 | +| C.2.1.4.1 | PCC Rules..... | 282 | +| C.2.1.4.2 | Gate Function..... | 283 | +| C.2.1.5 | Policy control request trigger..... | 283 | +| C.2.1.6 | UE IP address support..... | 284 | +| C.3 | Service Operation..... | 284 | +| C.3.1 | Introduction..... | 284 | +| C.3.2 | Npcf_SMPolicyControl_Create Service Operation..... | 284 | +| C.3.2.1 | General..... | 284 | +| C.3.2.2 | IPTV service support..... | 285 | +| C.3.3 | Npcf_SMPolicyControl_UpdateNotify Service Operation..... | 285 | +| C.3.3.1 | General..... | 285 | +| C.3.3.2 | IPTV service support..... | 285 | +| C.3.4 | Npcf_SMPolicyControl_Update Service Operation..... | 285 | +| C.3.4.1 | General..... | 285 | +| C.3.4.2 | IPTV service support..... | 286 | +| C.3.5 | Npcf_SMPolicyControl_Delete Service Operation..... | 286 | +| C.3.5.1 | General..... | 286 | +| C.3.6 | Provisioning and Enforcement of Policy Decisions..... | 287 | +| C.3.6.0 | General..... | 287 | +| C.3.6.1 | IPTV service support..... | 287 | +| C.3.6.2 | Hybrid Access support..... | 287 | +| C.3.6.2.1 | General..... | 287 | +| C.3.6.2.2 | Hybrid Access with single PDU session..... | 288 | +| C.3.6.2.3 | Hybrid Access with MA PDU session connectivity over NG-RAN and wireline..... | 288 | +| C.3.6.2.4 | Hybrid Access with MA PDU session connectivity over EPC/E-UTRAN and wireline using EPC interworking scenarios..... | 288 | + +**Annex D(informative): Change history.....290** + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- Y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document provides the stage 3 specification of the Session Management Policy Control Service of 5G system. The stage 2 definition and related procedures of the Session Management Policy Control Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +Stage 3 call flows are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +The Policy Control Function with session related policies provides the Session Management Policy Control Service to the NF server consumers (e.g. Session Management Function). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [12] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes". +- [14] Void. +- [15] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Control Data, Application Data and Structured Data for Exposure; Stage 3". +- [16] 3GPP TS 23.228: "IP multimedia subsystem; Stage 2". +- [17] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". + +- [18] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point 5". +- [19] 3GPP TS 32.291: "5G System; Charging service; Stage 3". +- [20] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [21] 3GPP TS 23.380: "IMS Restoration Procedures". +- [22] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [23] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [24] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [25] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [26] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [27] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [28] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [29] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [30] 3GPP TS 32.290: "5G system; Services, operations and procedures of charging using Service Based Interface (SBI)". +- [31] IETF RFC 9457: "Problem Details for HTTP APIs". +- [32] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [35] 3GPP TS 32.255: "Charging management; 5G data connectivity domain charging; stage 2". +- [36] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [37] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [38] 3GPP TR 21.900: "Technical Specification Group working methods". +- [39] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [40] 3GPP TS 29.524: "Cause codes mapping between 5GC interfaces; Stage 3". +- [41] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification". +- [42] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [43] 3GPP TS 24.193: "Access Traffic Steering, Switching and Splitting (ATSSS); Stage 3". +- [44] 3GPP TS 24.519: "Time-Sensitive Networking (TSN) Application Function (AF) to Device-Side TSN Translator (DS-TT) and Network-Side TSN Translator (NW-TT) protocol aspects; Stage 3". +- [45] IEEE Std 802.1Q-2018: "IEEE Standard for Local and metropolitan area networks--Bridges and Bridged Networks". +- [46] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [47] BBF TR-456: "AGF Functional Requirements". +- [48] CableLabs WR-TR-5WWC-ARCH: "5G Wireless Wireline Converged Core Architecture". +- [49] 3GPP TS 24.539: "5G System (5GS); Network to TSN translator (TT) protocol aspects; Stage 3". + +- [50] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [51] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [52] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [53] 3GPP TS 29.565: "5G System; Time Sensitive Communication and Time Synchronization Function Services; Stage 3". +- [54] 3GPP TS 38.413: "NG Radio Access Network (NG-RAN); NG Application Protocol (NGAP)". +- [55] IETF RFC 8655: "Deterministic Networking Architecture". +- [56] IETF RFC 8344: "A YANG Data Model for IP Management". +- [57] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". +- [58] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [59] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [60] 3GPP TS 32.299: "Charging management; Diameter charging applications" +- [61] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [62] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [63] 3GPP TS 29.594: "5G System; Spending Limit Control Service; Stage 3". + +--- + +## 3 Definitions, symbols and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**5G QoS Flow:** The finest granularity for QoS forwarding treatment in the 5G System. All traffic mapped to the same 5G QoS Flow receive the same forwarding treatment (e.g. scheduling policy, queue management policy, rate shaping policy, RLC configuration, etc.). Providing different QoS forwarding treatment requires separate 5G QoS Flow. + +**5G QoS Identifier:** A scalar that is used as a reference to a specific QoS forwarding behaviour (e.g. packet loss rate, packet delay budget) to be provided to a 5G QoS Flow. This may be implemented in the access network by the 5QI referencing node specific parameters that control the QoS forwarding treatment (e.g. scheduling weights, admission thresholds, queue management thresholds, link layer protocol configuration, etc.). + +**Access Traffic Steering:** The procedure that selects an access network for a new data flow and transfers the traffic of this data flow over the selected access network. Access traffic steering is applicable between one 3GPP access and one non-3GPP access. + +**Access Traffic Switching:** The procedure that moves all traffic of an ongoing data flow from one access network to another access network in a way that maintains the continuity of the data flow. Access traffic switching is applicable between one 3GPP access and one non-3GPP access. + +**Access Traffic Splitting:** The procedure that splits the traffic of a data flow across multiple access networks. When traffic splitting is applied to a data flow, some traffic of the data flow is transferred via one access and some other traffic of the same data flow is transferred via another access. Access traffic splitting is applicable between one 3GPP access and one non-3GPP access. + +**Application detection filter:** A logic used to detect packets generated by an application based on extended inspection of these packets, e.g., header and/or payload information, as well as dynamics of packet flows. The logic is entirely internal to a UPF, and is out of scope of this specification. + +**Application identifier:** An identifier, referring to a specific application detection filter. + +**Application service provider:** A business entity responsible for the application that is being / will be used by a UE, which may be either an AF operator or has an association with the AF operator. + +**Binding:** The association between a service data flow and the QoS Flow transporting that service data flow. + +**Binding mechanism:** The method for creating, modifying and deleting bindings. + +**Charging control:** The process of associating packets, belonging to a service data flow, to a charging key and applying online charging or offline charging, as appropriate. + +**Charging key:** information used by the CHF for rating purposes. + +**Detected application traffic:** An aggregate set of packet flows that are generated by a given application and detected by an application detection filter. + +**Dynamic PCC Rule:** a PCC rule, for which the definition is provided to the SMF by the PCF. + +**Gating control:** The process of blocking or allowing packets, belonging to a service data flow / detected application's traffic, to pass through to the UPF. + +**MA PDU Session:** A PDU Session that provides a PDU connectivity service, which can use one access network at a time, or simultaneously one 3GPP access network and one non-3GPP access network. + +**Monitoring key:** information used by the SMF and PCF for usage monitoring control purposes as a reference to a given set of service data flows or application (s), that all share a common allowed usage on a per UE and DNN and S-NSSAI basis. + +**Operating System (OS):** Collection of UE software that provides common services for applications. + +**Operating System Identifier (OSId):** An identifier identifying the operating system. + +**PCC decision:** A PCF decision for policy and charging control provided to the SMF (consisting of PCC rules and PDU Session related attributes), a PCF decision for access and mobility related control provided to the AMF, a PCF decision for UE access selection and PDU Session selection related policy provided to the UE or a PCF decision for background data transfer policy provided to the AF. + +**PCC rule:** A set of information enabling the detection of a service data flow and providing parameters for policy control and/or charging control and/or other control or support information. The possible information is described in clause 6.3.1. + +**PDU Session:** Association between the UE and a Data Network that provides a PDU connectivity service. + +**Policy control:** The process whereby the PCF indicates to the SMF how to control the QoS Flow. Policy control includes QoS control and/or gating control. + +**Policy Control Request trigger report:** a notification, possibly containing additional information, of an event which occurs that corresponds with a Policy Control Request trigger. + +**Policy Control Request trigger:** defines a condition when the SMF shall interact again with the PCF. + +**Predefined PCC Rule:** a PCC rule that has been provisioned directly into the SMF by the operator. + +**Redirection:** Redirect the detected service traffic to an application server (e.g. redirect to a top-up / service provisioning page). + +**Service data flow:** An aggregate set of packet flows carried through the UPF that matches a service data flow template. + +**Service data flow filter:** A set of packet flow header parameter values/ranges used to identify one or more of the packet flows in the UPF. The possible service data flow filters are defined in clause 6.2.2.2. + +**Service data flow filter identifier:** A scalar that is unique for a specific service data flow (SDF) filter within a PDU session. + +**Service data flow template:** The set of service data flow filters in a PCC Rule or an application identifier in a PCC rule referring to an application detection filter in the SMF or in the UPF, required for defining a service data flow. + +**Service identifier:** An identifier for a service. The service identifier provides the most detailed identification, specified for flow based charging, of a service data flow. A concrete instance of a service may be identified if additional AF information is available (further details to be found in clause 6.3.1). + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [2], subclause 3.1 apply: + +#### **Onboarding Standalone Non-Public Network** + +#### **Onboarding Network** + +## **3.2 Abbreviations** + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|-----------------------------------------------------------------------------| +| ADC | Application Detection and Control | +| 5G-RG | 5G Residential Gateway | +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| API | Application Programming Interface | +| ATSSS | Access Traffic Steering, Switching, Splitting | +| ATSSS-LL | ATSSS Low-Layer | +| BAT | Burst Arrival Time | +| BBF | Broadband Forum | +| CHEM | Coverage and Handoff Enhancements using Multimedia error robustness feature | +| CHF | Charging Function | +| DCS | Default Credentials Server | +| DDD | Downlink Data Delivery | +| DDN | Downlink Data Notification | +| DetNet | Deterministic Networking | +| DN-AAA | Data Network Authentication, Authorization and Accounting | +| DNN | Data Network Name | +| DS-TT | Device-side TSN translator | +| DTS | Data Transport Service | +| EAS | Edge Application Server | +| ECN | Explicit Congestion Notification | +| ePDG | evolved Packet Data Gateway | +| FN-RG | Fixed Network Residential Gateway | +| GEO | Geosynchronous Orbit | +| GFBR | Guaranteed Flow Bit Rate | +| GUAMI | Globally Unique AMF Identifier | +| HFC | Hybrid Fiber Coax | +| HTTP | Hypertext Transfer Protocol | +| HR-SBO | Home Routed-Session BreakOut | +| I-SMF | Intermediate SMF | +| L4S | Low Latency Low Loss Scalable Throughput | +| LEO | Low Earth Orbit | +| MA | Multi-Access | +| MEO | Medium Earth Orbit | +| MPQUIC | Multi-Path QUIC | +| MPTCP | Multi-Path TCP Protocol | +| MTU | Maximum Transmission Unit | +| NAS | Non-Access-Stratum | +| NEF | Network Exposure Function | + +| | | +|---------|----------------------------------------------------------------| +| NF | Network Function | +| NID | Network Identifier | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| NW-TT | Network-side TSN translator | +| ON-SNPN | Onboarding Standalone Non-Public Network | +| ONN | Onboarding Network | +| PCC | Policy and Charging Control | +| PCF | Policy Control Function | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| PMIC | Port Management Information Container | +| PSA | PDU Session Anchor | +| PSAP | Public Safety Answering Point | +| QoS | Quality of Service | +| RSN | Redundancy Session Number | +| RTT | Round-Trip Time | +| SDF | Service Data Flow | +| SFC | Service Function Chain | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SSC | Service and Session Continuity | +| SUPL | Secure User Plane for Location | +| TNAN | Trusted Non-3GPP Access Network | +| TWAN | Trusted WLAN Access Network | +| TSC | Time Sensitive Communication | +| TSCAI | Time Sensitive Communication Assistance Information | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TSN | Time Sensitive Networking | +| TSN GM | TSN Grand Master | +| UDM | Unified Data Management | +| UDR | Unified Data Repository | +| UE | User Equipment | +| UL CL | UpLink Classifier | +| UMIC | User plane node Management Information Container | +| UPF | User Plane Function | +| URLLC | Ultra Reliable Low Latency Communication | +| URSP | UE Route Selection Policy | +| W-5GAN | Wireline 5G Access Network | +| W-5GBAN | Wireline BBF Access Network | +| W-5GCAN | Wireline 5G Cable Access Network | +| W-AGF | Wireline Access Gateway Function | + +## 4 Npcf\_SMPolicyControl Service + +### 4.1 Service Description + +#### 4.1.1 Overview + +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 (e.g. SMF). The Session Management Policy Control Service can be used for charging control, policy control, application detection and control and/or access traffic steering, switching and splitting within a MA PDU Session. Session Management Policy Control Service applies to the cases where the SMF interacts with the PCF in the non-roaming scenario, the 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. + +## 4.1.2 Service Architecture + +The Session Management Policy Control Service is provided by the PCF to the consumer and shown in the SBI representation model in figure 4.1.2-1 and in the reference point representation model in figure 4.1.2-2. The overall Policy and Charging Control related 5G architecture is depicted in 3GPP TS 29.513 [7]. + +The only known NF service consumer is the SMF. + +![Figure 4.1.2-1: Reference Architecture for the Npcf_SMPolicyControl Service; SBI representation. The diagram shows a PCF (Policy Control Function) box containing an oval labeled 'Npcf'. Below the PCF box is a rectangular box labeled 'Npcf_SMPolicyControl'. At the bottom is an SMF (Session Management Function) box. A vertical line connects the 'Npcf' oval to the 'Npcf_SMPolicyControl' box, and another vertical line connects the 'Npcf_SMPolicyControl' box to the SMF box.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +Figure 4.1.2-1: Reference Architecture for the Npcf\_SMPolicyControl Service; SBI representation. The diagram shows a PCF (Policy Control Function) box containing an oval labeled 'Npcf'. Below the PCF box is a rectangular box labeled 'Npcf\_SMPolicyControl'. At the bottom is an SMF (Session Management Function) box. A vertical line connects the 'Npcf' oval to the 'Npcf\_SMPolicyControl' box, and another vertical line connects the 'Npcf\_SMPolicyControl' box to the SMF box. + +**Figure 4.1.2-1: Reference Architecture for the Npcf\_SMPolicyControl Service; SBI representation** + +![Figure 4.1.2-2: Reference Architecture for the Npcf_SMPolicyControl Service; reference point representation. The diagram shows a PCF (Policy Control Function) box on the left and an SMF (Session Management Function) box on the right. A horizontal line connects them, with a small box labeled 'N7' in the center of the line.](51db757d054ce1ce83c436a3578b56ca_img.jpg) + +Figure 4.1.2-2: Reference Architecture for the Npcf\_SMPolicyControl Service; reference point representation. The diagram shows a PCF (Policy Control Function) box on the left and an SMF (Session Management Function) box on the right. A horizontal line connects them, with a small box labeled 'N7' in the center of the line. + +**Figure 4.1.2-2: Reference Architecture for the Npcf\_SMPolicyControl Service; reference point representation** + +NOTE: The PCF represents the V-PCF in the local breakout scenario. The SMF represents the H-SMF and the PCF represents the H-PCF in the home routed scenario. + +## 4.1.3 Network Functions + +### 4.1.3.1 Policy Control Function (PCF) + +The PCF is responsible for policy control decisions and flow based charging control functionalities. The PCF provides policies to the SMF, for example: + +- policies for application and service data flow detection; +- gating; +- QoS; +- flow based charging; +- traffic steering control; +- usage monitoring control; +- access traffic steering; +- switching and steering within a MA PDU Session; +- access network information report; + +- UMIC, PMIC and TSCAI input container; and +- RAN support information to the SMF. + +The policy decisions made by the PCF may be based on one or more of the following: + +- Information obtained from the AF, e.g. the session, media and subscriber related information; +- Information obtained from the UDR; + +NOTE: For local breakout roaming, session management policy data for the UE as defined in 3GPP TS 29.519 [15] is not available in the VPLMN and V-PCF uses locally configured information according to the roaming agreement with the HPLMN operator. All interactions to the UDR in this document are subject to this restriction. + +- Information obtained from the AMF, e.g. UE related and access related information; +- Information obtained from the SMF; +- Information obtained from the NWDAF; +- Information obtained from the NEF; +- Information from the CHF about spending limits control; +- Information from the TSCTSF or TSN AF; and +- PCF pre-configured policy context. + +#### 4.1.3.2 NF Service Consumers + +The SMF is responsible for the enforcement of session management related policy decisions from the PCF, related to service flow detection, QoS, charging, gating, traffic usage reporting, traffic steering and access traffic steering, switching and splitting within a MA PDU Session. + +The SMF shall support: + +- sending the PDU session related attributes to the PCF; +- requesting and receiving the PCC rule(s) from the PCF; +- binding of service data flows to QoS flow as defined in 3GPP TS 29.513 [7]; +- deriving rule(s) from the PCC rule(s) and then providing those rules to the user plane function or remove the rule(s) from the user plane as defined in 3GPP TS 29.244 [13]; +- deriving the QoS rules towards the UE; +- deriving the QoS profile towards the access network; +- deriving the ATSSS rules towards the UE if applicable; +- transferring the DS-TT PMIC transparently towards/from the UE/DS-TT and transferring the NW-TT U/PMIC transparently towards/from the UPF/NW-TT, if applicable; +- adapting received TSCAI input information (TSC assistance container) to 5GS GM and transferring the TSCAI to the AN-RAN; +- handling the policy control request trigger; and +- handling the PDU session related policy information. + +NOTE: SMF functionality related to event exposure is defined in 3GPP TS 29.508 [12]. + +The SMF is also responsible for forwarding to the PCF the UE Policy information received from the UE in UE Policy Containers (information related to URSP delivery in EPS) and in URSP enforcement reports. + +## 4.1.4 Rules + +### 4.1.4.1 General + +A rule is a set of policy information elements associated with a PDU session, or with service data flows (i.e., with a PCC rule). + +Two types of rules are defined: + +- Session rule; and +- PCC rule. + +Both Session rules and PCC rules are composed of embedded information elements as well as information elements that are part of the referenced objects (e.g. condition data, or usage monitoring policy data type) by the rule. + +PCC rule is defined in clause 4.1.4.2. Session rule is defined in clause 4.1.4.3. + +### 4.1.4.2 PCC rules + +#### 4.1.4.2.1 PCC rules definition + +A PCC rule is a set of information elements enabling the detection of a service data flow and providing parameters for policy control and/or charging control. There are two different types of PCC rules as defined in 3GPP TS 23.503 [6]: + +- Dynamic PCC rules: PCC rules that are dynamically provisioned by the PCF to the SMF. These PCC rules may be either predefined or dynamically generated in the PCF. Dynamic PCC rules can be installed, modified and removed at any time. +- Predefined PCC rules: PCC rules that are preconfigured in the SMF. Predefined PCC rules can be activated or deactivated by the PCF at any time. Predefined PCC rules within the PCF may be grouped allowing the PCF to dynamically activate a set of PCC rules. + +Additionally, predefined PCC rules may be grouped within the SMF as predefined PCC rule bases which allow the PCF to dynamically activate these sets of rules. In this case, the PCC rule identifier is used to hold the predefined PCC rule base identifier. + +NOTE 1: When the SMF interacts with the PCF for a PCC rule base, the PCF has no way of knowing which individual PCC rule of the PCC rule base caused the interaction. If such knowledge is required for specific PCC rules, then these PCC rules need to be implemented either as dynamic PCC rules or as predefined PCC rules that are not grouped in a PCC rule base. The SMF decision logic for interacting (or not) with the PCF about an event related to a PCC rule base is up to implementation and depends on the specific issue that triggered this interaction. + +NOTE 2: The operator can define a predefined PCC rule, to be activated by the SMF. Such a predefined rule is not explicitly known in the PCF. + +A PCC rule consists of: + +**Table 4.1.4.2.1-1: PCC rule information elements** + +| Information name | Description | Category | +|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| Rule identifier | Uniquely identifies the PCC rule, within a PDU Session.
It is used between PCF and SMF for referencing PCC rules. | Mandatory | +| Service data flow detection | | | +| Precedence | Determines the order, in which the service data flow templates are applied at service data flow detection, enforcement and charging. | Mandatory | +| Service Data Flow Template | For IP PDU traffic: Either a list of service data flow filters or an application identifier that references the corresponding application detection filter for the detection of the service data flow.
For Ethernet PDU traffic: Combination of traffic patterns of the Ethernet PDU traffic. | Mandatory | +| Mute for notification | Defines whether application's start or stop notification is to be muted. | Optional | +| Charging | | | +| Charging key | The charging system (CHF) uses the charging key to determine the tariff to apply to the service data flow. | Optional | +| Service identifier | The identity of the service or service component the service data flow in a rule relates to. | Optional | +| Sponsor Identifier | An identifier, provided from the AF, which identifies the Sponsor, used for sponsored flows to correlate measurements from different users for accounting purposes. | Optional | +| Application Service Provider Identifier | An identifier, provided from the AF, which identifies the Application Service Provider, used for sponsored flows to correlate measurements from different users for accounting purposes. | Optional | +| Charging method | Indicates the required charging method for the PCC rule.
Values: online or offline or none. | Optional | +| Service Data flow handling while requesting credit | Indicates whether the service data flow is allowed to start while the SMF is waiting for the response to the credit request.
Only applicable for charging method online. | Optional | +| Measurement method | Indicates whether the service data flow data volume, duration, combined volume/duration or event shall be measured.
This is applicable to reporting, if the charging method is online or offline.
Note: Event based charging is only applicable to predefined PCC rules and PCC rules used for application detection filter (i.e. with an application identifier). | Optional | +| Application Function Record Information | An identifier, provided from the AF, correlating the measurement for the Charging key/Service identifier values in this PCC rule with application level reports. | Optional | +| Service identifier level reporting | Indicates that separate usage reports shall be generated for this Service identifier.
Values: mandated or not required. | Optional | +| Policy control | | | +| 5QI | Identifier of the authorized QoS parameters for the service data flow. | Mandatory | +| ARP | The Allocation and Retention Priority for the service data flow consisting of the priority level, the pre-emption capability and the pre-emption vulnerability. | Mandatory | +| Gate status | The gate status indicates whether the service data flow, detected by the service data flow template, may pass (Gate is open) or shall be discarded (Gate is closed). | Optional | +| QoS Notification Control (QNC) | 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. | Optional | +| Reflective QoS Control | Indicates to apply reflective QoS for the SDF. | Optional | +| MBR (UL/DL) | The uplink/downlink maximum bitrate authorized for the service data flow. | Optional | +| GBR (UL/DL) | The uplink/downlink guaranteed bitrate authorized for the service data flow. | Optional | +| UL sharing indication | Indicates resource sharing in uplink direction with service data flows having the same value in their PCC rule. | Optional | +| DL sharing indication | Indicates resource sharing in downlink direction with service data flows having the same value in their PCC rule. | Optional | +| Redirect | Redirect state of the service data flow (enabled/disabled). | Optional | +| Redirect Destination | Controlled Address to which the service data flow is redirected when redirect is enabled. | Optional | + +| | | | +|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Bind to default QoS Flow | Indicates that the dynamic PCC rule shall always have its binding with the default QoS Flow. | Optional | +| Priority Level | Indicates a priority in scheduling resources among QoS Flows. | Optional | +| Averaging Window | Represents the duration over which the guaranteed and maximum bitrate shall be calculated. | Optional | +| Maximum Data Burst Volume | Denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB. | Optional | +| Disable UE notifications at changes related to Alternative QoS Profiles | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. The fulfilled situation is either the QoS profile or an Alternative QoS Profile. | Optional | +| Precedence for TFT packet filter allocation | Determines the order of TFT packet filter allocation for PCC rules | Optional | +| ECN marking for L4S | The ECN marking for L4S indicates that the UL and/or DL of the service data flow, detected by the service data flow template, supports ECN marking for L4S and enables ECN marking for L4S support.
(NOTE 6) | Optional | +| Data burst end marking indication | Indicates enable or disable the data burst end marking. | Optional | +| | Access Network Information Reporting | | +| User Location Required | The UE location(s) (e.g. the serving cell of the UE) is to be reported. When the corresponding QoS flow is deactivated, and if available, information on when the UE was last known to be in that location is also to be reported. | Optional | +| UE Timezone Required | The time zone of the UE is to be reported. | Optional | +| | Usage Monitoring Control | | +| Monitoring key | The PCF uses the monitoring key to group services that share a common allowed usage. | Optional | +| | N6-LAN Traffic Steering Enforcement Control | | +| Traffic steering policy identifier(s) | Reference to a pre-configured traffic steering policy at the SMF. | Optional | +| Metadata | Metadata of traffic for service function chaining handling | Optional | +| | Application Function influence on traffic routing Enforcement Control | | +| Data Network Access Identifier | Identifier of the target Data Network Access. | Optional | +| Per DNAI: Traffic steering policy identifier | Reference to a pre-configured traffic steering policy at the SMF. | Optional | +| Per DNAI: N6 traffic routing information | Describes the information necessary for traffic steering to the DNAI. | Optional | +| Information on AF subscription to UP path changes events | Indicates whether a notification in case of UP path change is requested, as well as the destination(s) for where to provide the notification. | Optional | +| Indication of UE IP address preservation | Indicates UE IP address should be preserved. | Optional | +| Indication of traffic correlation | Indicates that the target PDU Sessions should be correlated via a common DNAI in the user plane. (NOTE 5) | Optional | +| Information on User Plane Latency requirements | Indicates the user plane latency requirements. | Optional | +| EAS IP replacement information | Contains EAS IP replacement information (i.e. IP addresses and port numbers of source and target EAS). | Optional | +| Indication for simultaneous connectivity at edge relocation | Indicates request from the AF for temporary simultaneous connectivity over source and target PSA at edge relocation. It may provide AF guidance to determine when the connectivity over the source PSA can be removed. | Optional | +| Traffic Correlation ID | Identification of a set of UEs accessing the application identified by the Service data flow template | Optional | +| Common EAS IP address | IP address of the common EAS for the application identified by the Service Data Flow Template for the UEs the AF request aims at | Optional | +| FQDN(s) | FQDN(s) for the application indicated in the PCC rule. | Optional | +| NEF information | Notification Endpoint of NEF subscription to be notified with information related to UE members of the set of UEs identified by traffic correlation ID. | Optional | +| Indication of EAS rediscovery. | Indicates the rediscovery of EAS. | Optional | +| | RAN support information | | +| UL Maximum Packet Loss Rate | The maximum rate for lost packets that can be tolerated in the uplink direction for the service data flow. | Optional | + +| | | | +|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| DL Maximum Packet Loss Rate | The maximum rate for lost packets that can be tolerated in the downlink direction for the service data flow. | Optional | +| MA PDU Session Control | | | +| Application descriptors | Identifies the application traffic for which MA PDU Session control is required based on the Steering functionality, the Steering mode, the Steering mode indicator and the Threshold values. | Optional | +| Steering Functionality | Indicates the applicable traffic steering functionality. | Optional | +| Steering mode (UL/DL) | Indicates the UL and/or DL traffic distribution rules between the 3GPP and Non-3GPP accesses together with associated parameters (when applicable) for the traffic matching the service data flow. | Optional | +| Steering mode indicator | Indicates either autonomous load-balance operation or UE-assistance operation, if the steering mode is set to "LOAD_BALANCING". | Optional | +| Threshold value(s) | Indicates, as applicable for the steering mode, the threshold value(s) for maximum RTT or maximum Packet Loss Rate, or both. | Optional | +| Charging for Non-3GPP access | Indicates parameters used for charging packets carried via Non-3GPP access for a MA PDU Session. The same set of parameters as for the Charging information above applies. If a parameter is not included here, the value provided in the Charging information above applies. | Optional | +| Usage Monitoring for Non-3GPP access | Indicates parameters used to monitor usage of the packets carried via Non-3GPP access for a MA PDU Session. The same set of parameters as for the Usage Monitoring information above applies. If a parameter is not included here, the value provided in the Usage Monitoring information above applies. | Optional | +| Transport Mode | The Transport Mode indicates the transport mode for transmitting a UDP flow between UE and UPF. The transport mode should be applied by the MPQUIC functionality for the matching traffic. It shall only be included when the steering functionality is MPQUIC functionality. | Conditional | +| IPTV (NOTE 1) | | | +| IP Multicast traffic control information | Indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed. | Optional | +| QoS Monitoring | | | +| QoS parameter(s) to be measured | Indicates the QoS parameters to be monitored, e.g. UL packet delay, DL packet delay or round trip packet delay. | Optional | +| Reporting frequency | Defines the frequency for the reporting, such as event triggered or periodic. | Optional | +| Target of reporting | Defines the target of the QoS Monitoring reports; it corresponds to the AF, as decided by the PCF or included when the indication of direct event notification is received from the AF. | Optional | +| Indication of direct event notification | Indicates that the QoS Monitoring event shall be reported by the UPF directly to the AF or Local NEF indicated by the Target of reporting. | Optional | +| Data Collection Application Identifier | Indicates that the PCC Rule is associated to a QoS monitoring event exposure subscription initiated by the NF service consumer (e.g. NWDAF) that provides an application identifier that matches this value. | Optional | +| Alternative QoS Parameter Sets (NOTE 2) | | | +| Packet Delay Budget | Indicates the packet delay budget in this Alternative QoS Parameter Set. | Optional | +| Packet Error Rate | Indicates the packet error rate in this Alternative QoS Parameter Set. | Optional | +| GBR (UL/DL) | The uplink/downlink guaranteed bitrate authorized for the service data flow in this Alternative QoS Parameter Set. | Optional | +| TSCAI Input container | | | +| Burst Arrival Time | Indicates the burst arrival time in reference to TSN GM for TSN or external GM for non-TSN applications at ingress port. | Optional | +| Periodicity | The time period (in reference to TSN GM for TSN or external GM for non-TSN applications) between start of two bursts. | Optional | +| Flow Direction | Direction of the flow. | Optional | +| Survival Time | It refers to the time period an application can survive without any burst. It is expressed in reference to the TSN GM for TSN and external GM for non-TSN applications. | Optional | + +| | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| +| Time Domain | Indicate the (g)PTP domain the (TSN)AF is located in. | Optional | +| Burst Arrival Time window | Indicates the acceptable earliest and latest arrival time of the data burst in reference to the external GM for non-TSN applications at ingress port. | Optional | +| Capability for BAT adaptation | Indicates the capability for AF to adjust the burst sending time according to the network provided Burst Arrival Time offset. | Optional | +| Periodicity Range | Indicates the capability for AF to adjust the periodicity and provides either the acceptable periodicity range or the acceptable periodicity set. It can be formulated as lower bound and upper bound of the periodicity for the acceptable periodicity range, or as a list of value(s) of the periodicity for the acceptable periodicity set. | Optional | +| Traffic Parameter Information | | | +| Periodicity | Indicates the time period between start of two data bursts in UL/DL direction. | Optional | +| Traffic Parameter Measurement | | | +| Traffic Parameter(s) to be measured | Indicates to measure the N6 jitter range associated with DL Periodicity and, optionally, the UL/DL periodicity. | Optional | +| Reporting condition | Defines the condition for the reporting, such as event triggered or periodic, frequency. | Optional | +| Indirect Feature Negotiation | | | +| Supported Features of NF Service Consumer | Network Function Service Consumer features supported per service. | Optional | +| NOTE 1: Only applicable to the 5G-RG connecting to the 5GC via NG-RAN as defined in Annex C.
NOTE 2: Only applicable for GBR service data flow with QoS Notification Control enabled.
NOTE 3: The parameter "Bind to QoS Flow associated with the default QoS rule and apply PCC rule parameters" defined in table 6.3.1 of 3GPP TS 23.503 [6] is implemented as follows: a default QoS with a GBR type or delay critical GBR type 5QI and a PCC rule bound to the default QoS flow are provisioned as defined in clause 4.2.6.2.1.
NOTE 4: The parameter "Indication of exclusion from session level monitoring" defined in table 6.3.1 of 3GPP TS 23.503 [6] is implemented as follows: a PCC rule identifier is included within the "exUsagePccRuleIds" attribute of the UsageMonitoringData instance of PDU session level usage monitoring to indicate that the service data flow shall be excluded from PDU Session usage monitoring as defined in clause 4.2.6.5.3.
NOTE 5: The indication of traffic correlation shall be provided only when all the PDU sessions related to the 5G VN group member UEs should be correlated by a common DNAI in the user plane for the traffic as described in 3GPP TS 23.501 [2], clause 5.6.7.1 and clause 5.29.
NOTE 6: When the "L4S" feature is supported, the indication of ECN marking for L4S shall be provided only when the PCF is configured to provide an explicit indicator to the SMF to enable ECN marking for L4S for the traffic identified by the SDF template. | | | + +**Editor's note:** Further adjustments transport mode definition are FFS based on the transport mode definition in TS 23.503. + +The above information is organized into a set of decision data objects as defined in clause 4.1.4.4. The exact encoding of PCC rules is defined in clause 5.6.2.6. + +#### 4.1.4.2.2 PCC rules operation + +For dynamic PCC rules, the following applies: + +- Installation: to provision the PCC rules. +- Modification: to modify the PCC rules. +- Removal: to remove the PCC rules. + +For predefined PCC rules, the following operations are available: + +- Activation: to activate the PCC rules. +- Deactivation: to deactivate the PCC rules. + +#### 4.1.4.3 Session rule + +##### 4.1.4.3.1 Session rules definition + +A session rule consists of policy information elements associated with PDU session. A session rule is dynamically provisioned by the PCF to the SMF (i.e., there are only dynamic session rules). The encoding of the SessionRule data type is defined in clause 5.6.2.7. + +A session rule shall include: + +- Session Rule Identifier. + +A session rule may include: + +- Authorized Session-AMBR; +- Authorized Default QoS; +- Reference to Usage Monitoring Data; +- Reference to Usage Monitoring Data for Non-3GPP access of MA PDU session; and +- Reference to Condition Data. + +##### 4.1.4.3.2 Session rules operation + +For Session rules, the following applies: + +- Installation: to provision the session rules. +- Modification: to modify the session rules. +- Removal: to remove the session rules. + +#### 4.1.4.4 Policy Decision types + +##### 4.1.4.4.1 General + +A policy decision is a grouping of cohesive information elements describing a specific type of decision, e.g. QoS, Charging data, etc. A policy decision can be linked to one or more PCC rules or one or more Session rules. A PCC rule or session rule can at most refer to one instance of the policy decision for each type. + +The following types of policy decision are defined: + +- Traffic control data; +- QoS data; +- Charging data; +- Usage Monitoring data; and +- QoS Monitoring data. + +##### 4.1.4.4.2 Traffic control data definition + +Traffic control data defines how traffic data flows associated with a rule are treated (e.g. blocked, redirected). The traffic control data encoding table is defined in clause 5.6.2.10. + +Traffic control data shall include: + +- Traffic Control Data ID. + +Traffic control data may include: + +- Flow status; +- ECN marking for L4S support indication; +- Redirect Information; +- Mute Notification; +- Traffic Steering Policy ID UL; +- Traffic Steering Policy ID DL; +- Metadata; +- Routing requirements; +- UP path change event subscription from the AF; +- Information on User Plane Latency requirements; +- EAS IP replacement information; +- Indication of traffic correlation; +- Correlation information for common EAS and DNAI selection potentially together with the NEF information for the notification related to UE members of the set of UEs identified by traffic correlation ID; +- Indication of simultaneous connectivity temporarily maintained for source and target PSA during edge relocation and guidance about when the connectivity over the source PSA can be removed; +- Access Traffic Steering Functionality; +- Access Traffic Steering Mode DL; + - Access Traffic Steering Mode; and + - Optionally, Access Traffic Steering Mode Indicator or Access Traffic Steering Mode Threshold; +- Access Traffic Steering Mode UL; and + - Access Traffic Steering Mode; and + - Optionally, Access Traffic Steering Mode Indicator or Access Traffic Steering Mode Threshold; +- Multicast Access Control; and +- The data burst end marking indication. + +#### 4.1.4.4.3 QoS data definition + +QoS data defines QoS parameters (e.g. bitrates) associated with a rule. The QoS data encoding table is defined in clause 5.6.2.8. + +QoS data shall include: + +- QoS Data ID; + +QoS data may include: + +- 5QI; +- ARP; +- QNC; +- Maximum Packet Loss Rate UL; +- Maximum Packet Loss Rate DL; + +- Maximum Bit Rate UL; +- Maximum Bit Rate DL; +- Guaranteed Bit Rate UL; +- Guaranteed Bit Rate DL; +- 5QI Priority Level; +- Averaging window; +- Maximum Data Burst Volume; +- Bound to default QoS flow indication; +- Resource Sharing Key UL; +- Resource Sharing Key DL; +- Reflective QoS attribute; +- Packet Delay Budget; and +- Packet Error Rate. + +NOTE: Either 5QI and ARP combination or Bound to default QoS flow indication is provided. + +#### 4.1.4.4.4 Charging data definition + +Charging data defines charging related parameters (e.g. rating group) associated with a rule. The charging data encoding table is defined in clause 5.6.2.11. + +Charging data shall include: + +- Charging Data ID; +- Rating Group. + +Charging data may include: + +- Metering Method; +- Charging Method; +- Service Data flow handling while requesting credit; +- Reporting Level; +- Service ID; +- Sponsor ID; +- Application Service Provider ID; and +- AF Charging ID. + +#### 4.1.4.4.5 UsageMonitoring data definition + +UsageMonitoring data defines usage monitoring information associated with a rule. The UsageMonitoring data encoding table is defined in clause 5.6.2.12. + +Usage Monitoring Data shall include: + +- Usage Monitoring ID. + +NOTE: A Usage Monitoring ID corresponds to a valid Monitoring Key. + +Usage Monitoring Data may include: + +- Volume Threshold; +- Volume Threshold UL; +- Volume Threshold DL; +- Time Threshold; +- Monitoring Time; +- Next Volume Threshold; +- Next Volume Threshold UL; +- Next Volume Threshold DL; +- Next Time Threshold; +- Inactivity Time; and +- PCC rule identifier(s) corresponding to the service data flow(s) which need to be excluded from PDU session level usage monitoring. + +#### 4.1.4.4.6 QoS Monitoring data definition + +QoS Monitoring data defines QoS Monitoring related parameters (e.g. request QoS monitoring parameters to be measured) associated with a rule. The QoS Monitoring data encoding table is defined in clause 5.6.2.40. + +QoS Monitoring data shall include: + +- QoS Monitoring Data ID; +- requested QoS monitoring parameters to be measured; +- reporting frequency. + +QoS monitoring data may include: + +- reporting thresholds; +- wait time; +- reporting period; +- target of reporting; +- indication of direct event notification; and +- data collection application identifier. + +### 4.1.5 Policy control request trigger + +A policy control request trigger is a condition pre-configured in the SMF (i.e. always report) or provisioned by the PCF to the SMF, which defines when the SMF shall interact again with PCF for further policy decision related to a PDU session. + +The policy control request trigger is designed as an Enumeration type defined in clause 5.6.3.6. + +The PCF can provide an array of policy control request triggers in a policy decision to subscribe to the associated triggers in the SMF. + +When the SMF interacts with the PCF when the condition(s) associated with policy control request triggers are met, the SMF shall the corresponding trigger(s) together with the related attribute(s) that have changed if applicable. + +#### 4.1.6 Requested rule data + +Requested rule data consists of requested information by the PCF associated with one or more PCC rules. + +The requested rule data is designed as a subresource of the policy decision within an attribute called "lastReqRuleData". The PCF only records the last requested rule data. + +When requesting rule data, the PCF shall include the types of data requested for the rules within the "reqData" array of the "lastReqRuleData" and shall also provide the corresponding policy control request triggers if the triggers are not yet set. + +The encoding of the requested rule data is further specified in clause 5.6.2.24. + +When the SMF receives the requested rule data, the SMF shall report the corresponding information to the PCF for the associated PCC rule(s). + +#### 4.1.7 Requested usage data + +Requested Usage data consists of the requested accumulated usage reports by the PCF for one or more instances of Usage Monitoring data decision. + +The requested usage data is designed as a sub resource of the policy decision within an attribute called "lastReqUsageData". The PCF only records the last requested usage data. + +The encoding of the requested usage data is further specified in clause 5.6.2.25. + +When the SMF receives the requested usage data attribute, the SMF shall report to the PCF the corresponding accumulated usage reports for the corresponding Usage Monitoring data decision(s). Requested usage data shall not be valid anymore for these Usage Monitoring data decision(s) after the reporting. + +#### 4.1.8 Condition data + +Condition data defines the condition(s) where the PCC rules or session rules are applicable and/or not applicable. The condition data encoding is defined in clause 5.6.2.9. + +Condition data shall include: + +- Condition Data ID. + +Condition data may include: + +- Activation Time; +- Deactivation Time; +- Access Type; and +- RAT Type + +NOTE: Access type and RAT type are only applicable to the session rule. + +### 4.2 Service Operations + +#### 4.2.1 Introduction + +The service operations defined for Npcf\_SMPolicyControl are shown in table 4.2.1-1. + +**Table 4.2.1-1: Npcf\_SMPolicyControl Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Npcf_SMPolicyControl_Create | Request to create an SM Policy Association with the PCF to receive the policy for a PDU session. | NF consumer (SMF) | +| Npcf_SMPolicyControl_Update | Request to update the SM Policy association with the PCF to receive the updated policy when Policy Control Request Trigger(s) condition is met. | NF consumer (SMF) | +| Npcf_SMPolicyControl_UpdateNotify | Update and/or delete PCC rule(s), PDU session related policy context at the SMF and Policy Control Request Trigger(s) information. | PCF | +| Npcf_SMPolicyControl_Delete | Request to delete the SM Policy Association and the associated resources. | NF consumer (SMF) | + +## 4.2.2 Npcf\_SMPolicyControl\_Create Service Operation + +### 4.2.2.1 General + +The Npcf\_SMPolicyControl\_Create service operation provides means for the SMF to request the creation of a corresponding SM Policy Association with PCF. + +The Session Management procedures of the SMF and related policies are defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [6]. + +The following procedures using the Npcf\_SMPolicyControl\_Create service operation are supported: + +- Request the creation of a corresponding SM Policy Association with the PCF. +- Provisioning of PCC rules. +- Provisioning of policy control request triggers. +- Provisioning of charging related information for a PDU session. +- Provisioning of revalidation time. +- Policy provisioning and enforcement of authorized AMBR per PDU session. +- Policy provisioning and enforcement of authorized default QoS. +- Provisioning of PCC rule for Application Detection and Control. +- 3GPP PS Data Off Support. +- IMS Emergency Session Support. +- Request Usage Monitoring Control. +- Access Network Charging Identifier report. +- Request for the successful resource allocation notification. +- Provisioning of IP Index Information. +- Negotiation of the QoS flow for IMS signalling. +- PCF resource cleanup. +- Access traffic steering, switching and splitting support. +- DNN Selection Mode Support. +- Detection of the SM Policy Association enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking. + +- Support of Dual Connectivity end to end redundant User Plane paths. +- User Plane Remote Provisioning of UE SNPN Credentials in Onboarding Network. +- Network slice related data rate policy control. +- Request of Presence Reporting Area Change Report. +- Group related data rate policy control. +- Support of Network Slice Usage Control. + +When the EMDBV feature defined in clause 5.8 is supported by both the PCF and the SMF, the PCF shall use the extMaxDataBurstVol attribute instead of the maxDataBurstVol attribute to signal maximum data burst volume values higher than 4095 Bytes. + +When the EMDBV feature is supported by the PCF but not supported by the SMF and the PCF needs to signal maximum data burst volume values higher than 4095 Bytes, the PCF shall use the maxDataBurstVol attribute set to 4095 Bytes. + +For values lower than or equal to 4095 Bytes, the PCF shall use the maxDataBurstVol attribute. + +NOTE: Maximum data burst volume values are sent by the PCF in responses to the SMF or in an SM Policy Association Update request i.e. after feature negotiation, so the PCF knows whether the SMF supports the EMDBV feature. + +#### 4.2.2.2 SM Policy Association establishment + +![Sequence diagram showing SM Policy Association establishment between an NF service consumer and a PCF.](1c9a5a80a4ed18fdfda1c8ae915966bf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../sm-policies + NF service consumer->>PCF: 1. POST .../sm-policies + Note left of PCF: 2. 201 Created + PCF-->>NF service consumer: 2. 201 Created +``` + +The diagram illustrates the interaction for SM Policy Association establishment. It features two lifelines: 'NF service consumer' on the left and 'PCF' on the right. Step 1 shows a horizontal arrow from the NF service consumer to the PCF labeled '1. POST .../sm-policies'. Step 2 shows a horizontal arrow from the PCF back to the NF service consumer labeled '2. 201 Created'. + +Sequence diagram showing SM Policy Association establishment between an NF service consumer and a PCF. + +**Figure 4.2.2.2-1: SM Policy Association establishment** + +When the NF service consumer receives the Nsmf\_PDUSession\_CreateSMContext Request as defined in clause 5.2.2.2 of 3GPP TS 29.502 [22], if the NF service consumer was requested not to interact with the PCF, the NF service consumer shall not interact with the PCF. Otherwise, the NF service consumer shall send an HTTP POST request to the PCF to create an "Individual SM Policy" resource as described in step 1 of figure 4.2.2.2-1. + +NOTE 1: The decision to not interact with the PCF applies for the entire lifetime of the PDU session. + +NOTE 2: The indicator to not interact with the PCF is configured in the UDM. It is delivered by the UDM to the NF service consumer within the Charging Characteristics using the Session Management Subscription Data Retrieval service operation as described in 3GPP TS 29.503 [34]. The indicator is operator specific, therefore it can only be used in non-roaming and home routed roaming cases. + +The NF service consumer shall include the "SmPolicyContextData" data structure in the content of the HTTP POST request in order to request the creation of a representation of the "Individual SM Policy" resource as described below. + +The NF service consumer shall include (if available) in the "SmPolicyContextData" data structure: + +- SUPI of the user within the "supi" attribute; +- PDU Session Id within the "pduSessionId" attribute; +- DNN within the "dnn" attribute; + +- DNN selection mode within the "dnnSelMode" attribute, if the "DNNSelectionMode" feature is supported; +- URL identifying the recipient of SM policies update notifications within the "notificationUri" attribute; +- PDU Session Type within the "pduSessionType" attribute; +- PEI within the "pei" attribute; +- Internal Group Id(s) within the "interGrpIds" attribute; +- type of access within the "accessType" attribute; +- type of the radio access technology within the "ratType" attribute; +- the combination of additional access type and RAT type within the "addAccessInfo" attribute, if the ATSSS feature is supported; +- the UE Ipv4 address within the "ipv4Address" attribute and/or the UE Ipv6 prefix within the "ipv6AddressPrefix" attribute; +- the UE time zone information within the "ueTimeZone" attribute; +- the UDM subscribed Session-AMBR or, if the "DN-Authorization" feature is supported, the DN-AAA authorized Session-AMBR within the "subsSessAmbr" attribute; + +NOTE 3: When both, the UDM subscribed Session-AMBR and the DN-AAA authorized Session-AMBR are available in the NF service consumer, the NF service consumer includes the DN-AAA authorized Session-AMBR. + +- if the "VPLMN-QoS-Control" feature is supported, the highest Session-AMBR and the default QoS supported in the VPLMN within the "vplmnQos" attribute, if available; + +NOTE 4: In home routed roaming, the H-SMF may provide the QoS constraints received from the VPLMN (defined in 3GPP TS 23.502 [3] clause 4.3.2.2.2) to the PCF. + +- the DN-AAA authorization profile index within the "authProfIndex" attribute, if the "DN-Authorization" feature is supported; +- subscribed Default QoS Information within the "subsDefQos" attribute; +- the number of supported packet filters for signalled QoS rules within the "numOfPackFilter" attribute; +- the online charging status within the "online" attribute; +- the offline charging status within the "offline" attribute; +- the charging characteristics within the "chargingCharacteristics" attribute; +- the access network charging identifier within the "accNetChId" attribute; +- the address of the network entity performing charging within the "chargEntityAddr" attribute; +- the 3GPP PS data off status within the "3gppPsDataOffStatus" attribute, if the "3GPP-PS-Data-Off" feature is supported; +- indication of UE support of reflective QoS within the "refQosIndication" attribute; +- user location(s) information within the "userLocationInfo" attribute; + +NOTE 5: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +- the S-NSSAI corresponding to the network slice to which the PDU session is allocated within the "sliceInfo" attribute; +- the required QoS flow usage for the default QoS flow within the "qosFlowUsage" attribute; +- the MA PDU session indication within the "maPduInd" attribute, if the "ATSSS" feature is supported; + +- the ATSSS capability within the "atsssCapab" attribute, if the "ATSSS" feature is supported; +- the identifier of the serving network (the PLMN Identifier or the SNPN Identifier) within the "servingNetwork" attribute; + +NOTE 6: The SNPN Identifier consists of the PLMN Identifier and the NID. + +- one or more framed routes within the "ipv4FrameRouteList" attribute for IPv4 and/or one or more framed routes within the "ipv6FrameRouteList" attribute; + +NOTE 7: When both, the UDM subscribed framed routes and the DN-AAA authorized framed routes are available in the NF service consumer, the NF service consumer includes the DN-AAA authorized framed routes. If the UDM or DN-AAA updates the framed routes during the lifetime of the PDU Session, the NF service consumer releases the PDU Session as defined in clause 4.2.5.2. + +- the serving network function identifier within the "servNfId" attribute; +- when the "PvsSupport" feature is supported, the onboarding indication within the "onboardInd" attribute and the Provisioning Server address(es) within the "pvsInfo" attribute; +- when the "SatBackhaulCategoryChg" feature is supported, the satellite backhaul category within the "satBackhaulCategory" attribute; + +NOTE 8: When the "satBackhaulCategory" attribute is not present, non-satellite backhaul applies. + +- when the "AMInfluence" feature is supported, the PCF for the UE callback URI and, if received, SBA binding information and, when the "EnSatBackhaulCatChg" feature is supported, also the dynamic satellite backhaul category, within the "pcfUeInfo" attribute; +- when the "URSPEnforcement" feature is supported, the URSP rule enforcement information provided by the UE within the "urspEnfInfo" attribute. In this case, the NF service consumer shall also include the SSC mode within the "sscMode" attribute, the UE requested DNN (if available and different from the selected DNN) within the "ueReqDnn" attribute, and if the PDU session is redundant, the RSN and the PDU session pair ID within the "redundantPduSessionInfo" attribute; +- trace control and configuration parameters information within the "traceReq" attribute; +- when the "EneNA" feature is supported, the list of NWDAF instance IDs used for the PDU Session within the "nwdafInstanceId" and their associated Analytic ID(s) within "nwdafEvents" consumed by the NF service consumer, included within the "nwdafDatas" attribute; and +- for HR-SBO scenario, if the "HR-SBO" feature is supported, the HR-SBO support indication within the "hrsboInd" attribute in the SM policy association. + +NOTE 9: VPLMN Specific Offloading Policy can be provisioned in HPLMN per each VPLMN based on the service level agreement between HPLMN and VPLMN. + +The NF service consumer may include in the "SmPolicyContextData" data structure the IPv4 address domain identity within the "ipDomain" attribute. + +NOTE 10: The "ipDomain" attribute is helpful when within a network slice, there are several separate IP address domains, with SMF/UPF(s) that allocate IPv4 IP addresses out of the same private address range to UE PDU Sessions. The same IP address can thus be allocated to UE PDU sessions served by SMF/UPFs in different IPv4 address domains. If one PCF controls several SMF/UPFs in different IP address domains, the UE IP address is thus not sufficient for the AF session binding procedure, as described in 3GPP TS 29.514 [17]. The SMF assists the PCF in the session binding supplying an "ipDomain" attribute denoting the IPv4 address domain identity of the allocated UE IPv4 address. + +When the PCF receives the HTTP POST request from the NF service consumer, the PCF shall make a policy authorization based on the information received from the NF service consumer and, if available, information received from the AMF, the CHF, the AF, the UDR and/or the NWDAF and operator policies pre-configured at the PCF. If the policy authorization is successful, the PCF shall create a new resource, which represents a new "Individual SM Policy" instance, addressed by a URI as defined in clause 5.3.3.2 and containing a PCF created resource identifier. The PCF shall respond to the NF service consumer with an HTTP 201 Created response, including: + +- a Location header field containing the URI of the created resource; and +- a response body providing the session management related policies, e.g. provisioning of PCC rules as defined in clause 4.2.6.2, provisioning of policy control request triggers as defined in clause 4.2.6.4. + +The NF service consumer shall use the URI received in the Location header in subsequent requests to the PCF to refer to the created "Individual SM Policy" resource. + +If the PCF received the list of NWDAF instance IDs used for the PDU Session in "nwdafInstanceId" attribute and their associated Analytic IDs in "nwdafEvents" attribute included within the "nwdafDatas" attribute the PCF may select those NWDAF instances as described in 3GPP TS 29.513 [7]. + +If the PCF received a "traceReq" attribute in the HTTP POST request from the SMF, it shall perform trace procedures as defined in 3GPP TS 32.422 [24]. + +If errors occur when processing the HTTP POST request, the PCF shall apply the error handling procedures specified in clause 5.7. + +If the user information received within the "supi" attribute is unknown, the PCF shall reject the request with an HTTP "400 Bad Request" response message including the "cause" attribute of the ProblemDetails data structure set to "USER\_UNKNOWN". + +If the PCF is not able, due to incomplete, erroneous or missing information (e.g. QoS, RAT type, subscriber information), to provision a policy decision as response to the request for PCC rules from the NF service consumer, the PCF may reject the request with an HTTP "400 Bad Request" response message including the "cause" attribute of the ProblemDetails data structure set to "ERROR\_INITIAL\_PARAMETERS". + +If the NF service consumer receives an HTTP response with the above error codes, the NF service consumer shall reject the PDU session establishment procedure that initiated the HTTP POST Request. + +If the PCF, based on local configuration and/or operator policies, denies the creation of the Individual SM Policy resource, the PCF may reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "POLICY\_CONTEXT\_DENIED". At reception of this error code and based on configured failure actions, the NF service consumer may reject or allow, by applying local policies, the PDU session establishment. + +If the "SamePcf" feature as defined in clause 5.8 is supported, when the PCF determines that the same PCF shall be selected for the SM Policy associations to the same UE ID, S-NSSAI and DNN combination in the non-roaming or home-routed scenario and there is no SM Policy association for the UE ID, S-NSSAI and DNN combination, the PCF, after determining whether the BSF supports the "SamePcf" or the "ExtendedSamePcf" feature as described in 3GPP TS 29.521 [39], shall request the BSF to check if there is an existing PCF binding information for the same UE ID, S-NSSAI and DNN combination registered by other PCF(s) as defined in clause 4.2.2.2 of 3GPP TS 29.521 [39]. If the PCF receives the from the BSF "403 Forbidden" status code with the "cause" attribute of the ProblemDetails data structure set to "EXISTING\_BINDING\_INFO\_FOUND" and the FQDN or description of IP endpoints of the Npcf\_SMPolicyControl service of the existing PCF (i.e. that handles SM Policy association(s) to the same UE ID, S-NSSAI and DNN combination) within the "pcfSmFqdn" attribute or the "pcfSmIpEndpoints" attribute of the BindingResp data structure respectively as defined in clause 4.2.2.2 of 3GPP TS 29.521 [39], the PCF shall reply to the SMF with an HTTP "308 Permanent Redirect" error response and the Location header containing a URI as defined in clause 5.3.2.2, with the FQDN or IP endpoint of this PCF's Npcf\_SMPolicyControl service as {apiRoot}. Upon reception of the response, the NF service consumer shall initiate a new HTTP POST request based on the returned URI. + +The forwarding of the Origination Time Stamp parameter shall apply as described hereafter, if the NF service consumer supports the detection and handling of late arriving requests as specified in clause 5.2.3.3 of 3GPP TS 29.502 [22] and the procedure is enabled by the operator. If the NF service consumer receives a request to create an SM Context or a PDU session context, which includes the 3gpp-Sbi-Origination-Timestamp header as defined in clause 5.2.3.2, the NF service consumer shall forward this header to the PCF as HTTP custom header. See also clause 4.2.7 for the handling at the PCF, when the PCF receives the 3gpp-Sbi-Origination-Timestamp header. + +#### 4.2.2.3 Provisioning of charging related information for PDU session + +##### 4.2.2.3.1 Provisioning of Charging Addresses + +The PCF may provide the SMF with the charging information, i.e. the CHF address(es), and if available, the associated CHF instance ID(s) and CHF set ID(s), during the initial interaction with the SMF defining the charging function respectively based on the operator policy. In this case, the PCF may retrieve the CHF addresses, and if available, the associated CHF instance ID(s) and CHF set ID(s) as follows: + +- The PCF receives it from the UDR as part of the Policy Data Subscription information, as defined in clause 5.2.10 of 3GPP TS 29.519 [15]. +- It is locally configured in the PCF based on operator policies. +- The PCF discovers it by interacting with the NRF, as described in clause 6.1 of 3GPP TS 32.290 [30]. + +In order to provision the CHF information to the SMF, the PCF shall include the "chargingInfo" attribute containing the charging information within the SmPolicyDecision data structure. + +Within the ChargingInformation data structure, both the primary CHF address, within the "primaryChfAddress" attribute, and secondary CHF address, within the "secondaryChfAddress" attribute, shall be provided simultaneously when the feature "CHFsetSupport" is not supported. When the feature "CHFsetSupport" is supported, the PCF shall include the "secondaryChfAddress" attribute if available (i.e. if previously retrieved from the UDR, locally configured in the PCF or discovered from the NRF). + +When the CHF supports redundancy based on NF Set concepts as described in 3GPP TS 29.500 [4], the required charging information consists of CHF address, encoded within the "primaryChfAddress" attribute, CHF instance, encoded within the "primaryChfInstanceId" attribute, and primary CHF set id, encoded within the "primaryChfSetId". The CHF set information may be also complemented by secondary CHF address, encoded within the "secondaryChfAddress", for backwards compatibility purposes with the primary/secondary redundancy mechanism. These shall overwrite any predefined CHF addresses and associated CHF instance ID and CHF set ID at the SMF. + +NOTE: When the feature "CHFsetSupport" is supported by the NF service consumer, it indicates the NF service consumer supports CHF redundancy based on NF Set concepts as described in 3GPP TS 29.500 [4], clause 6.5.3. + +Provisioning charging information without PCC rules for charged service data flows shall not be considered as an error, since such PCC rules may be provided later. If the PCF has provided the charging information within the SmPolicyDecision data structure during the initial interaction with the SMF, the PCF shall not modify the charging information in subsequent interactions. + +If no charging information is provisioned by the PCF, the SMF shall use the charging information obtained via one of the following procedures, with the precedence order highest to lowest (see 3GPP TS 32.255 [35], clause 5.1.8): + +1. UDM provided charging characteristics. +2. NRF based discovery. +3. SMF locally configured charging characteristics. + +##### 4.2.2.3.2 Provisioning of Default Charging Method + +The default charging method indicates what charging method shall be used for every PCC rule within which the charging method is omitted, i.e. either both the "online" and the "offline" attributes are not provided or only one of them is provided and set to "false" within the ChargingData data structure to which the PCC rule refers. The SMF may have a pre-configured default charging method. + +Upon the initial interaction with the PCF, the SMF shall provide the pre-configured default charging method, if available, within the "offline" attribute and/or the "online" attribute, and embedded directly within the SmPolicyContextData data structure of the HTTP POST message sent to the PCF. + +The PCF may provide in the response to the received HTTP POST message the default charging method which applies to the PDU session. In order to do so, if offline charging applies, the PCF shall include the "offline" attribute set to + +"true" within the SmPolicyDecision data structure, or if online charging applies, the PCF shall include the "online" attribute set to "true" within the SmPolicyDecision data structure. The default charging method provided by the PCF shall overwrite any predefined default charging method available at the SMF. If the PCF has provided the default charging method during the initial interaction with the SMF, it shall not modify the default charging method in subsequent interactions. + +When the "OfflineChOnly" feature is supported, the PCF may include the "PDU Session with offline charging only" indication as specified in clause 4.2.2.3.3. + +NOTE: It is possible that there is no default charging method applied to a PDU session. + +#### 4.2.2.3.3 Provisioning of the "PDU Session with offline charging only" indication + +If the "OfflineChOnly" feature, specified in clause 5.8, is supported, the PCF may provide in the response to the received HTTP POST message from the SMF the "PDU Session with offline charging only" indication, within the "offlineChOnly" attribute, to signal that the online charging method shall never be configured for any of the PCC Rules activated during the lifetime of the PDU Session, nor provided as the Default Charging Method, as specified in clause 6.4 of 3GPP TS 23.503. + +If the "OfflineChOnly" feature, specified in clause 5.8, is supported and the PCF includes the "PDU Session with offline charging only" indication set to "true" in the "offlineChOnly" attribute within the SmPolicyDecision data structure, then the default charging method for the PDU session is offline charging, and the "online" attribute and the "offline" attribute shall not be provisioned by the PCF within the SmPolicyDecision data structure. + +NOTE: If the PCF includes the "PDU Session with offline charging only" indication set to "true" in the "offlineChOnly" attribute within the SmPolicyDecision data structure, and the "online" attribute and the "offline" attribute are also provisioned by the PCF within the SmPolicyDecision data structure, then the SMF could ignore the values of the "online" attribute and the "offline" attribute. + +#### 4.2.2.4 Provisioning of revalidation time + +The PCF may provide within the SmPolicyDecision data structure the revalidation time within the "revalidationTime" attribute and the "RE\_TIMEOUT" policy control request trigger within the "policyCtrlReqTriggers" attribute to instruct the SMF to trigger an interaction with the PCF to request PCC rule(s). + +The SMF shall start the timer based on the revalidation time and shall trigger a PCC rule request towards the PCF before the indicated revalidation time. + +#### 4.2.2.5 Policy provisioning and enforcement of authorized AMBR per PDU session + +The SMF shall, if available include either the UDM subscribed Session-AMBR or, if the "DN-Authorization" feature is supported, the DN-AAA authorized Session-AMBR per PDU session within the "subsSessAmbr" attribute in the SmPolicyContextData data structure, as defined in clause 4.2.2.2. When both the UDM subscribed Session-AMBR and the DN-AAA authorized Session-AMBR are available in the SMF, the DN-AAA authorized Session-AMBR shall take precedence over the UDM subscribed Session-AMBR. + +NOTE 1: The SMF always provides either the UDM subscribed Session-AMBR or the DN-AAA authorized Session-AMBR per PDU session during an SM policy association establishment procedure except when the SM policy association corresponds to an emergency PDU session. + +In home routed roaming, and if the "VPLMN-QoS-Control" feature is supported, the SMF shall provide the Session-AMBR constraints received from the VPLMN, if available, within the "vplmnQos" attribute. + +When the SMF provides the subscribed Session-AMBR to the PCF, the PCF shall authorize the Session-AMBR based on the operator's policy and, in the home routed scenario, shall ensure that the authorized Session-AMBR value does not exceed the Session-AMBR value provided by the VPLMN, if available. For emergency PDU sessions, the PCF shall behave as specified in clause 4.2.2.9. + +NOTE 2: If the SMF does not provide the Session-AMBR constraints in the VPLMN to the PCF, the PCF considers that no Session-AMBR constraints apply unless operator policies define any. + +When network slice data rate policy control applies, the PCF shall authorize the Session-AMBR as described in clause 4.2.6.8. + +The PCF shall provision the authorized Session-AMBR to the SMF in the response to the received HTTP POST message, as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon reception of the authorized Session-AMBR from the PCF, the SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for the enforcement of the Session-AMBR for the concerned PDU session. + +#### 4.2.2.6 Policy provisioning and enforcement of authorized default QoS + +During PDU session establishment, as defined in clause 4.2.2.2, the SMF shall, if available, include the subscribed default QoS within the "subsDefQos" attribute. + +NOTE 1: The SMF always provides the subscribed default QoS during an SM policy association establishment procedure except when the SM policy association corresponds to an emergency PDU session. + +In home routed roaming, and if the "VPLMN-QoS-Control" feature is supported, the SMF shall provide the default QoS constraints received from the VPLMN, if available, within the "vplmnQos" attribute. + +When the SMF provides the subscribed default QoS to the PCF, the PCF shall authorize the default QoS based on the operator's policy and, in the home routed scenario, shall ensure that the authorized default QoS contains 5QI and ARP values, and MBR/GBR values, if applicable, and if the feature "VPLMN-5QIPrioLevel" is supported, a 5QI Priority Level (when the required 5QI Priority Level is different from the standardized Default Priority Level value in the QoS characteristics Table 5.7.4-1 in 3GPP TS 23.501 [2]), supported by the VPLMN, if available. For emergency PDU sessions, the PCF shall behave as specified in clause 4.2.2.9. + +NOTE 2: If the SMF does not provide the default QoS constraints in the VPLMN to the PCF, the PCF considers that no default QoS constraints apply unless operator policies define any. + +The PCF shall provision the authorized default QoS to the SMF in the response to the received HTTP POST message, as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon reception of the authorized default QoS, the SMF enforces it, which may lead to the change of the subscribed default QoS. The SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for this enforcement of the authorized default QoS for the concerned PDU session. + +NOTE 3: If dynamic PCC is not deployed, the SMF can have a DNN based configuration to enable the establishment of a GBR resource type default QoS flow. This configuration contains a standardized GBR 5QI as well as GFBR and MFBR for UL and DL. + +NOTE 4: GBR resource type is not applicable to the default QoS flow of a PDU session that is interworking with EPS. + +#### 4.2.2.7 Provisioning of PCC rule for Application Detection and Control + +If the ADC feature is supported, and the user subscription indicates that application detection and control is required, the PCF may provision PCC rule(s) for application detection and control as defined in clause 4.2.6.2.11 in the response message to the received HTTP POST request from the SMF. + +If the SMF receives a PCC rule for application detection and control, the SMF shall instruct the UPF to detect the associated application traffic as defined in 3GPP TS 29.244 [13]. + +#### 4.2.2.8 3GPP PS Data Off Support + +When the 3GPP-PS-Data-Off feature, as defined in clause 5.8, is supported, and if the SMF is informed that the 3GPP PS Data Off status of the UE is set to active during the establishment of a PDU session over 3GPP access and/or non-3GPP access, it shall include the "3gppPsDataOffStatus" attribute set to true within the SmPolicyContextData data structure in the HTTP POST message that it sends to the PCF, as defined in clause 4.2.2.2. + +If the PCF receives that HTTP POST message with a SmPolicyContextData data structure containing a "3gppPsDataOffStatus" attribute set to true as above and the "accessType" attribute indicating "3GPP\_ACCESS", the PCF shall configure the SMF to block any downlink and optionally uplink IP flows that are not related to a service contained in the list of 3GPP PS Data Off Exempt Services, e.g. by not installing any related dynamic PCC rule(s) or by not activating the related predefined PCC rule(s) such as PCC rule(s) with wild-carded service data flow filters. The + +PCF may also, subject to its normal policies, provide the PCC rule(s) for the service(s) included in the list of 3GPP PS Data Off Exempt Services, as defined in clause 4.2.6.2.1. + +The PCF shall subscribe to the "AC\_TY\_CH" policy control request trigger with the SMF, as defined in clause 4.2.6.4, in order to support this feature, if the PCF determines that the UE is allowed to access the network via non-3GPP access. + +NOTE 1: The PCF can be configured with a list of 3GPP PS Data Off Exempt Services per DNN and S-NSSAI. The list of 3GPP PS Data Off Exempt Services for an DNN and S-NSSAI can also be empty, or can allow for any service within that DNN and S-NSSAI, according to operator policy. + +NOTE 2: For the PDU session used for IMS services, the 3GPP Data Off Exempt Services are enforced in the IMS domain as specified in 3GPP TS 23.228 [16]. Policies configured in the PCF need to ensure that IMS services are allowed when the 3GPP Data Off status of the UE is set to active, e.g. by treating any service within a well-known IMS DNN as part of the 3GPP PS Data Off Exempt Services. + +NOTE 3: The packets transferred over non-3GPP access are unaffected by the 3GPP PS Data Off functionality. + +If the "ATSSS" feature, as defined in clause 5.8 is supported, and the PCF receives in the SmPolicyContextData data structure the "maPduInd" attribute, the "3gppPsDataOffStatus" attribute set to true and the "accessType" attribute or the "addAccInfo" attribute set to "3GPP\_ACCESS", the PCF shall configure the SMF in such a way that: + +- packets for services belonging to the 3GPP PS Data Off Exempt services are forwarded over 3GPP access and non-3GPP access as indicated by the policy for ATSSS Control, as specified in clause 4.2.6.2.17; and +- for downlink and optionally uplink flows not related to a service contained in the list of 3GPP PS Data Off Exempt services, the PCF may configure the SMF to handle the associated traffic only via non-3GPP access, if available, by providing the corresponding ATSSS policy within the related PCC rule, as specified in clause 4.2.6.2.17. + +#### 4.2.2.9 IMS Emergency Session Support + +A SMF that requests PCC Rules at PDU Session Establishment for an IMS emergency session in a PLMN or an SNPN shall send an HTTP POST message to the PCF, as defined in clause 4.2.2.2, including the "dnn" attribute containing the Emergency DNN. The SMF may include the SUPI, within the "supi" attribute, and if the SUPI is not available or unauthenticated, the SMF shall include the PEI, within the "pei" attribute, the "invalidSupi" attribute set to "true" and an implementation specific value within the "supi" attribute. The SMF may include the rest of the attributes described in clause 4.2.2.2. The SMF may also include the GPSI, if available, within the "gpsi" attribute. + +NOTE 1: The SMF will not provide subscribed information (e.g. subscribed default QoS or subscribed Session AMBR) to the PCF when the SUPI is not available, unauthenticated or based on local configuration. + +NOTE 2: IMS Emergency services are not supported for SNPN when the UE accesses the SNPN over NWu via a PLMN. + +The PCF shall detect that a PDU session is restricted to IMS Emergency services when the "dnn" attribute included in the HTTP POST message received from the SMF includes a data network identifier that matches one of the Emergency DNs from the configurable list. The PCF does not perform in this case subscription check procedures with UDR; it uses instead the locally configured operator policies to make authorization and policy decisions. The PCF: + +- shall provision PCC Rules restricting the access to Emergency Services (e.g. P-CSCF(s), DHCP(s), DNS(s) and SUPL(s) addresses), as required by local operator policies, in a response message to the SMF according to the procedures described in clause 4.2.6; +- may provision the authorized QoS that applies to the default QoS flow in the response message to the SMF within the "authDefQos" attribute of a session rule according to the procedures described in clause 4.2.3.6, except for obtaining the authorized QoS upon interaction with the UDR. The value of the "priorityLevel" attribute included within the "arp" attribute shall be assigned as required by local operator policies (e.g. if an IMS Emergency session is prioritized, the "priorityLevel" attribute may contain a value that is reserved for an operator domain use of IMS Emergency sessions). If the "accessType" attribute is set to "3GPP\_ACCESS", the values of the "preemptCap" and the "preemptVuln" attributes included within the "arp" attribute shall be assigned as required by local operator policies, + +- may provision the authorized Session-AMBR in the response message to the SMF, according to the procedures described in clause 4.2.3.5. + +When the SMF detects that the provisioning of PCC Rules failed, the PCC rule error handling procedures shall be performed. + +#### 4.2.2.10 Request Usage Monitoring Control + +If the UMC as defined in clause 5.8 is supported, the PCF may provision the usage monitoring control policy to the SMF as defined in clause 4.2.6.5.3. + +#### 4.2.2.11 Access Network Charging Identifier report + +During the PDU session establishment procedure, if the Access Network Charging Identifier is within the Uint32 value range, the SMF may provide the access network charging identifier information within the "accNetChId" attribute of the SmPolicyContextData data structure. Within the associated AccNetChId data structure, the SMF shall include the "accNetChIdValue" attribute containing the Access Network Charging Identifier for the PDU session (i.e., for the default QoS flow) and the "sessionChScope" attribute set to true. The SMF may provide the address of the network entity performing the charging functionality within the "chargEntityAddr" attribute. + +NOTE: As specified in 3GPP TS 32.255 [35] clause 5.1.4, the SMF assigns a charging identifier per PDU session and is used through the PDU session's lifetime. The report of Access Network Charging Identifier(s) in 5GS and EPS interworking scenarios is described in clause B.3.2.3. + +If the "AccNetChargId\_String" feature is supported by the SMF, and the Access Network Charging Identifier value is longer than Uint32: + +- if the SMF doesn't know if the PCF supports the "AccNetChargId\_String" feature, the SMF shall not provide the access network charging identifier information; +- if the SMF knows the PCF supports the feature "AccNetChargId\_String", the SMF shall encode the access network charging identifier within "accNetChargIdString" attribute. + +#### 4.2.2.12 Request for the successful resource allocation notification + +The PCF may request the SMF to confirm that the resources associated to a PCC rule are successfully allocated as defined in clause 4.2.6.5.5. + +#### 4.2.2.13 Request of Presence Reporting Area Change Report + +If the PRA or ePRA feature, as defined in clause 5.8, is supported, the PCF may provision the Presence Reporting Area Information to the SMF as defined in clause 4.2.6.5.6. + +#### 4.2.2.14 Provisioning of IP Index Information + +If the PDU session type received within the "pduSessionType" attribute is "IPv4" or "IPv6" or "IPv4V6", and no corresponding IP address/prefix is received, the PCF may include within the SmPolicyDecision data structure the IP index information within the "ipv4Index" attribute, for IPv4 address allocation, and/or the "ipv6Index" attribute, for IPv6 address allocation, based on the user's subscription information retrieved from the UDR and operator's policy. + +The SMF may use this IP index information to assist in selecting how the IP address is to be allocated when multiple allocation methods or multiple instances of the same method are supported. + +#### 4.2.2.15 Negotiation of the QoS flow for IMS signalling + +If the SMF includes the "qosFlowUsage" attribute required for the default QoS flow within the SmPolicyContextData data structure during the PDU session establishment procedure, the PCF shall provide the "qosFlowUsage" attribute back in the response with the authorized usage. + +If during PDU session establishment procedure, the SMF includes the "IMS\_SIG" value within the "qosFlowUsage" attribute and the PCF accepts that default QoS flow is dedicated to IMS signalling, the PCF shall within the + +SmPolicyDecision data structure include the "IMS\_SIG" value within the "qosFlowUsage" attribute. In this case, the PCF shall restrict the QoS flow to only be used for IMS signalling as specified in 3GPP TS 23.228 [16] by applying the applicable 5QI for IMS signalling. + +If the SMF include the "IMS\_SIG" value within the "qosFlowUsage" attribute of the SmPolicyContextData data structure, but the PCF does not include the "IMS\_SIG" within the "qosFlowUsage" attribute of SmPolicyDecision data structure, the PCC Rules provided by the PCF shall have a 5QI value different from the 5QI value for the IMS signalling. + +#### 4.2.2.16 PCF resource cleanup + +In the Npcf\_SMPolicyControl\_Create service operation, the SMF as NF service consumer may provide SMF Id in "smfId" attribute and recovery timestamp in "recoveryTime" attribute. The PCF may use the "smfId" attribute to supervise the status of the SMF as described in clause 5.2 of 3GPP TS 29.510 [29] and perform necessary cleanup upon status change of the SMF later, and/or both the "smfId" attribute and the "recoveryTime" attribute in cleanup procedure as described in clause 6.4 of 3GPP TS 23.527 [33]. + +#### 4.2.2.17 Access traffic steering, switching and splitting support + +If the SMF supports the "ATSSS" feature defined in clause 5.8, the SMF shall within the SmPolicyContextData data structure include the ATSSS capability within the "atsssCapab" attribute and the MA PDU session Indication within the "maPduInd" attribute as defined in clause 4.2.2.2. + +The SMF determines the ATSSS capability supported for the MA PDU Session based on the ATSSS capabilities provided by the UE and per DNN configuration on SMF, as follows: + +- a. If the SMF receives the UE's ATSSS capabilities "MPTCP functionality with any steering mode and ATSSS-LL functionality with only Active-Standby steering mode" and; + - i. if the DNN configuration allows both MPTCP and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_UL"; or; + - ii. if the DNN configuration allows both MPTCP and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, but the UPF does not support the RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL". + - iii. if the DNN configuration allows MPTCP with any steering mode and ATSSS-LL with only Active-Standby steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_DLUL". +- b. If the SMF receives the UE's ATSSS capabilities "ATSSS-LL functionality with any steering mode" and the DNN configuration allows ATSSS-LL with any steering mode, the SMF shall set the "atsssCapab" attribute to the value "ATSSS\_LL". +- c. If the SMF receives the UE's ATSSS capabilities "MPTCP functionality with any steering mode and ATSSS-LL functionality with any steering mode", and the DNN configuration allows both MPTCP and ATSSS-LL with any steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_ATSSS\_LL". + +If the SMF supports the "EnATSSS\_v2" feature defined in clause 5.8 + +- a. If the SMF receives the UE's ATSSS capabilities "MPQUIC functionality with any steering mode and ATSSS-LL functionality with only Active-Standby steering mode" and; + - i. if the DNN configuration allows both MPQUIC and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL"; + - ii. if the DNN configuration allows both MPQUIC and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, but the UPF does not support the RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL"; or + +- iii. if the DNN configuration allows MPQUIC with any steering mode and ATSSS-LL with only Active-Standby steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_DLUL". +- b. If the SMF receives the UE's ATSSS capabilities "MPQUIC functionality with any steering mode and ATSSS-LL functionality with any steering mode", and the DNN configuration allows both MPQUIC and ATSSS-LL with any steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPQUIC\_ATSSS\_LL". +- c. If the SMF receives the UE's ATSSS capabilities " MPTCP functionality with any steering mode, MPQUIC functionality with any steering mode and ATSSS-LL functionality with only Active-Standby steering mode" and; + - i. if the DNN configuration allows MPTCP, MPQUIC and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL"; + - ii. if the DNN configuration allows MPTCP, MPQUIC and ATSSS-LL with any steering mode, including RTT measurement without using PMF protocol, but the UPF does not support the RTT measurement without using PMF protocol, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL"; or + - iii. if the DNN configuration allows MPTCP and MPQUIC with any steering mode and ATSSS-LL with only Active-Standby steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_DLUL". +- d. If the SMF receives the UE's ATSSS capabilities "MPTCP functionality with any steering mode, MPQUIC functionality with any steering mode and ATSSS-LL functionality with any steering mode", and the DNN configuration allows MPTCP, MPQUIC and ATSSS-LL with any steering mode, the SMF shall set the "atsssCapab" attribute to the value "MPTCP\_MPQUIC\_ATSSS\_LL". + +If the SMF receives the MA PDU Request Indication from the UE and the SMF determines that the MA PDU session is allowed based on the Session Management subscription data retrieved from the UDM and the operator policy, the SMF shall include the "MA\_PDU\_REQUEST" within the "maPduInd" attribute; otherwise if the SMF receives the MA PDU Network-Upgrade Allowed indication from the UE and the SMF determines that the MA PDU session is allowed based on the Session Management subscription data retrieved from the UDM and the operator policy, the SMF shall include the "MA\_PDU\_NETWORK\_UPGRADE\_ALLOWED" within the "maPduInd" attribute. + +If the PCF supports the "ATSSS" feature, the PCF may provide PCC rules and/or session rules of ATSSS policy for the MA PDU session as defined in clause 4.2.6.2.17 and clause 4.2.6.3.4; otherwise the PCF shall not provide any PCC rules and/or session rules of ATSSS policy. + +#### 4.2.2.18 DNN Selection Mode Support + +If the SMF supports the "DNNSelectionMode" feature defined in clause 5.8, when the SMF receives from the AMF the DNN selection mode, the SMF shall send an HTTP POST message as defined in clause 4.2.2.2 and shall include the received information in the "dnnSelMode" attribute. + +The "dnnSelMode" attribute indicates whether the DNN supplied in the "dnn" attribute is an explicitly subscribed DNN and thus verified by the network against UDM subscription (regardless of whether it was originally provided by the UE or replaced by the network), or if it is a non-subscribed DNN (and provided by the UE, or replaced by the network). + +If the PCF supports the "DNNSelectionMode" feature, when the "dnnSelMode" attribute indicates: + +- the DNN is not explicitly subscribed, the PCF may provision PCC rules and Session rules according to the PCF local configuration for the UE provided and/or network provided non-subscribed DNN; +- the DNN is explicitly subscribed and verified by the network against UDM subscription, the PCF proceeds according to existing specified procedures. + +#### 4.2.2.19 Detection of the SM Policy Association enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking + +When the feature "TimeSensitiveNetworking" is supported, the PCF detects if the Npcf\_SMPolicyControl\_Create request relates to SM Policy Association enabling Time Sensitive Communications Time Synchronization and/or Deterministic Networking based on the received DNN and S-NSSAI. The PCF then may provide within the SmPolicyDecision data structure the "TSN\_BRIDGE\_INFO" policy control request trigger within the "policyCtrlReqTriggers" attribute to instruct the SMF to trigger a PCF interaction when the trigger is met; i.e., new TSC user plane node information (e.g. TSN Bridge or DetNet router information) is available. + +NOTE: Time sensitive communication, time synchronization and deterministic networking are not supported in home-routed roaming scenarios, and service continuity is not supported when the UE moves from 5GS to EPS. + +#### 4.2.2.20 Support of Dual Connectivity end to end redundant User Plane paths + +Upon the initial interaction with the PCF, if the "Dual-Connectivity-redundant-UP-paths" feature is supported, the PCF shall determine, based on operator's policy (e.g. when some of the allowed services require redundancy), whether the PDU session is a redundant one. + +When the PCF determines that the PDU session is a redundant PDU session, the PCF shall provision the "redSessIndication" attribute set to true within the SmPolicyDecisionData returned in the response to the HTTP POST request. Upon receiving the indication from the PCF that the PDU session is a redundant PDU session, the SMF shall apply the corresponding procedures towards the access network and the UPF for the establishment of the redundant user plane paths as defined in clause 5.33.2.1 of 3GPP TS 23.501 [2]. + +The PCF shall not modify during the PDU session lifetime the indication of whether the redundant user plane paths are allowed for the PDU session. + +#### 4.2.2.21 User Plane Remote Provisioning of UE SNPN Credentials in Onboarding Network + +User Plane Remote Provisioning of UEs SNPN Credentials when in Onboarding Network (ONN) is provided using a PDU session for a DNN and S-NSSAI used for onboarding. + +The PCF may make authorization and policy decisions to restrict the use of the PDU Session established to the DNN and S-NSSAI used for onboarding in an ONN, e.g., by restricting the traffic to/from Provisioning Server address(es) and DNS server address(es) only. An ONN is either an ON-SNPN or a PLMN/SNPN. + +When the ONN is an ON-SNPN and the "PvsSupport" feature is supported, during the PDU session establishment procedure related to a PDU session used for User Plane Remote Provisioning, the SMF shall include the indication that the PDU session is used for onboarding with the "onboardInd" attribute set to true and provide within "pvsInfo" attribute, if available, the information related to the Provisioning Server(s) that provisions the UE with credentials and other data to enable SNPN access. + +NOTE 1: When an SNPN that provides access to localized services is acting as ON-SNPN, the SMF includes both DCS provided and the locally configured PVS IP address(es) and/or PVS FQDN(s), in the request to the PCF. + +If the "onboardInd" attribute set to true is received during the SM policy association establishment, the PCF deducts that the combination of the received DNN within "dnn" attribute and the S-NSSAI within "sliceInfo" attribute corresponds to a PDU session used for User Plane Remote Provisioning. In this case, the PCF shall omit the subscription data check with UDR. Instead, the PCF shall use the locally stored Onboarding Configuration Data for this DNN and S-NSSAI combination to make authorization and policy decisions. + +If the "pvsInfo" attribute with the Provisioning Server(s) information is received in the request, the PCF shall use the received information to create the service data flow template of the Provisioning Server(s) in the derived PCC Rule(s). If the "pvsInfo" attribute is not received, the PCF shall construct this service data flow template(s) based on the local configuration stored as part of the Onboarding Configuration Data. In addition, the PCF may create service data flow templates for the DNS server address(es) stored as part of the Onboarding Configuration Data. The "pvsInfo" attribute provided by the SMF may include, for each provided Provisioning Server, the Provisioning Server IP address(es) and/or FQDN(s). + +NOTE 2: How the PCF resolves a Provisioning Server FQDN to an IP address or IP address range with other mechanism than local configuration in the Onboarding Configuration Data is not specified in this release of the specification + +The PCF shall select the QoS information of the PCC rule(s) applicable to the User Plane Remote Provisioning service based on policies locally configured at the PCF as part of the Onboarding Configuration Data. + +The PCF shall install the derived PCC Rule(s) in the response. The installed PCC Rule(s) shall take precedence over the locally stored PCC Rule(s) in the SMF. + +When the SMF detects that the provisioning of PCC Rules failed, the PCC rule error handling procedures shall be performed. + +NOTE 3: When the ONN is a PLMN or a SNPN, the SMF does not provide the "onboardInd" attribute and the "pvsInfo" attribute. The PCF retrieves policy control subscription profile for this SUPI, DNN, S-NSSAI from UDR, that includes the list of allowed services. If the list of allowed services includes both PVS and DNS services, then the PCF, based on local policies, determines the PVS and DNS address(es) to be used in the SDF template of the PCC Rule(s) and allows traffic to/from these destinations as per currently specified procedures. + +#### 4.2.2.22 Network slice related data rate policy control + +When an Npcf\_SMPolicyControl\_Create request is received, the PCF may check if the S-NSSAI to which the received request relates is subject to network slice data rate policy control. If it is the case, the PCF shall apply network slice data rate control as described in clause 4.2.6.8. + +#### 4.2.2.23 Group related data rate policy control + +When an Npcf\_SMPolicyControl\_Create request is received, the PCF may apply group data rate control as described in clause 4.2.6.9. + +#### 4.2.2.24 Network slice usage control + +When the PCF receives a Npcf\_SMPolicyControl\_Create request and the "NetSliceUsageCtrl" feature is supported, the PCF may check whether the S-NSSAI to which the received request relates is subject to network slice usage control. If it is the case, the PCF may provision in the Npcf\_SMPolicyControl\_Create response the network slice usage control information (e.g., the slice PDU session inactivity timer value) within the "sliceUsgCtrlInfo" attribute of the SmPolicyDecision data structure, as specified in clause 5.15.15.3 of 3GPP TS 23.501 [2]. + +NOTE: In this release of the specification, network slice usage control information provisioning by the PCF is not supported in roaming scenarios. + +### 4.2.3 Npcf\_SMPolicyControl\_UpdateNotify Service Operation + +#### 4.2.3.1 General + +The UpdateNotify service operation provides updated Session Management related policies to the NF service consumer (SMF) or triggers the deletion of the context of SM related policies. The POST method is used for both update and terminate operations. + +The following procedures using the Npcf\_SMPolicyControl\_UpdateNotify service operation are supported: + +- PCF initiated update of the policies associated with a PDU session. +- PCF initiated deletion of the SM Policy Association of a PDU session. +- Provisioning of PCC rules. +- Provisioning of policy control request triggers. +- Provisioning of revalidation time. + +- Policy provisioning and enforcement of the authorized AMBR per PDU session. +- Policy provisioning and enforcement of the authorized default QoS. +- Provisioning of PCC rules for Application Detection and Control. +- 3GPP PS Data Off Support. +- IMS Emergency Session Support. +- Request Access Network Information. +- Request Usage Monitoring Control. +- Request for the result of PCC rule removal. +- Access Network Charging Identifier request. +- Request successful resource allocation notifications. +- IMS Restoration Support. +- P-CSCF Restoration Enhancement Support. +- Access traffic steering, switching and splitting support. +- Policy provisioning and enforcement of AF session with required QoS. +- Forwarding of TSC user plane node management information and port management information received from the TSN AF or TSCTSF. +- Provisioning of TSCAI input information and TSC QoS related data. +- Policy provisioning of QoS Monitoring control. +- Policy decision and condition data error handling. +- Network slice related data rate policy control. +- Request of Presence Reporting Area Change Report. +- PCC Rule Error Report. +- Session Rule Error Report. +- Group related data rate policy control. +- VPLMN Specific Offloading Policy. +- Support of Network Slice Usage Control. + +#### 4.2.3.2 SM Policy Association Update request + +![Sequence diagram for SM Policy Association Update request](67d03c9e89620d73e3786c869e559752_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of PCF: 1. POST {notificationUri}/update + NF service consumer->>PCF: Request + Note right of PCF: 2a. 200OK + Note right of PCF: 2b. 204 No Content + PCF-->>NF service consumer: Response +``` + +The diagram illustrates the interaction between an NF service consumer and a PCF for an SM Policy Association Update request. The sequence starts with the NF service consumer sending a POST request to the PCF. The PCF responds with either a 200OK or a 204 No Content status. + +Sequence diagram for SM Policy Association Update request + +Figure 4.2.3.2-1: SM Policy Association Update request + +The PCF may decide to provision policies related to an Individual SM Policy resource without obtaining a request from the NF service consumer, e.g. in response to information provided to the PCF via the Rx or N5 reference points, or in response to an internal trigger within the PCF, e.g., the activation of a pending policy counter provided via the Nchf\_SpendingLimitControl Service (see 3GPP TS 29.594 [63]). The PCF shall send for this purpose a POST request to the NF service consumer (e.g. SMF) using the URI "{notificationUri}/update". The content of the message shall contain a SmPolicyNotification data structure that contains: + +- the representation of the updated policies within the "smPolicyDecision" attribute; and +- the resource URI of the Individual SM Policy resource related to the notification within the "resourceUri" attribute. + +Detailed procedures related to the provisioning and enforcement of the policy decisions contained within the SmPolicyDecision data structure are provided in clause 4.2.6. + +When the PCF has received from an NF service consumer (e.g., an AF) temporal invalidity conditions information for a PDU session of a UE or group of UE(s), the PCF shall evaluate the temporal invalidity conditions of the AF request and may inform the SMF to install, modify or remove the corresponding policy decisions (e.g. PCC rule(s)) according to the evaluation result. + +In case of a successful update of SM policies: + +- if the PCF provisioned policy control request triggers (applicable triggers are as defined in Table 5.6.2.26-1), a "200 OK" response code and a response body with the corresponding available information in the "UeCampingRep" data structure shall be returned in the response; +- otherwise, a "204 No Content" response code shall be returned in the response. + +NOTE: When there is an ongoing procedure that collisions with the update of SM policies (e.g. during handover from 5GS to EPS) the SMF, based on operator policies, can delay the update of SM policies and return a "204 No Content" response code. In this case the SMF will process the request when the procedure is finished. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If the "SessionRuleErrorHandler" feature is not supported and the NF service consumer received one or more PCC rules from the PCF, but the validation of all these PCC Rules was unsuccessful, the NF service consumer shall reject the request and include in an HTTP "400 Bad Request" response message the ErrorReport data structure. Within the ErrorReport data structure, the NF service consumer shall include the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "PCC\_RULE\_EVENT" or "PCC\_QOS\_FLOW\_EVENT" and the "ruleReports" attribute to report the PCC rule status of the affected PCC rules as defined in clause 4.2.3.16. + +If the "SessionRuleErrorHandler" feature is supported and the NF service consumer received one or more PCC rules and/or session rules from the PCF but the validation of all these PCC Rules and/or session rules was unsuccessful, the NF service consumer shall reject the request and include in an HTTP "400 Bad Request" response message the ErrorReport data structure. Within the ErrorReport data structure, the NF service consumer shall include the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "RULE\_PERMANENT\_ERROR" or "RULE\_TEMPORARY\_ERROR" and the "ruleReports" attribute to report the PCC rule status of the affected PCC rules as defined in clause 4.2.3.16 and/or the "sessRuleReports" attribute to report the session rule status of the affected session rules as defined in clause 4.2.3.20. + +If in the cases above, if the "PolicyDecisionErrorHandler" feature is supported, the PCF provisioned policy decisions and/or condition data which are not referred by any PCC rules or session rules and, in addition of the report of the faulty PCC rule(s) and/or session rule(s), the NF service consumer needs to report the failed policy decisions and/or condition data, the "policyDecFailureReports" attribute shall also be provided as described in clause 4.2.3.26. Additionally, if the "ExtPolicyDecisionErrorHandler" feature is supported the NF service consumer may also provide the "invalidPolicyDecs" as described in clause 4.2.3.26.2. + +If the "Ext2PolicyDecisionErrorHandling" feature is supported, the NF service consumer did not receive neither PCC rules nor session rules and received policy decision types and/or condition types which are not referred by any PCC rules or session rules, and the storage of all the policy decision types and/or condition data was unsuccessful (e.g. the policy decision could not be successfully stored due to a limitation of resources at the SMF) or there were semantical inconsistencies in the provided data, the NF service consumer shall include in an HTTP "400 Bad Request" response message the ErrorReport data structure including the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "POL\_DEC\_ERROR" and shall behave as defined in clause 4.2.3.26. + +If the "SessionRuleErrorHandling" feature is not supported and if the NF service consumer received one or more PCC rules from the PCF but the validation of some of them was unsuccessful, the NF service consumer shall include an HTTP "200 OK" status code together with one or more RuleReport data structure(s) to report the PCC rule status of the affected PCC rules as defined in clause 4.2.3.16 in the "PartialSuccessReport" data structure included in the response message. The "failureCause" attribute of the "PartialSuccessReport" shall be set to "PCC\_RULE\_EVENT" or "PCC\_QOS\_FLOW\_EVENT". + +If the "SessionRuleErrorHandling" feature is supported and the NF service consumer received one or more PCC rule and/or session rules from the PCF but the validation of some of them was unsuccessful, the NF service consumer shall include an HTTP "200 OK" status code together with the "ruleReports" attribute to report the PCC rule status of the affected PCC rules as defined in clause 4.2.3.16 and/or the "sessRuleReports" attribute to report the session rule status of the affected session rules as defined in clause 4.2.3.20 in the "PartialSuccessReport" data structure included in the response message. The "failureCause" attribute of the "PartialSuccessReport" shall be set to "RULE\_PERMANENT\_ERROR" or "RULE\_TEMPORARY\_ERROR". + +If the "PolicyDecisionErrorHandling" feature is supported, the NF service consumer received policy decision types and/or condition types which are not referred by any PCC rules or session rules, and the storage or validation of not all the policy decision types and/or condition data was unsuccessful, the NF service consumer shall reply with an HTTP "200 OK" response message and behave as described in clause 4.2.3.26. + +If the PCF provisioned policy control request triggers and the NF service consumer needs to report partial success information, the NF service consumer may include in the "PartialSuccessReport" data structure the "ueCampingRep" attribute with the corresponding available information. When it is required to report multiple instances of the "PartialSuccessReport" data structure due to different "failureCause" values, the NF service consumer shall use only one instance of the "PartialSuccessReport" data structure to include the "ueCampingRep" attribute with the corresponding available information. + +#### 4.2.3.3 SM Policy Association termination request + +![Sequence diagram showing SM Policy Association termination request. The NF service consumer sends a POST {notificationUri}/terminate request to the PCF, and the PCF responds with a 204 No Content.](18291be12b470a557e8c9f3a74e021be_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: 1. POST {notificationUri}/terminate + NF service consumer->>PCF: 1. POST {notificationUri}/terminate + Note right of PCF: 2. 204 No Content + PCF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing SM Policy Association termination request. The NF service consumer sends a POST {notificationUri}/terminate request to the PCF, and the PCF responds with a 204 No Content. + +**Figure 4.2.3.3-1: SM Policy Association termination request** + +The PCF may request PDU session termination and the corresponding deletion of the Individual SM policy resource in the following circumstances: + +- If the PCF decides to terminate a PDU session due to an internal trigger or a trigger from the UDR. +- The PCF may also decide to terminate a PDU session upon receiving a POST message from the NF service consumer (e.g. when data usage quota is reached). + +The PCF shall send a POST request to the NF service consumer (e.g. SMF) using the URI {notificationUri}/terminate and include the TerminationNotification data structure in the body of the HTTP POST request. Within the TerminationNotification data structure, the PCF shall include: + +- the resource URI of the Individual SM policy resource related to the termination request within the "resourceUri" attribute; and +- the cause of why the PCF requests the termination of the policy association within the "cause" attribute. + +If the NF service consumer accepts the received POST request, the NF service consumer shall send a "204 No Content" response. + +After the successful processing of the HTTP POST request, the NF service consumer shall invoke the Npcf\_SMPolicyControl\_Delete Service Operation defined in clause 4.2.5 to terminate the policy association and initiate the procedure to terminate the PDU session as defined in 3GPP TS 29.502 [22]. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 4.2.3.4 Provisioning of revalidation time + +During the lifetime of a PDU session, within the SmPolicyDecision data structure, the PCF may provide the revalidation time within the "revalidationTime" attribute and the "RE\_TIMEOUT" policy control request trigger within the "policyCtrlReqTriggers" attribute to instruct the SMF to trigger an interaction with the PCF to request PCC rule(s) if not provided yet. The PCF may also update the revalidation time by including the new value within the "revalidationTime" attribute. The PCF may disable the revalidation function by removing the "RE\_TIMEOUT" policy control request trigger, if it has been previously provided. + +When the SMF receives the revalidation time within the "revalidationTime" attribute, the SMF shall store the received value and start the associated timer based on it. Then, the SMF shall trigger a PCC rule request towards the PCF before the indicated revalidation time. + +If the "RE\_TIMEOUT" policy control request trigger is removed, the SMF shall stop the associated timer. + +NOTE: By disabling the revalidation function, the revalidation time value previously provided to the SMF is not applicable anymore. + +#### 4.2.3.5 Policy provisioning and enforcement of authorized AMBR per PDU session + +The PCF may modify the authorized Session-AMBR at any time during the lifetime of the PDU session and provision it to the SMF by invoking the procedure defined in clause 4.2.3.2. + +If the "VPLMN-QoS-Control" feature is supported, the PCF shall ensure that the authorized Session-AMBR value does not exceed the Session-AMBR supported by the VPLMN, if applicable. + +The PCF shall provision the new authorized session AMBR to the SMF as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon reception of the authorized Session-AMBR, the SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for the enforcement of the AMBR for the concerned PDU session. + +For UL Classifier or Multi-homing PDU Sessions, the SMF will provision the policies of session-AMBR for the downlink and uplink directions to the UL Classifier/Branching Point functionality and in addition provision the policies of Session-AMBR for the downlink direction to all the PDU session anchors, as defined in clause 5.4.4 of 3GPP TS 29.244 [13]. + +#### 4.2.3.6 Policy provisioning and enforcement of authorized default QoS + +The PCF may modify the authorized default QoS during the lifetime of the PDU session and provision it to the SMF by invoking the procedure defined in clause 4.2.3.2. + +If the "VPLMN-QoS-Control" feature is supported, the PCF shall ensure that the authorized default QoS contains 5QI and ARP values, and MBR/GBR values, if applicable, and if the feature "VPLMN-5QIPrioLevel" is supported, a 5QI Priority Level (when the required 5QI Priority Level is different from the standardized Default Priority Level value in the QoS characteristics Table 5.7.4-1 in 3GPP TS 23.501 [2]), supported by the VPLMN, if applicable. + +The PCF shall provision the authorized default QoS to the SMF as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon reception of the authorized default QoS, the SMF enforces it, which may lead to the change of the subscribed default QoS. The SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for the enforcement of the authorized default QoS for the concerned PDU session. + +#### 4.2.3.7 Provisioning of PCC rule for Application Detection and Control + +If the ADC feature is supported, the user subscription indicates that application detection and control is enabled, and the PCF determines that application detection is required because of e.g. an internal/external trigger or the PCF has received from an NF service consumer (e.g. another PCF or an AF) a subscription to the event for application start/stop traffic detection (see TS 29.514 [17], clause 4.2.6.9 for PCF subscription to application detection control and TS 29.523 [61], clause 4.2.2 for AF subscription to application detection control), the PCF may provision PCC rule(s) for application detection and control as defined in clause 4.2.6.2.11 in the notification (i.e. HTTP POST) request. + +When the PCF provisions PCC rule(s) for application detection and control the PCF update of the mute indication is not allowed during the PDU session lifetime, i.e., if for the PCC rule, the application's start or stop notifications are muted, the PCC rule shall remain with the application's start or stop notifications muted along the PDU session lifetime, and viceversa, if for the PCC rule, the application's start or stop notifications are not muted, the PCC rule shall remain with the application's start or stop notifications not muted along the PDU session lifetime. The SMF shall reject the PCC rule modification as specified in clause 4.2.6.2.11. + +If the SMF receives PCC rule(s) for application detection and control, the SMF shall instruct the UPF to detect the application traffic as defined in 3GPP TS 29.244 [13]. + +#### 4.2.3.8 3GPP PS Data Off Support + +When the PCF receives service information from the AF while the 3GPP PS Data Off handling functionality is active as described in clause 4.2.2.8 or 4.2.4.8, the PCF shall check: + +- for a non-MA PDU session, whether the corresponding service is a 3GPP PS Data Off Exempt Service and permissible according to the user's subscription and the policies of the PCF; +- for a MA PDU session: + - a. whether the corresponding service is a 3GPP Data Off Exempt Service and permissible according to the user's subscription and the policies of the PCF; or + - b. whether the corresponding service does not belong to the 3GPP PS Data Off Exempt Services, but: + - the non-3GPP access is available; and + - the PCF policies allow all the traffic of the service to be forwarded using the non-3GPP access. + +If so, the PCF shall install, modify or delete the corresponding PCC rules. For a MA PDU session and when the service does not belong to the 3GPP PS Data Off Exempt Services, the policy for ATSSS Control included in the PCC rule, as specified in clause 4.2.6.2.17, shall enable all the traffic to be forwarded using only the non-3GPP access. + +Otherwise, the PCF shall reject the service information from the AF. + +If the PCF determines that the 3GPP PS Data Off handling functionality becomes inactive, the PCF shall make the necessary policy control decisions and provision the PCC rules to make sure that services are allowed according to the user's subscription and operator policy (irrespective of whether they belong to the list of 3GPP PS Data Off Exempt Services). + +NOTE: The PCF can then open gates via the "flowStatus" attribute for active PCC rules associated to services not contained in the list of 3GPP PS Data Off Exempt Services. The PCF can also install PCC rules or activate predefined PCC rules for some services not belonging to the list of 3GPP PS Data Off Exempt Services. If the PCF activates or installs a PCC rule with wildcarded filters, it can remove or de-activate PCC rules for 3GPP PS Data Off Exempt Services that are redundant to this PCC rule. + +#### 4.2.3.9 IMS Emergency Session Support + +##### 4.2.3.9.1 Provisioning of PCC rule + +When the PCF receives IMS service information from the AF for an Emergency service and derives authorized PCC Rules from the service information, the "priorityLevel", the "preemptCap" and the "preemptVuln" attributes of the Arp data structure within the QoS data decision to which each PCC Rule refers shall be assigned values (i.e. priority and pre-emption level) as required by local operator policies (e.g. if an IMS Emergency session is prioritized, the "priorityLevel" attribute may contain a value that is reserved for an operator domain use of IMS Emergency session). + +The PCF shall immediately initiate the procedures described in clause 4.2.6.2.1 to provision the necessary PCC Rules and the procedures described in clause 4.2.6.2.3 to provision the authorized QoS perPCC rule. + +The provisioning at the SMF of PCC Rules, which require the establishment of a dedicated QoS flow for emergency services, shall cancel the inactivity timer in the SMF, if it started running as defined in the clause 4.2.3.9.2. + +Any SMF-initiated request for PCC Rules for an IMS Emergency service with the "repPolicyCtrlReqTriggers" attribute containing the "RES\_MO\_RE" value (i.e. UE-initiated resource reservation) shall be rejected by the PCF via an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "ERROR\_TRAFFIC\_MAPPING\_INFO\_REJECTED". + +The SMF shall execute the procedures to ensure that a new QoS flow is established for the Emergency service. + +When the SMF detects that the provisioning of PCC Rules failed, the PCC rule error handling procedure shall be performed. + +##### 4.2.3.9.2 Removal of PCC Rules for Emergency Services + +The reception by the PCF of a request to terminate an AF session for an IMS Emergency service triggers the removal by the PCF of the PCC Rules assigned to the terminated IMS Emergency Service in the SMF, using the procedure defined in clause 4.2.6.2.1. + +At reception of an HTTP POST message that removes one or several PCC Rules from a PDU Session restricted to emergency services, the SMF shall: + +- initiate a QoS flow termination procedure, when all the PCC Rules bound to a QoS flow are removed; or +- initiate a QoS flow modification procedure, when not all the PCC Rules bound to a QoS flow are removed. + +In addition, the SMF shall initiate an inactivity timer if all PCC Rules with a 5QI other than the 5QI of the default QoS flow or the 5QI used for IMS signalling were removed from the PDU session restricted to Emergency Services (e.g. to enable PSAP Callback session). When the inactivity timer expires, the SMF shall initiate a PDU session termination procedure as defined in clause 4.2.5. + +#### 4.2.3.10 Request of Access Network Information + +If the NetLoc feature defined in clause 5.8 is supported, the PCF may request the SMF to report the access network information as defined in clause 4.2.6.5.4. + +#### 4.2.3.11 Request Usage Monitoring Control + +If the UMC feature defined in clause 5.8 is supported, the PCF may provision the usage monitoring control policy to the SMF, as defined in clause 4.2.6.5.3, to request the activation of usage monitoring control. + +#### 4.2.3.12 IPv6 Multi-homing support + +During the lifetime of the Multi-homing PDU session, the PCF shall provision the PCC rules and session rules to the SMF. The SMF shall derive the appropriate policies based on the policies provisioned by the PCF and provision them to the appropriate UPF, if applicable, access network, if applicable, and UE, if applicable. + +#### 4.2.3.13 Request for the result of PCC rule removal + +If the RAN-NAS-Cause feature is supported, the PCF may request the SMF to inform it of the result of PCC rule(s) removal, when the PCF removes PCC rule(s) as defined in clause 4.2.6.5.2. + +When the SMF receives the request, the SMF shall maintain locally the removed PCC rules(s) until it receives the resource release outcome from the network. + +#### 4.2.3.14 Access Network Charging Identifier request + +The PCF may request the SMF to provide the Access Network Charging Identifier associated to the dynamic PCC rules as defined in clause 4.2.6.5.1. + +#### 4.2.3.15 Request for the successful resource allocation notification + +The PCF may request the SMF to confirm that the resources associated to a PCC rule are successfully allocated as defined in clause 4.2.6.5.5. + +#### 4.2.3.16 PCC Rule Error Report + +If the SMF receives one or more PCC rule(s) as defined in clause 4.2.3.1, but the validation of all the received PCC Rules was unsuccessful, the SMF shall reject the request via an HTTP "400 Bad Request" status code and include in the corresponding response message the "ruleReports" attribute containing RuleReport data structure(s) to report the failure for the affected PCC rule(s) within the ErrorReport data structure; otherwise, if the validation of only some of the received PCC rules was unsuccessful, the SMF shall reply to the PCF with an HTTP "200 OK" status code and include in the corresponding response message one or more RuleReport data structure(s) to report the failure for the affected PCC rule(s) within the PartialSuccessReport data structure. + +Within each RuleReport instance, the SMF shall identify the failed PCC rule(s) by including their identifiers within the "pccRuleIds" attribute, identify the failure reason code by including a "failureCode" attribute, and include the PCC rule(s) status within the "ruleStatus" attribute containing a value as follows: + +- If the installation/activation of one or more new PCC rules (i.e. rules which were not previously successfully installed) fails, the SMF shall set the "ruleStatus" attribute value to "INACTIVE". +- If the modification of a currently active PCC rule fails, the SMF shall retain the existing PCC rule as active without any modification, unless the reason for the failure has an impact also on the existing PCC rule. + +The removal of a PCC rule shall never fail, even if the related PDU session procedures with the UE fail. The SMF shall retain information on the removal of the PDU session and conduct the necessary PDU session procedures with the UE when it is possible. + +Depending on the value of the "failureCode" attribute, the PCF may decide whether retaining, re-installation, modification or removal of the old PCC rule or any other action applies. + +If the "RuleVersioning" feature is supported and the PCF included the "contVer" attribute for a specific PCC rule instance in the "pccRules" attribute when provisioning this PCC rule to the SMF, then if the resource allocation for the corresponding PCC rule was unsuccessful, the SMF shall include the "contVers" attribute in the corresponding RuleReport instance within the "ruleReports" attribute. Depending on the value of the "failureCode" attribute, and when applicable, depending also on the value of the "contVer" attribute, the PCF may decide whether retaining, re-installation, modification, removal of the old PCC rule or any other action applies. + +#### 4.2.3.17 IMS Restoration Support + +If the ProvAFsignalFlow feature defined in clause 5.8 is supported, and in order to support IMS Restoration procedures (refer to 3GPP TS 23.380 [21]), the PCF needs to convey the AF address to the SMF. In order to do so, in case the AF + +provisions information about the AF signalling flows between the UE and the AF, as defined in clause 4.4.5a of 3GPP TS 29.214 [18], or in clauses 4.2.2.16 and 4.2.3.17 of 3GPP TS 29.514 [17], the PCF shall install the corresponding dynamic PCC rules (if not installed before) as defined in clause 4.2.6.2.1. The PCF shall include within the associated PccRule instance(s) the signalling flows between the UE and the AF within the "flowInfos" attribute and the "afSigProtocol" attribute set to the value corresponding to the signalling protocol used between the UE and the AF. + +The SMF shall respond to the PCF with an HTTP "204 no content" and initiate the corresponding QoS flow procedures, if required. The SMF shall extract the AF address from the provisioned PCC rule(s) and use it for the monitoring procedures as defined for the different access types. + +NOTE 1: The SMF can use the extracted AF address from the PCC rule(s) to check if the monitoring procedures have to be started for the corresponding AF. + +In case the AF de-provisions information about the AF signalling flows between the UE and the AF, as defined in clause 4.4.5a of 3GPP TS 29.214 [18], or in clauses 4.2.2.16 and 4.2.3.17 of 3GPP TS 29.514 [17], the PCF shall remove the corresponding dynamic PCC rule(s) by triggering a notification (i.e. HTTP POST) message towards the SMF. The PCF shall then apply the procedures defined in clause 4.2.6.2.1. + +The SMF shall send an HTTP response message to the PCF. + +NOTE 2: The SMF can use the AF address associated with the removed PCC rule(s) to check if it can stop monitoring the corresponding AF. + +#### 4.2.3.18 P-CSCF Restoration Enhancement Support + +This clause is applicable when the PCF-based P-CSCF Restoration Enhancement, as defined in 3GPP TS 23.380 [21] and controlled by the feature "PCSCF-Restoration-Enhancement" defined in clause 5.8, is supported by both the PCF and the SMF. + +If the PCF receives a request for P-CSCF restoration from the P-CSCF as defined in clause 4.4.7 of 3GPP TS 29.214 [18] or in clause 4.2.2.27 of 3GPP TS 29.514 [17], the PCF shall send a notification (i.e. HTTP POST) message to the SMF including the "pcscfRestIndication" attribute set to true for the corresponding PDU session. + +The SMF shall acknowledge the PCF and initiate the corresponding QoS flow procedures for the IMS PDU connection as defined in 3GPP TS 23.380 [21]. + +#### 4.2.3.19 Request of Presence Reporting Area Change Report + +If the PRA or ePRA feature defined in clause 5.8 is supported, the PCF may provision the Presence Reporting Area Information to the SMF as defined in clause 4.2.6.5.6. + +#### 4.2.3.20 Session Rule Error Report + +If the "SessionRuleErrorHandling" feature is supported and the SMF receives one or more session rule(s) as defined in clause 4.2.6.3.1 but the validation of all the received session rules was unsuccessful, the SMF shall reject the request via an HTTP "400 Bad Request" status code and include in the corresponding response message the "sessRuleReports" attribute containing SessionRuleReport data structure(s) to report the failure for the affected session rule(s) within the ErrorReport data structure; otherwise, if the validation of some of the received session rules was unsuccessful, the SMF shall reply to the PCF with an HTTP "200 OK" status code and include in the corresponding response message the "sessRuleReports" attribute containing one or more SessionRuleReport data structure(s) to report the failure for the affected session rule(s) within the PartialSuccessReport data structure. + +Within each SessionRuleReport instance, the SMF shall identify the failed session rule(s) by including their identifier(s) within the "ruleIds" attribute, identify the failure reason code by including a "sessRuleFailureCode" attribute, and include the session rule(s) status within the "ruleStatus" attribute containing a value as follows: + +- If the installation of one or more new session rule(s) (i.e. rules which were not previously successfully installed) fails, the SMF shall set the "ruleStatus" attribute value to "INACTIVE". +- If the modification of a currently provisioned session rule fails, the SMF shall retain the existing session rule as provisioned without any modification, unless the reason for the failure has an impact also on the existing session rule. The SMF shall report the modification failure to the PCF. + +The removal of a session rule shall never fail, even if the related PDU session procedures with the UE fail. The SMF shall then retain information on the removal of the PDU session and conduct the necessary PDU session procedures with the UE when it is possible. + +Depending on the value of the "sessRuleFailureCode" attribute, the PCF may decide whether retaining, re-installation, modification or removal of the old session rule, or any other action applies. + +#### 4.2.3.21 Access traffic steering, switching and splitting support + +If the PCF supports the "ATSSS" feature, the PCF may provide PCC rules and/or session rules for the MA PDU session as defined in clause 4.2.6.2.17 and clause 4.2.6.3.4. + +#### 4.2.3.22 Policy provisioning and enforcement of the AF session with required QoS + +If the PCF receives a QoS reference parameter during the initial provisioning of service information as defined in clause 4.2.2.32 of 3GPP TS 29.514 [17], or if the PCF receives individual QoS parameters during the initial provisioning of service information as defined in clause 4.2.2.24 of 3GPP TS 29.514 [17], the PCF shall authorize the service information from the AF and derive the QoS parameters of the related PCC rule(s) based on the received service information and the indicated QoS reference parameter or the indicated individual QoS parameters (e.g. Requested Maximum Bitrate and Requested Guaranteed Bitrate). + +**NOTE:** A SLA has to be in place between the operator and the ASP defining the possible QoS levels and their charging rates. For each possible pre-defined QoS information set, the PCF needs to be configured with the corresponding QoS parameters and their values as well as the appropriate Charging key (or receive this information from the UDR). + +If the PCF receives a different QoS reference parameter or different individual QoS parameters during the modification of service information as defined in clause 4.2.3.30 of 3GPP TS 29.514 [17], the PCF shall update accordingly the related QoS parameters corresponding to the new QoS parameter in the related PCC rule(s). + +If the AF subscribes to Service Data Flow QoS notification control, the PCF may additionally receive the Alternative Service Requirements during the initial provisioning of service information as defined in clause 4.2.2.32 of 3GPP TS 29.514 [17]. + +In this case, when the PCF authorizes service information based on the indicated QoS reference parameter or individual QoS parameters, and the "AuthorizationWithRequiredQoS" feature is supported, the PCF shall additionally derive alternative QoS parameter sets for the concerned PCC rule(s) based on the QoS reference parameters or individual QoS parameters provided in the Alternative Service Requirements. In order to do so, the PCF shall include one or more references to the QosData data structure within the "refAltQosParams" attribute of the concerned PCC rule(s) and a "qosDecs" attribute containing these QoS data decision(s) within the SmPolicyDecision data structure. In each QoS data decision instance, the PCF shall include the alternative QoS parameter set Id within the "qoSId" attribute, the alternative packet delay budget within the "packetDelayBudget" attribute, the alternative packet error rate within the "packetErrorRate" attribute, the alternative guaranteed bandwidth in uplink within the "gbrUI" attribute and the alternative guaranteed bandwidth in downlink within the "gbrDI" attribute. The "refAltQosParams" attribute is an ordered list of alternative QoS parameter sets, where the lower the index of the array for a given entry, the higher the priority. + +If the AF changes or newly provides the Alternative Service Requirements during the modification of service information as defined in clause 4.2.3.30 of 3GPP TS 29.514 [17], the PCF shall update accordingly or provide the Alternative QoS parameter sets in the related PCC rule(s). + +If the "PDUSetHandling" feature is supported and the PCF receives PDU Set QoS requirements during the initial provisioning of service information as defined in clause 4.2.2.39 of 3GPP TS 29.514 [17], the PCF shall determine the PDU Set QoS parameters based on the received requirements and include them within the "pduSetQoS" attribute. + +The PCF shall provision the related PCC rule(s) with alternative QoS parameter set(s) and enable QoS Notification Control, if it has not been enabled yet, as defined in clause 4.2.3.30 of 3GPP TS 29.514 [17]. + +If the "DisableUENotification" feature is supported and if the AF indicated to the PCF that the UE does not need to be informed about changes related to Alternative QoS Profiles as defined in clause 4.2.2.32 or 4.2.3.30 of 3GPP TS 29.514 [17] and the PCF decides to disable the notifications to the UE when changes related to the Alternative QoS Profiles occur, the PCF shall include the "disUeNotif" attribute set to true within the corresponding the PCC rule instance. + +When the SMF receives PCC rule(s) with alternative QoS parameter sets, the SMF shall enforce these PCC rule(s) and derive in addition the alternative QoS profile(s) towards the access network based on the received alternative QoS parameter set(s). + +#### 4.2.3.23 Forwarding of TSC user plane node management information and port management information received from the TSN AF or TSCTSF + +During the lifetime of a PDU session enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking the PCF may receive a UMIC and/or, when the DS-TT or the NW-TT functions are used, one or more PMIC(s) from the TSN AF or TSCTSF within the service information and/or, the indication of direct notification for the UPF to report the TSC management information as defined in 3GPP TS 29.514 [17]. A UMIC carries TSC user plane node management information. A PMIC carries port management information for a port located in DS-TT and/or NW-TT. + +**NOTE:** The 5GS Architecture to support IETF Deterministic Networking (IETF RFC 8655 [55]) does not require the DS-TT functionality to be supported in the device nor require the user plane NW-TT functionality to be supported in the UPF. However, it can co-exist with such functions. + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported the PCF initiates the Npcf\_SMPolicyControl\_UpdateNotify request and sends possibly updated policy information about the PDU Session and/or the UMIC and/or the PMIC(s) to the SMF via the SmPolicyDecision structure, in which the UMIC is encoded in the "tsnBridgeManCont" attribute, the DS-TT PMIC is encoded in the "tsnPortManContDstt" attribute and the one or more NW-TT PMIC(s) are encoded in the "tsnPortManContNwtt" attribute. + +The PMIC(s) are encoded in the "PortManagementContainer" data type, that includes the port management information in the "portManCont" attribute and the related port number in the "portNum" attribute. If the port is on DS-TT the SMF forwards the PMIC(s) to the DS-TT port. If the port is on NW-TT the SMF forwards the PMIC(s) to the NW-TT port. + +The UMIC is encoded in the "BridgeManagementContainer" data type, that includes the TSC user plane node management information in the "bridgeManCont" attribute. The SMF always forwards the UMIC to the TSC user plane node functionality of the UPF/NW-TT. + +If the "ExposureToTSC" feature is supported, and the TSCTSF or TSN AF has requested direct UPF notifications, the PCF shall set the notification URI within the "tscNotifUri" attribute and the notification correlation id within the "tscNotifCorrId" attribute corresponding to values provided by the TSCTSF or TSN AF. In this case, the SMF shall forward the received direct notification information to the UPF. + +**Editor's note:** It is FFS whether further adjustments to direct TSC event notification information are needed based on SA2 definition in TS 23.503. + +#### 4.2.3.24 Provisioning of TSCAI input information and TSC QoS related data + +The PCF may receive the TSCAI input information in the TSC assistance container and TSC traffic QoS related information from the TSN AF or TSCTSF. + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported by both the SMF and PCF as described in clause 5.8, the PCF shall provide for the derived PCC rule(s): + +- the 5G QoS parameters and the optional 5G QoS characteristics corresponding to a 5QI for a delay-critical GBR derived from the TSC traffic QoS information received from the TSN AF or TSCTSF encoded within a QosData type referred in the "refQosData" of the PCC rule; and +- the TSCAI input information as received from the TSN AF or TSCTSF, which may contain the periodicity, and burst arrival time encoded in the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute of the PCC rule, when the feature "TimeSensitiveCommunication" is supported, the survival time encoded in the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute and the (TSN)AF (g)PTP domain encoded in the "tscaiTimeDom" attribute, and when the feature "EnTSCAC" is supported, the burst arrival time window within the "burstArrivalTimeWnd" attribute, or capability for BAT adaptation encoded in the "capBatAdaptation" attribute, and either the acceptable periodicity range includes a lower bound encoded in the "lowerBound" attribute and an upper bound encoded in the "upperBound" attribute or a list of the acceptable periodicity value(s) encoded in the "periodicVals" attribute within the "periodicityRange" attribute. + +The values of MDBV and PDB applied to the derived 5QI shall follow principles defined in clause 5.27.3 of 3GPP TS 23.501 [2]. + +For IEEE TSN networks, the value of the MBR, if applicable, and the GBR are derived using the Maximum Bit Rate provided by the TSN AF. For other time sensitive communication networks, the value of the GBR may be derived using the input provided by the TSCTSF (e.g. the Minimum Bit Rate) and applying the QoS mapping procedures as specified in clause 7.3.3 of 3GPP TS 29.513 [7]. + +The ARP is assigned a value preconfigured for TSC services. + +As specified in clause 4.2.3.22, when the PCF receives a QoS reference from the TSCTSF, the PCF shall derive the above QoS parameters based on pre-defined QoS parameters referenced by the QoS reference. When the PCF receives individual QoS parameters from the TSCTSF, the PCF shall set derived QoS parameters based on the received individual QoS parameters and applying the QoS mapping procedures as specified in clause 7.3.3 of 3GPP TS 29.513 [7]. + +If the PCF receives Alternative Service Requirements that contain QoS references from the TSCTSF, the PCF shall derive the alternative QoS parameter set(s) based on the pre-defined QoS parameters referenced by the received Alternative Service Requirements as defined in clause 4.2.3.22. If the PCF receives Alternative Service Requirements that contain Requested Alternative QoS Parameter Set(s) from the TSCTSF, the PCF shall set the alternative QoS parameter set(s) based on the Requested Alternative QoS Parameter Set(s) contained in the received Alternative Service Requirements as defined in clause 4.2.3.22. + +The SMF shall convert the received TSCAI input information from the external GM into the 5G GM based on the time offset and cumulative rateRatio (when available) between external time and 5GS time as measured and reported by the UPF and, forward the derived TSCAI parameters per QoS Flow basis to the AN-RAN as follows: + +- For the traffic in downlink direction, the SMF shall correct the value of the "burstArrivalTime" attribute of the "tscaiInputDI" attribute based on the latest received time offset measurement from the UPF and set the downlink TSCAI Burst Arrival Time as the sum of the corrected value and the CN PDB as described in clause 5.7.3.4 of 3GPP TS 23.501 [2], representing the latest possible time when the first packet of the data bursts arrives at the AN. +- For the traffic in uplink direction, the SMF shall correct the value of "burstArrivalTime" attribute of the "tscaiInputUI" attribute based on the latest received time offset measurement from the UPF and set the uplink TSCAI Burst Arrival Time as the sum of corrected value and the UE-DS-TT Residence Time representing the latest possible time when the first packet of the data burst arrives at the egress of the UE. How the SMF corrects the Burst Arrival Time if the UE-DS-TT residence time has not been provided by the UE is up to SMF implementation. +- The SMF shall correct the value of "periodicity" attribute of the "tscaiInputUI" and/or "tscaiInputDI" using the cumulative rateRatio if the cumulative rateRatio measurement was previously received from the UPF and set the TSCAI Periodicity as the corrected value. Otherwise, the SMF shall set the periodicity in the TSCAI Periodicity without any correction. +- If the "TimeSensitiveCommunication" feature is supported and the TSCAI Survival Time Information is received: + - when the "surTimeInNumMsg" attribute is received, the SMF shall convert the value of "surTimeInNumMsg" attribute of the "tscaiInputUI" and/or "tscaiInputDI" attributes into time units by multiplying its value by the corrected uplink TSCAI Periodicity and/or downlink TSCAI Periodicity respectively, and set the TSCAI Survival Time to the calculated value; or + - when the "surTimeInTime" is received, the SMF shall correct the value of "surTimeInTime" attribute of the "tscaiInputUI" and/or "tscaiInputDI" attributes using the cumulative rateRatio if the cumulative rateRatio measurement was previously received from the UPF and set the TSCAI Survival Time to the corrected value. Otherwise, the SMF shall set the TSCAI Survival Time without correction. +- If the "EnTSCAC" feature is supported and the burst arrival time is provided, either the burst arrival time window or the capability for BAT adaptation may be received: + - when the burst arrival time window is received, for the traffic in downlink direction, the SMF shall correct the value of the "burstArrivalTimeWnd" attribute of the "tscaiInputDI" attribute in the same ways it is described for the correction of the burst arrival time in downlink as above and for the traffic in uplink + +direction, the SMF shall correct the value of "burstArrivalTimeWnd" attribute of the "tscaiInputUI" attribute in the same ways it is described for the correction of the burst arrival time in uplink in this clause; or + +NOTE 1: It is preferred that the range of the "burstArrivalTimeWnd" attribute contains the value of the "burstArrivalTime". + +- when the capability for BAT adaptation is received, the SMF shall set the value of "capBatAdaptation" attribute as the value of capability for BAT adaptation in the TSCAI. +- when the PCF receives the subscription for the notification on network provided BAT offset from the AF/NEF or TSCTSF, then PCF shall include "BAT\_OFFSET\_INFO" policy control request trigger within the "policyCtrlReqTriggers" attribute in the SmPolicyDecision data structure, if it has not been provisioned yet. +- when the burst arrival time window is received, if the periodicity range (either the acceptable periodicity range or the acceptable periodicity set) is received, the SMF shall correct the value of the "lowerBound" attribute and the "upperBound" attribute, or the "periodicVals" attribute within the "periodicityRange" attribute of the "tscaiInputUI" and/or "tscaiInputDI" using the same way as it is described for the correction of the periodicity in this clause. +- If the "EnTSCAC" feature is supported and the burst arrival time is not provided, only the capability for BAT adaptation may be received: + - when the value of the "capBatAdaptation" attribute as the capability for BAT adaptation is received, the SMF enables notification control for the QoS Flow (if not already enabled) in order to receive the BAT offset along with the "GFBR can no longer be guaranteed" notification from the NG-RAN. + +If the "TimeSensitiveCommunication" feature is supported, depending on whether the Time Domain information is included in the "tscaiTimeDom" attribute of the PCC rule, SMF may perform the following: + +- if the "tscaiTimeDom" attribute is not included in the PCC rule, the SMF provisions the UPF/NW-TT to report the clock drifting between 5G clock and the external GM clock for the (g)PTP time domain number that is configured to the NW-TT. +- if the "tscaiTimeDom" attribute is included in the PCC rule and does not indicate Time Domain = "5GS", the SMF provisions the UPF/NW-TT to report the clock drifting between 5G clock and the external GM clock for the received Time Domain information. + +NOTE 2: The Time Domain value corresponding to "5GS" is locally configured in the SMF and in the TSCTSF and indicates that the AF does not provide a Time Domain, as specified in 3GPP TS 29.565 [53], and it is not needed to adjust the TSCAI input information. The omission of the Time Domain within the "tscaiTimeDom" attribute of the PCC rule indicates it is needed to apply the TSN AF time domain, configured in the NW-TT, to adjust the TSCAI input information. + +The SMF shall use the N4 Association Setup or Update procedures as described in 3GPP TS 29.244 [13] to provision the UPF to report the clock drifting. + +If the SMF receives the clock drifting from the UPF for a Time Domain, and + +- if the received Time Domain matches the Time Domain information within the "tscaiTimeDom" attribute included in the PCC rule; or +- the "tscaiTimeDom" attribute is not included within the PCC rule, + +then the SMF may determine the time offset and cumulative rateRatio (when available) based on received Time Domain information and adjust the TSCAI information as described above. + +If the received clock drifting from the UPF does not match the Time Domain information within the "tscaiTimeDom" attribute of the PCC rule or the received "tscaiTimeDom" attribute of the PCC rule indicates Time Domain = "5GS" then the SMF will not adjust the TSCAI information. + +The provisioning of TSCAI input information and TSC traffic QoS configuration per PCC Rule shall be performed using the PCC rule provisioning procedure as defined in clause 4.2.6.2.1. + +#### 4.2.3.25 Policy provisioning of QoS Monitoring control + +##### 4.2.3.25.1 General + +The QoS Monitoring control refers to the real time measurement of QoS parameters between the UE and the UPF for a QoS flow. + +NOTE 1: The AF can request measurements for one or more QoS parameters, which can trigger QoS monitoring control for service data flow(s). This clause describes QoS monitoring control for packet delay, congestion, and data rate. + +If the "QosMonitoring" feature is supported, the PCF may generate the authorized QoS Monitoring data decision for the service data flow for packet delay based on the QoS Monitoring request if received from the AF, or when the feature "EnSatBackhaulCatChg" is supported, based on PCF local policy or configuration as described in subclause 4.2.3.25.2. + +The PCF, when the request is received from the AF, may determine whether the QoS monitoring report is sent to the AF/NEF by the SMF bypassing the PCF or by the PCF. When the feature "ExposureToEAS" is supported and the AF indication of direct notification is received, the PCF may determine whether duplicate notification by the UPF is required, i.e., whether the QoS monitoring report is directly sent to the local AF/NEF and to the PCF/SMF. When the "UPEAS" feature is supported, the PCF may generate a Data Collection Application Identifier based on the AF request or local configuration to be used in the SMF to associate the PCC rule with a QoS monitoring event exposure subscription. + +The PCF shall include within the SmPolicyDecision data structure one or more QosMonitoringData instances within the "qosMonDecs" attribute if not provided yet and, if the PCF determines that the QoS monitoring report shall be sent by the PCF from the SMF, "QOS\_MONITORING" within the "policyCtrlReqTriggers" attribute, if it has not been provisioned yet. + +NOTE 2: The QoS monitoring report can be sent by the SMF to the PCF as described in clause 4.2.4.24. The QoS monitoring report of the PCF to the AF/NEF is described in 3GPP TS 29.514 [17], the QoS monitoring report of the SMF to the AF/NEF bypassing the PCF is described in 3GPP TS 29.508 [12] and the QoS monitoring report to the Local NEF/AF by the UPF is described in 3GPP TS 29.564 [50]. + +When the features "QoSMonitoring" and "NscSupportedFeatures" are supported and if the NEF/AF provided information about the support of "QoSMonitoring" feature on Nsmf\_EventExposure service, the PCF may also include this information within the "nscSuppFeats" attribute included within the PccRule data type. + +For each QosMonitoringData instance, PCF shall include: + +- the requested QoS monitoring parameter(s) to be measured (i.e. DL/UL round trip packet delay and/or, if the "EnQoSMon" feature is supported, congestion information and/or data rate) within the "reqQosMonParams" attribute; +- the frequency(s) of reporting (e.g. event triggered and/or periodic) within the "repFreqs" attribute; +- for the case the "repFreqs" attribute includes the value "EVENT\_TRIGGERED": + - a. for QoS monitoring for packet delay: + - the delay threshold for downlink with the "repThreshDI" attribute if "reqQosMonParams" attribute includes DOWNLINK; + - the delay threshold for uplink with the "repThreshUI" attribute if "reqQosMonParams" attribute includes UPLINK; and/or + - the delay threshold for round trip with the "repThreshRp" attribute if "reqQosMonParams" attribute includes ROUND\_TRIP; + - b. for QoS monitoring for data rate: + - the data rate threshold for downlink within the "repThreshDatRateDI" attribute if the "reqQosMonParams" attribute includes DOWNLINK\_DATA\_RATE; and/or + - the data rate threshold for uplink within the "repThreshDatRateUI" attribute if the "reqQosMonParams" attribute includes UPLINK\_DATA\_RATE; + +- c. for QoS monitoring for congestion information: + - the congestion threshold for downlink within the "repThreshConDI" attribute if the "reqQosMonParams" attribute includes DOWNLINK\_CONGESTION; and/or + - the data rate threshold for uplink within the "repThreshConUI" attribute if the "reqQosMonParams" attribute includes UPLINK\_CONGESTION; and +- d. the minimum waiting time between subsequent reports within the "waitTime" attribute; and +- e. if the feature "PacketDelayFailureReport" or "EnQoSMon" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; +- for the case the "repFreqs" attribute includes "PERIODIC", the periodic time for reporting and, if the feature "PacketDelayFailureReport" or "EnQoSMon" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; +- either the notification URI within the "notifyUri" attribute and the notification correlation id within the "notifyCorrId" attribute if the PCF determines that the notification shall be sent to the AF directly from the SMF or the notification URI within the "notifyUri" attribute, the notification correlation id within the "notifyCorrId" attribute corresponding to the Local NEF or AF and the "directNotifInd" attribute set to true if the feature "ExposureToEAS" and/or the feature "EnQoSMon" is supported and the PCF determines that the direct notification by the UPF to the Local NEF or AF is required based on the indication of direct notification received from the AF; and + +**Editor's note:** It is FFS whether new data type structure is needed for QoS monitoring control for multi-modal services. + +**NOTE 3:** If the feature "ExposureToEAS" is supported and if the PCF determines to receive QoS Monitoring report while direct UPF notification is also required, the PCF can provision the "QOS\_MONITORING" policy control request trigger to the SMF together with the "directNotifInd" attribute set to true. + +**Editor's note:** Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +- the Data Collection Application Identifier within the "dataCollAppId" attribute if the "UPEAS" feature is supported and if the PCF determines that the SMF has to associate the PCC rule with a QoS monitoring event exposure subscription for that application identifier as described in 3GPP TS 29.508 [12]. + +If the feature "EnQoSMon" is supported, and QoS monitoring control is for data rate, may include the averaging window within the "avrgWndw" attribute. + +The PCF shall include the value of QoS Monitoring Data ID of QosMonitoringData instance within the "refQosMon" attribute of the corresponding PCC rule and provide the QoS monitoring data decision together with the PCC rule if it has not been provisioned to the SMF. When the SMF receives the PCC rule, the SMF shall send a QoS Monitoring request to the PSA UPF via N4 as defined in 3GPP TS 29.244 [13] and NG-RAN via N2 signalling to request the QoS monitoring between PSA UPF and NG-RAN as defined in 3GPP TS 29.502 [22]. If the feature "ExposureToEAS" is supported and if the SMF receives both the "QOS\_MONITORING" policy control request trigger and the indication of direct notification, the SMF shall request the UPF to perform duplicated notification as defined in 3GPP TS 29.244 [13]. If the "UPEAS" feature is supported, when the SMF receives the Data Collection Application Identifier within the "dataCollAppId" attribute as part of the QosMonitoringData instance of the PCC rule, the SMF shall associate the PCC rule with the QoS monitoring event exposure subscription related to that application identifier as described in 3GPP TS 29.508 [12]. + +If the PCF receives the request from the local NEF/AF to disable the QoS monitoring from the AF or the Local NEF, the PCF shall update the PCC rule with the "refQosMon" attribute set to NULL. The PCF may also remove the corresponding QoS Monitoring Data if no PCC rule is referring to it. + +If the PCF receives the request to disable the direct event notification to the local NEF or AF by the UPF, the PCF shall determine whether the PCF or the SMF bypassing the PCF sends the QoS monitoring reports to the local AF/NEF: + +- a. if the QoS monitoring reports are sent by the SMF bypassing the PCF: + +- update the PCC rule with the "refQosMon" attribute referring a QosMonitoringData instance which does not include the "directNotifInd" attribute set to true and still includes the "notifyUri", and the "notifyCorreId" attributes; or + - update the corresponding QosMonitoringData instance by including the "directNotifInd" attribute set to false and still keeping the "notifyUri", and the "notifyCorreId" attributes; +- b. if the QoS monitoring reports are sent by the PCF: +- update the PCC rule with the "refQosMon" attribute referring a QosMonitoringData instance which does not include the "directNotifInd", the "notifyUri", and the "notifyCorreId" attributes or update the QosMonitoringData instance by removing the "directNotifInd", the "notifyUri", and the "notifyCorreId" attributes; and + - provision the value "QOS\_MONITORING" within the "policyCtrlReqTriggers" attribute, if not previously provided. + +The SMF shall request to the UPF to disable the notification to the AF/(Local)NEF via N4 as defined in 3GPP TS 29.244 [13] and shall start sending the related notifications to PCF or to the indicated Notification URI and notification correlation Id, as applicable. + +If the PCF determines that QoS monitoring report shall be sent to the PCF from the SMF instead of sent from the SMF bypassing the PCF, the PCF shall replace the QosMonitoringData instance with an instance that does not include the "notifyUri" and the "notifyCorreId" attributes and include "QOS\_MONITORING" within the "policyCtrlReqTriggers" attribute if it has not been provisioned yet. If the PCF determines that QoS monitoring report shall be sent from the SMF bypassing the PCF instead of sent from the SMF to the PCF, the PCF shall update the QosMonitoringData instance by including the the notification URI within the "notifyUri" attribute and the notification correlation id within the "notifyCorreId" attribute, and remove the value "QOS\_MONITORING" within the "policyCtrlReqTriggers" attribute. + +#### 4.2.3.25.2 QoS Monitoring when dynamic Satellite Backhaul is used + +If the features "QosMonitoring" and "EnSatBackhaulCatChg" are supported, and if dynamic satellite backhaul is used, QoS monitoring may be used by the PCF to measure packet delay as specified in clause 4.2.3.25.1. + +If the PCF has subscribed to backhaul category changes within the "SAT\_CATEGORY\_CHG" policy control request trigger as described on clause 5.6.3.6, and the dynamic satellite backhaul is used to serve the PDU session, the PCF may, based on the local policy or configuration, request QoS Monitoring for the packet delay between UE and PSA UPF and the corresponding QoS Monitoring reports. The PCF shall include within the SmPolicyDecision data structure one or more QosMonitoringData instances within the "qosMonDecs" attribute if not provided yet, within the affected PCC rules, a reference to the corresponding QosMonitoringData instance, and the "QOS\_MONITORING" value within the "policyCtrlReqTriggers" attribute, if it has not been provisioned yet The PCF may take the reported packet delay information into account for the policy decision along with other criteria, such as the AF requested QoS requirements. + +#### 4.2.3.26 Policy decision error handling + +##### 4.2.3.26.1 Policy decision types and condition data error handling + +If the "PolicyDecisionErrorHandling" feature is supported and the "ExtPolicyDecisionErrorHandling" feature is not supported, and the SMF receives one or more policy decision type(s) (as defined in clause 4.1.4.4) and/or condition data (as defined in clause 4.1.8), which are not referred by any provisioned PCC rule or session rule as defined in clause 4.2.3.2, but the storage of the policy decision types and/or condition data was unsuccessful (e.g. the policy decision could not be successfully stored due to a limitation of resources at the SMF) or there are semantical inconsistencies in the provided data, the SMF shall behave as follows: + +- Include an HTTP "200 OK" status code and one or more PolicyDecisionFailureCode data types to indicate the type(s) of the failed policy decisions and/or condition data in the response message, if the SMF does not need to report any other information (e.g. the failure reports of the PCC rule(s) or session rule(s) which are provisioned in the same message, are not needed). +- Include an HTTP "200 OK" status code and one or more PartialSuccessReport data structure(s) including the "policyDecFailureReports" attribute to indicate the type(s) of the failed policy decisions and/or condition data and the "failureCause" attribute set to "POL\_DEC\_ERROR" in the response message, if the SMF needs to report + +partial success (e.g. some of the PCC rules and/or session rules provisioned by the PCF in the same message were not installed/activated successfully). + +- Include an HTTP "400 Bad Request" status code and the ErrorReport data structure including the "policyDecFailureReports" attribute to indicate the type(s) of the failed policy decisions and/or condition data in the response message, if the SMF needs to reject the request (e.g. all the PCC rules and/or session rules provisioned by the PCF in the same message were not installed/activated successfully). + +NOTE: An error within a policy decision type and/or condition data not referred by any PCC rules or session rules is encoded within the "policyDecFailureReports" attribute as specified in the PolicyDecisionFailureCode data structure defined in clause 5.6.3.28. + +When the PCF receives the above reports, the PCF shall consider all the instances of the policy decisions and/or condition data which were provisioned in the request message and indicated in the PolicyDecisionFailureCode data type as removed from the SMF. When the PCF receives a response with HTTP "400 Bad Request" status code but the "policyDecFailureReports" attribute is not included in the provided ErrorReport data structure, the PCF shall consider all the provisioned instances of the policy decisions and/or condition data in the request message as removed from the SMF. + +The removal of a policy decision type and/or condition data shall not fail. + +#### 4.2.3.26.2 Policy decision types, condition data and other policy decisions error handling + +If the "ExtPolicyDecisionErrorHandler" feature is supported and the SMF receives one or more policy decision type(s) (as defined in clause 4.1.4.4) and/or condition data (as defined in clause 4.1.8), which are not referred by any provisioned PCC rule or session rule as defined in clause 4.2.3.2, and/or other SM policy decisions (e.g. the SMF receives policy control request triggers and applicable additional information) and the SMF detects that the received policy decision(s) cannot be enforced (e.g. because of semantical inconsistencies in the provided data): + +- If the SMF does not need to reject the request (e.g. none, or only some but not all, of the PCC rule(s) and/or session rule(s) provisioned by the PCF in the same message are not installed/activated successfully), the SMF shall include one or more PartialSuccessReport data structure(s) in the response message with an HTTP "200 OK" status code. In order to report the partial success of policy decision and/or condition data, the SMF shall include in the related PartialSuccessReport data structure(s) the "failureCause" attribute set to "POL\_DEC\_ERROR" and the "policyDecFailureReports" attribute to indicate the failed policy decision type(s) and/or condition data that are not referred by any provisioned PCC rule or session rule and/or in other SM policy decision(s), and may include the "invalidPolicyDecs" attribute to provide more details on these failed policy decision type(s) and/or condition data that are not referred by any provisioned PCC rule or session rule and/or other SM policy decisions. +- If the SMF needs to reject the request (e.g. all the PCC rules and/or session rules provisioned by the PCF in the same message are not installed/activated successfully), the SMF shall include an ErrorReport data structure within a response message with an HTTP "400 Bad Request" status code. The SMF shall include the "policyDecFailureReports" attribute to indicate a failed policy decision type(s) and/or condition data that are not referred by any provisioned PCC rule or session rule and/or in other SM policy decisions, and may include the "invalidPolicyDecs" attribute to provide more details on these failed policy decision types and/or condition data that are not referred by any provisioned PCC rule or session rule and/or other SM policy decisions. In addition, when "Ext2PolicyDecisionErrorHandler" feature is supported and the NF service consumer needs to reject the request because the PCF only provided policy decision/condition data and all of them were faulty, the NF service consumer shall include the ErrorReport data structure with the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "POL\_DEC\_ERROR". + +NOTE 1: An error within a policy decision type and/or condition data not referred by any PCC rules or session rules and/or an error in other policy decisions is encoded within the "policyDecFailureReports" attribute as specified in the PolicyDecisionFailureCode data structure defined in clause 5.6.3.28. + +When the PCF receives the above reports, the PCF shall behave as follows: + +- For the policy decisions and/or condition data: + - a. The PCF shall consider all the instances of the policy decision(s) and/or condition data which are provisioned in the request message and indicated in the PolicyDecisionFailureCode data type as removed from the SMF. + +- b. When the PCF receives a response with HTTP "400 Bad Request" status code but the "policyDecFailureReports" attribute is not included in the provided ErrorReport data structure, the PCF shall consider all the provisioned instance(s) of the policy decision(s) and/or condition data in the request message as removed from the SMF. + - c. The removal of a policy decision type and/or condition data shall not fail. +- For the other policy decisions: +- a. The PCF shall consider all the new failed policy decisions provisioned in the request message and indicated in the PolicyDecisionFailureCode data type as not installed in the SMF. + - b. The PCF shall consider all the modified policy decisions provisioned in the request message and indicated in the PolicyDecisionFailureCode data type as unmodified in the SMF. + - c. The PCF shall consider all the removed policy decisions provided in the request message as deleted in the SMF. + +NOTE 2: The removal of a policy decision does not fail. Even if there is an inconsistency e.g. between the deletion of a policy control request trigger and the deletion of the applicable additional information, the whole related policy decision is removed. + +#### 4.2.3.27 Network slice related data rate policy control + +At the time a PCF-initiated change of the authorized Session-AMBR occurs or PCC Rule(s) for GBR service data flow(s) need to be provisioned at the SMF, the PCF may check if the concerned S-NSSAI is subject to network slice data rate policy control. If it is the case, the PCF shall apply network slice data rate control as described in clause 4.2.6.8. + +#### 4.2.3.28 Group related data rate policy control + +At the time a PCF-initiated change of the authorized Session-AMBR occurs or PCC Rule(s) for GBR service data flow(s) need to be provisioned at the SMF, the PCF may apply group data rate control as described in clause 4.2.6.9. + +#### 4.2.3.29 Policy provisioning of Traffic Parameter to be measured + +If the "PowerSaving" feature is supported, the PCF may send the Periodicity information "periodInfo" attribute received from the AF or NEF and together with the indication for SMF to request the UPF to perform the Traffic Parameter(s) measurement within the PCC rules. The Traffic Parameter(s) to be measured includes the downlink periodicity associated N6 jitter range and the Uplink and/or downlink periodicity information "periodInfo" attribute if the Periodicity information is not received from the AF. + +If the PCC rule indicates to perform the Traffic Parameter(s) measurement, the SMF requests the UPF to monitor and periodically report the measured Traffic Parameter(s) using the N4 Session Modification procedure. Upon reception of the measured Traffic Parameter(s) from the UPF, the SMF includes the measured N6 jitter range and the associated downlink periodicity in the TSCAI and forwards it to the NG-RAN to assist configuration UE power saving. + +#### 4.2.3.30 Network slice usage control + +When a PCF-initiated change of the SM policies shall be performed by the PCF via the Npcf\_SMPolicyControl\_UpdateNotify service operation and the "NetSliceUsageCtrl" feature is supported, the PCF may check whether the S-NSSAI of the concerned SM Policy Association is subject to network slice usage control. If it is the case, the PCF may provision/update/remove in the Npcf\_SMPolicyControl\_UpdateNotify request the network slice usage control information (e.g., the slice PDU session inactivity timer value) within the "sliceUsgCtrlInfo" attribute of the SmPolicyDecision data structure provided within the "smPolicyDecision" attribute of the SmPolicyNotification data structure. + +NOTE: In this release of the specification, network slice usage control information provisioning/update/removal by the PCF is not supported in roaming scenarios. + +## 4.2.4 Npcf\_SMPolicyControl\_Update Service Operation + +### 4.2.4.1 General + +The Npcf\_SMPolicyControl\_Update service operation provides means for the NF service consumer to inform the PCF that a policy control request trigger condition has been met and for the PCF to inform the NF service consumer of any resulting update of the Session Management related policies. + +The following procedures using the Npcf\_SMPolicyControl\_Update service operation are supported: + +- Provisioning of PCC rules. +- Provisioning of policy control request triggers. +- Request the policy based on revalidation time. +- Policy provisioning and enforcement of authorized AMBR per PDU session. +- Policy provisioning and enforcement of authorized default QoS. +- Application detection information reporting. +- Indication of QoS Flow Termination Implications. +- 3GPP PS Data Off Support. +- Request and report Access Network Information. +- Request Usage Monitoring Control and report Accumulated Usage. +- Ipv6 Multi-homing support. +- Request and report the result of PCC rule removal. +- Access Network Charging Identifier Request and report. +- Request and report the successful resource allocation notification. +- Negotiation of the QoS flow for IMS signalling. +- Notification about Service Data Flow QoS target enforcement. +- Request the termination of SM Policy association. +- Reporting of TSC user plane node management information and port management information. +- QoS Monitoring Report. +- Policy decision and condition data error handling. +- Request the policy after DDN failure events. +- Network slice related data rate policy control. +- Presence Reporting Area Information Report. +- PCC Rule Error Report. +- Session Rule Error Report. +- UE initiates a resource modification support. +- Trace Control. +- Group related data rate policy control. +- Support of Network Slice Usage Control. + +#### 4.2.4.2 Requesting the update of the Session Management related policies + +![Sequence diagram showing the interaction between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF to update an Individual SM Policy resource. The PCF responds with a 200 OK status.](376f80eb8a41369e87da63a0210d173e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST /sm-policies/{smPolicyId}/update + NF service consumer->>PCF: Request + Note left of PCF: 2. 200 OK + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF to update an Individual SM Policy resource. The PCF responds with a 200 OK status. + +**Figure 4.2.4.2-1: Requesting the update of the Session Management related policies** + +When the NF service consumer detects that one or more policy control request triggers are met, the NF service consumer shall send a POST request to the PCF to update an Individual SM Policy resource. The {smPolicyId} in the URI identifies the Individual SM Policy resource to be updated. The NF service consumer include SmPolicyUpdateContextData data structure in the content of the HTTP POST to request a update of representation of the "Individual SM Policy" resource. The NF service consumer shall include the met policy control request trigger(s) within the "repPolicyCtrlReqTriggers" attribute and applicable updated value(s) in the corresponding attribute(s). + +The NF service consumer shall include (if the corresponding policy control request trigger is met and the applicable information is available) in SmPolicyUpdateContextData data structure: + +- type of access within the "accessType" attribute; +- type of the radio access technology within the "ratType" attribute; +- the new allocated UE Ipv4 address within the "ipv4Address" attribute and/or the UE Ipv6 prefix within the "ipv6AddressPrefix" attribute; +- an additional new allocated UE Ipv6 prefix within the "addIpv6AddrPrefixes" attribute, if the "MultiIpv6AddrPrefix" feature is supported; +- multiple new allocated UE Ipv6 prefixes within the "multiIpv6Prefixes" attribute, if the "UnlimitedMultiIpv6Prefix" feature is supported; +- the released UE Ipv4 address within the "relIpv4Address" attribute and/or the UE Ipv6 prefix within the "relIpv6AddressPrefix" attribute; +- an additional released UE Ipv6 prefix within the "addRelIpv6AddrPrefixes" attribute, if the "MultiIpv6AddrPrefix" feature is supported; +- multiple released UE Ipv6 prefixes within the "multiRelIpv6Prefixes" attribute, if the "UnlimitedMultiIpv6Prefix" feature is supported; +- the UE MAC address within the "ueMac" attribute; +- the released UE MAC address within the "relUeMac" attribute; +- the indication of UE supporting reflective QoS within the "refQosIndication" attribute; +- access network charging identifier within the "accNetChIds" attribute; +- the 3GPP PS data off status within the "3gppPsDataOffStatus" attribute, if the "3GPP-PS-Data-Off" feature is supported; +- the UE time zone information within the "ueTimeZone" attribute; + +- the UDM subscribed Session-AMBR or, if the "DN-Authorization" feature is supported, the DN-AAA authorized Session-AMBR within the "subsSessAmbr" attribute; + +NOTE 1: When both, the UDM subscribed Session-AMBR and the DN-AAA authorized Session-AMBR are available in the NF service consumer, the NF service consumer includes the DN-AAA authorized Session-AMBR. + +- if the "VPLMN-QoS-Control" feature is supported, the highest Session-AMBR and the default QoS supported in the VPLMN within the "vplmnQos" attribute, if available; + +NOTE 2: In home routed roaming, the H-SMF may provide the QoS constraints received from the VPLMN (defined in 3GPP TS 23.502 [3] clause 4.3.2.2.2) to the PCF. + +- if the "DN-Authorization" feature is supported, the DN-AAA authorization profile index within the "authProfIndex" attribute; +- subscribed Default QoS Information within the "subsDefQos" attribute; +- detected application information within the "appDetectionInfos" attribute; +- if the "UMC" feature is supported, the accumulated usage reports within the "accuUsageReports" attribute; +- if the "PRA" feature is supported, the reported presence reporting area information within the "repPraInfos" attribute; +- the QoS flow usage required of the default QoS flow within the "qosFlowUsage" attribute; +- indication whether the QoS targets of one or more SDFs are not guaranteed or guaranteed again within the "qncReports" attribute; +- user location(s) information within the "userLocationInfo" attribute; + +NOTE 3: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +- if the "GroupIdListChange" feature is supported, the Internal Group Identifier(s) of the served UE within the "interGrpIds" attribute; +- if the "SatBackhaulCategoryChg" feature is supported, the satellite backhaul category or non-satellite backhaul and, when the "EnSatBackhaulCatChg" feature is supported, also the dynamic satellite backhaul category, within the "satBackhaulCategory" attribute; +- if the "AMInfluence" feature is supported, the PCF for the UE callback URI and, if received, SBA binding information within the "pcfUeInfo" attribute; +- serving network function identifier within the "servNfId" attribute; +- identifier of the serving network within the "servingNetwork" attribute; +- when the "URSPEnforcement" feature is supported, the URSP rule enforcement information provided by the UE within the "urspEnfInfo" attribute. In this case, the NF service consumer shall also include, if they were not previously provided, the SSC mode within the "sscMode" attribute, the UE requested DNN (if available and different from the selected DNN) within the "ueReqDnn" attribute, and/or if the PDU session is redundant, the RSN and the PDU session pair ID within the "redundantPduSessionInfo" attribute. The NF service consumer shall also provide the "accessType" attribute, if changed compared to the latest reported value; +- if the "EnTSCAC" feature is supported, the BAT offset and the optionally adjusted periodicity within the "batOffsetInfo" attribute; +- when the "EneNA" feature is supported, the list of NWDAF instance IDs used for the PDU Session within the "nwdafInstanceId" and their associated Analytic ID(s) within "nwdafEvents" updated with the new values included within the "nwdafDatas" attribute; + +NOTE 4: The NF service consumer provides the complete updated list of NWDAF instance IDs and associated Analytic ID(s) used for the PDU session. If all NWDAF data is deleted an empty list is included. + +- for HR-SBO scenario, if the "HR-SBO" feature is supported, the H-SMF may include the HR-SBO support indication within the "hrsboInd" attribute; and + +NOTE 5: The "PLMN\_CH" trigger has to be provisioned in order to report this information. + +- if the "NetSliceRepl" feature is supported and the NF service consumer reports a change from the initial S-NSSAI of the PDU Session to the Alternative S-NSSAI via the "NET\_SLICE\_REPL" PCRT, the Alternative S-NSSAI used to replace the existing S-NSSAI for the PDU Session within the "sliceInfo" attribute. + +**Editor's Note:** Whether the initial S-NSSAI is provided to the PCF when the NF service consumer reports a change from the Alternative S-NSSAI to the initial S-NSSAI of the PDU Session via the "NET\_SLICE\_REPL" PCRT is FFS and pending stage 2 feedback. + +The NF service consumer may include in "SmPolicyUpdateContextData" data structure the IPv4 address domain identity within the "ipDomain" attribute. + +In case of a successful update, "200 OK" response shall be returned. The PCF shall include in the "200 OK" response the representation of the updated policies within the SmPolicyDecision data structure. Detailed procedures related to the provisioning and enforcement of the policy decisions within the SmPolicyDecision data structure are contained in clause 4.2.6. + +NOTE 6: An empty SmPolicyDecision data structure is included in the "200 OK" response when the PCF decides not to update policies. + +If the PCF received a new list of NWDAF instance IDs used for the PDU Session in "nwdafInstanceId" attribute and their associated Analytic IDs in "nwdafEvents" attribute included within the "nwdafDatas" attribute the PCF may select those NWDAF instances based on this new list as described in 3GPP TS 29.513 [7]. + +If errors occur when processing the HTTP POST request, the PCF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP POST request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If the PCF is, due to incomplete, erroneous or missing information (e.g. QoS, RAT type, subscriber information) not able to provision a policy decision as response to the request for PCC rules by the NF service consumer, the PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_INITIAL\_PARAMETERS". + +If the PCF receives the set of session information which is sent in the message originated due to a trigger being met is incoherent with the previous set of session information for the same session (E.g. trigger met was RAT changed, and the RAT notified is the same as before), the PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_TRIGGER\_EVENT". + +If the PCF detects that the packet filters in the request for new PCC rules received from the NF service consumer is covered by the packet filters of outstanding PCC rules that the PCF is provisioning to the NF service consumer, the PCF may reject the request and include in an HTTP "403 Forbidden" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_CONFLICTING\_REQUEST". + +If the PCF does not accept one or more of the traffic mapping filters provided by the NF service consumer in an HTTP POST request (e.g. because the PCF does not allow the UE to request enhanced QoS for services not known to the PCF), the PCF shall reject the request and include in an HTTP "403 Forbidden" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_TRAFFIC\_MAPPING\_INFO\_REJECTED". + +If the NF service consumer receives HTTP response with these codes, the NF service consumer shall reject the PDU session modification that initiated the HTTP Request. + +The PCF shall not combine a rejection with provisioning of PCC rule operations in the same HTTP response message. + +#### 4.2.4.3 Request the policy based on revalidation time + +If the timer for the policy revalidation is started, the SMF shall send the PCC rule request before the indicated revalidation time. The SMF shall within the SmPolicyUpdateContextData data structure include RE\_TIMEOUT within the "repPolicyCtrlReqTriggers" attribute. The SMF shall stop the timer once the SMF sends the HTTP POST request. + +NOTE 1: The PCF is expected to be prepared to provide a new policy, as desired for the revalidation time, during a preconfigured period before the revalidation time. The preconfigured periods in the SMF and PCF need to be aligned. + +The PCF may instruct the SMF to revalidate the provided PCC rules by including the "revalidationTime" attribute within the SmPolicyDecision in the HTTP POST response. + +NOTE 2: If the PCF omits the "revalidationTime" attribute the revalidation function remains enabled, but the timer remains stopped till the PCF provides a revalidation time within the "revalidationTime" attribute. + +When the SMF receives the HTTP POST response message, the SMF shall start the timer for revalidation based on the received value of revalidation time if the revalidation function is not disabled; otherwise, the SMF shall not start the timer for revalidation. + +The PCF may disable the revalidation function by removing the RE\_TIMEOUT policy control request trigger in the HTTP POST response message. If the revalidation function is disabled, the SMF shall ignore any received value of revalidation time and shall not start the timer for revalidation. + +NOTE 3: By disabling the revalidation function the revalidation time value previously provided to the SMF is not applicable anymore. + +#### 4.2.4.4 Policy provisioning and enforcement of authorized AMBR per PDU session + +When the SMF detects that the Session-AMBR changes, the SMF shall notify of the change to the PCF by invoking the procedure defined in clause 4.2.4.2, and shall include the new Session-AMBR within the "subsSessAmbr" attribute and the "SE\_AMBR\_CH" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +If the "DN-Authorization" feature is supported, when both, the UDM subscribed Session-AMBR and the DN-AAA authorized Session-AMBR are available in the SMF, the DN-AAA authorized/re-authorized Session-AMBR shall take precedence over the changes on UDM subscribed Session-AMBR. + +If the "VPLMN-QoS-Control" feature is supported, + +- in the home routed scenario, when the SMF detects that the Session-AMBR supported in the VPLMN changes (i.e. when the UE moves from the HPLMN to a VPLMN with Session-AMBR constraints or between VPLMNs with different Session-AMBR constraints), the SMF shall notify of the change to the PCF by invoking the procedure defined in clause 4.2.4.2, and shall include the new VPLMN Session-AMBR within the "vplmnQos" attribute and the "VPLMN\_QOS\_CH" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. +- when the SMF detects that the UE moves from a VPLMN with Session-AMBR constraints to a VPLMN where the QoS constraints are not applicable in the home routed scenario or the UE moves back to the non-roaming scenario, the SMF shall notify the PCF that the QoS constraints in the VPLMN are not applicable by invoking the procedure defined in clause 4.2.4.2, and shall include the "vplmnQosNotApp" attribute set to true and the "VPLMN\_QOS\_CH" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +Upon receiving the change of Session-AMBR, the PCF shall ensure that the authorized Session-AMBR value does not exceed the Session-AMBR supported by the VPLMN, if applicable, and provision the new authorized Session-AMBR to the SMF in the response as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon receiving the authorized Session-AMBR from the PCF, the SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for the enforcement of the AMBR per PDU session. + +For UL Classifier or Multi-homing PDU Session, the SMF will provision the policies of session-AMBR for downlink and uplink direction to the UL Classifier/Branching Point functionality and in addition provision the policies of session-AMBR in the downlink direction to all the PDU session anchors as defined in clause 5.4.4 of 3GPP TS 29.244 [13]. + +#### 4.2.4.5 Policy provisioning and enforcement of authorized default QoS + +When the SMF detects that the subscribed default QoS change, the SMF shall notify of the PCF by invoking the procedure as defined in clause 4.2.4.2, include the new subscribed default QoS within the "subsDefQos" attribute and "repPolicyCtrlReqTriggers" set to DEF\_QOS\_CH. + +If the "VPLMN-QoS-Control" feature is supported, + +- in the home routed scenario, when the SMF detects that the default QoS supported in the VPLMN changes (i.e. when the UE moves from the HPLMN to a VPLMN with default QoS constraints or between VPLMNs with different default QoS constraints), the SMF shall notify of the change to the PCF by invoking the procedure defined in clause 4.2.4.2, and shall include the new default QoS value supported in the VPLMN within the "vplmnQos" attribute and the "VPLMN\_QOS\_CH" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute; +- when the SMF detects that the UE moves from a VPLMN with default QoS constraints to a VPLMN where the QoS constraints are not applicable in the home routed scenario or the UE moves back to the non-roaming scenario, the SMF shall notify the PCF that the QoS constraints in the VPLMN are not applicable by invoking the procedure defined in clause 4.2.4.2, and shall include the "vplmnQosNotApp" attribute set to true and the "VPLMN\_QOS\_CH" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +Upon receiving the change of default QoS, the PCF shall ensure that the authorized default QoS contains a 5QI and ARP values supported by the VPLMN, if applicable, and shall provision the authorized default QoS to the SMF in the response of the message as defined in clauses 4.2.6.3.1 and 4.2.6.3.2. + +Upon receiving the authorized default QoS, the SMF enforces it which may lead to the change of the subscribed default QoS. The SMF shall apply the corresponding procedures towards the access network, the UE and the UPF for the enforcement of the authorized default QoS. + +#### 4.2.4.6 Application detection information reporting + +If the ADC feature is supported and if the SMF receives the PCC rule for application detection and control, the SMF shall instruct the UPF as defined in 3GPP TS 29.244 [13] to: + +- Detect the application traffic. +- Report the detected application's traffic start/stop events along with the application instance identifier and service data flow descriptions when service data flow descriptions are deducible. + +When the start of the application's traffic, identified by an application identifier, is received from the UPF, if PCF has previously provisioned the APP\_STA/APP\_STO policy control request trigger, unless a request to mute such a notification (i.e. the "muteNotif" attribute set to true within the Traffic Control Data decision which the PCC rule refers to), the SMF shall report the start of the application to the PCF. + +In order to do so, the SMF shall perform the procedure as defined in clause 4.2.4.2 by including the information regarding the detected application's traffic within the "appDetectionInfos" attribute and the "APP\_STA" within the "repPolicyCtrlReqTriggers" attribute even if the application traffic is discarded due to enforcement actions of the PCC rule. In this case, within the each AppDetectionInfo instance, the SMF shall include the received application identifier within the "appId" attribute, and may include the detected service data flow description within the "sdfDescriptions" attribute if deducible and received and an allocated application instance identifier for the detected service data flow descriptions if received within the "instanceId". The "sdfDescriptions" attribute, if present, shall contain the "flowDescription" attribute and "flowDirection" attribute. The application instance identifier allows the correlation of APP\_STA and APP\_STO policy control request trigger to the specific service data flow descriptions. + +When the stop of the application's traffic, identified by an application identifier is received from the UPF and the SMF has reported the start of the application to the PCF, the SMF shall report the stop of the application to the PCF. In order to do so, the SMF shall perform the procedure as defined in clause 4.2.4.2 by including the information regarding the detected application's traffic within the "appDetectionInfos" attribute and the "APP\_STO" within the "repPolicyCtrlReqTriggers" attribute. For each AppDetectionInfo instance, the SMF shall include the received application identifier within the "appId" attribute and the application instance identifier received from the UPF within the "instanceId" if it is provided along with the APP\_STA to the PCF. + +The PCF then may make policy decisions based on the information received and send the corresponding updated PCC rules to the SMF. + +When a PFD provisioned by the PFDF as specified in 3GPP TS 29.551 [46] is removed/modified and the removed/modified PFD was used to detect application traffic related to an application identifier in a PCC rule installed or activated for a PDU session, if the removed/modified PFD results in that the stop of an application or an application instance is not able to be detected, and if the SMF has reported the application start as described in this clause to the PCF for the application or application instance represented by this PFD, the SMF shall report the application stop to the PCF for the corresponding application or the corresponding application instance, if the stop of the application's traffic, identified by the corresponding application or the corresponding application instance, is received from the UPF. + +NOTE: Multiple PFDs can be associated with the application identifier. When the removed/modified PFD is the last one which is used to detect traffic identified by the "appId" attribute, the SMF reports application stop. + +The PCF is not allowed to update the mute indication of a provisioned PCC rule(s) during the PDU session lifetime, i.e., if for the PCC rule, the application's start or stop notifications are muted, the PCC rule shall remain with the application's start or stop notifications muted along the PDU session lifetime, and viceversa, if for the PCC rule, the application's start or stop notifications are not muted, the PCC rule shall remain with the application's start or stop notifications not muted along the PDU session lifetime. The SMF shall reject the update of the mute indication for a provisioned PCC rule as specified in clause 4.2.6.2.11. + +#### 4.2.4.7 Indication of QoS Flow Termination Implications + +When the SMF detects that a dedicated QoS flow could not be activated or has been terminated it shall remove the affected PCC rules and send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "ruleReports" attribute containing the RuleReport data instance which specifies the affected PCC rules within the "pccRuleIds" attribute, "INACTIVE" as the value within the "ruleStatus" attribute and the "RES\_ALLO\_FAIL" as the value of the "failureCode" attribute. + +If the RAN-NAS-Cause feature is supported, the SMF shall provide the available access network information within the "userLocationInfo" attribute (if available), "userLocationInfoTime" attribute (if available) and "ueTimezone" attribute (if available). Additionally, if the SMF receives from the access network the RAN cause and/or the NAS cause due to QoS flow termination the SMF shall provide the received cause(s) in the "ranNasRelCauses" attribute included in RuleReport data instance. + +If the NetLoc feature is supported, and if the identifier of the affected PCC rule was included within the "refPccRuleIds" attribute of the RequestedRuleData data structure when the affected PCC rule was installed or modified, the SMF shall provide the access network information to the PCF by including the user location(s) information within the "userLocationInfo" attribute (if requested by the PCF and if provided to the SMF), the information on when the UE was last known to be in that location within "userLocationInfoTime" attribute (if user location information was requested by the PCF and if the corresponding information was provided to the SMF), the PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID) within the "servingNetwork" attribute (if the user location information was requested by the PCF but it is not provided to the SMF) and the timezone information within the "ueTimeZone" attribute (if requested by the PCF and available). + +NOTE 1: The SMF derives the value of the "userLocationInfoTime" attribute from the age of location information received from the AMF at PDU session update as described in 3GPP TS 29.502[22]. Whether the "userLocationInfo" attribute also encodes the age of location is implementation specific. + +NOTE 2: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +This shall be done whenever one of these conditions applies: + +- The SMF is requested by the RAN to initiate the deactivation of a QoS flow. +- PCC rule(s) are removed/deactivated by the SMF without PCF request (e.g. due to unsuccessful reservation of resources to satisfy the QoS flow binding). + +NOTE 3: The SMF will not initiate the deactivation of the QoS flow upon reception of the UE-initiated resource modification procedure indicating packet filter deletion. If all the PCC rules associated to a QoS flow have been deleted as a consequence of the PCF interaction, the SMF will initiate the QoS flow termination procedure towards the RAN. + +Signalling flows for the QoS flow termination and details of the binding mechanism are presented in 3GPP TS 29.513 [7]. + +#### 4.2.4.8 3GPP PS Data Off Support + +If the SMF is informed that the 3GPP PS Data Off status of the UE changed, the SMF shall send an HTTP POST message to the PCF, as defined in clause 4.2.4.2, providing the "PS\_DA\_OFF" value within the "repPolicyCtrlReqTriggers" attribute and the "3gppPsDataOffStatus" attribute set to the value indicated by the UE within the "SmPolicyUpdateContextData" data structure. + +Upon reception of this HTTP POST message with the "repPolicyCtrlReqTriggers" attribute set to the value "PS\_DA\_OFF" or "AC\_TY\_CH" the PCF shall determine whether the 3GPP PS Data Off handling functionality (as described below) becomes active or inactive. The 3GPP PS Data Off handling functionality is active if, and only if, + +- the latest received "3gppPsDataOffStatus" attribute is set to true; and + +NOTE 1: If the PS\_DA\_OFF policy control request trigger is received, the latest received value is the one received in the HTTP POST message. Otherwise, it corresponds to the stored value. + +- the UE uses 3GPP access, i.e.: + - for a non MA PDU session, the "accessType" attribute is set to "3GPP\_ACCESS"; and + - for a MA PDU session, either the "accessType" attribute or the "addAccessInfo" attribute indicate "3GPP\_ACCESS", and the "relAccessInfo" attribute either is not available or does not indicate "3GPP\_ACCESS". + +If the PCF determines that the 3GPP PS Data Off handling functionality becomes active, the PCF shall configure the SMF in such a way that: + +- only packets for services belonging to the list of 3GPP PS Data Off Exempt Services are forwarded over 3GPP access; and +- all other downlink packets and optionally uplink packets are: + - for a non-MA PDU session or a MA PDU session where non-3GPP access is not available, discarded by modifying or removing any related dynamic PCC rule(s) or by deactivating any related predefined PCC rule(s); + - for a MA PDU session where non-3GPP access is available, forwarded only via non-3GPP access, if it is ensured by the policy for ATSSS Control as specified in clause 4.2.6.2.17. + +NOTE 2: In order for the UPF to prevent the services that do not belong to the list of 3GPP PS Data Off Exempt Services, if such services are controlled by dynamic PCC rules, the PCF can either close gates for the downlink and optionally the uplink directions via the "flowStatus" attribute in the related dynamic PCC rules or remove those dynamic PCC rules. If the services are controlled by predefined PCC rules, the PCF needs to deactivate those PCC rules. PCC rule(s) with wild-carded service data flow filters can be among the PCC rules that are modified, removed or disabled in that manner. It can then be necessary that the PCF at the same time installs or activates PCC rules for PS Data Off Exempt Services. The network configuration can ensure that at least one PCC rule is bound to the default QoS flow when PS Data Off is activated in order to avoid the deletion of an existing PDU session or to not fail a PDU session establishment. + +If the PCF determines that the 3GPP PS Data Off handling functionality becomes inactive, the PCF shall make the necessary policy control decisions and perform PCC rule operations to make sure that services are allowed according to the user's subscription and operator policy (irrespective of whether they belong to the list of 3GPP PS Data Off Exempt Services or not). + +NOTE 3: The PCF can then open gates via the "flowStatus" attribute for active PCC rules associated to services not contained in the list of 3GPP PS Data Off Exempt Services. The PCF can also install PCC rules or activate predefined PCC rules for some services not belonging to the list of 3GPP PS Data Off Exempt Services. If the PCF activates or installs a PCC rule with wildcared filters, it can remove or de-activate PCC rules for 3GPP PS Data Off Exempt Services that are redundant with this PCC rule. + +#### 4.2.4.9 Request and Report of Access Network Information + +If the NetLoc as defined in clause 5.8 is supported, the PCF may request the SMF to report the access network information as defined in clause 4.2.6.5.4. + +If the AN\_INFO policy control request trigger is set, upon receiving the "lastReqRuleData" attribute with the "reqData" attribute with the value(s) MS\_TIME\_ZONE and/or USER\_LOC\_INFO and the "refPccRuleIds" attribute containing the PCC rule identifier(s) corresponding to the PCC rule(s) which is being installed, modified or removed together, the SMF shall apply the Namf\_EventExposure service for Time-Zone-Report and/or Location-Report event with One-Time Report type as defined in clause 5.3.1 and 5.3.2.2.2 of 3GPP TS 29.518 [36] if the related information is not available to obtain this information. When the SMF then receives access network information from the AMF, the SMF shall provide the required access network information to the PCF by as defined in clause 4.2.4.2 and set the corresponding attributes as follows: + +- If the user location(s) information was requested by the PCF and was provided to the SMF, the SMF shall provide the user location information within the "userLocationInfo" attribute and the time when it was last known within "userLocationInfoTime" attribute (if available). + +NOTE 1: The SMF derives the value of the "userLocationInfoTime" attribute from the age of location information received in the Location-Report (defined in clause 5.3.1 of 3GPP TS 29.518 [36]) from the AMF. Whether the "userLocationInfo" attribute also encodes the age of location is implementation specific. + +NOTE 2: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +- If the user location information was requested by the PCF and was not provided to the SMF, the SMF shall provide the serving PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID) within the "servingNetwork" attribute. +- If the time zone was requested by the PCF, the SMF shall provide it within the "ueTimeZone" attribute. + +NOTE 3: If the SMF receives the access network information but receives the rejection of the QoS flow creation or modification, the SMF reports the the enforcement error of the PCC rule to the PCF as defined in clause 4.2.4.15. + +In addition, the SMF shall provide the AN\_INFO policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +The SMF shall not report any subsequent access network information updates received from the RAN without any further provisioning or removal of related PCC rules requesting the access network information unless the associated QoS flow or PDU session has been released. + +#### 4.2.4.10 Request Usage Monitoring Control and Reporting Accumulated Usage + +##### 4.2.4.10.1 General + +If the UMC feature, as defined in clause 5.8 is supported, the PCF may provision the usage monitoring control policy to the SMF, as defined in clause 4.2.6.5.3, to request the usage monitoring control. + +The SMF shall report the accumulated usage to the PCF in the following conditions: + +- when a usage threshold is reached, as described in this clause; +- when all PCC rules for which usage monitoring is enabled for a particular usage monitoring key are removed or deactivated, as specified in clause 4.2.4.10.2; +- when usage monitoring is explicitly disabled by the PCF, as specified in clause 4.2.6.5.3.2; +- when a PDU session is terminated, as specified in clause 4.2.5.3; +- when requested by the PCF, as specified in clause 4.2.6.5.3.3. + +The UPF measures the volume and/or the time of usage of all traffic of a PDU session or the corresponding service data flows. When the SMF receives the accumulated usage report from the UPF as defined in clauses 7.5.5.2, 7.5.7.2 or + +7.5.8.3 of 3GPP TS 29.244 [13], the SMF shall send an HTTP POST message as defined in clause 4.2.4.2, including one or more accumulated usage reports within the "accuUsageReports" attribute and the "US\_RE" value within the "repPolicyCtrlReqTriggers" attribute. Each AccuUsageReport data structure shall contain the accumulated usage report within one or two Usage Report information element, i.e. the accumulated usage before the monitoring time or the accumulated usage both before and after the monitoring time, corresponding to one usage monitoring control instance as requested by the PCF. + +If the monitoring time is provided by the PCF for a usage monitoring control instance and: + +- if the SMF receives only one Usage Report information elements corresponding to the usage monitoring control instance from the UPF, within the AccuUsageReport data structure, the SMF shall include the accumulated usage before the monitoring time within the "timeUsage" attribute, "volUsage" attribute, "volUsageUplink" attribute and/or "volUsageDownlink" attribute, if applicable; otherwise, +- if the SMF receives two Usage Report information elements corresponding to the usage monitoring control instance from the UPF, within the AccuUsageReport data structure, the SMF includes the accumulated usage before the monitoring time within the "timeUsage" attribute, "volUsage" attribute, "volUsageUplink" attribute and/or "volUsageDownlink" attribute, if applicable, and the accumulated usage after the monitoring time within the "nextTimeUsage" attribute, "nextVolUsage" attribute, "nextVolUsageUplink" attribute and/or "nextVolUsageDownlink" attribute, if applicable. + +When the PCF receives the accumulated usage report in the HTTP POST message, the PCF shall indicate to the SMF if usage monitoring shall continue for this usage monitoring control instance as follows: + +- if the PCF wishes to continue monitoring for the usage monitoring control instance and: + - if monitoring shall continue for specific level(s), the PCF shall provide in the response to the received HTTP POST message the new threshold(s) corresponding to these level(s) using the same attributes as before (i.e. "volumeThreshold", "volumeThresholdUplink", "volumeThresholdDownlink" and/or "timeThreshold"; "nextVolThreshold", "nextVolThresholdUplink", "nextVolThresholdDownlink", and/or "nextTimeThreshold" if the "monitoringTime" attribute is provided within an entry of the "umDecs" attribute); or + - if the PCF wishes to stop monitoring for specific level(s) the PCF shall not include in the response to the received HTTP POST message updated threshold(s) for these specific level(s), i.e. the corresponding "volumeThreshold" attribute, "volumeThresholdUplink" attribute, "volumeThresholdDownlink" attribute, "timeThreshold" attribute, "nextVolThreshold" attribute, "nextVolThresholdUplink" attribute, "nextVolThresholdDownlink" attribute, and/or "nextTimeThreshold" attribute shall not be included within an entry of the "umDecs" attribute. + - otherwise, if the PCF wishes to stop monitoring for the usage monitoring control instance, the PCF shall not include any thresholds of this usage monitoring control instance in the response to the HTTP POST message or remove the reference to the usage monitoring control instance from the concerned dynamic PCC rule or session rule. + +If both volume and time thresholds were provided by the PCF and only one of these two thresholds is reached, the SMF shall report this event to the PCF and the accumulated usage since last report shall be reported for both measurements. + +Upon reception of the reported usage from the SMF, the PCF shall deduct the value of the usage report from the total allowed usage for that PDU session, usage monitoring key, or both as applicable, and the PCF may also derive and update the PCC rules based on the remaining allowed usage or reported usage and provision them to the SMF. If the remaining allowed usage reaches a value zero (or below zero), the PCF may apply other policy decisions and interact with the SMF accordingly. + +NOTE: The PCF can also update the related usage monitoring information in the UDR as defined in 3GPP TS 29.519 [15] according to the received usage report(s). + +#### 4.2.4.10.2 PCC Rule Removal + +When the PCF removes or deactivates the last PCC rule associated with a usage monitoring key in an Npcf\_SMPolicyControl\_UpdateNotify request as described in clause 4.2.3.2 or in an Npcf\_SMPolicyControl\_Update response as described in clause 4.2.3.4 whose request was not related to reporting usage for the same monitoring key, the SMF shall send a new Npcf\_SMPolicyControl\_Update request including the "US\_RE" value within the "repPolicyCtrlReqTriggers" attribute and one or more accumulated usage reports within the "accuUsageReports" + +attribute within the SmPolicyUpdateContextData data type of the HTTP POST request using the procedures to report accumulated usage defined in clause 4.2.4.10. + +When the SMF reports that the last PCC rule associated with a usage monitoring key is inactive, the SMF shall report the accumulated usage for that monitoring key within the same HTTP POST request if the "ruleReports" attribute was included in the SmPolicyUpdateContextData data type; otherwise, if the "ruleReports" attribute was included in the HTTP POST response of an Npcf\_SMPolicyControl\_UpdateNotify request, the SMF shall invoke the Npcf\_SMPolicyControl\_Update service operation by sending a new HTTP POST request to report accumulated usage for the usage monitoring key. + +#### 4.2.4.11 Ipv6 Multi-homing support + +The SMF may insert an additional PDU Session Anchor to an existing PDU session by using Ipv6 multi-homing mechanism. In this case, the SMF shall inform the PCF when one or more new Ipv6 prefix is allocated to the new PDU Session Anchor as defined in clause 4.2.4.2. The SMF shall, within the SmPolicyUpdateContextData data structure, include the "UE\_IP\_CH" within the "repPolicyCtrlReqTriggers" attribute and include the new Ipv6 prefix within the "ipv6AddressPrefix" attribute, and may include an additional new Ipv6 prefix within the "addIpv6AddrPrefixes" attribute, if the "MultiIpv6AddrPrefix" feature is supported, or multiple new Ipv6 prefixes within the "multiIpv6Prefixes" attribute, if the "UnlimitedMultiIpv6Prefix" feature is supported. + +When the PCF receives the request from the SMF indicating the addition of one or more new Ipv6 prefixes, the PCF shall determine the impacted PCC rules and/or session rules associated with each new Ipv6 prefix and provision them to the SMF as defined in clauses 5.6.2.6 and 5.6.2.7. The SMF shall derive the appropriate policies based on the policies provisioned by the PCF and provision them to the appropriate UPF, if applicable, access network, if applicable, and UE, if applicable. The PCF shall additionally consider the new Ipv6 prefix, or the new Ipv6 prefixes if the "MultiIpv6AddrPrefix" feature is supported or the "UnlimitedMultiIpv6Prefix" feature, during subsequent PCC rules and/or session rules updates. + +When the SMF removes a PDU Session anchor from the Multi-homing PDU session, the SMF shall inform the PCF of the released Ipv6 prefix related to the PDU Session anchor as defined in clause 4.2.5.2. The SMF shall, within the SmPolicyUpdateContextData data structure, include the "UE\_IP\_CH" within the "repPolicyCtrlReqTriggers" attribute and include the released Ipv6 prefix within the "relIpv6AddressPrefix" attribute, and may include an additional released UE Ipv6 prefixes within the "addRelIpv6AddrPrefixes" attribute, if the "MultiIpv6AddrPrefix" feature is supported, or multiple released UE Ipv6 prefixes within the "multiRelIpv6Prefixes" attribute, if the "UnlimitedMultiIpv6Prefix" feature is supported. + +When the PCF receives the request from the SMF indicating the release of one or more Ipv6 prefixes, the PCF shall determine the previously provisioned PCC rules and/or session rules associated with each released Ipv6 prefix and shall remove and/or update them from the SMF as applicable. The PCF shall remove the released Ipv6 prefix, or the multiple released Ipv6 prefixes if the "MultiIpv6AddrPrefix" or the "UnlimitedMultiIpv6Prefix" feature is supported. + +#### 4.2.4.12 Request and report for the result of PCC rule removal + +If the RAN-NAS-Cause feature is supported, the PCF may request the SMF to inform it of the result of the PCC rule removal when the PCF removes the PCC rule as defined in clause 4.2.6.5.2. + +When the SMF receives the request, the SMF shall maintain locally the removed PCC rules until it receives of the resource release outcome from the network. + +The SMF shall notify the PCF by include the "RES\_RELEASE" within the "repPolicyCtrlReqTriggers" attribute and the affected rules indicated within one instance of the "ruleReports" attribute with the "ruleStatus" attribute set to the value INACTIVE. + +If the QoS flow is terminated as a consequence of the removal of one or more PCC rules, the SMF shall inform the PCF about the completion of the QoS flow procedure related to the removal of PCC rules that indicated resource release notification by including the RequestedRuleData instance containing the "reqData" attribute with the RES\_RELEASE referring to the PCC rule. If the SMF received from the access network some RAN/NAS release cause(s), the SMF shall also provide the received cause(s) in the "ruleReports" attribute. The SMF shall also provide the available access network information within the "userLocationInfo" attribute (if available), "userLocationInfoTime" attribute (if available) and "ueTimezone" attribute (if available). + +#### 4.2.4.13 Access Network Charging Identifier request and report + +If the "policyCtrlReqTriggers" attribute with the value "AN\_CH\_COR" has been provided to the SMF, the SMF shall notify to the PCF the Access Network Charging Identifier that the SMF has assigned to the PDU session for the dynamic PCC Rules which referred from the RequestedRuleData data structure containing the CH\_ID within the "reqData" attribute by including an "accNetChIds" attribute within the SmPolicyUpdateContextData data structure in the HTTP POST message. + +If the the Access Network Charging Identifier is within the Uint32 value range; the SMF shall include one AccNetChId instance within the "accNetChIds" attribute and include the Access Network Charging Identifier within the "accNetChIdValue" attribute and the "sessionChScope" attribute set to true; otherwise, if the "AccNetChargId\_String" feature is supported by the SMF and the PCF, and the Access Network Charging Identifier value is longer than Uint32, the SMF shall include one AccNetChId instance within the "accNetChIds" attribute and the Access Network Charging Identifier within the "accNetChargIdString" attribute and the "sessionChScope" attribute set to true. + +NOTE: As specified in 3GPP TS 32.255 [35] clause 5.1.4, the SMF assigns a charging identifier per PDU session and is used through the PDU session's lifetime. The request of Access Network Charging Identifier(s) in 5GS and EPS interworking scenarios is described in clause B.3.4.11. + +When the PCF does not have the access network charging identifier information for the PDU session, the PCF may request the SMF to provide the Access Network Charging Identifier associated to the new dynamic PCC rules as defined in clause 4.2.6.5.1 in the response message. + +#### 4.2.4.14 Request and report for the successful resource allocation notification + +The PCF may request the SMF to confirm that the resources associated to a PCC rule are successfully allocated as defined in clause 4.2.6.5.5. + +If the "policyCtrlReqTriggers" attribute with the value "SUCC\_RES\_ALLO" has been provided to the SMF, the SMF shall notify to the PCF that the resources associated to the PCC rules which were referred from an element of the "lastReqRuleData" attribute containing the "SUCC\_RES\_ALLO" within the "reqData" attribute are successfully allocated. When the SMF received successful resource allocation response from the access network, the SMF shall within the SmPolicyUpdateContextData data structure include the "SUCC\_RES\_ALLO" within the "repPolicyCtrlReqTriggers" attribute and "ruleReports" attribute. Within the RuleReport instance, the SMF shall include the corresponding PCC rule identifier(s) within the "pccRuleIds" attribute and the "ruleStatus" attribute set to value "ACTIVE". + +If the "AuthorizationWithRequiredQoS" feature as defined in clause 5.8 is supported and if the SMF additionally receives the reference to the matching Alternative QoS Profile which the NG-RAN can guarantee, the SMF shall also include the reference to the QosData data structure for the Alternative QoS parameter set corresponding to the reference to the matching alternative QoS profile within the "altQosParamId" attribute. + +If the "RuleVersioning" feature is supported and the PCF included the "contVer" attribute for a specific PCC rule instance, and the resource allocation was successful for this PCC rule, the SMF shall include the rule content version within the "contVers" attribute in the corresponding RuleReport instance. + +#### 4.2.4.15 PCC Rule Error Report + +If the installation/activation of one or more PCC rules fails using the procedure as defined in clause 4.2.2.1 or 4.2.4.1 or the PCF installed, activated or modified one or more PCC rules as defined in clause 4.2.3.1 but resource allocation for the PCC rule was unsuccessful or the UE was found temporarily unavailable, the SMF shall include the "ruleReports" attribute for the affected PCC rules to report the failure within the SmPolicyUpdateContextData data structure. Within each RuleReport instance, the SMF shall identify the failed PCC rule(s) by including the affected PCC rules within the "pccRuleIds" attribute, identify the failed reason code by including a "failureCode" attribute, and shall include rule status within the "ruleStatus" attribute with the value as described below. + +If the installation/activation of one or more new PCC rules (i.e., rules which were not previously successfully installed) fails, the SMF shall set the "ruleStatus" to INACTIVE. + +The removal of a PCC rule shall not fail, even if the PDU session procedures with the UE fail. The SMF shall retain information on the removal and conduct the necessary PDU session procedures with the UE when it is possible. + +If the modification of a currently active PCC rule fails, the SMF shall retain the existing PCC rule as active without any modification unless the reason for the failure has an impact also on the existing PCC rule. The SMF shall report the modification failure to the PCF. + +If a PCC rule was successfully installed/activated, but can no longer be enforced by the SMF, the SMF shall set the "ruleStatus" attribute to INACTIVE. + +NOTE: When the PCF receives "ruleStatus" set to INACTIVE, the PCF does not need request the SMF to remove the inactive PCC rule. + +Depending on the value of the "failureCode" attribute, the PCF may decide whether retaining of the old PCC rule, re-installation, modification, removal of the PCC rule or any other action applies. + +If the feature "UEUnreachable" is supported, when the "failureCode" indicates "UE\_TEMPORARILY\_UNAVAILABLE" and the "retryTimer" is received, the PCF should not reattempt the installation, re-installation or modification of PCC rules until the received retry timer expires. + +If the RAN-NAS-Cause feature is supported and as part of any of the procedures described in this clause the SMF receives from the access network some RAN/NAS release cause(s), the SMF shall also provide the received cause(s) in the RuleReport instance. If RAN-NAS-Cause feature is supported the SMF shall provide the available access network information within the "userLocationInfo" attribute (if available), "userLocationInfoTime" attribute (if available) and "ueTimezone" attribute (if available). + +If the "RuleVersioning" feature is supported and the PCF included the "contVer" attribute for a specific PCC rule instance, and the resource allocation was unsuccessful as for any of the procedures described in this clause the SMF shall include the rule content version within the "contVers" attribute for the corresponding RuleReport instance. + +#### 4.2.4.16 Presence Reporting Area Information Report + +If the PRA or ePRA feature as defined in clause 5.8 is supported and when the SMF receives the presence reporting area information from the serving node as defined in 3GPP TS 29.518 [36] indicating that the UE is inside or outside of one or more presence reporting areas or any of the presence reporting areas is set to inactive, the SMF shall check if the reported presence reporting area identifier corresponds to a presence reporting area that is relevant for the PCF. In that case, the SMF shall within the SmPolicyUpdateContextData data structure include the "PRA\_CH" within the "repPolicyCtrlReqTriggers" attribute and one or more Presence Reporting Area Information Report within the "repPraInfos" attribute. For each PresenceInfo data structure, the SMF shall also include the presence reporting area status within the "presenceState" attribute and the presence reporting area identifier within the "praId" attribute for each of the presence reporting areas reported by the serving node. + +If the SMF receives presence reporting area information for a Set of Core Network predefined Presence Reporting Area encoded within the "praId" attribute together with the individual PRA Identifier encoded within the "additionalPraId" attribute as described in 3GPP TS 29.518 [36], the SMF shall only provide the PCF with the presence reporting area information corresponding to the additional PRA information (i.e. the individual PRA identifier) encoded within the "praId" attribute. + +NOTE 1: The SMF will receive additional presence reporting area information when the UE enters or leaves one or more presence reporting areas related to a PRA set. In that case, the additional presence reporting area information corresponds to the actual individual presence reporting area. The received presence reporting area identifier corresponds to the PRA set id and is used to identify the requester (PCF or CHF) of the notification information. + +NOTE 2: The PCF can acquire the necessary data for presence reporting from the UDR. + +NOTE 3: Homogeneous support of Presence Area reporting in a network is assumed. + +NOTE 4: The serving node can activate the reporting for the PRAs which are inactive as described in the 3GPP TS 23.501 [2]. + +#### 4.2.4.17 UE initiates a resource modification support + +In the case that the UE initiates a resource modification procedure as defined in clause 6.4.2.2 of 3GPP TS 24.501 [20], the SMF shall within the SmPolicyUpdateContextData data structure include the "RES\_MO\_RE" within the "repPolicyCtrlReqTriggers" attribute and shall include the UE request of specific QoS + +handling for selected SDF within the "ueInitResReq" attribute. Within the UeInitiatedResourceRequest data structure, the SMF shall include the "ruleOp" attribute, "packFiltInfo" attribute and "reqQos" attribute if applicable as follows: + +- When the UE requests to "Create new QoS rule", the SMF shall include the "ruleOp" attribute set to "CREATE\_PCC\_RULE", the "packFiltInfo" attribute and "reqQos" attribute containing the requested QoS for the new PCC rule. Each PacketFilterInfo instance shall contain one packet filters requested for creating the new QoS rule. If the PCF authorizes the request, the PCF shall create a new PCC rule by including the new packet filters within the service data flow template of the PCC rule. When the SMF received the PCC rule, the SMF shall derive the QoS rule based on the PCC rule, assign a new QoS rule identifier within the PDU session for the QoS rule. The SMF shall keep the mapping between the PCC rule identifier and the QoS rule identifier. +- When the UE requests to "Modify existing QoS rule and add packet filters" for the QoS rule created as a result of the UE-initiated resource modification, SMF shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_ADD\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the QoS rule identifier and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall contain one packet filters requested for addition to this QoS Rule. If the UE request includes the modified QoS information the SMF shall also include the "reqQos" attribute to indicate the updated QoS for the affected PCC rule(s). If the PCF authorizes the request, the PCF shall update the PCC rule by adding the new packet filters to the service data flow template of the PCC rule. +- When the UE requests to "Modify existing QoS rule and replace all packet filters" for the QoS rule created as a result of the UE-initiated resource modification, SMF shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_REPLACE\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the QoS rule identifier and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall contain one packet filters requested for addition to this QoS Rule. If the UE request includes the modified QoS information the SMF shall also include the "reqQos" attribute to indicate the updated QoS for the affected PCC rule. If the PCF authorizes the request, the PCF shall update PCC rule by replacing the all existing packet filters within the service data flow template of the PCC rule with the new packet filter(s). +- When the UE requests to "Modify existing QoS rule and delete packet filters" for the QoS rule created as a result of the UE-initiated resource modification, SMF shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_DELETE\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the QoS rule identifier and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall within the "packFiltId" attribute include the removed packet filter identifier assigned by the PCF corresponding to the packet filter identifier received from the UE. If the UE request includes modified QoS information the SMF shall also include the "reqQos" attribute to indicate the updated QoS for the affected PCC rule(s). If the PCF authorizes the request, the PCF shall update PCC rule by removing the corresponding packet filters from the service data flow template of the PCC rule. +- When the UE requests to "Modify existing QoS rule without modifying packet filters" for the QoS rule created as a result of the UE-initiated resource modification, SMF shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_WITHOUT\_MODIFY\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the QoS rule identifier, the "packFiltInfo" attribute and the modified QoS information within the "reqQos" attribute. The "packFiltInfo" attribute shall include one PacketFilterInfo instance which includes any packet filter identifier assigned by the PCF for the PCC rule within the "packFiltId" attribute. +- When the UE requests to "Delete existing QoS rule" the SMF shall include the "ruleOp" attribute set to "DELETE\_PCC\_RULE" for the QoS rule created as a result of the UE-initiated resource modification, the "pccRuleId" attribute including the PCC rule identifier corresponding the QoS rule identifier and the "packFiltInfo" attribute. The "packFiltInfo" attribute shall include one PacketFilterInfo instance which includes any packet filter identifier assigned by the PCF for the PCC rule within the "packFiltId" attribute. The PCF shall remove the PCC rule when the PCF receives the request according to the PCC rule identifier. + +NOTE 1: The UE can only modify or delete the packet filters that the UE has introduced and associated resources. The packet filter identifiers contained in the FlowInformation data structure are only used for packet filters created by the UE. + +The SMF shall calculate the requested GBR, for a GBR 5QI, as the sum of the previously authorized GBR for the affected PCC rule, corresponding to the QoS rule, adjusted with the difference between the requested GBR for the QoS flow and previously negotiated GBR for the QoS flow. For the UE request to create a new QoS Rule, the GBR as requested by the UE for the QoS rule shall be used. + +If the request covers all the PCC rules with a QoS flow binding to the same QoS flow, then the SMF may request a change to the 5QI for existing PCC rules. + +For the purpose of creating or modifying a QoS rule with adding, replacing and modifying packet filter, within the UeInitiatedResourceRequest instance, the SMF shall include the precedence information of the QoS rule within the "precedence" attribute, and within each PacketFilterInfo instance, the SMF shall include the "packFiltCont" attribute, "tosTrafficClass" attribute, "spi" attribute, "flowLabel" attribute and "flowDirection" attribute set to the value(s) describing the packet filter provided by the UE. + +NOTE 2: The UE signalling with the network is governed by the applicable NAS signalling TS. The NAS 3GPP TS for a specific access may restrict the UE possibilities to make requests compared to what is stated above. + +Upon receipt of the request from the SMF, the PCF shall check the set of services the user is allowed to access. If the user is not allowed to access AF session based services, the PCF shall check whether the user is allowed to request resources for services not known to the PCF and whether the requested QoS and/or packet filters can be authorized. If the user is not allowed to request resources for services not known to the PCF, the PCF shall reject the request with in an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "POLICY\_CONTEXT\_DENIED". + +If the PCF authorizes the request from the UE, the PCF shall construct a PCC rule(s) based on the UeInitiatedResourceRequest data structure. For the request to add the filter(s), the PCF shall within the FlowInformation data structure include the assigned packet filter identifier within the "packFiltId" attribute. When the SMF derives the QoS based on the PCC rule, the SMF shall assign a new packet filter identifier for each added packet filter within the QoS rule and keep the mapping between the packet filter identifier for the packet filter within the PCC rule and QoS rule. + +The PCF shall perform the QoS authorization for the new created or modified PCC rules if requested by the UE as defined in clause 4.2.6.6.2. + +If the PCF detects that the packet filters in the request for new PCC rules received from the SMF is covered by the packet filters of outstanding PCC rules that the PCF is provisioning to the SMF, the PCF may reject the request and indicate the cause for the rejection including the "cause" attribute of the ProblemDetails data structure set to "ERROR\_CONFLICTING\_REQUEST" in an HTTP "403 Forbidden" response message. If the SMF receives a response message with this code, the SMF shall ignore the PDU session modification that initiated the HTTP request as specified in 3GPP TS 24.501[20] clause 6.3.2.5. + +If the PCF does not accept one or more of the traffic mapping filters provided by the SMF in an HTTP Request (e.g. because the PCF does not allow the UE to request enhanced QoS for services not known to the PCF), the PCF shall reject the request and indicate the cause for the rejection including the "cause" attribute of the ProblemDetails data structure set to "ERROR\_TRAFFIC\_MAPPING\_INFO\_REJECTED" in an HTTP "403 Forbidden" response message. If the SMF receives an HTTP response with this code, the SMF shall reject the PDU session modification that initiated the HTTP request. + +The PCF shall not combine a rejection with provisioning of PCC rule operations in the same HTTP response. + +#### 4.2.4.18 Trace Control + +When there is the requirement to activate tracing the SMF may provide trace control parameters within the "traceReq" attribute to the PCF via the Npcf\_SMPolicyControl\_Update service operation. The update service operation may also indicate the update or deactivation of the trace session to the PCF. + +#### 4.2.4.19 Negotiation of the QoS flow for IMS signalling + +When UE initiates a resource modification request, if the SMF includes the "qosFlowUsage" attribute containing "IMS\_SIG" within SmPolicyUpdateContextData data structure and the PCF accepts that a QoS flow dedicated to IMS signalling shall be used, the PCF shall return the "qosFlowUsage" containing "IMS\_SIG" value within the SmPolicyDecision data structure. The provided PCC rules shall have the 5QI applicable for IMS signalling. + +#### 4.2.4.20 Notification about Service Data Flow QoS target enforcement + +When the SMF gets the knowledge that for one or more QoS Flows: + +- the GBR QoS targets cannot be guaranteed; or +- the GBR QoS targets can be guaranteed again; + +the SMF shall inform the PCF that the GBR QoS targets cannot be guaranteed or can be guaranteed again for the PCC rules bound to the QoS flows. + +The SMF gets the knowledge that the GBR QoS targets cannot be guaranteed or can be guaranteed again for the QoS flow(s) as follows: + +- upon receiving a notification from the NG-RAN that the GFBR can no longer be guaranteed or can be guaranteed again as defined clause 5.2.2.3.1 of 3GPP TS 29.502 [22]; or +- during a handover, a QoS Flow which is listed as transferred QoS Flow received from the AMF as defined clause 5.2.2.3.1 of 3GPP TS 29.502 [22] can be interpreted as a notification that GFBR can be guaranteed again if the SMF has received a notification from the source NG-RAN that the GFBR can no longer be guaranteed but does not receive an explicit notification that the GFBR can no longer be guaranteed for that QoS Flow from the Target NG-RAN within a configured time as previous bullet. + +The SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "QOS\_NOTIF" within "repPolicyCtrlReqTriggers" attribute and the "qncReports" attribute. In each QosNotificationControlInfo data structure, the SMF shall include the indication that the GBR QoS targets cannot be guaranteed or the GBR QoS targets can be guaranteed again within the "notifType" attribute and affected PCC rule identifiers within the "refPccRuleIds" attribute. + +If the "AuthorizationWithRequiredQoS" feature as defined in clause 5.8 is supported, the SMF shall also include the reference to the QosData data structure for the Alternative QoS parameter set corresponding to the reference to the matching alternative QoS profile within the "altQosParamId" attribute if the SMF additionally receives the reference to the matching Alternative QoS Profile which the NG-RAN can guarantee when the NG-RAN indicates the GBR QoS targets cannot be guaranteed. When the SMF additionally receives an indication that lowest priority Alternative QoS Profile cannot be fulfilled from the NG-RAN the SMF shall omit the "altQosParamId" attribute to indicate that that the lowest priority alternative QoS profile could not be fulfilled either. When the "DisableUENotification" feature is supported, if the corresponding PCC rule does not include the "disUeNotif" attribute set to true, the SMF shall also send the fulfilled QoS profile or Alternative QoS Profile to the UE as defined in clause 5.2.2.3.1.1 of 3GPP TS 29.518 [36], if applicable. + +If the affected PCC rule was provisioned with a content version, the SMF shall include the "contVers" attribute defined in the QosNotificationControlInfo data structure for those corresponding PCC rules. The SMF may include more than one content version in the "contVers" attribute for the same PCC rule within the corresponding QosNotificationControlInfo instance included in the "qncReports" attribute (e.g. the SMF has combined multiple PCC rule versions enforcement into one QoS flow operation). + +When the "AuthorizationWithRequiredQoS" and the "AltQoSProfilesSupportReport" features as defined in clause 5.8 are supported, and the PCF included during PCC rule provisioning the "refAltQosParams" attribute for the concerned PCC rule(s), if the SMF: + +- receives the indication that the GBR QoS targets cannot be guaranteed, as specified in 3GPP TS 38.413 [54]; and +- does not receive a matching Alternative QoS Profile the NG-RAN can guarantee or the indication that the lowest priority Alternative QoS profile cannot be fulfilled, as specified in 3GPP TS 38.413 [54]; + +then the SMF may determine that Alternative QoS Profiles are not supported by the NG-RAN where the UE is currently located and include within the QosNotificationControlInfo data structure the "altQosNotSuppInd" attribute set to true. When Alternative QoS profiles are supported by the NG-RAN where the UE is currently located, the SMF may omit the "altQosNotSuppInd" attribute or set it to false. + +When the PCF receives the HTTP POST request, it shall acknowledge the request by sending a "200 OK" response to the SMF and then notify the AF as defined in 3GPP TS 29.514 [17], clause 4.2.5.4. + +#### 4.2.4.21 Session Rule Error Report + +If the "SessionRuleErrorHandler" feature is supported and if the installation of one or more session rules fails using the procedure as defined in clauses 4.2.2.1 or 4.2.4.1 or the PCF provisioned one or more session rules as defined in clause 4.2.3.1 but enforcement of the session Rule was unsuccessful (e.g. session-AMBR is rejected by the AMF in the roaming scenario, and the SMF determines that the PDU session is kept, the SMF shall include the "sessRuleReports" attribute for the affected session rules to report the failure within the SmPolicyUpdateContextData data structure. Within each SessionRuleReport instance, the SMF shall identify the failed session rule(s) by including the affected session rules within the "ruleIds" attribute, identify the failed reason code by including a "sessRuleFailureCode" attribute, and shall include rule status within the "ruleStatus" attribute with the value as described below. + +If the installation of one or more new session rules fails, the SMF shall set the "ruleStatus" to INACTIVE. + +The removal of a session rule shall not fail, even if the PDU session procedures with the UE fail. The SMF shall retain information on the removal and conduct the necessary PDU session procedures with the UE when it is possible. + +If the modification of a currently provisioned session rule fails, the SMF shall retain the existing session rule as provisioned without any modification unless the reason for the failure has an impact also on the existing session rule. The SMF shall report the modification failure to the PCF. + +If a session rule was successfully installed, but can no longer be enforced by the SMF: + +- If the "ImmediateTermination" feature is supported, and based on operator's policy, the SMF shall evaluate whether the PDU session can be kept. If the SMF determines to terminate the PDU session immediately, the SMF shall trigger the deletion of the SM Policy Association as described in clauses 4.2.5, otherwise the SMF shall set the "ruleStatus" attribute to INACTIVE. +- If the the "ImmediateTermination" feature is not supported, the SMF shall set the "ruleStatus" attribute to INACTIVE. + +NOTE: When the PCF receives "ruleStatus" set to INACTIVE, the PCF does not need to request the SMF to remove the inactive session rule. + +Depending on the value of the "sessRuleFailureCode" attribute, the PCF may decide whether retaining the old session rule, re-installation, modification, removal of the session rule or any other action applies. + +#### 4.2.4.22 Request the termination of SM Policy association + +If "RespBasedSessionRel" feature is supported, PCF may request the PDU session termination upon receiving a POST message from the SMF (e.g. when usage quota reached). In this case, the PCF shall include the "relCause" attribute within the SmPolicyDecision data structure of the response to the POST message. + +After the receipt of a successful HTTP POST response from the PCF containing the "relCause" attribute within the SmPolicyDecision data structure, the SMF shall invoke the Npcf\_SMPolicyControl\_Delete Service Operation defined in clause 4.2.5 to terminate the policy association and initiate the procedure to terminate the PDU session as defined in 3GPP TS 29.502 [22]. + +#### 4.2.4.23 Reporting of TSC user plane node management information and port management information + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported and the "TSN\_BRIDGE\_INFO" policy control request trigger is provisioned in the SMF, when new TSC user plane node information is available for TSC or Deterministic Networking PDU sessions, the SMF requests to update the SM Policy Association and provides to the PCF information on the conditions that have been met. + +The Policy Control Request Trigger condition "TSN\_BRIDGE\_INFO" is met when: + +- a. the SMF detects new TSC user plane node port (the UE has indicated support of transferring Port Management Information Containers, or SMF local configuration for the given DNN, S-NSSAI indicates support for Deterministic Networking). The SMF shall send to the PCF, if available: + - the port number for the device side of the PDU session encoded in the "dsttPortNum" attribute allocated by the UPF; + +NOTE 1: The port number of the PDU session corresponds to the device side port of the 5GS bridge/router. When the device supports the DS-TT functionality, the port number represents the DS-TT port number corresponding to the given PDU Session. + +NOTE 2: Port number can refer either to Ethernet port or PTP port or a port of a DetNet router. In Ethernet type PDU Sessions, it is assumed that the PTP port number is the same as the associated Ethernet port number. + +- the TSC user plane node Id received from the UPF encoded in the "bridgeId" attribute; +- when DS-TT functionality is used: + - a. the MAC address of the DS-TT port received from the UE encoded in the "dsttAddr" attribute, if received; and + - b. the UE-DS-TT residence time if received from the UE encoded in the "dsttResidTime" attribute, +- in case of Deterministic Networking, for the device side port, and when the feature "MTU\_Size" is supported, the MTU size (as specified in IETF RFC 8344 [56]) for IPv4 and/or IPv6 encoded in the "mtuIpv4" and/or "mtuIpv6" attributes respectively, + +within the SmPolicyUpdateContextData structure encoded in the "tsnBridgeInfo" attribute of the TsnBridgeInfo data type; and/or + +- b. the SMF receives a UMIC from the TSC user plane node functionality of the UPF/NW-TT and/or, when the DS-TT or the NW-TT functions are used, the SMF receives a PMIC from the DS-TT port and/or one or more PMIC(s) in the corresponding one or more NW-TT ports. The SMF shall transparently forward to the PCF the UMIC encoded within the "tsnBridgeManCont" attribute and/or the DS-TT PMIC encoded within the "tsnPortManContDstt" attribute and/or the one or more NW-TT PMIC(s) encoded within the "tsnPortManContNwtt" attribute within the SmPolicyUpdateContextData structure. + +NOTE 3: The 5GS Architecture to support IETF Deterministic Networking IETF RFC 8655 [55] does not require the DS-TT functionality to be supported in the device nor require the user plane NW-TT functionality to be supported in the UPF. For the reporting of information of network side ports, NW-TT control plane functionality is supported and PMIC(s) carry port management information of NW-TT port(s). + +For IP type of PDU sessions, the UE IP address of the PDU session received within the "ipv4Address" or "ipv6AddressPrefix" attribute, as described in clause 4.2.2.2 and 4.2.4.2 (reported with trigger "UE\_IP\_CH") is used as identifier of the PDU session related to the reported TSC user plane node information. + +For Ethernet type of PDU sessions (IEEE TSN and other time sensitive communications than TSN) the MAC address of the DS-TT port received within the "dsttAddr" attribute is used as identifier of the PDU session related to the reported TSC user plane node information. + +#### 4.2.4.24 Notification about Service Data Flow QoS Monitoring + +When the SMF gets the information about real-time measurements of QoS parameters for one or more SDFs from the UPF and the "QOS\_MONITORING" policy control request trigger was provisioned, then SMF shall inform the PCF for the impacted PCC rules + +When the QoS monitoring applies for packet delay, the SMF shall inform the PCF when it gets information about any of the following items for one or more SDFs from the UPF: + +- uplink packet delay(s); +- downlink packet delay(s); and/or +- round trip delay(s); or +- if the feature "PacketDelayFailureReport" is supported, indicator of packet delay measurement failure. + +When the "EnQoSMon" feature is supported and the QoS monitoring applies for congestion information, the SMF shall inform the PCF when it gets information about any of the following items for one or more SDFs from the UPF: + +- uplink congestion information; and/or + +- downlink congestion information; or +- indicator of congestion information measurement failure. + +When the feature "EnQoSMon" is supported, and QoS monitoring applies for data rate measurements, the SMF shall inform about any of the following items for one or more SDFs from the UPF: + +- uplink data rate; and/or +- downlink data rate. + +The SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "QOS\_MONITORING" within "repPolicyCtrlReqTriggers" attribute and the "qosMonReports" attribute, and/or if the feature "XRM\_5G" is supported, and/or the "qosMonDatRateReps" attribute. In each QosMonitoringReport data structure, the PCF shall include: + +- affected PCC rule identifiers within the "refPccRuleIds" attribute; and + +if QoS monitoring is for packet delay, the PCF shall include within the "qosMonReports" attribute: + +- one or two uplink packet delays within the "ulDelays" attribute; and/or +- one or two downlink packet delays within the "dlDelays" attribute; and/or +- one or two round trip packet delays within the "rtDelays" attribute; and/or +- if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within "pdmf" attribute; or + +and/or, if the feature "EnQoSMon" is supported and QoS monitoring is for data rate measurements, the PCF shall include within the "qosMonDatRateReps" attribute: + +- one data rate measurement for the UL within the "ulDataRate" attribute; and/or +- one data rate measurement for the DL within the "dlDataRate" attribute. + +**Editor's note:** Whether the maximum and minimum Data Rate measurements calculated during the waiting time can be reported is FFS. + +and/or, if the feature "EnQoSMon" is supported and QoS monitoring for congestion measurement is enabled, the PCF may include within the "qosMonReports" attribute: + +- the uplink congestion information within the "ulCongInfo" attribute; +- the downlink congestion information within the "dlCongInfo" attribute; or +- the congestion information measurement failure indicator within "cimf" attribute. + +**Editor's Note:** It is FFS whether congestion information measurement failure can occur. + +#### 4.2.4.25 Access traffic steering, switching and splitting support + +If "ATSSS" feature defined in clause 5.8 is supported and the PCF has previously provisioned the AC\_TY\_CH policy control request trigger, when the UE requests to: + +- add an access to an already established MA PDU session (i.e. registers to another access), the SMF shall, within the SmPolicyUpdateContextData data structure, include the "AC\_TY\_CH" within the "repPolicyCtrlReqTriggers" attribute and include the additional Access type and the additional RAT type if available within the "addAccessInfo" attribute. +- release an access from an already established MA PDU session (i.e. deregisters from one access but remains registered on the other access), the SMF shall, within the SmPolicyUpdateContextData data structure, include the "AC\_TY\_CH" within the "repPolicyCtrlReqTriggers" attribute and include the released access type and the released RAT type if available within the "relAccessInfo" attribute. + +When the PCF receives the request from the SMF indicating the addition of Access Type or removal of Access Type, the PCF may provide PCC rules and/or session rules for the MA PDU session as defined in clause 4.2.6.2.17 and clause 4.2.6.3.4. + +#### 4.2.4.26 Policy decision error handling + +##### 4.2.4.26.1 Policy decision types and condition data error handling + +If the "PolicyDecisionErrorHandling" feature is supported and the "ExtPolicyDecisionErrorHandling" feature is not supported, and one or more policy decision types (as defined in clause 4.1.4.4) and/or condition data (as defined in clause 4.1.8) which are not referred by any PCC rules or session rule is provisioned using the procedure as defined in clauses 4.2.2.1, 4.2.3.1 or 4.2.4.1 but the storage was unsuccessful (e.g. the policy decision could not be successfully stored due to a limitation of resources at the SMF), or because there are semantical inconsistencies in the provided data, the SMF shall include the "policyDecFailureReports" attribute to indicate the type(s) of the failed policy decisions and/or condition data within the SmPolicyUpdateContextData data structure. When the PCF receives the above report, the PCF shall consider all the instances of the policy decisions and/or condition data which are not referred by any PCC rule and/or session stored at the SMF and indicated by the PolicyDecisionFailureCode data type are removed from the SMF. + +The removal of a policy decision type and/or condition data shall not fail. + +##### 4.2.4.26.2 Policy decision types, condition data and other policy decisions error handling + +If the "ExtPolicyDecisionErrorHandling" feature is supported and one or more policy decision types (as defined in clause 4.1.4.4) and/or condition data (as defined in clause 4.1.8) which are not referred by any PCC rules or session rules is provisioned using the procedure as defined in clauses 4.2.2.1, 4.2.3.1 or 4.2.4.1, and/or other SM policy decisions (e.g. the SMF receives policy control request triggers and applicable additional information) but the SMF detects the received policy decision cannot be enforced (e.g. because semantical inconsistencies in the provided data), and the SMF determines that the PDU session can be kept, the SMF shall within the SmPolicyUpdateContextData data structure include the "policyDecFailureReports" attribute to indicate a failure in the provided policy decision types and/or condition data not referred by any PCC rules or session rules and/or in other SM policy decisions, and may include the "invalidPolicyDecs" attribute to indicate the failed policy decision types and/or condition data not referred by any PCC rules or session rules and/or other SM policy decisions. + +When the PCF receives the above report, the PCF shall consider: + +- all the instances of the policy decisions and/or condition data which are not referred by any PCC rule and/or session stored at the SMF and indicated by the PolicyDecisionFailureCode data type are removed from the SMF; and +- for the other policy decisions: + - a. All the new failed policy decisions provisioned are not installed in the SMF. + - b. All the modified policy decisions shall remain unmodified in the SMF. + - c. All the removed policy decisions provided in the request message are deleted in the SMF. + +NOTE: The removal of a policy decision does not fail. Even if there is an inconsistency e.g. between the deletion of a policy control request trigger and the deletion of the applicable additional information, the whole related policy decision is removed. + +#### 4.2.4.27 Policy Control for DDN Events + +If the feature "DDNEventPolicyControl" or "DDNEventPolicyControl2" is supported, and if the PCF has previously provisioned "DDN\_FAILURE" policy control request trigger, the SMF shall send the PCC rule request when it receives an event subscription for DDN Failure event including the traffic descriptors. The SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "DDN\_FAILURE" within "repPolicyCtrlReqTriggers" attribute and include one or more traffic descriptor(s) in the "trafficDescriptors" attribute within the SmPolicyUpdateContextData structure for policy evaluation. Upon reception of the HTTP POST message: + +- if the PCF determines that there is an existing PCC rule for the traffic detection of DDD Status event which has the same traffic descriptor(s) as the new request one, the PCF shall update the existing PCC rule for traffic detection of DDD Status event by including both the "DDN\_FAILURE" and "DDD\_STATUS" values within the "notifCtrlInds" attribute of the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or of the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported to indicate both the DDN Failure and DDD Status event detection; +- if the PCF determines that there is an existing PCC rule for the policy and charging control which has the same traffic descriptor(s) as the new request one, the PCF shall update the existing PCC rule by including the downlink data notification control information within the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or within the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported to indicate the DDN Failure event detection. Within the DownlinkDataNotificationControl or DownlinkDataNotificationControlRm data type, the PCF shall include the "DDN\_FAILURE" value within the "notifCtrlInds" attribute; +- otherwise the PCF shall make a new PCC rule by including the reported traffic descriptors within the "flowInfos" attribute, setting a lower value to the "precedence" attribute and including the downlink data notification control information within the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or within the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported and setting the other PCC rule information to the same values as in an existing PCC rule that previously matched the traffic. Within the DownlinkDataNotificationControl or DownlinkDataNotificationControlRm data type, the PCF shall include the "DDN\_FAILURE" value within the "notifCtrlInds" attribute to indicate the DDN Failure event detection. When the new PCC rule has to be bound to the default QoS flow, the PCF shall include the "defQosFlowIndication" attribute set to true within the QosData data structure to which the PCC rule refers. From now on, the PCF needs to keep new PCC rule for event detection fully synchronized with the existing PCC rule that previously matched the traffic for all other policy and charging control settings to ensure the same user experience and traffic treatment according to the operator policy. + +If the feature "DDNEventPolicyControl" or the "DDNEventPolicyControl2" is supported, and if the PCF has previously provisioned "DDN\_DELIVERY\_STATUS" policy control request trigger, the SMF shall send the PCC rule request when it receives an event subscription for DDD Status event including the traffic descriptors. The SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "DDN\_DELIVERY\_STATUS" within "repPolicyCtrlReqTriggers" attribute, include one or more traffic descriptor(s) in the "trafficDescriptors" attribute and the type(s) of notification in the "typesOfNotif" attribute within the SmPolicyUpdateContextData structure for policy evaluation. Upon reception of the HTTP POST message: + +- if the PCF determines that there is an existing PCC rule for traffic detection of DDN Failure event which has the same traffic descriptor(s) as the new request one, the PCF shall update the existing PCC rule for traffic detection of DDN Failure event by including both the "DDN\_FAILURE" and "DDD\_STATUS" values within the "notifCtrlInds" attribute and the type(s) of notifications within the "typesOfNotif" attribute of the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or of the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported to indicate both the DDN Failure and DDD Status event detection; +- if the PCF determines that there is an existing PCC rule for the policy and charging control which has the same traffic descriptor(s) as the new request one, the PCF shall update the existing PCC rule by including the downlink data notification control information within the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or within the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported to indicate the DDD Status event detection. Within the DownlinkDataNotificationControl or DownlinkDataNotificationControlRm data type, the PCF shall include the "DDD\_STATUS" value within the "notifCtrlInds" attribute and the type(s) of notifications within the "typesOfNotif" attribute;otherwise the PCF shall make a PCC rule by including the reported traffic descriptors within the "flowInfos" attribute, setting a lower value to the "precedence" attribute and including the downlink data notification control information within the "ddNotifCtrl" attribute if the "DDNEventPolicyControl" feature is supported or within the "ddNotifCtrl2" attribute if the "DDNEventPolicyControl2" feature is supported to indicate the DDD Status event detection and setting the other PCC rule information to the same values as in an existing PCC rule that previously matched the traffic. Within the DownlinkDataNotificationControl or DownlinkDataNotificationControlRm data type, the PCF shall include the "DDD\_STATUS" value within the "notifCtrlInds" attribute and the type(s) of notifications within the "typesOfNotif" attribute to indicate that DDN Status event detection is required. When the new PCC rule has to be bound to the default QoS flow, the PCF shall include the "defQosFlowIndication" attribute set to true within the QosData data structure to which the PCC rule refers. From now on, the PCF needs to keep new PCC rule for event detection fully synchronized with + +the existing PCC rule that previously matched the traffic for all other policy and charging control settings to ensure the same user experience and traffic treatment according to the operator policy. + +If the feature "DDNEventPolicyControl2" is supported, when the SMF receives a request to cancel a subscription of the DDN Failure or DDD status event and if the PCF has previously provisioned "DDN\_FAILURE\_CANCELLATION" and "DDN\_DELIVERY\_STATUS\_CANCELLATION" policy control request trigger, the SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "DDN\_FAILURE\_CANCELLATION" or "DDN\_DELIVERY\_STATUS\_CANCELLATION" within "repPolicyCtrlReqTriggers" attribute respectively and include the rule identifier of the PCC rule which is used for traffic detection of event within the "pccRuleId" attribute. Upon reception of the HTTP POST message: + +- If the PCC rule corresponding to the received PCC rule identifier is only used for the traffic detection of DDN failure or DDD Status respectively, the PCF shall remove the PCC rule locally and request the SMF to remove it too. +- If the PCC rule corresponding to the received PCC identifier is used for the traffic detection of both DDN failure and DDD status events, the PCF shall update the PCC rule by removing the downlink data notification control information for DDN failure or DDD status respectively from the PCC rule. In order to do that, within the DownlinkDataNotificationControlRm data type of the "ddNotifCtrl2" attribute, the PCF shall omit the "DDN\_FAILURE" or "DDD\_STATUS" within the "notifCtrlInds" attribute respectively. If the data notification control information for the DDD status is omitted, the PCF shall also include the "typesOfNotif" attribute set to NULL. +- If the PCC rule corresponding to the received PCC rule identifier is also used for the policy and charging control to the service data flow besides the traffic detection of the DDN failure or DDD status event, the PCF shall update the PCC rule by removing the downlink data notification control information from the PCC rule. In order to do that, the PCF shall include the "ddNotifCtrl2" attribute set to NULL. + +NOTE: The "ddNotifCtrl1" attribute is used to contain the downlink data notification control information if the "DDNEventPolicyControl" feature is supported; while the "ddNotifCtrl2" attribute is used to contain the downlink data notification control information if the "DDNEventPolicyControl2" feature is supported. + +When the SMF receives the new or updated PCC rule within the response message from the PCF, SMF shall perform the DDD Status and/or DDN Failure event based on the downlink data notification control information within the PCC rule as follows: + +- If the downlink data notification control information indicates that the detection of DDD Status event and buffered notification type is required, the SMF shall derive a PDR and a related FAR as defined in clause 5.28 of 3GPP TS 29.244 [13] to request the UPF to report an event of the first buffered downlink data packet identified by the PDR. When the SMF receives the corresponding report, the SMF shall send the notification to the NEF as defined in clause 4.2.2.2 of 3GPP TS 29.508 [12]. +- If the downlink data notification control information indicates that the detection of DDD Status event and transmitted notification type is required, the SMF shall detect event and send the notification as defined in clause 4.2.2.2 of 3GPP TS 29.508 [12]. +- If the downlink data notification control information indicates that the detection of DDN Failure event and/or DDD Status event and discarded notification type is required, the SMF shall derive a PDR and a related FAR as defined in clause 5.28 of 3GPP TS 29.244 [13] to request the UPF to report an event of the first discarded downlink data packet identified by the PDR. When the SMF receives the corresponding report, the SMF shall send the notification to the AMF as defined in clause 5.2.2.5.1 of 3GPP TS 29.502 [22] and/or send the notification to the NEF as defined in clause 4.2.2.2 of 3GPP TS 29.508 [12] respectively. + +#### 4.2.4.28 Network slice related data rate policy control + +When an Npcf\_SMPolicyControl\_Update request that requires a change of the authorized Session-AMBR and/or MBR update(s) for PCC Rule(s) corresponding to GBR service data flow(s) is received, the PCF may check if the S-NSSAI to which the received request relates is subject to network slice data rate policy control. If it is the case, the PCF shall apply network slice data rate control as described in clause 4.2.6.8. + +#### 4.2.4.29 Group related data rate policy control + +When an Npcf\_SMPolicyControl\_Update request that requires a change of the authorized Session-AMBR and/or MBR update(s) for PCC Rule(s) corresponding to GBR service data flow(s) is received, the PCF may apply group data rate control as described in clause 4.2.6.9. + +#### 4.2.4.30 Notification on network provided BAT Offset policy control trigger + +When the BAT\_OFFSET\_INFO policy control request trigger is set, upon receiving the BAT offset and optionally an adjusted periodicity from the NG-RAN, the SMF shall send an HTTP POST request to the PCF with an SmPolicyUpdateContextData data structure, including the "BAT\_OFFSET\_INFO" within the "repPolicyCtrlReqTriggers" attribute and the BAT offset within the "ranBatOffsetNotif" attribute and optionally the adjusted periodicity within the "adjPeriod" attribute. + +The SMF shall adjust the BAT offset value of "ranBatOffsetNotif" attribute received from NG-RAN based on the clock drifting report from UPF. Otherwise, the SMF shall notify the BAT offset value of "ranBatOffsetNotif" attribute to PCF without any adjustment. + +When the BAT\_OFFSET\_INFO policy control request trigger is set and the QoS Notification Control is also enabled for the corresponding PCC rule, upon receiving the BAT offset along with the "GFBR can no longer be guaranteed" notification from the NG-RAN feedback, the SMF shall, in addition to the provisions of clause 4.2.4.20, include the "BAT\_OFFSET\_INFO" within the "repPolicyCtrlReqTriggers" attribute and the BAT offset within the "ranBatOffsetNotif" attribute of the SmPolicyUpdateContextData data structure. Editor's Note: It is FFS how the bat offset is indicated and reported per PCC rule. + +#### 4.2.4.31 Network slice usage control + +When the PCF receives a Npcf\_SMPolicyControl\_Update request and the "NetSliceUsageCtrl" feature is supported, the PCF may check whether the S-NSSAI of the targeted SM Policy Association is subject to network slice usage control. If it is the case, the PCF may provision/update/remove in the Npcf\_SMPolicyControl\_Update response the network slice usage control information (e.g., the slice PDU session inactivity timer value) within the "sliceUsgCtrlInfo" attribute of the SmPolicyDecision data structure. + +NOTE: In this release of the specification, network slice usage control information provisioning/update/removal by the PCF is not supported in roaming scenarios. + +### 4.2.5 Npcf\_SMPolicyControl\_Delete Service Operation + +#### 4.2.5.1 General + +The delete service operation provides means for the NF service consumer to delete the policy context associated with a PDU Session. + +The following procedures using the Npcf\_SMPolicyControl\_Delete service operation are supported: + +- Deletion of the policy context associated with a PDU session. +- Report Accumulated Usage. +- Report Access Network Information. +- Network slice related data rate policy control. +- Group related data rate policy control. + +#### 4.2.5.2 SM Policy Association termination + +![Sequence diagram showing SM Policy Association termination between an NF service consumer and a PCF. Step 1: The NF service consumer sends a POST request to the PCF with the URI .../sm-policies/{smPolicyId}/delete. Step 2: The PCF responds with a 204 No Content status.](18d7d8de298d79e7bc87af5217f11203_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../sm-policies/{smPolicyId}/delete + NF service consumer->>PCF: Request + Note left of PCF: 2. 204 No Content + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing SM Policy Association termination between an NF service consumer and a PCF. Step 1: The NF service consumer sends a POST request to the PCF with the URI .../sm-policies/{smPolicyId}/delete. Step 2: The PCF responds with a 204 No Content status. + +**Figure 4.2.5.2-1: SM Policy Association termination** + +When an individual resource of the SM Policy Association collection shall be deleted, the NF service consumer shall invoke the Npcf\_SMPolicyControl\_Delete service operation towards the PCF using an HTTP POST request, as shown in figure 4.2.5.2-1, step 1. + +The NF service consumer shall set the request URI to "{apiRoot}/npcf-smolicycontrol/v1/sm-policies/{smPolicyId}/delete". The {smPolicyId} in the URI identifies the "Individual SM Policy" to be deleted. + +The HTTP POST request sent by the NF service consumer (e.g. SMF) shall contain (if available) the SM Policy Association related information within the SmPolicyDeleteData data structure in the request body: + +- accumulated usage within the "accuUsageReports" attribute as defined in clause 4.2.5.3; +- the user location(s) information within the "userLocationInfo" attribute, the information on when the UE was last known to be in that location within the "userLocationInfoTime" attribute, the PLMN Identifier or the SNPn Identifier (the PLMN Identifier and the NID) within the "servingNetwork" attribute, the timezone information within the "ueTimeZone" attribute and the RAN and/or NAS release cause(s) within the "ranNasRelCauses" attribute as defined in clause 4.2.5.4; + +NOTE 1: The SMF derives the value of the "userLocationInfoTime" attribute from the age of location information received from the AMF at PDU session termination as described in 3GPP TS 29.502[22]. Whether the "userLocationInfo" attribute also encodes the age of location is implementation specific. + +NOTE 2: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +- the "PS\_TO\_CS\_HO" value within the "pduSessRelCause" attribute, if the PDU session is released due to PS to CS handover and the "PDUSessionRelCause" feature defined in clause 5.8 is supported; +- the "RULE\_ERROR" value within the "pduSessRelCause" attribute, if the PDU session is released due to a failed enforcement of the applied session rule as described in clause 4.2.4.21 and the "ImmediateTermination" feature defined in clause 5.8 is supported. + +When the PCF receives the HTTP POST request from the NF service consumer and if the PCF successfully processed and accepted the received HTTP POST request from the NF service consumer, the PCF shall acknowledges the request by sending an HTTP response message with the corresponding status code. The PCF acknowledges the delete request by sending a "204 No Content" response to the NF service consumer, as shown in figure 4.2.5.2-1, step 2. Further, the PCF shall remove the individual resource linked to the delete request. + +If errors occur when processing the HTTP POST request, the PCF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP POST request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 4.2.5.3 Report Accumulated Usage + +If the UMC feature is supported, at PDU session termination, the SMF shall send the accumulated usage information for all the monitoring keys for which usage monitoring was previously enabled. When the SMF receives the accumulated usage report from the UPF as defined in clause 7.5.7.2 of 3GPP TS 29.244 [13], the SMF shall include one or more received accumulated usage reports in the "accuUsageReports" attribute of the SmPolicyDeleteData data structure. + +If all PDU sessions related to the same DNN and S-NSSAI combination for a user are terminated, the PCF shall store the remaining allowed usage, i.e. the information about the remaining overall amount of resources, in the UDR as defined in 3GPP TS 29.519 [15]. + +#### 4.2.5.4 Report Access Network Information + +If the RAN-NAS-Cause feature is supported or the NetLoc feature is supported, within the SmPolicyDeleteData data structure, the SMF shall provide the available access network information within the "userLocationInfo" attribute (if available), the information on when the UE was last known to be in that location within the "userLocationInfoTime" attribute (if available), the "ueTimezone" attribute (if available). Additionally, for the NetLoc feature, if the user location information is not available, the SMF shall include the PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID) within the "servingNetwork" attribute; for RAN-NAS-Cause feature, if the SMF received from the access network the RAN cause and/or the NAS cause due to PDU session termination, the SMF shall provide the received cause(s) in the "ranNasRelCauses" attribute. + +NOTE 1: The SMF derives the value of the "userLocationInfoTime" attribute from the age of location information received in the Location-Report (defined in clause 5.3.1 of 3GPP TS 29.518 [36]) from the AMF. Whether the "userLocationInfo" attribute also encodes the age of location is implementation specific. + +NOTE 2: The SMF encodes both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute when they are both received from the AMF. + +#### 4.2.5.5 Void + +#### 4.2.5.6 Network slice related data rate policy control + +When an Npcf\_SMPolicyControl\_Delete request is received, the PCF may check if the S-NSSAI to which the received request relates is subject to network slice data rate policy control. If it is the case, the PCF shall apply network slice data rate control as described in clause 4.2.6.8. + +#### 4.2.5.7 Group related data rate policy control + +When an Npcf\_SMPolicyControl\_Delete request is received, the PCF may apply group data rate control as described in clause 4.2.6.9. + +### 4.2.6 Provisioning and Enforcement of Policy Decisions + +#### 4.2.6.1 General + +Policy Decisions are provided from the PCF to the NF service consumer (SMF) as part of the following service operations: + +- the Npcf\_SMPolicyControl\_Create Service Operation described in clause 4.2.2; +- the SM Policy Association Notification request as part of the Npcf\_SMPolicyControl\_UpdateNotify Service Operation as described in clause 4.2.3.2; and +- the Npcf\_SMPolicyControl\_Update service operation as described in clause 4.2.4 + +Policy decisions shall be encoded within the SmPolicyDecision data structure defined in clause 5.6.2.4 + +Policy decisions may include: + +- Session Rule(s), as described in clause 4.1.4.3, encoded within the "sessRules" attribute; + +- PCC Rule(s), as described in clause 4.1.4.2, encoded within the "pccRules" attribute; +- QoS decision(s), as described in clause 4.1.4.4.3, which can be referenced from PCC rule(s), encoded within the "qosDecs" attribute; +- Charging decision(s), as described in clause 4.1.4.4.4, which can be referenced from PCC rule(s), encoded within the "chgDecs" attribute; +- Traffic control decision(s), as described in clause 4.1.4.4.2, which can be referenced from PCC rule(s), encoded within the "traffContDecs" attribute; +- Usage monitoring control decision(s), as described in clause 4.1.4.4.5, which can be referenced from PCC rule(s) and session rule(s), encoded within the "umDecs" attribute; +- QoS monitoring decision, as described in clause 4.1.4.4.6, which can be referenced from PCC rule(s), encoded within the "qosMonDecs" attribute; +- Condition(s) that can be referenced from PCC rule(s) and session rule(s), encoded within the "conds" attribute; +- QoS characteristics for non-standard 5QIs and non-preconfigured 5QIs provided within the "qosChars" attribute; +- A reflective QoS timer; +- Policy control request triggers and applicable additional information, e.g. Revalidation Time, PRA information; +- Last requested rule data; +- Last requested usage data; +- Default charging method of the PDU session; +- "PDU Session with offline charging only" indication; +- Charging information; +- P-CSCF Restoration Indication; +- IP index information; +- Presence Reporting Area information; +- TSC user plane node management information; +- port management information for the DS-TT port; +- port management information for the NW-TT port; +- The request of the PDU session termination; +- Usage of QoS flow; +- Redundant PDU session indication; +- VPLMN Specific Offloading Policy; and +- the network slice usage control information (e.g. the slice PDU session inactivity timer value), if the "NetSliceUsageCtrl" feature is supported. + +NOTE: In this release of the specification, network slice usage control information provisioning/update/removal by the PCF is not supported in roaming scenarios. + +For the Npcf\_SMPolicyControl\_Create Service Operation, the SmPolicyDecision data structure shall contain a full description of all policy decision(s) provided by the PCF for the policy association. + +For the Npcf\_SMPolicyControl\_UpdateNotify service operation for the SM Policy Association Notification request and for the Npcf\_SMPolicyControl\_Update service operation, the SmPolicyDecision data structure shall contain a description of the changes to the policy decision(s) with respect to the last provided policy decision(s) for the corresponding policy association. The redundant PDU session indication, the default charging method of the PDU + +session, the "PDU Session with offline charging only" indication, the charging information, the Reflective QoS Timer and the IP index information shall not be updated by the PCF. + +If no other rule is defined for specific data types within the SmPolicyDecision data structure, the encoding of changes of the policy decision(s) in the SmPolicyDecision data structure shall follow the following principles: + +- 1) To modify an attribute with a value of type map (e.g. the "sessRules" attribute, the "pccRules" attribute, the "qosDecs" attribute, the "traffContDecs" attribute, the "umDecs" attribute, the "conds" attribute, etc.), this attribute shall be provided with a value containing a map with entries according to the following principles: + - A new entry of the map shall be added by supplying a new identifier (e.g. rule / decision identifier) as the key and the corresponding structured data type instance (e.g. PCC rule) with the complete content as the value. + - An existing entry of the map shall be modified by supplying the existing identifier as the key and the corresponding structured data type instance as the value, with the same existing identifier (e.g. set the "qosId" to the same existing QoS data decision identifier), which shall describe the modifications following bullets 1 to 6. + - An existing entry of the map shall be deleted by supplying the existing identifier as the key and "NULL" as the value. + - For an unmodified entry of the map, no entry needs to be provided within the map. +- 2) To modify an attribute with a structured data type instance as the value, the attribute shall be provided with a value containing a structured data type instance with entries according to bullets 1 to 6. +- 3) To modify an attribute with another type than map or structured data type as the value, the attribute shall be provided with a complete representation of its value, which shall replace the previous value. +- 4) To create an attribute of any type, the attribute shall be provided with a complete representation of its value. +- 5) To delete an attribute of any type, the attribute shall be provided with "NULL" as the value. + +NOTE 1: Attributes that are allowed to be deleted need to be marked as "nullable" within the OpenAPI file in Annex A. + +- 6) Attributes that are not added, modified or deleted do not need to be provided. + +NOTE 2: In the related data structures, no attribute can be marked as mandatory except the attribute containing the identifier (e.g. rule / decision identifier). + +The PCF shall not remove a provisioned policy decision data or condition data from the SMF when the associated reference(s) from the PCC rule(s) or session rule(s) are still valid except the usage monitoring data referred by the pre-defined PCC rule(s) (see clause 4.2.6.5.3.2 for further information). If the PCF determines that the policy decision or condition data shall be used for future PCC or session rule(s), the PCF may keep a policy decision data or condition data valid when the PCF removes all the PCC rule or session rule(s) referring to that policy decision data or condition data; otherwise the PCF shall remove the provisioned policy decision data or condition data when the PCF removes all the PCC or session rule(s) referring to the policy decision data or condition data. + +When the NF service consumer (SMF) accepts the notification of policy updates, and/or when after receiving the response to the request of policies the SM Policy association is retained in the NF service consumer (SMF), if the installation/activation of one or more new PCC rule(s) or the installation of one or more session rule(s) (i.e. rules which were not previously successfully installed) fails, although the failed PCC rule(s) or session rule(s) are removed, the policy decision and/or condition data which are referred by the failed PCC rule(s) or session rule(s) may remain applicable in the SMF until the PCF removes them. If the PCF determines that the policy decision or condition data that remain applicable shall be used for future PCC or session rule(s) (e.g. because the PCF reattempts to install the failed PCC rule) the PCF may keep these policy decision data or condition data valid; otherwise the PCF shall immediately remove these policy data or condition data from the SMF. + +NOTE 3: Due to internal policies, the SMF could decide to remove the policy decision and/or condition data not referred by any PCC and/or session rule(s) before the PCF decides to remove them. When the PCF decides to remove the policy decision and/or condition data that were silently removed by the SMF, the SMF accepts the removal indication, as specified in clauses 4.2.3.26 and 4.2.4.26. When the PCF decides to reuse the policy decision and/or condition data that were silently removed by the SMF, the SMF reports PCC and/or session rule error as specified in clauses 4.2.3.16, 4.2.4.15, 4.2.3.20 and 4.2.4.21. + +NOTE 4: When the PCF notification of policy updates is rejected as specified in clauses 4.2.3.16 and 4.2.3.20 with a HTTP "400 Bad Request" status code, the whole update is rejected, including the provided policy decision and/or condition data. When the SMF reports PCC and/or session rule(s) error as specified in clauses 4.2.4.15 and 4.2.4.21 for all the provisioned PCC rule and/or session rule(s), the valid policy decision and/or condition data provided in the corresponding update response can remain valid in the SMF until the PCF removes them. + +The error handling for the policy decision and/or condition data which are not referred by any PCC rule and/or session rule stored at the SMF is defined in clause 4.2.3.26 and 4.2.4.26. + +## 4.2.6.2 PCC Rules + +### 4.2.6.2.1 Overview + +The PCF may perform an operation on a single PCC rule or a group of PCC rules. The impacted PCC rule(s) shall be included in the "pccRules" map attribute within the SmPolicyDecision data structure with the associated "pccRuleId" as the key of the map. For activating a pre-defined PCC rule or installing or modifying a dynamic PCF-provisioned PCC rule, the corresponding PccRule data structure shall be provided as the map entry value. For deactivating or removing a PCC rule, the map entry value shall be set to "NULL". + +NOTE 1: When deactivating a predefined PCC rule that is activated in more than one QoS flow, this predefined PCC rule is deactivated simultaneously in all the QoS flows where it was previously activated. + +In order to activate a pre-defined PCC rule, the PCF shall include within the PccRule data structure the pre-defined PCC rule identifier within the "pccRuleId" attribute and the "refCondData" attribute, if applicable, i.e. the PccRule data structure is empty, except for the "pccRuleId" attribute and the "refCondData" attribute, if applicable. If the "refCondData" attribute is applicable, a "conds" attribute containing the corresponding ConditionData data structure referred by this PCC rule shall be included in the SmPolicyDecision data structure, if it has not been previously provided. + +In order to install a new dynamic PCF-provisioned PCC rule, the PCF shall further set other attributes within the PccRule data structure as follows: + +- It may include the precedence of a PCC rule among the other PCC rules of the PDU session, within the "precedence" attribute. Within a PDU session, the PCF shall authorize different precedence values for the PCC rules whose packet filters contained within the "flowDescription" attribute or the "ethFlowDescription" attribute include the "packetFilterUsage" attribute set to "true". + +NOTE 2: The SMF sets the precedence value of a QoS rule to the precedence value of the PCC rule for which the QoS rule is generated. The UE considers as an error when two or more QoS rules associated with a PDU session have identical precedence values. + +- It shall include either the flow information within the "flowInfos" attribute or the application identifier within the "appId" attribute. +- It shall include one reference to the QosData data structure within the "refQosData" attribute. In this case, a "qosDecs" attribute containing the corresponding QoS data policy decision shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- It may include one or more reference(s) to the QosData structure within the "refAltQosParams" attribute to refer to the Alternative QoS parameter set(s) of the service data flow. In this case, a "qosDecs" attribute containing the corresponding alternative QoS data policy decision(s) shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- It shall include one reference to the TrafficControlData data structure within the "refTcData" attribute. In this case, a "traffContDecs" attribute containing the corresponding Traffic Control data policy decision shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- It may include one reference to the ChargingData data structure within the "refChgData" attribute. In this case, a "chgDecs" attribute containing the corresponding Charging Data policy decision shall be included in the SmPolicyDecision data structure, if it has not been previously provided. + +- It may include one reference to the UsageMonitoringData data structure within the "refUmData" attribute. In this case, a "umDecs" attribute containing the corresponding Usage Monitoring data policy decision shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- It may include one reference to the QosMonitoringData data structure within the "refQosMon" attribute. In this case, a "qosMonDecs" attribute containing the corresponding QoS Monitoring data policy decision shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- It may include one reference to the ConditionData data type within the "refCondData" attribute. In this case, a "conds" attribute containing the corresponding Condition Data shall be included in the SmPolicyDecision data structure, if it has not been previously provided. +- If the "PowerSaving" feature is supported, it may include the traffic parameter data within the "traffParaData" attribute. + +In order to modify an existing dynamic PCF-provisioned PCC rule, the PCF shall further set other attributes within the PccRule data structure as follows: + +- If the PCF needs to modify attribute(s) within a PCC rule, the PCF shall include the modified attribute(s) with their new value(s) within the associated PccRule data instance in the SmPolicyDecision data structure. Previously supplied attribute(s) not supplied in the modified PCC rule instance shall remain valid. +- If the PCF only needs to modify the content of the referenced policy decision data (e.g. QosData, ChargingData, etc.) and/or condition data for one or more PCC rule(s), the PCF shall include, within the SmPolicyDecision data structure, the corresponding policy decision data and/or condition data within the corresponding map attribute(s) (e.g. include the QoS data decision(s) within the "qosDecs" attribute). +- In order to modify the content of the referenced condition data for one or more existing pre-defined PCC rule(s), the PCF shall include, within the SmPolicyDecision data structure, the corresponding condition data within the "conds" attribute. + +NOTE 3: To update a policy decision data and/or condition data instance, the PCF can provide only the modified attribute(s) with their new value(s) or could provide both, the modified attribute(s) with their new value(s) and the unmodified attributes. When only the modified attribute(s) are provided, the previously supplied attribute(s) not supplied in the modified policy decision data and/or condition data instance remain valid. + +- PCF may also perform a full replacement of a policy decision data and/or condition data instance by including the new reference to the policy decision data and/or condition data instance within the associated PCC rule and the corresponding policy decision and/or condition data in the SmPolicyDecision data structure, if it has not been previously provided. + +The PCF may combine multiple of the above PCC rule operations in a single message. + +The SMF shall ensure that at least one PCC Rule bound to the default QoS flow is activated for the PDU Session. If the PCF does not provision any PCC rule, the SMF shall activate at least one pre-defined PCC rule which is not known by the PCF and bind it to the default QoS flow. + +If the authorized default QoS is GBR type or delay critical GBR type as defined in clause 4.2.6.3.3, to ensure that one and only one of the authorized PCC rules is bound to the default QoS flow the PCF shall indicate that one and only one PCC rule is bound to the default QoS flow as defined in clause 4.2.6.2.10. The SMF shall not bind any other PCC rule to the default QoS flow with a GBR or delay critical GBR 5QI. + +The SMF shall ensure that the packet filters signalled to UE reflects the QoS Flow binding of PCC rules, except for those extending the inspection beyond what can be signalled to the UE. The SMF shall explicitly signal the packet filters to the UE if the corresponding "packetFilterUsage" attribute is provided and set to true. If the "packetFilterUsage" attribute is absent or set to false, it is an SMF decision whether to signal the packet filters that is redundant from a traffic mapping point of view. + +The default QoS rules shall contain either a Packet Filter Set that allows all UL packets or a Packet Filter Set that is generated from the UL packet filters (and from the DL packet filters if they are available) with the "packetFilterUsage" attribute set to true. + +NOTE 1: If multiple PCC rules with the "packetFilterUsage" attribute set to true are bound to the QoS Flow associated with the default QoS rule, it is up to SMF implementation which one will be chosen to generate the default QoS rule. If the PCC rule that is chosen to generate the default QoS rule is removed/deactivated, another PCC rule bound to the QoS Flow associated with the default QoS rule will be used instead and the default QoS rule would be updated accordingly. + +NOTE 2: For IP type PDU Session or Ethernet type PDU Session, the default QoS rule is the only QoS rule of a PDU Session which may contain a Packet Filter Set that allows all UL packets, and in this case, the highest precedence value can be used for the QoS rule. + +#### 4.2.6.2.2 Gate Function + +The Gate Function is a user plane function that permits to control, i.e. enabling or disabling, the forwarding of data packets belonging to a service data flow. A gate is provisioned by the PCF within a PCC rule, enforced by the SMF and ultimately applied by the UPF. + +If a PCC rule contains the "flowInfos" attribute applicable for uplink service data flow(s), it shall describe a gate for the corresponding uplink service data flow(s). If a PCC rule contains the "flowInfos" attribute(s) applicable for downlink service data flow(s), it shall describe a gate for the corresponding downlink service data flow(s). If the PCC rule contains an "appId" attribute, it shall describe a gate for the corresponding detected application traffic. In order to do so, the "flowStatus" attribute within the TrafficControlData data structure to which the PCC rule refers shall describe if uplink and/or downlink gate(s) is/are open or closed. + +The commands to open or close a gate shall lead to enabling or disabling the passage of the corresponding data packets. If a gate is closed, all data packets of the related service data flow(s) are dropped by the UPF. If a gate is open, the data packets of the related service data flow(s) are allowed to be forwarded by the UPF. + +#### 4.2.6.2.3 Policy enforcement for authorized QoS per PCC Rule + +The PCF may provide the authorized QoS for a PCC rule to the SMF. The Provisioning of the authorized QoS per PCC Rule shall be performed using the PCC rule provisioning procedure defined in clause 4.2.6.2.1. For a PCF-provided PCC rule, the authorized QoS shall be encoded using the QosData data structure. The PCF shall include for this purpose a reference to this QosData data structure within the "refQosData" attribute of the PCC rule and a "qosDecs" attribute containing this QoS data decision within the SmPolicyDecision data structure. + +If the authorized QoS is provided for a PCC rule, the SMF shall derive the associated QoS profile towards the access network, if applicable, the associated QoS rule towards the UE, if applicable, and the associated QoS information with the PDR(s) towards the UPF. + +#### 4.2.6.2.4 Redirect Function + +When the ADC feature is supported, the PCF may provide the redirect instructions for one or several dynamic PCC rule(s) to the SMF. This Provisioning shall be performed using the policy provisioning procedure defined in clause 4.2.6.1. + +The "traffContDecs" attribute within the SmPolicyDecision is used to provide traffic control decision(s). The redirect instructions shall be encoded using the "redirectInfo" attribute within the corresponding TrafficControlData data structure, and used to provide a RedirectInformation data structure with the following components: + +- The "redirectEnabled" attribute to indicate whether redirect is enabled or not. It shall be included and set to true when the redirect instruction is initially provisioned and may be included in subsequent updates of the RedirectInformation to enable or disable the redirect instruction. +- The redirect address may be provided using the "redirectAddressType" and "redirectServerAddress" attributes or it may be preconfigured in the SMF/UPF. A redirect destination provided within the "redirectServerAddress" attribute for a dynamic PCC Rule shall override the redirect destination preconfigured in the SMF/UPF. + +NOTE 1: The SMF/UPF uses the preconfigured redirection address only if it can be applied to the application traffic being detected, e.g. the redirection destination address could be preconfigured on a per application identifier basis. + +If redirect action(s) need to be applied to a dynamic PCC rule, this PCC rule shall reference a traffic control decision with the relevant redirect instructions. If a dynamic PCC rule includes flow information for UE IPv4 address and IPv6 + +prefix address(es) related to the same application identifier and the ADCmultiRedirection feature is supported, the "addRedirectInfo" attribute including more than one RedirectInformation data structure may be provided simultaneously to the redirect instruction. + +If the "redirectInfo" attribute is provided for a dynamic PCC rule, the SMF shall instruct the UPF to perform the requested redirection as defined in 3GPP TS 29.244 [13]. + +If the "redirectServerAddress" attribute is not provided in the dynamic PCC rule and the redirection address is not preconfigured in the SMF/UPF for this PCC rule, the SMF shall perform PCC Rule Error Report, as specified in clauses 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "MISS\_REDI\_SER\_ADDR". + +NOTE 2: When the redirect server address is not provided by the PCC rule, the SMF determines the "MISS\_REDI\_SER\_ADDR" error, e.g. when the SMF determines the redirect destination is not pre-configured at both the SMF and the UPF. + +To disable the redirect function for one or more already installed PCC Rule(s), the PCF shall: + +- update the PCC rule to modify the reference to Traffic Control Data decision to point to another (existing or new) Traffic Control Data decision that does not have "redirectInfo" instructions; or +- update the Traffic Control Data decision that the PCC rule refers to with the "redirectEnabled" attribute set to false, if the PCF disables the redirect function for all the PCC rules that refer to this Traffic Control Data decision. + +For a predefined PCC rule, the redirect information shall be included in the rule definition at the SMF/UPF. Redirect information shall be activated for predefined PCC rules while those rules are active. + +#### 4.2.6.2.5 Usage Monitoring Control + +Usage monitoring may be performed for service data flows associated with one or more PCC rules. + +The provisioning of usage monitoring control per PCC rule shall be performed using the PCC rule provisioning procedure as defined in clause 4.2.6.2.1. For a dynamic PCC rule, the reference to the UsageMonitoringData data structure of the usage monitoring control instance, which is related with the PCC rule, shall be included within the "refUmData" attribute of the PccRule data structure of the PCC rule(s). For a predefined PCC rule, the reference to a usage monitoring control instance shall be included in the rule definition at the SMF. Usage monitoring shall be activated for both service data flows associated with predefined PCC rules and dynamic PCC rules, including rules with deferred activation and/or deactivation times while those rules are active. + +#### 4.2.6.2.6 Traffic Steering Control support + +If the TSC feature is supported, the PCF may instruct the SMF to apply a traffic steering control for the purpose of: + +- steering the subscriber's traffic to an appropriate operator or 3rd party service functions (e.g. NAT, antimalware, parental control, DDoS protection) in the N6-LAN or 5G-LAN type of services according to operator policy or, if the SFC feature is supported, according to the information of AF influenced service function chaining, and/or +- enabling the routing of the user traffic to a local Data Network identified by a DNAI per AF request. When the "CommonEASDNAI" feature is supported, the procedure is also used by the PCF to request to select a common EAS or a common DNAI for a set of UE associated with the same traffic correlation Id accessing the application identified by the service data flow template as requested by the AF or to provide endpoint information for the NEF to be notified with information related to UE members of the set of UEs identified by traffic correlation ID. + +If the SFC feature is supported, the PCF may instruct the SMF to apply both traffic steering controls above simultaneously. + +##### 4.2.6.2.6.1 Steering the traffic in the N6-LAN or steering the 5G-LAN type of services + +This procedure is only applicable in non-roaming and home-routed scenarios. + +For the purpose of steering the subscriber's traffic to an appropriate operator or 3rd party service functions in the N6-LAN or steering the 5G-LAN type of services based on network operator configured policies not related to an AF request to influence service function chaining, the PCF shall include within the PccRule data structure a reference to the relevant Traffic Control Data decision and: + +- include within the PccRule data structure either the application to be detected identified by the "appId" attribute or the service data flow to be detected identified by the "flowInfos" attribute; and +- include a "traffContDecs" attribute containing the corresponding Traffic Control Data decision within the SmPolicyDecision, if it has not been previously provided. In this case, the PCF shall include directly within this Traffic Control Data decision a traffic steering policy identifier for downlink within the "trafficSteeringPolIdDI" attribute and/or a traffic steering policy identifier for uplink within the "trafficSteeringPolIdUI" attribute. + +When the SFC feature is supported, for the purpose of steering the subscriber's traffic to an appropriate operator or 3rd party service functions in the N6-LAN or steering the 5G-LAN type of services related to an AF request to influence service function chaining, the PCF shall determine if the ongoing PDU Session is impacted by the steering of traffic to a Service Function Chain as follows: + +- If the AF request includes the individual IP address/ prefix allocated to a UE or the UE MAC address, the PCF shall store the received traffic steering control information and perform session binding as defined in clause 6.2 of 3GPP TS 29.513 [7] to determine the impacted PDU session. +- Otherwise, the PCF fetches from the UDR, as defined in 3GPP TS 29.519 [15], the traffic steering control information applicable for a UE, any UE or an Internal Group Id (if received in the SMF request). + +Then the PCF authorizes the request for influencing service function chaining. For the impacted PDU Session that corresponds to the AF request, the PCF shall take into account, if available, the service function chaining indication stored in the policy data subscription information in the UDR, as defined in 3GPP TS 29.519 [15], to determine whether it is allowed to generate PCC rules with traffic steering information based on AF request information. When allowed, the PCF shall generate PCC rules with traffic steering control information and provide the corresponding Traffic Control Data decision as described above. In this case the traffic steering policy identifier for downlink and/or uplink traffic may be derived from the SFC ID(s) provided by the AF. Additionally, the Traffic Control Data decision may include metadata if provided by the AF. + +NOTE: In case there are both a network operator configured policy for N6-LAN Traffic Steering in PCF and an AF-provided SFC ID(s) mapping to traffic steering control information, the PCF decides based on local configuration which one takes precedence. + +The PCF may also provision the traffic steering control information by activating pre-defined PCC rule(s) in the SMF. + +If traffic steering policy provided in the "trafficSteeringPolIdUI" and/or "trafficSteeringPolIdDI" attribute are invalid or unknown, or the enforcement of the steering of the traffic failed, the SMF shall return a PCC Rule Error Report, as specified in clauses 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "TRAFFIC\_STEERING\_ERROR". + +#### 4.2.6.2.6.2 Steering the traffic to a local access of the data network + +This procedure is only applicable in non-roaming and visited access (i.e. LBO) scenarios. + +The PCF shall determine if the ongoing PDU Session is impacted by the routing of traffic to a local access to a data network as follows: + +- If the AF request includes the individual IP address/ prefix allocated to a UE or the UE MAC address, the PCF shall store the received traffic routing information and perform session binding as defined in clause 6.2 of 3GPP TS 29.513 [7] to determine the impacted PDU session. +- Otherwise, the PCF fetches from the UDR, as defined in 3GPP TS 29.519 [15], the traffic routing data information applicable for a UE, any UE or one or more Internal Group Id(s) (if received in the SMF request) and/or subscriber category(ies). + +NOTE 1: If the UDR provides as part of the traffic routing data information a list of Internal Group Id(s), this information applies to all the PDU sessions related to UEs that belong to every one of these groups, i.e. a single UE needs to be a member of every group in the list of Internal Group Id(s). If the list of subscriber category(ies) is part of the traffic routing data information, this information applies to all the PDU sessions related to the UEs that belong to every one of these Subscriber Categories. + +Then the PCF authorizes the request for influencing SMF routing decisions. For the impacted PDU Session that corresponds to the AF request, the PCF shall take into account, if available, the local routing indication stored in the policy data subscription information in the UDR, as defined in 3GPP TS 29.519 [15], to determine whether it is allowed + +to generate PCC rules with traffic routing information. When allowed, the PCC rules are generated based on the AF request as follows: + +- When the request is for influencing SMF routing decisions, based on traffic routing information, operator's policy, etc., the PCF determines the traffic steering policy. The traffic steering policy indicates, for each DNAI, a traffic steering policy identifier configured in the SMF and/or if the N6 routing information associated to the application is explicitly provided by the AF, the N6 routing information (as provided by the AF). The traffic steering policy identifier is derived by the PCF from the routing profile Id provided by the AF and is related to the mechanism enabling traffic steering to the DN. Then: +- The PCF shall include within each PccRule data structure the necessary information to identify the concerned traffic within either the "flowInfos" attribute or the "appId" attribute, and include within the TrafficControlData data type that the PCC rule refers to a list of locations that the traffic shall be routed to in the "routeToLocs" attribute, and, if the "AF\_latency" feature is supported, the PCF shall include the maximum allowed user plane latency within the "maxAllowedUpLat" attribute if available. If "EASIPreplacement" feature is supported, the PCF shall include the EAS IP replacement information within the "easIpReplaceInfos" attribute if available. +- Within each RouteToLocation instance, the PCF shall include a DNAI in the "dnai" attribute to indicate the location of the application towards which the traffic routing is applied, and a traffic steering policy identifier in the "routeProfId" attribute, to indicate the traffic steering policy that applies to the indicated DNAI, and/ or the explicit N6 traffic routing information in the "routeInfo" attribute. +- If the AF provides both a routing profile Id and N6 routing information for a DNAI, the PCF may include a RouteToLocation instance with the required information or may include two RouteToLocation instances with the same DNAI within the "dnai" attribute and a traffic steering policy identifier within the "routeProfId" attribute in one instance and explicit routing information within the "routeInfo" attribute in the other instance. + +NOTE 2: The N6 traffic routing requirements are related to the mechanism enabling traffic steering in the local access to the DN. The routing profile ID refers to a pre-agreed policy between the AF and the 5GC. This policy may refer to different steering policy identifier(s) sent to the SMF and e.g. based on time of the day, etc. + +NOTE 3: When per DNAI both, the "routeProfId" and the "routeInfo" attributes are provided, if the pre-configured traffic steering policy referenced by the "routeProfId" attribute contains information that is overlapping with the N6 traffic routing information provided in the "routeInfo" attribute, the N6 traffic routing information takes precedence. + +NOTE 4: In this release of the specification, either a traffic steering policy identifier for UL or a traffic steering policy identifier for DL can be defined per DNAI. + +- When the request is for subscribing to UP path change events of the PDU session, the PCF shall include the information on AF subscription to UP path change events within the PCC rule(s) to request the SMF to create a subscription to such notifications for the AF. In order to do so, the PCF shall include within each PccRule data structure the necessary information to identify the concerned traffic within either the "flowInfos" attribute or the "appId" attribute, and include within the Traffic Control Data decision that the PCC rule refers to the information on AF subscription to events within the "upPathChgEvent" attribute. Within this "upPathChgEvent" attribute, the PCF shall include the "dnaiChgType" attribute to indicate the type of notification (i.e. early notification, late notification or both), the notification URI within the "notificationUri" attribute, the notification correlation Id within the "notifCorreId" attribute, and if the URLLC feature is supported, an indication of AF acknowledgement to be expected within the "afAckInd" attribute. In order to enable the AF to identify the AF request to which the notification corresponds when the AF receives a UP path change notification from the SMF, as defined in clause 4.2.2.2 of 3GPP TS 29.508 [12], the PCF shall set the values of the "notificationUri" attribute and "notifCorreId" attribute respectively as follows: +- If the PCF fetches the traffic routing data information from the UDR, the PCF shall set the value of the "notificationUri" attribute to the value of the "upPathChgNotifUri" attribute of the TrafficInfluData data structure and set the value of the "notifCorreId" attribute to the value of the "upPathChgNotifCorreId" attribute of the TrafficInfluData data structure as defined in 3GPP TS 29.519 [15]. +- If the PCF receives the traffic routing data information from the AF via N5 interface, the PCF shall set the values of the "notificationUri" attribute and the "notifCorreId" attribute according to the "upPathChgSub" attribute within the AfRoutingRequirement data structure as defined in 3GPP TS 29.514 [17]. + +If the NEF/AF provided information about the feature support on Nsmf\_EventExposure service as described in 3GPP TS 29.514 [17] (AF request applies an individual UE address) or 3GPP TS 29.519[15] (AF request applies to PDU sessions not identified by a UE address), the PCF may also include this information within the "nscSuppFeats" attribute included within the PccRule data type. + +- If the AF request includes an indication that application relocation is not possible, the PCF shall include within the PccRule data instance(s) the necessary information to identify the traffic within either the "flowInfos" attribute or the "appId" attribute and the "appReloc" attribute set to true. In this case, the SMF shall ensure that for the traffic related with the concerned application, no DNAI change takes place once selected initially for this application. +- If the "EASDiscovery" feature is supported and the AF request includes an indication that EAS rediscovery is required, the PCF shall include within the PccRule data instance(s) the necessary information to identify the traffic within the "appId" attribute and the "easRedisInd" attribute set to true. +- If the URLLC feature is supported and the AF request includes an indication that the UE IP address preservation should be considered, the PCF shall include within the concerned PccRule data instance(s) the "addrPreserInd" attribute set to true. +- If the AF request includes an indication that the PDU session should be correlated via a common DNAI for a given traffic, the PCF shall include within the TrafficControlData data instance provisioned for one or more PCC rule(s), the "traffCorreInd" attribute set to true. + +NOTE 5: The indication of traffic correlation can be provided together with the traffic routing information by the AF for all the members of the 5G VN group. Referred to clause 5.29.4 of 3GPP TS 23.501 [2]. + +- If the feature "SimultConnectivity" is supported and the AF request includes an indication that the simultaneous connectivity may be temporarily maintained for the target and the source PSA during the edge re-location procedure, the PCF may include within the TrafficControlData data instance provisioned for one or more PCC rule(s) the "simConnInd" attribute set to true, as indicated by the AF. If the feature "SimultConnectivity" is supported and the AF request includes the time interval to be considered for inactivity of the traffic routed through the source PSA after which the simultaneous connectivity can be terminated, the PCF may also include the received duration within the "simConnTerm" attribute. +- If the feature "CommonEASDNAI" is supported and AF includes a traffic correlation information within "tfcCorreInfo" attribute, and + - if the AF request also includes an indication that the PDU session should be correlated via a common DNAI, the PCF shall include the TrafficControlData data instance provisioned for one or more PCC rule(s), "COMMON\_DNAI" within the "corrType" attribute and the identification of a set of UEs accessing the application identified by the service data flow template within the "tfcCorrId" attribute. If the NEF has added its information in the AF request in order to be notified with information related to UE members of the set of UEs identified by traffic correlation ID, then the PCF shall include also the "notifUri" and "notifCorrId" attributes within the "tfcCorreInfo" attribute of the TrafficControlData; or + - if the AF request also includes an indication that a common EAS for the application identified by the service data flow template should be selected, the PCF shall include the TrafficControlData data instance provisioned for one or more PCC rule(s), the "COMMON\_EAS" within the "corrType" attribute, the identification of a set of UEs accessing the application identified by the service data flow template within the "tfcCorrId" attribute, the common EAS address(s) within the "comEasIpv4Addr" attribute and/or "comEasIpv6Addr" attribute and/or the FQDN range corresponding to the application within the "fqdnRange" attribute. If the NEF has added its information in the AF request in order to be notified with information related to UE members of the set of UEs identified by traffic correlation ID, then the PCF shall include also the "notifUri" and "notifCorrId" attributes within the "tfcCorreInfo" attribute of the TrafficControlData. + +NOTE 6: Common EAS selection means the common DNAI is selected. + +The PCF shall provide the PCC rule(s) as defined in clause 4.2.6.2.1. + +If the temporal validity condition is received, the PCF shall evaluate the temporal validity condition of the AF request and inform the SMF to install or remove the corresponding PCC rule(s) according to the evaluation result. When policies specific to the PDU Session and policies general to multiple PDU Sessions exist, the PCF gives precedence to the PDU Session specific policies over the general policies. + +If the spatial validity condition is received, the PCF considers the latest known UE location to determine the PCC rules provided to the SMF. In order to do that, the PCF shall request the SMF to report the notifications about change of UE location in an area of interest (i.e. Presence Reporting Area) as defined in clauses 4.2.2.13 or 4.2.3.19. The subscribed area of interest may be the same as the one provided in spatial validity condition, or may be a subset of the spatial validity condition (e.g. a list of TAs) based on the latest known UE location. When the SMF detects that the UE entered the area of interest subscribed by the PCF, the SMF notifies the PCF and the PCF provides to the SMF the PCC rule(s) described above. When the SMF becomes aware that the UE left the area subscribed by the PCF, the SMF notifies the PCF and the PCF may remove or provide updated PCC rule(s) to the SMF. + +When the PCC rules are installed, the SMF may, based on local policies, take the information in the PCC rule(s) into account to: + +- if the PDU Session is of IP type and the "addrPreserInd" attribute is included and set to true in the PCC rule(s), the SMF should preserve the UE IP address and, if necessary, not reselect the related PSA UPF for the traffic identified in the PCC rule once the PSA UPF is selected; otherwise, the SMF (re)selects UPF(s) as it might be required for PDU Sessions. +- activate mechanisms for traffic multi-homing or enforcement of an UL Classifier (UL CL). +- inform the AF of the (re)selection of the UP path (change of DNAI) and/or the candidate DNAI(s) for the PDU Session if the "CommonEASDNAI" feature is supported and the "candDnaiInd" attribute was set to "true". +- determine the target DNAI(s) for the current UE location, which may imply I-SMF selection or removal to be requested to the AMF as defined in 3GPP TS 29.502 [22]. +- if the "traffCorreInd" attribute set to true is included in the TrafficControlData data type referenced by a set of PCC rules, based on SMF implementation and local configuration, the SMF should select a common DNAI from the list of DNAI included in the "routeToLocs" attribute for the identified traffic of the PDU session. +- if the "simConnInd" attribute set to true is included in the TrafficControlData data type referenced by a set of PCC rules, the SMF may temporarily maintain simultaneous connectivity for the source and target PSA at edge relocation procedure, and may influence the establishment of a temporary N9 forwarding tunnel between the source UL CL and target UL CL. If the "simConnTerm" attribute is also included, the SMF may consider the indicated time interval as the minimum one to be considered for inactivity for the described traffic before the connectivity over the source PSA may be removed. +- if the "maxAllowedUpLat" attribute is received, SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value and whether to relocate the PSA UPF to satisfy the user plane latency. +- if the "easIpReplaceInfos" attribute is received, the SMF may instruct the local PSA UPF with the EAS IP replacement information using "Outer Header Creation" as defined in 3GPP TS 29.244 [13] clause 8.2.56 and "Outer Header Removal" as defined in 3GPP TS 29.244 [13] clause 8.2.64. The PSA UPF shall be configured by the SMF to perform one creation and one removal of the appropriate outer header(s) both in the uplink and in the downlink direction in a way that the address information indicated by the "source" attribute (within "easIpReplaceInfos") is used in the headers of the packets towards the UE and the address information indicated by the "target" attribute (within "easIpReplaceInfos") is used in the headers of the packets towards the DN. +- if the "easRedisInd" attribute set to true is included, the SMF may indicate the UE to refresh the cached EAS information as defined in clause 6.3.2 of 3GPP TS 24.501 [20]. +- if the "tfcCorreInfo" attribute is received, and, + - if the "COMMON\_DNAI" is included within the "corrType" attribute in the TrafficControlData data type referenced by a set of PCC rules, based on SMF implementation and local configuration, the SMF should select a common DNAI from the list of DNAI included in the "routeToLocs" attribute for the traffic of the PDU session which have the same traffic correlation Id within the "tfcCorrId" attribute as defined in clause 6.2.3.2.6 of TS 23.548 [62]. The SMF shall use the provided DNAI as the common DNAI when only one is included in the "routeToLocs" attribute; or + - if the "COMMON\_EAS" is included within the "corrType" attribute in the TrafficControlData data type referenced by a set of PCC rules, the SMF should use the value within the "fqdnRange" if received to match the FQDN received from the EASDF via the Neasdf\_DNSContext\_Notify request. If they are matched, the + +SMF may indicate the UE the common EAS address(s) received within the "comEasIpv4Addr" attribute and/or "comEasIpv6Addr" attribute. + +NOTE 7: In order for the SMF to initiate the EASDF-based EAS discovery procedure, the SMF will use the FQDN information received within the "fqdnRange" attribute for setting traffic route and finding DNAI. The "flowInfos" attribute or the "appId" attribute will not be considered for that purpose. + +- if the "notifUri" attribute and "notifCorrId" attribute are included, the SMF shall notify the 5GC determined information for a set of UEs identified by Traffic Correlation ID. + +NOTE 8: Common EAS selection means the common DNAI is selected. + +If routing of traffic to a local access to a data network policy provided in the "routeToLocs" attribute is invalid, unknown or not applicable, or the enforcement of the steering of the traffic to the indicated DNAI failed, the SMF shall return a PCC Rule Error Report, as specified in clauses 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "DNAI\_STEERING\_ERROR". + +#### 4.2.6.2.7 Conditioned PCC rule + +The PCF may control at what time the status of a PCC rule changes. In order to provision a PCC rule with conditional data, the PCF shall provision a PCC rule as defined in clause 4.2.6.2.1 and include within its "refCondData" attribute the value of the "condId" attribute of the targeted ConditionData instance. The PCF shall also ensure that this referenced ConditionData instance is included in the "conds" map attribute within the SmPolicyDecision data structure, following the procedures defined in clause 4.2.6.1. + +Within the ConditionData instance, the PCF shall include the activation time within the "activationTime" attribute and/or the deactivation time within the "deactivationTime" attribute. + +When the SMF receives a conditioned PCC rule, the SMF shall act as follows: + +- 1) If only the "activationTime" attribute is provided by the PCF and the time specified in it is in the future, then the SMF shall set the PCC rule to inactive state and only change it to active state at the specified time. If this time specified in the "activationTime" attribute is in the past, then the SMF shall immediately set the PCC rule to active state. +- 2) If only the "deactivationTime" attribute is provided by the PCF and the time specified in it is in the future, then the SMF shall set the PCC rule to active state and only change it to inactive state at the specified time. If this time specified in the "deactivationTime" is in the past, then the SMF shall immediately set the PCC rule to inactive state. +- 3) If both the "activationTime" attribute and the "deactivationTime" attribute are provided by the PCF, and the value specified in the "activationTime" occurs before the value specified in the "deactivationTime" attribute, and also when the PCC rule is provided before or at the value specified in the "deactivationTime", the SMF shall handle the PCC rule first as defined in 1) and then as defined in 2). +- 4) If both the "activationTime" attribute and the "deactivationTime" attribute are provided by the PCF, and the value specified in the "deactivationTime" attribute occurs before the value specified in the "activationTime", and also when the PCC rule is provided before or at the value specified in the "activationTime" attribute, the SMF shall handle the PCC rule first as defined in 2) and then as defined in 1). +- 5) If both the "activationTime" attribute and the "deactivationTime" attribute are provided by the PCF and are both in the past, and the value specified in the "activationTime" occurs before the value specified in the "deactivationTime" attribute, then the SMF shall immediately set the PCC rule to inactive state. +- 6) If both the "activationTime" attribute and the "deactivationTime" attribute are provided by the PCF and are both in the past, and the value specified in the "deactivationTime" attribute occurs before the value specified in the "activationTime" attribute, then the SMF shall immediately set the PCC rule to active state. +- 7) If both "activationTime" attribute and "deactivationTime" attribute are specified with the same time, the SMF shall report a PCC rule error for the concerned PCC rule(s), as specified in clauses 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "INCORRECT\_COND\_DATA". + +The PCF may modify a currently installed/activated PCC rule, including setting, modifying or deleting its deferred activation and/or deactivation time as follows: + +- 1) When modifying a PCC rule by newly setting the deferred activation time and/or deactivation time, the PCF shall update the PCC rule by including the corresponding ConditionData instance's "condId" attribute value within the "refCondData" attribute and including within the SmPolicyDecision data structure this ConditionData instance within the "conds" map attribute, if not previously provisioned. +- 2) When modifying a PCC rule by modifying the already provisioned deferred activation time and/or deactivation time: + - the PCF may update the PCC rule by replacing the existing ConditionData instance's "condId" attribute value within the "refCondData" attribute with a another one pointing to another ConditionData instance and including within the SmPolicyDecision data structure this new ConditionData instance within the "conds" attribute, if not previously provisioned; or + - the PCF may update the condition data decision to which the PCC rule refers by updating the corresponding ConditionData instance in the SmPolicyDecision data structure, as defined in clause 4.2.6.1. The PCF may add an activation time and/or a deactivation time, update the values of the existing activation time and/or deactivation time, or delete either the existing activation time or the existing deactivation time. +- 3) When modifying a PCC rule by deleting the previously provisioned deferred activation time and/or deactivation time: + - the PCF shall delete the reference to the corresponding ConditionData instance within the PCC rule by updating the "refCondData" attribute of the PCC rule to "NULL" value; and + - the PCF may also delete this condition data decision to which the PCC rule refers as defined in clause 4.2.6.1 (i.e. delete the corresponding ConditionData instance within the SmPolicyDecision data structure), if no other PCC rule is referring to this condition data decision. + +To delete a conditioned PCC rule, the PCF shall run the procedures as defined in clause 4.2.6.2.1. + +The UE timezone information, if available, may be used by the PCF to construct the values of the "activationTime" attribute and/or the "deactivationTime" attribute. + +The PCC rule(s) including a reference to a Condition Data decision which includes an "activationTime" attribute and/or a "deactivationTime" attribute shall be bound to a QoS flow associated with a default QoS rule that allows all UL packets. If such PCC rule(s) are not bound to a QoS flow associated with a default QoS rule, the SMF shall report a failure to the PCF by including the "ruleReports" attribute with the "failureCode" attribute set to the value "NO\_QOS\_FLOW\_BOUND" for the affected PCC rule(s). Changes of the QoS profile or QoS rule which will initiate signalling towards the access network and/or UE in such PCC rule(s) shall also not be applied. + +NOTE: This limitation prevents dependencies on the signalling of changed traffic mapping information towards the UE. + +#### 4.2.6.2.8 PCC rule for resource sharing + +If the ResShare feature is supported by both the SMF and PCF as described in clause 5.8, the PCF may indicate that the SMF should commonly reserve resources for a set of PCC rules. The SMF shall then, for PCC rules bound to the same QoS flow and the same sharing key value, use the highest GBR value among those PCC rules as input for calculating the common GBR value when reserving QoS flow resources. The GBR value for each direction shall be considered separately, so that the uplink and downlink GBR values may originate from different PCC rules. + +The SMF may, based on internal logic, use the highest MBR value among the provided PCC rules indicated to share resources, when determining the MBR for the QoS flow. Each individual PCC rule is still subject to data rate policing based on its own MBR values. + +The PCF shall provide the "sharingKeyDI" attribute and/or "sharingKeyUI" attribute within the QosData data structure which the PCC rules refers to in order to indicate that the related PCC rule may share resources with other PCC rules bound to the same QoS flow. + +The SMF shall apply resource sharing if at least two PCC rules bound to the same QoS flow share the same value in the "sharingKeyDI" attribute and/or "sharingKeyUI" attribute. + +When modifying the value of "sharingKeyDI" attribute and/or "sharingKeyUI" attribute of the QosData data structure, which a PCC rule refers to for the PCC rule that is subject to resource sharing the SMF may adjust the resource sharing of the remaining PCC rules. + +NOTE 1: A PCC rule that is deleted is also removed from the resource sharing, while the remaining PCC rules continue their sharing relationship. + +NOTE 2: The state of resource sharing ends when less than two of the PCC rules in the set remains. + +#### 4.2.6.2.9 Resource reservation for services sharing priority + +When the PCF derives PCC Rules corresponding to a service related to an AF that has indicated that priority sharing is allowed for that service over Rx interface or within the Npcf\_PolicyAuthorization service, it derives the corresponding PCC Rules according to current procedures as described in 3GPP TS 29.513 [7], clause 7.3. The PCF may additionally take the suggested pre-emption capability and vulnerability values into account if the AF provided them when the PCF determines the ARP pre-emption capability and vulnerability. The ARP derived at this point and the priority sharing indicator provided over Rx reference point (see 3GPP TS 29.214 [18] for further information) or over the Npcf\_PolicyAuthorization service (see 3GPP TS 29.514 [17] for further information) related to these derived PCC Rules are stored for later use. + +For PCC Rules related to the same PDU session with the same assigned 5QI and with the priority sharing indicator enabled (see 3GPP TS 29.214 [18], clause 4.4.8, or 3GPP TS 29.514 [17], clauses 4.2.2.21, 4.2.3.21 and 4.2.4.9), the PCF shall rederive the ARP into a shared ARP for these PCC Rules as follows: + +- The Priority Level shall be set to the lowest value (i.e. highest priority) among the Priority Level values derived for the PCC rules that include the priority sharing indicator. +- The Pre-emption Capability shall be set to true if any of the original derived PCC Rules have the Pre-emption Capability value set to true. +- The Pre-emption Vulnerability shall be set to true if all the original derived PCC Rules have the Pre-emption Vulnerability value set to true. + +NOTE 1: Having the same setting for the ARP parameter in the PCC Rules with the priority sharing indicator set enables the usage of the same QoS flow. Furthermore, a combined modification of the ARP parameter in the PCC rules ensures that a QoS flow modification is triggered when a media flow with higher service priority starts. + +If the 5QI and/or ARP related to any of the PCC Rules that share priority is changed (e.g. based on local policies), the PCF shall rederive the ARP for the impacted PCC Rules following the same procedure as defined in this clause. + +The PCF shall provision the PCC Rules according to the rederived ARP information as described in clause 4.2.6.2.1. + +If the PCF receives a report that a PCC rule provisioning or modification failed due to the resource reservation failure as defined in clauses 4.2.3.1.6 and 4.2.4.15 (PCC Rule Error Report) and if the PCF supports the MCPTT-Preemption feature as defined in clause 5.4.1 of 3GPP TS 29.214 [18] or in clause 5.8 of 3GPP TS 29.514 [17], the PCF shall check if pre-emption control based on the pre-emption control information provided by the AF as defined in clauses 4.4.1 or 4.4.2 of 3GPP TS 29.214 [18] or in clauses 4.2.2.21, 4.2.3.21 or 4.2.4.9 of 3GPP TS 29.514 [17] applies. + +NOTE 2: The PCF determines that pre-emption control applies based on the presence of the Pre-emption-Control-Info AVP received over Rx reference point as defined in 3GPP TS 29.214 [18] or "preemptControlInfo" attribute received over N5 reference point as defined in 3GPP TS 29.514 [17] and operator policies. + +If pre-emption control applies, the PCF shall check the corresponding derived PCC Rules (before applying priority sharing procedures). If the Pre-emption Capability of the derived PCC Rule is disabled the PCF shall notify that resource allocation has failed for this PCC rule to the AF as defined in clauses 4.4.1 or 4.4.2 of 3GPP TS 29.214 [18] or in clauses 4.2.2.21, 4.2.3.21 or 4.2.4.9 of 3GPP TS 29.514 [17]. Otherwise, if the Pre-emption Capability of the derived PCC Rule is enabled, the PCF shall perform the pre-emption control as follows: + +- For all the active PCC rule(s) that applied priority sharing mechanism, the PCF shall identify the PCC Rules that have the Pre-emption Vulnerability enabled. For those selected PCC Rule(s), the PCF shall check the Priority Level value. + +- If there is only one PCC Rule with the Priority Level value higher (i.e. lower priority) than the derived Priority Level value of new or modified PCC Rule, the PCF shall remove this PCC rule. The PCF shall retry the PCC rule provisioning or modification procedure for the PCC rule that failed. +- Otherwise, if there are more than one PCC Rule with the Priority Level value higher (i.e. lower priority) than the derived Priority Level value of new or modified PCC Rule, the PCF shall remove the PCC Rule with the highest Priority Level from the SMF. The PCF shall retry the PCC rule provisioning or modification procedure for the PCC rule that failed; If more than one PCC Rule have the same highest Priority Level, the PCF shall check the Pre-Emption-Control-Info AVP received over Rx interface as defined in 3GPP TS 29.214 [18], or the "preemptControlInfo" attribute received over N5 interface as defined in 3GPP TS 29.514 [17] and remove the PCC Rule that matches the condition. +- Otherwise, if there is at least one PCC Rule with the same Priority Level value than the derived Priority Level value of new or modified PCC Rule, the PCF shall check the Pre-emption-Control-Info AVP received over Rx interface as defined in 3GPP TS 29.214 [18] or the "preemptControlInfo" attribute received over N5 interface as defined in 3GPP TS 29.514 [17] for these PCC Rules and remove the PCC Rule that matches the condition. +- Otherwise, the PCF shall notify that resource allocation has failed for this PCC rule to the AF as defined in clauses 4.4.1 or 4.4.2 of 3GPP TS 29.214 [18] or in clauses 4.2.2.21 or 4.2.3.21 of 3GPP TS 29.514 [17]. + +If there is no active PCC Rule with the Pre-emption Vulnerability enabled, the PCF shall notify that resource allocation has failed for this PCC rule to the AF as defined in clauses 4.4.1 or 4.4.2 of 3GPP TS 29.214 [18]. + +NOTE 3: If the PCF receives a report that a PCC rule provisioning or modification failed due to the resource reservation failure and the PCF does not support the MCPTT-Preemption feature as defined in clause 5.4.1 of 3GPP TS 29.214 [18] or clause 5.8 of 3GPP TS 29.514 [17], the PCF can apply pre-emption and remove active PCC rules from the SMF and then retry the PCC rule provisioning or modification procedure. Otherwise, the PCF will notify it to the AF as defined in clauses 4.4.1 or 4.4.2 of 3GPP TS 29.214 [18] or in clauses 4.2.2.21 or 4.2.3.21 of 3GPP TS 29.514 [17]. How the PCF applies the pre-emption depends on the implementation. + +#### 4.2.6.2.10 PCC rule bound to the default QoS flow + +The PCF may indicate to the SMF that a PCC rule shall be bound to the default QoS flow and remain on the default QoS flow. The SMF shall then, for the indicated PCC rule, bind it to the default QoS flow until this PCC rule is removed or until the PCF modifies this PCC rule to set the "defQosFlowIndication" attribute to false. For this second case, the SMF shall evaluate the full QoS information within the QosData data structure to which the PCC rule refers and follow normal policy enforcement procedures for authorized QoS per service data flow as described in clause 4.2.6.2.3. + +NOTE: 5QI, ARP, QNC (if available), Priority Level (if available), Averaging Window (if available) and Maximum Data Burst Volume (if available) within the QoS Data decision referred by the PCC rule are only used by the SMF for QoS flow binding purposes when the "defQosFlowIndication" attribute is not included in the QoS Data decision or it is included and set to false. + +The PCF shall provide the "defQosFlowIndication" attribute set to true in order to indicate that the related PCC rule shall be bound to the default QoS flow. + +If the "defQosFlowIndication" attribute is provided and set to true within the QosData data structure to which the PCC rule refers, the SMF shall bind the related PCC rule to the default QoS flow. This binding remains valid until the related PCC rule is removed or if the PCF indicates to the SMF that the binding to the default QoS flow for this PCC rule no longer applies. + +The SMF shall ignore the values of the other attributes, including 5QI, ARP, QNC (if available), Priority Level (if available), Averaging Window (if available) and Maximum Data Burst Volume (if available), provided within the QosData data structure if the "defQosFlowIndication" attribute is provided by the PCF and set to true. If the PCF has previously indicated to the SMF that a PCC rule shall be bound to the default QoS flow, and desires to indicate that this binding no longer applies the PCF shall update this PCC rule by including the "defQosFlowIndication" attribute set to false. The SMF shall in this case evaluate the full QoS information within the QosData data structure to which the PCC rule refers and follow normal policy enforcement procedures for authorized QoS per service data flow as described in clause 4.2.6.2.3. + +If the PCF has not previously indicated to the SMF that a PCC rule shall be bound to the default QoS flow (i.e. it may be bound to another QoS flow), in order to indicate that the binding to the default QoS flow shall now apply for this PCC rule, the PCF shall update the PCC rule by including (or updating) the "defQosFlowIndication" attribute and set it to true. The SMF shall in this case follow the procedures described in this clause. + +#### 4.2.6.2.11 PCC rule for Application Detection and Control + +If the ADC feature is supported, the user subscription indicates that application detection and control is enabled, and the PCF determines that application detection is required because of e.g. an internal/external trigger or the PCF has received from an NF service consumer (e.g. another PCF or an AF) a subscription to the event for application start/stop traffic detection (see TS 29.514 [17], clause 4.2.6.9 subscription to application detection control and TS 29.523 [61], clause 4.2.2 for AF subscription to application detection control), the PCF may instruct the SMF to detect application(s) by installing or activating PCC rule(s). + +NOTE: When the NF service consumer is an AF, the PCF will identify all the affected PDU sessions based on the received information as specified in TS 29.523 [61] and generate the PCC Rules with instructions to detect application(s) for each affected PDU session. + +An application to be detected is identified by an application identifier, which shall be provided within the "appId" attribute for dynamic PCC rules or pre-provisioned for predefined PCC rules. If the PCF requires to be notified when application start/stop is detected, it shall also provide the APP\_STA and APP\_STO policy control request triggers to the SMF as defined in clause 4.2.4.6. For dynamic PCC rules, the PCF may also mute such notifications for a specific detected application by including a "traffContDecs" attribute to contain a Traffic Control Data decision which contains the "muteNotif" attribute set to true and including a "refTcData" attribute referring to this Traffic Control Data decision within the concerned PCC rule. + +If the application identifier provided in the "appId" attribute is invalid, unknown or not applicable, the SMF shall return a PCC Rule Error Report, as specified in clauses 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "APP\_ID\_ERR". + +The SMF shall reject the update of the mute indication for a provisioned PCC rule as specified in clause 4.2.3.16 and 4.2.4.15, and set the "failureCode" attribute to "MUTE\_CHG\_NOT\_ALLOWED". + +When the application detection control was initiated by an NF service consumer and it unsubscribes to receive these notifications, the PCF shall unsubscribe to the related policy control request triggers as described in clause 4.2.6.4 unless they are used for other purposes. + +In this release of the specification Application Detection and Control applies only to the IP PDU session type. + +#### 4.2.6.2.12 Provisioning of PCC Rules for Multimedia Priority Services + +##### 4.2.6.2.12.1 General + +The provision of PCC Rules corresponding to both MPS and non-MPS service shall be performed as described in clause 4.2.6.2.1 "Provisioning of PCC rules". + +When the PCF derives PCC Rules corresponding to MPS service, the ARP and 5QI shall be set as appropriate for the prioritized service, e.g. an IMS Multimedia Priority Service. The PCF may authorize a standardized 5QI or a standardized 5QI with a specific 5QI priority level as defined in clause 4.2.6.6.2. The PCF may also authorize a non-standardized 5QI with explicitly signalled QoS characteristics as defined in clause 4.2.6.6.3. + +When the PCF derives PCC Rules corresponding to non-MPS service, the PCF shall generate the PCC Rules as per normal procedures. At the time the Priority PDU connectivity services is invoked based on the subscription profile stored in the UDR (i.e. Indication for support of Priority PDU connectivity service and MPS Priority Level are set in the UDR) or by the AF (e.g., MPS for DTS is invoked as described in 3GPP TS 29.214 [18] and 3GPP TS 29.514 [17]), the PCF shall upgrade the ARP and/or change 5QI for the PCC Rules to appropriate values as needed for MPS. The PCF shall change the ARP and/or 5QI (also associated QoS characteristics if applicable) modified for the Priority PDU connectivity service to an appropriate value according to PCF decision. + +When the PCF receives an HTTP POST message as defined in clause 4.2.2.1, the PCF shall check whether any of these parameters is stored in the UDR: indication for support of Priority PDU connectivity service, MPS Priority Level and/or indication of IMS priority service support. The PCF shall derive the applicable PCC rules and default QoS flow QoS based on that information. If the indication of IMS priority service support is set and the "dnn" attribute corresponds to + +a DNN dedicated for IMS, the PCF shall assign an ARP corresponding to MPS for the default QoS flow and for the PCC Rules corresponding to the IMS signalling QoS flow. If the "dnn" does not correspond to a DNN dedicated for IMS, the ARP shall be derived without considering IMS Signalling Priority. + +NOTE 1: Subscription data for MPS is provided to PCF through the Nudr service. + +Once the PCF receives a notification of a change in Priority PDU connectivity services support, MPS Priority Level and/or IMS priority service support from the UDR, the PCF shall make the corresponding policy decisions (i.e. ARP and/or 5QI (also associated QoS characteristics if applicable) change) and, if applicable, shall initiate an HTTP POST message as defined in clause 4.2.3.2 to provision the modified data. + +NOTE 2: The details associated with the UDR service are specified in 3GPP TS 29.519 [15]. + +NOTE 3: The MPS Priority Level is one among other input data such as operator policy for the PCF to set the ARP. + +Whenever one or more AF sessions of an MPS service are active within the same PDU session, the PCF shall ensure that the ARP priority level of the default QoS flow is at least as high as the highest ARP priority level used by any authorized PCC rules belonging to an MPS service. If the ARP pre-emption capability is enabled for any of the authorized PCC rules belonging to an MPS service, the PCF shall also enable the ARP pre-emption capability for the default QoS Flow. + +NOTE 4: This ensures that services using dedicated QoS flows are not terminated because of a default QoS flow with a lower ARP priority level or disabled ARP pre-emption capability being dropped during mobility events. + +NOTE 5: This PCF capability does not cover interactions with services other than MPS services. + +#### 4.2.6.2.12.2 Invocation/Revocation of Priority PDU connectivity services + +When a Priority PDU connectivity services is invoked, the PCF shall: + +- Derive the corresponding PCC Rules with the ARP and 5QI (also associated QoS characteristics if applicable) set as appropriate for a prioritized service. +- Set the ARP of the default QoS flow as appropriate for a Priority PDU connectivity services under consideration of the requirement described in clause 4.2.6.2.12.1. +- Set the 5QI (also associated QoS characteristics if applicable) of the default QoS flow as appropriate for the Priority PDU connectivity services. +- Set the ARP of PCC Rules installed before the activation of the Priority PDU connectivity services to the ARP as appropriate for the Priority PDU connectivity services under the consideration of the requirements described in clause 4.2.6.2.12.1. +- Set the 5QI of the PCC Rules installed before the activation of the Priority PDU connectivity services to the 5QI (also associated QoS characteristics if applicable) as appropriate for the Priority PDU connectivity services if modification of the 5QI of the PCC Rules is required. + +When a Priority PDU connectivity services is revoked, the PCF shall: + +- Delete the PCC Rules corresponding to the Priority PDU connectivity services if they were previously provided. +- Set the ARP of the default QoS flow to the normal ARP under the consideration of the requirements described in clause 4.2.6.2.12.1. +- Set the 5QI of the default QoS flow as appropriate for PCF decision. +- Set the ARP of all active PCC Rules as appropriate for the PCF under the consideration of the requirements described in clause 4.2.6.2.12.1. +- Set the 5QI to an appropriate value according to PCF decision if modification of the 5QI of PCC Rules is required. + +NOTE: Priority PDU connectivity services can be explicitly invoked/revoked via UDR MPS user profile (Indication of Priority PDU connectivity services, MPS Priority Level). An AF for MPS Priority Service can also be used to provide Priority PDU connectivity services using network-initiated resource allocation procedures (via interaction with PCC) for originating accesses. + +The PCF shall provision the SMF with the applicable PCC Rules upon Priority PDU connectivity services activation and deactivation as described above. The provision of the QoS information applicable for the PCC Rules shall be performed as described in clause 4.5.6.2. The provision of QoS information for the default QoS flow shall be performed as described in clause 4.2.6.3. + +#### 4.2.6.2.12.3 Invocation/Revocation of IMS Multimedia Priority Services + +If the PCF receives service information including an MPS session indication and the service priority level from the P-CSCF or at reception of the indication that IMS priority service is active for the PDU session, the PCF shall under consideration of the requirements described in clause 4.2.6.2.12.1: + +- if required, set the ARP and 5QI (also associated QoS characteristics if applicable) of the default QoS flow as appropriate for the prioritized service; +- if required, set the ARP and 5QI (also associated QoS characteristics if applicable) of all PCC rules assigned to the IMS signalling QoS flow as appropriate for IMS Multimedia Priority Services; +- derive the PCC Rules corresponding to the IMS Multimedia Priority Service and set the ARP and 5QI (also associated QoS characteristics if applicable) of these PCC Rules based on the information received over N5/Rx. + +If the PCF detects that the P-CSCF released all the MPS session and the IMS priority service has been deactivated for the PDU session the PCF shall under consideration of the requirements described in clause 4.2.6.2.12.1: + +- delete the PCC Rules corresponding to the IMS Multimedia Priority Service; +- if required, set the ARP and 5QI of the default QoS flow as appropriate for the IMS Multimedia Priority set to inactive; +- replace the ARP and 5QI of all PCC Rules assigned to the IMS signalling QoS flow as appropriate when the IMS Multimedia Priority is inactive. + +#### 4.2.6.2.12.4 Invocation/Revocation of MPS for DTS + +When the PCF receives from the AF an indication of invocation/revocation of MPS for DTS as specified in 3GPP TS 29.514 [17] or 3GPP TS 29.214[10], and if the "MPSforDTS" feature is supported, the PCF shall make the corresponding policy decisions (i.e. ARP and/or 5QI change for the default QoS) and, if applicable, shall initiate an Npcf\_SMPolicyControl\_UpdateNotify to provision the modified data. + +For the invocation of MPS for DTS, the PCF shall: + +- Set the ARP of the default QoS flow as appropriate for MPS for DTS. +- Set the 5QI (also associated QoS characteristics if applicable) of the default QoS flow as appropriate for MPS for DTS. + +NOTE 1: For PCC Rules that had the same ARP and 5QI as the original default QoS flow: the PCF indicates to the SMF that the PCC rule is to be bound to the default QoS flow by setting the "defQosFlowIndication" attribute within the QosData data structure to true; or sets the ARP as appropriate for MPS for DTS and the 5QI (also associated QoS characteristics if applicable) as appropriate for MPS for DTS. + +For the revocation of MPS for DTS, to revert the MPS for DTS values of the default QoS flow and the PCC rules bound to the default QoS flow, the PCF shall set the ARP and the 5QI of the default QoS flow as appropriate for PCF decision. + +NOTE 2: For PCC Rules that had the same ARP and 5QI as the default QoS flow, or had the "defQosFlowIndication" attribute set to true: the PCF sets the ARP; and the 5QI (also associated QoS characteristics if applicable) as appropriate for PCF decision. The provision of the QoS information applicable for the PCC Rules is performed as described in clause 4.2.6.6. + +NOTE 3: Revocation may require more complex logic on the part of the PCF beyond simply restoring the prior ARP and 5QI values as set prior to invocation of MPS for DTS, if these values and/or the defQosFlowIndication were modified by another service during the time that MPS for DTS was enabled. The corresponding logic is dependent on the identification of particular services that may be deployed and the desired interactions between MPS for DTS and any such services. These aspects are not considered in the present specification. + +The PCF shall provision the SMF upon MPS for DTS invocation and revocation as described above for the default QoS flow as described in clause 4.2.3.6. + +On receipt from an AF of a request to report the successful outcome of the MPS for DTS invocation/revocation of priority handling for the default QoS flow (see 3GPP TS 29.214 [18] and 3GPP TS 29.514 [17]), the PCF shall request the SMF to confirm that the resources associated to the MPS for DTS invocation/revocation are successfully allocated. The PCF does this by setting the "policyCtrlReqTriggers" attribute in the "SmPolicyDecision" data structure to the value "SUCC\_QOS\_UPDATE". On receipt of the "repPolicyCtrlReqTriggers" attribute in the SmPolicyUpdateContextData data structure set to the value "SUCC\_QOS\_UPDATE" from the SMF, the PCF shall inform the AF that it successfully acted upon the "mpsAction" attribute as defined in 3GPP TS 29.514 [17] or the MPS-Action AVP as defined in 3GPP TS 29.214 [18]. + +The SMF shall report MPS for DTS invocation/revocation failure to the PCF according to clause 4.2.4.21 if requested to do so by the AF as described in 3GPP TS 29.214 [18], clause 4.4.11 or as described in 3GPP TS 29.514 [17], clause 4.2.2.12.2. + +#### 4.2.6.2.13 Sponsored Data Connectivity + +Sponsored data connectivity may be performed for service data flows associated with one or more PCC rules if the information about the sponsor, the application service provider and optionally the threshold values are provided by the AF and if the AF has not indicated to disable/not enable sponsored data connectivity as described in 3GPP TS 29.214 [18] clauses 4.4.1 and 4.4.2 or 3GPP TS 29.514 [17] clauses 4.2.2.5 and 4.2.3.5. + +The provisioning of sponsored data connectivity per PCC rule shall be performed using the PCC rule provisioning procedure as defined in clause 4.2.6.2.1. The sponsor identity shall be set using the "sponsorId" attribute within the ChargingData data type which the PCC rule refers to. The application service provider identity shall be set using the "appSvcProvId" attribute within the ChargingData data type which the PCC rule refers to. The "sponsorId" attribute and "appSvcProvId" shall be set if the "reportingLevel" attribute within the ChargingData data type which the PCC rule refers to is set to the value "SPON\_CON\_LEVEL". + +When receiving the usage thresholds from the AF, the PCF shall use the sponsor identity to generate a value of "umId" attribute of the UsageMonitoringData data type which the PCC rule refers to and request usage monitoring control for the sponsored data connectivity by following the procedures specified in clauses 4.2.6.2.5. + +When the AF disables sponsoring a service (See 3GPP TS 29.214 [18] clause 4.4.2 or 3GPP TS 29.514 [17] clause 4.2.3.5), the PCF + +- may modify the PCC rules in order to set the "reportingLevel" attribute to "SER\_ID\_LEVEL" or "RAT\_GR\_LEVEL" within the ChargingData data type which the PCC rule refers to and not include the "sponsorId" attribute and "appSvcProvId" attribute if they were included previously. +- may modify the PCC rules to update the charging key by setting the new value of the "ratingGroup" attribute within the ChargingData data type which the PCC rule refers to. + +NOTE: A specific charging key can be applied to the sponsored data connectivity for online charging. + +- shall disable the usage monitoring for the sponsored data connectivity according to clause 4.2.6.2.5 if it was enabled previously. As a result, PCF gets the accumulated usage of the sponsored data connectivity. + +#### 4.2.6.2.14 Support for PCC rule versioning + +The support of PCC rule versioning is optional. When the "RuleVersioning" feature is supported, the SMF and the PCF shall comply with the procedures specified in this clause. + +If required by operator policies, the PCF shall assign a content version for each generated PCC rule and shall include the assigned version in the "contVer" attribute included within the PccRule data structure. Upon each PCC rule + +modification, if the content version was previously assigned to a PCC rule, the PCF shall assign a new content version. In this case, all the content related to that PCC rule shall be included. If the PCF needs to modify the attribute(s) within the PCC rule, the PCF shall include the new content version within the "contVer" attribute together with all modified and unmodified applicable attribute(s) within the PccRule data structure. If the PCF only needs to modify the content of referenced policy decision data and/or condition data for one or more PCC rules, the PCF shall additionally provide the PCC rule(s) which is referring to the modified policy decision data and/or condition data. Within each PCC rule instance, the PCF shall include all unmodified applicable attribute(s) and the new assigned version in the "contVer" attribute. The content version is unique for the lifetime of the PCC rule. + +NOTE 1: The PCF will include all the content of the PCC rule in each modification of the PCC rule in order to ensure that the rule is installed with the proper information regardless of the outcome of the QoS flow procedure related to previous rule provisioning versions that are not reported yet. + +NOTE 2: The operation policies can take into account whether the AF provides the related content version information over Rx reference point (see clause 4.4.9 in 3GPP TS 29.214 [18]), or over Npcf\_PolicyAuthorization service (see clauses 4.2.2.13 and 4.2.3.13 in 3GPP TS 29.514 [17]). + +Whenever the SMF provides a PCC rule report for rules that were provisioned with a content version, the SMF shall include the "contVers" attribute defined in the RuleReport data structure for those corresponding PCC rules. In case it is required to report the content version of multiple PCC rules, the SMF shall use one instance of RuleReport data structure per PCC rule, and shall include in the "pccRuleIds" attribute only the identifier of the corresponding PCC rule. The SMF may include more than one content version in the "contVers" attribute for the same PCC rule within the corresponding RuleReport instance included in the "ruleReports" attribute (e.g. the SMF has combined multiple PCC rule versions enforcement into one QoS flow operation). In this case, the "ruleStatus" attribute shall indicate the final status of the PCC rule. + +NOTE 3: The PCF will use the content version to identify the PCC rule version that failed or succeeded when multiple provisions of the same PCC rule occur in a short period of time. If required by the AF, the PCF will inform the AF according to 3GPP TS 29.214 [18], clause 4.4.9, or according to 3GPP TS 29.514 [17], clause 4.2.5.8 about the failure or success for the media component version associated to the PCC rule version. + +#### 4.2.6.2.15 Background data transfer support + +If the PCF receives Reference Id within the service information from the AF as defined in 3GPP TS 29.514 [17] or 3GPP TS 29.214 [18] or if "EnhancedBackgroundDataTransfer" feature as defined in clause 5.8 is supported and the PCF receives the Reference Id(s) within the PDU session related subscription information from the UDR as defined in 3GPP TS 29.519 [15], the PCF shall retrieve the corresponding transfer policy from the UDR based on the Reference Id(s) as defined in 3GPP TS 29.519 [15]. The PCF shall use the retrieved transfer policy as input for policy decisions (e.g. setting the charging key equal to the charging key of the transfer policy, rule activation/deactivation time according to the time window). + +During PDU session establishment, if "EnhancedBackgroundDataTransfer" feature as defined in clause 5.8 is supported and if validation conditions (i.e. Time Window and/or Location Criteria) of the transfer policy are not satisfied then the PCF may reject corresponding SM Policy Association as defined in clause 4.2.2.2 and include in an HTTP "403 Forbidden" response message the "cause" attribute of the ProblemDetails data structure set to "VALIDATION\_CONDITION\_NOT\_MET". And based on this feedback, the SMF shall reject the PDU session setup. + +After successful PDU session establishment, if "EnhancedBackgroundDataTransfer" feature as defined in clause 5.8 is supported, PCF may request the PDU session termination if the validation conditions become not satisfied as defined in clause 4.2.3.3. Within the TerminationNotification, the PCF shall include the "cause" attribute set to "VALIDATION\_CONDITION\_NOT\_MET". + +If "BDTPolicyRenegotiation" feature as defined in clause 5.8 is supported and if the PCF retrieves the BDT policy and corresponding related information (e.g. network area information, the volume of data to be transferred per UE, etc.) within the BdtData data type, and with the "bdtpStatus" attribute within the BdtData data type set to value "INVALID", the PCF may reject the SM Policy Association establishment or defer to make the policy decisions until the PCF is informed of the result of BDT policy re-negotiation finally. If the PCF determines to reject the SM Policy Association establishment based on the invalid BDT policy, the PCF shall include in an HTTP "403 Forbidden" response message the "cause" attribute of the ProblemDetails data structure set to "INVALID\_BDT\_POLICY". If the PCF defers to make the policy decisions, then based on the result of the BDT policy renegotiation, the PCF may make the policy decisions or terminate the SM Policy Association as defined in this clause. + +#### 4.2.6.2.16 Number of supported packet filter for signalled QoS rule limitation support + +If the PCF includes the flow information within the "flowInfos" attribute and if the number of supported packet filter for signalled QoS rules within the "numOfPackFilter" attribute is received from the SMF during the PDU session establishment, the PCF shall ensure that for all the dynamic PCC rules of a PDU session, the number of packet filters contained within the "flowDescription" attribute or the "ethFlowDescription" attribute with the "packetFilterUsage" set to true does not exceed the value of the "numOfPackFilter" attribute. + +NOTE: The maximum number of packet filters sent to the UE per QoS rule is additionally limited by the access type. When the UE is camping in 5GS the number of packet filters is limited as specified in 3GPP TS 24.501[20]. + +If the PCF determines that there is a possibility to run into a restriction regarding the number of TFT packet filters that can be allocated for the PDU Session, interworking with N26 deployment is supported and "PackFiltAllocPrecedence" feature is supported, the PCF may behave as described in Annex B.3.2.0, B.3.3.0 and B.3.4.0. + +#### 4.2.6.2.17 Access traffic steering, switching and splitting support + +If both the SMF and the PCF support the "ATSSS" feature as defined in clause 5.8, the PCF may enable the control of traffic steering, switching and splitting for a detected service data flow by including MA PDU Session control information within the PCC rule. In order to do so, within the PccRule data structure the PCF: + +- may include one reference to the ChargingData data structure within the "refChgN3gData" attribute if the PCF determines that the specific charging parameters used for packets carried via Non-3GPP access. In this case, a "chgDecs" attribute containing the corresponding Charging Data policy decisions shall be included in the SmPolicyDecision data structure if it has not been provided; +- may include one reference to the UsageMonitoringData data structure within the "refUmN3gData" attribute if the PCF determines that the specific usage monitoring parameters used for packets carried via Non-3GPP access. In this case, a "umDecs" attribute containing the corresponding Usage Monitoring Data policy decisions shall be included in the SmPolicyDecision data structure if it has not been provided; +- may include the ATSSS rule application descriptor within "appDescriptor" attribute if the SDF template included in the PCC rule contains an Application Identifier in the "appId" attribute (see clause 4.2.6.2.1). The PCF may retrieve the OS Id(s) from the "UEPolicySet" resource in the UDR as described in 3GPP TS 29.519 [15] to determine, by internal configuration, the OS Application Identifier supported by the OS Id that corresponds to the application identifier included in the SDF template. If no OS Id is available in the UDR, the PCF may use the PEI to determine the OS Id supported by the UE; + +NOTE 1: If the PCF does not take into account the received PEI and/or the retrieved OSId(s) to derive the application descriptor, then the PCF can include in the PCC rule multiple application descriptors associated to multiple operating systems. + +NOTE 2: If only one UE OSId is stored in the UDR and the PCF takes it into account to derive the application descriptor, then the PCF can omit the OS Id in the application descriptor included in the PCC rule. + +- may include the ATSSS policies within the Traffic Control Data decision which the PCC rule refers to. Within the TrafficControlData data structure, based on the ATSSS capability supported for the MA PDU Session, the PCF shall include: + - the applicable access traffic steering method, "ATSSS\_LL", "MPTCP" or, if the EnATSSS\_v2 feature is supported, "MPQUIC", for the UL and DL traffic, encoded in the "steerFun" attribute; and + +NOTE: When the feature EnATSSS\_v2 is supported, the ATSSS-LL functionality is not supported together with the "REDUNDANT" steering mode. When the UE indicates it supports the ATSSS-LL functionality with any steering mode, it is implied that the UE supports the ATSSS-LL functionality with any steering mode except the "REDUNDANT" steering mode. + +- the steering rule for access traffic distribution across the 3GPP and Non-3GPP accesses encoded in a "SteeringMode" data structure within the "steerModeDI" attribute for the DL traffic and within the "steerModeUI" attribute for the UL traffic. + +The "SteeringMode" data structure shall include: + +- the steering mode value determined by the PCF within the "steerModeValue" attribute as follows: + - a. "ACTIVE\_STANDBY" indicates the traffic of a SDF is steered on one access (the Active access), when this access is available, and switched to the other access (the Standby access), when Active access becomes unavailable. When the Active access becomes available again, the SDF is switched back to this access. If the Standby access is not defined, then the SDF is only allowed on the Active access and cannot be transferred on another access. + - b. "LOAD\_BALANCING" indicates that the traffic of an SDF is split percentually between the 3GPP and Non-3GPP accesses. + - c. "SMALLEST\_DELAY" indicates that the traffic of an SDF is steered and/or switched to the access that has the smallest delay (e.g. smallest RTT). + - d. "PRIORITY\_BASED" indicates that the traffic of an SDF is steered to the high priority access until the access is determined to be congested. In this case, the traffic of the SDF is also sent to the low priority access, i.e. the SDF traffic is split over the two accesses. When the high priority access becomes unavailable, all SDF traffic is switched to the low priority access. How UE and UPF determine when a congestion occurs on an access is implementation dependent. + - e. If both the SMF and the PCF support the "EnATSSS\_v2" feature, "REDUNDANT" indicates that the traffic of an SDF may be duplicated on the 3GPP and Non-3GPP accesses. +- When the access traffic steering mode in the "steerModeValue" attribute is "ACTIVE\_STANDBY", the active access encoded within the "active" attribute, and the standby access, if defined, in the "standby" attribute; or +- When the access traffic steering mode in the "steerModeValue" attribute is "LOAD\_BALANCING", the traffic load distributed across 3GPP and Non-3GPP accesses encoded within the "3gLoad" attribute as the 3GPP access traffic weight percentage. The sum of the Non-3GPP access traffic weight percentage and the 3GPP access traffic weight percentage must be 100; or +- When the access traffic steering mode in the "steerModeValue" attribute is "PRIORITY\_BASED", the high priority access type encoded within the "prioAcc" attribute. + +If the EnATSSS\_v2 feature is supported, when the access traffic steering mode in the "steerModeValue" attribute is "REDUNDANT", the "SteeringMode" data structure may include the primary access encoded within the "primary" attribute. + +If the EnATSSS feature is supported, the PCF may provide either the steering mode indicator or the authorized threshold values for RTT and/or Packet Loss Rate within the "SteeringMode" data structure as follows: + +- a. when the access traffic steering mode within the "steerModeValue" attribute is "LOAD\_BALANCING" with fixed split percentages or "PRIORITY\_BASED" or, when the EnATSSS\_v2 feature is supported, "REDUNDANT", the PCF may provide, within the "thresValue" attribute, the authorized threshold value of RTT encoded in the "rttThres" attribute and/or the authorized threshold value of Packet Loss Rate encoded in the "plrThres" attribute. + - For "LOAD\_BALANCING" steering mode with fixed split percentages (i.e., without the "AUTO\_LOAD\_BALANCE" or "UE\_ASSISTANCE" steering mode indicator), the traffic load distributed across accesses indicated in "3gLoad" attribute shall only apply when the measurement of RTT and/or Packet Loss Rate on both accesses do not exceed the values for RTT and/or Packet Loss Rate provided respectively in the "rttThres" and/or "plrThres" attributes. When at least one measured parameter on one access exceeds the provided threshold value, the UE and UPF may stop sending traffic on this access, or may continue sending traffic on this access, but should reduce the traffic on this access and shall send the amount of reduced traffic on the other access. How UE and UPF adjust the traffic load distributed across accesses is implementation dependent. + - For "PRIORITY\_BASED" steering mode, when the measurement of RTT and/or Packet Loss Rate on the high priority access type exceeds the values for RTT and/or Packet Loss Rate provided respectively in the "rttThres" and/or "plrThres" attributes, this access may be considered as congested by the UE and the UPF. In this case, the traffic of the SDF is also sent to the low priority access. + - For "REDUNDANT" steering mode, and when the feature EnATSSS\_v2 is supported: + +- i. When a threshold value is not provided (i.e., when RTT and Packet Loss Rate are not provided), the traffic of an SDF is duplicated on both accesses if both accesses are available. If a primary access is provided, the UE and the UPF send all data packets of the SDF on the primary access and may duplicate data packets of the SDF on the other access. If a primary access is not provided to the UE and UPF, the UE and UPF send all data packets of the SDF on both accesses. + - ii. When a threshold value is provided, the duplication of the traffic of the SDF, by the UE and UPF, on both accesses shall only apply when the measurement of RTT or Packet Loss Rate on both accesses exceeds the values for RTT or Packet Loss Rate provided respectively in the "rttThres" or "plrThres" attributes. When the measured parameter (i.e., either RTT or Packet Loss Rate) exceeds the provided threshold value on one access only, the UE and UPF shall send the traffic of the SDF only over the other access. When the measured parameter (i.e., either RTT or Packet Loss Rate) does not exceed the provided threshold value on any access, the UE and UPF shall send the traffic of the SDF only over the primary access. If the primary access is not provided to the UE and UPF, UE and UPF select a primary access based on their own implementation (e.g., using the lowest RTT access or the lowest Packet Loss Rate access). If measurement results on an access are not available for a parameter, it is considered that the measured parameter for this access has not exceeded the provided threshold value. When a threshold value is provided, the "REDUNDANT" steering mode is only used for Non-GBR SDF. +- b. when the access traffic steering mode in the "steerModeValue" attribute is "LOAD\_BALANCING", the PCF may provide within the "steerModeInd" attribute: +- "AUTO\_LOAD\_BALANCE", when the UE and UPF are allowed to autonomously determine the traffic load of an SDF distributed across accesses; or + - "UE\_ASSISTANCE", when the UE is allowed to decide how to distribute the UL traffic of an SDF and the UE may inform the UPF how it decided to distribute the UL traffic. In the normal cases, although with this indicator provided, the UE shall apply the Steering Mode provided by the network. + +When the "steerModeInd" attribute is provided, the traffic load distributed across accesses indicated in "3gLoad" attribute may be ignored by the UE and UPF. + +If the value of "atsssCapab" attribute received from the SMF is "MPTCP\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL", "MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL" or "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL", the PCF shall provide a PCC Rule for non-MPTCP/non-MPQUIC traffic. To enable non-MPTCP traffic/non-MPQUIC, the PCF shall include a "match all" packet filter within the "flowInfos" attribute, the highest value within the "precedence" attribute of the PCC rule, and within the TrafficControlData data structure referred by the PCC rule, set the "steerFun" attribute to the "ATSSS\_LL", the "steerModeValue" attribute of the "steerModeUI" attribute to "ACTIVE\_STANDBY", and the "steerModeValue" attribute of the "steerModeDI" attribute to any supported steering mode except the "SMALLEST\_DELAY" and, when the EnATSSS\_v2 feature is supported, "REDUNDANT" steering mode. How PCF assigns precedence value in packet filters for MPTCP and MPQUIC traffic, when both are supported, is implementation dependant. + +If the value of "atsssCapab" received from the SMF is "MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_UL", "MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL" or "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL", the PCF shall provide a PCC rule for non-MPTCP/non-MPQUIC traffic. To enable non-MPTCP/non-MPQUIC traffic, the PCF shall include a "match all" packet filter within the "flowInfos" attribute, the highest value within the "precedence" attribute of the PCC rule, and within the TrafficControlData data structure referred by the PCC rule, set the "steerFun" attribute to the "ATSSS\_LL", the "steerModeValue" attribute of the "steerModeUI" attribute to "ACTIVE\_STANDBY", and the "steerModeValue" attribute of the "steerModeDI" attribute to any supported steering mode except, when the feature EnATSSS\_v2 is supported, the "REDUNDANT" steering mode. How PCF assigns precedence value in packet filters for MPTCP and MPQUIC traffic, when both are supported, is implementation dependant. + +If the value of "atsssCapab" received from the SMF is "MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_DLUL", "MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_DLUL" or "MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_DLUL", the PCF shall provide a PCC rule for non-MPTCP/non-MPQUIC traffic. To enable non-MPTCP/non-MPQUIC traffic, the PCF shall include a "match all" packet filter within the "flowInfos" attribute, the highest value within the "precedence" attribute of the PCC rule, and within the TrafficControlData data structure referred by the PCC rule, set the "steerFun" attribute to the "ATSSS\_LL", the "steerModeValue" attribute of the "steerModeUI" attribute and the "steerModeDI" attribute to "ACTIVE\_STANDBY". How PCF assigns precedence value in packet filters for MPTCP and MPQUIC traffic, when both are supported, is implementation dependant. + +If the value of "atsssCapab" received from the SMF is "MPTCP\_ATSSS\_LL", "MPQUIC\_ATSSS\_LL" or "MPTCP\_MPQUIC\_ATSSS\_LL", the PCF shall provide a PCC rule for non-MPTCP/non-MPQUIC traffic. To enable non-MPTCP/non-MPQUIC traffic, the PCF may include a "match all" packet filter within the "flowInfos" attribute, the highest value within the "precedence" attribute of the PCC rule, and within the TrafficControlData data structure referred by the PCC rule, set the "steerFun" attribute to the "ATSSS\_LL", the "steerModeValue" attribute of the "steerModeUI" attribute and the "steerModeDI" attribute to any supported steering mode except, when the feature EnATSSS\_v2 is supported, the "REDUNDANT" steering mode. How PCF assigns precedence value in packet filters for MPTCP and MPQUIC traffic, when both are supported, is implementation dependant. + +Upon receipt of the PCC rule with the MA PDU Session control information, the SMF shall: + +- derive the ATSSS rules to deliver to the UE for UL traffic steering as defined in 3GPP TS 29.502 [22]. When the EnATSSS feature is supported and the SMF received for UL traffic steering either the steering mode indicator within the "steerModeInd" attribute or the threshold value(s) within the "thresValue" attribute, the SMF includes the received steering mode indication or the received threshold value(s) in the derived ATSSS Rule sent to the UE as defined in 3GPP TS 29.502 [22]. When the EnATSSS\_v2 feature is supported and the SMF received the primary access within the "primary" attribute, the SMF includes the received primary access in the derived ATSSS Rule sent to the UE as defined in 3GPP TS 29.502 [22]; + +NOTE 3: The Traffic Descriptor in the ATSSS rule is generated by the SMF from the SDF template of the PCC rule. If the PccRule data structure contains the "flowInfos" attribute, the SMF uses the UL SDF filters for the generation of the IP descriptors or Non-IP descriptors. If the PccRule data structure contains the "appId" attribute, the SMF includes the application descriptors received from the PCF in the "appDescriptor" attribute of the PCC rule. + +- derive the QoS profile and provide it to the access network(s) as follows: + - for a Non-GBR QoS flow, + - a) the SMF shall provide the QoS profile to both access networks if the UE is registered over both accesses during MA PDU Session Establishment procedure; + - b) the SMF shall provide the QoS profile to the access networks over which the user plane resources are activated during MA PDU Session Modification procedure. + - for a GBR QoS flow, + - a) if the Multi Access policies of the PCC rule indicate the GBR SDF is handled only in one access (i.e. , the SMF shall provide the QoS profile to the access network indicated by the PCC rule; + - b) if the Multi Access policies of the PCC rule indicate the GBR SDF is handled in both accesses, the SMF shall decide to which access network to provide the QoS profile for the GBR SDF based on its local policy (e.g. the local policy is configured the access where the traffic is ongoing according to the Multi Access policies of the PCC rule). + - c) for a GBR QoS flow, traffic splitting is not supported because the QoS profile is provided to a single access network at a given time, and the traffic can be steered or switched as indicated by the "ACTIVE\_STANDBY" steering mode. If the SMF receives the report that the current active access is not available from the UPF, the SMF shall perform as follows: + - if the corresponding PCC rule allows the GBR QoS flow only on this access or if the corresponding PCC rule allows the GBR QoS flow on both accesses but the other access is not available, the SMF shall release the resources for the GBR QoS flow and report to the PCF about the removal of the PCC rule as defined in clause 4.2.4.15. + - if the corresponding PCC rule allows the GBR QoS flow on both accesses and the other access is available, the SMF shall try to move the GBR QoS flow to the other access. The SMF may trigger a PDU session modification procedure to provide the QoS profile to the other access and release the resources for the GBR QoS flow in the current access. + - if the QoS notification control is not enabled for the corresponding PCC rule and the other access does not accept the QoS profile, the SMF shall release the resources for the GBR QoS flow and report to the PCF about the removal of the PCC rule as defined in clause 4.2.4.15. + +- if the QoS notification control is enabled for the corresponding PCC rule, the SMF shall notify the PCF within the "qncReports" attribute that the QoS targets of the SDFs are not guaranteed. After the other access accepts the QoS profile, the SMF shall notify the PCF within the "qncReports" attribute that the QoS targets of the SDFs are guaranteed again. If the other access does not accept the QoS profile, the SMF shall delete the GBR QoS flow and report to the PCF about the removal of the PCC rule as defined in clause 4.2.4.15. +- instruct the UPF for DL access traffic steering as defined in 3GPP TS 29.244 [13]. When the EnATSSS feature is supported and the SMF received for DL traffic steering either the steering mode indicator within the "steerModeInd" attribute or the threshold value(s) within the "thresValue" attribute, the SMF includes the received steering mode indication or the received threshold value(s) in the derived the multi-access rule sent to the UPF as defined in 3GPP TS 29.244 [13]. When the EnATSSS\_v2 feature is supported and the SMF received the primary access within the "primary" attribute, the SMF includes the received primary access in the derived multi-access rule sent to the UPF as defined in 3GPP TS 29.244 [13]; +- apply charging information depending on the used access type if indicated in the PCC rule; and +- apply usage monitoring control depending on the used access type if indicated in the PCC rule. + +The PCF may update the steering rule for access traffic distribution across the 3GPP and Non-3GPP accesses for a PCC rule. In order to do so, the PCF may: + +- within the corresponding PccRule data structure, include a new reference of a Traffic Control Data decision and provide the Traffic Control Data decision if not provided yet. +- update the Traffic Control Data decision by including the appropriate attribute value(s) within the "steerFun" attribute, "steerModeDI" attribute and/or "steerModeUI" attribute. + +#### 4.2.6.2.18 Void + +#### 4.2.6.2.19 Provisioning of PCC Rules for Mission Critical Services + +##### 4.2.6.2.19.1 General + +The provision of PCC Rules corresponding to both MCS and non-MCS service shall be performed as described in clause 4.2.6.2.1 "Provisioning of PCC rules". + +When the PCF derives PCC Rules corresponding to MCS service, the ARP and 5QI shall be set as appropriate for the prioritized service, e.g. an IMS Mission Critical Service. The PCF may authorize a standardized 5QI or a standardized 5QI with a specific 5QI priority level as defined in clause 4.2.6.6.2. The PCF may also authorize a non-standardized 5QI with explicitly signalled QoS characteristics as defined in clause 4.2.6.6.3. + +At the time the Priority PDU connectivity services is invoked (i.e. Indication for support of priority PDU connectivity service and MCS Priority Level are set), the PCF shall upgrade the ARP and/or change 5QI for the PCC Rules to appropriate values as needed for MCS. The PCF shall change the ARP and/or 5QI (also associated QoS characteristics if applicable) modified for the priority PDU connectivity service to an appropriate value according to PCF decision. + +When the PCF receives an HTTP POST message as defined in clause 4.2.2.1, the PCF shall check whether any of these parameters is stored in the UDR: indication for support of priority PDU connectivity service, indication for support of MCS Priority Level. The PCF shall derive the applicable PCC rules and default QoS flow QoS based on that information. If the indication of IMS priority service support is set and the "dnn" attribute corresponds to a DNN dedicated for IMS, the PCF shall assign an ARP corresponding to MCS for the default QoS flow and for the PCC Rules corresponding to the IMS signalling QoS flow. If the "dnn" does not correspond to a DNN dedicated for IMS, the ARP shall be derived without considering IMS Signalling Priority. + +NOTE 1: Subscription data for MCS is provided to the PCF through the Nudr service. + +Once the PCF receives a notification of a change in Priority PDU connectivity services support, MCS Priority Level and/or IMS priority service support from the UDR, the PCF shall make the corresponding policy decisions (i.e. ARP and/or 5QI (also associated QoS characteristics if applicable) change) and, if applicable, shall initiate an HTTP POST message as defined in clause 4.2.3.2 to provision the modified data. + +NOTE 2: The details associated with the UDR service are specified in 3GPP TS 29.519 [15]. + +NOTE 3: The MCS Priority Level is one among other input data such as operator policy for the PCF to set the ARP. + +Whenever one or more AF sessions of an MCS service are active within the same PDU session, the PCF shall ensure that the ARP priority level of the default QoS flow is at least as high as the highest ARP priority level used by any authorized PCC rules belonging to an MCS service. If the ARP pre-emption capability is enabled for any of the authorized PCC rules belonging to an MCS service, the PCF shall also enable the ARP pre-emption capability for the default QoS Flow. + +NOTE 4: This ensures that services using dedicated QoS flows are not terminated because of a default QoS flow with a lower ARP priority level or disabled ARP pre-emption capability being dropped during mobility events. + +NOTE 5: This PCF capability does not cover interactions with services other than MCS services. + +#### 4.2.6.2.19.2 Invocation/Revocation of Priority PDU connectivity services + +When a Priority PDU connectivity services is invoked, the PCF shall: + +- Derive the corresponding PCC Rules with the ARP and 5QI (also associated QoS characteristics if applicable) set as appropriate for a prioritized service. +- Set the ARP of the default QoS flow as appropriate for a Priority PDU connectivity services under consideration of the requirement described in clause 4.2.6.2.19.1. +- Set the 5QI (also associated QoS characteristics if applicable) of the default QoS flow as appropriate for the Priority PDU connectivity services. +- Set the ARP of PCC Rules installed before the activation of the Priority PDU connectivity services to the ARP as appropriate for the Priority PDU connectivity services under the consideration of the requirements described in clause 4.2.6.2.19.1. +- Set the 5QI of the PCC Rules installed before the activation of the Priority PDU connectivity services to the 5QI (also associated QoS characteristics if applicable) as appropriate for the Priority PDU connectivity services if modification of the 5QI of the PCC Rules is required. + +When a Priority PDU connectivity services is revoked, the PCF shall: + +- Delete the PCC Rules corresponding to the Priority PDU connectivity services if they were previously provided. +- Set the ARP of the default QoS flow to the normal ARP under the consideration of the requirements described in clause 4.2.6.2.19.1. +- Set the 5QI of the default QoS flow as appropriate for PCF decision. +- Set the ARP of all active PCC Rules as appropriate for the PCF under the consideration of the requirements described in clause 4.2.6.2.19.1. +- Set the 5QI to an appropriate value according to PCF decision if modification of the 5QI of PCC Rules is required. + +NOTE: Priority PDU connectivity services can be explicitly invoked/revoked via UDR MCS user profile (Indication of Priority PDU connectivity services, MCS Priority Level). An AF for MCS Priority Service can also be used to provide Priority PDU connectivity services using network-initiated resource allocation procedures (via interaction with PCC) for originating accesses. + +The PCF shall provision the SMF with the applicable PCC Rules upon Priority PDU connectivity services activation and deactivation as described above. The provision of the QoS information applicable for the PCC Rules shall be performed as described in clause 4.5.6.2. The provision of QoS information for the default QoS flow shall be performed as described in clause 4.2.6.3. + +#### 4.2.6.2.19.3 Invocation/Revocation of IMS Mission Critical Services + +If the PCF receives service information including an MCS session indication and the service priority level from the P-CSCF or at reception of the indication that IMS priority service is active for the PDU session, the PCF shall under consideration of the requirements described in clause 4.2.6.2.19.1: + +- if required, set the ARP and 5QI (also associated QoS characteristics if applicable) of the default QoS flow as appropriate for the prioritized service; +- if required, set the ARP and 5QI (also associated QoS characteristics if applicable) of all PCC rules assigned to the IMS signalling QoS flow as appropriate for IMS Mission Critical Services; +- derive the PCC Rules corresponding to the IMS Mission Critical Service and set the ARP and 5QI (also associated QoS characteristics if applicable) of these PCC Rules based on the information received over N5/Rx. + +If the PCF detects that the P-CSCF released all the MCS session and the IMS priority service has been deactivated for the PDU session the PCF shall under consideration of the requirements described in clause 4.2.6.2.19.1: + +- delete the PCC Rules corresponding to the IMS Mission Critical Service; +- if required, set the ARP and 5QI of the default QoS flow as appropriate for the IMS Mission Critical set to inactive; +- replace the ARP and 5QI of all PCC Rules assigned to the IMS signalling QoS flow as appropriate when the IMS Mission Critical Service is inactive. + +#### 4.2.6.2.20 PCC rules authorization with preliminary service information + +If the PCF receives a request for PCC rules for a PDU session from the SMF, while no suitable authorized PCC rules are configured in the PCF or can be derived from service information provisioned by an AF, but the user is allowed to access AF session based services, the PCF may, depending e.g. on the user's subscription details or operator policy, authorise the requested QoS for a timer supervised grace period (the timer started by the PCF by the request from the SMF) to wait for AF service information. If an AF session bound to the same PDU session is ongoing and only preliminary service information was received within this AF session, the PCF shall base the authorization of the requested QoS on the preliminary service information. + +NOTE 1: This scenario can for instance be encountered for a UE terminated IMS session establishment or modification with UE initiated resource reservation, refer to 3GPP TS 29.214 [18] or 3GPP TS 29.514 [17]. If the PCF does not authorize a request for PCC rules in this scenario, the IMS session setup can fail. + +NOTE 2: During the grace period, the QoS and packet filters requested by the UE need to be authorized even if the user is not allowed to request for resources for services not known to the PCF or if the requested 5QI is not allowed for services not known to the PCF as it is not clear at this point in time whether the UE resource request belongs to an AF session or to a service not known to the PCF. + +If the preliminary service information is insufficient to construct appropriate PCC rules or no preliminary service information is available, the PCF shall provide preliminary PCC rules to authorize the UE requested QoS and packet filters. Therefore, the preliminary PCC rules shall contain wildcarded flow description or flow description derived from possible packet filters received as part of the request for PCC rules. The PCF may apply a dedicated charging key value to indicate to the charging subsystem that the charging key is preliminary and may be corrected later on. + +NOTE 3: With the dedicated charging key, the PCF instructs the charging subsystem to recalculate the applicable charge for the time when the dedicated charging key value was applied once the dedicated charging key value is replaced with some other value in a new provisioning of PCC rules. For example, if online charging applies, Session Charging with Unit Reservation (SCUR) can be used. When the charging key changes, the SMF will return initially reserved credit units and the CHF then can recalculate the consumed credit units applying the rate derived from the new other charging key value and update the user's credit accordingly. + +NOTE 4: A preliminary PCC rule is a normal PCC rule containing preliminary information. + +If the PCF receives AF service information while the timer-supervised grace period is running, the PCF shall stop the timer and may derive authorized PCC rules from this service information and update or replace the preliminary PCC + +rules that were previously provided for the UE requested QoS and packet filters, for instance by choosing service specific QoS parameters and charging keys. + +NOTE 5: The dedicated preliminary charging key value that was previously provided by the PCF instructs the charging subsystem to recalculate the applicable charge when the new service specific charging key is provided. The recalculation covers the time when the previous dedicated charging key value was active. The new service specific charging key is applied from that time onwards. + +If the timer expires and the PCF has not received any AF service information, the PCF should apply the policy for services not known to the PCF and may downgrade or revoke the authorization for the preliminary PCC rules (previously provided for the UE requested QoS and packet filters) in accordance with the policy for services not known to the PCF. The PCF should adjust the charging keys within the PCC rules and should downgrade the authorized QoS to the allowed value for the services not known to the PCF, if required. + +#### 4.2.6.2.21 Policy Control for L4S + +When the "L4S" feature is supported, and the PCF is configured to provide an explicit indicator to the SMF to enable ECN marking for L4S, this procedure is used by the PCF to explicitly indicate that the UL and/or DL traffic identified by SDF template supports ECN marking for L4S support. + +If the AF provides an explicit indication that the UL and/or DL service data flow supports ECN marking for L4S as defined in 3GPP TS 29.514 [17], or the PCF determines, based on locally configured policies, that the UL and/or DL traffic of the SDF template support ECN marking for L4S, then the PCF may explicitly or implicitly (based on local configuration), indicate to the SMF to enable ECN marking for L4S. + +The PCF shall provide to the SMF the explicit indication of support of ECN marking for L4S by installing PCC rules and the implicit indication by installing or activating PCC rule(s). + +The provisioning of the explicit indication of ECN marking for L4S support per PCC rule shall be performed using the PCC rule provisioning procedure as defined in clause 4.2.6.2.1 and shall be provided using the "l4sInd" attribute within the TrafficControlData the PCC rule refers to. The "l4sInd" attribute shall be set to "UL", "DL" or "UL\_DL" to indicate respectively whether the UL, the DL, or both, UL and DL, service data flow(s) of the SDF template of the PCC rule support ECN marking for L4S. + +When the SMF receives the indication that ECN marking for L4S is supported for the UL and/or DL traffic of the PCC rule, may decide, based on operator's network configuration and policies, to enable for the QoS flow the ECN marking for L4S in either the NG-RAN, as specified in 3GPP TS 29.502 [22], or in the PSA UPF as specified in 3GPP TS 29.244 [13]. + +NOTE: When the ECN marking for L4S is performed by UPF, the NG-RAN is instructed to perform congestion information monitoring, as specified in 3GPP TS 29.502 [22]. + +In case of inter NG-RAN UE mobility, if the ECN marking for L4S has been enabled on source NG-RAN, but the target NG-RAN does not support ECN marking for L4S, then the SMF may enable ECN marking for L4S in PSA UPF. + +When serving PSA UPF or NG-RAN is changed e.g., due to inter-NG-RAN handover or PSA UPF relocation, target NG-RAN and PSA UPF should keep the current congestion exposure method. However, if not available (e.g., ECN marking for L4S is not used anymore in 5GS), the PCF provisioned the "L4S\_SUPP" policy control request trigger, the SMF may notify the PCF about ECN marking not supported. At a subsequent PSA UPF or NG-RAN change, the SMF may determine the target NG-RAN and/or PSA UPF may support the congestion exposure method again and may notify the PCF about ECN marking is supported again. In these cases, the SMF shall invoke the Npcf\_SMPolicyControl\_Update procedure and shall include within the SmPolicyUpdateContextData, including the "L4S\_SUPP" within "repPolicyCtrlReqTriggers" attribute and the "l4sReports" attribute. In each L4sSupportInfo data structure, the SMF shall include the indication that ECN marking for L4S is not available or is available again within the "notifType" attribute and affected PCC rule identifiers within the "refPccRuleIds" attribute. The PCF may notify the affected AF(s) as specified 3GPP TS 29.514 [17]. + +#### 4.2.6.2.22 UL/DL policy control based on Round-Trip latency requirements + +If the "RTLatency" feature is supported, the Round-Trip (RT) latency indication indicates the service data flow needs to meet the RT latency requirement of the service may be provided by the AF, which is twice the single direction delay requirement between the UE and the PSA UPF described by the received QoS reference parameter or the received individual QoS parameter. + +If the AF provided the RT latency indication as defined in 3GPP TS 29.514 [17], the PCF may split the RT latency requirement, i.e. the twice of the single direction delay, into two PDBs of two PCC rules, one for UL service data flow and the other for DL service data flow. The two PDBs can be unequal, but their sum shall not exceed the RT latency requirement. + +NOTE: RT latency requirement may also be locally configured in the PCF together with delay requirement. + +To enable RT latency tracking, the PCF shall generate associated QoS monitoring policies for the two correlated PCC rules as described in clause 4.2.3.25. The uplink and downlink delay for the two PCC rules shall be tracked by PCF independently with same reporting period. When the QoS monitoring results are reported to PCF, the PCF may update the two PCC rules to adjust the UL PDB and DL PDB. + +#### 4.2.6.2.23 Policy Decision for AF requested QoS for a UE or group of UEs not identified by a UE address + +When the AF requested QoS for a UE or group UE(s), the requested QoS data may be either provisioned by the AF/NEF to the TSCTSCF, and later to the PCF for the related active PDU sessions, as specified in 3GPP TS 29.565 [53] and 3GPP TS 29.514 [17], or stored by the AF/NEF at the UDR and later retrieved by the PCF for the related active PDU sessions, as defined in 3GPP TS 29.519 [15]. + +When the PCF needs to make Policy Decision(s) and derive PCC Rule(s) for a PDU session corresponding to the concerned UE or group of UE(s), the PCF shall take into consideration the received AF requested QoS data, if applicable, and may provide to the SMF the policy control triggers corresponding to the AF subscribed event(s) as defined in clause 4.2.6.4, or activate/modify/remove PCC rule(s) as defined in clause 4.2.3.2. + +When the SMF notifies the PCF about a met policy control request trigger corresponding to the AF subscribed event(s), the PCF may notify either the TSCTSF or the AF/NEF, as defined in 3GPP TS 29.514 [17], based on whether the requested QoS data was provisioned via the TSCTSF or the UDR. + +#### 4.2.6.3 Session Rules + +##### 4.2.6.3.1 Overview + +The PCF may perform operations on session rules. The impacted rules shall be included in the "sessRules" map attribute within the SmPolicyDecision data structure with the "sessRuleId" as a key. For installing or modifying a session rule, the corresponding SessionRule data instance shall be provided as the map entry value. For removing a session rule, the map entry value shall be set to NULL. + +In order to install a new session rule, the PCF shall further set other attributes within the SessionRule data structure as follows: + +- if the "subsSessAmbr" has been previously received by the PCF, it shall include the authorized Session-AMBR within the "authSessAmbr" attribute; +- when the "subsDefQos" has been previously received by the PCF, it shall include the authorized default QoS within the "authDefQos" attribute using the procedure as defined in clause 4.2.6.3.3; +- it may include one reference to the UsageMonitoringData data structure within the "refUmData" attribute. In this case, a "umDecs" attribute containing the corresponding Usage Monitoring data policy decisions shall be included in SmPolicyDecision data structure if it has not been previously provided; +- if the "ATSSS" feature is supported, it may include one reference to the UsageMonitoringData data structure to apply for the Non-3GPP access within the "refUmN3gData" attribute. In this case, a "umDecs" attribute containing the corresponding Usage Monitoring data policy decisions shall be included in SmPolicyDecision data structure if it has not been previously provided; and +- it may include one reference to the ConditionData data structure within the "refCondData" attribute. In this case, a "conds" attribute containing the corresponding Condition Data decision shall be included in SmPolicyDecision data structure if it has not been previously provided. + +In order to modify an existing session rule, the PCF shall further set other attributes within the SessionRule data structure as follows: + +- If the PCF needs to modify the attribute(s) within a session rule, the PCF shall include the modified attribute(s) with the new value(s) within the SessionRule data instance. Previously supplied attributes not supplied in the modified PCC rule instance shall remain valid. +- If the PCF only needs to modify the content of referenced policy decision data (e.g. UsageMonitoringData, etc.) and/or condition data for one or more session rules, the PCF shall, within the SmPolicyDecision data structure, include the corresponding policy decision data and/or condition data within the corresponding map attributes (e.g. include the usage monitoring data decision within the "umDecs" attribute). + +The PCF may combine multiple of the above session rule operations in a single message, but the PCF shall ensure that one and only one session rule is enforced in the SMF at a certain point in time. + +NOTE: Either there is always an unconditional session rule provisioned in the NF service consumer (SMF), or there is always a conditioned session rule applicable in the NF service consumer (SMF). + +#### 4.2.6.3.2 Conditioned Session rule + +##### 4.2.6.3.2.1 General + +Up to four conditioned session rules (i.e. authorized Session-AMBR and authorized default QoS) may be provisioned by the PCF. In order to provision a session rule with conditional data, the PCF shall provision a session rule as defined in clause 4.2.6.3.1 and include within its "refCondData" attribute the corresponding ConditionData's "condId" attribute value. The PCF shall also ensure that the referenced ConditionData instance is included in the "conds" map within the SmPolicyDecision data structure following the procedures defined in clause 4.2.6.1 and that the referenced usage monitoring data is the same for all the provisioned conditioned and non-conditioned session rule(s). + +Within the ConditionData instance, the PCF shall include the activation time within the "activationTime" attribute for the time conditioned authorized Session-AMBR and authorized default QoS (deactivation time does not apply for a session rule). If the "AccessTypeCondition" feature as defined in clause 5.8 is supported, the PCF may include for the access type conditioned session rule the access type within the "accessType" attribute and RAT type within the "ratType" attribute if applicable for the access type conditioned authorized Session-AMBR. + +NOTE 1: The SMF retains remaining time conditioned session rules that have an execution time in the future. + +NOTE 2: Time condition and access type condition can both apply to authorize the Session-AMBR within a session rule. + +The PCF shall ensure that a time conditioned session rule and a session rule without time condition for the same session differ only in the authorized session-AMBR and authorized default QoS properties. + +When the SMF detects that the referenced usage monitoring data of the enforced session rule is not the same for all the provisioned session rule(s) the SMF shall report the session rule error for the not enforced session rule(s) as defined in clauses 4.2.3.20 and 4.2.4.21, and shall set the "failureCode" attribute to "INCORRECT\_UM". + +If the SMF receives the conditioned session rule, when the condition indicated in the related attribute(s) within the Condition Data decision (e.g. at the time indicated in the "activationTime" attribute) is met, the SMF shall perform the conditional policy without interaction with the PCF. If the Condition Data decision includes more than one type of conditions and all the types of conditions are met, the SMF shall perform the conditional policy. + +If time conditioned session rule(s) to change the non-conditioned session rule are received by the SMF and the earliest Activation Time is in the past, then the SMF shall immediately enforce the most recent time conditioned instance that is not in the future. + +The PCF may modify a currently installed session rule, including setting, modifying or deleting its condition(s) as follows: + +- 1) When modifying a session rule by setting the condition(s), the PCF shall update the session rule by including the corresponding ConditionData's "condId" attribute value within the "refCondData" attribute and within the SmPolicyDecision data structure include the ConditionData instance within the "conds" attribute if not provisioned yet. +- 2) When modifying a session rule by modifying the condition(s): + +- the PCF may update the session rule by replacing the existing ConditionData instance's "condId" attribute value within the "refCondData" attribute with a new one and within the SmPolicyDecision data structure include the new ConditionData instance within the "conds" attribute if not provisioned yet; or +- the PCF may update the condition data decision which the session rule refers to by updating the corresponding ConditionData instance as defined in clause 4.2.6.1. The PCF may update the value of the condition within the related attribute (e.g. the value of the existing deferred activation time within the "activationTime" attribute). + +3) When modifying a session rule by deleting the condition(s): + +- the PCF shall delete the reference to the ConditionData instance within the session rule by updating session rule with the "refCondData" attribute set to NULL; and +- the PCF may delete the condition data decision which the session rule refers to as defined in clause 4.2.6.1 if no other session rules are referring to the condition data decision. + +To delete a conditioned session rule, the PCF shall perform the deletion of session rule as defined in clause 4.2.6.3.1. The "ueTimeZone" attribute, if available, may be used by the PCF to derive the value for the "activationTime" attribute. + +NOTE 3: Conditioned Session-AMBR and default QoS change helps reducing the signalling load over N7. However, the Session-AMBR and default QoS change needs to be communicated to the UE. Consequently a simultaneous change of the Session-AMBR and default QoS for many UE(s) may introduce a signalling storm in the 5GC (e.g. over N1/N2/N4/N11). The PCF can avoid this simultaneous change of the Session-AMBR and default QoS (e.g. spread the time conditioned change over time for many UEs). + +NOTE 4: For services that depend on specific Session-AMBR and/or default QoS change (e.g. an MPS session), the PCF is responsible to ensure that no conditioned session rules interfere with the service (e.g., ensure proper MPS operation by removing time conditioned settings that would later impact MPS). + +#### 4.2.6.3.2.2 Time conditioned authorized Session-AMBR + +The procedures in clause 4.2.6.3.2.1 apply with clarifications in the present clause. + +Each instance of the session rule shall include authorized Session-AMBR within the "authSessAmbr" attribute. + +If the "VPLMN-QoS-Control" feature is supported and the PCF receives the session AMBR constraints from the SMF, the PCF shall ensure that the authorized session AMBR value within each instance of the session rule does not exceed the session AMBR supported by the VPLMN, if applicable. + +The SMF shall, after applying a time conditioned instruction to change the authorized AMBR, apply the corresponding procedures towards to the access network, the UE and the UPF for the enforcement of the AMBR per PDU session. + +#### 4.2.6.3.2.3 Time conditioned authorized default QoS + +The procedures in clause 4.2.6.3.2.1 apply with clarifications in the present clause. + +Each instance of the session rule shall include authorized default QoS within the "authDefQos" attribute. + +If the "VPLMN-QoS-Control" feature is supported and the PCF receives the default QoS constraints from the SMF, the PCF shall ensure that the authorized default QoS containing 5QI, ARP and, if the feature "VPLMN-5QIPrioLevel" is supported, 5qiPriorityLevel (when the required 5QI Priority Level is different from the standardized Default Priority Level value in the QoS characteristics Table 5.7.4-1 in 3GPP TS 23.501 [2]), values within each instance of the session rule is supported by the VPLMN, if applicable. + +The SMF shall, after applying a time conditioned instruction to change the authorized default QoS, apply the corresponding procedures towards to the access network, the UE and the UPF for the enforcement of the authorized default QoS. All PCC rule(s) with the "defQosFlowIndication" attribute set to true shall remain bound to the default QoS flow. For any other PCC rule previously bound to the default QoS flow, SMF shall then perform the QoS flow binding according to clause 6.4 in 3GPP TS 29.513 [7]. + +#### 4.2.6.3.2.4 Access type conditioned authorized Session-AMBR + +The SMF shall enforce the Session-AMBR values corresponding to the session rule whose referred ConditionData instance contains the "accessType" attribute and "ratType" attribute matching the current access type and RAT type of the UE for the given PDU session. If the "VPLMN-QoS-Control" feature is supported and the PCF receives the session AMBR constraints from the SMF, the PCF shall ensure that the authorized session AMBR value within each instance of the session rule does not exceed the session AMBR supported by the VPLMN, if applicable. + +The PCF shall ensure that an access type conditioned session rule and a session rule without any access type condition for the same session differ only in the authorized session-AMBR property. If more than one access type conditioned session rules are provisioned, and if there is no session rule without any access type condition provisioned in the SMF, the PCF shall ensure that any two access type conditioned session rules for the same session differ only in the authorized session-AMBR property. + +NOTE: Access type conditions are only applicable to the authorized session-AMBR. + +If there is a session rule whose authorized Session-AMBR does not depend on any access type condition provided and there is also a session rule with an access type conditioned authorized Session-AMBR provided, then the access type conditioned session rule where the conditions specified within the Condition Data decision are met shall be enforced. Otherwise, the session rule with the authorized Session-AMBR without any access type condition shall be enforced. + +If conditions from multiple access type conditioned the session rule with authorized Session-AMBR are met at the same time then the session rule related to the most strict matching condition is enforced, e.g. Policy1 specifies access type only and Policy2 specifies access type (with the value same as in Policy1) and an RAT Type, both, then the Policy2 shall be enforced when the UE's current access type and RAT type matches with the condition specified by Policy2. + +If conditions from multiple access type conditioned the session rule with authorized Session-AMBR are met at the same time and all of these policies are equally applicable, e.g. Policy1 specifies access type only and Policy2 specifies RAT type only and if the UE's current access type matches with Policy1 and the UE's current RAT type matches with Policy2, then the SMF should apply the Session-AMBR with Policy2. + +An access type conditioned session rule does not apply to a MA PDU session. When the "ATSSS" feature is supported, and the PDU session is a MA PDU session, the PCF shall not provide to the SMF access type conditioned session rules. If access type conditioned session rules are provisioned in the SMF for a MA PDU session (e.g. because of error in the PCF or EPS to 5GS handover) they shall be ignored. + +#### 4.2.6.3.3 Provisioning of authorized default QoS + +The PCF can provide the authorized default QoS for a session rule to the SMF. The provisioning of authorized default QoS for a session rule shall be performed using the session rule provisioning procedure as defined in clause 4.2.6.3.1. The authorized default QoS shall be encoded using an AuthorizedDefaultQos data structure. + +In order to provision authorized default QoS for a new session rule, the PCF shall include the assigned 5QI value within the "5qi" attribute and the assigned ARP value within the "arp" attribute in the AuthorizedDefaultQos data structure. The PCF may include the "priorityLevel" attribute in the AuthorizedDefaultQos data structure to authorize the particular 5QI priority level to override the default value for a standardized or pre-configured 5QI. The PCF may include a "QosCharacteristics" entry in the "qosChars" attribute map to provide explicitly signalled QoS characteristics associated with a 5QI that is neither standardized nor pre-configured. When the authorized default QoS applies to explicitly signalled QoS Characteristics, it shall be provisioned as defined in clause 4.2.6.6.3. For 5QI of GBR type or delay critical GBR type, the PCF shall additionally include max bandwidth in uplink within the "maxbrUI" attribute and/or max bandwidth in downlink within the "maxbrDI" attribute, the guaranteed bandwidth in uplink within the "gbrUI" attribute and/or the guaranteed bandwidth in downlink within the "gbrDI" attribute and may include the particular averaging window within the "averWindow" attribute and/or particular maximum data burst volume within the "maxDataBurstVol" or "extMaxDataBurstVol" (if supported, see clause 4.2.2.1) attribute to override the default values for a standardized or pre-configured 5QI. + +In order to modify authorized default QoS for an existing session rule, the PCF shall include the modified attribute(s) with the new value(s) within the AuthorizedDefaultQos data structure and provision a new QoS Characteristics if applicable. Previously supplied attributes not supplied in the AuthorizedDefaultQos data structure shall remain valid. + +#### 4.2.6.3.4 Access traffic steering, switching and splitting support + +If both the SMF and the PCF support the "ATSSS" feature, the PCF may enable the control of the PDU session level Usage Monitoring information depending on what access type is used to carry service data flows. + +When the PCF determines that at PDU session level different usage monitoring data shall be defined for the 3GPP and the Non-3GPP access, the PCF shall include within the SessionRule data structure one reference to the UsageMonitoringData policy decision to apply for the Non-3GPP access within the "refUmN3gData" attribute, and a "umDecs" attribute containing the corresponding Usage Monitoring Data policy decisions if it has not been previously provided. When the "refUmN3gData" is omitted, the attribute "refUmData" contains the reference to the UsageMonitoringData policy decision to apply for both, 3GPP and Non-3GPP, accesses. + +**NOTE:** To ensure that the traffic of a set of service data flows is excluded for both, the 3GPP access and Non-3GPP access, from the PDU session level usage monitoring, the "exUsagePccRuleIds" attribute is set to the same value within the Usage Monitoring Control decision referred by the "refUmN3gData" attribute and within the Usage Monitoring Control decision referred by the "refUmData" attribute. + +#### 4.2.6.3.5 Usage Monitoring Control + +Usage monitoring may be performed for all the traffic of a PDU session in the SMF or for all the traffic of a PDU session excluding the traffic of a service data flow or a group of service data flows. + +The provisioning of usage monitoring control for the traffic of a PDU session shall be performed using the session rule provisioning procedure as defined in clause 4.2.6.3.1. When the traffic of a service data flow or a group of service data flows is excluded from the traffic of the PDU session, the UsageMonitoringData policy decision referred within the "refUmData" attribute, and/or the UsageMonitoringData policy decision referred within the "refUmN3gData" attribute when the "ATSSS" feature is supported, shall include the "exUsagePccRuleIds" attribute as defined in clause 4.2.6.5.3.1. + +Usage monitoring for all the session rules (conditioned and non-conditioned) shall refer to the same UsageMonitoringData policy decision(s), i.e., the monitoring key that applies to all the traffic of a PDU session, or to all the traffic of a PDU session except certain service data flow(s), shall not change because of the activation of a conditioned session rule. + +#### 4.2.6.4 Policy control request triggers + +The PCF may provide one or several policy control request trigger(s) to the SMF. In order to do so, the PCF shall include one or several policy control request trigger(s) within the "policyCtrlReqTriggers" attribute within the SmPolicyDecision data structure. + +During the lifetime of the PDU session, the PCF may update or remove the policy control request triggers. In order to update the policy control request trigger, the PCF shall provide the new complete list of applicable policy control request triggers by including one or several policy control request trigger(s) within the "policyCtrlReqTriggers" attribute within the SmPolicyDecision data structure. + +The PCF may remove all previously provided policy control request triggers by providing a "policyCtrlReqTriggers" attribute set to the value NULL. Upon reception of a policy control request trigger with this value, the SMF shall not inform PCF of any trigger except for those triggers that are always reported and do not require provisioning from the PCF. + +Whenever the PCF provisions one or several policy control request trigger(s) by using an HTTP POST message as defined in clause 4.2.3.2, unless otherwise specified in a policy control request trigger's value definition, the SMF shall send the corresponding currently applicable values (e.g. access type, RAT type, user location information, etc.) to the PCF within the UeCampingRep data structure in the response of the HTTP POST message, and in this case, the "repPolicyCtrlReqTriggers" attribute shall not be included. + +#### 4.2.6.5 Encoding of the request of information reporting + +##### 4.2.6.5.1 Request of Access Network Charging Identifier + +When the Access Network Charging Identifier is unknown for an AF session to the PCF, the PCF may request the SMF to provide the Access Network Charging Identifier associated to the dynamic PCC rules. To do so, the PCF shall within + +SmPolicyDecision data structure provide the "policyCtrlReqTriggers" attribute with the value "AN\_CH\_COR" if the policy control request trigger is not previously set and the "lastReqRuleData" attribute. For the RequestedRuleData instance, the PCF shall include the CH\_ID within the "reqData" attribute and reference of the PCC rule within the "refPccRuleIds" attribute. + +The PCF shall interpret that the Access Network Charging Identifier is known when the PCF receives an "accNetChId" attribute with the "sessionChScope" attribute included and set to true as defined in clause 4.2.2.11 and 4.2.4.13. + +#### 4.2.6.5.2 RAN NAS Cause Support + +When the RAN-NAS-Cause feature is supported, the PCF may request the SMF to inform it of the result of PCC rule(s) removal, when the PCF removes PCC rule(s). In order to do so, the PCF shall additionally include the "policyCtrlReqTriggers" attribute containing the "RES\_RELEASE" value if this policy control request trigger was not previously set, and the "lastReqRuleData" attribute. Within the RequestedRuleData instance, the PCF shall include the "RES\_RELEASE" value within the "reqData" attribute and reference the removed PCC rule within the "refPccRuleIds" attribute. + +NOTE: This is done to allow the PCF to notify the AF when there is an abnormal termination of the QoS flow. The PCF does not have to retry the removal of these PCC Rules. + +#### 4.2.6.5.3 Provisioning of the Usage Monitoring Control Policy + +##### 4.2.6.5.3.1 General + +The PCF may indicate the need to apply monitoring control of the accumulated usage of network resources on a per PDU session basis. Usage is defined as volume or time of user plane traffic. Monitoring for traffic volume and traffic time can be performed in parallel. The data collection for usage monitoring control shall be performed per monitoring key, which may apply to a single service data flow, a set of service data flows or all the traffic in a PDU session. If usage monitoring at PDU session level is enabled, the PCF may request the SMF to exclude a single service data flow or a set of service data flows from usage monitoring at PDU session level. + +During PDU session establishment, the PCF may receive information from the UDR about total the allowed usage per DNN / S-NSSAI combination and UE, i.e. the overall amount of allowed traffic volume and/or time of usage that are to be monitored per DNN / S-NSSAI combination and UE and/or the total allowed usage for Monitoring key(s) per DNN / S-NSSAI combination and UE. + +NOTE 1: It depends on the implementation of UDR whether to provide the total allowed usage per DNN / S-NSSAI combination and UE to different PCFs if these different PCFs are serving PDU sessions with the same value of DNN / S-NSSAI combination and UE. + +If the SMF supports the UMC feature, the PCF may request usage monitoring control for a PDU session. If at that time the PCF has not provided "US\_RE" policy control request trigger to the SMF, the PCF shall include the "policyCtrlReqTriggers" attribute with the value "US\_RE" and provide it to the SMF as defined in clause 4.2.6.4. The PCF shall not remove the "US\_RE" policy control request trigger while usage monitoring is still active in the SMF. + +At PDU session establishment and modification, the PCF may provide to the SMF, for each usage monitoring control instance, the applicable threshold(s), i.e. volume threshold, time threshold or both volume threshold and time threshold. To provide the initial threshold(s) for each usage monitoring control instance, the PCF shall include these threshold(s) within the "umDecs" attribute within the SmPolicyDecision data structure. + +The PCF may provide a monitoring time to the SMF for the usage monitoring control instance(s) and optionally specify a subsequent threshold value for the usage after the monitoring time. + +NOTE 2: The PCF can provide only one threshold or one threshold and one subsequent threshold in the case that monitoring time is provided. When only the threshold is provided, the UPF resets the usage threshold to the remaining value of the threshold at the monitoring time; when the threshold and subsequent threshold are provided, the UPF resets the usage threshold to the value of the subsequent threshold at the monitoring time as defined in 3GPP 29.244 [13]. + +Threshold levels may be defined for: + +- the total volume only; or + +- the uplink volume only; or +- the downlink volume only; or +- the uplink and downlink volume; and/or +- the time. + +Threshold levels, monitoring time, if applicable, and inactive time, if applicable, for each usage monitoring control instance may be provisioned within an entry of the "umDecs" attribute as follows: + +- the total volume threshold, if applicable, within the "volumeThreshold" attribute; +- the uplink volume threshold, if applicable, within the "volumeThresholdUplink" attribute; +- the downlink volume threshold, if applicable, within the "volumeThresholdDownlink" attribute; +- the time threshold, if applicable, within the "timeThreshold" attribute; +- the total volume threshold after the monitoring time, if applicable, within the "nextVolThreshold" attribute; +- the uplink volume threshold after the monitoring time, if applicable, within the "nextVolThresholdUplink" attribute; +- the downlink volume threshold after the monitoring time, if applicable, within the "nextVolThresholdDownlink" attribute; +- the time threshold after the monitoring time, if applicable, within the "nextTimeThreshold" attribute; +- the monitoring time, if applicable, within the "monitoringTime" attribute; +- the inactive time, if applicable, within the "inactivityTime" attribute. + +If the SMF reports usage before the monitoring time is reached, the monitoring time is not retained by the SMF. Therefore, the PCF may again provide in the response a monitoring time and optionally the subsequent threshold value(s) for the usage after the monitoring time. + +The "inactivityTime" attribute represents the time interval after which the time measurement shall stop for the Monitoring Key, if no packets belonging to the corresponding Monitoring Key are received. Time measurement shall resume again on receipt of a further packet belonging to the Monitoring Key. Time measurement for a Monitoring key shall also be stopped when time based usage monitoring is disabled, if this happens before the Inactivity Detection Time is reached. If an "inactivityTime" attribute with value of zero is provided, or if no "inactivityTime" attribute is present within the usage monitoring control instance provided by the PCF, the time measurement shall be performed continuously from the point the first packet is received matching the applicable Monitoring Key is received and until time based usage monitoring is disabled. + +If the usage monitoring control instance applies to the PDU session level, the PCF shall include the reference to the Usage Monitoring Data decision within the "refUmData" attribute of the related session rule. + +If the usage monitoring control instance applies to a service data flow or a group of service data flows, the PCF shall include the reference to the Usage Monitoring Data decision within the "refUmData" attribute of the related PCC rule(s). + +The PCF may provide one usage monitoring control instance applicable at PDU session level and one or more usage monitoring control instances applicable at PCC Rule(s) level. + +If the PDU session level usage monitoring is enabled and service data flow(s) need to be excluded from this PDU session level usage monitoring, the PCF shall include the corresponding PCC rule identifier(s) within the "exUsagePccRuleIds" attribute of the UsageMonitoringData instance of PDU session level usage monitoring. If the exclusion is enabled, the PCF may disable the exclusion again for service data flow(s) by removing the corresponding PCC rule identifier(s) from "exUsagePccRuleIds" attribute. + +The PCF may provide new volume threshold(s) and/or a new time threshold to the SMF. The new threshold value(s) override the existing value(s) in the SMF. + +When the SMF receives above the usage monitoring control request from the PCF, the SMF shall initiate the PFCP Session Establishment procedure as defined in clause 7.5.2, or the PFCP Session Modification procedure, as defined in clause 7.5.4 of 3GPP TS 29.244 [13], to request the UPF to perform the usage monitoring control. + +If the reset time of the usage monitoring related information (see clause 5.4.2.7 of 3GPP TS 29.519 [15]) is reached, the PCF shall reset the remaining allowed usage to the value(s) indicated in the usage monitoring related information and shall then interact with the SMF to undo any previously applied policy decisions related to remaining allowed usage of zero (or below zero). + +NOTE 2: The PCF can also update the related usage monitoring information in the UDR as defined in 3GPP TS 29.519 [15] according to the performed reset action. + +#### 4.2.6.5.3.2 Disabling Usage Monitoring + +After usage monitoring is enabled, the PCF may explicitly disable usage monitoring as a result of receiving an SM Policy association update from the SMF which is not related to reporting usage, but to other external triggers (e.g., receiving an AF request, subscriber profile update), or a PCF internal trigger. When the PCF disables usage monitoring, the SMF shall report the accumulated usage which has occurred while usage monitoring was enabled since the last report. + +To disable usage monitoring for a monitoring key, the PCF shall provide either the SMF with the corresponding applicable attributes of the usage monitoring control instance containing a NULL value (e.g. the previous provided "volumeThreshold" is set to NULL), or: + +- for dynamic PCC rule(s) or session rule(s), remove the reference to the corresponding usage monitoring control instance from all the dynamic PCC rule(s) or session rule(s) referencing it; + +NOTE: The PCF could keep the UsageMonitoringData policy decision valid in the SMF. + +- for predefined PCC rule(s), remove the UsageMonitoringData policy decision referred from all the activated predefined PCC rule(s). + +When the PCF disables usage monitoring for usage monitoring key(s) via a Npcf\_SMPolicyControl\_UpdateNotify or a Npcf\_SMPolicyControl\_Update service operation, the SMF shall trigger a new Npcf\_SMPolicyControl\_Update service operation using the procedures specified in clause 4.2.4.10 to report accumulated usage for the disabled usage monitoring key(s). + +#### 4.2.6.5.3.3 PCF Requested Usage Report + +When usage monitoring is enabled, the PCF may request the SMF to report the accumulated usage for one or more enabled usage monitoring control instance(s) regardless of whether associated usage threshold(s) have been reached or not. In order to do so, the PCF shall include the "lastReqUsageData" attribute containing one or more reference(s) to usage monitoring data decision(s) within the "refUmIds" attribute or the "allUmIds" attribute set to true in an HTTP POST request or in the response of an HTTP POST request from the SMF. The PCF shall require the SMF to report accumulated usage for one or more enabled usage monitoring control instance(s) only in a response to received HTTP POST request from the SMF when the SMF has not provided accumulated usage in this HTTP POST request for the same usage monitoring control instance(s). + +#### 4.2.6.5.4 Request for Access Network Information + +When the NetLoc feature is supported, if the AF requests the PCF to report the access network information as described in clauses 4.2.2, 4.2.3 or 4.2.4 of 3GPP TS 29.514 [17] or in clauses 4.1 and 4.2 of 3GPP TS 29.214 [18], the PCF shall perform the PCC rule provisioning procedure as defined in clause 4.2.6.2.1 and additionally provide the requested access network information indication (e.g. user location and/or user timezone information) to the SMF as follows: + +- it shall include the "lastReqRuleData" attribute to contain the "reqData" attribute with the value(s) MS\_TIME\_ZONE and/or USER\_LOC\_INFO and the "refPccRuleIds" attribute to contain the related installed/modified/removed PCC rule identifier(s). +- it shall provide the AN\_INFO policy control request rigger within the "policyCtrlReqTriggers" attribute (if not yet set). + +For those PCC Rule(s) based on preliminary service information as described in 3GPP TS 29.514 [17] or in 3GPP TS 29.214 [18], the PCF may assign the 5QI and ARP of the default QoS flow to avoid signalling to the UE. These PCC Rules shall not include the "packetFilterUsage" attribute set to true within the "flowInfos" attribute. + +For those PCC Rule(s) based on AF signalling as described in 3GPP TS 29.514 [17] or in 3GPP TS 29.214 [18], the PCF may use 5QI and ARP for AF signalling to avoid signalling to the UE. These PCC Rules shall not include the "packetFilterUsage" attribute set to true within the "flowInfos" attribute. + +NOTE: Similarly, for predefined PCC rules based on AF signalling, these PCC Rule(s) could be defined with the 5QI and ARP for AF signalling, and cannot include packet filter usage information. + +#### 4.2.6.5.5 Request for the successful resource allocation notification + +The PCF may request the SMF to confirm that the resources associated to a PCC rule are successfully allocated. To do so, the PCF shall provide within the "policyCtrlReqTriggers" attribute of the SmPolicyDecision data structure the value "SUCC\_RES\_ALLO ", if this policy control request trigger was not previously set, and provide the "lastReqRuleData" attribute as well. For the associated RequestedRuleData instance, the PCF shall include the value "SUCC\_RES\_ALLO" within the "reqData" attribute and the reference to the PCC rule within the "refPccRuleIds" attribute. + +#### 4.2.6.5.6 Provisioning of Presence Reporting Area Information + +When the PRA or ePRA feature is supported, the PCF may determine during the lifetime of the PDU session whether reports on the change of UE presence in Presence Reporting Area(s) are desired for this PDU session based on the subscriber's profile configuration. If such reporting is desired for a PDU session, the PCF shall provide the "praInfos" attribute within the SmPolicyDecision data structure. Within each associated PresenceInfoRm data structure, the PCF shall include the Presence Reporting Area Identifier within the "prald" attribute, and, for a UE-dedicated Presence Reporting Area, the list of elements composing the presence reporting area within the "trackingAreaList" attribute, the "ecgiList" attribute, the "ncgiList" attribute, the "globaleNbIdList" attribute and/or the "globalRanNodeIdList" attribute. The PCF shall also activate the reporting of the changes of UE presence in the provided Presence Reporting Area(s) by provisioning the "PRA\_CH" policy control request trigger to the SMF, within the "policyCtrlReqTriggers" attribute. + +NOTE 1: If this feature is not supported, the PCF can instead activate location change reporting that enables to receive reports of the actual location of the UE. Due to the potential increase in signalling load, careful consideration of the network load is necessary for such reporting, e.g. by limiting the number of subscribers subject to such reporting. + +If the PCF is configured with a Presence Reporting Area identifier referring to a list of Presence Reporting Area Identifier(s) within a Set of Core Network predefined Presence Reporting Areas as defined in 3GPP TS 23.501 [2], the PCF shall include only the identifier of the Presence Reporting Area Set within the "prald" attribute. + +NOTE 2: The Presence Reporting Area Identifier can correspond to a list of Presence Reporting Area Identifier(s) within a Set of Core Network predefined Presence Reporting Areas (PRA set identifier) as defined in 3GPP TS 23.501 [2]. + +The PCF may modify the list of PRA Identifier(s) by providing new Presence Reporting Area(s) or removing existing Presence Reporting Area(s), or modify the list of Presence Reporting Area element(s) by providing the updated Presence Reporting Area(s). In order to do that, + +- when the PRA feature is supported, the PCF shall follow the general procedure defined in clause 4.2.6.1 and supply the Presence Reporting Area identifier(s) as key(s) of "praInfos" the map attribute; or +- when the ePRA feature is supported, the PCF shall follow the general procedure defined in clause 4.2.6.1 and supply the Presence Reporting Area identifier(s) as key(s) of "praInfos" map, with the exception that for the modification of the list of the Presence Reporting Area element(s) the PCF shall fully replace the Presence Reporting Areas(s) previously provided with the new complete list of Presence Reporting Area element(s). + +NOTE 3: When the PRA feature is supported, the PCF cannot indicate the SMF to remove an existing Presence Reporting Area element(s) from a Presence Reporting Area by providing the updated Presence Reporting Area as defined in clause 4.2.6.1. How to support it depends on implementation. + +When PRA or ePRA feature is supported, the PCF may remove the associated policy control request trigger (i.e. "PRA\_CH") as defined in clause 4.2.6.4, if previously activated. + +If the NF service consumer and the PCF support both PRA and ePRA features, the NF service consumer and PCF shall perform the behaviours as the ePRA feature defined. + +If the "PRA\_CH" policy control request trigger is provisioned, when the PCF provides a list of presence reporting areas as described above, the PCF shall ensure that the maximum number of provisioned Presence Reporting Area Identifiers is not exceeded. The maximum number of PRAs may be configured in the PCF. The PCF may have independent configuration of the maximum number for Core Network pre-configured PRAs and UE-dedicated PRAs. + +NOTE 4: For all the Presence Reporting Area(s) provided by the PCF, the SMF can store the Presence Reporting Area Identifier(s) together with an indication that states that it relates to PCF requested PRA status changes. + +NOTE 5: This information is needed so that if both the PCF and the CHF request the reporting of PRA status changes, the SMF is able to differentiate whether the reported PRA changes are relevant to the PCF or the CHF. + +The SMF shall invoke the Namf\_EventExposure service in the AMF to handle the subscription to the presence state of a UE in an area of interest as specified in 3GPP TS 29.518 [36]. + +The PCF may be notified during the lifetime of a PDU session that the targeted UE is located in an access network where local configuration indicates that reporting changes of UE presence in Presence Reporting Area(s) is not supported. The PCF may then remove the associated policy control request trigger (i.e. "PRA\_CH"), if previously activated. In this case, the PCF shall also remove the provisioned Presence Reporting Area(s) by including the "praInfos" attribute set to NULL within the SmPolicyDecision data structure. + +The SMF shall remove the Namf\_EventExposure service subscription with the AMF for the reporting of Changes of UE presence in Presence Reporting Area(s), when the PCF and CHF remove the associated request triggers. + +#### 4.2.6.5.7 Policy provisioning and enforcement of reflective QoS + +If the PCF receives the "refQosIndication" attribute set to true as defined in clauses 4.2.2.2 or 4.2.4.2, and if the PCF determines that Reflective QoS Control will be enabled for the PDU session based on the operator's policy and user subscriptions, the PCF may provision the Reflective QoS Timer by including the "reflectiveQoS Timer" attribute within the SmPolicyDecision data structure in the response message. + +The provisioning of reflective QoS may be performed for service data flows associated with one or more PCC rules, and shall be performed using the PCC rule provisioning procedure. The PCF may within a QoS data decision which a PCC rule refer to include the "reflectiveQos" attribute set to true to enable the Reflective QoS control to a non-GBR downlink service data flow when the PCF authorizes the QoS for the service data flow as defined in clause 4.2.6.6.2. + +The PCF shall ensure that both, uplink and downlink traffic for such non-GBR service data flow are allowed. + +NOTE 1: The PCF can allow both uplink and downlink traffic for the non-GBR service data flow in several ways, e.g. by installing a PCC rule with uplink and downlink flow information, or by installing separate PCC rules for the uplink flows and downlink flows, or by installing a PCC rule with only the application identifier. + +The PCF shall activate the reporting changes of reflective QoS indication by provisioning the "REF\_QOS\_IND\_CH" policy control request trigger to the SMF. + +NOTE 2: While the UE applies a standardized value for the precedence of all UE derived QoS rules, PCC rules precedence values can vary and PCF configuration has to ensure that there is a large enough value range for the precedence of PCC rules corresponding to UE derived QoS rules. To avoid that the precedence of network provided QoS rules need to be changed when Reflective QoS is activated and filters are overlapping, the PCF will take the standardized value for the precedence of UE derived QoS rules into account and will setting the precedence value of PCC rules subject to Reflective QoS to a value in the range from 70 to 99 (decimal), as specified in 3GPP TS 24.501 [20], clause 6.2.5.1.1.3. + +The SMF shall apply reflective QoS control for the downlink traffic of the service data flows of the PCC rules that reference a QosData decision that includes "reflectiveQos" attribute set to true. + +The PCF shall not include the "reflectiveQos" attribute set to true within the QoS data decision which the PCC rule with match-all SDF template refers to. If a PCC rule with match-all SDF template has been provisioned to the SMF, the PCF + +shall not include the "reflectiveQos" attribute within the QoS data decision which contains the "defQosFlowIndication" attribute, either. + +If the PCF receives the "refQosIndication" attribute set to false as defined in clause 4.2.4.2, the PCF shall disable the reflective QoS Control for the PDU session. In order to do so, the PCF shall within the QoS data decision which affected PCC rule refer to include the "reflectiveQos" attribute set to false and may update other QoS parameters within the QoS data decision and/or update the flow information of PCC rule by including the "packetFilterUsage" attribute set to true. + +## 4.2.6.6 Authorized QoS + +### 4.2.6.6.1 General + +The PCF shall provision the authorized QoS. The authorized QoS may apply to a PCC rule or to a PDU session. + +- When the authorized QoS applies to a PCC rule, it shall be provisioned within the corresponding PCC rule as defined in clause 4.2.6.6.2. +- When the authorized QoS for a PCC rule with a GBR QCI is candidate for resource sharing an instruction on the allowed sharing may be provisioned as defined in clause 4.2.6.2.8. +- When the authorized QoS applies to a PDU session, it shall be provisioned as defined in clause 4.2.6.3.1. +- When the authorized QoS applies to the default QoS flow, it shall be provisioned as defined in clause 4.2.6.3.1. +- When the authorized QoS applies to an explicitly signalled QoS Characteristics, it shall be provisioned as defined in clause 4.2.6.6.3. +- When the authorized QoS applies to the Reflective QoS, it shall be provisioned as defined in clause 4.2.6.5.7. + +The authorized QoS provides appropriate values for the resources to be enforced. The authorized QoS for a PCC rule is a request for allocating the corresponding resources. The Provisioning of authorized QoS per PCC rule is a part of PCC rule provisioning procedure. + +If the SMF cannot allocate any of the resources as authorized by the PCF, the SMF informs the PCF and acts as described in clauses 4.2.3.16 and 4.2.4.15. + +The SMF shall interact with the (R)AN, UPF and UE for enforcing the policy based authorization. + +QoS authorization information may be dynamically provisioned by the PCF or it may be a pre-defined PCC rule in the SMF. Moreover, all the parameters of the authorized QoS may be changed. + +NOTE 1: A change of 5QIs cannot be described as an upgrade or downgrade and also no 5QI can be referred to as the higher or lower. Whether the 5QI is permitted to be changed or not is subject to both operator policies and normal restrictions on changing from a non-GBR 5QI value to GBR 5QI value on an IP flow. + +NOTE 2: All attributes of the ARP QoS parameter can be changed but only the ARP priority level represents an ordered range of values. The ARP priority level attribute represents the actual priority for the service/user with the value 1 as the highest and can thus be upgraded and downgraded. + +If the PCF is unable to make a decision for the response to the HTTP POST message by the SMF, the PCF may reject the request as described in clause 5.7. + +### 4.2.6.6.2 Policy provisioning and enforcement of authorized QoS per service data flow + +The Provisioning of authorized QoS per service data flow is a part of PCC rule provisioning procedure, as described in clause 4.2.6.2.1. + +The authorized QoS per service data flow shall be provisioned within a QosData data structure. The PCF shall include a "qosDecs" attribute containing the corresponding QoS data decision within the SmPolicyDecision data structure and include the reference to this QoS data decision within the "refQosData" attribute of the PccRule data instance. + +When network slice data rate policy control applies and the authorized QoS per service data flow refers to a 5QI of GBR type, the PCF shall derive the authorized QoS per service data flow as described in clause 4.2.6.8. + +Within the QoS data decision, for 5QI of GBR type or delay critical GBR type, the PCF shall include the authorized GBR 5QI or delay critical GBR 5QI respectively within the "5qi" attribute, the ARP within the "arp" attribute, and max bandwidth in uplink within the "maxbrUI" attribute and/or max bandwidth in downlink within the "maxbrDI" attribute, the guaranteed bandwidth in uplink within the "gbrUI" attribute and/or the guaranteed bandwidth in downlink within the "gbrDI" attribute. If the PCF determines that the application traffic can be adapted to the change in the QoS based on the configuration (e.g. if the AF is capable to trigger rate adaptation), the PCF may request a notification when authorized GBR or delay critical GBR cannot be guaranteed or can be guaranteed again by including the "qnc" attribute set to true. + +Within the QoS data decision, for 5QI of non-GBR type, the PCF shall include the authorized non-GBR 5QI within the "5qi" attribute and the ARP within the "arp" attribute. The PCF may authorize the max bandwidth in uplink within the "maxbrUI" attribute and/or max bandwidth in downlink within the "maxbrDI" attribute. + +When the PCF authorizes a standardized 5QI but a Priority Level, an Averaging Window and/or a Maximum Data Burst Volume which are different from the standardized value in the table 5.7.4-1 of 3GPP TS 23.501 [2] are required, the PCF shall include the Priority Level within the "priorityLevel" attribute, the Averaging Window within the "averWindow" attribute and/or the Maximum Data Burst Volume within the "maxDataBurstVol" attribute or the "extMaxDataBurstVol" attribute (if supported, see clause 4.2.2.1). + +NOTE 1: For the non-standardized or non-configured 5QI, the PCF needs to authorize explicitly signalled QoS Characteristics associated with the 5QI if the PCF has not provisioned it. + +If the configured policy allows at reception of the service information from the AF and the application of the rules of the QoS mapping procedures defined in 3GPP TS 29.513 [7] clause 7.3.2 for the received service information result in a 5QI of 1 associated with the corresponding flows, and the RAN-Support-Info feature as defined clause 5.8 is supported, the PCF shall determine the Maximum Packet Loss Rate for UL and DL for those flows associated within 5QI of 1. In this case, the PCF shall include the value of Maximum Packet Loss Rate for UL within the "maxPacketLossRateUI" attribute and/or the value of Maximum Packet Loss Rate for DL within the "maxPacketLossRateDI" attribute. + +NOTE 2: If CHEM feature is supported, then PCF as described in clause 7.2.3 of 3GPP TS 29.513 [7] or based on local configuration, the PCF sets the downlink and uplink maximum packet loss rates corresponding to either the most robust codec mode or the least robust codec mode of the negotiated set in each direction. + +If the PCF wants to ensure that a PCC Rule is always bound to the default QoS flow, the policy provisioning for the related authorized QoS shall be done as described in clause 4.2.6.2.10. + +The SMF shall perform a QoS flow binding based on the QoS information within the QoS data decision as defined in clause 6.4 of 3GPP TS 29.513 [7] after the SMF installs or activates the PCC rules. + +The SMF shall reserve the resources necessary for the guaranteed bitrate for the PCC rule upon receipt of a PCC rule provisioning including QoS information. For GBR QoS flows the SMF should set the QoS flow's GBR to the sum of the GBRs of all PCC rules that are active/installed and bound to that GBR QoS flow. For GBR QoS flow the SMF should set the QoS flow's MBR to the sum of the MBRs of all PCC rules that are active/installed and bound to that GBR QoS flow. + +NOTE 3: Since the PCF controls the GBR value in the PCC rule, the PCF can prevent that uplink GBR resources are reserved by providing an uplink GBR value of zero for that PCC rule. This may be useful e.g. for a PCC rule with application identifier as the uplink traffic can be received in other QoS flow than the one the PCC rule is bound to. + +The SMF shall assign a QFI if a new QoS flow needs to be established and shall derive, if applicable, the QoS profile required towards the Access Network, the QoS rule required towards the UE and the QoS information with PDRs towards to the UPF. If multiple PCC rules with the Maximum Packet Loss Rate for UL and DL are bound to the same QoS flow, the SMF shall choose the lowest value per direction related to the PCC rules within the QoS profile towards to the access network. + +For PIN scenarios (defined in 3GPP TS 23.501 [2], clause 5.44), the SMF may, for a (S-NSSAI, DNN) combination of the PDU Session, increase the CN PDB in the derived QoS profile corresponding to a GBR flow if the UE requested non-3GPP delay budget as part of a UE-initiated resource modification procedure based on operator policy and implementation. + +NOTE 4: The non-3GPP delay budget does not impact the QoS flow binding as defined in clause 6.4 in 3GPP TS 29.513 [7]. + +If one or more of the 5QI, ARP, QNC, Priority level, Averaging Window and Maximum Data Burst Volume attributes of a PCC rule are modified to the same updated values for all the PCC rules bound to the same QoS flow, then the SMF should modify the corresponding attributes for that impacted QoS flow. + +Upon deactivation or removal of a PCC rule, the SMF shall free the resources reserved for that PCC rule, and initiate the corresponding procedure with access network, UE and UPF to remove the resources. + +#### 4.2.6.6.3 Policy provisioning and enforcement of authorized explicitly signalled QoS Characteristics + +The PCF may provision a dynamically assigned 5QI value (from the non-standardized and non-preconfigured value range) and the associated 5G QoS characteristics to the SMF. In order to do so, the PCF shall include within the SmPolicyDecision data structure the "qosChars" attribute to contain one or more authorized signalled QosCharacteristics instance(s). For each QosCharacteristics instance, the PCF shall include the assigned 5QI value within the "5qi" attribute, the resource type value within the "resourceType" attribute, the 5QI Priority Level value within the "priorityLevel" attribute, the Packet Delay Budget value within the "packetDelayBudget" attribute, the Packet Error Rate value within the "packetErrorRate" attribute, the Averaging Window value within the "averagingWindow" attribute, if applicable, and the Maximum Data Burst Volume value within the "maxDataBurstVol" attribute or the "extMaxDataBurstVol" attribute (if supported, see clause 4.2.2.1), if applicable. If the PCF has provisioned an authorized signalled QosCharacteristics instance to the SMF, the PCF shall not update nor remove it during the lifetime of the policy association. + +Upon receiving the authorized explicitly signalled QoS characteristics, the SMF shall derive the QoS profile for the access network and provide it to the access network by invoking the corresponding procedure. + +NOTE 1: The SMF can increase the Packet Delay Budget in the QoS profile in PIN scenarios as a result of a UE-requested PDU session modification procedure for certain (S-NSSAI, DNN) combination and signal it to the access network(defined in 3GPP TS 23.501 [2], clause 5.44.3.4). + +NOTE 2: Operator configuration is assumed to ensure that the assigned dynamic 5QI value is unique and references the same set of QoS characteristics within the whole PLMN at a given time. + +#### 4.2.6.7 Monitoring the data rate per network slice for a UE + +The PCF can support monitoring of data rate per S-NSSAI for a UE. + +During PDU session establishment, if the PCF supports monitoring of the data rate per S-NSSAI for a UE, the PCF may retrieve for the UE and S-NSSAI to which the PDU session is allocated the Subscribed UE-Slice-MBR (i.e. the aggregate data rate that can be expected to be provided across all GBR and Non-GBR QoS Flows of a UE for a network slice identified by an S-NSSAI) from the UDR as defined in clause 5.4.2.14 of 3GPP TS 29.519 [15]. The PCF shall monitor the data rate for this S-NSSAI and UE by deriving the utilized data rate based on the authorized Session-AMBR and/or the authorized QoS per service data flow in all PDU session(s) established for the UE in the concerned S-NSSAI and checking the derived value against the UE-Slice-MBR set by the PCF based on the Subscribed UE-Slice-MBR value retrieved from the UDR and operator policies available at the PCF. + +As part of the PDU session modification procedure(s) targeting the PDU session(s) established for the UE in the concerned S-NSSAI, whenever the PCF needs to provide the associated authorized Session-AMBR(s), install new or updated PCC Rule(s) and/or delete PCC Rule(s) related to GBR service data flow(s), the PCF shall calculate the utilized data rate as described in clause 4.2.6.8.2. + +At the termination of a PDU session established for the UE in the concerned S-NSSAI, the PCF shall adjust the utilized data rate for the UE based on the release of the Session-AMBR and the removal of all the PCC Rule(s) related to GBR service data flow(s) associated to that PDU session. + +To enable this monitoring, the SMF shall select the same PCF instance for all PDU sessions of the UE to the S-NSSAI that is subject to this monitoring as defined in clause 8.3 of 3GPP TS 29.513 [7]. + +When the calculated utilized data rate for the S-NSSAI and UE reaches a certain percentage of the Subscribed UE-Slice-MBR value, the PCF may apply a policy decision to strengthen the traffic restrictions for individual PDU session(s) or PCC rule(s) (e.g. change the authorized Session-AMBR as defined in clause 4.2.6.3.1, change the authorized QoS per service data flow as defined in clause 4.2.6.6.2, or change the charging keys) within individual PDU session(s) established for the UE in the concerned S-NSSAI. When the calculated utilized data rate per S-NSSAI for a UE falls below that percentage of the Subscribed UE-Slice-MBR value, the PCF may relax the traffic restrictions for + +individual PDU session(s) or PCC rule(s) within individual PDU session(s) established for the UE in the concerned S-NSSAI. + +As part of the policy decision to strengthen the traffic restrictions for individual PDU session(s), the PCF may reject the establishment or SMF-initiated modification of the associated SM Policy Association(s) with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "EXCEEDED\_UE\_SLICE\_DATA\_RATE". + +NOTE: It is recommended to avoid frequent policy decisions which trigger a signalling with the UE (like change of the authorized Session-AMBR or change of the authorized QoS per service data flow). + +#### 4.2.6.8 Network slice related data rate policy control + +##### 4.2.6.8.1 General + +A PCF that supports network slice related data rate policy control shall be able to control and manage the network slice data rate. + +A Maximum Slice Data Rate may be configured by the operator (e.g. based on an SLA related to the associated network slice identified by an S-NSSAI). + +NOTE 1: The Maximum Slice Data Rate defines the maximum allowed aggregate data rate across all GBR and Non-GBR QoS Flows within the network slice identified by an S-NSSAI as defined in 3GPP TS 29.519 [15]. + +NOTE 2: The maximum data rate of Non-GBR QoS Flow(s) is controlled via the authorized Session-AMBR, while the maximum data rate of a GBR QoS Flow is controlled via the authorized MBR value of the associated PCC rule. + +The PCF shall determine, based on local configuration, if the network slice data rate is controlled via PCF-based monitoring by using QoS parameters or with assistance of the NWDAF. + +The PCF shall monitor the data rate of the network slice and ensure that it does not exceed the Maximum Slice Data Rate for that network slice by e.g. rejecting new SM Policy Associations, changing the authorized Session-AMBR values (if allowed by the HPLMN), changing the MBR values in PCC rules belonging to GBR service data flows or other actions depending on operator's policies. + +NOTE 3: Based on operator's policies, it is also possible for the PCF to accept that new PDU session(s) or PCC rule(s) belonging to GBR service data flow(s) lead to exceeding the Maximum Slice Data Rate and apply a different charging for them. Once the Maximum Slice Data Rate is no longer exceeded, the PCF can decide to go back to applying the previous charging. + +NOTE 4: Subject to operator policy and national/regional regulations, prioritised services and emergency services may be exempted from network slice data rate policy control. + +NOTE 5: A single PCF can be used for the monitoring and limitation of the network slice related data rate. To enable this, the SMF has to select the same PCF instance for all PDU Sessions of the UE to the S-NSSAI. + +##### 4.2.6.8.2 PCF-based network slice data rate policy control by using QoS parameters + +If the NWDAF is not deployed or not used for network slice data rate policy control and PCF-based monitoring of network slice data rate by using QoS parameters applies, the UDR shall maintain the Remaining Maximum Slice Data Rate per S-NSSAI as part of the network slice specific policy control data as defined in 3GPP TS 29.519 [15]. + +Whenever the PCF needs to calculate the data rate related to authorized Session-AMBR and/or the MBR(s) of the GBR Service Data Flow(s), the PCF shall obtain the Remaining Maximum Slice Data Rate by interacting with the UDR as defined in 3GPP TS 29.519 [15]. When the PCF interacts with the UDR may be based on operator policies. + +When the PCF needs to provide the authorized Session-AMBR and/or install new or updated PCC Rule(s) and/or delete PCC Rule(s) related to GBR service data flow(s), the PCF shall: + +- calculate the difference between the previously authorized Session-AMBR, if applicable, and the new authorized Session-AMBR; and/or + +- calculate the difference between the previously authorized MBR and the new authorized MBR(s) for the authorized PCC Rule(s) related to GBR service data flow(s); + +And then: + +- Calculate the utilized data rate, i.e. the sum of the previously calculated differences, which is to be subtracted from the Remaining Maximum Slice Data rate. + +NOTE 1: For example, when the PCF modifies as part of the same operation the MBR of PCC Rule A from 100 to 150 and the MBR of PCC Rule B from 30 to 20, deletes PCC Rule C with an MBR of 50 and adds a PCC Rule D of MBR 75, the final calculated value will be $+50-10-50+75$ , i.e. 65. If the authorized Session-AMBR is also updated from 1000 to 2000, the final derived value will be 1065. + +NOTE 2: The utilized data rate can be a negative value. In this case, the final Remaining Maximum Slice Data Rate is increased. + +Therefore, the PCF shall behave as follows: + +- At PDU session establishment, the PCF shall check whether the Remaining Maximum Slice Data Rate is higher than the calculated utilized data rate (e.g. based on the authorized Session-AMBR). If it is the case, the PCF shall deduct the value of the utilized data rate from the Remaining Maximum Slice Data Rate for the concerned S-NSSAI in the UDR. If however the Remaining Maximum Slice Data Rate is not sufficient, the PCF may reject the establishment of the SM Policy Association with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "EXCEEDED\_SLICE\_DATA\_RATE". +- At PDU session modification initiated by the SMF, the PCF shall check whether the Remaining Maximum Slice Data Rate is higher than the calculated utilized data rate (e.g. based on the authorized Session-AMBR). If it is the case, the PCF shall deduct the value of the utilized data rate from the Remaining Maximum Slice Data Rate for the concerned S-NSSAI in the UDR. If however the Remaining Maximum Slice Data Rate is not sufficient, the PCF may reject the modification of the SM Policy Association with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "EXCEEDED\_SLICE\_DATA\_RATE". +- When a PCC rule of a GBR service data flow is installed, modified, removed, activated or deactivated in the SMF, + - the PCF shall derive the authorized QoS for the service data flow and the associated utilized data rate and update the Remaining Maximum Slice Data Rate for the concerned S-NSSAI in the UDR accordingly; + - the PCF may request the SMF to confirm that the resources associated to that PCC rule are successfully allocated as defined in clause 4.2.6.5.5 or released as defined in clauses 4.2.3.13 and 4.2.4.12; + - if the SMF reports that some of or all the resources cannot be successfully allocated, the PCF shall recalculate the authorized QoS for the service data flow and the associated utilized data rate and update the Remaining Maximum Slice Data Rate for the concerned S-NSSAI in the UDR accordingly. +- When the authorized Session-AMBR changes and/or one or several PCC Rule(s) of a GBR service data flow(s) are installed, removed or modified, the PCF shall calculate the new utilized data rate and update the Remaining Maximum Slice Data Rate for that S-NSSAI in the UDR accordingly. +- At PDU session termination, the PCF shall add the value of the related previously utilized data rate (i.e. based on the authorized Session-AMBR allocated to the PDU session and the previously utilized data rate by the removed PCC Rule(s) related to GBR service data flow(s)) to the Remaining Maximum Slice Data Rate for the concerned S-NSSAI in the UDR. +- If the Remaining Maximum Slice Data Rate for that S-NSSAI reaches a (operator defined) threshold that indicates that it is closer or equal to zero, the PCF may apply policy decision(s) to strengthen the traffic restrictions for the concerned PDU Session(s). +- If the Remaining Maximum Slice Data Rate for that S-NSSAI returns to a value below the (operator defined) threshold, the PCF may apply policy decision(s) to recover the initially derived value(s) for the concerned PDU Session(s). + +NOTE 3: While the Remaining Maximum Slice Data Rate is relatively high, the PCF can be configured to maintain a local Remaining Maximum Slice Data Rate and to only interact with the UDR to update the Remaining Maximum Slice Data Rate when a certain threshold is reached, or a certain time window has passed. The higher the configured values are the lower the chances for an accurate limitation of the slice data rate becomes. When multiple PCFs for the same S-NSSAI are deployed, each PCF can also subscribe to the change of the Network slice specific policy control data in the UDR. The UDR will then send a notification to each subscribed PCF when the Remaining Maximum Slice Data Rate per S-NSSAI changes. + +NOTE 4: Multiple PCFs responsible for PDU Sessions of UEs to the same S-NSSAI can read and update the Remaining Maximum Slice Data Rate for the S-NSSAI in the UDR using the conditional requests with preconditions for the update of the Remaining Maximum Slice Data Rate, this mechanism using Etags is defined in Table 5.2.2.2-2 of 3GPP TS 29.500 [4] to ensure a proper update of the UDR data in case of simultaneous access from different PCFs. + +#### 4.2.6.8.3 Network slice data rate policy control with assistance of the NWDAF + +If the NWDAF is used for network slice data rate policy control, the PCF uses the Data Volume Dispersion Analytics provided by the NWDAF. For this purpose, the PCF subscribes to the NWDAF for periodic reporting of the Data Volume Dispersion Analytics statistics for all the UEs using the concerned network slice. The PCF subscribes to the NWDAF for Data Volume Dispersion Analytics reporting at the establishment of the first PDU session within the concerned S-NSSAI (subject to network slice data rate limitation) and cancels this subscription at the termination of the last PDU session within the concerned S-NSSAI as described in 3GPP TS 29.520 [51]. + +The PCF calculates the utilized data rate of the S-NSSAI by using the Data Volume Dispersion Analytics statistics reported by the NWDAF. When the utilized data rate of the S-NSSAI in UL and/or DL is getting close to or exceeding respectively the value of the "mbrUI" attribute and/or the value of the "mbrDI" attribute of the SlicePolicyData data structure as defined in 3GPP TS 29.519 [15], based on operator policy, the PCF may apply policy decision(s) to strengthen the traffic restrictions for individual PDU sessions and/or PCC rules. For example: + +- The PCF may reject the creation or modification of SM Policy Associations that require the increase of the utilized data rate for the S-NSSAI with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "EXCEEDED\_SLICE\_DATA\_RATE". +- The PCF may refrain from sending new and/or updated PCC Rules that require the increase of the utilized data rate. + +When the utilized data rate of the S-NSSAI in UL and/or DL falls below respectively the value of the "mbrUI" attribute and/or the value of the "mbrDI" attribute of the SlicePolicyData data structure, the PCF may relax the traffic restrictions for individual PDU sessions and/or PCC rules. + +When multiple PCFs for the same S-NSSAI are deployed, each PCF subscribes to the analytics from the NWDAF separately. + +NOTE: When multiple PCFs are used for the concerned S-NSSAI, the NWDAF triggers Data Volume Dispersion Analytics notifications towards all these PCFs, but their policy decisions can be different. + +#### 4.2.6.9 Group related data rate policy control + +##### 4.2.6.9.1 General + +A PCF that supports group related data rate policy control shall be able to control and manage the group data rate for 5G VN groups. In order to do so, the PCF shall perform the same procedures as the ones defined for network slice related data rate policy control defined in clauses 4.2.6.8 for the PDU session(s) of the UE(s) belonging to a 5G VN group, with the following differences: + +- Only the PCF-based method shall be applicable for group related data rate policy control, i.e., the provisions of clause 4.2.6.8.3 shall not apply for group related data rate policy control. +- The provisions related to slice related data rate policy control for an S-NSSAI shall apply for group related data rate policy control for a 5G VN Group. + +- Instead of configuring the Maximum Slice Data Rate per S-NSSAI by the operator, the Maximum Group Data Rate per 5G VN Group is either provisioned by the AF to the UDR (for "Subscription Data") via the NEF/UDM as part of the 5G VN group subscription data using the procedures defined in 3GPP TS 29.522 [59] and 3GPP TS 29.503 [34] and/or configured by the operator. When the Maximum Group Data Rate is provisioned by the AF, the PCF shall retrieve it from the UDR (for "Subscription Data"). +- Instead of handling the Remaining Maximum Slice Data Rate per S-NSSAI, the UDR and PCF shall handle the Remaining Maximum Group Data Rate per 5G VN Group. +- Instead of calculating the utilized data rate based on the value(s) of the authorized Session-AMBR and the MBR of every GBR SDF for every PDU Session of a network slice identified by an S-NSSA, the PCF shall calculate the utilized data rate based on the value(s) of the authorized Session-AMBR and the MBR of every GBR SDF for every PDU Session of the concerned 5G VN Group. +- Instead of returning the "EXCEEDED\_SLICE\_DATA\_RATE" application error, the PCF shall return the "EXCEEDED\_GROUP\_DATA\_RATE" application error within the "403 Forbidden" error response. + +#### 4.2.6.10 Policy Provisioning for eXtended Reality and Interactive Media Services + +##### 4.2.6.10.1 Support for delivery of multi-modal services + +Multi-modal services consist of several data flows (named as multi-modal flows) that relate to each other and may come from different sources. Each data flow (single-modal data) may be seen as one type of data (for example audio, video, positioning, haptic data) associated with the same communication service. + +The provision of PCC Rules corresponding to multi-modal services shall be performed as described in clause 4.2.6.2.1 "Provisioning of PCC rules". + +For the delivery of multi-modal services, the PCF shall: + +- derive the applicable PCC rule(s) and apply the required QoS as described in clause 4.2.3.22. The PCF may use the multi-modal Id received from the AF (either directly or via NEF), as specified in 3GPP TS 29.514 [17], to derive the correct PCC rules and apply QoS policies; and +- when the received multi-modal service requirements include QoS monitoring requirements, generate the authorized QoS Monitoring policy for each flow as described in clause 4.2.3.25. The PCF shall use the QoS monitoring requirement received from the AF (either directly or via NEF), as specified in 3GPP TS 29.514 [17]. + +#### 4.2.7 Handling of requests which collide with an existing SM Policy Association + +The PCF may receive an Originating Time Stamp parameter within the 3gpp-Sbi-Origination-Timestamp header, which is set by the AMF, by the Npcf\_SMPolicyControl\_Create service request. + +NOTE 1: The SMF forwards the Origination Time Stamp to the PCF, when received from the AMF to allow the handling of colliding requests at the PCF based on network conditions. + +Upon receipt of a Npcf\_SMPolicyControl\_Create service request which collides with an existing SM Policy Association for the same UE (i.e. same values of "supi" attribute) and the same PDU session Id (i.e. same values of "pduSessionId" attribute), the PCF shall accept the new request only if it contains a more recent timestamp within the 3gpp-Sbi-Origination-Timestamp header than the origination timestamp stored for the existing SM Policy Association. An incoming Npcf\_SMPolicyControl\_Create service request shall be considered as more recent than an existing SM Policy Association and be accepted if no 3gpp-Sbi-Origination-Timestamp header was provided for at least one of the two SM Policy Associations. The PCF shall reject an incoming request whose timestamp is less recent than the timestamp of the existing SM Policy Association with the HTTP status code "403 Forbidden" and the application error "LATE\_OVERLAPPING\_REQUEST". + +NOTE 2: When the PCF accepts the new request that contains a more recent timestamp within the 3gpp-Sbi-Origination-Timestamp header than the timestamp stored for the SM Policy Association, the PCF performs implementation specific, e.g. locally deletes the existing Individual SM Policy Association. + +## 4.2.8 UE IP address support + +As specified in 3GPP TS 23.501 [2], the following types of UE IP addresses may be assigned to a PDU session and may be received by the PCF: + +- IPv4 address; and/or +- /64 IPv6 Prefix; or +- IPv6 prefix shorter than the default /64 prefix when IPv6 Prefix Delegation applies. + +More than one UE IP addresses may be assigned to a PDU session, as specified in clause 4.2.4.11. + +--- + +# 5 Npcf\_SMPolicyControl Service API + +## 5.1 Introduction + +The Npcf\_SMPolicyControl Service shall use the Npcf\_SMPolicyControl API. + +The API URI of the Npcf\_SMPolicyControl API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP request from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "npcf-smpolicycontrol". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2, shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +An OpenAPI [10] specification of HTTP messages and content bodies for the Npcf\_SMPolicyControl is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [31]. + +## 5.2.3 HTTP custom headers + +### 5.2.3.1 General + +The Npcf\_SMPolicyControl API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4]. + +### 5.2.3.2 3gpp-Sbi-Origination-Timestamp + +The header contains the date and time (with a millisecond granularity) when the originating entity initiated the request as specified in clause 6.1.2.3.2 of 3GPP TS 29.502 [22]. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +![Diagram showing the resource URI structure of the Npcf_SMPolicyControl API. The root path is {apiRoot}/npcf-smpolicycontrol/v1. It branches to /sm-policies, which then branches to /{smPolicyId}. From /{smPolicyId}, two optional sub-paths are shown: /update and /delete, both enclosed in dashed boxes.](cd0f8f598fb2fa15165967e75378f42a_img.jpg) + +``` +graph TD; Root["{apiRoot}/npcf-smpolicycontrol/v1"] --- SmPolicies["/sm-policies"]; SmPolicies --- SmPolicyId["/{smPolicyId}"]; SmPolicyId --- Update["/update"]; SmPolicyId --- Delete["/delete"]; style Update stroke-dasharray: 5 5; style Delete stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure of the Npcf\_SMPolicyControl API. The root path is {apiRoot}/npcf-smpolicycontrol/v1. It branches to /sm-policies, which then branches to /{smPolicyId}. From /{smPolicyId}, two optional sub-paths are shown: /update and /delete, both enclosed in dashed boxes. + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_SMPolicyControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------|----------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| SM Policies | /sm-policies | POST | Create a new Individual SM Policies resource for a SUPI or a PEI and PDU Session ID supplied by the NF service consumer. | +| Individual SM Policy | /sm-policies/{smPolicyId} | GET | Read an Individual SM Policies resource. | +| | /sm-policies/{smPolicyId}/delete | delete (POST) | Delete an Individual SM Policies resource. | +| | /sm-policies/{smPolicyId}/update | update (POST) | Update an Individual SM Policies resource when a policy control request event is met or an error of policy enforcement occurs. | + +## 5.3.2 Resource: SM Policies + +### 5.3.2.1 Description + +This resource represents the collection of the individual SM Policies created in the PCF. + +### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-sm-policycontrol/v1/sm-policies + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +### 5.3.2.3 Resource Standard Methods + +#### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------| +| SmPolicyContextData | M | 1 | Parameters to create an individual SM policies resources. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyDecision | M | 1 | 201 Created | An individual SM Policy resources for the SUPI and PDU session id are created successfully. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| n/a | | | 308 Permanent Redirect | The URI of the PCF within the existing PCF binding information stored in the BSF for the indicated combination is returned in the non-roaming or home-routed scenario. (NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: Only applicable to the "SamePcf" feature as defined in clause 5.8. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/npcf-smolicycontrol/v1/sm-policies/{smPolicyId} | + +**Table 5.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the PCF within the existing PCF binding information stored in the BSF for the indicated combination. | + +## 5.3.2.4 Resource Custom Operations + +None. + +## 5.3.3 Resource: Individual SM Policy + +### 5.3.3.1 Description + +The individual SM Policy resource represents an individual SM Policy created in the PCF and associated with the SUPI and PDU session ID. + +### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-smolicycontrol/v1/sm-policies/{smPolicyId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|---------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| smPolicyId | string | Unique identifier of the individual SM Policy resource. | + +### 5.3.3.3 Resource Standard Methods + +#### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyControl | M | 1 | 200 OK | An individual SM Policy resources for the SUPI and PDU session id are returned successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SM policy retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SM policy retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +### 5.3.3.4 Resource Custom Operations + +#### 5.3.3.4.1 Overview + +**Table 5.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------------------|--------------------|------------------------------------------| +| delete | /sm-policies/{smPolicyId}/delete | delete (POST) | Delete an individual SM Policy resource. | +| update | /sm-policies/{smPolicyId}/update | update (POST) | Update an individual SM Policy resource. | + +#### 5.3.3.4.2 Operation: delete + +##### 5.3.3.4.2.1 Description + +##### 5.3.3.4.2.2 Operation Definition + +This custom operation deletes an individual SM Policy resource in the PCF. + +This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2. + +**Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------------------------| +| SmPolicyDeleteData | O | 0..1 | Parameters to be sent by the NF service consumer when the individual SM policy is deleted. | + +**Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful deletion of the individual SM policy resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SM policy deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SM policy deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +### 5.3.3.4.3 Operation: update + +#### 5.3.3.4.3.1 Description + +#### 5.3.3.4.3.2 Operation Definition + +This custom operation updates an individual SM Policy resource in the PCF. + +This operation shall support the request data structures specified in table 5.3.3.4.3.2-1 and the response data structure and response codes specified in table 5.3.3.4.3.2-2. + +**Table 5.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyUpdateContextData | M | 1 | Parameters to be sent by the NF service consumer when the individual SM policy is updated. It indicates the occurred changes. | + +**Table 5.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyDecision | M | 1 | 200 OK | An individual SM Policy resources is updated successfully. Response body includes the policy decision changes. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual SM policy modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual SM policy modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +**Table 5.5.1-1: Notifications** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------|-----------------------------|---------------------------------|----------------------------------------------------| +| Policy Update Notification | {notificationUri}/update | update (POST) | Policy Update Notification. | +| Request for termination of the policy association | {notificationUri}/terminate | terminate (POST) | Request for termination of the policy association. | + +### 5.5.2 Policy Update Notification + +#### 5.5.2.1 Description + +This notification is used by the PCF to update the policy. + +#### 5.5.2.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.2.2-1 and the response data structure and response codes specified in table 5.5.2.2-2. + +**Table 5.5.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|--------------------------------------------| +| SmPolicyNotification | M | 1 | Update the SM policies provided by the PCF | + +**Table 5.5.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The SM policies are updated successfully. | +| UeCampingRep | O | 0..1 | 200 OK | The current applicable values corresponding to the policy control request trigger is reported. | +| array(PartialSuccessReport) | O | 1..N | 200 OK | Some of the PCC rules and/or session rule provisioned by the PCF are not installed/activated successfully and/or the storage of some of the provisioned policy decisions and/or condition data has failed. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during SM policy notification.
Applicable if the feature "ES3XX" is supported. (NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during SM policy notification.
Applicable if the feature "ES3XX" is supported. (NOTE 3) | +| ErrorReport | M | 1 | 400 Bad Request | The SM policies including all the PCC rules, session rules and policy decisions and condition data provisioned by the PCF are not installed/activated and stored successfully. | +| array(PolicyDecisionFailureCode) | O | 1..N | 200 OK | Provisioning of some of the policy decision and/condition data which are not referred by any PCC rules or session rule has failed. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.5.3 Request for termination of the policy association + +### 5.5.3.1 Description + +This notification is used by the PCF to request the termination of a policy association. + +### 5.5.3.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.3.2-1 and the response data structure and response codes specified in table 5.5.3.2-2. + +**Table 5.5.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|----------------------------------------------| +| TerminationNotification | M | 1 | Request to terminate the policy association. | + +**Table 5.5.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The request for policy association termination was received. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during SM policy termination notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during SM policy termination notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE: 1 The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.5.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.
For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +The Npcf\_SMPolicyControl API allows the NF service consumer to retrieve the session management related policy from the PCF as defined in 3GPP TS 23.503 [6]. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_SMPolicyControl service based interface protocol. + +**Table 5.6.1-1: Npcf\_SMPolicyControl specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| 5GSmCause | 5.6.3.2 | Indicates the 5GSM cause code value. | RAN-NAS-Cause | +| AdditionalAccessInfo | 5.6.2.43 | Indicates the combination of additional Access Type and RAT Type for MA PDU session | ATSSS | +| AccNetChargingAddress | 5.6.2.35 | Identifies the address of the network node performing charging and used for charging applications. | | +| AccNetChId | 5.6.2.23 | Contains the access network charging identifier for the PCC rule(s) or whole PDU session. | | +| AccuUsageReport | 5.6.2.18 | Contains the accumulated usage report information. | UMC | +| AfSigProtocol | 5.6.3.10 | Indicates the protocol used for signalling between the UE and the AF. | ProvAFsignalFlow | +| AppDetectionInfo | 5.6.2.22 | Contains the detected application's traffic information. | ADC | +| ApplicationDescriptor | 5.6.3.2 | Defines the Application Descriptor for an ATSSS rule. | ATSSS | +| AtsssCapability | 5.6.3.26 | Contains the ATSSS capability supported for the MA PDU Session. | ATSSS | +| AuthorizedDefaultQos | 5.6.2.34 | Authorized Default QoS. | | +| BridgeManagementContainer | 5.6.2.47 | Contains the UMIC. | TimeSensitive Networking | +| CalleeInfo | 5.6.2.55 | Identifies the callee information. | VBCforIMS | +| CallInfo | 5.6.2.54 | Identifies the caller and callee information. | VBCforIMS | +| ChargingData | 5.6.2.11 | Contains charging related parameters. | | +| ChargingInformation | 5.6.2.17 | Contains the addresses, and if available, the instance ID and set ID, of the charging functions. | | +| ConditionData | 5.6.2.9 | Contains conditions for applicability of a rule. | | +| CreditManagementStatus | 5.6.3.16 | Indicates the reason of the credit management session failure. | | +| DownlinkDataNotificationControl | 5.6.2.48 | Contains the downlink data notification control information. | DDNEventPolicyControl | +| DownlinkDataNotificationControlRm | 5.6.2.49 | This data type is defined in the same way as the "DownlinkDataNotificationControl" data type, but with the OpenAPI "nullable: true" property. | DDNEventPolicyControl2 | +| EpsRanNasRelCause | 5.6.3.2 | Indicates the RAN or NAS release cause code information in 3GPP-EPS access type or indicates the TWAN or untrusted WLAN release cause code information in Non-3GPP-EPS access type. | RAN-NAS-Cause | +| ErrorReport | 5.6.2.36 | Contains the PCC rule and/or session rule and/or policy decision and/or condition data reports. | | +| FailureCause | 5.6.3.14 | Indicates the cause of the failure in a Partial Success Report. | | +| FailureCode | 5.6.3.9 | Indicates the reason of the PCC rule failure. | | +| FlowDescription | 5.6.3.2 | Defines a packet filter for an IP flow. | | +| FlowDirection | 5.6.3.3 | Indicates the direction of the service data flow. | | +| FlowDirectionRm | 5.6.3.15 | This data type is defined in the same way as the "FlowDirection" data type, but allows null value. | | +| FlowInformation | 5.6.2.14 | Contains the flow information. | | +| IpMulticastAddressInfo | 5.6.2.46 | Contains the IP multicast addressing information | WWC | +| L4sSupportInfo | 5.6.2.57 | Indicates whether the ECN marking for L4S is available in 5GS for the indicated PCC rules. | L4S | +| MaPduIndication | 5.6.3.25 | Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed. | ATSSS | +| MeteringMethod | 5.6.3.5 | Indicates the metering method. | | +| MulticastAccessControl | 5.6.3.20 | Indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed. | WWC | +| NetLocAccessSupport | 5.6.3.27 | Indicates the access network support of the report of the requested access network information. | NetLoc | +| NotificationControlIndication | 5.6.3.29 | Indicates the notification of DDD Status is requested and/or notification of DDN Failure is requested. | DDNEventPolicyControl | + +| | | | | +|---------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| NwdafData | 5.6.2.53 | Indicates the list of NWDAF instance IDs used for the PDU Session and their associated Analytics ID(s) consumed by the NF service consumer. | EneNA | +| PacketFilterContent | 5.6.3.2 | Defines a packet filter for an IP flow. | | +| PacketFilterInfo | 5.6.2.30 | Contains the information from a single packet filter sent from the NF service consumer to the PCF. | | +| PartialSuccessReport | 5.6.2.33 | Includes the information reported by the NF service consumer when some of the PCC rules and/or session rules and/or policy decisions and/or condition data are not successfully installed/activated or stored. | | +| PccRule | 5.6.2.6 | Contains the PCC rule information. | | +| PduSessionRelCause | 5.6.3.24 | Contains the NF service consumer PDU Session release cause. | PDUSessionRelCause, ImmediateTermination | +| PolicyControlRequestTrigger | 5.6.3.6 | Contains the policy control request trigger(s). | | +| PolicyDecisionFailureCode | 5.6.3.28 | Indicates the type of the failed policy decision and/or condition data. | PolicyDecisionErrorHandlering | +| PortManagementContainer | 5.6.2.45 | Contains the port management information container for a port. | TimeSensitive Networking | +| QosCharacteristics | 5.6.2.16 | Contains QoS characteristics for a non-standardized or non-configured 5QI. | | +| QosData | 5.6.2.8 | Contains the QoS parameters. | | +| QosFlowUsage | 5.6.3.13 | Indicates a QoS flow usage information. | | +| QosMonitoringData | 5.6.2.40 | Contains QoS monitoring related control information. | QosMonitoring | +| QosMonitoringReport | 5.6.2.42 | Contains QoS monitoring reporting information. | QosMonitoring | +| QosNotificationControlInfo | 5.6.2.32 | Contains the QoS Notification Control Information. | | +| RanNasRelCause | 5.6.2.28 | Contains the RAN/NAS release cause. | RAN-NAS-Cause | +| RedirectAddressType | 5.6.3.12 | Indicates the redirect address type. | ADC | +| RedirectInformation | 5.6.2.13 | Contains the redirect information. | ADC | +| ReportingFrequency | 5.6.3.22 | Indicates the frequency for the reporting | QosMonitoring | +| ReportingLevel | 5.6.3.4 | Indicates the reporting level. | | +| RequestedQos | 5.6.2.31 | Contains the QoS information requested by the UE. | | +| RequestedQosMonitoringParameter | 5.6.3.21 | Indicates the requested QoS monitoring parameters to be measured. | QosMonitoring | +| RequestedRuleData | 5.6.2.24 | Contains rule data requested by the PCF to receive information associated with PCC rules. | | +| RequestedRuleDataType | 5.6.3.7 | Contains the type of rule data requested by the PCF. | | +| RequestedUsageData | 5.6.2.25 | Contains usage data requested by the PCF requesting usage reports for the corresponding usage monitoring data instances. | UMC | +| RuleOperation | 5.6.3.11 | Indicates a UE initiated resource operation that causes a request for PCC rules. | | +| RuleReport | 5.6.2.27 | Reports the status of PCC rule(s). | | +| RuleStatus | 5.6.3.8 | Indicates the status of PCC or session rule. | | +| ServingNfIdentity | 5.6.2.38 | Contains the serving Network Function identity. | | +| SessionRule | 5.6.2.7 | Contains session level policy information. | | +| SessionRuleFailureCode | 5.6.3.17 | Indicates the reason of the session rule failure. | SessionRuleErrorHandlering | +| SessionRuleReport | 5.6.2.37 | Reports the status of session rule. | SessionRuleErrorHandlering | +| SgsnAddress | 5.6.2.50 | Contains the serving SGSN address. | 2G3GIWK | +| SliceUsgCtrlInfo | 5.6.2.59 | Represents network slice usage control information. | NetSliceUsageCtrl | +| SmPolicyAssociationReleaseCause | 5.6.3.23 | Represents the cause why the PCF requests the termination of the SM policy association. | | +| SmPolicyControl | 5.6.2.2 | Contains the parameters to request the SM policies and the SM policies authorized by the PCF. | | +| SmPolicyContextData | 5.6.2.3 | Contains the parameters to create individual SM policy resource. | | + +| | | | | +|----------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| SmPolicyDecision | 5.6.2.4 | Contains the SM policies authorized by the PCF. | | +| SmPolicyNotification | 5.6.2.5 | Contains the update of the SM policies. | | +| SmPolicyDeleteData | 5.6.2.15 | Contains the parameters to be sent to the PCF when the individual SM policy is deleted. | | +| SmPolicyUpdateContextData | 5.6.2.19 | Contains the met policy control request trigger(s) and corresponding new value(s) or the error report of the policy enforcement. | | +| SteeringFunctionality | 5.6.3.18 | Indicates functionality to support traffic steering, switching and splitting determined by the PCF. | ATSSS | +| SteeringMode | 5.6.2.39 | Contains the steering mode value and parameters determined by the PCF. | ATSSS | +| SteerModeIndicator | 5.6.3.31 | Contains Autonomous load-balance indicator or UE-assistance indicator. | EnATSSS | +| SteerModeValue | 5.6.3.19 | Indicates the steering mode value determined by the PCF. | ATSSS | +| TerminationNotification | 5.6.2.21 | Termination Notification. | | +| ThresholdValue | 5.6.2.52 | Contains the threshold value(s) for RTT and/or Packet Loss Rate. | EnATSSS | +| TrafficControlData | 5.6.2.10 | Contains parameters determining how flows associated with a PCCRule are treated (blocked, redirected, etc). | | +| TrafficParaData | 5.6.2.56 | Contains Traffic Parameter(s) related control information. | PowerSaving | +| TrafficParameterMeas | 5.6.3.32 | Indicates the traffic parameters to be measured. | PowerSaving | +| TsnBridgeInfo | 5.6.2.41 | Contains parameters that describe and identify the TSC user plane node. | TimeSensitive Networking | +| TsnPortNumber | 5.6.3.2 | Contains a port number. | TimeSensitive Networking | +| UeCampingRep | 5.6.2.26 | Contains the current applicable values corresponding to the policy control request triggers. | | +| UeInitiatedResourceRequest | 5.6.2.29 | Indicates a UE requests specific QoS handling for selected SDF. | | +| UePolicyContainer | 5.6.3.2 | Contains a UE policy container | EpsUrsp | +| UpPathChgEvent | 5.6.2.20 | Contains the UP path change event subscription from the AF. | TSC | +| UrspEnforcementInfo | 5.6.3.2 | Contains the report of URSP rule(s) enforcement information as received from the UE. | URSPEnforcement | +| UsageMonitoringData | 5.6.2.12 | Contains usage monitoring related control information. | UMC | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_SMPolicyControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_SMPolicyControl service based interface. + +**Table 5.6.1-2: Npcf\_SMPolicyControl re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| 5GMmCause | 3GPP TS 29.571 [11] | Contains the cause value of 5GMM protocol. | RAN-NAS-Cause | +| 5Qi | 3GPP TS 29.571 [11] | Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501 [2]), within the range 0 to 255. | | +| 5QiPriorityLevel | 3GPP TS 29.571 [11] | Unsigned integer indicating the 5Qi Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501 [2]), within the range 1 to 127. Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 127 as the lowest priority. | | +| 5QiPriorityLevelRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "5QiPriorityLevel" data type, but with the OpenAPI "nullable: true" property. | | +| AccessType | 3GPP TS 29.571 [11] | The identification of the type of access network. | | +| AccessTypeRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "AccessType" data type, but with the OpenAPI "nullable: true" property. | ATSSS | +| Ambr | 3GPP TS 29.571 [11] | Session-AMBR. | | +| AnGwAddress | 3GPP TS 29.514 [17] | Carries the control plane address of the access network gateway. (NOTE 1) | | +| ApplicationChargingId | 3GPP TS 29.571 [11] | Application provided charging identifier allowing correlation of charging information. | AF_Charging_Identifier | +| ApplicationId | 3GPP TS 29.571 [11] | Application Identifier | UPEAS | +| Arp | 3GPP TS 29.571 [11] | ARP. | | +| AverWindow | 3GPP TS 29.571 [11] | Averaging Window. | | +| AverWindowRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "AverWindow" data type, but with the OpenAPI "nullable: true" property. | | +| BatOffsetInfo | 3GPP TS 29.514 [17] | Contains the offset of the BAT and the optionally adjusted periodicity. | EnTSCAC | +| BitRate | 3GPP TS 29.571 [11] | String representing a bit rate that shall be formatted as follows:

pattern: " \d+(\.\d+)? (bps Kbps Mbps Gbps Tbps)"
Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps". | | +| BitRateRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. | | +| Bytes | 3GPP TS 29.571 [11] | String with format "byte". | TimeSensitive Networking | +| ChargingId | 3GPP TS 29.571 [11] | Charging identifier allowing correlation of charging information. | | +| ContentVersion | 3GPP TS 29.514 [17] | Indicates the content version of a PCC rule. It uniquely identifies a version of the PCC rule as defined in clause 4.2.6.2.14. | RuleVersionin
g | +| DateTime | 3GPP TS 29.571 [11] | String with format "date-time" as defined in OpenAPI Specification [10]. | | +| DateTimeRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "DateTime" data type, but with the OpenAPI "nullable: true" property. | | +| DddTrafficDescriptor | 3GPP TS 29.571 [11] | Traffic Descriptor | DDNEventPolicyControl | +| DiDataDeliveryStatus | 3GPP TS 29.571 [11] | Downlink data delivery status. | DDNEventPolicyControl | +| DnaiChangeType | 3GPP TS 29.571 [11] | Describes the types of DNAI change. | | +| Dnn | 3GPP TS 29.571 [11] | The DNN the user is connected to. | | +| DnnSelectionMode | 3GPP TS 29.502 [22] | DNN selection mode. | DNNSelection
Mode | +| DurationSec | 3GPP TS 29.571 [11] | Identifies a period of time in units of seconds. | | + +| | | | | +|-------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| DurationSecRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. | | +| EasIpReplacementInfo | 3GPP TS 29.571 [11] | Contains EAS IP replacement information for a Source and a Target EAS. | EASIPreplacement | +| EthFlowDescription | 3GPP TS 29.514 [17] | Defines a packet filter for an Ethernet flow. (NOTE 2) | | +| ExtMaxDataBurstVol | 3GPP TS 29.571 [11] | Maximum Data Burst Volume. | EMDBV | +| ExtMaxDataBurstVolRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "ExtMaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property. | EMDBV | +| Metadata | 3GPP TS 29.571 [11] | This datatype contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | SFC | +| FinalUnitAction | 3GPP TS 32.291 [19] | Indicates the action to be taken when the user's account cannot cover the service cost. | | +| FlowStatus | 3GPP TS 29.514 [17] | Describes whether the IP flow(s) are enabled or disabled. The value "REMOVED" is not applicable to Npcf_SMPolicyControl service. | | +| FqdnPatternMatchingRule | 3GPP TS 29.571 [11] | Identifies the FQDN pattern matching rule. | HR-SBO | +| Gpsi | 3GPP TS 29.571 [11] | Identifies a GPSI. | | +| GroupId | 3GPP TS 29.571 [11] | Identifies a group of internal globally unique ID. | | +| Guami | 3GPP TS 29.571 [11] | Globally Unique AMF Identifier. | | +| InvalidParam | 3GPP TS 29.571 [11] | Invalid Parameters for the reported failed policy decisions | ExtPolicyDecisionErrorHandling | +| IpIndex | 3GPP TS 29.519 [15] | Information that identifies which IP pool or external server is used to allocate the IP address. | | +| IpAddr | 3GPP TS 29.571 [11] | Identifies an IP address. | HR-SBO | +| Ipv4Addr | 3GPP TS 29.571 [11] | Identifies an Ipv4 address. | | +| Ipv4AddrMask | 3GPP TS 29.571 [11] | String identifying an IPv4 address mask. | | +| Ipv6Addr | 3GPP TS 29.571 [11] | Identifies an IPv6 address. | | +| Ipv6Prefix | 3GPP TS 29.571 [11] | The Ipv6 prefix allocated for the user. | | +| MacAddr48 | 3GPP TS 29.571 [11] | MAC Address. | | +| MaxDataBurstVol | 3GPP TS 29.571 [11] | Maximum Data Burst Volume. | | +| MaxDataBurstVolRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "MaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property. | | +| NfInstanceId | 3GPP TS 29.571 [11] | The NF instance identifier. | | +| NfSetId | 3GPP TS 29.571 [11] | The NF set identifier. | | +| NgApCause | 3GPP TS 29.571 [11] | Contains the cause value of NgAP protocol. | RAN-NAS-Cause | +| NullValue | 3GPP TS 29.571 [11] | JSON's null value, used as an explicit value of an enumeration. | | +| NwdafEvent | 3GPP TS 29.520 [51] | Analytics ID consumed by the NF service consumer. | EneNA | +| PacketDelBudget | 3GPP TS 29.571 [11] | Packet Delay Budget. | | +| PacketErrRate | 3GPP TS 29.571 [11] | Packet Error Rate. | | +| PacketLossRateRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "PacketLossRate" data type, but with the OpenAPI "nullable: true" property. | | +| PcfUeCallbackInfo | 3GPP TS 29.571 [11] | Contains the PCF for the UE callback URI and SBA binding information, if available | AMInfluence | +| PduSessionId | 3GPP TS 29.571 [11] | The identification of the PDU session. | | +| PduSessionType | 3GPP TS 29.571 [11] | Indicate the type of a PDU session. | | +| PduSetQosParaRm | 3GPP TS 29.571 [11] | Represents the PDU Set level QoS parameters to be modified. | PDUSetHandling | +| Pei | 3GPP TS 29.571 [11] | The Identification of a Permanent Equipment. | | +| PeriodicityInfo | 3GPP TS 29.514 [17] | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | PowerSaving | + +| | | | | +|--------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| PlmnIdNid | 3GPP TS 29.571 [11] | The identification of the Network: The PLMN Identifier (the mobile country code and the mobile network code) or the SNPN Identifier (the PLMN Identifier and the NID). | | +| PresenceInfo | 3GPP TS 29.571 [11] | Contains the information which describes a Presence Reporting Area. | PRA | +| PresenceInfoRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "PresenceInfo" data type, but with the OpenAPI "nullable: true" property. | PRA | +| ProblemDetails | 3GPP TS 29.571 [11] | Contains a detailed information about an error. | | +| ProtoDesc | 3GPP TS 29.514 [17] | Represents Protocol description of the media flow | PDUSetHandling | +| QosNotifType | 3GPP TS 29.514 [17] | Indicates whether the GBR targets for the indicated SDFs are "NOT_GUARANTEED" or "GUARANTEED" again. | | +| QosResourceType | 3GPP TS 29.571 [11] | Indicates whether the resource type is GBR, delay critical GBR, or non-GBR. | | +| RatingGroup | 3GPP TS 29.571 [11] | Identifier of a rating group. | | +| RatType | 3GPP TS 29.571 [11] | The identification of the RAT type. | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| RedundantPduSessionInformation | 3GPP TS 29.502 [22] | Contains the Redundant PDU session information, i.e, the RSN and the PDU Session Pair ID. | URSPEnforcement | +| RouteToLocation | 3GPP TS 29.571 [11] | A traffic routes to applications location. | TSC | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [11] | Indicates the satellite backhaul category or non-satellite backhaul. | SatBackhaulCategoryChg | +| ServerAddressingInfo | 3GPP TS 29.571 [11] | Contains the Provisioning Server information that provisions the UE with credentials and other data to enable SNPN access. | PvsSupport | +| ServiceId | 3GPP TS 29.571 [11] | Identifier of a service. | | +| Snssai | 3GPP TS 29.571 [11] | Identifies the S-NSSAI. | | +| SscMode | 3GPP TS 29.571 [11] | Represents the service and session continuity mode. | URSPEnforcement | +| SubscribedDefaultQos | 3GPP TS 29.571 [11] | Subscribed Default QoS. | | +| Supi | 3GPP TS 29.571 [11] | The identification of the user (i.e. IMSI, NAI). | | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TraceData | 3GPP TS 29.571 [11] | | | +| TimeZone | 3GPP TS 29.571 [11] | Contains the user time zone information. | | +| TscailInputContainer | 3GPP TS 29.514 [17] | TSCAI Input information. | TimeSensitive Networking | +| TrafficCorrelationInfo | 3GPP TS 29.519 [15] | Contains the information for traffic correlation. | CommonEAS DNAI | +| UInteger | 3GPP TS 29.571 [11] | Unsigned Integer. | | +| UIntegerRm | 3GPP TS 29.571 [11] | This data type is defined in the same way as the "UInteger" data type, but with the OpenAPI "nullable: true" property. | EnATSSS, AF_latency | +| Uint16 | 3GPP TS 29.571 [11] | Unsigned 16-bit integers. | MTU_Size | +| Uint32 | 3GPP TS 29.571 [11] | Unsigned 32-bit integers. | MTU_Size | +| Uint64 | 3GPP TS 29.571 [11] | Unsigned 64-bit integers. | TimeSensitive Networking | +| UplinkDownlinkSupport | 3GPP TS 29.514 [17] | Represents whether a capability is supported for the UL, the DL or both UL and DL service data flows | L4S | +| Uri | 3GPP TS 29.571 [11] | URI. | | +| UserLocation | 3GPP TS 29.571 [11] | Contains the user location(s). | | +| Volume | 3GPP TS 29.122 [32] | Unsigned integer identifying a volume in units of bytes. | | +| VolumeRm | 3GPP TS 29.122 [32] | This data type is defined in the same way as the "Volume" data type, but with the OpenAPI "nullable: true" property. | | +| VplmnOffloadingInfo | 3GPP TS 29.571 [11] | VPLMN Specific Offloading Information. | HR-SBO | +| VplmnQos | 3GPP TS 29.502 [22] | QoS constraints in the VPLMN. | VPLMN-QoS-Control | + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: "AnGwAddress" data structure is only applicable to the 5GS and EPC/E-UTRAN interworking scenario as defined in Annex B.
NOTE 2: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 5.8 shall be supported. | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.6.2 Structured data types + +### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.6.2.2 Type SmPolicyControl + +**Table 5.6.2.2-1: Definition of type SmPolicyControl** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| context | SmPolicyContextData | M | 1 | Includes the parameters to request the SM policies by the NF service consumer. | | +| policy | SmPolicyDecision | M | 1 | Includes the SM policies authorized by the PCF. | | + +### 5.6.2.3 Type SmPolicyContextData + +**Table 5.6.2.3-1: Definition of type SmPolicyContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| accNetChld | AccNetChld | O | 0..1 | Indicates the access network charging identifier for the whole PDU session. For EPS interworking scenarios, it indicates the access network charging identifier for the default QoS flow / default EPS bearer or the whole PDU session. | | +| chargEntityAddr | AccNetChargingAddress | O | 0..1 | Address of the network entity performing charging. | | +| gpsi | Gpsi | O | 0..1 | Gpsi shall contain either an External Id or an MSISDN. | | +| supi | Supi | M | 1 | Subscription Permanent Identifier. (NOTE 2) | | +| invalidSupi | boolean | C | 0..1 | When this attribute is included and set to true, it indicates that the "supi" attribute contains an invalid value. This attribute shall be present if the SUPI is not available in the NF service consumer, or the SUPI is unauthenticated. When present it shall be set as follows:
- true: invalid SUPI.
- false (default): valid SUPI. | | +| pduSessionId | PduSessionId | M | 1 | PDU session Id. | | +| dnn | Dnn | M | 1 | The DNN of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 4) | | +| dnnSelMode | DnnSelectionMode | O | 0..1 | Indicates whether the requested DNN corresponds to an explicitly subscribed DNN. | DNNSelectionMode | +| interGrpIds | array(GroupId) | O | 1..N | The internal Group Id(s). | | +| notificationUri | Uri | M | 1 | Identifies the recipient of SM policies update notifications sent by the PCF. | | +| pduSessionType | PduSessionType | M | 1 | Indicates the type of a PDU session. | | +| accessType | AccessType | O | 0..1 | The Access Type where the served UE is camping. | | +| ratType | RatType | O | 0..1 | The RAT Type where the served UE is camping. | | +| addAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the combination of additional Access Type and RAT Type for MA PDU session. | ATSSS | +| servingNetwork | PlmnIdNid | O | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN the NID together with the PLMN ID identifies the SNPN. | | +| userLocationInfo | UserLocation | O | 0..1 | The location where the served UE is camping. (NOTE 3) | | +| ueTimeZone | TimeZone | O | 0..1 | The time zone where the served UE is camping. | | +| pei | Pei | O | 0..1 | The Permanent Equipment Identifier of the served UE. | | +| ipv4Address | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE. | | +| ipv6AddressPrefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE. | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 1) | | +| subsSessAmbr | Ambr | O | 0..1 | UDM subscribed or DN-AAA authorized Session-AMBR. | | +| authProfIndex | string | O | 0..1 | DN-AAA authorization profile index. | DN-Authorization | + +| | | | | | | +|-------------------------|-----------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| subsDefQos | SubscribedDefaultQos | O | 0..1 | Subscribed Default QoS Information. | | +| vplmnQos | VplmnQos | O | 0..1 | QoS constraints in a VPLMN. | VPLMN-QoS-Control | +| numOfPackFilter | integer | O | 0..1 | Contains the number of supported packet filter for signalled QoS rules. | | +| online | boolean | O | 0..1 | If it is included and set to true, the online charging is applied to the PDU session. | | +| offline | boolean | O | 0..1 | If it is included and set to true, the offline charging is applied to the PDU session. | | +| chargingCharacteristics | string | O | 0..1 | Contains the Charging Characteristics applied to the PDU session. Functional requirements for the Charging Characteristics are defined in 3GPP TS 32.255 [35] Annex A. The charging characteristics are encoded as specified in 3GPP TS 29.503 [34]. | | +| 3gppPsDataOffStatus | boolean | O | 0..1 | If it is included and set to true, the 3GPP PS Data Off is activated by the UE. | 3GPP-PS-Data-Off | +| refQosIndication | boolean | O | 0..1 | If it is included and set to true, the reflective QoS is supported by the UE. | | +| sliceInfo | Snssai | M | 1 | Identifies the S-NSSAI. | | +| qosFlowUsage | QosFlowUsage | O | 0..1 | Indicates the required usage for default QoS flow. | | +| servNfId | ServingNfIdentity | O | 0..1 | Contains the serving network function identity. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of Supported features used as described in clause 5.8. This parameter shall be supplied by the NF service consumer in the POST request that requested the creation of an individual SM policy resource. | | +| traceReq | TraceData | O | 0..1 | Trace control and configuration parameters information defined in 3GPP TS 32.422 [24]. | | +| smfId | NfInstanceId | O | 0..1 | SMF instance identifier. | | +| recoveryTime | DateTime | O | 0..1 | It includes the recovery time of the NF service consumer. | | +| maPduInd | MaPduIndication | O | 0..1 | Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed. | ATSSS | +| atsssCapab | AtsssCapability | O | 0..1 | Contains the ATSSS capability supported for the MA PDU Session. | ATSSS | +| ipv4FrameRouteList | array(Ipv4AddrMask) | O | 1..N | List of Framed Route information of IPv4. | | +| ipv6FrameRouteList | array(Ipv6Prefix) | O | 1..N | List of Framed Route information of IPv6. | | +| satBackhaulCategory | SatelliteBackhaulCategory | O | 0..1 | Indicates satellite backhaul category or non-satellite backhaul used for the PDU session. When this attribute is not present, non-satellite backhaul applies. If the "EnSatBackhaulCatChg" feature is supported, the different dynamic satellite backhaul categories may also be provided. | SatBackhaulCategoryChg | +| pcfUeInfo | PcfUeCallbackInfo | O | 0..1 | PCF for the UE callback URI and SBA binding information. | AMInfluence | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | Provisioning Server(s) information that provision the UE with credentials and other data to enable SNPN access. | PvsSupport | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| onboardInd | boolean | O | 0..1 | If it is included and set to true, it indicates that the PDU session is used for UE Onboarding. | PvsSupport | +| nwdafDatas | array(NwdafData) | O | 1..N | List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. | EneNA | +| urspEnfInfo | UrspEnforcementInfo | O | 0..1 | Contains the reporting of URSP rule(s) enforcement from the UE. | URSPEnforcement | +| sscMode | SscMode | C | 0..1 | SSC Mode of the PDU session. It shall be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| ueReqDnn | Dnn | O | 0..1 | UE requested DNN.

It shall be present, if available and different from the selected DNN, when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| redundantPduSessionInfo | RedundantPduSessionInformation | O | 0..1 | RSN and PDU session pair ID of the redundant PDU session.

It shall be present, if available, when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| hrsboInd | boolean | O | 0..1 | HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is supported. Default value is "false" if omitted. | HR-SBO | +| NOTE 1: The value provided in this attribute is implementation specific. The only constraint is that the NF service consumer shall supply a different identifier for each overlapping address domain (e.g. the SMF NF instance identifier). | | | | | | +| NOTE 2: For an emergency session, when the SUPI is not available in the NF service consumer, or if available, the SUPI is unauthenticated, the value provided in the "supi" attribute is implementation specific. | | | | | | +| NOTE 3: The SMF may encode both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute. | | | | | | +| NOTE 4: The PCF uses the DNN as received from the NF service consumer without applying any transformation (e.g. in subsequent requests to the UDR). To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. | | | | | | + +## 5.6.2.4 Type SmPolicyDecision + +**Table 5.6.2.4-1: Definition of type SmPolicyDecision** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| sessRules | map(SessionRule) | O | 1..N | A map of Sessionrules with the content being the SessionRule as described in clause 5.6.2.7. The key used in this map for each entry is the sessRuleId attribute of the corresponding SessionRule. (NOTE 2) | | +| pccRules | map(PccRule) | O | 1..N | A map of PCC rules with the content being the PCCRule as described in clause 5.6.2.6. The key used in this map for each entry is the pccRuleId attribute of the corresponding PccRule. | | +| qosDecs | map(QosData) | O | 1..N | Map of QoS data policy decisions. The key used in this map for each entry is the qosId attribute of the corresponding QosData. (NOTE 2) | | +| chgDecs | map(ChargingData) | O | 1..N | Map of Charging data policy decisions. The key used in this map for each entry is the chgId attribute of the corresponding ChargingData. | | +| chargingInfo | ChargingInformation | C | 1 | Contains the CHF addresses, and if available, the associated CHF instance ID(s) and CHF set ID(s) of the PDU session. (NOTE 3) | | +| traffContDecs | map(TrafficControlData) | O | 1..N | Map of Traffic Control data policy decisions. The key used in this map for each entry is the tcId attribute of the corresponding TrafficControlData. (NOTE 2) | | +| umDecs | map(UsageMonitoringData) | O | 1..N | Map of Usage Monitoring data policy decisions. The key used in this map for each entry is the umId attribute of the corresponding UsageMonitoringData. | UMC | +| qosChars | map(QosCharacteristics) | O | 1..N | Map of QoS characteristics for non-standard 5QIs and non-preconfigured 5QIs. This map uses the 5QI values as keys. (NOTE 2) | | +| qosMonDecs | map(QosMonitoringData) | O | 1..N | Map of QoS Monitoring data policy decision. The key used in this map for each entry is the qmId attribute of the corresponding QosMonitoringData. | QosMonitoring | +| reflectiveQoSTimer | DurationSec | O | 0..1 | Defines the lifetime of a UE derived QoS rule belonging to the PDU Session for reflective QoS. (NOTE 2) | | +| offline | boolean | O | 0..1 | Indicates the offline charging is applicable to the PDU session when it is included and set to true. (NOTE 3) (NOTE 4) (NOTE 6) | | +| online | boolean | O | 0..1 | Indicates the online charging is applicable to the PDU session when it is included and set to true. (NOTE 3) (NOTE 4) (NOTE 6) | | +| offlineChOnly | boolean | O | 0..1 | Indicates that the online charging method shall never be used for any PCC rule activated during the lifetime of the PDU session, when this attribute is present and set to "true". The default value is "false", e.g. if this attribute is omitted. (NOTE 3) (NOTE 4) (NOTE 6) | OfflineChOnly | + +| | | | | | | +|-----------------------|------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| conds | map(ConditionData) | O | 1..N | A map of condition data with the content being as described in clause 5.6.2.9. The key used in this map for each entry is the condId attribute of the corresponding ConditionData. | | +| revalidationTime | DateTime | O | 0..1 | Defines the time before which the NF service consumer shall have to re-request PCC rules. | | +| pcscfRestIndication | boolean | O | 0..1 | If this attribute is included and set to true, it indicates that P-CSCF Restoration is requested. The default value "FALSE" applies if the attribute is not present and has not been supplied previously. | PCSCF-Restoration-Enhancement | +| policyCtrlReqTriggers | array(PolicyControlRequestTrigger) | O | 1..N | Defines the policy control request triggers subscribed by the PCF. | | +| lastReqRuleData | array(RequestedRuleData) | O | 1..N | Defines the last list of rule control data requested by the PCF. | | +| lastReqUsageData | RequestedUsageData | O | 0..1 | Indicates whether the last accumulated usage report is requested by the PCF or not, and includes references to the targeted usage monitoring data instances. | UMC | +| pralInfos | map(PresenceInfoRm) | O | 1..N | Defines the PRA information provisioned by the PCF. The "pralId" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall not be supplied. | PRA | +| ipv4Index | lpIndex | C | 0..1 | Information that identifies the IP address allocation method for IPv4 address allocation. (NOTE 3) | | +| ipv6Index | lpIndex | C | 0..1 | Information that identifies the IP address allocation method for IPv6 address allocation. (NOTE 3) | | +| qosFlowUsage | QosFlowUsage | O | 0..1 | Indicates the required usage for default QoS flow. | | +| relCause | SmPolicyAssociationReleaseCause | O | 0..1 | The cause for which the PCF requests the termination of the policy association. | RespBasedSessionRel | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features. This parameter shall be supplied by the PCF in the response to the POST request that requested the creation of an individual SM policy resource. | | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information | TimeSensitive Networking | +| tsnPortManContDs tt | PortManagementContainer | O | 0..1 | Transports port management information for the DS-TT port. | TimeSensitive Networking | +| tsnPortManContNw tts | array(PortManagementContainer) | O | 1..N | Transports port management information for one or more NW-TT ports. | TimeSensitive Networking | +| tscNotifUri | Uri | O | 0..1 | For PMIC/UMIC UPF event, notification target address of the TSCTSF or TSN AF receiving the TSC management information. | ExposureToTSC | +| tscNotifCorrelId | string | C | 0..1 | Correlation identifier for TSC management information notifications. It shall be provided if the "tscNotifUri" attribute is provided. | ExposureToTSC | + +| | | | | | | +|-------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| redSessIndication | boolean | O | 0..1 | Indicates whether the PDU Session is a redundant PDU session:
true: end to end redundant PDU session;
false: Not end to end redundant PDU session;
If this attribute is absent it means the PDU session is not an end to end redundant PDU session.
(NOTE 2) (NOTE 3) | Dual-Connectivity-redundant-UP-paths | +| uePolCont | UePolicyContainer | O | 0..1 | Indicates a UE policy container for the UE. Only applicable to the 5GS and EPC interworking scenario as defined in Annex B. | EspUrsp | +| vpImnOffload | VpImnOffloadingInfo | O | 0..1 | Indicates the VPLMN Specific Offloading Policy. | HR-SBO | +| sliceUsgCtrlInfo | SliceUsgCtrlInfo | O | 0..1 | Represents the network slice usage control information (e.g., slice PDU Session inactivity timer value) to be used to support and enforce network slice usage control. | NetSliceUsageCtrl | + +NOTE 1: For IPv4v6 PDU session, both the "ipv4Index" attribute and "ipv6Index" attribute may be provisioned by the PCF. + +NOTE 2: This attribute shall not be removed if it was provisioned. + +NOTE 3: This attribute may only be supplied by the PCF in the response to the initial POST request that requested the creation of an individual SM policy resource. + +NOTE 4: If both the "offline" attribute and the "online" attribute are omitted by the PCF, and when the "OfflineChOnly" feature is supported, if the "offlineChOnly" attribute is set to "false" or omitted by the PCF, the default charging method pre-configured at the SMF, if available, shall be applied to the PDU session. If both offline and online charging methods are pre-configured at the SMF, the SMF shall determine which one of them to be applied to the PDU session based on local policy. The "offline" attribute and the "online" attribute shall not be simultaneously present with the same value, i.e., both set to true or both set to false. + +NOTE 5: If the "chargingInfo" attribute is not supplied by the PCF, the charging information configured at the SMF shall be applied to the PDU session. + +NOTE 6: When the "OfflineChOnly" feature is supported and the "offlineChOnly" attribute is present and set to "true", the "online" attribute and the "offline" attribute shall not be present. + +### 5.6.2.5 Type SmPolicyNotification + +**Table 5.6.2.5-1: Definition of type SmPolicyNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual SM policy resource related to the notification.
(NOTE) | | +| smPolicyDecision | SmPolicyDecision | M | 1 | Session management policy decision (see clause 5.6.2.4). | | + +NOTE: Either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute can be used by the SMF for the identification of the individual SM policy resource related to the notification. + +## 5.6.2.6 Type PccRule + +**Table 5.6.2.6-1: Definition of type PccRule** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| flowInfos | array(FlowInformation) | C | 1..N | An array of Ethernet or IP flow filter information. (NOTE 3) | +| appId | string | C | 0..1 | A reference to the application detection filter configured at the UE. (NOTE 3) | +| appDescriptor | ApplicationDescriptor | C | 0..1 | ATSSS rule application descriptor shall be present when the PDN session is a MA PDN session. SDF template contains an App Identifier (i.e. when the "appId" attribute is present). | +| contVer | ContentVersion | O | 0..1 | Indicates the content version of the PCC rule. | +| pccRuleId | string | M | 1 | Univocally identifies the PCC rule within a PDN session. | +| precedence | UInteger | O | 0..1 | Determines the order in which the PCC rule is applied relative to other PCC rules within the same PDN session. It shall be included if the "flowInfos" attribute is included and may be included if the "appId" attribute is included when the initially provisions the PCC rule. (NOTE 2) (NOTE 4) | +| afSigProtocol | AfSigProtocol | O | 0..1 | Indicates the protocol used for signalling between the UE and the AF. The default value "NO_INFORMATION" shall apply if the attribute is not present and has not been supplied previously. | +| appReloc | boolean | O | 0..1 | It indicates that the application cannot be relocated once a location of the application is selected by the 5GC when it is included and set to "true". Indication of application relocation possibility. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | +| easRedisInd | boolean | O | 0..1 | Indicates the EAS rediscovery required for the application if it is included and set to "true". Default value is "false" if omitted. The indication shall be invalid if it was applied unless it is provided again. | +| addrPreserInd | boolean | O | 0..1 | Indicates whether UE IP address should be preserved. This attribute shall set to "true" if preserved, otherwise, set to "false". The default value "false" shall apply if the attribute is not present and has not been supplied previously. | +| refQosData | array(string) | O | 1..N | A reference to the QosData profile type decision type. It is the qosData described in clause 5.6.2.8. (NOTE 1) | + +| | | | | | +|---------------------|---------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| refAltQosParameters | array(string) | O | 1..N | A Reference to the QoS Data decisions for the Alternative QoS parameter sets of the service flow. Only the "qosId" attribute, the "gbrUI" attribute, the "gbrDI" attribute, the "packetDelayBudget" attribute and the "packetErrorRate" attribute are applicable within the associated QoSData data types. This attribute represents an ordered list, where lower the index of the array for a given entry, the higher the priority. | +| refTcData | array(string) | O | 1..N | A reference to the TrafficControl policy decision type. It is the type described in clause 5.6.2.10. (NOTE 1) | +| refChgData | array(string) | O | 1..N | A reference to the ChargingData policy decision type. It is the type described in clause 5.6.2.11. (NOTE 1) (NOTE 7) | +| refChgN3gData | array(string) | O | 1..N | A reference to the ChargingData policy decision type only applicable for Non-3GPP access. It is the type described in clause 5.6.2.11. (NOTE 1) (NOTE 5) (NOTE 7) | +| refUmData | array(string) | O | 1..N | A reference to UsageMonitoring policy decision type. It is the type described in clause 5.6.2.12. (NOTE 1) | +| refUmN3gData | array(string) | O | 1..N | A reference to UsageMonitoring policy decision type only applicable for Non-3GPP access. It is the type described in clause 5.6.2.12. (NOTE 1) (NOTE 6) | +| refCondData | string | O | 0..1 | A reference to the condition data described in clause 5.6.2.9. | +| refQosMon | array(string) | O | 1..N | A reference to QosMonitoring policy decision type. It is the type described in clause 5.6.2.40. (NOTE 1) | +| protoDesc | ProtoDesc | O | 0..1 | Protocol description for PDU session identification and/or detection of end of data burst in UPF | +| tscaiInputUI | TscailInputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE (uplink flow direction). (NOTE 9) | +| tscaiInputDI | TscailInputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress of the NW-TT (downlink flow direction). (NOTE 9) | +| tscaiTimeDom | UInteger | O | 0..1 | Indicates the (g)PTP domain where the (TSN)AF is located in. | +| capBatAdaptation | boolean | O | 0..1 | Indicates the capability for AF to adjust the burst sending time, if provided and set to "true". The default value is "false" if not present. (NOTE 9) | +| ddNotifCtrl | DownlinkDataNotificationControl | O | 0..1 | The Downlink Data Notification Control applying to the control of DDD Status event notification and DDN Failure event notification attribute shall not be present if the DDNEventPolicyControl2 is supported. | + +| | | | | | | +|--|-----------------|-----------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | ddNotifCtrl2 | DownlinkDataNotificationControlRm | O | 0..1 | The Downlink Data Notification Control applying to the control DDD Status event notification DDN Failure event notification including the removal of providing the downlink data notification information. | +| | disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN changes in the fulfilled QoS status when it is included and set to true. The fulfilled situation is either a QoS profile or an Alternative QoS Profile. The default value "false" apply, if the attribute is not present and has not been supplied previously. | +| | packFiltAllPrec | UInteger | C | 0..1 | Determines the order of TFT packet filter allocation for PCC rules. (NOTE 8) | +| | nscSuppFeats | map(SupportedFeatures) | O | 1..N | A map of Network Function Service Consumer features supported service. The key used in this map for each entry is the ServiceName as defined in 3GPP TS 29.511 (e.g. for Nsmf_EventExposure the key shall be set to nsmf-event-exposure). | +| | callInfo | CallInfo | O | 0..1 | Indicates the caller and the call information. | +| | traffParaData | TrafficParaData | O | 0..1 | Traffic Parameter measurements | + +introduced for future compatibility. In this release of the specification the maximum number of the array is 1. + +With the "appld" attribute, the precedence can be preconfigured in SMF or provided in the PCF. The precedence provided by the PCF shall take precedence. + +"infos" attribute or "appld" attribute shall be supplied by the PCF when the PCC rule is initially. If the "appld" attribute is supplied, the PCF shall not modify the application identifier supplied in the "appld" attribute later. + +"precedence" attribute is used to specify the precedence of the PCC rule among all PCC rules within the PDU session. It includes an integer value in the range from 0 to 255 (decimal). The value of the "precedence" attribute, the lower the precedence of that PCC rule is. The precedence from 70 to 99 (decimal) shall be used for the PCC rules subject to Reflective QoS. + +Session, Charging Data decision referred by the "refChgData" attribute applies to both 3GPP and non-3GPP access. If there is no "refChgN3gData" attribute included, the Charging Data decision referred by the "refChgData" attribute applies to non-3GPP access and the Charging Data decision referred by the "refChgData" attribute applies to 3GPP access. The value(s) of the "chglD" attribute referred by the "refChgN3gData" shall be the same as the one(s) within the Charging Data decision referred by the "refChgData". + +Session, Usage Monitoring Data decision referred by the "refUmData" attribute applies to both 3GPP and non-3GPP access. If there is no "refUmN3gData" attribute included, the Usage Monitoring Data decision referred by the "refUmData" attribute applies to non-3GPP access and the Usage Monitoring Data decision referred by the "refUmData" attribute applies to 3GPP access. + +If the "refChgData" attribute and/or "refChgN3gData" attribute is/are provisioned for a PCC rule, then this PCC rule shall not be subject to charging accordingly. If the "refChgData" attribute and/or "refChgN3gData" attribute is set to NULL for a PCC rule, then charging shall be deactivated accordingly for this PCC rule. If the AllocPrecedence feature is supported, the packFiltAllPrec attribute shall be present in every PDU Session when the PCC rule is installed for the first time. + +"tscailTimeWnd" attribute, within the "tscailInputUI" and/or "tscailInputDI" attributes, and the "tscailOutputUI" attribute are mutually exclusive. + +## 5.6.2.7 Type SessionRule + +**Table 5.6.2.7-1: Definition of type SessionRule** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| authSessAmbr | Ambr | C | 0..1 | Authorized Session-AMBR. (NOTE 1) | | +| authDefQos | AuthorizedDefaultQos | C | 0..1 | Authorized default QoS information. (NOTE 1) | | +| sessRuleId | string | M | 1 | Univocally identifies the session rule within a PDU session. | | +| refUmData | string | O | 0..1 | A reference to UsageMonitoringData policy decision type. It is the umId described in clause 5.6.2.12. (NOTE 2) | UMC | +| refCondData | string | O | 0..1 | A reference to the condition data. It is the condId described in clause 5.6.2.9. | | +| refUmN3gData | string | O | 0..1 | A reference to UsageMonitoringData policy decision type to apply for Non-3GPP access. It is the umId described in clause 5.6.2.12. (NOTE 2) | UMC, ATSSS | + +NOTE 1: When the "subsDefQos" and "subsSessAmbr" are provided to the PCF, the PCF shall provide both "authSessAmbr" and the "authDefQos" attributes the first time the session rule is provisioned. In this case, the PCF shall ensure that a session rule enforced in the SMF contains the "authSessAmbr" and the "authDefQos" attributes. + +NOTE 2: For a MA PDU session, if the "refUmN3gData" is omitted, the attribute "refUmData" contains the reference to the UsageMonitoringData policy decision to apply for both, 3GPP and Non-3GPP, accesses. + +## 5.6.2.8 Type QosData + +**Table 5.6.2.8-1: Definition of type QosData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| qosId | string | M | 1 | Univocally identifies the QoS control policy data within a PDU session. | | +| 5qi | 5Qi | C | 0..1 | Identifier for the authorized QoS parameters for the service data flow. It shall be included when the QoS data decision is initially provisioned and "defQosFlowIndication" is not included or is included and set to false. | | +| maxbrUI | BitRateRm | O | 0..1 | Indicates the maximum bandwidth in uplink. | | +| maxbrDI | BitRateRm | O | 0..1 | Indicates the maximum bandwidth in downlink. | | +| gbrUI | BitRateRm | O | 0..1 | Indicates the guaranteed bandwidth in uplink. (NOTE 3) | | +| gbrDI | BitRateRm | O | 0..1 | Indicates the guaranteed bandwidth in downlink. (NOTE 3) | | +| arp | Arp | C | 1 | Indicates the allocation and retention priority. It shall be included when the QoS data decision is initially provisioned and "defQosFlowIndication" is not included or is included and set to false. | | +| qnc | boolean | O | 0..1 | 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. The default value "FALSE" is used if this attribute is not present and has not been supplied previously. (NOTE 3) | | +| reflectiveQos | boolean | O | 0..1 | Indicates whether the QoS information is reflective for the corresponding non-GBR service data flow. The default value "FALSE" is used if this attribute is not present and has not been supplied previously. | | +| sharingKeyDI | string | O | 0..1 | Indicates, by containing the same value, what PCC rules may share resources in the downlink direction. | ResShare | +| sharingKeyUI | string | O | 0..1 | Indicates, by containing the same value, what PCC rules may share resources in the uplink direction. | ResShare | +| priorityLevel | 5QiPriorityLevelRm | O | 0..1 | Indicates a priority in scheduling resources among QoS Flows. (NOTE 1) | | +| averWindow | AverWindowRm | O | 0..1 | Represents the duration over which the guaranteed and maximum bitrates shall be calculated. (NOTE 1) (NOTE 3) | | +| maxDataBurstVol | MaxDataBurstVolRm | O | 0..1 | Denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB. (NOTE 1, NOTE 2) | | +| maxPacketLossRateDI | PacketLossRateRm | O | 0..1 | Indicates the maximum downlink packet loss rate for that can be tolerated for the service data flow. | RAN-Support-Info | +| maxPacketLossRateUI | PacketLossRateRm | O | 0..1 | Indicates the maximum uplink packet loss rate that can be tolerated for the service data flow. | RAN-Support-Info | +| defQosFlowIndication | boolean | O | 0..1 | Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule. The default value "FALSE" is used if this attribute is not present and has not been supplied previously. | | + +| | | | | | | +|--------------------|----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| extMaxDataBurstVol | ExtMaxDataBurstVolRm | O | 0..1 | Denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB. (NOTE 1, NOTE 2) | EMDBV | +| packetDelayBudget | PacketDelBudget | O | 0..1 | Unsigned integer. It indicates the Packet Delay Budget expressed in milliseconds. | AuthorizationWithRequiredQoS | +| packetErrorRate | PacketErrRate | O | 0..1 | String indicating the packet error rate. Examples:
Packet Error Rate $4 \times 10^{-6}$ shall be encoded as "4E-6".
Packet Error Rate $10^{-2}$ shall be encoded as "1E-2". | AuthorizationWithRequiredQoS | +| pduSetQoS | PduSetQoSParaRm | O | 0..1 | Contains the PDU Set QoS Parameters which are used to support PDU Set based QoS handling. | PDUSetHandling | + +NOTE 1: Applicable only when a value different from the standardized value for this 5QI, provided in table 5.7.4-1 3GPP TS 23.501 [2], is required. + +NOTE 2: Either the maxDataBurstVol attribute or the extMaxDataBurstVol attribute may be present for a Delay Critical GBR QoS flow. If the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurstVol attribute is used. If the EMDBV feature is supported by both the PCF and the SMF, the extMaxDataBurstVol attribute is used to transmit the maximum data burst volume values higher than 4095 Bytes (see clause 4.2.2.1). + +NOTE 3: This attribute is only applicable to GBR type or delay critical GBR type 5QIs. + +Editor's note: Based on the progress of SA2, it is FFS whether PDU Set QoS parameters are defined within PccRule data type instead of within QosData. + +### 5.6.2.9 Type ConditionData + +**Table 5.6.2.9-1: Definition of type ConditionData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------|---|-------------|------------------------------------------------------------------------------------------|---------------------| +| condId | string | M | 1 | Uniquely identifies the condition data within a PDU session. | | +| activationTime | DateTimeRm | O | 0..1 | The time when the decision data shall be activated. | | +| deactivationTime | DateTimeRm | O | 0..1 | The time when the decision data shall be deactivated. (NOTE 1) | | +| accessType | AccessType | O | 0..1 | The condition of access type of the UE when the session AMBR shall be enforced. (NOTE 2) | AccessTypeCondition | +| ratType | RatType | O | 0..1 | The condition of RAT type of the UE when the session AMBR shall be enforced. (NOTE 2) | AccessTypeCondition | + +NOTE 1: It is only included in the ConditionData instance for conditioned PCC rule. + +NOTE 2: At least one of the "accessType" or "ratType" attributes shall be present in an access type conditioned session rule. + +## 5.6.2.10 Type TrafficControlData + +**Table 5.6.2.10-1: Definition of type TrafficControlData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| tcId | string | M | 1 | Univocally identifies the traffic control policy data within a PDU session. | | +| l4sInd | UplinkDownlinkSupport | O | 0..1 | When provided, it represents an explicit indication of whether ECN marking for L4S support is supported for the UL, the DL or both, UL and DL. | L4S | +| flowStatus | FlowStatus | O | 0..1 | Enum determining what action to perform on traffic. Possible values are: [enable, disable, enable_uplink, enable_downlink]. The default value "ENABLED" shall apply, if the attribute is not present and has not been supplied previously. (NOTE 3) | | +| redirectInfo | RedirectInformation | O | 0..1 | It indicates whether the detected application traffic should be redirected to another controlled address. | ADC | +| addRedirectInfo | array(RedirectInformation) | O | 1..N | Additional redirection information. Each element indicates whether the detected application traffic should be redirected to another controlled address. | ADCmultiRedirection | +| muteNotif | boolean | O | 0..1 | Indicates whether application's start or stop notifications are to be muted. It shall be set to true to indicate application's start or stop notifications are muted. When it is set to false, it indicates application's start or stop notifications are not muted. The default value false shall apply, if the attribute is not present and has not been supplied previously. | ADC | +| trafficSteeringPolldDI (NOTE 1) | string | O | 0..1 | Reference to a pre-configured traffic steering policy for downlink traffic at the SMF. | TSC | +| trafficSteeringPolldUI (NOTE 1) | string | O | 0..1 | Reference to a pre-configured traffic steering policy for uplink traffic at the SMF. | TSC | +| metadata | Metadata | O | 0..1 | This datatype contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. May be only provided when "trafficSteeringPolldDI" and/or "trafficSteeringPolldUI" are provided for the first time. | SFC | +| routeToLocs (NOTE 1) | array(RouteToLocation) | O | 1..N | A list of location(s) to which the traffic shall be routed for the AF request. | TSC | +| maxAllowedUpLat | UIntegerRm | O | 0..1 | Indicates the target user plane latency in units of milliseconds. The SMF may use this value to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value. | AF_latency | +| easIpReplaceInfos | array(EasIpReplacementInfo) | O | 1..N | Contains EAS IP replacement information. | EASIPreplacement | +| traffCorreInd | boolean | O | 0..1 | Indication of traffic correlation. If it is included and set to "true", traffic should be correlated; The default value "false" applies, if the attribute is not present and has not been supplied previously. (NOTE 2) | | +| ttcCorreInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEAS DNAI | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity temporarily maintained for the source and target PSA. If it is included and set to "true", temporary simultaneous connectivity should be kept. The default value "false" applies, if the attribute is not present and has not been supplied previously. | SimultConnectivity | +| simConnTerm | DurationSec | C | 0..1 | Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure. It may be included when the "simConnInd" attribute is set to true. | SimultConnectivity | +| upPathChgEvent | UpPathChgEvent | O | 0..1 | Contains the information about the AF subscription to UP path change events. | TSC | +| steerFun | SteeringFunctionality | O | 0..1 | Indicates the applicable traffic steering functionality. | ATSSS | +| steerModeDI | SteeringMode | O | 0..1 | Determines the traffic distribution rule across 3GPP and Non-3GPP accesses to apply for downlink traffic. | ATSSS | +| steerModeUI | SteeringMode | O | 0..1 | Determines the traffic distribution rule across 3GPP and Non-3GPP accesses to apply for uplink traffic. | ATSSS | +| mulAccCtrl | MulticastAccessControl | O | 0..1 | Indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed. The default value "NOT_ALLOWED" applies, if the attribute is not present and has not been supplied previously. | WWC | +| candDnaiInd | boolean | O | 0..1 | Indication of reporting candidate DNAI(s). If it is included and set to "true", the candidate DNAI(s) for the PDU session need to be reported. Otherwise set to "false" or omitted. | CommonEAS DNAI | +| datEndMarkInd | boolean | O | 0..1 | The data burst end marking is enabled if it is set to "true". Default value is "false" if omitted. | PowerSaving | +| NOTE 1: If SFC feature is not supported, traffic steering policy identifier(s) (i.e. "trafficSteeringPolldDI" attribute and/or "trafficSteeringPolldUI" attribute) and N6 traffic routing requirements (i.e. "routeToLocs" attribute) are mutually exclusive; otherwise, they can be provided simultaneously. | | | | | | +| NOTE 2: The TSC feature shall be supported in order to support this attribute. The Indication of traffic correlation shall be provided only when all the PDU sessions related to the 5G VN group member UEs should be correlated by a common DNAI in the user plane for the traffic as described in 3GPP TS 23.501 [2], clause 5.6.7.1 and clause 5.29. | | | | | | +| NOTE 3: The "flowStatus" attribute and the "mulAccCtrl" attribute are mutually exclusive. | | | | | | + +## 5.6.2.11 Type ChargingData + +**Table 5.6.2.11-1: Definition of type ChargingData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| chgId | string | M | 1 | Univocally identifies the charging control policy data within a PDU session. | | +| meteringMethod | MeteringMethod | O | 0..1 | Defines what parameters shall be metered for offline charging. If the attribute is not present but it has been supplied previously, the previous information remains valid. If the attribute is not present and it has not been supplied previously or the attribute has been supplied previously but the attribute is set to NULL, the metering method pre-configured at the SMF is applicable as default metering method. | | +| offline | boolean | O | 0..1 | Indicates the offline charging is applicable to the PCC rule when it is included and set of true. (NOTE 1) | | +| online | boolean | O | 0..1 | Indicates the online charging is applicable to the PCC rule when it is included and set of true. (NOTE 1, NOTE 5) | | +| sdfHandl | boolean | O | 0..1 | Indicates whether the service data flow is allowed to start while the SMF is waiting for the response to the credit request. The default value "FALSE" (blocking) shall apply, if the attribute is not present. (NOTE 2) | | +| ratingGroup | RatingGroup | C | 0..1 | The charging key for the PCC rule used for rating purposes. It shall be included when the ChargingData policy decision is initially provisioned. | | +| reportingLevel | ReportingLevel | O | 0..1 | Defines on what level the SMF reports the usage for the related PCC rule. If the attribute is not present but it has been supplied previously, the previous information remains valid. If the attribute is not present and it has not been supplied previously or the attribute has been supplied previously but it is set to NULL, the reporting level pre-configured at the SMF is applicable as default reporting level. | | +| serviceId | ServiceId | O | 0..1 | Indicates the identifier of the service or service component the service data flow in a PCC rule relates to. | | +| sponsorId | string | O | 0..1 | Indicates the sponsor identity. | SponsoredConnectivity | +| appSvcProvId | string | O | 0..1 | Indicates the application service provider identity. | SponsoredConnectivity | +| afChargingIdentifier | ChargingId | C | 0..1 | An identifier, provided from the AF, correlating the measurement for the Charging key/Service identifier values in this PCC rule with application level reports. (NOTE 4) | | +| afChargId | ApplicationChargingId | O | 0..1 | A character string identifier, provided from the AF, correlating the measurement for the Charging key/Service identifier values in this PCC rule with application level reports. (NOTE 3) | AF_Charging_Identifier | + +| | | +|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The absence of both the "offline" attribute and "online" attribute or only one attribute is present and set to false within a Charging Data decision instance indicates that the default charging method of the PDU session is applicable to the PCC rule referring to the Charging Data decision. Either "offline" attribute or "online" attribute set to true shall be provisioned initially if there is no default charging method applied to the PDU session. The "offline" attribute and the "online" attribute shall not be simultaneously present with the same value, i.e. both set to "true" or both set to "false". | +| NOTE 2: | The "sdfHandl" attribute shall not be present when the online charging method does not apply for the PCC rule referring to the Charging Data decision (i.e., when the "online" attribute is present and set to false, or is absent and the online default charging method does not apply for the PDU session, or is absent and there is no online default charging method defined). | +| NOTE 3: | The "afChargId" attribute shall be used instead of the "afChargingIdentifier" attribute when the "AF_Charging_Identifier" feature is supported. | +| NOTE 4: | The "afChargingIdentifier" attribute shall not be present when the "AF_Charging_Identifier" feature is supported. When the "AF_Charging_Identifier" feature is not supported it is out of the scope of the specification what the behaviour of the PCF is when the AF provides charging identifier values that are out of ChargingId data type value range. | +| NOTE 5: | When the "OfflineChOnly" feature is supported and the "offlineChOnly" attribute is present and set to "true" within the SmPolicyDecision data structure, then the "online" attribute shall not be present. | + +## 5.6.2.12 Type UsageMonitoringData + +**Table 5.6.2.12-1: Definition of type UsageMonitoringData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| umId | string | M | 1 | Contains the Usage Monitoring ID, which univocally identifies the usage monitoring policy data instance within a PDU session.
(NOTE) | | +| volumeThreshold | VolumeRm | O | 0..1 | Indicates the total volume threshold. | | +| volumeThresholdUplink | VolumeRm | O | 0..1 | Indicates a volume threshold in uplink. | | +| volumeThresholdDownlink | VolumeRm | O | 0..1 | Indicates a volume threshold in downlink. | | +| timeThreshold | DurationSecRm | O | 0..1 | Indicates a time threshold. | | +| monitoringTime | DateTimeRm | O | 0..1 | Indicates the time at which the UP function is expected to reapply the next thresholds (e.g. nextVolThreshold). | | +| nextVolThreshold | VolumeRm | C | 0..1 | Indicates a volume threshold after the Monitoring Time. | | +| nextVolThresholdUplink | VolumeRm | O | 0..1 | Indicates a volume threshold in uplink after the Monitoring Time. | | +| nextVolThresholdDownlink | VolumeRm | O | 0..1 | Indicates a volume threshold in downlink after the Monitoring Time. | | +| nextTimeThreshold | DurationSecRm | C | 0..1 | Indicates a time threshold after the Monitoring Time. | | +| inactivityTime | DurationSecRm | O | 0..1 | Defines the period of time after which the time measurement shall stop, if no packets are received. | | +| exUsagePccRuleIds | array(string) | C | 1..N | Contains the PCC rule identifier(s) corresponding to service data flow(s) that shall be excluded from PDU Session usage monitoring. It is only included in the UsageMonitoringData instance for session level usage monitoring. | | + +NOTE: A Usage Monitoring ID corresponds to a valid Monitoring Key. + +### 5.6.2.13 Type RedirectInformation + +**Table 5.6.2.13-1: Definition of type RedirectInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| redirectEnabled | boolean | C | 0..1 |

This attribute indicates whether the redirect instruction is enabled. It shall be included and set to true when the redirect instruction is provisioned initially within a PCC rule.

Subsequently:

  • - It may be included to disable or re-enable the redirect instruction.
  • - Otherwise, if the attribute is omitted, the previous value shall apply.
| | +| redirectAddressType | RedirectAddressType | O | 0..1 | Indicates the type of redirect address contained within the "redirectServerAddress" attribute. | | +| redirectServerAddress | string | O | 0..1 |

Indicates the address of the redirect server.

  • - If the "redirectAddressType" attribute indicates "IPV4_ADDR", the encoding is the same as the Ipv4Addr data type defined in 3GPP TS 29.571 [11].
  • - If the "redirectAddressType" attribute indicates "IPV6_ADDR", the encoding is the same as the Ipv6Addr data type defined in 3GPP TS 29.571 [11].
  • - If the "redirectAddressType" attribute indicates "URL" or "SIP_URI", the encoding is the same as the Uri data type defined in 3GPP TS 29.571 [11].
| | + +### 5.6.2.14 Type FlowInformation + +**Table 5.6.2.14-1: Definition of type FlowInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| flowDescription | FlowDescription | O | 0..1 | Contains the packet filters of the IP flow(s). | | +| ethFlowDescription | EthFlowDescription | O | 0..1 | Defines a packet filter for an Ethernet flow. If the "fDir" attribute is included, it shall be set to "DOWNLINK". If the "fDir" attribute is never provided, the address information within the "ethFlowDescription" attribute shall be encoded in downlink direction. | | +| packFiltId | string | O | 0..1 | An identifier of packet filter. (NOTE) | | +| packetFilterUsage | boolean | O | 0..1 | The packet shall be sent to the UE. The default value "FALSE" shall apply, if the attribute is not present and has not been supplied previously. | | +| tosTrafficClass | string | O | 0..1 | 2-octet string. The first octet contains the Ipv4 Type-of-Service or the Ipv6 Traffic-Class field and the second octet contains the ToS/Traffic mask field in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| spi | string | O | 0..1 | 4 octet string, representing the security parameter index of the IPSec packet in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| flowLabel | string | O | 0..1 | 3-octet string, representing the Ipv6 flow label header field in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| flowDirection | FlowDirectionRm | O | 0..1 | Indicates the direction/directions that a filter is applicable, downlink only, uplink only or both down- and uplink (bidirectional). | | + +NOTE: The PCF shall only assign the "packFiltId" attribute for PCC rules created as a result of UE-initiated resource allocation. + +### 5.6.2.15 Type SmPolicyDeleteData + +**Table 5.6.2.15-1: Definition of type SmPolicyDeleteData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| userLocationInfo | UserLocation | O | 0..1 | The location(s) where the served UE is camping. (NOTE 2) | RAN-NAS-Cause, NetLoc | +| ueTimeZone | TimeZone | O | 0..1 | The time zone where the served UE is camping. | RAN-NAS-Cause, NetLoc | +| userLocationInfoTime | DateTime | O | 0..1 | Contains the NTP time at which the UE was last known to be in the location contained in the "userLocationInfo" attribute. (NOTE 1) | RAN-NAS-Cause, NetLoc | +| servingNetwork | PlmnIdNid | O | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN, the NID together with the PLMN ID identifies the SNPN. | NetLoc | +| ranNasRelCauses | array(RanNasRelCause) | O | 1..N | Indicates the RAN and/or NAS release cause(s) code information. | RAN-NAS-Cause | +| accuUsageReports | array(AccuUsageReport) | O | 1..N | Contains the accumulated usage reporting information. | UMC | +| pduSessRelCause | PduSessionRelCause | O | 0..1 | Indicates PDU session release cause. | PDU Session Rel Cause, Immediate Termination | + +NOTE 1: The age of UE location included within the "userLocationInfoTime" attribute is the age of the 3GPP access UE location received from the AMF and shall be included only when the reported "userLocationInfo" attribute includes the UE location in the 3GPP access. + +NOTE 2: The SMF may encode both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute. + +## 5.6.2.16 Type QosCharacteristics + +**Table 5.6.2.16-1: Definition of type QosCharacteristics** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | M | 1 | Identifier for the authorized QoS parameters for the service data flow. Applies to PCC rule and PDU session level. | | +| resourceType | QosResourceType | M | 1 | Indicates whether the resource type is GBR, delay critical GBR, or non-GBR. | | +| priorityLevel | 5QIPriorityLevel | M | 1 | Unsigned integer indicating the 5QI Priority Level, within a range of 1 to 127. | | +| packetDelayBudget | PacketDelBudget | M | 1 | Unsigned integer indicates the packet delay budget. Packet Delay Budget expressed in milliseconds. | | +| packetErrorRate | PacketErrRate | M | 1 | String indicating the packet error rate.
Examples:
Packer Error Rate $4 \times 10^{-6}$ shall be encoded as "4E-6".
Packer Error Rate $10^{-2}$ shall be encoded as "1E-2". | | +| averagingWindow | AverWindow | C | 0..1 | Indicates the averaging window. This IE shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. | | +| maxDataBurstVol | MaxDataBurstVol | C | 0..1 | Unsigned Integer. Indicates the maximum data burst volume.
(NOTE) | | +| extMaxDataBurstVol | ExtMaxDataBurstVol | C | 0..1 | Unsigned Integer. Indicates the maximum data burst volume.
(NOTE) | EMDBV | + +NOTE: Either the maxDataBurstVol IE or the extMaxDataBurstVol IE may be present for a Delay Critical GBR QoS flow. If the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurstVol IE is used. If the EMDBV feature is supported by both the PCF and the SMF, the extMaxDataBurstVol IE is used to transmit maximum data burst volume values higher than 4095 Bytes (see clause 4.2.2.1). + +## 5.6.2.17 Type ChargingInformation + +**Table 5.6.2.17-1: Definition of type ChargingInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| primaryChfAddress | Uri | M | 1 | Contains the {apiRoot} part, either in the form of an FQDN or IPAddress/Port Number, of the URI, of the primary CHF instance.
(NOTE 1) (NOTE 2) | | +| secondaryChfAddress | Uri | C | 0..1 | Contains the {apiRoot} part, either in the form of an FQDN or IPAddress/Port Number, of the URI, of the secondary CHF instance.
It shall be present if the feature "CHFsetSupport" is not supported.
It may be omitted if the feature "CHFsetSupport" is supported
(NOTE 1) (NOTE 2) | | +| primaryChfSetId | NfSetId | C | 0..1 | The CHF set ID that the primary CHF instance belongs to may complement the primary CHF address and shall be present, if available.
(NOTE 2) | | +| primaryChfInstanceId | NfInstanceId | C | 0..1 | The CHF instance ID of the primary CHF instance may complement the primary CHF address and shall be present, if available.
(NOTE 2) | | +| secondaryChfSetId | NfSetId | C | 0..1 | The CHF set ID that the secondary CHF instance belongs to may complement the secondary CHF address and shall be present, if available, and the feature "CHFsetSupport" is not supported. It may be omitted if available and the feature "CHFsetSupport" is supported. | | +| secondaryChfInstanceId | NfInstanceId | C | 0..1 | The CHF instance ID of the secondary CHF instance may complement the secondary CHF address and shall be present, if available, and the feature "CHFsetSupport" is not supported. It may be omitted if available and the feature "CHFsetSupport" is supported. | | + +NOTE 1: Based on the {apiRoot} of the CHF instance in the form of an FQDN, the consumer can derive the Nfinstance via NRF lookup. It is up to the consumer to determine which service to invoke from the CHF. The {apiRoot} shall apply to all CHF services. + +NOTE 2: The NF Service Consumer of the CHF may use the "primaryChfAddress"/"secondaryChfAddress" attributes as primary/secondary redundancy mechanism, or alternatively, when CHF instance and CHF set are available, it may also rely on the availability of a CHF instance within the CHF Set for the same purpose. + +### 5.6.2.18 Type AccuUsageReport + +**Table 5.6.2.18-1: Definition of type AccuUsageReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-------------|---|-------------|----------------------------------------------------------------------------------|---------------| +| refUmlDs | string | M | 1 | An id referencing UsageMonitoringData objects associated with this usage report. | | +| volUsage | Volume | O | 0..1 | Indicates a total accumulated volume usage. | | +| volUsageUplink | Volume | O | 0..1 | Indicates an accumulated volume usage in uplink. | | +| volUsageDownlink | Volume | O | 0..1 | Indicates an accumulated volume usage in downlink. | | +| timeUsage | DurationSec | O | 0..1 | Indicates an accumulated time usage. | | +| nextVolUsage | Volume | C | 0..1 | Indicates an accumulated volume usage after the Monitoring Time. | | +| nextVolUsageUplink | Volume | O | 0..1 | Indicates an accumulated volume usage in uplink after the Monitoring Time. | | +| nextVolUsageDownlink | Volume | O | 0..1 | Indicates an accumulated volume usage in downlink after the Monitoring Time. | | +| nextTimeUsage | DurationSec | C | 0..1 | Indicates an accumulated time usage after the Monitoring. | | + +## 5.6.2.19 Type SmPolicyUpdateContextData + +**Table 5.6.2.19-1: Definition of type SmPolicyUpdateContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| repPolicyCtrlReqTriggers | array(PolicyControlRequestTrigger) | C | 1..N | The policy control request triggers which are met. It is omitted if no triggers are met such as in clauses 4.2.4.7 and 4.2.4.15. | | +| accNetChlds | array(AccNetChld) | O | 1..N | Indicates the access network charging identifier for the whole PDU session. For EPS interworking scenarios, it indicates the access network charging identifier for the PCC rule(s) or the whole PDU session. | | +| accessType | AccessType | O | 0..1 | The Access Type where the served UE is camping. | | +| ratType | RatType | O | 0..1 | The RAT Type where the served UE is camping. | | +| addAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the combination of added Access Type and RAT Type for MA PDU session. | ATSSS | +| relAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the combination of released Access Type and RAT Type for MA PDU session. | ATSSS | +| servingNetwork | PlmnIdNid | O | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN the NID together with the PLMN ID identifies the SNPN. | | +| userLocationInfo | UserLocation | O | 0..1 | The location(s) where the served UE is camping. (NOTE 4) | | +| ueTimeZone | TimeZone | O | 0..1 | The time zone where the served UE is camping. | | +| ipv4Address | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE. | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 2) | | +| rellpv4Address | Ipv4Addr | O | 0..1 | Indicates the released IPv4 Address of the served UE. | | +| ipv6AddressPrefix | Ipv6Prefix | O | 0..1 | The Ipv6 Address Prefix of the served UE. (NOTE 6) | | +| rellpv6AddressPrefix | Ipv6Prefix | O | 0..1 | Indicates the released IPv6 Address Prefix of the served UE in multi-homing case. (NOTE 6) | | +| relUeMac | MacAddr48 | O | 0..1 | Indicates the released MAC Address of the served UE. | | +| ueMac | MacAddr48 | O | 0..1 | The MAC Address of the served UE. | | +| subsSessAmbr | Ambr | O | 0..1 | UDM subscribed or DN-AAA authorized Session-AMBR. | | +| authProfIndex | string | O | 0..1 | DN-AAA authorization profile index. | DN-Authorization | +| subsDefQos | SubscribedDefaultQos | O | 0..1 | Subscribed Default QoS Information. | | +| vplmnQos | VplmnQos | O | 0..1 | QoS constraints in a VPLMN (NOTE 5) | VPLMN-QoS-Control | +| vplmnQosNotApp | boolean | O | 0..1 | If it is included and set to true, indicates that the QoS constraints in the VPLMN are not applicable. (NOTE 5) | VPLMN-QoS-Control | +| numOfPackFilter | integer | O | 0..1 | Contains the number of supported packet filter for signalled QoS rules. (NOTE 1) | | +| accuUsageReports | array(AccuUsageReport) | O | 1..N | Contains the accumulated usage report(s). | UMC | +| 3gppPsDataOffStatus | boolean | O | 0..1 | If it is included and set to true, the 3GPP PS Data Off is activated by the UE. | 3GPP-PS-Data-Off | + +| | | | | | | +|------------------------|-----------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| appDetectionInfos | array(AppDetectionInfo) | O | 1..N | Reports the start/stop of the application traffic and detected SDF descriptions if applicable. | ADC | +| ruleReports | array(RuleReport) | O | 1..N | Used to report the PCC rule failure. | | +| sessRuleReports | array(SessionRuleReport) | O | 1..N | Used to report the session rule failure. | SessionRuleErrorHandling | +| qncReports | array(QosNotificationControlInfo) | O | 1..N | QoS Notification Control information. | | +| qosMonReports | array(QosMonitoringReport) | O | 1..N | QoS Monitoring reporting information. | QosMonitoring | +| qosMonDatRateReps | array(QosMonitoringReport) | O | 1..N | QoS Monitoring reporting information with data rate measurements. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. | EnQoSMon | +| userLocationInfoTime | DateTime | O | 0..1 | Contains the NTP time at which the UE was last known to be in the location. (NOTE 3) | | +| repPralInfos | map(PresenceInfo) | O | 1..N | Reports the changes of presence reporting area. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall be supplied. The "additionalPrald" attribute within the PresenceInfo data type shall not be supplied. | PRA | +| ueInitResReq | UeInitiatedResourceRequest | O | 0..1 | Indicates a UE requests specific QoS handling for selected SDF. | | +| refQosIndication | boolean | O | 0..1 | 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 | QosFlowUsage | O | 0..1 | Indicates the required usage for default QoS flow. | | +| creditManageStatus | CreditManagementStatus | O | 0..1 | Indicates the reason of the credit management session failure. | | +| servNfld | ServingNfIdentity | O | 0..1 | Contains the serving network function identity. | | +| traceReq | TraceData | C | 0..1 | It shall be included if trace is required to be activated, modified or deactivated (see 3GPP TS 32.422 [24]). For trace modification, it shall contain a complete replacement of trace data. For trace deactivation, it shall contain the Null value. | | +| addIpv6AddrPrefixes | Ipv6Prefix | O | 0..1 | An additional Ipv6 Address Prefix of the served UE. (NOTE 6) | MultiIpv6AddrPrefix | +| addRelIpv6AddrPrefixes | Ipv6Prefix | O | 0..1 | Indicates an additional released IPv6 Address Prefix of the served UE. (NOTE 6) | MultiIpv6AddrPrefix | +| multiIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | The Ipv6 Address Prefixes of the served UE. (NOTE 6) | UnlimitedMultiIpv6Prefix | +| multiRelIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | Indicates the released IPv6 Address Prefixes of the served UE. (NOTE 6) | UnlimitedMultiIpv6Prefix | +| tsnBridgeInfo | TsnBridgeInfo | O | 0..1 | Transports TSC user plane node information. | TimeSensitive Networking | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information. | TimeSensitive Networking | +| tsnPortManContDstt | PortManagementContainer | O | 0..1 | When DS-TT functionality is used, transports TSN port management information for the DS-TT port. | TimeSensitive Networking | + +| | | | | | | +|-------------------------|----------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| tsnPortManContNwtt
s | array(PortManagementContainer) | O | 1..N | When NW-TT functionality is used, transports TSN port management information for one or more NW-TT ports. | TimeSensitive Networking | +| tscNotifUri | Uri | O | 0..1 | For PMIC/UMIC UPF event notification target address of the TSCTSF or TSN AF receiving the TSC management information. | ExposureToTSC | +| tscNotifCorreId | string | O | 0..1 | Correlation identifier for TSC management information notifications. | ExposureToTSC | +| maPduInd | MaPduIndication | O | 0..1 | Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed. (NOTE 1) | ATSSS | +| atsssCapab | AtsssCapability | O | 0..1 | Contains the ATSSS capability supported for the MA PDU session. (NOTE 1) | ATSSS | +| mulAddrInfos | array(IpMulticastAddressInfo) | O | 1..N | Contains the IP multicast address information. | WWC | +| policyDecFailureReports | array(PolicyDecisionFailureCode) | O | 1..N | Indicates the type(s) of the failed policy decision and/or condition data. | PolicyDecision ErrorHandling | +| invalidPolicyDecs | array(InvalidParam) | O | 1..N | Indicates the invalid parameters for the reported type(s) of the failed policy decision and/or condition data. | ExtPolicyDecisionErrorHandling | +| trafficDescriptors | array(DddTrafficDescriptor) | O | 1..N | Contains the traffic descriptor(s) | DDNEventPolicyControl | +| typesOfNotif | array(DlDataDeliveryStatus) | O | 1..N | Contains the type of notification of DDD Status. | DDNEventPolicyControl | +| pccRuleId | string | O | 0..1 | Contains the identifier of the PCC rule which is used for traffic detection of event (e.g. DDN failure). | DDNEventPolicyControl2 | +| interGrpIds | array(GroupId) | O | 1..N | Internal Group Identifier(s) of the served UE. | GroupIdListChange | +| satBackhaulCategory | SatelliteBackhaul Category | O | 0..1 | Indicates the satellite backhaul category or non-satellite backhaul used for the PDU session. If the "EnSatBackhaulCatChg" feature is supported, the dynamic satellite backhaul categories may also be provided. | SatBackhaulCategoryChg | +| pcfUeInfo | PcfUeCallbackInfo | O | 0..1 | PCF for the UE callback URI and SBA binding information. | AMInfluence | +| nwdafDatas | array(NwdafData) | O | 1..N | List of NWDAF Instance IDs and their associated Analytics IDs consumed by the NF service consumer. | EneNA | +| anGwStatus | boolean | O | 1..N | When it is included and set to "true", it indicates that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the AN-Gateway has been recovered. (NOTE 1) | SGWRest | +| uePolCont | UePolicyContainer | C | 0..1 | Indicates a UE policy container received from the UE. (NOTE 1) | EpsUrsp | +| urspEnfInfo | UrspEnforcementInfo | O | 0..1 | Contains the reporting of URSP rule enforcement from the UE. | URSPEnforcement | +| sscMode | SscMode | O | 0..1 | SSC Mode of the PDU session.

It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| ueReqDnn | Dnn | O | 0..1 | UE requested DNN.

It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| redundantPduSessionInfo | RedundantPduSessionInformation | O | 0..1 | RSN and PDU session pair ID of the redundant PDU session. It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| l4sReports | array(L4sSupportInfo) | O | 1..N | ECN marking for L4S support report information. | L4S | +| sliceInfo | Snssai | O | 0..1 | Identifies the updated S-NSSAI. | NetSliceRepl | +| batOffsetInfo | BatOffsetInfo | O | 0..1 | Contains the BAT offset and the optionally adjusted periodicity. | EnTSCAC | +| hrsboInd | boolean | O | 0..1 | HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is supported. If present and set to "false", it indicates that the HR-SBO is not supported. (NOTE 7) | HR-SBO | +| NOTE 1: This attribute is only applicable to the 5GS and EPC/E-UTRAN interworking scenario as defined in Annex B. | | | | | | +| NOTE 2: The value provided in this attribute is implementation specific. The only constraint is that the NF service consumer shall supply a different identifier for each overlapping address domain (e.g. the SMF NF instance identifier). | | | | | | +| NOTE 3: The age of UE location included within the "userLocationInfoTime" attribute is the age of the 3GPP access UE location received from the AMF and shall be included only when the reported "userLocationInfo" attribute includes the UE location in the 3GPP access. | | | | | | +| NOTE 4: The SMF may encode both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute. | | | | | | +| NOTE 5: Only one of "vplmnQos" or "vplmnQosNotApp" attributes may be present. | | | | | | +| NOTE 6: When the "WWC" feature is supported, according to 3GPP TS 23.316 [42], clause 8.3.1 and 4.6.2, more than one IPv6 prefix shorter than /64 or more than one full IPv6 address with a /128 prefix may be allocated to the RG. When feature Multilpv6AddrPrefix is supported, additional IPv6 prefix shorter than /64 or full IPv6 address with a /128 prefix may be reported encoded as the "addlpv6AddrPrefixes" and the "addRelIpv6AddrPrefixes" attributes, if the "Multilpv6AddrPrefix" feature is supported, or as the "multilpv6Prefixes" and the "multiRelIpv6Prefixes" attributes, if the "UnlimitedMultilpv6Prefix" feature is supported. If the attribute "multilpv6Prefixes" is provided, then attributes "ipv6AddressPrefix" and "addlpv6AddrPrefixes" shall be both absent. If the attribute "multiRelIpv6Prefixes" is provided, then attributes "relIpv6AddressPrefix" and "addRelIpv6AddrPrefixes" shall be both absent. | | | | | | +| NOTE 7: This attribute may be present when the "PLMN_CH" trigger is included in "repPolicyCtrlReqTriggers" attribute. | | | | | | + +Editor's Note: The content of the "sliceInfo" attribute for the case where the NF service consumer reports a change from the Alternative S-NSSAI to the initial S-NSSAI of the PDU Session via the "NET\_SLICE\_REPL" PCRT is FFS and pending stage 2 feedback. + +Editor's Note: It is FFS how the bat offset is indicated and reported per PCC rule. + +Editor's Note: Whether existing QoS monitoring data types and attributes are reused or new ones are added is to be discussed. + +## 5.6.2.20 Type UpPathChgEvent + +**Table 5.6.2.20-1: Definition of type UpPathChgEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationUri | Uri | M | 1 | Notification address of AF receiving the event notification. | TSC | +| notifCorrelId | string | M | 1 | It is used to set the value of Notification Correlation ID in the notification sent by the NF service consumer. | TSC | +| dnaiChgType | DnaiChangeType | M | 1 | Indicates the type of DNAI change. | TSC | +| afAckInd | boolean | O | 0..1 | Identifies whether the AF acknowledgement of UP path event notification is expected. Set to "true" if the AF acknowledgement is expected; otherwise set to "false". Default value is "false" if omitted. | URLLC | + +### 5.6.2.21 Type TerminationNotification + +**Table 5.6.2.21-1: Definition of type TerminationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual SM policy resource related to the notification.
(NOTE) | | +| cause | SmPolicyAssociationReleaseCause | M | 1 | The cause why the PCF requests the termination of the policy association. | | + +NOTE: Either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute can be used by the SMF for the identification of the individual SM policy resource related to the notification. + +### 5.6.2.22 Type AppDetectionInfo + +**Table 5.6.2.22-1: Definition of type AppDetectionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | string | M | 1 | A reference to the application detection filter configured at the UPF and reported to the NF service consumer. | | +| instanceId | string | O | 0..1 | Identifier dynamically assigned by UPF and reported to the NF service consumer 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 | array(FlowInformation) | O | 1..N | Contains the detected service data flow descriptions if they are deducible. When present, it shall only include the "flowDescription" and the "flowDirection" attributes of the FlowInformation data type. | | + +### 5.6.2.23 Type AccNetChld + +**Table 5.6.2.23-1: Definition of type AccNetChld** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| accNetChldValue | ChargingId | C | 0..1 | Contains a charging identifier. (NOTE 1) | | +| accNetChargIdString | string | C | 0..1 | A character string containing the charging identifier (see clause 5.1.9.1 of 3GPP TS 32.255 [35]). (NOTE 1) | AccNetChargId_String | +| refPccRuleIds | array(string) | O | 1..N | Applicable only to EPS interworking scenarios. Contains the identifier of the PCC rule(s) that are associated to the provided Access Network Charging Identifier. | | +| sessionChScope | boolean | O | 0..1 | When included and set to true, it indicates that the provided Access Network Charging Identifier applies to the whole PDU Session. Default value is false if omitted. Value false applies only to EPS interworking scenarios | | + +NOTE 1: The "accNetChldValue" shall be used to encode the charging identifier when the charging identifier is within the Uint32 value range. The "accNetChargIdString" attribute shall be used to encode the charging identifier when the "AccNetChargId\_String" feature is supported by the SMF and the PCF and the charging identifier is out of the Uint32 range. + +NOTE 2: When the "AccNetChargId\_String" feature is not supported and the value of the charging identifier is out of the ChargingId data type value range (Uint32) it is not possible to ensure a proper charging correlation using value of the "accNetChldValue" attribute. + +### 5.6.2.24 Type RequestedRuleData + +**Table 5.6.2.24-1: Definition of type RequestedRuleData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| refPccRuleIds | array(string) | M | 1..N | An array of PCC rule id references to the PCC rules associated with the control data. | | +| reqData | array(RequestedRuleDataType) | M | 1..N | Array of requested rule data type elements indicating what type of rule data is requested for the corresponding referenced PCC rules. | | + +### 5.6.2.25 Type RequestedUsageData + +**Table 5.6.2.25-1: Definition of type RequestedUsageData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| refUmlDs | array(string) | C | 1..N | An array of usage monitoring data id references to the usage monitoring data instances for which the PCF is requesting an accumulated usage report. This attribute shall only be provided when allUmlDs is not set to true. | | +| allUmlDs | boolean | C | 0..1 | This boolean indicates whether the requested accumulated usage report applies to all usage monitoring data instances. When it is not included, it means that the requested accumulated usage report shall only apply to the usage monitoring data instances referenced in the refUmlDs attribute. | | + +## 5.6.2.26 Type UeCampingRep + +Table 5.6.2.26-1: Definition of type UeCampingRep + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| accessType | AccessType | C | 0..1 | The Access Type where the served UE is camping.
It shall be provided for trigger "AC_TY_CH". | | +| ratType | RatType | C | 0..1 | The RAT Type where the served UE is camping.
It shall be provided for triggers "RAT_TY_CH" and/or "AC_TY_CH". | | +| servNfId | ServingNfIdentity | C | 0..1 | Contains the serving network function identity.
It shall be provided for trigger "SCNN_CH". | | +| servingNetwork | PlmnIdNid | C | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For an SNPN the NID together with the PLMN ID identifies the SNPN.
It shall be provided for trigger "PLMN_CH". | | +| userLocationInfo | UserLocation | C | 0..1 | The location(s) of the served UE.
It shall be provided for trigger "SAREA_CH".
(NOTE) | | +| ueTimeZone | TimeZone | C | 0..1 | The time zone where the served UE is camping.
It shall be provided for trigger "UE_TZ_CH" | | +| netLocAccSupp | NetLocAccessSupport | O | 0..1 | Indicates that the access network does not support the reporting of the requested access network information. | NetLoc | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates satellite backhaul category or non-satellite backhaul used for the PDU session.
If the "EnSatBackhaulCatChg" feature is supported, the different dynamic satellite backhaul categories may also be provided.
It shall be provided for trigger "SAT_CATEGORY_CHG" | SatBackhaulCategoryChg_v2 | +| urspEnfInfo | UrspEnforcementInfo | C | 0..1 | Contains the reporting of URSP rule(s) enforcement received from the UE.
It shall be provided for trigger "URSP_ENFORCEMENT_INFO" | URSPEnforcement | +| sscMode | SscMode | O | 0..1 | SSC Mode of the PDU session.

It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| ueReqDnn | Dnn | O | 0..1 | UE requested DNN.

It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | +| redundantPduSessionInfo | RedundantPduSessionInformation | O | 0..1 | RSN and PDU session pair ID of the redundant PDU session.
It may be present when the "urspEnfInfo" attribute is present. | URSPEnforcement | + +NOTE: The SMF may encode both 3GPP and non-3GPP access UE location in the "userLocationInfo" attribute. + +## 5.6.2.27 Type RuleReport + +**Table 5.6.2.27-1: Definition of type RuleReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| pccRuleIds | array(string) | M | 1..N | Contains the identifier(s) of the affected PCC rule(s). | | +| ruleStatus | RuleStatus | M | 1 | Indicates the status of the PCC rule(s). | | +| contVers | array(ContentVersion) | C | 1..N | Indicates the version(s) of the PCC rule(s). If the RuleVersioning feature is supported, the content version shall be included in this attribute if it was included when the corresponding PCC rule was installed or modified. | RuleVersioning | +| failureCode | FailureCode | C | 0..1 | Indicates the reason why the PCC Rule(s) are being reported. It shall be included when the NF service consumer reports the failure of the enforcement of the PCC rule(s). | | +| retryAfter | UInteger | O | 0..1 | Indicates the estimate on how long it will take before it can be considered the UE is reachable. It may be provided when the failureCode attribute indicates UE_TEMPORARILY_UNAVAILABLE. The value shall be in seconds. | UEUnreachable | +| finUnitAct | FinalUnitAction | O | 0..1 | Contains the termination action that is applied, when the user's account cannot cover the service cost. | | +| ranNasRelCauses | array(RanNasRelCause) | O | 1..N | Indicates the RAN or NAS release cause code information. | RAN-NAS-Cause | +| altQosParamId | string | O | 0..1 | Indicates the alternative QoS parameter set that the NG-RAN can guarantee. It is included during the report of success resource allocation and indicates that NG-RAN used an alternative QoS profile because the requested QoS could not be allocated. | AuthorizationWithRequiredQoS | + +## 5.6.2.28 Type RanNasRelCause + +**Table 5.6.2.28-1: Definition of type RanNasRelCause** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------|---------------| +| ngApCause | NgApCause | O | 0..1 | Indicates the cause value of NGAP protocol. | RAN-NAS-Cause | +| 5gMmCause | 5GMmCause | O | 0..1 | Indicates the cause value of 5GMM protocol. | RAN-NAS-Cause | +| 5gSmCause | 5GSmCause | O | 0..1 | Indicates the cause value of 5GSM protocol. | RAN-NAS-Cause | +| epsCause | EpsRanNasRelCause | O | 0..1 | Indicates the RAN/NAS cause value for EPS. | RAN-NAS-Cause | + +### 5.6.2.29 Type UeInitiatedResourceRequest + +**Table 5.6.2.29-1: Definition of type UeInitiatedResourceRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| pccRuleId | string | C | 1 | Indicates a PCC rule corresponding to a QoS rule which is requested to be modified or deleted by the UE. | | +| ruleOp | RuleOperation | M | 1 | Indicates an operation for the PCC rule. | | +| packFiltInfo | array(PacketFilterInfo) | M | 1..N | Contains the information from a single packet filter sent from the NF service consumer to the PCF. | | +| precedence | integer | O | 0..1 | The requested order for the PCC rule generated from the QoS rule requested by the UE. | | +| reqQos | RequestedQos | O | 0..1 | Contains the QoS information requested by the UE. | | + +### 5.6.2.30 Type PacketFilterInfo + +**Table 5.6.2.30-1: Definition of type PacketFilterInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| packFiltId | string | O | 0..1 | An identifier of packet filter. For PCC rules created as a result of UE-initiated resource modification, the packet filter identifier is assigned by the PCF and is unique per UE and PCF instance. | | +| packFiltCont | PacketFilterContent | O | 0..1 | Contains the content of the packet filter as requested by the UE and required by the PCF to create the PCC rules. | | +| tosTrafficClass | string | O | 0..1 | 2-octet string. The first octet contains the Ipv4 Type-of-Service or the Ipv6 Traffic-Class field and the second octet contains the ToS/Traffic mask field in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| spi | string | O | 0..1 | 4 octet string, representing the security parameter index of the IPSec packet in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| flowLabel | string | O | 0..1 | 3-octet string, representing the Ipv6 flow label header field in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [41]. | | +| flowDirection | FlowDirection | O | 0..1 | Indicates the direction/directions that a filter is applicable, downlink only, uplink only or both down- and uplink (bidirectional). | | + +### 5.6.2.31 Type RequestedQos + +**Table 5.6.2.31-1: Definition of type RequestedQos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | M | 1 | Identifier for the authorized QoS parameters for the service data flow. | | +| gbrUI | BitRate | O | 0..1 | Indicates the guaranteed bandwidth in uplink requested by the UE. | | +| gbrDI | BitRate | O | 0..1 | Indicates the max guaranteed in downlink requested by the UE. | | + +### 5.6.2.32 Type QosNotificationControlInfo + +**Table 5.6.2.32-1: Definition of type QosNotificationControlInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| refPccRuleIds | array(string) | M | 1..N | An array of PCC rule id references to the PCC rules associated with the QosNotificationControlInfo. | | +| notifType | QosNotifType | M | 1 | Indicates whether the GBR targets for the indicated SDFs are "NOT_GUARANTEED" or "GUARANTEED" again. | | +| contVers | array(ContentVersion) | C | 1..N | Indicates the version of the PCC rule. If rule versioning feature is supported, the content version shall be included if it was included when the corresponding PCC rule was installed or modified. | RuleVersioning | +| altQosParamId | string | O | 0..1 | Indicates the alternative QoS parameter set the NG-RAN can guarantee. When it is omitted and "notifType" attribute is NOT_GUARANTEED, it indicates that the lowest priority alternative QoS profile could not be fulfilled. | AuthorizationWithRequiredQoS | +| altQosNotSupplnd | boolean | O | 0..1 | It may be set to true when the "notifType" attribute is NOT_GUARANTEED to indicate that the Alternative QoS profiles are not supported by NG-RAN. The default value false shall apply if the attribute is not present.
It may be used when the AuthorizationWithRequiredQoS feature is supported. | AltQoSProfilesSupportReport | + +### 5.6.2.33 Type PartialSuccessReport + +**Table 5.6.2.33-1: Definition of type PartialSuccessReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------|--------------------------------| +| failureCause | FailureCause | M | 1 | Application error cause specific to this report. | | +| ruleReports | array(RuleReport) | C | 1..N | Information about the PCC rules provisioned by the PCF not successfully installed/activated. | | +| sessRuleReports | array(SessionRuleReport) | O | 1..N | Information about the session rules provisioned by the PCF not successfully installed. | SessionRuleErrorHandling | +| ueCampingRep | UeCampingRep | O | 0..1 | Includes the current applicable values corresponding to the provisioned policy control request triggers. | | +| policyDecFailureReports | array(PolicyDecisionFailureCode) | O | 1..N | Used to report the failure of the policy decision and/or condition data. | PolicyDecisionErrorHandling | +| invalidPolicyDecs | array(InvalidParam) | O | 1..N | Indicates the invalid parameters for the reported type(s) of the failed policy decision and/or condition data. | ExtPolicyDecisionErrorHandling | + +NOTE: The "ruleReports" shall be included if the SessionRuleErrorHandling feature or the PolicyDecisionErrorHandling feature is not supported. + +### 5.6.2.34 Type AuthorizedDefaultQos + +**Table 5.6.2.34-1: Definition of type AuthorizedDefaultQos** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | C | 0..1 | 5G QoS Identifier. It shall be included when the Authorized Default QoS is initially provisioned. | | +| arp | Arp | C | 0..1 | Indicates the allocation and retention priority. It shall be included when the Authorized Default QoS is initially provisioned. | | +| priorityLevel | 5QIPriorityLevelRm | O | 0..1 | Unsigned integer indicating the 5QI Priority Level, within a range of 1 to 127. | | +| averWindow | AverWindowRm | O | 0..1 | Indicates the averaging window. (NOTE 1) | | +| maxDataBurstVol | MaxDataBurstVolRm | O | 0..1 | Unsigned integer indicating the maximum data burst volume. (NOTE 2) | | +| gbrUl | BitRateRm | O | 0..1 | Indicates the guaranteed bandwidth in uplink. (NOTE 1) | | +| gbrDl | BitRateRm | O | 0..1 | Indicates the guaranteed bandwidth in downlink. (NOTE 1) | | +| maxbrUl | BitRateRm | O | 0..1 | Indicates the max bandwidth in uplink. (NOTE 1) | | +| maxbrDl | BitRateRm | O | 0..1 | Indicates the max bandwidth in downlink. (NOTE 1) | | +| extMaxDataBurstVol | ExtMaxDataBurstVolRm | O | 0..1 | Unsigned integer indicating the maximum data burst volume. (NOTE 2) | EMDBV | + +NOTE 1: This attribute is only applicable to GBR type or delay critical GBR type 5QI. +NOTE 2: Either the maxDataBurstVol IE or the extMaxDataBurstVol IE may be present for a Delay Critical GBR QoS flow. If the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurstVol IE is used. If the EMDBV feature is supported by both the PCF and the SMF, the extMaxDataBurstVol IE is used to transmit maximum data burst volume values higher than 4095 Bytes (see clause 4.2.2.1). + +### 5.6.2.35 Type AccNetChargingAddress + +**Table 5.6.2.35-1: Definition of type AccNetChargingAddress** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------|---------------| +| anChargIpv4Addr | Ipv4Addr | O | 0..1 | Includes the IPv4 address of network entity within the access network performing charging. | | +| anChargIpv6Addr | Ipv6Addr | O | 0..1 | Includes the IPv6 address of network entity within the access network performing charging. | | + +NOTE: At least one address of the access network entity (the IPv4 address or the IPv6 address or both if both addresses are available) shall be included. + +### 5.6.2.36 Type ErrorReport + +**Table 5.6.2.36-1: Definition of type ErrorReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------|--------------------------------| +| error | ProblemDetails | M | 1 | More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. | | +| ruleReports | array(RuleReport) | O | 1..N | Used to report the PCC rule failure. | | +| sessRuleReports | array(SessionRuleReport) | O | 1..N | Used to report the session rule failure. | SessionRuleErrorHandling | +| policyDecFailureReports | array(PolicyDecisionFailureCode) | O | 1..N | Used to report the failure of the policy decision and/or condition data. | PolicyDecisionErrorHandling | +| invalidPolicyDecs | array(InvalidParam) | O | 1..N | Indicates the invalid parameters for the reported type(s) of the failed policy decision and/or condition data. | ExtPolicyDecisionErrorHandling | + +### 5.6.2.37 Type SessionRuleReport + +**Table 5.6.2.37-1: Definition of type SessionRuleReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ruleIds | array(string) | M | 1..N | Contains the identifier of the affected session rule(s). | | +| ruleStatus | RuleStatus | M | 1 | Indicates the status of the session rule(s). | | +| sessRuleFailureCode | SessionRuleFailureCode | C | 0..1 | Indicates the reason that the session rule(s) is being reported. It shall be included when the NF service consumer reports the enforcement failure of the session rule(s). | | + +### 5.6.2.38 Type ServingNfIdentity + +**Table 5.6.2.38-1: Definition of type ServingNfIdentity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------|---------------| +| servNfInstanceId | NfInstanceId | O | 0..1 | Network Function Instance Identifier of the 5G serving CN node. It represents the AMF. | | +| guami | Guami | O | 0..1 | Globally Unique AMF Identifier. | | +| anGwAddr | AnGwAddress | O | 0..1 | Contains the access network control gateway address. It represents the S-GW or ePDG address. (NOTE 2) | | +| sgsnAddr | SgsnAddress | O | 0..1 | Contains the serving SGSN address. (NOTE 3) | 2G3GIWK | + +NOTE 1: At least one of the "servNfInstanceId", "guami", "anGwAddr", or "sgsnAddr" attributes shall be present. +NOTE 2: "anGwAddr" attribute is only applicable to the 5GS and EPC (E-UTRAN and non-3GPP access) interworking scenario as defined in Annex B. +NOTE 3: "sgsnAddr" attribute is only applicable to the 5GS and EPC (GERAN and UTRAN access) interworking scenario as defined in Annex B. + +### 5.6.2.39 Type SteeringMode + +**Table 5.6.2.39-1: Definition of type SteeringMode** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| steerModeValue | SteerModeValue | M | 1 | Indicates the value of the steering mode. | | +| active | AccessType | C | 0..1 | Indicates the Active access. It shall be included when the "steerModeValue" attribute is set to "ACTIVE_STANDBY". | | +| standby | AccessTypeRm | O | 0..1 | Indicates the Standby access. It may be included when the "steerModeValue" attribute is set to "ACTIVE_STANDBY". | | +| 3gLoad | UInteger | C | 0..1 | Indicates the traffic load to steer to the 3GPP Access expressed in one percent.
It shall be set to 0, 10, 20, 30, 40, 50, 60, 70, 80, 90 or 100.
It shall be included when the "steerModeValue" attribute is set to "LOAD_BALANCING". | | +| prioAcc | AccessType | C | 0..1 | Indicates the high priority access.
It shall be included when the "steerModeValue" attribute is set to "PRIORITY_BASED". | | +| thresValue | ThresholdValue | O | 0..1 | Indicates the threshold value(s) for RTT and/or Packet Loss Rate. If the EnATSSS feature is supported, it may be included when the "steerModeValue" attribute is set to "LOAD_BALANCING" with fixed split percentages or "PRIORITY_BASED" or, when the feature EnATSSS_v2 is supported, "REDUNDANT". (NOTE 1) (NOTE 2) | EnATSSS | +| steerModeInd | SteerModeIndicator
or | O | 0..1 | Contains Autonomous load-balance indicator or UE-assistance indicator. If the EnATSSS feature is supported, it may be included when the "steerModeValue" attribute is set to "LOAD_BALANCING". (NOTE 1) | EnATSSS | +| primary | AccessTypeRm | O | 0..1 | Indicates the Primary access. It shall be included when the "steerModeValue" attribute is set to "REDUNDANT". | EnATSSS_v2 | + +NOTE 1: The "thresValue" attribute and "steerModeInd" attribute are mutually exclusive. +NOTE 2: When the feature EnATSSS\_v2 is supported, if the Steering Mode is "REDUNDANT", either a Maximum RTT or a Maximum Packet Loss Rate may be provided, but not both. + +## 5.6.2.40 Type QosMonitoringData + +**Table 5.6.2.40-1: Definition of type QosMonitoringData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| qmId | string | M | 1 | Univocally identifies the QoS monitoring policy data within a PDU session. | | +| reqQosMonParams | array(RequestedQosMonitoringParameter) | M | 1..N | Indicates QoS information to be monitored, e.g. the UL packet delay, DL packet delay and/or round trip packet delay and/or congestion information between the UE and the UPF is to be monitored when the QoS Monitoring is enabled for the service data flow.
(NOTE 1)
If the "EnQoSMon" feature is supported, it indicates the congestion information to be monitored, e.g., the UL congestion information and/or the the DL congestion information | QoSMonitoring
EnQoSMon | +| repFreqs | array(ReportingFrequency) | M | 1..N | Indicates the frequency for the reporting, such as event triggered and/or periodic. | | +| repThreshDl | integer | O | 0..1 | Indicates the threshold in units of milliseconds for DL packet delay. Only applicable when the "reqQosMonParams" attribute includes the "DOWNLINK" value and the "repFreqs" attribute includes the value "EVENT_TRIGGERED".
Minimum = 0. | | +| repThreshUl | integer | O | 0..1 | Indicates the threshold in units of milliseconds for UL packet delay. Only applicable when the "reqQosMonParams" attribute includes the "UPLINK" value and the "repFreqs" attribute includes the value "EVENT_TRIGGERED".
Minimum = 0. | | +| repThreshRp | integer | O | 0..1 | Indicates the threshold in units of milliseconds for round trip packet delay. Only applicable when the "reqQosMonParams" attribute includes the "ROUND_TRIP" value and the "repFreqs" attribute includes the value "EVENT_TRIGGERED".
Minimum = 0. | | +| conThreshDl | UInteger | O | 0..1 | Indicates the downlink threshold for congestion reporting. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0. | EnQoSMon | +| conThreshUl | UInteger | O | 0..1 | Indicates the downlink threshold for congestion reporting. Only applicable when the "repFreqs" attribute is not supplied or the "repFreqs" is set to "EVENT_DETECTION".
Minimum = 0. | EnQoSMon | +| waitTime | DurationSecRm | O | 0..1 | Indicates the minimum waiting time between subsequent reports. Only applicable when the "repFreqs" attribute includes the value "EVENT_TRIGGERED". | | +| repPeriod | DurationSecRm | O | 0..1 | Indicates the reporting period. Only applicable when the "repFreqs" attribute includes the value "PERIODIC".
If the feature "PacketDelayFailureReport" is supported, it also indicates the time interval at which a measurement failure needs to be reported if no measurement result is provided. Only applicable when the "repFreqs" attribute includes the value "PERIODIC" and "EVENT_TRIGGERED". | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------|---------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifyUri | UriRm | O | 0..1 | Notification address of the AF or if the "ExposureToEAS" feature is supported, of the Local NEF or AF receiving the event notification. It shall be included if the PCF determines that the notification shall be sent to the AF directly from the NF service consumer or the PCF determines that the notification shall be sent to the Local NEF or AF directly from the UPF. (NOTE 2). | | +| notifyCorreId | string | O | 0..1 | It is used to set the value of Notification Correlation ID in the notification sent by the NF service consumer or, if the "ExposureToEAS" feature is supported, the UPF. It may be included if the PCF determines that the notification shall be sent to the AF directly from the NF service consumer or the PCF determines that the notification shall be sent to the Local NEF or AF directly from the UPF. (NOTE 2). | | +| directNotifInd | boolean | O | 0..1 | Indicates that the direct event notification sent to the Local NEF or AF by the UPF is requested if it is included and set to true. | ExposureToEAS | +| avrgWndw | AverWindowRm | O | 0..1 | Averaging window for the calculation of the data rate for the service data flow. It may be present when the "repThreshDatRateDI" and/or "repThreshDatRateUI" attributes are present. | EnQoSMon | +| repThreshDatRateDI | BitRateRm | O | 0..1 | Indicates the threshold for DL data rate. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION". | EnQoSMon | +| repThreshDatRateUI | BitRateRm | O | 0..1 | Indicates the threshold for UL data rate. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION". | EnQoSMon | +| dataCollAppId | ApplicationId | O | 0..1 | Indicates the Data Collection Application Identifier used to identify the QoS monitoring event exposure subscription. | UPEAS | +| NOTE 1: In this release of the specification the maximum number of elements in the array is 3. | | | | | | +| NOTE 2: The attributes "notifyUri" and "notifyCorreId" shall not be set to NULL if the "ExposureToEAS" feature is not supported. | | | | | | + +### 5.6.2.41 Type TsnBridgeInfo + +**Table 5.6.2.41-1: Definition of type TsnBridgeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| bridgeId | Uint64 | O | 0..1 | Contains a TSC user plane node Id. It may contain the unique TSN Bridge MAC address for IEEE TSN networks (as defined in IEEE Std 802.1Q-2018 [45] clause 14.2.5) or may contain a unique identifier assigned within 5GS (that identifies, e.g. a DetNet Router). | | +| dsttAddr | MacAddr48 | O | 0..1 | When DS-TT functionality is used, contains the MAC address of DS-TT. | | +| dsttPortNum | TsnPortNumber | O | 0..1 | Port allocated to a PDU session. | | +| dsttResidTime | UInteger | O | 0..1 | When DS-TT functionality is used, the time taken within the UE and DS-TT to forward a packet between the UE/DS-TT port encoded as specified in clause 9.11.4.26 of 3GPP TS 24.501 [20] starting with octet 3 and ending with octet 10. | | +| mtulpv4 | Uint16 | O | 0..1 | MTU size, in octets, for the largest IPv4 packet that the interface will send and receive, as specified in IETF RFC 8344 [56].
Minimum = 68 | MTU_Size | +| mtulpv6 | Uint32 | O | 0..1 | MTU size, in octets, of the largest IPv6 packet that the interface will send and receive, as specified in IETF RFC 8344 [55].
Minimum = 1280 | MTU_Size | + +## 5.6.2.42 Type QosMonitoringReport + +**Table 5.6.2.42-1: Definition of type QosMonitoringReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| refPccRuleIds | array(string) | M | 1..N | An array of PCC rule id references to the PCC rules associated with the QoS Monitoring report. | | +| ulDelays | array(integer) | O | 1..N | Uplink packet delay in units of milliseconds. (NOTE 1) | | +| dlDelays | array(integer) | O | 1..N | Downlink packet delay in units of milliseconds. (NOTE 1) | | +| rtDelays | array(integer) | O | 1..N | Round trip delay in units of milliseconds. (NOTE 1) | | +| ulCongInfo | UInteger | O | 1..N | Uplink congestion information (without "%" sign). (NOTE 3) | EnQoSMon | +| dlCongInfo | UInteger | O | 0..1 | Downlink congestion information. (without "%" sign). (NOTE 3) | EnQoSMon | +| pdmf | boolean | O | 0..1 | Packet delay measurement failure indicator. When set to true, it indicates that a packet delay failure has occurred.
Default value is false if omitted. (NOTE 2) | PacketDelayFailureReport | +| cimf | boolean | O | 0..1 | Congestion information measurement failure indicator. When set to true, it indicates that a congestion information failure has occurred.
Default value is false if omitted. (NOTE 3) | EnQoSMon | +| ulDataRate | BitRate | O | 0..1 | Uplink data rate. (NOTE 4) | EnQoSMon | +| dlDataRate | BitRate | O | 0..1 | Downlink data rate. (NOTE 4) | EnQoSMon | + +NOTE 1: In this release of the specification the maximum number of elements in the array is 2. If more than one value is received at one given point of time for UL packet delay, DL packet delay or round trip packet delay respectively, the NF service consumer reports the minimum and maximum packet delays to the PCF; when more than one value is sent at one given point of time for congestion information, they represent the minimum and maximum congestion information. + +NOTE 2: When the "pdmf" attribute is set to true, the rest of parameters shall not be present. + +NOTE 3: When the "ulDataRate" and/or "dlDataRate" attributes are present, the congestion related attributes and the packet delay related attributes shall not be present. + +Editor's note: Whether the "ulCongInfo" and "dlCongInfo" attributes are single or plural is FFS. + +Editor's note: It is FFS whether the "cimf" attribute is needed. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +## 5.6.2.43 Type AdditionalAccessInfo + +**Table 5.6.2.43-1: Definition of type AdditionalAccessInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------|---------------| +| accessType | AccessType | M | 1 | The Access Type where the served UE is camping. | | +| ratType | RatType | O | 0..1 | The RAT Type where the served UE is camping. | | + +## 5.6.2.44 Void + +## 5.6.2.45 Type PortManagementContainer + +Table 5.6.2.45-1: Definition of type PortManagementContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| portManCont | Bytes | M | 1 | Transports port management information for a DS-TT port or a NW-TT port encoded as specified in clause 9.11.4.27 of 3GPP TS 24.501 [20] starting with octet 4. | | +| portNum | TsnPortNumber | M | 1 | Provides port number for a DS-TT port or a NW-TT port. | | + +## 5.6.2.46 Type IpMulticastAddressInfo + +Table 5.6.2.46-1: IpMulticastAddressInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| srcIpv4Addr | Ipv4Addr | C | 0..1 | Indicates the source IPv4 address of the DL multicast flow. Maybe included if the "ipv4MulAddr" attribute is included. | | +| ipv4MulAddr | Ipv4Addr | O | 0..1 | Indicates the destination IPv4 multicast address of the DL multicast flow. | | +| srcIpv6Addr | Ipv6Addr | C | 0..1 | Indicates the source IPv6 address of the DL multicast flow. Maybe included if the "ipv6MulAddr" attribute is included. | | +| ipv6MulAddr | Ipv6Addr | O | 0..1 | Indicates the destination IPv6 multicast address of the DL multicast flow. | | + +NOTE: Either "ipv4MulAddr" attribute or "ipv6MulAddr" attribute shall be included. + +## 5.6.2.47 Type BridgeManagementContainer + +Table 5.6.2.47-1: Definition of type BridgeManagementContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| bridgeManCont | Bytes | M | 1 | Transports TSC user plane node management service message encoded as specified in clause 8.7 of 3GPP TS 24.539 [49]. | | + +## 5.6.2.48 Type DownlinkDataNotificationControl + +Table 5.6.2.48-1: Definition of type DownlinkDataNotificationControl + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------------|---|-------------|---------------------------------------------------|------------------------| +| notifCtrlInds | array(NotificationControlIndication) | M | 1..N | Indicates the event notification(s) is requested. | DDNEEventPolicyControl | +| typesOfNotif | array(DIDataDeliveryStatus) | O | 1..N | Contains the type of notification of DDD Status. | DDNEEventPolicyControl | + +NOTE: In this release of the specification the maximum number of elements in the array is 2. + +### 5.6.2.49 Type DownlinkDataNotificationControlRm + +This data type is defined in the same way as the "DownlinkDataNotificationControl" data type, but: + +- with the OpenAPI "nullable: true" property; +- the removable attributes "notifCtrlInds", and "typesOfNotif" attribute are defined as nullable in the OpenAPI. + +### 5.6.2.50 Type SgsnAddress + +**Table 5.6.2.50-1: Definition of type SgsnAddress** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------|---------------| +| sgsnIpv4Addr | Ipv4Addr | O | 0..1 | Includes the IPv4 address of the access network gateway control node. | | +| sgsnIpv6Addr | Ipv6Addr | O | 0..1 | Includes the IPv6 address of the access network gateway control node. | | +| NOTE: At least one address of the SGSN (the IPv4 address or the IPv6 address or both if both addresses are available) shall be included. | | | | | | + +### 5.6.2.51 Void + +### 5.6.2.52 Type ThresholdValue + +**Table 5.6.2.52 -1: Definition of type ThresholdValue** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| rttThres | UIntegerRm | O | 0..1 | Unsigned integer identifying a threshold value of Maximum RTT in units of milliseconds. | | +| plrThres | PacketLossRateRm | O | 0..1 | Indicates a threshold value of Maximum Packet Loss Rate. | | +| NOTE: At least one of the attributes shall be included. | | | | | | + +### 5.6.2.53 Type NwdafData + +**Table 5.6.2.53-1: Definition of type NwdafData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| nwdafInstanceId | NfInstanceId | M | 1 | Uniquely identifies the NWDAF Instance ID consumed by the NF service consumer. | | +| nwdafEvents | array(NwdafEvent) | O | 1..N | List of Analytics IDs consumed by the NF service consumer. | | + +### 5.6.2.54 Type CallInfo + +**Table 5.6.2.54-1: Definition of type CallInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| callingPartyAddrs | array(string) | O | 1..N | Identifies the address(es) (SIP URI or Tel URI) which identifies the party (Public User Identity or Public Service Identity) initiating a SIP transaction. The coding of each calling party address is the same as defined as clause 7.2.33 of 3GPP TS 32.299[60] | | +| calleeInfo | CalleeInfo | O | 0..1 | Identifies the callee information | | + +### 5.6.2.55 Type CalleeInfo + +**Table 5.6.2.55-1: Definition of type CalleeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| calledPartyAddr | string | O | 0..1 | Holds the address of the party (Public User ID or Public Service ID) to whom the SIP transaction is posted in the context of an end-to-end SIP transaction as defined in clause 7.2.32 in 3GPP TS 32.299 [60]. | | +| requestPartyAddrs | array(string) | O | 1..N | Holds the address(es) of the party (Public User ID or Public Service ID) to whom the SIP transaction was originally posted as defined in clause 7.2.176 in 3GPP TS 32.299 [60]. | | +| calledAssertIds | array(string) | O | 1..N | Holds the address(es) (SIP URI and/or Tel URI) of the party (Public User ID or Public Service ID) of the finally asserted called party as defined in clause 7.2.31 of 3GPP TS 32.299 [60]. | | + +### 5.6.2.56 Type TrafficParaData + +**Table 5.6.2.56-1: Definition of type TrafficParaData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| periodInfo | PeriodicityInfo | O | 0..1 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | | +| reqTrafficParas | array(TrafficParameterMeas) | M | 1..N | Indicates the traffic parameters to be measured.
(NOTE) | | +| repFreqs | array(Reporting Frequency) | M | 1..N | Represents the notification method (periodic or on event detection). | | +| dlN6JitterThr | UInteger | O | 0..1 | Indicates to measure the downlink N6 jitter range associated with downlink Periodicity. | | +| repPeriod | DurationSecRm | O | 0..1 | Indicates the time interval between successive event notifications. Only applicable when the "notifMethod" attribute includes the value "PERIODIC". | | + +NOTE: The DL\_PERIOD and UL\_PERIOD may be provided in the "reqTrafficParas" attribute if the "periodUI" and "periodUL" attributes contained in "periodInfo" attribute are not included. + +### 5.6.2.57 Type L4sSupportInfo + +**Table 5.6.2.57-1: Definition of type L4sSupportInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| refPccRuleIds | array(string) | M | 1..N | An array of PCC rule id references to the PCC rules associated with the ECN marking for L4S support information. | | +| notifType | L4sNotifType | M | 1 | Indicates whether the ECN marking for L4S for the indicated SDFs are "NOT_AVAILABLE" or "AVAILABLE" again. | | + +### 5.6.2.58 Void + +### 5.6.2.59 Type SliceUsgCtrlInfo + +**Table 5.6.2.59-1: Definition of type SliceUsgCtrlInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|----------------------------------------------------------|---------------| +| pduSessInactivTimer | DurationSecRm | O | 0..1 | Represents the slice PDU Session inactivity timer value. | | + +## 5.6.3 Simple data types and enumerations + +### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. For additional simple data types see 3GPP TS 29.571 [11]. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| 5GSmCause | UInteger | Indicates the 5GSM cause code value as defined in clause 9.11.4.2 of 3GPP TS 24.501 [20]. | RAN-NAS-Cause | +| EpsRanNasRelCause | string | Indicates the RAN or NAS release cause code information in 3GPP-EPS access type or indicates the TWAN or untrusted WLAN release cause code information in Non-3GPP-EPS access type. It shall be coded as per the RAN/NAS Cause in clause 8.103 of 3GPP TS 29.274 [37], starting with Octet 5. | RAN-NAS-Cause | +| FlowDescription | string | Defines a packet filter for an IP flow. Refer to clause 5.4.2 of 3GPP TS 29.212 [23] for encoding. | | +| PacketFilterContent | string | Defines a packet filter for an IP flow. Refer to clause 5.3.54 of 3GPP TS 29.212 [23] for encoding. | | +| TsnPortNumber | UInteger | Port number for the device side of the PDU session or for the NW-TT port. | TimeSensitiveNetworking | +| ApplicationDescriptor | Bytes | Defines the OS Id and the OS application identifier for an ATSSS rule, where the OS Id is optional. It is a sequence of octets representing the traffic descriptor(s) of the ATSSS rule as Os Id, if applicable, and Os App Id as defined in table 6.1.3.2-1 of 3GPP TS 24.193 [43]. | ATSSS | +| UePolicyContainer | Bytes | Defines a UE policy delivery service message. Refer to Annex D.5 of 3GPP TS 24.501 [20] for encoding. | EpsUrsp | +| UrspEnforcementInfo | Bytes | Defines a UE policy Enforcement Report. Refer to 3GPP TS 24.501 [20], clause 9.11.4 for encoding. | URSPEnforcement | + +### 5.6.3.3 Enumeration: FlowDirection + +**Table 5.6.3.3-1: Enumeration FlowDirection** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 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 NF service consumer. | | + +### 5.6.3.4 Enumeration: ReportingLevel + +**Table 5.6.3.4-1: Enumeration ReportingLevel** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------|---------------| +| 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. | | + +### 5.6.3.5 Enumeration: MeteringMethod + +**Table 5.6.3.5-1: Enumeration MeteringMethod** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------|---------------| +| 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. | | + +### 5.6.3.6 Enumeration: PolicyControlRequestTrigger + +**Table 5.6.3.6-1: Enumeration PolicyControlRequestTrigger** + +| Enumeration value | Description | Applicability | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| PLMN_CH | PLMN Change. | | +| RES_MO_RE | A request for resource modification has been received by the NF service consumer. (NOTE) | | +| AC_TY_CH | Access Type Change. It also indicates the addition or removal of Access Type for MA PDU session. | | +| UE_IP_CH | UE IP address change. (NOTE) | | +| 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. | UMC | +| APP_STA | The start of application traffic has been detected. | ADC | +| APP_STO | The stop of application traffic has been detected. | ADC | +| AN_INFO | Access Network Information report. | NetLoc | +| CM_SES_FAIL | Credit management session failure. | | +| PS_DA_OFF | The NF service consumer reports when the 3GPP PS Data Off status changes. (NOTE) | 3GPP-PS-Data-Off | +| DEF_QOS_CH | Default QoS Change. (NOTE) | | +| SE_AMBR_CH | Session-AMBR Change. (NOTE) | | +| QOS_NOTIF | The NF service consumer notify the PCF when receiving notification from RAN that QoS targets of the QoS Flow cannot be guaranteed or can be guaranteed. | | +| NO_CREDIT | Out of credit. | | +| REALLO_OF_CREDIT | Reallocation of credit | ReallocationOfCredit | +| PRA_CH | Change of UE presence in Presence Reporting Area. | PRA | +| 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 NF service consumer generated the request because there has been a PCC revalidation timeout (i.e. Enforced PCC rule request defined in table 6.1.3.5.-1 of 3GPP TS 23.503 [6]). | | +| RES_RELEASE | Indicates that the NF service consumer can inform the PCF of the outcome of the release of resources for those rules that require so. | RAN-NAS-Cause | +| SUCC_RES_ALLO | Indicates that the NF service consumer shall inform the PCF of the successful resource allocation for those rules that requires so. | | +| RAT TY_CH | RAT type change. | | +| REF_QOS_IND_CH | Reflective QoS indication Change. | | +| NUM_OF_PACKET_FILTER | Indicates that the NF service consumer shall report the number of supported packet filter for signalled QoS rules. (NOTE) Only applicable to the interworking scenario as defined in Annex B. | | +| UE_STATUS_RESUME | Indicates that the UE's status is resumed. Only applicable to the interworking scenario as defined in Annex B. | PolicyUpdateWhenUESuspends | +| UE_TZ_CH | UE Time Zone Change. | | +| AUTH_PROF_CH | Indicates that the DN-AAA authorization profile index has changed. (NOTE) | DN-Authorization | +| TSN_BRIDGE_INFO | Indicates the NF service consumer has detected information about new TSC user plane node port(s), and/or new/updated UMIC and/or PMIC(s). | TimeSensitiveNetworking | +| QOS_MONITORING | Indicates that the NF service consumer notifies the PCF of the QoS Monitoring information. | QosMonitoring | +| SCELL_CH | Location Change with respect to the Serving Cell. | | +| USER_LOCATION_CH | Indicates that user location has changed, applicable to serving area change and serving cell change. | AggregatedUELocChanges | +| EPS_FALLBACK | EPS Fallback report is enabled in the NF service consumer. Only applicable to the interworking scenario as defined is Annex B. | EPSFallbackReport | +| MA_PDU | Indicates that the NF service consumer notifies the PCF of the MA PDU session request. Only applicable to the interworking scenario as defined in Annex B. (NOTE) | ATSSS | +| 5G_RG_JOIN | The 5G-RG has joined to an IP Multicast Group. | WWC | +| 5G_RG_LEAVE | The 5G-RG has left an IP Multicast Group. | WWC | + +| | | | +|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| DDN_FAILURE | Indicates that the NF service consumer requests policies from PCF if it received an event subscription for DDN Failure event. | DDNEventPolicyControl | +| DDN_DELIVERY_STATUS | Indicates that the NF service consumer requests policies from PCF if it received an event subscription for DDN Delivery Status event. | DDNEventPolicyControl | +| GROUP_ID_LIST_CHG | UE Internal Group Identifier(s) has changed: the NF service consumer reports that UDM provided list of group Ids has changed. (NOTE) | GroupIdListChange | +| DDN_FAILURE_CANCELLATION | Indicates that the event subscription for DDN Failure event is cancelled. | DDNEventPolicyControl2 | +| DDN_DELIVERY_STATUS_CANCELLATION | Indicates that the event subscription for DDD STATUS is cancelled. | DDNEventPolicyControl2 | +| VPLMN_QOS_CH | Indicates that the NF service consumer has detected the change of the QoS supported in the VPLMN, the change from the case where the QoS constraints are applicable to the case where the QoS constraints are not applicable (e.g. the UE moves back from the home routed to the non-roaming scenario) or vice versa. (NOTE) | VPLMN-QoS-Control | +| SUCC_QOS_UPDATE | Indicates that the NF service consumer notifies the PCF of the successful update of the QoS for MPS. | MPSforDTS | +| SAT_CATEGORY_CHG | Indicates that the SMF has detected a change between different satellite category, or non-satellite backhaul. | SatBackhaulCategoryChg | +| PCF_UE_NOTIF_IND | Indicates the SMF has detected the AMF forwarded the PCF for the UE indication to receive/stop receiving notifications of SM Policy association established/terminated events. (NOTE) | AMInfluence | +| NWDAF_DATA_CHG | Indicates that the NWDAF instance IDs used for the PDU session and/or associated Analytics IDs have changed. (NOTE) | EneNA | +| UE_POL_CONT_IND | Indicates that the NF service consumer has received a new UE policy container from the UE in EPC over a PDN connection. Only applicable to the interworking scenario as defined in Annex B. (NOTE) | EpsUrsp | +| URSP_ENFORCEMENT_INFO | Indicates that the NF service consumer has detected a report of URSP rule enforcement information. | URSPEnforcement | +| HR_SBO_IND_CHG | Indicates the HR-SBO support indication has changed. (NOTE) | HR-SBO | +| L4S_SUPP | Indicates whether the ECN marking for L4S support is not available or available again in 5GS. | L4S | +| NET_SLICE_REPL | Indicates network slice replacement, i.e., a change between the initial S-NSSAI of the PDU Session and the Alternative S-NSSAI. (NOTE) | NetSliceRepl | +| BAT_OFFSET_INFO | Indicates that the NF service consumer has detected the information about the BAT offset and optionally adjusted periodicity. | EnTSCAC | +| NOTE: The NF service consumer always reports to the PCF. | | | + +The PCF may provision the values of policy control request trigger which are not always reported by the NF service consumer as defined in clause 4.2.6.4. + +When the NF service consumer detects the corresponding policy control request trigger(s), the NF service consumer shall report the detected trigger(s) to the PCF as defined in clause 4.2.4.1 with the additional information for different independent policy control request triggers as follows: + +If the "PLMN\_CH" is provisioned, when the NF service consumer detects a change of the serving network (a PLMN or an SNPN), the NF service consumer shall include the "PLMN\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current identifier of the serving network within the "servingNetwork" attribute. + +NOTE 1: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +When the NF service consumer receives the resource modification request from the UE, the NF service consumer shall include the "RES\_MO\_RE" within the "repPolicyCtrlReqTriggers" attribute and the information for requesting the PCC rule as defined in clause 4.2.4.17. + +If the "AC\_TY\_CH" is provisioned, when the NF service consumer detects a change of access type, the NF service consumer shall include the "AC\_TY\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current access type + +within the "accessType" attribute. The RAT type encoded in the "ratType" attribute shall also be provided when applicable to the specific access type. Specific attributes for the EPC interworking case are described in Annex B. If the ATSSS feature is supported, when the NF service consumer detects an access is added or released for MA PDU session, the NF service consumer shall include the added Access Type or released Access type encoded as "accessType" attribute within the AdditionalAccessInfo data structure. The RAT type encoded in the "ratType" attribute shall also be provided within the AdditionalAccessInfo data structure when applicable to the added access type or released access type. + +When the NF service consumer detects an IPv4 address and/or an IPv6 prefix is allocated or released, the NF service consumer shall include the "UE\_IP\_CH" within the "repPolicyCtrlReqTriggers" attribute and new allocated UE IPv4 address within the "ipv4Address" attribute and/or the UE IPv6 prefix within the "ipv6AddressPrefix" attribute or the released UE IPv4 address within the "relIpv4Address" attribute and/or the UE IPv6 prefix within the "relIpv6AddressPrefix" attribute. If the "MultiIpv6AddrPrefix" feature is supported, and if an additional allocated or released IPv6 prefix is detected, the NF service consumer shall include the new allocated UE IPv6 prefix within the "addIpv6AddrPrefixes" attribute and the released UE IPv6 prefix within the "addRelIpv6AddrPrefixes" attribute. If the "UnlimitedMultiIpv6Prefix" feature is supported, and if multiple allocated or released IPv6 prefixes are detected, the NF service consumer shall include the new allocated UE IPv6 prefixes within the "multiIpv6Prefixes" attribute and the released UE IPv6 prefixes within the "mutliRelIpv6Prefixes" attribute. + +When the NF service consumer detects a new UE MAC address or a used UE MAC address is not used any more, the NF service consumer shall include the "UE\_MAC\_CH" within the "repPolicyCtrlReqTriggers" attribute and new detected UE MAC address within the "ueMac" attribute or the not used UE MAC address within the "relUeMac" attribute. + +If the "AN\_CH\_COR" is provisioned, when the NF service consumer is provisioned with the PCC rule as defined in clause 4.2.6.5.1, the NF service consumer shall notify the PCF of access network charging identifier associated with the PCC rules as defined in clause 4.2.4.13. + +If the "US\_RE" is provisioned, when the NF service consumer receives the usage report from the UPF, the NF service consumer shall notify the PCF of the accumulated usage as defined in clause 4.2.4.10. Applicable to functionality introduced with the UMC feature as described in clause 5.8. + +If the "APP\_STA" is provisioned, when the NF service consumer receives the application start report from the UPF, the NF service consumer shall notify the PCF of the application start report as defined in clause 4.2.4.6. Applicable to functionality introduced with the ADC feature as described in clause 5.8. + +If the "APP\_STO" is provisioned, when the NF service consumer receives the application stop report from the UPF, the NF service consumer shall notify the PCF of the application stop report as defined in clause 4.2.4.6. Applicable to functionality introduced with the ADC feature as described in clause 5.8. + +If the "AN\_INFO" is provisioned, when the NF service consumer receives the reported access network information from the access network, the NF service consumer shall notify the PCF of the access network information as defined in clause 4.2.4.9. Applicable to functionality introduced with the NetLoc feature as described in clause 5.8. + +If the "CM\_SES\_FAIL" is provisioned, when the NF service consumer receives a detected transient/permanent failure from the CHF, the NF service consumer shall include the "CM\_SES\_FAIL" within the "repPolicyCtrlReqTriggers" attribute. If the failure does not apply to all PCC Rules, the affected PCC Rules are indicated within the "ruleReports" attribute, with the "ruleStatus" attribute set to value ACTIVE and the "failureCode" attribute set to the corresponding value as reported by the CHF; otherwise if the failure applies to the session, the "creditManageStatus" shall be set to the corresponding value as reported by the CHF. + +If the "PS\_DA\_OFF" is provisioned, when the NF service consumer receives a change of 3GPP PS Data Off status from the UE, the NF service consumer shall notify the PCF as defined in clause 4.2.4.8. Applicable to functionality introduced with the 3GPP-PS-Data-Off feature as described in clause 5.8. + +When the NF service consumer detects a change of subscribed default QoS, the NF service consumer shall include the "DEF\_QOS\_CH" within the "repPolicyCtrlReqTriggers" attribute and the new subscribed default QoS within the "subsDefQos" attribute. + +When the NF service consumer detects a change of Session-AMBR, the NF service consumer shall include the "SE\_AMBR\_CH" within the "repPolicyCtrlReqTriggers" attribute and the new Session-AMBR within the "subsSessAmbr" attribute. + +If the "QOS\_NOTIF" is provisioned, when the NF service consumer receives a notification from access network that QoS targets of the QoS Flow cannot be guaranteed or can be guaranteed again, the NF service consumer shall send the notification as defined in clause 4.2.4.20. + +If the "NO\_CREDIT" is provisioned, when the NF service consumer detects the credit for the PCC rule(s) is no longer available, the NF service consumer shall include the "NO\_CREDIT" within the "repPolicyCtrlReqTriggers" attribute, the termination action the NF service consumer applies to the PCC rules as instructed by the CHF within the "finUnitAct" attribute and the affected PCC rules within the "ruleReports" attribute. + +When the "ReallocationOfCredit" feature is supported, if the "REALLO\_OF\_CREDIT" is provisioned, when the NF service consumer detects the credit for the PCC rule(s) is reallocated, the NF service consumer shall include the "REALLO\_OF\_CREDIT" within the "repPolicyCtrlReqTriggers" attribute and include the affected PCC rules for which credit has been reallocated after credit was no longer available and the "ruleStatus" attribute set to value ACTIVE within the "ruleReports" attribute. + +If the "PRA\_CH" is provisioned, to detect when the UE enters/leaves certain presence reporting areas, the NF service consumer is provisioned the presence reporting area information as defined in clause 4.2.6.5.6. When the NF service consumer receives the presence reporting area information from the serving node, the NF service consumer shall notify the PCF of the reported presence area information as defined in clause 4.2.4.16. This report includes reporting the initial status at the time the request for reports is initiated. Applicable to the functionality introduced by the PRA or ePRA feature as described in clause 5.8. + +If the "SAREA\_CH" is provisioned, when the NF service consumer detects a change of serving area (i.e. tracking area, or if the feature "2G3GIWK" is supported routing area), the NF service consumer shall include the "SAREA\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current TAI within the "userLocationInfo" attribute in either the "eutraLocation" or "nrLocation", or the current Routing Area within the "userLocationInfo" attribute in the "utraLocation" attribute when UTRAN access, or in the "geraLocation" attribute when GERAN access, as applicable. Non-3GPP access user location is reported in the "n3gaLocation" attribute when applicable. The attributes used in case of EPC interworking are described in Annex B. + +If the "SCNN\_CH" is provisioned, when the NF service consumer detects a change of serving Network Function (i.e. the AMF, ePDG, S-GW or if the feature "2G3GIWK" is supported SGSN), the NF service consumer shall include the "SCNN\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current serving Network Function in the "servNfId" attribute if available. When the serving Network Function is an AMF, the NF service consumer shall include the AMF Network Function Instance Identifier within the "servNfInstId" attribute and the Globally Unique AMF Identifier within the "guami" attribute. The attributes included in case of EPC interworking are described in Annex B. + +NOTE 1: In the home-routed roaming case, if the AMF change is unknown to the H-SMF, then the AMF change is not reported. + +If the "RE\_TIMEOUT" is provisioned, when the NF service consumer is provisioned with the revalidation time by the PCF, the NF service consumer shall request the policy before the indicated revalidation time is reached as defined in clause 4.2.4.3. + +If the "RES\_RELEASE" is provisioned, when the NF service consumer receives the request of PCC rule removal as defined in clause 4.2.6.5.2, the NF service consumer shall report the outcome of resource release as defined in clause 4.2.4.12. Applicable to functionality introduced with the RAN-NAS-Cause feature as described in clause 5.8. + +When "SUCC\_RES\_ALLO" is provisioned and PCC rules are provisioned according to clause 4.2.6.5.5, the NF service consumer shall inform the PCF of the successful resource allocation as defined in clause 4.2.4.14. + +If the feature "2G3GIWK" is supported, and if the "RAI\_CH" is provisioned, when the NF service consumer detects a change of routing area, the NF service consumer shall include the "RAI\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current RAI within the "userLocationInfo" attribute as described in Annex B. + +If the "RAT TY\_CH" is provisioned, when the NF service consumer detects a change of the RAT type, the NF service consumer shall include the "RAT TY\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current RAT type within the "ratType" attribute. For MA PDU session, the NF service consumer shall include the current RAT type at the SmPolicyUpdateContextData data type level or AdditionalAccessInfo data type level. If the RAT type is provided at the SmPolicyUpdateContextData data type level, the NF service consumer shall also provide the associated access type within the SmPolicyUpdateContextData data structure. + +If the "REF\_QOS\_IND\_CH" is provisioned, when the NF service consumer receives a change of reflective QoS indication from the UE, the NF service consumer shall include the "REF\_QOS\_IND\_CH" within the "repPolicyCtrlReqTriggers" attribute and the indication within the "refQosIndication" attribute. + +When the NF service consumer receives the number of supported packet filter for signalled QoS rules for the PDU session from the UE during the PDU Session Modification procedure after the first inter-system change from EPS to 5GS for a PDU Session established in EPS and transferred from EPS with N26 interface, the NF service consumer shall include the "NUM\_OF\_PACKET\_FILTER" within the "repPolicyCtrlReqTriggers" attribute and the number of supported packet filter for signalled QoS rules within the "numOfPackFilter" attribute. Only applicable to the interworking scenario as defined in Annex B. + +If the "UE\_STATUS\_RESUME" is provisioned, when the NF service consumer detected the UE's status is resumed from suspend state, the NF service consumer shall inform the PCF of the UE status including the "UE\_STATUS\_RESUME" within "repPolicyCtrlReqTriggers" attribute. The PCF shall after this update the NF service consumer with PCC Rules or session rules if necessary. Applicable to functionality introduced with the PolicyUpdateWhenUESuspends feature as described in clause 5.8. + +If the "UE\_TZ\_CH" is provisioned, when the NF service consumer detects a change of the UE Time Zone, the NF service consumer shall include the "UE\_TZ\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current UE Time Zone within the "ueTimeZone" attribute. + +If the "DN-Authorization" feature is supported, when the NF service consumer detects a change of DN-AAA authorization profile index, the NF service consumer shall include the "AUTH\_PROF\_CH" within the "repPolicyCtrlReqTriggers" attribute and the new DN-AAA authorization profile index within the "authProfIndex" attribute. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported and "TSN\_BRIDGE\_INFO" is provisioned, when the NF service consumer detects: + +- there is information about new TSC user plane node port(s), e.g. a new manageable Ethernet port, the NF service consumer shall include the "TSN\_BRIDGE\_INFO" within the "repPolicyCtrlReqTriggers" attribute and the updated TSC user plane node information within the "tsnBridgeInfo" attribute; and/or +- the NF service consumer detects a UMIC or PMIC, the NF service consumer shall include the "TSN\_BRIDGE\_INFO" within the "repPolicyCtrlReqTriggers" attribute and the UMIC, if available, within the "tsnBridgeManCont" attribute, and/or the PMIC(s), if available, within the "tsnPortManContDstt" and the "tsnPortManContNwts" attributes. + +NOTE 2: When the NF service consumer detects updated Port Management Information of the NW-TT ports, the NF service consumer includes the PMIC within the "tsnPortManContNwts" attribute of SmPolicyUpdateContextData data type. + +If the "QoSMonitoring" feature and/or the "EnQoSMon" is supported and if the "QOS\_MONITORING" is provisioned, upon receiving the QoS Monitoring report from the UPF, the NF service consumer shall send the QoS monitoring report(s) for the concerned PCC rules to the PCF as defined in clause 4.2.4.24. + +If the "SCELL\_CH" is provisioned, when the NF service consumer detects a change of serving cell, the NF service consumer shall include the "SCELL\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current cell Id within the "userLocationInfo" attribute either in the "eutraLocation" attribute when EPC/E-UTRAN access or "nrLocation" attribute when NR access or "geraLocation" attribute when GERAN access or "utraLocation" attribute when UTRAN access, as applicable. + +NOTE 3: Location change of serving cell can increase signalling load on multiple interfaces. Hence, it is recommended that any such serving cell changes event trigger subscription is only applied for a limited number of subscribers. + +If the "AggregatedUELocChanges" feature is supported and the "USER\_LOCATION\_CH" is provisioned, when the NF service consumer detects a change of serving cell and/or a change of serving area (i.e. tracking area), the NF service consumer shall include the "USER\_LOCATION\_CH" within the "repPolicyCtrlReqTriggers" attribute and the current serving area and/or cell Id within the "userLocationInfo" attribute in the "eutraLocation" attribute or "nrLocation" attribute or "geraLocation" attribute or "utraLocation" attribute, as applicable. + +NOTE 4: The access network can be configured to report location changes only when transmission resources are established in the radio access network. + +If the "EPSFallbackReport" feature is supported and the "EPS\_FALLBACK" is provisioned and there is a PCC rule installed that required the reporting, when the NF service consumer receives a PDU session modification response indicating the rejection of the establishment of the QoS flow with 5QI=1, the NF service consumer shall notify the PCF of EPS fallback as defined in clause B.3.4.6. + +When the NF service consumer receives the MA PDU Request Indication or MA PDU Network-Upgrade Allowed Indication and ATSSS Capability from the UE during the PDU Session Modification procedure after the first inter-system change from EPS to 5GS for a PDU Session established in EPS and transferred from EPS with N26 interface, the NF service consumer shall include the "MA\_PDU" within the "repPolicyCtrlReqTriggers" attribute, the MA PDU session Indication in the "maPduInd" attribute, the ATSSS capability of the MA PDU session within the "atsssCapab" attribute. Only applicable to the interworking scenario as defined in Annex B. + +If the "WWC" feature is supported and "5G\_RG\_JOIN" is provisioned and when the NF service consumer detects a 5G-RG has joined to an IP Multicast Group, the NF service consumer shall include the "5G\_RG\_JOIN" within the "repPolicyCtrlReqTriggers" attribute and the IP multicast addressing information within the "mulAddrInfos" attribute. + +If the "WWC" feature is supported and "5G\_RG\_LEAVE" is provisioned and when the NF service consumer detects a 5G-RG has left an IP Multicast Group, the NF service consumer shall include the "5G\_RG\_LEAVE" within the "repPolicyCtrlReqTriggers" attribute and the IP multicast addressing information within the "mulAddrInfos" attribute. + +If "DDNEventPolicyControl" feature is supported, and if "DDN\_FAILURE" is provisioned, when the NF service consumer receives an event subscription for DDN Failure event including the traffic descriptors, the NF service consumer shall include the "DDN\_FAILURE" within the "repPolicyCtrlReqTriggers" attribute and traffic descriptor(s) within the "trafficDescriptors" attribute. + +If "DDNEventPolicyControl" feature is supported, and if "DDN\_DELIVERY\_STATUS" is provisioned, when the NF service consumer receives an event subscription for DDD Status event including the traffic descriptors, the NF service consumer shall include the "DDN\_DELIVERY\_STATUS" within the "repPolicyCtrlReqTriggers" attribute and traffic descriptor(s) within the "trafficDescriptors" attribute and the requested type(s) of notifications (notifications about downlink packets being buffered, and/or discarded). + +If "GroupIdListChange" feature is supported, when the SMF receives the updated Internal Group Identifier(s) from the UDM, the SMF shall include the "GROUP\_ID\_LIST\_CHG" within the "repPolicyCtrlReqTriggers" attribute and the Internal Group Identifier(s) of the served UE within the "interGrpIds" attribute. + +If "DDNEventPolicyControl2" feature is supported, and if "DDN\_FAILURE\_CANCELLATION" is provisioned, when the SMF receives a cancellation of event subscription for DDN Failure event, the SMF shall include the "DDN\_FAILURE\_CANCELLATION" within the "repPolicyCtrlReqTriggers" attribute and the PCC rule identifier of the PCC rule which is used for traffic detection of DDN failure event within the "pccRuleId" attribute. + +If "DDNEventPolicyControl2" feature is supported, and if "DDN\_DELIVERY\_STATUS\_CANCELLATION" is provisioned, when the SMF receives a cancellation of event subscription for DDD Status event, the SMF shall include the "DDN\_DELIVERY\_STATUS\_CANCELLATION" within the "repPolicyCtrlReqTriggers" attribute and the PCC rule identifier of the PCC rule which is used for traffic detection of DDD status event within the "pccRuleId" attribute. + +When the "VPLMN-QoS-Control" feature is supported and if the NF service consumer receives a new QoS value supported in the VPLMN, the NF service consumer shall include the "VPLMN\_QOS\_CH" within the "repPolicyCtrlReqTriggers" attribute and the received QoS constraints within the "vplmnQos" attribute; if the NF service consumer detects that the UE moves from a VPLMN with QoS constraints to the HPLMN or to a VPLMN without QoS constraints, the NF service consumer shall include the "VPLMN\_QOS\_CH" within the "repPolicyCtrlReqTriggers" attribute and the "vplmnQosNotApp" attribute set to true. + +If the "MPSforDTS" feature is supported, and if "SUCC\_QOS\_UPDATE" is provisioned, when the resources for the MPS for DTS invocation/revocation are successfully allocated for MPS for DTS, the NF service consumer shall include the "SUCC\_QOS\_UPDATE" within the "repPolicyCtrlReqTriggers" attribute. + +If "SatBackhaulCategoryChg" is supported, and if "SAT\_CATEGORY\_CHG" is provisioned, the NF service consumer notifies the PCF when there is a change of the backhaul which is used for the PDU session between different satellite backhaul categories or between a satellite backhaul and a non-satellite backhaul. When the "EnSatBackhaulCatChg" feature is supported, the different dynamic satellite backhaul categories may also be reported. The NF service consumer shall include the satellite backhaul category or dynamic satellite backhaul category or non-satellite backhaul within the "satBackhaulCategory" attribute together with the "SAT\_CATEGORY\_CHG" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +NOTE 5: Only a single backhaul category can be indicated. + +If the "AMInfluence" feature is supported, the NF service consumer notifies the PCF about the PCF for the UE request to be notified of PDU session established/terminated events and if applicable, about the PCF for the UE binding information in the initial reporting and when the PCF for the UE changes by forwarding within the "pcfUeInfo" attribute, the received PCF for the UE callback URI within the "callbackUri" attribute and, if received, SBA binding information within the "bindingInfo" attribute, together with the "PCF\_UE\_NOTIF\_IND" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. The NF service consumer notifies the PCF about the PCF for the UE request to stop being notified about the PDU session established/terminated events by sending the "pcfUeInfo" attribute set to NULL together with the "PCF\_UE\_NOTIF\_IND" policy control request trigger within the "repPolicyCtrlReqTriggers" attribute. + +If "EneNA" feature is supported, the NF service consumer notifies the PCF when there is a change in the list of NWDAF Instance IDs used for the PDU Session and/or associated Analytics IDs. The NF service consumer shall include within the "nwdafDatas" attribute the list of NWDAF instance IDs used for the PDU Session within the "nwdafInstanceId" attribute and their associated Analytic ID(s) within the "nwdafEvents" attribute, and the "NWDAF\_DATA\_CHG" within the "repPolicyCtrlReqTriggers" attribute. + +If the "EpsUrsp" feature is supported, when the NF service consumer receives a new UE policy container from the UE in EPC over a PDN connection, the NF service consumer shall include the "UE\_POL\_CONT\_IND" within the "repPolicyCtrlReqTriggers" attribute and the received UE policy container within the "uePolCont" attribute. Only applicable to the interworking scenario as defined in Annex B. + +If the "URSPEnforcement" feature is supported and "URSP\_ENFORCEMENT\_INFO" is provisioned, when the NF service consumer detects the UE includes URSP enforcement information in the PDU session modification request, the NF service consumer shall include the "URSP\_ENFORCEMENT\_INFO" within the "repPolicyCtrlReqTriggers" attribute and shall forward the received information from the UE within the "urspEnfInfo" attribute. In this case, the NF service consumer shall also include, if they were not previously provided, the SSC mode within the "sscMode" attribute, the UE requested DNN (if available and different from the selected DNN) within the "ueReqDnn" attribute, and if the PDU session is redundant, the RSN and the PDU session pair ID within the "redundantPduSessionInfo" attribute. The NF service consumer shall also include the access type within the "accessType" attribute, if changed compared with the latest provided value. + +If "HR-SBO" feature is supported, the NF service consumer notifies the PCF when the HR-SBO support indication has changed. The NF service consumer shall include the "hrsboInd" attribute and set it to "true" if the HR-SBO is supported, otherwise set it to "false", and the "HR\_SBO\_IND\_CHG" within the "repPolicyCtrlReqTriggers" attribute. + +When the "L4S" feature is supported and the "L4S\_SUPP" is provisioned, when the PCC rules are provisioned with the explicit indication of ECN marking for L4S according to clause 4.2.6.21.3, the NF service consumer shall inform the PCF of the unavailability or availability again in 5GS for ECN marking for L4S support as defined in clause 4.2.6.2.21. + +If "NetSliceRepl" feature is supported, the NF service consumer notifies the PCF about network slice replacement, i.e., when there is a change between the initial S-NSSAI of the PDU Session and the Alternative S-NSSAI by including the "NET\_SLICE\_REPL" PCRT within the "repPolicyCtrlReqTriggers" attribute. When the NF service consumer reports a change from the initial S-NSSAI of the PDU Session to the Alternative S-NSSAI, it shall additionally include the Alternative S-NSSAI within the "sliceInfo" attribute. + +**Editor's Note:** Whether the initial S-NSSAI is provided to the PCF when the NF service consumer reports a change from the Alternative S-NSSAI to the initial S-NSSAI of the PDU Session via the "NET\_SLICE\_REPL" PCRT is FFS and pending stage 2 feedback. + +If "EnTSCAC" feature is supported, and if "BAT\_OFFSET\_INFO" is provisioned, when the SMF receives the notification on BAT offset and optionally adjusted periodicity, the SMF shall include the "BAT\_OFFSET\_INFO" within the "repPolicyCtrlReqTriggers" attribute and the BAT offset and optionally adjusted periodicity within the "batOffsetInfo" attribute. + +**Editor's Note:** It is FFS how the bat offset is indicated and reported per PCC rule. + +### 5.6.3.7 Enumeration: RequestedRuleDataType + +**Table 5.6.3.7-1: Enumeration RequestedRuleDataType** + +| Enumeration value | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|-------------------| +| 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. (NOTE) | | +| USER_LOC_INFO | Indicates that the requested access network info type is the UE's location. (NOTE) | | +| 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. | | +| EPS_FALLBACK | Indicates that the requested rule data is the report of QoS flow rejection due to EPS fallback. | EPSFallbackReport | +| NOTE: The requested rule data shall also be reported at QoS flow termination and PDU session termination. | | | + +### 5.6.3.8 Enumeration: RuleStatus + +**Table 5.6.3.8-1: Enumeration RuleStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ACTIVE | Indicates that the PCC rule(s) are successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in the SMF), or that the session rule(s) are successfully installed. | | +| INACTIVE | Indicates that the PCC rule(s) are removed (for those provisioned from the PCF) or inactive (for those pre-defined in the SMF) or that the session rule(s) are removed. | | + +### 5.6.3.9 Enumeration: FailureCode + +**Table 5.6.3.9-1: Enumeration FailureCode** + +| Enumeration value | Description | Applicability | +|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UNK_RULE_ID | Indicates that the pre-provisioned PCC rule could not be successfully activated because the provided PCC rule identifier is unknown to the NF service consumer. | | +| RA_GR_ERR | Indicates that the PCC rule could not be successfully installed or enforced because the Rating Group specified within the Charging Data policy decision to which the PCC rule refers is unknown or invalid. | | +| SER_ID_ERR | Indicates that the PCC rule could not be successfully installed or enforced because the Service Identifier specified within the Charging Data policy decision to which the PCC rule refers is invalid, unknown or not applicable to the service being charged. | | +| NF_MAL | Indicates that the PCC rule could not be successfully installed (for those provisioned from the PCF), activated (for those pre-defined in the SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction. | | +| RES_LIM | Indicates that the PCC rule could not be successfully installed (for those provisioned from the PCF), activated (for those pre-defined in the SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF. | | +| MAX_NR_QoS_FLOW
(NOTE) | Indicates that the PCC rule could not be successfully installed (for those provisioned from the PCF), activated (for those pre-defined in the SMF) or enforced (for those already successfully installed) due to the fact that the maximum number of QoS flows has been reached for the associated PDU session. | | +| MISS_FLOW_INFO | Indicates that the PCC rule could not be successfully installed (for those provisioned from the PCF) or enforced (for those already successfully installed) because neither the "flowInfos" attribute nor the "appld" attribute is specified by the PCF within the PCC rule entry of the "pccRules" attribute during the first PCC rule installation request. | | +| RES_ALLO_FAIL | Indicates that the PCC rule could not be successfully installed or maintained since the associated QoS flow establishment/modification failed or the associated QoS flow was released. | | +| UNSUCC_QOS_VAL | This value is used to:
- indicate that QoS validation has failed; or
- indicate when Guaranteed Bandwidth > Max-Requested-Bandwidth. | | +| INCOR_FLOW_INFO | Indicates that the PCC rule could not be successfully installed or modified at the NF service consumer 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 | Indicates that the PCC rule could not be maintained because of PS to CS handover. | | +| APP_ID_ERR | Indicates that the PCC rule could not be successfully installed or enforced because the Application Identifier is invalid, unknown, or not applicable to the application required for detection. | ADC | +| NO_QOS_FLOW_BOUND | Indicates that there is no QoS flow to which the SMF can bind the PCC rule. | | +| FILTER_RES | Indicates that the Flow Information within the "flowinfos" attribute cannot be handled by the NF service consumer because at least one of the restrictions defined in clause 5.4.2 of 3GPP TS 29.212 [23] was not respected. | | +| MISS_REDI_SER_ADDR | Indicates that the PCC rule could not be successfully installed or enforced at the NF service consumer because there is no valid Redirect Server Address within the provided Traffic Control Data policy decision to which the PCC rule refers, and no preconfigured redirection address for this PCC rule at the SMF/UPF. | ADC | +| UE_TEMPORARILY_UNAVAILABLE | Indicates that the PCC rule could not be successfully installed/modified because the SMF was informed that the UE was not reachable. | UEUnreachable | +| CM_END_USER_SER_DENIED | Indicates that the charging system denied the service request due to service restrictions (e.g. terminate rating group) or limitations related to the end-user, e.g. the end-user's account could not cover the requested service. | | + +| | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| CM_CREDIT_CON_NOT_APP | Indicates 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 via offline charging). | | +| CM_AUTH_REJ | Indicates that the charging system denied the service request in order to terminate the service for which credit is requested. | | +| CM_USER_UNK | Indicates that the specified end user could not be found in the charging system. | | +| CM_RAT_FAILED | Indicates that the charging system cannot rate the service request due to insufficient rating inputs, incorrect combination of inputs or due to an attribute or an attribute value that is not recognized or supported in the rating. | | +| UE_STA_SUSP | Indicates that the UE is in suspend state. Only applicable to the interworking scenario, as defined in Annex B. | PolicyUpdateWhenUESuspends | +| UNKNOWN_REF_ID | Indicates that the PCC rule could not be successfully installed/modified because the referenced identifier to a Policy Decision Data or to a Condition Data is unknown to the NF service consumer. | | +| INCORRECT_COND_DATA | Indicates that the PCC rule could not be successfully installed/modified because the referenced Condition data are incorrect (e.g. the "deactivationTime" and the "activationTime" included in the referenced ConditionData contain the same time value). | | +| REF_ID_COLLISION | Indicates that the PCC rule could not be successfully installed/modified because a Policy Decision referenced within the PCC rule is also referenced by a session rule (e.g. a session rule and this PCC rule refer to the same Usage Monitoring decision data). | | +| TRAFFIC_STEERING_ERROR | This value is used to indicate that:
- the enforcement of the steering of traffic to the N6-LAN or 5G-LAN failed; or
- the dynamic PCC rule could not be successfully installed/modified at the NF service consumer because e.g. there are invalid traffic steering policy identifier(s) within the provided Traffic Control Data policy decision to which the PCC rule refers.
Applicable when the functionality introduced with the TSC feature described in clause 5.8 applies. | | +| DNAI_STEERING_ERROR | This value is used to indicate that:
- the enforcement of the steering of traffic to the indicated DNAI failed; or
- the dynamic PCC rule could not be successfully installed/modified at the NF service consumer because there is invalid route information for a DNAI(s) (e.g. routing profile id is not configured) within the provided Traffic Control Data policy decision to which the PCC rule refers.
Applicable when the functionality introduced with the TSC feature described in clause 5.8 applies. | | +| AN_GW_FAILED | Indicates that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the S-GW has been recovered. This value shall not be used if the SM Policy association modification procedure is initiated for session rule removal only. | SGWRest | +| MAX_NR_PACKET_FILTERS_EXCEEDED | This value is used to indicate that the PCC rule could not be successfully installed, modified or enforced at the NF service consumer because the number of supported packet filters for signalled QoS rules for the PDU session has been reached. | | +| PACKET_FILTER_TFT_ALLOCATION_EXCEEDED | Indicates that the PCC rule is removed at 5GS to EPS mobility because TFT allocation was not possible since the number of active packet filters in the EPC bearer is exceeded. | PackFiltAllocPrecedence | +| MUTE_CHG_NOT_ALLO_WED | Indicates that the PCC rule could not be successfully modified because the mute condition for application detection report cannot be changed.
Applicable when the functionality introduced with the ADC feature described in clause 5.8 applies. | | +| NOTE: The enumeration value does not follow the related naming convention (i.e. "UPPER_WITH_UNDERSCORE") defined in clause 5.1.4 of 3GPP TS 29.501 [6]. This enumeration value is however kept as currently defined in this specification for backward compatibility considerations. | | | + +## 5.6.3.10 Enumeration: AfSigProtocol + +Table 5.6.3.10-1: Enumeration AfSigProtocol + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------------------------------|------------------| +| NO_INFORMATION | Indicate that no information about the AF signalling protocol is being provided. This is the default value. | ProvAFsignalFlow | +| SIP | Indicate that the signalling protocol is Session Initiation Protocol. | ProvAFsignalFlow | + +## 5.6.3.11 Enumeration: RuleOperation + +Table 5.6.3.11-1: Enumeration RuleOperation + +| Enumeration value | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|---------------| +| CREATE_PCC_RULE | Indicates to create a new PCC rule to reserve the resource requested by the UE. | | +| DELETE_PCC_RULE | Indicates to delete a PCC rule corresponding to reserve the resource requested by the UE. | | +| MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS | Indicates to modify the PCC rule by adding new packet filter(s). | | +| MODIFY_PCC_RULE_AND_REPLACE_PACKET_FILTERS (NOTE) | Indicates to modify the PCC rule by replacing the existing packet filter(s). | | +| MODIFY_PCC_RULE_AND_DELETE_PACKET_FILTERS (NOTE) | Indicates to modify the PCC rule by deleting the existing packet filter(s). | | +| MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS | Indicates to modify the PCC rule by modifying the QoS of the PCC rule. | | +| NOTE: The enumeration value does not follow the related naming convention (i.e. "UPPER_WITH_UNDERSCORE") defined in clause 5.1.4 of 3GPP TS 29.501 [5]. There is a space between the "MODIFY_" part and the "PCC" part. This enumeration value is however kept as currently defined in this specification for backward compatibility considerations. | | | + +## 5.6.3.12 Enumeration: RedirectAddressType + +Table 5.6.3.12-1: Enumeration RedirectAddressType + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------|---------------| +| 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. | | + +## 5.6.3.13 Enumeration: QosFlowUsage + +Table 5.6.3.13-1: Enumeration QosFlowUsage + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------|---------------| +| GENERAL | Indicates no specific QoS flow usage information is available. | | +| IMS_SIG | Indicates that the QoS flow is used for IMS signalling only. | | + +### 5.6.3.14 Enumeration: FailureCause + +**Table 5.6.3.14-1: Enumeration FailureCause** + +| Enumeration value | Description | Applicability | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| PCC_RULE_EVENT | Some of the PCC rules provisioned by the PCF in the request cannot be installed/activated. It is used to inform the PCF that the request failed and should not be attempted again. | | +| PCC_QOS_FLOW_EVENT | For some reason some of the PCC rules provisioned by the PCF in the request cannot be enforced or modified successfully in a network initiated procedure. It is used to inform the PCF that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. | | +| RULE_PERMANENT_ERR
OR | The HTTP request is rejected because some of the PCC and/or session rules provisioned by the PCF in the request cannot be installed/activated. It is used to inform the PCF that the request failed, and should not be attempted again. | SessionRuleError
Handling | +| RULE_TEMPORARY_ERR
OR | The HTTP request is rejected because for some reason some of the PCC and/or session rules provisioned by the PCF in the request cannot be enforced or modified successfully in a network initiated procedure. It is used to inform the PCF that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. | SessionRuleError
Handling | +| POL_DEC_ERROR | Some of the policy decisions (including data that is different than PCC/session rule related data) provided by the PCF in the request cannot be provisioned in the NF service consumer. | PolicyDecisionErr
orHandling | + +### 5.6.3.15 Enumeration: FlowDirectionRm + +This data type is defined in the same way as the "FlowDirection" data type, but also allows null value (specified as "NullValue" data type). + +### 5.6.3.16 Enumeration: CreditManagementStatus + +**Table 5.6.3.16-1: Enumeration CreditManagementStatus** + +| Enumeration value | Description | Applicability | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| END_USER_SER_DENIED | Indicates 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. | | +| CREDIT_CTRL_NOT_APP | Indicates 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). | | +| AUTH_REJECTED | Indicates that the charging system denied the service request in order to terminate the service for which credit is requested. | | +| USER_UNKNOWN | Indicates that the specified end user could not be found in the charging system. | | +| RATING_FAILED | Indicates that the charging system cannot rate the service request due to insufficient rating input, incorrect attribute combination or an attribute value that is not recognized or supported in rating. | | + +### 5.6.3.17 Enumeration: SessionRuleFailureCode + +**Table 5.6.3.17-1: Enumeration SessionRuleFailureCode** + +| Enumeration value | Description | Applicability | +|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| NF_MAL | Indicates that the session rule could not be successfully installed) or enforced (for those already successfully installed) due to SMF/UPF malfunction. | | +| RES_LIM | Indicates that the session rule could not be successfully installed or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF. | | +| SESSION_RESOURCE_ALLOCATION_FAILURE | Indicates the session rule could not be successfully enforced due to failure during the allocation of resources for the PDU session in the UE, RAN or AMF. | | +| UNSUCC_QOS_VAL | Indicates that the QoS validation has failed. | | +| INCORRECT_UM | The usage monitoring data of the enforced session rule is not the same for all the provisioned session rule(s), i.e., the reference identifier to a UsageMonitoringData policy decision is not homogeneously provisioned in all session rules (e.g., some, but not all, session rules contain usage monitoring data, or all session rules contain usage monitoring data, but with different monitoring key). | (NOTE) | +| UE_STA_SUSP | Indicates that the UE is in suspend state. Only applicable to the interworking scenario as defined in Annex B. | PolicyUpdateWhenUESuspends | +| UNKNOWN_REF_ID | Indicates that the session rule could not be successfully installed/modified because the reference identifier to a Policy Decision Data or to a Condition Data is unknown to the NF service consumer. | | +| INCORRECT_COND_DATA | Indicates that the session rule could not be successfully installed/modified because the referenced Condition data are incorrect (e.g. the ConditionData instance contains a "deactivationTime" attribute, or the "ratType" attribute value in a ConditionData instance indicates a RAT type (e.g. "NR") that is not specified for the the "accessType" attribute indicated value (e.g. "NON_3GPP_ACCESS"). | | +| REF_ID_COLLISION | Indicates that the session rule could not be successfully installed/modified because the same Policy Decision is referenced by a PCC rule (e.g. the session rule and the PCC rule refer to the same Usage Monitoring decision data). | | +| DEFAULT_QOS_MODIFICATION_FAILURE | Indicates that the enforcement of the default QoS modification failed.
The SMF shall use this value during the session rule error report specified in clause 4.2.4.21 to indicate to the PCF that the PDU session modification failed because the default QoS modification procedure as specified in clauses 4.2.3.6 and 4.2.4.5 has failed. | SessQoSModEnforcementFailure | +| SESSION_AMBR_MODIFICATION_FAILURE | Indicates that the enforcement of the session-AMBR modification failed.
The SMF shall use this value during the session rule error report specified in clause 4.2.4.21 to indicate to the PCF that the PDU session modification failed because the session-AMBR modification procedure as specified in clauses 4.2.3.5 and 4.2.4.4 has failed. | SessQoSModEnforcementFailure | +| NOTE: The "INCORRECT_UM" value shall only be used when the feature "UMC" is supported. | | | + +### 5.6.3.18 Enumeration: SteeringFunctionality + +**Table 5.6.3.18-1: Enumeration SteeringFunctionality** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------------------|---------------| +| MPTCP | Indicates that PCF authorizes the MPTCP functionality to support traffic steering, switching and splitting. | ATSSS | +| MPQUIC | Indicates that PCF authorizes the MPQUIC functionality to support traffic steering, switching and splitting. | EnATSSS_v2 | +| ATSSS_LL | Indicates that PCF authorizes the ATSSS-LL functionality to support traffic steering, switching and splitting. | ATSSS | + +### 5.6.3.19 Enumeration: SteerModeValue + +**Table 5.6.3.19-1: Enumeration SteerModeValue** + +| Enumeration value | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ACTIVE_STANDBY | Indicates the steering mode is Active-Standy. It is used to steer a SDF on one access (the Active access), when this access is available, and to switch the SDF to the other access (the Standby access), when Active access becomes unavailable. | ATSSS | +| LOAD_BALANCING | Indicates the traffic of an SDF is split percentually across accesses. | ATSSS | +| SMALLEST_DELAY | Indicates the traffic of a SDF is steered and/or switch to the access with the smallest delay. | ATSSS | +| PRIORITY_BASED | Indicates all the traffic of an SDF is steered to the high priority access, until this access is determined to be congested. | ATSSS | +| REDUNDANT | Indicates that the traffic of an SDF may be duplicated on the 3GPP and Non-3GPP accesses. | EnATSSS_v2 | +| NOTE: When the steering mode "REDUNDANT" is provided, the steering functionality "ATSSS_LL" shall not be provided. | | | + +### 5.6.3.20 Enumeration: MulticastAccessControl + +**Table 5.6.3.20-1: Enumeration MulticastAccessControl** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| ALLOWED | Indicates the service data flow, corresponding to the service data flow template, is allowed. | WWC | +| NOT_ALLOWED | Indicates the service data flow, corresponding to the service data flow template, is not allowed. This is default value. | WWC | + +### 5.6.3.21 Enumeration RequestedQosMonitoringParameter + +**Table 5.6.3.21-1: Enumeration RequestedQosMonitoringParameter** + +| Enumeration value | Description | Applicability | +|---------------------|-----------------------------------------------------------------------------------------------------------|---------------| +| DOWNLINK | Indicates the DL packet delay between the UE and the UPF is to be monitored. | | +| UPLINK | Indicates the UL packet delay between the UE and the UPF is to be monitored. | | +| ROUND_TRIP | Indicates the round trip packet delay between the UE and the UPF is to be monitored. | | +| DOWNLINK_DATA_RATE | Indicates the DL data rate is to be monitored. | EnQoSMon | +| UPLINK_DATA_RATE | Indicates the UL data rate is to be monitored. | EnQoSMon | +| DOWNLINK_CONGESTION | Indicates that the percentage of DL packets to be marked as congested is to be monitored for the DL flow. | EnQoSMon | +| UPLINK_CONGESTION | Indicates that the percentage of DL packets to be marked as congested is to be monitored for the UL flow. | EnQoSMon | + +### 5.6.3.22 Enumeration: ReportingFrequency + +**Table 5.6.3.22-1: Enumeration ReportingFrequency** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------|---------------| +| EVENT_TRIGGERED | Indicates the delay is reported when the delay exceeds the threshold. | | +| PERIODIC | Indicates the delay is reported periodically. | | + +### 5.6.3.23 Enumeration: SmPolicyAssociationReleaseCause + +The enumeration SmPolicyAssociationReleaseCause represents the cause why the PCF requests the termination of the policy association. It shall comply with the provisions defined in table 5.6.3.23-1. + +**Table 5.6.3.23-1: Enumeration SmPolicyAssociationReleaseCause** + +| Enumeration value | Description | Applicability | +|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| UNSPECIFIED | This value is used for unspecified reasons. | | +| UE_SUBSCRIPTION | This value is used to indicate that the policy association needs to be terminated because the subscription of UE has changed (e.g. was removed). | | +| INSUFFICIENT_RES | This value is used to indicate that the server is overloaded and needs to abort the policy association. | | +| VALIDATION_CONDITION_NOT_MET | This value is used to indicate that the policy association needs to be terminated because the validation condition of background data transfer policy is not met. | EnhancedBackgroundDataTransfer | +| REACTIVATION_REQUESTED | This value is used to indicate that policy association needs to be terminated because the PCF is not able to maintain the existing PDU session and requests that the PDU session is reactivated. | ReleaseToReactivation | + +### 5.6.3.24 Enumeration: PduSessionRelCause + +**Table 5.6.3.24-1: Enumeration PduSessionRelCause** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------|----------------------| +| PS_TO_CS_HO | Indicates that the PDU session is terminated due to PS to CS handover. | PduSessionRelCause | +| RULE_ERROR | Indicates that the PDU session is terminated due to a session rule modification error. | ImmediateTermination | + +### 5.6.3.25 Enumeration: MaPduIndication + +**Table 5.6.3.25-1: Enumeration MaPduIndication** + +| Enumeration value | Description | Applicability | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| MA_PDU_REQUEST | UE requested MA PDU session and the request is authorized by subscription. | | +| MA_PDU_NETWORK_UPGRADE_ALLOWED | UE requested single access PDU session with indication of network upgrade to MA PDU session supported and the upgrade is authorized by subscription. | | + +## 5.6.3.26 Enumeration: AtsssCapability + +Table 5.6.3.26-1: Enumeration AtsssCapability + +| Enumeration value | Description | Applicability | +|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ATSSS_LL | Indicates that the MA PDU Session supports the ATSSS-LL capability with any steering mode in the uplink and in the downlink. | | +| MPTCP_ATSSS_LL | Indicates that the MA PDU Session supports both the MPTCP and ATSSS-LL capability with any steering mode in the uplink and in the downlink. | | +| MPTCP_ATSSS_LL_WITH_ASMODE_UL | Indicates that the MA PDU Session supports the MPTCP capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode in the downlink and Active-Standby mode in the uplink. | | +| MPTCP_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL | Indicates that the MA PDU Session supports the MPTCP capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode except Smallest Delay mode in the downlink and Active-Standby mode in the uplink. | | +| MPTCP_ATSSS_LL_WITH_ASMODE_DLUL | Indicates that the MA PDU Session supports the MPTCP capability with any steering mode and ATSSS-LL capability with Active-Standby mode in uplink and downlink. | | +| MPQUIC_ATSSS_LL | Indicates that the MA PDU Session supports the MPQUIC and ATSSS-LL capability with any steering mode in the uplink and in the downlink. | EnATSSS_v2 | +| MPQUIC_ATSSS_LL_WITH_ASMODE_UL | Indicates that the MA PDU Session supports the MPQUIC capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode in the downlink and Active-Standby mode in the uplink. | EnATSSS_v2 | +| MPQUIC_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL | Indicates that the MA PDU Session supports the MPQUIC capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode except Smallest Delay mode in the downlink and Active-Standby mode in the uplink. | EnATSSS_v2 | +| MPQUIC_ATSSS_LL_WITH_ASMODE_DLUL | Indicates that the MA PDU Session supports the MPQUIC capability with any steering mode and ATSSS-LL capability with Active-Standby mode in uplink and downlink. | EnATSSS_v2 | +| MPTCP_MPQUIC_ATSSS_LL | Indicates that the MA PDU Session supports the MPTCP, MPQUIC and ATSSS-LL capability with any steering mode in the uplink and in the downlink. | EnATSSS_v2 | +| MPTCP_MPQUIC_ATSSS_LL_WITH_ASMODE_UL | Indicates that the MA PDU Session supports the MPTCP and MPQUIC capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode in the downlink and Active-Standby mode in the uplink. | EnATSSS_v2 | +| MPTCP_MPQUIC_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL | Indicates that the MA PDU Session supports the MPTCP and MPQUIC capability with any steering mode in uplink and downlink, and ATSSS-LL capability with any steering mode except Smallest Delay mode in the downlink and Active-Standby mode in the uplink. | EnATSSS_v2 | +| MPTCP_MPQUIC_ATSSS_LL_WITH_ASMODE_DLUL | Indicates that the MA PDU Session supports the MPTCP and MPQUIC capability with any steering mode and ATSSS-LL capability with Active-Standby mode in uplink and downlink. | EnATSSS_v2 | + +### 5.6.3.27 Enumeration: NetLocAccessSupport + +**Table 5.6.3.27-1: Enumeration NetLocAccessSupport** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------|---------------| +| ANR_NOT_SUPPORTED | Indicates that the access network does not support the report of access network information. | | +| TZR_NOT_SUPPORTED | Indicates that the access network does not support the report of UE time zone.
(NOTE 1) | | +| LOC_NOT_SUPPORTED | Indicates that the access network does not support the report of UE Location.
(NOTE 2) | | + +NOTE 1: The UE time zone is not available in EPC untrusted WLAN. +NOTE 2: The SMF+PGW determines the UE Location is not available as described in clause B.3.6.3. + +### 5.6.3.28 Enumeration: PolicyDecisionFailureCode + +**Table 5.6.3.28-1: PolicyDecisionFailureCode** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------|---------------------------------| +| TRA_CTRL_DECS_ERR | Indicates failure in the provisioning of traffic control decision data. | | +| QOS_DECS_ERR | Indicates failure in the provisioning of QoS decision data. | | +| CHG_DECS_ERR | Indicates failure in the provisioning of charging decision data. | | +| USA_MON_DECS_ERR | Indicates failure in the provisioning of usage monitoring decision data. | UMC | +| QOS_MON_DECS_ERR | Indicates failure in the provisioning of QoS monitoring decision data. | | +| CON_DATA_ERR | Indicates failure in the provisioning of condition data. | | +| POLICY_PARAM_ERR | Indicates the information related to the provisioned policy parameter(s) is incorrect, incomplete or inconsistent. | ExtPolicyDecisionError Handling | + +### 5.6.3.29 Enumeration: NotificationControlIndication + +**Table 5.6.3.29-1: Enumeration NotificationControlIndication** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------|-----------------------| +| DDN_FAILURE | Indicates that the notification of DDN Failure is requested. | DDNEventPolicyControl | +| DDD_STATUS | Indicates that the notification of DDD status is requested. | DDNEventPolicyControl | + +### 5.6.3.30 Void + +### 5.6.3.31 Enumeration: SteerModelIndicator + +**Table 5.6.3.31-1: Enumeration SteerModelIndicator** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| AUTO_LOAD_BALANCE | Allows the UE and UPF to autonomously determine the traffic load of an SDF distributed across accesses. | | +| UE_ASSISTANCE | Allows the UE to decide how to distribute the UL traffic of an SDF and the UE may inform the UPF how it decided to distribute the UL traffic. | | + +### 5.6.3.32 Enumeration TrafficParameterMeas + +**Table 5.6.3.32-1: Enumeration TrafficParameterMeas** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------|---------------| +| DL_N6_JITTER | The downlink N6 jitter range associated with DL Periodicity. | | +| DL_PERIOD | The Downlink periodicity. | | +| UL_PERIOD | The Uplink periodicity. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Npcf\_SMPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Npcf\_SMPolicyControl API. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_SMPolicyControl API are listed in table 5.7.3-1 and 5.7.3-2. + +**Table 5.7.3-1: Application errors when PCF acts as a server** + +| Application Error | HTTP status code | Description | +|-------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_UNKNOWN | 400 Bad Request | The HTTP request is rejected because the end user specified in the request is unknown to the PCF. (NOTE 1) (NOTE 3) | +| ERROR_INITIAL_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the set of session or subscriber information needed by the PCF for rule selection is incomplete or erroneous or not available for the decision to be made. (E.g. QoS, RAT type, subscriber information) (NOTE 1) (NOTE 2) (NOTE 3) | +| ERROR_TRIGGER_EVENT | 400 Bad Request | The HTTP request is rejected because the set of session information sent the message originated due to a trigger been met is incoherent with the previous set of session information for the same session. (E.g. trigger met was RAT changed, and the RAT notified is the same as before) (NOTE 2) (NOTE 3) | +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the PCF receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. (NOTE 2) | +| ERROR_TRAFFIC_MAPPING_INFO_REJECTED | 403 Forbidden | The HTTP request is rejected because the PCF does not accept one or more of the traffic mapping filters provided by the NF service consumer in a PCC Request. (NOTE 2) (NOTE 3) | +| ERROR_CONFLICTING_REQUEST | 403 Forbidden | The HTTP request is rejected because the PCF cannot accept the UE-initiated resource request as a network-initiated resource allocation is already in progress that has packet filters that cover the packet filters in the received UE-initiated resource request. The NF service consumer shall reject the attempt for UE-initiated resource request. (NOTE 2) (NOTE 3) | +| LATE_OVERLAPPING_REQUEST | 403 Forbidden | The request is rejected because it collides with and exiting Policy Association with a more recent originating timestamp. (NOTE 1) | +| POLICY_CONTEXT_DENIED | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request due to operator policies and/or local configuration. (NOTE 1) (NOTE 2) (NOTE 3) | +| VALIDATION_CONDITION_NOT_MET | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request because the validation condition of background data transfer policy is not met. (NOTE 1) (NOTE 3) | +| INVALID_BDT_POLICY | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request because the background data transfer policy is invalid. (NOTE 1) | +| EXCEEDED_UE_SLICE_DATA_RATE | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request because the authorized data rate exceeds the consumed data rate for that UE and network slice. (NOTE 1) (NOTE 2) | +| EXCEEDED_SLICE_DATA_RATE | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request because the authorized data rate exceeds the consumed data rate for that slice. (NOTE 1) (NOTE 2) | + +| | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EXCEEDED_GROUP_DATA_RATE | 403 Forbidden | The HTTP request is rejected because the PCF does not accept the NF service consumer request because the authorized group data rate exceeds the consumed data rate for the concerned group. (NOTE 1) (NOTE 2) | +| POLICY_ASSOCIATION_NOT_FOUND | 404 Not Found | The HTTP request is rejected because no policy association corresponding to the request exists in the PCF. (NOTE 2) | +| NOTE 1: These application errors are used by the create service operation (see clause 4.2.2.2) and included in the responses to the POST request.
NOTE 2: These application errors are used by the update service operation (see clause 4.2.4.2) and included in the responses to the POST request.
NOTE 3: The Cause codes mapping performed by NF service consumer between this Application Error and the 5GSM related value is specified in clause 5.2.2.2 of 3GPP TS 29.524 [40].
NOTE 4: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +**Table 5.7.3-2: Application errors when NF service consumer acts as a server to receive a notification** + +| Application Error | HTTP status code | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PCC_RULE_EVENT | 400 Bad Request | The HTTP request is rejected because all the PCC rules provisioned by the PCF in the request cannot be installed/activated. It is used to inform the PCF that the request failed, and should not be attempted again. (NOTE 1) | +| PCC_QOS_FLOW_EVENT | 400 Bad Request | The HTTP request is rejected because for some reason all the PCC rules provisioned by the PCF in the request cannot be enforced or modified successfully in a network initiated procedure. It is used to inform the PCF that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. (NOTE 1) | +| UE_STATUS_SUSPEND | 400 Bad Request | The HTTP request is rejected because the UE's status is suspended and the policy decisions received from the PCF cannot be enforced by the NF service consumer. Applicable only to functionality introduced with the PolicyUpdateWhenUESuspends feature as described in clause 5.8. (NOTE 1) | +| RULE_PERMANENT_ERROR | 400 Bad Request | The HTTP request is rejected because all the PCC rules and/or session rules provisioned by the PCF in the request cannot be installed/activated. It is used to inform the PCF that the request failed, and should not be attempted again. Applicable only to functionality introduced with the SessionRuleErrorHandler feature as described in clause 5.8. (NOTE 1) | +| RULE_TEMPORARY_ERROR | 400 Bad Request | The HTTP request is rejected because for some reason all the PCC rules and/or session rules provisioned by the PCF in the request cannot be enforced or modified successfully in a network initiated procedure. It is used to inform the PCF that the request could not be satisfied at the time it was received, but may be able to satisfy the request in the future. Applicable only to functionality introduced with the SessionRuleErrorHandler feature as described in clause 5.8. (NOTE 1) | +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the NF service consumer receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. (NOTE 1) | +| AN_GW_FAILED | 400 Bad Request | This error shall be used when SGWRest feature is supported and the received policy decisions (i.e. installation/modification of PCC rules or session rules) cannot be enforced by the SMF because the AN-Gateway has failed. (NOTE 1) | +| POL_DEC_ERROR | 400 Bad Request | This error shall be used when Ext2PolicyDecisionErrorHandler feature is supported, the PCF provides only SM policy decisions and/or condition data and all the policy decisions and/or conditions in the request cannot be stored in the NF service consumer. | +| NOTE 1: These application errors are used by the UpdateNotify service operation (see clause 4.2.3.2) and included in the responses to the POST request. | | | +| NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_SMPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | TSC | This feature indicates support for traffic steering control in the (S)GI-LAN, steering the 5G-LAN type of services or routing of the user traffic to a local Data Network identified by the DNAI per AF request. If the NF service consumer supports this feature, the PCF shall behave as described in clause 4.2.6.2.6. | +| 2 | ResShare | This feature indicates the support of service data flows that share resources. If the NF service consumer supports this feature, the PCF shall behave as described in clause 4.2.6.2.8. | +| 3 | 3GPP-PS-Data-Off | This feature indicates the support of 3GPP PS Data off status change reporting. | +| 4 | ADC | This feature indicates the support of application detection and control. | +| 5 | UMC | Indicates that the usage monitoring control is supported. | +| 6 | NetLoc | This feature indicates the support of the Access Network Information Reporting for 5GS. | +| 7 | RAN-NAS-Cause | This feature indicates the support for the detailed release cause code information from the access network. (NOTE) | +| 8 | ProvAFsignalFlow | This feature indicates support for the feature of IMS Restoration as described in clause 4.2.3.17. If NF service consumer supports this feature the PCF may provision AF signalling IP flow information. | +| 9 | PCSCF-Restoration-Enhancement | This feature indicates support of P-CSCF Restoration Enhancement. It is used for the NF service consumer to indicate if it supports P-CSCF Restoration Enhancement. | +| 10 | PRA | This feature indicates the support of presence reporting area change reporting. The support of the update of a UE Dedicated Presence Reporting Area is unspecified. | +| 11 | RuleVersioning | This feature indicates the support of PCC rule versioning as defined in clause 4.2.6.2.14. | +| 12 | SponsoredConnectivity | This feature indicates support for sponsored data connectivity feature. If the NF service consumer supports this feature, the PCF may authorize sponsored data connectivity to the subscriber. | +| 13 | RAN-Support-Info | This feature indicates the support of maximum packet loss rate value(s) for uplink and/or downlink voice service data flow(s). | +| 14 | PolicyUpdateWhenUESuspends | This feature indicates the support of report when the UE is suspended and then resumed from suspend state. Only applicable to the interworking scenario as defined in Annex B. | +| 15 | AccessTypeCondition | This feature indicates the support of access type conditioned authorized Session-AMBR as defined in clause 4.2.6.3.2.4. | +| 16 | Multilpv6AddrPrefix | This feature indicates the support of additional new/removed (up to two) IPv6 address prefixes reporting. | +| 17 | SessionRuleErrorHandling | This feature indicates the support of session rule error handling. | +| 18 | AF_Charging_Identifier | This feature indicates the support of long character strings as charging identifiers. | +| 19 | ATSSS | This feature indicates the support of the access traffic switching, steering and splitting functionality as defined in clauses 4.2.6.2.17 and 4.2.6.3.4. | +| 20 | PendingTransaction | This feature indicates support for the race condition handling as defined in 3GPP TS 29.513 [7]. | +| 21 | URLLC | This feature indicates support of Ultra-Reliable Low-Latency Communication (URLLC) requirements, i.e. AF application relocation acknowledgement requirement and UE address(es) preservation. The TSC feature shall be supported in order to support this feature. | +| 22 | MacAddressRange | Indicates the support of a set of MAC addresses with a specific range in the traffic filter. | +| 23 | WWC | Indicates support of wireless and wireline convergence access as defined in annex C. | + +| | | | +|----|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | QosMonitoring | Indicates support of QoS monitoring as defined in clause 4.2.3.25 and 4.2.4.24. Reporting of monitoring data applies to packet delay information when only this feature is supported. | +| 25 | AuthorizationWithRequiredQoS | Indicates support of policy authorization for the AF session with required QoS as defined in clause 4.2.3.22. | +| 26 | EnhancedBackgroundDataTransfer | Indicates the support of applying the Background Data Transfer Policy to a future PDU session. | +| 27 | DN-Authorization | This feature indicates the support of DN-AAA authorization data for policy control. | +| 28 | PDUSessionRelCause | Indicates the support of "PS_TO_CS_HO" PDU session release cause. | +| 29 | SamePcf | This feature indicates the support of same PCF selection for the parameter's combination. | +| 30 | ADCmultiRedirection | This feature indicates support for multiple redirection information in application detection and control. It requires the support of ADC feature. | +| 31 | RespBasedSessionRel | Indicates support of handling PDU session termination functionality as defined in clause 4.2.4.22. | +| 32 | TimeSensitiveNetworking | Indicates that the 5G System is integrated within the external network as a TSN bridge. | +| 33 | EMDBV | This feature indicates the support of the ExtMaxDataBurstVol data type defined in 3GPP TS 29.571 [11]. The use of this data type is specified in clause 4.2.2.1. | +| 34 | DNNSelectionMode | This feature indicates the support of DNN selection mode. | +| 35 | EPSFallbackReport | This feature indicates the support of the report of EPS Fallback as defined in clauses B.3.3.2 and B.3.4.6. | +| 36 | PolicyDecisionErrorHandler | This feature indicates the support of the error report of the policy decision and/or condition data which is not referred by any PCC rule or session rule as defined in clause 4.2.3.26 and 4.2.4.26. | +| 37 | DDNEventPolicyControl | This feature indicates the support for policy control in the case of DDN Failure and Delivery Status events as defined in clause 4.2.4.27. | +| 38 | ReallocationOfCredit | This feature indicates the support of notifications of reallocation of credit. | +| 39 | BDTPolicyRenegotiation | This feature indicates the support of the BDT policy renegotiation. | +| 40 | ExtPolicyDecisionErrorHandler | This feature indicates the support of the error report of a faulty SM policy decision parameter as defined in clause 4.2.3.26 and 4.2.4.26. It requires the support of PolicyDecisionErrorHandler feature. | +| 41 | ImmediateTermination | This feature indicates the support of the termination the PDU session when the NF service consumer cannot ensure the UE, RAN, AMF, or UPF can revert to the status before the PDU session modification occurred, as defined in clause 4.2.4.21. | +| 42 | AggregatedUELocChanges | This feature indicates the support of notifications of serving area (i.e. tracking area) and/or serving cell changes. | +| 43 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. | +| 44 | GroupIdListChange | This feature indicates the support for the notification of changes in the list of internal group identifiers. | +| 45 | DisableUENotification | Indicates the support of disabling QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. This feature requires that the AuthorizationWithRequiredQoS feature is also supported. | +| 46 | OfflineChOnly | This feature enables the PCF to signal the "PDU Session with offline charging only" indication as defined in clause 4.2.2.3.3. | + +| | | | +|----|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 47 | Dual-Connectivity-redundant-UP-paths | Indicates the support of policy authorization of end to end redundant user plane path using dual connectivity as described in clause 4.2.2.20. | +| 48 | DDNEventPolicyControl2 | This feature indicates the support for the policy control removal in the case of DDN Failure and/or Delivery Status event(s) is cancelled as defined in clause 4.2.4.27. The DDNEventPolicyControl feature shall be supported in order to support this feature. | +| 49 | VPLMN-QoS-Control | Indicates the support of QoS constraints from the VPLMN for the derivation of the authorized Session-AMBR and authorized default QoS. | +| 50 | 2G3GIWK | This feature indicates the support of GERAN and UTRAN access over N7 interface. | +| 51 | TimeSensitiveCommunication | Indicates that the 5G System is integrated within the external network as a TSC user plane node to enable the Time Sensitive Communications and Time Synchronization. This feature requires that the TimeSensitiveNetworking feature is also supported. | +| 52 | AF_latency | This feature indicates the support of Edge relocation considering user plane latency. This feature requires that the TSC feature is also supported. | +| 53 | SatBackhaulCategoryChg | This feature indicates the support of notification of a change between different satellite backhaul categories, or between satellite backhaul and non-satellite backhaul. | +| 54 | CHFsetSupport | Indicates the support of CHF redundancy and failover mechanisms based on CHF instance availability within a CHF Set, as described in clause 4.2.2.3.1. | +| 55 | EnATSSS | Indicates the support of ATSSS enhancement. It requires the support of ATSSS feature. | +| 56 | MPSforDTS | Indicates support of the MPSfor DTS feature as described in clause 4.2.6.2.12.4. | +| 57 | RoutingInfoRemoval | Indicates the support of the removal of the "routeToLocs" attribute from the TrafficControlData instance. | +| 58 | ePRA | This feature indicates the support of presence reporting area change reporting. It additionally supports the update of the elements of a UE Dedicated Presence Reporting Area by the full replacement of the previously provided one comparing with the PRA feature. | +| 59 | AMInfluence | Indicates the support of the delivery of the PCF for the UE request to be notified by the PCF for the PDU session about PDU session established/terminated events. | +| 60 | PvsSupport | This feature indicates the support of SNPn UE Remote Provisioning via User Plane as described in clause 4.2.2.21. | +| 61 | EneNA | This feature indicates the support of NWDAF data reporting. | +| 62 | BIUMR | This feature bit indicates whether the NF Service Consumer (e.g. SMF) and PCF supports Binding Indication Update for multiple resource contexts specified in clauses 6.12.1 and 5.2.3.2.6 of 3GPP TS 29.500 [4]. | +| 63 | EASIPreplacement | This feature indicates the support of EAS IP replacement. This feature requires that the TSC feature is also supported. | +| 64 | ExposureToEAS | This feature indicates the support of exposure of QoS monitoring results to local AF. This feature requires that QosMonitoring feature is also supported. | +| 65 | SimultConnectivity | This feature indicates the support of temporary simultaneously connectivity at edge relocation. This feature requires that the TSC feature is also supported. | +| 66 | SGWRest | This feature indicates the support of SGW Restoration procedures. Only applicable to the interworking scenario as defined in Annex B. | +| 67 | ReleaseToReactivate | This feature indicates that the PCF can request the SMF for reactivation of a PDU session based on an SM Policy Association release cause. | +| 68 | EASDiscovery | This feature indicates the support of EAS (re)discovery. | +| 69 | AccNetChargId_String | This feature indicates the support of long character strings as access network charging identifier. | + +| | | | +|----|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 70 | WLAN_Location | This feature indicates the support of the report of the WLAN location information received from the ePDG/EPC, if available. It is only applicable to EPS interworking scenarios as specified in Annex B. | +| 71 | PackFiltAllocPrecedence | This feature indicates the support of the control of the maximum number of packet filters in the EPS network in the EPS interworking scenarios as described in Annex B. | +| 72 | SatBackhaulCategoryChg_v2 | This feature indicates the support of the indication of satellite backhaul categories, or the indication of non-satellite backhaul during the response to the update notify request. | +| 73 | PacketDelayFailureReport | Indicates the support of packet delay failure report as part of QoS Monitoring procedures. This feature requires that QosMonitoring feature is supported. | +| 74 | AltQoSProfilesSupportReport | This feature indicates the support of the report of whether Alternative QoS parameters are supported by NG-RAN. This feature requires that AuthorizationWithRequiredQoS feature is also supported. | +| 75 | Ext2PolicyDecisionErrorHandler | This feature indicates the support of the error report of the policy decision and/or condition data which is not referred by any PCC rule or session rule when no PCC rules and no session rules are provided and the handling of partial errors. It requires the support of ExtPolicyDecisionErrorHandler feature. | +| 76 | UEUnreachable | This feature indicates the support for the reporting of UE temporarily unavailable. | +| 77 | EnTSCAC | Indicates the support of extensions to TSCAC and the RAN feedback for BAT offset and adjusted periodicity. This feature requires that TimeSensitiveCommunication feature is also supported. | +| 78 | MTU_Size | This feature indicates the support of the report of the MTU size of the device side port. This feature requires that the TimeSensitiveCommunication feature is also supported. | +| 79 | EnSatBackhaulCatChg | This feature indicates the support of notification of dynamic satellite backhaul categories. It requires the support of SatBackhaulCategoryChg and SatBackhaulCategoryChg_v2 features. | +| 80 | SFC | This feature indicates support for application function influence on service function chaining(s). It requires the support of TSC feature. | +| 81 | EpsUrsp | This feature indicates the support of URSP provisioning in EPS. Only applicable to the interworking scenario as defined in Annex B. | +| 82 | CommonEASDNAI | This feature controls the support of the common EAS/DNAI selection. It requires the support of TSC feature. | +| 83 | UnlimitedMultilpv6Prefix | This feature indicates the support of multiple IPv6 address prefixes reporting. | +| 84 | NscSupportedFeatures | This feature indicates the support of provisioning of the Network Function Service Consumer features supported in Nsmf_EventExposure service as described in 3GPP TS 29.508 [12]. | +| 85 | URSPEnforcement | This feature indicates the support of awareness of URSP rule enforcement | +| 86 | VBCforIMS | This feature indicates the support of provisioning of the caller and callee informations in volume based charging for IMS as defined in clause A.16 of 3GPP TS 29.214 [18] (replacing PCRF with PCF). | +| 87 | ExposureToTSC | This feature indicates the support of the direct event notification of TSC management information from the UPF to the TSCTSF or TSN AF in 5GC. This feature requires that TimeSensitiveCommunication feature is also supported. | + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 88 | NetSliceRepl | This feature indicates the support of the network slice replacement functionality introduced in this specification as part of the end-to-end network slicing functionality.

The following functionalities are supported:
- Support the reporting of the network slice replacement information to the PCF. | +| 89 | SessQoSModEnforcementFailure | This feature indicates the support of the report PDU session modification failure because the enforcement of the default QoS modification or session-AMBR modification of the active session rule failed. | +| 90 | HR-SBO | This feature indicates the support of VPLMN specific Offloading policy in Home Routed deployments with Session Breakout (HR-SBO). | +| 91 | EnATSSS_v2 | Indicates the support of ATSSS enhancements which includes REDUNDANT steering mode, MPQUIC steering functionality and MA PDU session interworking enhancements. It requires the support of the EnATSSS features. | +| 92 | NetSliceUsageCtrl | This feature indicates the support of the network slice usage control functionality introduced in this specification as part of the end-to-end network slicing functionality.

The following functionalities are supported:
- Support the provisioning by the PCF of the network slice usage control information (e.g., slice PDU session inactivity timer value). | +| 93 | VPLMN-5QIPrioLevel | Indicates the support of the indication of the VPLMN supported 5QI priority level when the required 5QI Priority Level is different from the standardized Default Priority Level value in the QoS characteristics Table 5.7.4-1 in 3GPP TS 23.501 [2].
This feature requires that VPLMN-QoS-Control feature is also supported. | +| 94 | PDUSetHandlinge | This feature indicates the support of PDU Set handling. This feature may be used for eXtended Reality (XR) and interactive media services. | +| 95 | RTLatency | This feature indicates the support of Round-Trip latency. This feature may be used for eXtended Reality (XR) and interactive media services | +| 96 | EnQoSMon | This feature indicates the support of enhanced QoS monitoring functionality, i.e. the report of the congestion information, and/or, the data rate information monitoring. | +| 97 | PowerSaving | This feature indicates the support of the Power Saving for different traffic measurement. | +| 98 | L4S | This feature indicates the support of the PCF indication of ECN marking for L4S support. | +| 99 | UPEAS | This feature indicates the support of UPF enhancements for exposure related to the identification of QoS monitoring event exposure subscription. | +| NOTE: 5GS and EPS release cause code information is supported. The EPS release cause code information from the access network is only applicable to EPS interworking scenarios as specified in Annex B. | | | + +Editor's note: Whether and/how to indicate the support of end of burst indication, and provision the flow periodicity information within the Power Saving feature is FFS. + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [27], the access to the Npcf\_SMPolicyControl API shall be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server. + +An NF service consumer, prior to consuming services offered by the Npcf\_SMPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Npcf\_SMPolicyControl service. + +The Npcf\_SMPolicyControl API defines a single scope "npcf-smpolicycontrol" for OAuth2 authorization (as specified in 3GPP TS 33.501 [27]) for the entire API, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Npcf\_SMPolicyControl API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [38] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +## A.2 Npcf\_SMPolicyControl API + +``` +openapi: 3.0.0 + +info: + title: Npcf_SMPolicyControl API + version: 1.3.0-alpha.5 + description: | + Session Management Policy Control Service + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.512 V18.4.0; 5G System; Session Management Policy Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.512/' + +security: + - {} + - oAuth2ClientCredentials: + - npcf-smpolicycontrol + +servers: + - url: '{apiRoot}/npcf-smpolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /sm-policies: + post: + summary: Create a new Individual SM Policy. + operationId: CreateSMPolicy + tags: + - SM Policies (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyContextData' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDecision' +``` + +``` + +headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string +'308': + description: Permanent Redirect + headers: + Location: + description: > + Contains the URI of the PCF within the existing PCF binding information stored in + the BSF for the same UE ID, S-NSSAI and DNN combination. + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + SmPolicyUpdateNotification: + '{ $request.body#/notificationUri }/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyNotification' +responses: + '200': + description: > + 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: + $ref: '#/components/schemas/PartialSuccessReport' + minItems: 1 + - type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request. + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/ErrorReport' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + SmPolicyControlTerminationRequestNotification: + '{ $request.body#/notificationUri }/terminate': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/sm-policies/{smPolicyId}: + get: + summary: Read an Individual SM Policy + operationId: GetSMPolicy + tags: + - Individual SM Policy (Document) + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association. + required: true + schema: + type: string + responses: + +``` + +``` + +'200': + description: OK. Resource representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyControl' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/sm-policies/{smPolicyId}/update: + post: + summary: Update an existing Individual SM Policy + operationId: UpdateSMPolicy + tags: + - Individual SM Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyUpdateContextData' + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association. + required: true + schema: + type: string + responses: + '200': + description: OK. Updated policies are returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDecision' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + +``` + +``` + + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/sm-policies/{smPolicyId}/delete: + post: + summary: Delete an existing Individual SM Policy. + operationId: DeleteSMPolicy + tags: + - Individual SM Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDeleteData' + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association. + required: true + schema: + type: string + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: '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: + description: > + Contains the parameters used to request the SM policies and the SM policies authorized by + the PCF. + type: object + properties: + context: + $ref: '#/components/schemas/SmPolicyContextData' + policy: + $ref: '#/components/schemas/SmPolicyDecision' + +``` + +``` +required: + - context + - policy + +SmPolicyContextData: + description: Contains the parameters used to create an Individual SM policy resource. + type: object + properties: + accNetChId: + $ref: '#/components/schemas/AccNetChId' + chargEntityAddr: + $ref: '#/components/schemas/AccNetChargingAddress' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + invalidSupi: + type: boolean + description: > + When this attribute is included and set to true, it indicates that the supi attribute + contains an invalid value.This attribute shall be present if the SUPI is not available + in the SMF or the SUPI is unauthenticated. When present it shall be set to true for an + invalid SUPI and false (default) for a valid SUPI. + interGrpIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + chargingcharacteristics: + type: string + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnnSelMode: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/DnnSelectionMode' + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + addAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ipDomain: + type: string + description: Indicates the IPv4 address domain + subsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + authProfIndex: + type: string + description: Indicates the DN-AAA authorization profile index + subsDefQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' + vplmnQos: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' + 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: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +qosFlowUsage: + $ref: '#/components/schemas/QosFlowUsage' +servNfId: + $ref: '#/components/schemas/ServingNfIdentity' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +maPduInd: + $ref: '#/components/schemas/MaPduIndication' +atsssCapab: + $ref: '#/components/schemas/AtsssCapability' +ipv4FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + minItems: 1 +ipv6FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 +satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' +pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 +onboardInd: + type: boolean + description: > + If it is included and set to true, it indicates that the PDU session is used for + UE Onboarding. +nwdafDatas: + type: array + items: + $ref: '#/components/schemas/NwdafData' + minItems: 1 +urspEnfInfo: + $ref: '#/components/schemas/UrspEnforcementInfo' +sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' +ueReqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +redundantPduSessionInfo: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' +hrsboInd: + type: boolean + description: > + HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is + supported. Default value is "false" if omitted. +required: +- supi +- pduSessionId +- pduSessionType +- dnn +- notificationUri +- sliceInfo +``` + +``` +SmPolicyDecision: + description: Contains the SM policies authorized by the PCF. + type: object + properties: + sessRules: + type: object + additionalProperties: + $ref: '#/components/schemas/SessionRule' + minProperties: 1 + description: > + A map of Sessionrules with the content being the SessionRule as described in + clause 5.6.2.7. The key used in this map for each entry is the sessRuleId + attribute of the corresponding SessionRule. + pccRules: + type: object + additionalProperties: + $ref: '#/components/schemas/PccRule' + minProperties: 1 + description: > + A map of PCC rules with the content being the PCCRule as described in + clause 5.6.2.6. The key used in this map for each entry is the pccRuleId + attribute of the corresponding PccRule. + nullable: true + pscfRestIndication: + type: boolean + description: > + If it is included and set to true, it indicates the P-CSCF Restoration is requested. + qosDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/QosData' + minProperties: 1 + description: > + Map of QoS data policy decisions. The key used in this map for each entry is the qosId + attribute of the corresponding QosData. + chgDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/ChargingData' + minProperties: 1 + description: > + Map of Charging data policy decisions. The key used in this map for each entry + is the chgId attribute of the corresponding ChargingData. + nullable: true + chargingInfo: + $ref: '#/components/schemas/ChargingInformation' + traffContDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/TrafficControlData' + minProperties: 1 + description: > + Map of Traffic Control data policy decisions. The key used in this map for each entry + is the tcId attribute of the corresponding TrafficControlData. + umDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonitoringData' + minProperties: 1 + description: > + Map of Usage Monitoring data policy decisions. The key used in this map for each entry + is the umId attribute of the corresponding UsageMonitoringData. + nullable: true + qosChars: + type: object + additionalProperties: + $ref: '#/components/schemas/QosCharacteristics' + minProperties: 1 + description: > + Map of QoS characteristics for non standard 5QIs. This map uses the 5QI values as keys. + qosMonDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/QosMonitoringData' + minProperties: 1 + description: > + Map of QoS Monitoring data policy decisions. The key used in this map for each entry + is the qmId attribute of the corresponding QosMonitoringData. +``` + +``` + + nullable: true + reflectiveQoSTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + cond: + type: object + additionalProperties: + $ref: '#/components/schemas/ConditionData' + minProperties: 1 + description: > + A map of condition data with the content being as described in clause 5.6.2.9. The key + used in this map for each entry is the condId attribute of the corresponding + ConditionData. + nullable: true + revalidationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + offline: + type: boolean + description: > + Indicates the offline charging is applicable to the PDU session when it is included and + set to true. + online: + type: boolean + description: > + Indicates the online charging is applicable to the PDU session when it is included and + set to true. + offlineChOnly: + type: boolean + default: false + description: > + Indicates that the online charging method shall never be used for any PCC rule activated + during the lifetime of the PDU session. + policyCtrlReqTriggers: + type: array + items: + $ref: '#/components/schemas/PolicyControlRequestTrigger' + minItems: 1 + description: Defines the policy control request triggers subscribed by the PCF. + nullable: true + lastReqRuleData: + type: array + items: + $ref: '#/components/schemas/RequestedRuleData' + minItems: 1 + description: Defines the last list of rule control data requested by the PCF. + lastReqUsageData: + $ref: '#/components/schemas/RequestedUsageData' + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' + minProperties: 1 + description: > + Map of PRA information. The praId attribute within the PresenceInfo data type is the key + of the map. + nullable: true + ipv4Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' + ipv6Index: + $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' + qosFlowUsage: + $ref: '#/components/schemas/QosFlowUsage' + relCause: + $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + tsnBridgeManCont: + $ref: '#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: '#/components/schemas/PortManagementContainer' + tsnPortManContNwtt: + type: array + items: + $ref: '#/components/schemas/PortManagementContainer' + minItems: 1 + tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tscNotifCorreId: + type: string + +``` + +``` + description: > + Correlation identifier for TSC management information notifications. + redSessIndication: + type: boolean + description: > + Indicates whether the PDU session is a redundant PDU session. If absent it means the PDU + session is not a redundant PDU session. + uePolCont: + $ref: '#/components/schemas/UePolicyContainer' + sliceUsCtrlInfo: + $ref: '#/components/schemas/SliceUsCtrlInfo' + vplmnOffload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VplmnOffloadingInfo' + +SmPolicyNotification: + description: Represents a notification on the update of the SM policies. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smPolicyDecision: + $ref: '#/components/schemas/SmPolicyDecision' + +PccRule: + description: Contains a PCC rule information. + type: object + properties: + flowInfos: + type: array + items: + $ref: '#/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. + appDescriptor: + $ref: '#/components/schemas/ApplicationDescriptor' + contVer: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + protoDesc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ProtoDesc' + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: '#/components/schemas/AfSigProtocol' + appReloc: + type: boolean + description: Indication of application relocation possibility. + easRedisInd: + type: boolean + description: Indicates the EAS rediscovery is required. + refQosData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: > + A reference to the QosData policy decision type. It is the qosId described in + clause 5.6.2.8. + refAltQosParams: + type: array + items: + type: string + minItems: 1 + description: > + A Reference to the QosData policy decision type for the Alternative QoS parameter sets + of the service data flow. + 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 + clause 5.6.2.10. +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 + clause 5.6.2.11. + nullable: true +refChgN3gData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: > + A reference to the ChargingData policy decision type only applicable to Non-3GPP access + if "ATSSS" feature is supported. It is the chgId described in clause 5.6.2.11. + 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 + clause 5.6.2.12. + nullable: true +refUmN3gData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: > + A reference to UsageMonitoringData policy decision type only applicable to Non-3GPP + access if "ATSSS" feature is supported. It is the umId described in clause 5.6.2.12. + nullable: true +refCondData: + type: string + description: > + A reference to the condition data. It is the condId described in clause 5.6.2.9. + nullable: true +refQosMon: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: > + A reference to the QosMonitoringData policy decision type. It is the qmId described in + clause 5.6.2.40. + nullable: true +addrPreserInd: + type: boolean + nullable: true +tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' +tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' +tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +capBatAdaptation: + type: boolean + description: > + Indicates the capability for AF to adjust the burst sending time, when it is provided + and set to "true". The default value is "false" if omitted. +ddNotifCtrl: + $ref: '#/components/schemas/DownlinkDataNotificationControl' +ddNotifCtrl2: + $ref: '#/components/schemas/DownlinkDataNotificationControlRm' +disUeNotif: + type: boolean + +``` + +``` + + nullable: true + packFiltAllPrec: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nscSuppFeats: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 + description: > + Identifies a list of Network Function Service Consumer supported per service. The key + used in this map for each entry is the ServiceName value as defined in + 3GPP TS 29.510[29]. + callInfo: + $ref: '#/components/schemas/CallInfo' + traffParaData: + $ref: '#/components/schemas/TrafficParaData' + required: + - pccRuleId + nullable: true + + SessionRule: + description: Contains session level policy information. + type: object + properties: + authSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + authDefQos: + $ref: '#/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 + clause 5.6.2.12. + nullable: true + refUmN3gData: + type: string + description: > + A reference to UsageMonitoringData policy decision type to apply for Non-3GPP access. It + is the umId described in clause 5.6.2.12. + nullable: true + refCondData: + type: string + description: > + A reference to the condition data. It is the condId described in clause 5.6.2.9. + nullable: true + required: + - sessRuleId + nullable: true + + QosData: + description: Contains the QoS parameters. + type: object + properties: + qosId: + type: string + description: Univocally identifies the QoS control policy data within a PDU session. + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + arp: + $ref: '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: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + maxDataBurstVol: + $ref: '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: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: '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 + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' + required: + - qosId + nullable: true + +ConditionData: + description: Contains conditions of applicability for a rule. + type: object + properties: + condId: + type: string + description: Uniquely identifies the condition data within a PDU session. + activationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + deactivationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + required: + - condId + nullable: true + +TrafficControlData: + description: > + Contains parameters determining how flows associated with a PCC Rule are treated (e.g. + blocked, redirected, etc). + type: object + properties: + tcId: + type: string + description: Univocally identifies the traffic control policy data within a PDU session. + l4sInd: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/UplinkDownlinkSupport' + flowStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: '#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + +``` + +``` + + $ref: '#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + description: Indicates whether application'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 + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: A list of location which the traffic shall be routed to for the AF request + nullable: true + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + easIpReplaceInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + minItems: 1 + description: Contains EAS IP replacement information. + nullable: true + traffCorreInd: + type: boolean + tfcCorreInfo: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' + simConnInd: + type: boolean + description: > + Indicates whether simultaneous connectivity should be temporarily maintained for the + source and target PSA. + simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + upPathChgEvent: + $ref: '#/components/schemas/UpPathChgEvent' + steerFun: + $ref: '#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: '#/components/schemas/MulticastAccessControl' + candDnaiInd: + type: boolean + description: > + Indication of reporting candidate DNAI(s). If it is included and set to "true", the + candidate DNAI(s) for the PDU session need to be reported. Otherwise set to "false" or + omitted. + datEndMarkInd: + type: boolean + description: > + The data burst end marking is enabled if it is set to "true". Default value is "false" +if + omitted. +required: +- tcId +nullable: true + +ChargingData: + description: Contains charging related parameters. + type: object + properties: + chgId: + type: string + description: Univocally identifies the charging control policy data within a PDU session. + meteringMethod: + +``` + +``` + + $ref: '#/components/schemas/MeteringMethod' + offline: + type: boolean + description: > + Indicates the offline charging is applicable to the PCC rule when it is included and set + to true. + online: + type: boolean + description: > + Indicates the online charging is applicable to the PCC rule when it is included and set + to true. + sdfHandl: + type: boolean + description: > + Indicates whether the service data flow is allowed to start while the SMF is waiting for + the response to the credit request. + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + reportingLevel: + $ref: '#/components/schemas/ReportingLevel' + serviceId: + $ref: '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: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + afChargId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + required: + - chgId + nullable: true + +UsageMonitoringData: + description: Contains usage monitoring related control information. + type: object + properties: + umId: + type: string + description: Univocally identifies the usage monitoring policy data within a PDU session. + volumeThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + volumeThresholdUplink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + volumeThresholdDownlink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + timeThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + monitoringTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + nextVolThreshold: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + nextVolThresholdUplink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + nextVolThresholdDownlink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + nextTimeThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + inactivityTime: + $ref: '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: + +``` + +``` +description: Contains the redirect information. +type: object +properties: + redirectEnabled: + type: boolean + description: Indicates the redirect is enable. + redirectAddressType: + $ref: '#/components/schemas/RedirectAddressType' + redirectServerAddress: + type: string + description: > + Indicates the address of the redirect server. If "redirectAddressType" attribute + indicates the IPV4_ADDR, the encoding is the same as the Ipv4Addr data type defined in + 3GPP TS 29.571.If "redirectAddressType" attribute indicates the IPV6_ADDR, the encoding + is the same as the Ipv6Addr data type defined in 3GPP TS 29.571.If "redirectAddressType" + attribute indicates the URL or SIP_URI, the encoding is the same as the Uri data type + defined in 3GPP TS 29.571. + +FlowInformation: + description: Contains the flow information. + type: object + properties: + flowDescription: + $ref: '#/components/schemas/FlowDescription' + ethFlowDescription: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + 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: + $ref: '#/components/schemas/FlowDirectionRm' + +SmPolicyDeleteData: + description: > + Contains the parameters to be sent to the PCF when an individual SM policy is deleted. + type: object + properties: + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfoTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ranNasRelCauses: + type: array + items: + $ref: '#/components/schemas/RanNasRelCause' + minItems: 1 + description: Contains the RAN and/or NAS release cause. + accuUsageReports: + type: array + items: + $ref: '#/components/schemas/AccuUsageReport' + minItems: 1 + description: Contains the usage report + pduSessionRelCause: + $ref: '#/components/schemas/PduSessionRelCause' + +QosCharacteristics: +``` + +``` +description: Contains QoS characteristics for a non-standardized or a non-configured 5QI. +type: object +properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + resourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + averagingWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' +required: +- 5qi +- resourceType +- priorityLevel +- packetDelayBudget +- packetErrorRate + +ChargingInformation: +description: Contains the addresses of the charging functions. +type: object +properties: + primaryChfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + secondaryChfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + primaryChfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + primaryChfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + secondaryChfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +required: +- primaryChfAddress + +AccuUsageReport: +description: Contains the accumulated usage report information. +type: object +properties: + refUmIds: + type: string + description: > + An id referencing UsageMonitoringData objects associated with this usage report. + volUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + volUsageUplink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + volUsageDownlink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + timeUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + nextVolUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + nextVolUsageUplink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + nextVolUsageDownlink: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + nextTimeUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- refUmIds + +SmPolicyUpdateContextData: +description: > + Contains the policy control request trigger(s) that were met and the corresponding new + value(s) or the error report of the policy enforcement. +type: object +properties: +``` + +``` +repPolicyCtrlReqTriggers: + type: array + items: + $ref: '#/components/schemas/PolicyControlRequestTrigger' + minItems: 1 + description: The policy control request triggers which are met. +accNetChIds: + type: array + items: + $ref: '#/components/schemas/AccNetChId' + minItems: 1 + description: > + Indicates the access network charging identifier for the PCC rule(s) or whole PDU + session. +accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +addAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' +relAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' +servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +relIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipDomain: + type: string + description: Indicates the IPv4 address domain +ipv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +relIpv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +addIpv6AddrPrefixes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +addRelIpv6AddrPrefixes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +multiIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The multiple allocated IPv6 prefixes of the served UE. +multiRelIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The multiple released IPv6 prefixes of the served UE. +relUeMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +subsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' +authProfIndex: + type: string + description: Indicates the DN-AAA authorization profile index +subsDefQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' +vplmnQos: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' +vplmnQosNotApp: + type: boolean + description: > + If it is included and set to true, indicates that the QoS constraints in the VPLMN are + not applicable. +numOfPackFilter: + type: integer + description: Contains the number of supported packet filter for signalled QoS rules. +accuUsageReports: + type: array +``` + +``` + items: + $ref: '#/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: + $ref: '#/components/schemas/AppDetectionInfo' + minItems: 1 + description: > + Report the start/stop of the application traffic and detected SDF descriptions + if applicable. +ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: Used to report the PCC rule failure. +sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: Used to report the session rule failure. +qncReports: + type: array + items: + $ref: '#/components/schemas/QosNotificationControlInfo' + minItems: 1 + description: QoS Notification Control information. +qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 +qosMonDatRateReps: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 +userLocationInfoTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +repPraInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Reports the changes of presence reporting area. The praId attribute within the + PresenceInfo data type is the key of the map. +ueInitResReq: + $ref: '#/components/schemas/UeInitiatedResourceRequest' +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: + $ref: '#/components/schemas/QosFlowUsage' +creditManageStatus: + $ref: '#/components/schemas/CreditManagementStatus' +servNfId: + $ref: '#/components/schemas/ServingNfIdentity' +traceReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' +maPduInd: + $ref: '#/components/schemas/MaPduIndication' +atsssCapab: + $ref: '#/components/schemas/AtsssCapability' +tsnBridgeInfo: + $ref: '#/components/schemas/TsnBridgeInfo' +tsnBridgeManCont: + $ref: '#/components/schemas/BridgeManagementContainer' +tsnPortManContDstt: +``` + +``` +$ref: '#/components/schemas/PortManagementContainer' +tsnPortManContNwttts: + type: array + items: + $ref: '#/components/schemas/PortManagementContainer' + minItems: 1 +tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +tscNotifCorreId: + type: string + description: > + Correlation identifier for TSC management information notifications. +mulAddrInfos: + type: array + items: + $ref: '#/components/schemas/IpMulticastAddressInfo' + minItems: 1 +policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. +invalidPolicyDecs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' + minItems: 1 + description: > + Indicates the invalid parameters for the reported type(s) of the failed policy decision + and/or condition data. +trafficDescriptors: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 +pccRuleId: + type: string + description: > + Contains the identifier of the PCC rule which is used for traffic detection of event. +typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 +interGrpIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +pcfUeInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PcfUeCallbackInfo' +nwdafData: + type: array + items: + $ref: '#/components/schemas/NwdafData' + minItems: 1 + nullable: true +anGwStatus: + type: boolean + description: > + When it is included and set to true, it indicates that the AN-Gateway has failed and + that the PCF should refrain from sending policy decisions to the SMF until it is + informed that the AN-Gateway has been recovered. +uePolCont: + $ref: '#/components/schemas/UePolicyContainer' +urspEnfInfo: + $ref: '#/components/schemas/UrspEnforcementInfo' +sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' +ueReqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +redundantPduSessionInfo: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' +l4sReports: + type: array +``` + +``` + + items: + $ref: '#/components/schemas/L4sSupportInfo' + minItems: 1 + description: ECN marking for L4S support availability in 5GS. + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + batOffsetInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' + hrsboInd: + type: boolean + description: > + HR-SBO support indication. If present and set to "true", it indicates that the HR-SBO is + supported. If present and set to "false", it indicates that the HR-SBO is not supported. + allOf: + - not: + - required: [multiIpv6Prefixes, ipv6AddressPrefix] + - not: + - required: [multiIpv6Prefixes, addIpv6AddrPrefixes] + - not: + - required: [multiRelIpv6Prefixes, relIpv6AddressPrefix] + - not: + - required: [multiRelIpv6Prefixes, relAddIpv6AddrPrefixes] + +UpPathChgEvent: + description: Contains the UP path change event subscription from the AF. + type: object + properties: + notificationUri: + $ref: '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: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + afAckInd: + type: boolean + required: + - notificationUri + - notifCorreId + - dnaiChgType + nullable: true + +TerminationNotification: + description: Represents a Termination Notification. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + cause: + $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' + required: + - resourceUri + - cause + +AppDetectionInfo: + description: Contains the detected application's traffic information. + type: object + properties: + appId: + type: string + description: A reference to the application detection filter configured at the UPF + instanceId: + type: string + description: > + Identifier sent 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: + $ref: '#/components/schemas/FlowInformation' + minItems: 1 + description: Contains the detected service data flow descriptions if they are deducible. + required: + - appId + +``` + +``` +AccNetChId: + description: > + Contains the access network charging identifier for the PCC rule(s) or for the whole + PDU session. + type: object + properties: + accNetChaIdValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + accNetChargId: + type: string + description: A character string containing the access network charging id. + 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 + oneOf: + - required: [accNetChaIdValue] + - required: [accNetChargId] + +AccNetChargingAddress: + description: Describes the network entity within the access network performing charging + type: object + anyOf: + - required: [anChargIpv4Addr] + - required: [anChargIpv6Addr] + properties: + anChargIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anChargIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + +RequestedRuleData: + description: > + Contains rule data requested by the PCF to receive information associated with PCC rule(s). + 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: + $ref: '#/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: + description: > + Contains usage data requested by the PCF requesting usage reports for the corresponding + usage monitoring data instances. + 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: > + This boolean 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: + description: > + Contains the current applicable values corresponding to the policy control request triggers. + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servNfId: + $ref: '#/components/schemas/ServingNfIdentity' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + netLocAccSupp: + $ref: '#/components/schemas/NetLocAccessSupport' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + urspEnfInfo: + $ref: '#/components/schemas/UrspEnforcementInfo' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScsMode' + ueReqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + redundantPduSessionInfo: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' + + RuleReport: + description: Reports the status of PCC. + type: object + properties: + pccRuleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the identifier of the affected PCC rule(s). + ruleStatus: + $ref: '#/components/schemas/RuleStatus' + contVers: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + minItems: 1 + description: Indicates the version of a PCC rule. + failureCode: + $ref: '#/components/schemas/FailureCode' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + finUnitAct: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' + ranNasRelCauses: + type: array + items: + $ref: '#/components/schemas/RanNasRelCause' + minItems: 1 + description: indicates the RAN or NAS release cause code information. + altQosParamId: + type: string + description: > + Indicates the alternative QoS parameter set that the NG-RAN can guarantee. It is + included during the report of successful resource allocation and indicates that NG-RAN + used an alternative QoS profile because the requested QoS could not be allocated.. + required: + - pccRuleIds + - ruleStatus + +``` + +``` +RanNasRelCause: + description: Contains the RAN/NAS release cause. + type: object + properties: + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + 5gSmCause: + $ref: '#/components/schemas/5GSmCause' + epsCause: + $ref: '#/components/schemas/EpsRanNasRelCause' + +UeInitiatedResourceRequest: + description: Indicates that a UE requests specific QoS handling for the selected SDF. + type: object + properties: + pccRuleId: + type: string + ruleOp: + $ref: '#/components/schemas/RuleOperation' + precedence: + type: integer + packFiltInfo: + type: array + items: + $ref: '#/components/schemas/PacketFilterInfo' + minItems: 1 + reqQos: + $ref: '#/components/schemas/RequestedQos' + required: + - ruleOp + - packFiltInfo + +PacketFilterInfo: + description: > + Contains the information from a single packet filter sent from the SMF to the PCF. + type: object + properties: + packFiltId: + type: string + description: An identifier of packet filter. + packFiltCont: + $ref: '#/components/schemas/PacketFilterContent' + 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: + $ref: '#/components/schemas/FlowDirection' + +RequestedQos: + description: Contains the QoS information requested by the UE. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + required: + - 5qi + +QosNotificationControlInfo: + description: Contains the QoS Notification Control Information. + 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: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosNotifType' + contVer: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + altQosParamId: + type: string + description: > + Indicates the alternative QoS parameter set the NG-RAN can guarantee. When it is omitted + and the notifType attribute is set to NOT_GUARANTEED it indicates that the lowest + priority alternative QoS profile could not be fulfilled. + altQosNotSuppInd: + type: boolean + description: > + When present and set to true it indicates that the Alternative QoS profiles are not + supported by NG-RAN. + required: + - refPccRuleIds + - notifType + + PartialSuccessReport: + description: > + Includes the information reported by the SMF when some of the PCC rules and/or session rules + and/or policy decision and/or condition data are not successfully installed/activated or + stored. + type: object + properties: + failureCause: + $ref: '#/components/schemas/FailureCause' + ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: > + Information about the PCC rules provisioned by the PCF not successfully + installed/activated. + sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: > + Information about the session rules provisioned by the PCF not successfully installed. + ueCampingRep: + $ref: '#/components/schemas/UeCampingRep' + policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. + invalidPolicyDecs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' + minItems: 1 + description: > + Indicates the invalid parameters for the reported type(s) of the failed policy decision + and/or condition data. + required: + - failureCause + + AuthorizedDefaultQos: + description: Represents the Authorized Default QoS. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' + averWindow: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' +maxDataBurstVol: +$ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' +maxbrUl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +maxbrDl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +gbrUl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +gbrDl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +extMaxDataBurstVol: +$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + +ErrorReport: + description: Contains the rule,policy decision and/or condition data error reports. + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: Used to report the PCC rule failure. + sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: Used to report the session rule failure. + polDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Used to report failure of the policy decision and/or condition data. + invalidPolicyDecs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/InvalidParam' + minItems: 1 + description: > + Indicates the invalid parameters for the reported type(s) of the failed policy decision + and/or condition data. + +SessionRuleReport: + description: Represents reporting of the status of a session rule. + type: object + properties: + ruleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the identifier of the affected session rule(s). + ruleStatus: + $ref: '#/components/schemas/RuleStatus' + sessRuleFailureCode: + $ref: '#/components/schemas/SessionRuleFailureCode' + policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. + required: + - ruleIds + - ruleStatus + +ServingNfIdentity: + description: Contains the serving Network Function identity. + type: object + properties: + servNfInstId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + anGwAddr: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AnGwAddress' + sgsnAddr: + $ref: '#/components/schemas/SgsnAddress' + +SteeringMode: + description: Contains the steering mode value and parameters determined by the PCF. + type: object + properties: + steerModeValue: + $ref: '#/components/schemas/SteerModeValue' + active: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + 3gLoad: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + prioAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + thresValue: + $ref: '#/components/schemas/ThresholdValue' + steerModeInd: + $ref: '#/components/schemas/SteerModeIndicator' + primary: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + + required: + - steerModeValue + +AdditionalAccessInfo: + description: > + Indicates the combination of additional Access Type and RAT Type for a MA PDU session. + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + required: + - accessType + +QosMonitoringData: + description: Contains QoS monitoring related control information. + type: object + properties: + qmId: + type: string + description: Univocally identifies the QoS monitoring policy data within a PDU session. + reqQosMonParams: + type: array + items: + $ref: '#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + description: > + indicates the QoS information to be monitored when the QoS Monitoring is enabled for + the service data flow. + repFreqs: + type: array + items: + $ref: '#/components/schemas/ReportingFrequency' + minItems: 1 + repThreshDl: + type: integer + description: Indicates the period of time in units of milliseconds for DL packet delay. + nullable: true + repThreshUl: + type: integer + description: Indicates the period of time in units of milliseconds for UL packet delay. + nullable: true + repThreshRp: + type: integer + description: > + Indicates the period of time in units of milliseconds for round trip packet delay. + nullable: true + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nullable: true +``` + +``` + + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nullable: true + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' + notifyCorreId: + type: string + nullable: true + directNotifInd: + type: boolean + description: > + Indicates that the direct event notification sent by UPF to the Local NEF or AF is + requested if it is included and set to true. + avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + dataCollAppId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + required: + - qmId + - reqQosMonParams + - repFreqs + nullable: true + + QosMonitoringReport: + description: Contains reporting information on QoS monitoring. + 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 monitoring + report. + ulDelays: + type: array + items: + type: integer + minItems: 1 + dlDelays: + type: array + items: + type: integer + minItems: 1 + rtDelays: + type: array + items: + type: integer + minItems: 1 + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + ulCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dlCongInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + cimf: + type: boolean + description: > + Congestion information measurement failure indicator. When set to true, it indicates + that a congestion information failure has occurred. Default value is false if omitted. + required: + - refPccRuleIds + +# +TsnBridgeInfo: + +``` + +``` +description: Contains parameters that describe and identify the TSC user plane node. +type: object +properties: + bridgeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + dsttAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dsttPortNum: + $ref: '#/components/schemas/TsnPortNumber' + dsttResidTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + mtuIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' + mtuIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' +# +PortManagementContainer: + description: Contains the port management information container for a port. + type: object + properties: + portManCont: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + portNum: + $ref: '#/components/schemas/TsnPortNumber' + required: + - portManCont + - portNum +BridgeManagementContainer: + description: Contains the UMIC. + type: object + properties: + bridgeManCont: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - bridgeManCont +IpMulticastAddressInfo: + description: Contains the IP multicast addressing information. + type: object + properties: + srcIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv4MulAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + srcIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6MulAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +DownlinkDataNotificationControl: + description: Contains the downlink data notification control information. + type: object + properties: + notifCtrlInds: + type: array + items: + $ref: '#/components/schemas/NotificationControlIndication' + minItems: 1 + typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 +DownlinkDataNotificationControlRm: + description: > + This data type is defined in the same way as the DownlinkDataNotificationControl data type, + but with the nullable:true property. + type: object + properties: + notifCtrlInds: + type: array + items: + $ref: '#/components/schemas/NotificationControlIndication' + minItems: 1 + nullable: true + typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 +``` + +``` + nullable: true + thresholdValue: + description: Indicates the threshold value(s) for RTT and/or Packet Loss Rate. + type: object + properties: + rttThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + plrThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + nullable: true + NwdafData: + description: > + Indicates the list of Analytic ID(s) per NWDAF instance ID used for the PDU Session consumed + by the SMF. + type: object + properties: + nwdafInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nwdafEvents: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + required: + - nwdafInstanceId + + CallInfo: + description: Identifies the caller and callee information. + type: object + properties: + callingPartyAddrs: + type: array + items: + type: string + minItems: 1 + calleeInfo: + $ref: '#/components/schemas/CalleeInfo' + nullable: true + + CalleeInfo: + description: Identifies the callee information. + type: object + properties: + calledPartyAddr: + type: string + requestPartyAddrs: + type: array + items: + type: string + minItems: 1 + calledAssertIds: + type: array + items: + type: string + minItems: 1 + nullable: true + +# +TrafficParaData: + description: Contains Traffic Parameter(s) related control information. + type: object + properties: + periodInfo: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/PeriodicityInfo' + reqTrafficParas: + type: array + items: + $ref: '#/components/schemas/TrafficParameterMeas' + minItems: 1 + description: Indicates the traffic parameters to be measured. + repFreqs: + type: array + items: + $ref: '#/components/schemas/ReportingFrequency' + minItems: 1 + description: Represents the notification method (periodic or on event detection). + dlN6JitterThr: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + required: + - reqTrafficParas + +L4sSupportInfo: + description: Contains the ECN marking for L4S support in 5GS information. + 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 ECN marking + for L4S support info. + notifType: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/L4sNotifType' + required: + - refPccRuleIds + - notifType + +SliceUsgCtrlInfo: + description: Represents network slice usage control information. + type: object + properties: + pduSessInactivTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + +5GSmCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +EpsRanNasRelCause: + type: string + description: Defines the EPS RAN/NAS release cause. +PacketFilterContent: + type: string + description: Defines a packet filter for an IP flow. +FlowDescription: + type: string + description: Defines a packet filter for an IP flow. +TsnPortNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +ApplicationDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +UePolicyContainer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +UrspEnforcementInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +FlowDirection: + anyOf: + - type: string + enum: + - DOWNLINK + - UPLINK + - BIDIRECTIONAL + - UNSPECIFIED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Indicates the direction of the service data flow. + 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: + description: > + This data type is defined in the same way as the "FlowDirection" data type, with the only + difference that it allows null value. + anyOf: + - $ref: '#/components/schemas/FlowDirection' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + +ReportingLevel: + anyOf: + - type: string + enum: + - SER_ID_LEVEL + - RAT_GR_LEVEL + - SPON_CON_LEVEL + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Indicates the reporting level. + 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 + enum: + - DURATION + - VOLUME + - DURATION_VOLUME + - EVENT + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Indicates the metering method. + 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 + enum: + - PLMN_CH + - RES_MO_RE + - AC_TY_CH + - UE_IP_CH + - UE_MAC_CH + - AN_CH_COR + - US_RE + - APP_STA + - APP_STO + - AN_INFO + - CM_SES_FAIL + - PS_DA_OFF + - DEF_QOS_CH + - SE_AMBR_CH + - QOS_NOTIF + - NO_CREDIT + - REALLO_OF_CREDIT + - PRA_CH + - SAREA_CH + - SCNN_CH + - RE_TIMEOUT +``` + +``` + +- RES_RELEASE +- SUCC_RES_ALLO +- RAI_CH +- RAT TY_CH +- REF_QOS_IND_CH +- NUM_OF_PACKET_FILTER +- UE_STATUS_RESUME +- UE_TZ_CH +- AUTH_PROF_CH +- QOS_MONITORING +- SCELL_CH +- USER_LOCATION_CH +- EPS_FALLBACK +- MA_PDU +- TSN_BRIDGE_INFO +- 5G_RG_JOIN +- 5G_RG_LEAVE +- DDN_FAILURE +- DDN_DELIVERY_STATUS +- GROUP_ID_LIST_CHG +- DDN_FAILURE_CANCELLATION +- DDN_DELIVERY_STATUS_CANCELLATION +- VPLMN_QOS_CH +- SUCC_QOS_UPDATE +- SAT_CATEGORY_CHG +- PCF_UE_NOTIF_IND +- NWDAF_DATA_CHG +- UE_POL_CONT_IND +- URSP_ENFORCEMENT_INFO +- HR_SBO_IND_CHG +- L4S_SUPP +- NET_SLICE_REPL +- BAT_OFFSET_INFO +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Indicates the policy control request trigger(s). + 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 guaranteed or gurated again. + - NO_CREDIT: Out of credit. + - REALLO_OF_CREDIT: Reallocation 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. + - RAI_CH: Location Change with respect to the RAI of GERAN and UTRAN. + - RAT TY_CH: RAT Type Change. + - REF_QOS_IND_CH: Reflective QoS indication Change + - NUM_OF_PACKET_FILTER: Indicates that the SMF shall report the number of supported packet + filter for signalled QoS rules. + - UE_STATUS_RESUME: Indicates that the UE's status is resumed. + +``` + +- UE\_TZ\_CH: UE Time Zone Change. +- AUTH\_PROF\_CH: The DN-AAA authorization profile index has changed. +- QOS\_MONITORING: Indicate that the SMF notifies the PCF of the QoS Monitoring information. +- SCELL\_CH: Location Change with respect to the Serving Cell. +- USER\_LOCATION\_CH: Indicate that user location has been changed, applicable to serving area change and serving cell change. +- EPS\_FALLBACK: EPS Fallback report is enabled in the SMF. +- MA\_PDU: UE Indicates that the SMF notifies the PCF of the MA PDU session request. +- TSN\_BRIDGE\_INFO: TSC user plane node information available. +- 5G\_RG\_JOIN: The 5G-RG has joined to an IP Multicast Group. +- 5G\_RG\_LEAVE: The 5G-RG has left an IP Multicast Group. +- DDN\_FAILURE: Event subscription for DDN Failure event received. +- DDN\_DELIVERY\_STATUS: Event subscription for DDN Delivery Status received. +- GROUP\_ID\_LIST\_CHG: UE Internal Group Identifier(s) has changed: the SMF reports that UDM provided list of group Ids has changed. +- DDN\_FAILURE\_CANCELLATION: The event subscription for DDN Failure event is cancelled. +- DDN\_DELIVERY\_STATUS\_CANCELLATION: The event subscription for DDN STATUS is cancelled. +- VPLMN\_QOS\_CH: Change of the QoS supported in the VPLMN. +- SUCC\_QOS\_UPDATE: Indicates that the requested MPS Action is successful. +- SAT\_CATEGORY\_CHG: Indicates that the SMF has detected a change between different satellite backhaul categories, or between a satellite backhaul and a non-satellite backhaul. +- PCF\_UE\_NOTIF\_IND: Indicates the SMF has detected the AMF forwarded the PCF for the UE indication to receive/stop receiving notifications of SM Policy association established/terminated events. +- NWDAF\_DATA\_CHG: Indicates that the NWDAF instance IDs used for the PDU session and/or associated Analytics IDs used for the PDU session and available in the SMF have changed. +- UE\_POL\_CONT\_IND: Indicates that a UE policy container is received from the UE in EPC over a PDN connection. +- URSP\_ENFORCEMENT\_INFO: Indicates a report of URSP rule enforcement information. +- HR\_SBO\_IND\_CHG: Indicates the HR-SBO support indication has changed. +- L4S\_SUPP: Indicates whether ECN marking for L4S is not available or available again in 5GS. +- NET\_SLICE\_REPL: Indicates network slice replacement, i.e., a change between the initial S-NSSAI of the PDU Session and the Alternative S-NSSAI +- BAT\_OFFSET\_INFO: Indicates that the SMF has detected the BAT offset and optionally adjusted periodicity. + +RequestedRuleDataType: + +anyOf: + +- type: string + - enum: + - CH\_ID + - MS\_TIME\_ZONE + - USER\_LOC\_INFO + - RES\_RELEASE + - SUCC\_RES\_ALLO + - EPS\_FALLBACK +- type: string + - description: > + + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | + +Indicates the type of rule data requested by the PCF. + +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. +- EPS\_FALLBACK: Indicates that the requested rule data is the report of QoS flow rejection due to EPS fallback. + +RuleStatus: + +anyOf: + +- type: string + - enum: + - ACTIVE + - INACTIVE +- type: string + - description: > + + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | + +Indicates the status of PCC or session rule. + +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 + +enum: + +- UNK\_RULE\_ID +- RA\_GR\_ERR +- SER\_ID\_ERR +- NF\_MAL +- RES\_LIM +- MAX\_NR\_QoS\_FLOW +- MISS\_FLOW\_INFO +- RES\_ALLO\_FAIL +- UNSUCC\_QoS\_VAL +- INCOR\_FLOW\_INFO +- PS\_TO\_CS\_HAN +- APP\_ID\_ERR +- NO\_QoS\_FLOW\_BOUND +- FILTER\_RES +- MISS\_REDI\_SER\_ADDR +- CM\_END\_USER\_SER\_DENIED +- CM\_CREDIT\_CON\_NOT\_APP +- CM\_AUTH\_REJ +- CM\_USER\_UNK +- CM\_RAT\_FAILED +- UE\_STA\_SUSP +- UNKNOWN\_REF\_ID +- INCORRECT\_COND\_DATA +- REF\_ID\_COLLISION +- TRAFFIC\_STEERING\_ERROR +- DNAI\_STEERING\_ERROR +- AN\_GW\_FAIL +- MAX\_NR\_PACKET\_FILTERS\_EXCEEDED +- PACKET\_FILTER\_TFT\_ALLOCATION\_EXCEEDED +- MUTE\_CHG\_NOT\_ALLOWED +- UE\_TEMPORARILY\_UNAVAILABLE + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | + +Indicates the reason of the PCC rule failure. + +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 neither the "flowInfos" attribute nor the "appId" attribute is specified within the PccRule data structure 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 within the "flowInfos" attribute cannot be handled by the SMF because any of the restrictions defined in clause 5.4.2 of 3GPP TS 29.212 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. + +- UE\_STA\_SUSP: Indicates that the UE is in suspend state. + +- UNKNOWN\_REF\_ID: Indicates that the PCC rule could not be successfully installed/modified because the referenced identifier to a Policy Decision Data or to a Condition Data is unknown to the SMF. + +- INCORRECT\_COND\_DATA: Indicates that the PCC rule could not be successfully installed/modified because the referenced Condition data are incorrect. + +- REF\_ID\_COLLISION: Indicates that PCC rule could not be successfully installed/modified because the same Policy Decision is referenced by a session rule (e.g. the session rule and the PCC rule refer to the same Usage Monitoring decision data). + +- TRAFFIC\_STEERING\_ERROR: Indicates that enforcement of the steering of traffic to the N6-LAN or 5G-LAN failed; or the dynamic PCC rule could not be successfully installed or modified at the NF service consumer because there are invalid traffic steering policy identifier(s) within the provided Traffic Control Data policy decision to which the PCC rule refers. + +- DNAI\_STEERING\_ERROR: Indicates that the enforcement of the steering of traffic to the indicated DNAI failed; or the dynamic PCC rule could not be successfully installed or modified at the NF service consumer because there is invalid route information for a DNAI(s) (e.g. routing profile id is not configured) within the provided Traffic Control Data policy decision to which the PCC rule refers. + +- AN\_GW\_FAILED: This value is used to indicate that the AN-Gateway has failed and that the PCF should refrain from sending policy decisions to the SMF until it is informed that the S-GW has been recovered. This value shall not be used if the SM Policy association modification procedure is initiated for PCC rule removal only. + +- MAX\_NR\_PACKET\_FILTERS\_EXCEEDED: This value is used to indicate that the PCC rule could not be successfully installed, modified or enforced at the NF service consumer because the number of supported packet filters for signalled QoS rules for the PDU session has been reached. + +- PACKET\_FILTER\_TFT\_ALLOCATION\_EXCEEDED: This value is used to indicate that the PCC rule is removed at 5GS to EPS mobility because TFT allocation was not possible since the number of active packet filters in the EPC bearer is exceeded. + +- MUTE\_CHG\_NOT\_ALLOWED: Indicates that the PCC rule could not be successfully modified because the mute condition for application detection report cannot be changed. Applicable when the functionality introduced with the ADC feature applies. + +#### AfSigProtocol: + +##### anyOf: + +- type: string + +##### enum: + +- NO\_INFORMATION + +- SIP + +- \$ref: 'TS29571\_CommonData.yaml#/components/schemas/NullValue' + +- type: string + +##### description: > + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +##### description: | + +Indicates the protocol used for signalling between the UE and the AF. +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. + +**RuleOperation:****anyOf:** + +- type: string + +**enum:** + +- CREATE\_PCC\_RULE +- DELETE\_PCC\_RULE +- MODIFY\_PCC\_RULE\_AND\_ADD\_PACKET\_FILTERS +- MODIFY\_PCC\_RULE\_AND\_REPLACE\_PACKET\_FILTERS +- MODIFY\_PCC\_RULE\_AND\_DELETE\_PACKET\_FILTERS +- MODIFY\_PCC\_RULE\_WITHOUT\_MODIFY\_PACKET\_FILTERS + +- type: string + +**description: >** + +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. + +**description: |** + +Indicates a UE initiated resource operation that causes a request for PCC rules. + +Possible values are + +- CREATE\_PCC\_RULE: Indicates to create a new PCC rule to reserve the resource requested by the UE. +- DELETE\_PCC\_RULE: Indicates to delete a PCC rule corresponding to reserve the resource requested by the UE. +- MODIFY\_PCC\_RULE\_AND\_ADD\_PACKET\_FILTERS: Indicates to modify the PCC rule by adding new packet filter(s). +- MODIFY\_PCC\_RULE\_AND\_REPLACE\_PACKET\_FILTERS: Indicates to modify the PCC rule by replacing the existing packet filter(s). +- MODIFY\_PCC\_RULE\_AND\_DELETE\_PACKET\_FILTERS: Indicates to modify the PCC rule by deleting the existing packet filter(s). +- MODIFY\_PCC\_RULE\_WITHOUT\_MODIFY\_PACKET\_FILTERS: Indicates to modify the PCC rule by modifying the QoS of the PCC rule. + +**RedirectAddressType:****anyOf:** + +- type: string + +**enum:** + +- IPV4\_ADDR +- IPV6\_ADDR +- URL +- SIP\_URI + +- type: string + +**description: >** + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +**description: |** + +Indicates the redirect address type. + +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 + +**enum:** + +- GENERAL +- IMS\_SIG + +- type: string + +**description: >** + +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +**description: |** + +Indicates a QoS flow usage information. + +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. + +**FailureCause:** + +description: Indicates the cause of the failure in a Partial Success Report. + +**anyOf:** + +``` +- type: string +enum: + - PCC_RULE_EVENT + - PCC_QOS_FLOW_EVENT + - RULE_PERMANENT_ERROR + - RULE_TEMPORARY_ERROR + - POL_DEC_ERROR +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. +``` + +``` +CreditManagementStatus: +description: Indicates the reason of the credit management session failure. +anyOf: +- type: string +enum: + - END_USER_SER_DENIED + - CREDIT_CTRL_NOT_APP + - AUTH_REJECTED + - USER_UNKNOWN + - RATING_FAILED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. +``` + +``` +SessionRuleFailureCode: +anyOf: +- type: string +enum: + - NF_MAL + - RES_LIM + - SESSION_RESOURCE_ALLOCATION_FAILURE + - UNSUCC_QOS_VAL + - INCORRECT_UM + - UE_STA_SUSP + - UNKNOWN_REF_ID + - INCORRECT_COND_DATA + - REF_ID_COLLISION + - AN_GW_FAILED + - DEFAULT_QOS_MODIFICATION_FAILURE + - SESSION_AMBR_MODIFICATION_FAILURE +- type: string +description: > +This string provides forward-compatibility with future +extensions to the enumeration and is not used to encode +content defined in the present version of this API. +description: | +Indicates the reason of the session rule failure. +Possible values are +- NF_MAL: Indicates 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: Indicates 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. +- SESSION_RESOURCE_ALLOCATION_FAILURE: Indicates the session rule could not be successfully +enforced due to failure during the allocation of resources for the PDU session in the UE, +RAN or AMF. +- UNSUCC_QOS_VAL: indicates that the QoS validation has failed. +- INCORRECT_UM: The usage monitoring data of the enforced session rule is not the same for +all the provisioned session rule(s). +- UE_STA_SUSP: Indicates that the UE is in suspend state. +- UNKNOWN_REF_ID: Indicates that the session rule could not be successfully +installed/modified because the referenced identifier to a Policy Decision Data or to a +Condition Data is unknown to the SMF. +- INCORRECT_COND_DATA: Indicates that the session rule could not be successfully +installed/modified because the referenced Condition data are incorrect. +- REF_ID_COLLISION: Indicates that the session rule could not be successfully +installed/modified because the same Policy Decision is referenced by a PCC rule (e.g. the +session rule and the PCC rule refer to the same Usage Monitoring decision data). +- AN_GW_FAILED: Indicates that the AN-Gateway has failed and that the PCF should refrain +from sending policy decisions to the SMF until it is informed that the S-GW has been +recovered. This value shall not be used if the SM Policy association modification procedure +is initiated for session rule removal only. +- DEFAULT_QOS_MODIFICATION_FAILURE: Indicates that the enforcement of the default QoS +modification failed. The SMF shall use this value to indicate to the PCF that the default +``` + +QoS modification has failed. +- SESSION\_AMBR\_MODIFICATION\_FAILURE: Indicates that the enforcement of the session-AMBR modification failed. The SMF shall use this value to indicate to the PCF that the session-AMBR modification has failed. + +SteeringFunctionality: + +anyOf: +- type: string +enum: +- MPTCP +- MPQUIC +- ATSSS\_LL +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. +description: | +Indicates functionality to support traffic steering, switching and splitting determined by the PCF. +Possible values are +- MPTCP: Indicates that PCF authorizes the MPTCP functionality to support traffic steering, switching and splitting. +- ATSSS\_LL: Indicates that PCF authorizes the ATSSS-LL functionality to support traffic steering, switching and splitting. + +SteerModeValue: + +description: Indicates the steering mode value determined by the PCF. +anyOf: +- type: string +enum: +- ACTIVE\_STANDBY +- LOAD\_BALANCING +- SMALLEST\_DELAY +- PRIORITY\_BASED +- REDUNDANT +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +MulticastAccessControl: + +description: > +Indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed. +anyOf: +- type: string +enum: +- ALLOWED +- NOT\_ALLOWED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +RequestedQoSMonitoringParameter: + +description: Indicates the requested QoS monitoring parameters to be measured. +anyOf: +- type: string +enum: +- DOWNLINK +- UPLINK +- ROUND\_TRIP + +- DOWNLINK\_DATA\_RATE +- UPLINK\_DATA\_RATE +- DOWNLINK\_CONGESTION +- UPLINK\_CONGESTION +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +ReportingFrequency: + +description: Indicates the frequency for the reporting. +anyOf: +- type: string +enum: + +- EVENT\_TRIGGERED +- PERIODIC +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +SgsnAddress: +description: describes the address of the SGSN +type: object +anyOf: +- required: [sgsnIpv4Addr] +- required: [sgsnIpv6Addr] +properties: +sgsnIpv4Addr: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +sgsnIpv6Addr: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' + +SmPolicyAssociationReleaseCause: +description: > +Represents the cause due to which the PCF requests the termination of the SM policy association. +anyOf: +- type: string +enum: +- UNSPECIFIED +- UE\_SUBSCRIPTION +- INSUFFICIENT\_RES +- VALIDATION\_CONDITION\_NOT\_MET +- REACTIVATION\_REQUESTED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +PduSessionRelCause: +description: Contains the SMF PDU Session release cause. +anyOf: +- type: string +enum: +- PS\_TO\_CS\_HO +- RULE\_ERROR +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +MaPduIndication: +description: > +Contains the MA PDU session indication, i.e., MA PDU Request or MA PDU Network-Upgrade Allowed. +anyOf: +- type: string +enum: +- MA\_PDU\_REQUEST +- MA\_PDU\_NETWORK\_UPGRADE\_ALLOWED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +AtsssCapability: +description: Contains the ATSSS capability supported for the MA PDU Session. +anyOf: +- type: string +enum: +- MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_UL +- MPTCP\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL +- MPTCP\_ATSSS\_LL\_WITH\_ASMODE\_DLUL +- ATSSS\_LL +- MPTCP\_ATSSS\_LL +- MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL +- MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL +- MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_DLUL +- MPQUIC\_ATSSS\_LL +- MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_ASMODE\_UL +- MPTCP\_MPQUIC\_ATSSS\_LL\_WITH\_EXSDMODE\_DL\_ASMODE\_UL + +``` + - MPTCP_MPQUIC_ATSSS_LL_WITH_ASMODE_DLUL + - MPTCP_MPQUIC_ATSSS_LL + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +# +NetLocAccessSupport: + anyOf: + - type: string + enum: + - ANR_NOT_SUPPORTED + - TZR_NOT_SUPPORTED + - LOC_NOT_SUPPORTED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Indicates the access network support of the report of the requested access network + information. + Possible values are + - ANR_NOT_SUPPORTED: Indicates that the access network does not support the report of access + network information. + - TZR_NOT_SUPPORTED: Indicates that the access network does not support the report of UE + time zone. + - LOC_NOT_SUPPORTED: Indicates that the access network does not support the report of UE + Location (or PLMN Id). + +PolicyDecisionFailureCode: + description: Indicates the type of the failed policy decision and/or condition data. + anyOf: + - type: string + enum: + - TRA_CTRL_DECS_ERR + - QOS_DECS_ERR + - CHG_DECS_ERR + - USA_MON_DECS_ERR + - QOS_MON_DECS_ERR + - CON_DATA_ERR + - POLICY_PARAM_ERR + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +# +NotificationControlIndication: + description: > + Indicates that the notification of DDD Status is requested and/or that the notification of + DDN Failure is requested. + anyOf: + - type: string + enum: + - DDN_FAILURE + - DDD_STATUS + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +# +SteerModeIndicator: + description: Contains Autonomous load-balance indicator or UE-assistance indicator. + anyOf: + - type: string + enum: + - AUTO_LOAD_BALANCE + - UE_ASSISTANCE + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +# +TrafficParameterMeas: + description: Indicates the traffic parameters to be measured. + anyOf: + - type: string + enum: +``` + +``` +- DL_N6_JITTER +- DL_PERIOD +- UL_PERIOD +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. +``` + +--- + +## Annex B (normative): 5GC and EPC interworking scenario support + +### B.1 Scope + +This annex defines procedures for 5GC and EPC interworking, which contains the following scenarios: + +- EPS and 5GS interworking (i.e. 3GPP access connected to EPC and 3GPP access connected to 5GC). +- EPC/ePDG and 5GS interworking (i.e. ePDG connected to EPC and 3GPP access connected to 5GC). +- EPS and 5GC/N3IWF interworking (i.e. 3GPP access connected to EPC and N3IWF connected to 5GC). +- EPS and 5GC/TNAN/TWAN interworking (i.e. 3GPP access connected to EPC and TNAN/TWAN connected to 5GC). + +NOTE: In this Release 5GC and EPC interworking is not supported for SNPN. + +--- + +## B.2 Npcf\_SMPolicyControl Service + +### B.2.1 Service Description + +#### B.2.1.1 Overview + +Session Management Policy Control Service applies to the cases where the SMF+PGW-C interacts with the PCF in the non-roaming scenario, the SMF+PGW-C interacts with the V-PCF in the local breakout roaming scenario and the H-SMF+H-PGW-C interacts with the H-PCF in the home-routed scenario. + +#### B.2.1.2 Service Architecture + +The Session Management Policy Control Service is provided by the PCF as shown in the SBI representation model in figure B.2.1.2-1 and in the reference point representation model in figure B.2.1.2.2. + +In this scenario the NF Service Consumer is a combined SMF and PGW-C. + +![Figure B.2.1.2-1: Reference Architecture for the Npcf_SMPolicyControl Service for 5GC and EPC interworking scenario; SBI representation. The diagram shows a PCF (Policy Control Function) connected to an SMF+PGW-C (SMF+PDN Gateway-C) via an Npcf interface. The Npcf interface is represented by a circle labeled 'Npcf' inside the PCF box, and the service name 'Npcf_SMPolicyControl' is shown in a box between the PCF and the SMF+PGW-C.](bf9abec3605f1a8d00ae6524a9af02ed_img.jpg) + +Figure B.2.1.2-1: Reference Architecture for the Npcf\_SMPolicyControl Service for 5GC and EPC interworking scenario; SBI representation. The diagram shows a PCF (Policy Control Function) connected to an SMF+PGW-C (SMF+PDN Gateway-C) via an Npcf interface. The Npcf interface is represented by a circle labeled 'Npcf' inside the PCF box, and the service name 'Npcf\_SMPolicyControl' is shown in a box between the PCF and the SMF+PGW-C. + +**Figure B.2.1.2-1: Reference Architecture for the Npcf\_SMPolicyControl Service for 5GC and EPC interworking scenario; SBI representation** + +![Figure B.2.1.2-2: Reference Architecture for the Npcf_SMPolicyControl Service or 5GC and EPC interworking scenario; reference point representation. The diagram shows a PCF (Policy Control Function) connected to an SMF+PGW-C (SMF+PDN Gateway-C) via an N7 reference point. The N7 reference point is represented by a box labeled 'N7' between the PCF and the SMF+PGW-C.](096a620f7a0b1b639a9da9618c1a3801_img.jpg) + +Figure B.2.1.2-2: Reference Architecture for the Npcf\_SMPolicyControl Service or 5GC and EPC interworking scenario; reference point representation. The diagram shows a PCF (Policy Control Function) connected to an SMF+PGW-C (SMF+PDN Gateway-C) via an N7 reference point. The N7 reference point is represented by a box labeled 'N7' between the PCF and the SMF+PGW-C. + +**Figure B.2.1.2-2: Reference Architecture for the Npcf\_SMPolicyControl Service or 5GC and EPC interworking scenario; reference point representation** + +NOTE: The PCF represents the V-PCF in the local breakout scenario. The SMF+PGW-C represents the H-SMF+H-PGW-C and the PCF represents the H-PCF in the home routed scenario. + +## B.3 Service Operation + +### B.3.1 Introduction + +This clause defines the specific service operations for the 5GC and EPC interworking scenario. In addition, the service operations defined in clause 4.2 shall be applicable. + +NOTE: For brevity reason, the combined SMF and PGW-C is denoted as SMF in what follows. + +### B.3.2 Npcf\_SMPolicyControl\_Create Service Operation + +#### B.3.2.0 General + +When the UE establishes the PDN connection through the EPC network and the SMF+PGW-C receives the Create Session Request message as defined in 3GPP TS 29.274 [37], the SMF+PGW-C shall behave as defined in clause 4.2.2.2 with the differences that the SMF+PGW-C shall include (if available) in SmPolicyContextData data structure: + +- the IMSI of the user within the "supi" attribute; +- the MSISDN of the user within the "gpsi" attribute; +- APN within the "dnn" attribute; + +- PDU Session Id determined by the SMF+PGW-C within "pduSessionId" attribute for a UE that has an EPS subscription that allows 5GC interworking but does not support 5GC NAS. + +NOTE 1: For a PDN connection established via the MME or ePDG, the PDU Session ID value is assigned from a reserved range as specified in Table 5.4.2-1 of 3GPP TS 29.571 [11]. The PDU session ID value assigned at PDN connection establishment remains unchanged along the PDN connection, i.e., it does not change when the UE handovers between EPS and EPC/ePDG. In the scenarios where UE handover between EPS and EPC/ePDG is enabled, to ensure uniqueness of the assigned PDU Session ID value, the SMF+PGW-C can retrieve from UDM the already assigned PDU Session ID values, allocate a non-colliding PDU Session ID value, and register in UDM the allocated PDU session ID; + +- PDN Type within the "pduSessionType" attribute; +- IMEI-SV within the "pei" attribute; +- IP-CAN type within the "accessType" attribute; +- RAT type within the "ratType" attribute; + +NOTE 2: See Annex B.3.2.2 for further information. + +- subscribed APN-AMBR within "subsSessAmbr" attribute; +- subscribed Default EPS bearer QoS within "subsDefQos" attribute; + +NOTE 3: Subscribed APN-AMBR and the QCI within the subscribed default EPS bearer QoS are mapped to subscribed Session-AMBR and 5QI as defined in Annex B.3.6.1 respectively. + +- user location information within the "userLocationInfo" attribute; + +NOTE 4: See Annex B.3.2.1 for further information. + +- the S-NSSAI determined by the SMF+PGW-C within the "sliceInfo" attribute; +- the bearer usage required of the default bearer within the "qosFlowUsage" attribute; +- the UE time zone information within "ueTimeZone" attribute, if available. + +NOTE 5: The UE time zone is not available in EPC untrusted WLAN. + +When the UE establishes the PDN connection in an 5GS-EPC interworking deployment, the SMF+PGW-C shall behave as defined in clause 4.2.2.2 (access through 5GS network) or this clause (access through the EPC network) and additionally, if the feature "PackFiltAllocPrecedence" is supported and there is a possibility to run into a restriction regarding the number of TFT packet filters that can be allocated when interworking with EPS with N26 is supported (see clause 4.11.1 of TS 23.502 [3]), the PCF may provide, as part of the PccRule data type(s) for the PCC Rules to be installed, the "packFiltAllPrec" attribute to indicate the order of the PCC Rules in the allocation of TFT packet filter(s) by the SMF+PGW-C. + +NOTE 6: PCF can know that interworking with EPS with N26 is supported based on the received DNN and S-NSSAI of the PDU Session. + +### B.3.2.1 UE Location related information + +When the UE establishes the PDN connection through the EPC/E-UTRAN network, the SMF+PGW-C shall include, if available, the following user location information: + +- user location information within the "eutraLocation" attribute included in the "userLocationInfo" attribute; and +- S-GW address, if available, within the "anGwAddr" attribute included in the "servNfId" attribute. + +When the UE establishes the PDN connection through the EPC/UTRAN network and the feature "2G3GIWK" is supported, the SMF+PGW-C shall include, if available, the following user location information: + +- user location information within the "utraLocationInfo" attribute included in the "userLocationInfo" attribute; and + +- SGSN address, if available, within the "sgsnAddr" attribute included in the "servNfId" attribute. + +When the UE establishes the PDN connection through the EPC/GERAN network and the feature "2G3GIWK" is supported, the SMF+PGW-C shall include, if available, the following user location information: + +- user location information within the "geraLocationInfo" attribute included in the "userLocationInfo" attribute; and +- SGSN address, if available, within the "sgsnAddr" attribute included in the "servNfId" attribute. + +When the UE establishes the PDN connection through the EPC/ePDG network, the SMF+PGW-C shall include, if available, the following user location information: + +- user location information within the "n3gaLocation" attribute included in the "userLocationInfo" attribute. The "n3gaLocation" attribute includes the "ueIpv4Addr" or "ueIpv6Addr" attributes, and, if available the "portNumber" and "protocol" attributes and, if the feature "WLAN\_Location" is supported, the "twapId" attribute encoding the WLAN location information, if available; and +- ePDG identification within the "anGwAddr" attribute included in the "servNfId" attribute. + +NOTE: The "n3gaLocation" attribute does not include the "n3gppTai" and "n3IwfId" attributes in EPC interworking scenarios. + +### B.3.2.2 Access Type related information + +When the UE establishes the PDN connection through the EPC/E-UTRAN network, the SMF+PGW shall include, if available, the following access type information: + +- the "3GPP\_ACCESS" value within the "accessType" attribute; and +- the "EUTRA" value within the "ratType" attribute. + +When the UE establishes the PDN connection through the EPC/UTRAN network and the feature "2G3GIWK" is supported, the SMF+PGW shall include, if available, the following access type information: + +- the "3GPP\_ACCESS" value within the "accessType" attribute; and +- the "UTRA" value within the "ratType" attribute. + +When the UE establishes the PDN connection through the EPC/GERAN network and the feature "2G3GIWK" is supported, the SMF+PGW shall include, if available, the following access type information: + +- the "3GPP\_ACCESS" value within the "accessType" attribute; and +- the "GERA" value within the "ratType" attribute. + +When the UE establishes the PDN connection through the EPC/ePDG network, the SMF+PGW shall include, if available, the following access type information: + +- the "NON\_3GPP\_ACCESS" value within the "accessType" attribute; +- the "WLAN" or "VIRTUAL" value within the "ratType" attribute, as applicable; and +- the ePDG address in the "servNfId" attribute within the "anGwAddr" attribute. + +### B.3.2.3 Access Network Charging Identifier report + +During PDU session establishment procedure, the SMF+PGW-C may provide the Access Network Charging Identifier for the PDU session (i.e., for the default QoS flow or the default EPS bearer) as specified in clause 4.2.2.11, or may provide the Access Network Charging Identifier for the default EPS bearer and indicate that there is a separate access network charging identifier for each EPS bearer/QoS flow by omitting or setting to false the "sessionChScope" attribute. + +In both cases above, the Access Network Charging Identifier value and the address of the network entity performing the charging are provided as specified in clause 4.2.2.11. + +NOTE: During the PDU Session Establishment procedure, when there are different charging identifiers for each EPS bearer (or QoS flow), the "refPccRuleIds" attribute is not provided within the AccNetChId data structure, since the PCC Rules are not yet authorized at this stage. + +## B.3.3 Npcf\_SMPolicyControl\_UpdateNotify Service Operation + +### B.3.3.0 General + +When the UE has an established PDN connection through the EPC/E-UTRAN network and the PCF provisions the policy to the SMF+PGW-C as defined in clause 4.2.3. The SMF+ PGW-C shall behave as defined in clause 4.2.3 with the differences that the SMF+PGW-C shall map the QoS information within the PCC rule and/or session rule into EPS QoS information as defined in Annex B.3.6.1. + +When the UE has an established PDN connection in an 5GS-EPC interworking deployment, the SMF+PGW-C shall behave as defined in clause 4.2.3 (access through the 5GS network) or this clause (access through the EPC network) and additionally, if the feature "PackFiltAllocPrecedence" is supported and there is a possibility to run into a restriction regarding the number of TFT packet filters that can be allocated when interworking with EPS with N26 is supported as described in Annex B.3.2.0, the PCF may provide, as part of the PccRule data type for the new PCC Rules to be installed, the "packFiltAllPrec" attribute to indicate the order of the PCC Rules in the allocation of TFT packet filter(s) by the SMF+PGW-C. + +### B.3.3.1 Policy Update When UE suspends + +If the PolicyUpdateWhenUESuspends feature as defined in clause 5.8 is supported the PCF and the SMF shall comply with the procedures specified in this clause. During PDU session/PDN connection establishment or modification procedure, the PCF shall subscribe to the "UE\_STATUS\_RESUME" policy control request trigger if not subscribed yet, as described in clause 4.2.6.4. When the SMF receives the policy decision from the PCF as defined in clause 4.2.3.1 for a PDN connection maintained when the UE's status is suspend state, the SMF shall reject the request and include an HTTP "400 Bad Request" status code together with an ErrorReport structure. Within the ErrorReport data structure, the SMF shall include the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "UE\_STATUS\_SUSPEND" which indicates the failure to enforce the corresponding policy decision, except if the policy decision is for the PCC rule removal only and/or session rule removal only, and further include the information as follows: + +- If the policy decision includes the installation of one or more PCC rules, the SMF shall invoke the procedure as defined in clause 4.2.3.16 with the "failureCode" attribute set to "UE\_STA\_SUSP" and "ruleStatus" attribute set to INACTIVE to indicate the failure to enforce those PCC rules. +- If the policy decision includes the modification of one or more PCC rules, the SMF shall invoke the procedure as defined in clause 4.2.3.16 with the "failureCode" attribute set to "UE\_STA\_SUSP" and "ruleStatus" attribute set to ACTIVE to indicate the failure to enforce those PCC rules. +- If the policy decision includes the modification of one or more session rules, the SMF shall within a RuleReport data structure include the "sessRuleReports" attribute. Within each SessionRuleReport data structure, the SMF shall include the affected session rules within the "ruleIds" attribute(s), the "sessRuleFailureCode" attribute set to "UE\_STA\_SUSP" and "ruleStatus" attribute set to ACTIVE to indicate the failure to enforce those session rules. + +Upon reception of the "failureCode" attribute and/or "sessRuleFailureCode" attribute set to "UE\_STA\_SUSP" or the ProblemDetails data structure set to "UE\_STATUS\_SUSPEND", the PCF shall not initiate any PDU Session Modification procedure, except if it is initiated for the PCC rule removal only or the session rule removal only, for the given PDU session over N7 until the UE's status is resumed. When the SMF detected the UE's status is resumed from suspend state, the SMF shall inform the PCF of the UE status as defined in Annex B.3.4.2. + +### B.3.3.2 Request report of EPS Fallback + +When the "EPSFallbackReport" feature is supported, if the AF requests the PCF to report the EPS fallback for voice media type as described in clauses 4.2.2.30 or 4.2.3.29 of 3GPP TS 29.514 [17] or in clause E.3 of 3GPP TS 29.214 [18], the PCF shall perform the PCC rule provisioning procedure as defined in clause 4.2.6.2.1 and additionally provide the request of EPS fallback report to the SMF as follows: + +- it shall include the "lastReqRuleData" attribute to contain the "reqData" attribute with the value "EPS\_FALLBACK" and the "refPccRuleIds" attribute to contain the related installed/modified PCC rule identifier(s) with 5QI=1. +- it shall provide the "EPS\_FALLBACK" policy control request rigger within the "policyCtrlReqTriggers" attribute, if not provided before. + +### B.3.3.3 S-GW Restoration Support + +If the SGWRest feature as defined in clause 5.8 is supported, the PCF and the SMF shall comply with the procedures specified in this clause. During PDU session/PDN connection establishment or modification procedure, the PCF shall subscribe to the "SCNN\_CH" policy control request trigger if not subscribed yet, as described in clause 4.2.6.4. + +When the SMF+PGW receives the policy decision from the PCF as defined in clause 4.2.3.1 for a PDN connection maintained during a S-GW failure, the SMF+PGW shall act as follows: + +- For MME/S4-SGSN triggered S-GW Restoration scenarios: + - the SMF+PGW shall reject the request and include an HTTP "400 Bad Request" status code together with an ErrorReport structure. Within the ErrorReport data structure, the SMF shall include the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "AN\_GW\_FAILED" which indicates the failure to enforce the corresponding policy decision, except if the policy decision is for the PCC rule removal only and/or session rule removal only, and further include the information as follows: + - If the policy decision is related to one or more PCC rules, the SMF+PGW shall behave as defined in clause 4.2.3.16 with the "failureCode" attribute set to "AN\_GW\_FAILED". + - If the policy decision is related to one or more session rules, the SMF+PGW shall behave as defined in clause 4.2.3.20 with the "sessRuleFailureCode" attribute set to "AN\_GW\_FAILED". + - For SMF+PGW triggered S-GW Restoration scenarios, the SMF+PGW shall accept the procedure as per normal procedures. In the case, the PDN connection is not restored during an operator configured time period, the SMF+PGW shall behave as follows as defined in annex B.3.4.9. + +Upon reception of the "cause" attribute of the ProblemDetails data structure set to "AN\_GW\_FAILED" or the "failureCode" attribute set to "AN\_GW\_FAILED" and/or the "sessRuleFailureCode" attribute set to "AN\_GW\_FAILED", the PCF shall not initiate any SM Policy association modification procedure, except if the I SM Policy association modification procedure is initiated for the PCC rule removal only, for the given SM Policy association over N7 until the S-GW has recovered. + +The SMF+PGW shall maintain the PDN connections affected by the S-GW failure and eligible for restoration for an operator configurable time period. Upon expiry of that time period, the SMF+PGW shall release the PDN connection and inform the PCF about the SM Policy association termination as specified in clause 4.2.5.2. + +The SMF+PGW should maintain the GBR bearers of the PDN connections eligible for restoration for an operator configurable time period. Upon expiry of that time period, the SMF+PGW shall release GBR bearers that have not yet been restored and inform the PCF about the PCC rule removal as specified in clause 4.2.4.7. + +The SMF+PGW shall discard downlink packets received for a PDN connection maintained during a S-GW failure that has not yet been restored. + +The SMF+PGW shall delete the PDN connection locally when it receives an SM Policy association termination from the PCF as described in clause 4.2.4.3. + +### B.3.3.4 Request of Access Network Charging Identifier + +When the PCF received from the SMF+PGW-C the indication that the Access Network Charging Identifier is different per EPS bearer/QoS flow (see clause B.3.2.3), or the Access Network Charging identifier is unknown for an AF session to the PCF, and the PCF received from the AF the request of access network information as specified in 3GPP TS 29.514 [17] or 3GPP TS 29.214 [18], the PCF shall request the access network charging identifier associated to the dynamic PCC rules as specified in clause 4.2.6.5.1. + +### B.3.3.5 Forwarding of UE policy container for URSP provisioning in EPS + +The PCF may receive a UE policy container and/or policy control triggers from the PCF for the UE during the lifetime of the PDU session and forward it to the SMF+PGW-C by invoking the procedure defined in clause 4.2.3.2. + +If the feature "EpsUrsp" is supported the PCF initiates the Npcf\_SMPolicyControl\_UpdateNotify request and transparently forwards the the UE policy container to the SMF+PGW-C via the SmPolicyDecision structure, in which the UE policy container is encoded in the "uePolCont" attribute. + +## B.3.4 Npcf\_SMPolicyControl\_Update Service Operation + +### B.3.4.0 General + +When the established PDN connection through the EPC/E-UTRAN network is modified and SMF+PGW-C receives Modify Bearer Request, Modify Bearer or Delete Bearer Command message and if the SMF detects the policy control request trigger(s) is met or the error(s) needs to be reported or when the UE handed over from the 5GS to the EPS and the SMF detects the policy control request trigger(s) is met, the SMF+PGW-C shall behave as defined in clause 4.2.4.2 with the differences that the SMF+PGW-C shall include (if available) in the SmPolicyUpdateContextData data structure: + +- IP-CAN type within the "accessType" attribute; +- RAT type within the "ratType" attribute; + +NOTE 1: See Annex B.3.4.5 for further information. + +- subscribed APN-AMBR within the "subsSessAmbr" attribute; +- subscribed Default EPS bearer QoS Information within the "subsDefQos" attribute; + +NOTE 2: Subscribed APN-AMBR and the QCI within the subscribed default EPS bearer QoS are mapped to subscribed Session-AMBR and 5QI as defined in Annex B.3.6.1 respectively. + +- the bearer usage required for the dedicated bearer within the "qosFlowUsage" attribute if the UE initiates a resource modification request procedure and the bearer usage request was present in the Bearer Resource Command; +- user location information of EPC within the "userLocationInfo" attribute; and + +NOTE 3: See Annex B.3.4.3 for further information. + +- UE policy container within "uePolCont" attribute, if available. + +The policy control request trigger "RES\_MO\_RE" is not supported when the PDN connection is established through the EPC/E-UTRAN network. The SMF+PGW shall reject the PDU session modification that initiated the UE's resource modification. + +During interworking from 5GS to EPS, if the feature "PackFiltAllocPrecedence" is supported, for QoS Flows without EPS bearer ID(s) assigned or for QoS Flows related to PCC Rules that do not have allocated TFT packet filters, the SMF+PGW-C shall delete those PCC Rules and inform the PCF. The SMF+PGW-C shall include the "ruleReports" attribute containing the RuleReport data instance which specifies the affected PCC rules within the "pccRuleIds" attribute, set to "INACTIVE" the value within the "ruleStatus" attribute and the "PACKET\_FILTER\_TFT\_ALLOCATION\_EXCEEDED" as the value of the "failureCode" attribute. + +If the feature "PackFiltAllocPrecedence" is supported, the PCF may provide, as part of the PccRule data type for the new PCC Rules to be installed the "packFiltAllPrec" attribute to indicate the order of the PCC Rules in the allocation of TFT packet filter(s) by the SMF+PGW-C. The PCF may include this parameter if the feature "PackFiltAllocPrecedence" is supported and there is a possibility to run into a restriction regarding the number of TFT packet filters that can be allocated for the PDU Session and interworking with EPS with N26 deployment is supported as described in Annex B.3.2.0. + +### B.3.4.1 Number of Supported Packet Filters Report + +When the UE handed over from the EPC/E-UTRAN to the 5GS and the number of supported packet filters for signalled QoS rules is received from the UE, the SMF shall include the "NUM\_OF\_PACKET\_FILTER" within the "repPolicyCtrlReqTriggers" attribute and the number of supported packet filters for signalled QoS rules within the "numOfPackFilter". In this case, the PCF shall behave as defined in clause 4.2.6.2.16. + +NOTE: The maximum number of packet filters sent to the UE per QoS rule is additionally limited as specified in 3GPP TS 24.501 [20] when the UE is camping in 5GS. + +### B.3.4.2 Policy Update When UE suspends + +#### B.3.4.2.1 Policy Update Error Report + +If the PolicyUpdateWhenUESuspends feature as defined in clause 5.8 is supported, the PCF and the SMF shall comply with the procedures specified in this clause. During PDU session/PDN connection establishment or modification procedure, the PCF shall subscribe to the "UE\_STATUS\_RESUME" policy control request trigger if not subscribed yet, as described in clause 4.2.6.4. When the SMF receives the policy decision from the PCF as defined in clause 4.2.4.1 for a PDN connection maintained when the UE's status is suspend state, the SMF shall include the "ruleReports" attribute for the affected PCC rules and/or session rules to report the failure within the SmPolicyUpdateContextData data structure. Within the ErrorReport data structure, the SMF shall include the "error" attribute containing the "cause" attribute of the ProblemDetails data structure set to "UE\_STATUS\_SUSPEND" which indicates the failure to enforce the corresponding policy decision, except if the policy decision is for the PCC rule removal only and/or session rule removal only, and further include the information as follows: + +- if the policy decision includes the modification of one or more session rules, within an RuleReport instance, the SMF shall include the "sessRuleReports" attribute. Within each SessionRuleReport data structure, the SMF shall include the affected session rules within the "ruleIds" attribute, the "sessRuleFailureCode" attribute set to "UE\_STA\_SUSP" and the "ruleStatus" attribute set to ACTIVE to indicate the failure to enforce those session rules. +- if the policy decision includes the installation of one or more PCC rules, the SMF shall invoke the procedure as defined in clause 4.2.4.15 with the "failureCode" attribute set to "UE\_STA\_SUSP" and "ruleStatus" attribute set to INACTIVE to indicate the failure to enforce those PCC rules. +- if the policy decision includes the modification of one or more PCC rules, the SMF shall invoke the procedure as defined in clause 4.2.4.15 with the "failureCode" attribute set to "UE\_STA\_SUSP" and "ruleStatus" attribute set to ACTIVE to indicate the failure to enforce those PCC rules. + +Upon reception of the "failureCode" attribute and/or "sessRuleFailureCode" attribute set to "UE\_STA\_SUSP", the PCF shall not initiate any PDU Session Modification procedure, except if it is initiated for the PCC rule removal only and/or session rule removal only, for the given PDU session over N7 until the UE's status is resumed. + +#### B.3.4.2.2 UE State Change Report + +If the SMF detected the UE's status is resumed from suspend state, the SMF shall inform the PCF of the UE status including the "UE\_STATUS\_RESUME" within "repPolicyCtrlReqTriggers" attribute. The PCF shall after this update the SMF with PCC Rules or session rules if necessary. + +### B.3.4.3 UE Location related information + +When the UE handed over from the EPC/GERAN or EPC/UTRAN and the feature "2G3GIWK" is supported, or 5GS to EPC/E-UTRAN the SMF+PGW-C shall include, together with the policy control request triggers met, the following user location information: + +- If the "SAREA\_CH" or "SCELL\_CH" policy control request trigger is provisioned and met, the user location information within the "eutraLocation" attribute included in the "userLocationInfo" attribute. +- If the "SCNN\_CH" policy control request trigger is provisioned and met, the "servNfId" attribute including the S-GW identification within the "anGwAddr" attribute. + +- If the "AN\_INFO" policy control request trigger is met, the user location was requested by the PCF and provided to the SMF+PGW-C, the SMF shall provide the user location information within the "eutraLocation" attribute included in the "userLocationInfo" attribute and the time when it was last known in the 3GPP access within "userLocationInfoTime" attribute (if available). + +When the UE handed over from the EPC/E-UTRAN to the EPC/GERAN or EPC/UTRAN and the feature "2G3GIWK" is supported the SMF+PGW-C shall include, together with the policy control request triggers met, the following user location information: + +- If the "SAREA\_CH" or "SCELL\_CH" policy control request trigger is provisioned and met, the user location information within the "geraLocation" attribute or "utraLocation" attribute included in the "userLocationInfo" attribute. +- If the "SCNN\_CH" policy control request trigger is provisioned and met, the "servNfld" attribute including the SGSN identification within the "sgsnAddr" attribute. + +When the UE handed over from the 5GS to EPC non-3GPP access, the SMF+PGW-C shall include, together with the applicable provisioned policy control request triggers, the following user location information: + +- If the "SAREA\_CH" policy control request trigger is provisioned and met, and the hand over is to EPC untrusted non-3GPP access, the user location information within the "n3gaLocation" attribute included in the "userLocationInfo" attribute as specified in clause B.3.2.1. +- If the "SCNN\_CH" policy control request trigger is provisioned and met, the ePDG identification within the "anGwAddr" attribute included in the "servNfld" attribute. +- If the "AN\_INFO" policy control request trigger is met, the user location was requested by the PCF and provided to the SMF+PGW-C, the SMF shall provide the user location information within the "n3gaLocation" attribute included in the "userLocationInfo" attribute and the time when it was last known in the non-3GPP access within "userLocationInfoTime" attribute (if available). The "n3gaLocation" attribute includes the "ueIpv4Addr" or "ueIpv6Addr" attributes, and, if available the "portNumber" and "protocol" attributes and, if the feature "WLAN\_Location" is supported, the "twapId" attribute encoding the WLAN location information, if available. + +NOTE 1: The "n3gaLocation" attribute does not include the "n3gppTai" and "n3IwflId" attributes in EPC interworking scenarios. + +NOTE 2: SCELL\_CH policy control request trigger is not supported in EPC Non-3GPP access. The PCF will not receive user location information related to this trigger in this case. + +#### B.3.4.4 Presence Reporting Area Information Report + +When the UE is connected through the EPC/E-UTRAN network, the SMF+PGW-C receives the presence reporting area information as defined in 3GPP TS 29.274 [37]. When the PRA or ePRA feature is supported, the SMF+PGW-C provides presence reporting area to the PCF as specified in clause 4.2.4.16. + +If the SMF+PGW-C receives from the MME presence reporting information corresponding to the Set of Core Network predefined Presence Reporting Areas, and the individual presence reporting area as specified in 3GPP TS 29.274 [37], the SMF+PGW shall only provide the PCF with the individual presence reporting area within the "praId" attribute of the PresenceInfo data type. + +#### B.3.4.5 Access Type related information + +The SMF+PGW shall include, when the policy control request trigger "AC\_TY\_CH" is met, the following access type information: + +- If after handover the new access type is EPC/E-UTRAN: + - a) the "3GPP\_ACCESS" value within the "accessType" attribute; and + - b) the "EUTRA" value within the "ratType" attribute. +- If after handover the new access type is EPC/UTRAN and the feature "2G3GIWK" is supported: + - a) the "3GPP\_ACCESS" value within the "accessType" attribute; and + +- b) the "UTRA" value within the "ratType" attribute. +- If after handover the new access type is EPC/GERAN and the feature "2G3GIWK" is supported: + - a) the "3GPP\_ACCESS" value within the "accessType" attribute; and + - b) the "GERA" value within the "ratType" attribute. +- If after handover the new access type is EPC/ePDG: + - a) the "NON\_3GPP\_ACCESS" value within the "accessType" attribute; + - b) the "WLAN" or "VIRTUAL" value within the "ratType" attribute, as applicable; and + - c) the ePDG address in the "servNfId" attribute within the "anGwAddr" attribute. + +NOTE 1: In the interworking scenario, "AC\_TY\_CH" is met when the UE handed over from the 5GC/N3IWF or 5GC/TNAN/TWAN to the EPC/E-UTRAN, or when the UE handed over from the 5GS to the EPC/ePDG. + +The SMF+PGW shall include, when the policy control request trigger "RAT\_TY\_CH" is met, the following RAT type information: + +- If after handover the new RAT type is the E-UTRA, the "EUTRA" value within the "ratType" attribute. +- If after handover the new RAT type is the WLAN, the "WLAN" or "VIRTUAL" value within the "ratType" attribute, as applicable. + +NOTE 2: In the interworking scenario, "RAT\_TY\_CH" is met when the UE handed over from the NR to the E-UTRA or when the UE handed over from the NR to the WLAN (untrusted) and from E-UTRA to WLAN (trusted/untrusted) or from E-UTRA to N3GA. + +### B.3.4.6 Report of EPS Fallback + +When the "EPSFallbackReport" feature is supported, if the "policyCtrlReqTriggers" attribute with the value "EPS\_FALLBACK" has been provided to the SMF, the SMF shall notify to the PCF of EPS fallback when a PCC rule referred from the "lastReqRuleData" attribute required the EPS fallback report within the "reqData" attribute. + +When the SMF received a PDU session modification response from the access network indicating the establishment of the QoS flow with 5QI=1 is rejected due to EPS fallback, the SMF shall within the SmPolicyUpdateContextData data structure include: + +- the "EPS\_FALLBACK" value within the "repPolicyCtrlReqTriggers" attribute; and +- the affected PCC rules within the "pccRuleIds" attribute included in the "ruleReports" attribute, where the "ruleStatus" attribute is set to ACTIVE. + +The PCF shall identify the AF session that requested the voice media type that triggered the EPS fallback and shall notify the AF as described in clauses 4.2.5.15 of 3GPP TS 29.514 [17] or in clause E.3 of 3GPP TS 29.214 [18]. + +### B.3.4.7 MA PDU Session + +If the UE or the network does not support MA PDU Session with 3GPP access connected to EPC, when the UE handed over from the EPC/E-UTRAN to the 5GS and the MA PDU Request Indication or MA PDU Network-Upgrade Allowed Indication and ATSSS Capability are received from the UE, if the "ATSSS" feature defined in clause 5.8 is supported, the SMF shall include the "MA\_PDU" within the "repPolicyCtrlReqTriggers" attribute, and, as defined in clause 4.2.2.17, the SMF shall include the MA PDU session Indication within the "maPduInd" attribute and the ATSSS capability of the MA PDU session within the "atsssCapab" attribute. In this case, the PCF shall behave as defined in clause 4.2.2.17. + +NOTE: If the UE and the network support MA PDU Sessions with 3GPP access connected to EPC, the MA PDU Session can be simultaneously associated with user-plane resources on 3GPP access network connected to EPC and with non-3GPP access network connected to 5GC as specified in clause B.3.6.4. + +### B.3.4.8 EPS RAN NAS Cause Support + +If the RAN-NAS-Cause feature as defined in clause 5.8 is supported, and the PDN connection is established through the EPC network, the SMF shall report the RAN/NAS release cause(s) as specified in clauses 4.2.4.7, 4.2.4.12 and 4.2.4.15, with the exception that the received EPS RAN/NAS cause(s) are encoded within the "epsCause" attribute included in the RanNasRelCause data type. In this Release of the specification, the EPS release cause code information may include RAN/NAS release cause(s), a TWAN release cause or an untrusted WLAN release cause. + +### B.3.4.9 S-GW Restoration Support + +If the SGWRest feature as defined in clause 5.8 is supported, the PCF and the SMF shall comply with the procedures specified in this clause. During PDU session/PDN connection establishment or modification procedure, the PCF shall subscribe to the "SCNN\_CH" policy control request trigger if not subscribed yet, as described in clause 4.2.6.4. + +When the SMF+PGW receives the policy decision from the PCF as defined in clause 4.2.4.1 or for a PDN connection maintained during a S-GW failure for a policy decision received as defined in clause 4.2.3.1 or 4.2.4.1, the SMF+PGW shall act as follows: + +- For MME/S4-SGSN triggered S-GW Restoration scenarios: + - When the SMF receives the policy decision from the PCF as defined in clause 4.2.4.1 for a PDN connection maintained during a S-GW failure, the SMF shall include the "ruleReports" attribute for the affected PCC rules and/or the "sessRuleReports" attribute for the affected session rules to report the failure within the SmPolicyUpdateContextData data structure and further include the information as follows. + - if the policy decision is related to one or more PCC rules, the SMF+PGW shall behave as defined in clause 4.2.4.15 with the "failureCode" attribute set to "AN\_GW\_FAILED". + - if the policy decision is related to one or more session rules the SMF+PGW shall behave as defined in clause 4.2.4.21 with the "sessRuleFailureCode" attribute set to "AN\_GW\_FAILED". +- For SMF+PGW triggered S-GW Restoration scenarios, if the SMF+PGW has accepted the procedure as per normal procedures but the PDN connection is not restored during an operator configured time period, the SMF+PGW shall behave as follows when the related timer expires: + - if the policy decision is related to the PCC rule(s), the SMF+PGW shall behave as defined in clause 4.2.4.15 with the "failureCode" attribute set to "RESOURCE\_ALLOCATION\_FAILURE" + - if the policy decision is related to the session rule(s), and the "SessQoSModEnforcementFailure" feature is not supported the SMF+PGW shall behave as defined in clause 4.2.4.21 with the "sessRuleFailureCode" attribute set to "SESSION\_RESOURCE\_ALLOCATION\_FAILURE". If the "SessQoSModEnforcementFailure" feature is supported, the "sessRuleFailureCode" attribute shall be set to "DEFAULT\_QOS\_MODIFICATION\_FAILURE" or "SESSION\_AMBR\_MODIFICATION\_FAILURE" based on the failure to enforce the corresponding policy decision. + +For MME/S4-SGSN triggered S-GW Restoration scenarios, while the S-GW restoration is in progress, if the SMF+PGW sends a request towards the PCF that is triggered by a different event (e.g. internal event at SMF+PGW), the SMF+PGW shall include the "anGwStatus" attribute set to "AN\_GW\_FAILED". + +Upon reception of the "failureCode" attribute set to "AN\_GW\_FAILED" and/or the "sessRuleFailureCode" attribute set to "AN\_GW\_FAILED" or the "anGwStatus" attribute set to "AN\_GW\_FAILED", the PCF shall not initiate any SM Policy association modification procedure, except if the SM Policy association modification procedure is initiated for the PCC rule removal only, for the given SM Policy association over N7 until the S-GW has recovered. + +If the SMF+PGW indicated AN\_GW\_FAILED previously according to the procedures described above or in annex B.3.3.3, the SMF+PGW shall inform the PCF when the S-GW has recovered by including "repPolicyCtrlReqTriggers" attribute set to the "SCNN\_CH" and the "servNfId" attribute including the S-GW identification within the "anGwAddr" attribute related to the restored or new S-GW. The PCF may after this update the SMF+PGW if necessary. + +NOTE 1: The PCF could reject requests from the AF and UDR when the "cause" attribute of the ProblemDetails data structure set to "AN\_GW\_FAILED", the "failureCode" attribute set to "AN\_GW\_FAILED" and/or the "sessRuleFailureCode" attribute set to "AN\_GW\_FAILED" or the "anGwStatus" attribute set to "AN\_GW\_FAILED" is received until the "repPolicyCtrlReqTriggers" attribute set to the "SCNN\_CH" is received. + +The SMF+PGW shall maintain the PDN connections affected by the S-GW failure and eligible for restoration for an operator configurable time period. Upon expiry of that time period, the SMF+PGW shall release the PDN connection and inform the PCF about the SM Policy association termination as specified in clause 4.2.5.2. + +NOTE 2: The PCF is not aware of which PDN connections are eligible for restoration. When the SMF+PGW detects a S-GW failure, the SMF+PGW requests the PCF to terminate SM Policy associations associated to PDN connections affected by the S-GW failure and not eligible for restoration. + +The SMF+PGW should maintain the GBR bearers of the PDN connections eligible for restoration for an operator configurable time period. Upon expiry of that time period, the SMF+PGW shall release GBR bearers that have not yet been restored and inform the PCF about the PCC rule removal as specified in clause 4.2.4.7. + +The SMF+PGW shall discard downlink packets received for a PDN connection maintained during a S-GW failure that has not yet been restored. + +The SMF+PGW shall delete the PDN connection locally when it receives an SM Policy association termination from the PCF as described in clause 4.2.4.3. + +### B.3.4.10 UE initiates a resource modification support + +In the case that the UE initiates a resource allocation procedure as defined in clause 6.5.3 or UE initiates a resource modification procedure as defined in clause 6.5.4 of 3GPP TS 24.301 [52], the SMF+PGW shall within the SmPolicyUpdateContextData data structure include the "RES\_MO\_RE" within the "repPolicyCtrlReqTriggers" attribute and shall include the UE request of specific QoS handling for selected SDF within the "ueInitResReq" attribute. Within the UeInitiatedResourceRequest data structure, the SMF+PGW shall include the "ruleOp" attribute, "packFiltInfo" attribute and "reqQos" attribute if applicable as follows: + +- When the UE requests to "Create new TFT", the SMF+PGW shall include the "ruleOp" attribute set to "CREATE\_PCC\_RULE", the "packFiltInfo" attribute and "reqQos" attribute containing the requested QoS for the new PCC rule. Each PacketFilterInfo instance shall contain one packet filter provided by the UE. If the PCF authorizes the request, the PCF shall create a new PCC rule by including the new packet filters within the service data flow template of the PCC rule. +- When the UE requests to "Add packet filters to existing TFT", SMF+PGW shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_ADD\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the packet filter identifier provided by the UE and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall contain one packet filter requested for addition. If the UE request includes the modified QoS information the SMF+PGW shall also include the "reqQos" attribute to indicate the updated QoS for the affected PCC rule(s). If the PCF authorizes the request, the PCF shall update the PCC rule by adding the new packet filters to the service data flow template of the PCC rule. +- When the UE requests to "Replace packet filters in existing TFT", SMF+PGW shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_REPLACE\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the packet filter identifier provided by the UE and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall within the "packFiltId" attribute include the replaced packet filter identifier assigned by the PCF corresponding to the packet filter identifier received from the UE and one packet filter requested for addition. If the UE request includes the modified QoS information the SMF+PGW shall also include the "reqQos" attribute to indicate the updated QoS for the affected PCC rule. If the PCF authorizes the request, the PCF shall update PCC rule by replacing the existing packet filter with the new packet filter within the service data flow template of the PCC rule. +- When the UE requests to "Delete packet filters from existing TFT", SMF+PGW shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_AND\_DELETE\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the packet filter identifier provided by the UE and the "packFiltInfo" attribute. Each PacketFilterInfo instance shall within the "packFiltId" attribute include the removed packet filter identifier assigned by the PCF corresponding to the packet filter identifier received from the UE. If the UE request includes modified QoS information the SMF+PGW shall also include the "reqQos" + +attribute to indicate the updated QoS for the affected PCC rule(s). If the PCF authorizes the request, the PCF shall update PCC rule by removing the corresponding packet filters from the service data flow template of the PCC rule. + +- When the UE requests to "No TFT operation", SMF+PGW shall include the "ruleOp" attribute set to "MODIFY\_PCC\_RULE\_WITHOUT\_MODIFY\_PACKET\_FILTERS", the "pccRuleId" attribute including the PCC rule identifier corresponding the packet filter identifier provided by the UE and the modified QoS information within the "reqQos" attribute. +- When the UE requests to "Delete existing TFT", the SMF+PGW shall include the "ruleOp" attribute set to "DELETE\_PCC\_RULE", the "pccRuleId" attribute including the PCC rule identifier corresponding the packet filter identifier provided by the UE and the "packFiltInfo" attribute. The PCF shall remove the PCC rule when the PCF receives the request according to the PCC rule identifier. + +NOTE 1: The UE can only modify or delete packet filters that the UE has introduced and associated resources. The packet filter identifiers contained in the FlowInformation data structure are only used for packet filters created by the UE. + +The SMF+PGW shall calculate the requested GBR, for a GBR QCI, as the sum of the previously authorized GBR for the affected PCC rule, adjusted with the difference between the requested GBR for the EPS bearer and previously negotiated GBR for the EPS bearer. For the UE request to "Create new TFT", the GBR as requested by the UE for those filters shall be used. + +If the request covers all the PCC rules with a bearer binding to the same bearer, then the SMF+PGW may request a change to the QCI for existing packet filters. + +For the purpose of creating or modifying a packet filter, replacing and modifying packet filter, within the UeInitiatedResourceRequest instance, the SMF+PGW shall include the precedence information of the packet filter within the "precedence" attribute, and within each PacketFilterInfo instance, the SMF+PGW shall include the "packFiltCont" attribute, "tosTrafficClass" attribute, "spi" attribute, "flowLabel" attribute and "flowDirection" attribute set to the value(s) describing the packet filter provided by the UE. + +NOTE 2: The UE signalling with the network is governed by the applicable NAS signalling TS. The NAS 3GPP TS for a specific access may restrict the UE possibilities to make requests compared to what is stated above. + +If the PCF authorizes the request from the UE, the PCF shall construct a PCC rule(s) based on the UeInitiatedResourceRequest data structure. For "CREATE\_PCC\_RULE" or "MODIFY\_PCC\_RULE\_AND\_ADD\_PACKET\_FILTERS" operation, the PCF shall within the FlowInformation data structure include the assigned packet filter identifier within the "packFiltId" attribute. When the SMF+PGW derives the TFT based on the PCC rule, the SMF+PGW shall assign a new packet filter identifier for each added packet filter and keep the mapping between the packet filter identifier for the packet filter within the PCC rule and TFT sent to the UE. + +### B.3.4.11 Report of Access Charging Network Identifier + +The report of the Access Network Charging Identifier(s) is as specified in clause 4.2.4.13, with the difference that when the SMF assigns an Access Network Charging Identifier per EPS bearer/QoS flow, the SMF shall additionally include, within each AccNetChId instance, all the PCC rule identifier(s) associated to the provided Access Network Charging Identifier within the "refPccRuleIds" attribute. + +#### B.3.4.11a Detection of the SM Policy Association enabling URSP provisioning in EPS + +During UE Initial Attach with default PDN connection establishment in EPS, the UE and the SMF+PGW-C perform ePCO capability negotiation as defined in 3GPP TS 24.301 [52] to ensure that both, the network and the UE support URSP provisioning in EPS PCO. The SMF+PGW-C, when receives from the UE the Indication of URSP Provisioning Support in EPS PCO in the PDN connectivity request, and supports the feature "EpsUrsp" as defined in clause 5.8, the SMF+PGW-C shall select a PCF that supports the feature "EpsUrsp", shall create the SM Policy Association as described in clause B.3.2 and shall provide to the UE the Indication of URSP Provisioning Support in EPS PCO in the PDN Connectivity Accept message as defined in 3GPP TS 24.301 [52]. + +When the UE determines the URSP provisioning in EPS PCO is supported by the network, then the UE initiates the UE requested bearer modification procedure and includes the UE Policy Container ePCO, which will be further forwarded by the MME to the SMF+PGW-C. When the feature "EpsUrsp" is supported and the SMF+PGW-C receives the UE Policy Container ePCO, the SMF+PGW-C shall include the "UE\_POL\_CONT\_IND" within the "repPolicyCtrlReqTriggers" attribute and shall forward transparently the UE Policy Container to the PCF for the PDU session within the "uePolCon" attribute. + +The PCF for the PDU session then detects that the SM Policy Association enables the URSP provisioning in EPS and establishes a UE Policy Association with the PCF for the UE as described in 3GPP TS 29.525 [57] to transparently forward the received UE policy container. The PCF for the PDU session shall subscribe to RAT Type and/or Access-Type changes if not previously subscribed. + +To detect the 5GS to EPS handover or 5GS to EPS Idle Mode mobility (both referred as 5GS to EPS mobility with N26 in the present document) and if the "EpsUrsp" feature described in clause 5.8 is supported, the PCF for the PDU session shall subscribe to RAT Type and/or Access Type changes, if not previously subscribed. During 5GS to EPS mobility with N26, and if the "EpsUrsp" feature described in clause 5.8 is supported, the PCF for the PDU session associated with the SMF+PGW-C serving the PDN connection(s) determines whether 5GS to EPS mobility applies based on the received RAT and/or Access-Type change event. When the reported RAT and Access-Type change event indicates the UE is moving from 5GS to EPS, the PCF for the PDU session then determines that the SM Policy Association(s) enables the URSP provisioning in EPS and establishes a UE Policy Association with the PCF for the UE, if applicable, as described in 3GPP TS 29.525 [57]. + +### B.3.4.12 Reporting of UE Policy container for URSP provisioning in EPS + +When the feature "EpsUrsp" is supported and a UE policy container is received from the UE in EPC over a PDN connection, the SMF+PGW-C requests to update the SM Policy Association and provides to the PCF the received UE policy container. + +The Policy Control Request Trigger condition "UE\_POL\_CONT\_IND" is met when the SMF+PGW-C receives a UE policy container from the UE. The SMF+PGW-C shall include the "UE\_POL\_CONT\_IND" within the "repPolicyCtrlReqTriggers" attribute and shall transparently forward to the PCF the UE policy container encoded within the "uePolCont" attribute. The PCF shall transparently forward the UE policy container to the PCF for the UE in Npcf\_UEPolicyControl\_Update/Create Request as described in 3GPP TS 29.525 [57]. + +## B.3.5 Npcf\_SMPolicyControl\_Delete Service Operation + +### B.3.5.1 General + +When the UE deletes the PDN connection through the EPC network and the SMF+PGW-C shall behave as defined in clause 4.2.5.2 with the difference that the SMF+PGW-C shall include the information elements contained in the Delete Session Request message within the SmPolicyDeleteData data structure. + +NOTE: See Annex B.3.2.1 for location information. + +### B.3.5.2 EPS RAN NAS Cause Support + +If the RAN-NAS-Cause feature as defined in clause 5.8 is supported, and the PDN connection is established through the EPC network, the SMF shall report the RAN/NAS release cause(s) as specified in clause 4.2.5.4.7, with the exception that the received EPS RAN/NAS cause(s) are encoded within the "epsCause" attribute included in the RanNasRelCause data type. In this Release of the specification, the EPS release cause code information may include RAN/NAS release cause(s), a TWAN release cause or an untrusted WLAN release cause. + +## B.3.6 Provisioning and Enforcement of Policy Decisions + +### B.3.6.1 QoS mapping performed by the SMF+PGW-C + +When the UE is served by the 5GC, during PDU Session establishment and GBR QoS flow establishment, SMF+PGW-C performs EPS QoS mappings, from the 5G QoS parameters obtained from the PCF, and allocates TFT with the + +PCC rules obtained from the PCF. If a TFT is to be allocated for a downlink unidirectional EPS bearer mapped from a downlink only QoS Flow, the SMF+ PGW-C shall allocate a TFT packet filter that effectively disallows any useful uplink packet as described in clause 15.3.3.4 of 3GPP TS 23.060 [26]. The SMF+PGW-C sends the mapped QoS parameters and TFT to the UE via PCO. + +When the UE is served by the EPC, during PDN Connection establishment and dedicated bearer establishment/modification, SMF+ PGW-C performs EPS QoS mappings, from the 5G QoS parameters obtained from the PCF, and allocates TFT with the PCC rules obtained from the PCF. Other 5G QoS parameters corresponding to the PDN connection, e.g. Session-AMBR, and QoS rules and QoS Flow level QoS parameters if needed for the QoS Flow(s) associated with the QoS rule(s), are sent to UE in PCO. + +The SMF+PGW-C shall perform EPS QoS mappings as defined in clause 4.11.1.1 and Annex C in 3GPP TS 23.502 [3] as follows: + +- ignore the QNC and reflective QoS indication if received; +- for standardized 5QIs, the authorized 5QI is one to one mapped to the QCI; + +NOTE: The delay critical 5QI mapping to QCI is unspecified in the present specification. + +- for non-standardized 5QI, derive the authorized QCI based on the authorized 5QI and operator policy; +- one to one map the subscribed default QCI to the subscribed default 5QI; +- set the subscribed Session-AMBR according to operator policy (e.g. taking the value of subscribed APN-AMBR into account); and +- set the authorized APN-AMBR according to operator policy (e.g. taking the value of authorized Session-AMBR into account). + +When SMF+PGW-C is used for GERAN/UTRAN access during PDN Connection establishment, dedicated bearer establishment/modification and the feature "2G3GIWK" is supported, SMF+ PGW-C maps R99 QoS to/from EPS parameters as defined in Annex E of TS 23.401 [58]. The EPS and 5G QoS mapping is performed as defined in this clause. + +### B.3.6.2 Provisioning of Presence Reporting Area Information + +When the PRA or ePRA feature is supported, the PCF provides the SMF with Presence Reporting Area(s) information as specified in clause 4.2.6.5.6. When the UE is connected through the EPC/E-UTRAN network, the SMF+PGW-C initiates the appropriate PDN connection specific procedures specified in 3GPP TS 29.274 [37] to obtain or to deactivate the report of the presence state of a UE in a presence reporting area. + +NOTE: Homogeneous support of Presence Area reporting in EPC and 5GC networks is assumed. + +### B.3.6.3 Request and Report of Access Network information + +If the NetLoc feature as defined in clause 5.8 is supported, the PCF may request the SMF+PGW-C to report the access network information as defined in clause 4.2.6.5.4. + +If the AN\_INFO policy control request trigger is set, upon receiving the "lastReqRuleData" attribute with the "reqData" attribute with the value(s) MS\_TIME\_ZONE and/or USER\_LOC\_INFO and the "refPccRuleIds" attribute containing the PCC rule identifier(s) corresponding to the PCC rule(s) being installed, modified or removed: + +- If the "reqData" attribute indicates MS\_TIME\_ZONE and USER\_LOC\_INFO and the SMF+PGW-C determines that the access network does not support the access network information reporting, the SMF+PGW-C shall immediately inform the PCF by including the "netLocAccSupp" attribute set to "ANR\_NOT\_SUPPORTED" value in the "UeCampingRep" data structure returned in the "200 OK" response to the policy update notification request. +- If the "reqData" attribute only includes the MS\_TIME\_ZONE value and the SMF+PGW-C determines that the access network does not support the report of the UE time zone, the SMF+PGW-C shall immediately inform the PCF by including the "netLocAccSupp" attribute set to "TZR\_NOT\_SUPPORTED" value in the "UeCampingRep" data structure returned in the "200 OK" response to the policy update notification request. + +- If the "reqData" attribute only includes the USER\_LOC\_INFO value and the SMF+PGW-C determines that the access network does not support the report of the UE location, the SMF+PGW-C shall immediately inform the PCF by including the "netLocAccSupp" attribute set to "LOC\_NOT\_SUPPORTED" value in the "UeCampingRep" data structure returned in the "200 OK" response to the policy update notification request. +- If the "reqData" attribute includes the USER\_LOC\_INFO value and the MS\_TIME\_ZONE value, and the SMF+PGW-C determines the access network supports the report of UE location and/or UE time zone, the SMF+PGW-C shall apply appropriate procedures to the EPC access network to obtain the requested and supported access network information and shall report the available information as specified in clause 4.2.4.9. + +NOTE: The SMF+PGW determines whether the access network supports access network information reporting based on access type, RAT type and trusted/untrusted type of the access network. + +When the request to report access network information occurs within an EPS Fallback for IMS voice procedure, the SMF shall delay the report of access network information till the handover to EPS has been completed, as specified in 3GPP TS 23.502 [3], clause 4.13.6.1. + +### B.3.6.4 MA PDU sessions with connectivity over E-UTRAN/EPC and non-3GPP access to 5GC + +If the "EnATSSS" feature defined in clause 5.8 is supported by both the SMF and the PCF, this scenario uses the Access Traffic Steering, Switching and Splitting functionality as described in clauses 4.2.2.17, 4.2.3.21, and 4.2.4.2 with the following specifics: + +- Multi access connectivity is provided using EUTRAN/EPC as 3GPP access and non-3GPP/5GC system as non-3GPP access. +- The ATSSS rules are derived from PCC rules and provided from the PGW-C+SMF to the UE over the non-3GPP access in 5GC system. +- When the UE requests a PDN connection in EPC indicating the association with a MA PDU session, the PDN connection may be handed over to 3GPP access in 5GC without affecting the ATSSS control. + +### B.3.6.5 MA PDU sessions with connectivity over 5GC and non-3GPP access to EPC + +If the "EnATSSS\_v2" feature defined in clause 5.8 is supported by both the SMF and the PCF, this scenario uses the Access Traffic Steering, Switching and Splitting functionality as described in clauses 4.2.2.17, 4.2.3.21, and 4.2.4.2 with the following specifics: + +- Multi access connectivity is provided using 5GS as 3GPP access and ePDG/EPC system as non-3GPP access. +- The ATSSS rules are derived from PCC rules and provided from the PGW-C+SMF to the UE over the 3GPP access in 5GC system. ATSSS rules may be provided to the UE via ePDG/EPC. +- When the UE requests a PDU session in 5GS indicating the association with a MA PDU session, the PDU session may be handed over to 3GPP access in EPC without affecting the ATSSS control. + +## B.3.7 Detection and handling of late arriving requests for interworking scenario + +### B.3.7.1 Handling of requests which collide with an existing SM Policy Association + +When the UE is served by the EPC and the SMF+PGW-C receives the origination time stamp from the originating entity (see clause 13.2 of 3GPP TS 29.274 [37]) during the PDN connection establishment, the SMF+PGW-C shall include the origination time stamp parameter within 3gpp-Sbi-Origination-Timestamp header in the HTTP POST request sent to the PCF, the PCF shall perform the behaviour as defined in clause 4.2.7.1. + +### B.3.7.2 Detection and handling of requests which have timed out at the originating entity + +When the UE is served by the EPC and the SMF+PGW-C receives the origination time stamp and the maximum wait time from the originating entity (see clause 13.3 of 3GPP TS 29.274 [37]), the SMF+PGW-C shall behave as defined in annex B.3.2 with the differences that the SMF+PGW-C: + +- shall include a 3gpp-Sbi-Sender-Timestamp header set to the value of the received origination time stamp; +- shall include a 3gpp-Sbi-Max-Rsp-Time header set to the value of the received maximum wait time. + +When the PCF receives the request from the SMF+PGW-C, the PCF shall behave as defined in clause 6.11.2 of 3GPP TS 29.500 [4]. + +--- + +## Annex C (normative): Wireless and wireline convergence access support + +### C.1 Scope + +This annex defines procedures for wireless and wireline convergence access support for 5GS. The specific stage 2 definition and related procedures are contained in 3GPP TS 23.316 [42]. The System Architecture for wireless and wireline convergence access is defined in 3GPP TS 23.501 [2]. + +--- + +### C.2 Npcf\_SMPolicyControl Service + +#### C.2.1 Service Description + +##### C.2.1.1 Overview + +Clause 4.1.1 applies with the exception that the UE is replaced by the 5G-RG and the W-AGF, which is acting as a UE towards the 5GC on behalf of the FN-RG. + +##### C.2.1.2 Service Architecture + +Clause 4.1.2 applies with the exception that roaming functionality does not apply for session policy control in this Release of the specification for 5G-RG users connecting to the 5GC via W-5GAN and FN-RG users. Roaming architecture is only applicable to a 5G-RG connecting to the 5GC via NG RAN. + +The 5G-RG may support LTE access connected to EPC and EPC interworking as defined in Annex B. + +##### C.2.1.3 Network Functions + +###### C.2.1.3.1 Policy Control Function (PCF) + +The PCF functionality defined in clause 4.1.3.1 shall apply with the exceptions described in this Annex. + +###### C.2.1.3.2 NF Service Consumers + +The functionality defined in clause 4.1.3.2 shall apply. + +The enforcement of the policy decisions applies for a single access PDU session over wireline access and multiaccess PDU sessions over wireline access and 3GPP with the exceptions described in this Annex. + +## C.2.1.4 Rules + +### C.2.1.4.1 PCC Rules + +Functionality as described in clause 4.1.4.2 applies with the following exceptions for the traffic of a PDU session over wireline access: + +- UL/DL Maximum Packet Loss Rate information does not apply. +- QoS Notification Control Information does not apply. + +### C.2.1.4.2 Gate Function + +Functionality as described in clause 4.2.6.2.2 applies with the following exceptions for the traffic of a PDU session over wireline access: + +- for the IPTV service, the "mulAccCtrl" attribute within the TrafficControlData data structure to which the PCC rule refers shall be used to describe if the gate is open or closed instead of the "flowStatus" attribute. + +## C.2.1.5 Policy control request trigger + +The Policy Control Request Triggers defined in clause 5.6.3.6 and related procedures are supported for a 5G-RG connecting to the 5GC via NG-RAN. + +The Policy Control Request Triggers defined in clause 5.6.3.6 are supported for a 5G-RG or FN-RG connecting to the 5GC via W-5GAN with the following not supporting ones: + +- PLMN\_CH +- SAREA\_CH +- SCNN\_CH +- PRA\_CH +- PS\_DA\_OFF +- QOS\_NOTIF +- RES\_RELEASE +- UE\_STATUS\_RESUME +- TSN\_BRIDGE\_INFO +- QOS\_MONITORING +- SCELL\_CH +- EPS\_FALLBACK +- DDN\_FAILURE +- DDN\_DELIVERY\_STATUS +- DDN\_FAILURE\_CANCELLATION +- DDN\_DELIVERY\_STATUS\_CANCELLATION +- USER\_LOCATION\_CH +- UE\_POL\_CONT\_IND + +Consequently, the procedures related to above policy control request triggers are not supported in the corresponding service operations. + +The PS\_DA\_OFF Policy Control Request Trigger may apply for the 5G-RG connecting to the 5GC via W-5GAN (see clause 4.2.2.8 and 4.2.4.8) in an hybrid access scenario (see clause C.3.6.2). + +The RES\_MO\_RE Policy Control Request trigger is not supported for a FN-RG as described in BBF TR-456 [47] and CableLabs WR-TR-5WWC-ARCH [48] specification. + +## C.2.1.6 UE IP address support + +The UE IP address support defined in clause 4.2.8 applies with the following additions, as specified in 3GPP TS 23.316 [57]: + +- IPv6 prefix other than default /64, including individual /128 IPv6 address, for IPv6 address allocation using DHCPv6; +- More than one UE IP addresses may be assigned to a PDU session and may be received by the PCF, where the UE IP addresses may correspond, to: + - a. multiple /128 IPv6 addresses; or + - b. an /64 default prefix used for IPv6 stateless autoconfiguration and IPv6 prefix(es) shorter than the default /64 prefix for IPv6 Prefix Delegation not including the /64 IPv6 Prefix (i.e. when the total IPv6 address space available for the PDU session cannot be aggregated into one single IPv6 prefix). + +--- + +## C.3 Service Operation + +### C.3.1 Introduction + +Clause 4.2.1 applies. + +### C.3.2 Npcf\_SMPolicyControl\_Create Service Operation + +#### C.3.2.1 General + +Clause 4.2.2.2 is applied with the following differences: + +- The allocated /128 IPv6 address or IPv6 /64 prefix or IPv6 prefix shorter than /64 is included within the "ipv6AddressPrefix" attribute. +- Request of Presence Reporting Area Change Report is not applicable when the 5G-RG or FN-RG connects to the 5GC via W-5GAN. +- Global Line ID including the line Id and either PLMN Id or operator Id is encoded within the "gli" attribute of the "n3gaLocation" attribute included in the "userLoc" attribute within the PolicyAssociationRequest data structure when the 5G-RG or FN-RG registers via W-5GBAN. +- The HFC Node Identifier is encoded in the "hfcNodeId" attribute of the "n3gaLocation" attribute included in the "userLocationInfo" attribute within the SmPolicyContextData data structure when the 5G-CRG or FN-CRG connects to the 5GC via W-5GCAN. +- The PEI that may be included within the "pei" attribute shall have one of the following representations: + - i. When the UE supports only wireline access, the PEI shall be a MAC address. + +NOTE: When the PEI includes an indication that the MAC address cannot be used as Equipment identifier, the PEI cannot be trusted for regulatory purposes and cannot be used for equipment based policy evaluation. + +- ii. When the UE supports at least one 3GPP access technology, the PEI shall be the allocated IMEI or IMEISV. + +- To support of Hybrid Access for a 5G-RG with a single PDU session as described in clause C.3.6.2.2, EPC interworking specific attributes and procedures apply as described in clause B.3.2; +- Access Traffic Steering, Switching and Splitting as defined in clause 4.2.2.17 is only applicable to the case that the 5G-RG establishes: + - a) Hybrid Access with a multi-access PDU Session connectivity via NG-RAN and W-5GAN, as described in clause C.3.6.2.3; or + - b) Hybrid Access with a multi-access PDU Session connectivity via EPC/E-UTRAN and W-5GAN, as described in clause C.3.6.2.4. +- The access network transmission technology for the wireline access may be encoded: + - i. within the "ratType" attribute of the SmPolicyContextData type; or + - ii. when Access Traffic Steering, Switching and Splitting is supported, within the "ratType" attribute of the SmPolicyContextData type, or within the "ratType" attribute of the AdditionalAccessInfo type. + +### C.3.2.2 IPTV service support + +If the PCF fetches the Multicast Access Control information from the UDR as defined in 3GPP TS 29.519 [15], the PCF shall authorize a PCC rule as defined in Annex C.3.6.1 and provision it to the SMF in the HTTP response message. + +## C.3.3 Npcf\_SMPolicyControl\_UpdateNotify Service Operation + +### C.3.3.1 General + +The descriptions in clause 4.2.3.1 are applied with the following differences: + +- To support Hybrid Access for a 5G-RG with a single PDU session as described in clause C.3.6.2.2, EPC interworking specific attributes and procedures apply as described in B.3.3; +- Access traffic steering, switching and splitting support as described in clause 4.2.3.21 is only applicable to the case that 5G-RG establishes: + - a) Hybrid Access with a multi-access PDU Session connectivity via NG-RAN and W-5GAN, as described in clause C.3.6.2.3; or + - b) Hybrid Access with a multi-access PDU Session connectivity via EPC/E-UTRAN and W-5GAN, as described in clause C.3.6.2.4. +- Request for the result of PCC rule removal is not applicable when the 5G-RG or FN-RG connects to the 5GC via W-5GAN. + +### C.3.3.2 IPTV service support + +If the PCF fetches the Multicast Access Control information from the UDR as defined in 3GPP TS 29.519 [15], for each impacted PDU session, the PCF shall authorize a PCC rule as defined in Annex C.3.6.1 and provision it to the SMF in the HTTP POST message. + +## C.3.4 Npcf\_SMPolicyControl\_Update Service Operation + +### C.3.4.1 General + +Clause 4.2.4.2 is applied with the following differences: + +- The released /128 IPv6 address or IPv6 /64 prefix or IPv6 prefix shorter than /64 is included within the "relIpv6AddressPrefix" attribute. + +- If the feature "MultiIpv6AddrPrefix" is supported, the additionally allocated IPv6 prefix may be included within the "addIpv6AddrPrefixes" attribute and the additional released IPv6 prefix may be included within the "addRelIpv6AddrPrefixes" attribute. If the "UnlimitedMultiIpv6Prefix" feature is supported, and if multiple allocated or released IPv6 prefixes are detected, the NF service consumer shall include the new allocated UE IPv6 prefixes within the "multiIpv6Prefixes" attribute and the released UE IPv6 prefixes within the "mutliRelIpv6Prefixes" attribute. +- RAN cause and/or the NAS cause information is not applicable when the 5G-RG or FN-RG connects the 5GC via W-5GAN. +- To support Hybrid Access for a 5G-RG with a single PDU session as described in clause C.3.6.2.2, EPC interworking specific attributes and procedures apply as described in B.3.4; +- When the report of access network information described in clause 4.2.4.9 includes the user location information, the "n3gaLocation" attribute shall be included in the "userLocationInfo" attribute and: + - a) if the UE connects via W-5GBAN access: + - Global Line Identifier shall be encoded in the "gli" attribute; and + - the "w5gbanLineType" attribute to indicate whether the W-5GBAN access is DSL or PON may be included; or + - b) if the UE connects via W-5GCAN access, the HFC Node Identifier shall be encoded in the "hfcNodeId" attribute. +- Access traffic steering, switching and splitting support as described in clause 4.2.4.25 is only applicable to the case that 5G-RG establishes: + - a) Hybrid Access with a multi-access PDU Session connectivity via NG-RAN and W-5GAN, as described in clause C.3.6.2.3; or + - b) Hybrid Access with a multi-access PDU Session connectivity via EPC/E-UTRAN and W-5GAN, as described in clause C.3.6.2.4. +- The access network transmission technology for the wireline access may be encoded: + - i. within the "ratType" attribute of the SmPolicyUpdateContextData type; or + - ii. when Access Traffic Steering, Switching and Splitting is supported, within the "ratType" attribute of the SmPolicyContextUpdateData type, or within the "ratType" attribute of the AdditionalAccessInfo type. + +### C.3.4.2 IPTV service support + +If the "WWC" feature is supported and "5G\_RG\_JOIN" and/or "5G\_RG\_LEAVE" are provisioned and when the SMF detects a 5G-RG has joined or left to an IP Multicast Group, the SMF shall send an HTTP POST message as defined in clause 4.2.4.2 and include the "5G\_RG\_JOIN" or "5G\_RG\_LEAVE" within the "repPolicyCtrlReqTriggers" attribute respectively and the received one or more IP multicast addressing information within the "mulAddrInfos" attribute. Within each IpMulticastAddressInfo data structure, the SMF shall include the destination IPv4 multicast address of the DL multicast flow within the "ipv4MulAddr" attribute and the source IPv4 address of the DL multicast flow within the "srcIpv4Addr" attribute if available or the destination IPv6 multicast address of the DL multicast flow within the "ipv6MulAddr" attribute and the source IPv6 address of the DL multicast flow within the "srcIpv6Addr" attribute if available. + +NOTE: The corresponding notification can be used by the PCF to manage Preview Rights related with an IP multicast flow corresponding to an IPTV channel by provisioning the corresponding PCC rule. In this case the PCF is responsible to remove the provisioned PCC rule when the preview duration has elapsed. + +## C.3.5 Npcf\_SMPolicyControl\_Delete Service Operation + +### C.3.5.1 General + +Clause 4.2.5.1 is applied with the following differences and limitations: + +- the "n3gaLocation" attribute shall be included in the "userLocationInfo" attribute and: + - a) if the UE connects via W-5GBAN access: + - Global Line Identifier shall be encoded in the "gli" attribute; and + - the "w5gbnLineType" attribute to indicate whether the W-5GBAN access is DSL or PON may be included; or + - b) if the UE connects via W-5GCAN access, + - the HFC Node Identifier shall be encoded in the "hfcNodeId" attribute; and + - the Global Cable Identifier may be encoded within the "gci" attribute. +- RAN cause and/or the NAS cause information is not applicable when the 5G-RG or FN-RG connects the 5GC via W-5GAN. + +## C.3.6 Provisioning and Enforcement of Policy Decisions + +### C.3.6.0 General + +Clause 4.2.6 applies with the following exceptions for the traffic of a PDU session over wireline access: + +- Policy provisioning and enforcement of authorized QoS per service data flow as described in clause 4.2.6.6.2 applies with the following differences: + - a) Determination of Maximum Packet Loss Rate for UL/DL does not apply. + - b) PCF does not request a notification when authorized GBR or delay critical GBR cannot be guaranteed or can be guaranteed again, i.e. "qnc" attribute does not apply. +- Provisioning of PCC Rules for Multimedia Priority Services is not supported. Clause 4.2.6.2.12 does not apply. +- Provisioning of PCC Rules for Mission Critical Services is not supported. Clause 4.2.6.2.19 does not apply. + +### C.3.6.1 IPTV service support + +If the "WWC" feature is supported by the SMF and PCF as defined in clause 5.8, when the PCF fetches the Multicast Access Control information from the UDR as defined in 3GPP TS 29.519 [15] applicable for a SUPI or Internal Group Id during the PDU session establishment or receives the notification of the Multicast Access Control information from the UDR as defined in 3GPP TS 29.519 [15] applicable for a SUPI(s) and/or Internal Group Id(s) and/or DNN/S-NSSAI combination(s) during the PDU session modification, the PCF authorizes the Multicast Access Control information. For each impacted PDU Session that corresponds to the Multicast Access Control information, the PCF shall determine the PCC rule(s) that are generated based on the Multicast Access Control information as follows: + +- for the multicast channel(s) which is allowed indicated in the Multicast Access Control information, the PCF shall include the corresponding multicast address(es) within the "flowInfos" attribute of the PCC rule and include the "mulAccCtrl" attribute set to "ALLOWED" within a Traffic Control Data instance which the PCC rule refers to. +- for the multicast channel(s) which is not allowed indicated in the Multicast Access Control information, the PCF shall include the corresponding multicast address(es) within the "flowInfos" attribute of the PCC rule and include the "mulAccCtrl" attribute set to "NOT\_ALLOWED" within a Traffic Control Data instance which the PCC rule refers to. + +NOTE 1: The "flowStatus" attribute is not included in this Traffic Control Data instance. The gate function is not applicable to IPTV service, and the control is done with the "mulAccCtrl" attribute. + +NOTE 2: Separate PCC Rules are used to convey the information related to allowed and not allowed multicast channel(s). + +## C.3.6.2 Hybrid Access support + +### C.3.6.2.1 General + +This clause specifies the support of policy control for Hybrid Access considering both, the support of single access PDU sessions and MA PDU sessions. + +Hybrid Access applies to a 5G-RG capable of connecting to: + +- both, NG-RAN and wireline access; and/or +- both, wireline access and EPC/E-UTRAN using EPC interworking as described in Annex B. + +Hybrid Access does not apply to FN-RG. + +### C.3.6.2.2 Hybrid Access with single PDU session + +Hybrid Access scenarios with single PDU sessions shall only use one of the two accesses, but the PDU session can be handover over between the two accesses. + +When the "WWC" feature is supported by the SMF and the PCF as defined in clause 5.8: + +- for a 5G-RG capable of connecting to the NG-RAN and the wireline access, the procedures specified in the main body of this specification apply, except: + - i. the UE is replaced by the 5G-RG; and + - ii. the non-3GPP access is replaced by the wireline access, as specified in this annex; +- for a 5G-RG capable of connecting to the wireline access and the EPC/E-UTRAN access, the procedures specified in the Annex B of this specification apply, except: + - i. the UE is replaced by the 5G-RG; and + - ii. the non-3GPP access is replaced by the wireline access. + +### C.3.6.2.3 Hybrid Access with MA PDU session connectivity over NG-RAN and wireline + +If the "WWC" and the "ATSSS" features are supported by the SMF and the PCF as defined in clause 5.8, this scenario uses the Access Traffic Steering, Switching and Splitting functionality as described in clauses 4.2.2.17, 4.2.3.21, and 4.2.4.25.8 with the following differences: + +- UE is replaced by 5G-RG. +- Non-3GPP access(es) is replaced by wireline access. + +### C.3.6.2.4 Hybrid Access with MA PDU session connectivity over EPC/E-UTRAN and wireline using EPC interworking scenarios + +If the "WWC" and the "ATSSS" features are supported by the SMF and the PCF as defined in clause 5.8, this scenario uses the Access Traffic Steering, Switching and Splitting functionality as described in clauses 4.2.2.17, 4.2.3.21, and 4.2.4.2 with the following specifics: + +- UE is replaced by 5G-RG. +- Non-3GPP access(es) is replaced by wireline access. + +- Multi access connectivity is provided using ATSSS using both, EPC (as 3GPP access) and wireline access/5GC system (as non-3GPP access), where: + - i. the ATSSS rules are derived from PCC rules and provided from the PGW-C+SMF to the 5G-RG over wireline access/5GC system; + - ii. when the 5G-RG requests a PDN connection in EPC indicating the association with a MA PDU session, the PDN connection may be handed over to 3GPP access in 5GC without affecting the ATSSS control. +- MA PDU Sessions of Ethernet PDU Session type where the 3GPP access corresponds to EPC/E-UTRAN are not applicable for 5G-RG. + +### C.3.6.3 Location Dependent Policies for trusted non-3GPP access + +To support location dependent policies when a UE connects using trusted non-3GPP access procedures via TNAP collocated with a 5G-RG, the PCF may retrieve/be notified by the UDR of the AF provided list of TNAP(s) in Service Parameter Data and/or the list of TNAP(s) provided within Session Management Policy Data as defined in 3GPP TS 29.519 [15]. In this case, the PCF may compare the TNAP ID(s) received from the UDR with the TNAP ID received in the user location information (if available) and may apply different policies depending on whether the UE is at a TNAP ID obtained from UDR or not. In case the PCF receives from the UDR TNAP ID(s) both in the Policy Data and in the Service Parameter Data, the PCF decides based on configuration whether to apply both or one of them. + +--- + +## Annex D(informative): Change history + +| Change history | | | | | | | | +|-----------------------|----------------|-------------|-----------|------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Session Management Policy Control Services specification | 0.0.0 | +| 2017-10 | CT3#92 | | | | | Inclusion of C3-175237, C3-175353 and editorial changes from Rapporteur | 0.1.0 | +| 2017-12 | CT3#93 | | | | | Inclusion of C3-176145, C3-176248, C3-176252, C3-176254, C3-176255, C3-176256, C3-176257, C3-176319, C3-176320, C3-176321, C3-176322, C3-176323 and editorial changes from Rapporteur | 0.2.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of C3-180035, C3-180198, C3-180097, C3-180342, C3-180303, C3-180343, C3-180202, C3-180305, C3-180307, C3-180308, C3-180306, C3-180309, C3-180310, C3-1801311, C3-180312 | 0.3.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of C3-181355, C3-181345, C3-181222, C3-181223, C3-181226, C3-181227 | 0.4.0 | +| 2018-04 | CT3#96 | C3-182515 | | | | Inclusion of C3-182056, C3-182318, C3-182322, C3-182463, C3-182325, C3-182327, C3-182330, C3-182331, C3-182132, C3-182332, C3-182324, C3-182482. | 0.5.0 | +| 2018-05 | CT3#97 | C3-183868 | | | | Inclusion of C3-183811, C3-183889, C3-183748, C3-183749, C3-183845, C3-183461, C3-183846, C3-183847, C3-183884, C3-183850, C3-183851, C3-183852, C3-183853, C3-183470, C3-183855, C3-183854, C3-183760, C3-183885, C3-183736, C3-183848, C3-183857, C3-183858, C3-183765, C3-183766, C3-183486, C3-183886, C3-183859, C3-183887, C3-183488, C3-183489, C3-183888, C3-183815, C3-183769, C3-183793, C3-183816, C3-183763, C3-183509, C3-183865, C3-183866, C3-183771, C3-183867, C3-183772, C3-183818, C3-183255, C3-183868, C3-183284 | 0.6.0 | +| 2018-06 | CT#80 | CP-181036 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181036 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 5 | F | Updates for TS 29.512 structure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 4 | F | Update of Npcf_SMPolicyControl_Create Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 5 | F | Update of Npcf_SMPolicyControl_UpdateNotify Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 3 | F | Update of Npcf_SMPolicyControl_Update Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 4 | F | Update of Npcf_SMPolicyControl_Delete Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 5 | F | Multi-homing support | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 2 | F | Access Network Charging Identifier request and report | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | 3 | F | Request result of PCC rule removal | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 3 | F | Request the successful resource allocation notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182168 | 0010 | 6 | F | HTTP error handling procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182169 | 0011 | 7 | F | PCC Rule Error Handling | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0012 | 2 | F | Failure cases of Npcf_SMPolicyControl_Create Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0013 | 5 | F | Failure cases of Npcf_SMPolicyControl_UpdateNotify Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0014 | 2 | F | Failure cases of Npcf_SMPolicyControl_Update Service Operation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0015 | 1 | F | Update of PCF and SMF function descriptions | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0016 | 3 | F | Rules, Session rules, PCC rules definition updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0017 | 2 | F | Policy Decision types Updates | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0018 | 4 | F | Policy control request trigger definition update | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0019 | 2 | F | Conditioned PCC rule update | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0020 | 2 | F | Conditioned session rule update | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0021 | 2 | F | IMS restoration support | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0022 | 9 | F | PRA support | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0023 | 5 | F | Update of steering the traffic to a local access of the data network | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0024 | 2 | F | Support for Ethernet PDU type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0025 | 6 | F | Update of Provisioning of charging related information for PDU session | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0026 | 4 | F | UE requests specific QoS handling for selected SDF | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0027 | 6 | F | Provisioning of IP index information | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0028 | 1 | F | Update of Multimedia Priority Services | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0029 | 3 | F | Exclude the traffic from the session level usage monitoring | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0030 | 3 | F | Provisioning of specific QoS parameters together with 5QI | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0031 | 1 | F | Add Unspecified value to the FlowDirection data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0032 | 2 | F | Completion of definitions of UsageMonitoringData and AccuUsageReport | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0033 | 4 | F | Definition of FlowStatus data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0034 | 1 | F | Definition of RedirectAddressType data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0035 | 1 | F | Mandate the TrafficControlData decision | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0036 | 2 | F | Reflective QoS support | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0037 | 1 | F | Remove the DELETE method | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0038 | 1 | F | Remove the Packet Loss Rate from the QoS characteristics | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2018-09 | CT#81 | CP-182015 | 0039 | 1 | F | Re-use the ARP data type from 29.571 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0043 | 1 | F | Definition of DNAI | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0044 | 1 | F | Completion of ConditionData | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0045 | 1 | F | Completion of TrafficControlData data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182023 | 0046 | 1 | B | Trace activation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0047 | 2 | F | Corrections on the notification URIs defined for the UpdateNotify | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0048 | 4 | F | Corrections on attributes and data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0049 | | F | Corrections on Supported Features | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0050 | 1 | F | Update custom operation for Npcf_SMPolicyControl_Update | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0051 | | F | Missing Slice Information | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0052 | 1 | F | Solution to IPv4 overlapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0053 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182104 | 0054 | 1 | B | Support of PCC rule versioning | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0055 | 1 | F | Update of Sponsored data connectivity support | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0056 | 1 | F | Update of resource structure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0057 | 1 | F | Correction on cardinality of array and map | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0058 | | F | Update of PccRule data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0059 | 1 | F | Open issues on Reused data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0060 | | F | DNAI report | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0061 | | F | Definition of maxPacketLossRate | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0063 | 6 | F | Correction to the AF influence traffic steering control | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0064 | 2 | F | Some corrections to the OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0065 | 3 | F | Background data transfer support | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0066 | 4 | F | Clarification of default QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0067 | 3 | F | Clarification of Maximum Packet Loss Rate authorization | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0068 | 1 | F | Clarification of PCC rule enforcement | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0069 | | F | Clarification of service data flow template | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0070 | | F | Correction to name of maximumDataBurstVolume attribute | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0071 | 1 | F | Correction to the QoS notification control authorization | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0072 | 3 | F | IMS dedicated signalling QoS flow | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0073 | 2 | F | Internal Group Id during the PDU session establishment | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0074 | 3 | F | Number of packet filters sent to the UE | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0075 | 2 | F | Packet filter identifier | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0076 | 1 | F | Remove two values of policy control request triggers in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0077 | 1 | F | SM policy association termination | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0078 | 3 | F | The procedure of QoS notification control | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0079 | 4 | F | Architecture of 5GS and EPS interworking scenario support | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0083 | 2 | F | QoS mapping in 5GS and EPS interworking scenario | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0084 | | F | PCC Rules for MPS | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0086 | 2 | F | ExternalDocs field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0089 | 1 | F | Correction of SMPolicyControl resource URI structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0089 | 2 | F | Correction of SMPolicyControl resource URI structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0090 | 1 | F | Definition on map keys in SmPolicyDecision | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0091 | 1 | F | Security field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0092 | 1 | F | Correction of datatypes related to QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0093 | 1 | F | Correction of 404 error information | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0094 | | F | Correction of API name | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0095 | 1 | F | Corrections of external references in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0096 | 4 | F | Corrections on IP index provisioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0097 | 1 | F | Corrections misused data types, attributes and error definitions | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0098 | 2 | F | Application Error POLICY_CONTEXT_DENIED | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0099 | 2 | F | Corrections on RAN-NAS-Cause feature | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0100 | 1 | F | Missing Policy Control Request trigger for RAT Type Change | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0101 | 2 | F | Corrections on rule versioning | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0102 | 1 | F | Corrections for Npcf_SMPolicyControl_UpdateNotify service operation. | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0103 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0104 | 1 | F | Correction to RAN-NAS-Cause feature | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0105 | 1 | F | a new PolicyControlRequestTrigger for refQosIndication | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0106 | 1 | F | PCC rule error report triggerconvention | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0108 | 1 | F | Missing SponsoredConnectivity feature | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0109 | 2 | F | Correct DNAI change type in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0110 | 3 | F | Selection of Predefined PCC Rule Base | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0111 | 3 | F | Correction to treatment of subscribed default QoS and authorized default QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183123 | 0113 | 1 | F | Address attribute for the network entity performing charging | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0115 | 1 | F | Status code update for Npcf_SMPolicyControl API | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0116 | 1 | F | CHF discovery and selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0117 | 1 | F | Condition Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0119 | | F | Correction to authDefaultQos attribute | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0120 | 1 | F | Correction to error handling | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183205 | 0121 | | F | Correction to Partial Success handling | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0122 | 2 | F | Correction to precedence of the PCC rule | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0123 | 2 | F | Correction to pre-defined PCC rule activation | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0124 | - | F | Correction to the terminology of QoS notification control | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0125 | 1 | F | Correction to the general descriptions of Provisioning and Enforcement of Policy Decisions | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0126 | 3 | F | Correction to the PCC rule definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0128 | 1 | F | Correction to the policy decision data definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0129 | 1 | F | Correction to the resource URI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0130 | | F | Correction to the RuleReport data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0131 | 1 | F | Delay critical GBR resource type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0132 | 1 | F | Correction to the specific data type table | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0133 | 1 | F | HTTP custom headers | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0134 | 1 | F | Inactivity timer for emergency session | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0135 | 1 | F | Provisioning and deletion of the policy decision data | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0136 | 1 | F | QoS authorization for the emergency service | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0137 | 1 | F | Reference number alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0138 | | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0140 | 2 | F | Adding "nullable" property to data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0141 | 2 | F | VolumeRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0142 | | F | Re-use PresenceInfoRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0143 | 1 | F | Re-use PacketLossRateRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0144 | 1 | F | Re-use MaxDataBurstVolRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0145 | | F | Re-use DurationSecRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0146 | | F | Re-use DateTimeRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0147 | | F | Re-use BitRateRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0148 | | F | Re-use AverWindowRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0150 | | F | Re-use 5QIPriorityLevelRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0151 | | F | FlowDirectionRm data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0152 | 1 | F | Correction to TrafficControlData data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0153 | 1 | F | Correction to the redirect function | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0154 | | F | Correction to the modification of an attribute with a value of type map | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0155 | 3 | F | Correction to SmPolicyDecision data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0157 | 1 | F | Correction to request rule data and request usage data | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0158 | 1 | F | Correction to QosData data structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0159 | 2 | F | Correction to Qos Characteristics | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0160 | 1 | F | Correction to PccRule data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0161 | | F | Correction to FlowInformation data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0162 | 1 | F | Correction to ChargingData data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0163 | | F | Correct the minProperties of the attributes | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0164 | 1 | F | Correct the minItems of the attributes | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0166 | 1 | F | delete UsageMonitoring in pccRule | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0167 | | F | rename the heading | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0168 | | F | incorrect description of online and offline | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0169 | | F | Location header | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0170 | 1 | F | API Version Update | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0172 | | F | Corrections to OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0173 | 1 | F | Corrections of user location and session AMBR attributes | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0174 | 1 | F | Common data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0176 | 2 | F | Presence Info removal | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0177 | 2 | F | Correction of SmPolicyUpdateContext data type in OpenAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190111 | 0178 | 1 | F | The SMF may allow traffic to start before quota management for online charging | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0179 | 1 | F | Correction of application error codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0180 | | F | Corrections to qosDecs attribute | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0182 | | F | PCF resource cleanup | 15.3.0 | +| 2019-03 | CT#83 | CP-190135 | 0183 | 1 | F | Corrections on Traffic Steering Control | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0184 | 2 | F | Control of QoS parameters for default QoS Flow | 15.3.0 | +| 2019-03 | CT#83 | CP-190157 | 0185 | 1 | F | Correction to UE initiates a resource modification support | 15.3.0 | +| 2019-03 | CT#83 | CP-190136 | 0186 | 1 | F | Completion of the QoS control notification | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0187 | 1 | F | Correction to credit management session failure | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0188 | 1 | F | Correction to OpenAPI file | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0189 | 1 | F | Correction to Provisioning of Default Charging Method | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0191 | 1 | F | Correction to the access network information reporting | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0192 | | F | Correction to the ARP | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0193 | 1 | F | Correction to the QoS data decision | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0194 | 2 | F | Correction to the QoS mapping performed by the SMF+PGW-C | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0195 | 2 | F | Correction to the SmPolicyDecision data type | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0197 | 2 | F | Correction to number of supported Packet Filters for signalled QoS rules | 15.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------|--------| +| 2019-03 | CT#83 | CP-190111 | 0198 | 1 | F | PCC rule enforcement | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0199 | 2 | F | Policy Update When UE suspends | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0200 | 1 | F | Correction to the QoS characteristics | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0201 | 1 | F | Remove two values of failure codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0205 | 1 | F | Alignment of attributes | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0206 | 2 | F | HTTP response code 204 for QoS Notification | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0208 | 1 | F | Corrections on Charging Characteristics | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0209 | | F | Correction on Provisioning of Charging Address | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0210 | 1 | F | Corrections for Location Change Policy Control Request Triggers | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0211 | 1 | F | AC_TY_CH related information | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0212 | | F | Time Zone Change Policy Control Request Trigger | 15.3.0 | +| 2019-03 | CT#83 | CP-190111 | 0213 | | F | Corrections on Reflective QoS | 15.3.0 | +| 2019-03 | CT#83 | CP-190167 | 0216 | | F | OpenAPI version number update | 15.3.0 | +| 2019-03 | CT#83 | CP-190121 | 0203 | 2 | B | Access Type conditioned Session-AMBR | 16.0.0 | +| 2019-03 | CT#83 | CP-190121 | 0207 | 1 | B | Multiple IPv6 prefixes allocated or released in PolicyUpdate request | 16.0.0 | +| 2019-03 | CT#83 | CP-190121 | 0215 | | F | OpenAPI version number update | 16.0.0 | +| 2019-06 | CT#84 | CP-191072 | 0218 | 2 | A | Correction of PCC rule base activation | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0220 | 1 | A | Corrections in main body of the specification | 16.1.0 | +| 2019-06 | CT#84 | CP-191089 | 0222 | 2 | B | DN Authorization for Policy Control | 16.1.0 | +| 2019-06 | CT#84 | CP-191087 | 0223 | 1 | B | General description for the support for traffic switching, steering and splitting | 16.1.0 | +| 2019-06 | CT#84 | CP-191087 | 0225 | 1 | B | Session Rule support for traffic switching, steering and splitting | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0227 | 3 | A | Correction to 5GS-EPS interworking support | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0229 | 1 | A | Correction to FlowInformation and rule versioning support | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0231 | 2 | A | Correction to PacketErrRate data type | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0233 | | A | Correction to PartialSuccessReport | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0237 | 2 | A | Correction to the PCC bound to the default QoS flow | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0241 | 1 | A | MBR of Non-GBR type 5QI | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0243 | 3 | A | Precedence of PCC rule | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0245 | 4 | A | Session Rule error handling | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0247 | 2 | A | Usage limitation of the time-conditioned PCC rule | 16.1.0 | +| 2019-06 | CT#84 | CP-191089 | 0248 | 2 | B | Multiple IPv6 prefixes report for Multi-homing support | 16.1.0 | +| 2019-06 | CT#84 | CP-191087 | 0249 | 4 | B | PCC support for traffic switching, steering and splitting | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0254 | 1 | A | Miscellaneous corrections | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0256 | 3 | A | Correction to Npcf_SMPolicyControl_UpdateNotify service operation | 16.1.0 | +| 2019-06 | CT#84 | CP-191089 | 0257 | 1 | F | Update the redirection server address to support dual stack UE | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0262 | | A | Precedence of OpenAPI file | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0263 | 1 | A | Deprecating API version | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0264 | 2 | B | AF acknowledgement to be expected | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0265 | 2 | B | UE IP address preservation indication | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0269 | 1 | A | Corrections to conditioned PCC rule | 16.1.0 | +| 2019-06 | CT#84 | CP-191089 | 0273 | 2 | F | Correction to IPv6 Multihoming support | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0275 | | A | Correction of RuleReport type | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0283 | 1 | A | Correction to access network information report | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0285 | 1 | A | Correction to FailureCode data type | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0291 | 1 | A | Correction to UE_STATUS_RESUME | 16.1.0 | +| 2019-06 | CT#84 | CP-191089 | 0293 | 1 | B | Race condition handling | 16.1.0 | +| 2019-06 | CT#84 | CP-191085 | 0294 | 1 | B | Npcf_SMPolicyControl service extension of 5WVVC | 16.1.0 | +| 2019-06 | CT#84 | CP-191072 | 0296 | 1 | F | Copyright Note in YAML file | 16.1.0 | +| 2019-06 | CT#84 | CP-191101 | 0298 | 1 | F | API version update | 16.1.0 | +| 2019-09 | CT#85 | CP-192167 | 0302 | 1 | B | Handling of requests colliding with an existing context | 16.2.0 | +| 2019-09 | CT#85 | CP-192178 | 0303 | 1 | B | Adding NID as input for policy decisions | 16.2.0 | +| 2019-09 | CT#85 | CP-192156 | 0304 | 1 | B | Support a set of MAC addresses in traffic filter | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0305 | 1 | B | Support of IMS restoration | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0306 | 1 | B | Support of Npcf_PolicyAuthorization invocation of priority sharing | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0308 | 2 | A | Correction to Resource Sharing | 16.2.0 | +| 2019-09 | CT#85 | CP-192176 | 0311 | 1 | B | Support of wireline and wireless access convergence, NFs | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0313 | | A | Correction to appReloc attribute | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0315 | 1 | A | Correction to GBR type default QoS flow | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0317 | 1 | A | Correction to interworking between the 5GC and EPC | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0319 | 2 | A | Correction to serving node change | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0323 | 1 | A | Correction to UE requested resource modification | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0325 | | A | Include ipDomain within SmPolicyUpdateContextData data type | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0327 | 1 | A | Correction to Usage Monitoring Control | 16.2.0 | +| 2019-09 | CT#85 | CP-192142 | 0329 | 1 | A | Packet filters for reflective QoS | 16.2.0 | +| 2019-09 | CT#85 | CP-192153 | 0330 | | B | PCC rule attribute correction for ATSSS | 16.2.0 | +| 2019-09 | CT#85 | CP-192156 | 0331 | | B | Correction to time conditioned PCC rule | 16.2.0 | +| 2019-09 | CT#85 | CP-192152 | 0333 | 1 | B | Npcf_SMPolicyControl_Create Service Operation Update of 5WVVC Correction to time conditioned PCC rule | 16.2.0 | +| 2019-09 | CT#85 | CP-192152 | 0334 | 1 | B | Npcf_SMPolicyControl_UpdateNotify Service Operation Update of 5WVVC | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2019-09 | CT#85 | CP-192152 | 0335 | 1 | B | Npcf_SMPolicyControl_Update Service Operation Update of 5WVC | 16.2.0 | +| 2019-09 | CT#85 | CP-192152 | 0336 | 1 | B | Npcf_SMPolicyControl_Delete Service Operation Update of 5WVC | 16.2.0 | +| 2019-09 | CT#85 | CP-192152 | 0337 | 2 | B | IPTV support | 16.2.0 | +| 2019-09 | CT#85 | CP-192175 | 0338 | 2 | B | QoS Monitoring support for URLLC | 16.2.0 | +| 2019-09 | CT#85 | CP-192171 | 0339 | 2 | B | PCC rule decision enhancement for supporting xBDT | 16.2.0 | +| 2019-09 | CT#85 | CP-192173 | 0341 | | B | OpenAPI version update TS 29.512 R-16 | 16.2.0 | +| 2019-12 | CT#86 | CP-193213 | 0345 | 2 | F | Increasing the maximum MDBV value | 16.3.0 | +| 2019-12 | CT#86 | CP-193181 | 0346 | 1 | B | Open issue for AddrPreservation feature | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0349 | 1 | A | Correction to the usage monitoring control | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0351 | 2 | A | Correction to the traffic steering control | 16.3.0 | +| 2019-12 | CT#86 | CP-193193 | 0352 | 2 | B | Usage Monitoring Control for ATSSS | 16.3.0 | +| 2019-12 | CT#86 | CP-193210 | 0353 | 1 | B | Correction to handling of requests colliding with an existing context | 16.3.0 | +| 2019-12 | CT#86 | CP-193223 | 0354 | 1 | B | Multiple BDT Policies | 16.3.0 | +| 2019-12 | CT#86 | CP-193223 | 0355 | 5 | B | New cause value of association termination for xBDT | 16.3.0 | +| 2019-12 | CT#86 | CP-193202 | 0356 | 6 | B | QoS Handling for V2X Communication | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0358 | 4 | B | Serving 4G only UEs by SMF+PGW-C | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0359 | | B | Add reference of 29.514 | 16.3.0 | +| 2019-12 | CT#86 | CP-193181 | 0360 | 1 | B | Report frequency of QoS monitoring | 16.3.0 | +| 2019-12 | CT#86 | CP-193236 | 0361 | 2 | B | Line Identifier | 16.3.0 | +| 2019-12 | CT#86 | CP-193193 | 0364 | 2 | B | remove EN related to SteeringFunctionality datatype | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0366 | | F | Correct the Cardinality of redirectInfo | 16.3.0 | +| 2019-12 | CT#86 | CP-193223 | 0367 | 1 | D | Background data transfer support editorials | 16.3.0 | +| 2019-12 | CT#86 | CP-193222 | 0368 | 2 | B | Transport of TSN information and containers between SMF and PCF | 16.3.0 | +| 2019-12 | CT#86 | CP-193222 | 0369 | 2 | B | Transport of TSC assistance information between SMF and PCF | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0371 | | A | CHF addresses as apiRoot in the form of an FQDN | 16.3.0 | +| 2019-12 | CT#86 | CP-193259 | 0372 | 4 | B | Indication of PS to CS Handover for 5G SRVCC from SMF to PCF | 16.3.0 | +| 2019-12 | CT#86 | CP-193215 | 0373 | 2 | B | Coverage and Handover Enhancements for Media (CHEM) | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0374 | 1 | B | MCS Priority Level | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0375 | 1 | F | Removal of non-breaking spaces, TABs and \$ref descriptions | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0377 | 2 | B | Request of SM Policy Association Termination during the Update procedure | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0379 | | A | Correction to delete a PCC rule requested by the UE | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0381 | | A | Termination action | 16.3.0 | +| 2019-12 | CT#86 | CP-193233 | 0382 | 1 | B | AMF change in the HR scenario | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0383 | 2 | B | Same PCF selection for the same UE ID, S-NSSAI and DNN combination | 16.3.0 | +| 2019-12 | CT#86 | CP-193238 | 0384 | 2 | B | Correction to the QoS monitoring Control | 16.3.0 | +| 2019-12 | CT#86 | CP-193212 | 0385 | | F | Update of API version and TS version in OpenAPI file | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0386 | | F | Correct the redirection server address to support dual stack UE | 16.3.0 | +| 2019-12 | CT#86 | CP-193184 | 0388 | 1 | A | Correction of AF Charging Identifier data type | 16.3.0 | +| 2019-12 | CT#86 | CP-193191 | 0389 | 2 | B | Clarification of PEI format, TS 29.512 | 16.3.0 | +| 2019-12 | CT#86 | CP-193230 | 0390 | 2 | B | HFC node Id in Location information, TS 29.512 | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0393 | 1 | B | Add reference to TS 29.524 | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0402 | 1 | B | Update of the same PCF selection | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0403 | | B | DNN Clarification | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0404 | 1 | B | Cell change trigger | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0405 | 1 | B | Correction to the policy decision data and condition data | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0406 | 1 | B | Reallocation of credit | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0407 | 1 | B | UE initiated resource modification correction | 16.4.0 | +| 2020-03 | CT#87e | CP-200204 | 0408 | 2 | B | Complete the PCC procedure for ATSSS | 16.4.0 | +| 2020-03 | CT#87e | CP-200203 | 0410 | 1 | B | Complete the IPTV support | 16.4.0 | +| 2020-03 | CT#87e | CP-200203 | 0411 | 1 | B | Policy Control Request Triggers for wireline access | 16.4.0 | +| 2020-03 | CT#87e | CP-200203 | 0412 | 1 | B | The data type of GlobalLineId | 16.4.0 | +| 2020-03 | CT#87e | CP-200212 | 0414 | 1 | B | Complete the PCC procedure for V2XARC | 16.4.0 | +| 2020-03 | CT#87e | CP-200202 | 0415 | 1 | B | Complete the QoS Monitoring | 16.4.0 | +| 2020-03 | CT#87e | CP-200218 | 0416 | 1 | B | Indication of traffic correlation | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0417 | 1 | B | DNN selection mode | 16.4.0 | +| 2020-03 | CT#87e | CP-200204 | 0419 | 2 | B | interworking with EPS for ATSSS | 16.4.0 | +| 2020-03 | CT#87e | CP-200285 | 0420 | 3 | B | Additional Access Type for ATSSS | 16.4.0 | +| 2020-03 | CT#87e | CP-200231 | 0423 | 1 | B | Report of EPS Fallback | 16.4.0 | +| 2020-03 | CT#87e | CP-200226 | 0424 | 1 | B | Clarification of DS-TT and NW-TT ports identification | 16.4.0 | +| 2020-03 | CT#87e | CP-200226 | 0425 | 1 | B | Clarification of DS-TT and NW-TT ports management information | 16.4.0 | +| 2020-03 | CT#87e | CP-200218 | 0426 | | B | PCF provisioning of TSN related Policy Control Request triggers | 16.4.0 | +| 2020-03 | CT#87e | CP-200218 | 0427 | 1 | B | TSCAI input container and TSN QoS container | 16.4.0 | +| 2020-03 | CT#87e | CP-200214 | 0428 | | F | OpenAPI: usage of the "tags" keyword | 16.4.0 | +| 2020-03 | CT#87e | CP-200214 | 0429 | | F | Enumerations and "nullable" keyword | 16.4.0 | +| 2020-03 | CT#87e | CP-200215 | 0430 | | F | Referencing enumerations in clause 5.6.1 | 16.4.0 | +| 2020-03 | CT#87e | CP-200200 | 0431 | | B | CHF set and instance Id in charging information | 16.4.0 | +| 2020-03 | CT#87e | CP-200216 | 0435 | | F | 29.512 Rel-16 Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201217 | 0437 | 1 | A | Correction to attributes interGrpIds and appDetectionInfos | 16.5.0 | +| 2020-06 | CT#88e | CP-201238 | 0438 | | F | Correction to V2XARC | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0440 | | A | String format of flow information | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0444 | 1 | A | Notification URI | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0445 | 1 | B | Cause Mapping of VALIDATION_CONDITION_NOT_MET | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0446 | | B | ATSSS rule derivation | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0447 | 3 | B | QoS support for ATSSS | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0448 | 1 | B | Enable removing the policy decision | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0449 | 2 | F | Correction to bridge Information report | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0450 | 2 | F | Correction to Port Management Information Container exchange | 16.5.0 | +| 2020-06 | CT#88e | CP-201271 | 0451 | 2 | F | Correction to Provisioning of TSCAI input information and TSC QoS related data | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0452 | 1 | B | PCC rule information update for vertical | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0453 | 1 | B | PCF functionality update for TSN | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0454 | | B | General update of Annex C | 16.5.0 | +| 2020-06 | CT#88e | CP-201262 | 0455 | 3 | B | Support of full Frame Routing feature | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0456 | 1 | B | The data type of GlobalLineId | 16.5.0 | +| 2020-06 | CT#88e | CP-201338 | 0457 | 3 | B | Procedure of policy provisioning of QoS monitoring control | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0458 | 1 | F | QoS Monitoring Control Data correction | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0463 | 1 | A | timeUsage in Accumulated Usage Report | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0464 | | F | Support the update of SteeringFunctionality | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0465 | | B | Not to support Mission Critical Services | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0468 | | F | Removal of MAC address | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0470 | | F | Removal of unbreakable space and TAB | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0471 | 1 | B | Solving Editor's note on UL CL | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0472 | 1 | B | Hybrid Access Support | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0473 | 1 | B | Untrusted PEI | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0474 | 1 | B | RAT type for WWC | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0475 | 1 | B | PS Data Off for a MA PDU session | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0476 | 1 | F | Correction to Reallocation of Credit | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0477 | 1 | B | Local traffic routing policy | 16.5.0 | +| 2020-06 | CT#88e | CP-201238 | 0478 | 1 | F | Referencing alternative QoS in clause 4.2.6.2.1 | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0479 | 1 | B | QoS information for Time Sensitive Networking | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0480 | 1 | B | Update of TSN related PCRTs | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0481 | 1 | B | Completion of traffic correlation | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0482 | 1 | A | Correction to NetLoc feature | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0484 | 1 | A | Correction to PS Data Off | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0486 | 1 | F | Correct data type used in QoS monitoring | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0487 | 1 | F | Storage of YAML files in ETSI Forge | 16.5.0 | +| 2020-06 | CT#88e | CP-201257 | 0489 | 1 | B | DDN Failure and Delivery Policy Control Request triggers | 16.5.0 | +| 2020-06 | CT#88e | CP-201272 | 0490 | 1 | B | Introduction of Bridge management information | 16.5.0 | +| 2020-06 | CT#88e | CP-201267 | 0491 | 1 | B | Clarification of PCF behaviour to honor UE provided maximum packet filter support | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0492 | 1 | B | Policy decision and condition data status report | 16.5.0 | +| 2020-06 | CT#88e | CP-201263 | 0494 | 1 | B | New value of the ATSSS capability | 16.5.0 | +| 2020-06 | CT#88e | CP-201264 | 0495 | 1 | B | PCC rule for Non-MPTCP traffic | 16.5.0 | +| 2020-06 | CT#88e | CP-201265 | 0496 | 1 | B | Steering modes for GBR traffic | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0499 | 1 | B | Correct the reference of the port management info container | 16.5.0 | +| 2020-06 | CT#88e | CP-201256 | 0501 | 1 | F | URI of the Npcf_SMPolicyControl service | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0503 | 1 | F | Correction to the usage of appReloc attribute | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0505 | 1 | A | Correction to session rule error report | 16.5.0 | +| 2020-06 | CT#88e | CP-201297 | 0506 | 2 | B | Clarification on the target of QoS Monitoring report | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0507 | 1 | F | Correction to attributes related to QosMonitoring | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0508 | | F | Clarification on the value of 3gLoad attribute | 16.5.0 | +| 2020-06 | CT#88e | CP-201266 | 0511 | 1 | B | Application Id in a PCC rule for ATSSS | 16.5.0 | +| 2020-06 | CT#88e | CP-201273 | 0513 | 1 | B | QoS parameter mapping | 16.5.0 | +| 2020-06 | CT#88e | CP-201217 | 0517 | 1 | A | Not supporting simultaneous online and offline charging | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0518 | | F | Optionality of ProblemDetails | 16.5.0 | +| 2020-06 | CT#88e | CP-201232 | 0519 | | F | "PCSCF-Restoration-Enhancement" feature corrections | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0520 | 1 | F | Supported headers, Resource Data type, Operation Name and yaml mapping | 16.5.0 | +| 2020-06 | CT#88e | CP-201247 | 0522 | | F | Reallocation of credit reporting to the PCF | 16.5.0 | +| 2020-06 | CT#88e | CP-201255 | 0524 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2020-06 | CT#88e | CP-201282 | 0525 | | F | Correcting feature numbers | 16.5.0 | +| 2020-09 | CT#89e | CP-202068 | 0527 | 1 | F | Correction of the alternative QoS profile | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0529 | | A | rellpv4Address attribute correction | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0531 | 1 | A | Correction to QosData | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0533 | 2 | A | Correction to QoS Flow usage negotiation | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0535 | 1 | A | Correction to RedirectInformation | 16.6.0 | +| 2020-09 | CT#89e | CP-202209 | 0538 | 1 | F | Correction to policy update when UE suspends | 16.6.0 | +| 2020-09 | CT#89e | CP-202059 | 0539 | | F | Correction to policy control request triggers for wireline access | 16.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202059 | 0553 | | F | Corrections related to framed routes | 16.6.0 | +| 2020-09 | CT#89e | CP-202077 | 0554 | | F | Correcting feature numbers | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0557 | 1 | A | Correction to ADC | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0559 | | A | Correction to ChfAddress | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0561 | | A | Correction to RAN-NAS Release Cause feature | 16.6.0 | +| 2020-09 | CT#89e | CP-202052 | 0563 | 1 | A | Correction for emergency sessions | 16.6.0 | +| 2020-09 | CT#89e | CP-202059 | 0565 | 1 | F | Support of 5GS and EPC interworking for non-3GPP Trusted Access | 16.6.0 | +| 2020-09 | CT#89e | CP-202048 | 0566 | | F | Multiple traffic descriptors | 16.6.0 | +| 2020-09 | CT#89e | CP-202084 | 0567 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2020-09 | CT#89e | CP-202079 | 0542 | 1 | F | Clarification of default QoS | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0543 | | B | Clarification of IP index provisioning | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0544 | 1 | F | Clarification of usage monitoring control | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0545 | 1 | F | Correction to indication of UE IP address preservation | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0546 | 1 | F | Correction to policy control functions for TSN | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0547 | | F | Correction to the policy decision | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0548 | | F | Correction to the session-AMBR provisioning | 17.0.0 | +| 2020-09 | CT#89e | CP-202080 | 0549 | 1 | B | Traffic steering control for 5G-LAN type of services | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0550 | 1 | B | Update the definitions in 3.1 | 17.0.0 | +| 2020-09 | CT#89e | CP-202079 | 0564 | | F | Clarification of trace control | 17.0.0 | +| 2020-12 | CT#90e | CP-203125 | 0570 | | A | refUmN3gData yaml correction | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0574 | | A | TS 29.512 Essential Corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203128 | 0576 | 1 | A | Correction of the condition for the Credit Reallocation event | 17.1.0 | +| 2020-12 | CT#90e | CP-203159 | 0578 | 2 | F | Disambiguation of the reporting and handling of triggers for PCC rule bases | 17.1.0 | +| 2020-12 | CT#90e | CP-203143 | 0582 | 1 | A | Correction to PRA | 17.1.0 | +| 2020-12 | CT#90e | CP-203128 | 0584 | 3 | A | Correction to access type conditioned session AMBR | 17.1.0 | +| 2020-12 | CT#90e | CP-203128 | 0586 | 1 | A | Correction to PolicyDecisionErrorHandling feature | 17.1.0 | +| 2020-12 | CT#90e | CP-203128 | 0587 | 1 | A | Correction to SamePcf Feature | 17.1.0 | +| 2020-12 | CT#90e | CP-203114 | 0594 | | A | Correction to policy based on revalidation time | 17.1.0 | +| 2020-12 | CT#90e | CP-203114 | 0597 | 1 | A | Correction to session rule | 17.1.0 | +| 2020-12 | CT#90e | CP-203114 | 0600 | | A | Correction to usage monitoring control | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0602 | 1 | F | Correction to FailureCode and SessionFailureCode | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0603 | 1 | B | Extension of Policy Decision Failure handling | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0604 | 1 | F | Correction to SM Policy Association termination due to session rule error | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0605 | 1 | F | Correction to SessionRuleFailureCode | 17.1.0 | +| 2020-12 | CT#90e | CP-203084 | 0606 | 1 | F | Correction to usage monitoring control | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0607 | | F | Correction to SMF definition for LBO | 17.1.0 | +| 2020-12 | CT#90e | CP-203114 | 0610 | 1 | A | Correction to usage report during the policy association termination | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0612 | 1 | A | Correction to the BDT policy re-negotiation | 17.1.0 | +| 2020-12 | CT#90e | CP-203150 | 0614 | 1 | A | Remove the NW-TT port from the TSN bridge info | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0618 | | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203132 | 0620 | 2 | A | Correction to Alternative QoS Parameter | 17.1.0 | +| 2020-12 | CT#90e | CP-203111 | 0626 | 1 | A | QoS monitoring report at PDU session termination | 17.1.0 | +| 2020-12 | CT#90e | CP-203111 | 0628 | 1 | A | QoS Monitoring corrections | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0629 | 1 | B | Updates to support User Location Change | 17.1.0 | +| 2020-12 | CT#90e | CP-203128 | 0631 | 1 | A | Location change (serving cell) for Policy Control Request Trigger | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0633 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0634 | 1 | F | Miscellaneous corrections to the Npcf_SMPolicyControl_Create service operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0635 | 1 | F | Miscellaneous corrections to the Npcf_SMPolicyControl_UpdateNotify service operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210222 | 0637 | 1 | A | Corrections to the procedures of policy provisioning and enforcement of authorized AMBR and default QoS | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0638 | 1 | F | Clarification on the applicability of some attributes and data types to UMC feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0639 | 1 | B | Addition of the PDU Session with offline charging only indication | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0640 | 1 | F | Reference to the wrong clause for the SMF initiated PDU session termination procedure | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0641 | 1 | F | Correction of a wrong reference to TS 29.514 related to AF session with required QoS procedures | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0642 | 1 | F | Clarification on the applicability of some data types to the SessionRuleErrorHandling feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0643 | 1 | F | Clarification on the applicability of some attributes to the 3GPP-PS-Data-Off feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0645 | 1 | F | Miscellaneous corrections to TS 29.512 | 17.2.0 | +| 2021-03 | CT#91e | CP-210205 | 0647 | 1 | A | Correction to the access network information report | 17.2.0 | +| 2021-03 | CT#91e | CP-210191 | 0651 | 2 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210237 | 0653 | 1 | A | Correction to the Group Id update | 17.2.0 | +| 2021-03 | CT#91e | CP-210189 | 0655 | 1 | A | PCC control for DDD status and availability after DDN failure events | 17.2.0 | +| 2021-03 | CT#91e | CP-210210 | 0657 | 3 | A | Disable UE notifications at changes related to Alternative QoS | 17.2.0 | + +| | | | | | | | | +|--|--|--|--|--|--|----------|--| +| | | | | | | Profiles | | +|--|--|--|--|--|--|----------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91e | CP-210228 | 0660 | | F | User Location Change PCRT not supported in wireline access | 17.2.0 | +| 2021-03 | CT#91e | CP-210202 | 0662 | 1 | A | Correction to supported Policy Control Request triggers in wireline access | 17.2.0 | +| 2021-03 | CT#91e | CP-210192 | 0664 | 3 | A | Redundant User Plane Paths | 17.2.0 | +| 2021-03 | CT#91e | CP-210204 | 0666 | | A | Correction to repPolicyCtrlReqTrigger attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210205 | 0668 | 1 | A | Correction to multiple access type conditioned session rules | 17.2.0 | +| 2021-03 | CT#91e | CP-210205 | 0670 | | A | Correction to QOS_DEC_ERR and CH_DEC_ERR | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0671 | 1 | F | Correction to Monitoring key definition | 17.2.0 | +| 2021-03 | CT#91e | CP-210204 | 0673 | 3 | A | Correction to access type conditioned session rule | 17.2.0 | +| 2021-03 | CT#91e | CP-210191 | 0675 | 2 | A | Correction to "resourceUri" attribute description | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0676 | | F | Correction on UE initiated PDU session modification | 17.2.0 | +| 2021-03 | CT#91e | CP-210237 | 0678 | 1 | A | Correction to TSN scenarios. | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0679 | | F | Update of "description" field for map data types | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0680 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210237 | 0686 | 2 | A | Correction to traffic correlation indication | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0691 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0692 | 1 | F | Additional corrections to the Npcf_SMPolicyControl_Create service operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0693 | 1 | F | Miscellaneous corrections to the Npcf_SMPolicyControl_Delete service operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0694 | 1 | F | Miscellaneous corrections to the Provisioning and Enforcement of Policy Decisions clause | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0695 | 1 | F | Miscellaneous corrections to the data types defined in the Npcf_SMPolicyControl API | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0696 | | F | Corrections of a reference to an non-existent subclause | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0697 | 1 | F | Corrections to the P-CSCF restoration indication mechanism | 17.2.0 | +| 2021-03 | CT#91e | CP-210225 | 0698 | 1 | F | Reference to the wrong attribute name for the QoS Monitoring Decision | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0701 | | A | Correction of a reference to the wrong attribute name for the reported presence reporting area information | 17.2.0 | +| 2021-03 | CT#91e | CP-210204 | 0706 | | A | Correction of the SteerModeValue attribute name in the Npcf_SMPolicyControl specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0707 | | F | Corrections to the applicability column of the SmPolicyDeleteData data type | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0710 | 1 | A | Correction to authDefQos attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0716 | 1 | A | Correction to the GBR type of default QoS flow | 17.2.0 | +| 2021-03 | CT#91e | CP-210217 | 0722 | | A | The apiSpecificResourceUriPart component | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0723 | 1 | F | NF service consumer terminology | 17.2.0 | +| 2021-03 | CT#91e | CP-210220 | 0724 | | B | Optional header clarification | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0727 | 1 | A | Corrections to RuleOperation | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0730 | 1 | A | repPolicyCtrlReqTriggers attribute correction | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0733 | | A | Correction to session rule | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0734 | 1 | F | deactivationTime for time conditioned session rule | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0735 | 1 | F | Remove exUsagePccRuleIds from PCC rule definition | 17.2.0 | +| 2021-03 | CT#91e | CP-210222 | 0738 | | A | packFiltInfo attribute correction | 17.2.0 | +| 2021-03 | CT#91e | CP-210195 | 0741 | 2 | A | Correction to PCF behavior when removing PCC/Session rules | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0742 | 1 | F | Correction on UE initiated PDU session modification | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0743 | 1 | F | Correction to conditioned rules | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0744 | 1 | F | Correction to Usage Monitoring | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0745 | 1 | F | Clarification about handling of valid unreferred policy decisions | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0748 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211283 | 0681 | 2 | B | Satellite backhaul change policy control request trigger | 17.3.0 | +| 2021-06 | CT#92e | CP-211226 | 0749 | 2 | B | 29.512 PCC support for MPS for DTS | 17.3.0 | +| 2021-06 | CT#92e | CP-211242 | 0751 | 1 | F | Correction to Charging Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211257 | 0752 | 2 | B | Application Detection triggering for dynamic AM policy changes | 17.3.0 | +| 2021-06 | CT#92e | CP-211237 | 0755 | 2 | A | Correct the error code MISS_FLOW_INFO | 17.3.0 | +| 2021-06 | CT#92e | CP-211198 | 0757 | 2 | A | Correction to PCC control for DDD status and availability after DDN failure events | 17.3.0 | +| 2021-06 | CT#92e | CP-211245 | 0759 | 1 | F | Correction to access network info report | 17.3.0 | +| 2021-06 | CT#92e | CP-211273 | 0760 | 3 | B | Support Time Sensing Communication other than TSN | 17.3.0 | +| 2021-06 | CT#92e | CP-211272 | 0761 | 2 | B | Support survival time | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0763 | 3 | B | Add user plane latency requirement in PCC rule | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0764 | | F | Correction to policy control request trigger | 17.3.0 | +| 2021-06 | CT#92e | CP-211246 | 0765 | 1 | F | Correction to usage monitoring for Non-3GPP | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0766 | 1 | F | Clarification of PCF Requested Usage Report | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0767 | 1 | F | Correct the disabling usage monitoring | 17.3.0 | +| 2021-06 | CT#92e | CP-211243 | 0768 | 1 | F | Correct the Redundant PDU Session indication | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0769 | 1 | F | Correct the offline charging only | 17.3.0 | +| 2021-06 | CT#92e | CP-211237 | 0771 | 1 | A | Correction to QoS control in the VPLMN | 17.3.0 | +| 2021-06 | CT#92e | CP-211270 | 0772 | 4 | B | Support of event trigger for GERAN and UTRAN access over N7 interface | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211217 | 0774 | 1 | F | Additional corrections to the PDU Session with offline charging only indication | 17.3.0 | +| 2021-06 | CT#92e | CP-211234 | 0775 | | F | Additional missing description fields in OpenAPI specification files | 17.3.0 | +| 2021-06 | CT#92e | CP-211277 | 0776 | 1 | B | Support of Threshold Condition | 17.3.0 | +| 2021-06 | CT#92e | CP-211277 | 0777 | 1 | B | Support of Steering Mode Indicator | 17.3.0 | +| 2021-06 | CT#92e | CP-211256 | 0778 | 2 | F | Correction of tsnPortManContNwts attribute | 17.3.0 | +| 2021-06 | CT#92e | CP-211215 | 0780 | 1 | A | Correction on wrong referenced attributes | 17.3.0 | +| 2021-06 | CT#92e | CP-211276 | 0782 | 1 | B | Support of Network Exposure to EAS via Local NEF | 17.3.0 | +| 2021-06 | CT#92e | CP-211217 | 0783 | 1 | B | Handling of requests which collide with an existing SM Policy Association for interworking scenario | 17.3.0 | +| 2021-06 | CT#92e | CP-211217 | 0785 | 1 | B | Handling of requests which have timed out at the originating entity for interworking scenario | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0786 | 1 | A | Redirect Responses | 17.3.0 | +| 2021-06 | CT#92e | CP-211250 | 0790 | 2 | F | Correction to Same PCF requests to BSF | 17.3.0 | +| 2021-06 | CT#92e | CP-211274 | 0791 | 1 | B | Support of TSCAI time domain | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0792 | 2 | F | Failure handling for traffic steering | 17.3.0 | +| 2021-06 | CT#92e | CP-211204 | 0795 | 1 | A | Wrong referenced SmPolicyDecision data type | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0797 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0798 | | F | Updating the UDR upon usage report receipt | 17.3.0 | +| 2021-09 | CT#93e | CP-212212 | 0799 | 1 | B | 29.512 MPS for DTS QoS update failure | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0802 | 1 | F | Correction to PRA information update | 17.4.0 | +| 2021-09 | CT#93e | CP-212198 | 0806 | 2 | B | Duplicated notification | 17.4.0 | +| 2021-09 | CT#93e | CP-212193 | 0807 | 1 | B | Clarification on satellite backhaul | 17.4.0 | +| 2021-09 | CT#93e | CP-212201 | 0808 | 1 | B | Authorization of UE initiates a resource modification | 17.4.0 | +| 2021-09 | CT#93e | CP-212201 | 0809 | 1 | B | PCC rules authorization with preliminary service information | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0810 | | B | Clarification of the charging correlation id | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0811 | | B | Removal of traffic routing information | 17.4.0 | +| 2021-09 | CT#93e | CP-212205 | 0812 | 1 | B | Support of IMS emergency service for SNPN | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0815 | 1 | A | Correction of report of User Location Info Time | 17.4.0 | +| 2021-09 | CT#93e | CP-212220 | 0817 | 1 | A | Support of TCP and UDP ports in non-3GPP UE location | 17.4.0 | +| 2021-09 | CT#93e | CP-212196 | 0818 | 1 | F | Align description with data type for rttThres | 17.4.0 | +| 2021-09 | CT#93e | CP-212196 | 0819 | | B | Congestion handling for priority-based steering mode | 17.4.0 | +| 2021-09 | CT#93e | CP-212196 | 0820 | | B | remove EN related to UE-assistance indicator | 17.4.0 | +| 2021-09 | CT#93e | CP-212211 | 0821 | 1 | F | handling of SMF for TSCAI Survival Time | 17.4.0 | +| 2021-09 | CT#93e | CP-212211 | 0822 | 1 | F | Replacement of TSN Terminology in 29.512 | 17.4.0 | +| 2021-09 | CT#93e | CP-212189 | 0824 | 1 | A | Align description with data type for thresholds in QosMonitoringData | 17.4.0 | +| 2021-09 | CT#93e | CP-212167 | 0826 | 1 | A | correction of description of dsttResidTime | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0827 | 1 | F | Corrections on the sender of the HTTP error response in the update procedure | 17.4.0 | +| 2021-09 | CT#93e | CP-212220 | 0828 | 1 | F | Correction to the declaration of authorization credentials | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0829 | | B | Correction to the report of Netloc access information | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0830 | | B | Removal of network slice instance from service procedures | 17.4.0 | +| 2021-09 | CT#93e | CP-212211 | 0831 | 1 | B | Introduction of TSCTSF | 17.4.0 | +| 2021-09 | CT#93e | CP-212220 | 0832 | 1 | F | Adding a missing description field to the OpenAPI specification file of the Npcf_SMPolicyControl API | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0833 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0834 | 1 | F | Report of 3GPP and non-3GPP User Location | 17.4.0 | +| 2021-12 | CT#94e | CP-213216 | 0836 | | F | Correction to the notification of satellite backhaul changes | 17.5.0 | +| 2021-12 | CT#94e | CP-213229 | 0838 | 1 | B | PCC Support of restricted PDU Session for remote provisioning of UE using User Plane | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0839 | 2 | B | Monitoring the data rate per Network Slice | 17.5.0 | +| 2021-12 | CT#94e | CP-213225 | 0840 | 1 | B | Handling of Session Management Policy Data per PLMN | 17.5.0 | +| 2021-12 | CT#94e | CP-213229 | 0841 | | B | SNPN support for IMS Emergency services | 17.5.0 | +| 2021-12 | CT#94e | CP-213229 | 0842 | | B | Direct access to SNPN | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0843 | 1 | B | Clarify the scenario where the TSC and time synchronization are not supported | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0844 | 1 | B | Resolve the editor's note for bridge Id | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0845 | 2 | B | Remove the editor's note for AF preference for the user plane latency | 17.5.0 | +| 2021-12 | CT#94e | CP-213222 | 0846 | | B | Remove the editor's note for UPF service | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0849 | 1 | B | NWDAF instance provisioning to the PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0850 | 1 | B | Support of UE-Slice-MBR | 17.5.0 | +| 2021-12 | CT#94e | CP-213219 | 0852 | 1 | F | Mutual exclusion between thresValue and steerModelInd | 17.5.0 | +| 2021-12 | CT#94e | CP-213219 | 0853 | 1 | F | MA PDU sessions with connectivity over EPC and 5GC | 17.5.0 | +| 2021-12 | CT#94e | CP-213243 | 0854 | 1 | F | Replacing PDU session in Annex B with PDN connection | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0855 | | F | API URI of the Npcf_SMPolicyControl API | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0856 | 1 | B | Indication of request of notification PDU session established/terminated events | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0857 | 1 | B | Handling alternative QoS related parameters received from the AF | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0858 | 1 | F | Correction to TSC QoS information | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0859 | 1 | F | Support of Ethernet PDU sessions and IP PDU sessions for TSC | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0860 | | F | TSCTSF as PCF consumer for TSC | 17.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213234 | 0861 | 1 | F | Change the Network to TSN translator (TT) protocol aspects TS referencing | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0862 | 1 | B | Adding EAS IP replacement information in PCC rules | 17.5.0 | +| 2021-12 | CT#94e | CP-213241 | 0864 | 1 | A | PCF authorization for QoS control in the VPLMN | 17.5.0 | +| 2021-12 | CT#94e | CP-213219 | 0865 | 1 | B | Extension of PCC rule definition for ATSSS | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0868 | | F | Correction on reused data type Uinteger | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0869 | 1 | B | Error handling when no SM Policy Association exists | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0870 | | F | Correction to session rule | 17.5.0 | +| 2021-12 | CT#94e | CP-213225 | 0871 | 1 | F | Resolving the PDU Session with offline charging only indication related Ens | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0872 | 1 | B | AF Request for Simultaneous Connectivity over Source and Target PSA at Edge Relocation | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0873 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220178 | 0875 | 1 | F | 29.512 MPS for DTS Notes Correction | 17.6.0 | +| 2022-03 | CT#95e | CP-220178 | 0876 | 1 | F | 29.512 MPS exemption from time conditioning | 17.6.0 | +| 2022-03 | CT#95e | CP-220188 | 0878 | | F | Clarification on threshold values | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0879 | 1 | B | Cleanup of time sensitive communication | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0881 | 1 | B | QoS determination for TSC | 17.6.0 | +| 2022-03 | CT#95e | CP-220182 | 0882 | 1 | F | Onboarding indication | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0883 | 1 | B | Support of AF triggered EAS rediscovery | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0884 | 1 | F | Clarification of the packet filter identifier | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0886 | | F | Correction on UE Location related information in the interworking cases | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0887 | 1 | F | Handling of number of packets in 5G | 17.6.0 | +| 2022-03 | CT#95e | CP-220179 | 0888 | 1 | F | reusing common data type SatelliteBackhaulCategory | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0889 | 1 | F | Alignment of term Session-AMBR | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0890 | | F | Update of service operation general descriptions | 17.6.0 | +| 2022-03 | CT#95e | CP-220187 | 0891 | 1 | F | Update of service operation general descriptions for eNS | 17.6.0 | +| 2022-03 | CT#95e | CP-220182 | 0892 | 1 | F | Update of 4.2.2.1 | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0893 | 1 | F | complete the definition of NWDAF_DATA_CHG trigger | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0894 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220188 | 0895 | 1 | F | Clarification to MA PDU sessions | 17.6.0 | +| 2022-03 | CT#95e | CP-220182 | 0896 | 1 | B | Completion of the Support of restricted PDU Session for remote provisioning of UE using User Plane | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0898 | 2 | B | Enhance SmPolicyAssociationReleaseCause for trigger PDU session reactivation procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0899 | 1 | F | Handling of supported features for Edge Computing | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0900 | | F | Corrections in attribute name and data type description related to NWDAF data. | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0901 | 1 | F | Collision in SMF during UpdateNotify procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0903 | 1 | F | Handling of packet filters when the allowed number is exceeded | 17.6.0 | +| 2022-03 | CT#95e | CP-220187 | 0904 | 1 | F | remove EN related to Dispersion Analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0906 | 1 | F | Formatting of Description Fields | 17.6.0 | +| 2022-03 | CT#95e | CP-220202 | 0907 | 1 | B | Support of AN-GW restoration | 17.6.0 | +| 2022-03 | CT#95e | CP-220202 | 0908 | 1 | B | UE-initiated resource modification support for interworking scenario | 17.6.0 | +| 2022-03 | CT#95e | CP-220167 | 0911 | 1 | A | Corrections to Application Detection and Control | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0912 | | B | Updating Binding Indication for multiple resource contexts feature | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0913 | 1 | F | Correction to the indication of notification to the PCF for the UE about PDU session establishment/termination events | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0915 | 1 | F | Correction to enable retrieval of Network Provided Location information in a MESSAGE request | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0916 | | B | Correction to TSCAI derivation | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0917 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-03 | CT#95e | CP-220335 | 0920 | | F | Correction to pvsInfo attribute | 17.6.0 | +| 2022-06 | CT#96 | CP-221154 | 0922 | | F | Correcting the definition of the 404 status code in the OpenAPI description | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0923 | 3 | F | Handling of time domain | 17.7.0 | +| 2022-06 | CT#96 | CP-221144 | 0924 | 2 | F | Resolve the issue of individual QoS parameters | 17.7.0 | +| 2022-06 | CT#96 | CP-221123 | 0926 | 1 | F | MA PDU Session in EPC/E-UTRAN to 5GS handover | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0927 | | F | Correction of supported features for Edge Computing functionality | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0929 | 1 | F | Completion of handling of NWDAF_DATA_CH trigger | 17.7.0 | +| 2022-06 | CT#96 | CP-221138 | 0930 | 1 | F | Completion of User Plane Remote Provisioning | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0931 | 3 | F | Correction to the charging identifier to enable uniqueness in roaming scenarios | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0933 | 1 | F | Correction to the PDU Session ID determination in EPC interworking scenarios | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0935 | 1 | F | Correction to the QoS constraints support | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0936 | 1 | F | Correction to the notification of PCF for a PDU session | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0937 | 1 | B | Burst Arrival Time adjustment | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0939 | 1 | F | Correction to the TrafficData and ConditionData | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0940 | 2 | F | Correction to QoS monitoring report | 17.7.0 | +| 2022-06 | CT#96 | CP-221117 | 0941 | 1 | A | Correction for the handling of QoS monitoring data | 17.7.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221157 | 0942 | | F | Handling of multiple IPv6 prefixes | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0945 | 1 | F | Correction to traffic routing requirements | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0947 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221127 | 0949 | | F | The behaviour of SMF for I-SMF insertion and removal | 17.7.0 | +| 2022-09 | CT#97e | CP-222125 | 0950 | | F | Untrusted WLAN location information | 17.8.0 | +| 2022-09 | CT#97e | CP-222125 | 0951 | 2 | F | Exceeding number of packet filters when interworking with EPS | 17.8.0 | +| 2022-09 | CT#97e | CP-222093 | 0955 | 1 | A | Correction to policyCtrlReqTriggers attribute name | 17.8.0 | +| 2022-09 | CT#97e | CP-222125 | 0957 | 1 | F | Correction to the QoS Monitoring | 17.8.0 | +| 2022-09 | CT#97e | CP-222113 | 0958 | 1 | F | Correction to the references | 17.8.0 | +| 2022-09 | CT#97e | CP-222093 | 0962 | | A | Correction to UP Path change subscription | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0963 | 1 | F | ExposureToEAS feature name correction | 17.8.0 | +| 2022-09 | CT#97e | CP-222125 | 0966 | 1 | F | Rejection of the update of mute indication for ADC | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0968 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223181 | 0970 | 1 | F | Survival time applicability | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0972 | | F | Correction on NWDAF_DATA_CHG handling | 17.9.0 | +| 2022-12 | CT#98e | CP-223196 | 0976 | 1 | F | Correction related to applicability of traffic correlation indicator | 17.9.0 | +| 2022-12 | CT#98e | CP-223163 | 0976 | | A | Correction to the attribute name of policy control request trigger | 17.9.0 | +| 2022-12 | CT#98e | CP-223183 | 0979 | 1 | F | Correction to the attribute name of policy control request trigger | 17.9.0 | +| 2022-12 | CT#98e | CP-223165 | 0984 | | F | Correction to Satellite backhaul change report | 17.9.0 | +| 2022-12 | CT#98e | CP-223197 | 0987 | | F | Correction to the PCF for the UE indication of notification of PDU session events | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0993 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223191 | 0969 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0971 | | F | Enumeration definitions in the OpenAPI file and name of ServingNfIdentity data type | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0973 | 2 | F | Default QoS and Session AMBR handling in emergency cases | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0974 | 1 | F | Correction on policy decision and condition data error handling | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0975 | 1 | B | Error handling when UE is temporarily unavailable | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0980 | 1 | B | PCC decision based on the input of TSCTSF | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0981 | | F | Correction to the terminology of UMIC | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0982 | 1 | F | Clarification of application detection information report | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0985 | 1 | B | Indication of Alternative QoS not supported by NG-RAN | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0986 | 1 | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0988 | 1 | F | Clarification to the report of access network charging information | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0989 | 1 | F | Correction to policy update procedures | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0990 | 1 | F | Correction to charging data | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0991 | 1 | F | QoS monitoring support report | 18.0.0 | +| 2022-12 | CT#98e | CP-223178 | 0992 | | B | SNPN mobility | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0994 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230142 | 0997 | 1 | A | Correcting the support of multiple IPv6 prefixes | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0999 | 1 | B | Adding the ability to model multiple IPv6 prefixes | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 1000 | | F | Correcting the description of the termination action upon out of credit event | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 1002 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 1004 | 1 | F | Alignment of packet delay report | 18.1.0 | +| 2023-03 | CT#99 | CP-230170 | 1008 | 1 | B | Support for AF influence on Service Function Chaining | 18.1.0 | +| 2023-03 | CT#99 | CP-230171 | 1009 | | B | Clarification of the usage monitoring with monitoring time and one instance of the thresholds provided | 18.1.0 | +| 2023-03 | CT#99 | CP-230171 | 1010 | 1 | B | Handling of packet filters provided to the UE by SMF | 18.1.0 | +| 2023-03 | CT#99 | CP-230171 | 1011 | 1 | B | Mapping of QoS parameters between Rel-99 QoS parameters and 5G QoS parameters when N7 interface | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 1012 | 1 | B | Support for AF traffic influence for common EAS, DNAI selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230140 | 1014 | | A | Correction in QoS monitoring handling | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 1016 | | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 1017 | | F | Generalization of QoS monitoring control description | 18.1.0 | +| 2023-03 | CT#99 | CP-230173 | 1019 | 1 | A | Correction on setting Packet Delay Failure report Threshold | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 1020 | 1 | B | Introducing selection of more granular set of UEs | 18.1.0 | +| 2023-03 | CT#99 | CP-230136 | 1021 | 1 | B | Support of integration with IETF Deterministic Networking | 18.1.0 | +| 2023-03 | CT#99 | CP-230141 | 1024 | | A | Correction to incorrect attribute name capitalization | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 1025 | | F | User Plane Remote Provisioning clarifications | 18.1.0 | +| 2023-03 | CT#99 | CP-230150 | 1026 | | B | Onboarding in SNPN supporting localized services | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 1027 | 1 | F | Correction to Alternative QoS support | 18.1.0 | +| 2023-03 | CT#99 | CP-230129 | 1031 | 1 | A | Correction of enumerations values | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 1032 | | F | Corrections to enumeration values not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230143 | 1034 | | A | Correction to wrong attribute name | 18.1.0 | +| 2023-03 | CT#99 | CP-230177 | 1038 | 1 | B | Support of IPv6 prefix delegation | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 1039 | 1 | B | Support of BAT window and capability for BAT adaptation | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 1040 | 1 | B | Support of periodicity range | 18.1.0 | +| 2023-03 | CT#99 | CP-230130 | 1041 | 1 | B | Support of Dynamic Satellite Backhaul | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 1043 | 1 | B | Support of common DNAI selection by AF | 18.1.0 | +| 2023-03 | CT#99 | CP-230318 | 1045 | 3 | B | URSP provisioning in EPS | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230161 | 1047 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231174 | 1048 | 1 | B | Support of Non-3GPP access for SNPN scenarios | 18.2.0 | +| 2023-06 | CT#100 | CP-231163 | 1049 | 1 | B | MA PDU session interworking enhancements | 18.2.0 | +| 2023-06 | CT#100 | CP-231163 | 1050 | 1 | B | MP-QUIC support for traffic steering | 18.2.0 | +| 2023-06 | CT#100 | CP-231163 | 1051 | | B | Redundant traffic steering | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 1052 | 1 | B | Network determined BAT offset and periodicity adaption | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 1053 | 3 | B | The correction on BAT window and BAT adaptation capability and the support of provisioning Periodicity Set | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 1056 | 3 | B | Group related data rate policy control | 18.2.0 | +| 2023-06 | CT#100 | CP-231152 | 1057 | 1 | B | Updates to support the provisioning of the PDU Session inactivity timer value | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 1058 | 1 | B | Correction to AF influence on Service Function Chaining | 18.2.0 | +| 2023-06 | CT#100 | CP-231342 | 1059 | 6 | B | Support for URSP awareness | 18.2.0 | +| 2023-06 | CT#100 | CP-231160 | 1060 | 1 | B | Applicability of the policy control request trigger for convergence scenario | 18.2.0 | +| 2023-06 | CT#100 | CP-231160 | 1061 | 1 | B | Clarification of policy control request trigger | 18.2.0 | +| 2023-06 | CT#100 | CP-231160 | 1063 | 1 | B | IPTV service authorization | 18.2.0 | +| 2023-06 | CT#100 | CP-231160 | 1064 | 1 | B | PCF Function Clarification | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 1065 | 1 | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 1067 | | B | New PCC rule parameter for indirect feature negotiation | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 1068 | 1 | B | Support of VPLMN Specific Offloading Policy for HR-SBO | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 1071 | 3 | B | Support of the direct event notification of TSC management information | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 1072 | 1 | B | Support of PDU Set QoS Parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 1073 | 1 | B | Support of Uplink Downlink transmission coordination to meet RT latency requirement | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 1074 | 1 | B | Npcf_SMPolicyControl Service update for support of multi-modal services | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 1075 | 1 | B | Update Npcf_SMPolicyControl Service for support of new QoS monitoring parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231163 | 1077 | 1 | B | Support of Transport Mode of MPQUIC Steering Functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 1081 | 1 | F | Candidate DNAI information in wrong data type | 18.2.0 | +| 2023-06 | CT#100 | CP-231162 | 1082 | 1 | B | Support of application detection event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231183 | 1084 | 1 | B | Adapt QoS Monitoring description | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 1086 | 1 | B | Protocol description support in Npcf_SMPolicyControl API | 18.2.0 | +| 2023-06 | CT#100 | CP-231136 | 1087 | 1 | B | Support of change of HR-SBO support indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 1088 | 1 | F | Renaming AF influenced Traffic Steering | 18.2.0 | +| 2023-06 | CT#100 | CP-231147 | 1091 | | A | Removal of unspecified QoS monitoring control options | 18.2.0 | +| 2023-06 | CT#100 | CP-231299 | 1092 | 2 | B | Support of periodicity measurement and reporting for power saving | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 1093 | | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231152 | 1094 | 1 | B | updating the S-NSSAI of the PDU Session | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 1096 | 1 | B | Completion of URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 1097 | 1 | B | Session Failure report | 18.2.0 | +| 2023-06 | CT#100 | CP-231336 | 1099 | 3 | B | Support of Caller and Callee information | 18.2.0 | +| 2023-06 | CT#100 | CP-231318 | 1100 | 2 | B | Policy Control for L4S | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 1101 | | F | Corrections to the procedures for monitoring the data rate per network slice for a UE | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 1102 | 1 | D | Correcting a wrong reference related to PCC rule versioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 1105 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232086 | 1106 | 1 | B | Priority Level addition to QoS constraints | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 1107 | 1 | F | Corrections to the definition of Group related Policy Control Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232093 | 1108 | 1 | B | Completing the support of slice PDU session inactivity timer provisioning by the PCF | 18.3.0 | +| 2023-09 | CT#101 | CP-232101 | 1109 | 1 | B | Considering home TNAPs for policy decisions | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 1110 | 1 | F | Editor's note removal for Multimodal id | 18.3.0 | +| 2023-09 | CT#101 | CP-232102 | 1111 | 1 | D | Correction on SFC abbreviation | 18.3.0 | +| 2023-09 | CT#101 | CP-232126 | 1112 | | F | Clarification on Redundant Steering Mode | 18.3.0 | +| 2023-09 | CT#101 | CP-232108 | 1113 | | B | Handling of Packet Delay Budget for PIN scenarios | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 1114 | | F | Correction in Feature numbering | 18.3.0 | +| 2023-09 | CT#101 | CP-232107 | 1116 | | A | Incorrect description of NWDAF data | 18.3.0 | +| 2023-09 | CT#101 | CP-232115 | 1118 | 1 | A | Correction of anGwStatus attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232257 | 1119 | 1 | F | Correcting the value of hrsbolnd attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232182 | 1120 | 2 | B | Common EAS/DNAI determination for a set of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232121 | 1121 | | B | Completion of the reporting of Satellite Backhaul changes | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 1122 | 1 | B | Completing URSP rule enforcement | 18.3.0 | +| 2023-09 | CT#101 | CP-232120 | 1125 | | A | Correction to Access Network Charging Identifier | 18.3.0 | +| 2023-09 | CT#101 | CP-232084 | 1126 | 1 | B | Subscription to Data Rate monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232181 | 1127 | 2 | B | Support of the congestion information measurement and reporting | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 1128 | 1 | B | Support of the congestion information measurement and reporting | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 1129 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233239 | 1130 | 1 | B | Update for the VPLMN offloading policy | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 1131 | 1 | F | Clarification for the change of PCF for the UE | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233233 | 1132 | 1 | B | Introduction of new features for PDU set handle and RT latency | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 1133 | 1 | F | Clarification on configuration of maximum group data rate | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 1134 | 1 | B | Further progressing the definition of the network slice replacement functionality | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 1135 | 1 | B | Further progressing the definition of the network slice replacement functionality | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 1136 | 1 | F | Support of the new feature name EnQoSMon | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 1138 | 2 | F | Support QoS monitoring for dynamic satellite backhaul | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 1139 | 2 | F | Selection of traffic description for Common DNAI | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 1140 | 3 | B | Support the management of the temporal invalidity condition | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 1141 | 2 | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233271 | 1142 | 2 | F | Spending limits report for SM Policy | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 1143 | 2 | B | Remove the EN for PCC rule generation | 18.4.0 | +| 2023-12 | CT#102 | CP-233267 | 1144 | | F | Presence condition correction | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 1145 | | F | Incorrect data type | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 1147 | | F | Correction in QoS monitoring when PDU session is released | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 1148 | 1 | F | EN resolution on UE policy container PCRT | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 1149 | 1 | B | Protocol description update | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 1150 | 1 | B | Feature granularity and definition for MultiModal & PowerSaving | 18.4.0 | +| 2023-12 | CT#102 | CP-233280 | 1151 | 1 | B | Editor note removal on SMF DNN configuration | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 1153 | 3 | B | Policy Authorization for AF requested QoS for a UE or group of UEs not identified by a UE address | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 1155 | | B | Definition of L4S feature | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 1163 | 1 | F | Corrections related to EnSatBackhaulCatChg feature | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 1164 | 1 | F | Missing PCRT for UeCampingRep | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 1166 | 1 | F | Clarifications on the dynamic satellite backhaul categories | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 1167 | | F | Corrections on the hrsbolnd attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 1168 | 1 | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 1169 | 1 | B | Support of Data Collection Application Identifier | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 1170 | | F | Correct the reference clause and update the terminology | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 1171 | 1 | B | Support of the Data Burst Handling Information in the PCC rule | 18.4.0 | +| 2023-12 | CT#102 | CP-233271 | 1172 | 1 | B | Clarification of PCF authorization during SM policy association establishment | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 1176 | 1 | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29513/raw.md b/gsma/29_series/29513/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..09452e208459fd4c6e0bbafc22831f9be3bd6e6a --- /dev/null +++ b/gsma/29_series/29513/raw.md @@ -0,0 +1,7918 @@ +# 3GPP TS 29.513 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3 (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +## --- Keywords --- + +## **3GPP** + +## --- Postal address --- + +## 3GPP support office address --- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## Internet --- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Abbreviations ..... | 11 | +| 4 Reference architecture..... | 12 | +| 5 Signalling Flows for the Policy Framework ..... | 17 | +| 5.0 General ..... | 17 | +| 5.1 AM Policy Association Management ..... | 17 | +| 5.1.1 AM Policy Association Establishment..... | 17 | +| 5.1.2 AM Policy Association Modification..... | 20 | +| 5.1.2.1 AM Policy Association Modification initiated by the AMF ..... | 20 | +| 5.1.2.1.1 AM Policy Association Modification initiated by the AMF without AMF relocation ..... | 20 | +| 5.1.2.1.2 AM Policy Association Modification with old PCF during AMF relocation ..... | 21 | +| 5.1.2.2 AM Policy Association Modification initiated by the PCF..... | 23 | +| 5.1.3 AM Policy Association Termination..... | 24 | +| 5.1.3.1 AM Policy Association Termination initiated by the AMF ..... | 24 | +| 5.1.3.2 AM Policy Association Termination initiated by the PCF ..... | 25 | +| 5.2 SM Policy Association Management..... | 27 | +| 5.2.1 SM Policy Association Establishment..... | 27 | +| 5.2.2 SM Policy Association Modification ..... | 31 | +| 5.2.2.1 General..... | 31 | +| 5.2.2.2 SM Policy Association Modification initiated by the PCF..... | 31 | +| 5.2.2.2.1 Interactions between SMF, PCF and CHF ..... | 31 | +| 5.2.2.2.2 Interactions between PCF, AF and UDR ..... | 32 | +| 5.2.2.2.2.1 AF Session Establishment ..... | 32 | +| 5.2.2.2.2.2 AF Session Modification ..... | 34 | +| 5.2.2.2.2.3 AF Session Termination ..... | 36 | +| 5.2.2.2.2.4 AF Request of application detection exposure ..... | 37 | +| 5.2.2.2.2.5 AF Request termination of application detection exposure..... | 38 | +| 5.2.2.3 SM Policy Association Modification initiated by the SMF..... | 39 | +| 5.2.3 SM Policy Association Termination ..... | 44 | +| 5.2.3.1 SM Policy Association Termination initiated by the SMF..... | 44 | +| 5.2.3.2 SM Policy Association Termination initiated by the PCF..... | 47 | +| 5.3 Spending Limit Procedures ..... | 48 | +| 5.3.1 General ..... | 48 | +| 5.3.2 Initial Spending Limit Report Request..... | 48 | +| 5.3.3 Intermediate Spending Limit Report Request ..... | 49 | +| 5.3.4 Final Spending Limit Report Request ..... | 49 | +| 5.3.5 Spending Limit Report ..... | 50 | +| 5.3.6 Subscription termination request by CHF ..... | 51 | +| 5.4 Network Data Analytics Procedures ..... | 51 | +| 5.4.1 General ..... | 51 | +| 5.4.2 NWDAF Discovery and Selection by the PCF ..... | 52 | +| 5.4.3 Policy decisions based on Network Analytics..... | 52 | +| 5.5 Service Capability Exposure Procedures ..... | 54 | +| 5.5.1 General ..... | 54 | +| 5.5.2 Management of Packet Flow Descriptions..... | 55 | +| 5.5.2.1 AF-initiated PFD management procedure ..... | 55 | +| 5.5.2.2 PFD management towards SMF ..... | 56 | +| 5.5.2.2.1 PFD retrieval ..... | 56 | +| 5.5.2.2.2 PFD management ..... | 57 | +| 5.5.3 Traffic influence procedures..... | 58 | + +| | | | +|-----------|-------------------------------------------------------------------------------------|-----| +| 5.5.3.1 | General..... | 58 | +| 5.5.3.2 | AF requests targeting an individual UE address..... | 60 | +| 5.5.3.3 | AF requests targeting PDU Sessions not identified by an UE address..... | 62 | +| 5.5.3.4 | AF request on PDU Sessions supporting HR-SBO ..... | 66 | +| 5.5.4 | Negotiation for future background data transfer procedure ..... | 68 | +| 5.5.4A | Modification of BDT warning notification request indication procedure ..... | 70 | +| 5.5.5 | BDT warning notification procedure..... | 71 | +| 5.5.6 | Background data transfer policy applying procedure..... | 74 | +| 5.5.7 | IPTV configuration provisioning ..... | 76 | +| 5.5.8 | AF-based service parameter provisioning..... | 77 | +| 5.5.8.1 | AF-based service parameter provisioning to HPLMN ..... | 77 | +| 5.5.8.2 | AF-based service parameter provisioning to VPLMN ..... | 80 | +| 5.5.9 | QoS monitoring procedure ..... | 83 | +| 5.5.10 | AF-triggered dynamically changing AM policies ..... | 86 | +| 5.5.10.1 | General..... | 86 | +| 5.5.10.2 | Access and Mobility policy authorization requests targeting an individual UE..... | 86 | +| 5.5.10.3 | AF requests to influence AM policies ..... | 90 | +| 5.5.11 | Procedures for Time Synchronization Exposure ..... | 92 | +| 5.5.11.1 | General..... | 92 | +| 5.5.11.2 | Exposure of UE availability and capabilities for Time Synchronization service ..... | 93 | +| 5.5.11.3 | Time Synchronization service activation, modification, and deactivation ..... | 96 | +| 5.5.11.4 | Management of 5G Access Stratum Time distribution ..... | 101 | +| 5.5.11.5 | Management of network timing synchronization status monitoring ..... | 106 | +| 5.5.12 | Deterministic Networking specific parameter provisioning..... | 107 | +| 5.5.12.1 | General..... | 107 | +| 5.5.12.2 | 5GS DetNet node information reporting ..... | 107 | +| 5.5.12.3 | 5GS DetNet node configuration ..... | 110 | +| 5.5.12.4 | QoS parameter mapping functions at TSCTSF ..... | 111 | +| 5.5.13 | Negotiation for planned data transfer with QoS requirements ..... | 113 | +| 5.5.13A | Modification of PDTQ warning notification request indication procedure ..... | 115 | +| 5.5.14 | PDTQ warning notification procedure ..... | 116 | +| 5.6 | UE Policy Association Management..... | 117 | +| 5.6.1 | UE Policy Association Establishment ..... | 117 | +| 5.6.1.1 | General..... | 117 | +| 5.6.1.2 | Non-roaming..... | 118 | +| 5.6.1.3 | Roaming..... | 122 | +| 5.6.2 | UE Policy Association Modification..... | 125 | +| 5.6.2.1 | UE Policy Association Modification initiated by the AMF ..... | 125 | +| 5.6.2.1.1 | General ..... | 125 | +| 5.6.2.1.2 | Non-roaming ..... | 126 | +| 5.6.2.1.3 | Roaming ..... | 127 | +| 5.6.2.2 | UE Policy Association Modification initiated by the PCF ..... | 129 | +| 5.6.2.2.1 | General ..... | 129 | +| 5.6.2.2.2 | Non-roaming ..... | 130 | +| 5.6.2.2.3 | Roaming ..... | 132 | +| 5.6.3 | UE Policy Association Termination..... | 134 | +| 5.6.3.1 | UE Policy Association Termination initiated by the AMF..... | 134 | +| 5.6.3.1.1 | General ..... | 134 | +| 5.6.3.1.2 | Non-roaming ..... | 135 | +| 5.6.3.1.3 | Roaming ..... | 136 | +| 5.6.3.2 | UE Policy Association Termination initiated by the PCF ..... | 137 | +| 5.6.3.2.1 | General ..... | 137 | +| 5.6.3.2.2 | Non-roaming ..... | 138 | +| 5.6.3.2.3 | Roaming ..... | 139 | +| 5.7 | MBS Policy Association Management ..... | 140 | +| 5.7.1 | General ..... | 140 | +| 5.7.2 | MBS Policy Association Establishment..... | 140 | +| 5.7.3 | MBS Policy Association Modification..... | 143 | +| 5.7.3.1 | General..... | 143 | +| 5.7.3.2 | MBS Policy Association Modification initiated by the AF/NEF/MBSF ..... | 143 | +| 5.7.4 | MBS Policy Association Termination..... | 145 | +| 5.7.4.1 | General..... | 145 | + +| | | | +|-----------|-----------------------------------------------------------------------------|-----| +| 5.7.4.2 | MBS Policy Association Termination initiated by the PCF ..... | 145 | +| 5.7.4.3 | MBS Policy Association Termination initiated by the AF/NEF/MBSF..... | 145 | +| 5.8 | Awareness of URSP Rule Enforcement..... | 146 | +| 5.8.1 | General ..... | 146 | +| 5.8.2 | Forwarding of URSP Rule Enforcement Information ..... | 147 | +| 6 | Binding Mechanism ..... | 148 | +| 6.1 | Overview ..... | 148 | +| 6.2 | Session Binding..... | 149 | +| 6.3 | PCC rule Authorization..... | 150 | +| 6.4 | QoS flow binding ..... | 151 | +| 6.5 | Binding mechanism in MBS deployments..... | 153 | +| 6.5.1 | MBS Session Binding..... | 153 | +| 6.5.2 | MBS PCC rule Authorization for an MBS session ..... | 153 | +| 6.5.3 | MBS QoS flow binding within an MBS session ..... | 153 | +| 7 | QoS Parameters Mapping ..... | 154 | +| 7.1 | Overview ..... | 154 | +| 7.2 | QoS parameter mapping Functions at AF ..... | 156 | +| 7.2.1 | Introduction ..... | 156 | +| 7.2.2 | AF supporting Rx interface ..... | 156 | +| 7.2.3 | AF supporting N5 interface ..... | 156 | +| 7.3 | QoS parameter mapping Functions at PCF ..... | 169 | +| 7.3.1 | Introduction ..... | 169 | +| 7.3.2 | PCF Interworking with an AF supporting Rx interface ..... | 169 | +| 7.3.3 | PCF Interworking with an AF supporting N5 interface ..... | 177 | +| 7.4 | QoS parameter mapping Functions at SMF ..... | 186 | +| 7.4.1 | QoS parameter mapping Functions in 5GC..... | 186 | +| 7.4.2 | QoS parameter mapping Functions at SMF+PGW-C for interworking scenario..... | 187 | +| 7.5 | QoS Parameters Mapping in MBS deployments..... | 187 | +| 7.5.1 | Introduction ..... | 187 | +| 7.5.2 | QoS parameter mapping Functions at PCF ..... | 187 | +| 7.5.3 | QoS parameter mapping Functions at MB-SMF ..... | 191 | +| 8 | PCF addressing ..... | 192 | +| 8.1 | General ..... | 192 | +| 8.2 | PCF discovery and selection by the AMF..... | 192 | +| 8.3 | PCF discovery and selection by the SMF ..... | 194 | +| 8.4 | PCF discovery and selection by the AF ..... | 195 | +| 8.4.1 | General ..... | 195 | +| 8.4.2 | Binding Support Function (BSF)..... | 195 | +| 8.4.3 | Void ..... | 196 | +| 8.4A | PCF for a PDU session discovery and selection by the PCF for a UE ..... | 196 | +| 8.5 | BSF procedures ..... | 197 | +| 8.5.1 | General ..... | 197 | +| 8.5.2 | Binding information Creation..... | 197 | +| 8.5.3 | Binding information Deletion..... | 198 | +| 8.5.4 | Binding information Retrieval..... | 198 | +| 8.5.5 | Proxy BSF ..... | 199 | +| 8.5.5.1 | General ..... | 199 | +| 8.5.5.2 | Rx Session Establishment..... | 199 | +| 8.5.5.3 | Rx Session Modification..... | 199 | +| 8.5.5.3.1 | AF-initiated ..... | 199 | +| 8.5.5.3.2 | PCF-initiated ..... | 200 | +| 8.5.5.4 | Rx Session Termination..... | 200 | +| 8.5.5.4.1 | AF-initiated ..... | 200 | +| 8.5.5.4.2 | PCF-initiated ..... | 201 | +| 8.5.6 | Redirect BSF ..... | 201 | +| 8.5.6.1 | General..... | 201 | +| 8.5.6.2 | Rx Session Establishment..... | 202 | +| 8.5.7 | Binding information Update..... | 202 | +| 8.5.8 | Binding information Subscription ..... | 203 | +| 8.5.9 | Binding information Unsubscription ..... | 203 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------------------|------------| +| 8.5.10 | Binding information Notification ..... | 204 | +| 8.6 | PCF discovery and selection procedures in MBS deployments..... | 204 | +| 8.6.1 | PCF discovery and selection by the MB-SMF ..... | 204 | +| 8.6.2 | PCF discovery and selection by the AF/NEF/MBSF ..... | 204 | +| 8.6.2.1 | General..... | 204 | +| 8.6.2.2 | Binding Support Function (BSF)..... | 205 | +| 8.6.3 | BSF procedures ..... | 205 | +| 8.6.3.1 | General..... | 205 | +| 8.6.3.2 | Binding information Creation..... | 206 | +| 8.6.3.3 | Binding information Update ..... | 206 | +| 8.6.3.4 | Binding information Deletion..... | 207 | +| 8.6.3.5 | Binding information Retrieval..... | 207 | +| 9 | Race condition handling..... | 207 | +| 9.1 | Overview ..... | 207 | +| 9.2 | Procedures ..... | 208 | +| Annex A (informative): | DRA and BSF coexistence ..... | 210 | +| Annex B (normative): | Signalling Flows for IMS..... | 210 | +| B.1 | General..... | 210 | +| B.2 | IMS Session Establishment..... | 211 | +| B.2.1 | Provisioning of service information at Originating P-CSCF and PCF ..... | 211 | +| B.2.2 | Provisioning of service information at terminating P-CSCF and PCF ..... | 216 | +| B.3 | IMS Session Modification ..... | 221 | +| B.3.1 | Provisioning of service information..... | 221 | +| B.3.2 | Enabling of IP Flows..... | 227 | +| B.3.3 | Disabling of IP Flows..... | 228 | +| B.3.4 | Media Component Removal..... | 229 | +| B.4 | IMS Session Termination..... | 230 | +| B.4.1 | Mobile initiated session release / Network initiated session release..... | 230 | +| B.4.2 | QoS Flow Release/Loss ..... | 232 | +| B.5 | Subscription to Notification of Signalling Path Status at IMS Registration..... | 232 | +| B.6 | Provisioning of SIP signalling flow information at IMS Registration..... | 234 | +| B.7 | Subscription to Notification of Change of Access Type at IMS Registration ..... | 235 | +| B.8 | Subscription to Notification of Change of PLMN Identifier at IMS Registration..... | 236 | +| B.9 | P-CSCF Restoration..... | 237 | +| B.10 | IMS Restricted Local Operator Services ..... | 238 | +| B.11 | Retrieval of Network Provided Location Information for SMS over IP at Originating side..... | 238 | +| B.12 | Retrieval of Network Provided Location Information for SMS over IP at Terminating side ..... | 240 | +| Annex C (informative): | Guidance for underlay network to support QoS differentiation for User Plane IPsec Child SA..... | 241 | +| C.1 | Access to PLMN services via SNPN and access to SNPN services via PLMN..... | 241 | +| C.2 | QoS differentiation support in the underlay network for overlay services ..... | 241 | +| C.3 | Guidelines for QoS requirements to/from DSCP mapping..... | 242 | +| C.4 | Network initiated QoS modification..... | 243 | +| C.5 | UE initiated QoS modification..... | 244 | +| Annex D (informative): | Change history..... | 247 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present document specifies detailed call flows of Policy and Charging Control (PCC) over the Npcf, Nsmf, Namf, Nudr, Nnef, Nchf, Nbsf, Nnwdaf and Nmbsmf service-based interfaces and their relationship with the flow level signalling in 5G system. + +NOTE: The call flows depicted in this Technical Specification do not cover all traffic cases. + +The stage 2 definition and procedures of PCC are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +The stage 2 definition and procedures of PCC for 5G multicast/broadcast services are contained in 3GPP TS 23.247 [54]. + +Detailed stage 3 procedures are provided in 3GPP TS 29.507 [7], 3GPP TS 29.508 [8], 3GPP TS 29.512 [9], 3GPP TS 29.514 [10], 3GPP TS 29.520 [11], 3GPP TS 29.519 [12], 3GPP TS 29.521 [22], 3GPP TS 29.594 [23], 3GPP TS 29.522 [24], 3GPP TS 29.551 [25], 3GPP TS 29.525 [31], 3GPP TS 29.554 [26] and 3GPP TS 29.537 [55]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The present specification also describes the PCC reference architectures for non-roaming and roaming scenarios in 5G system. + +The present specification also describes the mapping of QoS parameters at AF, PCF, SMF and MB-SMF. + +The present specification also describes the session binding at PCF, and the QoS flow binding at SMF and MB-SMF. + +The present specification also describes the PCF addressing. + +The present specification also describes the Race condition handling. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [8] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [9] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". + +- [10] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [11] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". + +- [12] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository Service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [13] Void +- [14] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [15] 3GPP TS 29.201: "Representational State Transfer (REST) reference point between Application Function (AF) and Protocol Converter (PC)". +- [16] IETF RFC 4566: "SDP: Session Description Protocol". +- [17] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS) Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [18] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [19] 3GPP TS 26.234: "End-to-end transparent streaming service; Protocols and codecs". +- [20] 3GPP2 C.S0046-0 v1.0: "3G Multimedia Streaming Services". +- [21] 3GPP2 C.S0055-A v1.0: "Packet Switched Video Telephony Services (PSVT/MCS)". +- [22] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [23] 3GPP TS 29.594: "5G System; Spending Limit Control Service; Stage 3". +- [24] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [25] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [26] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [27] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [28] 3GPP TS 32.240: "Charging management; Charging architecture and principles". +- [29] IETF RFC 6733: "Diameter Base Protocol". +- [30] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [31] 3GPP TS 29.525: "UE Policy Control Service; Stage 3". +- [32] 3GPP TS 29.518: "Access and Mobility Management Services; Stage 3". +- [33] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [34] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)".Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [35] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [36] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [37] IETF RFC 3890: "A Transport Independent Bandwidth Modifier for the Session Description Protocol (SDP)". +- [38] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [39] IETF RFC 4145: "TCP-Based Media Transport in the Session Description Protocol (SDP)". +- [40] IETF RFC 4975: "The Message Session Relay Protocol (MSRP)". + +- [41] 3GPP TS 24.229: " IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [42] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [43] IETF RFC 3264: "An Offer/Answer model with the Session Description Protocol (SDP)". +- [44] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [45] 3GPP TS 23.380: "IMS Restoration Procedures". +- [46] 3GPP TS 23.221: "Architectural requirements". +- [47] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository Service for Subscription Data; Stage 3". +- [48] 3GPP TS 29.552: "5G System; Network Data Analytics signalling follows; Stage 3". +- [49] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [50] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". +- [51] 3GPP TS 29.510: "5G System; Network function repository services; Stage 3". +- [52] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [53] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [54] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [55] 3GPP TS 29.537: "5G System; Multicast/Broadcast Policy Control Services; Stage 3". +- [56] 3GPP TS 29.564: "5G System; User Plane Function Services; Stage 3". +- [57] 3GPP TS 23.548: "5G System Enhancements for Edge Computing; Stage 2". +- [58] 3GPP TS 29.532: "5G System; 5G Multicast-Broadcast Session Management Services; Stage 3". +- [59] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane of EPC Nodes". +- [60] 3GPP TS 29.565: "5G System; Time Sensitive Communication and Time Synchronization Function services; Stage 3". +- [61] 3GPP TS 29.503: "5G System; Unified Data Management services; Stage 3". +- [62] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [63] IETF RFC 8655: "Deterministic Networking Architecture". +- [64] IETF draft-ietf-detnet-yang: "Deterministic Networking (DetNet) YANG Model". + +**Editor's note:** The above document cannot be formally referenced until it is published as an RFC. + +- [65] IETF RFC 6241: "Network Configuration Protocol (NETCONF)". +- [66] IETF RFC 8040: "RESTCONF Protocol". +- [67] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [68] 3GPP TS 29.543: "5G System; Data Transfer Policy Control Services; Stage 3". +- [69] IETF RFC 8864: "Negotiation Data Channels Using the Session Description Protocol (SDP)" + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.501 [2], clause 3.1 apply: + +### **Onboarding Standalone Non-Public Network** + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|----------|-----------------------------------------------------------------------------| +| 5GC | 5G Core Network | +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5QI | 5G QoS Identifier | +| 5G VN | 5G Virtual Network | +| A2X | Aircraft-to-Everything | +| A2XP | Aircraft-to-Everything Policy | +| AF | Application Function | +| AMBR | Aggregate Maximum Bit Rate | +| AMF | Access and Mobility Management Function | +| ARP | Allocation and Retention Priority | +| AW | Average Window | +| BDT | Background Data Transfer | +| BSF | Binding Support Function | +| CHEM | Coverage and Handoff Enhancements using Multimedia error robustness feature | +| CHF | Charging Function | +| DetNet | Deterministic Networking | +| DSCP | Differentiated Services Code Point | +| DN-AAA | Data Network Authentication, Authorization and Accounting | +| DTS | Data Transport Service | +| EPC | Evolved Packet Core | +| EPS | Evolved Packet System | +| E-UTRAN | Evolved Universal Terrestrial Radio-Access Network | +| LBO | Local Breakout | +| MBR | Maximum Bitrate | +| MBS | Multicast/Broadcast Service | +| MBSF | Multicast/Broadcast Service Function | +| MB-SMF | Multicast/Broadcast Session Management Function | +| MCS | Mission Critical Service | +| MME | Mobility Management Entity | +| MPD | Media Presentation Description | +| MPS | Multimedia Priority Service | +| MTU | Maximum Transmission Unit | +| NEF | Network Exposure Function | +| NID | Network Identifier | +| NPLI | Network Provided Location Information | +| NRF | Network Repository Function | +| NSSAI | Network Slice Selection Assistance Information | +| NWDAF | Network Data Analytics Function | +| ON-SNPN | Onboarding Standalone Non-Public Network | +| PCC | Policy and Charging Control | + +| | | +|---------|-------------------------------------------------------| +| PCF | Policy Control Function | +| PDB | Packet Delay Budget | +| PDTQ | Planned Data Transfer with QoS requirements | +| PDUID | ProSe Discovery UE ID | +| PER | Packet Error Rate | +| PFD | Packet Flow Description | +| PFD | Packet Flow Description Function | +| PMIC | Port Management Information Container | +| PL | Priority Level | +| ProSe | Proximity Services | +| ProSeP | 5G ProSe Policy | +| PSA | PDU Session Anchor | +| PSAP | Public Safety Access Point | +| P-CSCF | Proxy Call Session Control Function | +| QFI | QoS Flow Identifier | +| QNC | QoS Notification Control | +| QoS | Quality of Service | +| SCP | Service Communication Proxy | +| SDP | Session Description Protocol | +| SEPP | Security Edge Protection Proxy | +| SFC | Service Function Chain | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SNPN | Stand-alone Non-Public Network | +| SPI | Security Parameter Index | +| TNAP | Trusted Network Access Point | +| TA | Tracking Area | +| TSC | Time Sensitive Communication | +| TSCAI | Time Sensitive Communication Assistance Information | +| TSN | Time Sensitive Networking | +| UDR | Unified Data Repository | +| UL CL | UpLink Classifier | +| UMIC | User plane node Management Information Container | +| UPF | User Plane Function | +| UPSI | UE policy section identifier | +| URSP | UE Route Selection Policy | +| V2X | Vehicle-to-Everything | +| V2XP | Vehicle-to-Everything Policy | +| HR-SBO | Home Routed-Session BreakOut | +| RSLPP | Ranging and sidelink positioning policy | + +# 4 Reference architecture + +The policy framework functionality in 5G is comprised of the functions of the Policy Control Function (PCF), the policy and charging enforcement functionality supported by the SMF and UPF, the access and mobility policy enforcement functionality supported by the AMF, the Network Data Analytics Function (NWDAF), the Network Exposure Function (NEF), the Charging Function (CHF), the Unified Data Repository (UDR), the Time Sensitive Communication and Time Synchronization Function (TSCTSF), the Application Function (AF) and the 5G Direct Discovery Name Management Function (5G DDNMF). + +The policy framework functionality for multicast-broadcast services in 5G is comprised of the functions of the Policy Control Function (PCF), the Multicast/Broadcast Service Function (MBSF), the Multicast-Broadcast Session Management Function (MB-SMF), the Network Exposure Function (NEF), the Unified Data Repository (UDR) and the Application Function (AF). + +For the roaming scenario, the Security Edge Protection Proxy (SEPP) is deployed between the V-PCF and H-PCF. 3GPP TS 23.503 [4] specifies the 5G policy framework stage 2 functionality. + +![Figure 4.1-1a: Overall non-roaming 5G Policy framework architecture (service based representation).](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +This diagram illustrates the service-based representation of the 5G Policy framework architecture. At the top, seven Network Functions (NFs) are shown: NEF, UDR, PCF, AF, TSCTSF, NWDAF, and CHF. Each NF is connected to a central Service Based Interface (SBI) via a specific service-based reference point: Nnef, Nudr, Npcf, Naf, Ntsctsf, Nnwdaf, and Nchf respectively. Below the SBI, five more NFs are connected to it: AMF (via Namf), SMF (via Nsmf), MB-SMF (via Nmbsmf), MBSF (via Nmbf), and 5G DDNMF (via N5g-ddnmf). Further connections are shown between these NFs: SMF connects to UPF via N4; MB-SMF connects to MB-UPF via N4mb; MBSF connects to MBSTF via Nmb2. Additionally, UPF connects to MB-UPF via N19mb, and MB-UPF connects to MBSTF via Nmb9. + +Figure 4.1-1a: Overall non-roaming 5G Policy framework architecture (service based representation). + +Figure 4.1-1a: Overall non-roaming 5G Policy framework architecture (service based representation) + +![Figure 4.1-1b: Overall non-roaming 5G Policy framework architecture (reference point representation).](f76f0f5dfff2511b51f6b875867c029f_img.jpg) + +This diagram illustrates the reference point representation of the 5G Policy framework architecture. At the top, a horizontal line represents the N85 reference point. Below it, another horizontal line represents the N86 reference point. The NFs are connected to these lines as follows: UDR to N86 via N36; TSCTSF to N86 via N84; AF to N86 via N5; NWDAF to N86 via N23; NEF to N86 via N30; CHF to N86 via N29 and N40. Below N86 is the PCF. Connections to the PCF are: UDR via N43; TSCTSF via N84; AF via N5; NWDAF via N23; NEF via N30; CHF via N28 and N40. Below the PCF, several other NFs are connected via their respective reference points: MBSF via Nmb12; MB-SMF via N7mb; 5G DDNMF via Npd; AMF via N15; SMF via N7. Further connections include: MBSF to MBSTF via Nmb2; MB-SMF to MB-UPF via N4mb; SMF to UPF via N4. Finally, MBSTF connects to MB-UPF via N19mb, and MB-UPF connects to UPF via Nmb9. + +Figure 4.1-1b: Overall non-roaming 5G Policy framework architecture (reference point representation). + +Figure 4.1-1b: Overall non-roaming 5G Policy framework architecture (reference point representation) + +NOTE 1: The N4, N4mb, Nmb2, Nmb9 and N19mb interfaces are not part of the Policy Framework architecture but shown in the figures for completeness. + +NOTE 2: If an SCP is deployed it can be used for indirect communication between NFs and NF services as described in Annex E of 3GPP TS 23.501 [2]. + +NOTE 3: MB-SMF, MBSTF, MB-UPF and MBSF apply only when the MBS PCC Architecture as described in 3GPP TS 23.247 [54] is deployed. In this case only the entities shown in that architecture are applicable. + +The AF trusted by the operator interacts with the PCF via the N5 reference point. In the case of an untrusted AF, the AF interacts with the PCF via the NEF. The NEF interacts with the PCF via the N30 reference point in the same way that the AF interacts with the PCF via the N5 reference point. + +The Nchf service for online and offline charging consumed by the SMF is defined in 3GPP TS 32.240 [28]. + +The Nchf service for Spending Limit Control consumed by the PCF is defined in 3GPP TS 29.594 [23]. + +The PCF providing session management policy control for a UE (i.e. PCF for the PDU Session) and the PCF providing non-session management policy control for that UE (i.e. PCF for the UE) may be different PCF instances and the communication between the PCF for the UE and the PCF for the PDU Session is performed over the N43 reference point. + +NOTE 3: The roaming scenarios for SNPNS are not supported in this Release. + +![Figure 4.1-2a: Overall roaming policy framework architecture - LBO (service based representation).](1d27fed9c01eb99f6535283f35fe3bbf_img.jpg) + +This diagram illustrates the service-based representation of the overall roaming policy framework architecture. It is divided into two main domains by a vertical dashed line: VPLMN (Visited PLMN) on the left and HPLMN (Home PLMN) on the right. In the VPLMN, the NEF, NWDAF, AF, and V-PCF are connected to a common service interface. The NEF connects via Nnef, NWDAF via Nnwdaf, AF via Naf, and V-PCF via Npcf. Below this interface, the AMF connects via Namf and the SMF connects via Nsmf. The SMF is further connected to the UPF via the N4 interface. The V-PCF connects to the vSEPP, which in turn connects to the hSEPP via the N32 interface. In the HPLMN, the hSEPP connects to the H-PCF via Npcf and to the UDR via Nudr. + +Figure 4.1-2a: Overall roaming policy framework architecture - LBO (service based representation). + +Figure 4.1-2a: Overall roaming policy framework architecture - LBO (service based representation) + +![Figure 4.1-2b: Overall roaming policy framework architecture - LBO (reference point representation).](5d76c2e9976aaf97001ee189908830fb_img.jpg) + +This diagram illustrates the reference point representation of the overall roaming policy framework architecture. It is divided into two main domains by a vertical dashed line: VPLMN (Visited PLMN) on the left and HPLMN (Home PLMN) on the right. In the VPLMN, the NEF, AF, and NWDAF are connected to the V-PCF via N30, N5, and N23 interfaces respectively. The V-PCF is connected to the AMF via N15 and to the SMF via N7. The SMF is connected to the UPF via the N4 interface. The V-PCF connects to the H-PCF in the HPLMN via the N24 interface. The H-PCF is connected to the UDR via the N36 interface. + +Figure 4.1-2b: Overall roaming policy framework architecture - LBO (reference point representation). + +Figure 4.1-2b: Overall roaming policy framework architecture - LBO (reference point representation) + +NOTE 4: In the LBO scenario, the PCF in the VPLMN may interact with the AF in order to generate PCC rules for services delivered via the VPLMN. The PCF in the VPLMN uses locally configured policies according to the roaming agreement with the HPLMN operator as input for PCC rule generation. The PCF in VPLMN has no access to subscriber policy information from the HPLMN nor to session management policy data for the UE in the VPLMN to retrieve input for PCC Rule generation. The interactions between the PCF in the VPLMN and the PCF in the HPLMN through the Npcf service based interface enables the PCF in the HPLMN to provision UE policies to the PCF in the VPLMN, as described in 3GPP TS 23.503 [4] clause 5.2.5. + +NOTE 5: In the LBO scenario, AF requests targeting a DNN (and slice) and / or a group of UEs are stored in the UDR by the NEF. The PCF in the VPLMN subscribes to and get notification from the UDR in the VPLMN for those AF requests. Details are defined in clause 5.6.7 of 3GPP TS 23.501 [2]. + +NOTE 6: For the sake of clarity, SEPPs are not depicted in the roaming reference point architecture figures. + +NOTE 7: N4 and N32 are not service based interfaces. + +NOTE 8: The Home Routed PDU sessions are not supported for TSC networks in this Release. + +![Diagram of Overall roaming policy framework architecture - home routed scenario (service based representation).](9791722d75115ddcc599b07d7bc35d73_img.jpg) + +The diagram illustrates the overall roaming policy framework architecture for a home routed scenario, divided into two network domains: VPLMN (Visited PLMN) and HPLMN (Home PLMN), separated by a dashed vertical line. In the VPLMN, the AMF is connected to the V-PCF via the Namf interface. The V-PCF is connected to the vSEPP via the Npcf interface. The vSEPP is connected to the hSEPP via the N32 interface. In the HPLMN, the hSEPP is connected to the SMF via the Nsmf interface. The SMF is connected to the UPF via the N4 interface. The SMF is also connected to the AF, NEF, H-PCF, UDR, CHF, and NWDAF via the Nsmf interface. The AF is connected to the NEF via the Naf interface. The NEF is connected to the H-PCF via the Nnef interface. The H-PCF is connected to the UDR via the Npcf interface. The UDR is connected to the CHF via the Nudr interface. The CHF is connected to the NWDAF via the Nchf interface. The NWDAF is connected to the SMF via the Nnwdaf interface. + +Diagram of Overall roaming policy framework architecture - home routed scenario (service based representation). + +**Figure 4.1-3a: Overall roaming policy framework architecture - home routed scenario (service based representation)** + +![Figure 4.1-3b: Overall roaming policy framework architecture - home routed scenario (reference point representation).](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates the overall roaming policy framework architecture for a home routed scenario. It is divided into two main domains by a vertical dashed line: VPLMN (Visited PLMN) on the left and HPLMN (Home PLMN) on the right. + +- VPLMN:** Contains the AMF (Access and Management Function) and V-PCF (Visited Policy Control Function). The AMF is connected to the V-PCF via the N15 interface. +- HPLMN:** Contains the UPF (User Plane Function), SMF (Session Management Function), H-PCF (Home Policy Control Function), NWDAF (Network Data Analytics Function), UDR (Unified Data Repository), AF (Application Function), NEF (Network Exposure Function), and CHF (CHF). The UPF is connected to the SMF via the N4 interface. The SMF is connected to the H-PCF via the N7 interface. The H-PCF is connected to the NWDAF via the N23 interface, to the UDR via the N36 interface, to the AF via the N5 interface, to the NEF via the N30 interface, and to the CHF via the N29 interface. The CHF is also connected to the SMF via the N28 interface and to the H-PCF via the N40 interface. The V-PCF is connected to the H-PCF via the N24 interface. + +Figure 4.1-3b: Overall roaming policy framework architecture - home routed scenario (reference point representation). + +**Figure 4.1-3b: Overall roaming policy framework architecture - home routed scenario (reference point representation)** + +NOTE 9: For the sake of clarity, SEPPs are not depicted in the roaming reference point architecture figures. + +NOTE 10: N4 and N32 are not service based interfaces. + +NOTE 11: An SCP can be used for indirect communication between NFs and NF services within the VPLMN, within the HPLMN, or in within both VPLMN and HPLMN. For simplicity, the SCP is not shown in the roaming architecture. + +NOTE 12: Non-roaming architecture, local breakout roaming architecture and home-routed roaming architecture for interworking between 5GS and EPS are defined in 3GPP TS 23.501 [2]. The signalling flows described in clause 5 apply to this scenario by replacing SMF by the SMF+PGW-C and with the differences applicable to EPC as described in Annex B.3 of 3GPP TS 29.512 [9]. + +To allow the 5G system to interwork with AFs related to existing services, e.g. IMS based services, Mission Critical Push To Talk services, the PCF shall support the corresponding Rx procedures and requirements defined in 3GPP TS 29.214 [18]. This facilitates the migration from EPC to 5GC without requiring these AFs to upgrade to support the N5 interface. + +![Figure 4.1-4: Interworking between 5G Policy framework and AFs supporting Rx interface.](7affafe7362a2d2d072e9d4bf515f0bb_img.jpg) + +The diagram shows the interworking between the 5G Policy framework and AFs supporting the Rx interface. It consists of two rectangular boxes: PCF (Policy Control Function) on the left and AF (Application Function) on the right. They are connected by a horizontal line labeled 'Rx'. + +Figure 4.1-4: Interworking between 5G Policy framework and AFs supporting Rx interface. + +**Figure 4.1-4: Interworking between 5G Policy framework and AFs supporting Rx interface** + +To support Deterministic Networking, the TSCTSF offers RESTCONF (IETF RFC 8040 [66]) and/or NETCONF (IETF RFC 6241 [65]) interfaces to access to the schema defined by the 3GPP Extended Deterministic Networking (DetNet) YANG Model specified in 3GPP TS 29.565 [60] (extension of IETF draft-ietf-detnet-yang [64]), to enable the provisioning of configuration and operation data for DetNet flows. The 5G System is integrated with the Deterministic Network as defined in IETF RFC 8655[63] as a logical DetNet transit router (see 3GPP TS 23.501 [2], clause 4.4.8.4). The TSCTSF performs mapping in the control plane between the 5GS internal functions and the DetNet controller. + +![Diagram showing the interworking between TSCTSF and DetNet controller. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the boxes is the text '3GPP Extended DetNet YANG Model over RESTCONF/NETCONF'.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +3GPP Extended DetNet YANG Model +over RESTCONF/NETCONF + +``` +graph LR; TSCTSF[TSCTSF] --- DetNet[DetNet controller]; +``` + +Diagram showing the interworking between TSCTSF and DetNet controller. A box labeled 'TSCTSF' is connected by a horizontal line to a box labeled 'DetNet controller'. Above the boxes is the text '3GPP Extended DetNet YANG Model over RESTCONF/NETCONF'. + +**Figure 4.1-5: Interworking between TSCTSF and DetNet controller to support Deterministic Networking.** + +# 5 Signalling Flows for the Policy Framework + +## 5.0 General + +This clause specifies the detailed call flows for the 5G Policy and Charging Control (PCC). + +Clauses from 5.1 to 5.6 specify the call flows for PCC with no support of 5G multicast-broadcast services. They include the detailed call flows over Npcf, Nsmf, Namf, Nudr, Nnef, Nchf, Nbsf and Nnwdaf service based interfaces and their relationship with the flow level signalling in the 5G system. + +NOTE: Interactions related with Nnwdaf service are not shown in the flows for readability purposes. The PCF can still make policy decisions taking into account network analytics in the applicable flows as described in clause 5.4.3. + +Specific call flows for PCC with support of 5G multicast broadcast services are specified in clause 5.7. + +## 5.1 AM Policy Association Management + +### 5.1.1 AM Policy Association Establishment + +This procedure concerns the following scenarios: + +1. UE initial registration with the network. +2. The AMF re-allocation with PCF change in handover procedure and registration procedure. +3. UE registers with 5GS during the UE moving from EPS to 5GS when there is no existing AM Policy Association. + +![Sequence diagram of AM Policy Association Establishment procedure. Lifelines: AMF, (V-)PCF, CHF, UDR, BSF. The procedure involves: 1. AMF sends Npcf_AMPolicyControl_Create request to (V-)PCF; 2. (V-)PCF sends Nudr_DataRepository_Query request to UDR; 3. UDR sends Nudr_DataRepository_Query response to (V-)PCF; 4. (V-)PCF sends Nudr_DataRepository_Subscribe request to UDR; 5. UDR sends Nudr_DataRepository_Subscribe response to (V-)PCF; 6. (V-)PCF makes a Policy Decision, which includes 6a. Initial/Intermediate Spending Limit Report Retrieval; 7. (V-)PCF sends Npcf_AMPolicyControl_Create response to AMF, which includes 7a. Nbsf_Management_Register request to BSF and 7b. Nbsf_Management_Register response from BSF; 8. AMF deploys Access and Mobility control policy.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant VPCF as (V-)PCF + participant CHF + participant UDR + participant BSF + + Note left of AMF: 8. Deploy Access and Mobility control policy + AMF->>VPCF: 1. Npcf_AMPolicyControl_Create request + VPCF-->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>VPCF: 3. Nudr_DataRepository_Query response + VPCF-->>UDR: 4. Nudr_DataRepository_Subscribe request + UDR-->>VPCF: 5. Nudr_DataRepository_Subscribe response + Note right of VPCF: 6. Policy Decision + Note right of VPCF: 6a. Initial/Intermediate Spending Limit Report Retrieval + VPCF-->>AMF: 7. Npcf_AMPolicyControl_Create response + Note right of VPCF: 7a. Nbsf_Management_Register request + VPCF-->>BSF: 7a. Nbsf_Management_Register request + BSF-->>VPCF: 7b. Nbsf_Management_Register response + +``` + +Sequence diagram of AM Policy Association Establishment procedure. Lifelines: AMF, (V-)PCF, CHF, UDR, BSF. The procedure involves: 1. AMF sends Npcf\_AMPolicyControl\_Create request to (V-)PCF; 2. (V-)PCF sends Nudr\_DataRepository\_Query request to UDR; 3. UDR sends Nudr\_DataRepository\_Query response to (V-)PCF; 4. (V-)PCF sends Nudr\_DataRepository\_Subscribe request to UDR; 5. UDR sends Nudr\_DataRepository\_Subscribe response to (V-)PCF; 6. (V-)PCF makes a Policy Decision, which includes 6a. Initial/Intermediate Spending Limit Report Retrieval; 7. (V-)PCF sends Npcf\_AMPolicyControl\_Create response to AMF, which includes 7a. Nbsf\_Management\_Register request to BSF and 7b. Nbsf\_Management\_Register response from BSF; 8. AMF deploys Access and Mobility control policy. + +**Figure 5.1.1-1: AM Policy Association Establishment procedure** + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +Step 2 - step 5 are not executed in the roaming case. + +1. The AMF receives the registration request from the AN. Based on local policy, the AMF selects to contact the (V-) PCF to create the policy association with the (V-) PCF and to retrieve Access and Mobility control policy. The AMF selects the PCF as described in clause 8.2 and invokes the Npcf\_AMPolicyControl\_Create service operation by sending the HTTP POST request to the "AM Policy Associations" resource as defined in clause 4.2.2 and clause 5.3.2.3.1 of 3GPP TS 29.507 [7]. The request operation provides, but is not limited to, the SUPI and the allowed NSSAI if applicable, and if received from the UDM, the Service Area Restrictions, RFSP index, UE-AMBR, a list of UE-Slice-MBR (s), GPSI and a list of Internal Group Identifiers, and may provide the applicable access type(s), the PEI if received in the AMF, the User Location Information if available, the UE Time Zone if available, Serving Network, the applicable RAT type(s), GUAMI of AMF, alternative or backup address(es) or FQDNs of AMF, trace control and configuration parameters information, etc., as defined in clause 4.2.2.1 of 3GPP TS 29.507 [7]. The request includes a Notification URI to indicate to the PCF where to send a notification when the policy is updated. +2. If the PCF does not have the subscription data, it invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending an HTTP GET request to the "AccessAndMobilityPolicyData" resource as specified in 3GPP TS 29.519 [12]. +3. The UDR sends an HTTP "200 OK" response to the PCF with the requested subscription data and/or application data in the response message body. + +4. The PCF may request notifications from the UDR on changes in the subscription information by invoking Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "PolicyDataSubscriptions" resource as specified in 3GPP TS 29.519 [12]. + +Additionally, if the PCF and the UDR support dynamically changing AM policies, the PCF may subscribe to the UDR using the Nudr\_DataRepository\_Subscribe service operation for notifications about AM Influence data changes by sending an HTTP POST request to the "ApplicationDataSubscriptions" resource as specified in 3GPP TS 29.519 [12]. + +5. The UDR sends an HTTP "201 Created" response to acknowledge the subscription from the PCF. If the PCF subscribed to notifications about AM Influence data with the immediate reporting indication set to "true" and matching AM Influence data exists in the UDR, the UDR includes them in the response as specified in 3GPP TS 29.519 [12]. +6. The (V-)PCF makes the requested policy decision including Access and Mobility control policy information, and may determine applicable Policy Control Request Trigger(s). + - 6a. In non-roaming case, if the PCF determines that the policy decision depends on the status of the policy counters available at the CHF, and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report Retrieval as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF determines that the status of additional policy counters is required, the PCF initiates an Intermediate Spending Limit Report Retrieval as defined in clause 5.3.3. +7. The (V-)PCF sends an HTTP "201 Created" response to the AMF with the determined policies as described in clause 4.2.2 of 3GPP TS 29.507 [7], e.g.: + - Access and Mobility Control Policy including Service Area Restrictions, and/or a RAT Frequency Selection Priority (RFSP) Index; and/or + - Policy Control Request Triggers and related policy information.; +- 7a. The PCF may register to the BSF as the PCF for the UE (i.e. as the PCF that handles the AM Policy Association of this UE) by sending an HTTP POST request to the "PCF for a UE Bindings" resource of the Nbsf\_Management\_Register service as described in clause 4.2.2.3 of 3GPP TS 29.521 [22]. +- 7b. The BSF responds with "201 Created" if the registration of the PCF for the UE was successful. +8. The AMF deploys the Access and Mobility control policy information if received which includes, e.g. storing the Service Area Restrictions, provisioning the Service Area Restrictions to the UE and/or choosing the RFSP index in use and provisioning the chosen RFSP index and Service Area Restrictions to the NG-RAN, if applicable, when the UE is registered in the 3GPP access. + +NOTE 1: The AMF can decide that the RFSP Index in use is the same as the RFSP index authorized by the PCF or can also use configured operator policies, the Allowed NSSAI, the Partially Allowed NSSAI and the UE related context information available at the AMF in its derivation. + +When the feature "RFSPValidityTime" is supported, the PCF provided the RFSP Index value that indicates the EPC/E-UTRAN access is prioritized over 5GS access and a validity time associated to the provided RFSP Index as specified in 3GPP TS 29.507 [7], if the AMF decides to use the RFSP Index received from the PCF, then the AMF provides to the MME both, the received RFSP Index and the received validity time. The validity time indicates the time for which the RFSP Index will be used in the MME after 5GS to EPS mobility. + +NOTE 2: The RFSP validity time indicated by the PCF when the feature "RFSPValidityTime" is supported is used by the MME to allow the UE to stay in EPS during the period of time indicated by the "rfspValTime" attribute as specified in 3GPP TS 29.507 [7] and avoid the potential ping-pong issue between 5GS and EPS (i.e., 5GS keeps sending the UE to EPS based on authorized RFSP Index from PCF, and the EPS keeps sending the UE back to 5GS immediately based on the subscribed RFSP Index). If due to UE mobility the AMF receives from the MME a validity time associated to the RFSP in use, the AMF shall ignore validity time received from the MME. + +NOTE 3: The PCF can reject the AM Policy Association establishment, e.g. the PCF cannot obtain the subscription-related information from the UDR and the PCF cannot make the policy decisions, as described in 3GPP TS 29.519 [12]. In this case, the AMF deploys the Access and Mobility control policy information based on the policy retrieved from the UDM if available or the local configuration. In order to choose the RFSP Index in use, the Allowed NSSAI, the Partially Allowed NSSAI and the UE related context information available at the AMF can also be used. + +### 5.1.2 AM Policy Association Modification + +#### 5.1.2.1 AM Policy Association Modification initiated by the AMF + +##### 5.1.2.1.1 AM Policy Association Modification initiated by the AMF without AMF relocation + +This procedure is performed when a Policy Control Request Trigger condition is met. + +![Sequence diagram for AMF-initiated AM Policy Association Modification without AMF relocation. The diagram shows interactions between AMF, (V-)PCF, CHF, and AF/NEF. The AMF sends a policy control request trigger (1) to the (V-)PCF. The (V-)PCF sends an Npcf_AMPolicyControl_Update request (2) to the AMF. The (V-)PCF makes a policy decision (3). The (V-)PCF sends an Npcf_AMPolicyControl_Update response (4) to the AMF. The (V-)PCF sends an Npcf_AMPolicyAuthorization_Notify request (4a) to the AF/NEF. The AF/NEF sends an Npcf_AMPolicyAuthorization_Notify response (4b) to the (V-)PCF. The AMF deploys the Access and Mobility control policy (5).](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant VPCF as (V-)PCF + participant CHF + participant AFNEF as AF/NEF + + Note left of AMF: 1. A policy control request trigger is triggered + AMF->>VPCF: 2. Npcf_AMPolicyControl_Update request + Note right of VPCF: 3. Policy Decision + Note right of VPCF: 3a. Spending Limit Report Retrieval + VPCF->>AMF: 4. Npcf_AMPolicyControl_Update response + VPCF-->>AFNEF: 4a. Npcf_AMPolicyAuthorization_Notify request + AFNEF-->>VPCF: 4b. Npcf_AMPolicyAuthorization_Notify response + Note left of AMF: 5. Deploy Access and Mobility control policy + +``` + +Sequence diagram for AMF-initiated AM Policy Association Modification without AMF relocation. The diagram shows interactions between AMF, (V-)PCF, CHF, and AF/NEF. The AMF sends a policy control request trigger (1) to the (V-)PCF. The (V-)PCF sends an Npcf\_AMPolicyControl\_Update request (2) to the AMF. The (V-)PCF makes a policy decision (3). The (V-)PCF sends an Npcf\_AMPolicyControl\_Update response (4) to the AMF. The (V-)PCF sends an Npcf\_AMPolicyAuthorization\_Notify request (4a) to the AF/NEF. The AF/NEF sends an Npcf\_AMPolicyAuthorization\_Notify response (4b) to the (V-)PCF. The AMF deploys the Access and Mobility control policy (5). + +**Figure 5.1.2.1.1-1: AMF-initiated AM Policy Association Modification without AMF relocation procedure** + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +1. The AMF detects a Policy Control Request Trigger condition is met or other condition is met, e.g. trace control configuration needs to be updated, as defined in clause 4.2.3.1 of 3GPP TS 29.507 [7]. +2. The AMF invokes the Npcf\_AMPolicyControl\_Update service operation to the (V-) PCF by sending the HTTP POST request to the "Individual AM Policy Association" resource with information on the conditions that have changed. +3. The (V-)PCF stores the information received in step 2 and makes the policy decision. +- 3a. In non-roaming case, if the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending + +Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4. + +4. The (V-)PCF sends an HTTP "200 OK" response to the AMF with the updated Access and Mobility control policy information and/ or the updated Policy Control Request Trigger parameters as described in clause 4.2.3.3 of 3GPP TS 29.507 [7]. +- 4a. If an AF (either directly or via the NEF) has previously subscribed to events for the AF application AM context (e.g. service area restrictions policy change) as described in 3GPP TS 29.534 [50] clause 4.2.5, the PCF checks if reporting is needed based on the policy decision that was made and may send a respective notification using Npcf\_AMPolicyAuthorization\_Notify as defined in 3GPP TS 29.534 [50] clause 4.2.7.2 (in addition, a Nnef\_AMPolicyAuthorization\_Notify request/response may occur between the NEF and the AF if the notification is relayed via the NEF). +- 4b. The AF (either directly or via the NEF) sends an HTTP "204 No Content" response as defined in 3GPP TS 29.534 [50] clause 4.2.7.2. +5. The AMF deploys the Access and Mobility control policy if received, which includes, e.g. storing the Service Area Restrictions, provisioning the Service Area Restrictions to the NG-RAN and UE, and/or choosing the RFSP index in use and provisioning the chosen RFSP index to the NG-RAN, if applicable, when the UE is registered in the 3GPP access, as specified in clause 5.1.1, step 8. + +##### 5.1.2.1.2 AM Policy Association Modification with old PCF during AMF relocation + +This procedure is performed when AMF relocation is performed and the old PCF is selected by the new AMF. + +![Sequence diagram illustrating the AMF-initiated AM Policy Association Modification with old PCF during AMF relocation procedure. The diagram shows interactions between Old AMF, New AMF, (V-)PCF, AF/NEF, and CHF.](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` + +sequenceDiagram + participant Old AMF + participant New AMF + participant VPCF as (V-)PCF + participant AFNEF as AF/NEF + participant CHF + + Note left of Old AMF: 1. UE Context retrieval from old AMF + Note right of New AMF: 2. Decision to establish Policy Association + New AMF-->>VPCF: 3. Npcf_AMPolicyControl_Update Request + Note right of VPCF: 4. Policy decision + Note right of VPCF: 4a. Spending Limit Report Retrieval + VPCF-->>New AMF: 5. Npcf_AMPolicyControl_Update Response + Note right of VPCF: 5a. Npcf_AMPolicyAuthorization_Notify request + VPCF-->>AFNEF: 5a. Npcf_AMPolicyAuthorization_Notify request + Note right of AFNEF: 5b. Npcf_AMPolicyAuthorization_Notify response + AFNEF-->>VPCF: 5b. Npcf_AMPolicyAuthorization_Notify response + Note right of New AMF: 6. Deploy access and mobility control policy + +``` + +Sequence diagram illustrating the AMF-initiated AM Policy Association Modification with old PCF during AMF relocation procedure. The diagram shows interactions between Old AMF, New AMF, (V-)PCF, AF/NEF, and CHF. + +**Figure 5.1.2.1.2-1: AMF-initiated AM Policy Association Modification with old PCF during AMF relocation procedure** + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +1. When the old AMF and the new AMF belong to the same PLMN or equivalent PLMN or belong to the same SNPN or equivalent SNPN, the old AMF transfers to the new AMF about the AM Policy Association information including, e.g. policy control request trigger(s), and the resource URI (i.e. {apiRoot}/npcf-am-policy-control/v1/policies/{polAssoId}) of AM Policy Association at the (V-)PCF). +2. Based on local policies, the new AMF decides to contact with (V-)PCF and update the resource identified by the resource URI received in step 1. +3. The new AMF invokes the Npcf\_AMPolicyControl\_Update service operation to the (V-) PCF by sending the HTTP POST request to the "Individual AM Policy Association" resource with the Notification URI of the new AMF. The request may also include the met policy control request trigger(s) and corresponding information, and the new alternate or backup IP addresses or FQDN. + +When the feature "FeatureRenegotiation" is supported, the HTTP POST request to the "Individual AM Policy Association" resource also contains the features supported by the new AMF and the feature related information, if applicable, as described in clause 4.2.3.4 of 3GPP TS 29.507 [7]. + +4. When the feature "FeatureRenegotiation" is not supported, the (V-)PCF updates the stored information provided by the old AMF with the information provided by the new AMF and makes the policy decision. + +When the feature "FeatureRenegotiation" is supported, and the (V-)PCF received the features supported by the AMF, the (V-)PCF re-evaluates the negotiated features and makes the policy decision considering the resulting negotiated features and the information provided by the new AMF. + +- 4a. In non-roaming case, if the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4. + +When the feature "FeatureRenegotiation" is supported, and the (V-)PCF received the features supported by the AMF, the (V-)PCF re-evaluates the negotiated features and makes the policy decision considering the resulting negotiated features and the information provided by the new AMF. + +5. The PCF sends an HTTP "200 OK" response to the AMF with: + - a. When the feature "FeatureRenegotiation" is not supported, the updated Access and Mobility control policy information and/or the updated Policy Control Request Trigger parameters as described in clause 4.2.3.3 of 3GPP TS 29.507 [7]. + - b. When the feature "FeatureRenegotiation" is supported, the Access and Mobility control policy information and Policy Control Request Triggers corresponding to the complete "Individual AM Policy Association" resource representation together with the negotiated supported features as described in clause 4.2.3.4 of 3GPP TS 29.507 [7]. +- 5a. If an AF (either directly or via the NEF) has previously subscribed to events for the AF application AM context (e.g. service area restrictions policy change) as described in 3GPP TS 29.534 [50] clause 4.2.5, the PCF checks if reporting is needed based on the policy decision that was made and may send a respective notification using Npcf\_AMPolicyAuthorization\_Notify as defined in 3GPP TS 29.534 [50] clause 4.2.7.2 (in addition, a Nnef\_AMPolicyAuthorization\_Notify request/response may occur between the NEF and the AF if the notification is relayed via the NEF). +- 5b. The AF (either directly or via the NEF) sends an HTTP "204 No Content" response as defined in 3GPP TS 29.534 [50] clause 4.2.7.2. +6. The AMF deploys the Access and Mobility control policy if received, which includes, e.g. storing the Service Area Restrictions, provisioning the Service Area Restrictions to the NG-RAN and UE, and/or choosing the RFSP index in use and provisioning the chosen RFSP index to the NG-RAN, if applicable, when the UE is registered in the 3GPP access, as specified in clause 5.1.1, step 8. + +#### 5.1.2.2 AM Policy Association Modification initiated by the PCF + +This procedure is performed when the Access and Mobility control policies are changed. + +![Sequence diagram illustrating the PCF-initiated AM Policy Association Modification procedure. Lifelines: AMF, (V-)PCF, CHF, AF/NEF. The sequence starts with a 'trigger' (1) and 'Spending Limit Report Retrieval' (2a) from (V-)PCF to CHF. Then, (V-)PCF sends a 'Policy Decision' (2) to AMF. AMF sends an 'Npcf_AMPolicyControl_UpdateNotify request' (3) to (V-)PCF, which responds with 'Npcf_AMPolicyControl_UpdateNotify response' (4). (V-)PCF then sends 'Npcf_AMPolicyAuthorization_Notify request' (4a) to AF/NEF, which responds with 'Npcf_AMPolicyAuthorization_Notify response' (4b). Finally, AMF sends a 'Deploy Access and Mobility control policy' (5) to (V-)PCF.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant VPCF as (V-)PCF + participant CHF + participant AFNEF as AF/NEF + + Note right of VPCF: 1. trigger + Note right of VPCF: 2a. Spending Limit Report Retrieval + VPCF->>CHF: 2a. Spending Limit Report Retrieval + Note right of VPCF: 2. Policy Decision + VPCF->>AMF: 2. Policy Decision + AMF->>VPCF: 3. Npcf_AMPolicyControl_UpdateNotify request + VPCF->>AMF: 4. Npcf_AMPolicyControl_UpdateNotify response + Note right of VPCF: 4a. Npcf_AMPolicyAuthorization_Notify request + VPCF->>AFNEF: 4a. Npcf_AMPolicyAuthorization_Notify request + Note right of AFNEF: 4b. Npcf_AMPolicyAuthorization_Notify response + AFNEF->>VPCF: 4b. Npcf_AMPolicyAuthorization_Notify response + Note left of AMF: 5. Deploy Access and Mobility control policy + AMF->>VPCF: 5. Deploy Access and Mobility control policy + +``` + +Sequence diagram illustrating the PCF-initiated AM Policy Association Modification procedure. Lifelines: AMF, (V-)PCF, CHF, AF/NEF. The sequence starts with a 'trigger' (1) and 'Spending Limit Report Retrieval' (2a) from (V-)PCF to CHF. Then, (V-)PCF sends a 'Policy Decision' (2) to AMF. AMF sends an 'Npcf\_AMPolicyControl\_UpdateNotify request' (3) to (V-)PCF, which responds with 'Npcf\_AMPolicyControl\_UpdateNotify response' (4). (V-)PCF then sends 'Npcf\_AMPolicyAuthorization\_Notify request' (4a) to AF/NEF, which responds with 'Npcf\_AMPolicyAuthorization\_Notify response' (4b). Finally, AMF sends a 'Deploy Access and Mobility control policy' (5) to (V-)PCF. + +**Figure 5.1.2.2-1: PCF-initiated AM Policy Association Modification procedure** + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +1. The (V-) PCF receives an external trigger, e.g. the subscriber policy data of a UE is changed or an AF request to influence AM policies has been received, or the (V-)PCF receives an internal trigger, e.g. operator policy is changed, to re-evaluate Access and Mobility control policy for a UE, or optionally in non-roaming cases, if the CHF provides the Spending Limit Report to the PCF as described in clause 5.3.5. +- 2a. In non-roaming case, if the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4 +3. The (V-)PCF invokes the Npcf\_AMPolicyControl\_UpdateNotify service operation by sending the HTTP POST request with "{notificationUri}/update" as the callback URI to the AMF that has previously subscribed, as described in clause 4.2.4.2 of 3GPP TS 29.507 [7]. +4. The AMF sends an HTTP "204 No Content" response the PCF. +- 4a. If an AF (either directly or via the NEF) has previously subscribed to events for the AF application AM context (e.g. service area restrictions policy change) as described in 3GPP TS 29.534 [50] clause 4.2.5, the PCF checks if reporting is needed based on the policy decision that was made and may send a respective notification using Npcf\_AMPolicyAuthorization\_Notify as defined in 3GPP TS 29.534 [50] clause 4.2.7.2 (in addition, a Nnwf\_AMPolicyAuthorization\_Notify request/response may occur between the NEF and the AF if the notification is relayed via the NEF). + +- 4b. The AF (either directly or via the NEF) sends an HTTP "204 No Content" response as defined in 3GPP TS 29.534 [50] clause 4.2.7.2. +5. The AMF deploys the Access and Mobility control policy information if received which includes, e.g. storing the Service Area Restrictions, provisioning the Service Area Restrictions to the UE and/or choosing the RFSP index in use and provisioning the chosen RFSP index and Service Area Restrictions to the NG-RAN, if applicable, when the UE is registered in the 3GPP access, as specified in clause 5.1.1, step 8. + +### 5.1.3 AM Policy Association Termination + +#### 5.1.3.1 AM Policy Association Termination initiated by the AMF + +This procedure is performed when the UE deregisters from the network, when the UE deregisters from 5GS during the UE moving from 5GS to EPS or when the old AMF removes the AM Policy Association during AMF relocation. + +NOTE: The old AMF removes the AM Policy Association during AMF relocation when the old AMF decides that the PCF instance Id is not sent to the new AMF (e.g. inter-AMF mobility with PLMN change, where the new PLMN is not an equivalent PLMN), or when the new AMF indicates to the old AMF that the received AM Policy Association will not be reused. + +![Sequence diagram of AMF-initiated AM Policy Association Termination procedure. Lifelines: AMF, (V-)PCF, CHF, UDR, BSF, AF/NEF. The sequence starts with AMF sending a delete request to (V-)PCF, followed by policy removal and a spending limit report retrieval. Then, (V-)PCF sends a delete response to AMF, followed by unsubscribe and deregister requests to UDR and BSF respectively. Finally, (V-)PCF sends notify and delete requests to AF/NEF, receiving responses in return.](b90144cfbb81a2d610d920240fda689d_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant VPCF as (V-)PCF + participant CHF + participant UDR + participant BSF + participant AFNEF as AF/NEF + + Note left of AMF: 2. Remove Access and Mobility control policy + AMF->>VPCF: 1. Npcf_AMPolicyControl_Delete request + Note right of VPCF: 2a. Spending Limit Report Retrieval + VPCF-->>AMF: 3. Npcf_AMPolicyControl_Delete response + VPCF->>UDR: 4. Nudr_DataRepository_Unsubscribe request + UDR-->>VPCF: 5. Nudr_DataRepository_Unsubscribe response + VPCF->>BSF: 6. Nbsf_Management_Deregister request + BSF-->>VPCF: 7. Nbsf_Management_Deregister response + VPCF->>AFNEF: 8. Npcf_AMPolicyAuthorization_Notify request + AFNEF-->>VPCF: 9. Npcf_AMPolicyAuthorization_Notify response + VPCF->>AFNEF: 10. Npcf_AMPolicyAuthorization_Delete request + AFNEF-->>VPCF: 11. Npcf_AMPolicyAuthorization_Delete response + +``` + +Sequence diagram of AMF-initiated AM Policy Association Termination procedure. Lifelines: AMF, (V-)PCF, CHF, UDR, BSF, AF/NEF. The sequence starts with AMF sending a delete request to (V-)PCF, followed by policy removal and a spending limit report retrieval. Then, (V-)PCF sends a delete response to AMF, followed by unsubscribe and deregister requests to UDR and BSF respectively. Finally, (V-)PCF sends notify and delete requests to AF/NEF, receiving responses in return. + +Figure 5.1.3.1-1: AMF-initiated AM Policy Association Termination procedure + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +Step 4 and step 5 are not executed in the roaming case. + +1. The AMF invokes the Npcf\_AMPolicyControl\_Delete service operation to delete the policy context in the (V-)PCF by sending the HTTP DELETE request to the "Individual AM Policy Association" resource. +2. The AMF removes the UE context for this UE, including the Access and Mobility Control Policy related to the UE, and/or policy control request triggers. +- 2a. In non-roaming cases, if the PCF has previously subscribed to the policy counter status to the CHF and if the PCF determines that the UE Policy Context does not depend on policy counters, it invokes the Final Spending Limit Report procedure defined in clause 5.3.4 to unsubscribe to policy counter status reporting, otherwise the PCF may invoke the Intermediate Spending Limit Report procedure as defined in clause 5.3.3 to modify the list of subscribed policy counters. +3. The (V-)PCF removes the policy context for the UE and sends an HTTP "204 No Content" response to the AMF. +4. The PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe the notification of subscriber policy data modification from the UDR by sending an HTTP DELETE request to the "IndividualPolicyDataSubscription" resource if it has subscribed such notification. The PCF invokes also the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe from notifications about AM Influence data changes at the UDR by sending an HTTP DELETE request to the "IndividualApplicationDataSubscription" resource if it has subscribed such notification. +5. The UDR responds with HTTP "204 No Content" to the PCF. +6. The PCF may also deregister from the BSF as the PCF for the UE (i.e. as the PCF that handles the AM Policy Association of this UE) by sending an HTTP DELETE request to the "Individual PCF for a UE Binding" resource of the Nbsf\_Management\_Deregister service as described in clause 4.2.3.3 of 3GPP TS 29.521 [22]. +7. The BSF responds with "204 No Content" if the deregistration of the PCF for the UE was successful. +8. If there is AF/NEF application AM context associated with the UE, the PCF invokes the Npcf\_AMPolicyAuthorization\_Notify service operation by sending the HTTP POST request with the {termNotifUri} as the callback URI to the AF/NEF to trigger the AF to request the AF application AM context termination. +9. The AF/NEF sends an HTTP "204 No Content" response to the PCF. +10. The AF/NEF invokes the Npcf\_AMPolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application AM Context" resource. +11. The PCF removes the AF application AM session context and sends an HTTP "204 No Content" response to the AF. + +##### 5.1.3.2 AM Policy Association Termination initiated by the PCF + +This procedure is performed when the UDR notifies the PCF that the policy profile is removed or when the PCF decides to terminate the AM Policy Association based on the internal logic, e.g. UE movement triggers a geo-fencing rule. + +![Sequence diagram for PCF-initiated AM Policy Association Termination procedure. Lifelines: AMF, (V-)PCF, UDR. The sequence starts with '1. Policy Data removed' in the UDR. Then '2. Nudr_DataRepository_Notify request' is sent from UDR to (V-)PCF. '3. Nudr_DataRepository_Notify response' is sent from (V-)PCF back to UDR. '4. Policy decision' is made in the (V-)PCF. '5. Npcf_AMPolicyControl_UpdateNotify request' is sent from (V-)PCF to AMF. '6. Npcf_AMPolicyControl_UpdateNotify response' is sent from AMF back to (V-)PCF. Finally, a block labeled '7. Perform step 1-3 and step 8-11 as specified in Figure 5.1.3.1-1' is shown at the bottom.](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant (V-)PCF + participant UDR + Note right of UDR: 1. Policy Data removed + UDR->>(V-)PCF: 2. Nudr_DataRepository_Notify request + (V-)PCF-->>UDR: 3. Nudr_DataRepository_Notify response + Note right of (V-)PCF: 4. Policy decision + (V-)PCF->>AMF: 5. Npcf_AMPolicyControl_UpdateNotify request + AMF-->>(V-)PCF: 6. Npcf_AMPolicyControl_UpdateNotify response + Note left of AMF: 7. Perform step 1-3 and step 8-11 as specified in Figure 5.1.3.1-1 + +``` + +Sequence diagram for PCF-initiated AM Policy Association Termination procedure. Lifelines: AMF, (V-)PCF, UDR. The sequence starts with '1. Policy Data removed' in the UDR. Then '2. Nudr\_DataRepository\_Notify request' is sent from UDR to (V-)PCF. '3. Nudr\_DataRepository\_Notify response' is sent from (V-)PCF back to UDR. '4. Policy decision' is made in the (V-)PCF. '5. Npcf\_AMPolicyControl\_UpdateNotify request' is sent from (V-)PCF to AMF. '6. Npcf\_AMPolicyControl\_UpdateNotify response' is sent from AMF back to (V-)PCF. Finally, a block labeled '7. Perform step 1-3 and step 8-11 as specified in Figure 5.1.3.1-1' is shown at the bottom. + +**Figure 5.1.3.2-1: PCF-initiated AM Policy Association Termination procedure** + +This procedure concerns both roaming and non-roaming scenarios. + +In the non-roaming case the role of the V-PCF is performed by the PCF. For the roaming scenarios, the V-PCF interacts with the AMF. + +Step 1, step 2 and step 3 are not executed in the roaming case or in the case that the PCF decides to terminate the AM Policy Association based on the internal logic. + +1. The subscriber policy control data is removed from the UDR. +2. The UDR invokes the Nudr\_DataRepository\_Notify service operation to notify the PCF that the policy profile is removed if PCF has subscribed such notification by sending the HTTP POST request to the callback URI "{notificationUri}" as specified in 3GPP TS 29.519 [12]. +3. The PCF sends the response to the Nudr\_DataRepository\_Notify service operation. +4. The (V-)PCF decides to terminate the AM Policy Association based on step 2 or an internal trigger, e.g. operator policy is changed, to re-evaluate Access and Mobility control policy for a UE. +5. The (V-)PCF may, depending on operator policies, invoke the Npcf\_AMPolicyControl\_UpdateNotify service operation towards the AMF to notify it of the removal of the Access and Mobility control policy control information by sending an HTTP POST request to the request URI "{notificationUri}/terminate" as described in clause 4.2.4.3 of 3GPP TS 29.507 [7]. + +Alternatively, the (V-)PCF may decide to maintain the Policy Association if a default profile is applied, and then step 4 through 6 are not executed. + +6. The AMF sends an HTTP "204 No Content" response to the PCF. +7. Step 1 through step 3 and step 8 through step 11 as specified in Figure 5.1.3.1-1 are executed with the following difference: + - the AMF removes the policy control request trigger(s) related to the AM policy association, but still keeps the provisioned AM policies and applies them to the UE. + +- Step 8 through step 11 can be issued at any time after step 4. + +## 5.2 SM Policy Association Management + +### 5.2.1 SM Policy Association Establishment + +This clause is applicable if a new SM Policy Association is being established. + +![Sequence diagram showing interactions between SMF, PCF, UDR, CHF, BSF, and PCF for a UE. The diagram includes 18 numbered messages such as Npcf_SMPolicyControl_Create request, Nudr_DataRepository_Query request, Nbsf_Management_Register request, and Npcf_PolicyAuthorization_Notify request.](d3ca266c298aeb34b019960c6c36f187_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + participant UDR + participant CHF + participant BSF + participant PCF_UE as PCF for a UE + + Note left of PCF: 11. Policy decision + + SMF->>PCF: 1. Npcf_SMPolicyControl_Create request + PCF->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>PCF: 3. Nudr_DataRepository_Query response + Note right of PCF: + PCF->>BSF: 4. Nbsf_Management_Register request + BSF-->>PCF: 5. Nbsf_Management_Register response + Note right of PCF: + PCF->>UDR: 6. Nudr_DataRepository_Query request + UDR-->>PCF: 7. Nudr_DataRepository_Query response + PCF->>UDR: 8. Nudr_DataRepository_Subscribe request + UDR-->>PCF: 9. Nudr_DataRepository_Subscribe response + Note right of PCF: 10. Initial/Intermediate Spending Limit Report Retrieval + Note left of PCF: 11. Policy decision + PCF->>UDR: 12. Nudr_DataRepository_Update request + UDR-->>PCF: 13. Nudr_DataRepository_Update response + Note right of PCF: + PCF->>BSF: 14. Nbsf_Management_Register request + BSF-->>PCF: 15. Nbsf_Management_Register response + Note right of PCF: + PCF-->>SMF: 16. Npcf_SMPolicyControl_Create response + PCF->>PCF_UE: 17. Npcf_PolicyAuthorization_Notify request + PCF_UE-->>PCF: 18. Npcf_PolicyAuthorization_Notify response +``` + +Sequence diagram showing interactions between SMF, PCF, UDR, CHF, BSF, and PCF for a UE. The diagram includes 18 numbered messages such as Npcf\_SMPolicyControl\_Create request, Nudr\_DataRepository\_Query request, Nbsf\_Management\_Register request, and Npcf\_PolicyAuthorization\_Notify request. + +###### Figure 5.2.1-1: SM Policy Association Establishment procedure + +This procedure concerns both roaming and non-roaming scenarios. + +In the LBO roaming case, the PCF acts as the V-PCF, and the V-PCF shall not contact the UDR/CHF. In the home routed roaming case, the PCF acts as the H-PCF and the H-PCF interacts with the H-SMF. + +NOTE 1: For LBO roaming case, session management policy data for the UE is not available in the VPLMN and V-PCF uses locally configured information according to the roaming agreement with the HPLMN operator. Therefore, interactions between PCF and UDR in the following procedures do not apply to this scenario. + +1. The SMF receives a PDU session establishment request from the UE. The SMF selects the PCF as described in clause 8.3 and invokes the Npcf\_SMPolicyControl\_Create service operation by sending the HTTP POST request to the "SM Policies" resource as defined in clause 4.2.2.2 of 3GPP TS 29.512 [9]. The request operation provides the needed information within the "SmPolicyContextData" as defined in clause 4.2.2 of 3GPP TS 29.512 [9]. +- 2-3. If "PvsSupport" feature defined in 3GPP TS 29.512 [9] is supported and the Onboarding Indication set to true is received and the combination of the received DNN and S-NSSAI corresponds to a PDU session used for User Plane Remote Provisioning, these steps are skipped. Otherwise, if PCF does not have the subscription data for the SUPI, DNN and S-NSSAI and/or based on operator policies, the PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "SessionManagementPolicyData" resource as specified in 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response to the PCF with the policy control subscription data. +4. If the "ExtendedSamePcf" feature is supported or the "ExtendedSamePcf" feature is not supported and the "SamePcf" feature is supported , and based on operator's policies and retrieved data the PCF determines that the same PCF needs to be used for all the SM Policy associations that match a combination of SUPI, DNN and S-NSSAI, and no SM Policy association for the given combination exists, the PCF invokes the Nbsf\_Management\_Register service operation to check if another PCF exists for the given parameter combination when the conditions as specified in 3GPP TS 29.512 [9], clause 4.2.2.2 are met. +5. If the PCF receives an HTTP "201 Created" response from the BSF with the created binding information as detailed in clause 8.5.2 and the flow continues in step 6. + +If the PCF receives an HTTP "403 Forbidden" response from the BSF, the PCF replies the SMF as described in 3GPP TS 29.512 [9], clause 4.2.2.2 and the flow terminates here. + +- 6-7. If BDT Reference ID(s) is included in the response from the UDR, the PCF shall invoke the Nudr\_DataRepository\_Query service operation to the UDR to retrieve the Background Data Transfer policy corresponding to the BDT Reference ID(s) by sending the HTTP GET request to the "IndividualBdtData" resource or the "BdtData" collection resource with the URI query parameter "bdt-ref-ids" as specified in 3GPP TS 29.519 [12], and the UDR sends an HTTP "200 OK" response to the PCF with the Background Data Transfer policy. + +Additionally, if the TSC feature defined in 3GPP TS 29.512 [9] is supported, the PCF invokes the Nudr\_DataRepository\_Query service operation to retrieve the stored AF influence data in the UDR by sending the HTTP GET request to the "Influence Data" resource as specified in 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response with the stored AF request. + +Additionally, if the ATSSS feature defined in 3GPP TS 29.512 [9] is supported, and the SDF template of the PCC rule includes an application identifier, the PCF invokes the Nudr\_DataRepository\_Query service operation to retrieve the stored OS Id(s) supported by the UE from the UDR by sending the HTTP GET request to the "UePolicySet" resource as specified in 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response with the stored UE Policy data. The PCF determines the application descriptors based on the retrieved OS Id(s), if available, and local configuration, as specified in 3GPP TS 29.512 [9]. + +Additionally, if the WWC feature defined in 3GPP TS 29.512 [9] is supported, the PCF invokes the Nudr\_DataRepository\_Query service operation to retrieve the stored IPTV configuration from the UDR by sending the HTTP GET request to the "IPTV Configurations" resource as specified in 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response with the stored IPTV configuration. The PCF determines Multicast Access Control information (i.e., whether the multicast channel represented by the SDF of the PCC rule is allowed or not) based on the retrieved IPTV configuration as specified in 3GPP TS 29.512 [9]. + +Additionally, when network slice data rate related policy control is supported by the PCF, the PCF may invoke the Nudr\_DataRepository\_Query service operation towards the UDR by sending an HTTP GET request targeting the "SlicePolicyControlData" resource as specified in clause 5.2.12 of 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response to the PCF with the network slice policy control data. + +Additionally, when location dependent policies for trusted non-3GPP access is supported by the PCF as defined in 3GPP TS 29.512 [9], the PCF may invoke the Nudr\_DataRepository\_Query service operation to retrieve the stored list of AF-provided TNAP ID(s) within Service Parameter data from the UDR by sending the HTTP GET request to the "Service Parameter Data" resource as specified in 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response with the stored Service Parameter Data. + +- 8-9. To request notifications from the UDR on changes in the policy data information, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "PolicyDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, if the TSC feature defined in 3GPP TS 29.512 [9] is supported, to request notifications from the UDR on changes in the AF influence data, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "Influence Data Subscription" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, if the WWC feature defined in 3GPP TS 29.512 [9] is supported, to request notifications from the UDR on changes in the IPTV configuration, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "ApplicationDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, when location dependent policies for trusted non-3GPP access is supported by the PCF as defined in 3GPP TS 29.512 [9], to request notifications from the UDR on changes in the list of AF-provided TNAP ID(s) within Service Parameter Data, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "ApplicationDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +10. If the PCF determines that the policy decision depends on the status of the policy counters available at the CHF, and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report Retrieval as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF determines that the status of additional policy counters are required, the PCF initiates an Intermediate Spending Limit Report Retrieval as defined in clause 5.3.3. +11. The PCF makes the policy decision to determine the information provided to the SMF. +- 12-13. If network slice data rate related policy control applies, the (H-)PCF may invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request targeting the "SlicePolicyControlData" resource in order to update the Remaining Maximum Slice Data Rate information. +14. When the "SamePcf" feature is not supported, in the case that the BSF is to be used and that either the IP address/prefix or MAC address is available, the PCF invokes the Nbsf\_Management\_Register service operation by sending HTTP POST request to create the PDU session binding information for a UE in the BSF as detailed in clause 8.5.2. + +When the "SamePcf" feature or the "ExtendedSamePcf" feature is supported, the PCF determines that the same PCF needs to be used for the SM Policy associations of the same DNN, S-NSSAI and SUPI parameter combination, and a SM Policy association already exists for the given parameter combination (i.e., step 4, 5 did not apply) the PCF invokes the Nbsf\_Management\_Register service operation by sending HTTP POST request to create the PDU session binding information for a UE in the BSF as detailed in clause 8.5.2. + +15. The PCF receives an HTTP "201 Created" response from the BSF with the created binding information as detailed in clause 8.5.2. +16. The PCF sends an HTTP "201 Created" response to the SMF with the determined policies as described in clause 4.2.2 of 3GPP TS 29.512 [9]. +17. If the PCF as a PCF for a PDU session receives the callback URI of the PCF for a UE in step 1, the PCF shall send the event of PDU session established to the AF by sending an HTTP POST request to the "{notifUri}/pdu-session" callback URI as defined in clause 4.2.5.22 of 3GPP TS 29.514 [10]. + +18. The PCF for a UE sends an HTTP "204 No Content" response to the PCF. + +### 5.2.2 SM Policy Association Modification + +#### 5.2.2.1 General + +The following procedures concern both roaming and non-roaming scenarios. + +In the LBO roaming case, the PCF acts as the V-PCF, and the V-PCF shall not contact the UDR/CHF. In the home routed roaming case, the PCF acts as the H-PCF and the H-PCF interacts with the H-SMF. + +NOTE 1: For LBO roaming case, session management policy data for the UE is not available in the VPLMN and V-PCF uses locally configured information according to the roaming agreement with the HPLMN operator. Therefore, interactions between PCF and UDR in the following procedures do not apply to this scenario. + +The SM Policy Association Modification procedure may be initiated either by the SMF or by the PCF. + +NOTE 2: The following procedures cover both Npcf\_PolicyAuthorization service operations over the N5 reference point and Rx interactions between AF and PCF. It is assumed that for the interactions between one AF and one PCF, only one of those possibilities is used. For details of Rx interface refer to 3GPP TS 29.214 [18] and for details on the Npcf\_PolicyAuthorization service refer to 3GPP TS 29.514 [10]. + +#### 5.2.2.2 SM Policy Association Modification initiated by the PCF + +##### 5.2.2.2.1 Interactions between SMF, PCF and CHF + +This procedure is performed when the PCF decides to modify policy decisions for a PDU session. + +![Sequence diagram showing interactions between SMF, PCF, CHF, and UDR for PCF-initiated SM Policy Association Modification.](4ba34b7c8f0b8799dc89462e0c71c52c_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + participant CHF + participant UDR + Note right of PCF: 1. Detection that PDU session modification is required + Note right of PCF: 2. Spending Limit Report + Note right of PCF: 3. Policy Decision + PCF->>UDR: 4. Nudr_DataRepository_Update request + UDR-->>PCF: 5. Nudr_DataRepository_Update response + PCF->>SMF: 6. Npcf_SMPolicyControl_UpdateNotify request + SMF-->>PCF: 7. Npcf_SMPolicyControl_UpdateNotify response +``` + +The diagram illustrates the sequence of interactions for a PCF-initiated SM Policy Association Modification. It involves four main entities: SMF, PCF, CHF, and UDR. The process begins with the PCF detecting a need for PDU session modification (Step 1). The PCF then sends a Spending Limit Report to the CHF (Step 2, dashed line). Next, the PCF makes a Policy Decision (Step 3). Following this, the PCF sends a Nudr\_DataRepository\_Update request to the UDR (Step 4). The UDR responds with a Nudr\_DataRepository\_Update response (Step 5, dashed line). Finally, the PCF sends an Npcf\_SMPolicyControl\_UpdateNotify request to the SMF (Step 6), and the SMF responds with an Npcf\_SMPolicyControl\_UpdateNotify response (Step 7). + +Sequence diagram showing interactions between SMF, PCF, CHF, and UDR for PCF-initiated SM Policy Association Modification. + +Figure 5.2.2.2.1-1: Interactions between SMF, PCF and CHF for PCF-initiated SM Policy Association Modification procedure + +1. The PCF receives an internal or external trigger to re-evaluate PCC Rules and policy decision for a PDU Session. Possible external trigger events are described in clause 5.2.2.2.2. + +NOTE: If "QoS Timing\_5G" feature is supported in Npcf\_PolicyAuthorization API, and the AF/NEF request for QoS duration and QoS inactivity interval, the next steps would be repeated until the AF session is terminated as described in clause 5.2.2.2.3. + +In addition, this procedure is triggered by the following cases: + +- The UDR notifies the PCF about a policy data change (e.g. change in MPS EPS Priority, MPS Priority Level, MCS Priority Level and/or IMS Signalling Priority, or change in user profile configuration indicating whether supporting application detection and control). + - The UDR notifies the PCF about application data change (e.g. change in AF influence data or IPTV configuration data). + - The CHF provides a Spending Limit Report to the PCF as described in clause 5.3.5. + - The PCF for the UE provides to the PCF for the PDU session a UE policy container and/or the policy control request triggers that apply to the UE policy association as described in clause 5.6.2.2. +2. If the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4. + 3. The PCF makes a policy decision. The PCF can determine that updated or new policy information need to be sent to the SMF. + - 4-5. If network slice data rate related policy control applies, the (H-)PCF may invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request targeting the "SlicePolicyControlData" resource in order to update the Remaining Maximum Slice Data Rate information. + 6. The PCF invokes the Npcf\_SMPolicyControl\_UpdateNotify service operation by sending the HTTP POST request with "{notificationUri}/update" as the callback URI to the SMF that has previously subscribed. The request operation provides the PDU session ID and the updated policies, as described in clause 4.2.3 of 3GPP TS 29.512 [9]. + 7. The SMF sends an HTTP "200 OK" or HTTP "204 No Content" to the PCF. + +##### 5.2.2.2.2 Interactions between PCF, AF and UDR + +###### 5.2.2.2.2.1 AF Session Establishment + +This procedure is performed when the AF/NEF requests to create an AF application session context for the requested service. + +NOTE 1: The NEF acts as an AF to support the network exposure functionality. + +For the integration with TSC networks the AF represented in the figures is either the TSN AF (integration with IEEE TSN networks) or the TSCTSF (integration with other TSC networks than IEEE TSN). + +![Sequence diagram showing the AF Session Establishment triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves four lifelines: SMF, PCF, AF, and UDR. The process starts with the AF sending an Npcf_PolicyAuthorization_Create request to the PCF. The PCF then sends a Diameter AAR (1a) to the SMF. The PCF stores service information (2). The PCF sends a Nudr_DataRepository_Query request (3) to the UDR, which responds (4). The PCF identifies affected PDU session(s) (5). The PCF sends an Npcf_PolicyAuthorization_Create response (6) to the AF, which includes a Diameter AAA (6a) to the SMF. The PCF sends a Npcf_PolicyAuthorization_Subscribe request (7) to the AF, which responds (8). Finally, the PCF initiates interactions (9) as described in Figure 5.2.2.2.1-1.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant AF + participant UDR + + Note left of SMF: Rx Case + AF->>PCF: 1. Npcf_PolicyAuthorization_Create request + AF->>SMF: 1a. Diameter AAR + Note right of PCF: 2. Store Service Information + PCF-->>UDR: 3. Nudr_DataRepository_Query request + UDR-->>PCF: 4. Nudr_DataRepository_Query response + Note right of PCF: 5. Identify affected PDU session(s) + Note left of SMF: Rx Case + PCF->>AF: 6. Npcf_PolicyAuthorization_Create response + PCF->>SMF: 6a. Diameter AAA + PCF-->>AF: 7. Npcf_PolicyAuthorization_Subscribe request + AF-->>PCF: 8. Npcf_PolicyAuthorization_Subscribe response + Note right of PCF: 9. Interactions in Figure 5.2.2.2.1-1 + +``` + +Sequence diagram showing the AF Session Establishment triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves four lifelines: SMF, PCF, AF, and UDR. The process starts with the AF sending an Npcf\_PolicyAuthorization\_Create request to the PCF. The PCF then sends a Diameter AAR (1a) to the SMF. The PCF stores service information (2). The PCF sends a Nudr\_DataRepository\_Query request (3) to the UDR, which responds (4). The PCF identifies affected PDU session(s) (5). The PCF sends an Npcf\_PolicyAuthorization\_Create response (6) to the AF, which includes a Diameter AAA (6a) to the SMF. The PCF sends a Npcf\_PolicyAuthorization\_Subscribe request (7) to the AF, which responds (8). Finally, the PCF initiates interactions (9) as described in Figure 5.2.2.2.1-1. + +**Figure 5.2.2.2.2.1-1: AF Session Establishment triggers PCF-initiated SM Policy Association Modification procedure** + +1. When the AF receives an internal or external trigger to set-up a new AF session, the AF invokes the Npcf\_PolicyAuthorization\_Create service operation to the PCF as defined in 3GPP TS 29.514 [10] by sending the HTTP POST request to the "Application Sessions" resource. + - 1a. The AF provides the Service Information to the PCF by sending a Diameter AAR for a new Rx Diameter session. +2. The PCF stores the Service Information received in step 1. +- 3-4. If the PCF does not have the subscription data for the SUPI, DNN and S-NSSAI, it invokes the Nudr\_DataRepository\_Query service operation towards the UDR by sending an HTTP GET request to the "SessionManagementPolicyData" resource. The UDR sends an HTTP "200 OK" response to the PCF with the subscription data. + +Additionally, when network slice data rate related policy control is supported by the PCF, the PCF may invoke the Nudr\_DataRepository\_Query service operation towards the UDR by sending an HTTP GET request targeting the "SlicePolicyControlData" resource as specified in clause 5.2.12 of 3GPP TS 29.519 [12]. The UDR sends an HTTP "200 OK" response to the PCF with the network slice policy control data. + +Additionally, if the AF provided a Background Data Transfer Reference ID in step 1 or step 1a and the corresponding transfer policy is not locally stored in the PCF, the PCF sends the HTTP GET request to the "IndividualBdtData" resource. The UDR sends an HTTP "200 OK" response to the PCF with the Background Data Transfer policy. + +If the AF session is for MPS for DTS invocation, the PCF performs MPS subscription checks if and only if requested by the AF as described in clause 4.4.11 of 3GPP TS 29.214 [18] or as described in clause 4.2.2.12.2 of 3GPP TS 29.514 [10]. + +5. The PCF identifies the affected established PDU Session (s) using the information previously received from the SMF and the Service Information received from the AF. +6. The PCF sends an HTTP "201 Created" response to the AF. + - 6a. The PCF sends a Diameter AAA to the AF. +7. The AF may invoke the Npcf\_PolicyAuthorization\_Subscribe service operation by sending the HTTP PUT request to the "Events Subscription" resource to subscribe to events in the PCF. The request includes the events that subscribes and a Notification URI to indicate to the PCF where to send the notification of the subscribed events, as described in clause 4.2.6 of 3GPP TS 29.514 [10]. +8. The PCF sends an HTTP "201 Created" response to the AF. +9. The PCF interacts with SMF according to Figure 5.2.2.2-1. + +###### 5.2.2.2.2.2 AF Session Modification + +This procedure is performed when the AF/NEF requests to update an AF application session context for the requested service. + +NOTE 1: The NEF acts as an AF to support the network exposure functionality. + +For the integration with TSC networks the AF represented in the figures is either the TSN AF (integration with IEEE TSN networks) or the TSCTSF (integration with other TSC networks than IEEE TSN). + +![Sequence diagram showing the AF Session Modification triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves four lifelines: SMF, PCF, AF, and UDR. The process starts with the AF sending an Npcf_PolicyAuthorization_Update request to the PCF. The PCF then sends a Diameter AAR (1a) to the AF. The PCF stores the service information (2) and sends a Nudr_DataRepository_Query request (3) to the UDR. The UDR responds (4). The PCF identifies affected PDU session(s) (5) and sends an Npcf_PolicyAuthorization_Update response (6) to the AF. The PCF also sends a Diameter AAA (6a) to the AF. The PCF sends an Npcf_PolicyAuthorization_(Un)Subscribe request (7) to the AF. The AF responds (8). Finally, the PCF initiates interactions with the SMF (9).](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant AF + participant UDR + + Note left of SMF: Rx Case + AF->>PCF: 1. Npcf_PolicyAuthorization_Update request + PCF->>AF: 1a. Diameter AAR + Note right of SMF: Rx Case + PCF->>PCF: 2. Store Service Information + PCF-->>UDR: 3. Nudr_DataRepository_Query request + UDR-->>PCF: 4. Nudr_DataRepository_Query response + PCF->>PCF: 5. Identify affected PDU session(s) + PCF->>AF: 6. Npcf_PolicyAuthorization_Update response + PCF->>AF: 6a. Diameter AAA + PCF-->>AF: 7. Npcf_PolicyAuthorization_(Un)Subscribe request + AF-->>PCF: 8. Npcf_PolicyAuthorization_(Un)Subscribe response + PCF->>PCF: 9. Interactions in Figure 5.2.2.2.1-1 + +``` + +Sequence diagram showing the AF Session Modification triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves four lifelines: SMF, PCF, AF, and UDR. The process starts with the AF sending an Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF then sends a Diameter AAR (1a) to the AF. The PCF stores the service information (2) and sends a Nudr\_DataRepository\_Query request (3) to the UDR. The UDR responds (4). The PCF identifies affected PDU session(s) (5) and sends an Npcf\_PolicyAuthorization\_Update response (6) to the AF. The PCF also sends a Diameter AAA (6a) to the AF. The PCF sends an Npcf\_PolicyAuthorization\_(Un)Subscribe request (7) to the AF. The AF responds (8). Finally, the PCF initiates interactions with the SMF (9). + +**Figure 5.2.2.2.2.2-1: AF Session Modification triggers PCF-initiated SM Policy Association Modification procedure** + +1. When the AF receives an internal or external trigger to modify an existing AF session, the AF invokes the Npcf\_PolicyAuthorization\_Update service operation to the PCF by sending the HTTP PATCH request to the "Individual Application Session Context" resource including the modified service information as defined in clause 4.2.3.2 of 3GPP TS 29.514 [10]. The AF may also provide the updated subscription to notifications on user plane events. To invoke/revoke MPS for DTS, the AF includes the MPS Action indication as defined in 3GPP TS 29.514 [10]. + +If the "TimeSensitiveNetworking" feature is supported the AF may also update the TSC Assistance Container and QoS related data and/or a UMIC and/or one or more PMIC(s). + +- 1a. The AF provides the Service Information to the PCF by sending a Diameter AAR for the existing Rx Diameter session corresponding to the modified AF session. +2. The PCF stores the received Service Information. +- 3-4. These steps are the same as steps 3-4 in clause 5.2.2.2.2.1. +5. The PCF identifies the affected existing PDU Session(s) using the information previously received from the SMF and the Service Information received from the AF. +6. The PCF sends an HTTP "200 OK" or HTTP "204 No Content" response to the AF. + - 6a. The H-PCF sends a Diameter AAA to the AF. + +7. The AF may decide to (un)subscribe to events for the active AF application session context in relation to the corresponding PDU session. + - If the AF decides to create a subscription to events or modify the events subscription, it invokes the Npcf\_PolicyAuthorization\_Subscribe service operation by sending the HTTP PUT request to the "Events Subscription" resource. The HTTP request includes the events that subscribes and may also include a Notification URI to indicate to the PCF where to send the notification of the subscribed events. + - If the AF decides to remove subscription to all subscribed events for the existing application session context, it invokes the Npcf\_PolicyAuthorization\_Unsubscribe service operation by sending the HTTP DELETE request to the "Events Subscription" resource. +8. The PCF responses to the AF. + - If the PCF accept the HTTP PUT request to create a subscription to events, it sends an HTTP "201 Created" response. + - If the PCF accept the HTTP PUT request to modify the events subscription, it sends an HTTP "200 OK" or HTTP "204 No Content" response. + - Upon receipt of the HTTP DELETE request to remove subscription to all subscribed events, the PCF sends an HTTP "204 No Content" response. +9. The PCF interacts with SMF according to Figure 5.2.2.2-1. + +###### 5.2.2.2.2.3 AF Session Termination + +This procedure is performed when the AF/NEF requests the PCF to delete the AF application session context. + +NOTE: The NEF acts as an AF to support the network exposure functionality for policy/charging capability. + +For the integration with TSC networks the AF represented in the figures is either the TSN AF (integration with IEEE TSN networks) or the TSCTSF (integration with other TSC networks than IEEE TSN). + +![Sequence diagram showing the AF Session Termination triggers PCF-initiated SM Policy Association Modification procedure. Lifelines: SMF, PCF, AF, UDR. The sequence starts with the AF sending an Npcf_PolicyAuthorization_Delete request to the PCF. The PCF then sends a Diameter STR to the SMF (Rx Case). The PCF identifies the affected PDU session. The PCF sends an Npcf_PolicyAuthorization_Delete response to the AF. The PCF sends a Diameter STA to the SMF (Rx Case). The PCF interacts with the SMF according to Figure 5.2.2.2.1-1. The PCF sends an Npcf_PolicyAuthorization_Delete response to the AF. The PCF sends a Diameter STA to the SMF (Rx Case).](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant AF + participant UDR + + Note left of SMF: Rx Case + AF->>PCF: 1. Npcf_PolicyAuthorization_Delete request + Note left of SMF: Rx Case + AF->>PCF: 1a. Diameter STR + Note right of PCF: 2. Identify affected PDU session + Note left of SMF: Rx Case + PCF-->>AF: 3. Npcf_PolicyAuthorization_Delete response + Note left of SMF: Rx Case + PCF-->>AF: 3a. Diameter STA + Note right of PCF: 4. Interactions in Figure 5.2.2.2.1-1 + Note left of SMF: Rx Case + PCF-->>AF: 3*. Npcf_PolicyAuthorization_Delete response + Note left of SMF: Rx Case + PCF-->>AF: 3a*. Diameter STA + +``` + +Sequence diagram showing the AF Session Termination triggers PCF-initiated SM Policy Association Modification procedure. Lifelines: SMF, PCF, AF, UDR. The sequence starts with the AF sending an Npcf\_PolicyAuthorization\_Delete request to the PCF. The PCF then sends a Diameter STR to the SMF (Rx Case). The PCF identifies the affected PDU session. The PCF sends an Npcf\_PolicyAuthorization\_Delete response to the AF. The PCF sends a Diameter STA to the SMF (Rx Case). The PCF interacts with the SMF according to Figure 5.2.2.2.1-1. The PCF sends an Npcf\_PolicyAuthorization\_Delete response to the AF. The PCF sends a Diameter STA to the SMF (Rx Case). + +**Figure 5.2.2.2.2.3-1: AF Session Termination triggers PCF-initiated SM Policy Association Modification procedure** + +1. The AF sends the Npcf\_PolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application Session Context" resource to request the removal of the AF application session as defined in clause 4.2.3.2 of 3GPP TS 29.514 [10]. The request may include the events to subscribe to. + - 1a. The AF sends a session termination request, Diameter STR, to the PCF to request the removal of the session. The request may include the events to subscribe to +2. The PCF identifies the affected PDU Session where PCC rules related with this AF session are installed. These PCC rules need to be removed. + + +If the request in step 1 or step 1a does not include the event(s) or it includes the event(s) but the corresponding information is available at the PCF, step 3 or step3a is performed respectively; otherwise, the step 3\* or step3a\* is performed respectively. +3. The PCF removes the AF application session context and sends an HTTP "204 No Content" or HTTP "200 OK" response to the AF. + - 3a. The PCF sends a Diameter STA, session termination answer, to the AF. +- 3\*. The PCF removes the AF application session context and sends an HTTP "200 OK" response with the information corresponding to the requested event(s) to the AF. + - 3a\*. The PCF sends a Diameter STA, session termination answer with the information corresponding to the requested event(s), to the AF. +4. The PCF interacts with SMF according to Figure 5.2.2.2.1-1. + +###### 5.2.2.2.2.4 AF Request of application detection exposure + +This procedure is performed when the AF/NEF subscribes or modifies a subscription to application detection exposure information for the requested service. + +NOTE: The NEF acts as an AF to support the network exposure functionality. + +![Sequence diagram showing the AF Request of application detection exposure triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves three lifelines: SMF, PCF, and AF. The sequence of messages is: 1. Npcf_EventExposure_Subscribe request from AF to PCF; 2. Store Service Information (internal PCF step); 3. Identify affected PDU session(s) (internal PCF step); 4. Npcf_EventExposure_Subscribe response from PCF to AF; 5. Interactions in Figure 5.2.2.2.1-1 between SMF and PCF.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + participant AF + Note right of PCF: 2. Store Service Information + Note right of PCF: 3. Identify affected PDU session(s) + AF->>PCF: 1. Npcf_EventExposure_Subscribe request + PCF->>AF: 4. Npcf_EventExposure_Subscribe response + Note left of SMF: 5. Interactions in Figure 5.2.2.2.1-1 +``` + +Sequence diagram showing the AF Request of application detection exposure triggers PCF-initiated SM Policy Association Modification procedure. The diagram involves three lifelines: SMF, PCF, and AF. The sequence of messages is: 1. Npcf\_EventExposure\_Subscribe request from AF to PCF; 2. Store Service Information (internal PCF step); 3. Identify affected PDU session(s) (internal PCF step); 4. Npcf\_EventExposure\_Subscribe response from PCF to AF; 5. Interactions in Figure 5.2.2.2.1-1 between SMF and PCF. + +**Figure 5.2.2.2.4-1: AF Request of application detection exposure triggers PCF-initiated SM Policy Association Modification procedure** + +1. When the AF requires to get information on the usage of applications to enforce application layer logic, the AF invokes the Npcf\_EventExposure\_Subscribe service operation to the PCF by sending the HTTP POST request to the "Policy Control Events Subscriptions" resource as described in 3GPP TS 29.523 [49]. + +When the AF requires to modify an existing subscription, the AF invokes the Npcf\_Event\_Exposure\_Subscribe service operation to the PCF by sending the HTTP PUT request to the "Individual Policy Control Events Subscription" resource as described in 3GPP TS 29.523 [49]. + +2. The PCF stores the Service Information received in step 1. +3. The PCF identifies the affected established PDU Session (s) using the information previously received from the AF. +4. The PCF sends an HTTP "201 Created" as a response to the initial subscription or HTTP "200 OK" or HTTP "204 No Content" as a response to a subscription modification. +5. The PCF interacts with SMF according to Figure 5.2.2.2-1. + +###### 5.2.2.2.2.5 AF Request termination of application detection exposure + +This procedure is performed when the AF/NEF unsubscribes to application detection exposure information for the requested service. + +NOTE: The NEF acts as an AF to support the network exposure functionality for policy/charging capability. + +![Sequence diagram showing the interaction between SMF, PCF, and AF for application detection exposure termination.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PCF + participant AF + Note right of PCF: 2. Identify affected PDU session(s) + Note right of SMF: 4. Interactions in Figure 5.2.2.2.1-1 + AF->>PCF: 1. Npcf_EventExposure_Unsubscribe request + PCF->>AF: 3. Npcf_EventExposure_Unsubscribe response + Note left of SMF: 4. Interactions in Figure 5.2.2.2.1-1 +``` + +The diagram illustrates a sequence of interactions between three network functions: SMF (Session Management Function), PCF (Policy Control Function), and AF (Application Function). The sequence starts with the AF sending a '1. Npcf\_EventExposure\_Unsubscribe request' to the PCF. The PCF then performs an internal step '2. Identify affected PDU session(s)'. Next, the PCF sends a '3. Npcf\_EventExposure\_Unsubscribe response' back to the AF. Finally, a dashed box labeled '4. Interactions in Figure 5.2.2.2.1-1' spans across the SMF and PCF lifelines, indicating further interactions between them. + +Sequence diagram showing the interaction between SMF, PCF, and AF for application detection exposure termination. + +**Figure 5.2.2.2.5-1: AF Request of application detection exposure termination triggers PCF-initiated SM Policy Association Modification procedure** + +1. The AF sends the Npcf\_EventExposure\_Unsubscribe service operation by sending the HTTP DELETE request to the "Individual Policy Control Events Subscription" resource to request the removal of the subscription as defined in clause 4.2.3 of 3GPP TS 29.523 [49]. +2. The PCF identifies the affected PDU Session where PCC rules related with this AF request are installed. These PCC rules need to be removed and the related Policy Control Request Triggers need to be unsubscribed unless they are used for other purposes. +3. The PCF removes the corresponding subscription and sends an HTTP "204 No Content" response to the AF. +4. If the PCF needs to remove the affected PCC Rules and unsubscribe to the related Policy Control Request Triggers the PCF interacts with SMF according to Figure 5.2.2.2-1. + +#### 5.2.2.3 SM Policy Association Modification initiated by the SMF + +This procedure is performed when the SMF observes some policy control trigger condition is met or a PCC rule error is reported. + +For the integration with TSC networks the AF represented in the figures is either the TSN AF (integration with IEEE TSN networks) or the TSCTSF (integration with other TSC networks than IEEE TSN). + +![Sequence diagram of SMF-initiated SM Policy Association Modification procedure. Lifelines: SMF, PCF, AF/PCF for a UE, UDR, CHF, BSF. The procedure involves policy control requests, data repository queries, URSP provisioning, policy authorization (notify, update, delete), Diameter messages (RAR/ASR, RAA/ASA, AAR, AAA, STR, STA), spending limit report retrieval, policy decisions, and NBSF management (update, deregister, register).](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +The sequence diagram illustrates the SMF-initiated SM Policy Association Modification procedure. The lifelines involved are SMF, PCF, AF/PCF for a UE, UDR, CHF, and BSF. The process begins with a policy control request trigger or PCC rule error (Step 1). The SMF sends an Npcf\_SMPolicyControl\_Update request to the PCF (Step 2). The PCF then queries the UDR for data (Steps 3 and 4). Next, URSP provisioning in EPS occurs (Step 5). The PCF sends policy authorization messages to the AF/PCF: Notify request (Step 6), Notify response (Step 7), Update request (Step 8), Update response (Step 9), Delete request (Step 10), and Delete response (Step 11). Brackets on the right indicate that if a specific event is received by the AF, an update may be requested (Steps 8-9), and if a termination request is received, the session is deleted (Steps 10-11). A 'Rx Case' block (shaded in light blue) contains Diameter messages: RAR/ASR (Step 6a), RAA/ASA (Step 7a), AAR (Step 8a), AAA (Step 9a), STR (Step 10a), and STA (Step 11a). Brackets here indicate that if a specific action is received, an update may be requested (Steps 8a-9a), and if an abort request is received, the session is terminated (Steps 10a-11a). The PCF then retrieves a spending limit report (Step 12). A policy decision is made (Step 13). The PCF sends an Nudr\_DataRepository\_Update request to the UDR (Step 14) and receives a response (Step 15). The PCF then interacts with the BSF via Nbsf\_Management messages: Update request (Step 16), Update response (Step 17), Deregister request (Step 18), Deregister response (Step 19), Register request (Step 20), and Register response (Step 21). Finally, the SMF receives an Npcf\_SMPolicyControl\_Update response from the PCF (Step 22). + +Sequence diagram of SMF-initiated SM Policy Association Modification procedure. Lifelines: SMF, PCF, AF/PCF for a UE, UDR, CHF, BSF. The procedure involves policy control requests, data repository queries, URSP provisioning, policy authorization (notify, update, delete), Diameter messages (RAR/ASR, RAA/ASA, AAR, AAA, STR, STA), spending limit report retrieval, policy decisions, and NBSF management (update, deregister, register). + +**Figure 5.2.2.3-1: SMF-initiated SM Policy Association Modification procedure** + +1. The SMF detects a policy control request trigger condition is met or an error is reported. + +2. The SMF invokes the Npcf\_SMPolicyControl\_Update service operation to the PCF by sending the HTTP POST request to the "Individual SM Policy" resource with information on the conditions that have changed or a PCC rule error occurs. + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported and the "TSN\_BRIDGE\_INFO" policy control request trigger is provisioned in the SMF, the SMF may provide during PDU session establishment TSC user plane node information (port number for the device side corresponding to the PDU session, DS-TT MAC address, if applicable, TSC user plane node Id and UE-DS-TT residence time, if available), and, if available, a UMIC and/or one or more PMIC(s) to the PCF, or, during PDU session modification procedures, updated UMIC and/or PMIC(s). In case of Deterministic Networking, the SMF may also provide the MTU size for IPv4 and the MTU size for IPv6 as part of TSC user plane node information. + +3. If the (H-)PCF requires subscription-related information and does not have it, the (H-)PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "SessionManagementPolicyData" resource to fetch the information. + +If the AfGuideTNAPs feature defined in 3GPP TS 29.512 [9] is supported and the (H-)PCF requires Service Parameter data and does not have it, the (H-)PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "Service Parameter Data" resource to fetch the information. + +Additionally, when network slice data rate related policy control is supported by the PCF, the PCF may invoke the Nudr\_DataRepository\_Query service operation towards the UDR by sending an HTTP GET request targeting the "SlicePolicyControlData" resource. + +4. The UDR sends an HTTP "200 OK" response to the PCF with the subscription related information containing the information about the allowed service(s) and PCC Rules information. + +NOTE 1: If the Npcf\_SMPolicyControl\_Update message of step 2 includes usage report(s), the (H-)PCF can also invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the "SessionManagementPolicyData" resource in order to update the usage monitoring information according to the received usage report(s). + +NOTE 2: If the Npcf\_SMPolicyControl\_Update message of step 2 includes the outcome of the resource allocation and network slice data rate policy control is supported, the (H-)PCF can also invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request targeting the "SlicePolicyControlData" resource in order to update the Remaining Maximum Slice Data Rate information. + +5. If the feature "EpsUrsp" is supported: + +- a. if the PCF received in step 1 a UE Policy Container as described in 3GPP TS 29.512 [9], and: + - i. there is no UE Policy Association established for the UE, the PCF triggers a UE Policy Association Establishment procedure as described in clause 5.6.1; or + - ii. there is a UE Policy Association established for the UE, the PCF triggers a UE Policy Association Update procedure as described in clause 5.6.2.1; or +- b. if the PCF received in step 1 a RAT type and/or Access Type change event as described in 3GPP TS 29.512 [9], and: + - i. the PCF determines that 5GS to EPS mobility applies as described in 3GPP TS 29.525 [31], the PCF retrieves from the BSF the PCF for the UE handling the UE policy association with the source AMF and triggers a UE Policy Association Establishment procedure as described in clause 5.6.1; or + - ii. the PCF determines that EPS to 5GS mobility applies, the PCF triggers a UE Policy Association Termination procedure as described in clause 5.6.3.2. + +NOTE 3: In the Home Routed case, the PCF interacts with the H-PCF for the UE and, in the LBO case, the PCF in the V-PLMN interacts with the V-PCF for the UE as described in clause 4.2.2.1 of 3GPP TS 29.525 [31]. + +6. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to indicate that an event for which the AF requested a notification has occurred by sending the HTTP POST request with "{notifUri}/notify" as the callback URI to the AF or to request to the AF the deletion of the active application session if all the service data + +flows for the AF session are deleted by sending the HTTP POST request with "{notifUri}/terminate" as the callback URI to the AF. + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported: + +- When the PCF detects that there is no Individual Application Session Context resource bound to the Individual SM Policy resource the PCF shall provide the new TSC user plane node information received in step 2 to the TSN AF or TSCTSF by sending an HTTP POST request to the "{notifUri}/new-bridge" request URI, where the "{notifUri}" value is pre-configured in the PCF or, if not pre-configured, discovered by invoking the Nnrf\_NFDiscovery service as defined in 3GPP TS 29.510 [51]. + +NOTE 4: The TSCTSF registers in the NRF the notification URI within the default notification subscription for time sensitive communication, time synchronization and deterministic networking notifications as described in 3GPP TS 29.510 [51]. + +- When the PCF detects that there is an Individual Application Session Context resource bound to the Individual SM Policy resource, the PCF shall provide the received UMIC and/or PMICs to the AF by sending an HTTP POST request to the "{notifUri}/notify" callback URI. + +When the PCF as a PCF for a PDU session becomes aware that a SM Policy Association that is being modified is receiving the callback URI of the PCF for a UE in step 2, the PCF shall send the event of PDU session established to the PCF for a UE by sending an HTTP POST request to the "{notifUri}/pdu-session" callback URI as defined in subclause 4.2.5.22 of 3GPP TS 29.514 [10]. + +- 6a. If the AF requested a notification of the corresponding event, the PCF sends a Diameter RAR with the Specific-Action AVP set to indicate the event that caused the request. If all service data flows for an AF session are deleted, the PCF sends a Diameter ASR to request to the AF the termination of the active session. + +7. The AF sends an HTTP "204 No Content" response to the PCF. + +If the feature "TimeSensitiveNetworking" or "TimeSensitiveCommunication" is supported and the TSN AF or TSCTSF received the notification of new TSC user plan node information over the "{notifUri}/new-bridge" request URI, the TSN AF or TSCTSF shall trigger the Npcf\_PolicyAuthorization\_Create service operation as described in clause 5.2.2.2.2.1, to request the creation of a new Individual Application Session Context resource specific to the PDU session identified by, for Ethernet type of PDU sessions, the received MAC address of the DS-TT port and for IP type of PDU sessions, the received UE IP address. + +NOTE 5: For the time synchronization service, the AF subscription to UE availability for time-synchronization service can occur after the PDU Session establishment has been completed in 5GS. Similarly, for the AF session with required QoS, the indication of the required QoS and TSC Assistance Container information can occur after the completion of the PDU session establishment. In such cases, the PCF sends the notification to the TSCTSF about the detection of a TSC user plane node information during PDU session establishment, but the TSCTSF doesn't have the time synchronization or required QoS available for the PDU session. In this case, the TSCTSF could defer the invocation of the Npcf\_PolicyAuthorization\_Create service operation till the reception of the subscription to UE availability for time synchronization or the AF session with required QoS occurs. + +If the PCF for a UE receives the notification of PDU session establishment over the "{notifUri}/pdu-session" request URI and if the "ApplicationDetectionEvents" feature is supported, the PCF for a UE may trigger the Npcf\_PolicyAuthorization\_Subscribe service operation described in clause 4.2.6.9 to subscribe to the notification of the application detection; + +- 7a. If the AF receives an event notification, the AF replies with a Diameter RAA and may provide within it updated service information. If the AF receives an indication that all service data flows for an AF session are deleted, the AF replies with a Diameter ASA. + +8. If the PCF indicates in step 5 that an event for the active application session has occurred, the AF may invoke the Npcf\_PolicyAuthorization\_Update service operation to the PCF by sending the HTTP PATCH request to the "Individual Application Session Context" resource including the modified service information. + +- 8a. If the PCF indicates in step 5a that an event for the active application session has occurred, the AF may send a Diameter AAR to the PCF including the modified service information. + +9. The PCF sends an HTTP "200 OK" or an HTTP "204 No Content" response to the AF. + +8a, The AF responds by sending a Diameter AAA to the PCF. + +10. If the PCF indicates in step 5 that there are no transmission resources for the service, the AF may terminate the AF session by invoking the Npcf\_PolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application Session Context" resource to terminate the AF session. The request may include the events to subscribe to. + +- 10a. The AF sends a Diameter STR message to the PCF to indicate that the AF session is terminated. + +11. The PCF removes the AF application session context and sends an HTTP "204 No Content". If the PCF need to include the notification of event, it sends an HTTP "200 OK" response. + +- 11a. The PCF responds by sending a Diameter STA message to the AF and the AF session is terminated. + +12. If the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4. + +13. The PCF makes a policy decision. The PCF may determine that updated or new policy information needs to be sent to the SMF in step 22. + +- 14-15. If network slice data rate related policy control applies, the (H-)PCF may invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request targeting the "SlicePolicyControlData" resource in order to update the Remaining Maximum Slice Data Rate information. + +If the BindingUpdate feature defined in 3GPP TS 29.521 [22] is supported, the steps 16 to 17 will be performed, otherwise the steps 18 to 21 will be performed. + +16. If the UE address changes and the binding information has been previously registered in the BSF, or if the "ExtendedSamePcf" feature is supported, and the PCF registered binding information without including the UE address and UE address is received in step 2 and required for the retrieval of binding information by any NF (e.g. for PDU session binding), the PCF invokes the Nbsf\_Management\_Update service operation by sending an HTTP PATCH request to update the binding information in the BSF as detailed in clause 8.5.7. + +17. The PCF receives an HTTP "200 OK" response from the BSF. + +18. If the IP address is released for the IP PDU session or the MAC address is not used anymore for the Ethernet PDU session and the binding information has been previously registered in the BSF, the PCF invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request to the BSF to delete binding information as detailed in clause 8.5.3. + +19. The PCF receives an HTTP "204 No Content" response from the BSF as detailed in clause 8.5.3. + +20. If a new IP address is allocated for the IP PDU session or a new MAC address is used for the Ethernet PDU session and the BSF is to be used, or if the "ExtendedSamePcf" feature is supported, and the PCF registered binding information without including the UE address and UE address is received in step 2 and required for the retrieval of binding information by any NF, the PCF invokes the Nbsf\_Management\_Register service operation by sending an HTTP POST request to create the binding information in the BSF as detailed in clause 8.5.2. + +21. The PCF receives an HTTP "201 Created" response from the BSF with the created binding information as detailed in clause 8.5.2. + +22. The PCF sends an HTTP "200 OK" response to the SMF with updated policy information about the PDU Session determined in step 13. + +If the feature "EpsUrsp" is supported, the PCF sends in the HTTP "200 OK" response to the SMF the UE policy container and/or the UE policy association triggers received from the PCF for the UE in step 5, if applicable. + +### 5.2.3 SM Policy Association Termination + +#### 5.2.3.1 SM Policy Association Termination initiated by the SMF + +This procedure is performed when the UE requests to terminate a PDU session or based on some internal triggers in the SMF(e.g. operator policy). + +![Sequence diagram for SMF-initiated SM Policy Association Termination procedure. Lifelines: SMF, PCF, AF/PCF for a UE, UDR, CHF, BSF. The diagram shows steps for policy control deletion, rule removal, authorization notifications, Diameter session handling (Rx Case), spending limit report retrieval, data repository updates, and network management deregistration.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +The sequence diagram illustrates the SMF-initiated SM Policy Association Termination procedure. The lifelines involved are SMF, PCF, AF/PCF for a UE, UDR, CHF, and BSF. The procedure is divided into several phases: + +- Initial Request:** SMF sends an *1. Npcf\_SMPolicyControl\_Delete request* to PCF. +- Rule Identification:** PCF performs *2. Identify which PCC Rules are affected*. +- Rule Removal:** SMF performs *3. Removal of all PCC Rules*. +- Policy Authorization:** PCF sends *4. Npcf\_PolicyAuthorization\_Notify request* to AF/PCF for a UE, which responds with *5. Npcf\_PolicyAuthorization\_Notify response*. PCF then sends *6. Npcf\_PolicyAuthorization\_Delete request* to AF/PCF for a UE, which responds with *7. Npcf\_PolicyAuthorization\_Delete response*. These steps are grouped by a bracket labeled "For each affected AF session (if any)". +- Rx Case:** A light blue shaded area labeled "Rx Case" on the left. PCF sends *4a. Diameter ASR* to AF/PCF for a UE, which responds with *5a. Diameter ASA*. PCF then sends *6a. Diameter STR* to AF/PCF for a UE, which responds with *7a. Diameter STA*. These steps are also grouped by a bracket labeled "For each affected AF session (if any)". +- Spending Limit Report:** A dashed box labeled *8. Spending Limit Report Retrieval* spans across PCF, UDR, and CHF. +- Response:** PCF sends *9. Npcf\_SMPolicyControl\_Delete response* to SMF. +- Data Repository Update:** PCF sends *10. Nudr\_DataRepository\_Update request* to UDR, which responds with *11. Nudr\_DataRepository\_Update response*. PCF then sends *12. Nudr\_DataRepository\_Unsubscribe request* to UDR, which responds with *13. Nudr\_DataRepository\_Unsubscribe response*. +- Network Management Deregistration:** A dashed box labeled *14. Nbsf\_Management\_Deregister request* and *15. Nbsf\_Management\_Deregister response* spans across AF/PCF for a UE and BSF. +- URSP Provisioning:** A dashed box labeled *16. URSP provisioning in EPS* is located at the bottom of the PCF lifeline. + +Sequence diagram for SMF-initiated SM Policy Association Termination procedure. Lifelines: SMF, PCF, AF/PCF for a UE, UDR, CHF, BSF. The diagram shows steps for policy control deletion, rule removal, authorization notifications, Diameter session handling (Rx Case), spending limit report retrieval, data repository updates, and network management deregistration. + +Figure 5.2.3.1-1: SMF-initiated SM Policy Association Termination procedure + +This procedure concerns both roaming and non-roaming scenarios. + +In the LBO roaming case, the PCF acts as the V-PCF, and the V-PCF shall not contact the UDR/CHF. In the home routed roaming case, the PCF acts as the H-PCF, and the H-PCF interacts only with the H-SMF. + +NOTE 1: For LBO roaming case, session management policy data is not stored in the VPLMN. Therefore, interactions between PCF and UDR in the SM Policy Association Termination procedures do not apply to this scenario. + +1. The SMF invokes the Npcf\_SMPolicyControl\_Delete service operation by sending the HTTP POST request to the "Individual SM Policy" resource to request the PCF to delete the context of the SM related policy as defined in clause 4.2.5.2 of 3GPP TS 29.512 [9]. The request operation may include usage monitoring information (if applicable) and access network information. +2. Upon receipt of Npcf\_SMPolicyControl\_Delete service operation, the PCF identifies the PCC Rules that require an AF to be notified and removes PCC Rules for the PDU Session. +3. The SMF removes all the PCC Rules which are applied to the PDU session. +4. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation by sending the HTTP POST request with "{notifUri}/terminate" as the callback URI to the AF to trigger the AF to request the application session context termination. + +When the PCF as a PDU session determines that the SM Policy Association that is terminating contains the callback URI for the PCF for a UE, the PCF shall send the event of PDU session terminated to the PCF for a UE by sending an HTTP POST request to the "{notifUri}/pdu-session" callback URI as defined in clause 4.2.5.22 of 3GPP TS 29.514 [10]. + +- 4a. The PCF indicates the session abort to the AF by sending a diameter ASR to the AF. +5. The AF sends an HTTP "204 No Content" response to the PCF. + - 5a. The AF responds by sending a diameter ASA to the PCF. +6. The AF invokes the Npcf\_PolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application Session Context" resource. The request may include the events to subscribe to. + - 6a. The AF sends a diameter STR to the PCF to indicate that the session has been terminated. The request may include the events to subscribe to. +7. The PCF removes the AF application session context and sends an HTTP "204 No Content" response to the AF. If the PCF needs to report usage data or the access network information, it sends an HTTP "200 OK" response. If usage thresholds were provided by the AF earlier, and the PCF has usage data that has not yet been reported to the AF, the PCF informs the AF about the resources that have been consumed by the user since the last report. If the SMF in step 1 reports the access network information and if the AF requested the PCF to report access network information in step 6 and/or the RAN-NAS-Cause feature is supported, the PCF informs the AF about the access network information. The PCF also deletes the subscription to PCF detected events for that AF application Session. + - 7a. The PCF responds by sending a diameter STA to the AF. If usage thresholds were provided by the AF earlier, and the PCF has usage data that has not yet been reported to the AF, the PCF informs the AF about the resources that have been consumed by the user since the last report. If the SMF in step 1 reports the access network information and if the AF requested the PCF to report access network information in step 6a and/or the RAN-NAS-Cause feature is supported, the PCF informs the AF about the access network information. +8. If this is the last PDU session for this subscriber the Final Spending Limit Report Request as defined in clause 5.3.4 is sent. If any existing PDU sessions for this subscriber require policy counter status reporting, the Intermediate Spending Limit Report Request as defined in clause 5.3.3 can be sent to alter the list of subscribed policy counters. +9. The PCF removes PCC Rules for the terminated PDU Session and sends an HTTP "204 No Content" response to the SMF. +10. The PCF invokes the Nudr\_DataRepository\_Update service operation by sending the HTTP PATCH request to the "SessionManagementPolicyData" resource to store the remaining usage allowance in the UDR, if all PDU sessions of the user to the same DNN and S-NSSAI are terminated. + +Additionally, if network slice data rate related policy control applies, the (H-)PCF may invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request targeting the "SlicePolicyControlData" resource in order to update the Remaining Maximum Slice Data Rate information. + +11. The UDR sends an HTTP "204 No Content" response to the PCF. + +12-13. To unsubscribe the notification of the PDU session related data modification from the UDR, the PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "IndividualPolicyDataSubscription" resource if it has subscribed such notification. The UDR sends an HTTP "204 No Content" response to the PCF. + +Additionally, to unsubscribe the notification of changes of the AF influence data from the UDR, the PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "Individual Influence Data Subscription" resource if it has subscribed such notification. The UDR sends an HTTP "204 No Content" response to the PCF. + +- Additionally, to unsubscribe from notifications about IPTV configuration data changes and/or from notifications about AF-provided TNAP ID(s) data changes at the UDR, the PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation by sending an HTTP DELETE request to the "IndividualApplicationDataSubscription" resource if it has subscribed such notification. The UDR sends an HTTP "204 No Content" response to the PCF. + +14. In the case that binding information has been previously registered in the BSF the PCF invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request to the BSF to delete binding information as detailed in clause 8.5.3. + +NOTE: The PCF invokes the Nbsf\_Management\_Deregister for every binding information previously registered in the BSF for the PDU session. + +15. The PCF receives an HTTP "204 No Content" response from the BSF as detailed in clause 8.5.3. + +16. If the feature "EpsUrsp" is supported and the PCF created a UE policy association with the PCF for the UE, the PCF may delete the UE policy association as described in clause 5.6.3.1. + +#### 5.2.3.2 SM Policy Association Termination initiated by the PCF + +This procedure is performed when the PCF requests to terminate a SM Policy Association based on some external or internal triggers as described in step 1 below. + +![Sequence diagram for PCF-initiated SM Policy Association Termination procedure. Lifelines: SMF, PCF, AF, UDR, CHF, BSF. The process starts with the PCF detecting PDU session termination (Step 1). The PCF sends an Npcf_SMPolicyControl_UpdateNotify request to the SMF (Step 2). The SMF responds with an Npcf_SMPolicyControl_UpdateNotify response (Step 3). Finally, a group of interactions (Step 4) occurs between the PCF, AF, UDR, CHF, and BSF, as detailed in Figure 5.2.3.1-1.](414cf5c0e2959c558de57a9fb5c2134a_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant AF + participant UDR + participant CHF + participant BSF + + Note right of PCF: 1. Detection that PDU session termination is required + PCF->>SMF: 2. Npcf_SMPolicyControl_UpdateNotify request + SMF-->>PCF: 3. Npcf_SMPolicyControl_UpdateNotify response + Note over PCF, AF, UDR, CHF, BSF: 4. Interactions in Figure 5.2.3.1-1 + +``` + +Sequence diagram for PCF-initiated SM Policy Association Termination procedure. Lifelines: SMF, PCF, AF, UDR, CHF, BSF. The process starts with the PCF detecting PDU session termination (Step 1). The PCF sends an Npcf\_SMPolicyControl\_UpdateNotify request to the SMF (Step 2). The SMF responds with an Npcf\_SMPolicyControl\_UpdateNotify response (Step 3). Finally, a group of interactions (Step 4) occurs between the PCF, AF, UDR, CHF, and BSF, as detailed in Figure 5.2.3.1-1. + +Figure 5.2.3.2-1: PCF-initiated SM Policy Association Termination procedure + +This procedure concerns both roaming and non-roaming scenarios. + +In the LBO roaming case, the PCF acts as the V-PCF. In the home routed roaming case, the PCF acts as the H-PCF, and the H-PCF interacts only with the H-SMF. + +1. The PCF makes policy decisions to terminate a PDU session based on an external trigger, e.g. UE subscription data is deleted, or based on an internal trigger, e.g. operator policy is changed. +2. The PCF sends the Npcf\_SMPolicyControl\_UpdateNotify service operation by sending the HTTP POST request with "{notificationUri}/delete" as the callback URI to trigger the SMF to request the release of the PDU session as defined in clause 4.2.3.3 of 3GPP TS 29.512 [9]. The request includes resource URI of the individual SM policy to be deleted and the cause why the PCF requests the termination. +3. The SMF sends an HTTP "200 OK" response to the PCF. +4. The PCF interacts with SMF/AF/UDR/CHF/BSF according to Figure 5.2.3.1-1. + +## 5.3 Spending Limit Procedures + +### 5.3.1 General + +The PCF may interact with the CHF to make PCC decisions based on spending limits. In Home Routed roaming and Non-roaming case, the (H-) PCF will interact with the CHF in HPLMN. + +### 5.3.2 Initial Spending Limit Report Request + +This clause describes the signalling flow for the PCF to request the status of the policy counters available at the CHF, and to subscribe to updates of these policy counters by the CHF. If the PCF provides the list of policy counter identifier(s), the CHF returns the policy counter status per policy counter identifier provided by the PCF, and stores the PCF's subscription to spending limit reports for these policy counters. If the PCF does not provide the list of policy counter identifier(s), the CHF returns the policy counter status for all policy counter identifier(s), which are available for this subscriber, and stores the PCF's subscription to spending limit reports for all policy counters. + +![Sequence diagram showing the Initial Spending Limit Report Request procedure between PCF and CHF.](9167fa5ebcb66516d1bbb421ec9bba7b_img.jpg) + +``` +sequenceDiagram + participant PCF + participant CHF + Note left of PCF: 1. Policy decision depends on policy counter status + PCF->>CHF: 2. Nchf_SpendingLimitControl_Subscribe request + CHF-->>PCF: 3. Nchf_SpendingLimitControl_Subscribe response +``` + +The diagram illustrates the interaction between the PCF and the CHF. It starts with a note on the PCF side indicating that a policy decision depends on policy counter status. The PCF then sends a message labeled '2. Nchf\_SpendingLimitControl\_Subscribe request' to the CHF. The CHF responds with a message labeled '3. Nchf\_SpendingLimitControl\_Subscribe response' back to the PCF. + +Sequence diagram showing the Initial Spending Limit Report Request procedure between PCF and CHF. + +**Figure 5.3.2-1: Initial Spending Limit Report Request procedure** + +1. The PCF retrieves subscription information that indicates that policy decisions depend on policy counter(s) held at the CHF and optionally the list of policy counter identifier(s). +2. The PCF invokes the Nchf\_SpendingLimitControl\_Subscribe service operation to the CHF by sending the HTTP POST request to the "Spending Limit Retrieval Subscriptions" resource if such reporting is not established for the subscriber. The request operation includes the subscriber Id "SUPI", the notification URI and optionally the list of policy counter identifier(s). +3. The CHF responds to the Nchf\_SpendingLimitControl\_Subscribe service operation including a Subscription Correlation ID and as Event Information provides the policy counter status, and optionally pending policy counter statuses and their activation times, per required policy counter identifier, and stores the PCF's subscription to spending limit reports for these policy counters. When no policy counter identifier(s) was received from the PCF, it provides the policy counter status, optionally pending policy counter statuses and their + +activation times, for all policy counters, which are available for this subscriber, and stores the PCF's subscription to spending limit reports for all policy counters. + +### 5.3.3 Intermediate Spending Limit Report Request + +This clause describes the signalling flow for the PCF to request the status of additional policy counters available at the CHF or to remove the request for the status of policy counters available at CHF. If the PCF provides the list of policy counter identifier(s), the CHF returns the policy counter status per policy counter identifier provided by the PCF. + +![Sequence diagram showing the Intermediate Spending Limit Report Request procedure between PCF and CHF.](2734e7f9be3e1dc046f14be2e6c9a085_img.jpg) + +``` +sequenceDiagram + participant PCF + participant CHF + Note left of PCF: 1. Status of additional or fewer policy counters are relevant for policy decision + PCF->>CHF: 2. Nchf_SpendingLimitControl_Subscribe request + CHF-->>PCF: 3. Nchf_SpendingLimitControl_Subscribe response +``` + +The diagram illustrates the interaction between the PCF (Policy Control Function) and the CHF (CHF). It starts with a note on the PCF side indicating that the status of additional or fewer policy counters are relevant for policy decision. The PCF then sends a request message '2. Nchf\_SpendingLimitControl\_Subscribe request' to the CHF. The CHF responds with a response message '3. Nchf\_SpendingLimitControl\_Subscribe response' back to the PCF. + +Sequence diagram showing the Intermediate Spending Limit Report Request procedure between PCF and CHF. + +**Figure 5.3.3-1: Intermediate Spending Limit Report Request procedure** + +1. The PCF decides to modify the list of subscribed policy counters, e.g. PCF determines that policy decisions depend on additional policy counter identifier(s) held at the CHF or that notifications of policy counter status changes for some policy counters are no longer required. +2. The PCF invokes the Nchf\_SpendingLimitControl\_Subscribe service operation to the CHF by sending the HTTP PUT request to the "Individual Spending Limit Retrieval Subscription" resource. The request operation may include an updated list of policy counter identifier(s) that overrides the previously stored list of policy counter identifier(s) and a notification URI. +3. The CHF responds to the Nchf\_SpendingLimitControl\_Subscribe service operation and provides as Event Information the policy counter status and optionally pending policy counter statuses and their activation times, per required policy counter identifier, and stores or removes the PCF's subscription to spending limit reporting by comparing the updated list with the existing PCF subscriptions. When no policy counter identifier(s) was received from the PCF, it provides the policy counter status, optionally pending policy counter statuses and their activation times, for all policy counter(s), which are available for this subscriber, and stores the PCF's subscription to spending limit reports for all policy counters. + +### 5.3.4 Final Spending Limit Report Request + +This clause describes the signalling flow for the PCF to unsubscribe to any future updates of policy counters for a given subscriber by the CHF. It cancels the request for reporting the change of the status of the policy counters available at the CHF. + +![Sequence diagram showing the Final Spending Limit Report Request procedure between PCF and CHF.](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` +sequenceDiagram + participant PCF + participant CHF + Note left of PCF: 1. Decision to unsubscribe from notifications of changes in the policy counter status + PCF->>CHF: 2. Nchf_SpendingLimitControl_Unsubscribe request + CHF-->>PCF: 3. Nchf_SpendingLimitControl_Unsubscribe response +``` + +The diagram illustrates a sequence of interactions between the PCF (Policy Control Function) and the CHF (CHF). It begins with a decision box on the PCF lifeline labeled "1. Decision to unsubscribe from notifications of changes in the policy counter status". This is followed by a message "2. Nchf\_SpendingLimitControl\_Unsubscribe request" sent from the PCF to the CHF. Finally, a message "3. Nchf\_SpendingLimitControl\_Unsubscribe response" is sent from the CHF back to the PCF. + +Sequence diagram showing the Final Spending Limit Report Request procedure between PCF and CHF. + +**Figure 5.3.4-1: Final Spending Limit Report Request procedure** + +1. The PCF decides that policy decisions for a given user no longer depend on policy counter(s) to which the PCF has existing subscriptions for status change notification. +2. The PCF sends Nchf\_SpendingLimitControl\_Unsubscribe service operation to the CHF by sending the HTTP DELETE request to the "Individual Spending Limit Retrieval Subscription" resource to cancel the notification request from the CHF on policy counter status, whereby the "{subscriptionId}" is the identification of the existing subscription to be deleted. +3. The CHF removes the PCF's subscription to spending limit reporting and responds to the Nchf\_SpendingLimitControl\_Unsubscribe service operation to the PCF. + +### 5.3.5 Spending Limit Report + +This clause describes the signalling flow for the CHF to notify the changes of the status of a subscribed policy counter(s) available at the CHF for that subscriber. Alternatively, the signalling flow can be re-used by the CHF to provide one or more pending statuses for a subscribed policy counter together with the time that have to be applied. + +![Sequence diagram illustrating the Spending Limit Report procedure between PCF and CHF.](820515db47ded68f5e0b625f4ec7d2c1_img.jpg) + +``` +sequenceDiagram + participant CHF + participant PCF + Note right of CHF: 1. Policy Counter Status change + CHF->>PCF: 2. Nchf_SpendingLimitControl_Notify request + PCF->>CHF: 3. Nchf_SpendingLimitControl_Notify response +``` + +The diagram shows a sequence of interactions between the PCF (Policy Control Function) and the CHF (CHF). The sequence starts with the CHF detecting a policy counter status change (Step 1). The CHF then sends an Nchf\_SpendingLimitControl\_Notify request to the PCF (Step 2). The PCF responds with an Nchf\_SpendingLimitControl\_Notify response (Step 3). + +Sequence diagram illustrating the Spending Limit Report procedure between PCF and CHF. + +**Figure 5.3.5-1: Spending Limit Report procedure** + +1. The CHF detects that status of a policy counter identifier(s) has changed and the PCF requested notification of changes in the status of a policy counter(s). Alternatively, if the CHF detects a policy counter status will change at a future point in time, the CHF shall be able to instruct the PCF to apply one or more pending statuses for a requested policy counter. +2. When the status of a specific policy counter changes, or the CHF detects that a policy counter status will change at a future point in time and decides to instruct the PCF to apply one or more pending statuses for a requested policy counter, the CHF shall determine the Spending Limit subscription resource(s) impacted by the change (e.g.. the Spending Limit subscription resource(s) bound to those PDU sessions and/or UE/AM policy associations that may have subscribed to status change notifications for the changed policy counter, and/or the Spending Limit subscription resource bound to an AM Policy association that may have subscribed to notification ) and invoke Nchf\_SpendingLimitControl\_Notify service operation by sending the HTTP POST request with "{notifURI}/notify " as the request URI to the PCF associated with each affected PDU session and/or each affected UE/AM policy association. The request operation includes the subscriber Id "SUPI" and in the Event Information the updated policy counter status, optionally including pending policy counter statuses and their activation times for any of the subscribed policy counters. +3. The PCF acknowledges the Nchf\_SpendingLimitControl\_Notify service operation. The PCF uses the status of the received policy counter(s) as input to its policy decision to apply operator defined actions, e.g. downgrade the QoS, and it shall ignore an unknown policy counter status report for all unknown policy counter identifiers in the Nchf\_SpendingLimitControl\_Notify service operation from the CHF. + +### 5.3.6 Subscription termination request by CHF + +This clause describes the signalling flow for the CHF to report the removal of the subscriber to every PCF. + +![Sequence diagram illustrating the Subscription Termination Request procedure between PCF and CHF. The CHF performs a 'Decision on the removal of a subscriber' and then sends an 'Nchf_SpendingLimitControl_Notify request' to the PCF. The PCF responds with an 'Nchf_SpendingLimitControl_Notify response'.](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant CHF + participant PCF + Note right of CHF: 1. Decision on the removal of a subscriber + CHF->>PCF: 2. Nchf_SpendingLimitControl_Notify request + PCF-->>CHF: 3. Nchf_SpendingLimitControl_Notify response + +``` + +Sequence diagram illustrating the Subscription Termination Request procedure between PCF and CHF. The CHF performs a 'Decision on the removal of a subscriber' and then sends an 'Nchf\_SpendingLimitControl\_Notify request' to the PCF. The PCF responds with an 'Nchf\_SpendingLimitControl\_Notify response'. + +**Figure 5.3.6-1: Subscription Termination Request procedure** + +1. When the CHF decides that a subscriber is removed it may report the removal to the PCF. +2. The CHF may invoke the Nchf\_SpendingLimitControl\_Notify service operation by sending the HTTP POST request with "{notifURI}/terminate" as request URI to the PCF. The request operation shall include the subscriber Id "SUPI" and in the subscription termination information "removed subscriber" as Event Information. +3. The PCF removes the subscription to notification of all policy counter statuses for a subscriber identified by the subscriber Id, makes applicable policy decisions and acknowledges the Nchf\_SpendingLimitControl\_Notify service operation. + +## 5.4 Network Data Analytics Procedures + +### 5.4.1 General + +The PCF may interact with the NWDAF to make PCC decisions based on analytics information as described in 3GPP TS 29.552 [48]. + +### 5.4.2 NWDAF Discovery and Selection by the PCF + +The PCF performs discovery and selection of NWDAF as follows: + +- When the "EneNA" feature is supported as described in 3GPP TS 29.507 [7], the PCF for the UE may select the list of NWDAF instance IDs used for the UE and their associated Analytic ID(s) based on the NWDAF information provided by the AMF as part of the AM Policy Association Establishment and/or Modification procedures as described in 3GPP TS 29.507 [7]. +- When the "EneNA" feature is supported as described in 3GPP TS 29.512 [9], the PCF for the PDU Session may select the list of NWDAF instance IDs used for the PDU Session and their associated Analytic ID(s) based on the NWDAF information provided by the SMF as part of the SM Policy Association Establishment and/or Modification procedures as described in 3GPP TS 29.512 [9]. +- When the NWDAF instance IDs provided by the AMF or SMF do not relate to the Analytics ID(s) required by the PCF, the PCF may perform NWDAF discovery as described in 3GPP TS 29.510 [51]. + +### 5.4.3 Policy decisions based on Network Analytics + +The following Analytics IDs (observed events as described in 3GPP TS 29.520 [11]) are relevant for Policy decisions: "Slice Load level information", "Service Experience", "Network Performance", "Abnormal behaviour", "UE Mobility", "UE Communication", "User Data Congestion", "Data Dispersion", "Session Management Congestion Control" + +Experience", "DN Performance", "WLAN performance", "Redundant Transmission Experience" and "URSP enforcement". + +The PCF may subscribe to these events and/or may retrieve the observed events when the information is needed. + +In order for the PCF to subscribe to these events, the PCF shall act as NF Service Consumer of the NWDAF as specified in 3GPP TS 29.520 [11] behaving as follows: + +- The PCF may subscribe to notifications of network analytics related to "Slice Load Level Information" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "SLICE\_LOAD\_LEVEL", the "snssais" attribute including the network slice and the "notificationMethod" attribute in "eventSubscriptions" attribute set to "THRESHOLD". + +NOTE 1: PCF does not subscribe to event "NSI\_LOAD\_LEVEL" since the network slice instance of a PDU session is not available in the PCF + +- If the feature "ServiceExperience" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Service Experience" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "SERVICE\_EXPERIENCE", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute, the "appIds" attribute with the identification of application(s) to which the subscription applies, the "ratFreqs" attribute if the feature "ServiceExperienceExt" is also supported including all the RAT types and/or all the frequencies that the NWDAF received for the application or specific RAT type(s) and/or frequencies where the UE camps and the service experience threshold value(s) for the RAT Type(s) and/or Frequency value(s). +- If the feature "NetworkPerformance" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Network Performance" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "NETWORK\_PERFORMANCE", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies within the "intGroupIds" attribute and the "networkArea" attribute with the identification network area to which the subscription applies. +- If the feature "AbnormalBehaviour" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Abnormal Behavior" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "ABNORMAL\_BEHAVIOUR", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute and either the "exptAnaType" attribute with the expected analytics or the "excepReqs" attribute with a list of exception Ids with the associated thresholds. Per each Exception Id, it is possible to provide additional information as described in TS 29.520 [11]. +- If the feature "UeMobility" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "UE Mobility" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "UE\_MOBILITY", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies within the "supis" or "intGroupIds" attribute and the "networkArea" attribute with the identification network area to which the subscription applies. +- If the feature "UeCommunication" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "UE communication" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "UE\_COMMUNICATION", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis" or "intGroupIds" attribute and optionally the "appIds" attribute with the identification of application(s) to which the subscription applies. +- If the feature "UserDataCongestion" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "User Data Congestion" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "USER\_DATA\_CONGESTION" and the "tgtUe" attribute with the identification of the target UE to which the subscription applies included in the "supis" attribute and optionally the "networkArea", "congThresholds" attributes with the area of interests and the reporting threshold respectively. If the feature "UserDataCongestionExt" is supported, the PCF may also provide the "maxTopAppUINbr" and/or "maxTopAppDINbr" attributes with the requested maximum number of top applications that contribute the most to the traffic. + +- If the feature "Dispersion" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Dispersion" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "DISPERSION", the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute and the "disperType" attribute within the "disperReqs" attribute set to the applicable dispersion analytic type. Optionally, the PCF may include the "networkArea" attribute with the identification network area to which the subscription applies, the identification of the network slice(s) by "snssais" attribute and/or the dispersion analytics requirements in "disperReqs" attribute, which for the requested dispersion type may include dispersion class within "disperClass" set to "TOP\_HEAVY". If the PCF is interested in the average data rate in the network slice, the PCF may set the "disperType" attribute within the "disperReqs" attribute set to "DVDA" and it shall provide the network slice within the "snssais" attribute and the "tgtUe" attribute set to "anyUe". +- If the feature "DnPerformance" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "DN Performance" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "DN\_PERFORMANCE" and the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute and optionally the "appIds" attribute with the identification of application(s) to which the subscription applies. +- If the feature "SMCCE" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Session Management Congestion Control Experience" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "SM\_CONGESTION" and the "tgtUe" attribute with the identification of target UE to which the subscription applies included in the "supis" attribute and the "dnns" attribute with the identification of the DNN and/or the "snssais" attribute with the identification of the network slice. +- If the feature "WlanPerformance" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "WLAN Performance" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "WLAN\_PERFORMANCE" and the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute. The PCF may provide any of "networkArea", "ssIds" or "bsIds" attributes to which the subscription applies within "wlanReqs" attribute. +- If the feature "RedundantTransmissionExp" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "Redundant Transmission Experience" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "RED\_TRANS\_EXP" and the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute. The PCF may provide the identification of network area within "networkArea" attribute, DNNs within "dnns" attribute and other requirements within "redTransReqs" attribute. +- If the feature "UrspEnforcement" is supported as defined in TS 29.520 [11], the PCF may subscribe to notifications of network analytics related to "URSP enforcement" using the Nnwdaf\_EventsSubscription\_Subscribe service operation including the "event" attribute set to "URSP\_ENFORCEMENT" and the "tgtUe" attribute with the identification of target UE(s) to which the subscription applies included in the "supis", "intGroupIds" or "anyUe" attribute and the "dnns" attribute with the identification of the DNN and/or the "snssais" attribute with the identification of the network slice. The PCF may include the "networkArea" attribute with the identification network area, to which the subscription applies, + +When the PCF requires the events related to any of these analytics Ids immediately, it shall initiate an Nnwdaf\_AnalyticsInfo\_Request service operation towards the NWDAF. In this case, the same level of information as for the subscription to events shall be provided as query parameters in the request, that is, the required event, filter and requirement information shall be provided in the "event-id", "event-filter" and "ana-req" URI query parameters. + +Upon reception of any of the events as described above either in a subscription or retrieval request, the NWDAF shall behave as described in TS 29.520 [11]. + +The subscribing and/or retrieving of analytics information by the PCF from the NWDAF may be triggered by: + +- Requests from AF/NEF; +- AM Policy association establishment or modification request from the AMF; +- UE Policy association establishment or modification request from the AMF; + +- SM Policy association establishment or modification request from the SMF; +- Notifications received from UDR or CHF on UE subscription change; +- Analytics information received. + +NOTE 2: Examples of operator policies where network analytics information from NWDAF is required as inputs for policy decisions are described in clause 6.1.1.3 of 3GPP TS 23.503[4]. + +NOTE 3: Care needs to be taken with regards to signalling and processing load caused when requesting analytics targeting "Any UE". A PCF preferably limits the analytics requests to a smaller UE set to reduce the load. + +## 5.5 Service Capability Exposure Procedures + +### 5.5.1 General + +PCC abilities can be exposed to a 3rd party application server via the NEF. + +The following procedures are included in this clause: + +1. The procedure of Packet Flow Descriptions management. +2. The procedure of AF traffic routing. +3. The procedure of Background Data Transfer negotiation. +4. The procedure of BDT warning notification. +5. The procedure of Background Data Transfer policy applying. +6. The procedure of IPTV configuration provisioning. +7. The procedure of AF-based service parameter provisioning. +8. The procedure of QoS monitoring. +9. The procedure of AF-triggered dynamically changing AM policies. +10. The procedure of Time Synchronization Exposure. +11. The procedure of Deterministic Networking specific parameter provisioning. +12. The procedure for negotiation for planned data transfer with QoS requirements. +13. PDTQ warning notification procedure + +### 5.5.2 Management of Packet Flow Descriptions + +#### 5.5.2.1 AF-initiated PFD management procedure + +This clause describes the procedure initiated by the AF for creation, update or removal of packet flow descriptions of the application(s) in operator's network as depicted in figure 5.5.2.1-1. + +![Sequence diagram of AF-initiated PFD management procedure. Lifelines: UDR, NEF, AF. The sequence starts with the AF sending a request (Nnef_PFDmanagement_Create/Update/Delete) to the NEF. The NEF performs internal handling. Then, the NEF sends a request (Nudr_DataRepository_Create/Update/Delete) to the UDR. The UDR returns a response (Nudr_DataRepository_Create/Update/Delete response) to the NEF. Finally, the NEF sends a response (Nnef_PFDmanagement_Create/Update/Delete response) to the AF.](88b0f3f4393228e9ea4d6542aef7c399_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant UDR + Note right of NEF: 2. NEF handling + AF->>NEF: 1. Nnef_PFDmanagement_Create / Nnef_PFDmanagement_Update / Nnef_PFDmanagement_Delete request + NEF->>UDR: 3. Nudr_DataRepository_Create/ Nudr_DataRepository_Update/ Nudr_DataRepository_Delete request + UDR-->>NEF: 4. Nudr_DataRepository_Create/ Nudr_DataRepository_Update/ Nudr_DataRepository_Delete response + NEF-->>AF: 5. Nnef_PFDmanagement_Create / Nnef_PFDmanagement_Update / Nnef_PFDmanagement_Delete response + +``` + +Sequence diagram of AF-initiated PFD management procedure. Lifelines: UDR, NEF, AF. The sequence starts with the AF sending a request (Nnef\_PFDmanagement\_Create/Update/Delete) to the NEF. The NEF performs internal handling. Then, the NEF sends a request (Nudr\_DataRepository\_Create/Update/Delete) to the UDR. The UDR returns a response (Nudr\_DataRepository\_Create/Update/Delete response) to the NEF. Finally, the NEF sends a response (Nnef\_PFDmanagement\_Create/Update/Delete response) to the AF. + +**Figure 5.5.2.1-1: AF-initiated PFD management procedure** + +1. To create PFDs resources for one or more application identifier(s), the AF invokes the Nnef\_PFDmanagement\_Create service operation to the NEF by sending the HTTP POST request to the resource "PFD Management Transactions". + +To update the PFDs for an existing individual transaction including one or more application identifier(s), the AF invokes the Nnef\_PFDmanagement\_Update service operation by sending the HTTP PUT request to the resource "Individual PFD Management Transaction". + +To update the PFDs for an existing application identifier, the AF invokes the Nnef\_PFDmanagement\_Update service operation by sending the HTTP PUT or PATCH request to the resource "Individual Application PFD Management". + +To remove the PFDs for an existing individual transaction "Individual PFD Management Transaction" including one or more application identifier(s), the AF invokes the Nnef\_PFDmanagement\_Delete service operation by sending the HTTP DELETE request to the resource "Individual PFD Management Transaction". + +To remove the PFDs for an existing individual application, the AF invokes the Nnef\_PFDmanagement\_Delete service operation by sending the HTTP DELETE request to the resource "Individual Application PFD Management". + +NOTE 1: For details of Nnef\_PFDmanagement\_Create/Update/Delete service operations refer to 3GPP TS 29.522 [24]. + +2. The NEF checks whether the application is authorized to perform this request based on the operator policies. +3. The NEF invokes Nudr\_DataRepository operation service to the UDR as follows: + - if PFDs creation for a new application identifier was requested in step 1, the NEF shall invoke the Nudr\_DataRepository\_Create service operation by sending an HTTP PUT request message to the resource "Individual PFD Data" for the requested application identifier. + +- if PFDs update for an existing application identifier was requested in step 1, the NEF shall invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PUT request message to the resource "Individual PFD Data" for the requested application identifier. +- if PFDs removal for an existing application identifier was requested in step 1, the NEF shall invoke the Nudr\_DataRepository\_Delete service operation by sending an HTTP DELETE request message to the resource "Individual PFD Data" for the requested application identifier. + +NOTE 2: PFD creation/update/removal in step 1 can include PFD management request for multiple applications, but the UDR service for PFD management only supports one application at a time. + +NOTE 3: For details of Nudr\_DataRepository\_Create/Update/Delete service operations refer to 3GPP TS 29.519 [12]. + +4. The UDR shall send the HTTP response message to the NEF correspondingly. +5. The NEF sends Nnef\_PFDManagement\_Create/Update/Delete Response to the AF. + +#### 5.5.2.2 PFD management towards SMF + +##### 5.5.2.2.1 PFD retrieval + +This procedure enables the SMF to retrieve PFDs for application identifier(s) from the PFDF as depicted in figure 5.5.2.2.1-1 when: + +- a PCC rule with the application identifier(s) is provided or activated and PFDs for the corresponding application identifier(s) provisioned by the PFDF are not available at the SMF; or +- the caching timer for an application identifier expires and the PCC Rule for this application identifier is still active. + +The SMF may retrieve PFDs for one or more application identifiers in the same Request. All PFDs related to an application identifier are provided in the response from the PFDF to the SMF. + +![Sequence diagram for PFD retrieval by SMF. The diagram shows four messages between SMF, PFDF, and UDR. 1. SMF sends Nnef_PFDmanagement_Fetch request to PFDF. 2. PFDF sends Nudr_DataRepository_Query request to UDR. 3. UDR sends Nudr_DataRepository_Query response to PFDF. 4. PFDF sends Nnef_PFDmanagement_Fetch response to SMF.](78d5774278a3f4a614f8c0ae485ce8d9_img.jpg) + +``` +sequenceDiagram + participant SMF + participant PFDF + participant UDR + Note left of SMF: PFD retrieval by SMF + SMF->>PFDF: 1. Nnef_PFDmanagement_Fetch request + PFDF-->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>PFDF: 3. Nudr_DataRepository_Query response + PFDF-->>SMF: 4. Nnef_PFDmanagement_Fetch response +``` + +Sequence diagram for PFD retrieval by SMF. The diagram shows four messages between SMF, PFDF, and UDR. 1. SMF sends Nnef\_PFDmanagement\_Fetch request to PFDF. 2. PFDF sends Nudr\_DataRepository\_Query request to UDR. 3. UDR sends Nudr\_DataRepository\_Query response to PFDF. 4. PFDF sends Nnef\_PFDmanagement\_Fetch response to SMF. + +Figure 5.5.2.2.1-1: PFD retrieval by SMF + +1. In order to retrieve the PFDs of individual application identifier, the SMF may invoke Nnef\_PFDmanagement\_Fetch service operation by sending an HTTP GET request message to the resource "{apiRoot}/nnef-pfdmanagement/v1/applications/{appId}" for the full pull procedure or invoke the Nnef\_PFDmanagement\_Fetch service operation by sending an HTTP POST request message to the resource "{apiRoot}/nnef-pfdmanagement/v1/applications/partialpull" for the partial pull procedure if the "PartialPull" feature is supported. + +In order to retrieve the PFDs of collection of application identifiers, the SMF may invoke the Nnef\_PFDmanagement\_Fetch service operation by sending an HTTP GET request message to the resource "{apiRoot}/nnef-pfdmanagement/v1/applications" with query parameters indicating the requested application identifiers for the full pull procedure or invoke the Nnef\_PFDmanagement\_Fetch service operation by sending an HTTP POST request message to the resource "{apiRoot}/nnef-pfdmanagement/v1/applications/partialpull" for the partial pull procedure if the "PartialPull" feature is supported. + +If the "NotificationPush" feature is supported and the PFD retrieval is performed due to a Notification Push received by the PFDF, the PFDF may indicate the PFD(s) operation in "pfdOp" attribute for SMF to determine the invoke action as defined in clause 5.5.2.2.2. + +NOTE 1: For details of Nnef\_PFDmanagement\_Fetch service operation refer to 3GPP TS 29.551 [25]. + +2. If the requested PFDs are not available in PFDF, + +- in order to retrieve the PFDs of individual application identifier, the PFDF shall invoke Nudr\_DataRepository\_Query service operation by sending an HTTP GET request message to the UDR to the resource "Individual PFD Data". +- in order to retrieve the PFDs of collection of application identifiers, the PFDF shall invoke the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request message to the UDR to the resource "PFD Data" with query parameters indicating the requested application identifiers. + +NOTE 2: For details of Nudr\_DataRepository\_Query service operation refer to 3GPP TS 29.519 [12]. + +3. The UDR shall send an HTTP GET response message including the requested PFDs to the NEF. + +4. The PFDF sends the "200 OK" response including the PFDs for the requested application identifier(s) to the SMF or sends the "204 No Content" response to indicate that the PFD(s) for all the requested application identifier(s) are not changed since last request if the partial pull procedure was invoked. + +##### 5.5.2.2.2 PFD management + +This procedure enables the SMF to subscribe the notification of events when the PFDs for application identifier change. The PFDF will notify the SMF to update and/or delete the PFDs for application identifier(s) as subscribed previously. + +![Sequence diagram showing PFD management between SMF and PFDF. The diagram illustrates the interaction for subscribing, notifying, fetching, and unsubscribing to PFD events.](3b621c21b0af3a504a28d2547e87138f_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PFDF + Note left of SMF: SMF initiates PFD management + SMF->>PFDF: 1. Nnef_PFDmanagement_Subscribe request + PFDF-->>SMF: 2. Nnef_PFDmanagement_Subscribe response + Note right of PFDF: PFDF detects event + PFDF->>SMF: 3. Nnef_PFDmanagement_Notify request + SMF-->>PFDF: 4. Nnef_PFDmanagement_Notify response + Note left of SMF: SMF requests PFDs + SMF->>PFDF: 5. Nnef_PFDmanagement_Fetch request + PFDF-->>SMF: 6. Nnef_PFDmanagement_Fetch response + Note left of SMF: SMF unsubscribes + SMF->>PFDF: 7. Nnef_PFDmanagement_Unsubscribe request + PFDF-->>SMF: 8. Nnef_PFDmanagement_Unsubscribe response + +``` + +Sequence diagram showing PFD management between SMF and PFDF. The diagram illustrates the interaction for subscribing, notifying, fetching, and unsubscribing to PFD events. + +Figure 5.5.2.2.2-1: PFDF management in the SMF + +1-2. In order to subscribe to the notification of events when the PFDs for application identifier change, the SMF invokes the Nnef\_PFDmanagement\_Subscribe service operation by sending an HTTP POST message to the resource "PFD subscriptions". The HTTP POST request includes a notification URI to indicate to the PFDF where to send notifications when events occur. If the subscription is accepted, the PFDF sends the POST response message a "201 Created" to the SMF. + +In order to update the existing event subscription and if the feature PfdChgSubsUpdate is supported, the SMF invokes the Nnef\_PFDmanagement\_Subscribe service operation by sending an HTTP PUT message to the resource "Individual PFD subscription". If the request is accepted, the PFDF sends an HTTP "200 OK" response to the SMF. + +- 3-4. The PFDF shall use Nnef\_PFDmanagement\_Notify service operation to update and/or delete the PFDs for application identifier(s) in the SMF. + +The PFDF may send an HTTP POST request message containing one or more PfdChangeNotification data structure to the notification URI "{notifyUri}" as defined in clause 4.2.4.2 of 3GPP TS 29.551 [25]. The SMF replies to the PFDF with an HTTP POST response message "204 No Content" indicating the successful provisioning of all PFDs or "200 OK" containing failed application identifier(s). + +If the NotificationPush feature is supported, the PFDF may send an HTTP POST request message containing one or more NotificationPush data structure to the notification URI "{notifyUri}/notifypush" to request the SMF to retrieve the PFDs from the PFDF and/or remove the PFD(s). The SMF replies to the PFDF with a "204 No Content" status code if the SMF accepted the request. + +- 5-6. If the SMF received the HTTP POST request message to request the SMF to retrieve the PFDs from the PFDF, depends on PFDF indication or SMF determination, the SMF may invoke the full pull procedure defined in clause 4.2.2.2 of 3GPP TS 29.551 [25] or invoke the partial pull procedure defined in clause 4.2.2.3 of 3GPP TS 29.551 [25] if the "PartialPull" feature is supported, using Nnef\_PFDmanagement\_Fetch service operation, to retrieve the PFD(s) for the application identifier(s). + +- 7-8. The SMF may initiate Nnef\_PFDmanagement\_Unsubscribe service operation to remove the subscription by sending an HTTP DELETE request message to the resource "Individual PFD subscription". The PFDF replies to the SMF with an HTTP DELETE response message "204 No Content". + +NOTE: For details of Nnef\_PFDmanagement\_Subscribe/Notify/Unsubscribe/Fetch service operations refer to 3GPP TS 29.551 [25]. + +### 5.5.3 Traffic influence procedures + +#### 5.5.3.1 General + +As described in 3GPP TS 23.501 [2] clause 5.6.7 and clause 5.6.16, an AF may send requests to influence SMF routing decisions and influence on N6-LAN traffic steering respectively for User Plane traffic of PDU Sessions. The AF may also provide in its request subscriptions to SMF events (e.g. UP path change). + +The following cases are included in this clause: + +AF requests targeting an individual UE address: such requests are routed (by the AF or by the NEF) to an individual PCF using the BSF or by configuration as described in clause 5.5.3.2. + +NOTE 1: Such requests target an on-going PDU Session. Whether the AF needs to use the NEF or not depends on local deployment. + +AF requests targeting PDU Sessions that are not identified by an UE address: For such requests the AF shall contact the NEF and the NEF stores the AF request information in the UDR. PCF(s) that have subscribed to the modification of the AF request information receive a corresponding notification from the UDR. This is described in clause 5.5.3.3. + +NOTE 2: Such requests can target on-going or future PDU Sessions. + +NOTE 3: The 5GC functions used in the procedures to influence SMF routing decisions are assumed to all belong to the same PLMN (HPLMN in non-roaming case or VPLMN in the case of a PDU Session in LBO mode) or to the same SNPN. The 5GC functions used in the procedures to influence on N6-LAN traffic steering are assumed to belong to the Home PLMN or Home SNPN (the AF can have an agreement with the Home PLMN), i.e. this case applies to non-roaming and Home Routed roaming scenarios. + +NOTE 4: The roaming scenarios for SNPNs are not supported in this Release. + +NOTE 5: AF requests invoked from an AF located in the HPLMN for home routed roaming scenario are not supported. + +NOTE 6: For details of Nnef\_TrafficInfluence\_Create/Update/Delete/AppRelocationInfo service operations refer to 3GPP TS 29.522 [24]. + +NOTE 7: For details of the Nudr\_DataRepository\_Create/Update/Delete service operations refer to 3GPP TS 29.519 [12] and 3GPP TS 29.504 [27]. + +NOTE 8: For details of the Nsmf\_EventExposure\_Notify/AppRelocationInfo service operations refer to 3GPP TS 29.508 [8]. + +NOTE 9: For details of the Npcf\_PolicyAuthorization\_Create/Update/Delete service operations refer to 3GPP TS 29.514 [10]. + +NOTE 10: For details of the Npcf\_SMPolicyControl\_UpdateNotify service operation refer to 3GPP TS 29.512 [9]. + +NOTE 11: For details of the Nbsf\_Management\_Discovery service operation refer to 3GPP TS 29.521 [22]. + +AF requests targeting PDU Sessions that support HR-SBO: when such requests are performed by the V-AF, the V-AF shall contact the V-NEF and the V-NEF stores the AF request information in the V-UDR. The procedure is described in clause 5.5.3.4. + +For such requests the AF shall contact the NEF and the NEF stores the AF request information in the UDR + +#### 5.5.3.2 AF requests targeting an individual UE address + +![Sequence diagram showing the interaction between SMF, PCF, BSF, NEF, and AF for processing AF requests targeting an individual UE address. The diagram is divided into several sections: (1A), (1B), 2, 3, 3a, (4A), and (4B).](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant BSF + participant NEF + participant AF + + Note left of PCF: (1A) + AF->>NEF: 1a.Nnef_TrafficInfluence_Create/Update/Delete request + Note right of NEF: 1b.parameter mapping and PLMN determination + NEF->>BSF: 1c.Nbsf_Management_Discovery request + BSF-->>NEF: 1d.Nbsf_Management_Discovery response + NEF->>PCF: 1e.Npcf_PolicyAuthorization_Create/Update/Delete request + PCF-->>NEF: 1f.Npcf_PolicyAuthorization_Create/Update/Delete response + NEF->>AF: 1g.Nnef_TrafficInfluence_Create/Update/Delete response + + Note left of PCF: (1B) + NEF->>BSF: 1a.Nbsf_Management_Discovery request + BSF-->>NEF: 1b.Nbsf_Management_Discovery response + NEF->>PCF: 1c.Npcf_PolicyAuthorization_Create/Update/Delete request + PCF-->>NEF: 1d.Npcf_PolicyAuthorization_Create/Update/Delete response + + SMF->>PCF: 2.Npcf_SMPolicyControl_UpdateNotify request + PCF-->>SMF: 3.Npcf_SMPolicyControl_UpdateNotify response + + Note left of SMF: 3a.User Plane Reconfiguration + + Note left of SMF: (4A) + SMF->>NEF: 4a.Nsmf_EventExposure_Notify request + NEF->>AF: 4b.Nnef_TrafficInfluence_Notify request + AF-->>NEF: 4c.Nnef_TrafficInfluence_Notify response + NEF->>SMF: 4d.Nsmf_EventExposure_Notify response + NEF->>AF: 4e.Nnef_TrafficInfluence_AppRelocationInfo request + AF-->>NEF: 4f.Nnef_TrafficInfluence_AppRelocationInfo response + SMF->>AF: 4g.Nsmf_EventExposure_AppRelocationInfo request + AF-->>SMF: 4h.Nsmf_EventExposure_AppRelocationInfo response + + Note left of SMF: (4B) + SMF->>AF: 4a.Nsmf_EventExposure_Notify request + AF-->>SMF: 4b.Nsmf_EventExposure_Notify response + SMF->>AF: 4c.Nsmf_EventExposure_AppRelocationInfo request + AF-->>SMF: 4d.Nsmf_EventExposure_AppRelocationInfo response + +``` + +Sequence diagram showing the interaction between SMF, PCF, BSF, NEF, and AF for processing AF requests targeting an individual UE address. The diagram is divided into several sections: (1A), (1B), 2, 3, 3a, (4A), and (4B). + +Figure 5.5.3.2-1: Processing AF requests to influence traffic routing for Sessions identified by an UE address + +##### 1A. The AF sends the AF request to PCF via the NEF. + +1a-1b. These steps are the same as steps 1-2 in Figure 5.5.3.3-1, with the difference that in step 2 in that figure, if the NEF determines that the HPLMN is the PLMN that the NEF belongs to, the procedure continues as described in this clause. + +1c-1d. If the PCF address is not available on the NEF based on local configuration, the NEF invokes the Nbsf\_Management\_Discovery service operation, specified in clause 8.5.4, to obtain the selected PCF ID for the ongoing PDU session identified by the individual UE address in the AF request. + +1e-1f. The NEF forwards the AF request to the PCF. + +When receiving the Nnef\_TrafficInfluence\_Create request in step 1a, the NEF invokes the Npcf\_PolicyAuthorization\_Create service operation as defined in 3GPP TS 29.514 [10] by sending the HTTP POST request to the "Application Sessions" resource as described in clause 5.2.2.2.2.1. + +When receiving the Nnef\_TrafficInfluence\_Update request in step 1a, the NEF invokes the Npcf\_PolicyAuthorization\_Update service operation as defined in 3GPP TS 29.514 [10] by sending the HTTP PATCH request to the "Individual Application Session Context" resource as described in clause 5.2.2.2.2.2. + +1g The NEF sends the HTTP response message to the AF correspondingly. + +##### 1B. The AF sends the AF request to PCF directly. + +1a-1b. If the PCF address is not available on the AF based on local configuration, the AF invokes the Nbsf\_Management\_Discovery service operation, as specified in clause 8.5.4, to obtain the selected PCF ID for the ongoing PDU session identified by the individual UE address in its request. + +1c-1d. To create a new AF request, the AF invokes the Npcf\_PolicyAuthorization\_Create service operation as defined in 3GPP TS 29.514 [10] by sending the HTTP POST request to the "Application Sessions" resource as described in clause 5.2.2.2.2.1. + +To update an existing AF request, the AF invokes the Npcf\_PolicyAuthorization\_Update service operation as defined in 3GPP TS 29.514 [10] by sending the HTTP PATCH request to the "Individual Application Session Context" resource as described in clause 5.2.2.2.2.2. + +To remove an existing AF request, the AF invokes the Npcf\_PolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application Session Context" resource as described in clause 5.2.2.2.2.3. + +##### 2-3. Upon receipt of the AF request, the PCF invokes the Npcf\_SMPolicyControl\_UpdateNotify service operation as defined in 3GPP TS 29.512 [9] to update the SMF with corresponding PCC rule(s) by sending the HTTP POST request to the callback URI "{notificationUri}/update" as described in clause 5.2.2.2.1. + +- For the case of 4A, the PCF includes in the PCC rule(s) the Notification URI pointing to the NEF and the Notification Correlation ID assigned by NEF. +- For the case of 4B, the PCF includes in the PCC rule(s) the Notification URI pointing to the AF and the Notification Correlation ID assigned by AF. + +###### 3a. When the SMF installs PCC rule successfully, the SMF determines whether UP path change needs to be enforced. In this case, the SMF: + +- when early notification is required, shall notify as described in step 4 before reconfiguring the User Plane of the PDU session; +- takes appropriate actions to reconfigure the User plane of the PDU Session such as: + - i. adding, replacing or removing a UPF in the data path to e.g. act as an UL CL or a Branching Point; + - ii. allocate a new Prefix to the UE (when IPv6 multi-Homing applies); + - iii. updating the UPF in the target DNAI with new traffic steering rules; + +- iv. using the received maximum allowed user plane latency to decide whether edge relocation is needed to ensure that the user plane latency does not exceed the value and whether to relocate the PSA UPF to satisfy the user plane latency + - v. (re)configure Local PSA for EAS IP address replacement if applicable; + - vi. establishing a temporary N9 forwarding tunnel between the source UL CL and target UL CL and, if the AF requested so, and "SimultConnectivity" is supported in the concerned interfaces, maintaining simultaneous connectivity temporarily for the source and target PSA until the traffic ceases to exist for an AF indicated period of time or locally configured value; + - vii. using the FQDN range within the PCC rule if available to match the FQDN received from the EASDF via the Neasdf\_DNSContext\_Notify request and, if matched, indicating the UE the common EAS address(s) within the PCC rule; and +- when late notification is required, shall notify as described in step 4 after reconfiguring the User Plane of the PDU session. + +If the "EASDiscovery" feature is supported, and if UP path is enforced and/or the indication of the EAS rediscovery was received, the SMF indicates to the UE to refresh the cached EAS information as defined in clause 6.3.2 of 3GPP TS 24.501 [20]. + +If the "SFC" feature is supported and if the SMF received service function chaining control information in the PCC rule, the SMF takes the proper actions to control the traffic steering towards the N6-LAN as defined in clause 5.4.8 of 3GPP TS 29.244[59]. + +4A. In case of 1A, if the SMF observes PDU Session related event(s) that AF has subscribed to, the SMF sends notification to the AF via the NEF. + +4a-4d. The SMF invokes Nsmf\_EventExposure\_Notify service operation to the AF via the NEF by sending an HTTP POST request. When receiving the Nsmf\_EventExposure\_Notify service operation, the NEF performs information mapping (e.g. Notification Correlation ID to AF Transaction ID, etc.), and invokes the Nnef\_TrafficInfluence\_Notify service operation to forward the notification to the AF. If the indication of AF acknowledgement to be expected was included in the PCC rule(s), the SMF may notify with a notification URI for AF acknowledgement as described in 3GPP TS 29.508 [8], and then the NEF also notifies with a URI for the AF acknowledgement as described in 3GPP TS 29.522 [24]. + +4e-4h. When receiving the notification with the URI for AF acknowledgement, the AF acknowledges the notification to the SMF identified by the notification URI via the NEF as defined in 3GPP TS 29.522 [24]. + +The step is the same as steps 7-14 in Figure 5.5.3.3-1. + +4B. In case of 1B, if the SMF observes PDU Session related event(s) that AF has subscribed to, the SMF sends notification to the AF directly. + +4a-4b. The SMF invokes Nsmf\_EventExposure\_Notify service operation to the AF directly by sending an HTTP POST request to the callback URI "{notifUri}", and the AF sends a "204 No Content" response to the SMF. If the indication of AF acknowledgement to be expected was included in the PCC rule(s), the SMF may provide an URI for the AF acknowledgement as described in 3GPP TS 29.508 [8]. + +4c-4d. When receiving the notification with the URI for AF acknowledgement from the SMF, the AF invokes Nsmf\_EventExposure\_AppRelocationInfo service operation as defined in 3GPP TS 29.508 [8] by sending an HTTP POST request to the callback URI "{ackUri}" to acknowledge the notification, and the SMF sends a "204 No Content" response to the AF. + +#### 5.5.3.3 AF requests targeting PDU Sessions not identified by an UE address + +If the AF traffic influence request affects future PDU session, the traffic influence procedure is performed as depicted in Figure 5.5.3.3-1. + +![Sequence diagram showing the processing of AF requests to influence traffic routing. Lifelines: SMF, PCF, UDR, NEF, AF. The process involves AF sending a request to NEF, NEF performing parameter mapping, NEF sending a request to UDR, UDR responding, NEF responding to AF, followed by SM Policy Association Establishment, User Plane Reconfiguration, and subsequent event exposure and relocation info exchanges between SMF, NEF, and AF.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant UDR + participant NEF + participant AF + + Note right of NEF: 1.Nnef_TrafficInfluence_Create/Update/Delete request + AF->>NEF: 1.Nnef_TrafficInfluence_Create/Update/Delete request + Note right of NEF: 2.parameter mapping and PLMN determination + Note right of NEF: 3.Nudr_DataRepository_Create/Update/Delete request + NEF->>UDR: 3.Nudr_DataRepository_Create/Update/Delete request + Note right of UDR: 4.Nudr_DataRepository_Create/Update/Delete response + UDR-->>NEF: 4.Nudr_DataRepository_Create/Update/Delete response + Note right of NEF: 5.Nnef_TrafficInfluence_Create/Update/Delete response + NEF-->>AF: 5.Nnef_TrafficInfluence_Create/Update/Delete response + + Note left of SMF: 6. SM Policy Association Establishment procedure + SMF->>PCF: 6. SM Policy Association Establishment procedure + Note left of SMF: 6a. User Plane Reconfiguration + SMF->>PCF: 6a. User Plane Reconfiguration + + Note left of SMF: 7.Nsmf_EventExposure_Notify request + SMF-->>NEF: 7.Nsmf_EventExposure_Notify request + Note right of NEF: 8.Nnef_TrafficInfluence_Notify request + NEF-->>AF: 8.Nnef_TrafficInfluence_Notify request + Note right of AF: 9.Nnef_TrafficInfluence_Notify response + AF-->>NEF: 9.Nnef_TrafficInfluence_Notify response + Note right of NEF: 10.Nsmf_EventExposure_Notify response + NEF-->>SMF: 10.Nsmf_EventExposure_Notify response + + Note right of NEF: 11.Nnef_TrafficInfluence_AppRelocationInfo request + NEF-->>AF: 11.Nnef_TrafficInfluence_AppRelocationInfo request + Note right of AF: 12.Nnef_TrafficInfluence_AppRelocationInfo response + AF-->>NEF: 12.Nnef_TrafficInfluence_AppRelocationInfo response + Note left of SMF: 13.Nsmf_EventExposure_AppRelocationInfo request + SMF-->>NEF: 13.Nsmf_EventExposure_AppRelocationInfo request + Note left of SMF: 14.Nsmf_EventExposure_AppRelocationInfo response + SMF-->>NEF: 14.Nsmf_EventExposure_AppRelocationInfo response + +``` + +Sequence diagram showing the processing of AF requests to influence traffic routing. Lifelines: SMF, PCF, UDR, NEF, AF. The process involves AF sending a request to NEF, NEF performing parameter mapping, NEF sending a request to UDR, UDR responding, NEF responding to AF, followed by SM Policy Association Establishment, User Plane Reconfiguration, and subsequent event exposure and relocation info exchanges between SMF, NEF, and AF. + +**Figure 5.5.3.3-1: Processing AF requests to influence traffic routing for Sessions not identified by an UE address, affecting future PDU session** + +1. To create a new AF request, the AF invokes the Nnef\_TrafficInfluence\_Create service operation as defined in clause 4.4.7 of 3GPP TS 29.522 [24] to the NEF by sending the HTTP POST request to the "Traffic Influence Subscription" resource. + +To update an existing AF request, the AF invokes the Nnef\_TrafficInfluence\_Update service operation defined in clause 4.4.7 of 3GPP TS 29.522 [24] by sending the HTTP PUT or PATCH request to the "Individual Traffic Influence Subscription" resource. + +To remove an existing AF request, the AF invokes the Nnef\_TrafficInfluence\_Delete service operation by sending the HTTP DELETE request to the "Individual Traffic Influence Subscription" resource. + +2. Upon receipt of the AF request, the NEF authorizes it and then performs the mapping from the information provided by the AF into information needed by the 5GC as described in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The NEF determines the HPLMN based on the AF request and its local configuration as described in 3GPP TS 29.522 [24]. If the HPLMN is the PLMN that the NEF belongs to, the procedure continues as described in this clause. Otherwise, the procedure described in clause 5.5.3.4 will be performed instead. + +- 3-4. When receiving the Nnef\_TrafficInfluence\_Create request, the NEF invokes the Nudr\_DataRepository\_Create service operation defined in 3GPP TS 29.519 [12] to store the AF request information in the UDR by sending the HTTP PUT request to the "Individual Influence Data" resource, and the UDR sends a "201 Created" response. + +When receiving the Nnef\_TrafficInfluence\_Update request, the NEF invokes the Nudr\_DataRepository\_Update service operation as defined in 3GPP TS 29.519 [12] to modify the AF request information in the UDR by sending the HTTP PATCH/PUT request to the resource "Individual Influence Data", and the UDR sends a "200 OK" or "204 No Content" response accordingly. + +When receiving the Nnef\_TrafficInfluence\_Delete request, the NEF invokes the Nudr\_DataRepository\_Delete service operation to delete the AF requirements from the UDR by sending the HTTP DELETE request to the "Individual Influence Data" resource, and the UDR sends a "204 No Content" response. + +5. The NEF sends the HTTP response message to the AF correspondingly. +6. The PCF retrieves the stored AF request in the UDR by invoking the Nudr\_DataRepository\_Query service operation during SM Policy Association Establishment procedure (see clause 5.2.1). + +The PCF generates the PCC rule(s) based on the AF request and provides it to the SMF as specified in in clause 4.2.6.2.6.2 of 3GPP TS 29.512 [9]. + +- 6a. This step is the same as the step 3a in Figure 5.5.3.2-1. +7. If the SMF observes PDU Session related event(s) that AF has subscribed to, the SMF invokes the Nsmf\_EventExposure\_Notify service operation to the NEF by sending an HTTP POST request to the callback URI "{notifUri}". If the indication of AF acknowledgement to be expected was included in the PCC rule(s), the SMF may notify with an URI for the AF acknowledgement as described in 3GPP TS 29.508 [8]. +8. When receiving the Nsmf\_EventExposure\_Notify service operation, the NEF performs information mapping (e.g. Notification Correlation ID to AF Transaction ID), and invokes the Nnef\_TrafficInfluence\_Notify service operation to forward the notification to the AF by sending the HTTP request to the callback URI "notificationDestination" as specified in 3GPP TS 29.522 [24]. If the notification from the SMF includes an URI for the AF acknowledgement, the NEF also notifies with a URI for the AF acknowledgement as described in 3GPP TS 29.522 [24]. +9. The AF sends an HTTP "204 No Content" response to the NEF. +10. The NEF sends an HTTP "204 No Content" response to the SMF. +- 11-12. When receiving the notification with the URI for AF acknowledgement from the NEF, the AF invokes Nnef\_TrafficInfluence\_AppRelocationInfo service operation by sending an HTTP POST request to the callback URI "{afAckUri}" to acknowledge the notification, and the NEF sends a "204 No Content" response to the AF. If the "ULBuffering" feature is supported, the AF may provide an indication that buffering of uplink traffic to the target DNAI is needed to the NEF. +- 13-14. When receiving the AF acknowledgement from the AF, to forward it to the SMF, the NEF invokes Nsmf\_EventExposure\_AppRelocationInfo service operation by sending an HTTP POST request to the callback URI "{ackUri}", and the SMF sends a "204 No Content" response to the NEF. If the NEF receives the indication that buffering of uplink traffic to the target DNAI is needed and the NEF determines that the SMF supports the "ULBuffering" feature as defined in 3GPP TS 29.508 [8], the NEF provides the indication that buffering of uplink traffic to the target DNAI is needed to the SMF. + +If the AF traffic influence request affects ongoing PDU session, the traffic influence procedure is performed as depicted in Figure 5.5.3.2-2. + +![Sequence diagram showing the processing of AF requests to influence traffic routing for sessions not identified by a UE address. The diagram involves five main participants: SMF, PCF, UDR, NEF, and AF. The process starts with the SMF and PCF performing an SM Policy Association Establishment procedure. The AF sends a request to the NEF, which then interacts with the UDR and PCF to determine parameter mapping and PLMN. The UDR sends a notify request to the PCF, which then updates the SMF. The SMF then sends an event exposure notify request to the NEF, which in turn sends a notify request and app relocation info request to the AF. The AF responds, and the NEF responds to the SMF, which finally responds to the PCF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant UDR + participant NEF + participant AF + + Note over SMF, PCF: 0. SM Policy Association Establishment procedure + + AF->>NEF: 1.Nnef_TrafficInfluence_Create/Update/Delete request + Note over NEF: 2.parameter mapping and PLMN determination + NEF->>UDR: 3.Nudr_DataRepository_Create/Update/Delete request + UDR-->>NEF: 4.Nudr_DataRepository_Create/Update/Delete response + NEF-->>AF: 5.Nnef_TrafficInfluence_Create/Update/Delete response + + UDR->>PCF: 6.Nudr_DataRepository_Notify request + PCF-->>UDR: 7.Nudr_DataRepository_Notify response + + PCF->>SMF: 8.Npcf_SMPolicyControl_UpdateNotify request + SMF-->>PCF: 9.Npcf_SMPolicyControl_UpdateNotify response + + Note over SMF: 9a. User Plane Reconfiguration + + SMF->>NEF: 10.Nsmf_EventExposure_Notify request + NEF-->>AF: 11.Nnef_TrafficInfluence_Notify request + AF-->>NEF: 12.Nnef_TrafficInfluence_Notify response + NEF-->>AF: 14.Nnef_TrafficInfluence_AppRelocationInfo request + AF-->>NEF: 15.Nnef_TrafficInfluence_AppRelocationInfo response + + SMF-->>NEF: 16.Nsmf_EventExposure_AppRelocationInfo request + NEF-->>SMF: 17.Nsmf_EventExposure_AppRelocationInfo response + +``` + +Sequence diagram showing the processing of AF requests to influence traffic routing for sessions not identified by a UE address. The diagram involves five main participants: SMF, PCF, UDR, NEF, and AF. The process starts with the SMF and PCF performing an SM Policy Association Establishment procedure. The AF sends a request to the NEF, which then interacts with the UDR and PCF to determine parameter mapping and PLMN. The UDR sends a notify request to the PCF, which then updates the SMF. The SMF then sends an event exposure notify request to the NEF, which in turn sends a notify request and app relocation info request to the AF. The AF responds, and the NEF responds to the SMF, which finally responds to the PCF. + +**Figure 5.5.3.3-2: Processing AF requests to influence traffic routing for Sessions not identified by an UE address, affecting ongoing PDU session** + +0. For non HR-SBO scenarios, the PCF subscribes to the changes of traffic influence data in the UDR during SM Policy Association establishment procedure (see clause 5.2.1). +- 1-5. These steps are the same as steps 1-5 in Figure 5.5.3.3-1, with the difference that in step 2 in that figure, if the NEF determines that the HPLMN is the PLMN that the NEF belongs to, the procedure continues as described in this clause. +- 6-7. The UDR invokes the Nudr\_DataRepository\_Notify service operation to PCF(s) that have subscribed to modifications of AF requests by sending the HTTP POST request to the callback URI "{notificationUri}", and the PCF sends a "204 No Content" response to the UDR. +- 8-9. Upon receipt of the AF request from the UDR, the PCF determines if existing PDU Sessions are potentially impacted by the AF request. For each of these PDU Sessions, the PCF invokes the Npcf\_SMPolicyControl\_UpdateNotify service operation to update the SMF with corresponding PCC rule(s) by sending the HTTP POST request to the callback URI "{notificationUri}/update" as described in clause 5.2.2.2.1. +- 9a. This step is the same as step 6a in Figure 5.5.3.3-1. + +10-17. These steps are the same as steps 7-14 in Figure 5.5.3.3-1. + +#### 5.5.3.4 AF request on PDU Sessions supporting HR-SBO + +If the AF in VPLMN request to influence the traffic routing of PDU Sessions supporting HR-SBO (e.g., for the purpose of subscription to UP path management events on HR-SBO Sessions in VPLMN), the traffic influence procedure is performed as depicted in Figure 5.5.3.4-1. + +![Sequence diagram showing the processing of AF requests on PDU Sessions supporting HR-SBO between VPLMN and HPLMN.](21ad58fee90f2be50708ff541d225507_img.jpg) + +The diagram illustrates the sequence of messages for processing AF requests on PDU Sessions supporting HR-SBO. It is divided into two network domains: VPLMN and HPLMN. + +**Participants:** + +- VPLMN:** V-SMF, V-UDR, V-NEF, V-AF +- HPLMN:** H-SMF, H-PCF + +**Sequence of Messages:** + +- Step 1 - 5 of Figure 5.5.3.3-1 (Summary block) +- V-AF sends **Nsmf\_PDUSession\_Create/Update request** to V-SMF. +- V-SMF sends **Npcf\_SMPolicyControl\_Create/Update request** to H-SMF. +- H-SMF sends **Npcf\_SMPolicyControl\_Create/Update response** to V-SMF. +- V-SMF sends **Nsmf\_PDUSession\_Create/Update response** to V-AF. +- H-SMF sends **Npcf\_SMPolicyControl\_UpdateNotify request** to H-PCF. +- H-PCF sends **Npcf\_SMPolicyControl\_UpdateNotify response** to H-SMF. +- H-SMF sends **Nsmf\_PDUSession\_Update request** to V-SMF. +- V-SMF sends **Nsmf\_PDUSession\_Update response** to H-SMF. +- V-AF sends **Nnef\_TrafficInfluenceData\_Subscribe request** to V-NEF. +- V-NEF sends **Nnef\_TrafficInfluenceData\_Subscribe response** to V-AF. +- V-AF sends **Nudr\_DataRepository\_Subscribe request** to V-UDR. +- V-UDR sends **Nudr\_DataRepository\_Subscribe response** to V-AF. +- V-AF sends **Nudr\_DataRepository\_Notify request** to V-UDR. +- V-UDR sends **Nudr\_DataRepository\_Notify response** to V-AF. +- V-NEF sends **Nnef\_TrafficInfluenceData\_Notify request** to V-AF. +- V-AF sends **Nnef\_TrafficInfluenceData\_Notify response** to V-NEF. +- User Plane Reconfiguration** (indicated by a box at the bottom left of the V-SMF lifeline). + +Sequence diagram showing the processing of AF requests on PDU Sessions supporting HR-SBO between VPLMN and HPLMN. + +**Figure 5.5.3.4-1: Processing AF requests on PDU Sessions supporting HR-SBO** + +- The V-AF requests to influence traffic routing is the same as steps 1 to step 5 of of Figure 5.5.3.3-1. The V-NEF determines in step 2 in that figure that the HPLMN is different from the PLMN the V-NEF belongs to. The V-NEF derives the UE identity(ies) from the AF request information as defined in 3GPP TS 29.522 [24] before storing it in the V-UDR. + +Editor's note: How roamers will be identified in TrafficInfluData is FFS. + +2. The V-SMF may include the HR-SBO support indication in Nsmf\_PDUSession\_Create/Update request as described in 3GPP TS 29.502 [52]. +- 3-4. If the "HR-SBO" feature is supported and the HR-SBO support indication was received from the V-SMF in step 2, the H-SMF may include the HR-SBO support indication in the SM policy association as defined in clauses 4.2.2.2 and 4.2.4.2 of 3GPP TS 29.512 [9]. + +When the H-SMF provides the HR-SBO support indication to the PCF, the H-PCF of the PDU Session may provide the VPLMN Specific Offloading Policy for the local part of the DN in VPLMN clause 4.2.6.1 of 3GPP TS 29.512 [9]. + +5. The H-SMF may include the VPLMN Specific Offloading Policy in Nsmf\_PDUSession\_Create/Update response as described in 3GPP TS 29.502 [52]. +- 6-7. When the H-SMF provides the HR-SBO support indication to the H-PCF, the H-PCF of the PDU Session may also provide the VPLMN Specific Offloading Policy for the local part of the DN in VPLMN in Npcf\_SMPolicyControl\_UpdateNotify request. +- 8-9. The H-SMF may include the VPLMN Specific Offloading Policy in Nsmf\_PDUSession\_Update request as described in clause 5.2.2.3 of 3GPP TS 29.502 [52]. +- 10-11. The V-SMF may subscribe to notification of AF request by invoking Nnef\_TrafficInfluenceData\_Subscribe service from V-NEF as defined in clause 4.4.2.2 of 3GPP TS 29.591 [67]. +- 12-13. If the V-NEF receives the subscription from the V-SMF in step 10, the V-NEF subscribes to notification of AF request by invoking Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "Influence Data Subscription" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. +- 14-15. The UDR invokes the Nudr\_DataRepository\_Notify service operation to V-NEF that has subscribed to modifications of AF requests by sending the HTTP POST request to the callback URI "{notificationUri}", and the V-NEF sends a "204 No Content" response to the UDR. + +**Editor's Note:** What information is used in step 1 to identify the user in the UDR so that it can be identified in steps 12-15 and whether additional steps are needed to get it requires further work in stage 2. + +- 16-17. The V-NEF may send notification to the V-SMF which has subscribed to AF request by invoking Nnef\_TrafficInfluenceData\_Notify service operation to the V-SMF as defined in clause 4.4.2.4 of 3GPP TS 29.591 [67]. +18. This step is the same as the step 3a in Figure 5.5.3.2-1. + +### 5.5.4 Negotiation for future background data transfer procedure + +![Sequence diagram illustrating the Negotiation for future background data transfer procedure between UDR, (H-)PCF, NEF, and AF.](10781f43062bf3e9601a1e086710556c_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant (H-)PCF + participant UDR + + Note right of (H-)PCF: 5. Policy decision + + AF->>NEF: 1. Nnef_BDTPNegotiation_Create request + NEF->>(H-)PCF: 2. Npcf_BDTPolicyControl_Create request + (H-)PCF->>UDR: 3. Nudr_DataRepository_Query request + UDR-->>(H-)PCF: 4. Nudr_DataRepository_Query response + Note right of (H-)PCF: 5. Policy decision + (H-)PCF->>NEF: 6. Npcf_BDTPolicyControl_Create response + NEF->>AF: 7. Nnef_BDTPNegotiation_Create response + AF->>NEF: 8. Nnef_BDTPNegotiation_Update request + NEF->>(H-)PCF: 9. Npcf_BDTPolicyControl_Update request + (H-)PCF->>UDR: 12. Nudr_DataRepository_Update request + UDR-->>(H-)PCF: 13. Nudr_DataRepository_Update response + (H-)PCF-->>NEF: 10. Npcf_BDTPolicyControl_Update response + NEF-->>AF: 11. Nnef_BDTPNegotiation_Update response + +``` + +Sequence diagram illustrating the Negotiation for future background data transfer procedure between UDR, (H-)PCF, NEF, and AF. + +**Figure 5.5.4-1: Negotiation for future background data transfer procedure** + +1. The AF invokes the Nnef\_BDTPNegotiation\_Create service operation by sending an HTTP POST request to the resource "BDT Subscription" to get background data transfer policies. The AF request shall contain an ASP identifier, the volume of data to be transferred per UE, the expected amount of UEs, the desired time window and optionally, network area information either as a geographical area (e.g. a civic address or shapes), or an area of interest that includes a list of TAs and/or list of NG-RAN nodes and/or a list of cell identifiers. When the AF provides a geographical area, then the NEF maps it based on local configuration into a short list of TAs and/or NG-RAN nodes and/or cells identifiers that is provided to the (H-)PCF. + +If the "BdtNotification\_5G" feature defined in 3GPP TS 29.122 [34] is supported, the AF request may contain a notification URI to request the BDT warning notification. + +NOTE 1: A 3rd party application server is typically not able to provide any specific network area information and if so, the AF request is for a whole operator network. + +2. Upon receipt of a Background Data Transfer request from the AF indicating a transfer policy request, the NEF invokes the Npcf\_BDTPolicyControl\_Create service operation with the (H-)PCF by sending an HTTP POST request to the resource "BDT policies". The request operation includes the ASP identifier, the volume of data to be transferred per UE, the expected number of UEs, the desired time window, and optionally the network area information (list of TAs and/or NG-RAN nodes and/or cells identifiers). + +If the AF requests the BDT warning notification in step 1, and if the "BdtNotification\_5G" feature defined in 3GPP TS 29.554 [26] is supported, the NEF provides a notification URI to request the BDT warning notification correspondingly. + +NOTE 2: The NEF may contact any PCF in the operator network. + +- 3-4. The (H-) PCF may invoke the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request to the resource "BdtData", to request from the UDR all stored transfer policies. The UDR sends an HTTP "200 OK" response to the (H-) PCF. + +NOTE 3: In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +5. The (H-) PCF determines one or more transfer policies based on the information received from the NEF and other available information (e.g. network policy, existing transfer policies, network area information, network performance information from the NWDAF and load status estimation for the desired time window). +6. The (H-) PCF sends a "201 Created" response to the Npcf\_BDTPolicyControl\_Create service operation with the acceptable one or more transfer policies and a Background Data Transfer Reference ID. +7. The NEF sends a "201 Created" response to forward the received transfer policies to the AF. If the NEF received only one background transfer policy from the (H) PCF, steps 8-11 are not executed and the flow proceeds to step 12. Otherwise, the flow proceeds to step 8. +8. The AF invokes the Nnef\_BDTPNegotiation\_Update service operation by sending an HTTP PATCH request to the resource "Individual BDT Subscription" to provide the NEF with the selected background data transfer policy. The AF may also request to disable/enable the BDT warning notification if the "BdtNotification\_5G" feature defined in 3GPP TS 29.122 [34] is supported. +9. The NEF invokes the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the resource "Individual BDT policy" to provide the (H-)-PCF with the selected background data transfer policy. The NEF may also request to disable/enable the BDT warning notification if the "BdtNotification\_5G" feature defined in 3GPP TS 29.554 [26] is supported. +10. The (H-) PCF sends an HTTP PATCH response message to the NEF. +11. The NEF sends an HTTP PATCH response message to the AF. +- 12-13. If the (H-)PCF does not locally store the transfer policy and, if applicable, BDT warning notification information, it invokes the Nudr\_DataRepository\_Update service operation by sending an HTTP PUT request to the resource "IndividualBdtData", to store for the provided ASP identifier the new transfer policy together with the associated background data transfer reference ID, the volume of data per UE, the expected number of UEs and if available the corresponding network area information and if applicable, warning notification information in the UDR. The UDR sends an HTTP "201 Created" response to the (H-)PCF. + +NOTE 4: For details of Nnef\_BDTPNegotiation\_Create/Update service operations refer to 3GPP TS 29.522 [24]. + +NOTE 5: For details of Npcf\_BDTPolicyControl\_Create/Update service operations refer to 3GPP TS 29.554 [26]. + +NOTE 6: For details of Nudr\_DataRepository\_Query/Update service operations refer to 3GPP TS 29.519 [12] and 3GPP TS 29.504 [27]. + +NOTE 7: When the AF sends an HTTP PUT request to the NEF to update BDT negotiation data different from selecting a transfer policy and/or toggling the BDT warning notification, the procedure defined in this clause applies, and in this case, Nnef\_BDTPNegotiation\_Create service operation is replaced by Nnef\_BDTPNegotiation\_Update service operation in step 1 and step 7. + +### 5.5.4A Modification of BDT warning notification request indication procedure + +![Sequence diagram showing the modification of BDT warning notification request indication procedure. Lifelines: UDR, (H-)PCF, NEF, AF. The sequence starts with AF sending a request to NEF, which then sends a request to (H-)PCF. (H-)PCF sends a response to NEF, which sends a response to AF. (H-)PCF then sends a request to UDR, which sends a response back to (H-)PCF.](a3472689858b068ef469213682965325_img.jpg) + +``` +sequenceDiagram + participant AF + participant NEF + participant (H-)PCF + participant UDR + Note right of AF: 1. Nnef_BDTPNegotiation_Update request + AF->>NEF: 1. Nnef_BDTPNegotiation_Update request + Note right of NEF: 2. Npcf_BDTPolicyControl_Update request + NEF->>(H-)PCF: 2. Npcf_BDTPolicyControl_Update request + Note right of (H-)PCF: 3. Npcf_BDTPolicyControl_Update response + (H-)PCF->>NEF: 3. Npcf_BDTPolicyControl_Update response + Note right of NEF: 4. Nnef_BDTPNegotiation_Update response + NEF->>AF: 4. Nnef_BDTPNegotiation_Update response + Note right of (H-)PCF: 5. Nudr_DataRepository_Update request + (H-)PCF->>UDR: 5. Nudr_DataRepository_Update request + Note right of UDR: 6. Nudr_DataRepository_Update response + UDR-->>(H-)PCF: 6. Nudr_DataRepository_Update response +``` + +Sequence diagram showing the modification of BDT warning notification request indication procedure. Lifelines: UDR, (H-)PCF, NEF, AF. The sequence starts with AF sending a request to NEF, which then sends a request to (H-)PCF. (H-)PCF sends a response to NEF, which sends a response to AF. (H-)PCF then sends a request to UDR, which sends a response back to (H-)PCF. + +**Figure 5.5.4A-1: Modification of BDT warning notification request indication procedure** + +1. The AF invokes the Nnef\_BDTPNegotiation\_Update service operation by sending an HTTP PATCH request to the resource "Individual BDT Subscription" to disable/enable the BDT warning notification if the "BdtNotification\_5G" feature defined in 3GPP TS 29.122 [34] is supported. +2. The NEF invokes the Npcf\_BDTPolicyControl\_Update service operation by sending an HTTP PATCH request to the resource "Individual BDT policy" to disable/enable the BDT warning notification if the "BdtNotification\_5G" feature defined in 3GPP TS 29.554 [26] is supported. +3. The (H-) PCF sends an HTTP PATCH response message to the NEF. +4. The NEF sends an HTTP PATCH response message to the AF. +- 5-6. If the (H-)PCF does not locally store the BDT warning notification information, it invokes the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the resource "IndividualBdtData", to store the warning notification information in the UDR. The UDR responds to the (H-)PCF. + +### 5.5.5 BDT warning notification procedure + +![Sequence diagram of the BDT warning notification procedure involving UDR, NWDAF, (H-)PCF, NEF, and AF.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant UDR + participant NWDAF + participant HPCF as (H-)PCF + participant NEF + participant AF + + Note right of HPCF: 0. Negotiation for future background data transfer procedure + Note left of HPCF: 1. PCF subscribes to network performance and is notified that network performance has degraded + HPCF->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>HPCF: 3. Nudr_DataRepository_Query response + Note left of HPCF: 4. Identifying affected transfer policies + Note left of HPCF: 5. Calculation of new candidate transfer policies + HPCF->>UDR: 6. Nudr_DataRepository_Update request + UDR-->>HPCF: 7. Nudr_DataRepository_Update response + HPCF->>NEF: 8. Npcf_BDTPolicyControl_Notify request + NEF->>AF: 9. Nnef_BDTPNegotiation_Notify request + AF-->>NEF: 10. Nnef_BDTPNegotiation_Notify response + NEF-->>HPCF: 11. Npcf_BDTPolicyControl_Notify response + Note right of AF: 12. AF checks candidate transfer policies + Note right of HPCF: 13. Steps 8-11 from subclause 5.5.4 + + alt Alternative A: AF selected transfer policy from candidate list + Note left of UDR: Alternative A: AF selected transfer policy from candidate list + AF->>UDR: 14A. Nudr_DataRepository_Update request + UDR-->>AF: 15A. Nudr_DataRepository_Update response + else Alternative B: AF did not select transfer policy from candidate list + Note left of UDR: Alternative B: AF did not select transfer policy from candidate list + AF->>UDR: 14B. Nudr_DataRepository_Delete request + UDR-->>AF: 15B. Nudr_DataRepository_Delete response + end + + HPCF->>UDR: 16. Nudr_DataRepository_Notify request + UDR-->>HPCF: 17. Nudr_DataRepository_Notify response + Note left of HPCF: 18. PCF initiates "UE Policy Association Modification" Procedure, see subclause 5.6.2.2 + Note left of HPCF: 19. PCF initiates "SM Policy Association Modification initiated by the PCF" Procedure, see subclause 5.2.2.2 or "SM Policy Association Termination initiated by the PCF" see subclause 5.2.3.2. + +``` + +The sequence diagram illustrates the BDT warning notification procedure. It begins with a negotiation for future background data transfer (step 0). The PCF subscribes to network performance and receives a degradation notification (step 1). It then queries the UDR for data (steps 2-3), identifies affected policies (step 4), and calculates new candidate policies (step 5). The PCF updates the UDR (steps 6-7) and sends a notification to the NEF (step 8). The NEF forwards this to the AF (step 9). The AF checks the candidate policies (step 12) and responds (step 10). The NEF then responds to the PCF (step 11). A loop (steps 8-11) is referenced from subclause 5.5.4. Two alternatives are shown: Alternative A (AF selected a policy) involves an update request/response (steps 14A-15A); Alternative B (AF did not select a policy) involves a delete request/response (steps 14B-15B). Finally, the PCF sends a notification to the UDR (steps 16-17) and initiates UE and SM policy association modifications (steps 18-19). + +Sequence diagram of the BDT warning notification procedure involving UDR, NWDAF, (H-)PCF, NEF, and AF. + +Figure 5.5.5-1: BDT warning notification procedure + +0. The AF subscribes to BDT warning notification from the (H-)PCF via NEF during Negotiation for future background data transfer procedure (see clause 5.5.4). + +1. The (H-)PCF subscribes to network performance from the NWDAF, and is notified when the network performance in the area of interest goes below the criteria from the NWDAF as described in clause 5.7.5 of 3GPP TS 29.552 [48]. + +2-3. The (H-)PCF may invoke the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request to the "BdtData" collection resource, to request from the UDR all stored transfer policies. The UDR sends an HTTP "200 OK" response to the (H-)PCF. + +NOTE 1: If only one PCF is deployed in the network, transfer policies might be locally stored in the PCF and the interaction with the UDR is not required. + +4. The (H-)PCF identifies the transfer policies that are affected by degradation of the network performance and for each affected transfer policy the (H-)PCF determines the ASP of which the background traffic will be influenced by the degradation of network performance and which requested the H-PCF to send the notification. + +5. The (H-)PCF decides, based on operator policies, for each of the affected transfer policies whether a list of candidate transfer policies has to be calculated. + +NOTE 2: If the (H-)PCF does not find any new candidate BDT policies, the previously negotiated BDT policy is kept and no interaction with the AF occurs i.e. steps 6 to 19 are not performed. + +6-7. If the (H-)PCF stored the affected transfer policy in the UDR and one or more new candidate BDT policies are calculated, the (H-)PCF invokes the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the resource "IndividualBdtData", to invalidate the affected background transfer policy in the UDR. The UDR sends an HTTP "200 OK" or "204 No Content" response to the (H-)PCF. + +8. The (H-)PCF invokes the Npcf\_BDTPolicyControl\_Notify service operation by sending the HTTP POST request with the BDT warning notification to the Notification URI "{notifUri}". + +The BDT warning notification includes the BDT Reference ID of the impacted transfer policy and optionally the time window when the network performance will go below the criteria set by the operator, the network area where the network performance will go below the criteria set by the operator and the list of candidate transfer policies. + +9. Upon the reception of the BDT warning notification from the (H-)PCF, the NEF invokes the Nnef\_BDTPNegotiation\_Notify service operation by sending the HTTP POST request with the BDT warning notification to the Notification URI "{notificationDestination}". + +10. The AF sends an HTTP POST response to the NEF. + +11. The NEF sends an HTTP POST response to the (H-)PCF. + +12. When the AF receives the BDT warning notification, the AF checks new candidate background transfer policies. + +13. If the AF selected one of the background transfer policies from the received candidate list or decided to indicate that none of the candidate background transfer policies is acceptable, steps 8 - 11 from clause 5.5.4 are executed with the exception that an indication that no background transfer policy is selected is included in the HTTP PATCH request if the AF did not select any of the background transfer policy. + +14A-15A. If the AF selected one of the background transfer policies from the candidate list and if the (H-)PCF stored the affected transfer policy in the UDR, the (H-)PCF shall invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the resource "IndividualBdtData", to update the UDR with the selected candidate transfer policy. The UDR sends an HTTP "200 OK" or "204 No Content" response to the (H-)PCF. + +14B-15B. If the AF did not select one of the background transfer policies from the candidate list and if the (H-)PCF stored the affected transfer policy in the UDR, the (H-)PCF shall invoke the Nudr\_DataRepository\_Delete service operation to remove the affected transfer policy from the UDR by sending the HTTP DELETE request to the "IndividualBdtData" resource. The UDR sends an HTTP "204 No Content" response to the (H-)PCF. + +NOTE 3: If the AF did not invoke within an operator configurable time the Nnef\_BDTPNegotiation\_Update service operation to indicate if the one of the background transfer policies from the candidate list is selected or not, the (H-)PCF might remove the no longer valid BDT policy from UDR. + +16-17. If the PCF subscribed to notification of "IndividualBDTdata" resource data changes in the UDR, i.e. the transfer policies are updated or deleted, the UDR invokes the Nudr\_DataRepository\_Notify service operation to the PCF by sending the HTTP POST request to the callback URI "{notificationUri}" as specified in 3GPP TS 29.519 [12]. + +NOTE 4: The PCF might be a different one than the PCF handling the BDT negotiation procedures, although in the figure it is represented as the same one for the simplification. + +18. If the (H-)PCF identifies the URSP rules to UE need to be updated the (H-)PCF initiates the procedure "UE Policy Association Modification" defined in clause 5.6.2.2.2. + +19. If the (H-)PCF identifies that: + +- the PCC rules and/or session rules delivered to the SMF need to be updated the (H-)PCF initiates the procedure "SM Policy Association Modification initiated by the PCF" defined in clause 5.2.2.2; or +- the SM policy association needs to be terminated the (H-)PCF initiates the procedure "SM Policy Association Termination initiated by the PCF" defined in clause 5.2.3.2. + +NOTE 5: For details of Nnef\_BDTPNegotiation\_Notify service operation refer to 3GPP TS 29.522 [24]. + +NOTE 6: For details of Npcf\_BDTPolicyControl\_Notify service operation refer to 3GPP TS 29.554 [26]. + +NOTE 7: For details of Nudr\_DataRepository\_Query/Update/Notify/Delete service operations refer to 3GPP TS 29.519 [12] and 3GPP TS 29.504 [27]. + +### 5.5.6 Background data transfer policy applying procedure + +![Sequence diagram showing the background data transfer policy applying procedure between AMF, PCF, UDR, NEF, and AF.](e354b57563dae469c00b412b2abdf765_img.jpg) + +The sequence diagram illustrates the interaction between five network functions: AMF, PCF, UDR, NEF, and AF. The procedure is as follows: + +- 0. Negotiation for future background data transfer procedure:** A horizontal message across the top of the diagram. +- 1. Nnef\_ApplyPolicy\_Create/Update/Delete request:** AF sends this request to NEF. +- 2. parameter mapping:** A horizontal message from NEF to UDR. +- 3. Nudr\_DataRepository\_Create/Update/Delete request:** NEF sends this request to UDR. +- 4. Nudr\_DataRepository\_Create/Update/Delete response:** UDR sends this response to NEF. +- 5. Nnef\_ApplyPolicy\_Create/Update/Delete response:** NEF sends this response to AF. +- (6A) UE Policy Association Modification procedure:** A shaded block containing: + - 6a. Nudr\_DataRepository\_Notify request:** PCF sends this request to UDR. + - 6b. Nudr\_DataRepository\_Notify response:** UDR sends this response to PCF. + - 6c. UE Policy Association Modification procedure:** A horizontal message from PCF to AMF. +- (6B) UE Policy Association Establishment procedure:** A shaded block containing: + - 7. Nudr\_DataRepository\_Update request:** PCF sends this request to UDR. + - 8. Nudr\_DataRepository\_Update response:** UDR sends this response to PCF. + +Sequence diagram showing the background data transfer policy applying procedure between AMF, PCF, UDR, NEF, and AF. + +Figure 5.5.6-1: Background data transfer policy applying procedure + +0. The AF negotiates policy for background data transfer during Negotiation for future background data transfer procedure (see clause 5.5.4). +1. To apply the negotiated Background Data Transfer Policy to UE or a group of UE, the AF invokes the Nnef\_ApplyPolicy\_Create service operation to the NEF by sending the HTTP POST request to the "Applied BDT Policy Subscriptions" resource. + +To update the applied policy, the AF invokes the Nnef\_ApplyPolicy\_Update service operation by sending the HTTP PATCH request to the "Individual Applied BDT Policy Subscription" resource. + +To remove the applied policy, the AF invokes the Nnef\_ApplyPolicy\_Delete service operation by sending the HTTP DELETE request to the "Individual Applied BDT Policy Subscription" resource. + +NOTE 1: For details of Nnef\_ApplyPolicy\_Create/Update/Delete service operations refer to 3GPP TS 29.522 [24]. + +2. Upon receipt of the AF request, the NEF authorizes it and then performs the mapping from the information provided by the AF into information needed by the 5GC as described in 3GPP TS 23.502 [3]. +- 3-4. When receiving the Nnef\_ApplyPolicy\_Create request, the NEF invokes the Nudr\_DataRepository\_Create service operation to store the AF request information in the UDR by sending the HTTP PUT request to the "Individual Applied BDT Policy Data" resource, and the UDR sends a "201 Created" response. + +When receiving the Nnef\_ApplyPolicy\_Update request, the NEF invokes the Nudr\_DataRepository\_Update service operation to modify the AF request information in the UDR by sending the HTTP PATCH request to the resource "Individual Applied BDT Policy Data", and the UDR sends a "200 OK" or "204 No Content" response. + +When receiving the Nnef\_ApplyPolicy\_Delete request, the NEF invokes the Nudr\_DataRepository\_Delete service operation to delete the AF requirements from the UDR by sending the HTTP DELETE request to the "Individual Applied BDT Policy Data" resource, and the UDR sends a "204 No Content" response. + +5. The NEF sends the HTTP response message to the AF correspondingly. +- 6A. The PCF previously subscribed to the changes of Applied BDT Policy Data during UE Policy Association Establishment procedure (see clause 5.6.1.2). + - 6a. The UDR invokes the Nudr\_DataRepository\_Notify service operation to PCF(s) that have subscribed to the changes of Applied BDT Policy Data by sending the HTTP POST request to the callback URI "{notificationUri}". + - 6b. The PCF sends a "204 No Content" response to the UDR. + - 6c. The PCF initiates UE Policy Association Modification procedure (see clause 5.6.2.2.2) to send the background data transfer policy to the UE. +- 6B. The PCF retrieves the Applied BDT Policy Data in the UDR by invoking the Nudr\_DataRepository\_Query service operation and sends the background data transfer policy to the UE during UE Policy Association Establishment procedure (see clause 5.6.1.2). +7. The PCF invokes the Nudr\_DataRepository\_Update service operation to the UDR by sending the HTTP PATCH request to the "SessionManagementPolicyData" resource, to store the BDT reference ID(s) into the PDU session related policy data. +8. The UDR sends a "204 No Content" or "200 OK" response to the PCF. + +NOTE 2: For details of the Nudr\_DataRepository\_Create/Update/Delete/Notify service operations refer to 3GPP TS 29.504 [27] and 3GPP TS 29.519 [12]. + +### 5.5.7 IPTV configuration provisioning + +![Sequence diagram of IPTV configuration provisioning procedure. Lifelines: SMF, PCF, UDR, NEF, AF. The sequence starts with the AF sending a request to the NEF. The NEF performs parameter mapping and sends a request to the UDR. The UDR returns a response to the NEF, which then returns a response to the AF. The UDR also sends a notify request to the PCF, which returns a notify response. The PCF then initiates the SM Policy Association Modification procedure (6c) with the SMF. The SMF then initiates the SM Policy Association Establishment procedure (6B) with the PCF.](164d1b48231be457522b31965610ea3b_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant UDR + participant PCF + participant SMF + + Note right of AF: 1. Nnef_IPTVconfiguration_Create/Update/Delete request + AF->>NEF: 1. Nnef_IPTVconfiguration_Create/Update/Delete request + Note right of NEF: 2. parameter mapping + Note right of NEF: 3. Nudr_DataRepository_Create/Update/Delete request + NEF->>UDR: 3. Nudr_DataRepository_Create/Update/Delete request + Note right of UDR: 4. Nudr_DataRepository_Create/Update/Delete response + UDR->>NEF: 4. Nudr_DataRepository_Create/Update/Delete response + Note right of NEF: 5. Nnef_IPTVconfiguration_Create/Update/Delete response + NEF->>AF: 5. Nnef_IPTVconfiguration_Create/Update/Delete response + + Note left of SMF: (6A) + Note right of UDR: 6a. Nudr_DataRepository_Notify request + UDR->>PCF: 6a. Nudr_DataRepository_Notify request + Note right of PCF: 6b. Nudr_DataRepository_Notify response + PCF->>Udr: 6b. Nudr_DataRepository_Notify response + + Note right of SMF: 6c. SM Policy Association Modification procedure + SMF->>PCF: 6c. SM Policy Association Modification procedure + + Note left of SMF: (6B) + Note right of SMF: SM Policy Association Establishment procedure + SMF->>PCF: SM Policy Association Establishment procedure + +``` + +Sequence diagram of IPTV configuration provisioning procedure. Lifelines: SMF, PCF, UDR, NEF, AF. The sequence starts with the AF sending a request to the NEF. The NEF performs parameter mapping and sends a request to the UDR. The UDR returns a response to the NEF, which then returns a response to the AF. The UDR also sends a notify request to the PCF, which returns a notify response. The PCF then initiates the SM Policy Association Modification procedure (6c) with the SMF. The SMF then initiates the SM Policy Association Establishment procedure (6B) with the PCF. + +**Figure 5.5.7-1: IPTV configuration provisioning procedure** + +1. To configure IPTV information to UE or a group of UE, the AF invokes the Nnef\_IPTVconfiguration\_Create service operation to the NEF by sending an HTTP POST request to the "IPTV Configurations" resource . + +To update an existing IPTV configuration, the AF invokes the Nnef\_IPTVconfiguration\_Update service operation by sending an HTTP PUT or PATCH request to the "Individual IPTV Configuration" resource. + +To remove an existing IPTV configuration, the AF invokes the Nnef\_IPTVconfiguration\_Delete service operation by sending an HTTP DELETE request to the "Individual IPTV Configuration" resource. + +NOTE 1: For details of Nnef\_IPTVconfiguration\_Create/Update/Delete service operations refer to 3GPP TS 29.522 [24]. + +2. Upon receipt of the AF request, the NEF authorizes it and then performs the mapping from the information provided by the AF into information needed by the 5GC as described in 3GPP TS 23.502 [3]. + +- 3-4. When receiving the Nnef\_IPTVconfiguration\_Create request, the NEF invokes the Nudr\_DataRepository\_Create service operation to store the IPTV configuration in the UDR by sending the HTTP PUT request to the "Individual IPTV Configuration" resource, and the UDR sends a "201 Created" response. + +When receiving the Nnef\_IPTVconfiguration\_Update request, the NEF invokes the Nudr\_DataRepository\_Update service operation to modify the IPTV configuration in the UDR by sending the HTTP PUT/PATCH request to the resource "Individual IPTV Configuration", and the UDR sends a "200 OK" or "204 No Content" response. + +When receiving the Nnef\_IPTVconfiguration\_Delete request, the NEF invokes the Nudr\_DataRepository\_Delete service operation to delete the IPTV configuration from the UDR by sending the HTTP DELETE request to the "Individual IPTV Configuration" resource, and the UDR sends a "204 No Content" response. + +5. The NEF sends the HTTP response message to the AF correspondingly. +- 6A. The PCF previously subscribed to the changes of IPTV configuration during SM Policy Association Establishment procedure (see clause 5.2.1). + - 6a. The UDR invokes the Nudr\_DataRepository\_Notify service operation to PCF(s) that have subscribed to the changes of IPTV configuration by sending the HTTP POST request to the callback URI "{notificationUri}". + - 6b. The PCF sends a "204 No Content" response to the UDR. + - 6c. The PCF determines PCC rules based on the received IPTV configuration and initiates SM Policy Association Modification procedure (see clause 5.2.2.1). +- 6B. The PCF retrieves the IPTV configuration in the UDR by invoking the Nudr\_DataRepository\_Query service operation, determines PCC rules based on the retrieved IPTV configuration and send the PCC rules to the SMF during SM Policy Association Establishment procedure (see clause 5.2.1). + +NOTE 2: For details of the Nudr\_DataRepository\_Create/Update/Delete/Notify service operations refer to 3GPP TS 29.504 [27] and 3GPP TS 29.519 [12]. + +### 5.5.8 AF-based service parameter provisioning + +#### 5.5.8.1 AF-based service parameter provisioning to HPLMN + +Figure 5.5.8.1-1 shows the procedure for service specific parameter provisioning by the AF to HPLMN. The AF uses Nnef\_ServiceParameter service to provide the service specific parameters to the HPLMN and the UE. In the roaming case, PCF is replaced by H-PCF, and the AMF interacts with the V-PCF which interacts with H-PCF. + +![Sequence diagram showing the AF-based service parameter provisioning procedure to HPLMN. Lifelines: AMF, PCF, UDR, NEF, AF. The procedure involves service parameter creation/update/delete, parameter mapping, repository storage, notification handling, and UE policy association establishment.](d3ca266c298aeb34b019960c6c36f187_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant UDR + participant NEF + participant AF + + Note right of NEF: Error! No text of specified style in document. + Note left of AMF: Error! No text of specified style in document. + + AF->>NEF: 1. Nnef_ServiceParameter_Create/Update/Delete request + NEF->>NEF: 2. parameter mapping + NEF->>UDR: 3. Nudr_DataRepository_Create/Update/Delete request + UDR->>NEF: 4. Nudr_DataRepository_Create/Update/Delete response + NEF->>AF: 5. Nnef_ServiceParameter_Create/Update/Delete response + + Note left of AMF: (6A) + Note right of AMF: 6a. Nudr_DataRepository_Notify request + Note left of AMF: 6b. Nudr_DataRepository_Notify response + Note right of AMF: 6c. UE Policy Association Modification procedure + + Note left of AMF: (6B) + Note right of AMF: 6B1. UE Policy Association Establishment + Note right of AMF: 6B2. UE Request of V2XP and/or 5G ProSeP + + PCF->>NEF: 7. Npcf_EventExposure_Notify request + NEF->>PCF: 8. Npcf_EventExposure_Notify response + NEF->>AF: 9. Nnef_ServiceParameter_Notify request + AF->>NEF: 10. Nnef_ServiceParameter_Notify response + +``` + +Sequence diagram showing the AF-based service parameter provisioning procedure to HPLMN. Lifelines: AMF, PCF, UDR, NEF, AF. The procedure involves service parameter creation/update/delete, parameter mapping, repository storage, notification handling, and UE policy association establishment. + +**Figure 5.5.8.1-1: AF-based service parameter provisioning procedure to HPLMN** + +1. To provide service specific parameters (e.g. for URSP influence, V2X, A2X, 5G ProSe, or Ranging\_SL) to a UE or a group of UEs, the AF invokes the Nnef\_ServiceParameter\_Create service operation to the NEF by sending an HTTP POST request to the "Service Parameter Subscriptions" resource. + +To update existing service specific parameters, the AF invokes the Nnef\_ServiceParameter\_Update service operation by sending an HTTP PUT or PATCH request to the concerned "Individual Service Parameter Subscription" resource. + +To remove existing service specific parameters, the AF invokes the Nnef\_ServiceParameter\_Delete service operation by sending an HTTP DELETE request to the concerned "Individual Service Parameter Subscription" resource. + +The request may include AF subscription information to the report of the outcome of UE Policy procedure. + +NOTE 1: For further details on the Nnef\_ServiceParameter\_Create/Update/Delete service operations, refer to 3GPP TS 29.522 [24]. + +2. Upon reception of the AF request, the NEF authorizes it and then performs the mapping of the information provided by the AF into associated information needed by the 5GC (e.g. GPSI to SUPI), as described in + +3GPP TS 23.502 [3]. The NEF may also support service specific authorization as described in clause 4.4.20 of 3GPP TS 29.522 [24]. + +- 3-4. When receiving the Nnef\_ServiceParameter\_Create request, the NEF invokes the Nudr\_DataRepository\_Create service operation to store the received service parameters in the UDR by sending an HTTP PUT request to the "Individual Service Parameter Data" resource, and the UDR replies with a "201 Created" response (if the processing of the request is successful). + +When receiving the Nnef\_ServiceParameter\_Update request, the NEF invokes the Nudr\_DataRepository\_Update service operation to request the modification of the service parameters in the UDR by sending an HTTP PUT/PATCH request to the concerned "Individual Service Parameter Data" resource, and the UDR replies with a "200 OK" or "204 No Content" response (if the processing of the request is successful). + +When receiving the Nnef\_ServiceParameter\_Delete request, the NEF invokes the Nudr\_DataRepository\_Delete service operation to request the deletion of the service parameters from the UDR by sending an HTTP DELETE request to the concerned "Individual Service Parameter Data" resource, and the UDR replies with a "204 No Content" response (if the processing of the request is successful). + +5. The NEF sends back an HTTP response message to the AF correspondingly. + +- 6A. If the PCF(s) have previously subscribed to the changes of service parameters during the UE Policy Association Establishment procedure (see clause 5.6.1), then: + +- 6a. The UDR invokes the Nudr\_DataRepository\_Notify service operation to the PCF(s) that have subscribed to the changes of service parameters by sending an HTTP POST request to the associated callback URI(s) "{notificationUri}"; + +- 6b. The PCF(s) send back "204 No Content" response(s) to the UDR; and + +- 6c. The PCF(s) may derive UE policies (e.g. URSP, V2X, A2X, 5G ProSe, and/or Ranging\_SL policies) based on the received service parameters from the UDR, UE subscription data, local operator policies, the previously received requested V2X/5G ProSe/A2X/Ranging/SL policies and UE capabilities (e.g., V2X capabilities) from the AMF, and initiate a UE Policy Association Modification procedure if applicable (see clause 5.6.2.2) to deliver the UE policies to the UE. + +- 6B. + +- 6B1 During UE Policy Association Establishment procedure (see clause 5.6.1), the PCF(s) retrieve the service parameters in the UDR by invoking the Nudr\_DataRepository\_Query service operation, determine UE policies (e.g. URSP, V2X, A2X, 5G ProSe policies, and/or Ranging/SL) based on the retrieved service parameters from the UDR, UE subscription data, local operator policies and UE capabilities (e.g. V2X capabilities, A2X capabilities and/or 5G ProSe capabilities) from the AMF , and if applicable, deliver the UE policies (including the determined V2XP, A2XP, 5G ProSeP and/or RSLPP) to the UE and corresponding V2X N2 PC5, A2X N2 PC5, ProSe N2 PC5 and/or Ranging/SL N2 policy to the NG-RAN. + +- 6B2. After registration, when the UE requests V2XP, A2XP, 5G ProSeP and/or RSLPP, the AMF sends to the PCF an Namf\_Communication\_NIMessageNotify service operation with the requested V2XP, A2XP, 5G ProSeP and/or RSLPP. The PCF retrieves the service parameter in the UDR by invoking the Nudr\_DataRepository\_Query service operation, determines V2XP, A2XP, 5G ProSeP and/or RSLPP based on the retrieved service parameter from the UDR, the received requested V2XP, A2XP, 5G ProSeP and/or RSLPP, UE subscription data, local operator policies and the UE capabilities (e.g., V2X, A2X capabilities, ProSe and/or Ranging/SL capabilities) previously received from the AMF, and delivers the V2XP, A2XP and/or 5G ProSeP to the UE and the corresponding V2X N2 PC5, A2X N2 PC5, ProSe N2 PC5 and/or Ranging/SL N2 policy to the NG-RAN. + +NOTE 2: For further details on the Nudr\_DataRepository\_Create/Update/Delete/Notify service operations, refer to 3GPP TS 29.504 [27] and 3GPP TS 29.519 [12]. + +7. If the AF subscribed to notifications about the outcome of UE Policies delivery (provision/update/removal) due to Service specific parameter provisioning and the PCF derived the corresponding UE policies, the PCF invokes the Npcf\_EventExposure\_Notify service operation to inform the NEF about the outcome of the procedure by sending the HTTP POST request to the callback URI "{notifUri}". + +NOTE 3: The Callback URI "{notifUri}" is used for both implicit and explicit subscriptions as described in 3GPP TS 29.523 [49]. Notification URI for implicit subscriptions is retrieved from UDR as described in 3GPP TS 29.519 [12]. + +8. The NEF sends back "204 No Content" response to the PCF. +9. When the NEF receives Npcf\_EventExposure\_Notify, the NEF performs information mapping as described in 3GPP TS 29.522 [24] and triggers the appropriate Nnef\_ServiceParameter\_Notify message. +10. The AF sends back an HTTP response message to the NEF to acknowledge the notification. + +#### 5.5.8.2 AF-based service parameter provisioning to VPLMN + +Figure 5.5.8.2-1 shows the procedure for service specific parameter provisioning by the AF to VPLMN + +![Sequence diagram illustrating the AF-based service parameter provisioning procedure to VPLMN. The diagram shows interactions between UE, (R)AN, AMF, V-PCF, V-UDR, V-NEF, AF, and H-PCF. The process involves Nnef_ServiceParameter operations, Nudr_DataRepository operations, and UE Policy delivery/association establishment.](1d27fed9c01eb99f6535283f35fe3bbf_img.jpg) + +``` + +sequenceDiagram + participant UE + participant RAN as (R)AN + participant AMF + participant VPCF as V-PCF + participant VUDR as V-UDR + participant VNEF as V-NEF + participant AF + participant HPCF as H-PCF + + Note left of UE: (4A) + AF->>VNEF: 1. Nnef_ServiceParameter_Create / Update / Delete Request + VNEF->>VUDR: 2. Nudr_DataRepository_Create / Update / Delete Request/Response + VUDR-->>VNEF: + VNEF-->>AF: 3. Nnef_ServiceParameter_Create / Update / Delete Response + Note right of AF: + VNEF->>VPCF: 4a1. Nudr_DM_Notify + VPCF->>HPCF: 4a2. Npcf_UEPolicyControl_Update + Note right of HPCF: + VPCF->>AMF: 4a3. UE Policy delivery as specified in clause 5.6.2.1.3 + Note left of UE: (4B) + UE->>VPCF: 4b1. Npcf_UEPolicyControl_Create request + VPCF->>VUDR: 4b2. Nudr_DM_Query/Subscribe + VUDR-->>VPCF: + VPCF->>AMF: 4b3. UE Policy Association establishment as specified in clause 5.6.1.3 + Note right of AMF: + VPCF-->>HPCF: 5. Npcf_UEPolicyControl_UpdateNotify + Note right of HPCF: + VPCF-->>VNEF: 6. Npcf_EventExposure_Notify request + VNEF-->>VPCF: 7. Npcf_EventExposure_Notify response + Note right of VNEF: + VNEF->>AF: 8. Nnef_ServiceParameter_Notify Request + AF-->>VNEF: 9. Nnef_ServiceParameter_Notify Response + +``` + +Sequence diagram illustrating the AF-based service parameter provisioning procedure to VPLMN. The diagram shows interactions between UE, (R)AN, AMF, V-PCF, V-UDR, V-NEF, AF, and H-PCF. The process involves Nnef\_ServiceParameter operations, Nudr\_DataRepository operations, and UE Policy delivery/association establishment. + +**Figure 5.5.8.2-1: AF-based service parameter provisioning procedure to VPLMN** + +1. To provide service specific parameters (e.g. for AF influence on VPLMN-specific URSP rule) for any inbound roamer of the indicated PLMN IDs, the AF invokes the Nnef\_ServiceParameter\_Create/Update/Delete service operation to the V-NEF by sending an HTTP POST request to the "Service Parameter Subscriptions" resource. + +The request may include AF subscription information to the report of the outcome of UE Policy procedure. + +NOTE 1: For further details on the Nnef\_ServiceParameter\_Create/Update/Delete service operations, refer to 3GPP TS 29.522 [24]. + +2. Upon reception of the AF request, the V-NEF authorizes it and then performs the mapping of the information provided by the AF into associated information needed by the 5GC, as described in 3GPP TS 23.502 [3]. + +When receiving the Nnef\_ServiceParameter\_Create request, the V-NEF invokes the Nudr\_DataRepository\_Create service operation to store the received service parameters in the V-UDR by sending an HTTP PUT request to the "Individual Service Parameter Data" resource, and the V-UDR replies with a "201 Created" response (if the processing of the request is successful). + +When receiving the Nnef\_ServiceParameter\_Update request, the V-NEF invokes the Nudr\_DataRepository\_Update service operation to request the modification of the service parameters in the V-UDR by sending an HTTP PUT/PATCH request to the concerned "Individual Service Parameter Data" resource, and the UDR replies with a "200 OK" or "204 No Content" response (if the processing of the request is successful). + +When receiving the Nnef\_ServiceParameter\_Delete request, the V-NEF invokes the Nudr\_DataRepository\_Delete service operation to request the deletion of the service parameters from the V-UDR by sending an HTTP DELETE request to the concerned "Individual Service Parameter Data" resource, and the V-UDR replies with a "204 No Content" response (if the processing of the request is successful). + +3. The V-NEF sends back an HTTP response message to the AF correspondingly. + +4A. If the V-PCF(s) have previously subscribed to the changes of service parameters during the UE Policy Association Establishment procedure (see clause 5.6.1), then: + +4a1. The V-UDR invokes the Nudr\_DataRepository\_Notify service operation to the V-PCF(s) that have subscribed to the changes of service parameters by sending an HTTP POST request to the associated callback URI(s) "{notificationUri}"; + +The PCF(s) send back "204 No Content" response(s) to the UDR; and + +4a2. For each retrieved Service Parameter resource, the V-PCF forwards to the H-PCF(s) the AF guidance on VPLMN-specific URSP rule information received from the V-UDR for the SUPI(s) that belong to one of the indicated target PLMN Id(s) of inbound roamers by sending an HTTP POST request to the "Individual UE Policy Association" resource(s). The V-PCF determines the SUPI(s) that belong to one of the target PLMN Id(s) of inbound roamers by the longest matching criteria for the MCC and/or MNC of the SUPI and the PLMN Id. The V-PCF includes the mapped HPLMN S-NSSAI values in the request and, if obtained from the V-UDR, the AF subscription to VPLMN-specific URSP rule delivery outcome. + +4a3. The H-PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy and indicates the delivery of UE Policies to the UE as defined in clause 5.6.2.1.3, from step 3 to step 9. + +4B. + +4b1. The V-PCF receives the Npcf\_UEPolicyControl\_Create service operation as specified in clause 5.6.1.3, step 1. + +4b2. If the VPLMNSpecificURSP feature as specified in 3GPP TS 29.504 [27] is supported with the V-UDR, the V-PCF retrieves service parameters with URSP guidance invoking the Nudr\_DataRepository\_Query service operation and subscribes to changes in service parameters invoking the Nudr\_DataRepository\_Subscribe service operation. + +4b3. For each service parameter resource retrieved, if the UE belongs to one of the target PLMN Id(s) of inbound roamers, the V-PCF forwards to the H-PCF the AF(s) guidance on VPLMN-specific URSP rule, includes the mapped HPLMN S-NSSAI values and, if available, AF(s) subscription to the VPLMN-specific URSP rule delivery outcome retrieved from the V-UDR by invoking the Npcf\_UEPolicyControl\_Create service operation as specified in clause 5.6.1.3, step 1. The V-PCF determines the SUPI(s) that belong to one of the target PLMN Id(s) of inbound roamers by the longest matching for the MCC and/or MNC of the SUPI and the PLMN Id. The H-PCF triggers the delivery of UE Policies to the UE procedure as described in clause 5.6.1.3, steps 8-26. + +5. When the H-PCF received the response of the UE Policy delivery outcome, if the V-PCF indicated that the AF(s) subscribed to notifications about the outcome of VPLMN-specific URSP rules, the H-PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify service operation by sending an HTTP POST request to the callback URI "{notificationUri}/update" with the corresponding successful or unsuccessful delivery indication as specified in 3GPP TS 29.525 [31], clause 4.2.4.7. + +6. If the AF subscribed to notifications about the outcome of UE Policies delivery (provision/update/removal) due to Service specific parameter provisioning, the V-PCF invokes the Npcf\_EventExposure\_Notify service operation to inform the V-NEF about the outcome of the procedure (as indicated by the H-PCF) by sending the HTTP POST request to the callback URI "{notifUri}" as described in 3GPP TS 29.523 [49]. + +NOTE 2: The Callback URI "{notifUri}" is used for both implicit and explicit subscriptions as described in 3GPP TS 29.523 [49]. Notification URI for implicit subscriptions is retrieved from UDR as described in 3GPP TS 29.519 [12]. + +7. The V-NEF sends back "204 No Content" response to the V-PCF. +8. When the NEF receives Npcf\_EventExposure\_Notify, the NEF performs information mapping as described in 3GPP TS 29.522 [24] and triggers the appropriate Nnef\_ServiceParameter\_Notify message. +9. The AF sends back an HTTP response message to the NEF to acknowledge the notification. + +### 5.5.9 QoS monitoring procedure + +![Sequence diagram of the QoS monitoring procedure involving NWDAF, SMF, PCF, BSF, NEF, and AF.](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant BSF + participant PCF + participant SMF + participant NWDAF + + Note right of AF: 1. Nnef_AFsessionWithQoS_Create/Update/Delete request + AF->>NEF: 1. Nnef_AFsessionWithQoS_Create/Update/Delete request + Note right of NEF: 2. Authorization + NEF->>BSF: 3. Nbsf_Management_Discovery request + BSF-->>NEF: 4. Nbsf_Management_Discovery response + Note right of NEF: 5. Npcf_PolicyAuthorization_Create/Update/Delete request + NEF->>PCF: 5. Npcf_PolicyAuthorization_Create/Update/Delete request + PCF-->>NEF: 6. Npcf_PolicyAuthorization_Create/Update/Delete response + Note right of PCF: 7. Nnef_AFsessionWithQoS_Create/Update/Delete response + PCF->>NEF: 7. Nnef_AFsessionWithQoS_Create/Update/Delete response + Note right of NEF: 8. Npcf_SMPolicyControl_UpdateNotify request + NEF->>SMF: 8. Npcf_SMPolicyControl_UpdateNotify request + SMF-->>PCF: 9. Npcf_SMPolicyControl_UpdateNotify response + Note right of SMF: 10a. Nsmf_EventExposure_Subscribe request + SMF->>NWDAF: 10a. Nsmf_EventExposure_Subscribe request + NWDAF-->>SMF: 10b. Nsmf_EventExposure_Subscribe response + Note right of NWDAF: 11. Request UPF and NG-RAN to perform QoS monitoring + NWDAF->>SMF: 11. Request UPF and NG-RAN to perform QoS monitoring + Note right of SMF: (12A) 12a. Npcf_SMPolicyControl_Update request + SMF->>PCF: 12a. Npcf_SMPolicyControl_Update request + PCF-->>SMF: 12b. Npcf_SMPolicyControl_Update response + Note right of PCF: 12c. Npcf_PolicyAuthorization_Notify request + PCF->>NEF: 12c. Npcf_PolicyAuthorization_Notify request + NEF-->>PCF: 12d. Npcf_PolicyAuthorization_Notify response + Note right of NEF: (12B) 12a. Nsmf_EventExposure_Notify request + NEF->>SMF: 12a. Nsmf_EventExposure_Notify request + SMF-->>NEF: 12b. Nsmf_EventExposure_Notify response + Note right of SMF: 13. Nnef_AFsessionWithQoS_Notify request + SMF->>NEF: 13. Nnef_AFsessionWithQoS_Notify request + NEF-->>SMF: 14. Nnef_AFsessionWithQoS_Notify response + +``` + +Sequence diagram of the QoS monitoring procedure involving NWDAF, SMF, PCF, BSF, NEF, and AF. + +Figure 5.5.9-1: QoS monitoring procedure + +1. The AF subscribes to or unsubscribes from the QoS monitoring notification from the PCF via the NEF. The AF may subscribe to the notification of packet delay measurements, congestion and/or data rate monitoring QoS measurements performed by the UPF and/or packet delay variation and/or round-trip time delays over two QoS flows QoS measurements performed by the PCF. + +To create a subscription to the QoS monitoring information, the AF invokes the Nnef\_AFsessionWithQoS\_Create service operation to the NEF by sending the HTTP POST request to the "AS Session with Required QoS Subscriptions" resource. If the feature "ExposureToEAS" is supported, the AF may request the direct event notification from the UPF. + +To modify an existing subscription to the QoS monitoring information, the AF invokes the Nnwf\_AFsessionWithQoS\_Update service operation by sending the HTTP PUT or PATCH request to the "Individual AS Session with Required QoS Subscription" resource. + +To remove a subscription to QoS monitoring information, the AF invokes the Nnwf\_AFsessionWithQoS\_Delete service operation by sending the HTTP DELETE request to the "Individual AS Session with Required QoS Subscription" resource. + +2. Upon receipt of the AF request, the NEF authorizes it. +- 3-4. If the PCF address is not available on the NEF based on local configuration, the NEF invokes the Nbsf\_Management\_Discovery service operation, specified in clause 8.5.4, to obtain the selected PCF ID for the ongoing PDU session identified by the individual UE address in the AF request. +- 5-6. The NEF forwards the AF request to the PCF. + +When receiving the Nnwf\_AFsessionWithQoS\_Create request in step 1, the NEF invokes the Npcf\_PolicyAuthorization\_Create service operation by sending the HTTP POST request to the "Application Sessions" resource as described in clause 5.2.2.2.2.1. + +When receiving the Nnwf\_AFsessionWithQoS\_Update request in step 1, the NEF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending the HTTP PATCH request to the "Individual Application Session Context" resource as described in clause 5.2.2.2.2.2. + +When receiving the Nnwf\_AFsessionWithQoS\_Delete request in step 1, the NEF invokes the Npcf\_PolicyAuthorization\_Delete service operation by sending the HTTP POST request to the "Individual Application Session Context" resource as described in clause 5.2.2.2.2.3. + +7. The NEF sends the HTTP response message to the AF correspondingly. +8. Upon receipt of the AF request, the PCF invokes the Npcf\_SMPolicyControl\_UpdateNotify service operation to update the SMF with corresponding PCC rule(s) by sending the HTTP POST request to the callback URI "{notificationUri}/update" as described in clause 5.2.2.2.1. + +If the AF subscribes to QoS monitoring event for packet delay, and if the feature "XRM\_5G" is supported data rate monitoring and/or congestion information, the PCF includes the related QoS monitoring information within the corresponding PCC rule(s). + +If the PCF determines that the QoS monitoring event notification shall be sent to the NEF via the PCF, the PCF provides the "QOS\_MONITORING" policy control request trigger if not previously provided, as specified in 3GPP TS 29.512 [9]. + +If the PCF determines that the QoS monitoring event notification shall be sent to the NEF directly from the SMF, the PCF includes the notification URI pointing to the NEF within the "notifyUri" attribute, the notification and the correlation id assigned by the NEF within the "notifyCorreId" attribute, as specified in 3GPP TS 29.512 [9]. + +When the feature "ExposureToEAS" is supported and if the PCF received from the NEF the indication of direct QoS monitoring event notification, the PCF includes the notification URI pointing to the NEF within the "notifyUri" attribute, the notification correlation id assigned by the NEF within the "notifyCorreId" attribute and the indication of direct QoS monitoring event notification within the "directNotifInd" attribute, if available, as specified in 3GPP TS 29.512 [9]. The PCF may also determine that duplicated notification is required, i.e. both direct notification to the NEF (i.e. sent from UPF) and notification to the PCF is required, as specified in 3GPP TS 23.548 [57]. In this case, the PCF also provides the "QOS\_MONITORING" policy control request trigger if not previously provided, as specified in 3GPP TS 29.512 [9]. + +If the feature "XRM\_5G" is supported and/or the AF subscribes to QoS monitoring event for packet delay variation and/or round-trip time delays over two QoS flows, the PCF includes the related QoS monitoring information for packet delay measurements within the corresponding PCC rule(s), and indicates that QoS monitoring reports are targeted to the PCF by providing the "QOS\_MONITORING" policy control request trigger if not previously provided, as specified in 3GPP TS 29.512 [9]. + +If the PCF received the NEF indication of direct QoS monitoring event notification for the packet delay, and the congestion and/or data rate monitoring and the request also included packet delay variation and/or round trip delay over two QoS flows, and the PCF determines that direct notification is not feasible, the PCF indicates in the response to the AF/NEF that direct notification is not possible. + +If the PCF deduces based on AF request (e.g. AF application identifier) or based on local configuration, that QoS monitoring report may be required by explicit subscription via Nsmf\_EventExposure service as specified in 3GPP TS 29.508 [8], the PCF includes as part of the QoS monitoring data referred from the PCC rule, the Data Collection Application Identifier used to identify the application to be monitored. + +If the AF unsubscribes from QoS monitoring event(s), the PCF removes/updates the related subscription information from the corresponding PCC rule(s) as specified in 3GPP TS 29.512 [9]. + +- 8a. Upon receipt of the AF request, the PCF invokes the Npcf\_SMPolicyControl\_UpdateNotify service operation to update the SMF with corresponding PCC rule(s) by sending the HTTP POST request to the callback URI "{notificationUri}/update" as described in clause 5.2.2.2.1. PCF shall ignore the direct notification indication for "PACK\_DEL\_VAR" events as PCF has to calculate packet delay variation. + +If the AF subscribes to packet delay variation event, the PCF includes the related packet delay information within the corresponding PCC rule(s). + +If the PCF determines that the packet delay variation event notification shall be sent to the NEF via the PCF, the PCF provides the "QOS\_MONITORING" policy control request trigger, as specified in 3GPP TS 29.512 [9]. + +In case of both "QOS\_MONITORING" and "PACK\_DEL\_VAR" events is requested; The PCF shall group the notification as the single request. In this case, the PCF also provides the "QOS\_MONITORING" policy control request trigger if not previously provided, as specified in 3GPP TS 29.512 [9]. + +9. The SMF sends an HTTP 200 OK response message to the PCF. + +- 10a. The NF service consumer of UPF events (e.g. NWDAF) may subscribe to the QoS monitoring notification from the UPF by invoking the Nsmf\_EventExposure\_Subscribe service operation if the "UPEAS" feature is supported. The application identifier and an indication on whether QoS monitoring in the default QoS flow is requested if no PCC rule is active may be provided. + +- 10b. The SMF checks if there is an active PCC rule that includes a Data Collection Application Identifier that matches the received application identifier. If there is an active PCC rule or there is no active PCC rule but the SMF received the indication that the QoS monitoring is requested in the default QoS flow, the SMF may send an HTTP "201 Created" response. Otherwise (no PCC rule is identified and there is no indication that QoS monitoring is requested in the default QoS flow), the SMF rejects the request or accepts it indicating that QoS monitoring is postponed, as described in 3GPP TS 29.508 [8]. + +11. When the SMF receives the PCC rule, the SMF shall send a QoS Monitoring request to the UPF and NG-RAN as defined in 3GPP TS 29.512 [9]. + +When the SMF receives the indication of direct QoS monitoring event notification within the PCC rule, the SMF shall send to the UPF the request to report directly to the NEF the QoS monitoring events. When the NEF receives the QoS monitoring report from the UPF as specified in 3GPP TS 29.564 [56], the NEF invokes the Nnef\_AFsessionWithQoS\_Notify service operation as described in steps 13-14. + +When the SMF receives the subscription to QoS monitoring notification in step 10a and if there is an active PCC rule for the referred application identifier, the SMF shall send to the UPF the request to report directly to the NF service consumer (e.g. NWDAF) the QoS monitoring events as specified in 3GPP TS 29.244 [59] + +When the SMF receives the subscription to QoS monitoring notification in step 10a and when it receives the indication that the QoS monitoring report may be done in the default QoS flow and there is no active PCC rule, the SMF shall send an Indication of QoS Flow associated with the default QoS Rule to the UPF as specified in 3GPP TS 29.244 [59]. In this case the notification is directly sent from the UPF. 12A. In case in step 8 the PCF determines that the notification shall be sent to the PCF: + +- 12a-12b. Upon receipt of the QoS monitoring report from the UPF, the SMF invokes the Npcf\_SMPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual SM Policy" resource. The PCF sends an HTTP POST response to the SMF. + +- 12c-12d. Upon receipt of the QoS monitoring event notification from the SMF, the PCF checks whether the notification needs to be sent to the NEF as described in 3GPP TS 29.512 [9], clause 4.2.3.25, and in that case, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the notification to the NEF by sending the HTTP POST request to the callback URI "{notifUri}/notify". The NEF sends an HTTP POST response to the PCF. Otherwise, these steps do not apply. + +12B. In case in step 8 the PCF determines that the notification shall be sent to the NEF directly from the SMF: + +12a-12b. Upon receipt of the QoS monitoring report from the UPF, the SMF invokes Nsmf\_EventExposure\_Notify service operation to forward the notification to the NEF by sending an HTTP POST request to the callback URI "{notifiUri}" received in step 8. The NEF sends an HTTP POST response to the SMF. + +13-14. Upon receipt of the QoS monitoring information in step 11, the NEF invokes the Nnef\_AFsessionWithQoS\_Notify service operation to forward the QoS monitoring information to the AF. + +NOTE 1: For details of Nnef\_AFsessionWithQoS\_Create/Update/Delete/Notify service operations refer to 3GPP TS 29.122 [34]. + +NOTE 2: For details of the Npcf\_PolicyAuthorization\_Create/Update/Delete/Notify service operations refer to 3GPP TS 29.514 [10]. + +NOTE 3: For details of the Npcf\_SMPolicyControl\_UpdateNotify/Update service operations refer to 3GPP TS 29.512 [9]. + +NOTE 4: For details of the Nbsf\_Management\_Discovery service operation refer to 3GPP TS 29.521 [22]. + +NOTE 5: For details of the Nsmf\_EventExposure\_Subscribe and Nsmf\_EventExposure\_Notify service operations refer to 3GPP TS 29.508 [8]. + +### 5.5.10 AF-triggered dynamically changing AM policies + +#### 5.5.10.1 General + +As described in clause 6.1.2.6 of 3GPP TS 23.503 [4], an AF may send requests to influence Access and Mobility related policies of a UE. The AF may also provide in its request subscriptions to events (e.g. related to service area coverage changes). + +The following cases are included in this clause: + +- AF requests targeting an individual UE without conditions related to the application traffic: these requests are routed (by the AF or by the NEF) to the PCF for the UE as described in clause 5.5.10.2. +- AF requests targeting an individual UE, a group of UEs, any UE accessing a combination of DNN and S-NSSAI, or all UEs using a specific application. For such requests the AF shall contact the NEF and the NEF stores the AF request information in the UDR. The PCF(s) for the UE receive a corresponding notification if they had subscribed to the creation / modification / deletion of the AF request information corresponding to the respective UDR Data Keys / Data Sub-Keys. This case is described in clause 5.5.10.3. + +This clause applies to non-roaming and LBO roaming, i.e. to cases where the PCF, AF, AMF and SMF belong to the Serving PLMN or AF belongs to a third party with which the Serving PLMN has an agreement. + +#### 5.5.10.2 Access and Mobility policy authorization requests targeting an individual UE + +This procedure concerns only non-roaming scenarios, i.e. to cases where the involved entities serving the UE (i.e. NEF, PCF, BSF, AMF) belong to the home PLMN. The AF may belong to the home PLMN (trusted AF) or to a third party (untrusted AF). + +This procedure is used for individual UEs when the request shall be applied independently of conditions related to the application traffic. The AF may interact with NFs of the Core Network either directly or via the NEF. The procedure for the NEF-mediated case is described in Figure 5.5.10.2-1, while the procedure for the direct case is described in Figure 5.5.10.2-2. + +![Sequence diagram showing the processing of NEF-mediated AF requests for Access and Mobility related policy authorization for a UE. The diagram involves five lifelines: AMF, PCF, BSF, NEF, and AF. The process starts with AM Policy Association Establishment (1). The AF sends an Nnef_AMPolicyAuthorization_Create/Update/Delete request (2) to the NEF. The NEF performs parameter mapping (3) and responds (4). The BSF sends a Nbsf_Management_Subscribe/Unsubscribe request (5) to the BSF, which responds (6). The BSF sends a Nbsf_Management_Notify request (7) to the BSF, which responds (8). The NEF sends an Npcf_AMPolicyAuthorization_Create/Update/Delete request (9) to the PCF, which responds (10). A dashed box indicates 'AM Policy Association Modification initiated by the PCF' (11). The PCF sends an Npcf_AMPolicyAuthorization_Notify request (12) to the NEF, which responds (13). The NEF sends an Nnef_AMPolicyAuthorization_Notify request (14) to the AF, which responds (15).](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant BSF + participant NEF + participant AF + + Note over AMF, PCF, BSF: 1. AM Policy Association Establishment + AF->>NEF: 2. Nnef_AMPolicyAuthorization_Create/ +Update/Delete request + Note over NEF: 3. Parameter mapping + NEF-->>AF: 4. Nnef_AMPolicyAuthorization_Create/ +Update/Delete response + BSF-->>BSF: 5. Nbsf_Management_Subscribe/Unsubscribe request + BSF-->>BSF: 6. Nbsf_Management_Subscribe/Unsubscribe response + BSF-->>BSF: 7. Nbsf_Management_Notify request + BSF-->>BSF: 8. Nbsf_Management_Notify response + NEF-->>PCF: 9. Npcf_AMPolicyAuthorization_Create/ +Update/Delete request + PCF-->>NEF: 10. Npcf_AMPolicyAuthorization_Create/ +Update/Delete response + Note over AMF, PCF: 11. AM Policy Association +Modification initiated +by the PCF + PCF-->>NEF: 12. Npcf_AMPolicyAuthorization_Notify +request + NEF-->>PCF: 13. Npcf_AMPolicyAuthorization_Notify +response + NEF-->>AF: 14. Nnef_AMPolicyAuthorization_Notify +request + AF-->>NEF: 15. Nnef_AMPolicyAuthorization_Notify +response + +``` + +Sequence diagram showing the processing of NEF-mediated AF requests for Access and Mobility related policy authorization for a UE. The diagram involves five lifelines: AMF, PCF, BSF, NEF, and AF. The process starts with AM Policy Association Establishment (1). The AF sends an Nnef\_AMPolicyAuthorization\_Create/Update/Delete request (2) to the NEF. The NEF performs parameter mapping (3) and responds (4). The BSF sends a Nbsf\_Management\_Subscribe/Unsubscribe request (5) to the BSF, which responds (6). The BSF sends a Nbsf\_Management\_Notify request (7) to the BSF, which responds (8). The NEF sends an Npcf\_AMPolicyAuthorization\_Create/Update/Delete request (9) to the PCF, which responds (10). A dashed box indicates 'AM Policy Association Modification initiated by the PCF' (11). The PCF sends an Npcf\_AMPolicyAuthorization\_Notify request (12) to the NEF, which responds (13). The NEF sends an Nnef\_AMPolicyAuthorization\_Notify request (14) to the AF, which responds (15). + +**Figure 5.5.10.2-1: Processing NEF-mediated AF requests for Access and Mobility related policy authorization for a UE** + +1. An AM Policy Association is established as described in clause 5.1.1. This step can occur at any time before step 7. +2. To create a new AF request, the AF invokes the Nnef\_AMPolicyAuthorization\_Create service operation to the NEF by sending an HTTP POST request to the "Application AM Contexts" resource as described in clause 4.4.26.2 of 3GPP TS 29.522 [24]. + +To update an existing AF request, the AF invokes the Nnef\_AMPolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application AM Context" resource as described in clause 4.4.26.3 of 3GPP TS 29.522 [24]. + +To remove an existing AF request, the AF invokes the Nnef\_AMPolicyAuthorization\_Delete service operation by sending an HTTP DELETE request to the "Individual Application AM Context" resource as described in clause 4.4.26.4 of 3GPP TS 29.522 [24]. + +3. Upon receipt of the AF request, the NEF authorizes it, stores it, and performs the mapping from the information provided by the AF into information needed by the 5GC (e.g. translate a GPSI into a SUPI) as described in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. +4. The NEF responds to the AF request creation, update, or deletion as described respectively in clauses 4.4.26.2, 4.4.26.3, or 4.4.26.4 of 3GPP TS 29.522 [24]. + +If the creation or update request included the subscription to event(s) together with the indication of immediate reporting of the currently available values of the subscribed events, the NEF includes in the response the applicable event(s) information, if available, as specified in clauses 4.4.26.2, or 4.4.26.4 of 3GPP TS 29.522 [24]. In this case, the response is deferred after step 10. + +5. The NEF may subscribe to (or unsubscribe from) the BSF using Nbsf\_Management\_Subscribe (or Nbsf\_Management\_Unsubscribe) to be informed about the PCF for a UE of the UE targeted in the AF request received in step 2, as described in clause 4.2.6 (for subscribing) or clause 4.2.7 (for unsubscribing) of 3GPP TS 29.521 [22]. +6. The BSF responds by confirming the received request and, in the case of subscription, including the existing PCF for a UE registration in the response, if found, as described in clause 4.2.6.2 of 3GPP TS 29.521 [22]. +7. The BSF notifies the NEF once there is a PCF for a UE registration for the UE indicated in the subscription as described in clause 4.2.8 of 3GPP TS 29.521 [22]. +8. The NEF confirms the received notification by sending a "204 No Content" response as described in clause 4.2.8 of 3GPP TS 29.521 [22]. +9. The NEF forwards the AF request to the PCF. + +If the NEF received the Nnef\_AMPolicyAuthorization\_Create request in step 2, the NEF invokes the Npcf\_AMPolicyAuthorization\_Create service operation by sending an HTTP POST request to the "Application AM Contexts" resource as described in clause 4.2.2 of 3GPP TS 29.534 [50]. + +If the NEF received the Nnef\_AMPolicyAuthorization\_Update request in step 2, the NEF invokes the Npcf\_AMPolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application AM Context" resource as described in clause 4.2.3 of 3GPP TS 29.534 [50]. + +If the NEF received the Nnef\_AMPolicyAuthorization\_Delete request in step 2, the NEF invokes the Npcf\_AMPolicyAuthorization\_Delete service operation by sending an HTTP DELETE request to the "Individual Application AM Context" resource as described in clause 4.2.4 of 3GPP TS 29.534 [50]. + +10. The PCF responds to the creation, update, or deletion request as described respectively in clauses 4.2.2, 4.2.3, or 4.2.4 of 3GPP TS 29.534 [50]. + +If the creation or update request included the subscription to event(s) together with the indication of immediate reporting of the currently available values of the subscribed events, the PCF includes in the response the applicable event(s) information, if available, as specified respectively in clauses 4.2.2 or 4.2.3 of 3GPP TS 29.534 [50]. + +11. AM Policy Association modification initiated by the PCF may be performed as described in clause 5.1.2.2. + +- 12-13. If an event (e.g. service coverage area change) occurs to which the NEF has previously subscribed, the PCF notifies the NEF using the Npcf\_AMPolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI included in the subscription, and the NEF responds by sending a confirmation, as described in clause 4.2.7 of 3GPP TS 29.534 [50]. + +- 14-15. When the NEF receives from the PCF an event (e.g. service coverage area change) to which the AF has previously subscribed, the NEF notifies the AF using the Nnef\_AMPolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI included in the subscription, and the AF responds by sending a confirmation, as described in clause 4.4.26.7 of 3GPP TS 29.522 [24]. + +NOTE: The subscriptions required for steps 12-15 can have happened either in the Create/Update steps or with a separate Subscribe message which is not shown in the call flow. + +![Sequence diagram showing the processing of direct AF requests for Access and Mobility related policy authorization for a UE. The diagram involves four main entities: AMF, PCF, BSF, and AF. The sequence starts with '1. AM Policy Association Establishment' between AMF and PCF. Then, the AF sends a '2. Nbsf_Management_Subscribe/Unsubscribe request' to the BSF, which responds with '3. Nbsf_Management_Subscribe/Unsubscribe response'. The BSF then sends a '4. Nbsf_Management_Notify request' to the AF, which responds with '5. Nbsf_Management_Notify response'. Next, the AF sends a '6. Npcf_AMPolicyAuthorization_Create/Update/Delete request' to the PCF, which responds with '7. Npcf_AMPolicyAuthorization_Create/Update/Delete response'. A dashed box labeled '8. AM Policy Association Modification initiated by the PCF' is shown. Finally, the PCF sends a '9. Npcf_AMPolicyAuthorization_Notify request' to the AF, which responds with '10. Npcf_AMPolicyAuthorization_Notify response'.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant BSF + participant AF + + Note over AMF, PCF: 1. AM Policy Association Establishment + AF->>BSF: 2. Nbsf_Management_Subscribe/Unsubscribe request + BSF-->>AF: 3. Nbsf_Management_Subscribe/Unsubscribe response + BSF->>AF: 4. Nbsf_Management_Notify request + AF-->>BSF: 5. Nbsf_Management_Notify response + AF->>PCF: 6. Npcf_AMPolicyAuthorization_Create/Update/Delete request + PCF-->>AF: 7. Npcf_AMPolicyAuthorization_Create/Update/Delete response + Note right of AMF: 8. AM Policy Association Modification initiated by the PCF + PCF->>AF: 9. Npcf_AMPolicyAuthorization_Notify request + AF-->>PCF: 10. Npcf_AMPolicyAuthorization_Notify response + +``` + +Sequence diagram showing the processing of direct AF requests for Access and Mobility related policy authorization for a UE. The diagram involves four main entities: AMF, PCF, BSF, and AF. The sequence starts with '1. AM Policy Association Establishment' between AMF and PCF. Then, the AF sends a '2. Nbsf\_Management\_Subscribe/Unsubscribe request' to the BSF, which responds with '3. Nbsf\_Management\_Subscribe/Unsubscribe response'. The BSF then sends a '4. Nbsf\_Management\_Notify request' to the AF, which responds with '5. Nbsf\_Management\_Notify response'. Next, the AF sends a '6. Npcf\_AMPolicyAuthorization\_Create/Update/Delete request' to the PCF, which responds with '7. Npcf\_AMPolicyAuthorization\_Create/Update/Delete response'. A dashed box labeled '8. AM Policy Association Modification initiated by the PCF' is shown. Finally, the PCF sends a '9. Npcf\_AMPolicyAuthorization\_Notify request' to the AF, which responds with '10. Npcf\_AMPolicyAuthorization\_Notify response'. + +**Figure 5.5.10.2-2: Processing direct AF requests for Access and Mobility related policy authorization for a UE** + +1. An AM Policy Association is established as described in clause 5.1.1. This step can occur at any time before step 4. +2. The AF may subscribe to (or unsubscribe from) the BSF using Nbsf\_Management\_Subscribe (or Nbsf\_Management\_Unsubscribe) to be informed about PCF for a UE registrations for the target UE, as described in clause 4.2.6 (for subscribing) or clause 4.2.7 (for unsubscribing) of 3GPP TS 29.521 [22]. +3. The BSF responds by confirming the received request and, in the case of subscription, including the existing PCF for a UE registration in the response, if found, as described in clause 4.2.6.2 of 3GPP TS 29.521 [22]. +4. The BSF notifies the AF once there is a PCF for a UE registration for the UE indicated in the subscription as described in clause 4.2.8 of 3GPP TS 29.521 [22]. +5. The AF confirms the received notification by sending a "204 No Content" response as described in clause 4.2.8 of 3GPP TS 29.521 [22]. +6. To create a new AF request, the AF invokes the Npcf\_AMPolicyAuthorization\_Create service operation by sending an HTTP POST request to the "Application AM Contexts" resource as described in clause 4.2.2 of 3GPP TS 29.534 [50]. + +To update an existing AF request, the AF invokes the Npcf\_AMPolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application AM Context" resource as described in clause 4.2.3 of 3GPP TS 29.534 [50]. + +To remove an existing AF request, the AF invokes the Npcf\_AMPolicyAuthorization\_Delete service operation by sending an HTTP DELETE request to the "Individual Application AM Context" resource as described in clause 4.2.4 of 3GPP TS 29.534 [50]. + +7. The PCF responds to the creation, update, or deletion request as described respectively in clauses 4.2.2, 4.2.3, or 4.2.4 of 3GPP TS 29.534 [50]. + +If the creation or update request included the subscription to event(s) together with the indication of immediate reporting of the currently available values of the subscribed events, the PCF includes in the response the + +applicable event(s) information, if available, as specified respectively in clauses 4.2.2 or 4.2.3 of 3GPP TS 29.534 [50]. + +8. AM Policy Association modification initiated by the PCF may be performed as described in clause 5.1.2.2. +- 9-10. When an event (e.g. service coverage area change) occurs to which the AF has previously subscribed, the PCF notifies the AF using the Npcf\_AMPolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI included in the subscription, and the AF responds by sending a confirmation, as described in clause 4.2.7 of 3GPP TS 29.534 [50]. + +NOTE: The subscriptions required for steps 9-10 can have happened either in the Create/Update steps or with a separate Subscribe message which is not shown in the call flow. + +#### 5.5.10.3 AF requests to influence AM policies + +This procedure concerns non-roaming and LBO roaming scenarios, i.e. to cases where the involved entities serving the UE (i.e. NEF, UDR, PCF, BSF, AMF) belong to the Serving PLMN. The AF may belong to the Serving PLMN (trusted AF) or to a third party with which the Serving PLMN has an agreement (untrusted AF). In LBO roaming, the AF requests target "any inbound roaming UEs identified by their home PLMN ID(s)" combined with DNN/S-NSSAI or Application Identifier(s). + +This procedure is used by the AF to provide its AM policy related request for one or multiple UEs at any time. + +![Sequence diagram showing the processing of AF requests to influence Access and Mobility related policy. The diagram involves six lifelines: AMF, PCF for the UE, PCF for the PDU Session, UDR, NEF, and AF. The process starts with '1. AM Policy Association Establishment'. The AF sends a '2. Nnef_AMInfluence_Create/Update/Delete request' to the NEF. The NEF performs '3. Parameter mapping' and sends a '4. Nudr_DataRepository_Create/Update/Delete request' to the UDR. The UDR returns a '5. Nudr_DataRepository_Create/Update/Delete response' to the NEF. The NEF then sends a '6. Nnef_AMInfluence_Create/Update/Delete response' to the AF. The UDR also sends a '7. Nudr_DataRepository_Notify request' to the PCF for the UE, which returns a '8. Nudr_DataRepository_Notify response'. The PCF for the UE then performs '9. PCF for a PDU Session discovery by the PCF for a UE'. It sends a '10. Npcf_PolicyAuthorization_Subscribe request' to the PCF for the PDU Session, which returns a '11. Npcf_PolicyAuthorization_Subscribe response'. The PCF for the PDU Session performs '12. Application traffic detection' and sends a '13. Npcf_PolicyAuthorization_Notify request' to the PCF for the UE, which returns a '14. Npcf_PolicyAuthorization_Notify response'. The PCF for the UE then initiates '15. AM Policy Association Modification initiated by the PCF'. It sends a '16. Npcf_EventExposure_Notify request' to the NEF. The NEF sends a '17. Nnef_AMInfluence_Notify request' to the AF, which returns a '18. Nnef_AMInfluence_Notify response'. Finally, the NEF sends a '19. Npcf_EventExposure_Notify response' to the PCF for the UE.](8307f6b04df072c9332f9987e034272c_img.jpg) + +Sequence diagram showing the processing of AF requests to influence Access and Mobility related policy. The diagram involves six lifelines: AMF, PCF for the UE, PCF for the PDU Session, UDR, NEF, and AF. The process starts with '1. AM Policy Association Establishment'. The AF sends a '2. Nnef\_AMInfluence\_Create/Update/Delete request' to the NEF. The NEF performs '3. Parameter mapping' and sends a '4. Nudr\_DataRepository\_Create/Update/Delete request' to the UDR. The UDR returns a '5. Nudr\_DataRepository\_Create/Update/Delete response' to the NEF. The NEF then sends a '6. Nnef\_AMInfluence\_Create/Update/Delete response' to the AF. The UDR also sends a '7. Nudr\_DataRepository\_Notify request' to the PCF for the UE, which returns a '8. Nudr\_DataRepository\_Notify response'. The PCF for the UE then performs '9. PCF for a PDU Session discovery by the PCF for a UE'. It sends a '10. Npcf\_PolicyAuthorization\_Subscribe request' to the PCF for the PDU Session, which returns a '11. Npcf\_PolicyAuthorization\_Subscribe response'. The PCF for the PDU Session performs '12. Application traffic detection' and sends a '13. Npcf\_PolicyAuthorization\_Notify request' to the PCF for the UE, which returns a '14. Npcf\_PolicyAuthorization\_Notify response'. The PCF for the UE then initiates '15. AM Policy Association Modification initiated by the PCF'. It sends a '16. Npcf\_EventExposure\_Notify request' to the NEF. The NEF sends a '17. Nnef\_AMInfluence\_Notify request' to the AF, which returns a '18. Nnef\_AMInfluence\_Notify response'. Finally, the NEF sends a '19. Npcf\_EventExposure\_Notify response' to the PCF for the UE. + +**Figure 5.5.10.3-1: Processing AF requests to influence Access and Mobility related policy** + +1. An AM Policy Association is established as described in clause 5.1.1 (including the retrieval of and subscription to AM Influence data in steps 2 and 4). This step may occur at any time before step 7. +2. To create a new AF request, the AF invokes the Nnef\_AMInfluence\_Create service operation to the NEF by sending an HTTP POST request to the "AM Influence Subscription" resource. The AF may subscribe to Access and Mobility management related events (e.g. about service area coverage change outcome) as part of this operation. + +To update an existing AF request, the AF invokes the Nnef\_AMInfluence\_Update service operation by sending an HTTP PUT or PATCH request to the "Individual AM Influence Subscription" resource. The AF may subscribe to or unsubscribe from Access and Mobility management related events (e.g. about service area coverage change outcome) as part of this operation. + +To remove an existing AF request, the AF invokes the Nnef\_AMInfluence\_Delete service operation by sending an HTTP DELETE request to the "Individual AM Influence Subscription" resource. The AF may unsubscribe from Access and Mobility management related events (e.g. about service area coverage change outcome) as part of this operation. + +3. Upon receipt of the AF request, the NEF authorizes it and then performs the mapping from the information provided by the AF into information needed by the 5GC (e.g. translate a GPSI into a SUPI) as described in clause 4.4.27 of 3GPP TS 29.522 [24]. +- 4-5. When receiving the Nnef\_AMInfluence\_Create request, the NEF invokes the Nudr\_DataRepository\_Create service operation to store the AF request information in the UDR by sending an HTTP PUT request to the "Individual AM Influence Data" resource, and the UDR sends a "201 Created" response. + +When receiving the Nnef\_AMInfluence\_Update request, the NEF invokes the Nudr\_DataRepository\_Update service operation to modify the AF request information in the UDR by sending an HTTP PATCH or PUT request to the resource "Individual AM Influence Data", and the UDR sends a "200 OK" or "204 No Content" response accordingly. + +When receiving the Nnef\_AMInfluence\_Delete request, the NEF invokes the Nudr\_DataRepository\_Delete service operation to delete the AF request information from the UDR by sending an HTTP DELETE request to the "Individual AM Influence Data" resource, and the UDR sends a "204 No Content" response. + +6. The NEF sends an HTTP response message to the AF correspondingly. +- 7-8. The UDR notifies the PCF(s) that have subscriptions (from step 1) which match the received AF request using the Nudr\_DataRepository\_Notify service operation by sending an HTTP POST request to the callback URI of the PCF that was included in the subscription, and the PCF(s) send a "204 No Content" response. +9. If the received AM Influence data indicated that the AM policy depends on PDU session traffic events (e.g. the application start and application stop for an application Id or PDU session establishment and termination for a DNN and S-NSSAI combination), the PCF for the UE may discover the PCF(s) for a PDU Session that handle(s) the respective UE traffic as described in clause 8.4a. +- 10-11. If the received AM Influence data indicated that the request is dependent (or does not depend anymore) on the existence of UE traffic that matches one or more application identifiers and the feature "ApplicationDetectionEvents" defined in 3GPP TS 29.514 [10] is supported, the PCF for the UE may subscribe (or unsubscribe) to the PCF(s) for the PDU Session for notifications about application traffic detection (e.g. start, stop) of the application(s) indicated in the AM Influence data using the Npcf\_PolicyAuthorization\_Subscribe service operation as described in 3GPP TS 29.514 [10] clause 4.2.6.9. +12. The PCF for the PDU Session creates PCC rule(s) including the application ID(s) in the service data flow description, if they do not already exist, and installs the PCC rule(s) and the Policy Control request trigger(s), also if they do not already exist, to detect the start/stop of application traffic in the SMF as described in 3GPP TS 29.512 [9]. When the SMF detects that the Policy Control Request Trigger is met, the SMF reports to the PCF for the PDU session the start or stop of concerned the application traffic. +- 13-14. The PCF for the PDU Session may notify the PCF for the UE about the detected event using the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the notification URI received in the subscription, and the PCF for the UE responds with "204 No Content", as described in 3GPP TS 29.514 [10] clause 4.2.5.19. +15. AM Policy Association modification initiated by the PCF may be performed as described in clause 5.1.2.2. +- 16-19. If the AF had subscribed to an Access and Mobility management related event (e.g. about service area coverage change outcome), the PCF may send respective notification(s) to the NEF using the Npcf\_EventExposure\_Notify service operation by sending an HTTP POST message as described in clause 4.2.4.2 of 3GPP TS 29.523 [49] to the notification URI that was included in the AM Influence data retrieved from the UDR. The NEF forwards such received notifications to the AF using the Nnef\_AMInfluence\_Notify service operation by sending an HTTP POST message to the notification URI previously received from the AF. The AF sends a "204 No Content" response to the NEF and the NEF sends a "204 No Content" response to the PCF. + +### 5.5.11 Procedures for Time Synchronization Exposure + +#### 5.5.11.1 General + +Time synchronization exposure allows an AF to configure time synchronization in 5GS. + +For (g)PTP operations, the Time synchronization service allows an AF to subscribe to the UE and 5GC capabilities and availability for time synchronization services as described in clause 5.5.11.2, to configure the (g)PTP instance in 5GS as described in clause 5.5.11.3, and monitor the service status as described in clause 5.5.11.5. + +For the 5G access stratum time distribution, the AF can influence the 5G access stratum time distribution as described in clause 5.5.11.4 and monitor the service status as described in clause 5.5.11.5. + +The time synchronization exposure is provided by NEF, which uses the services provided by TSCTSF. The AF that is part of the operator's trust domain may invoke the services directly with TSCTSF; in such case, the TSCTSF directly responds/notifies the AF, accordingly. + +#### 5.5.11.2 Exposure of UE availability and capabilities for Time Synchronization service + +The procedure is used by the AF to subscribe to notifications and to explicitly cancel a previous subscription for UE availability for time synchronization service. + +![Sequence diagram showing the exposure of UE availability and capabilities for Time Synchronization service. The diagram involves five main entities: SMF, PCF, TSCTSF, NEF, and AF. The sequence starts with a policy authorization notify from SMF to PCF. The AF sends a subscription request to NEF, which is forwarded to TSCTSF. TSCTSF validates the request and updates the PCF. The PCF then initiates SM Policy Association modifications with the SMF. Finally, the TSCTSF reads capabilities and sends notifications back through the NEF to the AF.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant TSCTSF + participant NEF + participant AF + + Note right of SMF: 0. Policy Authorization Notify and reporting time synchronization capabilities from DS-TT and NW-TT. Policy Authorization create + AF->>NEF: 1. Nnef_TimeSynchronization_CapsSubscribe/Unsubscribe request + NEF->>TSCTSF: 2. Ntsctsf_TimeSynchronization_CapsSubscribe/Unsubscribe request + Note right of TSCTSF: 3. Validation of whether AF request for UE Time Synchronization capabilities is allowed by subscription + TSCTSF->>PCF: 4. Npcf_PolicyAuthorization_Update request + PCF->>TSCTSF: 5. Npcf_PolicyAuthorization_Update response + Note right of SMF: 8. SM Policy Association modification initiated by the AF, clause 5.2.2.2.2. + Note right of SMF: 9. SM Policy Association modification initiated by the SMF, clause 5.2.2.3. + TSCTSF->>NEF: 6. Ntsctsf_TimeSynchronization_CapsSubscribe/Unsubscribe response + NEF->>AF: 7. Nnef_TimeSynchronization_CapsSubscribe/Unsubscribe response + SMF->>PCF: 10. Npcf_PolicyAuthorization_Notify request + PCF->>SMF: 11. Npcf_PolicyAuthorization_Notify response + Note right of TSCTSF: 12. TSCTSF reads time synchronization capabilities received from DS-TT and NW-TT + TSCTSF->>NEF: 13. Ntsctsf_TimeSynchronization_CapsNotify request + NEF->>TSCTSF: 14. Ntsctsf_TimeSynchronization_CapsNotify response + NEF->>AF: 15. Nnef_TimeSynchronization_CapsNotify request + AF->>NEF: 16. Nnef_TimeSynchronization_CapsNotify response + +``` + +Sequence diagram showing the exposure of UE availability and capabilities for Time Synchronization service. The diagram involves five main entities: SMF, PCF, TSCTSF, NEF, and AF. The sequence starts with a policy authorization notify from SMF to PCF. The AF sends a subscription request to NEF, which is forwarded to TSCTSF. TSCTSF validates the request and updates the PCF. The PCF then initiates SM Policy Association modifications with the SMF. Finally, the TSCTSF reads capabilities and sends notifications back through the NEF to the AF. + +**Figure 5.5.11.2-1: Exposure of UE availability and capabilities for Time Synchronization service** + +0. During SM Policy Association establishment, the PCF determines if the PDU Session is potentially impacted by time synchronization service (based on local configuration) and provides the "TSN\_BRIDGE\_INFO" policy + +control request trigger to the SMF as described in figure 5.2.1-1, step 11. During SM Policy Association modification (triggered during PDU session establishment), the SMF may report it to the PCF to provide TSC user plane node information (device side port number, DS-TT MAC address (to identify the PDU session), if applicable, TSC user plane node Id and UE-DS-TT residence time, if available), and, if available, a UMIC and/or one or more PMIC(s), as described in figure 5.2.2.3-1, step 2. For IP PDU sessions, the PCF uses the UE IP address to identify the PDU session. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to notify to the TSCTSF the received TSC user plane node information for the PDU session, and, if available, the received UMIC/PMIC(s), as described in figure 5.2.2.3-1, step 5. + +The TSCTSF retrieves the UE SUPI from the BSF using the UE IP address, and may get from UDM Time Synchronization Subscription Data, that may contain either one or more subscribed time synchronization service Id(s) (that map to a PTP instance configuration in the TSCTSF for the DNN/S-NSSAI) or an indication that an AF-requested (g)PTP time synchronization service is allowed for the given UE and DNN/S-NSSAI. + +If an AF-requested (g)PTP time synchronization service is allowed for the UE and DNN/S-NSSAI, the TSCTSF then invokes the Npcf\_PolicyAuthorization\_Create request message to the PCF as described in clause 5.2.2.2.2.1 to create an AF-session. The TSCTSF may subscribe with the PCF to the "TSN\_BRIDGE\_INFO" event, to get notifications about PMIC/UMIC updates as specified in 3GPP TS 29.514 [10]. For IP PDU sessions, the TSCTSF stores the DNN, S-NSSAI and IP address as received from PCF and SUPI as received from BSF and associates them with the AF-session, as described in 3GPP TS 29.565 [60]. + +The received PMIC(s)/UMIC, if available, may contain (g)PTP instance configuration for the reported DS-TT/NW-TT. + +If the TSCTSF retrieves from UDM one or more time synchronization service Id(s) matching PTP instance configuration for the DNN/S-NSSAI, the TSCTSF distributes the PTP instance configuration as described in clause 5.5.11.3. + +1. To subscribe to notifications of the UE availability for time synchronization service, the AF invokes the Nnef\_TimeSynchronization\_CapsSubscribe service operation to the NEF by sending the HTTP POST request to the "Time Synchronization Exposure Subscriptions" resource as defined in 3GPP TS 29.522 [24]. + +To unsubscribe to the UE availability for time synchronization for a list of UE(s), the AF invokes Nnef\_TimeSynchronization\_CapsUnsubscribe service operation to the NEF by sending the HTTP DELETE request to the "Individual Time Synchronization Exposure Subscription" resource as defined in 3GPP TS 29.522 [24]. + +2. The NEF selects the TSCTSF and maps the received parameters to 5GC parameters, if applicable, as described in 3GPP TS 29.522 [24] and invokes the Ntsctsf\_TimeSynchronization\_CapsSubscribe service operation by sending the HTTP POST request to the "Time Synchronization Exposure" resource as described in 3GPP TS 29.565 [60]. + +In the case of Ntsctsf\_TimeSynchronization\_CapsUnsubscribe, the NEF interacts with the TSCTSF by sending an HTTP DELETE request to the "Individual Time Synchronization Exposure Subscription" resource as described in 3GPP TS 29.565 [60]. + +The AF that is part of operator's trust domain may invoke the requests directly to the TSCTSF. + +3. If the request includes GPSI(s), an External Group Identifier or an Internal Group Identifier, the TSCTSF uses the Nudm\_SDM\_Get request as described in 3GPP TS 29.503 [61] to retrieve the subscription information for the target UEs (i.e., to retrieve the SUPI(s)) from the UDM, using each GPSI or the External Group Identifier as received from the NEF, or an Internal Group Identifier as provided directly by the AF). + +For the retrieved SUPI(s), the TSCTSF requests the Time Synchronization Subscription Data from the UDM if not previously retrieved in step 0, to validate whether the AF request for (g)PTP-based time distribution for the DNN and S-NSSAI is allowed by the UE subscription. + +4. The TSCTSF uses the parameters received in step 2 and step 3 (i.e. DNN, S-NSSAI and SUPI(s)) to find matching AF-session(s) as described in 3GPP TS 29.565 [60]. + +If the subscription data for the UE indicates that the AF is not allowed to request (g)PTP-based time synchronization for this UE, DNN and S-NSSAI combination, the corresponding AF-session is excluded from the list of matching AF-sessions. + +For any AF-session in the list of matching AF-session(s), the TSCTSF interacts with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request message as specified in 3GPP TS 29.514 [10], to provide/retrieve UMIC/PMIC information, if not available in the TSCTSF, from the NW-TT/DS-TT to read the (g)PTP capabilities as specified in 3GPP TS 23.501 [2], K.2.2.1 + +In the case of Ntsctsf\_TimeSynchronization\_CapsUnsubscribe, the TSCTSF, for the AF-session(s) in the list of matching AF-session(s), triggers a Npcf\_PolicyAuthorization\_Delete request message as specified in 3GPP TS 29.514 [10], deletes the corresponding "Individual Time Synchronization Exposure Subscription" resource and responds to the NEF (or AF) with a "204 No Content" status code. Steps 4-5 and 8-16 are skipped. + +5. The PCF responds with a "200 OK" or "204 No Content" status code to the received PATCH request. +6. TSCTSF acknowledges the execution of Ntsctsf\_TimeSynchronization\_CapsSubscribe to the requester that initiated the request (NEF or AF) by sending a "201 Created" status code. + +When the request was to unsubscribe to the UE availability for time synchronization, the TSCTSF deletes the corresponding "Individual Time Synchronization Exposure Subscription" resource and responds to the NEF with a "204 No Content" status code. + +7. NEF acknowledges the execution of Nnef\_TimeSynchronization\_CapsSubscribe to the AF by sending a "201 Created" status code. + +When the request was to unsubscribe to the UE availability for time synchronization, the NEF deletes the corresponding "Individual Time Synchronization Exposure Subscription" resource and responds to the AF with a "204 No Content" status code. + +- 8 For each AF-session for which the TSCTSF triggered the Npcf\_PolicyAuthorization\_Update request as described in step 4, the PCF provides to the SMF the UMIC/PMIC information received from the TSCTSF and for the concerned PDU session as described in clause 5.2.2.2.2. +- 9 When the SMF detects UMIC/PMIC changes for the NW-TT/DS-TT for each concerned PDU sessions, the SMF provides the updated UMIC/PMIC information to the PCF as described in clause 5.2.2.3. +10. The TSCTSF receives UMIC/PMIC information from NW-TT/DS-TT ports from the PCF, with the notification of BRIDGE\_INFO events as specified in 3GPP TS 29.514 [10]. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI as specified in clause 5.2.2.3. +11. The TSCTSF responds to the PCF with a "204 No Content" status code. +12. The TSCTSF uses the procedures described in clause K.2.1 of TS 23.501 [2] to determine the (g)PTP capabilities from the DS-TT and, if not previously determined, the (g)PTP capabilities from the NW-TT. + +The TSCTSF composes the time synchronization capabilities for the DS-TT/UE(s) connected to the NW-TT based on the capability information received from the DS-TT(s) and NW-TT for each AF-session. If the Ntsctsf\_TimeSynchronization\_CapsSubscribe request included an Event Filter with one or more of the requested PTP instance type, requested transport protocol for PTP, or requested PTP Profile, the TSCTSF considers only the DS-TT(s) and NW-TT(s) with these capabilities as part of the time synchronization capability set that is reported to the NEF (or AF). + +The TSCTSF maintains, for the "Individual Time Synchronization Exposure Subscription" resource, the association between the user-plane Node ID, the time synchronization capabilities, the Event Filter(s) (if available), the NEF or AF Notification Target Address and list of the matching AF-sessions with PCFs with this user-plane Node ID. + +13. The TSCTSF sends Ntsctsf\_TimeSynchronization\_CapsNotify to the NEF by invoking the HTTP POST request, as described in 3GPP TS 29.565 [60]. The message includes the time synchronization capabilities as composed for all the matching AF-sessions in step 12. The message contains one or more user-plane Node ID(s), a list of UE identities associated to each user-plane Node ID and time synchronization capabilities for each set of DS-TTs (UEs) connected to given user-plane Node ID. The user-plane Node ID identifies the NW-TT to where the UE/DS-TT(s) are connected to. +14. The NEF responds to the PCF with a "204 No Content" status code. + +15. The NEF forwards the Nnef\_TimeSynchronization\_CapsNotify with Time Synchronization capability event to the AF by invoking the HTTP POST request as described in 3GPP TS 29.522 [24]. +16. The AF responds the NEF with a "204 No Content" status code. + +At PDU Session Establishment as defined in step 0, steps 3-5 and steps 8-16 are repeated for the new PDU Session/AF-session and the TSCTSF may notify the NEF (or AF) for the Time Synchronization capability event, optionally with the updated time synchronization capabilities. + +Upon PDU Session release indication from a PCF, the TSCTSF removes the corresponding AF-session from the list of AF-sessions associated with the time synchronization exposure subscription resource, once the corresponding AF-session is removed from the list of AF-sessions associated with the time synchronization configuration, as described in clause 5.5.11.3. The changes in the set of capabilities are notified to the NEF and AF as described in steps 13 to 16. + +#### 5.5.11.3 Time Synchronization service activation, modification, and deactivation + +The AF may use Nnef\_TimeSynchronization\_CapsSubscribe service operation as described in clause 5.5.11.2 to learn the UE capabilities for time synchronization service for a list of UE identities. The Nnef\_TimeSynchronization\_CapsNotify service operation indicates the list of UE identities per User-plane Node ID that match the provided time synchronization capabilities. + +The AF can use the user-plane node ID received in the Nnef\_TimeSynchronization\_CapsNotify service operation as a target of the configuration of a PTP instance in the Nnef\_TimeSynchronization\_ConfigCreate request. + +![Sequence diagram showing interactions between SMF, PCF, TSCTSF, NEF, and AF for time synchronization configuration. The diagram includes 24 numbered steps and several process blocks (5-7, 14-15, 20) detailing internal logic and notifications.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` +sequenceDiagram + participant AF + participant NEF + participant TSCTSF + participant PCF + participant SMF + + Note right of AF: 1. Nnef_TimeSynchronization_ConfigCreate/Update/Delete request + AF->>NEF: 1. Nnef_TimeSynchronization_ConfigCreate/Update/Delete request + Note right of NEF: 2. Ntsctsf_TimeSynchronization_ConfigCreate/Update/Delete request + NEF->>TSCTSF: 2. Ntsctsf_TimeSynchronization_ConfigCreate/Update/Delete request + Note right of TSCTSF: 3. Ntsctsf_TimeSynchronization_ConfigCreate/Update/Delete response + TSCTSF->>NEF: 3. Ntsctsf_TimeSynchronization_ConfigCreate/Update/Delete response + Note right of NEF: 4. Nnef_TimeSynchronization_ConfigCreate/Update/Delete response + NEF->>AF: 4. Nnef_TimeSynchronization_ConfigCreate/Update/Delete response + + Note right of AF: 5. Validation of whether AF request for Time Synchronization configuration is allowed by subscription. + Note right of AF: 6. Coverage area resolution. + Note right of AF: 7. For each authorized UE and matched AF-session, the TSCTSF builds PMIC(s)/UMIC for NW-TT and PMIC for DS-TT. + + Note right of TSCTSF: 8. Npcf_PolicyAuthorization_Update request + TSCTSF->>PCF: 8. Npcf_PolicyAuthorization_Update request + Note right of PCF: 9. Npcf_PolicyAuthorization_Update response + PCF->>TSCTSF: 9. Npcf_PolicyAuthorization_Update response + + Note right of SMF: 10. SM Policy Association modification initiated by the AF, clause 5.2.2.2.2 + Note right of SMF: 11. SM Policy Association modification initiated by the SMF, clause 5.2.2.3. + + Note right of TSCTSF: 12. Npcf_PolicyAuthorization_Notify request + TSCTSF->>PCF: 12. Npcf_PolicyAuthorization_Notify request + Note right of PCF: 13. Npcf_PolicyAuthorization_Notify response + PCF->>TSCTSF: 13. Npcf_PolicyAuthorization_Notify response + + Note right of TSCTSF: 14. The TSCTSF receives within the PMIC(s)/UMIC, PTP instance information for the DS-TT/NW-TT + Note right of TSCTSF: 15. For each authorized UE, the TSCTSF invokes management of 5G Access Stratum time distribution as specified in 5.5.11.4, steps 5-9. + + Note right of TSCTSF: 16. Ntsctsf_TimeSynchronization_ConfigUpdateNotify request + TSCTSF->>NEF: 16. Ntsctsf_TimeSynchronization_ConfigUpdateNotify request + Note right of NEF: 17. Ntsctsf_TimeSynchronization_ConfigUpdateNotify response + NEF->>TSCTSF: 17. Ntsctsf_TimeSynchronization_ConfigUpdateNotify response + + Note right of NEF: 18. Nnef_TimeSynchronization_ConfigUpdateNotify request + NEF->>AF: 18. Nnef_TimeSynchronization_ConfigUpdateNotify request + Note right of AF: 19. Nnef_TimeSynchronization_ConfigUpdateNotify response + AF->>NEF: 19. Nnef_TimeSynchronization_ConfigUpdateNotify response + + Note right of SMF: 20. Time Synchronization configuration update due to coverage area resolution. + + Note right of TSCTSF: 21. Ntsctsf_TimeSynchronization_ConfigUpdateNotify request + TSCTSF->>NEF: 21. Ntsctsf_TimeSynchronization_ConfigUpdateNotify request + Note right of NEF: 22. Ntsctsf_TimeSynchronization_ConfigUpdateNotify response + NEF->>TSCTSF: 22. Ntsctsf_TimeSynchronization_ConfigUpdateNotify response + + Note right of NEF: 23. Nnef_TimeSynchronization_ConfigUpdateNotify request + NEF->>AF: 23. Nnef_TimeSynchronization_ConfigUpdateNotify request + Note right of AF: 24. Nnef_TimeSynchronization_ConfigUpdateNotify response + AF->>NEF: 24. Nnef_TimeSynchronization_ConfigUpdateNotify response +``` + +Sequence diagram showing interactions between SMF, PCF, TSCTSF, NEF, and AF for time synchronization configuration. The diagram includes 24 numbered steps and several process blocks (5-7, 14-15, 20) detailing internal logic and notifications. + +###### **Figure 5.5.11.3-1: Time Synchronization service activation, modification and deactivation** + +1. To create a time synchronization service configuration for a PTP instance and user-plane node ID, the AF invokes the Nnef\_TimeSynchronization\_ConfigCreate service operation to the NEF by sending the HTTP POST request to the "Time Synchronization Exposure Configurations" resource as specified in 3GPP TS 29.522 [24]. + +To update an existing time synchronization service configuration for a PTP instance and user-plane node ID, the AF invokes the Nnef\_TimeSynchronization\_ConfigUpdate service operation by sending the HTTP PUT request to the "Individual Time Synchronization Exposure Configuration" resource. + +To remove an existing time synchronization service configuration for a PTP instance and user-plane node ID, the AF invokes the Nnef\_TimeSynchronization\_ConfigDelete service operation by sending the HTTP DELETE request to the "Individual Time Synchronization Exposure Configuration" resource. + +The NEF authorizes the AF request. The request contains user-plane node ID as reference to the target of UEs and AF-sessions held in the TSCTSF in the "Individual Time Synchronization Exposure Subscription" resource for the indicated user-plane node ID. + +The Nnef\_TimeSynchronization\_ConfigCreate request creates also a subscription to notifications for the changes in the time synchronization service configuration. + +The AF may also subscribe to time synchronization status report by including (optionally) the clock quality detail level set to "acceptable/not acceptable indication" and providing clock quality acceptance criteria. + +NOTE 1: The AF request for PTP service activation, modification cannot indicate that the clock quality detail level to provide is "metrics", i.e. if the AF includes the clock quality detail level, its value needs to set to "acceptable/not acceptable indication" and accompanied with "clock quality acceptance criteria". The UE/DS-TT retrieves detailed information (timing synchronization metrics) from Announce messages sent for (g)PTP services. + +- 2 The NEF authorizes the AF request and translates the received parameters into 5GC parameters as described in 3GPP TS 29.522 [24] before invoking the TSCTSF services (e.g., if the AF request includes a time synchronization coverage area formulated using a geographical description of the area(e.g., civic addresses or shapes), the NEF transforms this information into 3GPP identifiers (e.g. TA(s)) based on pre-configuration). + +When the NEF receives the Nnef\_TimeSynchronization\_ConfigCreate request, the NEF invokes the Ntsctsf\_TimeSynchronization\_ConfigCreate service operation to create time synchronization service configuration for a PTP instance and a user-plane node ID in an "Individual Time Synchronization Exposure Subscription" resource in the TSCTSF by sending the HTTP POST request to the "Time Synchronization Exposure Configurations" resource as specified in 3GPP TS 29.565 [60]. If the "CoverageAreaSupport" feature is supported, the NEF may include the coverage area where the indicated service configuration applies. + +When the NEF receives the Nnef\_TimeSynchronization\_ConfigUpdate request, the NEF invokes the Ntsctsf\_TimeSynchronization\_ConfigUpdate service operation to update time synchronization service configuration for a PTP instance and a user-plane node ID in an "Individual Time Synchronization Exposure Subscription" resource in the TSCTSF by sending the HTTP PUT request to the "Individual Time Synchronization Exposure Configuration" resource as specified in 3GPP TS 29.565 [60]. If the "CoverageAreaSupport" feature is supported, the NEF may include the coverage area where the indicated service configuration applies. + +When the NEF receives the Nnef\_TimeSynchronization\_ConfigDelete request, the NEF invokes the Ntsctsf\_TimeSynchronization\_ConfigDelete service operation to delete time synchronization service configuration for a PTP instance and a user-plane node ID in an "Individual Time Synchronization Exposure Subscription" resource in the TSCTSF by sending the HTTP DELETE request to the "Individual Time Synchronization Exposure Configuration" resource as specified in 3GPP TS 29.565 [60]. The TSCTSF sends a "204 No Content" response. + +An AF that is part of operator's trust domain may invoke the TSCTSF services directly with TSCTSF. + +3. The TSCTSF acknowledges the NEF request including: + - For a creation request response, a "201 Created" status code, including a reference to the time synchronization service configuration created (PTP instance created) represented by the "Individual Time Synchronization Exposure Configuration" resource. + +- For an update request response, a "200 OK" or a "204 No Content" status code. + - For a delete request response, a "204 No Content" status code. +4. The NEF sends the HTTP response message to the AF correspondingly. + 5. The TSCTSF checks with the UDM if the concerned UE(s) are allowed to receive the time sync service configuration. + +The TSCTSF uses user-plane node ID and the PTP instance information (PTP instance type, transport protocol and PTP profile) of the request and the related "Individual Time Synchronization Exposure Subscription" resource, to determine the target UEs (SUPI(s)) and checks whether the AF requested parameters comply with the stored Time Synchronization Subscription Data retrieved from the UDM as described in clause 5.5.11.2. + +If the "AF request Authorization" in the Time Synchronization Subscription Data for the affected SUPI indicates that the AF is allowed to request PTP instance configuration, the TSCTSF proceeds with the configuration. Otherwise (i.e., the "AF request Authorization" is not allowed), steps 4 and steps 7-19 are skipped for this UE. + +NOTE 2: The AF-sessions that are not associated with a time synchronization configuration (for a user-plane node Id, specific PTP instance information, and the related "Individual Time Synchronization Exposure Subscription" resource), are available to be selected as suitable AF-sessions in another Ntsctsf\_TimeSynchronization\_ConfigCreate/Update request. + +If the Ntsctsf\_TimeSynchronization\_ConfigCreate request contains a temporal validity condition with a start-time and/or the stop-time that is in the future, the TSCTSF maintains the start-time and stop-time for the time synchronization service for the corresponding time synchronization configuration. If the start-time is in the past, the TSCTSF treats the request as if the time synchronization service is activated immediately. When the start-time is reached, the TSCTSF proceeds with the activation of the service. When the stop-time is reached for an active time synchronization service configuration, the TSCTSF proceeds as if an Ntsctsf\_TimeSynchronization\_ConfigDelete request is received. + +6. If the "CoverageAreaSupport" feature is supported, the NEF may include in step 2 the coverage area where the indicated service configuration applies. The TSCTSF determines the Time Synchronization Coverage Area by selecting the TA(s) that are part of both, the list of TA(s) provided by the NEF and the list of TA(s) stored in the Time Synchronization Subscription Data. Then, the TSCTSF performs the following operations: + +- The TSCTSF subscribes with the AMF(s) for UE presence in Area of Interest composed by the TA(s) as specified in 3GPP TS 29.565 [60]. +- Based on the notification from the AMF, the TSCTSF determines whether to activate time synchronization service for this UE: + - a. If the UE presence is within any of the TAs from the time synchronization coverage area, the TSCTSF determines to activate the received PTP instance configuration for the authorized UE. + - b. If the UE presence is not within any of the TAs from the time synchronization coverage area, the TSCTSF determines to set to inactive the received PTP instance configuration for the authorized UE. + +7. For each authorized UE (in step 3 and step 4) and matched AF-session, the TSCTSF uses the procedures described in clause K.2.2 of 3GPP TS 23.501 [2] to configure and initialize the PTP instance in the DS-TT(s) and NW-TT according to the parameters received in step 2. The TSCTSF constructs a PMIC to each DS-TT/UE to activate the time synchronization service in DS-TT and constructs PMIC(s) and UMIC to NW-TT to activate the time synchronization service in NW-TT. + +If in step 1 the AF subscribes to time synchronization status report, the TSCTSF may subscribe for notifications about changes in NG-RAN and UPF/NW-TT (if applicable) timing synchronization status as described in clause 5.5.11.5. + +8. For each authorized UE and matched AF-session, the TSCTSF delivers the PMIC(s) and UMIC to NW-TT and the PMIC(s) to DS-TT/UE by invoking the Npcf\_PolicyAuthorization\_Update service procedure as specified in clause 5.2.2.2.2.2. +9. The PCF acknowledges the request with a "200 OK" or a "204 No Content" status code. + +10. For each AF-session for which the TSCTSF triggered the Npcf\_PolicyAuthorization\_Update request, the PCF provides the UMIC/PMIC information for the concerned PDU session as described in clause 5.2.2.2.2. +- 11 The DS-TT(s) and the NW-TT response is encoded in the corresponding PMIC(s)/UMIC containers which are delivered by the SMF to the PCF in an SM Policy Association modification initiated by the SMF procedure, as described in clause 5.2.2.3. +12. The TSCTSF receives UMIC/PMIC information from NW-TT/DS-TT ports from the PCF with the notification about BRIDGE\_INFO events for each AF-session, as specified in 3GPP TS 29.514 [10]. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI as specified in clause 5.2.2.3. +13. The TSCTSF responds to the PCF with a "204 No Content" status code. +14. Upon reception of responses from each DS-TT and the NW-TT (for all affected AF sessions), the TSCTSF determines the state of the time synchronization configuration for the indicated PTP instance and user-plane node ID. +15. The TSCTSF uses the procedure in clause 5.5.11.4, steps 5-9, to activate or modify the 5G access stratum time distribution for the UEs that are part of the indicated PTP instance. +16. For an active PTP instance, the TSCTSF notifies the NEF (or AF), with the Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify service operation, by sending to the NEF (or AF) callback URI the HTTP POST request containing notification correlation identifier and the current state of the time synchronization service configuration for the NW-TT and DS-TTs (of the indicated PTP instance and user-plane node ID) as specified in 3GPP TS 29.565 [60]. + +If the TSCTSF receives a spatial validity condition as described in step 6, whenever the UE moves in or out of the Area of Interest, the TSCTSF may indicate to the AF whether a PTP port is activated or deactivated due to change of UE presence status in the Area of Interest. If the feature "NetTimeSynchStatus" is supported, and the state of the time synchronization service configuration for the NW-TT and/or DS-TT changes, the TSCTSF may indicate to the AF whether the PTP port is activated or deactivated due to a detected failure, degradation, or improvement of the time synchronization service. + +17. The NEF (or AF) acknowledges the notification request by replying with a "204 No Content" status code. +18. The NEF forwards to the AF in the Nnef\_TimeSynchronization\_ConfigUpdateNotify service operation the current state of the time synchronization service configuration for the NW-TT and DS-TT (for the active PTP instance and user-plane node ID) by invoking the HTTP POST request to the AF callback URI. +19. The AF acknowledges the notification request by replying with a "204 No Content" status code. +20. If TSCTSF received a time synchronization coverage area as part of the Ntsctsf\_TimeSynchronization\_ConfigCreate request in step 2, upon the reception of a change in the UE presence in Area of Interest notification, the TSCTSF determines if the time synchronization coverage area condition shall trigger an activation or deactivation of the PTI instance configuration: + - If the UE moves within any of the TAs from the time synchronization coverage area, then the TSCTSF adds the UE/DS-TT port to the PTP instance. + - If the UE moves outside all of the TAs from the time synchronization coverage area, then the TSCTSF removes the UE/DS-TT port rom the PTP instance. + +The TSCTSF configures the Grandmaster functionality, as applicable, as specified in 3GPP TS 29.565 [60]. The TSCTSF delivers the PMIC and/or UMIC as described in steps 8-15. The TSCTSF updates the state of the time synchronization configuration and may notify the NEF (or AF) as described in step 16-19.. + +21. For an active PTP instance, the TSCTSF notifies the NEF (or AF), with the Ntsctsf\_TimeSynchronization\_ConfigUpdateNotify service operation as specified in 3GPP TS 29.565 [60]. +22. The NEF (or AF) acknowledges the notification request by replying with a "204 No Content" status code. +23. The NEF forwards to the AF in the Nnef\_TimeSynchronization\_ConfigUpdateNotify service operation. + +24. The AF acknowledges the notification request by replying with a "204 No Content" status code. + +NOTE 3: If the AF receives a clock quality acceptance criteria result (acceptable/not acceptable), the AF decides whether to modify the service configured for the UE of a PTP instance or whether to deactivate it (deleting the PTP instance configuration). + +A change in the PTP instance in the DS-TT or NW-TT triggers a notification of PMIC/UMIC change towards the TSCTSF as described in clause 5.2.2.3 and steps 11-14. The change of PTP instance is notified to the NEF and AF as described in steps 16 to 19. + +Upon PDU Session release indication from a PCF, the TSCTSF removes the corresponding AF-session from the list of AF-sessions associated with the time synchronization configuration. The TSCTSF uses the procedure in clause 5.5.11.4 to remove the 5G access stratum time distribution parameters for the UE that is removed from the impacted PTP instance. The changes in the configured PTP instance are notified to the NEF and AF as described in steps 16 to 19. + +At PDU Session Establishment step 0, step 5, and steps 8-11 of figure 5.5.11.2-1 are repeated for a new PDU Session and AF-session. The NEF (or AF) may use the Ntsctsf\_TimeSynchronization\_ConfigUpdate service operation as described in figure 5.5.11.3-1 to add the DS-TT/UE to the existing PTP instance and corresponding time synchronization service configuration. + +If the TSCTSF received a temporal validity condition, the TSCTSF checks the activation or deactivation of the time synchronization service as specified in 3GPP TS 29.565 [60]. + +#### 5.5.11.4 Management of 5G Access Stratum Time distribution + +The AF can use the procedure to activate, update or delete the 5G access stratum time distribution for one UE or a group of UE(s). The AF may also use this procedure to indicate a clock quality detail level to provide to the UE or group of UE(s) and to subscribe for time synchronization status reports. + +The AF may query the status of the 5G access stratum time distribution using Nnef\_ASTI\_Get service operation. The Nnef\_ASTI service is specified in 3GPP TS 29.565 [60]. + +![Sequence diagram showing the management of 5G Access Stratum Time distribution between AMF, PCF, BSF, TSCTSF, NEF, and AF. The diagram is divided into four main sections: 0. AM Policy Association Establishment; 1. AF request to influence 5G Access Stratum Time distribution (steps 1-4); 2. PTP instance configuration or AF request (steps 5-9); 3. AF request to influence 5G Access Stratum Time distribution (steps 10-11); 4. PTP instance configuration or AF request (steps 12-16).](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant BSF + participant TSCTSF + participant NEF + participant AF + + Note over AMF, PCF: 0. AM Policy Association Establishment, clause 5.1.1. + + Note over BSF, TSCTSF, NEF, AF: AF request to influence 5G Access Stratum Time distribution + AF->>NEF: 1. Nnef_ASTI_Create/Update/Delete/Get request + NEF->>TSCTSF: 2. Ntsctsf_ASTI_Create/Update/Delete/Get request + Note over BSF, TSCTSF: 3. Validation of whether AF request for ASTI is allowed by subscription + Note over BSF, TSCTSF: 4. Coverage area resolution + + Note over AMF, PCF, BSF, TSCTSF, NEF: PTP instance configuration (clause 5.5.11.3) or AF request to influence 5G Access Stratum Time distribution + BSF->>TSCTSF: 5. Nbsf_Management_Subscribe request + TSCTSF->>BSF: 6. Nbsf_Management_Subscribe response + TSCTSF->>BSF: 6b. Nbsf_Management_Notify request/response + BSF->>PCF: 7. Npcf_AMPolicyAuthorization_Create/Update request + Note over AMF, PCF: 8. AM Policy Association Modification Initiated by the PCF, clause 5.1.2.2. + PCF->>TSCTSF: 9. Npcf_AMPolicyAuthorization_Create/Update response + + Note over BSF, TSCTSF, NEF, AF: AF request to influence 5G Access Stratum Time distribution + TSCTSF->>NEF: 10. Ntsctsf_ASTI_Create/Update/Delete/Get response + NEF->>AF: 11. Nnef_ASTI_Create/Update/Delete/Get response + + Note over AMF, PCF, BSF, TSCTSF, NEF: PTP instance configuration (clause 5.5.11.3) or AF request to influence 5G Access Stratum Time distribution + Note over BSF, TSCTSF: 12. Access stratum time distribution update due to coverage area resolution + + Note over BSF, TSCTSF, NEF, AF: AF request to influence 5G Access Stratum Time distribution + TSCTSF->>NEF: 13. Ntsctsf_ASTI_UpdateNotify request + NEF->>TSCTSF: 14. Ntsctsf_ASTI_UpdateNotify response + NEF->>AF: 15. Nnef_ASTI_UpdateNotify request + AF->>NEF: 16. Nnef_ASTI_UpdateNotify response + +``` + +Sequence diagram showing the management of 5G Access Stratum Time distribution between AMF, PCF, BSF, TSCTSF, NEF, and AF. The diagram is divided into four main sections: 0. AM Policy Association Establishment; 1. AF request to influence 5G Access Stratum Time distribution (steps 1-4); 2. PTP instance configuration or AF request (steps 5-9); 3. AF request to influence 5G Access Stratum Time distribution (steps 10-11); 4. PTP instance configuration or AF request (steps 12-16). + +**Figure 5.5.11.4-1: Management of 5G Access Stratum Time distribution** + +0. AM Policy Association establishment as described in clause 5.1.1. + +1. To provide access stratum time distribution parameters to the NEF, the AF invokes the Nnef\_ASTI\_Create service operation to the NEF by sending the HTTP POST request to the "ASTI Configurations" resource as specified in 3GPP TS 29.522 [24]. + +To update previously provided access stratum time distribution parameters, the AF invokes an Nnef\_ASTI\_Update by sending the HTTP PUT request to the "Individual ASTI Configuration" resource. + +To remove previously provided access stratum time distribution parameters, the AF invokes the Nnef\_ASTI\_Delete service operation by sending the HTTP DELETE request to the "Individual ASTI Configuration" resource. + +To query the status of the access stratum time distribution, the AF invokes Nnef\_ASTI\_Get service operation by sending the by sending the "retrieve" custom operation (HTTP POST request) to the "ASTI Configurations" resource. + +If the feature "NetTimeSynchStatus" is supported, the AF request may indicate the clock quality detail level of the information to provide to the UE and, if required, include the clock quality acceptance criteria for the UE. + +NOTE: If the AF requests clock quality detail level to be "acceptable/not acceptable indication", the AF needs to provide the clock quality acceptance criteria. + +By including the clock quality acceptance criteria in a Nnef\_ASTI request, the AF indicates to the TSCTSF (via the NEF) to create a subscription at the TSCTSF to get notified about the changes in 5G access stratum time distribution status. + +2. The NEF authorizes the request and maps the received parameters to 5GC parameters as specified in 3GPP TS 29.522 [24] (e.g., the NEF transforms a geographical area description provided as a spatial validity condition into 3GPP identifiers (e.g. TAIIs) based on configuration). After successful authorization, the NEF invokes: + - The Ntsctsf\_ASTI\_Create service operation by sending the HTTP POST request to the "ASTI Configurations" resource as specified in 3GPP TS 29.565 [60]. + - The Ntsctsf\_ASTI\_Update service operation by sending the HTTP PUT request to the "Individual ASTI Configuration" resource as specified in 3GPP TS 29.565 [60]. + - The Ntsctsf\_ASTI\_Delete service operation by sending the HTTP DELETE request to the "Individual ASTI Configuration" resource as specified in 3GPP TS 29.565 [60]. + - The Ntsctsf\_ASTI\_Get service operation by sending the "retrieve" custom operation (HTTP POST request) to the "ASTI Configurations" resource as specified in 3GPP TS 29.565 [60]. + +If the TSCTSF determines the targeted UE is part of a PTP instance in 5GS (see clause 5.5.11.3), the TSCTSF rejects the request (steps 3-4 and 7-19 are skipped). + +The AF that is part of operator's trust domain may invoke the services directly with the TSCTSF and identifies the targeted UE(s) using SUPI(s) or an Internal Group Identifier. + +If the Ntsctsf\_ASTI\_Create request in step 2 contains a temporal validity condition with a start-time and/or the stop-time that is in the future, the TSCTSF maintains the start-time and stop-time for the time synchronization service for the corresponding time synchronization configuration. If the start-time is in the past, the TSCTSF treats the request as if the time synchronization service is activated immediately. When the start-time is reached, the TSCTSF proceeds with the activation of the service. When the stop-time is reached for active time synchronization service configuration, the TSCTSF proceeds as if an Nnef\_ASTI\_Delete request is received. + +3. If the targeted UE(s) are identified by GPSI(s) or External/Internal Group Identifier, the TSCTSF interacts with UDM by invoking the Nudm\_SDM\_Get request as specified in 3GPP TS 29.503 [61] to retrieve the Time Synchronization Subscription Data for each affected SUPI. + +If the "AF request Authorization" in the Time Synchronization Subscription Data for the affected SUPI indicates that the AF is allowed to request 5G access stratum-based time distribution, the TSCTSF proceeds with ASTI service configuration. Otherwise, if the AF is not authorized, steps 4 and 7-19 are skipped for this UE. + +The TSCTSF checks the AF request with the stored Time Synchronization Subscription Data and authorizes the request. If the request is not authorized, steps 5 to 9 are skipped. + +4. If the feature "CoverageAreaSupport" is supported, the Ntsctsf\_ASTI\_Create request in step 2 may contain the coverage area where the Access Stratum Time Distribution service applies. The TSCTSF determines the Time Synchronization Coverage Area by selecting the TA(s) that are part of both, the list of TA(s) provided by the NEF and the list of TA(s) stored in the Time Synchronization Subscription Data. Then, the TSCTSF performs the following operations: + +- The TSCTSF subscribes with the AMF(s) for UE presence in Area of Interest composed by the TA(s) in the time synchronization coverage area as specified in 3GPP TS 29.565 [60]. +- Based on the notification from the AMF and the time synchronization coverage area received in step 1, the TSCTSF determines whether to activate time synchronization service for this UE: + - If the UE location is within any of the TAs from the time synchronization coverage area, the TSCTSF determines to enable access stratum time distribution for the UE. + - If the UE location is not within any of the TAs from the time synchronization coverage area, the TSCTSF determines to disable access stratum time distribution for the UE. + +If in step 1 the AF subscribes to time synchronization status report (containing timing synchronization metrics or a clock quality acceptance criteria result), the TSCTSF subscribes for notification about changes in NG-RAN and UPF/NW-TT timing synchronization status as described in clause 5.5.11.5. + +5. To search for the PCF for the UE, the TSCTSF invokes the Nbsf\_Management\_Subscribe service operation by sending an HTTP POST request to the "Binding Subscriptions" resource as specified in 3GPP TS 29.521 [22] to subscribe to notifications of PCF\_UE\_BINDING\_REGISTRATION event for the indicated SUPI. +6. If matching entries already existed in the BSF when step 5 is performed, this entry is immediately reported to the TSCTSF in the "201 created" response. + - 6.b. If the matching entry does not exist, the BSF provides to the TSCTSF the identity of the PCF for the UE for the requested SUPI via an Nbsf\_Management\_Notify operation once the PCF is registered as described in clause 5.1.1. +7. If the TSCTSF decides to enable the Access Stratum Time Distribution service for the UE, the TSCTSF calculates the Uu time synchronization error budget as described in clause 5.27.1.9 of 3GPP TS 23.501 [2]. + +When the procedure is triggered by PTP instance activation, modification, or deactivation in the TSCTSF as described in clause 5.5.11.3, the TSCTSF calculates the Uu time synchronization error budget as described in clause 5.27.1.9 of 3GPP TS 23.501 [2] for the SUPIs that are part of the PTP instance. + +The TSCTSF sends to the PCF for the UE the access stratum time distribution request using Npcf\_AMPolicyAuthorization\_Create/Update request as described in 3GPP TS 29.534 [50], containing the 5G access stratum time distribution indication (enable, disable) and optionally the calculated Uu time synchronization error budget. If the feature "NetTimeSynchStatus" is supported, the TSCTSF provides to the PCF for the UE the AF requested clock quality detail level and clock quality acceptance criteria, if available. + +8. If the PCF receives multiple time synchronization error budgets for a given UE, then the PCF picks the most stringent budget. The PCF may initiate an AM Policy Association Modification procedure as described in clause 5.1.2.2 to provide the AMF with the 5G access stratum time distribution parameters. If the feature "NetTimeSynchStatus" is supported, the PCF for the UE provides the AMF the AF requested clock quality detail level and clock quality acceptance criteria, if available. + +As part of this procedure, the AMF, if supported, stores the 5G access stratum time distribution indication (enable, disable), the Uu time synchronization error budget, the clock quality detail level and the clock quality acceptance criteria, if available, in the UE context in the AMF and sends the 5G access stratum time distribution indication (enable, disable), the Uu time synchronization error budget, the clock quality detail level and the clock quality acceptance criteria, when they are available, to NG-RAN (during mobility registration, AM policy modification, Service Request, N2 Handover and Xn handover) as specified in 3GPP TS 38.413 [62]. The NG-RAN node, if supported, stores the information in the UE Context. Based on this information, the NG-RAN node provides the 5GS access stratum time to the UE according to the Uu time synchronization error budget as provided by the TSCTSF (if supported by UE and NG-RAN) and timing synchronization status reports to the UE. + +9. The PCF of the UE replies to the TSCTSF with a "201 Created" status code to the Npcf\_AMPolicyAuthorization\_Create service request and with a "200 OK" or "204 No Content" status code to the Npcf\_AMPolicyAuthorization\_Update service request. +10. The TSCTSF responds the AF/NEF with the Ntsctsf\_ASTI\_Create/Update/Delete/Get service operation response using the "201 Created"/"200 OK" or "204 No Content"/"204 No Content"/"200 OK" status code respectively. + +11. The NEF informs the AF about the result of the Nnef\_ASTI\_Create/Update/Delete/Get service operation performed in step 2 using the "201 Created"/"200 OK" or "204 No Content"/"204 No Content"/"200 OK" status code respectively. +12. If the TSCTSF receives a time synchronization coverage area as part of the Ntscsf\_ASTI\_Create request in step 2 or as part of the (g)PTP time synchronization service configuration, as described in clause 5.5.11.3, upon the reception of a change in the UE presence in Area of Interest notification, the TSCTSF determines if the time synchronization coverage area condition shall trigger an activation or deactivation of the access stratum time distribution: + - If the UE moves within any of the TAs from the time synchronization coverage area, then the TSCTSF determines to enable access stratum time distribution for the UE. + - If the UE moves outside all of the TAs from the time synchronization coverage area, then the TSCTSF determines to disable access stratum time distribution for the UE. + +The TSCTSF updates the previously provided 5GS access stratum time distribution parameters as described in steps 7-9. + +If the TSCTSF receives clock quality acceptance criteria as part of the Ntscsf\_ASTI\_Create request in step 2, in case the TSCTSF determines a change in the support of the clock quality acceptance criteria for the UE as described in clause 5.5.11.5, the TSCTSF may update the previously provided 5GS access stratum time distribution parameters as described in steps 7-9. + +13. If the TSCTSF determines to update the enable/disable the 5G access stratum time distribution for the UE in step 12, and the TSCTSF received the time synchronization coverage area as part of the Ntscsf\_ASTI\_Create/Update request in step 2, the TSCTSF notifies the update of the service status to AF/NEF by sending an HTTP POST to the received callback URI as specified in 3GPP TS 29.565 [60]. + +If the TSCTSF determines a change in the fulfillment of the clock quality acceptance criteria for the UE for which the AF has requested the access stratum time distribution as described in clause 5.5.11.5, the TSCTSF includes the clock quality acceptance criteria result (acceptable/not acceptable) to the notification to the AF. Based on this notification, the AF decides whether to modify the ASTI service configured for the UE using Ntscsf\_ASTI\_Update service. + +14. The NEF/AF replies with a "204 No Content" status code. +15. The NEF forwards the received notification to the AF by sending an HTTP POST to the received callback URI as specified in 3GPP TS 29.522 [24]. +16. The NEF/AF replies with a "204 No Content" status code. + +#### 5.5.11.5 Management of network timing synchronization status monitoring + +![Sequence diagram illustrating the management of network timing synchronization status monitoring. The diagram shows interactions between AMF, UPF, PCF, TSCTSF, NEF, and AF. The sequence starts with a PTP or ASTI service activation (0). The TSCTSF then subscribes to NG-RAN synchronization status reports from the AMF (1) and to UPF/NW-TT timing synchronization status reports via UMIC from the UPF (2). The NG-RAN sends a timing synchronization status event to the TSCTSF (3). The UPF/NW-TT reports the timing synchronization status via UMIC to the TSCTSF (4). The TSCTSF triggers an ASTI or PTP service modification based on these events (5). Finally, the TSCTSF sends a time synchronization status change notification to the NEF (6).](f6d72d7c790e7f585532140f3971639a_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant UPF + participant PCF + participant TSCTSF + participant NEF + participant AF + + Note over AMF, AF: 0. PTP service activation 5.5.11.3 or ASTI service activation 5.5.11.4 + Note over AMF, TSCTSF: 1. TSCTSF Subscribes with AMF to NG-RAN synchronization status reports + Note over UPF, TSCTSF: 2. TSCTSF subscribes to UPF/NW-TT timing synchronization status reports via UMIC + Note over AMF, TSCTSF: 3. NG-RAN timing synchronization status event + Note over UPF, TSCTSF: 4. UPF/NW-TT reports timing synchronization status via UMIC to the TSCTSF + Note over AMF, TSCTSF: 5. ASTI or PTP service modification triggered by time synchronization status events + Note over TSCTSF, NEF: 6. Time synchronization status changes notification + +``` + +Sequence diagram illustrating the management of network timing synchronization status monitoring. The diagram shows interactions between AMF, UPF, PCF, TSCTSF, NEF, and AF. The sequence starts with a PTP or ASTI service activation (0). The TSCTSF then subscribes to NG-RAN synchronization status reports from the AMF (1) and to UPF/NW-TT timing synchronization status reports via UMIC from the UPF (2). The NG-RAN sends a timing synchronization status event to the TSCTSF (3). The UPF/NW-TT reports the timing synchronization status via UMIC to the TSCTSF (4). The TSCTSF triggers an ASTI or PTP service modification based on these events (5). Finally, the TSCTSF sends a time synchronization status change notification to the NEF (6). + +**Figure 5.5.11.5-1: Management of network timing synchronization status monitoring** + +0. An AF requests creation or modification of a (g)PTP-based or an ASTI-based time synchronization service as described in clauses 5.5.11.3 and 5.5.11.4; and to subscribe to time synchronization status report(s), the AF provides clock quality detail level and, if applicable, clock quality acceptance criteria in the request. + +If network timing synchronization status reports are provisioned using node-level signalling via control plane, the TSCTSF determines the serving AMF(s) and the UPF/NW-TT nodes (in cases where UPF/NW-TT is involved in providing time information to DS-TT) for the UE(s) that needs to initiate network timing synchronization status monitoring. + +1. For 5G access stratum time distribution or PTP instance activation, modification, if the UE/DS-TT obtains time information from NG-RAN and if network timing synchronization status reports are provisioned using node-level signalling via control plane: + +- The TSCTSF subscribes with the determined AMF(s) to NG-RAN timing synchronization status updates at the NG-RAN nodes that may provision 5G access stratum time distribution information to the target UE. + +NOTE 1: The provisioning of the NG-RAN timing synchronization status attributes can be configured via OAM or via TSCTSF and AMF with node-level signalling. The RAN node is pre-configured with the thresholds for each timing synchronization status attribute as described in clause 5.27.1.12 in 3GPP TS 23.501 [2]. When the network timing synchronization status exceeds or meets again any of the pre-configured thresholds, the NG-RAN node detects a change of its timing synchronization status (e.g., degradation, failure, improvement) and reports it. + +2. For PTP instance activation, modification, if the UPF/NW-TT is involved in providing time information to DS-TT and if network timing synchronization status reports are provisioned using node-level signalling via control plane: + +The TSCTSF subscribes to timing synchronization status updates with the UPF/NW-TT that may provision time information via PTP to the target UE. + +NOTE 2: The UPF/NW-TT timing synchronization status updates provisioning can be configured via OAM or via UMIC. + +3. When timing synchronization status reporting in NG-RAN is configured by the TSCTSF via the AMF in step 1, if the NG-RAN node detects a change on its timing synchronization, the TSCTSF receives an NG-RAN timing synchronization status update via the AMF. The update contains a scope of the timing synchronization status (as described in clause 5.27.1.12 in 3GPP TS 23.501 [2]) and some or all of the information elements listed in Table 5.27.1.12-1 of 3GPP TS 23.501 [2]. +4. When timing synchronization status reporting in the UPF/NW-TT is configured by the TSCTSF via UMIC in step 2, if the UPF/NW-TT detects a change on its timing synchronization status, the TSCTSF receives a UPF/NW-TT timing synchronization status update from the UPF/NW-TT via UMIC. The update contains some or all of the information elements listed in Table 5.28.3.1-2 of 3GPP TS 23.501 [2]. +5. Upon the reception of an update on the NG-RAN and/or NW-TT timing synchronization status, the TSCTSF determines the impacted UE(s) and, if applicable, whether the clock quality acceptance criteria can still be met. + +NOTE 3: When the status update indicates degradation in the NG-RAN, the TSCTSF subscribes to notifications about UE presence in an Area of Interest for the gNB node ID(s) or Cell IDs that reported the timing synchronization status degradation/improvement in order to determine the affected UE(s). + +NOTE 4: NG-RAN and/or UPF/NW-TT timing synchronization status update can be configured via OAM instead of node-level signalling via control plane. + +For each affected UE, if the TSCTSF determines that the clock quality acceptance criteria can still be met, then TSCTSF may update, for (g)PTP, the clockQuality information sent in Announce messages for the PTP instance using PMIC/UMIC reporting, and for ASTI service, the TSCTSF notifies the service status to AF, as described in step 6, which based on this notification decides whether to modify the ASTI service configured for the UE. + +NOTE 5: The handling of Announce messages follows existing procedures as described in 3GPP TS 23.501 [2]. + +6. If the clock quality acceptance criteria cannot be met or can be met again, then TSCTSF informs the AF about the acceptance criteria result (e.g., acceptable/not acceptable), for PTP based or ASTI time synchronization service as described in clauses 5.5.11.3 and 5.5.11.4. + +### 5.5.12 Deterministic Networking specific parameter provisioning + +#### 5.5.12.1 General + +The 5G System is integrated with the Deterministic Network as defined in IETF RFC 8655[63] as a logical DetNet transit router as specified in 3GPP TS 23.501 [2], clause 4.4.8.4. + +Deterministic Networking parameter provisioning allows a DetNet controller to configure deterministic networking parameters in 5GS and provide time-sensitive features that guarantee almost zero packet loss rates and bounded latency. + +The DetNet support is achieved by reusing the TSC framework for deterministic QoS and time synchronization services. To enable deterministic networking in 5GS, the DetNet controller collects interface information from the 5GS DetNet node using the 5GS DetNet node information reporting procedure as described in clause 5.5.12.2 and configures the reported interfaces as described in clause 5.5.12.3. + +#### 5.5.12.2 5GS DetNet node information reporting + +The TSCTSF may provide exposure information to the DetNet controller using information collected from the UPF/NW-TT via parameters in PMIC, and for the device side ports, using parameters provided from the SMF to the TSCTSF via PCF, as described in figure 5.5.12.2-1. + +![Sequence diagram for 5GS DetNet node information reporting. Lifelines: SMF, PCF, TSCTSF, DetNet Controller. The sequence starts with SMF sending a 'Policy Authorization Notify and reporting DetNet router information' to PCF. PCF then sends 'Npcf_PolicyAuthorization_Create/Subscribe request' to TSCTSF, which responds. SMF then reads UMIC information (steps 4.1 and 4.2). PCF sends 'Npcf_PolicyAuthorization_Notify request' to TSCTSF, which responds. PCF then sends 'Npcf_PolicyAuthorization_Update request' to TSCTSF, which responds. SMF then reads PMIC information (steps 9.1 and 9.2). PCF sends 'Npcf_PolicyAuthorization_Notify request' to TSCTSF, which responds. Finally, TSCTSF provides interface information to the DetNet Controller.](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant TSCTSF + participant DetNet Controller + + Note over SMF, PCF: 1. Policy Authorization Notify and reporting DetNet router information. + PCF->>TSCTSF: 2. Npcf_PolicyAuthorization_Create/Subscribe request + TSCTSF-->>PCF: 3. Npcf_PolicyAuthorization_Create/Subscribe response + Note left of SMF: 4. Read UMIC information: +4.1.SM Policy Association modification initiated by the AF, clause 5.2.2.2.2.2. +4.2 SM Policy Association modification initiated by the SMF, clause 5.2.2.3. + PCF->>TSCTSF: 5. Npcf_PolicyAuthorization_Notify request + TSCTSF-->>PCF: 6. Npcf_PolicyAuthorization_Notify response + PCF->>TSCTSF: 7. Npcf_PolicyAuthorization_Update request + TSCTSF-->>PCF: 8. Npcf_PolicyAuthorization_Update response + Note left of SMF: 9. Read PMIC information: +9.1.SM Policy Association modification initiated by the AF, clause 5.2.2.2.2.2. +9.2 SM Policy Association modification initiated by the SMF, clause 5.2.2.3. + PCF->>TSCTSF: 10. Npcf_PolicyAuthorization_Notify request + TSCTSF-->>PCF: 11. Npcf_PolicyAuthorization_Notify response + Note right of TSCTSF: 12. TSCTSF provides interface information to the DetNet controller. + TSCTSF-->>DetNet Controller: + +``` + +Sequence diagram for 5GS DetNet node information reporting. Lifelines: SMF, PCF, TSCTSF, DetNet Controller. The sequence starts with SMF sending a 'Policy Authorization Notify and reporting DetNet router information' to PCF. PCF then sends 'Npcf\_PolicyAuthorization\_Create/Subscribe request' to TSCTSF, which responds. SMF then reads UMIC information (steps 4.1 and 4.2). PCF sends 'Npcf\_PolicyAuthorization\_Notify request' to TSCTSF, which responds. PCF then sends 'Npcf\_PolicyAuthorization\_Update request' to TSCTSF, which responds. SMF then reads PMIC information (steps 9.1 and 9.2). PCF sends 'Npcf\_PolicyAuthorization\_Notify request' to TSCTSF, which responds. Finally, TSCTSF provides interface information to the DetNet Controller. + +**Figure 5.5.12.2-1: 5GS DetNet node information reporting** + +- During SM Policy Association establishment, if the feature "TimeSensitiveCommunication" is supported, the PCF based on local configuration for the DNN and S-NSSAI determines that the SM Policy Association enables Deterministic Networking and provides to the SMF the "TSN\_BRIDGE\_INFO" policy control request trigger as described in figure 5.2.1-1, step 11. + +When the trigger is met, the PCF receives the TSC User Plane information from the SMF (for DetNet it represents 5GS Router information) and the device side information: port number, User Plane node ID and, if available and the feature "MTU\_Size" is supported, MTU size for IPv4 and MTU size for IPv6 as described in figure 5.2.2.3-1, step 2. The PCF may also receive NW-TT PMIC (with network side interface configuration information). The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to notify to the TSCTSF the received TSC User Plane information and the device side information, and if available, NW-TT PMIC(s)/UMIC, as described in figure 5.2.2.3-1, step 5 and includes the UE IP address to identify the PDU session. + +During SM Policy Association establishment (clause 5.2.1), and when Framed Routes applies, the PCF receives Framed Route information from the SMF during SM Policy Association creation. During SM Policy Association update (figure 5.2.2.3), and when prefix delegation applies, the SMF reports to the PCF the prefix delegated to the UE by IPv6 prefix delegation. + +- The TSCTSF then invokes the Npcf\_PolicyAuthorization\_Create request message to the PCF as described in clause 5.2.2.2.2.1 to create an AF-session. The TSCTSF shall subscribe with the PCF to the "TSN\_BRIDGE\_INFO" event, to get notifications about NW-TT PMIC(s)/UMIC updates as specified in 3GPP TS 29.514 [10]. + +If the "ExtraUEaddrReport" feature is supported, the TSCTSF shall subscribe to the "EXTRA\_UE\_ADDR" event to receive information about the one or more Framed Routes available for the PDU session or about the IPv6 prefixes delegated to the UE by IPv6 Prefix Delegation. + +Using the User Plane node Id received in step 1, the TSCTSF may subscribe with the NW-TT to receive UMIC information for the indicated User Plane node Id, if not previously received, by provisioning the concerned UMIC container. + +3. If the information is available in the PCF, the PCF returns the event related information in the Npcf\_PolicyAuthorization\_Create response (e.g. framed route information, if the TSCTSF subscribed to notifications on reporting of extra addresses, and frame routes are available). + +The TSCTSF stores the DNN, S-NSSAI and IP address(es) as received from PCF and associates them with the AF-session, as described in 3GPP TS 29.565 [60]. + +If the TSCTSF determines the interface configuration information for the created AF-session is complete, the TSCTSF may report to the DetNet controller the collected interface(s) information as described in step 10. + +4. The PCF subscribes to UMIC changes with the SMF: + - 4.1 The PCF provides to the SMF the UMIC information received from the TSCTSF as described in clause 5.2.2.2.2.2, and the SMF sends the received UMIC to the NW-TT/UPF. + - 4.2 When the SMF receives the UMIC reported from the UPF/NW-TT, the SMF provides the received UMIC information to the PCF as described in clause 5.2.2.3. +5. The TSCTSF receives from the PCF the notification of the BRIDGE\_INFO event, as specified in 3GPP TS 29.514 [10], containing the UMIC information with the NW-TT ports of the indicated User Plane node Id. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI as specified in clause 5.2.2.3. +6. The TSCTSF responds to the PCF with a "204 No Content" status code. +7. The TSCTSF shall request PMIC information from the NW-TT using the User Plane node Id received in step 1 and the port number(s) received in step 5, to read network interface configuration for the indicated ports, as specified in 3GPP TS 23.501 [2]. The TSCTSF interacts with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request message as specified in 3GPP TS 29.514 [10]. +8. The PCF responds with a "200 OK" or "204 No Content" status code in response to the Npcf\_PolicyAuthorization request. +9. The PCF subscribes to PMIC changes from the SMF: + - 9.1. The PCF provides to the SMF the PMIC information received from the TSCTSF as described in clause 5.2.2.2.2.2, which sends the received PMIC to the NW-TT/UPF. + - 9.2 When the SMF detects PMIC changes for the NW-TT, the SMF provides the received PMIC information to the PCF as described in clause 5.2.2.3. +10. The TSCTSF receives the PMIC information from the NW-TT ports via the PCF with the notification of the BRIDGE\_INFO event, as specified in 3GPP TS 29.514 [10]. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the callback URI as specified in clause 5.2.2.3. +11. The TSCTSF responds to the PCF with a "204 No Content" status code. +12. After the TSCTSF determines that the interface information for the AF session is complete, the TSCTSF may provide the collected network and device side interface configuration to the DetNet controller as defined in 3GPP TS 23.501 [2]. + +When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node as specified in 3GPP TS 29.565 [60], the TSCTSF may use the user-plane node ID received in step 1 to generate an identifier of the 5GS DetNet node and provide it to the DetNet controller. + +NOTE: The 5GS node identification can be realized by providing an identifier of the 5GS DetNet node to the DetNet controller using the exposure of 5GS DetNet node identification specified in the 3GPP Extension 3gpp-5gs-detnet-node in 3GPP TS 29.565 [60], or the TSCTSF can provide different termination points (addresses) for the signalling between the DetNet controller and the TSCTSF, each one representing different 5GS nodes. + +#### 5.5.12.3 5GS DetNet node configuration + +The DetNet controller triggers the 5GS DetNet node configuration procedure to provide Deterministic Networking specific parameters to 5GS as described in figure 5.5.12.2-1. + +![Sequence diagram for 5GS DetNet node configuration showing interactions between SMF, PCF, TSCTSF, and DetNet Controller.](053f1077d592e6622cd21dc4bb4cb366_img.jpg) + +``` + +sequenceDiagram + participant SMF + participant PCF + participant TSCTSF + participant DetNet Controller + + Note right of DetNet Controller: 2. Determine 5GS requirements for the DetNet flow based on DetNet YANG configuration + + DetNet Controller->>TSCTSF: 1. Provide DetNet YANG configuration + Note right of TSCTSF: 2. Determine 5GS requirements for the DetNet flow based on DetNet YANG configuration + TSCTSF->>PCF: 3. Npcf_PolicyAuthorization_Update request + PCF->>TSCTSF: 4. Npcf_PolicyAuthorization_Update response + Note left of SMF: 5. SM Policy Association modification initiated by the AF, clause 5.2.2.2.2.2. + Note left of SMF: 6. SM Policy Association modification initiated by the SMF, clause 5.2.2.3. + SMF->>TSCTSF: 7. Npcf_PolicyAuthorization_Notify request + TSCTSF->>PCF: 8. Npcf_PolicyAuthorization_Notify response + TSCTSF->>DetNet Controller: 9. Response to DetNet YANG configuration + +``` + +Sequence diagram for 5GS DetNet node configuration showing interactions between SMF, PCF, TSCTSF, and DetNet Controller. + +Figure 5.5.12.3-1: DetNet Node configuration + +1. The DetNet controller provides YANG data model configuration to the TSCTSF. The TSCTSF uses the identifier of the incoming and outgoing interfaces, as provided in step 10 of figure 5.5.12.2-1, to determine the affected PDU Session(s) and flow direction, whether it is uplink or downlink. The TSCTSF also determines if the flow is UE to UE in which case two PDU sessions will be affected for the flow and the TSCTSF breaks up the requirements to individual requirements for the PDU Sessions. +2. The TSCTSF determines the 5GS requirements for the DetNet flow. + +When both, the TSCTSF and the DetNet controller support the 3GPP Extension 3gpp-5gs-detnet-node as specified in 3GPP TS 29.565 [60], the TSCTSF maps the received 5GS maximum latency and/or 5GS maximum loss to QoS parameters to PCF as specified in clause 5.5.12.4. When the TSCTSF and/or the DetNet controller do not support the 3GPP Extension 3gpp-5gs-detnet-node or the DetNet YANG configuration includes the E2E traffic requirements, the TSCTSF derives 5GS requirements based on pre-configured mapping as described in 3GPP TS 29.565 [60]. The TSCTSF also constructs a TSCAC for each flow description. + +The TSCTSF provides the mapped parameters and the flow description to the PCF(s) on a per AF Session basis for the given UE address. + +3. The TSCTSF interacts with the PCF by triggering a Npcf\_PolicyAuthorization\_Update request message as specified in 3GPP TS 29.514 [10], to provide the required QoS for each flow description. The TSCTSF subscribes to the report of successful/unsuccessful resource allocation outcome as specified in 3GPP TS 29.514 [10]. +4. The PCF authorizes the request from TSCTSF and responds with a "200 OK" or "204 No Content" status code to the received PATCH request. If the PCF determines that the requirements can't be authorized, it rejects the request with the appropriate status code and error cause. In case the request is rejected, the TSCTSF informs the DetNet controller about the unsuccessful outcome as described in step 9. +5. Once the PCF authorizes the request, the PCF updates the SMF with corresponding new PCC rule(s) and policy control request triggers as specified in the PCF initiated SM Policy Association Modification procedure described in clause 5.2.2.2.2.2. The QoS flow is established according to the 5GS QoS requirements for the DetNet flow. +6. The SMF reports to the PCF the outcome about the successful/unsuccessful establishment of the QoS flow as specified in clause 5.2.2.3. +7. The PCF invokes the Npcf\_PolicyAuthorization\_Notify request service operation to provide to the TSCTSF the outcome of the QoS provisioning parameters by sending an HTTP POST request to the callback URI as specified in clause 5.2.2.3. +8. The TSCTSF responds to the PCF with a "204 No Content" status code. +9. The TSCTSF responds to the DetNet controller. + +When both, the TSCTSF and the DetNet controller support Extension 3gpp-5gs-detnet-node as specified in 3GPP TS 29.565 [60], the TSCTSF may provide 5GS specific status code information on the result of the configuration to the DetNet controller. If the status of the flow changes later for any reason (e.g., service data flow deactivation) or the PDU session is released, the TSCTSF notifies the DetNet controller on the status of the flow with 5GS specific information. + +#### 5.5.12.4 QoS parameter mapping functions at TSCTSF + +The TSCTSF may receive from a DetNet Controller DetNet YANG configuration describing the traffic characteristics and QoS requirements for a DetNet flow(s) as described in IETF draft-ietf-detnet-yang [64] and, if supported, in the 3GPP extension 3gpp-5gs-detnet-node described in 3GPP TS 29.565 [60]. + +The TSCTSF maps the DetNet configuration as follows before interacting with the PCF: + +**Table 5.5.12.4-1: QoS parameter mapping functions at the TSCTSF** + +| traffic-profile
IETF draft-ietf-detnet-yang [64] | | Media Component
3GPP TS 29.514 [10] | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--| +| "traffic-requirements" | "min-bandwidth" | "mirBwUI", "mirBwDI" (NOTE 2): Minimum requested bandwidth. Represents the requested guaranteed bit rate. | | | | +| | "max-latency" | "tsnQos" | "tscPackDelay": Represents the requested Packet Delay Budget. The provided value is based on a pre-configured mapping for the given deployment. | | | +| | "_3gpp-5gs-node-max-latency" (NOTE 1) | "tsnQos" | "tscPackDelay": Represents the requested Packet Delay Budget. It is the result of subtracting the UE-DS-TT residence time (either provided by the PCF or pre-configured at TSCTSF) from the "_3gpp-5gs-node-max-latency". | | | +| | "max-loss" | "tsnQos" | "maxPer": Represents the requested maximum Packet Error Rate. The provided value is based on a pre-configured mapping for the given deployment. | | | +| | "_3gpp-5gs-node-max-loss" (NOTE 1) | "tsnQos" | "maxPer": Represents the requested maximum Packet Error Rate. | | | +| | "max-consecutive-loss-tolerance" | "tscaInputUI", "tscaInputDI" (NOTE 2) | "surTimeInNumMsg", "surTimeInTime": Represents the survival time (when the mapping is possible, e.g. when there is only a single packet per interval). | | | +| "traffic-spec" | "interval" | "tscaInputUI", "tscaInputDI" (NOTE 2) | "periodicity": Represents the periodicity between the start of two data bursts. | | | +| | "max-pkts-per-interval" | "tsnQos" | "maxTscBurstSize": Represents the maximum burst size. It is calculated as the max-pkts-per-interval * (max-payload-size + protocol header size). | | | +| | "max-payload-size" | | | | | +| | "protocol header-size" | | | | | +| | "interval" | "marBwUI", "marBwDI" (NOTE 2): Maximum requested bandwidth. Represents the requested maximum bit rate. It is calculated as the max-pkts-per-interval * (max-payload-size + protocol header size)/ interval. | | | | +| | "max-pkts-per-interval" | | | | | +| | "max-payload-size" | | | | | +| | "protocol header-size" | | | | | +| NOTE 1: When both the TSCTSF and the DetNet controller support 3GPP extensions described in 3GPP TS 29.565 [60] to the IETF draft-ietf-detnet-yang [64], the DetNet controller may provide the "_3gpp-5gs-node-max-latency" and "_3gpp-5gs-node-max-loss" specific to the 5GS system. | | | | | | +| NOTE 2: The UL flow direction represents the traffic at the ingress interface of the DS-TT/UE. The DL flow direction represents the traffic at the ingress interface of the NW-TT. | | | | | | + +The DetNet flow specification for the application flow(s) is based on the IP source and destination addresses, IPv4 protocol or IPv6 next header, IPv4 type of service or IPv6 traffic class, IPv6 flow label, TCP or UDP source or destination ports, and IPsec SPI header fields as defined in section 5.1 of IETF RFC 8939 [32]. The DetNet flow specification is mapped into the corresponding UL and/or DL fields of the 5GS Flow Description, within the media subcomponent, as specified in 3GPP TS 29.514 [20]. + +Based on the mapping of the received traffic profile and/or 3GPP extended parameters, the TSCTSF provides the derived TSC Assistance Container and the related QoS information to the PCF as specified in table 5.5.12.4-1. + +### 5.5.13 Negotiation for planned data transfer with QoS requirements + +![Sequence diagram for Negotiation for PDTQ procedure. Lifelines: UDR, NWDAF, (H-)PCF, NEF, AF. The sequence starts with the AF sending a request to the NEF, which then calls the PCF. The PCF queries the UDR for data, receives it, performs a policy decision, and returns a response to the NEF. The NEF then sends a response to the AF. Subsequent steps involve updates and responses between the AF, NEF, and PCF, with the PCF updating the UDR.](cab0834804fb031b43865554cc8d06ab_img.jpg) + +``` + +sequenceDiagram + participant AF + participant NEF + participant PCF as (H-)PCF + participant NWDAF + participant UDR + + Note right of PCF: 5. PCF Retrieves the Network Performance analytics and/or DN Performance analytics from NWDAF + + Note right of PCF: 6. Policy decision + + AF->>NEF: 1. Nnef_PDTQPolicyNegotiation_Create Request + NEF->>PCF: 2. Npcf_PDTQPolicyControl_Create Request + PCF-->>UDR: 3. Nudr_DataRepository_Query request + UDR-->>PCF: 4. Nudr_DataRepository_Query response + Note right of PCF: 5. PCF Retrieves the Network Performance analytics and/or DN Performance analytics from NWDAF + Note right of PCF: 6. Policy decision + PCF->>NEF: 7. Npcf_PDTQPolicyControl_Create Response + NEF->>AF: 8. Nnef_PDTQPolicyNegotiation_Create Response + AF-->>NEF: 9. Nnef_PDTQPolicyNegotiation_Update Request + NEF-->>PCF: 10. Npcf_PDTQPolicyControl_Update Request + PCF-->>NEF: 11. Npcf_PDTQPolicyControl_Update Response + NEF-->>AF: 12. Nnef_PDTQPolicyNegotiation_Update Response + PCF-->>UDR: 13. Nudr_DM_Update_Request + UDR-->>PCF: 14. Nudr_DM_Update_Response + +``` + +Sequence diagram for Negotiation for PDTQ procedure. Lifelines: UDR, NWDAF, (H-)PCF, NEF, AF. The sequence starts with the AF sending a request to the NEF, which then calls the PCF. The PCF queries the UDR for data, receives it, performs a policy decision, and returns a response to the NEF. The NEF then sends a response to the AF. Subsequent steps involve updates and responses between the AF, NEF, and PCF, with the PCF updating the UDR. + +Figure 5.5.13-1: Negotiation for PDTQ procedure + +- The AF invokes the Nnef\_PDTQPolicyNegotiation\_Create service operation by sending an HTTP POST request to the resource "PDTQ Policy Subscriptions" to negotiate the PDTQ policies. The detailed information contained in AF request is described in clause 4.4.34 of 3GPP TS 29.522 [24]. When the AF provides a geographical area, then the NEF maps it based on local configuration into a short list of TAs and/or NG-RAN nodes and/or cells identifiers, which are provided to the (H-) PCF. + +NOTE 1: The AF can determine the minimum QoS requirements based on the UEs who are expected to participate in the PDTQ transfer window, the network input data and the group application data transfer trigger conditions. + +The NEF may map the ASP ID into DNN and S-NSSAI to be used in step 2. + +NOTE 2: The Application ID provided by the AF and the Application ID that is provided to NWDAF can be different, and the mapping will be performed in the PCF. + +- Upon receipt of a PDTQ policies request from the AF, the NEF invokes the Npcf\_PDTQPolicyControl\_Create service operation to the (H-) PCF by sending an HTTP POST request to the resource "PDTQ policies". The detailed information contained in NEF request is described in clause 5.2.2.2.2 of 3GPP TS 29.543 [68]. + +- The (H-) PCF may invoke the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request to the resource "PdtqData" as defined in clause 5.2.17.3.1 of 3GPP TS 29.519 [12] to request from the UDR all existing PDTQ policies. The UDR sends an HTTP "200 OK" response with all the stored PDTQ policies and corresponding related information to the (H-) PCF. + +NOTE 3: In case only one PCF is deployed in the network, PDTQ policies can be locally stored in the PCF and the interaction with the UDR is not required. + +5. The PCF requests and/or subscribes to the "Network Performance Analytics" from NWDAF as defined in clause 5.7.5 of 3GPP TS 29.552 [48] and/or the "DN Performance Analytics" as defined in clause 5.7.16 of 3GPP TS 29.552 [48]. +6. The (H-) PCF determines one or more PDTQ policies based on the information received from the NEF and other available information (e.g. network policy, existing PDTQ policies, network area information and performance analytics from the NWDAF). Each PDTQ policy includes a recommended time window for the traffic transfer for each of the AF session for each of the UEs involved. +7. The (H-) PCF sends a "201 Created" response to the Npcf\_PDTQPolicyControl\_Create service operation with the acceptable one or more PDTQ policies and a PDTQ Reference ID. +8. The NEF sends a "201 Created" response to forward the received PDTQ policies to the AF. If the NEF received only one PDTQ policy from the (H-) PCF, steps 9-12 are not executed and the flow proceeds to step 13. Otherwise, the flow proceeds to step 9. +9. If more than one PDTQ policies were provided to the AF, the AF invokes the Nnef\_PDTQPolicyNegotiation\_Update service operation by sending an HTTP PATCH request to the resource "Individual PDTQ Policy Subscription" as described in clause 4.4.34 of 3GPP TS 29.522 [24] to provide the NEF with the selected PDTQ policy. The AF may also send an HTTP PATCH to request to disable/enable the PDTQ warning notification. +10. The NEF invokes the Npcf\_PDTQPolicyControl\_Update service operation by sending an HTTP PATCH request to the resource "Individual PDTQ Policy" as described in clause 5.2.2.3 of 3GPP TS 29.543 [68] to provide the (H-) PCF with the selected PDTQ policy and/or PDTQ warning notification information. +11. The (H-) PCF sends an HTTP PATCH response message to the NEF. +12. The NEF sends an HTTP PATCH response message to the AF. +- 13-14. If the (H-) PCF does not locally store the PDTQ policy and if applicable, PDTQ warning notification information, it invokes the Nudr\_DataRepository\_Update service operation by sending an HTTP PUT request to the resource "IndividualPdtqData", to store for the provided ASP identifier the new PDTQ policy and if applicable, warning notification information together with the information defined in clause 5.4.2.33 of 3GPP TS 29.519 [12]. The UDR sends an HTTP "201 Created" response to the (H-) PCF. + +### 5.5.13A Modification of PDTQ warning notification request indication procedure + +![Sequence diagram for the modification of PDTQ warning notification request indication procedure. The diagram shows five lifelines: UDR, NWDAF, (H-)PCF, NEF, and AF. The sequence of messages is: 1. AF sends Nnef_PDTQPolicyNegotiation_Update Request to NEF; 2. NEF sends Npcf_PDTQPolicyControl_Update Request to (H-)PCF; 3. (H-)PCF sends Npcf_PDTQPolicyControl_Update Response to NEF; 4. NEF sends Nnef_PDTQPolicyNegotiation_Update Response to AF; 5. (H-)PCF sends Nudr_DM_Update_Request to UDR (dashed line); 6. UDR sends Nudr_DM_Update_Response to (H-)PCF (dashed line).](75f0cb39f1cd165dfe4a6aa6c4d9388d_img.jpg) + +``` +sequenceDiagram + participant AF + participant NEF + participant (H-)PCF + participant NWDAF + participant UDR + Note left of AF: + AF->>NEF: 1. Nnef_PDTQPolicyNegotiation_Update Request + NEF->>(H-)PCF: 2. Npcf_PDTQPolicyControl_Update Request + (H-)PCF-->>NEF: 3. Npcf_PDTQPolicyControl_Update Response + NEF-->>AF: 4. Nnef_PDTQPolicyNegotiation_Update Response + Note left of (H-)PCF: + (H-)PCF-->>UDR: 5. Nudr_DM_Update_Request + UDR-->>(H-)PCF: 6. Nudr_DM_Update_Response +``` + +Sequence diagram for the modification of PDTQ warning notification request indication procedure. The diagram shows five lifelines: UDR, NWDAF, (H-)PCF, NEF, and AF. The sequence of messages is: 1. AF sends Nnef\_PDTQPolicyNegotiation\_Update Request to NEF; 2. NEF sends Npcf\_PDTQPolicyControl\_Update Request to (H-)PCF; 3. (H-)PCF sends Npcf\_PDTQPolicyControl\_Update Response to NEF; 4. NEF sends Nnef\_PDTQPolicyNegotiation\_Update Response to AF; 5. (H-)PCF sends Nudr\_DM\_Update\_Request to UDR (dashed line); 6. UDR sends Nudr\_DM\_Update\_Response to (H-)PCF (dashed line). + +**Figure 5.5.13A-1: Modification of PDTQ warning notification request indication procedure** + +1. The AF sends an HTTP PATCH request to the resource "Individual PDTQ Policy Subscription" as described in clause 4.4.34 of 3GPP TS 29.522 [24] to disable/enable the PDTQ warning notification. +2. The NEF invokes the Npcf\_PDTQPolicyControl\_Update service operation by sending an HTTP PATCH request to the resource "Individual PDTQ Policy" as described in clause 5.2.2.3 of 3GPP TS 29.543 [68] to provide the (H-) PCF with the PDTQ warning notification information. +3. The (H-) PCF sends an HTTP PATCH response message to the NEF. +4. The NEF sends an HTTP PATCH response message to the AF. +- 5-6. If the (H-) PCF does not locally store the PDTQ warning notification information, it invokes the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the resource "IndividualPdtqData", to store the warning notification information together with the information defined in clause 5.4.2.33 of 3GPP TS 29.519 [12]. The UDR responds to the (H-) PCF. + +### 5.5.14 PDTQ warning notification procedure + +![Sequence diagram of the PDTQ warning notification procedure involving UDR, NWDAF, (H-)PCF, NEF, and AF.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant UDR + participant NWDAF + participant HPCF as (H-)PCF + participant NEF + participant AF + + Note right of HPCF: 0. Negotiation for PDTQ procedure + Note left of NWDAF: 1. PCF is notified that Network Performance or DN Performance has degraded + HPCF->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>HPCF: 3. Nudr_DataRepository_Query response + Note right of HPCF: 4. Identifying affected PDTQ policies + Note right of HPCF: 5. Calculation of new candidate PDTQ policies + HPCF->>NEF: 6. Npcf_PDTQPolicyControl_Notify request + NEF->>AF: 7. Nnef_PDTQPolicyNegotiation_Notify request + AF-->>NEF: 8. Nnef_PDTQPolicyNegotiation_Notify response + HPCF->>NEF: 9. Npcf_PDTQPolicyControl_Notify response + Note right of AF: 10. AF checks candidate PDTQ policies + Note right of HPCF: 11. Steps 9-12 in clause 5.5.13 + + alt Alternative A: AF selected PDTQ policy from candidate list + Note left of UDR: Alternative A: AF selected PDTQ policy from candidate list + HPCF->>UDR: 12a. Nudr_DataRepository_Update request + UDR-->>HPCF: 13a. Nudr_DataRepository_Update response + else Alternative B: AF did not select PDTQ policy from candidate list + Note left of UDR: Alternative B: AF did not select PDTQ policy from candidate list + HPCF->>UDR: 12b. Nudr_DataRepository_Delete request + UDR-->>HPCF: 13b. Nudr_DataRepository_Delete response + end + +``` + +The sequence diagram illustrates the PDTQ warning notification procedure. It begins with the negotiation for the PDTQ procedure (step 0) between the (H-)PCF and the AF via the NEF. The (H-)PCF is then notified by the NWDAF that network or DN performance has degraded (step 1). The (H-)PCF sends a query request to the UDR (step 2), which responds (step 3). The (H-)PCF identifies affected policies (step 4) and calculates new candidate policies (step 5). It then sends a notify request to the NEF (step 6), which forwards it to the AF (step 7). The AF responds (step 8), and the NEF responds to the (H-)PCF (step 9). The AF checks the candidate policies (step 10). The procedure then continues with steps 9-12 from clause 5.5.13 (step 11). Two alternatives are shown: Alternative A, where the AF selects a policy, leading to an update request (12a) and response (13a); and Alternative B, where the AF does not select a policy, leading to a delete request (12b) and response (13b). + +Sequence diagram of the PDTQ warning notification procedure involving UDR, NWDAF, (H-)PCF, NEF, and AF. + +Figure 5.5.14-1: PDTQ warning notification procedure + +0. The negotiation for PDTQ policy as described in clause 5.5.13 is completed. In addition, the PCF has subscribed to "Network Performance Analytics" and/or "DN Performance Analytics" from NWDAF for the area of interest and time window of a PDTQ policy following the procedure and services described in 3GPP TS 29.552 [48]. The AF subscribes to PDTQ warning notification from the (H-)PCF via NEF during Negotiation for PDTQ procedure (see clause 5.5.13). +1. The (H-)PCF is notified when the subscribed "Network Performance Analytics" and/or "DN Performance Analytics" from the NWDAF in the area of interest reaches the Reporting Threshold as described in clause 5.7.5 and clause 5.7.16 of 3GPP TS 29.552 [48] respectively. + +- 2-3. The (H-)PCF may invoke the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request to the "PdtqData" resource, to request from the UDR all stored PDTQ policies. The UDR sends an HTTP "200 OK" response with all the stored PDTQ policies and corresponding related information to the (H-)PCF. + +NOTE 1: If only one PCF is deployed in the network, PDTQ policies might be locally stored in the PCF and the interaction with the UDR is not required. + +4. The (H-)PCF identifies the PDTQ policies that are affected by degradation of the performance. For each affected PDTQ policy the (H-)PCF determines the ASP of which the PDTQ traffic will be influenced by the degradation of performance analytics and which requested the (H-)PCF to send the notification. +5. Based on the operator policies, the (H-)PCF decides for each of the affected PDTQ policies whether a new list of candidate PDTQ policies has to be calculated. + +NOTE 2: If the (H-)PCF does not find any new candidate PDTQ policies, the previously negotiated PDTQ policy is kept and no interaction with the AF occurs, i.e. steps 6 to 13 are not performed. + +6. The (H-)PCF invokes the Npcf\_PDTQPolicyControl\_Notify service operation by sending the HTTP POST request with the PDTQ warning notification to the Notification URI which was received in Npcf\_PDTQPolicyControl\_Create request. + +The PDTQ warning notification includes PDTQ Reference ID and a list of candidate PDTQ policies as described in clause 5.2.2.4.2 of 3GPP TS 29.543 [68]. + +7. Upon the reception of the PDTQ warning notification from the (H-)PCF, the NEF invokes the Nnef\_PDTQPolicyNegotiation\_Notify service operation by sending the HTTP POST request with the PDTQ warning notification to the Notification URI, which was received in Nnef\_PDTQPolicyNegotiation\_Create request. +8. The AF sends an HTTP "204 No Content" response to the NEF. +9. The NEF sends an HTTP "204 No Content" response to the (H-)PCF. +10. When the AF receives the PDTQ warning notification, the AF checks new candidate PDTQ policies. +11. Steps 9-12 from clause 5.5.13 are executed to confirm the selected PDTQ policy. If the AF did not select any of the PDTQ policies, an indication that no PDTQ policy is selected is included in the HTTP PATCH request. +- 12a-13a. If the AF selected one of the PDTQ policies from the candidate list and if the (H-)PCF stored the affected PDTQ policy in the UDR, the (H-)PCF shall invoke the Nudr\_DataRepository\_Update service operation by sending an HTTP PATCH request to the resource "IndividualPdtqData", to update the UDR with the selected candidate PDTQ policy. The UDR sends an HTTP "200 OK" or "204 No Content" response to the (H-)PCF. +- 12b-13b. If the AF did not select one of the PDTQ policies from the candidate list and if the (H-)PCF stored the affected PDTQ policy in the UDR, the (H-)PCF shall invoke the Nudr\_DataRepository\_Delete service operation to remove the affected PDTQ policy from the UDR by sending the HTTP DELETE request to the "IndividualPdtqData" resource. The UDR sends an HTTP "204 No Content" response to the (H-)PCF. + +NOTE 3: Steps 5 to 12a/12b can occur multiple times, i.e. for each affected PDTQ policy. + +**Editor's Note:** Whether the (H-)PCF removes or not the affected PDTQ policy in the UDR when the AF did not select one of the candidate PDTQ policies is subject to the final alignment between TS 23.502 and TS 23.503. + +## 5.6 UE Policy Association Management + +### 5.6.1 UE Policy Association Establishment + +#### 5.6.1.1 General + +The procedures in this clause, which may take place for a UE registered in the same AMF or different AMFs for 3GPP access and non-3GPP access, are performed when the UE initially registers with the network, when the UE registers with 5GS during the UE moving from EPS to 5GS and if there is no existing UE Policy Association, when the new + +AMF establishes the UE Policy Association with the new PCF during AMF relocation, or when interworking between 5GS and EPS if a UE Policy Container is received from the UE via SMF+PGW-C for URSP provisioning in EPS. + +NOTE 1: For details of the Nudr\_DataRepository\_Query/Update/Subscribe service operations refer to 3GPP TS 29.519 [12]. + +NOTE 2: For details of the Npcf\_UEPolicyControl\_Create/Update service operations refer to 3GPP TS 29.525 [31]. + +NOTE 3: For details of the Namf\_Communication\_N1N2MessageTransfer/N1N2MessageSubscribe/N1MessageNotify service operations refer to 3GPP TS 29.518 [32]. + +NOTE 4: For URSP provisioning in EPS the (V-)PCF for a PDU session replaces the AMF in the procedure described in clause 5.6.1.2. + +NOTE 5: For details of the Nchf\_SpendingLimitControl\_Subscribe/Notify service operations refer to 3GPP TS 29.594 [23]. + +#### 5.6.1.2 Non-roaming + +![Sequence diagram of UE Policy Association Establishment procedure - Non-roaming. Lifelines: AMF, PCF, CHF, UDR, BSF. The sequence starts with AMF sending Npcf_UEPolicyControl_Create request to PCF. PCF sends Nudr_DataRepository_Query request to UDR, which responds. PCF then sends Nudr_DataRepository_Subscribe request to UDR, which responds. PCF sends Nchf_SpendingLimitControl_Subscribe request to CHF, which responds. PCF sends a Policy Decision to AMF. AMF sends Npcf_UEPolicyControl_Create response to PCF. PCF sends Nbsf_Management_Register request to BSF, which responds. AMF sends Namf_Communication_N1N2MessageSubscribe request to PCF, which responds. AMF sends Namf_Communication_N1N2MessageTransfer request to PCF, which responds. AMF sends Namf_Communication_N1MessageNotify request to PCF, which responds. PCF sends Nudr_DataRepository_Update request to UDR, which responds.](124c6108c63173818afb8ed49521e22d_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant CHF + participant UDR + participant BSF + + AMF->>PCF: 1. Npcf_UEPolicyControl_Create request + PCF->>UDR: 2. Nudr_DataRepository_Query request + UDR-->>PCF: 3. Nudr_DataRepository_Query response + PCF->>UDR: 4. Nudr_DataRepository_Subscribe request + UDR-->>PCF: 5. Nudr_DataRepository_Subscribe response + PCF->>CHF: 6a. Nchf_SpendingLimitControl_Subscribe request + CHF-->>PCF: 6b. Nchf_SpendingLimitControl_Subscribe response + Note right of PCF: 6. Policy Decision + PCF->>AMF: 7. Npcf_UEPolicyControl_Create response + PCF->>BSF: 8. Nbsf_Management_Register request + BSF-->>PCF: 9. Nbsf_Management_Register response + AMF->>PCF: 10. Namf_Communication_N1N2MessageSubscribe request + PCF-->>AMF: 11. Namf_Communication_N1N2MessageSubscribe + AMF->>PCF: 12. Namf_Communication_N1N2MessageTransfer request + PCF-->>AMF: 13. Namf_Communication_N1N2MessageTransfer response + AMF->>PCF: 14. Namf_Communication_N1MessageNotify request + PCF-->>AMF: 15. Namf_Communication_N1MessageNotify response + PCF->>UDR: 16. Nudr_DataRepository_Update request + UDR-->>PCF: 17. Nudr_DataRepository_Update response + +``` + +Sequence diagram of UE Policy Association Establishment procedure - Non-roaming. Lifelines: AMF, PCF, CHF, UDR, BSF. The sequence starts with AMF sending Npcf\_UEPolicyControl\_Create request to PCF. PCF sends Nudr\_DataRepository\_Query request to UDR, which responds. PCF then sends Nudr\_DataRepository\_Subscribe request to UDR, which responds. PCF sends Nchf\_SpendingLimitControl\_Subscribe request to CHF, which responds. PCF sends a Policy Decision to AMF. AMF sends Npcf\_UEPolicyControl\_Create response to PCF. PCF sends Nbsf\_Management\_Register request to BSF, which responds. AMF sends Namf\_Communication\_N1N2MessageSubscribe request to PCF, which responds. AMF sends Namf\_Communication\_N1N2MessageTransfer request to PCF, which responds. AMF sends Namf\_Communication\_N1MessageNotify request to PCF, which responds. PCF sends Nudr\_DataRepository\_Update request to UDR, which responds. + +**Figure 5.6.1.2-1: UE Policy Association Establishment procedure - Non-roaming** + +- The AMF receives the registration request from the AN. + +Based on local policy, and the authorized capabilities received from the UE (e.g. V2X capabilities and/or A2X capabilities and/or 5G ProSe and/or Ranging/SL capabilities), as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31], the AMF decides to select and contact the PCF to create the UE policy association. The AMF invokes the Npcf\_UEPolicyControl\_Create service operation by sending an HTTP POST request to the "UE Policy Associations" resource as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31]. + +- For URSP provisioning in EPS, if the "EpsUrsp" feature is supported and a UE Policy Container is received from the UE via SMF+PGW-C, the PCF for a PDU session invokes the Npcf\_UEPolicyControl\_Create service operation by sending an HTTP POST request to the "UE Policy Associations" resource as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31]. + - If the "EpsUrsp" feature is supported and the PCF for the PDU session determines that the 5GS to EPS mobility scenario applies as specified in clause 5.2.2.3, then PCF for the PDU session selects the PCF for the UE as described in clause 5.2.2.3, invokes the Npcf\_UEPolicyControl\_Create service operation as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31] and retrieves from the UE policy association previously established in 5GS the available UE policy section(s) and/or triggers as defined in clause 4.2.2.1.1a of 3GPP TS 29.525 [31]. +- 2-3. If the PCF does not have the subscription data or the latest list of UPSIs for the UE, it invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending an HTTP GET request to the "UEPolicySet" resource. The UDR sends an HTTP "200 OK" response to the PCF with the latest UPSIs and its content, and/or the subscription data. + +Additionally, if the "EnhancedBackgroundDataTransfer" feature defined in 3GPP TS 29.504 [27] is supported, the PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "Applied BDT Policy Data" resource to retrieve the applied BDT Policy Data. The UDR sends an HTTP "200 OK" response with the stored applied BDT Policy Data. And then, if the corresponding transfer policy is not locally stored in the PCF, the PCF invokes the Nudr\_DataRepository\_Query service operation by sending the HTTP GET request to the "IndividualBdtData" resource or the "BdtData" collection resource with the URI query parameter "bdt-ref-ids" as specified in 3GPP TS 29.519 [12], to retrieve the related Background Data Transfer policy information (i.e. Time window and Location criteria) stored in the UDR. The UDR sends an HTTP "200 OK" response to the PCF. + +Additionally, if the "AfGuideURSP" feature is supported and URSPs are influenced by the AF, and/or V2XP and/or A2XP if the "A2X" feature is supported, and/or the "ProSe" feature is supported and ProSeP policies and/or RSLPP if the "Ranging\_SL" feature is supported may be delivered to the UE, the PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "Service Parameter Data" resource to retrieve the service parameter data. The UDR sends an HTTP "200 OK" response with the stored service parameter data. + +Additionally, the PCF invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending the HTTP GET request to the "5GVnGroupsInternal" resource to retrieve the group configuration of the received 5G VN Group Id as specified in 3GPP TS 29.505 [47], if not internally available. + +NOTE 1: The PCF can internally store the retrieved 5G VN group configuration data for later use for other SUPIs that belong to the same Internal-Group-Id. + +- 4-5. The PCF may request notifications from the UDR on changes in the policy data subscription information (e.g, UE Policy Set resource), and in this case, the PCF shall invoke the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "PolicyDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, if the "EnhancedBackgroundDataTransfer" feature defined in 3GPP TS 29.504 [27] is supported, to request notifications from the UDR on changes in the applied BDT Policy Data, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "ApplicationDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, if the PCF requests notifications from the UDR on changes in the service parameter data, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "ApplicationDataSubscriptions" resource. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +Additionally, to request notifications from the UDR on changes in the 5G VN group configuration data associated to each of the Internal-Group-Id provided to the PCF, the PCF invokes the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "SubscriptionDataSubscriptions" resource as specified in 3GPP TS 29.505 [47], if not internally available. The UDR sends an HTTP "201 Created" response to acknowledge the subscription. + +6. The PCF determines whether and which UE policy has to be provisioned or updated as defined in clause 4.2.2.2.1 of 3GPP TS 29.525 [31], and may determine applicable Policy Control Request Trigger(s). + +The PCF determines whether and which ANDSP and/or URSP has to be provisioned or updated based on the NF service consumer inputs, the received list of UPSIs from the UE, if available, the UE Policy Sections stored in the UDR, if available, other received UE parameters, if available, the policy subscription and application data retrieved from UDR, if available, analytics information received from NWDAF (applicable to URSP), if available, and local policies as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) and/or 4.2.2.2.3 (for URSP) of 3GPP TS 29.525 [31]. + +If the "V2X" feature is supported, the PCF determines whether the V2XP and the V2X N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.2 and 4.2.2.3 of 3GPP TS 29.525 [31]. + +If the "A2X" feature is supported, the PCF determines whether the A2XP and the A2X N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.4 and 4.2.2.5 of 3GPP TS 29.525 [31]. + +If the "ProSe" feature is supported, the PCF determines whether the ProSeP and the 5G ProSe N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.3 and 4.2.2.4 of 3GPP TS 29.525 [31]. + +If the "Ranging\_SL" feature is supported, the PCF determines whether the RSLPP and the Ranging/SL N2 policy have to be provisioned as defined in clause 4.2.2 of 3GPP TS 29.525 [31]. + +In addition, the PCF checks if the size of determined UE policy exceeds a predefined limit. + +6a-6b If the PCF determines that the policy decision depends on the status of the policy counters available at the CHF, and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report Retrieval as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF determines that the status of additional policy counters is required, the PCF initiates an Intermediate Spending Limit Report Retrieval as defined in clause 5.3.3. + +NOTE 2: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in PCF is related to that limitation. + +- If the size is under the limit then the UE policy information is included in a single Namf\_Communication\_N1N2MessageTransfer service operation and messages 10 to 13 are thus executed one time. + - If the size exceeds the predefined limit, the PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. Each UE policy information fragment will be then sent in separated Namf\_Communication\_N1N2MessageTransfer service operations and messages 10 to 13 are thus executed several times, one time for each UE policy information fragment. +7. The PCF sends an HTTP "201 Created" response to the AMF with the Policy Control Request Trigger(s) if applicable, and potentially further information as defined in 3GPP TS 29.525 [31]. +- For URSP provisioning in EPS, if the PCF decided to provision or update the URSP in step 6, the PCF invokes the Npcf\_UEPolicyControl\_Create response service operation to provision or update the URSP and the PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the PCF as specified in 3GPP TS 29.525 [31]. Steps 8-15 are not applicable for URSP provisioning in EPS. +- 8-9. If the "ProSe" feature is supported for the Npcf\_UEPolicyControl service and/or the "EpsUrsp" feature is supported for the Npcf\_UEPolicyControl service and the UE indicated in step 1 that the UE supports URSP provisioning in EPS, the PCF may register with the BSF as the PCF serving this UE, if not already registered at the AM Policy Association establishment. This is performed by using the Nbsf\_Management\_Register operation, providing as inputs the SUPI, the GPSI, if available, and the PCF end points related to the Npcf\_AMPolicyAuthorization service. +10. To subscribe to notifications of N1 message for UE Policy Delivery Result, or subsequent UE policy requests (e.g. for V2XP and/or A2XP and/or ProSeP and/or RSLPP), the PCF invokes Namf\_Communication\_N1N2MessageSubscribe service operation to the AMF by sending the HTTP POST method with the URI of the "N1N2 Subscriptions Collection for Individual UE Contexts" resource. +11. The AMF sends an HTTP "201 Created" response to the PCF. +12. If the PCF determines to provision or update the UE policy in step 6, the PCF sends the UE policy to the UE via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "V2X" feature is supported and the PCF determines to provision V2XP and V2X N2 PC5 policy in step 6, the PCF sends the V2XP to the UE and the V2X N2 PC5 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "ProSe" feature is supported and the PCF determines to provision ProSeP and 5G ProSe N2 PC5 policy in step 6, the PCF sends the ProSeP to the UE and the 5G ProSe N2 PC5 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "A2X" feature is supported and the PCF determines to provision A2XP and A2X N2 PC5 policy in step 6, the PCF sends the A2XP to the UE and the A2X N2 PC5 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "Ranging\_SL" feature is supported and the PCF determines to provision RSLPP and Ranging/SL N2 policy in step 6, the PCF sends the RSLPP to the UE and the Ranging/SL N2 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +The PCF can provision the UE policy (including V2XP and/or A2XP and/or ProSeP and/or RSLPP) and V2X N2 PC5 policy and/or A2X N2 PC5 policy and/or 5G ProSe N2 PC5 Policy and/or Ranging/SL N2 Policy in the same message. + +13. The AMF sends a response to the Namf\_Communication\_N1N2MessageTransfer service operation. +14. When receiving the UE Policy container, the AMF forwards the response of the UE to the PCF using Namf\_Communication\_N1MessageNotify service operation. +15. The PCF sends a response to the Namf\_Communication\_N1MessageNotify service operation. + +NOTE 3: Steps 7 and 10-15 are triggered by the Npcf\_UEPolicyControl\_Create request and can be received by the AMF in any order; e.g., all or some of the steps 10-15 can be received by the AMF prior to step 7. Note that, to ensure the UE Policy delivery response within the N1MessageNotify is received, the PCF should wait for the reception of a successful N1N2MessageSubscribe response (step 11) before sending the N1N2MessageTransfer request (step 12). + +- 16-17. The PCF maintains the latest list of UE policy sections delivered to the UE (in step 12) and updates the UE policy information for the subscriber including the latest list of UPSIs and its content in the UDR by invoking the Nudr\_DataRepository\_Update service operation. + +- If there is no UE policy information retrieved in step 3, the PCF sends an HTTP PUT request to the "UEPolicySet" resource, and the UDR sends an HTTP "201 Created" response. +- Otherwise, the PCF sends an HTTP PUT/PATCH request to the "UEPolicySet" resource, and the UDR sends an HTTP "200 OK" or "204 No Content" response accordingly. + +If the "EpsUrsp" feature is supported for the Npcf\_UEPolicyControl service and the UE indicated in step 1 that the UE supports URSP provisioning in EPS, the PCF shall update the UDR with the received UE support of URSP provisioning in EPS. + +#### 5.6.1.3 Roaming + +![Sequence diagram illustrating the UE Policy Association Establishment procedure - Roaming. The diagram shows interactions between AMF, V-PCF, V-UDR, H-PCF, H-UDR, and BSF. The process starts with the AMF sending an Npcf_UEPolicyControl_Create request to the V-PCF. The V-PCF then sends a Create request to the H-PCF. The H-PCF interacts with the H-UDR (Query, Subscribe) and the BSF (Register). The H-PCF sends a Policy Decision to the V-PCF. The V-PCF then sends a response to the AMF. The AMF then sends N1N2 messages to the UE (Communication_N1N2MessageSubscribe, Communication_N1N2MessageTransfer, Communication_N1MessageNotify). The V-PCF sends an Update request to the H-PCF, which in turn updates the H-UDR.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant V-PCF + participant V-UDR + participant H-PCF + participant H-UDR + participant BSF + + Note left of AMF: 1. Npcf_UEPolicyControl_Create request + AMF->>V-PCF: 1. Npcf_UEPolicyControl_Create request + Note right of V-PCF: 2. Npcf_UEPolicyControl Create request + V-PCF->>H-PCF: 2. Npcf_UEPolicyControl Create request + Note right of H-PCF: 3. Nudr_DataRepository_Query request + H-PCF->>H-UDR: 3. Nudr_DataRepository_Query request + Note right of H-UDR: 4. Nudr_DataRepository_Query response + H-UDR-->>H-PCF: 4. Nudr_DataRepository_Query response + Note right of H-PCF: 5. Nudr_DataRepository_Subscribe request + H-PCF->>H-UDR: 5. Nudr_DataRepository_Subscribe request + Note right of H-UDR: 6. Nudr_DataRepository_Subscribe response + H-UDR-->>H-PCF: 6. Nudr_DataRepository_Subscribe response + Note right of H-PCF: 7. Policy Decision + H-PCF->>V-PCF: 8. Npcf_UEPolicyControl Create response + Note right of H-PCF: 9. Nbsf_Management_Register request + H-PCF->>BSF: 9. Nbsf_Management_Register request + Note right of BSF: 10. Nbsf_Management_Register response + BSF-->>H-PCF: 10. Nbsf_Management_Register response + Note right of V-PCF: 11. Nudr_DataRepository_Query request + V-PCF->>V-UDR: 11. Nudr_DataRepository_Query request + Note right of V-UDR: 12. Nudr_DataRepository_Query response + V-UDR-->>V-PCF: 12. Nudr_DataRepository_Query response + Note right of V-PCF: 13. Nudr_DataRepository_Subscribe request + V-PCF->>V-UDR: 13. Nudr_DataRepository_Subscribe request + Note right of V-UDR: 14. Nudr_DataRepository_Subscribe response + V-UDR-->>V-PCF: 14. Nudr_DataRepository_Subscribe response + Note right of V-PCF: 15. Policy Decision + V-PCF->>AMF: 16. Npcf_UEPolicyControl_Create response + Note right of AMF: 17. Namf_Communication_N1N2MessageSubscribe request + AMF->>V-PCF: 17. Namf_Communication_N1N2MessageSubscribe request + Note right of V-PCF: 18. Namf_Communication_N1N2MessageSubscribe response + V-PCF-->>AMF: 18. Namf_Communication_N1N2MessageSubscribe response + Note right of AMF: 19. Namf_Communication_N1N2MessageTransfer request + AMF->>V-PCF: 19. Namf_Communication_N1N2MessageTransfer request + Note right of V-PCF: 20. Namf_Communication_N1N2MessageTransfer response + V-PCF-->>AMF: 20. Namf_Communication_N1N2MessageTransfer response + Note right of AMF: 21. Namf_Communication_N1MessageNotify request + AMF->>V-PCF: 21. Namf_Communication_N1MessageNotify request + Note right of V-PCF: 22. Namf_Communication_N1MessageNotify response + V-PCF-->>AMF: 22. Namf_Communication_N1MessageNotify response + Note right of V-PCF: 23. Npcf_UEPolicyControl_Update request + V-PCF->>H-PCF: 23. Npcf_UEPolicyControl_Update request + Note right of H-PCF: 24. Npcf_UEPolicyControl_Update response + H-PCF-->>V-PCF: 24. Npcf_UEPolicyControl_Update response + Note right of H-PCF: 25. Nudr_DataRepository_Update request + H-PCF->>H-UDR: 25. Nudr_DataRepository_Update request + Note right of H-UDR: 26. Nudr_DataRepository_Update response + H-UDR-->>H-PCF: 26. Nudr_DataRepository_Update response + +``` + +Sequence diagram illustrating the UE Policy Association Establishment procedure - Roaming. The diagram shows interactions between AMF, V-PCF, V-UDR, H-PCF, H-UDR, and BSF. The process starts with the AMF sending an Npcf\_UEPolicyControl\_Create request to the V-PCF. The V-PCF then sends a Create request to the H-PCF. The H-PCF interacts with the H-UDR (Query, Subscribe) and the BSF (Register). The H-PCF sends a Policy Decision to the V-PCF. The V-PCF then sends a response to the AMF. The AMF then sends N1N2 messages to the UE (Communication\_N1N2MessageSubscribe, Communication\_N1N2MessageTransfer, Communication\_N1MessageNotify). The V-PCF sends an Update request to the H-PCF, which in turn updates the H-UDR. + +Figure 5.6.1.3-1: UE Policy Association Establishment procedure - Roaming + +- The AMF receives the registration request from the AN. + +Based on local policy, and the capabilities received from the UE (e.g. V2X capabilities and/or A2X capabilities), as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31], the AMF decides to establish UE Policy Association with the V-PCF. The AMF invokes the Npcf\_UEPolicyControl\_Create service operation by sending an HTTP POST request to the "UE Policy Associations" resource as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31]. + +- For URSP provisioning in EPS, if the "EpsUrsp" feature is supported and a UE Policy Container is received from the UE via SMF+PGW-C, the V-PCF for a PDU session invokes the Npcf\_UEPolicyControl\_Create service operation by sending an HTTP POST request to the "UE Policy Associations" resource as defined in clause 4.2.2.1 of 3GPP TS 29.525 [31]. +- The V-PCF invokes the Npcf\_UEPolicyControl\_Create service operation by sending an HTTP POST request to the "UE Policy Associations" resource to forward the information received from AMF to the H-PCF. The request includes the parameters received in step 1. The V-PCF also provides the H-PCF the Notification URI where to send a notification when the policy is updated. + - These steps are the same as steps 2-5 in clause 5.6.1.2, except the description of "EnhancedBackgroundDataTransfer" feature is not applicable. + +7. The H-PCF determines whether and which ANDSP and/or URSP has to be provisioned or updated based on the NF service consumer inputs, the received list of UPSIs from the UE, if available, the UE Policy Sections stored in the UDR, if available, other received UE parameters, if available, the policy subscription and application data retrieved from UDR, if available, analytics information received from NWDAF (applicable to URSP), if available and local policies as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) and/or 4.2.2.2.3 (for URSP) of 3GPP TS 29.525 [31]. + +If the H-PCF does not receive information from the UE (the list of UPSIs and/or other UE parameters, as e.g. the ANDSP support indication) in step 2, and this information is available in the UDR and the H-PCF determines the information in UDR is reliable, the H-PCF uses the UE information retrieved from the UDR in the determination of whether and which ANDSP and/or URSP has to be provisioned. In this case, the UE parameters retrieved from UDR (e.g. the ANDSP support indication) are included in step 8 as described in 3GPP TS 29.525 [31]. + +If the "V2X" feature is supported, the H-PCF determines whether the V2XP and the V2X N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.2 and 4.2.2.3 of 3GPP TS 29.525 [31]. + +If the "ProSe" feature is supported, the H-PCF determines whether the ProSeP and the 5G ProSe N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.3 and 4.2.2.4 of 3GPP TS 29.525 [31]. + +If the "A2X" feature is supported, the H-PCF determines whether the A2XP and the A2X N2 PC5 policy have to be provisioned as defined in clauses 4.2.2.2.1.4 and 4.2.2.5 of 3GPP TS 29.525 [31]. + +If the "Ranging\_SL" feature is supported, the PCF determines whether the RSLPP and the Ranging/SL N2 policy have to be provisioned as defined in clause 4.2.2 of 3GPP TS 29.525 [31]. + +In addition, the H-PCF checks if the size of determined UE policy exceeds a predefined limit. + +NOTE 1: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in H-PCF is related to that limitation. + +If the size is under the limit then the UE policy information is included in Npcf\_UEPolicyControl\_Create response service operation. + +- If the size exceeds the predefined limit, the H-PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. One fragment will be sent in Npcf\_UEPolicyControl\_Create response service operation, and others will be sent by initiating the PCF-initiated UE Policy Association Modification procedure specified in clause 5.6.2.2.3. + +8. The H-PCF sends an HTTP "201 Created" response to the V-PCF with the decided UE policy, Policy Control Request Trigger(s) N2 PC5 policy and UE parameters, if available. + +- 9-10. If the "ProSe" feature is supported for the Npcf\_UEPolicyControl service, the H-PCF may register with the BSF as the PCF serving this UE. This is performed by using the Nbsf\_Management\_Register operation, providing as inputs the SUPI, the GPSI, if available, and the PCF end points related to the Npcf\_AMPolicyAuthorization service. + +11. The V-PCF invokes Nudr\_DataRepository\_Query service operation to the UDR by sending an HTTP GET request to the "PlmnUePolicySet" resource to retrieve the list of UPSIs and its content stored in the V-UDR for the PLMN ID of this UE. Alternatively, the V-PCF can have this information configured locally. + +12. The V-UDR sends an HTTP "200 OK" response to the V-PCF with the UE policy information. + +13. The V-PCF may request notifications from the V-UDR on changes in UE policy information, and in this case, the PCF shall invoke the Nudr\_DataRepository\_Subscribe service operation by sending an HTTP POST request to the "PolicyDataSubscriptions" resource. + +14. The V-UDR sends an HTTP "201 Created" response to acknowledge the subscription from the V-PCF. + +15. The V-PCF determines whether and which UE policy has to be provisioned or updated as defined in clause 4.2.2.2.1 of 3GPP TS 29.525 [31], and may determine applicable Policy Control Request Trigger(s). + +The V-PCF determines whether and which visited ANDSP has to be provisioned based on the NF service consumer inputs, the received list of UPSIs from the UE, if available, the UE Policy Sections locally configured or stored in the UDR for the UE PLMN, other received UE parameters, if available, and local policies as defined in clauses 4.2.2.2.1.1, and 4.2.2.2.2 of 3GPP TS 29.525 [31]. + +If the V-PCF does not receive information from the UE (the list of UPSIs and/or other UE parameters, as e.g. the ANDSP support indication) in step 1, the "UECapabilityIndication" feature is supported, and UE parameters are received from the H-PCF as defined in in step 8, the V-PCF uses the received UE parameters in the determination of whether and which ANDSP has to be provisioned. + +If the "V2X" feature is supported and the V-PCF received the V2XP and the V2X N2 PC5 policy, the V-PCF sends the V2XP to the UE and the V2X N2 PC5 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "ProSe" feature is supported and the V-PCF received the ProSeP and the 5G ProSe N2 PC5 policy, the V-PCF sends the ProSeP to the UE and the 5G ProSe N2 PC5 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +If the "Ranging\_SL" feature is supported and the V-PCF received the RSLPP and Ranging/SL N2 policy, the V-PCF sends the RSLPP to the UE and the Ranging/SL N2 policy to the NG-RAN via the AMF by invoking the Namf\_Communication\_N1N2MessageTransfer service operation. + +The PCF can provision the UE policy (including V2XP and/or A2XP and/or ProSeP and/or RSLPP) and V2X N2 PC5 policy and/or A2X N2 PC5 policy and/or 5G ProSe N2 PC5 Policy and/or Ranging/SL N2 Policy in the same message. + +In addition, the V-PCF checks if the size of determined UE policy exceeds a predefined limit. + +NOTE 2: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in V-PCF is related to that limitation. + +- If the size is under the limit then the UE policy information is included in a single Namf\_Communication\_N1N2MessageTransfer service operation and messages 19 to 24 are thus executed one time. + - If the size exceeds the predefined limit, the V-PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. Each UE policy information fragment will be then sent in separated Namf\_Communication\_N1N2MessageTransfer service operations and messages 19 to 24 are thus executed several times, one time for each UE policy information fragment. +16. The V-PCF sends an HTTP "201 Created" response to the AMF with the Policy Control Request Trigger(s) if available, and potentially further information as defined in 3GPP TS 29.525 [31]. + - For URSP provisioning in EPS, and LBO roaming scenarios, if the V-PCF received the URSP in step 15, the V-PCF invokes the Npcf\_UEPolicyControl\_Create response service operation to provision or update the URSP and the V-PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the V-PCF as specified in 3GPP TS 29.525 [31]. Steps 17-22 are not applicable for URSP provisioning in EPS. + 17. To subscribe to notifications of N1 message for UE Policy Delivery Result, or subsequent UE policy requests (e.g. for V2XP and/or A2XP and/or ProSeP and/or RSLPP), the V-PCF invokes Namf\_Communication\_N1N2MessageSubscribe service operation to the AMF by sending the HTTP POST method with the URI of the "N1N2 Subscriptions Collection for Individual UE Contexts" resource. + 18. The AMF sends an HTTP "201 Created" response to the V-PCF. + 19. The V-PCF invokes the Namf\_Communication\_N1N2MessageTransfer service operation to send the policy decided locally in step 13 and to forward the policy received from the H-PCF in step 8. + 20. The AMF sends a response to the Namf\_Communication\_N1N2MessageTransfer service operation. + 21. When receiving the UE Policy container for the result of the UE policy, the AMF forwards the response of the UE to the V-PCF using Namf\_Communication\_N1MessageNotify service operation. + 22. The V-PCF sends a response to the Namf\_Communication\_N1MessageNotify service operation. + 23. Upon receipt of the UE Policy container belonging to the H-PLMN in step 21, the V-PCF invokes the Npcf\_UEPolicyControl\_Update service operation by sending an HTTP POST request to the "Individual UE Policy Association" resource to forward the response of the UE to the H-PCF. + +- For URSP provisioning in EPS, and LBO roaming scenarios, the UE Policy container belonging to the H-PLMN is received from the V-PCF for the PDU session using the Npcf\_UEPolicyControl\_Update request service operation. + +24. The H-PCF sends an HTTP "200 OK" response to the V-PCF. + +NOTE 3: Steps 16-24 are triggered by the Npcf\_UEPolicyControl\_Create request and can be received by the AMF in any order, e.g., all or some of the steps 17-24 can be received by the AMF prior to step 16. Note that, to ensure the UE Policy delivery response within the N1MessageNotify is received, the PCF should wait for the reception of a successful N1N2MessageSubscribe response (step 18) before sending the N1N2MessageTransfer request (step 19). + +25-26. The H-PCF maintains the latest list of UE policy information delivered to the UE and updates UE policy including the latest list of UPSIs and its content in the H-UDR by invoking the Nudr\_DataRepository\_Update service operation. + +- If there is no UE policy information retrieved in step 4, the H-PCF sends an HTTP PUT request to the "UEPolicySet" resource, and the UDR sends an HTTP "201 Created" response. +- Otherwise, the H-PCF sends an HTTP PUT/PATCH request to the "UEPolicySet" resource, and the H-UDR sends an HTTP "200 OK" or "204 No Content" response accordingly. + +### 5.6.2 UE Policy Association Modification + +#### 5.6.2.1 UE Policy Association Modification initiated by the AMF + +##### 5.6.2.1.1 General + +The procedures in this clause are performed when a Policy Control Request Trigger condition is met or when the new AMF reuses the UE Policy Association established by the old AMF with the PCF during AMF relocation. + +NOTE 1: For details of the Nudr\_DataRepository\_Update service operation refer to 3GPP TS 29.519 [12]. + +NOTE 2: For details of the Npcf\_UEPolicyControl\_Update/UpdateNotify service operations refer to 3GPP TS 29.525 [31]. + +NOTE 3: For details of the Namf\_Communication\_N1N2MessageTransfer/N1MessageNotify service operations refer to 3GPP TS 29.518 [32]. + +NOTE 4: When the UE Policy Association is for URSP provisioning in EPS the (V-)PCF for a PDU session replaces the AMF in the procedure described in clause 5.6.2.1.2. + +##### 5.6.2.1.2 Non-roaming + +![Sequence diagram for AMF-initiated UE Policy Association Modification procedure – Non-roaming](58f4167687de8d7339594e5f6fbe0bc6_img.jpg) + +``` +sequenceDiagram + participant AMF + participant PCF + participant UDR + Note right of PCF: 2. Policy Decision + Note right of AMF: 4. Perform step 12-15 as specified in Figure 5.6.1.2-1 + + AMF->>PCF: 1. Npcf_UEPolicyControl_Update request + PCF-->>AMF: 3. Npcf_UEPolicyControl_Update response + Note right of AMF: 4. Perform step 12-15 as specified in Figure 5.6.1.2-1 + Note right of PCF: 2. Policy Decision + Note right of PCF: 5. Nudr_DataRepository_Update request + PCF-->>UDR: 5. Nudr_DataRepository_Update request + UDR-->>PCF: 6. Nudr_DataRepository_Update response +``` + +The sequence diagram illustrates the AMF-initiated UE Policy Association Modification procedure in a non-roaming scenario. It involves three main participants: AMF, PCF, and UDR. The process begins with the AMF sending an 'Npcf\_UEPolicyControl\_Update request' to the PCF. The PCF responds with a 'Npcf\_UEPolicyControl\_Update response'. A dashed box labeled '4. Perform step 12-15 as specified in Figure 5.6.1.2-1' is shown between the AMF and PCF. A 'Policy Decision' box is shown on the PCF lifeline. Following this, the PCF sends a 'Nudr\_DataRepository\_Update request' to the UDR, which responds with a 'Nudr\_DataRepository\_Update response'. + +Sequence diagram for AMF-initiated UE Policy Association Modification procedure – Non-roaming + +**Figure 5.6.2.1.2-1: AMF-initiated UE Policy Association Modification procedure – Non-roaming** + +1. When the AMF detects a Policy Control Request Trigger condition is met or the old AMF transfers to the new AMF the UE Policy Association information, it invokes the Npcf\_UEPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource with information on the conditions that have changed. + +NOTE 1: The old AMF transfers to the new AMF the UE Policy Association when the old AMF and the new AMF belong to the same PLMN or equivalent PLMN or belong to the same SNPN or equivalent SNPN. + +During AMF relocation, when the new AMF decides to reuse the UE Policy Association established by the old AMF with the PCF: + +- a. If the feature "FeatureRenegotiation" is supported, the new AMF invokes the Npcf\_UEPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource, and includes the supported features, the feature(s) related information, if applicable and other information on the conditions that have changed as described in clause 4.2.3.4 of 3GPP TS 29.525 [31]. + - b. If the feature "FeatureRenegotiation" is not supported, the new AMF invokes the Npcf\_UEPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource with information on the conditions that have changed. +2. The PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s). When the feature "FeatureRenegotiation" is supported, and the PCF received the features supported by the AMF, the PCF re-evaluates the negotiated features and makes the policy decision considering the resulting negotiated features and the information provided by the new AMF. + +The policy decision contains the applicable Policy Control Request Trigger(s) and/or updated UE Policy and/or updated V2X N2 PC5 policy, if the "V2X" feature is supported, and/or A2X N2 PC5 policy, if the "A2X" feature is supported, and/or updated ProSeP, if the "ProSe" feature is supported, within the updated UE Policy and/or 5G ProSe N2 PC5 policy, and/or updated RSLPP within the updated UE Policy and/or Ranging/SL N2 policy if the "Ranging\_SL" feature is supported. The PCF checks if the size of determined UE policy exceeds a predefined limit the same as step 6 in clause 5.6.1.2. + +The PCF determines whether and which ANDSP and/or URSP has to be provisioned or updated based on the NF service consumer inputs, policy subscription and application data, if available, the UE Policy Sections previously delivered to the UE, if available, other UE parameters previously received from the UE, if available, the reported information by the AMF and local policies, as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) and/or 4.2.2.2.3 (for URSP) of 3GPP TS 29.525 [31]. + +3. The PCF sends an HTTP "200 OK" response to the AMF with: + - a. When the feature "FeatureRenegotiation" is not supported, the applicable updated Policy Control Request Trigger(s), and potentially further information as defined in 3GPP TS 29.525 [31]. + - b. When the feature "FeatureRenegotiation" is supported, the complete "Individual UE Policy Association" resource representation together with the negotiated supported features as described in clause 4.2.3.4 of 3GPP TS 29.525 [31]. + - For URSP provisioning in EPS, if the PCF decided to update the URSP in step 2, the PCF invokes the Npcf\_UEPolicyControl\_Update response service operation to update the URSP and the PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the PCF as specified in 3GPP TS 29.525 [31]. Step 4 is not applicable for URSP provisioning in EPS. +4. If the PCF decided to update the UE policy, and/or N2 PC5 policy and/or 5G ProSe N2 PC5 policy and/or Ranging/SL N2 policy in step 2, steps 12-15 as specified in Figure 5.6.1.2-1 are executed. + +NOTE 2: The messages of step 4 are triggered by the Npcf\_UEPolicyControl\_Update request and some or all of them can be received by the AMF before step 3. + +- 5-6. If the PCF decided to update the UE policy in step 2, the PCF maintains the latest list of UE policy information delivered to the UE and updates UE policy including the latest list of UPSIs and its content in the UDR by invoking the Nudr\_DataRepository\_Update service operation. The PCF sends an HTTP PUT/PATCH request to the "UEPolicySet" resource, and the UDR sends an HTTP "204 No Content" response. + +##### 5.6.2.1.3 Roaming + +![Sequence diagram for AMF-initiated UE Policy Association Modification procedure - Roaming. The diagram shows interactions between AMF, V-PCF, H-PCF, and H-UDR. Steps 1-6 involve Npcf_UEPolicyControl_Update requests and responses. Step 7 is a dashed box indicating a reference to another figure. Steps 8-9 involve Nudr_DataRepository_Update requests and responses.](164d1b48231be457522b31965610ea3b_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant V-PCF + participant H-PCF + participant H-UDR + + Note right of H-PCF: 3. Policy Decision + Note right of V-PCF: 5. Policy Decision + + AMF->>V-PCF: 1. Npcf_UEPolicyControl_Update request + V-PCF->>H-PCF: 2. Npcf_UEPolicyControl_Update request + H-PCF-->>V-PCF: 4. Npcf_UEPolicyControl_Update response + V-PCF-->>AMF: 6. Npcf_UEPolicyControl_Update response + Note right of AMF: 7. Perform step 19-24 as specified in Figure 5.6.1.3-1 + Note right of H-PCF: 8. Nudr_DataRepository_Update request + H-UDR-->>H-PCF: 9. Nudr_DataRepository_Update response + +``` + +Sequence diagram for AMF-initiated UE Policy Association Modification procedure - Roaming. The diagram shows interactions between AMF, V-PCF, H-PCF, and H-UDR. Steps 1-6 involve Npcf\_UEPolicyControl\_Update requests and responses. Step 7 is a dashed box indicating a reference to another figure. Steps 8-9 involve Nudr\_DataRepository\_Update requests and responses. + +**Figure 5.6.2.1.3-1: AMF-initiated UE Policy Association Modification procedure - Roaming** + +1. When the AMF detects a Policy Control Request Trigger condition is met the old AMF transfers to the new AMF the UE Policy Association information, it invokes the Npcf\_UEPolicyControl\_Update service operation to the V-PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource with information on the conditions that have changed. + +NOTE 1: The old AMF transfers to the new AMF the UE Policy Association when the old AMF and the new AMF belong to the same PLMN or equivalent PLMN or belong to the same SNPN or equivalent SNPN. + +During AMF relocation, when the new AMF decides to reuse the UE Policy Association established by the old AMF with the V-PCF: + +- a. If the feature "FeatureRenegotiation" is supported, the AMF invokes the Npcf\_UEPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource, and includes the supported features, the feature(s) related information elements, if applicable and other information on the conditions that have changed as described in clause 4.2.3.4 of 3GPP TS 29.525 [31]. + - b. If the feature "FeatureRenegotiation" is not supported, the new AMF invokes the Npcf\_UEPolicyControl\_Update service operation to the PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource with information on the conditions that have changed. +2. The V-PCF forwards the information received from AMF in step 1 to the H-PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource if the H-PCF has subscribed the notification. + +If the V-PCF received a Namf\_Communication\_N1MessageNotify service request with a UE Policy container and/or the V-PCF is made aware of the delivery outcome of previously provided UE Policy, the V-PCF forwards the received information to the H-PCF by sending an HTTP POST request to the "Individual UE Policy Association" resource. + +NOTE 2: The V-PCF is aware of the delivery outcome either based on the response with the result of UE policy delivery from the UE or based on the AMF knowledge that the UE is temporarily unavailable. + +3. The H-PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy, and/or updated V2XP within the updated UE Policy and/or V2X N2 PC5 policy if the "V2X" feature is supported, and/or updated A2XP within the updated UE Policy and/or A2X N2 PC5 policy if + +the "A2X" feature is supported, and/or updated ProSeP, if the "ProSe" feature is supported, within the updated UE Policy and/or 5G ProSe N2 PC5 policy, and/or updated RSLPP within the updated UE Policy and/or Ranging/SL N2 policy if the "Ranging\_SL" feature is supported. + +If the H-PCF received the response of the UE Policy delivery outcome from the V-PCF and the AF subscribed to notifications about the outcome of UE Policies delivery, steps 7-10 of clause 5.5.8 are executed. + +The H-PCF determines whether and which ANDSP and/or URSP has to be provisioned or updated based on NF service consumer inputs, policy subscription and application data, if available, the UE Policy Sections previously delivered to the UE, if available, other UE parameters previously received from the UE, if available, the reported information by the V-PCF and local policies, as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) and/or 4.2.2.2.3 (for URSP) of 3GPP TS 29.525 [31]. + +In addition, the H-PCF checks if the size of determined UE policy exceeds a predefined limit. + +NOTE 3: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in H-PCF is related to that limitation. + +- If the size is under the limit then the UE policy information is included in Npcf\_UEPolicyControl\_Update response service operation. + - If the size exceeds the predefined limit, the H-PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. One fragment will be sent in Npcf\_UEPolicyControl\_Update response service operation, and others will be then sent by initiating the PCF-initiated UE Policy Association Modification procedure specified in clause 5.6.2.2.3. +4. The H-PCF sends an HTTP "200 OK" response to the V-PCF with the updated policy information decided in step 3. + 5. The V-PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy, if applicable. The V-PCF checks if the size of determined UE policy exceeds a predefined limit the same as step 13 in clause 5.6.1.3. + +The V-PCF determines whether VPLMN ANDSP has to be provisioned or updated based on NF service consumer inputs, policy subscription for the UE PLMN, other UE parameters previously received from the UE, if available, and local policies, as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) of 3GPP TS 29.525 [31]. + +6. The V-PCF sends an HTTP "200 OK" response to the AMF with the applicable updated Policy Control Request Trigger(s), and potentially further information as defined in 3GPP TS 29.525 [31]. +- For URSP provisioning in EPS, and LBO roaming scenarios, if the V-PCF received the URSP in step 4, the V-PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify request service operation to update the URSP and the V-PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the V-PCF as specified in 3GPP TS 29.525 [31]. +7. If the V-PCF decided to update the UE policy in step 5 or the V-PCF received the UE Policy, V2X N2 PC5 policy and/or A2X N2 PC5 policy and/or 5G ProSe N2 PC5 policy and/or Ranging/SL N2 policy in step 4, steps 19-24 as specified in Figure 5.6.1.3-1 are executed. +- For URSP provisioning in EPS, steps 19-22 as specified in Figure 5.6.1.3-1 are not applicable. + +NOTE 4: The messages of step 7 are triggered by the Npcf\_UEPolicyControl\_Update request and some or all of them can be received by the AMF before step 6. + +- 8-9. If the H-PCF decided to update the UE policy in step 3, the H-PCF maintains the latest list of UE policy information delivered to the UE and updates UE policy including the latest list of UPSIs and its content in the H-UDR by invoking the Nudr\_DataRepository\_Update service operation. The PCF sends an HTTP PUT/PATCH request to the "UEPolicySet" resource, and the UDR sends an HTTP "204 No Content" response. + +#### 5.6.2.2 UE Policy Association Modification initiated by the PCF + +##### 5.6.2.2.1 General + +The procedures in this clause are performed when the UE policy (roaming case) and/or Policy Control Request Trigger(s) are changed, and/or for notifying the AMF about a successful delivery of ANDSP/WLANSP to the UE. + +NOTE 1: For details of the Nudr\_DataRepository\_Update service operation refer to 3GPP TS 29.519 [12]. + +NOTE 2: For details of the Npcf\_UEPolicyControl\_UpdateNotify service operation refer to 3GPP TS 29.525 [31]. + +NOTE 3: For details of the Namf\_Communication\_N1N2MessageTransfer/N1MessageNotify service operations refer to 3GPP TS 29.518 [32]. + +NOTE 4: When the UE Policy Association is for URSP provisioning in EPS the (V-)PCF for a PDU session replaces the AMF in the procedure described in clause 5.6.2.2.2. + +NOTE 5: For details of the Nchf\_SpendingLimitControl\_Subscribe/Notify service operations refer to 3GPP TS 29.594 [23]. + +##### 5.6.2.2.2 Non-roaming + +![Sequence diagrams for PCF-initiated UE Policy Association Modification procedure – Non-roaming. The first diagram shows interactions between AMF, PCF, and UDR. The second diagram shows interactions between AMF, PCF, CHF, and UDR.](53f1f7d17b3e7aae62169c41d2a88a77_img.jpg) + +The diagram illustrates two sequence diagrams for the PCF-initiated UE Policy Association Modification procedure in a non-roaming scenario. + +**Sequence Diagram 1 (Top):** This diagram shows the interaction between the AMF, PCF, and UDR. The sequence of messages is as follows: + +- The PCF sends a **1. Trigger** message to itself. +- The PCF sends a **2. Nudr\_DataRepository\_Query request** to the UDR. +- The UDR responds with **3. Nudr\_DataRepository\_Query response** to the PCF. +- The PCF performs a **4. Policy Decision**. +- The PCF sends a **5. Npcf\_UEPolicyControl\_UpdateNotify request** to the AMF. +- The AMF responds with **6. Npcf\_UEPolicyControl\_UpdateNotify response** to the PCF. +- A dashed box indicates that the PCF will **7. Perform step 12-15 as specified in Figure 5.6.1.2-1**. +- Following this, the PCF sends a **8. Nudr\_DataRepository\_Update request** to the UDR. +- The UDR responds with **9. Nudr\_DataRepository\_Update response** to the PCF. + +**Sequence Diagram 2 (Bottom):** This diagram shows the interaction between the AMF, PCF, CHF, and UDR. The sequence of messages is as follows: + +- The PCF sends a **1. Trigger** message to itself. +- The PCF sends a **2. Nudr\_DataRepository\_Query request** to the UDR. +- The UDR responds with **3. Nudr\_DataRepository\_Query response** to the PCF. +- The PCF sends a **4a. Nchf\_SpendingLimitControl\_Subscribe/Unsubscribe request** to the CHF. +- The CHF responds with **4b. Nchf\_SpendingLimitControl\_Subscribe/Unsubscribe response** to the PCF. +- The PCF performs a **4. Policy Decision**. +- The PCF sends a **5. Npcf\_UEPolicyControl\_UpdateNotify request** to the AMF. +- The AMF responds with **6. Npcf\_UEPolicyControl\_UpdateNotify response** to the PCF. +- A dashed box indicates that the PCF will **7. Perform step 12-15 as specified in Figure 5.6.1.2-1**. +- Following this, the PCF sends a **8. Nudr\_DataRepository\_Update request** to the UDR. +- The UDR responds with **9. Nudr\_DataRepository\_Update response** to the PCF. + +Sequence diagrams for PCF-initiated UE Policy Association Modification procedure – Non-roaming. The first diagram shows interactions between AMF, PCF, and UDR. The second diagram shows interactions between AMF, PCF, CHF, and UDR. + +Figure 5.6.2.2.2-1: PCF-initiated UE Policy Association Modification procedure – Non-roaming + +1. The PCF receives an external trigger (e.g. the subscriber policy data of a UE is changed, the applied BDT Policy Data is changed, or subscription data for the 5G VN group data is changed, or application detection), or the PCF receives an internal trigger (e.g. operator policy is changed, or a pending policy counter becomes active) to re-evaluate UE policy decision for a UE. + +NOTE 1: When the external trigger affects more than one UE (e.g. when Network Performance is degraded in a network area info) the PCF will apply the next steps to all the affected active UE Policy Associations. + +- 2-3. If the applied BDT policy Data is changed in step 1, and if the corresponding transfer policy is not locally stored in the PCF, the PCF sends the HTTP GET request to the "IndividualBdtData" resource to retrieve the related Background Data Transfer policy information (i.e. Time window and Location criteria) stored in the UDR. The UDR sends an HTTP "200 OK" response to the PCF. +4. The PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy and/or updated V2X N2 PC5 policy, if the "V2X" feature is supported, and/or updated A2X N2 PC5 policy, if the "A2X" feature is supported and/or updated 5G ProSe N2 PC5 policy, if the "ProSe" feature is supported, and/or updated RSLPP within the updated UE Policy and/or Ranging/SL N2 policy if the "Ranging\_SL" feature is supported. The PCF checks if the size of determined UE policy exceeds a predefined limit the same as step 6 in clause 5.6.1.2. +- 4a. In non-roaming case, if the PCF determines that the policy decision depends on the status of the policy counters available at the CHF and such reporting is not established for the subscriber, the PCF initiates an Initial Spending Limit Report as defined in clause 5.3.2. If policy counter status reporting is already established for the subscriber, and the PCF decides to modify the list of subscribed policy counters, the PCF sends an Intermediate Spending Limit Report as defined in clause 5.3.3. If the PCF decides to unsubscribe any future status notification of policy counters, it sends a Final Spending Limit Report Request to cancel the request for reporting the change of the status of the policy counters available at the CHF as defined in clause 5.3.4. +5. If the PCF decided to update the Policy Control Request Trigger(s) in step 4 or it needs to report the successful delivery of ANDSP/WLANSP to the AMF, the V-PCF shall invoke the Npcf\_UEPolicyControl\_UpdateNotify service operation by sending an HTTP POST request to the callback URI "{notificationUri}/update". +- For URSP provisioning in EPS, if the PCF decided to update the URSP in step 4, the PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify request service operation to update the URSP and the PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the PCF as specified in 3GPP TS 29.525 [31]. Step 7 is not applicable for URSP provisioning in EPS. +6. The AMF sends an HTTP "204 No Content" response to the PCF. +7. If the PCF decided to update the UE policy, V2X N2 PC5 policy and/or A2X N2 PC5 policy and/or 5G ProSe N2 PC5 policy and/or Ranging/SL N2 policy in step 4, steps 12-15 as specified in Figure 5.6.1.2-1 are executed. +- 8-9. If the PCF decided to update the UE policy in step 4, steps 5-6 in clause 5.6.2.1.2 are executed. + +NOTE 2: When the trigger to update the UE policy is AF-based service parameter provisioning as described in clause 5.5.8, the AF requested to be notified of the outcome of the UE Policy delivery and the PCF initiated step 7 based on the AF request, then steps 7 - 10 specified in clause 5.5.8 are executed. + +##### 5.6.2.2.3 Roaming + +![Sequence diagram for PCF-initiated UE Policy Association Modification procedure – Roaming. The diagram shows interactions between AMF, V-PCF, H-PCF, and H-UDR. It is divided into two main scenarios: one where the H-PCF receives a trigger (steps 1-4) and another where the V-PCF receives a trigger (steps 5-8). Both scenarios lead to a common step (9) and then to interactions with the H-UDR (steps 10-11).](49ee89a1d5852ab005dbbab6de09a8a6_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant V-PCF + participant H-PCF + participant H-UDR + + Note right of H-PCF: 1. Trigger + Note right of H-PCF: 2. Policy Decision + H-PCF->>V-PCF: 3. Npcf_UEPolicyControl_UpdateNotify request + V-PCF-->>H-PCF: 4. Npcf_UEPolicyControl_UpdateNotify response + + Note right of V-PCF: 5. Trigger + Note right of V-PCF: 6. Policy Decision + V-PCF-->>AMF: 7. Npcf_UEPolicyControl_UpdateNotify request + AMF-->>V-PCF: 8. Npcf_UEPolicyControl_UpdateNotify response + + Note over AMF, V-PCF, H-PCF: 9. Perform step 19-24 as specified in Figure 5.6.1.3-1 + + Note right of H-PCF: 10. Nudr_DataRepository_Update request + H-UDR-->>H-PCF: 11. Nudr_DataRepository_Update response + +``` + +Sequence diagram for PCF-initiated UE Policy Association Modification procedure – Roaming. The diagram shows interactions between AMF, V-PCF, H-PCF, and H-UDR. It is divided into two main scenarios: one where the H-PCF receives a trigger (steps 1-4) and another where the V-PCF receives a trigger (steps 5-8). Both scenarios lead to a common step (9) and then to interactions with the H-UDR (steps 10-11). + +**Figure 5.6.2.2.3-1: PCF-initiated UE Policy Association Modification procedure – Roaming** + +If the H-PCF receives a trigger, steps 1 to 4 and 10 to 11 are executed and steps 5 to 8 are omitted. + +If the V-PCF receives a trigger, steps 1 to 4 and 10 to 11 are omitted and steps 5 to 8 are executed. + +1. The H-PCF receives an external trigger, e.g. the subscriber policy data of a UE is changed, or the PCF receives an internal trigger, e.g. operator policy is changed, to re-evaluate UE policy decision for a UE. +2. The H-PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy and/or updated V2X N2 PC5 policy, if the "V2X" feature is supported, and/or updated A2X N2 PC5 policy, if the "A2X" feature is supported and/or updated 5G ProSe N2 PC5 policy, if the "ProSe" feature is supported, and/or updated RSLPP within the updated UE Policy and/or Ranging/SL N2 policy if the "Ranging\_SL" feature is supported. + +The H-PCF determines whether and which ANDSP and/or URSP has to be provisioned or updated based on policy subscription and application data, if available, the UE Policy Sections previously delivered to the UE, if available, other UE parameters previously received from the UE, if available, and local policies, as defined in clauses 4.2.2.2.1.1, 4.2.2.2.2 (for ANDSP) and/or 4.2.2.2.3 (for URSP) of 3GPP TS 29.525 [31]. + +In addition, the H-PCF checks if the size of determined UE policy exceeds a predefined limit. + +NOTE 1: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in H-PCF is related to that limitation. + +- If the size is under the limit then the UE policy information is included in a single Npcf\_UEPolicyControl\_UpdateNotify service operation and messages 3 to 4 are thus executed one time. + +- If the size exceeds the predefined limit, the PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. Each UE policy information fragment will be then sent in separated Npcf\_UEPolicyControl\_UpdateNotify service operations and messages 3 to 4, and 9 are thus executed several times, one time for each UE policy information fragment. +3. The H-PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify service operation by sending an HTTP POST request to the callback URI "{notificationUri}/update" with the updated UE policy and/or the updated V2X N2 PC5 policy and/or the updated A2X N2 PC5 policy, and/or the updated 5G ProSe N2 PC5 policy and/or Ranging/SL N2 policy and/or Policy Control Request Trigger(s) if applicable. + 4. The V-PCF sends an HTTP "204 No Content" response to the H-PCF. + 5. The V-PCF receives an external trigger, e.g. operator policy in the V-UDR for the PLMN ID of this UE is changed, or the V-PCF receives an internal trigger, e.g. local policy is changed, to re-evaluate UE policy decision for a UE. + +NOTE 2: When the V-PCF receives an internal or external trigger to re-evaluate the UE policy decision for the roaming UEs of a PLMN ID, the PCF applies control mechanisms to avoid signalling storms and potential network overload, as e.g. limiting the number of simultaneous updates distributing the base of visiting UEs in a time dispersion interval. + +6. The V-PCF makes the policy decision including the applicable updated Policy Control Request Trigger(s) and/or updated UE Policy. + +In addition, the V-PCF checks if the size of determined UE policy and received UE policy from H-PCF in step 3 exceeds a predefined limit. + +NOTE 3: NAS messages from AMF to UE do not exceed the maximum size limit allowed in NG-RAN (PDCP layer), so the predefined size limit in V-PCF is related to that limitation. + +- If the size is under the limit then the UE policy information is included in a single Namf\_Communication\_N1N2MessageTransfer service operation and message 9 is thus executed one time. + - If the size exceeds the predefined limit, the V-PCF splits the UE policy information in smaller logical independent UE policy information fragments and ensures the size of each is under the predefined limit. Each UE policy information fragment will be then sent in separated Namf\_Communication\_N1N2MessageTransfer service operations and message 9 is thus executed several times, one time for each UE policy information fragment. +7. If the V-PCF needs to update the Policy Control Request Trigger(s), forward the Policy Control Request Trigger(s) received from the H-PCF in step 3, or report the successful delivery of ANDSP/WLANSP to the AMF, the V-PCF shall invoke the Npcf\_UEPolicyControl\_UpdateNotify service operation by sending an HTTP POST request to the callback URI "{notificationUri}/update". + - For URSP provisioning in EPS, and LBO roaming scenarios, if the V-PCF received the URSP in step 3, the V-PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify request service operation to update the URSP and the PCF for the PDU session invokes the Npcf\_UEPolicyControl\_Update request service operation to forward the response of the UE to the V-PCF as specified in 3GPP TS 29.525 [31]. + 8. The AMF sends an HTTP "204 No Content" response to the PCF. + 9. If the V-PCF decided to update the UE policy in step 6 or the V-PCF received the UE Policy and/or V2X N2 PC5 policy, if the "V2X" feature is supported, and/or A2X N2 PC5 policy, if the "A2X" feature is supported, and/or 5G ProSe N2 PC5 policy, if the "ProSe" feature is supported, and/or Ranging/SL N2 policy if the "Ranging\_SL" feature is supported, in step 3, steps 19-24 as specified in Figure 5.6.1.3-1 are executed. + - For URSP provisioning in EPS, steps 19-22 as specified in Figure 5.6.1.3-1 are not applicable. +- 10-11. If the H-PCF decided to update the UE policy in step 2, the steps 8-9 in clause 5.6.2.1.3 are executed. + +### 5.6.3 UE Policy Association Termination + +#### 5.6.3.1 UE Policy Association Termination initiated by the AMF + +##### 5.6.3.1.1 General + +This procedure is performed when the UE deregisters from the network and the UE is only registered in that access type, when the UE deregisters from 5GS during the UE moving from 5GS to EPS and the UE is only connected or registered in 3GPP access (i.e., if the UE is not connected to the 5GC over a non-3GPP access in the same PLMN) or when the old AMF removes the UE Policy Association during AMF relocation. When the UE Policy Association is for URSP provisioning in EPS, and the "EpsUrsp" feature is supported for the Npcf\_SMPolicyControl service, this procedure is also triggered when the PCF for the PDU session determines EPS to 5GS mobility applies based on the indication of RAT type and/or Access type change received from the SMF+PGW-C, or when the PCF for the PDU session receives the last SM policy association termination from the SMF+PGW-C. + +NOTE 1: The old AMF removes the UE Policy Association during AMF relocation when the old AMF decides that the the PCF instance Id is not sent to the new AMF (e.g. inter-AMF mobility with PLMN change, where the new PLMN is not an equivalent PLMN), or when the new AMF indicates to the old AMF that the received UE Policy Association will not be reused. + +NOTE 2: For details of the Nudr\_DataRepository\_Unsubscribe service operation refer to 3GPP TS 29.519 [12]. + +NOTE 3: For details of the Npcf\_UEPolicyControl\_Delete service operation refer to 3GPP TS 29.525 [31]. + +NOTE 4: For details of the Namf\_Communication\_N1N2MessageUnsubscribe service operation refer to 3GPP TS 29.518 [32]. + +NOTE 5: When the UE Policy Association is for URSP provisioning in EPS the (V-)PCF for a PDU session replaces the AMF in the procedure described in clause 5.6.3.1.2. + +NOTE 6: For details of the Nchf\_SpendingLimitControl\_Unsubscribe service operations refer to 3GPP TS 29.594 [23]. + +##### 5.6.3.1.2 Non-roaming + +![Sequence diagram showing the AMF-initiated UE Policy Association Termination procedure – Non-roaming. The diagram involves five lifelines: AMF, PCF, CHF, UDR, and BSF. The sequence of messages is: 1. AMF to PCF: Npcf_UEPolicyControl_Delete request; 2. PCF to AMF: Npcf_UEPolicyControl_Delete response; 3. PCF to BSF: Nbsf_Management_Deregister request; 4. BSF to PCF: Nbsf_Management_Deregister response; 5. PCF to AMF: Namf_Communication_N1N2MessageUnsubscribe request; 6. AMF to PCF: Namf_Communication_N1N2MessageUnsubscribe response; 7. PCF to CHF: Nchf_SpendingLimitControl_Unsubscribe request; 8. CHF to PCF: Nchf_SpendingLimitControl_Unsubscribe response; 9. PCF to UDR: Nudr_DataRepository_Unsubscribe request; 10. UDR to PCF: Nudr_DataRepository_Unsubscribe response.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF + participant CHF + participant UDR + participant BSF + Note left of AMF: 1. Npcf_UEPolicyControl_Delete request + AMF->>PCF: 1. Npcf_UEPolicyControl_Delete request + Note right of PCF: 2. Npcf_UEPolicyControl_Delete response + PCF-->>AMF: 2. Npcf_UEPolicyControl_Delete response + Note right of PCF: 3. Nbsf_Management_Deregister request + PCF-->>BSF: 3. Nbsf_Management_Deregister request + Note right of BSF: 4. Nbsf_Management_Deregister response + BSF-->>PCF: 4. Nbsf_Management_Deregister response + Note right of PCF: 5. Namf_Communication_N1N2MessageUnsubscribe request + PCF-->>AMF: 5. Namf_Communication_N1N2MessageUnsubscribe request + Note left of AMF: 6. Namf_Communication_N1N2MessageUnsubscribe response + AMF-->>PCF: 6. Namf_Communication_N1N2MessageUnsubscribe response + Note right of PCF: 7. Nchf_SpendingLimitControl_Unsubscribe request + PCF-->>CHF: 7. Nchf_SpendingLimitControl_Unsubscribe request + Note right of CHF: 8. Nchf_SpendingLimitControl_Unsubscribe response + CHF-->>PCF: 8. Nchf_SpendingLimitControl_Unsubscribe response + Note right of PCF: 9. Nudr_DataRepository_Unsubscribe request + PCF-->>UDR: 9. Nudr_DataRepository_Unsubscribe request + Note right of UDR: 10. Nudr_DataRepository_Unsubscribe response + UDR-->>PCF: 10. Nudr_DataRepository_Unsubscribe response + +``` + +Sequence diagram showing the AMF-initiated UE Policy Association Termination procedure – Non-roaming. The diagram involves five lifelines: AMF, PCF, CHF, UDR, and BSF. The sequence of messages is: 1. AMF to PCF: Npcf\_UEPolicyControl\_Delete request; 2. PCF to AMF: Npcf\_UEPolicyControl\_Delete response; 3. PCF to BSF: Nbsf\_Management\_Deregister request; 4. BSF to PCF: Nbsf\_Management\_Deregister response; 5. PCF to AMF: Namf\_Communication\_N1N2MessageUnsubscribe request; 6. AMF to PCF: Namf\_Communication\_N1N2MessageUnsubscribe response; 7. PCF to CHF: Nchf\_SpendingLimitControl\_Unsubscribe request; 8. CHF to PCF: Nchf\_SpendingLimitControl\_Unsubscribe response; 9. PCF to UDR: Nudr\_DataRepository\_Unsubscribe request; 10. UDR to PCF: Nudr\_DataRepository\_Unsubscribe response. + +Figure 5.6.3.1.2-1: AMF-initiated UE Policy Association Termination procedure – Non-roaming + +1. The AMF invokes the Npcf\_UEPolicyControl\_Delete service operation by sending the HTTP DELETE request to the "Individual UE Policy Association" resource to delete the policy context in the PCF. +2. The PCF removes the policy context for the UE and sends an HTTP "204 No Content" response to the AMF. +- 3-4. If the PCF has previously registered to the BSF as the PCF that is serving this UE, the PCF deregisters from the BSF if no AM Policy Association nor UE Policy Association for this UE exists anymore. This is performed by using the Nbsf\_Management\_Deregister service operation. +5. To unsubscribe to notifications of N1 message for UE Policy Delivery Result, the PCF invokes Namf\_Communication\_N1N2MessageUnsubscribe service operation to the AMF by sending the HTTP DELETE method with the URI of the "N1N2 Individual Subscription" resource. +6. The AMF sends an HTTP "204 No Content" response to the PCF. + +NOTE 1: Steps 5-6 are triggered by the Npcf\_UEPolicyControl\_Delete request and can be received by the AMF before step 2. + +NOTE 2: Steps 5-6 are not applicable for URSP provisioning in EPS. + +- 7-8. If the PCF has previously subscribed to the policy counter status to the CHF, and if the PCF determines that the AM Policy Context does not depend on policy counters, it invokes the procedure Final Spending Limit Report Request defined in clause 5.3.4 to unsubscribe to policy counter status reporting, otherwise the PCF may invoke the Intermediate Spending Limit Report procedure as defined in clause 5.3.3 to modify the list of subscribed policy counters. +9. The PCF unsubscribes the notification of subscriber policy data modification from the UDR by invoking Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "IndividualPolicyDataSubscription" resource if it has subscribed such notification. +- The PCF invokes also the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe from notifications about applied BDT Policy Data changes and service parameter data changes at the UDR by sending + +an HTTP DELETE request to the "IndividualApplicationDataSubscription" resource if it has subscribed such notifications. + +- The PCF invokes also the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe from notifications about 5G VN group configuration data changes at the UDR by sending an HTTP DELETE request to the "IndividualSubscriptionDataSubscription" resource as specified in 3GPP TS 29.505 [47] if it has subscribed such notification. + +NOTE 3: The PCF will not invoke the Nudr\_DataRepository\_Unsubscribe service operation when the PCF has internally stored the retrieved 5G VN group configuration data for later use for other SUPIs that belong to the same Internal-Group-Id + +10. The UDR sends an HTTP "204 No Content" response to the PCF. + +##### 5.6.3.1.3 Roaming + +![Sequence diagram for AMF-initiated UE Policy Association Termination procedure – Roaming. The diagram shows interactions between AMF, V-PCF, V-UDR, H-PCF, H-UDR, and BSF. The sequence starts with the AMF sending an Npcf_UEPolicyControl_Delete request to the V-PCF. The V-PCF responds with an Npcf_UEPolicyControl_Delete response. The V-PCF then sends an Npcf_UEPolicyControl_Delete request to the H-PCF. The H-PCF responds with an Npcf_UEPolicyControl_Delete response. The H-PCF then sends an Nbsf_Management_Deregister request to the BSF. The BSF responds with an Nbsf_Management_Deregister response. The H-PCF then sends a Namf_Communication_N1N2MessageUnsubscribe request to the AMF. The AMF responds with a Namf_Communication_N1N2MessageUnsubscribe response. The AMF then sends a Nudr_DataRepository_Unsubscribe request to the V-UDR. The V-UDR responds with a Nudr_DataRepository_Unsubscribe response. The V-UDR then sends a Nudr_DataRepository_Unsubscribe request to the H-UDR. The H-UDR responds with a Nudr_DataRepository_Unsubscribe response.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant V-PCF + participant V-UDR + participant H-PCF + participant H-UDR + participant BSF + + Note left of AMF: 1. Npcf_UEPolicyControl_Delete request + AMF->>V-PCF: 1. Npcf_UEPolicyControl_Delete request + Note left of V-PCF: 2. Npcf_UEPolicyControl_Delete response + V-PCF-->>AMF: 2. Npcf_UEPolicyControl_Delete response + Note left of V-PCF: 3. Npcf_UEPolicyControl_Delete request + V-PCF->>H-PCF: 3. Npcf_UEPolicyControl_Delete request + Note left of H-PCF: 4. Npcf_UEPolicyControl_Delete response + H-PCF-->>V-PCF: 4. Npcf_UEPolicyControl_Delete response + Note left of H-PCF: 5. Nbsf_Management_Deregister request + H-PCF->>BSF: 5. Nbsf_Management_Deregister request + Note left of BSF: 6. Nbsf_Management_Deregister response + BSF-->>H-PCF: 6. Nbsf_Management_Deregister response + Note left of H-PCF: 7. Namf_Communication_N1N2MessageUnsubscribe request + H-PCF->>AMF: 7. Namf_Communication_N1N2MessageUnsubscribe request + Note left of AMF: 8. Namf_Communication_N1N2MessageUnsubscribe response + AMF-->>H-PCF: 8. Namf_Communication_N1N2MessageUnsubscribe response + Note left of AMF: 9. Nudr_DataRepository_Unsubscribe request + AMF->>V-UDR: 9. Nudr_DataRepository_Unsubscribe request + Note left of V-UDR: 10. Nudr_DataRepository_Unsubscribe response + V-UDR-->>AMF: 10. Nudr_DataRepository_Unsubscribe response + Note left of V-UDR: 11. Nudr_DataRepository_Unsubscribe request + V-UDR->>H-UDR: 11. Nudr_DataRepository_Unsubscribe request + Note left of H-UDR: 12. Nudr_DataRepository_Unsubscribe response + H-UDR-->>V-UDR: 12. Nudr_DataRepository_Unsubscribe response + +``` + +Sequence diagram for AMF-initiated UE Policy Association Termination procedure – Roaming. The diagram shows interactions between AMF, V-PCF, V-UDR, H-PCF, H-UDR, and BSF. The sequence starts with the AMF sending an Npcf\_UEPolicyControl\_Delete request to the V-PCF. The V-PCF responds with an Npcf\_UEPolicyControl\_Delete response. The V-PCF then sends an Npcf\_UEPolicyControl\_Delete request to the H-PCF. The H-PCF responds with an Npcf\_UEPolicyControl\_Delete response. The H-PCF then sends an Nbsf\_Management\_Deregister request to the BSF. The BSF responds with an Nbsf\_Management\_Deregister response. The H-PCF then sends a Namf\_Communication\_N1N2MessageUnsubscribe request to the AMF. The AMF responds with a Namf\_Communication\_N1N2MessageUnsubscribe response. The AMF then sends a Nudr\_DataRepository\_Unsubscribe request to the V-UDR. The V-UDR responds with a Nudr\_DataRepository\_Unsubscribe response. The V-UDR then sends a Nudr\_DataRepository\_Unsubscribe request to the H-UDR. The H-UDR responds with a Nudr\_DataRepository\_Unsubscribe response. + +**Figure 5.6.3.1.3-1: AMF-initiated UE Policy Association Termination procedure – Roaming** + +- The AMF invokes the Npcf\_UEPolicyControl\_Delete service operation by sending the HTTP DELETE request to the "Individual UE Policy Association" resource to delete the policy context in the V-PCF. The V-PCF interacts with the H-PCF. +- The V-PCF removes the policy context for the UE and sends an HTTP "204 No Content" response to the AMF. +- The V-PCF invokes the Npcf\_UEPolicyControl\_Delete service operation by sending the HTTP DELETE request to the "Individual UE Policy Association" resource to delete the policy context in the H-PCF. +- The H-PCF removes the policy context for the UE and sends an HTTP "204 No Content" response to the V-PCF. +- 5-6. If the H-PCF has previously registered to the BSF as the PCF that is serving this UE, the H-PCF shall deregister from the BSF if no AM Policy Association nor UE Policy Association for this UE exists anymore. This is performed by using the Nbsf\_Management\_Deregister service operation. +- To unsubscribe to notifications of N1 message for UE Policy Delivery Result, the V-PCF invokes Namf\_Communication\_N1N2MessageUnsubscribe service operation to the AMF by sending the HTTP DELETE method with the URI of the "N1N2 Individual Subscription" resource. +- The AMF sends an HTTP "204 No Content" response to the V-PCF. + +NOTE 1: Steps 7-8 are triggered by the Npcf\_UEPolicyControl\_Delete request and can be received by the AMF before step 2. + +NOTE 2: Steps 7-8 are not applicable for URSP provisioning in EPS. + +9. The V-PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "IndividualPolicyDataSubscription" resource to unsubscribe the notification from the V-UDR on changes in UE policy information if it has subscribed such notification. + +10. The V-UDR sends an HTTP "204 No Content" response to the V-PCF. + +11. The H-PCF unsubscribes the notification of subscriber policy data modification from the H-UDR by invoking Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "IndividualPolicyDataSubscription" resource if it has subscribed such notification. + +- The PCF invokes also the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe from notifications about service parameter data changes at the UDR by sending an HTTP DELETE request to the "IndividualApplicationDataSubscription" resource if it has subscribed such notification. + +- The PCF invokes also the Nudr\_DataRepository\_Unsubscribe service operation to unsubscribe from notifications about 5G VN group configuration data changes at the UDR by sending an HTTP DELETE request to the "IndividualSubscriptionDataSubscription" resource as specified in 3GPP TS 29.505 [47] if it has subscribed such notification. + +NOTE 2: The PCF will not invoke the Nudr\_DataRepository\_Unsubscribe service operation when the PCF has internally stored the retrieved 5G VN group configuration data for later use for other SUPIs that belong to the same Internal-Group-Id. + +12. The H-UDR sends an HTTP "204 No Content" response to the H-PCF. + +#### 5.6.3.2 UE Policy Association Termination initiated by the PCF + +##### 5.6.3.2.1 General + +This procedure is performed when the (H-)UDR notifies the (H-)PCF that the policy profile is removed. + +NOTE 1: For details of the Nudr\_DataRepository\_Notify service operation refer to 3GPP TS 29.519 [12]. + +NOTE 2: For details of the Npcf\_UEPolicyControl\_UpdateNotify/Delete service operations refer to 3GPP TS 29.525 [31]. + +NOTE 3: For details of the Namf\_Communication\_N1N2MessageUnsubscribe service operation refer to 3GPP TS 29.518 [32]. + +NOTE 4: When the UE Policy Association is for URSP provisioning in EPS the (V-)PCF for a PDU session replaces the AMF in the procedure described in clause 5.6.3.2.2. + +##### 5.6.3.2.2 Non-roaming + +![Sequence diagram for PCF-initiated UE Policy Association Termination procedure – Non-roaming](cab0834804fb031b43865554cc8d06ab_img.jpg) + +``` +sequenceDiagram + participant AMF + participant PCF + participant UDR + Note right of UDR: 1. Policy Data removed + UDR->>PCF: 2. Nudr_DataRepository_Notify request + PCF-->>UDR: 3. Nudr_DataRepository_Notify response + PCF->>AMF: 4. Npcf_UEPolicyControl_UpdateNotify request + AMF-->>PCF: 5. Npcf_UEPolicyControl_UpdateNotify response + Note over AMF, PCF: 6. Perform step 1-4 as specified in Figure 5.6.3.1.2-1 +``` + +The diagram illustrates the sequence of interactions for the PCF-initiated UE Policy Association Termination procedure in a non-roaming scenario. It involves three main entities: AMF, PCF, and UDR. The process begins with the UDR removing policy data (Step 1). The UDR then sends a 'Nudr\_DataRepository\_Notify request' to the PCF (Step 2), which responds with a 'Nudr\_DataRepository\_Notify response' (Step 3). Next, the PCF sends an 'Npcf\_UEPolicyControl\_UpdateNotify request' to the AMF (Step 4), which responds with an 'Npcf\_UEPolicyControl\_UpdateNotify response' (Step 5). Finally, a note indicates that steps 1 through 4 as specified in Figure 5.6.3.1.2-1 are performed (Step 6). + +Sequence diagram for PCF-initiated UE Policy Association Termination procedure – Non-roaming + +**Figure 5.6.3.2.2-1: PCF-initiated UE Policy Association Termination procedure – Non-roaming** + +1. The subscriber policy control data is removed from the UDR. +2. The UDR invokes the Nudr\_DataRepository\_Notify service operation by sending the HTTP POST request to callback URI "{notificationUri}" to notify the PCF that the policy profile is removed if PCF has subscribed such notification. +3. The PCF sends HTTP "204 No Content" response to confirm reception and the result to UDR. +4. The PCF may, depending on operator policies, invoke the Npcf\_UEPolicyControl\_UpdateNotify service operation to the AMF of the removal of the UE policy control information by sending the HTTP POST request to the callback URI "{notificationUri}/terminate". +Alternatively, the PCF may decide to maintain the UE Policy Association if a default profile is applied, and then step 4 through 6 are not executed. +5. The AMF sends an HTTP "204 No Content" response to the PCF. +6. Steps 1 to 4 as specified in Figure 5.6.3.1.2-1 are executed. + +##### 5.6.3.2.3 Roaming + +![Sequence diagram for PCF-initiated UE Policy Association Termination procedure – Roaming. Lifelines: AMF, V-PCF, V-UDR, H-PCF, H-UDR. The sequence starts with '1. Policy Data removed' in H-UDR. H-UDR sends '2. Nudr_DataRepository_Notify request' to H-PCF. H-PCF sends '3. Nudr_DataRepository_Notify response' to H-UDR. H-PCF sends '4. Npcf_UEPolicyControl_UpdateNotify request' to V-PCF. V-PCF sends '5. Npcf_UEPolicyControl_UpdateNotify response' to H-PCF. H-PCF sends '6. Npcf_UEPolicyControl_UpdateNotify request' to AMF. AMF sends '7. Npcf_UEPolicyControl_UpdateNotify response' to H-PCF. H-PCF sends '8. Nudr_DataRepository_Unsubscribe request' to V-UDR. V-UDR sends '9. Nudr_DataRepository_Unsubscribe response' to H-PCF. A block labeled '10. Perform step 1-6 as specified in Figure 5.6.3.1.3-1' spans across the bottom of the diagram.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant V-PCF + participant V-UDR + participant H-PCF + participant H-UDR + + Note right of H-UDR: 1. Policy Data removed + H-UDR->>H-PCF: 2. Nudr_DataRepository_Notify request + H-PCF-->>H-UDR: 3. Nudr_DataRepository_Notify response + H-PCF->>V-PCF: 4. Npcf_UEPolicyControl_UpdateNotify request + V-PCF-->>H-PCF: 5. Npcf_UEPolicyControl_UpdateNotify response + H-PCF->>AMF: 6. Npcf_UEPolicyControl_UpdateNotify request + AMF-->>H-PCF: 7. Npcf_UEPolicyControl_UpdateNotify response + H-PCF->>V-UDR: 8. Nudr_DataRepository_Unsubscribe request + V-UDR-->>H-PCF: 9. Nudr_DataRepository_Unsubscribe response + Note over AMF, V-PCF, V-UDR, H-PCF: 10. Perform step 1-6 as specified in Figure 5.6.3.1.3-1 + +``` + +Sequence diagram for PCF-initiated UE Policy Association Termination procedure – Roaming. Lifelines: AMF, V-PCF, V-UDR, H-PCF, H-UDR. The sequence starts with '1. Policy Data removed' in H-UDR. H-UDR sends '2. Nudr\_DataRepository\_Notify request' to H-PCF. H-PCF sends '3. Nudr\_DataRepository\_Notify response' to H-UDR. H-PCF sends '4. Npcf\_UEPolicyControl\_UpdateNotify request' to V-PCF. V-PCF sends '5. Npcf\_UEPolicyControl\_UpdateNotify response' to H-PCF. H-PCF sends '6. Npcf\_UEPolicyControl\_UpdateNotify request' to AMF. AMF sends '7. Npcf\_UEPolicyControl\_UpdateNotify response' to H-PCF. H-PCF sends '8. Nudr\_DataRepository\_Unsubscribe request' to V-UDR. V-UDR sends '9. Nudr\_DataRepository\_Unsubscribe response' to H-PCF. A block labeled '10. Perform step 1-6 as specified in Figure 5.6.3.1.3-1' spans across the bottom of the diagram. + +Figure 5.6.3.2.3-1: PCF-initiated UE Policy Association Termination procedure – Roaming + +1. The subscriber policy control data is removed from the H-UDR. +2. The H-UDR invokes the Nudr\_DataRepository\_Notify service operation by sending the HTTP POST request to callback URI "{notificationUri}" to notify the H-PCF that the policy profile is removed if H-PCF has subscribed such notification. +3. The H-PCF sends HTTP "204 No Content" response to confirm reception and the result to H-UDR. +4. The H-PCF may, depending on operator policies, invoke the Npcf\_UEPolicyControl\_UpdateNotify service operation to the AMF of the removal of the UE policy control information by sending the HTTP POST request to the callback URI "{notificationUri}/terminate". + +Alternatively, the H-PCF may decide to maintain the UE Policy Association if a default profile is applied, and then step 4 through 10 are not executed. + +5. The AMF sends an HTTP "204 No Content" response to the V-PCF. +6. The V-PCF invokes the Npcf\_UEPolicyControl\_UpdateNotify service operation to the AMF of the removal of the UE policy control information by sending the HTTP POST request to the callback URI "{notificationUri}/terminate". +7. The AMF sends an HTTP "204 No Content" response to the V-PCF. +8. The V-PCF invokes the Nudr\_DataRepository\_Unsubscribe service operation by sending the HTTP DELETE request to the "IndividualPolicyDataSubscription" resource to unsubscribe the notification from the V-UDR on changes in UE policy information if it has subscribed such notification. +9. The V-UDR sends an HTTP "204 No Content" response to the V-PCF. +10. Steps 1 to 6 as specified in Figure 5.6.3.1.3-1 are executed. + +## 5.7 MBS Policy Association Management + +### 5.7.1 General + +Clause 5.7 specifies the detailed call flows for MBS Policy and Charging Control (PCC) for 5G multicast-broadcast services over the Npcf and Nmbsmf service-based interfaces and their relationship with the flow level signalling in the 5G system. + +The stage 2 definition, architecture and procedures for MBS PCC are specified in 3GPP TS 23.247 [54]. + +### 5.7.2 MBS Policy Association Establishment + +This clause is applicable if a new MBS Policy Association is being established. + +![Sequence diagram of MBS Policy Association Establishment procedure. Lifelines: MB-SMF, PCF, BSF, UDR, AF/NEF/MBSF. The procedure involves discovery, authorization, registration, and session creation steps, with conditional policy decisions by the PCF.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant AF/NEF/MBSF + participant BSF + participant UDR + participant PCF + participant MB-SMF + + Note right of AF/NEF/MBSF: 1. Trigger + Note left of BSF: If AF/NEF/MBSF decided to interact with PCF + AF/NEF/MBSF->>BSF: 2. Nbsf_Management_Discovery + BSF-->>AF/NEF/MBSF: 3. Nbsf_Management_Discovery response + AF/NEF/MBSF->>PCF: 4. Npcf_MBSPolicyAuthorization_Create Request + PCF->>UDR: 5. Nudr_DataRepository_Query request + UDR-->>PCF: 6. Nudr_DataRepository_Query response + Note right of PCF: 7. MBS policy decision + PCF->>BSF: 8. Nbsf_Management_Register request + BSF-->>PCF: 9. Nbsf_Management_Register response + PCF-->>AF/NEF/MBSF: 10. Npcf_MBSPolicyAuthorization_Create response + Note left of MB-SMF: 11. Nmbsmf_MBSSession_Create Request + MB-SMF->>PCF: 12. Npcf_MBSPolicyControl_Create request + PCF->>BSF: 13. Nbsf_Management_Register request + BSF-->>PCF: 14. Nbsf_Management_Register response + PCF->>UDR: 15. Nudr_DataRepository_Query request + UDR-->>PCF: 16. Nudr_DataRepository_Query response + Note right of PCF: 17. MBS policy decision + PCF-->>MB-SMF: 18. Npcf_MBSPolicyControl_Create response + MB-SMF-->>AF/NEF/MBSF: 19. Nmbsmf_MBSSession_Create Response + +``` + +Sequence diagram of MBS Policy Association Establishment procedure. Lifelines: MB-SMF, PCF, BSF, UDR, AF/NEF/MBSF. The procedure involves discovery, authorization, registration, and session creation steps, with conditional policy decisions by the PCF. + +**Figure 5.7.2-1: MBS Policy Association Establishment procedure** + +1. When the AF decides to create an MBS Session, the AF/NEF/MBSF may decide to interact with the PCF for MBS policy authorization based on the local configuration. If it does, the procedure continues with step 2; otherwise, the procedure continues with step 11. +2. If the AF requests for a location-dependent session and if there is a need to select the same PCF for the location dependent MBS Sessions, the NEF/MBSF checks whether there is already a PCF serving the MBS session by invoking Nbsf\_Management\_Discovery service by sending an HTTP GET request to the resource "PCF for an MBS Session Bindings" in order to discover whether there is a PCF serving the MBS session with the MBS session ID as described in 3GPP TS 29.521 [22]. In the case that the NEF/MBSF receives a request without an MBS Session ID from the AF, the NEF/MBSF contacts with the MB-SMF to request allocation of a TMGI before the NEF/MBSF contacts with the PCF. + +3. If there is a PCF serving the MBS session, the BSF sends an HTTP "200 OK" with the address of another PCF to AF/NEF/MBSF; otherwise, the BSF returns an HTTP "200 OK" with empty array (i.e. "[ ]" in JSON). +4. If the received Request is not for location-dependent session in step 1 or the BSF returned an HTTP "200 OK" with empty array (i.e. "[ ]" in JSON), the AF/NEF/MBSF discovers and selects the PCF as defined in clause 8.6.2, and then the AF/NEF/MBSF invokes the Npcf\_MBSPolicyAuthorization\_Create service operation by sending an HTTP POST request to the "MBS Application Session Contexts" resource as defined in clause 5.3.2.2 of 3GPP TS 29.537 [55] with the request body containing, but not limited to, the concerned MBS Session ID, MBS Service Information, DNN if available and S-NSSAI if available; otherwise if the BSF returned the HTTP "200 OK" with the address of another PCF, the AF/NEF/MBSF contacts with the returned PCF by invoking the Npcf\_MBSPolicyAuthorization\_Create service operation. +5. The PCF may retrieve MBS Session policy control data for the MBS session from the UDR. It invokes for this purpose the Nudr\_DataRepository\_Query service operation by sending an HTTP GET request to the "MBSSessionPolicyControlData" resource as specified in 3GPP TS 29.519 [12]. +6. The UDR responds with an HTTP "200 OK" response to the PCF with the requested MBS Session policy control data in the response message body. + +NOTE 1: Interacting with the UDR for MBS Session policy control data retrieval is not necessary in a deployment where MBS Policy Session policy control data is stored locally at the PCF. + +7. The PCF performs MBS policy authorization based on the received MBS Service Information, the operator policies that are pre-configured at the PCF and the MBS Session policy control data retrieved from the UDR. + +If the request is authorized, the PCF derives the MBS policies and determines whether the MBS policies are allowed or not. If they are allowed, the PCF then packages them into an MBS policy decision as described in clause 5.2.2 of 3GPP TS 29.537 [55] and stores them together with the corresponding MBS session ID. + +8. If the request is authorized and the PCF is not already handling the MBS Session, the PCF may register at the BSF as the PCF handling the MBS session by sending an HTTP POST request to the "PCF for an MBS Session Bindings" resource using the Nbsf\_Management\_Register service operation, as described in clause 4.2.2.4 of 3GPP TS 29.521 [22]. +9. The BSF responds with "201 Created" status code if the registration of the PCF was successful. +10. The PCF sends an Npcf\_MBSPolicyAuthorization\_Create Response to the AF/NEF/MBSF. +11. AF/NEF/MBSF discovers and selects an MB-SMF for the MBS session and sends Nmbsmf\_MBSSession\_Create Request to the MB-SMF as defined in clause 5.3.2.2 of 3GPP TS 29.532 [58]. +12. Upon reception of an Nmbsmf\_MBSSession\_Create request from the AF/NEF/MBSF, the MB-SMF discovers and selects the PCF as defined in clause 8.6.1, and then invokes the Npcf\_MBSPolicyControl\_Create service operation towards the PCF by sending an HTTP POST request to the "MBS Policies" resource as defined in clause 5.2.2.2 of 3GPP TS 29.537 [55] with the request body containing, but not limited to, the concerned MBS Session ID, DNN (if received from the AF/NEF/MBSF), S-NSSAI (if received from the AF/NEF/MBSF) and MBS Service Information (if received from the AF/NEF/MBSF). +13. If the PCF is not handling the MBS session and the PCF needs to check if there is a PCF already handling the MBS session (i.e., the request corresponds to a location-dependent MBS service and/or no MBS Service Information was provided by the MB-SMF), the PCF invokes the Nbsf\_Management\_Register service as described in 3GPP TS 29.521 [22]. +14. If there is an existing PCF for an MBS Session Binding information for the MBS session ID, the BSF rejects the request with an HTTP "403 Forbidden" status code and includes the address of the existing PCF that is handling the MBS session in the response and the procedure continues directly in step 18; otherwise, for the case of location-dependent MBS sessions, the BSF registers the PCF as the PCF handling the MBS session, stores the related PCF for an MBS Session binding information and responds to the PCF with an HTTP "201 Created" status code and the next steps are executed. +15. If the PCF receives MBS Service Information from the MB-SMF and the PCF does not have the MBS Session policy control data (e.g. the steps 2-10 were not executed), it invokes the Nudr\_DataRepository\_Query service operation to the UDR by sending an HTTP GET request to the "MBSSessionPolicyControlData" resource as specified in 3GPP TS 29.519 [12]. + +6. The UDR sends an HTTP "200 OK" response to the PCF with the requested MBS Session policy control data in the response message body. + +17. If the PCF receives MBS Service Information from the MB-SMF, the PCF performs MBS policy authorization based on the received MBS Service Information, the operator policies that are pre-configured at the PCF and the MBS Session policy control data retrieved from the UDR, if applicable. If the request is authorized, the PCF derives the MBS policies and determines whether they are allowed or not. If they are allowed, the PCF then packages them into an MBS policy decision as described in clause 5.2.2 of 3GPP TS 29.537 [55]. + +Otherwise, when steps 2-10 were performed and MBS policies were derived in step 7, this step is not needed. + +18. The PCF then responds to the MB-SMF. Following responses are returned to the MB-SMF: + +- If the PCF receives the HTTP "403 Forbidden" with the address of another PCF in step 14, the PCF rejects the request and responds to the MB-SMF with an HTTP "308 Permanent Redirection" status code including an HTTP Location header field containing the "apiRoot" (e.g. FQDN or IP address) of the PCF currently serving the MBS Session as described in clause 5.2.2 of 3GPP TS 29.537 [55]. In this case, the MB-SMF contacts with the returned address of the another PCF as described in step 12; otherwise, +- If the PCF receives the HTTP "201 Created " in step 14 and the request is authorized, the PCF responds to the MB-SMF with an HTTP "201 Created" status code with the response body including the derived MBS policy as described in clause 5.2.2 of 3GPP TS 29.537 [55]. +- If errors occur when processing the Npcf\_MBSPolicyControl\_Create by the PCF (e.g. the request is not authorized, the derived MBS policies are not allowed) and the PCF was registered at the BSF as the PCF handling the MBS session in step 14, the PCF deregisters itself at the BSF from being the PCF handling the MBS session by sending an HTTP DELETE request to the corresponding "Individual PCF for an MBS Session Binding" resource using the Nbsf\_Management\_Deregister service operation, as described in clause 4.2.3.4 of 3GPP TS 29.521 [22]. The BSF responds with a "204 No Content" status code if the deregistration of the PCF was successful. + +19. The MB-SMF sends Nmbsmf\_MBSSession\_Create Response to the AF/NEF/MBSF as defined in clause 5.3.2.2 of 3GPP TS 29.532 [58]. + +NOTE 2: These steps 2, 8 and 13 are not necessary in a deployment with a single PCF. + +### 5.7.3 MBS Policy Association Modification + +#### 5.7.3.1 General + +The MBS Policy Association Modification procedure may be initiated by the AF/NEF/MBSF. + +#### 5.7.3.2 MBS Policy Association Modification initiated by the AF/NEF/MBSF + +This procedure is performed when the AF/NEF/MBSF or the MB-SMF needs to modify MBS policy decisions related to an existing MBS Policy Association when the AF decides to update the MBS Service Information. + +![Sequence diagram illustrating the MBS Policy Association Modification procedure. The diagram shows interactions between MB-SMF, PCF, and AF, NEF, MBSF. The process starts with a PCF interaction decision in the AF, NEF, MBSF lifeline, followed by an Npcf_MBSPolicyAuthorization_Update request to the PCF. The PCF authorizes the MBS session and derives QoS, responding with an Npcf_MBSPolicyAuthorization_Update response. The AF, NEF, MBSF then requests an MBS Session update from the MB-SMF. The MB-SMF sends an Npcf_MBSPolicyControl_Update request to the PCF, which authorizes the session and derives QoS, responding with an Npcf_MBSPolicyControl_Update response. Finally, the MB-SMF indicates that the MBS Session update is completed.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant AF, NEF, MBSF + participant PCF + participant MB-SMF + + Note right of AF, NEF, MBSF: 1. PCF interaction decision + AF, NEF, MBSF->>PCF: 2. Npcf_MBSPolicyAuthorization_Update request + Note right of PCF: 3. Authorize MBS Session & derive QoS + PCF-->>AF, NEF, MBSF: 4. Npcf_MBSPolicyAuthorization_Update response + Note right of AF, NEF, MBSF: 5. MBS Session update is requested + AF, NEF, MBSF->>MB-SMF: 6. Npcf_MBSPolicyControl_Update request + Note right of MB-SMF: 7. Authorize MBS Session & derive QoS + MB-SMF-->>AF, NEF, MBSF: 8. Npcf_MBSPolicyControl_Update response + Note right of AF, NEF, MBSF: 9. MBS Session update is completed + +``` + +Sequence diagram illustrating the MBS Policy Association Modification procedure. The diagram shows interactions between MB-SMF, PCF, and AF, NEF, MBSF. The process starts with a PCF interaction decision in the AF, NEF, MBSF lifeline, followed by an Npcf\_MBSPolicyAuthorization\_Update request to the PCF. The PCF authorizes the MBS session and derives QoS, responding with an Npcf\_MBSPolicyAuthorization\_Update response. The AF, NEF, MBSF then requests an MBS Session update from the MB-SMF. The MB-SMF sends an Npcf\_MBSPolicyControl\_Update request to the PCF, which authorizes the session and derives QoS, responding with an Npcf\_MBSPolicyControl\_Update response. Finally, the MB-SMF indicates that the MBS Session update is completed. + +**Figure 5.7.3.2-1: MBS Policy Association Modification procedure** + +1. When the AF decides to modify an existing MBS Session that requires policy control, the AF/NEF/MBSF may decide to interact with the PCF for early authorization based on the same decision that was made during MBS Session creation procedure (see clause 5.7.2). If no interaction is required, steps 2-4 are skipped. +2. The AF/NEF/MBSF invokes the Npcf\_MBSPolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual MBS Application Session Context" resource as defined in clause 5.3.2.3.2 of 3GPP TS 29.537 [55] with the request body containing the MbsAppSessionCtxtPatch data structure with the modified service information within the "mbsServiceInfo" attribute. +3. The PCF determines whether the request is authorized and if the request is authorized, the PCF derives the updated QoS parameters based on the received MBS Service Information and determines whether this updated QoS is allowed. If the updated QoS is allowed, the PCF generates the updated policy information for the MBS session and packages it together with the MBS Session ID into an MBS policy decision as described in clause 5.3.2.3 of 3GPP TS 29.537 [55]. +4. The PCF responds to the AF/NEF/MBSF with an HTTP "200 OK" status code with the Application Session context information within the "MbsAppSessionCtxt" data type, including the "contactPcfInd" attribute if the policy information was changed to indicate that the MB-SMF needs to contact the PCF. Alternatively, the PCF may respond with an HTTP "204 No Content" when no information is provided in the response. +5. The AF/NEF/MBSF sends Nmbsmf\_MBSsession\_Update Request to the MB-SMF as defined in clause 5.3.2.3 of 3GPP TS 29.532 [58]. +6. If the MB-SMF received the indication to contact the PCF or did not receive it but decided to contact the PCF, the MB-SMF invokes the Npcf\_MBSPolicyControl\_Update service operation by sending an HTTP POST request to the PCF to update the Individual MBS Policy Association. The request body shall include the MbsPolicyCtxtDataUpdate data structure in the payload body of the HTTP POST, that may include the request trigger(s) within the "mbsPerts" attribute and, if received from the AF/NEF/MBSF, the updated service information within the "mbsServInfo", as described in clause 5.2.2.3.2 of 3GPP TS 29.537 [55]. +7. The PCF determines whether the request is authorized and if the request is authorized, the PCF checks if there is available service information. In that case, the PCF derives the updated QoS parameters based on the received MBS Service Information and determines whether this updated QoS is allowed. If the updated QoS is allowed, the PCF generates the updated policy information for the MBS session and packages it into the updated MBS + +policy decision as described in clause 5.2.2.3 of 3GPP TS 29.537 [55]. If the PCF did not receive MBS Service Information from the MB-SMF, the PCF identifies any updated policy information for the MBS session corresponding to the MBS session ID received from the MB-SMF. + +8. Upon success, the PCF responds to the MB-SMF with an HTTP "200 OK" status code including the MbsPolicyData data structure with the input parameters within the "mbsPolicyCtxtData" attribute and the updated policy information within "mbsPolicies" attribute. +9. The AF/NEF/MBSF sends Nmbsmf\_MBSSession\_Update Response to the MB-SMF as defined in clause 5.3.2.3 of 3GPP TS 29.532 [58]. + +### 5.7.4 MBS Policy Association Termination + +#### 5.7.4.1 General + +The MBS Policy Association Termination procedure is initiated by the AF/NEF/MBSF. + +#### 5.7.4.2 MBS Policy Association Termination initiated by the PCF + +Void + +#### 5.7.4.3 MBS Policy Association Termination initiated by the AF/NEF/MBSF + +This procedure is performed when the AF/NEF/MBSF needs to terminate the MBS Policy Association when the AF decides to release the MBS session. + +![Sequence diagram for MBS Policy Association termination procedure initiated by the AF. Lifelines: MB-SMF, PCF, BSF, AF/NEF/MBSF. The process starts with a 'Trigger' from AF/NEF/MBSF. A dashed box labeled 'if AF/NEF/MBSF decided to interact with PCF' contains steps 2 (Npcf_MBSPolicyAuthorization_Delete request) and 3 (Npcf_MBSPolicyAuthorization_Delete response). Step 4 is Nmbsmf_MBSSession_Delete Request from AF/NEF/MBSF to MB-SMF. Step 5 is Npcf_MBSPolicyControl_Delete request from MB-SMF to PCF. Step 6 is Nbsf_Management_Deregister request from PCF to BSF. Step 7 is Nbsf_Management_Deregister response from BSF to PCF. Step 8 is Npcf_MBSPolicyControl_Delete response from PCF to MB-SMF. Step 9 is Nmbsmf_MBSSession_Delete Response from MB-SMF to AF/NEF/MBSF.](cd141897aa368dbbaa398ace230cdd85_img.jpg) + +``` + +sequenceDiagram + participant AF/NEF/MBSF + participant BSF + participant PCF + participant MB-SMF + + Note right of AF/NEF/MBSF: 1. Trigger + alt if AF/NEF/MBSF decided to interact with PCF + AF/NEF/MBSF->>PCF: 2. Npcf_MBSPolicyAuthorization_Delete request + PCF-->>AF/NEF/MBSF: 3. Npcf_MBSPolicyAuthorization_Delete response + end + AF/NEF/MBSF->>MB-SMF: 4. Nmbsmf_MBSSession_Delete Request + MB-SMF->>PCF: 5. Npcf_MBSPolicyControl_Delete request + PCF->>BSF: 6. Nbsf_Management_Deregister request + BSF-->>PCF: 7. Nbsf_Management_Deregister response + PCF-->>MB-SMF: 8. Npcf_MBSPolicyControl_Delete response + MB-SMF->>AF/NEF/MBSF: 9. Nmbsmf_MBSSession_Delete Response + +``` + +Sequence diagram for MBS Policy Association termination procedure initiated by the AF. Lifelines: MB-SMF, PCF, BSF, AF/NEF/MBSF. The process starts with a 'Trigger' from AF/NEF/MBSF. A dashed box labeled 'if AF/NEF/MBSF decided to interact with PCF' contains steps 2 (Npcf\_MBSPolicyAuthorization\_Delete request) and 3 (Npcf\_MBSPolicyAuthorization\_Delete response). Step 4 is Nmbsmf\_MBSSession\_Delete Request from AF/NEF/MBSF to MB-SMF. Step 5 is Npcf\_MBSPolicyControl\_Delete request from MB-SMF to PCF. Step 6 is Nbsf\_Management\_Deregister request from PCF to BSF. Step 7 is Nbsf\_Management\_Deregister response from BSF to PCF. Step 8 is Npcf\_MBSPolicyControl\_Delete response from PCF to MB-SMF. Step 9 is Nmbsmf\_MBSSession\_Delete Response from MB-SMF to AF/NEF/MBSF. + +Figure 5.7.4.3-1: MBS Policy Association termination procedure initiated by the AF. + +1. When the AF decides to terminate an existing MBS Session under policy control, the AF/NEF/MBSF interacts with the PCF if it was decided to contact the PCF as part of the MBS Policy Association creation procedure. In that case steps 2 and 3 applies. Otherwise, these steps are skipped. + 2. The AF/NEF/MBSF invokes Npcf\_MBSPolicyAuthorization\_Delete Request to the PCF that handles the MBS Session by sending an HTTP DELETE request to the "Individual MBS Application Session Context" resource as defined in clause 5.3.2.4 of 3GPP TS 29.537 [55]. + 3. Upon success, the PCF responds with an HTTP "204 No Content" status code. + 4. The AF/NEF/MBSF sends Nmbsmf\_MBSSession\_Delete Request to the MB-SMF as defined in clause 5.3.2.4 of 3GPP TS 29.532 [58]. + 5. The MB-SMF invokes the Npcf\_MBSPolicyControl\_Delete service operation by sending an HTTP DELETE request to the "Individual MBS Policy" resource to request the PCF to delete the context of the MBS related policy as defined in clause 5.2.2.4.2 of 3GPP TS 29.537 [55]. + 6. If the same PCF is used for the location dependent MBS sessions and this is the last MBS Policy Association related to that MBS Session, or for an MBS Session that is not an instance of a location-dependent MBS service, the AF/NEF/MBSF interacted with the PCF in step 2, the PCF invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request to the BSF to delete binding information as detailed in clause 8.5.3. + 7. The PCF receives an HTTP "204 No Content" response from the BSF as detailed in clause 8.5.3. + 8. The PCF deletes the concerned MBS Policy Association context for the terminated MBS Session and responds to the MB-SMF with an HTTP "204 No Content" status code. +- NOTE: Step 6 and 8 can be executed in parallel. +9. The MB-SMF sends Nmbsmf\_MBSSession\_Delete Response to the NEF/MBSF as defined in clause 5.3.2.4 of 3GPP TS 29.532 [58]. + +## 5.8 Awareness of URSP Rule Enforcement + +### 5.8.1 General + +Clause 5.8 specifies the detailed call flows for awareness of URSP rule enforcement over the Npcf service-based interfaces and their relationship with the flow level signalling in the 5G system. + +NOTE: In the Home Routed roaming case, the H-PCF for a UE interacts with the PCF for a PDU session in the HPLMN. + +**Editor's Note:** The description of LBO roaming scenarios is FFS. + +### 5.8.2 Forwarding of URSP Rule Enforcement Information + +![Sequence diagram showing the forwarding of URSP Rule Enforcement Information between AMF, PCF (for the UE), PCF (for the PDU Session), and SMF.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg) + +``` + +sequenceDiagram + participant AMF + participant PCF_UE as PCF (for the UE) + participant PCF_PDU as PCF (for the PDU Session) + participant SMF + + Note left of AMF: 1. UE Policy Association Establishment + Note left of AMF: 2. PCF indicates the UE to send reporting of URSP rule enforcement + Note right of PCF_PDU: 3. SM Policy Association Establishment + Note left of PCF_UE: 4. PCF for a PDU session discovery by the PCF for a UE + PCF_UE->>PCF_PDU: 5. Npcf_PolicyAuthorization_Subscribe request + PCF_PDU-->>PCF_UE: 6. Npcf_PolicyAuthorization_Subscribe response + PCF_PDU->>SMF: 7. Npcf_SMPolicyControl_UpdateNotify request + SMF-->>PCF_PDU: 8. Npcf_SMPolicyControl_UpdateNotify response + Note right of SMF: 9. SMF detects the event + PCF_PDU->>SMF: 10. Npcf_SMPolicyControl_Update request + SMF-->>PCF_PDU: 11. Npcf_SMPolicyControl_Update response + PCF_PDU->>PCF_UE: 12. Npcf_PolicyAuthorization_Notify request + PCF_UE-->>PCF_PDU: 13. Npcf_PolicyAuthorization_Notify response + Note left of AMF: 14. UE Policy Association Modification initiated by the PCF + +``` + +Sequence diagram showing the forwarding of URSP Rule Enforcement Information between AMF, PCF (for the UE), PCF (for the PDU Session), and SMF. + +**Figure 5.8.2-1: Forwarding of URSP Rule Enforcement Information** + +This procedure concerns both non-roaming and Home Routed roaming scenarios. In the Home Routed roaming case, the H-PCF for the UE interacts with the PCF for a PDU session in the HPLMN. + +1. An UE Policy Association is established as described in clause 5.1.1. +2. If the UE indicated the support of URSP rule enforcement, the PCF for the UE may indicate in one or more URSP rule(s) sent to the UE to send reporting of URSP rule enforcement as described in clause 4.2.2.2.3.1 of 3GPP TS 29.525 [31]. For the PDU sessions related to the URSP rule(s) whose enforcement has been requested, the PCF for the UE triggers the discovery of the PCF(s) for the PDU session as described in step 4. + +3. The SMF establishes a SM Policy Association as described in clause 5.2.1. If the "URSPEnforcement" feature is supported, the SMF may include the URSP rule enforcement information provided by the UE and additional PDU session information as specified in clause 4.2.2.2 of 3GPP TS 29.512 [9]. The PCF, in the response, may subscribe with the SMF to the report of URSP rule enforcement by providing the Policy Control Request Trigger "UE reporting of URSP rule enforcement information" as specified in clause 5.6.3.6 of 3GPP TS 29.512 [9]. +4. The PCF for the UE discovers the PCF(s) for a PDU Session that handle(s) the respective UE traffic as described in clause 8.4a. +- 5-6. When the PCF for the UE receives the notification about a PDU session that may be handling the traffic of a URSP rule, if the "URSPEnforcement" feature is supported, the PCF for the UE subscribes to the PCF for the PDU Session for notifications about UE reporting of URSP rule enforcement information using the Npcf\_PolicyAuthorization\_Subscribe service operation as described in 3GPP TS 29.514 [10] clause 4.2.6.9. +- 7-8. If not already provisioned, the PCF for a PDU session provisions the Policy Control Request Trigger to request the SMF to detect "UE reporting of URSP rule enforcement information" as defined in clause 4.2.6.4 of 3GPP TS 29.512 [9]. + +If the PCF for the PDU session contains URSP rule enforcement information (e.g., it was received during SM Policy Association establishment), the PCF for the PDU session notifies the PCF for the UE as described in steps 13-14. +9. When the SMF receives a UE report of URSP rule enforcement via PDU session modification, the Policy Control Request Trigger "UE reporting of URSP rule enforcement information" is met. +- 10-11. The SMF notifies the PCF for a PDU session using the Npcf\_SMPolicyControl\_Update service operation as described in clause 4.2.4.2 of 3GPP TS 29.512 [9]. +- 12-13. The PCF for the PDU Session notifies the PCF for the UE about the detected URSP rule enforcement event using the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request to the notification URI received in the subscription in step 5, and the PCF for the UE responds with "204 No Content", as described in 3GPP TS 29.514 [10] clause 4.2.5.25. +14. The PCF for the UE checks operator policies and then may make policy control decisions, e.g. may adjust the URSP rules when needed, based on the notified URSP rule enforcement information. + +# --- 6 Binding Mechanism + +## 6.1 Overview + +The binding mechanism associates the session information with the QoS flow that is intended to carry the service data flow(s). + +The binding mechanism includes three parts: + +1. Session binding. +2. PCC rule authorization. +3. QoS flow binding. + +For PCC deployments not supporting MBS, the binding mechanism is described in this clause and the rest of clauses under clause 6. + +When PCC is deployed in an MBS architecture as defined in 3GPP TS 23.247 [54], the binding mechanism is defined as described in clause 6.5. + +The Session binding function receives the AF session information and determines the relevant PDU session. With this information the PCC rule authorization function runs the policy rules and constructs the PCC rule(s), if the authorization is granted. Finally, the QoS flow binding function selects the QoS flow(s) to carry the service data flow (defined in a PCC rule by means of the SDF template), within the PDU session + +The PCC rule authorization function and the QoS flow binding function can take place without the Session binding function at certain PDU session events (e.g. request of SM related policies initiated by the SMF). The PCF may authorize dynamic PCC rules for service data flows without a corresponding AF session. + +NOTE: The relation between AF sessions and rules depends only on the operator configuration. An AF session can be covered by one or more PCC rules, if applicable (e.g. one rule per media component of an IMS session). + +## 6.2 Session Binding + +The Session binding is the association of the AF session information to one and only one PDU session. + +When the PCF receives the service information from the AF, the PCF shall perform the session binding and shall associate the described IP and Ethernet data flows within the AF session information (and therefore the applicable PCC rules) to one existing PDU session. This association is done comparing the following parameters received from the AF with the corresponding PDU session parameters. In order to have a successful session binding, all parameters shall match, if provided. + +- a) For an IP type PDU session, the UE IPv4 address or IPv6 address. If IPv6 address is received from the AF, the association is done by comparing the /128 IPv6 address with the IPv6 prefix of the PDU session using the longest prefix match. + +NOTE 1: The UE IP address management is specified in 3GPP TS 29.512 [9], clause 4.2.8, and the differences and additions in wireline and wireless convergence scenarios specified in 3GPP TS 23.512 [9], clause C.2.1.6. For IPv6 prefix delegation, the IPv6 network prefix of the PDU session is shorter than /64. + +NOTE 2: The UE IPv4 address or IPv6 address received by the PCF from the AF can contain an IP address that belongs to the framed routes that apply to a PDU session. In this case, the association with the PDU session needs to be based on comparing the received UE address is within the one or more framed routes of the PDU session. + +For an Ethernet type PDU session, the UE MAC address. + +If the "TimeSensitiveNetworking" or the "TimeSensitiveCommunication" feature feature is supported, association is done by comparing the value of MAC address in the AF request with the MAC address of the DS-TT port as reported by the SMF within the TSC User Plane Node information. + +- b) The UE identity (of the same kind e.g. SUPI), if available. + +NOTE 3: In case the UE identity in the access network and the application level identity for the user are of different kinds, the PCF needs to maintain, or have access to, the mapping between the identities. Such mapping is outside the scope of the present document. + +For 5G ProSe Layer-3 UE-to-Network Relay connectivity, the UE identity that the SMF has provided (i.e. 5G ProSe Layer-3 UE-to-Network Relay Identity) and the UE identity provided by the AF (i.e. 5G ProSe Layer-3 Remote UE Identity) may be different. In these scenarios, the PCF shall ignore the UE identity provided the AF, and applies the rest of received parameters, if available, to perform session binding. + +- c) The information about the data network (DNN) the user is accessing, if available. + +NOTE 4: For 5G ProSe Layer-3 UE-to-Network Relay connectivity, to enable the PCF to distinguish the Relay scenario from other scenarios and hence ignore the received UE identity provided by the AF, a dedicated DNN for 5G ProSe Layer-3 UE-to-Network Relay connectivity needs to be configured in the PCF. + +- d) The IPv4 address domain identity if available in the "ipDomain" attribute. + +NOTE 5: The "ipDomain" attribute is helpful when within a network slice instance, there are several separate IP address domains, with SMF/UPF(s) that allocate IPv4 IP addresses out of the same private address range to UE PDU Sessions. The same IP address can thus be allocated to UE PDU sessions served by SMF/UPF(s) in different address domains. If one PCF controls several SMF/UPF(s) in different IP address domains, the UE IP address is thus not sufficient for the session binding. An AF can serve UEs in different IP address domains, either by having direct IP interfaces to those domains, or by having interconnections via NATs in the user plane between the UPF and the AF. If a NAT is used, the AF obtains the IP address allocated to the UE PDU session via application level signalling and supplies it for the session binding to the PCF in the "ueIpv4" attribute. The AF supplies an "ipDomain" attribute denoting the IP address domain behind the NAT in addition. The AF can derive the appropriate value from the source address (allocated by the NAT) of incoming user plane packets. The value provided in the "ipDomain" attribute is operator configurable. + +e) The S-NSSAI if available. + +NOTE 6: The S-NSSAI is helpful in the scenario where multiple network slice instances are deployed in the same DNN, and the same IPv4 address may be allocated to UE PDU sessions in different network slice instances. If one PCF controls several network slices, each network slice in different IP address domains, the UE IP address is not sufficient for the session binding. The AF supplies the S-NSSAI denoting the network slice instance that allocated the IPv4 address of the UE PDU session. How the AF derives S-NSSAI is out of the scope of this specification. + +Session Binding applies for PDU sessions of IP type. It may also apply to Ethernet PDU session type but only when especially allowed by PCC related policy control request trigger. In the case of Ethernet PDU session, session binding does not apply to AF requests sent over Rx. + +NOTE 7: For the Ethernet PDU session, the PCF needs to provision "UE\_MAC\_CH" trigger to the SMF. + +NOTE 8: Refer to 3GPP TS 29.213 [30] for the session binding between the IP type PDU session and the AF request sent over Rx. + +The PCF shall identify the PCC rules affected by the AF session information, including new PCC rules to be installed and existing PCC rules to be modified or removed. + +If the PCF is not capable of executing the Session binding, the PCF shall reject the AF request. + +## 6.3 PCC rule Authorization + +The PCC rule authorization is the selection of the 5G QoS parameters, described in 3GPP TS 23.501 [2] clause 5.7.2, for the PCC rules. + +The PCF shall perform the PCC rule authorization after successful session binding for PCC rules belonging to the AF sessions, as well as for the PCC rules without the corresponding AF sessions. By the authorization process the PCF determines whether the user can have access to the requested services and under what constraints. If so, the PCC rules are created or modified. If the session information is not authorized, a negative answer shall be issued to the AF. + +The PCF shall perform the PCC rule authorization function, e.g. when the PCF receives the session information from the AF, when the PCF receives a notification of PDU session events (e.g. PDU session establishment, PDU session modification) from the SMF, or when the PCF receives a notification from the UDR, that calls for a policy decision. + +For the authorization of a PCC rule, the PCF shall consider any 5GC specific restrictions, the AF service information and other information available to the PCF (e.g. user's subscription information, operator policies). The PCF shall assign an appropriate set of 5G QoS parameters (e.g. 5QI, QoS characteristics, ARP, GBR, MBR, QNC, RQI), that can be supported by the access network, to each PCC rule. Additional information may be needed in the PCC rule based on feature support and available information as described in 3GPP TS 29.512 [9]. + +The authorization of a PCC rule associated with an emergency service shall be supported without subscription information (e.g. information stored in the UDR). The PCF shall apply policies configured for the emergency service. + +If "PvsSupport" feature defined in 3GPP TS 29.512 [9] is supported, and the Onboarding Network is an ON-SNPN, the authorization of PCC rule(s) associated with a PDU Session used for User Plane Remote Provisioning shall be supported without subscription information (e.g. information stored in the UDR). The PCF shall apply policies based on the locally stored Onboarding Configuration Data for this DNN and S-NSSAI combination. + +NOTE 1: When the Onboarding Network is a PLMN or SNPN, the authorization of PCC rule(s) associated with a PDU Session used for User Plane Remote Provisioning is based on any 5GC specific restrictions and other information available to the PCF, e.g. user's subscription information and operator policies (e.g., the list of allowed services within the user's subscription and the PVS and DNS address(es) to be used in the SDF template of the PCC Rule(s) within the local configuration). + +NOTE 2: The PCC rule authorization is not applicable to the Unstructured type PDU session. + +## 6.4 QoS flow binding + +The QoS flow binding is the association of the PCC rule to a QoS flow, identified by the QFI, within a PDU session. + +The QoS flow binding function resides in the SMF. The binding is performed using the following binding parameters: + +- 5QI; +- ARP; +- QNC (if available in the PCC rule); +- Priority Level (if available in the PCC rule); +- Averaging Window (if available in the PCC rule); and +- Maximum Data Burst Volume (if available in the PCC rule). + +The selected QoS flow shall have the same above binding parameters as the one indicated by the PCC rule. The set of 5G QoS parameters assigned by the PCF to the service data flow is the main input for QFI allocation. + +The SMF shall bind a PCC rule to the default QoS flow as follows: + +- For a non-GBR default QoS flow, the PCC rule(s) bound to the default QoS flow contains values of the non-GBR type 5QI, ARP, and if received, 5QI priority Level, that are identical to the corresponding values within the "authDefQos" attribute of the enforced session rule. +- For a GBR or delay critical GBR default QoS flow, the PCC rule bound to the default QoS flow contains a reference to a QoS data decision with the "defQosFlowIndication" attribute set to true and the authorized default QoS within the "authDefQos" attribute of the enforced session rule contains values of the GBR type or delay critical GBR type 5QI, ARP, GBR, MBR, and if available, 5QI priority Level, averaging window and maximum data burst volume. + +When the QoS data decision which the PCC rule refers to include the "defQosFlowIndication" attribute set to true as defined in clause 4.2.6.2.10 of 3GPP TS 29.512 [9], the SMF shall bind the PCC rule to the default QoS flow as long as the "defQosFlowIndication" attribute set to true. + +If the "defQosFlowIndication" attribute has not been received before during the lifetime of the PCC rule or the "defQosFlowIndication" attribute has been received but set to false (as defined in clause 4.2.6.2.10 of 3GPP TS 29.512 [9]), the SMF shall evaluate whether a QoS flow with the same binding parameters combination exists. If a QoS flow with the same binding parameters combination exists, the SMF binds the PCC rule to the existing QoS flow, or based on local policies, or the below mentioned conditions (which QoS Flow binding shall ensure), require the establishment of a new QoS flow. If no QoS flow exists, the SMF creates a new QoS flow, derives the QoS parameters for a new QoS flow, using authorized QoS in the PCC rule, and binds the PCC rule to the QoS flow. + +NOTE 1: For non-GBR QoS flows, and when standardized 5QIs or pre-configured 5QIs are used, the 5QI value can be used as the QFI of the QoS flow. However, the pre-configured 5QI values cannot be used when the UE is roaming. + +NOTE 2: For an unstructured PDU session, there is maximum one QoS flow. + +NOTE 3: For PCC rules containing a delay critical GBR 5QI value, the SMF can bind PCC Rules with the same binding parameters to different QoS Flows to ensure that the GFBR of the QoS Flow can be achieved with the Maximum Data Burst Volume of the QoS Flow. + +The PCF shall supply the PCC rules to be installed, modified, or removed to the SMF. The SMF shall evaluate whether it is possible to use one of the existing QoS flows or not, and if applicable. + +If the PCF has previously indicated to the SMF that a PCC rule shall be bound to the default QoS flow by including the "defQosFlowIndication" attribute set to true within the QoS data decision which the PCC rule refers to, but the PCF updates the QoS data decision by including the "defQosFlowIndication" attribute set to false as defined in clause 4.2.6.2.10 of 3GPP TS 29.512 [9], the SMF shall create the binding between service data flow(s) and the QoS flow which have the same binding parameters. + +If the PCC rule is corresponding to the QoS rule requested by the UE as defined in clause 4.2.4.17 of 3GPP TS 29.512 [9] and a Segregation bit is set as defined in Table 9.11.4.13.1 of 3GPP TS 24.501 [33] in the request from the UE, the SMF should abide by the UE request and bind the PCC rule on a distinct and dedicated QoS Flow e.g. even if an existing QoS Flow can support the requested QoS, but is still allowed to proceed instead with binding the selected SDF(s) on an existing QoS Flow. + +Whenever the binding parameters of a PCC rule changes, the existing binding of this PCC rule shall be re-evaluated, i.e. the QoS flow binding procedure, is performed. The re-evaluation may, for a PCC rule, result in a new binding with another QoS flow. If the PCF requests the same change of the binding parameter value(s) for all PCC rules that are bound to the same QoS Flow, the SMF should not re-evaluate the binding of these PCC rules and instead, modify the QoS parameter value(s) of the QoS Flow accordingly. + +NOTE 4: A QoS change of the default 5QI/ARP values doesn't cause the QoS flow rebinding for PCC rules previously bound to the QoS flow associated with the default QoS rule, with the "defQosFlowIndication" attribute set to true. + +If the PCC rule is removed, the SMF shall remove the association of the PCC rule to the QoS flow. If the last PCC rule that is bound to a QoS Flow is removed, the SMF shall delete the QoS Flow. + +When a QoS flow is removed the SMF shall report to the PCF that the PCC rules bound to the corresponding QoS flow are removed. + +The QoS Flow binding shall also ensure that: + +- If a dynamic value for the Core Network Packet Delay Budget (defined in 3GPP TS 23.501 [2], clause 5.7.3.4) is used, PCC rules with the same above binding parameters but different PDU Session anchors (i.e. the corresponding service data flows which have different CN PDBs) shall not be bound to the same QoS Flow. + +NOTE 5: Different PDU Session anchors can exist if multiple RouteToLocation instances are included within the traffic control decision referred by the PCC rules. + +NOTE 6: In PIN scenarios (defined in 3GPP TS 23.501 [2], clause 5.44.3.4) the SMF can increase the dynamic CN PDB based on the requested non-3GPP delay budget for specific GBR QoS flows based on operator policy and implementation. This change however does not impact the QoS Flow binding. + +- A PCC rule including TSCAI information is bound to a new QoS flow and no other PCC rule shall be bound to this same QoS flow. Whenever the TSC Assistance container of an existing PCC rule is changed, the binding of this PCC rule shall not be re-evaluated. +- For MA PDU Session, the QoS flow binding shall also ensure that the PCC rules for GBR or delay critical GBR service data flows allowed on different access are not bound to the same QoS flow even if the PCC rules contain the same binding parameters. + +NOTE 7: For MA PDU Session, the GBR or delay critical GBR resource for a service data flow is allocated only in one access. + +- When the PCF provisions a PCC rule with Alternative QoS parameter Set(s), the PCC rule is bound to a new QoS Flow and no other PCC rule is bound to this QoS Flow. +- When the PCF provisions a PCC rule with QoS Monitoring Policy, the PCC rule is bound to a new QoS flow and no other PCC rule is bound to this QoS flow. + +NOTE 8: The binding of PCC rule with QoS Monitoring policy to a new QoS flow is only applicable to the Per QoS Flow per UE QoS Monitoring (as described in TS 23.501 [2] clause 5.33.3.2). + +- The SMF should not bind PCC rule(s) with the indication of service data flow(s) supporting ECN marking for L4S within the "l4sInd" attribute and the PCC rule(s) with service data flow(s) not supporting ECN marking for L4S to the same QoS flow. + +NOTE 9: The SMF can also, based on local configuration, bind a PCC Rule that does not include the explicit indication of ECN marking for L4S to a new QoS flow that supports ECN marking for L4S. + +- When the PCF provisions a PCC rule with Traffic Parameter Information, the PCC rule is bound to a new QoS Flow and no other PCC rule is bound to this QoS Flow. +- When the PCF provisions a PCC rule with PDU Set Control Information, the PCC rule is bound to a new QoS Flow and no other PCC rule is bound to this QoS Flow. Whenever the PDU Set Control Information of an existing PCC rule changed, the binding of this PCC rule shall not be re-evaluated. +- When the PCF provisions a PCC rule with Data Burst Handling Information, the PCC rule is bound to a new QoS flow and no other PCC rule is bound to this QoS flow. + +## 6.5 Binding mechanism in MBS deployments + +### 6.5.1 MBS Session Binding + +MBS Session binding is the association of an AF Session information to one and only one MBS Session. When the PCF receives MBS Policy Association Create request or MBS Policy Association Update request from the MB-SMF and if the PCF does not receive MBS Service Information from the MB-SMF, the PCF shall perform MBS session binding and associate the MBS session with the existing IP data flows within the AF session information (and therefore the applicable MBS Policies). The PCF shall perform MBS session binding based on the MBS Session ID. For an MBS Session that is instance of a location-dependent MBS service, the Area Session Policy ID is used together with the MBS + +Session ID to associate the AF Session information with this MBS Session instance of a location-dependent MBS service in a specific MBS Service Area. + +### 6.5.2 MBS PCC rule Authorization for an MBS session + +The MBS PCC rule authorization is the selection of the 5G QoS parameters, described in clause 6.10.1 of 3GPP TS 23.247 [2], for the MBS PCC rule. The PCF may perform the MBS PCC rule authorization in the following situations: + +- When the MBS Service Information is received from the AF/NEF/MBSF. In this case, the MBS PCC rule authorization occurs at the reception of the information from the AF/NEF/MBSF. +- When the MBS Service Information is received from the MB-SMF. In this case, no session binding is performed. + +Using the authorization process, the PCF determines whether the broadcast and multicast service is authorized. If so, the MBS PCC rules are created, modified and/or removed. If the received MBS service information is not authorized, the PCF shall reject the request with an appropriate error status code . + +For the authorization of an MBS PCC rule, the PCF shall consider any 5GC specific restrictions, the MBS service information and other information available to the PCF (e.g. MBS Policy Control Data, operator policies). The PCF assigns an appropriate set of 5G QoS parameters (e.g. 5QI, QoS characteristics, ARP, GBR, MBR), that can be supported by the access network, to each MBS PCC rule. + +### 6.5.3 MBS QoS flow binding within an MBS session + +The MBS QoS flow binding is the association of the MBS PCC rule to an MBS QoS flow, identified by the QFI, within an MBS session. + +The MBS QoS flow binding function resides at the MB-SMF. This binding is performed using the following binding parameters: + +- 5QI; +- ARP; +- Priority Level (if available in the MBS PCC rule); +- Averaging Window (if available in the MBS PCC rule); and +- Maximum Data Burst Volume (if available in the MBS PCC rule). + +The selected MBS QoS flow shall have the same binding parameters (listed above) as the ones indicated by the MBS PCC rule. The set of 5G QoS parameters assigned by the PCF to the MBS service data flow is the main input for QFI allocation. + +The PCF shall supply the MBS PCC rule(s) to be installed, modified, or removed to the MB-SMF. The MB-SMF shall evaluate whether it is possible to use the existing MBS QoS flows or not, and if applicable. + +Whenever the binding parameters of an MBS PCC rule changes, the existing binding of this MBS PCC rule shall be re-evaluated, i.e. the MBS QoS flow binding procedure, is performed. The re-evaluation may, for an MBS PCC rule, result in a new binding with another MBS QoS flow. If the PCF requests the same change of the binding parameters values for all the MBS PCC rule(s) that are bound to the same MBS QoS Flow, the MB-SMF should not re-evaluate the binding of these MBS PCC rules, instead, the MB-SMF shall modify the QoS parameters values of the MBS QoS Flow accordingly. + +If an MBS PCC rule is removed, the MB-SMF shall remove the association of the MBS PCC rule to the MBS QoS flow to which the MBS PCC rule is associated. If the last MBS PCC rule that is bound to an MBS QoS Flow is removed, the MB-SMF shall delete the MBS QoS Flow. + +When an MBS QoS flow is removed, the MB-SMF shall report to the PCF that the MBS PCC rule(s) bound to this MBS QoS flow are removed. + +# --- 7 QoS Parameters Mapping + +## 7.1 Overview + +Several QoS parameters mapping functions are needed during PCC interaction. + +The main purpose of these mapping functions is the conversion of QoS parameters from one format to another. QoS information may be: + +- parts of a session description language (SDI), e.g. SDP, MPD; +- QoS parameters; and +- access specific QoS parameters. + +For PCC deployments not supporting MBS, QoS parameters mapping functions are located at the AF, PCF, SMF and UE and are described in this clause and the rest of clauses under clause 7. + +When PCC is deployed in an MBS architecture as defined in 3GPP TS 23.247 [54], QoS parameter mapping functions are defined as described in clause 7.5. + +One QoS mapping function is located at the AF, which maps the application specific information into the appropriate information that are carried over the Rx as specified in 3GPP TS 29.214 [18] or N5 interface as specified in 3GPP TS 29.514 [10]. + +For IMS, the AF may pass service information to the PCF over the Rx interface or over the N5 interface if the PCF and the P-CSCF support the "IMS\_SBI" feature. The AF derives information about the service from the SDI or from other sources. The mapping is application specific. If SDP (IETF RFC 4566 [16]) is used as SDI, the AF should apply the mapping described in clause 7.2. If MPD (3GPP TS 26.247 [17]) is used, the AF may apply the mapping described in Annex I in 3GPP TS 26.247 [17]. Clause 7.2 specifies the QoS parameter mapping functions at the AF. For IMS, the mapping rules in clause 7.2 shall be used at the P-CSCF. + +One QoS mapping function is located at the PCF, which maps the service information received over the Rx or N5 interface, or if the "GMEC" feature is supported, obtained from UDR into QoS parameters (e.g. 5QI, GBR, MBR, and ARP). This mapping is access independent. Clause 7.3 specifies the QoS mapping functions at the PCF applicable for all accesses. + +The mapping functions located at SMF is specified in clause 7.4. The mapping function in UE is implementation dependent and not specified within this specification. + +The PCF notes and authorizes the service data flows described within this service information by mapping from service information to Authorized QoS parameters for transfer to the SMF via the N7 interface. The SMF will map from the Authorized QoS parameters to the access specific QoS parameters. + +For 3GPP 5GS, the network sets up QoS flow(s) with a suitable QoS and indicates to the UE the QoS characteristics of those QoS flow(s). Therefore the flow of QoS related information will be unidirectional as indicated in the figure 7.1-1. + +![Figure 7.1-1: QoS mapping framework diagram showing the flow of QoS parameters between UE, SMF, AF, and PCF.](88b0f3f4393228e9ea4d6542aef7c399_img.jpg) + +The diagram illustrates the QoS mapping framework across four main entities: UE (User Equipment), SMF (SMF), AF (Application Function), and PCF (Policy Control Function). + +- UE (User Equipment):** Contains an **Application** block at the top. Below it is a dashed box containing three components: **Flow Service Manager**, **Translation / Mapping function**, and **Access-Specific Flow Service Manager**. These components are connected by vertical dashed double-headed arrows. +- AF (Application Function):** Contains two blocks: **1) SDI Mapping function** and **2) Policy Engine**. The SDI Mapping function is connected to the Application via a horizontal double-headed arrow labeled *AF session signalling , possibly with SDI*. The Policy Engine receives *Service information* from the SDI Mapping function via a downward arrow labeled **Rx or N5**. +- PCF (Policy Control Function):** Receives *Service information* from the AF and sends **Authorized QoS parameters** to the SMF via the **N7** interface. +- SMF (SMF):** Contains three blocks: **Flow Service Manager**, **3) Translation / Mapping function**, and **Access-Specific Flow Service Manager (NOTE)**. These are connected by vertical downward arrows. The SMF's Flow Service Manager receives **Authorized QoS parameters** from the PCF and sends **Authorized QoS parameters** to the UE's Flow Service Manager. The SMF's Translation / Mapping function receives **Authorized QoS parameters** from the SMF's Flow Service Manager and sends **Authorized Access-Specific QoS parameters** to the UE's Translation / Mapping function. The SMF's Access-Specific Flow Service Manager receives **Authorized Access-Specific QoS parameters** from the SMF's Translation / Mapping function and sends **Authorized Access-specific QoS parameters** to the UE's Access-Specific Flow Service Manager. +- LEGEND:** + - A double-headed arrow represents a **Signalling path**. + - A dashed box indicates components that are **Only for some PDU session Types and terminals**. + +Figure 7.1-1: QoS mapping framework diagram showing the flow of QoS parameters between UE, SMF, AF, and PCF. + +NOTE: Access Specific QoS parameters with Authorized Access-Specific QoS parameters comparison. + +**Figure 7.1-1: QoS mapping framework** + +1. The AF shall perform mapping from an SDI received within the AF session signalling to service information passed to the PCF over the Rx or N5 interface (see clause 7.2 if SDP is used as SDI). +2. The PCF shall perform mapping from the service information received over the Rx or N5 interface to the Authorized QoS parameters that shall be passed to the SMF via the N7 interface. The mapping is performed for each service data flow. The PCF combines per direction the individual Authorized QoS parameters per flow (see clause 7.3). +3. The SMF shall perform mapping from the Authorized QoS parameters received from PCF to the access specific QoS parameters. + +## 7.2 QoS parameter mapping Functions at AF + +### 7.2.1 Introduction + +The mapping described in this clause is mandatory for the P-CSCF and should also be applied by other AFs, if the SDI is SDP. + +When a session is initiated or modified the AF shall derive a Media-Component-Description AVP for Rx interface or a "MediaComponent" attribute for N5 interface from the SDP Parameters. If the CHEM feature is supported, the P-CSCF may provide the maximum packet loss rate(s) for uplink and/or downlink direction(s) in the Max-PLR-DL AVP and/or + +the Max-PLR-UL AVP for Rx interface respectively as defined in clause 7.2.2 or the "maxPacketLossRateUI" attribute and/or "maxPacketLossRateDI" attribute respectively as defined in clause 7.2.3. + +### 7.2.2 AF supporting Rx interface + +When the AF interworks with the PCF using the Rx interface, it shall derive a Media-Component-Description AVP from the SDP parameters for each SDP media component using the same mapping rules as defined in clause 6.2 of 3GPP TS 29.213 [30]. + +### 7.2.3 AF supporting N5 interface + +The mapping described in this clause is mandatory for the P-CSCF and should also be applied by other AFs, if the SDI is SDP. + +When a session is initiated or modified the P-CSCF shall use the mapping rules in table 7.2.3-1 for each SDP media component to derive a media component entry of the "medComponents" attribute from the SDP Parameters. The mapping shall not apply to media components where the SDP payload is proposing to use a circuit-switched bearer (i.e. "c=" line set to "PSTN" and an "m=" line set to "PSTN", refer to 3GPP TS 24.292 [35]). Circuit-switched bearer related media shall not be included in the service information sent to the PCF. + +###### **Table 7.2.3-1: Rules for derivation of service information within Media Component Description from SDP media component** + +| Service information per Media Component-Description
(see NOTE 1 and NOTE 7) | Derivation from SDP Parameters
(see NOTE 2) | +|----------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Media Component Number | ordinal number of the position of the "m=" line in the SDP | +| AF Application Identifier | The "afAppId" attribute may be supplied or omitted, depending on the application.
For IMS, if the "afAppId" attribute is supplied, its value should not demand application specific bandwidth or QoS characteristics handling unless the IMS application is capable of handling a QoS downgrading. | +| Media Type | The "medType" attribute shall be included with the same value as supplied for the media type in the "m=" line. | +| Flow Status | 
 IF port in m-line = 0 THEN   "fStatus" := REMOVED; ELSE   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN   (NOTE 9)     "fStatus" := ENABLED;   ELSE /* UDP or RTP/AVP transport     IF a=rtcp-mux is negotiated THEN       "fStatus" :=ENABLED; (NOTE 12 and 13)     ELSE       IF a=recvonly THEN         IF <SDP direction> = UE originated (NOTE 8) THEN           "fStatus" := ENABLED-DOWNLINK; (NOTE 4)         ELSE /* UE terminated (NOTE 8) */           "fStatus" := ENABLED-UPLINK; (NOTE 4)         ENDIF;       ELSE         IF a=sendonly THEN           IF <SDP direction> = UE originated (NOTE 8) THEN             "fStatus" := ENABLED-UPLINK; (NOTE 4)           ELSE /* UE terminated (NOTE 8) */             "fStatus" := ENABLED-DOWNLINK; (NOTE 4)           ENDIF;         ELSE           IF a=inactive THEN             "fStatus" :=DISABLED;           ELSE /* a=sendrecv or no direction attribute */             "fStatus" := ENABLED (NOTE 4)           ENDIF;         ENDIF;       ENDIF;     ENDIF;   ENDIF; ENDIF; (NOTE 5)
| + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max Requested Bandwidth-UL | 
 IF <SDP direction> = UE terminated (NOTE 8) THEN   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN     (NOTE 9)     IF a=recvonly or a=sendrecv or no direction attribute THEN       IF b=AS:<bandwidth> is present and         ( b=TIAS:<Tibandwidth> is not           present or is present but not supported ) THEN         "marBwUl" := <bandwidth> * 1000; /* Unit bit/s       ELSE         IF b=TIAS:<Tibandwidth> is present and supported THEN           "marBwUl" := <Transport-dependent bandwidth>           (NOTE 11) /* Unit bit/s         ELSE           "marBwUl" := <Operator specific setting>;         ENDIF;       ENDIF;     ELSE       "marBwUl" := <Operator specific setting>,         (NOTE 10)     ENDIF;   ELSE /* UDP or RTP/AVP transport     IF b=AS:<bandwidth> is present and       ( b=TIAS:<Tibandwidth> is not         present or is present but not supported ) THEN       IF a=rtcp-mux is negotiated (NOTE 13) THEN         IF b=RR:<rrbandwidth> is present           OR b=RS:<rsbandwidth> is present THEN           "marBwUl" := <bandwidth> * 1000 +             <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)         ELSE           "marBwUl" := <bandwidth> * 1050;           /* Unit is bit/s         ENDIF       ELSE         "marBwUl" := <bandwidth> * 1000;         /* Unit is bit/s       ENDIF;     ELSE       IF b=TIAS:<Tibandwidth> is present and supported THEN         IF a=rtcp-mux is negotiated (NOTE 13) THEN           IF b=RR:<rrbandwidth> is present             OR b=RS:<rsbandwidth> is present THEN             "marBwUl" :=               <Transport-dependent bandwidth> (NOTE 11) +               <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)           ELSE             "marBwUl" :=               <Transport-dependent bandwidth>               * 1.05 (NOTE 11) /* Unit bit/s           ENDIF         ELSE           "marBwUl" := <Transport-dependent bandwidth>           (NOTE 11) /* Unit bit/s         ENDIF;       ELSE         "marBwUl" := <Operator specific setting>,           or attribute not supplied;       ENDIF;     ENDIF;   ELSE     Consider SDP in opposite direction   ENDIF
| + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max Requested Bandwidth DL | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF Transport in m-line is "TCP" or "TCP/MSRP" or "UDP/DTLS/SCTP" THEN     (NOTE 9)     IF a=recvonly or a=sendrecv or no direction attribute THEN       IF b=AS:<bandwidth> is present and         ( b=TIAS:<Tibandwidth> is not present or          is present but not supported ) THEN           "marBwDl" := <bandwidth> * 1000; /* Unit bit/s         ELSE           IF b=TIAS:<Tibandwidth> is present and supported THEN             "marBwDl" := <Transport-dependant bandwidth>             /* Unit bit/s (see NOTE 11)             OR Operator specific setting           ELSE             "marBwDl" := <Operator specific setting>;           ENDIF;         ELSE           "marBwDl" := <Operator specific setting>,           (NOTE 10)         ENDIF;       ELSE /* UDP or RTP/AVP transport         IF b=AS:<bandwidth> is present and b=TIAS:<Tibandwidth> is not           present THEN             IF a=rtcp-mux is negotiated (NOTE 13) THEN               IF b=RR:<rrbandwidth> is present                 OR b=RS:<rsbandwidth> is present THEN                   "marBwDl" := <bandwidth> * 1000 +                   <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)                 ELSE                   "marBwDl" := <bandwidth> * 1050;                   /* Unit is bit/s                 ENDIF               ELSE                 "marBwDl" := <bandwidth> * 1000                 ;/* Unit is bit/s               ENDIF;             ELSE               IF b=TIAS:<Tibandwidth> is present THEN                 IF a=rtcp-mux is negotiated (NOTE 13) THEN                   IF b=RR:<rrbandwidth> is present                     OR b=RS:<rsbandwidth> is present THEN                       "marBwDl" :=                       <Transport-dependent bandwidth> (NOTE 11) +                       <rrbandwidth> + <rsbandwidth>; (NOTE 3; NOTE 6)                     ELSE                       "marBwDl" :=                       <Transport-dependent bandwidth>                       * 1.05 (NOTE 11) /* Unit bit/s                     ENDIF                   ELSE                     "marBwDl" := <Transport-dependent bandwidth>                     (NOTE 11) /* Unit bit/s                   ENDIF;                 ELSE                   "marBwDl" := <Operator specific setting>,                   or attribute not supplied;                 ENDIF;               ENDIF;             ELSE               Consider SDP in opposite direction             ENDIF           ENDIF;         ENDIF;       ENDIF;     ENDIF;   ENDIF;
| +| Max Supported Bandwidth-UL | 
 IF a=bw-info is present and includes MaxSupBw: <bandwidth> and direction:   recv (UE terminated) or send (UE originated) or sendrecv (NOTE 14) THEN     "maxSuppBwUl" := [supplied <bandwidth>] * 1000 /Unit bit/s/      (NOTE 16)   ELSE /* a=bw-info is not present or is present but MaxSupBw is not     included or direction is the opposite     Attribute not supplied   ENDIF;   (NOTE 15)
| + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Max Supported Bandwidth-DL | IF a=bw-info is present and includes MaxSupBw : and direction: send (UE terminated) or recv (UE originated) or sendrecv (NOTE 14) THEN
"maxSuppBwDl" := [supplied ] * 1000 /Unit bit/s/
(NOTE 16)
ELSE /* a=bw-info is not present or is present but MaxSupBw is not included or direction is the opposite
Attribute not supplied
ENDIF;
(NOTE 15) | +| Min Desired Bandwidth UL | IF a=bw-info is present and includes MinDesBw : and direction: recv (UE terminated) or send (UE originated) or sendrecv (NOTE 14) THEN
"minDesBwUl" := supplied * 1000 /Unit bit/s/
(NOTE 16)
ELSE /* a=bw-info is not present or is present but MinDesBw is not included or direction is the opposite
Attribute not supplied
ENDIF; | +| Min Desired Bandwidth DL | IF a=bw-info is present and includes MinDesBw : and direction: send (UE terminated) or recv (UE originated) or sendrecv (NOTE 14) THEN
"minDesBwDl" := [supplied ] * 1000 /Unit bit/s/
(NOTE 16)
ELSE /* a=bw-info is not present or is present but MinDesBw is not included or direction is the opposite
Attribute not supplied
ENDIF; | +| RR Bandwidth | IF b=RR: is present THEN
"rrBw" := ;
ELSE
Attribute not supplied
ENDIF;
(NOTE 3; NOTE 6) | +| RS Bandwidth | IF b=RS: is present THEN
"rsBw" := ;
ELSE
Attribute not supplied
ENDIF;
(NOTE 3; NOTE 6) | + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Media SubComponent | Supply one attribute for bidirectional combination of two corresponding IP flows, if available, and for each single IP flow without a corresponding IP flow in opposite direction.
If a media component comprises separate IP flows for RTP and RTCP, they are described in two separate Media SubComponent. However, if a=rtcp-mux is negotiated, RTP and RTCP use the same IP flow and shall be described in a single MediaSubComponent entry of the "medSubcomps" attribute.
The encoding of the "medSubcomps" attribute is described in table 6.2.2 | +| Reservation Priority | The AF may supply or omit the "resPrio" attribute. (NOTE 17) | +| Codec Data | The "codecs" are provisioned as specified in clause 5.6.2.7 of 3GPP TS 29.514 [10], including the codec-related information detailed in clause 5.6.3.2 of 3GPP TS 29.514 [10]. | +| Maximum Packet Loss Rate DL | 
 IF a= PLR_adapt line is NOT present in both SDP OFFER and ANSWER THEN   /* As UE don't support CHEM feature, AF should not use packet loss rates      in either the uplink or downlink direction */   maxPacketLossRateDl attribute not supplied ELSE   IF P-CSCF serving the OFFERER THEN     FOR each RTP payload type of the same media line       IF Maximum-e2e-PLR line is present in the SDP OFFER THEN         IF maxUL-PLR is present in the SDP ANSWER           maxPacketLossRateDl = value of maxe2e-PLR in the SDP OFFER - maxUL-PLR           in the SDP ANSWER         ELSE /* maxUL-PLR is not present in the SDP ANSWER */           MaxPacketLossRateDl = the default value is ½ maxe2e-PLR value         present           in the SDP OFFER         ELSE /* Maximum-e2e-PLR line is not present in the SDP OFFER */           IF maxUL-PLR is present in the SDP ANSWER THEN             maxPacketLossRateDl = (the default value is end-to-end Maximum               End-to-End Packet Loss Rate for the decoder of               the RTP payload type as recommended in 3GPP               TS 26.114 [14] clause X.1.2 for application               layer redundancy or X.1.1 for partial redundancy)               - maxUL-PLR in the SDP ANSWER           ELSE /* maxUL-PLR is not present in the SDP ANSWER */             maxPacketLossRateDl = the default value is ½ end-to-end Maximum           End-to-End             Packet Loss Rate for the decoder of the RTP payload             type as recommended in 3GPP TS 26.114 [14]             clause X.1.2 for application layer redundancy             or X.1.1 for partial redundancy           ENDIF;         ENDIF;       END FOR LOOP of each RTP payload type of the same media       maxPacketLossRateDl = maximum value of Max-PLR-DL among all the RTP       payload         types       ELSE /* For P-CSCF serving the ANSWERER */         FOR each RTP payload type of the same media line           IF Maximum-e2e-PLR line is present in the SDP ANSWER THEN             IF maxDL-PLR is present in the SDP ANSWER               maxPacketLossRateDl = value of maxDL-PLR in the SDP ANSWER             ELSE /* maxDL-PLR is not present in the SDP ANSWER */               maxPacketLossRateDl = the default value is ½ maxe2e-PLR value             present               in the SDP ANSWER             ELSE /* Maximum-e2e-PLR line is not present in the SDP ANSWER */               maxPacketLossRateDl = the default value is ½ end-to-end Maximum             End-to-End               Packet Loss Rate for the decoder of the RTP payload               type as recommended in 3GPP TS 26.114 [14]               clause X.1.2 for application layer redundancy               or X.1.1 for partial redundancy             ENDIF;           END FOR LOOP of each RTP payload type of the same media           maxPacketLossRateDl = maximum value of Max-PLR-DL among all the RTP           payload             types           ENDIF;         ENDIF;       ENDIF;     ENDIF;
| + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Packet Loss Rate UL | 
 IF a= PLR adapt line is NOT present in both SDP OFFER and ANSWER THEN   /* As UE don't support CHEM feature, AF should not use packet loss rates    in either the uplink or downlink direction */   maxPacketLossRateUl attribute not supplied ELSE   IF P-CSCF serving the OFFERER THEN     FOR each RTP payload type of the same media line       IF Maximum-e2e-PLR line is present in the SDP ANSWER THEN         IF maxDL-PLR is present in the SDP ANSWER           maxPacketLossRateUl = value of maxe2e-PLR in the SDP ANSWER - maxDL-PLR           in the SDP ANSWER         ELSE /* maxDL-PLR is not present in the SDP ANSWER */           maxPacketLossRateUl = the default value is ½ maxe2e-PLR value         present           in the SDP ANSWER         ELSE /* MAXimum-e2e-PLR line is not present in the SDP ANSWER */           maxPacketLossRateUl = the default value is ½ end-to-end Maximum         End-to-End           Packet Loss Rate for the decoder of the RTP payload           type as recommended in 3GPP TS 26.114 [14]           clause X.1.2 for Application layer redundancy           or X.1.1 for partial redundancy         ENDIF;       END FOR LOOP of each RTP payload type of the same media       maxPacketLossRateUl = maximum value of Max-PLR-UL among all the RTP       payload         types       ELSE /* For P-CSCF serving the ANSWERER */         FOR each RTP payload type of the same media line           IF MAXimum-e2e-PLR line is present in the SDP OFFER THEN             IF maxUL-PLR is present in the SDP ANSWER               maxPacketLossRateUl = value of maxUL-PLR in the SDP ANSWER             ELSE /* maxUL-PLR is not present in the SDP ANSWER */               maxPacketLossRateUl = the default value is ½ maxe2e-PLR value             present               in the SDP OFFER             ELSE /* MAXimum-e2e-PLR line is not present in the SDP OFFER */               maxPacketLossRateUl = the default value is ½ end-to-end Maximum             End-to-End               Packet Loss Rate for the decoder of the RTP payload               type as recommended in 3GPP TS 26.114 [14]               clause X.1.2 for Application layer redundancy               or X.1.1 for partial redundancy             ENDIF;           END FOR LOOP of each RTP payload type of the same media           maxPacketLossRateUl = maximum value of Max-PLR-UL among all the RTP           payload             types           ENDIF;         ENDIF;       ENDIF;     ENDIF;
| + +| Service information per Media Component-Description (see NOTE 1 and NOTE 7) | Derivation from SDP Parameters (see NOTE 2) | +|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Desired-Max-Latency | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "latency"     IF qos-hint-split-value for "local" is not present       "desMaxLatency" = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present       "desMaxLatency" = <qos-hint-split-value>     ENDIF   ELSE     Attribute not supplied   ENDIF ELSE /* <SDP direction> = UE terminated (NOTE 8)/   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "latency"     IF qos-hint-split-value for "local" is not present       "desMaxLatency" = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       "desMaxLatency" = <qos-hint-end-to-end-value> - <qos-hint-split-value>     ENDIF   ELSE     Attribute not supplied   ENDIF ENDIF
| +| Desired-Max-Loss | 
 IF <SDP direction> = UE originated (NOTE 8) THEN   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "loss"     IF qos-hint-split-value for "local" is not present       "desMaxLoss" = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       "desMaxLoss" = <qos-hint-split-value>     ENDIF   ELSE     Attribute not supplied   ENDIF ELSE /* <SDP direction> = UE terminated (NOTE 8)/   IF a=3gpp-qos-hint is present and includes a qos-hint-property that indicates "loss"     IF qos-hint-split-value for "local" is not present       "desMaxLoss" = <qos-hint-end-to-end-value>*0.5     ELSE /* qos-hint-split-value for "local" is present/       "desMaxLoss" = <qos-hint-end-to-end-value> - <qos-hint-split-value>     ENDIF   ELSE     Attribute not supplied   ENDIF ENDIF
| + +| Service information per
Media Component-
Description
(see NOTE 1 and NOTE 7) | Derivation from SDP Parameters
(see NOTE 2) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| NOTE 1: The encoding of the service information is defined in 3GPP TS 29.514 [10].
NOTE 2: The SDP parameters are described in IETF RFC 4566 [16].
NOTE 3: The "b=RS:" and "b=RR:" SDP bandwidth modifiers are defined in IETF RFC 3556 [36].
NOTE 4: As an operator policy to disable forward and/or backward early media, for media with UDP as transport protocol only the "fStatus" attribute may be downgraded by using the gate control procedures defined in the annex B of 3GPP TS 29.514 [10] before a SIP confirmed dialogue is established, i.e. until a 200 (OK) response to an INVITE request is received.
NOTE 5: If the SDP answer is available when the session information is derived, the direction attributes and port number from the SDP answer shall be used to derive the flow status. However, to enable interoperability with SIP clients that do not understand the inactive SDP attribute, if "a=inactive" was supplied in the SDP offer, this shall be used to derive the flow status. If the SDP answer is not available when the session information is derived, the direction attributes from the SDP offer shall be used.
NOTE 6: Information from the SDP answer is applicable, if available.
NOTE 7: The attributes may be omitted if they have been supplied in previous service information and have not changed, as detailed in 3GPP TS 29.514 [10].
NOTE 8: "Uplink SDP" indicates that the SDP was received from the UE and sent to the network. This is equivalent to = UE originated.
"Downlink SDP" indicates that the SDP was received from the network and sent to the UE. This is equivalent to = UE terminated.
NOTE 9: Support for TCP at a P-CSCF acting as AF is only required if services with TCP transport are used in the corresponding IMS system.
As an operator policy to disable forward and/or backward early media, for media with TCP as transport protocol, the "marBwUI"/"marBwDI" attribute values may be downgraded before a SIP confirmed dialogue is established, i.e. until a 200 (OK) response to an INVITE request is received. Only a small bandwidth in both directions is required in this case in order for TCP control packets to flow.
NOTE 10: TCP uses IP flows in the directionality opposite to the transferred media for feedback. To enable these flows, a small bandwidth in this direction is required.
NOTE 11: TIAS is defined in IETF RFC 3890 [37]. IETF RFC 3890 clause 6.4 provides procedures for converting TIAS to transport-dependant values. This procedure relies on the presence of maxprate (also defined in IETF RFC 3890).
NOTE 12: Multiplexed RTP/RTCP flows need to have "fStatus" attribute set to "ENABLED" in order to always permit the RTCP traffic.
NOTE 13: RTP/RTCP multiplexing is defined in IETF RFC 5761 [38].
NOTE 14: This attribute is derived from the SDP answer information and is omitted if E2EQOSMTSI feature is not supported.
NOTE 15: When both "b =" line and "a=bw-info" including MaxSupBw are present when sending the SDP, it is expected that the values are aligned.
NOTE 16: When the supplied bandwidth does not correspond to the bandwidth applicable to the IP version used by the UE, the AF shall re-compute it considering the IP version used by the UE as defined in 3GPP TS 26.114 [14].
NOTE 17: When the AF recognizes the need to request prioritized access to system resources, the AF shall include the "resPrio" attribute as described in 3GPP TS 29.514 [10]. Various mechanisms used by the P-CSCF to determine if the request is eligible for priority treatment are specified in clause 4.11 of 3GPP TS 24.229 [41] (e.g. based on the Resource Priority header field as described in IETF RFC 4412 [42] or a special dialstring contained in the SIP message). | | + +##### **Table 7.2.3-2: Rules for derivation of Media SubComponent from SDP media component** + +| Service information per Media SubComponent (see NOTE 1 and NOTE 5) | Derivation from SDP Parameters (see NOTE 2) | +|--------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow Number | The AF shall assign a number to the media subcomponent that is unique within the surrounding media component entries included in a "medComponents" attribute and for the entire lifetime of the AF session. The AF shall select the ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing downlink destination port numbers, if downlink destination port numbers are available. For uplink or inactive unicast media IP flows, a downlink destination port number is nevertheless available, if SDP offer-answer according to IETF RFC 3264 [43] is used. The AF shall select the ordinal number of the IP flow(s) within the "m=" line assigned in the order of increasing uplink destination port numbers, if no downlink destination port numbers are available. | +| Flow Status | Attribute not supplied | +| Max Requested Bandwidth UL | Attribute not supplied | +| Max Requested Bandwidth DL | Attribute not supplied | + +| | | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow Description |

For uplink and downlink direction, a Flow Description entry within the "fDescs" attribute shall be provided unless no IP Flows in this direction are described within the media component.

If UDP is used as transport protocol, the SDP direction attribute (NOTE 4) indicates the direction of the media IP flows within the media component as follows:

 IF a=recvonly THEN (NOTE 3)   IF <SDP direction> = UE originated (NOTE 7) THEN     Provide only downlink entry within the "fDescs" attribute   ELSE /* UE terminated (NOTE 7) */     Provide only uplink entry within "fDescs" attribute   ENDIF; ELSE   IF a=sendonly THEN (NOTE 3)     IF <SDP direction> = UE originated (NOTE 7) THEN       Provide only uplink entry within the "fDescs" attribute     ELSE /* UE terminated (NOTE 7) */       Provide only downlink entry within the "fDescs" attribute     ENDIF;   ELSE /* a=sendrecv or a=inactive or no direction attribute */     Provide uplink and downlink for "fDescs" attribute   ENDIF; ENDIF;

However, for RTCP and RTP/RTCP multiplexed IP flows uplink and downlink Flow Description entries within "fDescs" attribute shall be provided irrespective of the SDP direction attribute.

If TCP is used as transport protocol (NOTE 8), IP flows in uplink and downlink direction are described in SDP irrespective of the SDP direction attribute, as TCP uses an IP flow for feedback even if contents are transferred only in the opposite direction. Thus, both uplink and downlink Flow Description entries within "fDescs" attribute shall be provided.

The uplink destination address shall be copied from the "c=" line of downlink SDP. (NOTE 6) (NOTE 7)

The uplink destination port shall be derived from the "m=" line of downlink SDP. (NOTE 6) (NOTE 7) However, for TCP transport the uplink destination port shall be wildcarded, if the local UE is the passive endpoint (NOTE 9)

The downlink destination address shall be copied from the "c=" line of uplink SDP. (NOTE 6) However, a P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the downlink destination address using those procedures.

The downlink destination port shall be derived from the "m=" line of uplink SDP. (NOTE 6) (NOTE 7) However, for TCP transport the downlink destination port shall be wildcarded, if the local UE is the active endpoint (NOTE 9). A P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the downlink destination port using those procedures.

For IPv6, uplink and downlink source addresses shall either be derived from the prefix of the destination address or be wildcarded by setting to "any", as specified in 3GPP TS 29.514 [10]. However, a P-CSCF acting as AF and applying NAT traversal procedures in Annex B shall derive the uplink source address using those procedures.

If IPv4 is being utilized, the uplink source address shall either be set to the address contained in the "c=" line of the uplink SDP or be wildcarded, and the downlink source address shall either be set to the address contained in the "c=" line of the downlink SDP or be wildcarded. However, for TCP transport, if the local UE is the passive endpoint (NOTE 9), the uplink source address shall not be wildcarded. If the local UE is the active endpoint (NOTE 9), the downlink source address shall not be wildcarded. A P-CSCF acting as AF and applying NAT traversal procedures in Annex C shall derive the uplink source address using those procedures.

Source ports shall not be supplied. However, for TCP transport, if the local UE is the passive end point (NOTE 9), the uplink source port shall be derived from the "m=" line of the uplink SDP. If the local UE is the active end point (NOTE 9), the downlink source port shall be derived from the "m=" line of the downlink SDP. A P-CSCF acting as AF and applying NAT traversal procedures in Annex B shall derive the downlink source ports using those procedures.

Proto shall be derived from the transport of the "m=" line. For "UDP/DTLS/SCTP" as defined in IETF RFC 8864 [69] or "RTP/AVP", proto is 17(UDP). For "TCP", as defined in IETF RFC 4145 [39], or "TCP/MSRP", as defined in IETF RFC 4975 [40], proto is 6(TCP).

| +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| Service information per Media SubComponent (see NOTE 1 and NOTE 5) | Derivation from SDP Parameters (see NOTE 2) | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Flow Usage | The "flowUsage" attribute shall be supplied with value "RTCP" if the IP flow(s) described in the Media SubComponent are used to transport RTCP only. Otherwise the "flowUsage" attribute shall not be supplied. IETF RFC 4566 [16] specifies how RTCP flows are described within SDP. If the IP flows(s) are used to transport signalling the value should be "AF-SIGNALLING" | +| NOTE 1: The encoding of the service information is defined in 3GPP TS 29.514 [10].
NOTE 2: The SDP parameters are described in IETF RFC 4566 [16].
NOTE 3: If the SDP direction attribute for the media component negotiated in a previous offer-answer exchange was sendrecv, or if no direction attribute was provided, and the new SDP direction attribute sendonly or recvonly is negotiated in a subsequent SDP offer-answer exchange, uplink and downlink within the "fDescs" attribute shall be supplied.
NOTE 4: If the SDP answer is available when the session information is derived, the direction attributes from the SDP answer shall be used to derive the flow description. However, to enable interoperability with SIP clients that do not understand the inactive SDP attribute, if "a=inactive" was supplied in the SDP offer, this shall be used. If the SDP answer is not available when the session information is derived, the direction attributes from the SDP offer shall be used.
NOTE 5: The attributes may be omitted if they have been supplied in previous service information and have not changed, as detailed in 3GPP TS 29.514 [10].
NOTE 6: If the session information is derived from an SDP offer, the required SDP may not yet be available. The corresponding "fDescs" attribute shall nevertheless be included and the unavailable fields (possibly all) shall be wildcarded.
NOTE 7: "Uplink SDP" indicates that the SDP was received from the UE and sent to the network. This is equivalent to = UE originated.
"Downlink SDP" indicates that the SDP was received from the network and sent to the UE. This is equivalent to = UE terminated.
NOTE 8: Support for TCP at a P-CSCF acting as AF is only required if services with TCP transport are used in the corresponding IMS system.
NOTE 9: For TCP transport, the passive endpoints are derived from the SDP "a=setup" attribute according to the rules in IETF RFC 4145 [39], or, if that attribute is not present, from the rules in IETF RFC 4975 [40]. | | + +## 7.3 QoS parameter mapping Functions at PCF + +### 7.3.1 Introduction + +The QoS authorization process consists of the derivation of the parameters Authorized 5G QoS Identifier (5QI), Authorized Allocation and Retention Priority (ARP) and Authorized Maximum/Guaranteed Data Rate UL/DL. And such process also includes the derivation of the QoS Notification Control (QNC), Reflective QoS Indication (RQI), Priority Level (PL), Averaging Window (AW) and Maximum Data Burst Volume (MDBV). + +When a session is initiated or modified the PCF shall derive Authorized QoS parameters from the service information received from an AF supporting Rx interface or from an AF supporting N5 interface. + +When the "GMEC" feature is supported, the AF provides the requested QoS for a UE or group of UE(s) not identified by UE address(es) and the service information is stored in UDR as specified in 3GPP TS 29.519 [12], the PCF shall derive the Authorized QoS parameters from the obtained information from the UDR. + +### 7.3.2 PCF Interworking with an AF supporting Rx interface + +When the AF interworks with the PCF using the Rx interface, the session binding in the PCF shall be always associated to an IP session and the PCF shall derive IP QoS parameters for the related IP flows. + +In the case of SIP forking, the various forked responses may have different QoS requirements for the IP flows of the same media component. Each Authorized IP QoS Parameter should be set to the highest value requested for the IP flow(s) of that media component by any of the active forked responses. + +###### **Table 7.3.2-1: Rules for derivation of the Maximum Authorized Data Rates, Authorized Guaranteed Data Rates and Maximum Authorized QoS Class per service data flow or bidirectional combination of service data flows in the PCF** + +| Authorized QoS
Parameter | Derivation from service information
(see NOTE 4) | +|-------------------------------------|-------------------------------------------------------------| +|-------------------------------------|-------------------------------------------------------------| + +##### **Maximum Authorized Data Rate DL (Max\_DR\_DL) and UL (Max\_DR\_UL)** + +``` + +IF operator special policy exists THEN + Max_DR_UL:= as defined by operator specific algorithm; + Max_DR_DL:= as defined by operator specific algorithm; + +ELSE + + IF AF Application Identifier demands application specific data rate + handling THEN + Max_DR_UL:= as defined by application specific algorithm; + Max_DR_DL:= as defined by application specific algorithm; + + ELSE IF Codec Data provides Codec information for a codec that is + supported by a specific algorithm (NOTE 5, 12 and 13) THEN + Max_DR_UL:= as defined by specific algorithm; + Max_DR_DL:= as defined by specific algorithm; + + ELSE + IF not RTCP flow(s) according to Flow Usage THEN + IF Flow Status indicates "REMOVED" THEN + Max_DR_UL:= 0; + Max_DR_DL:= 0; + ELSE + IF Uplink Flow Description is supplied THEN + IF Maximum UL Supported Bandwidth is present and supported THEN + Max_DR_UL:= Maximum UL Supported Bandwidth; + ELSE IF Maximum UL Requested Bandwidth is present THEN + Max_DR_UL:= Maximum UL Requested Bandwidth; + ELSE + Max_DR_UL:= as set by the operator; + ENDIF; + ELSE + Max_DR_UL:= 0; + ENDIF; + + IF Downlink Flow Description is supplied THEN + IF Maximum DL Supported Bandwidth is present and supported THEN + Max_DR_DL:= Maximum DL Supported Bandwidth; + ELSE IF Maximum DL Requested Bandwidth is present THEN + Max_DR_DL:= Maximum DL Requested Bandwidth; + ELSE + Max_DR_DL:= as set by the operator; + ENDIF; + ELSE + Max_DR_DL:= 0; + ENDIF; + ENDIF; + ELSE /* RTCP IP flow(s) */ + IF RS Bandwidth is present and RR Bandwidth is present THEN + Max_DR_UL:= (RS Bandwidth + RR Bandwidth); + Max_DR_DL:= (RS Bandwidth + RR Bandwidth); + ELSE + IF Maximum UL Requested Bandwidth is present THEN + IF RS Bandwidth is present and RR Bandwidth is not present THEN + Max_DR_UL:= MAX[0.05 * Maximum UL Requested Bandwidth, RS Bandwidth]; + ENDIF; + + IF RS Bandwidth is not present and RR Bandwidth is present THEN + Max_DR_UL:= MAX[0.05 * Maximum UL Requested Bandwidth, RR Bandwidth]; + ENDIF; + + IF RS Bandwidth and RR Bandwidth are not present THEN + Max_DR_UL:= 0.05 * Maximum UL Requested Bandwidth; + ENDIF; + ELSE + Max_DR_UL:= as set by the operator; + ENDIF; + + IF Maximum DL Requested Bandwidth is present THEN + IF RS Bandwidth is present and RR Bandwidth is not present THEN + Max_DR_DL:= MAX[0.05 * Maximum DL Requested Bandwidth, RS Bandwidth]; + ENDIF; + + IF RS Bandwidth is not present and RR Bandwidth is present THEN + Max_DR_DL:= MAX[0.05 * Maximum DL Requested Bandwidth, RR Bandwidth]; + ENDIF; + ENDIF; + ENDIF; + ENDIF; + ENDIF; + +``` + +| Authorized QoS Parameter | Derivation from service information
(see NOTE 4) | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | 
    IF RS Bandwidth and RR Bandwidth are not present THEN       Max_DR_DL:= 0.05 * Maximum DL Requested Bandwidth;     ENDIF;      ELSE       Max_DR_DL:= as set by the operator;     ENDIF;    ENDIF; ENDIF; ENDIF; ENDIF;  IF SIP Forking Indication indicates "SEVERAL DIALOGUES" THEN   Max_DR_UL = MAX[Max_DR_UL, previous Max_DR_UL]   Max_DR_DL = MAX[Max_DR_DL, previous Max_DR_DL] ENDIF;
| + +| Authorized QoS Parameter | Derivation from service information
(see NOTE 4) | +|----------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized Guaranteed Data Rate DL (Gua_DR_DL) and UL (Gua_DR_UL) (see NOTE 6, 8, 9 and 10) | 
 IF operator special policy exists THEN   Gua_DR_UL:= as defined by operator specific algorithm;   Gua_DR_DL:= as defined by operator specific algorithm;  ELSE   IF AF Application Identifier demands application specific data rate handling THEN     Gua_DR_UL:= as defined by application specific algorithm;     Gua_DR_DL:= as defined by application specific algorithm;    ELSE IF Codec Data provides Codec information for a codec that is supported by a specific algorithm (NOTE 5, 12 and 13) THEN     Gua_DR_UL:= as defined by specific algorithm;     Gua_DR_DL:= as defined by specific algorithm;    ELSE     IF Uplink Flow Description is supplied THEN       IF Minimum UL Desired Bandwidth is present and supported THEN         Gua_DR_UL:= Minimum UL Desired Bandwidth;       ELSE IF Minimum UL Requested Bandwidth is present THEN         Gua_DR_UL:= Minimum UL Requested Bandwidth;       ELSE         Gua_DR_UL:= as set by the operator;       ENDIF;      ELSE       Gua_DR_UL:= Max_DR_UL;      ENDIF;      IF Downlink Flow Description is supplied THEN       IF Minimum DL Desired Bandwidth is present and supported THEN         Gua_DR_DL:= Minimum DL Desired Bandwidth;       ELSE IF Minimum DL Requested Bandwidth is present THEN         Gua_DR_DL:= Minimum DL Requested Bandwidth;       ELSE         Gua_DR_DL:= as set by the operator;       ENDIF;      ELSE       Gua_DR_DL:= Max_DR_DL;      ENDIF;   ENDIF; ENDIF;  IF SIP Forking Indication indicates "SEVERAL DIALOGUES" THEN   Gua_DR_UL = MAX[Gua_DR_UL, previous Gua_DR_UL]   Gua_DR_DL = MAX[Gua_DR_DL, previous Gua_DR_DL] ENDIF;
| + +| Authorized QoS Parameter | Derivation from service information
(see NOTE 4) | +|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized 5G QoS Identifier (5QI)
(see NOTE 1, 2, 3, 7, 14, 15, 17 and 19) | 
 IF an operator special policy exists THEN   5QI:= as defined by operator specific algorithm; (NOTE 18)  ELSE IF MPS Identifier demands MPS specific QoS Class handling THEN   5QI:= as defined by MPS specific algorithm (NOTE 11); ELSE IF AF Application Identifier demands application specific QoS Class handling THEN   5QI:= as defined by application specific algorithm;  ELSE IF FLUS-Identifier AVP demands specific QoS Class handling THEN   5QI:= as defined by specific algorithm; (NOTE 16)  ELSE IF Codec Data provides Codec information for a codec that is supported by a specific algorithm THEN   5QI:= as defined by specific algorithm; (NOTE 5) ELSE   /* The following 5QI derivation is an example of how to obtain the 5QI values in a 5GS network */   IF Media Type is present THEN     CASE Media Type OF       "audio": 5QI := 1;       "video": 5QI := 2;       "application": 5QI := 1 OR 2;     /* NOTE: include new media types here */      OTHERWISE: 5QI := 9;     /*e.g. for TCP-based generic traffic */    END;   ENDIF; ENDIF;  IF SIP Forking Indication indicates "SEVERAL DIALOGUES" THEN   5QI = MAX[5QI, previous 5QI] ENDIF ;
| + +| Authorized QoS Parameter | Derivation from service information
(see NOTE 4) | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The 5QI assigned to a RTCP IP flow is the same as for the corresponding RTP media IP flow. | +| NOTE 2: | When audio or video IP flow(s) are removed from a session, the 5QI shall keep the originally assigned value. | +| NOTE 3: | When audio or video IP flow(s) are added to a session, the PCF shall derive the 5QI taking into account the already existing media IP flow(s) within the session. | +| NOTE 4: | The encoding of the service information is defined in 3GPP TS 29.214 [18] and 3GPP TS 29.201 [15]. If AVPs are omitted within a Media Component Description or Media Subcomponent of the service information, the corresponding information from previous service information shall be used, as specified in 3GPP TS 29.214 [18] and 3GPP TS 29.201 [15]. | +| NOTE 5: | 3GPP TS 26.234 [19], 3GPP TS 26.114 [14], 3GPP2 C.S0046 [20], and 3GPP2 C.S0055 [21] contain examples of QoS parameters for codecs of interest. The support of any codec specific algorithm in the PCF is optional. | +| NOTE 6: | Authorized Guaranteed Data Rate DL and UL shall not be derived for non-GBR 5QI values. | +| NOTE 7: | Recommended 5QI values for standardised 5QI characteristics are shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 8: | The PCF may be configured with operator specific preconditions for setting the Authorized Guaranteed Data Rate lower than the corresponding Maximum Authorized Data Rate. | +| NOTE 9: | For certain services (e.g. DASH services according to 3GPP TS 26.247 [17]), the AF may also provide a minimum required bandwidth so that the PCF can derive an Authorized Guaranteed Data Rate lower than the Maximum Authorized Data Rate. | +| NOTE 10: | For 5GS, the PCF shall assign an Authorized Guaranteed Data Rate UL/DL value within the limit supported by the serving network. | +| NOTE 11: | The MPS specific algorithm shall consider various inputs, including the received MPS Identifier and Reservation Priority, for deriving the 5QI. | +| NOTE 12: | When multiple codecs are supported per media stream (e.g. as part of multi-stream multiparty conferencing media handling are negotiated as described in 3GPP TS 26.114 [14]) the codec specific algorithm shall consider the bandwidth related to each codec when calculating the total bandwidth. | +| NOTE 13: | 3GPP TS 26.114 [14] contains examples of how the Authorized Guaranteed Data Rate and Maximum Authorized Data Rate are assumed to be derived for multi-party multimedia conference media handling support. The support of this behaviour is optional. | +| NOTE 14: | The PCF may authorize a non-standardized 5QI with explicitly signalled QoS characteristics as defined in clause 4.2.6.6.3 of 3GPP TS 29.512 [9] or may assign QoS characteristics (e.g. Priority Level, Averaging Window, and Maximum Data Burst Volume) to be used instead of the default QoS characteristics associated with a standardised 5QI value as shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 15: | In a network where SRVCC is enabled, the 5QI=1 shall be used for IMS services in accordance to 3GPP TS 23.216 [44]. Non-IMS services using 5QI=1 may suffer service interruption and/or inconsistent service experience if SRVCC is triggered. Triggering SRVCC for WebRTC IMS session will cause service interruption and/or inconsistent service experience when using 5QI=1. Operator policy (e.g. use of specific AF application identifier) may be used to avoid using 5QI 1 for a voice service, e.g. WebRTC IMS session. | +| NOTE 16: | The "live" uplink streaming algorithm may consider various inputs, including the received FLUS-Identifier AVP, Desired-Max-Latency AVP, Desired-Max-Loss AVP, AF-Application-Identifier and Media-Type AVP for deriving the 5QI. When Desired-Max-Latency AVP and/or Desired-Max-Loss AVP are present, non-authority 5QI mapping may be done according to table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 17: | The algorithm to support applications with specific QoS hints (e.g. loss and/or latency demands) may consider various inputs, including the received Desired-Max-Latency AVP, Desired-Max-Loss AVP and AF-Application-Identifier AVP for deriving the 5QI, as shown in table E.0 in 3GPP TS 26.114 [14]. Non-authority 5QI mapping may be done according to table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 18: | Operator specific policies may consider access information for policy decision. E.g., in a network where the PDU session can be carried over NR satellite access or satellite backhaul, the PCF may take this information into account (together with any delay requirements provided by the AF) to determine the applicable policy decision, as e.g. the 5QI value. | +| NOTE 19: | 3GPP TS 26.114 [14] contains examples on how 5QI may be derived for data channel media type | + +The PCF should per ongoing session store the Authorized QoS parameters for each service data flow or bidirectional combination of service data flows (as described within a Media Subcomponent). + +If the PCF provides a QoS information associated to a PCC rule it may apply the rules in table 7.3.2-2 to combine the Authorized QoS per service data flow or bidirectional combination of service data flows (as derived according to table 7.3.2-1) for all service data flows described by the corresponding PCC rule. + +If the PCF provides a QoS information associated to a PDU session (i.e. QoS flow with default QoS rule), it may apply the rules in table 7.3.2-2 to combine the Authorized QoS per service data flow or bidirectional combination of service data flows (as derived according to table 7.3.2-1) for all service data flows allowed to be transported within the PDU session. It is recommended that the rules in table 7.3.2-2 are applied for all service data flows with corresponding AF + +session. The PCF may increase the authorized QoS further to take into account the requirements of predefined PCC rules without ongoing AF sessions. + +NOTE 1: For home-routed scenarios, if the "VPLMN-QoS-Control" feature as defined in 3GPP TS 29.512 [9] is supported, if the PCF applies the rules in table 7.3.2-2 to calculate the authorized QoS to be transported within the PDU session, the PCF can adapt the authorized QoS associated to the PDU session to take into account the values that can be accepted by the VPLMN. + +NOTE 2: QoS Information related to Maximum Authorized UL/DL Data Rate provided at PDU session level is not derived based on mapping tables in this clause, but based on subscription and operator specific policies. + +NOTE 3: ARP is always calculated at PCC rule level according to table 7.3.2-2. + +**Table 7.3.2-2: Rules for calculating the Maximum Authorized/Guaranteed Data Rates, 5QI and ARP in the PCF** + +| Authorized QoS Parameter | Calculation Rule | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL and UL | Maximum Authorized Data Rate DL/UL is the sum of all Maximum Authorized Data Rate DL/UL for all the service data flows or bidirectional combinations of service data flows (as according to table 7.3.2-1). | +| Guaranteed Authorized Data Rate DL and UL (NOTE 3) | Guaranteed Authorized Data Rate DL/UL is the sum of all Guaranteed Authorized Data Rate DL/UL for all the service data flows or bidirectional combinations of service data flows (as according to table 7.3.2-1). | +| 5QI | 5QI = MAX [needed QoS parameters per service data flow or bidirectional combination of service data flows (as operator's defined criteria) among all the service data flows or bidirectional combinations of service data flows.] | +| ARP (NOTE 1) | 
 IF an operator special policy exists THEN   ARP:= as defined by operator specific algorithm;  ELSE IF MPS Identifier demands MPS specific ARP handling THEN   ARP:= as defined by MPS specific algorithm (NOTE 2); ELSE IF AF Application Identifier demands application specific ARP handling THEN   ARP:= as defined by application specific algorithm; ELSE IF Reservation Priority demands application specific ARP handling THEN   ARP:= as defined by application specific algorithm; ENDIF;
| +| NOTE 1: The ARP priority levels 1-8 should only be assigned to resources for services that are authorized to receive prioritized treatment within an operator domain. | | +| NOTE 2: The MPS specific algorithm shall consider various inputs, including the received MPS Identifier and Reservation Priority, for deriving the ARP. | | +| NOTE 3: The PCF may check that the Guaranteed Authorized Data Rate DL/UL does not exceed the limit supported by the serving network to minimize the risk of rejection of the bearer by the serving network. | | + +### 7.3.3 PCF Interworking with an AF supporting N5 interface + +When the AF interworks with the PCF using the N5 interface, the session binding in the PCF shall be associated to an IP session or an Ethernet session, and the PCF shall derive QoS parameters for the related data flows. + +**Table 7.3.3-1: Rules for derivation of the Maximum Authorized Data Rates, Authorized Guaranteed Data Rates, Maximum Authorized QoS Class and other authorized QoS parameters per service data flow or bidirectional combination of service data flows in the PCF** + +| Authorized QoS
Parameter | Derivation from service information
(NOTE 4) | +|-------------------------------------|---------------------------------------------------------| +|-------------------------------------|---------------------------------------------------------| + +| | | +|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL (Max_DR_DL) and UL (Max_DR_UL) | 
 IF operator special policy exists THEN   Max_DR_UL:= as defined by operator specific algorithm;   Max_DR_DL:= as defined by operator specific algorithm;   (NOTE 8, 9 and 10) ELSE IF afAppId attribute of MediaComponent data type demands application   specific data rate handling THEN   Max_DR_UL:= as defined by application specific algorithm;   Max_DR_DL:= as defined by application specific algorithm; ELSE IF codecs attribute of MediaComponent data type provides Codec   information for a codec that is supported by a specific algorithm   (NOTE 5) THEN   Max_DR_UL:= as defined by specific algorithm;   Max_DR_DL:= as defined by specific algorithm; ELSE IF the qosReference attribute of MediaComponent data type corresponds   to a pre-defined QoS information set THEN   Max_DR_UL:= as configured by operator   Max_DR_DL:= as configured by operator; ELSE   IF not RTCP flow(s) according to flowUsage attribute of     MediaSubComponent data type THEN     IF fStatus attribute indicates "REMOVED" THEN       Max_DR_UL:= 0;       Max_DR_DL:= 0;     ELSE       IF Uplink Flow Description is supplied within the fDescs attribute         of the MediaSubComponent data type THEN         IF marBwUl attribute is present THEN           Max_DR_UL:= marBwUl value;         ELSE           Max_DR_UL:= as set by the operator;         ENDIF;       ELSE         Max_DR_UL:= 0;       ENDIF;       IF Downlink Flow Description is supplied within the fDescs attribute         of the MediaSubComponent data type THEN         IF marBwDl attribute is present THEN           Max_DR_DL:= marBwDl value;         ELSE           Max_DR_DL:= as set by the operator;         ENDIF;       ELSE         Max_DR_DL:= 0;       ENDIF;     ENDIF;   ELSE /* RTCP IP flow(s) */     IF fStatus attribute indicates "REMOVED" THEN       Max_DR_UL:= 0;       Max_DR_DL:= 0;     ELSE       IF Uplink Flow Description is supplied within the fDescs attribute         of the MediaSubComponent data type THEN         IF marBwUl attribute is present within the MediaSubComponent data           type THEN           Max_DR_UL:= marBwUl;         ELSEIF marBwUl attribute is present within the MediaComponent           data type THEN           Max_DR_UL:= 0.05 * marBwUl value;         ELSE           Max_DR_UL:= as set by the operator;         ENDIF;       ELSE         Max_DR_UL:= 0;       ENDIF;       IF Downlink Flow Description is supplied within the fDescs attribute         of the MediaSubComponent data type THEN         IF marBwDl attribute is present within the MediaSubComponent data           type THEN           Max_DR_DL:= marBwDl;         ELSEIF marBwDl attribute is present within the MediaComponent           data type THEN           Max_DR_DL:= 0.05 * marBwDl value;         ELSE           Max_DR_DL:= as set by the operator;         ENDIF;       ELSE         Max_DR_DL:= 0;       ENDIF;     ENDIF;   ENDIF;
| +|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| Authorized QoS
Parameter | Derivation from service information
(NOTE 4) | +|-----------------------------|-------------------------------------------------| +| | ENDIF;
ENDIF;
ENDIF; | + +| Authorized QoS Parameter | Derivation from service information
(NOTE 4) | +|--------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized Guaranteed Data Rate DL (Gua_DR_DL) and UL (Gua_DR_UL) | 
 IF operator special policy exists THEN   Gua_DR_UL:= as defined by operator specific algorithm;   Gua_DR_DL:= as defined by operator specific algorithm;  ELSE IF afAppId attribute of MediaComponent data type demands application specific data rate handling THEN   Gua_DR_UL:= as defined by application specific algorithm;   Gua_DR_DL:= as defined by application specific algorithm; ELSE IF codecs attribute of MediaComponent data type provides Codec information for a codec that is supported by a specific algorithm (NOTE 5) THEN   Gua_DR_UL:= as defined by specific algorithm;   Gua_DR_DL:= as defined by specific algorithm; ELSE IF the qosReference attribute of MediaComponent data type corresponds to a pre-defined QoS information set THEN   Gua_DR_UL:= as configured by operator   Gua_DR_DL:= as configured by operator; ELSE IF the altSerReqs attribute of MediaComponent data type corresponds to a list of pre-defined QoS information set THEN for each pre-defined QoS information set:   Gua_DR_UL:= as configured by operator;   Gua_DR_DL:= as configured by operator; (NOTE 16) ELSE IF the altSerReqsData attribute of MediaComponent data type corresponds to a list of alternative service requirements that include Requested Alternative QoS parameter Set(s) THEN for each QoS information set:   Gua_DR_UL:= gbrUl value;   Gua_DR_DL:= gbrDl value (NOTE 16); ELSE IF fStatus attribute indicates "REMOVED" THEN   Gua_DR_UL:= 0;   Gua_DR_DL:= 0; ELSE   IF Uplink Flow Description is supplied within the fDescs attribute of the MediaSubComponent data type THEN     IF mirBwUl attribute is present THEN       Gua_DR_UL:= mirBwUl value;     ELSE IF corresponding operator policy exists       Gua_DR_UL:= as set by the operator;     ELSE       Gua_DR_UL:= Max_DR_UL;     ENDIF;   ELSE     Gua_DR_UL:= 0;   ENDIF;   IF Downlink Flow Description is supplied within the fDescs attribute of the MediaSubComponent data type THEN     IF mirBwDl attribute is present THEN       Gua_DR_DL:= mirBwDl value;     ELSE IF corresponding operator policy exists       Gua_DR_DL:= as set by the operator;     ELSE       Gua_DR_DL:= Max_DR_DL;     ENDIF;   ELSE     Gua_DR_DL:= 0;   ENDIF;   ENDIF; ENDIF;
| + +| Authorized QoS Parameter | Derivation from service information
(NOTE 4) | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized 5G QoS Identifier (5QI)
(see NOTE 1, 2, 3, 7, 12, 14, 17 and 19) | 
 IF an operator special policy exists THEN   5QI:= as defined by operator specific algorithm; (NOTE 18) ELSE IF mpsId attribute demands MPS specific QoS Class handling THEN   5QI:= as defined by MPS specific algorithm (NOTE 11); ELSE IF mcsId attribute demands MCS specific QoS Class handling THEN   5QI:= as defined by MCS specific algorithm (NOTE 13); ELSE IF afAppId attribute of MediaComponent data type demands application specific QoS Class handling THEN   5QI:= as defined by application specific algorithm; ELSE IF flusId attribute demands specific QoS Class handling THEN   5QI:= as defined by specific algorithm; (NOTE 15) ELSE IF codecs attribute of MediaComponent data type provides Codec information for a codec that is supported by a specific algorithm THEN   5QI:= as defined by specific algorithm; (NOTE 5) ELSE IF the qosReference attribute of MediaComponent data type corresponds to a pre-defined QoS information set THEN   5QI:= as configured by operator; ELSE   /* The following 5QI derivation is an example of how to obtain the 5QI values in a 5GS network */   IF the medType attribute of MediaComponent data type is present THEN     CASE medType value OF       "audio": 5QI := 1;       "video": 5QI := 2;       "application": 5QI := 1 OR 2;       OTHERWISE: 5QI := 9; /*e.g. for TCP-based generic traffic */     ENDIF;   ENDIF; ENDIF;
| +| Authorized Packet Delay Budget (PDB) for Alternative QoS parameter Sets | 
 IF the altSerReqs attribute of MediaComponent data type corresponds to a list of pre-defined QoS information set THEN for each pre-defined QoS information set:   PDB:= as configured by operator; (NOTE 16) ELSE IF the altSerReqsData attribute of MediaComponent data type corresponds to a list of alternative service requirements that include Requested Alternative QoS parameter Set(s) THEN for each QoS information set:   PDB:= pdb value; ENDIF;
| +| Authorized Packet Error Rate (PER) for Alternative QoS parameter Sets | 
 IF the altSerReqs attribute of MediaComponent data type corresponds to a list of pre-defined QoS information set THEN for each pre-defined QoS information set:   PER:= as configured by operator; (NOTE 16) ENDIF;
| + +| Authorized QoS Parameter | Derivation from service information (NOTE 4) | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The 5QI assigned to a RTCP IP flow is the same as for the corresponding RTP media IP flow. | +| NOTE 2: | When audio or video IP flow(s) are removed from a session, the 5QI shall keep the originally assigned value. | +| NOTE 3: | When audio or video IP flow(s) are added to a session, the PCF shall derive the 5QI taking into account the already existing media IP flow(s) within the session. | +| NOTE 4: | The encoding of the service information is defined in 3GPP TS 29.514 [10]. | +| NOTE 5: | 3GPP TS 26.234 [19], 3GPP TS 26.114 [14], 3GPP2 C.S0046 [20], and 3GPP2 C.S0055 [21] contain examples of QoS parameters for codecs of interest. The support of any codec specific algorithm in the PCF is optional. | +| NOTE 6: | Authorized Guaranteed Data Rate DL and UL shall not be derived for non-GBR 5QI values. | +| NOTE 7: | Recommended 5QI values for standardised 5QI characteristics are shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 8: | The PCF may be configured with operator specific preconditions for setting the Authorized Guaranteed Data Rate lower than the corresponding Maximum Authorized Data Rate. | +| NOTE 9: | For certain services (e.g. DASH services according to 3GPP TS 26.247 [17]), the AF may also provide a minimum required bandwidth so that the PCF can derive an Authorized Guaranteed Data Rate lower than the Maximum Authorized Data Rate. | +| NOTE 10: | The PCF shall assign an Authorized Guaranteed Data Rate UL/DL value within the limit supported by the serving network. | +| NOTE 11: | The MPS specific algorithm shall consider various inputs, including the received mpsId and resPrio attributes, for deriving the 5QI. | +| NOTE 12: | The PCF may authorize a non-standardized 5QI with explicitly signalled QoS characteristics as defined in clause 4.2.6.6.3 of 3GPP TS 29.512 [9] or may assign QoS characteristics (e.g. Priority Level, Averaging Window, and Maximum Data Burst Volume) to be used instead of the default QoS characteristics associated with a standardised 5QI value as shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 13: | The MCS specific algorithm shall consider various inputs, including the received mcsId and resPrio attributes, for deriving the 5QI. | +| NOTE 14: | In a network where SRVCC is enabled, the 5QI=1 shall be used for IMS services in accordance to 3GPP TS 23.216 [44]. Non-IMS services using 5QI=1 may suffer service interruption and/or inconsistent service experience if SRVCC is triggered. Triggering SRVCC for WebRTC IMS session will cause service interruption and/or inconsistent service experience when using 5QI=1. Operator policy (e.g. use of specific AF application identifier) may be used to avoid using 5QI 1 for a voice service, e.g. WebRTC IMS session. | +| NOTE 15: | The "live" uplink streaming algorithm may consider various inputs, including the received flusId attribute, desMaxLatency attribute, desMaxLoss attribute, afAppId attribute and medType attribute for deriving the 5QI. When desMaxLatency attribute and/or desMaxLoss attribute are present, non-authority 5QI mapping may be done according to table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 16: | The PCF may authorize one or more alternative parameter set(s) if the alternative QoS reference(s) or Requested Alternative QoS parameter Set(s) is received. | +| NOTE 17: | The algorithm to support applications with specific QoS hints (e.g. loss and/or latency demands) may consider various inputs, including the received desMaxLatency attribute, desMaxLoss attribute and afAppId attribute for deriving the 5QI, as shown in table E.0 in 3GPP TS 26.114 [14]. Non-authority 5QI mapping may be done according to table 5.7.4-1 in 3GPP TS 23.501 [2]. | +| NOTE 18: | Operator specific policies may consider access information for policy decision. E.g., in a network where the PDU session can be carried over NR satellite access or satellite backhaul, the PCF may take this information into account (together with any delay requirements provided by the AF) to determine the applicable policy decision, as e.g. the 5QI value. | +| NOTE 19: | 3GPP TS 26.114 [14] contains examples on how 5QI may be derived for data channel media type | + +The PCF should per ongoing session store the Authorized QoS parameters for each service data flow or bidirectional combination of service data flows (as described within a medComponents attribute). + +If the PCF provides a QoS information associated to a PCC rule it may apply the rules in table 7.3.3-2 to combine the Authorized QoS per service data flow or bidirectional combination of service data flows (as derived according to table 7.3.3-1) for all service data flows described by the corresponding PCC rule. + +If the PCF provides a QoS information associated to a PDU session (i.e. QoS flow with default QoS rule), it may apply the rules in table 7.3.3-2 to combine the Authorized QoS per service data flow or bidirectional combination of service data flows (as derived according to table 7.3.3-1) for all service data flows allowed to be transported within the PDU session. It is recommended that the rules in table 7.3.3-2 are applied for all service data flows with corresponding AF session. The PCF may increase the authorized QoS further to take into account the requirements of predefined PCC rules without ongoing AF sessions. + +NOTE 1: For home-routed scenarios, if the "VPLMN-QoS-Control" feature as defined in 3GPP TS 29.512 [9] is supported, if the PCF applies the rules in table 7.3.2-2 to calculate the authorized QoS to be transported within the PDU session, the PCF can adapt the authorized QoS associated to the PDU session to take into account the values that can be accepted by the VPLMN. + +NOTE 2: QoS Information related to Maximum Authorized UL/DL Data Rate provided at PDU session level is not derived based on mapping tables in this clause, but based on subscription and operator specific policies. + +NOTE 3: ARP is always calculated at PCC rule level according to table 7.3.3-2. + +**Table 7.3.3-2: Rules for calculating the Maximum Authorized/Guaranteed Data Rates, 5QI and ARP in the PCF** + +| Authorized QoS Parameter | Calculation Rule | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL and UL | Maximum Authorized Data Rate DL/UL is the sum of all Maximum Authorized Data Rate DL/UL for all the service data flows or bidirectional combinations of service data flows (as according to table 7.3.3-1). | +| Guaranteed Authorized Data Rate DL and UL | Guaranteed Authorized Data Rate DL/UL is the sum of all Guaranteed Authorized Data Rate DL/UL for all the service data flows or bidirectional combinations of service data flows (as according to table 7.3.3-1). (NOTE 3) | +| 5QI | 5QI = MAX [needed QoS parameters per service data flow or bidirectional combination of service data flows (as operator's defined criteria) among all the service data flows or bidirectional combinations of service data flows.] | +| ARP | IF an operator special policy exists THEN
ARP:= as defined by operator specific algorithm;
ELSE IF mpsId attribute demands MPS specific ARP handling THEN
ARP:= as defined by MPS specific algorithm (NOTE 2);
ELSE IF mcsId attribute demands MCS specific ARP handling THEN
ARP:= as defined by MCS specific algorithm (NOTE 4);
ELSE IF afAppId attribute of MediaComponent data type demands application specific ARP handling THEN
ARP:= as defined by application specific algorithm;
ELSE IF resPrio attribute of MediaComponent data type demands application specific ARP handling THEN
ARP:= as defined by application specific algorithm;
ELSE IF the qosReference attribute of MediaComponent data type corresponds to a pre-defined QoS information set THEN
ARP:= as configured by operator
ENDIF;
(NOTE 1) | +| NOTE 1: The ARP priority levels 1-8 should only be assigned to resources for services that are authorized to receive prioritized treatment within an operator domain. | | +| NOTE 2: The MPS specific algorithm shall consider various inputs, including the received mpsId and resPrio attributes, for deriving the ARP. | | +| NOTE 3: The PCF may check that the Guaranteed Authorized Data Rate DL/UL does not exceed the limit supported by the serving network to minimize the risk of rejection of the bearer by the serving network. | | +| NOTE 4: The MCS specific algorithm shall consider various inputs, including the received mcsId and resPrio attributes, for deriving the ARP. | | + +## 7.4 QoS parameter mapping Functions at SMF + +### 7.4.1 QoS parameter mapping Functions in 5GC + +**Table 7.4.1.1: Rules for derivation of the Authorized QoS Parameters per QoS flow from the Authorized QoS Parameters in SMF** + +| Authorized QoS Parameter per QoS flow (NOTE) | Derivation from Authorized QoS Parameters | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL and UL per QoS flow | Maximum Authorized Bandwidth DL/UL per QoS flow = Sum of Maximum Authorized Data Rate DL/UL for all PCC rules bound to that QoS flow.
For PCC rules which are bound to the same QoS flow and have the same sharing key value, the highest MBR value among those PCC rules may be used as input for calculating the common MBR value based on internal logic as defined in clause 4.2.6.2.8 of 3GPP TS 29.512 [9]. | +| Guaranteed Authorized Data Rate DL and UL per QoS flow | Guaranteed Authorized Data Rate DL/UL per QoS flow = Sum of Guaranteed Authorized Data Rate DL/UL for all PCC rules bound to that QoS flow.
For PCC rules which are bound to the same QoS flow and have the same sharing key value, the highest GBR value among those PCC rules shall be used as input for calculating the common GBR value as defined in clause 4.2.6.2.8 of 3GPP TS 29.512 [9]. | +| Session-AMBR DL and UL | For all non-GBR QoS flows, Session-AMBR DL/UL is applied. | +| 5QI | 5QI from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. | +| ARP | ARP from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. | +| QNC | QNC from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. | +| Priority Level (PL) | PL from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. | +| Averaging Window (AW) | AW from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. Applicable for GBR or delay critical GBR QoS flow. | +| Maximum Data Burst Volume (MDBV) | MDBV from PCC rules having the same value combination of 5QI/ARP/QNC/PL/AW/MDBV is used. Applicable for delay critical GBR QoS flow. | +| RQI | RQI from PCC rules is used per service data flow. Applicable for non-GBR QoS flows. | +| Maximum Packet Loss Rate DL and UL per QoS flow | Maximum packet loss rate DL/UL among all PCC rules bound to that QoS flow. Applicable for GBR QoS flows. | +| Alternative QoS Profiles | Alternative QoS profiles per QoS flow = Alternative QoS Parameter Sets of the PCC rule. The PCC rule is bound to a new QoS flow and no other PCC rule is bound to the QoS flow. Applicable for GBR QoS flows. | +| NOTE: For unstructured PDU session type, only default 5QI and ARP of the QoS Flow associated with the default QoS rule, and Session-AMBR are applicable. | | + +### 7.4.2 QoS parameter mapping Functions at SMF+PGW-C for interworking scenario + +**Table 7.4.2.1: Rules for derivation of the Authorized QoS Parameters per EPS bearer from the Authorized QoS Parameters in SMF+PGW-C** + +| Authorized QoS Parameter per EPS bearer | Derivation from Authorized QoS Parameters (NOTE 2) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL and UL per EPS bearer | Maximum Authorized Bandwidth DL/UL per EPS bearer = Sum of Maximum Authorized Data Rate DL/UL for all PCC rules bound to that EPS bearer as described in clause 4.5.5.3 of 3GPP TS 29.212 [53].
For PCC rules which are bound to the same EPS bearer and have the same sharing key value, the highest MBR value among those PCC rules may be used as input for calculating the common MBR value based on internal logic as defined in clause 4.5.5.11 of 3GPP TS 29.212 [53]. | +| Guaranteed Authorized Data Rate DL and UL per QoS flow | Guaranteed Authorized Data Rate DL/UL per EPS bearer = Sum of Guaranteed Authorized Data Rate DL/UL for all PCC rules bound to that EPS bearer as described in clause 4.5.5.3 of 3GPP TS 29.212 [53].
For PCC rules which are bound to the same EPS bearer and have the same sharing key value, the highest GBR value among those PCC rules shall be used as input for calculating the common GBR value as defined in clause 4.5.5.11 of 3GPP TS 29.212 [53]. | +| APN-AMBR DL and UL | Set according to the operator policy. | +| QCI (NOTE 1) | For standardized 5QIs, the authorized QCI is one to one mapped from the 5QI;
For non-standardized 5QIs, the authorized QCI is derived based on the authorized 5QI and operator policy;
For the subscribed default 5QI, one to one map the subscribed default QCI to the subscribed default 5QI. | +| ARP | One to one mapping to the value derived as described in table 7.4.1.1. | +| Maximum Packet Loss Rate DL and UL per EPS bearer | One to one mapping to the value derived as described in table 7.4.1.1. | +| NOTE 1 The delay critical 5QI mapping to QCI is upspecified in the present specification. | | +| NOTE 2 Other Authorized QoS parameters that do not have a corresponding mapping in EPS remain unchanged in the SMF+PGW-C for possible future access of the UE to 5GC. | | + +## 7.5 QoS Parameters Mapping in MBS deployments + +### 7.5.1 Introduction + +MBS QoS parameters mapping functions are located at the PCF and MB-SMF. + +### 7.5.2 QoS parameter mapping Functions at PCF + +The QoS authorization process consists of the derivation of the Authorized 5G QoS Identifier (5QI), Authorized Allocation and Retention Priority (ARP) and Authorized Maximum/Guaranteed Data Rate DL parameters. Such process also includes the derivation of the Priority Level (PL), Averaging Window (AW) and Maximum Data Burst Volume (MDBV). + +The PCF shall derive the Authorized QoS parameters from the MBS service information received: + +- from an AF/NEF/MBSF that interacts with the PCF via the Npcf\_MBSPolicyAuthorization service; or +- from an MB-SMF that interacts with the PCF via the Npcf\_MBSPolicyControl service. + +###### **Table 7.5.2-1: Rules for derivation of the Maximum Authorized Data Rates, Authorized Guaranteed Data Rates, Maximum Authorized QoS Class and other authorized QoS parameters per MBS service data flow at the PCF** + +| Authorized QoS Parameter | Derivation from service information
(NOTE 3) | +|-------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL (Max_DR_DL) | 
 IF operator special policy exists THEN   -Max_DR_DL:= as defined by operator specific algorithm;   (NOTE 7 and 10) ELSE IF afAppId attribute of MbsServiceInfo data type demands application specific data rate handling THEN   -Max_DR_DL:= as defined by application specific algorithm; ELSE IF mbsMediaInfo attribute is received   IF codecs attribute of MbsMediaInfo data type provides Codec information for a codec that is supported by a specific algorithm (NOTE 4) THEN     Max_DR_DL:= as defined by specific algorithm;   ELSE IF maxReqMbsBwDl attribute is present THEN     Max_DR_DL:= maxReqMbsBwDl value;   ELSE     Max_DR_DL:= as set by the operator;   ENDIF; ELSE IF mbsQosReq attribute is received   IF maxBitRate attribute is present THEN     Max_DR_DL:= maxBitRate value;   ELSE     Max_DR_DL:= as set by the operator;   ENDIF; ELSE IF the qosRef attribute is present THEN   Max_DR_DL:= as configured by operator; ENDIF;
| +| Authorized Guaranteed Data Rate DL (Gua_DR_DL) | 
 IF operator special policy exists THEN   -Gua_DR_DL:= as defined by operator specific algorithm;   (NOTE 7 and 8) ELSE IF afAppId attribute of MbsServiceInfo data type demands application specific data rate handling THEN   -Gua_DR_DL:= as defined by application specific algorithm; ELSE IF mbsMediaInfo attribute is received   IF codecs attribute of MbsMediaInfo data type provides Codec information for a codec that is supported by a specific algorithm (NOTE 4) THEN     Gua_DR_DL:= as defined by specific algorithm;   ELSE IF minReqMbsBwDl attribute is present THEN     Gua_DR_DL:= minReqMbsBwDl value;   ELSE IF correspondng operator policy exists     Gua_DR_DL:= as set by the operator;   ELSE IF service corresponds to a GBR 5QI THEN     Gua_DR_DL:= Max_DR_DL;   ELSE     Gua_DR_DL:= 0; (NOTE 5)   ENDIF; ELSE IF mbsQosReq attribute is received   IF guarBitRate attribute is present THEN     Gua_DR_DL:= guarBitRate value;   ELSE IF correspondng operator policy exists     Gua_DR_DL:= as set by the operator;   ELSE IF service corresponds to a GBR 5QI THEN     Gua_DR_DL:= Max_DR_DL;   ELSE     Gua_DR_DL:= 0; (NOTE 5)   ENDIF; ELSE IF the qosRef attribute is present THEN   Gua_DR_DL:= as configured by operator; ENDIF;
| + +| Authorized QoS Parameter | Derivation from service information
(NOTE 3) | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authorized 5G QoS Identifier (5QI)
(see NOTE 1, 2, 6 and 9) | 
 IF an operator special policy exists THEN   5QI:= as defined by operator specific algorithm; (NOTE 10) ELSE IF afAppId attribute of MbsServiceInfo data type demands application specific QoS Class handling THEN   5QI:= as defined by application specific algorithm; ELSE IF mbsMediaInfo attribute is received   IF codecs attribute of MbsMediaInfo data type provides Codec information for a codec that is supported by a specific algorithm (NOTE 4) THEN   5QI:= as defined by specific algorithm; ELSE   /* The following 5QI derivation is an example of how to obtain the 5QI values in a 5GS network */   IF the mbsMedType attribute is present THEN     CASE mbsMedType value OF       "audio": 5QI := 1;       "video": 5QI := 2;       "application": 5QI := 1 OR 2;     OTHERWISE: 5QI := 9; /*e.g. for TCP-based generic traffic */     ENDIF;   ELSE IF mbsQosReq attribute is received     5QI:= 5qi attribute value;   ELSE IF the mbsQosRef attribute is received THEN     5QI:= as configured by operator;   ENDIF;
| +| NOTE 1: When audio or video IP flow(s) are removed from a session, the 5QI shall keep the originally assigned value. | | +| NOTE 2: When audio or video IP flow(s) are added to a session, the PCF shall derive the 5QI taking into account the already existing media IP flow(s) within the session. | | +| NOTE 3: The encoding of the service information is defined in 3GPP TS 29.537 [55]. | | +| NOTE 4: The support of any codec specific algorithm in the PCF is optional. | | +| NOTE 5: Authorized Guaranteed Data Rate DL shall not be derived for non-GBR 5QI values. | | +| NOTE 6: Recommended 5QI values for standardised 5QI characteristics are shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. | | +| NOTE 7: The PCF may be configured with operator specific preconditions for setting the Authorized Guaranteed Data Rate lower than the corresponding Maximum Authorized Data Rate. | | +| NOTE 8: The PCF shall assign an Authorized Guaranteed Data Rate DL value within the limit supported by the serving network. | | +| NOTE 9: The PCF may authorize a non-standardized 5QI with explicitly signalled QoS characteristics as defined in clause 5.2.3.2.3 of 3GPP TS 29.537 [55] or may assign QoS characteristics (e.g. Priority Level, Averaging Window, and Maximum Data Burst Volume) to be used instead of the default QoS characteristics associated with a standardised 5QI value as shown in table 5.7.4-1 in 3GPP TS 23.501 [2]. Averaging Window may also be derived from averWindow attribute when mbsQosReq is received in the PCF. | | +| NOTE 10: Operator specific policies may consider access information for policy decision. | | + +The PCF should per ongoing MBS session store the Authorized QoS parameters for each service data flow (as described within a mbsMedComps attribute). + +If the PCF provides a QoS information associated to an MBS PCC rule it may apply the rules in table 7.5.2-2 to combine the Authorized QoS per service data flow (as derived according to table 7.5.2-1) for all service data flows described by the corresponding MBS PCC rule. + +NOTE 1: QoS Information related to MBS Session-AMBR is not derived based on mapping tables in this clause, but based on subscription and operator specific policies. + +NOTE 2: ARP is always calculated at MBS PCC rule level according to table 7.5.2-2. + +**Table 7.5.2-2: Rules for calculating the Maximum Authorized/Guaranteed Data Rates, 5QI and ARP in the PCF** + +| Authorized QoS Parameter | Calculation Rule | +|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Data Rate DL | Maximum Authorized Data Rate DL is the sum of all Maximum Authorized Data Rate DL for all the service data flows (as according to table 7.5.2-1). | +| Guaranteed Authorized Data Rate DL | Guaranteed Authorized Data Rate DL is the sum of all Guaranteed Authorized Data Rate DL for all the service data flows (as according to table 7.5.2-1). (NOTE 2) | +| 5QI | 5QI = MAX [needed QoS parameters per service data flow (as operator's defined criteria) among all the service data flows] | +| ARP | IF an operator special policy exists THEN
ARP:= as defined by operator specific algorithm;
ELSE IF afAppId attribute of MbsServiceInfo data type demands application specific ARP handling THEN
ARP:= as defined by application specific algorithm;
ELSE IF mbsQosReq attribute is received
IF reqMbsAcp attribute is present THEN
ARP:= reqMbsAcp value;
ENDIF;
ELSE IF mbsSdfResPrio is received and it demands application specific ARP handling THEN
ARP:= as defined by application specific algorithm;
ELSE IF mbsQosReq attribute is received
ARP:= as configured by operator
ENDIF;
(NOTE 1) | + +NOTE 1: The ARP priority levels 1-8 should only be assigned to resources for services that are authorized to receive prioritized treatment within an operator domain. + +NOTE 2: The PCF may check that the Guaranteed Authorized Data Rate DL does not exceed the subscribed maximum aggregated bitrate that can be provided across all the GBR QoS Flows for an MBS session. + +### 7.5.3 QoS parameter mapping Functions at MB-SMF + +**Table 7.5.3-1: Rules for derivation of the Authorized QoS Parameters per QoS flow from the Authorized QoS Parameters in SMF** + +| Authorized QoS Parameter per QoS flow | Derivation from Authorized QoS Parameters | +|--------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Maximum Authorized Bandwidth DL per QoS flow | Maximum Authorized Bandwidth DL per QoS flow = Sum of Maximum Authorized Data Rate DL for all MBS PCC rules bound to that QoS flow. | +| Guaranteed Authorized Data Rate DL per QoS flow | Guaranteed Authorized Data Rate DL per QoS flow = Sum of Guaranteed Authorized Data Rate DL for all MBS PCC rules bound to that QoS flow. | +| Session-AMBR DL | For all non-GBR QoS flows, Session-AMBR DL is applied. | +| 5QI | 5QI from MBS PCC rules having the same value combination of 5QI/ARP/PL/AW/MDBV is used. | +| ARP | ARP from MBS PCC rules having the same value combination of 5QI/ARP/PL/AW/MDBV is used. | +| Priority Level (PL) | PL from MBS PCC rules having the same value combination of 5QI/ARP/PL/AW/MDBV is used. | +| Averaging Window (AW) | AW from MBS PCC rules having the same value combination of 5QI/ARP/PL/AW/MDBV is used. Applicable for GBR or delay critical GBR QoS flow. | +| Maximum Data Burst Volume (MDBV) | MDBV from MBS PCC rules having the same value combination of 5QI/ARP/PL/AW/MDBV is used. Applicable for delay critical GBR QoS flow. | + +# 8 PCF addressing + +## 8.1 General + +The PCF discovery and selection procedures are needed when there are multiple and separately addressable PCFs in a PLMN or an SNPN. It is also possible that a PCF may serve only specific DN(s). + +For PCC deployments not supporting MBS, PCF discovery and selection procedures are described in this clause clauses 8.2, 8.3, 8.4 and 8.5. + +PCF discovery and selection procedures related to MBS PCC deployments as defined in 3GPP TS 23.247 [54] are described in clause 8.6. + +These procedures correlate the AF service session establishment over N5 or Rx with the associated PDU session (Session binding) handled over N7. They also correlate the AF service request over N5 with the associated AM policy context or, in the case the AF is a 5G DDNMF, with the associated UE policy context, handled over N15. + +These procedures enable the AMF and SMF to address the PCF. + +These procedures enable a consumer NF (e.g. an AF, NEF or PCF for a UE) to address the PCF for a PDU Session or the PCF for the UE (see clause 8.4). + +The SCP is involved in the case of delegated discovery and selection. + +## 8.2 PCF discovery and selection by the AMF + +PCF discovery and selection functionality is implemented in the AMF and the SCP, and follows the principles described in 3GPP TS 23.501 [2], clause 6.3.1. The AMF uses the PCF services for a UE. + +When the AMF performs discovery and selection for a UE, the AMF may utilize the Nnrf\_NFDiscovery service of the NRF to discover the candidate PCF instance(s). In addition, PCF information may also be locally configured in the AMF. The AMF selects a PCF instance, or two when roaming, based on the available PCF instances (obtained from the NRF or locally configured in the AMF) and depending on operator's policies. + +In the non-roaming case, the AMF selects a PCF instance for AM policy association and selects the same PCF instance for UE policy association. In the roaming case, the AMF selects a V-PCF instance for AM policy association and selects the same V-PCF instance for UE policy association. The following factors may be considered for PCF discovery and selection for Access and Mobility policies and UE policies: + +- SUPI; the AMF selects a PCF instance based on the SUPI range the UE's SUPI belongs to or based on the results of a discovery procedure with the NRF using the UE's SUPI as an input for PCF discovery. +- GPSI; the AMF selects a PCF instance based on the GPSI range the UE's GPSI belongs to or based on the results of a discovery procedure with the NRF using the UE's GPSI as an input for PCF discovery. +- S-NSSAI(s). In the roaming case, the AMF selects the V-PCF instance based on the S-NSSAI(s) of the VPLMN and selects the H-PCF instance based on the S-NSSAI(s) of the HPLMN. +- PCF Set ID. +- PCF Group ID of the UE's SUPI. + +NOTE 1: The AMF can infer the PCF Group ID the UE's SUPI belongs to or UE's GPSI belongs to based on the results of PCF discovery procedures with the NRF. The AMF can provide the PCF Group ID to other PCF NF consumers as described in 3GPP TS 23.502 [3]. + +- The features supported by the PCF (e.g. the PCF supporting the "DNNReplacementControl" feature is selected by the AMF supporting DNN replacement). +- The V2X support stored in the NRF. +- The A2X support stored in the NRF. + +- The ProSe support stored in the NRF. +- The Ranging\_SL support stored in the NRF. +- PCF Selection Assistance Info and PCF Instance Id(s) serving the established PDU Sessions/PDN Connections received from UDM. In case PCF Selection Assistance Info and PCF Instance Id(s) are received from the UDM, the AMF selects a PCF instance that matches one of the received PCF instance Id(s) serving a combination of DNN and S-NSSAI that is included in the the PCF Selection Assistance Info. If multiple DNN and S-NSSAI combinations are provided, the AMF selects the DNN, S-NSSAI using local configuration. In case PCF instance Id(s) are not received, e.g. EPS interworking is not supported, the AMF selects the PCF instance by considering other above factors. + +In the case of delegated discovery and selection in the SCP, the AMF shall include in the first request to the PCF the above factors, if available, within the "3gpp-Sbi-Discovery-\*" request headers, as specified in 3GPP TS 29.500 [5], clause 6.10.3.2. + +In the following scenarios, information about the PCF instance that has been selected by the AMF (e.g. the selected PCF instance Id, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID, if available) can be forwarded to another NF consumer of the PCF: + +- During AMF relocation, the target AMF may receive from the source AMF a resource URI of AM Policy association and/or a resource URI of UE Policy association, a PCF instance ID, a PCF set ID, and if the PCF set ID is not available, a PCF Group ID (if available) to enable the target AMF to reuse the same PCF instance (i.e. reuse the AM Policy association resource and/or UE Policy association resource), and the target AMF may decide based on operator policy either to re-use the AM/UE Policy Association in the same PCF instance or select a new PCF instance. +- In the roaming case, the AMF may, based on operator policies (e.g. roaming agreement), select the H-PCF in addition to the V-PCF for a UE by performing a PCF discovery and selection as described above. The AMF sends the selected H-PCF instance Id to the V-PCF during the UE Policy association establishment procedure. + +In these scenarios, if the target AMF performs discovery and selection, the target AMF may use the received PCF information instead of performing PCF selection interacting with the NRF as described above (discovery may still be needed depending on what level of information is sent by the AMF, e.g. the address of the PCF instance may not be present) + +In addition, in the case of delegated discovery and selection in the SCP, the following applies: + +- a) The selected PCF instance may include the PCF instance ID, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available) in the response to the AMF. + +NOTE 2: The selected (V-)PCF instance can include a binding indication, including the (V-)PCF ID and possibly the PCF Set ID in the response to the AMF. + +- b) The AMF first establishes an AM policy association; when forwarding the related request message, the SCP discovers and selects a (V-)PCF instance for AM policy association. Unless binding information is provided in the response of the PCF to that request, the SCP adds the PCF instance ID it selected into the response to the AMF, as per clause 6.10.3.4 of 3GPP TS 29.500 [5]. The AMF uses the received (V-)PCF instance Id for the AM policy association and/or the available binding information within the "3gpp-Sbi-Discovery-\*" request headers for the request to establish the UE policy association. The SCP selects the corresponding (V-)PCF instance for UE policy association based on the received discovery and selection parameters. +- c) During AMF relocation, the target AMF may receive a resource URI of AM Policy association and/or a resource URI of UE Policy association, a PCF instance ID, a PCF set ID, and if the PCF set ID is not available, a PCF Group ID (if available) from the source AMF to enable it to reuse the same PCF instance. The AMF may decide based on operator policy either to use the old PCF instance or select another PCF instance (i.e. reuse the AM Policy association resource and/or UE Policy association resource). If the target AMF decides to reuse the old PCF instance, the AMF includes the {apiRoot} of the resource URI within the "3gpp-Sbi-Target-apiRoot" request header, the PCF instance ID, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available) within the "3gpp-Sbi-Discovery-\*" request header as received from the source AMF in the AM policy update request and/or the UE policy update request to the PCF via the SCP. +- d) In the roaming case, the AMF performs discovery and selection of the H-PCF from NRF as described in this clause. The AMF may indicate the maximum number of H-PCF instances to be returned from NRF, i.e. H-PCF + +selection at NRF. The AMF uses the received V-PCF instance Id for AM Policy association and/or the available binding information received during the AM policy association procedure as described in bullet b) above to send the UE policy association establishment request, which also includes the selected H-PCF instance Id, to the V-PCF via the SCP. The SCP discovers and selects the V-PCF instance. The V-PCF sends an UE policy association establishment request towards the HPLMN, which includes the selected H-PCF instance Id within the "3gpp-Sbi-Discovery-\*" request header as a discovery and selection parameter to the H-PCF via the SCP. + +## 8.3 PCF discovery and selection by the SMF + +PCF discovery and selection functionality is implemented in the SMF and the SCP, and follows the principles described in 3GPP TS 23.501 [2], clause 6.3.1. The SMF uses the PCF services for a PDU session. The selected PCF instance may be the same or a different one than the PCF instance used by the AMF. + +When the SMF performs discovery and selection for a PDU session, the SMF may utilize the Nnrf\_NFDiscovery service of the Network Repository Function to discover the candidate PCF instance(s). In addition, PCF information may also be locally configured in the SMF. The SMF selects a PCF instance based on the available PCF instances (obtained from the NRF or locally configured in the SMF). The following factors may be considered during the PCF selection. + +- Local operator policies. +- Selected Data Network Name (DNN). +- S-NSSAI of the PDU session. In the LBO roaming case, the SMF selects the PCF instance based on the S-NSSAI of the VPLMN. In the home routed roaming case, the H-SMF selects the H-PCF instance based on the S-NSSAI of the HPLMN. +- the features supported by the PCF (e.g. a PCF supporting the "ATSSS" feature is selected for an MA PDU session). +- SUPI; the SMF selects a PCF instance based on the SUPI range the UE's SUPI belongs to or based on the results of a discovery procedure with NRF using the UE's SUPI as an input for PCF discovery. +- GPSI; the SMF selects a PCF instance based on the GPSI range the UE's GPSI belongs to or based on the results of a discovery procedure with NRF using the UE's GPSI as an input for PCF discovery. +- PCF instance ID selected by the AMF for the UE, if available. +- The PCF Group ID provided by the AMF to the SMF, if available. +- PCF Set ID, if available. +- Same PCF Selection Indication provided by the AMF to the SMF, if available. + +In the case of delegated discovery and selection in SCP, the SMF shall include the above factors except the local operator policies if available in the first request, within the "3gpp-Sbi-Discovery-\*" request headers as specified in 3GPP TS 29.500 [5], subclause 6.10.3.2. + +The AMF may, based on operator policies, forward the selected PCF instance ID, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available) to the SMF during the PDU Session Establishment procedure to enable the usage of the same PCF instance for the AMF and the SMF. In this scenario, when the SMF performs discovery and selection, the SMF may decide based on operator policy either to use the same PCF instance or select a new PCF instance. + +If the combination of the DNN and S-NSSAI of the PDU session matches one of the combination(s) of the DNN and S-NSSAI included in the PCF Selection Assistance info received from UDM, the AMF shall forward the Same PCF Selection Indication together with the selected PCF instance Id, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available) to the SMF during the PDU Session Establishment procedure. In case that the Same PCF Selection Indication is received together with the PCF instance Id, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available), the SMF shall select the same PCF instance for SM Policy Control. + +If the same PCF instance is selected by the SMF, the PCF discovery and selection procedure described above is not performed (discovery may still be needed to obtain the address of the PCF instance). + +In the case of delegated discovery and selection in the SCP, the SMF may include the received PCF instance ID, the PCF set ID, and if the PCF set ID is not available, the PCF Group ID (if available) within the "3gpp-Sbi-Discovery-\*" request headers in the request to the PCF via the SCP. The SCP may decide based on operator policy either to use the indicated PCF instance or select another PCF instance. + +When the feature "SamePcf" is supported, the selected PCF instance may indicate redirection for the SM Policy Control association creation to a different PCF instance, including the redirection URI with the FQDN or IP endpoint of the target Npcf\_SMPolicyControl service in a different PCF instance. The SMF shall behave as follows: + +- For direct communication scenarios, at the reception of the redirection request, the SMF shall terminate the current SM Policy Control association creation and reselect a PCF instance based on the received redirection information. The SMF shall then establish an SM Policy Control association with the reselected PCF instance. +- For indirect communication scenarios with delegated discovery and selection, the SCP, based on local policies, as specified in 3GPP TS 29.500 [5], clause 6.10.9.1, may send the request towards the new PCF instance instead of forwarding the redirect request to the SMF. If the redirect request is received by the SMF, the SMF shall terminate the current SM Policy Control association creation and reselect a PCF instance based on the received redirection information. The SMF shall then establish an SM Policy Control association with the reselected PCF instance using the same or a different SCP and including the {apiRoot} of the received URI within the "3gpp-Sbi-Target-apiRoot" request header. + +NOTE: A single PCF can be used for the monitoring and limitation of the data rate per network slice. To enable this, the SMF has to select the same PCF instance for all PDU Sessions of the UE to the S-NSSAI. This is achieved with the mechanisms described in this clause, for example by using local operator policies in the SMF or SUPI ranges. + +## 8.4 PCF discovery and selection by the AF + +### 8.4.1 General + +When multiple and separately addressable PCFs have been deployed, the BSF, as described in clause 8.4.2, is required in order to ensure that a consumer NF (e.g. an AF, NEF) for a certain PDU session reaches over N5/Rx the PCF holding the PDU session information, and that a consumer NF (e.g. an AF or NEF) for a certain UE context reaches over N5 the PCF holding the UE context information. The AF can also select a PCF based on local configuration for Ethernet PDU sessions. + +For the integration with TSC networks the AF is either the TSN AF (integration with IEEE TSN networks) or the TSCTSF (integration with other TSC networks than IEEE TSN). + +### 8.4.2 Binding Support Function (BSF) + +The BSF has the following characteristics: + +- a) The BSF stores internally information about the corresponding selected PCF as defined in 3GPP TS 29.521 [22]. + - For a certain PDU session, the BSF stores internally information about the user identity, the DNN, the UE (IP or MAC) address(es), S-NSSAI, the IPv4 address domain (if applicable) and the selected PCF address, and if available the associated PCF instance ID, PCF set ID and the level of SBA binding. + - For a certain UE, the BSF stores internally information about the user identity, the selected PCF address and if available the associated PCF instance ID, PCF set ID and the level of SBA binding. + +NOTE 1: Only NF instance or NF set of level of binding is supported at the BSF for SBA binding level of Npcf\_PolicyAuthorization service. + +NOTE 2: How to ensure the routing of the Npcf\_SMPolicyControl\_Create service operation to the appropriate PCF instance when the "SamePcf" feature or the "ExtendedSamePcf" feature are supported depends on the implementation. + +- b) The PCF utilizes the Nbsf\_Management service of the BSF to register, update or remove the stored information in the BSF. + +- For a PDU Session, the PCF ensures that the binding information is updated each time an IP address is allocated or released for the PDU Session or, for Ethernet PDU Sessions, each time the PCF is notified that a MAC address is taken into use or no more used in the PDU Session or, each time the PCF instance is changed. + - For a UE, the PCF ensures that it is updated each time the AMF selects a new PCF instance. + - If the PCF determines whether the same PCF shall be selected for the SM Policy associations as described in 3GPP TS 29.512 [9], the PCF registers in the BSF including the available parameter combination. The BSF applies the procedures to identify if there is a PCF handling the binding information and accepts or rejects the request accordingly (see clause 4.2.2.2 of 3GPP TS 29.521 [22]). +- c) For the retrieval of binding information, any NF, such as NEF or AF, uses the Nbsf\_Management service as defined in 3GPP TS 29.521 [22] to discover or subscribe to the notification of the selected PCF address(es), and if available, the associated PCF instance ID, PCF set ID and the level of SBA binding for: +- i. the tuple (UE address, DNN, SUPI, GPSI, S-NSSAI, IPv4 address domain) (or for a subset of this tuple), when the target is the PCF for the PDU session; or + - ii. the tuple (SUPI, GPSI) (or for a subset of this tuple), when the target is the PCF for the UE. +- d) If the NF received a PCF set ID or a PCF instance ID with a level of SBA binding as result of the Nbsf management service discovery service operation or in the request of the Nbsf management service notification service operation or in the response of the Nbsf management subscribe service operation, it should use that information as NF set level or NF instance level SBA Binding Indication to route requests to the PCF. +- e) For an ongoing NF service session, the PCF may provide SBA Binding Indication to the NF (see clause 6.3.1.0 of 3GPP TS 23.501 [2]). This SBA Binding Indication shall then be used instead of any PCF information received from the BSF. +- f) The BSF is able to proxy or redirect Rx requests based on the IP address of a UE. For any AF using Rx, such as P-CSCF, the BSF determines the selected PCF address according to the information carried by the incoming Rx requests. + +It shall support the functionality of a proxy agent and a redirect agent as defined in IETF RFC 6733 [29]. The mode in which it operates (i.e. proxy or redirect) shall be based on operator's requirements. + +- g) The BSF may be deployed standalone or may be collocated with other network functions such as the PCF, UDR, NRF, and SMF. + +NOTE 3: Collocation allows combined implementation. + +- h) The NF may discover the BSF via NRF by invoking the Nnrf\_NFDiscovery service operation or based on local configuration. In case of via NRF the BSF registers the NF profile in NRF. The IP domain list, the Range(s) of UE IPv4 addresses, Range(s) of UE IPv6 prefixes, Range(s) of SUPIs, the Range(s) of GPSIs or the BSF Group Id supported by the BSF may be provided to NRF, as described in clause 6.1.6.2.21 of TS 29.510 [51]. +- i) The BSF verifies whether to provide the address of a PCF for a PDU Session or a PCF for a UE based on the explicit NF service request to the resource collection representing the binding information for the PCF for a PDU Session or the PCF for a UE as specified in 3GPP TS 29.521 [22]. + +### 8.4.3 Void + +### 8.4A PCF for a PDU session discovery and selection by the PCF for a UE + +When the PCF for a UE determines that the AM policy, e.g. service area restriction, depends on PDU session traffic events, e.g. the application start and application stop for an application Id, or makes policy control decisions based on awareness of URSP rule enforcement for an application, the PCF for a UE needs to discover the PCF for a PDU session handling the concerned PDU session(s) to subscribe to the notification of the PDU session traffic related event(s) using the Npcf\_PolicyAuthorization service. The following alternatives are specified for the discovery and selection of the PCF for a PDU session by the PCF for a UE: + +- 1) The PCF for a UE may subscribe with the BSF to the notification of the binding information registration/deregistration of the PCF for a PDU session as defined in 3GPP TS 29.521 [22]; or +- 2) The PCF for a UE may subscribe with the PCF for the PDU session to the notification of PDU session established/terminated events for certain DNN and S-NSSAI combination(s) as follows: + 1. The PCF for a UE provides to the AMF the PCF for a UE callback information (e.g. callback URI information where it listens to notifications of PDU session established/terminated events) and the matching S-NSSAI and DNN combination(s), as specified in 3GPP TS 29.507 [7]. + 2. The AMF forwards to the SMF, for the PDU session(s) matching the received S-NSSAI and DNN combination(s), the PCF for a UE callback information, as specified in 3GPP TS 29.502 [52]. + 3. The SMF notifies the PCF for a PDU session of the received PCF for a UE callback information, as specified in 3GPP TS 29.512 [9]. + 4. When the PCF for a PDU session becomes aware that a SM Policy Association is receiving the callback URI for the PCF for a UE, the PCF for a PDU session sends the Npcf\_PolicyAuthorization\_Notify service operation to the received PCF for a UE callback URI to notify the PCF for a UE of the PCF for a PDU session address(es) and SBA binding information as specified in clause 4.2.5.22 of 3GPP TS 29.514 [10]. + +## 8.5 BSF procedures + +### 8.5.1 General + +These procedures concern the storage of binding information in the BSF, the retrieval of binding information from the BSF and the subscription to the notification of PCF registration/deregistration events from the BSF. + +This clause also concerns the BSF procedures over Rx reference point. Clause 8.5.5 is for the BSF implemented as a Diameter Proxy Agent, and clause 8.5.6 is for the BSF implemented as a Diameter Redirect Agent. + +### 8.5.2 Binding information Creation + +![Sequence diagram showing the Binding information Creation procedure between PCF and BSF.](94d3fdcc244924326f02533aeb2d93fc_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF + Note left of PCF: 1. Nbsf_Management_Register request + PCF->>BSF: 1. Nbsf_Management_Register request + Note right of BSF: 2. Nbsf_Management_Register response + BSF-->>PCF: 2. Nbsf_Management_Register response +``` + +Sequence diagram showing the Binding information Creation procedure between PCF and BSF. + +Figure 8.5.2-1: Binding information Creation procedure + +1. When an IP address is allocated for the IP PDU session, or a MAC address is used for the Ethernet PDU session, the PCF for a PDU session invokes the Nbsf\_Management\_Register service operation by sending an HTTP POST request with Resource URI of the resource "PCF for a PDU Session Bindings" to store the binding information in the BSF. The binding information provided in the HTTP POST request is defined in clause 4.2.2.2 of 3GPP TS 29.521 [22]. + +When an AM Policy Association or an UE Policy Association is established, and the PCF for a UE determines that binding information needs to be created, the PCF for a UE invokes the Nbsf\_Management\_Register service operation by sending an HTTP POST request with Resource URI of the resource "PCF for a UE Bindings" as defined in clause 4.2.2.3 of 3GPP TS 29.521 [22] to store the binding information in the BSF. + +2. Once the BSF created the resource correspondingly, the BSF shall send an HTTP "201 Created" response to the PCF and store the binding information. + +### 8.5.3 Binding information Deletion + +![Sequence diagram for Binding information Deletion procedure between PCF and BSF.](0f1767577a073167eb9628d72034e083_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF + Note left of PCF: When the IP address is released or the MAC address is not used for a certain PDU session... + PCF->>BSF: 1. Nbsf_Management_Deregister request + BSF-->>PCF: 2. Nbsf_Management_Deregister response +``` + +Sequence diagram for Binding information Deletion procedure between PCF and BSF. + +**Figure 8.5.3-1: Binding information Deletion procedure** + +1. When the IP address is released or the MAC address is not used for a certain PDU session and there is no IP address or MAC address applicable to a corresponding binding information (e.g. the IP address or the MAC address is the unique address for the PDU session), the PCF for a PDU Session invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request with Resource URI of the resource "Individual PCF for a PDU Session Binding" to request the BSF to remove the binding information as defined in clause 4.2.3.2 of 3GPP TS 29.521 [22]. + +When the AM Policy Association or the UE Policy Association is terminated, and the PCF for a UE determines that binding information needs to be terminated, the PCF for a UE invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request with Resource URI of the resource "Individual PCF for a UE Binding" to request the BSF to remove the binding information as defined in clause 4.2.3.3 of 3GPP TS 29.521 [22]. + +2. Upon success, the BSF shall send an HTTP "204 No Content" response to the PCF and remove the stored binding information. + +### 8.5.4 Binding information Retrieval + +![Sequence diagram for Binding information Retrieval procedure between AF/NEF and BSF.](1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg) + +``` +sequenceDiagram + participant AF/NEF + participant BSF + Note left of AF/NEF: The NF service consumer (e.g., NEF, AF, NWDAF) invokes the Nbsf_Management_Discovery service operation... + AF/NEF->>BSF: 1. Nbsf_Management_Discovery request + BSF-->>AF/NEF: 2. Nbsf_Management_Discovery response +``` + +Sequence diagram for Binding information Retrieval procedure between AF/NEF and BSF. + +**Figure 8.5.4-1: Binding information Retrieval procedure** + +1. The NF service consumer (e.g., NEF, AF, NWDAF) invokes the Nbsf\_Management\_Discovery service operation by sending an HTTP GET request with Resource URI of the resource "PCF for a PDU Session Bindings" to the BSF to obtain the address information of the selected PCF for a certain PDU session. The URI query parameters in the HTTP GET request are specified in clause 4.2.4.2 of 3GPP TS 29.521 [22]. + +The NF service consumer (e.g., NEF, AF) invokes the Nbsf\_Management\_Discovery service operation by sending an HTTP GET request with Resource URI of the resource "PCF for a UE Bindings" to the BSF to obtain the address information of the selected PCF for a certain UE. The URI query parameters in the HTTP GET request are specified in clause 4.2.4.3 of 3GPP TS 29.521 [22]. + +2. Once the request is accepted and a binding resource matching the query parameters exists, the BSF shall send an HTTP "200 OK" response to the NF service consumer with the address information of the selected PCF (e.g. Npcf\_PolicyAuthorization service FQDN and/or IP Endpoint(s) of the selected PCF, or if the PCF supports the Rx interface the Diameter host and realm for the selected PCF), and if available with the associated PCF set ID, the PCF instance ID and the SBA binding level. + +### 8.5.5 Proxy BSF + +#### 8.5.5.1 General + +When the BSF receives a request from an AF, it shall check whether it already has selected a PCF for the Rx session; if it does have a PCF already selected for the Rx session, it shall proxy the request to the corresponding PCF. If the BSF does not have a PCF already selected, it shall select a PCF to handle the Rx session and then proxy the request to the selected PCF. + +#### 8.5.5.2 Rx Session Establishment + +![Sequence diagram for Rx Session Establishment procedure using BSF (proxy).](820515db47ded68f5e0b625f4ec7d2c1_img.jpg) + +``` +sequenceDiagram + participant AF + participant BSF as BSF (proxy) + participant PCF + Note right of BSF: 2. BSF binding retrieval + AF->>BSF: 1. Diameter AAR + BSF->>PCF: 3. Proxy Diameter AAR + PCF-->>BSF: 4. Diameter AAA + BSF-->>AF: 5. Proxy Diameter AAA +``` + +The diagram illustrates the Rx Session Establishment procedure. It involves three main entities: AF (Application Function), BSF (proxy) (Binding Support Function), and PCF (Policy Control Function). The sequence of messages is as follows: 1. The AF sends a Diameter AAR (Authentication, Authorization, Accounting Request) to the BSF (proxy). 2. The BSF (proxy) performs a 'BSF binding retrieval' (indicated by a self-call). 3. The BSF (proxy) sends a Proxy Diameter AAR to the PCF. 4. The PCF returns a Diameter AAA (Authentication, Authorization, Accounting Answer) to the BSF (proxy). 5. The BSF (proxy) then proxies the Diameter AAA back to the AF. + +Sequence diagram for Rx Session Establishment procedure using BSF (proxy). + +**Figure 8.5.5.2-1: Rx Session Establishment procedure using BSF (proxy)** + +1. A Diameter AAR indicating establishment of an AF session is sent by the AF and received by a BSF (proxy). +2. The BSF (proxy) shall select a PCF from the binding for the AF. +3. The BSF (proxy) proxies the Diameter AAR to the target PCF. The proxied Diameter AAR maintains the same Session-Id AVP value. +4. The PCF returns a Diameter AAA to the BSF (proxy). +5. BSF (proxy) proxies the Diameter AAA to the AF. The proxied Diameter AAA maintains the same Session-Id AVP value. + +#### 8.5.5.3 Rx Session Modification + +##### 8.5.5.3.1 AF-initiated + +![Sequence diagram for AF-initiated Rx Session Modification procedure using BSF (proxy).](868ef3e0abb37916a7af1e923995f329_img.jpg) + +``` +sequenceDiagram + participant AF + participant BSF as BSF (proxy) + participant PCF + AF->>BSF: 1. Diameter AAR + BSF->>PCF: 2. Proxy Diameter AAR + PCF-->>BSF: 3. Diameter AAA + BSF-->>AF: 4. Proxy Diameter AAA +``` + +The diagram illustrates the AF-initiated Rx Session Modification procedure. It involves the same three entities: AF, BSF (proxy), and PCF. The sequence of messages is: 1. The AF sends a Diameter AAR to the BSF (proxy). 2. The BSF (proxy) proxies the Diameter AAR to the PCF. 3. The PCF returns a Diameter AAA to the BSF (proxy). 4. The BSF (proxy) proxies the Diameter AAA back to the AF. + +Sequence diagram for AF-initiated Rx Session Modification procedure using BSF (proxy). + +**Figure 8.5.5.3.1-1: AF-initiated Rx Session Modification procedure using BSF (proxy)** + +1. A subsequent Diameter AAR indicating modification of an existing Rx session is sent by the AF and received by the BSF (proxy). +2. The BSF (proxy) proxies the Diameter AAR to the target PCF. +3. PCF returns a Diameter AAA to the BSF (proxy). +4. BSF (proxy) proxies the Diameter AAA to the AF. + +##### 8.5.5.3.2 PCF-initiated + +![Sequence diagram for PCF-initiated Rx Session Modification procedure using BSF (proxy).](164d1b48231be457522b31965610ea3b_img.jpg) + +``` +sequenceDiagram + participant AF + participant BSF as BSF (proxy) + participant PCF + Note right of PCF: 1. Diameter RAR + PCF->>BSF: + Note left of BSF: 2. Proxy Diameter RAR + BSF->>AF: + Note right of AF: 3. Diameter RAA + AF->>BSF: + Note left of BSF: 4. Proxy Diameter RAA + BSF->>PCF: +``` + +The diagram illustrates the PCF-initiated Rx Session Modification procedure using BSF (proxy). It shows four steps: 1. Diameter RAR from PCF to BSF (proxy); 2. Proxy Diameter RAR from BSF (proxy) to AF; 3. Diameter RAA from AF to BSF (proxy); 4. Proxy Diameter RAA from BSF (proxy) to PCF. + +Sequence diagram for PCF-initiated Rx Session Modification procedure using BSF (proxy). + +**Figure 8.5.5.3.2-1: PCF-initiated Rx Session Modification procedure using BSF (proxy)** + +1. A PCF-initiated Diameter RAR indicating an Rx specific action is sent to the AF and received by the BSF (proxy). +2. The BSF (proxy) proxies the Diameter RAR to the AF. The proxied Diameter Request maintains the same Session-Id AVP value. +3. AF returns a Diameter RAA to the BSF (proxy). +4. BSF (proxy) proxies the Diameter RAA to the PCF. + +#### 8.5.5.4 Rx Session Termination + +##### 8.5.5.4.1 AF-initiated + +![Sequence diagram for AF-initiated Rx Session Termination procedure using BSF (proxy).](22b2fd4b8672ad8b02cf6cd4de5809cd_img.jpg) + +``` +sequenceDiagram + participant AF + participant BSF as BSF (proxy) + participant PCF + Note left of BSF: 1. Diameter STR + AF->>BSF: + Note right of BSF: 2. Proxy Diameter STR + BSF->>PCF: + Note left of PCF: 3. Diameter STA + PCF->>BSF: + Note right of BSF: 4. Proxy Diameter STA + BSF->>AF: +``` + +The diagram illustrates the AF-initiated Rx Session Termination procedure using BSF (proxy). It shows four steps: 1. Diameter STR from AF to BSF (proxy); 2. Proxy Diameter STR from BSF (proxy) to PCF; 3. Diameter STA from PCF to BSF (proxy); 4. Proxy Diameter STA from BSF (proxy) to AF. + +Sequence diagram for AF-initiated Rx Session Termination procedure using BSF (proxy). + +**Figure 8.5.5.4.1-1: AF-initiated Rx Session Termination procedure using BSF (proxy)** + +1. A Diameter STR indicating termination of an Rx session is sent by the AF to the BSF (proxy). The message uses the same Session-Id AVP value of the active Rx session established between the AF and PCF. +2. The BSF (proxy) proxies the Diameter STR to the target PCF. The proxied Diameter Request maintains the same Session-Id AVP value. +3. PCF sends BSF (proxy) a Diameter STA to acknowledge termination of the session. +4. The BSF marks the Rx session terminated and proxies the Diameter STA to the AF. The proxied Diameter Answer maintains the same Session-Id AVP value. + +##### 8.5.5.4.2 PCF-initiated + +![Sequence diagram showing PCF-initiated Rx Session Termination procedure using BSF (proxy).](163688ca8da9787f5d48edd68d8cc75b_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF as BSF (proxy) + participant AF + Note right of PCF: 1. Diameter ASR + PCF->>BSF: 1. Diameter ASR + Note left of BSF: 2. Proxy Diameter ASR + BSF->>AF: 2. Proxy Diameter ASR + Note right of AF: 3. Diameter ASA + AF->>BSF: 3. Diameter ASA + Note left of BSF: 4. Proxy Diameter ASA + BSF->>PCF: 4. Proxy Diameter ASA +``` + +The diagram illustrates a sequence of four messages between three entities: AF, BSF (proxy), and PCF. The sequence starts with the PCF sending a '1. Diameter ASR' message to the BSF (proxy). The BSF (proxy) then proxies this message to the AF as '2. Proxy Diameter ASR'. The AF responds with '3. Diameter ASA' to the BSF (proxy). Finally, the BSF (proxy) proxies the response to the PCF as '4. Proxy Diameter ASA'. + +Sequence diagram showing PCF-initiated Rx Session Termination procedure using BSF (proxy). + +**Figure 8.5.5.4.2-1: PCF-initiated Rx Session Termination procedure using BSF (proxy)** + +1. A PCF-initiated Diameter ASR requesting the termination of an Rx session is sent to the AF and received by the BSF (proxy). +2. The BSF (proxy) proxies the Diameter ASR to the AF. The proxied Diameter ASR maintains the same Session-Id AVP value. +3. AF returns a Diameter ASA to the BSF (proxy). +4. BSF (proxy) proxies the Diameter ASA to the PCF. + +### 8.5.6 Redirect BSF + +#### 8.5.6.1 General + +A BSF implemented as a Diameter redirect agent shall redirect the received Diameter request message by carrying out the procedures defined in clause 6.1.7 of IETF RFC 6733 [29]. The Client shall use the value within the Redirect-Host AVP of the redirect response in order to obtain the PCF identity. The BSF may provide the Redirect-Host-Usage AVP in the redirect response to provide a hint to the Client about how the cached route table entry created from the Redirect-Host AVP is to be used as described in clause 6.13 of IETF RFC 6733 [29]. + +The BSF may also provide the Redirect-Max-Cache-Time AVP in the redirect response to indicate to the Client the lifetime of the cached route table entry created from the Redirect-Host and Redirect-Host-Usage AVP values as described in clause 6.14 of IETF RFC 6733 [29]. + +The BSF clients shall use cached route table entry created from the Redirect-Host, Redirect-Host-Usage and Redirect-Max-Cache-Time AVPs to determine whether BSF interaction is required. + +The AF shall contact the BSF on Rx session establishment to retrieve the PCF address. The BSF (redirect) does not need to maintain Diameter sessions and Diameter Base redirect procedures are applicable. Therefore, an AF should not send an Rx session modification or termination request to the BSF. + +#### 8.5.6.2 Rx Session Establishment + +![Sequence diagram for Rx Session Establishment procedure using BSF (redirect).](d62e2e2281009c16f4ee61660e716cd9_img.jpg) + +``` + +sequenceDiagram + participant AF + participant BSF as BSF (redirect) + participant PCF + Note right of BSF: 2. BSF binding retrieval + AF->>BSF: 1. Diameter AAR + BSF->>AF: 3. Diameter AAA (redirect) + AF->>PCF: 4. Diameter AAR + PCF->>AF: 5. Diameter AAA + +``` + +The diagram illustrates the Rx Session Establishment procedure using BSF (redirect). It involves three main entities: AF (Application Function), BSF (BSF (redirect)), and PCF (Policy Control Function). The sequence of messages is as follows: + + +- The AF sends a Diameter AAR (1) to the BSF. +- The BSF performs a binding retrieval (2) internally. +- The BSF sends a Diameter AAA (redirect) (3) back to the AF. +- The AF re-sends the Diameter AAR (4) to the target PCF. +- The PCF returns a Diameter AAA (5) to the AF. + +Sequence diagram for Rx Session Establishment procedure using BSF (redirect). + +**Figure 8.5.6.2-1: Rx Session Establishment procedure using BSF (redirect)** + +1. A Diameter AAR indicating establishment of a new Rx Diameter session with the PCF is sent by the AF and received by a BSF (redirect). +2. The BSF shall select the PCF from the binding for the AF. +3. The BSF sends a Diameter AAA indicating redirection as defined in IETF RFC 6733 [29]. The target PCF identity is included in the Redirect-Host AVP. +4. The AF re-sends the Diameter AAR of step 1 to the target PCF. +5. PCF returns a Diameter AAA to the AF. + +### 8.5.7 Binding information Update + +![Sequence diagram for Binding information Update procedure.](6324b252294c0f5d4e34dad4a1202075_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant BSF + PCF->>BSF: 1. Nbsf_Management_Update request + BSF->>PCF: 2. Nbsf_Management_Update response + +``` + +The diagram illustrates the Binding information Update procedure. It involves two main entities: PCF (Policy Control Function) and BSF (BSF). The sequence of messages is as follows: + + +- The PCF sends an Nbsf\_Management\_Update request (1) to the BSF. +- The BSF returns an Nbsf\_Management\_Update response (2) to the PCF. + +Sequence diagram for Binding information Update procedure. + +**Figure 8.5.7-1: Binding information Update procedure** + +1. If the binding information has been previously registered in the BSF, and if the BindingUpdate feature defined in 3GPP TS 29.521 [22] is supported, the PCF for a PDU Session invokes the Nbsf\_Management\_Update service operation by sending an HTTP PATCH request with Resource URI of the resource "Individual PCF for a PDU Session Binding" as defined in clause 4.2.5.2 of 3GPP TS 29.521 [22] to update the binding information in the BSF in the following cases: + - for the IP address information of the served UE: + - for the IPv4v6 address case, when one of the addresses is released or a new IP address is allocated; and/or + - for the multiple address case, if the MultiUeAddr feature defined in 3GPP TS 29.521 [22] is supported, when a new IP address (e.g. IPv6 prefix) is allocated or an IP address which is not the last one is released for the IP PDU session, + - for the MAC address information of the served UE: + +- if the MultiUeAddr feature defined in 3GPP TS 29.521 [22] is supported, when a new MAC address is used or a MAC address which is not the last one is not used for the Ethernet PDU session ; and/or +- if a new PCF instance is selected, the PCF instance ID and the associated PCF address(es). + +If the binding information has been previously registered in the BSF, and if a new PCF instance for a UE is selected, the PCF for a UE invokes the Nbsf\_Management\_Update service operation by sending an HTTP PATCH request with Resource URI of the resource "Individual PCF for a UE Binding" as defined in clause 4.2.5.3 of 3GPP TS 29.521 [22] to update the binding information in the BSF. + +2. Upon success, the BSF shall send an HTTP "200 OK" response to the PCF and update the binding information. + +### 8.5.8 Binding information Subscription + +![Sequence diagram for Binding information Subscription procedure](1b896a95bc9974ad01fac7ac6f541a96_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. Nbsf_Management_Subscribe Request + BSF-->>NF service consumer: 2. Nbsf_Management_Subscribe Response +``` + +The diagram illustrates the interaction between an NF service consumer and a BSF for binding information subscription. The NF service consumer sends a '1. Nbsf\_Management\_Subscribe Request' to the BSF, and the BSF responds with a '2. Nbsf\_Management\_Subscribe Response'. + +Sequence diagram for Binding information Subscription procedure + +**Figure 8.5.8-1: Binding information Subscription procedure** + +1. The NF service consumer (e.g. PCF for a UE, AF, NEF) invokes the Nbsf\_Management\_Subscribe service operation by sending an HTTP POST request with the Resource URI of the "Binding Subscriptions" resource as defined in clause 4.2.6.2 of 3GPP TS 29.521 [22] to subscribe to the notifications of registration/deregistration events for the PCF for a PDU Session or PCF for a UE. +2. Upon success, the BSF shall create and store the subscription, and send an HTTP "201 Created" response to the NF service consumer including the created subscription resource and the available binding information related to the subscription. + +### 8.5.9 Binding information Unsubscription + +![Sequence diagram for Binding information Unsubscription procedure](4d7f667796a8cdcdd745e953ac11e289_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. Nbsf_Management_Unsubscribe Request + BSF-->>NF service consumer: 2. Nbsf_Management_Unsubscribe Response +``` + +The diagram illustrates the interaction between an NF service consumer and a BSF for binding information unsubscription. The NF service consumer sends a '1. Nbsf\_Management\_Unsubscribe Request' to the BSF, and the BSF responds with a '2. Nbsf\_Management\_Unsubscribe Response'. + +Sequence diagram for Binding information Unsubscription procedure + +**Figure 8.5.9-1: Binding information Unsubscription procedure** + +1. The NF service consumer (e.g. PCF, AF, NEF) invokes the Nbsf\_Management\_Unsubscribe service operation by sending an HTTP DELETE request with the Resource URI of the "Individual Binding Subscription" resource to request the BSF to remove the corresponding subscription. + +2. Upon success, the BSF shall remove the corresponding subscription and send an HTTP "204 No Content" response to the NF service consumer. + +### 8.5.10 Binding information Notification + +![Sequence diagram showing the Binding information Notification procedure between an NF service consumer and a BSF.](573c8f9e728e343b6864e1070c14b8cf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: (Implicit) Subscription to Nbsf_Management_Notify + BSF->>NF service consumer: 1. Nbsf_Management_Notify Request + NF service consumer-->>BSF: 2. Nbsf_Management_Notify Response +``` + +Sequence diagram showing the Binding information Notification procedure between an NF service consumer and a BSF. + +**Figure 8.5.10-1: Binding information Notification procedure** + +1. If the notification has been previously subscribed in the BSF, the BSF invokes the Nbsf\_Management\_Notify service operation by sending the HTTP POST request with Resource URI as defined in clause 4.2.8.2 of 3GPP TS 29.521 [22] to notify the newly registration or deregistration events. +2. Once the NF consumer accepts the request, it sends an HTTP "204 No Content" response to the BSF. + +## 8.6 PCF discovery and selection procedures in MBS deployments + +### 8.6.1 PCF discovery and selection by the MB-SMF + +PCF discovery and selection functionality is implemented in the MB-SMF and follows the principles described in 3GPP TS 23.501 [2], clause 6.3.1. The MB-SMF uses the PCF services for the handling of the MBS session. + +When the MB-SMF performs discovery and selection for an MBS session, the MB-SMF may utilize the Nnrf\_NFDiscovery service of the Network Repository Function to discover the candidate PCF instance(s). In addition, PCF information may also be locally configured in the MB-SMF. The MB-SMF selects a PCF instance based on the available PCF instances (obtained from the NRF or locally configured in the MB-SMF). The following factors may be considered during the PCF selection. + +- Local operator policies. +- the features supported by the PCF +- PCF Set ID, if available. + +NOTE 1: A single PCF can be deployed in the network. In this case the information is preconfigured in the MB-SMF. + +NOTE 2: A single PCF can be used for the handling of location dependent MBS sessions. To enable this, the MB-SMF has to select the same PCF instance for all the MBS session establishments applicable for the same MBS Session Id. + +### 8.6.2 PCF discovery and selection by the AF/NEF/MBSF + +#### 8.6.2.1 General + +The AF/NEF/MBSF performs discovery and selection of the PCF for an MBS session. The AF/NEF/MBSF may utilize the Nnrf\_NFDiscovery service of the NRF to discover the candidate PCF instance(s). In addition, PCF information may + +also be locally configured in the AF/NEF/MBSF. The AF/NEF/MBSF selects a PCF instance based on the available PCF instances (obtained from the NRF or locally configured in the NEF/MBSF) and depending on operator's policies. + +When multiple and separately addressable PCFs are deployed, the BSF, as described in clause 8.6.2.2, is required in order to ensure that a consumer NF (e.g. AF, NEF, MBSF, MB-SMF) reaches over N5/N30/Nmb12/N7mb the PCF currently handling the MBS session. + +NOTE: This mechanism is not necessary in a deployment with a single PCF. + +#### 8.6.2.2 Binding Support Function (BSF) + +The BSF has the following characteristics: + +- a) The BSF stores internally information about the PCF selected to handle an MBS session. + - For a certain MBS session, the BSF stores internally information about the MBS Session ID and the selected PCF address for the MBS session, and if available, the associated PCF instance ID, PCF set ID and the level of SBA binding. + +NOTE 1: Only NF instance or NF set level of binding is supported at the BSF for SBA binding level. + +- b) The PCF uses the BSF to ensure that the same PCF is selected for the MBS Policy association(s) related to the same MBS Session ID, and in the case where the AF/NEF/MBSF interacts with the PCF for MBS Policy Authorization, to ensure that the same PCF is selected for MBS Policy Authorization (via the Npcf\_MBSPolicyAuthorization) and MBS Policy Association(s) management (via the Npcf\_MBSPolicyControl). The PCF utilizes the Nbsf\_Management service of the BSF to register, update or remove the stored PCF for an MBS session binding information at the BSF. The PCF ensures that the PCF for an MBS session binding information is updated each time the PCF instance is changed. + +At the reception of a PCF for an MBS session binding registration request, the BSF checks whether there is already a PCF handling the MBS Session identified by the provided MBS Session ID. If no such PCF is found, the BSF stores the information received in the request, i.e. registers the PCF sending the request as the PCF handling the MBS session; otherwise, the BSF rejects the registration request and includes the information of the existing PCF instance currently handling the MBS session in the response (see clause 4.2.2.4 of 3GPP TS 29.521 [22]). + +- c) For the retrieval of binding information, any NF, such as NEF, MBSF or AF, uses the Nbsf\_Management service as defined in 3GPP TS 29.521 [22] to discover the PCF instance currently handling the MBS session and the related information (i.e. PCF address(es), and if available, the associated PCF instance ID, PCF set ID and the level of SBA binding for the MBS Session ID). +- d) If the NF received a PCF set ID or a PCF instance ID with a level of SBA binding as result of the Nbsf management service registration or discovery service operations, it should use that information as NF set level or NF instance level SBA Binding Indication to route requests to the PCF. +- e) For an ongoing NF service session, the PCF may provide SBA Binding Indication to the NF (see clause 6.3.1.0 of 3GPP TS 23.501 [2]). This SBA Binding Indication shall then be used instead of any PCF information received from the BSF. + +### 8.6.3 BSF procedures + +#### 8.6.3.1 General + +These procedures concern the storage, update, discovery and removal of MBS session binding information in the BSF and the retrieval of binding information from the BSF. + +#### 8.6.3.2 Binding information Creation + +![Sequence diagram for Binding information Creation procedure](35a7554182eb055209552843f341a1ae_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF + Note left of PCF: + PCF->>BSF: 1. Nbsf_Management_Register request + BSF-->>PCF: 2. Nbsf_Management_Register response +``` + +The diagram shows a sequence of two messages between a PCF and a BSF. The PCF sends a '1. Nbsf\_Management\_Register request' to the BSF, and the BSF responds with a '2. Nbsf\_Management\_Register response'. + +Sequence diagram for Binding information Creation procedure + +**Figure 8.6.3.2-1: Binding information Creation procedure** + +1. In order to either: + +- register itself at the BSF as the PCF handling the MBS session; or +- check whether there is already a PCF handling the MBS session, and if it is not the case and when applicable, register at the BSF as the PCF handling the MBS session; + +the PCF shall invoke the Nbsf\_Management\_Register service operation by sending an HTTP POST request targeting the resource URI of the "PCF for an MBS Session Bindings" resource. + +2. Upon reception of the request from the PCF, the BSF shall either: + +- for location-dependent MBS sessions and if there is no PCF already handling the MBS session, register the PCF sending the request as the PCF handling the MBS session by creating the corresponding PCF for an MBS session binding resource and storing the received information. The BSF shall then send back a successful response to the PCF as defined in clause 4.2.2.4 of 3GPP TS 29.521 [22]; or +- if there is already a PCF handling the MBS session (i.e., there is an existing PCF for an MBS session binding stored at the BSF for the MBS session identified by the received MBS session ID), the BSF shall reject the request and return in the response the information of the PCF currently handling the MBS session as defined in clause 4.2.2.4 of 3GPP TS 29.521 [22]. + +#### 8.6.3.3 Binding information Update + +![Sequence diagram for Binding information Update procedure](3b621c21b0af3a504a28d2547e87138f_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF + Note left of PCF: + PCF->>BSF: 1. Nbsf_Management_Update request + BSF-->>PCF: 2. Nbsf_Management_Update response +``` + +The diagram shows a sequence of two messages between a PCF and a BSF. The PCF sends a '1. Nbsf\_Management\_Update request' to the BSF, and the BSF responds with a '2. Nbsf\_Management\_Update response'. + +Sequence diagram for Binding information Update procedure + +**Figure 8.6.3.3-1: Binding information Update procedure** + +1. If a PCF for an MBS session binding information has been previously registered at the BSF, the PCF invokes the Nbsf\_Management\_Update service operation by sending an HTTP PATCH request targeting the resource URI of the "Individual PCF for an MBS Session Binding" resource as defined in clause 4.2.5.4 of 3GPP TS 29.521 [22] to update the PCF for an MBS session binding information at the BSF (e.g. if a new PCF instance is selected, in which case, the PCF instance ID and the associated PCF address(es) are provided). + +2. Upon success, the BSF shall send an HTTP "200 OK" response to the PCF and update the corresponding PCF for an MBS session binding information. + +#### 8.6.3.4 Binding information Deletion + +![Sequence diagram for Binding information Deletion procedure](7a0db9703b68b3d06cdaeefc084c0006_img.jpg) + +``` +sequenceDiagram + participant PCF + participant BSF + Note left of PCF: Request removal of PCF for an MBS session binding + PCF->>BSF: 1. Nbsf_Management_Deregister request + BSF-->>PCF: 2. Nbsf_Management_Deregister response +``` + +The diagram illustrates the interaction between a PCF and a BSF for binding information deletion. The PCF sends a 'Nbsf\_Management\_Deregister request' to the BSF, and the BSF responds with a 'Nbsf\_Management\_Deregister response'. + +Sequence diagram for Binding information Deletion procedure + +**Figure 8.6.3.4-1: Binding information Deletion procedure** + +1. In order to request the removal of an existing PCF for an MBS session binding (i.e. the PCF is no longer handling the MBS session), the PCF invokes the Nbsf\_Management\_Deregister service operation by sending an HTTP DELETE request targeting the resource URI of the "Individual PCF for an MBS Session Binding" resource to request the BSF to remove the targeted PCF for an MBS session binding information as defined in clause 4.2.3.4 of 3GPP TS 29.521 [22]. +2. Upon success, the BSF shall send an HTTP "204 No Content" response to the PCF and remove the corresponding stored PCF for an MBS session binding information. + +#### 8.6.3.5 Binding information Retrieval + +![Sequence diagram for Binding information Retrieval procedure](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +``` +sequenceDiagram + participant AF/NEF/MBSF + participant BSF + Note left of AF/NEF/MBSF: Request address information of PCF + AF/NEF/MBSF->>BSF: 1. Nbsf_Management_Discovery request + BSF-->>AF/NEF/MBSF: 2. Nbsf_Management_Discovery response +``` + +The diagram illustrates the interaction between an AF/NEF/MBSF and a BSF for binding information retrieval. The AF/NEF/MBSF sends a 'Nbsf\_Management\_Discovery request' to the BSF, and the BSF responds with a 'Nbsf\_Management\_Discovery response'. + +Sequence diagram for Binding information Retrieval procedure + +**Figure 8.6.3.5-1: Binding information Retrieval procedure** + +1. The NF service consumer (e.g. NEF, AF, MBSF) invokes the Nbsf\_Management\_Discovery service operation by sending an HTTP GET request targeting the resource URI of the "PCF for an MBS Session Bindings" resource to the BSF to obtain the address information of the PCF currently handling an MBS session. The URI query parameter(s) to be provided in the HTTP GET request are specified in clause 4.2.4.4 of 3GPP TS 29.521 [22]. +2. Once the request is accepted and a PCF for an MBS session binding resource matching the provided query parameter(s) exists, the BSF shall send an HTTP "200 OK" response to the NF service consumer with the address information of the PCF currently handling the MBS session (i.e. PCF address(es), and if available, the associated PCF set ID, the PCF instance ID and the SBA binding level information). + +# 9 Race condition handling + +## 9.1 Overview + +Certain PCC Services (e.g., Npcf\_SMPolicyControl service, Npcf\_AMPolicyControl service) allow the NF producer (e.g. PCF) to update the policy association in two ways: unsolicited and solicited. The PCF can push policy decisions (e.g. PCC rule) to the NF consumer (e.g. SMF) in an unsolicited fashion (e.g. using UpdateNotify service operation for Npcf\_SMPolicyControl service). It can also install policy decisions in a solicited manner by responding to the NF consumer (e.g. using the response of the Update service operation for Npcf\_SMPolicyControl service). + +The NF producer and the NF consumer can initiate transactions that modify the policy independently (e.g. Update service operation from the NF consumer and UpdateNotify service operation from the NF producer) and potentially concurrently. Additionally, there may be HTTP proxy in between the NF consumer and NF producer that could cause messages to be delivered out of order. This can lead to race conditions that may result in the wrong information maintained by the NF consumer or NF producer of a policy association. + +Note that race conditions occur in different ways based on the application. Also, their impact is specific to the application. + +## 9.2 Procedures + +This clause describes the optional procedures for handling race conditions in a deterministic manner. These procedures apply to the SMF (Npcf\_SMPolicyControl service), AMF (Npcf\_AMFPolicyControl service and Npcf\_UEPolicyControl service), and PCF (Npcf\_SMPolicyControl service, Npcf\_AMFPolicyControl service and Npcf\_UEPolicyControl service). + +In this clause, the terms NF consumer and NF producer are relative to the service. As an example, for the Npcf\_SMPolicyControl service, the NF consumer is the SMF and the NF producer is the PCF. The term NF can refer to either a NF consumer or a NF producer. The term "transaction" refers to a HTTP request and its associated response. The term "ongoing transaction" refers to a transaction that has an outstanding response. + +A node that supports the procedures defined in this clause and is configured to comply with them, shall advertise such support by including the corresponding "PendingTransaction" feature within the attribute of SupportedFeatures data type during the policy association establishment. + +On receipt of a HTTP request for an existing policy association, the recipient NF shall check if it has an ongoing transaction on that policy association: + +1. If there are no ongoing transactions on the policy association, the NF shall process the incoming request normally. +2. If there is an ongoing transaction on the policy association and optionally, if the recipient NF cannot determine that the incoming request can be safely handled without creating a state mismatch: + - a. The NF consumer shall reject the incoming request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "PENDING\_TRANSACTION". + - b. The NF producer shall either reject the incoming request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "PENDING\_TRANSACTION" or shall wait for one of the following conditions to occur: + - i. The ongoing transaction completes. In this case, the policy association is updated at the NF producer on the completion of the ongoing transaction and afterwards, the incoming request (e.g. HTTP POST) is processed normally based on the updated policy association state. + - ii. The waiting period has exceeded its allotted time. In this case, the NF producer shall reject the incoming request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "PENDING\_TRANSACTION". +3. On receipt of a "PENDING\_TRANSACTION" error code, an NF consumer shall retry the request. On the other hand, if an NF producer had rejected a request from an NF consumer with a "PENDING\_TRANSACTION" error code, the NF producer should not retry the failed request until it responds to the re-attempted request from the NF consumer. This is to avoid having both the NF consumer and NF producer concurrently retry their requests. In all other cases, if the policy association on the NF consumer still needs to be updated, the NF producer shall retry the request. +4. The NF consumer or NF producer should limit the number of times they re-attempt the same request due to receipt of a "PENDING\_TRANSACTION" error code. +5. The only exception to the rules above is a policy association termination request initiated by the NF consumer (e.g. HTTP POST with request URI to "{apiRoot}/npcf-smpolicycontrol/{apiVersion}/sm-policies/{smPolicyId}/delete") or a request for policy association termination initiated by the NF producer (e.g. HTTP POST with request URI to "{notificationUri}/terminate"). In both cases, the request should be handled as follows: + +- a. When receiving a request for a policy association termination initiated by the NF producer that requires new transactions to be initiated or existing transactions to be finished, a NF consumer shall acknowledge the request immediately (e.g. a HTTP POST message with request URI to "`./{NotificationUri}/terminate`" shall be acknowledged with a 204 No Content response). The NF consumer shall wait for the current transaction to complete (either by the NF producer acknowledging the request or rejecting it with the "PENDING\_TRANSACTION" application error code) before completing the policy association termination procedure (e.g. before sending the HTTP POST with request URI to "`{apiRoot}/npcf-sm-policycontrol//sm-policies/{smPolicyId}/delete`"). + +NOTE: The client needs to wait for the outcome of the policy association modification to determine if the policy association termination procedure will be used to report information that could not be reported as part of the policy association modification procedure. + +- b. When receiving a request for a policy association termination initiated by the NF consumer, the NF producer shall handle it immediately. + +# Annex A (informative): DRA and BSF coexistence + +During the network migration, DRA and BSF may coexist in operator's network. When the AF sends Rx request to the DRA, the DRA can utilize the Nbsf\_Management\_Discovery service operation to obtain the relevant PCF address as depicted in figure A-1. The DRA only applies this operation if it has no stored binding information derived from an ongoing Gx session for that subscriber. + +NOTE 1: For a UE in the EPC there is a Gx session and the DRA stores the binding information. For a UE in the 5GC the Npcf\_SmPolicyControl service is used and the BSF stores the binding information. + +![Sequence diagram showing PCF discovery by DRA via BSF. The diagram illustrates three steps: 1. Diameter AAR from an external source to the DRA; 2. Nbsf_Management_Discovery request from the DRA to the BSF; 3. Nbsf_Management_Discovery response from the BSF back to the DRA.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` + +sequenceDiagram + participant AF + participant DRA + participant BSF + Note left of DRA: 1. Diameter AAR + AF->>DRA: 1. Diameter AAR + Note right of DRA: 2. Nbsf_Management_Discovery request + DRA->>BSF: 2. Nbsf_Management_Discovery request + Note right of BSF: 3. Nbsf_Management_Discovery response + BSF->>DRA: 3. Nbsf_Management_Discovery response + +``` + +Sequence diagram showing PCF discovery by DRA via BSF. The diagram illustrates three steps: 1. Diameter AAR from an external source to the DRA; 2. Nbsf\_Management\_Discovery request from the DRA to the BSF; 3. Nbsf\_Management\_Discovery response from the BSF back to the DRA. + +**Figure A-1: PCF discovery by DRA via BSF** + +1. The AF sends a Diameter AAR to the DRA to establish a new Rx diameter session. +2. When receiving the request in step 1, if the DRA has no stored binding information derived from an ongoing Gx session for the subscriber, the DRA invokes the Nbsf\_Management\_Discovery service operation to the BSF to obtain the selected PCF ID for a certain PDU session. +3. The BSF replies to the DRA with the PCF ID. + +NOTE 2: If the DRA has no stored binding information derived from an ongoing Gx session for a subscriber, the DRA needs to request new binding information for each Rx session establishment because the information in the BSF could have changed compared to any previous binding information the DRA requested. + +# Annex B (normative): Signalling Flows for IMS + +The signalling flows in clause 5 are also applicable for IMS services provided for a PLMN or an SNPN. This Annex adds flows that show interactions with SIP/SDP signalling of the IMS when the Npcf\_PolicyAuthorization service is used by the P-CSCF and both, the PCF and the P-CSCF support the "IMS\_SBI" feature, and when the P-CSCF uses the Rx reference point with the PCF. + +NOTE 1: In PLMNs or SNPNs where both Rx and Npcf\_PolicyAuthorization are used it is implementation specific how the P-CSCF determines the applicable interface/protocol to use with the PCF - e.g. Separate P-CSCF's used for Rx and Npcf\_PolicyAuthorization, local routing configuration in the P-CSCF. + +NOTE 2: In this Release only IMS voice and emergency services are provided for SNPN. + +## --- B.1 General + +The following is applicable for Emergency Services and PSAP call back request: + +- The P-CSCF includes an Emergency indication when service information is sent over N5/Rx and when required by the IMS deployment. The P-CSCF may also indicate that it requires UE identities as defined in 3GPP TS 29.514 [10] for N5 and 3GPP TS 29.214 [18] for Rx. +- The PCF only allows Emergency Sessions that are bound to a PDU session established to an Emergency DNN. +- Upon request from the P-CSCF, the PCF provides the P-CSCF with UE identities corresponding to the established PDU session. + +The following is not applicable for Emergency Services and PSAP call back request: + +- Pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. +- Subscription to notification of Signalling Path Status at IMS Registration, subscription to notification of changes of access type at IMS Registration and Provisioning of SIP Signalling flow information at IMS Registration procedures. + +## --- B.2 IMS Session Establishment + +### B.2.1 Provisioning of service information at Originating P-CSCF and PCF + +This clause covers the PCC procedures for the provisioning of service information, the retrieval of network provided location information (UE location and/or time zone) and the report of EPS fallback indication at the originating P-CSCF and PCF at IMS session establishment. + +In figure B.2.1-1 the P-CSCF derives the provisioning of service information to the PCF from the SDP offer/answer exchange. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF. Lifelines: UE, PCF, P-CSCF. The diagram illustrates the interaction between these entities for session establishment, including SDP offers/answers, policy authorization requests/responses, and PCC rules provisioning. It also highlights 'Rx Case' sections and the NPLI (user location and/or UE timezone information) exchange.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + + Note left of UE: NPLI: user location and/or UE timezone information + + UE->>P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Define down-link connection info + P-CSCF->>P-CSCF: 3. SDP offer + P-CSCF->>P-CSCF: 4. SDP answer + P-CSCF->>P-CSCF: 5. Define up-link connection info + P-CSCF->>PCF: 6. Npcf_PolicyAuthorization_Create request + Note right of PCF: Rx Case + PCF->>PCF: 6a. Diameter AAR + P-CSCF->>UE: 7. Store application session information and identify PDU session + P-CSCF->>PCF: 8. Npcf_PolicyAuthorization_Create response + Note right of PCF: Rx Case + PCF->>PCF: 8a. Diameter AAA + P-CSCF->>UE: 9. SDP answer + P-CSCF->>UE: 10. PCC rules provisioning + P-CSCF->>PCF: 11. Npcf_PolicyAuthorization_Notify request + PCF->>P-CSCF: 12. Npcf_PolicyAuthorization_Notify response + Note right of PCF: Rx Case + PCF->>PCF: 11a. Diameter RAR + PCF->>PCF: 12a. Diameter RAA + Note right of P-CSCF: If access network information and/or EPS fallback indication is requested + P-CSCF->>UE: 13. SIP with NPLI + +``` + +Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF. Lifelines: UE, PCF, P-CSCF. The diagram illustrates the interaction between these entities for session establishment, including SDP offers/answers, policy authorization requests/responses, and PCC rules provisioning. It also highlights 'Rx Case' sections and the NPLI (user location and/or UE timezone information) exchange. + +**Figure B.2.1-1: PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF** + +1. The P-CSCF receives the SDP parameters defined by the originator within an SDP offer in SIP signalling. +2. The P-CSCF identifies the connection information needed (IP address of the down link IP flow(s), port numbers to be used, etc.). +3. The P-CSCF forwards the SDP offer in SIP signalling. +4. The P-CSCF gets the negotiated SDP parameters from the terminating side through SIP signalling interaction. +5. The P-CSCF identifies the connection information needed (IP address of the up-link media IP flow(s), port numbers to be used, etc.). + +6. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Create service operation to forward the derived session information to the PCF by sending an HTTP POST request to the "Application Sessions" resource. + - 6a. The P-CSCF provides session information to the PCF by sending a Diameter AAR for a new Rx Diameter session. +7. The PCF stores application session information and performs session binding. For N5 interface, the PCF creates an "Individual Application Session Context" resource to store the received application session information. +8. The PCF replies to the P-CSCF with a HTTP "201 Created" response and includes the URI of the "Individual Application Session Context" resource in the Location header field. + - 8a. The PCF sends a Diameter AAA to the P-CSCF. +9. Upon reception of the acknowledgement from the PCF, the SDP parameters are passed to the UE in SIP signalling. +10. The PCF executes interactions according to figure 5.2.2.2-1. This step implies provisioning of PCC rules and is executed in parallel with steps 8 and 9 (steps 8a and 9a for Rx case). +11. If the P-CSCF requested access network information and/or EPS fallback indication in step 6, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the EPS fallback indication, if received in step 10, and/or the access network information received in step 10 in an HTTP POST request sent to the Notification URI received in step 6. + - 11a. If the P-CSCF requested access network information and/or EPS fallback indication in step 6a, the PCF forwards the EPS fallback indication, if received in step 10, and the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response to the PCF. + - 12a. If step 11a occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs (step 11a for Rx case), the P-CSCF forwards the network provided location information in a subsequent SIP message to IMS core network. The P-CSCF, based on local configuration, may also include the EPS fallback indication, if received. + +Optionally, the provisioning of service information may be derived already from the SDP offer: + +- to enable a possible rejection of the service information by the PCF, obtained by the P-CSCF in time to reject the service with appropriate SIP signalling; +- to allow the P-CSCF to request network provided location information for inclusion in the SDP offer; +- to support authentication of roaming users in deployments with no IMS-level roaming interfaces; or +- to support PSAP callback functionality for anonymous IMS emergency sessions. + +This is described in figure B.2.1-2. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF. Lifelines: UE, PCF, P-CSCF. The diagram illustrates the flow of SDP offers, policy authorization requests, and provisioning of PCC rules. It includes Rx Case segments and a final NPLI (user location and/or UE timezone information) block.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + + Note left of UE: Rx Case + UE->>P-CSCF: 1. SDP offer + Note right of P-CSCF: 2. Extract down-link service information + P-CSCF->>PCF: 3. Npcf_PolicyAuthorization_Create request + Note right of PCF: Rx Case + PCF->>P-CSCF: 3a. Diameter AAR + Note right of P-CSCF: 4. Authorize service information + P-CSCF->>PCF: 5. Npcf_PolicyAuthorization_Create response + Note right of PCF: Rx Case + PCF->>P-CSCF: 5a. Diameter AAA + Note right of P-CSCF: 6. SDP offer (without NPLI) + Note right of P-CSCF: If access network information is requested + Note left of PCF: 7. PCC rules provisioning + P-CSCF->>PCF: 8. Npcf_PolicyAuthorization_Notify request + Note right of PCF: Rx Case + PCF->>P-CSCF: 8a. Diameter RAR + PCF->>P-CSCF: 9a. Diameter RAA + Note right of P-CSCF: 10a. SDP offer (with NPLI) + Note right of P-CSCF: 10b. SIP (with NPLI) + P-CSCF->>UE: 11. SDP answer + Note right of P-CSCF: 12. Extract up-link service information + P-CSCF->>PCF: 13. Npcf_PolicyAuthorization_Update request + Note right of PCF: Rx Case + PCF->>P-CSCF: 13a. Diameter AAR + Note right of P-CSCF: 14. Store application session context Information + P-CSCF->>PCF: 15. Npcf_PolicyAuthorization_Update response + Note right of PCF: Rx Case + PCF->>P-CSCF: 15a. Diameter AAA + Note right of P-CSCF: 16. PCC rules provisioning + P-CSCF->>UE: 17. SDP answer + Note left of UE: NPLI: user location and/or UE timezone information + +``` + +Sequence diagram showing PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF. Lifelines: UE, PCF, P-CSCF. The diagram illustrates the flow of SDP offers, policy authorization requests, and provisioning of PCC rules. It includes Rx Case segments and a final NPLI (user location and/or UE timezone information) block. + +**Figure B.2.1-2: PCC Procedures for IMS Session Establishment at originating P-CSCF and PCF, provisioning of service information derived from SDP offer and answer** + +1. The P-CSCF receives the first SDP offer for a new SIP dialogue within a SIP INVITE request. + +2. The P-CSCF extracts service information from the SDP offer (IP address of the down link IP flow(s), port numbers to be used, etc.). +3. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Create service operation to forward the derived service information to the PCF by sending an HTTP POST request to the "Application Sessions" resource. It indicates that only an authorization check of the service information is requested. + - 3a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR for a new Rx Diameter session. It indicates that only an authorization check of the service information is requested. +4. The PCF checks and authorizes the service information, stores session information, performs session binding, but does not provision PCC rules at this stage. In case of N5 interface, the PCF creates an "Individual Application Session Context" resource to store the application session information. +5. The PCF replies to the P-CSCF with an HTTP "201 Created" response and includes the URI of the "Individual Application Session Context" resource in the Location header field. + - 5a. The PCF replies to the P-CSCF with a Diameter AAA. +6. If the P-CSCF did not request access network information in step 3 (or step 3a for Rx case), or if the P-CSCF requested access network information but does not require the access network information for inclusion in the SDP offer, or the P-CSCF requested user information in step 3 (or step 3a for Rx case) the P-CSCF forwards the SDP offer in SIP signalling. +7. If the P-CSCF requested access network information in step 3 (or step 3a for Rx case), the PCF executes interactions according to figure 5.2.2.2-1. This step implies provisioning of PCC rules. +8. If the P-CSCF requested access network information in step 3, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the access network information received in step 7 in an HTTP POST request sent to the Notification URI received in step 3. + - 8a. If the P-CSCF requested access network information in step 3a, the PCF forwards the access network information received in step 7 in a Diameter RAR. +9. If step 8 occurs, the P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response to the PCF. + - 9a. If step 8a occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +- 10a. If step 8 occurs (or step 8a for Rx case), and if the P-CSCF requires to send the access network information and the SDP offer together, the P-CSCF includes the SDP offer and the network provided location information in the next SIP message the P-CSCF sends towards the IMS core network. +- 10b. If step 8 occurs (or step 8a for Rx case), and if it is allowed for the P-CSCF to handle the access network information independently of the SDP offer, the P-CSCF includes the network provided location information in a subsequent SIP message the P-CSCF sends towards the IMS core network. Typically, network provided information is sent after step 17 rather than at step 10. +11. The P-CSCF receives the negotiated SDP parameters from the terminating side within a SDP answer in SIP signalling. +12. The P-CSCF extracts service information from the SDP answer (IP address of the up-link media IP flow(s), port numbers to be used, etc.). +13. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation to modify the "Individual Application Session Context" resource in the PCF by sending an HTTP PATCH request to the URI of the "Individual Application Session Context" resource with the derived service information. Access network information is not requested if done in step 7. + - 13a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR over the existing Rx Diameter session. Access network information is not requested if done in step 7. +14. The PCF stores the received information. In case of N5 interface, the PCF updates the "Individual Application Session Context" with the received application session information. +15. The PCF replies to the P-CSCF with an HTTP "204 No Content" response. + +- 15a. The PCF replies the P-CSCF with a Diameter AAA. +16. The PCF authorizes the session information. The PCF executes interactions according to figure 5.2.2.2-1. This step implies provisioning of PCC rules and authorized QoS. +17. Upon successful authorization of the session, the SDP parameters are passed to the UE in SIP signalling. This step is executed in parallel with step 16. + +### B.2.2 Provisioning of service information at terminating P-CSCF and PCF + +This clause covers the PCC procedures for the provisioning of service information, the retrieval of network provided location information (UE location and/or time zone) and the report of EPS fallback indication at the terminating P-CSCF and PCF at IMS session establishment. + +In figure B.2.2-1 the P-CSCF derives the provisioning of service information to the PCF from the SDP offer/answer exchange. + +![Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCF. Lifelines: P-CSCF, PCF, UE. The diagram illustrates the interaction between these entities for session establishment, including SDP offers/answers, policy authorization requests, and provisioning of PCC rules. It also highlights 'Rx Case' sections and the NPLI (user location and/or UE timezone information) handling.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant P-CSCF + participant PCF + participant UE + + Note left of P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Define up-link connection info + P-CSCF->>UE: 3. SDP offer + UE->>P-CSCF: 4. SDP answer + Note left of P-CSCF: 5. Define down-link connection info + P-CSCF->>PCF: 6. Npcf_PolicyAuthorization_Create request + Note left of P-CSCF: Rx Case + P-CSCF->>PCF: 6a. Diameter AAR + Note right of PCF: 7. Store session information and identify PDU session + PCF->>P-CSCF: 8. Npcf_PolicyAuthorization_Create response + Note left of P-CSCF: Rx Case + PCF->>P-CSCF: 8a. Diameter AAA + P-CSCF-->>P-CSCF: 9. SDP answer (without NPLI) + Note right of PCF: 10. Provisioning of PCC rules + PCF-->>P-CSCF: 11. Npcf_PolicyAuthorization_Notify request + P-CSCF-->>PCF: 12. Npcf_PolicyAuthorization_Notify response + Note left of P-CSCF: Rx Case + PCF-->>P-CSCF: 11a. Diameter RAR + P-CSCF-->>PCF: 12a. Diameter RAA + Note right of PCF: If access network information and/or EPS fallback indication is requested + P-CSCF-->>P-CSCF: 13. SDP answer (with NPLI) + Note left of P-CSCF: NPLI: user location and/or UE timezone information + +``` + +Sequence diagram showing PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCF. Lifelines: P-CSCF, PCF, UE. The diagram illustrates the interaction between these entities for session establishment, including SDP offers/answers, policy authorization requests, and provisioning of PCC rules. It also highlights 'Rx Case' sections and the NPLI (user location and/or UE timezone information) handling. + +**Figure B.2.2-1: PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCF** + +1. The P-CSCF receives the SDP parameters defined by the originator. +2. The P-CSCF identifies the connection information needed (IP address of the up-link IP flow(s), port numbers to be used, etc.). +3. The P-CSCF sends the SDP offer to the UE. + +4. The P-CSCF receives the negotiated SDP parameters from the UE. +5. The P-CSCF identifies the connection information needed (IP address of the down-link IP flow(s), port numbers to be used, etc.). +6. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Create service operation to forward the derived service information to the PCF by sending an HTTP POST request to the "Application Sessions" resource. + - 6a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR for a new Rx Diameter session. +7. The PCF stores the received session information, and performs session binding. For the N5 interface, the PCF creates an "Individual Application Session Context" resource to store the received application session information. +8. The PCF sends an HTTP "201 Created" response to the P-CSCF and includes the URI of the "Individual Application Session Context" resource in the Location header field. + - 8a. The PCF sends a Diameter AAA to the P-CSCF. +9. If the P-CSCF did not request access network information in step 6 (or step 6a for the Rx case), upon reception of the acknowledgement from the PCF, the SDP parameters in the SDP answer are passed to the originator. +10. The PCF executes interactions according to clause 5.2.2.2.1 This step implies provisioning of PCC rules and is executed in parallel with steps 8 (or step 8a for the Rx case) and 9. +11. If the P-CSCF requested access network information and/or EPS fallback indication in step 6, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward EPS fallback indication, if received in step 10, and/or the the access network information received in step 10 by sending an HTTP POST request to the Notification URI received in step 6. + - 11a. If the P-CSCF requested access network information and/or EPS fallback in step 6a, the PCF forwards the EPS fallback indication, if received in step 10, and/or the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response. + - 12a. If step 11a occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs (or step 11a for the Rx case), the P-CSCF forwards the SDP answer and includes the network provided location information in the next SIP message the P-CSCF sends towards the IMS core network. The P-CSCF, based on local configuration, may include the EPS fallback indication in outgoing SIP messages towards other IMS nodes, if received. + +Optionally, the provisioning of service information may be derived already from the SDP offer: + +- to enable that a possible rejection of the service information by the PCF is obtained by the P-CSCF in time to reject the service with appropriate SIP signalling; or +- to enable pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. + +This is described in figure B.2.2-2. + +![Sequence diagram showing the interaction between P-CSCF, PCF, and UE for SDP offer/answer processing with policy authorization. The diagram includes steps for SDP offer/answer exchange, policy authorization requests (Npcf_PolicyAuthorization_Create/Update/Notify), and Diameter messages (AAR, AAA, RAR, RAA).](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +``` + +sequenceDiagram + participant P-CSCF + participant PCF + participant UE + + Note left of P-CSCF: 1. SDP offer + P-CSCF->>P-CSCF: 2. Extract up-link service information + P-CSCF->>PCF: 3. Npcf_PolicyAuthorization_Create request + Note left of PCF: Rx Case + PCF->>PCF: 3a. Diameter AAR + Note right of PCF: 4. Authorize service information + PCF->>P-CSCF: 5. Npcf_PolicyAuthorization_Create response + Note left of PCF: Rx Case + PCF->>PCF: 5a. Diameter AAA + PCF->>UE: 6. SDP offer + Note right of PCF: 7. Provisioning of PCC rules + UE->>P-CSCF: 8. SDP answer + Note left of P-CSCF: 9. Extract down-link service information + P-CSCF->>PCF: 10. Npcf_PolicyAuthorization_Update request + Note left of PCF: Rx Case + PCF->>PCF: 10a. Diameter AAR + Note right of PCF: 11. Store session information + PCF->>P-CSCF: 12. Npcf_PolicyAuthorization_Update response + Note left of PCF: Rx Case + PCF->>PCF: 12a. Diameter AAA + Note right of PCF: 13. Provisioning of PCC rules + Note left of P-CSCF: 14. SDP answer (without NPLI) + P-CSCF-->>P-CSCF: 15. Npcf_PolicyAuthorization_Notify request + P-CSCF-->>PCF: 16. Npcf_PolicyAuthorization_Notify response + Note right of PCF: If access network information is requested + Note left of PCF: Rx Case + PCF-->>PCF: 15a. RAR + PCF-->>PCF: 16a. Diameter RAA + Note left of P-CSCF: 17. SDP answer (with NPLI) + P-CSCF-->>P-CSCF: 17. SDP answer (with NPLI) + + Note right of P-CSCF: NPLI: user location and/or UE timezone information + Note right of PCF: 3GPP + +``` + +**NPLI:** +user location and/or UE +timezone information + +**3GPP** + +Sequence diagram showing the interaction between P-CSCF, PCF, and UE for SDP offer/answer processing with policy authorization. The diagram includes steps for SDP offer/answer exchange, policy authorization requests (Npcf\_PolicyAuthorization\_Create/Update/Notify), and Diameter messages (AAR, AAA, RAR, RAA). + +###### **Figure B.2.2-2: PCC Procedures for IMS Session Establishment at terminating P-CSCF and PCF, provisioning of service information derived from SDP offer and answer** + +1. The P-CSCF receives the first SDP offer for a new SIP dialogue within SIP signalling, e.g. within a SIP INVITE request. +2. The P-CSCF extracts the service information from the SDP offer (IP address of the up-link IP flow(s), port numbers to be used, etc.). +3. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Create service operation to forward the derived session information to the PCF by sending an HTTP POST request to the "Application Sessions" resource. + - 3a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR for a new Rx Diameter session. + +The P-CSCF indicates to the PCF that the service information that the AF has provided to the PCF is preliminary and needs to be further negotiated between the two ends. The P-CSCF may request access network information and/or EPS fallback indication. + +4. The PCF checks and authorizes the session information, performs session binding, but does not provision PCC rules at this stage. In case of N5 interface, the PCF creates an "Individual Application Session Context" resource, +5. The PCF replies to the P-CSCF with an HTTP "201 Created" response and includes the URI of the "Individual Application Session Context" resource in the Location header field. + - 5a. The PCF replies to the P-CSCF with a Diameter AAA. +6. The P-CSCF sends the SDP offer to the UE. +7. If the UE initiates a QoS flow modification request, the PCF provides the SMF with PCC rules according to figure 5.2.2.2-1 based on the SDP offer. + +NOTE: Step 7 is not applicable for IMS Emergency Sessions. + +8. The P-CSCF receives the negotiated SDP parameters from the UE within an SDP answer in SIP signalling. +9. The P-CSCF extracts service information from the SDP answer (IP address of the down-link IP flow(s), port numbers to be used, etc.). +10. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation to modify the "Individual Application Session Context" resource by sending to the PCF an HTTP PATCH request to the URI of the "Individual Application Session Context" resource with the derived service information. The P-CSCF may request access network information and/or EPS fallback information if not requested in step 3. + - 10a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR over the existing Rx Diameter session. The P-CSCF may request access network information and/or EPS fallback information if not requested in step 3a. +11. The PCF stores the received session information. In case of N5 interface, the updates the "Individual Application Session Context" resource with the received session information. +12. The PCF sends an HTTP "204 No Content" response to the P-CSCF. + - 12a. The PCF replies to the P-CSCF with a Diameter AAA. +13. The PCF authorizes the session information. The PCF executes interactions according to figure 5.2.2.2-1. This step implies provisioning of PCC rules and authorized QoS. +14. If the P-CSCF did not request access network information in step 3 or 10 (step 3a or 10a for Rx case), upon successful authorization of the session the SDP parameters in the SDP answer are passed to the originator. This step is executed in parallel with step 12 (step 12a for Rx case). +15. If the P-CSCF requested access network information and/or EPS fallback indication in step 3 or 10, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the EPS fallback indication, if + +received in step 13, and the access network information received in step 13 in an HTTP POST request to the Notification URI received in in step 3 or 10. + +- 15a. If the P-CSCF requested access network information and/or EPS fallback indication in step 3a or 10a, the PCF forwards the EPS fallback indication, if received in step 13, and the access network information received in step 13 in a Diameter RAR. +16. If step 15 occurs, the P-CSCF acknowledges the receipt of the notification request with an an HTTP "204 No Content" response to the PCF. + - 16a. If step 15a occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +17. If step 15 occurs (step 15a for Rx case), the P-CSCF forwards the SDP answer and includes the network provided location information in the next SIP message the P-CSCF sends towards the IMS core network. The P-CSCF, based on local configuration, may include the EPS fallback indication in outgoing SIP messages towards other IMS nodes, if received. + +## --- B.3 IMS Session Modification + +### B.3.1 Provisioning of service information + +This clause covers the provisioning of service information and the retrieval of network provided location information (UE location and/or time zone), and for the Npcf\_PolicyAuthorization service, the report of EPS fallback indication, at IMS session modification both at the originating and terminating side. + +In figure B.3.1-1 the P-CSCF derives the provisioning of service information to the PCF from the SDP offer/answer exchange. + +![Sequence diagram showing the provisioning of service information at IMS session modification between PCF and P-CSCF. The diagram includes steps for SDP offer/answer exchange, service information extraction, policy authorization updates, and optional network information notifications. Rx Case markers and NPLI (user location and/or UE timezone information) are also indicated.](4792a2ccd62226861fadc22117edb7b1_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant P-CSCF + Note left of PCF: Rx Case + Note right of P-CSCF: 2. extract changes in service information from SDP offer + Note right of P-CSCF: 5. Extract changes in service information from SDP answer + Note left of PCF: Rx Case + Note right of P-CSCF: 10. Interactions in Figure 5.2.2.2.1-1 + Note right of P-CSCF: If access network information and/or EPS fallback indication is requested + Note left of PCF: Rx Case + Note right of P-CSCF: If access network information is requested + Note bottom: NPLI: user location and/or UE timezone information + +``` + +The sequence diagram illustrates the interaction between the PCF and P-CSCF for provisioning service information during an IMS session modification. The process begins with an SDP offer from the originator to the P-CSCF. The P-CSCF extracts changes in service information from the SDP offer and sends an SDP offer to the PCF. The PCF responds with an SDP answer. The P-CSCF then extracts changes in service information from the SDP answer and sends an Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF stores AF session context info and identifies the PDU session, then responds with an Npcf\_PolicyAuthorization\_Update response. The PCF also sends a Diameter AAA to the P-CSCF. The PCF sends an SDP answer (without NPLI) to the originator. The PCF then performs interactions as defined in Figure 5.2.2.2.1-1. The PCF sends an Npcf\_PolicyAuthorization\_Notify request to the P-CSCF. The P-CSCF responds with an Npcf\_PolicyAuthorization\_Notify response. The PCF also sends a Diameter RAR to the P-CSCF. The P-CSCF responds with a Diameter RAA. Finally, the PCF sends an SDP answer (with NPLI) to the originator. The NPLI (user location and/or UE timezone information) is indicated in the final SDP answer. The Rx Case markers indicate specific processing cases. The conditional blocks indicate optional network information requests. + +Sequence diagram showing the provisioning of service information at IMS session modification between PCF and P-CSCF. The diagram includes steps for SDP offer/answer exchange, service information extraction, policy authorization updates, and optional network information notifications. Rx Case markers and NPLI (user location and/or UE timezone information) are also indicated. + +**Figure B.3.1-1: Provisioning of service information at IMS session modification** + +1. The P-CSCF receives the SDP parameters defined by the originator within an SDP offer in SIP signalling. +2. The P-CSCF identifies the relevant changes in the SDP. + +3. The P-CSCF forwards the SDP offer in SIP signalling. +4. The P-CSCF gets the negotiated SDP parameters from the terminating side through SIP signalling interaction. +5. The P-CSCF identifies the relevant changes in the SDP. +6. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource, and includes the derived updated information. + - 6a. The P-CSCF sends a Diameter AAR for an existing Diameter session and includes the derived updated service information. +7. The PCF stores the received updated session information and identifies the affected established PDU Session. For N5 interface, the PCF updates the "Individual Application Session Context" resource. +8. The PCF replies to the P-CSCF with a HTTP "200 OK" response. + - 8a. The PCF answers with a Diameter AAA. +9. If the P-CSCF did not request access network information in step 6 (step 6a for Rx case), the P-CSCF forwards the SDP answer in SIP signalling. +10. The PCF executes interactions according to figure 5.2.2.2.1-1. Due to the updated service information, this step may imply provisioning of PCC rules or the need to enable or disable IP Flows (see clauses B.3.2 and B.3.3, respectively). +11. If the P-CSCF requested access network information and/or EPS fallback indication in step 6, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the EPS fallback indication, if received in step 10, and/or the access network information received in step 10 in an HTTP POST request sent to the Notification URI received in step 6. + - 11a. If the P-CSCF requested access network information in step 6a, the PCF forwards the access network information received in step 10 in a Diameter RAR. +12. If step 11 occurs, the P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response to the PCF. + - 12a. If step 11 occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +13. If step 11 occurs (step 11a for Rx case), the P-CSCF includes the SDP answer and the network provided location information in the next SIP message the P-CSCF sends towards the IMS core network. + +Optionally, the provisioning of service information may be derived already from the SDP offer to: + +- enable that a possible rejection of the service information by the PCF is obtained by the P-CSCF in time to reject the service with appropriate SIP signalling; or +- enable pre-authorization for a UE terminated IMS session establishment with UE initiated resource reservation. + +This is described in figure B.3.1-2. + + + +![Sequence diagram showing interactions between PCF and P-CSCF. The diagram includes messages such as SDP offer, Npcf_PolicyAuthorization_Update request, Diameter AAR, Diameter AAA, and provisioning of PCC rules. It also features 'Rx Case' highlighted sections and conditional logic for network information requests.](aa81b9b80bd1e3d723922b3a033564a2_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant P-CSCF + Note left of PCF: Rx Case + Note right of P-CSCF: extract changes in service information from SDP offer + Note left of PCF: authorize service information + Note left of PCF: Provisioning of PCC rules + Note right of P-CSCF: extract changes in service information from SDP answer + Note left of PCF: Provisioning of PCC rules + Note right of P-CSCF: If access network information is requested and/or EPS fallback indication is requested + Note left of PCF: Rx Case + Note right of P-CSCF: If access network information is requested + + Note left of PCF: 1. SDP offer + Note right of P-CSCF: 2. extract changes in service information from SDP offer + Note left of PCF: 3. Npcf_PolicyAuthorization_Update request + Note left of PCF: 3a. Diameter AAR + Note left of PCF: 4. authorize service information + Note left of PCF: 5. Npcf_PolicyAuthorization_Update response + Note left of PCF: 5a. Diameter AAA + Note left of PCF: 6. Provisioning of PCC rules + Note right of P-CSCF: 7. SDP offer + Note right of P-CSCF: 8. SDP answer + Note right of P-CSCF: 9. extract changes in service information from SDP answer + Note left of PCF: 10. Npcf_PolicyAuthorization_Update request + Note left of PCF: 10a. Diameter AAR + Note left of PCF: 11. Npcf_PolicyAuthorization_Update response + Note left of PCF: 11a. Diameter AAA + Note left of PCF: 12. Provisioning of PCC rules + Note left of PCF: 13. SDP answer (without NPLI) + Note right of P-CSCF: 14. Npcf_PolicyAuthorization_Notify request + Note right of P-CSCF: 15. Npcf_PolicyAuthorization_Notify response + Note left of PCF: 14a. Diameter RAR + Note left of PCF: 15a. Diameter RAA + Note left of PCF: 16. SDP answer (With NPLI) + +``` + +The sequence diagram illustrates the interaction between the PCF (Policy Control Function) and the P-CSCF (PDN Gateway Control Function). The process begins with an SDP offer from an external source to the P-CSCF. The P-CSCF extracts changes in service information and sends an Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF responds with an Npcf\_PolicyAuthorization\_Update response, which is accompanied by Diameter AAR and AAA messages. The PCF then provisions PCC rules. The P-CSCF sends an SDP offer to the external source and receives an SDP answer. It extracts changes in service information and sends another Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF responds with an Npcf\_PolicyAuthorization\_Update response, again accompanied by Diameter AAR and AAA messages. The PCF provisions PCC rules again. Finally, the PCF sends an SDP answer (without NPLI) to the P-CSCF. The P-CSCF sends an Npcf\_PolicyAuthorization\_Notify request to the PCF, and the PCF responds with an Npcf\_PolicyAuthorization\_Notify response, which is accompanied by Diameter RAR and RAA messages. The PCF then sends an SDP answer (With NPLI) to the P-CSCF. The diagram includes 'Rx Case' highlighted sections for the Diameter messages and conditional logic for network information requests. + +Sequence diagram showing interactions between PCF and P-CSCF. The diagram includes messages such as SDP offer, Npcf\_PolicyAuthorization\_Update request, Diameter AAR, Diameter AAA, and provisioning of PCC rules. It also features 'Rx Case' highlighted sections and conditional logic for network information requests. + +###### **Figure B.3.1-2: Provisioning of service information derived from SDP offer and answer at IMS session modification** + +1. The P-CSCF receives an SDP offer in SIP signalling for an existing SIP dialogue. +2. The P-CSCF identifies the relevant changes in the SDP and extracts the corresponding service information. +3. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource created for the corresponding SIP session, and updates the PCF with the derived updated information. + - 3a. The P-CSCF forwards the derived service information to the PCF by sending a Diameter AAR over the existing Rx Diameter session for the corresponding SIP session. + +The P-CSCF request indicates that the service information that the AF has provided to the PCF is preliminary and needs to be further negotiated between the two ends. + +4. The PCF checks and authorizes the session information, but does not provision PCC rules at this stage. +5. The PCF replies to the P-CSCF with a HTTP "200 OK" response + - 5a. The PCF answers with a Diameter AAA. +6. If the UE initiates a QoS flow resource modification request, the PCF provides the SMF with PCC rules according to figure 5.2.2.3-1 based on the SDP offer. + +NOTE: Step 6 is not applicable for IMS Emergency Sessions. + +7. The P-CSCF forwards the SDP offer in SIP signalling. +8. The P-CSCF receives the negotiated SDP parameters within an SDP answer in SIP signalling from the terminating side. +9. The P-CSCF identifies the relevant changes in the SDP and extracts the corresponding service information. +10. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource, and includes the derived updated information. + - 10a. The P-CSCF sends a Diameter AAR for an existing Diameter session and includes the derived updated service information. +11. The PCF replies to the P-CSCF with a HTTP "200 OK" response + - 11a. The PCF answers with a Diameter AAA. +12. The PCF interacts with the SMF according to figure 5.2.2.2.2.2-1. This step may imply provisioning of PCC rules and authorized QoS. The PCF may need to enable or disable IP Flows (see clauses B.3.2 and B.3.3, respectively) due to the updated service information. +13. If the P-CSCF did not request access network information in step 3 (step 3a for the Rx case) or step 10 (step 10a for the Rx case), the P-CSCF forwards the SDP answer in SIP signalling. This step is executed in parallel with step 12. +14. If the P-CSCF requested access network information and/or EPS fallback indication in step 3 or 10, the PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the EPS fallback indication, if received in step 12, and/or the access network information received in step 12. + - 14a. If the P-CSCF requested access network information in step 3a or 10a, the PCF forwards the access network information received in step 12 in a Diameter RAR. +15. If step 14 occurs, the P-CSCF acknowledges the notification with a HTTP "204 No Content" response + - 15a. If step 14a occurs, the P-CSCF acknowledges the receipt of Diameter RAR. +16. If step 14 occurs (or step 14a for the Rx case), the P-CSCF includes the SDP answer and the network provided location information in the next SIP message the P-CSCF sends towards the IMS core network. + +### B.3.2 Enabling of IP Flows + +The PCF makes a final decision to enable the allocated QoS resource for the authorized IP flows of the media component(s) if the QoS resources are not enabled at the time they are authorized by the PCF (e.g. because of gate control of early media) or if the media IP flow(s) previously placed on hold are resumed, i.e. the media IP flow(s) of the media component that was placed on hold at the time of the resource authorization or at a later stage is reactivated (with SDP direction sendrecv, sendonly, recvonly or none direction). + +The Enabling of IP Flows procedure is triggered during the early dialog by the P-CSCF receiving the SIP message (e.g. 18x response on initial INVITE request) with the P-Early-Media header field indicating request for authorization of early media as described in clause B.2.2 of 3GPP TS 29.514 [10]. + +NOTE: Enabling of IP Flows is also possible as part of preliminary responses in order to support SIP Forking scenarios. See clause B.3.1 of 3GPP TS 29.514 [10]. + +The Enabling of IP Flows procedure is triggered during the confirmed dialog by the P-CSCF receiving SIP 2xx response to an INVITE request or a 2xx response to an in-dialog UPDATE request in an established dialog (in both cases a 200 OK response is usually received). When receiving such responses, the P-CSCF shall take the SDP direction attribute in the latest received SDP (either within the 2xx response or a previous SIP message) into account when deciding, which gates shall be opened: + +- For a unidirectional SDP media component, IP flows in the opposite direction shall not be enabled. +- For an inactive SDP media component, no IP flows shall be enabled. + +Figure B.3.2-1 is applicable to the originating and terminating sides for a confirmed dialog. + +![Sequence diagram illustrating the Enabling of IP Flows procedure between UE, PCF, and P-CSCF.](e2c1c672349c10dccb2563eff6d8260e_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of UE: Rx Crise + Note right of P-CSCF: 1. 2xx response + Note right of P-CSCF: 2. Npcf_PolicyAuthorization_Update request + Note right of P-CSCF: 2a. Diameter AAR + Note left of UE: Rx Crise + Note right of P-CSCF: 3. PCF updates flow status of affected PCC rules + Note right of P-CSCF: 4. Npcf_PolicyAuthorization_Update response + Note right of P-CSCF: 4a. Diameter AAA + Note left of UE: Rx Crise + Note right of P-CSCF: 5. 2xx response + Note right of P-CSCF: 6. PCF opens the gates + +``` + +The sequence diagram shows the interaction between the User Equipment (UE), Policy Control Function (PCF), and PDN Gateway (P-CSCF) for enabling IP flows. The process starts with the P-CSCF receiving a 2xx response (Step 1). It then sends an Npcf\_PolicyAuthorization\_Update request to the PCF (Step 2), which in turn sends a Diameter AAR to the PCF (Step 2a). The PCF updates the flow status of affected PCC rules (Step 3). The PCF then sends an Npcf\_PolicyAuthorization\_Update response to the P-CSCF (Step 4), which in turn sends a Diameter AAA to the P-CSCF (Step 4a). The P-CSCF sends a 2xx response to the UE (Step 5). Finally, the PCF opens the gates (Step 6). The diagram includes 'Rx Crise' labels on the UE side and numbered steps on the P-CSCF side. + +Sequence diagram illustrating the Enabling of IP Flows procedure between UE, PCF, and P-CSCF. + +Figure B.3.2-1: Enabling of IP Flows + +1. The P-CSCF receives the SIP 2xx response complying with the conditions specified in the paragraphs above. + +2. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource to the PCF requesting that gates shall be opened. + - 2a. The P-CSCF sends a Diameter AAR message to the PCF, requesting that gates shall be opened. +3. The PCF approves the enabling of IP flows and PCF updates flow status of affected PCC rules. +4. The PCF replies to the P-CSCF with a HTTP "200 OK" response. + - 4a. The PCF sends a Diameter AAA to the P-CSCF. +5. The P-CSCF forwards the SIP 2xx response to the UE. +6. The PCF executes interactions according to figure 5.2.2.2.2.2-1. This step implies opening the "gates" by updating the flow status of PCC rules. + +### B.3.3 Disabling of IP Flows + +The Disabling of IP Flows procedure is used when media IP flow(s) of a session are put on hold (e.g. in case of a media re-negotiation or call hold). + +NOTE 1: Disabling of IP Flows is also possible as part of preliminary responses in order to support SIP Forking scenarios. See clause B.3.1 of 3GPP TS 29.514 [10]. + +Media is placed on hold as specified in IETF RFC 3264 [43]. Media modified to become inactive (SDP direction attribute) shall also be considered to be put on hold. + +If a bidirectional media component is placed on hold by making it unidirectional, the IP flows shall only be disabled in the deactivated direction. If a media component is placed on hold by making it inactive, the IP flows shall be disabled in both directions. + +Figure B.3.3-1 presents the Disabling of IP Flows procedure at media on hold for both the originating and terminating sides. + +![Sequence diagram illustrating the disabling of IP flows at media on hold. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF receives an SDP answer putting media on hold from an external source. It then sends an Npcf_PolicyAuthorization_Update request to the PCF. The PCF sends a Diameter AAR request to the PCF (labeled 2a). The PCF updates the flow status of affected PCC rules. The PCF sends an Npcf_PolicyAuthorization_Update response to the P-CSCF. The P-CSCF sends a Diameter AAA message back to the P-CSCF (labeled 4a). The P-CSCF forwards the SDP answer putting media on hold to the UE. The PCF closes the related gates.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of P-CSCF: 1. SDP answer putting media on hold + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Update request + Note left of PCF: Rx Cnse + PCF->>PCF: 2a. Diameter AAR + Note right of PCF: 3. PCF updates flow status of affected PCC rules + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Update response + Note left of PCF: Rx Cnse + PCF->>PCF: 4a. Diameter AAA + P-CSCF->>UE: 5. SDP answer putting media on hold + Note right of PCF: 6. PCF closes the related gates + +``` + +Sequence diagram illustrating the disabling of IP flows at media on hold. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF receives an SDP answer putting media on hold from an external source. It then sends an Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF sends a Diameter AAR request to the PCF (labeled 2a). The PCF updates the flow status of affected PCC rules. The PCF sends an Npcf\_PolicyAuthorization\_Update response to the P-CSCF. The P-CSCF sends a Diameter AAA message back to the P-CSCF (labeled 4a). The P-CSCF forwards the SDP answer putting media on hold to the UE. The PCF closes the related gates. + +**Figure B.3.3-1: Disabling of IP Flows at Media on Hold** + +1. The P-CSCF receives an SDP answer putting media on hold within a SIP message. (NOTE 2) + 2. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource to the PCF requesting that gates shall be closed. + - 2a. The P-CSCF sends a Diameter AAR request to the PCF, requesting that gates shall be closed. + 3. The PCF updates flow status of affected PCC rules for the media on hold. + 4. The PCF replies to the P-CSCF with a HTTP "200 OK" response. + - 4a. The PCF sends a Diameter AAA message back to the P-CSCF. + 5. The P-CSCF forwards the SDP answer putting media on hold within a SIP message. + 6. The PCF executes interactions according to figure 5.2.2.2.2.2-1. This step implies closing the relevant media IP flow gate(s), leaving the possible related RTCP gate(s) open to keep the connection alive. +- NOTE 2: This procedure occurs whenever a bidirectional media is made unidirectional or when a media is changed to inactive. + +### B.3.4 Media Component Removal + +Figure B.3.4-1 presents the flows of PCC procedures at the removal of media component(s) from an IMS session which is not being released for both the originating and terminating sides. + +![Sequence diagram illustrating the revoke authorization for IP resources at media component removal for both originating and terminating sides. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF receives an SDP answer removing a media component from an external source. It then sends an Npcf_PolicyAuthorization_Update request to the PCF. The PCF responds with a Diameter AAR. The PCF stores session information and identifies the PDU Session. The PCF then sends an Npcf_PolicyAuthorization_Update response to the P-CSCF, which in turn sends a Diameter AAA. Finally, the PCF removes/modifies PCC rules.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of UE: Rx Case + P-CSCF->>P-CSCF: 1. SDP answer removing media component + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Update request + PCF->>PCF: 2a. Diameter AAR + Note right of PCF: 3. PCF stores session information and identify PDU Session + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Update response + Note left of UE: Rx Case + PCF->>P-CSCF: 4a. Diameter AAA + Note right of PCF: 5. Remove/Modify PCC rules + +``` + +Sequence diagram illustrating the revoke authorization for IP resources at media component removal for both originating and terminating sides. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF receives an SDP answer removing a media component from an external source. It then sends an Npcf\_PolicyAuthorization\_Update request to the PCF. The PCF responds with a Diameter AAR. The PCF stores session information and identifies the PDU Session. The PCF then sends an Npcf\_PolicyAuthorization\_Update response to the P-CSCF, which in turn sends a Diameter AAA. Finally, the PCF removes/modifies PCC rules. + +**Figure B.3.4-1: Revoke authorization for IP resources at media component removal for both originating and terminating sides** + +1. A SIP message containing SDP indicating the removal of media component(s) is received by the P-CSCF. +2. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Update service operation by sending an HTTP PATCH request to the "Individual Application Session Context" resource to the PCF with modified service information. +- 2a. The P-CSCF sends Diameter AAR to the PCF with modified service information. +3. The PCF stores the AF session information and identifies the affected PDU session. +4. The PCF replies to the P-CSCF with a HTTP "200 OK" response. +- 4a. The PCF sends a Diameter AAA message back to the P-CSCF. +5. The P-CSCF forwards the SDP answer removing a media component. +6. The PCF makes a decision on what PCC rules need to be modified or removed and executes interactions according to figure 5.2.2.2.2.2-1. + +## B.4 IMS Session Termination + +### B.4.1 Mobile initiated session release / Network initiated session release + +Figure B.4.1-1 represents the mobile or network initiated IMS session release without access network information retrieval. The session release may be signalled by a SIP BYE request, or any SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response to an initial INVITE request. If any 4xx, 5xx, or 6xx SIP final error response to Re-INVITE or UPDATE request just terminates the transaction, then the session is not released, otherwise if the error response terminates the dialog then the session is released. + +Figures B.4.1-2 and B.4.1-3 presents the network initiated and the mobile initiated IMS session release with access network information retrieval, respectively. + +![Sequence diagram for IMS session termination without access network information retrieval. Lifelines: UE, PCF, P-CSCF. Step 1: P-CSCF receives a SIP BYE request or error response. Step 2: P-CSCF forwards the BYE request or error response to the UE. Step 3: Removal of PCC Rules at AF session release (parallel interaction).](d26959f4514c26ca19c3d6f00da85956_img.jpg) + +``` +sequenceDiagram + participant P-CSCF + participant PCF + participant UE + Note right of P-CSCF: 1. BYE, 3xx, 4xx, 5xx, or 6xx + P-CSCF->>UE: 2. BYE, 3xx, 4xx, 5xx, or 6xx + Note over PCF, UE: 3. Removal of PCC Rules at AF session release +``` + +Sequence diagram for IMS session termination without access network information retrieval. Lifelines: UE, PCF, P-CSCF. Step 1: P-CSCF receives a SIP BYE request or error response. Step 2: P-CSCF forwards the BYE request or error response to the UE. Step 3: Removal of PCC Rules at AF session release (parallel interaction). + +**Figure B.4.1-1: IMS session termination without access network information retrieval** + +1. SIP BYE request, a SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response to an initial INVITE or any 4xx, 5xx, or 6xx SIP final error response to Re-INVITE or UPDATE which terminates the dialog is received by the P-CSCF. +2. P-CSCF forwards the BYE request, or the SIP 3xx redirect response, or any 4xx, 5xx, or 6xx SIP final error response. +3. The interactions in Figure 5.2.2.2.2.3-1 are applicable. + +![Sequence diagram for network initiated IMS session termination with access network information retrieval. Lifelines: UE, PCF, P-CSCF. Step 1: P-CSCF receives a SIP BYE request. Step 2: P-CSCF forwards the BYE request to the UE. Step 3: Removal of PCC Rules at AF session release (parallel interaction). Step 4: UE sends a 200 OK (BYE) response to the P-CSCF. Step 5: P-CSCF forwards the 200 OK (BYE) response to the PCF.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` +sequenceDiagram + participant P-CSCF + participant PCF + participant UE + Note right of P-CSCF: 1. BYE + P-CSCF->>UE: 2. BYE + Note over PCF, UE: 3. Removal of PCC Rules at AF session release + UE->>P-CSCF: 4. 200 OK (BYE) + P-CSCF->>PCF: 5. 200 OK (BYE) +``` + +Sequence diagram for network initiated IMS session termination with access network information retrieval. Lifelines: UE, PCF, P-CSCF. Step 1: P-CSCF receives a SIP BYE request. Step 2: P-CSCF forwards the BYE request to the UE. Step 3: Removal of PCC Rules at AF session release (parallel interaction). Step 4: UE sends a 200 OK (BYE) response to the P-CSCF. Step 5: P-CSCF forwards the 200 OK (BYE) response to the PCF. + +**Figure B.4.1-2: network initiated IMS session termination with access network information retrieval** + +1. SIP BYE request is received by the P-CSCF. +2. The P-CSCF forwards the BYE request. +3. In parallel to step 2, the interactions in Figure 5.2.2.2.2.3-1 take place. Within those interactions, the P-CSCF requests and receives the access network information. +4. The P-CSCF receives the SIP 200 OK (BYE) response. +5. The P-CSCF forwards the SIP 200 OK (BYE) response. It includes the access networking information obtained in step 3 as the network provided location information. + +![Sequence diagram for mobile initiated IMS session termination with access network information retrieval. The diagram shows three lifelines: PCF, P-CSCF, and UE. Step 1: UE sends a BYE message to P-CSCF. Step 2: A rounded rectangle labeled '2. Removal of PCC Rules at AF session release' spans the PCF and P-CSCF lifelines. Step 3: P-CSCF sends a BYE message to the left, presumably towards the UE or another component.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant PCF + Note right of P-CSCF: 2. Removal of PCC Rules at AF session release + UE->>P-CSCF: 1. BYE + P-CSCF->>PCF: + P-CSCF->>: 3. BYE +``` + +Sequence diagram for mobile initiated IMS session termination with access network information retrieval. The diagram shows three lifelines: PCF, P-CSCF, and UE. Step 1: UE sends a BYE message to P-CSCF. Step 2: A rounded rectangle labeled '2. Removal of PCC Rules at AF session release' spans the PCF and P-CSCF lifelines. Step 3: P-CSCF sends a BYE message to the left, presumably towards the UE or another component. + +**Figure B.4.1-3: mobile initiated IMS session termination with access network information retrieval** + +1. SIP BYE request is received by the P-CSCF. +2. The interactions in Figure 5.2.2.2.2.3-1 are applicable. Within those interactions, the P-CSCF requests and receives the access network information. +3. The P-CSCF forwards the BYE request. It includes the access network information obtained in step 2 as the network provided location information. + +### B.4.2 QoS Flow Release/Loss + +A QoS flow release may affect all IP-Flows within an IMS Session. Flows in Figure 5.2.2.3-1 apply. + +## B.5 Subscription to Notification of Signalling Path Status at IMS Registration + +This clause covers the optional Subscription to Notifications of IMS Signalling Path Status upon an initial successful IMS Registration procedure. + +![Sequence diagram showing the subscription to notification of IMS signaling path status at initial IMS registration. Lifelines: UE, PCF, P-CSCF. The diagram includes SIP REGISTER messages, Npcf_PolicyAuthorization_Create requests, Diameter AAR and AAA messages, Session Binding, and a Subscribe to QoS Flow Level Event.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + + Note left of UE: Rx Case + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>P-CSCF: 2. SIP REGISTER + P-CSCF-->>P-CSCF: 3. 200 OK + P-CSCF-->>UE: 4. 200 OK + P-CSCF->>PCF: 5. Npcf_PolicyAuthorization_Create request + Note right of PCF: Rx Case + P-CSCF->>PCF: 5a. Diameter AAR + rect rgb(255, 255, 255) + Note over PCF: 6. Session Binding + end + PCF->>P-CSCF: 7. Npcf_PolicyAuthorization_Create response + Note right of PCF: Rx Case + PCF->>P-CSCF: 7a. Diameter AAA + rect rgb(255, 255, 255) + Note over PCF: 8. Subscribe to QoS Flow Level Event + end + +``` + +Sequence diagram showing the subscription to notification of IMS signaling path status at initial IMS registration. Lifelines: UE, PCF, P-CSCF. The diagram includes SIP REGISTER messages, Npcf\_PolicyAuthorization\_Create requests, Diameter AAR and AAA messages, Session Binding, and a Subscribe to QoS Flow Level Event. + +**Figure B.5-1: Subscription to Notification of IMS Signaling Path Status at initial IMS Registration** + +- 1-4. The user initiates an initial SIP Registration procedure. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +5. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention to subscribe to the status of the IMS Signaling path. The P-CSCF sends an HTTP POST request message to the PCF. +- 5a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to the status of the IMS Signaling path. The P-CSCF sends a Diameter AAR command to the PCF. +6. The PCF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. +7. The PCF confirms the subscription to IMS Signaling path status and replies with an HTTP "201 Created" message back to the P-CSCF. +- 7a. The PCF confirms the subscription to IMS Signaling path status and replies with a Diameter AAA command back to the P-CSCF. +8. If the PCF had not previously subscribed to the required QoS level events from the PDU session for the affected PCC Rules, then the PCF shall do so now. The PCF initiates procedures according to figure 5.2.2.2.1-1. + +## B.6 Provisioning of SIP signalling flow information at IMS Registration + +This clause covers the optional Provisioning of SIP signalling flow information upon an initial successful IMS Registration procedure. + +![Sequence diagram showing the provisioning of SIP signalling flow information at initial IMS Registration. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with the UE sending a SIP REGISTER to the P-CSCF. The P-CSCF then sends a SIP REGISTER to the PCF, which responds with a 200 OK. The P-CSCF then sends a 200 OK to the UE. Next, the P-CSCF sends an Npcf_PolicyAuthorization_Create request to the PCF. The PCF then sends a Diameter AAR (Rx Case) to the P-CSCF. The P-CSCF then sends an AF session binding to the UE. The PCF then sends an Npcf_PolicyAuthorization_Create response to the P-CSCF, which in turn sends a Diameter AAA (Rx Case) to the P-CSCF. Finally, the PCF performs the provisioning of PCC rules, indicated by a dashed box.](a26e142d3df5bef41a84a9dd099d7825_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of UE: Rx Case + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>PCF: 2. SIP REGISTER + PCF-->>P-CSCF: 3. 200 OK + P-CSCF-->>UE: 4. 200 OK + P-CSCF->>PCF: 5. Npcf_PolicyAuthorization_Create request + PCF->>P-CSCF: 5a. Diameter AAR + Note right of P-CSCF: Rx Case + P-CSCF->>UE: 6. AF session binding + PCF->>P-CSCF: 7. Npcf_PolicyAuthorization_Create response + P-CSCF->>PCF: 7a. Diameter AAA + Note right of PCF: 8. Provisioning of PCC rules + +``` + +Sequence diagram showing the provisioning of SIP signalling flow information at initial IMS Registration. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with the UE sending a SIP REGISTER to the P-CSCF. The P-CSCF then sends a SIP REGISTER to the PCF, which responds with a 200 OK. The P-CSCF then sends a 200 OK to the UE. Next, the P-CSCF sends an Npcf\_PolicyAuthorization\_Create request to the PCF. The PCF then sends a Diameter AAR (Rx Case) to the P-CSCF. The P-CSCF then sends an AF session binding to the UE. The PCF then sends an Npcf\_PolicyAuthorization\_Create response to the P-CSCF, which in turn sends a Diameter AAA (Rx Case) to the P-CSCF. Finally, the PCF performs the provisioning of PCC rules, indicated by a dashed box. + +**Figure B.6-1: Provisioning of SIP Signalling Flow Information at initial IMS Registration** + +- 1-4. The user initiates an initial SIP Registration procedure. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +5. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention to provision the information about the SIP signalling flows established between the UE and the P-CSCF. The P-CSCF invokes the Npcf\_PolicyAuthorization\_Create service operation to the PCF by sending an HTTP POST request to the "Application Sessions" resource. +- 5a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to provision the information about the SIP signalling flows established between the UE and the P-CSCF. The P-CSCF sends a Diameter AAR command to the PCF. +6. The PCF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. +7. The PCF replies to the P-CSCF with a HTTP "201 Created" response and includes the URI of the "Individual Application Session Context" resource in the Location header field. +- 7a. The PCF replies to the P-CSCF with a Diameter AAA. +8. If the PCF had not previously provisioned PCC rules corresponding to the received SIP signalling flows, then the PCF executes interactions according to figure 5.2.2.2.2.1-1. This step implies provisioning of PCC rules. + +## B.7 Subscription to Notification of Change of Access Type at IMS Registration + +This clause covers the optional Subscription to Notifications of change in the access type upon an initial IMS Registration procedure. + +![Sequence diagram showing the subscription to notification of change of IP-CAN Type at initial IMS Registration. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with the UE sending a SIP REGISTER to the P-CSCF. The P-CSCF then sends an Npcf_PolicyAuthorization_Create request to the PCF. The PCF responds with an AF Session Binding. The P-CSCF then sends a Diameter AAR to the PCF, which responds with a Diameter AAA. The P-CSCF then sends a SIP REGISTER to the UE, which responds with a 200 OK. Finally, the UE sends a Subscribe to QoS flow level events message to the PCF.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of UE: Rx Case + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Create request + Note right of PCF: Rx Case + P-CSCF->>PCF: 2a. Diameter AAR + PCF->>P-CSCF: 3. AF Session Binding + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Create response + Note right of PCF: Rx Case + PCF->>P-CSCF: 4a. Diameter AAA + P-CSCF->>UE: 5. SIP REGISTER + UE->>P-CSCF: 6. 200 OK + P-CSCF->>UE: 7. 200 OK + Note left of PCF: + UE-->>PCF: 8. Subscribe to QoS flow level events + +``` + +Sequence diagram showing the subscription to notification of change of IP-CAN Type at initial IMS Registration. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with the UE sending a SIP REGISTER to the P-CSCF. The P-CSCF then sends an Npcf\_PolicyAuthorization\_Create request to the PCF. The PCF responds with an AF Session Binding. The P-CSCF then sends a Diameter AAR to the PCF, which responds with a Diameter AAA. The P-CSCF then sends a SIP REGISTER to the UE, which responds with a 200 OK. Finally, the UE sends a Subscribe to QoS flow level events message to the PCF. + +**Figure B.7-1: Subscription to Notification of change of IP-CAN Type at initial IMS Registration** + +- 1.- The user initiates an initial SIP Registration procedure. +2. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention to subscribe to the notification of access type change by invoking the Npcf\_PolicyAuthorization\_Create service operation to the PCF. The P-CSCF sends an HTTP POST request to the "Application Sessions" resource. +- 2a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to the notification of access type change. The P-CSCF sends a Diameter AAR command to the PCF. + +NOTE: It should be possible for the P-CSCF to request the subscription to notification of IMS Signalling path status and PLMN changes also in this step. + +3. The PCF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. +4. The PCF confirms the subscription to notification of access type change and replies to the P-CSCF with a HTTP "201 Created" response and includes the URI of the "Individual Application Session Context" resource in the Location header field. +- 4a. The PCF confirms the subscription to notification of change of access type and replies with a Diameter AAA command back to the P-CSCF. + +The PCF includes in the response the type of access type currently in use. + +- 5-7. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). +8. If the PCF had not previously subscribed to the required QoS flow level event from the access type (i.e. access type change and RAT type change, if applicable), then the PCF shall do so now. The PCF initiates procedures according to figure 5.2.2.2.2.1-1. + +## B.8 Subscription to Notification of Change of PLMN Identifier at IMS Registration + +This clause covers the optional Subscription to Notifications of change in the PLMN identifier upon an initial IMS Registration procedure. The PLMN identifier or SNPN identifier where the UE is currently located is provided within the Notification of change in the PLMN identifier. n2 + +NOTE 1: The SNPN identifier consists of the PLMN identifier and the NID. + +![Sequence diagram showing the interaction between UE, PCF, and P-CSCF for subscription to notification of change of PLMN Identifier at IMS Registration.](cb4cfa42ce34febde7bdb882f3fc3094_img.jpg) + +``` +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + + Note left of UE: Rx Case + UE->>P-CSCF: 1. SIP REGISTER + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Create request + Note right of PCF: Rx Case + PCF->>P-CSCF: 2a. Diameter AAR + Note right of PCF: Session Binding + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Create response + Note right of PCF: Rx Case + PCF->>P-CSCF: 4a. Diameter AAA + P-CSCF->>UE: 5. SIP REGISTER + P-CSCF->>UE: 6. 200 OK + UE->>P-CSCF: 7. 200 OK + Note right of UE: Subscribe to QoS Flow Level Event +``` + +The sequence diagram illustrates the interaction between the User Equipment (UE), Policy Control Function (PCF), and PDN Gateway Control and Session Function (P-CSCF) for the subscription to notification of change of PLMN Identifier at IMS Registration. The process begins with the UE sending a SIP REGISTER message to the P-CSCF. The P-CSCF then sends an Npcf\_PolicyAuthorization\_Create request to the PCF. The PCF responds with a Diameter AAR message. The PCF also initiates a Session Binding procedure. The PCF then sends an Npcf\_PolicyAuthorization\_Create response to the P-CSCF, followed by a Diameter AAA message. The P-CSCF sends a SIP REGISTER message to the UE, followed by a 200 OK message. The UE responds with a 200 OK message. Finally, the UE initiates a Subscribe to QoS Flow Level Event procedure. + +Sequence diagram showing the interaction between UE, PCF, and P-CSCF for subscription to notification of change of PLMN Identifier at IMS Registration. + +Figure B.8-1: Subscription to Notification of change of PLMN Identifier at initial IMS Registration + +1. The user initiates an initial SIP Registration procedure. +2. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention to subscribe to notification of PLMN Identifier Change. The P-CSCF sends an HTTP POST request message to the PCF. + +- 2a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention to subscribe to notification of PLMN Identifier Change. The P-CSCF sends a Diameter AAR command to the PCF. + +NOTE 2: It should be possible for the P-CSCF to request the subscription to notification of IMS Signalling path status and IP-CAN Type changes also in this step. + +3. The PCF performs session binding and identifies corresponding PCC Rules related to IMS Signalling. + +4. The PCF confirms the subscription to notification of PLMN Identifier Change and replies with an HTTP "201 Created" message back to the P-CSCF. + +- 4a. The PCF confirms the subscription to notification of PLMN Identifier Change and replies with a Diameter AAA command back to the P-CSCF. + +- 5-7. The SIP Registration procedure is completed successfully (user has been authenticated and registered within the IMS Core NW). + +8. If the PCF had not previously subscribed to the required QoS level events from the PDU session for the affected PCC Rules, then the PCF shall do so now. The PCRF initiates procedures according to figure 5.2.2.2.1-1. + +NOTE 3: If the PLMN identifier is not available in step 4 (step 4a for Rx case), the P-CSCF will wait to get it in step 8 before progressing the SIP Register, i.e. steps 5, 6 and 7 will occur after step 8. + +## B.9 P-CSCF Restoration + +This clause is applicable if P-CSCF Restoration is to be performed. + +![Sequence diagram for P-CSCF Restoration showing interactions between UE, SMF, PCF, and P-CSCF. The diagram includes steps for policy authorization, SM policy control updates, and a callout for the P-CSCF Restoration Procedure. A shaded 'Rx Case' section highlights steps 1a and 2a.](6f659142d4789aa889184459f884787e_img.jpg) + +``` + +sequenceDiagram + participant UE + participant SMF + participant PCF + participant P-CSCF + Note left of UE: Rx Case + P-CSCF->>PCF: 1.Npcf_PolicyAuthorization_Create Request (P-CSCF Restoration operation) + PCF-->>P-CSCF: 2.Npcf_PolicyAuthorization_Create Response + Note right of PCF: Rx Case + PCF->>P-CSCF: 1a. Diameter AAR + P-CSCF-->>PCF: 2a. Diameter AAA + PCF->>SMF: 3.Npcf_SMPolicyControl_UpdateNotify Request + SMF-->>PCF: 4.Npcf_SMPolicyControl_UpdateNotify Response + Note left of UE: P-CSCF Restoration Procedure + +``` + +Sequence diagram for P-CSCF Restoration showing interactions between UE, SMF, PCF, and P-CSCF. The diagram includes steps for policy authorization, SM policy control updates, and a callout for the P-CSCF Restoration Procedure. A shaded 'Rx Case' section highlights steps 1a and 2a. + +Figure B.9-1: P-CSCF Restoration + +1. The P-CSCF invokes the "P-CSCF restoration" custom operation to initiate a P-CSCF Restoration procedure, as defined in 3GPP TS 23.380 [45], by sending an HTTP POST request to the ".../pcscf-restoration" URI, which can contain the IP address of the UE within the "uelpv4" attribute or "uelpv6" attribute, and, if required to solve private IPv4 case, the "ipDomain" attribute or the "sliceInfo" attribute if available, The SUPI in the "supi" + +attribute and the DNN in the "dnn" attribute are provided if the UE IP address is not available, or if available, IP address is not unique and the ipDomain" attribute and/or the "sliceInfo" attribute are not available. + +- 1a. sends an AAR command to PCF to initiate a P-CSCF Restoration procedure, as defined in the 3GPP TS 23.380 [45]. The AAR command contains a Rx-Request-Type AVP with value set to PCSCF\_RESTORATION and can contain the IP address of the UE within Framed-IP-Address AVP (if available) or the Framed-Ipv6-Prefix AVP (if available), IMSI (if available) within the Subscription-Id AVP, the IMS DNN (if available) within the Called-Station-Id AVP and/or the IP address domain (if available) within the IP-Domain-Id AVP. +2. The PCF acknowledges the received HTTP POST request with a HTTP "204 No content" response. + - 2a. When receiving the AAR command for P-CSCF Restoration from the P-CSCF, the PCF acknowledges the AAR by sending an AAA command to the P-CSCF. +3. When receiving the request for the "P-CSCF restoration" custom operation via N5 interface, or the AAR command from the Rx interface, the PCF finds the corresponding PDU session according to the received information from the P-CSCF, and invokes the Npcf\_SMPolicyControl\_UpdateNotify to indicate the SMF the request of P-CSCF restoration for the corresponding PDU session by sending an HTTP POST request to the SMF notification URI and including in body the SmPolicyDecision data type the "pescfRestIndication" attribute set to true. +4. When receiving the HTTP POST request indicating P-CSCF Restoration, the SMF acknowledges the request by sending an HTTP "204 No Content" response to the PCF and performs the subsequent P-CSCF Restoration procedure as specified in 3GPP TS 23.380 [45]. + +NOTE: If the PDU session is terminated as result of P-CSCF Restoration, the SMF invokes the Npcf\_SMPolicyControl\_Delete service operation to terminate the SM Policy Association and delete the corresponding "Individual SM Policy" resource in the PCF. + +## --- B.10 IMS Restricted Local Operator Services + +RLOS may be supported as described in clause B.1 with the following differences: + +- Only RLOS requests over E-UTRAN are supported in this release of the specification +- emergency service is replaced by RLOS; +- emergency indication is replaced by RLOS indication; +- emergency session is replaced by RLOS session; +- emergency DNN is replaced by RLOS DNN; and +- the call back functionality is not applicable to RLOS. + +NOTE: Clause B.2.2 is not supported for RLOS, because only UE originated RLOS requests over E-UTRAN are supported and there is no support for mobile terminated services as specified in 3GPP TS 23.221 [46]. + +## --- B.11 Retrieval of Network Provided Location Information for SMS over IP at Originating side + +This clause covers the optional request of access network information for SMS over IP. + +![Sequence diagram showing the retrieval of access network information for SMS over IP at the originating side. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with a SIP MESSAGE from UE to P-CSCF. P-CSCF then sends an Npcf_PolicyAuthorization_Subscribe request to PCF. This is followed by a Diameter AAR (2a) from P-CSCF to PCF, which falls within an Rx Case. PCF performs a Session Binding (3). PCF then sends an Npcf_PolicyAuthorization_Subscribe response (4) to P-CSCF, followed by a Diameter AAA (4a) from PCF to P-CSCF, also within an Rx Case. PCF then sends a Request Access Network Info (5) to P-CSCF. P-CSCF sends an Npcf_PolicyAuthorization_Notify request (6) to PCF, followed by a Diameter RAR (6a) from PCF to P-CSCF, within an Rx Case. PCF sends an Npcf_PolicyAuthorization_Notify response (7) to P-CSCF, followed by a Diameter RAA (7a) from PCF to P-CSCF, within an Rx Case. Finally, P-CSCF sends a SIP MESSAGE (8) to the terminating side.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + Note left of UE: Rx Case + UE->>P-CSCF: 1. SIP MESSAGE + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Subscribe request + P-CSCF->>PCF: 2a. Diameter AAR + Note right of PCF: Session Binding + PCF->>P-CSCF: 3. Session Binding + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Subscribe response + Note left of P-CSCF: Rx Case + PCF->>P-CSCF: 4a. Diameter AAA + Note right of PCF: Request Access Network Info + PCF->>P-CSCF: 5. Request Access Network Info + P-CSCF->>PCF: 6. Npcf_PolicyAuthorization_Notify request + Note left of P-CSCF: Rx Case + PCF->>P-CSCF: 6a. Diameter RAR + PCF->>P-CSCF: 7. Npcf_PolicyAuthorization_Notify response + PCF->>P-CSCF: 7a. Diameter RAA + P-CSCF->>UE: 8. SIP MESSAGE + +``` + +Sequence diagram showing the retrieval of access network information for SMS over IP at the originating side. The diagram involves three main entities: UE, PCF, and P-CSCF. The sequence starts with a SIP MESSAGE from UE to P-CSCF. P-CSCF then sends an Npcf\_PolicyAuthorization\_Subscribe request to PCF. This is followed by a Diameter AAR (2a) from P-CSCF to PCF, which falls within an Rx Case. PCF performs a Session Binding (3). PCF then sends an Npcf\_PolicyAuthorization\_Subscribe response (4) to P-CSCF, followed by a Diameter AAA (4a) from PCF to P-CSCF, also within an Rx Case. PCF then sends a Request Access Network Info (5) to P-CSCF. P-CSCF sends an Npcf\_PolicyAuthorization\_Notify request (6) to PCF, followed by a Diameter RAR (6a) from PCF to P-CSCF, within an Rx Case. PCF sends an Npcf\_PolicyAuthorization\_Notify response (7) to P-CSCF, followed by a Diameter RAA (7a) from PCF to P-CSCF, within an Rx Case. Finally, P-CSCF sends a SIP MESSAGE (8) to the terminating side. + +**Figure B.11.1: Retrieval of Access Network Information for SMS over IP at originating side** + +- 1.- The UE sends a SIP MESSAGE request to IMS. +2. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention of retrieval the access network information. The P-CSCF sends an HTTP POST request message to the PCF. + - 2a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention of retrieval the access network information. The P-CSCF sends a Diameter AAR command to the PCF. +3. The PCF performs session binding. +4. The PCF replies with an HTTP "201 Created" message back to the P-CSCF. + - 4a. The PCF replies with a Diameter AAA command back to the P-CSCF. +5. The PCF requires access network information according to figure 5.2.2.2.1-1. +6. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the access network information received in step 5 in an HTTP POST request sent to the Notification URI received in step 4. + - 6a. The PCF forwards the access network information received in step 5 in a Diameter RAR. +7. The P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response to the PCF. + - 7a. The P-CSCF acknowledges the receipt of Diameter RAR. +8. IMS sends a SIP MESSAGE to the terminating side including the network provided location information. + +After, the P-CSCF terminates the AF session as described in clause 5.2.2.2.2.3. + +## B.12 Retrieval of Network Provided Location Information for SMS over IP at Terminating side + +This clause covers the optional request of access network information for SMS over IP. + +![Sequence diagram for Retrieval of Access Network Information for SMS over IP at terminating side. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF sends a 200 OK to the UE. Then, the P-CSCF sends an Npcf_PolicyAuthorization_Subscribe request to the PCF. The PCF sends a Diameter AAR (2a) to the P-CSCF. The PCF performs a Session Binding (3). The PCF sends an Npcf_PolicyAuthorization_Subscribe response (4) to the P-CSCF. The PCF sends a Diameter AAA (4a) to the P-CSCF. The PCF sends a Request Access Network Info (5) to the P-CSCF. The PCF sends an Npcf_PolicyAuthorization_Notify request (6) to the P-CSCF. The PCF sends an Npcf_PolicyAuthorization_Notify response (7) to the P-CSCF. The PCF sends a Diameter RAR (6a) to the P-CSCF. The PCF sends a Diameter RAA (7a) to the P-CSCF. Finally, the P-CSCF sends a 200 OK (8) to the UE. The diagram is divided into three sections labeled 'Rx Case'.](2eb23c2210154279f8013a1594fbcc5a_img.jpg) + +``` + +sequenceDiagram + participant UE + participant PCF + participant P-CSCF + + Note left of UE: Rx Case + UE->>P-CSCF: 1. 200 OK + P-CSCF->>PCF: 2. Npcf_PolicyAuthorization_Subscribe request + Note right of PCF: Rx Case + PCF->>P-CSCF: 2a. Diameter AAR + Note left of PCF: Rx Case + PCF->>PCF: 3. Session Binding + PCF->>P-CSCF: 4. Npcf_PolicyAuthorization_Subscribe response + Note right of PCF: Rx Case + PCF->>P-CSCF: 4a. Diameter AAA + Note left of PCF: Rx Case + PCF->>P-CSCF: 5. Request Access Network Info + PCF->>P-CSCF: 6. Npcf_PolicyAuthorization_Notify request + PCF->>P-CSCF: 7. Npcf_PolicyAuthorization_Notify response + Note right of PCF: Rx Case + PCF->>P-CSCF: 6a. Diameter RAR + PCF->>P-CSCF: 7a. Diameter RAA + P-CSCF->>UE: 8. 200 OK + +``` + +Sequence diagram for Retrieval of Access Network Information for SMS over IP at terminating side. The diagram shows interactions between UE, PCF, and P-CSCF. The P-CSCF sends a 200 OK to the UE. Then, the P-CSCF sends an Npcf\_PolicyAuthorization\_Subscribe request to the PCF. The PCF sends a Diameter AAR (2a) to the P-CSCF. The PCF performs a Session Binding (3). The PCF sends an Npcf\_PolicyAuthorization\_Subscribe response (4) to the P-CSCF. The PCF sends a Diameter AAA (4a) to the P-CSCF. The PCF sends a Request Access Network Info (5) to the P-CSCF. The PCF sends an Npcf\_PolicyAuthorization\_Notify request (6) to the P-CSCF. The PCF sends an Npcf\_PolicyAuthorization\_Notify response (7) to the P-CSCF. The PCF sends a Diameter RAR (6a) to the P-CSCF. The PCF sends a Diameter RAA (7a) to the P-CSCF. Finally, the P-CSCF sends a 200 OK (8) to the UE. The diagram is divided into three sections labeled 'Rx Case'. + +**Figure B.12.1: Retrieval of Access Network Information for SMS over IP at terminating side** + +- 1.- The P-CSCF receives the 200 OK message on SIP MESSAGE request. +2. The P-CSCF requests the creation of a new "Individual Application Session Context" resource with the intention of retrieval the access network information. The P-CSCF sends an HTTP POST request message to the PCF. + - 2a. The P-CSCF requests the establishment of a new Diameter Rx session with the intention of retrieval the access network information. The P-CSCF sends a Diameter AAR command to the PCF. +3. The PCF performs session binding. +4. The PCF replies with an HTTP "201 Created" message back to the P-CSCF. + - 4a. The PCF replies with a Diameter AAA command back to the P-CSCF. +5. The PCF requires access network information according to figure 5.2.2.2.1-1. + +6. The PCF invokes the Npcf\_PolicyAuthorization\_Notify service operation to forward the access network information received in step 5 in an HTTP POST request sent to the Notification URI received in step 4. + - 6a. The PCF forwards the access network information received in step 5 in a Diameter RAR. +7. The P-CSCF acknowledges the receipt of the notification request with an HTTP "204 No Content" response to the PCF. + - 7a. The P-CSCF acknowledges the receipt of Diameter RAR. +8. The P-CSCF forwards the 200 OK including the network provided location information. + +After, the P-CSCF terminates the AF session as described in clause 5.2.2.2.2.3 + +# --- Annex C (informative): Guidance for underlay network to support QoS differentiation for User Plane IPsec Child SA + +## C.1 Access to PLMN services via SNPN and access to SNPN services via PLMN + +To access PLMN services, a UE in SNPN access mode that has successfully registered with a SNPN may perform another registration via the SNPN User Plane with the PLMN, discovering and establishing connectivity to an N3IWF in the PLMN. + +In these scenarios, the PLMN is the overlay network and the SNPN is the underlay network. + +Equivalently, to access SNPN services, a UE that has successfully registered with a PLMN over 3GPP access may perform another registration via the PLMN User Plane with a SNPN, discovering and establishing connectivity to an N3IWF in the SNPN. + +In these scenarios, the SNPN is the overlay network and the PLMN is the underlay network. + +## --- C.2 QoS differentiation support in the underlay network for overlay services + +When an overlay network service has specific QoS requirements that need to be fulfilled by the underlay network, an SLA needs to be determined between the two networks. + +The SLA covers the selective services of the overlay network that require QoS support in the underlay network. The rest of the overlay network traffic could be handled in best effort basis by the underlay network. + +The SLA includes a mapping between the DSCP value(s) of the User Plane IPsec Child SA(s) and the QoS requirement of the overlay network service(s). The QoS requirement includes the QoS parameters (defined in 3GPP TS 23.501 [2], clause 5.7.2) that are necessary (e.g. 5QI, ARP, etc.). The SLA also includes the N3IWF IP address of the overlay network. + +Based on the SLA, the N3IWF in the overlay network derives DSCP value(s) of the User Plane IPsec Child SA(s) from the QoS requirements of the service(s), and the SMF/PCF in the underlay network derives the QoS requirements for the User Plane IPsec Child SA(s) from the DSCP value(s) of the traffic. The description of the PCC procedures for the underlay network support of QoS differentiation for User Plane IPsec Child SA(s) for network initiated QoS and UE initiated QoS modification are described in clauses C.4 and C.5 respectively. + +In order to facilitate the SLA, the clause C.3 below provides a guidance for details of the possible mapping table between DSCP value(s) of the User Plane IPsec Child SA(s) and the QoS parameters of the overlay network service(s). The QoS parameters that the underlay network may need to determine based on the DSCP value (e.g. ARP, 5QI, GBR, + +MBR, ...) should be described in the SLA, and configured in the underlay network SMF and/or PCF and in the N3IWF in the overlay network. + +## C.3 Guidelines for QoS requirements to/from DSCP mapping + +The mapping guidelines in this clause represent an example of how the DSCP values can be used to reference a combination of QoS parameters. + +In these scenarios, where it is pursued to determine the applicable QoS in the underlay network based on the QoS handling of the service in the overlay network, the DSCP values represent a tool for the underlay network to reproduce the combination of QoS parameters determined by the overlay network. + +To achieve this goal, it is assumed that the DSCP marking(s) done by the N3IWF remain unaltered in the underlay network. The non-alteration of the DSCP values on NWu interface should be governed and ensured by the SLA and by transport level agreements. + +The mapping guidelines in the tables below are only examples and are not expected to fit every possible deployment. E.g., a deployment may use DSCP 44 and DSCP EF for conversational voice, 5QI 1, indicating the different DSCP values different GBR UL/DL values while another one may use only DSCP 44 and estimate the GBR/MBR parameters that would best fit with a set of possible different GBR/MBR requirements. The DSCP to/from QoS parameter mapping is determined by network administrators, as needed. + +**Table C.3-1: Example of QoS parameters to/from DSCP mapping for conversational voice** + +| DSCP | QoS parameter | | | | | | +|------|---------------|--------|--------|--------|--------------------------------------------------------------|--------------------------------------------------------------| +| | 5QI | ARP PL | ARP PC | ARP PV | GBR UL/DL | MBR UL/DL | +| 46 | 1 | 10 | NO | YES | 31 kbps UL/DL
(IPv4 case)
39 kbps UL/DL
(IPv6 case) | 31 kbps UL/DL
(IPv4 case)
39 kbps UL/DL
(IPv6 case) | +| 44 | 1 | 10 | NO | YES | 25 kbps UL/DL
(IPv4 case)
33 kbps UL/DL
(IPv6 case) | 31 kbps UL/DL
(IPv4 case)
39 kbps UL/DL
(IPv6 case) | +| 45 | 1 | 10 | NO | YES | 32 kbps UL/DL
(IPv4 case)
40 kbps UL/DL
(IPv6 case) | 32 kbps UL/DL
(IPv4 case)
40 kbps UL/DL
(IPv6 case) | + +**Table C.3-2: Example of QoS parameters to/from DSCP mapping for conversational video** + +| DSCP | QoS parameter | | | | | | +|------|---------------|--------|--------|--------|------------------------------|-------------------------------| +| | 5QI | ARP PL | ARP PC | ARP PV | GBR UL/DL | MBR UL/DL | +| 34 | 2 | 11 | NO | YES | 64 kbps UL/DL
(IPv6 case) | 704 kbps UL/DL
(IPv6 case) | + +## C.4 Network initiated QoS modification + +The mapping agreed in SLA is configured at N3IWF of the overlay network (QoS parameters to DSCP mapping) and at the SMF/PCF of the underlay network (DSCP to QoS parameters). If a dedicated DNN/S-NSSAI is used in the underlay network for providing access to the N3IWF in the overlay network, the SMF/PCF in the underlay network can be configured to enable packet detection (based on N3IWF IP address and DSCP value) for PDU sessions associated with the dedicated DNN/S-NSSAI. + +![Sequence diagram showing network initiated QoS modification procedure between Underlay and Overlay networks. The Underlay network contains AMF, SMF, UPF, and PCF. The Overlay network contains N3IWF, AMF, SMF, and PCF. The procedure consists of five steps: 1. PDU Session establishment in underlay network; 2. UE Registration and PDU Session establishment in overlay network; 3. PCF requested PDU session modification in overlay network; 4. Application Detection; 5. PCF triggered PDU Session modification in underlay network.](d9c0a780cd22626253dab4aa41699e2f_img.jpg) + +The diagram illustrates the interaction between an Underlay network and an Overlay network for network-initiated QoS modification. The Underlay network contains the AMF, SMF, UPF, and PCF. The Overlay network contains the N3IWF, AMF, SMF, and PCF. The procedure is as follows: + +- 1. PDU Session establishment, 3GPP TS 23.502, 4.3.2.2**: In the Underlay network, the SMF initiates an SM Policy Association Establishment (5.2.1, Activation of Application and Detection control) with the PCF. +- 2. Overlay network, UE Registration and PDU Session establishment, 3GPP TS 23.502, 4.12.2 and 4.12.5**: The UE registers and establishes a PDU Session in the Overlay network via the N3IWF. +- 3. Overlay network, PCF requested PDU session modification , 3GPP TS 23.502, 4.3.3.2 and 4.12.6**: The PCF in the Overlay network requests a PDU session modification. This involves the creation of a UP Ipsec Child SA (4.12.6) and an SM Policy Association Modification (5.2.2.2. Network Initiated QoS modification). +- 4. Application Detection**: An application detection mechanism is triggered in the Underlay network. +- 5. PCF triggered PDU Session modification, 3GPP TS 23.502, 4.3.3.2**: The PCF in the Underlay network triggers a PDU Session modification, involving an SM Policy Association Modification (5.2.2.3. DSCP to QoS requirement mapping). + +Sequence diagram showing network initiated QoS modification procedure between Underlay and Overlay networks. The Underlay network contains AMF, SMF, UPF, and PCF. The Overlay network contains N3IWF, AMF, SMF, and PCF. The procedure consists of five steps: 1. PDU Session establishment in underlay network; 2. UE Registration and PDU Session establishment in overlay network; 3. PCF requested PDU session modification in overlay network; 4. Application Detection; 5. PCF triggered PDU Session modification in underlay network. + +Figure C.4-1: Example of network initiated QoS procedure + +1. When the UE establishes a PDU Session in underlay network, the SMF creates a SM Policy Association with the PCF (clause 5.2.1), which determines the PCC rules to install based on UE subscription information and local configuration (which takes into account the SLA). The PCF in the underlay network installs in the SMF PCC rule(s) that contain an application identifier (see 3GPP TS 29.512 [9], clause 4.2.2.7) that refer to the N3IWF IP address and the DSCP value(s) of the User Plane IPsec Child SA(s) of the overlay network that require QoS differentiation by the underlay network. +2. The UE registers (see 3GPP TS 23.502 [3], clause 4.12.2) and establishes PDU Session (3GPP TS 23.502 [3], clause 4.12.5) in the overlay network via the User Plane connectivity established in the underlay network. + +3. When the UE is accessing a specific service of the overlay network, the service can e.g. request via the PCF a specific QoS treatment to the overlay network. The PCF then invokes the SM Policy Association Modification procedure (see clause 5.2.2.2), which triggers the creation of the corresponding QoS Flow in the overlay network. The N3IWF is configured to allocate different dedicated User Plane IPsec Child SA(s) for each overlay network QoS Flow(s) (3GPP TS 23.502 [3], clause 4.12.6). + +The N3IWF uses the QoS Flow level QoS parameters it receives from SMF in overlay network along with the mapping agreed in the SLA to derive a specific DSCP value for the User Plane IPsec Child SA (e.g. QoS parameters to DSCP mapping table described in clause C.3). The N3IWF can provide to the UE the DSCP value for the User Plane IPsec Child SA (clause 4.12.5, step 4a and 4c of TS 23.502 [3]) mapped to QoS Flow for the specific network service. + +The UE receives the QoS Flow level QoS parameters (e.g. 5QI, GFBR, MFBR, as specified in TS 24.501 [33]) from SMF/PCF in overlay network for the QoS Flow which is created for the specific overlay network service. + +The N3IWF (for DL) and the UE (for UL) will set the DSCP marking in the outer IP header of the User Plane IPsec Child SA. + +When the service requests the termination of the specific QoS treatment to the overlay network, the PCF invokes the SM Policy Association Modification procedure (see clause 5.2.2.2), which triggers the termination of the corresponding QoS Flow(s) in the overlay network. The N3IWF terminates the dedicated User Plane IPsec Child SA(s) for each terminated overlay network QoS Flow(s). + +4. The overlay network traffic between UE and N3IWF using the specific DSCP marking will be detected by the UPF/SMF in the underlay network based on the previously installed PCC rules. + +When the N3IWF terminates the dedicated User Plane IPsec Child SA(s), the termination of the traffic with the specific DSCP marking will be detected by the UPF/SMF in the underlay network based on the previously installed PCC rules. + +5. The UE and N3IWF detected traffic are reported by the SMF to the PCF as described in 3GPP TS 29.512 [9], clause 4.2.4.6, using the SM Policy Association Modification procedure described in clause 5.2.2.3. The PCF, based on the DSCP value of the detected traffic, derives the QoS requirements for the related service and installs new PCC rules on the SMF including the QoS parameters (5QI, ARP, GBR, etc., as described in the DSCP to QoS parameters mapping of the SLA) for handling the packets corresponding to the specific User Plane IPsec Child SA. The SMF in the underlay network may generate a separate QoS Flow, as described in clause 4.3.3 of TS 23.502 [3], for the traffic of the User Plane IPsec Child SA, which will receive the same QoS treatment as the QoS treatment of the overlay network for the service traffic. + +The detection of the termination of the UE and N3IWF traffic is reported by the SMF to the PCF as described in 3GPP TS 29.512 [9], clause 4.2.4.6, using the SM Policy Association Modification procedure described in clause 5.2.2.3. The PCF, based on the identification of the traffic, removes the previously provided PCC rules that handle the packets corresponding to the specific User Plane IPsec Child SA. The SMF in the underlay network may terminate the corresponding QoS Flow. + +## --- C.5 UE initiated QoS modification + +To support QoS differentiation in the underlay network with UE-requested QoS modification, the UE can request for an IPsec SA the same QoS parameters from the underlay network as the QoS parameters provided by the overlay network for the related service. It is assumed that UE-requested QoS modification is used only when the 5QIs used by the overlay network are from the range of standardized 5QIs. The packet filter in the UE-requested QoS rule can be based on the N3IWF address and the SPI associated with the IPsec SA. + +The mapping (DSCP to QoS requirements) agreed in SLA is configured at the SMF/PCF of the underlay network and in the N3IWF of the overlay network. + +![Sequence diagram illustrating the UE initiated QoS procedure across Underlay and Overlay networks.](26d664119ad25250780f554633444e54_img.jpg) + +The diagram illustrates the sequence of operations for a UE initiated QoS procedure across two network domains: Underlay network and Overlay network. + +- Underlay network components:** AMF, SMF, UPF, PCF. +- Overlay network components:** N3IWF, AMF, SMF, PCF. + +**Sequence of operations:** + +- 1. PDU Session establishment, 3GPP TS 23.502, 4.3.2.2** + This step occurs within the Underlay network. The SMF creates a SM Policy Association with the PCF (clause 5.2.1). +- 2. Overlay network, UE Registration and PDU Session establishment, 3GPP TS 23.502, 4.12.2 and 4.12.5** + This step involves the UE registering and establishing a PDU Session in the Overlay network via the User Plane connectivity established in the Underlay network. +- 3. Overlay network, UE requested PDU session modification , 3GPP TS 23.502, 4.3.3.2 and 4.12.6** + When the UE requests a specific QoS treatment, the SMF in the overlay network invokes the SM Policy Association Modification procedure (clause 5.2.2.3) and includes the UE-requested QoS. The PCF responds with the PCC rule(s) and the SMF creates the corresponding QoS Flow. This step involves: + - UP Ipsec Child SA creation, 3GPP TS 23.502, 4.12.6 + - SM Policy Association Modification, 5.2.2.3. UE requested QoS modification +- 4. UE triggered PDU Session modification, 3GPP TS 23.502, 4.3.3.2** + This step occurs within the Underlay network. The SMF creates a SM Policy Association Modification (clause 5.2.2.3). + +Sequence diagram illustrating the UE initiated QoS procedure across Underlay and Overlay networks. + +**Figure C.5-1: Example of UE initiated QoS procedure** + +1. When the UE establishes a PDU Session in underlay network, the SMF creates a SM Policy Association with the PCF (clause 5.2.1). +2. UE registers (3GPP TS 23.502 [3], clause 4.12.2) and establishes PDU Session (3GPP TS 23.502 [3], clause 4.12.5) in the overlay network via the User Plane connectivity established in the underlay network. +3. When UE is accessing a specific service of the overlay network, the UE e.g. can request to the overlay network a specific QoS treatment for this service. The SMF in the overlay network invokes the SM Policy Association Modification procedure (see clause 5.2.2.3) and includes the UE-requested QoS as described in 3GPP TS 29.512 [9], clause 4.2.4.17. The PCF in the overlay network responds to the SMF with the PCC rule(s) with the QoS requirements as per the UE-requested QoS. The SMF creates the corresponding QoS Flow in the overlay network (see clause 4.3.3 of TS 23.502 [3]). + +The N3IWF is configured to allocate different dedicated User Plane IPsec Child SA(s) for each overlay network QoS Flow(s) (3GPP TS 23.502 [3], clause 4.12.6) that requires underlay network QoS support. The UE receives the QoS Flow level QoS parameters (e.g. 5QI, GFBR, MFBR, as specified in TS 24.501 [33]) from SMF/PCF in overlay network for the QoS Flow which is created for the specific overlay network service. + +If an SLA exists, the SLA is configured in the N3IWF in the overlay network, and the N3IWF can provide to the UE the DSCP value for the User Plane IPsec Child SA (clause 4.12.5, step 4a and 4c of TS 23.502 [3]). + +When the UE requests the termination of the UE-requested QoS in the overlay network as described in 3GPP TS 29.512 [9], clause 4.2.4.17, the PCF in the overlay network responds to the SMF with the removal of the corresponding PCC rule(s). The SMF terminates the corresponding QoS Flow in the overlay network + +- 4 In order to ensure the underlay network handles the traffic of the overlay network service with the desired QoS, the UE can request a new QoS Flow for the PDU session in the underlay network for the concerned User Plane IPsec Child SA(s). The UE triggers a PDU session modification procedure and derives the UE-requested QoS for the underlay network from the QoS Flow level QoS parameters the UE received from the overlay network. The Packet Filter in the QoS rule of the request includes the overlay network N3IWF IP address and SPI associated with the User Plane IPsec Child SA. + +The SMF in the underlay network, after receiving the PDU Session Modification Request, invokes the SM Policy Association Modification procedure (see clause 5.2.2.3) to notify to the PCF that the UE has initiated a resource modification (see 3GPP TS 29.512 [9], clause 4.2.4.17). The PCF in the underlay network determines if the request can be authorized based on UE subscription and local policy which can take into account the SLA between overlay network and underlay network. If the request is authorized, the PCF generates a new PCC rule with the UE-requested QoS, and includes it in the response to the SMF in order to create new QoS Flow in underlay network using the QoS Flow level QoS parameters from the overlay network. The generated SDF refers to the N3IWF IP address and the SPI (provided by the UE in Traffic filter in PDU Session Modification request) to enable filtering and mapping of DL traffic towards the right PDU Session/QoS Flow within the underlay network. + +- If the SLA exists, and the N3IWF in overlay network provides to the UE the DSCP value for the User Plane IPsec Child SA as described in step 3, the UE can include the DSCP value in the Packet Filter of the PDU Session Modification procedure including the UE requested QoS in the underlay network. The PCF in the underlay network performs QoS authorization of the UE QoS request considering the UE subscription and local configuration which takes into account the mapping of DSCP to QoS requirements in the SLA. + +In order to ensure the underlay network terminates the QoS handling of the traffic of the overlay network when the UE requested the termination of the UE-requested QoS in the overlay network, the UE triggers the termination of the UE requested QoS in the underlay network. The SMF in the underlay network, notifies to the PCF that the UE has initiated a resource modification to terminate the requested QoS (see 3GPP TS 29.512 [9], clause 4.2.4.17), and the PCF removes the concerned PCC rule(s). The SMF terminates the corresponding QoS Flow in the underlay network. + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of policy and charging signalling and QoS parameters mapping | 0.0.0 | +| 2017-10 | CT3#92 | C3-175378 | | | | Inclusion of C3-175332, C3-175355. | 0.1.0 | +| 2017-12 | CT3#93 | C3-176398 | | | | Inclusion of C3-176258, C3-176372 | 0.2.0 | +| 2018-01 | CT3#94 | C3-180363 | | | | Inclusion of C3-180069, C3-180246, C3-180277, C3-180317 | 0.3.0 | +| 2018-03 | CT3#95 | C3-181369 | | | | Inclusion of C3-181250, C3-181251, C3-181252 | 0.4.0 | +| 2018-04 | CT3#96 | C3-182517 | | | | Inclusion of C3-182222, C3-182340, C3-182341, C3-182342, C3-182343, C3-182374, C3-182375, C3-182376, C3-182377, C3-182378. | 0.5.0 | +| 2018-05 | CT3#97 | C3-183901 | | | | Inclusion of C3-183385, C3-183387, C3-183388, C3-183495, C3-183496, C3-183497, C3-183503, C3-183527, C3-183528, C3-183529, C3-183530, C3-183823, C3-183828 | 0.6.0 | +| 2018-06 | CT#80 | CP-181035 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181035 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | AF traffic routing procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 3 | F | BSF procedures over Rx | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 2 | F | Clarification on PCF discovery and selection | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 4 | F | QoS mapping at AF and PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 2 | F | remove EN of PCC rule authorization for non-IP cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 2 | F | slice info considered in session binding and PCF selection | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 1 | B | Solution to IPv4 overlapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | | F | Remove the editor's note for Ethernet | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | | F | 5QI derivation in PCF QoS mapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | | B | SMF QoS mapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182035 | 0011 | 2 | F | Resolving EN for PFD Management | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | 1 | F | Architecture of interworking with AFs supporting Rx interface | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 5 | F | Correction to AM Policy association procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | | F | Correction to the PFD retrieval | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 1 | F | Correction to the PCF discovery and selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | 2 | F | Correction to the QoS flow binding | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | 1 | F | PCF Derivation of QoS Parameters | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | Consolidation of Initial Spending Limit Report request | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 1 | F | Consolidation of Intermediate Spending Limit Report request | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | 1 | F | Consolidation of Spending Limit Report notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0022 | 1 | F | Introduction of the subclause "subscription termination request" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | 4 | F | UE Policy Association procedures | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0026 | 1 | F | updates in clause 5.2 to detail UDR interaction | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0027 | 3 | F | corrections to AF traffic routing procedures | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0028 | 1 | F | BSF only stores binding info locally | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0029 | 3 | F | Correction on BSF and DRA coexistence scenario | 15.2.0 | +| 2018-12 | CT#82 | CP-183108 | 0031 | 2 | F | Correction of SM Policy Establishment and Termination Flows to Include Calls to the BSF | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0032 | 1 | F | Correction of SM Policy Modification Flows to Include Calls to the BSF | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0033 | | F | Using resource name instead of resoure URI in BSF procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0034 | 1 | F | corrections on PFD management procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0035 | | F | corrections on NWDA procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0036 | | F | http details in BDT procedure | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0037 | | F | Correction to architecture figures | 15.2.0 | +| 2019-03 | CT#83 | CP-190115 | 0039 | | F | GPSI in AF session establishment | 15.3.0 | +| 2019-03 | CT#83 | CP-190134 | 0040 | 1 | F | SEPPs in roaming architecture | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0041 | 3 | F | Correct PCF-initiated AM policy association termination | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0044 | | F | Invocation of Nudr_DataRepository_Update service operation for BDT | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0045 | 1 | F | PFD management in the SMF | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0046 | | F | Invocations of the Nbsf_Management service operations | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0047 | | F | Corrections on UE policy association procedure | 15.3.0 | +| 2019-03 | CT#83 | CP-190115 | 0051 | | F | Corrections on AFTrafficRouting procedure | 15.3.0 | +| 2019-06 | CT#84 | CP-191075 | 0052 | 1 | F | Correction on PCF discovery | 15.4.0 | +| 2019-06 | CT#84 | CP-191075 | 0053 | 1 | F | Correction to the QoS flow binding | 15.4.0 | +| 2019-06 | CT#84 | CP-191075 | 0056 | 2 | F | Corrections to AM policy control procedure and UE policy control procedure | 15.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191075 | 0057 | 1 | F | multiple MANAGE UE POLICY COMMAND messages sent by H-PCF | 15.4.0 | +| 2019-06 | CT#84 | CP-191075 | 0059 | | F | Remove NSI ID | 15.4.0 | +| 2019-06 | CT#84 | CP-191075 | 0064 | 1 | F | Correction to AM Policy Association Establishment Flow | 15.4.0 | +| 2019-06 | CT#84 | CP-191089 | 0060 | 1 | F | DN Authorization data for Policy Control | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0061 | 1 | B | Npcf_AMPolicyControl support of Allowed NSSAI | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0062 | 2 | B | Race condition handling | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0065 | 2 | B | BSF binding update | 16.0.0 | +| 2019-06 | CT#84 | CP-191109 | 0066 | 1 | B | PCF selection for ATSSS | 16.0.0 | +| 2019-06 | CT#84 | CP-191085 | 0068 | 1 | B | Session binding of 5WWC | 16.0.0 | +| 2019-06 | CT#84 | CP-191089 | 0069 | 2 | F | Clarifications to UE Policy Delivery, Roaming | 16.0.0 | +| 2019-09 | CT#85 | CP-192143 | 0072 | 1 | A | Session binding for IPv6 addresses | 16.1.0 | +| 2019-09 | CT#85 | CP-192143 | 0076 | 1 | A | Alignment of notification URI name and HTTP reponse code | 16.1.0 | +| 2019-09 | CT#85 | CP-192143 | 0078 | 1 | A | Corrections on NWDA procedures | 16.1.0 | +| 2019-09 | CT#85 | CP-192143 | 0080 | | A | Corrections on PFD procedure and SM policy procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0081 | 1 | B | BDT notification procedure | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0082 | 2 | B | Update NWDA procedures for more Analytics | 16.1.0 | +| 2019-09 | CT#85 | CP-192171 | 0083 | 2 | B | xBDT procedure | 16.1.0 | +| 2019-12 | CT#86 | CP-193185 | 0085 | 1 | A | Correct AMF behaviour during PCF-initiated AM Policy Association Termination procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0086 | 1 | B | Retrieval of BDT policy data for a set of BDT reference identifiers | 16.2.0 | +| 2019-12 | CT#86 | CP-193185 | 0088 | 1 | A | Correction to PCF selection | 16.2.0 | +| 2019-12 | CT#86 | CP-193185 | 0090 | 1 | A | Correction to QoS Mapping | 16.2.0 | +| 2019-12 | CT#86 | CP-193202 | 0091 | 2 | B | QoS Handling for V2X Communication | 16.2.0 | +| 2019-12 | CT#86 | CP-193202 | 0092 | 2 | B | QoS mapping for QoS Handling for V2X Communication | 16.2.0 | +| 2019-12 | CT#86 | CP-193180 | 0093 | 1 | B | Architecture clarification for eSBA | 16.2.0 | +| 2019-12 | CT#86 | CP-193180 | 0094 | 2 | B | PCF selection for eSBA | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0097 | 1 | B | Include AF relocation acknowledgement into Traffic influence procedures | 16.2.0 | +| 2019-12 | CT#86 | CP-193215 | 0098 | 2 | B | Coverage and Handover Enhancements for Media (CHEM) | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0099 | 1 | B | MCS Priority Level | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0101 | | F | Remove EN related to BDT reference ID storage in SMPolicyData | 16.2.0 | +| 2019-12 | CT#86 | CP-193217 | 0102 | 2 | B | QoS Parameter mapping at AF, N5 interface | 16.2.0 | +| 2019-12 | CT#86 | CP-193196 | 0103 | 4 | B | Skeleton for Annex B, Signalling Flows for IMS | 16.2.0 | +| 2020-03 | CT#87e | CP-200208 | 0100 | 2 | B | BDT renegotiation upon the network conditions change | 16.3.0 | +| 2020-03 | CT#87e | CP-200215 | 0105 | 1 | F | Incorrect figure 5.2.3.1-1: SMF-initiated SM Policy Association Termination procedure | 16.3.0 | +| 2020-03 | CT#87e | CP-200215 | 0106 | | B | Impacts on QoS mapping to support FLUS functionality | 16.3.0 | +| 2020-03 | CT#87e | CP-200200 | 0108 | 1 | B | PCF selection performed by the SMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200225 | 0109 | 1 | B | Binding mechanism update for V2X | 16.3.0 | +| 2020-03 | CT#87e | CP-200212 | 0110 | 1 | B | QoS parameter mapping at PCF update for V2X | 16.3.0 | +| 2020-03 | CT#87e | CP-200225 | 0111 | 1 | B | QoS parameter mapping at SMF update for V2X | 16.3.0 | +| 2020-03 | CT#87e | CP-200222 | 0112 | 1 | B | Annex B, IMS Session Establishment | 16.3.0 | +| 2020-03 | CT#87e | CP-200222 | 0113 | 1 | B | Annex B, IMS Session Modification, provisioning of service information | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0114 | 1 | B | Annex B, IMS Session Modification, gate control | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0115 | 1 | B | Annex B, IMS Session Modification, media component removal | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0116 | 1 | B | Annex B, IMS Session Termination | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0117 | 1 | B | Annex B, Provisioning of SIP signalling flow information at IMS Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0118 | 1 | B | Annex B, Subscription to Notification of Change of Access Type | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0121 | | B | Annex B, P-CSCF Restoration | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0122 | 1 | B | DNN Replacement as PCF discovery factor for the AMF | 16.3.0 | +| 2020-03 | CT#87e | CP-200218 | 0123 | | B | AF session binding to PDU session for TSN networks | 16.3.0 | +| 2020-03 | CT#87e | CP-200201 | 0124 | | B | SRVCC impacts on QoS mapping | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0125 | | F | Applying UE Policy Association Modification to all affected UEs | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0130 | 1 | B | Subscription to Notification of Signalling Path Status at IMS Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0133 | 1 | B | Subscription to Notification of change of PLMN Identifier at initial IMS Registration | 16.3.0 | +| 2020-03 | CT#87e | CP-200206 | 0136 | | B | Annex B, IMS Restricted Local Operator Services | 16.3.0 | +| 2020-06 | CT#88e | CP-201233 | 0137 | | B | Clarification of PCF selection by the AMF and SMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201268 | 0138 | 2 | B | Correction on QoS Flow Binding for QoS Flow Behaviour | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0139 | | B | Correction to PCC rule Authorization | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0140 | 1 | B | Correction to binding information procedures | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0141 | 3 | B | Same PCF selection support | 16.4.0 | +| 2020-06 | CT#88e | CP-201259 | 0142 | 3 | B | Update of PCF discovery by the AF for eSBA | 16.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201229 | 0143 | 3 | B | QoS Flow Binding about ATSSS | 16.4.0 | +| 2020-06 | CT#88e | CP-201252 | 0144 | 1 | B | Correction to session binding for TSN | 16.4.0 | +| 2020-06 | CT#88e | CP-201232 | 0146 | | B | Update for eIMS5G_SBA | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0147 | | F | Corrections on Network data analytics subscribe procedure | 16.4.0 | +| 2020-06 | CT#88e | CP-201212 | 0148 | 3 | B | Binding information: PCF set ID and PCF instance ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0149 | 1 | F | Removal of not valid BDT policy from UDR | 16.4.0 | +| 2020-06 | CT#88e | CP-201252 | 0150 | 1 | B | Binding of PCC rules to a QoS flow considering TSCAI information | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0151 | | B | Support of applications with specific QoS hints | 16.4.0 | +| 2020-06 | CT#88e | CP-201260 | 0154 | 1 | F | Correction on QoS Flow Binding for CN PDB | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0155 | 1 | F | URI correction on Npcf_SMPolicyControl | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0157 | 1 | B | Framed Routing Support | 16.4.0 | +| 2020-06 | CT#88e | CP-201266 | 0158 | 1 | B | Support of ATSSS | 16.4.0 | +| 2020-06 | CT#88e | CP-201218 | 0176 | 1 | A | Correction to PCC call flows | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0179 | 1 | B | Procedure of N2 PC5 Policy | 16.4.0 | +| 2020-09 | CT#89e | CP-202053 | 0181 | | A | Application data change triggers PCF-initiated SM Policy Association Modification | 16.5.0 | +| 2020-09 | CT#89e | CP-202059 | 0182 | 1 | F | Procedure for IPTV configuration | 16.5.0 | +| 2020-09 | CT#89e | CP-202069 | 0183 | 1 | F | Procedure of AF-based service parameter provisioning for V2X | 16.5.0 | +| 2020-09 | CT#89e | CP-202209 | 0184 | 1 | F | GPSI used for PCF selection | 16.5.0 | +| 2020-09 | CT#89e | CP-202081 | 0185 | | F | Correction to QoS flow binding | 16.5.0 | +| 2020-09 | CT#89e | CP-202053 | 0189 | 1 | A | Corrections on AF-initiated PFD management procedure | 16.5.0 | +| 2020-09 | CT#89e | CP-202049 | 0190 | 1 | F | Correction to PCF discovery and selection | 16.5.0 | +| 2020-09 | CT#89e | CP-202049 | 0191 | 1 | F | Correction to selection of the same PCF | 16.5.0 | +| 2020-09 | CT#89e | CP-202081 | 0192 | | F | Update the call flows to support TSN | 16.5.0 | +| 2020-09 | CT#89e | CP-202079 | 0186 | 1 | F | Correction to the SM policy association procedure | 17.0.0 | +| 2020-12 | CT#90e | CP-203157 | 0194 | 1 | A | Usage of PCF Group ID for PCF selection when delegated discovery is used | 17.1.0 | +| 2020-12 | CT#90e | CP-203146 | 0199 | | F | Correction to Notification response receiver | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0200 | | F | Correction to pending transactions | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0201 | 1 | F | Correction to SM policy association modification procedure | 17.1.0 | +| 2020-12 | CT#90e | CP-203115 | 0204 | | A | Correction to PFD retrieval in PULL mode | 17.1.0 | +| 2020-12 | CT#90e | CP-203135 | 0205 | 1 | B | Procedure of PUSH notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203115 | 0208 | | A | Correction to traffic influence procedures | 17.1.0 | +| 2020-12 | CT#90e | CP-203156 | 0212 | 1 | A | Correction to Alternative QoS as binding parameter | 17.1.0 | +| 2020-12 | CT#90e | CP-203132 | 0210 | | A | Correction to Alternative QoS parameter mapping | 17.1.0 | +| 2020-12 | CT#90e | CP-203150 | 0214 | 1 | A | Modification of UE Policy related clauses to support URSP rules for 5G VN Group | 17.1.0 | +| 2021-03 | CT#91e | CP-210215 | 0219 | 4 | B | Procedure of notification push update | 17.2.0 | +| 2021-03 | CT#91e | CP-210215 | 0220 | 3 | B | Procedure of partial pull | 17.2.0 | +| 2021-03 | CT#91e | CP-210202 | 0222 | 1 | A | Correction to AM Policy Control for Wireline and Wireless Convergence feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210210 | 0226 | 1 | A | Correction to N2 PC5 policy provision procedure | 17.2.0 | +| 2021-03 | CT#91e | CP-210193 | 0228 | 3 | A | QoS monitoring procedure | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0229 | 1 | F | Clean up TS references | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0231 | | A | Alignment of BDT policy re-negotiation | 17.2.0 | +| 2021-03 | CT#91e | CP-210237 | 0233 | 1 | A | Correction to TSN scenarios. | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0234 | 1 | F | Removal of resource URI from Notify service operations | 17.2.0 | +| 2021-03 | CT#91e | CP-210196 | 0239 | 1 | A | Determination of the default QoS flow | 17.2.0 | +| 2021-03 | CT#91e | CP-210229 | 0242 | 1 | F | Correction to table 7.4.1 | 17.2.0 | +| 2021-03 | CT#91e | CP-210196 | 0245 | | A | Correction to Notification URI | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0250 | 1 | F | Correction to Network data analytics Unsubscribe procedure | 17.2.0 | +| 2021-03 | CT#91e | CP-210222 | 0252 | | A | PFD change subscription modification procedure | 17.2.0 | +| 2021-03 | CT#91e | CP-210205 | 0254 | 1 | A | Correction to SamePcf Feature | 17.2.0 | +| 2021-06 | CT#92e | CP-211226 | 0257 | 1 | B | PCF control of MPS for DTS | 17.3.0 | +| 2021-06 | CT#92e | CP-211201 | 0258 | 3 | B | 5G ProSe related updates to PCC procedures | 17.3.0 | +| 2021-06 | CT#92e | CP-211268 | 0262 | 1 | A | QoS flow binding for QoS monitoring | 17.3.0 | +| 2021-06 | CT#92e | CP-211259 | 0263 | 1 | B | Selecting the same PCF for AMF and SMF | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0264 | 1 | F | Clean up of Network Data Analytics procedures | 17.3.0 | +| 2021-06 | CT#92e | CP-211273 | 0265 | 1 | B | Support Time Sensitive Communication other than TSN | 17.3.0 | +| 2021-06 | CT#92e | CP-211276 | 0266 | 1 | B | Support of Network Exposure to EAS via Local NEF | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0269 | 1 | F | Correction of missing interaction for updating UDR data based on usage report | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0270 | 1 | B | Updates of PCC procedures related to AF influence on URSP | 17.3.0 | +| 2021-09 | CT#93e | CP-212212 | 0272 | 1 | B | 29.513 MPS for DTS note fix | 17.4.0 | +| 2021-09 | CT#93e | CP-212225 | 0273 | 1 | B | AM Influence procedure for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212225 | 0274 | 1 | B | AM Policy Authorization procedure for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212225 | 0275 | 1 | B | AM Policy association procedure updates to support DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212225 | 0276 | 1 | B | DCAMP impact on PCC architecture | 17.4.0 | +| 2021-09 | CT#93e | CP-212205 | 0277 | - | B | DCAMP impact on PCC architecture | 17.4.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93e | CP-212225 | 0278 | 1 | F | BSF enhancement on PCF Discovery and Selection for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212206 | 0279 | 1 | B | Npcf_AMPolicyControl support of UE-Slice-MBR | 17.4.0 | +| 2021-09 | CT#93e | CP-212211 | 0280 | 1 | F | Correction to abbreviations for TSC | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0281 | - | F | Correction of resource name used in xBDT | 17.4.0 | +| 2021-09 | CT#93e | CP-212193 | 0284 | 1 | B | 5QI value for services carried over satellite access/backhaul | 17.4.0 | +| 2021-09 | CT#93e | CP-212208 | 0286 | 1 | A | Correction to V2X Policy Provisioning Request | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0287 | 1 | F | Correction to ProSe Policy Provisioning Request | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0288 | - | B | Architecture updates to support ProSe | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0289 | - | B | BSF support for the PCF notification of PDUID changes | 17.4.0 | +| 2021-12 | CT#94-e | CP-213234 | 0291 | 1 | B | Updates for TSC networks other than TSN | 17.5.0 | +| 2021-12 | CT#94-e | CP-213229 | 0292 | | B | PCC Support of restricted PDU Session for remote provisioning of UE using User Plane | 17.5.0 | +| 2021-12 | CT#94-e | CP-213225 | 0294 | 1 | B | Handling of Session Management Policy Data per PLMN | 17.5.0 | +| 2021-12 | CT#94-e | CP-213222 | 0295 | 1 | B | Notification on the outcome of UE Policies delivery due to service specific parameter provisioning | 17.5.0 | +| 2021-12 | CT#94-e | CP-213194 | 0296 | 1 | F | Updates on DCAMP related BSF services | 17.5.0 | +| 2021-12 | CT#94-e | CP-213227 | 0297 | 1 | B | NWDAF discovery by the PCF | 17.5.0 | +| 2021-12 | CT#94-e | CP-213237 | 0298 | | F | Correction to PFD procedures | 17.5.0 | +| 2021-12 | CT#94-e | CP-213243 | 0299 | 1 | F | Correction to SM Policy Association Establishment procedure | 17.5.0 | +| 2021-12 | CT#94-e | CP-213194 | 0300 | 1 | B | Completion of PCF discovery mechanisms | 17.5.0 | +| 2021-12 | CT#94-e | CP-213194 | 0301 | 1 | B | Alternative mechanism for PCF for a UE discovery | 17.5.0 | +| 2021-12 | CT#94-e | CP-213213 | 0302 | | B | Completion of the PCF for a UE registration in the BSF | 17.5.0 | +| 2021-12 | CT#94-e | CP-213230 | 0293 | 2 | B | Support of monitoring the data rate per Network Slice | 17.5.0 | +| 2021-12 | CT#94-e | CP-213223 | 0303 | 1 | B | Update the procedure to support AF preference for the user plane latency | 17.5.0 | +| 2021-12 | CT#94-e | CP-213225 | 0304 | 1 | B | Architectures for interworking with EPS | 17.5.0 | +| 2021-12 | CT#94-e | CP-213200 | 0305 | 1 | F | Updates on DCAMP related BSF procedures | 17.5.0 | +| 2021-12 | CT#94-e | CP-213200 | 0306 | | F | Corrections to DCAMP | 17.5.0 | +| 2021-12 | CT#94-e | CP-213213 | 0307 | 1 | F | Correction of PCF registration in the BSF at UE policy association creation | 17.5.0 | +| 2021-12 | CT#94-e | CP-213225 | 0308 | 1 | F | cancel subscription to UDR at SM policy association termination | 17.5.0 | +| 2021-12 | CT#94-e | CP-213244 | 0309 | | F | cancel subscription to UDR at UE policy association termination | 17.5.0 | +| 2021-12 | CT#94-e | CP-213244 | 0312 | 1 | F | Correction to PFD retrieval procedure | 17.5.0 | +| 2021-12 | CT#94-e | CP-213228 | 0313 | 2 | B | Policy decisions based on Network Analytics | 17.5.0 | +| 2021-12 | CT#94-e | CP-213230 | 0314 | 1 | B | Same PCF discovery for the control of data rate per network slice | 17.5.0 | +| 2021-12 | CT#94-e | CP-213200 | 0315 | 1 | B | Management of AM Policies depending on the application in use | 17.5.0 | +| 2021-12 | CT#94-e | CP-213223 | 0316 | 1 | B | AF Request for Simultaneous Connectivity over Source and Target PSA at Edge Relocation | 17.5.0 | +| 2022-03 | CT#95e | CP-220198 | 0317 | 2 | B | Resolution of DCAMP open issues such as applicable filters and immediate reporting | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0318 | 2 | F | Correction to the BSF procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0319 | 1 | F | PCF for a PDU session discovery by PCF a UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0320 | 1 | B | TSCTSF discovery | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0322 | 1 | F | Handling of VN Group data during UE Policy Association Termination procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220187 | 0323 | 2 | F | Correction on the UE-Slice-MBR sent to PCF | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0324 | 2 | B | Reporting requested service area coverage change, clarification | 17.6.0 | +| 2022-03 | CT#95e | CP-220182 | 0325 | 1 | B | Informative guideline for mapping between QoS parameters and DSCP marking | 17.6.0 | +| 2022-03 | CT#95e | CP-220182 | 0326 | 1 | B | Clarification to PCC Support of restricted PDU Session for remote provisioning of UE using User Plane | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0327 | 1 | B | Adding service specific authorization in the service parameter provisioning procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0328 | 1 | F | Collision in SMF during UpdateNotify procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0329 | 1 | B | Support of AF triggered EAS rediscovery | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0330 | 1 | B | Support of EAS IP replacement | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0331 | 1 | B | Support of uplink buffering indication for Application Relocation | 17.6.0 | +| 2022-03 | CT#95e | CP-220202 | 0332 | 1 | B | QoS Mapping at SMF+PGW-C for interworking scenario | 17.6.0 | +| 2022-03 | CT#95e | CP-220202 | 0333 | 1 | B | Signalling flows for interworking scenario | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0335 | 1 | F | Correction to enable retrieval of Network Provided Location information in a MESSAGE request | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0336 | 1 | B | Deferred invocation of Npcf_PolicyAuthorization_Create service operation | 17.6.0 | +| 2022-06 | CT#96 | CP-221116 | 0337 | | F | Incorrect step number referenced in UE Policy Association Modification procedures | 17.7.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221129 | 0338 | | F | Correction to PCF subscription on USER_DATA_CONGESTION | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0339 | | F | Correction of wrong features in the flow procedures for Edge Computing | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0340 | | F | PCF behaviour for Data Dispersion and WLAN performance | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0341 | | B | PCF behaviour for Service Experience analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221138 | 0342 | 1 | F | Completion of User Plane Remote Provisioning | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0343 | 1 | F | Correction to AM Policy Association Modification procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0344 | 1 | F | Correction to AM Policy Association Termination procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0345 | 1 | B | Notification of PDU session establishment or PDU session termination | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0346 | 1 | B | Update of AF requests to influence AM policies procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0347 | 1 | B | Update of binding information subscription procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0348 | 1 | B | Update of PCF for a PDU session discovery and selection by the PCF for a UE | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0350 | 1 | F | Session binding for TSC | 17.7.0 | +| 2022-06 | CT#96 | CP-221144 | 0351 | | F | Correction to SM policy association establishment | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0352 | 1 | F | Correction to SM policy association modification by the PCF | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0353 | 1 | F | Correction to SM policy association modification initiated by the SMF | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0354 | 1 | F | BSF storage information for TSC | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0355 | 1 | F | Correction to the procedure of maximum allowed user plane latency | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0356 | 1 | F | Correction to the SMF behaviour of IP replacement | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0359 | 1 | B | Introduction of 5MBS in PCC architecture | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0360 | 1 | B | Structure to introduce MBS flows | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0361 | 1 | B | PCF Discovery in MBS PCC deployments | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0362 | 1 | B | QoS mapping in MBS PCC deployments | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0363 | 2 | B | Redefining the scope of TS 29.513 | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0364 | 1 | B | Specification of PCC MBS Session Creation | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0365 | 1 | B | Specification of PCC MBS Session Modification | 17.7.0 | +| 2022-06 | CT#96 | CP-221120 | 0366 | 1 | B | Specification of PCC MBS Session Termination | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0367 | | F | Handling of UE Policy delivery notifications | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0368 | | F | Corrections in AF session procedures | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0369 | 1 | F | VPLMN QoS constraints in QoS mapping procedures | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0370 | 1 | F | Correction to QoS monitoring report | 17.7.0 | +| 2022-06 | CT#96 | CP-221141 | 0371 | 1 | A | Request of V2XP/ProSeP during NAS Transport procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0374 | | F | PCF selection for V2XP and ProSe | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0375 | 1 | F | Handling of individual alternative QoS | 17.7.0 | +| 2022-06 | CT#96 | CP-221145 | 0376 | 1 | F | Discovery of TSCTSF notification URI | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0377 | 1 | F | Wrong reference allocation | 17.7.0 | +| 2022-09 | CT#97e | CP-222091 | 0382 | 1 | A | Attribute name correction for QoS monitoring | 17.8.0 | +| 2022-09 | CT#97e | CP-222127 | 0383 | 1 | F | Correction to SMF-initiated SM Policy Association Modification procedure | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0384 | 1 | F | User plane latency requirement support | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0385 | 1 | F | Incorrect attribute names used in QoS monitoring procedure | 17.8.0 | +| 2022-09 | CT#97e | CP-222125 | 0386 | 1 | F | Correction to ANDSP/URSP rules Determination | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0388 | 1 | F | PCF selection based on Same PCF indication | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0390 | | F | Service parameter data retrieval | 17.8.0 | +| 2022-12 | CT#98e | CP-223166 | 0396 | | F | Handling of QoS mapping procedures in PCF and MB-SMF. | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0397 | | F | Removal of EN related to the impacts in 5MBS PCC architecture. | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0398 | | F | Introduction of MBS Discovery procedures | 17.9.0 | +| 2022-12 | CT#98e | CP-223167 | 0399 | 1 | F | Completion of MBS Policy Session Modification procedure | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0403 | | F | Binding mechanism for MBS | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0404 | | F | Resolves the editor's note in the create service operation | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0405 | | F | Resolves the editor's note in the delete service operation | 17.9.0 | +| 2022-12 | CT#98e | CP-223162 | 0409 | | F | Session binding to support 5G ProSe Layer-3 UE-to-Network Relay without N3IWF | 17.9.0 | +| 2022-12 | CT#98e | CP-223201 | 0391 | 1 | B | Feature awareness during UE mobility with AMF change | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0392 | | F | Clarification on usage of N30 and N5 reference points | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0393 | 1 | F | Support of UE Policy delivery in AMF-initiated UE Policy Association modification | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0394 | | F | Corrections on QoS mapping tables | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0395 | 1 | F | Corrections on the RFSP Index handling | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0402 | 2 | F | Correction to the attribute name for QoS parameters calculation | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0406 | 1 | F | Correction to provisioning of service information | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0407 | | B | PLMN to PLMN inter-AMF mobility | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0408 | | F | Correction to PCC rule authorization for AF requests with Alternative Service Requirements | 18.0.0 | +| 2022-12 | CT#98e | CP-223178 | 0410 | | B | SNPN to SNPN inter-AMF mobility | 18.0.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|--------------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230133 | 0412 | 1 | B | Considering UE Policy Control inputs for ANDSP determination | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0413 | 1 | F | Clarification about the parameter matching in session binding | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0414 | | F | Clarification about the order of steps in UE Policy Association procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0418 | 1 | B | Update Traffic Influence procedures. | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0423 | 1 | B | Support for AF traffic influence for common EAS, DNAI selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230127 | 0425 | 1 | A | Removal of V2XP/ProSeP during registration | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0426 | | F | Correct API name for Nbsf_Management_Discovery API | 18.1.0 | +| 2023-03 | CT#99 | CP-230140 | 0429 | | A | Correction on the feature support for implicit subscriptions | 18.1.0 | +| 2023-03 | CT#99 | CP-230140 | 0430 | 1 | A | Correction in the handling of QoS monitoring report | 18.1.0 | +| 2023-03 | CT#99 | CP-230147 | 0431 | 1 | B | NWDAF-assisted for URSP rules determination | 18.1.0 | +| 2023-03 | CT#99 | CP-230170 | 0432 | 1 | B | Service Function Chaining support in the Traffic Influence procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0433 | | F | Missing edge computing functionality for AF request to influence traffic routing procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0435 | 1 | B | Procedures for Time Synchronization Exposure | 18.1.0 | +| 2023-03 | CT#99 | CP-230136 | 0436 | 1 | B | Support of integration with IETF Deterministic Networking | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0437 | 1 | F | ANDSP and/or OSId support indication to V-PCF | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0438 | 1 | F | Complete description for Onboarding Indication | 18.1.0 | +| 2023-03 | CT#99 | CP-230177 | 0439 | | B | Support of IPv6 prefix delegation | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0440 | 1 | B | Enhancement of Time Sensitive Communication | 18.1.0 | +| 2023-03 | CT#99 | CP-230181 | 0441 | 1 | B | Feature negotiation in roaming scenarios | 18.1.0 | +| 2023-06 | CT#100 | CP-231165 | 0443 | | B | UE Policy Association procedure updates for ANDSP determination and delivery | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0444 | 3 | B | URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231177 | 0445 | | B | PCF triggered UE mobility from 5GS to EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0446 | 1 | B | Clarification to subscription to UMIC and PMIC changes | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0447 | | B | Clarification and correction to the report of extra UE addresses | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0448 | 1 | F | Update the description with references. | 18.2.0 | +| 2023-06 | CT#100 | CP-231156 | 0450 | 1 | B | Support for A2X service parameters and policy provisioning during UE Policy association establishment. | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0451 | | F | Correction to BSF procedures | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0452 | 1 | F | Update of 5.5.1 | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 0453 | 1 | D | Correction to AF influence on Service Function Chaining | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0454 | 1 | D | Corrections for the reference number | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0455 | | B | NWDAF assisted decision on E2E redundant transmission | 18.2.0 | +| 2023-06 | CT#100 | CP-231136 | 0456 | 4 | B | Support of VPLMN Specific Offloading Policy for HR-SBO | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0457 | 1 | F | Corrections on DetNet node information reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0458 | 1 | B | Support of PDTQ Policy Negotiation procedure | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0459 | 1 | B | Support of PDTQ warning notification procedure | 18.2.0 | +| 2023-06 | CT#100 | CP-231156 | 0461 | 1 | B | Enhancements to AF-based service parameter provisioning for A2X communication | 18.2.0 | +| 2023-06 | CT#100 | CP-231147 | 0464 | | A | Removal of QoS monitoring control at PDU session release | 18.2.0 | +| 2023-06 | CT#100 | CP-231162 | 0465 | 1 | B | Support of application detection event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0466 | 1 | B | Complete description for the AF request on PDU session supporting HR-SBO | 18.2.0 | +| 2023-06 | CT#100 | CP-231171 | 0467 | | B | Support of dynamically changing AM policies for inbound roamers using LBO | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0468 | 1 | B | URSP Enforcement analytics ID for policy decision | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0470 | | F | misplaced 5G DDNMF in 8.4.1 | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0471 | 1 | B | Update of TSCTSF mapping of DetNet configuration | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0472 | 1 | B | Support of 3GPP extensions for DetNet | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0473 | | B | Completion of URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0474 | 1 | B | Policy Control for L4S | 18.2.0 | +| 2023-09 | CT3#101 | CP-232101 | 0475 | 1 | B | Retrieving home TNAPs for policy decisions | 18.3.0 | +| 2023-09 | CT3#101 | CP-232158 | 0476 | 1 | B | Packet delay variation monitoring enhancement | 18.3.0 | +| 2023-09 | CT3#101 | CP-232127 | 0477 | 1 | B | Data channel update for N5 interface | 18.3.0 | +| 2023-09 | CT3#101 | CP-232086 | 0480 | 1 | F | Corrections to 5MBS signalling procedures | 18.3.0 | +| 2023-09 | CT3#101 | CP-232094 | 0482 | 1 | A | Essential corrections to 5MBS signalling procedures | 18.3.0 | +| 2023-09 | CT3#101 | CP-232104 | 0483 | 1 | F | EN resolution for A2X subscription | 18.3.0 | +| 2023-09 | CT3#101 | CP-232102 | 0486 | 1 | D | Correction on SFC abbreviation | 18.3.0 | +| 2023-09 | CT3#101 | CP-232087 | 0487 | 1 | B | Update the procedures for PDTQ policy negotiation and warning notification | 18.3.0 | +| 2023-09 | CT3#101 | CP-232257 | 0488 | 1 | B | Update the processing of AF requests on PDU Sessions supporting HR-SBO | 18.3.0 | +| 2023-09 | CT3#101 | CP-232257 | 0489 | 1 | B | Impacts in AF influence on traffic procedures due to HR-SBO scenarios | 18.3.0 | +| 2023-09 | CT3#101 | CP-232108 | 0490 | | B | Handling of Packet Delay Budget for PIN scenarios | 18.3.0 | +| 2023-09 | CT3#101 | CP-232086 | 0491 | 2 | F | Clarification on BDT negotiation data modification | 18.3.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|---------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT3#101 | CP-232099 | 0492 | 1 | B | Spending Limits for AM Policy and UE Policy | 18.3.0 | +| 2023-09 | CT3#101 | CP-232103 | 0494 | 3 | B | Add RSLPP in call flows of Policy Control | 18.3.0 | +| 2023-12 | CT#102 | CP-233279 | 0495 | | B | Removal of EN on A2X and V2X parameter provisioning | 18.4.0 | +| 2023-12 | CT#102 | CP-233274 | 0496 | 1 | F | Correction on description of rfspValTime | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0497 | 2 | B | Procedure of Awareness of URSP Rule Enforcement | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0498 | 2 | F | Correction in warning notification procedures. | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0499 | 4 | F | Correction in warning notification procedures and related data types. | 18.4.0 | +| 2023-12 | CT#102 | CP-233275 | 0500 | 1 | B | IMS Data channel QoS update | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0501 | 1 | B | AF QoS Timing info addition | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0502 | 1 | B | Policy Authorization for AF requested QoS for a UE or group of UEs not identified by a UE address | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0503 | 1 | B | Support of VPLMN specific URSP rules | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0504 | | B | Update to the report of time synchronization status changes | 18.4.0 | +| 2023-12 | CT#102 | CP-233248 | 0505 | | B | Subscription checks during Time Synchronization Exposure | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0506 | | B | UE Policy Association for 3GPP and non-3GPP accesses | 18.4.0 | +| 2023-12 | CT#102 | CP-233250 | 0507 | 1 | F | Include Partially Allowed NSSAI in the AM Policy association procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233257 | 0508 | | D | resource name correction | 18.4.0 | +| 2023-12 | CT#102 | CP-233268 | 0509 | 1 | F | Removal of Editor's Note related to the Npcf_UEPolicyControl support | 18.4.0 | +| 2023-12 | CT#102 | CP-233255 | 0511 | 1 | A | Correction to PCC procedures for location dependent MBS service | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0512 | 1 | B | Support of QoS monitoring subscription from the NWDAF | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0513 | 1 | B | Update the QoS flow binding procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233266 | 0514 | 1 | B | Solving Editor's Note about QoS mapping | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0515 | 1 | B | Completion of LBO roaming information | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0516 | 1 | B | Skipping the checking of policy subscription data | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0517 | | B | Solving Editor's Note about Feature re-negotiation | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29514/raw.md b/gsma/29_series/29514/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ef519dbd83299c7c291687749669d47c8aa7bbc8 --- /dev/null +++ b/gsma/29_series/29514/raw.md @@ -0,0 +1,10186 @@ + + +# 3GPP TS 29.514 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Policy Authorization Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. + +Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices + +## Keywords + +**3GPP** + +Postal address + +3GPP support office address +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + + +**3GPP** + +# Contents + +| | | +|------------------------------------------------------------------------------------------------|----| +| Foreword..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Abbreviations..... | 14 | +| 4 Npcf_PolicyAuthorization Service..... | 15 | +| 4.1 Service Description..... | 15 | +| 4.1.1 Overview..... | 15 | +| 4.1.2 Service Architecture..... | 15 | +| 4.1.3 Network Functions..... | 16 | +| 4.1.3.1 Policy Control Function (PCF)..... | 16 | +| 4.1.3.2 NF Service Consumers..... | 17 | +| 4.2 Service Operations..... | 18 | +| 4.2.1 Introduction..... | 18 | +| 4.2.2 Npcf_PolicyAuthorization_Create service operation..... | 18 | +| 4.2.2.1 General..... | 18 | +| 4.2.2.2 Initial provisioning of service information..... | 20 | +| 4.2.2.3 Gate control..... | 24 | +| 4.2.2.4 Initial Background Data Transfer policy indication..... | 25 | +| 4.2.2.5 Initial provisioning of sponsored connectivity information..... | 25 | +| 4.2.2.6 Subscriptions to Service Data Flow QoS notification control..... | 26 | +| 4.2.2.7 Subscription to Service Data Flow Deactivation..... | 26 | +| 4.2.2.8 Initial provisioning of traffic routing and service function chaining information..... | 27 | +| 4.2.2.9 Void..... | 29 | +| 4.2.2.10 Subscription to resources allocation outcome..... | 29 | +| 4.2.2.11 Void..... | 29 | +| 4.2.2.12 Invocation of Multimedia Priority Services..... | 29 | +| 4.2.2.12.1 General..... | 29 | +| 4.2.2.12.2 MPS for DTS..... | 30 | +| 4.2.2.12.3 Provisioning of MPS for DTS signalling flow information..... | 30 | +| 4.2.2.13 Support of content versioning..... | 31 | +| 4.2.2.14 Request of access network information..... | 31 | +| 4.2.2.15 Initial provisioning of service information status..... | 32 | +| 4.2.2.16 Provisioning of signalling flow information..... | 32 | +| 4.2.2.17 Support of resource sharing..... | 33 | +| 4.2.2.18 Indication of Emergency traffic..... | 33 | +| 4.2.2.19 Invocation of MCPTT..... | 34 | +| 4.2.2.20 Invocation of MCVideo..... | 34 | +| 4.2.2.21 Priority sharing indication..... | 34 | +| 4.2.2.22 Subscription to Out of Credit notification..... | 35 | +| 4.2.2.23 Subscriptions to Service Data Flow QoS Monitoring Information..... | 35 | + +# Copyright Notification + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +| | | | +|----------|-------------------------------------------------------------------------------------------------|----| +| 4.2.2.24 | Provisioning of TSCAI input Information and QoS related data..... | 37 | +| 4.2.2.25 | Provisioning of TSC user plane node management information and port management information..... | 38 | +| 4.2.2.26 | Invocation of Mission Critical Services..... | 39 | +| 4.2.2.27 | P-CSCF restoration enhancements..... | 39 | +| 4.2.2.29 | Support of FLUS feature..... | 40 | +| 4.2.2.30 | Subscription to EPS Fallback report..... | 40 | +| 4.2.2.31 | Subscription to TSC user plane node related events..... | 40 | +| 4.2.2.32 | Initial provisioning of required QoS information..... | 41 | +| 4.2.2.33 | Support of QoSHint feature..... | 41 | +| 4.2.2.34 | Subscription to Reallocation of Credit notification..... | 41 | +| 4.2.2.35 | Subscription to satellite backhaul category changes..... | 42 | +| 4.2.2.36 | Subscription to the report of extra UE addresses..... | 42 | +| 4.2.2.37 | Provisioning of multi-modality services..... | 42 | +| 4.2.2.38 | Initial provisioning of Round-Trip latency requirements..... | 43 | +| 4.2.2.39 | Provisioning of PDU Set QoS related data..... | 43 | +| 4.2.2.41 | Subscription to Packet Delay Variation monitoring..... | 44 | +| 4.2.2.42 | Initial provisioning of periodicity information..... | 44 | +| 4.2.2.43 | Provisioning of the indication of ECN marking for L4S support..... | 44 | +| 4.2.2.44 | Subscription to Round-Trip delay monitoring..... | 45 | +| 4.2.3 | Npcf_PolicyAuthorization_Update service operation..... | 46 | +| 4.2.3.1 | General..... | 46 | +| 4.2.3.2 | Modification of service information..... | 47 | +| 4.2.3.3 | Gate control..... | 50 | +| 4.2.3.4 | Background Data Transfer policy indication at policy authorization update..... | 50 | +| 4.2.3.5 | Modification of sponsored connectivity information..... | 51 | +| 4.2.3.6 | Modification of Subscription to Service Data Flow QoS notification control..... | 52 | +| 4.2.3.7 | Modification of Subscription to Service Data Flow Deactivation..... | 52 | +| 4.2.3.8 | Update of traffic routing and service function chaining information..... | 52 | +| 4.2.3.9 | Void..... | 54 | +| 4.2.3.10 | Modification of subscription to resources allocation outcome..... | 54 | +| 4.2.3.11 | Void..... | 54 | +| 4.2.3.12 | Modification of Multimedia Priority Services..... | 54 | +| 4.2.3.13 | Support of content versioning..... | 55 | +| 4.2.3.14 | Request of access network information..... | 55 | +| 4.2.3.15 | Modification of service information status..... | 55 | +| 4.2.3.16 | Support of SIP forking..... | 56 | +| 4.2.3.17 | Provisioning of signalling flow information..... | 56 | +| 4.2.3.18 | Support of resource sharing..... | 56 | +| 4.2.3.19 | Modification of MCPTT..... | 57 | +| 4.2.3.20 | Modification of MCVideo..... | 57 | +| 4.2.3.21 | Priority sharing indication..... | 57 | +| 4.2.3.22 | Modification of Subscription to Out of Credit notification..... | 58 | +| 4.2.3.23 | Modification of Subscription to Service Data Flow QoS Monitoring Information..... | 58 | +| 4.2.3.24 | Update of TSCAI Input Information and TSC QoS related data..... | 59 | +| 4.2.3.25 | Provisioning of TSC user plane node management information and port management information..... | 60 | +| 4.2.3.26 | Modification of Mission Critical Services..... | 60 | +| 4.2.3.28 | Support of FLUS feature..... | 60 | +| 4.2.3.29 | Subscription to EPS Fallback report..... | 60 | +| 4.2.3.30 | Modification of required QoS information..... | 61 | +| 4.2.3.31 | Support of QoSHint feature..... | 62 | +| 4.2.3.32 | Modification of Subscription to Reallocation of Credit notification..... | 62 | +| 4.2.3.33 | Modification of Subscription to satellite backhaul category changes..... | 62 | +| 4.2.3.34 | Modification of Subscription to TSC user plane node related events..... | 63 | +| 4.2.3.35 | Modification of the subscription to the report of extra UE addresses..... | 63 | +| 4.2.3.36 | Modification of multi-modal services..... | 63 | +| 4.2.3.37 | Modification of Round-Trip latency requirements..... | 64 | +| 4.2.3.38 | Update of PDU Set QoS related data..... | 64 | +| 4.2.3.39 | Modification of Subscription to TSC user plane node related events..... | 64 | +| 4.2.3.40 | Modification of Packet Delay Variation monitoring requirement..... | 64 | + +| | | | +|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 4.2.3.41 | Modification of periodicity information..... | 65 | +| 4.2.3.42 | Provisioning of the indication of ECN marking for L4S support..... | 65 | +| 4.2.3.43 | Modification of Round-Trip delay monitoring requirements..... | 65 | +| 4.2.4 | Npcf_PolicyAuthorization_Delete service operation..... | 66 | +| 4.2.4.1 | General..... | 66 | +| 4.2.4.2 | AF application session context termination..... | 66 | +| 4.2.4.3 | Reporting usage for sponsored data connectivity..... | 67 | +| 4.2.4.4 | Void..... | 67 | +| 4.2.4.5 | Termination of Multimedia Priority Services..... | 68 | +| 4.2.4.6 | Request and report of access network information..... | 68 | +| 4.2.4.7 | Termination of MCPTT..... | 69 | +| 4.2.4.8 | Termination of MCVideO..... | 69 | +| 4.2.4.9 | Priority sharing indication..... | 69 | +| 4.2.4.10 | Report of RAN-NAS release cause..... | 70 | +| 4.2.4.11 | Termination of Mission Critical Services..... | 71 | +| 4.2.4.12 | Void..... | 71 | +| 4.2.5 | Npcf_PolicyAuthorization_Notify service operation..... | 71 | +| 4.2.5.1 | General..... | 71 | +| 4.2.5.2 | Notification about application session context event..... | 72 | +| 4.2.5.3 | Notification about application session context termination..... | 73 | +| 4.2.5.4 | Notification about Service Data Flow QoS notification control..... | 75 | +| 4.2.5.5 | Notification about Service Data Flow Deactivation..... | 75 | +| 4.2.5.6 | Reporting usage for sponsored data connectivity..... | 77 | +| 4.2.5.7 | Void..... | 77 | +| 4.2.5.8 | Notification about resources allocation outcome..... | 77 | +| 4.2.5.9 | Void..... | 79 | +| 4.2.5.10 | Notification of signalling path status..... | 79 | +| 4.2.5.11 | Reporting access network information..... | 80 | +| 4.2.5.12 | Notification about Out of Credit..... | 81 | +| 4.2.5.13 | Notification about TSC user plane node management information and/or port management information detection, Individual Application Session Context exists..... | 81 | +| 4.2.5.14 | Notification about Service Data Flow QoS Monitoring control..... | 82 | +| 4.2.5.15 | Report of EPS Fallback..... | 83 | +| 4.2.5.16 | Notification about TSC user plane node Information, no Individual Application Session Context exists..... | 83 | +| 4.2.5.17 | Notification about Reallocation of Credit..... | 85 | +| 4.2.5.18 | Notification of MPS for DTS Outcome..... | 85 | +| 4.2.5.19 | Notification about Application Detection Information..... | 85 | +| 4.2.5.20 | Notification about satellite backhaul category changes..... | 86 | +| 4.2.5.21 | Notification about UP change enforcement failure..... | 86 | +| 4.2.5.22 | Notification about PDU session established/terminated events..... | 86 | +| 4.2.5.23 | Notification about extra UE addresses..... | 87 | +| 4.2.5.25 | Notification about URSP rule enforcement information..... | 88 | +| 4.2.5.26 | Notification about Packet Delay Variation..... | 89 | +| 4.2.5.27 | Notification about 5GS support for Policy Control for L4S..... | 89 | +| 4.2.5.28 | Notification about Round-Trip delay monitoring measurements..... | 89 | +| 4.2.5.29 | Event notification for AF requested QoS for a UE or group of UE(s) not identified by UE address(es)..... | 90 | +| 4.2.6 | Npcf_PolicyAuthorization_Subscribe service operation..... | 90 | +| 4.2.6.1 | General..... | 90 | +| 4.2.6.2 | Handling of subscription to events for the existing application session context..... | 91 | +| 4.2.6.3 | Initial subscription to events without provisioning of service information..... | 93 | +| 4.2.6.4 | Subscription to usage monitoring of sponsored data connectivity..... | 95 | +| 4.2.6.5 | Void..... | 95 | +| 4.2.6.6 | Request of access network information..... | 95 | +| 4.2.6.7 | Subscription to notification of signalling path status..... | 96 | +| 4.2.6.8 | Subscription to Service Data Flow QoS Monitoring Information..... | 96 | +| 4.2.6.9 | Subscription to application detection notification..... | 97 | +| 4.2.6.10 | Subscription to satellite backhaul category changes..... | 98 | +| 4.2.6.11 | Subscription to TSC user plane node related events..... | 98 | +| 4.2.6.12 | Subscription to the report of extra UE addresses..... | 99 | + +| | | | +|-------------|-----------------------------------------------------------------------------|-----| +| 4.2.6.13 | Subscription to Service Data Flow QoS Monitoring, multi-modal services..... | 99 | +| 4.2.6.14 | Subscription to notifications about URSP rule enforcement..... | 99 | +| 4.2.7 | Npcf_PolicyAuthorization_Unsubscribe service operation..... | 100 | +| 4.2.7.1 | General..... | 100 | +| 4.2.7.2 | Unsubscription to events..... | 100 | +| 5 | Npcf_PolicyAuthorization Service API..... | 101 | +| 5.1 | Introduction..... | 101 | +| 5.2 | Usage of HTTP..... | 101 | +| 5.2.1 | General..... | 101 | +| 5.2.2 | HTTP standard headers..... | 101 | +| 5.2.2.1 | General..... | 101 | +| 5.2.2.2 | Content type..... | 102 | +| 5.2.3 | HTTP custom headers..... | 102 | +| 5.3 | Resources..... | 102 | +| 5.3.1 | Resource Structure..... | 102 | +| 5.3.2 | Resource: Application Sessions (Collection)..... | 103 | +| 5.3.2.1 | Description..... | 103 | +| 5.3.2.2 | Resource definition..... | 103 | +| 5.3.2.3 | Resource Standard Methods..... | 103 | +| 5.3.2.3.1 | POST..... | 103 | +| 5.3.2.4 | Resource Custom Operations..... | 105 | +| 5.3.2.4.1 | Overview..... | 105 | +| 5.3.2.4.2 | Operation: PscfRestoration..... | 105 | +| 5.3.2.4.2.1 | Description..... | 105 | +| 5.3.2.4.2.2 | Operation Definition..... | 105 | +| 5.3.3 | Resource: Individual Application Session Context (Document)..... | 106 | +| 5.3.3.1 | Description..... | 106 | +| 5.3.3.2 | Resource definition..... | 106 | +| 5.3.3.3 | Resource Standard Methods..... | 106 | +| 5.3.3.3.1 | GET..... | 106 | +| 5.3.3.3.2 | PATCH..... | 107 | +| 5.3.3.4 | Resource Custom Operations..... | 109 | +| 5.3.3.4.1 | Overview..... | 109 | +| 5.3.3.4.2 | Operation: delete..... | 109 | +| 5.3.3.4.2.1 | Description..... | 109 | +| 5.3.3.4.2.2 | Operation Definition..... | 109 | +| 5.3.4 | Resource: Events Subscription (Document)..... | 110 | +| 5.3.4.1 | Description..... | 110 | +| 5.3.4.2 | Resource definition..... | 111 | +| 5.3.4.3 | Resource Standard Methods..... | 111 | +| 5.3.4.3.1 | PUT..... | 111 | +| 5.3.4.3.2 | DELETE..... | 113 | +| 5.3.3.4 | Resource Custom Operations..... | 114 | +| 5.4 | Custom Operations without associated resources..... | 114 | +| 5.5 | Notifications..... | 114 | +| 5.5.1 | General..... | 114 | +| 5.5.2 | Event Notification..... | 115 | +| 5.5.2.1 | Description..... | 115 | +| 5.5.2.2 | Target URI..... | 115 | +| 5.5.2.3 | Standard Methods..... | 115 | +| 5.5.2.3.1 | POST..... | 115 | +| 5.5.3 | Termination Request..... | 116 | +| 5.5.3.1 | Description..... | 116 | +| 5.5.3.2 | Target URI..... | 116 | +| 5.5.3.3 | Standard Methods..... | 117 | +| 5.5.3.3.1 | POST..... | 117 | +| 5.5.4 | Detected 5GS Bridge for a PDU session..... | 118 | +| 5.5.4.1 | Description..... | 118 | +| 5.5.4.2 | Target URI..... | 118 | +| 5.5.4.3 | Standard Methods..... | 118 | +| 5.5.4.3.1 | POST..... | 118 | + +| | | | +|-----------|----------------------------------------------|-----| +| 5.5.5 | Notification about PDU session event..... | 119 | +| 5.5.5.1 | Description..... | 119 | +| 5.5.5.2 | Target URI..... | 120 | +| 5.5.5.3 | Standard Methods..... | 120 | +| 5.5.5.3.1 | POST..... | 120 | +| 5.6 | Data Model..... | 121 | +| 5.6.1 | General..... | 121 | +| 5.6.2 | Structured data types..... | 128 | +| 5.6.2.1 | Introduction..... | 128 | +| 5.6.2.2 | Type AppSessionContext..... | 129 | +| 5.6.2.3 | Type AppSessionContextReqData..... | 130 | +| 5.6.2.4 | Type AppSessionContextRespData..... | 132 | +| 5.6.2.5 | Type AppSessionContextUpdateData..... | 133 | +| 5.6.2.6 | Type EventsSubscReqData..... | 135 | +| 5.6.2.7 | Type MediaComponent..... | 137 | +| 5.6.2.8 | Type MediaSubComponent..... | 140 | +| 5.6.2.9 | Type EventsNotification..... | 142 | +| 5.6.2.10 | Type AfEventSubscription..... | 145 | +| 5.6.2.11 | Type AfEventNotification..... | 145 | +| 5.6.2.12 | Type TerminationInfo..... | 145 | +| 5.6.2.13 | Type AfRoutingRequirement..... | 146 | +| 5.6.2.14 | Type ResourcesAllocationInfo..... | 147 | +| 5.6.2.15 | Type QosNotificationControlInfo..... | 147 | +| 5.6.2.16 | Type SpatialValidity..... | 148 | +| 5.6.2.17 | Type EthFlowDescription..... | 149 | +| 5.6.2.18 | Void..... | 150 | +| 5.6.2.19 | Void..... | 150 | +| 5.6.2.20 | Type AnGwAddress..... | 150 | +| 5.6.2.21 | Type Flows..... | 150 | +| 5.6.2.22 | Type TemporalValidity..... | 151 | +| 5.6.2.23 | Void..... | 151 | +| 5.6.2.24 | Type AfRoutingRequirementRm..... | 151 | +| 5.6.2.25 | Type EventsSubscReqDataRm..... | 152 | +| 5.6.2.26 | Type MediaComponentRm..... | 154 | +| 5.6.2.27 | Type MediaSubComponentRm..... | 158 | +| 5.6.2.28 | Type SpatialValidityRm..... | 159 | +| 5.6.2.29 | Type ExtendedProblemDetails..... | 159 | +| 5.6.2.30 | Type AcceptableServiceInfo..... | 159 | +| 5.6.2.31 | Type UeIdentityInfo..... | 159 | +| 5.6.2.32 | Type AccessNetChargingIdentifier..... | 160 | +| 5.6.2.33 | Type OutOfCreditInformation..... | 160 | +| 5.6.2.34 | Type QosMonitoringInformation..... | 161 | +| 5.6.2.35 | Type TsnQosContainer..... | 162 | +| 5.6.2.36 | Type PscfRestorationRequestData..... | 162 | +| 5.6.2.37 | Type QosMonitoringReport..... | 163 | +| 5.6.2.38 | Type TsnQosContainerRm..... | 164 | +| 5.6.2.39 | Type TscaiInputContainer..... | 164 | +| 5.6.2.40 | Type PduSessionTsnBridge..... | 165 | +| 5.6.2.41 | Type QosMonitoringInformationRm..... | 165 | +| 5.6.2.42 | Type EventsSubscPutData..... | 166 | +| 5.6.2.43 | Type AppSessionContextUpdateDataPatch..... | 166 | +| 5.6.2.44 | Type AppDetectionReport..... | 166 | +| 5.6.2.45 | Type PduSessionEventNotification..... | 167 | +| 5.6.2.46 | Type PcfAddressingInfo..... | 168 | +| 5.6.2.47 | Type AlternativeServiceRequirementsData..... | 168 | +| 5.6.2.48 | Type PeriodicityRange..... | 169 | +| 5.6.2.49 | Type AfSfcRequirement..... | 169 | +| 5.6.2.51 | Type ProtoDesc..... | 170 | +| 5.6.2.52 | Type ProtoDescRm..... | 170 | +| 5.6.2.53 | Type PdvMonitoringReport..... | 170 | +| 5.6.2.54 | Type PeriodicityInfo..... | 170 | + +| | | | +|------------------------------------------------------------------------|--------------------------------------------------------------------------------|------------| +| 5.6.2.56 | Type L4sSupport..... | 171 | +| 5.6.3 | Simple data types and enumerations..... | 171 | +| 5.6.3.1 | Introduction..... | 171 | +| 5.6.3.2 | Simple data types..... | 171 | +| 5.6.3.3 | Enumeration: MediaType..... | 172 | +| 5.6.3.4 | Enumeration: ReservPriority..... | 173 | +| 5.6.3.5 | Enumeration: ServAuthInfo..... | 173 | +| 5.6.3.6 | Enumeration: SponsoringStatus..... | 173 | +| 5.6.3.7 | Enumeration: AfEvent..... | 174 | +| 5.6.3.8 | Enumeration: AfNotifMethod..... | 176 | +| 5.6.3.9 | Enumeration: QosNotifType..... | 176 | +| 5.6.3.10 | Enumeration: TerminationCause..... | 176 | +| 5.6.3.11 | Void..... | 177 | +| 5.6.3.12 | Enumeration: FlowStatus..... | 177 | +| 5.6.3.13 | Enumeration: MediaComponentResourcesStatus..... | 177 | +| 5.6.3.14 | Enumeration: FlowUsage..... | 177 | +| 5.6.3.15 | Enumeration: RequiredAccessInfo..... | 178 | +| 5.6.3.16 | Enumeration: ServiceInfoStatus..... | 178 | +| 5.6.3.17 | Enumeration: SipForkingIndication..... | 178 | +| 5.6.3.18 | Enumeration: AfRequestedData..... | 178 | +| 5.6.3.19 | Enumeration: PreemptionControlInformation..... | 178 | +| 5.6.3.20 | Enumeration: PrioritySharingIndicator..... | 179 | +| 5.6.3.21 | Enumeration: PreemptionControlInformationRm..... | 179 | +| 5.6.3.22 | Enumeration: MpsAction..... | 179 | +| 5.6.3.23 | Enumeration: AppDetectionNotifType..... | 179 | +| 5.6.3.24 | Enumeration: PduSessionStatus..... | 179 | +| 5.6.3.25 | Enumeration: UplinkDownlinkSupport..... | 180 | +| 5.6.3.26 | Enumeration: L4sNotifType..... | 180 | +| 5.7 | Error handling..... | 180 | +| 5.7.1 | General..... | 180 | +| 5.7.2 | Protocol Errors..... | 180 | +| 5.7.3 | Application Errors..... | 180 | +| 5.8 | Feature negotiation..... | 182 | +| 5.9 | Security..... | 186 | +| Annex A (normative): OpenAPI specification..... | | 187 | +| A.1 | General..... | 187 | +| A.2 | Npcf_PolicyAuthorization API..... | 187 | +| Annex B (normative): IMS Related P-CSCF Procedures over N5..... | | 222 | +| B.1 | Provision of Service Information at P-CSCF..... | 222 | +| B.2 | Enabling of IP Flows..... | 224 | +| B.2.1 | General..... | 224 | +| B.2.2 | Gate control procedures considering the P-Early-Media header field..... | 225 | +| B.2.3 | Gate control procedures based on the configuration in the P-CSCF..... | 226 | +| B.3 | Support for SIP forking..... | 227 | +| B.3.0 | General..... | 227 | +| B.3.1 | PCC rule provisioning for early media for forked responses..... | 227 | +| B.3.2 | Updating the provisioned PCC rules at the final answer..... | 228 | +| B.4 | Notification of AF Signalling Transmission Path Status..... | 228 | +| B.5 | Indication of Emergency Registration and Session Establishment..... | 228 | +| B.6 | Support for Early Session disposition SDP..... | 229 | +| B.6.1 | General..... | 229 | +| B.6.2 | Service Information Provisioning for Early Media..... | 229 | +| B.6.3 | Updating the Provisioned Service Information when Dialogue is established..... | 230 | + +| | | | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------|------------| +| B.7 | Provision of Signalling Flow Information at P-CSCF..... | 231 | +| B.8 | Retrieval of network provided location information..... | 231 | +| B.8.1 | General..... | 231 | +| B.8.2 | Retrieval of network provided location information at originating P-CSCF for inclusion in SIP Request... | 231 | +| B.8.3 | Retrieval of network provided location information at originating P-CSCF for inclusion in SIP response confirmation..... | 232 | +| B.8.4 | Retrieval of network provided location information at terminating P-CSCF..... | 233 | +| B.8.5 | Provisioning of network provided location information at SIP session release..... | 234 | +| B.8.6 | Provisioning of network provided location information at mid call..... | 235 | +| B.9 | Resource Sharing..... | 235 | +| B.10 | Handling of MCPTT priority call..... | 236 | +| B.10.1 | General..... | 236 | +| B.10.2 | Determination of MCPTT priority parameter values..... | 236 | +| B.11 | Handling of MCVideo priority call..... | 237 | +| B.11.1 | General..... | 237 | +| B.11.2 | Determination of MCVideo priority parameter values..... | 237 | +| B.12 | Notification Access Type Change..... | 237 | +| B.13 | Notification of PLMN Change..... | 238 | +| B.14 | Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM)..... | 238 | +| B.15 | Handling of a FLUS session..... | 239 | +| B.16 | QoS hint support for data channel media..... | 240 | +| B.17 | Handling of MPS Session..... | 240 | +| B.18 | Handling of RAN/NAS release cause values..... | 241 | +| Annex C (normative): | Flow identifiers: Format definition and examples..... | 241 | +| C.1 | Format of a flow identifier..... | 241 | +| C.1.1 | General..... | 241 | +| Annex D (normative): | Wireless and wireline convergence access support..... | 241 | +| D.1 | Scope..... | 241 | +| D.2 | Npcf_PolicyAuthorization Service..... | 241 | +| D.2.1 | Service Description..... | 241 | +| D.2.1.1 | Overview..... | 241 | +| D.2.1.2 | Service Architecture..... | 241 | +| D.2.1.3 | Network Functions..... | 242 | +| D.2.1.3.1 | Policy Control Function (PCF)..... | 242 | +| D.2.1.3.2 | NF Service Consumers..... | 242 | +| D.3 | Service Operations..... | 242 | +| D.3.1 | Introduction..... | 242 | +| D.3.2 | Npcf_PolicyAuthorization_Create Service Operation..... | 242 | +| D.3.2.1 | General..... | 242 | +| D.3.3 | Npcf_PolicyAuthorization_Update Service Operation..... | 243 | +| D.3.3.1 | General..... | 243 | +| D.3.4 | Npcf_PolicyAuthorization_Delete Service Operation..... | 243 | +| D.3.4.1 | General..... | 243 | +| D.3.5 | Npcf_PolicyAuthorization_Notify Service Operation..... | 243 | +| D.3.5.1 | General..... | 243 | +| D.3.6 | Npcf_PolicyAuthorization_Subscribe Service Operation..... | 244 | +| D.3.6.1 | General..... | 244 | +| D.3.7 | Npcf_PolicyAuthorization_Unsubscribe Service Operation..... | 244 | +| D.3.7.1 | General..... | 244 | + +**Annex E (informative): Change history.....245** + +--- + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# 1 Scope + +The present specification provides the stage 3 definition of the Policy Authorization Service of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for the Npcf Policy Authorization Service are specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Policy Authorization Service is provided by the Policy Control Function (PCF). This service creates policies as requested by the authorised AF for the PDU Session to which the AF session is bound. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [9] IETF RFC 9113: "HTTP/2". +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [12] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [13] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [14] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [15] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [16] IEEE 802.3-2015: "IEEE Standard for Ethernet". +- [17] IEEE 802.1Q-2014: "Bridges and Bridged Networks". + +- [18] IETF RFC 7042: "IANA Considerations and IETF Protocol and Documentation Usage for IEEE 802 Parameters". +- [19] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [20] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [21] IETF RFC 7396: "JSON Merge Patch". +- [22] 3GPP TS 32.291: "5G System; Charging service; Stage 3". +- [23] 3GPP TS 22.153: "5G System; "Multimedia Priority Service". +- [24] IETF RFC 9457: "Problem Details for HTTP APIs". +- [25] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [26] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [27] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [28] 3GPP TR 21.900: "Technical Specification Group working methods". +- [29] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [30] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia telephony; Media handling and interaction". +- [31] IETF RFC 5761: "Multiplexing RTP Data and Control Packets on a Single Port". +- [32] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3". +- [33] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2". +- [34] IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services". +- [35] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [36] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [37] IETF RFC 3556: "Session Description Protocol (SDP) Bandwidth Modifiers for RTP Control Protocol (RTCP) Bandwidth". +- [38] IETF RFC 3959 (December 2004): "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [39] 3GPP TS 23.380: "IMS Restoration Procedures". +- [40] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [41] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control; Protocol specification". +- [42] IETF RFC 8101: "IANA Registration of New Session Initiation Protocol (SIP), Resource-Priority Namespace for Mission Critical Push To Talk Service". +- [43] 3GPP TS 24.281: "Mission Critical Video (MCVideo) signalling control; Protocol specification". +- [44] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [45] 3GPP TS 22.179: "Mission Critical Push to Talk (MCPTT) over LTE; Stage 1". +- [46] 3GPP TS 22.280: "Mission Critical (MC) services common requirements". +- [47] 3GPP TS 22.281: "Mission Critical (MC) video over LTE". + +- [48] 3GPP TS 22.282: "Mission Critical (MC) data over LTE". +- [49] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [50] IETF RFC 4574: "The Session Description Protocol (SDP) Label Attribute". +- [51] 3GPP TS 26.238: "Uplink Streaming". +- [52] IETF RFC 6733: "Diameter Base Protocol". +- [53] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Control Data, Application Data and Structured Data for Exposure; Stage 3". +- [54] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [55] Void. +- [56] IETF RFC 8655: "Deterministic Networking Architecture". +- [57] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Application Function (AF):** Element offering application(s) that use PDU session resources. + +**AF Application identifier:** An identifier that refers to the particular service the NF service consumer session belongs to. In the context of application detection control, it refers to the application identifier used by the PCF in the PCC rule as specified in 3GPP TS 29.512 [8]. + +**AF application session context:** Application level session context established by an application level signalling protocol offered by the AF that requires a session context set-up with explicit session context description before the use of the service. + +**MCS session:** A session for which priority treatment is applied for allocating and maintaining radio and network resources to support the Mission Critical Service (MCS). MCS is defined in 3GPP TS 22.179 [45], 3GPP TS 22.280 [46], 3GPP TS 22.281 [47], and 3GPP TS 22.282 [48]. + +**MPS session:** A session for which priority treatment is applied for allocating and maintaining radio and network resources to support the Multimedia Priority Service (MPS). MPS is defined in 3GPP TS 22.153 [23]. + +**PCC rule:** Set of information enabling the detection of a service data flow and providing parameters for policy control and/or charging control. + +**Service information:** Set of information conveyed from the AF/NEF to the PCF by the Npcf\_PolicyAuthorization service to be used as a basis for PCC decisions at the PCF, including information about the AF/NEF application session context (e.g. application identifier, type of media, bandwidth, IP address and port number). + +**Service data flow:** An aggregate set of packet flows. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-----------------------------------------------------------------------------| +| 5G-RG | 5G Residential Gateway | +| AF | Application Function | +| ARP | Allocation and Retention Priority | +| ATSSS | Access Traffic Steering, Switching and Splitting | +| BAT | Burst Arrival Time | +| BBF | Broadband Forum | +| BSSID | Basic Service Set Identifier | +| CHEM | Coverage and Handoff Enhancements using Multimedia error robustness feature | +| CHF | Charging Function | +| DCCF | Data Collection Coordination Function | +| DEI | Drop Eligible Indicator | +| DetNet | Deterministic Networking | +| DNAI | DN Access Identifier | +| DNN | Data Network Name | +| DS-TT | Device-side TSN translator | +| DSL | Digital Subscriber Line | +| DTS | Data Transport Service | +| EAS | Edge Application Server | +| ECN | Explicit Congestion Notification | +| ePDG | evolved Packet Data Gateway | +| E-UTRA | Evolved Universal Terrestrial Radio Access | +| FLUS | Framework for Live Uplink Streaming | +| FN-RG | Fixed Network Residential Gateway | +| GEO | Geosynchronous Orbit | +| GPSI | Generic Public Subscription Identifier | +| HFC | Hybrid Fiber-Coaxial | +| H-PCF | PCF in the HPLMN | +| IMS | IP-Multimedia Subsystem | +| JSON | JavaScript Object Notation | +| L4S | Low Latency Low Loss Scalable Throughput | +| LEO | Low Earth Orbit | +| MA | Multi-Access | +| MCPTT | Mission Critical Push to Talk Service | +| MCVideo | Mission Critical Video | +| MEO | Medium Earth Orbit | +| MPS | Multimedia Priority Service | +| MTU | Maximum Transmission Unit | +| NEF | Network Exposure Function | +| NID | Network Identifier | +| NR | New Radio | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| NW-TT | Network-side TSN translator | +| PCC | Policy and Charging Control | +| PCF | Policy Control Function | +| PCP | Priority Code Point | +| P-CSCF | Proxy Call Session Control Function | +| PDV | Packet Delay Variation | +| PEI | Permanent Equipment Identifier | +| PMIC | Port Management Information Container | +| PON | Passive Optical Network | +| PRA | Presence Reporting Area | +| PSA | PDU Session Anchor | +| QoS | Quality of Service | +| RFSP | RAT Frequency Selection Priority | + +| | | +|---------|----------------------------------------------------------------| +| RSN | Redundancy Session Number | +| RTCP | Real Time Control Protocol | +| RTP | Real Time Protocol | +| SDF | Service Data Flow | +| SDP | Session Description Protocol | +| SFC | Service Function Chain | +| SIP | Session Initiation Protocol | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SNPN | Stand-alone Non-Public Network | +| SPI | Security Parameter Index | +| SSC | Service and Session Continuity | +| SSID | Service Set Identifier | +| SUPI | Subscription Permanent Identifier | +| TNAP | Trusted Non-3GPP Access Point | +| TSC | Time Sensitive Communication | +| TSCAI | Time Sensitive Communication Assistance Information | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TSN | Time Sensitive Networking | +| UDR | Unified Data Repository | +| UMIC | User plane node Management Information Container | +| UPF | User Plane Function | +| URSP | UE Route Selection Policy | +| VID | VLAN Identifier | +| VLAN | Virtual Local Area Network | +| V-PCF | PCF in the VPLMN | +| W-5GAN | Wireline 5G Access Network | +| W-5GBAN | Wireline 5G BBF Access Network | +| W-5GCAN | Wireline 5G Cable Access Network | +| W-AGF | Wireline Access Gateway Function | + +## 4 Npcf\_PolicyAuthorization Service + +### 4.1 Service Description + +#### 4.1.1 Overview + +The Npcf\_PolicyAuthorization Service, as defined in 3GPP TS 23.502 [3] and in 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +The Npcf\_PolicyAuthorization service authorises a NF service consumer request and creates policies as requested by the authorised NF service consumer for the PDU session to which the AF session is bound to. This service also allows the NF service consumer to subscribe/unsubscribe to notifications on events (e.g. access type change, PLMN change, usage report, access network information report). + +#### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging control related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [7]. + +The only known NF service consumers of the Npcf\_PolicyAuthorization service are the Application Function (AF), the Network Exposure Function (NEF), the Time Sensitive Communication and Time Synchronization Function (TSCTSF) and the Policy Control Function for the UE (PCF for the UE). + +The Npcf\_PolicyAuthorization service is provided by the PCF and consumed by the AF, the NEF, the TSCTSF and, when the PCF for the PDU session and the PCF for the UE are different, the PCF for the UE, as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for the reference point representation model. + +![Figure 4.1.2-1: Npcf_PolicyAuthorization service Architecture, SBI representation. The diagram shows a top-level PCF box containing an Npcf service interface. Below it, a horizontal line represents the Service Based Interface (SBI). Four boxes (NEF, AF, PCF, and TSCTSF) are connected to this SBI line. The connection between the top PCF and the SBI is labeled Npcf_PolicyAuthorization.](8307f6b04df072c9332f9987e034272c_img.jpg) + +Figure 4.1.2-1: Npcf\_PolicyAuthorization service Architecture, SBI representation. The diagram shows a top-level PCF box containing an Npcf service interface. Below it, a horizontal line represents the Service Based Interface (SBI). Four boxes (NEF, AF, PCF, and TSCTSF) are connected to this SBI line. The connection between the top PCF and the SBI is labeled Npcf\_PolicyAuthorization. + +**Figure 4.1.2-1: Npcf\_PolicyAuthorization service Architecture, SBI representation** + +![Figure 4.1.2-2: Npcf_PolicyAuthorization service Architecture, reference point representation. The diagram shows a top-level PCF box connected to four boxes below (NEF, AF, PCF, and TSCTSF) via individual lines representing reference points. These lines are labeled N30, N5, N43, and N84 respectively.](33a8f3f01dfa8bce75d23017855a13c5_img.jpg) + +Figure 4.1.2-2: Npcf\_PolicyAuthorization service Architecture, reference point representation. The diagram shows a top-level PCF box connected to four boxes below (NEF, AF, PCF, and TSCTSF) via individual lines representing reference points. These lines are labeled N30, N5, N43, and N84 respectively. + +**Figure 4.1.2-2: Npcf\_PolicyAuthorization service Architecture, reference point representation** + +NOTE: When the N43 reference point exists, i.e. when the PCF is a NF service consumer of the Npcf\_PolicyAuthorization service, the PCF for the UE interacts with the PCF for the PDU session. + +The AF trusted by the operator interacts with the PCF via the N5 reference point. In the case of an untrusted AF, the AF interacts with the PCF via the NEF. The NEF interacts with the PCF via the N30 reference point in the same way that the AF interacts with the PCF via the N5 reference point. + +## 4.1.3 Network Functions + +### 4.1.3.1 Policy Control Function (PCF) + +The PCF (Policy Control Function) performs policy and charging control for the PDU session and/or the flows indicated by the NF service consumer and according to the service requirements provided by the NF service consumer. + +The policy and charging control for service data flows enable the PCF to provide network control regarding the service data flow detection, gating, QoS and flow based charging (except credit management) towards the SMF/UPF. + +The PCF receives session and media related information from the Npcf\_PolicyAuthorization service consumers and notifies them of subscribed traffic plane events. + +The PCF may receive from the NF service consumers the request to monitor the requested service and media information and notifies them of the UL/DL/round-trip delay, and congestion information of the requested flows. + +The PCF may receive service routing requirements and the indication of receiving notifications about user plane path changes from the Npcf\_PolicyAuthorization service consumers. + +The PCF may receive from the NF service consumers the specific required QoS and a prioritized list of alternative QoS profiles and notifies them about the QoS target the access network guarantees. + +The PCF checks that the service information provided by the NF service consumer is consistent with the operator defined policy rules before storing the service information. + +The PCF uses the received service information and the subscription information when it applies as basis for the policy and charging control decisions. + +The PCF derives PCC rules and provisions them to the SMF via the Npcf\_SMPolicyControl service and subscribes to traffic plane events via policy control request triggers as described in 3GPP TS 29.512 [8]. + +To enable Time Sensitive Communication, Time Synchronization and Deterministic Networking, the PCF: + +- notifies the NF service consumer (i.e. TSN AF or TSCTSF) about the TSC user plane node and port number corresponding to the device side of a PDU session; +- enables the NF service consumer (i.e. TSN AF or TSCTSF) configures/reads information from the TSC user plane node and ports by forwarding TSC user plane node management containers and port management containers to the SMF as described in 3GPP TS 29.512 [8]; +- notifies the NF service consumer (i.e. TSN AF or TSCTSF) about updated TSC user plane node configuration and port configuration information by forwarding TSC user plane node management containers and port management containers received from the SMF; and +- uses the received QoS and TSC assistance information to derive the policy information delivered in the PCC rule to the SMF as described in 3GPP TS 29.512 [8]. + +To enable PDU Set handling, the PCF may receive the PDU set related QoS from the NF service consumers to derive the policy information delivered in the PCC rule to the SMF as described in 3GPP TS 29.512 [8]. + +When the PCF for the UE is separated from the PCF for the PDU session, the PCF for the PDU session is responsible for notifying to the PCF for the UE about the URSP enforcement information received from the UE via the SMF as described in 3GPP TS 29.512 [8]. + +#### 4.1.3.2 NF Service Consumers + +The known NF service consumers are the AF, the NEF, the TSCTSF and the PCF (for a UE), as defined in 3GPP TS 23.502 [3]. + +The AF is an element offering control to applications that require the policy and charging control of traffic plane resources; specific user plane paths for the requested traffic, the monitoring of the required service QoS, and/or specific QoS and alternative QoS profiles. The AF uses the Npcf\_PolicyAuthorization service to provide service information to the PCF. + +In 5GS interworking with TSN networks, the TSN AF is an element offering to TSC control functions an interface to 5GS to forward TSC user plane node and port management configuration, and to set the QoS policy required to forward the TSC traffic making use of the 5GS traffic plane resources. + +The AFs can be deployed by the same operator offering the access services or can be provided by external third-party service provider. If the AF is not allowed by the operator to access directly the PCF, the AF uses the external exposure framework via NEF to interact with the PCF, as described in clause 5.20 of 3GPP TS 23.501 [2]. + +The Network Exposure Function (NEF) supports external exposure of capabilities of network functions. + +The AF trusted by the operator, the NEF or the DetNet controller can use the TSCTSF to interface with PCF to support time sensitive communication, time synchronization and deterministic networking. The TSCTSF is an element offering, to internal and/or external time sensitive AF (via NEF) and/or to the DetNet controller, control to handle from/towards the PCF the required TSC user plane node and port management configuration, and to set in the PCF the QoS policy required to forward TSC traffic. + +The PCF providing session management policy control for a UE (i.e. PCF for a PDU session) and the PCF providing UE policy control and/or access and mobility control for this same UE (i.e. PCF for a UE) may be different PCFs. When access and mobility policies depend on traffic plane events (as e.g. application detection control), or the URSP + +may be adjusted based on the report of URSP enforcement information, the PCF for a UE may act as an NF service consumer of the PCF for the PDU session by subscribing to the corresponding events. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Npcf\_PolicyAuthorization Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Npcf\_PolicyAuthorization Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| Npcf_PolicyAuthorization_Create | Determines and installs the policy according to the service information provided by an authorized NF service consumer. | NF service consumer (e.g. AF, NEF) | +| Npcf_PolicyAuthorization_Update | Determines and updates the policy according to the modified service information provided by an authorized NF service consumer. | NF service consumer (e.g. AF, NEF) | +| Npcf_PolicyAuthorization_Delete | Provides means to delete the application session context of the NF service consumer. | NF service consumer (e.g. AF, NEF) | +| Npcf_PolicyAuthorization_Notify | Notifies NF service consumers of the subscribed events. | PCF | +| Npcf_PolicyAuthorization_Subscribe | Allows NF service consumers to subscribe to the notifications of events. | NF service consumer (e.g. AF, NEF, PCF for a UE) | +| Npcf_PolicyAuthorization_Unsubscribe | Allows NF service consumers to unsubscribe from the notifications of events. | NF service consumer (e.g. AF, NEF, PCF for a UE) | + +NOTE 1: The NEF and the AF use the Npcf\_PolicyAuthorization service in the same way. + +NOTE 2: The PCF is the consumer when the PCF for the UE and the PCF for the PDU session are different in the Npcf\_PolicyAuthorization\_Notify/Subscribe/Unsubscribe operations. + +NOTE 3: The NWDAF and the DCCF can be NF service consumers of the Npcf\_PolicyAuthorization\_Notify/Subscribe/Unsubscribe operations to perform data collection for UEs. However, there is no data collected from the PCF by the NWDAF or the DCCF defined in this Release of the specification. + +### 4.2.2 Npcf\_PolicyAuthorization\_Create service operation + +#### 4.2.2.1 General + +The Npcf\_PolicyAuthorization\_Create service operation authorizes the request from the NF service consumer, and optionally communicates with Npcf\_SMPolicyControl service to determine and install the policy according to the information provided by the NF service consumer. + +The Npcf\_PolicyAuthorization\_Create service operation creates an application session context in the PCF. + +The following procedures using the Npcf\_PolicyAuthorization\_Create service operation are supported: + +- Initial provisioning of service information. +- Gate control. +- Initial Background Data Transfer policy indication. +- Initial provisioning of sponsored connectivity information. +- Subscription to Service Data Flow QoS notification control. +- Subscription to Service Data Flow Deactivation. + +- Initial provisioning of traffic routing information. +- Subscription to resources allocation outcome. +- Invocation of Multimedia Priority Services. +- Support of content versioning. +- Request of access network information. +- Initial provisioning of service information status. +- Provisioning of signalling flow information. +- Support of resource sharing. +- Indication of Emergency traffic. +- Invocation of MCPTT. +- Invocation of MCVideo. +- Priority sharing indication. +- Subscription to out of credit notification. +- Subscription to Service Data Flow QoS Monitoring information. +- Provisioning of TSCAI input information and TSC QoS related data. +- Provisioning of TSC user plane node management information and port management information. +- P-CSCF restoration enhancements. +- Support of CHEM feature. +- Support of FLUS feature. +- Subscription to EPS Fallback report. +- Subscription to TSC user plane node related events. +- Initial provisioning of required QoS information. +- Support of QoSHint feature. +- Subscription to reallocation of credit notification. +- Subscription to satellite backhaul category changes. +- Subscription to the report of extra UE addresses. +- Initial provisioning of Round-Trip latency requirements. +- Provisioning of multi-modal services. +- Provisioning of PDU Set QoS related data. +- Subscription to BAT offset notification. +- Subscription to Packet Delay Variation monitoring. +- Provisioning of the indication of ECN marking for L4S support. +- Subscription of Round-Trip delay monitoring requirements over two QoS flows. +- Provisioning of the QoS timing information. +- Initial provisioning of Periodicity information. + +#### 4.2.2.2 Initial provisioning of service information + +This procedure is used to set up an AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.2.2-1 illustrates the initial provisioning of service information. + +![Sequence diagram showing the initial provisioning of service information between an NF service consumer and a PCF. Step 1: The NF service consumer sends a POST request to the app-sessions resource on the PCF. Step 2: The PCF responds with a 201 Created status.](4cc7cdce3d498d8b0ba033a9be24ade5_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant PCF as PCF + Note right of NF: 1. POST « app-sessions » + NF->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF: Response + +``` + +Sequence diagram showing the initial provisioning of service information between an NF service consumer and a PCF. Step 1: The NF service consumer sends a POST request to the app-sessions resource on the PCF. Step 2: The PCF responds with a 201 Created status. + +**Figure 4.2.2.2-1: Initial provisioning of service information** + +When a new AF application session context is being established and media information for this application session context is available at the NF service consumer and the related media requires PCC control, the NF service consumer shall invoke the Npcf\_PolicyAuthorization\_Create service operation by sending the HTTP POST request to the resource URI representing the "Application Sessions" collection resource of the PCF, as shown in figure 4.2.2.2-1, step 1. + +The NF service consumer shall include in the "AppSessionContext" data type in the content of the HTTP POST request a partial representation of the "Individual Application Session Context" resource by providing the "AppSessionContextReqData" data type. The "Individual Application Session Context" resource and the "Events Subscription" sub-resource are created as described below. + +The NF service consumer shall provide in the body of the HTTP POST request: + +- for IP type PDU sessions, the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute; and +- for Ethernet type PDU sessions, the MAC address of the UE in the "ueMac" attribute. + +For Ethernet type PDU sessions, if the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported, the "ueMac" attribute containing the MAC address of the DS-TT port as received from the PCF during the reporting of TSC user plane node information as defined in clause 4.2.5.16. + +NOTE 1: The determination of the DS-TT port MAC address is specified in clause 5.28.2 of 3GPP TS 23.501 [2]. The DS-TT port MAC address is used as identifier of the PDU session related to the reported TSC user plane node information. + +For IP type PDU sessions, if the "TimeSensitiveCommunication" feature is supported, the "ueIpv4" or "ueIpv6" attribute containing the IPv4 or IPv6 address of the UE as received from the PCF during the reporting of user plane node information as defined in clause 4.2.5.16. + +NOTE 2: The IP address of the PDU session is used as identifier of the PDU session related to the reported TSC user plane node information. + +The NF service consumer shall provide the corresponding service information in the "medComponents" attribute, if available. The NF service consumer shall indicate to the PCF for each media component included within the "medComponents" attribute whether the media component service data flow(s) (IP or Ethernet) should be enabled or disabled with the "fStatus" attribute. The service data flow filters (IP or Ethernet) that identify the traffic of the media component, if available, shall be provided within the media subcomponent(s) elements included in the "medSubComps" attribute (one uplink and/or downlink service data flow filter per media subcomponent). If the "EnQosMon" feature is + +supported, the NF service consumer may include the attribute "evSubsc" in the "MediaSubComponent" data type for QoS monitoring for each media component. Either the "evSubsc" in "MediaSubComponent" data type or attribute "evSubsc" in "AppSessionContextReqData" data type may be provided to subscribe to notifications for a specific event. + +An IP flow description is based on the definition of the packet filter for an IP flow (direction, IP source and destination address, protocol, and source and destination port) as defined by "FlowDescription" data type, the type of service or traffic class as defined in the "tosTrCl" attribute and, when the feature "DetNet" is supported, the flow label and the IPsec SPI as defined in the "flowLabel" and "spi" attributes respectively. + +An Ethernet flow description is based on the definition of the packet filter for an Ethernet flow (direction, Ethertype, source and destination MAC address, vlan tags, IP flow description (when Ethertype is IP) and source and destination MAC address range) as specified by "EthFlowDescription" data type. + +If the "AuthorizationWithRequiredQoS" feature as defined in clause 5.8 is supported, the AF may provide within the MediaComponent data structure required QoS information as specified in clause 4.2.2.32. + +The AF may include the AF application identifier in the "afAppId" attribute into the body of the HTTP POST request in order to indicate the particular service that the AF session belongs to. + +The AF application identifier may be provided at both "AppSessionContextReqData" data type level, and "MediaComponent" data type level. When provided at both levels, the AF application identifier provided at "MediaComponent" data type level shall have precedence. + +The AF application identifier at the "AppSessionContextReqData" data type level may be used to trigger the PCF to indicate to the SMF/UPF to perform the application detection based on the operator's policy as defined in 3GPP TS 29.512 [8]. + +If the "IMS\_SBI" feature is supported, the NF service consumer may include the AF charging identifier in the "afChargId" attribute for charging correlation purposes. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported the NF service consumer may provide TSC information as specified in clauses 4.2.2.24 and 4.2.2.25. + +If the "MultiMedia" feature is supported, the NF service consumer may provide the multi-modal service identifier in the "multiModalId" attribute for multi-modal communication purpose in clause 4.2.2.37. + +If the "PDUSetHandling" feature is supported, the NF service consumer may provide PDU set related QoS information as specified in clauses 4.2.2.39. + +The NF service consumer may also include the "evSubsc" attribute of "EventsSubscReqData" data type to request the notification of certain user plane events. The NF service consumer shall include the events to subscribe to in the "events" attribute, and the notification URI where to address the Npcf\_PolicyAuthorization\_Notify service operation in the "notifUri" attribute. The events subscription is provisioned in the "Events Subscription" sub-resource. + +The AF shall also include the "notifUri" attribute in the "AppSessionContextReqData" data type to indicate the URI where the PCF can request to the AF the deletion of the "Individual Application Session Context" resource. + +If the PCF cannot successfully fulfil the received HTTP POST request due to the internal PCF error or due to the error in the HTTP POST request, the PCF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, when the PCF receives the HTTP POST request from the NF service consumer, the PCF shall apply session binding as described in 3GPP TS 29.513 [7]. To allow the PCF to identify the PDU session for which the HTTP POST request applies, the NF service consumer shall provide in the body of the HTTP POST request: + +- for IP type PDU session, either the "ueIpv4" attribute or "ueIpv6" attribute containing the IPv4 or the IPv6 address applicable to an IP flow or IP flows towards the UE; and +- for Ethernet type PDU session, the "ueMac" attribute containing the UE MAC address applicable to an Ethernet flow or Ethernet flows towards the UE. + +The NF service consumer may provide DNN in the "dnn" attribute, SUPI in the "supi" attribute, GPSI in the "gpsI" attribute, the S-NSSAI in the "sliceInfo" attribute if available for session binding. The NF service consumer may also provide the domain identity in the "ipDomain" attribute. + +- NOTE 3: The "ipDomain" attribute is helpful in the following scenario: Within a network slice, there are several separate IP address domains, with SMF/UPF(s) that allocate IPv4 IP addresses out of the same private address range to UE PDU sessions. The same IP address can thus be allocated to UE PDU sessions served by SMF/UPF(s) in different address domains. If one PCF controls several SMF/UPF(s) in different IP address domains, the UE IP address is thus not sufficient for the session binding. A NF service consumer can serve UEs in different IP address domains, either by having direct IP interfaces to those domains, or by having interconnections via NATs in the user plane between the UPF and the NF service consumer. If a NAT is used, the NF service consumer obtains the IP address allocated to the UE PDU session via application level signalling and supplies it for the session binding to the PCF in the "ueIpv4" attribute. The NF service consumer supplies an "ipDomain" attribute denoting the IP address domain behind the NAT in addition. The NF service consumer can derive the appropriate value from the source address (allocated by the NAT) of incoming user plane packets. The value provided in the "ipDomain" attribute is operator configurable. +- NOTE 4: The "sliceInfo" attribute is helpful in the scenario where multiple network slices are deployed in the same DNN, and the same IPv4 address may be allocated to UE PDU sessions in different network slices. If one PCF controls several network slices, the UE IP address is not sufficient for the session binding. The NF service consumer supplies "sliceInfo" attribute denoting the network slice that allocated the IPv4 address of the UE PDU session. How the NF service consumer derives S-NSSAI is out of the scope of this specification. +- NOTE 5: When the scenario described in NOTE 3 applies and the NF service consumer is a P-CSCF it is assumed that the P-CSCF has direct IP interfaces to the different IP address domains and that no NAT is located between the UPF and P-CSCF. How a non-IMS NF service consumer obtains the UE private IP address to be provided to the PCF is out of scope of the present release; it is unspecified how to support applications that use a protocol that does not retain the original UE's private IP address. +- NOTE 6: As described in 3GPP TS 29.513 [7], in order to have a successful session binding, all attributes must match, if provided. + +If the PCF fails in executing session binding, the PCF shall reject the Npcf\_PolicyAuthorization\_Create service operation with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "PDU\_SESSION\_NOT\_AVAILABLE". + +If the request contains the "medComponents" attribute the PCF shall store the received service information. The PCF shall process the received service information according to the operator policy and may decide whether the request is accepted or not. The PCF may take the priority information within the "resPrio" attribute into account when making this decision. + +If the service information provided in the body of the HTTP POST request is rejected (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for a UE is exceeded), the PCF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". + +If the PCF detects that a temporary network failure has occurred (e.g. the SGW has failed as defined in clause B.3.3.3 or B.3.4.9 of 3GPP TS 29.512 [8]) and the AF initiates an Npcf\_PolicyAuthorization\_Create service operation, the PCF shall reject the request with an HTTP "403 Forbidden" response including the "cause" attribute set to "TEMPORARY\_NETWORK\_FAILURE". + +If the service information provided in the HTTP POST request is rejected due to a temporary condition in the network (e.g. the NWDAF reported the network slice selected for the PDU session is congested), the PCF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The PCF may also provide a retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the PCF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [5] clause 5.2.2.2. + +If the service information is invalid or insufficient for the PCF to perform the requested action, e.g. invalid media type or invalid QoS reference, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "INVALID\_SERVICE\_INFORMATION". + +If the IP flow descriptions cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [20] are not observed, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "FILTER\_RESTRICTIONS". + +If the AF provided the same AF charging identifier for a new Individual Application Session Context that is already in use for the other ongoing Individual Application Session, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "DUPLICATED\_AF\_SESSION". + +NOTE 7: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8] and the authorized data rate for any of those cases in a slice is exceeded due to the bandwidth demands of the new service information, it is also possible to accept the request based on operator policies. In this case the derived PCC rule(s) belonging to the authorized GBR service data flows can include a different MBR and/or have a different charging than the one applicable if the data rate is not exceeded as specified in 3GPP TS 29.512 [8]. + +The PCF may additionally provide the acceptable bandwidth within the attribute "acceptableServInfo" included in the "ExtendedProblemDetails" data structure returned in the rejection response message. + +If the "SignalingPathValidation" feature is supported, and the "User-Agent" HTTP header field indicates that the NF type of the NF that originated the request is "NEF" or "AF", and the PCF detects that the TSCTSF is the NF type required for the request (e.g., the PCF triggered a notification about TSC user plane node information towards the TSCTSF as described in clause 4.2.15.16), the PCF shall reject the request with an HTTP "403 Forbidden" response including the "cause" attribute set to "INVALID\_SIGNALING\_PATH". When the NEF/AF receives this error from the PCF, the NEF/AF selects the TSCTSF for this request, as specified in 3GPP TS 29.522 [54]. + +To allow the PCF and SMF/UPF to perform PCC rule authorization and QoS flow binding for the described service data flows, the NF service consumer shall supply: + +- for IP type PDU session, both source and destination IP addresses and port numbers in the "fDescs" attribute within the "medSubComps" attribute, if such information is available; and +- for Ethernet type PDU session, the Ethernet Packet filters in the "ethfDescs" attribute within the "medSubComps" attribute, if such information is available. + +The NF service consumer may specify the ToS traffic class (i.e. ToS (IPv4) or TC (IPv6) value) within the "tosTrCl" attribute for the described service data flows together with the "fDescs" attribute. + +NOTE 8: : A ToS/TC value can be useful when another packet filter attribute is needed to differentiate between packet flows. For example, packet flows encapsulated and encrypted by a tunnelling protocol can be differentiated by the ToS/TC value of the outer header if appropriately set by the application. To use ToS/TC for service data flow detection, network configuration needs to ensure there is no ToS/TC re-marking applied along the path from the application to the PSA UPF and the specific ToS/TC values are managed properly to avoid potential collision with other usage (e.g., paging policy differentiation). + +The NF service consumer may include the "resPrio" attribute at the "AppSessionContextReqData" data type level to assign a priority to the AF Session as well as include the "resPrio" attribute at the "MediaComponent" data type level to assign a priority to the service data flow. The presence of the "resPrio" attribute in both levels does not constitute a conflict as they each represent different types of priority. The reservation priority at the "AppSessionContextReqData" data type level provides the relative priority for an AF session while the reservation priority at the "MediaComponent" data type level provides the relative priority for a service data flow within a session. If the "resPrio" attribute is not specified, the requested priority is `PRIO_1`. + +The PCF shall check whether the received service information requires PCC rules to be created and provisioned as specified in 3GPP TS 29.513 [7]. Provisioning of PCC rules to the SMF shall be carried out as specified at 3GPP TS 29.512 [8]. + +Based on the received subscription information from the NF service consumer, the PCF may create a subscription to event notifications for a related PDU session from the SMF, as described in 3GPP TS 29.512 [8]. + +If the PCF created an "Individual Application Session Context" resource, the PCF shall send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 4.2.2.2-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field; and + +- an "AppSessionContext" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}". + +When "Events Subscription" sub-resource is created in this procedure, the NF service consumer shall build the sub-resource URI by adding the path segment "/events-subscription" at the end of the URI path received in the Location header field. + +The "AppSessionContext" data type the content shall contain the representation of the created "Individual Application Session Context" resource and may include the "Events Subscription" sub-resource. + +The PCF shall include in the "evsNotif" attribute: + +- if the NF service consumer subscribed to the event "PLMN\_CHG" in the HTTP POST request, the "event" attribute set to "PLMN\_CHG" and the "plmnId" attribute including the PLMN Identifier or the SNPN Identifier if the PCF has previously requested to be updated with this information in the SMF; + +NOTE 9: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 10: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- if the NF service consumer subscribed to the event "ACCESS\_TYPE\_CHANGE" in the HTTP POST request, the "event" attribute set to "ACCESS\_TYPE\_CHANGE" and: + - i. the "accessType" attribute including the access type, and the "ratType" attribute including the RAT type when applicable for the notified access type; and + - ii. if the "ATSSS" feature is supported, the "addAccessInfo" attribute with the additional access type information if available, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; and + +NOTE 11: For a MA PDU session, if the "ATSSS" feature is not supported by the NF service consumer the PCF includes the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type (if applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +- iii. the "anGwAddr" attribute including access network gateway address when available, if the PCF has previously requested to be updated with this information in the SMF; and + +- if the "IMS\_SBI" feature is supported and if the NF service consumer subscribed to the "CHARGING\_CORRELATION" event in the HTTP POST request, the "event" attribute set to "CHARGING\_CORRELATION" and may include the "anChargIds" attribute containing the access network charging identifier(s) and the "anChargAddr" attribute containing the access network charging address. + +The NF service consumer subscription to other specific events using the Npcf\_PolicyAuthorization\_Create request is described in the related clauses. Notification of events when the applicable information is not available in the PCF when receiving the Npcf\_PolicyAuthorization\_Create request is described in clause 4.2.5. + +The acknowledgement towards the NF service consumer should take place before or in parallel with any required PCC rule provisioning towards the SMF. + +NOTE 12: The behaviour when the NF service consumer does not receive the HTTP response message, or when it arrives after the internal timer waiting for it has expired, or when it arrives with an indication different than a success indication, are outside the scope of this specification and based on operator policy. + +#### 4.2.2.3 Gate control + +This procedure is used by an NF service consumer to instruct the PCF about when the service data flow(s) are to be enabled or disabled for a PDU session. + +The AF shall include in the HTTP POST request message described in subclause 4.2.2.2 the "fStatus" attribute for the flows to be enabled or disabled within the "medComponents" or "medSubComps" attributes. + +If a "medSubComps" attribute contains a "flowUsage" attribute with the value "RTCP", then the IP Flows described by that media subcomponent shall be enabled in both directions irrespective of the value of the "fStatus" attribute of the corresponding media component. + +As result of this action, the PCF shall set the appropriate gate status for the corresponding active PCC rule(s). + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +#### 4.2.2.4 Initial Background Data Transfer policy indication + +This procedure is used by a NF service consumer to indicate a transfer policy negotiated for background data transfer using the Npcf\_BDTPolicyControl service as described in 3GPP TS 29.554 [14]. + +The NF service consumer may include in the HTTP POST request message described in clause 4.2.2.2 a reference identifier related to a transfer policy negotiated for background data transfer in the "bdtRefId" attribute. + +NOTE 1: The PCF will retrieve the corresponding transfer policy from the UDR based on the reference identifier within the "bdtRefId" attribute. In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +If the PCF cannot retrieve the transfer policy, the PCF shall set to TP\_NOT\_UNKNOWN the "servAuthInfo" attribute in the HTTP response message to the NF service consumer to indicate that the transfer policy is unknown. + +If the time window of the received transfer policy has expired, the PCF shall set to TP\_EXPIRED the "servAuthInfo" attribute in the HTTP response message to indicate to the NF service consumer that the transfer policy has expired. Otherwise, if the time window of the received transfer policy has not yet occurred, the PCF shall set to TP\_NOT\_YET\_OCCURRED the "servAuthInfo" attribute in the HTTP response message to the NF service consumer to indicate that the time window of the transfer policy has not yet occurred. + +NOTE 2: In the case that the PCF cannot retrieve the transfer policy, the transfer policy time window has not yet occurred or the transfer policy expired, the PCF makes the decision without considering the transfer policy. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +#### 4.2.2.5 Initial provisioning of sponsored connectivity information + +This procedure is used by a NF service consumer to indicate sponsored data connectivity when "SponsoredConnectivity" feature is supported. + +The NF service consumer shall provide in the "AppSessionContext" data type of the HTTP POST request message described in clause 4.2.2.2 an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute within the "ascReqData" attribute. Additionally, the NF service consumer may provide an indication to the PCF of sponsored data connectivity not enabled by including the "sponStatus" attribute set to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may subscribe with the PCF to the notification of usage threshold reached. The NF service consumer shall include: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with the "event" attribute set to "USAGE\_REPORT"; and +- the "usgThres" attribute of "UsageThreshold" data type in the "EventsSubscReqData" data type with: + - a) the total volume in the "totalVolume" attribute; or + - b) the uplink volume only in the "uplinkVolume" attribute; or + - c) the downlink volume only in the "downlinkVolume"; and/or + - d) the time in the "duration" attribute. + +NOTE 1: If the NF service consumer is in the user plane, the AF can handle the usage monitoring and therefore it is not required to provide a usage threshold to the PCF as part of the sponsored connectivity functionality. + +When the NF service consumer indicated to enable sponsored data connectivity, and the UE is roaming in a VPLMN, the following procedures apply: + +- If the NF service consumer is located in the HPLMN, for home routed roaming case and when the operator policies do not allow accessing the sponsored data connectivity with this roaming case, the H-PCF shall reject the service request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". +- If the NF service consumer is located in the VPLMN, the V-PCF shall reject the service request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". + +When the NF service consumer indicated to enable sponsored data connectivity, and the UE is non-roaming or roaming with the home routed case and the operator policies allow accessing the sponsored data connectivity with this roaming case, the following procedures apply: + +- If the SMF does not support sponsored connectivity and the required reporting level for that service indicates a sponsored connectivity level according to 3GPP TS 29.512 [8], then the PCF shall reject the request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". +- If the SMF supports sponsored data connectivity feature or the required reporting level is different from sponsored connectivity level as described in 3GPP TS 29.512 [8], then the PCF, based on operator policies, shall check whether it is required to validate the sponsored connectivity data. If it is required, it shall perform the authorizations based on sponsored data connectivity profiles. If the authorization fails, the PCF shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". + +NOTE 2: The PCF is not required to verify that a trust relationship exists between the operator and the sponsors. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +#### 4.2.2.6 Subscriptions to Service Data Flow QoS notification control + +The subscription to Service Data Flow QoS notification control is used by a NF service consumer to subscribe to receive a notification when the GBR QoS targets for one or more service data flows can no longer (or can again) be guaranteed. + +NOTE: It may happen that the GBR QoS targets for one or more PCC rules (i.e. Service Data Flows) cannot be guaranteed, either permanently or temporarily in the radio access network. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "events" attribute with the "event" attribute set to "QOS\_NOTIF". + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +As result of this action, the PCF shall set the appropriate subscription to QoS notification control for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.7 Subscription to Service Data Flow Deactivation + +This procedure is used by NF service consumer to subscribe to the notification of deactivation of one or more Service Data Flows within the AF application session context. + +NOTE: It may happen that one or more PCC rules (i.e. Service Data Flows) are deactivated at the SMF at certain time, either permanently or temporarily, due to e.g. release of resources or out of credit condition. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "events" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +As result of this action, the PCF shall set the appropriate subscription to service data flow deactivation for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.8 Initial provisioning of traffic routing and service function chaining information + +This procedure is used by a NF service consumer to: + +- influence SMF traffic routing decisions to a local access to a Data Network identified by a DNAI; and/or +- request subscriptions to notifications about UP path management events related to the PDU session, + +when "InfluenceOnTrafficRouting" feature is supported; and/or + +- influence the steering of user traffic to service function chain(s) on N6-LAN, + +when "SFC" feature is supported. + +NOTE 1: The NF service consumer uses the Npcf\_PolicyAuthorization service for requests targeting specific ongoing PDU sessions of individual UE(s). The NF service consumer requests that target existing or future PDU Sessions of multiple UE(s) or any UE are sent via the NEF and may target multiple PCF(s), as described in 3GPP TS 29.513 [7]. + +When the "CommonEASDNAI" feature is supported, the procedure is also used by a NF service consumer to request to select a common EAS or EAS(es) corresponding to a common DNAI for a set of UE associated with the same traffic correlation Id accessing the application identified by the provided service information. + +NOTE 2: Common EAS selection means the common DNAI is selected. + +In order to influence on traffic routing, the NF service consumer shall include in the HTTP POST request message described in clause 4.2.2.2 the "afRoutReq" attribute of "AfRoutingRequirement" data type with specific routing requirements for the application traffic flows either within "AppSessionContextReqData" data type for the service indicated in the "afAppId" attribute, or within the "medComponents" attribute. When provided at both levels, the "afRoutReq" attribute value in the "medComponents" attribute shall have precedence over the "afRoutReq" attribute included in the "AppSessionContextReqData" data type. + +In order to influence on N6-LAN traffic steering, the NF service consumer shall include in the HTTP POST request message described in clause 4.2.2.2 the "afSfcReq" attribute of "AfSfcRequirement" data type with specific N6-LAN traffic steering requirements for the application traffic flows either within "AppSessionContextReqData" data type for the service indicated in the "afAppId" attribute, or within the "medComponents" attribute. When provided at both levels, the "afSfcReq" attribute value in the "medComponents" attribute shall have precedence over the "afSfcReq" attribute included in the "AppSessionContextReqData" data type. + +The NF service consumer may include traffic routing and N6-LAN traffic steering requirements together with service information. + +The NF service consumer may request to influence on N6-LAN traffic steering and/or to influence SMF traffic routing decisions to a DNAI. + +If "SFC" feature is supported, when the NF service consumer requests to influence N6-LAN traffic steering, it shall include in the "afSfcReq" attribute: + +- a) The pre-defined Service Function Chain identifier for downlink in "sfcIdDI" and/or for uplink in "sfcIdUI". + +In that case, the NF service consumer may include in the "afSfcReq" attribute: + +- a) Spatial validity during which the NF service consumer request is valid shall be indicated in terms of validity areas encoded in the "spVal" attribute of "SpatialValidity" data type. The "SpatialValidity" data type consists of a list of presence areas included in the "presenceInfoList" attribute, where each element shall include the presence reporting area identifier in the "pralD" attribute and may include the elements composing a presence area encoded in the attributes: "trackingAreaList", "ecgList", "ncgList", "globalRanNodeIdList". +- b) Metadata to be transparently sent to the SMF as defined in 3GPP TS 29.512[8]. + +If "InfluenceOnTrafficRouting" feature is supported, when the NF service consumer request to influence on traffic routing, the NF service consumer shall include in the "afRoutReq" attribute: + +- a) A list of routes to locations of applications in the "routeToLocs" attribute. Each element of the list shall contain: + - a DNAI in the "dnai" attribute to indicate the location of the application towards which the traffic routing is applied; and + - a routing profile identifier in the "routeProfId" attribute, and/or the explicit routing information in the "routeInfo" attribute. + +In this case, the NF service consumer may include in the "afRoutReq" attribute: + +- a) Indication of application relocation possibility in the "appReloc" attribute. + - b) Temporal validity during which the NF service consumer request is valid shall be indicated with the "startTime" and "stopTime" attributes. + - c) Spatial validity during which the NF service consumer request is valid shall be indicated in terms of validity areas encoded in the "spVal" attribute of "SpatialValidity" data type. The "SpatialValidity" data type consists of a list of presence areas included in the "presenceInfoList" attribute, where each element shall include the presence reporting area identifier in the "praId" attribute and may include the elements composing a presence area encoded in the attributes: "trackingAreaList", "ecgList", "ncgList", "globalRanNodeIdList". + - d) Indication of UE IP address preservation in the "addrPreserInd" attribute if the URLLC feature is supported. + - e) If the SimultConnectivity feature is supported: + - indication of simultaneous connectivity temporarily maintained in the source and target PSA during the edge re-location procedure in the "simConnInd" attribute; and + - if the "simConnInd" attribute is set to true, the minimum time interval to be considered for inactivity of the traffic routed via the source PSA in the "simConnTerm" attribute. + - f) EAS IP replacement information in the "easIpReplaceInfos" attribute if the EASIPreplacement feature is supported. + - g) Indication of EAS rediscovery in the "easRedisInd" attribute if the EASDiscovery feature is supported. + - h) Maximum allowed user plane latency in the "maxAllowedUpLat" attribute if the AF\_latency feature is supported. +- NOTE 3: The EAS IP Replacement information and the information indicating the EAS rediscovery are not provided simultaneously. +- i) If the CommonEASDNAI feature is supported, traffic correlation information in the "tfcCorreInfo" attribute. + +When "InfluenceOnTrafficRouting" feature is supported, the NF service consumer may also subscribe to notifications about UP path management events. The NF service consumer shall include in the "upPathChgSub" attribute: + +- notifications of early and/or late DNAI change, using the attribute "dnaiChgType" indicating whether the subscription is for "EARLY", "LATE" or "EARLY\_LATE"; +- the notification URI where the NF service consumer is receiving the Nsmf\_EventExposure\_Notify service operation in the "notificationUri" attribute; and +- the notification correlation identifier assigned by the NF service consumer in the "notifCorreId" attribute. + +When the NF service consumer subscribes to notifications about UP path management events, it may include the "3gpp-Sbi-Consumer-Info" custom HTTP header as described in clause 6.6.2 of 3GPP TS 29.500 [5] to indicate the features supported by the NF service consumer over the Nsmf\_EventExposure service related to UP path management event handling as described in 3GPP TS 29.508[13]. + +If the URLLC feature is supported, the NF service consumer may include an indication of NF service consumer acknowledgement to be expected as an "afAckInd" attribute within the "upPathChgSub" attribute. + +When the feature "RoutingReqOutcome" is supported: + +- the PCF may set the "servAuthInfo" attribute in the HTTP response message to "ROUT\_REQ\_NOT\_AUTHORIZED" when the PCF determines, e.g. based on subscription, the AF influence on traffic routing is not allowed for the PDU session; +- when the NF service consumer requests the steering of traffic to a DNAI and/or the subscription to notifications about UP path management events, the NF service consumer may subscribe to notifications of failures in the enforcement of UP path changes including within the "evSubsc" attribute the "event" attribute value "UP\_PATH\_CHG\_FAILURE" in an entry of the "events" array. + +NOTE 4: In the case that the PCF determines that the requested AF routing requirements cannot be applied and returns the "servAuthInfo" attribute in the HTTP response, the PCF makes the decision without considering the requested AF routing requirements. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +The PCF shall store the routing requirements included in the "afRoutReq" attribute and/or in the N6-LAN traffic steering requirements "afSfcReq" attribute. + +The PCF shall check whether the received routing requirements and/or N6-LAN traffic steering requirements require PCC rules to be created or provisioned to include or modify traffic steering policies (for both routing requirements and/or N6-LAN traffic steering requirements) and the application relocation possibility (only for routing requirements) as specified in 3GPP TS 29.513 [7]. Provisioning of PCC rules to the SMF shall be carried out as specified in 3GPP TS 29.512 [8]. + +NOTE 5: The NF service consumer receives the notification about UP path management events by the Nsmf\_EventExposure\_Notify service operation as defined in clause 4.2.2.2 of 3GPP TS 29.508 [13]. + +#### 4.2.2.9 Void + +#### 4.2.2.10 Subscription to resources allocation outcome + +This procedure is used by a NF service consumer to subscribe to notifications when the resources associated to the corresponding service information have been allocated and/or cannot be allocated. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message: + +- if the NF service consumer requests the PCF to provide a notification when the resources associated to the service information have been allocated, an event entry within the "events" attribute with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION"; +- if the NF service consumer requests the PCF to provide a notification when the resources associated to the service information cannot be allocated, an event entry within the "events" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION"; and/or +- if the feature "UEUnreachable" is supported and the NF service consumer request the PCF to provide a notification when the resources associated to the service information are not allocated because the UE is unreachable, an event entry within the "events" attribute with the "event" attribute set to "UE\_TEMPORARILY\_UNAVAILABLE". + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +As a result of this action, the PCF shall set the appropriate subscription to notification of resources allocation outcome for the corresponding PCC Rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.11 Void + +## 4.2.2.12 Invocation of Multimedia Priority Services + +### 4.2.2.12.1 General + +This procedure allows a NF service consumer, as per 3GPP TS 22.153 [23], to request prioritized access to system resources in situations such as during congestion. + +The NF service consumer may include the "mpsId" attribute to indicate that the new AF session relates to an MPS session. + +The "mpsId" attribute shall contain the national variant for the MPS service name indicating an MPS session. The "resPrio" attribute shall include the priority value of the related priority service. + +If the NF service consumer supports the SBI Message Priority mechanism for an MPS session, it shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 6.8.2 of 3GPP TS 29.500 [5]. + +NOTE 1: If the NF service consumer supports the SBI Message Priority mechanism for an MPS session, the NF service consumer will include the "3gpp-Sbi-Message-Priority" custom HTTP header with a priority value equivalent to the value of the "resPrio" attribute. Highest user priority value is mapped in the corresponding lowest value of the "3gpp-Sbi-Message-Priority" custom HTTP header. + +When the PCF receives the "mpsId" attribute indicating an MPS session, the PCF shall take specific actions on the corresponding PDU session to ensure that the MPS session is prioritized as specified in 3GPP TS 29.512 [8]. + +NOTE 2: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +### 4.2.2.12.2 MPS for DTS + +MPS for DTS is the means for an NF service consumer to invoke/revoke the Priority PDU connectivity service for the default QoS flow only, i.e. without designating a particular service data flow for priority service. MPS for DTS applies only to non-IMS DNNs. + +When the "MPSforDTS" feature is supported, to invoke MPS for DTS, the NF service consumer includes the "mpsAction" attribute, set to "ENABLE\_MPS\_FOR\_DTS" or "AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS". These "mpsAction" attribute values signal a QoS change to the default QoS flow and service data flows mapped to the default QoS flow without the creation of a new QoS flow. + +When the "ENABLE\_MPS\_FOR\_DTS" value is received, and allowed by local policy, the PCF does not check the user's MPS subscription details. When the "AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS" value is received, and allowed by local policy, the PCF shall check the user's MPS subscription to authorize the request. When the request is to authorize and enable, and the request is not authorized (e.g. not allowed by MPS subscription), the PCF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". + +NOTE: How the NF service consumer checks the MPS for DTS authorization is out of scope of the present document. + +When creating an Individual Application Session Context resource, due to the invocation or revocation of MPS for DTS, the NF service consumer may subscribe to the outcome of the default QoS updates by setting within the "evSubsc" attribute an event in the "events" array with: + +- the "event" attribute set to the value "SUCCESSFUL\_QOS\_UPDATE" to report that the invocation/revocation requested by the NF service consumer was successful; and/or +- the "event" attribute set to the value "FAILED\_QOS\_UPDATE" to report that the invocation/revocation requested by the NF service consumer has failed to be successful. + +The NF service consumer may use the procedure specified in clause 4.2.2.12.3 to open a new priority PDU session related to the AF signalling IP flow between the UE and NF service consumer. + +#### 4.2.2.12.3 Provisioning of MPS for DTS signalling flow information + +This clause is applicable to provisioning of signalling flow information for MPS for DTS if the MPSforDTS feature is supported as described in clause 5.8. + +This procedure allows the NF service consumer to provision information about the AF signalling IP flows between the UE and the NF service consumer. + +The NF service consumer shall provide: + +- the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute; +- when the "AuthorizationForMpsSignalling" feature is supported, the "mpsAction" attribute set to "AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_AF\_SIGNALLING"; +- the "mpsId" attribute; and +- a media component within the "medComponents" attribute including: + - the "medCompN" attribute set to "0"; and + - the media subcomponent within the "medSubComps" attribute representing the AF signalling IP flow, where the media subcomponent shall contain: + - the "flowUsage" attribute set to the value "AF\_SIGNALLING"; + - the "fNum" attribute set according to the rules described in Annex C; + - the "fDesc" attribute containing the IP flows of the AF signalling flow; and + - the "fStatus" set to the value "ENABLED". + +The PCF shall determine whether the request is accepted or not. If accepted, the PCF shall perform session binding and shall reply to the NF service consumer as described in clause 4.2.2.2. If rejected, the PCF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". + +The PCF shall set appropriate QoS values for the AF signalling IP flow and shall install the corresponding dynamic PCC rule for the AF signalling IP flows. + +The NF service consumer may de-provision the information about the AF signalling IP flows at any time. To do that, if the "Individual Application Session Context" resource is only used to provide information about the AF Signalling IP flows, the NF service consumer shall remove the resource by sending an Npcf\_PolicyAuthorization\_Delete service operation towards the PCF as defined in clause 4.2.4.2. Otherwise, the NF service consumer shall remove the IP flow within the media component invoking the Npcf\_PolicyAuthorization\_Update service operation as defined in clause 4.2.3.17. + +NOTE: Combining the request for the AF signalling flow with an MPS for DTS invocation/revocation request is not supported in this release. + +#### 4.2.2.13 Support of content versioning + +The support of the media component versioning is optional. When the "MediaComponentVersioning" feature is supported, the NF service consumer and the PCF shall comply with the procedures specified in this clause. + +If required by operator policies, the NF service consumer shall assign a content version to the media component related to certain service and shall provide assigned content version to the PCF in the "contVer" attribute included in the corresponding media component entry of the "medComponents" attribute. + +If the PCF receives the "contVer" attribute for a certain media component, the PCF shall follow the procedures described in 3GPP TS 29.512 [8], clause 4.2.6.2.14. + +#### 4.2.2.14 Request of access network information + +This procedure is used by a NF service consumer to request the PCF to report the access network information (i.e. user location and/or user timezone information) at the creation of the "Individual Application Session Context" resource, when the "NetLoc" feature is supported. + +The NF service consumer shall include in the HTTP POST request message described in clause 4.2.2.2: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +When the PCF determines that the access network does not support the access network information reporting because the SMF does not support the NetLoc feature, the PCF shall respond to the NF service consumer including in the "EventsNotification" data type the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED" value. Otherwise, the PCF shall immediately configure the SMF to provide such access information, as specified in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +#### 4.2.2.15 Initial provisioning of service information status + +When the "IMS\_SBI" feature is supported, the NF service consumer may provide the status of the service information. + +If the NF service consumer provides service information that has been fully negotiated (e.g. based on the SDP answer), the NF service consumer may include the "servInfStatus" attribute set to "FINAL". In this case the PCF shall authorize the session and provision the corresponding PCC rules to the SMF. + +The NF service consumer may additionally provide preliminary service information not fully negotiated yet (e.g. based on the SDP offer) at an earlier stage. To do so, the NF service consumer shall include the "servInfStatus" attribute set to "PRELIMINARY". Upon receipt of such preliminary service information, the PCF shall perform an early authorization check of the service information. If the NF service consumer requests the PCF to report the access network information together with preliminary service information, the PCF shall immediately configure the SMF to provide the access network information. + +#### 4.2.2.16 Provisioning of signalling flow information + +This clause is applicable when IMS restoration is supported according to the supported feature "ProvAFsignalFlow" as described in clause 5.8. + +This procedure allows NF service consumer to provision information about the AF signalling IP flows between the UE and the NF service consumer. + +The NF service consumer shall provide: + +- the IP address (IPv4 or IPv6) of the UE in the "ueIPv4" or "ueIPv6" attribute; and +- a media component within the "medComponents" attribute including: + - the "medCompN" attribute set to "0"; and + - one or more media subcomponents within the "medSubComps" attribute representing the AF signalling IP flows, where each media subcomponent shall contain: + - the "flowUsage" attribute set to the value "AF\_SIGNALLING"; + - the "fNum" attribute set according to the rules described in Annex C; + - the "fDesc" attribute containing the IP flows of the AF signalling flow; + +- the "fStatus" set to the value "ENABLED"; and +- the "afSigProtocol" set to the value corresponding to the signalling protocol used between the UE and the NF service consumer. + +The PCF shall perform session binding and shall reply to the NF service consumer as described in clause 4.2.2.2. + +PCC rules related to the AF signalling IP flows could have been provisioned to SMF using the corresponding procedures specified in 3GPP TS 29.512 [8] at an earlier stage (e.g. typically at the establishment of the QoS flow for AF Signalling IP Flows). The PCF shall install the corresponding dynamic PCC rule for the AF signalling IP flows. + +The NF service consumer may de-provision the information about the AF signalling IP flows at any time. To do that, if the "Individual Application Session Context" resource is only used to provide information about the AF Signalling IP flows, the NF service consumer shall remove the resource by sending an Npcf\_PolicyAuthorization\_Delete service operation as service operation towards the PCF as defined in clause 4.2.4.2. Otherwise, the NF service consumer shall remove the IP flows within the media component invoking the Npcf\_PolicyAuthorization\_Update service operation as defined in clause 4.2.3.17. + +#### 4.2.2.17 Support of resource sharing + +This procedure is used by a NF service consumer to indicate that a media component of an Individual Application Session Context resource may share resources with other media components in the related direction in other Individual Application Session Context resources when the "ResourceSharing" feature is supported. + +The NF service consumer may include the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute within a media component of the "medComponents" attribute to indicate that the related media of the created new Individual Application Session Context resource may share resources with other media components in the related direction that include the same value for the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +If the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute are provided within a media component of the "medComponents" attribute, the PCF may apply the mechanisms for resource sharing as described in 3GPP TS 29.512 [8], clause 4.2.6.2.8. + +#### 4.2.2.18 Indication of Emergency traffic + +When the "IMS\_SBI" feature is supported, this procedure allows a NF service consumer to indicate that the new AF session context relates to emergency traffic. + +The NF service consumer may include the "servUrn" attribute to indicate that the new AF session context relates to emergency traffic. Additionally, the NF service consumer may include the "afReqData" attribute to indicate the additional information requested for the AF session context. + +When the PCF receives the "servUrn" attribute indicating an emergency session, the PCF may apply special policies, for instance prioritising service flows relating to the new AF session context, allowing these service flows free of charge or exempting the service flows from the limitation of data rate per network slice when the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8]. + +If the "servUrn" attribute indicates that the new NF service consumer session context relates to emergency traffic and the "afReqData" attribute is received, the PCF shall reply to the NF service consumer as described in clause 4.2.2.2 and shall provide the requested available user information in the "ueIds" attribute included within the "ascRespData" attribute in the HTTP "201 Created" response. + +NOTE 1: The "supi" attribute within the "ueIds" attribute contains an IMSI, if available, when the UE accesses a PLMN and contains either an IMSI or a network-specific identifier that takes the form of an NAI, if available, when the UE accesses a SNPN. For both, PLMN access and SNPN access, the "gpsi" attribute within the "ueIds" attribute contains an MSISDN, if available, and the "pei" attribute contains an IMEI(SV). + +If the NF service consumer supports the SBI Message Priority mechanism for an emergency session, it shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 6.8.2 of 3GPP TS 29.500 [5]. + +NOTE 2: If the NF service consumer supports the SBI Message Priority mechanism for an emergency session, the NF service consumer includes the "3gpp-Sbi-Message-Priority" custom HTTP header based on NF service consumer policies in relation to valid values of the "servUrn" attribute. The highest user priority value is mapped to the corresponding lowest value of the "3gpp-Sbi-Message-Priority" custom HTTP header. + +When the new AF session context does not indicate emergency traffic and the session binding function detects that the binding is to a PDU session established to the Emergency DNN, the PCF shall reject the HTTP POST request and shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "UNAUTHORIZED\_NON\_EMERGENCY\_SESSION". + +#### 4.2.2.19 Invocation of MCPTT + +When the feature "MCPTT" is supported by the NF service consumer and the PCF, this procedure allows a NF service consumer to request prioritized access to system resources in situations such as an MCPTT session with priority call. + +The NF service consumer may include the "mcpttId" attribute to indicate that the new "Individual Application Session Context" resource relates to an MCPTT session with priority call. + +When the PCF receives the "mcpttId" attribute indicating an MCPTT session and the "resPrio" attribute, the PCF shall take specific actions on the corresponding PDU session to ensure that the MCPTT session is prioritized as specified in 3GPP TS 29.512 [8]. + +NOTE: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +Additionally, when the "PrioritySharing" feature is supported, the PCF may receive the "prioSharingInd" attribute within the media component received in the "medComponents" attribute as described in clause 4.2.2.21. In this case, and if "MCPTT-Preemption" feature is supported, the PCF may receive pre-emption information as also described in clause 4.2.2.21. + +For the handling of MCPTT session with priority call, see Annex B.13 + +#### 4.2.2.20 Invocation of MCVideo + +When the feature "MCVideo" is supported by the NF service consumer and the PCF, this procedure allows a NF service consumer to request prioritized access to system resources in situations such as an MCVideo session with priority call. + +The NF service consumer may include the "mcVideoId" attribute to indicate that the new "Individual Application Session Context" resource relates to an MCVideo session with priority call. + +When the PCF receives the "mcVideoId" attribute indicating an MCVideo session and the "resPrio" attribute, the PCF shall take specific actions on the corresponding PDU session to ensure that the MCVideo session is prioritized as specified in 3GPP TS 29.512 [8]. + +NOTE: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +For the handling of MCVideo session with priority call, see Annex B.15. + +#### 4.2.2.21 Priority sharing indication + +When the "PrioritySharing" feature is supported, the NF service consumer may indicate to the PCF that the related media flow is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other "Individual Application Session Context" resources. + +The NF service consumer may include the "prioSharingInd" attribute set to "ENABLED" within a media component of the "medComponents" attribute to indicate to the PCF that the related media flow is allowed to use the same Allocation and Retention Priority as media flows which: + +- are assigned the same 5QI in the PCF; and +- belong to other "Individual Application Session Context" resources bound to the same PDU session that also contain the "prioSharingInd" attribute set to "ENABLED". + +If the "MCPTT-Preemption" feature is supported, the NF service consumer may also include: + +- within a media component of the "medComponents" attribute, the "preemptCap" attribute containing the suggested pre-emption capability value and the "preemptVuln" attribute containing the suggested pre-emption vulnerability value, for the PCF to determine ARP values; +- within the "ascReqData" attribute in the request body, the "preemptControlInfo" attribute containing the pre-emption control information for the PCF to perform pre-emption control as described in 3GPP TS 29.512 [8], clause 4.2.6.2.9; and +- within the "evSubsc" attribute, the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION" to request the notification for resource allocation failure. + +Upon reception of this information, the PCF shall behave as described in 3GPP TS 29.512 [8], clause 4.2.6.2.9. For the handling of MCPTT sessions, see Annex B.10. + +NOTE 1: Service data flow deactivation procedures will apply according to clauses 4.2.2.7, 4.2.3.7, 4.2.5.5. + +NOTE 2: This enhancement avoids the risk that a QoS flow establishment request is rejected if the maximum number of active QoS flows is exceeded. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +#### 4.2.2.22 Subscription to Out of Credit notification + +This procedure is used by the NF service consumer if the "IMS\_SBI" feature is supported to subscribe to notifications of credit not available for the Service Data Flows within the AF application session context. + +NOTE: It can happen that there are one or more PCC rules (i.e. Service Data Flows) with credit not available, each one with their corresponding termination action (terminate, redirect, access restricted). + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to the value "OUT\_OF\_CREDIT". + +As result of this action, the PCF shall set the appropriate subscription to out of credit notification for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +#### 4.2.2.23 Subscriptions to Service Data Flow QoS Monitoring Information + +The subscription to Service Data Flow QoS monitoring information is used by a NF service consumer to receive a notification about the real-time measurements of QoS parameters for a QoS Flow, e.g. packet delay between UPF and UE, when the "QoSMonitoring" feature is supported. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include: + +- the requested QoS monitoring parameter(s) to be measured (i.e. DL, UL and/or round trip packet delay, if the feature "XRM\_5G" is supported, , and/or the UL and/or DL data rate information) within the "reqQosMonParams" attribute; +- an entry of the "AfEventSubscription" data type per requested notification method in the "events" attribute with: + - a) the "event" attribute set to the value "QOS\_MONITORING"; and + +- b) the "notifMethod" attribute set to the value "EVENT\_DETECTION" or "PERIODIC"; and + - c) when the "notifMethod" attribute is set to the value "PERIODIC", the periodic time for reporting and, if the feature "PacketDelayFailureReport" or "EnQoSMon" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; and + - d) when the "notifMethod" attribute is set to the value "EVENT\_DETECTION", the minimum waiting time between subsequent reports within the "waitTime" attribute and, if the feature "PacketDelayFailureReport" or "EnQoSMon" is supported, the maximum period with no QoS measurement results reported within the "repPeriod" attribute; +- when the "notifMethod" attribute set to the value "EVENT\_DETECTION": +1. For QoS monitoring of packet delay, the "qosMon" attribute, with the required QoS Monitoring information: + - a) the delay threshold for downlink with the "repThreshDI" attribute; + - b) the delay threshold for uplink with the "repThreshUI" attribute; and/or + - c) the delay threshold for round trip with the "repThreshRp" attribute. + +When the feature "XRM\_5G" is supported, for QoS monitoring for congestion information, the "congestMon" attribute with: + +- a) the delay threshold for downlink with the "conThreshDI" attribute; and/or + - b) the delay threshold for uplink with the "conThreshUI" attribute. +2. When the feature "XRM\_5G" is supported, for QoS monitoring of data rate, the "qosMonDatRate" attribute with: + - a) the data rate threshold for downlink within the "repThreshDatRateDI" attribute; and/or + - b) the data rate threshold for the uplink within the "repThreshDatRateUI" attribute. + +**Editor's note:** Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +The NF service consumer may include in "EventsSubscReqData" data type the notification correlation identifier assigned by the AF within the "notifCorreId" attribute and, if the feature "ExposureToEAS" or "EnQoSMon" is supported, the "directNotifInd" attribute set to true to indicate direct event notification of QoS Monitoring data from the UPF. + +For data rate monitoring, the AF may include an averaging window within the "avrgWndw" attribute. + +The NF service consumer may include the "3gpp-Sbi-Consumer-Info" custom HTTP header as described in clause 6.6.2 of 3GPP TS 29.500 [5] to indicate the support of "QoSMonitoring" feature by the NF service consumer over the Nsmf\_EventExposure service as described in 3GPP TS 29.508[13]. + +The NF service consumer shall include more than one "AfEventSubscription" data type within the "EventsSubscReqData" data type if more than one notification method is required. + +The PCF shall reply to the AF as described in clause 4.2.2.2. + +If the AF provided an indication of direct event notification in the request and PCF determines that the direct notification of QoS Monitoring reports applies (i.e. the AF request does not include QoS parameter measurements that are derived by PCF), the PCF behaves as specified in 3GPP TS 29.512 [8]. + +If the AF provided an indication of direct event notification and PCF determines that the direct notification of QoS Monitoring reports does not apply (i.e. the AF request includes QoS parameter measurements that are derived by PCF as specified in clause 4.2.2.41 (AF request for monitoring packet delay variation), and clause 4.2.2.44 (AF request for monitoring round trip packet delay when UL and DL are on different service data flows)), the PCF generates a successful response to the AF and indicates that direct event notification is not possible by including within the "servAuthInfo" attribute the value "DIRECT\_NOTIF\_NOT\_POSSIBLE". In this case, the PCF shall not indicate direct notification in the QoS Monitoring policy provided to the SMF and instead subscribe to receive QoS Monitoring reports from SMF as specified in 3GPP TS 29.512 [8]. + +As result of this action, the PCF shall set the appropriate subscription to QoS Monitoring information for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +**Editor's note:** It is FFS whether new data type structure is needed for QoS monitoring control for multi-modal services. + +#### 4.2.2.24 Provisioning of TSCAI input Information and QoS related data + +If the "TimeSensitiveNetworking" feature is supported the NF service consumer (i.e. TSN AF or TSCTSF) may provide TSCAI input information within the TSC assistance container and QoS related data to the PCF by the Npcf\_PolicyAuthorization\_Create service operation to describe the TSC traffic pattern and QoS characteristics for use in the 5G System. + +The NF service consumer (i.e. TSN AF or TSCTSF) shall derive the TSCAI input information and the QoS related data for a given TSC stream or flow of aggregated TSC streams. The TSCTSF may determine the TSCAI input information and the related QoS data based on information provided by an AF/NEF, and may provide it for IP type and Ethernet type of PDU sessions as specified in clauses 4.15.6.6 and 4.15.6.6a of TS 23.502 [3]. In case of integration with IEEE TSN network, the TSN AF determines the TSCAI input information as defined in clause 5.27.2.2 of 3GPP TS 23.501 [2] and the QoS related data as defined in clause 5.28.4 of 3GPP TS 23.501 [2]. + +To indicate the TSCAI input information of a TSC stream or aggregated set of TSC streams, the NF service consumer (i.e. TSN AF or TSCTSF) may include for the uplink flow direction (ingress interface of the DS-TT/UE) in the "tscaiInputUI" attribute and/or for the downlink flow direction (ingress interface of the NW-TT) the "tscaiInputDI" attribute included in a media component entry of the "medComponents" attribute: + +- the time period between the start of two bursts of a TSC stream or aggregated TSC streams in reference to the external GM encoded in the "periodicity" attribute, and the acceptable lower bound and upper bound of the periodicity of the start two bursts of a TSC stream or aggregated TSC streams in reference to the external GM or acceptable list of the periodicity value(s) encoded in the "periodicityRange" attribute if the "EnTSCAC" feature is supported; +- the arrival time of the first data burst of a TSC stream or aggregated TSC streams in reference to the external GM encoded in the "burstArrivalTime" attribute, and the acceptable earliest and latest arrival time of the first data burst of the TSC stream or aggregated TSC streams in reference to the external GM encoded in the "burstArrivalTimeWnd" attribute if the "EnTSCAC" feature is supported; and +- if the "TimeSensitiveCommunication" feature is supported, the time period an application can survive without any burst, i.e., the survival time, in terms of maximum number of messages encoded in the "surTimeInNumMsg" attribute or in time units encoded in the "surTimeInTime" attribute. + +**NOTE:** A single burst (message is equivalent to burst) is expected within a single periodicity. The survival time in terms of maximum number of messages represents the time period result of multiplying the periodicity by the indicated number of messages. + +The uplink and/or downlink flow of the TSC stream or aggregated set of TSC streams shall be encoded within the corresponding "MediaSubComponent" entries of the "medSubComps" attribute, for PDU sessions of Ethernet type in the "ethfDescs" attribute and for PDU sessions of IP type in the "fDescs" attribute. + +When the feature "TimeSensitiveCommunication" is supported, to indicate the time domain the NF service consumer is located in (i.e. the (g)PTP domain), the NF service consumer may include the "tscaiTimeDom" attribute in the corresponding media component entry of the "medComponents" attribute. + +When the feature "EnTSCAC" is supported, the NF service consumer may include within the "capBatAdaptation" attribute in the corresponding media component entry of the "medComponents" attribute the capability of AF to adjust the burst sending time according to the network provided Burst Arrival Time offset if burst arrival time window is not provided. + +When the feature "EnTSCAC" is supported, an NF service consumer may request to be notified about the network-determined BAT offset and the optionally adjusted periodicity by using the "EventsSubscReqData" data type and shall include in the HTTP POST request message an event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO". + +To indicate the TSC QoS related data of a TSC stream or aggregated set of TSC streams, the NF service consumer (i.e. TSN AF or TSCTSF) may include in the "tsnQos" attribute included in a media component entry of the "medComponents" attribute; + +- the maximum burst size encoded in the "maxTscBurstSize" attribute; +- the maximum time a packet may be delayed encoded in the "tscPackDelay" attribute; +- the maximum packet error rate encoded in the "maxPer" attribute, if the "ExtQoS" feature is supported; +- the TSC traffic priority in scheduling resources among other TSC streams encoded in the "tscPrioLevel" attribute. + +The NF service consumer (i.e. TSN AF or TSCTSF) may also include the max bitrates in uplink and downlink within the "marBwUI" attribute and the "marBwDI" attribute of the "medComponents" attribute respectively. In case of integration with IEEE TSN network, the TSN AF determines the maximum flow bit rate as defined in Annex I of 3GPP TS 23.501 [2]. In case of integration with a TSC network other than IEEE TSN network, the TSCTSF may additionally include the "mirBwUI" attribute and the "mirBwDI" attribute of the "medComponents" attribute to indicate the requested guaranteed bit rates in uplink and downlink respectively. + +When the feature "TimeSensitiveCommunication" is supported, and the feature "AuthorizationWithRequiredQoS" is supported as specified in clause 4.2.2.32, the NF service consumer (i.e. TSCTSF or TSN AF) may provide within an entry of the "medComponents" attribute a reference to pre-defined QoS information within the "qosReference" attribute instead of providing the attributes "tsnQos", "marBwUI", "marBwDI", "mirBwUI", and/or "mirBwDI". Additionally, if the NF service consumer supports adjustments to different QoS parameter combinations, the NF service consumer may provide a prioritized list of one or more QoS references within the "altSerReqs" attribute as specified in clause 4.2.2.32. + +When the feature "TimeSensitiveCommunication" is supported, the feature "AltSerReqsWithIndQoS" is supported as specified in clause 4.2.2.32, and the NF service consumer (i.e. TSCTSF or TSN AF) provides within an entry of the "medComponents" attribute individual QoS information (e.g. within the "tsnQos", "marBwUI" and/or "marBwDI" attributes as described in this clause, then the NF service consumer may provide adjustments to different QoS parameter combinations within a prioritized list of one or more Requested Alternative QoS Parameter set(s) within the "altSerReqsData" attribute as specified in clause 4.2.2.32. + +The PCF shall reply to the NF service consumer (i.e. TSN AF or TSCTSF) as described in clause 4.2.2.2. + +The PCF shall check whether the received TSCAI input container and TSC QoS related data require to create PCC rules to provide the SMF with derived QoS characteristics and the received TSCAI input container. Provisioning of PCC rule(s) to the SMF shall be carried out as specified in 3GPP TS 29.512 [8]. + +#### 4.2.2.25 Provisioning of TSC user plane node management information and port management information + +During the lifetime of a PDU session enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking, the PCF may receive from the NF service consumer TSC user plane node management information and/or, when the DS-TT or the NW-TT functions are used, port management information for a port located in DS-TT and/or NW-TT and/or, the direct event notification of TSC management information from the UPF if the feature "ExposureToTSC" is supported. + +NOTE: The 5GS Architecture to support IETF Deterministic Networking (IETF RFC 8655 [56]) does not require the DS-TT functionality to be supported in the device nor require the user plane NW-TT functionality to be supported in the UPF. However, it can co-exist with such functions. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported, the NF service consumer (i.e., the TSN AF or the TSCTSF) may provide a UMIC with TSC user plane node management information for the UPF/NW-TT and PMIC(s) with port management information for the DS-TT port and/or the NW-TT ports, to configure the 5G system as a TSC user plane node by invoking the Npcf\_PolicyAuthorization\_Create service operation to the PCF. + +The NF service consumer may include in the "AppSessionContextReqData" data type: + +- the DS-TT PMIC encoded in the attribute "tsnPortManContDstt" and/or the one or more NW-TT PMIC(s) encoded in the "tsnPortManContNwtt" attribute, if available, for the DS-TT port and NW-TT ports allocated for + +a PDU session. The PMIC(s) are encoded in the "PortManagementContainer" data type, which includes the port management information in the "portManCont" attribute and the related port number in the "portNum" attribute; + +- the UMIC encoded in the "tsnBridgeManCont", if available, for the TSC user plane node functionality of the UPF/NW-TT allocated for a PDU session. The UMIC is encoded in the "BridgeManagementContainer" data type;and/or +- if the feature "ExposureToTSC" is supported, the notification URI within the "tscNotifUri" attribute and the notification correlation identifier assigned by the TSCTSF or TSN AF within the "tscNotifCorreId" attribute, which, if available, indicates that the direct event notification of TSC management information from the UPF is requested. + +As result of this action, the PCF shall provide the received DS-TT and/or NW-TT PMIC(s) and/or UMIC and/or the direct event notification of TSC management information for the corresponding PDU session as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.26 Invocation of Mission Critical Services + +This procedure allows a NF service consumer, as per 3GPP TS 22.179 [45], to request prioritized access to system resources in situations such as during congestion. + +The NF service consumer may include the "mcsId" attribute to indicate that the new AF session relates to an MCS session. + +The "mcsId" attribute shall contain the national variant for the MCS service name indicating an MCS session. The "resPrio" attribute shall include the priority value of the related priority service. + +If the NF service consumer supports the SBI Message Priority mechanism for an MCS session, it shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 6.8.2 of 3GPP TS 29.500 [5]. + +NOTE: If the NF service consumer supports the SBI Message Priority mechanism for an MCS session, the NF service consumer will include the "3gpp-Sbi-Message-Priority" custom HTTP header with a priority value equivalent to the value of the "resPrio" attribute. Highest user priority value is mapped in the corresponding lowest value of the "3gpp-Sbi-Message-Priority" custom HTTP header. + +When the PCF receives the "mcsId" attribute indicating an MCS session, the PCF shall take specific actions on the corresponding PDU session to ensure that the MCS session is prioritised as specified in 3GPP TS 29.512 [8]. + +#### 4.2.2.27 P-CSCF restoration enhancements + +The P-CSCF restoration custom operation is applicable when the PCF based Restoration Enhancement, as defined in 3GPP TS 23.380 [39], represented by the supported feature "PCSCF-Restoration-Enhancement" is supported by both P-CSCF and PCF. + +Figure 4.2.2.27-1 illustrates the P-CSCF restoration enhancements. + +![Sequence diagram showing P-CSCF restoration enhancements between an NF service consumer and a PCF. Step 1: POST « pscf-restoration » from NF service consumer to PCF. Step 2: 204 No Content response from PCF to NF service consumer.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST « pscf-restoration » + NF service consumer->>PCF: Request + Note left of PCF: 2. "204 No Content" + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing P-CSCF restoration enhancements between an NF service consumer and a PCF. Step 1: POST « pscf-restoration » from NF service consumer to PCF. Step 2: 204 No Content response from PCF to NF service consumer. + +**Figure 4.2.2.27-1: P-CSCF restoration enhancements** + +The P-CSCF acting as a NF service consumer shall invoke the "P-CSCF restoration" custom operation sending an HTTP POST request to the resource URI representing the custom operation (POST .../pcscf-restoration) as shown in figure 4.2.2.27-1, step 1, in case P-CSCF restoration needs to be performed. + +The P-CSCF shall include in the "PscfRestorationRequestData" data type in the content of the HTTP POST request: + +- the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute, and if the IP address is not unique (e.g. private IPv4 case), the "ipDomain" attribute or the "sliceInfo" attribute if available; or +- if the IP address is not available or if the IP address is not unique and the "ipDomain" attribute and the "sliceInfo" attribute are not available, the SUPI in the "supi" attribute and the DNN in the "dnn" attribute. + +The PCF shall identify the PDU session for which the HTTP POST request applies. If the PCF fails in identifying the PDU session, the PCF shall reject the "P-CSCF restoration" custom operation with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "PDU\_SESSION\_NOT\_AVAILABLE". + +Otherwise, the PCF shall acknowledge the request and shall send to the NF service consumer a "204 No content" response to the HTTP POST request, as shown in figure 4.2.2.27-1, step 2. + +The PCF shall send a request for P-CSCF restoration to the SMF for the corresponding PDU session as described in 3GPP TS 29.512 [8], clause 4.2.3.18. + +#### 4.2.2.28 Support of CHEM feature + +When CHEM feature is supported, the NF service consumer may include the value of Maximum Packet Loss Rate for UL within the "maxPacketLossRateUl" attribute and/or the value of Maximum Packet Loss Rate for DL within the "maxPacketLossRateDl" attribute in "medComponents" attribute. For CHEM feature, see Annex B.14. + +#### 4.2.2.29 Support of FLUS feature + +When "FLUS" feature is supported by the NF service consumer, the NF service consumer may include the "flusId" attribute within a media component of the "medComponents" attribute to indicate that the related media of the created new Individual Application Session Context resource corresponds to a FLUS media stream. Additional QoS information for the treatment of FLUS media may be provided within "desMaxLatency" attribute and/or "desMaxLoss" attribute. + +#### 4.2.2.30 Subscription to EPS Fallback report + +When the "EPSFallbackReport" feature is supported, the NF service consumer subscribes to EPS Fallback report to be notified of the rejection in 5GS of the requested resources associated to service information for voice media type and the subsequent fallback to EPS of the resources associated to the voice media and other medias requested by this NF service consumer. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "events" attribute with the "event" attribute set to "EPS\_FALLBACK". The NF service consumer shall request to the PCF to report EPS Fallback in conjunction with providing the PCF with NF service consumer service information for voice media type as described in clause 4.2.2.2. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +As result of this action, the PCF shall set the appropriate subscription to EPS Fallback report for the corresponding PCC rule(s) as described in in 3GPP TS 29.512 [8]. + +#### 4.2.2.3.1 Subscription to TSC user plane node related events + +This procedure is used by the NF service consumer (i.e. TSN AF or TSCTSF) if the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported to subscribe to notifications of updated TSC user plane node information, e.g., DS-TT PMIC and/or NW-TT PMIC(s) and/or UMIC availability within the Individual Application Session Context resource created to handle the TSC user plane node in the context of a PDU session. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message within the "evSubsc" attribute an event within "events" attribute with the "event" attribute set to the value "TSN\_BRIDGE\_INFO" to subscribe to the reception of TSC user plane node information. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. If the PCF stores updated PMIC/UMIC updated information, the PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "TSN\_BRIDGE\_INFO" and the "tsnBridgeManCont" attribute and/or the "tsnPortManContDstt" attribute and/or the "tsnPortManContNwttts" attribute as received from the SMF if not previously reported. + +As result of this action, the PCF shall set the corresponding subscription to the report of TSC user plane node management information and port management information for the corresponding PDU session , if not previously done, as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.3.2 Initial provisioning of required QoS information + +This procedure is used by a NF service consumer to request that a data session to a UE is set up with a specific QoS (e.g. low latency or Packet Delay Variation) and priority handling when the "AuthorizationWithRequiredQoS" feature is supported. + +The NF service consumer may provide within one or more entries of the "medComponents" attribute included in the "ascReqData" attribute of the HTTP POST request message described in clause 4.2.2.2 a reference to pre-defined QoS information within the "qosReference" attribute. + +Additionally, if the NF service consumer supports adjustment to different QoS parameter combinations, the NF service consumer may provide a prioritized list of one or more QoS references within the "altSerReqs" attribute, where the lower the index of the array for a given entry, the higher the priority. + +If the "AltSerReqsWithIndQoS" feature is supported, and the NF service consumer requests that the data session to a UE is set up with individual QoS parameters (i.e., with QoS information within "medComponents" attribute, e.g. the "tsnQos", "marBwUI" and/or "marBwDI" attributes, instead of a QoS reference within the "qosReference" attribute), the NF service consumer may instead of the "altSerReqs" attribute provide a prioritized list of alternative service requirements that include Requested Alternative QoS Parameter set(s) within the "altSerReqsData" attribute, where the lower the index of the array for a given entry, the higher the priority. + +If the "DisableUENotification" feature is supported, the AF may also indicate to the PCF that the UE does not need to be informed about changes related to Alternative QoS Profiles by including the "disUeNotif" attribute set to true. + +When the NF service consumer provides the "altSerReqs" attribute or the "altSerReqsData" attribute, the NF service consumer shall also subscribe to receive notifications from the PCF when the resources associated to the corresponding service information have been allocated as described in clause 4.2.2.10 and when the GBR QoS targets for one or more service data flows can no longer (or can again) be guaranteed, as described in clause 4.2.2.6. + +Due to the received QoS information, the PCF may need to provision or modify the related PCC rules as specified in 3GPP TS 29.513 [7] and provide the related information towards the SMF following the corresponding procedures specified in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +#### 4.2.2.33 Support of QoSHint feature + +If the QoSHint feature is supported by the NF service consumer, the NF service consumer may include the "desMaxLatency" attribute and/or "desMaxLoss" attribute within a media component of the "medComponents" attribute to indicate that the related media of the created Individual Application Session Context resource has specific latency and/or loss demands. + +#### 4.2.2.34 Subscription to Reallocation of Credit notification + +This procedure is used by the NF service consumer if the "IMS\_SBI" and the "ReallocationOfCredit" features are supported to subscribe to notifications of reallocation of credit for the Service Data Flows within the AF application session context. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to the value "REALLOCATION\_OF\_CREDIT". + +As result of this action, the PCF shall set the appropriate subscription to reallocation of credit notification for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +#### 4.2.2.35 Subscription to satellite backhaul category changes + +When the feature "SatelliteBackhaul" is supported, the subscription to satellite backhaul category changes is used by a NF service consumer to subscribe to receive a notification when the satellite backhaul category changes and when the backhaul category changes between satellite backhaul and non-satellite backhaul. When the feature "EnSatBackhaulCatChg" is supported, the subscription is also used to receive a notification when the satellite backhaul category change comprises a dynamic satellite backhaul category. + +The NF service consumer shall use the "evSubsc" attribute as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "events" attribute with the "event" attribute set to "SAT\_CATEGORY\_CHG". + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. The PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "SAT\_CATEGORY\_CHG" and the "satBackhaulCategory" attribute including the satellite backhaul category or the indication of non-satellite backhaul if the PCF has previously requested to the SMF to be updated with this information. + +As result of this action, the PCF shall set the appropriate subscription to satellite backhaul changes for the PDU session, if not previously subscribed, as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.36 Subscription to the report of extra UE addresses + +When the feature "ExtraUEaddrReport" is supported, the subscription to the report of extra UE addresses is used to report information about the extra IP addresses or address ranges allocated to the PDU session due to framed routes or IPv6 prefix delegation. The report shall include the actual list of IPv4 addresses or list of IPv6 prefixes as currently allocated. + +NOTE: In case of Deterministic Networking, the 5GS DetNet Node, as described in 3GPP TS 23.501 [2], may forward via its device side interface IP packets destined not only to the UE's IP address or prefix but also to a range of IPv4 addresses or IPv6 IP prefixes according to one or more Framed Routes. + +The NF service consumer shall use the "evSubsc" attribute as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "events" array with the "event" attribute set to "EXTRA\_UE\_ADDR". + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.2.2. + +If the PCF received from the SMF the framed routes as described in 3GPP TS 29.512 [8], clause 4.2.2.2, or the PCF receives updated information of the extra one or more IPv6 prefixes allocated to the UE as described in + +3GPP TS 29.512 [8], clauses 4.2.4.2 and C.3.4.1, the PCF shall include in the response the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "EXTRA\_UE\_ADDR" and: + +- the actual list of IPv4 addresses within the "ipv4AddrList" attribute, if one or more IPv4 framed routes are associated to the PDU session and are available in the PCF; or +- the actual list of IPv6 prefixes allocated to the UE within the "ipv6PrefixList" attribute, if one or more IPv6 framed routes are associated to the PDU session and are available in the PCF, or if the PCF keeps updated IPv6 prefix(es) information. + +As result of this action, the PCF shall set the appropriate subscription to the report of UE IP addresses, if not previously subscribed, as described in in 3GPP TS 29.512 [8]. + +#### 4.2.2.37 Provisioning of multi-modality services + +This procedure is used by a NF service consumer to: + +- provide service requirements for each media flow that comprise the multi-modal service; and/or +- provide QoS monitoring requirements for each media flow that comprise the multi-modal service; + +when "MultiMedia" feature is supported. + +The NF service consumer may include the multi-modal Service Identifier within the "multiModalId" attribute to indicate that the new AF session relates to a multi-modal service. + +To provide service requirements for a multi-modal service, the NF service consumer shall follow the procedures described in clause 4.2.2.2 for initial provisioning of service information, with the following additional considerations: + +- When the multi-modal service combines several media, the NF service consumer shall provide the service information of each media within the "medComponents" attribute. The media subcomponent(s), when provided for a media component, only contain the description of the service data flow(s). + +To provide QoS monitoring requirements for each media component, the NF service consumer shall follow the procedures described in clause 4.2.2.23 for subscriptions to QoS Monitoring Information. + +**Editor's Note:** It is FFS whether different QoS monitoring requirements per different media might be requested and the data types to use in that case. + +#### 4.2.2.38 Initial provisioning of Round-Trip latency requirements + +When the "RTLatency" feature is supported, this procedure is used by a NF service consumer to request Round-Trip (RT) latency requirement for an XR or other interactive media services with an RT latency indication via the AF session with required QoS procedure. The AF may provide the "rTTLatencyInd" attribute contained in MediaComponent data type to indicate that the service data flow needs to meet the RT latency requirement of the service, which is the twice of the single direction delay requirement between the UE and the PSA UPF derived from the "qosReference" attribute or included in the "tscPackDelay" attribute. + +Due to the received Round-Trip latency requirements, the PCF may need to provision or modify the related PCC rules as specified in 3GPP TS 29.513 [7] and provide the related information towards the SMF following the corresponding procedures specified in clause 4.2.6.21.2 of 3GPP TS 29.512 [8]. + +#### 4.2.2.39 Provisioning of PDU Set QoS related data + +If the "PDUSetHandling" feature is supported, to indicate the PDU Set QoS related information for the PDU Set, the NF service consumer may include in the "pduSetQos" attribute included in a media component entry of the "medComponents" attribute; + +- the upper bound for the delay that a PDU Set may experience for the transfer between the UE and the N6 termination point at the UPF encoded in the "pduSetDelayBudget" attribute as described in 3GPP TS 29.571 [12]; + +- upper bound for the non-congestion related PDU Set loss rate encoded in the "pduSetErrRate" attribute as described in 3GPP TS 29.571 [12]. +- PDU Set Integrated Handling information (PSIHI) indicates whether all PDUs of the PDU Set are needed for the usage of the PDU Set by the application layer in the receiver side in the "pduSetHandlingInfo" attribute as described in 3GPP TS 29.571 [12]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.2.2. + +As result of this action, the PCF shall set the appropriate PDU Set QoS parameters for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.40 Subscription to BAT offset notification + +When the "EnTSCAC" feature is supported, the subscription to BAT offset is used by a NF service consumer to subscribe to receive a notification when NF service consumer provides the Capability for BAT adaptation or BAT Window as defined in clause 4.2.2.24. When the NF service consumer provides the periodicity range, the BAT offset subscription is also used to receive the adjusted periodicity. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include in the HTTP POST request message an event within the "evSubsc" attribute with the "event" attribute set to the value "BAT\_OFFSET\_INFO". + +As result of this action, the PCF shall set the appropriate subscription to BAT offset notification for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.41 Subscription to Packet Delay Variation monitoring + +The subscription to Packet Delay Variation is used by an NF service consumer to receive a notification about the variation of packet delay between UE and PSA UPF when the "EnQoSMon" feature is supported. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and may include: + +- the requested Packet Delay Variation parameter(s) to be measured (i.e. DL, UL and/or round trip packet delay) within the "pdvReqMonParams" attribute; +- an entry of the "AfEventSubscription" data type per requested notification method in the "events" attribute with: + - a) the "event" attribute set to the value "PACK\_DEL\_VAR"; and + - b) the "notifMethod" attribute set to the value "EVENT\_DETECTION" or "PERIODIC"; and + - c) when the "notifMethod" attribute is set to the value "PERIODIC", the periodic time for reporting and the maximum period with no Packet Delay Variation measurement within the "repPeriod" attribute; and + - d) when the "notifMethod" attribute is set to the value "EVENT\_DETECTION", the minimum waiting time between subsequent reports within the "waitTime" attribute and the maximum period with no Packet Delay Variation measurement within the "repPeriod" attribute; +- when the "notifMethod" attribute set to the value "EVENT\_DETECTION", the "pdvMon" attribute, with the required Packet Delay Variation monitoring information: + - a) the delay threshold for downlink with the "repThreshDI" attribute; + - b) the delay threshold for uplink with the "repThreshUI" attribute; and/or + - c) the delay threshold for round trip with the "repThreshRp" attribute. + +The NF service consumer shall include more than one "AfEventSubscription" data types within the "EventsSubscReqData" data type if more than one notification methods are required. + +If the AF also subscribed to packet delay measurements and provided "directNotifInd" attribute in the request as described in clause 4.2.2.23, and the PCF determines that to calculate the Packet Delay Variations the packet delay measurements cannot be notified directly, the PCF shall set to DIRECT\_NOTIF\_NOT\_POSSIBLE the "servAuthInfo" attribute in the HTTP response message. The PCF shall not provide the notification addresses and direct notification + +indication in the PCC rule. The PCF shall subscribe to receive the QoS Monitoring reports from SMF by setting the QoS Monitoring Policy Control Request Trigger. + +The PCF shall reply to the AF as described in clause 4.2.2.2. + +As result of this action, the PCF shall determine the QoS Monitoring information to derive packet delay variation measurements requested by the AF and shall set the appropriate subscription for QoS Monitoring with the SMF to receive packet delay monitoring reports for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.42 Initial provisioning of periodicity information + +If the "XRM\_5G" feature is supported, the AF may provide the Uplink and/or Downlink Periodicity information which indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction within "periodInfo" attribute contained in MediaComponent data structure. + +As a result of this action, the PCF shall send the Periodicity information to the SMF as described in 3GPP TS 29.512 [8]. + +#### 4.2.2.43 Provisioning of the indication of ECN marking for L4S support + +When the "L4S" feature is supported, this procedure is used by a NF service consumer to explicitly indicate that the UL and/or DL service data flow of a media component supports ECN marking for L4S support. + +The NF service consumer may include in the HTTP POST request message described in clause 4.2.2.2, within the corresponding media component(s) entries of the "medComponents" attribute, the "l4sInd" attribute set to "UL", "DL" or "UL\_DL" to indicate respectively whether the UL, the DL, or both, UL and DL, service data flow(s) supports ECN marking for L4S support. + +The NF service consumer shall also subscribe to receive notifications from the PCF when the ECN marking for L4S support is not available or available again in 5GS by including within the "evSubsc" attribute the "events" attribute with the "event" attribute set to "L4S\_SUPP". + +The PCF may indicate to the SMF to enable for ECN marking for L4S support following the procedures specified in clause 4.2.6.2.21 of 3GPP TS 29.512 [8]. + +#### 4.2.2.44 Subscription to Round-Trip delay monitoring + +When the "EnQoSMon" feature is supported, this procedure is used by an NF service consumer to receive a notification about the Round-Trip delay measurements over two QoS flows. + +The NF service consumer shall use the "EventsSubscReqData" data type as described in clause 4.2.2.2 and shall include: + +- an entry of the "AfEventSubscription" data type per requested notification method in the "events" attribute with: + - a) the "event" attribute set to the value "RT\_DELAY\_TWO\_QOS\_FLOWS"; and + - b) the "notifMethod" attribute set to the value "EVENT\_DETECTION", or "PERIODIC"; and + - c) when the "notifMethod" attribute is set to the value "PERIODIC", the periodic time for reporting and the maximum period with no Round-Trip delay measurement within the "repPeriod" attribute; and + - d) when the "notifMethod" attribute is set to the value "EVENT\_DETECTION", the minimum waiting time between subsequent reports within the "waitTime" attribute and the maximum period with no Round-Trip delay within the "repPeriod" attribute; +- when the "notifMethod" attribute set to the value "EVENT\_DETECTION", the "qosMon" attribute, with the delay threshold for round trip with the "repThreshRp" attribute. + +**Editor's note:** It is FFS whether to reuse "qosMon" attribute or create a new "rttMon" attribute. + +If the UL and DL flows request the same QoS, the NF service consumer shall use the "MediaComponent" data type as described in clause 4.2.2.2 for the two QoS flows which Round-Trip delay will be measured and shall include: + +- an entry of the "MediaSubComponent" data type with the "fDescs" attribute contains the flow description for the monitored Uplink and/or Downlink IP flows. + +If the UL and DL flows request the different QoS, the NF service consumer shall use two "MediaComponent" data type as described in clause 4.2.2.2 for the uplink and downlink QoS flows which Round-Trip delay will be measured and shall include: + +- for the uplink flow, an entry of the "MediaSubComponent" data type with the "fDescs" attribute contains the monitored flow description for the Uplink IP flow; +- for the downlink flow, an entry of the "MediaSubComponent" data type with the "fDescs" attribute contains the monitored flow description for the Downlink IP flow. + +**Editor's note:** It is FFS how to enable flow level event subscription per UL and DL QoS flow. + +The NF service consumer shall include more than one "AfEventSubscription" data type within the "EventsSubscReqData" data type if more than one notification method is required. + +The PCF shall reply to the AF as described in clause 4.2.2.2. + +As result of this action, the PCF shall determine the QoS Monitoring information to derive round-trip delay measurements requested by the AF and shall set the appropriate subscription for QoS Monitoring information for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +## 4.2.3 Npcf\_PolicyAuthorization\_Update service operation + +### 4.2.3.1 General + +The Npcf\_PolicyAuthorization\_Update service operation provides updated application level information from the NF service consumer and optionally communicates with the Npcf\_SMPolicyControl service to determine and install the policy according to the information provided by the NF service consumer. + +The Npcf\_PolicyAuthorization\_Update service operation updates an application session context in the PCF. + +The following procedures using the Npcf\_PolicyAuthorization\_Update service operation are supported: + +- Modification of service information. +- Gate control. +- Background Data Transfer policy indication at policy authorization update. +- Modification of sponsored connectivity information. +- Modification of Subscription to Service Data Flow QoS notification control. +- Modification of Subscription to Service Data Flow Deactivation. +- Update of traffic routing information. +- Modification of subscription to resources allocation outcome. +- Modification of Multimedia Priority Services. +- Support of content versioning. +- Request of access network information. +- Modification of service information status. +- Support of SIP forking. +- Provisioning of signalling flow information. +- Support of resource sharing. + +- Modification of MCPTT. +- Modification of MCVideo. +- Priority sharing indication. +- Modification of subscription to out of credit notification. +- Modification of Subscription to Service Data Flow QoS Monitoring Information. +- Update of TSCAI Input Information and TSC QoS related data. +- Provisioning of TSC user plane node management information and port management information. +- Support of CHEM feature. +- Support of FLUS feature. +- Subscription to EPS Fallback report. +- Modification of required QoS information. +- Support of QoSHint feature. +- Modification of subscription to reallocation of credit notification. +- Modification of subscription to satellite backhaul category changes. +- Modification of the subscription to the report of extra UE addresses. +- Modification of multi-modal services +- Modification of Round-Trip latency requirements. +- Update of PDU Set QoS related data. +- Modification of subscription to BAT offset notification. +- Modification of subscription to Packet Delay Variation monitoring. +- Provisioning of the indication of ECN marking for L4S support. +- Modification of Round-Trip delay monitoring requirements over two QoS flows. +- Provisioning of the QoS timing information. +- Modification of Periodicity information. + +#### 4.2.3.2 Modification of service information + +This procedure is used to modify an existing application session context as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4] when the feature "PatchCorrection" is supported. + +Figure 4.2.3.2-1 illustrates the modification of service information using HTTP PATCH method. + +![Sequence diagram showing the modification of service information using HTTP PATCH. The NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK.](8d66c9c295023a1380f9986d3663bb1e_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PATCH « app-sessions/{appSessionId} » + NF service consumer->>PCF: Request + Note left of PCF: 2. "200 OK" + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the modification of service information using HTTP PATCH. The NF service consumer sends a PATCH request to the PCF, and the PCF responds with a 200 OK. + +**Figure 4.2.3.2-1: Modification of service information using HTTP PATCH** + +The NF service consumer may modify the application session context information at any time (e.g. due to an AF session modification or internal NF service consumer trigger) and invoke the Npcf\_PolicyAuthorization\_Update service operation by sending the HTTP PATCH request message to the resource URI representing the "Individual Application Session Context" resource, as shown in figure 4.2.3.2-1, step 1, with the modifications to apply. + +The JSON body within the PATCH request shall include the "AppSessionContextUpdateDataPatch" data type and shall be encoded according to "JSON Merge Patch", as defined in IETF RFC 7396 [21]. The modifications to apply are encoded within the attributes of the "ascReqData" attribute, as described below and in subsequent clauses. + +The NF service consumer may include the updated service information in the "medComponents" attribute of the "ascReqData" attribute. The NF service consumer may update the service data flow filter(s) (IP or Ethernet) that identify the traffic of the media component by replacing, within the concerned media subcomponent(s), the previously provided value(s) with the updated one(s). + +If the "AuthorizationWithRequiredQoS" feature as defined in clause 5.8 is supported, the NF service consumer may provide within the MediaComponentRm data structure an update of the required QoS information as specified in clause 4.2.3.30. + +The NF service consumer may include in the "ascReqData" attribute an AF application identifier in the "afAppId" attribute to trigger the PCF to indicate to the SMF/UPF to perform the application detection based on the operator's policy as defined in 3GPP TS 29.512 [8]. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported, the NF service consumer may provide TSC user plane node related information as specified in clauses 4.2.3.24 and 4.2.3.25. + +If the "PDUSetHandling" feature is supported, the NF service consumer may update PDU set related QoS information as specified in clauses 4.2.3.36. + +The NF service consumer may also create, modify or remove events subscription information by sending the HTTP PATCH request message to the resource URI representing the "Individual Application Session Context" resource. + +The NF service consumer shall create event subscription information by including in the "ascReqData" attribute the "evSubsc" attribute of "EventsSubscReqDataRm" data type with the corresponding list of events to subscribe to; and the "notifiUri" attribute with the notification URI where the PCF shall send the notifications. + +The NF service consumer shall update existing event subscription information by including in the "ascReqData" attribute an updated value of the "evSubsc" attribute of the "EventsSubscReqDataRm" data type as follows: + +- The "events" attribute shall include the new complete list of subscribed events. +- When the NF service consumer requests to update the additional information related to an event (e.g. the NF service consumer needs to provide new thresholds to the PCF in the "usgThres" attribute related to the "USAGE\_REPORT" event) the NF service consumer shall include the additional information, which shall completely replace the previously provided one. + +NOTE 1: Note that when the NF service consumer requests to remove an event, this event is not included in the "events" attribute. + +NOTE 2: When an event is included in the "events" attribute and its related additional information is set to null, the PCF considers the subscription to this event is active, but the related procedures stop applying. + +NOTE 3: When an event is removed from the "events" attribute but its related information is not set to null, the PCF considers the subscription to this event is terminated, the related additional information is removed, and the related procedures stop applying. + +The NF service consumer shall remove existing event subscription information by setting to null the "evSubsc" attribute included in the "ascReqData" attribute. + +If the "EnQosMon" feature is supported, the NF service consumer may include attribute "evSubsc" in "MediaSubComponentRm" data type for QoS monitoring for each media component. Either the attribute "evSubsc" in "MediaSubComponentRm" data type or attribute "evSubsc" in "AppSessionContextReqDataRm" data type may be provided to subscribe to notifications for a specific event. An event subscription modification shall not create simultaneous subscriptions, for the provided event, within the media subcomponent and within the application session context. + +The NF service consumer shall update the existing event subscription information of each media component by updating the value of the "evSubsc" attribute in "MediaSubComponentRm" data type. + +The NF service consumer shall remove the existing event subscription information of each media component by setting to null the "evSubsc" attribute in "MediaSubComponentRm" data type. + +Events with "notifMethod" set to "ONE\_TIME" shall only apply at the time the NF service consumer requests their subscription. Once the event report is performed, the subscription to this event is automatically terminated in the PCF and the related information is removed. The presence of a one-time event, together with its related additional information when applicable, during an update procedure shall represent the recreation of the subscription to this event in the PCF. + +NOTE 4: The "notifUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the PCF cannot successfully fulfil the received HTTP PATCH request due to the internal PCF error or due to the error in the HTTP PATCH request, the PCF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP PATCH request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Otherwise, the PCF shall process the received service information according the operator policy and may decide whether the HTTP request message is accepted or not. + +If the updated service information is not acceptable (e.g. the subscribed guaranteed bandwidth for a particular user is exceeded or the authorized data rate in that slice for the UE is exceeded), the PCF shall include in an HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". + +If the PCF detects that a temporary network failure has occurred (e.g. the SGW has failed as defined in clause B.3.3.3 or B.3.4.9 of 3GPP TS 29.512 [8]) and the AF initiates an Npcf\_PolicyAuthorization\_Update service operation, the PCF shall reject the request with an HTTP "403 Forbidden" response including the "cause" attribute set to "TEMPORARY\_NETWORK\_FAILURE". + +If the service information provided in the HTTP PATCH request is rejected due to a temporary condition in the network (e.g. the NWDAF reported the network slice selected for the PDU session is congested), the PCF may include in the "403 Forbidden" response the "cause" attribute set to "REQUESTED\_SERVICE\_TEMPORARILY\_NOT\_AUTHORIZED". The PCF may also provide a retry interval within the "Retry-After" HTTP header field. When the NF service consumer receives the retry interval within the "Retry-After" HTTP header field, the NF service consumer shall not send the same service information to the PCF again (for the same application session context) until the retry interval has elapsed. The "Retry-After" HTTP header is described in 3GPP TS 29.500 [5] clause 5.2.2.2. + +If the service information is invalid or insufficient for the PCF to perform the requested action, e.g. invalid media type or invalid QoS reference, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "INVALID\_SERVICE\_INFORMATION". + +If the IP flow descriptions cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [20] are not observed, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "FILTER\_RESTRICTIONS". + +If the AF provided the same AF charging identifier for a new Individual Application Session Context that is already in use for the other ongoing Individual Application Session, the PCF shall indicate an HTTP "Bad Request" response including the "cause" attribute set to "DUPLICATED\_AF\_SESSION". + +NOTE 5: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8] and the authorized data rate in a slice is exceeded due to the bandwidth demands of the modified service information, it is also possible to accept the request based on operator policies. In this case the derived PCC rule(s) belonging to the authorized GBR service data flows can include a different MBR and/or have a different charging than the one applicable if the data rate is not exceeded as specified in 3GPP TS 29.512 [8]. + +The PCF may additionally provide the acceptable bandwidth within the attribute "acceptableServInfo" included in the "ExtendedProblemDetails" data structure returned in the rejection response message. + +If the request is accepted, the PCF shall update the service information with the new information received. Due to the updated service information, the PCF may need to create, modify or delete the related PCC rules as specified in 3GPP TS 29.513 [7] and provide the updated information towards the SMF following the corresponding procedures specified in 3GPP TS 29.512 [8]. + +Based on the received subscription information from the NF service consumer, the PCF may create a subscription to event notifications or may modify the existing subscription to event notifications, for a related PDU session from the SMF, as described in 3GPP TS 29.512 [8]. + +The PCF shall reply with the HTTP response message to the NF service consumer and may include the "AppSessionContext" data type content with the representation of the modified "Individual Application Session Context" resource and may include the "Events Subscription" sub-resource. + +The PCF shall include in the "evsNotif" attribute: + +- if the NF service consumer subscribed to the "PLMN\_CHG" event in the HTTP PATCH request, the "event" attribute set to "PLMN\_CHG" and the "plmnId" attribute including the PLMN Identifier or the SNPN Identifier if the PCF has previously requested to be updated with this information in the SMF; + +NOTE 6: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 7: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- if the NF service consumer subscribed to the event "ACCESS\_TYPE\_CHANGE" event in the HTTP PATCH request, the "event" attribute set to "ACCESS\_TYPE\_CHANGE" and: + - i. the "accessType" attribute including the access type, and the "ratType" attribute including the RAT type when applicable for the notified access type; and + - ii. if the "ATSSS" feature is supported, the "addAccessInfo" attribute with the additional access type information if available, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; and + +NOTE 8: For a MA PDU session, if the "ATSSS" feature is not supported by the NF service consumer, the PCF includes the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type (if applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +- iii. the "anGwAddr" attribute including access network gateway address when available, if the PCF has previously requested to be updated with this information in the SMF; and + +- if the "IMS\_SBI" feature is supported and if the NF service consumer subscribed to the "CHARGING\_CORRELATION" event in the HTTP PATCH request, the "event" attribute set to "CHARGING\_CORRELATION" and may include the "anChargIds" attribute containing the access network charging identifier(s) and the "anChargAddr" attribute containing the access network charging address. + +The NF service consumer subscription to other specific events using the Npcf\_PolicyAuthorization\_Update request is described in the related clauses. Notification of events when the applicable information is not available in the PCF when receiving the Npcf\_PolicyAuthorization\_Update request is described in clause 4.2.5. + +The HTTP response message towards the NF service consumer should take place before or in parallel with any required PCC rule provisioning towards the SMF. + +If the PCF does not have an existing application session context for the application session context being modified (such as after a PCF failure), the PCF shall reject the HTTP request message with the HTTP response message with the applicable rejection cause. + +#### 4.2.3.3 Gate control + +This procedure is used by a NF service consumer to modify in the PCF the service data flow(s) that are to be enabled or disabled to pass through the PDU session. + +The NF service consumer shall use the HTTP PATCH method to modify the gate control information. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, in the media component(s) included in the "medComponents" attribute at media and/or media subcomponent level, the "fStatus" attribute for the flows to be enabled or disabled with the appropriate value. + +If a "medSubComps" attribute contains a "flowUsage" attribute with the value "RTCP", then the IP Flows described by that media subcomponent shall be enabled in both directions irrespective of the value of the "fStatus" attribute of the corresponding media component. + +As result of this action, the PCF shall set the appropriate gate status for the corresponding active PCC rule(s). + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.4 Background Data Transfer policy indication at policy authorization update + +This procedure is used by a NF service consumer to indicate at policy authorization update a transfer policy negotiated for background data transfer using the Npcf\_BDTPolicyControl service as described in 3GPP TS 29.554 [14]. + +The NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, a new reference id in the "bdtReflId" attribute. + +NOTE 1: The PCF will retrieve the corresponding transfer policy from the UDR based on the reference identifier within the "bdtReflId" attribute. In case only one PCF is deployed in the network, transfer policies can be locally stored in the PCF and the interaction with the UDR is not required. + +If the PCF cannot retrieve the transfer policy, the PCF shall set to TP\_NOT\_KNOWN the "servAuthInfo" attribute in the HTTP response message to the NF service consumer to indicate that the transfer policy is unknown. + +If the time window of the received transfer policy has expired, the PCF shall set to TP\_EXPIRED the "servAuthInfo" attribute in the HTTP response message to indicate to the NF service consumer that the transfer policy has expired. Otherwise, if the time window of the received transfer policy has not yet occurred, the PCF shall set to TP\_NOT\_YET\_OCCURRED the "servAuthInfo" attribute in the HTTP response message to the NF service consumer to indicate that the time window of the transfer policy has not yet occurred. + +NOTE 2: In the case that the PCF cannot retrieve the transfer policy, the transfer policy time window has not yet occurred or the transfer policy expired, the PCF makes the decision without considering the transfer policy. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.5 Modification of sponsored connectivity information + +This procedure is used by a NF service consumer to modify sponsored data connectivity when "SponsoredConnectivity" feature is supported. + +The NF service consumer shall use the HTTP PATCH method to modify the sponsored connectivity information. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, an application service provider identity and a sponsor identity within the "aspId" attribute and "sponId" attribute, and optionally an indication of whether to enable or disable sponsored data connectivity within the "sponStatus" attribute set to the applicable value to provide sponsored connectivity information or to update existing sponsored connectivity information. + +If the NF service consumer requests to enable sponsored data connectivity the NF service consumer shall change the "sponStatus" attribute value to "SPONSOR\_ENABLED". + +If the NF service consumer requests to disable sponsored data connectivity the NF service consumer shall provide an indication to disable sponsored data connectivity to the PCF by setting the "sponStatus" attribute to "SPONSOR\_DISABLED". + +To support the usage monitoring of sponsored data connectivity, the NF service consumer may also include in the HTTP PATCH a new or modified "evSubsc" attribute of "EventsSubscReqDataRm" data type with: + +- the usage thresholds to apply in the "usgThres" attribute; and +- the subscription to usage monitoring for sponsored data connectivity in an entry of the "events" attribute of the "AfEventSubscription" data type with the "event" attribute set to "USAGE\_REPORT". + +NOTE 1: If the NF service consumer is in the user plane, the NF service consumer can handle the usage monitoring and therefore it is not required to provide a usage threshold to the PCF as part of the sponsored data connectivity information. + +When the NF service consumer indicated to enable sponsored data connectivity, and the UE is roaming with the visited access case, the following procedures apply: + +- If the NF service consumer is located in the HPLMN, for home routed roaming case and when operator policies do not allow accessing the sponsored data connectivity with this roaming case, the H-PCF shall reject the service request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". +- If the NF service consumer is located in the VPLMN, the V-PCF shall reject the service request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". + +When the NF service consumer indicated to enable sponsored data connectivity, and the UE is in the non-roaming case or roaming with the home routed case and the operator policies allow accessing the sponsored data connectivity with this roaming case, the following procedures apply: + +- If the SMF does not support sponsored connectivity and the required reporting level for that service indicates a sponsored connectivity level according to 3GPP TS 29.512 [8], then the PCF shall reject the request and shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". +- If the SMF supports sponsored data connectivity feature or the required reporting level is different from sponsored connectivity level as described in 3GPP TS 29.512 [8], then the PCF, based on operator policies, shall check whether it is required to validate the sponsored connectivity data. If it is required, it shall perform the authorizations based on sponsored data connectivity profiles. If the authorization fails, the PCF shall include in the HTTP "403 Forbidden" response message the "cause" attribute set to "UNAUTHORIZED\_SPONSORED\_DATA\_CONNECTIVITY". + +NOTE 2: The PCF is not required to verify that a trust relationship exists between the operator and the sponsors. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.6 Modification of Subscription to Service Data Flow QoS notification control + +This procedure is used in the NF service consumer to modify in the PCF the subscription to notification about whether the GBR QoS targets can no longer (or can again) be guaranteed. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which either shall include in the "events" attribute a new element with the "event" attribute set to "QOS\_NOTIF" to indicate the subscription to QoS notification control, or shall not include in the "events" attribute an existing element with the "event" attribute set to "QOS\_NOTIF" to indicate the termination of the subscription to QoS notification control. + +As result of this action, the PCF shall set the appropriate subscription to QoS notification control for the corresponding active PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.7 Modification of Subscription to Service Data Flow Deactivation + +This procedure is used by a NF service consumer to modify in the PCF the subscription to the notification of deactivation of one or more Service Data Flows within the AF application session context. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which either shall include in the "events" attribute a new element with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION" to indicate the subscription to service data flow deactivation, or shall not include in the "events" attribute an existing element with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION". + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +As result of this action, the PCF shall set the appropriate subscription to service data flow deactivation for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.8 Update of traffic routing and service function chaining information + +This procedure is used by NF service consumer to modify in the PCF the traffic routing information to a local access to a DNN, and/or to modify the subscription to notifications about UP path management when "InfluenceOnTrafficRouting" feature is supported. + +When the "SFC" feature is supported, this procedure is used by NF service consumer to modify in the PCF the service function chaining information. + +When the "SimultConnectivity" feature is supported, this procedure may be used to modify (create, delete, update) the indication of simultaneous connectivity temporarily maintained for the source and target PSA and/or the indication of the minimum time interval to be considered for inactivity for the traffic routed via the source PSA. + +When the "URLLC" feature is supported, this procedure may be used to modify (create, delete, update) the indication of UE IP address preservation. + +When the "EASIPreplacement" feature is supported, this procedure may be used to modify (initially provide, delete, update) the EAS IP replacement information to the PCF. + +The NF service consumer shall use the HTTP PATCH method. + +To modify traffic routing information, the NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, an updated "afRoutReq" attribute(s) with the modified traffic routing information. To modify the indication of simultaneous connectivity and/or the termination of the simultaneous connectivity, the NF service consumer shall include an updated "simConnInd" attribute and/or an updated "simConnTem" attribute, if applicable. To modify the indication of UE IP address preservation, the NF service consumer shall include the updated indication of UE IP address preservation in the "addrPreserInd" attribute, if applicable. To modify the EAS IP replacement information, the NF service consumer shall include the updated/new "easIpReplaceInfos" attribute, if applicable. To modify the maximum allowed user plane latency, the NF service consumer shall include the updated/new "maxAllowedUpLat" attribute, if applicable. To modify the traffic correlation information, the NF service consumer shall include an updated/new "tfcCorreInfo" attribute. To send a new indication of EAS rediscovery, the NF service consumer shall include the indication in the "easRedisInd" attribute, if applicable. + +To modify service function chaining information, the NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, an updated "afSfcReq" attribute(s) with the modified service function chaining information. + +To modify the subscription to notifications about UP path management events (create, delete or modify), the NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "upPathChgSub" attribute with the modified subscription to UP path management events. + +When the feature "RoutingReqOutcome" is supported: + +- and the NF service consumer is creating or modifying AF routing information, the PCF may set the "servAuthInfo" attribute in the HTTP response message to "ROUT\_REQ\_NOT\_AUTHORIZED" when the PCF determines, e.g. based on subscription, the AF influence on traffic routing is not allowed for the PDU session; +- when the NF service consumer requests the update of the steering of traffic to a DNAI and/or the subscription to notifications about UP path management events, the NF service consumer may subscribe to notifications of failures in the enforcement of UP path changes including within the "evSubsc" attribute the "event" attribute value "UP\_PATH\_CHG\_FAILURE" in an entry of the "events" array, or may remove the subscription to notification of failures in the enforcement of UP path changes by not including the the "event" attribute value "UP\_PATH\_CHG\_FAILURE" in an entry of the "events" array of the "evSubsc" attribute. + +NOTE: In the case that the PCF determines that the requested AF routing requirements cannot be applied and returns the "servAuthInfo" attribute in the HTTP response, the PCF makes the decision without considering the requested AF routing requirements. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +The PCF shall store the application routing requirements included in the "afRoutReq" attribute and/or in the N6-LAN traffic steering requirements "afSfcReq" attribute. + +The PCF shall check whether the updated application routing requirements and/or N6-LAN traffic steering requirements require PCC rules to be created or modified to include updated traffic steering policies (for both routing requirements and/or N6-LAN traffic steering requirements), or to update the application relocation possibility (only for routing requirements) as specified in 3GPP TS 29.513 [7]. Provisioning of PCC rules to the SMF shall be carried out as specified at 3GPP TS 29.512 [8]. + +#### 4.2.3.9 Void + +#### 4.2.3.10 Modification of subscription to resources allocation outcome + +This procedure is used in the NF service consumer to modify in the PCF the subscription to notification about resources allocation outcome. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which either include in the "events" attribute a new element with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION", "FAILED\_RESOURCES\_ALLOCATION" and/or "UE\_TEMPORARILY\_UNAVAILABLE" or remove in the "events" attribute an existing element with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION", "FAILED\_RESOURCES\_ALLOCATION" and/or "UE\_TEMPORARILY\_UNAVAILABLE". As a result of this action, the PCF shall set the appropriate subscription to notification of resources allocation outcome in the corresponding PCC Rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.11 Void + +#### 4.2.3.12 Modification of Multimedia Priority Services + +The NF service consumer may include, in the "ascReqData" attribute, the "mpsId" attribute if it was not previously provided in order to indicate that the modified AF session relates to an MPS session. + +If the NF service consumer supports the SBI Message Priority mechanism for an MPS session, the NF service consumer shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 4.2.2.12.1. + +If the PCF receives the "mpsId" attribute, the PCF shall take specific actions on the corresponding PDU session to ensure that the MPS session is prioritized as defined in 3GPP TS 29.512 [8]. + +**NOTE:** When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +When the feature "MPSforDTS" is supported, the NF service consumer includes the "mpsAction" attribute to invoke or revoke MPS for DTS, as specified in clause 4.2.2.12.2. When invoking MPS for DTS, the NF service consumer shall include the "mpsAction" attribute set to "ENABLE\_MPS\_FOR\_DTS" or "AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS". When the "ENABLE\_MPS\_FOR\_DTS" value is received in the "mpsAction" attribute, and allowed by local policy, the PCF does not check the authorization of the request. When the "AUTHORIZE\_AND\_ENABLE\_MPS\_FOR\_DTS" value is received in the "mpsAction" attribute, and allowed by local policy, the PCF shall check the user's MPS subscription to authorize the request. When the request is to authorize and enable, and the request is not authorized (e.g. not allowed by MPS subscription), the PCF shall indicate in an HTTP "403 Forbidden" response message the cause for the rejection including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". + +To revoke MPS for DTS, the NF service consumer shall include the "mpsAction" attribute set to "DISABLE\_MPS\_FOR\_DTS". When the "DISABLE\_MPS\_FOR\_DTS" value is received in the "mpsAction" attribute, and allowed by local policy, the PCF does not check the authorization of the request. + +When modifying an Individual Application Session Context resource due to the invocation or revocation of the MPS for DTS service, the NF service consumer may subscribe to the outcome of the QoS updates by setting within the "evSubsc" attribute an event within the "events" array with: + +- the "event" attribute set to the value "SUCCESSFUL\_QOS\_UPDATE" to report that the invocation/revocation requested by the NF service consumer was successful; and/or +- the "event" attribute set to the value "FAILED\_QOS\_UPDATE" to report that the invocation/revocation requested by the NF service consumer has failed. + +#### 4.2.3.13 Support of content versioning + +The support of the media component versioning is optional. When the "MediaComponentVersioning" feature is supported, the NF service consumer and the PCF shall comply with the procedures specified in this clause. + +Upon each media component modification encoded in the "medComponents" attribute included in the "ascReqData" attribute, if the content version was previously assigned to a media component, the NF service consumer shall assign a new content version. All the content related to that media component shall be included and the content version shall be unique for the lifetime of the media component. + +**NOTE:** The NF service consumer will include all the content of the media component in each media component modification in order to ensure that the media component is installed with the proper information regardless of the outcome of the QoS flow procedure related to previous interactions that are not reported to the PCF yet. + +If the PCF receives the "contVer" attribute for a certain media component, the PCF shall follow the procedures described in 3GPP TS 29.512 [8], clause 4.2.6.2.14. + +#### 4.2.3.14 Request of access network information + +This procedure is used by a NF service consumer to request access network information for an existing "Individual Application Session Context" resource at service information modification when the "NetLoc" feature is supported. + +NOTE 1: Clause 4.2.6.6 describes the NF service consumer request of access network information without providing service information. + +The NF service consumer shall create event subscription information by including in the "AppSessionContextUpdateData" data type the "evSubsc" attribute of "EventsSubscReqData" data type with the corresponding list of events to subscribe to. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +When the PCF determines that the access network does not support the access network information reporting because the SMF does not support the NetLoc feature, the PCF shall respond to the NF service consumer including in the "EventsNotification" data type the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED" value. Otherwise, the PCF shall immediately configure the SMF to provide such access information, as specified in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.3.2. + +NOTE 2: The NF service consumer does not invoke the Npcf\_PolicyAuthorization\_Update service operation to remove subscription to access network information report since the "Access Network Information Notification" is the one-time reported event. Once the access network information is reported to the NF service consumer the subscription to the access network information report is automatically terminated in the PCF and the related information is removed. + +#### 4.2.3.15 Modification of service information status + +When the "IMS\_SBI" feature is supported, the NF service consumer may update the status of the service information. If the NF service consumer provides service information that has been fully negotiated (e.g. based on the SDP answer), the NF service consumer may include in the "ascReqData" attribute the "servInfStatus" attribute set to "FINAL". In this case the PCF shall authorize the session and provision the corresponding PCC rules to the SMF. + +The NF service consumer may additionally provide preliminary service information not fully negotiated yet (e.g. based on the SDP offer) at an earlier stage. To do so, the NF service consumer shall include the "servInfStatus" attribute set to "PRELIMINARY". Upon receipt of such preliminary service information, the PCF shall perform an early authorization check of the service information. If the NF service consumer requests the PCF to report the access network information together with preliminary service information, the PCF shall immediately configure the SMF to provide the access network information. + +#### 4.2.3.16 Support of SIP forking + +When the "IMS\_SBI" feature is supported, this procedure is used by a NF service consumer to indicate that an existing "Individual Application Session Context" resource comprises service information about several SIP dialogues. + +The NF service consumer shall use the HTTP PATCH method to modify the service information. + +The NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the "sipForkInd" attribute and include the updated service information. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +When the "sipForkInd" attribute gets the value: + +- "SEVERAL\_DIALOGUES", the PCF shall send additional PCC rules or individual data flow filters to already provided PCC rules as described in Annex B.3.1. +- "SINGLE\_DIALOGUE", the PCF shall update installed PCC rules and Authorized-QoS information as described in Annex B.3.2. + +#### 4.2.3.17 Provisioning of signalling flow information + +This procedure is used by a NF service consumer to provision or de-provision information about the AF signalling IP flows between the UE and the NF service consumer. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute: + +- when the procedure is used to provision information about the AF signalling IP flows, a media component within the "medComponents" attribute including the attributes described in clause 4.2.2.16 in the case of IMS restoration or clause 4.2.2.12.3 otherwise; +- when the procedure is used to de-provision information about the AF signalling IP flows, for the media subcomponents containing the AF signalling IP flows, the "fStatus" attribute set to the value "REMOVED". + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.18 Support of resource sharing + +When the "ResourceSharing" is supported by the NF service consumer and the PCF, the NF service consumer may include, in the "ascReqData" attribute, the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute within a media component of the "medComponents" attribute to indicate to the PCF that the related media of the modified Individual Application Session Context resource may share resources with other media components in the related direction that include the same value in the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute. + +The NF service consumer may modify the conditions for resource sharing by including the media component within the "medComponents" attribute with a new value for the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute. The NF service consumer may indicate that the related media of the modified Individual Application Session resource is not sharing resources with other media components in the related direction setting the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute to "null". + +The NF service consumer shall use the HTTP PATCH method to update the "Individual Application Session Context resource" as described in clause 4.2.3.2. + +If the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute are provided within a media component of the "medComponents" attribute, the PCF may apply the mechanisms for resource sharing as described in 3GPP TS 29.512 [8], clause 4.2.6.2.8. + +#### 4.2.3.19 Modification of MCPTT + +The NF service consumer may include, in the "ascReqData" attribute, the "mcpttId" attribute in order to indicate that the modified "Individual Application Session Context" resource relates to the priority adjustment of an MCPTT session. When the PCF receives the "mcpttId" attribute related to that MCPTT session, the PCF may take specific actions on the corresponding PDU session to ensure that the MCPTT session is prioritized. For the handling of MCPTT session with priority call, see Annex B.13. + +- NOTE: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +Additionally, when the "PrioritySharing" feature is supported, the PCF may receive the "prioSharingInd" attribute within the media component received in the "medComponents" attribute as described in clause 4.2.2.21. In this case, and if "MCPTT-Preemption" feature is supported, the PCF may receive pre-emption information as also described in clause 4.2.3.21. + +#### 4.2.3.20 Modification of MCVideo + +The NF service consumer may include, in the "ascReqData" attribute, the "mcVideoId" attribute in order to indicate that the modified "Individual Application Session Context" resource relates to the priority adjustment of an MCVideo session. When the PCF receives the "mcVideoId" attribute related to that MCVideo session, the PCF may take specific actions on the corresponding PDU session to ensure that the MCVideo session is prioritized. For the handling of MCVideo session with priority call, see Annex B.15. + +NOTE: When the PCF supports data rate control per network slice and/or data rate control per network slice for a UE as specified in 3GPP TS 29.512 [8], it is possible that, subject to operator policy and national/regional regulations, prioritised services are exempted from the limitation of data rate per network slice. In that case the PCF will handle the request from the NF service consumer even if the authorized data rate per network slice is exceeded. + +#### 4.2.3.21 Priority sharing indication + +When the "PrioritySharing" feature is supported, the NF service consumer may include the "prioSharingInd" attribute set to "ENABLED" within a media component of the "medComponents" attribute included in the "ascReqData" attribute to indicate to the PCF that the related media flow is allowed to use the same Allocation and Retention Priority (ARP) as media flows belonging to other "Individual Application Session Context" resources as described in clause 4.2.2.21. In this case, if the "MCPTT-Preemption" feature is supported, the NF service consumer may also include the "preemptCap", "preemptVuln" and "preemptControlInfo" attributes as described in clause 4.2.2.21. + +When the "preemptControlInfo" attribute is modified, the latest provided value shall be applied to all potential media flow candidates. + +If the NF service consumer earlier has indicated a media flow priority sharing to the PCF by setting the "prioSharingInd" attribute to "ENABLED", the NF service consumer may include the Priority-Sharing-Indicator AVP set to "DISABLED" within a media component of the "medComponents" attribute to indicate to the PCF that the related media flow shall not be part of the mechanism for sharing the Allocation and Retention Priority with other media flows any longer. + +If this media flow was in priority sharing with other media flows the PCF should readjust the Allocation and Retention Priority for the remaining services sharing priority as described in 3GPP TS 29.512 [8], clause 4.2.6.2.9 and handle the media flow excluded from priority sharing according to normal PCC/QoS rule provisioning procedures described in 3GPP TS 29.512 [8], clause 4.2.6.2. + +If the NF service consumer earlier has indicated a media flow priority sharing to the PCF by setting the "prioSharingInd" attribute to "ENABLED" for media flows and the NF service consumer indicates to remove one or more of the media flows in priority sharing with other media flows, the PCF should readjust the Allocation and Retention Priority for the remaining services sharing priority as described in 3GPP TS 29.512 [8], clause 4.2.6.2.9 and handle the media flow removed according to normal PCC/QoS rule provisioning procedures described in 3GPP TS 29.512 [8], clause 4.2.6.2. + +#### 4.2.3.22 Modification of Subscription to Out of Credit notification + +This procedure is used by the NF service consumer if the "IMS\_SBI" feature is supported to modify in the PCF the subscription to notification about credit unavailability for the Service Data Flows within the AF application session context. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which either include in the "events" attribute a new element with the "event" attribute set to the value "OUT\_OF\_CREDIT" or remove from the "events" attribute the existing element with the "event" attribute set to the value "OUT\_OF\_CREDIT". + +As a result of this action, the PCF shall set the appropriate subscription to out of credit notification for the corresponding PCC Rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.3.2. + +#### 4.2.3.23 Modification of Subscription to Service Data Flow QoS Monitoring Information + +This procedure is used by NF service consumer to modify the PCF subscription for notification about real-time measurements of QoS parameters for a QoS Flow, e.g. packet delay and/or congestion information between UPF and UE, when the "QoSMonitoring" feature is supported. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "evSubsc" attribute of "EventsSubscReqDataRm" data type, as follows: + +- to create a subscription to notifications of QoS monitoring report: + - a) shall include the "events" array with an array that contains a new entry per requested notification method with the "event" attribute set to "QOS\_MONITORING", and notification related information as described in clause 4.2.2.23; + - b) when the "notifMethod" of the new entry is "EVENT\_DETECTION", shall include a "qosMon" attribute with the QoS monitoring information for packet delay thresholds and/or a "qosMonDatRate" attribute with QoS monitoring information for data rate thresholds and/or the "congestMon" attribute for congestion thresholds as described in clause 4.2.2.23. + - c) shall include the new requested QoS monitoring parameter(s) to be measured (i.e. DL/UL/round trip packet delay and/or if the feature "XRM\_5G" is supported, congestion information, and/or, data rate information) within the "reqQosMonParams" attribute; + - d) may include the notification correlation identifier assigned by the AF within the "notifCorreId" attribute; + - e) if the feature "ExposureToEAS" and/or "XRM\_5G" is supported, may include the "directNotifInd" attribute set to true to indicate the direct event notification of QoS Monitoring data from the UPF; + - f) for data rate monitoring, may include the "avrgWndw" attribute to indicate the average window for the data rate measurement; and +- to remove a subscription to QoS monitoring information: + - a) shall include the "events" array containing an array that shall omit the corresponding entry with the "event" attribute value "QOS\_MONITORING"; + - b) when the "notifMethod" attribute of the removed entry is "EVENT\_DETECTION", it shall contain the "qosMon" and/or "qosMonDatRate" and/or "congestMon" attribute set to null; + - c) if the "directNotifInd" attribute and/or the "avrgWndw" attribute was previously provided, it shall contain the "directNotifInd" attribute and/or the "avrgWndw" attribute set to null. + +If the AF provided an indication of direct event notification, and the PCF determines that the QoS Monitoring reports cannot be notified directly (e.g. the AF requests for monitoring packet delay variation or round trip packet delay when UL and DL are on different service data flows), the PCF generates a successful response to the AF and indicates that direct event notification is not possible by including within the "servAuthInfo" attribute the value "DIRECT\_NOTIF\_NOT\_POSSIBLE", as described in clause 4.2.2.23. + +As result of this action, the PCF shall set the appropriate subscription to QoS monitoring information for the corresponding active PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +**Editor's note:** Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +#### 4.2.3.24 Update of TSCAI Input Information and TSC QoS related data + +If the "TimeSensitiveNetworking" feature is supported, the NF service consumer may update the TSCAI Input container and the TSC QoS related data held in an "Individual Application Session Context" resource using the + +Npcf\_PolicyAuthorization\_Update service operation to modify the TSCAI input information and QoS characteristics delivered to the SMF for use in the 5G System. + +The NF service consumer shall use the HTTP PATCH method as described in clause 4.2.3.2 to modify TSCAI input container and the TSC QoS related information. + +The NF service consumer may indicate TSCAI input information and/or TSC QoS related information for new TSC streams by adding, in the "ascReqData" attribute, one or more media component entries within the "medComponents" attribute including the "tsnQos" attribute and including the "tscaiInputUI" attribute and/or the "tscaiInputDI" attribute and, when the feature "TimeSensitiveCommunication" is supported, the "tscaiTimeDom" attribute, if available, when the feature "EnTSCAC" feature is supported, the "capBatAdaptation" attribute, if available, as described in clause 4.2.2.24. + +The NF service consumer may update the TSCAI input information and/or the TSC QoS related information for existing TSC traffic by including the updated values in the "tscaiInputUI" attribute and/or "tscaiInputDI" attribute and/or updated values in the "tsnQos" attribute included in a media component entry of the "medComponents" attribute included in the "ascReqData" attribute. + +The NF service consumer may delete the TSCAI input information and TSC QoS related information of removed TSC traffic by removing the corresponding media component entries within the "medComponents" attribute included in the "ascReqData" attribute. + +Alternatively, when the "TimeSensitiveCommunication" and "AuthorizationWithRequiredQoS" features are supported, the NF service consumer (i.e., the TSCTSF or TSN AF) may update TSC QoS related information updating the "qosReference" attribute, and/or may indicate the update of the alternative service requirements updating the "altSerReqs" attribute as specified in clause 4.2.3.30. + +When the "TimeSensitiveCommunication" and "AltSerReqsWithIndQoS" features are supported, the NF service consumer (i.e., the TSCTSF or TSN AF) may update TSC QoS related information updating the individual QoS requirement within the "tsnQos" attribute, and/or may indicate the update of the alternative service requirements updating the "altSerReqsData" attribute as specified in clause 4.2.3.30. + +When the "EnTSCAC" feature is supported, the NF service consumer may update the request to notify the network-determined BAT offset and the optionally adjusted periodicity by using the "EventsSubscReqDataRm" data type and may update by including the event within the "events" attribute with the "event" attribute set to "BAT\_OFFSET\_INFO", if available, as described in clause 4.2.2.40. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +The PCF shall check whether the received TSCAI input information and TSC QoS related information require to modify or to remove PCC rules in the SMF. Provisioning of PCC rule(s) to the SMF shall be carried out as specified in 3GPP TS 29.512 [8]. + +#### 4.2.3.25 Provisioning of TSC user plane node management information and port management information + +During the lifetime of a PDU session enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking, the NF service consumer may provision or update, at any time, TSC user plane node management information and/or, when the DS-TT or the NW-TT functions are used, port management information for a port located in DS-TT and/or NW-TT and/or, the direct event notification of TSC management information from the UPF if the feature "ExposureToTSC" is supported. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported the NF service consumer (i.e., the TSN AF or the TSCTSF) may provide a UMIC with TSC user plane management information for the UPF/NW-TT and/or a PMIC for the DS-TT port and/or PMIC(s) for the NW-TT ports with the respective port management information, to read and/or to update the configuration of the 5G system as a TSC user plane node by invoking the Npcf\_PolicyAuthorization\_Update service operation to the PCF. + +The NF service consumer shall use the HTTP PATCH method as described in clause 4.2.3.2 to modify the "Individual Application Session Context" resource holding the UMIC and/or the DS-TT PMIC and/or NW-TT PMIC(s). + +The NF service consumer may include in the "ascReqData" attribute: + +- the DS-TT PMIC encoded in the "tsnPortManContDstt" and/or the one or more NW-TT PMIC(s) encoded in the "tsnPortManContNwttts", if available; +- the UMIC encoded in the "tsnBridgeManCont", if available; and/or +- if the feature "ExposureToTSC" is supported, the notification URI within the "tscNotifUri" attribute and the notification correlation identifier assigned by the TSCTSF or TSN AF within the "tscNotifCorreId" attribute, which, if available, indicates that the direct event notification of TSC management information from the UPF is requested. + +As result of this action, the PCF shall provide the received DS-TT and/or NW-TT PMIC(s) and/or UMIC and/or the direct event notification of TSC management information for the corresponding PDU session as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.26 Modification of Mission Critical Services + +The NF service consumer may include, in the "ascReqData" attribute, the "mcsId" attribute if it was not previously provided in order to indicate that the modified AF session relates to an MCS session. + +If the NF service consumer supports the SBI message priority mechanism for an MCS session, the NF service consumer shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 4.2.2.12. + +If the PCF receives the "mcsId" attribute, the PCF shall take specific actions on the corresponding PDU session to ensure that the MCS session is prioritised as defined in 3GPP TS 29.512 [8]. + +#### 4.2.3.27 Support of CHEM feature + +When CHEM feature is supported, the NF service consumer may include the value of Maximum Packet Loss Rate for UL within the "maxPacketLossRateUI" attribute and/or the value of Maximum Packet Loss Rate for DL within the "maxPacketLossRateDI" attribute in "medComponents" attribute. For CHEM feature, see Annex B.14. + +#### 4.2.3.28 Support of FLUS feature + +If the "FLUS" feature is supported by the NF service consumer, the NF service consumer may include the "flusId" attribute within a media component of the "medComponents" attribute to indicate that the related media of the modified Individual Application Session Context resource corresponds to a FLUS media stream. Additional QoS information for the treatment of FLUS media may be provided within "desMaxLatency" attribute and/or "desMaxLoss" attribute. + +#### 4.2.3.29 Subscription to EPS Fallback report + +When the "EPSFallbackReport" feature is supported, this procedure is used in the NF service consumer to subscribe to the notification of EPS Fallback events, if this event was not previously provisioned. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "evSubsc" attribute of the "EventsSubscReqDataRm" data type, which shall include in the "events" attribute a new element with the "event" attribute set to "EPS\_FALLBACK". The NF service consumer shall request to the PCF to report EPS Fallback in conjunction with providing the PCF with NF service consumer service information for voice media type as described in clause 4.2.3.2, if the event was not previously provisioned as described in clause 4.2.2.30. + +As result of this action, the PCF shall set the appropriate subscription to EPS Fallback for the corresponding active PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.30 Modification of required QoS information + +When the "AuthorizationWithRequiredQoS" feature is supported, this procedure is used by a NF service consumer to modify the required QoS by providing a different QoS reference(s) parameter while the AF session is ongoing. When + +the "AltSerReqsWithIndQoS" feature is supported, this procedure is used by a NF service consumer to modify the Requested Alternative QoS Parameter set(s). + +The NF service consumer shall use the HTTP PATCH method to modify the required QoS information. + +When the "AuthorizationWithRequiredQoS" feature is supported, the NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, within one or more entries of the "medComponents" attribute included in the AppSessionContextUpdateData data type: + +- a "qosReference" attribute, which may contain: + - i. a QoS reference, that replaces an existing QoS reference value if the "qosReference" attribute was previously provisioned, or creates a new one if no "qosReference" attribute was previously provisioned; + - ii. a "null" value, which removes a previously provisioned "qosReference" attribute value. +- an "altSerReqs" attribute, which may contain: + - i. a prioritized list of alternative QoS references, which replaces an existing alternative QoS references list if the "altSerReqs" attribute was previously provisioned, or creates a new one if no "altSerReqs" attribute was previously provisioned; + - ii. a "null" value, which removes a previously provisioned alternative QoS references list. + +When the "AltSerReqsWithIndQoS" feature is supported, and the service QoS is provided, or was previously provided using individual QoS parameters (e.g. "marBwUI" and/or "marBwDI", attributes) instead of a QoS reference, the NF service consumer may include within one or more entries of the "medComponents" attribute: + +- an "altSerReqsData" attribute, which may contain: + - i. a prioritized list of alternative service requirements that include Requested Alternative QoS Parameter set(s), which replaces an existing list of alternative service requirements that include Requested Alternative QoS Parameter set(s) if the "altSerReqsData" attribute was previously provisioned, or creates a new one if no "altSerReqsData" attribute was previously provisioned; + - ii. a "null" value, which removes a previously provisioned list of alternative service requirements that include individual QoS parameter sets. + +NOTE: The modification of the individual QoS parameters is performed by provisioning within the "medComponents" attribute an update of the existing values or deleting the previously provided values, as described in clause 4.2.3.2. + +When the "DisableUENotification" feature is supported, the NF service consumer may include a "disUeNotif" attribute, which may contain: + +- i. a "true" value if it was not provided or it was provided and set to "false"; +- ii. a "false" value if it was provided and set to "true". + +When the NF service consumer provides the "altSerReqs" attribute containing a prioritized list of alternative QoS references or "altSerReqsData" attribute containing a prioritized list of alternative service requirements that include individual QoS parameter sets, the NF service consumer shall subscribe to receive notifications from the PCF when the resources associated to the corresponding service information have been allocated as described in clause 4.2.3.10 and when the GBR QoS targets for one or more service data flows can no longer (or can again) be guaranteed, as described in clause 4.2.3.6, if not previously subscribed. + +Due to the updated required QoS information, the PCF may need to modify the related PCC rules as specified in 3GPP TS 29.513 [7] and provide the updated information towards the SMF following the corresponding procedures specified in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.31 Support of QoSHint feature + +If the QoSHint feature is supported by the NF service consumer, the NF service consumer may include the "desMaxLatency" attribute and/or "desMaxLoss" attribute within a media component of the "medComponents" attribute to indicate that the related media of the modified Individual Application Session Context resource has specific latency and/or loss demands. + +#### 4.2.3.32 Modification of Subscription to Reallocation of Credit notification + +This procedure is used by the NF service consumer if the "IMS\_SBI" and the "ReallocationOfCredit" features are supported to modify in the PCF the subscription to notification about reallocation of credit for the Service Data Flows within the AF application session context. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which either include in the "events" attribute a new element with the "event" attribute set to the value "REALLOCATION\_OF\_CREDIT" or remove from the "events" attribute the existing element with the "event" attribute set to the value "REALLOCATION\_OF\_CREDIT". + +As a result of this action, the PCF shall set the appropriate subscription to reallocation of credit notification for the corresponding PCC Rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.3.2. + +#### 4.2.3.33 Modification of Subscription to satellite backhaul category changes + +When the feature "SatelliteBackhaul" is supported, this procedure is used in the NF service consumer to modify in the PCF the subscription to notification about satellite backhaul category changes. When the feature "EnSatBackhaulCatChg" is supported, the procedure is also used to modify the subscription to notification about dynamic satellite backhaul category changes. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which shall include in the "events" attribute a new element with the "event" attribute set to "SAT\_CATEGORY\_CHG" to indicate the subscription to changes of satellite backhaul category or changes between satellite backhaul and non-satellite backhaul. + +As result of this action, the PCF shall set the appropriate subscription to satellite backhaul changes for the PDU session as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. The PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "SAT\_CATEGORY\_CHG" and the "satBackhaulCategory" attribute including the satellite backhaul category or the indication of non-satellite backhaul if the PCF has previously subscribed with the SMF to changes in this information. + +#### 4.2.3.34 Modification of Subscription to TSC user plane node related events + +When the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported, this procedure is used to modify in the PCF the subscription to TSC user plane node related events. + +The NF service consumer shall use the HTTP PATCH request message described in clause 4.2.3.2. To subscribe to this event, the NF service consumer shall include in the "evSubsc" attribute within the "ascReqData" attribute, the "events" attribute with a new element with the "event" attribute set to the value "TSN\_BRIDGE\_INFO". To unsubscribe to this event, the NF service consumer shall omit the event "TSN\_BRIDGE\_INFO" within the "events" attribute or, if all the subscribed events are being removed, shall set the "evSubsc" attribute to null. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.3.2. + +If the PCF stores updated PMIC/UMIC updated information, and the NF service consumer subscribed to the reception of TSC user plane information, the PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "TSN\_BRIDGE\_INFO" and the "tsnBridgeManCont" attribute and/or the "tsnPortManContDstt" attribute and/or the "tsnPortManContNwts" attribute as received from the SMF, if not previously reported. + +As result of this action, the PCF shall modify the corresponding subscription to the report of TSC user plane node management information and port management information for the corresponding PDU session, if applicable, as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.35 Modification of the subscription to the report of extra UE addresses + +When the feature "ExtraUEaddrReport" is supported, this procedure is used to modify in the PCF the subscription to the report of extra UE addresses. + +The NF service consumer shall use the HTTP PATCH request message described in clause 4.2.3.2. To subscribe to this event, the NF service consumer shall include in the "evSubsc" attribute within the "ascReqData" attribute, the "events" array with a new element with the "event" attribute set to the value "EXTRA\_UE\_ADDR". To unsubscribe to this event, the NF service consumer shall omit the event "EXTRA\_UE\_ADDR" within the "events" attribute or, if all the subscribed events are being removed, shall set the "evSubsc" attribute to null. + +The PCF shall reply to the NF service consumer with an HTTP response message as described in clause 4.2.3.2. + +If the PCF received from the SMF the framed routes as described in 3GPP S 29.512 [8], clause 4.2.2.2, or the PCF received updates of the one or more IPv6 prefixes allocated to the UE as described in 3GPP TS 29.512 [8], clauses 4.2.4.2 and C.3.4.1, and the NF service consumer is subscribing to this event, the PCF shall include in the response the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "EXTRA\_UE\_ADDR" and: + +- the actual list of IPv4 addresses within the "ipv4AddrList" attribute, if one or more IPv4 framed routes are available in the PCF; or +- the actual list of IPv6 prefixes allocated to the UE within the "ipv6PrefixList" attribute, if one or more IPv6 framed routes are associated to the PDU session and are available in the PCF, or if the PCF keeps updated IPv6 prefix(es) information. + +As result of this action, the PCF shall set the appropriate subscription to the report of UE IP addresses, if not previously subscribed, as described in in 3GPP TS 29.512 [8]. + +#### 4.2.3.36 Modification of multi-modal services + +This procedure is used by a NF service consumer to modify the provisioning of multi-modality services when "MultiMedia" feature is supported. + +The NF service consumer shall use the HTTP PATCH method to modify the provisioning of multi-modality services. + +The NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute. + +The NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated QoS monitoring requirements. + +**Editor's Note:** It is FFS whether different QoS monitoring requirements per different media might be requested. It is also FFS whether the existing data structures for QoS Monitoring can be reused or new ones are needed. + +#### 4.2.3.37 Modification of Round-Trip latency requirements + +If the "RTLatency" feature is supported, the NF service consumer may update the RT latency requirement using the HTTP PATCH method as described in clause 4.2.3.2 by invoking the Npcf\_PolicyAuthorization\_Update service operation. + +Due to the change of Round-Trip latency requirements, the PCF may need to provision or modify the related PCC rules as specified in 3GPP TS 29.513 [7] and provide the related information towards the SMF following the corresponding procedures specified in clause 4.2.6.21.2 of 3GPP TS 29.512 [8]. + +#### 4.2.3.38 Update of PDU Set QoS related data + +If the "PDUSetHandling" feature is supported, the NF service consumer may update the PDU Set QoS related data held in an "Individual Application Session Context" resource using the Npcf\_PolicyAuthorization\_Update service operation to modify the PDU Set QoS characteristics delivered to the SMF for use in the 5G System. + +The NF service consumer may indicate PDU Set QoS related information for new PDUs by adding, in the "ascReqData" attribute, one or more media component entries within the "medComponents" attribute including the "pduSetQos" attribute, as described in clause 4.2.2.39. + +The NF service consumer may delete the PDU Set QoS related information of removed PDU Set traffic by removing the corresponding media component entries within the "medComponents" attribute included in the "ascReqData" attribute. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +As result of this action, the PCF shall set the appropriate PDU Set QoS parameters for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.39 Modification of Subscription to TSC user plane node related events + +When the "EnTSCAC" feature is supported, this procedure is used to modify in the PCF the subscription to the BAT offset information notification. + +The NF service consumer shall use the HTTP PATCH method to update the "Events Subscription" sub-resource together with the modifications to the "Individual Application Session Context" resource. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "EventsSubscReqDataRm" data type, which shall include in the "events" attribute a new element with the "event" attribute set to "BAT\_OFFSET\_INFO" to indicate the subscription to changes of the BAT offset and the optionally adjusted periodicity. + +As result of this action, the PCF shall set the appropriate subscription to BAT offset notification for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.40 Modification of Packet Delay Variation monitoring requirement + +This procedure is used by an NF service consumer to modify the subscription for notification about the variation of packet delay between UE and PSA UPF when the "EnQoSMon" feature is supported. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "evSubsc" attribute of "EventsSubscReqDataRm" data type, as follows: + +- to create a subscription to notifications of Packet Delay Variation reports, the NF service consumer shall behave as specified in clause 4.2.2.41; or +- to remove a subscription to Packet Delay Variation reports, the NF service consumer shall include the "events" array without any entry with the "event" value "PACK\_DEL\_VAR" and shall set to null the "pdvMon" attribute if previously provided. +- to modify a subscription to Packet Delay Variation reports, the NF service consumer shall replace the Packet Delay Variation parameter(s) and/or the Packet Delay Variation information and/or the event reporting information, as necessary. + +As result of this action, the PCF shall determine the QoS Monitoring information to derive Packet Delay Variation measurements requested by the AF, if applicable, and shall modify the subscription for QoS Monitoring for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +#### 4.2.3.41 Modification of periodicity information + +If the "XRM\_5G" feature is supported, the AF may provide the Uplink and/or Downlink Periodicity information which indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction within "periodInfo" attribute contained in MediaComponentRm data structure. + +As a result of this action, the PCF shall send the Periodicity information to the SMF as described in 3GPP TS 29.512 [8]. + +#### 4.2.3.42 Provisioning of the indication of ECN marking for L4S support + +When the "L4S" feature is supported, this procedure is used by a NF service consumer to provide the explicit indication of whether the UL and/or DL service data flow of a new media component supports ECN marking for L4S. + +The NF service consumer may include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, in the corresponding new media component(s) entries of the "medComponents" attribute, the "l4sInd" attribute with the indication of ECN marking for L4S support as described in clause 4.2.2.43. The NF service consumer shall also subscribe to receive notifications when the ECN marking for L4S support is not available or available again as described in clause 4.2.2.43, if not previously subscribed. + +As result of this action, the PCF may indicate to the SMF to enable for ECN marking for L4S support for the service data flow of the new media component(s) following the procedures specified in clause 4.2.6.2.21 of 3GPP TS 29.512 [8]. + +#### 4.2.3.43 Modification of Round-Trip delay monitoring requirements + +This procedure is used by an NF service consumer to modify the subscription for notification about the Round-Trip delay measurements over two QoS flows when the "EnQoSMon" feature is supported. + +The NF service consumer shall include in the HTTP PATCH request message described in clause 4.2.3.2, in the "ascReqData" attribute, the updated values of the "evSubsc" attribute of "EventsSubscReqDataRm" data type, as follows: + +- to create a subscription to notifications of Round-Trip delay measurements over two QoS flows reports, the NF service consumer shall behave as specified in clause 4.2.2.44; and +- to remove a subscription to Round-Trip delay measurements over two QoS flows reports, the NF service consumer shall include the "events" array without any entry with the "event" value "RT\_DELAY\_TWO\_QOS\_FLOWS"; +- to modify a subscription to Round-Trip delay measurements over two QoS flows reports, the NF service consumer shall replace the Round-Trip delay over two QoS flows and/or the event reporting information, as necessary. + +As result of this action, the PCF shall determine the QoS Monitoring information to derive the Round-Trip delay measurements over two QoS flows requested by the AF, if applicable, and shall modify the subscription for QoS Monitoring for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8], + +The PCF shall reply to the NF service consumer as described in clause 4.2.3.2. + +### 4.2.4 Npcf\_PolicyAuthorization\_Delete service operation + +#### 4.2.4.1 General + +The Npcf\_PolicyAuthorization\_Delete service operation provides means for the NF service consumer to delete the context of application session information. + +The following procedures using the Npcf\_PolicyAuthorization\_Delete service operation are supported: + +- AF application session context termination. + +- Reporting usage for sponsored data connectivity. +- Termination of Multimedia Priority Services. +- Request and report of access network information. +- Termination of MCPTT. +- Termination of MCVideO. +- Priority sharing indication. +- Report of RAN-NAS release cause. +- Termination of Mission Critical Services. + +#### 4.2.4.2 AF application session context termination + +This procedure is used to terminate an AF application session context for the service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.4.2-1 illustrates the application session context termination. + +![Sequence diagram showing the application session context termination between an NF service consumer and a PCF.](ada2aa7cce9cff9cf116d9ae2b8b7c27_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST « app-sessions/{appSessionId}/delete + NF service consumer->>PCF: Request + Note left of PCF: 2a. "200 OK" +2b. "204 No Content" + PCF-->>NF service consumer: Response +``` + +The diagram illustrates the interaction for application session context termination. It features two lifelines: "NF service consumer" on the left and "PCF" on the right. A solid arrow points from the NF service consumer to the PCF, labeled "1. POST « app-sessions/{appSessionId}/delete". A return arrow points from the PCF back to the NF service consumer, labeled with two possible responses: "2a. "200 OK"" and "2b. "204 No Content"". + +Sequence diagram showing the application session context termination between an NF service consumer and a PCF. + +**Figure 4.2.4.2-1: Application session context termination** + +When an AF session is terminated, and if the AF application session context was created as described in clause 4.2.2 or in clause 4.2.6.3, the NF service consumer shall invoke the Npcf\_PolicyAuthorization\_Delete service operation to the PCF using an HTTP POST request, as shown in figure 4.2.4.2-1, step 1. + +The NF service consumer shall set the request URI to "{apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/delete". + +The NF service consumer may include in the body of the HTTP POST the "EventsSubscReqData" data type with the "evSubsc" attribute indicating the corresponding list of events to subscribe to. + +When the PCF receives the HTTP POST request from the NF service consumer, indicating the termination of the AF application session context information, the PCF shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the NF service consumer is accepted, the PCF shall send to the NF service consumer: + +- a) if event information is reported, a "200 OK" response to HTTP POST request, as shown in figure 4.2.4.2-1, step 2a, including in the "AppSessionContext" data type the "evsNotif" attribute, which encodes within "evNotifs" attribute the event to report to the NF service consumer, if available, as described in clause 4.2.5.2. If the event information is not available at the PCF the PCF shall defer sending the response to the NF service consumer and shall immediately configure the SMF to provide such information, as specified in 3GPP TS 29.512 [8]; + +- b) otherwise, the PCF shall send to the NF service consumer a "204 No Content". + +Afterwards, the PCF shall free the network resources allocated for the Service Data Flow(s) corresponding to the deleted AF application session context information. In order to do that, the PCF shall initiate the request for the removal of any related PCC rules from the SMF, if not previously done, following the corresponding procedures specified in 3GPP TS 29.512 [8]. + +If the HTTP POST request from the NF service consumer is rejected, the PCF shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 5.7. + +#### 4.2.4.3 Reporting usage for sponsored data connectivity + +When "SponsoredConnectivity" is supported, and the NF service consumer indicated to enable sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the PCF, the PCF shall report accumulated usage to the NF service consumer using the response of the Npcf\_PolicyAuthorization\_Delete service operation. + +This procedure is initiated when: + +- the "Individual Application Session Context" is deleted by the NF service consumer; or +- the PCF requests the deletion of the "Individual Application Session Context" to the NF service consumer, as described in clause 4.2.5.3, due to PDU session termination, the termination of all the service data flows of the AF session or the home operator policy disallowing the UE accessing the sponsored data connectivity in the roaming case. + +To report the accumulated usage, the PCF shall immediately configure the SMF to retrieve the accumulated usage as specified in 3GPP TS 29.512 [8]. When the PCF receives the usage information from the SMF, the PCF shall notify the NF service consumer by including the "EventsNotification" data type in the response of the HTTP POST request as described in clause 4.2.4.2. + +The PCF shall include: + +- an event of the "AfEventNotification" data type in the "evNotifs" attribute with the matched event "USAGE\_REPORT" in the "event" attribute; and +- the usage encoded in the "usgRep" attribute. + +#### 4.2.4.4 Void + +#### 4.2.4.5 Termination of Multimedia Priority Services + +If the AF session being terminated corresponds to an MPS session, the PCF shall delete the PCC rules corresponding to the MPS session and the PCF shall revoke the actions related to the prioritization of the MPS session in the corresponding PDU Session as defined in 3GPP TS 29.512 [8]. + +If the AF session being terminated corresponds to an MPS for DTS session, the PCF shall revoke MPS for DTS session in the corresponding PDU Session as defined in 3GPP TS 29.512 [8]. + +#### 4.2.4.6 Request and report of access network information + +This procedure is used by a NF service consumer to request the PCF to report the access network information (i.e. user location and/or user timezone information) at the deletion of the "Individual Application Session Context" resource when the "NetLoc" feature is supported. + +This procedure is initiated when: + +- the "Individual Application Session Context" is deleted by the NF service consumer; or + +- the PCF requests the deletion of the "Individual Application Session Context" from the NF service consumer, as described in clause 4.2.5.3, due to PDU session termination or the termination of all the service data flows of the AF session. + +The NF service consumer shall include in the HTTP POST request message described in clause 4.2.4.2: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +When the PCF determines that the access network does not support the access network information reporting because the SMF does not support the NetLoc feature, the PCF shall respond to the NF service consumer including in the "EventsNotification" data type the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED" value. Otherwise, the PCF shall immediately configure the SMF to provide such access information, as specified in 3GPP TS 29.512 [8]. + +When the PCF receives the access network information from the SMF, the PCF shall provide the corresponding access network information to the NF service consumer by including the "EventsNotification" data type in the "200 OK" response to the HTTP POST request. The PCF shall include: + +- in case of 3GPP access, the user location information in the "eutraLocation" or in the "nrLocation" attribute in the "ueLoc" attribute, if available and required; +- in case of untrusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if required, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; + - b) the UDP source port or the TCP source port in the "portNumber" and "protocol" attributes, if available; and + - c) if the "WLAN\_Location" feature is supported, the WLAN location information encoded in the "twapId" attribute, if available, that shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; + +NOTE 1: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute. + +- in case of trusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if required, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; and + - b) the UDP source port in the "portNumber" attribute if available; and + +NOTE 2: The UDP protocol can be used between the UE and the TNGF to enable NAT traversal. + +- c) either the TNAP identifier encoded in the "tnapId" attribute or the TWAP identifier encoded in the "twapId" attribute. The TNAP identifier and the TWAP identifier shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; +- if user location was required, the time when it was last known in the "ueLocTime" attribute if available; + +NOTE 3: The PCF derives the value of the "ueLocTime" attribute from the "userLocationInfoTime" attribute received from the SMF as specified in 3GPP TS 29.512 [8]. + +- the serving network identity i.e. the PLMN Identifier (the PLMN network code and the country code) or the SNPN Identifier (the PLMN Identifier and the NID) in the "plmnId" attribute, if user location information is required but not available in any access; and/or +- the UE timezone in the "ueTimeZone" attribute if required and available. + +NOTE 4: The PCF forwards both 3GPP and non-3GPP access UE locations in the "ueLoc" attribute when both UE locations are provided by the SMF as defined in 3GPP TS 29.512 [8]. + +When the PCF receives from the SMF that the access network does not support access network information report, the PCF shall include the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED", "TZR\_NOT\_SUPPORTED" or "LOC\_NOT\_SUPPORTED" value received from the SMF in the "EventsNotification" data type in the "200 OK" response to the HTTP POST request. + +The PCF shall also include an event of the "AfEventNotification" data type in the "evNotifs" attribute with the "event" attribute set to the value "ANI\_REPORT". + +#### 4.2.4.7 Termination of MCPTT + +If the "Individual Application Session Context" resource being removed corresponds to an MCPTT session, the PCF shall delete the PCC rules corresponding to the MCPTT session and the PCF shall revoke the actions related to the prioritization of the MCPTT session in the corresponding PDU Session as defined in 3GPP TS 29.512 [8]. + +#### 4.2.4.8 Termination of MCVideo + +If the "Individual Application Session Context" resource being removed corresponds to an MCVideo session, the PCF shall delete the PCC rules corresponding to the MCVideo session and the PCF shall revoke the actions related to the prioritization of the MCVideo session in the corresponding PDU Session as defined in 3GPP TS 29.512 [8]. + +#### 4.2.4.9 Priority sharing indication + +If the "Individual Application Session Context" resource being removed included the "prioSharingInd" attribute set to "ENABLED" within a media component of the "medComponents" attribute, if the related media flow(s) was in priority sharing with other media flows the PCF should readjust the Allocation and Retention Priority for the remaining services sharing Allocation and Retention Priority as described in 3GPP TS 29.512 [8], clause 4.2.6.2.9 and handle the media flow removed according to normal PCC/QuoS rule provisioning procedures described in 3GPP TS 29.512 [8], clause 4.2.6.2. + +#### 4.2.4.10 Report of RAN-NAS release cause + +This procedure is used by a PCF to report about the RAN-NAS release cause together with access network information (i.e. user location and/or user timezone information) at the deletion of the "Individual Application Session Context" resource when the "RAN-NAS-Cause" feature is supported. + +This procedure is initiated when: + +- the "Individual Application Session Context" is deleted by the NF service consumer; or +- the PCF requests the deletion of the "Individual Application Session Context" from the NF service consumer, as described in clause 4.2.5.3, due to PDU session termination or the termination of all the service data flows of the AF session. + +The PCF shall immediately configure the SMF to provide such RAN-NAS release cause together with access information, as specified in 3GPP TS 29.512 [8]. + +When the PCF receives the RAN-NAS release cause and access network information from the SMF, the PCF shall provide the corresponding access network information and RAN-NAS release cause to the NF service consumer by including the "EventsNotification" data type in the "200 OK" response to the HTTP POST request. The PCF shall include: + +- in case of 3GPP access, the user location information in the "eutraLocation" or in the "nrLocation" attribute in the "ueLoc" attribute, if available; +- in case of untrusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute; + - b) the UDP source port or the TCP source port in the "portNumber" and "protocol" attributes if available; and + - c) if the "WLAN\_Location" feature is supported, the WLAN location information encoded in the "twapId" attribute, if available, that shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; + +NOTE 1: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute. + +- in case of trusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; and + - b) the UDP source port in the "portNumber" attribute if available; and + +NOTE 2: The UDP protocol can be used between the UE and the TNGF to enable NAT traversal. + +- c) either the TNAP identifier encoded in the "tnapId" attribute or the TWAP identifier encoded in the "twapId" attribute. The TNAP identifier and the TWAP identifier shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; +- the serving network identity i.e. the PLMN Identifier (the PLMN network code and the country code) or the SNPN Identifier (the PLMN Identifier and the NID) in the "plmnId" attribute, if user location information is not available in any access; +- the UE timezone in the "ueTimeZone" attribute if available; and +- the RAN and/or NAS release cause in the "ranNasRelCauses" attribute, if available. + +The PCF shall also include an event of the "AfEventNotification" data type in the "evNotifs" attribute with the "event" attribute set to the value "RAN\_NAS\_CAUSE". + +#### 4.2.4.11 Termination of Mission Critical Services + +If the AF session being terminated corresponds to an MCS session, the PCF shall delete the PCC rules corresponding to the MCS session and the PCF shall revoke the actions related to the prioritisation of the MCS session in the corresponding PDU Session as defined in 3GPP TS 29.512 [8]. + +#### 4.2.4.12 Void + +### 4.2.5 Npcf\_PolicyAuthorization\_Notify service operation + +#### 4.2.5.1 General + +The Npcf\_PolicyAuthorization\_Notify service operation enables notification to NF service consumers that the previously subscribed event for the existing application session context occurred or that the application session context is no longer valid. + +The following procedures using the Npcf\_PolicyAuthorization\_Notify service operation are supported: + +- Notification about application session context event. +- Notification about application session context termination. +- Notification about Service Data Flow QoS notification control. +- Notification about service data flow deactivation. +- Reporting usage for sponsored data connectivity. +- Notification of resources allocation outcome. +- Reporting access network information. +- Notification of signalling path status. +- Notification about out of credit. +- Notification about TSC user plane node management information and/or port management information, Individual Application Session Context exists. +- Notification about Service Data Flow QoS Monitoring control. +- Report of EPS Fallback. +- Notification about TSC user plane node Information, no Individual Application Session Context exists. +- Notification about reallocation of credit. +- Notification of MPS for DTS outcome. +- Notification about application detection information. +- Notification about satellite backhaul category changes. +- Notification about UP path change enforcement failure. +- Notification about PDU session established/terminated events. +- Notification about extra UE addresses. +- Notification about BAT offset. +- Notification about UE reporting Connection Capabilities. +- Notification about Packet Delay Variation. +- Notification about 5GS support for Policy Control for L4S. +- Notification about Round-Trip delay monitoring measurements over two QoS flows. +- Event notification for AF requested QoS for a UE or group of UE(s) not identified by UE address(es). + +#### 4.2.5.2 Notification about application session context event + +This procedure is invoked by the PCF to notify the NF service consumer when a certain, previously subscribed, application session context event occurs, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.5.2-1 illustrates the notification about application session context event. + +![Sequence diagram illustrating the notification about application session context event. The diagram shows two participants: 'NF service consumer' on the left and 'PCF' on the right. Step 1: The PCF sends a POST request to the NF service consumer with the message '1. POST « {notifUri}/notify'. Step 2: The NF service consumer responds with '2. "204 No Content"'.](6231ba981d3d1ab7ce0cae71abd08c17_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of PCF: 1. POST « {notifUri}/notify + PCF->>NF service consumer: + Note left of NF service consumer: 2. "204 No Content" + NF service consumer->>PCF: + +``` + +Sequence diagram illustrating the notification about application session context event. The diagram shows two participants: 'NF service consumer' on the left and 'PCF' on the right. Step 1: The PCF sends a POST request to the NF service consumer with the message '1. POST « {notifUri}/notify'. Step 2: The NF service consumer responds with '2. "204 No Content"'. + +**Figure 4.2.5.2-1: Notification about application session context event** + +When the PCF determines that the event for the existing AF application session context, to which the NF service consumer has subscribed to, occurred e.g. upon reception of an event notification for a PDU session from the SMF as described in 3GPP TS 29.512 [8], the PCF shall invoke the Npcf\_PolicyAuthorization\_Notify service operation by sending the HTTP POST request (as shown in figure 4.2.5.2-1, step 1) to the NF service consumer using the notification URI received in the subscription creation (or modification), as specified in clause 4.2.6, and appending the "notify" segment path at the end of the URI. The PCF shall provide in the body of the HTTP POST request the "EventsNotification" data type including: + +- the Events Subscription resource identifier related with the notification in the "evSubsUri" attribute; and +- the list of the reported events in the "evNotifs" attribute. For each reported event, the "AfEventNotification" data type shall include the event identifier and may include additional event information. + +The PCF shall include: + +- if the NF service consumer subscribed to the "PLMN\_CHG" event, the "event" attribute set to "PLMN\_CHG" and the "plmnId" attribute including the PLMN Identifier or the SNPN Identifier if the PCF has requested to be updated with this information in the SMF; + +NOTE 1: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 2: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- if the NF service consumer subscribed to the event "ACCESS\_TYPE\_CHANGE", the "event" attribute set to "ACCESS\_TYPE\_CHANGE" and: + - the "accessType" attribute including the access type, and the "ratType" attribute including the RAT type when applicable for the notified access type; and/or + - if the "ATSSS" feature is supported and the PDU session is a MA PDU session: + - if it is the first access type report, and both, 3GPP and non-3GPP access information is available, the "addAccessInfo" attribute. The "addAccessInfo" attribute contains the additional access type information, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; + - if it is a subsequent access type change report: + +- if a new access type is added to the MA PDU session, the "addAccessInfo" attribute with the added access type encoded in the "accessType" attribute, and the RAT type encoded in the "ratType" attribute when applicable for the notified access type; +- if an access type is released to the MA PDU session, the "relAccessInfo" attribute with the released access type encoded in the "accessType" attribute, and the RAT type encoded in the "ratType" attribute when applicable for the notified access type; and + +NOTE 3: For a MA PDU session, if the "ATSSS" feature is not supported by the NF service consumer the PCF shall include the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type. When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access and only changes on activation and deactivation of 3GPP access are reported. + +iii. the "anGwAddr" attribute including access network gateway address when available; and + +- if the "IMS\_SBI" feature is supported and if the NF service consumer subscribed to the "CHARGING\_CORRELATION" event, the "event" attribute set to "CHARGING\_CORRELATION" and may include the "anChargIds" attribute containing the access network charging identifier(s) and the "anChargAddr" attribute containing the access network charging address. + +The NF service consumer notification of other specific events using the Npcf\_PolicyAuthorization\_Notify request is described in the related clauses. + +Upon the reception of the HTTP POST request from the PCF indicating that the PDU session and/or service related event occurred, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the PCF is accepted, the NF service consumer shall acknowledge the receipt of the event notification with a "204 No Content" response to HTTP POST request, as shown in figure 4.2.5.2-1, step 2. + +If the HTTP POST request from the PCF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 4.2.5.3 Notification about application session context termination + +This procedure is invoked by the PCF to notify the NF service consumer that the application session context is no longer valid, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.5.3-1 illustrates the notification about application session context termination. + +![Sequence diagram showing the notification about application session context termination between an NF service consumer and a PCF. The PCF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content status.](8395ccdee8a80af834aca2bdfd7f9a9b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of PCF: 1. POST « {notifUri}/terminate + PCF->>NF service consumer: 1. POST « {notifUri}/terminate + Note left of NF service consumer: 2. "204 No Content" + NF service consumer-->>PCF: 2. "204 No Content" + +``` + +Sequence diagram showing the notification about application session context termination between an NF service consumer and a PCF. The PCF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content status. + +Figure 4.2.5.3-1: Notification about application session context termination + +When the PCF determines that the AF application session context is no longer valid, the PCF shall invoke the Npcf\_PolicyAuthorization\_Notify service operation by sending the HTTP POST request (as shown in figure 4.2.5.3-1, step 1) using the notification URI received in the "Individual Application Session Context" context creation, as specified in clause 4.2.2 and clause 4.2.6.3, and appending the "terminate" segment path at the end of the URI, to trigger the NF service consumer to request the application session context termination (see clause 4.2.4.2). The PCF shall provide in the body of the HTTP POST request the "TerminationInfo" data type including: + +- the Individual Application Session Context resource identifier related to the termination notification in the "resUri" attribute; and +- the application session context termination cause in the "termCause" attribute of the "TerminationCause" data type, indicating: + - i) "PDU\_SESSION\_TERMINATION" when the PCF received from the SMF the indication of SM Policy Context termination without a specific PDU session release cause value; + - ii) "ALL\_SDF\_DEACTIVATION" when the PCF received from the SMF the indication that all the SDFs of the Individual Application Session Context resource are deactivated or all resource allocation of an Individual Application Session Context fails because other reasons than "PS\_TO\_CS\_HAN"; + - iii) "PS\_TO\_CS\_HO" if the "IMS\_SBI" feature is supported and the PCF received from the SMF: + - a) the PDU session release cause value "PS\_TO\_CS\_HO"; or + - b) the failure code value "PS\_TO\_CS\_HAN" for all the SDFs of the Individual Application Session Context resource; + - iv) "INSUFFICIENT\_SERVER\_RESOURCES" when the PCF is overloaded; + - v) "INSUFFICIENT\_QOS\_FLOW\_RESOURCES" when the PCF received that the maximum number of QoS flows for the PDU session is reached or there was a QoS flow resource limitation error; or + - vi) "SPONSORED\_DATA\_CONNECTIVITY\_DISALLOWED" when the PCF detects that due to operator policy the UE accessing the sponsored data connectivity is disallowed. + +Upon the reception of the HTTP POST request from the PCF requesting the application session context termination, the NF service consumer shall acknowledge that request by sending an HTTP response message with the corresponding status code. + +If the HTTP POST request from the PCF is accepted, the NF service consumer shall acknowledge the receipt of the application session context termination request with a "204 No Content" response to HTTP POST request (as shown in figure 4.2.5.3-1, step 2) and shall invoke the Npcf\_PolicyAuthorization\_Delete service operation to the PCF as described in clause 4.2.4. + +If the HTTP POST request from the PCF is not accepted, the NF service consumer shall indicate in the response to HTTP POST request the cause for the rejection as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +#### 4.2.5.4 Notification about Service Data Flow QoS notification control + +When the PCF gets the knowledge that one or more SDFs: + +- cannot guarantee the GBR QoS targets; or +- can guarantee again the GBR QoS targets; + +the PCF shall inform the NF service consumer accordingly if the AF has previously subscribed as described in clauses 4.2.2.6 and 4.2.3.6. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "QOS\_NOTIF" in the "event" attribute; and +- the "qncReports" array with: + - a) the "notifType" attribute to indicate whether the GBR targets for the indicated SDFs are "NOT\_GUARANTEED" or "GUARANTEED" again; + - b) the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable; and + - c) if the "AuthorizationWithRequiredQoS" feature or the "AltSerReqsWithIndQoS" feature as defined in clause 5.8 is supported, the reference to the Alternative Service Requirement corresponding alternative QoS parameter set if received from the SMF within the "altSerReq" attribute. When the "altSerReq" attribute is omitted and the "notifType" attribute is NOT\_GUARANTEED, it indicates that the lowest priority alternative service requirement could not be fulfilled. + +When the "AuthorizationWithRequiredQoS" and "AltQoSProfilesSupportReport" features as defined in clause 5.8 are supported, and the AF included during the media component provisioning the "altSerReqs" attribute for the concerned media component(s), or the "AltSerReqsWithIndQoS" and "AltQoSProfilesSupportReport" features are supported and the AF included during media component provisioning the "altSerReqsData" attribute for the concerned media component(s), if the PCF receives from the SMF the indication that the GBR QoS targets cannot be guaranteed and the indication that alternative QoS profiles are not supported in the NG-RAN where the UE is currently located as specified in 3GPP TS 29.512 [8], the PCF may include within the QosNotificationControlInfo data structure the "altSerReqNotSuppInd" attribute set to true. When the Alternative QoS profiles are supported by the NG-RAN where the UE is currently located, the PCF may omit or set the "altSerReqNotSuppInd" attribute to false, as indicated by the SMF. + +If "MediaComponentVersioning" feature is supported, and if the content version was included when the corresponding media component was provisioned, the "flows" attribute shall also contain the "contVers" attribute including the content version(s) of the media components. The PCF shall include more than one entry in the "contVers" attribute for the same media component if the PCF has received multiple content versions as described in clause 4.2.6.2.14 in 3GPP TS 29.512 [8]. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. The NF service consumer may also update the AF application session context information by sending an HTTP PATCH request to the PCF. + +Signalling flows for Service Data Flow QoS notification control are presented in 3GPP TS 29.513 [7]. + +#### 4.2.5.5 Notification about Service Data Flow Deactivation + +When the PCF gets the knowledge that one or more SDFs have been deactivated, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 4.2.2.7 and 4.2.3.7. + +When not all the service data flows within the AF application session context are affected, the PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include within the "evNotifs" attribute an event of "AfEventNotification" data type indicating the matched event ("FAILED\_RESOURCES\_ALLOCATION" if the resources could not be allocated or "UE\_TEMPORARILY\_UNAVAILABLE" if the UE was temporarily unavailable) in the "event" attribute and the deactivated service data flows (if not all the flows are affected) encoded in the "flows" attribute. + +NOTE 1: If the PCF detects that the PCC rules related to an AF application session context cannot be installed or modified because there is a temporary network failure (e.g. SGW failed according to clause B.3.3.3 or B.3.4.9 of 3GPP TS 29.512 [8]) and if requested by the AF, the PCF can notify the AF of the event "FAILED\_RESOURCES\_ALLOCATION". + +If the "MediaComponentVersioning" feature is supported, and if the content version was included when the corresponding media component was provisioned as described in clause 4.2.5.8, the PCF shall also include in the "flows" attribute the "contVers" attribute with the content version(s) of the media components. + +If the "RAN-NAS-Cause" feature is supported and the PCF received the RAN-NAS release cause and access network information from the SMF, the PCF shall provide in the "EventsNotification" data type of the HTTP POST request: + +- in case of 3GPP access, the user location information in the "eutraLocation" or in the "nrLocation" attribute in the "ueLoc" attribute, if available; +- in case of untrusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute; + - b) the UDP source port or the TCP source port in the "portNumber" and "protocol" attributes, if available; and + - c) if the "WLAN\_Location" feature is supported, the WLAN location information encoded in the "twapId" attribute, if available, that shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; + +NOTE 2: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute. + +- in case of trusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; and + - b) the UDP source port in the "portNumber" attribute if available; and + +NOTE 3: The UDP protocol can be used between the UE and the TNGF to enable NAT traversal. + +- c) either the TNAP identifier encoded in the "tnapId" attribute or the TWAP identifier encoded in the "twapId" attribute. The TNAP identifier and the TWAP identifier shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; +- the serving network identity i.e. the PLMN Identifier (the PLMN network code and the country code) or the SNPN Identifier (the PLMN Identifier and the NID) in the "plmnId" attribute, if user location information is not available in any access; +- the UE timezone in the "ueTimeZone" attribute if available; and +- the RAN and/or NAS release cause in the "ranNasRelCauses" attribute, if available. + +NOTE 4: The PCF forwards both 3GPP and non-3GPP access UE locations in the "ueLoc" attribute when both UE locations are provided by the SMF as defined in 3GPP TS 29.512 [8]. + +The PCF shall include in the "evNotifs" attribute, together with the event "FAILED\_RESOURCES\_ALLOCATION", an event of the "AfEventNotification" data type with the "event" attribute set to the value "RAN\_NAS\_CAUSE". + +The PCF shall include more than one entry in the "contVers" attribute for the same media component if the PCF has received multiple content versions as described in clause 4.2.6.2.14 in 3GPP TS 29.512 [8]. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. The NF service consumer may also update the AF application session context information by sending an HTTP PATCH request to the PCF. + +When all the service data flows within the AF session are affected, the PCF shall inform the NF service consumer by sending a notification about application session context termination as defined in clause 4.2.5.3. + +Signalling flows for Service Data Flow Deactivation cases are presented in 3GPP TS 29.513 [7]. + +#### 4.2.5.6 Reporting usage for sponsored data connectivity + +When "SponsoredConnectivity" is supported, the NF service consumer enabled sponsored data connectivity and the NF service consumer provided usage thresholds for such sponsor to the PCF, the PCF shall report accumulated usage to the NF service consumer using the Npcf\_PolicyAuthorization\_Notify service operation when: + +- the PCF detects that the usage threshold provided by the NF service consumer has been reached; or +- the NF service consumer disables the sponsored data connectivity. + +The PCF shall notify the NF service consumer of the accumulated usage by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- an event of the "AfEventNotification" data type in the "evNotifs" attribute with the matched event "USAGE\_REPORT" in the "event" attribute; and +- the accumulated usage, corresponding to the usage since the last report to the AF, encoded in the "usgRep" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. The NF service consumer may terminate the AF session sending an HTTP POST as described in clause 4.2.4.2 or update the AF application session context information by providing a new usage threshold sending an HTTP PATCH request to the PCF as described in clause 4.2.3.5 or an HTTP PUT request to the PCF as described in clause 4.2.6.4. + +NOTE: Once the accumulated usage is reported by the PCF to the AF, the monitoring will not start until the PCF receives the new threshold from the NF service consumer and provides it to the SMF. + +#### 4.2.5.7 Void + +#### 4.2.5.8 Notification about resources allocation outcome + +When the PCF becomes aware that the resources associated to service information for one or more SDFs have been allocated, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "SUCCESSFUL\_RESOURCES\_ALLOCATION" event as described in clauses 4.2.2.10 and 4.2.3.10. The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. The PCF shall include in the "evNotifs" attribute an entry with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION" and (if not all the flows are affected) the identification of the related media components in the "flows" attribute. If the "MediaComponentVersioning" feature is supported, the PCF shall also include in the "flows" attribute the "contVers" attribute with the content version(s) of the media components if the content version was included when the corresponding media component was provisioned. + +If the "AuthorizationWithRequiredQoS" feature or the "AltSerReqsWithIndQoS" feature as defined in clause 5.8 is supported, when the PCF becomes aware that the resources associated to service information for one or more SDFs have been allocated and additionally receives the alternative QoS parameter set(s), the PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. The PCF shall include: + +- an entry in the "evNotifs" attribute with the "event" attribute set to "SUCCESSFUL\_RESOURCES\_ALLOCATION"; and +- the "succResourcAllocReports" attribute with the reference to the Alternative Service Requirement corresponding alternative QoS parameter set within the "altSerReq" attribute and the identification of the related media components in the "flows" attribute. If the "MediaComponentVersioning" feature is supported, the PCF shall also include in the "flows" attribute the "contVers" attribute with the content version(s) of the media components if the content version was included when the corresponding media component was provisioned. + +When the PCF becomes aware that the resources associated to service information for one or more SDFs cannot be allocated, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "FAILED\_RESOURCES\_ALLOCATION" event as described in clauses 4.2.2.10 and 4.2.3.10. The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. The PCF shall include: + +- an entry in the "evNotifs" attribute with the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION"; and +- the "failedResourcAllocReports" attribute with the active/inactive status of the PCC rules related to certain media components encoded in the "mcResourcStatus" attribute, and (if not all the flows are affected) the identification of the related media components in the "flows" attribute. If the "MediaComponentVersioning" feature is supported, the PCF shall also include in the "flows" attribute the "contVers" attribute with the content version(s) of the media components if the content version was included when the corresponding media component was provisioned. + +When the feature "UEUnreachable" is supported and if the PCF becomes aware that the UE is temporarily unavailable and thus the resources associated to service information for one or more SDFs are not allocated, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "UE\_TEMPORARILY\_UNAVAILABLE" event as described in clauses 4.2.2.10 and 4.2.3.10. The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. The PCF shall include: + +- an entry in the "evNotifs" attribute with the "event" attribute set to "UE\_TEMPORARILY\_UNAVAILABLE", +- the "failedResourcAllocReports" attribute with the active/inactive status of the PCC rules related to certain media components encoded in the "mcResourcStatus" attribute, and (if not all the flows are affected) the identification of the related media components in the "flows" attribute. If the "MediaComponentVersioning" feature is supported, the PCF shall also include in the "flows" attribute the "contVers" attribute with the content version(s) of the media components if the content version was included when the corresponding media component was provisioned; and +- the "retryAfter" attribute if this information was received from the SMF. + +The PCF shall include more than one entry in the "contVers" attribute for the same media component if the PCF has received multiple content versions as described in clause 4.2.6.2.14 in 3GPP TS 29.512 [8]. + +NOTE: The NF service consumer will use the content version to identify the media component version that failed or succeeded when multiple provisions of the same media component occur in a short period of time. How the NF service consumer handles such situations is out of scope of this specification. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +Signalling flows for resource allocation outcome are presented in 3GPP TS 29.513 [7]. + +#### 4.2.5.9 Void + +#### 4.2.5.10 Notification of signalling path status + +When the PCF is notified of the loss or release of resources associated to the PCC rules corresponding with AF signalling IP flows, the PCF shall inform the NF service consumer about the loss of the signalling transmission path if the NF service consumer has previously subscribed as described in clause 4.2.6.7. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include within the "evNotifs" attribute an event of "AfEventNotification" data type indicating the matched event "FAILED\_RESOURCES\_ALLOCATION" in the "event" attribute and the deactivated IP flow encoded in the "flows" attribute. + +If the "RAN-NAS-Cause" feature is supported and the PCF received the RAN-NAS release cause and/or access network information from the SMF, the PCF shall provide in the "EventsNotification" data type in the "200 OK" response to the HTTP POST request: + +- in case of 3GPP access, the user location information in the "eutraLocation" or in the "nrLocation" attribute in the "ueLoc" attribute, if available; +- in case of untrusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute; and + - b) the UDP source port or the TCP source port in the "portNumber" and "protocol" attributes, if available; and + - c) if the "WLAN\_Location" feature is supported, the WLAN location information encoded in the "twapId" attribute, if available, that shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; + +NOTE 1: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute. + +- in case of trusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if available, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; and + - b) the UDP source port in the "portNumber" attribute if available; and + +NOTE 2: The UDP protocol can be used between the UE and the TNGF to enable NAT traversal. + +- c) either the TNAP identifier encoded in the "tnapId" attribute or the TWAP identifier encoded in the "twapId" attribute. The TNAP identifier and the TWAP identifier shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; +- the serving network identity i.e. the PLMN Identifier (the PLMN network code and the country code) or the SNPN Identifier (the PLMN Identifier and the NID) in the "plmnId" attribute, if user location information is not available in any access; +- the UE timezone in the "ueTimeZone" attribute if available; and +- the RAN and/or NAS release cause in the "ranNasRelCauses" attribute, if available. + +NOTE 3: The PCF forwards both 3GPP and non-3GPP access UE locations in the "ueLoc" attribute when both UE locations are provided by the SMF as defined in 3GPP TS 29.512 [8]. + +The PCF shall include in the "evNotifs" attribute, together with the event "FAILED\_RESOURCES\_ALLOCATION", an event of the "AfEventNotification" data type with the "event" attribute set to the value "RAN\_NAS\_CAUSE". + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +#### 4.2.5.11 Reporting access network information + +This procedure is used by the PCF to report the access network information (i.e. user location and/or user timezone information) to the NF service consumer when the "NetLoc" feature is supported. + +When the PCF receives the access network information from the SMF, the PCF shall include the "EventsNotification" data type in the body of the HTTP POST request message sent to the NF service consumer as described in clause 4.2.5.2. The PCF shall include in the "EventsNotification" data type: + +- in case of 3GPP access, the user location information in the "eutraLocation" or in the "nrLocation" attribute in the "ueLoc" attribute, if available and required; +- in case of untrusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if required, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; + - b) the UDP source port or the TCP source port in the "portNumber" and "protocol" attributes, if available; and + - c) if the "WLAN\_Location" feature is supported, the WLAN location information encoded in the "twapId" attribute, if available, that shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; + +NOTE 1: When the UE reaches the ePDG via a NAT, the combination of UE local IP address and the UE source port is needed for lawful interception purposes. The UE source port may be either a UDP or a TCP port, and it is indicated in the "protocol" attribute. + +- in case of trusted non-3GPP access, the user location information in the "n3gaLocation" attribute in the "ueLoc" attribute, if required, as follows: + - a) the user local IP address in the "ueIpv4Addr" or "ueIpv6Addr" attribute, if available; and + - b) the UDP source port in the "portNumber" attribute if available; and + +NOTE 2: The UDP protocol can be used between the UE and the TNGF to enable NAT traversal. + +- c) either the TNAP identifier encoded in the "tnapId" attribute or the TWAP identifier encoded in the "twapId" attribute. The TNAP identifier and the TWAP identifier shall consist of: + - i. the SSID in the "ssid" attribute; + - ii. the BSSID the "bssId" attribute if available; and + - iii. the civic address in the "civicAddress" attribute if available; +- if user location was required, the time when it was last known in the "ueLocTime" attribute if available; + +NOTE 3: The PCF derives the value of the "ueLocTime" attribute from the "userLocationInfoTime" attribute received from the SMF as specified in 3GPP TS 29.512 [8]. + +- the serving network identity i.e. the PLMN Identifier (the PLMN network code and the country code) or the SNPN Identifier (the PLMN Identifier and the NID) in the "plmnId" attribute, if user location information is required but not available in any access; and/or +- the UE timezone in the "ueTimeZone" attribute if required and available. + +NOTE 4: The PCF forwards both 3GPP and non-3GPP access UE locations in the "ueLoc" attribute when both UE locations are provided by the SMF as defined in 3GPP TS 29.512 [8]. + +When the PCF receives from the SMF that the access network does not support access network information report, the PCF shall include the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED", "TZR\_NOT\_SUPPORTED" or "LOC\_NOT\_SUPPORTED" value received from the SMF in the "EventsNotification" data type in the "200 OK" response to the HTTP POST request. + +The PCF shall also include an event of the "AfEventNotification" data type in the "evNotifs" attribute with the "event" attribute set to the value "ANI\_REPORT". + +NOTE 5: The PCF receives the access network information from the SMF if it is previously requested by the NF service consumer or at PDU session termination or at the termination of all the service data flows of the AF session. + +The PCF shall not invoke the Npcf\_PolicyAuthorization\_Notify service operation with the "event" attribute set to the value "ANI\_REPORT" to report to the NF service consumer any subsequently received access network information, unless the NF service consumer sends a new request for access network information. + +#### 4.2.5.12 Notification about Out of Credit + +If the "IMS\_SBI" feature is supported and if the PCF becomes aware that there is no credit available in the CHF for one or more SDFs, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "OUT\_OF\_CREDIT" event as described in clauses 4.2.2.22 and 4.2.3.22. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- in the "evNotifs" attribute an entry with the "event" attribute set to the value "OUT\_OF\_CREDIT"; and +- the "outOfCredReports" attribute containing in each entry of the "OutOfCreditInformation" data type the credit information for one or more service data flows. The "OutOfCreditInformation" data type shall contain the termination action in the "finUnitAct" attribute, and the identification of the affected service data flows (if not all the flows are affected) encoded in the "flows" attribute. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message as described in clause 4.2.5.2. + +#### 4.2.5.13 Notification about TSC user plane node management information and/or port management information detection, Individual Application Session Context exists + +During the lifetime of a PDU session enabling Time Sensitive Communication, Time Synchronization and/or Deterministic Networking, the SMF may send to the PCF TSC user plane node management information of the UPF/NW-TT within a UMIC and/or, when the DS-TT or the NW-TT functions are used, a PMIC from the DS-TT port and/or one or more PMIC(s) from the one or more NW-TT ports. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported and if the PCF becomes aware that updated TSC user plane node information is available, e.g., a UMIC and/or PMIC(s) have been received, for the SM Policy Association bound to the Individual Application Session Context resource,, the PCF shall inform the NF service consumer (i.e., the TSN AF or the TSCTSF) accordingly, if the NF service consumer has previously subscribed as described in clause 4.2.2.31. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include in the "evNotifs" attribute an entry with the "event" attribute set to the value "TSN\_BRIDGE\_INFO", and the "tsnBridgeManCont" attribute and/or the "tsnPortManContDstt" attribute and/or the "tsnPortManContNwtt" attribute as received from the SMF if the PCF is aware that a UMIC and/or a DS-TT PMIC and/or one or more NW-TT PMIC(s) are available or updated. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request as specified in clause 4.2.5.2. + +The NF service consumer may use the received UMIC and/or the received DS-TT PMIC and/or NW-TT PMIC(s) and the local configuration to construct the DS-TT port and or NW-TT port management information required to interwork with the external network (e.g. TSN). + +If port management information shall be sent as a response of the received notification, the NF service consumer triggers the Npcf\_PolicyAuthorization\_Update service operation to send the port management information to the PCF as specified in clause 4.2.3. The NF service consumer delivers to the PCF the derived port management information containers as described in clause 4.2.3.25. + +And/or if TSC user plane node management information shall be sent as a response of the received notification, the NF service consumer includes the UMIC in the Npcf\_PolicyAuthorization\_Update service operation as described in clause 4.2.3.25. + +#### 4.2.5.14 Notification about Service Data Flow QoS Monitoring control + +When the PCF gets the information about real-time measurements of QoS parameters for one or more SDFs from the SMF (e.g. for QoS monitoring for packet delay, uplink packet delay(s), downlink packet delay(s) and/or round trip delay(s) or if the feature "PacketDelayFailureReport" is supported, indicator of packet delay measurement failure) the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 4.2.2.23 and 4.2.3.23 and 4.2.6.8. + +The PCF shall notify the NF service consumer of the QoS monitoring events by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "QOS\_MONITORING" in the "event" attribute; and +- for QoS monitoring for packet delay, the "qosMonReports" array with: + - a) the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable; and, for QoS monitoring for packet delay: + - b) one or two uplink packet delays within the "ulDelays" attribute; + - c) one or two downlink packet delays within the "dlDelays" attribute; + - d) one or two round trip packet delays within the "rtDelays" attribute; and/or + - e) if the feature "PacketDelayFailureReport" is supported, the packet delay measurement failure indicator within the "pdmf" attribute; +- if the feature "EnQoSMon" is supported, to report data rate measurements, the "qosMonDatRateReps" array with: + - a) the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable; + - b) one data rate measurement for the UL within the "ulDataRate" attribute; and/or + - c) one data rate measurement for the DL within the "dlDataRate" attribute. + +**Editor's note:** Whether Data Rate monitoring requires the report of the maximum and minimum calculated during the waiting time is FFS. + +- if the feature "EnQoSMon" is supported, for QoS monitoring for congestion information, the "congestReports" array with: + - a) the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable; and + - b) the uplink congestion information measurement(s) within the "ulConInfo" attribute; + - c) the downlink congestion information measurement(s) within the "dlConInfo" attribute; or + - d) the congestion information measurement failure indicator within the "cimf" attribute. + +#### 4.2.5.15 Report of EPS Fallback + +When "EPSFallbackReport" feature is supported and the PCF becomes aware of the EPS Fallback for the resources requested for a particular service information (voice media type), the PCF shall inform the NF service consumer if the NF service consumer has previously subscribed as described in clauses 4.2.2.30 and 4.2.3.29. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "EPS\_FALLBACK" in the "event" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +#### 4.2.5.16 Notification about TSC user plane node Information, no Individual Application Session Context exists + +During PDU session establishment of a PDU session enabling Time Sensitive Communications, Time Synchronization and Deterministic Networking, the PCF may receive from the SMF TSC user plane node information as specified in clauses 4.2.2.19 and 4.2.3.23 of 3GPP TS 29.512 [8]. + +If the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported and if the PCF becomes aware that TSC user plane node information for an external network (e.g. TSN) is available, but there is no "Individual Application Session Context" resource bound to the SM Policy Association updated with TSC user plane node related information, the PCF shall inform the NF service consumer (i.e. TSN AF or TSCTSF) about the detection of a TSC user plane node information in the context of a PDU session by sending a notification request: + +- to the request URI locally configured in the PCF for the NF service consumer; or +- if the request URI for the TSCTSF is not locally configured in the PCF, to the notification URI registered by the TSCTSF in the NRF as default notification subscription for time sensitive communication, time synchronization and deterministic networking notifications, and retrieved from NRF by the PCF using the discovery service, as specified in 3GPP TS 29.510[27] for the PDU session DNN/S-NSSAI. + +NOTE 1: PCF configuration of TSN AF needs to ensure that the notification is addressed to a TSN AF that connects to the same external network the UPF/NW-TT connects to. How it is achieved is implementation specific. It can be based e.g. on dedicated DNN/S-NSSAI combinations or on the received TSC user plane node information. + +NOTE 2: It is assumed that there is only one TSCTSF for a given DNN/S-NSSAI in this release of the specification. + +Figure 4.2.5.16-1 illustrates the notification about TSC user plane node information when there is no Individual Application Session Context bound to the SM Policy Association. + +![Sequence diagram showing the notification process between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 204 No Content status.](b0666d7acc98c96f24d88c97bbd7cae7_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note left of NF service consumer: NF service consumer + Note right of PCF: PCF + NF service consumer->>PCF: 1. POST « {notifUri}/new-bridge + PCF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the notification process between an NF service consumer and a PCF. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 204 No Content status. + +Figure 4.2.5.16-1: Notification about TSC user plane node Information, no AF session context exists + +When the PCF determines that the AF application session context does not exist for the SM Policy Association that detected new port information and a notification URI for the NF service consumer can be determined, the PCF shall invoke the Npcf\_PolicyAuthorization\_Notify service operation by sending the HTTP POST request (as shown in figure 4.2.5.16-1, step 1) using the notification URI locally configured in the PCF or, retrieved from NRF, and appending the "new-bridge" segment path at the end of the URI, to trigger the NF service consumer (i.e. TSN AF or TSCTSF) to request the creation of an Individual Application Session Context resource to handle the TSC user plane node detected in the context of a PDU session, configuring ports and TSC user plane node management information, and providing the corresponding TSCAI input containers and TSC traffic QoS related data (see clauses 4.2.2.2, 4.2.2.24, 4.2.2.25 and 4.2.2.31). + +The PCF shall provide in the body of the HTTP POST request the "PduSessionTsnBridge" data type including TSC user plane node information as follows: + +- the "tsnBridgeInfo" attribute as received from the SMF; +- when DS-TT and/or NW-TT functionality is used, the "tsnPortManContDstt" attribute and/or "tsnPortManContNwtt" attribute as received from the SMF, if available; +- in case of Deterministic Networking, for the device side port, and if the "MTU\_Size" feature is supported, the MTU size for IPv4 and the MTU size for IPv6 encoded in the "mtulpv4" and "mtulpv6" attributes respectively, if available; and +- when the "TimeSensitiveCommunication" feature is supported and for a PDU session of IP type, the UE IPv4 address within the "ueIpv4Addr" attribute or the UE IPv6 prefix within the "ueIpv6AddrPrefix", the DNN within the "dnn" attribute, the S-NSSAI within the "snssai" attribute and, if available, the domain identity within the "ipDomain" attribute if UE IPv4 address is provided. + +NOTE 3: In the case of IP overlapping, the DNN, S-NSSAI and domain identity, if available, are required for session binding in the PCF. Domain identity applies as defined in clause 4.2.2.2. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request. + +With the received information, the NF service consumer (i.e. TSN AF or TSCTSF) shall immediately trigger the creation of an Individual Application Session Context resource to handle in this association the configuration of the new TSC user plane node in the context of this PDU session, as described in clauses 4.2.2.2, 4.2.2.24, 4.2.2.25 and 4.2.2.31. + +NOTE 4: For the time synchronization service, the subscription to UE availability for time-synchronization service can occur after the PDU Session establishment has been completed in 5GS. Similarly, for the AF session with required QoS, the indication of the required QoS and TSC Assistance Container information can occur after the completion of the PDU session establishment. In such cases, the PCF sends the notification to the TSCTSF about the detection of a TSC user plane node information during PDU session establishment, and the TSCTSF could defer the creation of the related "Individual Application Session Context" till the reception of the subscription to UE availability for time synchronization or the AF session with required QoS occurs, as specified in 3GPP TS 29.513[7]. + +The NF service consumer (i.e. TSN AF or TSCTSF) may use the received TSC user plane node information and/or the received DS-TT port management information container and/or NW-TT port management information containers and the local configuration to construct the DS-TT port and or NW-TT port management information required to interwork with the external network. + +#### 4.2.5.17 Notification about Reallocation of Credit + +If the "IMS\_SBI" and the "ReallocationOfCredit" features are supported and if the PCF becomes aware that there is credit reallocated for one or more SDFs after a former out of credit indication, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "REALLOCATION\_OF\_CREDIT" event as described in clauses 4.2.2.34 and 4.2.3.32. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include in the "evNotifs" attribute an entry with: + +- the "event" attribute set to the value "REALLOCATION\_OF\_CREDIT"; and + +- the SDFs that are impacted as consequence of the reallocation of credit condition encoded in the "flows" attribute. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message as described in clause 4.2.5.2. + +#### 4.2.5.18 Notification of MPS for DTS Outcome + +When the MPSforDTS feature is supported and the PCF is informed about the successful default QoS update, the PCF shall notify the NF service consumer as described in clause 4.2.5.2, if the NF service consumer has previously subscribed to the "SUCCESSFUL\_QOS\_UPDATE" event as described in clauses 4.2.2.12.2 and 4.2.3.12. The PCF shall notify the NF service consumer by including within the "evNotifs" attribute, an entry with the "event" attribute set to "SUCCESSFUL\_QOS\_UPDATE". + +When the MPSforDTS feature is supported and the PCF is informed about the failure of a default QoS update, the PCF shall notify the NF service consumer as described in clause 4.2.5.2, if the NF service consumer has previously subscribed to the "FAILED\_QOS\_UPDATE" event as described in clauses 4.2.2.12.2 and 4.2.3.12. The PCF shall notify the NF service consumer by including within the "evNotifs" attribute, an entry with the "event" attribute set to "FAILED\_QOS\_UPDATE". + +#### 4.2.5.19 Notification about Application Detection Information + +When the "ApplicationDetectionEvents" feature is supported, when the PCF gets the knowledge that the traffic of the indicated application started or stopped, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 4.2.6.9. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include, for the detected application(s)'s traffic: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "APP\_DETECTION" in the "event" attribute; and +- the "adReports" array, which for each detected application's traffic shall include: + - a) the "adNotifyType" attribute to indicate whether the detection is about the start of the application's traffic encoded as the "APP\_START" value, or about the stop of the application's traffic encoded as the "APP\_STOP" value; and + - b) the application identifier within the "afAppId" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +Signalling flows for the notification of application detection information are presented in 3GPP TS 29.513 [7]. + +NOTE: When the NF service consumer receives the notifications for multiple applications, the NF service consumer (e.g. the PCF for the UE) can determine which logic to apply (e.g. which AM policy to apply) based on local configuration and operator policy. + +In this release of the specification application detection applies only to the application(s) with IP traffic. + +#### 4.2.5.20 Notification about satellite backhaul category changes + +When the PCF gets the knowledge that there is a change of the backhaul used for the PDU session between satellite backhaul categories or between a satellite and a non-satellite backhaul category, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clauses 4.2.2.35 and 4.2.3.33 and 4.2.6.10. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +When the "SatelliteBackhaul" feature is supported, the PCF shall include within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "SAT\_CATEGORY\_CHG" in the "event" attribute, and within the "satBackhaulCategory" attribute the received satellite backhaul category or the indication of non-satellite backhaul. When the "EnSatBackhaulCatChg" feature is supported and the PCF received the dynamic satellite backhaul category, the PCF shall include the dynamic satellite backhaul category within the "satBackhaulCategory" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. The NF service consumer may also update the AF application session context information by sending an HTTP PATCH request to the PCF. + +#### 4.2.5.21 Notification about UP change enforcement failure + +If the "RoutingReqOutcome" feature is supported and if the PCF becomes aware that the enforcement of the UP path change fails (as specified in clause 4.2.6.2.6.2 of 3GPP TS 29.512 [8]), the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "UP\_PATH\_CHG\_FAILURE" event as described in clauses 4.2.2.8 and 4.2.3.8. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include in the "evNotifs" attribute an entry with the "event" attribute set to the value "UP\_PATH\_CHG\_FAILURE". + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message as described in clause 4.2.5.2. + +#### 4.2.5.22 Notification about PDU session established/terminated events + +If the PCF becomes aware that the SM Policy Association contains the callback URI of the PCF for a UE then, the PCF shall inform the NF service consumer (i.e. the PCF for a UE) about: + +- the PDU session establishment, when the PCF receives the callback URI of the PCF for a UE from the SMF; and +- the PDU session termination, when the PCF receives the SM Policy Association termination from the SMF; + +by sending a notification request to the received callback URI of the PCF for a UE. + +Figure 4.2.5.22-1 illustrates the notification about PDU session established/terminated events. + +![Sequence diagram showing the notification about PDU session established/terminated events between an NF service consumer and a PCF.](0c5f3d0d14479b9e784d595fecd6dba5_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of PCF: 1. POST « {notifUri}/pdu-session + PCF->>NF service consumer: 1. POST « {notifUri}/pdu-session + Note left of NF service consumer: 2. "204 No Content" + NF service consumer->>PCF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message is a POST request from the PCF to the NF service consumer, labeled "1. POST « {notifUri}/pdu-session". The second message is a "204 No Content" response from the NF service consumer to the PCF, labeled "2. "204 No Content"". The NF service consumer is represented by a box on the left, and the PCF is represented by a box on the right. Vertical lines extend downwards from each box, and the messages are shown as horizontal arrows between these lines. + +Sequence diagram showing the notification about PDU session established/terminated events between an NF service consumer and a PCF. + +Figure 4.2.5.22-1: Notification about PDU session established/terminated events + +When the PCF becomes aware that a SM Policy Association is receiving the callback URI of the PCF for a UE, or becomes aware that the SM Policy Association that is terminating contains the callback URI of the PCF for a UE, the PCF shall invoke the Npcf\_PolicyAuthorization\_Notify service operation by sending an HTTP POST request (as shown in figure 4.2.5.22-1, step 1) using the callback URI contained in the SM Policy Association and appending the "pdu-session" path segment at the end of the URI. + +NOTE: The PCF includes in the notification request a Routing Binding Indication as specified in 3GPP TS 29.500 [5], clause 6.12 if an SBA binding indication relative to the PCF for a UE is available in the SM Policy Association together with the callback URI of the PCF for a UE. + +The PCF shall provide in the body of the HTTP POST request the PduSessionEventNotification data type, which shall include an indication of PDU session establishment/termination as follows: + +- the "evNotif" attribute, of "AfEventNotification" data type, which shall include the "PDU\_SESSION\_STATUS" event within the "event" attribute; +- the SUPI of the PDU session within the "supi" attribute; +- the served UE address as the identification of the reported PDU session: + - i. for IP type PDU sessions, the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute; and + - ii. for Ethernet type PDU sessions, the MAC address of the UE in the "ueMac" attribute; +- whether the PDU session is established or terminated within the "status" attribute; and +- when the "status" attribute indicates "ESTABLISHED": + - i. the PCF addressing information where the NF service consumer (i.e. PCF for a UE) may send the subscription request to notification about the detected application traffic in the "pcfInfo" attribute; and + - ii. the context information of the related PDU session, i.e., the DNN withing the "dnn" attribute, the S-NSSAI within the "snssai" attribute and the GPSI within the "gpsi" attribute, if available. + +Upon the reception of the HTTP POST request from the PCF, and if the request is accepted, the NF service consumer (i.e. PCF for a UE) shall acknowledge that request by sending an HTTP response message with a "204 No Content" status code as described in figure 4.2.5.22-1, step 2. + +The NF service consumer (i.e. PCF for a UE) may use the notified PCF address(es) and SBA binding indication, if available, to subscribe with the PCF for a PDU session to the detection of application(s) traffic, as described in clause 4.2.6.9. + +#### 4.2.5.23 Notification about extra UE addresses + +When the "ExtraUEaddrReport" feature is supported, and the PCF becomes aware that the there is a change in the list of IP addresses or address ranges allocated to the PDU session due to framed routes or IPv6 prefix delegation (as described in 3GPP TS 29.512 [8], clauses 4.2.4.2 and C.3.4.1), the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "EXTRA\_UE\_ADDR" event as described in clauses 4.2.2.36, 4.2.3.35 and 4.2.6.12. The report shall include the actual list of IPv4 addresses or list of IPv6 prefixes as currently allocated. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include in the "evNotifs" array an entry with the "event" attribute set to the value "EXTRA\_UE\_ADDR" and: + +- the actual list of IPv4 addresses within the "ipv4AddrList" attribute, if there was a change in the one or more IPv4 framed routes associated to the PDU session; or +- the actual list of IPv6 prefixes allocated to the UE within the "ipv6PrefixList" attribute, if there was a change in the one or more IPv6 framed routes associated to the PDU session, or in the one or more IPv6 prefixes allocated to the PDU session. + +NOTE: In this release of the specification the IP Framed Routes are received by the PCF during PDU session establishment and remain unchanged during the lifetime of the PDU session. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message as described in clause 4.2.5.2. + +#### 4.2.5.24 Notification about BAT offset + +If the "EnTSCAC" feature is supported, upon receiving the BAT offset and optionally the adjusted periodicity, the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed to the "BAT\_OFFSET\_INFO" event as described in clauses 4.2.2.40 and 4.2.3.24. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- in the "evNotifs" attribute an entry with the "event" attribute set to the value "BAT\_OFFSET\_INFO"; +- the "batOffsetInfo" attribute containing the offset of the BAT and the optionally adjusted periodicity. The "BatOffsetInfo" data type shall contain the BAT offset of the arrival time in the "ranBatOffsetNotif" attribute, and the optionally adjusted periodicity of the data bursts encoded in the "adjPeriod" attribute; and +- the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable. + +Upon the reception of the HTTP POST request from the PCF, the NF service consumer shall acknowledge that request by sending an HTTP response message as described in clause 4.2.5.2. + +#### 4.2.5.25 Notification about URSP rule enforcement information + +When the "URSPEnforcement" feature is supported, when the PCF gets from the UE via the SMF the report of URSP rule enforcement information from associated URSP rule(s) as defined in 3GPP TS 29.512 [8], the PCF shall inform the NF service consumer accordingly if the NF service consumer has previously subscribed as described in clause 4.2.6.14. + +The PCF shall notify the NF service consumer by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include, for the notification about URSP rule enforcement information: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "URSP\_ENF\_INFO" in the "event" attribute; +- within the "urspEnfRep" attribute, the URSP rule enforcement information received from the UE as defined in 3GPP TS 29.512 [8]; +- if not previously reported, the SSC mode within the "sscMode" attribute, the UE requested DNN, if available, within the "ueReqDnn" attribute, and if the PDU session is redundant, the RSN and the PDU session pair ID within the "redundantPduSessionInfo" attribute; and +- within the "accessType" attribute and "ratType" attribute, the access type, if available and changed compared to the latest report. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +Signalling flows for the notification of UE reporting of URSP rule enforcement are presented in 3GPP TS 29.513 [7]. + +#### 4.2.5.26 Notification about Packet Delay Variation + +When the PCF gets the information about real-time measurements of QoS parameters for one or more SDFs from the SMF (e.g. for QoS monitoring for packet delay, uplink packet delay(s), downlink packet delay(s) and/or round trip delay(s)), the PCF calculates the uplink, downlink and/or round trip Packet Delay Variations based on the received uplink, downlink or round trip QoS Monitoring result, and reports to the NF service consumer accordingly if the NF service consumer has previously subscribed to Packet Delay Variation reports as described in clauses 4.2.2.41 and 4.2.3.40. + +The PCF shall notify the NF service consumer of the Packet Delay Variation events by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "PACK\_DEL\_VAR" in the "event" attribute; and +- the "pdvMonReports" array with: + - a) the identification of the affected service flows (if not all the flows are affected) encoded in the "flows" attribute if applicable; and + - b) one or two uplink packet delay variation measurement(s) within the "ulPdv" attribute; + - c) one or two downlink packet delay variation measurement(s) within the "dlPdv" attribute; + - d) one or two round trip packet delay variation measurement(s) within the "rtPdv" attribute; and/or. + +**Editor's note:** Whether reporting packet delay variation errors is needed is FFS. + +#### 4.2.5.27 Notification about 5GS support for Policy Control for L4S. + +When the "L4S" feature is supported, the NF service consumer provided the explicit indication of ECN marking for L4S support for the provided UL and/or DL SDF(s) as described in clauses 4.2.2.43 and 4.2.3.42, and the PCF gets the knowledge that there is a change of the 5GS support for ECN marking for L4S for the indicated SDF(s), the PCF, may notify the NF service consumer about the change of 5GS support by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event, "L4S\_SUPP", in the "event" attribute and the "l4sReports" array. In each entry of the "l4sReports" array, the PCF shall include the indication that ECN marking for L4S is not available or is available again within the "notifyType" attribute and the SDFs that are impacted as consequence of change of 5GS availability condition for ECN marking for L4S encoded in the "flows" attribute. + +When the NF service consumer receives the HTTP POST request, it shall acknowledge the request by sending a "204 No Content" response to the PCF. + +#### 4.2.5.28 Notification about Round-Trip delay monitoring measurements + +Upon receiving the delay information per flow (e.g. the UL and DL are separated into two flows) from the SMF(e.g. for QoS monitoring for packet delay, uplink packet delay(s), downlink packet delay(s) and/or round trip delay(s)), the PCF calculates the Round-Trip delay and reports to the NF service consumer accordingly if the NF service consumer has previously subscribed to RTT monitoring reports as described in clauses 4.2.2.44 and 4.2.3.43. + +The PCF shall notify the NF service consumer of the RTT monitoring events by including the "EventsNotification" data type in the body of the HTTP POST request as described in clause 4.2.5.2. + +The PCF shall include: + +- within the "evNotifs" attribute an event entry of the "AfEventNotification" data type with the matched event "RT\_DELAY\_TWO\_QOS\_FLOWS" in the "event" attribute; and +- the "qosMonReports" array with: + - a) one or two round trip packet delay measurement(s) within the "rtDelays" attribute; or + - b) the packet delay measurement failure indicator within the "pdmf" attribute. + +**Editor's note:** It is FFS whether to reuse "qosMonReports" attribute or create a new "rttMonReports" attribute. + +#### 4.2.5.29 Event notification for AF requested QoS for a UE or group of UE(s) not identified by UE address(es) + +An NF service consumer (e.g., AF, NEF) may subscribe to event(s) reporting implicitly via the UDR as specified in 3GPP TS 29.519 [53] (see also clause 4.15.6.14 of 3GPP TS 23.502 [3] and clause 6.1.3.28 of 3GPP TS 23.503 [4]) when provisioning/updating AF requested QoS for a UE or a group of UE(s) not identified by UE address(es). + +Editor's Note: Whether and/or how to identify the relation with a GMEC feature is FFS. This procedure is invoked by the PCF to notify the NF service consumer(s) (e.g., NEF, AF) when such previously subscribed event(s) occur. + +When the PCF determines that event(s) occurred (e.g., upon reception of an event notification for a PDU session from the SMF as described in 3GPP TS 29.512 [8]), the PCF shall invoke the Npcf\_PolicyAuthorization\_Notify service operation as described in clause 4.2.5.2 with the following differences: + +- a. The "{notifUri}" variable part of the request URI of the HTTP POST request shall contain the callback URI included within the "notifUri" attribute contained within the "evSubsc" attribute of the corresponding AF Requested QoS Data obtained from the UDR as specified in 3GPP TS 29.519 [53]. +- b. The "EventsNotification" data type shall include within the "{appSessionId}" variable part of the "" component (see clause 5.1) of the "evSubsUri" attribute, the notification correlation identifier included within the "notifCorrelId" attribute included within the "evSubsc" attribute of the corresponding AF Requested QoS Data also obtained from the UDR as specified in 3GPP TS 29.519 [53]. + +## 4.2.6 Npcf\_PolicyAuthorization\_Subscribe service operation + +### 4.2.6.1 General + +The Npcf\_PolicyAuthorization\_Subscribe service operation enables NF service consumers handling of subscription to events for the existing application session context. Subscription to events shall be created: + +- within the application session context establishment procedure by invoking the Npcf\_PolicyAuthorization\_Create service operation, as described in clause 4.2.2; or +- within the application session context modification procedure by invoking the Npcf\_PolicyAuthorization\_Update service operation, as described in clause 4.2.3; or +- by invoking the Npcf\_PolicyAuthorization\_Subscribe service operation for the existing application session context, as described in clause 4.2.6.2. + +The following procedures using the Npcf\_PolicyAuthorization\_Subscribe service operation is supported: + +- Handling of subscription to events for the existing application session context. +- Initial subscription to events without provisioning of service information. +- Subscription to usage monitoring of sponsored data connectivity. +- Request of access network information. +- Subscription to notification of signalling path status. +- Subscription to Service Data Flow QoS Monitoring Information. +- Subscription to application detection notifications. +- Subscription to satellite backhaul category changes. +- Subscription to the report of extra UE addresses. +- Subscription to Service Data Flow QoS Monitoring multi-modal services. +- Subscription to UE reporting Connection Capabilities notification. + +### 4.2.6.2 Handling of subscription to events for the existing application session context + +This procedure is used to create a subscription to events for the existing AF application session context bound to the corresponding PDU session or to modify an existing subscription, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.6.2-1 illustrates the creation of events subscription information using HTTP PUT method. + +![Sequence diagram showing the creation of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the PCF, and the PCF responds with 201 Created.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PUT « app-sessions/{appSessionId}/events-subscription + NF service consumer->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the PCF, and the PCF responds with 201 Created. + +**Figure 4.2.6.2-1: Creation of events subscription information using HTTP PUT** + +Figure 4.2.6.2-2 illustrates the modification of events subscription information using HTTP PUT method. + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the PCF, and the PCF responds with either 204 No Content or 200 OK.](f2486d5031b55e42b300903a716b0a00_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PUT « app-sessions/{appSessionId}/events-subscription + NF service consumer->>PCF: Request + Note left of PCF: 2a. "204 No Content" +2b. "200 OK" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the PCF, and the PCF responds with either 204 No Content or 200 OK. + +**Figure 4.2.6.2-2: Modification of events subscription information using HTTP PUT** + +When the NF service consumer decides to create a subscription to one or more events for the existing application session context or to modify an existing subscription previously created by itself at the PCF, the NF service consumer shall invoke the Npcf\_PolicyAuthorization\_Subscribe service operation by sending the HTTP PUT request to the resource URI representing the "Events Subscription" sub-resource in the PCF, as shown in figure 4.2.6.2-1, step 1 and figure 4.2.6.2-2, step 1. The NF service consumer shall provide in the "EventsSubscReqData" data type of the body of the HTTP PUT request: + +- the "events" attribute with the list of events to be subscribed; and +- the "notifUri" attribute that includes the Notification URI to indicate to the PCF where to send the notification of the subscribed events. + +NOTE 1: The "notifUri" attribute within the EventsSubscReqData data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +Upon the reception of the HTTP PUT request from the NF service consumer, the PCF shall decide whether the received HTTP PUT request is accepted. + +If the HTTP PUT request from the NF service consumer is rejected, the PCF shall indicate in the HTTP response the cause for the rejection as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP PUT request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +If the PCF accepted the HTTP PUT request to create a subscription to events, the PCF shall create the "Events Subscription" sub-resource and shall send the HTTP response message to the NF service consumer as shown in figure 4.2.6.2-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field that shall contain the URI of the created "Events Subscription" sub-resource i.e. "{apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription"; and +- a response body with the "EventsSubscPutData" data type, that contains the attributes of the "EventsSubscReqData" data type, representing the created "Events Subscription" sub-resource. + +If the PCF determines that one or more of the subscribed events are already met in the PCF, the PCF may also include the attributes of the "EventsNotification" data type within the "EventsSubscPutData" data type to notify about the already met events in the PCF. + +If the PCF accepted the HTTP PUT request to modify the events subscription, the PCF shall modify the "Events Subscription" sub-resource and shall send to the NF service consumer: + +- the HTTP "204 No Content" response (as shown in figure 4.2.6.2-2, step 2a); or +- the HTTP "200 OK" response (as shown in figure 4.2.6.2-2, step 2b) including in the "EventsSubscPutData" data type the updated representation of the "Events Subscription" sub-resource encoded within the attributes of the "EventsSubscReqData" data type and, if one or more of the updated subscribed events are already met in the PCF, the notification of these events by including the attributes of the "EventsNotification" data type. + +The PCF shall include in the "evsNotif" attribute: + +- if the NF service consumer subscribed to the "PLMN\_CHG" event in the HTTP PUT request, the "event" attribute set to "PLMN\_CHG" and the "plmnId" attribute including the PLMN Identifier or the SNPN Identifier if the PCF has previously requested to be updated with this information in the SMF; and + +NOTE 2: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 3: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- if the NF service consumer subscribed to the "ACCESS\_TYPE\_CHANGE" event in the HTTP PUT request, the "event" attribute set to "ACCESS\_TYPE\_CHANGE" and: + - i. the "accessType" attribute including the access type, and the "ratType" attribute including the RAT type when applicable for the notified access type; and + - ii. if the "ATSSS" feature is supported, the "addAccessInfo" attribute with the additional access type information if available, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; and + +NOTE 4: For a MA PDU session, if the "ATSSS" feature is not supported by the NF service consumer the PCF includes the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type (when applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +- iii. the "anGwAddr" attribute including access network gateway address when available, + +if the PCF has previously requested to be updated with this information in the SMF. + +Based on the received subscription information from the NF service consumer, the PCF may create a subscription to event notifications or may modify the existing subscription to event notifications, for a related PDU session from the SMF, as described in 3GPP TS 29.512 [8]. + +#### 4.2.6.3 Initial subscription to events without provisioning of service information + +The NF service consumer may subscribe with the PCF to events notification without providing service information. + +NOTE 1: This service operation is intended to create a resource that enables to handle subscription to events without provisioning service information. For the scenarios where it is known the NF service consumer, after creating a subscription without service information, could require an application session context with the PCF with required service information, the NF service consumer needs to create an Individual Application Session context as described in clause 4.2.2.2. + +Figure 4.2.6.3-1 illustrates the initial subscription to events without provisioning of service information. + +![Sequence diagram showing the initial subscription to events without provisioning of service information. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status.](107cbeda15ddd53da92c2f677b441c93_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST « app-sessions » + NF service consumer->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the initial subscription to events without provisioning of service information. The NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status. + +**Figure 4.2.6.3-1: Initial Subscription to events without provisioning of service information** + +When a NF service consumer establishes an application session context with the PCF to subscribe to events and does not require PCC control for the related media, the NF service consumer shall invoke the Npcf\_PolicyAuthorization\_Subscribe service operation by sending the HTTP POST request to the resource URI representing the "Application Sessions" collection resource of the PCF, as shown in figure 4.2.6.3-1, step 1. + +The NF service consumer shall include in the "ascReqData" attribute of the "AppSessionContext" data type in the content of the HTTP POST request: + +- either the "ueMac" attribute containing the UE MAC address, or the "ueIpv4" attribute or "ueIpv6" attribute containing the UE IPv4 or the IPv6 address; +- the "notifUri" attribute containing the URI where the PCF shall request to the NF service consumer the deletion of the "Individual Application Session Context" resource; and +- the "evSubsc" attribute of "EventsSubscReqData" data type to request the notification of certain user plane events. The NF service consumer shall include: + - a. the events to subscribe to in the "events" attribute; and + - b. the notification URI where to address the notification of the met events within the "notifUri" attribute. + +The NF service consumer may provide in the "AppSessionContext" data type the DNN in the "dnn" attribute, SUPI in the "supi" attribute or other information if available. + +If the PCF cannot successfully fulfil the received HTTP POST request due to the internal PCF error or due to the error in the HTTP POST request, the PCF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, when the PCF receives the HTTP POST request from the NF service consumer, the PCF shall apply session binding as described in 3GPP TS 29.513 [7]. The PCF identifies the PDU session for which the HTTP POST request applies as described in clause 4.2.2.2. + +If the PCF fails in executing session binding, the PCF shall reject the Npcf\_PolicyAuthorization\_Subscribe service operation with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "PDU\_SESSION\_NOT\_AVAILABLE". + +The information required for session binding (UE MAC address, or UE IPv4 or IPv6 address, DNN, SUPI and other available information, such as S-NSSAI and/or IPv4 address domain identifier) is provisioned in the "Individual + +Application Session Context" resource. The events subscription is provisioned in the "Events Subscription" sub-resource. + +Based on the received subscription information from the NF service consumer, the PCF may create a subscription to event notifications for a related PDU session from the SMF, as described in 3GPP TS 29.512 [8]. + +If the PCF created the "Events Subscription" sub-resource within the "Individual Application Session Context" resource, the PCF shall send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 4.2.6.3-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field; and +- an "AppSessionContext" data type in the content. + +The Location header field shall contain the URI of the created events subscription sub-resource i.e. "{apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription". + +The "AppSessionContext" data type content shall contain the representation of the created "Individual Application Session Context" resource and "Events Subscription" sub-resource. + +The PCF shall include in the "evsNotif" attribute: + +- if the NF service consumer subscribed to the event "PLMN\_CHG" in the HTTP POST request, the "event" attribute set to "PLMN\_CHG" and the "plmnId" attribute including the PLMN Identifier or the SNPN Identifier if the PCF has previously requested to be updated with this information in the SMF; + +NOTE 2: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 3: Handover between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- if the NF service consumer subscribed to the event "ACCESS\_TYPE\_CHANGE" in the HTTP POST request, the "event" attribute set to "ACCESS\_TYPE\_CHANGE" and: + - i. the "accessType" attribute including the access type, and the "ratType" attribute including the RAT type when applicable for the notified access type; and + - ii. if the "ATSSS" feature is supported, the "addAccessInfo" attribute with the additional access type information if available, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; and + +NOTE 4: For a MA PDU session, if the "ATSSS" feature is not supported by the NF service consumer the PCF includes the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type (if applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +- iii. the "anGwAddr" attribute including access network gateway address when available, +if the PCF has previously requested to be updated with this information in the SMF; and + +- if the "IMS\_SBI" feature is supported and if the NF service consumer subscribed to the event "CHARGING\_CORRELATION" in the HTTP POST request, the "event" attribute set to "CHARGING\_CORRELATION" and may include the "anChargIds" attribute containing the access network charging identifier(s) and the "anChargAddr" attribute containing the access network charging address. + +NOTE 5: Due to the resource structure, as result of the Npcf\_PolicyAuthorization\_Subscribe service operation using POST methods, the PCF creates an Individual Application Session context resource which can only be deleted via Npcf\_PolicyAuthorization\_Delete service operation. + +#### 4.2.6.4 Subscription to usage monitoring of sponsored data connectivity + +This procedure is used by a NF service consumer to subscribe with the PCF to usage monitoring of sponsored data connectivity or to provide updated usage thresholds for the existing application session context, when the "Sponsored Connectivity" feature is supported. + +The NF service consumer shall include in the HTTP PUT request message described in clause 4.2.6.2 the "EventsSubscReqData" data type, that shall contain: + +- the "events" attribute with a new entry of the "AfEventSubscription" data type with the "event" attribute set to "USAGE\_REPORT"; and +- the "usgThres" attribute with the usage thresholds to apply. + +The PCF shall reply to the NF service consumer as described in clause 4.2.6.2. + +#### 4.2.6.5 Void + +#### 4.2.6.6 Request of access network information + +This procedure is used by a NF service consumer to request the PCF to report the access network information (i.e. user location and/or user timezone information) without providing service information when the "NetLoc" feature is supported. + +The NF service consumer can request access network information without providing service information: + +- at initial subscription to events, using the HTTP POST request message as described in clause 4.2.6.3; and +- at modification of the subscription to events, using the HTTP PUT request message as described in clause 4.2.6.2. + +The NF service consumer shall include in the HTTP request message: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +When the PCF determines that the access network does not support the access network information reporting because the SMF does not support the NetLoc feature, the PCF shall respond to the NF service consumer including in the "EventsNotification" data type the "noNetLocSupp" attribute set to "ANR\_NOT\_SUPPORTED" value. Otherwise, the PCF shall immediately configure the SMF to provide such access information, as specified in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer with the HTTP POST response as described in clause 4.2.6.3 and with the HTTP PUT response as described in clause 4.2.6.2. + +#### 4.2.6.7 Subscription to notification of signalling path status + +When the feature "IMS\_SBI" is supported, this procedure is used by a NF service consumer to subscribe to notifications of the status of the AF signalling transmission path. + +The NF service consumer shall create a new "Individual Application Session Context" resource with the PCF for the AF signalling using the Npcf\_PolicyAuthorization\_Create service operation. + +The NF service consumer shall provide: + +- the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute; +- within the "evSubsc" attribute, the "event" attribute set to "FAILED\_RESOURCES\_ALLOCATION"; and + +- a media component within the "medComponents" attribute including: + - the "medCompN" attribute set to "0"; and + - a single media subcomponent within the "medSubComps" attribute with: + - the "flowUsage" attribute set to the value "AF\_SIGNALLING"; and + - if the procedures for NF service consumer provisioning of AF signalling flow information do not apply, the "fNum" attribute set to "0". + +When the "fNum" attribute is set to "0", the rest of attributes within the related media component and media subcomponent shall not be used. + +The PCF shall perform session binding as described in 3GPP TS 29.513 [7] and shall reply to the NF service consumer as described in clause 4.2.6.3. + +PCC rules related to AF signalling IP flows should be provisioned to SMF using the corresponding procedures specified at 3GPP TS 29.512 [8] at an earlier stage (e.g. typically at the establishment of the QoS flow dedicated for AF signalling IP flows). The PCF may install the corresponding dynamic PCC rules for the AF signalling IP flows if none has been installed before. + +NOTE 1: Well-known ports (e.g. 3GPP TS 24.229 [32] for SIP) or wildcard ports can be used by PCF to derive the dynamic PCC for the AF signalling IP flows. + +If the "Individual Application Session Context" resource is only used for subscription to notification of AF signalling path status, the NF service consumer may cancel the subscription to notifications of the status of the AF signalling transmission path removing the resource as described in clause 4.2.4.2. + +NOTE 2: The "Individual Application Session Context" resource created for the AF signalling can also be used when the NF service consumer requests notifications of access type change, access network information for SMS over IP and/or when the NF service consumer provisions AF Signalling Flow Information. + +#### 4.2.6.8 Subscription to Service Data Flow QoS Monitoring Information + +This procedure is used by NF service consumer to subscribe and/or modify the PCF subscription for notification about real-time measurements of QoS parameters, e.g. packet delay between UPF and UE, when the "QoSMonitoring" feature is supported. + +The NF service consumer shall include in the HTTP PUT request message described in clause 4.2.6.2 the "EventsSubscReqData" data type, that shall contain: + +- to create a subscription to notifications of QoS monitoring report: + - a) shall include the "events" array with an array that contains a new entry per requested notification method with the "event" attribute set to "QOS\_MONITORING", and notification related information as described in clause 4.2.2.23; + - b) when the "notifMethod" of the new entry is "EVENT\_DETECTION", shall include a "qosMon" attribute with the QoS monitoring information for packet delay thresholds and/or a "qosMonDatRate" attribute with QoS monitoring information for data rate thresholds and/or the "congestMon" attribute for congestion thresholds as described in clause 4.2.2.23; + - c) shall include the new requested QoS monitoring parameter(s) to be measured (i.e. DL/UL/round trip packet delay and/or, if the feature "XRM\_5G" is supported, congestion information, and/or data rate information) within the "reqQosMonParams" attribute; and + - d) may include the notification correlation identifier assigned by the AF within the "notifCorreId" attribute; + - e) if the feature "ExposureToEAS" and/or "XRM\_5G" is supported, may include the "directNotifInd" attribute set to true to indicate the direct event notification of QoS Monitoring data from the UPF. + - f) for data rate monitoring, may include the "avrgWndw" attribute to indicate the average window for the data rate measurement; and + +- to remove a subscription to QoS monitoring information: + - a) shall include the "events" array containing an array that shall omit the corresponding entry with the "event" attribute value "QOS\_MONITORING"; and + - b) when the "notifMethod" of the removed entry is "EVENT\_DETECTION", it shall omit the "qosMon" and/or "qosMonDatRate" and/or "congestMon" attribute; + - c) shall omit the "reqQosMonParams"; + - d) if the feature "ExposureToEAS" and/or "XRM\_5G" is supported, shall omit the "directNotifInd" attribute and/or the "avrgWndw" attribute; + +The NF service consumer shall include other events related information that shall remain unchanged. + +As result of this action, the PCF shall set the appropriate subscription to QoS monitoring information for the corresponding active PCC rule(s) as described in 3GPP TS 29.512 [8]. + +If the AF provided an indication of direct event notification, and the PCF determines that the QoS Monitoring reports cannot be notified directly (e.g. the AF requests for monitoring packet delay variation or round trip packet delay when UL and DL are on different service data flows), the PCF generates a successful response to the AF and indicates that direct event notification is not possible by including within the "servAuthInfo" attribute the value "DIRECT\_NOTIF\_NOT\_POSSIBLE", as described in clause 4.2.2.23. + +The PCF shall reply to the NF service consumer as described in clause 4.2.6.2. + +**Editor's note:** Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +#### 4.2.6.9 Subscription to application detection notification + +This procedure is used by a NF service consumer to request the PCF the subscription to application (e.g. start, stop) detection notifications, if the "ApplicationDetectionEvents" feature is supported. + +The NF service consumer can request the subscription to notification of application detection events without providing service information: + +- at initial subscription to events, using the HTTP POST request message as described in clause 4.2.6.3; and +- at modification of the subscription to events, using the HTTP PUT request message as described in clause 4.2.6.2. + +The NF service consumer shall include: + +- To subscribe to notifications about the detection of the start/stop of one or more application's traffic the "evSubsc" attribute within the POST request as described in clause 4.2.6.3, with: + - a. the "events" array, including an event with the "event" attribute value set to "APP\_DETECTION"; and + - b. the "afAppIds" attribute, with the list of AF application identifier(s) that refer to the applications' traffic to detect. +- To modify the subscription to notifications of application's traffic detection the "EventsSubscReqData" data type within the PUT request as described in clause 4.2.6.2, including an event with the "event" attribute value set to "APP\_DETECTION" and an updated list of AF application identifiers within the "afAppIds" attribute. +- To remove the subscription to notifications about the start and stop of the applications traffic, an "events" array within the PUT request as described in clause 4.2.6.2, without including any event with the "event" attribute value "APP\_DETECTION" and omitting the "afAppIds" attribute. + +The PCF shall reply to the NF service consumer with the HTTP POST response as described in clause 4.2.6.3 and with the HTTP PUT response as described in clause 4.2.6.2. + +The PCF shall set the appropriate subscription to Application Detection for the corresponding PCC rule(s) as described in 3GPP TS 29.512 [8]. + +In this release of the specification application detection applies only to the application(s) with IP traffic. + +#### 4.2.6.10 Subscription to satellite backhaul category changes + +When the feature "SatelliteBackhaul" is supported, this procedure is used by NF service consumer to subscribe and/or modify the PCF subscription to receive a notification when the satellite backhaul category changes and when the backhaul category changes between satellite backhaul and non-satellite backhaul. When the feature "EnSatBackhaulCatChg" is supported, the subscription is also used to receive a notification when the satellite backhaul category change comprises a dynamic satellite backhaul category. + +The NF service consumer shall include in the HTTP PUT request message described in clause 4.2.6.2 the "EventsSubscReqData" data type, or in the HTTP POST request message described in clause 4.2.6.3 the "evSubsc" attribute, that shall contain the "events" array, with a new entry with the "event" attribute set to "SAT\_CATEGORY\_CHG" to indicate the creation of a subscription to backhaul category changes. + +The NF service consumer shall include other events related information that shall remain unchanged. + +As result of this action, the PCF shall set the appropriate subscription to satellite backhaul changes for the PDU session as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer as described in clause 4.2.6.2 or in clause 4.2.6.3. The PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "SAT\_CATEGORY\_CHG" and the "satBackhaulCategory" attribute including the satellite backhaul category or the indication of non-satellite backhaul if the PCF has previously subscribed with the SMF to changes in this information. + +#### 4.2.6.11 Subscription to TSC user plane node related events + +When the "TimeSensitiveNetworking" or "TimeSensitiveCommunication" feature is supported, this procedure is used by the NF service consumer to subscribe and/or modify the PCF subscription to received notification when TSC user plane node information is updated. + +The NF service consumer shall include in the HTTP PUT request message described in clause 4.2.6.2 the "EventsSubscReqData" data type, or in the HTTP POST request message described in clause 4.2.6.3 the "evSubsc" attribute, that shall contain the "events" array, with a new entry with the "event" attribute set to the value "TSN\_BRIDGE\_INFO" to subscribe to the reception of TSC user plane node information. + +The NF service consumer shall include other events related information that shall remain unchanged. + +As result of this action, the PCF shall set the corresponding subscription to the report of TSC user plane node management information and port management information for the corresponding PDU session as described in 3GPP TS 29.512 [8]. + +The PCF shall reply to the NF service consumer in clause 4.2.6.2 or in clause 4.2.6.3. The PCF shall include the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "TSN\_BRIDGE\_INFO" and the "tsnBridgeManCont" attribute and/or the "tsnPortManContDstt" attribute and/or the "tsnPortManContNwttts" attribute as received from the SMF, if not previously reported. + +As result of this action, the PCF shall subscribe to the report of TSC user plane node management information and port management information for the corresponding PDU session, if not previously subscribed, as described in 3GPP TS 29.512 [8]. + +#### 4.2.6.12 Subscription to the report of extra UE addresses + +When the feature "ExtraUEaddrReport" is supported, the subscription to the report of extra UE addresses is used to report about the extra IP addresses or address ranges allocated to the PDU session due to framed routes or IPv6 prefix delegation. The report shall include the actual list of IPv4 addresses or list of IPv6 prefixes as currently allocated. + +The PCF shall include in the HTTP PUT request message described in clause 4.2.6.2 the "EventsSubscReqData" data type, or in the HTTP POST request message described in clause 4.2.6.3 the "evSubsc" attribute, that shall contain the "events" array, with a new entry with the "event" attribute set to the value "EXTRA\_UE\_ADDR". + +The NF service consumer shall include other events related information that shall remain unchanged, if applicable. + +The PCF shall reply to the NF service consumer with the HTTP POST response as described in clause 4.2.6.3 and with the HTTP PUT response as described in clause 4.2.6.2. + +If the PCF received from the SMF the framed routes as described in 3GPP TS 29.512 [8], clause 4.2.2.2, or the PCF received updated information of the one or more IPv6 prefixes allocated to the UE as described in 3GPP TS 29.512 [8], clauses 4.2.4.2 and C.3.4.1, the PCF shall include in the response the "evsNotif" attribute with an entry in the "evNotifs" array with the "event" attribute set to "EXTRA\_UE\_ADDR" and: + +- the actual list of IPv4 addresses within the "ipv4AddrList" attribute, if one or more IPv4 framed routes are associated to the PDU session and are available in the PCF; or +- the actual list of IPv6 prefixes allocated to the UE within the "ipv6PrefixList" attribute, if one or more IPv6 framed routes are associated to the PDU session and are available in the PCF, or if the PCF keeps updated IPv6 prefix(es) information. + +As result of this action, the PCF shall set the appropriate subscription to the report of UE IP addresses, if not previously subscribed, as described in 3GPP TS 29.512 [8]. + +#### 4.2.6.13 Subscription to Service Data Flow QoS Monitoring, multi-modal services + +When the "XRM\_5G" feature is supported, this procedure is used by the NF service consumer to subscribe and/or modify the PCF subscription for notification about real-time measurements of QoS parameters, e.g. packet delay between UPF and UE, with distinct QoS monitoring requirements per media component. + +To provide QoS monitoring requirements for each media component, the NF service consumer shall follow the procedures described in clause 4.2.6.8 for subscription to QoS Monitoring Information. + +**Editor's Note:** It is FFS whether different QoS monitoring requirements per different media might be requested. It is also FFS whether the existing data structures for QoS Monitoring can be reused or new ones are needed. + +#### 4.2.6.14 Subscription to notifications about URSP rule enforcement + +This procedure is used by a NF service consumer to request the PCF the subscription to URSP rule enforcement notification, if the "URSPEnforcement" feature is supported. + +The NF service consumer may request the subscription to notification of URSP rule enforcement event without providing service information: + +- at initial subscription to events, using the HTTP POST request message as described in clause 4.2.6.3; and +- at modification of the subscription to events, using the HTTP PUT request message as described in clause 4.2.6.2. + +The NF service consumer shall include: + +- To subscribe to notifications about URSP rule enforcement information, the "evSubsc" attribute within the POST request as described in clause 4.2.6.3, with the "events" array, including an event with the "event" attribute value set to "URSP\_ENF\_INFO"; and +- To remove the subscription to notifications about URSP rule enforcement information, an "events" array within the PUT request as described in clause 4.2.6.2, without including any event with the "event" attribute value "URSP\_ENF\_INFO". + +The PCF shall reply to the NF service consumer with the HTTP POST response as described in clause 4.2.6.3 and with the HTTP PUT response as described in clause 4.2.6.2. + +If URSP rule enforcement information corresponding to the subscription is available, the PCF shall include the received URSP rule enforcement information within the "urspEnfRep" attribute, the SSC mode within the "sscMode" attribute, the UE requested DNN, if available, within the "ueReqDnn" attribute, if the PDU session is redundant, the RSN and the PDU session pair ID within the "redundantPduSessionInfo" attribute and the access type within the "accessType" attribute, if not previously provided, or changed compared to the latest provided value, in the "evsNotif" attribute as defined in clause 4.2.5.24. + +The PCF shall set the appropriate subscription to URSP rule enforcement report as described in 3GPP TS 29.512 [8]. + +## 4.2.7 Npcf\_PolicyAuthorization\_Unsubscribe service operation + +### 4.2.7.1 General + +The Npcf\_PolicyAuthorization\_Unsubscribe service operation enables NF service consumers to remove subscription to all subscribed events for the existing application session context. Subscription to events shall be removed: + +- by invoking the Npcf\_PolicyAuthorization\_Unsubscribe service operation for the existing application session context, as described in clause 4.2.7.2; or +- within the application session context modification procedure by invoking the Npcf\_PolicyAuthorization\_Update service operation, as described in clause 4.2.3; or +- within the application session context termination procedure by invoking the Npcf\_PolicyAuthorization\_Delete service operation, as described in clause 4.2.4. + +The following procedure using the Npcf\_PolicyAuthorization\_Unsubscribe service operation is supported: + +- Unsubscription to events. + +### 4.2.7.2 Unsubscription to events + +This procedure is used to unsubscribe to all subscribed events for the existing AF application session context, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +Figure 4.2.7.2-1 illustrates the unsubscription to events using the HTTP DELETE method. + +![Sequence diagram showing the removal of events subscription information using HTTP DELETE. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content.](85e7d6eb95be2fe34f09499ca16536de_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. DELETE « app-sessions/{appSessionId}/events-subscription » + NF service consumer->>PCF: Request + Note left of PCF: 2. "204 No Content" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the removal of events subscription information using HTTP DELETE. An NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content. + +**Figure 4.2.7.2-1: Removal of events subscription information using HTTP DELETE** + +When the NF service consumer decides to unsubscribe to all subscribed events for the existing application session context, the NF service consumer shall invoke the Npcf\_PolicyAuthorization\_Unsubscribe service operation by sending the HTTP DELETE request message to the resource URI representing the "Events Subscription" sub-resource in the PCF, as shown in figure 4.2.7.2-1, step 1. + +Upon the reception of the HTTP DELETE request message from the NF service consumer, the PCF shall decide whether the received HTTP request message is accepted. + +If the HTTP DELETE request message from the NF service consumer is accepted, the PCF shall delete "Events Subscription" sub-resource and shall send to the NF service consumer a HTTP "204 No Content" response message. The PCF may delete the existing subscription to event notifications for the related PDU session from the SMF as described in 3GPP TS 29.512 [8]. + +If the HTTP DELETE request message from the NF service consumer is rejected, the PCF shall indicate in the HTTP response message the cause for the rejection as specified in clause 5.7. + +## 5 Npcf\_PolicyAuthorization Service API + +### 5.1 Introduction + +The Npcf\_PolicyAuthorization Service shall use the Npcf\_PolicyAuthorization API. + +The API URI of the Npcf\_PolicyAuthorization API shall be: + +**{apiRoot}** + +The request URIs used in each HTTP requests from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npcf-policyauthorization". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 5.2 Usage of HTTP + +#### 5.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Npcf\_PolicyAuthorization service is contained in Annex A. + +#### 5.2.2 HTTP standard headers + +##### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +##### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [10], shall be used as content type of the HTTP bodies specified in the present specification, as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" and shall be signalled by the content type "application/merge-patch+json", as defined in IETF RFC 7396 [21]. + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [24]. + +#### 5.2.3 HTTP custom headers + +The Npcf\_PolicyAuthorization API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] and may support optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5]. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_PolicyAuthorization API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Npcf\_PolicyAuthorization API. + +![Diagram showing the resource URI structure for the Npcf_PolicyAuthorization API. The root is {apiRoot}/npcf-policyauthorization/v1. It branches into /app-sessions, which further branches into /{appSessionId} (with sub-resources /delete and /events-subscription) and /pcscf-restoration.](da5a8f834706c8119a47c5eb732feabe_img.jpg) + +``` +graph TD; Root["{apiRoot}/npcf-policyauthorization/v1"] --- AppSessions["/app-sessions"]; AppSessions --- AppSessionId["/{appSessionId}"]; AppSessions --- PcscfRestoration["/pcscf-restoration"]; AppSessionId --- Delete["/delete"]; AppSessionId --- EventsSubscription["/events-subscription"]; style Delete stroke-dasharray: 5 5; style PcscfRestoration stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure for the Npcf\_PolicyAuthorization API. The root is {apiRoot}/npcf-policyauthorization/v1. It branches into /app-sessions, which further branches into /{appSessionId} (with sub-resources /delete and /events-subscription) and /pcscf-restoration. + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_PolicyAuthorization API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|--------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Application Sessions | /app-sessions | POST | Npcf_PolicyAuthorization_Create. Creates a new Individual Application Session Context resource and may create the child Events Subscription sub-resource. | +| | /app-sessions/pcscf-restoration | PcscfRestoration (POST) | P-CSCF restoration. It indicates that P-CSCF restoration needs to be performed. | +| Individual Application Session Context | /app-sessions/{appSessionId} | PATCH | Npcf_PolicyAuthorization_Update. Updates an existing Individual Application Session Context resource. It can also update an Events Subscription sub-resource. | +| | | GET | Reads an existing Individual Application Session Context resource. | +| | /app-sessions/{appSessionId}/delete | delete (POST) | Npcf_PolicyAuthorization_Delete. Deletes an existing Individual Application Session Context resource and the child Events Subscription sub-resource. | +| Events Subscription | /app-sessions/{appSessionId}/events-subscription | PUT | Npcf_PolicyAuthorization_Subscribe. Creates a new Events Subscription sub-resource or modifies an existing Events Subscription sub-resource. | +| | | DELETE | Npcf_PolicyAuthorization_Unsubscribe. Deletes an Events Subscription sub-resource. | + +## 5.3.2 Resource: Application Sessions (Collection) + +### 5.3.2.1 Description + +The Application Sessions resource represents all application session contexts that exist in the Npcf\_PolicyAuthorization service at a given PCF instance. + +### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-policyauthorization/v1/app-sessions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +### 5.3.2.3 Resource Standard Methods + +#### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------| +| AppSessionContext | M | 1 | Contains the information for the creation of a new Individual Application Session Context resource. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AppSessionContext | M | 1 | 201 Created | Successful case.
The creation of an Individual Application Session Context resource is confirmed and a representation of that resource is returned. | +| n/a | | | 303 See Other | The result of the HTTP POST request would be equivalent to the existing Application Session Context. The HTTP response shall contain a Location header field set to the URI of the existing individual Application Session Context resource. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ExtendedProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} | + +**Table 5.3.2.3.1-5: Headers supported by the 303 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the existing individual Application Session Context resource. | + +**Table 5.3.2.3.1-6: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-------------------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string or integer | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +### 5.3.2.4 Resource Custom Operations + +#### 5.3.2.4.1 Overview + +**Table 5.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|---------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| PcsfRestoration | /app-sessions/pcscf-restoration | POST | The P-CSCF Restoration custom operation invokes P-CSCF restoration. It does not create an Individual Application Session Context resource. | + +#### 5.3.2.4.2 Operation: PcsfRestoration + +##### 5.3.2.4.2.1 Description + +##### 5.3.2.4.2.2 Operation Definition + +This custom operation invokes P-CSCF restoration in the PCF and does not create an Individual Application Session Context resource. + +This operation shall support the request data structure specified in table 5.3.2.4.2.2-1 and the response data structure and response codes specified in table 5.3.2.4.2.2-2. + +**Table 5.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| PcsfRestorationRequest Data | O | 0..1 | P-CSCF restoration data to be sent by the NF service consumer to request the P-CSCF restoration to the PCF. | + +**Table 5.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The P-CSCF restoration has been successfully invoked. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during P-CSCF restoration.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during P-CSCF restoration.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: Failure cases are described in subclause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +**Table 5.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +## 5.3.3 Resource: Individual Application Session Context (Document) + +### 5.3.3.1 Description + +The Individual Application Session Context resource represents a single application session context that exists in the Npcf\_PolicyAuthorization service. + +### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|--------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| appSessionId | string | Identifies an application session context formatted according to IETF RFC 3986 [19]. | + +### 5.3.3.3 Resource Standard Methods + +#### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| AppSessionContext | M | 1 | 200 OK | A representation of an Individual Application Session Context resource is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Application Session Context retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Application Session Context retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the GET method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +### 5.3.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| AppSessionContextUpdateDataPatch | M | 1 | Contains the modification(s) to apply to the Individual Application Session Context resource. | + +**Table 5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| AppSessionContext | M | 1 | 200 OK | Successful case.
The Individual Application Session Context resource was modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Application session context resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Application Session Context modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Application Session Context modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ExtendedProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the PATCH method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.2-4: Headers supported by the 403 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-------------------|---|-------------|-------------------------------------------------------------------------------------| +| Retry-After | string or integer | M | 1 | Indicates the time the NF service consumer has to wait before making a new request. | + +**Table 5.3.3.3.2-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.2-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative PCF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +### 5.3.3.4 Resource Custom Operations + +#### 5.3.3.4.1 Overview + +**Table 5.3.3.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| delete | /app-sessions/{appSessionId}/delete | POST | Npcf_PolicyAuthorization_Delete.
Deletes an existing Individual Application Session Context resource and the child Events Subscription sub-resource. | + +#### 5.3.3.4.2 Operation: delete + +##### 5.3.3.4.2.1 Description + +##### 5.3.3.4.2.2 Operation Definition + +This custom operation deletes an existing Individual Application Session Context resource and the child Events Subscription sub-resource in the PCF. + +This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2. + +**Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventsSubscReqData | O | 0..1 | Events subscription information to be sent by the NF service consumer to request event notification when the Individual Application Session Context resource is deleted. | + +**Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The Individual Application session context resource was deleted. | +| AppSessionContext | M | 1 | 200 OK | Successful case.
The Individual Application Session Context resource was deleted and a partial representation of that resource containing event notification information is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Application Session Context termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Application Session Context termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +## 5.3.4 Resource: Events Subscription (Document) + +### 5.3.4.1 Description + +The Events Subscription sub-resource represents a subscription to events for an application session context that exists in the Npcf\_PolicyAuthorization service. + +### 5.3.4.2 Resource definition + +Resource URI: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription + +This resource shall support the resource URI variables defined in table 5.3.4.2-1. + +**Table 5.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|-----------|--------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| appSessionId | string | Identifies an application session context formatted according to IETF RFC 3986 [19]. | + +### 5.3.4.3 Resource Standard Methods + +#### 5.3.4.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.4.3.1-1. + +**Table 5.3.4.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.4.3.1-2 and the response data structures and response codes specified in table 5.3.4.3.1-3. + +**Table 5.3.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------------------------------------| +| EventsSubscReqData | M | 1 | Contains information for the modification of the Events Subscription sub-resource. | + +**Table 5.3.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| EventsSubscPutData | M | 1 | 201 Created | Successful case.
The Events Subscription sub-resource was created.
The properties of the EventsSubscReqData data type shall be included. The properties of the EventsNotification data type shall be included when the notification for one or more created events is already available in the PCF. | +| EventsSubscPutData | M | 1 | 200 OK | Successful case.
The Events Subscription sub-resource was modified and a representation of that sub-resource is returned.
The properties of the EventsSubscReqData data type shall be included. The properties of the EventsNotification data type shall be included when the notification for one or more updated events is already available in the PCF. | +| n/a | | | 204 No Content | Successful case.
The Events Subscription sub-resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Events Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Events Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the PUT method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription | + +**Table 5.3.4.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.4.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +### 5.3.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.4.3.2-1. + +**Table 5.3.4.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.4.3.2-2 and the response data structures and response codes specified in table 5.3.4.3.2-3. + +**Table 5.3.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.4.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The Events Subscription sub-resource was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Events Subscription termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Events Subscription termination.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the DELETE method shall also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +### 5.3.3.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------|------------------------|---------------------------------|-----------------------------------------------------------------------------------------------| +| Event Notification | {notifUri}/notify | notify (POST) | PCF event notification. | +| Termination Request | {notifUri}/terminate | terminate (POST) | Request for termination of an Individual Application Session Context. | +| Notification about new 5GS Bridge | {notifUri}/new-bridge | new-bridge (POST) | Notification about new 5GS Bridge | +| Notification about PDU session events | {notifUri}/pdu-session | pdu-session (POST) | Notification about PDU session events not bound to an Individual Application Session Context. | + +## 5.5.2 Event Notification + +### 5.5.2.1 Description + +The Event Notification is used by the PCF to report one or several observed application session context events to the NF service consumer that has subscribed to such notifications, via the Events Subscription sub-resource for explicit subscriptions or, via the UDR for implicit subscriptions. + +**Editor's Note:** Whether/how to document how the OpenAPI represents the Callback URI for implicit subscriptions in this TS is FFS. + +### 5.5.2.2 Target URI + +The Callback URI "{notifUri}/notify" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri |

The Notification URI as assigned within the Events Subscription sub-resource and described within the EventsSubscReqData type (see table 5.6.2.6-1) for explicit subscriptions.

For implicit subscriptions the Notification URI is assigned via the provisioning of the corresponding application data in the UDR as specified in clause 4.2.5.29 (see also 3GPP TS 29.519 [53]).

| + +### 5.5.2.3 Standard Methods + +#### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|---------------------------------------------| +| EventsNotification | M | 1 | Provides Information about observed events. | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the notification request is redirected | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the notification request is redirected | + +## 5.5.3 Termination Request + +### 5.5.3.1 Description + +The Termination Request is used by the PCF to request the NF service consumer the deletion of the Individual Application Session Context resource. + +### 5.5.3.2 Target URI + +The Callback URI "{notifUri}/terminate" shall be used with the callback URI variables defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual Application Session Context resource and described within the AppSessionContextReqData Data type (see table 5.6.2.3-1). | + +### 5.5.3.3 Standard Methods + +#### 5.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.3.1-1. + +**Table 5.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.1-3. + +**Table 5.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------------| +| TerminationInfo | M | 1 | Provides information about the deletion of the resource. | + +**Table 5.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.
Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the notification request is redirected | + +**Table 5.5.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the notification request is redirected | + +## 5.5.4 Detected 5GS Bridge for a PDU session + +### 5.5.4.1 Description + +The detected TSC user plane node for a PDU session operation is used by the PCF to notify the NF service consumer about the detection of TSC user plane node information in the context of a PDU session and to trigger in the NF service consumer (i.e. TSN AF or TSCTSF) the creation of a new Individual Application Session Context to associate it with the detected TSC user plane node for the PDU session. + +The PCF shall use the locally configured notification URI of the NF service consumer (i.e. TSN AF or TSCTSF) or the notification URI of the NF service consumer (i.e. TSCTSF) discovered via Nnrf\_NFDiscovery service as defined in 3GPP TS 29.510 [27], if not configured, as request URI of the notification request. The "callback" definition in the OpenAPI specification is associated to the "ApplicationSessions" resource. + +### 5.5.4.2 Target URI + +The Callback URI "{notifUri}/new-bridge" shall be used with the callback URI variables defined in table 5.5.4.2-1. + +**Table 5.5.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------| +| notifUri | Uri | It is locally configured in the PCF or discovered via Nnrf_NFDiscovery service. | + +### 5.5.4.3 Standard Methods + +#### 5.5.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.4.3.1-1. + +**Table 5.5.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.4.3.1-2 and the response data structures and response codes specified in table 5.5.4.3.1-3. + +**Table 5.5.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------------------------------------------------| +| PduSessionTsnBridge | M | 1 | Provides information about the UP node of the reported PDU session. | + +**Table 5.5.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during PDU session TSC user plane node notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during PDU session TSC user plane node notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the notification request is redirected | + +## 5.5.5 Notification about PDU session event + +### 5.5.5.1 Description + +The Notification about PDU session events not bound to an Individual Application Session Context (eventNotificationPduSession) is used by the PCF to notify the NF service consumer (e.g., the PCF for a UE) about the PDU session events. + +The PCF shall use the NF service consumer (e.g. PCF for a UE) callback URI implicitly subscribed (e.g. contained in the SM Policy Association of the related PDU session) as request URI of the notification request, and append the "pdu-session" segment path at the end of the URI. The "callback" definition in the OpenAPI specification is associated to the "ApplicationSessions" resource. + +### 5.5.5.2 Target URI + +The Callback URI "{notifUri}/pdu-session" shall be used with the callback URI variables defined in table 5.5.5.2-1. + +**Table 5.5.5.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------------| +| notifUri | Uri | It is the PCF for a UE callback URI stored in the SM Policy Association. | + +### 5.5.5.3 Standard Methods + +#### 5.5.5.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.5.3.1-1. + +**Table 5.5.5.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.5.3.1-2 and the response data structures and response codes specified in table 5.5.5.3.1-3. + +**Table 5.5.5.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|---------------------------------------------------------------------------------| +| PduSessionEventNotification | M | 1 | Provides information about the PDU session related event implicitly subscribed. | + +**Table 5.5.5.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during PDU session established/terminated notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during PDU session established/terminated notification.
(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +**Table 5.5.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_PolicyAuthorization service based interface protocol. + +**Table 5.6.1-1: Npcf\_PolicyAuthorization specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| AcceptableServiceInfo | 5.6.2.30 | Acceptable maximum requested bandwidth. | | +| AccessNetChargingIdentifier | 5.6.2.32 | Contains the access network charging identifier. | IMS_SBI | +| AddFlowDescriptionInfo | 5.6.2.55 | Contains additional flow description information, as the flow label and the IPsec SPI. | AddFlowDescriptionInformation | +| AfAppId | 5.6.3.2 | Contains an AF application identifier. | | +| AfEvent | 5.6.3.7 | Represents an event to notify to the NF service consumer. | | +| AfEventNotification | 5.6.2.11 | Represents the notification of an event. | | +| AfEventSubscription | 5.6.2.10 | Represents the subscription to events. | | +| AfNotifMethod | 5.6.3.8 | Represents the notification methods that can be subscribed for an event. | | +| AfRequestedData | 5.6.3.18 | Represents the information the NF service consumer requested to be exposed. | IMS_SBI | +| AfRoutingRequirement | 5.6.2.13 | Describes the routing requirements for the application traffic flows. | InfluenceOnTrafficRouting | +| AfRoutingRequirementRm | 5.6.2.24 | This data type is defined in the same way as the "AfRoutingRequirement" data type, but with the OpenAPI "nullable: true" property. | InfluenceOnTrafficRouting | +| AfSfcRequirement | 5.6.2.49 | Describes the requirements to steer the traffic to a pre-configured chain of service functions on N6-LAN. | SFC | +| AlternativeServiceRequirementsData | 5.6.2.47 | Contains alternative QoS related parameter sets. | AltSerReqsWithIndQoS | +| AnGwAddress | 5.6.2.20 | Carries the control plane address of the access network gateway. | | +| AppDetectionReport | 5.6.2.44 | Indicates the start or stop of the detected application traffic and the detected AF application identifier. | ApplicationDetectionEvents | +| AppDetectionNotifType | 5.6.3.23 | Represents the types of reports bound to the notification of application detection information. | ApplicationDetectionEvents | +| AppSessionContext | 5.6.2.2 | Represents an Individual Application Session Context resource. | | +| AppSessionContextReqData | 5.6.2.3 | Represents the Individual Application Session Context resource data received in an HTTP POST request message. | | +| AppSessionContextRespData | 5.6.2.4 | Represents the Individual Application Session Context resource data produced by the server and returned in an HTTP response message. | | +| AppSessionContextUpdateData | 5.6.2.5 | Describes the modifications to the "ascReqData" property of an Individual Application Session Context resource. | | +| AppSessionContextUpdateDataPatch | 5.6.2.43 | Describes the modifications to an Individual Application Session Context resource | PatchCorrection | +| AspId | 5.6.3.2 | Contains an identity of an application service provider. | SponsoredConnectivity | +| BatOffsetInfo | 5.6.2.50 | Contains the offset of the BAT and the optionally adjusted periodicity. | EnTSCAC | +| CodecData | 5.6.3.2 | Contains a codec related information. | | +| ContentVersion | 5.6.3.2 | Represents the version of a media component. | MediaComponentVersioning | +| EthFlowDescription | 5.6.2.17 | Defines a packet filter for an Ethernet flow. | | +| EventsNotification | 5.6.2.9 | Describes the notification about the events occurred within an Individual Application Session Context resource. | | +| EventsSubscPutData | 5.6.2.42 | Identifies the events the application subscribes to within an Events Subscription sub-resource data. It may also include the attributes of the notification about the events already met at the time of subscription.
It is represented as a non-exclusive list of two data types: EventsSubscReqData and EventsNotification. | | + +| Data type | Section defined | Description | Applicability | +|-------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| EventsSubscReqData | 5.6.2.6 | Identifies the events the application subscribes to within an Individual Application Session Context resource. | | +| EventsSubscReqDataRm | 5.6.2.25 | This data type is defined in the same way as the "EventsSubscReqData" data type, but with the OpenAPI "nullable: true" property. | | +| ExtendedProblemDetails | 5.6.2.29 | Data type that extends ProblemDetails. | | +| FlowDescription | 5.6.3.2 | Defines a packet filter for an IP flow. | | +| Flows | 5.6.2.21 | Identifies the flows related to a media component. | | +| FlowStatus | 5.6.3.12 | Describes whether the IP flow(s) are enabled or disabled. | | +| FlowUsage | 5.6.3.14 | Describes the flow usage of the flows described by a media subcomponent. | | +| L4sNotifType | 5.6.3.25 | Indicates whether the ECN marking for L4S support for the indicated SDFs is "NOT_AVAILABLE" or "AVAILABLE" again. | L4S | +| L4sSupport | 5.6.2.56 | Indicates whether the ECN marking for L4S is available in 5GS for the indicated service data flows. | L4S | +| MediaComponent | 5.6.2.7 | Contains service information for a media component of an AF session. | | +| MediaComponentRm | 5.6.2.26 | This data type is defined in the same way as the "MediaComponent" data type, but with the OpenAPI "nullable: true" property. | | +| MediaProtocol | 5.6.3.2 | Represents the different media protocol applicable for XRM multi modality session. | MultiMedia | +| MediaComponentResourcesStatus | 5.6.3.13 | Indicates whether the media component is active or inactive. | | +| MediaSubComponent | 5.6.2.8 | Contains the requested bitrate and filters for the set of IP flows identified by their common flow identifier. | | +| MediaSubComponentRm | 5.6.2.27 | This data type is defined in the same way as the "MediaSubComponent" data type, but with the OpenAPI "nullable: true" property. | | +| MediaType | 5.6.3.3 | Indicates the media type of a media component. | | +| MpsAction | 5.6.3.22 | Indicates whether it is an invocation, a revocation or an invocation with authorization of the MPS for DTS service. | MPSforDTS | +| MultiModalId | 5.6.3.2 | Contains a multi-modal service identifier. | MultiMedia | +| OutOfCreditInformation | 5.6.2.33 | Indicates the service data flows without available credit and the corresponding termination action. | IMS_SBI | +| PayloadType | 5.6.3.2 | Represents the different payload type. | XRM_5G | +| PcfAddressingInfo | 5.6.2.46 | Contains PCF address information. | | +| PscfRestorationRequestData | 5.6.2.36 | Indicates P-CSCF restoration. | PCSCF-Restoration-Enhancement | +| PduSessionEventNotification | 5.6.2.45 | Indicates PDU session information for the established/terminated PDU session. | | +| PduSessionStatus | 5.6.3.24 | Indicates whether the PDU session is established or terminated. | | +| PduSessionTsnBridge | 5.6.2.40 | Contains the TSC user plane node Information and DS-TT port and/or NW-TT ports management information of a new detected TSC user plane node in the context of a new PDU session. | TimeSensitiveNetworking | +| PdvMonitoringReport | 5.6.2.53 | Packet Delay Variation reporting information. | EnQoSMon | +| PeriodicityInfo | 5.6.2.54 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | PowerSaving | + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| PeriodicityRange | 5.6.2.48 | Contains the acceptable range (which is formulated as lower bound and upper bound of the periodicity of the start two bursts in reference to the external GM) or acceptable periodicity value(s) (which is formulated as a list of values for the periodicity). | EnTSCAC | +| PreemptionControlInformation | 5.6.3.19 | Pre-emption control information. | MCP TT-Preemption | +| PreemptionControlInformationRm | 5.6.3.21 | This data type is defined in the same way as the "PreemptionControlInformation" data type, but with the OpenAPI "nullable: true" property. | MCP TT-Preemption | +| PrioritySharingIndicator | 5.6.3.20 | Priority sharing indicator. | PrioritySharing | +| ProtoDesc | 5.6.2.51 | Represents Protocol Description of the media flow | PDUSetHandling | +| ProtoDescRm | 5.6.2.52 | This data type is defined in the same way as the "ProtoDesc" data type, but with the OpenAPI "nullable: true" property. | PDUSetHandling | +| QosMonitoringInformation | 5.6.2.34 | QoS monitoring information (e.g. UL, DL or round trip packet delay). | QoSMonitoring | +| QosMonitoringInformationRm | 5.6.2.41 | This data type is defined in the same way as the "QosMonitoringInformation" data type, but with the OpenAPI "nullable: true" property. | QoSMonitoring | +| QosMonitoringReport | 5.6.2.37 | Contains QoS monitoring reporting information. | QoSMonitoring | +| QosNotificationControlInfo | 5.6.2.15 | Indicates whether the QoS targets related to certain media component are not guaranteed or are guaranteed again. | | +| QosNotifType | 5.6.3.9 | Indicates type of notification for QoS Notification Control. | | +| RequiredAccessInfo | 5.6.3.15 | Indicates the access network information required for an AF session. | NetLoc | +| ReservPriority | 5.6.3.4 | Indicates the reservation priority. | | +| ResourcesAllocationInfo | 5.6.2.14 | Indicates the status of the PCC rule(s) related to certain media component. | | +| ServAuthInfo | 5.6.3.5 | Indicates the result of the Policy Authorization service request from the NF service consumer. | | +| ServiceInfoStatus | 5.6.3.16 | Preliminary or final service information status. | IMS_SBI | +| ServiceUrn | 5.6.3.2 | Service URN. | IMS_SBI | +| SipForcingIndication | 5.6.3.17 | Describes if several SIP dialogues are related to an "Individual Application Session Context" resource. | IMS_SBI | +| SpatialValidity | 5.6.2.16 | Describes the spatial validity of an NF service consumer request for influencing traffic routing. | InfluenceOnTrafficRouting | +| SpatialValidityRm | 5.6.2.28 | This data type is defined in the same way as the "SpatialValidity" data type, but with the OpenAPI "nullable: true" property. | InfluenceOnTrafficRouting | +| SponId | 5.6.3.2 | Contains an Identity of a sponsor. | SponsoredConnectivity | +| SponsoringStatus | 5.6.3.6 | Represents whether sponsored data connectivity is enabled or disabled/not enabled. | SponsoredConnectivity | +| TemporalValidity | 5.6.2.22 | Indicates the time interval during which the NF service consumer request is to be applied. | InfluenceOnTrafficRouting | +| TerminationCause | 5.6.3.10 | Indicates the cause for requesting the deletion of the Individual Application Session Context resource. | | +| TerminationInfo | 5.6.2.12 | Includes information related to the termination of the Individual Application Session Context resource. | | +| TosTrafficClass | 5.6.3.2 | Contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the ToS/Traffic Class mask field. | | +| TosTrafficClassRm | 5.6.3.2 | This data type is defined in the same way as the "TosTrafficClass" data type, but with the OpenAPI "nullable: true" property. | | + +| Data type | Section defined | Description | Applicability | +|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| TscPriorityLevel | 5.6.3.2 | Priority of TSC Flows | TimeSensitiveNetworking | +| TscPriorityLevelRm | 5.6.3.2 | This data type is defined in the same way as the "TscPriorityLevel" data type, but with the OpenAPI "nullable: true" property | TimeSensitiveNetworking | +| TscailInputContainer | 5.6.2.39 | TSCAI Input information container. | TimeSensitiveNetworking | +| TsnQosContainer | 5.6.2.35 | TSC traffic QoS parameters. | TimeSensitiveNetworking
XRM_5G | +| TsnQosContainerRm | 5.6.2.38 | This data type is defined in the same way as the "TsnQosContainer" data type, but with the OpenAPI "nullable: true" property. | TimeSensitiveNetworking
XRM_5G | +| UeIdentityInfo | 5.6.2.31 | Represents 5GS-Level UE Identities. | IMS_SBI | +| UrspEnforcementReport | 5.6.2.53 | Indicates the UE reporting Connection Capabilities from associated URSP rule(s). | URSPEnforcement | +| UplinkDownlinkSupport | 5.6.3.25 | Represents whether a capability is supported for the UL, the DL or both UL and DL service data flows | L4S | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_PolicyAuthorization service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_PolicyAuthorization service based interface. + +**Table 5.6.1-2: Npcf\_PolicyAuthorization re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| AccNetChargingAddresses | 3GPP TS 29.512 [8] | Indicates the IP address of the network entity within the access network performing charging. | IMS_SBI | +| AccessType | 3GPP TS 29.571 [12] | The identification of the type of access network. | | +| AccumulatedUsage | 3GPP TS 29.122 [15] | Accumulated Usage. | SponsoredConnectivity | +| AdditionalAccessInfo | 3GPP TS 29.512 [8] | Indicates the combination of additional Access Type and RAT Type for MA PDU session | ATSSS | +| AfSigProtocol | 3GPP TS 29.512 [8] | Represents the protocol used for signalling between the UE and the NF service consumer. | ProvAFsignalFlow | +| ApplicationChargingId | 3GPP TS 29.571 [12] | Application provided charging identifier allowing correlation of charging information. | IMS_SBI | +| AverWindow | 3GPP TS 29.571 [12] | Averaging Window. | XRM_5G | +| AverWindowRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "AverWindow" data type, but with the OpenAPI "nullable: true" property. | XRM_5G | +| BdtReferenceId | 3GPP TS 29.122 [15] | Identifies transfer policies. | | +| BitRate | 3GPP TS 29.571 [12] | Specifies bitrate in kbits per second. | | +| BitRateRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. | | +| BridgeManagementContainer | 3GPP TS 29.512 [8] | Contains TSC user plane node management information. | TimeSensitiveNetworking | +| Bytes | 3GPP TS 29.571 [12] | String with format "byte". | | +| ChargingId | 3GPP TS 29.571 [12] | Charging identifier allowing correlation of charging information. | IMS_SBI | +| DateTime | 3GPP TS 29.571 [12] | String with format "date-time" as defined in OpenAPI Specification [11]. | InfluenceOnTrafficRouting, TimeSensitiveNetworking | +| Dnn | 3GPP TS 29.571 [12] | Data Network Name. | | +| DurationSec | 3GPP TS 29.571 [12] | Identifies a period of time in units of seconds. | TimeSensitiveNetworking, EnhancedSubscriptionToNotification, SimultConnectivity | +| DurationSecRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. | SimultConnectivity | +| EasIpReplacementInfo | 3GPP TS 29.571 [12] | Contains EAS IP replacement information for a Source and a Target EAS. | EASIPreplacement | +| FinalUnitAction | 3GPP TS 32.291 [22] | Indicates the action to be taken when the user's account cannot cover the service cost. | | +| Float | 3GPP TS 29.571 [12] | Number with format "float" as defined in OpenAPI Specification [11]. | FLUS | +| FloatRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "Float" data type, but with the OpenAPI "nullable: true" property. | FLUS | +| FlowDirection | 3GPP TS 29.512 [8] | Flow Direction. | | +| Fqdn | 3GPP TS 29.571 [12] | Contains a FQDN | | +| ExtMaxDataBurstVol | 3GPP TS 29.571 [12] | Maximum Burst Size. | TimeSensitiveNetworking | +| ExtMaxDataBurstVolRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "ExtMaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property | TimeSensitiveNetworking | +| Gpsi | 3GPP TS 29.571 [12] | Identifies the GPSI. | | +| Ipv4Addr | 3GPP TS 29.571 [12] | Identifies an IPv4 address. | | +| Ipv4AddrMask | 3GPP TS 29.571 [12] | IPv4 address mask | ExtraUEaddrReport | + +| Data type | Reference | Comments | Applicability | +|---------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| Ipv6Addr | 3GPP TS 29.571 [12] | Identifies an IPv6 address. | | +| IpEndPoint | 3GPP TS 29.510 [27] | Contains a NF IPv4 and/or IPv6 end points. | | +| MacAddr48 | 3GPP TS 29.571 [12] | MAC Address. | | +| Metadata | 3GPP TS 29.571 [12] | This datatype contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | SFC | +| NetLocAccessSupport | 3GPP TS 29.512 [8] | Indicates the access network does not support the report of the requested access network information. | NetLoc | +| NullValue | 3GPP TS 29.571 [12] | JSON's null value, used as an explicit value of an enumeration. | MCPTT-Preemption | +| PacketDelBudget | 3GPP TS 29.571 [12] | Packet Delay Budget. | TimeSensitiveNetworking | +| PacketDelBudgetRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "PacketDelBudget" data type, but with the OpenAPI "nullable: true" property. | TimeSensitiveNetworking | +| PacketErrRate | 3GPP TS 29.571 [12] | String representing Packet Error Rate (see clauses 5.7.3.5 and 5.7.4 of 3GPP TS 23.501 [8]), expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit.
Pattern: '^[0-9]E-[0-9]'

Examples:
Packet Error Rate $4 \times 10^{-6}$ shall be encoded as "4E-6".
Packet Error Rate $10^{-2}$ shall be encoded as "1E-2". | ExtQoS | +| PacketErrRateRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "PacketErrRate" data type, but with the OpenAPI "nullable: true" property. | ExtQoS | +| PacketLossRateRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "PacketLossRate" data type, but with the OpenAPI "nullable: true" property. | CHEM | +| PduSessionId | 3GPP TS 29.571 [12] | The identification of the PDU session. | URSPEnforcement | +| PduSetQosPara | 3GPP TS 29.571 [12] | PDU Set related QoS parameters. | PDUSetHandlingXRM_5G | +| PduSetQosParaRm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "PduSetQosPara" data type, but with the OpenAPI "nullable: true" property. | PDUSetHandlingXRM_5G | +| Pei | 3GPP TS 29.571 [12] | Identifies the PEI. | IMS_SBI | +| PlmnIdNid | 3GPP TS 29.571 [12] | Identifies the network: the PLMN Identifier (the mobile country code and the mobile network code) or the SNPN Identifier (the PLMN Identifier and the NID). | | +| PreemptionCapability | 3GPP TS 29.571 [12] | Pre-emption capability. | MCPTT-Preemption | +| PreemptionVulnerability | 3GPP TS 29.571 [12] | Pre-emption vulnerability. | MCPTT-Preemption | +| PreemptionCapabilityRm | 3GPP TS 29.571 [12] | It is defined in the same way as the "PreemptionCapability" data type, but with the OpenAPI "nullable: true" property. | MCPTT-Preemption | +| PreemptionVulnerabilityRm | 3GPP TS 29.571 [12] | It is defined in the same way as the "PreemptionVulnerability" data type, but with the OpenAPI "nullable: true" property. | MCPTT-Preemption | +| PresenceInfo | 3GPP TS 29.571 [12] | Represents an area of interest, e.g. a Presence Reporting Area. | InfluenceOnTrafficRouting | +| PortManagementContainer | 3GPP TS 29.512 [8] | Contains port management information for a related port. | TimeSensitiveNetworking | +| ProblemDetails | 3GPP TS 29.571 [12] | Contains a detailed information about an error. | | +| RanNasRelCause | 3GPP TS 29.512 [8] | Indicates RAN and/or NAS release cause code information. | RAN-NAS-Cause | + +| Data type | Reference | Comments | Applicability | +|---------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| RatType | 3GPP TS 29.571 [12] | RAT Type. | | +| RedirectResponse | 3GPP TS 29.571 [12] | Contains redirection related information. | ES3XX | +| RedundantPduSessionInformation | 3GPP TS 29.502 [57] | Contains the Redundant PDU session information, i.e. the RSN and the PDU Session Pair ID. | URSPEnforcement | +| RequestedQosMonitoringParameter | 3GPP TS 29.512 [8] | Indicate the QoS information to be monitored, e.g. UL packet delay, DL packet delay or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for packet delay is enabled for the service data flow. | QoSMonitoring | +| RouteToLocation | 3GPP TS 29.571 [12] | Identifies routes to locations of applications. | InfluenceOnTrafficRouting | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [12] | Indicates the satellite or non-satellite backhaul category | SatelliteBackhaul | +| Snssai | 3GPP TS 29.571 [12] | Identifies the S-NSSAI. | | +| SscMode | 3GPP TS 29.571 [12] | Service and session continuity mode. | URSPEnforcement | +| Supi | 3GPP TS 29.571 [12] | Identifies the SUPI. | | +| SupportedFeatures | 3GPP TS 29.571 [12] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeWindow | 3GPP TS 29.122 [15] | Time window identified by a start time and a stop time. | EnTSCAC | +| TrafficCorrelationInfo | 3GPP TS 29.519 [53] | Contains the information for traffic correlation. | CommonEASDNAI | +| TimeZone | 3GPP TS 29.571 [12] | Time Zone. | NetLoc | +| TsnBridgeInfo | 3GPP TS 29.512 [8] | TSC user plane node information. | TimeSensitiveNetworking | +| Uint32 | 3GPP TS 29.571 [12] | Unsigned 32-bit integers, i.e. only value 0 and 32-bit integers above 0 are permissible. | ResourceSharing | +| Uint32Rm | 3GPP TS 29.571 [12] | This data type is defined in the same way as the "Uint32" data type, but with the OpenAPI "nullable: true" property. | ResourceSharing | +| Uinteger | 3GPP TS 29.571 [12] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. Minimum = 0. | TimeSensitiveNetworking | +| UpPathChgEvent | 3GPP TS 29.512 [8] | Contains the subscription information to be delivered to SMF for the UP path management events. | InfluenceOnTrafficRouting | +| Uri | 3GPP TS 29.571 [12] | String providing an URI. | | +| UsageThreshold | 3GPP TS 29.122 [15] | Usage Thresholds. | SponsoredConnectivity | +| UsageThresholdRm | 3GPP TS 29.122 [15] | This data type is defined in the same way as the "UsageThreshold" data type, but with the OpenAPI "nullable: true" property. | SponsoredConnectivity | +| UserLocation | 3GPP TS 29.571 [12] | User Location(s). | NetLoc | + +## 5.6.2 Structured data types + +### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.6.2.2 Type AppSessionContext + +**Table 5.6.2.2-1: Definition of type AppSessionContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ascReqData | AppSessionContextReqData | C | 0..1 | Identifies the service requirements of an Individual Application Session Context. It shall be present in HTTP POST request messages for the creation of the resource and may be included in the HTTP response messages. | | +| ascRespData | AppSessionContextRespData | C | 0..1 | Describes the authorization data of an Individual Application Session Context created by the PCF. It may be present in the HTTP response messages. | | +| evsNotif | EventsNotification | O | 0..1 | Describes information related to the notification of events. | | + +### 5.6.2.3 Type AppSessionContextReqData + +**Table 5.6.2.3-1: Definition of type AppSessionContextReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| afAppId | AfAppId | O | 0..1 | AF application identifier. | | +| afChargId | ApplicationChargingId | O | 0..1 | AF charging identifier. This information may be used for charging correlation with QoS flow. | IMS_SBI | +| afReqData | AfRequestedData | O | 0..1 | Represents the NF service consumer requested data to be exposed. | IMS_SBI | +| afRoutReq | AfRoutingRequirement | C | 0..1 | Indicates the AF traffic routing requirements. It shall be included if Influence on Traffic Routing feature is supported. | InfluenceOnTrafficRouting | +| afSfcReq | AfSfcRequirement | O | 0..1 | Describes the AF requirements to steer the traffic to a pre-configured chain of service functions on N6-LAN. | SFC | +| aspId | AspId | C | 0..1 | Application service provider identity. It shall be included if "SponsoredConnectivity" feature is supported. | SponsoredConnectivity | +| bdtRefId | BdtReferenceId | O | 0..1 | Reference to a transfer policy negotiated for background data traffic. | | +| dnn | Dnn | C | 0..1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. It shall be present when the "afRoutReq" attribute is present.
(NOTE 2) | | +| evSubsc | EventsSubscReqData | O | 0..1 | Identifies the events the application subscribes to at creation of an Individual Application Session Context resource. | | +| ipDomain | string | O | 0..1 | Indicates the IPv4 address domain information that assists session binding. | | +| mcpttId | string | O | 0..1 | Indicates that the created Individual Application Session Context resource relates to an MCPTT session prioritized call.
It includes either one of the namespace values used for MCPTT (see IETF RFC 8101 [42]) and it may include the name of the MCPTT service provider. | MCPTT | +| mcVideoId | string | O | 0..1 | Indicates that the created Individual Application Session Context resource relates to an MCVideo session prioritized call.
It includes either one of the namespace values used for MCPTT (see IETF RFC 8101 [42]) and it may include the name of the MCVideo service provider. | MCVideo | +| medComponents | map(MediaComponent) | O | 1..N | Media Component information. The key of the map is the attribute "medCompN". | | +| mpsAction | MpsAction | O | 0..1 | Indicates a request to invoke an MPS action. | MPSforDTS | +| mpsId | string | O | 0..1 | Indicates that the created Individual Application Session Context resource relates to an MPS service. It contains the national variant for MPS service name. | | +| mcsId | string | O | 0..1 | Indicates that the created Individual Application Session Context resource relates to an MCS service. It contains the national variant for MCS service name. | | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| preemptControlInfo | PreemptionControlInformation | O | 0..1 | Pre-emption control information. | MCPTT-Preemption | +| resPrio | ReservPriority | O | 0..1 | Indicates the reservation priority. | | +| servInfStatus | ServiceInfoStatus | O | 0..1 | Indicates whether the service information is preliminary or final. When the attribute is not provided the default value is "FINAL". | IMS_SBI | +| notifUri | Uri | M | 1 | Notification URI for Application Session Context termination requests. | | +| servUrn | ServiceUrn | O | 0..1 | Service URN. | IMS_SBI | +| sliceInfo | Snssai | O | 0..1 | Identifies the S-NSSAI. | | +| sponId | SponId | C | 0..1 | Sponsor identity. It shall be included if "SponsoredConnectivity" feature is supported. | SponsoredConnectivity | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled. The absence of the attribute indicates that the sponsored connectivity is enabled. | SponsoredConnectivity | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier. | | +| suppFeat | SupportedFeatures | M | 1 | This IE represents a list of Supported features used as described in clause 5.8. It shall be supplied by the NF service consumer in the POST request that requests a creation of an Individual Application Session Context resource. | | +| uelpv4 | Ipv4Addr | C | 0..1 | The IPv4 address of the served UE. (NOTE 1) | | +| uelpv6 | Ipv6Addr | C | 0..1 | The IPv6 address of the served UE. (NOTE 1) | | +| ueMac | MacAddr48 | C | 0..1 | The MAC address of the served UE. When the feature "TimeSensitiveNetworking" is supported this attribute represents the DS-TT port MAC address. (NOTE 1) | | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information. | TimeSensitiveNetworking | +| tsnPortManContDstt | PortManagementContainer | O | 0..1 | Transports port management information for the DS-TT port. | TimeSensitiveNetworking | +| tsnPortManContNwtt | array(PortManagementContainer) | O | 1..N | Transports port management information for one or more NW-TT ports. | TimeSensitiveNetworking | +| tscNotifUri | Uri | O | 0..1 | Notification address of the TSCTSF or TSN AF receiving the TSC management information. | ExposureToTSC | +| tscNotifCorrId | string | O | 0..1 | Correlation identifier for TSC management information notifications. It shall be provided if the "tscNotifUri" attribute is provided. | ExposureToTSC | +| multiModalId | MultiModalId | O | 0..1 | Multi-modal Service Identifier | MultiMedia | +| qosDuration | DurationSec | O | 0..1 | Contains the QoS duration to transfer data transmission (e.g., AI/ML transmission). The minimum value of the QoS duration is 60 sec. | QoSTiming_5G | +| qosInactInt | DurationSec | O | 0..1 | Contains the QoS inactivity interval for the given data transmission (e.g., AI/ML transmission). The minimum value of the QoS duration is 60 sec | QoSTiming_5G | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-------------|---------------| +| NOTE 1: Only one of the served UE addressing parameters (the IPv4 address or the IPv6 address or MAC address) shall always be included. | | | | | | +| NOTE 2: The PCF uses the DNN as received from the NF service consumer without applying any transformation (e.g. during session binding). To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. | | | | | | + +### 5.6.2.4 Type AppSessionContextRespData + +**Table 5.6.2.4-1: Definition of type AppSessionContextRespData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| servAuthInfo | ServAuthInfo | O | 0..1 | Indicates additional information related with the result of the authorization for a service request. | | +| ueIds | array(UeIdentityInfo) | O | 1..N | Represents the 5GS-Level UE identities available for an AF session context. | IMS_SBI | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8.
It shall be supplied by the PCF in the response to the POST request that requested a creation of an Individual Application Session Context resource. | | + +## 5.6.2.5 Type AppSessionContextUpdateData + +**Table 5.6.2.5-1: Definition of type AppSessionContextUpdateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| afAppId | AfAppId | O | 0..1 | AF application identifier. | | +| afRoutReq | AfRoutingRequirementRm | O | 0..1 | Indicates the AF traffic routing requirements. | InfluenceOnTrafficRouting | +| afSfcReq | AfSfcRequirement | O | 0..1 | Indicates the AF requirements on steering traffic to a pre-configured chain of service functions on N6-LAN. | SFC | +| aspld | Aspld | O | 0..1 | Application service provider identity. | SponsoredConnectivity | +| bdtReflId | BdtReferenceId | O | 0..1 | Reference to a transfer policy negotiated for background data traffic. | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Identifies the events the application subscribes to at modification of an Individual Application Session Context resource. | | +| mcpttId | string | O | 0..1 | Indicates that the updated Individual Application Session Context resource relates to an MCPTT session prioritized call.
It includes either one of the namespace values used for MCPTT (see IETF RFC 8101 [42]) and it may include the name of the MCPTT service provider. | MCPTT | +| mcVideoId | string | O | 0..1 | Indicates that the updated Individual Application Session Context resource relates to an MCVideo session prioritized call.
It includes either one of the namespace values used for MCPTT (see IETF RFC 8101 [42]) and it may include the name of the MCVideo service provider. | MCVideo | +| medComponents | map(MediaComponentRm) | O | 1..N | Media Component information. The key of the map is the "medCompN" attribute. | | +| mpsAction | MpsAction | O | 0..1 | Indicates a request to invoke or revoke MPS for DTS. | MPSforDTS | +| mpslId | string | O | 0..1 | Indicates that the modified Individual Application Session Context resource relates to an MPS service. It contains the national variant for MPS service name. | | +| mcsId | string | O | 0..1 | Indicates that the updated Individual Application Session Context resource relates to an MCS service. It contains the national variant for MCS service name. | | +| preemptControlInfo | PreemptionControlInformationRm | O | 0..1 | Preemption control information. | MCPTT-Preemption | +| resPrio | ReservPriority | O | 0..1 | Indicates the reservation priority. | | +| servInfStatus | ServiceInfoStatus | O | 0..1 | Indicates whether the service information is preliminary or final. | IMS_SBI | +| sipForkInd | SipForkingIndication | O | 0..1 | Describes if several SIP dialogues are related to an "Individual Application Session Context" resource. | IMS_SBI | +| sponId | SponId | O | 0..1 | Sponsor identity. | SponsoredConnectivity | +| sponStatus | SponsoringStatus | O | 0..1 | Indication of whether sponsored connectivity is enabled or disabled/not enabled. | SponsoredConnectivity | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information. | TimeSensitive Networking | +| tsnPortManContDtt | PortManagementContainer | O | 0..1 | Transports port management information for the DS-TT port. | TimeSensitive Networking | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| tsnPortManContNwTts | array(PortManagementContainer) | O | 1..N | Transports port management information for one or more NW-TT ports. | TimeSensitive Networking | +| tscNotifUri | Uri | O | 0..1 | Notification address of the TSCTSF or TSN AF receiving the TSC management information. | ExposureToTSC | +| tscNotifCorreId | string | O | 0..1 | Correlation identifier for TSC management information notifications. It shall be provided if the "tscNotifUri" attribute is provided. | ExposureToTSC | +| qosDuration | DurationSecRm | O | 0..1 | Contains the QoS duration to transfer data transmission (e.g., AI/ML transmission). The minimum value of the QoS duration is 60 second. | QoSTiming_5G | +| qosInactInt | DurationSecRm | O | 0..1 | Contains the QoS inactivity interval for the given data transmission (e.g., AI/ML transmission). The minimum value of the QoS inactivity interval duration is 60 second. | QoSTiming_5G | + +## 5.6.2.6 Type EventsSubscReqData + +**Table 5.6.2.6-1: Definition of type EventsSubscReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| events | array(AfEventSubscription) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | O | 0..1 | Notification URI. | | +| reqQosMonParams | array(RequestedQoSMonitoringParameter) | O | 1..N | Indicates the QoS information to be monitored, e.g. UL packet delay, DL packet delay, round trip packet delay and/or congestion information between the UE and the UPF, and/or data rate monitoring, is to be monitored when the QoS Monitoring is enabled for the service data flow. | QoSMonitoring
EnQoSMon | +| qosMon | QoSMonitoringInformation | O | 0..1 | QoS Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed and packet delay measurements are required. | QoSMonitoring | +| qosMonDatRate | QoSMonitoringInformation | O | 0..1 | Contains the data rate measurements information for the subscribed report. It shall be present when the event "QOS_MONITORING" is subscribed and data rate measurements are required. | EnQoSMon | +| pdvReqMonParams | array(RequestedQoSMonitoringParameter) | O | 1..N | Indicates the Packet Delay Variation to be monitored, e.g. UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored. | EnQoSMon | +| pdvMon | QoSMonitoringInformation | O | 0..1 | Packet Delay Variation information for the subscribed report. It may be present when the event "PACK_DEL_VAR" is subscribed.
(NOTE) | EnQoSMon | +| congestMon | QoSMonitoringInformation | O | 0..1 | Congestion threshold for the subscribed report. It may be present when the event "QOS_MONITORING" is subscribed. | EnQoSMon | +| reqAnis | array(RequiredAccessInfo) | C | 1..N | Represents the required access network information. It shall be present when the event "ANI_REPORT" is subscribed. | NetLoc | +| usgThres | UsageThreshold | O | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. | SponsoredConnectivity | +| notifCorrId | string | O | 0..1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | EnhancedSubscriptionToNotification | +| afAppIds | array(AfAppId) | O | 1..N | AF application identifier(s). It shall be present when the event "APP_DETECTION" is subscribed. | ApplicationDetectionEvents | +| directNotifInd | boolean | O | 0..1 | Indicates that the event notification of QoS Monitoring data is sent by the UPF to Local NEF or AF if it is included and set to true. It may be present when the event "QOS_MONITORING" is subscribed.
The default value "false" shall apply, if the attribute is not present. | ExposureToEAS | +| avrgWndw | AverWindow | O | 0..1 | Averaging window for the calculation of the data rate for the service data flow. It may be included when the "qosMonDatRate" attribute is included. | EnQoSMon | + +NOTE: The "pvdMon" attribute, when provided, contains the threshold(s) in units of milliseconds to trigger packet delay variation events for the UL, DL and/or Round Trip within the "repThreshDI", "repThreshUI" and/or "repThreshRp" attribute(s) respectively. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +Editor's note: Whether to reuse or enhance the QosMonitoringInformation data type for the "pdvMon" attribute is FFS. + +## 5.6.2.7 Type MediaComponent + +**Table 5.6.2.7-1: Definition of type MediaComponent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| afAppId | AfAppId | O | 0..1 | Contains information that identifies the particular service the AF session belongs to. | | +| afRoutReq | AfRoutingRequirement | O | 0..1 | Indicates the AF traffic routing requirements. | InfluenceOnTrafficRouting | +| afSvcReq | AfSvcRequirement | O | 0..1 | Indicates the AF requirements on steering traffic to a pre-configured chain of service functions on N6-LAN. | SFC | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information. | AuthorizationWithRequiredQoS | +| altSerReqs | array(string) | O | 1..N | Ordered list of alternative service requirements that include a set of QoS references. The lower the index of the array for a given entry, the higher the priority. (NOTE 1) | AuthorizationWithRequiredQoS | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 1..N | Ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 1) | AltSerReqsWithIndQoS | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | DisableUENotification | +| contVer | ContentVersion | O | 0..1 | Represents the content version of a media component. | MediaComponentVersioning | +| desMaxLatency | Float | O | 0..1 | Indicates a maximum desirable transport level packet latency in milliseconds. | FLUS, QoSHint | +| desMaxLoss | Float | O | 0..1 | Indicates the maximum desirable transport level packet loss rate in percent (without "%" sign). | FLUS, QoSHint | +| flusId | string | O | 0..1 | Indicates that the media component is used for FLUS media. It is derived from the media level attribute "a=label:" (see IETF RFC 4574 [50]) obtained from the SDP body. It contains the string after "a=label:" starting with "flus" and may be followed by more characters as described in 3GPP TS 26.238 [51]. | FLUS | +| medCompN | integer | M | 1 | Identifies the media component number, and it contains the ordinal number of the media component. | | +| medSubComps | map(MediaSubComponent) | O | 1..N | Contains the requested bitrate and filters for the set of service data flows identified by their common flow identifier. The key of the map is the attribute "fNum". | | +| medType | MediaType | O | 0..1 | Indicates the media type of the service. | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| maxPacketLossRateDI | PacketLossRateRm | O | 0..1 | Indicates the downlink maximum rate for lost packets that can be tolerated for the service data flow. | CHEM | +| maxPacketLossRateUI | PacketLossRateRm | O | 0..1 | Indicates the uplink maximum rate for lost packets that can be tolerated for the service data flow. | CHEM | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| maxSuppBwDI | BitRate | O | 0..1 | Maximum supported bandwidth for the Downlink. | IMS_SBI | +| maxSuppBwUI | BitRate | O | 0..1 | Maximum supported bandwidth for the Uplink. | IMS_SBI | +| minDesBwDI | BitRate | O | 0..1 | Minimum desired bandwidth for the Downlink. | IMS_SBI | +| minDesBwUI | BitRate | O | 0..1 | Minimum desired bandwidth for the Uplink. | IMS_SBI | +| mirBwUI | BitRate | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| fStatus | FlowStatus | O | 0..1 | Indicates whether the status of the service data flows is enabled, or disabled. | | +| preemptCap | PreemptionCapability | O | 0..1 | Defines whether the media flow may get resources that were already assigned to another media flow with a lower priority level. It may be included together with "prioSharingInd" for ARP decision. | MCPTT-Preemption | +| preemptVuln | PreemptionVulnerability | O | 0..1 | Defines whether the media flow may lose the resources assigned to it in order to admit a media flow with higher priority level. It may be included together with "prioSharingInd" for ARP decision. | MCPTT-Preemption | +| prioSharingInd | PrioritySharingIndicator | O | 0..1 | Indicates that the media flow is allowed to use the same ARP as media flows belonging to other "Individual Application Session Context" resources bound to the same PDU session. | PrioritySharing | +| resPrio | ReservPriority | O | 0..1 | Indicates the reservation priority. | | +| rrBw | BitRate | O | 0..1 | Indicates the maximum required bandwidth in bits per second for RTCP receiver reports within the session component as specified in IETF RFC 3556 [37]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. | IMS_SBI | +| rsBw | BitRate | O | 0..1 | Indicates the maximum required bandwidth in bits per second for RTCP sender reports within the session component as specified in IETF RFC 3556 [37]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. | IMS_SBI | +| sharingKeyDI | Uint32 | O | 0..1 | Identifies which media components share resources in the downlink direction.
If resource sharing applies between media components across "Individual Application Session Context" resources for the same PDU session, the same value of the "sharingKeyDI" attribute shall be used. If resource sharing does not apply among media components across "Individual Application Session Context" resources for the same PDU session, a different value for the "sharingKeyDI" attribute shall be used. | ResourceSharing | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| sharingKeyUI | Uint32 | O | 0..1 | Identifies which media components share resources in the uplink direction. If resource sharing applies between media components across "Individual Application Session Context" resources for the same PDU session, the same value of the "sharingKeyUI" attribute shall be used. If resource sharing does not apply among media components across "Individual Application Session Context" resources for the same PDU session, a different value for the "sharingKeyUI" attribute shall be used. | ResourceSharing | +| codecs | array(CodecsData) | O | 1..2 | Indicates the codec data. | | +| tsnQos | TsnQoSContainer | O | 0..1 | Transports QoS parameters for TSC traffic. | TimeSensitiveNetworking XRM_5G | +| tscaiInputUI | TscailnputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE (uplink flow direction). (NOTE 2) | TimeSensitiveNetworking | +| tscaiInputDI | TscailnputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress of the NW-TT (downlink flow direction). (NOTE 2) | TimeSensitiveNetworking | +| tscaiTimeDom | UInteger | O | 0..1 | Indicates the (g)PTP domain that the (TSN)AF is located in. | TimeSensitiveCommunication | +| capBatAdaptation | boolean | O | 0..1 | Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true". The default value is "false" if omitted. (NOTE 2) | EnTSCAC | +| rTLatencyInd | boolean | O | 0..1 | Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. | RTLatency | +| pduSetQos | PduSetQosPara | O | 0..1 | PDU Set QoS parameters for XRM traffic. | PDUSetHandling | +| pduSetProtDesc | ProtoDesc | O | 0..1 | Protocol description for PDU Set identification and/or detection of the end of data burst in UPF. | PDUSetHandling | +| periodInfo | PeriodicityInfo | O | 0..1 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. | PowerSaving | +| l4sInd | UplinkDownlinkSupport | O | 0..1 | Indicates whether ECN marking for L4S support is supported for the UL, the DL or both, UL and DL. | L4S | + +NOTE 1: The attributes "altSerReqs" and "altSerReqsData" are mutually exclusive. Of the two, only the attribute "altSerReqs" may be provided if the attribute "qosReference" is provided, while only the attribute "altSerReqsData" may be provided if the attribute "qosReference" is not provided. + +NOTE 2: The "burstArrivalTimeWnd" attribute, within the "tscaiInputUI" and/or "tscaiInputDI" attributes, and the "capBatAdaptation" attribute are mutually exclusive. + +**Editor's Note:** Whether the AF can provide an indication for detection of last PDU of the data burst is FFS based on stage 2 discussion. + +All IP flows within a "MediaSubComponent" data type are permanently disabled by supplying "FlowStatus" data type with a deletion indication. + +Bandwidth information and the "fStatus" attribute provided within the MediaComponent applies to all those IP flows within the media component, for which no corresponding information is being provided within the "medSubComps" attribute. As defined in 3GPP TS 29.513 [7], the bandwidth information within the media component level "marBwUI" and "marBwDI" attributes applies separately to each media subcomponent except for media subcomponents with a + +"flowUsage" attribute with the value "RTCP". The mapping of bandwidth information for RTCP media subcomponent is defined in 3GPP TS 29.513 [7] clause 7.3.3. + +**Editor's note:** It is FFS whether other IEs within the "tsnQos" attribute than "tscPackDelay" attribute can apply for multi-modal communication services. + +### 5.6.2.8 Type MediaSubComponent + +**Table 5.6.2.8-1: Definition of type MediaSubComponent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| afSigProtocol | AfSigProtocol | O | 0..1 | Indicates the protocol used for signalling between the UE and the NF service consumer. It may be included only if the "flowUsage" attribute is set to the value "AF_SIGNALLING". | ProvAFsignalFlow | +| ethfDescs | array(EthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink Ethernet flows. | | +| fNum | integer | M | 1 | Identifies the ordinal number of the service data flow. | | +| fDescs | array(FlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink IP flows. | | +| addInfoFlowDescs | array(AddFlowDescriptionInfo) | O | 1..2 | Represents additional flow description information (flow label and IPsec SPI) per Uplink and/or Downlink IP flows represented in the "fDescs" attribute. | AddFlowDescriptionInformation | +| fStatus | FlowStatus | O | 0..1 | Indicates whether the status of the service data flows is enabled or disabled. | | +| flowUsage | FlowUsage | O | 0..1 | Flow usage of the flows (e.g. RTCP, AF signalling). | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| tosTrCl | TosTrafficClass | O | 0..1 | Type of Service or Traffic Class. | | +| evSubsc | EventsSubscReqData | O | 0..1 | Identifies the events the application subscribes to at creation of a media component. (NOTE) | EnQoSMon | +| NOTE: If attribute "evSubsc" is present, one or more of the following IEs may be included: "events", "notifUri", "reqQosMonParams", "qosMon", "qosMonDatRate", "pdvReqMonParams", "pdvMon", "congestMon", "notifCorrelId", "afApplds", "directNotifInd", "avrgWndw". In addition, when present the attribute "events", one or more of the following Enumeration "AfEvent" may be included: "QOS_MONITORING", "PACK_DEL_VAR", "RT_DELAY_TWO_QOS_FLOWS". | | | | | | + +**Editor's Note:** Whether the internal AF or the NEF need to separate the MediaSubComponent or adding fDescs or ethfDescs inside the evSusc if different events applies to different single-modal data flow is FFS. + +**Editor's note:** It is FFS whether the notifUri and notifCorrelId attributes may be required for the evSubsc attribute. + +The bit rate information and flow status information provided within the "MediaSubComponent" data type takes precedence over information provided within "MediaComponent" data type. + +All service data flows within a "MediaSubComponent" data type are permanently disabled by supplying "FlowStatus" data type with a deletion indication. + +## 5.6.2.9 Type EventsNotification + +**Table 5.6.2.9-1: Definition of type EventsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| adReports | array(AppDetectionReport) | C | 0..1 | Includes the detected application report. It shall be present when the notified event is "APP_DETECTION". | ApplicationDetectionEvents | +| accessType | AccessType | C | 0..1 | Includes the access type. It shall be present when the notified event is "ACCESS_TYPE_CHANGE" or, if the feature "URSPEnforcement" is supported, when the notified event is "URSP_ENF_INFO". | | +| addAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the additional combination of Access Type and RAT Type available for MA PDU session. It may be present when the notified event is "ACCESS_TYPE_CHANGE" and the PDU session is a Multi-Access PDU session. | ATSSS | +| relAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the released combination of Access Type and RAT Type previously available for MA PDU session. It may be present when the notified event is "ACCESS_TYPE_CHANGE" and the PDU session is a Multi-Access PDU session. | ATSSS | +| anChargAddr | AccNetChargingAddress | O | 0..1 | Includes the access network charging address. It shall be present if available when the notified event is "CHARGING_CORRELATION". | IMS_SBI | +| anChargIds | array(AccessNetChargingIdentifier) | C | 1..N | Includes the access network charging identifier(s). It shall be present when the notified event is "CHARGING_CORRELATION". | IMS_SBI | +| anGwAddr | AnGwAddress | O | 0..1 | Access network Gateway Address. It carries the IP address of the ePDG used as IPSec tunnel endpoint with the UE for EPC/ePDG and 5GS interworking. It shall be present, if applicable, when the notified event is "ACCESS_TYPE_CHANGE". | | +| l4sReports | array(L4sSupport) | C | 1..N | ECN marking for L4S support information. It shall be present when the notified event is "L4S_SUPP". | L4S | +| evSubsUri | Uri | M | 1 | The Events Subscription URI. Identifies the Events Subscription sub-resource that triggered the notification. (NOTE 1, NOTE 5) | | +| evNotifs | array(AfEventNotification) | M | 1..N | Notifications about individual events. | | +| failedResourAllocReports | array(ResourcesAllocationInfo) | C | 1..N | Indicates the status of the PCC rule(s) related to certain failed media components. It shall be included when the event trigger is "FAILED_RESOURCES_ALLOCATION". | | +| succResourAllocReports | array(ResourcesAllocationInfo) | O | 1..N | Indicates the alternative service requirement the NG-RAN can guarantee to certain media components. It may be included when the event trigger is "SUCCESSFUL_RESOURCES_ALLOCATION". | AuthorizationWithRequiredQoS | +| noNetLocSupp | NetLocAccessSupport | O | 0..1 | Indicates the access network does not support the report of the requested access network information. | NetLoc | +| outOfCredReports | array(OutOfCreditInformation) | C | 1..N | Out of credit information per service data flow. It shall be present when the notified event is "OUT_OF_CREDIT". | IMS_SBI | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| plmnId | PlmnIdNid | C | 0..1 | PLMN Identifier or the SNPN Identifier. It shall be present when the notified event is "PLMN_CHG" or, if location information is required but is not available when the notified event is "ANI_REPORT". It shall be present if available when the notified event is "RAN_NAS_CAUSE".
(NOTE 2) | | +| qncReports | array(QosNotificationControlInfo) | C | 1..N | QoS notification control information. It shall be present when the notified event is "QOS_NOTIF". | | +| qosMonReports | array(QosMonitoringReport) | C | 1..N | QoS Monitoring reporting information. It shall be present when the notified event is "QOS_MONITORING". | QoSMonitoring | +| qosMonDatRateReports | array(QosMonitoringReport)t | C | 1..N | QoS Monitoring reporting information with data rate measurements. It shall be present when the notified event is "QOS_MONITORING" and data rate measurements are available. | EnQoSMon | +| congestReports | array(QosMonitoringReport) | C | 1..N | Congestion information. It shall be present when the notified event is "QOS_MONITORING". | EnQoSMon | +| pdvMonReports | array(PdvMonitoringReport) | C | 1..N | Packet Delay Variation information. It shall be present when the notified event is "PACK_DEL_VAR". | EnQoSMon | +| ranNasRelCauses | array(RanNasRelCause) | C | 1..N | RAN-NAS release cause. It shall be present if available when the notified event is "RAN_NAS_CAUSE". | RAN-NAS-Cause | +| ratType | RatType | O | 0..1 | RAT type. It shall be present, if applicable, when the notified event is "ACCESS_TYPE_CHANGE" or, if the feature "URSPEnforcement" is supported, when the notified event is "URSP_ENF_INFO". | | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates the satellite or non-satellite backhaul category of the PDU session. It shall be present, if applicable, when the notified event is "SAT_CATEGORY_CHG".
If the "EnSatBackhaulCatChg" feature is supported, the different dynamic satellite backhaul categories may also be provided. | SatelliteBackhaul | +| ueLoc | UserLocation | O | 0..1 | E-UTRA, or NR, and/or non-3GPP trusted and untrusted access user location information. "n3gppTai" and "n3lwflId" attributes within the "N3gaLocation" data type shall not be supplied. It shall be present if required and available when the notified event is "ANI_REPORT". It shall be present if available when the notified event is "RAN_NAS_CAUSE".
(NOTE 3) (NOTE 4) | NetLoc, RAN-NAS-Cause | +| ueLocTime | DateTime | O | 0..1 | Contains the NTP time at which the UE was last known to be in the location.
(NOTE 3) | NetLoc | +| ueTimeZone | TimeZone | O | 0..1 | UE time zone.
It shall be present if required and available when the notified event is "ANI_REPORT". It shall be present if available when the notified event is "RAN_NAS_CAUSE". | NetLoc, RAN-NAS-Cause | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| usgRep | AccumulatedUsage | C | 0..1 | Indicates the measured volume and/or time for sponsored data connectivity. It shall be present when the notified event is "USAGE_REPORT". | SponsoredConnectivity | +| urspEnfRep | UrspEnforcementInfo | C | 0..1 | Includes the URSP rule enforcement information received from a UE from associated URSP rule(s). It shall be present when the notified event is "URSP_ENF_INFO". | URSPEnforcement | +| sscMode | SscMode | O | 0..1 | SSC Mode of the PDU session. It may be present when the notified event is "URSP_ENF_INFO". | URSPEnforcement | +| ueReqDnn | Dnn | O | 0..1 | UE requested DNN. It may be present when the notified event is "URSP_ENF_INFO". | URSPEnforcement | +| redundantPduSessionInfo | RedundantPduSessionInformation | O | 0..1 | RSN and PDU session pair ID of the redundant PDU session. It may be present when the notified event is "URSP_ENF_INFO". | URSPEnforcement | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information. | TimeSensitiveNetworking | +| tsnPortManContD | PortManagementContainer | O | 0..1 | Transports port management information for the DS-TT port. | TimeSensitiveNetworking | +| tsnPortManContN | array(PortManagementContainer) | O | 1..N | Transports port management information for one or more NW-TT ports. | TimeSensitiveNetworking | +| ipv4AddrList | array(Ipv4AddrMask) | O | 1..N | List of Framed Route information of IPv4. | ExtraUEaddrReport | +| ipv6PrefixList | array(Ipv6Prefix) | O | 1..N | List of Framed Route information of IPv6 or list of IPv6 address prefixes of the served UE. | ExtraUEaddrReport | +| batOffsetInfo | BatOffsetInfo | C | 0..1 | The offset of the BAT and the optionally adjusted periodicity. It shall be present if available when the notified event is "BAT_OFFSET_INFO". | EnTSCAC | + +NOTE 1: Either the complete resource URI included in the "evSubsUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "evSubsUri" attribute may be used by the NF service consumer for the identification of the Individual Application Session Context resource related to the notification. + +NOTE 2: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 3: Whether the "ueLoc" attribute also encodes the age of location is implementation specific. + +NOTE 4: When the "ueLoc" attribute contains both, the 3GPP and the non-3GPP UE location, the "ueLocTime" attribute contains the age of the last known 3GPP UE location. + +NOTE 5: For event notifications of implicit subscriptions, the content of "evSubsUri" attribute shall be set as specified in clause 4.2.5.29. + +### 5.6.2.10 Type AfEventSubscription + +**Table 5.6.2.10-1: Definition of type AfEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| +| event | AfEvent | M | 1 | Subscribed Event. | | +| notifMethod | AfNotifMethod | O | 0..1 | If notifMethod is not supplied, the default value "EVENT_DETECTION" applies. | | +| repPeriod | DurationSec | O | 0..1 | Indicates the time interval between successive event notifications. It is supplied for notification method "PERIODIC".
If the feature "PacketDelayFailureReport" or "EnQoSMon" is supported, it also indicates the time interval at which a measurement failure needs to be reported if no measurement result is provided. It is supplied for notification methods "PERIODIC" and "EVENT_DETECTION". | EnhancedSubscriptionToNotification
PacketDelayFailureReport
EnQoSMon | +| waitTime | DurationSec | O | 0..1 | Indicates the minimum waiting time between subsequent reports. Only applicable when the notification is set to "EVENT_DETECTION". | EnhancedSubscriptionToNotification | + +### 5.6.2.11 Type AfEventNotification + +**Table 5.6.2.11-1: Definition of type AfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | AfEvent | M | 1 | Notified Event. | | +| flows | array(Flows) | O | 1..N | Affected Service Data Flows. | | +| retryAfter | UInteger | O | 0..1 | Indicates the estimate on how long it will take before it can be considered the paging procedure as completed. It may be provided when the event attribute indicates UE_TEMPORARILY_UNAVAILABLE. The value shall be in seconds. | UEUnreachable | + +### 5.6.2.12 Type TerminationInfo + +**Table 5.6.2.12-1: Definition of type TerminationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------| +| termCause | TerminationCause | M | 1 | Indicates the cause for requesting the deletion of the Individual Application Session Context resource. | | +| resUri | Uri | M | 1 | Identifies the Individual Application Session Context that triggered the termination notification.
(NOTE) | | +| NOTE: Either the complete resource URI included in the "resUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resUri" attribute may be used by the NF service consumer for the identification of the Individual Application Session Context resource related to the termination notification. | | | | | | + +### 5.6.2.13 Type AfRoutingRequirement + +**Table 5.6.2.13-1: Definition of type AfRoutingRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| appReloc | boolean | O | 0..1 | Indication of application relocation possibility.
When it is included and set to "true", it indicates that the application cannot be relocated once a location of the application is selected by the 5GC. The default value is "false". | InfluenceOnTrafficRouting | +| routeToLocs | array(RouteToLocation) | O | 1..N | A list of traffic routes to applications locations. | InfluenceOnTrafficRouting | +| spVal | SpatialValidity | O | 0..1 | Indicates where the traffic routing requirements apply. The absence of this attribute indicates no spatial restrictions. | InfluenceOnTrafficRouting | +| tempVals | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the NF service consumer request is to be applied. | InfluenceOnTrafficRouting | +| upPathChgSub | UpPathChgEvent | O | 0..1 | Subscription to UP path management events. | InfluenceOnTrafficRouting | +| addrPreserInd | boolean | O | 0..1 | Indicates whether UE IP address should be preserved.
This attribute shall set to "true" if preserved, otherwise, set to "false".
Default value is false if omitted. | URLLC | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity temporarily maintained for the source and target PSA. If it is included and set to "true", temporary simultaneous connectivity should be kept. The default value "false" applies, if the attribute is not present and has not been supplied previously. | SimultConnectivity | +| simConnTerm | DurationSec | C | 0..1 | Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure.
It may be included when the "simConnInd" attribute is set to true. | SimultConnectivity | +| maxAllowedUpLat | UInteger | O | 0..1 | Indicates the target user plane latency in units of milliseconds. | AF_latency | +| easIpReplaceInfos | array(EasIpReplacementInfo) | O | 1..N | Contains EAS IP replacement information. | EASIPreplacement | +| easRedisInd | boolean | O | 0..1 | Indicates the EAS rediscovery is required for the application if it is included and set to "true". Default value is "false" if omitted. The indication shall be invalid after it was applied unless it is provided again. | EASDiscovery | +| tfcCorreInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEASDNAI | + +### 5.6.2.14 Type ResourcesAllocationInfo + +**Table 5.6.2.14-1: Definition of type ResourcesAllocationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| mcResourcStatus | MediaComponentResourcesStatus | C | 0..1 | Indicates the status of the PCC rule(s) related to the media components identified by the "flows" attribute. | | +| flows | array(Flows) | C | 1..N | Identification of the flows. It shall be included if "MediaComponentVersioning" feature is supported. When "MediaComponentVersioning" feature is not supported, if no flows are provided, the status in the "mcResourcStatus" applies for all flows within the AF session. | | +| altSerReq | string | O | 0..1 | When present, indicates the alternative service requirement the NG-RAN can guarantee for the indicated "flows". | AuthorizationWithRequiredQoS | + +NOTE: The "mcResourcStatus" attribute shall be included if AuthorizationWithRequiredQoS feature is not supported. + +### 5.6.2.15 Type QosNotificationControlInfo + +**Table 5.6.2.15-1: Definition of type QosNotificationControlInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| notifType | QosNotifType | M | 1 | Indicates whether the GBR targets for the indicated SDFs are "NOT_GUARANTEED" or "GUARANTEED" again. | | +| flows | array(Flows) | C | 1..N | Identification of the flows. It shall be included if "MediaComponentVersioning" feature is supported. When "MediaComponentVersioning" feature is not supported, if no flows are provided, the notification in the "notifType" applies for all flows within the AF session. | | +| altSerReq | string | O | 0..1 | Indicates the alternative service requirement the NG-RAN can guarantee. It contains a QoS reference or the reference to the alternative individual QoS related parameters (see "altQosParamSetRef" attribute in Table 5.6.2.47). When it is omitted and the "notifType" attribute is NOT_GUARANTEED, it indicates that the lowest priority alternative service requirement could not be fulfilled by the NG-RAN. | AuthorizationWithRequiredQoS | +| altSerReqNotSupplnd | boolean | O | 0..1 | It may be set to true when the "notifType" attribute is NOT_GUARANTEED to indicate that alternative service requirements are not supported by NG-RAN. The default value false shall apply if the attribute is not present. It may be used when the AuthorizationWithRequiredQoS feature or the AltSerReqsWithIndQoS feature is supported. | AltQoSProfilesSupportReport | + +## 5.6.2.16 Type SpatialValidity + +**Table 5.6.2.16-1: Definition of type SpatialValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| presenceInfoList | map(PresenceInfo) | M | 1..N | Defines the presence information provisioned by the NF service consumer. The "presenceState" attribute within the "PresenceInfo" data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. | InfluenceOnTraffic Routing | + +## 5.6.2.17 Type EthFlowDescription + +**Table 5.6.2.17-1: Definition of type EthFlowDescription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| destMacAddr | MacAddr48 | O | 0..1 | Destination MAC address. | | +| ethType | string | M | 1 | A two-octet string that represents the Ethertype, as described in IEEE 802.3 [16] and IETF RFC 7042 [18] in hexadecimal representation.
Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the ethType shall appear first in the string, and the character representing the 4 least significant bits of the ethType shall appear last in the string. | | +| fDesc | FlowDescription | C | 0..1 | Contains the flow description for the Uplink or Downlink IP flow. It shall be present when the Ethertype is IP. (NOTE 3) | | +| fDir | FlowDirection | O | 0..1 | Contains the packet filter direction. Only the "DOWNLINK" or "UPLINK" value is applicable. (NOTE 2) | | +| sourceMacAddr | MacAddr48 | O | 0..1 | Source MAC address. | | +| vlanTags | array(string) | O | 1..2 | Customer-VLAN and/or Service-VLAN tags containing the VID, PCP/DEI fields as defined in IEEE 802.1Q [17] and IETF RFC 7042 [18]. The first/lower instance in the array stands for the Customer-VLAN tag and the second/higher instance in the array stands for the Service-VLAN tag.

Each field is encoded as a two-octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the PCP/DEI field shall appear first in the string, followed by character representing the 4 most significant bits of the VID field, and the character representing the 4 least significant bits of the VID field shall appear last in the string.

If only Service-VLAN tag is provided, empty string for Customer-VLAN tag shall be provided. | | +| srcMacAddrEnd | MacAddr48 | O | 0..1 | Source MAC address end. If this attribute is present, the sourceMacAddr attribute specifies the source MAC address start. E.g. srcMacAddrEnd with value 00-10-A4-23-3E-FE and sourceMacAddr with value 00-10-A4-23-3E-02 means all MAC addresses from 00-10-A4-23-3E-02 up to and including 00-10-A4-23-3E-FE. | MacAddressRange | +| destMacAddrEnd | MacAddr48 | O | 0..1 | Destination MAC address end. If this attribute is present, the destMacAddr attribute specifies the destination MAC address start. | MacAddressRange | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-------------|---------------| +| NOTE 1: The "srcMacAddrEnd" attribute may only be present if the "sourceMacAddr" attribute is present; the "destMacAddrEnd" attribute may only be present if the "destMacAddr" attribute is present. | | | | | | +| NOTE 2: If the "UPLINK" is included within the "fDir" attribute, the "sourceMacAddr" attribute and "srcMacAddrEnd" attribute (if MacAddressRange feature is supported) contain the UE address and "destMacAddr" attribute and "destMacAddrEnd" attribute (if MacAddressRange feature is supported) contain the remote address; otherwise if the "DOWNLINK" is included within the "fDir" attribute or the "fDir" attribute is never provided, the "sourceMacAddr" attribute and "srcMacAddrEnd" attribute (if MacAddressRange feature is supported) contain the remote address and "destMacAddr" attribute and "destMacAddrEnd" attribute (if MacAddressRange feature is supported) contain the UE address. | | | | | | +| NOTE 3: The direction of the "fDesc" attribute shall be set to "in" if the "UPLINK" is included within the "fDir" attribute; the direction of the "fDesc" attribute shall be set to "out" if the "DOWNLINK" is included within the "fDir" attribute or the "fDir" attribute is never provided. | | | | | | + +5.6.2.18 Void + +5.6.2.19 Void + +5.6.2.20 Type AnGwAddress + +**Table 5.6.2.20-1: Definition of type AnGwAddress** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------|---------------| +| anGwIpv4addr | Ipv4Addr | O | 0..1 | Includes the IPv4 address of the access network gateway control node. | | +| anGwIpv6addr | Ipv6Addr | O | 0..1 | Includes the IPv6 address of the access network gateway control node. | | +| NOTE: At least one address of the access network gateway control node (the IPv4 address or the IPv6 address or both if both addresses are available) shall be included. | | | | | | + +5.6.2.21 Type Flows + +**Table 5.6.2.21-1: Definition of type Flows** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| contVers | array(ContentVersion) | C | 1..N | Represents the content version of the content of a media component. If "MediaComponentVersioning" feature is supported, the content version shall be included if it was included when the corresponding media component was provided or modified. | MediaComponentVersioning | +| fNums | array(integer) | O | 1..N | Indicates the service data flows via their flow identifier. If no flow identifier is supplied, the Flows data type refers to all the flows matching the media component number. | | +| medCompN | integer | M | 1 | Identifies the media component number, and it contains the ordinal number of the media component. | | + +### 5.6.2.22 Type TemporalValidity + +**Table 5.6.2.22-1: Definition of type TemporalValidity** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| startTime | DateTime | O | 0..1 | Indicates the time from which the traffic routing requirements start to apply. The absence of this attribute indicates the traffic routing requirements apply immediately. | InfluenceOnTraffic Routing | +| stopTime | DateTime | O | 0..1 | Indicates the time when the traffic routing requirements cease to apply. The absence of this attribute indicates the traffic routing requirements do not cease at any time. | InfluenceOnTraffic Routing | + +### 5.6.2.23 Void + +### 5.6.2.24 Type AfRoutingRequirementRm + +This data type is defined in the same way as the "AfRoutingRequirement" data type, but: + +- with the OpenAPI "nullable: true" property; +- the removable attribute "spVal" is defined with the data type "SpatialValidityRm"; and +- the removable attributes "tempVals", "routeToLocs", "addrPreserInd", "simConnInd", "simConnTerm" and "easIpReplaceInfos" are defined as nullable in the OpenAPI. + +**Table 5.6.2.24-1: Definition of type AfRoutingRequirementRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| appReloc | boolean | O | 0..1 | Indication of application relocation possibility. When it is set to "true", it indicates that the application cannot be relocated once a location of the application is selected by the 5GC. | InfluenceOnTrafficRouting | +| routeToLocs | array(RouteToLocation) | O | 1..N | A list of traffic routes to applications locations. | InfluenceOnTrafficRouting | +| spVal | SpatialValidityRm | O | 0..1 | Indicates where the traffic routing requirements apply. | InfluenceOnTrafficRouting | +| tempVals | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the NF service consumer request is to be applied. | InfluenceOnTrafficRouting | +| upPathChgSub | UpPathChgEvent | O | 0..1 | Subscription to UP path management events. | InfluenceOnTrafficRouting | +| addrPreserInd | boolean | O | 0..1 | Indicates whether UE IP address should be preserved. | URLLC | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity temporarily maintained for the source and target PSA. If it is included and set to "true", temporary simultaneous connectivity should be kept. | SimultConnectivity | +| simConnTerm | DurationSecRm | C | 0..1 | Indication of the minimum time interval to be considered for inactivity of the traffic routed via the source PSA during the edge re-location procedure. | SimultConnectivity | +| maxAllowedUpLat | UIntegerRm | O | 0..1 | Indicates the target user plane latency in units of milliseconds. | AF_latency | +| easIpReplaceInfos | array(EasIpReplacementInfo) | O | 1..N | Contains EAS IP replacement information. | EASIPreplacement | +| easRedisInd | boolean | O | 0..1 | Indicates the EAS rediscovery is required for the application if it is included and set to "true". Default value is "false" if omitted. The indication shall be invalid after it was applied unless it is provided again. | EASDiscovery | +| tfcCorreInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEASDNAI | + +## 5.6.2.25 Type EventsSubscReqDataRm + +This data type is defined in the same way as the "EventsSubscReqData" data type, but: + +- with the OpenAPI "nullable: true" property; and +- the removable attribute "usgThres" is defined with the removable data type "UsageThresholdRm"; and removable attribute "qosMon" is defined with the removable data type "QosMonitoringInformationRm". + +**Table 5.6.2.25-1: Definition of type EventsSubscReqDataRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| events | array(AfEventSubscription) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | O | 0..1 | Notification URI. | | +| reqQosMonParams | array(RequestedQoSMonitoringParameter) | O | 1..N | Indicates the QoS information to be monitored, e.g. UL packet delay, DL packet delay, round trip packet delay and/or congestion information between the UE and the UPF, and/or data rate is to be monitored when the QoS Monitoring is enabled for the service data flow. | QoSMonitoring
EnQoSMon | +| qosMon | QoSMonitoringInformationRm | O | 0..1 | QoS Monitoring information. It can be present when the event "QOS_MONITORING" is subscribed. | QoSMonitoring | +| qosMonDatRate | QoSMonitoringInformationRm | O | 0..1 | Contains the data rate measurements information for the subscribed report. It can be present when the event "QOS_MONITORING" is subscribed and data rate measurements are required. | EnQoSMon | +| pdvReqMonParams | array(RequestedQoSMonitoringParameter) | O | 1..N | Indicates the Packet Delay Variation to be monitored, e.g. UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored. | EnQoSMon | +| pdvMon | QoSMonitoringInformationRm | O | 0..1 | Packet Delay Variation information for the subscribed report. It may be present when the event "PACK_DEL_VAR" is subscribed. | EnQoSMon | +| congestMon | QoSMonitoringInformation | O | 0..1 | Congestion threshold for the subscribed report. It may be present when the event "QOS_MONITORING" is subscribed.
(NOTE 2) | EnQoSMon | +| reqAnis | array(RequiredAccessInfo) | C | 1..N | Represents the required access network information. It shall be present when the event "ANI_REPORT" is subscribed. (NOTE) | NetLoc | +| usgThres | UsageThresholdRm | O | 0..1 | Includes the volume and/or time thresholds for sponsored data connectivity. | SponsoredConnectivity | +| notifCorrelId | string | O | 0..1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | EnhancedSubscriptionToNotification | +| directNotifInd | boolean | C | 0..1 | Indicates that the event notification of QoS Monitoring data is sent by the UPF to Local NEF or AF if it is included and set to true. It may be present when the event "QOS_MONITORING" is subscribed. | ExposureToEAS | +| avrgWndw | AverWindowRm | O | 0..1 | Averaging window for the calculation of the data rate for the service data flow | EnQoSMon | + +NOTE 1: "ANI\_REPORT" is the one-time reported event and thus the attribute "reqAnis" is not defined as removable attribute (i.e. with the removable data type "RequiredAccessInfoRm"). Once the access network information is reported to the NF service consumer the subscription to this event is automatically terminated in the PCF and the related information is removed. + +NOTE 2: The enumeration "ROUND\_TRIP" is not applicable to "QOS\_MONITORING" event. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +### 5.6.2.26 Type MediaComponentRm + +This data type is defined in the same way as the "MediaComponent" data type, but: + +- with the OpenAPI "nullable: true" property; and +- the removable attributes "afRoutReq" is defined with the removable data type "AfRoutingRequirementRm"; "maxPacketLossRateDI" and "maxPacketLossRateUI" are defined with the removable data type "PacketLossRateRm"; "medSubComps" is defined with the removable data type "MediaSubComponentRm"; "preemptCap" is defined with the removable data type "PreemptionCapabilityRm"; "preemptVuln" is defined with the removable data type "PreemptionVulnerabilityRm"; "marBwDI", "marBwUI", "minDesBwDI", "minDesBwUI", "mirBwDI", "mirBwUI", "maxSuppBwDI", "maxSuppBwUI", "rrBw", "rsBw" are defined with the removable data type "BitRateRm"; "sharingKeyDI", "sharingKeyUI", "tsnQos", and "pduSetQos" are defined with the removable data types "Uint32Rm", "TsnQosContainerRm" and "pduSetQosParaRm"; the removable attributes "desMaxLatency" and "desMaxLoss" are defined with the removable data type "FloatRm"; "pduSetprotDesc" is defined with the removable data type "ProtoDescRm", the removable attribute "flusId" is defined as nullable in the OpenAPI. +- the removable attributes "qosReference", "altSerReqs" and "afSfcReq" are defined as nullable. + +**Table 5.6.2.26-1: Definition of type MediaComponentRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| afAppId | AfAppId | O | 0..1 | Contains information that identifies the particular service the AF session belongs to. | | +| afRoutReq | AfRoutingRequirementRm | O | 0..1 | Indicates the AF traffic routing requirements. | InfluenceOnTrafficRouting | +| afSvcReq | AfSvcRequirement | O | 0..1 | Indicates the AF requirements on steering traffic to a pre-configured chain of service functions on N6-LAN. | SFC | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information. | AuthorizationWithRequiredQoS | +| altSerReqs | array(string) | O | 1..N | Ordered list of alternative service requirements that include a set of QoS references. The lower the index of the array for a given entry, the higher the priority. (NOTE 1) | AuthorizationWithRequiredQoS | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 1..N | Ordered list of alternative service requirements that include individual QoS parameter sets. The lower the index of the array for a given entry, the higher the priority. (NOTE 1) | AltSerReqsWithIndQoS | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation when it is included and set to "true". The fulfilled situation is either the QoS profile or an Alternative QoS Profile. The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | DisableUENotification | +| contVer | ContentVersion | O | 0..1 | Represents the content version of a media component. | MediaComponentVersioning | +| desMaxLatency | FloatRm | O | 0..1 | Indicates a maximum desirable transport level packet latency in milliseconds. | FLUS, QoSHint | +| desMaxLoss | FloatRm | O | 0..1 | Indicates the maximum desirable transport level packet loss rate in percent (without "%" sign). | FLUS, QoSHint | +| flusId | string | O | 0..1 | Indicates that the media component is used for FLUS media. It is derived from the media level attribute "a=label:" (see IETF RFC 4574 [50]) obtained from the SDP body. It contains the string after "a=label:" starting with "flus" and may be followed by more characters as described in 3GPP TS 26.238 [51]. | FLUS | +| maxPacketLossRateDI | PacketLossRateRm | O | 0..1 | Indicates the downlink maximum rate for lost packets that can be tolerated for the service data flow. | CHEM | +| maxPacketLossRateUI | PacketLossRateRm | O | 0..1 | Indicates the uplink maximum rate for lost packets that can be tolerated for the service data flow. | CHEM | +| medCompN | integer | M | 1 | Identifies the media component number, and it contains the ordinal number of the media component. | | +| medSubComps | map(MediaSubComponentRm) | O | 1..N | Contains the requested bitrate and filters for the set of service data flows identified by their common flow identifier. The key of the map is the attribute "fNum". | | +| medType | MediaType | O | 0..1 | Indicates the media type of the service. | | +| marBwUI | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Uplink. | | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| marBwDI | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| maxSuppBwDI | BitRateRm | O | 0..1 | Maximum supported bandwidth for the Downlink. | IMS_SBI | +| maxSuppBwUI | BitRateRm | O | 0..1 | Maximum supported bandwidth for the Uplink. | IMS_SBI | +| minDesBwDI | BitRateRm | O | 0..1 | Minimum desired bandwidth for the Downlink. | IMS_SBI | +| minDesBwUI | BitRateRm | O | 0..1 | Minimum desired bandwidth for the Uplink. | IMS_SBI | +| mirBwUI | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| fStatus | FlowStatus | O | 0..1 | Indicates whether the status of the service data flows is enabled, or disabled. | | +| preemptCap | PreemptionCapabilityRm | O | 0..1 | Defines whether the media flow may get resources that were already assigned to another media flow with a lower priority level. | MCPTT-Preemption | +| preemptVuln | PreemptionVulnerabilityRm | O | 0..1 | Defines whether the media flow may lose the resources assigned to it in order to admit a media flow with higher priority level. | MCPTT-Preemption | +| prioSharingInd | PrioritySharingIndicator | O | 0..1 | Indicates that the media flow is allowed to use the same ARP as media flows belonging to other "Individual Application Session Context" resources bound to the same PDU session. | PrioritySharing | +| resPrio | ReservPriority | O | 0..1 | Indicates the reservation priority. | | +| rrBw | BitRateRm | O | 0..1 | Indicates the maximum required bandwidth in bits per second for RTCP receiver reports within the session component as specified in IETF RFC 3556 [37]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. | IMS_SBI | +| rsBw | BitRateRm | O | 0..1 | Indicates the maximum required bandwidth in bits per second for RTCP sender reports within the session component as specified in IETF RFC 3556 [37]. The bandwidth contains all the overhead coming from the IP-layer and the layers above, i.e. IP, UDP and RTCP. | IMS_SBI | +| codecs | array(CodecsData) | O | 1..2 | Indicates the codec data. | | +| sharingKeyDI | Uint32Rm | O | 0..1 | Identifies which media components share resources in the downlink direction.
If resource sharing applies between media components across "Individual Application Session Context" resources for the same PDU session, the same value of the "sharingKeyDI" attribute shall be used. If resource sharing does not apply among media components across "Individual Application Session Context" resources for the same PDU session, a different value for the "sharingKeyDI" attribute shall be used. If resource sharing does no longer apply for this media component, the "sharingKeyDI" attribute shall be set to "null". | ResourceSharing | + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| sharingKeyUI | Uint32Rm | O | 0..1 | Identifies which media components share resources in the uplink direction. If resource sharing applies between media components across "Individual Application Session Context" resources for the same PDU session, the same value of the "sharingKeyUI" attribute shall be used. If resource sharing does not apply among media components across "Individual Application Session Context" resources for the same PDU session, a different value for the "sharingKeyUI" attribute shall be used. If resource sharing does no longer apply for this media component, the "sharingKeyUI" attribute shall be set to "null". | ResourceSharing | +| tsnQos | TsnQoSContainerRm | O | 0..1 | Transports QoS parameters for TSC traffic. | TimeSensitive Networking XRM_5G | +| tscaiInputUI | TscaiInputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE (uplink flow direction). | TimeSensitive Networking | +| tscaiInputDI | TscaiInputContainer | O | 0..1 | Transports TSCAI input parameters for TSC traffic at the ingress of the NW-TT (downlink flow direction). | TimeSensitive Networking | +| tscaiTimeDom | UInteger | O | 0..1 | Indicates the (g)PTP domain that the (TSN)AF is located in. | TimeSensitive Communication | +| capBatAdaptation | boolean | O | 0..1 | Indicates the capability for AF to adjust the burst sending time, when it is supported and set to "true". The default value is "false" if omitted. (NOTE 2) | EnTSCAC | +| rTLatencyInd | boolean | O | 0..1 | Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of the service, when it is included and set to "true". The default value is "false" if omitted. | RTLatency | +| pduSetQos | PduSetQosParaRm | O | 0..1 | PDU Set QoS parameters for XRM traffic. | PDUSetHandling | +| pduSetProtDesc | ProtoDescRm | O | 0..1 | Protocol description for PDU Set identification in UPF | PDUSetHandling | +| periodInfo | PeriodicityInfo | O | 0..1 | Indicates the time period between the start of the two data bursts in Uplink and/or Downlink direction. XRM_5G | PowerSaving | +| l4sInd | UplinkDownlinkSupport | O | 0..1 | When provided, it represents an explicit indication of whether ECN marking for L4S support is supported for the UL, the DL or both, UL and DL. It may be present when the media component is initially provided. | L4S | + +NOTE 1: The attributes "altSerReqs" and "altSerReqsData" are mutually exclusive. +NOTE 2: The "burstArrivalTimeWnd" attribute, within the "tscaiInputUI" and/or "tscaiInputDI" attributes, and the "capBatAdaptation" attribute are mutually exclusive. + +Editor's note: It is FFS whether other IEs within the "tsnQos" attribute than "tscPackDelay" attribute can apply for multi-modal communication services. + +### 5.6.2.27 Type MediaSubComponentRm + +This data type is defined in the same way as the "MediaSubComponent" data type, but: + +- with the OpenAPI "nullable: true" property; + +- the removable attributes "marBwDI", "marBwUI", defined with the removable data type "BitRateRm"; the removable attribute "tosTrCI", defined with the removable data type "TosTrafficClassRm"; and +- the removable attributes "ethfDescs" and "fDescs" and "addInfoFlowDescs" are defined as nullable in the OpenAPI. + +**Table 5.6.2.27-1: Definition of type MediaSubComponentRm** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| afSigProtocol | AfSigProtocol | O | 0..1 | Indicates the protocol used for signalling between the UE and the NF service consumer. It may be included only if the "flowUsage" attribute is set to the value "AF_SIGNALLING". | ProvAFsignalFlow | +| ethfDescs | array(EthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink Ethernet flows. | | +| fNum | integer | M | 1 | Identifies the ordinal number of the IP flow. | | +| fDescs | array(FlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink IP flows. | | +| addInfoFlowDescs | array(AddFlowDescriptionInfo) | O | 1..2 | Represents additional flow description information (flow label and IPsec SPI) per Uplink and/or Downlink IP flows represented in the "fDescs" attribute. | AddFlowDescriptionInformation | +| fStatus | FlowStatus | O | 0..1 | Indicates whether the status of the service data flows is enabled or disabled. | | +| flowUsage | FlowUsage | O | 0..1 | Flow usage of the flows (e.g. RTCP, AF signalling). | | +| marBwUI | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| tosTrCI | TosTrafficClassRm | O | 0..1 | Type of Service or Traffic Class. | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Identifies the events the application subscribes to at update of a media component. (NOTE) | EnQoSMon | +| NOTE: NOTE: If attribute "evSubsc" is present, one or more of the following IEs may be included: "events", "notifUri", "reqQosMonParams", "qosMon", "qosMonDatRate", "pdvReqMonParams", "pdvMon", "congestMon", "notifCorreId", "afAppIds", "directNotifInd", "avrgWndw". In addition, when present the attribute "events", one or more of the following Enumeration "AfEvent" may be included: "QOS_MONITORING", "PACK_DEL_VAR", "RT_DELAY_TWO_QOS_FLOWS". | | | | | | + +Editor's note: It is FFS whether the notifUri and notifCorreId attributes may be required for the evSubsc attribute. + +### 5.6.2.28 Type SpatialValidityRm + +This data type is defined in the same way as the "SpatialValidity" data type, but with the OpenAPI "nullable: true" property. + +### 5.6.2.29 Type ExtendedProblemDetails + +This data type is the "ProblemDetails" data type defined in 3GPP TS 29.571 [12] but extended with the attribute "acceptableServInfo" of data type "AcceptableServiceInfo". + +**Table 5.6.2.29-1: Definition of type ExtendedProblemDetails** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| acceptableServInfo | AcceptableServiceInfo | O | 0..1 | Describes information related to the acceptable service information, i.e., the maximum acceptable bandwidth for an AF session and/or for specific media components. | | +| NOTE: ExtendedProblemDetails data type also contains all the properties defined for ProblemDetails data type in 3GPP TS 29.571[12]. | | | | | | + +### 5.6.2.30 Type AcceptableServiceInfo + +**Table 5.6.2.30-1: Definition of type AcceptableServiceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accBwMedComps | map(MediaComponent) | O | 1..N | Indicates the maximum bandwidth that shall be authorized by the PCF for each media component of the map. Each media component of the map shall only include the "medCompN" attribute and the "marBwDI" and/or "marBwUI" attributes indicating the maximum acceptable bandwidth. The key of the map is the media component number. | | +| marBwUI | BitRate | O | 0..1 | Maximum acceptable bandwidth for the Uplink for the AF session. | | +| marBwDI | BitRate | O | 0..1 | Maximum acceptable bandwidth for the Downlink for the AF session. | | +| NOTE: When the acceptable bandwidth applies to one or more media components, only the "accBwMedComps" attribute shall be provided. When the acceptable bandwidth applies to the whole AF session, only the "marBwDI" and "marBwUI" attributes shall be present. | | | | | | + +### 5.6.2.31 Type UeIdentityInfo + +**Table 5.6.2.31-1: Definition of type UeIdentityInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|----------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Represents the GPSI. | | +| pei | Pei | O | 0..1 | Represents the PEI. | | +| supi | Supi | O | 0..1 | Represents the SUPI. | | +| NOTE: At least one of the "gpsi", "supi" and "pei" attributes shall be present. More than one attribute may be present simultaneously. | | | | | | + +### 5.6.2.32 Type AccessNetChargingIdentifier + +**Table 5.6.2.32-1: Definition of type AccessNetChargingIdentifier** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| accNetChaldValue | ChargingId | C | 0..1 | Contains a charging identifier. (NOTE 1) | | +| accNetChargIdString | string | C | 0..1 | A character string containing the charging identifier (see clause 5.1.9.1 of 3GPP TS 32.255 [35]). (NOTE 1) | AccNetChargId_String | +| flows | array(Flows) | O | 1..N | Identifications of the flows transported within the corresponding QoS flow. If no flows are provided, the charging identifier applies for all flows within the AF session. | | + +NOTE 1: The "accNetChaldValue" shall be used to encode the charging identifier when the charging identifier is within the Uint32 value range. The "accNetChargIdString" attribute shall be used to encode the charging identifier when the "AccNetChargId\_String" feature is supported by the AF and the PCF and the charging identifier is out of the Uint32 range. + +NOTE 2: When the "AccNetChargId\_String" feature is not supported and the value of the charging identifier is out of the ChargingId data type value range (Uint32) it is not possible to ensure a proper charging correlation using value of the "accNetChaldValue" attribute. + +### 5.6.2.33 Type OutOfCreditInformation + +**Table 5.6.2.33-1: Definition of type OutOfCreditInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| finUnitAct | FinalUnitAction | M | 1 | Indicates the termination action to be taken when the user's account cannot cover the service cost. | | +| flows | array(Flows) | O | 1..N | Identifications of the flows without available credit. If no flows are provided, the termination action in "finUnitAct" attribute applies for all flows within the AF session. | | + +## 5.6.2.34 Type QosMonitoringInformation + +Table 5.6.2.34-1: Definition of type QosMonitoringInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| repThreshDI | integer | O | 0..1 | Indicates the threshold in units of milliseconds for DL packet delay. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION".
Minimum = 0. | | +| repThreshUI | integer | O | 0..1 | Indicates the threshold in units of milliseconds for UL packet delay. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION".
Minimum = 0. | | +| repThreshRp | integer | O | 0..1 | Indicates the threshold in units of milliseconds for round trip packet delay.

If the "EnQoSMon" feature is supported and the "RT_DELAY_TWO_QOS_FLOWS" event is subscribed, it indicates the round trip delay of multiple QoS flows.

Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION".
Minimum = 0. | | +| repThreshDataRateDI | BitRate | O | 0..1 | Indicates the threshold for DL data rate. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION". | EnQoSMon | +| repThreshDataRateUI | BitRate | O | 0..1 | Indicates the threshold for UL data rate. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION". | EnQoSMon | +| conThreshDI | UInteger | O | 0..1 | Indicates the downlink threshold percentage of congestion reporting. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION".
Minimum = 0. | EnQoSMon | +| conThreshUI | UInteger | O | 0..1 | Indicates the uplink threshold percentage of congestion reporting. Only applicable when the "notifMethod" attribute is not supplied or the "notifMethod" is supplied and set to "EVENT_DETECTION".
Minimum = 0. | EnQoSMon | +| NOTE: | When the "EnQoSMon" is not supported, the "repThreshDI" attribute and/or the "repThreshUI" attribute and/or the "repThreshRp" attribute shall be present, when the "EnQoSMon" feature is supported, either the "repThreshDataRateDI" attribute and/or the "repThreshDataRateUI" attribute shall present, or the "repThreshDI" attribute and/or the "repThreshUI" attribute and/or the "repThreshRp" attribute shall be present. | | | | | + +Editor's note: Whether the applicable reporting frequency for the Data Rate QoS monitoring can be event triggered and/or periodic is FFS. + +Editor's Note: It is FFS whether the QoS monitoring requirements for congestion measurements are different than the ones for packet delay, i.e., it is FFS whether reporting period and reporting frequency apply, or different criteria needs to be applied. + +### 5.6.2.35 Type TsnQosContainer + +**Table 5.6.2.35-1: Definition of type TsnQosContainer** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------|---------------| +| maxTscBurstSize | ExtMaxDataBurstVol | O | 0..1 | Maximum burst size of the TSC traffic in units of Bytes.
Minimum = 4096, Maximum = 2000000. | | +| tscPackDelay | PacketDelBudget | O | 0..1 | Delay of the TSC traffic. | | +| maxPer | PacketErrRate | O | 0..1 | Packet error rate of the TSC traffic | ExtQoS | +| tscPrioLevel | TscPriorityLevel | O | 0..1 | TSC traffic priority in relation to other TSC and non-TSC traffic. | | + +NOTE: At least one of the attributes shall be present in an instance of the TsnQosContainer. + +### 5.6.2.36 Type PscfRestorationRequestData + +**Table 5.6.2.36-1: Definition of type PscfRestorationRequestData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | O | 0..1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
(NOTE 2) | | +| ipDomain | string | O | 0..1 | Indicates the IPv4 address domain information that assists session binding. | | +| sliceInfo | Snssai | O | 0..1 | Identifies the S-NSSAI. | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. | | +| uelpv4 | Ipv4Addr | C | 0..1 | The IPv4 address of the served UE.
(NOTE 1) | | +| uelpv6 | Ipv6Addr | C | 0..1 | The IPv6 address of the served UE.
(NOTE 1) | | + +NOTE 1: When present, only one of the served UE addressing parameters (the IPv4 address or the IPv6 address) shall always be included. + +NOTE 2: The PCF uses the DNN as received from the NF service consumer without applying any transformation (e.g. during session binding). To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +## 5.6.2.37 Type QosMonitoringReport + +Table 5.6.2.37-1: Definition of type QosMonitoringReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------| +| flows | array(Flows) | C | 1..N | Identification of the flows. It shall be included if "MediaComponentVersioning" feature is supported. When "MediaComponentVersioning" feature is not supported, if no flows are provided, the packet delay applies for all flows within the AF session. | | +| ulDelays | array(integer) | O | 1..N | Uplink packet delay in units of milliseconds. (NOTE 1) | | +| dlDelays | array(integer) | O | 1..N | Downlink packet delay in units of milliseconds. (NOTE 1) | | +| rtDelays | array(integer) | O | 1..N | Round trip delay in units of milliseconds. (NOTE 1)

If the "EnQoSMon" feature is supported and the "RT_DELAY_TWO_QOS_FLOWS" event is subscribed, it indicates the round trip delay of multiple QoS flows. | | +| pdmf | boolean | O | 0..1 | Packet delay measurement failure indicator. When set to true, it indicates that a packet delay failure has occurred. Default value is false if omitted. (NOTE 2) | PacketDelayFailureReport
EnQoSMon | +| cimf | boolean | O | 0..1 | Congestion information measurement failure indicator. When set to true, it indicates that a congestion information failure has occurred. Default value is false if omitted. (NOTE 3) | EnQoSMon | +| ulDataRate | BitRate | O | 0..1 | Uplink data rate. (NOTE 4) | EnQoSMon | +| dlDataRate | BitRate | O | 0..1 | Downlink data rate. (NOTE 4) | EnQoSMon | +| ulConInfo | UInteger | O | 0..1 | Percentage of uplink congestion level for exposure (without "%" sign). It may be present when the event "QOS_MONITORING" is subscribed. (NOTE 3) | EnQoSMon | +| dlConInfo | UInteger | O | 0..1 | Percentage of downlink congestion level for exposure (without "%" sign). It may be present when the event "QOS_MONITORING" is subscribed. (NOTE 3) | EnQoSMon | + +NOTE 1: In this release of the specification the maximum number of elements in the array is 2. When more than one value is sent at one given point of time for UL packet delay, DL packet delay or round trip packet delay respectively, they represent the minimum and maximum packet delays; when more than one value is sent at one given point of time for congestion information, they represent the minimum and maximum congestion information. + +NOTE 2: When the "pdmf" attribute is set to true, "ulDelays", "dlDelays" and "rtDelays" shall not be present. + +NOTE 3: When the "cimf" attribute is set to true, "ulCongInfo" and "dlConInfo" shall not be present. + +NOTE 4: When the "ulDataRate" and/or the "dlDataRate" attribute are included, the "pdmf", "ulDelays", "dlDelays" and "rtDelays" shall not be present. + +Editor's note: Whether a maximum and minimum data rate measurements calculated during the waiting time interval are the applicable is FFS. + +### 5.6.2.38 Type TsnQosContainerRm + +This data type is defined in the same way as the "TsnQoSContainer" data type, but with the OpenAPI "nullable: true" property for each of the attributes as well as for the entire data type. + +### 5.6.2.39 Type TscailInputContainer + +**Table 5.6.2.39-1: Definition of type TscailInputContainer** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| periodicity | UInteger | O | 0..1 | Unsigned 64-bit integer identifying a period of time in units of microseconds, i.e. 0 to (2 64 )-1.
Minimum = 0.
Maximum = 18446744073709551615.
Identifications of the time period between the start of two bursts in reference to the external GM. | | +| burstArrivalTime | DateTime | O | 0..1 | Indicates the arrival time of the data burst in reference to the external GM. | | +| surTimeInNumMsg | UInteger | O | 0..1 | Unsigned 32-bit integer indicates the survival time in terms of maximum number of messages an application can survive without any burst. A message is equivalent to a burst, i.e. 0 to (2 32 )-1.
Minimum = 0.
Maximum = 4294967295. | TimeSensitive Communication | +| surTimeInTime | UInteger | O | 0..1 | Unsigned 64-bit integer indicates the survival time in terms of time units of microseconds an application can survive without any burst, i.e. 0 to (2 64 )-1.
Minimum = 0.
Maximum = 18446744073709551615. | TimeSensitive Communication | +| periodicityRange | PeriodicityRange | O | 0..1 | Contains the acceptable time period range between the start of two bursts in reference to the external GM or the acceptable periodicity value(s).
(NOTE 1) | EnTSCAC | +| burstArrivalTimeWnd | TimeWindow | O | 0..1 | Contains the acceptable earliest and latest arrival time of the data burst in reference to the external GM. The start time contains the earliest arrival time, and the stop time contains the latest arrival time.
(NOTE 2) | EnTSCAC | + +NOTE 1: The attribute "periodicityRange" may be only present together with the "periodicity" attribute when the "burstArrivalTime" attribute and "burstArrivalTimeWnd" attribute are present. +NOTE 2: The "burstArrivalTimeWnd" attribute may only present when the "burstArrivalTime" is present. + +## 5.6.2.40 Type PduSessionTsnBridge + +**Table 5.6.2.40-1: Definition of type PduSessionTsnBridge** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| tsnBridgeInfo | TsnBridgeInfo | M | 1 | Reports the TSC user plane node information. | | +| tsnBridgeManCont | BridgeManagementContainer | O | 0..1 | Transports TSC user plane node management information. | | +| tsnPortManContD
stt | PortManagementContainer | O | 0..1 | Transports port management information for the DS-TT port. | | +| tsnPortManContN
wtt | array(PortManagementContainer) | O | 1..N | Transports port management information for one or more NW-TT ports. | | +| uelpv4Addr | Ipv4Addr | O | 0..1 | It represents the identifier of the PDU session related to the reported UP node information, and contains the UE IPv4 address.
It might be present for PDU sessions of IP type.
(NOTE 1) | TimeSensitive Communication | +| dnn | Dnn | O | 0..1 | The DNN of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
(NOTE 2) | TimeSensitive Communication | +| snssai | Snssai | O | 0..1 | Identifies the S-NSSAI. | TimeSensitive Communication | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. | TimeSensitive Communication | +| uelpv6AddrPrefix | Ipv6Prefix | O | 0..1 | It represents the identifier of the PDU session related to the reported UP node information, and contains the UE IPv6 address prefix.
It might be present for PDU sessions of IP type.
(NOTE 1) | TimeSensitive Communication | + +NOTE 1: For PDU sessions of IP type, either the uelpv4Addr or the uelpv6AddrPrefix shall be present in this release of the specification. + +NOTE 2: The PCF includes the DNN of the PDU session as received from the SMF without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +## 5.6.2.41 Type QosMonitoringInformationRm + +This data type is defined in the same way as the "QosMonitoringInformation" data type, but with the OpenAPI "nullable: true" property for the data type and for the "repThreshDatRateDI" and "repThreshDatRateUI" attributes. + +### 5.6.2.42 Type EventsSubscPutData + +**Table 5.6.2.42-1: Definition of type EventsSubscPutData** + +| Data Type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| EventsSubscReqData | C | 0..1 | Identifies the events the application subscribes to and represents the Events Subscription sub-resource data. It shall be present in the response to PUT requests as specified in table 5.3.4.3.1-3. | | +| EventsNotification | C | 0..1 | Describes the notification about the events already met at the time of subscription. It shall be present if available. | | +| NOTE: EventsSubscPutData data type is represented as a non-exclusive list of two data types: EventsSubscReqData and EventsNotification. | | | | | + +### 5.6.2.43 Type AppSessionContextUpdateDataPatch + +**Table 5.6.2.43-1: Definition of type AppSessionContextUpdateDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| ascReqData | AppSessionContextUpdateData | O | 0..1 | Describes the requested update to the services requirements of an Individual Application Session Context. | | + +### 5.6.2.44 Type AppDetectionReport + +**Table 5.6.2.44-1: Definition of type AppDetectionReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| adNotifType | AppDetectionNotifType | M | 1 | Indicates whether the report is about the detection of application start or application stop. | | +| afAppId | AfAppId | M | 1 | It indicates the application identifier of the detected traffic. | | + +## 5.6.2.45 Type PduSessionEventNotification + +**Table 5.6.2.45-1: Definition of PduSessionEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| evNotif | AfEventNotification | M | 1 | Indicates the reported event (e.g. "PDU_SESSION_STATUS"). | | +| supi | Supi | C | 0..1 | Contains the SUPI of the PDU session. It shall be present for the "PDU_SESSION_STATUS" event. | | +| uelpv4 | Ipv4Addr | C | 0..1 | The IPv4 address of the served UE for the reported PDU session.
(NOTE 1) | | +| uelpv6 | Ipv6Addr | C | 0..1 | The IPv6 address of the served UE for the reported PDU session.
(NOTE 1) | | +| ueMac | MacAddr48 | C | 0..1 | The MAC address of the served UE for the reported PDU session.
(NOTE 1) | | +| status | PduSessionStatus | C | 0..1 | It shall be present for the "PDU_SESSION_STATUS" event. Indicates whether the PDU session is "ESTABLISHED" or "TERMINATED". | | +| pcfInfo | PcfAddressingInfo | C | 0..1 | Contains PCF addressing information. It may be present for the "PDU_SESSION_STATUS" event. It shall be included when the PDU session operation is "ESTABLISHED". | | +| dnn | Dnn | C | 0..1 | Contains the DNN of the PDU session. It shall be included when the event is "PDU_SESSION_STATUS" and the PDU session operation is "ESTABLISHED".
(NOTE 2) | | +| snssai | Snssai | C | 0..1 | Contains the S-NSSAI of the PDU session. It shall be included when the event is "PDU_SESSION_STATUS" and the PDU session operation is "ESTABLISHED". | | +| gpsi | Gpsi | O | 0..1 | Contains the GPSI of the PDU session. It shall be included, if available, when the event is "PDU_SESSION_STATUS" and the PDU session operation is "ESTABLISHED". | | + +NOTE 1: Only one of the served UE addressing parameters (the IPv4 address or the IPv6 address or MAC address) shall always be included. + +NOTE 2: The PCF includes the DNN of the PDU session as received from the SMF without applying any transformation. To successfully perform DNN matching, in a specific deployment a DNN shall always be encoded either with the full DNN (e.g., because there are multiple Operator Identifiers for a Network Identifier) or the DNN Network Identifier only. The NF service consumer may include the DNN Operator Identifier based on local configuration. + +### 5.6.2.46 Type PcfAddressingInfo + +**Table 5.6.2.46-1: Definition of type PcfAddressingInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pcfFqdn | Fqdn | C | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. It shall be provided if available.
(NOTE) | | +| pcfIpEndPoints | array(IpEndPoint) | C | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. It shall be provided if available.
(NOTE) | | +| bindingInfo | string | O | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the Binding indications of the PCF indicated by the pcfFqdn IE and/or pcfIpEndPoints IE, and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [25], without the header name and including only binding indications for "nf-instance" or "nf-set" binding levels. | | + +NOTE: The pcfFqdn and/or the pcfIpEndPoints shall always be included. + +### 5.6.2.47 Type AlternativeServiceRequirementsData + +**Table 5.6.2.47-1: Definition of type AlternativeServiceRequirementsData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| altQosParamSetRef | string | M | 1 | It contains a reference to the alternative individual QoS related parameter(s) included in this set. The value of this attribute shall only be used in QoS notification control information (see "altSerReq" attribute in Table 5.6.2.15) to indicate the alternative individual QoS related parameters that can be guaranteed (if any). | | +| gbrUI | BitRate | O | 0..1 | Indicates the guaranteed bandwidth in uplink. | | +| gbrDI | BitRate | O | 0..1 | Indicates the guaranteed bandwidth in downlink. | | +| pdb | PacketDelBudget | O | 0..1 | Unsigned integer. It indicates the Packet Delay Budget expressed in milliseconds. | | +| per | PacketErrRate | O | 0..1 | It indicates the Packet Error Rate. | ExtQoS | + +NOTE: At least one of the "pdb" attribute, the "per" attribute (if the ExtQoS feature is supported), and the combination of the "gbrUI" and "gbrDI" attributes, shall be provided. + +### 5.6.2.48 Type PeriodicityRange + +**Table 5.6.2.48-1: Definition of type PeriodicityRange** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lowerBound | UInteger | C | 0..1 | Unsigned 64-bit integer identifying a period of time in units of microseconds, i.e. 0 to $(2^{64})-1$ .
Minimum = 0.
Maximum = 18446744073709551615.
Indicates the acceptable lower bound of the periodicity of the start two bursts in reference to the external GM. | | +| upperBound | UInteger | C | 0..1 | Unsigned 64-bit integer identifying a period of time in units of microseconds, i.e. 0 to $(2^{64})-1$ .
Minimum = 0.
Maximum = 18446744073709551615.
Indicates the acceptable upper bound of the periodicity of the start two bursts in reference to the external GM. | | + +NOTE: Either the "periodVals" attribute or both the "lowerBound" attribute and the "upperBound" attribute shall be present when PeriodicityRange is provided. + +### 5.6.2.49 Type AfSfcRequirement + +**Table 5.6.2.49-1: Definition of type AfSfcRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| sfclDI
(NOTE) | string | O | 0..1 | Reference to a pre-configured service function chain for downlink traffic. | | +| sfclUI
(NOTE) | string | O | 0..1 | Reference to a pre-configured service function chain for uplink traffic. | | +| spVal | SpatialValidityRm | O | 0..1 | Indicates where the traffic routing requirements apply. The absence of this attribute indicates no spatial restrictions. | | +| metadata | Metadata | O | 0..1 | Contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | | + +NOTE: Either "sfclDI", "sfclUI" or both shall be present when AfSfcRequirement is initially provided. + +### 5.6.2.50 Type BatOffsetInfo + +**Table 5.6.2.50-1: Definition of type BatOffsetInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------|---------------| +| ranBatOffsetNotif | integer | M | 1 | Indicates the BAT offset of the arrival time of the data burst in units of milliseconds. | | +| adjPeriod | UInteger | O | 0..1 | Contains the adjusted periodicity in units of milliseconds of the data bursts in reference to the external GM. | | +| flows | array(Flows) | C | 1..N | Identification of the flows. If no flows are provided, the BAT offset applies for all flows of the AF session. | | + +### 5.6.2.51 Type ProtoDesc + +This data type is defined to represent media protocol description of the service data flow + +**Table 5.6.2.51-1: Definition of type ProtoDesc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------|---------------| +| protocol | MediaProtocol | M | 1 | Indicates the protocol used by the service data flow. | | +| payloadType | PayloadType | O | 0..1 | Indicates the payload type used by the service data flow | | + +Editor's Note: The encoding and detailed entries within protocol and payloadType attribute is FFS. + +### 5.6.2.52 Type ProtoDescRm + +This data type is defined in the same way as the "ProtoDesc" data type, but with the OpenAPI "nullable: true" property for each of the attributes as well as for the entire data type. + +### 5.6.2.53 Type PdvMonitoringReport + +**Table 5.6.2.53-1: Definition of type PdvMonitoringReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------|---------------| +| flows | array(Flows) | O | 1..N | Identification of the flows. | | +| ulPdv | integer | O | 0..1 | Uplink packet delay variations in units of milliseconds. | | +| dlPdv | integer | O | 0..1 | Downlink packet delay variations in units of milliseconds. | | +| rtPdv | integer | O | 0..1 | Round trip packet delay variations in units of milliseconds. | | + +Editor's note: Whether reporting packet delay variation errors is needed is FFS. + +Editor's note: Whether the "ulPdv" and "dlPdv" attributes are single or plural is FFS. + +### 5.6.2.54 Type PeriodicityInfo + +**Table 5.6.2.54-1: Definition of type PeriodicityInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------|---------------| +| periodUI | DurationSecRm | O | 0..1 | Indicates the time period between the start of the two data bursts in Uplink direction. | | +| periodDI | DurationSecRm | O | 0..1 | Indicates the time period between the start of the two data bursts in Downlink direction. | | + +## 5.6.2.55 Type AddFlowDescriptionInfo + +**Table 5.6.2.55-1: Definition of AddFlowDescriptionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| spi | string | O | 0..1 | 4 octet string, representing the security parameter index of the IPSec packet in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [36]. | | +| flowLabel | string | O | 0..1 | 3-octet string, representing the IPv6 flow label header field in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [36]. | | +| flowDir | FlowDirection | O | 0..1 | Contains the packet filter direction to which the IPSec SPI and/or flow label applies. Only the "DOWNLINK" or "UPLINK" value is applicable. Default value is "DOWNLINK". | | + +## 5.6.2.56 Type L4sSupport + +**Table 5.6.2.56-1: Definition of type L4sSupport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifType | L4sNotifType | M | 1 | Indicates whether the ECN marking for L4S for the indicated SDFs are "NOT_AVAILABLE" or "AVAILABLE" again. | | +| flows | array(Flows) | O | 1..N | Identification of the flows. If no flows are provided, the notification in the "notifType" applies for all flows within the AF session. | | + +## 5.6.3 Simple data types and enumerations + +### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|----------------------------------------------------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| AfAppId | string | Contains an AF application identifier. | | +| AspId | string | Contains an identity of an application service provider. | SponsoredConnectivity | +| CodecData | string | Contains codec related information.
Refer to clause 5.3.7 of 3GPP TS 29.214 [20] for encoding. | | +| ContentVersion | integer | Unsigned 64-bit integer that indicates the version of some content, as e.g. the content of a media component. The content version shall be unique for the content and for the lifetime of that content.
(NOTE) | MediaComponentVersioning | +| FlowDescription | string | Defines a packet filter for an IP flow. It contains an IPFilterRule according to clause 4.3 of IETF RFC 6733 [52].
Refer to clause 5.3.8 of 3GPP TS 29.214 [20] for encoding. | | +| MultiModalId | string | Contains a multi-modal service identifier. | MultiMedia | +| SponId | string | Contains an identity of a sponsor. | SponsoredConnectivity | +| ServiceUrn | string | Indicates that an AF session is used for Emergency traffic.

It contains values of the service URN and it may include subservices, as defined in IETF RFC 5031 [34] or registered at IANA.

The string "urn:service:" in the beginning of the URN shall be omitted and all subsequent text shall be included. Examples of valid values of the ServiceUrn data structure are "sos", "sos.fire", "sos.police" and "sos.ambulance". | IMS_SBI | +| TosTrafficClass | string | 2-octet string, where each octet is encoded in hexadecimal representation. The first octet contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet contains the ToS/Traffic Class mask field. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. One example is that of a TFT packet filter as defined in 3GPP TS 24.008 [36]. | | +| TosTrafficClassRm | string | This data type is defined in the same way as the "TosTrafficClass" data type, but with the OpenAPI "nullable: true" property. | | +| TscPriorityLevel | integer | Indicates the TSC traffic Priority Level, within the range 1 to 8.
Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 8 as the lowest priority. | TimeSensitiveNetworking | +| TscPriorityLevelRm | integer | This data type is defined in the same way as the "TscPriorityLevel" data type, but with the OpenAPI "nullable: true" property. | TimeSensitiveNetworking | +| PayloadType | string | Represents the media protocol applicable for PDU set identification. | PDUSetHandling | +| MediaProtocol | string | Indicates the protocol used by the service data flow for PDU set identification. | PDUSetHandling | +| NOTE: The method of assigning content versions is implementation specific. | | | | + +### 5.6.3.3 Enumeration: MediaType + +The enumeration "MediaType" represents the media type of a media component. + +**Table 5.6.3.3-1: Enumeration MediaType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------|---------------| +| AUDIO | The type of media is audio. | | +| VIDEO | The type of media is video. | | +| DATA | The type of media is data. | | +| APPLICATION | The type of media is application data. | | +| CONTROL | The type of media is control. | | +| TEXT | The type of media is text. | | +| MESSAGE | The type of media is message | | +| OTHER | Other type of media. | | + +### 5.6.3.4 Enumeration: ReservPriority + +The enumeration "ReservPriority" represents the reservation priority. The lowest priority shall be indicated with the "PRIO\_1" value, the next after the lowest with the "PRIO\_2" value, and so on up to the highest priority which shall be indicated with "PRIO\_16". + +**Table 5.6.3.4-1: Enumeration ReservPriority** + +| Enumeration value | Description | Applicability | +|-------------------|-------------|---------------| +| PRIO_1 | | | +| PRIO_2 | | | +| PRIO_3 | | | +| PRIO_4 | | | +| PRIO_5 | | | +| PRIO_6 | | | +| PRIO_7 | | | +| PRIO_8 | | | +| PRIO_9 | | | +| PRIO_10 | | | +| PRIO_11 | | | +| PRIO_12 | | | +| PRIO_13 | | | +| PRIO_14 | | | +| PRIO_15 | | | +| PRIO_16 | | | + +### 5.6.3.5 Enumeration: ServAuthInfo + +The enumeration "ServAuthInfo" represents the result of the Npcf\_PolicyAuthorization service request from the NF service consumer. + +**Table 5.6.3.5-1: Enumeration ServAuthInfo** + +| Enumeration value | Description | Applicability | +|-------------------------------|-----------------------------------------------------------------------------------------------------|-------------------| +| TP_NOT_KNOWN | Indicates the transfer policy is not known. | | +| TP_EXPIRED | Indicates the transfer policy has expired. | | +| TP_NOT_YET_OCCURRED | Indicates the time window of the transfer policy has not yet occurred. | | +| ROUT_REQ_NOT_AUTHORIZE
D | Indicates the AF influence on traffic routing request is not allowed for the concerned PDU session. | RoutingReqOutcome | +| DIRECT_NOTIF_NOT_POSSIB
LE | Indicates that direct notification for QoS monitoring is not applied. | EnQoSMon | + +### 5.6.3.6 Enumeration: SponsoringStatus + +The enumeration "SponsoringStatus" represents whether the sponsored data connectivity is enabled or disabled/not-enabled. + +**Table 5.6.3.6-1: Enumeration SponsoringStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------|-----------------------| +| SPONSOR_DISABLED | Sponsored data connectivity is disabled or not enabled. | SponsoredConnectivity | +| SPONSOR_ENABLED | Sponsored data connectivity is enabled. | SponsoredConnectivity | + +### 5.6.3.7 Enumeration: AfEvent + +The enumeration "AfEvent" represents the traffic events the PCF can notify to the NF service consumer. + +**Table 5.6.3.7-1: Enumeration AfEvent** + +| Enumeration value
(NOTE 1) | Description | Applicability | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| ACCESS_TYPE_CHANGE | Access type change. | | +| ANI_REPORT | Access Network Information Report requested. | NetLoc | +| APP_DETECTION | Application detection report is requested. | ApplicationDetectionEvents | +| CHARGING_CORRELATION | Access Network Charging Correlation Information. | IMS_SBI | +| UP_PATH_CHG_FAILURE | Indicates that the enforcement of the AF required routing requirements (i.e. DNAI change) failed. | RoutingReqOutcome | +| L4S_SUPP | Indicates whether ECN marking for L4S is not available or available again in 5GS. | L4S | +| EPS_FALLBACK | Indicates the rejection of the establishment of the QoS flow for the requested voice media type in 5GS and the subsequent fallback to EPS. | EPSFallbackReport | +| EXTRA_UE_ADDR | Indicates the report of extra IP addresses or address ranges allocated for the given PDU session resulting from framed routes or IPv6 prefix delegation. | ExtraUEaddrReport | +| FAILED_QOS_UPDATE | Indicates that the invocation/revocation indication included in the mpsAction requested by the NF service consumer has failed. | MPSforDTS | +| FAILED_RESOURCES_ALLOCATION | Indicates that one or more of the SDFs of an Individual Application Session Context are deactivated at the SMF. It also indicates that the resources requested for a particular service information cannot be successfully allocated.
(NOTE 2) | | +| OUT_OF_CREDIT | Out of credit.
(NOTE 2) | IMS_SBI | +| PDU_SESSION_STATUS | Indicates the status of the PDU session (established/terminated). It only applies to notifications to the PCF for a UE as specified in clause 4.2.5.22. | | +| PLMN_CHG | This trigger indicates PLMN change. | | +| QOS_NOTIF | The GBR QoS targets of a SDF are not guaranteed or are guaranteed again. | | +| QOS_MONITORING | Indicates PCF to enable Qos Monitoring for the Service Data Flow. | QoSMonitoring | +| RAN_NAS_CAUSE | This trigger indicates RAN-NAS release cause information is available in the PCF from the SMF.
This event does not require explicit subscription. | RAN-NAS-Cause | +| REALLOCATION_OF_CREDIT | Credit has been reallocated after a former out of credit indication.
(NOTE 2) | IMS_SBI,
ReallocationOfCredit | +| SAT_CATEGORY_CHG | Indicates that the SMF has detected a change between different satellite backhaul category, or non-satellite backhaul. | SatelliteBackhaul | +| SUCCESSFUL_QOS_UPDATE | Indicates that the invocation/revocation indication included in the mpsAction requested by the NF service consumer has been successful. | MPSforDTS | +| SUCCESSFUL_RESOURCES_ALLOCATION | Indicates that the resources requested for particular service information have been successfully allocated.
(NOTE 2) | | +| TSN_BRIDGE_INFO | 5GS Bridge information (UMIC and/or PMIC(s)) received by the PCF from the SMF. | TimeSensitiveNetworking | +| USAGE_REPORT | Volume and/or time usage for sponsored data connectivity. | SponsoredConnectivity | +| UE_TEMPORARILY_UNAVAILABLE | UE is temporary unavailable. | UEUnreachable | +| BAT_OFFSET_INFO | BAT offset and the optionally adjusted periodicity received by the PCF from the SMF. | EnTSCAC | +| URSP_ENF_INFO | Request to forward UE reporting of URSP enforcement information from associated URSP rule(s). | URSPEnforcement | +| PACK_DEL_VAR | Indicates Packet Delay Variation is enabled for the SDF. | EnQoSMon | +| RT_DELAY_TWO_QOS_FLOWS | Indicates PCF to enable Qos Monitoring for the Round-trip delay measurement over two QoS flows | EnQoSMon | + +| Enumeration value
(NOTE 1) | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---------------| +| NOTE 1: The subscription to events applies at AF session level, i.e., to all the media components/subcomponents of the Individual Application Session Context resource, unless otherwise specified in the AF event definition.
NOTE 2: To ensure the event reports the requested information for all the media components of the Individual Application Session Context resource, the event should be subscribed during the initial provisioning of the service information. When the event is subscribed after the initial provisioning of the service information, it is unknown the status for the unmodified service information previously provisioned, and in this case, only future status changes may be reported. | | | + +### 5.6.3.8 Enumeration: AfNotifMethod + +The enumeration "AfNotifMethod" represents the notification methods that can be subscribed by an NF service consumer. + +**Table 5.6.3.8-1: Enumeration AfNotifMethod** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------------------|------------------------------------| +| EVENT_DETECTION | Event is reported whenever the event is met and the subscription is alive. | | +| ONE_TIME | Events are reported once the event is met and are not reported again unless the AF refreshes the subscription. | | +| PERIODIC | The notification is periodically sent. | EnhancedSubscriptionToNotification | + +### 5.6.3.9 Enumeration: QosNotifyType + +The enumeration "QosNotifyType" represents the types of reports bound to the notification of QoS Notification Control. + +**Table 5.6.3.9-1: Enumeration QosNotifyType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------|---------------| +| GUARANTEED | The QoS targets of one or more SDFs are guaranteed again. | | +| NOT_GUARANTEED | The QoS targets of one or more SDFs are not being guaranteed. | | + +### 5.6.3.10 Enumeration: TerminationCause + +The enumeration "TerminationCause" represents the types of causes the PCF can report when requesting to the NF service consumer the deletion of the "Individual Application Session Context" resource. + +**Table 5.6.3.10-1: Enumeration TerminationCause** + +| Enumeration value | Description | Applicability | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ALL_SDF_DEACTIVATION | All the SDFs of an Individual Application Session Context are deactivated at the SMF. It also indicates the case that the all resource allocation of an Individual Application Session Context fails. | | +| PDU_SESSION_TERMINATION | The PDU session is terminated. | | +| PS_TO_CS_HO | Indication of PS to CS handover is received from the SMF. | IMS_SBI | +| INSUFFICIENT_SERVER_RESOURCES | Indicates that the server is overloaded and needs to release the Individual Application Session Context resource. | | +| INSUFFICIENT_QOS_FLOW_RESOURCES | Indicates that the QoS flow has been deactivated due to insufficient QoS flow resources (e.g. the maximum number of QoS flows for the PDU session is reached). | | +| SPONSORED_DATA_CONNECTIVITY_DISALLOWED | Indicates that due to operator policy (e.g. disallowing the UE accessing the sponsored data connectivity in the roaming case) the Individual Application Session Context resource needs to be terminated. | | + +### 5.6.3.11 Void + +### 5.6.3.12 Enumeration: FlowStatus + +The enumeration "FlowStatus" represents whether the service data flow(s) are enabled or disabled. + +**Table 5.6.3.12-1: Enumeration FlowStatus** + +| Enumeration value | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ENABLED-UPLINK
(NOTE) | Indicates to enable associated uplink service data flow(s) and to disable associated downlink service data flow(s). | | +| ENABLED-DOWNLINK
(NOTE) | Indicates to enable associated downlink service data flow(s) and to disable associated uplink service data flow(s). | | +| ENABLED | Indicates to enable all associated service data flow(s) in both directions. | | +| DISABLED | Indicates to disable all associated service data flow(s) in both directions. | | +| REMOVED | Indicates to remove all associated service data flow(s). The IP Filters for the associated service data flow(s) shall be removed. The associated service data flows shall not be taken into account when deriving the authorized QoS. | | +| NOTE: The enumeration value does not follow the related naming convention (i.e. "UPPER_WITH_UNDERSCORE") defined in clause 5.1.4 of 3GPP TS 29.501 [6]. This enumeration value is however kept as currently defined in this specification for backward compatibility considerations. | | | + +### 5.6.3.13 Enumeration: MediaComponentResourcesStatus + +The enumeration "MediaComponentResourcesStatus" indicates whether the PCC rule(s) related to certain media component are active or inactive. + +**Table 5.6.3.13-1: Enumeration MediaComponentResourcesStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------|---------------| +| ACTIVE | Indicates that the PCC rule(s) related to certain media component are active. | | +| INACTIVE | Indicates that the PCC rule(s) related to certain media component are inactive. | | + +### 5.6.3.14 Enumeration: FlowUsage + +The enumeration "FlowUsage" represents the flow usage of the flows described by a media subcomponent. + +**Table 5.6.3.14-1: Enumeration FlowUsage** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| NO_INFO | This value is used to indicate that no information about the usage of the IP flow is being provided. This is the default value. | | +| RTCP | This value is used to indicate that an IP flow is used to transport RTCP. | | +| AF_SIGNALLING | This value is used to indicate that the IP flow is used to transport AF Signalling Protocols (e.g. SIP/SDP). | IMS_SBI | + +NOTE: A NF service consumer can choose not to identify RTCP flows, e.g. in order to avoid that RTCP flows are always enabled by the server. + +### 5.6.3.15 Enumeration: RequiredAccessInfo + +The enumeration "RequiredAccessInfo" represents the access network information required for the "Individual Application Session Context" resource. + +**Table 5.6.3.15-1: Enumeration RequiredAccessInfo** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| USER_LOCATION | Indicates that the user location information shall be reported. | | +| UE_TIME_ZONE | Indicates that the user timezone shall be reported. | | + +### 5.6.3.16 Enumeration: ServiceInfoStatus + +The enumeration "ServiceInfoStatus" represents whether the NF service consumer provided service information is preliminary or final. + +**Table 5.6.3.16-1: Enumeration ServiceInfoStatus** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FINAL | This value is used to indicate that the service has been fully negotiated between the two ends and service information provided is the result of that negotiation. | | +| PRELIMINARY | This value is used to indicate that the service information that the AF has provided to the PCF is preliminary and needs to be further negotiated between the two ends (e.g. for IMS when the service information is sent based on the SDP offer). | | + +### 5.6.3.17 Enumeration: SipForkingIndication + +The enumeration "SipForkingIndication" describes if several SIP dialogues are related to an "Individual Application Session Context" resource. + +**Table 5.6.3.17-1: Enumeration SipForkingIndication** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| SINGLE_DIALOGUE | This value is used to indicate that the "Individual Application Session Context" resource relates to a single SIP dialogue. This is the default value. | | +| SEVERAL_DIALOGUES | This value is used to indicate that the "Individual Application Session Context" resource relates to several SIP dialogues. | | + +### 5.6.3.18 Enumeration: AfRequestedData + +The enumeration "AfRequestedData" represents the information the NF service consumer requested to be exposed. + +**Table 5.6.3.18-1: Enumeration AfRequestedData** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UE_IDENTITY | Indicates that the NF service consumer requests the PCF to provide the 5GS-level UE identities (SUPI, GPSI, PEI) available for that PDU session. | | + +### 5.6.3.19 Enumeration: PreemptionControlInformation + +The enumeration "PreemptionControlInformation" represents how to perform pre-emption among multiple potential media flow candidates of same priority. + +**Table 5.6.3.19-1: Enumeration PreemptionControlInformation** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------|---------------| +| MOST_RECENT | Indicates the most recent added flow is to be pre-empted. | | +| LEAST_RECENT | Indicates the least recent added flow is to be pre-empted. | | +| HIGHEST_BW | Indicates the highest bandwidth flow is to be pre-empted. | | + +### 5.6.3.20 Enumeration: PrioritySharingIndicator + +The enumeration "PrioritySharingIndicator" represents whether the media component is enabled or disabled for priority sharing with other media components which are assigned the same 5QI and belong to other "Individual Application Session Context" resource bound to the same PDU session. + +**Table 5.6.3.20-1: Enumeration PrioritySharingIndicator** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ENABLED | Indicates the media component is allowed to share ARP with other medias which are assigned the same 5QI and belong to other "Individual Application Session Context" resources bound to the same PDU session. | | +| DISABLED | Indicates the media component is not allowed to share ARP with other media components. This is the default value when omitted. | | + +### 5.6.3.21 Enumeration: PreemptionControlInformationRm + +This data type is defined in the same way as the "PreemptionControlInformation" data type but also allows null value (specified as "NullValue" data type). + +### 5.6.3.22 Enumeration: MpsAction + +The enumeration "MpsAction" indicates the type of action for an MPS request. + +**Table 5.6.3.22-1: Enumeration MpsAction** + +| Enumeration value | Description | Applicability | +|--------------------------------------------|-------------------------------------------------------------------|-------------------------------| +| DISABLE_MPS_FOR_DTS | Disable MPS for DTS. | | +| ENABLE_MPS_FOR_DTS | Enable MPS for DTS. | | +| AUTHORIZE_AND_ENABLE_MPS_FOR_DTS | Check the UE's MPS subscription and enable MPS for DTS. | | +| AUTHORIZE_AND_ENABLE_MPS_FOR_AF_SIGNALLING | Check the UE's MPS subscription and enable MPS for AF signalling. | AuthorizationForMpsSignalling | + +### 5.6.3.23 Enumeration: AppDetectionNotifType + +The enumeration "AppDetectionNotifType" represents the types of reports bound to the notification of application detection information. + +**Table 5.6.3.23-1: Enumeration AppDetectionNotifType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------|---------------| +| APP_START | The start of application's traffic is detected. | | +| APP_STOP | The stop of application's traffic is detected. | | + +### 5.6.3.24 Enumeration: PduSessionStatus + +The enumeration "PduSessionStatus" represents the notification is about PDU session established or terminated. + +**Table 5.6.3.24-1: Enumeration PduSessionStatus** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| ESTABLISHED | The PDU session is established. | | +| TERMINATED | The PDU session is terminated. | | + +### 5.6.3.25 Enumeration: UplinkDownlinkSupport + +The enumeration "UplinkDownlinkSupport" represents whether a capability is supported for the UL, the DL or both, UL and DL. + +**Table 5.6.3.25-1: Enumeration UplinkDownlinkSupport** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------|---------------| +| UL | ECN marking for L4S supported for the UL. | | +| DL | ECN marking for L4S supported for the DL. | | +| UL_DL | ECN marking for L4S supported for the UL and the DL | | + +### 5.6.3.26 Enumeration: L4sNotifyType + +The enumeration "L4sNotifyType" represents unavailability or availability again of the ECN marking for L4S support in 5GS. + +**Table 5.6.3.26-1: Enumeration L4sNotifyType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| AVAILABLE | The ECN marking for L4S of one or more SDFs is available again. | | +| NOT_AVAILABLE | The ECN marking for L4S of one or more SDFs is not available. | | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Npcf\_PolicyAuthorization API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses shall apply. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Npcf\_PolicyAuthorization API. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_PolicyAuthorization API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID_SERVICE_INFORMATION | 400 Bad Request | The HTTP request is rejected because the service information is invalid or insufficient for the PCF to perform the requested action, e.g. invalid media type or invalid QoS reference. (NOTE 1) | +| FILTER_RESTRICTIONS | 400 Bad Request | The HTTP request is rejected because the IP flow descriptions cannot be handled by the PCF because the restrictions defined in clause 5.3.8 of 3GPP TS 29.214 [20] are not observed. (NOTE 1) | +| DUPLICATED_AF_SESSION | 400 Bad Request | The HTTP request is rejected because the new Individual Application Session Context relates to an AF session with another related active Individual Application Session Context, e.g. if the AF provided the same AF charging identifier for this new Individual Application Session Context that is already in use for the other ongoing Individual Application Session Context. (NOTE 2) | +| REQUESTED_SERVICE_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is rejected. (NOTE 7) | +| REQUESTED_SERVICE_TEMPORARILY_NOT_AUTHORIZED | 403 Forbidden | The service information provided in the request is temporarily rejected. (NOTE 2) | +| UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY | 403 Forbidden | The request for sponsored data connectivity is not authorized. (NOTE 3) | +| UNAUTHORIZED_NON_EMERGENCY_SESSION | 403 Forbidden | The PCF rejects a new AF session context setup because the session binding function associated a non-Emergency IMS session to a PDU session established to an Emergency DNN. | +| TEMPORARY_NETWORK_FAILURE | 403 Forbidden | The PCF rejects new or modified service information because there is a temporary failure in the access network (e.g. the SGW has failed) | +| INVALID_SIGNALING_PATH | 403 Forbidden | The PCF rejects the creation of the Individual Application Session Context resource because the NF that invoked the service request is invalid (i.e. the NEF sent the request while the PCF expected the TSCTSF to do so). (NOTE 8) | +| APPLICATION_SESSION_CONTEXT_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the specified Individual Application Session Context does not exist. (NOTE 4) | +| PDU_SESSION_NOT_AVAILABLE | 500 Internal Server Error | The PCF failed in executing session binding. (NOTE 5) | +| NOTE 1: This application error is included in the response to the POST request (see clauses 4.2.2.2 and 4.2.2.5) and to the PATCH request (see clauses 4.2.3.2 and 4.2.3.5). | | | +| NOTE 2: This application error is included in the response to the POST request (see clause 4.2.2.2) and to the PATCH request (see clause 4.2.3.2). | | | +| NOTE 3: This application error is included in the response to the POST request (see clause 4.2.2.5) and to the PATCH request (see clause 4.2.3.5). | | | +| NOTE 4: This application error is included in the responses to the GET, PATCH and delete custom operation requests to the Individual Application Session Context resource, and to the PUT and DELETE requests to the Events Subscription resource. | | | +| NOTE 5: This application error is included in the response to the POST request (see clauses 4.2.2.2, 4.2.6.3 and 4.2.2.27). | | | +| NOTE 6: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | +| NOTE 7: This application error is included in the response to the POST request (see clauses 4.2.2.2, 4.2.2.5, and 4.2.2.12) and to the PATCH request (see clauses 4.2.3.2, 4.2.3.5 and 4.2.3.12). | | | +| NOTE 8: This application error is included in the response to the POST request (see clause 4.2.2.2). | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_PolicyAuthorization API. They shall be negotiated using the extensibility mechanism defined in clause 6.6.2 of 3GPP TS 29.500 [5]. + +When requesting the PCF to create an Individual Application Session Context resource the NF service consumer shall indicate the optional features the NF service consumer supports for the Npcf\_PolicyAuthorization service by including the "suppFeat" attribute in the "AppSessionContextReqData" data type of the HTTP POST request. + +The PCF shall determine the supported features for the created Individual Application Session Context resource as specified in clause 6.6.2 of 3GPP TS 29.500 [5]. The PCF shall indicate the supported features in the HTTP response confirming the creation of the Individual Application Session Context resource by including the "suppFeat" attribute in the "AppSessionContextRespData" data type. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | InfluenceOnTrafficRouting | Indicates support of Application Function influence on traffic routing. If the PCF supports this feature, the NF service consumer may influence SMF routing to applications or subscribe to notifications of UP path management for the traffic flows of an active PDU session. | +| 2 | SponsoredConnectivity | Indicates support of sponsored data connectivity. If the PCF supports this feature, the NF service consumer may provide sponsored data connectivity to the SUPI. | +| 3 | MediaComponentVersioning | Indicates the support of the media component versioning. | +| 4 | URLLC | Indicates support of Ultra-Reliable Low-Latency Communication (URLLC) requirements, i.e. AF application relocation acknowledgement and UE address(es) preservation. The InfluenceOnTrafficRouting feature shall be supported in order to support this feature. | +| 5 | IMS_SBI | Indicates support of the communication with the 5GC IMS NF service consumer via Service Based Interfaces. | +| 6 | NetLoc | Indicates the support of access network information reporting. | +| 7 | ProvAFsignalFlow |

This indicates support for the feature of provisioning of AF signalling flow information as described in clauses 4.2.2.16 and 4.2.3.17. If the PCF supports this feature the NF service consumer may provision AF signalling flow information.

NOTE: This feature is used by the IMS Restoration Procedures to provide to the SMF the address of the P-CSCF selected by the UE, refer to 3GPP TS 23.380 [39].

The IMS_SBI feature shall be supported in order to support this feature.

| +| 8 | ResourceSharing | This feature indicates the support of resource sharing across several "Individual Application Session Context" resources. The IMS_SBI feature shall be supported in order to support this feature. | +| 9 | MCPTT | This feature indicates the support of Mission Critical Push To Talk services as described in 3GPP TS 24.379 [41]. | +| 10 | MCVideo | This feature indicates the support of Mission Critical Video services as described in 3GPP TS 24.281 [43]. | +| 11 | PrioritySharing | This feature indicates that Priority Sharing is supported as described in 3GPP TS 23.503 [4], clause 6.1.3.15. | +| 12 | MCPTT-Preemption | This feature indicates the support of service pre-emption based on the information provided by the NF service consumer. It requires that both PrioritySharing and MCPTT features are also supported. | +| 13 | MacAddressRange | Indicates the support of a set of MAC addresses with a specific range in the traffic filter. | +| 14 | RAN-NAS-Cause | This feature indicates the support for the release cause code information from the access network. | +| 15 | EnhancedSubscriptionToNotification |

Indicates the support of:

  • - Subscription to periodic notifications.
  • - Definition of a waiting time between the reporting of two event triggered events.
  • - Indication of whether the event has to be reported at PDU Session termination.
  • - Notification Correlation Id for a subscription to an event.
| +| 16 | QoSMonitoring | Indicates the support of QoS monitoring functionality and the report of packet delay monitoring. This feature requires the support of the EnhancedSubscriptionToNotification feature. | +| 17 | AuthorizationWithRequiredQoS | Indicates support of policy authorization for the AF session with required QoS. | +| 18 | TimeSensitiveNetworking | Indicates that the 5G System is integrated within the external network as a TSN bridge. | +| 19 | PCSCF-Restoration-Enhancement | This feature indicates support of P-CSCF Restoration Enhancement. It is used for the PCF and the P-CSCF to indicate if they support P-CSCF Restoration Enhancement. | +| 20 | CHEM | This feature indicates the support of Coverage and Handover Enhancements for Media (CHEM). | + +| Feature number | Feature Name | Description | +|----------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 21 | FLUS | This feature indicates the support of FLUS functionality as described in 3GPP TS 26.238 [51]. | +| 22 | EPSFallbackReport | This feature indicates the support of the report of EPS Fallback as defined in clauses 4.2.2.30, 4.2.3.29 and 4.2.5.15. | +| 23 | ATSSS | Indicates the support of the report of the multiple access types of a MA PDU session. | +| 24 | QoSHint | This feature indicates the support of specific QoS hint parameters as described in 3GPP TS 26.114 [30], clause 6.2.10. | +| 25 | ReallocationOfCredit | This feature indicates the support of notifications of reallocation of credits events. It requires the support of IMS_SBI feature. | +| 26 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 27 | DisableUENotification | Indicates the support of disabling QoS flow parameters signalling to the UE when the SMF is notified by the NG-RAN of changes in the fulfilled QoS situation. This feature requires that the AuthorizationWithRequiredQoS feature is also supported. | +| 28 | PatchCorrection | Indicates support of the correction to the PATCH method: When this feature is not supported, the interoperability between a NF service consumer and the PCF can only be ensured when it is not required the update of the Individual Application Session Context resource. | +| 29 | MPSforDTS | Indicates support for MPS for DTS as described in clauses 4.2.2.12.2 and 4.2.3.12. | +| 30 | ApplicationDetectionEvents | This feature indicates the support of the subscription to notifications of the detection of the start and stop of an application's traffic. | +| 31 | TimeSensitiveCommunication | Indicates that the 5G System is integrated within the external network as a TSC user plane node to enable Time Sensitive Communication, Time Synchronization and Deterministic Networking. This feature requires that the TimeSensitiveNetworking feature is also supported. | +| 32 | ExposureToEAS | This feature indicates the support of the indication of direct event notification of QoS monitoring events from the UPF to the Local NEF or AF in 5GC. This indication requires that the QoSMonitoring feature is supported. | +| 33 | SatelliteBackhaul | Indicates the support of the report of the satellite or non-satellite backhaul category of the PDU session. | +| 34 | RoutingReqOutcome | Indicates the support of:
- the report of UP path change failures; and
- the indication of whether AF routing requirements are applied.
It requires the support of InfluenceOnTrafficRouting feature. | +| 35 | EASDiscovery | This feature indicates the support of EAS (re)discovery. | +| 36 | AltSerReqsWithIndQoS | Indicates the support of provisioning Alternative Service Requirements with individual QoS parameters. This feature requires that the AuthorizationWithRequiredQoS feature is also supported. | +| 37 | SimultConnectivity | This feature indicates the support of the indication of temporary simultaneous connectivity over source and target PSA at edge relocation. This indication requires that the InfluenceOnTrafficRouting feature is supported. | +| 38 | EASIPreplacement | This feature indicates the support of provisioning of EAS IP replacement info. This support requires that InfluenceOnTrafficRouting feature is also supported. | +| 39 | AccNetChargId_String | This feature indicates the support of long character strings as access network charging identifier. | +| 40 | WLAN_Location | This feature indicates the support of the report of the WLAN location information received from the ePDG/EPC, if available. It is only applicable to EPS interworking scenarios as described in 3GPP TS 29.512 [8], Annex B. | + +| Feature number | Feature Name | Description | +|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 41 | AF_latency | This feature indicates support for edge relocation considering user plane latency. | +| 42 | UEUnreachable | This feature indicates the support for the reporting of UE temporary unavailable. | +| 43 | AltQoSProfilesSupportReport | This feature indicates the support of the report of whether Alternative QoS parameters are supported by NG-RAN. This feature requires that AuthorizationWithRequiredQoS feature is also supported. | +| 44 | PacketDelayFailureReport | Indicates the support of packet delay failure report as part of QoS Monitoring procedures. This feature requires that QoSMonitoring feature is supported. | +| 45 | EnTSCAC | Indicates the support of extensions to TSCAC and the RAN feedback for BAT offset and adjusted periodicity. This feature requires that the TimeSensitiveCommunication feature is also supported. | +| 46 | SignalingPathValidation | This feature indicates the support of the validation of the NF type that originates the Npcf_PolicyAuthorization_Create request. | +| 47 | ExtQoS | This feature indicates the support for the extensions to the QoS mechanisms. | +| 48 | CommonEASDNAI | This feature controls the support of the common EAS/DNAI selection. This feature requires that the InfluenceOnTrafficRouting feature is also supported. | +| 49 | SFC | This feature indicates support of Service Function Chaining functionality. | +| 50 | MultiMedia | This feature indicates the support of multi-modal or multimedia communication service. This feature acts as a basic functional block for extended reality (XR) and interactive media services. | +| 51 | EnSatBackhaulCatChg | This feature indicates the support also of the report of the dynamic satellite backhaul category of the PDU session. This feature requires the support of SatelliteBackhaul feature. | +| 52 | MTU_Size | This feature indicates the support of the report of the MTU size of the device side port. This feature requires that the TimeSensitiveCommunication feature is also supported. | +| 53 | ExtraUEaddrReport | This feature indicates the support of the report of additional IP addresses or address ranges allocated for the given PDU session resulting from framed routes or IPv6 prefix delegation. | +| 54 | AuthorizationForMpsSignalling | This feature indicates support for use of the "mpsAction" attribute to signal that the UE's MPS subscription shall be checked by the PCF prior to enabling MPS for AF signalling. | +| 55 | ExposureToTSC | This feature indicates the support of the direct event notification of TSC management information from the UPF to the TSCTSF or TSN AF in 5GC. This feature requires that the TimeSensitiveCommunication feature is also supported. | +| 56 | URSPEnforcement | This feature indicates the support of awareness of URSP rule enforcement | +| 57 | AddFlowDescriptionInformation | This feature indicates support for use e.g. of additional flow description parameters, as the flow label and the IPSec SPI. | +| 58 | QoSTiming_5G | This feature indicates the support of QoS timing information for the transfer and support of data transmission (e.g., AI/ML traffic transmission). | +| 59 | PDUSetHandling | This feature indicates the support of PDU Set handling. This feature may be used for eXtended Reality (XR) and interactive media services. | +| 60 | RTLatency | This feature indicates the support of Round-Trip latency. This feature may be used for eXtended Reality (XR) and interactive media services. | +| 61 | EnQoSMon | This feature indicates the support of enhanced QoS monitoring functionality, i.e. the report of the congestion information, and/or, the RTT delay over two QoS flows, and/or, the data rate information, and/or, the Packet Delay Variation monitoring. | +| 62 | PowerSaving | This feature indicates the support of power savings in multi modal traffic.. | +| 63 | L4S | This feature indicates the support of the AF indication of ECN marking for L4S support. | + +Editor's note: Whether an independent feature for RT latency is needed is FFS. + +Editor's note: Whether and/how to indicate the support of end of burst indication, and provision the flow periodicity information within the Power Saving feature is FFS. + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [25] and 3GPP TS 29.500 [5], the access to the Npcf\_PolicyAuthorization API, based on local configuration, may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [26]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [27]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF service consumer, prior to consuming services offered by the Npcf\_PolicyAuthorization API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [27], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Npcf\_PolicyAuthorization service. + +The Npcf\_PolicyAuthorization API the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [6], clause 4.x. + +**Table 5.9-1: OAuth2 scopes defined in Npcf\_PolicyAuthorization API** + +| Scope | Description | +|---------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| "npcf-policyauthorization" | Access to the PCF Policy Authorization API | +| "npcf-policyauthorization:policy-auth-mgmt" | Access to service operations applying to PCF Policy Authorization for creation, updation, deletion, retrieval | + +## Annex A (normative): OpenAPI specification + +### A.1 General + +The present Annex contains an OpenAPI [11] specification of HTTP messages and content bodies used by the Npcf\_PolicyAuthorization API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [28] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +### A.2 Npcf\_PolicyAuthorization API + +``` +openapi: 3.0.0 + +info: + title: Npcf_PolicyAuthorization Service API + version: 1.3.0-alpha.5 + description: | + PCF Policy Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.514 V18.4.0; 5G System; Policy Authorization Service; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.514/' + +servers: + - url: '{apiRoot}/npcf-policyauthorization/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + +paths: + /app-sessions: + post: + summary: Creates a new Individual Application Session Context resource + operationId: PostAppSessions + tags: + - Application Sessions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + requestBody: + description: Contains the information for the creation the resource. + required: true + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/AppSessionContext' +responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + headers: + Location: + description: > + Contains the URI of the created individual application session context resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} + or the URI of the created events subscription sub-resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} + /events-subscription + required: true + schema: + type: string + '303': + description: > + See Other. The result of the HTTP POST request would be equivalent to the existing + Application Session Context. + headers: + Location: + description: > + Contains the URI of the existing individual Application Session Context resource. + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: > + Indicates the time the AF has to wait before making a new request. It can be a + non-negative integer (decimal number) indicating the number of seconds the AF + has to wait before making a new request or an HTTP-date after which the AF can + retry a new request. + schema: + anyOf: + - type: integer + - type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + terminationRequest: + '{ $request.body#/ascReqData/notifUri }/terminate': + post: + requestBody: + description: > + +``` + +``` + + Request of the termination of the Individual Application Session Context. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationInfo' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + eventNotification: + '{ $request.body#/ascReqData/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +``` + +``` +detected5GsBridgeForPduSession: + '{$request.body#/ascReqData/evSubsc/notifUri}/new-bridge': + post: + requestBody: + description: Notification of a new TSC user plane node detected in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionTsnBridge' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +eventNotificationPduSession: + '{$request.body#/ascReqData/evSubsc/notifUri}/pdu-session': + post: + requestBody: + description: Notification of PDU session established or terminated. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionEventNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/app-sessions/pcscf-restoration: + post: + summary: "Indicates P-CSCF restoration and does not create an Individual Application Session Context" + operationId: PcscfRestoration + tags: + - PCSCF Restoration Indication + requestBody: + description: PCSCF Restoration Indication. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcscfRestorationRequestData' + responses: + '204': + description: The deletion is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/app-sessions/{appSessionId}: + get: + summary: "Reads an existing Individual Application Session Context" + operationId: GetAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' +``` + +``` + + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: + summary: "Modifies an existing Individual Application Session Context" + operationId: ModAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization + - oAuth2ClientCredentials: + - npcf-policyauthorization + - npcf-policyauthorization:policy-auth-mgmt + parameters: + - name: appSessionId + description: String identifying the resource. + in: path + required: true + schema: + type: string + requestBody: + description: Modification of the resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AppSessionContextUpdateDataPatch' + responses: + '200': + description: > + Successful modification of the resource and a representation of that resource is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The successful modification. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: > + +``` + +``` + +Indicates the time the AF has to wait before making a new request. It can be a +non-negative integer (decimal number) indicating the number of seconds the AF has +to wait before making a new request or an HTTP-date after which the AF can retry +a new request. +schema: + anyOf: + - type: integer + - type: string +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + eventNotification: + '{ $request.body#/ascReqData/evSubsc/notifUri }/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' +responses: + '204': + description: The receipt of the notification is acknowledged + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/app-sessions/{appSessionId}/delete: + post: + summary: "Deletes an existing Individual Application Session Context" + operationId: DeleteAppSession + tags: + - Individual Application Session Context (Document) + security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + + - npcfc-policyauthorization + - oAuth2ClientCredentials: + - npcfc-policyauthorization + - npcfc-policyauthorization:policy-auth-mgmt +parameters: + - name: appSessionId + description: String identifying the Individual Application Session Context resource. + in: path + required: true + schema: + type: string +requestBody: + description: > + Deletion of the Individual Application Session Context resource, req notification. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' +responses: + '200': + description: The deletion of the resource is confirmed and a resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The deletion is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/app-sessions/{appSessionId}/events-subscription: + put: + summary: "creates or modifies an Events Subscription subresource" + operationId: updateEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Events Subscription resource. + in: path + required: true + schema: + type: string + requestBody: + description: Creation or modification of an Events Subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + +``` + +``` + +'201': + description: > + The creation of the Events Subscription resource is confirmed and its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' + headers: + Location: + description: > + Contains the URI of the created Events Subscription resource, + according to the structure + {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/ + events-subscription + required: true + schema: + type: string +'200': + description: > + The modification of the Events Subscription resource is confirmed its representation is + returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' +'204': + description: > + The modification of the Events Subscription subresource is confirmed without returning + additional data. +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + eventNotification: + '{ $request.body#/notifUri }/notify': + post: + requestBody: + description: > + Contains the information for the notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +delete: + summary: deletes the Events Subscription subresource + operationId: DeleteEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: String identifying the Individual Application Session Context resource. + in: path + required: true + schema: + type: string + responses: + '204': + description: > + The deletion of the of the Events Subscription sub-resource is confirmed without + returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-policyauthorization: Access to the Npcf_PolicyAuthorization API + npcf-policyauthorization:policy-auth-mgmt: > + Access to service operations applying to PCF Policy Authorization for creation, + updation, deletion, retrieval. + +schemas: + +``` + +``` +AppSessionContext: + description: Represents an Individual Application Session Context resource. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextReqData' + ascRespData: + $ref: '#/components/schemas/AppSessionContextRespData' + evsNotif: + $ref: '#/components/schemas/EventsNotification' + +AppSessionContextReqData: + description: Identifies the service requirements of an Individual Application Session Context. + type: object + required: + - notifUri + - suppFeat + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + - required: [ueMac] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afChargId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + afReqData: + $ref: '#/components/schemas/AfRequestedData' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + aspId: + $ref: '#/components/schemas/AspId' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' + mcpttId: + description: Indication of MCPTT service request. + type: string + mcVideoId: + description: Indication of MCVideo service request. + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + minProperties: 1 + description: > + Contains media component information. The key of the map is the medCompN attribute. + multiModalId: + $ref: '#/components/schemas/MultiModalId' + ipDomain: + type: string + mpsAction: + $ref: '#/components/schemas/MpsAction' + mpsId: + description: Indication of MPS service request. + type: string + mcsId: + description: Indication of MCS service request. + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformation' + qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +``` + +``` +servUrn: + $ref: '#/components/schemas/ServiceUrn' +sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +sponId: + $ref: '#/components/schemas/SponId' +sponStatus: + $ref: '#/components/schemas/SponsoringStatus' +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' +tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' +tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' +tsnPortManContNwts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 +tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +tscNotifCorreId: + type: string + description: > + Correlation identifier for TSC management information notifications. + +AppSessionContextRespData: + description: > + Describes the authorization data of an Individual Application Session Context created by + the PCF. + type: object + properties: + servAuthInfo: + $ref: '#/components/schemas/ServAuthInfo' + ueIds: + type: array + items: + $ref: '#/components/schemas/UeIdentityInfo' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +AppSessionContextUpdateDataPatch: + description: > + Identifies the modifications to an Individual Application Session Context and/or the + modifications to the sub-resource Events Subscription. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextUpdateData' + +AppSessionContextUpdateData: + description: > + Identifies the modifications to the "ascReqData" property of an Individual Application + Session Context which may include the modifications to the sub-resource Events Subscription. + type: object + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + aspId: + $ref: '#/components/schemas/AspId' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + evSubsc: +``` + +``` + + $ref: '#/components/schemas/EventsSubscReqDataRm' + mcpttId: + description: Indication of MCPTT service request. + type: string + mcVideoId: + description: Indication of modification of MCVideo service. + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponentRm' + minProperties: 1 + description: > + Contains media component information. The key of the map is the medCompN attribute. + mpsAction: + $ref: '#/components/schemas/MpsAction' + mpsId: + description: Indication of MPS service request. + type: string + mcsId: + description: Indication of MCS service request. + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformationRm' + qosDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + qosInactInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + sipForkInd: + $ref: '#/components/schemas/SipForkingIndication' + sponId: + $ref: '#/components/schemas/SponId' + sponStatus: + $ref: '#/components/schemas/SponsoringStatus' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtt: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + tscNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + tscNotifCorreId: + type: string + description: > + Correlation identifier for TSC management information notifications. + +EventsSubscReqData: + description: Identifies the events the application subscribes to. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformation' + qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformation' + pdvReqMonParams: + +``` + +``` + + type: array + items: + $ref: + 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + pdvMon: + $ref: '#/components/schemas/QosMonitoringInformation' + congestMon: + $ref: '#/components/schemas/QosMonitoringInformation' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + notifCorreId: + type: string + afAppIds: + type: array + items: + $ref: '#/components/schemas/AfAppId' + minItems: 1 + directNotifInd: + type: boolean + avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + +EventsSubscReqDataRm: + description: > + This data type is defined in the same way as the EventsSubscReqData data type, but with + the OpenAPI nullable property set to true. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + items: + $ref: + 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + qosMonDatRate: + $ref: '#/components/schemas/QosMonitoringInformationRm' + pdvReqMonParams: + type: array + items: + $ref: + 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + pdvMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + congestMon: + $ref: '#/components/schemas/QosMonitoringInformation' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 + usgThres: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notifCorreId: + type: string + directNotifInd: + type: boolean + nullable: true + avrgWndw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + nullable: true + +``` + +``` + +MediaComponent: + description: Identifies a media component. + type: object + required: + - medCompN + allOf: + - not: + required: [altSerReqs,altSerReqsData] + - not: + required: [qosReference,altSerReqsData] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + qosReference: + type: string + disUeNotif: + type: boolean + altSerReqs: + type: array + items: + type: string + minItems: 1 + altSerReqsData: + type: array + items: + $ref: '#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + Contains alternative service requirements that include individual QoS parameter sets. + contVer: + $ref: '#/components/schemas/ContentVersion' + codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + flusId: + type: string + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + medCompN: + type: integer + medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponent' + minProperties: 1 + description: > + Contains the requested bitrate and filters for the set of service data flows identified + by their common flow identifier. The key of the map is the fNum attribute. + medType: + $ref: '#/components/schemas/MediaType' + minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapability' + preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerability' + prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' + resPrio: + $ref: '#/components/schemas/ReservPriority' + rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + tsnQos: + $ref: '#/components/schemas/TsnQosContainer' + tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + capBatAdaptation: + type: boolean + description: > + Indicates the capability for AF to adjust the burst sending time, when it is supported + and set to "true". The default value is "false" if omitted. + rTlatencyInd: + type: boolean + description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". The default value is "false" if + omitted. + pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara' + pduSetProtDesc: + $ref: '#/components/schemas/ProtoDesc' + periodInfo: + $ref: '#/components/schemas/PeriodicityInfo' + l4sInd: + $ref: '#/components/schemas/UplinkDownlinkSupport' + +MediaComponentRm: + description: > + This data type is defined in the same way as the MediaComponent data type, but with the + OpenAPI nullable property set to true. + type: object + required: + - medCompN + not: + required: [altSerReqs,altSerReqsData] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + afSfcReq: + $ref: '#/components/schemas/AfSfcRequirement' + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + altSerReqsData: + type: array + items: + $ref: '#/components/schemas/AlternativeServiceRequirementsData' + minItems: 1 + description: > + +``` + +``` + + Contains removable alternative service requirements that include individual QoS + parameter sets. + nullable: true +disUeNotif: + type: boolean +contVer: + $ref: '#/components/schemas/ContentVersion' +codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 +desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' +desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' +flusId: + type: string + nullable: true +fStatus: + $ref: '#/components/schemas/FlowStatus' +marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' +maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' +maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +medCompN: + type: integer +medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponentRm' + minProperties: 1 + description: > + Contains the requested bitrate and filters for the set of service data flows identified + by their common flow identifier. The key of the map is the fNum attribute. +medType: + $ref: '#/components/schemas/MediaType' +minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapabilityRm' +preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerabilityRm' +prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' +resPrio: + $ref: '#/components/schemas/ReservPriority' +rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' +sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' +sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' +tsnQos: + $ref: '#/components/schemas/TsnQosContainerRm' +tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' +tscaiInputUl: + $ref: '#/components/schemas/TscaiInputContainer' +tscaiTimeDom: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +``` + +``` + +capBatAdaptation: + type: boolean + description: > + Indicates the capability for AF to adjust the burst sending time, when it is supported + and set to "true". The default value is "false" if omitted. +rTLatencyInd: + type: boolean + description: > + Indicates the service data flow needs to meet the Round-Trip (RT) latency requirement of + the service, when it is included and set to "true". The default value is "false" if + omitted. +pduSetQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosParaRm' +pduSetProtDesc: + $ref: '#/components/schemas/ProtoDescRm' +periodInfo: + $ref: '#/components/schemas/PeriodicityInfo' +l4sInd: + $ref: '#/components/schemas/UplinkDownlinkSupport' +nullable: true + +MediaSubComponent: + description: Identifies a media subcomponent. + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethFDescs: + type: array + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + addInfoFlowDescs: + type: array + items: + $ref: '#/components/schemas/AddFlowDescriptionInfo' + minItems: 1 + maxItems: 2 + description: > + Represents additional flow description information (flow label and IPsec SPI) + per Uplink and/or Downlink IP flows. + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClass' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' + +MediaSubComponentRm: + description: > + This data type is defined in the same way as the MediaSubComponent data type, but with the + OpenAPI nullable property set to true. Removable attributes marBwDl and marBwUl are defined + with the corresponding removable data type. + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethFDescs: + type: array + +``` + +``` + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + addInfoFlowDescs: + type: array + items: + $ref: '#/components/schemas/AddFlowDescriptionInfo' + minItems: 1 + maxItems: 2 + nullable: true + description: > + Represents additional flow description information (flow label and IPsec SPI) + per Uplink and/or Downlink IP flows. + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClassRm' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + nullable: true + +EventsNotification: + description: Describes the notification of a matched event. + type: object + required: + - evSubsUri + - evNotifs + properties: + adReports: + type: array + items: + $ref: '#/components/schemas/AppDetectionReport' + minItems: 1 + description: Includes the detected application report. + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + addAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + anChargAddr: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AccNetChargingAddress' + anChargIds: + type: array + items: + $ref: '#/components/schemas/AccessNetChargingIdentifier' + minItems: 1 + anGwAddr: + $ref: '#/components/schemas/AnGwAddress' + l4sReports: + type: array + items: + $ref: '#/components/schemas/L4sSupport' + minItems: 1 + evSubsUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + evNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 +``` + +``` +failedResourceAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 +succResourceAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 +noNetLocSupp: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NetLocAccessSupport' +outOfCredReports: + type: array + items: + $ref: '#/components/schemas/OutOfCreditInformation' + minItems: 1 +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +qncReports: + type: array + items: + $ref: '#/components/schemas/QosNotificationControlInfo' + minItems: 1 +qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 +qosMonDatRateReps: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 +pdvMonReports: + type: array + items: + $ref: '#/components/schemas/PdvMonitoringReport' + minItems: 1 +congestReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 +ranNasRelCauses: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause' + minItems: 1 + description: Contains the RAN and/or NAS release cause. +ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +ueLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +ueLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +usgRep: + $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' +urspEnfRep: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UrspEnforcementInfo' +sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' +ueReqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +redundantPduSessionInfo: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' +tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' +tsnPortManContDsst: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' +tsnPortManContNwtt: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' +``` + +``` + minItems: 1 + ipv4AddrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + minItems: 1 + ipv6PrefixList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + batOffsetInfo: + $ref: '#/components/schemas/BatOffsetInfo' + +AfEventSubscription: + description: Describes the event information delivered in the subscription. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + notifMethod: + $ref: '#/components/schemas/AfNotifMethod' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +AfEventNotification: + description: Describes the event information delivered in the notification. + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +TerminationInfo: + description: > + Indicates the cause for requesting the deletion of the Individual Application Session + Context resource. + type: object + required: + - termCause + - resUri + properties: + termCause: + $ref: '#/components/schemas/TerminationCause' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +AfRoutingRequirement: + description: Describes AF requirements on routing traffic. + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + spVal: + $ref: '#/components/schemas/SpatialValidity' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 +``` + +``` + +upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' +addrPreserInd: + type: boolean +simConnInd: + type: boolean + description: > + Indicates whether simultaneous connectivity should be temporarily maintained for the + source and target PSA. +simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +easIpReplaceInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + minItems: 1 + description: Contains EAS IP replacement information. +easRedisInd: + type: boolean + description: Indicates the EAS rediscovery is required. +maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +tfcCorreInfo: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' +AfSfcRequirement: + description: Describes AF requirements on steering traffic to N6-LAN. + type: object + properties: + sfcIdDl: + type: string + description: Reference to a pre-configured SFC for downlink traffic. + nullable: true + sfcIdUl: + type: string + description: Reference to a pre-configured SFC for uplink traffic. + nullable: true + spVal: + $ref: '#/components/schemas/SpatialValidityRm' + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + nullable: true + +SpatialValidity: + description: Describes explicitly the route to an Application location. + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Defines the presence information provisioned by the AF. The praId attribute within the + PresenceInfo data type is the key of the map. + +SpatialValidityRm: + description: > + This data type is defined in the same way as the SpatialValidity data type, but with the + OpenAPI nullable property set to true. + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Defines the presence information provisioned by the AF. The praId attribute within the + PresenceInfo data type is the key of the map. + nullable: true + +AfRoutingRequirementRm: + description: > + This data type is defined in the same way as the AfRoutingRequirement data type, but with + +``` + +``` + the OpenAPI nullable property set to true and the spVal and tempVals attributes defined as + removable. + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + nullable: true + spVal: + $ref: '#/components/schemas/SpatialValidityRm' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 + nullable: true + upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + addrPreserInd: + type: boolean + nullable: true + simConnInd: + type: boolean + nullable: true + description: > + Indicates whether simultaneous connectivity should be temporarily maintained for the + source and target PSA. + simConnTerm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + easIpReplaceInfos: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EasIpReplacementInfo' + minItems: 1 + description: Contains EAS IP replacement information. + nullable: true + easRedisInd: + type: boolean + description: Indicates the EAS rediscovery is required. + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UintegerRm' + tfcCorreInfo: + $ref: 'TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo' + nullable: true + +AnGwAddress: + description: Describes the address of the access network gateway control node. + type: object + anyOf: + - required: [anGwIpv4Addr] + - required: [anGwIpv6Addr] + properties: + anGwIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anGwIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + +Flows: + description: Identifies the flows. + type: object + required: + - medCompN + properties: + contVers: + type: array + items: + $ref: '#/components/schemas/ContentVersion' + minItems: 1 + fNums: + type: array + items: + type: integer + minItems: 1 + medCompN: +``` + +``` +type: integer + +EthFlowDescription: + description: Identifies an Ethernet flow. + type: object + required: + - ethType + properties: + destMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ethType: + type: string + fDesc: + $ref: '#/components/schemas/FlowDescription' + fDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + sourceMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + vlanTags: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + srcMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + destMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + +ResourcesAllocationInfo: + description: Describes the status of the PCC rule(s) related to certain media components. + type: object + properties: + mcResourcStatus: + $ref: '#/components/schemas/MediaComponentResourcesStatus' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string + description: > + Indicates whether NG-RAN supports alternative QoS parameters. The default value false + shall apply if the attribute is not present. It shall be set to false to indicate that + the lowest priority alternative QoS profile could not be fulfilled. + +TemporalValidity: + description: Indicates the time interval(s) during which the AF request is to be applied. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +QosNotificationControlInfo: + description: > + Indicates whether the QoS targets for a GRB flow are not guaranteed or guaranteed again. + type: object + required: + - notifType + properties: + notifType: + $ref: '#/components/schemas/QosNotifyType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string + description: > + Indicates the alternative service requirement NG-RAN can guarantee. When it is omitted + and the notifType attribute is set to NOT_GUARANTEED it indicates that the lowest + priority alternative alternative service requirement could not be fulfilled by NG-RAN. + altSerReqNotSuppInd: + type: boolean +``` + +``` +description: > + When present and set to true it indicates that Alternative Service Requirements are not + supported by NG-RAN. + +AcceptableServiceInfo: + description: Indicates the maximum bandwidth that shall be authorized by the PCF. + type: object + properties: + accBwMedComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + description: > + Indicates the maximum bandwidth that shall be authorized by the PCF for each media + component of the map. The key of the map is the media component number. + minProperties: 1 + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +UeIdentityInfo: + description: Represents 5GS-Level UE identities. + type: object + anyOf: + - required: [gpsi] + - required: [pei] + - required: [supi] + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +AccessNetChargingIdentifier: + description: Describes the access network charging identifier. + type: object + oneOf: + - required: [accNetChaIdValue] + - required: [accNetChargIdString] + properties: + accNetChaIdValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + accNetChargIdString: + type: string + description: A character string containing the access network charging identifier. + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + +OutOfCreditInformation: + description: > + Indicates the SDFs without available credit and the corresponding termination action. + type: object + required: + - finUnitAct + properties: + finUnitAct: + $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + +QosMonitoringInformation: + description: > + Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip + delay. + type: object + properties: + repThreshDl: + type: integer + repThreshUl: +``` + +``` + + type: integer + repThreshRp: + type: integer + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +PduSessionTsnBridge: + description: > + Contains the new TSC user plane node information and may contain the DS-TT port and/or + NW-TT port management information. + type: object + required: + - tsnBridgeInfo + properties: + tsnBridgeInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/TsnBridgeInfo' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + ueIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ipDomain: + type: string + description: IPv4 address domain identifier. + ueIpv6AddrPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +QosMonitoringInformationRm: + description: > + This data type is defined in the same way as the QosMonitoringInformation data type, but + with the OpenAPI nullable property set to true. + type: object + properties: + repThreshDl: + type: integer + repThreshUl: + type: integer + repThreshRp: + type: integer + repThreshDatRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + repThreshDatRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + conThreshDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + conThreshUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nullable: true + +PscfRestorationRequestData: + description: Indicates P-CSCF restoration. + type: object + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ipDomain: + type: string + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +``` + +``` +supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + +QosMonitoringReport: + description: QoS Monitoring reporting information. + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + ulDelays: + type: array + items: + type: integer + minItems: 1 + dlDelays: + type: array + items: + type: integer + minItems: 1 + rtDelays: + type: array + items: + type: integer + minItems: 1 + pdmf: + type: boolean + description: Represents the packet delay measurement failure indicator. + ulConInfo: + type: array + items: + type: integer + minItems: 1 + dlConInfo: + type: array + items: + type: integer + minItems: 1 + cimf: + type: boolean + description: Represents the congestion information measurement failure indicator. + ulDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + dlDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +TsnQosContainer: + description: Indicates TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevel' + +TsnQosContainerRm: + description: Indicates removable TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' + maxPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRateRm' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevelRm' + nullable: true +``` + +``` +TscaiInputContainer: + description: Indicates TSC Traffic pattern. + type: object + properties: + periodicity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + burstArrivalTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + surTimeInNumMsg: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + surTimeInTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + burstArrivalTimeWnd: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + periodicityRange: + $ref: '#/components/schemas/PeriodicityRange' + nullable: true + +AppDetectionReport: + description: > + Indicates the start or stop of the detected application traffic and the application + identifier of the detected application traffic. + type: object + required: + - adNotifyType + - afAppId + properties: + adNotifyType: + $ref: '#/components/schemas/AppDetectionNotifType' + afAppId: + $ref: '#/components/schemas/AfAppId' + +PduSessionEventNotification: + description: > + Indicates PDU session information for the concerned established/terminated PDU session. + type: object + required: + - evNotif + properties: + evNotif: + $ref: '#/components/schemas/AfEventNotification' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + status: + $ref: '#/components/schemas/PduSessionStatus' + pcfInfo: + $ref: '#/components/schemas/PcfAddressingInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + +PcfAddressingInfo: + description: Contains PCF address information. + type: object + properties: + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_PolicyAuthorization service. + bindingInfo: + type: string + description: contains the binding indications of the PCF. + +AlternativeServiceRequirementsData: +``` + +``` +description: Contains an alternative QoS related parameter set. +type: object +required: +- altQosParamSetRef +properties: +altQosParamSetRef: +type: string +description: Reference to this alternative QoS related parameter set. +gbrUl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +gbrDl: +$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +pdb: +$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' +per: +$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + +EventsSubscPutData: +description: > +Identifies the events the application subscribes to within an Events Subscription +sub-resource data. It may contain the notification of the already met events. +anyOf: +- $ref: '#/components/schemas/EventsSubscReqData' +- $ref: '#/components/schemas/EventsNotification' + +PeriodicityRange: +description: > +Contains the acceptable range (which is formulated as lower bound and upper bound of +the periodicity of the start twobursts in reference to the external GM) or +acceptable periodicity value(s) (which is formulated as a list of values for +the periodicity). +type: object +oneOf: +- required: [lowerBound, upperBound] +- required: [periodicVals] +properties: +lowerBound: +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +upperBound: +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +periodicVals: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +minItems: 1 + +BatOffsetInfo: +description: > +Indicates the offset of the BAT and the optionally adjusted periodicity. +type: object +required: +- ranBatOffsetNotif +properties: +ranBatOffsetNotif: +type: integer +description: > +Indicates the BAT offset of the arrival time of the data burst in units +of milliseconds. +adjPeriod: +$ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +flows: +type: array +items: +$ref: '#/components/schemas/Flows' +minItems: 1 +description: > +Identification of the flows. If no flows are provided, the BAT offset applies +for all flows of the AF session. + +ProtoDesc: +description: Contains the protocol description namely protocol details and payload type +information. +type: object +properties: +protocol: +$ref: '#/components/schemas/MediaProtocol' +payloadType: +$ref: '#/components/schemas/PayloadType' +``` + +``` +ProtoDescRm: + description: Contains the protocol description namely protocol details and payload type + information. + type: object + properties: + protocol: + $ref: '#/components/schemas/MediaProtocol' + payloadType: + $ref: '#/components/schemas/PayloadType' + nullable: true + +PdvMonitoringReport: + description: Packet Delay Variation reporting information. + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + description: Identification of the flows. + ulPdv: + type: integer + description: Uplink packet delay variation in units of milliseconds. + dlPdv: + type: integer + description: Downlink packet delay variation in units of milliseconds. + rtPdv: + type: integer + description: Round trip packet delay variation in units of milliseconds. + +PeriodicityInfo: + description: > + Indicates the time period between the start of the two data bursts in Uplink and/or Downlink + direction. + type: object + properties: + periodUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + periodDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + nullable: true + +AddFlowDescriptionInfo: + description: Contains additional flow description information. + type: object + properties: + spi: + type: string + description: > + 4-octet string representing the security parameter index of the IPSec packet + in hexadecimal representation. + flowLabel: + type: string + description: > + 3-octet string representing the IPv6 flow label header field in hexadecimal + representation. + flowDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + +L4sSupport: + description: > + Indicates whether the ECN marking for L4S support is not available or available + again in 5GS. + type: object + required: + - notifType + properties: + notifType: + $ref: '#/components/schemas/L4sNotifType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 +``` + +# + +``` +# EXTENDED PROBLEMDETAILS +# + ExtendedProblemDetails: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - type: object + properties: + acceptableServInfo: + $ref: '#/components/schemas/AcceptableServiceInfo' + +# +# SIMPLE DATA TYPES +# + AfAppId: + description: Contains an AF application identifier. + type: string + AspId: + description: Contains an identity of an application service provider. + type: string + CodecData: + description: Contains codec related information. + type: string + ContentVersion: + description: Represents the content version of some content. + type: integer + FlowDescription: + description: Defines a packet filter of an IP flow. + type: string + SponId: + description: Contains an identity of a sponsor. + type: string + ServiceUrn: + description: Contains values of the service URN and may include subservices. + type: string + TosTrafficClass: + description: > + 2-octet string, where each octet is encoded in hexadecimal representation. The first octet + contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet + contains the ToS/Traffic Class mask field. + type: string + TosTrafficClassRm: + description: > + This data type is defined in the same way as the TosTrafficClass data type, but with the + OpenAPI nullable property set to true. + type: string + nullable: true + MultiModalId: + description: > + This data type contains a multi-modal service identifier. + type: string + TscPriorityLevel: + description: Represents the priority level of TSC Flows. + type: integer + minimum: 1 + maximum: 8 + TscPriorityLevelRm: + description: > + This data type is defined in the same way as the TscPriorityLevel data type, but with the + OpenAPI nullable property set to true. + type: integer + minimum: 1 + maximum: 8 + nullable: true + + MediaProtocol: + description: represents the different media protocol applicable for XRM muti modality session. + type: string + + PayloadType: + description: represents the different payload type. + type: string + +# +# ENUMERATIONS DATA TYPES +# + MediaType: + description: Indicates the media type of a media component. + anyOf: +``` + +``` +- type: string +enum: +- AUDIO +- VIDEO +- DATA +- APPLICATION +- CONTROL +- TEXT +- MESSAGE +- OTHER +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. + +MpsAction: +description: > +Indicates whether it is an invocation, a revocation or an invocation with authorization of +the MPS for DTS service. +anyOf: +- type: string +enum: +- DISABLE_MPS_FOR_DTS +- ENABLE_MPS_FOR_DTS +- AUTHORIZE_AND_ENABLE_MPS_FOR_DTS +- AUTHORIZE_AND_ENABLE_MPS_FOR_AF_SIGNALLING +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. + +ReservPriority: +description: Indicates the reservation priority. +anyOf: +- type: string +enum: +- PRIO_1 +- PRIO_2 +- PRIO_3 +- PRIO_4 +- PRIO_5 +- PRIO_6 +- PRIO_7 +- PRIO_8 +- PRIO_9 +- PRIO_10 +- PRIO_11 +- PRIO_12 +- PRIO_13 +- PRIO_14 +- PRIO_15 +- PRIO_16 +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. + +ServAuthInfo: +description: Indicates the result of the Policy Authorization service request from the AF. +anyOf: +- type: string +enum: +- TP_NOT_UNKNOWN +- TP_EXPIRED +- TP_NOT_YET_OCURRED +- ROUT_REQ_NOT_AUTHORIZED +- DIRECT_NOTIF_NOT_POSSIBLE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration +and is not used to encode content defined in the present version of this API. + +SponsoringStatus: +description: Indicates whether sponsored data connectivity is enabled or disabled/not enabled. +anyOf: +- type: string +enum: +- SPONSOR_DISABLED +``` + +``` + - SPONSOR_ENABLED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +AfEvent: + description: Represents an event to notify to the AF. + anyOf: + - type: string + enum: + - ACCESS_TYPE_CHANGE + - ANI_REPORT + - APP_DETECTION + - CHARGING_CORRELATION + - EPS_FALLBACK + - EXTRA_UE_ADDR + - FAILED_QOS_UPDATE + - FAILED_RESOURCES_ALLOCATION + - OUT_OF_CREDIT + - PDU_SESSION_STATUS + - PLMN_CHG + - QOS_MONITORING + - QOS_NOTIF + - RAN_NAS_CAUSE + - REALLOCATION_OF_CREDIT + - SAT_CATEGORY_CHG + - SUCCESSFUL_QOS_UPDATE + - SUCCESSFUL_RESOURCES_ALLOCATION + - TSN_BRIDGE_INFO + - UP_PATH_CHG_FAILURE + - USAGE_REPORT + - UE_TEMPORARILY_UNAVAILABLE + - BAT_OFFSET_INFO + - URSP_ENF_INFO + - PACK_DEL_VAR + - L4S_SUPP + - RT_DELAY_TWO_QOS_FLOWS + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +AfNotifMethod: + description: Represents the notification methods that can be subscribed for an event. + anyOf: + - type: string + enum: + - EVENT_DETECTION + - ONE_TIME + - PERIODIC + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +QoSNotifType: + description: Indicates the notification type for QoS Notification Control. + anyOf: + - type: string + enum: + - GUARANTEED + - NOT_GUARANTEED + - type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +TerminationCause: + description: > + Indicates the cause behind requesting the deletion of the Individual Application Session + Context resource. + anyOf: + - type: string + enum: + - ALL_SDF_DEACTIVATION + - PDU_SESSION_TERMINATION + - PS_TO_CS_HO +``` + +- INSUFFICIENT\_SERVER\_RESOURCES +- INSUFFICIENT\_QOS\_FLOW\_RESOURCES +- SPONSORED\_DATA\_CONNECTIVITY\_DISALLOWED +- type: string +- description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +MediaComponentResourcesStatus: +description: Indicates whether the media component is active or inactive. +anyOf: +- type: string +enum: +- ACTIVE +- INACTIVE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +FlowUsage: +description: Describes the flow usage of the flows described by a media subcomponent. +anyOf: +- type: string +enum: +- NO\_INFO +- RTCP +- AF\_SIGNALLING +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +FlowStatus: +description: Describes whether the IP flow(s) are enabled or disabled. +anyOf: +- type: string +enum: +- ENABLED-UPLINK +- ENABLED-DOWNLINK +- ENABLED +- DISABLED +- REMOVED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +RequiredAccessInfo: +description: Indicates the access network information required for an AF session. +anyOf: +- type: string +enum: +- USER\_LOCATION +- UE\_TIME\_ZONE +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +SipForkingIndication: +description: > +Indicates whether several SIP dialogues are related to an "Individual Application Session Context" resource. +anyOf: +- type: string +enum: +- SINGLE\_DIALOGUE +- SEVERAL\_DIALOGUES +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +AfRequestedData: +description: Represents the information that the AF requested to be exposed. +anyOf: +- type: string + +``` +enum: + - UE_IDENTITY +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +ServiceInfoStatus: +description: Represents the preliminary or final service information status. +anyOf: +- type: string +enum: + - FINAL + - PRELIMINARY +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +PreemptionControlInformation: +description: Represents Pre-emption control information. +anyOf: +- type: string +enum: + - MOST_RECENT + - LEAST_RECENT + - HIGHEST_BW +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +PrioritySharingIndicator: +description: Represents the Priority sharing indicator. +anyOf: +- type: string +enum: + - ENABLED + - DISABLED +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +PreemptionControlInformationRm: +description: > + This data type is defined in the same way as the PreemptionControlInformation data type, but + with the OpenAPI nullable property set to true. +anyOf: +- $ref: '#/components/schemas/PreemptionControlInformation' +- $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + +AppDetectionNotifyType: +description: Indicates the notification type for Application Detection Control. +anyOf: +- type: string +enum: + - APP_START + - APP_STOP +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +PduSessionStatus: +description: Indicates whether the PDU session is established or terminated. +anyOf: +- type: string +enum: + - ESTABLISHED + - TERMINATED +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +UplinkDownlinkSupport: +description: > +``` + +``` + +Represents whether an indication or capability is supported for the UL, the DL or both, +UL and DL. +anyOf: +- type: string + enum: + - UL + - DL + - UL_DL +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +L4sNotifyType: +description: Indicates the notification type for ECN marking for L4S support in 5GS. +anyOf: +- type: string + enum: + - AVAILABLE + - NOT_AVAILABLE +- type: string + description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. + +``` + +--- + +## Annex B (normative): IMS Related P-CSCF Procedures over N5 + +### B.1 Provision of Service Information at P-CSCF + +When the "IMS\_SBI" feature is supported, the P-CSCF shall send service information to the PCF upon every SIP message that includes an SDP answer payload for the purpose of authorizing the IP flows and the QoS resources required for a negotiated IMS session, unless the SDP payload only relates to a circuit-switched bearer (i.e. "c=" line set to "PSTN" and an "m=" line set to "PSTN", refer to 3GPP TS 24.292 [29]). The service information shall be derived both from the SDP offer and the SDP answer. This ensures that the PCF receives proper information to perform media authorization for all possible IMS session set-up scenarios, and that the PCF is also capable of handling session modifications. The P-CSCF may include "servInfStatus" attribute set to "FINAL". + +Additionally, the P-CSCF may send service information to the PCF when receiving a SIP message that includes an SDP offer payload for the purpose of performing an early bandwidth authorization check, or for enabling pre-authorization for a UE terminated IMS session establishment or modification with UE initiated resource reservation, or for the retrieval of network provided access network information (see clause B.8.2). + +The P-CSCF shall send service information to the PCF when receiving a SIP message that includes an SDP offer payload when the IMS session is an MPS session that requires priority treatment. For a UE terminated session the P-CSCF may send the service information derived from the SDP offer when the SDP offer either does not include any preconditions information or includes preconditions information indicating that the local preconditions (i.e. the preconditions related to the remote peer) are already met. In this case, the P-CSCF shall derive the service information only from the SDP offer and shall include "servInfStatus" attribute set to "PRELIMINARY". + +NOTE 1: For a UE terminated session setup, when the SDP offer either does not include any preconditions information or includes preconditions information indicating that the local preconditions (i.e. the preconditions related to the remote peer) are already met, the terminating UE can request a resource modification prior to sending the SDP answer. Even if the IP address and port information in the session information derived from the SDP offer can be insufficient for PCC rule authorization, the policy to handle such UE initiated requests at the PCF can take into account the fact that an IMS session establishment is ongoing, for instance in deciding whether to authorize the request and in selecting an appropriate charging key and a gating policy. + +The P-CSCF shall derive the value of the "fDescs" attribute within the service information from the SDP as follows: + +- An uplink entry in the "fDescs" attribute shall be formed as follows: The destination address shall be taken from the SDP information received by the P-CSCF in downlink direction, while the source IP address may be formed + +from the address present in the SDP received by the P-CSCF in uplink direction (taking into account only the 64 bit prefix of the Ipv6 address) Source and destination ports shall be derived according to rules provided in 3GPP TS 29.513 [7] clause 7.2. + +EXAMPLE 1: Assuming UE A sends an SDP to UE B, the PCF of UE B uses the address present in this SDP for the destination address of UE B's uplink entry in the "fDescs" attribute, while the PCF of the UE A uses the 64 bit prefix of the same address for the source address of UE A's uplink entry in the "fDescs" attribute. If the source address is not formed from the 64 bit prefix, the source address shall be wildcarded. + +- A downlink entry in the "fDescs" attribute shall be formed as follows: The destination address shall be taken from the SDP information received by the P-CSCF in uplink direction, while the source IP address may be formed (in order to reduce the possibilities of QoS flow misuse) from the destination address in the SDP received by the P-CSCF in downlink direction (taking into account only the 64 bit prefix of the Ipv6 address) Source and destination ports shall be derived according to rules provided in 3GPP TS 29.513 [7] clause 7.2. + +EXAMPLE 2: Assuming UE A sends an SDP to UE B, the PCF of UE A uses the address present in this SDP for the destination address of UE A's downlink entry in the "fDescs" attribute, while the PCF of UE B uses the 64 bit prefix of the same address for the source address of UE B's downlink entry in the "fDescs" attribute. If the source address is not formed from the 64 bit prefix, the source address shall be wildcarded. + +The P-CSCF shall derive the bandwidth information within the service information, from the "b=AS" SDP parameter and "a=bw-info" SDP parameter, if available. If "a=bw-info" is used for bandwidth derivation, the P-CSCF shall use the SDP attribute line that contains the bandwidth properties for the IP version used by the UE, as detailed in 3GPP TS 29.513 [7] clause 7.2. If the received "a=bw-info" SDP attribute line(s) contain only bandwidth properties for an IP version that is not used by the UE, the P-CSCF shall re-compute the bandwidth properties for the used IP version and use that value for the bandwidth derivation as defined in 3GPP TS 26.114 [30]. + +NOTE 2: If no IP version is included for any of the "a=bw-info" SDP attribute lines related to a certain payload type and direction then IPv6 is assumed for all bandwidth properties related to the same direction and payload type, on all of the related "a=bw-info" SDP attribute lines, see clause 19 of 3GPP TS 26.114 [30]. + +If "a=bw-info" is used for bandwidth derivation and it includes both known and unknown bandwidth properties, the P-CSCF shall only consider the known bandwidth properties to derive the bandwidth information and ignore the unknown ones. If the "a=bw-info" line is received with an unknown directionality, then the entire "a=bw-info" line shall be ignored. + +For the possibly associated RTCP IP flows, the P-CSCF shall use the SDP "b=RR" and "b=RS" parameters, if present, as specified in 3GPP TS 29.513 [7] clause 7.2. The "b=AS", "b=RR" and "b=RS" parameters in the SDP contain all the overhead coming from the IP-layer and the layers above, e.g. IP, UDP, RTP and RTCP payload, or IP, UDP and RTCP. + +For multiplexed RTP/RTCP flows (as negotiated using the "a=rtcp-mux" SDP attribute defined in IETF RFC 5761 [31]), a P-CSCF supporting RTP/RTCP transport multiplexing shall derive the bandwidth information within the service information as specified in 3GPP TS 29.513 [7] clause 7.2. + +However, if service information is received containing the "b=TIAS" SDP parameter that corresponds to an SDP answer payload, and if the P-CSCF supports this parameter, the P-CSCF may derive the bandwidth from this parameter rather than from the "b=AS" SDP parameter, as detailed in 3GPP TS 29.513 [7] clause 7.2. + +When available, the P-CSCF shall also indicate to PCF, as a complement to the Service Information, the IMS Communication Service Identifier within the "afAppId" attribute. The originating P-CSCF shall take the IMS Communication Service Identifier value from the SIP response. The terminating P-CSCF shall take the IMS Communication Service Identifier value from the SIP request. Otherwise, the P-CSCF may not be able to provide an IMS Communication Service Identifier value to the PCF. The format and specific headers where IMS communication service identifiers are transported within SIP are defined in 3GPP TS 24.229 [32]. + +NOTE 3: In order to indicate the IMS Communication Service Identifier to the PCF, the originating P-CSCF sets the "afAppId" attribute to the ICSI contained in the topmost occurrence of the "+g.3gpp.icsi-ref" header field parameter of the Feature-Caps header field(s) of 18x or 2xx SIP response (Feature-Caps: \*; +g.3gpp.icsi-ref="urn%3Aurn-7%3A3gpp-service.ims.icsi.mmtel") and the terminating P-CSCF sets the "afAppId" attribute to the ICSI of the P-Asserted-Service header information received in the SIP request (e.g. P-Asserted-Service: urn:urn-7:3gpp-service.ims.icsi.mmtel). Since the headers and the format of the ICSI can vary depending on the case, the PCF has to be prepared to accept the complete ICSI information received in different formats, as described in clause 7.2A.8.2 in 3GPP TS 24.229 [32]. + +Additionally, if "ResourceSharing" feature is supported, the P-CSCF may include the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute within a media component of the "medComponents" attribute in order to indicate the PCF that resource sharing should apply for the media components in the related direction with the same value for the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute. + +Additionally, if "PrioritySharing" feature is supported, the P-CSCF may provide the "prioSharingInd" attribute within a media component of the "medComponents" attribute as described in clause 4.2.2.21 and 4.2.3.21. + +NOTE 4: The P-CSCF obtains this information from the Application Server as described in 3GPP TS 23.228 [33], clause 5.4.7.9. + +NOTE 5: RTCP flows are not subject to resource sharing. This requirement cannot be met for multiplexed RTP/RTCP flows as in this case there is no mechanism in the current release to distinguish between RTP and RTCP flows. + +For IMS emergency services provided by a PLMN or an SNPN if the "servUrn" attribute does not include an emergency service URN, i.e. a top-level service type of "sos" as specified in IETF RFC 5031 [34] and possibly additional sub-service information on the type of the emergency service and the PCF binds the IMS service session to a PDU session established to an Emergency DNN, the PCF shall return the application error UNAUTHORIZED\_NON\_EMERGENCY\_SESSION to the P-CSCF. Upon receiving an application error UNAUTHORIZED\_NON\_EMERGENCY\_SESSION the P-CSCF shall apply the procedures defined in 3GPP TS 24.229 [32]. + +NOTE 6: The PCF determines whether a PDU session is established to an Emergency DNN based on the information received over N7 and operator configuration. + +If the "afReqData" attribute is provided in the "ascReqData" attribute indicating "5GS-level UE Identities required", the PCF shall provide the available user information for the PDU session in the serving network (either a PLMN or an SNPN) within the "ueIds" attribute included in the "ascRespData" attribute, where each entry shall contain the IMSI (for PLMN access) or either IMSI or NAI (for SNPN access) within the "supi", and/or the MSISDN within the "gpsi" and/or the IMEI(SV) within the "pei" attributes. + +The PCF may decide not to authorize requested service information. The PCF will indicate it to the P-CSCF by rejecting the HTTP request with an HTTP "403 Forbidden" response message including the "cause" attribute set to "REQUESTED\_SERVICE\_NOT\_AUTHORIZED". Upon receiving an HTTP "403 Forbidden" response message including the "cause" attribute set to the value "REQUESTED\_SERVICE\_NOT\_AUTHORIZED" the P-CSCF shall apply the procedures defined in 3GPP TS 24.229 [32]. + +--- + +## B.2 Enabling of IP Flows + +### B.2.1 General + +Prior to the completion of the SIP session set-up, i.e. until the 2xx response to the INVITE request is received, the P-CSCF may enable or disable media IP flows depending on operator policy, thus allowing or forbidding early media in forward and/or backward direction. The P-CSCF may set the values of the "fStatus" attribute derived from the SDP direction attributes as defined in 3GPP TS 29.513 [7] clause 7.3.3 or set the values of the "fStatus" attributes considering the em-param of the P-Early-Media header field according to clause B.2.2 or downgrade the values of the "fStatus" attribute derived from the SDP direction attribute based on the configuration in the P-CSCF according to clause B.2.3. However for multiplexed RTP/RTCP flows (as negotiated using the "a=rtcp-mux" SDP attribute defined in IETF RFC 5761 [31]), a P-CSCF supporting RTP/RTCP transport multiplexing shall set the "fStatus" attribute to + +"ENABLED" to prevent that RTCP is blocked. If the P-CSCF chooses to modify the values of the "fStatus" as received from the SDP direction attribute, the P-CSCF shall store the last received SDP. + +When a 2xx response is received, the P-CSCF shall enable all media IP flows according to the direction attribute within the last received SDP, as specified in 3GPP TS 29.513 [7] clause 7.3.3. When a 2xx response is received and the P-CSCF previously provided the values of the "fStatus" attributes different from the value derived from the SDP direction attribute in the session information, the P-CSCF shall provide service information with values of the "fStatus" attributes corresponding to the last received SDP. + +NOTE: In most cases a 2xx response is a 200 (OK) response. + +If the P-CSCF receives SDP answers after the completion of the SIP session set-up, i.e. after the 2xx response to the INVITE request is received, the P-CSCF shall provide the "fStatus" attribute, based on the last received SDP answer. The "fStatus" attribute shall be derived from the SDP according to 3GPP TS 29.513 [7] clause 7.3.3. + +## B.2.2 Gate control procedures considering the P-Early-Media header field + +Prior to the completion of the SIP session set-up, the P-CSCF may use the em-param of the P-Early-Media header field defined in IETF RFC 5009 [35] in order to enable or disable early media in forward and/or backward direction. If the P-CSCF uses the em-param of the P-Early-Media header field for the gate control of early media, the P-CSCF shall perform the following procedures. + +In the terminating P-CSCF, when a SIP message with the P-Early-Media header field is received from the UE and the policies configured in the P-CSCF indicate that the UE is authorized to send early media, then: + +- 1) the P-CSCF shall set the "fStatus" attribute to "ENABLED" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "sendrecv" or no SDP direction attribute has been received; or +- 2) the P-CSCF shall set the "fStatus" attribute to "ENABLED-UPLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "sendonly"; or + - the received em-param(s) in the P-Early-Media header field includes "sendonly" and the last received SDP direction attribute from the UE is "sendrecv" or "sendonly" or no SDP direction attribute has been received; or +- 3) the P-CSCF shall set the "fStatus" attribute to "ENABLED-DOWNLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the UE is "recvonly"; or + - the received em-param(s) in the P-Early-Media header field includes "recvonly" and the last received SDP direction attribute from the UE is "sendrecv" or "recvonly" or no SDP direction attribute has been received; or +- 4) the P-CSCF shall set the "fStatus" attribute to "DISABLED" if either the received em-param(s) in the P-Early-Media header field or the last received SDP direction attribute from the UE includes "inactive"; or +- 5) the P-CSCF may set the "fStatus" attribute to "DISABLED" or apply the rules defined in clause B.2.2 if the received em-param(s) in the P-Early-Media header field includes "sendonly" or "recvonly" and the last received SDP direction attribute from the UE is "recvonly" or "sendonly" respectively. + +NOTE 1: If the UE is authorized to send early media, the P-CSCF will not remove or modify the P-Early-Media header field according to 3GPP TS 24.229 [32]. + +When a SIP message with the P-Early-Media header field is received from the functional entity within the trust domain, and if: + +- the P-Early-Media header field includes the "gated" parameter, then the P-CSCF may decide not to perform the gate control of early media; or + +- the P-Early-Media header field does not include the "gated" parameter, then the P-CSCF shall perform the following procedures: + - 1) the P-CSCF shall set the "fStatus" attribute to "ENABLED" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "sendrecv" or no SDP direction attribute has been received; or + - 2) the P-CSCF shall set the "fStatus" attribute to "ENABLED-DOWNLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "sendonly"; or + - the received em-param(s) in the P-Early-Media header field includes "sendonly" and the last received SDP direction attribute from the functional entity is "sendrecv" or "sendonly" or no SDP direction parameter has been received; or + - 3) the P-CSCF shall set the "fStatus" attribute to "ENABLED-UPLINK" if: + - the received em-param(s) in the P-Early-Media header field includes "sendrecv" and the last received SDP direction attribute from the functional entity is "recvonly"; or + - the received em-param(s) in the P-Early-Media header field includes "recvonly" and the last received SDP direction attribute from the functional entity is "sendrecv" or "recvonly" or no SDP direction parameter has been received; or + - 4) the P-CSCF shall set the "fStatus" attribute to "DISABLED" if either the received em-param(s) in the P-Early-Media header field or the last received SDP direction attribute from the functional entity includes "inactive"; or + - 5) the P-CSCF may set the "fStatus" attribute to "DISABLED" or apply the rules defined in clause A.2.2 if the received em-param(s) in the P-Early-Media header field includes "sendonly" or "recvonly" and the last received SDP direction attribute from the functional entity is "recvonly" or "sendonly" respectively. + +NOTE 2: According to IETF RFC 5009 [35], the non-direction parameter "gated" can be included after the direction parameter (e.g. "sendrecv") in the parameter list. The proxy performing gating of early media can add the parameter before forwarding the SIP message. + +When a SIP message without the P-Early-Media header field is received from either the functional entity within the trust domain or the UE that is authorized to send early media, then the P-CSCF may set the "fStatus" attribute to "DISABLED" or apply the rules defined in clause B.2.3 or apply the rules defined in 3GPP TS 29.513 [7] clause 7.3.3. + +NOTE 3: As indicated in IETF RFC 5009 [35] the applicable preconditions need to be met in order to allow early media in a particular direction. + +When a SIP message is received from the functional entity other than the functional entity within the trust domain or the UE that is authorized to send early media, then the P-CSCF shall not use the received em-param(s) in the P-Early-Media header field and may apply the rules defined in clause B.2.2 or apply the rules defined in 3GPP TS 29.513 [7] clause 7.3.3. + +NOTE 4: The P-CSCF will remove or modify the P-Early-Media header field in the above case. + +## B.2.3 Gate control procedures based on the configuration in the P-CSCF + +Prior to the completion of the SIP session set-up, the P-CSCF may downgrade the values of the "fStatus" attributes derived from the SDP direction attributes based on the configuration in the P-CSCF. If the P-CSCF has the configuration for the gate control of early media, the P-CSCF shall perform the following procedures. + +NOTE: The gate control of early media can be configured in the P-CSCF per UE basis. + +When the "fStatus" attribute derived from the SDP direction attribute is "ENABLED", then the P-CSCF may downgrade the value of the "fStatus" attribute to the value "DISABLED", "ENABLED\_UPLINK", or "ENABLED\_DOWNLINK" based on the configuration in the P-CSCF. + +When the "fStatus" attribute derived from the SDP direction attribute is "ENABLED\_UPLINK" or "ENABLED\_DOWNLINK", then the P-CSCF may downgrade the value of the "fStatus" attribute to the value "DISABLED" based on the configuration in the P-CSCF. + +--- + +## B.3 Support for SIP forking + +### B.3.0 General + +The P-CSCF shall be able to handle forking when PCC is applied and the "IMS\_SBI" feature is supported. Forking can occur as specified in 3GPP TS 23.228 [33]. The related UE procedures are described in 3GPP TS 24.229 [32]. + +### B.3.1 PCC rule provisioning for early media for forked responses + +When a SIP session has been originated by a connected UE, the P-CSCF may receive multiple provisional responses due to forking before the first final answer is received. Multiple early media session may be established during this process. + +The UE and the P-CSCF become aware of the forking only when a subsequent provisional response arrives for a new early dialogue. After the first early media session is established, for each subsequent provisional response establishing an additional early media session, the P-CSCF shall use an Npcf\_PolicyAuthorization\_Update service operation containing the "sipForkInd" attribute with value "SEVERAL\_DIALOGUES" and include the service information derived from the latest provisional response. + +The P-CSCF shall also provision the service information derived from any subsequent SDP offer-answer exchange within an early dialogue (e.g. in PRACK and OK(PRACK), or UPDATE and OK(UPDATE) ) using an Npcf\_PolicyAuthorization\_Update service operation containing the "sipForkInd" attribute with value "SEVERAL\_DIALOGUES" and the derived service information. + +When receiving an Npcf\_PolicyAuthorization\_Update service operation containing the "sipForkInd" attribute with value "SEVERAL\_DIALOGUES", the PCF shall identify the existing "Individual Application Session Context" resource with existing authorization information. + +The PCF shall send additional PCC Rules or individual service data flow filters to already provided PCC rules as required by the "fDescs" attribute within the AF session context information to the SMF. The PCF shall authorize any additional media components and any increased QoS requirements for the previously authorized media components, as requested within the service information. + +The PCF shall authorize the maximum bandwidth required by any of the dialogues, but not the sum of the bandwidths required by all dialogues. Thus, the QoS authorized for a media component is equal to the highest QoS requested for that media component by any of the forked responses. + +The PCF shall open or close the gates for service flows depending on the flow status that is being provisioned. However, if a flow ID has been enabled in uplink or downlink direction or both way within previous service information, it shall remain enabled even if the PCF receives service information that disable this flow ID within an Npcf\_PolicyAuthorization\_Update service operation containing the "sipForkInd" attribute with value "SEVERAL\_DIALOGUES". + +If the P-CSCF provides one or more media components within the "medComponents" attribute with the "fStatus" attribute set to "REMOVED" for previously authorized media component(s) the media component shall remain as authorized and the PCF shall not take any action on that media component(s). + +NOTE: There can be cases where a forked response could not support some of the media components included in the SDP Offer (e.g. when early session disposition SDP as described in Annex B.6 applies, the forked response related to the early session could include the port set to zero for those media components not related to the early session or when a subsequent SDP Offer-Answer to indicate that some media is disabled). For those cases the P-CSCF will indicate the PCF about the removal of the corresponding media component. However this media component is already supported by other UEs and the PCF needs to maintain the corresponding PCC rules until the final SDP answer is received in the P-CSCF in order to avoid the release of resources in the network. + +### B.3.2 Updating the provisioned PCC rules at the final answer + +The P-CSCF shall store the SDP information for each early dialogue separately till the first final SIP answer is received. Then the related early dialogue is progressed to an established dialogue to establish the final SIP session. All the other early dialogues are terminated. The service information for the SIP session is updated to match the requirements of the remaining early dialogue only. + +When receiving the first final SIP response, the P-CSCF shall send an Npcf\_PolicyAuthorization\_Update service operation setting to null the "sipForkInd" attribute and shall include the service information derived from the SDP corresponding to the dialogue of the final response. The P-CSCF shall provision the full service information including the applicable "fDescs" attribute and "fStatus" attribute. + +When receiving an Npcf\_PolicyAuthorization\_Update service operation with a "sipForkInd" attribute with value "SINGLE\_DIALOGUE", the PCF shall update installed PCC Rules information and Authorized-QoS information to match only the requirements of the service information within this Npcf\_PolicyAuthorization\_Update service operation. The PCF should immediately remove PCC Rule(s) or individual service data flow filters not matching IP flow(s) in the updated Service Information, to reduce the risk for initial clipping of the media stream, and to minimize possible misuse of resources. The PCF shall also open or close the gates for service flows according to the flow status in the received service information. + +--- + +## B.4 Notification of AF Signalling Transmission Path Status + +When the P-CSCF receives an initial REGISTER SIP message from an attached UE, the P-CSCF may subscribe to notifications of the status of the AF signalling transmission path using the procedures specified in clause 4.2.6.7. Once the P-CSCF has subscribed, the P-CSCF may receive notifications from the PCF according to clause 4.2.5.10. + +NOTE: This procedure is not applicable for IMS registrations for Emergency sessions. + +The P-CSCF shall cancel the subscription to notification of the status of the AF signalling transmission path when the AF signalling to that particular user is terminated (i.e. when the user is de-REGISTERED from the IM CN subsystem). + +When the P-CSCF receives a notification of loss of signalling connectivity from the PCF, the P-CSCF shall behave as defined in 3GPP TS 24.229 [32]. + +--- + +## B.5 Indication of Emergency Registration and Session Establishment + +When the P-CSCF receives an initial REGISTER SIP message for an IMS emergency registration or an INVITE SIP message for an emergency session and the P-CSCF determines that there are no IMS-level roaming interfaces, and the "IMS\_SBI" feature is supported the P-CSCF may request the PCF to provide the 5GS-Level UE identities (GPSI, SUPI, PEI) available for that PDU session in the serving network (either a PLMN or an SNPN) using the procedure as specified in this clause (for an IMS emergency registration) or B.1 (for an IMS emergency session establishment). + +A P-CSCF may request the PCF to provide the 5GS-level identities (GPSI, SUPI, PEI) available for that PDU session when no service information is available in the P-CSCF. To do so, the P-CSCF shall create an "Individual Application Session Context" resource in the PCF for the AF signalling using an Npcf\_PolicyAuthorization\_Create service operation. The P-CSCF shall provide the UE's IP address (using either the "uelpv4" attribute or the "uelpv6" attribute) + +and the "afReqData" attribute set to "UE\_IDENTITY". The P-CSCF shall include the "servUrn" attribute set to the value "sos", in order to indicate that the new AF session context relates to emergency traffic that is not related to a specific emergency service. + +If the P-CSCF supports the SBI Message Priority mechanism for an emergency session, it shall include the "3gpp-Sbi-Message-Priority" custom HTTP header towards the PCF as described in clause 6.8.2 of 3GPP TS 29.500 [5]. + +NOTE 1: If the P-CSCF supports the SBI Message Priority mechanism for an emergency session, the P-CSCF includes the "3gpp-Sbi-Message-Priority" custom HTTP header based on P-CSCF policies in relation to valid values of the "servUrn" attribute. The highest user priority value is mapped to the corresponding lowest value of the "3gpp-Sbi-Message-Priority" custom HTTP header. + +When the PCF receives an Npcf\_PolicyAuthorization\_Create service operation as described in the preceding paragraphs from the P-CSCF, the PCF shall perform session binding as described in 3GPP TS 29.513 [7]. When the PCF receives the "servUrn" attribute indicating an emergency session, the PCF may apply special policies, for instance prioritising service flows relating to the AF session context or allowing these service flows free of charge. + +When the "servUrn" attribute indicates that the AF session context relates to emergency traffic and the "afReqData" attribute is received indicating "UE\_IDENTITY", the PCF shall provide the requested available user information (MSISDN, IMSI (for PLMN access) or either IMSI or NAI (for SNPn access), IMEI(SV)) for the PDU session within "ueIds" attribute within the "ascRespData" in the HTTP "201 Created" response. + +When the P-CSCF receives the HTTP "201 Created" response with the 5GS-level UE identities from the PCF, the P-CSCF stores the "ueIds" received within "Individual Application Session Context" resource returned in the HTTP "201 Created" response and behaves as defined in 3GPP TS 24.229 [32]. + +NOTE 2: The user information received within the "ueIds" attribute can be used to support PSAP callback functionality for anonymous IMS emergency sessions. See 3GPP TS 23.167 [40] for further information. + +The P-CSCF may decide to delete the "Individual Application Session Context" resource at any time. In that case, the Npcf\_PolicyAuthorization\_Delete service operation, as described in clause 4.2.4.2. + +A SIP INVITE request can contain a service URN as defined in IETF RFC 5031 [34] within the request URI. If the service within this URN is "sos", possibly with additional sub-service information, the P-CSCF shall provision this service and sub-service information within the "servUrn" attribute towards the PCF. The P-CSCF may also provision possible information about other services received within the service URN. + +--- + +## B.6 Support for Early Session disposition SDP + +### B.6.1 General + +As a network option, when the "IMS\_SBI" feature is supported, the P-CSCF may support the PCC procedures in the present clause to handle "early session" disposition type SDP, as standardised in IETF RFC 3959 [38]. + +### B.6.2 Service Information Provisioning for Early Media + +The P-CSCF can receive "early session" disposition SDP in addition to "session" disposition SDP in SIP early dialogues. + +The P-CSCF shall then provision service information derived both from the "early session" disposition SDP and "session" disposition SDP applying the procedures in clauses B.1, B.2, and B.3, and in the present clause. + +The P-CSCF shall apply the mapping rules in Annex C to derive the flow identifiers from "early session" disposition SDP. + +If a single media line with one media type (e.g. "audio" or "video") is contained in "early session" disposition SDP and a single media line with the same media type is contained in the "session" disposition SDP of the same SIP dialogue, and both media lines describe service flows of the same directionality (uplink, downlink, or bidirectional), the P-CSCF should describe those SDP media lines in the same session information media component (with the same flow ID). + +The "early session" disposition SDP can also contain media lines of a type not included in the "session" disposition SDP, or several media lines of the same type. Such media components shall be described in own media components in the service information. + +If the P-CSCF desires to invoke special policies or separate event notifications for an "early session" disposition media line, it may choose to provision a separate session information media component even if a media line with the same media type and directionality is contained in "session" disposition SDP. + +NOTE 1: A PCF is then likely to supply separate PCC rules for early media and the corresponding final media. This may lead to an over provisioning of resources during call establishment and a subsequent reconfiguration of the radio bearer, or even to a call failure if the extra resources are not authorized or available. + +If the P-CSCF receives "early session" disposition SDP before any "session" disposition SDP and supplies service information derived from the "early session" disposition SDP at this point of time, it shall use dedicated media components relating only to the "early session" disposition SDP in the service information. + +NOTE 2: The "session" disposition SDP offer will frequently occur before the "early session" disposition SDP offer, but can also occur in parallel or in exceptional cases afterwards. The "session" disposition SDP answer can be contained in the same SIP message as the "early session" disposition SDP offer, or can be sent in a 200 OK (INVITE), i.e. after the "early session" disposition SDP answer. + +If the P-CSCF includes any media component relating both to "early session" disposition SDP and "session" disposition SDP in the service information, the P-CSCF shall: + +- provision the service information derived from "early session" disposition SDP and the service information derived from "session" disposition SDP in separate Npcf\_PolicyAuthorization\_Update requests (to the same "Individual Application Session Context" resource), and shall send a new Npcf\_PolicyAuthorization\_Update request only after any previous Npcf\_PolicyAuthorization\_Update request has been acknowledged; and +- provision the first service information (either derived from "early session" disposition SDP or "session" disposition SDP) without the "sipForkInd" attribute, or with "sipForkInd" attribute with value "SINGLE\_DIALOGUE"; and +- provision all subsequent service information during ongoing call establishment with the "sipForkInd" attribute with value SEVERAL\_DIALOGUES; and +- if an SDP answer has been received and codecs are provisioned within the "codecs" attribute included in a media component of the "medComponents" attribute, provision within a "codecs" attribute the codec derived from the corresponding offer together with a codec derived from the SDP answer. + +NOTE 3: The P-CSCF needs to provision the service information derived from "early session" disposition SDP and the service information derived from "session" disposition SDP in separate Npcf\_PolicyAuthorization\_Update requests because the encoding of the media component does not allow for the simultaneous provisioning of two corresponding filters. + +NOTE 4: The PCF will treat service information containing the "sipForkInd" attribute as described in clause B.3. + +## B.6.3 Updating the Provisioned Service Information when Dialogue is established + +The P-CSCF shall store the SDP information for the "session" disposition type until the first final SIP answer is received. Then the early media described in the "early session" disposition type SDP are terminated. + +The P-CSCF shall then update the service information to match the requirements of the media described in the "session" disposition type SDP only: + +- If the P-CSCF included any media component relating both to "early session" disposition SDP and "session" disposition SDP in the service information, the P-CSCF shall send an Npcf\_PolicyAuthorization\_Update request without the "sipForkInd" attribute or with a "sipForkInd" attribute with value SINGLE\_DIALOGUE and shall include the service information derived from the "session" disposition SDP. The P-CSCF shall provision the full service information including the applicable "fDescs" attribute and "fStatus" attribute. + +- The P-CSCF shall disable any media component(s) in the service information that relate to early media only by setting their flow status to "REMOVED". + +--- + +## B.7 Provision of Signalling Flow Information at P-CSCF + +When the P-CSCF has successfully concluded the initial registration of an attached UE, i.e., when the P-CSCF has sent to the UE a SIP 200 (OK) response to the SIP REGISTER request, the P-CSCF may provision information about the SIP signalling flows between the UE and itself using the procedure specified in clause 4.2.2.16. If the P-CSCF already has created an "Individual Application Session Context" resource with the PCF related to the signalling with the UE, e.g. one that has been opened according to the procedure described in clause B.4, the P-CSCF shall reuse the already open session to provision the SIP Signalling IP Flow information using the procedure specified in clause 4.2.3.17. + +NOTE: This procedure is not applicable for IMS registrations for Emergency sessions. + +If the P-CSCF provisions information about SIP signalling flows, the P-CSCF shall ensure that for each signalling IP flow information it provides, the flow descriptions within the "fDescs" attribute shall accurately reflect the IP flow information as seen in the IP header 'on the wire'. The P-CSCF shall set the value of the "afSigProtocol" attribute to "SIP". + +When the P-CSCF de-registers the UE and terminates SIP Signalling to the UE, the P-CSCF shall de-provision the SIP Signalling IP flow information from the PCRF as described in clauses 4.2.2.16 and 4.2.3.17. + +--- + +## B.8 Retrieval of network provided location information + +### B.8.1 General + +According to clause E.7 of 3GPP TS 23.228 [33], the P-CSCF can use PCC to retrieve network provided location information. Information flows related to the distribution of network provided location information within the IMS are provided in Annex R of 3GPP TS 23.228 [33]. + +The following clauses provide optional PCC procedures to support the retrieval of network provided location information. + +The originating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information either before sending the INVITE or MESSAGE towards the terminating side or upon reception of the SDP answer from the terminating side. + +The terminating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information either upon reception of a SIP INVITE or upon reception of a SIP response. + +The originating and terminating P-CSCF can, depending on operator policy, retrieve the user location and/or UE Time Zone information at mid call. e.g., when the P-CSCF learns about the access type change. + +### B.8.2 Retrieval of network provided location information at originating P-CSCF for inclusion in SIP Request + +If the originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding a SIP INVITE request, upon reception of the SIP INVITE/UPDATE request, the P-CSCF shall invoke: + +- the Npcf\_PolicyAuthorization\_Create service operation according to clause 4.2.2.14 (SIP INVITE request); or +- the Npcf\_PolicyAuthorization\_Update service operation according to clause 4.2.3.14 or the Npcf\_PolicyAuthorization\_Subscribe service operation according to clause 4.2.6.6 (SIP INVITE/UPDATE request); + +including in the corresponding HTTP request: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + +- a) the "event" attribute set to the value "ANI\_REPORT"; and +- b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +If the SIP INVITE request is an initial SIP INVITE request, the P-CSCF shall create a new "Individual Application Session Context" for the new SIP session with the Npcf\_PolicyAuthorization\_Subscribe service operation according to clause 4.2.6.6 (if no session information is included) or with the Npcf\_PolicyAuthorization\_Create service operation according to clause 4.2.2.14 (if preliminary session information is included). + +The P-CSCF will receive the access network information from the PCF within the Npcf\_PolicyAuthorization\_Notify service operation as described in clause 4.2.5.11 and should include this access network information in the SIP INVITE/UPDATE requests that it forwards. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +If the originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding a SIP MESSAGE request, upon reception of a MESSAGE request, the P-CSCF shall invoke the Npcf\_PolicyAuthorization\_Subscribe service operation including in the corresponding HTTP request: + +- the IP address (IPv4 or IPv6) of the UE in the "ueIpv4" or "ueIpv6" attribute; +- a media component within the "medComponents" attribute including: + - a) the "medCompN" attribute set to "0"; and + - b) a single media subcomponent within the "medSubComps" attribute with: + - i. the "flowUsage" attribute set to the value "AF\_SIGNALLING"; and + - ii. if the procedures for AF provisioning of AF signalling flow information do not apply, the "fNum" attribute set to "0". +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +The P-CSCF will receive the access network information from the PCF within the Npcf\_PolicyAuthorization\_Notify service operation as described in clause 4.2.5.11 and should include this access network information in the SIP MESSAGE requests that it forwards. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +If the AF application session context is only used for retrieval of network provided location information, at reception of this information, the AF may delete the context of application session information using the Npcf\_PolicyAuthorization\_Delete service operation. + +### B.8.3 Retrieval of network provided location information at originating P-CSCF for inclusion in SIP response confirmation + +If an originating P-CSCF is required by operator policy to retrieve network provided location information before forwarding an SDP answer, the P-CSCF shall apply the following procedures. + +Upon reception of an SDP offer, the P-CSCF may invoke the Npcf\_PolicyAuthorization\_Create service operation to the PCF according to clause B.1 and may include in the corresponding HTTP POST request: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +Upon reception of an SDP answer, the P-CSCF will invoke the Npcf\_PolicyAuthorization\_Update service operation to the PCF according to clause B.1. If the P-CSCF has not requested access network information upon reception of the SDP offer, the P-CSCF shall include in the corresponding HTTP PATCH request: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +The P-CSCF will receive the access network information from the PCF in the Npcf\_PolicyAuthorization\_Notify service operation and should include this access network information in the SIP message with the response confirmation before forwarding it. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +## B.8.4 Retrieval of network provided location information at terminating P-CSCF + +If a terminating P-CSCF is required by operator policy to retrieve network provided location information at session establishment and/or modification, the P-CSCF shall apply the following procedures. + +The terminating P-CSCF may request network provided location information upon reception of a SIP INVITE request in the following manner: + +- if the SIP INVITE request is an initial SIP INVITE request, the P-CSCF shall create a new "Individual Application Session Context" for the new SIP session with the Npcf\_PolicyAuthorization\_Subscribe service operation according to clause 4.2.6.6 (if no session information is included) or with the Npcf\_PolicyAuthorization\_Create service operation according to clause 4.2.2.14 (if preliminary session information is included); +- if the SIP INVITE contains an SDP offer, the P-CSCF shall include in the corresponding HTTP request: + - a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; + - b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information); + - c) service information derived from the SDP offer; and + - d) the "servInfStatus" attribute with the value set to "PRELIMINARY"; and +- if the SIP INVITE does not contain an SDP offer, the P-CSCF shall include in the corresponding HTTP request: + - a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; and + +- b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +Upon reception of a SIP response that requires the inclusion of access network information, if the P-CSCF has not already requested network provided location information upon reception of the corresponding SIP INVITE request, the P-CSCF shall request network provided location information in the following manner: + +- if an "Individual Application Session Context" related to service data has not yet been created, the P-CSCF shall create an "Individual Application Session Context" for the new SIP session with the Npcf\_PolicyAuthorization\_Subscribe service operation according to clause 4.2.6.6 (if no session information is included) or with the Npcf\_PolicyAuthorization\_Create service operation according to clause 4.2.2.14 (if session information is included); +- if the SIP response includes an SDP answer, the P-CSCF shall send an HTTP request to the PCF according to clause B.1; the P-CSCF shall include in this HTTP request: + - a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; and + - b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information); +- if the SIP response does not contain an SDP body, the P-CSCF shall include in the corresponding HTTP request: + - a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; and + - b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information); and +- if the SIP response includes an SDP offer, the P-CSCF shall include in the corresponding HTTP request: + - a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; and + - b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information); + - c) service information derived from the SDP offer; and + - d) the "servInfStatus" attribute with the value set to "PRELIMINARY". + +The P-CSCF will receive the access network information from the PCF in the Npcf\_PolicyAuthorization\_Notify service operation and should include this access network information in the appropriate SIP response before forwarding it. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +If the terminating P-CSCF is required by operator policy to retrieve network provided location information upon reception of a SIP MESSAGE response, the P-CSCF shall behave according to B.8.2. + +## B.8.5 Provisioning of network provided location information at SIP session release + +If a P-CSCF is required by operator policy to include network provided location information in SIP session release signalling, the P-CSCF shall apply the following procedures: + +Upon reception of a SIP session release request that requires the inclusion of network provided location information, the P-CSCF will invoke the Npcf\_PolicyAuthorization\_Delete service operation to the PCF according to clause 4.2.4.6 and shall include in the HTTP request: + +- an entry of the "AfEventSubscription" data type in the "events" attribute with: + - a) the "event" attribute set to the value "ANI\_REPORT"; and + - b) the "notifMethod" attribute set to the value "ONE\_TIME"; and +- the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information). + +The P-CSCF will receive the access network information from the PCF in the Npcf\_PolicyAuthorization\_Delete service operation according to clause 4.2.4.6 and shall include this access network information in the appropriate SIP message before forwarding it. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +## B.8.6 Provisioning of network provided location information at mid call + +If a P-CSCF is required by operator policy to include network provided location information at mid call, the P-CSCF shall apply the following procedures: + +Upon reception of a trigger (e.g., when the P-CSCF learns about the access change) that requires the inclusion of network provided location information in a SIP message, the P-CSCF will invoke the Npcf\_PolicyAuthorization\_Update and shall include in the corresponding HTTP request: + +- a) an entry of the "AfEventSubscription" data type in the "events" attribute with: + - (i) the "event" attribute set to the value "ANI\_REPORT"; and + - (ii) the "notifMethod" attribute set to the value "ONE\_TIME"; +- b) the "reqAnis" attribute, with the required access network information, i.e. user location and/or user time zone information); +- c) service information related to the service according to clause 4.2.3.2. + +The P-CSCF will receive the access network information from the PCF in the Npcf\_PolicyAuthorization\_Notify service operation, and should include this access network information in the appropriate SIP message before forwarding it. When the retrieved access network information corresponds to the "tnapId" or "twapId" attribute, the P-CSCF may also map the retrieved access network information to a Geographical Identifier for routing, as specified in clause E.8 of 3GPP TS 23.228 [33]. + +--- + +## B.9 Resource Sharing + +The P-CSCF may indicate to the PCF that media of an "Individual Application Session Context" resource may share resources with media belonging to other "Individual Application Session Context" resources according to 3GPP TS 23.228 [33]. + +If the P-CSCF determines that resource sharing is possible, it may at creation of a new "Individual Application Session Context" resource, include the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute indicating that media resources + +may be shared in the related direction. The P-CSCF shall assign a distinct value for the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute for each media component within the "medComponents" attribute. + +NOTE 1: When resource sharing applies to both directions for a certain media component, the P-CSCF can assign the same value for "sharingKeyUI" attribute and "sharingKeyDI" attribute within the same media component. + +The P-CSCF shall not include the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute within the media components in the "medComponents" attribute when the "Individual Application Session Context" resource relates to an Emergency Session. + +The PCF shall not include the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute for those PCC/GoS Rules related to the RTCP traffic. + +Trigger conditions that require applying or stopping resource sharing are described in 3GPP TS 24.229 [32]. + +NOTE 2: When P-CSCF needs to stop sharing according to the procedures described in 3GPP TS 24.229 [32], the P-CSCF will provide "null" value for the "sharingKeyUI" attribute and/or "sharingKeyDI" attribute within the media component in the "medComponents" attribute. + +--- + +## B.10 Handling of MCPTT priority call + +### B.10.1 General + +Within the framework of MCPTT, when the SIP Core (3GPP TS 24.379 [41]) is implemented by an IMS core network, if the P-CSCF receives a SIP request message including a Resource-Priority header field with a namespace field and priority value defined for MCPTT for adjusting the priority of an MCPTT session, the P-CSCF shall provide the "resPrio" attribute and the "mcpttId" in the Npcf\_PolicyAuthorization\_Create request as defined in clause B.13.2 to allow the PCF to set the corresponding PCC rule(s) according to the prioritized MCPTT service. Additionally, if "PrioritySharing" feature is supported, the P-CSCF may provide the "prioSharingInd" attribute within the media component included in the "medComponents" attribute as described in clause B.1. For MCPTT the service priority and the priority sharing indicator are defined in 3GPP TS 24.379 [41]. + +NOTE 1: The process of adjusting priority may occur several times during the course of one session, e.g. a normal MCPTT group call elevated to an MCPTT emergency group call, returned to a normal priority MCPTT group call, elevated to an MCPTT imminent peril group call and returned to a normal priority MCPTT group call. + +NOTE 2: Upon reception of a request that requires the adjustment of the MCPTT priority, the PCF is expected to derive the PCC Rules corresponding to the this MCPTT session, as appropriate according to operator policies. + +NOTE 3: The PCF can identify an MCPTT call using the IMS Communication Service Identifier specific to MCPTT, which is provided by the P-CSCF in the "afAppId" attribute in the Npcf\_PolicyAuthorization\_Create request sent to PCF. + +### B.10.2 Determination of MCPTT priority parameter values + +When the P-CSCF receives an authorized Resource-Priority header field containing an appropriate namespace and priority value used for MCPTT in SIP signalling, the P-CSCF shall include the "mcpttId" attribute and the "resPrio" attribute in the corresponding Npcf\_PolicyAuthorization service operation towards the PCF. + +The "mcpttId" attribute shall include the namespace defined for MCPTT as received within the Resource-Priority header field. + +NOTE: Two different values are defined for the MCPTT-Identifier AVP, one for each namespace value defined for MCPTT (see IETF RFC 8101 [42]). + +The "resPrio" attribute shall contain the priority value of the Resource-Priority header; the lowest priority shall be mapped to **PRI0\_1** (Resource-Priority header value 0), the next after the lowest to **PRI0\_2** (Resource-Priority header value 1), and so on up to the highest priority which shall be mapped to **PRI0\_16** (Resource-Priority header value 15). + +Additionally, when the P-CSCF receives information about priority sharing from an MCPTT server that supports simultaneous sessions and that needs to share a common priority for several MCPTT sessions and if "PrioritySharing" feature is supported, the P-CSCF may include the "prioSharingInd" attribute within the media component received in the "medComponents" attribute in the corresponding Npcf\_PolicyAuthorization service operation. See 3GPP TS 24.379 [41] for further information. + +--- + +## B.11 Handling of MCVideo priority call + +### B.11.1 General + +Within the framework of MCVideo, when the SIP Core (3GPP TS 23.281 [34]) is implemented by an IMS core network, if the P-CSCF receives a SIP request message including a Resource-Priority header field with a namespace field and priority value defined for MCVideo for adjusting the priority of an MCVideo session, the P-CSCF shall provide the "resPrio" attribute and the "mcVideoId" in the Npcf\_PolicyAuthorization\_Create request as defined in clause B.15.2 to allow the PCF to set the corresponding PCC rule(s) according to the prioritized MCVideo service. + +- NOTE 1: The process of adjusting priority may occur several times during the course of one session, e.g. a normal MCVideo group call elevated to an MCVideo emergency group call and returned to a normal priority MCVideo group call, elevated to an MCVideo imminent peril group call and returned to a normal priority MCVideo group call. +- NOTE 2: Upon reception of a request that requires the adjustment of the MCVideo priority, the PCF is expected to derive the PCC Rules corresponding to the this MCVideo session, as appropriate according to operator policies. +- NOTE 3: The PCF can identify an MCVideo call using the IMS Communication Service Identifier specific to MCVideo, which is provided by the P-CSCF in the "afAppId" attribute in the Npcf\_PolicyAuthorization\_Create request sent to PCF. + +### B.11.2 Determination of MCVideo priority parameter values + +When the P-CSCF receives an authorized Resource-Priority header field containing an appropriate namespace and priority value used for MCVideo in SIP signalling, the P-CSCF shall include the "mcVideoId" attribute and the "resPrio" attribute in the corresponding Npcf\_PolicyAuthorization service operation towards the PCF. + +The "mcVideoId" attribute shall include the namespace defined for MCVideo as received within the Resource-Priority header field. + +The "resPrio" attribute shall contain the priority value of the Resource-Priority header; the lowest priority shall be mapped to **PRI0\_1** (Resource-Priority header value 0), the next after the lowest to **PRI0\_2** (Resource-Priority header value 1), and so on up to the highest priority which shall be mapped to **PRI0\_16** (Resource-Priority header value 15). + +--- + +## B.12 Notification Access Type Change + +When the P-CSCF receives an initial SIP REGISTER message or a SIP INVITE message from an attached UE, the P-CSCF may request from the PCF the information about the access type the UE is attached to using the procedure specified in clauses 4.2.2.2, 4.2.3.2 and 4.2.6.2. + +- NOTE 1: This procedure is not applicable for IMS registrations for Emergency sessions. +- NOTE 2: The P-CSCF can request information about the access type as part of the SIP session setup when it is only interested in the related information when the IMS session is ongoing. + +If the P-CSCF requests information about the access type, the P-CSCF shall also subscribe within the same Npcf\_PolicyAuthorization service operation to notifications for changes of the access type used by the UE. The P-CSCF shall include an entry of the "AfEventSubscription" data type in the "events" attribute with the "event" attribute set to the value "ACCESS\_TYPE\_CHANGE". + +When the P-CSCF receives from the PCF the access type: + +- in the subscription request response within the HTTP response; or +- in the notification of access type change in an HTTP POST request from the PCF, + +the P-CSCF shall store the access type information received within the "accessType" attribute and the RAT type information received within "ratType" attribute and use the received information as per P-CSCF procedures in 3GPP TS 24.229 [32]. + +The P-CSCF may receive subsequent notifications for changes of the access type from the PCF according to clause 4.2.5.2. When the P-CSCF receives a notification of the change of the access type used by the UE, the P-CSCF shall store the new access type information and RAT type information and use the received information as per P-CSCF procedures in 3GPP TS 24.229 [32]. + +NOTE 3: The subscription to receive information about the access type will be cancelled when the corresponding Individual Application Session Context resource is removed by the P-CSCF (i.e. when the UE is de-REGISTERED or the related SIP call is released). + +--- + +## B.13 Notification of PLMN Change + +When the P-CSCF receives an initial SIP REGISTER message from an attached UE, the P-CSCF may subscribe to notifications of PLMN changes corresponding to the identity of the network (either a PLMN or an SNPN) where the UE is located using the procedure specified in clauses 4.2.2.2, 4.2.3.2 and 4.2.6.2. + +NOTE: For a UE located in an SNPN the SNPN Identifier consisting of the PLMN Identifier and the NID is provided. + +When the P-CSCF receives the subscription request response in an HTTP response or the notification of PLMN change in an HTTP POST request from the PCF, the P-CSCF shall store the PLMN Identifier and, if available, the NID received within the "plmnId" attribute and use the received information as per P-CSCF procedures in 3GPP TS 24.229 [32]. + +The P-CSCF shall cancel the subscription to notification for changes of the PLMN used by the UE when the user is de-registered from the IM CN subsystem. + +--- + +## B.14 Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM) + +As a network option, the P-CSCF may support the PCC procedures in the present clause to handle the Coverage and Handoff Enhancements using Multimedia error robustness feature (CHEM). + +NOTE: When the CHEM feature is supported, improved error robustness might be enabled by packet-loss handling procedures of the codec, codec mode, or codec configuration to avoid, delay, or reduce the need to handoff a terminal due to degradation in the media quality. Communicating the level of robustness of the media to the network enables the eNB to use this information to determine a threshold for when the terminal should be handed off to another cell, domain (circuit-switched vs. packet-switched), or radio access technology. + +When a session is initiated or modified the P-CSCF supporting the CHEM feature shall derive the "maxPacketLossRateDl" attribute and "maxPacketLossRateUl" attribute based on the PLR\_adapt and maxe2e-PLR attribute values in both the SDP offer and/or SDP answer to determine the maximum tolerable end-to-end PLR budget distributed across the uplink and downlink in a media transport path as described in 3GPP TS 29.513 [7] clause 7.2.3. + +Upon reception of SDP offer and answer, the P-CSCF should check whether "a= PLR\_adapt" line is present in both SDP offer and answer to derive "maxPacketLossRateDI" attribute and "maxPacketLossRateUI" attribute in "medComponents" attribute else "maxPacketLossRateDI" and "maxPacketLossRateUI" attributes are not included by the P-CSCF. + +The originating P-CSCF should derive "maxPacketLossRateDI" attribute to the maximum value of MaxPacketLossRateDI among all the RTP payload types. For each RTP payload type MaxPacketLossRateDI is computed as described in 3GPP TS 29.513 [7] clause 7.2.3. + +- If maxe2e-PLR is included in the SDP offer then the MaxPacketLossRateDI for a payload type is derived as value of maxe2e-PLR in the SDP offer minus maxUL-PLR in the SDP answer if present else the MaxPacketLossRateDI is $\frac{1}{2}$ maxe2e-PLR value present in the SDP offer. +- If maxe2e-PLR is not included in the SDP offer then the MaxPacketLossRateDI for a payload type is derived from the default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [30] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy minus maxUL-PLR in the SDP answer if present else the MaxPacketLossRateDI $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [30] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +The originating P-CSCF should derive "maxPacketLossRateUI" attribute to the maximum value of MaxPacketLossRateUI among all the RTP payload types. For each RTP payload type MaxPacketLossRateUI is computed as described in 3GPP TS 29.513 [7] clause 7.2.3. + +- If maxe2e-PLR is included in the SDP answer then the MaxPacketLossRateUI for a payload type is derived as value of maxe2e-PLR in the SDP answer minus maxDL-PLR in the SDP answer if present else the MaxPacketLossRateUI is $\frac{1}{2}$ maxe2e-PLR value present in the SDP answer. +- If maxe2e-PLR is not included in the SDP answer then the MaxPacketLossRateUI for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [30] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +The terminating P-CSCF should derive "maxPacketLossRateDI" attribute to the maximum value of MaxPacketLossRateDI among all the RTP payload types. For each RTP payload type MaxPacketLossRateDI is computed as described in 3GPP TS 29.513 [7] clause 7.2.3. + +- If maxe2e-PLR is included in the SDP answer then the MaxPacketLossRateDI for a payload type is derived as value of maxDL-PLR in the SDP answer if present else the MaxPacketLossRateDI is $\frac{1}{2}$ maxe2e-PLR value present in the SDP answer. +- If maxe2e-PLR is not included in the SDP answer then the MaxPacketLossRateDI for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [30] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +The terminating P-CSCF should derive "maxPacketLossRateUI" attribute to the maximum value of MaxPacketLossRateUI among all the RTP payload types. For each RTP payload type MaxPacketLossRateUI is computed as described in 3GPP TS 29.513 [7] clause 7.2.3. + +- If maxe2e-PLR is included in the SDP offer then the MaxPacketLossRateUI for a payload type is derived as value of maxUL-PLR in the SDP answer if present else the MaxPacketLossRateUI is $\frac{1}{2}$ maxe2e-PLR value present in the SDP offer. +- If maxe2e-PLR is not included in the SDP offer then the MaxPacketLossRateUI for a payload type is derived as the $\frac{1}{2}$ default value in end-to-end Maximum End-to-End Packet Loss Rate for the decoder of the RTP payload type as recommended in 3GPP TS 26.114 [30] clause X.1.2 for application layer redundancy or X.1.1 for partial redundancy. + +## B.15 Handling of a FLUS session + +If the P-CSCF receives a SIP request that requires provisioning of a service information to the PCF, the "FLUS" feature is supported and an SDP attribute "a=label:flus..." is included in one or more of the received SDP media descriptions, the P-CSCF shall provide the string after "a=label:" starting with "flus" within the "flusId" attribute for each affected media components within the "medComponents" attribute in the corresponding Npcf\_PolicyAuthorization service operation towards the PCF. + +NOTE: During the first interaction with the PCF, the P-CSCF does not know if the "FLUS" feature is supported by the PCF. In this case the P-CSCF will include the information as if the feature is supported. + +If additionally the P-CSCF receives the "a=3gpp-qos-hint" media-level SDP attribute in the SIP request, the P-CSCF shall provide the PCF with the "desMaxLatency" attribute and/or "desMaxLoss" attribute as described in 3GPP TS 29.513 [7], clause 7.2.3. + +Upon receiving the information from the P-CSCF and if the "FLUS" feature is supported, the PCF shall derive the QoS information as described in 3GPP TS 29.513 [7], clause 7.3.3. + +## B.16 QoS hint support for data channel media + +If the P-CSCF receives a SIP request that requires provisioning of a service information to the PCF, the QoSHint feature is supported and an SDP attribute "a=3gpp-qos-hint" is included in one or more of the received data channel media descriptions, the P-CSCF may provide the "desMaxLatency" attribute and/or "desMaxLoss" attribute for each affected application media component within the "medComponents" attribute in the corresponding Npcf\_PolicyAuthorization service operation towards the PCF. + +NOTE: During the first interaction with the PCF, the P-CSCF does not know if the QoSHint feature is supported by the PCF. In this case the P-CSCF will include the information as if the feature is supported. + +Upon receiving the information from the P-CSCF and if the QoSHint feature is supported, the PCF shall derive the QoS information as described in 3GPP TS 29.513 [7], clause 7.3.3. + +## B.17 Handling of MPS Session + +When the P-CSCF receives an authorised Resource-Priority header field or when the P-CSCF adds a temporarily authorised Resource-Priority header field containing an appropriate namespace and priority value in SIP signaling, and recognizes the need for priority treatment as specified in 3GPP TS 24.229 [32], and the "IMS\_SBI" feature is supported, the P-CSCF shall include the "mpsId" attribute and the "resPrio" attribute in the corresponding Npcf\_PolicyAuthorization service operation towards the PCF. The "mpsId" attribute shall contain the national variant for MPS service name indicating an MPS session. The "resPrio" attribute shall be determined based on the resource value received in the "wps" namespace of the SIP Resource-Priority header field, and shall be included at "AppSessionContextReqData" data type level as well as the "MediaComponent" data type level. The "resPrio" attribute shall be populated with a default value if the priority value is unknown. + +NOTE 1: Various mechanisms can be applied to recognize the need for priority treatment in the P-CSCF (e.g., based on the dialled digits), according to national regulation and network configuration, as stated in 3GPP TS 24.229 [32]. + +NOTE 2: Highest user priority level (lowest numerical resource value of the SIP Resource-Priority header field) is mapped to the highest enumerated value of the "resPrio" attribute. + +If the P-CSCF supports the SBI Message Priority mechanism for an MPS session, the P-CSCF shall include the "3gpp-Sbi-Message-Priority" custom HTTP header with a priority value based on the value of the "resPrio" attribute. The highest "resPrio" value is mapped to the corresponding lowest value of the "3gpp-Sbi-Message-Priority" custom HTTP header. + +Upon reception of a request that requires MPS treatment, the PCF shall derive the PCC rules corresponding to the MPS session, as appropriate. The PCF shall take specific actions on the corresponding PDU session to ensure that the MPS session is prioritized, as described in 3GPP TS 29.512 [8], clause 4.2.6.2.12.3. + +When the P-CSCF detects that the MPS session has ended, the P-CSCF deletes in the PCF the "Individual Application Session Context" resource corresponding to the MPS session. The PCF shall delete the PCC rules corresponding to the MPS session and shall revoke the actions related to the prioritization of the MPS session in the corresponding PDU session, as described in 3GPP TS 29.512 [8], clause 4.2.6.2.12.3. + +--- + +## B.18 Handling of RAN/NAS release cause values + +If the P-CSCF is required by operator policy to provide the RAN/NAS release cause information, it includes this information in the corresponding SIP message as specified in 3GPP TS 24.229 [32] when received from the PCF (see clause 4.4.4, 4.4.6.1, 4.4.6.2, 4.4.6.3 and 4.4.6.7). + +--- + +## Annex C (normative): Flow identifiers: Format definition and examples + +### C.1 Format of a flow identifier + +#### C.1.1 General + +A flow identifier is expressed as a 2-tuple as follows: + + + +where both are numbered starting from 1. The encoding of the flow identifier is as indicated in 3GPP TS 24.008 [36]. + +The rules for the allocation of flow identifiers to IP flows are defined in 3GPP TS 29.214 [20], Annex B.1.1. Derivation of flow identifiers from SDP are described in 3GPP TS 29.214 [20], Annex B.1.2, and examples are covered in 3GPP TS 29.214 [20], Annex B2, B3, B4 and B5. + +--- + +## Annex D (normative): Wireless and wireline convergence access support + +### D.1 Scope + +This annex provides the stage 3 definition of the Policy Authorization Service for wireless and wireline convergence access support for 5GS. + +The stage 2 definition and procedures of the Policy Authorization Service for wireless and wireline convergence access support for 5GS are contained in 3GPP TS 23.316 [44]. + +--- + +## D.2 Npcf\_PolicyAuthorization Service + +### D.2.1 Service Description + +#### D.2.1.1 Overview + +The overview defined in clause 4.1.1 applies with the exception that the UE is replaced by the 5G-RG and the W-AGF, which is acting as a UE towards the 5GC on behalf of the FN-RG. + +#### D.2.1.2 Service Architecture + +The service architecture defined in clause 4.1.2 applies. + +#### D.2.1.3 Network Functions + +##### D.2.1.3.1 Policy Control Function (PCF) + +The PCF functionality defined in clause 4.1.3.1 shall apply with the following modifications for W-5GAN and for the Npcf\_PolicyAuthorization service: + +- The 5G-RG and the W-AGF, acting as a UE towards the 5GC on behalf of the FN-RG, replace the UE. +- The PCF provides Policy Authorization as described in this Annex. + +##### D.2.1.3.2 NF Service Consumers + +The NF service consumer functionality defined in clause 4.1.3.2 shall apply with the following exceptions for the traffic of a PDU session over wireline access: + +- Indication that the QoS targets can no longer (or can again) be guaranteed does not apply. +- Invocation of Multimedia Priority Services does not apply in this release of the specification. +- Indication of PLMN change does not apply. +- Indication of TSN 5GS Bridge Information does not apply. +- Reporting RAN/NAS Release Cause over wireline does not apply. +- The Maximum Packet Loss Rate for UL and DL is not forwarded to the wireline access. CHEM feature does not apply. + +--- + +## D.3 Service Operations + +### D.3.1 Introduction + +Service procedures covered in clause 4.2.1 shall apply. + +### D.3.2 Npcf\_PolicyAuthorization\_Create Service Operation + +#### D.3.2.1 General + +The procedures specified in clause 4.2.2 shall apply with the following differences: + +- Subscriptions to notifications of Service Data Flow QoS targets are not supported. Clause 4.2.2.6 does not apply for the traffic of a PDU session over wireline access. +- Invocation of Multimedia Priority Services is not supported. Clause 4.2.2.12 does not apply for the traffic of a PDU session over wireline access. +- The PEI that may be returned as available user information within the "ueIds" attribute described in clause 4.2.2.18 shall have one of the following representations: + - i. When the UE supports only wireline access, the PEI shall be a MAC address. + - ii. When the UE supports at least one 3GPP access technology, the PEI shall be the allocated IMEI or IMEISV. +- Subscription and notification of PLMN change does not apply for the traffic of a PDU session over wireline access. +- Indication of TSN 5GS Bridge Information does not apply. Clauses 4.2.2.24, 4.2.2.25 and 4.2.2.31 do not apply. +- The Maximum Packet Loss Rate for UL and DL is not forwarded to the wireline access. Clause 4.2.2.28, Support of CHEM feature, does not apply for the traffic of a PDU session over wireline access. +- When the NF service consumer subscribes to the Access Type Change event, the event is met, and the 5G-RG or FN-RG is connected to the 5GC via wireline access, the reported wireline transmission technology is encoded in the "ratType" attribute, within either the EventsNotification data type or the AdditionalAccessInfo data type, as applicable. + +## D.3.3 Npcf\_PolicyAuthorization\_Update Service Operation + +### D.3.3.1 General + +The procedures specified in clause 4.2.3 shall apply with the following differences: + +- Subscriptions to notifications of Service Data Flow QoS targets are not supported. Clause 4.2.3.6 does not apply for the traffic of a PDU session over wireline access. +- Invocation of Multimedia Priority Services is not supported. Clause 4.2.3.12 does not apply for the traffic of a PDU session over wireline access. +- Subscription and notification of PLMN change does not apply for the traffic of a PDU session over wireline access. +- Indication of TSN 5GS Bridge Information does not apply. Clauses 4.2.3.24, and 4.2.3.25 do not apply. +- The Maximum Packet Loss Rate for UL and DL is not forwarded to the wireline access. Clause 4.2.3.27, Support of CHEM feature, does not apply for the traffic of a PDU session over wireline access. +- When the NF service consumer subscribes to the Access Type Change event, the event is met, and the 5G-RG or FN-RG is connected to the 5GC via wireline access, the reported wireline transmission technology is encoded in the "ratType" attribute, within either the EventsNotification data type or the AdditionalAccessInfo data type, as applicable. + +## D.3.4 Npcf\_PolicyAuthorization\_Delete Service Operation + +### D.3.4.1 General + +The procedures specified in clause 4.2.4 shall apply with the following differences: + +- When the report of access network information described in clause 4.2.4.6 includes the user location information, the "n3gaLocation" attribute shall be included in the "ueLoc" attribute and shall encode: + - a) if the UE connects via W-5GBAN access: + +- shall encode the Global Line Identifier in the "gli" attribute; and + - may include the "w5gbnLineType" attribute to indicate whether the W-5GBAN access is DSL or PON; or +- b) if the UE connects via W-5GCAN access, the HFC Node Identifier in the "hfcNodeId" attribute. +- Reporting RAN/NAS Release Cause over wireline does not apply. Clause 4.2.4.10 does not apply. + +## D.3.5 Npcf\_PolicyAuthorization\_Notify Service Operation + +### D.3.5.1 General + +The procedures specified in clause 4.2.5 shall apply with the following differences: + +- Subscriptions to notifications of Service Data Flow QoS targets are not supported. Clause 4.2.5.4 does not apply for the traffic of a PDU session over wireline access. +- Invocation of Multimedia Priority Services is not supported. Clause 4.2.4.5 does not apply for the traffic of a PDU session over wireline access. +- When the report of access network information described in clause 4.2.5.11 includes the user location information, the "n3gaLocation" attribute shall be included in the "ueLoc" attribute and shall encode: + - a) if the UE connects via W-5GBAN access: + - shall encode the Global Line Identifier in the "gli" attribute; and + - may include the "w5gbnLineType" attribute to indicate whether the W-5GBAN access is DSL or PON; or + - b) if the UE connects via W-5GCAN access, the HFC Node Identifier in the "hfcNodeId" attribute. +- Notification of PLMN changes does not apply for the traffic of a PDU session over wireline access. +- Indication of TSN 5GS Bridge Information does not apply. Clauses 4.2.5.13 and 4.2.5.16 do not apply. +- Reporting RAN/NAS Release Cause over wireline does not apply. Clauses 4.2.5.5 and 4.2.5.10 do not apply. +- When the 5G-RG or FN-RG connects to the 5GC via W-5GAN, and the Access Type Change event is met, the reported wireline transmission technology is encoded in the "ratType" attribute, within either the EventsNotification data type or the AdditionalAccessInfo data type, as applicable. + +## D.3.6 Npcf\_PolicyAuthorization\_Subscribe Service Operation + +### D.3.6.1 General + +The procedures specified in clause 4.2.6 shall apply with the following differences: + +- When the NF service consumer subscribes to the Access Type Change event, the event is met, and the 5G-RG or FN-RG is connected to the 5GC via wireline access, the reported wireline transmission technology is encoded in the "ratType" attribute, within either the EventsNotification data type or the AdditionalAccessInfo data type, as applicable. +- Subscription to PLMN change does not apply for the traffic of a PDU session over wireline access. + +## D.3.7 Npcf\_PolicyAuthorization\_Unsubscribe Service Operation + +### D.3.7.1 General + +The procedures specified in clause 4.2.7 shall apply. + +--- + +## Annex E (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Policy Authorization Service specification | 0.0.0 | +| 2017-03 | CT3#92 | | | | | Inclusion of pCRs agreed during CT3#92 | 0.1.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of documents agreed in CT3#94:
C3-180036, C3-180038, C3-180212, C3-180213,
C3-180214, C3-180217, C3-180218, C3-180243,
C3-180313, C3-180314, C3-180315, C3-180316. | 0.2.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of documents agreed in CT3#95:
C3-181229, C3-181338, C3-181231, C3-181232, C3-181339, C3-181323 | 0.3.0 | +| 2018-04 | CT3#96 | | | | | Inclusion of documents agreed in CT3#96:
C3-182057, C3-182333, C3-182235, C3-182334,
C3-182474, C3-182336, C3-182337, C3-182338,
C3-182339, C3-182245, C3-182475, C3-182247,
C3-182248, C3-182249, C3-182250, C3-182251 | 0.4.0 | +| 2018-06 | CT3#97 | | | | | Inclusion of documents agreed in CT3#97:
C3-183220, C3-183222, C3-183230, C3-183233,
C3-183234, C3-183239, C3-183281, C3-183300,
C3-183301, C3-183517, C3-183518, C3-183520,
C3-183521, C3-183522, C3-183523, C3-183524,
C3-183525, C3-183526, C3-183577, C3-183579,
C3-183580, C3-183581, C3-183582, C3-183583,
C3-183584, C3-183585, C3-183586, C3-183587,
C3-183588, C3-183589, C3-183590, C3-183591,
C3-183592, C3-183820, C3-183821, C3-183822,
C3-183879, C3-183882. | 0.5.0 | +| 2018-06 | CT#80 | | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | DNAI change notification type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | 1 | F | Definition of FlowStatus data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 2 | F | Temporal validity update | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | | F | Modification of Traffic Routing Information provided at AF session level | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 1 | F | Missing AF Transaction Identifier | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 2 | B | Solution to IPv4 overlapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 2 | B | Subscription and notification of resources allocation outcome, data model | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | 1 | B | Subscription to resources allocation outcome, service procedures | 15.1.0 | +| 2018-09 | CT#81 | CP-182101 | 0009 | 3 | B | Notification of resource allocation outcome, service procedures | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | 2 | B | Subscription and notification of out of credit events, data model | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0011 | 1 | B | Subscription to out of credit notification, service procedures | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0012 | 3 | B | Out of credit notification, service procedures | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0013 | 1 | F | References to Data Types defined in 5G Technical Specifications | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0014 | 1 | F | Removal of error
UNAUTHORIZED_TRAFFIC_ROUTING_REQUEST | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0015 | 3 | F | OpenAPI corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0016 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0017 | | F | Correction on TemporalValidity | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0018 | 2 | F | Resource structure presentation | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0019 | | F | Corrections related to Feature negotiation | 15.1.0 | +| 2018-08 | CT#81 | CP-182040 | 0020 | 1 | F | Cardinality of optional arrays and maps | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0021 | | F | Application Error: SUBSCRIPTION_NOT_FOUND | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0022 | 2 | F | Completion and clarification of non-3GPP access location information | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0023 | 1 | B | Support of Priority Services | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0024 | 3 | F | Correction of PRA information | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0025 | 1 | F | Updates in clause 4.2.6.3 to detail session binding | 15.1.0 | +| 2018-08 | CT#81 | CP-182100 | 0026 | 2 | B | Support of content versioning for a media component, service procedures | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0027 | | B | Support of content versioning for a media component, data model | 15.1.0 | +| 2018-08 | CT#81 | CP-182103 | 0028 | 2 | B | Updates of QoS Notification Control description and data model | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0029 | 2 | B | Requested Service Temporarily not authorized | 15.1.0 | +| 2018-08 | CT#81 | CP-182102 | 0030 | 2 | B | Support of notification of content version during service data flow deactivation | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0031 | 1 | F | Transfer of RouteToLocation Data Type to TS 29.571 | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0032 | 2 | F | Addition of FlowUsage Information | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0033 | | F | Correction of evsNotif attribute | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0034 | 1 | F | Completing definition of re-used data types | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0035 | | F | Correction of AppSessionContextReqData | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0036 | | F | Correction of evNotif array attribute | 15.1.0 | +| 2018-08 | CT#81 | CP-182015 | 0037 | | F | Removal of Editor's note in subclause 5.6.2.6 | 15.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------|--------| +| 2018-08 | CT#81 | CP-182015 | 0038 | | F | Corrections on TosTrafficClass data type | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0043 | | F | Usage of EventsSubscReqData data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0044 | | F | Reference update: RFC 7396 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0045 | | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0046 | | F | Update of sponsored data connectivity indication | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0047 | 3 | F | Npcf_PolicyAuthorization API Authorization based on OAuth2 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0050 | 1 | F | Removal of references to 3GPP TS 29.508 | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0051 | 1 | F | Correction of 404 error | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0052 | | F | Corrections on Spatial Validity in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183125 | 0053 | 2 | F | Corrections on Data Types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0054 | 5 | F | Adding "nullable" property to OpenAPI definitions of data types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0055 | | F | Correction of figure 4.2.4.2-1 to include 204 status code | 15.2.0 | +| 2018-12 | CT#82 | CP-183125 | 0056 | 1 | F | Corrections on OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0058 | 1 | F | Adding the externalDocs field in the OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0059 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0060 | 1 | F | Incorrect references | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0061 | 1 | F | OpenAPI: HTTP status codes alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0062 | | F | OpenAPI: usage of the "tags" keyword | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0063 | | F | Presence conditions in OpenAPI file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0064 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0065 | | F | Correction of resource URIs | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0066 | 1 | F | New data type for subscriptions to UP Path management events | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0067 | 2 | F | Mandatory traffic routing information for AF influence on traffic routing | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0068 | | F | Incorrect use of Link data type | 15.2.0 | +| 2018-12 | CT#82 | CP-183125 | 0069 | 1 | F | Corrections on QNC trigger name | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0070 | 1 | F | Miscellaneous Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0071 | | F | Removal of SUBSCRIPTION_NOT_FOUND error from service procedures | 15.2.0 | +| 2018-12 | CT#82 | CP-183125 | 0072 | | F | Update of supported AF events | 15.2.0 | +| 2019-03 | CT#83 | CP-190112 | 0074 | | F | Add GPSI in N5 | 15.3.0 | +| 2019-03 | CT#83 | CP-190112 | 0077 | 1 | F | Miscellaneous corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190112 | 0078 | 2 | F | Retry-After header definition in OpenAPI | 15.3.0 | +| 2019-03 | CT#83 | CP-190112 | 0079 | 1 | F | OpenAPI Version number update | 15.3.0 | +| 2019-03 | CT#83 | CP-190070 | 0076 | 1 | F | Indication of acceptable service information | 16.0.0 | +| 2019-03 | CT#83 | CP-190069 | 0080 | 3 | F | OpenAPI version update | 16.0.0 | +| 2019-06 | CT#84 | CP-191076 | 0082 | 1 | A | Correction to the encoding of the initial POST request callback URI | 16.1.0 | +| 2019-06 | CT#84 | CP-191076 | 0084 | | A | Storage of OpenAPI specification file | 16.1.0 | +| 2019-06 | CT#84 | CP-191076 | 0088 | 2 | A | Correction to EthFlowDescription data type | 16.1.0 | +| 2019-06 | CT#84 | CP-191076 | 0093 | 1 | A | Precedence of OpenAPI file | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0094 | 2 | B | AF acknowledgement to be expected | 16.1.0 | +| 2019-06 | CT#84 | CP-191071 | 0095 | 2 | B | UE IP address preservation Indication | 16.1.0 | +| 2019-06 | CT#84 | CP-191076 | 0097 | | A | Missing resPrio attribute | 16.1.0 | +| 2019-06 | CT#84 | CP-191076 | 0101 | 1 | A | Copyright Note in YAML file | 16.1.0 | +| 2019-06 | CT#84 | CP-191101 | 0105 | 2 | F | OpenAPI Version number update | 16.1.0 | +| 2019-09 | CT#85 | CP-192155 | 0109 | 1 | B | Support of "Access Network Charging Correlation Information" notification | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0110 | 1 | B | Support of "Out of credit" notification | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0111 | | B | Support of the AF charging identifier | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0112 | | B | Support of "Access Network Information Notification" | 16.2.0 | +| 2019-09 | CT#85 | CP-192202 | 0114 | 1 | B | Support a set of MAC addresses in traffic filter | 16.2.0 | +| 2019-09 | CT#85 | CP-192144 | 0116 | 1 | A | Support of Ethernet scenarios | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0117 | 1 | B | IMS related P-CSCF procedures and Service Information Status | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0118 | | B | IMS related P-CSCF procedures, setting flow status and flow number | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0119 | | B | IMS related P-CSCF procedures, Support of SIP Forking | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0120 | 1 | B | IMS related P-CSCF procedures, support of RTCP flows | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0121 | 2 | B | Subscription to notification of Signalling Path Status | 16.2.0 | +| 2019-09 | CT#85 | CP-192222 | 0122 | | B | Provisioning of Signalling Flow Information | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0123 | 1 | B | Resource Sharing Support | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0124 | | B | Support of Mission Critical Push To Talk | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0125 | 1 | B | Support of Mission Critical Video | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0126 | 1 | B | Priority Sharing Indication | 16.2.0 | +| 2019-09 | CT#85 | CP-192155 | 0127 | | B | IMS emergency services | 16.2.0 | +| 2019-09 | CT#85 | CP-192144 | 0129 | | A | Correction to Policy Authorization Update | 16.2.0 | +| 2019-09 | CT#85 | CP-192152 | 0130 | 1 | B | Support of wireline and wireless access convergence, Annex Skeleton | 16.2.0 | +| 2019-09 | CT#85 | CP-192223 | 0131 | 1 | B | Support of wireline and wireless access convergence, NFs | 16.2.0 | +| 2019-09 | CT#85 | CP-192173 | 0133 | | F | OpenAPI version update | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0135 | 1 | F | Open issue for AddrReservation feature | 16.3.0 | +| 2019-12 | CT#86 | CP-193186 | 0137 | | F | Correction to appReloc attribute | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0138 | 1 | B | P-CSCF procedures to support Access Type Change notification | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193196 | 0139 | 1 | B | P-CSCF procedures to subscribe to PLMN Change notification | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0140 | 2 | B | Support of the RAN-NAS Release Cause | 16.3.0 | +| 2019-12 | CT#86 | CP-193235 | 0141 | 6 | B | QoS Handling for V2X Communication | 16.3.0 | +| 2019-12 | CT#86 | CP-193181 | 0142 | 3 | B | QoS Monitoring for Service Data Flows | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0144 | | B | NetLoc Correction | 16.3.0 | +| 2019-12 | CT#86 | CP-193222 | 0145 | 2 | B | Transport of TSN information and containers between PCF and AF | 16.3.0 | +| 2019-12 | CT#86 | CP-193222 | 0146 | 1 | B | Transport of TSC assistance information between PCF and AF | 16.3.0 | +| 2019-12 | CT#86 | CP-193260 | 0147 | 5 | B | Indication of PS to CS Handover for 5G SRVCC | 16.3.0 | +| 2019-12 | CT#86 | CP-193215 | 0148 | 4 | B | Coverage and Handover Enhancements for Media (CHEM) | 16.3.0 | +| 2019-12 | CT#86 | CP-193197 | 0149 | 2 | B | Update of API version and TS version in OpenAPI file | 16.3.0 | +| 2019-12 | CT#86 | CP-193186 | 0151 | | A | Correct VLAN tag description | 16.3.0 | +| 2019-12 | CT#86 | CP-193186 | 0153 | | A | Corrections to several mistakes | 16.3.0 | +| 2019-12 | CT#86 | CP-193228 | 0154 | 2 | B | Report of Wireline Location Information | 16.3.0 | +| 2019-12 | CT#86 | CP-193191 | 0155 | 1 | B | Support of 5WWC, supported PEI format | 16.3.0 | +| 2019-12 | CT#86 | CP-193229 | 0156 | 2 | B | Support of Trusted non-3GPP accesses | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0157 | | F | Correction of AF Charging Identifier data type | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0158 | 2 | B | P-CSCF restoration | 16.3.0 | +| 2019-12 | CT#86 | CP-193196 | 0159 | | B | Support of Maximum Supported Bandwidth and Minimum Desired Bandwidth | 16.3.0 | +| 2019-12 | CT#86 | CP-193212 | 0161 | 1 | F | Update of API version and TS version in OpenAPI file | 16.3.0 | +| 2020-03 | CT#87e | CP-200215 | 0162 | | B | Support of Framework for Live Uplink Streaming (FLUS) in Npcf_PolicyAuthorization service | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0174 | | B | DNN Clarification | 16.4.0 | +| 2020-03 | CT#87e | CP-200265 | 0176 | 3 | B | Complete the QoS Monitoring | 16.4.0 | +| 2020-03 | CT#87e | CP-200206 | 0177 | | B | Network provided location information at SIP session release | 16.4.0 | +| 2020-03 | CT#87e | CP-200231 | 0180 | 1 | B | Report of EPS Fallback | 16.4.0 | +| 2020-03 | CT#87e | CP-200201 | 0181 | 1 | B | Update of the indication of PS to CS Handover | 16.4.0 | +| 2020-03 | CT#87e | CP-200254 | 0182 | 3 | B | Configuration of one or more NW-TT port management information containers | 16.4.0 | +| 2020-03 | CT#87e | CP-200218 | 0183 | | B | DS-TT port MAC address as UE MAC address | 16.4.0 | +| 2020-03 | CT#87e | CP-200218 | 0184 | 2 | B | TSCAI input container and TSN QoS container | 16.4.0 | +| 2020-03 | CT#87e | CP-200256 | 0185 | 2 | B | Notification about TSN port detection and/or port management information, AF session exists | 16.4.0 | +| 2020-03 | CT#87e | CP-200255 | 0186 | 1 | B | Notification about TSN port detection and/or port management information, no AF session exists | 16.4.0 | +| 2020-03 | CT#87e | CP-200212 | 0187 | | F | Modification of Alternative Service Requirements | 16.4.0 | +| 2020-03 | CT#87e | CP-200212 | 0188 | | F | Service Procedures for AF session with required QoS functionality | 16.4.0 | +| 2020-03 | CT#87e | CP-200207 | 0189 | | B | Adding "ProblemDetails" data type in table 5.6.1-2 | 16.4.0 | +| 2020-03 | CT#87e | CP-200214 | 0190 | | F | Enumeration PreemptionControlInformationRm and "nullable" keyword | 16.4.0 | +| 2020-03 | CT#87e | CP-200202 | 0191 | | F | Correcting 5G_URLLC errors in clause 5.6 | 16.4.0 | +| 2020-03 | CT#87e | CP-200206 | 0192 | | F | OpenAPI: property containing the pre-emption control information | 16.4.0 | +| 2020-03 | CT#87e | CP-200206 | 0193 | | F | Correcting eIMS5G_SBA errors in clause 5.6 | 16.4.0 | +| 2020-03 | CT#87e | CP-200261 | 0194 | | F | Adding info about removable attributes "maxPacketLossRateDI" and "maxPacketLossRateUI" | 16.4.0 | +| 2020-03 | CT#87e | CP-200212 | 0195 | 1 | F | Correction to QoS notification Control | 16.4.0 | +| 2020-03 | CT#87e | CP-200216 | 0197 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-06 | CT#88e | CP-201219 | 0199 | 1 | A | Correction to response for PUT request for Events Subscription | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0200 | 1 | F | Correction to bridge information report and port management information container provisioning | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0201 | 1 | B | Correction to TSCAI provisioning | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0203 | | F | Removal of MAC address | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0204 | | F | Solving ENs related to a global line identity | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0205 | | F | Solving ENs related to NetLoc support for wireline access | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0206 | | F | Adding QosMonitoringInformationRm in table 5.6.1-1 | 16.5.0 | +| 2020-06 | CT#88e | CP-201232 | 0207 | | F | Miscellaneous corrections | 16.5.0 | +| 2020-06 | CT#88e | CP-201246 | 0208 | | F | Support of FLUS feature | 16.5.0 | +| 2020-06 | CT#88e | CP-201246 | 0209 | | F | Names of "maxPacketLossRateDI" and "maxPacketLossRateUI" attributes | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0210 | | B | Adding support of NID | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0211 | | F | Correction to Access Network Information for Trusted non-3GPP access | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0212 | | B | Solving Editor's notes on report of location for Trusted non-3GPP access | 16.5.0 | +| 2020-06 | CT#88e | CP-201229 | 0213 | 3 | B | Access Type Report for a MA PDU session | 16.5.0 | +| 2020-06 | CT#88e | CP-201232 | 0214 | 3 | F | Correction to NetLoc feature | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0215 | 1 | B | Correction to TSCAI UL and DL description | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0216 | 3 | B | Update of TSN related events | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0217 | 1 | F | Storage of YAML files in ETSI Forge | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0218 | 3 | B | Access Type report for WWW | 16.5.0 | +| 2020-06 | CT#88e | CP-201246 | 0219 | 1 | B | Support of applications with specific QoS hints | 16.5.0 | +| 2020-06 | CT#88e | CP-201272 | 0221 | 1 | B | Introduction of Bridge management information | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201219 | 0222 | 1 | A | Correction of Policy Authorization Delete API 200 OK response body content | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0224 | 1 | B | DS-TT MAC address derivation | 16.5.0 | +| 2020-06 | CT#88e | CP-201273 | 0225 | 1 | B | Max bitrate of TSN QoS information | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0226 | 1 | B | Port management on TSN AF | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0227 | 1 | F | Service information provisioning for TSN | 16.5.0 | +| 2020-06 | CT#88e | CP-201337 | 0228 | 1 | B | TSN QoS Information derivation on the TSN AF | 16.5.0 | +| 2020-06 | CT#88e | CP-201256 | 0230 | 1 | F | URI of the Npcf_PolicyAuthorization service | 16.5.0 | +| 2020-06 | CT#88e | CP-201219 | 0232 | | A | OpenAPI: adding Location header field in 303 response | 16.5.0 | +| 2020-06 | CT#88e | CP-201228 | 0233 | 1 | B | Events not supported in wireline access | 16.5.0 | +| 2020-06 | CT#88e | CP-201270 | 0234 | 1 | B | Reallocation of credit | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0235 | 1 | B | Indication of Application Sessions resource | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0236 | 1 | B | TSN AF selection by PCF | 16.5.0 | +| 2020-06 | CT#88e | CP-201219 | 0238 | 1 | A | Correction to Subscription operation | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0241 | | F | Optionality of ProblemDetails | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0242 | | B | Providing NID to the P-CSCF | 16.5.0 | +| 2020-06 | CT#88e | CP-201232 | 0243 | 1 | F | "PCSCF-Restoration-Enhancement" feature corrections | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0244 | | F | Required field in OpenAPI file | 16.5.0 | +| 2020-06 | CT#88e | CP-201244 | 0245 | 1 | F | Supported headers, Resource Data type, Operation Name | 16.5.0 | +| 2020-06 | CT#88e | CP-201233 | 0247 | 1 | B | Description of enhanced PCC features in NF description clauses | 16.5.0 | +| 2020-06 | CT#88e | CP-201252 | 0248 | 1 | B | Description of TSN features in NF description clauses | 16.5.0 | +| 2020-06 | CT#88e | CP-201213 | 0249 | | B | Description of URLLC features in NF description clauses | 16.5.0 | +| 2020-06 | CT#88e | CP-201238 | 0250 | | B | Description of V2X features in NF description clauses | 16.5.0 | +| 2020-06 | CT#88e | CP-201255 | 0253 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2020-09 | CT#89e | CP-202065 | 0256 | 1 | F | Data type correction of the reqAni | 16.6.0 | +| 2020-09 | CT#89e | CP-202062 | 0257 | 1 | F | Removal on Editor's notes on traffic forwarding for a MA PDU session | 16.6.0 | +| 2020-09 | CT#89e | CP-202065 | 0258 | | F | Correction to Trusted Non-3GPP location information | 16.6.0 | +| 2020-09 | CT#89e | CP-202065 | 0259 | 1 | F | Correction of handling of non-3GPP location information by the P-CSCF | 16.6.0 | +| 2020-09 | CT#89e | CP-202065 | 0260 | 1 | F | Handling of MPS Session by the P-CSCF | 16.6.0 | +| 2020-09 | CT#89e | CP-202084 | 0261 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.6.0 | +| 2020-12 | CT#90e | CP-203139 | 0262 | 1 | F | Essential Corrections and alignments | 16.7.0 | +| 2020-12 | CT#90e | CP-203127 | 0263 | 1 | F | SBI Message Priority mechanism for emergency session | 16.7.0 | +| 2020-12 | CT#90e | CP-203116 | 0265 | | A | Correction to ACCESS_TYPE_CHANGE | 16.7.0 | +| 2020-12 | CT#90e | CP-203150 | 0266 | 1 | F | Remove the NW-TT port from the TSN bridge info | 16.7.0 | +| 2020-12 | CT#90e | CP-203132 | 0267 | 1 | F | Correction to Alternative QoS Parameter | 16.7.0 | +| 2020-12 | CT#90e | CP-203116 | 0269 | 1 | A | Correction to referenced attributes | 16.7.0 | +| 2020-12 | CT#90e | CP-203111 | 0270 | | F | Corrections on QoS monitoring | 16.7.0 | +| 2020-12 | CT#90e | CP-203111 | 0271 | 1 | F | QoS monitoring report at PDU session termination | 16.7.0 | +| 2020-12 | CT#90e | CP-203139 | 0272 | 1 | F | Storage of YAML files in ETSI Forge | 16.7.0 | +| 2020-12 | CT#90e | CP-203110 | 0273 | 1 | F | Correction to support redirection codes | 16.7.0 | +| 2020-12 | CT#90e | CP-203152 | 0274 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.7.0 | +| 2021-03 | CT#91e | CP-210210 | 0275 | 4 | F | Disable UE notifications at changes related to Alternative QoS Profiles | 16.8.0 | +| 2021-03 | CT#91e | CP-210202 | 0276 | 1 | F | Correction to location information | 16.8.0 | +| 2021-03 | CT#91e | CP-210192 | 0277 | 1 | F | mandate notifCorrId for QoS monitoring subscription | 16.8.0 | +| 2021-03 | CT#91e | CP-210191 | 0278 | 3 | F | Correction to resource identifiers descriptions used in notifications | 16.8.0 | +| 2021-03 | CT#91e | CP-210237 | 0279 | 1 | F | Correction to TSN scenarios. | 16.8.0 | +| 2021-03 | CT#91e | CP-210197 | 0287 | 1 | A | Correction to PATCH method | 16.8.0 | +| 2021-03 | CT#91e | CP-210209 | 0288 | | F | Usage threshold update | 16.8.0 | +| 2021-03 | CT#91e | CP-210239 | 0291 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.8.0 | +| 2021-03 | CT#91e | CP-210219 | 0280 | 1 | F | Adding "description" field for map data types | 17.0.0 | +| 2021-03 | CT#91e | CP-210218 | 0281 | | F | OpenAPI reference | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0283 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.0.0 | +| 2021-03 | CT#91e | CP-210219 | 0284 | | F | Support of optional HTTP custom header fields | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0285 | | F | Terminology alignment: usage of "NF service consumer" | 17.0.0 | +| 2021-03 | CT#91e | CP-210240 | 0292 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2021-06 | CT#92e | CP-211226 | 0293 | 3 | B | AF Session for control of MPS for DTS | 17.1.0 | +| 2021-06 | CT#92e | CP-211257 | 0294 | 2 | B | Adding PCF as the consumer of the Npcf_PolicyAuthorization service to support DCAMP | 17.1.0 | +| 2021-06 | CT#92e | CP-211257 | 0295 | 4 | B | Support of subscription to application detection notification for a PDU session | 17.1.0 | +| 2021-06 | CT#92e | CP-211302 | 0296 | 4 | B | Support Time Sensing Communication other than TSN | 17.1.0 | +| 2021-06 | CT#92e | CP-211272 | 0297 | 3 | B | Support survival time | 17.1.0 | +| 2021-06 | CT#92e | CP-211205 | 0302 | 2 | A | Correction on 404 Not Found | 17.1.0 | +| 2021-06 | CT#92e | CP-211261 | 0304 | | A | Correction to Data type table | 17.1.0 | +| 2021-06 | CT#92e | CP-211200 | 0306 | 1 | A | Redirect responses with "application/json" media type | 17.1.0 | +| 2021-06 | CT#92e | CP-211304 | 0308 | 3 | A | Correcting the unit of Periodicity | 17.1.0 | +| 2021-06 | CT#92e | CP-211262 | 0309 | 1 | A | Removal of tsnBridgeInfo from EventsNotification data type | 17.1.0 | +| 2021-06 | CT#92e | CP-211276 | 0314 | 1 | B | Support of Network Exposure to EAS via Local NEF. | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211217 | 0315 | 2 | B | Application error. | 17.1.0 | +| 2021-06 | CT#92e | CP-211220 | 0317 | 1 | A | Adding NWDAF as the consumer of Npcf_PolicyAuthorization service | 17.1.0 | +| 2021-06 | CT#92e | CP-211205 | 0321 | | A | Attribute and data type corrections | 17.1.0 | +| 2021-06 | CT#92e | CP-211213 | 0322 | 1 | B | Satellite backhaul change event. | 17.1.0 | +| 2021-06 | CT#92e | CP-211217 | 0323 | 1 | F | Completion of Termination Causes. | 17.1.0 | +| 2021-06 | CT#92e | CP-211274 | 0324 | 1 | B | Support of TSCAI time domain. | 17.1.0 | +| 2021-06 | CT#92e | CP-211211 | 0325 | 1 | B | AF influence on traffic routing related events and errors report. | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0327 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212212 | 0328 | 1 | B | Authorization for MPS for DTS | 17.2.0 | +| 2021-09 | CT#93e | CP-212211 | 0329 | 1 | B | TSCTSF support for Time Sensitive Communication | 17.2.0 | +| 2021-09 | CT#93e | CP-212224 | 0330 | | F | Clarification of resource allocation failure | 17.2.0 | +| 2021-09 | CT#93e | CP-212205 | 0331 | | B | Support of IMS emergency service for SNPN | 17.2.0 | +| 2021-09 | CT#93e | CP-212200 | 0333 | 1 | A | Support of TCP and UDP ports in non-3GPP UE location | 17.2.0 | +| 2021-09 | CT#93e | CP-212211 | 0334 | 1 | F | Replacement of TSN Terminology in 29.514 | 17.2.0 | +| 2021-09 | CT#93e | CP-212190 | 0338 | | A | Corrections on modification of subscription procedure | 17.2.0 | +| 2021-09 | CT#93e | CP-212199 | 0339 | 1 | A | Correction of report of User location information time | 17.2.0 | +| 2021-09 | CT#93e | CP-212224 | 0340 | | F | Removal of network slice instance from service procedures | 17.2.0 | +| 2021-09 | CT#93e | CP-212211 | 0341 | 1 | B | Introduction of TSCTSF | 17.2.0 | +| 2021-09 | CT#93e | CP-212223 | 0342 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212224 | 0344 | | F | Report of 3GPP and non-3GPP User Location | 17.2.0 | +| 2021-12 | CT#94e | CP-213239 | 0346 | | F | API URI of the Npcf_PolicyAuthorization API | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0347 | 1 | B | TSCTSF discovery | 17.3.0 | +| 2021-12 | CT#94e | CP-213243 | 0348 | 1 | B | Access type change report | 17.3.0 | +| 2021-12 | CT#94e | CP-213194 | 0349 | | B | Subscription to the detection of the traffic of one or more applications | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0350 | 1 | B | Adding QoS related parameters to the Alternative Service Requirements | 17.3.0 | +| 2021-12 | CT#94e | CP-213194 | 0351 | 1 | B | Notification of PDU session established/terminated events | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0352 | 1 | F | Correction to TSC QoS information | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0353 | 1 | F | Support of IP type and Ethernet type of PDU sessions for TSC | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0354 | | F | TSCTSF NF service consumer | 17.3.0 | +| 2021-12 | CT#94e | CP-213225 | 0355 | | B | Resolves the editor's note for FILTER_RESTRICTIONS application error | 17.3.0 | +| 2021-12 | CT#94e | CP-213223 | 0356 | 1 | B | Adding EAS IP replacement information in Policy Authorization | 17.3.0 | +| 2021-12 | CT#94e | CP-213228 | 0357 | 1 | B | Adding DCCF as PCF Policy Authorization NF service consumer | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0358 | 1 | F | Update of 5.6.1 | 17.3.0 | +| 2021-12 | CT#94e | CP-213214 | 0360 | 1 | A | Alignment of description with data type for QosMonitoringInformation | 17.3.0 | +| 2021-12 | CT#94e | CP-213249 | 0362 | | A | Alignment of description with data type for TscPriorityLevel | 17.3.0 | +| 2021-12 | CT#94e | CP-213244 | 0365 | 1 | F | Correction to QoS notification data type | 17.3.0 | +| 2021-12 | CT#94e | CP-213230 | 0366 | | B | Slice data rate control in N5 interface | 17.3.0 | +| 2021-12 | CT#94e | CP-213200 | 0367 | 1 | F | Correction of service architecture, N43 reference point | 17.3.0 | +| 2021-12 | CT#94e | CP-213223 | 0368 | 1 | B | AF Request for Simultaneous Connectivity over Source and Target PSA at Edge Relocation | 17.3.0 | +| 2021-12 | CT#94e | CP-213229 | 0369 | 1 | B | 5GS Level Identities in SNPN scenarios | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0370 | 1 | F | Update of service architecture | 17.3.0 | +| 2021-12 | CT#94e | CP-213238 | 0372 | | A | Correction to optionality of problem details | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0373 | | F | Addition of description field to MpsAction data type | 17.3.0 | +| 2021-12 | CT#94e | CP-213225 | 0374 | | F | Correction to error responses | 17.3.0 | +| 2021-12 | CT#94e | CP-213244 | 0375 | 1 | F | Miscellaneous corrections | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0376 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-03 | CT#95e | CP-220183 | 0378 | 1 | B | QoS determination for TSC | 17.4.0 | +| 2022-03 | CT#95e | CP-220185 | 0379 | 1 | B | Support of AF triggered EAS rediscovery | 17.4.0 | +| 2022-03 | CT#95e | CP-220179 | 0380 | 1 | F | Corrections to satellite backhaul category changes | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0381 | 1 | F | Update of 4.2.5.1 | 17.4.0 | +| 2022-03 | CT#95e | CP-220176 | 0382 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.4.0 | +| 2022-03 | CT#95e | CP-220183 | 0383 | 1 | B | Adding alternative QoS related parameter setsAdding alternative QoS related parameter sets | 17.4.0 | +| 2022-03 | CT#95e | CP-220185 | 0384 | 1 | F | Handling of supported features for Edge Computing | 17.4.0 | +| 2022-03 | CT#95e | CP-220195 | 0385 | | F | Handling of the indication of UE IP address preservation in Update procedures | 17.4.0 | +| 2022-03 | CT#95e | CP-220202 | 0387 | 1 | B | Support of AN-GW restoration | 17.4.0 | +| 2022-03 | CT#95e | CP-220201 | 0389 | | F | Update of FQDN data type | 17.4.0 | +| 2022-03 | CT#95e | CP-220201 | 0390 | 1 | F | Update of description fields | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0391 | 1 | F | Correction to notification about PDU session establishment/termination events | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0392 | | F | Clarification to subscription to notification of application detection | 17.4.0 | +| 2022-03 | CT#95e | CP-220195 | 0394 | 1 | F | Correction to enable retrieval of Network Provided Location information in a MESSAGE request | 17.4.0 | +| 2022-03 | CT#95e | CP-220183 | 0395 | 1 | F | Correction to notification of detected TSC user plane node | 17.4.0 | + +| | | | | | | | | +|--|--|--|--|--|--|-------------|--| +| | | | | | | information | | +|--|--|--|--|--|--|-------------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220183 | 0396 | | F | Removal of Editor's notes | 17.4.0 | +| 2022-03 | CT#95e | CP-220195 | 0397 | 1 | B | Correction to enable retrieval of Network Provided Location information at mid-call access change | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0398 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221159 | 0402 | 1 | F | Wording correction for consistency | 17.5.0 | +| 2022-06 | CT#96 | CP-221144 | 0404 | 2 | F | Resolve the issue related to individual QoS parameters | 17.5.0 | +| 2022-06 | CT#96 | CP-221144 | 0405 | 1 | B | DNN and S-NSSAI notification | 17.5.0 | +| 2022-06 | CT#96 | CP-221157 | 0407 | 3 | F | Correction to the charging identifier to enable uniqueness in roaming scenarios | 17.5.0 | +| 2022-06 | CT#96 | CP-221119 | 0410 | 1 | A | Correction to Npcf_PolicyAuthorization_Subscribe service operation | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0412 | 1 | F | Update to include a missing NOTE | 17.5.0 | +| 2022-06 | CT#96 | CP-221154 | 0413 | | F | Alignment with the SBI template | 17.5.0 | +| 2022-06 | CT#96 | CP-221158 | 0416 | 1 | F | Correction to traffic routing requirements | 17.5.0 | +| 2022-06 | CT#96 | CP-221144 | 0417 | | F | Discovery of TSCTSF notification URI | 17.5.0 | +| 2022-06 | CT#96 | CP-221161 | 0419 | 2 | A | Correction on TscainputContainer definition | 17.5.0 | +| 2022-06 | CT#96 | CP-221151 | 0420 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222125 | 0421 | | F | Untrusted WLAN location information | 17.6.0 | +| 2022-09 | CT#97e | CP-222093 | 0424 | | A | Correction to notification about application session context termination | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0425 | 1 | F | Correction to notification about PDU session established/terminated events | 17.6.0 | +| 2022-09 | CT#97e | CP-222113 | 0426 | | F | Correction to the notification URI | 17.6.0 | +| 2022-09 | CT#97e | CP-222099 | 0427 | 1 | F | User plane latency requirement support | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0428 | 1 | F | Clarification of ToS traffic class | 17.6.0 | +| 2022-09 | CT#97e | CP-222113 | 0429 | | F | Correction to time synchronization procedures during the creation of the AF session | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0430 | | F | Correction to QoS monitoring | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0432 | | F | Correction to the subscription to Access Type change | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0435 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223164 | 0443 | | A | Correction to the attribute name of media subcomponent | 17.7.0 | +| 2022-12 | CT#98e | CP-223191 | 0436 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0437 | | F | useless AF transaction identifier | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0438 | 1 | F | Enumeration definitions in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0439 | | F | Clarification on usage of N30 and N5 reference points | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0440 | 1 | F | Error handling when UE is temporarily unavailable | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0444 | | F | Correction to the terminology of UMIC | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0445 | 1 | F | Correction to functionality of PCF | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0446 | | F | AF events apply per AF session | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0447 | 1 | B | Indication of Alternative Service Requirements not supported by NG-RAN | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0448 | 1 | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0449 | | F | Correction to DNN presence condition in PscfRestorationRequestData | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0450 | 1 | F | Correction to QoS monitoring | 18.0.0 | +| 2022-12 | CT#98e | CP-223178 | 0451 | 1 | B | SNPN mobility | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0452 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230176 | 0453 | 1 | F | Clarification about the applicability of ipDomain and sliceInfo | 18.1.0 | +| 2023-03 | CT#99 | CP-230180 | 0454 | 1 | B | Adding PER to Policy Authorization inputs | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0455 | 1 | B | PER for Alternative QoS | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0456 | 1 | F | 5GC AF signalling note | 18.1.0 | +| 2023-03 | CT#99 | CP-230274 | 0457 | 2 | B | OAuth2 scopes in Npcf_PolicyAuthorization API | 18.1.0 | +| 2023-03 | CT#99 | CP-230128 | 0461 | | A | Corrections to QoS monitoring | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0466 | 1 | B | Support for AF traffic influence for common EAS, DNAI selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230267 | 0468 | 2 | A | Correction on setting Packet Delay Failure report Threshold | 18.1.0 | +| 2023-03 | CT#99 | CP-230266 | 0469 | 2 | B | Service Function Chaining support in N5 interface | 18.1.0 | +| 2023-03 | CT#99 | CP-230268 | 0470 | 1 | F | Generalization of QoS monitoring control description | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0471 | | F | Support of EAS Rediscovery during the update procedure | 18.1.0 | +| 2023-03 | CT#99 | CP-230174 | 0472 | | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230182 | 0473 | 1 | B | Npcf_PolicyAuthorization service update for Multi-Modal service XR and Media Services | 18.1.0 | +| 2023-03 | CT#99 | CP-230130 | 0474 | 3 | B | Update Satellite Backhaul Category | 18.1.0 | +| 2023-03 | CT#99 | CP-230136 | 0475 | 1 | B | Support of integration with IETF Deterministic Networking | 18.1.0 | +| 2023-03 | CT#99 | CP-230136 | 0476 | 2 | B | Subscription to the report of extra UE addresses | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0477 | | B | PCF rejection of an AF request routed via an incorrect signaling path | 18.1.0 | +| 2023-03 | CT#99 | CP-230176 | 0478 | 1 | F | Correction to Alternative QoS support | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0479 | | F | Corrections to enumeration values not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0480 | | F | Clarifications to TSC | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0481 | | F | Missing error codes for subscription response | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0482 | | F | Complete Application Errors descriptions | 18.1.0 | +| 2023-03 | CT#99 | CP-230179 | 0483 | 1 | B | Support of BAT window and capability for BAT adaptation | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230179 | 0484 | 1 | B | Support of periodicity range | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0485 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231130 | 0487 | 2 | B | Clarification of flow filter information in a media component | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0488 | 1 | B | Npcf_PolicyAuthorization enhancements to support multi-modal services | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0489 | 1 | F | MPS Action update in OpenAPI file | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0490 | | F | Flow Number for MPS for DTS AF signalling flow | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0491 | 1 | B | Clarifications to the Report of Extra UE addresses | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 0497 | 1 | B | Correction to AF influence on Service Function Chaining | 18.2.0 | +| 2023-06 | CT#100 | CP-231160 | 0498 | 1 | B | Handling of RAN/NAS release cause values | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0499 | 1 | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0501 | 3 | F | Support of BAT offset and adjusted periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0502 | 1 | F | Removal of the Editor's note about BAT window and PeriodicityRange | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0503 | 1 | B | Support of the direct event notification of TSC management information | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0505 | 3 | B | Support of Uplink Downlink transmission coordination to meet RT latency requirement | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0506 | 1 | B | Npcf_PolicyAuthorization service update for support of multi-modal services | 18.2.0 | +| 2023-06 | CT#100 | CP-231335 | 0507 | 3 | B | Update Npcf_PolicyAuthorization service for support of new QoS monitoring parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0508 | 1 | B | Update Npcf_PolicyAuthorization service for support of PDU Set handling | 18.2.0 | +| 2023-06 | CT#100 | CP-231154 | 0513 | 1 | A | Wrong attribute name for the indication of direct notification | 18.2.0 | +| 2023-06 | CT#100 | CP-231130 | 0514 | 1 | B | Protocol description parameter support in Npcf_PolicyAuthorization Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231147 | 0517 | | A | Removal of unspecified QoS monitoring control options | 18.2.0 | +| 2023-06 | CT#100 | CP-231343 | 0518 | 3 | B | Support for URSP awareness | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0519 | 1 | B | Support of Packet Delay Variation monitoring and reporting | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0520 | 1 | B | Support of periodicity measurement and reporting for power saving | 18.2.0 | +| 2023-06 | CT#100 | CP-231143 | 0523 | 1 | B | Support of provisioning periodicity set | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0524 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231151 | 0525 | 1 | B | Support of DetNet flow identification | 18.2.0 | +| 2023-06 | CT#100 | CP-231129 | 0528 | 1 | B | Policy Control for L4S | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0531 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232159 | 0532 | 1 | B | Policy Authorization QoS Timing info addition | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0533 | 1 | F | Editor note removal for Multimodal id | 18.3.0 | +| 2023-09 | CT#101 | CP-232102 | 0534 | 1 | D | Correction on SFC terminology | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0535 | 1 | F | Incorrect description of FlowDescription | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0536 | 1 | B | PDU Set Integrated Handling Information Update | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0537 | 1 | B | Completing URSP rule enforcement | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0539 | 1 | B | C3-233693 | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0540 | 1 | B | Support of the congestion information measurement and reporting | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0541 | 1 | B | Support of the Packet Delay Variation monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0543 | 1 | B | Update for the direct event notification | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0544 | 1 | B | Support of the End of Data Burst Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232158 | 0545 | 1 | B | Support of the RTT monitoring over two QoS flows | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0546 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232186 | 0547 | | B | Common EAS/DNAI determination for a set of UEs | 18.3.0 | +| 2023-12 | CT#102 | CP-233234 | 0548 | 1 | B | Introduction of new features for PDU set handle and RT latency | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0551 | 1 | B | Support of subscription to flow level events | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0552 | 1 | F | Support of the new feature name EnQoSMon | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0554 | 2 | F | Removal of the Editor's note about direct TSC event notification information | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0555 | | B | Update Data Rate monitoring | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0556 | 1 | F | PdvMonitoringReport Clarification | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0558 | 1 | B | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0559 | 1 | B | Feature granularity and definition for MultiModal & PowerSaving | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0560 | 3 | B | Event notification for AF requested QoS for a UE or group of UEs not identified by a UE address | 18.4.0 | +| 2023-12 | CT#102 | CP-233233 | 0562 | | B | Definition of L4S feature | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 0566 | 1 | F | Adding reference and correcting the terms to align with stage-2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 0567 | 1 | F | Corrections related to EnSatBackhaulCatChg feature | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0569 | | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233249 | 0573 | | B | Completion of direct event notification of TSC management information support | 18.4.0 | +| 2023-12 | CT#102 | CP-233265 | 0574 | 1 | A | Wrong attribute name for Access Network Gateway Address | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0575 | 1 | B | Update for the PDU Set QoS related data | 18.4.0 | +| 2023-12 | CT#102 | CP-233234 | 0576 | 1 | F | Update for the Periodicity information and the terminology | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0579 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29515/raw.md b/gsma/29_series/29515/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..49aec3148314448081562ae60f6d382154a342c9 --- /dev/null +++ b/gsma/29_series/29515/raw.md @@ -0,0 +1,2784 @@ + + +# 3GPP TS 29.515 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Gateway Mobile Location Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 5 Services offered by the GMLC ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Ngmlc_Location Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 ProvideLocation..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Provide Location of a single UE ..... | 9 | +| 5.2.2.2.3 Provide Locations of a group of UEs ..... | 10 | +| 5.2.2.3 LocationUpdate..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 5.2.2.4 CancelLocation ..... | 12 | +| 5.2.2.4.1 General ..... | 12 | +| 5.2.2.5 EventNotify..... | 12 | +| 5.2.2.5.1 General ..... | 12 | +| 5.2.2.5.2 EventNotify for a single UE..... | 13 | +| 5.2.2.5.3 EventNotify for the UEs in a target group ..... | 14 | +| 5.2.2.6 LocationUpdateNotify ..... | 14 | +| 5.2.2.6.1 General ..... | 14 | +| 5.2.2.7 LocationUpdateSubscribe..... | 15 | +| 5.2.2.7.1 General ..... | 15 | +| 6 API Definitions ..... | 16 | +| 6.1 Ngmlc_Location Service API ..... | 16 | +| 6.1.1 Introduction ..... | 16 | +| 6.1.2 Usage of HTTP..... | 16 | +| 6.1.2.1 General..... | 16 | +| 6.1.2.2 HTTP standard headers..... | 16 | +| 6.1.2.2.1 General ..... | 16 | +| 6.1.2.2.2 Content type ..... | 16 | +| 6.1.2.3 HTTP custom headers..... | 16 | +| 6.1.2.3.1 General ..... | 16 | +| 6.1.3 Custom Operations without associated resources ..... | 17 | +| 6.1.3.1 Overview..... | 17 | +| 6.1.3.2 Operation: provide-location ..... | 17 | +| 6.1.3.2.1 Description ..... | 17 | +| 6.1.3.2.2 Operation Definition ..... | 18 | +| 6.1.3.3 Operation: cancel-location..... | 19 | +| 6.1.3.3.1 Description ..... | 19 | +| 6.1.3.3.2 Operation Definition ..... | 19 | +| 6.1.3.4 Operation: location-update ..... | 20 | +| 6.1.3.4.1 Description ..... | 20 | +| 6.1.3.4.2 Operation Definition ..... | 20 | +| 6.1.3.5 Operation: loc-update-subs ..... | 21 | +| 6.1.3.5.1 Description ..... | 21 | +| 6.1.3.5.2 Operation Definition ..... | 21 | + +| | | | +|-------------------------------|-------------------------------------------|-----------| +| 6.1.4 | Notifications ..... | 22 | +| 6.1.4.1 | General..... | 22 | +| 6.1.4.2 | Eventnotify..... | 22 | +| 6.1.4.2.1 | Description ..... | 22 | +| 6.1.4.2.2 | Notification Definiton ..... | 22 | +| 6.1.4.2.3 | Notification Standard Methods ..... | 22 | +| 6.1.4.2.3.1 | POST ..... | 22 | +| 6.1.4.3 | LocationUpdateNotify ..... | 23 | +| 6.1.4.3.1 | Description ..... | 23 | +| 6.1.4.3.2 | Notification Definiton ..... | 23 | +| 6.1.4.3.3 | Notification Standard Methods ..... | 24 | +| 6.1.4.3.3.1 | POST ..... | 24 | +| 6.1.5 | Data Model ..... | 24 | +| 6.1.5.1 | General..... | 24 | +| 6.1.5.2 | Structured data types..... | 27 | +| 6.1.5.2.1 | Introduction ..... | 27 | +| 6.1.5.2.2 | Type: InputData..... | 28 | +| 6.1.5.2.3 | Type: LocationData..... | 32 | +| 6.1.5.2.4 | Type: CancelLocData..... | 35 | +| 6.1.5.2.5 | Type: LocUpdateData ..... | 36 | +| 6.1.5.2.6 | Type: EventNotifyData ..... | 37 | +| 6.1.5.2.7 | Type: UePrivacyRequirements ..... | 39 | +| 6.1.5.2.8 | Void..... | 40 | +| 6.1.5.2.9 | Type: LocUpdateNotification ..... | 40 | +| 6.1.5.2.10 | Type: LocUpdateSubs..... | 40 | +| 6.1.5.2.11 | Type: EventNotifyDataAdditionalInfo ..... | 41 | +| 6.1.5.2.12 | Type: EventNotifyDataExt..... | 41 | +| 6.1.5.2.13 | Type: AreaEventInfoAddition..... | 41 | +| 6.1.5.2.14 | Type: AreaEventInfoExt ..... | 41 | +| 6.1.5.2.15 | Type: IntegrityRequirements..... | 42 | +| 6.1.5.2.16 | Type: AlertLimit ..... | 42 | +| 6.1.5.2.17 | Type: UpLocRepInfoAf ..... | 42 | +| 6.1.5.2.18 | Type: UpCumEvtRptCriteria ..... | 42 | +| 6.1.5.2.19 | Type: AddLocationDatas ..... | 43 | +| 6.1.5.2.20 | Type: LocationDataExt ..... | 43 | +| 6.1.5.3 | Simple data types and enumerations..... | 43 | +| 6.1.5.3.1 | Introduction ..... | 43 | +| 6.1.5.3.2 | Simple data types ..... | 43 | +| 6.1.5.3.3 | Enumeration: PseudonymIndicator ..... | 43 | +| 6.1.5.3.4 | Enumeration: LocationRequestType..... | 44 | +| 6.1.5.3.5 | Enumeration: LocationTypeRequested ..... | 44 | +| 6.1.5.3.6 | Enumeration: EventNotifyDataType..... | 44 | +| 6.1.5.3.7 | Enumeration: FailureCause ..... | 45 | +| 6.1.5.3.8 | Enumeration: SuccessType ..... | 45 | +| 6.1.5.3.9 | Enumeration: ReportingInd ..... | 45 | +| 6.1.6 | Error Handling ..... | 45 | +| 6.1.6.1 | General..... | 45 | +| 6.1.6.2 | Protocol Errors ..... | 45 | +| 6.1.6.3 | Application Errors..... | 45 | +| 6.1.7 | Feature negotiation ..... | 46 | +| 6.1.8 | Security..... | 46 | +| 6.1.9 | HTTP redirection..... | 47 | +| Annex A (normative): | OpenAPI specification ..... | 48 | +| A.1 | General..... | 48 | +| A.2 | Ngmlc_Location API..... | 48 | +| Annex B (informative): | Change history..... | 61 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Ngmlc Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the GMLCc. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.273: "5G System Location Services (LCS)". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [12] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [13] ITU Recommendation E.164: "The international public telecommunication numbering plan". +- [14] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". + +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [17] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [18] 3GPP TS 22.071: "Location Services (LCS); Service description; Stage 1". +- [19] 3GPP TR 21.900: "Technical Specification Group working methods". +- [20] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [21] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [22] 3GPP TS 33.256: "Security aspects of Uncrewed Aerial Systems (UAS)". +- [23] 3GPP TS 37.355: "Technical Specification Group Radio Access Network; LTE Positioning Protocol (LPP)". +- [24] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +Void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------------| +| 5GC | 5G Core Network | +| AMF | Access and Mobility Management Function | +| GAD | Geographical Area Description | +| GMLC | Gateway Mobile Location Centre | +| GPSI | Generic Public Subscription Identifier | +| LCS | Location Services | +| LDR | Location Deferred Request | +| LPHAP | Low Power and High Accuracy Positioning | +| MO-LR | Mobile Originated Location Request | +| MT-LR | Mobile Terminated Location Request | +| NEF | Network Exposure Function | +| NI-LR | Network Induced Location Request | +| NRF | Network Repository Function | +| SUPI | Subscription Permanent Identifier | + +# --- 4 Overview + +The Gateway Mobile Location Centre (GMLC) is the network entity in the 5G Core Network (5GC) supporting Location Services (LCS). Within the 5GC, the GMLC offers services to the AMF, GMLC, NEF, NWDAF and LMF via the Ngmlc service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.273 [4]). + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the GMLC: + +![Figure 4-1: Reference model – GMLC. A diagram showing five network functions (AMF, NEF, GMLC, NWDAF, LMF) on the left connected to a central GMLC block on the right. The connections are labeled with interface names: NL2 (AMF to GMLC), NL5 (NEF to GMLC), NL3 (GMLC to GMLC), NL9 (NWDAF to GMLC), and NL10 (LMF to GMLC). The central GMLC block is connected to the other functions via a common interface labeled Ngmlc.](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 4-1: Reference model – GMLC. A diagram showing five network functions (AMF, NEF, GMLC, NWDAF, LMF) on the left connected to a central GMLC block on the right. The connections are labeled with interface names: NL2 (AMF to GMLC), NL5 (NEF to GMLC), NL3 (GMLC to GMLC), NL9 (NWDAF to GMLC), and NL10 (LMF to GMLC). The central GMLC block is connected to the other functions via a common interface labeled Ngmlc. + +Figure 4-1: Reference model – GMLC + +The functionalities supported by the GMLC are listed in clause 4.3.3 of 3GPP TS 23.273 [4]. + +# 5 Services offered by the GMLC + +## 5.1 Introduction + +The table 5.1-1 shows the GMLC Services and GMLC Service Operations: + +Table 5.1-1: List of GMLC Services + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | +|----------------|----------------------|---------------------|------------------------------| +| Ngmlc_Location | ProvideLocation | Request/Response | H-GMLC, NEF, NWDAF, LMF, AMF | +| | LocationUpdate | Request/Response | AMF, V-GMLC | +| | LocationUpdateNotify | Notify | NEF | +| | CancelLocation | Request/Response | H-GMLC, NEF, NWDAF | +| | EventNotify | Notify | H-GMLC, NEF, NWDAF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +Table 5.1-2: API Descriptions + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------|--------|------------------------|-----------------------------|-----------|-------| +| Ngmlc_Location | 6.1 | Ngmlc Location Service | TS29515_Ngmlc_Location.yaml | ngmlc-loc | A.2 | + +## 5.2 Ngmlc\_Location Service + +### 5.2.1 Service Description + +The Ngmlc\_Location service enables an NF to request location determination (current geodetic and optionally local and/or civic location) for a target UE. The following are the key functionalities of this NF service. + +- Allow the consumer NF to request the current geodetic and optionally local and/or civic location of a target UE. +- Allow the consumer NF to subscribe/unsubscribe the geodetic and optionally local and/or civic location of a target UE for some certain events. +- Allow the consumer NF to cancel an on-going periodic or triggered location request of a target UE. +- Allow the consumer NF to get notified about the geodetic and optionally local and/or civic location of a target UE when some certain events are detected. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Ngmlc\_Location services are as follows: + +- ProvideLocation +- LocationUpdate +- CancelLocation +- EventNotify +- LocationUpdateNotify +- LocationUpdateSubscribe + +#### 5.2.2.2 ProvideLocation + +##### 5.2.2.2.1 General + +The following procedures are supported using the "ProvideLocation" service operation: + +- Provide location of a single UE +- Provide locations of a group of UEs + +##### 5.2.2.2.2 Provide Location of a single UE + +The service operation is used during the procedures: + +- 5GC-MT-LR Procedure for the commercial location service (see 3GPP TS 23.273 [4], clause 6.1.2 and 6.1.4) +- Initiation and Reporting of Location Events (see 3GPP TS 23.273 [4], clause 6.3.1, clause 6.16.1) +- Unified Location Service Exposure Procedure without routing by a UDM (see 3GPP TS 23.273 [4], clause 6.5.1) +- Procedures with interaction between 5GC and EPC (see 3GPP TS 23.273 [4], clause 6.13) + +The ProvideLocation service operation is invoked by a NF Service Consumer, e.g. a NEF, GMLC NWDAF or LMF, towards the GMLC to request to provide the location information (geodetic location and, optionally local and/or civic location) for a target UE or to subscribe to periodic or triggered deferred location for a target UE. See Figure 5.2.2.2.2-1. + +![Sequence diagram showing the ProvideLocation Request/Response for a target UE. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 200 OK (LocationDataExt) or a 4xx/5xx (ProblemDetails) or 3xx response.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant GMLC + Note left of NF Service Consumer: + NF Service Consumer->>GMLC: 1. POST .../provide-location (InputData) + Note right of GMLC: + GMLC-->>NF Service Consumer: 2a. 200 OK (LocationDataExt) + GMLC-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the ProvideLocation Request/Response for a target UE. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 200 OK (LocationDataExt) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.2.2.2.2-1: ProvideLocation Request/Response for a target UE** + +1. The NF Service Consumer shall send an HTTP POST request to the URI associated with the "provide-location" custom operation. The input parameters for the request (the target UE identification (SUPI or GPSI), required QoS, supported GAD shapes, LCS client type, external Service Identity, Codeword, service coverage, LDR type, serving AMF address, LDR reference, scheduled location time, LMF ID, LpHapType, Event Report Expected Area, reporting indication, integrity requirements, LOS/NLOS measurement indication, ...) may be included in the HTTP POST request body, H-GMLC Callback URI may be included in the HTTP POST request body to V-GMLC (eventually to AMF) for implicit subscription of EventNotify provided by GMLC, and NEF or NWDAF Callback URI may be included in the HTTP POST request body to GMLC/H-GMLC for implicit subscription of EventNotify provided by GMLC/H-GMLC. + +If the request is to use a location reporting via user plane, an indication of the request of location reporting via user plane shall be included in the HTTP POST contents. If the indication of the request of location reporting via user plane is included in the HTTP POST contents, the endpoint address of the user plane for location reporting may be included in the HTTP POST contents. The criteria for sending cumulative event reports over control plane may be included in the contents when the request is sent from H-GMLC to V-GMLC. + +**Editor's Note:** [CR0116, 5G\_eLCS\_Ph3] Whether the security related materials can be included in the contents is FFS. + +If Multiple Location QoS was requested, the H-GMLC as NF service consumer may perform the Location QoS mapping to obtain the location QoS that can be applicable to EPS based on the original multiple QoS (see clause 6.19 of 3GPP TS 23.273 [4]) and may include the mapped Location QoS applicable to EPS in the request to the V-GMLC as NF service producer. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the determined position of the UE if any (geodetic position, local position, civic location, positioning methods...). + +If geographic area(s) are received in the request for area event, the GMLC (or V-GMLC when roaming) shall convert the received geographic area(s) into a corresponding list of cell and/or tracking area identities when invoking AMF location services. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.2-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.2-2. + +##### 5.2.2.2.3 Provide Locations of a group of UEs + +The service operation is used during the procedures: + +- Bulk Operation of LCS Service Request Targeting to Multiple UEs (see 3GPP TS 23.273 [4], clause 6.8) + +The ProvideLocation service operation is invoked by a NF Service Consumer, e.g. a NEF or NWDAF, towards the GMLC (e.g. (H)GMLC when roaming) to request to provide the location information (geodetic location and, optionally local and/or civic location) for a target group of UEs or to subscribe to periodic or triggered deferred location for a target group of UEs. See Figure 5.2.2.2.3-1. + +![Sequence diagram showing the ProvideLocation Request/Response for a target group. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 200 OK (LocationDataExt) or a 4xx (ProblemDetails) or 3xx status code.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant GMLC + Note left of NF Service Consumer: + NF Service Consumer->>GMLC: 1. POST .../provide-location (InputData) + Note right of GMLC: + GMLC-->>NF Service Consumer: 2a. 200 OK (LocationDataExt) + GMLC-->>NF Service Consumer: 2b. 4xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the ProvideLocation Request/Response for a target group. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 200 OK (LocationDataExt) or a 4xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.2.3-1: ProvideLocation Request/Response for a target group** + +1. The NF Service Consumer shall send an HTTP POST request to the URI associated with the "provide-location" custom operation. The input parameters the target group identification (the External Group ID or the Internal Group ID), LCS client type, eventNotificationUri shall be included in the HTTP POST request body, LDR type, LDR reference shall be also included in the request if requesting the deferred LCS service, the required QoS, supported GAD shapes, external Service Identity, service coverage should be included in the request. If the request is related to location determination at the scheduled time, the scheduled location time shall be included in the HTTP POST request body. + +If the request is to use a location reporting via user plane, an indication of the request of location reporting via user plane shall be included in the HTTP POST contents. If the indication of the request of location reporting via user plane is included in the HTTP POST contents, the endpoint address of the user plane for location reporting may be included in the HTTP POST contents. The criteria for sending cumulative event reports over control plane may be included in the contents when the request is sent from H-GMLC to V-GMLC. + +**Editor's Note: [CR0116, 5G\_eLCS\_Ph3] Whether the security related materials can be included in the contents is FFS.** + +GMLC shall translate the target group identification into the list of the UE identifications which belong to the target group by invoking the related service provided by UDM, then for each UE in the list, GMLC initiates following steps of procedures of the 5GC-MT-LR or Deferred 5GC-MT-LR as defined in 3GPP TS 23.273 [4] clause 6.8. + +If geographic area(s) are received in the request for area event, the GMLC (or V-GMLC when roaming) shall convert the received geographic area(s) into a corresponding list of cell and/or tracking area identities when invoking AMF location services. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain the success type. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.2-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.2.2-2. + +#### 5.2.2.3 LocationUpdate + +##### 5.2.2.3.1 General + +The service operation is used during the procedure: + +- 5GC-MO-LR Procedure (see 3GPP TS 23.273 [4], clause 6.2) + +The LocationUpdate enables the NF consumer (e.g. AMF) to update UE location information towards the GMLC. See Figure 5.2.2.3.1-1. + +![Sequence diagram for Figure 5.2.2.3.1-1: LocationUpdate Request/Response. The diagram shows two lifelines: NF Service Consumer and GMLC. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 204 No Content (success) or a 4xx status code with ProblemDetails (failure or redirection).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant GMLC + Note left of NF Service Consumer: 1. POST .../location-update (LocUpdateData) + NF Service Consumer->>GMLC: 1. POST .../location-update (LocUpdateData) + Note right of GMLC: 2a. 204 No Content + GMLC-->>NF Service Consumer: 2a. 204 No Content + Note right of GMLC: 2b. 4xx (ProblemDetails) + GMLC-->>NF Service Consumer: 2b. 4xx (ProblemDetails) +``` + +Sequence diagram for Figure 5.2.2.3.1-1: LocationUpdate Request/Response. The diagram shows two lifelines: NF Service Consumer and GMLC. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 204 No Content (success) or a 4xx status code with ProblemDetails (failure or redirection). + +**Figure 5.2.2.3.1-1: LocationUpdate Request/Response** + +1. The NF Service Consumer shall send an HTTP POST request to the URI associated with the "location-update" custom operation. The request body shall contain a LocUpdateData object.. +- 2a. On success, "204 No content" shall be returned by the GMLC. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.2-2 may be returned. For a 4xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.4.2-2. + +#### 5.2.2.4 CancelLocation + +##### 5.2.2.4.1 General + +The service operation is used during the procedure: + +- Cancellation of Reporting of Location Events by an AF, an NF or External LCS Client or GMLC (see 3GPP TS 23.273 [4], clause 6.3.3) + +The CancelLocation enables the consumer NF to use the service operation to cancel a deferred 5GC-MT-LR procedure for periodic or triggered location for a single UE or for a group. See Figure 5.2.2.4.1-1. + +![Sequence diagram for Figure 5.2.2.4.1-1: CancelLocation Request/Response. The diagram shows two lifelines: NF Service Consumer and GMLC. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 204 No Content (success) or a 4xx status code with ProblemDetails or a 3xx status code (failure or redirection).](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant GMLC + Note left of NF Service Consumer: 1. POST .../cancel-location (CancelLocData) + NF Service Consumer->>GMLC: 1. POST .../cancel-location (CancelLocData) + Note right of GMLC: 2a. 204 No Content + GMLC-->>NF Service Consumer: 2a. 204 No Content + Note right of GMLC: 2b. 4xx(ProblemDetails) or 3xx + GMLC-->>NF Service Consumer: 2b. 4xx(ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.4.1-1: CancelLocation Request/Response. The diagram shows two lifelines: NF Service Consumer and GMLC. The NF Service Consumer sends a POST request to the GMLC. The GMLC responds with either a 204 No Content (success) or a 4xx status code with ProblemDetails or a 3xx status code (failure or redirection). + +**Figure 5.2.2.4.1-1: CancelLocation Request/Response** + +1. The NF Service Consumer shall send an HTTP POST request to the URI associated with the "cancel-location" custom operation. The input parameters for the request ((H-)GMLC contact address, LDR reference number, LMF identification, serving AMF address) should be included in the HTTP POST request body. +- 2a. On success, "204 No Content" shall be returned. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.2-2 may be returned. For a 4xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.2-2. + +#### 5.2.2.5 EventNotify + +##### 5.2.2.5.1 General + +The following procedures are supported using the "EventNotify" service operation: + +- EventNotify for a single UE + +- EventNotify for the UEs in a target group + +##### 5.2.2.5.2 EventNotify for a single UE + +The service operation is used during the procedure: + +- Deferred 5GC-MT-LR Procedure for Periodic, Triggered and UE Available Location Events (see 3GPP TS 23.273 [4], clause 6.3) +- Unified Location Service Exposure Procedure without routing by a UDM (see 3GPP TS 23.273 [4], clause 6.5.1) + +The EventNotify for a single UE enables the consumer NF (e.g. (H)GMLC, NEF, NWDAF) to get notified about the geodetic and optionally local and/or civic location, the completion or activation of deferred location, mobility to a different AMF/MME of a UE with deferred location for a target UE, the active state of the location reporting over user plane, or the statistics on the location reporting over user plane, when some certain events are detected. See Figure 5.2.2.5.2-1. + +![Sequence diagram showing the interaction between GMLC and NF Service Consumer for EventNotify Notification for a single UE. The GMLC sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx ProblemDetails or 3xx response.](4636adff5682a064f0ae5f13a1d464a6_img.jpg) + +``` + +sequenceDiagram + participant GMLC + participant NF as NF Service Consumer + Note left of GMLC: GMLC + Note right of NF: NF Service Consumer + GMLC->>NF: 1. POST {locationNotificationUri} (EventNotifyDataExt) + NF-->>GMLC: 2a. 204 No Content + NF-->>GMLC: 2b.4xx ProblemDetails or 3xx + +``` + +Sequence diagram showing the interaction between GMLC and NF Service Consumer for EventNotify Notification for a single UE. The GMLC sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 204 No Content or a 4xx ProblemDetails or 3xx response. + +**Figure 5.2.2.5.2-1: EventNotify Notification for a single UE** + +1. The GMLC shall send an HTTP POST to the locationNotificationUri to send a notification. The input parameters for the notification (Notification Correlation ID, UE (SUPI and if available GPSI), Type of location related event (e.g. deferred location for the UE available event, activation of location for periodic or triggered location, mobility of a target UE to a new AMF or MME for a deferred location, Geodetic Location, Local Location, Civic Location, Position Methods Used, serving LMF identification etc.) should be included in the HTTP POST request body. + +If the GMLC receives the statistics on the location reporting over user plane (e.g., the number of location reports over user plane) from the AMF, the statistics on the location reporting over user plane shall be included in the HTTP POST contents. + +The locationNotificationUri shall be set to: + +If the notification is sent from (V)GMLC to (H)GMLC when roaming with (V)GMLC used, + +- the hGMLCCallBackURI received from the AMF/LMF; + +If the notification is sent from (H)GMLC to NEF, or other NF (e.g. NWDAF), + +- the callback URI (i.e., eventNotificationUri) of NEF or other NF (e.g. NWDAF) provided by NEF or other NF (e.g. NWDAF) during requesting the ProvideLocation service operation for the periodic or triggered deferred location for a target UE or ; +- the callback URI of NEF locally provisioned in the (H)GMLC. + +- 2a. If the notification is received, the NF Service Consumer shall reply with the status code 204 indicating the notification is received, in the response message. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.2.3.1-2 may be returned. For a 4xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.2.3.1-2. + +##### 5.2.2.5.3 EventNotify for the UEs in a target group + +The service operation is used during the procedure: + +- Bulk Operation of LCS Service Request Targeting to Multiple UEs (see 3GPP TS 23.273 [4], clause 6.8) + +The EventNotify for the UEs in a target group enables the consumer NF (e.g. NEF, NWDAF) to get notified about the geodetic and optionally local and/or civic locations (immediate locations or deferred locations) for the UEs in target group, the failures of requesting location for the UEs in the target group, completion or activation of deferred location for the UEs in the target group. See Figure 5.2.2.5.3-1. + +![Sequence diagram showing the EventNotify notification process between GMLC and NF Service Consumer.](16c1175b5f05a4b55e6d396fc51b15b3_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant NF as NF Service Consumer + Note left of GMLC: GMLC + Note right of NF: NF Service Consumer + GMLC->>NF: 1. POST {locationNotificationUri} (EventNotifyDataExt) + NF-->>GMLC: 2a. 204 No Content + NF-->>GMLC: 2b. 4xx ProblemDetails or 3xx +``` + +The diagram illustrates the interaction between a GMLC and an NF Service Consumer. The GMLC sends a POST request to the NF Service Consumer's locationNotificationUri. The NF Service Consumer responds with either a 204 No Content status code or a 4xx/3xx status code with ProblemDetails or an error message. + +Sequence diagram showing the EventNotify notification process between GMLC and NF Service Consumer. + +**Figure 5.2.2.5.3-1: EventNotify Notification for the UEs in a target group** + +1. The GMLC/(H)GMLC shall send an HTTP POST to the locationNotificationUri to send a notification. The Request body shall contain event report(s) for one or more UEs in the group. The event report for each UE shall include the LDR Reference, UE identifier (SUPI or GPSI), location data (location data for immediate location service request or location data for deferred location service request) or failure cause of positioning. The locationNotificationUri shall be set to: + - the callback URI of NEF, or other NF (e.g. NWDAF) provided by NEF during requesting the ProvideLocation service operation for a target group of UEs or; + - the callback URI of NEF locally provisioned in the GMLC/(H)GMLC. +- 2a. If the notification is received, the NF Service Consumer shall reply with the status code 204 indicating the notification is received, in the response message. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.2.3.1-2 may be returned. For a 4xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.2.3.1-2. + +#### 5.2.2.6 LocationUpdateNotify + +##### 5.2.2.6.1 General + +The service operation is used during the procedure: + +- 5GC-MO-LR Procedure (see 3GPP TS 23.273 [4], clause 6.2) + +The LocationUpdateNotify enables the NF consumer (e.g. NEF) to get notified about the UE location information update. See Figure 5.2.2.6.1-1. + +![Sequence diagram for Figure 5.2.2.6.1-1: LocationUpdateNotify Notification. The diagram shows two lifelines: GMLC and NF Service Consumer. Step 1: GMLC sends a POST {notifURI} (LocUpdateNotification) request to the NF Service Consumer. Step 2a: The NF Service Consumer responds with 204 No Content. Step 2b: Alternatively, it could respond with 4xx (ProblemDetails) or 3xx.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant GMLC + participant NF Service Consumer + Note left of GMLC: 1. POST {notifURI} (LocUpdateNotification) + GMLC->>NF Service Consumer: 1. POST {notifURI} (LocUpdateNotification) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>GMLC: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx (ProblemDetails) or 3xx + NF Service Consumer-->>GMLC: 2b. 4xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.6.1-1: LocationUpdateNotify Notification. The diagram shows two lifelines: GMLC and NF Service Consumer. Step 1: GMLC sends a POST {notifURI} (LocUpdateNotification) request to the NF Service Consumer. Step 2a: The NF Service Consumer responds with 204 No Content. Step 2b: Alternatively, it could respond with 4xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.6.1-1: LocationUpdateNotify Notification** + +1. The GMLC shall send an HTTP POST request to the notifURI of the NF consumer (e.g. NEF). The response body shall contain a LocUpdateNotification object. + +The notifURI (e.g. NEF address for callback) is locally configured on GMLC or discovered via NRF. + +- 2a. On success, "204 No content" shall be returned by the NF consumer. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.3.3.1-2 may be returned. For a 4xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.3.3.1-2. + +#### 5.2.2.7 LocationUpdateSubscribe + +##### 5.2.2.7.1 General + +This service operation is used by a NF Service Consumer (e.g. NEF) to trigger a subscription to notifications on UE location information update for the 5GC-MO-LR Procedure (see 3GPP TS 23.273 [4], clause 6.2). See Figure 5.2.2.7.1-1. + +NOTE: This service operation is not used by the current stage 2 specifications in 3GPP TS 23.273 [4], i.e. the subscription to notifications on UE location information update is implicit. + +![Sequence diagram for Figure 5.2.2.7.1-1: Subscription to UE location information update. The diagram shows two lifelines: NF service consumer and GMLC. Step 1: NF service consumer sends a POST.../loc-update-subs (LocUpdateSubs) request to the GMLC. Step 2a: The GMLC responds with 204 No Content. Step 2b: Alternatively, it could respond with 4xx / 5xx (ProblemDetails) or 3xx.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant GMLC + Note left of NF service consumer: 1. POST.../loc-update-subs (LocUpdateSubs) + NF service consumer->>GMLC: 1. POST.../loc-update-subs (LocUpdateSubs) + Note right of GMLC: 2a. 204 No Content + GMLC-->>NF service consumer: 2a. 204 No Content + Note right of GMLC: 2b. 4xx / 5xx (ProblemDetails) or 3xx + GMLC-->>NF service consumer: 2b. 4xx / 5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.7.1-1: Subscription to UE location information update. The diagram shows two lifelines: NF service consumer and GMLC. Step 1: NF service consumer sends a POST.../loc-update-subs (LocUpdateSubs) request to the GMLC. Step 2a: The GMLC responds with 204 No Content. Step 2b: Alternatively, it could respond with 4xx / 5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.7.1-1: Subscription to UE location information update** + +1. The NF service consumer (e.g. NEF) sends a POST request to the parent resource, i.e. collection of subscriptions (.../loc-update-subs), to create a subscription to UE location information update for the 5GC-MO-LR Procedure, as provided in LocUpdateSubs information conveyed in the message body. + +- 2a. On success, "204 No content" shall be returned by the GMLC. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.2-2 may be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.4.2-2. + +# 6 API Definitions + +## 6.1 Ngmlc\_Location Service API + +### 6.1.1 Introduction + +The Ngmlc\_Location service shall use the Ngmlc\_Location API. + +The API URI of the Ngmlc\_Location API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "ngmlc-loc". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +HTTP messages and bodies for the Ngmlc\_Location service shall comply with the OpenAPI [7] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [5]. +- The Problem Details JSON Object (IETF RFC 9457 [10]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [5], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +### 6.1.3 Custom Operations without associated resources + +#### 6.1.3.1 Overview + +The structure of the custom operation URIs of the Ngmlc\_Location service is shown in Figure 6.1.3.1-1. + +![Diagram showing the custom operation URI structure of the Ngmlc_Location API. The base URI is {apiRoot}/ngmlc-loc/. Below it, four custom operations are listed: /provide-location, /cancel-location, /location-update, and /loc-update-subs, each enclosed in a dashed box.](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` + +graph TD + Base["{apiRoot}/ngmlc-loc/"] + Base --- P1["/provide-location"] + Base --- P2["/cancel-location"] + Base --- P3["/location-update"] + Base --- P4["/loc-update-subs"] + style P1 stroke-dasharray: 5 5 + style P2 stroke-dasharray: 5 5 + style P3 stroke-dasharray: 5 5 + style P4 stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure of the Ngmlc\_Location API. The base URI is {apiRoot}/ngmlc-loc/. Below it, four custom operations are listed: /provide-location, /cancel-location, /location-update, and /loc-update-subs, each enclosed in a dashed box. + +**Figure 6.1.3.1-1: Custom operation URI structure of the Ngmlc\_Location API** + +Table 6.1.3.1-1 provides an overview of the custom operations and applicable HTTP methods. + +**Table 6.1.3.1-1: Custom operations** + +| Custom operation URI | Mapped HTTP method | Description | +|---------------------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------| +| {apiRoot}/ngmlc-loc//provide-location | POST | Request or Subscribe the geodetic and optionally local and/or civic location of a target UE or a target group of UEs | +| {apiRoot}/ngmlc-loc//cancel-location | POST | Cancel an on-going periodic or triggered location request of a target UE or a target group of UEs | +| {apiRoot}/ngmlc-loc//location-update | POST | Enable the NF consumer to update UE location information towards the GMLC | +| {apiRoot}/ngmlc-loc//loc-update-subs | POST | Enable a NF service consumer (e.g. NEF) to subscribe to UE location information | + +#### 6.1.3.2 Operation: provide-location + +##### 6.1.3.2.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operations URI. + +##### 6.1.3.2.2 Operation Definition + +The operation shall support the response data structures and response codes specified in tables 6.1.3.2.2-1 and 6.1.3.2.2-2. + +**Table 6.1.3.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------| +| InputData | M | 1 | Input parameters to the "Provide-Location" operation | + +**Table 6.1.3.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationDataExt | M | 1 | 200 OK |

This case represents the successful retrieval of the location of the UE or successful subscription of periodic or triggered location of the UE, or represents completely or partially accept of the requesting locations for a target group.

Upon success, a response body is returned containing the different parameters of the location data if obtained, such as:

  • - Geographic Area
  • - Local Location
  • - Civic Location
  • - Age of Location
  • - Accuracy of Location
  • - Positioning methods
| +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden |

The "cause" attribute may be used to indicate one of the following application errors:

  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - UNSUPPORTED_BY_UE
  • - DETACHED_USER

See table 6.1.6.3-1 for the description of these errors.

| +| ProblemDetails | O | 0..1 | 500 Internal Server Error |

The "cause" attribute may be used to indicate the following application error:

  • - POSITIONING_FAILED

See table 6.1.6.3-1 for the description of these errors.

| +| ProblemDetails | O | 0..1 | 504 Gateway Timeout |

The "cause" attribute may be used to indicate the following application error:

  • - UNREACHABLE_USER
  • - PEER_NOT_RESPONDING

See table 6.1.6.3-1 for the description of this error.

| + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]). + +**Table 6.1.3.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.3 Operation: cancel-location + +##### 6.1.3.3.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.3.3.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.3.3.2-1 and table 6.1.3.3.2-2. + +**Table 6.1.3.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------------| +| CancelLocData | M | 1 | The information is used to cancel deferred 5GC-MT-LR for a single UE or for a group of UE. | + +**Table 6.1.3.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful cancellation of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.6.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]). + +**Table 6.1.3.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.4 Operation: location-update + +##### 6.1.3.4.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.3.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.3.4.2-1 and table 6.1.3.4.2-2. + +**Table 6.1.3.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------------------------------| +| LocUpdateData | M | 1 | Input parameters to the "location-update" operation | + +**Table 6.1.3.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful update of location. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNSPECIFIED
  • - UNREQUESTED_BY_UE
  • - UNKNOWN_EXTERNAL_CLIENT_OR_AF
  • - UNREACHABLE_EXTERNAL_CLIENT_OR_AF
See table 6.1.6.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]). + +**Table 6.1.3.4.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.5 Operation: loc-update-subs + +##### 6.1.3.5.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operations URI. + +##### 6.1.3.5.2 Operation Definition + +The operation shall support the request and response data structures and response codes specified in tables 6.1.3.5.2-1 and 6.1.3.5.2-2. + +**Table 6.1.3.5.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------------------------------------------------| +| LocUpdateSubs | M | 1 | Contains the subscription to UE location update information that is to be created. | + +**Table 6.1.3.5.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents the successful UE location information subscription creation. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- UNREQUESTED_BY_UE

See table 6.1.6.3-1 for the description of these errors. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. | | | | | + +**Table 6.1.3.5.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Notifications + +#### 6.1.4.1 General + +This clause specifies the notifications provided by the Ngmlc\_Location service. + +**Table 6.1.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------|---------------------------|---------------------------------|---------------------------------| +| EventNotify | {locationNotificationUri} | POST | | +| LocationUpdateNotify | {notifURI} | POST | | + +#### 6.1.4.2 Eventnotify + +##### 6.1.4.2.1 Description + +The EventNotify operation is used to the occurrence of periodic or triggered location event for a target UE to a consumer NF (e.g. (H)GMLC, NEF, NWDAF) or used to report the locations (e.g. the immediate locations or deferred locations) for the UEs in a target group to a consumer NF (e.g. NEF, NWDAF). + +##### 6.1.4.2.2 Notification Definition + +Call-back URI: {locationNotificationUri} + +See clause 5.2.2.5 for the description of how the GMLC obtains the Call-back URI of the NF Service Consumer. + +##### 6.1.4.2.3 Notification Standard Methods + +###### 6.1.4.2.3.1 POST + +This method sends a Location event notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.4.2.3.1-1 and table 6.1.4.2.3.1-2. + +**Table 6.1.4.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|--------------------------------------------------| +| EventNotifyDataExt | M | 1 | Input parameters to the "Event Notify" operation | + +**Table 6.1.4.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

See table 6.1.6.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]). + +**Table 6.1.4.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.4.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +#### 6.1.4.3 LocationUpdateNotify + +##### 6.1.4.3.1 Description + +The LocationUpdateNotify operation is used to deliver the location update for a UE to a consumer NF (e.g. NEF). + +##### 6.1.4.3.2 Notification Definition + +Call-back URI: {notifURI} + +##### 6.1.4.3.3 Notification Standard Methods + +###### 6.1.4.3.3.1 POST + +This method sends a Location update notification to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.1.4.3.3.1-1 and table 6.1.4.3.3.1-2. + +**Table 6.1.4.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------| +| LocUpdateNotification | M | 1 | Input parameters to the "LocationUpdateNotification" operation | + +**Table 6.1.4.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents successful notification of the event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
  • - UNSPECIFIED
  • - UNKNOWN_EXTERNAL_CLIENT_OR_AF
  • - UNREACHABLE_EXTERNAL_CLIENT_OR_AF
See table 6.1.6.3-1 for the description of this error. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]). + +**Table 6.1.4.3.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +**Table 6.1.4.3.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification is redirected | + +### 6.1.5 Data Model + +#### 6.1.5.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.5.1-1 specifies the data types defined for the Ngmlc\_Location service based interface protocol. + +**Table 6.1.5.1-1: Ngmlc\_Location specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|---------------| +| InputData | 6.1.5.2.2 | the input parameters in ProvideLocation service operation | | +| LocationData | 6.1.5.2.3 | Location data | | +| CancelLocData | 6.1.5.2.4 | the input parameters in CancelLocation service operation | | +| LocUpdateData | 6.1.5.2.5 | the input parameters in LocationUpdate service operation | | +| EventNotifyData | 6.1.5.2.6 | the input parameters for the target UE in EventNotify Notification service operation | | +| UePrivacyRequirements | 6.1.5.2.7 | UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming case) for the target UE | | +| LocUpdateNotification | 6.1.5.2.9 | Location Update Notification | | +| LocUpdateSubs | 6.1.5.2.10 | UE location information subscription | | +| AreaEventInfoAddition | 6.1.5.2.13 | Additional information for Extended Area event information | | +| AreaEventInfoExt | 6.1.5.2.14 | Extended Area Event Information | | +| IntegrityRequirements | 6.1.5.2.15 | GNSS integrity requirements | | +| AlertLimit | 6.1.5.2.16 | Alert Limit | | +| UpLocRepInfoAf | 6.1.5.2.17 | Information for the location reporting over user plane | | +| UpCumEvtRptCriteria | 6.1.5.2.18 | Criteria for sending cumulative events reports over control plane | | +| AddLocationDatas | 6.1.5.2.19 | Additional location data | | +| LocationDataExt | 6.1.5.2.20 | the response parameters in ProvideLocation service operation including one or more LocationData | | +| ServiceIdentity | 6.1.5.3.2 | service identity | | +| CodeWord | 6.1.5.3.2 | codeword | | +| ExternalClientIdentication | 6.1.5.3.2 | external client identification | | +| E164CountryCodeOfGeographicArea | 6.1.5.3.2 | E.164 country codes for geographic areas | | +| LcsServiceTypeId | 6.1.5.3.2 | LCS Service Type Id | | +| TimeToAlert | 6.1.5.3.2 | Time-to-Alert | | +| TargetIntegrityRisk | 6.1.5.3.2 | Target Integrity Risk | | +| HorizontalProtectionLevel | 6.1.5.3.2 | Horizontal Protection Level | | +| VerticalProtectionLevel | 6.1.5.3.2 | Vertical Protection Level | | +| PseudonymIndicator | 6.1.5.3.3 | It defines if a pseudonym is requested | | +| LocationRequestType | 6.1.5.3.4 | NI-LR, MT-LR or MO-LR | | +| LocationTypeRequested | 6.1.5.3.5 | the location type requested by the LCS client | | +| EventNotifyDataType | 6.1.5.3.6 | the type of event that triggers event notification | | +| EventNotifyDataAdditionalInfo | 6.1.5.2.11 | Additional information to Event Notify Data | | +| EventNotifyDataExt | 6.1.5.2.12 | Extended Event Notify Data for UEs of a target group | | +| FailureCause | 6.1.5.3.7 | Positioning failure cause | | +| SuccessType | 6.1.5.3.8 | Success Type to indicate full or partial success | | +| ReportingInd | 6.1.5.3.9 | Reporting indication on how a target UE sends event reports when the UE is outside the event report allowed area | | + +Table 6.1.5.1-2 specifies data types re-used by the Ngmlc\_Location service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Ngmlc\_Location service based interface. + +Table 6.1.5.1-2: Ngnlc\_Location re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-------------------------------|---------------------|-----------------------------------------------------------------------------------|---------------| +| Gpsi | 3GPP TS 29.571 [11] | | | +| Supi | 3GPP TS 29.571 [11] | | | +| Uri | 3GPP TS 29.571 [11] | | | +| Amfld | 3GPP TS 29.571 [11] | | | +| NflInstanceId | 3GPP TS 29.571 [11] | | | +| ExternalClientType | 3GPP TS 29.572 [12] | | | +| LocationQoS | 3GPP TS 29.572 [12] | | | +| LcsQoSClass | 3GPP TS 29.572 [12] | | | +| SupportedGADShapes | 3GPP TS 29.572 [12] | | | +| PeriodicEventInfo | 3GPP TS 29.572 [12] | | | +| AreaEventInfo | 3GPP TS 29.572 [12] | | | +| MotionEventInfo | 3GPP TS 29.572 [12] | | | +| LdrType | 3GPP TS 29.572 [12] | | | +| LdrReference | 3GPP TS 29.572 [12] | | | +| AgeOfLocationEstimate | 3GPP TS 29.572 [12] | | | +| PositioningMethod | 3GPP TS 29.572 [12] | | | +| AccuracyFulfilmentIndicator | 3GPP TS 29.572 [12] | | | +| LmflIdentification | 3GPP TS 29.572 [12] | | | +| LcsServiceType | 3GPP TS 29.572 [12] | | | +| VelocityRequested | 3GPP TS 29.572 [12] | | | +| LcsPriority | 3GPP TS 29.572 [12] | | | +| VelocityEstimate | 3GPP TS 29.572 [12] | | | +| TerminationCause | 3GPP TS 29.572 [12] | | | +| PositioningMethodAndUsage | 3GPP TS 29.572 [12] | | | +| GnssPositioningMethodAndUsage | 3GPP TS 29.572 [12] | | | +| LcsServiceAuth | 3GPP TS 29.571 [11] | | | +| Ecgi | 3GPP TS 29.571 [11] | | | +| Ncgi | 3GPP TS 29.571 [11] | | | +| Altitude | 3GPP TS 29.572 [12] | Altitude | | +| BarometricPressure | 3GPP TS 29.572 [12] | Barometric pressure | | +| MinorLocationQoS | 3GPP TS 29.572 [12] | Minor Location QoS | MUTIQOS | +| LocationPrivacyVerResult | 3GPP TS 29.518 [20] | | | +| ExternalGroupId | 3GPP TS 29.571 [11] | External Group Identifier | | +| GroupId | 3GPP TS 29.571 [11] | Group Identifier | | +| CivicAddress | 3GPP TS 29.572 [12] | Civic Address | | +| GeographicArea | 3GPP TS 29.572 [12] | Geographic Area | | +| LocalArea | 3GPP TS 29.572 [12] | Local area specified by different shape | | +| RedirectResponse | 3GPP TS 29.571 [11] | | | +| DateTime | 3GPP TS 29.571 [11] | Date and Time | | +| LpHapType | 3GPP TS 29.518 [20] | Type of Low Power and/or High Accuracy Positioning | | +| HighAccuracyGnssMetrics | 3GPP TS 29.572 [12] | High Accuracy GNSS Metrics | | +| LosNlosMeasureInd | 3GPP TS 29.572 [12] | LOS/NLOS measurement indication | | +| UpLocRepAddrAfRm | 3GPP TS 29.122 [24] | User plane addressing information | | +| IndoorOutdoorInd | 3GPP TS 29.572 [25] | Indicates an area for event reporting | | +| RangingSIResult | 3GPP TS 29.572 [12] | Indicates result type for ranging and sidelink positioning | | +| RelatedUE | 3GPP TS 29.572 [12] | Indicates information for related UE for ranging and sidelink positioning | | +| RangeDirection | 3GPP TS 29.572 [12] | Represents the range and direction between two points. | | +| 2DRelativeLocation | 3GPP TS 29.572 [12] | Represents 2D local coordinates with origin corresponding to another known point. | | + +| | | | | +|----------------------|---------------------|-----------------------------------------------------------------------------------|--| +| 3DRelativeLocation | 3GPP TS 29.572 [12] | Represents 3D local coordinates with origin corresponding to another known point. | | +| MappedLocationQoSEps | 3GPP TS 29.572 [12] | Mapped Location QoS for EPS | | + +#### 6.1.5.2 Structured data types + +##### 6.1.5.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.5.2.2 Type: InputData + +Table 6.1.5.2.2-1: Definition of type InputData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier (NOTE 3). | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier (NOTE 3). | | +| extGroupId | ExternalGroupId | O | 0..1 | This IE may be present when requesting LCS service for a group of target UEs, if present this IE shall contain the External Group ID (NOTE 3). | | +| intGroupId | GroupId | O | 0..1 | This IE may be present when requesting LCS service for a group of target UEs, if present this IE shall contain the Internal Group ID (NOTE 3). | | +| externalClientType | ExternalClientType | M | 1 | This IE shall contain LCS client type | | +| locationQoS | LocationQoS | O | 0..1 | Requested location QoS

Multiple QoS Class (lcsQosClass sets to "MULTIPLE_QOS") shall only be used when GMLC support MUTIQOS feature. | | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | Supported Geographical Area Description shapes | | +| serviceIdentity | ServiceIdentity | O | 0..1 | Service identity | | +| serviceCoverage | array(E164CountryCodeOfGeographicArea) | O | 1..N | A list of E.164 country codes for geographic areas (see ITU Recommendation E.164 [13]) where the LCS client is permitted to request and receive UE location information. | | +| ldrType | LdrType | C | 0..1 | Location deferred request event type | | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Periodic event information of the location request for a target UE | | +| areaEventInfo | AreaEventInfoExt | C | 0..1 | Area event information of the location request for a target UE | | +| motionEventInfo | MotionEventInfo | C | 0..1 | Motion event information of the location request for a target UE | | +| ldrReference | LdrReference | C | 0..1 | Notification correlation ID
It shall be present in the request from NEF if it is allocated by NEF for the Deferred 5GC-MT-LR procedure.
It shall be present in the request from NEF for requesting location service for a group of UEs.
It shall be present in the request to VGMLC for the Deferred 5GC-MT-LR procedure.
This IE shall be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [4] clause 6.1.2. | | +| hgmlcCallBackUri | Uri | O | 0..1 | Notification target address for HGMLC
This IE shall also be present for location service in PNI-NPN with | | + +| | | | | | | +|------------------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | signalling optimisation, as specified in 3GPP TS 23.273 [4] clause 6.1.2 | | +| eventNotificationUri | Uri | O | 0..1 | The call-back Uri of NF service consumer (i.e. NEF, NWDAF) for implicit subscription to notification of Eventnotify.
This IE should be included and is used to receive the location information for UEs in the group when requesting LCS service for a group of target UEs or requesting deferred 5GC MT LCS service for a single UE. | | +| externalClientId | ExternalClientId | O | 0..1 | External LCS client identification | | +| afId | string | O | 0..1 | The identification of AF that initiated location request | | +| uePrivacyRequirements | UePrivacyRequirements | O | 0..1 | UE privacy requirement | | +| lcsServiceType | LcsServiceType | O | 0..1 | LCS service type

This IE may be present when being sent from HGMLC to VGMLC.

When present, it shall contain the LCS service type, which is mapped from attribute serviceIdentity of the LCS Request by the HGMLC. | | +| velocityRequested | VelocityRequested | O | 0..1 | Velocity of the target UE is requested | | +| priority | LcsPriority | O | 0..1 | Priority of the location request | | +| locationTypeRequested | LocationTypeRequested | O | 0..1 | Requested type of location, applicable to location immediate request (NOTE 2) | | +| maximumAgeOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Requested maximum age of the location estimate | | +| amfId | AmfId | O | 0..1 | The identification of serving AMF | | +| codeWord | CodeWord | O | 0..1 | Code word (NOTE 1) | | +| scheduledLocTime | DateTime | O | 0..1 | The scheduled time (in UTC) for location determination | | +| reliableLocReq | boolean | C | 0..1 | This IE shall be included with the value "true" to indicate that reliable UE location information is required, as specified in 3GPP TS 33.256 [22] clause 5.3.2.

When present, this IE shall be set as following:
- true: the reliable UE location information is required
- false (default): the reliable UE location information is not required | | +| servingLmfId | LMFIdentification | O | 0..1 | If present, this IE contains the identification of a serving LMF selected by the GMLC. | | +| lpHapType | LpHapType | C | 0..1 | This IE shall be included and set to "LOW_POW_HIGH_ACCU_POS" to request low power and high accuracy positioning, as specified in clause 6.1.2 of 3GPP TS 23.273 [4]. | | +| evtRptExpectedAre | GeographicAre | O | 0..1 | This IE shall be present in the | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| a | a | | | request from H-GMLC to V-GMLC if the event report expected area was retrieved from UDM.

When present, this IE shall indicate the event report expected area. | | +| reportingInd | ReportingInd | C | 0..1 | This IE shall be present in the request from H-GMLC to V-GMLC if the area usage indication is provided by UDM and event report expected area is present.

When present, this IE shall indicate whether the UE is allowed to generate and send the reports inside or outside the event report expected area:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [4] clause 5.14 and 6.3.1) | | +| integrityRequirements | IntegrityRequirements | O | 0..1 | When present, this IE shall indicate the integrity requirements. | | +| upLocRepStatAf | integer | O | 0..1 | When present, this IE contains the number of event reports have transferred over user plane. If the cumulative event report has been sent previously, this IE contains the number of event reports have transferred over user plane since the last cumulative event report was sent | | +| requestedRangingSIResult | array(RangingSIResult) | O | 1..N | When present, this IE shall contain the type of result requested for ranging and sidelink positioning, such as absolute locations, relative locations or ranges and directions related to the UEs, etc. | Ranging_SL | +| relatedUEs | array(RelatedUE) | O | 1..N | When present, this IE contains a list of the information for the related UEs for the ranging and sidelink positioning. | Ranging_SL | +| mappedQoSEps | MappedLocationQoSEps | C | 0..1 | This IE may only be present in the service request from H-GMLC to V-GMLC, if the Multiple QoS Class is indicated in the locationQoS IE.

When present, this IE shall indicate the mapped Location QoS applicable to EPS ("BEST EFFORT" or "ASSURED") based on the Multiple Location QoS (see clause 6.19 of 3GPP TS 23.273 [4]). | MUTIQOS | +| NOTE 1: Checking of the Codeword in UE applies only when the Codeword parameter is present and when the codeWordCheck parameter (specified in clause 6.1.5.2.7) is present and set to TRUE. | | | | | | +| NOTE 2: If the LocationTypeRequested parameter is set to value "NOTIFICATION_VERIFICATION_ONLY", then the lcsServiceAuthInfo attribute in the uePrivacyRequirements IE, if present, shall be set to either "NOTIFICATION_ONLY" or "NOTIFICATION_AND_VERIFICATION_ONLY". | | | | | | +| NOTE 3: If retrieving the location for a target UE, the UE identification (attributes gsi and/or supi) shall be included, if retrieving the UE locations for a target group, the group identification (attributes extGroupId and/or intGroupId), UE identification and group identification shall be included exclusively. | | | | | | + + + +##### 6.1.5.2.3 Type: LocationData + +Table 6.1.5.2.3-1: Definition of type LocationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| locationEstimate | GeographicArea | O | 0..1 | Geographic area of the target UE | | +| civicAddress | CivicAddress | O | 0..1 | Civic address of the target UE | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Age of location estimate | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | The indication whether the obtained location estimate satisfies the requested accuracy or not | | +| ueVelocity | VelocityEstimate | O | 0..1 | Responded UE velocity, if requested and available | | +| ldrReference | LdrReference | C | 0..1 | Notification correlation ID
It shall be present in the response to NEF if it is allocated by HGMLC for the the Deferred 5GC-MT-LR procedure. | | +| altitude | Altitude | C | 0..1 | If present, this IE indicates the altitude of the positioning estimate.
This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming. | | +| servingLMFIdentification | LMFIdentification | C | 0..1 | If present, this IE contains the identification of a serving LMF for periodic or triggered location.
This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming. | | +| locationPrivacyVer | LocationPrivacy | C | 0..1 | If present, this IE contains | | + +| | | | | | | +|---------------------------|-------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| Result | VerResult | | | the result of location privacy verification by UE.
The IE shall be included from (V)GMLC to (H)GMLC if received from the serving AMF by (V)GMLC when roaming and a location request with notification and privacy verification only indication is sent to the serving AMF via (V)GMLC by (H)GMLC during location request procedure.. | | +| successType | SuccessType | C | 0..1 | This IE is only used for requesting LCS service for a group, and shall be present to indicate one of the following value.
-
SUCCESS_COMPLETELY
-
SUCCESS_PARTIALLY

The value "SUCCESS_COMPLETELY" indicates that requesting/subscribing to LCS service is successful for all the UE(s) within the group identified by the external/internal group ID. The value "SUCCESS_PARTIALLY" indicates that requesting/subscribing to LCS service is only successful for a part of the UE(s) within the group identified by the external/internal group ID.

The default value of this attribute is "SUCCESS_COMPLETELY" if this IE is not present. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received. | MUTIQOS | +| directReportInd | boolean | C | 0..1 | When present, this IE shall be set for the following value:
- true: location determination will be sent by LMF to GMLC directly
- false (default): location determination will not be sent by LMF to GMLC directly

This IE shall be present if received from LMF. | | +| acceptedPeriodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE shall be present if received from AMF/LMF. | | + +| | | | | | | +|---------------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | When present, this IE shall provide the accepted periodic event reporting information. | | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF/AMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| relatedApplicationlayerId | ApplicationlayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | Ranging_SL | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationlayerId. | Ranging_SL | + +##### 6.1.5.2.4 Type: CancelLocData + +Table 6.1.5.2.4-1: Definition of type CancelLocData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | This IE may be present when requesting cancellation of LCS service for a single UE.

When present, this IE shall contain the Subscription Permanent Identifier of the target UE.
(NOTE). | | +| gpsi | Gpsi | O | 0..1 | This IE may be present when requesting cancellation of LCS service for a single UE.

When present, this IE shall contain the Generic Public Subscription identifier of the target UE.
(NOTE). | | +| extGroupId | ExternalGroupId | O | 0..1 | This IE may be present when requesting cancellation of LCS service for a group of target UEs.

When present this IE shall contain the External Group ID
(NOTE). | | +| intGroupId | GroupId | O | 0..1 | This IE may be present when requesting cancellation of LCS service for a group of target UEs.

When present this IE shall contain the Internal Group ID
(NOTE). | | +| hgmlcCallbackUri | Uri | M | 1 | Notification target address | | +| ldrReference | LdrReference | M | 1 | LDR Reference | | +| lmfIdentification | LmfIdentification | O | 0..1 | The latest LMF identification received | | +| amfId | AmfId | O | 0..1 | The identification of the serving AMF | | +| NOTE: If cancelling the location for a target UE, the UE identification (attributes gpsi and/or supi) shall be included, if cancelling the UE locations for a target group, the group identification (attributes extGroupId and/or intGroupId), UE identification and group identification shall be included exclusively. | | | | | | + +##### 6.1.5.2.5 Type: LocUpdateData + +Table 6.1.5.2.5-1: Definition of type LocUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription identifier | | +| pseudonymIndicator | PseudonymIndicator | O | 0..1 | Pseudonym indicator | | +| locationRequestType | LocationRequestType | M | 1 | Event causing the location estimate (5GC-MO-LR) | | +| locationEstimate | GeographicArea | M | 1 | Geographic area of the target UE | | +| ageOfLocationEstimate | AgeOfLocationEstimate | M | 1 | Age of location estimate | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | M | 1 | The indication whether the obtained location estimate satisfies the requested accuracy or not | | +| civicAddress | CivicAddress | O | 0..1 | Civic address of the target UE | | +| lcsQosClass | LcsQosClass | M | 1 | The LCS QoS Class requested by the target UE | | +| externalClientId | ExternalClientId | O | 0..1 | Identity of the LCS client | | +| aflid | string | O | 0..1 | Identity of the AF | | +| gmlcNumber | string | C | 0..1 | This IE shall be included by the AMF in the request to V-GMLC, if the "mlc-number" IE is received in MO request from the UE.

When present, this IE shall contain the GMLC Number (in E.164 international number format) indicated in the "mlc-number" IE of the MO request from the UE. The V-GMLC may query NRF to obtain the H-GMLC using the GMLC Number.

Pattern: "^[0-9]{5,15}\$" | | +| lcsServiceType | LcsServiceTypeId | O | 0..1 | When present, this IE shall contain the LCS Service Type received from the UE, as specified in clause 6.2 of 3GPP TS 23.273 [4].

When received, the H-GMLC shall map the received LCS Service Type to the Service Identity in Location Update Notification. | | + +##### 6.1.5.2.6 Type: EventNotifyData + +Table 6.1.5.2.6-1: Definition of type EventNotifyData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| ldrReference | LdrReference | M | 1 | LDR Reference | | +| eventNotifyDataType | EventNotifyDataType | M | 1 | The type of event that triggers event notification | | +| locationEstimate | GeographicArea | O | 0..1 | Geographic area of the target UE | | +| civicAddress | CivicAddress | O | 0..1 | Civic address of the target UE | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Age of location estimate | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each non-GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | If present, this IE shall indicate the usage of each GNSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully. | | +| lmfIdentification | LmfIdentification | O | 0..1 | LMF identification that stores the location context of the target UE | | +| amfld | Amfld | O | 0..1 | The identification of AMF that is serving the target UE | | +| terminationCause | TerminationCause | C | 0..1 | The IE shall be included if event reporting has been terminated | | +| velocityEstimate | VelocityEstimate | C | 0..1 | If present, this IE contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty.
This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming. | | +| altitude | Altitude | C | 0..1 | If present, this IE indicates the altitude of the positioning estimate.
This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming. | | + +| | | | | | | +|-----------------------------|-----------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| targetNode | NfInstanceId | C | 0..1 | For mobility of a UE with periodic or triggered location, this IE contains the address of the new serving node and shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | The indication whether the obtained location estimate satisfies the requested accuracy or not | | +| failureCause | FailureCause | C | 0..1 | This IE shall contain the failure cause for the UE if present.
The IE shall be included if positioning has failed for the target UE in the target group. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE shall be present if received. | MUTIQOS | +| haGnssMetrics | HighAccuracyGnssMetrics | C | 0..1 | This IE should be included when received from LMF/AMF.

When present, this IE shall indicate the high accuracy GNSS metrics for the location estimate. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| relatedApplicationLayerId | ApplicationLayerId | O | 0..1 | Identifies the application layer ID of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | Ranging_SL | +| rangeDirection | RangeDirection | O | 0..1 | When present, this IE identifies a range and direction from a point A to a point B, comprising a range from point A to point B, an azimuth direction from point A to point B and an elevation direction from point A to point B. | Ranging_SL | +| 2dRelativeLocation | 2DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 2D location with uncertainty ellipse, characterised by a point described in 2D local co-ordinates with origin corresponding to another known point, distances r1 and r2 and an angle of orientation A. | Ranging_SL | +| 3dRelativeLocation | 3DRelativeLocation | O | 0..1 | When present, this IE identifies a relative 3D | Ranging_SL | + +| | | | | | | +|------------------|------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | location with uncertainty ellipsoid, characterised by a point described in 3D local co-ordinates with origin corresponding to another known point, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis"). | | +| relativeVelocity | VelocityEstimate | O | 0..1 | When present, this IE identifies UE velocity relative to the UE identified with relatedApplicationLayerId. | Ranging_SL | + +##### 6.1.5.2.7 Type: UePrivacyRequirements + +**Table 6.1.5.2.7-1: Definition of type UePrivacyRequirements** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lcsServiceAuthInfo | LcsServiceAuth | O | 0..1 | When present, this IE shall contain an indication of privacy related notification or verification for the target UE.
The default value of this parameter if not present is "LOCATION_ALLOWED_WITHOUT_NOTIFICATION". | | +| codeWordCheck | boolean | O | 0..1 | When present, it shall indicate whether the Codeword parameter shall be checked in UE. (NOTE) | | +| NOTE: Checking of the Codeword in UE applies only when the Codeword parameter (specified in clause 6.1.5.2.2) is present and when the codeWordCheck parameter is present and set to TRUE. | | | | | | + +6.1.5.2.8 Void + +6.1.5.2.9 Type: LocUpdateNotification + +Table 6.1.5.2.9-1: Definition of type LocUpdateNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription identifier | | +| locationRequestType | LocationRequestType | M | 1 | Event causing the location estimate (5GC-MO-LR) | | +| locationEstimate | GeographicArea | M | 1 | geographic area of the target UE | | +| ageOfLocationEstimate | AgeOfLocationEstimate | M | 1 | Age of location estimate | | +| timestampOfLocationEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same). | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | M | 1 | The indication whether the obtained location estimate satisfies the requested accuracy or not | | +| civicAddress | CivicAddress | O | 0..1 | Civic address of the target UE | | +| lcsQosClass | LcsQosClass | M | 1 | The LCS QoS Class requested by the target UE | | +| aflid | string | O | 0..1 | Identity of the AF | | +| serviceIdentity | ServiceIdentity | O | 0..1 | When present, this IE shall contain Service Identity mapped from the LCS Service Type specified by the UE, as specified in clause 6.2 of 3GPP TS 23.273 [4]. | | + +6.1.5.2.10 Type: LocUpdateSubs + +Table 6.1.5.2.10-1: Definition of type LocUpdateSubs + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| nflInstanceId | NflInstanceId | M | 1 | Identity of the NF Instance creating the subscription. | | +| notifUri | Uri | M | 1 | The URI via which the NF service consumer wants to receive notifications related to this subscription. | | +| supi | Supi | C | 0..1 | SUPI of the UE concerned by the subscription.
This attribute shall be present if the gpsi attribute is not present. | | +| gpsi | Gpsi | C | 0..1 | GPSI of the UE concerned by the subscription.
This attribute shall be present if the supi attribute is not present. | | + +6.1.5.2.11 Type: EventNotifyDataAdditionalInfo + +**Table 6.1.5.2.11-1: Definition of type EventNotifyDataAdditionalInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| addEventDataList | array(EventNotifyData) | O | 1..N | When present, this IE shall include a list of event reports of the additional UE(s) which belong to the target group. | | + +6.1.5.2.12 Type: EventNotifyDataExt + +**Table 6.1.5.2.12-1: Definition of type EventNotifyDataExt as a list of to be combined data** + +| Data type | Cardinality | Description | Applicability | +|-------------------------------|-------------|-------------------------------------------------------|---------------| +| EventNotifyData | 1 | Event Notification Data | | +| EventNotifyDataAdditionalInfo | 1 | Additional information of the Event Notification Data | | + +6.1.5.2.13 Type: AreaEventInfoAddition + +**Table 6.1.5.2.13-1: Definition of type AreaEventInfoAddition** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| geoAreaList | array(GeographicArea) | O | 1..N | One or more geographic areas for location reporting event | +| ignoreAreaDefInd | boolean | O | 0..1 | Indicating whether the "areaDefinition" IE in AreaEventInfoExt combined data type shall be ignored or not:

- true: the "areaDefinition" IE shall be ignored.
- false (default) the "areaDefinition" IE shall not be ignored. | +| additionalCheckInd | boolean | O | 0..1 | This IE shall be included with the value "true" to indicate that additional check whether UE is located within the requested target area is required, as specified in 3GPP TS 23.273 [4] clause 6.3.1.

When present, this IE shall be set as following:
- true: the additional check whether UE is located within the requested target area is required
- false (default): the additional check whether UE is located within the requested target area is not required | + +6.1.5.2.14 Type: AreaEventInfoExt + +**Table 6.1.5.2.14-1: Definition of type AreaEventInfoExt as a list of to be combined data** + +| Data type | Cardinality | Description | Applicability | +|-----------------------|-------------|----------------------------------------------------------|---------------| +| AreaEventInfo | 1 | Area Event Information | | +| AreaEventInfoAddition | 1 | Addition information for Extended Area Event Information | | + +6.1.5.2.15 Type: IntegrityRequirements + +**Table 6.1.5.2.15-1: Definition of type IntegrityRequirements** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------| +| targetIntegrityRisk | TargetIntegrityRisk | O | 0..1 | This IE shall indicate Target Integrity Risk (TIR), as specified in 3GPP TR 37.355 [23]. | +| timeToAlert | TimeToAlert | O | 0..1 | This IE shall indicate the Time-to-Alert (TTA). | +| alertLimit | AlertLimit | O | 0..1 | This IE shall indicate Alert Limit (AL), as specified in 3GPP TS 37.355 [23]. | + +6.1.5.2.16 Type: AlertLimit + +**Table 6.1.5.2.16-1: Definition of type AlertLimit** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| horizontalProtectionLevel | HorizontalProtectionLevel | M | 1 | This IE shall indicate the Horizontal Protection Level, as specified in 3GPP TS 37.355 [23]. | +| verticalProtectionLevel | VerticalProtectionLevel | O | 0..1 | This IE shall indicate the Vertical Protection Level, as specified in 3GPP TS 37.355 [23]. | + +6.1.5.2.17 Type: UpLocRepInfoAf + +**Table 6.1.5.2.17-1: Definition of type UpLocRepInfoAf** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| upLocRepAfInd | boolean | C | 0..1 | This IE shall be included to indicate that the location reporting over user plane is required.

When present, this IE shall be set as following:
- true: the location reporting over user plane is required.

Presence of this IE with false value is prohibited | | +| upLocRepAddrAf | UpLocRepAddrAfRm | O | 0..1 | Notification target (LCS client or AF) endpoint address for location reporting over user plane. | | +| upCumEvtRptCriteria | UpCumEvtRptCriteria | O | 0..1 | Criteria for sending cumulative event reports over control plane | | + +6.1.5.2.18 Type: UpCumEvtRptCriteria + +**Table 6.1.5.2.18-1: Definition of type UpCumEvtRptCriteria** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| evtRptTimeCriteria | integer | O | 0..1 | This IE shall contain a timer in seconds to trigger cumulative event report over control plane when location reporting over user plane is ongoing | | +| evtRptCountCriteria | integer | O | 0..1 | This IE shall contain a number to trigger cumulative event report over control plane when location reporting over user plane is ongoing | | + +##### 6.1.5.2.19 Type: AddLocationDatas + +Table 6.1.5.2.19-1: Definition of type AddLocationDatas + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------|---|-------------|------------------------------------|---------------| +| addLocationDatas | array(LocationData) | O | 1..N | Contains one or more LocationData. | | + +##### 6.1.5.2.20 Type: LocationDataExt + +Table 6.1.5.2.20-1: Definition of type LocationDataExt as a list of data types to be combined + +| Data type | Cardinality | Description | Applicability | +|------------------|-------------|--------------------------|---------------| +| LocationData | 1 | Location Data | | +| AddLocationDatas | 1 | Additional Location Data | | + +#### 6.1.5.3 Simple data types and enumerations + +##### 6.1.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.5.3.2 Simple data types + +The simple data types defined in table 6.1.5.3.2-1 shall be supported. + +Table 6.1.5.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|---------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ServiceIdentity | string | Service identity | | +| ExternalClientId | string | External LCS client identification | | +| CodeWord | string | codeword | | +| E164CountryCodeOfGeographicArea | string | The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area | | +| LcsServiceTypeId | integer | LCS Service Type Id, as specified clause 7.6.11.15 of 3GPP TS 29.002 [21].
Minimum = 0. Maximum = 127 | | +| TimeToAlert | integer | Time-to-Alert
Minimum = 1. Maximum = 300 | | +| TargetIntegrityRisk | integer | Target Integrity Risk
Minimum = 10. Maximum = 90 | | +| HorizontalProtectionLevel | integer | Horizontal Protection Level
Minimum = 0. Maximum = 50000 | | +| VerticalProtectionLevel | integer | Vertical Protection Level
Minimum = 0. Maximum = 50000 | | + +##### 6.1.5.3.3 Enumeration: PseudonymIndicator + +The enumeration PseudonymIndicator represents whether pseudonym should be used as the identity of the target UE. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.5.3.3-1: Enumeration PseudonymIndicator** + +| Enumeration value | Description | Applicability | +|---------------------------|------------------------------|---------------| +| "PSEUDONYM_REQUESTED" | A pseudonym is requested | | +| "PSEUDONYM_NOT_REQUESTED" | A pseudonym is not requested | | + +##### 6.1.5.3.4 Enumeration: LocationRequestType + +The enumeration LocationRequestType represents how the location request is triggered. It shall comply with the provisions defined in table 6.1.5.3.4-1. + +**Table 6.1.5.3.4-1: Enumeration LocationRequestType** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------|---------------| +| "NI-LR" | Network induced location request | | +| "MT-LR" | Mobile terminated location request | | +| "MO-LR" | Mobile originated location request | | + +##### 6.1.5.3.5 Enumeration: LocationTypeRequested + +The enumeration LocationTypeRequested represents the requested type of location which is only applicable to location immediate request. It shall comply with the provisions defined in table 6.1.5.3.5-1. + +**Table 6.1.5.3.5-1: Enumeration LocationTypeRequested** + +| Enumeration value | Description | Applicability | +|----------------------------------|----------------------------------------------------------------|---------------| +| "CURRENT_LOCATION" | Requesting the current location of the target UE | | +| "CURRENT_OR_LAST_KNOWN_LOCATION" | Requesting the current or last known location of the target UE | | +| "INITIAL_LOCATION" | Requesting the initial location of the target UE | | +| "NOTIFICATION_VERIFICATION_ONLY" | Requesting notification verification only | | + +##### 6.1.5.3.6 Enumeration: EventNotifyDataType + +The enumeration EventNotifyDataType represents the type of event notification. It shall comply with the provisions defined in table 6.1.5.3.6-1. + +**Table 6.1.5.3.6-1: Enumeration EventNotifyDataType** + +| Enumeration value | Description | Applicability | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| "UE_AVAILABLE" | UE available event | | +| "PERIODIC" | Periodic event | | +| "ENTERING_INTO_AREA" | Entering area event | | +| "LEAVING_FROM_AREA" | Leaving area event | | +| "BEING_INSIDE_AREA" | Being inside area event | | +| "MOTION" | Motion event | | +| "MAXIMUM_INTERVAL_EXPIRATION_EVENT" | Expiration of maximum reporting interval event | | +| "LOCATION_CANCELLATION_EVENT" | Cancellation of location reporting event | | +| "ACTIVATION_OF_DEFERRED_LOCATION" | A confirmation that periodic or triggered location was successfully activated in the target UE | | +| "UE_MOBILITY_FOR_DEFERRED_LOCATION" | Mobility of the target UE to a different NF | | +| "5GC_MT_LR" | Report of immediate 5GC mobile terminated location.
It is used for 5GC_MT_LR request targeting to a group of UE procedure. | | +| "DIRECT_REPORT_EVENT" | Direct location reporting event | | +| "CUMULATIVE_EVENT_REPORT" | Cumulative event report for events reported | | + +##### 6.1.5.3.7 Enumeration: FailureCause + +The enumeration FailureCause represents the cause of positioning failure. It shall comply with the provisions defined in table 6.1.5.3.7-1. + +**Table 6.1.5.3.7-1: Enumeration FailureCause** + +| Enumeration value | Description | Applicability | +|----------------------|------------------------------------|---------------| +| "POSITIONING_DENIED" | Positioning is denied | | +| "UNSUPPORTED_BY_UE" | Positioning is not supported by UE | | +| "NOT_REGISTERED_UE" | UE doesn't register | | +| "UNSPECIFIED" | Unspecified | | + +##### 6.1.5.3.8 Enumeration: SuccessType + +The enumeration SuccessType represents the type of success. It shall comply with the provisions defined in table 6.1.5.3.8-1. + +**Table 6.1.5.3.8-1: Enumeration SuccessType** + +| Enumeration value | Description | Applicability | +|----------------------|------------------------------|---------------| +| "SUCCESS_COMPLETELY" | It is completely successful. | | +| "SUCCESS_PARTIALLY" | It is partially successful. | | + +##### 6.1.5.3.9 Enumeration: ReportingInd + +The enumeration ReportingInd represents whether the UE is allowed to generate and send the event report when the UE detects the triggered or periodic event happens, if it is inside or outside the event report allowed/expected area. It shall comply with the provisions defined in table 6.1.5.3.9-1. + +**Table 6.1.5.3.x-1: Enumeration ReportingInd** + +| Enumeration value | Description | Applicability | +|---------------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| "INSIDE_REPORTING" | The UE is allowed to generate and send the event report when the UE is inside the event report allowed/expected area. | | +| "OUTSIDE_REPORTING" | The UE is allowed to generate and send the event report when the UE is outside the event report allowed/expected area | | + +### 6.1.6 Error Handling + +#### 6.1.6.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +#### 6.1.6.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [5]. + +#### 6.1.6.3 Application Errors + +The application errors defined for the Ngmlc\_Location service are listed in Table 6.1.6.3-1. + +**Table 6.1.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| POSITIONING_DENIED | 403 Forbidden | the positioning procedure was denied. | +| UNSPECIFIED | 403 Forbidden | the request is rejected due to unspecified reasons. | +| UNSUPPORTED_BY_UE | 403 Forbidden | the position request for periodic or triggered location is not supported by the target UE | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | the location context was not found | +| UNREQUESTED_BY_UE | 403 Forbidden | the UE did not request transfer of its location to an LCS Client or AF | +| UNKNOWN_EXTERNAL_CLIENT_OR_AF | 403 Forbidden | the external LCS client or AF is unknown | +| UNREACHABLE_EXTERNAL_CLIENT_OR_AF | 403 Forbidden | the external LCS client or AF is unreachable | +| DETACHED_USER | 403 Forbidden | the user is deregistered in the AMF | +| POSITIONING_FAILED | 500 Internal Server Error | the positioning procedure failed | +| UNREACHABLE_USER | 504 Gateway Timeout | the user could not be reached in order to perform positioning procedure | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from a remote peer, i.e.,
1) The response from the serving AMF wasn't received by (V)GMLC, or;
2) (V)GMLC received HTTP status code 504 with PEER_NOT_RESPONDING from AMF. | + +### 6.1.7 Feature negotiation + +The optional features in table 6.1.7-1 are defined for the Ngmlc\_Location API. + +**Table 6.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MUTIQOS | Support of Multiple Location QoSes.

This feature bit indicates whether the GMLC support that more than one Location QoSes during consuming location service are required. | +| 2 | Ranging_SL | This feature supports the enhanced location exposure service (e.g. location information for ranging and sidelink positioning), and requires the support of eLCS feature.
The feature is not applicable to pre-5G (e.g. 4G). | + +### 6.1.8 Security + +As indicated in 3GPP TS 33.501 [15], the access to the Ngmlc\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [17]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Ngmlc\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [17], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Ngmlc\_Location service. + +The Ngmlc\_Location API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [15]: + +**Table 6.1.8-1: OAuth2 scopes defined in Ngmlc\_Location API** + +| Scope | Description | +|-------------------------------------|--------------------------------------------| +| "ngmlc_loc" | Access to the Ngmlc_Location API. | +| "ngmlc_loc:provide-location:invoke" | Access to invoke Provide Location | +| "ngmlc_loc:cancel-location:invoke" | Access to invoke Cancel Location | +| "ngmlc_loc:location-update:invoke" | Access to invoke Location update | +| "ngmlc_loc:loc-update-subs:invoke" | Access to invoke Location update subscribe | + +### 6.1.9 HTTP redirection + +An HTTP request may be redirected to a different GMLC service instance, within the same GMLC or a different GMLC of an GMLC set, e.g. when an GMLC service instance is part of an GMLC (service) set or when using indirect communications (see 3GPP TS 29.500 [5]). + +An SCP that reselects a different GMLC producer instance will return the NF Instance ID of the new GMLC producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [5]. + +If an GMLC within an GMLC set redirects a service request to a different GMLC of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new GMLC towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [5]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Ngmlc\_Location service. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [6] clause 5.3.1 and 3GPP TR 21.900 [19] clause 5B). + +## A.2 Ngmlc\_Location API + +``` +openapi: 3.0.0 +info: + version: '1.2.0-alpha.5' + title: 'Ngmlc_Location' + description: | + GMLC Location Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.515 V18.4.0; 5G System; Gateway Mobile Location Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.515/' + +servers: + - url: '{apiRoot}/ngmlc-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - ngmlc-loc + +paths: + /provide-location: + post: + summary: Request Location of an UE + operationId: RequestLocation + tags: + - Request Location + security: + - {} + - oAuth2ClientCredentials: + - ngmlc-loc + - oAuth2ClientCredentials: + - ngmlc-loc + - ngmlc-loc:provide-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InputData' + required: true + responses: + '200': + description: Expected response to a valid request +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/LocationDataExt' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + EventNotify: + '{ $request.body#/hmlcCallBackUri }': + post: + requestBody: + description: UE Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotifyDataExt' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +EventNotifyNf: +``` + +``` + +'{$request.body#/eventNotificationUri}': + post: + requestBody: + description: UE Event Notification + content: + application/json: + schema: + $ref: '#/components/schemas/EventNotifyDataExt' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/cancel-location: + post: + summary: request cancellation of periodic or triggered location + operationId: CancelLocation + tags: + - Cancel Location + security: + - {} + - oAuth2ClientCredentials: + - ngmlc-loc + - oAuth2ClientCredentials: + - ngmlc-loc + - ngmlc-loc:cancel-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelLocData' + required: true + responses: + '204': + description: Expected response to a successful cancellation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/location-update: + post: + summary: update UE location information + operationId: UpdateLocation + tags: + - Update Location + security: + - {} + - oAuth2ClientCredentials: + - ngmlc-loc + - oAuth2ClientCredentials: + - ngmlc-loc + - ngmlc-loc:location-update:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocUpdateData' + required: true + responses: + '204': + description: Expected response to successful location context transfer + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/loc-update-subs: + post: + summary: subscribe to notifications of UE location information + operationId: LocationUpdateSubscribe + tags: + - UE location information Subscription creation + security: + - {} + - oAuth2ClientCredentials: + - ngmlc-loc + - oAuth2ClientCredentials: +``` + +``` +- ngmlc-loc +- ngmlc-loc:loc-update-subs:invoke +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocUpdateSubs' + required: true +responses: + '204': + description: Expected response to successful UE location information subscription + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + LocationUpdateNotify: + "{$request.body#/notifUri}": + post: + requestBody: + description: Location Update Notification + content: + application/json: + schema: + $ref: '#/components/schemas/LocUpdateNotification' + responses: + '204': + description: Expected response to a valid notification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +``` + +``` + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + ngmlc-loc: Access to the Ngmlc_Location API + ngmlc-loc:provide-location:invoke: Access to invoke Provide Location + ngmlc-loc:cancel-location:invoke: Access to invoke Cancel Location + ngmlc-loc:location-update:invoke: Access to invoke Location update + ngmlc-loc:loc-update-subs:invoke: Access to invoke Location update subscribe + +schemas: +# +# COMPLEX TYPES +# + InputData: + description: Contains the input parameters in ProvideLocation service operation + type: object + required: + - externalClientType + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + extGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + externalClientType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + locationQoS: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + serviceIdentity: + $ref: '#/components/schemas/ServiceIdentity' + serviceCoverage: + type: array + items: + $ref: '#/components/schemas/E164CountryCodeOfGeographicArea' + minItems: 1 + ldrType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrType' + periodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfoExt' + motionEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MotionEventInfo' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + hgmlcCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + eventNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + externalClientIdentification: + $ref: '#/components/schemas/ExternalClientIdentification' + afid: + type: string + uePrivacyRequirements: + $ref: '#/components/schemas/UePrivacyRequirements' + lcsServiceType: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType' + velocityRequested: +``` + +``` + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested' + priority: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsPriority' + locationTypeRequested: + $ref: '#/components/schemas/LocationTypeRequested' + maximumAgeOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + codeWord: + $ref: '#/components/schemas/CodeWord' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + servingLmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + evtRptExpectedArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + reportingInd: + allOf: + - $ref: '#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + integrityRequirements: + $ref: '#/components/schemas/IntegrityRequirements' + upLocRepInfoAf: + $ref: '#/components/schemas/UpLocRepInfoAf' + requestedRangingSlResult: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelatedUE' + minItems: 1 + mappedQoSEps: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MappedLocationQoSEps' + +LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' + +LocationData: + description: Contains the response parameters in ProvideLocation service operation + type: object + properties: + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timeStampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GNSSPositioningMethodAndUsage' +``` + +``` + minItems: 1 + accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + ueVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' + servingLMFIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + locationPrivacyVerResult: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LocationPrivacyVerResult' + successType: + $ref: '#/components/schemas/SuccessType' + achievedQos: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' + directReportInd: + type: boolean + default: false + acceptedPeriodicEventInfo: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo' + haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + +CancelLocData: + description: Contains the input parameters in CancelLocation service operation + type: object + required: + - hgmlcCallBackUri + - ldrReference + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + extGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + hgmlcCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + lmfIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + +LocUpdateData: + description: Contains the input parameters in LocationUpdate service operation + type: object + required: + - locationRequestType + - locationEstimate + - ageOfLocationEstimate + - accuracyFulfilmentIndicator + - lcsQosClass + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pseudonymIndicator: +``` + +``` +$ref: '#/components/schemas/PseudonymIndicator' +locationRequestType: + $ref: '#/components/schemas/LocationRequestType' +locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' +ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' +timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' +civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' +lcsQosClass: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass' +externalClientIdentification: + $ref: '#/components/schemas/ExternalClientIdentification' +afId: + type: string +gmlcNumber: + type: string + pattern: '^[0-9]{5,15}$' +lcsServiceType: + $ref: '#/components/schemas/LcsServiceTypeId' + +EventNotifyData: + description: Contains the input parameters for the target UE in EventNotify Notification +service operation + type: object + required: + - eventNotifyDataType + - ldrReference + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ldrReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference' + eventNotifyDataType: + $ref: '#/components/schemas/EventNotifyDataType' + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + positioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + lmfIdentification: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId' + terminationCause: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/TerminationCause' + velocityEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + altitude: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude' + targetNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + failureCause: + $ref: '#/components/schemas/FailureCause' + achievedQos: +``` + +``` + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS' + haGnssMetrics: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + indoorOutdoorInd: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/IndoorOutdoorInd' + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + +UePrivacyRequirements: + description: UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming +case) for the target UE + type: object + properties: + lcsServiceAuthInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LcsServiceAuth' + codeWordCheck: + type: boolean + +LocUpdateNotification: + description: Location Update Notification + type: object + required: + - locationRequestType + - locationEstimate + - ageOfLocationEstimate + - accuracyFulfilmentIndicator + - lcsQosClass + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + locationRequestType: + $ref: '#/components/schemas/LocationRequestType' + locationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + accuracyFulfilmentIndicator: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator' + civicAddress: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + lcsQosClass: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass' + afId: + type: string + serviceIdentity: + $ref: '#/components/schemas/ServiceIdentity' + +LocUpdateSubs: + description: UE location information subscription + type: object + required: + - nfInstanceId + - notifURI + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + notifURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + +EventNotifyDataExt: + description: Extended Event Notify Data for UEs of a target group + allOf: + - $ref: '#/components/schemas/EventNotifyData' + - $ref: '#/components/schemas/EventNotifyDataAdditionalInfo' + +EventNotifyDataAdditionalInfo: + description: Additional information to Event Notify Data + type: object + properties: + addEventDataList: + type: array + items: + $ref: '#/components/schemas/EventNotifyData' + minItems: 1 + +AreaEventInfoAddition: + description: Additional information for Extended Area event information + type: object + properties: + geoAreaList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + ignoreAreaDefInd: + type: boolean + default: false + additionalCheckInd: + type: boolean + default: false + +AreaEventInfoExt: + description: Extended Area Event Information + allOf: + - $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/AreaEventInfo' + - $ref: '#/components/schemas/AreaEventInfoAddition' + +IntegrityRequirements: + description: integrity requirements. + type: object + properties: + timeToAlert: + $ref: '#/components/schemas/TimeToAlert' + targetIntegrityRisk: + $ref: '#/components/schemas/TargetIntegrityRisk' + alertLimit: + $ref: '#/components/schemas/AlertLimit' + +AlertLimit: + description: Alert Limit. + type: object + required: + - horizontalProtectionLevel + properties: + horizontalProtectionLevel: + $ref: '#/components/schemas/HorizontalProtectionLevel' + verticalProtectionLevel: + $ref: '#/components/schemas/VerticalProtectionLevel' + +UpLocRepInfoAf: + description: Information for the location reporting over user plane + type: object + properties: + upLocRepAfInd: + type: boolean + enum: + - true + upLocRepAddrAf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UpLocRepAddrAfRm' + upCumEvtRptCriteria: + $ref: '#/components/schemas/UpCumEvtRptCriteria' + +UpCumEvtRptCriteria: + description: Criteria for sending cumulative events reports over control plane + type: object + properties: +``` + +``` + evtRptTimeCriteria: + type: integer + evtRptCountCriteria: + type: integer +``` + +``` +# +# SIMPLE TYPES +# +``` + +``` + ServiceIdentity: + description: Contains the service identity + type: string + ExternalClientIdentification: + description: Contains the external client identification + type: string + CodeWord: + description: Contains the codeword + type: string + E164CountryCodeOfGeographicArea: + description: Contains the E.164 country codes for geographic areas + type: string + LcsServiceTypeId: + description: LCS Service Type Id. + type: integer + minimum: 0 + maximum: 127 + TimeToAlert: + description: Contains the time-to-alert + type: integer + minimum: 1 + maximum: 300 + TargetIntegrityRisk: + description: Contains the target integrity risk + type: integer + minimum: 10 + maximum: 90 + HorizontalProtectionLevel: + description: Contains the Horizontal Protection Level + type: integer + minimum: 0 + maximum: 50000 + VerticalProtectionLevel: + description: Contains the Vertical Protection Level + type: integer + minimum: 0 + maximum: 50000 +``` + +``` +# +# ENUMS +# +``` + +``` + PseudonymIndicator: + description: It defines if a pseudonym is requested + anyOf: + - type: string + enum: + - PSEUDONYM_REQUESTED + - PSEUDONYM_NOT_REQUESTED + - type: string + LocationRequestType: + description: NI-LR, MT-LR or MO-LR + anyOf: + - type: string + enum: + - NI_LR + - MT_LR + - MO_LR + - type: string + LocationTypeRequested: + description: Contains the location type requested by the LCS client + anyOf: + - type: string + enum: + - CURRENT_LOCATION + - CURRENT_OR_LAST_KNOWN_LOCATION + - INITIAL_LOCATION + - NOTIFICATION_VERIFICATION_ONLY + - type: string + EventNotifyDataType: + description: Contains the type of event that triggers event notification +``` + +``` +anyOf: + - type: string + enum: + - UE_AVAILABLE + - PERIODIC + - ENTERING_INTO_AREA + - LEAVING_FROM_AREA + - BEING_INSIDE_AREA + - MOTION + - MAXIMUM_INTERVAL_EXPIRATION_EVENT + - LOCATION_CANCELLATION_EVENT + - ACTIVATION_OF_DEFERRED_LOCATION + - UE_MOBILITY_FOR_DEFERRED_LOCATION + - 5GC_MT_LR + - DIRECT_REPORT_EVENT + - CUMULATIVE_EVENT_REPORT + - type: string +FailureCause: + description: Positioning failure cause + anyOf: + - type: string + enum: + - POSITIONING_DENIED + - UNSUPPORTED_BY_UE + - NOT_REGISTERED_UE + - UNSPECIFIED + - type: string +SuccessType: + description: Success Type to indicate full or partial success + anyOf: + - type: string + enum: + - SUCCESS_COMPLETELY + - SUCCESS_PARTIALLY + - type: string +ReportingInd: + description: > + Indicates whether the UE is allowed to generate and send the event report inside or outside + the event report allowed(expected) area + anyOf: + - type: string + enum: + - INSIDE_REPORTING + - OUTSIDE_REPORTING + - type: string +AddLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|------------------------------------------------------------------|------|-----|-----|------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-04 | CT4#90 | C4-191340 | | | | Initial Draft of Gateway Mobile Location Services | 0.1.0 | +| 2019-05 | CT4#91 | C4-192485 | | | | V0.2.0 | 0.2.0 | +| 2019-09 | CT4#93 | C4-193845 | | | | Implementation of pCRs agreed at CT4#93 | 0.3.0 | +| 2019-10 | CT4#94 | C4-194555 | | | | Implementation of pCRs agreed at CT4#94 | 0.4.0 | +| 2019-11 | CT4#95 | C4-195413, C4-195409, C4-195296 | | | | Implementation of pCRs agreed at CT4#95 | 0.5.0 | +| 2019-12 | CT#86 | CP-193065 | | | | TS presented for information | 1.0.0 | +| 2020-03 | CT4#96e | C4-200725, C4-200727, C4-200943, C4-200993, C4-200995, C4-201286 | | | | Implementation of pCRs agreed at CT4#96e | 1.1.0 | +| 2020-03 | CT#87e | CP-200060 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT87e | 16.0.0 | +| 2020-04 | CT#87e | C4-202409 | 0001 | 1 | F | Correct the errors | 16.1.0 | +| 2020-04 | CT#87e | C4-202325 | 0003 | - | F | Miscellaneous corrections on TS 29.515 | 16.1.0 | +| 2020-04 | CT#87e | C4-202326 | 0004 | - | F | Removing pseudonym of UE | 16.1.0 | +| 2020-04 | CT#87e | C4-202532 | 0005 | 1 | F | UE Privacy Requirements Corrections | 16.1.0 | +| 2020-06 | CT#88e | C4-203181 | 0006 | - | F | Error corrections | 16.1.0 | +| 2020-06 | CT#88e | C4-203540 | 0007 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | C4-203524 | 0008 | 1 | F | Correct the Example Consumer(s) in Table 5.1-1 | 16.1.0 | +| 2020-06 | CT#88e | C4-203269 | 0010 | - | F | LDRreference | 16.1.0 | +| 2020-06 | CT#88e | C4-203360 | 0003 | 1 | F | Miscellaneous corrections on TS 29.515 | 16.1.0 | +| 2020-06 | CT#88e | C4-203645 | 0011 | - | F | 3GPP TS 29.515 API Version Update | 16.1.0 | +| 2020-09 | CT#89e | CP-202112 | 0012 | 1 | F | API name correction | 16.2.0 | +| 2020-09 | CT#89e | CP-202112 | 0014 | 1 | F | Correction of CodeWord Checking for UE Notification and Verification | 16.2.0 | +| 2020-09 | CT#89e | CP-202112 | 0015 | 1 | F | Correction of Notification or Verification only for UE Positioning | 16.2.0 | +| 2020-09 | CT#89e | CP-202112 | 0016 | 1 | F | Corrections on EventNotify service operation | 16.2.0 | +| 2020-09 | CT#89e | CP-202112 | 0017 | 1 | F | Corrections on Application Errors in provide-location response | 16.2.0 | +| 2020-09 | CT#89e | CP-202112 | 0018 | 1 | F | Corrections on LocationData | 16.2.0 | +| 2020-09 | CT#89e | CP-202139 | 0020 | 2 | F | Essential correction to OpenAPI specification for LocationUpdateNotify service operation | 16.2.0 | +| 2020-09 | CT#89e | CP-202096 | 0021 | - | F | API version and External doc update | 16.2.0 | +| 2020-11 | CT#90e | CP-203050 | 0022 | 1 | F | CancelLocation for a group of UEs | 16.3.0 | +| 2020-11 | CT#90e | CP-203050 | 0023 | 2 | F | EventNotify for UEs in a group | 16.3.0 | +| 2020-11 | CT#90e | CP-203050 | 0024 | 1 | F | Provide Locations of a group of UEs | 16.3.0 | +| 2020-11 | CT#90e | CP-203050 | 0028 | - | F | Essential corrections | 16.3.0 | +| 2020-11 | CT#90e | CP-203050 | 0029 | - | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-11 | CT#90e | CP-203050 | 0030 | - | F | API version and External doc update | 16.3.0 | +| 2021-03 | CT#91e | CP-210037 | 0033 | 1 | F | HTTP 3xx redirection | 16.4.0 | +| 2021-03 | CT#91e | CP-210041 | 0032 | 1 | F | Geographic Area | 16.4.0 | +| 2021-03 | CT#91e | CP-210054 | 0035 | - | F | 29.515 Rel-16 API version and External doc update | 16.4.0 | +| 2021-03 | CT#91e | CP-210034 | 0034 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92e | CP-211026 | 0036 | 2 | B | Add Local Address | 17.1.0 | +| 2021-06 | CT#92e | CP-211028 | 0047 | - | F | Data Types Descriptions | 17.1.0 | +| 2021-06 | CT#92e | CP-211050 | 0050 | - | F | 29.515 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0040 | 1 | A | 3xx description correction for SCP | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0046 | 1 | A | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92e | CP-211063 | 0038 | 1 | A | LCS Service Type and External Client Type | 17.1.0 | +| 2021-06 | CT#92e | CP-211063 | 0044 | - | A | Remove LcsServiceType | 17.1.0 | +| 2021-06 | CT#92e | CP-211063 | 0048 | - | A | Wrong data type name | 17.1.0 | +| 2021-09 | CT#93e | C4-214712 | 0056 | 1 | A | LCS Service Type | 17.2.0 | +| 2021-09 | CT#93e | C4-214826 | 0054 | 1 | B | Multiple QoS Class | 17.2.0 | +| 2021-09 | CT#93e | C4-214766 | 0057 | - | F | 29.515 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94e | C4-215455 | 0059 | - | B | Higher Resolution Timestamp for Location Estimates | 17.3.0 | +| 2021-12 | CT#94e | C4-216164 | 0063 | - | A | Correct the table name of SuccessType | 17.3.0 | +| 2021-12 | CT#94e | C4-216520 | 0065 | 1 | A | Add the missing pseudonymIndicator IE in OpenAPI | 17.3.0 | +| 2021-12 | CT#94e | C4-216534 | 0067 | 1 | A | Information for HGMMLC Discovery | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213174 | 0069 | 2 | A | LCS Service Type in MO-LR | 17.3.0 | +| 2021-12 | CT#94e | C4-216481 | 0070 | - | F | 29.515 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95e | C4-220339 | 0074 | 1 | F | Editorial corrections | 17.4.0 | +| 2022-03 | CT#95e | C4-220368 | 0072 | 1 | B | Schedule location time for GMLC | 17.4.0 | +| 2022-03 | CT#95e | C4-221352 | 0076 | - | F | Editorial corrections | 17.4.0 | +| 2022-03 | CT#95e | C4-221603 | 0077 | - | F | 29.515 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221022 | 0079 | - | B | Scheduled location time for bulk operation | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0081 | - | F | 29.515 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97e | CP-222036 | 0082 | 1 | F | Indication of Network Assisted Positioning method | 17.6.0 | +| 2022-09 | CT#97e | CP-222058 | 0083 | - | F | 29.515 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98e | CP-223028 | 0084 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0085 | - | F | 29.515 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230065 | 0090 | - | F | Correction on the figure of EventNotify | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0093 | 2 | B | Location service in PNI-NPN with signalling optimisation | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0094 | 1 | B | Support of LMF selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0095 | 1 | B | Support of location comparison task | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0096 | 2 | B | Support of low power and high accuracy positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0098 | - | F | 29.515 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0097 | 3 | F | Location header description | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0100 | 1 | B | Add NWDAF as GMLC service consumer | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0101 | - | F | Miscellaneous corrections | 18.2.0 | +| 2023-06 | CT#100 | CP-231075 | 0103 | 1 | A | Missing finer periodicities than 1s and an infinite reporting amount | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0105 | 2 | B | Support of event report allowed area | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0109 | 1 | F | Update the incorrect reference | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0110 | - | B | OAuth2 scopes in the Ngmlc_Location API | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0112 | 2 | B | Add reporting indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0113 | - | F | Wrong reference number | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0114 | - | F | 29.515 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232035 | 0117 | 1 | F | Correction on Reporting Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232063 | 0119 | - | A | Missed HA GNSS Metrics Support over SBI | 18.3.0 | +| 2023-09 | CT#101 | CP-232053 | 0120 | - | B | Support of 5GC-MT-LR procedure involving Mobile Base Station Relay | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0121 | 1 | B | Support on NLOS/LOS measurement indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232062 | 0124 | 1 | A | Add GNSS integrity requirement | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0125 | - | F | 29.515 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233037 | 0116 | 5 | B | Periodic or triggered location events via user plane to an LCS Client or AF | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0127 | 1 | B | Addition of missing interface between LMF and GMLC | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0128 | - | F | Correction on the description of scheduledLocTime | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0129 | - | B | Resolve Editor's note | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0130 | - | B | Support on Indoor/Outdoor indication | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0131 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233072 | 0136 | - | A | Incomplete CR implementation | 18.4.0 | +| 2023-12 | CT#102 | CP-233295 | 0137 | 4 | B | Update on Ngmlc_Location_ProvideLocation service for ranging SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0138 | 2 | F | Reporting Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0139 | 1 | B | Multiple QoS for Deferred Location Service Continuation from 5GS to EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0140 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0144 | - | F | 29.515 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29523/raw.md b/gsma/29_series/29523/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..d0990d5dd35f1ecb1d6543d7e8024331e239b500 --- /dev/null +++ b/gsma/29_series/29523/raw.md @@ -0,0 +1,1989 @@ + + +# 3GPP TS 29.523 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Policy Control Event Exposure Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +3GPP, 5G System + +## **3GPP** + +## --- **Postal address** + +## --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTETM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Npcf_EventExposure Service ..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 8 | +| 4.1.3 Network Functions ..... | 9 | +| 4.1.3.1 Policy Control Function (PCF) ..... | 9 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 10 | +| 4.2.1 Introduction ..... | 10 | +| 4.2.2 Npcf_EventExposure_Subscribe service operation..... | 10 | +| 4.2.2.1 General..... | 10 | +| 4.2.2.2 Creating a new subscription..... | 11 | +| 4.2.2.3 Modifying an existing subscription ..... | 13 | +| 4.2.3 Npcf_EventExposure_UnSubscribe service operation..... | 14 | +| 4.2.3.1 General..... | 14 | +| 4.2.3.2 Unsubscription from event notifications..... | 14 | +| 4.2.4 Npcf_EventExposure_Notify service operation..... | 15 | +| 4.2.4.1 General..... | 15 | +| 4.2.4.2 Notification about subscribed events ..... | 15 | +| 5 Npcf_EventExposure Service API..... | 18 | +| 5.1 Introduction ..... | 18 | +| 5.2 Usage of HTTP..... | 18 | +| 5.2.1 General ..... | 18 | +| 5.2.2 HTTP standard headers ..... | 18 | +| 5.2.2.1 General..... | 18 | +| 5.2.2.2 Content type..... | 18 | +| 5.2.3 HTTP custom headers ..... | 19 | +| 5.2.3.1 General..... | 19 | +| 5.3 Resources ..... | 19 | +| 5.3.1 Resource Structure..... | 19 | +| 5.3.2 Resource: Policy Control Events Subscriptions (Collection)..... | 19 | +| 5.3.2.1 Description..... | 19 | +| 5.3.2.2 Resource definition ..... | 20 | +| 5.3.2.3 Resource Standard Methods ..... | 20 | +| 5.3.2.3.1 POST ..... | 20 | +| 5.3.2.4 Resource Custom Operations..... | 20 | +| 5.3.3 Resource: Individual Policy Control Events Subscription (Document)..... | 20 | +| 5.3.3.1 Description..... | 20 | +| 5.3.3.2 Resource definition ..... | 21 | +| 5.3.3.3 Resource Standard Methods ..... | 21 | +| 5.3.3.3.1 GET ..... | 21 | +| 5.3.3.3.2 PUT ..... | 22 | +| 5.3.3.3.3 DELETE..... | 23 | +| 5.3.3.4 Resource Custom Operations..... | 24 | +| 5.4 Custom Operations without associated resources ..... | 24 | +| 5.5 Notifications ..... | 25 | +| 5.5.1 General ..... | 25 | +| 5.5.2 Policy Control Event Notification ..... | 25 | + +| | | | +|---------------------------------------------------------|------------------------------------------|-----------| +| 5.5.2.1 | Description ..... | 25 | +| 5.5.2.2 | Target URI ..... | 25 | +| 5.5.2.3 | Standard Methods ..... | 25 | +| 5.5.2.3.1 | POST ..... | 25 | +| 5.6 | Data Model..... | 26 | +| 5.6.1 | General ..... | 26 | +| 5.6.2 | Structured data types ..... | 28 | +| 5.6.2.1 | Introduction..... | 28 | +| 5.6.2.2 | Type PcEventExposureSubsc ..... | 29 | +| 5.6.2.3 | Type PcEventExposureNotif ..... | 30 | +| 5.6.2.4 | Type ReportingInformation ..... | 31 | +| 5.6.2.5 | Type ServiceIdentification..... | 32 | +| 5.6.2.6 | Type EthernetFlowInfo ..... | 32 | +| 5.6.2.7 | Type IpFlowInfo ..... | 32 | +| 5.6.2.8 | Type PcEventNotification..... | 33 | +| 5.6.2.9 | Type PduSessionInformation..... | 34 | +| 5.6.2.10 | Type SnssaiDnnCombination ..... | 34 | +| 5.6.3 | Simple data types and enumerations ..... | 34 | +| 5.6.3.1 | Introduction..... | 34 | +| 5.6.3.2 | Simple data types ..... | 34 | +| 5.6.3.3 | Enumeration: PcEvent ..... | 34 | +| 5.7 | Error handling ..... | 35 | +| 5.7.1 | General ..... | 35 | +| 5.7.2 | Protocol Errors..... | 35 | +| 5.7.3 | Application Errors ..... | 35 | +| 5.8 | Feature negotiation..... | 35 | +| 5.9 | Security..... | 36 | +| Annex A (normative): OpenAPI specification ..... | | 37 | +| A.1 | General..... | 37 | +| A.2 | Npcf_EventExposure API..... | 37 | +| Annex B (informative): Change history ..... | | 45 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Policy Control Event Exposure Service of the 5G System. It provides stage 3 protocol definitions, message flows and specifies the API for the Npcf Event Exposure service. + +The 5G System stage 2 architecture and the procedures are specified in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [8]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The Policy Control Event Exposure Service is provided by the Policy Control Function (PCF). This service exposes policy control events observed at the PCF. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. + - For a specific reference, subsequent revisions do not apply. + - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [8] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [9] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [10] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [11] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". +- [12] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [13] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [14] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [15] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [16] IETF RFC 9113: "HTTP/2". + +- [17] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [18] IETF RFC 9457: "Problem Details for HTTP APIs". +- [19] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [20] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [21] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [22] 3GPP TR 21.900: "Technical Specification Group working methods". +- [23] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". +- [24] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [25] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**example:** text used to clarify abstract rules by applying them literally. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|---------|-------------------------------------------------------| +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| API | Application Programming Interface | +| ATSSS | Access Traffic Steering, Switching and Splitting | +| DNN | Data Network Name | +| ePDG | evolved Packet Data Gateway | +| GEO | Geosynchronous Orbit | +| GPSI | Generic Public Subscription Identifier | +| HTTP | Hypertext Transfer Protocol | +| LEO | Low Earth Orbit | +| MA | Multi-Access | +| MEO | Medium Earth Orbit | +| NEF | Network Exposure Function | +| NID | Network Identifier | +| NF | Network Function | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| OAM | Operation And Maintenance | +| PCF | Policy Control Function | +| RFSP | RAT Frequency Selection Priority | +| SAC | Service Area Coverage | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SUPI | Subscription Permanent Identifier | + +| | | +|------|---------------------------| +| UDM | Unified Data Management | +| UDR | Unified Data Repository | +| URSP | UE Route Selection Policy | + +# --- 4 Npcf\_EventExposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Policy Event Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +This service: + +- allows NF service consumers to subscribe to, modify and unsubscribe from policy control events; and +- notifies NF service consumers with a corresponding subscription about observed events on the PCF. + +The types of observed events include: + +- PLMN identifier notification; + +NOTE 1: Within the PLMN identifier notification event the PLMN Identifier or SNPN Identifier where the UE is currently located is provided. The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 2: Mobility between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- access type change; +- satellite backhaul category change; +- service area coverage change; +- successful or unsuccessful outcome of the UE Policy Delivery; and +- application traffic detection events. + +The target of the event reporting may include a group of UE(s) or any UE (i.e. all UEs). When an event occurs, to which the NF service consumer has subscribed, the PCF reports the requested information to the NF service consumer based on the event reporting information definition requested by the NF service consumer (see 3GPP TS 23.502 [3], clause 4.15.1). + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture and signalling flows are also described in 3GPP TS 29.513 [8]. + +The Policy Event Exposure Service (Npcf\_EventExposure) is part of the Npcf service-based interface exhibited by the Policy Control Function (PCF). + +The known NF service consumers of the Npcf\_EventExposure service are the Network Exposure Function (NEF) and the Application Function (AF). + +The Npcf\_EventExposure service is provided by the PCF and consumed by NF service consumers (e.g. NEF, AF), as shown in figure 4.1.2-1 for the SBI representation model and in figure 4.1.2-2 for reference point representation model. + +![Figure 4.1.2-1: Npcf_EventExposure service Architecture, SBI representation. The diagram shows a PCF box containing an oval labeled 'Npcf'. A line labeled 'Npcf_EventExposure' extends from the 'Npcf' oval down to a horizontal bus line. Below this bus line, two boxes labeled 'NEF' and 'AF' are connected via vertical lines.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 4.1.2-1: Npcf\_EventExposure service Architecture, SBI representation. The diagram shows a PCF box containing an oval labeled 'Npcf'. A line labeled 'Npcf\_EventExposure' extends from the 'Npcf' oval down to a horizontal bus line. Below this bus line, two boxes labeled 'NEF' and 'AF' are connected via vertical lines. + +Figure 4.1.2-1: Npcf\_EventExposure service Architecture, SBI representation + +![Figure 4.1.2-2: Npcf_EventExposure service Architecture, reference point representation. The diagram shows a box labeled 'PCF' at the top. Two lines, labeled 'N5' and 'N30', extend from the bottom of the 'PCF' box to two boxes labeled 'AF' and 'NEF' respectively, which are positioned side-by-side at the bottom.](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +Figure 4.1.2-2: Npcf\_EventExposure service Architecture, reference point representation. The diagram shows a box labeled 'PCF' at the top. Two lines, labeled 'N5' and 'N30', extend from the bottom of the 'PCF' box to two boxes labeled 'AF' and 'NEF' respectively, which are positioned side-by-side at the bottom. + +Figure 4.1.2-2: Npcf\_EventExposure service Architecture, reference point representation + +NOTE: The NWDAF and the DCCF can be consumers of the Npcf\_EventExposure service to perform data collection. However, there is no data collected from the PCF by the NWDAF or the DCCF defined in this release of the specification. + +### 4.1.3 Network Functions + +#### 4.1.3.1 Policy Control Function (PCF) + +The PCF (Policy Control Function) is a functional element that encompasses policy control decision and flow based charging control functionalities as defined in 3GPP TS 29.512 [9], access and mobility policy decisions for the control of the UE Service Area Restrictions and RAT/RFSP control as defined in 3GPP TS 29.507 [10] and UE Policy decisions for the control of Access network discovery and selection policy and UE Route Selection Policy (URSP) as defined in 3GPP TS 29.525 [11]. + +The policy control decision and flow based charging control functionalities enable the PCF to provide network control regarding the service data flow detection, gating, QoS and flow based charging (except credit management) towards the SMF/UPF. The PCF offers these capabilities to the NF service consumers (e.g. the AF and NEF) as defined in 3GPP TS 29.514 [12] and 3GPP TS 29.214 [13]. + +The PCF also offers the access and mobility policy control to the NF service consumers as defined in 3GPP TS 29.534 [23]. + +The Policy Event Exposure Service enables the PCF to report policy control events observed in one or more PCF services to NF service consumers. + +#### 4.1.3.2 NF Service Consumers + +As indicated in clause 4.1.2 above, the known NF service consumer of the Npcf\_EventExposure service are the Network Exposure Function (NEF) and the Application Function (AF). + +The Network Exposure Function (NEF) is a functional element that supports the following functionalities: + +- The NEF securely exposes network capabilities and events provided by 3GPP NFs to AF. +- The NEF provides a means for the AF to securely provide information to 3GPP network and can authenticate, authorize and assist in throttling the AF. +- The NEF translates the information received from the AF to the one sent to internal 3GPP NFs, and vice versa. +- The NEF supports exposing information (collected from other 3GPP NFs) to the AF. + +The Application Function (AF) is a functional element offering control to applications that require the policy and charging control of traffic plane resources; specific user plane paths for the requested traffic, the monitoring of the required service QoS, and/or specific QoS and alternative QoS profiles. The AF uses the Npcf\_EventExposure service to receive exposed information from the 5GC network. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Npcf\_EventExposure Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Npcf\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Npcf_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe for event notifications on a specified policy control event for a group of UE(s) or any UE, or to modify a subscription. | NF service consumer (e.g. NEF) | +| Npcf_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF service consumer (e.g. NEF) | +| Npcf_EventExposure_Notify | This service operation is used by the PCF to report UE related policy control event(s) to the NF service consumer which has subscribed to the event report service. | PCF | + +### 4.2.2 Npcf\_EventExposure\_Subscribe service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to explicitly subscribe for policy events notifications on a specified context for a group of UE(s) or any UE, or to modify an existing subscription. + +The following are the types of events for which a subscription can be made: + +- PLMN identifier notification; + +NOTE 1: Within the PLMN identifier notification event the PLMN Identifier or SNPN Identifier where the UE is currently located is provided. The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 2: Mobility between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- change of Access Type; +- when the feature "AMPoliciesEvents" is supported, change of Service Area Coverage; + +- when the feature "SatelliteBackhaul" is supported, satellite backhaul category change; +- when the feature "DeliveryOutcome" is supported, UE Policy delivery outcome; and +- when the feature "AppDetection" is supported, application traffic detection (Start/Stop) event notification. + +The following procedures using the Npcf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +NOTE 3: It is also possible to implicitly subscribe for policy events notifications for a single UE, for a group of UE(s) or any UE. Implicit subscription information is obtained from the UDR for application data. In this case, the PCF will use the callback URI provided by the AF to the UDR, see 3GPP TS 29.519 [24] for the details. + +#### 4.2.2.2 Creating a new subscription + +Figure 4.2.2.2-1 illustrates the creation of a subscription. + +![Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the PCF, and the PCF responds with a 201 Created status. + +**Figure 4.2.2.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request with: "{apiRoot}/npcf-eventexposure/v1/subscriptions" as request URI as shown in figure 4.2.2.2-1, step 1, and the "PcEventExposureSubsc" data structure as request body. + +The "PcEventExposureSubsc" data structure shall include: + +- identification of the policy events to subscribe as "eventSubs" attribute; +- indication of the UEs to which the subscription applies via: + - a) identification of a group of UE(s) via a "groupId" attribute; or + - b) identification of any UE by omitting the "groupId" attribute; +- a URI where to receive the requested notifications as "notifUri" attribute; and +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute. + +The "PcEventExposureSubsc" data structure may also include: + +- description of the event reporting information as "eventsRepInfo", which may include: + - a) event notification method (periodic, one time, on event detection) as "notifMethod" attribute; + - b) Maximum Number of Reports as "maxReportNbr" attribute; + - c) Monitoring Duration as "monDur" attribute; + +- d) repetition period for periodic reporting as "repPeriod" attribute; + - e) immediate reporting indication as "immRep" attribute; + - f) sampling ratio as "sampRatio" attribute; + - g) group reporting guard time as "grpRepTime" attribute; + - h) partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; and/or + - i) a notification flag as "notifFlag" attribute if the EneNA feature is supported; +- if the supported feature "ExtendedSessionInformation" is supported, to filter the AF sessions for which the policy event report shall occur, the identification of the services one or more AF sessions may belong to as "filterServices" attribute, which may include per service identification: + - a) a list of ethernet flows in the "servEthFlows" attribute; or + - b) a list of IP flows in the "servIpFlows" attribute; and/or + - c) an AF application identifier in the "afAppId" attribute; + - to filter the DNNs for which the policy event report shall occur, the identification of the DNNs in the "filterDnns" attribute; + - to filter the S-NSSAIs for which the policy event report shall occur, the identification of the S-NSSAIs in the "filterSnssais" attribute; + - when the feature "EneNA" and/or "AppDetection" are supported, to filter the specific DNN and S-NSSAI combination list for which the policy event report shall occur, the identification of each combination within the "snssaiDnn" attribute; and + - when the feature "AppDetection" is supported, to indicate the specific application(s) for which the policy event report shall occur, the application identifier(s) in the "appIds" attribute. + +If the PCF cannot successfully fulfil the received HTTP POST request due to an internal PCF error or an error in the HTTP POST request, the PCF shall send an HTTP error response as specified in clause 5.7. + +Upon successful reception of the HTTP POST request with "{apiRoot}/npcf-eventexposure/v1/subscriptions" as request URI and "PcEventExposureSubsc" data structure as request body, the PCF shall create a new "Individual Policy Events Subscription" resource, store the subscription and send a HTTP "201 Created" response as shown in figure 4.2.2.2-1, step 2. The PCF shall include in the "201 Created" response: + +- a Location header field; and +- an "PcEventExposureSubsc" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId}". + +The "PcEventExposureSubsc" data type in the response content shall contain the representation of the created "Individual Policy Events Subscription". + +When the "monDur" attribute is included in the response, it represents a server selected expiry time that is equal or less than a possible expiry time in the request. + +When the "immRep" attribute set to true is included in the subscription and the subscribed policy control events are available: + +- if the feature "ERIR" is not supported, the PCF shall immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) using the Npcf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. +- if the feature "ERIR" is supported, the PCF shall immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "201 Created" response as shown in + +figure 4.2.2.2-1, step 2. The "PcEventExposureSubsc" data type shall include the corresponding event(s) notification within the "eventNotifs" attribute, as described in clause 4.2.4.2. + +When the sampling ratio as the "sampRatio" attribute is included in the subscription without a "partitionCriteria" attribute, the PCF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the PCF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time as the "grpRepTime" attribute is included in the subscription, the PCF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the PCF shall notify the NF service consumer using the Npcf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the PCF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). + +**Editor's Note:** It is FFS to determine whether any further provisions or limitations with regard to the usage of the "notifFlag" attribute are needed. + +**Editor's Note:** When the PCF accepts the subscription from the NF service consumer, whether the PCF is required to subscribe to other NF is FFS. + +##### 4.2.2.3.3 Modifying an existing subscription + +Figure 4.2.2.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the PCF. The PCF responds with either a 200 OK or a 204 No Content.](5a9282ac54ca7bc50f1d2ab6cfb376ba_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PUT .../subscriptions/{subscriptionId} + NF service consumer->>PCF: Request + Note left of PCF: 2a. 200 OK +2b. 204 No Content + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the modification of an existing subscription. An NF service consumer sends a PUT request to the PCF. The PCF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.3-1: Modification of an existing subscription** + +To modify an existing subscription to event notifications, the NF service consumer shall send an HTTP PUT request with: "{apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId}" as request URI, as shown in figure 4.2.2.3-1, step 1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "PcEventExposureSubsc" data structure is included as request body as described in clause 4.2.2.2. + +NOTE 1: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the PUT. + +NOTE 2: The "notifUri" attribute within the PcEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the PCF cannot successfully fulfil the received HTTP PUT request due to an internal PCF error or an error in the HTTP PUT request, the PCF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP PUT request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of an HTTP PUT request with: "{apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId}" as request URI and "PcEventExposureSubsc" data structure as + +request body, the PCF shall store the subscription and send an HTTP "200 OK" response with the "PcEventExposureSubsc" data structure as response body or an HTTP "204 No Content" response, as shown in figure 4.2.2.3-1, step 2. + +The "PcEventExposureSubsc" data structure in the response content shall contain the representation of the modified "Individual Policy Events Subscription". + +When the "monDur" attribute is included in the response, it represents a NF service producer selected expiry time that is equal or less than a possible expiry time received in the request. + +When the "immRep" attribute set to true is included in the updated subscription and the subscribed policy control events are available: + +- if the feature "ERIR" is not supported, the PCF shall immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) using the Npcf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. +- if the feature "ERIR" is supported, the PCF shall immediately notify the NF service consumer with the current available value(s) for the subscribed event(s) within the HTTP "200 OK" response as shown in figure 4.2.2.3-1, step 2a. The "PcEventExposureSubsc" data type shall include the corresponding event(s) notification within the "eventNotifs" attribute, as described in clause 4.2.4.2. + +When the sampling ratio as the "sampRatio" attribute is included in the subscription without a "partitionCriteria" attribute, the PCF shall select a random subset of UEs among the target UEs according to the sampling ratio and only report the event(s) related to the selected subset of UEs. If the "partitionCriteria" attribute is additionally included, then the PCF shall first partition the UEs according to the value of the "partitionCriteria" attribute and then select a random subset of UEs from each partition according to the sampling ratio and only report the event(s) related to the selected subsets of UEs. + +When the group reporting guard time as the "grpRepTime" attribute is included in the subscription, the PCF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the PCF shall notify the NF service consumer using the Npcf\_EventExposure\_Notify service operation, as described in clause 4.2.4.2. + +When the "notifFlag" attribute is included, and set to "DEACTIVATE" in the request, the PCF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the "notifFlag" attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer); if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the PCF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the "notifFlag" attribute is set to "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the PCF shall unmute the event notification, i.e. start sending again notifications for available events. + +**Editor's Note:** It is FFS to determine whether any further provisions or limitations with regard to the usage of the "notifFlag" attribute are needed. + +**Editor's Note:** When the PCF accepts the subscription modification from the NF service consumer, whether the PCF is required to subscribe to other NF is FFS. + +### 4.2.3 Npcf\_EventExposure\_UnSubscribe service operation + +#### 4.2.3.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Npcf\_EventExposure\_UnSubscribe service operation is supported: + +- unsubscription from event notifications. + +#### 4.2.3.2 Unsubscription from event notifications + +Figure 4.2.3.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the interaction between an NF service consumer and a PCF for unsubscribing from event notifications. Step 1: The consumer sends a DELETE request to the PCF. Step 2: The PCF responds with a 204 No Content status.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>PCF: Request + Note left of PCF: 2. "204 No Content" + PCF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a PCF for unsubscribing from event notifications. Step 1: The consumer sends a DELETE request to the PCF. Step 2: The PCF responds with a 204 No Content status. + +**Figure 4.2.3.2-1: Unsubscription from event notifications** + +To unsubscribe from event notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId}" as request URI, as shown in figure 4.2.3.2-1, step 1, where "{subscriptionId}" is the subscription correlation identifier of the existing resource subscription that is to be deleted. + +If the PCF cannot successfully fulfil the received HTTP DELETE request due to an internal PCF error or an error in the HTTP DELETE request, the PCF shall send the HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the PCF determines the received HTTP DELETE request needs to be redirected, the PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP DELETE request with: "{apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId}" as request URI, the PCF shall remove the corresponding subscription and send an HTTP "204 No Content" response as shown in figure 4.2.3.2-1, step 2. + +### 4.2.4 Npcf\_EventExposure\_Notify service operation + +#### 4.2.4.1 General + +The Npcf\_EventExposure\_Notify service operation enables the PCF to notify the NF service consumers that the previously (explicitly or implicitly) subscribed policy control event occurred. + +The following procedure using the Npcf\_EventExposure\_Notify service operation is supported: + +- notification about subscribed events. + +#### 4.2.4.2 Notification about subscribed events + +Figure 4.2.4.2-1 illustrates the notification about subscribed events. + +![Sequence diagram showing the notification process between a PCF and an NF service consumer. The PCF sends a POST {notifUri} request to the NF service consumer, and the NF service consumer responds with a 204 No Content.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant NF as NF service consumer + Note right of PCF: 1. POST {notifUri} + PCF->>NF: Request + Note left of NF: 2. "204 No Content" + NF-->>PCF: Response + +``` + +Sequence diagram showing the notification process between a PCF and an NF service consumer. The PCF sends a POST {notifUri} request to the NF service consumer, and the NF service consumer responds with a 204 No Content. + +**Figure 4.2.4.2-1: Notification about subscribed events** + +If the PCF observes policy control related event(s) for which an NF service consumer has subscribed explicitly as defined in clause 4.2.2 or implicitly when the subscription information is obtained from the UDR for application data, the PCF shall send an HTTP POST request as shown in figure 4.2.4.2-1, step 1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription or containing the callback URI provided by the AF to the UDR, and the "PcEventExposureNotif" data structure. + +The "PcEventExposureNotif" data structure shall include: + +- The notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute or obtained from the UDR as specified in 3GPP TS 29.519 [24]; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "PcEventNotification" data structure that shall include: + 1. the Policy Control event as "event" attribute; + 2. for an access type change: + - a) new access type as "accType" attribute; + - b) the new RAT type as "ratType" attribute, if applicable for the notified access type; and + - c) if the "ATSSS" feature is supported: + - i. if it is the first access type report for a PDU session, and both, 3GPP and non-3GPP access information is available, the "addAccessInfo" attribute. The "addAccessInfo" attribute contains the additional access type information, where the access type is encoded in the "accessType" attribute, and the RAT type is encoded in the "ratType" attribute when applicable for the notified access type; + - ii. if it is a subsequent access type change report: + - if a new access type is added to the MA PDU session, the "addAccessInfo" attribute with the added access type encoded in the "accessType" attribute, and the RAT type encoded in the "ratType" attribute when applicable for the notified access type; + - if an access type is released in the MA PDU session, the "relAccessInfo" attribute with the released access type encoded in the "accessType" attribute, and the RAT type encoded in the "ratType" attribute when applicable for the notified access type; and + - d) for EPC interworking scenarios, the ePDG address as "anGwAddr" attribute, if applicable for the notified access type; + 3. for a PLMN change: + +NOTE 1: For a MA PDU session, if the "ATSSS" feature is not supported by the AF, the PCF includes the "accessType" attribute and the "ratType" attribute with a currently active combination of access type and RAT type (if applicable for the notified access type). When both 3GPP and non-3GPP accesses are available, the PCF includes the information corresponding to the 3GPP access. + +- a) new network identity containing the PLMN Identifier or the SNPN Identifier in the "plmnId" attribute; + +NOTE 2: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 3: Mobility between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +4. when the feature "AMPoliciesEvents" is supported, for a service area coverage change, the new service area coverage in the "appliedCov" attribute, encoded as specified in 3GPP TS 29.534 [23], clause 4.2.7.4; + +NOTE 4: The service area coverage change event is met and the notification is triggered when the PCF determines the tracking areas where the service is allowed in relation to the NF consumer requested service area coverage. The actual service area coverage for the UE might be larger than the one reported with the service area coverage change event. + +5. for a satellite backhaul category change: + +- a) when the "SatelliteBackhaul" feature is supported: + - i) the satellite backhaul category (i.e., "GEO", "MEO", "LEO", or "OTHER\_SAT") or the indication of non-satellite backhaul category (i.e., "NON\_SATELLITE") in the "satBackhaulCategory" attribute; or +- b) when dynamic satellite backhaul is used by the NG-RAN and the feature "EnSatBackhaulCatChg" is supported: + - i) the dynamic satellite backhaul category (i.e., "DYNAMIC\_GEO", "DYNAMIC\_MEO", "DYNAMIC\_LEO", or "DYNAMIC\_OTHER\_SAT") in the "satBackhaulCategory" attribute; + +6. when the feature "DeliveryOutcome" is supported, to report the unsuccessful outcome of the UE Policy Delivery related to the invocation of AF provisioned service parameters, the reason of failure within the "delivFailure" attribute; + +7. the identity of the affected UE in the "supi" attribute and, if available, in the "gpsi" attribute; + +8. the time at which the event was observed encoded as "timeStamp" attribute; + +9. if available, and if the feature "ExtendedSessionInformation" is supported, information about the PDU session involved in the reported event in the "pduSessInfo" attribute, that shall include: + +- a) the S-NSSAI of the PDU session in the "snssai" attribute; +- b) the DNN of the PDU session in the "dnn" attribute; and +- c) the IPv4 address in the "ueIpv4" attribute and/or the IPv6 prefix in the "ueIpv6" attribute, or the Ethernet MAC address in the "ueMac" attribute; and + +if the IPv4 address is included in the "ueIpv4" attribute, may include the IP domain in the "ipDomain" attribute; + +10. if available, and if the feature "ExtendedSessionInformation" is supported, information about the services involved in the reported event in the indicated PDU session in the "repServices" attribute, which may include per identified service: + +- a) a list of Ethernet flows in the "servEthFlows" attribute which contains an impacted Ethernet flow number within the "flowNumber" attribute in each EthernetFlowInfo data structure; or +- b) a list of IP flows in the "servIpFlows" attribute which contains an impacted IP flow number within the "flowNumber" attribute in each IpFlowInfo data structure; and/or +- c) an AF application identifier in the "afAppId" attribute. + +11. for an application detection event and if the feature "AppDetection" is supported: + +- a) the IPv4 address in the "ueIpv4" attribute and/or the IPv6 prefix in the "ueIpv6" attribute within the "pduSessInfo" attribute; and +- b) the application identifier for which the notification applies in the "appId" attribute. + +If the NF service consumer cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Upon successful reception of the HTTP POST request with "{notifUri}" as request URI and a "PcEventExposureNotif" data structure as request body, the NF service consumer shall send a "204 No Content" HTTP response, as shown in figure 4.2.4.2-1, step 2, for a successful processing. + +# --- 5 Npcf\_EventExposure Service API + +## 5.1 Introduction + +The Npcf\_EventExposure Service shall use the Npcf\_EventExposure API. + +The API URI of the Npcf\_EventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npcf-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [16], shall be used as specified in clause 5.2 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [7] specification of HTTP messages and content bodies for the Npcf\_EventExposure is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [17], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [18]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5] may be supported. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_EventExposure API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Npcf\_EventExposure API. + +![Diagram showing the resource URI structure for the Npcf_EventExposure API. The root is {apiRoot}/npcf-eventexposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing {subscriptionId}.](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npcf-eventexposure/v1"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["{subscriptionId}"] + +``` + +Diagram showing the resource URI structure for the Npcf\_EventExposure API. The root is {apiRoot}/npcf-eventexposure/v1. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing {subscriptionId}. + +Figure 5.3.1-1: Resource URI structure of the Npcf\_EventExposure API + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 5.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Policy Control Events Subscriptions | /subscriptions | POST | Subscription to the notification of policy control events and creation of an Individual Policy Control Events Subscription resource. | +| Individual Policy Control Events Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Policy Control Events Subscription resource. | +| | | PUT | Modifies an Individual Policy Control Events Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of policy control events. | + +### 5.3.2 Resource: Policy Control Events Subscriptions (Collection) + +#### 5.3.2.1 Description + +The Policy Control Events Subscriptions resource represents all subscriptions of the Npcf\_EventExposure service at a given PCF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-eventexposure/v1/subscriptions + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| PcEventExposure Subsc | M | 1 | Contains the information required for the creation of a new individual policy control events subscription. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------| +| PcEventExposure Subsc | M | 1 | 201 Created | Contains the representation of the Individual Policy Control Events Subscription resource. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. | | | | | + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId} | + +#### 5.3.2.4 Resource Custom Operations + +None. + +### 5.3.3 Resource: Individual Policy Control Events Subscription (Document) + +#### 5.3.3.1 Description + +The Individual Policy Control Events Subscription resource represents a single subscription of the Npcf\_EventExposure service at a given PCF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 5.3.3.2-1. + +**Table 5.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subscriptionId | string | Identifies a subscription to the PCF event exposure service. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.3.3.1-1. + +**Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.1-3. + +**Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| PcEventExposureSubscriptions | M | 1 | 200 OK | A representation of the Individual Policy Control Events Subscription is returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-------------------------------------------------------------------------------| +| PcEventExposureSubscription | M | 1 | Modifies the existing Individual Policy Control Events Subscription resource. | + +**Table 5.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| PcEventExposureSubs
c | M | 1 | 200 OK | Successful case: The Individual Policy Control Events Subscription was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case: The Individual Policy Control Events Subscription was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected | + +##### 5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3-1. + +**Table 5.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.3-2 and the response data structures and response codes specified in table 5.3.3.3.3-3. + +**Table 5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The Individual Policy Control Events Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription termination.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +#### 5.3.3.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [5] and clause 4.6.2.3 of 3GPP TS 29.501 [6]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------|--------------|---------------------------------|-------------------------------------------------| +| Policy Control Event Notification | {notifUri} | POST | Notification of policy control event reporting. | + +### 5.5.2 Policy Control Event Notification + +#### 5.5.2.1 Description + +The Policy Control Event Notification is used by the PCF to report one or several observed policy control events to the NF service consumer that has subscribed to such notifications. + +NOTE 1: The "callback" clause of the OpenAPI specification found in Annex A.2 associated to the POST method of the "Policy Control Events Subscriptions" resource is used as the notification request for both explicit and implicit subscriptions. + +NOTE 2: For implicit subscriptions, the NEF can have previously stored in the UDR the notification URI to be used in the notifications initiated by the PCF. See 3GPP TS 29.519 [24] for the details. + +#### 5.5.2.2 Target URI + +The Callback URI "{notifUri}" shall be used with the callback URI variables defined in table 5.5.2.2-1. + +**Table 5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|--------------------------------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned by the NF service consumer either during the explicit subscription service operation and described within the PcEventExposureSubsc data type (see table 5.6.2.2-1) or during the implicit subscription via the provisioning of the corresponding application data in UDR (see 3GPP TS 29.519 [24]). (NOTE). | +| NOTE: When obtained from the UDR, it corresponds to the notification URI previously stored by the NEF. | | | + +#### 5.5.2.3 Standard Methods + +##### 5.5.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.2.3.1-1. + +**Table 5.5.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.5.2.3.1-2 and the response data structures and response codes specified in table 5.5.2.3.1-3. + +**Table 5.5.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------| +| PcEventExposureNotif | M | 1 | Provides Information about observed policy control events | + +**Table 5.5.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during event notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of 3GPP TS 29.500 [5] for the POST method shall also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (see clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification request is redirected. | + +**Table 5.5.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_EventExposure service based interface protocol. + +Table 5.6.1-1: Npcf\_EventExposure specific Data Types + +| Data type | Section defined | Description | Applicability | +|-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| EthernetFlowInfo | 5.6.2.6 | Identification of an UL/DL ethernet flow. | ExtendedSession Information | +| IpFlowInfo | 5.6.2.7 | Identification of an UL/DL IP flow. | ExtendedSession Information | +| PcEvent | 5.6.3.3 | Policy Control Events. | | +| PcEventExposureNotif | 5.6.2.3 | Describes notifications about Policy Control events that occurred in an Individual Policy Events Subscription resource. | | +| PcEventExposureSubsc | 5.6.2.2 | Represents an Individual Policy Events Subscription resource. | | +| PcEventNotification | 5.6.2.8 | Represents the information reported for a Policy Control event. | | +| PduSessionInformation | 5.6.2.9 | Represents PDU session identification information. | ExtendedSession Information
AppDetection | +| ReportingInformation | 5.6.2.4 | Represents the type of reporting the subscription requires. | | +| ServiceIdentification | 5.6.2.5 | Identification of the service to which the subscription applies. | ExtendedSession Information | +| SnsaiDnnCombination | 5.6.2.10 | Represents a combination of S-NSSAI and DNN(s). | EneNA | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_EventExposure service based interface. + +Table 5.6.1-2: Npcf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|-----------------------------------------------------------------------------------------------------------|-----------------------------| +| AccessType | 3GPP TS 29.571 [14] | Access Type. | | +| AdditionalAccessInfo | 3GPP TS 29.512 [9] | Indicates the combination of additional Access Type and RAT Type for MA PDU session. | ATSSS | +| AfAppId | 3GPP TS 29.514 [12] | AF application Identifier. | ExtendedSession Information | +| AnGwAddress | 3GPP TS 29.514 [12] | Carries the control plane address of the EPC untrusted non-3GPP access network gateway. (NOTE 1) | | +| ApplicationId | 3GPP TS 29.571 [14] | Application Identifier. | AppDetection | +| DateTime | 3GPP TS 29.571 [14] | Time stamp. | | +| Dnn | 3GPP TS 29.571 [14] | Identifies a DNN. | | +| DurationSec | 3GPP TS 29.571 [14] | Seconds of duration. | | +| EthFlowDescription | 3GPP TS 29.514 [12] | Identifies an ethernet flow description. (NOTE 2) | ExtendedSession Information | +| Failure | 3GPP TS 29.522 [25] | Indicates the failure reason for an unsuccessful outcome of the UE Policy Delivery. | DeliveryOutcome | +| FlowDescription | 3GPP TS 29.514 [12] | Identifies an IP flow description. | ExtendedSession Information | +| Gpsi | 3GPP TS 29.571 [14] | Generic Public Subscription Identifier. | | +| GroupId | 3GPP TS 29.571 [14] | Identifies a group of UEs. | | +| MacAddr48 | 3GPP TS 29.571 [14] | Mac Address of the UE. | ExtendedSession Information | +| MutingExceptionInstructions | 3GPP TS 29.571 [14] | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). | | +| MutingNotificationsSettings | 3GPP TS 29.571 [14] | Contains setting related to the muting of notifications. | | +| NotificationFlag | 3GPP TS 29.571 [14] | Notification flag. | EneNA | +| NotificationMethod | 3GPP TS 29.508 [15] | Represents the Notification Method. | | +| PartitioningCriteria | 3GPP TS 29.571 [14] | Used to partition UEs before applying sampling. | EneNA | +| PlmnIdNid | 3GPP TS 29.571 [14] | Identifies the network: the PLMN Identifier or the SNPN Identifier. (NOTE 3) | | +| RatType | 3GPP TS 29.571 [14] | RAT Type. | | +| RedirectResponse | 3GPP TS 29.571 [14] | Contains redirection related information. | ES3XX | +| SamplingRatio | 3GPP TS 29.571 [14] | Sampling Ratio. | | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [14] | Indicates the satellite or non-satellite backhaul category. | SatelliteBackhaul | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [23] | Service area coverage in terms of tracking area codes and serving network. | AMPoliciesEvents | +| Snssai | 3GPP TS 29.571 [14] | Identifies a S-NSSAI. | | +| Supi | 3GPP TS 29.571 [14] | Identifies the SUPI of the UE. | | +| SupportedFeatures | 3GPP TS 29.571 [14] | Used to negotiate the applicability of the optional features defined in clause 5.8. | | +| Uinteger | 3GPP TS 29.571 [14] | Unsigned integer. | | + +NOTE 1: "AnGwAddress" data structure is only used to encode the ePDG address and is only applicable to the 5GS and EPC/E-UTRAN interworking scenario as defined in 3GPP TS 29.512 [9], Annex B. + +NOTE 2: In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 5.8 shall be supported. + +NOTE 3: The SNPN Identifier consists of the PLMN Identifier and the NID. + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type PcEventExposureSubsc + +Table 5.6.2.2-1: Definition of type PcEventExposureSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| eventSubs | array(PcEvent) | M | 1..N | Subscribed Policy Control events. | | +| eventsRepInfo | ReportingInformation | O | 0..1 | Represents the reporting requirements of the subscription. | | +| groupId | GroupId | C | 0..1 | Represents an internal group identifier and identifies a group of UEs. It shall be present when the subscription is targeting a Group of UE(s). | | +| filterDnns | array(Dnn) | O | 1..N | Represents the DNNs for which the policy event report shall apply. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. If omitted it represents any DNN. | | +| filterSnssais | array(Snssai) | O | 1..N | Represents the S-NSSAIs for which the policy event report shall apply. If omitted it represents any S-NSSAI. | | +| snssaiDnn | array(SnssaiDnn Combination) | O | 1..N | Represents the combination list of S-NSSAI and DNN for which the policy event report shall apply. If omitted, it represents any combination. | EneNA, AppDetection | +| filterServices | array(ServiceIdentication) | O | 1..N | Represents the services for which the policy event report shall apply. If omitted, the policy event report shall apply for all the active services. | ExtendedSessionInformation | +| appIds | array(ApplicationId) | O | 1..N | Represents the applications for which the policy event report shall apply. It shall be provided for event "APPLICATION_START" or "APPLICATION_STOP". | AppDetection | +| notifUri | Uri | M | 1 | Notification URI for Policy Control event reporting. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(PcEventNotification) | C | 1..N | Represents the Policy Control Events to be reported in the Npcf_EventExposure_Subscribe response. It shall be present in the resource creation/update response when the "eventsRepInfo" attribute includes the "immRep" attribute set to true. Otherwise, it shall be omitted. | ERIR | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.8. Shall be present in the HTTP POST request/response. (NOTE) | | + +NOTE: In the HTTP request, it represents the set of features supported by the NF service consumer. In the HTTP response, it represents the set of features supported by both the NF service consumer and the PCF. + +#### 5.6.2.3 Type PcEventExposureNotif + +Table 5.6.2.3-1: Definition of type PcEventExposureNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(PcEventNotification) | M | 1..N | Represents the Policy Control Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +#### 5.6.2.4 Type ReportingInformation + +**Table 5.6.2.4-1: Definition of type ReportingInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| immRep | boolean | O | 0..1 | Indication of immediate reporting. If included, when it is set to true it indicates immediate reporting of the subscribed events, if available. Otherwise, reporting will occur when the event is met. | | +| notifMethod | NotificationMethod | O | 0..1 | Represents the notification method (periodic, one time, on event detection). If "notifMethod" attribute is not supplied, the default value "ON_EVENT_DETECTION" applies. | | +| maxReportNbr | UInteger | O | 0..1 | Represents the maximum number of reports, after which the subscription ceases to exist (i.e., the reporting ends). It may be present for the "PERIODIC" and on "ON_EVENT_DETECTION" notification methods. If omitted, there is no limit. | | +| monDur | DateTime | C | 0..1 | Represents the time at which the subscription ceases to exist (i.e. the subscription becomes invalid and the reporting ends). If omitted, there is no time limit. If present in the subscription request, it shall be present in the subscription response. | | +| repPeriod | DurationSec | O | 0..1 | Indicates the time interval between successive event notifications. It is supplied for notification method "PERIODIC". | | +| sampRatio | SamplingRatio | O | 0..1 | Indicates the ratio of the random subset to target UEs, event reports only relates to the subset. | | +| partitionCriteria | array(PartitioningCriteria) | O | 1..N | Defines criteria for partitioning the UEs in order to apply the sampling ratio for each partition. It may only be included in event subscription requests when the "sampRatio" attribute is also provided. (NOTE 1) | EneNA | +| grpRepTime | DurationSec | O | 0..1 | Indicates the time during which the event reports detected for the concerned UEs are aggregated in a group, in order to be reported together to the NF service consumer. | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. Default: "ACTIVATE". | EneNA | +| notifFlagInstruct | MutingExceptionInstructions | O | 0..1 | Contains instructions to be executed upon the occurrence of an event muting exception (e.g. full buffer). It may only be provided if the "notifFlag" is provided and set to "DEACTIVATE".(NOTE 2) | | + +| | | | | | | +|---------------|-----------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| mutingSetting | MutingNotificationsSettings | O | 0..1 | Contains settings related to the muting of notifications. It may only be provided in the NF service producer response and only if the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes are accepted.(NOTE 2) | | +|---------------|-----------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +NOTE 1: For a given type of partitioning criteria, the UE shall belong to only one single partition as long as it is served by the NF service producer. + +NOTE 2: This attribute is not used in this API and is applicable only in APIs that re-use this data type for the purpose of data collection for analytics. + +#### 5.6.2.5 Type ServiceIdentification + +**Table 5.6.2.5-1: Definition of type ServiceIdentification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|----------------------------------------|---------------| +| servEthFlows | array(EthernetFlowInfo) | C | 1..N | Ethernet flows of a service. | | +| servIpFlows | array(IpFlowInfo) | C | 1..N | IP flows of a service. | | +| afAppId | AfAppId | O | 0..1 | Contains an AF application identifier. | | + +NOTE: At least one of the "servEthFlows", "servIpFlows" or "afAppId" attributes shall be present. The "servEthFlows" attribute and the "servIpFlows" attribute shall not be both present at the same time. + +#### 5.6.2.6 Type EthernetFlowInfo + +**Table 5.6.2.6-1: Definition of type EthernetFlowInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| ethFlows | array(EthFlowDescription) | C | 1..2 | Contains the flow description for the Uplink and/or Downlink Ethernet flows. It shall be present in the subscription request. | | +| flowNumber | integer | M | 1 | Identifies the ordinal number of the Ethernet flow. | | + +#### 5.6.2.7 Type IpFlowInfo + +**Table 5.6.2.7-1: Definition of type IpFlowInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| ipFlows | array(FlowDescription) | C | 1..2 | Contains the flow description for the Uplink and/or Downlink IP flows. It shall be present in the subscription request. | | +| flowNumber | integer | M | 1 | Identifies the ordinal number of the IP flow. | | + +#### 5.6.2.8 Type PcEventNotification + +Table 5.6.2.8-1: Definition of type PcEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| event | PcEvent | M | 1 | Reported Policy Control event. | | +| accType | AccessType | C | 0..1 | Access Type. It shall be included when the reported PcEvent is "AC_TY_CH". | | +| addAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the additional combination of Access Type and RAT Type available for MA PDU session. It may be present when the notified event is "AC_TY_CH" and the PDU session is a Multi-Access PDU session. | ATSSS | +| relAccessInfo | AdditionalAccessInfo | O | 0..1 | Indicates the release of a combination of Access Type and RAT Type available for MA PDU session. It may be present when the notified event is "AC_TY_CH" and the PDU session is a Multi-Access PDU session. | ATSSS | +| anGwAddr | AnGwAddress | O | 0..1 | ePDG address. It shall be included if applicable when the reported PcEvent is "AC_TY_CH". | | +| ratType | RatType | O | 0..1 | RAT Type. It shall be included if applicable when the reported PcEvent is "AC_TY_CH". | | +| plmnId | PlmnIdNid | C | 0..1 | PLMN Identifier or the SNPN Identifier. It shall be included when the reported PcEvent is "PLMN_CH".
(NOTE) | | +| appliedCov | ServiceAreaCoverageInfo | C | 0..1 | The list of applied allowed Tracking Areas for the serving network where the UE is camping. It shall be included when the reported PcEvent is "SAC_CH". | AMPoliciesEvents | +| supi | Supi | C | 0..1 | SUPI of the UE. It shall be present if available. | | +| gpsi | Gpsi | O | 0..1 | Gpsi shall contain either an External Id or an MSISDN. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| pduSessInfo | PduSessionInformation | O | 0..1 | Represents PDU session information related to the observed event. | ExtendedSessionInformation, AppDetection | +| appId | ApplicationId | O | 0..1 | Represents the detected application. | AppDetection | +| repServices | ServiceIdentification | O | 0..1 | Represents service information related to the observed event. | ExtendedSessionInformation | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates the satellite or non-satellite backhaul category of the PDU session. It shall be included when the reported PcEvent is "SAT_CATEGORY_CH".
If the "EnSatBackhaulCatChg" feature is supported, the different dynamic satellite backhaul categories may also be provided. | SatelliteBackhaul | +| delivFailure | Failure | C | 0..1 | Indicates the failure reason for an unsuccessful outcome of the UE Policy Delivery. It shall be included when the reported | DeliveryOutcome | + +| | | | | | | +|------------------------------------------------------------------------|--|--|--|----------------------------------------|--| +| | | | | PcEvent is "UNSUCCESS_UE_POL_DEL_S P". | | +| NOTE: The SNPN Identifier consists of the PLMN Identifier and the NID. | | | | | | + +#### 5.6.2.9 Type PduSessionInformation + +**Table 5.6.2.9-1: Definition of type PduSessionInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI of the PDU session. | | +| dnn | Dnn | M | 1 | Dnn of the PDU session, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. | | +| uelpv4 | Ipv4Addr | C | 0..1 | The IPv4 address of the served UE.
(NOTE 1) | | +| uelpv6 | Ipv6Prefix | C | 0..1 | The IPv6 prefix of the served UE.
(NOTE 1) | | +| ipDomain | string | O | 0..1 | Identifies the IP domain.
(NOTE 2) | | +| ueMac | MacAddr48 | C | 0..1 | UE MAC address.
(NOTE 1) | | + +NOTE 1: Either the served UE IP address (an Ipv4Addr or Ipv6Prefix or both if available) or UE MAC address shall be present. +NOTE 2: An "ipDomain" attribute, may be provided in combination with a "uelpv4" attribute. + +#### 5.6.2.10 Type SnssaiDnnCombination + +**Table 5.6.2.10-1: Definition of type SnssaiDnnCombination** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI | | +| dnns | array(Dnn) | M | 1..N | Dnn | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.6.3.3 Enumeration: PcEvent + +The enumeration PcEvent represents the policy control events that can be subscribed. It shall comply with the provisions defined in table 5.6.3.3-1. + +Table 5.6.3.3-1: Enumeration PcEvent + +| Enumeration value | Description | Applicability | +|-------------------------|----------------------------------------------------------------------------------------------------------------------|-------------------| +| AC TY_CH | Access Type Change | | +| PLMN_CH | PLMN Change | | +| SAC_CH | Service Area Coverage change | AMPoliciesEvents | +| SAT_CATEGORY_CH | Indicates that a change between different satellite backhaul category, or non-satellite backhaul, has been detected. | SatelliteBackhaul | +| SUCCESS_UE_POL_DEL_SP | Indicates about the successful UE Policy delivery related to the invocation of AF provisioned service parameters. | DeliveryOutcome | +| UNSUCCESS_UE_POL_DEL_SP | Indicates about the unsuccessful UE Policy delivery related to the invocation of AF provisioned service parameters. | DeliveryOutcome | +| APPLICATION_START | The start of application traffic has been detected. | AppDetection | +| APPLICATION_STOP | The stop of application traffic has been detected. | AppDetection | + +## 5.7 Error handling + +### 5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [5]. + +For the Npcf\_EventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Npcf\_EventExposure API. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no service specific protocol errors applicable for the Npcf\_EventExposure API. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_EventExposure service are listed in table 5.7.3-1. + +Table 5.7.3-1: Application errors + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_EventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +**Table 5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ExtendedSessionInformation | Indicates the support of additional session information in the subscription and report of policy control event. | +| 2 | MacAddressRange | Indicates the support of a set of MAC addresses with a specific range in the traffic filter. | +| 3 | ATSSS | Indicates the support of the report of the multiple access types of a MA PDU session. | +| 4 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 5 | AMPoliciesEvents | Indicates the support of the report of changes of service area coverage for a UE. | +| 6 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 7 | SatelliteBackhaul | Indicates the support of the report of the satellite or non-satellite backhaul category of the PDU session. | +| 8 | DeliveryOutcome | Indicates the support of notifications about the outcome of the UE Policy delivery related to the invocation of AF provisioned service parameters. | +| 9 | ERIR | Indicates the support of immediate report within the subscription response. | +| 10 | EnSatBackhaulCatChg | This feature indicates the support of the report of the dynamic satellite backhaul category of the PDU session. This feature requires the support of SatelliteBackhaul feature. | +| 11 | AppDetection | Indicates the support of Application Traffic Detection Event Exposure. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [19] and 3GPP TS 29.500 [5], the access to the Npcf\_EventExposure API, based on local configuration, may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [20]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [21]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nnrf\_NFManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [21], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF where the NF Service Consumer invoked the discovery of the Npcf\_EventExposure service. + +The Npcf\_EventExposure API defines a single scope "npcf-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [7] specification of HTTP messages and content bodies used by the Npcf\_EventExposure API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [22] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +## --- A.2 Npcf\_EventExposure API + +``` +openapi: 3.0.0 +info: + version: 1.3.0-alpha.3 + title: Npcf_EventExposure + description: | + PCF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.523 V18.2.0; 5G System; Policy Control Event Exposure Service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.523/ + +servers: + - url: '{apiRoot}/npcf-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-eventexposure + +paths: + /subscriptions: + post: + summary: Creates a new Individual Policy Control Events Subscription resource + operationId: PostPcEventExposureSubsc + tags: + - Policy Control Events Subscription (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' +``` + +``` + +headers: + Location: + description: > + Contains the URI of the created individual policy control events subscription + resource, according to the structure + {apiRoot}/npcf-eventexposure/v1/subscriptions/{subscriptionId} + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + PcEventNotification: + "{$request.body#/notifUri}": + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureNotif' +responses: + '204': + description: No Content, Notification was succesfull. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/subscriptions/{subscriptionId}: + get: + summary: "Reads an existing Individual Policy Control Events Subscription" + operationId: GetPcEventExposureSubsc + +``` + +``` +tags: + - Individual Policy Control Events Subscription (Document) +parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string +responses: + '200': + description: OK. Resource representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: "Modifies an existing Individual Policy Control Events Subscription " + operationId: PutPcEventExposureSubsc + tags: + - Individual Policy Control Events Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string + responses: + '200': + description: OK. Resource was successfully modified and representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcEventExposureSubsc' + '204': + description: No Content. Resource was successfully modified. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: "Cancels an existing Individual Policy Control Events Subscription " + operationId: DeletePcEventExposureSubsc + tags: + - Individual Policy Control Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Policy Control Event Subscription ID. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-eventexposure: Access to the Npcf_EventExposure API. + +schemas: + + PcEventExposureNotif: + description: > + Represents notifications about Policy Control events related to an Individual + Policy Events Subscription resource. + type: object + properties: + notifId: + type: string + eventNotifs: + type: array +``` + +``` + items: + $ref: '#/components/schemas/PcEventNotification' + minItems: 1 + required: + - notifId + - eventNotifs + +PcEventExposureSubsc: + description: Represents an Individual Policy Events Subscription resource. + type: object + properties: + eventSubs: + type: array + items: + $ref: '#/components/schemas/PcEvent' + minItems: 1 + eventsRepInfo: + $ref: '#/components/schemas/ReportingInformation' + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + filterDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + filterSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + snssaiDnns: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnCombination' + minItems: 1 + filterServices: + type: array + items: + $ref: '#/components/schemas/ServiceIdentification' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/PcEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventSubs + - notifId + - notifUri + +ReportingInformation: + description: Represents the type of reporting that the subscription requires. + type: object + properties: + immRep: + type: boolean + notifMethod: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + maxReportNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + monDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +``` + +``` +partitionCriteria: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PartitioningCriteria' + minItems: 1 + description: Criteria for partitioning the UEs before applying the sampling ratio. +grpRepTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' +notifFlagInstruct: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' +mutingSetting: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + +ServiceIdentification: + description: Identifies the service to which the subscription applies. + type: object + properties: + servEthFlows: + type: array + items: + $ref: '#/components/schemas/EthernetFlowInfo' + minItems: 1 + servIpFlows: + type: array + items: + $ref: '#/components/schemas/IpFlowInfo' + minItems: 1 + afAppId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AfAppId' + # All conditions in allOf must be met + allOf: + # First condition is that servEthFlows and servIpFlows are mutually exclusive + - not: + - required: [servEthFlows, servIpFlows] + # Second condition is that at least one the servEthFlows, servIpFlows and afAppId shall be + present + - anyOf: + - required: [servEthFlows] + - required: [servIpFlows] + - required: [afAppId] + +EthernetFlowInfo: + description: Identifies an UL/DL ethernet flow. + type: object + properties: + ethFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + flowNumber: + type: integer + required: + - flowNumber + +IpFlowInfo: + description: Identifies an UL/DL IP flow. + type: object + properties: + ipFlows: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + flowNumber: + type: integer + required: + - flowNumber + +PcEventNotification: + description: Represents the information reported for a Policy Control event. + type: object + properties: + event: +``` + +``` + + $ref: '#/components/schemas/PcEvent' + accType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + addAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + anGwAddr: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AnGwAddress' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + appliedCov: + $ref: 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pduSessionInfo: + $ref: '#/components/schemas/PduSessionInformation' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + repServices: + $ref: '#/components/schemas/ServiceIdentification' + delivFailure: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Failure' + required: + - event + - timeStamp + +PduSessionInformation: + description: Represents PDU session identification information. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ipDomain: + type: string + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + required: + - snssai + - dnn + oneOf: + - required: [ueMac] + - anyOf: + - required: [ueIpv4] + - required: [ueIpv6] +SnssaiDnnCombination: + description: Represents a combination of S-NSSAI and DNN(s). + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + +# Simple data types and Enumerations + +PcEvent: + description: Represents the policy control events that can be subscribed. + anyOf: + - type: string + +``` + +``` +enum: + - AC_TY_CH + - PLMN_CH + - SAC_CH + - SAT_CATEGORY_CH + - SUCCESS_UE_POL_DEL_SP + - UNSUCCESS_UE_POL_DEL_SP + - APPLICATION_START + - APPLICATION_STOP +- type: string +description: > + This string provides forward-compatibility with future extensions to the enumeration + and is not used to encode content defined in the present version of this API. +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-11 | | | | | | TS skeleton of Policy Event Exposure Service specification | 0.0.0 | +| 2018-11 | CT3#99 | C3-187718 | | | | API Introduction and Usage of HTTP for new PCF TS | 1.0.0 | +| 2018-11 | CT3#99 | C3-187416 | | | | Npcf_EventExposure Resources Definition and Error handling | 1.0.0 | +| 2018-11 | CT3#99 | C3-187419 | | | | Npcf_EventExposure, Policy Control Event Notification | 1.0.0 | +| 2018-11 | CT3#99 | C3-187675 | | | | Npcf_EventExposure Service Description | 1.0.0 | +| 2018-11 | CT3#99 | C3-187717 | | | | Npcf_EventExposure Service Operations and Data Structures | 1.0.0 | +| 2018-11 | CT3#99 | C3-187734 | | | | Npcf_EventExposure, OpenAPI | 1.0.0 | +| 2018-11 | CT3#99 | C3-187677 | | | | Npcf_EventExposure, Security | 1.0.0 | +| 2018-12 | CT#82 | CP-183131 | | | | TS sent to plenary for information and approval | 1.0.0 | +| 2018-12 | CT#82 | CP-183166 | | | | Npcf_EventExposure, OpenAPI | 1.1.0 | +| 2018-12 | CT#82 | CP-183251 | | | | TS number assigned in the plenary for approval | 1.1.0 | +| 2018-12 | CT#82 | CP-183253 | | | | TS approved by plenary | 15.0.0 | +| 2019-03 | CP#83 | CP-190112 | 0001 | 1 | F | Handling of IPdomain and UE addresses in Npcf_EventExposure service | 15.1.0 | +| 2019-03 | CT#83 | CP-190160 | 0002 | 3 | F | Correction on Presence conditions for ServiceIdentification data type | 15.1.0 | +| 2019-03 | CT#83 | CP-190112 | 0003 | 1 | F | Handling of UE identities in Npcf_EventExposure service | 15.1.0 | +| 2019-03 | CP#83 | CP-190112 | 0004 | | F | Correction on the handling of access type change | 15.1.0 | +| 2019-03 | CT#83 | CP-190112 | 0005 | | F | Correction of OpenAPI errors | 15.1.0 | +| 2019-03 | CP#83 | CP-190161 | 0006 | 1 | F | OpenAPI Version number updates | 15.1.0 | +| 2019-06 | CT#84 | CP-191081 | 0007 | 1 | F | Report ePDG address | 15.2.0 | +| 2019-06 | CT#84 | CP-191081 | 0008 | | F | Storage of OpenAPI specification file | 15.2.0 | +| 2019-06 | CT#84 | CP-191081 | 0009 | 2 | F | Correction to the notification procedure | 15.2.0 | +| 2019-06 | CT#84 | CP-191081 | 0010 | | F | Correction on PCF event exposure service | 15.2.0 | +| 2019-06 | CT#84 | CP-191081 | 0011 | 2 | F | Precedence of OpenAPI file | 15.2.0 | +| 2019-06 | CT#84 | CP-191182 | 0012 | 2 | F | Copyright note in YAML file | 15.2.0 | +| 2019-06 | CT#84 | CP-191081 | 0013 | 1 | F | OpenAPI Version number update | 15.2.0 | +| 2019-09 | CT#85 | CP-192156 | 0014 | 1 | B | Support of a set of MAC addresses in traffic filter | 16.0.0 | +| 2019-09 | CT#85 | CP-192157 | 0015 | 1 | B | Enhancement of event reporting information | 16.0.0 | +| 2019-09 | CT#85 | CP-192173 | 0016 | | F | OpenAPI version update | 16.0.0 | +| 2020-03 | CT#87e | CP-200207 | 0018 | | B | DNN Clarification | 16.1.0 | +| 2020-06 | CT#88e | CP-201252 | 0019 | | B | Adding support of NID | 16.2.0 | +| 2020-06 | CT#88e | CP-201229 | 0020 | 3 | B | Access Type Report for a MA PDU session | 16.2.0 | +| 2020-06 | CT#88e | CP-201244 | 0021 | 1 | F | Storage of YAML files in ETSI Forge | 16.2.0 | +| 2020-06 | CT#88e | CP-201256 | 0022 | 1 | F | URI of the Npcf_EventExposure service | 16.2.0 | +| 2020-06 | CT#88e | CP-201223 | 0024 | 1 | A | suppFeat within PcEventExposureSubsc | 16.2.0 | +| 2020-06 | CT#88e | CP-201244 | 0025 | 1 | F | Supported headers, Resource Data type | 16.2.0 | +| 2020-06 | CT#88e | CP-201255 | 0027 | | F | Update of OpenAPI version and TS version in externalDocs Field | 16.2.0 | +| 2020-09 | CT#89e | CP-202055 | 0031 | 1 | A | Resource URI for individual subscription | 16.3.0 | +| 2020-09 | CT#89e | CP-202073 | 0028 | | B | Successful status code | 17.0.0 | +| 2020-12 | CT#90e | CP-203076 | 0033 | 2 | A | TS 29.523 Essential Corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0035 | 1 | A | Storage of YAML files in ETSI Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203144 | 0037 | 1 | F | Combination of DNN and S-NSSAI | 17.1.0 | +| 2020-12 | CT#90e | CP-203110 | 0039 | 1 | A | Correction to support Stateless NFs | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0041 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0042 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0043 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0044 | | F | Missing data type in the Npcf_EventExposure specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0045 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211257 | 0046 | 1 | B | Support of notifications of SAR changes | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0047 | 2 | B | Partitioning criteria for applying sampling in specific UE partitions in PCF exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211234 | 0048 | | F | Support of optional HTTP custom header fields | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0049 | 1 | B | Support of Mute reporting | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0051 | 1 | A | Redirect responses with "application/json" media type | 17.3.0 | +| 2021-06 | CT#92e | CP-211213 | 0052 | 1 | B | Satellite backhaul change event in PCF exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0053 | | F | Correction to subscription filters | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0055 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212205 | 0056 | | B | Definition of PLMN identifier notification event | 17.4.0 | +| 2021-09 | CT#93e | CP-212220 | 0057 | 1 | F | URI representing Policy Control Events Subscriptions resource | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213222 | 0058 | 1 | B | Notification on the outcome of UE Policies delivery due to service specific parameter provisioning | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0059 | 1 | F | Updates in subscription to service area coverage changes | 17.5.0 | +| 2021-12 | CT#94e | CP-213226 | 0060 | 1 | A | Corrections in PCF event exposure NF service consumers | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0061 | 1 | B | Event report in the subscription response | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0063 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220179 | 0064 | | F | Completion of the information related to satellite backhaul change event | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0065 | | F | Completion of the information related to UE Policy Delivery outcome event | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0066 | 1 | B | Clarification of the report of the requested service area coverage change | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0067 | | B | Definition of Service Area Coverage | 17.6.0 | +| 2022-03 | CT#95e | CP-220179 | 0068 | | F | Changing reference for the SatelliteBackhaulCategory data type | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0069 | 1 | F | Update of description fields | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0070 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221157 | 0071 | | F | Inaccurate condition for immediate reporting | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0072 | | F | Alignment with the SBI template | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0073 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222099 | 0074 | 1 | F | Correction to notification of outcome of the UE Policy Delivery | 17.8.0 | +| 2022-12 | CT#98e | CP-223191 | 0075 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0077 | 1 | F | PcEvent enumeration definition in the OpenAPI file | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0080 | 2 | F | Correction to Data Type PduSessionInformation | 18.0.0 | +| 2022-12 | CT#98e | CP-223178 | 0081 | | B | SNPN mobility | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0085 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230167 | 0086 | 1 | D | Removing wrong feature indication | 18.1.0 | +| 2023-03 | CT#99 | CP-230162 | 0087 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231125 | 0088 | 1 | B | Event muting enhancements for PCF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231250 | 0089 | 2 | B | Support of application detection event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0091 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0092 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-12 | CT#102 | CP-233247 | 0096 | 1 | F | Correcting the cardinality of event | 18.3.0 | +| 2023-12 | CT#102 | CP-233253 | 0097 | 1 | B | Support of Dynamic Satellite Backhaul | 18.3.0 | +| 2023-12 | CT#102 | CP-233257 | 0098 | 1 | F | Completion of Application Detection | 18.3.0 | +| 2023-12 | CT#102 | CP-233228 | 0099 | 1 | F | Reference update: IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233228 | 0100 | | F | ProblemDetails RFC 7807 obsoleted by RFC 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233226 | 0101 | 1 | F | Applicability of muting exception instructions | 18.3.0 | +| 2023-12 | CT#102 | CP-233253 | 0102 | 1 | B | Support of dynamic satellite backhaul category changes | 18.3.0 | \ No newline at end of file diff --git a/gsma/29_series/29524/raw.md b/gsma/29_series/29524/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ce1f9aaac6bc9dd3d361e9c542e44b2967a8015a --- /dev/null +++ b/gsma/29_series/29524/raw.md @@ -0,0 +1,555 @@ + + +# 3GPP TS 29.524 V18.0.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Cause codes mapping between 5GC interfaces; Stage3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a small red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions, symbols and abbreviations ..... | 7 | +| 3.1 Abbreviations ..... | 7 | +| 4 Mapping between 5GC interfaces causes and 5GMM Cause Codes by AMF ..... | 7 | +| 4.1 General ..... | 7 | +| 4.2 Mapping between Nausf services causes and 5GMM causes ..... | 7 | +| 4.2.1 General ..... | 7 | +| 4.2.2 Mapping between Nausf_UEAuthentication service causes on N12 and 5GMM causes ..... | 8 | +| 4.2.2.1 General ..... | 8 | +| 4.2.2.2 Mapping from HTTP to 5GMM causes values – Request rejected by AUSF..... | 8 | +| 4.2.2.3 Mapping from HTTP to 5GMM cause values – Request accepted by AUSF ..... | 8 | +| 4.3 Mapping between Nsmf services causes and 5GMM causes..... | 9 | +| 4.3.1 General ..... | 9 | +| 4.3.2 Mapping between Nsmf_PDUSession service causes on N11 and 5GMM causes ..... | 9 | +| 4.3.2.1 General ..... | 9 | +| 4.3.2.2 Mapping from HTTP to 5GMM Cause Values ..... | 9 | +| 4.4 Mapping between Nudm services causes and 5GMM causes..... | 11 | +| 4.4.1 General ..... | 11 | +| 4.4.2 Mapping between Nudm_UEContextManagement service causes on N8 and 5GMM causes..... | 11 | +| 4.4.2.1 General ..... | 11 | +| 4.4.2.1 Mapping from HTTP to NAS cause values – Request rejected by UDM..... | 11 | +| 4.4.3 Mapping between Nudm_SubscriberDataManagement service causes on N8 and 5GMM causes ..... | 11 | +| 4.4.3.1 General ..... | 11 | +| 4.4.3.2 Mapping from HTTP to NAS cause values – Request rejected by UDM due to N8 failure ..... | 12 | +| 4.5 Mapping between Neir services causes and 5GMM causes ..... | 12 | +| 4.5.1 General ..... | 12 | +| 4.5.2 Mapping between N5g-eir_EquipmentIdentityCheck Service causes on N17 and 5GMM causes ..... | 12 | +| 4.5.2.1 General ..... | 12 | +| 4.5.2.2 Mapping from HTTP to NAS cause values – Request accepted by EIR..... | 12 | +| 4.6 Mapping between Nnssf services causes and 5GMM causes ..... | 12 | +| 4.6.1 General ..... | 12 | +| 4.6.2 Mapping between Nnssf_NSSelection service causes on N22 and 5GMM causes ..... | 12 | +| 4.6.2.1 General ..... | 12 | +| 4.6.2.2 Mapping from HTTP to 5GMM Cause Values ..... | 13 | +| 5 Mapping between 5GC interfaces causes and 5GSM Cause Codes by SMF ..... | 13 | +| 5.1 General ..... | 13 | +| 5.2 Mapping between Npcf service causes on N7 and 5GSM causes..... | 13 | +| 5.2.1 General ..... | 13 | +| 5.2.2 Mapping between Npcf_SMSPolicyControl Service causes on N7 and 5GSM causes ..... | 13 | +| 5.2.2.1 General ..... | 13 | +| 5.2.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by PCF..... | 14 | +| 5.3 Mapping between Nudm service causes on N10 and 5GSM causes..... | 14 | +| 5.3.1 General ..... | 14 | +| 5.3.2 Mapping between Nudm_UEContextManagement service causes on N10 and 5GSM causes ..... | 14 | +| 5.3.2.1 General ..... | 14 | +| 5.3.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures..... | 14 | +| 5.3.3 Mapping between Nudm_SubscriberDataManagement service causes on N10 and 5GSM causes ..... | 15 | +| 5.3.3.1 General ..... | 15 | +| 5.3.3.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures..... | 15 | +| 5.4 Mapping between N4 causes and 5GSM causes..... | 15 | +| 5.4.1 General ..... | 15 | +| 5.4.2 Mapping from N4 to 5GSM cause values ..... | 16 | + +5.5 Mapping between Nnsacf services causes and 5GSM causes..... 17 +5.5.1 General ..... 17 +5.5.2 Mapping between Nnsacf\_NSAC service causes on N81 and 5GSM causes..... 17 +5.5.2.1 General..... 17 +5.5.2.2 Mapping from HTTP to 5GSM Cause Values..... 17 +**Annex A (informative): Change history..... 18** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the mapping: + +- performed by the AMF between HTTP responses (Status Codes and Protocol or Application Errors) returned by 5GC NFs to the AMF and 5GMM Cause values sent to UEs; +- performed by the SMF between HTTP responses (Status Codes and Protocol or Application Errors) returned by 5GC NFs to SMF and 5GSM Cause values sent to UEs; +- performed by the SMF between N4 errors returned by the UPF and 5GSM Cause values sent to UEs. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes". +- [3] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [4] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [5] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [6] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [7] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". +- [8] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [9] 3GPP TS 29.508: "5G System, Session Management Event Exposure Service; Stage 3". +- [10] 3GPP TS 29.540: "5G System; SMS Services; Stage3 ". +- [11] 3GPP TS 29.511: "5G System; Equipment Identity Register Services; Stage 3". +- [12] 3GPP TS 29.507: "5G System; Access and Mobility Policy Control Service; Stage 3". +- [13] 3GPP TS 29.525: "5G System; UE Policy Control Service; Stage 3". + +[xx] 3GPP TS 29.536: "5G System; Network Slice Admission Control Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|-----------------------------------------| +| 5GC | 5G Core Network | +| AMF | Access and Mobility Management Function | +| HTTP | Hypertext Transfer Protocol | +| NF | Network Function | +| NSSF | Network Slice Selection Function | +| PCF | Policy Control Function | +| SMF | Session Management Function | +| UDM | Unified Data Management | + +# --- 4 Mapping between 5GC interfaces causes and 5GMM Cause Codes by AMF + +## 4.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by NF services contacted by the AMF and the 5GMM cause values sent to UEs. + +No mapping is required for: + +- the Nsmf\_SMService\_Activate, Nsmf\_SMService\_Deactivate and Nsmf\_SMService\_UplinkSMS operations described in 3GPP TS 29.540 [10]. +- the Npcf\_AMPolicyControl service operations described in 3GPP TS 29.507 [12]. +- the Npcf\_UEPolicyControl service operations described in 3GPP TS 29.525 [13]. + +## 4.2 Mapping between Nausf services causes and 5GMM causes + +### 4.2.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by AUSF services to the AMF and the 5GMM cause values sent to UEs. + +### 4.2.2 Mapping between Nausf\_UEAuthentication service causes on N12 and 5GMM causes + +#### 4.2.2.1 General + +This clause defines the mapping for the Nausf\_UEAuthentication service (see 3GPP TS 29.509 [7]). It also contains the mapping in case of a 200 OK is returned but the Authentication has failed. + +#### 4.2.2.2 Mapping from HTTP to 5GMM causes values – Request rejected by AUSF + +**Table .4.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by AUSF** + +| HTTP status code on N12 | Protocol or Application Error | 5GMM cause to UE | +|---------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 403 Forbidden | SERVING_NETWORK_NOT_AUTHORIZED | Cause #11 – PLMN not allowed
Cause #73 – Serving network not authorized
Cause #12 – Tracking area not allowed
Cause #15 – No suitable cells in tracking area
(NOTE1) | +| | AUTHENTICATION_REJECTED | N/A (NOTE 2) | +| | INVALID_HN_PUBLIC_KEY_IDENTIFIER | N/A (NOTE 2) | +| | INVALID_HN_PUBLIC_KEY_IDENTIFIER | N/A (NOTE 2) | +| 404 Not Found | CONTEXT_NOT_FOUND | N/A (NOTE 2) | +| | USER_NOT_FOUND | | +| 504 Gateway Timeout | UPSTREAM_SERVER_ERROR | N/A (NOTE 2) | +| | NETWORK_FAILURE | N/A (NOTE 2) | +| 500 Internal Server Error | AV_GENERATION_PROBLEM | N/A (NOTE 2) | +| 501 Not Implemented | UNSUPPORTED_PROTECTION_SCHEME | N/A (NOTE 2) | + +NOTE 1: One of these 5GMM causes may be used. +NOTE 2: There is no corresponding mapping since the Authentication is rejected and the Authentication Reject message does not have a 5GMM cause. + +#### 4.2.2.3 Mapping from HTTP to 5GMM cause values – Request accepted by AUSF + +**Table .4.2.2.3-1: Mapping from HTTP to 5GMM cause values – Request accepted by AUSF** + +| HTTP status code on N12 | Protocol or Application Error | 5GMM cause to UE | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| 200 OK | The "authResult" in "ConfirmationDataResponse" is set to "AUTHENTICATION_FAILURE" (see clause 6.1.6.2.8 of 3GPP TS 29.509 [7]). | Cause #3 – Illegal UE | +| | The "authResult" in "EapSession" is set to "AUTHENTICATION_FAILURE" (see clause 6.1.6.2.8 of 3GPP TS 29.509 [7]). | Cause #3 – Illegal UE | + +## 4.3 Mapping between Nsmf services causes and 5GMM causes + +### 4.3.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by SMF services to the AMF and the 5GMM cause values sent to UEs. + +The AMF may invoke SMF service operations upon receipt of: + +- 5GSM messages (e.g. PDU Session establishment request) piggybacked in 5GMM UL NAS TRANSPORT message; +- 5GMM Service Request or Registration Request messages, to establish the user-plane resources of a PDU session. + +A 5GMM cause is defined in: + +- the DL NAS TRANSPORT message; +- the PDU session reactivation result error cause IE of a REGISTRATION ACCEPT or SERVICE ACCEPT message; +- the REGISTRATION REJECT or SERVICE REJECT message. + +The AMF shall support mapping the status code and/or Protocol or Application Error received from the SMF to a 5GMM cause code, where 3GPP TS 24.501 [3] requires a 5GMM Cause to be included in the 5GMM message sent to the UE. + +NOTE: REGISTRATION REJECT and SERVICE REJECT messages are rejected only due to 5GMM-specific reasons, i.e. not for problems specific to session management. + +### 4.3.2 Mapping between Nsmf\_PDUSession service causes on N11 and 5GMM causes + +#### 4.3.2.1 General + +This clause defines the mapping for the Nsmf\_PDUSession service (see 3GPP TS 29.502 [8]). + +#### 4.3.2.2 Mapping from HTTP to 5GMM Cause Values + +Table 4.3.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by SMF + +| HTTP status code on N11 | Protocol or Application Error | 5GMM cause to UE | +|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| 200 OK | The upCnxState IE is set to DEACTIVATED and the Cause IE set to "INSUFFICIENT_UP_RESOURCES" (see clause 5.2.2.3.2.2 of 3GPP TS 29.502 [8]) (NOTE 2) | #92 - Insufficient user-plane resources for the PDU session | +| 403 Forbidden | OUT_OF_LADN_SERVICE_AREA | #43 - LADN not available | +| 403 Forbidden | PRIORITIZED_SERVICES_ONLY | #28 - Restricted service area | +| 404 Not Found | CONTEXT_NOT_FOUND | N/A (NOTE 1) | +| | | | +| | | | +| | | | +| 504 Gateway Timeout | NETWORK_FAILURE | N/A (NOTE 1) | + +NOTE 1: An N1 SM cause is included by the SMF in the HTTP error response in this case. + +NOTE 2: This corresponds to the scenario where NG-RAN cannot establish user plane resources during the activation of the User Plane connection of a PDU session. + +## 4.4 Mapping between Nudm services causes and 5GMM causes + +### 4.4.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (status codes and Protocol or Application Errors) returned by UDM services to AMF and the 5GMM cause values sent to UEs. + +### 4.4.2 Mapping between Nudm\_UEContextManagement service causes on N8 and 5GMM causes + +#### 4.4.2.1 General + +This clause defines the mapping for the Nudm\_UEContextManagement service is described in 3GPP TS 29.503 [5]). + +#### 4.4.2.1 Mapping from HTTP to NAS cause values – Request rejected by UDM + +**Table 4.4.2.1-1: Mapping from HTTP to 5GMM cause values – Request rejected by UDM** + +| HTTP status code on N8 | Protocol or Application Error | 5GMM cause to UE | +|-------------------------------------------------------------------------------------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| 403 Forbidden | UNKNOWN_5GS_SUBSCRIPTION | #27 – N1 mode not allowed | +| | ACCESS_NOT_ALLOWED | #15 "No suitable cells in tracking area", or
#12 "Tracking area not allowed"
or
#72 – Non-3GPP access to 5GCN not allowed (NOTE) | +| | RAT_NOT_ALLOWED | #15 "No suitable cells in tracking area", or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed" (NOTE) | +| | NO_PS_SUBSCRIPTION | #7 – 5GS services not allowed | +| | ROAMING_NOT_ALLOWED | #11 "PLMN not allowed" or
#13 "Roaming not allowed in this tracking area", (NOTE) | +| 404 Not Found | CONTEXT_NOT_FOUND | #9 "UE identity cannot be derived by the network" | +| 404 Not Found | USER_NOT_FOUND | #3 "Illegal UE" | +| 422 Unprocessable Entity | UNPROCESSABLE_REQUEST | #111 protocol error unspecified | +| NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. | | | + +### 4.4.3 Mapping between Nudm\_SubscriberDataManagement service causes on N8 and 5GMM causes + +#### 4.4.3.1 General + +This clause defines the mapping for the Nudm\_SubscriberDataManagement service is described in 3GPP TS 29.503 [5]). + +#### 4.4.3.2 Mapping from HTTP to NAS cause values – Request rejected by UDM due to N8 failure + +**Table 4.4.x.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by UDM due to N8 failures when consuming Nudm\_SubscriberDataManagement service** + +| HTTP status code on N8 | Protocol or Application Error | 5GMM cause to UE | +|-------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------------------| +| 404 Not Found | USER_NOT_FOUND
DATA_NOT_FOUND | #3 "Illegal UE"
#27 "N1 mode not allowed" | +| NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. | | | + +## 4.5 Mapping between Neir services causes and 5GMM causes + +### 4.5.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (status code and Protocol or Application Errors) returned by the EIR to the AMF and the 5GMM cause values sent to UEs. + +### 4.5.2 Mapping between N5g-eir\_EquipmentIdentityCheck Service causes on N17 and 5GMM causes + +#### 4.5.2.1 General + +This clause defines the mapping for the N5g-eir\_EquipmentIdentityCheck service (see 3GPP TS 29.511 [11]). + +#### 4.5.2.2 Mapping from HTTP to NAS cause values – Request accepted by EIR + +**Table 4.5.2.2-1: Mapping from HTTP to 5GMM cause values – Request accepted by EIR** + +| HTTP Status on N17 | Protocol or Application information | 5GMM cause to UE | +|--------------------|---------------------------------------------------------------------------------------------------------|------------------| +| 200 OK | Equipment Status is set to "BLACKLISTED", which indicates that the equipment is in the prohibited list. | #6 "Illegal ME" | + +## 4.6 Mapping between Nnssf services causes and 5GMM causes + +### 4.6.1 General + +This clause defines the mapping performed by the AMF between HTTP responses (Status Code and Protocol or Application Errors) returned by the NSSF to the AMF and the 5GMM cause values sent to UEs. + +### 4.6.2 Mapping between Nnssf\_NSSelection service causes on N22 and 5GMM causes + +#### 4.6.2.1 General + +This clause defines the mapping for the Nnssf\_NSSelection service (see 3GPP TS 29.531 [4]). + +#### 4.6.2.2 Mapping from HTTP to 5GMM Cause Values + +**Table 4.6.2.2-1: Mapping from HTTP to 5GMM cause values – Request rejected by NSSF** + +| HTTP status code on N22 | Protocol or Application Error | 5GMM cause to UE | +|-------------------------|-------------------------------|-----------------------------------| +| 403 Forbidden | SNSSAI NOT SUPPORTED | #62 – No Network Slices available | + +# --- 5 Mapping between 5GC interfaces causes and 5GSM Cause Codes by SMF + +## 5.1 General + +This clause describes the mapping performed by the SMF between HTTP responses (status Code and Protocol or Application Errors) returned by NF services contacted by the SMF and the corresponding 5GSM cause values sent to UEs (in5GSMmessages). + +No mapping is required for the Nsmf\_PDUSession service over N11 since the SMF includes the 5GSM cause in 5GSM messages sent in N1 SM Information (see 3GPP TS 29.502 [5]). + +No mapping is required for the Nsmf\_PDUSession service over N16 since the 5GSM cause is generated at the H-SMF and provided to the V-SMF in N1 SM Information (see 3GPP TS 29.502 [9]). + +No mapping is required for the Nsmf\_EventExposure service specified in 3GPP TS 29.508 [9] + +## 5.2 Mapping between Npcf service causes on N7 and 5GSM causes + +### 5.2.1 General + +This clause defines the mapping performed by the SMF between HTTP responses (status code and Protocol or Application Errors) returned by the PCF to the SMF and the 5GSM causes sent to UEs. + +### 5.2.2 Mapping between Npcf\_SMPolicyControl Service causes on N7 and 5GSM causes + +#### 5.2.2.1 General + +This clause defines the mapping for the Npcf\_SMPolicyControl service (see 3GPPTS 29.512 [6]). + +#### 5.2.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by PCF + +**Table 5.2.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by PCF** + +| HTTP status code on N7 | Protocol or Application Error | 5GSM cause to UE | +|------------------------|-------------------------------------|----------------------------------------------------------------| +| 400 Bad Request | USER_UNKNOWN | Cause #29 - User authentication or authorization failed | +| | ERROR_INITIAL_PARAMETERS | Cause #31 - Request rejected, unspecified | +| | ERROR_TRIGGER_EVENT | Cause #31 - Request rejected, unspecified | +| 403 Forbidden | ERROR_TRAFFIC_MAPPING_INFO_REJECTED | Cause #29 - User authentication or authorization failed | +| | POLICY_CONTEXT_DENIED | Cause #29 - User authentication or authorization failed (NOTE) | +| | VALIDATION_CONDITION_NOT_MET | Cause #29 - User authentication or authorization failed | +| | EXCEEDED_UE_SLICE_DATA_RATE | Cause #69 - Insufficient resources for specific slice | +| | EXCEEDED_SLICE_DATA_RATE | Cause #69 - Insufficient resources for specific slice | +| | EXCEEDED_GROUP_DATA_RATE | Cause #69 - Insufficient resources for specific slice | + +NOTE: Upon receiving the cause POLICY CONTEXT DENIED, the SMF may reject the request, or it may accept the request based on the local policy. + +## 5.3 Mapping between Nudm service causes on N10 and 5GSM causes + +### 5.3.1 General + +This clause defines the mapping performed by the SMF between HTTP responses (status codes and Protocol or Application Errors) returned by the UDM to the SMF and the 5GSM causes sent to UEs. + +### 5.3.2 Mapping between Nudm\_UEContextManagement service causes on N10 and 5GSM causes + +#### 5.3.2.1 General + +This clause defines the mapping for the Nudm\_UEContextManagement service (see 3GPP TS 29.503 [5]). + +#### 5.3.2.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures + +**Table 5.3.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures** + +| HTTP status code on N10 | Protocol or Application Error | 5GSM cause to UE | +|-------------------------|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| 403 Forbidden | ROAMING_NOT_ALLOWED | #29 "User authentication or authorization failed" | +| | DNN_NOT_ALLOWED | #27 "Missing or unknown DNN" or
#67 "Insufficient resources for specific slice and DNN"
#70 "Missing or unknown DNN in a slice"
(NOTE) | +| 404 Not Found | USER NOT FOUND | #29 "User authentication or authorization failed" | + +NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. + +### 5.3.3 Mapping between Nudm\_SubscriberDataManagement service causes on N10 and 5GSM causes + +#### 5.3.3.1 General + +This clause defines the mapping for the Nudm\_SubscriberDataManagement service (see 3GPP TS 29.503 [5]). + +#### 5.3.3.2 Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures + +**Table 5.3.3.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by UDM due to N10 failures when consuming Nudm\_SubscriberDataManagement service** + +| HTTP status code on N10 | Protocol or Application Error | 5GSM cause to UE | +|-------------------------|----------------------------------|----------------------------------------------------------------------------------------------------| +| 404 Not Found | USER NOT FOUND
DATA_NOT_FOUND | #29 "User authentication or authorization failed"
#33 "Requested service option not subscribed" | + +NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. + +## 5.4 Mapping between N4 causes and 5GSM causes + +### 5.4.1 General + +N4 error handling and cause codes are defined in 3GPP TS 29.244 [2]. + +The receipt of an N4 error may trigger error handling in SMF. This clause defines the mapping performed by the SMF between when an error received on N4 interface cannot be resolved by SMF and results in the SMF sending a 5GSM message to the UE. + +### 5.4.2 Mapping from N4 to 5GSM cause values + +**Table 5.4.2-1: Mapping from N4 to 5GSM cause values – Request rejected by SMF due to N4 failures** + +| N4 Cause Code | | 5GSM cause to UE | | +|------------------------|-----------------------------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| Cause value
Decimal | Error description | Cause value | Error description | +| 64 | Request rejected
(reason not
specified) | #31 | Request rejected,
unspecified | +| 74 | PFCP entity in
congestion | #26
#38
#69
#67 | Insufficient resources
Network Failure
Insufficient resources
for specific slice
Insufficient resources
for specific slice and
DNN | +| 77 | System failure | #31 | Request rejected,
unspecified | + +## 5.5 Mapping between Nnsacf services causes and 5GSM causes + +### 5.5.1 General + +This clause defines the mapping performed by the SMF between HTTP responses (Status Code and Protocol or Application Errors) returned by the NSACF to the SMF and the 5GSM cause values sent to UEs. + +### 5.5.2 Mapping between Nnsacf\_NSAC service causes on N81 and 5GSM causes + +#### 5.5.2.1 General + +This clause defines the mapping for the Nnsacf\_NSAC service (see 3GPP TS 29.536 [14]). + +#### 5.5.2.2 Mapping from HTTP to 5GSM Cause Values + +**Table 5.X.2.2-1: Mapping from HTTP to 5GSM cause values – Request rejected by NSACF** + +| HTTP status code on N81 | Protocol or Application Error | 5GSM cause to UE | +|-------------------------|-------------------------------|------------------------------------------------| +| 403 Forbidden | ALL_SLICE_FAILED | #69 –Insufficient resources for specific slice | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-10 | CT4#86Bis | | | | | First version of this new TS including:
C4-187375 (Skeleton)
C4-187378 (N11 – 5GMM)
C4-187391 (N8 – 5GMM – Request rejected)
C4-187589 (Scope)
C4-187390 (N4 – 5GMM) | 0.1.0 | +| 2018-12 | CT4#87 | | | | | The following agreed documents are included:
C4-188418 (NSSF)
C4-188484 (Nsmf_PDUSession N11 and N16)
C4-188486 (Cause 5GMM)
C4-188609 (N4)
C4-188637 (N8 and 5GMM)
C4-188638 (EIR)
C4-188640 (N10 and 5GSM)
C4-188641 (N7)
C4-188642 (Nausf)
C4-188643 (N11 5GMM)
C4-188647 (Clean-up) (Conclusion from C4-188384 was wrongly reported to be included in 5GSM General Clause while it applied to 5GMM – corrected by Rapporteur).
C4-188648 (General 5GSM) | 0.2.0 | +| 2018-12 | CT#82 | CP-183104 | | | | Sent for information and approval | 1.0.0 | +| 2018-12 | CT#82 | CP-183104 | | | | Approved in CT#82 | 15.0.0 | +| 2019-03 | CT#83 | CP-190031 | 0001 | 2 | F | Corrections on cause mapping in clause 4 | 15.1.0 | +| 2019-03 | CT#83 | CP-190031 | 003 | 1 | F | Mapping between N11 causes and 5GMM causes | 15.1.0 | +| 2019-03 | CT#83 | CP-190031 | 0008 | 1 | F | Remove EN's in 5.2.2.2 | 15.1.0 | +| 2019-03 | CT#83 | CP-190031 | 0004 | 2 | F | Corrections to 5GMM and 5GSM causes mappings | 15.1.0 | +| 2019-06 | CT#84 | CP-191037 | 0012 | - | F | Cause mapping updates | 15.2.0 | +| 2019-06 | CT#84 | CP-191037 | 0013 | 1 | F | Correction on cause mapping regarding no subscription | 15.2.0 | +| 2019-06 | CT#84 | CP-191037 | 0014 | 2 | F | Essential Correction on Error mapping for NSSF Services | 15.2.0 | +| 2019-06 | CT#84 | CP-191037 | 0015 | 1 | F | Essential Correction on mapping for N4 to SBI | 15.2.0 | +| 2019-06 | CT#84 | CP-191037 | 0016 | 1 | F | Cause mapping corrections | 15.2.0 | +| 2019-06 | CT#84 | CP-191037 | 0017 | 1 | F | Add a mapping for N10 | 15.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0019 | 2 | F | Add new mapping towards Cause #62 (No Network Slices available) | 16.0.0 | +| 2020-06 | CT#88e | CP-201034 | 0020 | 1 | F | Correction of the mapping between PCF service causes and 5GSM causes | 16.1.0 | +| 2021-03 | CT#91e | CP-210027 | 0022 | 1 | D | Use of inclusive terminology | 17.0.0 | +| 2021-03 | CT#91e | CP-210028 | 0023 | 1 | F | ERROR CONFLICTING REQUEST | 17.0.0 | +| 2021-06 | CT#92e | CP-211146 | 0024 | | F | Editorial Correction | 17.1.0 | +| 2021-09 | CT#93e | CP-212230 | 0025 | 1 | B | Cause Mapping for NSAC | 17.2.0 | +| 2021-12 | CT#94e | CP-213086 | 0026 | - | F | Mapping for the cause from Nudm_SubscriberDataManagement | 17.3.0 | +| 2023-12 | CT#102 | CP-233064 | 0028 | 1 | F | Cause mapping for EXCEEDED_UE_SLICE_DATA_RATE and EXCEEDED_SLICE_DATA_RATE | 17.4.0 | +| 2023-12 | CT#102 | CP-233047 | 0027 | - | B | Cause mapping for EXCEEDED_GROUP_DATA_RATE | 18.0.0 | \ No newline at end of file diff --git a/gsma/29_series/29525/raw.md b/gsma/29_series/29525/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..db1c7eed30e013d1ba88293d5a9bf61c7ac432bf --- /dev/null +++ b/gsma/29_series/29525/raw.md @@ -0,0 +1,3926 @@ + + +# 3GPP TS 29.525 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; UE Policy Control Service; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +--- + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in small letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +## --- **Keywords** + +3GPP, 5G System + +## **3GPP** + +## --- **Postal address** + +### --- **3GPP support office address** + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +## --- **Internet** + + + +## --- **Copyright Notification** + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 UE Policy Control Service..... | 10 | +| 4.1 Service Description ..... | 10 | +| 4.1.1 Overview ..... | 10 | +| 4.1.2 Service Architecture ..... | 11 | +| 4.1.3 Network Functions ..... | 12 | +| 4.1.3.1 Policy Control Function (PCF)..... | 12 | +| 4.1.3.2 NF Service Consumers ..... | 13 | +| 4.2 Service Operations ..... | 14 | +| 4.2.1 Introduction ..... | 14 | +| 4.2.2 Npcf_UEPolicyControl_Create Service Operation..... | 15 | +| 4.2.2.1 General..... | 15 | +| 4.2.2.2 UE Policy..... | 20 | +| 4.2.2.2.1 Overview ..... | 20 | +| 4.2.2.2.1.0 General ..... | 20 | +| 4.2.2.2.1.1 Provisioning of the UE Access Network discovery and selection policies and UE Route Selection Policy ..... | 22 | +| 4.2.2.2.1.1a Provisioning of URSP in EPS ..... | 23 | +| 4.2.2.2.1.2 Provisioning of Vehicle-to-Everything Policy ..... | 25 | +| 4.2.2.2.1.3 Provisioning of ProSe Policy..... | 25 | +| 4.2.2.2.1.4 Provisioning of Aircraft-to-Everything Policy ..... | 26 | +| 4.2.2.2.1.5 Provisioning of Ranging and Sidelink Positioning Policy ..... | 26 | +| In the roaming or non-roaming case, the (V-)PCF shall use the Namf_Communication_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send the RSLPP to the UE. | | +| 4.2.2.2.2 UE Access Network discovery and selection policies (ANDSP) ..... | 26 | +| 4.2.2.2.3 UE Route Selection Policy (URSP) ..... | 27 | +| 4.2.2.2.3.1 General ..... | 27 | +| 4.2.2.2.3.2 Provisioning of VPLMN-specific URSP Rules ..... | 30 | +| 4.2.2.2.4 Vehicle-to-Everything Policy (V2XP)..... | 31 | +| 4.2.2.2.5 Proximity based Services Policy (ProSeP)..... | 31 | +| 4.2.2.2.6 Aircraft-to-Everything Policy (A2XP)..... | 31 | +| 4.2.2.2.7 Ranging and Sidelink Positioning Policy (RSLPP) ..... | 31 | +| 4.2.2.3 V2X N2 PC5 Policy..... | 31 | +| 4.2.2.4 5G ProSe N2 PC5 Policy ..... | 32 | +| 4.2.2.5 A2X N2 PC5 Policy..... | 32 | +| 4.2.2.6 Ranging/SL N2 PC5 Policy ..... | 32 | +| 4.2.3 Npcf_UEPolicyControl_Update Service Operation..... | 33 | +| 4.2.3.1 General..... | 33 | +| 4.2.3.2 Policy Control Request Triggers..... | 37 | +| 4.2.3.3 Encoding of updated policy ..... | 38 | +| 4.2.3.4 Feature renegotiation during AMF relocation ..... | 39 | +| 4.2.4 Npcf_UEPolicyControl_UpdateNotify Service Operation ..... | 40 | +| 4.2.4.1 General..... | 40 | +| 4.2.4.2 Policy update notification ..... | 40 | +| 4.2.4.3 Request for termination of the policy association ..... | 42 | +| 4.2.4.4 URSP provisioning for Background Data Transfer policy ..... | 43 | +| 4.2.4.5 UE policy provisioning for V2X communication over PC5 and Uu reference points ..... | 44 | +| 4.2.4.6 UE policy provisioning for 5G ProSe..... | 44 | +| 4.2.4.7 UE policy provisioning for AF-influenced URSP..... | 44 | + +| | | | +|-------------|-----------------------------------------------------------------------------------------------------------|----| +| 4.2.4.8 | UE policy provisioning for A2X communication over PC5 and A2X communication over Uu reference point ..... | 45 | +| 4.2.4.9 | URSP provisioning in EPS. .... | 45 | +| 4.2.4.10 | UE policy provisioning for Ranging/SL ..... | 45 | +| 4.2.5 | Npcf_UEPolicyControl_Delete Service Operation ..... | 46 | +| 5 | Npcf_UEPolicyControl API ..... | 47 | +| 5.1 | Introduction ..... | 47 | +| 5.2 | Usage of HTTP..... | 47 | +| 5.2.1 | General ..... | 47 | +| 5.2.2 | HTTP standard headers ..... | 47 | +| 5.2.2.1 | General..... | 47 | +| 5.2.2.2 | Content type ..... | 47 | +| 5.2.3 | HTTP custom headers ..... | 48 | +| 5.3 | Resources ..... | 48 | +| 5.3.1 | Resource Structure..... | 48 | +| 5.3.2 | Resource: UE Policy Associations ..... | 48 | +| 5.3.2.1 | Description..... | 48 | +| 5.3.2.2 | Resource definition..... | 48 | +| 5.3.2.3 | Resource Standard Methods ..... | 49 | +| 5.3.2.3.1 | POST ..... | 49 | +| 5.3.3 | Resource: Individual UE Policy Association ..... | 49 | +| 5.3.3.1 | Description..... | 49 | +| 5.3.3.2 | Resource definition..... | 49 | +| 5.3.3.3 | Resource Standard Methods ..... | 50 | +| 5.3.3.3.1 | GET ..... | 50 | +| 5.3.3.3.2 | DELETE..... | 51 | +| 5.3.3.4 | Resource Custom Operations..... | 52 | +| 5.3.3.4.1 | Overview ..... | 52 | +| 5.3.3.4.2 | Operation: Update ..... | 52 | +| 5.3.3.4.2.1 | Description ..... | 52 | +| 5.3.3.4.2.2 | Operation Definition..... | 52 | +| 5.4 | Custom Operations without associated resources ..... | 53 | +| 5.5 | Notifications ..... | 54 | +| 5.5.1 | General ..... | 54 | +| 5.5.2 | Policy Update Notification ..... | 54 | +| 5.5.2.1 | Description..... | 54 | +| 5.5.2.2 | Operation Definition ..... | 54 | +| 5.5.3 | Request for termination of the UE policy association..... | 55 | +| 5.5.3.1 | Description..... | 55 | +| 5.5.3.2 | Operation Definition ..... | 55 | +| 5.6 | Data Model..... | 56 | +| 5.6.1 | General ..... | 56 | +| 5.6.2 | Structured data types ..... | 59 | +| 5.6.2.1 | Introduction..... | 59 | +| 5.6.2.2 | Type PolicyAssociation ..... | 60 | +| 5.6.2.3 | Type PolicyAssociationRequest ..... | 61 | +| 5.6.2.4 | Type PolicyAssociationUpdateRequest..... | 64 | +| 5.6.2.5 | Type PolicyUpdate ..... | 67 | +| 5.6.2.6 | Type TerminationNotification ..... | 68 | +| 5.6.2.7 | Type UePolicyTransferFailureNotification ..... | 68 | +| 5.6.2.8 | Type UeRequestedValueRep ..... | 69 | +| 5.6.2.9 | Type UePolicyParameters..... | 70 | +| 5.6.2.10 | Type LboRoamingInformation ..... | 70 | +| 5.6.2.11 | Type UrspEnforcementPduSession ..... | 71 | +| 5.6.2.12 | Type UePolicyNotification ..... | 71 | +| 5.6.3 | Simple data types and enumerations ..... | 71 | +| 5.6.3.1 | Introduction..... | 71 | +| 5.6.3.2 | Simple data types..... | 72 | +| 5.6.3.3 | Enumeration: RequestTrigger..... | 72 | +| 5.6.3.4 | Enumeration: PolicyAssociationReleaseCause ..... | 74 | +| 5.6.3.5 | Enumeration: Pc5Capability ..... | 74 | + +| | | | +|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.6.3.6 | Enumeration: ProSeCapability ..... | 74 | +| 5.6.3.8 | Enumeration: AccessStatus..... | 75 | +| 5.6.3.9 | Enumeration: N1N2MessTransferErrorReply ..... | 75 | +| 5.6.4 | Data types describing alternative data types or combinations of data types ..... | 76 | +| 5.6.4.1 | Type: UePolicyTransferFailureCause..... | 76 | +| 5.7 | Error handling ..... | 76 | +| 5.7.1 | General ..... | 76 | +| 5.7.2 | Protocol Errors..... | 76 | +| 5.7.3 | Application Errors ..... | 76 | +| 5.8 | Feature negotiation..... | 77 | +| 5.9 | Security..... | 79 | +| Annex A (normative): OpenAPI specification..... | | 80 | +| A.1 | General..... | 80 | +| A.2 | Npcf_UEPolicyControl API ..... | 80 | +| Annex B (normative): Wireless and wireline convergence access support..... | | 93 | +| B.1 | Scope..... | 93 | +| B.2 | Npcf_UEPolicyControl Service..... | 94 | +| B.2.1 | Service Description ..... | 94 | +| B.2.1.1 | Overview ..... | 94 | +| B.2.1.2 | Service Architecture ..... | 94 | +| B.2.1.3 | Network Functions ..... | 94 | +| B.2.1.3.1 | Policy Control Function (PCF) ..... | 94 | +| B.2.1.3.2 | NF Service Consumers ..... | 94 | +| B.3 | Service Operations ..... | 94 | +| B.3.1 | Introduction ..... | 94 | +| B.3.2 | Npcf_UEPolicyControl_Create Service Operation..... | 95 | +| B.3.2.1 | General ..... | 95 | +| B.3.3 | Npcf_UEPolicyControl_Update Service Operation..... | 95 | +| B.3.3.1 | General ..... | 95 | +| B.3.4 | Npcf_UEPolicyControl_UpdateNotify Service ..... | 95 | +| B.3.4.1 | General ..... | 95 | +| B.3.5 | Npcf_UEPolicyControl_Delete Service Operation..... | 96 | +| B.3.5.1 | General ..... | 96 | +| Annex C (informative): Withdrawn API versions ..... | | 97 | +| Annex D (informative): Change history..... | | 98 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +# --- 1 Scope + +The present specification provides the stage 3 definition of the UE Policy Control Service (Npcf\_UEPolicyControl) of the 5G System. + +The stage 2 definition and procedures of UE Policy Control Service are contained in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4]. The 5G System Architecture is defined in 3GPP TS 23.501 [2]. + +Stage 3 call flows are provided in 3GPP TS 29.513 [7]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition of the 5G System are specified in 3GPP TS 29.500 [5] and 3GPP TS 29.501 [6]. + +The UE Policy Control Service is provided by the Policy Control Function (PCF). This service provides UE policies and N2 PC5 policy. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [6] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [7] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [11] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [12] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [13] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [14] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [15] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [16] 3GPP TS 24.526: "UE policies for 5G System (5GS); Stage 3". + +- [17] 3GPP TS 29.519: "5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; Stage 3". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [19] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [20] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [21] IETF RFC 9457: "Problem Details for HTTP APIs". +- [22] 3GPP TR 21.900: "Technical Specification Group working methods". +- [23] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [24] 3GPP TS 24.587: "Vehicle-to-Everything (V2X) services in 5G System (5GS); Stage 3". +- [25] 3GPP TS 24.588: "Vehicle-to-Everything (V2X) services in 5G System (5GS); User Equipment (UE) policies; Stage 3". +- [26] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository service for Subscription Data; Stage 3". +- [27] 3GPP TS 29.504: "5G System; Unified Data Repository Services; Stage 3". +- [28] 3GPP TS 24.554: "Proximity based services (ProSe) in 5G system (5GS) protocol aspects; Stage 3". +- [29] 3GPP TS 24.555: "Proximity based services (ProSe) in 5G system (5GS); User Equipment (UE) policies; Stage 3". +- [30] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [31] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [32] 3GPP TS 24.577: "Aircraft-to-Everything (A2X) services in 5G System (5GS) protocol aspects; Stage 3". +- [33] 3GPP TS 24.588: "Aircraft-to-Everything (A2X) services in 5G System (5GS); UE policies". +- [34] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3" +- [35] 3GPP TS 29.521: "5G System; Binding Support Management Service; Stage 3". +- [36] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [37] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [38] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [39] 3GPP TS 29.594: "5G System; Spending Limit Control Service; Stage 3". +- [40] 3GPP TS 29.502: "5G System; Session Management Services; Stage 3". +- [41] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [42] 3GPP TS 24.514: "Ranging based services and sidelink positioning in 5G system(5GS); Stage 3". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.503 [4], subclause 3.1 and 3GPP TS 23.501 [2], clause 3.1 apply: + +### VPLMN specific URSP rules + +### Configured NSSAI + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|-----------------------------------------------| +| 5G-BRG | 5G Broadband Residential Gateway | +| 5G-CRG | 5G Cable Residential Gateway | +| 5G-RG | 5G Residential Gateway | +| 5G-VN | 5G Virtual Network | +| A2X | Aircraft-to-Everything | +| A2XP | Aircraft-to-Everything Policy | +| AMF | Access and Mobility Management Function | +| ANDSP | Access Network Discovery and Selection Policy | +| API | Application Programming Interface | +| CHF | Charging Function | +| DNN | Data Network Name | +| EPS | Evolved Packet Core System | +| FN-RG | Fixed Network Residential Gateway | +| FN-BRG | Fixed Network Broadband Residential Gateway | +| FN-CRG | Fixed Network Cable Residential Gateway | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HFC | Hybrid Fiber-Coaxial | +| HTTP | Hypertext Transfer Protocol | +| H-PCF | Home Policy Control Function | +| JSON | JavaScript Object Notation | +| N3AN | Non-3GPP access network | +| N3IWF | Non-3GPP InterWorking Function | +| NID | Network Identifier | +| NF | Network Function | +| NRF | Network Repository Function | +| NSWO | Non-Seamless WLAN Offload | +| OS | Operating System | +| OSId | Operating System Identity | +| PCF | Policy Control Function | +| PDU | Packet Data Unit | +| PEI | Permanent Equipment Identifier | +| PIN | Personal IoT Network | +| PRA | Presence Reporting Area | +| ProSeP | 5G ProSe Policy | +| PTI | Procedure Transaction Identity | +| RSLPP | Ranging and Sidelink Positioning Policy | + +| | | +|---------|-----------------------------------| +| RSN | Redundancy Sequence Number | +| SL | Sidelink | +| SMF | Session Management Function | +| SNPN | Stand-alone Non-Public Network | +| SSC | Service and Session Continuity | +| SUPI | Subscription Permanent Identifier | +| TNGF | Trusted Non-3GPP Gateway Function | +| UDR | Unified Data Repository | +| UPSC | UE policy section code | +| UPSI | UE policy section identifier | +| URSP | UE Route Selection Policy | +| V2X | Vehicle-to-Everything | +| V2XP | Vehicle-to-Everything Policy | +| V-PCF | Visited Policy Control Function | +| VPS | VPLMN Specific | +| W-5GAN | Wireline 5G Access Network | +| W-5GCAN | Wireline 5G Cable Access Network | +| W-AGF | Wireline Access Gateway Function | + +# --- 4 UE Policy Control Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The UE Policy Control Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Policy Control Function (PCF). + +This service is used as part of the provisioning of UE policies (e.g. ANDSP, URSP, V2XP, A2XP, ProSeP, RSLPP) determined by the PCF to the UE via the AMF and as part of the provisioning of N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL determined by the PCF to the NG-RAN via the AMF. In case of URSP provisioning in EPS this service may be used as part of the provisioning of URSP determined by the PCF to the UE via a PCF for a PDU session. This service hence offers the following functionalities: + +- creation of a UE Policy Association as requested by the NF service consumer (e.g. AMF); +- provisioning of policy control request trigger(s) to the NF service consumer (e.g. AMF); +- provisioning of the UE policy (e.g. ANDSP, URSP, V2XP, A2XP, ProSeP, RSLPP) to the V-PCF by the H-PCF in the roaming case; +- provisioning of the N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL to the V-PCF by the H-PCF in the roaming case; +- update of a UE Policy Association as requested by the NF service consumer (e.g. AMF); +- reporting of the met policy control request trigger(s) by the NF service consumer; +- update of policy control request trigger(s) by the PCF to the NF service consumer (e.g. AMF); +- deletion of a UE Policy Association as requested by the NF service consumer (e.g. AMF); +- enable the PCF to request the termination of a UE Policy Association to the NF service consumer (e.g. AMF) ; and +- provisioning of the URSP to a PCF for a PDU session in case of URSP provisioning in EPS. +- support of N3IWF/TNGF selection based on the UE requested NSSAI. + +### 4.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Policy and Charging related 5G architecture is also described in 3GPP TS 29.513 [7]. + +The UE Policy Control Service (Npcf\_UEPolicyControl) is part of the Npcf service-based interface exhibited by the Policy Control Function (PCF). + +The known NF service consumers of the Npcf\_UEPolicyControl service are the Access and Mobility Management Function (AMF) and the Visited Policy Control Function (V-PCF). + +The AMF accesses the UE Policy Control Service at the PCF via the N15 reference point. In case of URSP delivery in EPS, when the PCF for the PDU session and the PCF for the UE are different, the PCF for the PDU session accesses the UE Policy Control Service at the PCF via the N43 reference point, + +In the roaming scenario, the N15 reference point is located between the V-PCF in the visited network and the AMF. The V-PCF accesses the UE Policy Control Service at the Home Policy Control Function (H-PCF) via the N24 Reference point. + +![Figure 4.1.2-1: Reference Architecture for the Npcf_UEPolicyControl Service; SBI representation](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +This diagram illustrates the Service Based Interface (SBI) representation of the Npcf\_UEPolicyControl service. At the top, a box labeled 'PCF' contains an oval labeled 'Npcf', representing the service provider. A vertical line labeled 'Npcf\_UEPolicyControl' descends from the 'Npcf' oval to a horizontal bus line. Below this bus line, three boxes are connected: 'AMF', 'V-PCF', and 'PCF', representing service consumers. + +Figure 4.1.2-1: Reference Architecture for the Npcf\_UEPolicyControl Service; SBI representation + +Figure 4.1.2-1: Reference Architecture for the Npcf\_UEPolicyControl Service; SBI representation + +![Figure 4.1.2-2: Non-roaming Reference Architecture for the Npcf_UEPolicyControlService; reference point representation](b3c108e7145f2017957569d06ea359cb_img.jpg) + +This diagram shows the non-roaming reference architecture using reference points. At the top is a box labeled 'PCF'. Below it, a box labeled 'AMF' is connected to the 'PCF' via a line labeled 'N15'. To the right, another box labeled 'PCF' is connected to the top 'PCF' via a line labeled 'N43'. + +Figure 4.1.2-2: Non-roaming Reference Architecture for the Npcf\_UEPolicyControlService; reference point representation + +Figure 4.1.2-2: Non-roaming Reference Architecture for the Npcf\_UEPolicyControlService; reference point representation + +NOTE 1: When the N43 reference point exists, i.e. when the PCF is a NF service consumer of the Npcf\_UEPolicyControl service, the PCF for the PDU session interacts with the PCF for the UE, and the non-roaming and home routed roaming architecture are the same. + +![Diagram of Roaming reference Architecture for the Npcf_UEPolicyControlService. It shows a hierarchy of Network Functions (NFs). At the top is H-PCF. Below it is V-PCF, connected via the N24 interface. Below the V-PCF are two NFs: AMF and V-PCF. The AMF is connected to the V-PCF via the N15 interface. The V-PCF (bottom) is connected to the V-PCF (middle) via the N43 interface.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +``` + +graph TD + H-PCF[H-PCF] ---|N24| V-PCF_Mid[V-PCF] + V-PCF_Mid ---|N15| AMF[AMF] + V-PCF_Mid ---|N43| V-PCF_Bot[V-PCF] + +``` + +Diagram of Roaming reference Architecture for the Npcf\_UEPolicyControlService. It shows a hierarchy of Network Functions (NFs). At the top is H-PCF. Below it is V-PCF, connected via the N24 interface. Below the V-PCF are two NFs: AMF and V-PCF. The AMF is connected to the V-PCF via the N15 interface. The V-PCF (bottom) is connected to the V-PCF (middle) via the N43 interface. + +**Figure 4.1.3-2: Roaming reference Architecture for the Npcf\_UEPolicyControlService; reference point representation** + +NOTE 2: In LBO roaming scenarios, the V-PCF for the PDU session interacts with the V-PCF for the UE (i.e., the V-PCF for the PDU session is a NF service consumer of the Npcf\_UEPolicyControl service offered by the V-PCF of the UE). + +### 4.1.3 Network Functions + +#### 4.1.3.1 Policy Control Function (PCF) + +For non-roaming scenarios, the Policy Control Function (PCF): + +- supports unified policy framework to govern network behaviour; +- provides UE policy, including Access Network Discovery and Selection Policy (ANDSP), UE Route Selection Policy (URSP), Vehicle-to-Everything Policy (V2XP), Aircraft-to-Everything Policy (A2XP), 5G ProSe Policy (ProSeP) and/or Ranging and Sidelink Positioning Policy (RSLPP) via the AMF transparently to the UE; +- provides policy control request trigger(s) to the AMF; + +NOTE 1: The PCF invokes the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provide the UE Policy. + +- provides N2 PC5 policy, containing the PC5 QoS parameters used by NG-RAN for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL via the AMF to the NG-RAN; + +NOTE 2: The PCF invokes the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provide the N2 PC5 Policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL. + +- provides URSP via a PCF for a PDU session transparently to the UE in case of URSP provisioning in EPS; and +- provides policy control request trigger(s) to a PCF for a PDU session in case of URSP provisioning in EPS. +- support of N3IWF/TNGF selection based on the UE requested NSSAI. + +For roaming scenarios, the Visited Policy Control Function (V-PCF): + +- provides policy control request trigger(s) to the AMF; +- provides the ANDSP of the VPLMN via the AMF transparently to the UE; +- forwards the ANDSP, URSP, V2XP, A2XP, ProSeP and/or RSLPP received from the H-PCF via the AMF to the UE; + +NOTE 3: The V-PCF invokes the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provide the UE Policy. + +- forwards the N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL received from the H-PCF via the AMF to the NG-RAN; + +NOTE 4: The V-PCF invokes the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provide the N2 PC5 Policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL. + +- for the LBO roaming scenarios, provides policy control request trigger(s) to a V-PCF for a PDU session in case of URSP provisioning in EPS; and +- for the LBO roaming scenarios, forwards the URSP received from the H-PCF via a V-PCF for a PDU session to the UE in case of URSP provisioning in EPS. + +For roaming scenarios, the Home Policy Control Function (H-PCF): + +- provides policy control request trigger(s) to the V-PCF; +- provides the UE policy (e.g. ANDSP, URSP, V2XP, A2XP, ProSeP or RSLPP) of the HPLMN to the V-PCF for forwarding to the UE via the AMF; +- provides the N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL to the V-PCF for forwarding to the NG-RAN via the AMF; and +- in case of URSP provisioning in EPS: + - a. for the LBO roaming scenarios, provides URSP to the V-PCF for forwarding to the UE via a V-PCF for a PDU session. + - b. for the Home Routed scenarios, provides URSP to the PCF for the PDU session in the HPLMN, for forwarding to the UE via the H-SMF. + +The policy decisions made by the PCF may also be based on one or more of the following: + +- Information obtained from the UDR (e.g., UE Policy Subscription data and/or Service Parameter Data provided by the AF/NEF via the UDR); +- Information obtained from the AMF, e.g., UE related and access related information; +- Information obtained from the NWDAF; +- Information from the CHF about spending limits control, e.g., status of each relevant policy counter and optional pending policy counter statuses; and + +NOTE 5: In this release of the specification, policy decisions based on spending limits control apply to URSP only. + +- PCF pre-configured policy context. + +#### 4.1.3.2 NF Service Consumers + +The known NF service consumers of the Npcf\_UEPolicyControl are the AMF, the V-PCF in the roaming case, and a PCF for a PDU session in case of URSP provisioning in EPS. + +The Access and Mobility Management function (AMF) performs: + +- registration management; +- connection management; + +- reachability management; +- mobility Management; +- forwarding of UE Policy towards the served UE; +- reporting of the UE state to the (V-)PCF; +- forwarding of the UE policy enforcement result received from the UE to the (V-)PCF; and + +NOTE: The AMF invokes the Namf\_Communication service specified in 3GPP TS 29.518 [14] to report the UE policy enforcement result. + +- forwarding of the N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL towards the NG-RAN. + +The Visited Policy Control Function (V-PCF) provides the functions described in clause 4.1.3.1 towards the visited network as NF service producer and acts as NF Service consumer toward the H-PCF, performing the following functions: + +- receiving policy control request trigger(s) and/or UE policy (e.g. ANDSP, URSP, V2XP, A2XP, ProSeP, RSLPP) from the H-PCF; +- receiving the N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe and/or Ranging/SL from the H-PCF; and +- reporting of the UE state and UE policy enforcement result to the H-PCF. +- providing the URSP rule enforcement report received from the UE to the H-PCF, if requested by the H-PCF as described in clause 4.2.2.2.3. + +The PCF for a PDU session in case of URSP provisioning in EPS performs: + +- forwarding of URSP towards the served UE. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Npcf\_UEPolicyControl Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------| +| Npcf_UEPolicyControl_Create | Creates a UE Policy Association. | NF service consumer (e.g. AMF, V-PCF in roaming case) | +| Npcf_UEPolicyControl_Update | Updates a UE Policy Association and provides the corresponding policies to the NF service consumer when policy control request trigger(s) is/are met or the AMF is relocated due to the UE mobility and the old PCF is selected. | NF service consumer (e.g. AMF, V-PCF in roaming case) | +| Npcf_UEPolicyControl_UpdateNotify |
  • - Provides the updated policy control request trigger(s) and/or applicable indications to the AMF by the (V-)PCF in the non-roaming or roaming case;
  • - Provides the updated UE policy, applicable indications, and/or policy control request trigger(s) to the V-PCF by the H-PCF; or
  • - Initiates the UE Policy association termination towards the NF service consumer by the NF service producer.
| PCF (H-PCF and V-PCF in roaming case) | +| Npcf_UEPolicyControl_Delete | Provides means for the NF service consumer to delete a UE Policy Association. | NF service consumer (e.g. AMF, V-PCF in roaming case) | + +### 4.2.2 Npcf\_UEPolicyControl\_Create Service Operation + +#### 4.2.2.1 General + +The procedure in the present clause is applicable when the NF service consumer creates a UE policy association in the following cases: + +- UE performs initial registration to the network, as defined in clause 5.5.1.2.2 of 3GPP TS 24.501 [15]; +- UE performs a mobility registration, if the UE operating in single-registration mode performs inter-system change from S1 mode to N1 mode, as defined in clause 5.5.1.3.2 of 3GPP TS 24.501 [15], and there is no existing UE Policy Association between AMF and PCF for this UE; and +- the AMF is relocated (between the different AMF sets) and the new AMF selects a new PCF. The procedure for the case where the AMF is relocated and the new AMF selects the old PCF is defined in clause 4.2.3.1. + +To support the delivery of URSP in EPC, the procedure in the present clause is also applicable when: + +- When the UE triggers a BEARER RESOURCE MODIFICATION REQUEST message with a UE policy container IE after the UE performs ePCO capability negotiation during PDN connection establishment (during the Initial Attach with default PDN connection establishment or the first PDN connection establishment) procedure as defined in 3GPP TS 24.301 [33], and both, the UE and the network support URSP provisioning in EPS PCO; and +- 5GS to EPS handover or 5GS to EPS Idle Mode mobility (both referred as 5GS to EPS mobility in the present document) as defined in 3GPP TS 24.501 [15]. + +The creation of a UE policy association only applies for normally registered UEs, i.e. it does not apply for emergency-registered UEs. + +Figure 4.2.2.1-1 illustrates the procedure used for the creation of a policy association. + +![Sequence diagram showing the creation of a UE policy association between an NF service consumer and a PCF.](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../policies + NF service consumer->>PCF: 1. POST .../policies + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: 2. "201 Created" +``` + +The diagram illustrates a sequence of two messages between an 'NF service consumer' and a 'PCF'. The first message, labeled '1. POST .../policies', is sent from the NF service consumer to the PCF. The second message, labeled '2. "201 Created"', is sent from the PCF back to the NF service consumer. + +Sequence diagram showing the creation of a UE policy association between an NF service consumer and a PCF. + +Figure 4.2.2.1-1: Creation of a UE policy association + +NOTE 1: For the roaming scenario, the PCF represents the V-PCF, if the NF service consumer is an AMF, and the PCF represents the H-PCF, if the NF service consumer is a V-PCF. + +When a UE registers to the network and a UE context is being established, if the AMF obtains from the UE a UE policy delivery protocol message as defined in Annex D of 3GPP TS 24.501 [15] and/or the authorized PC5 capability for 5G ProSe, and/or the authorized PC5 capability for V2X communications and/or A2X communications, and/or the authorized PC5 capability for Ranging/SL, the AMF shall establish a UE policy association with the (V-)PCF, in case there is no existing UE policy association for the UE; otherwise, the AMF may establish a UE Policy Association with the (V-)PCF based on AMF local configuration. + +NOTE 2: In the roaming scenario, the visited AMF's local configuration can indicate whether UE Policy delivery is needed based on the roaming agreement with the home PLMN of the UE. + +During UE Initial Attach with default PDN connection or the establishment of the first PDN connection in EPS, if the UE and the SMF+PGW support URSP provisioning in EPS PCO, and the "EpsUrsp" feature is supported between the + +SMF+PGW-C and the PCF for the PDU session, the PCF for a PDU session associated with the SMF+PGW-C serving the PDN connection obtains from the UE a UE policy container in a Npcf\_SMPolicyControl\_Update procedure triggered by a bearer resource modification procedure as described in 3GPP TS 29.512 [31]. Then, if the "EpsUrsp" feature described in clause 5.8 is supported, the PCF for a PDU session shall establish a UE policy association with the (V-)PCF for the UE for the delivery of URSP only. + +During 5GS to EPS mobility with N26, and if the "EpsUrsp" feature described in clause 5.8 is supported, the PCF for the PDU session determines whether 5GS to EPS mobility applies based on the received RAT and/or Access-Type change event as described in 3GPP TS 29.512 [31]. Then, for non-roaming and Home Routed roaming scenarios, the PCF for a PDU session shall determine whether the UE supports URSP provisioning in EPS by checking the UE Policy Set information in UDR as specified in 3GPP TS 29.519 [17], and if supported, shall establish a UE policy association with the PCF for the UE that is handling the UE policy association with the source AMF. For LBO roaming scenarios, the V-PCF for the PDU session determines based on local configuration whether to establish a UE Policy Association towards the V-PCF for the UE. + +NOTE 3: The PCF for the PDU session discovers the address of the PCF for the UE handling the UE policy association with the source AMF by querying the BSF as described in 3GPP TS 29.521 [22]. + +To establish a UE policy association with the PCF, the NF service consumer (e.g. AMF) shall send an HTTP POST request with "{apiRoot}/npcf-ue-policy-control/v1/policies" as Resource URI and the PolicyAssociationRequest data structure as request body, which shall include: + +- the Notification URI encoded as "notificationUri" attribute; +- the SUPI encoded as "supi" attribute; and +- the features supported by the NF service consumer encoded as "suppFeat" attribute, + +shall also include, when available: + +- the GPSI encoded as "gpsi" attribute; +- the Access type encoded as "accessType" attribute; +- the Permanent Equipment Identifier (PEI) encoded as "pei" attribute; +- the User Location Information encoded as "userLoc" attribute; +- the UE Time Zone encoded as "timeZone" attribute; +- the identifier of the serving network (the PLMN Identifier or the SNPN Identifier), encoded as "servingPlmn" attribute; + +NOTE 4: The SNPN Identifier consists of the PLMN Identifier and the NID. + +- the RAT type encoded as "ratType" attribute; +- the received UE policy delivery protocol message defined in Annex D of 3GPP TS 24.501 [15] encoded as "uePolReq" attribute; +- for the roaming scenario, if the NF service consumer is an AMF, the H-PCF ID encoded as "hPcfId" attribute; +- the Internal Group Identifier(s) encoded as "groupIds" attribute; +- the PC5 capability for V2X encoded as "pc5Capab" attribute if the "V2X" feature defined in clause 5.8 is supported; +- the 5G ProSe capability within the "proSeCapab" attribute, if the "ProSe" feature defined in clause 5.8 is supported; +- the Ranging/SL capability within the "rangingSlCapab" attribute, if the "Ranging\_SL" feature defined in clause 5.8 is supported; +- if the NF service consumer is an AMF, the GUAMI encoded as "guami" attribute; +- if the NF service consumer is an AMF, the serving AMF Id encoded as "servingNfId" attribute; + +NOTE 5: If the PCF received the "servingNfId" attribute, the PCF can use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] to retrieve the NF profile of the Namf\_Communication service available in the indicated AMF instance Id. + +- if the NF service consumer is an AMF, the "SliceAwareANDSP" feature is supported, and the AMF has determined that the UE has selected a non-3gpp access node (i.e. TNGF or N3IWF) that does not match its subscribed S-NSSAI(s) (or Configured NSSAI, in the roaming case), the wrongly selected non-3gpp access node encoded as "n3gNodeReSel" attribute, and, in the roaming case, also the Configured NSSAI for the serving PLMN encoded as "confSnssais" attribute; +- if the NF service consumer is an AMF, the Satellite Backhaul Category encoded as "satBackhaulCategory" attribute, if the "EnSatBackhaulCategoryChg" feature defined in clause 5.8 is supported +- if the NF service consumer is the PCF for the PDU session, and the "EpsUrsp" feature defined in clause 5.8 is supported, the indication that the trigger for the UE Policy Association Establishment is the 5GS to EPS mobility scenario encoded as the "5gsToEpsMob" attribute. +- for the roaming scenario, if the NF service consumer is an AMF and the "NssaiChange" feature is supported, the Configured NSSAI for the serving PLMN encoded as "confSnssais" attribute and optionally the mapped each S-NSSAI value of home network corresponding to the configured S-NSSAI values in the serving PLMN encoded as "mappedHomeSnssai" attribute within the "confSnssais" attribute; +- the PC5 capability for A2X encoded as "pc5CapA2x" attribute if the "A2X" feature defined in clause 5.8 is supported; +- for the roaming scenario, if the NF service consumer is a V-PCF and the "VPLMNSpecificURSP" feature is supported, the AF guidance on VPLMN-specific URSP rules related information, if applicable, within the "vpsUrspGuidance" attribute, that shall contain for each related AF: + - a. the AF guidance on VPLMN-Specific URSP rules within the "urspGuidance" attribute; and + - b. if the AF requested to the VPLMN notifications about the delivery of UE Policies, the "deliveryEvents" attribute including the "SUCCESS\_UE\_POL\_DEL\_SP" and/or "UNSUCCESS\_UE\_POL\_DEL\_SP" events; and +- for the roaming scenario, if the NF service consumer is an AMF, and the "VPLMNSpecificURSP" feature is supported, LBO information within the "lboRoamingInfo" attribute. + +and may include: + +- if the NF service consumer is an AMF, the name of a service produced by the AMF that expects to receive information via the Npcf\_UEPolicyControl\_UpdateNotify service operation encoded as "serviceName" attribute; +- if the NF service consumer is an AMF, the alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; +- if the NF service consumer is an AMF, the alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; +- if the NF service consumer is an AMF, the alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; + +Upon the reception of the HTTP POST request, + +- the (V-)(H-)PCF shall assign a UE policy association ID; +- for the roaming scenario and based on operator policy, the V-PCF (as the NF service consumer) should send to the H-PCF a request for the Creation of a UE policy association as described in the present clause; +- the (V-)(H-)PCF shall determine the applicable UE policy as detailed in clause 4.2.2.2. For the V-PCF, any policy received from the H-PCF in the reply to the possible request for the Creation of a policy association should be taken into consideration; +- if the (V-)PCF determines that UE policy needs to be provisioned, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the UE policy according to clause 4.2.2.2 and as follows: + +- (i) the (V-)PCF shall subscribe to the AMF to notifications on N1 messages for UE Policy Delivery Results using the Namf\_Communication\_N1N2MessageSubscribe service operation; + - (ii) the (V-)PCF shall send the determined UE policy (e.g. ANDSP, URSP, V2XP, A2XP, ProSeP, RSLPP) using Namf\_Communication\_N1N2MessageTransfer service operation(s); and + - (iii) the (V-)PCF shall be prepared to receive UE Policy Delivery Results from the AMF and/or subsequent UE policy requests (e.g. for V2XP and/or A2XP and/or ProSeP and/or RSLPP) within the Namf\_Communication\_N1MessageNotify service operation. For the V-PCF, if the received UE Policy Delivery results relate to UE policy sections provided by the H-PCF, the V-PCF shall use the Npcf\_UEPolicyControl\_Update Service Operation defined in clause 4.2.3 to send those UE Policy Delivery results to the H-PCF; +- if the UE indicates the support of V2X communications over PC5 reference point and the "V2X" feature is supported, the (H-)PCF shall determine the applicable V2XP, as detailed in clause 4.2.2.2.1.2, and V2X N2 PC5 policy, as detailed in clause 4.2.2.3 and based on the operator's policy; + - if the UE indicates the support of 5G ProSe and the "ProSe" feature is supported, the (H-)PCF shall determine the applicable ProSeP, as detailed in clause 4.2.2.2.1.3, and 5G ProSe N2 PC5 policy, as detailed in clause 4.2.2.4 and based on the operator's policy; + - if the UE indicates the support of Ranging/SL and the "Ranging\_SL" feature is supported, the (H-)PCF shall determine the applicable RSLPP, as detailed in clause 4.2.2.2.1.X, and Ranging/SL N2 PC5 policy, as detailed in clause 4.2.2.X and based on the operator's policy; + - if the PCF determines that N2 PC5 policy (e.g. for V2X communications, for 5G ProSe, for Ranging/SL) needs to be provisioned, including the case of the V-PCF when receiving the N2 PC5 policy from the H-PCF, the PCF shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the N2 PC5 policy according to clause 4.2.2.3 and/or clause 4.2.2.4; + - if the UE indicates support for URSP provisioning in EPS, the "EpsUrsp" feature is supported, and the (V-)PCF determines that UE policy needs to be provisioned via a PCF for a PDU session, the (V-)PCF shall provision the UE policy according to clause 4.2.2.2 and as follows: + - (i) the (V-)PCF shall send a UE policy container with the determined URSP using Npcf\_UEPolicyControl\_Create response service operation(s); and + - (ii) the (V-)PCF shall be prepared to receive UE Policy Delivery Results from the PCF for a PDU session. The PCF for a PDU session shall use the Npcf\_UEPolicyControl\_Update service operation defined in clause 4.2.3 to send those UE Policy Delivery results to the (V-)PCF; + - if the UE indicates the support of A2X communications over PC5 reference point and the "A2X" feature is supported, the (H-)PCF shall determine the applicable A2XP, as detailed in clause 4.2.2.2.1.4, and V2X N2 PC5 policy, as detailed in clause 4.2.2.5 and based on the operator's policy; +- for the successful case, the (V-)(H-)PCF shall send a HTTP "201 Created" response with the URI for the created resource in the "Location" header field. + +NOTE 6: The assigned policy association ID is part of the URI for the created resource and is thus associated with the SUPI. + +and the PolicyAssociation data type as response body, including: + +- mandatorily, the negotiated supported features encoded as "suppFeat" attribute; +- optionally, the information provided by the NF service consumer when requesting the creation of this policy association encoded as "request" attribute; +- optionally, for the H-PCF as service producer communicating with the V-PCF, UE policy (see clause 4.2.2.2) encoded as "uePolicy" attribute; +- optionally, for the H-PCF as service producer communicating with the V-PCF, N2 PC5 policy (see clause 4.2.2.3 and/or clause 4.2.2.4) encoded as "n2Pc5Pol" attribute (for V2X communications) and/or "n2Pc5PolA2X" attribute (for A2X communications) and/or "n2Pc5ProSePol" attribute (for 5G ProSe); + +- optionally, for the H-PCF as service producer communicating with the V-PCF, N2 PC5 policy (see clause 4.2.2.3 and/or clause 4.2.2.4 and/or clause 4.2.2.X) encoded as "n2Pc5Pol" attribute (for V2X communications) and/or "n2Pc5PolA2x" attribute (for A2X communications) and/or "n2Pc5ProSePol" attribute (for 5G ProSe) and/or "n2Pc5RsppPol" attribute (for Ranging/SL); +- optionally, for the H-PCF as service producer communicating with the V-PCF, and when the feature "UECapabilityIndication" is supported, if the H-PCF did not receive from the UE information about ANDSP support and the information is available and reliable in the UDR (see clause 4.2.2.2.1.1), the ANDSP support indication retrieved from UDR encoded as "andspInd" attribute; +- optionally, one or several of the following Policy Control Request Trigger(s) encoded as "triggers" attribute (see clause 4.2.3.2): + - a) Location change (tracking area); + - b) Change of UE presence in PRA; + - c) Change of PLMN, if the "PlmnChange" feature is supported; + - d) Change of UE connectivity state, if the "ConnectivityStateChange" feature is supported; + - e) URSP rule enforcement information, if the "URSPEnforcement" feature is supported; + - f) Change of Satellite Backhaul Category, if the "EnSatBackhaulCategoryChg" feature is supported; + - g) Change of Access Type, if the "AccessChange" feature is supported; + - h) LBO information change, applicable to roaming scenarios, if the "VPLMNSpecificURSP" feature is supported and the NF service consumer is an AMF; and + - i) Change of Configured NSSAI, in roaming scenarios, if the "NssaiChange" feature is supported and the NF service consumer is the AMF; +- if the Policy Control Request Trigger "Change of UE presence in PRA" is provided, the presence reporting areas for which reporting is required encoded as "pras" attribute; +- if the Policy Control Request Trigger "LBO information change" is provided, optionally, the DNNs(s) and S-NSSAI(s) for which LBO information is required encoded as "pduSessions" attribute; + +NOTE 7: If the PCF uses a Presence Reporting Area identifier referring to a Set of Core Network predefined Presence Reporting Areas as defined in 3GPP TS 23.501 [2], the PCF includes the identifier of this Presence Reporting Area set within the "pralD" attribute. + +- if the SliceAwareANDSP feature is supported, the PCF received the "n3gNodeReSel" attribute and the PCF has successfully delivered the updated ANDSP/WLANSP to the UE with the slice information for the corresponding non-3gpp node, the notification of this successful delivery by providing the "andspDelInd" attribute with the value "true". +- if errors occur when processing the HTTP POST request, the (V-)(H-)PCF shall apply error handling procedures as specified in clause 5.7 and according to the following provisions: + - if the user information received within the "supi" attribute is unknown, the (V-)(H-)PCF shall reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "USER\_UNKNOWN"; and + - if the (V-)(H-)PCF is, due to incomplete, erroneous or missing information in the request, not able to provision a UE policy decision, the (V-)(H-)PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_REQUEST\_PARAMETERS". + +If the (V-)PCF received a GUAMI, the (V-)PCF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [14], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF (service) set. + +#### 4.2.2.2 UE Policy + +##### 4.2.2.2.1 Overview + +###### 4.2.2.2.1.0 General + +The UE policy consists of + +- UE Access Network discovery and selection policies (ANDSP). It is used by the UE for selecting non-3GPP accesses networks. The encoding of ANDSP is defined in 3GPP TS 24.526 [16]; +- UE Route Selection Policy (URSP). This UE policy is used by the UE to determine how to route outgoing traffic. Traffic can be routed to an established PDU Session, offloaded to non-3GPP access outside a PDU Session, can be routed via a ProSe Layer-3 UE-to-Network Relay outside a PDU session or trigger the establishment of a new PDU Session. The encoding of URSP is defined in 3GPP TS 24.526 [16]; +- UE Vehicle-to-Everything Policy (V2XP). This UE policy provides configuration information to the UE for V2X communications over PC5 reference point or over Uu reference point or both. The encoding of V2XP is defined in 3GPP TS 24.588 [25]; +- UE 5G Proximity based Services Policy (ProSeP). This UE policy provides configuration information to the UE for 5G ProSe direct discovery, 5G ProSe direct communications, 5G ProSe UE-to-network relay, 5G ProSe usage reporting configuration and rules and/or 5G ProSe UE-to-UE relay; and +- UE Aircraft-to-Everything Policy (A2XP). This UE policy provides configuration information to the UE for A2X communications over PC5 reference point or A2X communications over Uu reference point or both. The encoding of A2XP is defined in 3GPP TS 24.578 [33]; +- UE Ranging and Sidelink Positioning Policy (RSLPP). The UE policy provides configuration information to the UE for Ranging/SL over PC5 reference point. The encoding of RSLPP is defined in 3GPP TS 24.514 [42]; + +The UE Policy is transferred to the UE using the UE policy delivery protocol defined in Annex D of 3GPP TS 24.501 [15]. The (V-)(H-)PCF shall send UE policy using the "MANAGE UE POLICY COMMAND" message and will receive the "MANAGE UE POLICY COMPLETE" or the "MANAGE UE POLICY COMMAND REJECT" messages in the response. Those messages are transparently forwarded by the AMF. + +The (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send "MANAGE UE POLICY COMMAND" messages to the UE and use the Namf\_Communication\_N1MessageNotify service operation defined in clause 5.2.2.3.5 of 3GPP TS 29.518 [14] to receive "MANAGE UE POLICY COMPLETE" and "MANAGE UE POLICY COMMAND REJECT" messages from the UE. The (V-)PCF shall only send "MANAGE UE POLICY COMMAND" messages below a predefined size limit. + +The H-PCF shall use service operations as defined in the present specification to receive "MANAGE UE POLICY COMPLETE" and "MANAGE UE POLICY COMMAND REJECT" messages from the V-PCF and to send "MANAGE UE POLICY COMMAND" messages to the V-PCF. The H-PCF shall encode the "MANAGE UE POLICY COMMAND" message in a "uePolicy" attribute. The H-PCF shall only send "MANAGE UE POLICY COMMAND" messages below a predefined size limit. + +The (V-)(H-)PCF may deliver the UE policy to the UE in several "MANAGE UE POLICY COMMAND" messages. + +For the purpose of such fragmented delivery and subsequent partial updates of UE policies, the UE policy is divided into policy sections. Such policy sections may be predefined in the (V-)(H-)PCF, may be retrieved by the (V-)(H-)PCF from the UDR as specified in 3GPP TS 29.519 [17], or may be dynamically generated by the (V-)(H-)PCF, but shall comply to the rules detailed below. The (V-)(H-)PCF may combine several policy sections into one "MANAGE UE POLICY COMMAND" message, if the predefined size limit is observed. + +The following rules apply to policy sections: + +- The size shall be below the predefined size limit. +- The policy section shall only contain complete URSP rule(s), WLANSP rule(s), N3AN node configuration information, V2XP, A2XP, ProSeP and/or RSLPP info content, but no fractions of such rules, configuration information, or info contents. + +- To ease a subsequent partial update of UE policies, policy sections should only contain a small number of policies, e.g. URSP rule(s), and/or WLANSP rule(s). +- The entire content of a policy section shall be provided by a single PLMN. + +A PCF shall only determine policy sections of its own PLMN. However, a V-PCF may forward UE policy sections received from the H-PCF to the UE. + +Each UE policy section is identified by a UE policy section identifier (UPSI). The UPSI is composed of two parts: + +- a) a PLMN ID part containing the PLMN ID of the PLMN or SNPN of the PCF which provides the UE policies; and +- b) a UE policy section code (UPSC) containing a unique value within the PLMN or SNPN selected by the PCF. + +NOTE 1: When the UE is operating in SNPN access operation mode, the UE associates the PLMN ID with the NID of the SNPN to differentiate between PLMN UPSI(s) and SNPN UPSI(s). + +The (V-)(H-)PCF provides an UPSI when providing a new UE policy section and may then identify that policy section using that UPSI when requesting that that UE policy section is modified or deleted, as specified in Annex D of 3GPP TS 24.501 [15]. + +If the (V-)(H-)PCF determines that changes are required and/or the V-PCF receives possible new or modified policy sections determined by the H-PCF in the roaming case, it shall send the determined new, updated or deleted policy sections using one or several "MANAGE UE POLICY COMMAND" messages towards the NF service consumer. In the roaming case, the V-PCF may either combine policy sections received from the H-PCF and policy sections the V-PCF selected in the same "MANAGE UE POLICY COMMAND" (as long as the predefined size limit is observed), or use separate "MANAGE UE POLICY COMMAND" messages; however, the V-PCF shall not distribute the policy sections received in one "MANAGE UE POLICY COMMAND" from the H-PCF into several "MANAGE UE POLICY COMMAND" messages as long as the predefined size limit is observed for the policy sections received from the H-PCF. The V-PCF shall allocate a new PTI for the "MANAGE UE POLICY COMMAND" sent by the V-PCF and store the mapping between the new PTI and the PTI within the "MANAGE UE POLICY COMMAND" received from the H-PCF. + +After sending a "MANAGE UE POLICY COMMAND" messages, the (V-)(H-)PCF shall wait for a related confirmation in a "MANAGE UE POLICY COMPLETE" messages or failure indication in a "MANAGE UE POLICY COMMAND REJECT" message. When receiving no such message until the expiry of a supervision timer specified in Annex D of 3GPP TS 24.501 [15], or when receiving a failure indication, the PCF should re-send related instructions for the policy sections. In the roaming case, the H-PCF and the V-PCF shall each be responsible for resending those policy sections that it originally supplied. In the case that the V-PCF combined policy sections received from the H-PCF and policy sections the V-PCF selected in the same "MANAGE UE POLICY COMMAND" described below, the V-PCF shall wait for the H-PCF to resend the policy sections of HPLMN, and then resend the combined policy sections. The (V-)(H-)PCF shall always include the initially supplied policy sections when resending the UE policy. + +The (V-)(H-)PCF shall determine that a received "MANAGE UE POLICY COMPLETE" message or "MANAGE UE POLICY COMMAND REJECT" message is related to the result of a "MANAGE UE POLICY COMMAND" based on the PTI within that message. In the roaming case, the V-PCF shall determine that the received message is related to the result of the UE policy provided by the H-PCF if the PTI within the message belongs to one of the stored PTI mapping(s). + +If the V-PCF combined policy sections received from the H-PCF and policy sections the V-PCF selected in the same "MANAGE UE POLICY COMMAND", upon reception of a "MANAGE UE POLICY COMPLETE" message or "MANAGE UE POLICY COMMAND REJECT" message the V-PCF shall: + +- forward the corresponding "MANAGE UE POLICY COMPLETE" message to the H-PCF; +- if a "MANAGE UE POLICY COMMAND REJECT" message with UPSI(s) of the HPLMN is received, forward the parts of the "MANAGE UE POLICY COMMAND REJECT" message that relate to the UPSI(s) of the HPLMN to the H-PCF; +- if a "MANAGE UE POLICY COMMAND REJECT" message without UPSI(s) of the HPLMN is received, send a "MANAGE UE POLICY COMPLETE" message to the H-PCF; and + +- provide the stored PTI received from the HPLMN in the corresponding "MANAGE UE POLICY COMMAND" within the "MANAGE UE POLICY COMPLETE" message or "MANAGE UE POLICY COMMAND REJECT" message towards the H-PCF. + +If the V-PCF sent a separate "MANAGE UE POLICY COMMAND" containing only the policy sections received from the H-PCF, the V-PCF shall forward the corresponding "MANAGE UE POLICY COMPLETE" or "MANAGE UE POLICY COMMAND REJECT" message to the H-PCF and provide the stored PTI received from the HPLMN in the corresponding "MANAGE UE POLICY COMMAND" within the "MANAGE UE POLICY COMPLETE" message or "MANAGE UE POLICY COMMAND REJECT" message towards the H-PCF. If the V-PCF distributed the policy sections received in one "MANAGE UE POLICY COMMAND" from the H-PCF into several "MANAGE UE POLICY COMMAND" messages to the UE (because the predefined size limit of the VPLMN was exceeded), the V-PCF shall aggregate all corresponding "MANAGE UE POLICY COMPLETE" or "MANAGE UE POLICY COMMAND REJECT" messages received from the UE into one "MANAGE UE POLICY COMPLETE" or "MANAGE UE POLICY COMMAND REJECT" message towards the H-PCF. + +When the (V-)PCF receives an Namf\_Communication\_N1N2MessageTransfer failure response as defined in clause 5.2.2.3.1.2 of 3GPP TS 29.518 [14], or an N1N2 Transfer Failure Notification as defined in clause 5.2.2.3.2 of 3GPP TS 29.518 [14], the (V-)PCF shall stop the supervision timer specified in Annex D of 3GPP TS 24.501 [15] corresponding to the affected PTIs. If the "retryAfter" attribute is received, the (V-)PCF should not initiate new UE Policy Delivery request until the timer expires. For the N1N2 Transfer Failure Notification case, the (V-)PCF determines the affected PTIs allocated by the V-PCF based on the resource URI within the "n1n2MsgDataUri" attribute of the N1N2MsgTxfrFailureNotification data structure as defined in clause 6.1.6.2.30 of 3GPP TS 29.518 [14]. + +NOTE 2: The (V-)PCF correlates the Namf\_Communication\_N1N2MessageTransfer request and the corresponding N1N2 Transfer Failure Notification based on the resource URI within the "Location" header included in the response HTTP status code "202 Accepted" of the Namf\_Communication\_N1N2MessageTransfer response and the resource URI within the "n1n2MsgDataUri" attribute of and N1N2 Transfer Failure Notification. And then the V-PCF determines the affected PTIs related with the resource URI. + +For the non-roaming case or the roaming case when the V-PCF determines that the affected UE Policy is related to the V-PLMN, the (V-)PCF may provision the policy control request trigger "CON\_STATE\_CH" if not provisioned yet. Upon receiving the notification of UE connectivity state change indicating that the UE enters the CM-Connected state, the (V-)PCF may retry to deliver the UE Policy. + +For the roaming case and if the V-PCF determines that the affected UE policy is related with the UE policy delivered by the H-PCF, the V-PCF shall send a POST message as defined in clause 4.2.3.1 to notify the H-PCF of the failure of UE policy transfer by including the "uePolTransFailNotif" attribute within the PolicyAssociationUpdateRequest data structure. Within the UePolicyTransferFailureNotification data structure, the V-PCF shall include the cause of the UE Policy Transfer Failure within the "cause" attribute and the PTI(s) allocated by the H-PCF corresponding to the PTI(s) allocated by the V-PCF within the "ptis" attribute. The H-PCF shall stop the supervision timer corresponding to the affected PTIs. If the feature "EnErrorHandler" is supported and the "retryAfter" attribute is received, the H-PCF should not initiate new UE Policy Delivery request until the timer expires. In this case, the H-PCF may provision the policy control request trigger "CON\_STATE\_CH" if not provisioned yet. Upon receiving the notification of UE connectivity state change indicating that the UE enters the CM-Connected state, the H-PCF may retry to deliver the UE Policy. + +When the (H-)PCF receives the "MANAGE UE POLICY COMPLETE" or the "MANAGE UE POLICY COMMAND REJECT" message and determines that this message indicates a UE Policy Delivery outcome to which an NF service consumer has subscribed via a request for service specific parameters, the (H-)PCF shall invoke the Npcf\_EventExposure\_Notify service operation as defined in clause 4.2.4.2 of 3GPP TS 29.523 [30]. + +###### 4.2.2.2.1.1 Provisioning of the UE Access Network discovery and selection policies and UE Route Selection Policy + +During Initial Registration and 5GS Registration during UE mobility from EPS to 5GS, and when: + +- the UE has one or more stored UE policy sections corresponding to the serving PLMN/SNPN or HPLMN; or +- the UE does not have any stored UE policy section corresponding to the serving PLMN/SNPN or HPLMN and the UE needs to send a UE policy container to the network; + +then the UE includes the "UE STATE INDICATION" message as defined in clause D.5.4.1 of 3GPP TS 24.501 [15], which is transferred transparently by the AMF within the "uePolReq" attribute during the creation of a policy association, as described in clause 4.2.2.1. + +The (H-)PCF, or the PCF of the SNPN for the UEs subscribed to the SNPN, may store in the UDR, as specified in 3GPP TS 29.519 [17]: + +- a) UPSCs and related UE policy sections of the own PLMN or SNPN it provided to a UE; +- b) the PEI received from the NF service consumer (e.g. AMF), if available; +- c) the OSId(s) received from the UE within the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; +- d) the indication of UE's support for ANDSP included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; +- e) if the "EpsUrsp" feature defined in 3GPP TS 29.519 [17] is supported, the indication of UE's support for URSP provisioning in EPS included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; +- f) if the "URSPEnforcement" feature defined in 3GPP TS 29.519 [17] is supported, the indication of UE's support for reporting URSP rule enforcement included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; and +- g) if the "VPLMNSpecificURSP" feature defined 3GPP TS 29.519 [17] is supported, the indication of UE's support for VPLM-Specific URSP included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available. + +The PCF shall retrieve from UDR the information previously stored in UDR, if not locally available, for URSP/ANDSP rule determination as specified in 3GPP TS 29.519 [17]. + +The V-PCF may retrieve UPSCs and related UE policy sections applicable for all UEs from a HPLMN from the V-UDR, using the HPLMN ID as key as specified in 3GPP TS 29.519 [17]. The PCF of the serving SNPN has locally configured the UPSCs and related UE policy sections applicable for all UEs other than the UEs subscribed to the SNPN. + +When receiving the "UE STATE INDICATION" message, the (V)-(H-)PCF or the PCF of the serving SNPN, shall determine, based on the UPSIs indicated in that message, if available, the ANDSP support indication and the OSId(s) indicated in that message, if available, the reporting URSP rule enforcement support in that message, if available, the UE Policy Sections and UPSCs stored in the UDR, if available, the policy subscription data, if available, application data, if available, inputs received from the NF service consumer, and local policy, as specified in clauses 4.2.2.2.2 and 4.2.2.2.3, whether any new UE policy section(s) need to be installed and whether any existing UE policy section(s) need to be updated or deleted. Based on local configuration, the (H-)PCF or the PCF of the serving SNPN (for the SNPN-subscribed UEs), may indicate to the UE to accept/not accept URSP rules signalled by non-subscribed SNPNs within the UE policy network classmark IE in a MANAGE UE POLICY COMMAND message as described in Annex D of 3GPP TS 24.501 [15]. + +NOTE 1: When an SNPN-enabled UE registers in a SNPN using credentials from a Credentials Holder (CH) but the UE is not subscribed in that SNPN, the PCF of the non-subscribed SNPN, based on local policies, can provision the UE with URSP rules and/or ANDSP rules for the SNPN. For the provisioned ANDSP rules, the UE gives priority to the valid ANDSP from the registered SNPN. + +When the received "UE STATE INDICATION" message indicated that the UE supports VPLMN-specific URSP rules as specified in Annex D of 3GPP TS 24.501 [15], the (H-)PCF may determine URSP rules specific per VPLMN as specified in clauses 4.2.2.2.3.2. In this case, the (H-)PCF shall provide to the UE within the "MANAGE UE POLICY COMMAND" the UE policy sections containing the VPLMN-specific URSP rules within the VPS URSP configuration IE as specified in subclause D.6.8 of 3GPP TS 24.501 [15]. + +NOTE 2: The VPS URSP configuration IE includes zero or more tuples, each tuple containing a tuple Id, VPLMN ID(s) and a list of UPSC(s) (of HPLMN's UE policy sections) with UE policies with URSP rules applicable to the VPLMN(s) and its equivalent PLMN(s). + +###### 4.2.2.2.1.1a Provisioning of URSP in EPS + +When the UE initially attaches in EPS and establishes the default PDN connection or establishes the first PDN connection in EPS, the "EpsUrsp" feature is supported as described in 3GPP TS 29.512 [31], both the UE and the network support URSP provisioning in EPS PCO,, the UE includes the UE policy container IE with the "UE STATE + +INDICATION" message as defined in clause D.5.4.1 of 3GPP TS 24.501 [15] in the BEARER RESOURCE MODIFICATION REQUEST message as defined in 3GPP TS 24.301 [36]. The UE policy container is then transferred transparently by the PCF for the PDU session within the "uePolReq" attribute during the creation of a UE policy association, as described in clause 4.2.2.1. + +The (H-)PCF, may store in the UDR, as specified in 3GPP TS 29.519 [17]: + +- a) UPSCs and related URSP sections of the own PLMN it provided to a UE; +- b) the PEI received from the NF service consumer, if available; +- c) the OSId(s) received from the UE within the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; +- d) if the "EpsUrsp" feature defined in 3GPP TS 29.519 [17] is supported, the indication of UE's support for URSP provisioning in EPS included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; and +- f) if the "URSPEnforcement" feature defined in 3GPP TS 29.519 [17] is supported, the indication of UE's support for reporting URSP rule enforcement included in the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available. + +The (H-)PCF shall retrieve from UDR the information previously stored in UDR, if not locally available, for URSP rule determination as specified in 3GPP TS 29.519 [17]. + +NOTE 1: URSP provisioning in EPS is supported in Home Routed roaming scenarios as it is supported in non-roaming scenarios. In Home Routed roaming scenarios the H-PCF corresponds with the PCF. + +When receiving the "UE STATE INDICATION" message, the (H-)PCF, shall determine, based on the UPSIs indicated in that message, if available, the OSId(s) indicated in that message, if available, the reporting URSP rule enforcement support in that message, if available, the UE Policy Sections and UPSCs stored in the UDR, if available, the policy subscription data, if available, application data, if available, and local policy, as specified in clauses 4.2.2.2.2 and 4.2.2.2.3, whether any new URSP section(s) need to be installed and whether any existing URSP section(s) need to be updated or deleted. + +**Editor's Note: Interaction between the how URSP provisioning in EPS and the report of URSP rule enforcement when the UE moves from EPS to 5GS is FFS.** + +During 5GS to EPS mobility with N26, when the "EpsUrsp" feature is supported and PCF for the PDU session establishes a UE Policy Association with the PCF for the UE as described in clause 4.2.2.1, the PCF for the UE shall determine whether the 5GS to EPS mobility with N26 scenario applies based on the "5gsToEpsMob" attribute. If it applies, the PCF for the UE shall recover from the UE Policy Association previously established with the AMF: + +- UE Policy Section related information, i.e.: + - a) UPSCs and related URSP sections of the own PLMN it provided to the UE; + - b) if the "URSPEnforcement" feature defined in 3GPP TS 29.519 [17] is supported, the indication of UE's support for reporting URSP rule enforcement received from the UE within the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; and + - c) the OSId(s) received from the UE within the "UE STATE INDICATION" message as described in the Annex D of 3GPP TS 24.501 [15], if available; and +- the subscribed Policy Control Triggers with the AMF, if available. + +NOTE 2: At 5GS to EPS mobility with N26, the guard timer in the AMF (as specified in clause 4.11.1.2.1 and clause 4.11.1.3.2 of TS 23.502 [3]) ensures that the UE Policy Association remains until the PCF for the UE detects that a UE Policy Association establishment is received from a PCF for the PDU Session indicating 5GS to EPS mobility. + +When receiving the 5GS to EPS mobility indication, the PCF for the UE, shall determine, based on the UE Policy Sections and the OSId(s) recovered from the former UE Policy Association in 5GS, if available, the policy subscription data, if available, application data, if available, and local policy, as specified in clauses 4.2.2.2.2 and 4.2.2.2.3, whether any new UE Policy section(s) with URSP need to be installed and whether any existing UE Policy section(s) with URSP need to be updated or deleted. + +In both scenarios above, initial attach and/or first PDN connection establishment in EPS scenario and 5GS to EPS mobility scenario, the determined URSP is transferred to the UE as specified in 4.2.2.2.1.0 with the following differences: + +- the messages of the UE policy delivery protocol defined in Annex D of 3GPP TS 24.501 [15] are transparently forwarded to the UE by a PCF for a PDU session; and +- the (V-)(H-)PCF shall use the Npcf\_UEPolicyControl\_Create/Update response and the Npcf\_UEPolicyControl\_UpdateNotify request to send "MANAGE UE POLICY COMMAND" messages to the UE in a "uePolicy" attribute and use the Npcf\_UEPolicyControl\_Update service operation to receive "MANAGE UE POLICY COMPLETE" and "MANAGE UE POLICY COMMAND REJECT" messages from the UE via a PCF for a PDU session in a "uePolDelResult" attribute. + +###### 4.2.2.2.1.2 Provisioning of Vehicle-to-Everything Policy + +When the UE registers to the network, if the AMF receives from the UE the PC5 capability for V2X communications in the Registration Request message, the UE is authorized to use V2X service based on the UE's subscription information and the "V2X" feature is supported, the AMF further reports to the PCF the PC5 capability for V2X communications within the "pc5Capab" attribute as defined in clause 4.2.2.1. The PCF may determine the V2XP over PC5 interface based on the received UE's PC5 capability for V2X, the Service specific parameter information retrieved from UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +After UE registration, if the UE supports V2X communication and it does not have valid V2XP, the UE includes the "UE POLICY PROVISIONING REQUEST" message as defined in 3GPP TS 24.587 [24] during the NAS transport procedure. The PCF may reject the request by sending back a "UE POLICY PROVISIONING REJECT" message as defined in clause 7.2.2 of 3GPP TS 24.587 [24] or provision the policy, as defined in clause 4.2.2.2.1, based on the service specific parameter information retrieved from UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +For both scenarios mentioned above, in the roaming case, the H-PCF may include the V2XP within the "uePolicy" attribute in the policy association create or update response to the V-PCF and in the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send the V2XP to the UE. + +###### 4.2.2.2.1.3 Provisioning of ProSe Policy + +When the UE registers to the network and the UE supports 5G ProSe, if the AMF receives from the UE the 5G ProSe Capability in the Registration Request message, the UE is authorized to use 5G ProSe service based on the UE's subscription information and the "ProSe" feature defined in clause 5.8 is supported, the AMF further reports to the PCF this 5G ProSe Capability of the UE within the "proSeCapab" attribute, as per the procedures defined in clause 4.2.2.1. When the UE disables/enables a 5G ProSe capability, the AMF further reports to the PCF the updated 5G ProSe capabilities of the UE within the "proSeCapab" attribute, as per the procedures defined in clause 4.2.3.1. The PCF may determine the support of 5G ProSe based on the received UE's 5G ProSe Capability, the service specific parameter information retrieved from the UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +After UE registration, if the UE does not have valid ProSeP, the UE includes a "UE POLICY PROVISIONING REQUEST" message defined in clause 7.2.1.1 of 3GPP TS 24.554 [28] during the NAS transport procedure. The PCF may either reject the request by sending back a "UE POLICY PROVISIONING REJECT" message defined in clause 7.2.2.1 of 3GPP TS 24.587 [24] or provision the policy, as defined in clause 4.2.2.2.1, based on the service specific parameter information retrieved from the UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +For both scenarios mentioned above, in the roaming case, the H-PCF may include the ProSeP within the "uePolicy" attribute in the policy association create and update response to the V-PCF and in the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send the ProSeP to the UE. + +###### 4.2.2.2.1.4 Provisioning of Aircraft-to-Everything Policy + +When the UE registers to the network, if the AMF receives from the UE the PC5 capability for A2X communications in the Registration Request message, the UE is authorized to use A2X service based on the UE's subscription information and the "A2X" feature is supported, the AMF further reports to the PCF the PC5 capability for A2X communications within the "pc5CapA2x" attribute as defined in clause 4.2.2.1. The PCF may determine the A2XP over PC5 interface based on the received UE's PC5 capability for A2X, the Service specific parameter information retrieved from UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +After UE registration, if the UE supports A2X communication and it does not have valid A2XP, the UE includes the "UE POLICY PROVISIONING REQUEST" message as defined in 3GPP TS 24.577 [32] during the NAS transport procedure. The PCF may reject the request by sending back a "UE POLICY PROVISIONING REJECT" message as defined in 3GPP TS 24.577 [32] or provision the policy, as defined in clause 4.2.2.2.1, based on the service specific parameter information retrieved from UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +**Editor's Note:** The reference to CT1 specification for A2XP related UE messages to be updated. + +For both scenarios mentioned above, in the roaming case, the H-PCF may include the A2XP within the "uePolicy" attribute in the policy association create or update response to the V-PCF and in the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send the A2XP to the UE. + +###### 4.2.2.2.1.5 Provisioning of Ranging and Sidelink Positioning Policy + +When the UE registers to the network and the UE supports Ranging/SL, if the AMF receives from the UE the Ranging/SL Capability in the Registration Request message, the UE is authorized to use Ranging/SL service based on the UE's subscription information and the "Ranging\_SL" feature defined in clause 5.8 is supported, the AMF further reports to the PCF this Ranging/SL Capability of the UE within the "rangingSICapab" attribute, as per the procedures defined in clause 4.2.2.1. The PCF may determine the RSLPP over PC5 interface based on the received UE's PC5 capability for Ranging/SL, the Service specific parameter information retrieved from UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +After UE registration, if the UE does not have valid RSLPP, the UE includes a "UE POLICY PROVISIONING REQUEST" message defined in 3GPP TS 24.514 [xx] during the NAS transport procedure. The PCF may either reject the request by sending back a "UE POLICY PROVISIONING REJECT" message defined in 3GPP TS 24.514 [xx] or provision the policy, as defined in clause 4.2.2.2.1, based on the service specific parameter information retrieved from the UE's Application Data in the UDR as defined in clause 6.2.15 of 3GPP TS 29.519 [17] and the operator's policy. + +For both scenarios mentioned above, in the roaming case, the H-PCF may include the RSLPP within the "uePolicy" attribute in the policy association create and update response to the V-PCF and in the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the +Namf\_Communication\_N1N2MessageTransfer service operation defined in +clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send the RSLPP to the UE. 4.2.2.2.2 +UE Access Network discovery and selection policies (ANDSP) + +UE Access Network discovery and selection policies are used by the UE to select non-3GPP accesses and to decide how to route traffic between the selected 3GPP and non 3GPP accesses. + +In this release of the specification, the Access Network Discovery & Selection policy shall contain only rules that aid the UE in selecting a WLAN access network. Rules for selecting other types of non-3GPP access networks are not specified. + +The WLAN access network selected by the UE with the use of Access Network Discovery & Selection policy may be used for direct traffic offload (i.e. sending traffic to the WLAN outside of a PDU Session) and for registering to 5GC using the non-3GPP access network selection information. + +The Access Network Discovery & Selection policy shall contain one or more WLAN Selection Policy (WLANS) rules and and may contain Non-3GPP access network (N3AN) node selection information and configuration information. + +N3AN node selection information and configuration information is used to control UE behaviour related to selection of N3IWF, or ePDG for accessing 5GC via untrusted non-3GPP access, or to support TNGF selection based on the S-NSSAI(s) needed by the UE for accessing 5GC via trusted 3GPP access. + +UE Access Network discovery and selection policies are encoded as defined in 3GPP TS 24.526 [16]. + +UE Access Network discovery and selection policies may be provided by a V-PCF and/or a H-PCF. + +If the UE has indicated in the "UE STATE INDICATION" message it does not support ANDSP, or, when the feature "UECapabilityIndication" is supported, the V-PCF receives from the H-PCF the "andspInd" attribute to false, i.e. the UE does not support non-3GPP access, the (V-)(H-)PCF shall not send any Access Network discovery and selection policies to the UE. + +##### 4.2.2.2.3 UE Route Selection Policy (URSP) + +###### 4.2.2.2.3.1 General + +The UE Route Selection Policy is used by the UE to determine how to route outgoing traffic. + +The UE Route Selection Policy shall consist of one or several URSP rules. The PCF determines whether URSP rule(s) have to be provisioned based on input parameters received from the NF service consumer, the received list of UPSIs from the UE, if available, the UE Policy Sections stored in the UDR, if available, other received UE parameters, if available, the policy subscription and application data retrieved from UDR, if available, analytics information received from NWDAF, if available, and local policies. + +URSP rules are encoded as defined in 3GPP TS 24.526 [16]. + +UE Route Selection Policy may only be provided by a H-PCF or the PCF of the SNPN, but shall not be provided by a V-PCF. However, UE Route Selection Policy determined and provided by the H-PCF may be retrieved by a V-PCF from the H-PCF and forwarded to a UE. + +The (H-)PCF shall use the UE policy subscription data stored in UDR as specified in 3GPP TS 29.519 [17] to ensure the values included in the Route Selection Descriptor of the generated URSP rules are always supported by subscription. + +For the received list of internal group Ids, the (H-)PCF retrieves the corresponding 5G VN group configuration data stored from the UDR as specified in 3GPP TS 29.504[27] and 3GPP TS 29.505 [26], if available. For each available 5G VN group, the (H-)PCF may use the retrieved 5G VN group configuration values to encode the values for the Route Selection Descriptor and the values for the Traffic Descriptor of the generated URSP rules. + +If the "EnhancedBackgroundDataTransfer" feature is supported, the (H-)PCF may retrieve the Background Data Transfer Reference ID(s) by retrieving the UE's Application Data from the UDR as defined in clause 6.2.9 of 3GPP TS 29.519 [17]. In this case, the PCF shall retrieve the transfer policy corresponding to the Background Data Transfer Reference ID(s) as defined in clause 5.2.8 of 3GPP TS 29.519 [17] and then may create the URSP rules including the Route Selection Validation Criteria for the UE as defined in clause 6.6.2.1 of 3GPP TS 23.503 [4]. If the (H-)PCF provisions the URSP rules including the Route Selection Validation Criteria for the UE, it shall use the associated S-NSSAI and DNN to store in the UDR the Background Data Transfer Reference ID(s) in the UE's session management policy data as specified in 3GPP TS 29.519 [17]. + +If the (H-)PCF retrieves the BDT policy and corresponding related information (e.g. network area information, the volume of data to be transferred per UE, etc.) within the BdtData data type, and the "bdtpStatus" attribute within the BdtData data type is set to value "INVALID", the (H-)PCF shall not provision the URSP rules based on the invalid BDT policy. When the BDT policy re-negotiation is completed the PCF may: + +- if the new BDT Policy is determined, create or update the applicable URSP rules based on the new BDT policy; or +- if the invalid BDT policy is removed, remove applicable URSP rules. + +If the "AfGuideURSP" feature is supported by the Nudr\_DataRepository service, the (H-)PCF may receive Service specific parameter information that contains data for AF guidance information on the URSP determination as defined in clause 6.4.2.15 of 3GPP TS 29.519 [17]. In this case, the (H-)PCF may also use this AF guidance information as input to determine the URSP that will be provisioned to the UE. If the received AF guidance information is not consistent with the UE subscription data, or the local operator policy does not allow the specific S-NSSAI and DNN provided by + +the AF guidance information, the corresponding AF guidance information shall not be used to determine the URSP rules. The PCF may also determine not to use AF guidance based on the analytics info received from the NWDAF. + +When the (H-)PCF decides to provide URSP rules based on the AF guidance information, it shall derive the information as follows: + +- Application traffic descriptor within the "trafficDesc" attribute is used to set the Traffic Descriptor of URSP rule (defined in Figure 5.2.2 of 3GPP TS 24.526 [16]). +- Each route selection parameter set within the "routeSelParamSets" attribute of the UrspRuleRequest data type is used to determine a Route selection descriptor (defined in Figure 5.2.2 of 3GPP TS 24.526 [16]) as follows: + - DNN (within the "dnn" attribute of the RouteSelectionParameterSet data type) and S-NSSAI (within the "snssai" attribute of the RouteSelectionParameterSet data type) from the route selection parameter set are used to set the Route selection descriptor contents (defined in Figure 5.2.4 of 3GPP TS 24.526 [16]); + - Route selection precedence (within the "precedence" attribute of the RouteSelectionParameterSet data type) is used to set the Precedence value of route selection descriptor (defined in Figure 5.2.4 of 3GPP TS 24.526 [16]); and + - the spatial validity condition (within the "spatialValidityTais" attribute of the RouteSelectionParameterSet data type) is used to set the Location criteria of the route selection descriptor (defined in Figure 5.2.5 of 3GPP TS 24.526 [16]). + - The PCF may use the requested PDU Session type provided within the "pduSessType" attribute of the RouteSelectionParameterSet data structure to derive the PDU Session type of the route selection descriptors of the URSP rule. +- The precedence for the generated URSP rule is determined by the (H-)PCF. The (H-)PCF may use the "relatPrecedence" attribute within the "UrspRuleRequest" data type to derive the relative precedence of the URSP rule for a request coming from the same AF. + +URSP rules based on AF guidance should not be set as the URSP rules with the "match all" application traffic descriptor. + +The (H-)PCF may obtain the information about the UE's OS from the UE as described in the Annex D of 3GPP TS 24.501 [15] or it may derive the information about the UE's OS from the PEI provided by the NF service consumer (e.g. AMF). + +If the (H-)PCF is required to provide UE policies to the UE that includes application descriptors then: + +- a) If the (H-)PCF has been provided with one UE's OS Id by the UE, the (H-)PCF shall use either the traffic descriptor "OS App Id type" or the traffic descriptor "OS Id + OS App Id type" as defined in 3GPP TS 24.526 [16]. + +NOTE 1: The (H-)PCF uses the traffic descriptor "OS Id + OS App Id type" when the (H-)PCF does not take the received UE's OS Id into account. + +- b) If the (H-)PCF has been provided with more than one UE's OS Id by the UE, + - the (H-)PCF shall use the traffic descriptor "OS Id + OS App Id type" for the UE's OS Id provided by the UE as defined in 3GPP TS 24.526 [16]; and + - the (H-)PCF shall not use the traffic descriptor "OS App Id type" as defined in 3GPP TS 24.526 [16]. +- c) If the (H-)PCF has not been provided with the UE's OS Id by the UE, + - the (H-)PCF shall use the traffic descriptor "OS Id + OS App Id type" as defined in 3GPP TS 24.526 [16]; and + - the (H-)PCF shall not use the traffic descriptor "OS App Id type" as defined in 3GPP TS 24.526 [16]. +- d) If the (H-)PCF has been provided with the UE's OS Id by the UE and the (H-)PCF has derived the UE's OS Id from the PEI and if there is an inconsistency between the OS Id provided by the UE and the OS Id derived from the PEI, the (H-)PCF shall use the OS Id provided by the UE for providing UE policies to the UE that include application descriptors. + +URSP rules may be used to support end to end redundant user plane paths by establishing two redundant PDU sessions. PCF configuration based on e.g. deployment, terminal implementation or policies per group of UE(s) may be used by the PCF to determine whether the URSP Rules shall include PDU Session Pair ID and RSN to indicate that they refer to redundant PDU sessions or whether the UE will determine these values instead. + +NOTE 2: When the "EnSatBackhaulCategoryChg" feature defined in clause 5.8 is supported, the received satellite or non-satellite backhaul category can be used as input to provision or update URSP rules to enable appropriate PDU session capabilities. E.g., when satellite backhaul category is indicated by the AMF, the (H-)PCF can take it into account to determine, based on operator policies, an appropriate Route Selection Descriptor for the URSP rule and the services deployed on the satellite, (e.g., the provisioning or update of URSP rules to indicate the specific DNN for services deployed on-board satellites). + +If the AF provided the (H-)PCF with Personal IoT Network identifier (PIN ID) associated with a DNN and S-NSSAI, and the received DNN and S-NSSAI corresponds to a subscribed DNN and S-NSSAI combination in the UE Policy Context as described in 3GPP TS 29.519 [17], the (H-)PCF shall include the PIN ID within the traffic descriptor of the URSP Rule attribute as defined in 3GPP TS 24.526 [16] for UE to choose an appropriate PIN to establish the PDU session. + +NOTE 3: The PCF can provide two distinct URSP rules to support end to end redundant user plane paths using Dual Connectivity for the duplicated traffic of an application. Duplicated traffic from the UE application is differentiated by two distinct traffic descriptors (different DNNs, and for IP traffic, different IP descriptors or non-IP descriptors), each one defined in a different URSP rule, so that the two redundant PDU sessions are matched to the specific Route Selection Descriptors of distinct URSP rules. These Route Selection Descriptors of distinct URSP rules may include corresponding RSNs and PDU Session Pair IDs as defined in 3GPP TS 24.526 [16]. The Route Selection Descriptors share the same PDU Session Pair ID, if included, to denote the two traffic are redundant with each other. + +NOTE 4: For backward compatibility, PCF can provide a Route Selection Descriptor with PDU Session Pair ID and RSN and a Route Selection Descriptor without PDU Session Pair ID and RSN in the URSP rule. In this case, the Route Selection Descriptor with PDU Session Pair ID and RSN has a lower precedence value (i.e. higher prioritised) than the one without PDU Session Pair ID. It allows that if a non-supporting UE receives the Route Selection Descriptor containing PDU Session Pair ID, it ignores this Route Selection Descriptor. + +NOTE 5: PIN ID and other traffic descriptor components are mutually exclusive, i.e., if PIN ID is included in a URSP rule, then no other traffic descriptor components are supported in the same URSP rule. + +The PCF may adjust the URSP rules when needed, based on awareness of URSP rule enforcement for an application by using the following mechanisms: + +###### A. Awareness of URSP rule enforcement with UE assistance: + +- Based on operator policies, and if the UE included in the UE STATE INDICATION message the indication of UE's support of reporting URSP rule enforcement as specified in the Annex D of 3GPP TS 24.501 [15], the PCF may indicate in a URSP rule sent to the UE to send reporting of URSP rule enforcement, as specified in 3GPP TS 24.526 [16]. For this URSP rule, the UE reports URSP rule enforcement to the SMF if Connection Capabilities are included in the traffic descriptor, as specified in the Annex D of 3GPP TS 24.501 [15] and in 3GPP TS 24.526 [16]. The SMF reports URSP rule enforcement information to the PCF as specified in 3GPP TS 29.512 [31]. +- For LBO roaming session case, if the feature "URSPEnforcement" is supported, the H-PCF for the UE may send the "URSP\_ENF\_INFO" Policy Control Request Trigger to the V-PCF for the UE during the UE Policy Association Establishment or Modification procedures. When the V-PCF receives URSP rule enforcement information as described above, the V-PCF shall invoke the UE Policy Association Update Modification procedure as described in clause 4.2.3.1. +- If the (V-)(H-)PCF for a UE and the PCF for a PDU session are different, then the (V-)(H-)PCF for a UE may subscribe to the PCF for a PDU session to receive the reporting of URSP rule enforcement information as defined in 3GPP TS 29.514 [37] and the (V-)(H-)PCF for a UE may obtain UE reporting of URSP rule enforcement information from the PCF for a PDU session as defined in 3GPP TS 29.514 [37], where the V-PCF for a UE interacts with the PCF for a PDU session in the VPLMN and the H-PCF for a UE interacts with the PCF for a PDU session in the HPLMN. + +- Based on the received URSP rule enforcement information, the (H-)PCF may adjust the URSP rules e.g. when the (H-)PCF determines that the UE does not have up-to-date URSP rules. + - In this release of the specification, the received URSP rule enforcement report shall contain one or more connection capabilities. If the URSP rule enforcement report does not include connection capabilities, based on local policies, the (H-)PCF for the UE may ignore the received report. +- B. Awareness of URSP rule enforcement without UE assistance: The PCF may subscribe to or request the PDU Session Traffic analytics statistics using the Nnwdaf\_EventsSubscription\_Subscribe service operation or Nnwdaf\_AnalyticsInfo\_Request service operation including the "PDU\_SESSION\_TRAFFIC" event for traffic monitoring of known traffic according to provisioned PDU Session Traffic requirements of corresponding URSP rule(s) at the NWDAF as defined in 3GPP TS 29.520 [38]. If the PCF is notified or responded with traffic that does not match Traffic Descriptor provided that is the traffic which is not expected according to a URSP rule, the PCF may adjust the URSP rules when unexpected application traffic is detected. + +NOTE 6: The PCF can combine the UE reporting of URSP rule enforcement with the analytics information together to adjust the URSP rules. + +###### 4.2.2.2.3.2 Provisioning of VPLMN-specific URSP Rules + +When the UE supports VPLMN-specific URSP rules, the H-PCF may provision VPLMN specific URSP rules to the UE for the purpose to route traffic to the VPLMN as described in clause 4.2.2.2.1.1. The H-PCF provides VPLMN specific URSP rules that contains HPLMN values. + +NOTE 1: For network slice information, the VPLMN-specific URSP rule contains HPLMN NSSAI values. For DNN information, the VPLMN-specific URSP rule contains DNN values according to the subscribed DNNs for which LBO roaming is allowed, as specified in 3GPP TS 29.519 [17]. + +The (H-)PCF may use AF guidance on URSP determination as input for VPLMN-specific URSP rule determination as specified in clause 4.2.2.2.3.1. The (H-)PCF retrieves from the UDR at the HPLMN the AF guidance for the VPLMN-specific URSP rules for a UE, group of UEs or any UE as specified in 3GPP TS 29.519 [17]. + +In case of roaming and if the feature "VPLMNSpecificURSP" is supported, the H-PCF may receive from the V-PCF the AF-guidance on VPLMN specific URSP rules within the "vpsUrspGuidance" attribute as specified in clauses 4.2.2.1, and 4.2.3.1. The V-PCF receives from the UDR at the VPLMN the V-AF guidance for the VPLMN specific URSP rules for all roaming UEs of a HPLMN as specified in 3GPP TS 29.519 [17]. The V-PCF determines based on LBO information received from the AMF whether the received V-AF-guidance on VPLMN specific URSP rules may apply for this UE, and if it is so, the V-PCF forwards the related information to the H-PCF within the "vpsUePolGuidance" attribute as specified in clause 4.2.2.1. + +For a UE for which AF guidance on VPLMN specific URSP rules is forwarded to the H-PCF within the "vpsUePolGuidance" attribute, the V-PCF: + +- maps the S-NSSAI of the VPLMN (indicated by the AF and retrieved from the UDR, if available) into the S-NSSAI of the HPLMN. The V-PCF uses the Configured NSSAI for the Serving PLMN and mapping of each S-NSSAI of the Configured NSSAI to corresponding HPLMN S-NSSAI values provided by the AMF within the "confSnssais" attribute as specified in clauses 4.2.2.1, and 4.2.3.1. The V-PCF shall subscribe to the "CONF\_NSSAI\_CH" policy control request trigger. Then, for each URSP rule included within the "urspGuidance" attribute, the V-PCF sends the mapped application guidance on URSP determination including the HPLMN S-NSSAI values to the H-PCF within the "snssai" attribute included within the corresponding "routeSelParamSets" entry; and +- indicates to the H-PCF to notify about the result of the delivery of UE policies (if it was requested by the AF to the VPLMN) using the "deliveryEvents" attribute as specified in clauses 4.2.2.1, and 4.2.3.1. The H-PCF notifies about the result of the delivery of UE policies using the "delivReport" attribute as specified in clauses 4.2.4.2 and 4.2.4.7. + +The H-PCF generates new or updated VPLMN-specific URSP rules using the received application guidance on the URSP rule determination, where the VPLMN ID(s) included in the (H-)AF and/or V-PCF request is used to indicate to the UE that this URSP rule applies when the UE is registered in the VPLMN ID. The H-PCF provides URSP rules for the received AF-guidance parameter values that are within the subscribed values defined in the UE Policy Data Set, as specified in 3GPP TS 29.519 [17]. The VPLMN ID(s) received in the (H-)(V-)AF request, as specified in + +3GPP TS 29.522[39], and/or received in the V-PCF request, and provided by the H-PCF within the VPLMN-specific URSP rule, as specified in 3GPP TS 24.501 [15], may contain one or more specific values for the MCC and MNC and/or may indicate any MNC for a MCC. The H-PCF, based on operator policies, may set the precedence in the URSP Rules to ensure that the UE checks the VPLMN ID(s) that contain one or more specific values for the MCC and MNC. The H-PCF should also set the precedence in the URSP rules to ensure that the UE checks any VPLMN-specific URSP rule related to the serving PLMN before any non-VPLMN specific URSP rules. + +If the UE does not indicate the support for VPLMN specific URSP rules, the H-PCF generates new or updated URSP rules using the VPLMN ID related information retrieved from the UDR and/or received from the V-PCF. + +NOTE 2: To avoid the UE stores obsolete information about VPLMN-specific URSP rules, the H-PCF could delete those determined based on V-AF guidance and once the UE has left the VPLMN. + +##### 4.2.2.2.4 Vehicle-to-Everything Policy (V2XP) + +V2XP includes the V2XP over PC5 and over Uu interfaces. + +The V2XP over PC5 are defined in clause 5.2.3 of 3GPP TS 24.587 [24] and the corresponding encoding is defined in clause 5.3.1 of 3GPP TS 24.588 [25]. + +The V2XP over Uu are defined in clause 5.2.4 of 3GPP TS 24.587 [24] and the corresponding encoding is defined in clause 5.3.2 of 3GPP TS 24.588 [25]. + +##### 4.2.2.2.5 Proximity based Services Policy (ProSeP) + +The ProSeP includes: + +- ProSeP for 5G ProSe direct discovery defined in clause 5.3 of 3GPP TS 24.555 [29]; + - ProSeP for 5G ProSe direct communications defined in clause 5.4 of 3GPP TS 24.555 [29]; + - ProSeP for 5G ProSe UE-to-network relay, including: + - ProSeP for 5G ProSe UE-to-network relay UE defined in clause 5.5 of 3GPP TS 24.555 [29]; and/or + - ProSeP for 5G ProSe Remote UE defined in clause 5.6 of 3GPP TS 24.555 [29]; + - ProSeP for 5G ProSe usage reporting configuration and rules defined in clause 5.7 of 3GPP TS 24.555 [29]; +- and/or +- ProSeP for 5G ProSe UE-to-UE relay, including: + - ProSeP for 5G ProSe UE-to-UE relay UE defined in clause 5.8 of 3GPP TS 24.555 [29]; and/or + - ProSeP for 5G ProSe End UE defined in clause 5.9 of 3GPP TS 24.555 [29]. + +##### 4.2.2.2.6 Aircraft-to-Everything Policy (A2XP) + +A2XP includes the A2X Policy over PC5 interface or A2X Policy over Uu reference point or both. + +The A2XP over PC5 or A2XP over Uu reference point or both are defined in 3GPP TS 24.577 [32] and the corresponding encoding is defined in 3GPP TS 24.578 [33]. + +**Editor's Note:** The reference to CT1 specification for A2XP related encoding to be updated. + +##### 4.2.2.2.7 Ranging and Sidelink Positioning Policy (RSLPP) + +RSLPP includes the Ranging/SL Policy over PC5 interface. The RSLPP over PC5 interface is defined in 3GPP TS 24.514 [42]. + +##### 4.2.2.2.3 V2X N2 PC5 Policy + +The V2X N2 PC5 policy consists of V2X PC5 QoS parameters used by the NG-RAN. + +When the (H-)PCF derives the UE policy for V2X communications over PC5 reference point as defined in clause 4.2.2.2.4, the (H-)PCF shall derive the corresponding V2X PC5 QoS parameters used by the NG-RAN. + +In the roaming case, the H-PCF: + +- if PC5 UE capabilities and UE Policy Provisioning request messages are received, and V2X policies are derived, shall include the V2X N2 PC5 Policy within the "n2Pc5Pol" attribute in the policy association creation response towards the V-PCF; or +- shall include the V2X N2 PC5 Policy within the "n2Pc5Pol" attribute, if changes apply, in the policy association update response towards the V-PCF; or +- may include the V2X N2 PC5 Policy within the "n2Pc5Pol" attribute in the the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send V2X N2 PC5 policy to the NG-RAN. + +#### 4.2.2.4 5G ProSe N2 PC5 Policy + +The 5G ProSe N2 PC5 policy consists of 5G ProSe PC5 QoS parameters used by the NG-RAN. + +When the (H-)PCF derives the UE policy for 5G ProSe as defined in clause 4.2.2.2.5, the (H-)PCF shall derive the corresponding 5G ProSe N2 PC5 QoS parameters used by the NG-RAN. + +In the roaming case, the H-PCF: + +- if the 5G ProSe capabilities and the UE Policy Provisioning request message are received, and 5G ProSe policies are derived, shall include the N2 PC5 Policy for 5G ProSe within the "n2Pc5ProSePol" attribute in the of policy association creation response towards the V-PCF; or +- shall include the N2 PC5 Policy for 5G ProSe within the "n2Pc5ProSePol" attribute, if changes apply, in the response of the policy association update response towards the V-PCF; or +- may include the N2 PC5 Policy for 5G ProSe within the "n2Pc5ProSePol" attribute in the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send 5G ProSe N2 PC5 policy to the NG-RAN. + +#### 4.2.2.5 A2X N2 PC5 Policy + +The A2X N2 PC5 policy consists of A2X PC5 QoS parameters used by the NG-RAN. + +When the (H-)PCF derives the UE policy for A2X communications over PC5 reference point as defined in clause 4.2.2.2.6, the (H-)PCF shall derive the corresponding V2X PC5 QoS parameters used by the NG-RAN. + +In the roaming case, the H-PCF: + +- if PC5 UE capabilities and UE Policy Provisioning request messages are received, and A2X policies are derived, shall include the A2X N2 PC5 Policy within the "n2Pc5PolA2x" attribute in the policy association creation response towards the V-PCF; or +- shall include the A2X N2 PC5 Policy within the "n2Pc5PolA2x" attribute, if changes apply, in the policy association update response towards the V-PCF; or +- may include the V2X N2 PC5 Policy within the "n2Pc5PolA2x" attribute in the the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send A2X N2 PC5 policy to the NG-RAN. + +#### 4.2.2.6 Ranging/SL N2 PC5 Policy + +The Ranging/SL N2 PC5 policy consists of Ranging/SL PC5 QoS parameters used by the NG-RAN. + +When the (H-)PCF derives the UE policy for Ranging/SL over PC5 reference point as defined in clause 4.2.2.2.X, the (H-)PCF shall derive the corresponding Ranging/SL PC5 QoS parameters used by the NG-RAN. + +In the roaming case, the H-PCF: + +- if PC5 UE capabilities and UE Policy Provisioning request messages are received, and Ranging/SL policies are derived, shall include the Ranging/SL N2 PC5 Policy within the "n2Pc5RsppPol" attribute in the policy association creation response towards the V-PCF; or +- shall include the Ranging/SL N2 PC5 Policy within the "n2Pc5RsppPol" attribute, if changes apply, in the policy association update response towards the V-PCF; or +- may include the Ranging/SL N2 PC5 Policy within the "n2Pc5RsppPol" attribute in the the policy association update request initiated by the H-PCF. + +In the roaming or non-roaming case, the (V-)PCF shall use the Namf\_Communication\_N1N2MessageTransfer service operation defined in clause 5.2.2.3.1 of 3GPP TS 29.518 [14] to send Ranging/SL N2 PC5 policy to the NG-RAN. + +### 4.2.3 Npcf\_UEPolicyControl\_Update Service Operation + +#### 4.2.3.1 General + +The procedure in the present clause is applicable when the NF service consumer modifies an existing UE policy association (including the case where the AMF is relocated and the new AMF selects to maintain the policy association with the old PCF and to update the Notification URI). + +Figure 4.2.3.1-1 illustrates the update of a policy association. + +![Sequence diagram showing the update of a UE policy association between an NF service consumer and a PCF.](f324fbc5d5af1e4da9cd932389f0064c_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../policies/{polAssold}/update + NF service consumer->>PCF: 1. POST .../policies/{polAssold}/update + Note left of PCF: 2. "200 OK" + PCF-->>NF service consumer: 2. "200 OK" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message, labeled '1. POST .../policies/{polAssold}/update', is sent from the NF service consumer to the PCF. The second message, labeled '2. "200 OK"', is sent from the PCF back to the NF service consumer. + +Sequence diagram showing the update of a UE policy association between an NF service consumer and a PCF. + +Figure 4.2.3.1-1: Update of a UE policy association + +NOTE 1: For the roaming case, the PCF represents the V-PCF if the NF service consumer is an AMF and the PCF represents the H-PCF if the NF service consumer is a V-PCF. + +The AMF, as NF service consumer, invokes this procedure when a subscribed policy control request trigger (see clause 4.2.3.2) occurs. When a policy control request trigger that requires the subscription as defined in table 5.6.3.3-1 (e.g. LOC\_CH trigger) occurs, the NF service consumer (AMF) shall only invoke this procedure if the PCF has explicitly subscribed to that event trigger. When a policy control request trigger that does not require the subscription as defined in table 5.6.3.3-1 (e.g. GROUP\_ID\_LIST\_CHG trigger) occurs, the NF service consumer (AMF) shall always invoke the procedure. + +NOTE 2: The AMF uses the Namf\_Communication\_N1MessageNotify service operation specified in 3GPP TS 29.518 [14] to send to the V-PCF a "MANAGE UE POLICY COMPLETE" message or a "MANAGE UE POLICY COMMAND REJECT" message, as defined in Annex D.5 of 3GPP TS 24.501 [15] or a "UE POLICY PROVISIONING REQUEST" message as defined in clause 7.2.1.1 of 3GPP TS 24.587 [24]. + +If an AMF as NF service consumer knows by implementation specific means that the UE context has been transferred to an AMF with another GUAMI within the AMF set, it may also invoke this procedure to update the Notification URI. + +NOTE 3: Either the old or the new AMF can invoke this procedure. + +During the AMF relocation, if the new AMF received the resource URI of the individual UE Policy from the old AMF and selects the old PCF, the new AMF shall also invoke this procedure to update the Notification URI. The new AMF may also update the alternate or backup IP addresses, and if service discovery via NRF applies, the AMF Id. If the feature "FeatureRenegotiation" is supported, the new AMF may perform feature renegotiation, as described in clause 4.2.3.4. + +NOTE 4: During inter-AMF mobility, the N1N2 Individual Subscription context is transferred from the source AMF to the target AMF as specified in 3GPP TS 29.518 [14]. When the target AMF determines to reuse the UE Policy Association indicated by the source AMF, the PCF can keep the N1N2 Individual Subscription context and, for subsequent interactions, replace in the request URI the {apiRoot} of the N1N2 Individual Subscription resource with the one of the target AMF. + +The V-PCF, as NF service consumer, invokes this procedure when a policy control request trigger (see clause 4.2.3.2) occurs. When a policy control request trigger that does not require the subscription as defined in table 5.6.3.3-1 (e.g. UE\_POLICY trigger) occurs, the V-PCF shall always invoke the procedure. When a policy control request trigger that requires the subscription as defined in table 5.6.3.3-1 (e.g. LOC\_CH trigger) occurs, the V-PCF shall only invoke this procedure if the H-PCF has subscribed to that event trigger. + +To request policies (e.g. policy control request trigger(s) is/are met) from the PCF, to update the Notification URI, to renegotiate features, to update the trace control configuration or to request the termination of trace, the NF Service Consumer shall request the update of the associated UE Policy Association by providing the relevant parameters about the UE context in an HTTP POST request with "{apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId}/update" as Resource URI and the PolicyAssociationUpdateRequest data structure as request body that shall include: + +- at least one of the following: + 1. a new Notification URI encoded in the "notificationUri" attribute; + 2. observed Policy Control Request Trigger(s) (see clause 4.2.3.2) encoded as "triggers" attribute; + 3. if a UE location change occurred, the UE location encoded as "userLoc" attribute; + 4. if a "MANAGE UE POLICY COMPLETE" message or a "MANAGE UE POLICY COMMAND REJECT" message of the UE policy delivery protocol defined in Annex D of 3GPP TS 24.501 [15] has been received by the V-PCF as NF service consumer, and at least parts of the contents relate to UPSIs of the HPLMN, the parts of that message that relate to UPSIs of the HPLMN encoded as "uePolDelResult" attribute; + 5. if the Policy Control Request Trigger "Change of UE presence in PRA" is provided, the current presence status of the UE for the presence reporting areas for which reporting was requested, if not previously provided, or the presence reporting areas for which reporting was requested and the status has changed encoded as "praStatuses" attribute; + +NOTE 5: If the PCF included the identifier of a Core Network predefined Presence Reporting Area Set within the "praId" attribute during the subscription to changes of UE presence in PRA, the AMF only provides the presence reporting area information corresponding to the concerned individual Presence Reporting Area Identifier(s) within the Set. The "praId" attribute within each returned "PresenceInfo" data type hence includes the identifier of the concerned individual Presence Reporting Area. + +6. if the NF service consumer is an AMF, for AMF relocation scenarios, if available, alternate or backup IPv4 Address(es) where to send Notifications encoded as "altNotifIpv4Addrs" attribute; +7. if the NF service consumer is an AMF, for AMF relocation scenarios, if available, alternate or backup IPv6 Address(es) where to send Notifications encoded as "altNotifIpv6Addrs" attribute; +8. if the NF service consumer is an AMF, for AMF relocation scenarios, if available, alternate or backup FQDN(s) where to send Notifications encoded as "altNotifFqdns" attribute; +9. for AMF relocation scenarios, the GUAMI encoded as "guami" attribute; + +NOTE 6: An alternate NF service consumer than the one that requested the generation of the subscription resource can send the request. For instance, an AMF as service consumer can change; + +10. if the NF service consumer is an AMF, for AMF relocation scenarios, the new serving AMF Id encoded in the "servingNfId" attribute; + +NOTE 7: If the PCF received the "servingNfId" attribute, the PCF can use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] to retrieve the NF profile of the Namf\_Communication service available in the indicated AMF instance Id. + +11. if a UE PLMN change occurred and the "PlmnChange" feature defined in clause 5.8 is supported, the PLMN Identifier or the SNPN Identifier of the new serving network encoded as "plmnId" attribute; + +NOTE 8: The SNPN Identifier consists of the PLMN Identifier and the NID. + +NOTE 9: When the UE moves between PLMNs, the trigger reports changes of equivalent PLMNs. + +NOTE 10: Mobility between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +12. if a "UE POLICY PROVISIONING REQUEST" message defined in clause 7.2.1.1 of 3GPP TS 24.587 [24] has been received by the V-PCF as NF service consumer and respectively the "V2X" feature , and/or the "A2X" feature and/or the "ProSe" feature and/or the "Ranging\_SL" feature defined in clause 5.8 is/are supported, the message encoded as "uePolReq" attribute; +13. if a UE Internal Group Identifier(s) change occurred and the "GroupIdListChange" feature defined in clause 5.8 is supported, the Internal Group Identifier(s) of the served UE encoded as "groupIds" attribute; +14. if a change of PC5 capability for 5G ProSe occurred and the "ProSe" feature defined in clause 5.8 is supported, the PC5 capability for 5G ProSe encoded as "proSeCapab" attribute; +- 14a. if a change of the Ranging/SL Capability occurred and the "Ranging\_SL" feature defined in clause 5.8 is supported, the Ranging/SL Capability encoded as "rangingSICapab" attribute; and/or +15. if a change of the connectivity state of the UE occurred and the "ConnectivityStateChange" feature defined in clause 5.8 is supported, the connectivity state of the served UE encoded as "connectState" attribute; +16. when a response with HTTP status code 4xx or 5xx as defined in clause 5.2.2.3.1.2 of 3GPP TS 29.518 [14] or a N1N2 Transfer Failure Notification as defined in clause 5.2.2.3.2 of 3GPP TS 29.518 [14] is received by the V-PCF after provisioning the UE policy by invoking the Namf\_Communication\_N1N2MessageTransfer service operation to the AMF, this UE policy transfer failure notification encoded as "uePolTransFailNotif" attribute; +17. if the NF service consumer is an AMF, the "SliceAwareANDSP" feature is supported, and the "NON\_3GPP\_NODE\_RESELECTION" trigger is reported within the "triggers" attribute, the wrongly selected non-3gpp access node encoded as "n3gNodeReSel" attribute, and, in the roaming case, also the Configured NSSAI for the serving PLMN encoded as "confSnssais" attribute; +18. if satellite backhaul category change occurred and the "EnSatBackhaulCategoryChg" feature defined in clause 5.8 is supported, the satellite backhaul category or non-satellite backhaul encoded as "satBackhaulCategory" attribute; +19. for the roaming scenario, if the NF service consumer is an AMF, Configured NSSAI change occurred and the "NssaiChange" feature is supported, the Configured NSSAI for the serving PLMN encoded as "confSnssais" attribute and optionally the mapped each S-NSSAI value of home network corresponding to the configured S-NSSAI values in the serving PLMN encoded as "mappedHomeSnssai" attribute within the "confSnssais" attribute; +- 20 for the roaming scenario, if the NF service consumer is a V-PCF, the "URSPEnforcement" feature is supported, and the "URSP\_ENF\_INFO" policy control request trigger is met, the URSP rule enforcement information within the "urspEnfReport" attribute; +21. for the roaming scenario, if the NF service consumer is a V-PCF the "VPLMNSpecificURSP" feature is supported, the AF guidance on VPLMN-specific URSP rules related information within the "vpsUePolGuidance" attribute, that shall contain for each related AF: + - a. the AF guidance on VPLMN-Specific URSP rules within the "urspGuidance" attribute, if the AF updated/provided this information; and/or + +- b. if the AF requested to the VPLMN notifications about the delivery of UE Policies or the update of the subscription to notification information previously provided, the "deliveryEvents" attribute including the "SUCCESS\_UE\_POL\_DEL\_SP" and/or "UNSUCCESS\_UE\_POL\_DEL\_SP" events; +- 22. for the roaming scenario, if the NF service consumer is an AMF, the "VPLMNSpecificURSP" feature is supported and the "LBO\_INFO\_CH" policy control request trigger is met, the LBO roaming information within the "lboRoamingInfo" attribute; and/or + - 23. if an access type change occurred and the "AccessChange" feature defined in clause 5.8 is supported, the access type(s) encoded as "accessTypes" and when an access type change occurred, the indication of whether a new access type is being added or an existing access type is being removed encoded within the "accessStatus" attribute. + +Upon the reception of the HTTP POST request: + +- if the PCF is a V-PCF and the V-PCF has an established policy association with the H-PCF, the V-PCF shall determine based on the contents of a potentially received "uePolDelResult" attribute to be sent to the H-PCF (see above) and requested event triggers of the H-PCF whether to send as the NF service consumer towards the H-PCF a request for the update of the policy association as described in the present clause; +- the (V-)(H-)PCF shall determine the applicable UE policy based on the contents of the received HTTP POST request, the UE Policy Sections stored in UDR, local policy and, for the H-PCF, taking into consideration the information received within the UE policy delivery protocol encoded in the "uePolReq" attribute, if available, and for the V-PCF, taking into consideration any policy received from the H-PCF encoded in the "uePolicy" attribute in the reply to the possible request for the update of the associated policy association. When the "ProSe" feature is supported, the H-PCF shall determine the applicable ProSeP based on the received PC5 capability for 5G ProSe. When the UE disables a 5G ProSe capability the PCF may stop updating the corresponding ProSeP, and when the UE enables a 5G ProSe capability the PCF may update the corresponding ProSeP; +- if the UE indicated the support of A2X communications over PC5 reference point, "A2X" feature is supported, and for the H-PCF, if the UE POLICY PROVISIONING REQUEST message was included in the "uePolReq" attribute, the (H-)PCF shall determine the applicable A2XP and A2X N2 PC5 policy as detailed in clauses 4.2.2.2.1.4 and 4.2.2.5, based on the operator's policy; +- if the UE indicates the support of 5G ProSe communications over PC5 reference point, the "ProSe" feature is supported, and for the H-PCF, if the UE POLICY PROVISIONING REQUEST message with the requested 5G ProSe policies was included in the "uePolReq" attribute, the (H-)PCF shall determine the applicable ProSeP and 5G ProSe N2 PC5 policy, as detailed in clauses 4.2.2.2.1.3 and 4.2.2.4, based on the operator's policy; +- if the UE indicated the support of V2X communications over PC5 reference point, "V2X" feature is supported, and for the H-PCF, if the UE POLICY PROVISIONING REQUEST message was included in the "uePolReq" attribute, the (H-)PCF shall determine the applicable V2XP and V2X N2 PC5 policy as detailed in clauses 4.2.2.2.1.2 and 4.2.2.3, based on the operator's policy; +- if the UE indicated the support of Ranging/SL over PC5 reference point, "Ranging\_SL" feature is supported, and for the H-PCF, if the UE POLICY PROVISIONING REQUEST message was included in the "uePolReq" attribute, the (H-)PCF shall determine the applicable RSLPP and Ranging/SL N2 PC5 policy as detailed in clauses 4.2.2.2.1.5 and 4.2.2.6 based on the operator's policy; +- for the successful case, the (V-)(H-)PCF shall send a HTTP "200 OK" response with the PolicyUpdate data type as response body with the possibly updated of UE policy (for the H-PCF), and/or ProSe N2 PC5 policy (for the H-PCF) as specified in clause 4.2.2.4, N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe (for the H-PCF) as specified in clause 4.2.2.3, and/or the Ranging/SL N2 PC5 policy (for the H-PCF) as specified in clause 4.2.2.6 and/or Policy Control Request Trigger(s) encoded as described in clause 4.2.3.3; +- if the (V-)PCF determines that UE policy needs to be updated, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the UE policy according to clause 4.2.2.2 and as follows: + - (i) the (V-)PCF shall send the determined UE policy using Namf\_Communication\_N1N2MessageTransfer service operation(s); and + - (ii) the (V-)PCF shall be prepared to receive UE Policy Delivery Results from the AMF within the Namf\_Communication\_N1MessageNotify service operation, and for the V-PCF, if the received UE Policy Delivery results relate to UE policy sections provided by the H-PCF, the V-PCF shall use the + +Npcf\_UEPolicyControl\_Update Service Operation to send those UE Policy Delivery results to the H-PCF; and + +NOTE 11: A PolicyUpdate data structure with only mandatory attribute(s) is included in the "200 OK" response when the PCF decides not to update the policies. + +- if the PCF determines that the V2XP and N2 PC5 policy (e.g. for V2X communications, for 5G ProSe) for V2X communications need to be updated, and for the V-PCF when receiving the updated V2XP and N2 PC5 policy for V2X communications from the H-PCF, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the V2XP to the UE and the V2X N2 PC5 policy to NG-RAN according to clauses 4.2.2.2.1.2 and 4.2.2.3; +- if the PCF determines that the A2XP (e.g. for A2X communications) for A2X communications need to be updated, and for the V-PCF when receiving the updated A2XP and N2 PC5 policy for A2X communications from the H-PCF, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the A2XP to the UE and the A2X N2 PC5 policy to NG-RAN according to clauses 4.2.2.2.1.4 and 4.2.2.5; +- if the PCF determines that ProSeP and 5G ProSe N2 PC5 policy needs to be updated, and for the V-PCF when receiving the updated ProSeP and 5G ProSe N2 PC5 policy from the H-PCF, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the ProSeP to the UE and 5G ProSe N2 PC5 policy to NG-RAN according to clauses 4.2.2.2.1.3 and 4.2.2.4; +- if the PCF determines that RSLPP and Ranging/SL N2 PC5 policy needs to be updated, and for the V-PCF when receiving the updated RSLPP and Ranging/SL N2 PC5 policy from the H-PCF, it shall use the Namf\_Communication service specified in 3GPP TS 29.518 [14] to provision the RSLPP to the UE and Ranging/SL N2 PC5 policy to NG-RAN according to clauses 4.2.2.2.1.5 and 4.2.2.6; +- if the SliceAwareANDSP feature is supported, the PCF received the "NON\_3GPP\_NODE\_RESELECTION" trigger, and the PCF has successfully delivered the updated ANDSP/WLANSP to the UE with the slice information for the corresponding non-3gpp node, the notification of this successful delivery by providing the "andspDellnd" attribute with the value "true". +- if errors occur when processing the HTTP POST request, the (V-)(H-)PCF shall: + - send an HTTP error response as specified in clause 5.7; or + - if the feature "ES3XX" is supported, and the (V-)(H-)PCF determines the received HTTP POST request needs to be redirected, send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]; + +according to the following provisions: + +- if the (V-)(H-)PCF is, due to incomplete, erroneous or missing information in the request not able to provision a UE policy decision, the PCF may reject the request and include in an HTTP "400 Bad Request" response message the "cause" attribute of the ProblemDetails data structure set to "ERROR\_REQUEST\_PARAMETERS". + +If the PCF received a new GUAMI, the PCF may subscribe to GUAMI changes using the AMFStatusChange service operation of the Namf\_Communication service specified in 3GPP TS 29.518 [14], and it may use the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the obtained GUAMI and possibly service name) to query the other AMFs within the AMF set. + +#### 4.2.3.2 Policy Control Request Triggers + +The following Policy Control Request Triggers are defined (see clause 6.1.2.5 of 3GPP TS 23.503 [4]): + +- "LOC\_CH", i.e. location change (tracking area): the tracking area of the UE has changed; +- "PRA\_CH", i.e. change of UE presence in PRA: the UE is entering/leaving a Presence Reporting Area. This includes reporting the initial status at the time the request for this reporting is initiated; +- "UE\_POLICY", i.e. a "MANAGE UE POLICY COMPLETE" message or a "MANAGE UE POLICY COMMAND REJECT" message, as defined in Annex D.5 of 3GPP TS 24.501 [15] has been received by the V-PCF and is being forwarded to the H-PCF, or has been received by a PCF for a PDU session (in case for URSP provisioning in EPS) and is being forwarded to the (V-)PCF, or a "UE POLICY PROVISIONING REQUEST" + +message, as defined in clause 7.2.1.1 of 3GPP TS 24.587 [24] has been received by the V-PCF and is being forwarded to the H-PCF; + +- "PLMN\_CH", i.e. PLMN change: the serving network (PLMN or SNPN) of the UE has changed; + +NOTE 1: The "PLMN\_CH" trigger only applies if the "PlmnChange" feature is supported. + +NOTE 2: When the UE is moving between PLMNs, the trigger reports changes of equivalent PLMNs. + +NOTE 3: Mobility between non-equivalent SNPNs, and between SNPN and PLMN is not supported. When the UE is operating in SNPN access mode, the trigger reports changes of equivalent SNPNs. + +- "CON\_STATE\_CH", i.e. connectivity state change: the connectivity state of the UE has changed; + +NOTE 4: The "CON\_STATE\_CH" trigger only applies if the "ConnectivityStateChange" feature is supported. + +- "GROUP\_ID\_LIST\_CHG", i.e. UE Internal Group Identifier(s) change: the UDM provided list of group Ids has changed; and + +NOTE 5: The "GROUP\_ID\_LIST\_CHG" trigger only applies if the "GroupIdListChange" feature is supported. This Policy Control Request Trigger does not require an explicit subscription from the PCF. + +- "UE\_CAP\_CH", i.e. UE Capabilities change: the UE provided 5G ProSe capabilities have changed. + +NOTE 6: The "UE\_CAP\_CH" trigger only applies if the "ProSe" feature is supported. This Policy Control Request Trigger does not require a subscription. + +- "SAT\_CATEGORY\_CHG", i.e. Satellite Backhaul Category change: the AMF has detected a change between different satellite category, or non-satellite backhaul. + +NOTE 7: The "SAT\_CATEGORY\_CHG" trigger only applies if the "EnSatBackhaulCategoryChg" feature is supported. + +- "NON\_3GPP\_NODE\_RESELECTION", i.e. wrong TNGF or N3IWF: the UE has connected to a wrong non-3GPP access node that does not match its subscribed (or configured, in the roaming case) S-NSSAI(s). + +NOTE 8: The "NON\_3GPP\_NODE\_RESELECTION" trigger only applies if the "SliceAwareANDSP" feature is supported. This Policy Control Request Trigger does not require explicit subscription by the PCF. + +- "CONF\_NSSAI\_CH", i.e. Configured NSSAI change: the Configured NSSAI has changed. + +NOTE 9: The "CONF\_NSSAI\_CH" trigger only applies if the "NssaiChange" feature is supported. + +- "URSP\_ENF\_INFO", i.e. URSP rule enforcement Information: The V-PCF has received URSP rule enforcement information for one or more URSP rules. + +NOTE 10: The "URSP\_ENF\_INFO" trigger only applies to the V-PCF in LBO roaming scenarios and if the "URSPEnforcement" feature is supported. + +- "LBO\_INFO\_CH", i.e. LBO information change: The AMF reports LBO roaming allowed or not allowed for the requested DNN(s) and S-NSSAI(s). + +NOTE 11: The "LBO\_INFO\_CH" trigger only applies to the AMF and when the "VPLMNSpecificURSP" feature is supported. + +- "ACCESS\_TYPE\_CH", i.e. access type change: The registered access type has changed, an access type is added or an access type is removed. + +NOTE 12: The "ACCESS\_TYPE\_CH" trigger only applies when the "AccessChange" feature is supported. + +#### 4.2.3.3 Encoding of updated policy + +Updated policies shall be encoded within the PolicyUpdate data type that may include: + +- only when the updated policy is supplied by the H-PCF in the roaming scenario, UE policy (see clause 4.2.2.2) encoded as "uePolicy" attribute, and N2 PC5 policy for V2X communications (see clause 4.2.2.3) encoded as + +"n2Pc5Pol" attribute and/or the N2 PC5 policy for A2X communications (see clause 4.2.2.5) encoded as "n2Pc5PolA2x" attribute and/or the N2 PC5 policy for 5G ProSe (see clause 4.2.2.4) encoded as "n2Pc5ProSePo" attribute and/or the N2 PC5 policy for Ranging/SL (see clause 4.2.2.X) encoded as "n2Pc5RsppPol" attribute; + +- when the updated policy is supplied via PCF of a PDU session by the (V-)PCF in case of URSP provisioning in EPS, UE policy (see clause 4.2.2.2) encoded as "uePolicy" attribute; +- updated Policy Control Request Trigger(s) (see clause 4.2.3.2) encoded as "triggers" attribute, i.e.: + - 1) either a new complete list of applicable Policy Control Request Trigger(s) including one or several of the following: + - a) Location change (tracking area); + - b) Change of UE presence in PRA; + - c) Change of PLMN, if the "PlmnChange" feature is supported; + - d) Change of UE connectivity state, if the "ConnectivityStateChange" feature is supported; + - e) Change of Satellite Backhaul Category, if the "EnSatBackhaulCategoryChg" feature is supported; + - f) Change of Configured NSSAI, in roaming scenarios, if the "NssaiChange" feature is supported and the NF service consumer is the AMF; + - g) LBO information change, applicable to roaming scenarios, if the "VPLMNSpecificURSP" feature is supported and the NF service consumer is an AMF; or + - h) Change of Access type, if the "AccessChange" feature is supported; + - 2) a "NULL" value to request the removal of all previously installed Policy Control Request Trigger(s); and +- if the Policy Control Request Trigger "Change of UE presence in PRA" is provided or if that trigger was already set but the requested presence reporting areas need to be changed, the presence reporting areas for which reporting is required encoded as "pras" attribute encoded as follows: + - a) A new entry shall be added by supplying a new identifier as key and the corresponding PresenceInfo data type instance with complete contents as value as an entry within the map. + - b) An existing entry shall be modified by supplying the existing identifier as key and the PresenceInfo data type instance with complete contents as value as an entry within the map. + - c) An existing entry shall be deleted by supplying the existing identifier as key and "NULL" as value as an entry within the map. + - d) For an unmodified entry, no entry needs to be provided within the map. +- if the Policy Control Request Trigger "LBO information change" is provided or if that trigger was already set but the requested LBO information needs to be changed, the requested LBO information encoded in the "pduSessions" attribute, a list of DNN and S-NSSAI combinations previously provided is updated by providing either a new complete list within the "pduSessions" attribute or by setting it to "NULL". If the "pduSessions" attribute is not provided or the previously provided "pduSessions" attribute is deleted, the LBO information change policy control request trigger applies to any S-NSSAI and DNN combination. + +#### 4.2.3.4 Feature renegotiation during AMF relocation + +During the AMF relocation, if the new AMF received the resource URI of the individual UE Policy from the old AMF and selects the old (V-)PCF, and the feature "FeatureRenegotiation" is supported, the new AMF shall invoke the update of the UE policy association as described in clause 4.2.3.1 with the following differences: + +- The new AMF shall include in the PolicyAssociationUpdateRequest data structure sent in the HTTP POST request: + - a. the "FEAT\_RENEG" policy control request trigger within the "triggers" attribute; + +- b. the "suppFeat" attribute with the AMF supported features; and +- c. for each supported feature, the required feature information elements as specified in clause 4.2.2.1, if applicable. + +NOTE 1: When the new AMF received from the old AMF the subscription to policy control request trigger(s) that depend on feature control, and a policy control request trigger is met, the required feature information included in the update request contains the report of the met policy control request trigger within the "triggers" attribute and the associated information in the corresponding attribute, when applicable. + +- Upon reception of the HTTP POST request, the (V-)PCF shall update the "Individual UE Policy Association" resource, determine the applicable policy and include in the PolicyUpdate data structure sent in the HTTP POST response: + +NOTE 2: The determination of the applicable policy can consider the features supported by the new AMF. + +- a. the "suppFeat" attribute with the negotiated supported features; and +- b. the complete "Individual UE Policy Association" resource representation, as specified in clause 4.2.2.1. + +### 4.2.4 Npcf\_UEPolicyControl\_UpdateNotify Service Operation + +#### 4.2.4.1 General + +The (V-)(H)-PCF may decide to update policy control request triggers, and in the roaming case, the H-PCF may decide to update the UE Policy, the V2X N2 PC5 policy, if the "V2X" feature is supported, and/or the A2X N2 PC5 policy, if the "A2X" feature is supported, and/or the 5G ProSe N2 PC5 policy, if the "ProSe" feature is supported and/or the Ranging/SL N2 PC5 policy, if the "Ranging\_SL" feature is supported. The PCF (H-PCF in the roaming case) may decide to request the termination of the policy association. + +If the "EpsUrsp" feature is supported and the NF consumer is a PCF for a PDU session the PCF (H-PCF in the LBO roaming scenario) may decide to update policy control request triggers and/or to update the URSP. The PCF (H-PCF in the LBO roaming scenario) may decide to request the termination of the policy association. + +The(V-)(H)-PCF shall then use an Npcf\_UEPolicyControl\_UpdateNotify service operation. + +The following procedures using the Npcf\_UEPolicyControl\_UpdateNotify service operation are supported: + +- Policy update notification. +- Request the termination of the UE policy association. +- URSP provisioning for background Data Transfer policy. +- UE policy provisioning for V2X communications over PC5 and Uu reference points. +- UE policy provisioning for 5G ProSe. +- UE policy provisioning for Ranging/SL. +- N2 PC5 Policy (e.g. for V2X communications, for A2X communications, for 5G ProSe, for Ranging/SL) provisioning. +- UE policy provisioning for A2X communications over PC5 reference point or A2X communications over Uu reference point or both. + +NOTE: The PCF derives the URSP and invokes the Namf\_Communication\_N1N2MessageTransfer service operation to provision it to the UE. + +- URSP provisioning in EPS. + +#### 4.2.4.2 Policy update notification + +Figure 4.2.4.2-1 illustrates the policy update notification. + +![Sequence diagram showing a policy update notification from PCF to NF service consumer. The PCF sends a POST {notificationUri}/update request. The NF service consumer responds with either 2a. '200 OK' or 2b. '204 No Content'.](c99bf3a0530a3e58f5f2d2790ba7441b_img.jpg) + +``` + +sequenceDiagram + participant PCF + participant NF as NF service consumer + Note right of PCF: 1. POST {notificationUri}/update + PCF->>NF: 1. POST {notificationUri}/update + Note left of NF: 2a. "200 OK" +2b. "204 No Content" + NF-->>PCF: 2a. "200 OK" +2b. "204 No Content" + +``` + +Sequence diagram showing a policy update notification from PCF to NF service consumer. The PCF sends a POST {notificationUri}/update request. The NF service consumer responds with either 2a. '200 OK' or 2b. '204 No Content'. + +**Figure 4.2.4.2-1: policy update notification** + +NOTE: For the roaming case, the PCF represents the V-PCF if the NF service consumer is an AMF and the PCF represents the H-PCF if the NF service consumer is a V-PCF. + +The (V-)(H)-PCF may decide to update, based on external triggers (e.g. notifications received from UDR about new or updated service parameter data as described in 3GPP TS 29.519 [17]) or internal triggers (e.g., the activation of a pending policy counter provided via the Nchf\_SpendingLimitControl Service as described in 3GPP TS 29.594 [33]) policy control request trigger(s) and in the roaming case, the H-PCF may also decide to update the UE Policy, the N2 PC5 policy for V2X communications if the "V2X" feature is supported and/or the N2 PC5 policy for A2X communications if the "A2X" feature is supported and/or the N2 PC5 policy for 5G ProSe if the "ProSe" feature is supported and/or the N2 PC5 policy for Ranging/SL if the "Ranging\_SL" feature is supported. + +NOTE: In this release of the specification, policy decisions based on policy counters provided via Nchf\_SpendingLimitControl service apply only for non-roaming cases and UE policies refer to URSP only. + +If the "EpsUrsp" feature is supported and the NF consumer is a PCF for a PDU session the PCF (H-PCF in the LBO roaming scenario) may decide to update policy control request triggers and/or to update the URSP. + +If the SliceAwareANDSP feature is supported and the PCF has successfully delivered the updated ANDSP/WLANSP to the UE with the slice information for the corresponding non-3gpp node, the PCF may decide to notify the NF service consumer about this successful delivery. + +If the "VPLMNSpecificURSP" feature is supported, the NF consumer is the V-PCF and the H-PCF received the subscription to notification about the delivery outcome of VPLMN-specific URSP rules within the "deliveryEvents" attribute as specified in clauses 4.2.2.1, and 4.2.3.1, the H-PCF notifies about the result of the delivery of UE policies using the "delivReport" attribute as described in clause 4.2.4.7. + +The (V-)(H)-PCF shall then send an HTTP POST request with "{notificationUri}/update" as URI (where the Notification URI was previously supplied by the NF service consumer) to the NF service consumer and the PolicyUpdate data structure as request body encoded as described in clause 4.2.3.3. + +Upon the reception of the HTTP POST request, the NF service consumer: + +- if the V-PCF is the NF service consumer, shall use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to send "MANAGE UE POLICY COMMAND" message(s) with the received UE policy to the UE via the AMF and/or with the received N2 PC5 policy for V2X communications and/or A2X communications and/or 5G ProSe to the NG-RAN via the AMF; +- if the V-PCF is the NF service consumer, shall provision the received policy control requested trigger(s) to the AMF, if applicable, using the Npcf\_UEPolicyControl\_UpdateNotify service operation according to the present clause; +- if the AMF is the NF service consumer, shall enforce the received policy control request trigger(s); + +- if the "EpsUrsp" feature is supported and a PCF for a PDU session is the NF service consumer, shall behave as specified in clause 4.2.4.8; +- shall either send a successful response indicating the success of the enforcement or an appropriate failure response, for the V-PCF as the NF service consumer taking into consideration a reply received from the possible Namf\_Communication Service service operation and from the possible Npcf\_UEPolicyControl\_UpdateNotify service operation according to the previous bullets. In case of a successful response: + - a. if the feature "ImmediateReport" is supported and the PCF provisioned policy control request triggers (applicable triggers are as defined in Table 5.6.2.8-1), a "200 OK" response code and a response body with the corresponding available information in the "UeRequestedValueRep" data structure shall be returned in the response; + - b.- otherwise, a "204 No Content" response code shall be returned in the response; and +- if errors occur when processing the HTTP POST request, shall send an HTTP error response as specified in clause 5.7; or +- if the feature "ES3XX" is supported, and the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +If the feature "ErrorResponse" is supported and if the AMF as NF service consumer is not able to handle the notification but another unknown AMF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +If the (V-)PCF receives a "307 Temporary Redirect" response, the (V-)PCF shall resend the failed policy update notification request using the received URI in the Location header field as Notification URI. Subsequent policy update notifications, triggered after the failed one, shall be sent to the Notification URI provided by the NF service consumer during the corresponding policy association creation/update. + +If the (V-)PCF becomes aware that a new AMF is requiring notifications (e.g. via the "404 Not found" response or via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [14], or via link level failures), and the (V-)PCF knows alternate or backup IPv4, IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the policy association was created or via AMFStatusChange Notifications, or via the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the service name and GUAMI obtained during the creation of the subscription) to query the other AMFs within the AMF set), the (V-)PCF shall exchange the authority part of the corresponding Notification URI with one of those addresses and shall use that URI in any subsequent communication. + +If the (V-)PCF received a "404 Not found" response, the (V-)PCF should resend the failed policy update notification request to that URI. + +#### 4.2.4.3 Request for termination of the policy association + +Figure 4.2.4.3-1 illustrates the request for a termination of the policy association. + +![Sequence diagram showing the request for termination of the UE policy association between a PCF and an NF service consumer.](63a2519518616620ef0e53d98b923c05_img.jpg) + +``` +sequenceDiagram + participant PCF + participant NF_service_consumer as NF service consumer + Note right of PCF: 1. POST {notificationUri}/terminate + PCF->>NF_service_consumer: 1. POST {notificationUri}/terminate + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>PCF: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between a PCF (Policy Control Function) and an NF service consumer. The PCF sends a POST request to the NF service consumer using the URI {notificationUri}/terminate. The NF service consumer responds with a "204 No Content" status code. + +Sequence diagram showing the request for termination of the UE policy association between a PCF and an NF service consumer. + +Figure 4.2.4.3-1: request for a termination of the UE policy association + +NOTE: For the roaming case, the PCF represents the V-PCF if the NF service consumer is an AMF and the PCF represents the H-PCF if the NF service consumer is a V-PCF. + +The (V-)(H-)PCF may request the termination of the UE policy association and shall then send an HTTP POST request with "{notificationUri}/terminate" as URI (where the Notification URI was previously supplied by the NF service consumer) and the TerminationNotification data structure as request body that shall include: + +- the resource URI of the concerned individual UE policy association (including the policy association ID) encoded as "resourceUri" attribute; and +- the cause why the (V-)(H-)PCF requests the termination of the policy association encoded as "cause" attribute. + +Upon the reception of the HTTP POST request, the NF service consumer: + +- if the V-PCF is the NF service consumer, shall send as NF service producer for the corresponding policy association (towards the AMF as NF service consumer) a request for a termination of the policy association according to the present clause; +- shall either send an HTTP "204 No Content" response for the successful processing of the HTTP POST request or an appropriate failure response, for the V-PCF as the NF service consumer taking into consideration a reply received for the possible corresponding policy association termination request according to the previous bullet; and +- if errors occur when processing the HTTP POST request, shall send an HTTP error response as specified in clause 5.7; or +- if the feature "ES3XX" is supported, and the NF service consumer determines that the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +After the successful processing of the HTTP POST request, any NF service consumer except for the V-PCF shall invoke the Npcf\_UEPolicyControl\_Delete Service Operation defined in clause 4.2.5 to terminate the policy association. + +If the AMF as NF service consumer is not able to handle the notification but knows by implementation specific means that another AMF is able to handle the notification, it shall reply with an HTTP "307 Temporary Redirect" response pointing to the URI of the new AMF. If the AMF as NF service consumer is not able to handle the notification but another unknown AMF could possibly handle the notification, it shall reply with an HTTP "404 Not found" error response. + +If the (V-)PCF receives a "307 Temporary Redirect" response, the PCF shall resend the failed request for termination of the policy association using the received URI in the Location header field as Notification URI. + +If the (V-)PCF becomes aware that a new NF service consumer (AMF) is requiring notifications (e.g. via the "404 Not found" response or via Namf\_Communication service AMFStatusChange Notifications, see 3GPP TS 29.518 [14], or via link level failures), and the (V-)PCF knows alternate or backup IPv4, IPv6 Address(es) or FQDN(s) where to send Notifications (e.g. via "altNotifIpv4Addrs", "altNotifIpv6Addrs" or "altNotifFqdns" attributes received when the policy association was created or via AMFStatusChange Notifications, or via the Nnrf\_NFDiscovery Service specified in 3GPP TS 29.510 [13] (using the service name and GUAMI obtained during the creation of the subscription) to query the other AMFs within the AMF set), the (V-)PCF shall exchange the authority part of the corresponding Notification URI with one of those addresses and shall resend the failed request for termination of the policy association to that URI. + +If the (V-)PCF received a "404 Not found" response, the (V-)PCF should resend the failed request for termination of the policy association to that URI. + +#### 4.2.4.4 URSP provisioning for Background Data Transfer policy + +If the "EnhancedBackgroundDataTransfer" feature is supported, after the UE policy association establishment, the (H-)PCF may receive the Background Data Transfer Reference ID(s) notified by the UDR for the change of UE's Application Data as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case, the (H-)PCF shall retrieve the transfer policy corresponding to the Background Data Transfer Reference ID(s) as defined in clause 5.2.8 of 3GPP TS 29.519 [17] and derive the URSP including the Route Selection Validation Criteria for the UE as defined in clause 6.2.2.1 of 3GPP TS 23.503 [4]. The H-PCF shall provision the URSP to the V-PCF as defined in clause 4.2.4.2 and then the V-PCF shall invoke the Namf\_Communication\_NIN2MessageTransfer service operation to provision it to + +the UE. The (H-)PCF shall use the associated S-NSSAI and DNN to store in the UDR the Background Data Transfer Reference ID(s) in the UE's session management policy data as specified in 3GPP TS 29.519 [17]. + +#### 4.2.4.5 UE policy provisioning for V2X communication over PC5 and Uu reference points + +After the UE policy association establishment and if the "V2X" feature is supported, the (H-)PCF may receive the service specific parameter information notified by the UDR for the change of UE's Application Data as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case: + +- for the roaming case, the H-PCF shall derive the V2XP and provision it to the V-PCF as defined in clause 4.2.4.2; and/or +- for the roaming and non-roaming case, the (V-)PCF shall use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to send "MANAGE UE POLICY COMMAND" message(s) with the V2XP to the UE via the AMF. + +#### 4.2.4.6 UE policy provisioning for 5G ProSe + +After the UE policy association establishment and if the "ProSe" feature is supported, the (H-)PCF may receive the service specific parameter information via a notification on the change of UE's Application Data from the UDR, as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case: + +- for the roaming case, the H-PCF shall derive the ProSeP and provision it to the V-PCF as defined in clause 4.2.4.2; and/or +- for the roaming and non-roaming case, the (H-)PCF shall derive the ProSeP and the (V-)PCF shall use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to convey it to the UE via the AMF by sending "MANAGE UE POLICY COMMAND" message(s) as defined in 3GPP TS 24.554 [28]. + +#### 4.2.4.7 UE policy provisioning for AF-influenced URSP + +If the "AfGuideURSP" feature is supported by the Nudr\_DataRepository service, after the UE policy association establishment, the (H-)PCF may be informed that service specific parameter information that contains data for AF guidance on the URSP determination has been created, modified or removed via a notification by the UDR for the change or removal of UE's Application Data as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case, the H-PCF may derive new URSP(s), modify existing URSP(s) or remove existing URSP(s) by using the information received from the UDR (see clause 4.2.2.2.1.1 and 4.2.2.2.3 for the description of how the (H-)PCF may use this information, stored UPSC(s), policy subscription information, analytics information received from NWDAF and local operator policy to determine the URSP that will be provisioned to the UE), and it shall: + +- for the roaming case, provision the derived new UE Policy Sections, and/or update and/or remove existing UE Policy Sections to the V-PCF as defined in clause 4.2.4.2 and then the V-PCF shall invoke the Namf\_Communication\_N1N2MessageTransfer service operation to provision the received UE Policy Sections to the UE; or +- for the non-roaming case, use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to convey the derived new UE Policy Sections and/or to update and/or remove existing UE Policy Sections to the UE via the AMF within "MANAGE UE POLICY COMMAND" message(s). + +In the roaming case, when the AMF informs the V-PCF that the UE is temporarily unreachable (see 3GPP TS 29.518 [18]), the V-PCF notifies the H-PCF accordingly (including the "uePolTransFailNotif" attribute within the PolicyAssociationUpdateRequest data structure, as described in clause 4.2.2.2.1.0). + +When the (H-)PCF receives the "MANAGE UE POLICY COMPLETE" or the "MANAGE UE POLICY COMMAND REJECT" message and/or the PCF deducts that the UE is temporarily unreachable, and the PCF determines that the received message or the internal deduction indicates a UE Policy Delivery outcome event is matched : + +- if an NF service consumer has subscribed via a request for service specific parameters to the HPLMN, the (H-)PCF shall invoke the Npcf\_EventExposure\_Notify service operation as defined in clause 4.2.4.2 of 3GPP TS 29.523 [30]; or + +- if a V-PCF has subscribed with the H-PCF as specified in clauses 4.2.2.1 and/or 4.2.3.1 because an AF has subscribed via a request for service parameters to the VPLMN, the H-PCF shall invoke the Npcf\_UEPolicyControl\_UpdateNotify as specified in this clause to notify about the result of the delivery of UE policies using the "delivReport" attribute. The "delivReport" attribute is a map of "eventNotifs" attributes, where: + - a. the key of the map represents the related AF; and + - b. each "eventNotifs" entry shall contain the reported event(s) ("SUCCESS\_UE\_POL\_DEL\_SP" or "UNSUCCESS\_UE\_POL\_DEL\_SP") within the "event" attribute and in case of delivery failure, the "delivFailure" attribute with the corresponding failure reason. + +When the AMF (non roaming case) or the V-PCF (roaming case) informs the (H-)PCF that the UE is temporarily unreachable (see 3GPP TS 29.518 [18]), the (H-) PCF may subscribe to "CON\_STATE\_CH" trigger if not done before and reattempt the provisioning of URSP(s) when the UE becomes reachable. + +#### 4.2.4.8 UE policy provisioning for A2X communication over PC5 and A2X communication over Uu reference point + +After the UE policy association establishment and if the "A2X" feature is supported, the (H-)PCF may receive the service specific parameter information notified by the UDR for the change of UE's Application Data as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case: + +- for the roaming case, the H-PCF shall derive the A2XP and provision it to the V-PCF as defined in clause 4.2.4.2; and/or +- for the roaming and non-roaming case, the (V-)PCF shall use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to send "MANAGE UE POLICY COMMAND" message(s) with the A2XP to the UE via the AMF. + +#### 4.2.4.9 URSP provisioning in EPS. + +When the "EpsUrsp" feature is supported and a PCF for a PDU session is the NF service consumer, the PCF for the UE may provide a UE Policy Container (with a "MANAGE UE POLICY COMMAND" message(s) with the UE policy to send to the UE via the PCF for the PDU session) and/or an update in the Policy Control Triggers applicable to the UE as described in clause 4.2.4.2. + +- 1)- When the PCF for the PDU session receives a UE Policy Container from the PCF for the UE, the PCF for the PDU session first shall select one of the ongoing PDU sessions for the related UE in EPC, and shall use the Npcf\_SMPolicyControl\_UpdateNotify service operation defined in 3GPP TS 29.512 [31] to forward to the UE via SMF+PGW-C the UE Policy Container with the "MANAGE UE POLICY COMMAND" message(s) with the received UE policy. +- 2) When the PCF for the PDU session receives an update in the Policy Control Request Triggers applicable to the UE, the PCF for the PDU session shall determine whether an update on the current Policy Control Triggers need to be sent to the SMF+PGW-C. In that case, the PCF for the PDU session shall select one of the ongoing PDU sessions for the related UE in EPC, and shall provision the received policy control requested trigger(s) to the SMF+PGW-C using the Npcf\_SMPolicyControl\_UpdateNotify service operation according to 3GPP TS 29.512 [31]. + +**Editor's Note:** It is FFS how the PCF for the PDU session selects one of the ongoing PDU sessions. + +#### 4.2.4.10 UE policy provisioning for Ranging/SL + +After the UE policy association establishment and if the "Ranging\_SL" feature is supported, the (H-)PCF may receive the service specific parameter information via a notification on the change of UE's Application Data from the UDR, as defined in clause 6.3.4 of 3GPP TS 29.519 [17]. In this case: + +- for the roaming case, the H-PCF shall derive the RSLPP and provision it to the V-PCF as defined in clause 4.2.4.2; and/or +- for the roaming and non-roaming case, the (H-)PCF shall derive the RSLPP and the (V-)PCF shall use the Namf\_Communication Service defined in 3GPP TS 29.518 [14] to convey it to the UE via the AMF by sending "MANAGE UE POLICY COMMAND" message(s). + +### 4.2.5 Npcf\_UEPolicyControl\_Delete Service Operation + +Figure 4.2.5-1 illustrates the deletion of a policy association. + +![Sequence diagram showing the deletion of a policy association between an NF service consumer and a PCF. The NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content.](b44f89b176c971c7dd264c07bfef2c2a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. DELETE .../policies/{polAssoId} + NF service consumer->>PCF: 1. DELETE .../policies/{polAssoId} + Note left of PCF: 2. "204 No Content" + PCF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the deletion of a policy association between an NF service consumer and a PCF. The NF service consumer sends a DELETE request to the PCF, and the PCF responds with a 204 No Content. + +**Figure 4.2.5-1: Deletion of a policy association** + +NOTE: For the roaming case, the PCF represents the V-PCF if the NF service consumer is an AMF and the PCF represents the H-PCF if the NF service consumer is a V-PCF. + +The AMF as NF service consumer requests that the policy association is deleted when the corresponding UE context is terminated, e.g. during UE de-registration from the network. In roaming scenarios, the V-PCF requests to the H-PCF the deletion of the UE policy association when the V-PCF determines that the UE context is terminated in the AMF, e.g., with the reception of the policy association deletion request or the reception of UE context not found reply to the UE Policy delivery request. + +During the AMF relocation, the old AMF shall invoke this procedure when: + +- the resource URI of the individual UE Policy Association resource is not transferred to the new AMF; or +- the new AMF informs the old AMF that the individual UE Policy Association resource is not being reused. + +The PCF for the PDU session as NF service consumer requests that the UE policy association is deleted when: + +- all the PDU sessions related with the UE policy association are terminated; or +- the PCF for the PDU session receives an indication of RAT type change from the SMF+PGW-C (from any of the related PDU sessions) and determines the EPS to 5GS mobility scenario applies. + +To request that the UE policy association is deleted, the NF service consumer (e.g. AMF) shall send an HTTP DELETE request with "{apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId}" as Resource URI. + +Upon the reception of the HTTP DELETE request, + +- the (V-)(H-)PCF shall delete the policy association; +- if the PCF is a V-PCF and has an established corresponding policy association towards the H-PCF, the V-PCF shall send as the NF service consumer towards the H-PCF a request for the deletion of that policy association as described in the present clause; +- the (V-)(H-)PCF shall send either an HTTP "204 No Content" response indicating the success of the deletion or an appropriate failure response, for the V-PCF as PCF taking into consideration a reply received for the possible policy association deletion request according to the previous bullet; and +- the (V-)(H-)PCF shall if errors occur when processing the HTTP DELETE request, send an HTTP error response as specified in clause 5.7; or +- if the feature ES3XX is supported, and the (V-)(H-)PCF determines the received HTTP DELETE request needs to be redirected, the (V-)(H-)PCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +Once the UE policy association is deleted, to unsubscribe to notifications of N1 message for UE Policy Delivery Result, the (V-)PCF shall trigger the Namf\_Communication\_N1N2MessageUnsubscribe service operation towards the N1N2 Individual Subscription resource as specified in 3GPP TS 29.518 [14]. + +# --- 5 Npcf\_UEPolicyControl API + +## 5.1 Introduction + +The Access and Mobility Policy Control Service shall use the Npcf\_UEPolicyControl API. + +The API URI of the Npcf\_UEPolicyControl API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the PCF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [6], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [6]. +- The shall be "npcf-ue-policy-control". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +HTTP/2, IETF RFC 9113 [8], shall be used as specified in clause 5 of 3GPP TS 29.500 [5]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [5]. + +The OpenAPI [10] specification of HTTP messages and content bodies for the Npcf\_UEPolicyControl is contained in Annex A. + +### 5.2.2 HTTP standard headers + +#### 5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [5] for the usage of HTTP standard headers. + +#### 5.2.2.2 Content type + +JSON, IETF RFC 8259 [9], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [5]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [21]. + +### 5.2.3 HTTP custom headers + +The Npcf\_UEPolicyControl API shall support HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [5] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [5]. + +In this Release of the specification, no specific custom headers are defined for the Npcf\_UEPolicyControl API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.3.1-1 depicts the resource URIs structure for the Npcf\_UEPolicyControl API. + +![Figure 5.3.1-1: Resource URI structure of the Npcf_UEPolicyControl API. The diagram shows a hierarchical tree structure starting with {apiRoot}/npcf-ue-policy-control/v1. It branches to /policies, which then branches to /{polAssId}, which finally branches to /update (indicated by a dashed box).](f943b07ab747bfd85e302e5a31c20ba8_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npcf-ue-policy-control/v1"] --> Policies["/policies"] + Policies --> PolAssId["/{polAssId}"] + PolAssId --> Update["/update"] + style Update stroke-dasharray: 5 5 + +``` + +Figure 5.3.1-1: Resource URI structure of the Npcf\_UEPolicyControl API. The diagram shows a hierarchical tree structure starting with {apiRoot}/npcf-ue-policy-control/v1. It branches to /policies, which then branches to /{polAssId}, which finally branches to /update (indicated by a dashed box). + +**Figure 5.3.1-1: Resource URI structure of the Npcf\_UEPolicyControl API** + +Table 5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|-----------------------------|---------------------------------|---------------------------------------------------------------| +| UE Policy Associations | /policies | POST | Create a new Individual UE policy association resource. | +| Individual UE Policy Association | /policies/{polAssId} | GET | Read an Individual UE Policy Association resource. | +| | | DELETE | Delete an Individual UE Policy Association resource. | +| | /policies/{polAssId}/update | update (POST) | Report observed event trigger and obtain updated UE policies. | + +### 5.3.2 Resource: UE Policy Associations + +#### 5.3.2.1 Description + +This resource represents a collection of UE policy associations. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/npcf-ue-policy-control/v1/policies + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +**Table 5.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.2.3 Resource Standard Methods + +##### 5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +**Table 5.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +**Table 5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|------------------------------------------------------------| +| PolicyAssociationRequest | M | 1 | Input parameters for the creation of a policy association. | + +**Table 5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|-----------------|-----------------------------------------------------------------| +| PolicyAssociation | M | 1 | 201 Created | Policy association was created and policies are being provided. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: Failure cases are described in clause 5.7. + +**Table 5.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId} | + +### 5.3.3 Resource: Individual UE Policy Association + +#### 5.3.3.1 Description + +This resource represents an individual UE policy association. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId} + +This resource shall support the resource URI variables defined in table 5.3.2.2-1. + +Table 5.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------| +| apiRoot | string | See clause 5.1. | +| polAssocId | string | Identifier of a policy association. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.3.2.3.1-1. + +Table 5.3.3.3.1-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.2.3.1-3. + +Table 5.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 5.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| PolicyAssociation | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual UE policy retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual UE policy retrieval.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP/SEPP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +Table 5.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +##### 5.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.3.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.2-3. + +**Table 5.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The policy association was successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual UE policy deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual UE policy deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP/SEPP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +#### 5.3.3.4 Resource Custom Operations + +##### 5.3.3.4.1 Overview + +**Table 5.3.3.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-------------------------------|--------------------|------------------------------------------------------------| +| Update | /policies/{polAssocId}/update | POST | Report observed event trigger and obtain updated policies. | + +##### 5.3.3.4.2 Operation: Update + +###### 5.3.3.4.2.1 Description + +The update custom operation allows an NF service consumer to report the occurrence on one or more policy request trigger(s) and to obtain related updated policies. + +###### 5.3.3.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 5.3.3.4.2.2-1 and the response data structure and response codes specified in table 5.3.3.4.2.2-2. + +**Table 5.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-----------------------------------------------------------| +| PolicyAssociationUpdateRequest | M | 1 | Describes the observed policy control request trigger(s). | + +**Table 5.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| PolicyUpdate | M | 1 | 200 OK | Describes updated policies. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual UE policy modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual UE policy modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP/SEPP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +**Table 5.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative PCF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target PCF (service) instance towards which the request is redirected. | + +## 5.4 Custom Operations without associated resources + +None. + +## 5.5 Notifications + +### 5.5.1 General + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------------------------|-----------------------------|---------------------------------|----------------------------------------------------| +| Policy Update Notification | {notificationUri}/update | update (POST) | Policy Update Notification. | +| Request for termination of the UE policy association | {notificationUri}/terminate | terminate (POST) | Request for termination of the policy association. | + +### 5.5.2 Policy Update Notification + +#### 5.5.2.1 Description + +This notification is used by the H-PCF to provide updates of UE policies to the V-PCF as NF service consumer, and used by the V-PCF to provide updates of policy control request triggers to the AMF as NF service consumer. + +#### 5.5.2.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.2.2-1 and the response data structure and response codes specified in table 5.5.2.2-2. + +**Table 5.5.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------| +| PolicyUpdate | M | 1 | Updated policies. | + +**Table 5.5.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeRequestedValueRep | O | 0..1 | 200 OK | The current applicable values corresponding to the policy control request trigger are reported. | +| n/a | | | 204 No Content | The policies were successfully updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during UE policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during UE policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another unknown host.
Applicable if the feature "ErrorResponse" is supported. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: Failure cases are described in clause 5.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP/SEPP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]) + +**Table 5.5.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF service consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported. | + +**Table 5.5.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.5.3 Request for termination of the UE policy association + +#### 5.5.3.1 Description + +This notification is used by the PCF to request the termination of a UE policy association. + +#### 5.5.3.2 Operation Definition + +This operation shall support the request data structures specified in table 5.5.3.2-1 and the response data structure and response codes specified in table 5.5.3.2-2. + +**Table 5.5.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|----------------------------------------------| +| TerminationNotification | M | 1 | Request to terminate the policy association. | + +**Table 5.5.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The request for policy association termination was received. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during UE policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during UE policy notification.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The NF service consumer can use this response when the notification can be sent to another unknown host. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [5] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP/SEPP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]). + +**Table 5.5.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. It may be included if the feature "ES3XX" is supported. | + +**Table 5.5.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resources located in an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the request is redirected to the same target via a different SCP/SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [5]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.6 Data Model + +### 5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.1-1 specifies the data types defined for the Npcf\_UEPolicyControl service based interface protocol. + +Table 5.6.1-1: Npcf\_UEPolicyControl specific Data Types + +| Data type | Section defined | Description | Applicability | +|-------------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| AccessStatus | 5.6.3.8 | Indicates whether the Access change is addition or removal. | AccessChange | +| LboRoamingInformation | 5.6.2.10 | LBO roaming information for a DNN and S-NSSAI | VPLMNSpecific URSP | +| N1N2MessTransferErrorReply | 5.6.3.8 | Error the V-PCF may send to the H-PCF when the V-PCF receives from the AMF an error to the N1N2MessageTransfer request. | EnErrorHandling | +| Non3gppAccess | 5.6.3.7 | Represents a Non-3gpp access node. | SliceAwareANDSP | +| Pc5Capability | 5.6.3.5 | Indicates the specific PC5 RAT(s) which the UE supports for V2X communications and/or A2X communications over PC5 reference point. | V2X, A2X | +| ProSeCapability | 5.6.3.6 | Indicates the 5G ProSe capabilities. | ProSe | +| PolicyAssociation | 5.6.2.2 | Description of a policy association that is returned by the PCF when a policy Association is created, updated, or read. | | +| PolicyAssociationReleaseCause | 5.6.3.4 | The cause why the PCF requests the termination of the policy association. | | +| PolicyAssociationRequest | 5.6.2.3 | Information that NF service consumer provides when requesting the creation of a policy association. | | +| PolicyAssociationUpdateRequest | 5.6.2.4 | Information that NF service consumer provides when requesting the update of a policy association. | | +| PolicyUpdate | 5.6.2.5 | Updated policies that the PCF provides in a notification or in the reply to an Update Request. | | +| RequestTrigger | 5.6.3.3 | Enumeration of possible Request Triggers. | | +| TerminationNotification | 5.6.2.6 | Request to terminate a policy Association that the PCF provides in a notification. | | +| UeRequestedValueRep | 5.6.2.8 | Contains the current applicable values corresponding to the policy control request triggers. | ImmediateReport | +| UePolicy | 5.6.3.2 | UE Policies | | +| UePolicyDeliveryResult | 5.6.3.2 | UE Policy delivery Result | | +| UePolicyNotification | 5.6.2.10 | Contains the delivery outcome of VPLMN-Specific URSP rules | VPLMNSpecific URSP | +| UePolicyParameters | 5.6.2.9 | Contains the service parameters used to guide the VPLMN-specific URSP rule determination. | VPLMNSpecific URSP | +| UePolicyRequest | 5.6.3.2 | Request for UE Policies | | +| UePolicyTransferFailureCause | 5.6.4.1 | UE Policy Transfer Failure Cause | EnErrorHandling | +| UePolicyTransferFailureNotification | 5.6.2.7 | Information that the UE policy is failure to be transferred to the UE. | | +| UrspEnforcemenPduSession | 5.6.2.11 | Represents URSP rule enforcement information for a PDU session. | URSPEnforcement | + +Table 5.6.1-2 specifies data types re-used by the Npcf\_UEPolicyControl service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Npcf\_UEPolicyControl service based interface. + +Table 5.6.1-2: Npcf\_UEPolicyControl re-used Data Types + +| Data type | Reference | Comments | Applicability | +|--------------------------------|---------------------|---------------------------------------------------------------------------------------------------|------------------------------| +| AccessType | 3GPP TS 29.571 [11] | | | +| Bytes | 3GPP TS 29.571 [11] | String with format "byte". | | +| ConfiguredSnssai | 3GPP TS 29.531 [34] | Contains the configured S-NSSAI and optionally mapped home S-NSSA. | SliceAwareANDSP, NssaiChange | +| CmState | 3GPP TS 29.518 [14] | Connectivity state of UE | ConnectivityStateChange | +| Event | 3GPP TS 29.522 [41] | Subscription to notification about delivery of VPLMN specific URSP rule. | VPLMNSpecificURSP | +| Fqdn | 3GPP TS 29.571 [11] | FQDN | | +| Gpsi | 3GPP TS 29.571 [11] | Generic Public Subscription Identifier | | +| GroupId | 3GPP TS 29.571 [11] | | | +| Guami | 3GPP TS 29.571 [11] | Globally Unique AMF Identifier | | +| Ipv4Addr | 3GPP TS 29.571 [11] | | | +| Ipv6Addr | 3GPP TS 29.571 [11] | | | +| N1N2MessageTransferCause | 3GPP TS 29.518 [14] | | | +| N2InfoContent | 3GPP TS 29.518 [14] | Represents a transparent N2 information content to be relayed by AMF. | V2X, A2X, ProSe, Ranging_SL | +| NfInstanceId | 3GPP TS 29.571 [11] | | | +| PcfEventNotification | 3GPP TS 29.523 [30] | Represents notification about UE Policy Delivery outcome | VPLMNSpecificURSP | +| PduSessionInfo | 3GPP TS 29.571 [11] | Contains a DNN and SNSSAI combination | VPLMNSpecificURSP | +| PduSessionInformation | 3GPP TS 29.523 [30] | Contains PDU session identification information. | URSPEnforcement | +| Pei | 3GPP TS 29.571 [11] | Permanent Equipment Identifier | | +| PlmnId | 3GPP TS 29.571 [11] | | | +| PlmnIdNid | 3GPP TS 29.571 [11] | Identifies the network: PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID). | | +| PresenceInfo | 3GPP TS 29.571 [11] | Presence reporting area information | | +| ProblemDetails | 3GPP TS 29.571 [11] | | | +| RatType | 3GPP TS 29.571 [11] | | | +| RedirectResponse | 3GPP TS 29.571 [11] | Contains redirection related information. | ES3XX | +| RedundantPduSessionInformation | 3GPP TS 29.502 [40] | Contains the Redundant PDU session information, i.e, the RSN and the PDU Session Pair ID. | URSPEnforcement | +| ServiceName | 3GPP TS 29.510 [13] | Name of the service instance. | | +| SatelliteBackhaulCategory | 3GPP TS 29.571 [11] | Indicates the satellite backhaul category or non-satellite backhaul. | EnSatBackhaulCategoryChg | +| Snssai | 3GPP TS 29.571 [11] | Represents an S-NSSAI | SliceAwareANDSP | +| Supi | 3GPP TS 29.571 [11] | Subscription Permanent Identifier | | +| SupportedFeatures | 3GPP TS 29.571 [11] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | +| TimeZone | 3GPP TS 29.571 [11] | | | +| UInteger | 3GPP TS 29.571 [11] | | | +| Uri | 3GPP TS 29.571 [11] | | | +| UrspEnforcementInfo | 3GPP TS 29.512 [31] | URSP rule enforcement information as received from the UE. | URSPEnforcement | +| UrspRuleRequest | 3GPP TS 29.522 [41] | URSP rule guidance information | VPLMNSpecificURSP | +| UserLocation | 3GPP TS 29.571 [11] | | | + +### 5.6.2 Structured data types + +#### 5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +#### 5.6.2.2 Type PolicyAssociation + +Table 5.6.2.2-1: Definition of type PolicyAssociation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| request | PolicyAssociationRequest | O | 0..1 | The information provided by the NF service consumer when requesting the creation of a policy association | | +| uePolicy | UePolicy | O | 0..1 | The UE policy as determined by the H-PCF (for the H-PCF as NF service producer). | | +| n2Pc5Pol | N2InfoContent | O | 0..1 | The N2 PC5 policy for V2X communications as determined by the H-PCF. | V2X | +| n2Pc5PolA2x | N2InfoContent | O | 0..1 | The N2 PC5 policy for A2X communications as determined by the H-PCF. | A2X | +| n2Pc5ProSePol | N2InfoContent | O | 0..1 | The N2 PC5 policy for 5G ProSe as determined by the PCF. | ProSe | +| triggers | array(RequestTrigger) | O | 1..N | Request Triggers to which the PCF subscribes. Only the values "LOC_CH", "PRA_CH", "PLMN_CH", "CONF_NSSAI_CH", "SAT_CATEGORY_CHG", "URSP_ENF_INFO", "ACCESS_TYPE_CH", "LBO_INFO_CH" and "CON_STATE_CH" are permitted. | (NOTE) | +| pras | map(PresenceInfo) | C | 1..N | If the Request Trigger "PRA_CH" is provided, the presence reporting area(s) for which reporting is requested shall be provided. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" and the "additionalPrald" attributes within the PresenceInfo data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. | | +| andspDelInd | boolean | O | 0..1 | Indication that the updated ANDSP/WLANSP has been successfully delivered to the UE. "true" means that it has been successfully delivered. The default value is "false". | SliceAwareANDSP | +| andspInd | boolean | O | 0..1 | Indication of UE support of ANDSP. True: The UE supports ANDSP; False: The UE does not support ANDSP. | UECapabilityIndication | +| pduSessions | array(PduSessionInfo) | O | 1..N | Contains the DNNs and S-NSSAIs for which LBO information is being requested. It may be provided when the "LBO_INFO_CH" request trigger is provided. | VPLMNSpecific URSP | +| suppFeat | SupportedFeatures | M | 1 | Indicates the negotiated supported features. | | +| n2Pc5RsppPol | N2InfoContent | O | 0..1 | The N2 PC5 policy for Ranging/SL as determined by the H-PCF. | Ranging_SL | + +NOTE: The "PLMN\_CH", "CONF\_NSSAI\_CH", "LBO\_INFO\_CH", "SAT\_CATEGORY\_CHG", "ACCESS\_TYPE\_CH", "URSP\_ENF\_INFO" and "CON\_STATE\_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. + +#### 5.6.2.3 Type PolicyAssociationRequest + +Table 5.6.2.3-1: Definition of type PolicyAssociationRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the PCF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| supi | Supi | M | 1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | C | 0..1 | Generic Public Subscription Identifier. Shall be provided when available. | | +| accessType | AccessType | C | 0..1 | The Access Type where the served UE is camping. Shall be provided when available. | | +| pei | Pei | C | 0..1 | The Permanent Equipment Identifier of the served UE. Shall be provided when available. | | +| userLoc | UserLocation | C | 0..1 | The location of the served UE. Shall be provided when available. | | +| timeZone | TimeZone | C | 0..1 | The time zone where the served UE is camping. Shall be provided when available. | | +| servingPlmn | PlmnIdNid | C | 0..1 | The serving network (a PLMN or an SNPN) where the served UE is camping. For the SNPN the NID together with the PLMN ID identifies the SNPN. Shall be provided when available. | | +| ratType | RatType | C | 0..1 | The RAT Type where the served UE is camping. Shall be provided when available. | | +| groupIds | array(GroupId) | C | 1..N | Internal Group Identifier(s) of the served UE. Shall be provided when available. | | +| hPcfId | NfInstanceId | C | 0..1 | H-PCF Identifier. Shall be provided when available. | | +| uePolReq | UePolicyRequest | C | 0..1 | A request for UE Policies. Shall be provided when the AMF receives an "UE STATE INDICATION" message, as defined in Annex D.5.4 of 3GPP TS 24.501 [15]. | | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as NF service consumer. | | +| serviceName | ServiceName | O | 0..1 | If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of information received within the Npcf_UEPolicyControl_UpdateNotify service operation. | | +| servingNfId | NfInstanceId | C | 0..1 | If the NF service consumer is an AMF, it shall contain the identifier of the serving AMF. | | +| pc5Capab | Pc5Capability | C | 0..1 | Indicates the PC5 Capability for V2X communications supported by the UE. It shall be provided when available at the NF service consumer. | V2X | + +| | | | | | | +|---------------------|-------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| pc5CapA2x | Pc5Capability | C | 0..1 | Indicates the PC5 Capability for A2X communications supported by the UE. It shall be provided when available at the NF service consumer. | A2X | +| proSeCapab | array(ProSeCapability) | C | 1..N | Indicates whether the UE is capable of one or more of the the following 5G ProSe Capabilities: 5G ProSe Direct Discovery, 5G ProSe Direct Communication, Layer-2 and/or Layer 3 5G ProSe UE-to-Network Relay and Layer-2 and/or Layer 3 5G ProSe Remote UE, and when the "ProSe_Ph2" feature is supported, Layer-2 and/or Layer-3 5G ProSe UE-to-UE Relay and Layer-2 and/or Layer-3 5G ProSe End UE.
. It shall be provided when available at the NF service consumer. | ProSe | +| confSnssais | array(ConfiguredSnssai) | C | 1..N | The Configured NSSAI for the serving PLMN, and optionally the mapped S-NSSAI value of home network corresponding to the configured S-NSSAI in the serving PLMN.
. It shall be provided in the roaming case when available at the NF service consumer. It shall be provided in the roaming case when available at the NF service consumer and the "NON_3GPP_NODE_RESELECTI ON" trigger is reported within the "triggers" attribute.
It shall be provided for trigger "CONF_NSSAI_CH". (NOTE) | SliceAwareANDSP, NssaiChange | +| n3gNodeReSel | Non3gppAccess | O | 0..1 | A wrongly selected non-3gpp access node. It shall be provided in the roaming case when available at the NF service consumer, i.e. when the UE has selected a non-3gpp access node that does not match its subscribed or Configured NSSAI. | SliceAwareANDSP | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates types of the satellite backhaul based on satellite types (when satellite backhaul is used) or non-satellite backhaul (when satellite backhaul is not used)..
The default value "NON_SATELLITE" shall apply if the attribute is not present. | EnSatBackhaulCategoryCh g | +| vpsUePolGuidance | map(UePolicyParameters ) | O | 1..N | Contains the service parameter used to guide the VPLMN-specific URSP and may contain the subscription to VPLMN-specific URSP delivery outcome. The key of the map represents the AF request to guide the VPLMN-specific URSP rules.
This attribute only applies in roaming and when the V-PCF is the NF service consumer. | VPLMNSpecificURSP | +| lboRoamInfo | array(LboRoamingInforma tion) | O | 1..N | Contains LBO roaming information for DNN and S-NSSAI | VPLMNSpecificURSP | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| | | | | combination(s).
This attribute only applies in roaming and when the AMF is the NF service consumer. | | +| 5gsToEpsMob | boolean | O | 0..1 | When it is set to true, it indicates the UE Policy Association creation is triggered by a 5GS to EPS mobility scenario.
Default value is false. | EpsUrsp | +| suppFeat | SupportedFeatures | M | 1 | Indicates the features supported by the service consumer. | | +| rangingSICapab | boolean | C | 0..1 | Indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not.
"true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE.
"false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE.
Default value when omitted is "false".

It shall be provided when available at the NF service consumer. | Ranging_SL | +| NOTE: The "mappedHomeSnssai" attribute within the ConfiguredSnssai data type may only be provided if the "NssaiChange" feature is supported. | | | | | | + +#### 5.6.2.4 Type PolicyAssociationUpdateRequest + +Table 5.6.2.4-1: Definition of type PolicyAssociationUpdateRequest + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| notificationUri | Uri | O | 0..1 | Identifies the recipient of Notifications sent by the PCF. | | +| altNotifIpv4Addrs | array(Ipv4Addr) | O | 1..N | Alternate or backup IPv4 Address(es) where to send Notifications. | | +| altNotifIpv6Addrs | array(Ipv6Addr) | O | 1..N | Alternate or backup IPv6 Address(es) where to send Notifications. | | +| altNotifFqdns | array(Fqdn) | O | 1..N | Alternate or backup FQDN(s) where to send Notifications. | | +| triggers | array(RequestTrigger) | C | 1..N | Request Triggers that the NF service consumer observes. | | +| praStatuses | map(PresenceInfo) | C | 1..N | If the Trigger "PRA_CH" is reported, the UE presence status for tracking area for which changes of the UE presence occurred shall be provided. The "prald" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall be supplied. The "additionalPrald" attribute within the PresenceInfo data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of an individual presence reporting area. | | +| userLoc | UserLocation | C | 0..1 | The location of the served UE shall be provided for trigger "LOC_CH". | | +| uePolDelResult | UePolicyDeliveryResult | C | 0..1 | UE Policy Delivery Result. Shall be provided together with trigger "UE_POLICY" when a "MANAGE UE POLICY COMPLETE" message or a "MANAGE UE POLICY COMMAND REJECT" message, as defined in Annex D.5 of 3GPP TS 24.501 [15], has been received by the V-PCF and is being forwarded to the H-PCF. | | +| uePolTransFailNotif | UePolicyTransferFailureNotification | C | 0..1 | The UE policy transfer failure notification. Shall be the provided together with trigger "UE_POLICY" when a response with HTTP status code 4xx or 5xx as defined in clause 5.2.2.3.1.2 of 3GPP TS 29.518 [14] or a N1N2 Transfer Failure Notification as defined in clause 5.2.2.3.2 of 3GPP TS 29.518 [14] is received after the V-PCF provisioned the UE policy by invoking the Namf_Communication_N1N2MessageTransfer service operation to the AMF and is notifying the H-PCF. | | +| uePolReq | UePolicyRequest | C | 0..1 | A request for UE Policies. Shall be provided together with trigger "UE_POLICY" when the V-PCF receives an "UE POLICY PROVISIONING REQUEST" message, as defined in clause 7.2.1.1 of 3GPP TS 24.587 [24], if the "V2X" feature is supported, and/or when the V-PCF receives an "UE POLICY | V2X, A2X, ProSe, Ranging_SL | + +| | | | | | | +|---------------------|--------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| | | | | PROVISIONING REQUEST" message for 5G ProSe, as defined in clause 10.4.1 of 3GPP TS 24.554 [28], if the "ProSe" feature is supported and/or when the V-PCF receives an "UE POLICY PROVISIONING REQUEST" message for A2X, as defined 3GPP TS 24.577 [32], if the "A2X" feature is supported and/or when the V-PCF receives an "UE POLICY PROVISIONING REQUEST" message for Ranging/SL, as defined 3GPP TS 24.514 [42], if the "Ranging_SL" feature is supported.. | | +| guami | Guami | C | 0..1 | The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as NF service consumer during the AMF relocation. | | +| servingNfId | NfInstanceId | C | 0..1 | It shall contain the identifier of the new AMF during the AMF relocation. | | +| plmnId | PlmnIdNid | C | 0..1 | The serving network identity (a PLMN or an SNPN) of the served UE shall be provided for trigger "PLMN_CH". | PlmnChange | +| connectState | CmState | C | 0..1 | The connectivity state of the served UE shall be provided for trigger "CON_STATE_CH". | ConnectivityStateChange | +| groupIds | array(GroupId) | C | 1..N | Internal Group Identifier(s) of the served UE. Shall be provided for trigger "GROUP_ID_LIST_CHG". | GroupIdListChange | +| proSeCapab | array(ProSeCapability) | O | 1..N | Indicates whether the UE is capable of one or more of the the following 5G ProSe Capabilities: 5G ProSe Direct Discovery, 5G ProSe Direct Communication, Layer-2 and/or Layer 3 5G ProSe UE-to-Network Relay and Layer-2 and/or Layer 3 5G ProSe Remote UE, and when the "ProSe_Ph2" feature is supported, Layer-2 and/or Layer-3 5G ProSe UE-to-UE Relay and Layer-2 and/or Layer-3 5G ProSe End UE. | ProSe | +| confSnssais | array(ConfiguredSnssai) | C | 1..N | The Configured NSSAI for the serving PLMN, and optionally the mapped S-NSSAI value of home network corresponding to the configured S-NSSAI in the serving PLMN. It shall be provided for trigger "CONF_NSSAI_CH". (NOTE) | SliceAwareANDSP, NssaiChange | +| n3gNodeReSel | Non3gppAccess | O | 0..1 | A wrongly selected non-3gpp access node. It shall be provided in the roaming case when available at the NF service consumer and the "NON_3GPP_NODE_RESELECTION" trigger is reported within the "triggers" attribute. | SliceAwareANDSP | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates types of the satellite backhaul based on satellite types (when satellite backhaul is used) or non-satellite backhaul (when satellite backhaul is not used). It shall be provided for trigger "SAT_CATEGORY_CHG". | EnSatBackhaulCategoryChg | +| urspEnfReport | map(UrspEnforcementPduSession) | O | 1..N | Represents information about the enforced URSP rule(s) in one or more PDU sessions for the affected UE. | URSPEnforcement | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | The key of the map is a character string that represents an integer value (it may correspond with a PDU session identifier).

It shall be present when the notified policy control request trigger is "URSP_ENF_INFO". | | +| vpsUePolGuidance | map(UePolicyParameters) | O | 1..N | Contains the service parameter used to guide the VPLMN-specific URSP rule determination and may contain the subscription to VPLMN-specific URSP delivery outcome. The key of the map represents the AF request to guide VPLMN-specific URSP rules. This attribute only applies in roaming and when the V-PCF is the NF service consumer. | VPLMNSpecificURSP | +| lboRoamInfo | array(LboRoamingInformation) | O | 1..N | Contains LBO roaming information for a DNN and S-NSSAI combination(s).
This attribute only applies in roaming and when the AMF is the NF service consumer. | VPLMNSpecificURSP | +| accessTypes | array(AccessType) | C | 1..N | The Access Type where the served UE is camping. It shall be provided for trigger "ACCESS_TYPE_CH" when the access type changes or when the access type is initially reported as consequence of the provisioning of the trigger. | AccessChange | +| accessStatus | AccessStatus | C | 0..1 | It indicates whether the change is an addition or a removal of the Access Type. It shall be provided for trigger "ACCESS_TYPE_CH" when the Access Type changes and indicates whether the access type within the "accessTypes" attribute add a new one or removes the existing one. | AccessChange | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the features supported by the NF service consumer.
It shall be included by the target AMF in inter-AMF mobility scenarios for trigger "FEAT_RENEG". | | +| rangingSICapab | boolean | O | 0..1 | Indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not.
"true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE.
"false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE. | Ranging_SL | +| NOTE: The "mappedHomeSnssai" attribute within the ConfiguredSnssai data type may only be provided if the "NssaiChange" feature is supported. | | | | | | + +Editor's Note: The reference to CT1 specification for A2X related UE messages to be updated. + +#### 5.6.2.5 Type PolicyUpdate + +Table 5.6.2.5-1: Definition of type PolicyUpdate + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual UE policy association related to the notification.
(NOTE 2) | | +| uePolicy | UePolicy | O | 0..1 | The UE policy as determined by the H-PCF. | | +| n2Pc5Pol | N2InfoContent | O | 0..1 | The N2 PC5 policy for V2X communications as determined by the H-PCF. | V2X | +| n2Pc5PolA2x | N2InfoContent | O | 0..1 | The N2 PC5 policy for A2X communications as determined by the H-PCF. | A2X | +| n2Pc5ProSePol | N2InfoContent | O | 0..1 | The N2 PC5 policy for 5G ProSe as determined by the PCF. | ProSe | +| triggers | array(RequestTrigger) | O | 1..N | Request Triggers that the PCF subscribes. Only values "LOC_CH", "PRA_CH", "PLMN_CH", "CONF_NSSAI_CH", "SAT_CATEGORY_CHG", "ACCESS_TYPE_CH", "URSP_ENF_INFO", "LBO_INFO_CH" and "CON_STATE_CH" are permitted. | (NOTE 1) | +| pras | map(PresenceInfoRm) | C | 1..N | If the Trigger "PRA_CH" is provided or if that trigger was already set but the requested presence reporting areas need to be changed, the presence reporting area(s) for which reporting is requested shall be provided. The "prald" attribute within the PresenceInfoRm data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall not be supplied. The "prald" attribute within the PresenceInfo data type shall include the identifier of either a presence reporting area or a presence reporting area set. | PresenceInfo | +| andspDelInd | boolean | O | 0..1 | Indication that the updated ANDSP/WLANSP has been successfully delivered to the UE. "true" means that it has been successfully delivered. The default value is "false". | SliceAwareANDSP | +| delivReport | map(UePolicyNotification) | O | 1..N | Contains the delivery outcome of VPLMN-Specific URSP rules. It may be included if the V-PCF indicated the subscription to delivery outcome events as described in clause 4.2.2.2.3.2. The key of the map represents the AF request of the corresponding subscription, i.e. its value shall match the key that was previously provided by the V-PCF in the "vpsUePolGuidance" attribute. | VPLMNSpecificURSP | +| pduSessions | array(PduSessionInfo) | O | 1..N | Contains the list of the DNN and SNSSAI pairs for which LBO information is being requested. It may be provided when the "LBO_INFO_CH" request trigger is provided. | VPLMNSpecificURSP | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features.
It shall be included in the HTTP POST response when the NF service consumer provided the supported features in the HTTP POST request. | FeatureRenegotiation | +| n2Pc5RsppPol | N2InfoContent | O | 0..1 | The N2 PC5 policy for Ranging/SL as determined by the H-PCF. | Ranging_SL | +| NOTE 1: The "PLMN_CH", "CONF_NSSAI_CH", "LBO_INFO_CH", "ACCESS_TYPE_CH", "SAT_CATEGORY_CHG", "URSP_ENF_INFO" and "CON_STATE_CH" values in the "triggers" attribute apply under feature control as described in clause 4.2.3.2. | | | | | | +| NOTE 2: When the PolicyUpdate data type is used in a policy update notify service operation, either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual UE Policy Association resource related to the notification. | | | | | | + +#### 5.6.2.6 Type TerminationNotification + +**Table 5.6.2.6-1: Definition of type TerminationNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| resourceUri | Uri | M | 1 | The resource URI of the individual UE policy association related to the notification.
(NOTE) | | +| cause | PolicyAssociationReleaseCause | M | 1 | The cause why the PCF requests the termination of the policy association. | | +| NOTE: Either the complete resource URI included in the "resourceUri" attribute or the "apiSpecificResourceUriPart" component (see clause 5.1) of the resource URI included in the "resourceUri" attribute may be used by the NF service consumer (e.g. AMF) for the identification of the Individual UE Policy Association resource related to the termination notification. | | | | | | + +#### 5.6.2.7 Type UePolicyTransferFailureNotification + +**Table 5.6.2.7-1: UEPolicyTransferFailureNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| cause | UePolicyTransferFailureCause | M | 1 | Indicates the reason why the UE policy could not be transferred by the AMF.
When the feature "EnErrorHandlering" is supported, the "cause" attribute may include the enumeration values defined in the "N1N2MessTransferErrorReply" data type. | | +| retryAfter | Uinteger | O | 0..1 | The V-PCF may include this IE if the AMF requests to stop sending the N1N2MessageTransfer before timeout of the indicated time period. | EnErrorHandlering | +| ptis | array(Uinteger) | M | 1..N | Contains a list of PTI assigned by the H-PCF corresponding to the UE policy(s) which could not be transferred by the AMF. | | + +#### 5.6.2.8 Type UeRequestedValueRep + +Table 5.6.2.8-1: Definition of type UeRequestedValueRep + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| userLoc | UserLocation | C | 0..1 | The location of the served UE is camping shall be provided for trigger "LOC_CH". | | +| praStatuses | map(PresenceInfo) | C | 1..N | The UE presence statuses for tracking areas shall be provided for trigger "PRA_CH".
The "prald" attribute within the PresenceInfo data type shall also be the key of the map. | | +| plmnId | PlmnIdNid | C | 0..1 | The serving network identity (a PLMN or an SNPN) of the served UE shall be provided for trigger "PLMN_CH". | PlmnChange | +| connectState | CmState | C | 0..1 | The connectivity state of the served UE. It shall be provided for trigger "CON_STATE_CH". | ConnectivityStateChange | +| satBackhaulCategory | SatelliteBackhaulCategory | C | 0..1 | Indicates types of the satellite backhaul based on satellite types (when satellite backhaul is used) or non-satellite backhaul (when satellite backhaul is not used). It shall be provided for trigger "SAT_CATEGORY_CHG". | EnSatBackhaulCategoryChg | +| urspEnfReport | map(UrspEnforcementPduSession) | C | 1..N | Represents information about the enforced URSP rule(s) in one or more PDU sessions for the affected UE.

The key of the map is a character string that represents an integer value (it may correspond with a PDU session identifier).

It shall be present when the notified policy control request trigger is "URSP_ENF_INFO". | URSPEnforcement | +| lboRoamInfo | array(LboRoamingInformation) | C | 1..N | Contains a list of LBO roaming information for a DNN and S-NSSAI combination. It shall be provided for trigger "LBO_INFO_CH". | VPLMNSpecific URSP | +| confSnssais | array(ConfiguredSnssai) | C | 1..N | The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home network corresponding to the configured S-NSSAI in the serving PLMN.
It shall be provided for trigger "CONF_NSSAI_CH". | NssaiChange | +| accessTypes | array(AccessType) | C | 1..N | The Access Type(s) where the served UE is camping. Shall be provided for trigger "ACCESS_TYPE_CH". | AccessChange | + +#### 5.6.2.9 Type UePolicyParameters + +Table 5.6.2.9-1: Definition of type UePolicyParameters + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| urspGuidance | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to guide the VPLMN-specific URSP. | | +| deliveryEvents | array(Event) | O | 1..N | Identifies the AF subscribed event(s) related to AF provisioned guidance for VPLMN-specific URSP rules.
(NOTE) | | + +NOTE: In this release of the specification, only the "SUCCESS\_UE\_POL\_DEL\_SP" and "UNSUCCESS\_UE\_POL\_DEL\_SP" events apply. + +#### 5.6.2.10 Type LboRoamingInformation + +Table 5.6.2.10-1: Definition of type LboRoamingInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| lboRoamAllowed | boolean | O | 0..1 | Indicates whether local breakout for the DNN and S-NSSAI is allowed when roaming.
true: allowed
false: not allowed.
If the attribute is absent it means not allowed. | | +| dnn | Dnn | M | 1 | Data Network Name with Network Identifier only. | | +| snssai | Snssai | M | 1 | S-NSSAI. | | + +#### 5.6.2.11 Type UrspEnforcementPduSession + +**Table 5.6.2.11-1: Definition of type UrspEnforcementPduSession** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| urspEnfInfo | UrspEnforcementInfo | M | 1 | Represents UE provided information about the enforced URSP rule(s) in one PDU session. | | +| sscMode | SscMode | O | 0..1 | SSC Mode of the PDU session.

It shall be provided when URSP rule enforcement information is provided for the first time. | | +| ueReqDnn | Dnn | O | 0..1 | UE requested DNN.

It shall be provided when URSP rule enforcement information is provided for the first time, if available and different from the selected DNN. | | +| redundantPduSessionInfo | RedundantPduSessionInformation | O | 0..1 | RSN and PDU session pair ID of the redundant PDU session.

It may be provided when URSP rule enforcement information is provided for the first time | | +| accessType | AccessType | O | 0..1 | Includes the access type of the PDU session. It shall be provided if changed compared to the latest provided value. | | +| ratType | RatType | O | 0..1 | RAT type of the PDU session. It shall be provided if changed compared to the latest provided value. | | +| pduSessionInfo | PduSessionInformation | O | 0..1 | Contains PDU session identification information: S-NSSAI, selected DNN, UE address.
It shall be provided when URSP rule enforcement information is provided for the first time. | | + +#### 5.6.2.12 Type UePolicyNotification + +**Table 5.6.2.12-1: Definition of type UePolicyNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventNotifs | array(PcEventNotification) | M | 1..N | Represents the events to be reported according to the subscription to delivery outcome events as described in clause 4.2.2.2.3.2.
(NOTE) | | +| NOTE: In this release of the specification, only the "SUCCESS_UE_POL_DEL_SP" and "UNSUCCESS_UE_POL_DEL_SP" events apply. | | | | | | + +### 5.6.3 Simple data types and enumerations + +#### 5.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 5.6.3.2 Simple data types + +The simple data types defined in table 5.6.3.2-1 shall be supported. + +**Table 5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UePolicy | Bytes | "MANAGE UE POLICY COMMAND" message content, as defined in Table D.5.1.1.1 of 3GPP TS 24.501 [15] | | +| UePolicyDeliveryResult | Bytes | "MANAGE UE POLICY COMPLETE" message content, as defined in Table D.5.2.1.1 of 3GPP TS 24.501 [15], or "MANAGE UE POLICY COMMAND REJECT" message content, as defined in Table D.5.3.1.1 of 3GPP TS 24.501 [15] | | +| UePolicyRequest | Bytes | "UE STATE INDICATION" message content, as defined in Table D.5.4.1.1 of 3GPP TS 24.501 [15] or "UE POLICY PROVISIONING REQUEST" message content, as defined in clause 7.2.1.1 of 3GPP TS 24.587 [24]. | | + +#### 5.6.3.3 Enumeration: RequestTrigger + +The enumeration RequestTrigger represents the possible Policy Control Request Triggers.. It shall comply with the provisions defined in table 5.6.3.3-1. + +Table 5.6.3.3-1: Enumeration RequestTrigger + +| Enumeration value | Description | Applicability | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| LOC_CH | Location change (tracking area): the tracking area of the UE has changed. (NOTE) | | +| PRA_CH | Change of UE presence in PRA: the AMF reports the current presence status of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the Presence Reporting Area. (NOTE) | | +| UE_POLICY | A "MANAGE UE POLICY COMPLETE" message, a "MANAGE UE POLICY COMMAND REJECT" message, as defined in Annex D.5 of 3GPP TS 24.501 [15] has been received by the V-PCF and is being forwarded to the H-PCF, or has been received by a PCF for a PDU session and is being forwarded to the (V-)PCF (and then from the V-PCF to the H-PCF) when the "EpsUrsp" feature is supported. A Namf_Communication_N1N2MessageTransfer failure response as defined in clause 5.2.2.3.1.2 of 3GPP TS 29.518 [14], an N1N2 Transfer Failure Notification as defined in clause 5.2.2.3.2 of 3GPP TS 29.518 [14], a UE Policy transfer failure is notifying to the H-PCF, or a UE Policy transfer failure is notifying to the (V-)PCF when the "EpsUrsp" feature is supported. When the "ProSe" feature is supported it indicates that a "UE POLICY PROVISIONING REQUEST" message, as defined in clause 10.4 of 3GPP TS 24.554 [28] has been received by the V-PCF and is being forwarded to the H-PCF. When the "V2X" feature is supported it indicates that a "UE POLICY PROVISIONING REQUEST" message, as defined in clause 7.2 of 3GPP TS 24.587 [24] has been received by the V-PCF and is being forwarded to the H-PCF. When the "A2X" feature is supported it indicates that a "UE POLICY PROVISIONING REQUEST" message, as defined in 3GPP TS 24.577 [32] has been received by the V-PCF and is being forwarded to the H-PCF. When the "Ranging_SL" feature is supported it indicates that a "UE POLICY PROVISIONING REQUEST" message, as defined in 3GPP TS 24.514 [42] has been received by the V-PCF and is being forwarded to the H-PCF. This event does not require a subscription and is only applicable for the V-PCF as NF service consumer and the H-PCF as NF service producer or a PCF for a PDU session as NF service consumer and the (V-)PCF as NF service producer when the "EpsUrsp" feature is supported. | | +| PLMN_CH | PLMN change: the serving network (a PLMN or an SNPN) of UE has changed. (NOTE) | PlmnChange | +| CON_STATE_CH | Connectivity state change: the connectivity state of UE has changed. (NOTE) | ConnectivityStateChange | +| GROUP_ID_LIST_CHG | UE Internal Group Identifier(s) has changed: the AMF reports that UDM provided list of group Ids has changed. This policy control request trigger does not require a subscription. | GroupIdListChange | +| UE_CAP_CH | UE Capabilities change: the UE provided 5G ProSe capabilities have changed. This policy control request trigger does not require subscription. | ProSe | +| SAT_CATEGORY_CHG | Satellite Backhaul Category change: the AMF has detected a change between different satellite backhaul category, or a change between satellite and non-satellite backhaul. (NOTE) | EnSatBackhaulCategoryChg | +| CONF_NSSAI_CH | Configured NSSAI change: the configured NSSAI has changed. This policy control request trigger only applies in roaming scenarios when the NF service consumer is the AMF. (NOTE) | NssaiChange | +| NON_3GPP_NODE_RESELECTION | Wrong TNGF or N3IWF: the UE has connected to a wrong non-3GPP access node that does not match its subscribed S-NSSAI(s). This policy control request trigger does not require a subscription. | SliceAwareANDSP | +| FEAT_RENEG | The target AMF determines feature re-negotiation is required. This policy control request trigger does not require subscription. | FeatureRenegotiation | +| URSP_ENF_INFO | The V-PCF has received URSP rule enforcement information for one or more URSP rules. This trigger only applies in roaming | URSPEnforcement | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | scenarios and to the V-PCF.
(NOTE) | | +| LBO_INFO_CH | LBO information change. The AMF reports LBO roaming allowed or not allowed for the requested DNN(s) and S-NSSAI(s). This policy control request trigger only applies in roaming scenarios when the NF service consumer is the AMF.
(NOTE) | VPLMNSpecificURSP | +| ACCESS_TYPE_CH | Access Type change. The registered access type has changed, an access type is added or an access type is removed | AccessChange | +| NOTE: The report of this trigger includes reporting the current value at the time the trigger is provisioned during the update or update notification of the policy association. | | | + +Editor's Note: The reference to CT1 specification for A2X related UE messages to be updated. + +#### 5.6.3.4 Enumeration: PolicyAssociationReleaseCause + +The enumeration PolicyAssociationReleaseCause represents the cause why the PCF requests the termination of the policy association. It shall comply with the provisions defined in table 5.6.3.4-1. + +**Table 5.6.3.4-1: Enumeration PolicyAssociationReleaseCause** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| UNSPECIFIED | This value is used for unspecified reasons. | | +| UE_SUBSCRIPTION | This value is used to indicate that the policy association needs to be terminated because the subscription of UE has changed (e.g. was removed). | | +| INSUFFICIENT_RES | This value is used to indicate that the server is overloaded and needs to abort the policy association. | | + +#### 5.6.3.5 Enumeration: Pc5Capability + +The enumeration Pc5Capability indicates the specific PC5 RAT(s) which the UE supports for V2X communication and/or A2X communication over PC5 reference point. It shall comply with the provisions defined in table 5.6.3.5-1. + +**Table 5.6.3.5-1: Enumeration Pc5Capability** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| LTE_PC5 | This value is used to indicate that UE supports PC5 LTE RAT for V2X communication and/or A2X communication over PC5 reference point. | | +| NR_PC5 | This value is used to indicate that UE supports PC5 NR RAT for V2X communication and/or A2X communication over PC5 reference point. | | +| LTE_NR_PC5 | This value is used to indicate that UE supports both PC5 LTE and NR RAT for V2X communication and/or A2X communication over PC5 reference point. | | + +#### 5.6.3.6 Enumeration: ProSeCapability + +This enumeration indicates the 5G ProSe capabilities. It shall comply with the provisions defined in table 5.6.3.6-1. + +**Table 5.6.3.6-1: Enumeration ProSeCapability** + +| Enumeration value | Description | Applicability | +|--------------------|--------------------------------------------------------------------------------------------------|---------------| +| PROSE_DD | This value is used to indicate that 5G ProSe Direct Discovery is supported by the UE. | | +| PROSE_DC | This value is used to indicate that 5G ProSe Direct Communication is supported by the UE. | | +| PROSE_L2_U2N_RELAY | This value is used to indicate that Layer-2 5G ProSe UE-to-Network Relay is supported by the UE. | | +| PROSE_L3_U2N_RELAY | This value is used to indicate that Layer-3 5G ProSe UE-to-Network Relay is supported by the UE. | | +| PROSE_L2_REMOTE_UE | This value is used to indicate that Layer-2 5G ProSe Remote UE is supported by the UE. | | +| PROSE_L3_REMOTE_UE | This value is used to indicate that Layer-3 5G ProSe Remote UE is supported by the UE. | | +| PROSE_L2_U2U_RELAY | This value is used to indicate that Layer-2 5G ProSe UE-to-UE Relay is supported by the UE. | ProSe_Ph2 | +| PROSE_L3_U2U_RELAY | This value is used to indicate that Layer-3 5G ProSe UE-to-UE Relay is supported by the UE. | ProSe_Ph2 | +| PROSE_L2_END_UE | This value is used to indicate that Layer-2 5G ProSe End UE is supported by the UE. | ProSe_Ph2 | +| PROSE_L3_END_UE | This value is used to indicate that Layer-3 5G ProSe End UE is supported by the UE. | ProSe_Ph2 | + +#### 5.6.3.7 Enumeration: Non3gppAccess + +The enumeration Non3gppAccess represents the possible Non-3gpp access nodes. It shall comply with the provisions defined in table 5.6.3.7-1. + +**Table 5.6.3.7-1: Non3gppAccess** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------|---------------| +| N3IWF | Non-3gpp Interworking Function | | +| TNGF | Trusted Non-3GPP Gateway Function | | + +#### 5.6.3.8 Enumeration: AccessStatus + +The enumeration AccessStatus represents whether the Access change is an addition or a removal. It shall comply with the provisions defined in table 5.6.3.8-1. + +**Table 5.6.3.8-1: Enumeration AccessStatus** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------|---------------| +| ADDITION | The type of change is an addition, i.e. the UE has Registered with new Access type. | | +| REMOVAL | The type of change is a removal, i.e. the UE has De-Registered with the existing Access type. | | + +#### 5.6.3.9 Enumeration: N1N2MessTransferErrorReply + +The enumeration N1N2MessTransferErrorReply represents the possible errors the V-PCF may send to the H-PCF when the V-PCF receives from the AMF an error reply to the N1N2MessageTransfer request. It shall comply with the provisions defined in table 5.6.3.8-1. + +**Table 5.6.3.8-1: N1N2MessTransferErrorReply** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------|---------------| +| UE_NOT_REACHABLE | The UE is not reachable for paging. | | +| UNSPECIFIED | Unspecified error. | | + +### 5.6.4 Data types describing alternative data types or combinations of data types + +#### 5.6.4.1 Type: UePolicyTransferFailureCause + +**Table 5.6.4.1-1: Definition of type UePolicyTransferFailureCause as a list of non-exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|----------------------------|-------------|---------------------------------------------------------------------------------------------|---------------| +| N1N2MessageTransferCause | 0..1 | The failure causes notified by the AMF within the N1 Message Transfer Failure notification. | | +| N1N2MessTransferErrorReply | 0..1 | Error reply the AMF may indicate within the response to N1N2MessageTransfer request. | | + +## 5.7 Error handling + +### 5.7.1 General + +For the Npcf\_UEPolicyControl API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [5] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [5]. + +In addition, the requirements in the following clauses are applicable for the Npcf\_UEPolicyControl API. + +### 5.7.2 Protocol Errors + +No specific protocol errors for the Npcf\_UEPolicyControl API are specified. + +### 5.7.3 Application Errors + +The application errors defined for the Npcf\_UEPolicyControl service are listed in Table 5.7.3-1 and Table 5.7.3-2. + +**Table 5.7.3-1: Application errors when PCF acts as a server** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USER_UNKNOWN | 400 Bad Request | The HTTP request is rejected because the end user specified in the request is unknown to the PCF. | +| ERROR_REQUEST_PARAMETERS | 400 Bad Request | The HTTP request is rejected because the set of information needed by the PCF for UE Policy selection is incomplete or erroneous or not available for the decision to be made. | +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the PCF receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. | +| POLICY_ASSOCIATION_NOT_FOUND | 404 Not Found | The HTTP request is rejected because no UE policy association corresponding to the request exists in the PCF. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +**Table 5.7.3-2: Application errors when NF service consumer acts as a server to receive a notification** + +| Application Error | HTTP status code | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PENDING_TRANSACTION | 400 Bad Request | This error shall be used when the PendingTransaction feature is supported and the NF service consumer receives an incoming request on a policy association while it has an ongoing transaction on the same policy association and cannot handle the request as described in clause 9.2 of 3GPP TS 29.513 [7]. (NOTE 1) | +| NOTE 1: This application error is included in the response to the Policy Update Notification HTTP POST request. | | | +| NOTE 2: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Npcf\_UEPolicyControl API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [5]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PendingTransaction | This feature indicates support for the race condition handling as defined in 3GPP TS 29.513 [7]. | +| 2 | PlmnChange | This feature indicates support for the change of PLMN trigger handling. | +| 3 | ConnectivityStateChange | This feature indicates support for the UE connectivity state change trigger handling. | +| 4 | V2X | This feature indicates support for the UE policy provisioning and N2 information provisioning for V2X communications. | +| 5 | GroupIdListChange | This feature indicates the support for the notification of changes in the list of internal group identifiers. | +| 6 | ImmediateReport | This feature indicates the support of the current applicable values report corresponding to the policy control request triggers for policy update notification. | +| 7 | ErrorResponse | This feature indicates support for "404 Not Found" error response code for policy update notification between AMF and (V-)PCF. | +| 8 | ES3XX | Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [5] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. | +| 9 | ProSe | This feature indicates support of UE policy and N2 information provisioning for 5G ProSe. | +| 10 | FeatureRenegotiation | This feature indicates the support of feature renegotiation during the update of a policy association triggered by UE mobility with AMF change. | +| 11 | SliceAwareANDSP | This feature indicates the support of ANDSP/WLANSP policies that consider the slices supported by the UE. | +| 12 | EpsUrsp | This feature indicates support of URSP provisioning in EPS and is only applicable in the case of 5GC and EPC interworking. | +| 13 | EnSatBackhaulCategoryChg | This feature indicates the support of notification of a change between different satellite backhaul categories, or dynamic satellite backhaul categories, or between satellite backhaul and non-satellite backhaul. | +| 14 | UECapabilityIndication | This feature indicates the support of the provisioning by the H-PCF to the V-PCF of the UE Capability for UE Policy, when the UE Capability is not received from the UE and the information is available and reliable in the UDR. | +| 15 | A2X | This feature indicates support of A2X communications. | +| 16 | NssaiChange | This feature indicates support for the change of Configured NSSAI trigger handling. | +| 17 | ProSe_Ph2 | This feature indicates the support of UE policy and N2 information provisioning for 5G ProSe UE-to-UE Relay function.

This feature requires that the ProSe feature is also supported. | +| 18 | PresenceInfo | The feature indicates the support of policy update to remove the existing presence reporting areas entry. | +| 19 | URSPEnforcement | This feature indicates the support of the report of URSP rule enforcement information by the V-PCF to the H-PCF. | +| 20 | VPLMNSpecificURSP | This feature indicates the support of AF guidance on VPLMN-specific URSP rules. It requires the support of NssaiChange feature. | +| 21 | Ranging_SL | This feature indicates the support for the UE policy provisioning and N2 information provisioning for Ranging and sidelink positioning. | +| 22 | AccessChange | This feature indicates the support of the report of access type changes, the addition of an access type or the removal of an existing access type. | +| 23 | EnErrorHandler | This feature indicates the support of the indication from the V-PCF to the H-PCF of the received AMF error response to the UE Policy Delivery transfer request. | + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [19] and 3GPP TS 29.500 [5], the access to the Npcf\_UEPolicyControl API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [20]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Npcf\_UEPolicyControl API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF service consumer used for discovering the Npcf\_UEPolicyControl service. + +The Npcf\_UEPolicyControl API defines a single scope "npcf-ue-policy-control" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +The present Annex contains an OpenAPI [10] specification of HTTP messages and content bodies used by the Npcf\_UEPolicyControl API. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [22] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +## A.2 Npcf\_UEPolicyControl API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Npcf_UEPolicyControl + description: | + UE Policy Control Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.525 V18.4.0; 5G System; UE Policy Control Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.525/' + +servers: + - url: '{apiRoot}/npcf-ue-policy-control/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-ue-policy-control + +paths: + /policies: + post: + operationId: CreateIndividualUEPolicyAssociation + summary: Create individual UE policy association. + tags: + - UE Policy Associations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationRequest' + responses: + '201': + description: Created + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/PolicyAssociation' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/npcf-ue-policy-control/v1/policies/{polAssoId}' + required: true + schema: + type: string +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + policyUpdateNotification: + '{$request.body#/notificationUri}/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyUpdate' +responses: +'200': + description: > + OK. The current applicable values corresponding to the policy control request + trigger is reported + content: + application/json: + schema: + $ref: '#/components/schemas/UeRequestedValueRep' +'204': + description: No Content, Notification was successful +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + +``` + +``` + + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +policyAssociationTerminationRequestNotification: + '{ $request.body#/notificationUri }/terminate': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policies/{polAssoId}: + get: + operationId: ReadIndividualUEPolicyAssociation + summary: Read individual UE policy association. + tags: + - Individual UE Policy Association (Document) + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociation' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + operationId: DeleteIndividualUEPolicyAssociation + summary: Delete individual UE policy association. + tags: + - Individual UE Policy Association (Document) + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policies/{polAssoId}/update: + post: + operationId: ReportObservedEventTriggersForIndividualUEPolicyAssociation + summary: > + Report observed event triggers and possibly obtain updated policies for an individual UE + policy association. + tags: + - Individual UE Policy Association (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyAssociationUpdateRequest' + parameters: + - name: polAssoId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Updated policies are returned + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyUpdate' + '307': +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcfe-ue-policy-control: Access to the Npcf_UEPolicyControl API + +schemas: + PolicyAssociation: + description: > + Contains the description of a policy association that is returned by the PCF when a policy + Association is created, updated, or read. + type: object + properties: + request: + $ref: '#/components/schemas/PolicyAssociationRequest' + uePolicy: + $ref: '#/components/schemas/UePolicy' + n2Pc5Pol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5PolA2x: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5ProSePol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + description: > + Request Triggers that the PCF subscribes. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' + minProperties: 1 + description: > + Contains the presence reporting area(s) for which reporting was requested. + The praId attribute within the PresenceInfoRm data type is the key of the map. + andspDelInd: + type: boolean + description: > + Indication that the updated ANDSP/WLANSP has been successfully delivered to the UE. + andspInd: + description: > + Indication of UE support of ANDSP. When set to true, it indicates the UE supports ANDSP, + when set to false it indicates the UE does not support ANDSP. + +``` + +``` +type: boolean +pduSessions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + description: Combination of DNN and S-NSSAIs for which LBO information is requested. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' +required: +- suppFeat +``` + +### **PolicyAssociationRequest:** + +``` +description: > + Represents information that the NF service consumer provides when requesting the creation of + a policy association. +type: object +properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + altNotifIpv4Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + description: Alternate or backup IPv4 Address(es) where to send Notifications. + altNotifIpv6Addrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + description: Alternate or backup IPv6 Address(es) where to send Notifications. + altNotifFqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + description: Alternate or backup FQDN(s) where to send Notifications. + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + groupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + hPcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + uePolReq: + $ref: '#/components/schemas/UePolicyRequest' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pc5Capab: + $ref: '#/components/schemas/Pc5Capability' + pc5CapA2x: + $ref: '#/components/schemas/Pc5Capability' + proSeCapab: + type: array + items: +``` + +``` +$ref: '#/components/schemas/ProSeCapability' +minItems: 1 +confSnssais: +type: array +items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' +minItems: 1 +description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. +n3gNodeReSel: +$ref: '#/components/schemas/Non3gppAccess' +satBackhaulCategory: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +5gsToEpsMob: +type: boolean +description: > + It indicates the UE Policy Association is triggered by a 5GS to EPS mobility + scenario. +vpsUePolGuidance: +type: object +additionalProperties: +$ref: '#/components/schemas/UePolicyParameters' +minProperties: 1 +description: > + Contains the service parameter used to guide the VPLMN-specific URSP and may contain + the subscription to VPLMN-specific URSP delivery outcome. + The key of the map represents the AF request to guide VPLMN-specific URSP rules. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. +lboRoamInfo: +type: array +items: + $ref: '#/components/schemas/LboRoamingInformation' +minItems: 1 +description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + This attribute only applies in roaming and when the AMF is the NF service consumer. +suppFeat: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +rangingSlCapab: +type: boolean +description: > + It indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not. + "true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE. + "false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE. + Default value when omitted is "false". +required: +- notificationUri +- suppFeat +- supi + +PolicyAssociationUpdateRequest: +description: > + Represents Information that the NF service consumer provides when requesting the update of + a policy association. +type: object +properties: +notificationUri: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +altNotifIpv4Addrs: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +minItems: 1 +description: Alternate or backup IPv4 Address(es) where to send Notifications. +altNotifIpv6Addrs: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +minItems: 1 +description: Alternate or backup IPv6 Address(es) where to send Notifications. +altNotifFqdns: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +minItems: 1 +description: Alternate or backup FQDN(s) where to send Notifications. +triggers: +``` + +``` +type: array +items: + $ref: '#/components/schemas/RequestTrigger' +minItems: 1 +description: Request Triggers that the NF service consumer observes. +praStatuses: +type: object +additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' +description: > + Contains the UE presence status for tracking area for which changes of the UE presence + occurred. The praId attribute within the PresenceInfo data type is the key of the map. +minProperties: 1 +userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +uePolDelResult: + $ref: '#/components/schemas/UePolicyDeliveryResult' +uePolTransFailNotif: + $ref: '#/components/schemas/UePolicyTransferFailureNotification' +uePolReq: + $ref: '#/components/schemas/UePolicyRequest' +guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +servingNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +connectState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' +groupIds: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +minItems: 1 +proSeCapab: +type: array +items: + $ref: '#/components/schemas/ProSeCapability' +minItems: 1 +confSnssais: +type: array +items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' +minItems: 1 +description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. +satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' +urspEnfRep: +type: object +additionalProperties: + $ref: '#/components/schemas/UrspEnforcementPduSession' +description: > + Contains information about the enforced URSP rule(s) in one or more PDU sessions. + The key of the map is a character string that represents an integer value. +minProperties: 1 +vpsUePolGuidance: +type: object +additionalProperties: + $ref: '#/components/schemas/UePolicyParameters' +minProperties: 1 +description: > + Contains the service parameter used to guide the VPLMN-specific URSP and may contain + the subscription to VPLMN-specific URSP delivery outcome. + The key of the map represents the AF request to guide VPLMN-specific URSP rules. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. +lboRoamInfo: +type: array +items: + $ref: '#/components/schemas/LboRoamingInformation' +minItems: 1 +description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + This attribute only applies in roaming and when the AMF is the NF service consumer. +accessTypes: +type: array +items: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + accessStatus: + $ref: '#/components/schemas/AccessStatus' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + rangingSlCapab: + type: boolean + description: > + It indicates whether the PC5 Capability for Ranging/SL is supported by the UE or not. + "true": Indicates that the PC5 Capability for Ranging/SL is supported by the UE. + "false": Indicates that the PC5 Capability for Ranging/SL is not supported by the UE. +PolicyUpdate: + description: > + Represents updated policies that the PCF provides in a notification or in the reply to an + Update Request. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + uePolicy: + $ref: '#/components/schemas/UePolicy' + n2Pc5Pol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5PolA2x: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + n2Pc5ProSePol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + triggers: + type: array + items: + $ref: '#/components/schemas/RequestTrigger' + minItems: 1 + nullable: true + description: > + Request Triggers that the PCF subscribes. + pras: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + description: > + Contains the presence reporting area(s) for which reporting was requested. + The praId attribute within the PresenceInfo data type is the key of the map. + minProperties: 1 + nullable: true + andspDelInd: + type: boolean + description: > + Indication that the updated ANDSP/WLANSP has been successfully delivered to the UE. + delivReport: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicyNotification' + minProperties: 1 + description: > + Contains the delivery outcome of the VPLMN-specific URSP. + The key of the map represents the AF request of the corresponding subscription, i.e. its + value shall match the key that was previously provided by the V-PCF in the + vpsUePolGuidance attribute. + This attribute only applies in roaming and when the V-PCF is the NF service consumer. + pduSessions: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionInfo' + minItems: 1 + description: > + Combination of DNN and S-NSSAIs for which LBO information is requested. + nullable: true + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + n2Pc5RsppPol: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InfoContent' + required: + - resourceUri + +TerminationNotification: + description: > + Represents a request to terminate a policy association that the PCF provides in a +``` + +``` + notification. + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + cause: + $ref: '#/components/schemas/PolicyAssociationReleaseCause' + required: + - resourceUri + - cause + +UePolicyTransferFailureNotification: + description: > + Represents information on the failure of a UE policy transfer to the UE because the UE is not + reachable. + type: object + properties: + cause: + $ref: '#/components/schemas/UePolicyTransferFailureCause' + retryAfter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ptis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + required: + - cause + - ptis + +UeRequestedValueRep: + description: > + Contains the current applicable values corresponding to the policy control request triggers. + type: object + properties: + userLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + praStatuses: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains the UE presence statuses for tracking areas. The praId attribute within the + PresenceInfo data type is the key of the map. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + connectState: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + confSnssais: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/ConfiguredSnssai' + minItems: 1 + description: > + The Configured NSSAI for the serving PLMN, and the mapped S-NSSAI value of home + network corresponding to the configured S-NSSAI in the serving PLMN. + satBackhaulCategory: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SatelliteBackhaulCategory' + urspEnfRep: + type: object + additionalProperties: + $ref: '#/components/schemas/UrspEnforcementPduSession' + description: > + Contains information about the enforced URSP rule(s) in one or more PDU sessions. + The key of the map is a character string that represents an integer value. + minProperties: 1 + lboRoamInfo: + type: array + items: + $ref: '#/components/schemas/LboRoamingInformation' + minItems: 1 + description: > + Contains LBO roaming information for DNN and S-NSSAI combination(s). + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +``` + +``` + minItems: 1 + UePolicyParameters: + description: > + Contains the service parameters used to guide the VPLMN-specific URSP rule determination. + type: object + properties: + urspGuidance: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + description: > + Contains the service parameter used to guide the VPLMN-specific URSP. + deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + description: > + AF subscribed event(s) notifications related to AF provisioned guidance + for VPLMN-specific URSP rules. + + LboRoamingInformation: + description: > + Contains LBO roaming information for a DNN and S-NSSAI. + type: object + properties: + lboRoamAllowed: + type: boolean + description: > + Indicates whether LBO for the DNN and S-NSSAI is allowed when roaming. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - dnn + - snssai + + UrspEnforcementPduSession: + description: > + Represents URSP rule enforcement information for a PDU session. + type: object + required: + - urspEnfInfo + properties: + urspEnfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UrspEnforcementInfo' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode' + ueReqDnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + redundantPduSessionInfo: + $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/RedundantPduSessionInformation' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + pduSessInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PduSessionInformation' + + UePolicyNotification: + description: > + Contains the delivery outcome of VPLMN-specific URSP rules. + type: object + properties: + eventNotifs: + type: array + items: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/PcEventNotification' + minItems: 1 + description: > + Represents the events to be reported according to the subscription to notifications + of VPLMN-specific URSP delivery outcome events. + + UePolicy: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' +``` + +UePolicyDeliveryResult: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Bytes' + +UePolicyRequest: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Bytes' + +### RequestTrigger: + +#### anyOf: + +- type: string + +#### enum: + +- LOC\_CH +- PRA\_CH +- UE\_POLICY +- PLMN\_CH +- CON\_STATE\_CH +- GROUP\_ID\_LIST\_CHG +- UE\_CAP\_CH +- SAT\_CATEGORY\_CHG +- NON\_3GPP\_NODE\_RESELECTION +- CONF\_NSSAI\_CH +- LBO\_INFO\_CH +- FEAT\_RENEG +- URSP\_ENF\_INFO +- ACCESS\_TYPE\_CH + +- type: string + +##### description: > + +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. + +##### description: | + +Represents the possible request triggers. + +Possible values are: + +- LOC\_CH: Location change (tracking area). The tracking area of the UE has changed. +- PRA\_CH: Change of UE presence in PRA. The AMF reports the current presence status of the UE in a Presence Reporting Area, and notifies that the UE enters/leaves the Presence Reporting Area. +- UE\_POLICY: A MANAGE UE POLICY COMPLETE message or a MANAGE UE POLICY COMMAND REJECT message, as defined in Annex D.5 of 3GPP TS 24.501 or a "UE POLICY PROVISIONING REQUEST" message, as defined in clause 7.2.1.1 of 3GPP TS 24.587, has been received by the AMF and is being forwarded. +- PLMN\_CH: PLMN change. the serving PLMN of UE has changed. +- CON\_STATE\_CH: Connectivity state change: the connectivity state of UE has changed. +- GROUP\_ID\_LIST\_CHG: UE Internal Group Identifier(s) has changed. This policy control request trigger does not require a subscription. +- UE\_CAP\_CH: UE Capabilities change: the UE provided 5G ProSe capabilities have changed. This policy control request trigger does not require subscription. +- SAT\_CATEGORY\_CHG: Indicates that the AMF has detected a change between different satellite category, or non-satellite backhaul. +- NON\_3GPP\_NODE\_RESELECTION: The UE has connected to a wrong non-3GPP access node that does not match its subscribed S-NSSAI(s). This policy control request trigger does not require a subscription. +- CONF\_NSSAI\_CH: Configured NSSAI change. Indicates that the configured NSSAI has changed. +- LBO\_INFO\_CH: LBO information change. The AMF reports LBO roaming allowed or not allowed for the requested DNN(s) and S-NSSAI(s). This policy control request trigger only applies in roaming scenarios when the NF service consumer is the AMF. +- FEAT\_RENEG: The NF service consumer notifies that the target AMF is requesting feature re-negotiation. +- URSP\_ENF\_INFO: The V-PCF has received URSP rule enforcement information for one or more + +### URSP + +rules. This trigger applies in roaming scenarios and to the V-PCF. + +- ACCESS\_TYPE\_CH: Access Type change. The registered access type has changed, an access type is added or an access type is removed. + +### PolicyAssociationReleaseCause: + +#### anyOf: + +- type: string + +#### enum: + +- UNSPECIFIED +- UE\_SUBSCRIPTION +- INSUFFICIENT\_RES + +- type: string + +##### description: > + +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. + +##### description: | + +Represents the cause why the PCF requests the policy association termination. + +Possible values are: + +- UNSPECIFIED: This value is used for unspecified reasons. +- UE\_SUBSCRIPTION: This value is used to indicate that the policy association needs to be terminated because the subscription of UE has changed (e.g. was removed). +- INSUFFICIENT\_RES: This value is used to indicate that the server is overloaded and needs to abort the policy association. + +### Pc5Capability: + +anyOf: + +- type: string + +enum: + +- LTE\_PC5 +- NR\_PC5 +- LTE\_NR\_PC5 + +- type: string + +description: > + +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. + +description: | + +Represents the specific PC5 RAT(s) which the UE supports for V2X or A2X communications over PC5 reference point. + +Possible values are: + +- LTE\_PC5: This value is used to indicate that UE supports PC5 LTE RAT for V2X communications or A2X communications over the PC5 reference point + +over the PC5 reference point. + +- NR\_PC5: This value is used to indicate that UE supports PC5 NR RAT for V2X communications or A2X communications over the PC5 reference point. +- LTE\_NR\_PC5: This value is used to indicate that UE supports both PC5 LTE and NR RAT for V2X communications or A2X communications over the PC5 reference point. + +### ProSeCapability: + +anyOf: + +- type: string + +enum: + +- PROSE\_DD +- PROSE\_DC +- PROSE\_L2\_U2N\_RELAY +- PROSE\_L3\_U2N\_RELAY +- PROSE\_L2\_REMOTE\_UE +- PROSE\_L3\_REMOTE\_UE +- PROSE\_L2\_U2U\_RELAY +- PROSE\_L3\_U2U\_RELAY +- PROSE\_L2\_END\_UE +- PROSE\_L3\_END\_UE + +- type: string + +description: > + +This string provides forward-compatibility with future extensions to the enumeration but is not used to encode the content defined in the present version of this API. + +description: | + +Represents the 5G ProSe capabilities. + +Possible values are: + +- PROSE\_DD: This value is used to indicate that 5G ProSe Direct Discovery is supported by the UE. +- PROSE\_DC: This value is used to indicate that 5G ProSe Direct Communication is supported by the UE. +- PROSE\_L2\_U2N\_RELAY: This value is used to indicate that Layer-2 5G ProSe UE-to-Network Relay is supported by the UE. +- PROSE\_L3\_U2N\_RELAY: This value is used to indicate that Layer-3 5G ProSe UE-to-Network Relay is supported by the UE. +- PROSE\_L2\_REMOTE\_UE: This value is used to indicate that Layer-2 5G ProSe Remote UE is supported by the UE. +- PROSE\_L3\_REMOTE\_UE: This value is used to indicate that Layer-3 5G ProSe Remote UE is supported by the UE. +- PROSE\_L2\_U2U\_RELAY: This value is used to indicate that Layer-2 5G ProSe UE-to-UE Relay is supported by the UE. +- PROSE\_L3\_U2U\_RELAY: This value is used to indicate that Layer-3 5G ProSe UE-to-UE Relay is supported by the UE. +- PROSE\_L2\_END\_UE: This value is used to indicate that Layer-2 5G ProSe End UE is supported by the UE. +- PROSE\_L3\_END\_UE: This value is used to indicate that Layer-3 5G ProSe End UE is supported by the UE. + +### Non3gppAccess: + +anyOf: + +``` +- type: string +enum: +- N3IWF +- TNGF +- type: string +description: > + 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. +description: | + Represents a non-3gpp access node. + Possible values are: +- N3IWF: Non-3gpp Interworking Function. +- TNGF: Trusted Non-3gpp Gateway Function. + +AccessStatus: +anyOf: +- type: string +enum: +- ADDITION +- REMOVAL +- type: string +description: > + 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. +description: | + Represents whether the type of change is a replacement, addition or removal. + Possible values are: +- ADDITION: The type of change is an addition. +- REMOVAL: The type of change is a removal. + +N1N2MessTransferErrorReply: +anyOf: +- type: string +enum: +- UE_NOT_REACHABLE +- UNSPECIFIED +- type: string +description: > + 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. +description: | + Represents an N1N2 Message Transfer error. + Possible values are: +- UE_NOT_REACHABLE: The UE is not reachable for paging. +- UNSPECIFIED: Unspecified error. + +# +UePolicyTransferFailureCause: +description: UE Policy Transfer Failure Cause. +anyOf: +- $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1N2MessageTransferCause' +- $ref: '#/components/schemas/N1N2MessTransferErrorReply' +``` + +# --- Annex B (normative): Wireless and wireline convergence access support + +## B.1 Scope + +This annex provides the stage 3 definition of the UE Policy Control Service for wireless and wireline convergence access support for 5GS. + +The stage 2 definition and procedures of the UE Policy Control Service for wireless and wireline convergence access support for 5GS are contained in 3GPP TS 23.316 [23]. + +## --- B.2 Npcf\_UEPolicyControl Service + +### B.2.1 Service Description + +#### B.2.1.1 Overview + +Clause 4.1.1 applies with the modification that the 5G-RG and FN-RG replace the UE. + +NOTE: The URSPs related to the FN-RG are delivered to the W-AGF, which is acting as a UE towards the 5GC on behalf of the FN-RG. + +#### B.2.1.2 Service Architecture + +Clause 4.1.1 applies with the exception that roaming functionality (V-PCF and H-PCF specific functionality) shall not apply in this Release of the specification for UE policy control for 5G-RG connecting via W-5GAN and FN-RG. Roaming architecture is only applicable to a 5G-RG connecting to the 5GC via NG RAN. + +#### B.2.1.3 Network Functions + +##### B.2.1.3.1 Policy Control Function (PCF) + +The PCF functionality defined in clause 4.1.3.1 shall apply with the following differences: + +- The PCF should not provide Access Network Discovery and Selection Policy (ANDSP) for a 5G-RG connected via wireline access. +- The Visited Policy Control Function (V-PCF) shall not apply for 5G-RG connecting via wireline access and FN-RG. +- The PCF provides the UE access selection and PDU session selection policy control as described in this Annex. + +##### B.2.1.3.2 NF Service Consumers + +The NF service consumer functionality shall apply as defined in clause 4.1.3.2 with the differences described in this Annex. + +## --- B.3 Service Operations + +### B.3.1 Introduction + +Clause 4.2.1 is applied with the following differences: + +- UE is replaced by the 5G-RG or or FN-RG. +- Update of an UE Policy Association for the case that the AMF is relocated due to the UE mobility and the old PCF is selected is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access. +- Roaming scenario is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access in this release of specification. + +### B.3.2 Npcf\_UEPolicyControl\_Create Service Operation + +#### B.3.2.1 General + +Clause 4.2.2.1 is applied with the following differences: + +- UE is replaced by the 5G-RG or FN-RG. +- The PEI that may be included within the "pei" attribute shall have one of the following representations: + - i. If the 5G-BRG supports only wireline access, the PEI shall be the 5G-BRG MAC address. + - ii. If the 5G-CRG supports only wireline access, the PEI shall be the cable modem MAC address. + - iii. If the 5G-RG supports at least one 3GPP access technology, the PEI shall be the allocated IMEI or IMEISV. + - iv. For the FN-BRG and FN-CRG, the PEI shall be the FN-RG MAC address. + +NOTE: When the PEI includes an indication that the MAC address cannot be used as Equipment identifier of the of the FN-RG, the PEI cannot be trusted for regulatory purposes and cannot be used for equipment based policy evaluation. + +- When the 5G-BRG or FN-BRG connects the 5GC via W-5GBAN, the "n3gaLocation" attribute shall be included in the "ueLoc" attribute and: + - the Global Line Identifier shall be included in the "gli" attribute; and + - the "w5gbnLineType" attribute to indicate whether the W-5GBAN access is DSL or PON may be included. +- The HFC Node Identifier is encoded in the "hfcNodeId" attribute of the "n3gaLocation" attribute included in the "userLoc" attribute within the PolicyAssociationRequest data structure when the 5G-CRG or FN-CRG connects to the 5GC via W-5GCAN. +- Roaming scenario is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access in this release of specification. +- The PCF should neither include NSWO indication nor any ANDSP policies in the UE Policy. + +### B.3.3 Npcf\_UEPolicyControl\_Update Service Operation + +#### B.3.3.1 General + +Clause 4.2.3.1 is applied with the following differences: + +- UE is replaced by the 5G-RG or FN-RG. +- Roaming scenario is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access in this release of specification. +- The PCF should neither include NSWO indication nor any ANDSP policies in the UE Policy. + +### B.3.4 Npcf\_UEPolicyControl\_UpdateNotify Service + +#### B.3.4.1 General + +Clause 4.2.4.1 is applied with the following differences: + +- UE is replaced by the 5G-RG or FN-RG. + +- Roaming scenario is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access in this release of specification. +- The PCF should neither include NSWO indication nor any ANDSP policies in the UE Policy. + +### B.3.5 Npcf\_UEPolicyControl\_Delete Service Operation + +#### B.3.5.1 General + +Clause 4.2.5.1 is applied with the following differences: + +- UE is replaced by the 5G-RG or FN-RG. +- Roaming scenario is not applicable when the 5G-RG or FN-RG connects the 5GC via wireline access in this release of specification. + +# --- Annex C (informative): Withdrawn API versions + +This Annex list withdrawn API versions of the Npcf\_UEPolicyControl API defined in the present specification. 3GPP TS 3GPP TS 29.501 [6] clause 4.3.1.6 describes the withdrawal of API versions. + +The API versions listed in table C-1 are withdrawn for the Npcf\_UEPolicyControl API. + +**Table C-1: Withdrawn API versions of the Npcf\_UEPolicyControl service** + +| API version number | Remarks | +|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| 1.0.0 | Deficits in:
- SUPI not mandatory (Unnecessary support of Emergency registration).
- Missing AMF instance id in Policy Association request | + +# Annex D (informative): Change history + +| Change history | | | | | | | | +|----------------|------------|-----------|------|-----|-----|----------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-10 | CT3#98-Bis | C3-186282 | | | | First TS version created based on suitable parts of TS 29.507v15.1.0 | 0.1.0 | +| 2018-12 | CT3#99 | C3-187094 | | | | API Version | 0.2.0 | +| 2018-12 | CT3#99 | C3-187532 | | | | ExternalDocs OpenAPI field | 0.2.0 | +| 2018-12 | CT3#99 | C3-187096 | | | | Location header field in OpenAPI | 0.2.0 | +| 2018-12 | CT3#99 | C3-187533 | | | | Security | 0.2.0 | +| 2018-12 | CT3#99 | C3-187098 | | | | supported content types | 0.2.0 | +| 2018-12 | CT3#99 | C3-187534 | | | | HTTP Error responses | 0.2.0 | +| 2018-12 | CT3#99 | C3-187673 | | | | Alternate IP address in Npcf_UEPolicyControl_Update | 0.2.0 | +| 2018-12 | CT3#99 | C3-187673 | | | | Corrections on Protocol and Application errors | 0.2.0 | +| 2018-12 | CP#82 | CP-183130 | | | | TS sent to plenary for information and approval | 1.0.0 | +| 2018-12 | CP#82 | CP-183175 | | | | PCR 29.xyz Corrections of Cardinality in OpenAPI | 1.1.0 | +| 2018-12 | CP#82 | CP-183250 | | | | TS number assigned for approval at plenary | 1.1.0 | +| 2018-12 | CP#82 | CP-183252 | | | | TS approved by plenary | 15.0.0 | +| 2019-03 | CP#83 | CP-190114 | 0001 | 1 | F | Usage of the Namf_Communication Service by V-PCF | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0002 | 1 | F | Allignment with TS 24.501 changes on UE STATE INDICATION message | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0005 | | F | OpenAPI version Update | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0006 | | F | Correction to the overview | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0007 | | F | Correction to the descriptions of network functions | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0008 | 1 | F | Correction to the service operation introduction | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0011 | 3 | F | Correction to the Npcf_UEPolicyControl_UpdateNotify operation | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0012 | | F | Correction to the PresenceInfo data type | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0013 | | F | UE Policy Control support for Emergency Registration | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0014 | | F | Correction to the group identifier | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0017 | 1 | F | Adding AMF instance id in Policy Association request | 15.1.0 | +| 2019-03 | CP#83 | CP-190114 | 0018 | 3 | F | V-PCF Interworking procedures for UE policy delivery service | 15.1.0 | +| 2019-03 | CP#83 | CP-190214 | 0019 | 3 | F | Correction on the handling of URSP and ANDSP policies | 15.1.0 | +| 2019-06 | CT#84 | CP-191082 | 0021 | 1 | F | ANDSP correction | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0022 | 2 | F | Correction to PolicyAssociationReleaseCause data type | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0023 | 1 | F | Resending the UE policy | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0024 | 2 | F | Correction to the service operation procedure | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0028 | 2 | F | Withdrawing API version | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0029 | 1 | F | Precedence of OpenAPI file | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0030 | 1 | F | API version Update | 15.2.0 | +| 2019-06 | CT#84 | CP-191082 | 0031 | | F | Correction to the serviceName attribute | 15.2.0 | +| 2019-06 | CT#84 | CP-191160 | 0034 | 2 | F | Copyright Note in YAML file | 15.2.0 | +| 2019-06 | CP#84 | CP-191089 | 0027 | 1 | F | Correction on Policy Association Termination | 16.0.0 | +| 2019-06 | CP#84 | CP-191089 | 0032 | 1 | B | Race condition handling | 16.0.0 | +| 2019-06 | CP#84 | CP-191101 | 0035 | 1 | F | API version Update | 16.0.0 | +| 2019-09 | CP#85 | CP-192178 | 0036 | | B | Adding NID as input for policy decisions | 16.1.0 | +| 2019-09 | CP#85 | CP-192148 | 0038 | | A | UE policy correction in AMF | 16.1.0 | +| 2019-09 | CP#85 | CP-192152 | 0040 | 1 | B | Support of wireline and wireless access convergence, Annex Skeleton | 16.1.0 | +| 2019-09 | CP#85 | CP-192176 | 0041 | 1 | B | Support of wireline and wireless access convergence, NFs | 16.1.0 | +| 2019-09 | CP#85 | CP-192224 | 0043 | 3 | A | Message transfer failure notification | 16.1.0 | +| 2019-09 | CP#85 | CP-192171 | 0044 | 3 | B | URSP rule provisioning for supporting xBDT | 16.1.0 | +| 2019-09 | CP#85 | CP-192148 | 0046 | 1 | A | GUAMI included in the Update operation | 16.1.0 | +| 2019-09 | CP#85 | CP-192160 | 0047 | 1 | B | PLMN change for V2X | 16.1.0 | +| 2019-09 | CP#85 | CP-192173 | 0048 | | F | OpenAPI version update for TS 29.525 Rel-16 | 16.1.0 | +| 2019-12 | CP#86 | CP-193197 | 0050 | 1 | F | Data type of the "serviceName" attribute | 16.2.0 | +| 2019-12 | CP#86 | CP-193223 | 0051 | | F | Correcting references related to xBDT support | 16.2.0 | +| 2019-12 | CP#86 | CP-193189 | 0053 | 1 | A | Correction to the trigger of UE policy association establishment | 16.2.0 | +| 2019-12 | CP#86 | CP-193223 | 0054 | 3 | B | URSP provisioning for xBDT | 16.2.0 | +| 2019-12 | CP#86 | CP-193197 | 0055 | 1 | B | Format of hPcflid attribute | 16.2.0 | +| 2019-12 | CP#86 | CP-193197 | 0057 | 1 | B | Subscription to UE Connectivity state changes | 16.2.0 | +| 2019-12 | CP#86 | CP-193197 | 0058 | | F | Removal of TABs from OpenAPI file | 16.2.0 | +| 2019-12 | CP#86 | CP-193202 | 0059 | 1 | F | correction to PLMN change trigger | 16.2.0 | +| 2019-12 | CP#86 | CP-193223 | 0060 | 1 | B | store BDT reference ID in SMPolicyData | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CP#86 | CP-193189 | 0064 | | A | Correction to PolicyUpdate | 16.2.0 | +| 2019-12 | CP#86 | CP-193189 | 0066 | 1 | A | Correction on 307 error | 16.2.0 | +| 2019-12 | CP#86 | CP-193191 | 0067 | 1 | B | Clarification of PEI format, TS 29.525 | 16.2.0 | +| 2019-12 | CP#86 | CP-193227 | 0068 | 2 | B | Wireline Location information | 16.2.0 | +| 2019-12 | CP#86 | CP-193212 | 0069 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200223 | 0071 | | B | Correction on UE Policy Association Establishment | 16.3.0 | +| 2020-03 | CT#87e | CP-200212 | 0072 | 1 | B | Network function enhancement for V2X communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200212 | 0073 | 1 | B | UE Policy for V2XARC | 16.3.0 | +| 2020-03 | CT#87e | CP-200262 | 0074 | 2 | B | N2 PC5 Policy for V2XARC | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0075 | 1 | B | Complete the procedure for WWC | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0076 | | B | Completing the description of "PLMN_CH" and "CON_STATE_CH" triggers. | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0078 | 1 | B | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201224 | 0080 | 1 | A | Location Header of 307 status code | 16.4.0 | +| 2020-06 | CT#88e | CP-201224 | 0082 | 1 | A | Notification URI | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0083 | | B | FQDN of alternative AMF | 16.4.0 | +| 2020-06 | CT#88e | CP-201224 | 0085 | | A | Description of scopes field and presenceStatus attribute | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0086 | | F | Removal of MAC address | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0087 | | F | Removal of unbreakable spaces | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0088 | 2 | B | Untrusted FN-RG PEI | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0089 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0090 | 1 | B | Correction to the UE policy definition | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0091 | 1 | B | Correction to the V2X Policy provisioning | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0093 | 1 | B | Remove editor's node | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0094 | 1 | F | URI of the Npcf_UEPolicyControl service | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0095 | | F | AF-based service parameter provisioning | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0096 | | F | Complete service description for V2X | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0097 | | F | Corrections on N2 PC5 policy | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0098 | | F | Include V2XP info contents into policy section | 16.4.0 | +| 2020-06 | CT#88e | CP-201213 | 0099 | 1 | B | Support of Dual Connectivity end to end Redundant User Plane Paths | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0100 | | F | Correction to 4.2.4.1 | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0101 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0102 | 1 | F | Supported headers, Resource Data type, Operation Name | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0105 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202069 | 0106 | | F | Include N2 PC5 policy in update response | 16.5.0 | +| 2020-09 | CT#89e | CP-202069 | 0107 | | F | Remove the dependency of subscription data in UDR for V2X | 16.5.0 | +| 2020-09 | CT#89e | CP-202079 | 0108 | 1 | F | report initial presence status for PRA | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0109 | 1 | B | Successful Response | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0110 | | B | Error status code | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0112 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0115 | 1 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0117 | 1 | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203143 | 0119 | 1 | A | Correction to PRA | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0121 | 1 | A | Correction to the BDT policy re-negotiation | 17.1.0 | +| 2020-12 | CT#90e | CP-203119 | 0126 | 1 | A | Correction to Policy Update Notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0127 | 1 | F | Report current value in Update for location related triggers | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0128 | 1 | B | Adding 200OK response for UpdateNotify | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0129 | 2 | B | Support of 307&404 response codes for Policy update notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203148 | 0130 | | F | "400 Bad Request" response on notification | 17.1.0 | +| 2020-12 | CT#90e | CP-203150 | 0132 | 1 | A | Correction to URSP rules, support of 5G VN services | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0136 | | F | Update of OpenAPI version and TS version in externalDocs fieldFilename: draft29525-h10-rm-v0.doc | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0139 | 1 | A | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210210 | 0141 | 1 | A | Correction to N2 PC5 policy | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0142 | | F | Adding "description" field for map data types | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0143 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0144 | | F | Clarification on optional HTTP custom headers | 17.2.0 | +| 2021-03 | CT#91e | CP-210227 | 0146 | 1 | F | Clarification of update operation | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0147 | 1 | F | Ambiguous concept of NF service consumer terminology | 17.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0148 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210191 | 0150 | 1 | A | Correction to resource identifiers descriptions used in notifications | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0152 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211133 | 0153 | 4 | B | 5G ProSe related updates to the | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------|--------| +| | | | | | | Npcf_UEPolicyControl_Create Service Operation | | +| 2021-06 | CT#92e | CP-211245 | 0155 | 1 | B | GLI report | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0157 | 1 | A | Temporary and Permanent Redirection | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0158 | 1 | B | Support of UE policy updates for AF influence on URSP | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0160 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0161 | 1 | F | Correction of URI structure | 17.4.0 | +| 2021-09 | CT#93e | CP-212250 | 0163 | 1 | A | Correction to V2X Policy Provisioning Request | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0164 | 1 | F | Correction to ProSe Policy Provisioning Request | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0165 | 1 | F | Separation of 5G ProSe N2 PC5 and V2X N2 PC5 policies. | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0166 | | B | Update of URSP definition | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0167 | 1 | B | Notification of 5G ProSe capability changes | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0168 | 1 | F | Correction to the reused data types | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0169 | | F | Correction to immediate PRA report | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0170 | 1 | B | Removal of some 5G ProSe related ENs | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0171 | 1 | F | Miscellaneous corrections to the Npcf_UEPolicyControl service | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0174 | | A | Correction of URI related attribute for the termination notification | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0175 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213229 | 0177 | | F | Direct access to SNPN | 17.5.0 | +| 2021-12 | CT#94e | CP-213243 | 0178 | | F | Correction to Update procedure | 17.5.0 | +| 2021-12 | CT#94e | CP-213213 | 0179 | 1 | B | Updates to ProSeP for 5G ProSe UE-to-network relay | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0180 | | B | Handling of retrieved URSP policies from the UDR | 17.5.0 | +| 2021-12 | CT#94e | CP-213248 | 0181 | | B | Support of RSN and PDU Session Pair ID in the URSP Rule | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0182 | 1 | F | Error handling when no UE Policy Association exists | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0183 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220206 | 0184 | 1 | B | PCF checking of redundant PDU session applicability | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0185 | 1 | A | Alignment of "Application Errors" clause with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0186 | 1 | B | Resolutions related to URSP guidance handling at the PCF | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0187 | 1 | F | Handling of supported features for Edge Computing | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0188 | 1 | F | Removal of Editor's Notes related to AF guidance of URSP determination | 17.6.0 | +| 2022-03 | CT#95e | CP-220167 | 0191 | 1 | A | Handling of error responses | 17.6.0 | +| 2022-03 | CT#95e | CP-220174 | 0193 | 1 | A | Description of a "307 Temporary Redirect" response | 17.6.0 | +| 2022-03 | CT#95e | CP-220193 | 0195 | 1 | F | Description of a "307 Temporary Redirect" response in table 5.5.2.2-2 | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0196 | | F | Removing the remaining ENs on ProSeP definition 2022-03 | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0200 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221154 | 0201 | 1 | F | Formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0202 | - | F | Using the common data type for FQDN | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0203 | - | F | Validation of guidance information | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0204 | - | F | Limitation of URSP derived based guidance information | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0205 | 1 | F | Notification of outcome of URSP provisioning | 17.7.0 | +| 2022-06 | CT#96 | CP-221116 | 0208 | 1 | F | Correction to ProSe related triggers | 17.7.0 | +| 2022-06 | CT#96 | CP-221253 | 0209 | 2 | F | Correction to GROUP_ID_LIST_CHG trigger | 17.7.0 | +| 2022-06 | CT#96 | CP-221138 | 0210 | 1 | B | UE Policies support in SNPN | 17.7.0 | +| 2022-06 | CT#96 | CP-221254 | 0211 | 2 | A | Request of ProSeP/V2XP during NAS Transport procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0215 | - | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0217 | 1 | F | Alignment with the SBI template | 17.8.0 | +| 2022-09 | CT#97e | CP-222133 | 0218 | 1 | F | Correction in the handling of precedence for URSP rules | 17.8.0 | +| 2022-09 | CT#97e | CP-224217 | 0220 | | A | Correction of policy update procedures | 17.8.0 | +| 2022-09 | CT#97e | CP-222178 | 0221 | 1 | F | Correction of UE Policy Association management for URSP and ANDSP | 17.8.0 | +| 2022-09 | CT#97e | CP-224322 | 0222 | | F | Correction to UE policy provisioning for AF-influenced URSP | 17.8.0 | +| 2022-12 | CT#98e | CP-223162 | 0223 | 2 | F | Removal of the request of V2XP and/or ProSeP during registration | 17.9.0 | +| 2022-12 | CT#98e | CP-223177 | 0229 | | F | Corrections to PLMN change trigger | 17.9.0 | +| 2022-12 | CT#98e | CP-223177 | 0231 | | F | Correction to UE Policies determination in a serving SNPN | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0232 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223201 | 0225 | 1 | B | Feature awareness during UE mobility with AMF change | 18.0.0 | +| 2022-12 | CT#98e | CP-223191 | 0227 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0228 | 1 | F | Correction on the handling of UE policy delivery errors | 18.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223178 | 0230 | | B | SNPN mobility | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0233 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230133 | 0234 | 1 | B | Adding Configured NSSAI to UE Policy Control inputs | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0236 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230147 | 0237 | 1 | B | NWDAF-assisted for URSP rules determination | 18.1.0 | +| 2023-03 | CT#99 | CP-230152 | 0238 | 1 | B | URSP provisioning in EPS | 18.1.0 | +| 2023-03 | CT#99 | CP-230181 | 0239 | 1 | F | Feature negotiation in roaming scenarios | 18.1.0 | +| 2023-03 | CT#99 | CP-230130 | 0240 | 1 | B | Support of the satellite backhaul category | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0241 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231174 | 0242 | 1 | B | Support of Non-3GPP access for SNPN scenarios | 18.2.0 | +| 2023-06 | CT#100 | CP-231165 | 0243 | 1 | B | Trigger slice-aware ANDSP/WLANSP determination | 18.2.0 | +| 2023-06 | CT#100 | CP-231165 | 0244 | 1 | B | ANDSP delivery notifications | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0246 | 1 | B | Representation of N43 reference point | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0247 | 1 | F | ANDSP support indication to V-PCF | 18.2.0 | +| 2023-06 | CT#100 | CP-231182 | 0248 | 1 | B | Support of PIN ID in URSP | 18.2.0 | +| 2023-06 | CT#100 | CP-231156 | 0249 | 1 | B | Support for A2X service authorization and policy provisioning in Npcf_UEPolicyControl Service Operation | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0251 | 1 | D | Miscellaneous changes | 18.2.0 | +| 2023-06 | CT#100 | CP-231173 | 0252 | 1 | B | Complete the feature negotiation during the AMF relocation | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0253 | 3 | B | Support for URSP awareness | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0254 | 2 | B | Support of the configured NSSAI change | 18.2.0 | +| 2023-06 | CT#100 | CP-231165 | 0255 | 1 | B | Support of TNGF selection for S-NSSAI | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0258 | 1 | F | HTTP redirection clause correction | 18.2.0 | +| 2023-06 | CT#100 | CP-231184 | 0259 | 1 | B | Support UE policies for 5G ProSe UE-to-UE relay | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0260 | 1 | B | URSP Provisioning in EPS roaming support | 18.2.0 | +| 2023-06 | CT#100 | CP-231134 | 0261 | 1 | B | URSP Provisioning in EPS corrections regarding the delivery of the initial UE policy container with the UE STATE INDICATION message | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0262 | 1 | B | Provisioning of VPLMN specific URSP rules | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0263 | 1 | B | Completion of URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231173 | 0264 | 1 | B | Solving remaining ENs on feature re-negotiation | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0265 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232098 | 0266 | 1 | F | Update on PresenceInfo for PolicyUpdate | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232104 | 0267 | | F | EN resolution for A2XP related UE policy encoding | 18.3.0 | +| 2023-09 | CT#101 | CP-232104 | 0268 | | F | EN resolution for A2X subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232108 | 0269 | | B | UE policy based on subscribed DNN/S-NSSAI for PIN scenarios | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0270 | 1 | B | Enhancement to Npcf_UEPolicyControl service for URSP rule enforcement | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0271 | 1 | B | Spending limits report for UE Policy | 18.3.0 | +| 2023-09 | CT#101 | CP-232121 | 0272 | 1 | B | Completion of the reporting of Satellite Backhaul changes | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0273 | 1 | B | URSP rule enforcement | 18.3.0 | +| 2023-09 | CT#101 | CP-232240 | 0274 | 1 | B | Completion of the Provisioning of VPLMN specific URSP | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0275 | 1 | B | Solving URSP delivery in EPS ENs related to roaming scenarios | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0276 | 3 | B | Completion of the reporting of configured NSSAI changes | 18.3.0 | +| 2023-09 | CT#101 | CP-232110 | 0277 | 1 | B | N1N2MessageSubscribe during AMF relocation | 18.3.0 | +| 2023-09 | CT#101 | CP-232110 | 0278 | | B | Discovery of Namf_Communication service | 18.3.0 | +| 2023-09 | CT#101 | CP-232110 | 0279 | 1 | B | Non-subscribed SNPN signalled URSP | 18.3.0 | +| 2023-09 | CT#101 | CP-232104 | 0280 | 1 | B | Support of A2X policy provisioning for A2X communication over Uu reference point | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0281 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233245 | 0282 | 2 | B | Support the change of the PDU Session Type for a 5G VN group | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0285 | 1 | B | Remove the EN for the details that the PCF receives the report of URSP rule enforcement info from NWDAF | 18.4.0 | +| 2023-12 | CT#102 | CP-233202 | 0286 | 1 | F | Correction to the report of URSP rule enforcement info | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0287 | | F | Wrong attribute name | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0288 | 2 | D | Incorrect feature name | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0289 | 1 | F | Correction in error handling in roaming scenarios | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0290 | 1 | B | Enhancement to Npcf_UEPolicyControl service for URSP rule enforcement in EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233268 | 0293 | 1 | B | Update UE Policy Control Service for Ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0295 | 1 | F | Miscellaneous changes | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0297 | 1 | B | Subscription to the outcome of the provisioning of VPLMN specific URSP | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0298 | 1 | B | URSP provisioning in EPS in Home Routed scenarios | 18.4.0 | +| 2023-12 | CT#102 | CP-233172 | 0299 | 2 | B | Same UE Policy Association shared by 3GPP and non-3GPP | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0300 | 1 | F | Corrections on PCRT for immediate report | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0301 | | F | definition of term Configured NSSAI | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0302 | 1 | B | Update for the URSP rule enforcement without UE assistance | 18.4.0 | +| 2023-12 | CT#102 | CP-233230 | 0304 | 1 | F | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233253 | 0305 | 1 | B | Support for services deployed on GEO satellite | 18.4.0 | +| 2023-12 | CT#102 | CP-233283 | 0306 | | B | Non-subscribed SNPN signalled WLANSP | 18.4.0 | +| 2023-12 | CT#102 | CP-233256 | 0307 | 1 | B | Completion of error handling functionality | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0309 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29531/raw.md b/gsma/29_series/29531/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..36590e4659d0c84d4b13052df946f9ecf8f795e9 --- /dev/null +++ b/gsma/29_series/29531/raw.md @@ -0,0 +1,3663 @@ + + +# 3GPP TS 29.531 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Slice Selection Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the letters is a red signal wave icon, and at the bottom, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the NSSF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nnssf_NSSelection Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 GET..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Get service operation of Nnssf_NSSelection service..... | 10 | +| 5.2.2.2.3 Get service operation of Nnssf_NSSelection service during the PDU session establishment..... | 12 | +| 5.2.2.2.4 Get service operation of Nnssf_NSSelection service during UE configuration update procedure..... | 13 | +| 5.3 Nnssf_NSSAIAvailability Service..... | 14 | +| 5.3.1 Service Description ..... | 14 | +| 5.3.2 Service Operations..... | 14 | +| 5.3.2.1 Introduction..... | 14 | +| 5.3.2.2 Update Service Operation..... | 15 | +| 5.3.2.2.1 General ..... | 15 | +| 5.3.2.3 Subscribe Service Operation..... | 15 | +| 5.3.2.3.1 Creation of a subscription ..... | 15 | +| 5.3.2.3.2 Modification of a subscription ..... | 17 | +| 5.3.2.4 Unsubscribe Service Operation ..... | 17 | +| 5.3.2.4.1 General ..... | 17 | +| 5.3.2.5 Notify Service Operation..... | 18 | +| 5.3.2.5.1 General ..... | 18 | +| 5.3.2.6 Delete Service Operation..... | 19 | +| 5.3.2.6.1 General ..... | 19 | +| 5.3.2.7 Options Service Operation..... | 20 | +| 5.3.2.7.1 General ..... | 20 | +| 6 API Definitions ..... | 20 | +| 6.1 Nnssf_NSSelection Service API..... | 20 | +| 6.1.1 API URI..... | 20 | +| 6.1.2 Usage of HTTP..... | 21 | +| 6.1.2.1 General..... | 21 | +| 6.1.2.2 HTTP standard headers..... | 21 | +| 6.1.2.2.1 General ..... | 21 | +| 6.1.2.2.2 Content type ..... | 21 | +| 6.1.2.3.1 General ..... | 21 | +| 6.1.3 Resources..... | 21 | +| 6.1.3.1 Overview..... | 21 | +| 6.1.3.2 Resource: Network Slice Information ..... | 22 | +| 6.1.3.2.1 Description ..... | 22 | +| 6.1.3.2.2 Resource Definition..... | 22 | +| 6.1.3.2.3 Resource Standard Methods..... | 22 | +| 6.1.3.2.4 Resource Custom Operations..... | 24 | + +| | | | +|------------|--------------------------------------------------------------------------|----| +| 6.1.4 | Custom Operations without associated resources ..... | 25 | +| 6.1.5 | Notifications ..... | 25 | +| 6.1.6 | Data Model ..... | 25 | +| 6.1.6.1 | General ..... | 25 | +| 6.1.6.2 | Structured data types ..... | 26 | +| 6.1.6.2.1 | Introduction ..... | 26 | +| 6.1.6.2.2 | Type: AuthorizedNetworkSliceInfo ..... | 27 | +| 6.1.6.2.3 | Type: SubscribedSnssai ..... | 31 | +| 6.1.6.2.4 | Void ..... | 31 | +| 6.1.6.2.5 | Type: AllowedSnssai ..... | 31 | +| 6.1.6.2.6 | Type: AllowedNssai ..... | 31 | +| 6.1.6.2.7 | Type: NsiInformation ..... | 32 | +| 6.1.6.2.8 | Type: MappingOfSnssai ..... | 32 | +| 6.1.6.2.9 | Void ..... | 33 | +| 6.1.6.2.10 | Type: SliceInfoForRegistration ..... | 33 | +| 6.1.6.2.11 | Type: SliceInfoForPDUSession ..... | 36 | +| 6.1.6.2.12 | Type: ConfiguredSnssai ..... | 36 | +| 6.1.6.2.13 | Type: SliceInfoForUEConfigurationUpdate ..... | 37 | +| 6.1.6.2.14 | Type: NsagInfo ..... | 39 | +| 6.1.6.3 | Simple data types and enumerations ..... | 39 | +| 6.1.6.3.1 | Introduction ..... | 39 | +| 6.1.6.3.2 | Simple data types ..... | 39 | +| 6.1.6.3.3 | Enumeration: RoamingIndication ..... | 39 | +| 6.1.6.4 | Binary data ..... | 39 | +| 6.1.7 | Error Handling ..... | 40 | +| 6.1.7.1 | General ..... | 40 | +| 6.1.7.2 | Protocol Errors ..... | 40 | +| 6.1.7.3 | Application Errors ..... | 40 | +| 6.1.8 | Feature negotiation ..... | 40 | +| 6.1.9 | Security ..... | 41 | +| 6.1.10 | HTTP redirection ..... | 41 | +| 6.2 | Nnssf_NSSAIAvailability Service API ..... | 41 | +| 6.2.1 | API URI ..... | 41 | +| 6.2.2 | Usage of HTTP ..... | 41 | +| 6.2.2.1 | General ..... | 41 | +| 6.2.2.2 | HTTP standard headers ..... | 42 | +| 6.2.2.2.1 | General ..... | 42 | +| 6.2.2.2.2 | Content type ..... | 42 | +| 6.2.2.2.3 | Accept-Encoding ..... | 42 | +| 6.2.2.3 | HTTP custom headers ..... | 42 | +| 6.2.2.3.1 | General ..... | 42 | +| 6.2.3 | Resources ..... | 42 | +| 6.2.3.1 | Overview ..... | 42 | +| 6.2.3.2 | Resource: NSSAI Availability Document ..... | 43 | +| 6.2.3.2.1 | Description ..... | 43 | +| 6.2.3.2.2 | Resource Definition ..... | 44 | +| 6.2.3.2.3 | Resource Standard Methods ..... | 44 | +| 6.2.3.3 | Resource: NSSAI Availability Notification Subscriptions Collection ..... | 47 | +| 6.2.3.3.1 | Description ..... | 47 | +| 6.2.3.3.2 | Resource Definition ..... | 48 | +| 6.2.3.3.3 | Resource Standard Methods ..... | 48 | +| 6.2.3.4 | Resource: Individual NSSAI Availability Notification Subscriptions ..... | 49 | +| 6.2.3.4.1 | Description ..... | 49 | +| 6.2.3.4.2 | Resource Definition ..... | 49 | +| 6.2.3.4.3 | Resource Standard Methods ..... | 49 | +| 6.2.3.5 | Resource: NSSAI Availability Store ..... | 51 | +| 6.2.3.5.1 | Description ..... | 51 | +| 6.2.3.5.2 | Resource Definition ..... | 51 | +| 6.2.3.5.3 | Resource Standard Methods ..... | 52 | +| 6.2.4 | Custom Operations without associated resources ..... | 53 | +| 6.2.5 | Notifications ..... | 53 | +| 6.2.5.1 | General ..... | 53 | + +| | | | +|-------------------------------|----------------------------------------------|-----------| +| 6.2.5.2 | NSSAI Availability Notification ..... | 53 | +| 6.2.5.2.1 | Description ..... | 53 | +| 6.2.5.2.2 | Notification Definition ..... | 53 | +| 6.2.5.2.3 | Notification Standard Methods ..... | 54 | +| 6.2.6 | Data Model ..... | 55 | +| 6.2.6.1 | General ..... | 55 | +| 6.2.6.2 | Structured data types ..... | 56 | +| 6.2.6.2.1 | Introduction ..... | 56 | +| 6.2.6.2.2 | Type: NssaiAvailabilityInfo ..... | 56 | +| 6.2.6.2.3 | Type: SupportedNssaiAvailabilityData ..... | 57 | +| 6.2.6.2.4 | Type: AuthorizedNssaiAvailabilityData ..... | 57 | +| 6.2.6.2.5 | Type: RestrictedSnssai ..... | 58 | +| 6.2.6.2.6 | Type: AuthorizedNssaiAvailabilityInfo ..... | 58 | +| 6.2.6.2.7 | Type: PatchDocument ..... | 58 | +| 6.2.6.2.8 | Type: NssfEventSubscriptionCreateData ..... | 59 | +| 6.2.6.2.9 | Type: NssfEventSubscriptionCreatedData ..... | 61 | +| 6.2.6.2.10 | Type: NssfEventNotification ..... | 62 | +| 6.2.6.2.11 | Type: SnssaiReplacementSubscribeInfo ..... | 63 | +| 6.2.6.2.12 | Type: NsiUnavailabilitySubscribeInfo ..... | 63 | +| 6.2.6.3 | Simple data types and enumerations ..... | 63 | +| 6.2.6.3.1 | Introduction ..... | 63 | +| 6.2.6.3.2 | Simple data types ..... | 63 | +| 6.2.6.3.3 | Enumeration: NssfEventType ..... | 64 | +| 6.2.6.4 | Binary data ..... | 64 | +| 6.2.7 | Error Handling ..... | 64 | +| 6.2.7.1 | General ..... | 64 | +| 6.2.7.2 | Protocol Errors ..... | 64 | +| 6.2.7.3 | Application Errors ..... | 64 | +| 6.2.8 | Feature negotiation ..... | 65 | +| 6.2.9 | Security ..... | 66 | +| 6.2.10 | HTTP redirection ..... | 67 | +| Annex A (normative): | OpenAPI specification ..... | 68 | +| A.1 | General ..... | 68 | +| A.2 | Nnssf_NSSelection API ..... | 68 | +| A.3 | Nnssf_NSSAIAvailability API ..... | 74 | +| Annex B (informative): | Change history ..... | 84 | + +# --- Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnssf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NSSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [9] 3GPP TS 23.003: "Numbering, addressing and identification". +- [10] IETF RFC 9113: "HTTP/2". +- [11] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [13] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [14] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [15] IETF RFC 9457: "Problem Details for HTTP APIs". +- [16] IETF RFC 1952: "GZIP file format specification version 4.3". +- [17] 3GPP TR 21.900: "Technical Specification Group working methods". +- [18] IETF RFC 9110: "HTTP Semantics". +- [19] Void +- [20] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [21] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP); Stage 3". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------| +| NSAG | Network Slice AS Group | +|------|------------------------| + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NSSF offers services to the AMF and NSSF in a different PLMN via the Nnssf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the NSSF and the scope of the present specification. + +![Diagram of NSSF in 5G System architecture showing AMF and NSSF connected to Nnssf interface of the NSSF.](740442c999390734911677f01af0316d_img.jpg) + +``` +graph LR; AMF[AMF] -- N22 --> Nnssf((Nnssf)); NSSF1[NSSF] -- N31 --> Nnssf; Nnssf --- NSSF2[NSSF]; +``` + +The diagram illustrates the NSSF in 5G System architecture. On the left, there are two boxes: 'AMF' at the top and 'NSSF' at the bottom. From the 'AMF' box, a line labeled 'N22' extends to the right and connects to a circle labeled 'Nnssf'. From the 'NSSF' box, a line labeled 'N31' extends to the right and also connects to the same 'Nnssf' circle. To the right of the 'Nnssf' circle is a large box labeled 'NSSF'. The 'Nnssf' circle is positioned on the left boundary of this 'NSSF' box, indicating it is a service based interface provided by the NSSF. + +Diagram of NSSF in 5G System architecture showing AMF and NSSF connected to Nnssf interface of the NSSF. + +**Figure 4.1-1: NSSF in 5G System architecture** + +The functionalities supported by the NSSF are listed in clause 6.2.14 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the NSSF + +## 5.1 Introduction + +The NSSF supports the following services. + +**Table 5.1-1: NF Services provided by NSSF** + +| Service Name | Description | Example Consumer | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| Nnssf_NSSelection | This service enables Network Slice selection in both the Serving PLMN and the HPLMN | AMF, V-NSSF | +| Nnssf_NSSAIAvailability | This service enables to update the S-NSSAI(s) the NF service consumer (e.g AMF) supports on a per TA basis on the NSSF and to subscribe and notify any change in status, on a per TA basis, of the SNSSAIs available per TA (unrestricted) and the restricted S-NSSAI(s) per PLMN in that TA in the serving PLMN of the UE.
This service also enables the notification of the Network Slice Replacement and Network Slice Instance Replacement to the NF Service Consumer. | AMF, V-NSSF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------|--------|--------------------------------------|--------------------------------------|-------------------------|-------| +| Nnssf_NSSelection | 6.1 | NSSF Network Slice Selection Service | TS29531_Nnssf_NSSelection.yaml | nnssf-nsselection | A.2 | +| Nnssf_NSSAIAvailability | 6.2 | NSSF NSSAI Availability Service | TS29531_Nnssf_NSSAIAvailability.yaml | nnssf-nssaiavailability | A.3 | + +## 5.2 Nnssf\_NSSelection Service + +### 5.2.1 Service Description + +The Nnssf\_NSSelection service is used by an NF Service Consumer (e.g. AMF or NSSF in a different PLMN) to retrieve the information related to network slice in the non-roaming and roaming case. + +It also enables the NSSF to provide to the AMF the Allowed NSSAI and the Configured NSSAI for the Serving PLMN. + +It also enables the NSSF to provide to the AMF the NSAG information associated with the Configured NSSAI for the Serving PLMN. + +The NF service consumer discovers the NSSF based on the local configuration. The NSSF in a different PLMN is discovered based on the self-constructed FQDN as specified in 3GPP TS 23.003 [9]. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nnssf\_NSSelection service the following service operations are defined: + +- Get. + +#### 5.2.2.2 GET + +##### 5.2.2.2.1 General + +The Get operation shall be invoked by the AMF in the non-roaming or roaming scenario to retrieve: + +- The slice selection information including the Allowed NSSAI, Configured NSSAI, target AMF Set or the list of candidate AMF(s), and optionally + - The Mapping Of Allowed NSSAI; + - The Mapping Of Configured NSSAI; + - NSI ID(s) associated with the Network Slice instances of the Allowed NSSAI; + - NRF(s) to be used to select NFs/services within the selected Network Slice instance(s) and NRF to be used to determine the list of candidate AMF(s) from the AMF Set, during Registration procedure; + - Information on whether the S-NSSAI(s) not included in the Allowed NSSAI which were part of the Requested NSSAI are rejected in the serving PLMN or in the current TA; + - The Target NSSAI that includes the S-NSSAI(s) as defined in clause 5.3.4.3.3 of 3GPP TS 23.501 [2], and + - The NSAG information associated with Configured NSSAI as defined in clause 5.15.14 of 3GPP TS 23.501 [2]. +- The NRF to be used to select NFs/services within the selected network slice instance, and optionally the NSI ID associated with the S-NSSAI provided in the input, during the PDU Session Establishment procedure. +- The slice mapping information including the mapping of S-NSSAI(s) of the VPLMN to corresponding HPLMN S-NSSAI(s). + +The Get operation shall also be invoked by the vNSSF in the roaming scenario to retrieve: + +- The hNRF to be used to select NFs/services within the selected network slice instance in the HPLMN, and optionally the NSI ID associated with the S-NSSAI provided in the input, during the PDU Session Establishment procedure. + +It is used in the following procedures: + +- Registration procedure (see clause 4.2.2.2.2 of 3GPP TS 23.502 [3]); +- Registration with AMF re-allocation (see clause 4.2.2.2.3 of 3GPP TS 23.502 [3]); +- EPS to 5GS handover using N26 interface (see clause 4.11.1.2.2 of 3GPP TS 23.502 [3]); +- EPS to 5GS mobility registration procedure (see clauses 4.11.1.3.3, 4.11.1.3.3A, 4.11.1.3.4 and 4.23.12 of 3GPP TS 23.502 [3]); +- Xn and N2 Handover procedures with PLMN change (see clauses 4.9.1, 4.23.7 and 4.23.11 of 3GPP TS 23.502 [3]); +- UE Configuration Update procedure (see clause 4.2.4.2 of 3GPP TS 23.502 [3]); +- SMF selection for non-roaming and roaming with local breakout (see clause 4.3.2.2.3.2 of 3GPP TS 23.502 [3]) or SMF selection for home-routed roaming scenario (see clause 4.3.2.2.3.3 of 3GPP TS 23.502 [3]). + +NOTE: The list of procedures above, which trigger invoking of the Nnssf\_NSSelection\_Get service operation, is not exhaustive. + +##### 5.2.2.2.2 Get service operation of Nnssf\_NSSelection service + +In this procedure, the NF Service Consumer (e.g. AMF) retrieves the slice selection information including the Allowed NSSAI, Configured NSSAI, target AMF Set or the list of candidate AMF(s) and other optional information. + +This service operation shall also be used to retrieve the slice mapping information including the mapping of S-NSSAI(s) of the VPLMN to corresponding HPLMN S-NSSAI(s), e.g. during inter-PLMN mobility procedure and/or mobility procedure within VPLMN from EPS to 5GS. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The NF Service Consumer sends a GET request to the NSSF. The NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (ProblemDetails), or a 4xx/5xx (ProblemDetails) or 3xx status.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: 1. GET .../v1/network-slice-information? + NF Service Consumer->>NSSF: 1. GET .../v1/network-slice-information? + Note right of NSSF: 2a. 200 OK (AuthorizedNetworkSliceInfo) +2b. 403 Forbidden (ProblemDetails) +Or 4xx/5xx (ProblemDetails) Or 3xx + NSSF-->>NF Service Consumer: 2a. 200 OK (AuthorizedNetworkSliceInfo) +2b. 403 Forbidden (ProblemDetails) +Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The NF Service Consumer sends a GET request to the NSSF. The NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (ProblemDetails), or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.2.2-1: Retrieve the network slice information during the mobility procedure** + +- 1 The AMF shall send a GET request to the NSSF. + +If the AMF wants to retrieve the slice selection information, one or more of the following parameters shall be included in the slice-info-request-for-registration query parameter: + +- Requested NSSAI and Subscribed S-NSSAI(s) with the indication if marked as default S-NSSAI and the associated subscribed NSSRG information; +- optionally UE support of subscription-based restrictions to simultaneous registration of network slice feature Indication; +- UDM indication to provide all subscribed S-NSSAIs for UEs not indicating support of subscription-based restrictions to simultaneous registration of network slices feature; +- Indication of the support of NSAG by the UE. + +If the AMF wants to retrieve the slice mapping information, the following parameters shall be included in the slice-info-request-for-registration query parameter: + +- sNssaiForMapping IE and; +- requestMapping IE. + +In both scenarios, the AMF shall also include the following parameters in the message: + +- PLMN ID of the SUPI in roaming scenarios; +- TAI; +- NF type of the NF service consumer and; +- Requester ID. + +- 2a On success, "200 OK" shall be returned when the NSSF is able to find authorized network slice information for the requested network slice selection information, the response body shall include a content containing at least the following parameters: + +- Allowed NSSAI and; +- target AMF Set or the list of candidate AMF(s). + +The content may additionally contain the following parameters: + +- a target AMF Service Set; +- Target NSSAI. + +"200 OK" shall also be returned when the NSSF is able to find the requested slicing mapping information, the response body shall include a content containing the mapping of S-NSSAI(s) of the VPLMN to corresponding HPLMN S-NSSAI(s) included in the allowedNssaiList IE. + +NSSFs of a PLMN that implement AMF reallocation via RAN by supporting the NGAP REROUTE NAS REQUEST procedure (see clause 8.6.5 of 3GPP TS 38.413 [21]) should return the target AMF set ID in its response. The NSSF may query the NRF to discover target AMF Set if this information is not known by other means (e.g. if not provided by AMF during Nnssf\_NSSAIAvailability\_Update service operation). + +If subscribed NSSRG list is provided, the NSSF shall provide the compatible S-NSSAIs in the Allowed NSSAI as defined in clause 5.15.12 of 3GPP TS 23.501 [2] and compatible S-NSSAIs in the Target NSSAI (if provided). + +If the request indicated that UE does not support subscription-based restrictions to simultaneous registration of network slice feature, and UDM has requested to provide all subscribed S-NSSAIs for such UEs, Configured NSSAI, if included, shall be provided ignoring the NSSRG restrictions. + +If the AMF has indicated the support of NSAG by the UE, the NSSF shall include the "nsagInfoList" attribute with NSAG information if available. + +- 2b If no slice instances can be found for the requested slice selection information or the requested slice mapping information, then the NSSF shall return a 403 Forbidden response with the "ProblemDetails" IE containing the Application Error "SNSSAI\_NOT\_SUPPORTED" (cf. Table 6.1.7.3-1). + +On failure or redirection, the NSSF shall return one of the HTTP status codes together with the response body listed in Table 6.1.3.2.3.1-3. + +##### 5.2.2.2.3 Get service operation of Nnssf\_NSSelection service during the PDU session establishment + +In this procedure, the NF Service Consumer (e.g. AMF) retrieves the NRF and the optionally the NSI ID of the network slice instance: + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The consumer sends a GET request for network slice information, and the NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (problemDetails), or a 4xx/5xx (ProblemDetails) or 3xx status code.](63e0c22852c26699d0bd095a2d796bab_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: + NF Service Consumer->>NSSF: 1. GET .../v1/network-slice-information? + Note right of NSSF: + NSSF-->>NF Service Consumer: 2a. 200 OK (AuthorizedNetworkSliceInfo) + NSSF-->>NF Service Consumer: 2b. 403 Forbidden (problemDetails) + NSSF-->>NF Service Consumer: Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The consumer sends a GET request for network slice information, and the NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (problemDetails), or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.2.3-1: Retrieve the network slice information during the PDU session establishment procedure** + +- 1 The NF Service consumer (e.g. AMF or NSSF in the different PLMN) shall send a GET request to the NSSF. + +The request shall include query parameters, contain at least the following parameters: + +- S-NSSAI; +- S-NSSAI from the HPLMN that maps to the S-NSSAI from the Allowed NSSAI of the Serving PLMN; +- the NF type of the NF service consumer; +- Requester ID and; +- non-roaming/LBO roaming/HR roaming indication. + +For the request towards an NSSF in the Serving PLMN, the query parameters shall also contain the PLMN ID of the SUPI and TAI. + +- 2a On success, "200 OK" shall be returned when the NSSF is able to find network slice instance information for the requested network slice selection information, the response body shall include a content containing at least the NRF to be used to select NFs/services within the selected Network Slice instance; +- 2b If no slice instances can be found for the requested slice selection information, then the NSSF shall return a 403 Forbidden response with the "ProblemDetails" IE containing the Application Error "SNSSAI\_NOT\_SUPPORTED" (cf. Table 6.1.7.3-1). + +On failure or redirection, the NSSF shall return one of the HTTP status codes together with the response body listed in Table 6.1.3.2.3.1-3. + +##### 5.2.2.2.4 Get service operation of Nssf\_NSSelection service during UE configuration update procedure + +In this procedure, the NF Service Consumer (e.g. AMF) retrieves network slice configuration information (e.g. the Allowed NSSAI and the Configured NSSAI) during the UE configuration update procedure. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The consumer sends a GET request to the NSSF. The NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (ProblemDetails), or a 3xx/4xx/5xx status code with ProblemDetails.](ddc7460821484f1ae2835c67955c554c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: 1. GET .../v1/network-slice-information? + NF Service Consumer->>NSSF: 1. GET .../v1/network-slice-information? + Note right of NSSF: 2a. 200 OK (AuthorizedNetworkSliceInfo) +2b. 403 Forbidden (ProblemDetails) +Or 4xx/5xx (ProblemDetails) Or 3xx + NSSF-->>NF Service Consumer: 2a. 200 OK (AuthorizedNetworkSliceInfo) +2b. 403 Forbidden (ProblemDetails) +Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSSF. The consumer sends a GET request to the NSSF. The NSSF responds with either a 200 OK (AuthorizedNetworkSliceInfo), a 403 Forbidden (ProblemDetails), or a 3xx/4xx/5xx status code with ProblemDetails. + +**Figure 5.2.2.2.4-1: Retrieve the network slice information during UE configuration update procedure** + +- The NF Service consumer (e.g. AMF) shall send a GET request to the NSSF. The request shall include query parameters: + - Subscribed S-NSSAI(s) with the indication if the S-NSSAI is marked as default S-NSSAI and the associated subscribed NSSRG information; + - optionally UE support of subscription-based restrictions to simultaneous registration of network slice feature Indication; + - UDM indication to provide all subscribed S-NSSAIs for UEs not indicating support of subscription-based restrictions to simultaneous registration of network slices feature; + - Rejected S-NSSAI(s) for the Registration Area; + - PLMN ID of the SUPI; + - TAI; + - Indication of the support of NSAG by the UE; + - NF type of the NF service consumer and; + - the NF instance ID of the requester NF. + +**NOTE:** When the AMF invokes UE Configuration Update procedure to determine the Target NSSAI to redirect the UE to the dedicated frequency band(s) for an S-NSSAI (as specified in clause 5.3.4.3.3 of 3GPP TS 23.501 [2]), the AMF provides the Allowed NSSAI and the rejected S-NSSAI(s) for the current Registration Area to the NSSF; the Allowed NSSAI and Rejected S-NSSAI(s) for the RA does not include any S-NSSAI that failed for Network Slice-Specific Authentication and Authorization. The AMF does not include the Requested NSSAI to the NSSF in this procedure, thus the NSSF will not provide Allowed NSSAI again to the AMF in the response. + +2a On success, "200 OK" shall be returned when the NSSF is able to find authorized network slice information for the requested network slice selection information, the response body shall include a content containing at least the following parameters: + +- Allowed NSSAI; +- Configured NSSAI and; +- optionally Target NSSAI. + +If subscribed NSSRG list is provided, the NSSF shall provide the compatible S-NSSAIs in the Allowed NSSAI as defined in the clause 5.15.12 of 3GPP TS 23.501 [2] and compatible S-NSSAIs in the Target NSSAI(if provided). + +If the request indicated that UE does not support subscription-based restrictions to simultaneous registration of network slice feature, and UDM has requested to provide all subscribed S-NSSAIs for such UEs, the NSSF shall provide Configured NSSAI ignoring the NSSRG restrictions. + +If the AMF has indicated the support of NSAG by the UE, the NSSF shall include the "nsagInfoList" attribute with NSAG information if available. + +2b If no slice instances can be found for the requested slice selection information, then the NSSF shall return a 403 Forbidden response with the "ProblemDetails" IE containing the Application Error "SNSSAI\_NOT\_SUPPORTED" (cf. Table 6.1.7.3-1). + +On failure or redirection, the NSSF shall return one of the HTTP status codes together with the response body listed in Table 6.1.3.2.3.1-3. + +## 5.3 Nnssf\_NSSAIAvailability Service + +### 5.3.1 Service Description + +The Nnssf\_NSSAIAvailability service is used by the NF service consumer (e.g AMF) to update the S-NSSAI(s) the AMF supports on a per TA basis on the NSSF, subscribe and unsubscribe the notification of any changes to the NSSAI availability information on a per TA basis, of the S-NSSAIs available per TA (unrestricted) and the restricted S-NSSAI(s) per PLMN in that TA in the serving PLMN of the UE. + +It also enables the NF service consumer (e.g. AMF) to update the NSAG(s) associated with the S-NSSAI(s) supported by the AMF on a per TA basis. + +It also enables the NF service consumer (e.g., AMF, V-NSSF) to receive updates for Network Slice Replacement and Network Slice Instance Replacement. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nnssf\_NSSAIAvailability service the following service operations are defined: + +- Update; +- Subscribe; +- Unsubscribe; +- Notify; +- Delete; +- Options. + +#### 5.3.2.2 Update Service Operation + +##### 5.3.2.2.1 General + +The Update operation shall be used by an NF Service Consumer (e.g. AMF) to update the NSSF with the S-NSSAIs the NF service consumer (e.g. AMF) supports per TA, and get the availability of the S-NSSAIs per TA for the S-NSSAIs the NF service consumer (e.g. AMF) supports. + +The Update operation may also be used by an NF Service Consumer (e.g. AMF) to update the NSSF with the NSAG(s) associated with the S-NSSAI(s) supported by the NF Service Consumer (e.g. AMF) on per TA basis, and to get the availability of the NSAG(s) per TA for the NSAG(s) supported by the NF Service Consumer (e.g. AMF). + +![Sequence diagram showing the Update Service Operation between an NF Service Consumer and an NSSF. Step 1: The consumer sends a PUT or PATCH request to the NSSF. Step 2: The NSSF responds with a 204 No content, 200 OK, 4xx, 5xx, or 3xx status.](9ae17964ddd9b814c7d905b1af2fddf2_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note right of NF Service Consumer: 1. PUT .../v1/nssai-availability/{nflid}(NssaiAvailabilityInfo) or +PATCH .../v1/nssai-availability/{nflid}(PatchDocument) + NF Service Consumer->>NSSF: Request + Note left of NSSF: 2. 204 No content / 200 OK (AuthorizedNssaiAvailabilityInfo) or +4xx / 5xx (ProblemDetails) or 3xx + NSSF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the Update Service Operation between an NF Service Consumer and an NSSF. Step 1: The consumer sends a PUT or PATCH request to the NSSF. Step 2: The NSSF responds with a 204 No content, 200 OK, 4xx, 5xx, or 3xx status. + +**Figure 5.3.2.2.1-1: Update the S-NSSAIs the AMF supports per TA** + +1. The NF service consumer (e.g. AMF) shall send a PUT request to the resource representing the NSSF Availability information of the individual NF, identified by the {nflid}, to replace or create the NSSF Availability information of the NF. + +The content shall contain the NssaiAvailabilityInfo which contains one or more representations of the individual supportedSnssai information to be replaced. + +The NssaiAvailabilityInfo in the content may contain NSAG information. + +The NF service consumer (e.g. AMF) shall send a PATCH request to the resource representing the NSSF Availability information of the individual NF, identified by the {nflid}, to update the NSSF Availability information of the NF. + +The content shall contain the PatchDocument which contains one or more PatchItem instructions for updating the individual supportedSnssai resources. + +The content may contain the PatchDocument which contains one or more PatchItem instructions for updating the NSAG information. + +2. On success, "204 No content" shall be returned if Authorized NSSF Availability is empty after the update; otherwise, "200 OK" shall be returned, the content of the PUT/PATCH response shall contain the representation describing the status of the request and the complete AuthorizedNssaiAvailabilityData information representing the current state of the AuthorizedNssaiAvailabilityInfo. + +If there is no supported S-NSSAIs authorized by the NSSF for the TA, the NSSF shall not return the AuthorizedNssaiAvailabilityData for the corresponding TA in the response. + +On failure or redirection, the NSSF shall return one of the HTTP status code together with the response body listed in Table 6.2.3.2.3.1-2 / Table 6.2.3.2.3.2-2. + +#### 5.3.2.3 Subscribe Service Operation + +##### 5.3.2.3.1 Creation of a subscription + +The Subscribe Operation is used by a NF Service Consumer (e.g. AMF, V-NSSF) to subscribe to a notification of Network Slice Replacement, Network Slice Instance Replacement and/or of any changes in status of the NSSF availability information (e.g. S-NSSAIs available per TA and the restricted S-NSSAI(s) per PLMN in that TA in the serving PLMN of the UE) upon this is updated by another AMF. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSSF to create a subscription. The NF Service Consumer sends a POST request to the NSSF. The NSSF responds with a 201 Created status, containing NssfEventSubscriptionCreatedData, or an error status (4xx/5xx ProblemDetails or 3xx).](0f985b39edc1d52ba3600c438bc8f0a5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: 1. POST .../v1/nssai-availability/subscriptions/(NssfEventSubscriptionCreateData) + NF Service Consumer->>NSSF: Request + Note right of NSSF: 2. 201 Created (NssfEventSubscriptionCreatedData) or 4xx/5xx (ProblemDetails) Or 3xx + NSSF-->>NF Service Consumer: Response + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSSF to create a subscription. The NF Service Consumer sends a POST request to the NSSF. The NSSF responds with a 201 Created status, containing NssfEventSubscriptionCreatedData, or an error status (4xx/5xx ProblemDetails or 3xx). + +**Figure 5.3.2.3.1-1 Create a subscription** + +1. The NF Service Consumer shall send a POST request to create a subscription resource in the NSSF. The content of the POST request shall contain a representation of the individual event subscription resource to be created in the NssfEventSubscriptionCreateData. + +The request shall indicate the type(s) of events for which the subscription is created, i.e., Network Slice Replacement, Network Slice Instance Replacement and/or of any changes in status of the NSSAI availability information. + +The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto during which the subscription is desired to be kept active and describes the maximum duration after which the subscribed event shall stop generating report. + +The request may also indicate a specific AMF Set to restrict the subscriptions to notifications applicable to the AMF Set (i.e. notifications related to S-NSSAIs supported by the AMF Set). If the AMF Set is provided and the NSSF support the "SATS" feature (see clause 6.2.8), the NF Service Consumer may also indicate that the subscription is for all TAI(s) associated with the AMF Set. + +If the service operation is invoked for subscription to Network Slice Replacement notification, then the request shall contain: + +- for VPLMN S-NSSAI: the list of S-NSSAIs in the VPLMN served by the NF Service Consumer that may be replaced with, the NF type of the NF Service Consumer (e.g., AMF) and the NF instance ID of the requester NF. +- for HPLMN S-NSSAI: the list of S-NSSAIs in the HPLMN that the S-NSSAI may be replaced with, the NF type of the NF Service Consumer (e.g., AMF, V-NSSF), the NF instance ID of the requester NF and the HPLMN ID. + +If the service operation is invoked for subscription to Network Slice Instance Replacement notification, then the request shall contain: + +- the list of S-NSSAIs and/or the list of NSI IDs that may become congested or no longer available. + +2. On success, "201 Created" shall be returned, and the content of the POST response shall contain the representation describing the status of the created subscription in NssfEventSubscriptionCreatedData. + +For a subscription to any changes in status of the NSSAI availability information, the NssfEventSubscriptionCreatedData may contain the AuthorizedNssaiAvailabilityData information, if available. + +If there is no supported S-NSSAIs authorized by the NSSF for the TA, the NSSF shall not return the AuthorizedNssaiAvailabilityData for the corresponding TA in the response. + +The Location header shall contain the location (URI) of the created subscription resource. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the NSSF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NSSF. The NSSF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +On failure or redirection, the NSSF shall return one of the HTTP status code together with the response body listed in Table 6.2.3.3.3.1-2. + +##### 5.3.2.3.2 Modification of a subscription + +The Subscribe Operation may be used by a NF Service Consumer (e.g. AMF, V-NSSF) towards an NSSF supporting the SUMOD feature, when it needs to modify an existing subscription previously created by itself. + +The NF Service Consumer shall modify the subscription by using HTTP method PATCH with the URI of the individual subscription resource to be modified. + +![Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the NSSF, and the NSSF responds with a 200 OK or an error status code.](21ad58fee90f2be50708ff541d225507_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: + Note right of NSSF: + NF Service Consumer->>NSSF: 1. PATCH .../subscriptions/{subscriptionID}{PatchDocument} + NSSF-->>NF Service Consumer: 2. 200 OK (NssfEventSubscriptionCreatedData) or 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the modification of a subscription. The NF Service Consumer sends a PATCH request to the NSSF, and the NSSF responds with a 200 OK or an error status code. + +**Figure 5.3.2.3.2-1 Modify a subscription** + +1. The NF Service Consumer (e.g. AMF, V-NSSF) shall send a PATCH request to the resource URI identifying the individual subscription resource. The content shall contain the PatchDocument which contains one or more PatchItem instructions for updating the subscription data. + +The NF Service Consumer shall not change the event IE included in the NssfEventSubscriptionCreateData by invoking the PATCH request message. + +For a subscription to any changes in status of the NSSAI availability information, the taiList IE may only be set to an empty array in PATCH request if the NF service consumer and NSSF support the ONSSAI feature. + +2. On success, "200 OK" shall be returned, the content of the PATCH response shall contain the representation describing the updated subscription in NssfEventSubscriptionCreatedData. + +For a subscription to any changes in status of the NSSAI availability information, if there is no supported S-NSSAIs authorized by the NSSF for the TA, the NSSF shall not return the AuthorizedNssaiAvailabilityData for the corresponding TA in the response. + +On failure or redirection, the NSSF shall return one of the HTTP status code together with the response body listed in Table 6.2.3.4.3.2-2. + +#### 5.3.2.4 Unsubscribe Service Operation + +##### 5.3.2.4.1 General + +The Unsubscribe Operation is used by a NF Service Consumer (e.g. AMF, V-NSSF) to unsubscribe to a notification of any previously subscribed changes to the NSSAI availability information, Network Slice Replacement and/or Network Slice Instance Replacement. + +![Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the NSSF. The NSSF responds with a 204 No Content or 4xx (ProblemDetails) or 3xx status code.](dfe556fea00682b09a59427aaf72051c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: 1. DELETE .../v1/nssai-availability/subscriptions/{SubscriptionId} + NF Service Consumer->>NSSF: 1. DELETE .../v1/nssai-availability/subscriptions/{SubscriptionId} + Note right of NSSF: 2. 204 No Content or 4xx (ProblemDetails) or 3xx + NSSF-->>NF Service Consumer: 2. 204 No Content or 4xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Unsubscribe a subscription. The NF Service Consumer sends a DELETE request to the NSSF. The NSSF responds with a 204 No Content or 4xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.4.1-1 Unsubscribe a subscription** + +1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the NSSF. +2. If the request is accepted, the NSSF shall respond with the status code 204 indicating the resource identified by subscription ID is successfully deleted. + +On failure or redirection, the NSSF shall return one of the HTTP status code together with the response body listed in Table 6.2.3.4.3.1-2. + +#### 5.3.2.5 Notify Service Operation + +##### 5.3.2.5.1 General + +The Notify Service operation shall be used by the NSSF to update the NF Service Consumer (e.g. AMF) with any change in status, on a per TA basis, of the S-NSSAIs available per TA (unrestricted) and the S-NSSAIs restricted per PLMN in that TA in the serving PLMN of the UE. The service operation is also used to notify the NF Service Consumer (e.g., AMF, V-NSSF) of Network Slice Replacement and/or Network Slice Instance Replacement. + +![Sequence diagram for Update the AMF with any S-NSSAIs restricted per TA. The NSSF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content Or 4xx/5xx (ProblemDetails) or 3xx status code.](3fa8bfee86764e3c3a1a6fbbe61bbd52_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note right of NSSF: 1. POST {nfNssaiAvailabilityUrl}{NssfEventNotification} + NSSF->>NF Service Consumer: 1. POST {nfNssaiAvailabilityUrl}{NssfEventNotification} + Note left of NF Service Consumer: 2. 204 No Content Or 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>NSSF: 2. 204 No Content Or 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Update the AMF with any S-NSSAIs restricted per TA. The NSSF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with a 204 No Content Or 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.3.2.5.1-1: Update the AMF with any S-NSSAIs restricted per TA** + +1. The NSSF shall send a POST request to the resource representing the NSSF availability resource in the NF service consumer (e.g. AMF, V-NSSF). The content of the POST request shall contain the one representations of the individual NssfEventNotification resource. + +For a subscription to any changes in status of the NSSAI availability information: + +- If there is no supported S-NSSAIs authorized by the NSSF for the TA, the NSSF shall not return the AuthorizedNssaiAvailabilityData for the corresponding TA in the notification. +- If there is no supported S-NSSAIs authorized by the NSSF for all TAs and the NF Service Consumer has indicated support of "EANAN" feature, the NSSF shall set authorizedNssaiAvailabilityData attribute to an empty array. + +For a subscription to Network Slice Instance Replacement: + +- If the NSSF supports the NSIUN feature (see clause 6.2.8) and if the Network Slice instance becomes no longer available, the NSSF shall notify the NF Service Consumer (e.g., AMF, V-NSSF) having subscribed to this event for the related S-NSSAI and/or NSI ID that the NSI is no longer available. In that case, the POST request from the NSSF shall contain the list of S-NSSAIs and the associated NSI IDs for which the status is + +changed (e.g., which become congested or no longer available). The request may also contain congestion mitigation information. + +For a subscription to Network Slice Replacement: + +- If the NSSF supports the NSRP feature (see clause 6.2.8) and if the NSSF detects that an S-NSSAI becomes unavailable (e.g., based on OAM or NWD AF analytics output), the NSSF shall send Network Slice Replacement for the S-NSSAI to the NF service consumer if the NF service consumer has subscribed to this event for the related S-NSSAI. The notification shall include an alternative S-NSSAI which can be used by the NF service consumer to replace the unavailable S-NSSAI. In case of roaming, the notification shall include: + - for VPLMN S-NSSAI replacement: the alternative VPLMN S-NSSAI for the S-NSSAI and the corresponding mapping to the S-NSSAI to be replaced. + - for HPLMN S-NSSAI replacement: the alternative HPLMN S-NSSAI for the S-NSSAI and the corresponding mapping to the HPLMN S-NSSAI to be replaced and the HPLMN ID. +- The NSSF shall notify the NF service consumer when the S-NSSAI becomes available again. The notification shall contain: + - an indication to stop Network Slice replacement for new UEs; or + - an indication to terminate Network Slice Replacement for all the UEs and move back the PDU sessions from the alternative S-NSSAI to the S-NSSAI. + +If the notification is triggered by the AMF that updates the supported S-NSSAIs per TA by using the Update operation, the NSSF shall not send the notification to the same AMF. + +2. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +On failure or redirection, the NF service consumer shall return one of the HTTP status code together with the response body listed in Table 6.2.5.2.3.1-2. + +#### 5.3.2.6 Delete Service Operation + +##### 5.3.2.6.1 General + +The Delete Service operation shall be used by the NF service consumer (e.g. AMF) to delete the NSSAI availability information stored for the NF service consumer in the NSSF. + +![Sequence diagram showing the Delete Service Operation. The NF Service Consumer sends a DELETE request to the NSSF, and the NSSF responds with a 204 No Content or an error status code.](cdd4dfacab004e9979caed3fffea69e5_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: + NF Service Consumer->>NSSF: 1. DELETE .../v1/nssai-availability/{nflid} + NSSF-->>NF Service Consumer: 2. 204 No Content or 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the Delete Service Operation. The NF Service Consumer sends a DELETE request to the NSSF, and the NSSF responds with a 204 No Content or an error status code. + +**Figure 5.3.2.6.1-1: Delete the NSSAI Availability Information at NSSF** + +1. The NF service consumer (e.g. AMF) shall send a DELETE request to remove the NSSAI availability information for the NF service consumer represented by the {nflid} (e.g. AMF ID). +2. The NSSF shall delete the NSSAI Availability information for the individual AMF and shall return the 204 No Content status code. + +On failure or redirection, the NSSF shall return one of the HTTP status code together with the response body listed in Table 6.2.3.2.3.3-2. + +#### 5.3.2.7 Options Service Operation + +##### 5.3.2.7.1 General + +The Options service operation is used by a NF Service Consumer (e.g. AMF) to discover the communication options supported by the NSSF for the resource. + +![Sequence diagram showing the procedure for the discovery of communication options supported by the NSSF. The NF Service Consumer sends an OPTIONS request to the NSSF, and the NSSF responds with a 200 OK or an error status code.](3da1a07cb87051bf616c9876db958cf0_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSF + Note left of NF Service Consumer: + NF Service Consumer->>NSSF: 1. OPTIONS .../nssai-availability + Note right of NSSF: + NSSF-->>NF Service Consumer: 2. 200 OK +Or 4xx/5xx (ProblemDetails) Or 3xx + +``` + +Sequence diagram showing the procedure for the discovery of communication options supported by the NSSF. The NF Service Consumer sends an OPTIONS request to the NSSF, and the NSSF responds with a 200 OK or an error status code. + +**Figure 5.3.2.7.1-1: Procedure for the discovery of communication options supported by the NSSF** + +1. The NF service consumer (e.g. AMF) shall send an OPTIONS request to discover the communication options supported by the NSSF for the resource. +2. If the request is accepted, the NSSF shall respond with the status code 200 OK and include an Accept-Encoding header (as described in IETF RFC 9110 [18]). + +On failure or redirection, the NSSF shall return one of the HTTP status code listed in Table 6.2.3.5.3.1-3. + +# --- 6 API Definitions + +## 6.1 Nnssf\_NSSelection Service API + +### 6.1.1 API URI + +The Nnssf\_NSSelection service shall use the Nnssf\_NSSelection API. + +The API URI of the Nnssf\_NSSelection API shall be: + +**{apiRoot}/nssf-nsselection/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}/nssf-nsselection//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "v2". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [10], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +An OpenAPI [6] specification of HTTP messages and content bodies for the Nnssf\_NSSelection service is specified in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [14], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnssf\_NSSelection service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 describes the resource URI structure of the Nnssf\_NSSelection API. + +![Diagram showing the resource URI structure of the nnssf_nsselection API. The root URI is //{apiRoot}/nnssf-nsselection/{apiVersion}. A callout box points to a sub-resource path: /network-slice-information.](f41910d93b5ae4cc7def1eb267229d50_img.jpg) + +``` +graph TD; Root[" //{apiRoot}/nnssf-nsselection/{apiVersion}"] --- Callout["/network-slice-information"]; +``` + +Diagram showing the resource URI structure of the nnssf\_nsselection API. The root URI is //{apiRoot}/nnssf-nsselection/{apiVersion}. A callout box points to a sub-resource path: /network-slice-information. + +**Figure 6.1.3.1-1: Resource URI structure of the nnssf\_nsselection API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------|----------------------------|----------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| Network Slice Information | /network-slice-information | GET | To retrieve network slice information. See clause 6.1.3.2.3.1.
Maps to Nnssf_NSSelection_Get service operation. | + +#### 6.1.3.2 Resource: Network Slice Information + +##### 6.1.3.2.1 Description + +This resource represents the network slice related information maintained by the NSSF. This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nssf-nselection//network-slice-information + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|------------------|-------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method retrieves the information related to the selected slice based on the input query parameters provided by the NF service consumer specified in table 6.1.3.2.3.1-1. + +This method shall support input query parameters specified in table 6.1.3.2.3.1-1 and the response data structure and response codes specified in table 6.1.3.2.3.1-3. + +Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | +|-------------------------------------|-----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-type | NFType | M | 1 | This IE shall contain the NF type of the NF service consumer. | +| nf-id | NfInstanceId | M | 1 | This IE shall contain the NF identifier of the NF service consumer. | +| slice-info-request-for-registration | SliceInfoForRegistration | C | 0..1 | This IE shall be present when the network slice information is requested during the Registration procedure or during EPS to 5GS handover procedure using N26 interface towards an NSSF in the serving PLMN. | +| slice-info-request-for-pdu-session | SliceInfoForPDUSession | C | 0..1 | This IE shall be present when the network slice information is requested during the PDU session establishment procedure. | +| slice-info-request-for-ue-cu | SliceInfoForUEConfigurationUpdate | C | 0..1 | This IE shall be present when the network slice information is requested during UE configuration update procedure. | +| home-plmn-id | PlmnId | C | 0..1 | This IE shall be present in the request towards an NSSF in the serving PLMN if the subscriber is a roamer to the serving PLMN. When present, this IE shall contain the home PLMN Id of the UE. | +| tai | Tai | C | 0..1 | This IE shall be present in the request towards an NSSF in the serving PLMN. When present, this IE shall contain the TAI the UE is currently located. | +| supported-features | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizedNetworkSliceInfo | M | 1 | 200 OK | This case represents a successful return of the authorized network slice information selected for the corresponding request. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | This represents the case, where the NF service consumer is not authorized to retrieve the slice selection information or the all of the SNSSAIs included in the requested slice selection information is not supported in the PLMN.
The application specific error information shall be provided in the "cause" attribute. The "cause" attribute shall be set to:
- SNSSAI_NOT_SUPPORTED, if the SNSSAI included in the requested slice selection information is not allowed and there is no default NSSAI value provided in the request.
- NOT_AUTHORIZED, if the NF service consumer identified by the NF Id is not authorized to retrieve the slice selection information.
See table 6.1.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP or SEPP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +There are no custom methods supported on the network-slice-information collection resource. + +### 6.1.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for the Nnssf\_NSSelection service in this version of this API. + +### 6.1.5 Notifications + +In this release of this specification, there are no notifications defined for the Nnssf\_NSSelection service. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnssf service based interface protocol. + +**Table 6.1.6.1-1: Nnssf\_NSSelection specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizedNetworkSliceInfo | 6.1.6.2.2 | Contains the authorized network slice information. | +| SubscribedSnssai | 6.1.6.2.3 | Contains the subscribed S-NSSAI. | +| AllowedSnssai | 6.1.6.2.5 | Contains the authorized S-NSSAI and optional mapped home S-NSSAI and network slice instance information. | +| AllowedNssai | 6.1.6.2.6 | Contains an array of allowed S-NSSAI that constitute the Allowed NSSAI information for the authorized network slice information. | +| NsiInformation | 6.1.6.2.7 | Contains the API URIs of NRF services to be used to discover NFs/services, subscribe to NF status changes and/or request access tokens within the selected Network Slice instance and optional the Identifier of the selected Network Slice instance. | +| MappingOfSnssai | 6.1.6.2.8 | Contains the mapping of S-NSSAI in the serving network and the value of the home network. | +| SliceInfoForRegistration | 6.1.6.2.10 | Contains the slice information requested during a Registration procedure. | +| SliceInfoForPDUSession | 6.1.6.2.11 | Contains the slice information requested during PDU Session establishment procedure. | +| ConfiguredSnssai | 6.1.6.2.12 | Contains the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN and optional mapped home S-NSSAI. | +| SliceInfoForUEConfigurationUpdate | 6.1.6.2.13 | Contains the slice information requested during UE configuration update procedure. | +| NsagInfo | 6.1.6.2.14 | Contains NSAG information. | +| NsiId | 6.1.6.3.2 | Contains the Identifier of the selected Network Slice instance. | +| RoamingIndication | 6.1.6.3.3 | Contains the indication on roaming. | + +Table 6.1.6.1-2 specifies data types re-used by the Nnssf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnssf service based interface. + +**Table 6.1.6.1-2: Nnssf re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features defined in table 6.1.8-1. | +| AccessType | 3GPP TS 29.571 [7] | Used to specify the access type for which a slice information is applicable. | +| NfServiceSetId | 3GPP TS 29.571 [7] | NF Service Set Identifier | +| RedirectResponse | 3GPP TS 29.571 [7] | | +| NFType | 3GPP TS 29.510 [13] | Type of Network Function. | +| NsSrg | 3GPP TS 29.571 [7] | Network slice simultaneous registration groups | +| NsagId | 3GPP TS 29.571 [7] | Network Slice AS Group ID | +| TaiRange | 3GPP TS 29.510 [13] | Range of TAIs | +| Tai | 3GPP TS 29.571 [7] | | +| Snssai | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +6.1.6.2.2 Type: AuthorizedNetworkSliceInfo + +**Table 6.1.6.2.2-1: Definition of type AuthorizedNetworkSliceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| allowedNssaiList | array(AllowedNssai) | C | 1..N |

This IE shall be included if:

  • - the NSSF received the Requested NSSAI and the subscribed S-NSSAI(s); or
  • - the "requestMapping" flag in the corresponding request was set to "true"; or
  • - if neither Requested NSSAI nor the mapping of Requested NSSAI was provided to the NSSF or none of the S-NSSAIs in the Requested NSSAI are permitted (provided that there is at least a subscribed S-NSSAI marked as default which is available in the current TA).

When present, this IE shall contain the allowed S-NSSAI(s) authorized by the NSSF in the serving PLMN per access type if the Requested NSSAI and the subscribed S-NSSAI(s) received, or this IE shall contain the mapping of S-NSSAI(s) of the VPLMN to corresponding HPLMN S-NSSAI(s) if requestMapping flag was set to "true".

NSSF may consider load level information of a Network Slice instance, provided by the NWDAF, to exclude slices that are overloaded.

| | +| configuredNssai | array(ConfiguredS nssai) | C | 1..N |

This IE shall be included if:

  • - the NSSF did not receive any Requested NSSAI; or
  • - the Requested NSSAI includes an S-NSSAI that is not valid in the Serving PLMN; or
  • - the NSSF has received "defaultConfiguredSnssaiInd" set to "true"; or
  • - the network slice information is requested during UE configuration update procedure.

When present, this IE shall contain the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN.

This IE shall not be included if the "requestMapping" IE was included in the request message and was set to "true".

NSSF may consider load level information of a Network Slice instance, provided by the NWDAF, to exclude slices that are overloaded.

| | + +| | | | | | | +|---------------------|---------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| targetAmfSet | string | O | 0..1 |

This IE may be included by the NSSF based on configuration and if the NSSF received the Requested NSSAI and the subscribed S-NSSAI(s). When present, this IE shall contain the target AMF set which shall be constructed from PLMN-ID (i.e. three decimal digits MCC and two or three decimal digits MNC), AMF Region Id (8 bit), and AMF Set Id (10 bit).

This IE shall not be included if the "requestMapping" IE was included in the request message and was set to "true".
Pattern: '[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}\$'
(NOTE 1, NOTE 2, NOTE 3)

| | +| candidateAmfList | array(NfInstanceId) | O | 1..N |

This IE may be included by the NSSF based on configuration and if the NSSF received the Requested NSSAI and the subscribed S-NSSAI(s). When present, this IE shall contain the list of candidate AMF(s).

This IE shall not be included if the "requestMapping" IE was included in the request message and was set to "true".
(NOTE 2, NOTE 3)

| | +| rejectedNssaiInPlmn | array(Snssai) | O | 1..N |

This IE may be included by the NSSF if the NSSF received the Requested NSSAI and the subscribed S-NSSAI(s). When present, this IE shall contain the rejected NSSAI in the PLMN.

NSSF may consider load level information of a Network Slice instance, provided by the NWDAF, to exclude slices that are overloaded. Such slices may be included in this attribute.

| | +| rejectedNssaiInTa | array(Snssai) | O | 1..N |

This IE may be included by the NSSF if the NSSF received the Requested NSSAI and the subscribed S-NSSAI(s). When present, this IE shall contain the rejected NSSAI in the current TA.

NSSF may consider load level information of a Network Slice instance, provided by the NWDAF, to exclude slices that are overloaded. Such slices may be included in this attribute.

| | +| nsiInformation | NsiInformation | C | 0..1 |

This IE shall be included by the NSSF if the NSSF received the S-NSSAI (i.e. during PDU session establishment procedure in non-roaming or LBO roaming).

This IE shall also be included by the hNSSF and forwarded by the vNSSF if the hNSSF received the S-NSSAI (i.e. during PDU session establishment procedure in HR roaming).

This IE shall not be included if the "requestMapping" IE was included in the request message and was set to "true".

| | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +| | | | | | | +|-------------------------|-----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| nrfAmfSet | Uri | O | 0..1 | This IE may be included by the NSSF based on configuration and if the target AMF Set is included. When present, this IE shall contain the API URI of the NRF NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [13]) to be used to determine the list of candidate AMF(s) from the AMF Set. (NOTE 2) | | +| nrfAmfSetNfMgtUri | Uri | C | 0..1 | This IE should be present if the nrfAmfSet is present. When present, it shall contain the API URI of the NRF NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [13]). (NOTE 2) | | +| nrfAmfSetAccessTokenUri | Uri | O | 0..1 | When present, this IE shall contain the API URI of the NRF Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [13]). (NOTE 2) | | +| nrfOauth2Required | map(boolean) | O | 1..N | This IE may be present if the nrfAmfSet IE or the nrfAmfSetNfMgtUri IE is present. When present, this IE shall indicate whether the NRF requires Oauth2-based authorization for accessing its services. The key of the map shall be the name of an NRF service, e.g. "nnrf-nfm" or "nnrf-disc".

The value of each entry of the map shall be encoded as follows:
- true: OAuth2 based authorization is required.

- false: OAuth2 based authorization is not required.

If this IE is present and set to true, then the nrfAmfSetAccessTokenUri IE shall be present and shall be used to request access token for NRF services.

The absence of this IE means that the NRF has not provided any indication about its usage of Oauth2 for authorization. (NOTE 2) | | +| targetAmfServiceSet | NfServiceSetId | O | 0..1 | When present, this IE shall contain the target AMF service set. (NOTE 1, NOTE 2) | | +| targetNssai | array(Snssai) | O | 1..N | This IE may be included by the NSSF if the NSSF received the Requested NSSAI and TAI, or the NSSF received the rejected NSSAI of current Registration Area.

When present, this IE shall contain S-NSSAI(s) as defined in clause 5.3.4.3.3 of 3GPP TS 23.501 [2]. | TargetNssai | +| nsagInfos | array(NsagInfo) | C | 1..N | This attribute shall be present if the AMF has indicated the support of NSAG by the UE, and the NSAG information is available to the NSSF. This attribute contains the list of NSAG information. | | + +| | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | The NF Service Consumer uses the PLMN ID, AMF Region, AMF Set and AMF Service Set to perform a NF Discovery to the NRF. | +| NOTE 2: | These attributes should be absent if the NSSF provides a Target NSSAI in targetNssai attribute in order to redirect or handover the UE to a cell of another TA as defined in clause 5.15.5.2.1 of 3GPP TS 23.501 [2]. | +| NOTE 3: | The targetAmfSet attribute and the candidateAmfList attribute should not be present simultaneously. | + +##### 6.1.6.2.3 Type: SubscribedSnssai + +**Table 6.1.6.2.3-1: Definition of type SubscribedSnssai** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| subscribedSnssai | Snssai | M | 1 | This IE shall contain the subscribed S-NSSAI. | +| defaultIndication | boolean | O | 0..1 | If it is set, the subscribed S-NSSAI is a default subscribed S-NSSAI. | +| subscribedNsSrgList | array(NsSrg) | O | 1..N | If present, this IE shall contain the subscribed network slice simultaneous registration groups applicable to the subscribedSnssai. | + +##### 6.1.6.2.4 Void + +##### 6.1.6.2.5 Type: AllowedSnssai + +**Table 6.1.6.2.5-1: Definition of type AllowedSnssai** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedSnssai | Snssai | M | 1 | This IE shall contain the allowed S-NSSAI in the serving PLMN. | +| nsiInformationList | array(NsiInformation) | O | 1..N | This IE may be present when the NSSF provides the Allowed NSSAI information to the NF service consumer (e.g AMF). If present, this IE shall include the information related to the network slice instance corresponding to the allowed S-NSSAI. | +| mappedHomeSnssai | Snssai | O | 0..1 | When present, this IE shall contain the mapped S-NSSAI value of home network corresponding to the allowed S-NSSAI in the serving PLMN. | + +##### 6.1.6.2.6 Type: AllowedNssai + +**Table 6.1.6.2.6-1: Definition of type AllowedNssai** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|----------------------------------------------------------------------------| +| allowedSnssaiList | array(AllowedSnssai) | M | 1..N | This IE shall contain the allowed S-NSSAI in the serving PLMN.
(NOTE) | +| accessType | AccessType | M | 1 | This IE shall contain the access type to which this Allowed NSSAI belongs. | +| NOTE: The maximum number of allowed S-NSSAIs shall not exceed the maximum number defined in 3GPP TS 24.501 [20]. | | | | | + +##### 6.1.6.2.7 Type: NsilInformation + +Table 6.1.6.2.7-1: Definition of type NsilInformation + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrflD | Uri | M | 1 | This IE shall contain the API URI of the NRF NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [13]) to be used to select the NFs/services within the selected Network Slice instance. | +| nsilD | NsilD | O | 0..1 | This IE may be optionally included by the NSSF. When present, this IE shall contain the Identifier of the selected Network Slice instance | +| nrnFmgtUri | Uri | O | 0..1 | This IE should be present. When present, it shall contain the API URI of the NRF NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [13]). | +| nrnAccessTokenUri | Uri | O | 0..1 | When present, this IE shall contain the API URI of the NRF Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [13]). | +| nrnOAuth2Required | map(boolean) | O | 1..N |

This IE may be present if the nrflD IE or the nrnFmgtUri IE is present. When present, this IE shall indicate whether the NRF requires OAuth2-based authorization for accessing its services.

The key of the map shall be the name of an NRF service, e.g. "nnrf-nfm" or "nnrf-disc".

The value of each entry of the map shall be encoded as follows:

  • - true: OAuth2 based authorization is required.
  • - false: OAuth2 based authorization is not required.

The absence of this IE means that the NRF has not provided any indication about its usage of OAuth2 for authorization.

| + +##### 6.1.6.2.8 Type: MappingOfSnssai + +Table 6.1.6.2.8-1: Definition of type MappingOfSnssai + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------| +| servingSnssai | Snssai | M | 1 | This IE shall contain the S-NSSAI value of serving network. | +| homeSnssai | Snssai | M | 1 | This IE shall contain the mapped S-NSSAI value of home network. | + +6.1.6.2.9 Void + +6.1.6.2.10 Type: SliceInfoForRegistration + +**Table 6.1.6.2.10-1: Definition of type SliceInfoForRegistration** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscribedNssai | array(Subscribed Snssai) | C | 1..N | This IE shall be included during the initial registration procedure or during mobility registration procedure in 5GS. This IE may also be included during EPS to 5GS handover procedure/Idle mode Mobility Registration Procedure using N26 interface or the handover procedure within 5GS. When present, this IE shall contain the list of subscribed S-NSSAIs along with an indication for each S-NSSAI if it is a default S-NSSAI. | +| allowedNssaiCurrentAccess | AllowedNssai | C | 0..1 | This IE shall be included during an initial registration procedure in 5GS or during mobility registration update procedure in 5GS with a native 5G-GUTI as the old GUTI, and an Allowed NSSAI for the current access type of the UE is available at the NF service consumer (e.g. AMF). | +| allowedNssaiOtherAccess | AllowedNssai | C | 0..1 | This IE shall be present during an initial registration procedure in 5GS or during mobility registration update procedure in 5GS with a native 5G-GUTI as the old GUTI, and if the UE was registered with the NF service consumer (e.g. AMF) earlier for another access type and an Allowed NSSAI for the other access type is available at the NF service consumer (e.g. AMF). | +| sNssaiForMapping | array(SNSSAI) | C | 1..N | This IE shall be included if the requestMapping IE is set to true. When included, this IE shall contain the set of S-NSSAIs obtained from PGW+SMF in the HPLMN for PDU sessions that are handed over from EPS to 5GS, or shall contain the set of HPLMN S-NSSAIs obtained from source AMF during handover procedure within 5GS, or shall contain the S-NSSAIs for the HPLMN received from the UE during EPS to 5GS Idle mode Mobility Registration Procedure using N26 interface/idle state mobility registration procedure in 5GS. | +| mappingOfNssai | array(MappingOf Snssai) | O | 1..N | This IE may be present when the network slice information is requested during the Registration procedure in roaming scenarios. If present, this IE shall contain the mapping of S-NSSAI of the VPLMN to corresponding HPLMN S-NSSAI, for the S-NSSAIs included in the requestedNssai and allowedNssai IEs for the current and other access types.
This IE may also be present when the network slice information is requested during EPS to 5GS handover procedure using N26 interface or the handover procedure within 5GS. If present, this IE shall contain the mapping of S-NSSAI of the VPLMN to corresponding HPLMN S-NSSAI, for the S-NSSAIs included in the requestedNssai IE. | +| requestedNssai | array(SNSSAI) | O | 1..N | This IE may contain the set of S-NSSAIs requested by the UE, it shall be the S-NSSAIs in hPLMN in non-roaming scenario, or the S-NSSAIs in vPLMN in LBO/HR roaming scenario.
During EPS to 5GS handover procedure using N26 interface, this IE may contain the set of S-NSSAIs in the serving PLMN obtained from PGW+SMF in VPLMN, or mapped from the set of S-NSSAIs obtained from PGW+SMF in the HPLMN.
During handover procedure within 5GS, this IE may contain the set of S-NSSAIs in the serving PLMN obtained from the source AMF, or mapped from the set of HPLMN S-NSSAIs obtained from source AMF. | + +| | | | | | +|----------------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| defaultConfiguredSnssaiInd | boolean | C | 0..1 | This IE shall be present when the UE includes the Default Configured NSSAI Indication during the Registration procedure or if the AMF indicates the NSSF to return Configured NSSAI in case of the network slice subscription change indication (NSSCI) is received from UDM.
true: The Default Configured NSSAI is indicated by the UE and/or the AMF indicates the NSSF to return Configured NSSAI;
false (default): The Default Configured NSSAI is not indicated by the UE and the AMF does not indicate the NSSF to return Configured NSSAI. | +| requestMapping | boolean | O | 0..1 | This IE may be present when the Nnssf_NSSelection_Get procedure is invoked during EPS to 5GS Mobility Registration Procedure (Idle State) using N26 interface or during EPS to 5GS handover procedure using N26 interface.
This IE may also be present when Nnssf_NSSelection_Get procedure is invoked during idle state Mobility Registration Procedure or handover procedure in 5GS.
When present this IE shall indicate to the NSSF that the NSSF shall return the VPLMN specific mapped SNSSAI values for the S-NSSAI values in the sNssaiForMapping IE. | +| ueSupNssrgInd | boolean | C | 0..1 | This IE shall be present in the request towards an NSSF in the serving PLMN when UE has indicated the support of NSSRG feature. When present, this IE shall contain the indication of UE support of subscription-based restrictions to simultaneous registration of network slice feature.
This IE shall be set as follows:
- true: the UE supports NSSRG feature
- false: the UE does not support NSSRG feature. | +| suppressNssrgInd | boolean | O | 0..1 | When present, this IE shall contain the UDM indication to provide all subscribed S-NSSAIs for UEs not indicating support of subscription-based restrictions to simultaneous registration of network slices. This IE may be present and set to true if the ueSupNssrgInd is set to false.

This IE shall be set as follows:
- true: UDM Indication to suppress NSSRG is present and set to TRUE
- false: UDM Indication to suppress NSSRG is set to FALSE or not present | +| nsagSupported | boolean | C | 0..1 | This IE shall be present if the UE has indicated support of NSAG in the 5GMM procedure.

true: the UE supports NSAG.
false (default): the UE does not support NSAG. | + +##### 6.1.6.2.11 Type: SliceInfoForPDUSession + +Table 6.1.6.2.11-1: Definition of type SliceInfoForPDUSession + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | Snssai | M | 1 | This IE shall contain the requested S-NSSAI for the PDU session, when the AMF queries the NSSF in the serving PLMN. When the vNSSF queries the hNSSF during PDU session establishment for home routed roaming case, this IE shall contain the S-NSSAI from the HPLMN that maps to the S-NSSAI from the Allowed NSSAI of the Serving PLMN, as obtained from the NF Service Consumer of the vNSSF. | +| roamingIndication | RoamingIndication | M | 1 | This IE shall contain the indication whether the UE is in non-roaming, LBO roaming or HR roaming. | +| homeSnssai | Snssai | C | 0..1 | This IE shall be included by the NF Service Consumer (e.g. AMF) towards the vNSSF during PDU session establishment procedure in home routed roaming scenario. This IE shall contain the S-NSSAI of the HPLMN that maps to the S-NSSAI from the Allowed NSSAI of the Serving PLMN when the UE in the roaming scenario. | + +##### 6.1.6.2.12 Type: ConfiguredSnssai + +Table 6.1.6.2.12-1: Definition of type ConfiguredSNssai + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| configuredSnssai | Snssai | M | 1 | This IE shall contain the configured S-NSSAI in the serving PLMN. | +| mappedHomeSnssai | Snssai | O | 0..1 | When present, this IE shall contain the mapped S-NSSAI value of home network corresponding to the configured S-NSSAI in the serving PLMN. | + +6.1.6.2.13 Type: SliceInfoForUEConfigurationUpdate + +**Table 6.1.6.2.13-1: Definition of type SliceInfoForUEConfigurationUpdate** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subscribedNssai | array(SubscribedSnssai) | C | 1..N | This IE shall be included during UE configuration update procedure in 5GS. When present, this IE shall contain the list of subscribed S-NSSAIs along with an indication for each S-NSSAI if it is a default S-NSSAI. | | +| allowedNssaiCurrentAccess | AllowedNssai | O | 0..1 | This IE may be included during UE configuration update procedure in 5GS. When present, this IE shall contain the list of allowed S-NSSAIs in the AMF for the current access type of the UE. | | +| allowedNssaiOtherAccess | AllowedNssai | O | 0..1 | This IE may be included during UE configuration update procedure in 5GS. When present, this IE shall contain the list of allowed S-NSSAIs in the AMF for the other access type of the UE. | | +| defaultConfiguredSnssaiInd | boolean | O | 0..1 | This IE may be present if the UE included the Default Configured NSSAI Indication during the recent Registration procedure. | | +| requestedNssai | array(SNSSAI) | O | 1..N | This IE may contain the set of S-NSSAIs requested by the UE in the recent registration procedure, it shall be the S-NSSAIs in hPLMN in non-roaming scenario, or the S-NSSAIs in vPLMN in LBO/HR roaming scenario. | | +| mappingOfNssai | array(MappingOfSnssai) | O | 1..N | This IE may be present when the network slice information is requested during UE configuration update procedure in roaming scenarios. If present, this IE shall contain the mapping of S-NSSAI of the VPLMN to corresponding HPLMN S-NSSAI, for the S-NSSAIs included in the requestedNssai and the allowedNssai IEs for the current and other access types. | | +| ueSupNssrgInd | boolean | C | 0..1 | This IE shall be present in the request towards an NSSF in the serving PLMN when UE has indicated the support of NSSRG feature. When present, this IE shall contain the indication of UE support of subscription-based restrictions to simultaneous registration of network slice feature.
This IE shall be set as follows:
- true: the UE supports NSSRG feature
- false: the UE does not support NSSRG feature. | | +| suppressNssrgInd | boolean | O | 0..1 | When present, this IE shall contain the UDM indication to provide all subscribed S-NSSAIs for UEs not indicating support of subscription-based restrictions to simultaneous registration of network slices. This IE may be present and set to true if the ueSupNssrgInd is set to false.

This IE shall be set as follows:
- true: UDM Indication to suppress NSSRG is present and set to TRUE
- false: UDM Indication to suppress NSSRG is set to FALSE or not present | | +| rejectedNssaiR | array(SNSSAI) | O | 1..N | This IE may be present when the UE is needed to be redirected to the dedicated frequency band(s) for an S-NSSAI (as specified in clause 5.3.4.3.3 of 3GPP TS 23.501 [2]).

When present, this IE shall indicate the rejected S-NSSAI(s) of the Registration Area. | TargetNssai | + +| | | | | | | +|---------------|---------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| nsagSupported | boolean | C | 0..1 | This IE shall be present if the UE has indicated support of NSAG in the 5GMM procedure.

true: the UE supports NSAG.
false (default): the UE does not support NSAG. | | +|---------------|---------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +##### 6.1.6.2.14 Type: NsagInfo + +**Table 6.1.6.2.14-1: Definition of type NsagInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| nsagIds | array(NsagId) | M | 1..N | The list of NSAG IDs, see 3GPP TS 38.413 [21] | +| snssaiList | array(Snssai) | M | 1..N | This attribute contains the S-NSSAI(s) which are associated with the NSAGs identified by the nsagIds. | +| tailList | array(Tai) | O | 1..N | This attribute indicates the TA(s) within which the association between the NSAGs identified by the nsagIds and the S-NSSAI(s) is valid.
(NOTE) | +| tailRangeList | array(TaiRange) | O | 1..N | This attribute indicates the TA(s) within which the association between the NSAGs identified by the nsagIds and the S-NSSAI(s) is valid.
(NOTE) | +| NOTE: The absence of both tailList and tailRangeList attributes means the association between the NSAGs identified by the nsagIds and the S-NSSAI(s) is valid across the PLMN | | | | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|--------------------------------------------------| +| NsId | string | Represents the Network Slice Instance Identifier | + +##### 6.1.6.3.3 Enumeration: RoamingIndication + +**Table 6.1.6.3.3-1: Enumeration RoamingIndication** + +| Enumeration value | Description | +|---------------------|----------------------------------------------------------------------------------------| +| NON_ROAMING | This value indicates that the UE is not roaming. | +| LOCAL_BREAKOUT | This value indicates that the UE is roaming but is using a local breakout PDU session. | +| HOME_ROUTED_ROAMING | This value indicates that the UE is roaming and is using a home routed PDU session. | + +#### 6.1.6.4 Binary data + +There is no binary data used for the Nnssf\_NSSelection service in this version of the API. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nnssf\_NSSelection service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nnssf\_NSSelection service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------|------------------|-----------------------------------------------------------------------------------------------------------------------| +| SNSSAI_NOT_SUPPORTED | 403 Forbidden | This cause value shall be set when the requested slice selection information is for SNSSAI(s) not supported. | +| NOT_AUTHORIZED | 403 Forbidden | The request is rejected due to the NF service consumer is not authorized to retrieve the slice selection information. | + +### 6.1.8 Feature negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the NSSF and the NF Service Consumer, for the Nnssf\_NSSelection service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Nnssf\_NSSelection service, if any, by including the supportedFeatures attribute in the HTTP GET request when requesting the NSSF to provide the Allowed NSSAI information. + +The NSSF shall determine the supported features for the requested network slice information resource as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in the Allowed NSSAI information it returns in the HTTP response. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [7]. + +The following features are defined for the Nnssf\_NSSelection service. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Nnssf\_NSSelection service** + +| Feature Number | Feature | M/O | Description | +|----------------|-------------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Nnssf_NSSelection service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | TargetNssai | O | Target NSSAI

An NF Service Consumer (e.g. AMF) and NSSF that supports this feature shall support handling of Target NSSAI as specified in clause 5.3.4.3.3 and clause 5.15.5.2.1 of 3GPP TS 23.501 [2]. | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [4], the access to the Nnssf\_NSSelection API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnssf\_NSSelection API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnssf\_NSSelection service. + +The Nnssf\_NSSelection API does not define any scopes for OAuth2 authorization. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different NSSF service instance, within the same NSSF or a different NSSF of an NSSF set, e.g. when an NSSF service instance is part of an NSSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different NSSF producer instance will return the NF Instance ID of the new NSSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSSF within an NSSF set redirects a service request to a different NSSF of the set using a 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nnssf\_NSSAIAvailability Service API + +### 6.2.1 API URI + +The Nnssf\_NSSAIAvailability service shall use the Nnssf\_NSSAIAvailability API. + +The API URI of the Nnssf\_NSSAIAvailability API shall be: + +**{apiRoot}/nnssf- nssaiavailability/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}/nnssf- nssaiavailability//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 9113 [10], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +An OpenAPI [6] specification of HTTP messages and content bodies for the Nnssf\_NSSAIAvailability service is specified in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +The JSON format shall be supported. The use of JSON format shall be as specified in clause 5.4 of 3GPP TS 29.500 [4]. + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [14], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4]. +- The Problem Details JSON Object (IETF RFC 9457 [15]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- JSON Patch (IETF RFC 6902 [8]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +##### 6.2.2.2.3 Accept-Encoding + +The NSSF should support gzip coding (see IETF RFC 1952 [16]) in HTTP requests and responses and indicate so in the Accept-Encoding header, as described in clause 6.9 of 3GPP TS 29.500 [4]. + +#### 6.2.2.3 HTTP custom headers + +##### 6.2.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnssf\_NSSAIAvailability service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.3.1-1 describes the resource URI structure of the Nnssf\_NSSAIAvailability API. + +![Figure 6.2.3.1-1: Resource URI structure of the Nnssf_NSSAIAvailability API. The diagram shows a hierarchical tree structure starting with ///nssf-nssaiavailability/. The root path is /nssai-availability, which branches into / and /subscriptions. The /subscriptions path further branches into /.](834fb96b114b8fdc001625e1ae28e8b1_img.jpg) + +``` + +graph TD + Root["///nssf-nssaiavailability/"] --> NssaiAvail["/nssai-availability"] + NssaiAvail --> Nfid["/"] + NssaiAvail --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Nnssf\_NSSAIAvailability API. The diagram shows a hierarchical tree structure starting with ///nssf-nssaiavailability/. The root path is /nssai-availability, which branches into / and /subscriptions. The /subscriptions path further branches into /. + +**Figure 6.2.3.1-1: Resource URI structure of the Nnssf\_NSSAIAvailability API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------------------|----------------------------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NSSAI Availability Store | /nssai-availability | OPTIONS | Discover the communication options supported by the NSSF for this resource. | +| NSSAI Availability Document | /nssai-availability/ | PUT | Updates the NSSF with the S-NSSAIs the NF service consumer (e.g. AMF) supports per TA. | +| | | PATCH | Updates the NSSF with the S-NSSAIs the NF service consumer (e.g. AMF) supports per TA. | +| | | DELETE | Delete the resource of the S-NSSAIs supported per TA by the NF service consumer (e.g. AMF) | +| NSSAI Availability Notification Subscriptions Collection | /nssai-availability/subscriptions | POST | Create a subscription to the notification of any changes to the NSSAI availability information, Network Slice Replacement or Network Slice Instance Replacement. | +| Individual NSSAI Availability Notification Subscriptions | /nssai-availability/subscriptions/ | DELETE | Unsubscribe to the notification of any changes to the NSSAI availability information, Network Slice Replacement or Network Slice Instance Replacement. | +| | | PATCH | Modify a subscription. | + +#### 6.2.3.2 Resource: NSSAI Availability Document + +##### 6.2.3.2.1 Description + +This resource represents a single NSSAI Availability resource. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nssf-nssaiavailability//nssai-availability/{nflId} + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|--------------|-----------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| nflId | NfInstanceId | Represents the Identifier of the AMF for which the NSSAI Availability information is updated. | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 PUT + +This method shall support the request data structures specified in table 6.2.3.2.3.1-1 and the response data structures and response codes specified in table 6.2.3.2.3.1-2. + +**Table 6.2.3.2.3.1-1: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| NssaiAvailabilityInfo | M | 1 | This IE contains the information regarding the NssaiAvailabilityData for the NF Service Consumer (e.g AMF). | + +**Table 6.2.3.2.3.1-2: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizedNssaiAvailabilityInfo | M | 1 | 200 OK | This case represents a successful update of the NSSF with the S-NSSAIs the AMF supports per TA. The authorized NSSAI availability (i.e. S-NSSAIs available per TA (unrestricted) and any S-NSSAIs restricted per PLMN in that TA in the serving PLMN of the UE) information shall be returned in the response content. | +| N/A | | | 204 No Content | This case represents a successful update of the NSSF with the S-NSSAIs the AMF supports per TA, and the authorized NSSAI availability is empty after the update. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | When the NF service consumer is not authorized to update the NSSAI availability information or the TAI/S-NSSAI information provided is not supported in the PLMN, the "cause" attribute shall be set to:
- SNSSAI_NOT_SUPPORTED, if the S-NSSAI provided is not supported in the PLMN.
- NOT_AUTHORIZED, if the NF service consumer identified by the NF Id is not authorized to update the NSSAI availability information.
See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.1-3: Headers supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|---------------------------------------------------| +| Content-Encoding | string | O | 0..1 | Content-Encoding, described in IETF RFC 9110 [18] | + +**Table 6.2.3.2.3.1-4: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|--------------------------------------------------| +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [18] | + +**Table 6.2.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.2.3.2.3.2 PATCH + +This method shall support the request data structures specified in table 6.2.3.2.3.2-1 and the response data structures and response codes specified in table 6.2.3.2.3.2-2. + +**Table 6.2.3.2.3.2-1: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| PatchDocument | M | 1 | This IE contains the information regarding the JSON patch instructions for updating the supportedSnssai(s) in NssaiAvailabilityInfo. | + +**Table 6.2.3.2.3.2-2: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthorizedNssaiAvailabilityInfo | M | 1 | 200 OK | This case represents a successful update of the NSSF with the S-NSSAls the AMF supports per TA.
If the authorized NSSAI availability (i.e. S-NSSAls available per TA (unrestricted) and any S-NSSAls restricted per PLMN in that TA in the serving PLMN of the UE) is changed, the NSSF shall return a data structure of type "AuthorizedNssaiAvailabilityInfo" in the response payload body. | +| N/A | | | 204 No Content | This case represents a successful update of the NSSF with the S-NSSAls the AMF supports per TA, and the authorized NSSAI availability is empty after the update. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | When the NF service consumer is not authorized to update the NSSAI availability information or the S-NSSAI information provided is not supported in the PLMN, the "cause" attribute shall be set to:
- SNSSAI_NOT_SUPPORTED, if the S-NSSAI provided is not supported in the PLMN.
- NOT_AUTHORIZED, if the NF service consumer identified by the NF Id is not authorized to update the NSSAI availability information.
See table 6.2.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application error:
- RESOURCE_NOT_FOUND
See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the NF case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.2.3.2.3.3.3 DELETE + +This method shall support the request data structures specified in table 6.2.3.2.3.3-1 and the response data structures and response codes specified in table 6.2.3.2.3.3-2. + +**Table 6.2.3.2.3.3-1: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.2.3.3-2: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application error:
- RESOURCE_NOT_FOUND
See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.2.3.3-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.3-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.3.3 Resource: NSSAI Availability Notification Subscriptions Collection + +##### 6.2.3.3.1 Description + +This resource represents the collection of NSSAI Availability Notification Subscriptions in the NSSF. + +This resource is modelled with the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nssf-nssaiavailability//nssai-availability/subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 POST + +This method shall support the request data structures specified in table 6.2.3.3.3.1-1 and the response data structures and response codes specified in table 6.2.3.3.3.1-2. + +**Table 6.2.3.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------|---|-------------|-------------------------------------------------------------------------------| +| NssfEventSubscriptionCreateData | M | 1 | This IE contains the information of an NSSF Event Subscription to be created. | + +**Table 6.2.3.3.3.1-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NssfEventSubscriptionCreatedData | M | 1 | 201 Created | This case represents a successful creation of an NSSF Event subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if this is a redirection triggered by an SCP to the same target resource via another SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application error:
- NOT_AUTHORIZED
See table 6.2.7.3-1 for the description of these errors. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.3.3.1-3: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nssf-nssaiavailability//nssai-availability/subscriptions/{subscriptionId} | + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.3.4 Resource: Individual NSSAI Availability Notification Subscriptions + +##### 6.2.3.4.1 Description + +This resource represents an Individual NSSAI Availability Notification Subscriptions resources generated by the NSSF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nssf-nssaiavailability/{apiVersion}/nssai-availability/subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.4.2-1. + +**Table 6.2.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| subscriptionId | string | Represents the Identifier of the subscription. | + +##### 6.2.3.4.3 Resource Standard Methods + +###### 6.2.3.4.3.1 DELETE + +This method shall support the request data structures specified in table 6.2.3.4.3.1-1 and the response data structures and response codes specified in table 6.2.3.4.3.1-2. + +**Table 6.2.3.4.3.1-1: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| N/A | | | | + +**Table 6.2.3.4.3.1-2: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------| +| N/A | | | 204 No Content | This case represents a successful deletion of the subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | This represents the case when the subscription resource is unavailable. | + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.4.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.4.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.2.3.4.3.2 PATCH + +This method shall support the request data structures specified in table 6.2.3.4.3.2-1 and the response data structures and response codes specified in table 6.2.3.4.3.2-2. + +**Table 6.2.3.4.3.2-1: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| PatchDocument | M | 1 | This IE contains the information regarding the JSON patch instructions for updating the NssfEventSubscriptionCreateData. | + +**Table 6.2.3.4.3.2-2: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NssfEventSubscriptionCreatedData | M | 1 | 200 OK | This case represents a successful update of the subscription. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND. | + +NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.2.3.5 Resource: NSSAI Availability Store + +##### 6.2.3.5.1 Description + +This resource represents a collection of NSSAI Availability resources. + +This resource is modelled with the Store resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nssf-nssaiavailability//nssai-availability + +This resource shall support the resource URI variables defined in table 6.2.3.5.2-1. + +**Table 6.2.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +##### 6.2.3.5.3 Resource Standard Methods + +###### 6.2.3.5.3.1 OPTIONS + +This method queries the communication options supported by the NSSF (see clause 6.9 of 3GPP TS 29.500 [4]). This method shall support the URI query parameters specified in table 6.1.3.5.3.1-1. + +**Table 6.2.3.5.3.1-1: URI query parameters supported by the OPTIONS method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.5.3.1-2 and the response data structures and response codes specified in table 6.2.3.5.3.2-3. + +**Table 6.2.3.5.3.1-2: Data structures supported by the OPTIONS Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.3.1-3: Data structures supported by the OPTIONS Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------| +| n/a | | | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 405 Method Not Allowed | | +| ProblemDetails | O | 0..1 | 501 Not Implemented | | + +NOTE 1: The mandatory HTTP error status codes for the OPTIONS method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.3.5.3.1-4: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|--------------------------------------------------| +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [18] | + +**Table 6.2.3.5.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.5.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSSF or NSSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources for the Nnssf\_NSSAIAvailability service in this version of the API. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause specifies the notifications provided by the Nnssf\_NSSAIAvailability service. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|--------------------------|---------------------------------|---------------------------------| +| NSSAI Availability Notification | {nfNssaiAvailabilityUri} | POST | | + +#### 6.2.5.2 NSSAI Availability Notification + +##### 6.2.5.2.1 Description + +If the NF Service Consumer (e.g. AMF or V-NSSF) has provided the callback URI for getting notified about the NSSAI availability information, Network Slice Replacement or Network Slice Instance Replacement, the NSSF shall notify the NF Service Consumer whenever the NSSAI availability information, Network Slice Replacement or Network Slice Instance Replacement is updated. + +##### 6.2.5.2.2 Notification Definition + +Callback URI: {nfNssaiAvailabilityUri} + +This callback URI is provided by the NF Service Consumer (e.g. AMF or V-NSSF) during subscription creation invoked by the NF Service Consumer. + +Table 6.2.5.2.2-1: Resources and methods overview + +| Resource name | Callback URI | HTTP method or custom operation | Description | +|------------------------------------------|--------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NSSAI Availability Notification Callback | {nfNssaiAvailabilityUri} | POST | The NSSF uses this callback URI to Update the AMF with any S-NSSAIs restricted per TA in the serving PLMN of the UE or to notify the Network Slice Replacement or Network Slice Instance Replacement event. | + +##### 6.2.5.2.3 Notification Standard Methods + +###### 6.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2. + +Table 6.2.5.2.3.1-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------------------------| +| NssfEventNotification | M | 1 | Representation of the data to be sent to the NF service consumer (e.g. AMF or V-NSSF). | + +Table 6.2.5.2.3.1-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful handling of notification in the NF service consumer (e.g. AMF or V-NSSF). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. In the former case, the URI shall be an URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. In the former case, the URI shall be an URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | The "cause" attribute may be used to indicate one of the following application errors:
- RESOURCE_CONTEXT_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- RESOURCE_URI_STRUCTURE_NOT_FOUND

See table 6.2.7.3-1 for the description of this error. | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nnsnf\_NSSAIAvailability service based interface protocol. + +**Table 6.2.6.1-1: Nnsnf\_NSSAIAvailability specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|-------------------------------------------------------------------------------------------------| +| NssaiAvailabilityInfo | 6.2.6.2.2 | This contains the Nssai availability information requested by the AMF. | +| SupportedNssaiAvailabilityData | 6.2.6.2.3 | This contains the Nssai availability data information per TA supported by the AMF. | +| AuthorizedNssaiAvailabilityData | 6.2.6.2.4 | This contains the Nssai availability data information per TA authorized by the NSSF | +| RestrictedSnssai | 6.2.6.2.5 | This contains the restricted SNssai information per PLMN. | +| AuthorizedNssaiAvailabilityInfo | 6.2.6.2.6 | This contains the Nssai availability data information authorized by the NSSF | +| PatchDocument | 6.2.6.2.7 | This contains the JSON Patch instructions for updating the subscription at the NSSF. | +| NssfEventSubscriptionCreateData | 6.2.6.2.8 | This contains the information for event subscription. | +| NssfEventSubscriptionCreatedData | 6.2.6.2.9 | This contains the information for created event subscription. | +| NssfEventNotification | 6.2.6.2.10 | This contains the notification for created event subscription. | +| SnssaiReplacementSubscribeInfo | 6.2.6.2.11 | This contains the input requirements for Network Slice Replacement event subscription. | +| NsiUnavailabilitySubscribeInfo | 6.2.6.2.12 | This contains the input requirements for Network Slice Instance Replacement event subscription. | +| NssfEventType | 6.2.6.3.3 | This contains the event for the subscription. | + +Table 6.2.6.1-2 specifies data types re-used by the Nnsnf service based interface protocol from other specifications. + +Table 6.2.6.1-2: Nnssf re-used Data Types + +| Data type | Reference | Comments | +|-------------------|---------------------|----------------------------------------------------------------------------------------| +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features defined in table 6.2.8-1. | +| Snssai | 3GPP TS 29.571 [7] | | +| PatchItem | 3GPP TS 29.571 [7] | Identifies the JSON Patch instructions | +| DateTime | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | | +| ExtSnssai | 3GPP TS 29.571 [7] | | +| NsagId | 3GPP TS 29.571 [7] | Network Slice AS Group ID | +| SnssaiReplaceInfo | 3GPP TS 29.571 [7] | Alternative S-NSSAI information | +| PlmnId | 3GPP TS 29.571 [7] | | +| TaiRange | 3GPP TS 29.510 [13] | | +| NFType | 3GPP TS 29.510 [13] | | +| NsagInfo | 3GPP TS 29.531 | See clause 6.1.6.2.14 | +| NsId | 3GPP TS 29.531 | See clause 6.1.6.3.2 | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: NssaiAvailabilityInfo + +Table 6.2.6.2.2-1: Definition of type NssaiAvailabilityInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|---------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportedNssaiAvailabilityData | array(SupportedNssaiAvailabilityData) | M | 1..N | This IE shall contain the information regarding the S-NSSAIs the NF service consumer (e.g. AMF) and the 5G-AN supports per TA. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported | +| amfSetId | string | O | 0..1 | This IE may be included to indicate the AMF set identifier for the AMFs serving the TAs where the NSSAI is available.
When present, this IE shall be constructed from PLMN-ID (i.e. three decimal digits MCC and two or three decimal digits MNC), AMF Region Id (8 bit), and AMF Set Id (10 bit).

Pattern: '[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}\$' | + +##### 6.2.6.2.3 Type: SupportedNssaiAvailabilityData + +Table 6.2.6.2.3-1: Definition of type SupportedNssaiAvailabilityData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| tai | Tai | M | 1 | This IE shall contain the identifier of the Tracking Area | | +| supportedSnssaiList | array(ExtSnssai) | M | 1..N | This IE shall contain the S-NSSAI(s) supported by the AMF for the TA. | | +| taiList | array(Tai) | O | 1..N | When present, this IE shall contain additional TAs with the same list of supported S-NSSAIs.
(NOTE) | ONSSAI | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain range(s) of TAs with the same list of supported S-NSSAIs.
(NOTE) | ONSSAI | +| nsagInfos | array(NsagInfo) | O | 1..N | When present, this IE shall contain the associations between NSAGs and S-NSSAIs. | | + +NOTE: The taiList IE shall not include the TAI contained in the tai IE. The taiRangeList IE may encompass the TAI contained in the tai IE. + +##### 6.2.6.2.4 Type: AuthorizedNssaiAvailabilityData + +Table 6.2.6.2.4-1: Definition of type AuthorizedNssaiAvailabilityData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tai | Tai | M | 1 | This IE shall contain the identifier of the Tracking Area. | | +| supportedSnssaiList | array(ExtSnssai) | M | 1..N | This IE shall contain the S-NSSAI(s) supported by the AMF and 5G-AN and authorized by the NSSF for the TA. | | +| restrictedSnssaiList | array(RestrictedSnssai) | O | 1..N | This IE may contain the restricted S-NSSAI(s) per PLMN for the TA. If the restricted S-NSSAI is not present, the S-NSSAIs indicated in supportedSnssaiList are not restricted in this TA for any PLMN. When present, this IE shall be included only by the NSSF. | | +| taiList | array(Tai) | O | 1..N | When present, this IE shall contain additional TAs with the same lists of supported and restricted S-NSSAIs.
(NOTE) | ONSSAI | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain range(s) of TAs with the same lists of supported and restricted S-NSSAIs.
(NOTE) | ONSSAI | +| nsagInfos | array(NsagInfo) | O | 1..N | When present, this IE shall contain the associations between NSAGs and S-NSSAIs. | | + +NOTE: The taiList IE shall not include the TAI contained in the tai IE. The taiRangeList IE may encompass the TAI contained in the tai IE. + +##### 6.2.6.2.5 Type: RestrictedSnssai + +Table 6.2.6.2.5-1: Definition of type RestrictedSnssai + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| homePlmnId | PlmnId | M | 1 | This IE shall contain the home PLMN ID of the PLMN with which the serving network has roaming agreement.
This IE shall be ignored if the roamingRestriction is set to "true". | | +| sNssaiList | array(ExtSnssai) | M | 1..N | This IE shall contain the array of restricted S-NSSAIs for the home PLMN Id. | | +| homePlmnIdList | array(PlmnId) | O | 1..N | When present, this IE shall contain additional home PLMN IDs with which the serving network has roaming agreement and with the same list of restricted S-NSSAIs. | ONSSAI | +| roamingRestriction | boolean | O | 0..1 | When present, it shall be set as follows:
- true: the list of restricted S-NSSAIs are applicable to all of the home PLMN IDs with which the serving network has roaming agreement;
- false (default): the list of restricted S-NSSAIs are applicable to part of the home PLMN IDs with which the serving network has roaming agreement as included in the homePlmnId and homePlmnIdList IEs. | ONSSAI | + +##### 6.2.6.2.6 Type: AuthorizedNssaiAvailabilityInfo + +Table 6.2.6.2.6 -1: Definition of type AuthorizedNssaiAvailabilityInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|----------------------------------------|---|-------------|------------------------------------------------------------------------------------------------| +| authorizedNssaiAvailabilityData | array(AuthorizedNssaiAvailabilityData) | M | 1..N | Contains the authorized NSSAI availability information. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported | + +##### 6.2.6.2.7 Type: PatchDocument + +Table 6.2.6.2.7-1: Definition of type PatchDocument + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| N/A | array(PatchItem) | M | 1..N | An array of patch instructions to update the NSSAI availability information or the NssfEventSubscriptionCreateData at the NSSF. See 3GPP TS 29.571 [7]. | + +6.2.6.2.8 Type: NssfEventSubscriptionCreateData + +**Table 6.2.6.2.8-1: Definition of type NssfEventSubscriptionCreateData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfNssaiAvailability
Uri | Uri | M | 1 | Identifies the recipient of notifications sent by the NF service consumer (e.g. AMF, V-NSSF) for this subscription | | +| taiList | array(Tai) | C | 0..N | When present, this IE shall identify the TAIs supported by the NF service consumer (e.g. AMF).
This IE shall be present if the NF Service Consumer subscribes to the SNSSAI_STATUS_CHANGE_REPORT event.
This IE may be absent if the NSSF supports the NSRP feature or the NSIUN feature and the NF service consumer does not subscribe to the SNSSAI_STATUS_CHANGE_REPORT event.
(NOTE) | | +| event | NssfEventType | M | 1 | Describes the event to be subscribed for this subscription. | | +| additionalEvents | array(NssfEventType) | C | 1..N | This IE shall be present if the NSSF supports the NSRP feature or the NSIUN feature and the NF Service Consumer wishes to subscribe to more than one event type. When present, this IE shall indicate the additional event(s) requested to be subscribed. | | +| expiry | DateTime | O | 0..1 | This IE may be included by the NF service consumer. When present, this IE shall represent the suggested UTC time after which the subscription becomes invalid. | | +| amfSetId | string | O | 0..1 | This IE may be included for "SNSSAI_STATUS_CHANGE_REPORT" event, to identify a specific AMF Set for which this subscription applies.

When present, this IE shall be constructed from PLMN-ID (i.e. three decimal digits MCC and two or three decimal digits MNC), AMF Region Id (8 bit), and AMF Set Id (10 bit).

Pattern: '[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}\$' | | +| taiRangeList | array(TaiRange) | O | 1..N | Identifies a list of TAI ranges supported by the NF service consumer (e.g. AMF) to be applied for "SNSSAI_STATUS_CHANGE_REPORT" event.
The NF service consumer shall only include this IE when it knows that the NSSF supports the "ONSSAI" feature.
(NOTE) | ONSSAI | +| amfId | NfInstanceId | O | 0..1 | This IE may be included to indicate the instance identity of the network function creating the subscription for "SNSSAI_STATUS_CHANGE_REPORT" event. | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | | +| allAmfSetTailnd | boolean | O | 0..1 | This IE may be present when amfSetId is present.

When present, this IE shall indicate whether the subscription is for all TAIs of the AMF set:
- true: all TAIs of the AMF Set is subscribed.
- false (default): indicated TAIs (in the tailList IE and/or taiRangeList IE) are subscribed. | SATAS | +| nsrpSubscribeInfo | SnsaiReplacementSubscribeInfo | C | 0..1 | This IE shall be present when the NF Service Consumer subscribes to the Network Slice Replacement event. | | +| nsiunSubscribeInfo | NsiUnavailabilitySubscribeInfo | C | 0..1 | This IE shall be present when the NF Service Consumer subscribes to the Network Slice Instance Replacement event. | | +| NOTE: For event "SNSSAI_STATUS_CHANGE_REPORT", the tailList attribute shall only be set to an empty array if the NSSF supports the "ONSSAI" feature and taiRangeList IE is present, or if the NSSF supports the "SATAS" feature and the allAmfSetTailnd IE is present with value true. A NF service consumer (e.g. AMF) may provide both taiRangeList and tailList attributes, to carry individual TAI(s) in the tailList attribute and ranges of TAIs in the taiRangeList attribute. | | | | | | + +##### 6.2.6.2.9 Type: NssfEventSubscriptionCreatedData + +**Table 6.2.6.2.9-1: Definition of type NssfEventSubscriptionCreatedData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|----------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscriptionId | string | M | 1 | Identifies the subscription Id for the created subscription. | +| expiry | DateTime | C | 0..1 | This IE shall be included, if, based on operator policy and taking into account the expiry time included in the request, the NSSF needs to include an expiry time. When present, it represents the UTC time after which the subscribed event shall stop generating report and the subscription becomes invalid. Upon reaching this expiry time the NF service consumer shall delete the representation of the subscription it may have. | +| authorizedNssaiAvailabilityData | array(AuthorizedNssaiAvailabilityData) | O | 1..N | This IE may be included if the NF Service Consumer requested to subscribe to changes in the status of NSSAI availability information and if the authorized NSSAI availability (i.e. S-NSSAIs available per TA (unrestricted) and any S-NSSAIs restricted per PLMN in that TA in the serving PLMN of the UE) is available. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | + +##### 6.2.6.2.10 Type: NssfEventNotification + +Table 6.2.6.2.10-1: Definition of type NssfEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Indicates which subscription generated event notification.

This parameter is generated by NSSF and returned in "Location" header in HTTP responses. This can be useful if a NF use a common call-back URI for multiple subscriptions. | | +| authorizedNssaiAvailabilityData | array(AuthorizedNssaiAvailabilityData) | C | 0..N | This IE shall be present for a notification of changes in the status of the NSSAI availability information. When present, this IE shall contain the authorized NSSAI availability information for all TAs the AMF subscribed to. Each element shall contain the current status of the list of S-NSSAI available in a TA and the list of S-NSSAI restricted per PLMN in that TA.

The NF Service Consumer shall replace any authorizedNssaiAvailabilityData received earlier by the new authorizedNssaiAvailabilityData received in the notification.

When no supported S-NSSAIs authorized by the NSSF for all TAs, this IE shall contain an empty array indicating Authorized NSSAI Availability information is empty. When received this IE with empty array, the NF Service Consumer shall remove any locally stored authorizedNssaiAvailabilityData previously received from NSSF. (NOTE) | | +| altNssai | array(SnssaiReplaceInfo) | C | 1..N | The IE shall be present for a notification of Network Slice Replacement. When present, this IE shall indicate the impacted S-NSSAIs if one or more of S-NSSAIs availability status changed from available to not available and vice versa, and the current status for each reported S-NSSAI.

This IE may contain the alternative S-NSSAI per impacted S-NSSAI for the S-NSSAIs that are reported as being not available. See clause 5.15.19 in 3GPP TS 23.501 [2]. | NSRP | +| unavailableNsList | array(NsId) | C | 1..N | This IE shall be present for a of Network Slice Instance Replacement. When present, this IE shall indicate the NSI IDs for which the status has changed (e.g., that are congested or no longer available). | NSIUN | +| NOTE: | For event "SNSSAI_STATUS_CHANGE_REPORT", the NSSF shall only send notification with empty array to NF Service Consumer previously indicated support of "EANAN" feature, when there is no supported S-NSSAIs authorized by the NSSF for all TAs. | | | | | + +##### 6.2.6.2.11 Type: SnssaiReplacementSubscribeInfo + +Table 6.2.6.2.11-1: Definition of type SnssaiReplacementSubscribeInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssaiToSubscribe | array(SNSSAI) | M | 0..N | This IE shall indicate the S-NSSAIs for which notification is requested during Network Slice Replacement.

In the case of roaming it shall indicate:
- the VPLMN S-NSSAIs for which notification is requested in case of Network Slice Replacement; or
- the HPLMN S-NSSAIs for which notification is requested in case of Network Slice Replacement.
(NOTE) | +| nfType | NFType | M | 1 | This IE shall contain the NF type of the NF service consumer. | +| nfId | NFInstanceId | M | 1 | This IE shall contain the NF identifier of the NF service consumer. | +| plmnId | PlmnId | C | 0..1 | This IE shall be present in roaming scenarios, if the indicated S-NSSAI is an HPLMN S-NSSAI. It may be present otherwise. When present, it shall indicate the PLMN ID of the S-NSSAI. | +| NOTE: The snssaiToSubscribe attribute shall be set to an empty array for a Network Slice Replacement subscription applying to all S-NSSAIs. | | | | | + +##### 6.2.6.2.12 Type: NsiUnavailabilitySubscribeInfo + +Table 6.2.6.2.12-1: Definition of type NsiUnavailabilitySubscribeInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nsiToSubscribe | array(NsiId) | O | 0..N | When present, this IE shall indicate the identifier of the Network Slice Instance(s) for which notifications are requested in case the status of the NSI changes (e.g., becomes congested or no longer available).
(NOTE 1) (NOTE 3) | +| snssaiToSubscribe | array(SNSSAI) | O | 0..N | When present, this IE shall indicate the identifier of the S-NSSAI related to the NSI for which notifications shall be invoked in case the NSI becomes congested or no longer available.(NOTE 2) (NOTE 3) | +| NOTE 1: The nsiToSubscribe attribute shall be set to an empty array for a Network Slice Instance Replacement subscription applying to all NSIs. | | | | | +| NOTE 2: The snssaiToSubscribe attribute shall be set to an empty array for a Network Slice Instance Replacement subscription applying to all S-NSSAIs. | | | | | +| NOTE 3: At least one of the nsiToSubscribe IE or snssaiToSubscribe IE shall be present. | | | | | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | +|-----------|---------------------------------------------------------------------|-------------| +| | | | + +##### 6.2.6.3.3 Enumeration: NssfEventType + +**Table 6.2.6.3.3-1: Enumeration NssfEventType** + +| Enumeration value | Description | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "SNSSAI_STATUS_CHANGE_REPORT" | A NF subscribes to this event to receive the status change about the current S-NSSAI available (i.e unrestricted) per TA and the status change about the list of restricted S-NSSAI per TA and per PLMN in the serving PLMN of the UE. | +| "SNSSAI_REPLACEMENT_REPORT" | A NF subscribes to this event to receive a replacement S-NSSAI for each impacted S-NSSAI. See clause 5.15.19 of 3GPP TS 23.501 [2]. | +| "NSI_UNAVAILABILITY_REPORT" | A NF subscribes to this event to receive the list of unavailable NSIs (e.g., due to overload). See clause 5.15.20 of 3GPP TS 23.501 [2]. | + +#### 6.2.6.4 Binary data + +There is no binary data used for the Nnssf\_NSSAIAvailability service in this version of the API. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.2.7.2 Protocol Errors + +Protocol Error Handling shall be supported as specified in clause 5.2.7.2 of 3GPP TS 29.500 [4]. + +#### 6.2.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nnssf\_NSSAIAvailability service. The following application errors listed in Table 6.1.7.3-1 are specific for the Nnssf\_NSSAIAvailability service. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_CONTEXT_NOT_FOUND | 400 Bad Request | Indicates that the NF Service Consumer (e.g. AMF) received a notification request from NSSF on an existing callback URI, but the corresponding context does not exist at the NF Service Consumer. | +| SNSSAI_NOT_SUPPORTED | 403 Forbidden | The request is rejected due to the SNSSAI provided in the request is not supported in the PLMN. | +| NOT_AUTHORIZED | 403 Forbidden | The request is rejected due to the NF service consumer is not authorized to update the NSSAI availability information, or subscribe for the NSSAI availability information notification. | +| RESOURCE_NOT_FOUND | 404 Not Found | The request is rejected due to the NF service consumer is authorized, but the resource related to the NF Id for which the NSSAI availability information is updated or deleted is unavailable. | +| SUBSCRIPTION_NOT_FOUND | 404 Not Found | Indicates the modification of subscription has failed due to an application error when the subscription is not found in the NSSF. | +| RESOURCE_URI_STRUCTURE_NOT_FOUND | 404 Not Found | Indicates that the NF Service Consumer (e.g. AMF) received a notification request from NSSF on a callback URI that is not known to the NF Service Consumer. | + +### 6.2.8 Feature negotiation + +The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the NSSF and the NF Service Consumer, for the Nnssf\_NSSAIAvailability service, if any. + +The NF Service Consumer shall indicate the optional features it supports for the Nnssf\_NSSAIAvailability service, if any, by including the supportedFeatures attribute in the HTTP PUT request when requesting the NSSF to update the NSSAI Availability information. + +The NSSF shall determine the supported features for the updated NSSAI Availability information resource as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in the authorized NSSAI availability information it returns in the HTTP response. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [7]. + +The following features are defined for the Nnssf\_NSSAIAvailability service. + +**Table 6.2.8-1: Features of supportedFeatures attribute used by Nnsf\_NSSAIAvailability service** + +| Feature Number | Feature | M/O | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ONSSAI | O | Optimized NSSAI Availability Data encoding

When this feature is supported:
- NSSAI Availability data may be signalled per list or range(s) of TAIs (see clauses 6.2.6.2.3 and 6.2.6.2.4); and
- RestrictedSnssai may encode a list of Home PLMN IDs or may be applicable to all of the Home PLMN IDs (see clause 6.2.6.2.5).
- NSSF event subscription may encode a list of TAI ranges (see clause 6.2.6.2.8). | +| 2 | SUMOD | O | Subscription Modification in Subscribe Service Operation

When this feature is supported, the subscription of NSSAI availability information is supported to be modified (see clause 5.3.2.3.2). | +| 3 | EANAN | O | Empty Authorized NSSAI Availability Notification

A NSSF supporting this feature shall send a notification to NF consumer (as subscriber) with empty array of Authorized NSSAI Availability Data, when no supported NSSAI Authorized by the NSSF for all TAs after latest update and the NF consumer indicated support of this feature.

A NF Consumer support this feature shall accept empty array of Authorized NSSAI Availability Data in a notification from NSSF and delete locally stored Authorized NSSAI Availability Data previously received. | +| 4 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Nnsf_NSSAIAvailability service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 5 | SATAS | O | Subscribe ALL TAIs for AMF Set

A NSSF supporting this feature shall support the NF Consumer to subscribe to all TAI(s) for an AMF set. | +| 6 | NSIUN | O | Network Slice Instance Unavailability Notification

An NF Service Consumer (e.g., AMF, V-NSSF) and NSSF supporting this feature shall support notifications from the NSSF to the NF Service Consumer about the unavailability of Network Slice Instances, as specified in clause 5.15.5.3 of 3GPP TS 23.501 [2]. | +| 7 | NSRP | O | Network Slice Replacement

An NF service consumer (e.g., AMF, V-NSSF) that supports this feature shall support network slice replacement as specified in clause 5.15.19 of 3GPP TS 23.501 [2]. | +| Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1).
Feature: A short name that can be used to refer to the bit and to the feature.
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature. | | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [11] and 3GPP TS 29.500 [4], the access to the Nnsf\_NSSAIAvailability API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [12]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [13]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnssf\_NSSAIAvailability API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [13], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnssf\_NSSAIAvailability service. + +The Nnssf\_NSSAIAvailability API does not define any scopes for OAuth2 authorization. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different NSSF service instance, within the same NSSF or a different NSSF of an NSSF set, e.g. when an NSSF service instance is part of an NSSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.2.8. + +An SCP that reselects a different NSSF producer instance will return the NF Instance ID of the new NSSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSSF within an NSSF set redirects a service request to a different NSSF of the set using a 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nnssf\_NSSelection service. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## --- A.2 Nnssf\_NSSelection API + +openapi: 3.0.0 + +``` + +info: + version: '2.3.0-alpha.2' + title: 'NSSF NS Selection' + description: | + NSSF Network Slice Selection Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +security: +- {} +- oAuth2ClientCredentials: + - nnssf-nsselection +servers: +- url: '{apiRoot}/nnssf-nsselection/v2' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +externalDocs: + description: 3GPP TS 29.531 V18.2.0; 5G System; Network Slice Selection Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.531/ +paths: + /network-slice-information: + get: + summary: Retrieve the Network Slice Selection Information + tags: + - Network Slice Information (Document) + operationId: NSSelectionGet + parameters: + - name: nf-type + in: query + description: NF type of the NF service consumer + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - name: nf-id + in: query + description: NF Instance ID of the NF service consumer + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +``` + +``` + +- name: slice-info-request-for-registration + in: query + description: Requested network slice information during Registration procedure + content: + application/json: + schema: + $ref: '#/components/schemas/SliceInfoForRegistration' +- name: slice-info-request-for-pdu-session + in: query + description: Requested network slice information during PDU session establishment +procedure + content: + application/json: + schema: + $ref: '#/components/schemas/SliceInfoForPDUSession' +- name: slice-info-request-for-ue-cu + in: query + description: Requested network slice information during UE configuration update procedure + content: + application/json: + schema: + $ref: '#/components/schemas/SliceInfoForUEConfigurationUpdate' +- name: home-plmn-id + in: query + description: PLMN ID of the HPLMN + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: tai + in: query + description: TAI of the UE + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: supported-features + in: query + description: Features required to be supported by the NFs in the target slice instance + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +responses: + '200': + description: OK (Successful Network Slice Selection) + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedNetworkSliceInfo' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +components: + securitySchemes: + +``` + +``` + +oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + - nnsf-nsselection: Access to the Nnssf_NSSelection API +schemas: + AuthorizedNetworkSliceInfo: + description: Contains the authorized network slice information + type: object + properties: + allowedNssaiList: + type: array + items: + $ref: '#/components/schemas/AllowedNssai' + minItems: 1 + configuredNssai: + type: array + items: + $ref: '#/components/schemas/ConfiguredSnssai' + minItems: 1 + targetAmfSet: + type: string + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' + candidateAmfList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + rejectedNssaiInPlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + rejectedNssaiInTa: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + nsiInformation: + $ref: '#/components/schemas/NsiInformation' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nrfAmfSet: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfAmfSetNfMgtUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfAmfSetAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfOAuth2Required: + type: object + description: > + Map indicating whether the NRF requires Oauth2-based authorization for accessing + its services. The key of the map shall be the name of an NRF service, + e.g. "nnrf-nfm" or "nnrf-disc" + additionalProperties: + type: boolean + minProperties: 1 + targetAmfServiceSet: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + targetNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + nsagInfos: + type: array + items: + $ref: '#/components/schemas/NsagInfo' + minItems: 1 + + SubscribedSnssai: + description: Contains the subscribed S-NSSAI + type: object + required: + - subscribedSnssai + properties: + +``` + +``` + + subscribedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + defaultIndication: + type: boolean + subscribedNsSrgList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsSrg' + minItems: 1 + +AllowedSnssai: + description: > + Contains the authorized S-NSSAI and optional mapped home S-NSSAI and + network slice instance information + type: object + required: + - allowedSnssai + properties: + allowedSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsiInformationList: + type: array + items: + $ref: '#/components/schemas/NsiInformation' + minItems: 1 + mappedHomeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +AllowedNssai: + description: > + Contains an array of allowed S-NSSAI that constitute the allowed NSSAI information + for the authorized network slice information + type: object + required: + - allowedSnssaiList + - accessType + properties: + allowedSnssaiList: + type: array + items: + $ref: '#/components/schemas/AllowedSnssai' + minItems: 1 + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + +NsiInformation: + description: > + Contains the API URIs of NRF services to be used to discover NFs/services, + subscribe to NF status changes and/or request access tokens within the selected + Network Slice instance and optional the Identifier of the selected Network Slice instance + type: object + required: + - nrfId + properties: + nrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nsiId: + $ref: '#/components/schemas/NsiId' + nrfNfMgtUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nrfOAuth2Required: + type: object + description: > + Map indicating whether the NRF requires OAuth2-based authorization for accessing + its services. The key of the map shall be the name of an NRF service, + e.g. "nnrf-nfm" or "nnrf-disc" + additionalProperties: + type: boolean + minProperties: 1 + +MappingOfSnssai: + description: Contains the mapping of S-NSSAI in the serving network and the value of the home +network + type: object + required: + +``` + +``` + +- servingSnssai +- homeSnssai +properties: + servingSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + homeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +``` + +### **SliceInfoForRegistration:** + +``` + +description: Contains the slice information requested during a Registration procedure +type: object +properties: + subscribedNssai: + type: array + items: + $ref: '#/components/schemas/SubscribedSnssai' + minItems: 1 + allowedNssaiCurrentAccess: + $ref: '#/components/schemas/AllowedNssai' + allowedNssaiOtherAccess: + $ref: '#/components/schemas/AllowedNssai' + sNssaiForMapping: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + requestedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + defaultConfiguredSnssaiInd: + type: boolean + default: false + mappingOfNssai: + type: array + items: + $ref: '#/components/schemas/MappingOfSnssai' + minItems: 1 + requestMapping: + type: boolean + ueSupNsrgInd: + type: boolean + suppressNsrgInd: + type: boolean + nsagSupported: + type: boolean + default: false + +``` + +### **SliceInfoForPDUSession:** + +``` + +description: Contains the slice information requested during PDU Session establishment procedure +type: object +required: +- sNssai +- roamingIndication +properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + roamingIndication: + $ref: '#/components/schemas/RoamingIndication' + homeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +``` + +### **SliceInfoForUEConfigurationUpdate:** + +``` + +description: Contains the slice information requested during UE configuration update procedure +type: object +properties: + subscribedNssai: + type: array + items: + $ref: '#/components/schemas/SubscribedSnssai' + minItems: 1 + allowedNssaiCurrentAccess: + $ref: '#/components/schemas/AllowedNssai' + allowedNssaiOtherAccess: + $ref: '#/components/schemas/AllowedNssai' + +``` + +``` + +defaultConfiguredSnssaiInd: + type: boolean +requestedNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +mappingOfNssai: + type: array + items: + $ref: '#/components/schemas/MappingOfSnssai' + minItems: 1 +ueSupNssrgInd: + type: boolean +suppressNssrgInd: + type: boolean +rejectedNssaiRa: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +nsagSupported: + type: boolean + default: false + +ConfiguredSnssai: + description: Contains the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN and + optional mapped home S-NSSAI + type: object + required: + - configuredSnssai + properties: + configuredSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + mappedHomeSnssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +NsagInfo: + description: Contains the association of NSAGs and S-NSSAI(s) along with the TA(s) within + which the association is valid. + type: object + required: + - nsagIds + - snssaiList + properties: + nsagIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsagId' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + +RoamingIndication: + description: Contains the indication on roaming + anyOf: + - type: string + enum: + - NON_ROAMING + - LOCAL_BREAKOUT + - HOME_ROUTED_ROAMING + - type: string + +NsiId: + description: Contains the Identifier of the selected Network Slice instance + type: string + +``` + +## A.3 Nnssf\_NSSAIAvailability API + +``` + +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.5' + title: 'NSSF NSSAI Availability' + description: | + NSSF NSSAI Availability Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + security: + - {} + - oAuth2ClientCredentials: + - nnssf-nssaiavailability + servers: + - url: '{apiRoot}/nnssf-nssaiavailability/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + externalDocs: + description: 3GPP TS 29.531 V18.5.0; 5G System; Network Slice Selection Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.531/ + paths: + /nssai-availability/{nfId}: + put: + summary: Updates/replaces the NSSF with the S-NSSAIs the NF service consumer (e.g AMF) supports per TA + tags: + - NF Instance ID (Document) + operationId: NSSAIAvailabilityPut + parameters: + - name: nfId + in: path + description: Identifier of the NF service consumer instance + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Parameters to update/replace at the NSSF, the S-NSSAIs supported per TA + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NssaiAvailabilityInfo' + responses: + '200': + description: OK (Successful update of SNSSAI information per TA) + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedNssaiAvailabilityInfo' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + +``` + +``` + + description: No Content (No supported slices after Successful update) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +patch: + summary: Updates an already existing S-NSSAIs per TA provided by the NF service consumer (e.g +AMF) + tags: + - NF Instance ID (Document) + operationId: NSSAIAvailabilityPatch + parameters: + - name: nfId + in: path + description: Identifier of the NF service consumer instance + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: JSON Patch instructions to update at the NSSF, the S-NSSAIs supported per TA + required: true + content: + application/json-patch+json:: + schema: + $ref: '#/components/schemas/PatchDocument' + + responses: + '200': + description: OK (Successful update of SNSSAI information per TA) + content: + application/json: + schema: + $ref: '#/components/schemas/AuthorizedNssaiAvailabilityInfo' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + +``` + +``` + + '204': + description: No Content (No supported slices after Successful update) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: Deletes an already existing S-NSSAIs per TA provided by the NF service consumer (e.g +AMF) + tags: + - NF Instance ID (Document) + operationId: NSSAIAvailabilityDelete + parameters: + - name: nfId + in: path + description: Identifier of the NF service consumer instance + required: true + schema: + type: string + + responses: + '204': + description: No Content (Successful deletion of SNSSAI information per TA) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + + default: + description: Unexpected error + +/nssai-availability/subscriptions: + +``` + +``` + +post: + summary: Creates subscriptions for notification about updates to NSSAI availability +information + tags: + - Subscriptions (Collection) + operationId: NSSAIAvailabilityPost + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Subscription for notification about updates to NSSAI availability information + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NssfEventSubscriptionCreateData' + callbacks: + nssaiAvailabilityNotification: + '{request.body#/nfNssaiAvailabilityUri}': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NssfEventNotification' + responses: + '204': + description: No Content (successful notification) + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +responses: + '201': + description: Created (Successful creation of subscription for notification) + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/NssfEventSubscriptionCreatedData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnsf-nssaiavailability/{apiVersion}/nssai- +availability/subscriptions/{subscriptionId} + required: true + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/nssai-availability/subscriptions/{subscriptionId}: + delete: + summary: Deletes an already existing NSSAI availability notification subscription + tags: + - Subscription ID (Document) + operationId: NSSAIAvailabilityUnsubscribe + parameters: + - name: subscriptionId + in: path + description: Identifier of the subscription for notification + required: true + schema: + type: string + responses: + '204': + description: No Content (Successful deletion of subscription for NSSAI Availability notification) + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + +``` + +``` + + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + + default: + description: Unexpected error + +patch: + summary: updates an already existing NSSAI availability notification subscription + tags: + - Subscription ID (Document) + operationId: NSSAIAvailabilitySubModifyPatch + parameters: + - name: subscriptionId + in: path + description: Identifier of the subscription for notification + required: true + schema: + type: string + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: JSON Patch instructions to update at the NSSF, the NSSAI availability +notification subscription + required: true + content: + application/json-patch+json:: + schema: + $ref: '#/components/schemas/PatchDocument' + +responses: + '200': + description: OK (Successful update of NSSAI availability notification subscription) + content: + application/json: + schema: + $ref: '#/components/schemas/NssfEventSubscriptionCreatedData' + headers: + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/nssai-availability: + +``` + +``` + +options: + summary: Discover communication options supported by NSSF for NSSAI Availability + operationId: NSSAIAvailabilityOptions + tags: + - NSSAI Availability Store + responses: + '200': + description: OK + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '405': + $ref: 'TS29571_CommonData.yaml#/components/responses/405' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnsf-nssaiavailability: Access to the Nnssf_NSSAIAvailability API + +schemas: + NssaiAvailabilityInfo: + description: This contains the Nssai availability information requested by the AMF + type: object + required: + - supportedNssaiAvailabilityData + properties: + supportedNssaiAvailabilityData: + type: array + items: + $ref: '#/components/schemas/SupportedNssaiAvailabilityData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + amfSetId: + type: string + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' + + SupportedNssaiAvailabilityData: + description: This contains the Nssai availability data information per TA supported by the AMF + type: object + required: + - tai + - supportedSnssaiList + properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + supportedSnssaiList: + +``` + +``` + + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + nsagInfos: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsagInfo' + minItems: 1 + +``` + +### AuthorizedNssaiAvailabilityData: + +description: This contains the Nssai availability data information per TA authorized by the + +### NSSF + +``` + +type: object +required: + - tai + - supportedSnssaiList +properties: + tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + supportedSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + restrictedSnssaiList: + type: array + items: + $ref: '#/components/schemas/RestrictedSnssai' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + nsagInfos: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsagInfo' + minItems: 1 + +``` + +### RestrictedSnssai: + +description: This contains the restricted SNssai information per PLMN + +``` + +type: object +required: + - homePlmnId + - sNssaiList +properties: + homePlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + homePlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + roamingRestriction: + type: boolean + default: false + +``` + +``` + +AuthorizedNssaiAvailabilityInfo: + description: This contains the Nssai availability data information authorized by the NSSF + type: object + required: + - authorizedNssaiAvailabilityData + properties: + authorizedNssaiAvailabilityData: + type: array + items: + $ref: '#/components/schemas/AuthorizedNssaiAvailabilityData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +NssfEventSubscriptionCreateData: + description: This contains the information for event subscription + type: object + required: + - nfNssaiAvailabilityUri + - event + properties: + nfNssaiAvailabilityUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + event: + $ref: '#/components/schemas/NssfEventType' + additionalEvents: + type: array + items: + $ref: '#/components/schemas/NssfEventType' + minItems: 1 + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + amfSetId: + type: string + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{2}-[0-3][A-Fa-f0-9]{2}$' + taiRangeList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TaiRange' + minItems: 1 + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + allAmfSetTaiInd: + type: boolean + default: false + nsrpSubscribeInfo: + $ref: '#/components/schemas/SnssaiReplacementSubscribeInfo' + nsiunSubscribeInfo: + $ref: '#/components/schemas/NsiUnavailabilitySubscribeInfo' + +NssfEventSubscriptionCreatedData: + description: This contains the information for created event subscription + type: object + required: + - subscriptionId + properties: + subscriptionId: + type: string + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + authorizedNssaiAvailabilityData: + type: array + items: + $ref: '#/components/schemas/AuthorizedNssaiAvailabilityData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +NssfEventNotification: + description: This contains the notification for created event subscription + type: object + +``` + +``` + +required: +- subscriptionId +properties: + subscriptionId: + type: string + authorizedNssaiAvailabilityData: + type: array + items: + $ref: '#/components/schemas/AuthorizedNssaiAvailabilityData' + altNssai: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SnssaiReplaceInfo' + minItems: 1 + description: > + Indicate the impacted S-NSSAIs, the current status for each reported S-NSSAI, and + if available the alternative S-NSSAI per impacted S-NSSAI for the S-NSSAIs that are + reported as being not available. + unavailableNsiList: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + + SnssaiReplacementSubscribeInfo: + description: Present if the NF service consumer subscribes to events related to Network Slice + Replacement. + type: object + properties: + snssaiToSubscribe: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + required: + - snssaiToSubscribe + - nfType + - nfId + + NsiUnavailabilitySubscribeInfo: + description: Present if the NF service consumer subscribes to events related to Network Slice + Instance Replacement. + type: object + properties: + nsiToSubscribe: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + snssaiToSubscribe: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + + NssfEventType: + description: This contains the event for the subscription + anyOf: + - type: string + enum: + - SNSSAI_STATUS_CHANGE_REPORT + - SNSSAI_REPLACEMENT_REPORT + - NSI_UNAVAILABILITY_REPORT + - type: string + + PatchDocument: + description: This contains the JSON Patch instructions for updating the Nssai availability + data information at the NSSF + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + +``` + +# --- Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175279 | | | | Initial Draft. | 0.1.0 | +| 2017-10 | CT4#81 | C4-175398 | | | | Implementation of C4-175280 | 0.2.0 | +| 2018-01 | CT4#82 | C4-181394 | | | | Implementation of C4-181240, C4-181242, C4-181244, C4-181355, C4-181356, C4-181357 | 0.3.0 | +| 2018-03 | CT4#83 | C4-182438 | | | | Implementation of C4-182087, C4-182294, C4-182295, C4-182296, C4-182297, C4-182298, C4-182299 | 0.4.0 | +| 2018-03 | CT#79 | CP-180035 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183519 | | | | Implementation of C4-183068, C4-183071, C4-183431, C4-183432, C4-183433 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184631 | | | | Implementation of C4-184602, C4-184023, C4-184024, C4-184025, C4-184026, C4-184603, C4-184527, C4-184528, C4-184604, C4-184632 | 1.2.0 | +| 2018-06 | CT#80 | CP-181108 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182160 | 0001 | 5 | F | Alignment of Nnsf_NSSelection Get service operation with stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182014 | 0002 | 2 | F | Adding NRF corresponding to an AMF set | 15.1.0 | +| 2018-09 | CT#81 | CP-182167 | 0003 | 4 | F | Corrections to NSSF Data Types | 15.1.0 | +| 2018-09 | CT#81 | CP-182063 | 0004 | | F | Corrections to NSSAIAvailability Service Operations | 15.1.0 | +| 2018-09 | CT#81 | CP-182063 | 0005 | 1 | F | Configured NSSAI for HPLMN - Alignment with Stage 2 | 15.1.0 | +| 2018-09 | CT#81 | CP-182063 | 0006 | | F | Correction to NRF Id in NSIInformation | 15.1.0 | +| 2018-09 | CT#81 | CP-182063 | 0007 | | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182063 | 0008 | | F | API version number update | 15.1.0 | +| 2018-12 | CT#82 | CP-183022 | 0009 | | F | Type Definition of AllowedNssai | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0010 | 1 | F | Correction to Slice Information For Registration | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0011 | | F | API Root | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0012 | 3 | F | Common Error Status Codes | 15.2.0 | +| 2018-12 | CT#82 | CP-183148 | 0013 | 2 | F | Array Range Correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0016 | 1 | F | OpenAPI Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0017 | 2 | F | Subscription Lifetime for NSSAI Availability Event Subscription | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0018 | | F | Correction of Resource URI structure | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0019 | | F | Add Delete Service Operation in Nnsf_NSSAIAvailability Service | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0020 | 2 | F | Add the Default Configured NSSAI Indication in Nnsf_NSSelection Service | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0021 | | F | CR 0021 29.531 Rel-15 Resource Uri Correction | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0022 | | F | Correction to NssaiAvailabilityInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0023 | 2 | F | Make OAuth2.0 Optional to Use | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0024 | | F | ExternalDocs | 15.2.0 | +| 2018-12 | CT#82 | CP-183022 | 0025 | | F | API Version | 15.2.0 | +| 2019-03 | CT#83 | CP-190027 | 0026 | 1 | F | Definition of TargetAmfSet | 15.3.0 | +| 2019-03 | CT#83 | CP-190027 | 0027 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190027 | 0029 | | F | Add missing NFTYPE reference in reused data types | 15.3.0 | +| 2019-03 | CT#83 | CP-190027 | 0030 | 2 | F | Clarify the conditions of returning Configured NSSAI. | 15.3.0 | +| 2019-03 | CT#83 | CP-190027 | 0031 | 1 | F | Service operation of Nnsf_NSSelection service during UE configuration update procedure | 15.3.0 | +| 2019-03 | CT#83 | CP-190171 | 0032 | 1 | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191039 | 0033 | 1 | F | Content encodings supported in HTTP requests | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0034 | 4 | F | Add AMFset in NssaiAvailabilityInfo | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0036 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0039 | 1 | F | API URIs of the NRF | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0040 | 1 | F | Subscription to and notification of NSSF events | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0041 | 2 | F | Essential Correction on Application Error returned by NSSF | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0042 | 1 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191039 | 0043 | | F | 3GPP TS 29.531 API version update | 15.4.0 | +| 2019-09 | CT#85 | CP-192111 | 0045 | | F | Essential Correction on AllowedNssai | 15.5.0 | +| 2019-09 | CT#85 | CP-192131 | 0044 | 1 | B | Slice selection during handover from 4G to 5G | 16.0.0 | +| 2019-12 | CT#86 | CP-193048 | 0047 | 1 | B | Subscribed NSSAI from the UDM | 16.1.0 | +| 2019-12 | CT#86 | CP-193044 | 0049 | | F | 3GPP TS 29.531 API version update | 16.1.0 | +| 2020-03 | CT#87 | CP-200039 | 0050 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0051 | 2 | B | Optimized NSSAI Availability Data encoding | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0052 | 3 | B | AMF Service Set ID in Nnsf_NSSelection response | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0053 | 2 | D | Editorial corrections | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0054 | 1 | F | Correction - formatting consistency | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0055 | 2 | B | 29531 CR optionality of ProblemDetails | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0056 | 1 | F | Modifications in the API of Nnsf_NSSAIAvailability service for the support of compression | 16.2.0 | +| 2020-03 | CT#87 | CP-200020 | 0057 | 2 | F | Corrections in the NSSF specification | 16.2.0 | +| 2020-03 | CT#87 | CP-200052 | 0058 | | F | 3GPP TS 29.531 Rel16 API External doc update | 16.2.0 | +| 2020-07 | CT#88 | CP-201058 | 0059 | | F | Storage of YAML files in ETSI Forge | 16.3.0 | + +| | | | | | | | | +|---------|---------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2020-07 | CT#88 | CP-201058 | 0060 | 3 | F | Supported Headers Tables for Request and Response codes | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0061 | 1 | F | Add a new Notifications Overview Table | 16.3.0 | +| 2020-07 | CT#88 | CP-201034 | 0062 | 1 | F | Remaining modifications in the API of Nnssf_NSSAIAvailability service for the support of compression | 16.3.0 | +| 2020-07 | CT#88 | CP-201034 | 0063 | | F | Slice Differentiator Ranges and Wildcard | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0064 | 1 | B | Restricted Snssai for roaming users | 16.3.0 | +| 2020-07 | CT#88 | CP-201034 | 0065 | | F | PATCH Response | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0066 | 1 | F | Data type column in Resource URI variables Table | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0067 | | F | mappingOfNssai IE in SliceInfoForRegistration | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0068 | 1 | F | URI of the Nnssf_NSSelection and Nnssf_NSSAIAvailability Services | 16.3.0 | +| 2020-07 | CT#88 | CP-201058 | 0069 | 1 | F | Error code corrections | 16.3.0 | +| 2020-07 | CT#88 | CP-201326 | 0071 | 1 | F | 29.531 Rel-16 API version and External doc update | 16.3.0 | +| 2020-09 | CT#89 | CP-202090 | 0072 | | F | Essential correction to event SNSSAI STATUS CHANGE REPORT | 16.4.0 | +| 2020-09 | CT#89 | CP-202090 | 0073 | 1 | F | Slice selection based on Load Analytics Information from NWDAF | 16.4.0 | +| 2020-09 | CT#89 | CP-202090 | 0074 | 3 | F | TAI Range List Served by an AMF | 16.4.0 | +| 2020-09 | CT#89 | CP-202090 | 0077 | 1 | F | Request mapping of S-NSSAI | 16.4.0 | +| 2020-09 | CT#89 | CP-202090 | 0078 | 2 | F | Subscription modification | 16.4.0 | +| 2020-09 | CT#89 | CP-202035 | 0080 | 2 | F | Notify Empty Authorized NSSAI Availability | 16.4.0 | +| 2020-09 | CT#89 | CP-202096 | 0081 | | F | 29.531 Rel-16 API version and External doc update | 16.4.0 | +| 2020-12 | CT#90-e | CP-203162 | 0082 | 1 | F | HTTP 3xx redirection | 16.5.0 | +| 2020-12 | CT#90-e | CP-203040 | 0083 | 1 | F | Mapping of S-NSSAIs in HPLMN and VPLMN | 16.5.0 | +| 2020-12 | CT#90-e | CP-203040 | 0084 | 1 | F | Number of allowed S-NSSAIs | 16.5.0 | +| 2020-12 | CT#90-e | CP-203035 | 0085 | | F | Storage of YAML files in 3GPP Forge | 16.5.0 | +| 2020-12 | CT#90-e | CP-203036 | 0086 | | F | API version and External doc update | 16.5.0 | +| 2021-03 | CT#91-e | CP-210043 | 0090 | | F | OpenAPI syntax error | 16.6.0 | +| 2021-03 | CT#91-e | CP-210054 | 0091 | | F | 29.531 Rel-16 API version and External doc update | 16.6.0 | +| 2021-03 | CT#91-e | CP-210034 | 0088 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-03 | CT#91-e | CP-210025 | 0089 | 1 | F | N31 interface between NSSFs | 17.0.0 | +| 2021-06 | CT#92-e | CP-211083 | 0094 | | A | Essential correction on Nssai Availability Document Update | 17.1.0 | +| 2021-06 | CT#92-e | CP-211028 | 0095 | | F | Data Types Descriptions | 17.1.0 | +| 2021-06 | CT#92-e | CP-211059 | 0097 | 1 | F | Redirect Responses | 17.1.0 | +| 2021-06 | CT#92-e | CP-211046 | 0098 | | F | Miscellaneous corrections | 17.1.0 | +| 2021-06 | CT#92-e | CP-211050 | 0100 | | F | 29.531 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93-e | CP-212075 | 0106 | | A | Incorrect references | 17.2.0 | +| 2021-09 | CT#93-e | CP-212052 | 0101 | | F | SNSSAI NOT_SUPPORTED | 17.2.0 | +| 2021-09 | CT#93-e | CP-212030 | 0102 | 3 | B | NSSRG value | 17.2.0 | +| 2021-09 | CT#93-e | CP-212030 | 0103 | 3 | B | Missing indication of UE support of NSSRG functionality in NSSF service | 17.2.0 | +| 2021-09 | CT#93-e | CP-212030 | 0104 | 2 | B | Target NSSAI | 17.2.0 | +| 2021-09 | CT#93-e | CP-212045 | 0107 | 1 | F | NSSAIAvailability Notify | 17.2.0 | +| 2021-09 | CT#93-e | CP-212059 | 0108 | | F | 29.531 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94-e | CP-213085 | 0111 | | B | Indicating possible use of OAuth2 authorization in NSSF response | 17.3.0 | +| 2021-12 | CT#94-e | CP-213085 | 0114 | | F | Corrections to the API URI | 17.3.0 | +| 2021-12 | CT#94-e | CP-213086 | 0112 | 1 | F | Correction on requestedNssai | 17.3.0 | +| 2021-12 | CT#94-e | CP-213086 | 0115 | | F | Notification Errors | 17.3.0 | +| 2021-12 | CT#94-e | CP-213092 | 0110 | 1 | B | UDM indication to provide full set of subscribed S-NSSAIs | 17.3.0 | +| 2021-12 | CT#94-e | CP-213092 | 0113 | 1 | B | Rejected S-NSSAIs for RA in NS Selection | 17.3.0 | +| 2021-12 | CT#94-e | CP-213092 | 0119 | 1 | B | Target NSSAI correction | 17.3.0 | +| 2021-12 | CT#94-e | CP-213092 | 0116 | | F | Configured NSSAI can include S-NSSAIs with different NSSRG values | 17.3.0 | +| 2021-12 | CT#94-e | CP-213113 | 0117 | 1 | F | Configured NSSAI shall be returned by NSSF to AMF during UCU procedure | 17.3.0 | +| 2021-12 | CT#94-e | CP-213113 | 0118 | 1 | F | Clarification on the condition when AMF can retrieve slice mapping information | 17.3.0 | +| 2021-12 | CT#94-e | CP-213121 | 0120 | | F | 29.531 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95-e | CP-220024 | 0126 | | F | Formatting of Description Fields | 17.4.0 | +| 2022-03 | CT#95-e | CP-220087 | 0122 | | F | Correction on ExtSnssai | 17.4.0 | +| 2022-03 | CT#95-e | CP-220087 | 0123 | | F | Adding use case for sending Allowed NSSAI aligned with stage 2 | 17.4.0 | +| 2022-03 | CT#95-e | CP-220092 | 0124 | 1 | D | Capitalize allowed NSSAI and target NSSAI | 17.4.0 | +| 2022-03 | CT#95-e | CP-220066 | 0127 | | F | 29.531 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221033 | 0129 | 1 | F | Redirect or handover the UE to a cell of another TA | 17.5.0 | +| 2022-06 | CT#96 | CP-221029 | 0130 | 2 | F | Clarification on targetAmfSet in AuthorizedNetworkSliceInfo | 17.5.0 | +| 2022-06 | CT#96 | CP-221055 | 0131 | 4 | F | Nnssf_NSSelection service update to support NSAG | 17.5.0 | +| 2022-06 | CT#96 | CP-221055 | 0132 | 3 | F | Nnssf_NSSAIAvailability service update to support NSAG | 17.5.0 | +| 2022-06 | CT#96 | CP-221033 | 0135 | 1 | F | Correction on OpenAPI | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0136 | | F | 29.531 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97e | CP-222055 | 0140 | 1 | F | Cleanup of the service operation description | 17.6.0 | +| 2022-09 | CT#97e | CP-222021 | 0137 | 1 | B | Subscribe to All TAIs for AMF Set | 18.0.0 | +| 2022-09 | CT#97e | CP-222025 | 0142 | | F | 29.531 Rel-18 API version and External doc update | 18.0.0 | +| 2022-12 | CT#98e | CP-223028 | 0143 | 1 | F | Missing mandatory status codes in OpenAPI | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223033 | 0144 | - | F | 29.531 Rel-18 API version and External doc update | 18.1.0 | +| 2023-03 | CT#99 | CP-230072 | 0146 | 1 | A | Essential correction of MNC encoding targetAmfSet | 18.2.0 | +| 2023-03 | CT#99 | CP-230071 | 0148 | - | F | 29.531 Rel-18 API version and External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0147 | 3 | F | Location header description | 18.3.0 | +| 2023-06 | CT#100 | CP-231027 | 0151 | 1 | F | Clarify the inclusion of targetAmfSet IE and candidateAmfList IE | 18.3.0 | +| 2023-06 | CT#100 | CP-231025 | 0152 | - | F | Clarify the inclusion of ueSupNssrgInd IE | 18.3.0 | +| 2023-06 | CT#100 | CP-231027 | 0153 | 1 | F | Clarify the content of mappingOfNssai IE | 18.3.0 | +| 2023-06 | CT#100 | CP-231025 | 0154 | - | F | Update data types re-used by Nnssf_NSSelection service | 18.3.0 | +| 2023-06 | CT#100 | CP-231048 | 0155 | 1 | B | Discontinuity of NSI for PDU sessions | 18.3.0 | +| 2023-06 | CT#100 | CP-231048 | 0156 | 5 | B | Support of Alternative S-NSSAI | 18.3.0 | +| 2023-06 | CT#100 | CP-231069 | 0159 | 1 | F | Editorial corrections | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0160 | - | F | Removal of apiVersion from resource URI variables tables | 18.3.0 | +| 2023-06 | CT#100 | CP-231070 | 0161 | - | F | 29.531 Rel-18 API version and External doc update | 18.3.0 | +| 2023-09 | CT#101 | CP-232069 | 0163 | 3 | B | Updates on Subscription, Unsubscription and Notification of NSSF for Network Slice and Network Slice Instance replacement | 18.4.0 | +| 2023-09 | CT#101 | CP-232043 | 0164 | 1 | B | Nnssf_NSSAIAvailability Service updata for Network Slice Replacement | 18.4.0 | +| 2023-09 | CT#101 | CP-232043 | 0165 | 1 | B | Remove the Editor's NOTE on Network Slice instance Replacement | 18.4.0 | +| 2023-09 | CT#101 | CP-232058 | 0166 | 1 | F | Major API version | 18.4.0 | +| 2023-09 | CT#101 | CP-232060 | 0167 | - | F | 29.531 Rel-18 API version and External doc update | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0168 | - | F | HTTP RFCs obsoleted by IETF RFC 9110 and 9113 | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0169 | - | F | Correction on the description of DateTime | 18.5.0 | +| 2023-12 | CT#102 | CP-233071 | 0172 | 2 | A | Update of subscribed NSSAI when UE is not registered in network | 18.5.0 | +| 2023-12 | CT#102 | CP-233058 | 0175 | 3 | A | Correction of API TS29531_Nnssf_NSSAIAvailability.yaml, error in amfSetId pattern | 18.5.0 | +| 2023-12 | CT#102 | CP-233030 | 0176 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.5.0 | +| 2023-12 | CT#102 | CP-233060 | 0180 | - | F | 29.531 Rel-18 API version and External doc update | 18.5.0 | \ No newline at end of file diff --git a/gsma/29_series/29536/raw.md b/gsma/29_series/29536/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..599fde442016da51dc637e06f089b681b39d8adc --- /dev/null +++ b/gsma/29_series/29536/raw.md @@ -0,0 +1,4055 @@ + + +# 3GPP TS 29.536 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Slice Admission Control Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-----------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 7 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions, abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 10 | +| 4 Overview..... | 10 | +| 4.1 General ..... | 10 | +| 4.1A NSAC Architecture Options..... | 11 | +| 4.2 NSAC support in roaming..... | 11 | +| 4.3 Interaction between NSACFs..... | 11 | +| 5 Services offered by the NSACF..... | 12 | +| 5.1 Introduction ..... | 12 | +| 5.2 Nnsacf_NSAC Service..... | 13 | +| 5.2.1 Service Description ..... | 13 | +| 5.2.2 Service Operations..... | 14 | +| 5.2.2.1 Introduction..... | 14 | +| 5.2.2.2 NumOfUEsUpdate..... | 14 | +| 5.2.2.2.1 General ..... | 14 | +| 5.2.2.2.2 NSAC for controlling the number of UEs..... | 14 | +| 5.2.2.2.3 NSAC for controlling the number of UEs in hierarchical NSACF architecture..... | 17 | +| 5.2.2.2.4 NSAC for controlling the number of UEs with at least one PDU session/PDN connection ..... | 18 | +| 5.2.2.2.5 NSAC for controlling the number of UEs in case of VPLMN with HPLMN assistance NSAC mode..... | 19 | +| 5.2.2.3 EACNotify ..... | 21 | +| 5.2.2.3.1 General ..... | 21 | +| 5.2.2.3.2 NSACF initiated EAC mode configuration ..... | 21 | +| 5.2.2.4 NumOfPDUsUpdate ..... | 22 | +| 5.2.2.4.1 General ..... | 22 | +| 5.2.2.4.2 NSAC for controlling the number of PDU sessions ..... | 22 | +| 5.2.2.4.3 NSAC for controlling the number of PDU sessions in hierarchical NSACF architecture..... | 25 | +| 5.2.2.4.4 NSAC for controlling the number of UEs with at least one PDU session/PDN connection per network slice ..... | 26 | +| 5.2.2.4.5 NSAC for controlling the number of LBO PDU Sessions in case of VPLMN with HPLMN assistance NSAC mode ..... | 26 | +| 5.2.2.5 LocalNumberUpdate..... | 28 | +| 5.2.2.5.1 General ..... | 28 | +| 5.2.2.5.2 Update of local maximum number of UEs or PDU sessions ..... | 28 | +| 5.2.2.6 QuotaUpdate ..... | 29 | +| 5.2.2.6.1 General ..... | 29 | +| 5.2.2.6.2 Update of maximum number of UEs and/or PDU sessions..... | 29 | +| 5.3 Nnsacf_SliceEventExposure Service ..... | 30 | +| 5.3.1 Service Description ..... | 30 | +| 5.3.2 Service Operations..... | 30 | +| 5.3.2.1 Introduction..... | 30 | +| 5.3.2.2 Subscribe..... | 30 | +| 5.3.2.2.1 General ..... | 30 | +| 5.3.2.2.2 Creation of a subscription ..... | 30 | +| 5.3.2.2.3 Modification of a subscription ..... | 32 | +| 5.3.2.2.4 Creation of a one time and immediate reporting subscription ..... | 33 | +| 5.3.2.3 Unsubscribe ..... | 34 | +| 5.3.2.3.1 General ..... | 34 | +| 5.3.2.4 Notify ..... | 34 | +| 5.3.2.4.1 General ..... | 34 | + +| | | | +|---------------|-------------------------------------------------------------------|----| +| 6 | API Definitions ..... | 36 | +| 6.1 | Nnsacf_NSAC Service API ..... | 36 | +| 6.1.1 | Introduction ..... | 36 | +| 6.1.2 | Usage of HTTP..... | 36 | +| 6.1.2.1 | General..... | 36 | +| 6.1.2.2 | HTTP standard headers..... | 36 | +| 6.1.2.2.1 | General ..... | 36 | +| 6.1.2.2.2 | Content type ..... | 36 | +| 6.1.2.3 | HTTP custom headers..... | 36 | +| 6.1.3 | Resources..... | 37 | +| 6.1.3.1 | Overview..... | 37 | +| 6.1.3.2 | Resource: Slice Collection Subject to NSAC for UEs ..... | 38 | +| 6.1.3.2.1 | Description ..... | 38 | +| 6.1.3.2.2 | Resource Definition..... | 38 | +| 6.1.3.2.3 | Resource Standard Methods..... | 38 | +| 6.1.3.2.4 | Resource Custom Operations..... | 40 | +| 6.1.3.3 | Resource: Slice Collection Subject to NSAC for PDU sessions ..... | 40 | +| 6.1.3.3.1 | Description ..... | 40 | +| 6.1.3.3.2 | Resource Definition..... | 40 | +| 6.1.3.3.3 | Resource Standard Methods..... | 40 | +| 6.1.3.3.4 | Resource Custom Operations..... | 41 | +| 6.1.3.4 | Resource: Slice Collection Configurations..... | 42 | +| 6.1.3.4.1 | Description ..... | 42 | +| 6.1.3.4.2 | Resource Definition..... | 42 | +| 6.1.3.4.3 | Resource Standard Methods..... | 42 | +| 6.1.3.4.4 | Resource Custom Operations..... | 42 | +| 6.1.3.4.4.2.1 | Description ..... | 42 | +| 6.1.3.4.4.2.2 | Operation Definition..... | 42 | +| 6.1.3.5 | Resource: Slice Collection Roaming Quotas..... | 43 | +| 6.1.3.5.1 | Description ..... | 43 | +| 6.1.3.5.2 | Resource Definition..... | 43 | +| 6.1.3.5.3 | Resource Standard Methods..... | 44 | +| 6.1.3.5.4 | Resource Custom Operations..... | 44 | +| 6.1.3.5.4.2.1 | Description ..... | 44 | +| 6.1.3.5.4.2.2 | Operation Definition..... | 44 | +| 6.1.4 | Custom Operations without associated resources ..... | 45 | +| 6.1.5 | Notifications ..... | 45 | +| 6.1.5.1 | General..... | 45 | +| 6.1.5.2 | EAC Mode Notification..... | 46 | +| 6.1.5.2.1 | Description ..... | 46 | +| 6.1.5.2.2 | Target URI..... | 46 | +| 6.1.5.2.3 | Standard Methods..... | 46 | +| 6.1.6 | Data Model ..... | 46 | +| 6.1.6.1 | General..... | 46 | +| 6.1.6.2 | Structured data types..... | 48 | +| 6.1.6.2.1 | Introduction ..... | 48 | +| 6.1.6.2.2 | Type: UeACRequestData..... | 48 | +| 6.1.6.2.3 | Type: UeACResponseData ..... | 49 | +| 6.1.6.2.4 | Type: EACNotification ..... | 49 | +| 6.1.6.2.5 | Type: AcuOperationItem..... | 49 | +| 6.1.6.2.6 | Type: AcuFailureItem ..... | 50 | +| 6.1.6.2.7 | Type: PduACRequestData ..... | 50 | +| 6.1.6.2.8 | Type: PduACResponseData..... | 50 | +| 6.1.6.2.9 | Type: UeACRequestInfo..... | 51 | +| 6.1.6.2.10 | Type: PduACRequestInfo ..... | 51 | +| 6.1.6.2.11 | Type: UeAdmissionValue..... | 52 | +| 6.1.6.2.12 | Type: PduAdmissionValue ..... | 52 | +| 6.1.6.2.13 | Type: ACUpdateData..... | 52 | +| 6.1.6.2.14 | Type: QuotaUpdateRequestData..... | 53 | +| 6.1.6.2.15 | Type: QuotaUpdateResponseData ..... | 53 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.6.3 | Simple data types and enumerations..... | 53 | +| 6.1.6.3.1 | Introduction ..... | 53 | +| 6.1.6.3.2 | Simple data types ..... | 53 | +| 6.1.6.3.3 | Enumeration: EACMode..... | 53 | +| 6.1.6.3.4 | Enumeration: AcuFlag ..... | 54 | +| 6.1.6.3.5 | Enumeration: AcuFailureReason ..... | 54 | +| 6.1.6.3.6 | Enumeration: SliceQuotaType ..... | 55 | +| 6.1.6.3.7 | Enumeration: NsacAdmissionMode ..... | 55 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 56 | +| 6.1.6.5 | Binary data ..... | 56 | +| 6.1.7 | Error Handling ..... | 56 | +| 6.1.7.1 | General ..... | 56 | +| 6.1.7.2 | Protocol Errors ..... | 56 | +| 6.1.7.3 | Application Errors ..... | 56 | +| 6.1.8 | Feature negotiation ..... | 56 | +| 6.1.9 | Security ..... | 57 | +| 6.1.10 | HTTP redirection..... | 57 | +| 6.2 | Nnsacf_SliceEventExposure Service API..... | 58 | +| 6.2.1 | Introduction ..... | 58 | +| 6.2.2 | Usage of HTTP..... | 58 | +| 6.2.2.1 | General ..... | 58 | +| 6.2.2.2 | HTTP standard headers..... | 58 | +| 6.2.2.2.1 | General ..... | 58 | +| 6.2.2.2.2 | Content type ..... | 58 | +| 6.2.2.3 | HTTP custom headers..... | 59 | +| 6.2.3 | Resources..... | 59 | +| 6.2.3.1 | Overview..... | 59 | +| 6.2.3.2 | Resource: Subscriptions collection..... | 59 | +| 6.2.3.2.1 | Description ..... | 59 | +| 6.2.3.2.2 | Resource Definition..... | 59 | +| 6.2.3.2.3 | Resource Standard Methods..... | 60 | +| 6.2.3.2.4 | Resource Custom Operations ..... | 61 | +| 6.2.3.3 | Resource: Individual subscription ..... | 61 | +| 6.2.3.3.1 | Description ..... | 61 | +| 6.2.3.3.2 | Resource Definition..... | 61 | +| 6.2.3.3.3 | Resource Standard Methods..... | 61 | +| 6.2.3.3.4 | Resource Custom Operations ..... | 65 | +| 6.2.4 | Custom Operations without associated resources ..... | 65 | +| 6.2.5 | Notifications ..... | 65 | +| 6.2.5.1 | General ..... | 65 | +| 6.2.5.2 | NSACF Event Notification ..... | 65 | +| 6.2.5.2.1 | Notification Definition ..... | 65 | +| 6.2.5.2.2 | Notification Standard Methods ..... | 66 | +| 6.2.6 | Data Model ..... | 66 | +| 6.2.6.1 | General ..... | 66 | +| 6.2.6.2 | Structured data types..... | 67 | +| 6.2.6.2.1 | Introduction ..... | 67 | +| 6.2.6.2.2 | Type: SACEventSubscription ..... | 68 | +| 6.2.6.2.3 | Type: CreatedSACEventSubscription..... | 69 | +| 6.2.6.2.4 | Type: SACEventReport..... | 69 | +| 6.2.6.2.5 | Type: SACEvent ..... | 70 | +| 6.2.6.2.6 | Type: SACEventReportItem ..... | 70 | +| 6.2.6.2.7 | Type: SACEventState ..... | 71 | +| 6.2.6.3 | Simple data types and enumerations..... | 71 | +| 6.2.6.3.1 | Introduction ..... | 71 | +| 6.2.6.3.2 | Simple data types ..... | 71 | +| 6.2.6.3.3 | Enumeration: SACEventType..... | 71 | +| 6.2.6.3.4 | Enumeration: SACEventTrigger ..... | 71 | +| 6.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 72 | +| 6.2.6.5 | Binary data ..... | 72 | +| 6.2.7 | Error Handling ..... | 72 | +| 6.2.7.1 | General ..... | 72 | + +| | | | +|-------------------------------|-------------------------------------|-----------| +| 6.2.7.2 | Protocol Errors ..... | 72 | +| 6.2.7.3 | Application Errors ..... | 72 | +| 6.2.8 | Feature negotiation ..... | 72 | +| 6.2.9 | Security ..... | 73 | +| 6.2.10 | HTTP redirection ..... | 73 | +| Annex A (normative): | OpenAPI specification ..... | 74 | +| A.1 | General ..... | 74 | +| A.2 | Nnsacf_NSAC API ..... | 74 | +| A.3 | Nnsacf_SliceEventExposure API ..... | 82 | +| Annex B (informative): | Change history ..... | 89 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnsacf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NSACF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] 3GPP TS 29.518: "5G System; Access and Mobility Management Service; Stage 3". +- [16] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [17] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [18] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". + +# 3 Definitions, abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|------------------------------------------| +| AF | Application Function | +| 5GC | 5G Core Network | +| AMF | Access Management Function | +| DCCF | Data Collection Coordination Function | +| EAC | Early Admission Control | +| MCX | Mission Critical Service | +| MPS | Multimedia Priority Service | +| NEF | Network Exposure Function | +| NSAC | Network Slice Admission Control | +| NSACF | Network Slice Admission Control Function | +| NWDAF | Network Data Analytics Function | +| SMF | Session Management Function | + +# 4 Overview + +## 4.1 General + +Within the 5GC, the NSACF offers services to the AMF, SMF (or combined SMF+PGW-C), NWDAF, NEF, DCCF and NSACF via the Nnsacf service based interface (see 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]). + +Figure 4.1 provides the reference model (in service based interface representation and in reference point representation), with focus on the NSACF and the scope of the present specification. + +![Reference model – NSACF diagram showing various network functions connected to the NSACF via the Nnsacf interface.](4dadfd8b8240e9d83f974e3f0fdd18df_img.jpg) + +The diagram illustrates the reference model for the NSACF. On the left, seven network functions are listed vertically: AMF, SMF, NEF, NWDAF, AF, DCCF, and NSACF. Lines from each of these functions converge at a central point. From this convergence point, a single line labeled 'Nnsacf' connects to a green rectangular box on the right labeled 'NSACF'. Above the convergence point, specific reference points are indicated: N80 (between AMF and SMF), N81 (between SMF and NEF), N82 (between NEF and NWDAF), and N99 (between DCCF and NSACF). + +Reference model – NSACF diagram showing various network functions connected to the NSACF via the Nnsacf interface. + +Figure 4.1: Reference model – NSACF + +The functionalities supported by the NSACF are listed in clause 6.2.28 of 3GPP TS 23.501 [2]. + +The services and service operations provided by the Nnsacf interface are listed in clause 5.2.21 of 3GPP TS 23.502 [3]. + +When the UE connects to EPS and EPS counting is required, it is the combined SMF+PGW-C invokes NSACF services to perform network slice admission control, during PDN connection establishment procedure and PDN connection release procedure, as specified in clause 5.15.11.5 of 3GPP TS 23.501 [2]. + +**NOTE:** A trusted AF can access NSACF services either via NEF to NSACF or directly to NSACF. An untrusted AF shall only be allowed to access NSACF services via NEF. If multiple NSACFs are deployed in the network and the trusted AF is interested in the aggregated report, then the trusted AF collects the report from NEF, instead of contacting multiple NSACFs directly. + +## 4.1A NSAC Architecture Options + +If the network is configured with a single NSAC service area, there is a single NSACF deployed to handle the admissions for an S-NSSAI. + +If the network is configured with multiple NSAC service areas, one of the three NSAC architecture options, i.e. non-hierarchical NSAC architecture, centralized NSAC architecture and hierarchical NSAC architecture (as specified in clause 5.15.11.0 of 3GPP TS 23.501 [2]), may be selected to handle the admissions for an S-NSSAI based on operator's policy. + +In different NSAC architectures, there are different roles of NSACFs as: + +- independent NSACFs are deployed in each NSAC service area in non-hierarchical NSAC architecture; +- a single centralized NSACF is deployed in the whole network in centralized NSAC architecture; and +- a primary NSACF and several distributed NSACFs are deployed in hierarchical NSAC architecture. + +For the hierarchical NSAC architecture, the NSACF role (i.e. primary NSACF or distributed NSACF) is configured in the NSACF per S-NSSAI (e.g. a NSACF may act as primary NSACF for a first S-NSSAI and as a distributed NSACF for a second S-NSSAI). For the same S-NSSAI, the role of primary and distributed NSACFs can be co-located at the same NSACF instance. A NSACF acting as a Primary NSACF for a given S-NSSAI handles overall NSAC for the S-NSSAI at the global level (i.e. it is ultimately responsible for the NSAC for an S-NSSAI). See clause 5.15.11 of 3GPP TS 23.501 [2]. + +## 4.2 NSAC support in roaming + +In the roaming scenario, depending on operator's policy and roaming agreement, a specific NSAC admission mode (i.e. VPLMN NSAC admission, VPLMN with HPLMN assistance admission or HPLMN NSAC admission) is determined for the NSAC procedure for roaming UEs (see clause 5.15.11.3 of 3GPP TS 23.501 [2]). + +For roaming UEs with LBO PDU session: + +- if VPLMN NSAC admission (with or without HPLMN assistance) is determined, the vNSACF offers service to the NF in the VPLMN (e.g. AMF and SMF in VPLMN); +- if HPLMN NSAC admission is determined, the hNSACF offers service to the NF in the VPLMN (e.g. AMF and SMF in VPLMN). The AMF and SMF in VPLMN interact with hNSACF to perform NSAC procedure. + +For roaming UEs with HR PDU session: + +- the hNSACF offers service to the SMF in the HPLMN; +- if HPLMN NSAC admission is determined, the hNSACF offers service to the AMF in the VPLMN. Otherwise, the vNSACF offers services to the AMF in the VPLMN. + +## 4.3 Interaction between NSACFs + +NSACF interactions may exist in the following cases: + +- for roaming case, if VPLMN with HPLMN assistance NSAC admission mode is determined, the NSACF in VPLMN may interact with the NSACF in HPLMN to fetch the quota for number of UEs or number of PDU sessions, and the NSACF in HPLMN may interact with the NSACF in VPLMN to provide the updated number of UEs or number of PDU sessions; +- for roaming case, if VPLMN NSAC admission mode is determined, the NSACF in VPLMN may interact with the NSACF in HPLMN to fetch the maximum number of registered UEs to be enforced and the maximum number of LBO PDU sessions to be enforced; +- in hierarchical NSAC architecture, a distributed NSACF may interact with the primary NSACF to fetch the quota for number of UEs or number of PDU sessions, and the primary NSACF may interact with the distributed NSACF to provide the updated number of UEs or number of PDU sessions, as specified in clause 5.15.11 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the NSACF + +## 5.1 Introduction + +The NSACF supports the following services. + +**Table 5.1-1: NF Services provided by NSACF** + +| Service Name | Description | Example Consumer | +|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnsacf_NSAC | This service allows the NF service consumer to:
- request the NSACF to perform per slice admission control for the number of UEs / PDU sessions, or the number of UEs with at least one PDU session/PDN Connection in case of EPS counting;
- request the NSACF to send or update the local maximum number of UEs / PDU sessions, in hierarchical NSAC architecture scenario;
- retrieve slice roaming quotas (i.e. the maximum number of UEs and/or PDU sessions) from the NSACF in HPLMN, in roaming scenario. | AMF, SMF, NSACF | +| Nnsacf_SliceEventExposure | This service provide event based notifications to the NF service consumer related to the number of UEs registered to a network slice or the number of PDU Sessions established to a network slice. | NEF, AF, NWDAF, DCCF, NSACF | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|-----------------|-------| +| Nnsacf_NSAC | 6.1 | Per slice admission control service to control the number of UEs / PDU sessions or the combination, or configure the local maximum number of UEs / PDU sessions in a distributed NSACF in hierarchical NSAC architecture, or retrieve slice roaming quotas from HPLMN NSACF in roaming scenario. | TS29536_Nnsacf_NSAC .yaml | nnsacf-nsac | A.2 | +| Nnsacf_SliceEvent Exposure | 6.2 | Slice related event subscription and notification | TS29536_Nnsacf_SliceE ventExposure.yaml | nnsacf-slice-ee | A.3 | + +## 5.2 Nnsacf\_NSAC Service + +### 5.2.1 Service Description + +The Nnsacf\_NSAC service provides the service capability for the NF Service Consumer (e.g. AMF, SMF or primary NSACF) to request admission control for UEs accessing a specific network slice, or for PDU sessions to be established to a specific network slice. The following are the key functionalities of this NF service: + +- Request the NSACF to control the number of UEs registered to a specific network slice, e.g. perform availability check and update the number of UEs registered to a specific network slice; +- Request the NSACF to control the number of PDU session established to a specific network slice, e.g. perform availability check and update the number of PDU sessions established to a specific network slice; +- Request the NSACF to control the number of UEs with at least one PDU session/PDN Connection established on a network slice if EPS counting is required; +- Notify the NF Service Consumer (e.g. AMF) of the activation/deactivation of EAC (Early Admission Control) mode for NSAC procedure; +- Request the NSACF to configure or update the local maximum number of registered UEs and/or number of PDU sessions of the network slice at a distributed NSACF, in hierarchical NSAC architecture. +- Request the NSACF in HPLMN to provide slice roaming quotas (i.e. the maximum number of UEs / PDU session in NSACF in VPLMN), in roaming scenario. + +The Nnsacf\_NSAC service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nnsacf\_NSAC service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|--------------------------------| +| NumOfUEsUpdate | Request the NSACF to perform admission control for the number of registered UEs, or the number of UEs with at least one PDU session/PDN Connection in case of EPS counting. | Request/Response | AMF, combined SMF+PGW-C, NSACF | +| NumOfPDUsUpdate | Request the NSACF to perform admission control for the number of PDU sessions, or the number of UEs with at least one PDU session/PDN Connection in case of EPS counting. | Request/Response | SMF, combined SMF+PGW-C, NSACF | +| EACNotify | Notify the NF Service Consumer of the activation/deactivation of EAC mode. | Subscribe/Notify | AMF | +| LocalNumberUpdate | Request the distributed NSACF to update its local maximum number of registered UEs and/or PDU sessions of the network slice, in hierarchical NSAC architecture. | Request/Response | primary NSACF | +| QuotaUpdate | Request the primary or central NSACF at HPLMN to update the slice roaming quotas (i.e. the maximum number of registered UEs and/or the maximum number of PDU sessions of a network slice) at the primary or central NSACF of VPLMN. | Request/Response | V-NSACF | + +When the UE connects to EPS and EPS counting is required for the S-NSSAI subjected to NSAC, only one of the configurations shall be applied as specified in clause 5.15.11.5 of 3GPP TS 23.501 [2]: + +- Maximum number of registered UEs and/or maximum number of PDU session. In that case the combined SMF+PGW-C shall invoke the NumOfUEsUpdate and NumOfPDUsUpdate service operations in sequence. If the NumOfUEsUpdate returns failure, the combined SMF+PGW-C shall not continue invoking the NumOfPDUsUpdate. If the NumOfPDUsUpdate returns failure then the combined SMF+PGW-C shall invoke the NumOfUEsUpdate to decrease the UE count. Or, + +- Maximum number of UEs with at least one PDU session/PDN Connection and/or maximum number of PDU session. In that case the combined SMF+PGW-C shall be configured with option 1 and shall invoke the NumOfUEsUpdate service operation or with option 2 and shall invoke NumOfPDUsUpdate service operation to NSACF to perform admission control for the number of UEs with at least one PDU session/PDN connection and/or maximum number of PDU session as specified in clause 5.15.11.5a of 3GPP TS 23.501 [2]. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +This clause introduces the related procedures using Nnsacf\_NSAC service operations to request the NSACF to control the number of UEs registered to a specific network slice. + +#### 5.2.2.2 NumOfUEsUpdate + +##### 5.2.2.2.1 General + +The NumOfUEsUpdate service operation shall be used by the NF Service Consumer (e.g. AMF, combined SMF+PGW-C, or NSACF) to request the NSACF to control the number of UEs registered to a specific network slice, e.g. perform availability check and update the number of UEs registered to a network slice. It is used in the following procedures: + +- AMF initiated network slice admission control procedure related to control the number of UEs registered to a network slice (see clause 4.2.11.2 of 3GPP TS 23.502 [3]). +- AMF initiated network slice admission control procedure related to control the number of roaming UEs registered to a network slice (see clauses 4.2.11.5.1 and 4.2.11.5.2.3 of 3GPP TS 23.502 [3]). +- Combined SMF+PGW-C initiated network slice admission control procedure related to control the number of UEs registered to a network slice, in the case of EPS interworking (see clause 5.15.11.5 of 3GPP TS 23.501 [2]). +- Combined SMF+PGW-C initiated network slice admission control procedure related to control the number of UEs with at least one PDU session/PDN connection (see clause 5.15.11.5a of 3GPP TS 23.501 [2]). +- Hierarchical NSACF-based network slice admission control procedure related to control the number of UEs registered to a network slice (see clause 4.2.11.2a of 3GPP TS 23.502 [3]). + +The operation may also be used to update the number of existing registered UEs in the NSACF when NSAC is enabled or disabled for a slice which is already live in the network. + +##### 5.2.2.2.2 NSAC for controlling the number of UEs + +The NF Service Consumer (e.g. AMF, combined SMF+PGW-C) shall invoke the NumOfUEsUpdate service operation to request the NSACF to perform network slice admission control procedure related to the number of UEs, by using the HTTP POST method as shown in Figure 5.2.2.2.2-1. + +![Sequence diagram showing the NSAC procedure for controlling the number of UEs. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 200 OK, a 4xx/5xx error, or a 3xx redirect response.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: 1. POST .../slices/ues (UeACRequestData) + NF Service Consumer->>NSACF: 1. POST .../slices/ues (UeACRequestData) + Note right of NSACF: 2a. 200 OK (UeACResponseData) or 204 No Content + NSACF-->>NF Service Consumer: 2a. 200 OK (UeACResponseData) or 204 No Content + Note right of NSACF: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + Note right of NSACF: 2c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the NSAC procedure for controlling the number of UEs. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 200 OK, a 4xx/5xx error, or a 3xx redirect response. + +**Figure 5.2.2.2.2-1: NSAC procedure for controlling the number of UEs** + +1. The NF Service Consumer (e.g. AMF, combined SMF+PGW-C) shall send a POST request to the resource representing the network slice admission control related to the number of UEs (i.e. .../slices/ues) in the NSACF. + +The content of the POST request shall contain the input data structure (i.e. UeACRequestData) for network slice admission control, which shall contain the following information: + +- the SUPI(s) of the UE(s); +- the access type, over which the UE registers to the network or deregisters from the network; +- a list of S-NSSAIs which are subject to NSAC, and for each S-NSSAI an update flag indicates the operation to that S-NSSAI; +- the NF Instance ID, identifying the requester NF. +- the NSAC Service Area of the NF consumer, if it is configured in the NF consumer. +- the NSAC admission mode of each S-NSSAI for inbound roamer, i.e. VPLMN NSAC admission mode or VPLMN with HPLMN assistance NSAC admission mode; +- the serving PLMN ID of the inbound roamer. + +In addition, the POST request may also contain: + +- the EAC notification callback URI. The AMF may provide the EAC notification callback URI at the first interaction with the NSACF, or may provide an updated one in later interactions when it changes. If the EAC notification callback URI is set to null value by the AMF in later interactions, it means the AMF unsubscribes the EAC notification from the NSACF; +- the additional access type, if the UE deregisters from the network over both 3GPP access and Non-3GPP access. + +The update flag shall be set to "INCREASE" for a UE to be registered to a specific slice, and shall be set to "DECREASE" for a UE to be deregistered from a specific slice. + +For NSAC of roaming UEs with VPLMN NSAC admission with or without HPLMN assistance, the NF Service Consumer (e.g. AMF) shall provide the S-NSSAI in serving PLMN, and the corresponding mapped S-NSSAI in home PLMN to the NSACF in serving PLMN. For NSAC of roaming UEs with HPLMN NSAC admission, the NF Service Consumer (e.g. AMF) shall provide the S-NSSAI in home PLMN to the NSACF in home PLMN (corresponding to the S-NSSAI in the VPLMN). + +NOTE 1: When multiple S-NSSAIs are supported by a NSACF and multiple S-NSSAIs are required for NSAC for a given UE where EAC mode is active for at least one S-NSSAI, how the AMF triggers NSAC procedure to this NSACF is implementation specific, e.g. the AMF triggers NSAC procedure for all these supported S-NSSAIs before the Registration Accept message or the UE Configuration Update message. + +- 2a. For each S-NSSAI included in UeACRequestData, the NSACF shall perform the following actions: + +- if the update flag is set to "INCREASE", the NSACF shall check whether the UE is already in the UE registration list stored in the NSACF and whether the total number of UEs to this slice will exceed the maximum number of UEs allowed to be registered to this slice: +- if the UE ID is already recorded in the UE registration list but the requester NF is not recorded in the UE registration list, the NSACF shall create a new entry for the UE registration associated with the requester NF and shall also maintain the existing UE registration entries. The total number of UEs registered to this slice is not updated; +- if the UE ID is not recorded in the UE registration list and the total number of UEs (including the UEs indicated in the request and the UEs already stored in the NSACF) does not exceed the maximum number of UEs allowed to be registered to this slice, the NSACF records the indicated UEs to the UE registration list stored in the NSACF, and updates the total number of UEs registered to this slice accordingly; +- if the UE ID is not recorded in the UE registration list and if the total number of UEs will exceed the maximum number of UEs allowed to be registered to this slice, the NSACF shall not record the UE into the UE registration list stored in the NSACF, and shall not update the total number of UEs. Instead, the NSACF shall record this S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_UE\_NUM" as specified in clause 6.1.6.3.5); +- if the update flag is set to "DECREASE" and if the UE is recorded in the UE registration list, the NSACF shall remove the indicated UEs from the UE registration list stored in the NSACF. If there are two or more UE registration entries associated with the UE ID, the NSACF shall only remove the entry associated with the requester NF. After removal, if a UE is no longer recorded in the UE registration list, the NSACF shall decrease the total number of UEs registered to this slice. +- If the update flag is set to "DECREASE" and if the UE is not recorded in the UE registration list, the NSACF shall not decrease the total number of UEs registered to this slice and shall return successful handling for this UE registration. + +The NSACF may be configured to perform per access type network slice admission control. In this case, the NSACF shall check whether the access type provided by the NF Service Consumer is configured for NSAC for the indicated S-NSSAI to control the number of UEs. If the access type is not configured for NSAC for the indicated S-NSSAI, the NSACF shall skip the above handling for increasing/decreasing the number of UEs and return successful for this S-NSSAI. If the access type is configured for NSAC for the indicated S-NSSAI, the NSACF shall perform the above handling taking the access type into account and record/remove the UE registration associated with the access type. If the total number of UEs will exceed the maximum number of UEs allowed to be registered to this slice, the NSACF shall record this S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_UE\_NUM" as specified in clause 6.1.6.3.5). + +If the NSACF is not configured to perform per access type network slice admission control, the NSACF may perform network slice admission control without taking access type into account. For example, the NSACF is configured with a total quota for the PLMN, but the network slice admission control is not specific to one access type. The NSACF shall record the access type(s) associated with the UE registration. The NSACF shall remove the corresponding UE registration entry when the UE deregisters from all access types. + +NOTE 2: For each S-NSSAI that is applicable for NSAC, the NSACF is configured with a total quota for the PLMN. However, the network slice admission control may be configured to apply for one specific access type or both access types. + +If in above NSACF handling not all S-NSSAIs are successful, "200 OK" shall be returned, with necessary response data indicating the failed S-NSSAI and the failure reason, e.g. "EXCEED\_MAX\_UE\_NUM". + +If in above NSACF handling all S-NSSAIs are successful, "204 No Content" shall be returned which could represent the maximum number of UEs for the S-NSSAI not reached. + +If the NSACF is configured with multiple NSAC Service Areas is configured to perform NSAC admission on a per NSAC service area granularity, the NSACF shall perform the NSAC admission against the received NSAC service area in the request. + +NOTE 3: If the PLMN has multiple NSAC service areas and there are multiple NSACFs deployed for the network slice, each NSACF may be configured with the maximum number of UEs of the network slice within its service area, e.g. as per operator policy. If hierarchical NSAC architecture is deployed, how to synchronize the threshold among the primary NSACF and distributed NSACFs is specified in clause 5.2.2.2.3 and clause 5.2.2.5.2. Otherwise, how to split or synchronize the threshold in multiple NSACFs is left to implementation, and how to guarantee session continuity when a UE moves to new NSAC service area with a different NSACF is also left to implementation. + +NOTE 4: If the NF Service Consumer is AMF, the NSACF may subscribe to AMF Status Change Notifications (e.g. AMF unavailability) via the NRF and update the NF ID accordingly, as described in clause 4.2.11.2 of 3GPP TS 23.502 [3]. + +When the NF Service Consumer subscribes to the EAC Notification for the first time, the NSACF shall immediately send an EAC notification (see clause 5.2.2.3.2) towards the NF consumer including the most recent EAC Modes for the subscribed S-NSSAIs. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.2.3.1-1. + +NOTE 5: If the NF Service Consumer provided the EAC notification callback URI, the NSACF can handle the EAC notification implicit subscription independently of the result of the UE NSAC activities, i.e. even the NSAC actions for all the S-NSSAIs are failed for the UE(s) and negative response is sent to the AMF, the NSACF can still store the EAC notification subscription and send EAC notification(s) to the AMF. + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +When the procedure is used to perform admission control for a number of UEs, when e.g. NSAC is enabled or disabled for an already live slice, then based on operator policy AMF may allow or disallow sessions for which NSACF returned a reject. + +##### 5.2.2.2.3 NSAC for controlling the number of UEs in hierarchical NSACF architecture + +When the hierarchical NSACF architecture is deployed in the network, the NF Service Consumer (e.g. AMF, combined SMF+PGW-C) shall invoke the NumOfUEsUpdate service operation to request the NSACF to perform network slice admission control procedure based on UE admission quota or UE admission threshold to control the number of UEs. In this procedure, the NSACF may delegate the request to the primary NSACF for further processing in specific cases. + +![Sequence diagram illustrating the NSAC procedure for controlling the number of UEs in hierarchical NSACF architecture. The diagram shows three participants: NF Service Consumer, NSACF, and Primary NSACF. The sequence of messages is as follows: 1. POST .../slices/ues (UeACRequestData) from NF Service Consumer to NSACF. 2. Response from NSACF to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx). 3. POST .../slices/ues (UeACRequestData) from NSACF to Primary NSACF. 4. Response from Primary NSACF to NSACF (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx). 5. Response from NSACF to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx).](6f659142d4789aa889184459f884787e_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + participant Primary NSACF + Note left of NF Service Consumer: 1. POST .../slices/ues (UeACRequestData) + NF Service Consumer->>NSACF: 1. POST .../slices/ues (UeACRequestData) + Note right of NSACF: 2a. 200 OK (UeACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 2a. 200 OK (UeACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + Note right of NSACF: 3. POST .../slices/ues (UeACRequestData) + NSACF-->>Primary NSACF: 3. POST .../slices/ues (UeACRequestData) + Note right of Primary NSACF: 4a. 200 OK (UeACResponseData) or 204 No Content +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + Primary NSACF-->>NSACF: 4a. 200 OK (UeACResponseData) or 204 No Content +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + Note right of NSACF: 5a. 200 OK (UeACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 5a. 200 OK (UeACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + +``` + +Sequence diagram illustrating the NSAC procedure for controlling the number of UEs in hierarchical NSACF architecture. The diagram shows three participants: NF Service Consumer, NSACF, and Primary NSACF. The sequence of messages is as follows: 1. POST .../slices/ues (UeACRequestData) from NF Service Consumer to NSACF. 2. Response from NSACF to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx). 3. POST .../slices/ues (UeACRequestData) from NSACF to Primary NSACF. 4. Response from Primary NSACF to NSACF (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx). 5. Response from NSACF to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx). + +Figure 5.2.2.2.3-1: NSAC procedure for controlling the number of UEs in hierarchical NSACF architecture + +1. Same as step 1 of Figure 5.2.2.2.2-1, with the following modifications. + +The POST request may contain: + +- the UE already registered indication, if the UE has been registered with the associated S-NSSAI in another NSAC service area before. + +NOTE: During inter-AMF mobility or EPS to 5GS mobility, the target AMF determines the UE already registered indication based on the allowed NSSAI information received from the source AMF or the combined SMF+PGW-C, as specified in clause 5.15.11.1.2 of 3GPP TS 23.501 [2]. + +2a. For each S-NSSAI included in UeACRequestData, the NSACF shall perform the actions to control the number of UEs. + +- if the update flag is set to "INCREASE" or "DECREASE", the NSACF shall behave as described in clause 5.15.11.1.2 of 3GPP TS 23.501 [2] and clause 4.2.11.2a of 3GPP TS 23.502 [3]. + +2b and 2c. Same as step 2b and 2c of Figure 5.2.2.2.2-1. + +3. If the NSAC processing involves the primary NSACF based on the mechanism defined in clause 4.2.11.2a of 3GPP TS 23.502 [3], the NF Service Consumer (e.g. NSACF) shall send a POST request to the resource representing the network slice admission control related to the number of UEs (i.e. .../slices/ues) in the primary NSACF. If the primary NSACF is not discovered, the NSACF shall discover the primary NSACF according to clause 6.3.22 of 3GPP TS 23.501 [2]. + +The content of the POST request shall contain the input data structure (i.e. UeACRequestData) for network slice admission control, which shall contain the information received in step 1. The UE already registered indication may be included if it is received in step 1 and the UE admission type is quota-based. + +4a. For each S-NSSAI included in UeACRequestData, the primary NSACF shall check the global maximum number of UEs and determines whether to accept or reject the request to update the local maximum number of UEs and/or the UE admission threshold configurations of NSACF. + +- if the update flag is set to "INCREASE" or "DECREASE", the primary NSACF shall behave as described in clause 5.15.11.1.2 of 3GPP TS 23.501 [2] and clause 4.2.11.2a of 3GPP TS 23.502 [3]. If in above primary NSACF handling not all S-NSSAIs are successful, "200 OK" shall be returned, with necessary response data indicating the failed S-NSSAI and the failure reason, e.g. "EXCEED\_MAX\_UE\_NUM". + +If in above primary NSACF handling all S-NSSAIs are successful, "204 No Content" shall be returned which could represent the maximum number of UEs for the S-NSSAI not reached. + +4b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.2.3.1-3. + +4c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +5a. If the response message includes the updated local maximum number of UEs and/or the updated UE admission threshold, the NSACF shall replace the local maximum number of UEs and/or the local UE admission threshold with the received updated values respectively. The NSACF shall execute the same action as step 2a of Figure 5.2.2.2.2-1 based on the updated values; + +If the response does not include the updated local maximum number of UEs and/or the updated UE admission threshold, the NSACF shall return the response to NF service consumer based on the received NSAC response from Primary NSACF. + +5b and 5c. Same as step 2b and 2c of Figure 5.2.2.2.2-1. + +##### 5.2.2.2.4 NSAC for controlling the number of UEs with at least one PDU session/PDN connection + +The NumOfUEsUpdate service operation may be invoked to control the number of UEs with at least one PDU session/PDN connection, by a combined SMF+PGW-C under the following conditions: + +- EPS interworking is supported; + +- EPS counting is required for the network slice identified by an S-NSSAI; +- the network (i.e., combined SMF+PGW-C, NSACF) is configured to perform NSAC for the number of UEs with at least one PDU session/PDN Connection. + +The combined SMF+PGW-C shall only invoke the NumOfUEsUpdate in the following cases: + +- when the UE establishes the first PDU session/PDN connection associated with the network slice in the combined SMF+PGW-C; +- when the last PDU session/PDN connection associated with the network slice is released. + +The procedure specified in clause 5.2.2.2.2 is applied, with the following difference: + +- Step 2a: + - for each S-NSSAI, the NSACF checks if the S-NSSAI is subject to counting the number of UEs with at least one PDU session/PDN connection. If no, the NSACF shall perform the existing NSAC handling as per clause 5.2.2.2.2. Otherwise, the NSACF shall perform the following steps: + - if the update flag is set to "INCREASE"/"DECREASE", perform "INCREASE"/"DECREASE" operation similarly as clause 5.2.2.2.2, by replacing the number of UEs to the number of UEs with at least one PDU session/PDN connection. + - if the update flag is set to "INCREASE" and the counted UE number exceeds the configured maximum number of UEs with at least one PDU session/PDN connection, the NSACF shall record this S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_UE\_NUM " as specified in clause 6.1.6.3.5). + - if the update flag is set to "UPDATE", behave as described in clause 4.11.5.9a of 3GPP TS 23.502 [3]. + - For the hierarchical NSAC architecture, the NSACF shall behave as specified in clause 5.2.2.2.3. + - If the local maximum number or local threshold is reached, the NSACF may interact with the Primary NSACF before it returns the response back to the SMF+PGW-C. For more details on handling between the NSACF and Primary NSACF see clause 4.2.11.2a of 3GPP TS 23.502 [3]. + +The EAC mode shall not be applicable for the NSAC for controlling the number of UEs with at least one PDU session/PDN connection option 1 and option 2. + +##### 5.2.2.2.5 NSAC for controlling the number of UEs in case of VPLMN with HPLMN assistance NSAC mode + +For controlling of maximum number of UEs in roaming case, the NF Service Consumer (e.g. AMF, vNSACF in Hierarchical NSAC architecture) shall invoke the NumOfUEsUpdate service operation to request the NSACF in Serving PLMN (e.g. Central or Primary NSACF in VPLMN) to perform network slice admission control procedure based on UE admission quota or UE admission threshold to control the number of UEs. In this procedure, the NSACF in Serving PLMN shall delegate the request to the NSACF in HPLMN for further processing in specific cases. + +![Sequence diagram illustrating the HPLMN Delegated NSAC procedure for controlling the number of UEs. The diagram shows three lifelines: NF Service Consumer in Serving PLMN, NSACF in Serving PLMN, and NSACF in Home PLMN. The sequence of messages is: 1. POST ../slices/ues (UeACRequestData) from NF Service Consumer to NSACF in Serving PLMN. 2. Response from NSACF in Serving PLMN to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx). 3. POST ../slices/ues (UeACRequestData) from NSACF in Serving PLMN to NSACF in Home PLMN. 4. Response from NSACF in Home PLMN to NSACF in Serving PLMN (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx). 5. Final response from NSACF in Serving PLMN to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx).](81a4cbf0b3c4cbc065efdf8f800dadde_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer in Serving PLMN + participant NSACF_S as NSACF in Serving PLMN + participant NSACF_H as NSACF in Home PLMN + Note left of NSACF_S: 2a. 200 OK (UeACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + Note right of NSACF_H: 4a. 200 OK (UeACResponseData) +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + Note left of NSACF_S: 5a. 200 OK (UeACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + + NFSC->>NSACF_S: 1. POST ../slices/ues (UeACRequestData) + NSACF_S-->>NFSC: 2a. 200 OK (UeACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + NSACF_S-->>NSACF_H: 3. POST ../slices/ues (UeACRequestData) + NSACF_H-->>NSACF_S: 4a. 200 OK (UeACResponseData) +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + NSACF_S-->>NFSC: 5a. 200 OK (UeACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + +``` + +Sequence diagram illustrating the HPLMN Delegated NSAC procedure for controlling the number of UEs. The diagram shows three lifelines: NF Service Consumer in Serving PLMN, NSACF in Serving PLMN, and NSACF in Home PLMN. The sequence of messages is: 1. POST ../slices/ues (UeACRequestData) from NF Service Consumer to NSACF in Serving PLMN. 2. Response from NSACF in Serving PLMN to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx). 3. POST ../slices/ues (UeACRequestData) from NSACF in Serving PLMN to NSACF in Home PLMN. 4. Response from NSACF in Home PLMN to NSACF in Serving PLMN (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx). 5. Final response from NSACF in Serving PLMN to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx). + +**Figure 5.2.2.2.5-1: HPLMN Delegated NSAC procedure for controlling the number of UEs** + +- Same as step 1 of Figure 5.2.2.2.2-1, with the value of NSAC admission mode set to VPLMN with HPLMN assistance NSAC admission mode. +- For each S-NSSAI included in UeACRequestData, the NSACF in serving PLMN shall perform the actions to control the number of UEs. + - if centralized NSAC architecture is deployed in the VPLMN, same as step 2a of Figure 5.2.2.2.2-1; or + - if Hierarchical NSAC architecture is deployed in the VPLMN, same as step 4a of Figure 5.2.2.2.3-1. +- If there is no allocated maximum number of UEs from HPLMN or the allocated maximum number of registered UEs has been reached, the NSACF in serving PLMN shall send a POST request to the resource representing the network slice admission control related to the number of UEs (i.e. .../slices/ues) in the NSACF in HPLMN. + +The content of the POST request shall contain the input data structure (i.e. UeACRequestData) for network slice admission control, which shall contain the information received in step 1. + +- For each S-NSSAI included in UeACRequestData, the NSACF in HPLMN shall check the global maximum number of UEs and determines whether to accept or reject the request to update the local maximum number of UEs and/or the UE admission threshold configurations of NSACF in serving PLMN. + +The NSACF in HPLMN shall send allocated maximum number or admission threshold of registered UEs for the mapped S-NSSAI in HPLMN for inbound roamers as described in clause 4.2.11.5.2.3 of 3GPP TS 23.502 [3]. If in above NSACF in HPLMN handling not all S-NSSAIs are successful, "200 OK" shall be returned, with necessary response data indicating the failed S-NSSAI and the failure reason, e.g. "EXCEED\_MAX\_UE\_NUM". + +- On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.2.3.1-3. + +- On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +- If the response message includes the allocated maximum number of UEs and/or UE admission threshold for the mapped S-NSSAI in HPLMN for inbound roamers, the NSACF in serving PLMN shall replaces the local maximum number of UEs and/or the local UE admission threshold with the received updated values respectively. The NSACF in serving PLMN shall execute the same action as step 2a of this procedure based on the updated values; + +If the response does not include the allocated maximum number of UEs and/or UE admission threshold, the NSACF in serving PLMN shall return the response to NF service consumer based on the received NSAC response from NSACF in HPLMN. + +5b and 5c. Same as step 2b and 2c of Figure 5.2.2.2.2-1. + +#### 5.2.2.3 EACNotify + +##### 5.2.2.3.1 General + +The EACNotify service operation shall be used by the NSACF to inform the NF Service Consumer (e.g. AMF) of the activation/deactivation of EAC mode. It is used in the following procedures: + +- NSACF initiated configuration on EAC mode procedure (see clause 4.2.11.3 of 3GPP TS 23.502 [3]). + +##### 5.2.2.3.2 NSACF initiated EAC mode configuration + +The EACNotify service operation shall be used by the NSACF to configure the EAC mode(s) for S-NSSAI(s) to the NF Service Consumer (e.g. AMF). The EACNotify service operation shall be triggered when the NSACF decides to set the EAC mode for an S-NSSAI to "ACTIVE" if the number of UEs registered to an S-NSSAI is above certain threshold, or set the EAC mode for an S-NSSAI to "DEACTIVE" if the number of UEs registered to an S-NSSAI is below certain threshold. The activation threshold and the deactivation threshold may be same or different. + +If NF Service Consumer has implicitly subscribed to receive EAC notification, the NSACF shall notify the NF Service Consumer (e.g. AMF) to configure the EAC mode by using the HTTP POST method as shown in Figure 5.2.2.3.2-1. + +![Sequence diagram showing the NSACF initiated EAC mode configuration procedure. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` + +sequenceDiagram + participant NSACF + participant NFSC as NF Service Consumer + Note left of NFSC: POST {EACNotificationUri} (EACNotification) + NFSC->>NSACF: POST {EACNotificationUri} (EACNotification) + NSACF-->>NFSC: 2a. 204 No Content + NSACF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NFSC: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the NSACF initiated EAC mode configuration procedure. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 204 No Content, a 4xx/5xx ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.3.2-1: NSACF initiated EAC mode configuration procedure** + +1. The NSACF shall send a POST request to the EAC Notification callback URI provided by the NF Service Consumer (e.g. AMF). + +The content of the POST request shall contain the notification content (i.e. EACNotification), which shall contain the following information: + +- S-NSSAI(s); +- the EAC mode for each S-NSSAI. + +The callback URI may be provided by the AMF in the first interaction with the NSACF, or in later interactions when the callback URI is changed. + +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. +- 2b. On failure, one of the HTTP status code listed in Table 6.1.5.2.3.1-2 shall be returned. For a 4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.7.3-1. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +The NSACF may try several times to send EAC notification to the AMF, if no response is received from the AMF e.g. AMF is out of service. If the subsequent try still fails, the NSACF should stop sending EAC notification, unless the AMF becomes available. + +#### 5.2.2.4 NumOfPDUsUpdate + +##### 5.2.2.4.1 General + +The NumOfPDUsUpdate service operation shall be used by the NF Service Consumer (e.g. SMF or NSACF) to request the NSACF to control the number of PDU sessions registered to a specific slice, e.g. perform availability check and update the number of PDU sessions registered to a slice. It is used in the following procedures: + +- SMF initiated network slice admission control procedure for controlling the number of PDU sessions registered to a network slice (see clause 4.2.11.4 of 3GPP TS 23.502 [3]). +- SMF initiated network slice admission control procedure for controlling the number of LBO PDU sessions registered to a network slice (see clauses 4.2.11.5.1 and 4.2.11.5.2.4 of 3GPP TS 23.502 [3]). +- Combined SMF+PGW-C initiated network slice admission control procedure for controlling the number of PDU sessions registered to a network slice, in the case of EPS interworking (see clause 5.15.11.5 of 3GPP TS 23.501 [2], and clause 4.2.11.4 of 3GPP TS 23.502 [3]). +- Combined SMF+PGW-C initiated network slice admission control procedure related to control the number of UEs with at least one PDU session/PDN connection (see clause 5.15.11.5a of 3GPP TS 23.501 [2]). +- Hierarchical NSAC-based network slice admission control procedure for controlling the number of PDU sessions registered to a network slice (see clause 4.2.11.4a of 3GPP TS 23.502 [3]). + +The operation may also be used to update the number of existing PDU Sessions in the NSACF when NSAC is enabled or disabled for a slice which is already live in the network. + +##### 5.2.2.4.2 NSAC for controlling the number of PDU sessions + +The NF Service Consumer (e.g. SMF, combined SMF+PGW-C) shall invoke the NumOfPDUsUpdate service operation to request the NSACF to perform network slice admission control procedure related to the number of PDU sessions, by using the HTTP POST method as shown in Figure 5.2.2.4.2-1. + +![Sequence diagram showing the NSAC procedure for controlling the number of PDU sessions. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 200 OK, a 4xx/5xx error, or a 3xx redirect.](2834bdd6eb8540277e609decbb924003_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: NF Service Consumer + Note right of NSACF: NSACF + NF Service Consumer->>NSACF: 1. POST .../slices/pdus (PduACRequestData) + NSACF-->>NF Service Consumer: 2a. 200 OK (PduACResponseData) or 204 No Content + NSACF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the NSAC procedure for controlling the number of PDU sessions. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 200 OK, a 4xx/5xx error, or a 3xx redirect. + +**Figure 5.2.2.4.2-1: NSAC procedure for controlling the number of PDU sessions** + +1. The NF Service Consumer (e.g. SMF) shall send a POST request to the resource representing the network slice admission control related to the number of PDU sessions (i.e. .../slices/pdus) in the NSACF. + +The content of the POST request shall contain the input data structure (i.e. PduACRequestData) for network slice admission control, which shall contain the following information: + +- the SUPI of the UE; + +- the access type, over which the PDU session is to be established or released; +- the PDU session ID(s); +- a list of S-NSSAIs which are subject to NSAC, and for each S-NSSAI an update flag indicates the operation to that S-NSSAI. +- the NSAC Service Area of the NF consumer, if it is configured in the NF consumer. +- the NSAC admission mode of each S-NSSAI for inbound roamer, i.e. VPLMN NSAC admission mode or VPLMN with HPLMN assistance NSAC admission mode; +- the serving PLMN ID of the inbound roamer. + +In addition, the POST request may also contain: + +- the NF Instance ID of the requester NF (i.e. SMF); +- the PGW-C FQDN, if the request is sent by a combined SMF+PGW-C in EPS interworking case. +- the additional access type, for an Multi-Access PDU session, if the PDU session is to be established over both 3GPP access and Non-3GPP access, or if the PDU session is to be released from both 3GPP access and Non-3GPP access. + +The update flag within the PduACRequestData shall be set to the value as following: + +- "INCREASE" for a Single-Access PDU session which is to be established, or for an Multi-Access PDU session when new access leg(s) is to be established; +- "DECREASE" for a Single-Access PDU session which is to be released, or for an Multi-Access PDU session when existing access leg(s) is to be removed; +- "UPDATE" for a Single-Access PDU session when the access type is to be replaced with a new access type during inter access mobility. + +For LBO cases with VPLMN NSAC admission with or without HPLMN assistance, the NF Service Consumer in serving PLMN (e.g. vSMF) shall provide the S-NSSAI in serving PLMN, and the corresponding mapped S-NSSAI in home PLMN to the NSACF in serving PLMN. For LBO cases with HPLMN NSAC admission, the NF Service Consumer in serving PLMN (e.g. vSMF) shall provide the S-NSSAI in home PLMN (corresponding to the S-NSSAI in the VPLMN) to the NSACF in home PLMN. For PDU sessions in the home-routed roaming case, the NF Service Consumer in home PLMN (e.g. hSMF) shall provide S-NSSAI(s) in home PLMN to the NSACF in the home PLMN. + +2a. For each S-NSSAI included in PduACRequestData, the NSACF shall perform the following actions: + +- if the update flag is set to "INCREASE", the NSACF shall check whether the PDU session is already recorded in the PDU registration list in the NSACF and whether the total number of PDU sessions to this slice will exceed the maximum number of PDU sessions allowed to be registered to this slice: + - if the PDU session (identified by the UE ID and the PDU session ID) is already recorded in the PDU registration list, the NSACF shall skip recording this PDU session and shall not increase the total number of PDU sessions established to this network slice; + - if the PDU session is not recorded in the PDU registration list and the total number of PDU sessions (including the PDU session indicated in the request and the PDU sessions already stored in the NSACF) does not exceed the maximum number of PDU sessions allowed to be registered to this slice, the NSACF records the PDU session to the PDU registration list stored in the NSACF, and updates the total number of PDU sessions registered to this slice accordingly; + - if the PDU session is not recorded in the PDU registration list and if the total number of PDU sessions will exceed the maximum number of PDU sessions allowed to be registered to this slice, the NSACF shall not record the PDU session into the PDU registration list stored in the NSACF, and shall not update the total number of PDU sessions. Instead, the NSACF shall record this S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_PDU\_NUM" as specified in clause 6.1.6.3.5); + +- if the update flag is set to "DECREASE" and if the PDU session is recorded in the PDU registration list, the NSACF decreases the total number of PDU sessions registered to this slice, and removes the indicated PDU session from the PDU registration list stored in the NSACF. +- If the update flag is set to "DECREASE" and if the PDU session is not recorded in the PDU registration list, the NSACF shall not decrease the total number of PDU sessions registered to this slice and shall return successful handling for this PDU registration. +- If the update flag is set to "UPDATE", the NSACF shall locate the existing entry in the PDU registration list and update the access type associated to the PDU session to which indicated in the request message. + +The NSACF may be configured to perform per access type network slice admission control. In this case, the NSACF shall check whether the access type provided by the NF Service Consumer is configured for NSAC for the indicated S-NSSAI to control the number of PDU sessions. If the access type is not configured for NSAC for the indicated S-NSSAI, the NSACF shall skip the above handling for increasing/decreasing the number of PDU sessions and shall return successful for this S-NSSAI. If the access type is configured for NSAC for the indicated S-NSSAI, the NSACF shall perform the above handling taking the access type into account. If the update flag is set to "UPDATE", the NSACF shall first increase the number of PDU sessions for the new access type, and if successful then decrease the number of PDU sessions for the old access type. If the total number of PDU sessions will exceed the maximum number of PDU sessions allowed to be registered to this slice, the AcuFailureReason shall indicate the applied access type (e.g. "EXCEED\_MAX\_PDU\_NUM\_3GPP" or "EXCEED\_MAX\_PDU\_NUM\_N3GPP" as specified in clause 6.1.6.3.5). + +If the NSACF is not configured to perform per access type network slice admission control, the NSACF may perform network slice admission control without taking access type into account. For example, the NSACF is configured with a total quota for the PLMN, but the network slice admission control is not specific to one access type. The NSACF shall record the access type(s) associated with the PDU registration. The NSACF shall remove the PDU registration entry when the PDU session is released from all access types. + +NOTE 1: For each S-NSSAI that is applicable for NSAC, the NSACF is configured with a total quota for the PLMN. However, the network slice admission control may be configured to apply for one specific access type or both access types. + +If in above NSACF handling not all S-NSSAIs are successful, "200 OK" shall be returned, with necessary response data, e.g. indicating the failed S-NSSAI(s). + +If in above NSACF handling all S-NSSAIs are successful, "204 No Content" shall be returned. + +If the NSACF is configured with multiple NSAC Service Areas and is configured to perform NSAC admission on a per NSAC service area granularity, the NSACF shall perform the NSAC admission against the received NSAC service area in the request. + +NOTE 2: If the PLMN has multiple service areas and there are multiple NSACFs deployed for the network slice, each NSACF may be configured with the maximum number of PDU Sessions of the network slice within its service area, e.g. as per operator policy. If hierarchical NSAC architecture is deployed, how to synchronize the threshold among the primary NSACF and distributed NSACFs is specified in clause 5.2.2.2.3 and clause 5.2.2.5.2. Otherwise, how to split or synchronize the threshold in multiple NSACFs is left to implementation, and how to guarantee session continuity when a UE moves to new NSAC service area with a different NSACF is also left to implementation. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.3.3.1-3. + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse shall be included in the content of POST response. + +When the procedure is used to perform admission control for a number of UEs, when e.g. NSAC is enabled or disabled for an already live slice, then based on operator policy, SMF may allow or disallow sessions for which NSACF returned a reject. + +##### 5.2.2.4.3 NSAC for controlling the number of PDU sessions in hierarchical NSACF architecture + +When hierarchical NSACF architecture is deployed in the network, the NF Service Consumer (e.g. SMF, combined SMF+PGW-C) shall invoke the NumOfPDUsUpdate service operation to request the NSACF to perform network slice admission control procedure related to the number of PDU sessions. In this procedure, the NSACF may delegate the request to the primary NSACF for further processing. + +![Sequence diagram illustrating the NSAC procedure for controlling the number of PDU sessions in hierarchical NSACF architecture. The diagram shows three participants: NF Service Consumer, NSACF, and Primary NSACF. The sequence of messages is: 1. POST .../slices/pdus (PduACRequestData) from NF Service Consumer to NSACF; 2. Response from NSACF to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx); 3. POST .../slices/pdus (PduACRequestData) from NSACF to Primary NSACF; 4. Response from Primary NSACF to NSACF (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx); 5. Final response from NSACF to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx).](a0739aaf13fa5a632d4faa830f6b2708_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + participant Primary NSACF + Note left of NF Service Consumer: 1. POST .../slices/pdus (PduACRequestData) + NF Service Consumer->>NSACF: 1. POST .../slices/pdus (PduACRequestData) + Note right of NSACF: 2a. 200 OK (PduACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 2a. 200 OK (PduACResponseData) or 204 No Content +2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + Note right of NSACF: 3. POST .../slices/pdus (PduACRequestData) + NSACF->>Primary NSACF: 3. POST .../slices/pdus (PduACRequestData) + Note right of Primary NSACF: 4a. 200 OK (PduACResponseData) +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + Primary NSACF-->>NSACF: 4a. 200 OK (PduACResponseData) +4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + Note right of NSACF: 5a. 200 OK (PduACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 5a. 200 OK (PduACResponseData) or 204 No Content +5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + +``` + +Sequence diagram illustrating the NSAC procedure for controlling the number of PDU sessions in hierarchical NSACF architecture. The diagram shows three participants: NF Service Consumer, NSACF, and Primary NSACF. The sequence of messages is: 1. POST .../slices/pdus (PduACRequestData) from NF Service Consumer to NSACF; 2. Response from NSACF to NF Service Consumer (2a. 200 OK, 2b. 4xx/5xx, 2c. 3xx); 3. POST .../slices/pdus (PduACRequestData) from NSACF to Primary NSACF; 4. Response from Primary NSACF to NSACF (4a. 200 OK, 4b. 4xx/5xx, 4c. 3xx); 5. Final response from NSACF to NF Service Consumer (5a. 200 OK, 5b. 4xx/5xx, 5c. 3xx). + +**Figure 5.2.2.4.3-1: NSAC procedure for controlling the number of PDU sessions in hierarchical NSACF architecture** + +1. Same as step 1 of Figure 5.2.2.4.2-1. + +2a. For each S-NSSAI included in PduACRequestData, the NSACF shall perform action to control the number of PDU session. + +If the local maximum number of PDU sessions is reached, the NSACF may interact with the Primary NSACF to request an update of the local maximum number of PDU sessions before it returns a response to the NF Service Consumer. + +2b and 2c. Same as step 2b and 2c of Figure 5.2.2.4.2-1. + +3. If the NSAC processing involves the primary NSACF based on the mechanism defined in clause 4.2.11.4a of 3GPP TS 23.502 [3], the NF Service Consumer (e.g. NSACF) shall send a POST request to the resource representing the network slice admission control related to the number of PDU sessions (i.e. .../slices/pdus) in the primary NSACF. If the primary NSACF is not discovered, the NSACF shall discover the primary NSACF according to clause 6.3.22 of 3GPP TS 23.501 [2]. + +The content of the POST request shall contain the input data structure (i.e. PduACRequestData) for network slice admission control, which shall contain the information received in step 1. + +4a. For each S-NSSAI included in PduACRequestData, the primary NSACF shall check the global maximum PDU session number and determines whether to accept or reject the request to update the local maximum PDU session number from NSACF. + +The primary NSACF shall include the S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_PDU\_NUM" as specified in clause 6.1.6.3.5), if the request to update the local maximum PDU session number is rejected. + +The primary NSACF shall include a new allocated local maximum PDU sessions number in the response message, if the request to update the local maximum PDU session number is accepted. + +4b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.3.3.1-3. + +4c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse shall be included in the content of POST response. + +- 5a. If the response message includes the updated the local maximum number, the NSACF shall replaces the existing local maximum number with the received updated value, and the NSACF shall execute the same action as step 2a of Figure 5.2.2.4.2-1 based on the updated value; + +If the response does not include the updated local maximum number, the NSACF shall returns the response to NF service consumer based on the received NSAC response from Primary NSACF. + +- 5b and 5c. Same as step 2b and 2c of Figure 5.2.2.4.2-1. + +##### 5.2.4.2.4 NSAC for controlling the number of UEs with at least one PDU session/PDN connection per network slice + +The NumOfPDUsUpdate service operation may be invoked to control the number of UEs with at least one PDU session/PDN connection, by the combined SMF+PGW-C under the following conditions: + +- EPS interworking is supported; +- EPS counting is required for the network slice identified by an S-NSSAI; +- the network (e.g. combined SMF+PGW-C, NSACF) is configured to perform NSAC for the number of UEs with at least one PDU Session/PDN Connection. + +The combined SMF+PGW-C shall invoke the NumOfPDUsUpdate in the following cases: + +- when the UE establishes PDU session/PDN connection associated with the network slice in the combined SMF+PGW-C; +- when the PDU session/PDN connection associated with the network slice is released. + +When invoking NumOfPDUsUpdate, the procedure specified in clause 5.2.2.4.2 is applied, with the following differences: + +- Step 2a: + - for each S-NSSAI, the NSACF checks if the S-NSSAI is subject to counting the number of UEs with at least one PDU session/PDN connection. If no, the NSACF shall perform the existing NSAC handling as per clause 5.2.2.4.2. Otherwise, the NSACF shall perform the following steps: + - if the update flag is set to "INCREASE", the NSACF, shall behave as specified in clause 5.15.11.5a of 3GPP TS 23.501 [2] and clause 4.11.5.9a of 3GPP TS 23.502 [3]. + - if the counted UE number exceeds the configured maximum number of UEs with at least one PDU session/PDN connection, the NSACF shall record this S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_UE\_NUM" as specified in clause 6.1.6.3.5). + - if the update flag is set to "UPDATE", the NSACF performs necessary check and updates the stored information in the UE entry (e.g. access type), as specified in clause 4.11.5.9a of 3GPP TS 23.502 [3]. + - if the update flag is set to "DECREASE", the NSACF shall behave as specified in clause 5.15.11.5a of 3GPP TS 23.501 [2] and clause 4.11.5.9a of 3GPP TS 23.502 [3]. + - For the hierarchical NSAC architecture, the NSACF shall behave as specified in clause 5.2.2.4.3. + - If the local maximum number or local threshold is reached, the NSACF may interact with the Primary NSACF before it returns the response back to the SMF+PGW-C. For more details on handling between the NSACF and Primary NSACF see clause 4.2.11.4a of 3GPP TS 23.502 [3]. + +##### 5.2.2.4.5 NSAC for controlling the number of LBO PDU Sessions in case of VPLMN with HPLMN assistance NSAC mode + +For controlling of maximum number of LBO PDU Sessions for inbound roamers, the NF Service Consumer (e.g. SMF, vNSACF in Hierarchical NSAC architecture) shall invoke the NumOfPDUsUpdate service operation to request the NSACF in Serving PLMN (e.g. Central or Primary NSACF in VPLMN) to perform network slice admission control + +procedure related to the number of LBO PDU sessions. In this procedure, the NSACF in Serving PLMN shall delegate the request to the NSACF in HPLMN for further processing in specific cases. + +![Sequence diagram showing the interaction between NF Service Consumer in Serving PLMN, NSACF in Serving PLMN, and NSACF in Home PLMN for LBO PDU session control.](e90987faabad6a6665cd8ed1151dc474_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NSACF_S as NSACF in Serving PLMN + participant NSACF_H as NSACF in Home PLMN + + Consumer->>NSACF_S: 1. POST .../slices/pdus (PduACRequestData) + NSACF_S-->>Consumer: 2a. 200 OK (PduACResponseData) or 204 No Content + Note left of NSACF_S: 2b. 4xx/5xx (ProblemDetails) +2c. 3xx (RedirectResponse) + NSACF_S->>NSACF_H: 3. POST .../slices/pdus (PduACRequestData) + NSACF_H-->>NSACF_S: 4a. 200 OK (PduACResponseData) + Note left of NSACF_H: 4b. 4xx/5xx (ProblemDetails) +4c. 3xx (RedirectResponse) + NSACF_S-->>Consumer: 5a. 200 OK (PduACResponseData) or 204 No Content + Note left of NSACF_S: 5b. 4xx/5xx (ProblemDetails) +5c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between NF Service Consumer in Serving PLMN, NSACF in Serving PLMN, and NSACF in Home PLMN for LBO PDU session control. + +**Figure 5.2.2.4.5-1: HPLMN Delegated NSAC procedure for controlling the number of LBO PDU sessions** + +1. Same as step 1 of Figure 5.2.2.4.2-1, with the value of NSAC admission mode set to VPLMN with HPLMN assistance NSAC admission mode. +- 2a. For each S-NSSAI included in PduACRequestData, the NSACF in serving PLMN shall perform actions to control the number of PDU session. + - if centralized NSAC architecture is deployed in the VPLMN, same as step 2a of Figure 5.2.2.4.2-1; or + - if Hierarchical NSAC architecture is deployed in the VPLMN, same as step 4a of Figure 5.2.2.4.3-1. +- 2b and 2c. Same as step 2b and 2c of Figure 5.2.2.4.2-1. +3. If the maximum number of PDU Session is not available or the maximum number of PDU Sessions has been reached at the NSACF in serving PLMN, the NSACF in serving PLMN shall send a POST request to the resource representing the network slice admission control related to the number of PDU sessions (i.e. .../slices/pdus) in the NSACF in HPLMN. + +The content of the POST request shall contain the input data structure (i.e. PduACRequestData) for network slice admission control, which shall contain the information received in step 1. + +- 4a. For each S-NSSAI included in PduACRequestData, the NSACF in HPLMN shall check the global maximum PDU session number and determines whether to accept or reject the request to update the local maximum PDU session number configurations of NSACF in serving PLMN. + +The NSACF in HPLMN shall include the S-NSSAI in the failed list of S-NSSAI in the response message, together with an appropriate value of AcuFailureReason (e.g. "EXCEED\_MAX\_PDU\_NUM" as specified in clause 6.1.6.3.5), if the request is rejected. + +The NSACF in HPLMN shall send allocated maximum number of LBO PDU Sessions for the mapped S-NSSAI in HPLMN for inbound roamers in the response message, if the request to update the local maximum PDU session number is accepted, as described in clause 4.2.11.5.2.4 of 3GPP TS 23.502 [3]. + +- 4b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.3.3.1-3. + +- 4c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse shall be included in the content of POST response. +- 5a. If the response message includes the allocated maximum number of LBO PDU Sessions, the NSACF in serving PLMN shall replaces the existing local maximum number with the received updated value, and the NSACF in serving PLMN shall execute the same action as step 2a of this procedure based on the updated value; + +If the response does not include the allocated maximum number of LBO PDU Sessions, the NSACF in serving PLMN shall return the response to NF service consumer based on the received NSAC response from NSACF in HPLMN. + +5b and 5c. Same as step 2b and 2c of Figure 5.2.2.4.2-1. + +#### 5.2.2.5 LocalNumberUpdate + +##### 5.2.2.5.1 General + +The LocalNumberUpdate service operation shall be used by the NF service consumer (e.g., primary NSACF) to update the local maximum number of registered UEs and/or PDU sessions of a network slice at the NSACF. It is used in the following procedures: + +- Update of local maximum number in Hierarchical NSAC Architecture (see clause 4.2.11.6 of 3GPP TS 23.502 [3]). + +The LocalNumberUpdate service operation shall also be used by the NF service consumer (e.g. primary or central NSACF in HPLMN) to update the local maximum number of registered roaming UEs and/or LBO PDU sessions of a network slice at the primary or central NSACF in VPLMN. It is used in the following procedures: + +- VPLMN with HPLMN assistance NSAC Admission mode for number of registered roaming UEs and number of LBO PDU sessions (see clause 4.2.11.5.2.2 of 3GPP TS 23.502 [3]). + +##### 5.2.2.5.2 Update of local maximum number of UEs or PDU sessions + +The LocalNumberUpdate service operation shall be used by the NF service consumer to update the local maximum number of registered UEs and/or PDU sessions of the network slice at the NSACF by using the HTTP POST method as shown in Figure 5.2.2.5.2-1. + +![Sequence diagram showing the NSAC procedure for updating the numbers of UEs and/or PDU sessions. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 204 No Content or a 3xx/4xx/5xx (ProblemDetails) response.](ead623e6a8ec701df64567695a57d01c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: POST request + NF Service Consumer->>NSACF: 1. POST .../slices/local-configs/update (ACUpdateData) + Note right of NSACF: Response + NSACF-->>NF Service Consumer: 2a. 204 No Content + Note right of NSACF: ProblemDetails + NSACF-->>NF Service Consumer: 2b. 3xx/4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the NSAC procedure for updating the numbers of UEs and/or PDU sessions. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with either a 204 No Content or a 3xx/4xx/5xx (ProblemDetails) response. + +**Figure 5.2.2.5.2-1: NSAC procedure for updating the numbers of UEs and/or PDU sessions** + +1. The NF Service Consumer (i.e., primary NSACF or central NSACF) shall send a POST request to the resource representing the network slice admission control configurations (i.e., .../slices/local-configs-update) in the NSACF. + +The content of the POST request shall contain the input data structure (i.e., ACUpdateData), which shall contain the following information to update the local maximum number of registered UEs and/or (LBO) PDU sessions in the Hierarchical NSAC Architecture: + +- the S-NSSAIs subject to NSAC for which an updated number of maximum number of UEs or PDU sessions needs to be provided; +- the updated local maximum number of registered UEs, if this information is changed; and +- the updated local maximum number of PDU sessions if this information is changed. + +Or it shall contain the following information in VPLMN with HPLMN assistance NSAC Admission mode: + +- the S-NSSAIs mapped in HPLMN subject to NSAC for which an update of the maximum number of registered roaming UEs or LBO PDU sessions needs to be provided; + - the updated local maximum number of registered roaming UEs, if this information is changed; and + - the updated local maximum number of LBO PDU sessions if this information is changed. +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. The updated values of the local maximum number of registered UEs and/or PDU sessions may directly apply to current NSAC pending requests in NSACF and they shall be used for all future requests as specified in clause 5.15.11.1.2 of 3GPP TS 23.501 [2]. +- 2b. On failure, one of the HTTP status codes listed in Table 6.1.3.4.3.1-3 shall be returned. + +#### 5.2.2.6 QuotaUpdate + +##### 5.2.2.6.1 General + +The QuotaUpdate service operation shall be used to request the primary or central NSACF at HPLMN to return the maximum number of registered UEs and/or the maximum number of LBO PDU sessions of a network slice to the primary or central NSACF of VPLMN for inbound roamers when the VPLMN NSAC admission mode is determined. + +It is used in the following procedures: + +- Network Slice Admission Control Support for Roaming by VPLMN (see clause 4.2.11.5.1 of 3GPP TS 23.502 [3]). + +##### 5.2.2.6.2 Update of maximum number of UEs and/or PDU sessions + +The QuotaUpdate service operation shall be used by the NF service consumer to fetch the maximum number of registered UEs and/or the maximum number of LBO PDU sessions of a network slice at the primary or central NSACF at HPLMN for inbound roamers by using the HTTP POST method as shown in Figure 5.2.2.6.2-1. + +![Sequence diagram showing the NSAC procedure for fetching the quota of the number of UEs and/or LBO PDU sessions at the HPLMN NSACF for inbound roamers. The diagram involves two participants: NF Service Consumer and NSACF. The sequence is: 1. POST .../slices/roaming-quotas/query (QuotaUpdateRequestData) from NF Service Consumer to NSACF. 2a. 200 OK (QuotaUpdateResponseData) from NSACF to NF Service Consumer. 2b. 3xx/4xx/5xx (ProblemDetails) from NSACF to NF Service Consumer.](1c29dadab94c3fa552d270434db09c81_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: 1. POST .../slices/roaming-quotas/query (QuotaUpdateRequestData) + NF Service Consumer->>NSACF: 1. POST .../slices/roaming-quotas/query (QuotaUpdateRequestData) + Note right of NSACF: 2a. 200 OK (QuotaUpdateResponseData) + NSACF-->>NF Service Consumer: 2a. 200 OK (QuotaUpdateResponseData) + Note right of NSACF: 2b. 3xx/4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2b. 3xx/4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the NSAC procedure for fetching the quota of the number of UEs and/or LBO PDU sessions at the HPLMN NSACF for inbound roamers. The diagram involves two participants: NF Service Consumer and NSACF. The sequence is: 1. POST .../slices/roaming-quotas/query (QuotaUpdateRequestData) from NF Service Consumer to NSACF. 2a. 200 OK (QuotaUpdateResponseData) from NSACF to NF Service Consumer. 2b. 3xx/4xx/5xx (ProblemDetails) from NSACF to NF Service Consumer. + +**Figure 5.2.2.6.2-1: NSAC procedure for fetching the quota of the number of UEs and/or LBO PDU sessions at the HPLMN NSACF for inbound roamers** + +1. The NF Service Consumer (i.e., primary or central NSACF at VPLMN) shall send a POST request to the resource representing the network slice admission control related to the quota update (i.e., .../slice/roaming-quotas/query) in the primary or central HPLMN NSACF. + +The content of the POST request shall contain the input data structure (i.e., QuotaUpdateRequestData), which shall contain the following information: + +- the S-NSSAI mapped in HPLMN subject to NSAC for which the available quota for the maximum number of inbound roaming UEs and/or LBO PDU sessions needs to be provided; + +- the serving PLMN ID of the UE for which quotas are requested; and + - the requested quota type indicating if the requested quota is for the maximum number of registered inbound roaming UEs and/or the maximum number of LBO PDU sessions. +- 2a. On success, "200 OK" shall be returned and the content of the POST response shall contain input data structure (i.e., QuotaUpdateResponseData), which shall contain the following information: +- The updated maximum number of registered inbound roaming UEs and/or the maximum number of LBO PDU sessions. +- 2b. On failure, one of the HTTP status codes listed in Table 6.1.3.5.4.2.2-2 shall be returned. + +## 5.3 Nnsacf\_SliceEventExposure Service + +### 5.3.1 Service Description + +The Nnsacf\_SliceEventExposure services provide event based notifications to the consumer NF (e.g. to NEF, AF, DCCF or NWDAF) related to the number of UEs registered to a network slice or the number of PDU Sessions established to a network slice. + +If, in accordance with operator policy and national/regional regulations, the NF Service Consumer (i.e. the AMF or the SMF) needs to exempt UEs/PDU Sessions that are used for emergency, mission critical and/or priority services (e.g. MCS, MPS) from NSAC, then the NF service consumer may send a request to NSACF and ignore the NSACF response. Therefore, if a UE/PDU session is rejected by NSACF, then the reports generated by the NSACF would not have counts of those UEs/PDU-Sessions, despite the UEs accessing the corresponding slice(s). Alternatively, the NF Service Consumer (i.e. the AMF or the SMF) may not invoke the corresponding NSAC procedure for the exempted UE/PDU Session, i.e. those UEs/PDU Sessions are not counted towards the maximum number of UEs/PDU Sessions (see clause 5.15.11.0 of 3GPP TS 23.501 [2]). + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +For the Nnsacf\_SliceEventExposure service the following service operations are defined: + +- Subscribe, including creation or modification of a subscription; +- Unsubscribe; +- Notify. + +#### 5.3.2.2 Subscribe + +##### 5.3.2.2.1 General + +This service operation is used by the consumer NF (e.g. NEF, AF, DCCF, NSACF or NWDAF) to subscribe or modify a subscription with the NSACF for event based notifications for: the number of UEs registered to a network slice, or the number of PDU Sessions established to a network slice. + +NOTE: In notifications reporting the number of UEs registered to a network slice, the NSACF can indicate whether the reported number of UEs correspond to UEs with at least one PDU session/PDN connection. See clause 5.3.2.4.1. + +##### 5.3.2.2.2 Creation of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) towards the NSACF, when it needs to create a subscription to monitor the event relevant to the NSACF. + +The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.2.3.1. + +The NF Service Consumer shall include the following information in the HTTP message body: + +- NF ID, indicates the identity of the network function instance initiating the subscription; +- Notification URI, indicates the address to deliver the event notifications generated by the subscription; +- Notification Correlation ID, indicates the correlation identity to be carried in the event notifications, the value of this IE shall be unique per subscription for a given NF service consumer receiving the notification; +- SAC Event Type, defines which type of events to notify (e.g. the number of UEs registered to a network slice, or the number of PDU Sessions established on a network slice); +- Event Filter, indicate the S-NSSAI(s) in serving PLMN and/or mapped S-NSSAI(s) in home PLMN to be monitored and reported. +- SAC Event Report Triggers, defines whether the notification is threshold triggered (e.g. the notification is triggered when the current number of UEs or PDU Sessions with a network slice reaches a defined threshold value) or the notification is periodic triggered (e.g. the notification is triggered at expiry of a periodic timer). +- Notification threshold if the SAC Event Report Triggers is threshold triggered, defines a numeric value or a percentage of the maximum number of the UEs or PDU Sessions per network slice; +- Notification periodicity if the SAC Event Report Triggers is periodic triggered, defines the time between the notification periodicity; +- a notification flag as "notifFlag" attribute if the EEMM feature is supported; and/or +- Muting Exception Instructions, which specify instructions to apply to the subscription and the stored events when an exception occurs at the NSACF while the event is muted (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number), if the EEMM feature is supported (see clause 6.2.8). + +![Sequence diagram showing the interaction between NF Service Consumer and NSACF for subscription creation. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with a 201 Created status code and a CreatedSACEventSubscription object. The NF Service Consumer then receives a 4xx/5xx ProblemDetails response and a 3xx RedirectResponse.](98e54d5540b2efe3e24af3cf936bc4ea_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant NSACF as NSACF + Note left of NFSC: + NFSC->>NSACF: 1. POST .../subscriptions (SACEventSubscription) + Note right of NSACF: + NSACF-->>NFSC: 2a. 201 Created (CreatedSACEventSubscription) + Note right of NSACF: + NSACF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) + Note right of NSACF: + NSACF-->>NFSC: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between NF Service Consumer and NSACF for subscription creation. The NF Service Consumer sends a POST request to the NSACF. The NSACF responds with a 201 Created status code and a CreatedSACEventSubscription object. The NF Service Consumer then receives a 4xx/5xx ProblemDetails response and a 3xx RedirectResponse. + +**Figure 5.4.2.2.2-1 Subscribe for Creation** + +1. The NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) shall send a POST request to create a subscription resource in the NSACF. The content of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer, representing the time up to which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report. +- 2a. On success, the request is accepted, the NSACF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. + +The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the NSACF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NSACF. The NSACF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time. + +If the immediateFlag attribute is set to "true" in the request message, the NSACF shall include the current number of UEs or PDU Sessions per network slice in the response immediately. + +If the NSACF supports the EEMM feature and the "notifFlag" attribute is included and set to "DEACTIVATE" in the request by e.g. the NWDAF or DCCF, the NSACF shall mute the event notification and store the available events. Additionally, if the NF service consumer also included event muting instructions in the request, the NSACF should evaluate the received event muting instructions against local actions (if configured) and, if the subscription creation request is accepted, the NSACF may indicate the following information to the NF service consumer in the response: + +- the maximum number of notifications that the NSACF expects to be able to store for the subscription; +- an estimate of the duration for which notifications can be buffered. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.2.3.2.3.1-3. + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +If the NSACF supports the EEMM features (see clause 6.2.8), the NF service consumer sets the "notifFlag" attribute to "DEACTIVATE" and event muting instructions in the request, but the NSACF cannot accept the received instructions, the NSACF may reject the request with a 403 Forbidden response and the application error "MUTING\_EXC\_INSTR\_NOT\_ACCEPTED". + +##### 5.3.2.2.3 Modification of a subscription + +The Subscribe service operation is invoked by a NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) towards the NSACF, when it needs to modify an existing subscription previously created by itself at the NSACF. + +When the subscription is to be expired, the NF service consumer may request the NSACF to update the subscription by indicating a new expiry time. The NSACF may return a new expiry time based on local policy, taking into account of the NF service consumer provided expiry time. + +To perform a partial update of the subscription of a given subscription Id, the NF Service Consumer shall issue an HTTP PATCH request, as shown in Figure 5.3.2.2.3-1. This partial update shall be used to add, delete and/or replace individual parameters of the subscription. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSACF for subscription partial modification. The NF Service Consumer sends a PATCH request to the NSACF. The NSACF responds with one of three options: 2a. 200 OK (PatchResult) or 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: NF Service Consumer + Note right of NSACF: NSACF + NF Service Consumer->>NSACF: 1. PATCH .../subscriptions/{subscriptionId} (SACEventSubscription) + NSACF-->>NF Service Consumer: 2a. 200 OK (PatchResult) or 204 No Content + NSACF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSACF for subscription partial modification. The NF Service Consumer sends a PATCH request to the NSACF. The NSACF responds with one of three options: 2a. 200 OK (PatchResult) or 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.3.2.2.3-1 Subscription partial modification** + +1. The NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) shall send a PATCH request to the resource URI representing the individual subscription, identified by the {subscriptionId}. The content of the PATCH request shall contain the list of operations (add/delete/replace) to be applied to parameters in the individual subscription. +- 2a. On success, the request is accepted, the NSACF shall return the representation of the updated subscription resource with the status code "200 OK", or "204 No Content" shall be returned. + +"204 No Content" may be returned, if the NF Service Producer accepts entirely the resource representation provided by the NF Service Consumer in the request. For example, the request contained a proposed expiry time + +and it is accepted by the NF Service Producer as the expiration time for the subscription, or the request did not contain a proposed expiry time and no expiration time is set by the NF Service Producer for the subscription. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") shall be returned. + +A ProblemDetails IE shall be included in the content of PATCH response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.2.3.3.3.1-3. + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of PATCH response. + +To perform a complete replacement of the subscription of a given subscription Id, the NF Service Consumer shall issue an HTTP PUT request, as shown in Figure 5.3.2.2.3-2: + +![Sequence diagram showing the interaction between an NF Service Consumer and an NSACF for a Subscription Complete Replacement. The NF Service Consumer sends a PUT request (1) to the NSACF. The NSACF responds with one of three options: 2a. 200 OK (CreatedSACEventSubscription), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](1b893df61c2b73b7a85e65fc1f58e203_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: 1. PUT .../subscriptions/{subscriptionId} (SACEventSubscription) + NF Service Consumer->>NSACF: 1. PUT .../subscriptions/{subscriptionId} (SACEventSubscription) + NSACF-->>NF Service Consumer: 2a. 200 OK (CreatedSACEventSubscription) + NSACF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NSACF for a Subscription Complete Replacement. The NF Service Consumer sends a PUT request (1) to the NSACF. The NSACF responds with one of three options: 2a. 200 OK (CreatedSACEventSubscription), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.3.2.2.3-2 Subscription Complete Replacement** + +1. The NF service consumer (e.g. NEF, AF, DCCF or NWDAF) shall send a PUT request to the resource URI representing the individual subscription, identified by the {subscriptionId}. The content of the PUT request shall contain a representation of the individual subscription to be completely replaced in the NSACF. + +2a. On success, the request is accepted, the NSACF shall include the resource (subscription) after replacement together with the status code "200 OK" indicating the requested resource is updated in the response message. + +The response, based on operator policy and taking into account the expiry time included in the request if any, may contain the expiry time as defined in 5.3.2.2.2. + +If the immediateFlag attribute is set to "true" in the request message, the NSACF shall include the current number of UEs or PDU sessions per network slice in the response immediately. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") shall be returned. + +A ProblemDetails IE shall be included in the content of PUT response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.2.3.3.3.2-3. + +2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of PUT response. + +##### 5.3.2.2.4 Creation of a one time and immediate reporting subscription + +The NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) may request the NSACF to immediately provide the current network slice status information (e.g. the number of UEs registered to a network slice, the current number of PDU Sessions established to a network slice). In this case, the NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) shall request the NSACF to create a temporary subscription and response with immediate report, as follows. + +1. The NF Service Consumer shall send a POST request as specified in step 1 of clause 5.3.2.2.2, with the following additional information: + +- the maxReports attribute set to 1 and the immediateFlag attribute set to "true". + +2a. The NSACF shall send a POST response as specified in step 2a of clause 5.3.2.2.2, with the following additional information: + +- the NSACF shall include the current number of UEs or PDU Sessions per network slice in the response immediately and shall terminate the subscription of the event. + +The NSACF shall terminate the subscription of the event after sending response to the NF Service Consumer. + +2b. Same as step 2b of figure 5.3.2.2.2-1. + +2c. Same as step 2c of figure 5.3.2.2.2-1. + +#### 5.3.2.3 Unsubscribe + +##### 5.3.2.3.1 General + +This service operation is used by the consumer NF (e.g. NEF, AF, DCCF or NWDAF) to unsubscribe from the event notification. + +The NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) shall unsubscribe to the subscription by using HTTP method DELETE. + +![Sequence diagram for Unsubscribe a subscription. The diagram shows two lifelines: NF Service Consumer and NSACF. The NF Service Consumer sends a DELETE request to the NSACF. The NSACF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](b54ce9bffd341cd643e196d5f4538829_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSACF + Note left of NF Service Consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF Service Consumer->>NSACF: 1. DELETE .../subscriptions/{subscriptionId} + Note right of NSACF: 2a. 204 No Content + NSACF-->>NF Service Consumer: 2a. 204 No Content + Note right of NSACF: 2b. 4xx/5xx (ProblemDetails) + NSACF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + Note right of NSACF: 2c. 3xx (RedirectResponse) + NSACF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Unsubscribe a subscription. The diagram shows two lifelines: NF Service Consumer and NSACF. The NF Service Consumer sends a DELETE request to the NSACF. The NSACF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.3.2.3.1-1: Unsubscribe a subscription** + +1. The NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF) shall send a DELETE request to delete an existing subscription resource in the NSACF. +- 2a. On success, the request is accepted, the NSACF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message. +- 2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") shall be returned. + +A ProblemDetails IE shall be included in the content of DELETE response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.2.3.3.3.3-3. + +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of DELETE response. + +#### 5.3.2.4 Notify + +##### 5.3.2.4.1 General + +This service operation is used by the NSACF to report the current status of certain network slice (e.g. the number of UEs registered to a network slice, or the current number of PDU Sessions established on a network slice in numbers or in percentage from the maximum allowed numbers). + +While counting the number of UEs registered to a network slice, or counting the number of UEs registered to a network slice with at least one PDU session/PDN connection, the NSACF shall not count twice the UE Ids stored temporarily due to the AMF mobility scenario. + +When reporting the number of UEs registered to a network slice, the NSACF may indicate whether the reported number of UEs correspond to UEs with at least one PDU session/PDN connection. + +![Sequence diagram showing the Notify procedure between an NF Service Consumer and an NSACF. Step 1 is a POST request from NSACF to NF Service Consumer. Steps 2a, 2b, and 2c are alternative responses from the NF Service Consumer to the NSACF.](6e15fc9ea763541c5913d26f85072ae1_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer + participant NSACF + NSACF->>NFSC: 1. POST {eventNotificationUrl}(SACEventReport) + NFSC-->>NSACF: 2a. 204 No Content + NFSC-->>NSACF: 2b. 4xx/5xx (ProblemDetails) + NFSC-->>NSACF: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Notify procedure between an NF Service Consumer and an NSACF. Step 1 is a POST request from NSACF to NF Service Consumer. Steps 2a, 2b, and 2c are alternative responses from the NF Service Consumer to the NSACF. + +**Figure 5.3.2.4.1-1: Notify** + +1. The NSACF shall send a POST request to send a notification. + +If the notification is threshold triggered, the NSACF shall send the notification every time if there is a change from being below the threshold to reach the threshold, or from reaching the threshold to coming down below the threshold (see clause 4.15.3.2.10 of 3GPP TS 23.502 [3]). When a subscription is created and the current number of UEs or number of PDU sessions reaches the threshold, the NSACF shall send the notification immediately. + +###### EXAMPLE: + +If the threshold for the reporting of the number of registered UEs is 100, the behaviour of the NSACF as below: + +- the current number of registered UEs is 100 when the subscription is created, the NSACF shall send a notification to the NF service consumer, then +- the current number of registered UEs is changed to 99, the NSACF shall send a notification to the NF service consumer, then +- the current number of registered UEs is changed to 90, the NSACF shall not send notification, then +- the current number of registered UEs is changed to 100, the NSACF shall send a notification to the NF service consumer, then +- the current number of registered UEs is changed to 110, the NSACF shall not send notification. + +For periodic reporting, the NSACF shall contain the current number of registered UEs in the concerned network slice or the current number of established PDU sessions in the concerned network slice expressed in percentage and in numerical to the NF Service Consumer. + +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer (e.g. NEF, AF, DCCF or NWDAF). +- 2b. On failure, the appropriate HTTP status code (e.g. "404 Not Found") shall be returned and appropriate additional information should be returned. + + A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.2.5.2.2.1-3. +- 2c. On redirection, "307 Temporary Redirect" or "308 Permanent Redirect" shall be returned. A RedirectResponse IE shall be included in the content of POST response. + +# 6 API Definitions + +## 6.1 Nnsacf\_NSAC Service API + +### 6.1.1 Introduction + +The Nnsacf\_NSAC shall use the Nnsacf\_NSAC API. + +The API URI of the Nnsacf\_NSAC API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnsacf-nsac". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnsacf\_NSAC API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +The figure 6.1.3.1-1 describes the resource URI structure of the Nnsacf-NSAC API. + +![Resource URI structure of the Nnsacf_NSAC API diagram](6be06b7dc72bb42afcb3465394667c3b_img.jpg) + +``` +graph TD; Root["//{apiRoot}/nnsacf-nsac/"] --- Slices["/slices"]; Root --- Ues["/ues"]; Root --- Pdus["/pdus"]; Root --- LocalConfigs["/local-configs"]; Root --- RoamingQuotas["/roaming-quotas"]; LocalConfigs --- Update["/update"]; RoamingQuotas --- Query["/query"]; +``` + +The diagram illustrates the hierarchical structure of the Nnsacf-NSAC API. The root path is `//{apiRoot}/nnsacf-nsac/`. From this root, five main resource paths branch out: `/slices`, `/ues`, `/pdus`, `/local-configs`, and `/roaming-quotas`. The `/local-configs` path further branches into `/update`, and the `/roaming-quotas` path further branches into `/query`. The `/update` and `/query` paths are shown with dashed boxes around them. + +Resource URI structure of the Nnsacf\_NSAC API diagram + +**Figure 6.1.3.1-1: Resource URI structure of the Nnsacf\_NSAC API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Slice Collection Subject to NSAC for UEs (Collection) | /slices/ues | POST | Request the NSACF to perform network slice admission control related to the number of UEs registered to a network slice, or a group of network slices. | +| Slice Collection Subject to NSAC for PDU sessions (Collection) | /slices/pdus | POST | Request the NSACF to perform network slice admission control related to the number of PDU sessions established to a network slice, or a group of network slices. | +| Slice Collection Configurations | /slices/local-configs/update | update (POST) | Request the NSACF to update the Network slice local configurations for NSAC procedure, i.e., to update the local maximum number of registered UEs and/or the local maximum number of PDU sessions established per Network slice. | +| Slice Collection Roaming Quotas | /slices/roaming-quotas/query | query (POST) | Request the NSACF at HPLMN to update the maximum number of registered UEs and/or number of LBO PDU sessions of the network slice at the NSACF of VPLMN for inbound roamers for VPLMN NSAC admission mode. | + +#### 6.1.3.2 Resource: Slice Collection Subject to NSAC for UEs + +##### 6.1.3.2.1 Description + +This resource represents the collection of slice subject to NSAC for UEs. + +This resource is modelled with the Store resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}///slices/ues + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +Table 6.1.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------------------| +| UeACRequestData | M | 1 | Request data for NSAC procedure related to the number of UEs per slice. | + +**Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeACResponseData | M | 1 | 200 OK | Response data for NSAC procedure related to the number of UEs per slice, in the case of not all S-NSSAIs are successful in the NSAC procedure. | +| n/a | | | 204 No Content | Upon success. Indicates all S-NSSAIs are successful in the NSAC procedure. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during a NSAC procedure. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | When used to represent the failure of NSAC procedure, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:
- SLICE_NOT_FOUND, if all S-NSSAIs provided in the request are not found from the NSSAI which are subject to NSAC procedure;
- ALL_SLICE_FAILED, if the list of S-NSSAIs is fully failed in the NSAC procedure;
- NSAC_SERVICE_AREA_NOT_SUPPORT, if the NSAC Service Area included in the request is not supported by the NSACF.
- NSAC_SERVICE_AREA_REQUIRED, if the NSACF has been configured with multiple NSAC Service Areas to perform NSAC admission on a per NSAC Service Area, and there is no NSAC Service Area received in the request. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.2.4 Resource Custom Operations + +In this release of this specification, no custom operations associated to this resource is defined. + +#### 6.1.3.3 Resource: Slice Collection Subject to NSAC for PDU sessions + +##### 6.1.3.3.1 Description + +This resource represents the collection of slice subject to NSAC for PDU sessions. + +This resource is modelled with the Store resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}//slices/pdus + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 POST + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +**Table 6.1.3.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------------------------------------| +| PduACRequestData | M | 1 | Request data for NSAC procedure related to the number of PDU sessions per slice. | + +Table 6.1.3.3.3.1-3: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PduACResponseData | M | 1 | 200 OK | Response data for NSAC procedure related to the number of PDU sessions per slice, in the case of not all S-NSSAIs are successful in the NSAC procedure. | +| n/a | | | 204 No Content | Upon success. Indicates all S-NSSAIs are successful in the NSAC procedure. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | When used to represent the failure of NSAC procedure, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:
- SLICE_NOT_FOUND, if all S-NSSAIs provided in the request are not found from the NSSAI which are subject to NSAC procedure;
- ALL_SLICE_FAILED, if the list of S-NSSAIs is fully failed in the NSAC procedure;
- NSAC_SERVICE_AREA_NOT_SUPPORT, if the NSAC Service Area included in the request is not supported by the NSACF.
- NSAC_SERVICE_AREA_REQUIRED, if the NSACF has been configured with multiple NSAC Service Areas to perform NSAC admission on a per NSAC Service Area, and there is no NSAC Service Area received in the request. | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +Table 6.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +In this release of this specification, no custom operations associated to this resource is defined. + +#### 6.1.3.4 Resource: Slice Collection Configurations + +##### 6.1.3.4.1 Description + +This resource represents the Slice Collection configurations, i.e. local configurations of the maximum number of registered UEs and/or maximum number of PDU sessions established at a network slice. + +##### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/slices/configs + +This resource shall support the resource URI variables defined in table 6.1.3.w.2-1. + +**Table 6.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.4.3 Resource Standard Methods + +In this release of this specification, no standard operations associated to this resource is defined. + +##### 6.1.3.4.4 Resource Custom Operations + +###### 6.1.3.4.4.1 Overview + +**Table 6.1.3.4.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| update | /slices/local-configs/update | POST | Request the NSACF to update the network slice local configurations for NSAC procedure, i.e., to update the local maximum number of registered UEs and/or the local maximum number of PDU sessions established per Network slice. | + +###### 6.1.3.4.4.2 Operation: update (POST) + +###### 6.1.3.4.4.2.1 Description + +This custom operation is used to update the Slice Collection configurations, i.e. local configurations of the maximum number of registered UEs and/or maximum number of PDU sessions established at a network slice. + +###### 6.1.3.4.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.4.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.4.4.2.2-2. + +**Table 6.1.3.4.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ACUpdateData | M | 1 | Provide the local configuration data for NSAC procedure related to update the local maximum number of registered UEs and/or the local maximum number of PDU sessions of the network slice at a NSACF. | + +**Table 6.1.3.4.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Indicates successful processing of the request to update the local configuration for NSAC procedure, i.e., the local maximum number of registered UEs and/or the local maximum number of PDU sessions per network slice. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the network slice with which the updated local maximum number of registered UEs and/or PDU sessions relates is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- LOCAL_CONFIG_NOT_FOUND | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.4.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.4.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +#### 6.1.3.5 Resource: Slice Collection Roaming Quotas + +##### 6.1.3.5.1 Description + +This resource represents the Slice Collection subject to roaming quotas update, i.e. quota update of the maximum number of registered UEs and/or maximum number of PDU sessions established at a network slice in a primary or central VPLMN NSACF for inbound roamers for VPLMN NSAC admission mode. + +##### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}//slices/roaming-quotas + +This resource shall support the resource URI variables defined in table 6.1.3.5.2-1. + +**Table 6.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.5.3 Resource Standard Methods + +None. + +##### 6.1.3.5.4 Resource Custom Operations + +###### 6.1.3.5.4.1 Overview + +**Table 6.1.3.5.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| query | /slices/roaming-quotas/query | POST | Request the NSACF at HPLMN to update the maximum number of registered UEs and/or maximum number of LBO PDU sessions of the network slice at the NSACF of VPLMN for inbound roamers for VPLMN NSAC admission mode. | + +###### 6.1.3.5.4.2 Operation: query + +###### 6.1.3.5.4.2.1 Description + +This custom operation is used to request the central or primary NSACF at HPLMN to update the maximum number of registered UEs and/or number of LBO PDU sessions of the network slice at the central or primary NSACF at VPLMN for inbound roamers for VPLMN NSAC admission mode. + +###### 6.1.3.5.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 6.1.3.5.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.5.4.2.2-2. + +**Table 6.1.3.5.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| QuotaUpdateRequestData | M | 1 | Provide the data for NSAC procedure related to quota update of the maximum number of registered UEs and/or number of LBO PDU sessions of the network slice at the primary or central NSACF in a VPLMN for inbound roamers for VPLMN NSAC admission mode. | + +**Table 6.1.3.5.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| QuotaUpdateResponseData | M | 1 | 200 OK | Response data for NSAC procedure related to the quota update of the number of UEs and/or number of LBO PDU sessions of the network slice in VPLMN for inbound roamers for VPLMN NSAC admission mode. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection, during a NSAC procedure.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP or SEPP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.5.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.5.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined. + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------|----------------------|---------------------------------|---------------------------------------------------------------------------------------| +| EAC Mode Notification | {EACNotificationUri} | POST | Notify the NF Service Customer (e.g. AMF) of the activation/deactivation of EAC mode. | + +#### 6.1.5.2 EAC Mode Notification + +##### 6.1.5.2.1 Description + +The EAC Mode Notification is used by the NSACF to inform the NF Service Consumer (e.g. AMF) of the activation/deactivation of EAC mode. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{EACNotificationUri}" shall be used with the callback URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Callback URI variables** + +| Name | Definition | +|--------------------|-------------------------------------------------------| +| eacNotificationUri | Notification URI for receiving EAC mode notification. | + +##### 6.1.5.2.3 Standard Methods + +###### 6.1.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and response codes specified in table 6.1.5.2.3.1-1. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------| +| EACNotification | M | 1 | EAC mode notification | + +**Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|-----------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------| +| | | | | | +| NOTE: | The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nnsacf\_NSAC service based interface protocol. + +**Table 6.1.6.1-1: Nnsacf\_NSAC specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------| +| UeACRequestData | 6.1.6.2.2 | Input data for NSAC procedure related to the number of UEs per slice. | | +| UeACResponseData | 6.1.6.2.3 | Response data of NSAC procedure for controlling the number of UEs. | | +| EACNotification | 6.1.6.2.4 | EAC mode notification | | +| AcuOperationItem | 6.1.6.2.5 | An operation item for NSAC procedure, indicating an S-NSSAI subject to NSAC and the associated operation. | | +| AcuFailureItem | 6.1.6.2.6 | A failure item which indicates the failed S-NSSAI and the failure reason. | | +| PduACRequestData | 6.1.6.2.7 | Input data for NSAC procedure related to the number of PDUs per slice. | | +| PduACResponseData | 6.1.6.2.8 | Response data of NSAC procedure for controlling the number of PDU sessions. | | +| EACMode | 6.1.6.3.3 | EAC mode | | +| AcuFlag | 6.1.6.3.4 | Update Flag for NSAC procedure | | +| AcuFailureReason | 6.1.6.3.5 | Indicates the failure reason for an S-NSSAI in the NSAC procedure | | +| UeACRequestInfo | 6.1.6.2.9 | One item of a UE and associated NSAC action. | | +| PduACRequestInfo | 6.1.6.2.10 | One item of a PDU session and associated NSAC action. | | +| UeAdmissionValue | 6.1.6.2.11 | Local maximum number of UEs | HNSAC | +| PduAdmissionValue | 6.1.6.2.12 | Local maximum number of PDUs | HNSAC | +| ACUpdateData | 6.1.6.2.13 | Input data for NSAC procedure to update the local maximum number of registered UEs and the local maximum number of PDU sessions. | HNSAC | +| QuotaUpdateRequestData | 6.1.6.2.15 | Input data for NSAC procedure to fetch the maximum number of registered UEs and/or the maximum number of PDU sessions. | | +| QuotaUpdateResponseData | 6.1.6.2.6 | Input data for NSAC procedure to update the maximum number of registered UEs and/or the maximum number of PDU sessions. | | +| SliceQuotaType | 6.1.6.3.6 | Type of quota update for NSAC procedure. | | +| NsacAdmissionMode | 6.1.6.3.7 | NSAC admission mode | | + +Table 6.1.6.1-2 specifies data types re-used by the Nnsacf\_NSAC service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnsacf\_NSAC service based interface. + +**Table 6.1.6.1-2: Nnsacf\_NSAC re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-----------------------------------|----------------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Problem Details | | +| RedirectResponse | 3GPP TS 29.571 [16] | Redirect Response | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Supported Features | | +| Supi | 3GPP TS 29.571 [16] | Subscription Permanent Identifier | | +| Snssai | 3GPP TS 29.571 [16] | Single NSSAI | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF Instance ID | | +| Uri | 3GPP TS 29.571 [16] | Resource or callback URI | | +| AccessType | 3GPP TS 29.571 [16] | Access Type | | +| NFType | 3GPP TS 29.510 [17] | NF Type | | +| Fqdn | 3GPP TS 29.571 [16] | FQDN | | +| PduSessionId | 3GPP TS 29.571 [16] | PDU Session Identifier | | +| PlmnId | 3GPP TS 29.571 [16] | PLMN ID | | +| Uinteger | 3GPP TS 29.571 [16] | Unsigned Integer | | +| NsacSai | 3GPP TS 29.571 [16] | NSAC Service Area ID | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: UeACRequestData + +**Table 6.1.6.2.2-1: Definition of type UeACRequestData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueACRequestInfo | array(UeACRequestInfo) | M | 1..N | List of UEs and their associated NSAC action details | | +| nfId | NfInstanceId | M | 1 | Indicates the NF Instance ID. When present, it shall carry one of the following values:
- the AMF Instance ID, if the request is from an AMF;
- the SMF Instance ID, if the request is from a combined SMF+PGW-C in EPS interworking case. | | +| nfType | NFType | O | 0..1 | Indicates the NF type of the requester NF. When present, it shall carry one of the following values:
- NFType=AMF, if the request is from an AMF;
- NFType=SMF, if the request is from a combined SMF+PGW-C in EPS interworking case. | | +| eaNotificationUri | Uri | O | 0..1 | Indicates the EAC notification callback URI. If the EAC notification callback URI is present, the AMF Instance ID shall also be present. | | +| nsacServiceArea | NsacSai | C | 0..1 | This IE shall be present if the NF consumer has been configured with NSAC service area it belongs to.

When present, this IE shall indicate the identity of the NSAC Service Area of the NF consumer. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +NOTE: If the NF consumer is combined SMF+PGW-C, the combined SMF+PGW-C determines the Access Type based on the RAT type parameter in the PMIP or GTP message received from the ePDG; or alternatively it can internally determine the Access Type based on the source node (e.g. SGW) sending the request for the PDN Connection establishment. + +##### 6.1.6.2.3 Type: UeACResponseData + +Table 6.1.6.2.3-1: Definition of type UeACResponseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| acuFailureList | map(array(AcuFailureItem)) | C | 1..N(1..M) | Indicates a list of S-NSSAI which is failed in the NSAC procedure, and the reasons for each S-NSSAI. Key of the map is the SUPI of the UE. | | +| ueAdmissionList | array(UeAdmissionValue) | C | 1..N | Indicates a list of S-NSSAI to delegate the NSAC handling to the NSACF, and the updated local maximum number of UEs and/or the updated UE admission threshold for each S-NSSAI, as defined in clause 4.2.11.2a or clause 4.2.11.5.2.3 of 3GPP TS 23.502 [3]. | HNSAC
VHSAC | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +##### 6.1.6.2.4 Type: EACNotification + +Table 6.1.6.2.4-1: Definition of type EACNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------|---------------| +| eacModeList | map(EACMode) | O | 1..N | a map of EAC Mode where the S-NSSAI serves as the key. | | + +##### 6.1.6.2.5 Type: AcuOperationItem + +Table 6.1.6.2.5-1: Definition of type AcuOperationItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| updateFlag | AcuFlag | M | 1 | Indicates the operation (i.e. increase or decrease) to the impacted S-NSSAI. | | +| snssai | Snssai | M | 1 | Indicates the S-NSSAI for the increase or decrease operation. It shall contain S-NSSAI in serving PLMN or the mapped S-NSSAI in home PLMN. | | +| plmnId | PlmnId | C | 0..1 | Indicates the PLMN ID associated to the S-NSSAI for increase or decrease operation. It shall be present in the NSAC procedure for the HR or LBO roaming case, or if the NSACF serves multiple PLMNs. | | +| ueRegInd | boolean | C | 0..1 | This IE shall be present and set to true if the UE has been registered with the associated S-NSSAI in another NSAC service area before, in hierarchical NSAC architecture.

Presence of this IE with false value shall be prohibited. | HNSAC | +| servingPlmnId | PlmnId | C | 0..1 | It shall be present in the NSAC procedure for the HR or LBO roaming case, and if the mapped S-NSSAI in home PLMN is included in snssai attribute. When present, it shall contain the serving PLMN ID of the UE. | | +| nsacMode | NsacAdmissionMode | C | 0..1 | This IE shall be present for inbound roamer, indicating VPLMN NSAC admission mode or VPLMN with HPLMN assistance NSAC admission mode. | | + +##### 6.1.6.2.6 Type: AcuFailureItem + +Table 6.1.6.2.6-1: Definition of type AcuFailureItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the S-NSSAI which is failed in the NSAC procedure.
It shall contain S-NSSAI in serving PLMN or the mapped S-NSSAI in home PLMN. | | +| reason | AcuFailureReason | M | 1 | Indicates the reason of an S-NSSAI which is failed in the NSAC procedure. | | +| pduSessionId | PduSessionId | C | 0..1 | The PDU session Identifier, shall be present when response is for pduAC. | | +| plmnId | PlmnId | C | 0..1 | Indicates the PLMN ID associated to the S-NSSAI which is failed in the NSAC procedure.
It shall be present in the NSAC procedure for the HR or LBO roaming case, or if the NSACF serves multiple PLMN. | | + +##### 6.1.6.2.7 Type: PduACRequestData + +Table 6.1.6.2.7-1: Definition of type PduACRequestData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduACRequestInfo | array(PduACRequestInfo) | M | 1..N | List of UEs and their associated NSAC action details | | +| nflId | NfInstanceId | O | 0..1 | Indicates the SMF Instance ID. | | +| pgwFqdn | Fqdn | O | 0..1 | Indicates the PGW-C FQDN, if the request is from a combined SMF+PGW-C, in EPS interworking case. | | +| nsacServiceArea | NsacSai | C | 0..1 | This IE shall be present if the NF consumer has been configured with NSAC service area it belongs to.

When present, this IE shall indicate the identity of the NSAC Service Area of the NF consumer. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +##### 6.1.6.2.8 Type: PduACResponseData + +Table 6.1.6.2.8-1: Definition of type PduACResponseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| acuFailureList | map(array(AcuFailureItem)) | C | 1..N(1..2) | Indicates a list of S-NSSAIs which are failed in the NSAC procedure, and the reasons for each S-NSSAI. Key of the map is the SUPI of the UE. | | +| pduAdmissionList | array(PduAdmissionValue) | C | 1..N | Indicates a list of S-NSSAI to delegate the NSAC handling to the NSACF, and the updated local maximum number of PDU sessions for each S-NSSAI, as defined in clause 4.2.11.4a or clause 4.2.11.5.2.4 of 3GPP TS 23.502 [3]. | HNSAC
VHSAC | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | | + +##### 6.1.6.2.9 Type: UeACRequestInfo + +Table 6.1.6.2.9-1: Definition of type UeACRequestInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| Supi | Supi | M | 1 | Supi | | +| anType | AccessType | M | 1 | Indicates the access type over which the UE registers to the network or deregisters from the network. | | +| acuOperationList | array(AcuOperationItem) | M | 1..N | A list of S-NSSAI to which the UE is to be registered or from which the UE is to be de-registered. | | +| additionalAnType | AccessType | O | 0..1 | Indicates the additional access type, when the UE deregisters from the network, if the UE previously registered to the network over 3GPP access and Non-3GPP access | | + +##### 6.1.6.2.10 Type: PduACRequestInfo + +Table 6.1.6.2.7-1: Definition of type PduACRequestData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Supi | | +| anType | AccessType | M | 1 | Indicates the access type over which the PDU session is to be established or released. | | +| pduSessionId | PduSessionId | M | 1 | Indicates the PDU session Identifier.

During PDU session establishment or release in 5GC, this IE shall indicate the PDU session ID of the PDU session to be established or to be released;

During PDN connection establishment or release in EPC, this IE shall indicate the EPS pre-allocated PDU session ID for the corresponding PDU session in 5GC. | | +| acuOperationList | array(AcuOperationItem) | M | 1..2 | A list of S-NSSAI to which the PDU session is to be established or from which the PDU session is to be released. | | +| additionalAnType | AccessType | O | 0..1 | Indicates the additional access type, for a Multiple-Access PDU session, if the PDU session is to be established over both 3GPP access and Non-3GPP access, or if the PDU session is to be released from both 3GPP access and Non-3GPP access. | | + +##### 6.1.6.2.11 Type: UeAdmissionValue + +Table 6.1.6.2.11-1: Definition of type UeAdmissionValue + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the S-NSSAI to delegate the NSAC handling to the NSACF. It shall contain the S-NSSAI in serving PLMN or the mapped S-NSSAI in home PLMN. | | +| maxNumUes | UInteger | C | 0..1 | This IE shall be present to include the maximum number of registered UEs, if the primary NSACF or the NSACF in HPLMN determines to update the maximum number of UEs.

See clause 4.2.11.2a or clause 4.2.11.5.2.3 of 3GPP TS 23.502 [3]. | | +| ueAdmissionThreshold | integer | C | 0..1 | This IE shall be present if the maxNumUes attribute is present and the primary NSACF or the NSACF in HPLMN determines to update the UE admission threshold for NSACF which supports UE admission threshold-based control. When present it shall indicate the threshold expressed as a percentage of the local maximum number of UEs in NSACF.

See clause 4.2.11.2a or clause 4.2.11.5.2.3 of 3GPP TS 23.502 [3].

Minimum = 0. Maximum = 100. | | + +##### 6.1.6.2.12 Type: PduAdmissionValue + +Table 6.1.6.2.12-1: Definition of type PduAdmissionValue + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the S-NSSAI to delegate the NSAC handling to the NSACF. It shall contain S-NSSAI in serving PLMN or the mapped S-NSSAI in home PLMN. | | +| maxNumPdus | UInteger | M | 1 | This attribute shall be present to include the maximum number of (LBO) PDU sessions. | | + +##### 6.1.6.2.13 Type: ACUpdateData + +Table 6.1.6.2.13-1: Definition of type ACUpdateData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the Network slice for which the NSACF shall update the maximum number of registered UEs number and/or the maximum number of PDU sessions. It shall indicate S-NSSAI in serving PLMN or the mapped S-NSSAI in home PLMN. | | +| maxUesNumber | integer | O | 0..1 | Indicates the updated maximum number of registered UEs of the S-NSSAI, that the NSACF can use. | | +| maxPdusNumber | integer | O | 0..1 | Indicates the updated maximum number of PDU Sessions of the S-NSSAI, that the NSACF can use. | | + +##### 6.1.6.2.14 Type: QuotaUpdateRequestData + +Table 6.1.6.2.14-1: Definition of type QuotaUpdateRequestData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the Network slice for which the NSACF shall provide the maximum number of registered inbound roaming UEs and/or the maximum number of LBO PDU sessions.
It shall indicate the mapped S-NSSAI in home PLMN. | | +| plmnId | PlmnId | M | 1 | Indicates the serving PLMN ID of UE. | | +| quotaType | SliceQuotaType | M | 1 | Indicates the type of the requested quota (i.e., maximum number of registered inbound roaming UEs and/or maximum number of LBO PDU sessions). | | + +##### 6.1.6.2.15 Type: QuotaUpdateResponseData + +Table 6.1.6.2.15-1: Definition of type QuotaUpdateResponseData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Indicates the Network slice for which the NSACF shall update the maximum number of registered inbound roaming UEs number and/or the maximum number of LBO PDU sessions.
It shall indicate the mapped S-NSSAI in home PLMN. | | +| maxUesNumber | integer | O | 0..1 | Indicates the updated maximum number of registered inbound roaming UEs of the S-NSSAI. | | +| maxPdusNumber | integer | O | 0..1 | Indicates the updated maximum number of LBO PDU Sessions of the S-NSSAI | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.1.6.3.3 Enumeration: EACMode + +The enumeration EACMode represents the mode of Early Admission Control. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration EACMode** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| "ACTIVE" | EAC mode is enabled. | | +| "DEACTIVE" | EAC mode is disabled. | | + +##### 6.1.6.3.4 Enumeration: AcuFlag + +The enumeration AcuFlag indicates the operation (i.e. increase or decrease) applied to a list of S-NSSAI during the NSAC procedure. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration AcuFlag** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "INCREASE" | Indicates the impacted list of S-NSSAI is to be added to the NSACF for a UE (or a PDU session). | | +| "DECREASE" | Indicates the impacted list of S-NSSAI is to be removed from the NSACF for a UE (or a PDU session). | | +| "UPDATE" | Indicates for the impacted S-NSSAIs the access type of a PDU session is to be replaced; or
Indicates for the impacted S-NSSAIs the access type of a UE with at least one PDU session/PDN connection is to be replaced. | | + +##### 6.1.6.3.5 Enumeration: AcuFailureReason + +The enumeration AcuFailureReason indicates the operation result of the NSAC procedure for an individual S-NSSAI. It shall comply with the provisions defined in table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration AcuFailureReason** + +| Enumeration value | Description | Applicability | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "SLICE_NOT_FOUND" | Indicates that an S-NSSAI is not found by the NSACF from the list of S-NSSAIs which are subject to NSAC procedure. | | +| "EXCEED_MAX_UE_NUM" | Indicates for an S-NSSAI the number of UEs has exceeded the configured maximum number of UEs, if network slice admission control is not specific to one access type.
(NOTE 2) | | +| "EXCEED_MAX_UE_NUM_3GPP" | Indicates for an S-NSSAI the number of UEs has exceeded the configured maximum number of UEs, if network slice admission control is required for 3GPP access.
(NOTE 1, NOTE 2) | | +| "EXCEED_MAX_UE_NUM_N3GPP" | Indicates for an S-NSSAI the number of UEs has exceeded the configured maximum number of UEs, if network slice admission control is required for Non-3GPP access.
(NOTE 1, NOTE 2) | | +| "EXCEED_MAX_PDU_NUM" | Indicates for an S-NSSAI the number of PDU sessions has exceeded the configured maximum number of PDU sessions if network slice admission control is not specific to one access type. | | +| "EXCEED_MAX_PDU_NUM_3GPP" | Indicates for an S-NSSAI the number of PDU sessions has exceeded the configured maximum number of PDU sessions, if network slice admission control is required for 3GPP access.
(NOTE 1) | | +| "EXCEED_MAX_PDU_NUM_N3GPP" | Indicates for an S-NSSAI the number of PDU sessions has exceeded the configured maximum number of PDU sessions, if network slice admission control is required for Non-3GPP access.
(NOTE 1) | | + +NOTE 1: If this value is returned in the NSAC response message, how the NF service consumer (e.g. AMF) utilizes the access information carried in the AcuFailureReason value is implementation specific. +NOTE 2: For one S-NSSAI, if the network is configured to perform NSAC for the number of UEs with at least one PDU session/PDN connection, these values returned in the NSAC response message indicate the excess of the configured maximum number of UEs with at least one PDU session/PDN connection. + +##### 6.1.6.3.6 Enumeration: SliceQuotaType + +The enumeration SliceQuotaType indicates the type of the quota (i.e. maximum number of registered UEs and/or maximum number of PDU sessions) for an S-NSSAI for which the fetching of the available quota is performed during the NSAC procedure. It shall comply with the provisions defined in table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration SliceQuotaType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "MAX_UE_NUM" | Indicates that quota type for update relates to maximum number of registered inbound roaming UEs. | | +| "MAX_PDU_NUM" | Indicates that quota type for update relates to maximum number of LBO PDU sessions. | | +| "BOTH" | Indicates that quota type for update relates to both maximum number of registered inbound roaming UEs and maximum number of LBO PDU sessions. | | + +##### 6.1.6.3.7 Enumeration: NsacAdmissionMode + +The enumeration NsacAdmissionMode indicates the mode (i.e. VPLMN NSAC admission mode or VPLMN with HPLMN assistance NSAC admission mode) applied to an S-NSSAI during the NSAC procedure. It shall comply with the provisions defined in table 6.1.6.3.7-1. + +**Table 6.1.6.3.7-1: Enumeration NsacAdmissionMode** + +| Enumeration value | Description | Applicability | +|-------------------------------|-------------------------------------------------|---------------| +| "VPLMN_ADMISSION" | VPLMN NSAC admission mode | | +| "VPLMN_WITH_HPLMN_ASSISTANCE" | VPLMN with HPLMN assistance NSAC Admission mode | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +In this release, no alternative data types or combinations of data types are defined in this specification. + +#### 6.1.6.5 Binary data + +In this release, no binary data types are defined in this specification. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnsacf\_NSAC API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnsacf\_NSAC API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnsacf\_NSAC service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnsacf\_NSAC service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SLICE_NOT_FOUND | 403 Forbidden | All S-NSSAIs provided in the request are not found by the NSACF from the list of S-NSSAIs which are subjected to NSAC procedure. | +| ALL_SLICE_FAILED | 403 Forbidden | All S-NSSAIs are failed in the NSAC procedure, e.g. due to exceed the configured maximum number of UEs. | +| NSAC_SERVICE_AREA_NOT_SUPPORT | 403 Forbidden | The NSAC Service Area included in the request is not supported by the NSACF. | +| NSAC_SERVICE_AREA_REQUIRED | 403 Forbidden | the NSACF has been configured with multiple NSAC Service Areas to perform NSAC admission on a per NSAC Service Area, and there is no NSAC Service Area received in the request. | +| LOCAL_CONFIG_NOT_FOUND | 404 Not Found | All S-NSSAIs provided in the request are not found by the receiving NSACF during the network slice local configuration update procedure (i.e. to update the local maximum number of UEs and/or PDU session). | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnsacf\_NSAC API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [16]. + +The following features are defined for the Nnsacf\_NSAC service. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | HNSAC | O | Hierarchical Network Slice Admission Control

An NF Service Consumer and the NSACF support this feature shall support handling of Hierarchical NSACF procedures as specified in clause 4.2.11.2a and clause 4.2.11.4a of 3GPP TS 23.502 [3]. | +| 2 | VHNSAC | O | VPLMN with HPLMN assistance NSAC Admission mode

An NF Service Consumer and the NSACF support this feature shall support handling of VPLMN with HPLMN assistance NSAC Admission procedures as specified in clause 4.2.11.5.2.3 and clause 4.2.11.5.2.4 of 3GPP TS 23.502 [3]. | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnsacf\_NSAC API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnsacf\_NSAC API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnsacf\_NSAC service. + +The Nnsacf\_NSAC API defines the following scopes for OAuth2 authorization: + +**Table 6.1.9-X: OAuth2 scopes defined in Nnsacf\_NSAC API** + +| Scope | Description | +|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "nnsacf-nsac" | Access to the Nnsacf_NSAC API. | +| "nnsacf-nsac:slice-ues" | Access to service operations applying to the collection of slice subject to NSAC for UEs. | +| "nnsacf-nsac:slice-pdus" | Access to service operations applying to the collection of slice subject to NSAC for PDU sessions. | +| "nnsacf-nsac:local-configs-update" | Access (from a primary NSACF) to update the network slice local configuration (i.e., the maximum number of registered UEs and/or the maximum number of PDU sessions) of a network slice at a distributed NSACF, in hierarchical NSAC architecture. | +| "nnsacf-nsac:roaming-quotas-query" | Access (from a primary or central VPLMN NSACF) to request the primary or central HPLMN NSACF the maximum number of registered UEs and/or the maximum number of PDU sessions of a network slice for inbound roamers for VPLMN NSAC admission mode. | + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different NSACF service instance within the same NSACF, or to a different NSACF of an NSACF set, when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSACF producer instance will return the NF Instance ID of the new NSACF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSACF redirects a service request to a different NSACF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSACF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +## 6.2 Nnsacf\_SliceEventExposure Service API + +### 6.2.1 Introduction + +The Nnsacf\_SliceEventExposure shall use the Nnsacf\_SliceEventExposure API. + +The API URI of the Nnsacf\_SliceEventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nnsacf-slice-ee". +- The shall be "v1". +- The shall be set as described in clause 6.2.3. + +### 6.2.2 Usage of HTTP + +#### 6.2.2.1 General + +HTTP/2, IETF RFC 7540 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nnsacf\_SliceEventExposure API is contained in Annex A. + +#### 6.2.2.2 HTTP standard headers + +##### 6.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +The figure 6.2.3.1-1 describes the resource URI structure of the Nnsacf\_SliceEventExposure API. + +![Figure 6.2.3.1-1: Resource URI structure of the Nnsacf_SliceEventExposure API. The diagram shows a hierarchical tree structure starting with the root URI //{apiRoot}/nnsacf-slice-ee/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](91b12db3c85bbf466ad27eb3665a1b06_img.jpg) + +``` + +graph TD + Root[" //{apiRoot}/nnsacf-slice-ee/"] --> Subscriptions[" /subscriptions"] + Subscriptions --> SubscriptionId[" /{subscriptionId}"] + +``` + +Figure 6.2.3.1-1: Resource URI structure of the Nnsacf\_SliceEventExposure API. The diagram shows a hierarchical tree structure starting with the root URI //{apiRoot}/nnsacf-slice-ee/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URI structure of the Nnsacf\_SliceEventExposure API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------| +| Subscriptions Collection (Collection) | /subscriptions | POST | Mapped to the service operation Subscribe, when to create a subscription | +| Individual subscription | /subscriptions/{subscriptionId} | PATCH | Mapped to the service operation Subscribe, when to modify the subscription partially | +| | | PUT | Mapped to the service operation Subscribe, when to modify the subscription completely | +| | | DELETE | Mapped to the service operation Unsubscribe | + +#### 6.2.3.2 Resource: Subscriptions collection + +##### 6.2.3.2.1 Description + +This resource represents a collection of subscriptions created by NF service consumers of Nnsacf\_SliceEventExposure service. + +This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]). + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnsacf-slice-ee//subscriptions + +This resource shall support the resource URI variables defined in table 6.2.3.2.2-1. + +**Table 6.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | + +##### 6.2.3.2.3 Resource Standard Methods + +###### 6.2.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1. + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3. + +**Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------| +| SACEventSubscription | M | 1 | Represents the subscription to the events for slice admission control | + +**Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedSACEventSubscription | M | 1 | 201
Created | Represents successful creation of the events subscription for slice admission control | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403
Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_NOT_FOUND
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nnsacf-slice-ee//subscriptions/{subscriptionId} | + +**Table 6.2.3.2.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.2.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.2.3.2.4 Resource Custom Operations + +In this release of this specification, no custom operations associated to this resource is defined. + +#### 6.2.3.3 Resource: Individual subscription + +##### 6.2.3.3.1 Description + +This resource represents an individual of subscription created by NF service consumers of Nnsacf\_SliceEventExposure service. + +This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnsacf-slice-ee//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.3.3.2-1. + +**Table 6.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| apiVersion | string | See clause 6.2.1. | +| subscriptionId | string | String identifies an individual subscription to the NSACF event exposure service | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 PATCH + +This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1. + +**Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3. + +**Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| array(PatchItem) | M | 1..N | It contains the list of changes to be made to the subscription, according to the JSON PATCH format specified in IETF RFC 6902 [14]. | + +**Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedSACEventSubscription | M | 1 | 200 OK | Represents successful update of the events subscription for slice admission control | +| n/a | | | 204 No Content | Represents a successful update of the events subscription for slice admission control, and no information needs to be returned to the NF service consumer. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_NOT_FOUND
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.2.3.3.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1. + +**Table 6.2.3.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3. + +**Table 6.2.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------------------------| +| SACEventSubscription | M | 1 | Represents the events subscription for slice admission control to be completely replaced. | + +**Table 6.2.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CreatedSACEventSubscription | M | 1 | 200 OK | Represents successful update of the events subscription for slice admission control. | +| n/a | | | 204 No Content | Represents the events subscription modification provided by the NF Service Consumer is accepted entirely. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 403 Forbidden | Indicates the creation of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_NOT_FOUND
- MUTING_EXC_INSTR_NOT_ACCEPTED | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_FOUND | + +NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same NSACF or NSACF (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.2.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.3.3.3.3-1. + +**Table 6.2.3.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.2.3.3.3.3-2 and the response data structures and response codes specified in table 6.2.3.3.3.3-3. + +**Table 6.2.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | +| ProblemDetails | O | 0..1 | 404 Not Found | Indicates the modification of subscription has failed due to application error.

The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION NOT FOUND. | +| NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 6.2.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.2.3.3.4 Resource Custom Operations + +In this release of this specification, no custom operations associated to this resource is defined. + +### 6.2.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +This clause specifies the notifications provided by the Nnsacf\_SliceEventExposure service. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------|------------------|---------------------------------|---------------------------------| +| NSACF Event Notification | {eventNotifyUri} | POST | | + +#### 6.2.5.2 NSACF Event Notification + +If a NF service consumer has subscribed to an event(s) supported by Nnsacf\_SliceEventExposure service, when NSACF aware of a state change of the event, NSACF shall create a notification including the event state report, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5]. + +##### 6.2.5.2.1 Notification Definition + +Call-back URI: {callbackUri} + +Call-back URI is "eventNotifyUri" provided by NF Service Consumer during creation of the subscription. + +##### 6.2.5.2.2 Notification Standard Methods + +###### 6.2.5.2.2.1 POST + +This method shall support the request data structures specified in table 6.2.5.2.2.1-1 and the response data structures and response codes specified in table 6.2.5.2.2.1-2. + +**Table 6.2.5.2.2.1-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------------| +| SACEventReport | M | 1 | Represents the notification to be delivered | + +**Table 6.2.5.2.2.1-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. | + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.2.5.2.2.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.2.5.2.2.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of another NF service consumer to which the notification should be sent.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.2.6 Data Model + +#### 6.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.2.6.1-1 specifies the data types defined for the Nnsacf\_SliceEventExposure service based interface protocol. + +**Table 6.2.6.1-1: Nnsacf\_SliceEventExposure specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------------------------|----------------|--------------------------------------------------------------|---------------| +| SACEventSubscription | 6.2.6.2.2 | Request data to create the event subscription | | +| CreatedSACEventSubscription | 6.2.6.2.3 | Response data on created event subscription | | +| SACEventReport | 6.2.6.2.4 | Event notification | | +| SACEvent | 6.2.6.2.5 | Describes an event to be subscribed | | +| SACEventReportItem | 6.2.6.2.6 | Represents a report triggered by a subscribed event type | | +| SACEventState | 6.2.6.2.7 | Represents the state of a subscribed event | | +| SACEventType | 6.2.6.3.3 | Describes the supported event types | | +| SACEventTrigger | 6.2.6.3.4 | Describes how NSACF should generate the report for the event | | + +Table 6.2.6.1-2 specifies data types re-used by the Nnsacf\_SliceEventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnsacf\_SliceEventExposure service based interface. + +**Table 6.2.6.1-2: Nnsacf\_SliceEventExposure re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------------|---------------------|--------------------------------|---------------| +| PatchItem | 3GPP TS 29.571 [16] | | | +| Uri | 3GPP TS 29.571 [16] | Callback URI | | +| NfInstanceId | 3GPP TS 29.571 [16] | NF Instance Id | | +| DurationSec | 3GPP TS 29.571 [16] | Time value in seconds | | +| SACInfo | 3GPP TS 29.571 [16] | SAC Information | | +| DateTime | 3GPP TS 29.571 [16] | UTC time | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Supported Features | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| SACEventStatus | 3GPP TS 29.571 [16] | SAC Event Status | | +| VarRepPeriod | 3GPP TS 29.571 [16] | Variable Reporting Periodicity | | +| NotificationFlag | 3GPP TS 29.571 [16] | Notification flag | | +| MutingExceptionInstructions | 3GPP TS 29.571 [16] | Muting exception instructions | | +| MutingNotificationsSettings | 3GPP TS 29.571 [16] | Muting notifications settings | | + +#### 6.2.6.2 Structured data types + +##### 6.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.2.6.2.2 Type: SACEventSubscription + +Table 6.2.6.2.2-1: Definition of type SACEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | SACEvent | M | 1 | Describes the event to be subscribed in subscription request. | | +| eventNotifyUri | Uri | M | 1 | Identifies the recipient of notifications sent by NSACF for this subscription. | | +| nflId | NfInstanceId | M | 1 | Indicates the instance identity of the network function creating the subscription. | | +| notifyCorrelationId | string | C | 0..1 | This IE shall be present if available.

If present, this IE identifies the notification correlation ID. The NSACF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. | | +| maxReports | integer | C | 0..1 | This IE shall be present if available.

If present, this IE contains the maximum number of reports that can be generated by each subscribed event in the subscription. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the NSACF needs to include an expiry time.

This IE may be included in an event subscription request.

When present, this IE shall represent the time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid.

This IE shall be absent in the response for one time and immediate reporting (see clause 5.3.2.2.4). | | +| notifFlag | NotificationFlag | O | 0..1 | Indicates the notification flag by NWDAF or DCCF, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications. | EEMM | +| mutingExclInstructions | MutingExceptionInstructions | O | 0..1 | This IE may be included by NWDAF or DCCF in the event subscription request, if the notifFlag IE is present and set to "DEACTIVATE".
When present, it shall indicate the instructions for the subscription and stored events when an exception (e.g. the buffer of stored event reports is full, or the number of stored event reports exceeds a certain number) occurs at NSACF while the events are muted.
See 3GPP TS 23.288 [18], clause 6.2.7.2.
Write-Only: true | EEMM | +| mutingNotSettings | MutingNotificationsSettings | O | 0..1 | This IE may be included in the event subscription response if the event notifications muting is activated.
This IE Indicates the NSACF muting notification settings.
See 3GPP TS 23.288 [18], clause 6.2.7.2.
Read-Only: true | EEMM | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. | | + +##### 6.2.6.2.3 Type: CreatedSACEventSubscription + +Table 6.2.6.2.3-1: Definition of type CreatedSACEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| subscription | SACEventSubscription | M | 1 | Represents the newly created SAC Event Subscription resource. | | +| subscriptionId | string | M | 1 | Represents the subscription Id of the newly created SAC Event Subscription resource. | | +| report | SACEventReportItem | C | 0..1 | This IE shall be present if available and if the immediateFlag attribute is set to "true" in subscription request.
When present, this IE represents the immediate event report (i.e. the current value of the event subscribed). | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.3.8 is supported. | | + +##### 6.2.6.2.4 Type: SACEventReport + +Table 6.2.6.2.4-1: Definition of type SACEventReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| report | SACEventReportItem | M | 1 | This IE represents the event report to be delivered. | | +| notifyCorrelationId | string | C | 0..1 | This IE shall be present if available.

If present, this IE indicate the notification correlation Id provided by the NF service consumer during event subscription. This parameter can be useful if the NF service consumer uses a common call-back URI for multiple subscriptions. | | + +##### 6.2.6.2.5 Type: SACEvent + +Table 6.2.6.2.5-1: Definition of type SACEvent + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | SACEventType | M | 1 | Describes the event type to be reported. | | +| eventTrigger | SACEventTrigger | C | 0..1 | Describes how the reports are triggered.
(See NOTE 1) | | +| eventFilter | array(SNSSAI) | M | 1..N | This IE shall indicate the S-NSSAI list to be applied. | | +| notificationPeriod | DurationSec | C | 0..1 | This IE shall be present if the eventTrigger is set to "PERIODIC". When present, this IE contains the time period for the event reports.
(See NOTE 3) | | +| notifThreshold | SACInfo | C | 0..1 | This IE shall be present if the eventTrigger is set to "THRESHOLD". When present, this IE indicates the monitoring threshold value, upon which event notification(s) are triggered. | | +| immediateFlag | boolean | O | 0..1 | This attribute shall be set to "true" to indicate an immediate event report in the subscription response is requested. The report contains the current value of the event stored at the time of the subscription in the NSACF.
(See NOTE 2) | | +| varRepPeriodInfo | array(VarRepPeriod) | O | 1..N | This IE may be present if the trigger is set to "PERIODIC".
This IE indicates the variable reporting periodicity information.
See 3GPP TS 23.502 [4], clause 4.15.1.
(See NOTE 3) | ENAPH3 | + +NOTE 1: The eventTrigger shall not be present if the maxReports attribute in the SACEventSubscription is set to 1. Otherwise, the eventTrigger shall be present. + +NOTE 2: If the immediateFlag flag is absent or set to "false", then the immediate reporting shall not be done. + +NOTE 3: If both notificationPeriod and varRepPeriodInfo attributes are present, the notificationPeriod shall be applied if none of the conditions trigger the variable reporting is met. + +##### 6.2.6.2.6 Type: SACEventReportItem + +Table 6.2.6.2.6-1: Definition of type SACEventReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventType | SACEventType | M | 1 | Describes the type of the event which triggers the report | | +| eventState | SACEventState | M | 1 | Describes the state of the event which triggered the report. | | +| timeStamp | DateTime | M | 1 | This IE shall contain the time at which the event is generated. | | +| eventFilter | Snssai | M | 1 | This IE shall indicate the S-NSSAI to be applied. | | +| sliceStatusInfo | SACEventStatuses | C | 0..1 | If the "eventType" attribute is set to "NUM_OF_REGD_UES" or "NUM_OF_ESTD_PDU_SESSIONS", this parameter shall be included to indicate the current network slice status information for the concerned network slice.
(NOTE) | | + +NOTE: For periodic reporting, both of the values expressed in percentage and in numerical shall be included. + +##### 6.2.6.2.7 Type: SACEventState + +**Table 6.2.6.2.7-1: Definition of type SACEventState** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| active | boolean | M | 1 | Represents the active state of the subscribe event. "TRUE" value indicates the event will continue generating reports; "FALSE" value indicates the event will not generate further report. | | +| remainReports | integer | O | 0..1 | Represents the number of remain reports to be generated by the subscribed event. | | +| remainDuration | DurationSec | O | 0..1 | Represents how long the subscribed event will continue generating reports. | | + +#### 6.2.6.3 Simple data types and enumerations + +##### 6.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.2.6.3.2 Simple data types + +The simple data types defined in table 6.2.6.3.2-1 shall be supported. + +**Table 6.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +##### 6.2.6.3.3 Enumeration: SACEventType + +**Table 6.2.6.3.3-1: Enumeration SACEventType** + +| Enumeration value | Description | Applicability | +|----------------------------|--------------------------------------------------------------------------------------------------------------|---------------| +| "NUM_OF_REGD_UES" | A NF subscribes to this event to receive the current number of registered UEs for a network slice. | | +| "NUM_OF_ESTD_PDU_SESSIONS" | A NF subscribes to this event to receive the current number of established PDU Sessions for a network slice. | | + +##### 6.2.6.3.4 Enumeration: SACEventTrigger + +**Table 6.2.6.3.4-1: Enumeration SACEventTrigger** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "THRESHOLD" | Defines that the NSACF should generate reports for the event when the defined threshold value is reached, until the subscription to this event ends:
- due to end of report duration or
- up to the maximum number of reports or
- the event being unsubscribed explicitly. | | +| "PERIODIC" | Defines that the NSACF should periodically generate reports for the event, until the subscription to this event ends:
- due to end of report duration or
- up to the maximum number of reports or
- the event being unsubscribed explicitly. | | + +#### 6.2.6.4 Data types describing alternative data types or combinations of data types + +In this release, no alternative data types or combinations of data types are defined in this specification. + +#### 6.2.6.5 Binary data + +In this release, no binary data types are defined in this specification. + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nnsacf\_SliceEventExposure API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnsacf\_SliceEventExposure API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nnsacf\_SliceEventExposure service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nnsacf\_SliceEventExposure service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------------------|------------------|-------------------------------------------------------------------------------------------------------------| +| SLICE_NOT_FOUND | 403 Forbidden | The given S-NSSAI is not found by the NSACF in the list of S-NSSAIs which are subjected to NSACF procedure. | +| MUTING_EXC_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates the NSACF does not accept the received muting exception instructions. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.3.8-1 are defined for the Nnsacf\_SliceEventExposure API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | M/O | Description | +|----------------|--------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ENAPH3 | O | Enhanced Network Automation Phase 3 defined in 3GPP Rel-18.
An NSACF supporting this feature shall support the handling of variable reporting periodicity information as specified in clause 4.15.1 of 3GPP TS 23.502 [4]. | +| 2 | EEMM | O | Event Exposure Muting Mechanism
An NSACF supporting this feature shall support the handling of event muting mechanism as specified in clause 6.2.7.2 of 3GPP TS 23.288 [18]. | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). + +Feature: A short name that can be used to refer to the bit and to the feature. + +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). + +Description: A clear textual description of the feature. + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnsacf\_SliceEventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnsacf\_SliceEventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnsacf\_SliceEventExposure service. + +The Nnsacf\_SliceEventExposure API defines a single scope "nnsacf-slice-ee" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different NSACF service instance within the same NSACF, or to a different NSACF of an NSACF set, when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSACF producer instance will return the NF Instance ID of the new NSACF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an NSACF redirects a service request to a different NSACF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSACF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nnsacf\_NSAC API + +``` +openapi: 3.0.0 + +info: + title: Nnsacf_NSAC + version: 1.1.0-alpha.4 + description: | + Nnsacf_NSAC Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.536 V18.4.0; 5G System; Network Slice Admission Control Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.536/ + +servers: + - url: '{apiRoot}/nnsacf-nsac/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnsacf-nsac + +paths: + /slices/ues: + post: + summary: Network Slice Admission Control on the Number of UEs + operationId: NumOfUEsUpdate + tags: + - slice collection + security: + - {} + - oAuth2ClientCredentials: + - nnsacf-nsac + - oAuth2ClientCredentials: + - nnsacf-nsac + - nnsacf-nsac:slice-ues + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UEACRequestData' +``` + +``` + + required: true + responses: + '200': + description: Partial successful ACU operation + content: + application/json: + schema: + $ref: '#/components/schemas/UeACResponseData' + '204': + description: Successful ACU operation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Unsuccessful ACU operation - Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Unsuccessful ACU operation - Slice Not Subject to NSAC + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Unsuccessful ACU operation - Slice Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + callbacks: + eacNotification: + '{request.body#/eacNotificationUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EacNotification' + responses: + '204': + description: slice re-authentication notification response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/slices/pdus: + post: + summary: Network Slice Admission Control on the number of PDU Sessions + operationId: NumOfPDUsUpdate + tags: + - slice collection + security: + - {} + +``` + +``` + + - oAuth2ClientCredentials: + - nnsacf-nsac + - oAuth2ClientCredentials: + - nnsacf-nsac + - nnsacf-nsac:slice-pdus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PduACRequestData' + required: true + responses: + '200': + description: Partial successful ACU operation + content: + application/json: + schema: + $ref: '#/components/schemas/PduACResponseData' + '204': + description: Successful ACU operation + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Unsuccessful ACU operation - Bad Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Unsuccessful ACU operation - Slice Not Subject to NSAC + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Unsuccessful ACU operation - Slice Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + +/slices/local-configs/update: + post: + summary: > + Network Slice Admission Control update of the local maximum number of registered UEs and/or + PDU sessions of the network slice at NSACF. + operationId: LocalNumberUpdate + tags: + - slice collection + security: + - {} + - oAuth2ClientCredentials: + - nnsacf-nsac + - oAuth2ClientCredentials: + - nnsacf-nsac + - nnsacf-nsac:local-configs-update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ACUpdateData' + required: true + responses: + '204': + description: Successful ACU operation + '307': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + +/slices/roaming-quotas/query: + post: + summary: > + Network Slice Admission Control fetching of the maximum number of registered UEs and/or + number of PDU sessions of the network slice at NSACF. + operationId: QuotaUpdate + tags: + - slice collection + security: + - {} + - oAuth2ClientCredentials: + - nnsacf-nsac + - oAuth2ClientCredentials: + - nnsacf-nsac + - nnsacf-nsac:roaming-quotas-query + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaUpdateRequestData' + required: true + responses: + '200': + description: Successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaUpdateResponseData' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' +``` + +``` +scopes: + nnsacf-nsac: Access to the Nnsacf_NSAC API + nnsacf-nsac:slice-ues: > + Access to service operations applying to the collection of slice subject to NSAC for + UEs + nnsacf-nsac:slice-pdus: > + Access to service operations applying to the collection of slice subject to NSAC for + PDU sessions + nnsacf-nsac:local-configs-update: > + Access to the NSAC update of the local maximum number of registered UEs and/or + PDU sessions of the network slice at NSACF + +schemas: + +# +# STRUCTURED DATA TYPES: +# + +UeACRequestData: + type: object + properties: + ueACRequestInfo: + type: array + items: + $ref: '#/components/schemas/UeACRequestInfo' + minItems: 1 + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + eacNotificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nsacServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ueACRequestInfo + - nfId + +UeACRequestInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + acuOperationList: + type: array + items: + $ref: '#/components/schemas/AcuOperationItem' + minItems: 1 + additionalAnType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - supi + - anType + - acuOperationList + +UeACResponseData: + type: object + properties: + acuFailureList: + description: A map (list of key-value pairs) where the key of the map shall be UE's supi + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/AcuFailureItem' + minItems: 1 + minProperties: 1 + ueAdmissionList: + type: array + items: + $ref: '#/components/schemas/UeAdmissionValue' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +AcuOperationItem: + type: object + properties: + updateFlag: + $ref: '#/components/schemas/AcuFlag' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + ueRegInd: + type: boolean + enum: + - true + servingPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nsacMode: + $ref: '#/components/schemas/NsacAdmissionMode' + required: + - updateFlag + - snssai + +AcuFailureItem: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + reason: + $ref: '#/components/schemas/AcuFailureReason' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + required: + - snssai + +EacNotification: + description: A map (list of key-value pairs) where Snssai converted to a string serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/EACMode' + minProperties: 1 + +PduACRequestData: + type: object + properties: + pduACRequestInfo: + type: array + items: + $ref: '#/components/schemas/PduACRequestInfo' + minItems: 1 + nFId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + nsacServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - pduACRequestInfo + +PduACRequestInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + acuOperationList: + type: array + items: + $ref: '#/components/schemas/AcuOperationItem' + minItems: 1 + maxItems: 2 + additionalAnType: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - supi + - anType + - pduSessionId + - acuOperationList + +PduACResponseData: + type: object + properties: + acuFailureList: + description: A map (list of key-value pairs) where the key of the map shall be UE's supi + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/AcuFailureItem' + minItems: 1 + maxItems: 2 + minProperties: 1 + pduAdmissionList: + type: array + items: + $ref: '#/components/schemas/PduAdmissionValue' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +UeAdmissionValue: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + maxNumUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ueAdmissionThreshold: + type: integer + minimum: 0 + maximum: 100 + required: + - snssai + +PduAdmissionValue: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + maxNumPdus: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - snssai + - maxNumPdus + +ACUpdateData: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + maxUesNumber: + type: integer + maxPdusNumber: + type: integer + required: + - snssai + +QuotaUpdateRequestData: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + quotaType: + items: + $ref: '#/components/schemas/SliceQuotaType' + required: + - snssai + - plmnId +``` + +``` +- quotaType + +QuotaUpdateResponseData: + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + maxUesNumber: + type: integer + maxPdusNumber: + type: integer + required: + - snssai + +# +# SIMPLE DATA TYPES +# + +# +# ENUMERATIONS +# + +EACMode: + anyOf: + - type: string + enum: + - ACTIVE + - DEACTIVE + - type: string + description: > + 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. + description: > + EAC mode. Possible values are + - ACTIVE + - DEACTIVE + +AcuFlag: + anyOf: + - type: string + enum: + - INCREASE + - DECREASE + - UPDATE + - type: string + description: > + 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. + description: > + Update Flag of ACU operation. Possible values are + - INCREASE + - DECREASE + - UPDATE + +AcuFailureReason: + anyOf: + - type: string + enum: + - SLICE_NOT_FOUND + - EXCEED_MAX_UE_NUM + - EXCEED_MAX_UE_NUM_3GPP + - EXCEED_MAX_UE_NUM_N3GPP + - EXCEED_MAX_PDU_NUM + - EXCEED_MAX_PDU_NUM_3GPP + - EXCEED_MAX_PDU_NUM_N3GPP + - type: string + description: > + 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. + description: > + Failure Reason of ACU operation to an S-NSSAI. Possible values are + - SLICE_NOT_FOUND + - EXCEED_MAX_UE_NUM +``` + +``` + +- EXCEED_MAX_UE_NUM_3GPP +- EXCEED_MAX_UE_NUM_N3GPP +- EXCEED_MAX_PDU_NUM +- EXCEED_MAX_PDU_NUM_3GPP +- EXCEED_MAX_PDU_NUM_N3GPP + +SliceQuotaType: + anyOf: + - type: string + enum: + - MAX_UE_NUM + - MAX_PDU_NUM + - BOTH + - type: string + description: > + 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. + description: > + Slice quota type. Possible values are + - MAX_UE_NUM + - MAX_PDU_NUM + - BOTH + +NsacAdmissionMode: + description: > + Indicates the NSAC admission mode applied in roaming case. + anyOf: + - type: string + enum: + - VPLMN_ADMISSION + - VPLMN_WITH_HPLMN_ASSISTANCE + - type: string + description: > + 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. + - VPLMN_ADMISSION + - VPLMN_WITH_HPLMN_ASSISTANCE + +``` + +## A.3 Nnsacf\_SliceEventExposure API + +openapi: 3.0.0 + +``` + +info: + title: Nnsacf_SliceEventExposure + version: 1.1.0-alpha.4 + description: | + Nnsacf_SliceEventExposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.536 V18.4.0; 5G System; Network Slice Admission Control Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.536/ + +servers: + - url: '{apiRoot}/nnsacf-slice-ee/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnsacf-slice-ee + +paths: + /subscriptions: + post: + summary: Nnsacf_SliceEventExposure Subscribe service Operation + tags: + - Subscriptions collection (Collection) + operationId: CreateSubscription + +``` + +``` +requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SACEventSubscription' + required: true +responses: + '201': + description: Subscription Created + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nnsacf-slice-ee//subscriptions/{subscriptionId}' + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedSACEventSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error +callbacks: + eventReport: + '{ $request.body#/subscription/eventNotifyUri }': + post: + summary: Event Notification Delivery + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SACEventReport' + required: true + responses: + '204': + description: Successful acknowledgement + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +/subscriptions/{subscriptionId}: + patch: + summary: Nnsacf_SliceEventExposure Subscribe partial modify service Operation + tags: + - Individual subscription (Document) + operationId: PartialModifySubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedSACEventSubscription' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + put: + summary: Nnsacf_SliceEventExposure Subscribe complete modify service Operation + tags: + - Individual subscription (Document) + operationId: CompleteModifySubscription + parameters: + - name: subscriptionId + in: path + +``` + +``` + required: true + description: Unique ID of the subscription to be modified + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SACEEventSubscription' + required: true + responses: + '200': + description: Subscription modified successfully + content: + application/json: + schema: + $ref: '#/components/schemas/CreatedSACEEventSubscription' + '204': + description: Events subscription modification is accepted entirely + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: Nnsacf_SliceEventExposure Unsubscribe service Operation + tags: + - Individual subscription (Document) + operationId: DeleteSubscription + parameters: + - name: subscriptionId + in: path + required: true + description: Unique ID of the subscription to be deleted + schema: + type: string + responses: + '204': + description: Subscription deleted successfully + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +``` + +``` +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnsacf-slice-ee: Access to the Nnsacf_SliceEventExposure API + +schemas: + +# +# STRUCTURED DATA TYPES +# + +SACEventSubscription: + description: Request data to create the event subscription + type: object + required: + - event + - eventNotifyUri + - nfId + properties: + event: + $ref: '#/components/schemas/SACEvent' + eventNotifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + notifyCorrelationId: + type: string + maxReports: + type: integer + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + notifFlag: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NotificationFlag' + mutingExcInstructions: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingExceptionInstructions' + mutingNotSettings: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/MutingNotificationsSettings' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +CreatedSACEventSubscription: + description: Response data on created event subscription + type: object + required: + - subscription + - subscriptionId + properties: + subscription: + $ref: '#/components/schemas/SACEventSubscription' + subscriptionId: + type: string + report: + $ref: '#/components/schemas/SACEventReportItem' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +SACEventReport: + description: Event notification + type: object + required: + - report + properties: + report: + $ref: '#/components/schemas/SACEventReportItem' + notifyCorrelationId: + type: string + +SACEvent: + description: Describes an event to be subscribed + type: object + required: + - eventType + - eventFilter + properties: + eventType: + $ref: '#/components/schemas/SACEventType' + eventTrigger: + $ref: '#/components/schemas/SACEventTrigger' + eventFilter: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + notificationPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SACInfo' + immediateFlag: + type: boolean + default: false + varRepPeriodInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarRepPeriod' + minItems: 1 + +SACEventReportItem: + description: Represents a report triggered by a subscribed event type + type: object + required: + - eventType + - eventState + - timeStamp + - eventFilter + properties: + eventType: + $ref: '#/components/schemas/SACEventType' + eventState: + $ref: '#/components/schemas/SACEventState' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + eventFilter: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + sliceStatusInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SACEventStatus' + +SACEventState: + description: Represents the state of a subscribed event + type: object + required: + - active + properties: + active: + type: boolean + remainReports: + type: integer + remainDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +# +# SIMPLE DATA TYPES +# +``` + +``` +# +# ENUMERATIONS +# + +SACEEventType: + description: Describes the supported event types + anyOf: + - type: string + enum: + - NUM_OF_REGD_UES + - NUM_OF_ESTP_PDU_SESSIONS + - type: string + +SACEEventTrigger: + description: Describes how NSACF should generate the report for the event + anyOf: + - type: string + enum: + - THRESHOLD + - PERIODIC + - type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2021-04 | CT4#103E | C4-212108 | | | | TS skeleton | 0.0.1 | | +| 2021-04 | CT4#103E | C4-212430, etc. | | | | Implementation of pCRs agreed in CT4#103E (C4-212430, C4-212610, C4-212432, C4-212112) | 0.1.0 | | +| 2021-06 | CT4#104E | C4-213440, etc. | | | | Implementation of pCRs agreed in CT4#104E (C4-213440, C4-213441, C4-213442, C4-213443, C4-213444, C4-213445, C4-213446, C4-213435, C4-213436, C4-213437, C4-213438) | 0.2.0 | | +| 2021-09 | CT4#105E | C4-214694, etc. | | | | Implementation of pCRs agreed in CT4#105E (C4-214694, C4-214695, C4-214645, C4-214646, C4-214647, C4-214098, C4-214610, C4-214611, C4-214107, C4-214292, C4-214593, C4-214594, C4-214595, C4-214317, C4-214318, C4-214729, C4-214730, C4-214337) | 0.3.0 | | +| 2021-10 | CT4#106E | C4-215382, etc. | | | | Implementation of pCRs agreed in CT4#106E (C4-215382, C4-215116, C4-215470, C4-215383, C4-215385, C4-215386, C4-215388, C4-215389, C4-215390, C4-215391, C4-215392, C4-215393, C4-215394, C4-215395, C4-215525, C4-215415, C4-215416, C4-215264) | 0.4.0 | | +| 2021-11 | CT4#107E | C4-216052, etc. | | | | Implementation of pCRs agreed in CT4#107E (C4-216052, C4-216240, C4-216241, C4-216414, C4-216415, C4-216416, C4-216429, C4-216446, C4-216516) | 0.5.0 | | +| 2021-12 | CT#94e | CP-213155 | | | | V1.0.0 presented for information | 1.0.0 | | +| 2022-01 | CT4#107bis-E | C4-220378, etc. | | | | Implementation of pCRs agreed in CT4#107bis-E (C4-220379, C4-220357, C4-220459, C4-220070, C4-220389, C4-220345, C4-220346, C4-220348, C4-220372, C4-220411, C4-220413, C4-220284) | 1.1.0 | | +| 2022-03 | CT4#108-E | C4-221040, etc. | | | | Implementation of pCRs agreed in CT4#108-E (C4-221040, C4-221046, C4-221450, C4-221505, C4-221302) | 1.2.0 | | +| 2022-03 | CT#95e | CP-220104 | | | | TS presented for approval | 2.0.0 | | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | | +| 2022-06 | CT#96 | CP-221033 | 0003 | 1 | F | NSAC for emergency and priority sessions alignment | 17.1.0 | | +| 2022-06 | CT#96 | CP-221033 | 0005 | 1 | F | Session continuity guarantee with multiple NSACFs deployment | 17.1.0 | | +| 2022-06 | CT#96 | CP-221038 | 0008 | - | F | Consumers of NSACF event exposure service | 17.1.0 | | +| 2022-06 | CT#96 | CP-221028 | 0010 | 1 | F | Reuse of type Fqdn from 29.571 | 17.1.0 | | +| 2022-06 | CT#96 | CP-221033 | 0011 | 1 | F | Clarification on Per Access NSAC | 17.1.0 | | +| 2022-06 | CT#96 | CP-221033 | 0012 | 1 | F | Removal of NSACF from HPLMN in LBO Model | 17.1.0 | | +| 2022-06 | CT#96 | CP-221051 | 0013 | - | F | API version and External doc update | 17.1.0 | | +| 2022-09 | CT#97 | CP-222028 | 0014 | 1 | F | Clarification on per access failure reason | 17.2.0 | | +| 2022-12 | CT#98 | CP-223095 | 0016 | 2 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | | +| 2022-12 | CT#98 | CP-223033 | 0017 | - | F | 29.536 Rel-18 API version and External doc update | 18.0.0 | | +| 2023-03 | CT#99 | CP-230047 | 0018 | - | B | Different NSAC Admission Mode in Roaming Scenario | 18.1.0 | | +| 2023-03 | CT#99 | CP-230070 | 0019 | - | F | Add DCCF to the NF service consumers list | 18.1.0 | | +| 2023-06 | CT#100 | CP-231027 | 0021 | 4 | F | Location header and missing Redirection clause | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0023 | 1 | B | Interaction between two NSACFs | 18.2.0 | | +| 2023-06 | CT#100 | CP-231025 | 0027 | - | B | OAuth2 scopes in the Nnsacf_NSAC API | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0028 | 1 | B | Network Slice status notifications and reports to Primary NSACF | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0029 | 2 | B | NSAC Service Area Support during NSAC Admission Control | 18.2.0 | | +| 2023-06 | CT#100 | CP-231047 | 0034 | 1 | B | Variable reporting periodicity | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0035 | - | F | NSAC in roaming | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0040 | 2 | B | Update NumOfUEsUpdate service operation for hierarchical NSACF architecture | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0041 | 2 | B | Update NumOfPDUsUpdate service operation for hierarchical NSACF architecture | 18.2.0 | | +| 2023-06 | CT#100 | CP-231028 | 0042 | - | F | Removal of apiVersion from resource URI variables tables | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0043 | 2 | B | Add LocalNumberUpdate service operation | 18.2.0 | | +| 2023-06 | CT#100 | CP-231069 | 0044 | 1 | F | Remove undefined Note in the table and correct the figure number | 18.2.0 | | +| 2023-06 | CT#100 | CP-231048 | 0046 | 1 | B | Update OpenApis for the primary NSACF communication | 18.2.0 | | +| 2023-06 | CT#100 | CP-231096 | 0049 | - | A | Correction on the cardinality of acuFailureList | 18.2.0 | | +| 2023-06 | CT#100 | CP-231070 | 0047 | - | F | 29.536 Rel-18 API version and External doc update | 18.2.0 | | +| 2023-09 | CT#101 | CP-232037 | 0051 | 2 | B | Option 1: Enhance NumOfUEsUpdate to count the number of UEs | 18.3.0 | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------------|--------| +| | | | | | | with at least one PDU session/PDN connection | | +| 2023-09 | CT#101 | CP-232037 | 0052 | 2 | B | Option 2: Enhance NumOfPDUsUpdate to count the number of UEs with at least one PDU session/PDN connection | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0054 | 3 | B | NSAC Architecture Options and Role of NSACF | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0057 | 1 | F | Update LocalNumberUpdate service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0058 | 1 | F | Corrections to modification of slice event subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0059 | 1 | F | Miscellaneous Updates and Corrections | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0060 | - | F | Correct the reference for supportedFeatures | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0061 | - | F | Correct the resource in the figures of NumOfPDUsUpdate procedure | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0062 | - | F | Correct the reference for LocalNumberUpdate | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0063 | - | B | UE admission threshold | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0064 | 1 | B | VPLMN with HPLMN assistance NSAC admission | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0065 | 1 | B | EN removal for NSACF and Primary NSACF interaction in a hierarchical NSACF deployment | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0066 | 1 | B | NSACF NSAC Quota Update service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0067 | 2 | B | Resource and Data types of NSACF NSAC Quota Update service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232037 | 0070 | 1 | F | Removal of description for AF/NEF subscription to the number of UEs with at least one PDU session/PDN connection | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0071 | 2 | F | EAC Mode Subscription and Notification | 18.3.0 | +| 2023-09 | CT#101 | CP-232037 | 0072 | 1 | B | Service introduction update for counting of UEs with at least one PDU sessions | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0076 | 1 | B | NSAC admission mode | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0080 | - | F | Rel18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233045 | 0081 | 2 | B | Muting mechanism | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0082 | - | F | Correction on hierarchical NSACF architecture | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0083 | 1 | F | Correction on Update operation for controlling the number of UEs with at least one PDU session/PDN connection | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0084 | 2 | F | LocalNumberUpdate in VPLMN with HPLMN assistance NSAC admission mode | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0085 | 1 | F | QuotaUpdate service operation Update | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0086 | - | F | Update the procedures to support the NumOfUEsUpdate and NumOfPDUsUpdate service operations for roaming UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0087 | 1 | B | VPLMN with HPLMN assistance NSAC Admission mode for number of LBO PDU Sessions | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0088 | 1 | B | VPLMN with HPLMN assistance NSAC Admission mode for number of Registered UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0089 | - | F | Obsoleted HTTP/2 RFCs | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0092 | - | F | Remove EN on PDU Session ID in Clause 5.2.4.2.4 | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0093 | 1 | F | Updates to general description of NSAC service operations | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0094 | 2 | F | Update to Resource Structure of Slice Collection Configurations | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0095 | 1 | | Corrections to Slice Collection Roaming Quotas | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0097 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233039 | 0098 | 2 | B | Finding and delegating an NSAC request to the primary NSACF | 18.4.0 | +| 2023-12 | CT#102 | CP-233039 | 0099 | 4 | B | NSACF role clarification | 18.4.0 | +| 2023-12 | CT#102 | CP-233039 | 0100 | 2 | B | Handling UE number with at least one PDU Session in the Hierarchical NSAC architecture | 18.4.0 | +| 2023-12 | CT#102 | CP-233039 | 0101 | 1 | B | Controlling the number of UEs with at least one PDU session/PDN connection | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0102 | 2 | B | NSAC Service Area data type definition | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0103 | 1 | F | Clarification on UE already registered indication | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0104 | 1 | F | Clarification on threshold synchronization among multiple NSACFs | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0105 | 2 | F | Threshold based UE admission control | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0107 | 1 | F | Clarification on the LocalNumberUpdate procedure | 18.4.0 | +| 2023-12 | CT#102 | CP-233039 | 0108 | 1 | F | EAC mode is not applicable for NSAC for UEs with at least PDU session/PDN connection | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0109 | - | F | API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29540/raw.md b/gsma/29_series/29540/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..2bbaadc6c390f4867b341e239b693b76c52a9b8d --- /dev/null +++ b/gsma/29_series/29540/raw.md @@ -0,0 +1,2029 @@ + + +# 3GPP TS 29.540 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; SMS Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- ***Copyright Notification*** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 5 Services offered by the SMSF ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsmf_SMService Service..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Activate ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Registration procedure using Activate service operation..... | 9 | +| 5.2.2.2.3 Modify UE Context in SMSF using HTTP PATCH Method ..... | 10 | +| 5.2.2.3 Deactivate ..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 5.2.2.3.2 De-Registration procedure to remove SMS service authorization from SMSF ..... | 12 | +| 5.2.2.3.3 De-Registration procedure to remove SMS service authorization from SMSF for one of the registered Access Type..... | 12 | +| 5.2.2.4 UplinkSMS ..... | 13 | +| 5.2.2.4.1 General ..... | 13 | +| 5.2.2.4.2 Procedures of sending SMS payload in uplink direction using UplinkSMS service operation..... | 13 | +| 5.2.2.5 MtForwardSm..... | 14 | +| 5.2.2.5.1 General ..... | 14 | +| 5.2.2.5.2 Procedures of sending SMS payload in downlink direction using MtForwardSm service operation..... | 14 | +| 6 API Definitions ..... | 15 | +| 6.1 Nsmf_SMService Service API ..... | 15 | +| 6.1.1 API URI..... | 15 | +| 6.1.2 Usage of HTTP..... | 15 | +| 6.1.2.1 General..... | 15 | +| 6.1.2.2 HTTP standard headers..... | 15 | +| 6.1.2.2.1 General ..... | 15 | +| 6.1.2.2.2 Content type ..... | 15 | +| 6.1.2.2.3 ETag ..... | 16 | +| 6.1.2.2.4 If-Match..... | 16 | +| 6.1.2.3 HTTP custom headers..... | 16 | +| 6.1.2.3.1 General ..... | 16 | +| 6.1.2.4 HTTP multipart messages..... | 16 | +| 6.1.3 Resources..... | 16 | +| 6.1.3.1 Overview..... | 16 | +| 6.1.3.2 Resource: UEContexts (Store)..... | 18 | +| 6.1.3.2.1 Description ..... | 18 | +| 6.1.3.2.2 Resource Definition..... | 18 | +| 6.1.3.2.3 Resource Standard Methods..... | 19 | +| 6.1.3.3 Resource: UEContext (Document)..... | 19 | +| 6.1.3.3.1 Description ..... | 19 | +| 6.1.3.3.2 Resource Definition..... | 19 | +| 6.1.3.3.3 Resource Standard Methods..... | 19 | +| 6.1.3.3.4 Resource Custom Operations ..... | 24 | +| 6.1.3.3.4.1 Overview ..... | 24 | + +| | | | +|------------------------------------------------------------|-----------------------------------------------------------|-----------| +| 6.1.3.3.4.2 | Operation: sendsms ..... | 24 | +| 6.1.3.3.4.2.1 | Description..... | 24 | +| 6.1.3.3.4.2.2 | Operation Definition ..... | 24 | +| 6.1.3.3.4.3 | Operation: send-mt-sms..... | 25 | +| 6.1.3.3.4.3.1 | Description..... | 25 | +| 6.1.3.3.4.3.2 | Operation Definition ..... | 25 | +| 6.1.4 | Custom Operations without associated resources ..... | 26 | +| 6.1.5 | Notifications ..... | 26 | +| 6.1.6 | Data Model ..... | 27 | +| 6.1.6.1 | General..... | 27 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: UeSmsContextData..... | 28 | +| 6.1.6.2.3 | Type: SmsRecordData..... | 29 | +| 6.1.6.2.4 | Void..... | 29 | +| 6.1.6.2.5 | Type: SmsRecordDeliveryData..... | 29 | +| 6.1.6.3 | Simple data types and enumerations..... | 29 | +| 6.1.6.3.1 | Introduction ..... | 29 | +| 6.1.6.3.2 | Simple data types ..... | 29 | +| 6.1.6.3.3 | Enumeration: SmsDeliveryStatus ..... | 29 | +| 6.1.6.4 | Binary data ..... | 30 | +| 6.1.6.4.1 | Introduction ..... | 30 | +| 6.1.6.4.2 | SMS Payload Information..... | 30 | +| 6.1.7 | Error Handling ..... | 30 | +| 6.1.7.1 | General..... | 30 | +| 6.1.7.2 | Protocol Errors ..... | 30 | +| 6.1.7.3 | Application Errors..... | 30 | +| 6.1.8 | Feature negotiation ..... | 30 | +| 6.1.9 | Security..... | 31 | +| 6.1.10 | HTTP redirection..... | 31 | +| Annex A (normative): OpenAPI specification..... | | 32 | +| A.1 | General..... | 32 | +| A.2 | Nsmssf_SMSService API..... | 32 | +| Annex B (Informative): HTTP Multipart Messages..... | | 40 | +| B.1 | Example of HTTP multipart message..... | 40 | +| B.2 | Void..... | 40 | +| B.3 | Example HTTP multipart message with SMS binary data ..... | 40 | +| Annex C (informative): Change history..... | | 42 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nsmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SMSF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [7] IETF RFC 9113: "HTTP/2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] IETF RFC 2387: "The MIME Multipart/Related Content-type". +- [10] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [11] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [12] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [13] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [14] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +- [15] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". + - [16] 3GPP TR 21.900: "Technical Specification Group working methods". + - [17] IETF RFC 9457: "Problem Details for HTTP APIs". + - [18] Void. + - [19] OpenAPI: "OpenAPI Specification Version 3.0.0", . + - [20] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". + - [21] 3GPP TS 23.540: "5G System; Technical realization of Service Based Short Message Service Stage 2". + - [22] 3GPP TS 29.577: "5G System; IP Short Message Gateway and SMS Router For Short Message Services Stage 3". + - [23] IETF RFC 9110: "HTTP Semantics". +- + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|----------------------------| +| 5GC | 5G Core Network | +| AMF | Access Management Function | +| JSON | Javascript Object Notation | +| SMSF | SMS Function | + +# --- 4 Overview + +Within the 5GC, the SMSF offers services to the AMF, SMS-GMSC, IP-SM-GW and SMS Router via the Nsmf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.540 [21]). + +Figures 4.1 provides the reference model (in service based interface representation and in reference point representation), with focus on the SMSF and the scope of the present specification. + +![Figure 4-1: Reference model – SMSF. The diagram shows four network functions (AMF, SMS-GMSC, SMS Router, and IP-SM-GW) connected to a central SMSF via the Nsmmf interface. The AMF connects via the N20 interface. The SMS-GMSC connects via the SM5 interface. The SMS Router connects via the SM7 interface. The IP-SM-GW connects via the SM9 interface. All four interfaces (N20, SM5, SM7, SM9) converge at a single point on the Nsmmf interface before entering the SMSF.](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 4-1: Reference model – SMSF. The diagram shows four network functions (AMF, SMS-GMSC, SMS Router, and IP-SM-GW) connected to a central SMSF via the Nsmmf interface. The AMF connects via the N20 interface. The SMS-GMSC connects via the SM5 interface. The SMS Router connects via the SM7 interface. The IP-SM-GW connects via the SM9 interface. All four interfaces (N20, SM5, SM7, SM9) converge at a single point on the Nsmmf interface before entering the SMSF. + +**Figure 4-1: Reference model – SMSF** + +The functionalities supported by the SMSF are listed in clause 6.2.13 of 3GPP TS 23.501 [2]. + +The services and service operations provided by the Nsmmf interface are listed in clause 5.2.9 of 3GPP TS 23.502 [3] and clause 6.4 of 3GPP TS 23.540 [21]. + +# 5 Services offered by the SMSF + +## 5.1 Introduction + +The SMSF supports the following services. + +**Table 5.1-1: NF Services provided by SMSF** + +| Service Name | Description | Example Consumer | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| Nsmmf_SMService | This service allows AMF to authorize SMS and activate SMS for the served user on SMSF. This service also allows the SMS-GMSC, SMS Router and IP-SM-GW to send the SMS payload in downlink direction to the SMSF. | AMF, SMS-GMSC, SMS Router, IP-SM-GW | + +Table 5.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-----------------|--------|----------------|------------------------------|-----------|-------| +| Nsmmf_SMService | 6.1 | SMSF SMService | TS29540_Nsmmf_SMService.yaml | nsmsf-sms | A.2 | + +## 5.2 Nsmmf\_SMService Service + +### 5.2.1 Service Description + +The Nsmmf\_SMService service provides the service capability for the NF Service Consumer (e.g. AMF) to authorize SMS and activate SMS for a service user on SMSF, for the NF Service Consumer (e.g. SMS GMSC, SMS Router and IP-SM-GW) to send the SMS payload in downlink direction to the SMSF. The following are the key functionalities of this NF service: + +- Activation or deactivation of SMS service for a given service user, which results in creating/updating/deleting an UE Context for SMS in SMSF; +- Send SMS payload in uplink direction to SMSF; + +- Send SMS payload in downlink direction to SMSF. + +The Nsmf\_SMSService service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nsmf\_SMSService service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|----------------------------------------------------------------------------------------------------------------------|---------------------|--------------------------------| +| Activate | Activate SMS service for a given service user, which results in creating or updating a UE Context for SMS in SMSF. | Request/Response | AMF | +| Deactivate | Deactivate SMS service for a given service user, which results in deleting or updating a UE Context for SMS in SMSF. | Request/Response | AMF | +| UplinkSMS | Send SMS payload in uplink direction to SMSF. | Request/Response | AMF | +| MtForwardSm | Send SMS payload in downlink direction to SMSF. | Request/Response | SMS-GMSC, SMS Router, IP-SM-GW | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +This clause introduces the related procedures using Nsmf\_SMSService service operations for supporting SMS service. + +#### 5.2.2.2 Activate + +##### 5.2.2.2.1 General + +The Activate service operation shall be used by the NF Service Consumer (e.g. AMF) to activate SMS service for a given service user, which results in creating or updating an individual UE Context for SMS in the SMSF, in the following procedures: + +- Registration Procedure for SMS over NAS (see clause 4.13.3.1 of 3GPP TS 23.502 [3]); +- Registration Update Procedure for SMS over NAS due to AMF change (see clause 4.13.3.1 of 3GPP TS 23.502 [3]); +- Registration Update Procedure for SMS over NAS to add authorization for SMS over a new additional Access Type; +- AMF initiated modification to UE Context in SMSF, e.g. modify the backup AMF information. + +There shall be only one individual UE Context for SMS per service user. + +##### 5.2.2.2.2 Registration procedure using Activate service operation + +The NF Service Consumer (e.g. AMF) shall activate SMS service for a given service user by using the HTTP PUT method as shown in Figure 5.2.2.2-1. + +![Sequence diagram showing the activation of SMS service. The NF Service Consumer sends a PUT request to the SMSF. The SMSF responds with 2a. 201 Created, 2b. 2c. 204 No Content, 2d. 4xx/5xx (ProblemDetails), or 2e. 3xx (RedirectResponse).](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMSF + Note left of NF Service Consumer: 1. PUT .../ue-contexts/{supi} (UeSmsContextData) + NF Service Consumer->>SMSF: 1. PUT .../ue-contexts/{supi} (UeSmsContextData) + SMSF-->>NF Service Consumer: 2a. 201 Created + SMSF-->>NF Service Consumer: 2b. 2c. 204 No Content + SMSF-->>NF Service Consumer: 2d. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2e. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the activation of SMS service. The NF Service Consumer sends a PUT request to the SMSF. The SMSF responds with 2a. 201 Created, 2b. 2c. 204 No Content, 2d. 4xx/5xx (ProblemDetails), or 2e. 3xx (RedirectResponse). + +**Figure 5.2.2.2.2-1: Activation of SMS service** + +1. The NF Service Consumer (e.g. AMF) shall send a PUT request to the resource representing the UE Context for SMS (i.e. .../ue-contexts/{supi}) in the SMSF to activate SMS service for a given service user. The content of the PUT request shall contain a representation of the individual UE Context resource to be created or updated. + +Depending on whether the target UE Context for SMS has already been created, the SMSF performs 2a or 2b: + +- 2a. If the target UE Context for SMS is not created in SMSF, the SMSF registers itself in UDM for the Access Type(s) provided, retrieves subscription data from the UDM, performs service authorization for the given UE, and create UE Context for SMS for this UE. + +If successful, "201 Created" shall be returned, the content of the PUT response shall contain the representation of the created resource and the "Location" header shall contain the URI of the created resource. + +- 2b. If the target UE Context for SMS has already been created, the SMSF updates the UE Context for SMS with the NF Service Consumer (e.g. AMF) provided parameters. + +If successful, "204 No Content" shall be returned. + +- 2c. If the target UE Context for SMS has already been created and the NF Service Consumer (e.g. AMF) provided parameters contains 2 access types (i.e. an additional Access Type), the SMSF registers itself in UDM for the new Access Type for the given UE, performs service authorization for the given UE for the new Access Type and updates the UE context for SMS for this UE with the new additional Access Type. + +If successful, "204 No Content" shall be returned. + +- 2d. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of PUT response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. + +- 2e. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. + +A RedirectResponse IE may be included in the content of PUT response, as specified in table 6.1.3.3.3.1-3. + +##### 5.2.2.2.3 Modify UE Context in SMSF using HTTP PATCH Method + +The NF Service Consumer (e.g. AMF) may update UE context in SMSF for a given service user by using the HTTP PATCH method as shown in Figure 5.2.2.2.3-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an SMSF to modify UE context using HTTP PATCH. The consumer sends a PATCH request. The SMSF responds with either 204 No Content, 200 OK with PatchResult or UeSmsContextData, a 4xx/5xx error with ProblemDetails, or a 3xx RedirectResponse.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMSF + NF Service Consumer->>SMSF: 1. PATCH .../ue-contexts/{supi} (array(PatchItem)) + SMSF-->>NF Service Consumer: 2a. 204 No Content + SMSF-->>NF Service Consumer: 2b. 200 OK (PatchResult) or 200 OK (UeSmsContextData) + SMSF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2d. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an SMSF to modify UE context using HTTP PATCH. The consumer sends a PATCH request. The SMSF responds with either 204 No Content, 200 OK with PatchResult or UeSmsContextData, a 4xx/5xx error with ProblemDetails, or a 3xx RedirectResponse. + +**Figure 5.2.2.3-1: Modify UE Context in SMSF using HTTP PATCH Method** + +1. The NF Service Consumer (e.g. AMF) shall send a PATCH request to the resource representing the UE Context for SMS (i.e. .../ue-contexts/{supi}) in the SMSF to modify the UE Context in SMSF for a given service user. The request body shall contain a list of PatchItem for each the JSON pointer is set to the attribute to be modified. +- 2a. On success, the request is accepted, and all the modification instructions in the PATCH request have been implemented, the SMSF shall respond with "204 No Content". +- 2b. On partial success, the request is accepted, but some of the modification instructions in the PATCH request have been discarded: + - the SMSF shall respond with "200 OK" including PatchResult to indicate the failed modifications, if the NF service consumer has included in the supported-feature query parameter the "PatchReport" feature; or + - the SMSF shall respond with "200 OK" with the response body containing UeSmsContextData, if the NF service consumer does not support the "PatchReport" feature. +- 2c. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. A ProblemDetails IE shall be included in the content of PATCH response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. + + If the modification is not allowed, HTTP status code "403 Forbidden" should be returned including additional error information in the response body (in the "ProblemDetails" element). + + If the resource does not exist, e.g. the attribute to be modified cannot be found, HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element). +- 2d. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the content of PATCH response, as specified in table 6.1.3.3.3.1-3. + +#### 5.2.2.3 Deactivate + +##### 5.2.2.3.1 General + +The Deactivate service operation shall be used by the NF Service Consumer (e.g. AMF) to deactivate SMS service for a given service user, which results in deleting or updating an individual UE Context for SMS in the SMSF, in the following procedures: + +- De-Registration Procedure to remove SMS service authorization from SMSF for SMS over NAS (see clause 4.13.3.2 of 3GPP TS 23.502 [3]); +- De-Registration procedure to remove SMS service authorization from SMSF for one of the registered Access Type (see clause 4.13.3.2 of 3GPP TS 23.502 [3]); + +##### 5.2.2.3.2 De-Registration procedure to remove SMS service authorization from SMSF + +The NF Service Consumer (e.g. AMF) shall deactivate SMS service for a given service user by using the HTTP DELETE method as shown in Figure 5.2.2.3.2-1. + +![Sequence diagram for Figure 5.2.2.3.2-1: Deactivation of SMS service. The diagram shows an NF Service Consumer sending a DELETE request to an SMSF. The SMSF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](7f17c430b9598e4d748a8041457810b3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMSF + Note left of NF Service Consumer: 1. DELETE .../ue-contexts/{supi} + NF Service Consumer->>SMSF: 1. DELETE .../ue-contexts/{supi} + SMSF-->>NF Service Consumer: 2a. 204 No Content + SMSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Figure 5.2.2.3.2-1: Deactivation of SMS service. The diagram shows an NF Service Consumer sending a DELETE request to an SMSF. The SMSF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.2.2.3.2-1: Deactivation of SMS service** + +1. The NF Service Consumer (e.g. AMF) shall send a DELETE request to the resource representing the UE Context for SMS (i.e. .../ue-contexts/{supi}) in the SMSF. +- 2a. The SMSF deactivates the SMS service for the service user, and deletes the UE context for SMS from the SMSF. +On success, "204 No Content" shall be returned. +- 2b. On failure, the appropriate HTTP status code (e.g. "404 Not Found") indicating the error shall be returned. +A ProblemDetails IE shall be included in the content of DELETE response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. +A RedirectResponse IE may be included in the content of DELETE response, as specified in table 6.1.3.3.3.2-3. + +##### 5.2.2.3.3 De-Registration procedure to remove SMS service authorization from SMSF for one of the registered Access Type + +When the UE has SMS service activated on both of the Access Types and the NF Service Consumer (e.g. AMF) wants to deactivate SMS service for the given UE for one of the affected Access Type, the NF Service Consumer (e.g. AMF) shall use HTTP PUT method as shown in Figure 5.2.2.3.3-1. + +![Sequence diagram for Figure 5.2.2.3.3-1: Removal of SMS service authorization over one of the access types. The diagram shows an NF Service Consumer sending a PUT request to an SMSF. The SMSF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMSF + Note left of NF Service Consumer: 1. PUT .../ue-contexts/{supi} (UeSmsContextData) + NF Service Consumer->>SMSF: 1. PUT .../ue-contexts/{supi} (UeSmsContextData) + SMSF-->>NF Service Consumer: 2a. 204 No Content + SMSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Figure 5.2.2.3.3-1: Removal of SMS service authorization over one of the access types. The diagram shows an NF Service Consumer sending a PUT request to an SMSF. The SMSF responds with one of three possible messages: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.2.2.3.3-1: Removal of SMS service authorization over one of the access types** + +1. The NF Service Consumer (e.g. AMF) shall send a PUT request to the resource representing the UE Context for SMS (i.e. .../ue-contexts/{supi}) in the SMSF. The content of the PUT request shall contain a representation of the individual UE Context resource to be updated. Only one Access Type that is allowed for SMS service shall be included in the content of PUT request. + +- 2a. Since the target UE Context for SMS was already created at the SMSF with both 3GPP and non-3GPP Access Types for the same NF Service Consumer (e.g. AMF) and the NF Service Consumer provided parameters contains only one Access Type, the SMSF deregisters itself in the UDM for the affected Access Type (i.e. the access type not included in the PUT request) for the given UE and updates the UE context for SMS by removing the affected Access Type. + +On success, "204 No Content" shall be returned. + +- 2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of PUT response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. + +- 2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. + +A RedirectResponse IE may be included in the content of PUT response, as specified in table 6.1.3.3.3.1-3. + +#### 5.2.2.4 UplinkSMS + +##### 5.2.2.4.1 General + +The UplinkSMS service operation shall be used by NF Service Consumer (e.g. AMF) to send SMS payload (e.g. SMS message or Ack) in the uplink direction to SMSF, in the following procedures: + +- MO SMS delivery procedure (see clause 4.13.3.3-4.13.3.5 of 3GPP TS 23.502 [3]); +- MT SMS delivery procedure (see clause 4.13.3.6-4.13.3.8 of 3GPP TS 23.502 [3]); + +##### 5.2.2.4.2 Procedures of sending SMS payload in uplink direction using UplinkSMS service operation + +The NF Service Consumer (e.g. AMF) shall send SMS payload in uplink direction by using the "sendsms" custom operation as shown in Figure 5.2.2.4.2-1. + +![Sequence diagram showing the interaction between NF Service Consumer and SMSF for sending SMS payload in uplink direction. The NF Service Consumer sends a POST request to the SMSF. The SMSF responds with one of three options: 2a. 200 OK (SmsRecordDeliveryData), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](cce70c739081f63a6af83dc9483f98ce_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMSF + Note left of NF Service Consumer: 1. POST .../ue-contexts/{supi}/sendsms (SmsRecordData) + NF Service Consumer->>SMSF: 1. POST .../ue-contexts/{supi}/sendsms (SmsRecordData) + Note right of SMSF: 2a. 200 OK (SmsRecordDeliveryData) + SMSF-->>NF Service Consumer: 2a. 200 OK (SmsRecordDeliveryData) + Note right of SMSF: 2b. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + Note right of SMSF: 2c. 3xx (RedirectResponse) + SMSF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the interaction between NF Service Consumer and SMSF for sending SMS payload in uplink direction. The NF Service Consumer sends a POST request to the SMSF. The SMSF responds with one of three options: 2a. 200 OK (SmsRecordDeliveryData), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +Figure 5.2.2.4.2-1: Send SMS payload in uplink direction + +1. The NF Service Consumer (e.g. AMF) shall send a POST request to the resource representing the UEContext (i.e. .../ue-contexts/{supi}/sendsms) of the SMSF. The content of the POST request shall contain the SMS record to be sent. + +- 2a. On success, "200 OK" shall be returned with "SmsRecordDeliveryData" object in the response body. + +The SMSF may immediately respond to the NF service consumer, after successful inspection of the SMS payload, and set the "deliveryStatus" attribute to "SMS\_DELIVERY\_SMSF\_ACCEPTED"; the SMSF may also attempt to forward the SMS payload to SMS-GMSC/TWMSC/IP-SM-GW/SMS Router. + +If successful, "200 OK" shall be returned. If needed, the payload body of the POST response shall contain the status of SMS record delivery attempts at the SMSF. + +- 2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. + +2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. + +A RedirectResponse IE may be included in the content of POST response, as specified in table 6.1.3.3.4.2.2-2. + +#### 5.2.2.5 MtForwardSm + +##### 5.2.2.5.1 General + +The MtForwardSm service operation shall be used by NF Service Consumer (e.g. SMS GMSC, SMS Router and IP-SM-GW) to send SMS payload (e.g. SMS message) in the downlink direction to SMSF, in the following procedures: + +- Successful Mobile Terminated short message transfer as defined in 3GPP TS 23.540 [21] clause 5.1.2, clause 5.1.3 and clause 5.1.4. +- Unsuccessful Mobile Terminated short message transfer as defined in 3GPP TS 23.540 [21] clause 5.1.5, clause 5.1.6 and clause 5.1.9. + +##### 5.2.2.5.2 Procedures of sending SMS payload in downlink direction using MtForwardSm service operation + +The NF Service Consumer (e.g. SMS GMSC, SMS Router and IP-SM-GW) shall send SMS payload in downlink direction by using the "send-mt-sms" custom operation as shown in Figure 5.2.2.5.2-1. + +![Sequence diagram showing the interaction between an NF Service Consumer and an SMSF. The NF Service Consumer sends a POST request to the SMSF. The SMSF responds with one of three options: 2a. 200 OK (SmsDeliveryData), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](66c2bf11a8f117cddf67eff92d4c736c_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant SMSF + Note left of NF Service Consumer: 1. POST .../ue-contexts/{supi}/send-mt-sms (SmsData) + NF Service Consumer->>SMSF: 1. POST .../ue-contexts/{supi}/send-mt-sms (SmsData) + Note right of SMSF: 2a. 200 OK (SmsDeliveryData) + SMSF-->>NF Service Consumer: 2a. 200 OK (SmsDeliveryData) + Note right of SMSF: 2b. 4xx/5xx (ProblemDetails) + SMSF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) + Note right of SMSF: 2c. 3xx (RedirectResponse) + SMSF-->>NF Service Consumer: 2c. 3xx (RedirectResponse) +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an SMSF. The NF Service Consumer sends a POST request to the SMSF. The SMSF responds with one of three options: 2a. 200 OK (SmsDeliveryData), 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.2.2.5.2-1: Send SMS payload in downlink direction** + +11. The NF Service Consumer (e.g. SMS GMSC, SMS Router and IP-SM-GW) shall send a POST request to the resource representing the UEContext (i.e. .../ue-contexts/{supi}/send-mt-sms) of the SMSF. The content of the POST request shall contain the MT SMS record to be sent. + +2a. On success, "200 OK" shall be returned with "SmsDeliveryData" object contains the MT SMS Delivery Report in the response body. + +2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned. + +A ProblemDetails IE shall be included in the content of POST response, with the "cause" attribute of ProblemDetails set to application error codes specified in table 6.1.7.3-1. + +2c. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. + +A RedirectResponse IE may be included in the content of POST response, as specified in table 6.1.3.3.4.3.2-2. + +# 6 API Definitions + +## 6.1 Nsmmf\_SMSService Service API + +### 6.1.1 API URI + +The Nsmmf\_SMSService shall use the Nsmmf\_SMSService API. + +The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nsmmf-sms". +- The shall be "v2". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [7], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +HTTP messages and bodies for the Nsmmf\_SMSService service shall comply with the OpenAPI [19] specification contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers is specified in clause 5.2.2 of 3GPP TS 29.500 [4]. + +##### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- the JSON format (IETF RFC 8259 [8]). The use of the JSON format shall be signalled by the content type "application/json". See also clause 5.4 of 3GPP TS 29.500 [4]. +- the Problem Details JSON Object (IETF RFC 9457 [17]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". +- the JSON Patch (IETF RFC 6902 [20]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json". + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one binary body part with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.sms | Binary encoded payload, encoding SMS payload, as specified in 3GPP TS 23.040 [11] and 3GPP TS 24.011 [12]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. SMS payload) without having to rely on metadata in the JSON payload. | | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +##### 6.1.2.2.3 ETag + +As described in IETF RFC 9110 [23] clause 8.8.3, an "ETag" (entity-tag) header should be included in HTTP responses except for non-cacheable resources to allow an NF Service Consumer performing a conditional request with "If-Match" header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value (included in subsequent client requests) with a given resource representation stored in the server or in a cache. + +##### 6.1.2.2.4 If-Match + +As described in IETF RFC 9110 [23] clause 13.1.1, an NF Service Consumer may issue conditional DELETE request towards SMSF by including an "If-Match" header in HTTP requests containing an entity tags received in previous response for the same resource. + +#### 6.1.2.3 HTTP custom headers + +##### 6.1.2.3.1 General + +In this release of this specification, no custom headers specific to the Nsmmf\_SMSService service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4]. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque SMS payload (e.g. SMS message, CP Ack, etc.), in the following service operations (and HTTP messages): + +- UplinkSMS service operation; + +HTTP multipart messages shall include one JSON body part and one binary body part comprising content of SMS payload content (see clause 6.1.6.4). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +A binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall make a reference to the binary body part using the Content-ID header field. + +Examples of multipart/related messages can be found in Annex B. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The figure 6.1.3.1-1 describes the resource URI structure of the Nsmmf-sms API. + +![Resource URI structure of the nsmsf-sms API diagram](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` +graph TD; Root["//{apiRoot}/nsmsf-sms/{apiVersion}"] --- UE["/ue-contexts"]; UE --- Supi["/{supi}"]; Supi --- SendSms["/sendSMS"]; Supi --- SendMtSms["/send-mt-sms"]; style SendSms stroke-dasharray: 5 5; style SendMtSms stroke-dasharray: 5 5; +``` + +The diagram illustrates the hierarchical structure of the nsmsf-sms API. It begins with the root path `//{apiRoot}/nsmsf-sms/{apiVersion}`. A vertical line descends from the root to a box containing `/ue-contexts`. From this box, another vertical line descends to a box containing `/{supi}`. From the `/{supi}` box, two vertical lines branch out to two separate dashed boxes: `/sendSMS` and `/send-mt-sms`. + +Resource URI structure of the nsmsf-sms API diagram + +**Figure 6.1.3.1-1: Resource URI structure of the nsmsf-sms API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 6.1.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UEContext (Document) | /ue-contexts/{supi} | PUT | It is used for the Activate service operation, for the purpose of:
- Activate SMS service for a given UE, which results in creating an individual UE Context resource in SMSF.
- Update SMS service parameters for a given UE, which results in updating an existing individual UE Context resource in SMSF.
- Deactivate SMS service for a given UE for one of the two registered Access Types, which results in updating an existing individual UE context resource in SMSF. | +| | | PATCH | It is used for the Activate service operation, for the purpose of:
- Partially update SMS service parameters for a given UE, which results in updating an existing individual UE Context resource in SMSF. | +| | | DELETE | It is used for the Deactivate service operation, for the purpose of:
- Deactivate SMS service for a given UE, which results in deleting an existing individual UE Context resource in SMSF. | +| | /ue-contexts/{supi}/sendsms | sendsms (POST) | It is used for the UplinkSMS service operation, to allow NF Service Consumer to send SMS payload in uplink direction. | +| | /ue-contexts/{supi}/send-mt-sms | send-mt-sms (POST) | It is used for the MtForwardSm service operation, to allow NF Service Consumer to send SMS payload in downlink direction. | + +#### 6.1.3.2 Resource: UEContexts (Store) + +##### 6.1.3.2.1 Description + +This resource represents the collection of UE Context for SMS in SMSF. + +This resource is modelled with the Store resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +No HTTP method has been defined for this resource. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nsmmf-sms//ue-contexts + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +Table 6.1.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.1.1 | + +##### 6.1.3.2.3 Resource Standard Methods + +No HTTP method has been defined for the UE Context collection resource. + +#### 6.1.3.3 Resource: UEContext (Document) + +##### 6.1.3.3.1 Description + +This resource represents an individual UE Context for SMS in SMSF. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +A PUT method to this resource can be invoked by the NF Service Consumer (e.g. AMF) to: + +- activate SMS service for a given UE, which results in creating new individual UE Context for SMS in SMSF, during the Registration procedure for SMS over NAS (see 3GPP TS 23.502 [3] clause 4.13.3.1); +- update SMS service parameters for a given UE, which results in updating individual UE Context for SMS in SMSF, during the Registration Update procedure due to AMF change (see 3GPP TS 23.502 [3] clause 4.13.3.1). +- update SMS service parameters for a given UE, which results in updating individual UE Context for SMS in SMSF, to add a new Access Type for SMS over NAS. +- Deactivate SMS service for a given UE for one of the two registered Access Types, which results in updating an existing individual UE context resource in SMSF to remove the affected Access Type for SMS over NAS. + +A DELETE method to this resource can be invoked by the NF Service Consumer (e.g. AMF) to: + +- deactivate SMS service for a given UE, which results in deleting existing individual UE Context for SMS in SMSF, during the De-Registration procedure form SMS over NAS (see 3GPP TS 23.502 [3] clause 4.13.3.2). + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nsmmf-sms//ue-contexts/{supi} + +This resource shall support the resource URI variables defined in table 6.1.3.3.2-1. + +**Table 6.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2) pattern: See pattern of type Supi in 3GPP TS 29.571 [6] | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 PUT + +This method creates an individual resource of UE Context for SMS in the SMSF, or updates the indicated resource of UE Context for SMS in the SMSF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.1-1. + +**Table 6.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.1-2 and the response data structures and response codes specified in table 6.1.3.3.3.1-3. + +Table 6.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| UeSmsContextData | M | 1 | Representation of the UE Context for SMS to be created in the SMSF, or to be updated in the SMSF. | + +Table 6.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UeSmsContextData | M | 1 | 201 Created | This case represents the successful creation of an UE Context for SMS.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| n/a | | | 204 No Content | This case represents the successful update of an UE Context for SMS. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | When used to represent the failure of creation / update of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:
  • SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;
| +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent the failure of creation / update of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" shall be set to one of the following application error codes:
  • USER_NOT_FOUND, if the provided subscriber identifier is invalid or the service user is not found from UDM;
| + +NOTE 1: The mandatory HTTP error status codes for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.3.3.1-4: Headers supported by the 201 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-sms//ue-contexts/{supi} | +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [23], clause 8.8.3. | + +Table 6.1.3.3.3.1-5: Headers supported by the 204 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| ETag | string | O | 0..1 | Entity Tag, containing a strong validator, as described in IETF RFC 9110 [23], clause 8.8.3. | + +Table 6.1.3.3.3.1-6: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.1-7: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.2 DELETE + +This method deletes an individual resource of UE Context for SMS in the SMSF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.2-1. + +**Table 6.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.1.3.3.3.2-2 and the response data structures and response codes specified in table 6.1.3.3.3.2-3. + +**Table 6.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | This case represents a successful deletion of an UE Context for SMS. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 404 Not Found | When used to represent an unsuccessful deletion of an UE Context for SMS, the "cause" attribute of the "ProblemDetails" may be used to include one of the following application error codes:
  • - CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.
| + +NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.3.2-4: Headers supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------| +| If-Match | String | O | 0..1 | Validator for conditional requests, as described in IETF RFC 7232 [18], clause 3.1 | + +**Table 6.1.3.3.3.2-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | String | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.2-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 6.1.3.3.3.3-1. + +**Table 6.1.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-----------------------------------| +| supported-features | SupportedFeatures | O | 0..1 | see 3GPP TS 29.500 [4] clause 6.6 | + +This method shall support the request data structures specified in table 6.1.3.3.3.3-2 and the response data structures and response codes specified in table 6.1.3.3.3.3-3. + +**Table 6.1.3.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------------------------| +| array(PatchItem) | M | 1..N | Items describe the modifications to the Event Subscription | + +**Table 6.1.3.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Upon success, an empty response body shall be returned. | +| PatchResult | C | 1 | 200 OK | Upon partial success, if the NF service consumer has indicated "PatchReport" in the supported-feature, the execution report is returned.
(NOTE 3) | +| UeSmsContextData | C | 0..1 | 200 OK | Upon partial success, if the NF service consumer does not support the "PatchReport" feature, the SMSF shall return a UeSmsContextData object in the response.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | One or more attributes are not allowed to be modified.

The "cause" attribute may be used to indicate one of the following application errors:
- MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- USER_NOT_FOUND
- CONTEXT_NOT_FOUND | + +NOTE 1: In addition common data structures as listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] are supported. +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. +NOTE 3: One of UeSmsContextData or PatchResult shall be returned, depending on whether the NF service consumer support "PatchReport" feature or not. + +**Table 6.1.3.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +##### 6.1.3.3.4 Resource Custom Operations + +###### 6.1.3.3.4.1 Overview + +**Table 6.1.3.3.4.1-1: Custom operations** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------|---------------------------------|--------------------|-------------------------------------------------| +| sendsms | /ue-contexts/{supi}/sendsms | POST | Send SMS payload or CP Ack in uplink direction. | +| send-mt-sms | /ue-contexts/{supi}/send-mt-sms | POST | Send MT SMS payload, or the related CP Ack. | + +###### 6.1.3.3.4.2 Operation: sendsms + +###### 6.1.3.3.4.2.1 Description + +This custom operation is used for NF Service Consumers to send SMS record in uplink direction. + +###### 6.1.3.3.4.2.2 Operation Definition + +This custom operation is used to send a SMS payload to an individual UEContext resource in the SMSF. + +This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.2.2-2. + +**Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------| +| SmsRecordData | M | 1 | Representation of the SMS Record to be created in the SMSF. | + +**Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsRecordDeliveryData | M | 1 | 200 OK | This case represents the successful of sending SMS record in uplink direction, with necessary response data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;
  • - SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.
| +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;
| +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.
| + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +**Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +###### 6.1.3.3.4.3 Operation: send-mt-sms + +###### 6.1.3.3.4.3.1 Description + +This custom operation is used for NF Service Consumers to send SMS record in downlink direction. + +###### 6.1.3.3.4.3.2 Operation Definition + +This custom operation is used to send a SMS payload to an individual UEContext resource in the SMSF. + +This operation shall support the request data structures specified in table 6.1.3.3.4.3.2-1 and the response data structure and response codes specified in table 6.1.3.3.4.3.2-2. + +**Table 6.1.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------| +| SmsData | M | 1 | Representation of the MT SMS sent to the SMSF. | + +Table 6.1.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsDeliveryData | M | 1 | 200 OK | This case represents the successful of sending SMS message in downlink direction, with necessary response data on the received delivery report. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;
  • - SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.
| +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - SERVICE_NOT_ALLOWED, if SMS service is not allowed for the given service user;
| +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents an unsuccessful delivery of SMS payload. The "cause" attribute may be used to indicate one of the following application errors:
  • - CONTEXT_NOT_FOUND, if the UE context for SMS to be operated is invalid or not found in SMSF.
| + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +Table 6.1.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +Table 6.1.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMSF or SMSF (service) set. For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined. + +### 6.1.5 Notifications + +In this release of this specification, no notification procedures are defined. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nsmf service based interface protocol. + +**Table 6.1.6.1-1: Nsmf specific Data Types** + +| Data type | Clause defined | Description | +|-----------------------|----------------|-------------------------------------------------------------------------------------------------------------| +| UeSmsContextData | 6.1.6.2.2 | Information used for activating SMS service for a service user, or updating the parameters for SMS service. | +| SmsRecordData | 6.1.6.2.3 | Information within request message invoking UplinkSMS service operation, for delivering SMS payload. | +| SmsRecordDeliveryData | 6.1.6.2.5 | Information for result of invoking UplinkSMS service operation. | +| RecordId | 6.1.6.3.2 | Record ID used to identify a message carrying SMS payload. | +| SmsDeliveryStatus | 6.1.6.3.3 | Status of SMS delivery attempts. | + +Table 6.1.6.1-2 specifies data types re-used by the Nsmf service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nsmf service based interface. + +**Table 6.1.6.1-2: Nsmf re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|---------------------|--------------------------------------------------------------------------------------------------------------------| +| ProblemDetails | 3GPP TS 29.571 [6] | Common Data Type used in response bodies | +| RedirectResponse | 3GPP TS 29.571 [6] | Redirect Response | +| Supi | 3GPP TS 29.571 [6] | Subscription Permanent Identifier | +| Gpsi | 3GPP TS 29.571 [6] | General Public Subscription Identifier | +| Pei | 3GPP TS 29.571 [6] | Permanent Equipment, it contains an IMEI or IMEISV. | +| Guami | 3GPP TS 29.571 [6] | Globally Unique AMF Identifier | +| AccessType | 3GPP TS 29.571 [6] | Access Type (3GPP or non-3GPP access) | +| UserLocation | 3GPP TS 29.571 [6] | User location information | +| TimeZone | 3GPP TS 29.571 [6] | User time zone information | +| NfInstanceId | 3GPP TS 29.571 [6] | NF Instance ID | +| RefToBinaryData | 3GPP TS 29.571 [6] | Information for indicating the binary content of SMS payload. | +| TraceData | 3GPP TS 29.571 [6] | Trace control and configuration parameters | +| BackupAmfInfo | 3GPP TS 29.571 [6] | Backup AMF Information | +| NfGroupId | 3GPP TS 29.571 [6] | Network Function Group Id | +| RatType | 3GPP TS 29.571 [6] | RAT Type | +| SupportedFeatures | 3GPP TS 29.571 [6] | Supported Features | +| PatchItem | 3GPP TS 29.571 [6] | Patch item | +| PatchResult | 3GPP TS 29.571 [6] | PATCH result | +| SmsData | 3GPP TS 29.577 [22] | Information within request message for delivering SMS. | +| SmsDeliveryData | 3GPP TS 29.577 [22] | Information within response message invoking MtForwardSm service operation, for delivering MT SMS Delivery Report. | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: UeSmsContextData + +Table 6.1.6.2.2-1: Definition of type UeSmsContextData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | M | 1 | This IE shall be present, and it shall contain the subscriber permanent identity of the service user. | +| gpsi | Gpsi | O | 0..1 | When present, this IE shall contain the generic public subscriber identifier of the service user. | +| pei | Pei | O | 0..1 | When present, this IE shall contain the IMEI or IMEISV of the service user. | +| accessType | AccessType | M | 1 | This IE shall be present, and it shall contain the access type from which the service user accesses to network. | +| additionalAccessType | AccessType | C | 0..1 | This IE shall be present in activate service operations to indicate that the service user accesses the network and request SMS service from both 3GPP access and Non-3GPP access.
This IE shall be absent in deactivate service operations to indicate that service user is no longer served with SMS service via two access types. In this case the accessType attribute shall indicate the remaining access type. | +| amfId | NfInstanceId | M | 1 | This IE shall be present, and it shall contain the NF instance ID of the requesting AMF. | +| guamis | array(Guami) | O | 1..N | When present, this IE shall contain the GUAMI(s) of the AMF. | +| ueLocation | UserLocation | O | 0..1 | When present, this IE shall contain the UE location information (e.g. TAI and CGI). | +| ueTimeZone | TimeZone | O | 0..1 | When present, this IE shall contain the current time zone of the service user. | +| traceData | TraceData | O | 0..1 | Trace Data. The Null value indicates that trace is not active. | +| backupAmfInfo | array(BackupAmfInfo) | C | 1..N | This IE shall be included if the NF service consumer is an AMF and the AMF supports the AMF management without UDSF when the UE Context for SMS to be created in the SMSF, or to be updated in the SMSF.
The SMSF uses this attribute to do an NRF query in order to invoke later services in a backup AMF e.g. Namf_MT.
Absence of this attribute indicates the backup AMF Info is not provided or the previous provided backup AMF Info is removed. | +| udmGroupId | NfGroupId | O | 0..1 | Identity of the UDM group serving the supi | +| routingIndicator | string | O | 0..1 | When present, it shall indicate the Routing Indicator of the UE. | +| hNwPubKeyId | integer | O | 0..1 | When present, it shall indicate the Home Network Public Key Identifier of the UE. (see NOTE). | +| ratType | RatType | C | 0..1 | When present, it shall indicate the RAT type of the UE. | +| additionalRatType | RatType | C | 0..1 | When present, it shall indicate the RAT type of the UE corresponding to additionalAccessType. This IE shall not be included if additionalAccessType IE is not present. | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. | + +NOTE: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. + +##### 6.1.6.2.3 Type: SmsRecordData + +Table 6.1.6.2.3-1: Definition of type SmsRecordData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------| +| smsRecordId | RecordId | M | 1 | This IE shall be present, and it shall contain the record id uniquely identify a message carrying SMS payload. | +| smsPayload | RefToBinaryData | M | 1 | This IE shall be present, and it shall contain the reference to the SMS Payload Information binary data (see clause 6.1.6.4) | +| gpsi | Gpsi | O | 0..1 | When present, this IE shall contain the global permanent subscriber identifier of the service user. | +| pei | Pei | O | 0..1 | When present, this IE shall contain the IMEI or IMEISV of the service user. | +| accessType | AccessType | O | 0..1 | When present, this IE shall contain the access type from which the service user accesses to network. | +| ueLocation | UserLocation | O | 0..1 | When present, this IE shall contain the UE location information (e.g. TAI and CGI). | +| ueTimeZone | TimeZone | O | 0..1 | When present, this IE shall contain the time zone of the service user. | + +##### 6.1.6.2.4 Void + +##### 6.1.6.2.5 Type: SmsRecordDeliveryData + +Table 6.1.6.2.5-1: Definition of type SmsRecordDeliveryData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| smsRecordId | RecordId | M | 1 | This IE shall be present, and it shall contain the record id uniquely identify a message carrying SMS payload. | +| deliveryStatus | SmsDeliveryStatus | M | 1 | This IE shall be present, and it shall indicate the status of SMS payload delivery attempt in the SMSF, after SMSF receiving SMS payload on Nsmmf interface. | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +Table 6.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | +|-----------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RecordId | string | String uniquely identifying a record in the SMSF. The format of RecordId is implementation specific, e.g. using UUID format. In an OpenAPI Specification [19] schema, the format shall be designated as "RecordId". | + +##### 6.1.6.3.3 Enumeration: SmsDeliveryStatus + +The enumeration SmsDeliveryStatus represents the status of SMS payload delivery attempt at the SMSF. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration SmsDeliveryStatus** + +| Enumeration value | Description | +|----------------------------|--------------------------------------------------------------------| +| SMS_DELIVERY_PENDING | The SMS payload delivery at SMSF is pended. | +| SMS_DELIVERY_COMPLETED | The SMS payload delivery at SMSF is completed. | +| SMS_DELIVERY_FAILED | The SMS payload delivery at SMSF is failed due to certain reasons. | +| SMS_DELIVERY_SMSF_ACCEPTED | The SMS payload is accepted by the SMSF for further delivery. | + +#### 6.1.6.4 Binary data + +##### 6.1.6.4.1 Introduction + +This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4), to support delivery of binary content of SMS payload. + +**Table 6.1.6.4.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|-------------------------|----------------|--------------| +| SMS Payload Information | 6.1.6.4.2 | vnd.3gpp.sms | + +##### 6.1.6.4.2 SMS Payload Information + +SMS Payload Information shall encode a SMS payload as specified in 3GPP TS 23.040 [11] and 3GPP TS 24.011 [12], using the vnd.3gpp.sms content-type. + +SMS Payload Information may encode e.g. the following content: + +- CP-DATA, CP-ACK, CP-ERROR as specified in 3GPP TS 23.040 [11] and 3GPP TS 24.011 [12]; + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Nsmf\_SMService service, and the following application errors listed in Table 6.1.7.3-1 are specific for the Nsmf\_SMService service. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------|------------------|------------------------------------------------------------------------------| +| USER_NOT_FOUND | 404 Not Found | The provided subscriber identifier is invalid or the service user not found. | +| CONTEXT_NOT_FOUND | 404 Not Found | The UE context for SMS to be operated is invalid or not found in SMSF. | +| SERVICE_NOT_ALLOWED | 403 Forbidden | The requested service is not allowed for this service user. | +| SMS_PAYLOAD_MISSING | 400 Bad Request | The expected SMS payload content is missing. | +| SMS_PAYLOAD_ERROR | 400 Bad Request | Errors exist in the format of SMS payload. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsmf\_SMService API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Features of supportedFeatures attribute used by Nsmmf\_SMService service** + +| Feature Number | Feature | M/O | Description | +|----------------|-------------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ES3XX | M | Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Nsmmf_SMService service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | PatchReport | O | If some of the modifications included in the PATCH request are not successfully implemented, the SMSF reports the result of PATCH request execution to the consumer. See clause 5.2.7.2 of 3GPP TS 29.500 [4]. | + +Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). +Feature: A short name that can be used to refer to the bit and to the feature. +M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). +Description: A clear textual description of the feature. + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [4], the access to the Nsmmf\_SMService API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [14]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [15]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nsmmf\_SMService API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [15], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nsmmf\_SMService service. + +The Nsmmf\_SMService API defines a single scope "nsmmf-sms" for OAuth2 authorization (as specified in 3GPP TS 33.501 [13]) for the entire API, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SMSF service instance, within the same SMSF or a different SMSF of an SMSF set, e.g. when an SMSF service instance is part of an SMSF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.1.8. + +An SCP that reselects a different SMSF producer instance will return the NF Instance ID of the new SMSF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SMSF within an SMSF set redirects a service request to a different SMSF of the set using a 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMSF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nsmmf\_SMSService service. It consists of OpenAPI 3.0.0 specifications, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [16] clause 5B). + +## A.2 Nsmmf\_SMSService API + +``` +openapi: 3.0.0 + +info: + version: '2.3.0-alpha.2' + title: 'Nsmmf_SMSService Service API' + description: | + SMF SMSService. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.540 V18.1.0; 5G System; SMS Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.540/' + +security: + - oAuth2ClientCredentials: + - nsmmf-sms + - {} + +servers: + - url: '{apiRoot}/nsmmf-sms/v2' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /ue-contexts/{supi}: + put: + summary: Activate SMS Service for a given UE + operationId: SMSServiceActivation + tags: + - Activation of SMS service + parameters: + - name: supi + in: path + required: true + description: Subscriber Permanent Identifier (SUPI) + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UeSmsContextData' + required: true + responses: +``` + +``` +'201': + description: UE Context for SMS is created in SMSF + content: + application/json: + schema: + $ref: '#/components/schemas/UeSmsContextData' + headers: + Location: + description: 'Contains the URI of the newly created resource, according to the +structure: {apiRoot}/nsmsf-sms//ue-contexts/{supi}' + required: true + schema: + type: string + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110 + schema: + type: string +'204': + description: UE Context for SMS is updated in SMSF + headers: + ETag: + description: Entity Tag, containing a strong validator, as described in IETF RFC 9110 + schema: + type: string +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Invalid Service Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Unable to create/update UE Context for SMS in SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: Unable to found subscription for service user or UE Context for SMS in SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +default: + description: Unexpected error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +patch: + summary: Update a parameter in the UE SMS Context in SMSF + operationId: SMSServiceParameterUpdate + tags: + - Parameter update in the UE SMS Context in SMSF + parameters: +``` + +``` +- name: supi + in: path + required: true + description: Subscriber Permanent Identifier (SUPI) + schema: + type: string +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + minItems: 1 + required: true +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + oneOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + - $ref: '#/components/schemas/UeSmsContextData' + '204': + description: Successful response + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '422': + description: Unprocessable Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + description: Unexpected error + +delete: + summary: Deactivate SMS Service for a given UE + operationId: SMSServiceDeactivation + tags: + - Deactivation of SMS service + parameters: + - name: supi + in: path + required: true + description: Subscriber Permanent Identifier (SUPI) + schema: + type: string + - name: If-Match +``` + +``` + +in: header +description: Validator for conditional requests, as described in IETF RFC 9110 +schema: + type: string +responses: + '204': + description: UE Context for SMS is deleted from SMSF + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Invalid Service Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: Unable to found UE Context for SMS in SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +/ue-contexts/{supi}/sendsms: + post: + summary: Send SMS payload for a given UE + operationId: SendSMS + tags: + - Send SMS payload in uplink direction + parameters: + - name: supi + in: path + required: true + description: Subscriber Permanent Identifier (SUPI) + schema: + type: string + requestBody: + content: + multipart/related: + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/SmsRecordData' + binaryPayload: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryPayload: + contentType: application/vnd.3gpp.sms + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: SMS payload is received by SMSF, and is being delivered out + content: + +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/SmsRecordDeliveryData' +'307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' +'400': + description: Invalid Service Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + description: Unable to deliver SMS at SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: Unable to found UE Context for SMS in SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +/ue-contexts/{supi}/send-mt-sms: + post: + summary: Send MT SMS payload for a given UE + operationId: SendMtSMS + tags: + - Send SMS payload in downlink direction + parameters: + - name: supi + in: path + required: true + description: Subscriber Permanent Identifier (SUPI) + schema: + type: string + requestBody: + content: + multipart/related: + schema: + type: object + properties: + jsonData: + $ref: 'TS29577_Nipsmgw_SMService.yaml#/components/schemas/SmsData' + binaryPayload: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryPayload: + contentType: application/vnd.3gpp.sms + headers: + Content-Id: + schema: + +``` + +``` + type: string + required: true + responses: + '200': + description: sending delivery report + content: + multipart/related: + schema: + type: object + properties: + jsonData: + $ref: 'TS29577_Nipsmgw_SMSService.yaml#/components/schemas/SmsDeliveryData' + binaryPayload: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryPayload: + contentType: application/vnd.3gpp.sms + headers: + Content-Id: + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Invalid Service Request + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Unable to deliver SMS at SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '404': + description: Unable to found UE Context for SMS in SMSF + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmsf-sms: Access to the nsmsf-sms API +``` + +schemas: + +UeSmsContextData: + +description: Represents the information used for activating the SMS service for a service user, or updating the parameters of the SMS service. + +type: object + +required: + +- supi +- amfId +- accessType + +properties: + +supi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' + +pei: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Pei' + +amfId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' + +guamis: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Guami' +minItems: 1 + +accessType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/AccessType' + +additionalAccessType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/AccessType' + +gpsi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' + +ueLocation: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/UserLocation' + +ueTimeZone: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/TimeZone' + +traceData: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/TraceData' + +backupAmfInfo: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/BackupAmfInfo' +minItems: 1 + +udmGroupId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfGroupId' + +routingIndicator: +type: string + +hNwPubKeyId: +type: integer + +ratType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/RatType' + +additionalRatType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/RatType' + +supportedFeatures: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + +SmsRecordData: + +description: Represents the information sent within a request message of the UplinkSMS service operation, for delivering SMS payload. + +type: object + +required: + +- smsRecordId +- smsPayload + +properties: + +smsRecordId: +\$ref: '#/components/schemas/RecordId' + +smsPayload: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/RefToBinaryData' + +accessType: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/AccessType' + +gpsi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' + +pei: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Pei' + +ueLocation: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/UserLocation' + +ueTimeZone: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/TimeZone' + +RecordId: + +description: Represents a record ID, used to identify a message carrying SMS payload. + +``` +type: string + +SmsRecordDeliveryData: + description: Represents information on the result of invoking the UplinkSMS service operation. + type: object + required: + - smsRecordId + - deliveryStatus + properties: + smsRecordId: + $ref: '#/components/schemas/RecordId' + deliveryStatus: + $ref: '#/components/schemas/SmsDeliveryStatus' + +SmsDeliveryStatus: + description: Represents the Status of an SMS delivery attempt. + type: string + enum: + - SMS_DELIVERY_PENDING + - SMS_DELIVERY_COMPLETED + - SMS_DELIVERY_FAILED + - SMS_DELIVERY_SMSF_ACCEPTED +``` + +# --- Annex B (Informative): HTTP Multipart Messages + +## B.1 Example of HTTP multipart message + +This Annex provides a (partial) example of HTTP multipart message. The example does not aim to be a complete representation of the HTTP message, e.g. additional information or headers can be included. + +This Annex is informative and the normative descriptions in this specification prevail over the description in this Annex if there is any difference. + +## --- B.2 Void + +## --- B.3 Example HTTP multipart message with SMS binary data + +Example HTTP multipart message with SMS binary data: + +``` +POST /example.com/nsmsf-sms/v1/ue-contexts/{supi}/sendSMS HTTP/2 +Content-Type: multipart/related; boundary=----Boundary +Content-Length: xyz + +-----Boundary +Content-Type: application/json + +{ + "smsRecordId": "777c3edf-129f-486e-a3f8-c48e7b515605", + "smsPayload": { + "contentId": "sms" + }, + "gpsi": "msisdn-8613915900000", + "pei": "imei-123456789012345", + "accessType": "3GPP_ACCESS", + "ueLocation": { + "nrLocation": { + "tai": { + "plmnId": { + "mcc": "46", + "mnc": "000" + }, + "tac": "A01001", + }, + "ncgi": { + "plmnId": { + "mcc": "46", + "mnc": "000" + }, + "nrCellId": "225BD6007" + } + } + }, + "ueTimeZone": "+08:00" +} +-----Boundary +Content-Type: application/vnd.3gpp.sms +Content-Id: sms + +{ ... SMS Message binary data ...} +-----Boundary +``` + +The JSON part of the HTTP POST message includes an attribute named "smsPayload" which refers to RefToBinaryData structure. The "contentId" of RefToBinaryData is encoded as a string and used to reference the value of the Content-ID header field of the binary body part. + +# Annex C (informative): Change history + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2017-10 | CT4#80 | C4-175084 | | | | Initial Draft. | 0.1.0 | | +| 2017-10 | CT4#80 | C4-175399 | | | | Implementation of C4-175281, C4-175282, C4-175284. | 0.2.0 | | +| 2017-12 | CT4#81 | C4-176441 | | | | Implementation of C4-176092, C4-176097, C4-176346, C4-176347, C4-176349, C4-176351, C4-176353. | 0.3.0 | | +| 2018-03 | CT4#83 | C4-182439 | | | | Implementation of C4-182300, C4-182301, C4-182303, C4-182416 | 0.4.0 | | +| 2018-04 | CT4#84 | C4-183520 | | | | Implementation of C4-183375, C4-183376, C4-183377, C4-183378, C4-183379. | 0.5.0 | | +| 2018-05 | CT4#85 | C4-184633 | | | | Implementation of C4-184467, C4-184605, C4-184470, C4-184473, C4-184474, C4-184634. | 0.6.0 | | +| 2018-06 | CT#80 | CP-181109 | | | | Presented for information and approval | 1.0.0 | | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | | +| 2018-09 | CT#81 | CP-182064 | 0002 | 1 | F | Change to Common Data Type | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0003 | 1 | F | Correct HTTP Response Code | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0004 | 1 | F | Add Missing Parameters | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0005 | - | F | Clarify the Format of SMS Record ID | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0006 | - | F | Add support of 5G Trace | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0007 | 2 | F | Backup AMF Info | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0008 | - | F | Description of Structured data types | 15.1.0 | | +| 2018-09 | CT#81 | CP-182064 | 0009 | 1 | F | API Version Update | 15.1.0 | | +| 2018-12 | CT#82 | CP-183023 | 0010 | 1 | F | API Correction | 15.2.0 | | +| 2018-12 | CT#82 | CP-183023 | 0011 | - | F | CR cardinality | 15.2.0 | | +| 2018-12 | CT#82 | CP-183023 | 0012 | 1 | F | NF group Id | 15.2.0 | | +| 2018-12 | CT#82 | CP-183023 | 0013 | - | F | APIRoot Clarification | 15.2.0 | | +| 2018-12 | CT#82 | CP-183023 | 0014 | - | F | Location Header in HTTP 201 Response | 15.2.0 | | +| 2018-12 | CT#82 | CP-183023 | 0015 | - | F | Open API version | 15.2.0 | | +| 2018-12 | CT#82 | CP-183188 | 0016 | - | F | Optionality of OAuth2 | 15.2.0 | | +| 2018-12 | CT#82 | CP-183189 | 0017 | - | F | Correction of "externalDocs" for Nsmf_SMService Service | 15.2.0 | | +| 2019-03 | CT#83 | CP-190069 | 0018 | 2 | F | SMS payload | 15.3.0 | | +| 2019-03 | CT#83 | CP-190028 | 0020 | - | F | API version update | 15.3.0 | | +| 2019-06 | CT#84 | CP-191040 | 0019 | 2 | F | Resolve Editor's Notes | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0021 | 1 | F | Resource URI correction | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0022 | 1 | F | API URI Description | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0023 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0025 | 1 | F | API Version Correction | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0026 | 1 | F | Supported Content Type | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0027 | 1 | F | Essential Corrections on MultiPart Message | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0029 | 1 | F | Copyright Note in YAML file | 15.4.0 | | +| 2019-06 | CT#84 | CP-191040 | 0031 | 1 | F | 3GPP TS 29.540 API Version Update | 15.4.0 | | +| 2019-06 | CT#84 | CP-191057 | 0024 | - | B | Remove useless and misleading application error | 16.0.0 | | +| 2019-09 | CT#85 | CP-192112 | 0033 | 1 | F | Decouple uplinkSMS Response with SMS-C Communication | 16.1.0 | | +| 2019-09 | CT#85 | CP-192123 | 0034 | - | F | CRLF between Header fields and Data | 16.1.0 | | +| 2019-09 | CT#85 | CP-192120 | 0036 | - | F | 29.540 Rel-16 Open API version externalDocs | 16.1.0 | | +| 2019-12 | CT#86 | CP-193044 | 0040 | - | F | 29.540 Rel-16 API version and External doc update | 16.2.0 | | +| 2020-03 | CT#87 | CP-200039 | 0041 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | | +| 2020-03 | CT#87 | CP-200039 | 0042 | 2 | F | Correction - formatting consistency | 16.3.0 | | +| 2020-03 | CT#87 | CP-200033 | 0043 | - | B | RAT Type | 16.3.0 | | +| 2020-03 | CT#87 | CP-200020 | 0044 | 2 | F | Optionality of ProblemDetails | 16.3.0 | | +| 2020-03 | CT#87 | CP-200052 | 0045 | - | F | API version and External doc update | 16.3.0 | | +| 2020-06 | CT#88 | CP-201059 | 0046 | 1 | F | Supported Headers table for response code 201 | 16.4.0 | | +| 2020-06 | CT#88 | CP-201059 | 0047 | 1 | F | Binary Data Types Table | 16.4.0 | | +| 2020-06 | CT#88 | CP-201024 | 0048 | 1 | F | Correct the Data Type Descriptions | 16.4.0 | | +| 2020-06 | CT#88 | CP-201059 | 0051 | 1 | F | Data type column in Resource URI variables Table | 16.4.0 | | +| 2020-06 | CT#88 | CP-201059 | 0052 | 1 | F | Add custom operation Name | 16.4.0 | | +| 2020-06 | CT#88 | CP-201024 | 0054 | - | F | Essential Corrections | 16.4.0 | | +| 2020-06 | CT#88 | CP-201073 | 0055 | - | F | API version and External doc update | 16.4.0 | | +| 2020-09 | CT#89 | CP-202101 | 0056 | 1 | F | Storage of YAML files in 3GPP Forge | 16.5.0 | | +| 2020-09 | CT#89 | CP-202096 | 0057 | - | F | API version and External doc update | 16.5.0 | | +| 2020-12 | CT#90 | CP-203027 | 0059 | 1 | F | Correction to support multiple access type for SMS | 16.6.0 | | +| 2020-12 | CT#90 | CP-203054 | 0060 | 1 | F | HTTP 3xx redirection | 16.6.0 | | +| 2020-12 | CT#90 | CP-203048 | 0064 | 1 | F | Essential corrections | 16.6.0 | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90 | CP-203027 | 0066 | 2 | F | Header check at deactivation of SMS service | 16.6.0 | +| 2020-12 | CT#90 | CP-203036 | 0069 | - | F | API version and External doc update | 16.6.0 | +| 2021-03 | CT#91 | CP-210062 | 0074 | - | F | Etag in 204 Response | 16.7.0 | +| 2021-03 | CT#91 | CP-210054 | 0078 | - | F | API version and External doc update | 16.7.0 | +| 2021-03 | CT#91 | CP-210021 | 0072 | 1 | B | Home Network Public Key identifier as additional input for SMSF service | 17.0.0 | +| 2021-03 | CT#91 | CP-210034 | 0075 | - | F | Editorial and reference errors | 17.0.0 | +| 2021-03 | CT#91 | CP-210034 | 0076 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-03 | CT#91 | CP-210029 | 0077 | - | F | API version and External doc update | 17.0.0 | +| 2021-06 | CT#92 | CP-211028 | 0080 | - | F | Adding some missing description fields to data type definitions in the OpenAPI specification file of the Nsmf_SMSService API | 17.1.0 | +| 2021-06 | CT#92 | CP-211177 | 0082 | 2 | F | Redirect Response | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0083 | - | F | 29.540 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212026 | 0085 | 1 | F | SMSF dual access registration | 17.2.0 | +| 2021-09 | CT#93 | CP-212060 | 0087 | - | F | 3xx description correction for SCP | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0088 | - | F | 29.540 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94 | CP-213087 | 0090 | 1 | F | Removal of backupAmfInfo | 17.3.0 | +| 2021-12 | CT#94 | CP-213121 | 0091 | - | F | 29.540 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95 | CP-220024 | 0093 | 3 | F | Introduce HTTP PATCH Method | 17.4.0 | +| 2022-03 | CT#95 | CP-220024 | 0094 | - | F | Simplify 307/308 Response in OpenAPI | 17.4.0 | +| 2022-03 | CT#95 | CP-220026 | 0096 | 1 | A | 3xx Redirect Response | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0097 | - | F | 29.540 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221027 | 0099 | - | F | Correction of typos in description fields | 17.5.0 | +| 2022-06 | CT#96 | CP-221054 | 0100 | - | F | Correction on USER NOT FOUND error | 17.5.0 | +| 2022-06 | CT#96 | CP-221090 | 0103 | 2 | B | MtForwardSm service operation | 17.5.0 | +| 2022-06 | CT#96 | CP-221031 | 0104 | 1 | B | Removal of the NOTE on interaction between SMSF and SMS-GMSC/IWMSC/IP-SM-GW/SMS Router | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0105 | - | B | 29.540 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222026 | 0106 | 1 | F | Partial success in PATCH | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0107 | - | F | 29.540 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98 | CP-223028 | 0108 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0109 | - | F | 29.540 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230029 | 0110 | - | F | Missing Mandatory Status Codes | 18.1.0 | +| 2023-03 | CT#99 | CP-220071 | 0112 | - | F | 29.540 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231026 | 0111 | 2 | F | Location header description | 18.2.0 | +| 2023-12 | CT#102 | CP-233027 | 0116 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | +| 2023-12 | CT#102 | CP-233029 | 0115 | 2 | F | Obsoleted HTTP/2 RFCs | 18.3.0 | \ No newline at end of file diff --git a/gsma/29_series/29549/raw.md b/gsma/29_series/29549/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f4b779759661bbdc41188ece5b3d0ba855b3fe42 --- /dev/null +++ b/gsma/29_series/29549/raw.md @@ -0,0 +1,16973 @@ + + +# 3GPP TS 29.549 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Service Enabler Architecture Layer for Verticals (SEAL); Application Programming Interface (API) specification; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTSTM is a Trade Mark of ETSI registered for the benefit of its members +3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTETM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| Foreword..... | 20 | +| 1 Scope..... | 22 | +| 2 References..... | 22 | +| 3 Definitions of terms and abbreviations..... | 23 | +| 3.1 Terms..... | 23 | +| 3.2 Abbreviations..... | 24 | +| 4 Overview..... | 24 | +| 5 Services offered by the SEAL servers..... | 25 | +| 5.1 Introduction of SEAL services..... | 25 | +| 5.2 Location management APIs..... | 28 | +| 5.2.1 SS_LocationReporting API..... | 28 | +| 5.2.1.1 Service Description..... | 28 | +| 5.2.1.1.1 Overview..... | 28 | +| 5.2.1.2 Service Operations..... | 28 | +| 5.2.1.2.1 Introduction..... | 28 | +| 5.2.1.2.2 Create_Trigger_Location_Reporting..... | 29 | +| 5.2.1.2.2.1 General..... | 29 | +| 5.2.1.2.2.2 VAL server providing trigger configuration using Create_Trigger_Location_Reporting service operation..... | 29 | +| 5.2.1.2.3 Fetch_Location_Report_Trigger..... | 29 | +| 5.2.1.2.3.1 General..... | 29 | +| 5.2.1.2.3.2 VAL server fetching trigger configuration using Fetch_Location_Report_Trigger service operation..... | 29 | +| 5.2.1.2.4 Update_Trigger_Location_Reporting..... | 30 | +| 5.2.1.2.4.1 General..... | 30 | +| 5.2.1.2.4.2 VAL server providing trigger configuration using Update_Trigger_Location_Reporting service operation..... | 30 | +| 5.2.1.2.5 Cancel_Trigger_Location_Reporting..... | 30 | +| 5.2.1.2.5.1 General..... | 30 | +| 5.2.1.2.5.2 VAL server providing trigger configuration using Cancel_Trigger_Location_Reporting service operation..... | 30 | +| 5.2.1.2.6 Notify_Trigger_Location_Reporting..... | 30 | +| 5.2.1.2.6.1 General..... | 30 | +| 5.2.1.2.6.2 LM Server notifies the VAL Server on the location trigger event using Notify_Trigger_Location_Reporting..... | 31 | +| 5.2.2 SS_LocationInfoEvent API..... | 31 | +| 5.2.3 SS_LocationInfoRetrieval API..... | 31 | +| 5.2.4 SS_LocationAreaInfoRetrieval API..... | 31 | +| 5.2.4.1 Service Description..... | 31 | +| 5.2.4.1.1 Overview..... | 31 | +| 5.2.4.2 Service Operations..... | 31 | +| 5.2.4.2.1 Introduction..... | 31 | +| 5.2.4.2.2 Obtain_UEs_Info..... | 32 | +| 5.2.4.2.2.1 General..... | 32 | +| 5.2.4.2.2.2 VAL server obtains UE(s) information in an application defined proximity range of a location using Obtain_UEs_Info service operation..... | 32 | +| 5.2.5 SS_LocationMonitoring API..... | 32 | +| 5.2.6 SS_LocationAreaMonitoring API..... | 33 | +| 5.2.7 SS_VALServiceAreaConfiguration API..... | 33 | +| 5.2.7.1 Service Description..... | 33 | +| 5.2.7.1.1 Overview..... | 33 | +| 5.2.7.2 Service Operations..... | 33 | +| 5.2.7.2.1 Introduction..... | 33 | +| 5.2.7.2.2 Configure_VAL_Service_Area..... | 34 | + +| | | | +|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 5.2.7.2.2.1 | General..... | 34 | +| 5.2.7.2.2.2 | VAL Server configures VAL service area(s) using the Configure_VAL_Service_Area service operation..... | 34 | +| 5.2.7.2.3 | Obtain_VAL_Service_Area..... | 34 | +| 5.2.7.2.3.1 | General..... | 34 | +| 5.2.7.2.3.2 | VAL Server obtains VAL service area(s) using the Obtain_VAL_Service_Area service operation..... | 34 | +| 5.2.7.2.4 | Update_VAL_Service_Area..... | 35 | +| 5.2.7.2.4.1 | General..... | 35 | +| 5.2.7.2.4.2 | VAL Server updates VAL service area(s) using the Update_VAL_Service_Area service operation..... | 35 | +| 5.2.7.2.5 | Delete_VAL_Service_Area..... | 35 | +| 5.2.7.2.5.1 | General..... | 35 | +| 5.2.7.2.5.2 | VAL Server deletes service area(s) using the Delete_VAL_Service_Area service operation..... | 35 | +| 5.2.7.2.6 | Subscribe_VAL_Service_Area_Change_Event..... | 36 | +| 5.2.7.2.6.1 | General..... | 36 | +| 5.2.7.2.6.2 | SEAL Server subscribes for the VAL service area(s) change event(s) reporting using the Subscribe_VAL_Service_Area_Change_Event service operation..... | 36 | +| 5.2.7.2.7 | Update_Subscription_VAL_Service_Area_Change_Event..... | 36 | +| 5.2.7.2.7.1 | General..... | 36 | +| 5.2.7.2.7.2 | SEAL Server updates the subscription for the VAL service area(s) change event(s) reporting using the Update_Subscription_VAL_Service_Area_Change_Event service operation..... | 36 | +| 5.2.7.2.8 | Unsubscribe_VAL_Service_Area_Change_Event..... | 37 | +| 5.2.7.2.8.1 | General..... | 37 | +| 5.2.7.2.8.2 | SEAL server unsubscribes from the VAL service area(s) change event(s) using Unsubscribe_VAL_Service_Area_Change_Event..... | 37 | +| 5.2.7.2.9 | Notify_VAL_Service_Area_Change_Event..... | 37 | +| 5.2.7.2.9.1 | General..... | 37 | +| 5.2.7.2.9.2 | LM server notifies the SEAL Server on VAL service area(s) change event(s) using Notify_VAL_Service_Area_Change_Event..... | 37 | +| 5.3 | Group management APIs..... | 38 | +| 5.3.1 | SS_GroupManagement API..... | 38 | +| 5.3.1.1 | Service Description..... | 38 | +| 5.3.1.1.1 | Overview..... | 38 | +| 5.3.1.2 | Service Operations..... | 38 | +| 5.3.1.2.1 | Introduction..... | 38 | +| 5.3.1.2.2 | Query_Group_Info..... | 38 | +| 5.3.1.2.2.1 | General..... | 38 | +| 5.3.1.2.2.2 | VAL server fetching VAL group documents, group membership and configuration information using Query_Group_Info service operation..... | 38 | +| 5.3.1.2.3 | Update_Group_Info..... | 39 | +| 5.3.1.2.3.1 | General..... | 39 | +| 5.3.1.2.3.2 | VAL server modifying group membership and configuration using Update_Group_Info service operation..... | 39 | +| 5.3.1.2.4 | Create_Group..... | 40 | +| 5.3.1.2.4.1 | General..... | 40 | +| 5.3.1.2.4.2 | VAL server creating new group using Create_Group service operation..... | 40 | +| 5.3.1.2.5 | Delete_Group..... | 40 | +| 5.3.1.2.5.1 | General..... | 40 | +| 5.3.1.2.5.2 | VAL server deleting VAL group using Delete_Group service operation..... | 40 | +| 5.3.2 | SS_GroupManagementEvent API..... | 41 | +| 5.4 | Configuration management APIs..... | 41 | +| 5.4.1 | SS_UserProfileRetrieval API..... | 41 | +| 5.4.1.1 | Service Description..... | 41 | +| 5.4.1.1.1 | Overview..... | 41 | +| 5.4.1.2 | Service Operations..... | 41 | +| 5.4.1.2.1 | Introduction..... | 41 | +| 5.4.1.2.2 | Obtain_User_Profile..... | 41 | +| 5.4.1.2.2.1 | General..... | 41 | + +| | | | +|--------------|---------------------------------------------------------------------------------------------------------------------|----| +| 5.4.1.2.2.2 | VAL server retrieving VAL user profile information using Obtain_User_Profile service operation..... | 42 | +| 5.4.2 | SS_UserProfileEvent API..... | 42 | +| 5.4.3 | SS_VALServiceData API..... | 42 | +| 5.4.3.1 | Service Description..... | 42 | +| 5.4.3.1.1 | Overview..... | 42 | +| 5.4.3.2 | Service Operations..... | 42 | +| 5.4.3.2.1 | Introduction..... | 42 | +| 5.4.3.2.2 | Obtain_VAL_Service_Data..... | 42 | +| 5.4.3.2.2.1 | General..... | 42 | +| 5.4.3.2.2.2 | SEAL server retrieving VAL service data using Obtain_VAL_Service_Data service operation..... | 42 | +| 5.5 | Network resource management APIs..... | 43 | +| 5.5.1 | SS_NetworkResourceAdaptation API..... | 43 | +| 5.5.1.1 | Service Description..... | 43 | +| 5.5.1.1.1 | Overview..... | 43 | +| 5.5.1.2 | Service Operations..... | 43 | +| 5.5.1.2.1 | Introduction..... | 43 | +| 5.5.1.2.2 | Reserve_Network_Resource..... | 44 | +| 5.5.1.2.2.1 | General..... | 44 | +| 5.5.1.2.2.2 | VAL server requesting for network resource adaptation using Reserve_Network_Resource service operation..... | 44 | +| 5.5.1.2.3 | Request_Unicast_Resource..... | 45 | +| 5.5.1.2.3.1 | General..... | 45 | +| 5.5.1.2.3.2 | VAL server requesting for unicast resource using Request_Unicast_Resource service operation..... | 45 | +| 5.5.1.2.4 | Update_Unicast_Resource..... | 45 | +| 5.5.1.2.4.1 | General..... | 45 | +| 5.5.1.2.4.2 | VAL server requesting for updating the unicast resource using Update_Unicast_Resource service operation..... | 45 | +| 5.5.1.2.5 | Request_Multicast_Resource..... | 45 | +| 5.5.1.2.5.1 | General..... | 45 | +| 5.5.1.2.5.2 | VAL server requesting for multicast resource using Request_Multicast_Resource service operation..... | 45 | +| 5.5.1.2.6 | Notify_UP_Delivery_Mode..... | 46 | +| 5.5.1.2.6.1 | General..... | 46 | +| 5.5.1.2.6.2 | Notifying user plane events using Notify_UP_Delivery_Mode service operation..... | 46 | +| 5.5.1.2.7 | Create_TSC_Stream..... | 46 | +| 5.5.1.2.7.1 | General..... | 46 | +| 5.5.1.2.7.2 | VAL server requesting for create TSC stream using Create_TSC_Stream service operation..... | 46 | +| 5.5.1.2.8 | Delete_TSC_Stream..... | 47 | +| 5.5.1.2.8.1 | General..... | 47 | +| 5.5.1.2.8.2 | VAL server requesting to delete a TSC stream using Delete_TSC_Stream service operation..... | 47 | +| 5.5.1.2.9 | Discover_TSC_Stream_Availability..... | 47 | +| 5.5.1.2.9.1 | General..... | 47 | +| 5.5.1.2.9.2 | VAL server discovering TSC stream availability using Discover_TSC_Stream_Availability service operation..... | 48 | +| 5.5.1.2.10 | Create_MBS_Resource..... | 48 | +| 5.5.1.2.10.1 | General..... | 48 | +| 5.5.1.2.10.2 | VAL Server requesting the creation of an MBS Resource using the Create_MBS_Resource service operation..... | 48 | +| 5.5.1.2.11 | Update_MBS_Resource..... | 49 | +| 5.5.1.2.11.1 | General..... | 49 | +| 5.5.1.2.11.2 | VAL Server requesting the update of an existing MBS Resource using the Update_MBS_Resource service operation..... | 49 | +| 5.5.1.2.12 | Delete_MBS_Resource..... | 49 | +| 5.5.1.2.12.1 | General..... | 49 | +| 5.5.1.2.12.2 | VAL Server requesting the deletion of an existing MBS Resource using the Delete_MBS_Resource service operation..... | 49 | + +| | | | +|--------------|--------------------------------------------------------------------------------------------------------------------------------|----| +| 5.5.1.2.13 | Activate_MBS_Resource..... | 49 | +| 5.5.1.2.13.1 | General..... | 49 | +| 5.5.1.2.13.2 | VAL Server requesting the activation of an existing MBS Resource using the
Activate_MBS_Resource service operation..... | 50 | +| 5.5.1.2.14 | Deactivate_MBS_Resource..... | 50 | +| 5.5.1.2.14.1 | General..... | 50 | +| 5.5.1.2.14.2 | VAL Server requesting the deactivation of an existing MBS Resource using the
Deactivate_MBS_Resource service operation..... | 50 | +| 5.5.1.2.15 | BDT_Configuration_Request..... | 50 | +| 5.5.1.2.15.1 | General..... | 50 | +| 5.5.1.2.15.2 | VAL Server requesting the background data transfer policy using the
BDT_Configuration_Request service operation..... | 50 | +| 5.5.1.2.16 | BDT_Negotiation_Notification..... | 51 | +| 5.5.1.2.16.1 | General..... | 51 | +| 5.5.1.2.16.2 | NRM Server notifying the background data transfer policy using the
BDT_Negotiation_Notification service operation..... | 51 | +| 5.5.2 | SS_EventsMonitoring API..... | 51 | +| 5.5.3 | SS_NetworkResourceMonitoring API..... | 51 | +| 5.5.3.1 | Service Description..... | 51 | +| 5.5.3.1.1 | Overview..... | 51 | +| 5.5.3.2 | Service Operations..... | 51 | +| 5.5.3.2.1 | Introduction..... | 51 | +| 5.5.3.2.2 | Subscribe_Unicast_QoS_Monitoring..... | 52 | +| 5.5.3.2.2.1 | General..... | 52 | +| 5.5.3.2.2.2 | VAL server subscribes for Unicast QoS Monitoring using
Subscribe_Unicast_QoS_Monitoring..... | 52 | +| 5.5.3.2.3 | Unsubscribe_Unicast_QoS_Monitoring..... | 53 | +| 5.5.3.2.3.1 | General..... | 53 | +| 5.5.3.2.3.2 | VAL server unsubscribes for Unicast QoS Monitoring using
Unsubscribe_Unicast_QoS_Monitoring..... | 53 | +| 5.5.3.2.4 | Notify_Unicast_QoS_Monitoring..... | 53 | +| 5.5.3.2.4.1 | General..... | 53 | +| 5.5.3.2.4.2 | NRM server notifies for Unicast QoS Monitoring using Notify_Unicast_QoS_Monitoring..... | 53 | +| 5.5.3.2.5 | Obtain_Unicast_QoS_Monitoring_Data..... | 54 | +| 5.5.3.2.5.1 | General..... | 54 | +| 5.5.3.2.6 | Update_Unicast_QoS_Monitoring_Subscription..... | 54 | +| 5.5.3.2.6.1 | General..... | 54 | +| 5.5.3.2.6.2 | VAL server modifies for Unicast QoS Monitoring Subscription using
Update_Unicast_QoS_Monitoring_Subscription..... | 54 | +| 5.6 | Events APIs..... | 55 | +| 5.6.1 | SS_Events API..... | 55 | +| 5.6.1.1 | Service Description..... | 55 | +| 5.6.1.1.1 | Overview..... | 55 | +| 5.6.1.2 | Service Operations..... | 55 | +| 5.6.1.2.1 | Introduction..... | 55 | +| 5.6.1.2.2 | Subscribe_Event..... | 56 | +| 5.6.1.2.2.1 | General..... | 56 | +| 5.6.1.2.2.2 | Subscribing to SEAL events using Subscribe_Event service operation..... | 56 | +| 5.6.1.2.3 | Notify_Event..... | 56 | +| 5.6.1.2.3.1 | General..... | 56 | +| 5.6.1.2.3.2 | Notifying SEAL events using Notify_Event service operation..... | 56 | +| 5.6.1.2.4 | Unsubscribe_Event..... | 56 | +| 5.6.1.2.4.1 | General..... | 56 | +| 5.6.1.2.4.2 | Unsubscribing from SEAL events using Unsubscribe_Event service operation..... | 56 | +| 5.6.1.2.5 | Update_Subscription..... | 57 | +| 5.6.1.2.5.1 | General..... | 57 | +| 5.6.1.2.5.2 | Updating the SEAL events subscription using Update_Subscription service operation..... | 57 | +| 5.7 | Key management APIs..... | 57 | +| 5.7.1 | SS_KeyInfoRetrieval API..... | 57 | +| 5.7.1.1 | Service Description..... | 57 | +| 5.7.1.1.1 | Overview..... | 57 | + +| | | | +|-------------|----------------------------------------------------------------------------------------------------------------------------|----| +| 5.7.1.2 | Service Operations..... | 57 | +| 5.7.1.2.1 | Introduction..... | 57 | +| 5.7.1.2.2 | Obtain_Key_Info..... | 57 | +| 5.7.1.2.2.1 | General..... | 57 | +| 5.7.1.2.2.2 | VAL server obtaining VAL service specific key material using Obtain_Key_Info service operation..... | 58 | +| 5.8 | Network slice capability Enablement APIs..... | 58 | +| 5.8.1 | SS_NetworkSliceAdaptation API..... | 58 | +| 5.8.1.1 | Service Description..... | 58 | +| 5.8.1.1.1 | Overview..... | 58 | +| 5.8.1.2 | Service Operations..... | 58 | +| 5.8.1.2.1 | Introduction..... | 58 | +| 5.8.1.2.2 | Network_slice_adaptation..... | 58 | +| 5.8.1.2.2.1 | General..... | 58 | +| 5.8.1.2.2.2 | VAL server requesting network slice adaptation using Network_slice_adaptation service operation..... | 58 | +| 5.9 | Identity Management APIs..... | 59 | +| 5.9.1 | SS_IdmParameterProvisioning API..... | 59 | +| 5.9.1.1 | Service Description..... | 59 | +| 5.9.1.1.1 | Overview..... | 59 | +| 5.9.1.2 | Service Operations..... | 59 | +| 5.9.1.2.1 | Introduction..... | 59 | +| 5.9.1.2.2 | Provide_Configuration..... | 60 | +| 5.9.1.2.2.1 | General..... | 60 | +| 5.9.1.2.2.2 | VAL server provisioning VAL service specific information using Provide_Configuration service operation..... | 60 | +| 5.9.1.2.3 | Get_Configuration..... | 60 | +| 5.9.1.2.3.1 | General..... | 60 | +| 5.9.1.2.3.2 | Service consumer obtaining the VAL service specific information provisioned using Get_Configuration service operation..... | 60 | +| 5.9.1.2.4 | Update_Configuration..... | 60 | +| 5.9.1.2.4.1 | General..... | 60 | +| 5.9.1.2.4.2 | Service consumer updating VAL service specific information using Update_Configuration service operation..... | 61 | +| 5.9.1.2.5 | Delete_Configuration..... | 61 | +| 5.9.1.2.5.1 | General..... | 61 | +| 5.9.1.2.5.2 | Service consumer deleting VAL service specific information using Delete_Configuration service operation..... | 61 | +| 5.10 | Data Delivery APIs..... | 61 | +| 6 | SEAL Design Aspects Common for All APIs..... | 61 | +| 6.1 | General..... | 61 | +| 6.2 | Data Types..... | 62 | +| 6.2.1 | General..... | 62 | +| 6.2.2 | Referenced structured data types..... | 62 | +| 6.2.3 | Referenced Simple data types and enumerations..... | 62 | +| 6.3 | Usage of HTTP..... | 63 | +| 6.4 | Content type..... | 63 | +| 6.5 | URI structure..... | 63 | +| 6.6 | Notifications..... | 64 | +| 6.7 | Error Handling..... | 64 | +| 6.8 | Feature negotiation..... | 64 | +| 6.9 | HTTP headers..... | 64 | +| 6.10 | Conventions for Open API specification files..... | 64 | +| 7 | SEAL API Definitions..... | 65 | +| 7.1 | Location management APIs..... | 65 | +| 7.1.1 | SS_LocationReporting API..... | 65 | +| 7.1.1.1 | API URI..... | 65 | +| 7.1.1.2 | Resources..... | 65 | +| 7.1.1.2.1 | Overview..... | 65 | +| 7.1.1.2.2 | Resource: SEAL Location Reporting Configurations..... | 66 | + +| | | | +|---------------|-----------------------------------------------------------------|----| +| 7.1.1.2.2.1 | Description..... | 66 | +| 7.1.1.2.2.2 | Resource Definition..... | 66 | +| 7.1.1.2.2.3 | Resource Standard Methods..... | 66 | +| 7.1.1.2.2.3.1 | POST..... | 66 | +| 7.1.1.2.2.4 | Resource Custom Operations..... | 67 | +| 7.1.1.2.3 | Resource: Individual SEAL Location Reporting Configuration..... | 67 | +| 7.1.1.2.3.1 | Description..... | 67 | +| 7.1.1.2.3.2 | Resource Definition..... | 67 | +| 7.1.1.2.3.3 | Resource Standard Methods..... | 67 | +| 7.1.1.2.3.3.1 | GET..... | 67 | +| 7.1.1.2.3.3.2 | PUT..... | 68 | +| 7.1.1.2.3.3.3 | DELETE..... | 69 | +| 7.1.1.2.3.3.4 | PATCH..... | 70 | +| 7.1.1.2.3.4 | Resource Custom Operations..... | 71 | +| 7.1.1.3 | Notifications..... | 71 | +| 7.1.1.3.1 | General..... | 71 | +| 7.1.1.3.2 | Location Trigger Event Notification..... | 71 | +| 7.1.1.3.2.1 | Description..... | 71 | +| 7.1.1.3.2.2 | Notification definition..... | 71 | +| 7.1.1.4 | Data Model..... | 73 | +| 7.1.1.4.1 | General..... | 73 | +| 7.1.1.4.2 | Structured data types..... | 74 | +| 7.1.1.4.2.1 | Introduction..... | 74 | +| 7.1.1.4.2.2 | Type: LocationReportConfiguration..... | 74 | +| 7.1.1.4.2.3 | Type: LocationReportConfigurationPatch..... | 75 | +| 7.1.1.4.2.4 | Type: TriggeringCriteria..... | 75 | +| 7.1.1.4.2.5 | LocationReport..... | 75 | +| 7.1.1.4.3 | Simple data types and enumerations..... | 76 | +| 7.1.1.4.3.1 | Introduction..... | 76 | +| 7.1.1.4.3.2 | Simple data types..... | 76 | +| 7.1.1.4.3.3 | Enumeration: InsideOutsideInd..... | 76 | +| 7.1.1.4.3.4 | Enumeration: LocChangeCond..... | 76 | +| 7.1.1.5 | Error Handling..... | 76 | +| 7.1.1.5.1 | General..... | 76 | +| 7.1.1.5.2 | Protocol Errors..... | 77 | +| 7.1.1.5.3 | Application Errors..... | 77 | +| 7.1.1.6 | Feature negotiation..... | 77 | +| 7.1.2 | SS_LocationAreaInfoRetrieval API..... | 77 | +| 7.1.2.1 | API URI..... | 77 | +| 7.1.2.2 | Resources..... | 77 | +| 7.1.2.2.1 | Overview..... | 77 | +| 7.1.2.2.2 | Resource: Location Information..... | 78 | +| 7.1.2.2.2.1 | Description..... | 78 | +| 7.1.2.2.2.2 | Resource Definition..... | 78 | +| 7.1.2.2.2.3 | Resource Standard Methods..... | 78 | +| 7.1.2.2.2.3.1 | GET..... | 78 | +| 7.1.2.2.2.4 | Resource Custom Operations..... | 79 | +| 7.1.2.3 | Notifications..... | 79 | +| 7.1.2.4 | Data Model..... | 80 | +| 7.1.2.4.1 | General..... | 80 | +| 7.1.2.4.2 | Structured Data Types..... | 80 | +| 7.1.2.4.3 | Simple data types and enumerations..... | 80 | +| 7.1.2.5 | Error Handling..... | 80 | +| 7.1.2.5.1 | General..... | 80 | +| 7.1.2.5.2 | Protocol Errors..... | 80 | +| 7.1.2.5.3 | Application Errors..... | 80 | +| 7.1.2.6 | Feature Negotiation..... | 81 | +| 7.1.3 | SS_VALServiceAreaConfiguration API..... | 81 | +| 7.1.3.1 | API URI..... | 81 | +| 7.1.3.2 | Resources..... | 81 | +| 7.1.3.2.1 | Overview..... | 81 | + +| | | | +|---------------|----------------------------------------------------------------|-----| +| 7.1.3.2.2 | Resource: VAL Service Areas..... | 83 | +| 7.1.3.2.2.1 | Description..... | 83 | +| 7.1.3.2.2.2 | Resource Definition..... | 83 | +| 7.1.3.2.2.3 | Resource Standard Methods..... | 83 | +| 7.1.3.2.2.3.1 | GET..... | 83 | +| 7.1.3.2.2.4 | Resource Custom Operations..... | 84 | +| 7.1.3.2.2.4.1 | Overview..... | 84 | +| 7.1.3.2.2.4.2 | Operation: Configure..... | 84 | +| 7.1.3.2.2.4.3 | Operation: Update..... | 85 | +| 7.1.3.2.2.4.4 | Operation: Delete..... | 86 | +| 7.1.3.2.3 | Resource: VAL Service Area Change Subscriptions..... | 87 | +| 7.1.3.2.3.1 | Description..... | 87 | +| 7.1.3.2.3.2 | Resource Definition..... | 87 | +| 7.1.3.2.3.3 | Resource Standard Methods..... | 87 | +| 7.1.3.2.3.3.1 | POST..... | 87 | +| 7.1.3.2.3.4 | Resource Custom Operations..... | 89 | +| 7.1.3.2.4 | Resource: Individual VAL Service Area Change Subscription..... | 89 | +| 7.1.3.2.4.1 | Description..... | 89 | +| 7.1.3.2.4.2 | Resource Definition..... | 89 | +| 7.1.3.2.4.3 | Resource Standard Methods..... | 89 | +| 7.1.3.2.4.3.1 | GET..... | 89 | +| 7.1.3.2.4.3.2 | PUT..... | 90 | +| 7.1.3.2.4.3.3 | PATCH..... | 91 | +| 7.1.3.2.4.3.4 | DELETE..... | 92 | +| 7.1.3.3.2 | Individual Unicast Monitoring Notification..... | 94 | +| 7.1.3.3.2.1 | Description..... | 94 | +| 7.1.3.3.2.2 | Notification definition..... | 94 | +| 7.1.3.4 | Data Model..... | 95 | +| 7.1.3.4.1 | General..... | 95 | +| 7.1.3.4.2 | Structured data types..... | 96 | +| 7.1.3.4.2.1 | Introduction..... | 96 | +| 7.1.3.4.2.2 | Type: ValServiceArea..... | 96 | +| 7.1.3.4.2.3 | Type: ValServiceAreaReq..... | 96 | +| 7.1.3.4.2.4 | Type: ValServiceAreaData..... | 96 | +| 7.1.3.4.2.5 | Type: ValServiceAreaResp..... | 97 | +| 7.1.3.4.2.6 | Type: ValServiceAreaSubsc..... | 97 | +| 7.1.3.4.2.7 | Type: ValServiceAreaEventType..... | 97 | +| 7.1.3.4.2.8 | Type: ValServiceAreaNotif..... | 97 | +| 7.1.3.4.2.9 | Type: ValServiceAreaEventContentInfo..... | 98 | +| 7.1.3.4.2.10 | Type: ValServiceAreaSubscPatch..... | 98 | +| 7.1.3.4.3 | Simple data types and enumerations..... | 98 | +| 7.1.3.4.3.1 | Introduction..... | 98 | +| 7.1.3.4.3.2 | Simple data types..... | 98 | +| 7.1.3.4.3.3 | Enumeration: ValServiceAreaEvent..... | 98 | +| 7.1.3.5 | Error Handling..... | 99 | +| 7.1.3.5.1 | General..... | 99 | +| 7.1.3.5.2 | Protocol Errors..... | 99 | +| 7.1.3.5.3 | Application Errors..... | 99 | +| 7.1.3.6 | Feature negotiation..... | 99 | +| 7.2 | Group management APIs..... | 99 | +| 7.2.1 | SS_GroupManagement API..... | 99 | +| 7.2.1.1 | API URI..... | 99 | +| 7.2.1.2 | Resources..... | 99 | +| 7.2.1.2.1 | Overview..... | 99 | +| 7.2.1.2.2 | Resource: VAL Group Documents..... | 100 | +| 7.2.1.2.2.1 | Description..... | 100 | +| 7.2.1.2.2.2 | Resource Definition..... | 101 | +| 7.2.1.2.2.3 | Resource Standard Methods..... | 101 | +| 7.2.1.2.2.3.1 | POST..... | 101 | +| 7.2.1.2.2.3.2 | GET..... | 102 | +| 7.2.1.2.2.4 | Resource Custom Operations..... | 102 | + +| | | | +|---------------|-----------------------------------------------------|-----| +| 7.2.1.2.3 | Resource: Individual VAL Group Document..... | 103 | +| 7.2.1.2.3.1 | Description..... | 103 | +| 7.2.1.2.3.2 | Resource Definition..... | 103 | +| 7.2.1.2.3.3 | Resource Standard Methods..... | 103 | +| 7.2.1.2.3.3.1 | GET..... | 103 | +| 7.2.1.2.3.3.2 | PUT..... | 104 | +| 7.2.1.2.3.3.3 | DELETE..... | 105 | +| 7.2.1.2.3.3.4 | PATCH..... | 106 | +| 7.2.1.2.3.4 | Resource Custom Operations..... | 107 | +| 7.2.1.3 | Notifications..... | 107 | +| 7.2.1.4 | Data Model..... | 107 | +| 7.2.1.4.1 | General..... | 107 | +| 7.2.1.4.2 | Structured data types..... | 109 | +| 7.2.1.4.2.1 | Introduction..... | 109 | +| 7.2.1.4.2.2 | Type: VALGroupDocument..... | 109 | +| 7.2.1.4.2.3 | Type: VALGroupDocumentPatch..... | 110 | +| 7.2.1.4.3 | Simple data types and enumerations..... | 110 | +| 7.2.1.5 | Error Handling..... | 110 | +| 7.2.1.5.1 | General..... | 110 | +| 7.2.1.5.2 | Protocol Errors..... | 110 | +| 7.2.1.5.3 | Application Errors..... | 110 | +| 7.2.1.6 | Feature negotiation..... | 110 | +| 7.3 | Configuration management APIs..... | 111 | +| 7.3.1 | SS_UserProfileRetrieval API..... | 111 | +| 7.3.1.1 | API URI..... | 111 | +| 7.3.1.2 | Resources..... | 111 | +| 7.3.1.2.1 | Overview..... | 111 | +| 7.3.1.2.2 | Resource: VAL Services..... | 112 | +| 7.3.1.2.2.1 | Description..... | 112 | +| 7.3.1.2.2.2 | Resource Definition..... | 112 | +| 7.3.1.2.2.3 | Resource Standard Methods..... | 112 | +| 7.3.1.2.2.3.1 | GET..... | 112 | +| 7.3.1.2.2.4 | Resource Custom Operations..... | 113 | +| 7.3.1.3 | Notifications..... | 113 | +| 7.3.1.4 | Data Model..... | 113 | +| 7.3.1.4.1 | General..... | 113 | +| 7.3.1.4.2 | Structured data types..... | 114 | +| 7.3.1.4.2.1 | Introduction..... | 114 | +| 7.3.1.4.2.2 | Type: ProfileDoc..... | 114 | +| 7.3.1.4.2.3 | Type: ValTargetUe..... | 114 | +| 7.3.1.4.3 | Simple data types and enumerations..... | 114 | +| 7.3.1.5 | Error Handling..... | 114 | +| 7.3.1.5.1 | General..... | 114 | +| 7.3.1.5.2 | Protocol Errors..... | 114 | +| 7.3.1.5.3 | Application Errors..... | 115 | +| 7.3.1.6 | Feature negotiation..... | 115 | +| 7.3.2 | SS_VALServiceData API..... | 115 | +| 7.3.2.1 | API URI..... | 115 | +| 7.3.2.2 | Resources..... | 115 | +| 7.3.2.2.1 | Overview..... | 115 | +| 7.3.2.2.2 | Resource: VAL Service Data Sets..... | 116 | +| 7.3.2.2.2.1 | Description..... | 116 | +| 7.3.2.2.2.2 | Resource Definition..... | 116 | +| 7.3.2.2.2.3 | Resource Standard Methods..... | 116 | +| 7.3.2.2.2.3.1 | GET..... | 116 | +| 7.3.2.2.2.4 | Resource Custom Operations..... | 117 | +| 7.3.2.3 | Custom Operations without associated resources..... | 117 | +| 7.3.2.4 | Notifications..... | 117 | +| 7.3.2.5 | Data Model..... | 117 | +| 7.3.2.5.1 | General..... | 117 | +| 7.3.2.5.2 | Structured data types..... | 118 | + +| | | | +|---------------|--------------------------------------------------|-----| +| 7.3.2.5.2.1 | Introduction..... | 118 | +| 7.3.2.5.2.2 | Type: ValServDataResp..... | 118 | +| 7.3.2.5.2.3 | Type: ValServiceData..... | 118 | +| 7.3.2.5.3 | Simple data types and enumerations..... | 118 | +| 7.3.2.5.3.1 | Introduction..... | 118 | +| 7.3.2.5.3.2 | Simple data types..... | 119 | +| 7.3.2.6 | Error Handling..... | 119 | +| 7.3.2.6.1 | General..... | 119 | +| 7.3.2.6.2 | Protocol Errors..... | 119 | +| 7.3.2.6.3 | Application Errors..... | 119 | +| 7.3.2.7 | Feature negotiation..... | 119 | +| 7.4 | Network resource management APIs..... | 119 | +| 7.4.1 | SS_NetworkResourceAdaptation API..... | 119 | +| 7.4.1.1 | API URI..... | 119 | +| 7.4.1.2 | Resources..... | 120 | +| 7.4.1.2.1 | Overview..... | 120 | +| 7.4.1.2.2 | Resource: Multicast Subscriptions..... | 122 | +| 7.4.1.2.2.1 | Description..... | 122 | +| 7.4.1.2.2.2 | Resource Definition..... | 122 | +| 7.4.1.2.2.3 | Resource Standard Methods..... | 123 | +| 7.4.1.2.2.3.1 | POST..... | 123 | +| 7.4.1.2.2.4 | Resource Custom Operations..... | 123 | +| 7.4.1.2.3 | Resource: Individual Multicast Subscription..... | 123 | +| 7.4.1.2.3.1 | Description..... | 123 | +| 7.4.1.2.3.2 | Resource Definition..... | 123 | +| 7.4.1.2.3.3 | Resource Standard Methods..... | 124 | +| 7.4.1.2.3.3.1 | GET..... | 124 | +| 7.4.1.2.3.3.2 | DELETE..... | 125 | +| 7.4.1.2.3.4 | Resource Custom Operations..... | 125 | +| 7.4.1.2.4 | Resource: Unicast Subscriptions..... | 126 | +| 7.4.1.2.4.1 | Description..... | 126 | +| 7.4.1.2.4.2 | Resource Definition..... | 126 | +| 7.4.1.2.4.3 | Resource Standard Methods..... | 126 | +| 7.4.1.2.4.3.1 | POST..... | 126 | +| 7.4.1.2.4.4 | Resource Custom Operations..... | 126 | +| 7.4.1.2.5 | Resource: Individual Unicast Subscription..... | 127 | +| 7.4.1.2.5.1 | Description..... | 127 | +| 7.4.1.2.5.2 | Resource Definition..... | 127 | +| 7.4.1.2.5.3 | Resource Standard Methods..... | 127 | +| 7.4.1.2.5.3.1 | GET..... | 127 | +| 7.4.1.2.5.3.2 | DELETE..... | 128 | +| 7.4.1.2.5.4 | Resource Custom Operations..... | 129 | +| 7.4.1.2.6 | Resource: TSC Stream Availability..... | 129 | +| 7.4.1.2.6.1 | Description..... | 129 | +| 7.4.1.2.6.2 | Resource Definition..... | 129 | +| 7.4.1.2.6.3 | Resource Standard Methods..... | 129 | +| 7.4.1.2.6.3.1 | GET..... | 129 | +| 7.4.1.2.6.4 | Resource Custom Operations..... | 130 | +| 7.4.1.2.7 | Resource: TSC streams..... | 130 | +| 7.4.1.2.7.1 | Description..... | 130 | +| 7.4.1.2.7.2 | Resource Definition..... | 130 | +| 7.4.1.2.7.3 | Resource Standard Methods..... | 131 | +| 7.4.1.2.7.3.1 | GET..... | 131 | +| 7.4.1.2.7.4 | Resource Custom Operations..... | 131 | +| 7.4.1.2.8 | Resource: Individual TSC Stream..... | 132 | +| 7.4.1.2.8.1 | Description..... | 132 | +| 7.4.1.2.8.2 | Resource Definition..... | 132 | +| 7.4.1.2.8.3 | Resource Standard Methods..... | 132 | +| 7.4.1.2.8.3.1 | GET..... | 132 | +| 7.4.1.2.8.3.2 | PUT..... | 133 | +| 7.4.1.2.8.3.3 | DELETE..... | 133 | + +| | | | +|----------------|----------------------------------------------------|-----| +| 7.4.1.2.9 | Resource: MBS Resources..... | 134 | +| 7.4.1.2.9.1 | Description..... | 134 | +| 7.4.1.2.9.2 | Resource Definition..... | 134 | +| 7.4.1.2.9.3 | Resource Standard Methods..... | 135 | +| 7.4.1.2.9.3.1 | POST..... | 135 | +| 7.4.1.2.9.4 | Resource Custom Operations..... | 135 | +| 7.4.1.2.10 | Resource: Individual MBS Resource..... | 135 | +| 7.4.1.2.10.1 | Description..... | 135 | +| 7.4.1.2.10.2 | Resource Definition..... | 135 | +| 7.4.1.2.10.3 | Resource Standard Methods..... | 136 | +| 7.4.1.2.10.3.1 | GET..... | 136 | +| 7.4.1.2.10.3.2 | PUT..... | 137 | +| 7.4.1.2.10.3.3 | PATCH..... | 138 | +| 7.4.1.2.10.3.4 | DELETE..... | 139 | +| 7.4.1.2.10.4 | Resource Custom Operations..... | 140 | +| 7.4.1.2.10.4.1 | Overview..... | 140 | +| 7.4.1.2.10.4.2 | Operation: Activate..... | 140 | +| 7.4.1.2.10.4.3 | Operation: Deactivate..... | 141 | +| 7.4.1.2.11 | Resource: BDT Policy Configurations..... | 142 | +| 7.4.1.2.11.1 | Description..... | 142 | +| 7.4.1.2.11.2 | Resource definition..... | 142 | +| 7.4.1.2.11.3 | Resource methods..... | 142 | +| 7.4.1.2.11.3.1 | POST..... | 142 | +| 7.4.1.2.12 | Resource: Individual BDT Policy Configuration..... | 143 | +| 7.4.1.2.12.1 | Description..... | 143 | +| 7.4.1.2.12.2 | Resource definition..... | 143 | +| 7.4.1.2.12.3 | Resource methods..... | 143 | +| 7.4.1.2.12.3.1 | GET..... | 143 | +| 7.4.1.2.12.3.2 | DELETE..... | 144 | +| 7.4.1.2.12.4 | Resource Custom Operations..... | 145 | +| 7.4.1.3 | Notifications..... | 145 | +| 7.4.1.3.1 | General..... | 145 | +| 7.4.1.3.2 | Notify_UP_Delivery_Mode..... | 146 | +| 7.4.1.3.2.1 | Description..... | 146 | +| 7.4.1.3.2.2 | Notification definition..... | 146 | +| 7.4.1.3.3 | BDT_Negotiation_Notification..... | 147 | +| 7.4.1.3.3.1 | Description..... | 147 | +| 7.4.1.3.3.2 | Notification definition..... | 147 | +| 7.4.1.4 | Data Model..... | 148 | +| 7.4.1.4.1 | General..... | 148 | +| 7.4.1.4.2 | Structured data types..... | 150 | +| 7.4.1.4.2.1 | Introduction..... | 150 | +| 7.4.1.4.2.2 | Type: MulticastSubscription..... | 150 | +| 7.4.1.4.2.3 | Type: UnicastSubscription..... | 151 | +| 7.4.1.4.2.4 | Type: UserPlaneNotification..... | 151 | +| 7.4.1.4.2.5 | Type: NrmEventNotification..... | 152 | +| 7.4.1.4.2.6 | Type: TscStreamData..... | 152 | +| 7.4.1.4.2.7 | Type: TrafficSpecInformation..... | 152 | +| 7.4.1.4.2.8 | Type: TscStreamAvailability..... | 153 | +| 7.4.1.4.2.9 | Type: StreamSpecification..... | 153 | +| 7.4.1.4.2.10 | Type: TrafficSpecification..... | 153 | +| 7.4.1.4.2.11 | Type: MBSResourceReq..... | 153 | +| 7.4.1.4.2.12 | Type: MBSResource..... | 154 | +| 7.4.1.4.2.13 | Type: MBSResourceRespInfo..... | 155 | +| 7.4.1.4.2.14 | Type: MBSResourceResp..... | 155 | +| 7.4.1.4.2.15 | Type: MBSResourcePatch..... | 156 | +| 7.4.1.4.2.16 | Type: MbsResAct..... | 156 | +| 7.4.1.4.2.17 | Type: MbsResDeact..... | 156 | +| 7.4.1.4.2.18 | Type: BdtPolConfig..... | 157 | +| 7.4.1.4.2.19 | Type: GeoArea..... | 157 | +| 7.4.1.4.2.20 | Type: BdtNotification..... | 158 | + +| | | | +|---------------|-----------------------------------------------------------|-----| +| 7.4.1.4.3 | Simple data types and enumerations..... | 158 | +| 7.4.1.4.3.0 | Introduction..... | 158 | +| 7.4.1.4.3.0A | Simple data types..... | 158 | +| 7.4.1.4.3.1 | Enumeration: ServiceAnnouncementMode..... | 158 | +| 7.4.1.4.3.2 | Enumeration: DeliveryMode..... | 159 | +| 7.4.1.4.3.4 | Enumeration: NetSysIndicator..... | 159 | +| 7.4.1.4.3.5 | Enumeration: NrmEvent..... | 159 | +| 7.4.1.5 | Error Handling..... | 159 | +| 7.4.1.5.1 | General..... | 159 | +| 7.4.1.5.2 | Protocol Errors..... | 159 | +| 7.4.1.5.3 | Application Errors..... | 159 | +| 7.4.1.6 | Feature negotiation..... | 160 | +| 7.4.2 | SS_NetworkResourceMonitoring API..... | 160 | +| 7.4.2.1 | API URI..... | 160 | +| 7.4.2.2 | Resources..... | 160 | +| 7.4.2.2.1 | Overview..... | 160 | +| 7.4.2.2.2 | Resource: Unicast Monitoring Subscriptions..... | 161 | +| 7.4.2.2.2.1 | Description..... | 161 | +| 7.4.2.2.2.2 | Resource Definition..... | 161 | +| 7.4.2.2.2.3 | Resource Standard Methods..... | 161 | +| 7.4.2.2.2.3.1 | POST..... | 161 | +| 7.4.2.2.2.4 | Resource Custom Operations..... | 162 | +| 7.4.2.2.3 | Resource: Individual Unicast Monitoring Subscription..... | 162 | +| 7.4.2.2.3.1 | Description..... | 162 | +| 7.4.2.2.3.2 | Resource Definition..... | 162 | +| 7.4.2.2.3.3 | Resource Standard Methods..... | 162 | +| 7.4.2.2.3.3.1 | DELETE..... | 162 | +| 7.4.2.2.3.3.2 | GET..... | 163 | +| 7.4.2.2.3.3.3 | PUT..... | 164 | +| 7.4.2.2.3.3.4 | PATCH..... | 165 | +| 7.4.2.3.2 | Individual Unicast Monitoring Notification..... | 166 | +| 7.4.2.3.2.1 | Description..... | 166 | +| 7.4.2.3.2.2 | Notification definition..... | 166 | +| 7.4.2.4 | Data Model..... | 167 | +| 7.4.2.4.1 | General..... | 167 | +| 7.4.2.4.2 | Structured data types..... | 169 | +| 7.4.2.4.2.1 | Introduction..... | 169 | +| 7.4.2.4.2.2 | Type: MonitoringReport..... | 169 | +| 7.4.2.4.2.3 | Type: MeasurementData..... | 169 | +| 7.4.2.4.2.4 | Type: MeasurementPeriod..... | 169 | +| 7.4.2.4.2.5 | Type: ReportingRequirements..... | 170 | +| 7.4.2.4.2.6 | Type: MeasurementRequirements..... | 171 | +| 7.4.2.4.2.7 | Type: MonitoringSubscription..... | 171 | +| 7.4.2.4.2.8 | Void..... | 172 | +| 7.4.2.4.2.9 | Type: FailureReport..... | 172 | +| 7.4.2.4.2.10 | Type: ReportingThreshold..... | 172 | +| 7.4.2.4.2.11 | Type: MonitoringSubscriptionPatch..... | 172 | +| 7.4.2.4.3 | Simple data types and enumerations..... | 173 | +| 7.4.2.4.3.1 | Enumeration: MeasurementDataType..... | 173 | +| 7.4.2.4.3.2 | Enumeration: TerminationMode..... | 173 | +| 7.4.2.4.3.3 | Enumeration: FailureReason..... | 173 | +| 7.4.2.4.3.4 | Enumeration: ThresholdHandlingMode..... | 173 | +| 7.4.2.5 | Error Handling..... | 174 | +| 7.4.2.5.1 | General..... | 174 | +| 7.4.2.5.2 | Protocol Errors..... | 174 | +| 7.4.2.5.3 | Application Errors..... | 174 | +| 7.4.2.6 | Feature negotiation..... | 174 | +| 7.5 | Event APIs..... | 174 | +| 7.5.1 | SS_Events API..... | 174 | +| 7.5.1.1 | API URI..... | 174 | +| 7.5.1.2 | Resources..... | 175 | + +| | | | +|---------------|----------------------------------------------------|-----| +| 7.5.1.2.1 | Overview..... | 175 | +| 7.5.1.2.2 | Resource: SEAL Events Subscriptions..... | 175 | +| 7.5.1.2.2.1 | Description..... | 175 | +| 7.5.1.2.2.2 | Resource Definition..... | 175 | +| 7.5.1.2.2.3 | Resource Standard Methods..... | 176 | +| 7.5.1.2.2.3.1 | POST..... | 176 | +| 7.5.1.2.2.4 | Resource Custom Operations..... | 176 | +| 7.5.1.2.3 | Resource: Individual SEAL Events Subscription..... | 176 | +| 7.5.1.2.3.1 | Description..... | 176 | +| 7.5.1.2.3.2 | Resource Definition..... | 176 | +| 7.5.1.2.3.3 | Resource Standard Methods..... | 177 | +| 7.5.1.2.3.3.1 | DELETE..... | 177 | +| 7.5.1.2.3.3.2 | PATCH..... | 178 | +| 7.5.1.2.3.3.3 | PUT..... | 178 | +| 7.5.1.2.3.4 | Resource Custom Operations..... | 179 | +| 7.5.1.3 | Notifications..... | 179 | +| 7.5.1.3.1 | General..... | 179 | +| 7.5.1.3.2 | SEAL Event Notification..... | 180 | +| 7.5.1.3.2.1 | Description..... | 180 | +| 7.5.1.3.2.2 | Notification definition..... | 180 | +| 7.5.1.4 | Data Model..... | 181 | +| 7.5.1.4.1 | General..... | 181 | +| 7.5.1.4.2 | Structured data types..... | 184 | +| 7.5.1.4.2.1 | Introduction..... | 184 | +| 7.5.1.4.2.2 | SEALEventSubscription..... | 184 | +| 7.5.1.4.2.3 | SEALEventNotification..... | 184 | +| 7.5.1.4.2.4 | EventSubscription..... | 185 | +| 7.5.1.4.2.5 | SEALEventDetail..... | 186 | +| 7.5.1.4.2.6 | VALGroupFilter..... | 187 | +| 7.5.1.4.2.7 | IdentityFilter..... | 187 | +| 7.5.1.4.2.8 | LMInformation..... | 187 | +| 7.5.1.4.2.9 | MessageFilter..... | 188 | +| 7.5.1.4.2.10 | MonitorFilter..... | 188 | +| 7.5.1.4.2.11 | MonitorEvents..... | 188 | +| 7.5.1.4.2.12 | MonitorEventsReport..... | 189 | +| 7.5.1.4.2.13 | ValidityConditions..... | 189 | +| 7.5.1.4.2.14 | MonitorLocationInterestFilter..... | 189 | +| 7.5.1.4.2.15 | LocationDevMonReport..... | 189 | +| 7.5.1.4.2.16 | TempGroupInfo..... | 190 | +| 7.5.1.4.2.17 | MonLocAreaInterestFltr..... | 190 | +| 7.5.1.4.2.18 | LocationInfoCriteria..... | 190 | +| 7.5.1.4.2.19 | ReferenceUEDetail..... | 191 | +| 7.5.1.4.2.20 | LocationAreaMonReport..... | 191 | +| 7.5.1.4.2.21 | MoveInOutUEDetails..... | 191 | +| 7.5.1.4.2.22 | SEALEventSubscriptionPatch..... | 191 | +| 7.5.1.4.2.23 | PartialEventSubscFailRep..... | 192 | +| 7.5.1.4.3 | Simple data types and enumerations..... | 192 | +| 7.5.1.4.3.1 | Introduction..... | 192 | +| 7.5.1.4.3.2 | Simple data types..... | 192 | +| 7.5.1.4.3.3 | Enumeration: SEALEvent..... | 193 | +| 7.5.1.4.3.4 | Enumeration: LocDevNotification..... | 193 | +| 7.5.1.4.3.5 | Enumeration: MonLocTriggerEvent..... | 193 | +| 7.5.1.5 | Error Handling..... | 194 | +| 7.5.1.5.1 | General..... | 194 | +| 7.5.1.5.2 | Protocol Errors..... | 194 | +| 7.5.1.5.3 | Application Errors..... | 194 | +| 7.5.1.6 | Feature Negotiation..... | 194 | +| 7.6 | Key management APIs..... | 195 | +| 7.6.1 | SS_KeyInfoRetrieval API..... | 195 | +| 7.6.1.1 | API URI..... | 195 | +| 7.6.1.2 | Resources..... | 196 | + +| | | | +|---------------|------------------------------------------------------|-----| +| 7.6.1.2.1 | Overview..... | 196 | +| 7.6.1.2.2 | Resource: Key Records..... | 196 | +| 7.6.1.2.2.1 | Description..... | 196 | +| 7.6.1.2.2.2 | Resource Definition..... | 196 | +| 7.6.1.2.2.3 | Resource Standard Methods..... | 197 | +| 7.6.1.2.2.3.1 | GET..... | 197 | +| 7.6.1.2.2.4 | Resource Custom Operations..... | 198 | +| 7.6.1.3 | Notifications..... | 198 | +| 7.6.1.4 | Data Model..... | 198 | +| 7.6.1.4.1 | General..... | 198 | +| 7.6.1.4.2 | Structured Data Types..... | 198 | +| 7.6.1.4.2.1 | Introduction..... | 198 | +| 7.6.1.4.2.2 | ValKeyInfo..... | 198 | +| 7.6.1.4.3 | Simple data types and enumerations..... | 199 | +| 7.6.1.5 | Error Handling..... | 199 | +| 7.6.1.5.1 | General..... | 199 | +| 7.6.1.5.2 | Protocol Errors..... | 199 | +| 7.6.1.5.3 | Application Errors..... | 199 | +| 7.6.1.6 | Feature Negotiation..... | 199 | +| 7.7 | Network slice capability Enablement APIs..... | 199 | +| 7.7.1 | SS_NetworkSliceAdaptation API..... | 199 | +| 7.7.1.1 | API URI..... | 199 | +| 7.7.1.2 | Resources..... | 199 | +| 7.7.1.3 | Custom Operations without associated resources..... | 200 | +| 7.7.1.3.1 | Overview..... | 200 | +| 7.7.1.3.2 | Operation: Request..... | 200 | +| 7.7.1.3.2.1 | Description..... | 200 | +| 7.7.1.3.2.2 | Operation Definition..... | 200 | +| 7.7.1.4 | Notifications..... | 201 | +| 7.7.1.5 | Data Model..... | 201 | +| 7.7.1.5.1 | General..... | 201 | +| 7.7.1.5.2 | Structured Data Types..... | 202 | +| 7.7.1.5.2.1 | Introduction..... | 202 | +| 7.7.1.5.2.2 | Type: NwSliceAdptInfo..... | 202 | +| 7.7.1.5.3 | Simple data types and enumerations..... | 202 | +| 7.7.1.6 | Error Handling..... | 202 | +| 7.7.1.6.1 | General..... | 202 | +| 7.7.1.6.2 | Protocol Errors..... | 202 | +| 7.7.1.6.3 | Application Errors..... | 202 | +| 7.7.1.7 | Feature Negotiation..... | 203 | +| 7.8 | Identity management APIs..... | 203 | +| 7.8.1 | SS_IdmParameterProvisioning API..... | 203 | +| 7.8.1.1 | API URI..... | 203 | +| 7.8.1.2 | Resources..... | 203 | +| 7.8.1.2.1 | Overview..... | 203 | +| 7.8.1.2.2 | Resource: VAL Services Configurations..... | 204 | +| 7.8.1.2.2.1 | Description..... | 204 | +| 7.8.1.2.2.2 | Resource Definition..... | 204 | +| 7.8.1.2.2.3 | Resource Standard Methods..... | 204 | +| 7.8.1.2.2.3.1 | POST..... | 204 | +| 7.8.1.2.2.3.2 | GET..... | 205 | +| 7.8.1.2.2.4 | Resource Custom Operations..... | 206 | +| 7.8.1.2.3 | Resource: Individual VAL Services Configuration..... | 206 | +| 7.8.1.2.3.1 | Description..... | 206 | +| 7.8.1.2.3.2 | Resource Definition..... | 206 | +| 7.8.1.2.3.3 | Resource Standard Methods..... | 206 | +| 7.8.1.2.3.3.1 | GET..... | 206 | +| 7.8.1.2.3.3.2 | PUT..... | 207 | +| 7.8.1.2.3.3.3 | PATCH..... | 208 | +| 7.8.1.2.3.3.4 | DELETE..... | 209 | +| 7.8.1.2.3.4 | Resource Custom Operations..... | 210 | + +| | | | +|----------------|--------------------------------------------------------------------------|-----| +| 7.8.1.3 | Custom operations without associated resources..... | 210 | +| 7.8.1.4 | Notifications..... | 210 | +| 7.8.1.5 | Data Model..... | 210 | +| 7.8.1.5.1 | General..... | 210 | +| 7.8.1.5.2 | Structured data types..... | 211 | +| 7.8.1.5.2.1 | Introduction..... | 211 | +| 7.8.1.5.2.2 | Type: VALServicesConfig..... | 211 | +| 7.8.1.5.2.3 | Type: VALServiceParams..... | 211 | +| 7.8.1.5.2.4 | Type: VALServicesConfigPatch..... | 212 | +| 7.8.1.5.3 | Simple data types and enumerations..... | 212 | +| 7.8.1.6 | Error Handling..... | 212 | +| 7.8.1.6.1 | General..... | 212 | +| 7.8.1.6.2 | Protocol Errors..... | 212 | +| 7.8.1.6.3 | Application Errors..... | 212 | +| 7.8.1.7 | Feature negotiation..... | 212 | +| 7.9 | Data Delivery APIs..... | 212 | +| 7.10 | Application data analytics enablement service configuration APIs..... | 213 | +| 7.10.1 | SS_ADAE_VALPerformanceAnalytics API..... | 213 | +| 7.10.1.1 | API URI..... | 213 | +| 7.10.1.2 | Resources..... | 213 | +| 7.10.1.2.1 | Overview..... | 213 | +| 7.10.1.2.2 | Resource: Application performance event subscription..... | 214 | +| 7.10.1.2.2.1 | Description..... | 214 | +| 7.10.1.2.2.2 | Resource Definition..... | 214 | +| 7.10.1.2.2.3 | Resource Standard Methods..... | 214 | +| 7.10.1.2.2.3.1 | POST..... | 214 | +| 7.10.1.2.2.4 | Resource Custom Operations..... | 215 | +| 7.10.1.3 | Notifications..... | 215 | +| 7.10.1.3.2 | Application performance event notification..... | 215 | +| 7.10.1.3.2.1 | Description..... | 215 | +| 7.10.1.3.2.2 | Notification definition..... | 215 | +| 7.10.1.4 | Data Model..... | 216 | +| 7.10.1.4.1 | General..... | 216 | +| 7.10.1.4.2 | Structured data types..... | 217 | +| 7.10.1.4.2.1 | Introduction..... | 217 | +| 7.10.1.4.2.2 | Type: AppPerfSubs..... | 218 | +| 7.10.1.4.2.3 | Type: AppPerfNotif..... | 219 | +| 7.10.1.4.2.4 | Type: ProdProfileInfo..... | 219 | +| 7.10.1.4.2.5 | Type: DataCollectReqs..... | 220 | +| 7.10.1.4.2.6 | Type: ProducerCap..... | 220 | +| 7.10.1.4.3 | Simple data types and enumerations..... | 220 | +| 7.10.1.4.3.1 | Introduction..... | 220 | +| 7.10.1.4.3.2 | Simple data types..... | 220 | +| 7.10.1.4.3.3 | Enumeration: AnalyticsType..... | 220 | +| 7.10.1.4.3.4 | Enumeration: DataType..... | 221 | +| 7.10.1.4.3.5 | Enumeration: ProducerType..... | 221 | +| 7.10.1.4.3.6 | Enumeration: ProducerData..... | 221 | +| 7.10.1.4.3.7 | Enumeration: ProducerRole..... | 222 | +| 7.10.1.4.3.8 | Enumeration: DataAbstraction..... | 222 | +| 7.10.1.5 | Error Handling..... | 222 | +| 7.10.1.5.1 | General..... | 222 | +| 7.10.1.5.2 | Protocol Errors..... | 222 | +| 7.10.1.5.3 | Application Errors..... | 222 | +| 7.10.1.6 | Feature Negotiation..... | 222 | +| 7.10.2 | SS_ADAE_SlicePerformanceAnalytics..... | 223 | +| 7.10.2.1 | API URI..... | 223 | +| 7.10.2.2 | Resources..... | 223 | +| 7.10.2.2.1 | Overview..... | 223 | +| 7.10.2.2.2 | Resource: Slice-specific application performance event subscription..... | 224 | +| 7.10.2.2.2.1 | Description..... | 224 | +| 7.10.2.2.2.2 | Resource Definition..... | 224 | + +| | | | +|----------------|----------------------------------------------------------------|-----| +| 7.10.2.2.2.3 | Resource Standard Methods..... | 224 | +| 7.10.2.2.2.3.1 | POST..... | 224 | +| 7.10.2.2.2.4 | Resource Custom Operations..... | 225 | +| 7.10.2.3 | Notifications..... | 225 | +| 7.10.2.3.2 | Slice-specific application performance event notification..... | 225 | +| 7.10.2.3.2.1 | Description..... | 225 | +| 7.10.2.3.2.2 | Notification definition..... | 225 | +| 7.10.2.4 | Data Model..... | 226 | +| 7.10.2.4.1 | General..... | 226 | +| 7.10.2.4.2 | Structured data types..... | 227 | +| 7.10.2.4.2.1 | Introduction..... | 227 | +| 7.10.2.4.2.2 | Type: SliceAppPerfSubs..... | 227 | +| 7.10.2.4.2.3 | Type: SliceAppPerfNotif..... | 227 | +| 7.10.2.5 | Error Handling..... | 227 | +| 7.10.2.5.1 | General..... | 227 | +| 7.10.2.5.2 | Protocol Errors..... | 228 | +| 7.10.2.5.3 | Application Errors..... | 228 | +| 7.10.2.6 | Feature Negotiation..... | 228 | +| 7.10.3 | SS_ADAE_Ue2UePerformanceAnalytics..... | 228 | +| 7.10.3.1 | API URI..... | 228 | +| 7.10.3.2 | Resources..... | 228 | +| 7.10.3.2.1 | Overview..... | 228 | +| 7.10.3.2.2 | Resource: UE-to-UE session performance event subscription..... | 229 | +| 7.10.3.2.2.1 | Description..... | 229 | +| 7.10.3.2.2.2 | Resource Definition..... | 229 | +| 7.10.3.2.2.3 | Resource Standard Methods..... | 230 | +| 7.10.3.2.2.3.1 | POST..... | 230 | +| 7.10.3.2.2.4 | Resource Custom Operations..... | 230 | +| 7.10.3.3 | Notifications..... | 231 | +| 7.10.3.3.2 | UE-to-UE session performance event notification..... | 231 | +| 7.10.3.3.2.1 | Description..... | 231 | +| 7.10.3.3.2.2 | Notification definition..... | 231 | +| 7.10.3.4 | Data Model..... | 231 | +| 7.10.3.4.1 | General..... | 231 | +| 7.10.3.4.2 | Structured data types..... | 232 | +| 7.10.3.4.2.1 | Introduction..... | 232 | +| 7.10.3.4.2.2 | Type: U2UPerfSubs..... | 232 | +| 7.10.3.4.2.3 | Type: Ue2UePerfNotif..... | 233 | +| 7.10.3.5 | Error Handling..... | 233 | +| 7.10.3.5.1 | General..... | 233 | +| 7.10.3.5.2 | Protocol Errors..... | 233 | +| 7.10.3.5.3 | Application Errors..... | 233 | +| 7.10.3.6 | Feature Negotiation..... | 233 | +| 7.10.4 | SS_ADAE_LocationAccuracyAnalytics..... | 233 | +| 7.10.4.1 | API URI..... | 233 | +| 7.10.4.2 | Resources..... | 234 | +| 7.10.4.2.1 | Overview..... | 234 | +| 7.10.4.2.2 | Resource: Location accuracy event subscription..... | 235 | +| 7.10.4.2.2.1 | Description..... | 235 | +| 7.10.4.2.2.2 | Resource Definition..... | 235 | +| 7.10.4.2.2.3 | Resource Standard Methods..... | 235 | +| 7.10.4.2.2.3.1 | POST..... | 235 | +| 7.10.4.2.2.4 | Resource Custom Operations..... | 235 | +| 7.10.4.3 | Notifications..... | 236 | +| 7.10.4.3.2 | Location accuracy event notification..... | 236 | +| 7.10.4.3.2.1 | Description..... | 236 | +| 7.10.4.3.2.2 | Notification definition..... | 236 | +| 7.10.4.4 | Data Model..... | 236 | +| 7.10.4.4.1 | General..... | 236 | +| 7.10.4.4.2 | Structured data types..... | 237 | +| 7.10.4.4.2.1 | Introduction..... | 237 | + +| | | | +|----------------|-------------------------------------------------------|-----| +| 7.10.4.4.2.2 | Type: LocAccurSubs..... | 238 | +| 7.10.4.4.2.3 | Type: LocAccurNotif..... | 238 | +| 7.10.4.5 | Error Handling..... | 238 | +| 7.10.4.5.1 | General..... | 238 | +| 7.10.4.5.2 | Protocol Errors..... | 238 | +| 7.10.4.5.3 | Application Errors..... | 238 | +| 7.10.4.6 | Feature Negotiation..... | 239 | +| 7.10.5 | SS_ADAE_ServiceApiAnalytics..... | 239 | +| 7.10.5.1 | API URI..... | 239 | +| 7.10.5.2 | Resources..... | 239 | +| 7.10.5.2.1 | Overview..... | 239 | +| 7.10.5.2.2 | Resource: Service API event subscription..... | 240 | +| 7.10.5.2.2.1 | Description..... | 240 | +| 7.10.5.2.2.2 | Resource Definition..... | 240 | +| 7.10.5.2.2.3 | Resource Standard Methods..... | 240 | +| 7.10.5.2.2.3.1 | POST..... | 240 | +| 7.10.5.2.2.4 | Resource Custom Operations..... | 241 | +| 7.10.5.3 | Notifications..... | 241 | +| 7.10.5.3.2 | Service API event notification..... | 241 | +| 7.10.5.3.2.1 | Description..... | 241 | +| 7.10.5.3.2.2 | Notification definition..... | 241 | +| 7.10.5.4 | Data Model..... | 242 | +| 7.10.5.4.1 | General..... | 242 | +| 7.10.5.4.2 | Structured data types..... | 242 | +| 7.10.5.4.2.1 | Introduction..... | 242 | +| 7.10.5.4.2.2 | Type: SrvApiSubs..... | 243 | +| 7.10.5.4.2.3 | Type: SrvApiNotif..... | 243 | +| 7.10.5.4.3 | Simple data types and enumerations..... | 243 | +| 7.10.5.4.3.1 | Introduction..... | 243 | +| 7.10.5.4.3.2 | Simple data types..... | 243 | +| 7.10.5.4.3.3 | Enumeration: SrvApiIdType..... | 243 | +| 7.10.5.5 | Error Handling..... | 243 | +| 7.10.5.5.1 | General..... | 243 | +| 7.10.5.5.2 | Protocol Errors..... | 244 | +| 7.10.5.5.3 | Application Errors..... | 244 | +| 7.10.5.6 | Feature Negotiation..... | 244 | +| 7.10.6 | SS_ADAE_SliceUsagePatternAnalytics..... | 244 | +| 7.10.6.1 | API URI..... | 244 | +| 7.10.6.2 | Resources..... | 244 | +| 7.10.6.2.1 | Overview..... | 244 | +| 7.10.6.2.2 | Resource: Slice usage pattern event subscription..... | 245 | +| 7.10.6.2.2.1 | Description..... | 245 | +| 7.10.6.2.2.2 | Resource Definition..... | 245 | +| 7.10.6.2.2.3 | Resource Standard Methods..... | 246 | +| 7.10.6.2.2.3.1 | POST..... | 246 | +| 7.10.6.2.2.4 | Resource Custom Operations..... | 246 | +| 7.10.6.2.2.4.1 | Overview..... | 246 | +| 7.10.6.2.2.4.2 | Operation: POST..... | 246 | +| 7.10.6.3 | Notifications..... | 247 | +| 7.10.6.3.2 | Slice usage pattern event notification..... | 247 | +| 7.10.6.3.2.1 | Description..... | 247 | +| 7.10.6.3.2.2 | Notification definition..... | 247 | +| 7.10.6.4 | Data Model..... | 248 | +| 7.10.6.4.1 | General..... | 248 | +| 7.10.6.4.2 | Structured data types..... | 249 | +| 7.10.6.4.2.1 | Introduction..... | 249 | +| 7.10.6.4.2.2 | Type: SUPAnalyticsSubs..... | 249 | +| 7.10.6.4.2.3 | Type: SUPNotif..... | 249 | +| 7.10.6.4.2.4 | Type: SUSLogReq..... | 250 | +| 7.10.6.4.2.5 | Type: SUSLogResp..... | 250 | +| 7.10.6.4.3 | Simple data types and enumerations..... | 250 | + +| | | | +|----------------|---------------------------------------------|-----| +| 7.10.6.4.3.1 | Introduction..... | 250 | +| 7.10.6.4.3.2 | Simple data types..... | 250 | +| 7.10.6.4.3.3 | Enumeration: NetworkSliceType..... | 251 | +| 7.10.6.5 | Error Handling..... | 251 | +| 7.10.6.5.1 | General..... | 251 | +| 7.10.6.5.2 | Protocol Errors..... | 251 | +| 7.10.6.5.3 | Application Errors..... | 251 | +| 7.10.6.6 | Feature Negotiation..... | 251 | +| 7.10.7 | SS_ADAE_EdgeLoadAnalytics..... | 251 | +| 7.10.7.1 | API URI..... | 251 | +| 7.10.7.2 | Resources..... | 252 | +| 7.10.7.2.1 | Overview..... | 252 | +| 7.10.7.2.2 | Resource: Edge load event subscription..... | 253 | +| 7.10.7.2.2.1 | Description..... | 253 | +| 7.10.7.2.2.2 | Resource Definition..... | 253 | +| 7.10.7.2.2.3 | Resource Standard Methods..... | 253 | +| 7.10.7.2.2.3.1 | POST..... | 253 | +| 7.10.7.2.2.4 | Resource Custom Operations..... | 254 | +| 7.10.7.2.2.4.1 | Overview..... | 254 | +| 7.10.7.2.2.4.2 | Operation: POST..... | 254 | +| 7.10.7.3 | Notifications..... | 255 | +| 7.10.7.3.2 | Edge load event notification..... | 255 | +| 7.10.7.3.2.1 | Description..... | 255 | +| 7.10.7.3.2.2 | Notification definition..... | 255 | +| 7.10.7.4 | Data Model..... | 256 | +| 7.10.7.4.1 | General..... | 256 | +| 7.10.7.4.2 | Structured data types..... | 256 | +| 7.10.7.4.2.1 | Introduction..... | 256 | +| 7.10.7.4.2.2 | Type: EdgeSubs..... | 257 | +| 7.10.7.4.2.3 | Type: EdgeNotif..... | 258 | +| 7.10.7.4.2.4 | Type: EdgeLogReq..... | 258 | +| 7.10.7.4.2.5 | Type: EdgeLogResp..... | 259 | +| 7.10.7.5 | Error Handling..... | 259 | +| 7.10.7.5.1 | General..... | 259 | +| 7.10.7.5.2 | Protocol Errors..... | 259 | +| 7.10.7.5.3 | Application Errors..... | 259 | +| 7.10.7.6 | Feature Negotiation..... | 259 | +| 8 | Using Common API Framework..... | 259 | +| 8.1 | General..... | 259 | +| 8.2 | Security..... | 260 | +| 9 | Security..... | 260 | +| 9.1 | General..... | 260 | +| 9.2 | SEAL-S security..... | 260 | + +| | | +|-------------------------------------------------------------------------------|------------| +| Annex A (normative): OpenAPI specification..... | 262 | +| A.1 General..... | 262 | +| A.2 SS_LocationReporting API..... | 262 | +| A.3 SS_GroupManagement API..... | 268 | +| A.4 SS_UserProfileRetrieval API..... | 273 | +| A.5 SS_NetworkResourceAdaptation API..... | 275 | +| A.6 SS_Events API..... | 295 | +| A.7 SS_KeyInfoRetrieval API..... | 306 | +| A.8 SS_LocationAreaInfoRetrieval API..... | 308 | +| A.9 SS_NetworkSliceAdaptation API..... | 309 | +| A.10 SS_NetworkResourceMonitoring API..... | 311 | +| A.11 SS_VALServiceData API..... | 319 | +| A.12 SS_VALServiceAreaConfiguration API..... | 321 | +| A.13 SS_IdmParameterProvisioning API..... | 330 | +| Annex B (normative): SEAL NRM server support integration with TSN..... | 335 | +| Annex C (informative): Change history..... | 336 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present specification describes the APIs for the Service Enabler Architecture Layer for Verticals (SEAL). The related stage 2 architecture, functional requirements and information flows are specified in 3GPP TS 23.434 [2] and 3GPP TS 23.433 [34] (for SEAL Data Delivery). + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.434: "Service Enabler Architecture Layer for Verticals (SEAL); Functional architecture and information flows". +- [3] 3GPP TS 29.122: "T8 reference point for Northbound Application Programming Interfaces (APIs)". +- [4] IETF RFC 6455: "The Websocket Protocol". +- [5] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [6] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [7] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [8] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". +- [9] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [10] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [11] Void +- [12] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)". +- [13] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [14] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [15] Open API: "OpenAPI Specification Version 3.0.0", . +- [16] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [17] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [18] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [19] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [20] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [21] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +- [22] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [23] 3GPP TS 29.468: "Group Communication System Enablers for LTE (GCSE\_LTE); MB2 reference point; Stage 3". +- [24] 3GPP TR 21.900: "Technical Specification Group working methods". +- [25] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [26] 3GPP TS 33.434: "Service Enabler Architecture Layer for Verticals (SEAL); Security Aspects". +- [27] 3GPP TS 29.486: "V2X Application Enabler (VAE) Services; Stage 3". +- [28] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [29] IEEE 802.1Qcc-2018: "IEEE Standard for Local and Metropolitan Area Networks—Bridges and Bridged Networks". +- [30] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [31] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [32] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [33] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [34] 3GPP TS 23.433: "Service Enabler Architecture Layer for Verticals (SEAL); Data Delivery enabler for vertical applications". +- [35] 3GPP TS 29.548: "Service Enabler Architecture Layer for Verticals (SEAL); SEAL Data Delivery (SEALDD) Server Services; Stage 3". +- [36] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services; Stage 2". +- [37] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description". +- [38] 3GPP TS 23.436: "Functional architecture and information flows for Application Data Analytics Enablement Service". +- [39] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [40] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". + +--- + +## 3 Definitions of terms and abbreviations + +### 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**VAL service:** A generic name for any service offered by the VAL service provider to their VAL users. + +**SEAL service:** A generic name for a common service (e.g. group management, configuration management, location management) that can be utilized by multiple vertical applications. + +**SEAL provider:** Provider of SEAL service(s). + +**VAL server:** A generic name for the server application function of a specific VAL service. + +**SEAL server:** An entity that provides the server side functionalities corresponding to the specific SEAL service. + +**VAL system:** The collection of applications, services, and enabling capabilities required to support a VAL service. + +**VAL group:** A defined set of VAL UEs or VAL users configured for specific purpose in a VAL service. + +NOTE: The set could be of either VAL UEs or VAL users depending on the specific VAL service. + +**VAL group home system:** The VAL system where the VAL group is defined. + +**VAL group member:** A VAL service user, whose VAL user ID is listed in a particular VAL group. + +**Vertical application:** An application catering to a specific vertical. + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|--------|--------------------------------------------------| +| 5GS | 5G System | +| ADAE | Application Data Analytics Enablement | +| AEF | API Exposing Function | +| API | Application Programming Interface | +| BDT | Background Data Transfer | +| DS-TT | Device-Side TSN Translator | +| JSON | JavaScript Object Notation | +| NDS | Network Domain Security | +| NDS/IP | NDS for IP based protocols | +| NRM | Network Resource Management | +| NSCE | Network Slice Capability Enablement | +| PLMN | Public Land Mobile Network | +| REST | Representational State Transfer | +| SCEF | Service Capability Exposure Function | +| SCS | Service Capability Server | +| SEAL | Service Enabler Architecture Layer for Verticals | +| SEALDD | SEAL Data Delivery | +| TMGI | Temporary Mobile Group Identity | +| TSC | Time Sensitive Communication | +| TSN | Time Sensitive Networking | +| UE | User Equipment | +| VAL | Vertical Application Layer | + +--- + +## 4 Overview + +3GPP has considered in 3GPP TS 23.434 [2] and 3GPP TS 23.433 [34] (for SEALDD) the development of Service enabler architecture layer for verticals (SEAL) over 3GPP networks to support vertical applications (e.g. V2X applications). It specifies the functional architecture for SEAL and the procedures, information flows and APIs for each service within SEAL in order to support vertical applications over the 3GPP systems. To ensure efficient use and deployment of vertical applications over 3GPP systems, SEAL services includes, group management, configuration management, location management, identity management, key management, network resource management, network slice capability enablement, application data analytics enablement (ADAE) and data delivery management. + +Clause 6 of 3GPP TS 23.434 [2] specifies the functional entities and domains of the functional model, reference points descriptions and SEAL APIs for SEAL services. + +The present document specifies the APIs needed to support SEAL. 3GPP TS 29.548 [35] specifies the APIs needed for SEALDD. + +--- + +## 5 Services offered by the SEAL servers + +### 5.1 Introduction of SEAL services + +The table 5.1-1 lists the SEAL server APIs below the service name. A service description clause for each API gives a general description of the related API. + +**Table 5.1-1: List of SEAL Service APIs** + +| Service Name | Service Operations | Operation Semantics | Consumer(s) | +|--------------------------------|---------------------------------------------------|---------------------|-------------| +| SS_LocationReporting | Create_Trigger_Location_Reporting | Request/ Response | VAL server | +| | Fetch_Location_Report_Trigger | Request/Response | VAL server | +| | Update_Trigger_Location_Reporting | Request/ Response | VAL server | +| | Cancel_Trigger_Location_Reporting | Request/ Response | VAL server | +| | Notify_Trigger_Location_Reporting | Notify | VAL server | +| SS_LocationInfoEvent | Subscribe_Location_Info | Subscribe/Notify | VAL server | +| | Unsubscribe_Location_Info | | VAL server | +| | Notify_Location_Info | | VAL server | +| SS_LocationInfoRetrieval | Obtain_Location_Info | Request/ Response | VAL server | +| SS_LocationAreaInfoRetrieval | Obtain_UEs_Info | Request/ Response | VAL server | +| SS_LocationMonitoring | Subscribe_Location_Monitoring | Subscribe/Notify | VAL server | +| | Unsubscribe_Location_Monitoring | | | +| | Notify_Location_Monitoring_Events | | | +| SS_LocationAreaMonitoring | Subscribe_Location_Area_Monitoring | Subscribe/Notify | VAL server | +| | Notify_Location_Area_Monitoring_Events | | | +| | Update_Location_Area_Monitoring_Subscribe | | | +| | Unsubscribe_Location_Area_Monitoring | | | +| SS_VALServiceAreaConfiguration | Configure_VAL_Service_Area | Request/Response | VAL server | +| | Obtain_VAL_Service_Area | Request/Response | VAL server | +| | Update_VAL_Service_Area | Request/Response | VAL server | +| | Delete_VAL_Service_Area | Request/Response | VAL server | +| | Subscribe_VAL_Service_Area_Change_Event | Subscribe/Notify | SEAL server | +| | Update_Subscription_VAL_Service_Area_Change_Event | | | +| | Unsubscribe_VAL_Service_Area_Change_Event | | | +| | Notify_VAL_Service_Area_Change_Event | | | +| SS_GroupManagement | Query_Group_Info | Request/ Response | VAL server | +| | Update_Group_Info | Request/ Response | VAL server | +| | Create_Group | Request/ Response | VAL server | +| | Delete_Group | Request/Response | VAL server | +| SS_GroupManagementEvent | Subscribe_Group_Info_Modification | Subscribe/Notify | VAL server | +| | Notify_Group_Info_Modification | | VAL server | +| | Notify_Group_Creation | | VAL server | +| SS_UserProfileRetrieval | Obtain_User_Profile | Request/ Response | VAL server | +| SS_VALServiceData | Obtain_VAL_Service_Data | Request/Response | SEAL server | +| SS_UserProfileEvent | Subscribe_User_Profile_Update | Subscribe/Notify | VAL server | +| | Notify_User_Profile_Update | | VAL server | +| SS_NetworkResourceAdaptation | Reserve_Network_Resou | Request/Response | VAL server | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|------------------|------------|--|--| +| (NOTE 3) | rce | | | | | +| | Request_Unicast_Resource | Request/Response | VAL server | | | +| | Update_Unicast_Resource | Request/Response | VAL server | | | +| | Request_Multicast_Resource | Request/Response | VAL server | | | +| | Notify_UP_Delivery_Mode | Subscribe/Notify | VAL server | | | +| | Discover_TSC_Stream_Availability | Request/Response | VAL server | | | +| | Create_TSC_Stream | Request/Response | VAL server | | | +| | Delete_TSC_Stream | Request/Response | VAL server | | | +| | Create_MBS_Resource | Request/Response | VAL server | | | +| | Update_MBS_Resource | Request/Response | VAL server | | | +| | Delete_MBS_Resource | Request/Response | VAL server | | | +| | Activate_MBS_Resource | Request/Response | VAL server | | | +| | Deactivate_MBS_Resource | Request/Response | VAL server | | | +| SS_EventsMonitoring | Subscribe_Monitoring_Events | Subscribe/Notify | VAL server | | | +| | Notify_Monitoring_Events | | | | | +| SS_Events | Subscribe_Event | Subscribe/Notify | VAL server | | | +| | Notify_Event | | VAL server | | | +| | Unsubscribe_Event | | VAL server | | | +| | Update_Subscription | | VAL server | | | +| SS_KeyInfoRetrieval | Obtain_Key_Info | Request/Response | VAL server | | | +| SS_NetworkSliceAdaptation | Request_Network_Slice_Adaptation | Request/Response | VAL server | | | +| SS_NetworkResourceMonitoring | Subscribe_Unicast_QoS_Monitoring_Data | Subscribe/Notify | VAL server | | | +| | Unsubscribe_Unicast_QoS_Monitoring_Data | | VAL server | | | +| | Notify_Unicast_QoS_Monitoring_Data | | VAL server | | | +| | Obtain_Unicast_QoS_Monitoring_Data | Request/Response | VAL server | | | +| | Update_Unicast_QoS_Monitoring_Subscription | | VAL server | | | +| SS_IdmParameterProvisioning | Provide_Configuration | Request/Response | VAL server | | | +| | Get_Configuration | | | | | +| | Update_Configuration | | | | | +| | Delete_Configuration | | | | | +| NOTE 1: The service operations of SS_Events API are reused by the SS_LocationInfoEvent, SS_LocationMonitoring, SS_LocationAreaMonitoring, SS_GroupManagementEvent, SS_UserProfileEvent and SS_EventsMonitoring for events related services. | | | | | | +| NOTE 2: The service APIs exposed by the SEALDD Server and the corresponding service operations, operation semantics and service consumers are specified in clause 5 of 3GPP TS 29.548 [35]. | | | | | | +| NOTE 3: The "Create_MBS_Resource", "Update_MBS_Resource", "Delete_MBS_Resource", "Activate_MBS_Resource" and "Deactivate_MBS_Resource" service operations correspond to the stage 2 "Request_Multicast/Broadcast_Resource", "Update_Multicast/Broadcast_Resource", "Delete_Multicast/Broadcast_Resource", "Activate_Multicast_Resource" and "Deactivate_Multicast_Resource" service operations defined in clause 14.4.2 of 3GPP TS 23.434 [2]. | | | | | | + +Editor's Note: The definition of the update/modify service operations for the VAL service area event subscription are FFS. + +Table 5.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 5.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|--------------|--------|-------------|----------------------------|---------|-------| +|--------------|--------|-------------|----------------------------|---------|-------| + +| | | | | | | +|-----------------------------------------------------------------------------------------------|-----|--------------------------------------------|---------------------------------------------|-----------|------| +| SS_LocationReporting | 7.1 | Report Location Information Service. | TS29549_SS_LocationReporting.yaml | ss-lr | A.2 | +| SS_GroupManagement | 7.2 | Group Management Service | TS29549_SS_GroupManagement.yaml | ss-gm | A.3 | +| SS_UserProfileRetrieval | 7.3 | User Profile Retrieval Service | TS29549_SS_UserProfileRetrieval.yaml | ss-upr | A.4 | +| SS_NetworkResourceAdaptation | 7.4 | Network Resource Adaptation Service | TS29549_SS_NetworkResourceAdaptation.yaml | ss-nra | A.5 | +| SS_Events | 7.5 | Events Notify Service | TS29549_SS_Events.yaml | ss-events | A.6 | +| SS_KeyInfoRetrieval | 7.6 | Key Information Retrieval Service | TS29549_SS_KeyInfoRetrieval.yaml | ss-kir | A.7 | +| SS_LocationAreaInfoRetrieval | 7.1 | Location Area Info Retrieval Service | TS29549_SS_LocationAreaInfoRetrieval.yaml | ss-lair | A.8 | +| SS_NetworkSliceAdaptation | 7.7 | Network Slice Adaptation Service | TS29549_SS_NetworkSliceAdaptation.yaml | ss-nsa | A.9 | +| SS_NetworkResourceMonitoring | 7.4 | Network Resource Monitoring | TS29549_SS_NetworkResourceMonitoring.yaml | ss-nrm | A.10 | +| SS_VALServiceData | 7.3 | VAL Service Data Service | TS29549_SS_VALServiceData.yaml | ss-vsd | A.11 | +| SS_VALServiceAreaConfiguration | 7.1 | VAL Service Area Configuration Service | TS29549_SS_VALServiceAreaConfiguration.yaml | ss-vsac | A.12 | +| SS_IdmParameterProvisioning | 7.8 | VAL Service Parameter Provisioning Service | TS29549_SS_IdmParameterProvisioning.yaml | ss-ipp | A.13 | +| NOTE: The APIs exposed by the SEALDD Server are specified in clause 5 of 3GPP TS 29.548 [35]. | | | | | | + +## 5.2 Location management APIs + +### 5.2.1 SS\_LocationReporting API + +#### 5.2.1.1 Service Description + +##### 5.2.1.1.1 Overview + +The SS\_LocationReporting API, as defined 3GPP TS 23.434 [2], allows VAL server via LM-S reference point to configure reporting trigger of location information to the location management server. + +#### 5.2.1.2 Service Operations + +##### 5.2.1.2.1 Introduction + +The service operation defined for SS\_LocationReporting API is shown in the table 5.2.1.2.1-1. + +**Table 5.2.1.2.1-1: Operations of the SS\_LocationReporting API** + +| Service operation name | Description | Initiated by | +|-----------------------------------|------------------------------------------------------------------------------------------------------|---------------------| +| Create_Trigger_Location_Reporting | This service operation is used by VAL server to create the trigger to report location information. | VAL server | +| Fetch_Location_Report_Trigger | This service operation is used by VAL server to retrieve the location reporting trigger information. | VAL server | +| Update_Trigger_Location_Reporting | This service operation is used by VAL server to update the trigger to report location information. | VAL server | +| Cancel_Trigger_Location_Reporting | This service operation is used by VAL server to cancel the trigger to report location information. | VAL server | +| Notify_Trigger_Location_Reporting | This service operation is used by LM Server to send the notifications to the VAL Server. | LM Server | + +## 5.2.1.2.2 Create\_Trigger\_Location\_Reporting + +### 5.2.1.2.2.1 General + +This service operation is used by a VAL server to create the trigger to report location information. + +### 5.2.1.2.2.2 VAL server providing trigger configuration using Create\_Trigger\_Location\_Reporting service operation + +To create the reporting trigger configuration, the VAL server shall send HTTP POST request message to location management server. The body of the HTTP POST message shall include the LocationReportConfiguration data type, as specified in the clause 7.1.1.2.2.3.1. + +Upon receiving the HTTP POST message as described above, the location management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to provide the trigger; +2. if the VAL server is authorized to provide the triggers, the location management server shall; + - a. create a new resource for Individual SEAL Location Reporting Configuration as specified in clause 7.1.1.2.1; and + - b. return within the response message body the created resource representation within the LocationReportConfiguration data structure, and within an HTTP Location header the created resource URI in the response message. and +3. if errors occur when processing the request, the LM Server shall respond to the VAL Server with an appropriate error response as specified in clause 7.1.1.5. + +## 5.2.1.2.3 Fetch\_Location\_Report\_Trigger + +### 5.2.1.2.3.1 General + +This service operation is used by VAL server to retrieve an individual location reporting configuration information. + +### 5.2.1.2.3.2 VAL server fetching trigger configuration using Fetch\_Location\_Report\_Trigger service operation + +To fetch the location report trigger configuration, the VAL server shall send HTTP GET request message to location management server on the resource URI representing the individual SEAL location reporting configuration, as specified in 7.1.1.2.3.3.1. + +Upon receiving the HTTP GET message as described above, the location management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the trigger information; +2. if the VAL server is authorized to fetch the trigger information, the location management server shall; + +- a. return the location report trigger configuration in LocationReportConfiguration data type, as specified in clause 7.1.1.2.1. + +#### 5.2.1.2.4 Update\_Trigger\_Location\_Reporting + +##### 5.2.1.2.4.1 General + +This service operation is used by a VAL server to update the trigger to report location information. + +##### 5.2.1.2.4.2 VAL server providing trigger configuration using Update\_Trigger\_Location\_Reporting service operation + +To modify the reporting trigger configuration, the VAL server shall send HTTP PUT message to the location management server to the Resource URI identifying the individual SEAL location reporting configuration resource representation, as specified in the clause 7.1.1.2.3.3.2. If the "PatchUpdate" feature defined in clause 7.1.1.6 is supported, the VAL server may send an HTTP PATCH request message to the Individual SEAL Location Reporting Configuration resource URI as specified in clause 7.1.1.2.3.3.4. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.1.1.2.3.3.4. + +When HTTP PUT is used, the "valServerId" attribute within the LocationReportConfiguration data structure shall not be updated. + +Upon receiving the HTTP PUT or PATCH request message, the location management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to modify the configuration information; +2. if the VAL server is authorized to modify the information, then the location management server shall; + - a. if the configuration information in the request is valid, update/modify the resource identified by the Resource URI of the configuration received in the request; + - b. return a 200 OK status code with the updated location reporting configuration information in the response or a 204 No Content status code. + +#### 5.2.1.2.5 Cancel\_Trigger\_Location\_Reporting + +##### 5.2.1.2.5.1 General + +This service operation is used by a VAL server to cancel the trigger to report location information. + +##### 5.2.1.2.5.2 VAL server providing trigger configuration using Cancel\_Trigger\_Location\_Reporting service operation + +To delete the reporting trigger configuration, the VAL server shall send an HTTP DELETE message to the resource representing Individual SEAL Location Reporting Configuration as specified in clause 7.1.1.2.3.3.3. + +Upon receiving the HTTP DELETE message, the location management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to delete the configuration information; and +2. if the VAL server is authorized to delete the configuration information, the location management server shall delete the resource pointed by the Resource URI for Individual SEAL Location Reporting Configuration. + +#### 5.2.1.2.6 Notify\_Trigger\_Location\_Reporting + +##### 5.2.1.2.6.1 General + +This service operation is used by a LM Server to notify of the location trigger event. + +#### 5.2.1.2.6.2 LM Server notifies the VAL Server on the location trigger event using Notify\_Trigger\_Location\_Reporting + +In order to notify the VAL Server about location event, the LM Server shall send an HTTP POST request message to the SEAL Server targeting the notification URI provided during location trigger configuration (see clause 5.2.1.2.2.2) as specified in clause 5.2.7.2.6. + +Upon receiving the HTTP POST request message, the VAL Server shall: + +1. process the location trigger event notification; +2. upon success, respond to the LM Server with a "204 No Content" status code; and +3. if errors occur when processing the request, the VAL Server shall respond to the LM Server with an appropriate error response as specified in clause 7.1.1.5. + +### 5.2.2 SS\_LocationInfoEvent API + +The SS\_LocationInfoEvent API, as defined 3GPP TS 23.434 [2], allows a VAL server via LM-S reference point to subscribe for and receive notifications of location information from the location management server. The SS\_LocationInfoEvent API supports this via the event "LM\_LOCATION\_INFO\_CHANGE" of the SS\_Events API as specified in clause 7.5. If the event subscription includes an indication for supplementary location information, then the location management server obtains the UE location information from the 3GPP core network and/or a 3rd party location management server. + +NOTE: How the location management server obtains the UE location from a 3rd party location management server is out of scope of this specification. + +### 5.2.3 SS\_LocationInfoRetrieval API + +The SS\_LocationInfoRetrieval API, as defined 3GPP TS 23.434 [2], enables the VAL server via LM-S reference point to obtain location information from the location management server. The SS\_LocationInfoRetrieval API supports this via the event "LM\_LOCATION\_INFO\_CHANGE" of the SS\_Events API by setting the "immRep" attribute to true and setting the "notifMethod" attribute to "ONE\_TIME" within the "eventReq" attribute, as specified in clause 7.5. + +Upon receipt of the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true in the HTTP POST request, the location management server shall ignore the "notificationDestination" attribute within the SEALEventSubscription data type and include the event details in the "eventDetails" attribute, if available, in the HTTP POST response. + +### 5.2.4 SS\_LocationAreaInfoRetrieval API + +#### 5.2.4.1 Service Description + +##### 5.2.4.1.1 Overview + +The SS\_LocationAreaInfoRetrieval API, as defined 3GPP TS 23.434 [2], enables the VAL server via LM-S reference point to obtain UE(s) information in an application defined proximity range of a location. + +#### 5.2.4.2 Service Operations + +##### 5.2.4.2.1 Introduction + +The service operation defined for SS\_LocationAreaInfoRetrieval API is shown in the table 5.2.4.2.1-1. + +**Table 5.2.4.2.1-1: Operations of the SS\_LocationAreaInfoRetrieval API** + +| Service operation name | Description | Initiated by | +|------------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------| +| Obtain_UEs_Info | This service operation is used by VAL server to obtain UE(s) information in an application defined proximity range of a location. | VAL server | + +## 5.2.4.2.2 Obtain\_UEs\_Info + +### 5.2.4.2.2.1 General + +This service operation is used by a VAL server to obtain UE(s) information in an application defined proximity range of a location. + +#### 5.2.4.2.2.2 VAL server obtains UE(s) information in an application defined proximity range of a location using Obtain\_UEs\_Info service operation + +To obtain the UE(s) information in an application defined proximity range of a location, the VAL server shall send HTTP GET message to the location management server, on location information collection resource representation URI as specified in the clause 7.1.2.2.2.3.1. The GET message shall include the query parameters: Location information or VAL service area identifier and proximity range. + +Upon receiving the HTTP GET message as described above, the location management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the UE(s) information; +2. if the VAL server is authorized to fetch the UE(s) information, the location management server shall; + - a. determine the VAL UE(s) information that are in the proximity range of the location as per the query parameters in the request message from the VAL server; + - b. return HTTP "200 OK" status code with the determined VAL UE(s) information in the LMInformation data type to the VAL server. + +## 5.2.5 SS\_LocationMonitoring API + +The SS\_LocationMonitoring API, as defined 3GPP TS 23.434 [2], allows a VAL server via the LM-S reference point to monitor the VAL UE(s) in relation to a given area of interest. The VAL server subscribes to the LM server to receive notifications of deviation of VAL UE(s) / User(s) location from a given location information. The SS\_LocationMonitoring API supports this via the event "LM\_LOCATION\_DEVIATION\_MONITOR" of the SS\_Events API as specified in clause 7.5. + +Upon the receipt of "LM\_LOCATION\_DEVIATION\_MONITOR" event subscription request from the VAL server, in order to notify the location deviation events to the VAL server, the location management server shall: + +1. verify the VAL user(s) / VAL UE(s) identifier(s) provided in the "tgtUes" attribute within the MonitorLocationInterestFilter structure as specified in steps 2a and 2b of clause 5.6.1.2.2.2; +2. periodically obtain the VAL UE location information using the SEAL location information procedures as per the SS\_LocationReporting and SS\_LocationAreaInfoRetrieval APIs as specified in clauses 5.2.1 and 5.2.4; +3. using the MonitoringEvent API as specified in 3GPP TS 29.122 [3] and 3GPP TS 29.522 [28], periodically obtain the VAL UE location information from the 3GPP core network using the relevant location related monitoring event(s) and subscribe to the service for area of interest monitoring via the "AREA\_OF\_INTEREST" monitoring event, and may optionally obtain VAL UE location information from the 3rd party location management server; + +NOTE: How the location management server obtains the UE location from a 3rd party location management server is out of scope of this specification. + +4. process the location information received in steps 2 and 3 above and continue as follows: + +- a. if the location information from the location management client, the 3GPP core network and from the 3rd party location management server (if available) do not match, or when the result of the presence status in the area of interest based on the location information collected from the location management client and the result of the presence status in the area of interest reported by the NEF do not match, then notify the VAL server with the "NOTIFY\_MISMATCH\_LOCATION" value in the event report; +- b. if the location information from the location management client, the 3GPP core network and from the 3rd party location management server (if available) match and is not within the area of interest of the VAL server, and such result is also aligned with the NEF reported area of interest monitoring result, then notify the VAL server with the "NOTIFY\_ABSENCE" value in the event report; or +- c. if the location information from the location management client, the 3GPP core network and from the 3rd party location management server (if available) match and is within the area of interest of the VAL server, and such result is also aligned with the NEF reported area of interest monitoring result, then notify to the VAL server with the "NOTIFY\_PRESENCE" value in the event report, based on the notification interval parameter in VAL server's event subscription; + +and + +5. if the SEAL location management server is unable to satisfy the request, the SEAL location management server shall respond to the VAL server with an appropriate error status code as defined in clause 7.5.1.5. + +## 5.2.6 SS\_LocationAreaMonitoring API + +The SS\_LocationAreaMonitoring API, as defined 3GPP TS 23.434 [2], allows a VAL server via the LM-S reference point to subscribe for and receive notifications of list of UE(s) moving in or out of a given area of interest from the location management server. The SS\_LocationAreaMonitoring API supports this via the event "LM\_LOCATION\_AREA\_MONITOR" of the SS\_Events API as specified in clause 7.5. The VAL server may indicate the periodic time interval in which the LM server needs to notify the VAL UE's location information in the Reporting Requirements, during the Subscribe\_Event service operation of SS\_Events API. + +## 5.2.7 SS\_VALServiceAreaConfiguration API + +### 5.2.7.1 Service Description + +#### 5.2.7.1.1 Overview + +The SS\_VALServiceAreaConfiguration API, as defined 3GPP TS 23.434 [2], enables a VAL Server to configure and manage VAL service area(s) via the LM-S reference point. + +### 5.2.7.2 Service Operations + +#### 5.2.7.2.1 Introduction + +The service operations defined for the SS\_VALServiceAreaConfiguration API are shown in the table 5.2.7.2.1-1. + +**Table 5.2.7.2.1-1: Service operations of the SS\_VALServiceAreaConfiguration API** + +| Service operation name | Description | Initiated by | +|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|--------------| +| Configure_VAL_Service_Area | This service operation is used by a VAL Server to configure VAL service area(s). | VAL Server | +| Obtain_VAL_Service_Area | This service operation is used by a VAL Server to obtain VAL service area(s) related information. | VAL Server | +| Update_VAL_Service_Area | This service operation is used by a VAL Server to request the update of VAL service area(s). | VAL Server | +| Delete_VAL_Service_Area | This service operation is used by a VAL Server to request the deletion of VAL service area(s). | VAL Server | +| Subscribe_VAL_Service_Area_Change_Event | This service operation is used by a SEAL Server to subscribe to the VAL service area(s) change event(s) reporting. | SEAL Server | +| Update_Subscription_VAL_Service_Area_Change_Event | This service operation is used by a SEAL Server to update the VAL service area(s) change event(s) subscription. | SEAL Server | +| Unsubscribe_VAL_Service_Area_Change_Event | This service operation is used by a SEAL Server to unsubscribe from the VAL service area(s) change event(s) reporting. | SEAL Server | +| Notify_VAL_Service_Area_Change_Event | This service operation is used by a LM Server to notify for the VAL service area(s) change event(s). | SEAL Server | + +## 5.2.7.2.2 Configure\_VAL\_Service\_Area + +### 5.2.7.2.2.1 General + +This service operation is used by a VAL Server to configure VAL service area(s) with VAL service area ID(s). + +### 5.2.7.2.2.2 VAL Server configures VAL service area(s) using the Configure\_VAL\_Service\_Area service operation + +In order to configure VAL service area(s), the VAL Server shall send an HTTP POST request message (i.e., custom operation "Configure") to the LM Server as specified in clause 7.1.3.2.2.4.2. The request body shall include the ValServiceAreaReq data structure defined in clause 7.1.3.4.2.3. + +Upon reception of the HTTP POST request message, the LM Server shall: + +1. verify the identity of the VAL Server and whether the VAL Server is authorized to configure the VAL service area(s) at the LM Server; +2. if the VAL Server is authorized, the LM Server shall configure the requested VAL service area(s) and respond to the VAL Server with an HTTP "200 OK" status code with the response body including the ValServiceAreaResp data structure defined in clause 7.1.3.4.2.5; and +3. if the LM server is unable to satisfy the request, the LM Server shall respond to the VAL Server with an appropriate error response as specified in clause 7.1.3.5. + +## 5.2.7.2.3 Obtain\_VAL\_Service\_Area + +### 5.2.7.2.3.1 General + +This service operation is used by a VAL Server to obtain the VAL service area(s) based on the corresponding VAL service area ID(s). + +### 5.2.7.2.3.2 VAL Server obtains VAL service area(s) using the Obtain\_VAL\_Service\_Area service operation + +In order to obtain VAL service area(s) and the corresponding information, the VAL Server shall send an HTTP GET request message to the LM Server targeting the URI of the "VAL Service Areas" resource as specified in clause 7.1.3.2.2.3.1. The request URI may include the requested VAL service identifier(s) as defined in clause 7.1.3.2.2.3.1. + +Upon reception of the HTTP GET request message, the LM Server shall: + +1. verify the identity of the VAL Server and whether the VAL Server is authorized to obtain the requested VAL service area(s) information from the LM Server; +2. if the VAL Server is authorized, the LM server shall respond to the VAL Server with an HTTP "200 OK" status code with the response body including the ValServiceAreaData data structure defined in clause 7.1.3.2.2.3.1; and +3. if the LM Server is unable to satisfy the request, the LM Server shall respond to the VAL Server with an appropriate error response as specified in clause 7.1.3.5. + +#### 5.2.7.2.4 Update\_VAL\_Service\_Area + +##### 5.2.7.2.4.1 General + +This service operation is used by a VAL Server to update a VAL service area(s) with the corresponding VAL service area ID(s). + +##### 5.2.7.2.4.2 VAL Server updates VAL service area(s) using the Update\_VAL\_Service\_Area service operation + +In order to update existing VAL service area(s) related information, the VAL Server shall send an HTTP POST request message (i.e., custom operation "Update") to the LM Server as specified in clause 7.1.3.2.2.4.3. The request body shall include the ValServiceAreaReq data structure specified in clause 7.1.3.2.2.4.3. + +Upon reception of the HTTP POST request message, the LM Server shall: + +1. verify the identity of the VAL Server and whether the VAL Server is authorized to update the requested VAL service area(s) related information at the LM Server; +2. if the VAL Server is authorized, the LM server shall check whether the VAL service area(s) exist and then update the VAL service area(s) information of each VAL service area ID(s), and respond to the VAL Server with an HTTP "200 OK" status code with the response body including the ValServiceAreaResp data structure defined in clause 7.1.3.4.2.5; and +3. if the LM Server is unable to satisfy the request, the LM Server shall respond to the VAL Server with an appropriate error response as specified in clause 7.1.3.5. + +#### 5.2.7.2.5 Delete\_VAL\_Service\_Area + +##### 5.2.7.2.5.1 General + +This service operation is used by a VAL Server to delete VAL service area(s) with the given VAL service area ID(s). + +##### 5.2.7.2.5.2 VAL Server deletes service area(s) using the Delete\_VAL\_Service\_Area service operation + +In order to delete existing VAL service area(s) and the related information, the VAL Server shall send an HTTP POST request message (i.e., custom operation "Delete") to the LM Server as specified in clause 7.1.3.2.2.4.4. + +Upon reception of the HTTP POST request message, the LM Server shall: + +1. verify the identity of the VAL Server and whether the VAL Server is authorized to delete the requested VAL service area(s) related information at the LM Server; +2. if the VAL Server is authorized, the LM server shall check whether the target VAL service area(s) exist(s), then delete the corresponding VAL service area(s) information, and respond to the VAL Server with an HTTP "200 OK" status code with the response body including the ValServiceAreaResp data structure defined in clause 7.1.3.4.2.5; and +3. if the LM Server is unable to satisfy the request, the LM Server shall respond to the VAL Server with an appropriate error response as specified in clause 7.1.3.5. + +### 5.2.7.2.6        **Subscribe\_VAL\_Service\_Area\_Change\_Event** + +#### 5.2.7.2.6.1        **General** + +This service operation is used by a SEAL Server to subscribe to the VAL service area(s) change event(s) reporting. + +#### 5.2.7.2.6.2        **SEAL Server subscribes for the VAL service area(s) change event(s) reporting using the Subscribe\_VAL\_Service\_Area\_Change\_Event service operation** + +In order to subscribe to the VAL service area(s) change event(s) reporting, the SEAL Server shall send an HTTP POST request message targeting the URI of the "VAL Service Area Change Subscriptions" resource as specified in clause 7.1.3.2.3.3.1. The request body shall include the ValServiceAreaSubsc data structure defined in clause 7.1.3.4.2.6. + +Upon reception of the HTTP POST request message, the LM Server shall: + +1. verify the identity of the SEAL Server and whether the SEAL Server is authorized to subscribe to the VAL service area(s) change event(s) reporting at the LM Server; +2. if the SEAL Server is authorized, the LM Server shall create a new "Individual VAL Service Area Change Subscription" resource and respond to the VAL server with an HTTP "201 Created" status code, including a Location header field containing the URI for the created "Individual VAL Service Area Change Subscription" resource and the response body including the ValServiceAreaSubsc data structure containing a representation of the created resource as defined in clause 7.1.3.4.2.6; and +3. if errors occur when processing the request, the LM Server shall respond to the SEAL Server with an appropriate error response as specified in clause 7.1.3.5. + +### 5.2.7.2.7        **Update\_Subscription\_VAL\_Service\_Area\_Change\_Event** + +#### 5.2.7.2.7.1        **General** + +This service operation is used by a SEAL Server to update the subscription for the VAL service area(s) change event(s) reporting. + +#### 5.2.7.2.7.2        **SEAL Server updates the subscription for the VAL service area(s) change event(s) reporting using the Update\_Subscription\_VAL\_Service\_Area\_Change\_Event service operation** + +In order to update an existing individual VAL service area change event subscription reporting, the SEAL Server shall send an HTTP PUT request message including the ValServiceAreaSubsc data structure to the LM Server, targeting the corresponding "Individual VAL Service Area Change Subscription" resource URI as specified in clause 7.1.3.2.4.3.2. + +In order to modify an existing individual VAL service area change event subscription reporting, the SEAL Server shall send an HTTP PATCH request message including the ValServiceAreaSubscPatch data structure targeting the "Individual VAL Service Area Change Subscription" resource URI as specified in clause 7.1.3.2.4.3.3. + +Upon receiving the HTTP PUT or HTTP PATCH request message, the LM Server shall: + +1. verify the identity of the SEAL Server and check if the SEAL Server is authorised to update or modify the "Individual VAL Service Area Change Subscription" resource; +2. if the SEAL Server is authorized, then the LM Server shall: + - a. update/modify the resource identified by the Resource URI of the configuration received in the request; and + - b. respond to the SEAL server with an HTTP "200 OK" with the response body containing the updated "Individual VAL Service Area Change Subscription" resource within the ValServiceAreaSubsc data structure or "204 No Content" status code; + +and + +3. if errors occur when processing the request, the LM Server shall respond to the SEAL Server with an appropriate error response as specified in clause 7.1.3.5. + +#### 5.2.7.2.8 Unsubscribe\_VAL\_Service\_Area\_Change\_Event + +##### 5.2.7.2.8.1 General + +This service operation is used by a SEAL Server to unsubscribe from the VAL service area(s) change event(s) reporting. + +##### 5.2.7.2.8.2 SEAL server unsubscribes from the VAL service area(s) change event(s) using Unsubscribe\_VAL\_Service\_Area\_Change\_Event + +In order to terminate an individual VAL service area change event subscription reporting, the SEAL server shall send an HTTP DELETE request message to the LM Server, on the corresponding "Individual VAL Service Area Change Subscription" resource URI as specified in clause 7.1.3.2.4.3.4. + +Upon reception of the HTTP DELETE request message, the LM server shall: + +1. verify the identity of the SEAL Server and check if the SEAL Server is authorised to terminate the targeted "Individual VAL Service Area Change Subscription" associated with the resource URI; +2. if the SEAL Server is authorized to unsubscribe from VAL service area(s) change event(s), the LM Server shall delete the related "Individual VAL Service Area Change Subscription" subscription resource at the LM Server; +3. upon success, respond to the SEAL server with a "204 No Content" status code; and +4. if errors occur when processing the request, the LM Server shall respond to the SEAL Server with an appropriate error response as specified in clause 7.1.3.5. + +#### 5.2.7.2.9 Notify\_VAL\_Service\_Area\_Change\_Event + +##### 5.2.7.2.9.1 General + +This service operation is used by a LM Server to notify for the VAL service area(s) change event(s). + +##### 5.2.7.2.9.2 LM server notifies the SEAL Server on VAL service area(s) change event(s) using Notify\_VAL\_Service\_Area\_Change\_Event + +In order to notify the SEAL server about VAL service area(s) change event(s), the LM Server shall send an HTTP POST request message to the SEAL Server targeting the notification URI provided during subscription creation as specified in clause 5.2.7.2.6. + +Upon receiving the HTTP POST request message, the SEAL Server shall: + +1. process the VAL service area change event(s) notification; and +2. upon success, respond to the LM Server with a "204 No Content" status code; and +3. if errors occur when processing the request, the SEAL Server shall respond to the LM Server with an appropriate error response as specified in clause 7.1.3.5. + +## 5.3 Group management APIs + +### 5.3.1 SS\_GroupManagement API + +#### 5.3.1.1 Service Description + +##### 5.3.1.1.1 Overview + +The SS\_GroupManagement API, as defined 3GPP TS 23.434 [2], allows VAL server via GM-S reference point to create, fetch, update and delete VAL group membership and configuration information. + +#### 5.3.1.2 Service Operations + +##### 5.3.1.2.1 Introduction + +The service operation defined for SS\_GroupManagement API is shown in the table 5.3.1.2.1-1. + +**Table 5.3.1.2.1-1: Operations of the SS\_GroupManagement API** + +| Service operation name | Description | Initiated by | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Query_Group_Info | This service operation is used by VAL server to query for VAL group documents, group membership list and configuration information. | VAL Server | +| Update_Group_Info | This service operation is used by VAL server to modify group membership and configuration information. | VAL server | +| Create_Group | This service operation is used by VAL server to configure new VAL group. | VAL server | +| Delete_Group | This service operation is used by the VAL server to delete the VAL group. | VAL server | + +#### 5.3.1.2.2 Query\_Group\_Info + +##### 5.3.1.2.2.1 General + +This service operation is used by a VAL server to obtain VAL group documents, group membership and configuration information. + +##### 5.3.1.2.2.2 VAL server fetching VAL group documents, group membership and configuration information using Query\_Group\_Info service operation + +To obtain membership, configuration information of a VAL group, the VAL server shall send a HTTP GET message to the group management server, on VAL group document's resource representation URI as specified in clause 7.2.1.2.3.3.1. The GET message may include the following query parameters: membership list, group configuration. To obtain VAL groups information, the VAL server shall send a HTTP GET message to the group management server, on VAL group documents collection resource representation URI as specified in clause 7.2.1.2.2.3.2. The GET message may include the following query parameters: VAL Group ID, VAL Service ID. + +Upon receiving the HTTP GET message as described above, the group management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the VAL group information; + +2. if the VAL server is authorized to obtain the group information, the group management server shall; + - a. if the request to VAL group document's resource representation URI includes query parameters, then, return in the response message with VAL group information which includes, group membership list information if the request includes membership list query, group configuration information if the request includes group configuration query and VAL group identifier; + - b. if the request to VAL group document's resource representation URI does not include query parameter, then, return the VAL group document resource in the response message; + - c. in the request to VAL group documents collection resource representation URI, return the VAL group documents matching the query parameters in the response message; +- and +3. if the group management server is unable to satisfy the request, the group management server shall respond to the VAL server with an appropriate error status code as specified in clause 7.2.1.5. + +#### 5.3.1.2.3 Update\_Group\_Info + +##### 5.3.1.2.3.1 General + +This service operation is used by a VAL server to modify group membership and configuration information. + +##### 5.3.1.2.3.2 VAL server modifying group membership and configuration using Update\_Group\_Info service operation + +To modify group information of a VAL group, the VAL server shall send HTTP PUT message to the group management server to the Resource URI identifying the VAL group document resource representation, as specified in the clause 7.2.1.2.3.3.2. This request shall not replace valGroupId property in the existing resource. If the "PatchUpdate" feature defined in clause 7.2.1.6 is supported, then the VAL server may send an HTTP PATCH request message to the Individual VAL Group Document resource URI as specified in clause 7.2.1.2.3.3.4, to partially update the VAL group document. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.2.1.2.3.3.4. Upon receiving the HTTP PUT message, the group management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to modify VAL group information; + 2. for the HTTP PUT request message, verify that valGroupId in the request is same as valGroupId of the VAL group document resource; + 3. if the VAL server is authorized to modify/update the group information and the valGroupId matches, then the group management server shall; + - a. if the group configuration information in the request is valid, update/modify the resource identified by the Resource URI of the group document with group members list, group configuration information, description, VAL service identifiers, external group identifier and location information received in the request; + - b. if the group document information in the request includes 5G LAN-Type communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP PUT/PATCH message as defined in clause 4.4.15.3 of 3GPP TS 29.522 [28]; + - c. return a 200 OK status code with the updated VAL group document in the response or a 204 No Content status code; +- and +4. if the group management server is unable to satisfy the request, the group management server shall respond to the VAL server with an appropriate error status code as specified in clause 7.2.1.5. + +NOTE: The group management server maintains a mapping between DNN and S-NSSAI of the 5GVN group and the VAL server requester identity based on operator policy. How such mapping is configured is implementation specific and out of the scope of this specification. + +#### 5.3.1.2.4 Create\_Group + +##### 5.3.1.2.4.1 General + +This service operation is used by a VAL server to create VAL group. + +##### 5.3.1.2.4.2 VAL server creating new group using Create\_Group service operation + +To create a VAL group, the VAL server shall send a HTTP POST message to the group management server. The body of the POST message shall include VAL group document information as specified in clause 7.2.1.2.2.3.1. The VAL server shall use this service operation to create the location-based VAL group as specified for Create\_LocationBasedGroup\_Info service operation of SS\_GroupManagement API, in 3GPP TS 23.434 [2]. + +Upon receiving HTTP POST message, the group management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to create VAL group document; +2. if the VAL group document information in the request includes location criteria, then shall obtain the list of VAL users or VAL UEs within the requested location criteria information from the Location Management server and include them in VAL group members of the new VAL group; + - a. if the "valServiceIds" attribute within VALGroupDocument structure was present in the received VAL group document information and the received response from the location management server does not include the identical list of the VAL service IDs as defined in the "valServiceIds" attribute within VALGroupDocument structure, the group management server shall retrieve the VAL service data from the configuration management server for the missed VAL service IDs and include the relevant VAL users or VAL UEs in the VAL group members of the new VAL group; +3. if the VAL group document information in the request includes 5G LAN-Type communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP POST message as defined in clause 4.4.15.2 of 3GPP TS 29.522 [28]; +4. if the VAL server is authorized to create VAL group document, shall create a new resource as defined in 7.2.1.2.2.3.1 and return the VAL group document and its Resource URI in the response message; and +5. if the group management server is unable to satisfy the request, the group management server shall respond to the VAL server with an appropriate error status code as defined in clause 7.2.1.5. + +NOTE: The group management server maintains a mapping between DNN and S-NSSAI of the 5GVN group and the VAL server requester identity based on operator policy. How such mapping is configured is implementation specific and out of the scope of this specification. + +#### 5.3.1.2.5 Delete\_Group + +##### 5.3.1.2.5.1 General + +This service operation is used by a VAL server to delete a VAL group. + +##### 5.3.1.2.5.2 VAL server deleting VAL group using Delete\_Group service operation + +To delete a VAL group, the VAL server shall send a HTTP DELETE message to the Group Management server to its resource representation in the Group Management server as specified in clause 7.2.1.2.3.3.3. Upon receiving HTTP DELETE message, the Group Management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to delete the VAL group document; +2. if the VAL server is authorized to delete the VAL group document, the Group Management server shall: + +- a. if the group communication type is 5GLAN communication, invoke the 5GLANParameterProvision API towards the NEF via an HTTP DELETE message as defined in clause 4.4.15.4 of 3GPP TS 29.522 [28]; + - b. delete the resource representation pointed by the group document resource identifier; +- and +3. if the group management server is unable to satisfy the request, the group management server shall respond to the VAL server with an appropriate error status code as specified in clause 7.2.1.5. + +### 5.3.2 SS\_GroupManagementEvent API + +The SS\_GroupManagementEvent API, as defined 3GPP TS 23.434 [2], allows a VAL server via GM-S reference point to subscribe for and receive notifications from Group Management server on new VAL group creations, on modifications to VAL Group membership and configuration information and on temporary VAL group formation. The SS\_GroupManagementEvent API supports this via the "GM\_GROUP\_CREATE", "GM\_GROUP\_INFO\_CHANGE" and "GM\_TEMP\_GROUP\_FORMATION" events of the SS\_Events API as specified in clause 7.5. In order to authorize the VAL servers that have to be notified of a "GM\_GROUP\_CREATE" event, the Group Management server shall identify the VAL services (VAL Service IDs) allowed for the VAL server by the "subscriberId" attribute and shall notify the VAL server if the VAL services enabled for the created VAL group are allowed for the VAL server. + +Upon the receipt of the VAL group document from the group management server during Create\_Group service operation, if the VAL server is interested in receiving the notifications about newly registered or de-registered VAL UE IDs to the VAL group, then the VAL server may subscribe to "GM\_GROUP\_INFO\_CHANGE" event using the SS\_Events API as specified in clause 7.5.1, to receive any VAL group membership update notifications. + +Upon the receipt of the message filters information in the "GM\_GROUP\_INFO\_CHANGE" event notification from the group management server, the VAL server shall consider the message filters in VAL specific communication. + +## 5.4 Configuration management APIs + +### 5.4.1 SS\_UserProfileRetrieval API + +#### 5.4.1.1 Service Description + +##### 5.4.1.1.1 Overview + +The SS\_UserProfileRetrieval API, as defined in 3GPP TS 23.434 [2], allows VAL server via CM-S reference point to obtain user profile from the configuration management server. + +#### 5.4.1.2 Service Operations + +##### 5.4.1.2.1 Introduction + +The service operation defined for SS\_UserProfileRetrieval API is shown in the table 5.4.1.2.1-1. + +**Table 5.4.1.2.1-1: Operations of the SS\_UserProfileRetrieval API** + +| Service operation name | Description | Initiated by | +|------------------------|----------------------------------------------------------------------|--------------| +| Obtain_User_Profile | This service operation is used by VAL server to obtain user profile. | VAL server | + +##### 5.4.1.2.2 Obtain\_User\_Profile + +###### 5.4.1.2.2.1 General + +This service operation is used by a VAL server to obtain VAL user profile information. + +#### 5.4.1.2.2.2 VAL server retrieving VAL user profile information using Obtain\_User\_Profile service operation + +To obtain a VAL user's profile, the VAL server shall send HTTP GET request message to configuration management server, on VAL service's resource representation URI, with query parameters VAL user ID or VAL UE ID and optionally VAL service ID, as specified in 7.3.1.2.2.3.1. + +Upon receiving the HTTP GET message as described above, the configuration management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to fetch the VAL user profile information; +2. if the VAL server is authorized to obtain the requested VAL user profile information, the configuration management server shall; + - a. return in the response message with profile information corresponding to the query parameters that was sent in the request message. + +### 5.4.2 SS\_UserProfileEvent API + +The SS\_UserProfileEvent API, as defined in 3GPP TS 23.434 [2], allows a VAL server via CM-S reference point to subscribe for and receive notifications from the Configuration Management server on profile updates to VAL User or VAL UE. The SS\_UserProfileEvent API supports this via the "CM\_USER\_PROFILE\_CHANGE" event in SS\_Events API as specified in clause 7.5. + +### 5.4.3 SS\_VALServiceData API + +#### 5.4.3.1 Service Description + +##### 5.4.3.1.1 Overview + +The SS\_VALServiceData API, as defined in 3GPP TS 23.434 [2], allows SEAL Server (e.g., GM Server via SEAL-X3 reference point) to obtain the VAL service data from the CM Server. + +#### 5.4.3.2 Service Operations + +##### 5.4.3.2.1 Introduction + +The service operation defined for SS\_VALServiceData API is shown in the table 5.4.3.2.1-1. + +**Table 5.4.3.2.1-1: Operations of the SS\_VALServiceData API** + +| Service operation name | Description | Initiated by | +|-------------------------|---------------------------------------------------------------------------|--------------| +| Obtain_VAL_Service_Data | This service operation is used by SEAL server to obtain VAL service data. | SEAL server | + +##### 5.4.3.2.2 Obtain\_VAL\_Service\_Data + +###### 5.4.3.2.2.1 General + +This service operation is used by a SEAL Server to obtain VAL service data. + +###### 5.4.3.2.2.2 SEAL server retrieving VAL service data using Obtain\_VAL\_Service\_Data service operation + +To obtain a VAL service data, the SEAL server shall send HTTP GET request message to CM Server, on the VAL Service Data Sets resource representation URI, with query parameters defined in clause 7.3.2.2.2.3.1. + +Upon receiving the HTTP GET message as described above, the CM Server shall: + +1. verify the identity of the SEAL Server and check if the SEAL Server is authorized to obtain the VAL service data; +2. if the SEAL server is authorized to obtain the requested VAL service data, the CM Server shall return in the response message the VAL service data corresponding to the query parameters that were received in the request message. If the request message includes both the "val-tgt-ues" and "val-service-ids" query parameters, the response message shall include the VAL service data resource(s) for only the VAL service(s) (the identifiers of which are provided within the "val-service-ids" query parameter) that are common to the VAL user(s)/VAL UE(s) provided in the "val-tgt-ues" query parameter; + +and + +3. if the CM server is unable to satisfy the request, the CM server server shall respond to the SEAL server with an appropriate error status code. + +## 5.5 Network resource management APIs + +### 5.5.1 SS\_NetworkResourceAdaptation API + +#### 5.5.1.1 Service Description + +##### 5.5.1.1.1 Overview + +The SS\_NetworkResourceAdaptation API, as defined 3GPP TS 23.434 [2], allows VAL server via NRM-S reference point to communicate with the network resource management server for network resource adaptation including reserving network resource, requesting and subscribing for unicast and multicast/broadcast resources. + +#### 5.5.1.2 Service Operations + +##### 5.5.1.2.1 Introduction + +The service operation defined for SS\_NetworkResourceAdaptation API is shown in the table 5.5.1.2.1-1. + +**Table 5.5.1.2.1-1: Operations of the SS\_NetworkResourceAdaptation API** + +| Service operation name | Description | Initiated by | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Reserve_Network_Resource | Requesting for network resource adaptation | VAL server | +| Request_Unicast_Resource | Requesting unicast resource | VAL server | +| Update_Unicast_Resource | Updating unicast resource | VAL server | +| Request_Multicast_Resource | Requesting multicast resource | VAL server | +| Notify_UP_Delivery_Mode | Notifying the user plane delivery mode | NRM server | +| Discover_TSC_Stream_Availability | Requesting the NRM server to discover the connectivity and available QoS characteristics between the source and the destination DS-TT ports. | VAL server | +| Create_TSC_Stream | Requesting the NRM server to create a TSC stream. | VAL server | +| Delete_TSC_Stream | Requesting the NRM server to delete a TSC stream. | VAL server | +| Create_MBS_Resource | Request the creation of a new MBS Resource. | VAL server | +| Update_MBS_Resource | Request the update of an existing "Individual MBS Resource" resource. | VAL server | +| Delete_MBS_Resource | Request the deletion of an existing "Individual MBS Resource" resource. | VAL server | +| Activate_MBS_Resource | Request the activation of an existing MBS Resource. | VAL server | +| Deactivate_MBS_Resource | Request the deactivation of an existing MBS Resource. | VAL server | +| BDT_Configuration_Request | Request the configuration of BDT policy. | VAL server | +| BDT_Negotiation_Notification | Notify about update in the negotiated BDT policy. | VAL server | + +### 5.5.1.2.2 Reserve\_Network\_Resource + +#### 5.5.1.2.2.1 General + +This service operation is used by a VAL server to request for network resource adaptation. + +#### 5.5.1.2.2.2 VAL server requesting for network resource adaptation using Reserve\_Network\_Resource service operation + +The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL UE(s) or VAL group information and the VAL service QoS requirement. Upon receiving HTTP POST message, the NRM server shall + +1. verify the identity of the VAL server and check if the VAL server is authorized to request for network resource adaptation; +2. if the VAL server is authorized, the NRM server shall determine the QoS requirements for each VAL UE based on the VAL UE(s) or VAL group information; +3. for each VAL UE, the NRM server initiates the PCC procedures; and +4. the NRM server provides result and optionally includes the accepted value for the QoS requirements based on the outcome of the PCC procedure in the response message + +### 5.5.1.2.3 Request\_Unicast\_Resource + +#### 5.5.1.2.3.1 General + +This service operation is used by a VAL server to request for unicast resource. + +#### 5.5.1.2.3.2 VAL server requesting for unicast resource using Request\_Unicast\_Resource service operation + +The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL user or UE information and the VAL service requirement. Upon receiving HTTP POST message, the NRM server shall + +1. verify the identity of the VAL server and check if the VAL server is authorized to request for unicast resource; +2. if the VAL server is authorized, the NRM server evaluates the need for network resources and use of resource sharing; +3. for the VAL user or UE, the NRM server initiates interaction via SIP core; +4. the NRM server creates a unicast subscription as specified in clause 7.4.1.2.4.3.1; and +5. the NRM server provides result in the response message. + +### 5.5.1.2.4 Update\_Unicast\_Resource + +#### 5.5.1.2.4.1 General + +This service operation is used by a VAL server to request for updating the unicast resource used by the VAL user or UE. + +#### 5.5.1.2.4.2 VAL server requesting for updating the unicast resource using Update\_Unicast\_Resource service operation + +The VAL server shall send a HTTP PUT message to the NRM server. The body of the PUT message shall include VAL user or UE information and the VAL service requirement. Upon receiving HTTP PUT message, the NRM server shall + +1. verify the identity of the VAL server and check if the VAL server is authorized to request for updating the unicast resource; +2. if the VAL server is authorized, the NRM server decides the need to update the unicast resource. If NRM server decides that no update is required for the unicast resource, then the NRM server sends a failure indication in the response message; +3. if NRM server decides to update the unicast resource, then the NRM server initiates interaction via SIP core; and +4. the NRM server provides result in the response message. + +### 5.5.1.2.5 Request\_Multicast\_Resource + +#### 5.5.1.2.5.1 General + +This service operation is used by a VAL server to request for multicast resource. + +#### 5.5.1.2.5.2 VAL server requesting for multicast resource using Request\_Multicast\_Resource service operation + +The VAL server shall send a HTTP POST message to the NRM server. The body of the POST message shall include VAL group information, service announcement mode, QoS information, Broadcast area, the local MBMS information or the local MBMS activation indication and VAL server notification endpoint address information. Upon receiving HTTP POST message, the NRM server shall + +1. verify the identity of the VAL server and check if the VAL server is authorized to request for multicast resource; +2. if the VAL server is authorized, the NRM server decides to establish an MBMS bearer in EPS using the procedures defined in 3GPP TS 29.468 [23]; +3. the NRM server creates a multicast subscription as specified in clause 7.4.1.2.2.3.1; +4. the NRM server provides the result in the response message. + +#### 5.5.1.2.6 Notify\_UP\_Delivery\_Mode + +##### 5.5.1.2.6.1 General + +This service operation is used by the NRM server to send user plane notifications to the VAL server. + +##### 5.5.1.2.6.2 Notifying user plane events using Notify\_UP\_Delivery\_Mode service operation + +To notify the user plane events, the NRM server shall send an HTTP POST message using the Notification Destination URI received in the multicast resource request defined in clause 5.5.1.2.5, or the MBS Resource creation/update request defined in clauses 5.5.1.2.10 and 5.5.1.2.11. The body of the HTTP POST message shall include an UserPlaneNotification as specified in clause 7.4.1.3.2. + +Upon receiving the HTTP POST message, the VAL server shall process the Event Notification. + +#### 5.5.1.2.7 Create\_TSC\_Stream + +##### 5.5.1.2.7.1 General + +This service operation is used by a VAL server to request the NRM server to create TSC stream resources. + +##### 5.5.1.2.7.2 VAL server requesting for create TSC stream using Create\_TSC\_Stream service operation + +In order to create a TSC stream resource, the VAL server shall send an HTTP PUT message to the NRM server with {valStreamId} in the request URI path to identify the TSC stream to be created. The request body with the "TscStreamData" data structure shall include stream specification and Traffic Specification Information which includes MaxFrameInterval, MaxFrameSize, MaxIntervalFrames, MaxLatency. + +Upon reception of the HTTP PUT message, the NRM server shall: + +1. verify the requestor identity of the VAL server, check whether the VAL server is authorized to request the NRM server to create a TSC stream with the VAL Stream ID as the TSC stream resource identifier; + +NOTE: It's up to the VAL server to secure the uniqueness of the VAL Stream ID. + +2. if the VAL server is authorized, the NRM server shall calculate the schedule for the VAL Stream ID based on the information collected earlier from the 5GS. It provides per-stream filtering and policy parameters (e.g as defined in IEEE 802.1Qcc [29]) used to derive the TSC QoS information and related flow information. The NRM server also provides the forwarding rule (e.g.as defined in IEEE 802.1Qcc [29]) used to identify the DS-TT MAC address of the corresponding PDU session. Based on the 5GS bridge delay information it determines the TSC QoS information and TSC Assistance information for the stream; +3. determine whether time synchronization needs to be activated for the TSC stream on the DS-TTs. If the DS-TTs are time synchronized, then the NRM shall not activate the time synchronization for the corresponding DS-TTs; +4. for each VAL UE, the trusted NRM server within the PLMN operator domain acting as a TSCTSF shall initiate the PCC procedures by triggering the Npcf\_policy\_Authorization\_Create service operation as described in 3GPP TS 29.514 [30] for the TSC stream for both uplink QoS flow (sender UE to UPF/bridge) and downlink QoS flow (UPF/bridge to receiver UE). The creation request includes the DS-TT port MAC address, TSC QoS information, TSC Assistance Information, flow bit rate, priority, Service Data Flow Filter containing flow description including Ethernet Packet Filters. The QoS flow will be assigned for the PDU session with the source + +MAC address for the uplink direction and with the destination MAC address for the downlink direction. This information is delivered to the DS-TT by the 5GS; + +5. if the time synchronization for the TSC stream on the DS-TTs was determined as required in step 3, the NRM server shall use the procedures described in 3GPP TS 29.514 [30] to activate the time synchronization for the corresponding DS-TTs; and +6. after the NRM server receiving a successful response from the PCF, the NRM server shall create an "Individual TSC Stream" resource which represents the created TSC stream, addressed by a URI that contains the {valStreamId} as the VAL Stream ID identifier the TSC Stream, and shall respond to the VAL server with a 201 Created status code, including a Location header field containing the URI for the created resource. If the NRM server receives an error response from the PCF, the NRM server shall not create the resource and shall respond to the VAL server with a proper error status code. + +#### 5.5.1.2.8 Delete\_TSC\_Stream + +##### 5.5.1.2.8.1 General + +This service operation is used by a VAL server to delete a TSC stream. + +##### 5.5.1.2.8.2 VAL server requesting to delete a TSC stream using Delete\_TSC\_Stream service operation + +In order to delete a TSC stream, the VAL server shall send an HTTP DELETE message to the NRM server, with "{apiRoot}/ss-nra/{apiVersion}/tsc-streams/{valStreamId}" as the Resource URI representing the TSC stream identified by the VAL sStream ID to be deleted. + +Upon reception of the HTTP DELETE message, the NRM server shall: + +1. identify the MAC addresses of the DS-TTs involved in the stream based on the stored information for the VAL Stream ID; +2. determine the actions related to the time synchronization deactivation for the DS-TTs: + - if none of the streams require to keep the time synchronization activated, deactivate the time synchronization for the involved DS-TTs in step 3; and + - otherwise, keep the time synchronization activated for the involved DS-TTs for which time synchronization was previously activated; +3. for each VAL UE, as the trusted NRM server within the PLMN operator domain acting as a TSCTSF shall: + - deactivate the time synchronization for the DS-TTs as per step 2 above by invoking the Npcf\_PolicyAuthorization\_Update service operation as defined in 3GPP TS 29.514 [30]; and + - initiate the PCC procedures by triggering the Npcf\_policy\_Authorization\_Delete service operation to delete the QoS flows as defined in 3GPP TS 29.514 [30] with all the MAC addresses referred by the VAL Stream ID; and +4. if the NRM server receive a successful response from the PCF, the NRM server shall delete the existing TSC stream in the "Individual TSC Stream" resource. Then the NRM server shall send an HTTP DELETE response message with "204 No Content" status code to the VAL server as a successful result of TSC stream deletion for the VAL Stream ID. If the NRM server receive an error code from the PCF, the NRM server shall take proper error handling action and shall respond to the VAL server with a proper error status code as unsuccessful result. + +#### 5.5.1.2.9 Discover\_TSC\_Stream\_Availability + +##### 5.5.1.2.9.1 General + +This service operation is used by a VAL server to request the NRM server to retrieve the connectivity information between the source and destination DS-TT ports and the related available QoS characteristics, prior to creating the stream. + +#### 5.5.1.2.9.2 VAL server discovering TSC stream availability using Discover\_TSC\_Stream\_Availability service operation + +In order to discover the connectivity between the source and destination DS-TT ports and the related available QoS characteristics, the VAL server shall send an HTTP GET request message to the NRM server, with the query parameters containing the targeted stream specifications. + +Upon reception of the HTTP GET request message, the NRM server shall: + +1. verify if the VAL server is authorized to discover the TSC stream availability; +2. if the VAL server is authorized, the NRM server shall check the connectivity between the DS-TTs ports indicated in the requested TSC stream definition based on the collected 5GS TSC bridge management and port management information, the traffic classes supported by the DS-TTs and the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) per traffic class; + +The necessary information to process the TSC stream availability discovery request, i.e. 5GS TSC bridge management and port management information, the traffic classes supported by the DS-TTs and the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) per traffic class, is collected by the NRM server and shall be available at the NRM server prior to the reception of the request from the VAL server. +3. if the discovery result is successful upon the connectivity between the DS-TT ports is discovered, the NRM server shall return an HTTP GET response message to the VAL server with an HTTP "200 OK" status code with the TscStreamAvailability data structure as the response body which shall include the stream specification matching the received query parameters and the corresponding list of traffic specifications; +4. if there is no stream specification matching the query parameters or no TSC stream availability information was discovered between the DS-TT ports, then the NRM server shall respond with a 204 No Content status code without response body; +5. Otherwise if error case occur (e.g. the necessary information to process the request is not available at the NRM server), the NRM server shall respond to the VAL server with a proper error status code. + +#### 5.5.1.2.10 Create\_MBS\_Resource + +##### 5.5.1.2.10.1 General + +This service operation is used by a VAL Server to request the creation of a new MBS Resource at the NRM Server (see also clause 14.3.4A of 3GPP TS 23.434[2]). + +##### 5.5.1.2.10.2 VAL Server requesting the creation of an MBS Resource using the Create\_MBS\_Resource service operation + +In order to request the creation of a new MBS Resource, the VAL Server shall send an HTTP POST request message to the NRM server targeting the "MBS Resources" collection resource, with the request body containing the MBSResourceReq data structure. + +Upon reception of the HTTP POST request message, the NRM Server shall: + +- verify the identity of the VAL Server and whether the VAL server is authorized to initiate such request; +- if the VAL Server is authorized and upon successful processing of the request, the NRM Server shall create a new "Individual MBS Resource" resource and respond to the VAL Server with an HTTP "201 Created" status code with the response body containing a representation of the created resource and potentially additional information (e.g. the user plane addressing information of the NRM Server for downlink data delivery) within the MBSResourceResp data structure; and +- if errors occur when processing the request, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +### 5.5.1.2.11 Update\_MBS\_Resource + +#### 5.5.1.2.11.1 General + +This service operation is used by a VAL Server to request the update of an existing MBS Resource at the NRM Server (see also clause 14.3.4A of 3GPP TS 23.434°[2]). + +#### 5.5.1.2.11.2 VAL Server requesting the update of an existing MBS Resource using the Update\_MBS\_Resource service operation + +In order to request the modification of an existing MBS Resource, the VAL Server shall send an HTTP PATCH request message to the NRM server targeting the corresponding "Individual MBS Resource" resource, with the request body containing the MBSResourcePatch data structure. + +Upon reception of the HTTP PATCH request message, the NRM Server shall: + +- verify whether the VAL server is authorized to initiate such request; +- if the VAL Server is authorized and upon successful processing of the request, the NRM Server shall modify the targeted "Individual MBS Resource" resource and respond to the VAL Server with either: + - an HTTP "200 OK" status code with the response body containing a representation of the updated resource and potentially additional information (e.g. the updated user plane addressing information of the NRM Server for downlink data delivery) within the MBSResourceResp data structure; or + - an HTTP "204 No Content" status code; + +and + +- if errors occur when processing the request, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +### 5.5.1.2.12 Delete\_MBS\_Resource + +#### 5.5.1.2.12.1 General + +This service operation is used by a VAL Server to request the deletion of an existing MBS Resource at the NRM Server (see also clause 14.3.4A of 3GPP TS 23.434°[2]). + +#### 5.5.1.2.12.2 VAL Server requesting the deletion of an existing MBS Resource using the Delete\_MBS\_Resource service operation + +In order to request the deletion of an existing MBS Resource, the VAL Server shall send an HTTP DELETE request message to the NRM server targeting the corresponding "Individual MBS Resource" resource. + +Upon reception of the HTTP DELETE request message, the NRM Server shall: + +- verify whether the VAL server is authorized to initiate such request; +- if the VAL Server is authorized and upon successful processing of the request, the NRM Server shall delete the targeted "Individual MBS Resource" resource and respond to the VAL Server with an HTTP "204 No Content" status code; and +- if errors occur when processing the request, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +### 5.5.1.2.13 Activate\_MBS\_Resource + +#### 5.5.1.2.13.1 General + +This service operation is used by a VAL Server to request the activation of an existing MBS Resource at the NRM Server (see also clause 14.3.4A of 3GPP TS 23.434°[2]). + +#### 5.5.1.2.13.2 VAL Server requesting the activation of an existing MBS Resource using the Activate\_MBS\_Resource service operation + +In order to request the activation of an existing MBS Resource, the VAL Server shall invoke the "Activate" resource custom operation by sending an HTTP POST request message to the NRM server targeting the URI of the corresponding "Individual MBS Resource" resource custom operation, i.e. "{apiRoot}/ss-nra//mbs-resources/{mbsResId}/activate", with the request body including the MbsResAct data structure. + +Upon reception of the HTTP POST request message, the NRM Server shall: + +- verify whether the VAL server is authorized to initiate such request; +- if the VAL Server is authorized and upon successful processing of the request, the NRM Server shall respond to the VAL Server with an HTTP "200 OK" status code with the response body including the the MbsResAct data structure; and +- if errors occur when processing the request, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +#### 5.5.1.2.14 Deactivate\_MBS\_Resource + +##### 5.5.1.2.14.1 General + +This service operation is used by a VAL Server to request the deactivation of an existing MBS Resource at the NRM Server (see also clause 14.3.4A of 3GPP TS 23.434[2]). + +##### 5.5.1.2.14.2 VAL Server requesting the deactivation of an existing MBS Resource using the Deactivate\_MBS\_Resource service operation + +In order to request the deactivation of an existing MBS Resource, the VAL Server shall invoke the "Deactivate" resource custom operation by sending an HTTP POST request message to the NRM server targeting the URI of the corresponding "Individual MBS Resource" resource custom operation, i.e. "{apiRoot}/ss-nra//mbs-resources/{mbsResId}/deactivate", with the request body including the MbsResDeact data structure. + +Upon reception of the HTTP POST request message, the NRM Server shall: + +- verify whether the VAL server is authorized to initiate such request; +- if the VAL Server is authorized and upon successful processing of the request, the NRM Server shall respond to the VAL Server with an HTTP "200 OK" status code with the response body including the the MbsResDeact data structure; and +- if errors occur when processing the request, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +#### 5.5.1.2.15 BDT\_Configuration\_Request + +##### 5.5.1.2.15.1 General + +This service operation is used by a VAL Server to request the background data transfer policy at the NRM Server. + +##### 5.5.1.2.15.2 VAL Server requesting the background data transfer policy using the BDT\_Configuration\_Request service operation + +In order to create resource for the background data transfer policy, the VAL Server shall invoke HTTP POST message to the NRM server to negotiate the transfer policy targeting the URI of the corresponding "BDT Policy Configurations" resource, i.e. "{apiRoot}/ss-nra//bdtpolicy-configs/", with the request body including the "BdtPolConfig" data structure. + +Upon reception of the HTTP POST request message, the NRM Server shall: + +- verify whether the VAL server is authorized to initiate such request; + +- If the VAL server is authorized, when the NRM server decides to negotiate BDT policy with the 3GPP network, it triggers background data transfer procedure defined in the clause 4.16.7.2 of 3GPP TS 23.502 [39]; +- upon success, the NRM Server responds to the VAL Server with an HTTP "201 Created" status code with the response body including the BdtPolConfig data structure; and +- if errors occur when processing the request or the NRM Server receives an error response from 5GC, the NRM Server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the VAL Server with an appropriate error status code. + +#### 5.5.1.2.16 BDT\_Negotiation\_Notification + +##### 5.5.1.2.16.1 General + +This service operation is used by the NRM Server to notify about update in the negotiated background data transfer policy. + +##### 5.5.1.2.16.2 NRM Server notifying the background data transfer policy using the BDT\_Negotiation\_Notification service operation + +To notify the update in the negotiated BDT policies received from the 3GPP network, the NRM server shall send an HTTP POST request message using the Notification URI received during the creation of the corresponding BDT policy configuration as defined in clause 5.5.1.2.15, and the request body including the BdtNotification data structure. + +Upon successful processing of the request, the VAL server shall respond with an HTTP "204 No Content" status code. On failure, the VAL server shall take proper error handling actions, as specified in clause 7.4.1.5, and respond to the NRM server with an appropriate error status code. + +### 5.5.2 SS\_EventsMonitoring API + +The SS\_EventsMonitoring API, as defined in 3GPP TS 23.434 [2], allows a VAL server via NRM-S reference point to subscribe for and receive notifications from the Network Resource Management server about events related to VAL UE(s). The SS\_EventsMonitoring API supports this via the "NRM\_MONITOR\_UE\_USER\_EVENTS" event in SS\_Events API as specified in clause 7.5. Based on the events of interest information related to the VAL UE(s), the NRM server shall subscribe to UE monitoring types and analytics events as specified in clause 4.4.2 and clause 4.4.14 of 3GPP TS 29.522 [28]. + +### 5.5.3 SS\_NetworkResourceMonitoring API + +#### 5.5.3.1 Service Description + +##### 5.5.3.1.1 Overview + +The SS\_NetworkResourceMonitoring API, as defined in 3GPP TS 23.434 [2], allows VAL server via NRM-S reference point to communicate with the network resource management server for network resource monitoring including requesting unicast QoS monitoring data and managing unicast QoS monitoring subscription. + +#### 5.5.3.2 Service Operations + +##### 5.5.3.2.1 Introduction + +The service operations defined for the SS\_NetworkResourceMonitoring API are shown in the table 5.5.3.2.1-1. + +**Table 5.5.3.2.1-1: Operations of the SS\_NetworkResourceMonitoring API** + +| Service operation name | Description | Initiated by | +|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------|--------------| +| Subscribe_Unicast_QoS_Monitoring | This service operation is used by VAL server to subscribe to unicast QoS monitoring events from SEAL servers. | VAL server | +| Unsubscribe_Unicast_QoS_Monitoring | This service operation is used by VAL server to unsubscribe from unicast QoS monitoring events from SEAL servers. | VAL server | +| Notify_Unicast_QoS_Monitoring | This service operation is used by SEAL server to send the notifications to the VAL server. | NRM server | +| Obtain_Unicast_QoS_Monitoring | This service operation is used by VAL server to obtain unicast QoS monitoring data. | VAL server | +| Update_Unicast_QoS_Monitoring_Subscription | This service operation is used by VAL server to update or modify the individual unicast QoS monitoring subscription. | VAL server | + +### 5.5.3.2.2 Subscribe\_Unicast\_QoS\_Monitoring + +#### 5.5.3.2.2.1 General + +This service operation is used by a VAL server to create a unicast QoS monitoring subscription to the NRM server. + +#### 5.5.3.2.2.2 VAL server subscribes for Unicast QoS Monitoring using Subscribe\_Unicast\_QoS\_Monitoring + +In order to subscribe to unicast QoS monitoring, the VAL server shall send an HTTP POST message to the NRM server targeting the URI of the "Unicast Monitoring Subscriptions" resource as specified in clause 7.4.2.2.2.3.1. The request body shall include the MonitoringSubscription data structure as defined in clause 7.4.2.4.2.8. The VAL server shall indicate within the ReportingRequirement data structure whether one-time reporting and/or immediate reporting is requested, i.e.: + +- the "immRep" attribute set to "true", if immediate reporting of the unicast QoS Monitoring data is requested; and/or +- the "reportingMode" attribute set to "ONE\_TIME" and the "immRep" attribute set to "true", if one-time reporting of the unicast QoS Monitoring data is requested via the Obtain\_Unicast\_QoS\_Monitoring service operation. + +Upon reception of the HTTP POST request message, the NRM server shall: + +1. verify the identity of the VAL server and whether the VAL server is authorized to create a unicast QoS monitoring subscription at the NRM server; +2. if the VAL server is not authorized, the NRM server shall respond to the VAL server with an appropriate error status code; +3. if the VAL server is authorized: + - a. if immediate reporting and one-time reporting are requested, the NRM server determines if the requested data is available internally or not and whether to interact with the NEF to retrieve the data using the Nnef\_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) as defined in 3GPP TS 29.522 [28]; + - b. otherwise, the NRM server shall interact with the NEF to establish the associated QoS monitoring subscriptions by invoking the Nnef\_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) and AsSessionWithQoS API as defined in 3GPP TS 29.522 [28]. The NRM server determines the relevant NEF subscription procedures and the parameters for these subscriptions based on the inputs received from the VAL server; +4. upon reception of successful response(s) from the NEF or retrieval of the requested data internally: + +- a. if immediate reporting and one-time reporting are requested, an HTTP "200 OK" status code, with the response body including the MonitoringReport data structure containing the available requested Unicast QoS Monitoring data as defined in clause 7.4.2.4.2.2; +- b. otherwise, the NRM server shall create a new "Individual Unicast Monitoring Subscription" resource and respond to the VAL server with: + - an HTTP "201 Created" status code, including a Location header field containing the URI for the created "Individual Unicast Monitoring Subscription" resource and the response body including the MonitoringSubscription data structure containing a representation of the created resource as defined in clause 7.4.2.4.2.8; and + - if immediate reporting was requested by the VAL server, the returned MonitoringSubscription data structure shall also contain the requested Unicast QoS Monitoring data within the "monRep" attribute, if the requested data is available, as defined in clause 7.4.2.4.2.2; +- c. in the case of partial failure, i.e. the request fails for only a subset of the targeted VAL UE(s) or VAL Stream ID(s), the NRM server shall include the "failureRep" attribute within the returned MonitoringReport data structure indicating the list of VAL UE(s) or VAL Stream ID(s) for which the NRM server failed to obtain the requested data and the related failure reasons; + +and + +5. if the NRM server is unable to satisfy the request, the NRM server shall respond to the VAL server with an appropriate error status code. + +### 5.5.3.2.3 Unsubscribe\_Unicast\_QoS\_Monitoring + +#### 5.5.3.2.3.1 General + +This service operation is used by a VAL server to terminate a unicast QoS monitoring subscription at the NRM server. + +#### 5.5.3.2.3.2 VAL server unsubscribes for Unicast QoS Monitoring using Unsubscribe\_Unicast\_QoS\_Monitoring + +In order to terminate a unicast QoS monitoring subscription, the VAL server shall send an HTTP DELETE request message to the NRM server, on the corresponding "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.1. + +Upon reception of the HTTP DELETE request message, the NRM server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorised to terminate the targeted "Individual Unicast Monitoring Subscription" associated with the resource URI; +2. if the VAL server is authorized to unsubscribe from Unicast QoS Monitoring, interact with the NEF to terminate the related QoS monitoring subscription and delete the related "Individual Unicast Monitoring Subscription" subscription resource at the NRM server; and +3. upon success, respond to the VAL server with a "204 No Content" status code. + +### 5.5.3.2.4 Notify\_Unicast\_QoS\_Monitoring + +#### 5.5.3.2.4.1 General + +This service operation is used by the NRM server to notify the VAL server of unicast QoS monitoring data. + +#### 5.5.3.2.4.2 NRM server notifies for Unicast QoS Monitoring using Notify\_Unicast\_QoS\_Monitoring + +The NRM server receives unicast QoS monitoring data by means of notifications provided by the NEF. The NRM server coordinates and aggregates the received information from the NEF notifications and determines whether to send a notification to the VAL server based on the VAL server subscription's reporting requirements. For event-triggered reporting, the NRM server notifies the VAL server when any given event is triggered. For a VAL group or a list of + +VAL UEs, the NRM server aggregates QoS monitoring data for each UE belonging to the group or the list; for a VAL stream, the NRM server aggregates the QoS monitoring data for the stream. + +The NRM server stops reporting according to the VAL server subscription's termination of reporting requirements. In the case user-triggered termination of reporting is requested or no termination of reporting requirements are provided, the NRM server terminates the Unicast Monitoring Subscription after receiving an explicit request from the VAL Server as specified in clause 5.5.3.2.3. In the case of time-triggered or event-triggered termination of reporting, the NRM server shall stop the reporting and terminate the subscription when the provided conditions are met. The NRM server may also store internally the QoS monitoring data as needed for later retrieval. + +In order to notify the VAL server about Unicast QoS Monitoring information updates, the NRM server shall send an HTTP POST request message to the VAL server targeting the notification URI provided during subscription creation as specified in clause 5.5.3.2.2.2. + +Upon receiving the HTTP POST request message, the VAL server shall: + +1. process the Unicast QoS Monitoring notification; and +2. upon success, respond to the NRM server with a "204 No Content" status code. + +#### 5.5.3.2.5 Obtain\_Unicast\_QoS\_Monitoring\_Data + +##### 5.5.3.2.5.1 General + +This service operation is used by a VAL server to obtain the QoS monitoring data from the NRM server for a time period of interest either in the past or in the present (i.e. current time). This service operation is supported via the Subscribe\_Unicast\_QoS\_Monitoring service operation using the immediate reporting and one-time reporting mechanisms as defined in clause 5.5.3.2.2.2. + +#### 5.5.3.2.6 Update\_Unicast\_QoS\_Monitoring\_Subscription + +##### 5.5.3.2.6.1 General + +This service operation is used by a VAL server to update a unicast QoS monitoring subscription at the NRM server. + +##### 5.5.3.2.6.2 VAL server modifies for Unicast QoS Monitoring Subscription using Update\_Unicast\_QoS\_Monitoring Subscription + +If the "UpdateSupport" feature defined in clause 7.4.2.6 is supported, the VAL server may send an HTTP PUT or an HTTP PATCH request to update or modify an individual unicast QoS monitoring subscription, respectively. + +In order to update an existing individual unicast QoS monitoring subscription, the VAL server shall send an HTTP PUT request message to the NRM server, targeting the corresponding "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.3. + +In order to modify an existing individual unicast QoS monitoring subscription, the VAL server shall send an HTTP PATCH request message targeting the "Individual Unicast Monitoring Subscription" resource URI as specified in clause 7.4.2.2.3.3.4. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.4.2.2.3.3.4. + +The updated resource representation information provided via an HTTP PUT method shall not change any target identifier, i.e., the "valUeIds", "valGroupId", and "valStreamIds" attributes within the "Individual Unicast Monitoring Subscription" resource. + +Upon receiving the HTTP PUT or HTTP PATCH request message, the NRM server shall: + +1. check if the required features for the received HTTP request are supported as defined in clause 7.4.2.6; +2. verify the identity of the VAL server and check if the VAL server is authorised to update or modify the "Individual Unicast Monitoring Subscription" resource; +3. if the required feature for the received HTTP request is supported and the VAL server is authorized, then the NRM server shall: + +- a. if the configuration information in the request is valid, interact with the NEF to update, modify, or establish the associated QoS monitoring subscriptions by invoking the Nnef\_AnalyticsExposure API (UE Communication Analytics Events and DN Performance Analytics) and AsSessionWithQoS API as defined in 3GPP TS 29.522 [28]. The NRM server determines the relevant NEF subscription procedures and the parameters for these subscriptions based on the inputs received from the VAL server; +4. upon reception of successful response(s) from the NEF: + - a. update/modify the resource identified by the Resource URI of the configuration received in the request; and + - b. respond to the VAL server with an HTTP "200 OK" status; +- and +5. if the NRM server is unable to satisfy the request, the NRM server shall respond to the VAL server with an appropriate error status code as defined in clause 7.4.2.5. + +## 5.6 Events APIs + +### 5.6.1 SS\_Events API + +#### 5.6.1.1 Service Description + +##### 5.6.1.1.1 Overview + +The SS\_Events API, allows a VAL server via LM-S, GM-S, CM-S reference points to subscribe and unsubscribe from SEAL events and to receive notifications from the Location Management Server, Group Management Server and Configuration Management Server respectively. + +#### 5.6.1.2 Service Operations + +##### 5.6.1.2.1 Introduction + +The service operations defined for the SS\_Events API are shown in the table 5.6.1.2.1-1. + +**Table 5.6.1.2.1-1: Operations of the SS\_Events API** + +| Service operation name | Description | Initiated by | +|------------------------|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| Subscribe_Event | This service operation is used by VAL server to subscribe for events from SEAL servers. | VAL Server | +| Unsubscribe_Event | This service operation is used by VAL server to unsubscribe for events from SEAL servers. | VAL Server | +| Notify_Event | This service operation is used by SEAL servers to send the notifications to the VAL server. | SEAL servers (Location Management, Group Management, Configuration Management). | +| Update_Subscription | This service operation is used by VAL server to update its events subscription at SEAL server. | VAL Server | + +### 5.6.1.2.2 Subscribe\_Event + +#### 5.6.1.2.2.1 General + +This service operation is used by a VAL server to subscribe to the SEAL events. + +#### 5.6.1.2.2.2 Subscribing to SEAL events using Subscribe\_Event service operation + +To subscribe to SEAL events, the VAL server shall send an HTTP POST message to the SEAL server. The body of the HTTP POST message shall include VAL Server Identifier, Event Type, Event Filters, Reporting Requirements and a Notification Destination URI as specified in clause 7.5.1.2.2.3.1. + +Upon receiving the above described HTTP POST message, the SEAL server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to subscribe to the SEAL events mentioned in the HTTP POST message; +2. if the VAL server is authorized to subscribe to the SEAL events, the SEAL server shall: + - a. verify the provided identifier(s) in the request; + - b. if the PartialFailureSupport feature is supported and partial failure has occurred (e.g. the SEAL server fails to verify the identifier(s) of only a subset of the provided target identifiers), the SEAL server shall process the request for the identifier(s) for which the verification is successful, create a new resource as specified in clause 7.5.1.2.1 and include in the response to the service consumer (i.e. VAL server) the "failureReport" attribute within the EventSubscription data structure indicating the list of the target identifier(s) for which the verification failed; + - c. otherwise, upon successful verification of the provided identifier(s) and successful processing of the request, create a new resource as specified in clause 7.5.1.2.1; + - d. return the created resource representation and the created SEAL Resource URI in the response message ; and + - e. if the SEAL server is unable to satisfy the request, the SEAL server shall respond to the VAL server with an appropriate error status code as defined in clause 7.5.1.5. + +### 5.6.1.2.3 Notify\_Event + +#### 5.6.1.2.3.1 General + +This service operation is used by the SEAL servers to send notifications to the VAL server. + +#### 5.6.1.2.3.2 Notifying SEAL events using Notify\_Event service operation + +To notify the SEAL events, the SEAL server shall send an HTTP POST message using the Notification Destination URI received in the subscription request. The body of the HTTP POST message shall include an Event Notification and SEAL Resource URI. + +Upon receiving the HTTP POST message, the VAL server shall process the Event Notification. + +### 5.6.1.2.4 Unsubscribe\_Event + +#### 5.6.1.2.4.1 General + +This service operation is used by a VAL server to un-subscribe from the SEAL events. + +#### 5.6.1.2.4.2 Unsubscribing from SEAL events using Unsubscribe\_Event service operation + +To unsubscribe from SEAL events, the VAL server shall send an HTTP DELETE message to the resource representing the event in the SEAL server as specified in clause 7.5.1.2.3.3.1. + +Upon receiving the HTTP DELETE message, the SEAL server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to Unsubscribe from the SEAL event associated with the SEAL Resource URI; and +2. if the VAL server is authorized to unsubscribe from the SEAL events, the SEAL server shall delete the resource pointed by the SEAL Resource URI + +#### 5.6.1.2.5 Update\_Subscription + +##### 5.6.1.2.5.1 General + +This service operation is used by a VAL server to update its SEAL events subscription. + +##### 5.6.1.2.5.2 Updating the SEAL events subscription using Update\_Subscription service operation + +If the "SubscUpdate" feature as defined in clause 7.5.1.6 is supported, then to request the update/modification of an existing Individual SEAL Events Subscription, the VAL server shall send a HTTP PATCH request (for partial modification) or PUT request (for fully replacement) message to the SEAL server on resource URI "Individual SEAL Events Subscription" resource as specified in clause 7.5.1.2.3.3.2 for HTTP PATCH message and in clause 7.5.1.2.3.3.3 for HTTP PUT message. + +Upon receiving the HTTP PATCH or PUT message from the VAL server, the SEAL server shall: + +1. check the update of the existing Individual SEAL Events Subscription from the VAL server is authorized or not; +2. if the VAL server is authorized to update the SEAL Events Subscription, then the SEAL server shall replace/modify the existing resource "Individual SEAL Events Subscription", respond to the VAL server with "204 No Content", or "200 OK" with the updated Individual SEAL Events Subscription message. + +## 5.7 Key management APIs + +### 5.7.1 SS\_KeyInfoRetrieval API + +#### 5.7.1.1 Service Description + +##### 5.7.1.1.1 Overview + +As specified in 3GPP TS 33.434 [26], the SS\_KeyInfoRetrieval API, allows the VAL server via KM-S reference point to obtain the VAL service specific key management information from the key management server. + +#### 5.7.1.2 Service Operations + +##### 5.7.1.2.1 Introduction + +The service operation defined for SS\_KeyInfoRetrieval API is shown in the table 5.7.1.2.1-1. + +**Table 5.7.1.2.1-1: Operations of the SS\_ KeyInfoRetrieval API** + +| Service operation name | Description | Initiated by | +|------------------------|------------------------------------------------------------------------------------|--------------| +| Obtain_Key_Info | This service operation is used by VAL server to obtain key management information. | VAL server | + +##### 5.7.1.2.2 Obtain\_Key\_Info + +##### 5.7.1.2.2.1 General + +This service operation is used by the VAL server to obtain VAL service specific key management information. + +#### 5.7.1.2.2.2 VAL server obtaining VAL service specific key material using Obtain\_Key\_Info service operation + +To obtain key management information specific to VAL service, the VAL server shall send HTTP GET request message to key management server, on Key records resource collection URI, with query parameters VAL service ID and optionally VAL user ID or VAL UE ID, as specified in 7.6.1.2.2.3.1. + +Upon receiving the HTTP GET message as described above, the key management server shall: + +1. verify the identity of the VAL server and check if the VAL server is authorized to obtain key management information specific to VAL service, VAL user or VAL UE, the URI in the request is of target SEAL KMS and date/time of the request is in recent time window; +2. if the VAL server is authorized to obtain the requested key management information, the key management server shall; + - a. return in the response message with key management information corresponding to the query parameters that were sent in the request message. + +## 5.8 Network slice capability Enablement APIs + +### 5.8.1 SS\_NetworkSliceAdaptation API + +#### 5.8.1.1 Service Description + +##### 5.8.1.1.1 Overview + +As specified in 3GPP TS 23.434 [2], the SS\_NetworkSliceAdaptation API, enables a VAL server to communicate with the Network Slice Capability Enablement (NSCE) server for network slice adaptation over the NSCE-S reference point. + +#### 5.8.1.2 Service Operations + +##### 5.8.1.2.1 Introduction + +The service operation defined for SS\_NetworkSliceAdaptation API is shown in the table 5.8.1.2.1-1. + +**Table 5.8.1.2.1-1: Operations of the SS\_NetworkSliceAdaptation API** + +| Service operation name | Description | Initiated by | +|--------------------------|--------------------------------------------------------------------------------------------------------|--------------| +| Network_slice_adaptation | This service operation is used by a VAL server to request network slice adaptation to the NSCE server. | VAL server | + +##### 5.8.1.2.2 Network\_slice\_adaptation + +###### 5.8.1.2.2.1 General + +This service operation is used by a VAL server to request network slice adaptation to the NSCE server. + +###### 5.8.1.2.2.2 VAL server requesting network slice adaptation using Network\_slice\_adaptation service operation + +To request network slice adaptation, the VAL server shall send an HTTP POST request message (i.e. custom operation "Request") to the NSCE server, with the request body containing the NwSliceAdptInfo data structure which shall include the parameters VAL service ID and list of VAL UE ID(s), and may include the parameters Network slice adaptation cause, Requested slice information (S-NSSAI or ENSI) and Requested DNN, as specified in clause 7.7.1.3.2. + +Upon reception of the HTTP POST request message as described above, the NSCE server shall: + +1. process the request and trigger the network slice configuration per VAL UE within the VAL Application to provide the updated S-NSSAI and DNN per VAL UE; +2. send guidance with the information (i.e., the updated S-NSSAI and DNN per VAL UE) to the PCF via NEF as part of the AF-driven guidance for URSP determination to 5G system, using Nnef\_ServiceParameter API as defined in 3GPP TS 29.522 [28]; and +3. after receiving a successful response from the NEF, send an HTTP 204 No content response to the VAL server confirming the fulfilment of the network slice adaptation request per VAL application. + +## 5.9 Identity Management APIs + +### 5.9.1 SS\_IdmParameterProvisioning API + +#### 5.9.1.1 Service Description + +##### 5.9.1.1.1 Overview + +As specified in 3GPP TS 23.434 [2], the SS\_IdmParameterProvisioning API enables a VAL server to communicate with the Identity Management (IM) server for the provisioning of the VAL service specific information for a VAL server (i.e. VAL server's VAL service(s) and the related VAL user(s) information) over the SEAL IM-S reference point. + +#### 5.9.1.2 Service Operations + +##### 5.9.1.2.1 Introduction + +The service operations defined for the SS\_IdmParameterProvisioning API are shown in the table 5.9.1.2.1-1. + +**Table 5.9.1.2.1-1: Operations of the SS\_IdmParameterProvisioning API** + +| Service operation name | Description | Initiated by | +|------------------------|---------------------------------------------------------------------------------------------------------------|-----------------| +| Provide_Configuration | This service operation is used to provision the VAL service specific information to the IM server. | e.g. VAL server | +| Get_Configuration | This service operation is used to retrieve the VAL service specific information provisioned to the IM server. | e.g. VAL server | +| Update_Configuration | This service operation is used to update the VAL service specific information provisioned to the IM server. | e.g. VAL server | +| Delete_Configuration | This service operation is used to delete the VAL service specific information provisioned to the IM server. | e.g. VAL server | + +### 5.9.1.2.2 Provide\_Configuration + +#### 5.9.1.2.2.1 General + +This service operation is used by a VAL server to provision the list of VAL service specific information of the VAL server to the IM server. + +#### 5.9.1.2.2.2 VAL server provisioning VAL service specific information using Provide\_Configuration service operation + +To provision the VAL services specific information, the VAL server shall send an HTTP POST request message to the IM Server with the request body including the VALServicesConfig data structure specified in clause 7.8.1.5.2.2. + +Upon receiving HTTP POST message, the identity management server shall: + +1. verify the identity of the VAL Server and check if the VAL Server is authorized to provision the VAL services specific configuration information; +2. if the VAL Server is authorized to provision the VAL services specific configuration information, shall create a new resource as defined in 7.8.1.2.2.3.1; and +3. if the IM Server is unable to satisfy the request, the IM Server shall respond to the VAL Server with an appropriate error status code as defined in clause 7.8.1.5. + +### 5.9.1.2.3 Get\_Configuration + +#### 5.9.1.2.3.1 General + +This service operation is used by a service consumer to fetch the provisioned list of VAL services specific information of the VAL server from the IM server. + +#### 5.9.1.2.3.2 Service consumer obtaining the VAL service specific information provisioned using Get\_Configuration service operation + +To obtain the provisioned VAL services configuration information, the service consumer shall send a HTTP GET message to the IM server targeting either, + +- "Individual VAL Services Configuration" resource representation URI as specified in clause 7.8.1.2.3.3.1; or +- "VAL Services Configurations" collection resource representation URI as specified in clause 7.8.1.2.2.3.2. In the GET message to "VAL Services Configurations" collection resource, the service consumer may include the VAL Server ID of the requesting VAL server, list of identifiers identifying the "Individual VAL Services Configuration" resources, as query parameters. + +Upon receiving the HTTP GET message as described above, if the service consumer is authorized to obtain the VAL Services Configuration information, then the IM server shall: + +1. in the request to "VAL Services Configurations" collection resource representation URI, return the VAL Service Configurations, list of "VALServicesConfig" data type, matching the query parameters in the response message; +2. in the request to "Individual VAL Services Configuration" resource representation URI, return the VAL Service Configuration resource "VALServicesConfig" data type in the response message. +3. if errors occur when processing the request, the IM Server shall respond to the service consumer with an appropriate error response as specified in clause 7.1.3.5. + +### 5.9.1.2.4 Update\_Configuration + +#### 5.9.1.2.4.1 General + +This service operation is used by a service consumer to update the list of VAL service specific information of the VAL server provisioned to the IM server. + +#### 5.9.1.2.4.2 Service consumer updating VAL service specific information using Update\_Configuration service operation + +To modify the VAL Services Configuration, the service consumer shall send either, + +- HTTP PUT message, including the "VALServicesConfig" data type, to the IM server to the Resource URI identifying the "Individual VAL Services Configuration" resource representation, as specified in the clause 7.8.1.2.3.3.2. This request shall not replace valServerId property in the existing resource, or +- HTTP PATCH request message, including the "VALServicesConfigPatch" data type, to the "Individual VAL Services Configuration" resource URI as specified in clause 7.8.1.2.3.3.3, to partially update the VAL Service Configuration. The body of the HTTP PATCH request message shall include the requested modifications as specified in clause 7.8.1.2.3.3.3. + +Upon receiving the HTTP PUT / PATCH message, if the service consumer is authorized to modify/update the VAL services configuration information, then the IM server shall: + +1. update/modify the resource identified by the Resource URI of the "Individual VAL Services Configuration" with the VAL Services information received in the request; +2. respond to the service consumer with HTTP "200 OK" with the response body containing the updated "Individual VAL Services Configuration" in "VALServicesConfig" data type, in the response or a 204 No Content status code; +3. if errors occur when processing the request, the IM Server shall respond to the service consumer with an appropriate error response as specified in clause 7.1.3.5. + +#### 5.9.1.2.5 Delete\_Configuration + +##### 5.9.1.2.5.1 General + +This service operation is used by a service consumer to delete the list of VAL service specific information of the VAL server provisioned to the IM server. + +##### 5.9.1.2.5.2 Service consumer deleting VAL service specific information using Delete\_Configuration service operation + +To delete a VAL Services Configuration information, the service consumer shall send a HTTP DELETE message to the IM server to its "Individual VAL Services Configuration" resource representation in the IM server as specified in clause 7.8.1.2.3.3.4. Upon receiving the HTTP DELETE message, if the service consumer is authorized to delete the VAL Services Configuration, then the IM server shall: + +1. delete the resource representation pointed by the Individual VAL Service Configuration resource identifier; +2. if errors occur when processing the request, the IM Server shall respond to the service consumer with an appropriate error response as specified in clause 7.1.3.5. + +## 5.10 Data Delivery APIs + +SEALDD APIs are defined in 3GPP TS 29.548 [35]. + +--- + +# 6 SEAL Design Aspects Common for All APIs + +## 6.1 General + +SEAL APIs allow secure access to the capabilities provided by SEAL. + +This document specifies the procedures triggered at different functional entities as a result of API invocation requests and event notifications. The stage-2 level requirements and signalling flows are defined in 3GPP TS 23.434 [2] and 3GPP TS 23.433 [34] (for SEALDD). + +Several design aspects, as mentioned in the following clauses, are specified in 3GPP TS 29.122 [3] and referenced by this specification. + +## 6.2 Data Types + +### 6.2.1 General + +This clause defines structured data types, simple data types and enumerations that are applicable to several APIs defined in the present specification and can be referenced from data structures defined in the subsequent clauses. + +In addition, data types that are defined in OpenAPI Specification [15] can also be referenced from data structures defined in the subsequent clauses. + +NOTE: As a convention, data types names in the present specification are with an upper-case letter in the beginning. Parameters are with a lower-case letter in the beginning. As an exception, data types that are also defined in OpenAPI Specification [15] can use a lower-case case letter in the beginning for consistency. + +Table 6.2.1-1 specifies data types re-used by the SEAL from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the SEAL. + +**Table 6.2.1-1: Re-used Data Types** + +| Data type | Reference | Comments | +|--------------------|--------------------|----------------------------------------------------------------------------------------------------------| +| Uri | 3GPP TS 29.122 [3] | | +| TestNotification | 3GPP TS 29.122 [3] | Following clarifications apply:
- The SCEF is the SEAL server; and
- The SCS/AS is the VAL server. | +| WebsockNotifConfig | 3GPP TS 29.122 [3] | Following clarifications apply:
- The SCEF is the SEAL server; and
- The SCS/AS is the VAL server. | + +### 6.2.2 Referenced structured data types + +Table 6.2.2-1 lists structured data types defined in this specification referenced by multiple services: + +**Table 6.2.2-1: Referenced Structured Data Types** + +| Data type | Reference | Description | +|------------------|--------------------|-----------------------------------------| +| VALGroupDocument | Clause 7.2.1.4.2.2 | VAL Group document information. | +| ProfileDoc | Clause 7.3.1.4.2.2 | VAL User or VAL UE profile information. | + +### 6.2.3 Referenced Simple data types and enumerations + +Following simple data types defined in Table 6.2.3-1 are applicable to several APIs in this document: + +**Table 6.2.3-1: Simple data types applicable to several APIs** + +| Type name | Reference | Description | +|-----------|-----------|-------------| +| | | | + +## 6.3 Usage of HTTP + +For SEAL APIs, support of HTTP/1.1 (IETF RFC 7230 [5], IETF RFC 7231 [6], IETF RFC 7232 [7], IETF RFC 7233 [8], IETF RFC 7234 [9] and IETF RFC 7235 [10]) over TLS is mandatory and support of HTTP/2 (IETF RFC 7540 [12]) over TLS is recommended. + +A functional entity desiring to use HTTP/2 shall use the HTTP upgrade mechanism to negotiate applicable HTTP version as described in IETF RFC 7540 [12]. + +Usage of HTTP over TLS and the TLS profiles shall be as specified in clause 5.1.1.4 of 3GPP TS 33.434 [26]. + +## 6.4 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [13]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [13]. + +The JSON objects defined in clause 5.2.3 of 3GPP TS 29.122 [3] for the HTTP PATCH request shall be supported. + +NOTE: This release only supports the content type JSON. + +## 6.5 URI structure + +### 6.5.1 Resource URI structure + +All API URIs of SEAL APIs shall be: + +**{apiRoot}/** + +"apiRoot" is configured by means outside the scope of the present document. It includes the scheme ("https"), host and optional port, and an optional prefix string. "apiName" and "apiVersion" shall be set dependent on the API, as defined in the corresponding clauses below. + +All resource URIs in the clauses below are defined relative to the above root API URI. + +NOTE 1: The "apiVersion" will only be increased if the new API version contains backward incompatible changes. Otherwise, the supported feature mechanism defined in clause 6.8 can be used to negotiate extensions. + +NOTE 2: A different root structure can be used when the resource URI is preconfigured in the API invoking entity. + +The root structure may be followed by "apiSpecificSuffixes" that are dependent on the API and are defined separately for each API as resource URI where they apply: + +**{apiRoot}//** + +### 6.5.2 Custom operations URI structure + +The custom operation definition is in Annex C of 3GPP TS 29.501 [14]. + +The URI of a custom operation which is associated with a resource shall have the following structure: + +**{apiRoot}///** + +Custom operations can also be associated with the service instead of a resource. The URI of a custom operation which is not associated with a resource shall have the following structure: + +**{apiRoot}//** + +In the above URI structures, "apiRoot", "apiName", "apiVersion" and "apiSpecificResourceUriPart" are as defined in clause 6.5.1 and "custOpName" represents the name of the custom operation as defined in clause 5.1.3.2 of 3GPP TS 29.501 [14] + +## 6.6 Notifications + +The functional entities + +- shall support the delivery of notifications using a separate HTTP connection towards an address (see clause 5.2.5.2 of 3GPP TS 29.122 [3]); +- may support testing delivery of notifications (see clause 5.2.5.3 of 3GPP TS 29.122 [3]); and +- may support the delivery of notification using WebSocket protocol (see IETF RFC 6455 [4] and clause 5.2.5.4 of 3GPP TS 29.122 [3]), + +as described in 3GPP TS 29.122 [3], with the following clarifications: + +- the SCEF is the SEAL server; and +- the SCS/AS is the Subscriber. + +## 6.7 Error Handling + +Response bodies and error handling described in clause 5.2.6 of 3GPP TS 29.122 [3] are applicable to all APIs in the present specification unless specified otherwise, with the following clarifications: + +- the SCEF is the SEAL server; and +- the SCS/AS is the functional entity invoking an API. + +## 6.8 Feature negotiation + +The functional entity invoking an API (i.e. the VAL server) and the SEAL server use feature negotiation procedures defined in 3GPP TS 29.122 [3] to negotiate the supported features, with the following clarifications: + +- description of the SCEF applies to the SEAL server; and +- description of the SCS/AS applies to the functional entity invoking an API. + +## 6.9 HTTP headers + +The HTTP headers and the HTTP custom headers described in 3GPP TS 29.122 [3] are applicable to all APIs in this document. + +## 6.10 Conventions for Open API specification files + +The conventions for Open API specification files as specified in clause 5.2.9 of 3GPP TS 29.122 [3] shall be applicable for all APIs in this document. + +## 7 SEAL API Definitions + +### 7.1 Location management APIs + +#### 7.1.1 SS\_LocationReporting API + +##### 7.1.1.1 API URI + +The SS\_LocationReporting service shall use the SS\_LocationReporting API. + +The request URIs used in HTTP requests from the VAL server towards the location management server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-lr". +- The shall be "v1". +- The shall be set as described in clause 7.1.1.2. + +##### 7.1.1.2 Resources + +###### 7.1.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.1.1.2.1-1 depicts the resource URIs structure for the SS\_LocationReporting API. + +![Diagram showing the resource URI structure for the SS_LocationReporting API. The root URI is {apiRoot}/ss-lr/. A line branches down to the resource /trigger-configurations. Another line branches down from /trigger-configurations to the resource /{configurationId}.](a3c1310e720178d2450a3748c7c75422_img.jpg) + +``` +graph TD; Root["{apiRoot}/ss-lr/"] --- Trigger["/trigger-configurations"]; Trigger --- ConfigId["/{configurationId}"]; +``` + +Diagram showing the resource URI structure for the SS\_LocationReporting API. The root URI is {apiRoot}/ss-lr/. A line branches down to the resource /trigger-configurations. Another line branches down from /trigger-configurations to the resource /{configurationId}. + +**Figure 7.1.1.2.1-1: Resource URI structure of the SS\_LocationReporting API** + +Table 7.1.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.1.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------|-------------------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------| +| SEAL Location Reporting Configurations | /trigger-configurations | POST | Creates a new Individual SEAL Location Reporting Configuration information. | +| Individual SEAL Location Reporting Configuration | /trigger-configurations/{configurationId} | GET | Retrieves an Individual SEAL Location Reporting Configuration information identified by {configurationId}. | +| | | PUT | Updates an Individual SEAL Location Reporting Configuration information identified by {configurationId}. | +| | | PATCH | Partially modifies an Individual SEAL Location Reporting Configuration information identified by {configurationId}. | +| | | DELETE | Delete an Individual SEAL Location Reporting Configuration information identified by {configurationId}. | + +### 7.1.1.2.2 Resource: SEAL Location Reporting Configurations + +#### 7.1.1.2.2.1 Description + +The resource allows the VAL server to request to create a new individual SEAL location reporting configuration information at the location management server. + +#### 7.1.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-lr//trigger-configurations + +This resource shall support the resource URI variables defined in the table 7.1.1.2.2.2-1. + +**Table 7.1.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.1.1.2.2.3 Resource Standard Methods + +##### 7.1.1.2.2.3.1 POST + +**Table 7.1.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.1.1.2.2.3.1-3. + +**Table 7.1.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|-----------------------------------------------| +| LocationReportConfiguration | M | 1 | Location reporting configuration information. | + +**Table 7.1.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------| +| LocationReportConfiguration | M | 1 | 201 Created | Location reporting configuration is created successfully. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.1.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-lr//trigger-configurations/{configurationId} | + +#### 7.1.1.2.2.4 Resource Custom Operations + +None. + +#### 7.1.1.2.3 Resource: Individual SEAL Location Reporting Configuration + +##### 7.1.1.2.3.1 Description + +The resource represents an individual SEAL location reporting configuration that is created at the location management server. + +##### 7.1.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-lr//trigger-configurations/{configurationId} + +This resource shall support the resource URI variables defined in the table 7.1.1.2.3.2-1. + +**Table 7.1.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5 | +| configurationId | string | Represents an individual SEAL location reporting configuration resource. | + +##### 7.1.1.2.3.3 Resource Standard Methods + +###### 7.1.1.2.3.3.1 GET + +This operation retrieves an individual SEAL location reporting configuration information. This method shall support the URI query parameters specified in table 7.1.1.2.3.3.1-1. + +**Table 7.1.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.2.3.3.1-2 and the response data structures and response codes specified in table 7.1.1.2.3.3.1-3. + +**Table 7.1.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationReportConfiguration | M | 1 | 200 OK | The location reporting configuration information. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +**Table 7.1.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +#### 7.1.1.2.3.3.2 PUT + +This operation updates the individual SEAL location reporting configuration. This method shall support the URI query parameters specified in table 7.1.1.2.3.3.2-1. + +**Table 7.1.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.2.3.3.2-2 and the response data structures and response codes specified in table 7.1.1.2.3.3.2-3. + +**Table 7.1.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------| +| LocationReportConfiguration | M | 1 | Updated details of the location reporting configuration. | + +**Table 7.1.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationReportConfiguration | M | 1 | 200 OK | The configuration is updated successfully and the updated configuration information returned in the response. | +| n/a | | | 204 No Content | The location reporting configuration updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +**Table 7.1.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +### 7.1.1.2.3.3.3 DELETE + +This operation deletes the individual SEAL location reporting configuration. This method shall support the URI query parameters specified in table 7.1.1.2.3.3.3-1. + +**Table 7.1.1.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.2.3.3.3-2 and the response data structures and response codes specified in table 7.1.1.2.3.3.3-3. + +**Table 7.1.1.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.1.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|----------|--------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual configuration matching the configurationId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +**Table 7.1.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +#### 7.1.1.2.3.3.4 PATCH + +This method shall support the URI query parameters specified in table 7.1.1.2.3.3.4-1. + +**Table 7.1.1.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.2.3.3.4-2 and the response data structures and response codes specified in table 7.1.1.2.3.3.4-3. + +**Table 7.1.1.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------| +| LocationReportConfigurationPatch | M | 1 | Contains the modifications to be applied to the Individual SEAL Location Reporting Configuration resource. | + +**Table 7.1.1.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocationReportConfiguration | M | 1 | 200 OK | Individual SEAL Location Reporting Configuration resource is modified successfully and representation of the modified Individual SEAL Location Reporting Configuration resource is returned. | +| n/a | | | 204 No Content | The Individual SEAL Location Reporting Configuration resource is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.1.1.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.1.1.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +#### 7.1.1.2.3.4 Resource Custom Operations + +None. + +#### 7.1.1.3 Notifications + +##### 7.1.1.3.1 General + +**Table 7.1.1.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|--------------|---------------------------------|---------------------------------| +| Location Reporting Notification | {notifUri} | POST | Notify on location event. | + +##### 7.1.1.3.2 Location Trigger Event Notification + +###### 7.1.1.3.2.1 Description + +###### 7.1.1.3.2.2 Notification definition + +Callback URI: {notifUri} + +This method shall support the URI query parameters specified in table 7.1.1.3.2.2-1. + +**Table 7.1.1.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.1.3.2.2-2 and the response data structures and response codes specified in table 7.1.1.3.2.2-3. + +**Table 7.1.1.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------| +| LocationReport | M | 1 | Represents the reported location event. | + +**Table 7.1.1.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The notification is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.1.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +**Table 7.1.1.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +## 7.1.1.4 Data Model + +### 7.1.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.1.1.4.1-1 specifies the data types defined specifically for the SS\_LocationReporting API service. + +**Table 7.1.1.4.1-1: SS\_LocationReporting API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|----------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| InsideOutsideInd | 7.1.1.4.3.3 | Represents a desired condition of the location reporting, e.g., inside or outside the given area. | TriggeringCriteria | +| LocChangeCond | 7.1.1.4.3.4 | Represents a desired condition of the requested location change | TriggeringCriteria | +| LocationReport | 7.1.1.4.2.5 | Represents the location trigger report. | NotifSupport | +| LocationReportConfiguration | 7.1.1.4.2.2 | Represents the location reporting configuration information. | | +| LocationReportConfigurationPatch | 7.1.1.4.2.3 | Represents the requested modifications to the location reporting configuration information.
Used to partially update Individual SEAL Location Reporting Configuration resource. | PatchUpdate | +| TriggeringCriteria | 7.1.1.4.2.4 | Represents the location reporting triggering criteria. | TriggeringCriteria | + +Table 7.1.1.4.1-2 specifies data types re-used by the SS\_LocationReporting API service. + +**Table 7.1.1.4.1-2: SS\_LocationReporting API Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------|--------------------| +| Accuracy | 3GPP TS 29.122 [3] | Used to represent the desired level of accuracy of the requested location information. | | +| DateTime | 3GPP TS 29.571 [21] | Used to represent the subscription duration. | | +| DurationSec | 3GPP TS 29.571 [21] | Used to represent the time interval between successive location reports. | | +| ScheduledCommunicationTime | 3GPP TS 29.571 [21] | Used to represent the scheduled location reporting time interval. | TriggeringCriteria | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.1.1.6-1. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID, to which location reporting applies. | | +| Uri | 3GPP TS 29.122 [3] | Represents a URI. | NotifSupport | + +## 7.1.1.4.2 Structured data types + +## 7.1.1.4.2.1 Introduction + +## 7.1.1.4.2.2 Type: LocationReportConfiguration + +**Table 7.1.1.4.2.2-1: Definition of type LocationReportConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| valServerId | string | M | 1 | Represents the VAL server identifier. | | +| valTgtUe | ValTargetUe | M | 1 | Represents the VAL User ID or VAL UE ID to which the location reporting applies. | | +| immRep | boolean | O | 0..1 | Indication of immediate reporting. If included, when it is set to true it indicates immediate reporting of the subscribed events, if available. Otherwise, reporting will occur when the event is met. | | +| monDur | DateTime | O | 0..1 | Represents the time at which the subscription ceases to exist (i.e the reporting trigger becomes invalid). If omitted, there is no time limit. | | +| repPeriod | DurationSec | O | 0..1 | Indicates the minimum time interval between successive location reports. | | +| notifUri | Uri | C | 0..1 | Represents the notification URI.

This attribute shall be provided when the "NotifSupport" feature is supported. | NotifSupport | +| accuracy | Accuracy | O | 0..1 | Represents the desired level of accuracy of the requested location information. | | +| triggCriteria | TriggeringCriteria | O | 0..1 | Represents the location report triggering criteria based on the VAL service area information. | TriggeringCriteria | +| valSvcAreaIds | array(string) | O | 0..1 | Represents the VAL service area ID(s). | ValSrvArea | +| suppFeat | SupportedFeatures | O | 0..1 | Used to negotiate the supported features of the API as defined in clause 7.1.1.6. This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | +| report | LocationReport | O | 0..1 | Represents location report.

This attribute may be present only in the response to a Location Trigger creation/update request. | NotifSupport | + +## 7.1.1.4.2.3 Type: LocationReportConfigurationPatch + +Table 7.1.1.4.2.3-1: Definition of type LocationReportConfigurationPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| valTgtUe | ValTargetUe | O | 1 | Represents the VAL User ID or VAL UE ID to which the location reporting applies. | | +| monDur | DateTime | O | 0..1 | Represents the time at which the subscription ceases to exist (i.e the reporting trigger becomes invalid). If omitted, there is no time limit. | | +| repPeriod | DurationSec | O | 0..1 | Indicates the minimum time interval between successive location reports. | | +| notifUri | Uri | O | 0..1 | Represents the notification URI. | NotifSupport | +| accuracy | Accuracy | O | 0..1 | Represents the desired level of accuracy of the requested location information. | | +| valSvcAreaIds | array(string) | O | 0..1 | Represents the VAL service area ID(s). | ValSrvArea | +| trigCriteria | ValServAreaTriggCriteria | O | 0..1 | Represents the location report triggering criteria. | TriggeringCriteria | + +## 7.1.1.4.2.4 Type: TriggeringCriteria + +Table 7.1.1.4.2.4-1: Definition of type TriggeringCriteria + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reportingMode | NotificationMethod | M | 1 | The indication of the requested reporting mode: periodic or event-triggered.

The "ONE_TIME" value is not applicable for this attribute. | | +| repPer | DurationSec | C | 0..1 | Indicates the reporting periodicity.

This attribute shall be present if the "reportingMode" attribute is set to the "PERIODIC". | | +| locChgCond | LocChangeCond | C | 0..1 | Identifies the reporting time interval for the event-triggered reporting.

This attribute shall be present if the "reportingMode" attribute is set to the "ON_EVENT_DETECTION". | | +| ioInd | InsideOutsideInd | O | 0..1 | Indicates the condition when the reporting shall occur. | | +| repSchedules | array(ScheduledCommunicationTime) | O | 1..N | Indicates the requested reporting schedule, e.g., day(s) of the week and/or time period(s) for the location reporting. | | + +## 7.1.1.4.2.5 LocationReport + +Table 7.1.1.4.2.5-1: Definition of type LocationReport + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Represents the subscription ID. | | +| valTgtUe | ValTargetUe | M | 1 | VAL User ID or UE ID whose location information is notified. | | +| locInfo | LocationInfo | M | 1 | The location information associated with the valTgtUe. | | +| timeStamp | DateTime | O | 0..1 | Timestamp of the location report. | | + +**Editor's Note:** How to indicate the triggering event to which the notification is related is FFS. + +#### 7.1.1.4.3 Simple data types and enumerations + +##### 7.1.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that are referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 6.2.1 can be referenced. + +##### 7.1.1.4.3.2 Simple data types + +The simple data types defined in table 7.1.1.4.3.2-1 shall be supported. + +**Table 7.1.1.4.3.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | + +##### 7.1.1.4.3.3 Enumeration: InsideOutsideInd + +The enumeration InsideOutsideInd represents a desired condition of the location reporting, e.g., inside or outside the given area. It shall comply with the provisions defined in table 7.1.1.4.3.3-1. + +**Table 7.1.1.4.3.3-1: Enumeration InsideOutsideInd** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------|---------------| +| INSIDE | Indicates that the reporting shall occur when the UE is inside the given location. | | +| OUTSIDE | Indicates that the reporting shall occur when the UE is outside the given location. | | + +##### 7.1.1.4.3.4 Enumeration: LocChangeCond + +The enumeration LocChangeCond represents a desired condition of the requested location change. It shall comply with the provisions defined in table 7.1.1.4.3.4-1. + +**Table 7.1.1.4.3.4-1: Enumeration LocChangeCond** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------------------|---------------| +| CELL | The condition is cell change. | | +| NODEB | The condition is eNodeB or gNodeB change. | | +| TA_RA | The condition is TA or RA change. | | +| WLAN_AN | The condition is WLAN access network change (e.g., SSID or BSSID change). | | +| CIVIC_ADDR | The condition is civic address change. | | +| GPS | The condition is GPS coordinate change. (NOTE) | | +| SAI | The condition is SAI change. | | +| ECGI | The condition is ECGI change. | | +| RAT | The condition is RAT change. | | +| VAL_SERVICE_AREA | The condition is VAL service area change. | ValSrvArea | +| NOTE: | Care needs to be taken with regards to load and signalling cost when using the "GPS" condition. | | + +#### 7.1.1.5 Error Handling + +##### 7.1.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +#### 7.1.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_LocationReporting API. + +#### 7.1.1.5.3 Application Errors + +The application errors defined for SS\_LocationReporting API are listed in table 7.1.1.5.3-1. + +**Table 7.1.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +#### 7.1.1.6 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.1.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchUpdate | Indicates the support of the PATCH method for updating an Individual SEAL Location Reporting Configuration resource. | +| 2 | ValSrvArea | This feature indicates the support of VAL service area ID functionality as part of phase-3 of the enhancements to the SEAL framework.

The following functionalities are supported:
- Support the usage of the VAL service area identifier to identify a VAL service area. | +| 3 | TriggeringCriteria | Indicates the support of the triggering criteria for the location reporting trigger as a part of the enhancements to the SEAL framework.

The following functionalities are supported:
- Support location reporting based on triggering criteria information. | +| 4 | NotifSupport | Indicates the support of the notification service operation. | + +### 7.1.2 SS\_LocationAreaInfoRetrieval API + +#### 7.1.2.1 API URI + +The request URI used in each HTTP request from the VAL server towards the location management server shall have the structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-lair". +- The shall be "v1". +- The shall be set as described in clause 7.1.2.2. + +#### 7.1.2.2 Resources + +##### 7.1.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.1.2.2.1-1 depicts the resource URIs structure for the SS\_LocationAreaInfoRetrieval API. + +![Diagram showing the URI structure: {apiRoot}/ss-lair/ points to /location-retrievals](18bb06865e2dada3656ea3d57f290f7f_img.jpg) + +``` + +graph TD + A["{apiRoot}/ss-lair/"] --> B["/location-retrievals"] + +``` + +Diagram showing the URI structure: {apiRoot}/ss-lair/ points to /location-retrievals + +**Figure 7.1.2.2.1-1: Resource URI structure of the SS\_LocationAreaInfoRetrieval API** + +Table 7.1.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.1.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------|----------------------|---------------------------------|----------------------------------------------------------------------------------------| +| Location Information | /location-retrievals | GET | Obtains the UE(s) information in an application defined proximity range of a location. | + +#### 7.1.2.2.2 Resource: Location Information + +##### 7.1.2.2.2.1 Description + +The Location Information resource represents the collection of UE(s) location information at the location management server. + +##### 7.1.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-lair//location-retrievals + +This resource shall support the resource URI variables defined in the table 7.1.2.2.2.2-1. + +**Table 7.1.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +##### 7.1.2.2.2.3 Resource Standard Methods + +###### 7.1.2.2.2.3.1 GET + +This operation obtains the UE(s) information in an application defined proximity range of a location. This method shall support the URI query parameters specified in table 7.1.2.2.2.3.1-1. + +**Table 7.1.2.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| location-info | LocationInfo | M | 1 | Location information around which the UE(s) information is requested. (NOTE) | | +| val-svc-area-id | string | O | 0..1 | Contains the identifier of the VAL service area around which the UE(s) information is requested. (NOTE) | ValSrvArea | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|---|---|---------------------------------------------------------------------------------------------------------|--| +| range | Float | M | 1 | The range information over which the UE(s) information is required, expressed in meters.
Minimum = 0 | | +| NOTE: If the "ValSrvArea" feature is supported and the "val-svc-area-id" query parameter is provided, then the LM server shall ignore the "location-info" query parameter. | | | | | | + +This method shall support the request data structures specified in table 7.1.2.2.2.3.1-2 and the response data structures and response codes specified in table 7.1.2.2.2.3.1-3. + +**Table 7.1.2.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.2.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(LMInformation) | O | 1..N | 200 OK | The UE(s) information in an application defined proximity range of a location | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.2.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +**Table 7.1.2.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +#### 7.1.2.2.2.4 Resource Custom Operations + +None. + +#### 7.1.2.3 Notifications + +None. + +## 7.1.2.4 Data Model + +### 7.1.2.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.1.2.4.1-1 specifies the data types defined specifically for the SS\_LocationAreaInfoRetrieval API service. + +**Table 7.1.2.4.1-1: SS\_LocationAreaInfoRetrieval API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +Table 7.1.2.4.1-2 specifies data types re-used by the SS\_LocationAreaInfoRetrieval API service. + +**Table 7.1.2.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------|---------------------|------------------------------------------------------------------------------|---------------| +| Float | 3GPP TS 29.571 [21] | Used to represent the value of the range. | | +| LMInformation | 7.5.1.4.2.8 | Used to represent the location information for a VAL User ID or a VAL UE ID. | | +| LocationInfo | 3GPP TS 29.122 [3] | Used to represent the location information. | | + +### 7.1.2.4.2 Structured Data Types + +None. + +### 7.1.2.4.3 Simple data types and enumerations + +None. + +## 7.1.2.5 Error Handling + +### 7.1.2.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +### 7.1.2.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_LocationAreaInfoRetrieval API. + +### 7.1.2.5.3 Application Errors + +The application errors defined for SS\_LocationAreaInfoRetrieval API are listed in table 7.1.2.5.3-1. + +**Table 7.1.2.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.1.2.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.1.2.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ValSrvArea |

This feature indicates the support of VAL service area ID functionality as part of the enhancements to SEAL.

The following functionalities are supported:

  • - Support the usage of the VAL service area identifier to identify a VAL service area.
| + +## 7.1.3 SS\_VALServiceAreaConfiguration API + +### 7.1.3.1 API URI + +The SS\_VALServiceAreaConfiguration service shall use the SS\_VALServiceAreaConfiguration API. + +The request URIs used in HTTP requests from the VAL server towards the LM Server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-vsac". +- The shall be "v1". +- The shall be set as described in clause 7.1.3.2. + +### 7.1.3.2 Resources + +#### 7.1.3.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.1.3.2.1-1 depicts the resource URIs structure for the SS\_VALServiceAreaConfiguration API. + +{apiRoot}/ss-vsac/ + +![Resource URI structure diagram for the SS_VALServiceAreaConfiguration API. The root is {apiRoot}/ss-vsac/. It branches into /areas and /subscriptions. /areas branches into /configure, /update, and /delete (all in dashed boxes). /subscriptions branches into /subscriptionId.](64cda8ce20067bc360ce2f3a5c9352b7_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-vsac/"] --- Areas[/areas/] + Root --- Subscriptions[/subscriptions/] + Areas --- Configure[/configure/] + Areas --- Update[/update/] + Areas --- Delete[/delete/] + Subscriptions --- SubscriptionId[/subscriptionId/] + style Configure stroke-dasharray: 5 5 + style Update stroke-dasharray: 5 5 + style Delete stroke-dasharray: 5 5 + +``` + +Resource URI structure diagram for the SS\_VALServiceAreaConfiguration API. The root is {apiRoot}/ss-vsac/. It branches into /areas and /subscriptions. /areas branches into /configure, /update, and /delete (all in dashed boxes). /subscriptions branches into /subscriptionId. + +**Figure 7.1.3.2.1-1: Resource URI structure of the SS\_VALServiceAreaConfiguration API** + +Table 7.1.3.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.1.3.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------------|---------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------| +| VAL Service Areas | /areas | GET | Obtain the VAL service area(s) according to the provided filtering criteria. | +| | /areas/configure | Configure | Configure VAL service area(s). | +| | /areas/update | Update | Update existing VAL service area(s). | +| | /areas/delete | Delete | Delete existing VAL service area(s). | +| VAL Service Area Change Subscriptions | /subscriptions | POST | Create a new VAL service area change event(s) subscription. | +| Individual VAL Service Area Change Subscription | /subscriptions/{subscriptionId} | GET | Retrieve the individual VAL service area change event(s) subscription resource according to the subscriptionId. | +| | | DELETE | Delete an existing VAL service area change event(s) subscription resource according to the subscriptionId. | + +### 7.1.3.2.2 Resource: VAL Service Areas + +#### 7.1.3.2.2.1 Description + +#### 7.1.3.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-vsac//areas + +This resource shall support the resource URI variables defined in table 7.1.3.2.2.2-1. + +**Table 7.1.3.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|---------------------| +| apiRoot | string | See clause 7.1.3.1. | + +#### 7.1.3.2.2.3 Resource Standard Methods + +##### 7.1.3.2.2.3.1 GET + +This operation enables to retrieve one or several "Individual VAL Service Area" resources managed by the LM Server. This method shall support the URI query parameters specified in table 7.1.3.2.2.3.1-1. + +**Table 7.1.3.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|-----------------------------------------------------------------| +| val-svc-area-ids | array(string) | O | 1..N | Represents the requested VAL service area(s). | +| supp-feats | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +NOTE: At least one of these query parameters shall be present, unless the request targets to retrieve all the VAL service area(s) available for the VAL server at the LM Server. + +**Editor's note:** The format of the "val-svc-area-ids" query parameter is FFS. + +This method shall support the request data structures specified in table 7.1.3.2.2.3.1-2 and the response data structures and response codes specified in table 7.1.3.2.2.3.1-3. + +**Table 7.1.3.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.3.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaData | M | 1 | 200 OK | The requested VAL service area(s) information is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.1.3.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +#### 7.1.3.2.2.4 Resource Custom Operations + +##### 7.1.3.2.2.4.1 Overview + +**Table 7.1.3.2.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|-------------------------------------------------| +| Configure | /areas/configure | POST | Enables to configure VAL Service Area(s). | +| Update | /areas/update | POST | Enables to update existing VAL Service Area(s). | +| Delete | /areas/delete | POST | Enables to delete existing VAL Service Area(s). | + +##### 7.1.3.2.2.4.2 Operation: Configure + +This custom operation enables to configure VAL Service Area(s). + +This operation shall support the request data structures specified in table 7.1.3.2.2.4.2-2 and the response data structures and response codes specified in table 7.1.3.2.2.4.2-3. + +**Table 7.1.3.2.2.4.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------------------------------------| +| ValServiceAreaReq | M | 1 | Represents the VAL service area(s) configuration information. | + +**Table 7.1.3.2.2.4.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaResp | M | 1 | 200 OK | Indicates the successfully configured VAL service area ID(s). | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +Editor's note: The error cases for the SS\_VALServiceAreaConfiguration API are FFS. + +**Table 7.1.3.2.2.4.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.2.4.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +#### 7.1.3.2.2.4.3 Operation: Update + +This custom operation enables to update existing VAL Service Area(s). + +This operation shall support the request data structures specified in table 7.1.3.2.2.4.3-2 and the response data structures and response codes specified in table 7.1.3.2.2.4.3-3. + +**Table 7.1.3.2.2.4.3-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------| +| ValServiceAreaReq | M | 1 | Represents the VAL service area(s) information that shall be updated. | + +**Table 7.1.3.2.2.4.3-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaResp | M | 1 | 200 OK | Indicates the successfully updated VAL service area ID(s). | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +Editor's note: The error cases for the SS\_VALServiceAreaConfiguration API are FFS. + +**Table 7.1.3.2.2.4.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.2.4.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +#### 7.1.3.2.2.4.4 Operation: Delete + +This custom operation enables to delete existing VAL Service Area(s). + +This operation shall support the request data structures specified in table 7.1.3.2.2.4.4-2 and the response data structures and response codes specified in table 7.1.3.2.2.4.4-3. + +**Table 7.1.3.2.2.4.4-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------| +| ValServiceAreaReq | M | 1 | Represents the VAL service area(s) information that shall be deleted. | + +**Table 7.1.3.2.2.4.4-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaResp | M | 1 | 200 OK | Indicates the successfully deleted VAL service area ID(s). | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +Editor's note: The error cases for the SS\_VALServiceAreaConfiguration API are FFS. + +**Table 7.1.3.2.2.4.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.2.4.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +### 7.1.3.2.3 Resource: VAL Service Area Change Subscriptions + +#### 7.1.3.2.3.1 Description + +#### 7.1.3.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-vsac//subscriptions + +This resource shall support the resource URI variables defined in table 7.1.3.2.3.2-1. + +**Table 7.1.3.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|---------------------| +| apiRoot | string | See clause 7.1.3.1. | + +### 7.1.3.2.3.3 Resource Standard Methods + +#### 7.1.3.2.3.3.1 POST + +This method enables a SEAL Server to request the creation of the individual VAL service area change subscription at the LM Server. This method shall support the URI query parameters specified in table 7.1.3.2.3.3.1-1. + +**Table 7.1.3.2.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.1.3.2.3.3.1-2 and the response data structures and response codes specified in table 7.1.3.2.3.3.1-3. + +**Table 7.1.3.2.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------| +| ValServiceAreaS
ubsc | M | 1 | Represents the requested VAL service area change subscription parameters. | + +**Table 7.1.3.2.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaS
ubsc | M | 1 | 201 Created | Successful case. The requested individual VAL service area change event(s) subscription resource is successfully created and a representation of the created resource is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM Server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.1.3.2.3.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-vsac//subscriptions{subscriptionId} | + +**Table 7.1.3.2.3.3.1-5: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.3.3.1-6: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM Server. | + +## 7.1.3.2.3.4 Resource Custom Operations + +None. + +## 7.1.3.2.4 Resource: Individual VAL Service Area Change Subscription + +## 7.1.3.2.4.1 Description + +## 7.1.3.2.4.2 Resource Definition + +Resource URI: {apiRoot}/ss-vsac//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 7.1.3.2.4.2-1. + +**Table 7.1.3.2.4.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 7.1.3.1. | +| subscriptionId | string | Represents the identifier of an individual VAL service area change event(s) subscription resource. | + +## 7.1.3.2.4.3 Resource Standard Methods + +## 7.1.3.2.4.3.1 GET + +This operation reads the Individual VAL Service Area Change Subscription resource. This method shall support the URI query parameters specified in table 7.1.3.2.4.3.1-1. + +**Table 7.1.3.2.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.1.3.2.4.3.1-2 and the response data structures and response codes specified in table 7.1.3.2.4.3.1-3. + +**Table 7.1.3.2.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.3.2.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaSubsc | M | 1 | 200 OK | The requested individual VAL service area change event(s) subscription is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.1.3.2.4.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM server. | + +**Table 7.1.3.2.4.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM server. | + +#### 7.1.3.2.4.3.2 PUT + +This operation updates the Individual VAL Service Area Change Subscription resource. This method shall support the URI query parameters specified in table 7.1.3.2.4.3.2-1. + +**Table 7.1.3.2.4.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.3.2.4.3.2-2 and the response data structures and response codes specified in table 7.1.3.2.4.3.2-3. + +**Table 7.1.3.2.4.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------------------------------------------------------------------------| +| ValServiceAreaSubsc | M | 1 | Represents the updated representation of the VAL service area change event(s) subscription. | + +**Table 7.1.3.2.4.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|----------|--------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaSubsc | M | 1 | 200 OK | The individual VAL service area change event(s) subscription is updated successfully, and the representation of the updated resource is returned. | +| n/a | | | 204 No Content | The individual VAL service area change event(s) subscription is updated successfully and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.3.2.4.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.4.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative LM Server. | + +#### 7.1.3.2.4.3.3 PATCH + +This operation modifies the Individual VAL Service Area Change Subscription resource. This method shall support the URI query parameters specified in table 7.1.3.2.4.3.3-1. + +**Table 7.1.3.2.4.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|----------|--------------------|--------------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.3.2.4.3.3-2 and the response data structures and response codes specified in table 7.1.3.2.4.3.3-3. + +**Table 7.1.3.2.4.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| ValServiceAreaSubscPatch | M | 1 | Represents the requested modifications to the VAL service area change event(s) subscription. | + +**Table 7.1.3.2.4.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServiceAreaSubsc | M | 1 | 200 OK | The individual VAL service area change event(s) subscription is modified successfully, and the representation of the modified resource is returned. | +| n/a | | | 204 No Content | The individual VAL service area change event(s) subscription is modified successfully and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.3.2.4.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative LM Server. | + +**Table 7.1.3.2.4.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative LM Server. | + +#### 7.1.3.2.4.3.4 DELETE + +This operation deletes the Individual VAL Service Area Change Subscription resource. This method shall support the URI query parameters specified in table 7.1.3.2.4.3.4-1. + +**Table 7.1.3.2.4.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.3.2.4.3.4-2 and the response data structures and response codes specified in table 7.1.3.2.4.3.4-3. + +**Table 7.1.3.2.4.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.1.3.2.4.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual VAL service area change event(s) subscription resource matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI of the resource located in an alternative LM server.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.3.2.4.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM server. | + +**Table 7.1.3.2.4.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative LM server. | + +## 7.1.3.3 Notifications + +### 7.1.3.3.1 General + +**Table 7.1.3.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|--------------|---------------------------------|-----------------------------------------------| +| VAL Service Area Change Notification | {notifUri} | POST | Notify on changes of the VAL service area(s). | + +### 7.1.3.3.2 Individual Unicast Monitoring Notification + +#### 7.1.3.3.2.1 Description + +#### 7.1.3.3.2.2 Notification definition + +Callback URI: {notifUri} + +This method shall support the URI query parameters specified in table 7.1.3.3.2.2-1. + +**Table 7.1.3.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.1.3.3.2.2-2 and the response data structures and response codes specified in table 7.1.3.3.2.2-3. + +**Table 7.1.3.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|------------------------------------------------| +| ValServiceAreaNotif | M | 1 | Represents the reported VAL service area data. | + +**Table 7.1.3.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The notification is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection.

The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.1.3.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +**Table 7.1.3.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +## 7.1.3.4 Data Model + +### 7.1.3.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.1.3.4.1-1 specifies the data types defined specifically for the SS\_VALServiceAreaConfiguration API service. + +**Table 7.1.3.4.1-1: SS\_VALServiceAreaConfiguration API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------|-----------------|-----------------------------------------------------------------------|---------------| +| ValServiceArea | 7.1.3.4.2.2 | Represents the VAL service area. | | +| ValServiceAreaReq | 7.1.3.4.2.3 | Represents the VAL service area configuration/update/delete request. | | +| ValServiceAreaData | 7.1.3.4.2.4 | Represents the VAL service area retrieval information. | | +| ValServiceAreaResp | 7.1.3.4.2.5 | Represents the VAL service area configuration/update/delete response. | | +| ValServiceAreaSubsc | 7.1.3.4.2.6 | Represents the VAL service area change event(s) subscription. | | +| ValServiceAreaEventType | 7.1.3.4.2.7 | Represents the VAL service area change event type. | | +| ValServiceAreaNotif | 7.1.3.4.2.8 | Represents the VAL service area change event(s) notification. | | +| ValServiceAreaEventInfo | 7.1.3.4.2.9 | Represents the VAL service area change event(s) content. | | +| ValServiceAreaEvent | 7.1.3.4.3.3 | Represents the VAL service area change event. | | +| ValServiceAreaSubscPatch | 7.1.3.4.2.10 | Represents the VAL service area change event(s) modification request. | | + +Table 7.1.3.4.1-2 specifies data types re-used by the SS\_VALServiceAreaConfiguration API service. + +**Table 7.1.3.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| DurationSec | 3GPP TS 29.571 [21] | Used to indicate the subscription duration. | | +| LocationArea5G | 3GPP TS 29.122 [3] | Used to indicate the location information. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.1.3.6-1. | | +| Uri | 3GPP TS 29.571 [21] | Used to indicate the notification URI. | | + +## 7.1.3.4.2 Structured data types + +## 7.1.3.4.2.1 Introduction + +## 7.1.3.4.2.2 Type: ValServiceArea + +**Table 7.1.3.4.2.2-1: Definition of type ValServiceArea** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| valSvcAreaId | ValSvcAreaId | M | 1 | Represents the VAL service area ID. | | +| locations | array(LocationArea5G) | M | 1..N | Represents the locations associated with the VAL service area. (NOTE) | | + +NOTE: The "nwAreaInfo" attribute within the LocationArea5G data type provided within this attribute is not applicable and shall not be present. + +Editor's note: The alignment of the VAL service area ID with ValSvcAreaId data type across the specification is TBD. + +## 7.1.3.4.2.3 Type: ValServiceAreaReq + +**Table 7.1.3.4.2.3-1: Definition of type ValServiceAreaReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| valSvcAreas | array(ValServiceArea) | M | 1..N | Represents the VAL service area(s). | | +| suppFeat | Supported Features | C | 0..1 | Represents the supported features.

This attribute shall be provided when feature negotiation needs to take place. | | + +## 7.1.3.4.2.4 Type: ValServiceAreaData + +**Table 7.1.3.4.2.4-1: Definition of type ValServiceAreaData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valSvcAreas | array(ValServiceArea) | O | 1..N | Represents the requested VAL service area(s).

If this attribute is not present, this means that no VAL service data instance satisfies the provided query parameter(s) in the request. | | +| suppFeats | Supported Features | O | 0..1 | Used to negotiate the applicability of optional features defined in table 7.1.3.6-1. | | + +## 7.1.3.4.2.5 Type: ValServiceAreaResp + +**Table 7.1.3.4.2.5-1: Definition of type ValServiceAreaResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| valSvcAreaIds | array(string) | M | 1..N | Represents the successfully handled VAL service area ID(s). | | +| suppFeat | Supported Features | C | 0..1 | Represents the supported features.

This attribute shall be provided when feature negotiation needs to take place. | | + +7.1.3.4.2.6 Type: ValServiceAreaSubsc + +**Table 7.1.3.4.2.6-1: Definition of type ValServiceAreaSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(ValServiceAreaEventType) | M | 1..N | Represents the subscribed VAL service area change event(s). | | +| notifUri | Uri | M | 1 | Indicates the URI towards which the notification should be delivered. | | +| subscDur | DurationSec | O | 0..1 | Indicates the subscription duration. If omitted, there is no time limit. | | +| suppFeat | SupportedFeatures | C | 0..1 | Represents the supported features.

This attribute shall be provided when feature negotiation needs to take place. | | + +7.1.3.4.2.7 Type: ValServiceAreaEventType + +**Table 7.1.3.4.2.7-1: Definition of type ValServiceAreaEventType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|------------------------------------------------------------------|---------------| +| event | ValServiceAreaEvent | M | 1 | Represents the requested VAL service area change event. | | +| valSvcAreaIds | array(string) | M | 1..N | Represents the VAL service area ID(s) associated with the event. | | + +7.1.3.4.2.8 Type: ValServiceAreaNotif + +**Table 7.1.3.4.2.8-1: Definition of type ValServiceAreaNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------------|---|-------------|----------------------------------------------------------|---------------| +| valSvcAreaContents | array(ValServiceAreaEventInfo) | M | 1..N | Represents the VAL service area change event(s) content. | | + +7.1.3.4.2.9 Type: ValServiceAreaEventContentInfo + +**Table 7.1.3.4.2.9-1: Definition of type ValServiceAreaEventInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | ValServiceAreaEvent | M | 1 | Represents the VAL service area change event. | | +| valSvcAreas | array(ValServiceArea) | C | 1..N | Represents the VAL service area(s) associated with the event.

This attribute shall be provided if the "event" is "UPDATE". | | +| valSvcAreaIds | array(string) | C | 1..N | Represents the VAL service area ID(s) associated with the event.

This attribute shall be provided if the "event" is "DELETE". | | + +## 7.1.3.4.2.10 Type: ValServiceAreaSubscPatch + +**Table 7.1.3.4.2.10-1: Definition of type ValServiceAreaSubscPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|-----------------------------------------------------------------------|---------------| +| events | array(ValServiceAreaEventType) | O | 1..N | Represents the subscribed VAL service area change event(s). | | +| notifUri | Uri | O | 0..1 | Indicates the URI towards which the notification should be delivered. | | +| subscDur | DurationSec | O | 0..1 | Indicates the subscription duration. | | + +## 7.1.3.4.3 Simple data types and enumerations + +## 7.1.3.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 7.1.3.4.3.2 Simple data types + +The simple data types defined in table 7.1.3.4.3.2-1 shall be supported. + +**Table 7.1.3.4.3.2-1: Simple data types** + +| Type name | Description | +|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValSvcAreaId | Represents the VAL Service Area identifier encoded as a string and generated either based on VAL Server ID or using the Universally Unique Identifier (UUID) version 4 as described in IETF RFC 4122 [40]. | + +## 7.1.3.4.3.3 Enumeration: ValServiceAreaEvent + +**Table 7.1.3.4.3.3-1: Enumeration ValServiceAreaEvent** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------|---------------| +| UPDATE | Indicates that the VAL service area change event is VAL service area update. | | +| DELETE | Indicates that the VAL service area change event is VAL service area delete. | | + +## 7.1.3.5 Error Handling + +## 7.1.3.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.1.3.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_VALServiceAreaConfiguration API. + +## 7.1.3.5.3 Application Errors + +The application errors defined for SS\_VALServiceAreaConfiguration API are listed in table 7.1.3.5.3-1. + +**Table 7.1.3.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| n/a | | | | + +### 7.1.3.6 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.1.3.6-1 lists the supported features for SS\_VALServiceAreaConfiguration API. + +**Table 7.1.3.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| n/a | | | + +## 7.2 Group management APIs + +### 7.2.1 SS\_GroupManagement API + +#### 7.2.1.1 API URI + +The SS\_GroupManagement service shall use the SS\_GroupManagement API. + +The request URIs used in HTTP requests from the VAL server towards the Group management server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-gm". +- The shall be "v1". +- The shall be set as described in clause 7.2.1.2 + +#### 7.2.1.2 Resources + +##### 7.2.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.2.1.2.1-1 depicts the resource URIs structure for the SS\_GroupManagement API. + +![Diagram showing the hierarchical structure of Resource URIs for the SS_GroupManagement API. The root URI is {apiRoot}/ss-gm/. It branches to /group-documents, which in turn branches to /{groupDocId}.](1dc67137b361f5ed5f660a282155a4ed_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-gm/"] --> GroupDocs["/group-documents"] + GroupDocs --> GroupDocId["/{groupDocId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the SS\_GroupManagement API. The root URI is {apiRoot}/ss-gm/. It branches to /group-documents, which in turn branches to /{groupDocId}. + +**Figure 7.2.1.2.1-1: Resource URI structure of the SS\_GroupManagement API** + +Table 7.2.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.2.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|-------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VAL Group Documents | /group-documents | POST | Create a new VAL group document. | +| | | GET | Retrieve VAL group documents according to the query parameters. If there are no query parameters, do not fetch any VAL group document. | +| Individual VAL Group Document | /group-documents/{groupDocId} | GET | Retrieve an individual VAL group's membership and configuration information according to query parameter on the resource identified by {groupDocId}. If there are no query parameter, fetch the whole VAL group document resource identified by {groupDocId}. | +| | | PUT | Update an individual VAL group's membership and configuration information identified by {groupDocId}. | +| | | PATCH | Partially update an individual VAL group's membership and configuration information identified by {groupDocId} | +| | | DELETE | Deletes an individual VAL group's membership and configuration information identified by {groupDocId}. | + +## 7.2.1.2.2 Resource: VAL Group Documents + +### 7.2.1.2.2.1 Description + +The VAL Group Documents resource represents all the VAL group documents that are created at a given group management server. + +### 7.2.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-gm//group-documents + +This resource shall support the resource URI variables defined in the table 7.2.1.2.2.2-1. + +**Table 7.2.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +### 7.2.1.2.2.3 Resource Standard Methods + +#### 7.2.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 7.2.1.2.2.3.1-1. + +**Table 7.2.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.2.1.2.2.3.1-3. + +**Table 7.2.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|----------------------------------------------------| +| VALGroupDocument | M | 1 | Details of the VAL group that needs to be created, | + +**Table 7.2.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------| +| VALGroupDocument | M | 1 | 201 Created | VAL group created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.2.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-gm//group-documents/{groupDocId} | + +#### 7.2.1.2.2.3.2 GET + +This operation retrieves VAL group documents satisfying filter criteria. This method shall support the URI query parameters specified in table 7.2.1.2.2.3.2-1. + +**Table 7.2.1.2.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------| +| val-group-id | string | O | 0..1 | String identifying the VAL group. | +| val-service-id | string | O | 0..1 | String identifying the VAL service. | + +This method shall support the request data structures specified in table 7.2.1.2.2.3.2-2 and the response data structures and response codes specified in table 7.2.1.2.2.3.2-3. + +**Table 7.2.1.2.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.1.2.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(VALGroup Document) | M | 0..N | 200 OK | List of VAL group documents. This response shall include VAL group documents matching the query parameters provided in the request. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.2.1.2.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +**Table 7.2.1.2.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +#### 7.2.1.2.2.4 Resource Custom Operations + +None. + +#### 7.2.1.2.3 Resource: Individual VAL Group Document + +##### 7.2.1.2.3.1 Description + +The Individual VAL Group Document resource represents an individual group document that is created at a given group management server. + +##### 7.2.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-gm//group-documents/{groupDocId} + +This resource shall support the resource URI variables defined in the table 7.2.1.2.3.2-1. + +**Table 7.2.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|---------------------------------------------------| +| apiRoot | string | See clause 6.5 | +| groupDocId | string | Represents an individual group document resource. | + +## 7.2.1.2.3.3 Resource Standard Methods + +## 7.2.1.2.3.3.1 GET + +This operation retrieves VAL group information satisfying filter criteria. This method shall support the URI query parameters specified in table 7.2.1.2.3.3.1-1. + +**Table 7.2.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| group-members | boolean | O | 0..1 | When set to 'true', it indicates the group management server to send the members list information of the VAL group. Set to false or omitted otherwise. | +| group-configuration | boolean | O | 0..1 | When set to 'true', it indicates the group management server to send the configuration information of the VAL group. Set to false or omitted otherwise. | + +This method shall support the request data structures specified in table 7.2.1.2.3.3.1-2 and the response data structures and response codes specified in table 7.2.1.2.3.3.1-3. + +**Table 7.2.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALGroupDocument | M | 1 | 200 OK | The VAL group information based on the request from the VAL server. This response shall include VAL group members list if group-members flag is set to true in the request, VAL group configuration information if the group-configuration flag is set to true in the request, VAL group identifier, whole VAL group document resource if both group-members and group-configuration flags are omitted/set to false in the request. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.2.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +**Table 7.2.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +#### 7.2.1.2.3.3.2 PUT + +This operation updates the VAL group document. This method shall support the URI query parameters specified in table 7.2.1.2.3.3.2-1. + +**Table 7.2.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.1.2.3.3.2-2 and the response data structures and response codes specified in table 7.2.1.2.3.3.2-3. + +**Table 7.2.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------| +| VALGroupDocument | M | 1 | Updated details of the VAL group document. | + +**Table 7.2.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALGroupDocument | M | 1 | 200 OK | The VAL group document updated successfully and the updated VAL group document returned in the response. | +| n/a | | | 204 No Content | The VAL group document updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.2.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +**Table 7.2.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +#### 7.2.1.2.3.3.3 DELETE + +This operation deletes the VAL group document. This method shall support the URI query parameters specified in table 7.2.1.2.3.3.3-1. + +**Table 7.2.1.2.3.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.1.2.3.3.3-2 and the response data structures and response codes specified in table 7.2.1.2.3.3.3-3. + +**Table 7.2.1.2.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.1.2.3.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual VAL group document matching the groupDocId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative group management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.2.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +**Table 7.2.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative group management server. | + +#### 7.2.1.2.3.3.4 PATCH + +This method shall support the URI query parameters specified in table 7.2.1.2.3.3.4-1. + +**Table 7.2.1.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.2.1.2.3.3.4-2 and the response data structures and response codes specified in table 7.2.1.2.3.3.4-3. + +**Table 7.2.1.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------------------------------------------------| +| VALGroupDocumentPatch | M | 1 | Contains the modifications to be applied to the Individual VAL Group Document resource. | + +**Table 7.2.1.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALGroupDocument | M | 1 | 200 OK | Individual VAL Group Document resource is modified successfully and representation of the modified VAL Group Document resource is returned. | +| n/a | | | 204 No Content | The Individual VAL Group Document resource is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.2.1.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.2.1.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +#### 7.2.1.2.3.4 Resource Custom Operations + +None. + +### 7.2.1.3 Notifications + +None. + +### 7.2.1.4 Data Model + +#### 7.2.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.2.1.4.1-1 specifies the data types defined specifically for the SS\_GroupManagement API service. + +**Table 7.2.1.4.1-1: SS\_GroupManagement API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------------|-----------------|----------------------------------------------------------------------------|---------------| +| VALGroupDocument | 7.2.1.4.2.2 | Represents details of the VAL group document information. | | +| VALGroupDocumentPatch | 7.2.1.4.2.3 | Represent details of the partial update of VAL group document information. | PatchUpdate | + +Table 7.2.1.4.1-2 specifies data types re-used by the SS\_GroupManagement API service. + +**Table 7.2.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|---------------------------------------------------------------------------------------------|---------------| +| ExternalGroupId | 3GPP TS 29.122 [3] | Used to represent the the external group identifier related to the member UEs of the group. | | +| LocationArea5G | 3GPP TS 29.122 [3] | Represents location information. | | +| LocationInfo | 3GPP TS 29.122 [3] | The location information related to VAL group. | | +| PduSessionType | 3GPP TS 29.571 [21] | Identifies PDU Session Type. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.2.1.6-1. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID, to which location reporting applies. | | + +## 7.2.1.4.2 Structured data types + +## 7.2.1.4.2.1 Introduction + +## 7.2.1.4.2.2 Type: VALGroupDocument + +**Table 7.2.1.4.2.2-1: Definition of type VALGroupDocument** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valGroupId | string | M | 1 | This is VAL group identity (VAL group ID) as per TS 23.434 [2], which is a unique identifier within the VAL service that represents a VAL group, set of VAL users or VAL UEs according to the VAL service. | | +| grpDesc | string | O | 0..1 | Text description of the VAL group. | | +| members | array(ValTargetUe) | O | 1..N | List of VAL User IDs or VAL UE IDs, which are members of the VAL group. | | +| valGrpConf | string | O | 0..1 | Configuration data for the VAL group. Shall be present in HTTP POST request message from VAL server to Group Management server. | | +| valServiceIds | array(string) | O | 1..N | List of VAL services whose communications enabled on the group. | | +| suppFeat | Supported Features | O | 0..1 | Used to negotiate the supported optional features of the API as described in clause 6.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | +| resUri | Uri | O | 0..1 | The URI for individual VAL group document resource. (NOTE 1) | | +| locInfo | LocationInfo | O | 0..1 | The location information related to the VAL group. This information is used to determine the members of the group. | | +| addLocInfo | LocationArea5G | O | 0..1 | The additional location information related to the VAL group. This information is used to determine the members of the group. | | +| valSvcAreaId | string | O | 0..1 | Identifier of the VAL service area. | ValSrvArea | +| extGrpId | ExternalGroupId | O | 0..1 | The external group identifier, identifying the member UEs of the VAL group at the 3GPP core network. | | +| com5GLanType | PduSessionType | O | 0..1 | Identifies the 5G LAN-Type communication. (NOTE 2) | | +| valSvcInf | string | O | 0..1 | VAL service specific information that may be present during group membership update and in the notification of the events "GM_GROUP_INFO_CHANGE" and "GM_GROUP_CREATE". | | + +NOTE 1: The "resUri" attribute is not modifiable by the VAL server. + +NOTE 2: The enumeration value "UNSTRUCTURED" in data type "PduSessionType" is not applicable. + +Editor's note: The cardinality and the presence condition of the "valSvcAreaId" attribute is FFS and to be aligned based on stage-2 requirements. + +## 7.2.1.4.2.3 Type: VALGroupDocumentPatch + +**Table 7.2.1.4.2.3-1: Definition of type VALGroupDocumentPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| grpDesc | string | O | 0..1 | Text description of the VAL group. | | +| members | array(ValTargetUe) | O | 1..N | List of VAL User IDs or VAL UE IDs, which are members of the VAL group. | | +| valGrpConf | string | O | 0..1 | Configuration data for the VAL group. | | +| valServiceIds | array(string) | O | 1..N | List of VAL services whose communications enabled on the group. | | +| locInfo | LocationInfo | O | 0..1 | The location information related to the VAL group. This information is used to determine the members of the group. | | +| addLocInfo | LocationArea5G | O | 0..1 | The additional location information related to the VAL group. This information is used to determining the members of the group. | | +| valSvcAreaId | string | O | 0..1 | Identifier of the VAL service area. | ValSrvArea | +| extGrpId | ExternalGroupId | O | 0..1 | The external group identifier, identifying the member UEs of the VAL group at the 3GPP core network. | | +| com5GLanType | PduSessionType | O | 0..1 | Identifies the 5G LAN-Type communication. (NOTE 1) | | + +NOTE 1: The enumeration value "UNSTRUCTURED" in data type "PduSessionType" is not applicable. + +Editor's note: The cardinality and the presence condition of the "valSvcAreaId" attribute is FFS and to be aligned based on stage-2 requirements. + +## 7.2.1.4.3 Simple data types and enumerations + +None. + +## 7.2.1.5 Error Handling + +## 7.2.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.2.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_GroupManagement API. + +## 7.2.1.5.3 Application Errors + +The application errors defined for SS\_GroupManagement API are listed in table 7.2.1.5.3-1. + +**Table 7.2.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 7.2.1.6 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.2.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | PatchUpdate | Indicates the support of the PATCH method for updating an Individual VAL Group Document resource. | +| 2 | enNB1 | This feature indicates the support of enhancements to this application layer API in Rel-18. | +| 3 | ValSrvArea | This feature indicates the support of VAL service area ID functionality as part of the phase-3 of the enhancements to the SEAL framework.

The following functionalities are supported:
- Support the usage of the VAL service area identifier to identify a VAL service area. | + +## 7.3 Configuration management APIs + +### 7.3.1 SS\_UserProfileRetrieval API + +#### 7.3.1.1 API URI + +The SS\_UserProfileRetrieval service shall use the SS\_UserProfileRetrieval API. + +The request URIs used in HTTP requests from the VAL server towards the Configuration management server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-upr". +- The shall be "v1". +- The shall be set as described in clause 7.3.1.2. + +#### 7.3.1.2 Resources + +##### 7.3.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.3.1.2.1-1 depicts the resource URIs structure for the SS\_UserProfileRetrieval API. + +![Diagram showing the hierarchical structure of the Resource URI for the SS_UserProfileRetrieval API. The root is {apiRoot}/ss-upr/, which branches to /val-services, which in turn branches to /{valServiceId}.](02d7901f2a570d0c08f8b2b310ec6826_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-upr/"] --> ValServices["/val-services"] + ValServices --> ValServiceId["/{valServiceId}"] + +``` + +Diagram showing the hierarchical structure of the Resource URI for the SS\_UserProfileRetrieval API. The root is {apiRoot}/ss-upr/, which branches to /val-services, which in turn branches to /{valServiceId}. + +**Figure 7.3.1.2.1-1: Resource URI structure of the SS\_UserProfileRetrieval API** + +Table 7.3.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.3.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|---------------|---------------------------------|----------------------------------------------------| +| VAL Services | /val-services | GET | Retrieve VAL User or VAL UE's profile information. | + +### 7.3.1.2.2 Resource: VAL Services + +#### 7.3.1.2.2.1 Description + +The VAL Services resource represents all the VAL services that are created at a given configuration management server. + +#### 7.3.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-upr//val-services + +This resource shall support the resource URI variables defined in the table 7.3.1.2.2.2-1. + +**Table 7.3.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.3.1.2.2.3 Resource Standard Methods + +##### 7.3.1.2.2.3.1 GET + +This operation retrieves VAL User or VAL UE profile information satisfying the filter criteria. This method shall support the URI query parameters specified in table 7.3.1.2.2.3.1-1. + +**Table 7.3.1.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------| +| val-tgt-ue | ValTargetUe | M | 1 | Identifying a VAL target UE. | +| val-service-id | string | O | 0..1 | String identifying a VAL service. | + +This method shall support the request data structures specified in table 7.3.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.3.1.2.2.3.1 -3. + +**Table 7.3.1.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.3.1.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(ProfileDoc) | M | 0..N | 200 OK | List of VAL User / VAL UE profile documents. This response shall include user profile information matching the query parameters provided in the request. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative configuration management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative configuration management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.3.1.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative configuration management server. | + +**Table 7.3.1.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative configuration management server. | + +#### 7.3.1.2.2.4 Resource Custom Operations + +None. + +#### 7.3.1.3 Notifications + +None. + +#### 7.3.1.4 Data Model + +##### 7.3.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.3.1.4.1-1 specifies the data types defined specifically for the SS\_UserProfileRetrieval API service. + +**Table 7.3.1.4.1-1: SS\_UserProfileRetrieval API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------|-----------------|------------------------------------------------------------------------------|---------------| +| ProfileDoc | 7.3.1.4.2.2 | Represents the profile information associated with VAL user ID or VAL UE ID. | | +| ValTargetUe | 7.3.1.4.2.3 | Represents the information identifying a VAL user ID or VAL UE ID. | | + +Table 7.3.1.4.1-2 specifies data types re-used by the SS\_UserProfileRetrieval API service. + +**Table 7.3.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------|-----------|----------|---------------| +| n/a | | | | + +### 7.3.1.4.2 Structured data types + +#### 7.3.1.4.2.1 Introduction + +#### 7.3.1.4.2.2 Type: ProfileDoc + +**Table 7.3.1.4.2.2-1: Definition of type ProfileDoc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------|---|-------------|-----------------------------------------------|---------------| +| profileInformation | string | M | 1 | Profile information associated with valTgtUe. | | +| valTgtUe | ValTargetUe | M | 1 | Unique identifier of a VAL user or a VAL UE. | | + +#### 7.3.1.4.2.3 Type: ValTargetUe + +**Table 7.3.1.4.2.3-1: Definition of type ValTargetUe** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------|-----------|---|-------------|----------------------------------|---------------| +| valUserId | string | O | 0..1 | Unique identifier of a VAL user. | | +| valUeId | string | O | 0..1 | Unique identifier of a VAL UE. | | +| NOTE: Either "valUserId" or "valUeId" shall be provided. | | | | | | + +### 7.3.1.4.3 Simple data types and enumerations + +None. + +## 7.3.1.5 Error Handling + +### 7.3.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +### 7.3.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_UserProfileRetrieval API. + +### 7.3.1.5.3 Application Errors + +The application errors defined for SS\_UserProfileRetrieval API are listed in table 7.3.1.5.3-1. + +**Table 7.3.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.3.1.6 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.3.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 7.3.2 SS\_VALServiceData API + +### 7.3.2.1 API URI + +The SS\_VALServiceData service shall use the SS\_VALServiceData API. + +The request URIs used in HTTP requests from the VAL server towards the CM Server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-vsd". +- The shall be "v1". +- The shall be set as described in clause 7.3.1.2. + +### 7.3.2.2 Resources + +#### 7.3.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.3.2.2.1-1 depicts the resource URIs structure for the SS\_VALServiceData API. + +![Diagram showing the resource URI structure for the SS_VALServiceData API. A box contains the placeholder '{apiRoot}/ss-vsd/'. A line descends from the bottom of this box to a rounded rectangle containing the path '/val-servdata'.](cd359a6b82fb57f2445df4087b8b1423_img.jpg) + +``` + +graph TD + A["{apiRoot}/ss-vsd/"] --> B[/val-servdata] + +``` + +Diagram showing the resource URI structure for the SS\_VALServiceData API. A box contains the placeholder '{apiRoot}/ss-vsd/'. A line descends from the bottom of this box to a rounded rectangle containing the path '/val-servdata'. + +**Figure 7.3.2.2.1-1: Resource URI structure of the SS\_VALServiceData API** + +Table 7.3.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.3.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|---------------|---------------------------------|---------------------------------------------------------------------------| +| VAL Service Data Sets | /val-servdata | GET | Retrieve the VAL service data according to the provided query parameters. | + +### 7.3.2.2.2 Resource: VAL Service Data Sets + +#### 7.3.2.2.2.1 Description + +The VAL Service Data Sets resource represents all the VAL service data resources managed by the CM Server. + +#### 7.3.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-vsd//val-servdata + +This resource shall support the resource URI variables defined in the table 7.3.2.2.2.2-1. + +**Table 7.3.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.3.2.2.2.3 Resource Standard Methods + +##### 7.3.2.2.2.3.1 GET + +This operation retrieves the VAL service data satisfying the filter criteria. This method shall support the URI query parameters specified in table 7.3.2.2.2.3.1-1. + +**Table 7.3.2.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|---------------------------------------------------------------------| +| val-tgt-ues | array(ValTargetUe) | O | 1..N | Identifying the list of the target VAL UE(s) or VAL user(s). (NOTE) | +| val-service-ids | array(string) | O | 1..N | Identifying the list of the target VAL service(s). (NOTE) | +| supp-feats | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | + +NOTE: At least one of these query parameters shall be present, unless the request targets to retrieve all the VAL Service Data Sets managed by the CM Server. + +**Editor's Note:** Whether either the VAL UE(s) or the VAL user(s) can be provided in the query string, or combinations of VAL UE(s) and the VAL user(s) can be provided in the query string of this GET method is FFS and pending stage 2 feedback. + +This method shall support the request data structures specified in table 7.3.2.2.2.3.1-2 and the response data structures and response codes specified in table 7.3.2.2.2.3.1-3. + +**Table 7.3.2.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.3.2.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValServDataResp | M | 1 | 200 OK | Represents the requested VAL service data. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CM Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative CM Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +Editor's Note: The application errors in the SS\_VALServiceData API are FFS. + +**Table 7.3.2.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CM Server. | + +**Table 7.3.2.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative CM server. | + +#### 7.3.2.2.2.4 Resource Custom Operations + +None. + +#### 7.3.2.3 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +#### 7.3.2.4 Notifications + +There are no notifications defined for this API in this release of the specification. + +#### 7.3.2.5 Data Model + +##### 7.3.2.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.3.2.5.1-1 specifies the data types defined specifically for the SS\_VALServiceData API service. + +**Table 7.3.2.5.1-1: SS\_VALServiceData API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------|-----------------|--------------------------------------------------------------|---------------| +| ValServDataResp | 7.3.2.5.2.2 | Represents the container for the requested VAL service data. | | +| ValServiceData | 7.3.2.5.2.3 | Represents the VAL service data. | | + +Table 7.3.2.5.1-2 specifies data types re-used by the SS\_VALServiceData API service. + +**Table 7.3.2.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| ValTargetUe | 7.3.1.4.2.3 | Used to indicate the VAL user ID or VAL UE ID. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.3.2.7-1. | | + +### 7.3.2.5.2 Structured data types + +#### 7.3.2.5.2.1 Introduction + +#### 7.3.2.5.2.2 Type: ValServDataResp + +**Table 7.3.2.5.2.2-1: Definition of type ValServDataResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valServData | array(ValServiceData) | O | 1..N | Contains the requested VAL service data.

If this attribute is not present, this means that no VAL service data instance satisfies the provided query parameter(s) in the request. | | +| suppFeats | SupportedFeatures | O | 0..1 | Used to negotiate the applicability of optional features defined in table 7.3.2.7-1. | | + +#### 7.3.2.5.2.3 Type: ValServiceData + +**Table 7.3.2.5.2.3-1: Definition of type ValServiceData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| valTgtUe | ValTargetUe | M | 1 | Unique identifier of a VAL user or a VAL UE. | | +| valServIds | array(string) | M | 1..N | List of the VAL services associated with the VAL user or VAL UE defined in the "valTgtUe" attribute. | | +| valServSpecInfo | string | O | 0..1 | Contains the VAL service specific information. | | + +### 7.3.2.5.3 Simple data types and enumerations + +#### 7.3.2.5.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +### 7.3.2.5.3.2 Simple data types + +The simple data types defined in table 7.3.2.5.3.2-1 shall be supported. + +**Table 7.3.2.5.3.2-1: Simple data types** + +| Type name | Description | +|-----------|-------------| +| | | +| | | + +## 7.3.2.6 Error Handling + +### 7.3.2.6.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +### 7.3.2.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_VALServiceData API. + +### 7.3.2.6.3 Application Errors + +The application errors defined for SS\_VALServiceData API are listed in table 7.3.2.6.3-1. + +**Table 7.3.2.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 7.3.2.7 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.3.2.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +# 7.4 Network resource management APIs + +## 7.4.1 SS\_NetworkResourceAdaptation API + +### 7.4.1.1 API URI + +The SS\_NetworkResourceAdaptation service shall use the SS\_NetworkResourceAdaptation API. + +The request URIs used in HTTP requests from the VAL server towards the NRM server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-nra". +- The shall be "v1". + +- The shall be set as described in clause 7.4.1.2 + +## 7.4.1.2 Resources + +### 7.4.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.4.1.2.1-1 depicts the resource URIs structure for the SS\_NetworkResourceAdaptation API. + +![A hierarchical diagram showing the resource URI structure of the SS_NetworkResourceAdaptation API. The root is {apiRoot}/ss-nra/. It branches into five main resources: /multicast-subscriptions, /mbs-resources, /unicast-subscriptions, /tsc-streams, and /tsc-stream-availability. /multicast-subscriptions has a sub-resource /{multiSubId}. /mbs-resources has a sub-resource /{mbsResId}. /unicast-subscriptions has a sub-resource /{uniSubId}. /tsc-streams has a sub-resource /{valStreamId}. /tsc-stream-availability is a leaf resource. Below /tsc-stream-availability is /bdt-policy-configs, which has a sub-resource /{bdtPolConfigId}.](c21bad844b5cb6026c067a1f43ce67c3_img.jpg) + +{apiRoot}/ss-nra/ + +``` +graph TD; Root["{apiRoot}/ss-nra/"] --- MS["/multicast-subscriptions"]; Root --- MR["/mbs-resources"]; Root --- US["/unicast-subscriptions"]; Root --- TS["/tsc-streams"]; Root --- TSA["/tsc-stream-availability"]; Root --- BPC["/bdt-policy-configs"]; MS --- MSI["/{multiSubId}"]; MR --- MRI["/{mbsResId}"]; US --- USI["/{uniSubId}"]; TS --- TSI["/{valStreamId}"]; BPC --- BPCI["/{bdtPolConfigId}"]; +``` + +A hierarchical diagram showing the resource URI structure of the SS\_NetworkResourceAdaptation API. The root is {apiRoot}/ss-nra/. It branches into five main resources: /multicast-subscriptions, /mbs-resources, /unicast-subscriptions, /tsc-streams, and /tsc-stream-availability. /multicast-subscriptions has a sub-resource /{multiSubId}. /mbs-resources has a sub-resource /{mbsResId}. /unicast-subscriptions has a sub-resource /{uniSubId}. /tsc-streams has a sub-resource /{valStreamId}. /tsc-stream-availability is a leaf resource. Below /tsc-stream-availability is /bdt-policy-configs, which has a sub-resource /{bdtPolConfigId}. + +**Figure 7.4.1.2.1-1: Resource URI structure of the SS\_NetworkResourceAdaptation API** + +Table 7.4.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.4.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------|---------------------------------------|---------------------------------|-----------------------------------------------------------------------------| +| Multicast Subscriptions | /multicast-subscriptions | POST | Create a new Individual Multicast Subscription resource. | +| Individual Multicast Subscription | /multicast-subscriptions/{multiSubId} | GET | Read an Individual Multicast Subscription resource. | +| | | DELETE | Remove an Individual Multicast Subscription resource. | +| MBS Resources | /mbs-resources | POST | Request the creation of an MBS resource. | +| Individual MBS Resource | /mbs-resources/{mbsResId} | GET | Request the retrieval of an existing "Individual MBS Resource" resource. | +| | | PUT | Request the update of an existing "Individual MBS Resource" resource. | +| | | PATCH | Request the modification of an existing "Individual MBS Resource" resource. | +| | | DELETE | Request the deletion of an existing "Individual MBS Resource" resource. | +| | | Activate | Request the activation of an existing MBS Resource. | +| | | Deactivate | Request the deactivation of an existing MBS Resource. | +| Unicast Subscriptions | /unicast-subscriptions | POST | Create a new Individual Unicast Subscription resource. | +| Individual Unicast Subscription | /unicast-subscriptions/{uniSubId} | GET | Read an Individual Unicast Subscription resource. | +| | | DELETE | Remove an Individual Unicast Subscription resource. | +| TSC Stream Availability | /tsc-stream-availability | GET | Retrieve TSC stream availability information. | +| TSC Streams | /tsc-streams | GET | Retrieve TSC stream information. | +| Individual TSC Stream | /tsc-streams/{valStreamId} | GET | Read an Individual TSC stream resource. | +| | | PUT | Create a new Individual TSC stream resource. | +| | | DELETE | Remove an Individual TSC stream resource. | +| | | GET | Read an Individual TSC stream resource. | +| BDT Policy Configurations | /bdt-policy-configs | POST | Create a new background data transfer policy configuration. | +| Individual BDT Policy Configuration | /bdt-policy-configs/{bdtPolConfigId} | GET | Read an existing background data transfer policy configuration. | +| | | DELETE | Delete an existing background data transfer configuration. | + +Editor's Note: Whether the HTTP PUT/PATCH is needed for BDT Policy Configurations is FFS. + +#### 7.4.1.2.2 Resource: Multicast Subscriptions + +##### 7.4.1.2.2.1 Description + +##### 7.4.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//multicast-subscriptions + +This resource shall support the resource URI variables defined in table 7.4.1.2.2.2-1. + +**Table 7.4.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.4.1.2.2.3 Resource Standard Methods + +##### 7.4.1.2.2.3.1 POST + +**Table 7.4.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.2.3.1-3. + +**Table 7.4.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-------------| +| MulticastSubscription | M | 1 | | + +**Table 7.4.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------| +| MulticastSubscription | M | 1 | 201 Created | | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.4.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra//multicast-subscriptions/{multiSubId} | + +#### 7.4.1.2.2.4 Resource Custom Operations + +None. + +#### 7.4.1.2.3 Resource: Individual Multicast Subscription + +##### 7.4.1.2.3.1 Description + +##### 7.4.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//multicast-subscriptions/{multiSubId} + +This resource shall support the resource URI variables defined in table 7.4.1.2.3.2-1. + +**Table 7.4.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|------------|-----------|----------------------------------------| +| apiRoot | string | 6.5 | +| multiSubId | string | The multicast subscription identifier. | + +#### 7.4.1.2.3.3 Resource Standard Methods + +##### 7.4.1.2.3.3.1 GET + +**Table 7.4.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.3.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.3.3.1-3. + +**Table 7.4.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MulticastSubscription | M | 1 | 200 OK | | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. + +**Table 7.4.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +## 7.4.1.2.3.3.2 DELETE + +**Table 7.4.1.2.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.3.3.2-2 and the response data structures and response codes specified in table 7.4.1.2.3.3.2-3. + +**Table 7.4.1.2.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Multicast Subscription resource was deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. + +**Table 7.4.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +## 7.4.1.2.3.4 Resource Custom Operations + +None. + +#### 7.4.1.2.4 Resource: Unicast Subscriptions + +##### 7.4.1.2.4.1 Description + +##### 7.4.1.2.4.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//unicast-subscriptions + +This resource shall support the resource URI variables defined in table 7.4.1.2.4.2-1. + +**Table 7.4.1.2.4.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +##### 7.4.1.2.4.3 Resource Standard Methods + +###### 7.4.1.2.4.3.1 POST + +**Table 7.4.1.2.4.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.4.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.4.3.1-3. + +**Table 7.4.1.2.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-------------| +| UnicastSubscription | M | 1 | | + +**Table 7.4.1.2.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------| +| UnicastSubscription | M | 1 | 201 Created | | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.4.1.2.4.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra//unicast-subscriptions/{uniSubId} | + +##### 7.4.1.2.4.4 Resource Custom Operations + +None. + +#### 7.4.1.2.5 Resource: Individual Unicast Subscription + +##### 7.4.1.2.5.1 Description + +##### 7.4.1.2.5.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//unicast-subscriptions/{uniSubId} + +This resource shall support the resource URI variables defined in table 7.4.1.2.5.2-1. + +**Table 7.4.1.2.5.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------|-----------|--------------------------------------| +| apiRoot | string | See clause 6.5. | +| uniSubId | string | The unicast subscription identifier. | + +##### 7.4.1.2.5.3 Resource Standard Methods + +###### 7.4.1.2.5.3.1 GET + +**Table 7.4.1.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.5.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.5.3.1-3. + +**Table 7.4.1.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UnicastSubscription | M | 1 | 200 OK | | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.4.1.2.5.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.5.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.5.3.2 DELETE + +**Table 7.4.1.2.5.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.5.3.2-2 and the response data structures and response codes specified in table 7.4.1.2.5.3.2-3. + +**Table 7.4.1.2.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.5.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual Unicast Subscription resource was deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. + +**Table 7.4.1.2.5.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.5.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.5.4 Resource Custom Operations + +None. + +#### 7.4.1.2.6 Resource: TSC Stream Availability + +##### 7.4.1.2.6.1 Description + +The TSC stream availability represent for TSC stream availability discovery with the given stream specification. + +##### 7.4.1.2.6.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//tsc-stream-availability + +This resource shall support the resource URI variables defined in table 7.4.1.2.6.2-1. + +**Table 7.4.1.2.6.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 6.5. | + +##### 7.4.1.2.6.3 Resource Standard Methods + +###### 7.4.1.2.6.3.1 GET + +This operation retrieves the TSC stream availability information. This method shall support the URI query parameters specified in table 7.4.1.2.6.3.1-1. + +**Table 7.4.1.2.6.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------|----------------------------|---|-------------|------------------------------------------------------------------------------------| +| stream-specs | array(StreamSpecification) | M | 1..N | The MAC address(es) of the source DS-TT port(s) and the destination DS-TT port(s). | + +This method shall support the request data structures specified in table 7.4.1.2.6.3.1-2 and the response data structure and response codes specified in table 7.4.1.2.6.3.1-3, table 7.4.1.2.6.3.1-4 and table 7.4.1.2.6.3.1-5. + +**Table 7.4.1.2.6.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.6.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(TscStream Availability) | M | 1..N | 200 OK | List of TSC stream availability information, each including the stream specification and list of traffic specifications. This response shall include stream specification matching the query parameters provided in the request. | +| N/A | O | 0..1 | 204 No Content | Indicates no stream specification matching with the query parameters, no TSC stream availability information. | +| N/A | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| N/A | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.1.2.6.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.6.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.6.4 Resource Custom Operations + +None. + +#### 7.4.1.2.7 Resource: TSC streams + +##### 7.4.1.2.7.1 Description + +The TSC streams represent the resources for TSC communication with the given stream specification. + +##### 7.4.1.2.7.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//tsc-streams + +This resource shall support the resource URI variables defined in table 7.4.1.2.7.2-1. + +**Table 7.4.1.2.7.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 6.5. | + +## 7.4.1.2.7.3 Resource Standard Methods + +## 7.4.1.2.7.3.1 GET + +This method shall support the URI query parameters specified in the table 7.4.1.2.7.3.1-1. + +**Table 7.4.1.2.7.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| val-stream-ids | array(string) | O | 1..N | Retrieval of all the TSC stream resources managed by the NRM server or the TSC Stream resource(s) identified by the VAL Stream ID(s). | + +This method shall support the request data structures specified in table 7.4.1.2.7.3.1-2 and the response data structure and response codes specified in table 7.4.1.2.7.3.1-3, table 7.4.1.2.7.3.1-4 and table 7.4.1.2.7.3.1-5. + +**Table 7.4.1.2.7.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.7.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(TscStream Data) | M | 1..N | 200 OK | Retrieval of TSC stream data information. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.1.2.7.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.7.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +## 7.4.1.2.7.4 Resource Custom Operations + +None. + +#### 7.4.1.2.8 Resource: Individual TSC Stream + +##### 7.4.1.2.8.1 Description + +##### 7.4.1.2.8.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra/{apiVersion}/tsc-streams/{valStreamId} + +This resource shall support the resource URI variables defined in table 7.4.1.2.8.2-1. + +**Table 7.4.1.2.8.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|-------------|-----------|----------------------------------------------| +| apiRoot | string | See clause 6.5. | +| valStreamId | string | The VAL Stream ID identifies the TSC stream. | + +##### 7.4.1.2.8.3 Resource Standard Methods + +###### 7.4.1.2.8.3.1 GET + +This operation retrieves an individual TSC stream information. This method shall support the URI query parameters specified in the table 7.4.1.2.8.3.1-1. + +**Table 7.4.1.2.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.8.3.1-2 and the response data structure and response codes specified in table 7.4.1.2.8.3.1-3, table 7.4.1.2.8.3.1-4 and table 7.4.1.2.8.3.1-5. + +**Table 7.4.1.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TscStreamData | M | 1 | 200 OK | | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.1.2.8.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.8.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.8.3.2 PUT + +This operation create an individual TSC stream identified by VAL Stream ID. This method shall support the URI query parameters specified in the table 7.4.1.2.8.3.2-1. + +**Table 7.4.1.2.8.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.8.3.2-2 and the response data structure and response codes specified in table 7.4.1.2.8.3.2-3 and table 7.4.1.2.8.3.2-4. + +**Table 7.4.1.2.8.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------------| +| TscStreamData | M | 1 | TSC stream creation request data from the VAL server to the NRM server. | + +**Table 7.4.1.2.8.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------| +| TscStreamData | M | 1 | 201 Created | TSC stream created data response from the NRM server to the VAL server. | +| NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. | | | | | + +**Table 7.4.1.2.8.3.2-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Location | String | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-nra//tsc-streams/{valStreamId} | + +#### 7.4.1.2.8.3.3 DELETE + +This operation deletes the individual TSC stream resource. This method shall support the URI query parameters specified in the table 7.4.1.2.8.3.3-1. + +**Table 7.4.1.2.8.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.8.3.3-2 and the response data structure and response codes specified in table 7.4.1.2.8.3.3-3, table 7.4.1.2.8.3.3-4 and table 7.4.1.2.8.3.3-5. + +**Table 7.4.1.2.8.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| | | | | + +**Table 7.4.1.2.8.3.3-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The Individual TSC Stream resource was deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.1.2.8.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.8.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.9 Resource: MBS Resources + +##### 7.4.1.2.9.1 Description + +This resource represents the collection of MBS Resources managed by the NEF. + +##### 7.4.1.2.9.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//mbs-resources + +This resource shall support the resource URI variables defined in table 7.4.1.2.9.2-1. + +**Table 7.4.1.2.9.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 6.5. | + +#### 7.4.1.2.9.3 Resource Standard Methods + +##### 7.4.1.2.9.3.1 POST + +This method enables a VAL Server to request the creation of a new MBS Resource at the NRM Server. + +This method shall support the URI query parameters specified in table 7.4.1.2.9.3.1-1. + +**Table 7.4.1.2.9.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.9.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.9.3.1-3. + +**Table 7.4.1.2.9.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|--------------------------------------------------------------------------| +| MbsResourceReq | M | 1 | Represents the parameters to request the creation of a new MBS resource. | + +**Table 7.4.1.2.9.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsResourceRes
p | M | 1 | 201
Created | Successful case. The requested MBS resource is successfully created and a representation of the created "Individual MBS Resource" resource is returned in the response body.

The URI of the created resource shall also be returned in an HTTP "Location" header. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. | | | | | + +**Table 7.4.1.2.9.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-nra//mbs-resources/{mbsResId} | + +#### 7.4.1.2.9.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 7.4.1.2.10 Resource: Individual MBS Resource + +##### 7.4.1.2.10.1 Description + +This resource represents an "Individual MBS Resource" resource managed by the NEF. + +##### 7.4.1.2.10.2 Resource Definition + +Resource URI: {apiRoot}/ss-nra//mbs-resources/{mbsResId} + +This resource shall support the resource URI variables defined in table 7.4.1.2.10.2-1. + +**Table 7.4.1.2.10.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------|-----------|----------------------------------------------------------------------| +| apiRoot | string | See clause 6.5. | +| mbsResId | string | Represents the identifier of the "Individual MBS Resource" resource. | + +#### 7.4.1.2.10.3 Resource Standard Methods + +##### 7.4.1.2.10.3.1 GET + +This method enables a VAL Server to retrieve an existing "Individual MBS Resource" resource managed by the NRM Server. + +This method shall support the URI query parameters specified in table 7.4.1.2.10.3.1-1. + +**Table 7.4.1.2.10.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.10.3.1-2 and the response data structures and response codes specified in table 7.4.1.2.10.3.1-3. + +**Table 7.4.1.2.10.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.10.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MBSResource | M | 1 | 200 OK | Successful case. A representation of the requested "Individual MBS Resource" resource is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.1.2.10.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +#### 7.4.1.2.10.3.2 PUT + +This method enables a VAL Server to request the update of an existing "Individual MBS Resource" resource managed by the NRM Server. + +This method shall support the URI query parameters specified in table 7.4.1.2.10.3.2-1. + +**Table 7.4.1.2.10.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.10.3.2-2 and the response data structures and response codes specified in table 7.4.1.2.10.3.2-3. + +**Table 7.4.1.2.10.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|----------------------------------------------------------------------------------| +| MBSResource | M | 1 | Represents the updated representation of the "Individual MBS Resource" resource. | + +**Table 7.4.1.2.10.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MBSResource | M | 1 | 200 OK | Successful case. The targeted "Individual MBS Resource" resource is successfully updated and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The targeted "Individual MBS Resource" resource is successfully updated and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. | | | | | + +**Table 7.4.1.2.10.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +#### 7.4.1.2.10.3.3 PATCH + +This method enables a VAL Server to request the modification of an existing "Individual MBS Resource" resource managed by the NRM Server. + +This method shall support the URI query parameters specified in table 7.4.1.2.10.3.3-1. + +**Table 7.4.1.2.10.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.10.3.3-2 and the response data structures and response codes specified in table 7.4.1.2.10.3.3-3. + +**Table 7.4.1.2.10.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------------| +| MBSResourcePatch | M | 1 | Represents the requested modifications to the "Individual MBS Resource" resource. | + +**Table 7.4.1.2.10.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MBSResource | M | 1 | 200 OK | Successful case. The targeted "Individual MBS Resource" resource is successfully modified and a representation of the updated resource is returned in the response body. | +| n/a | | | 204 No Content | Successful case. The targeted "Individual MBS Resource" resource is successfully modified and no content is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. | | | | | + +**Table 7.4.1.2.10.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +#### 7.4.1.2.10.3.4 DELETE + +This method enables a VAL Server to request the deletion of an existing "Individual MBS Resource" resource managed by the NRM Server. + +This method shall support the URI query parameters specified in table 7.4.1.2.10.3.4-1. + +**Table 7.4.1.2.10.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.2.10.3.4-2 and the response data structures and response codes specified in table 7.4.1.2.10.3.4-3. + +**Table 7.4.1.2.10.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.10.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The targeted "Individual MBS Resource" resource is successfully deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.

Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.1.2.10.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +## 7.4.1.2.10.4 Resource Custom Operations + +## 7.4.1.2.10.4.1 Overview + +**Table 7.4.1.2.10.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|--------------------------------------|--------------------|-------------------------------------------------------| +| Activate | /mbs-resources/{mbsResId}/activate | POST | Request the activation of an existing MBS Resource. | +| Deactivate | /mbs-resources/{mbsResId}/deactivate | POST | Request the deactivation of an existing MBS Resource. | + +## 7.4.1.2.10.4.2 Operation: Activate + +## 7.4.1.2.10.4.2.1 Description + +This resource custom operation enables a VAL Server to request the activation of an existing MBS Resource at the NRM Server. + +## 7.4.1.2.10.4.2.2 Operation Definition + +This operation shall support the request data structures specified in table 7.4.1.2.10.4.2.2-1 and the response data structure and response codes specified in table 7.4.1.2.10.4.2.2-2. + +**Table 7.4.1.2.10.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------------------------| +| MbsResAct | M | 1 | Contains the parameters to request the activation of the MBS Resource. | + +**Table 7.4.1.2.10.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsResAct | M | 1 | 200 OK | Successful case. The activation request is successfully received and processed. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.4.1.2.10.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +7.4.1.2.10.4.3 Operation: Deactivate + +7.4.1.2.10.4.3.1 Description + +This resource custom operation enables a VAL Server to request the deactivation of an existing MBS Resource at the NRM Server. + +7.4.1.2.10.4.3.2 Operation Definition + +This operation shall support the request data structures specified in table 7.4.1.2.10.4.3.2-1 and the response data structure and response codes specified in table 7.4.1.2.10.4.3.2-2. + +**Table 7.4.1.2.10.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|--------------------------------------------------------------------------| +| MbsResDeact | M | 1 | Contains the parameters related to the deactivation of the MBS Resource. | + +**Table 7.4.1.2.10.4.3.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MbsResDeact | M | 1 | 200 OK | Successful case. The deactivation request is successfully received and processed. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM Server.
Redirection handling is defined in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.1.2.10.4.3.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +**Table 7.4.1.2.10.4.3.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NRM Server. | + +#### 7.4.1.2.11 Resource: BDT Policy Configurations + +##### 7.4.1.2.11.1 Description + +This resource represents the collection of BDT Policy Configurations managed by the NRM Server. + +##### 7.4.1.2.11.2 Resource definition + +Resource URI: {apiRoot}/ss-nra//bdtpolicy-configs + +This resource shall support the resource URI variables defined in table 7.4.1.2.11.2-1. + +**Table 7.4.1.2.11.2-1: Resource URI variables for resource "BDT Policy Configurations"** + +| Name | Data type | Definition | +|---------|-----------|-----------------| +| apiRoot | string | See clause 6.5. | + +##### 7.4.1.2.11.3 Resource methods + +###### 7.4.1.2.11.3.1 POST + +This method enables to request the creation of a new "Individual BDT Policy Configuration" resource at the NRM Server + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 7.4.1.2.11.3.1-1, table 7.4.1.2.11.3.1-2 and table 7.4.1.2.11.3.1-3. + +**Table 7.4.1.2.11.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | Cardinality | Remarks | +|------|-----------|-------------|---------| +| | | | | + +**Table 7.4.1.2.11.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|--------------------------------------------------------------------------------------------------| +| BdtPolConfig | M | 1 | Represents the parameters to request the creation of a new "BDT Policy Configurations" resource. | + +**Table 7.4.1.2.11.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolConfig | M | 1 | 201 Created | Successful case. The requested BDT Policy configuration resource is successfully created and a representation of the created "Individual BDT Policy Configuration" resource is returned in the response body.

The URI of the created resource shall also be returned in an HTTP "Location" header. | +| n/a | | | 204 No Content | The request is successfully received. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.4.1.2.11.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-nra//bdt-policy-configs/{bdtPolConfigId} | + +#### 7.4.1.2.12 Resource: Individual BDT Policy Configuration + +##### 7.4.1.2.12.1 Description + +This resource represents an "Individual BDT Policy Configuration" resource managed by the NRM Server. + +##### 7.4.1.2.12.2 Resource definition + +Resource URI: {apiRoot}/ss-nra//bdt-policy-configs/{bdtPolConfigId} + +This resource shall support the resource URI variables defined in table 7.4.1.2.12.2-1. + +**Table 7.4.1.2.12.2-1: Resource URI variables for resource "Individual BDT Policy Config"** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.5. | +| bdtPolConfigId | string | Represents the identifier of the "Individual BDT Policy Configuration" resource. | + +##### 7.4.1.2.12.3 Resource methods + +###### 7.4.1.2.12.3.1 GET + +The GET method allows to read an "Individual BDT Policy Configuration" resource to obtain details of an active resource BDT policy configuration. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 7.4.1.2.12.3.1-1 and table 7.4.1.2.12.3.1-2. + +**Table 7.4.1.2.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolConfig | M | 1 | 200 OK | Successful case. A representation of the requested "Individual BDT Policy Configuration" resource is returned in the response body. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. + +**Table 7.4.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.12.3.2 DELETE + +The DELETE method deletes the resource related to the BDT policy configuration. + +This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 7.4.1.12.3.2-1 and table 7.4.1.2.12.3.2-2. + +**Table 7.4.1.2.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.1.2.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The "Individual BDT policy Configuration" resource was deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative network resource management server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. + +**Table 7.4.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative network resource management server. | + +**Table 7.4.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative network resource management server. | + +#### 7.4.1.2.12.4 Resource Custom Operations + +None. + +### 7.4.1.3 Notifications + +#### 7.4.1.3.1 General + +**Table 7.4.1.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------|----------------------|---------------------------------|----------------------------------| +| Notify_UP_Delivery_Mode | {notifUri}
(NOTE) | POST | Report User Plane delivery mode. | + +NOTE: This notification is used for both multicast resource management for EPS and multicast/broadcast resource management for 5GS. The "notifUri" is hence either provided via the Request\_Multicast\_Resource service operation for the former case, or the CreateMBSResource/UpdateMBSResource service operation for the latter case. + +### 7.4.1.3.2 Notify\_UP\_Delivery\_Mode + +#### 7.4.1.3.2.1 Description + +#### 7.4.1.3.2.2 Notification definition + +Callback URI: {notifUri} + +This method shall support the URI query parameters specified in table 7.4.1.3.2.2-1. + +**Table 7.4.1.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.3.2.2-2 and the response data structures and response codes specified in table 7.4.1.3.2.2-3. + +**Table 7.4.1.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|----------------------------------------------------------------------| +| UserPlaneNotification | M | 1 | Represents the content of the user plane delivery mode notification. | + +**Table 7.4.1.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] also apply. + +**Table 7.4.1.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 7.4.1.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +### 7.4.1.3.3 BDT\_Negotiation\_Notification + +#### 7.4.1.3.3.1 Description + +#### 7.4.1.3.3.2 Notification definition + +Callback URI: {notifUri} + +This method shall support the URI query parameters specified in table 7.4.1.3.3.2-1. + +**Table 7.4.1.3.3.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.1.3.3.2-2 and the response data structures and response codes specified in table 7.4.1.3.3.2-3. + +**Table 7.4.1.3.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|----------------------------------------------------| +| BdtNotification | M | 1 | Represents the negotiated BDT policy notification. | + +**Table 7.4.1.3.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] also apply. + +**Table 7.4.1.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 7.4.1.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +## 7.4.1.4 Data Model + +### 7.4.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.4.1.4.1-1 specifies the data types defined specifically for the SS\_NetworkResourceAdaptation API service. + +**Table 7.4.1.4.1-1: SS\_NetworkResourceAdaptation API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| BdtPolConfig | 7.4.1.4.2.18 | Represents the parameters related to the BDT Policy Configuration Resource. | | +| BdtNotification | 7.4.1.4.2.20 | Represents the negotiated BDT Policy notification. | | +| DeliveryMode | 7.4.1.4.3.2 | Indicates the delivery mode. | | +| GeoArea | 7.4.1.4.2.19 | Represents the Geographic Area. | | +| EpsMbmsInfo | 7.4.1.4.3.0A | Represents the EPS MBMS bearer information. | | +| MbsResAct | 7.4.1.4.2.16 | Represents the parameters related to the activation of the MBS Resource. | | +| MbsResDeact | 7.4.1.4.2.17 | Represents the parameters related to the deactivation of the MBS Resource. | | +| MbsResource | 7.4.1.4.2.12 | Represents an MBS Resource. | | +| MbsResourcePatch | 7.4.1.4.2.15 | Represents the parameters to request the modification of an MBS Resource. | | +| MbsResourceReq | 7.4.1.4.2.11 | Represents the parameters to request the creation of an MBS Resource. | | +| MbsResourceRespInfo | 7.4.1.4.2.13 | Represents NRM Server side information related to the MBS Resource. | | +| MbsResourceResp | 7.4.1.4.2.14 | Represents a response to an MBS Resource creation/modification request. | | +| MulticastSubscription | 7.4.1.4.2.2 | Represents a multicast subscription. | | +| NetSysIndicator | 7.4.1.4.3.4 | Represents the network system indicator, i.e. 5GS, EPS or both. | | +| NrmEvent | 7.4.1.4.3.3 | Indicates the NRM event. | | +| NrmEventNotification | 7.4.1.4.2.5 | Represents a notification on an individual User Plane event. | | +| ServiceAnnouncementMode | 7.4.1.4.3.1 | Indicates the service announcement mode. | | +| StreamSpecification | 7.4.1.4.2.9 | Represents a stream specification that includes MAC addresses of the source and destination DS-TT ports. | | +| TrafficSpecification | 7.4.1.4.2.10 | Represents the traffic class supported by the DS-TTs and available end-to-end maximum latency value. | | +| TrafficSpecInformation | 7.4.1.4.2.7 | Represents the traffic class supported by the DS-TTs and available end-to-end latency value and Priority Code Point (PCP) value. | | +| TscStreamAvailability | 7.4.1.4.2.8 | Represents the TSC stream availability information including the stream specification and list of traffic specifications. | | +| TscStreamData | 7.4.1.4.2.6 | Represents the TSC stream data information. | | +| UnicastSubscription | 7.4.1.4.2.3 | Represents a unicast subscription. | | +| UserPlaneNotification | 7.4.1.4.2.4 | Represents a notification on User Plane events. | | + +Table 7.4.1.4.1-2 specifies data types re-used by the SS\_NetworkResourceAdaptation API service. + +**Table 7.4.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------------|---------------------|--------------------------------------------------------------------------------------------------------|----------------------| +| DateTime | 3GPP TS 29.571 [21] | Used to represent the subscription duration. | | +| DurationSec | 3GPP TS 29.122 [3] | Used to represent the duration in seconds. | | +| ExternalGroupId | 3GPP TS 29.122 [3] | Represents an External Group Identifier. | | +| ExternalMbsServiceArea | 3GPP TS 29.571 [21] | Represents an MBS Service Area. | | +| GeographicArea | 3GPP TS 29.572 [31] | Represents Geographical area. | | +| CivicAddress | 3GPP TS 29.572 [31] | Represents civic address of an area. | | +| Ipv4Addr | 3GPP TS 29.571 [21] | Used to identify the IPv4 address. | | +| Ipv6Addr | 3GPP TS 29.571 [21] | Used to identify the IPv6 address. | | +| LocalMbmsInfo | 3GPP TS 29.486 [27] | Used to represent the local MBMS information. | | +| MacAddr48 | 3GPP TS 29.571 [21] | Used to identify a MAC address. | | +| MbmsLocArea | 3GPP TS 29.122 [3] | Used to indicate the requested area of the MBMS bearer. | | +| MbsServiceInfo | 3GPP TS 29.571 [21] | Represents MBS Service Information. | | +| MbsSession | 3GPP TS 29.571 [21] | Represents an MBS Session. | | +| MbsSessionId | 3GPP TS 29.571 [21] | Represents the identifier of an MBS Session. | | +| Port | 3GPP TS 29.122 [3] | Used to identify the port. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the supported optional features of the API. | | +| TimeWindow | 3GPP TS 29.122 [3] | Represents a time interval. | | +| UsageThreshold | 3GPP TS 29.122 [3] | Represents the data usage threshold. | | +| Uint32 | 3GPP TS 29.571 [21] | Represents an unsigned integer. | | +| UInteger | 3GPP TS 29.571 [21] | Represents an unsigned integer. | | +| Uri | 3GPP TS 29.571 [21] | Used to indicate the notification URI. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to identify either a VAL User ID or a VAL UE ID. | | +| WebsockNotifConfig | 3GPP TS 29.122 [3] | Used to indicate the configuration parameters to set up notification delivery over Websocket protocol. | | + +## 7.4.1.4.2 Structured data types + +## 7.4.1.4.2.1 Introduction + +## 7.4.1.4.2.2 Type: MulticastSubscription + +**Table 7.4.1.4.2.2-1: Definition of type MulticastSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| valGroupId | string | M | 1 | The identity of the group that the MBMS bearer is requested for. | | +| anncMode | ServiceAnnouncementMode | M | 1 | Indicates whether the service announcement is sent by NRM server or by the VAL server. | | +| multiQosReq | string | M | 1 | The QoS requirement for the multicast. | | +| locArea | MbmsLocArea | O | 0..1 | Indicate the area where the MBMS bearer is requested for. | | +| duration | DateTime | O | 0..1 | Identifies the absolute time at which the subscription resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the VAL server. When omitted in the response, it indicates the resource is set to valid forever by the VAL server. | | +| tmgi | Uint32 | O | 0..1 | TMGI.
Shall be provided by the NRM server if announcement mode is set to VAL. | | +| localMbmsInfo | LocalMbmsInfo | O | 0..1 | Contains the local MBMS information. This attribute may be present only within the trust domain. | LocalMBMS | +| localMbmsActInd | boolean | O | 0..1 | Set to true to indicate that the local MBMS is activated.
Set to false or omitted otherwise. | LocalMBMS | +| notifUri | Uri | M | 1 | Identifies the notification URI where the NRM notification shall be sent to. | | +| reqTestNotif | boolean | O | 0..1 | Set to true to request the VAE server to send a test notification as defined in clause 6.6. Set to false or omitted otherwise. | Notification_test_event | +| wsNotifCfg | WebsocketNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.6. | Notification_websocket | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features defined in table 7.4.1.6-1.
This parameter may be supplied by the VAL server in the POST request that requests the creation of a Multicast Subscription resource and shall be supplied in the corresponding POST response if it was present in the request. | | +| upIpv4Addr | Ipv4Addr | O | 0..1 | Ipv4address of the user plane. (NOTE) | | +| upIpv6Addr | Ipv6Addr | O | 0..1 | Ipv6address of the user plane. (NOTE) | | +| upPortNum | Port | O | 0..1 | UDP port number of the user plane. | | +| radioFreqs | array(uint32) | O | 1..N | The radio frequencies which may be provided by the NRM server. | | + +NOTE: At least one of upIpv4Addr or upIpv6Addr shall be provided by the NRM server. + +## 7.4.1.4.2.3 Type: UnicastSubscription + +**Table 7.4.1.4.2.3-1: Definition of type UnicastSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| valTgtUe | ValTargetUe | M | 1 | The identity of the VAL user or VAL UE that the unicast bearer is requested for. | | +| uniQosReq | string | O | 0..1 | The QoS requirement for the unicast. | | +| duration | DateTime | O | 0..1 | Identifies the absolute time at which the subscription resource is considered to expire. When omitted in the request, it indicates the resource is requested to be valid forever by the VAL server. When omitted in the response, it indicates the resource is set to valid forever by the VAL server. | | +| notifUri | Uri | M | 1 | Identifies the notification URI where the NRM notification shall be sent to. | | +| reqTestNotif | Boolean | O | 0..1 | Set to true to request the VAE server to send a test notification as defined in clause 6.6. Set to false or omitted otherwise. | Notification_test_event | +| wsNotifCfg | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.6. | Notification_websocket | +| suppFeat | SupportedFeatures | O | 1 | This parameter may be supplied by VAL server in the POST request that request the creation of a Unicast Subscription resource and may be supplied in the reply of corresponding request. | | + +## 7.4.1.4.2.4 Type: UserPlaneNotification + +**Table 7.4.1.4.2.4-1: Definition of type UserPlaneNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|----------------------------------------------------------------------|---------------| +| notifId | Uri | M | 1 | The subscription resource Uri to which this notification is related. | | +| eventNotifs | array(NrmEventNotification) | M | 1..N | Notifications about Individual Events | | + +7.4.1.4.2.5 Type: NrmEventNotification + +**Table 7.4.1.4.2.5-1: Definition of type NrmEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | NrmEvent | M | 1 | Event that is notified. | | +| ts | DateTime | M | 1 | Time at which the event is observed. | | +| deliveryMode | DeliveryMode | C | 0..1 | Indicates delivery of the user data to the UE(s) via unicast mode, EPS MBMS multicast mode, 5GS MBS multicast mode or 5GS MBS broadcast mode.

This attribute shall be present if the "event" attribute is set to "UP_DELIVERY_MODE". | | +| streamIds | array(string) | O | 1..N | Indicates the media streams (unicast or multicast) to be used.

This attribute may be present if the "event" attribute is set to "UP_DELIVERY_MODE" and the NRM Server already has the streams available. | | + +7.4.1.4.2.6 Type: TscStreamData + +**Table 7.4.1.4.2.6-1: Definition of type TscStreamData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| streamSpec | StreamSpecification | M | 1 | Stream specification includes MAC addresses of the source and destination DS-TT ports. | | +| trafficSpecInfo | TrafficSpecInformation | M | 1 | Traffic Specification Information includes Priority Code Point (PCP), MaxFrameInterval, MaxFrameSize, MaxIntervalFrames, MaxLatency, etc. (e.g. as described in IEEE 802.1Qcc [29] in clause 46.2). | | + +7.4.1.4.2.7 Type: TrafficSpecInformation + +**Table 7.4.1.4.2.7-1: Definition of type TrafficSpecInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pcpValue | Uint32 | M | 1 | The Priority Code Point (PCP) value identify the traffic class, with value between 0 to 7. | | +| maxFramInt | DurationSec | M | 1 | Maximum Frame Interval. | | +| maxFramSize | Uint32 | M | 1 | Maximum frame size will transmit, excluding the overhead. | | +| maxIntFrames | Uint32 | M | 1 | Maximum interval frames. | | +| maxLatency | Uint32 | M | 1 | Indicates the end-to-end latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays) in milliseconds. | | + +7.4.1.4.2.8 Type: TscStreamAvailability + +**Table 7.4.1.4.2.8-1: Definition of type TscStreamAvailability** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| streamSpec | StreamSpecification | M | 1 | Stream specification includes MAC addresses of the source and destination DS-TT ports. | | +| trafficSpecs | array(TrafficSpecification) | M | 1..N | The traffic classes supported by the DS-TTs and available end-to-end maximum latency values. | | + +7.4.1.4.2.9 Type: StreamSpecification + +**Table 7.4.1.4.2.9-1: Definition of type StreamSpecification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------|---------------| +| srcMacAddr | MacAddr48 | M | 1 | The MAC address of the source DS-TT port. | | +| dstMacAddr | MacAddr48 | M | 1 | The MAC address of the destination DS-TT port. | | + +7.4.1.4.2.10 Type: TrafficSpecification + +**Table 7.4.1.4.2.10-1: Definition of type TrafficSpecification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| trafficClass | Uint32 | M | 1 | The traffic class supported by the DS-TTs with value between 0 to 7. | | +| e2eMaxLatency | Uinteger | M | 1 | Indicates the end to end maximum latency (including the UE-DS-TT residence times, UPF residence time, and propagation delays), in the units of milliseconds. | | + +7.4.1.4.2.11 Type: MBSResourceReq + +**Table 7.4.1.4.2.11-1: Definition of type MBSResourceReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsResource | MBSResource | M | 1 | Contains the parameters to request the creation of the MBS Resource. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features.

This attribute shall be present only if feature negotiation needs to take place. | | + +## 7.4.1.4.2.12 + +Type: MBSResource + +**Table 7.4.1.4.2.12-1: Definition of type MBSResource** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valGroupId | string | C | 0..1 | Contains the identity of the VAL group to which the MBS Resource is related.

(NOTE 1) | | +| valUeIdsList | array(ValTargetUe) | C | 1..N | Contains the list of the identifier(s) of the VAL UE(s) to which the MBS Resource is related.

(NOTE 1) | | +| servAnmtMode | ServiceAnnouncementMode | M | 1 | Contain the MBS Service Announcement mode to be used, i.e. whether the MBS Service Announcement is delivered by the NRM Server or the VAL Server. | | +| mbsResServInfo | MbsServiceInfo | M | 1 | Contains the MBS Service Information for the MBS Resource. | | +| mbsResServiceArea | ExternalMbsServiceArea | O | 0..1 | Contains the Service Area of the MBS Resource. | | +| notifUri | Uri | M | 1 | Contains the URI towards which the user plane delivery mode notifications shall be sent. | | +| netSysInd | NetSysIndicator | O | 0..1 | Indicates whether the MBS Resource requires multicast/broadcast services from 5GS, EPS or both. | | +| localMbmsInfo | LocalMbmsInfo | O | 0..1 | Contains the local MBMS information.

This attribute may only be provided if the "netSysInd" attribute is set to "EPS" or "5GS_AND_EPS".

(NOTE 2) | | +| localMbmsActInd | boolean | O | 0..1 | Set to true by the service consumer to indicate that the local MBMS is activated. Set to false or omitted otherwise.

(NOTE 2) | | +| mbsResRespInfo | MBSResourceRespInfo | O | 0..1 | Represents the NRM Server side information related to the created MBS Resource.

This attribute may only be present in the response to the request to create/update/modify/retrieve the MBS Resource. | | + +NOTE 1: These attributes are mutually exclusive. Either one of them shall be present. + +NOTE 2: These attributes are mutually exclusive. Either one of them may be present. + +## 7.4.1.4.2.13 + +Type: MBSResourceRespInfo + +Table 7.4.1.4.2.13-1: Definition of type MBSResourceRespInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbs5gSessionId | MbsSessionId | O | 0..1 | Contains the identifier of the MBS session (i.e. TMGI and/or SSM, in addition to the NID in the case an SNPn).

This attribute may not be present if the MBS Service Announcement is delivered by the NRM Server (i.e. the "servAnmtMode" attribute in the corresponding request is set to "NRM"). | | +| mbmsBearerId | MbsSessionId | O | 0..1 | Contains the identifier of the MBMS bearer (i.e. TMGI).

This attribute may not be present if the MBS Service Announcement is delivered by the NRM Server (i.e. the "servAnmtMode" attribute in the corresponding request is set to "NRM"). | | +| upIpv4Addr | Ipv4Addr | C | 0..1 | Contains the user plane IPv4 address of the NRM Server to be used by the VAL Server for downlink packets delivery.

(NOTE 1) | | +| upIpv6Addr | Ipv6Addr | C | 0..1 | Contains the user plane IPv6 address of the NRM Server to be used by the VAL Server for downlink packets delivery.

(NOTE 1) | | +| upPortNum | Port | O | 0..1 | Contains the user plane UDP port number to be used by VAL Server for downlink packets delivery. | | +| mbs5GInfo | MbsSession | O | 0..1 | Contains MBS related configuration information.

This attribute may only be present if the network system used for multicast/broadcast services is 5GS or both 5GS and EPS. | | +| epsMbmsInfo | EpsMbmsInfo | O | 0..1 | Contains MBMS related configuration information.

This attribute may only be present if the network system used for multicast/broadcast services is EPS or both 5GS and EPS. | | + +NOTE 1: At least one of these attributes shall be present. + +## 7.4.1.4.2.14 + +Type: MBSResourceResp + +Table 7.4.1.4.2.14-1: Definition of type MBSResourceResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsResource | MBSResource | M | 1 | Contains the the created MBS Resource. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features.

This attribute shall be present only if feature negotiation is taking place (i.e. this attribute was present in the corresponding request). | | + +## 7.4.1.4.2.15 Type: MBSResourcePatch + +**Table 7.4.1.4.2.15-1: Definition of type MBSResourcePatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsResServInfo | MbsServiceInfo | O | 0..1 | Contains the updated MBS Service Information for the MBS Resource. | | +| mbsResServiceArea | ExternalMbsServiceArea | O | 0..1 | Contains the updated Service Area of the MBS Resource. | | +| notifUri | Uri | O | 0..1 | Contains the URI towards which the user plane delivery mode notifications shall be sent. | | +| localMbmsInfo | LocalMbmsInfo | O | 0..1 | Contains the local MBMS information.

This attribute may only be provided if the "netSysInd" attribute is set to "EPS" or "5GS_AND_EPS".

(NOTE) | | +| localMbmsActInd | boolean | O | 0..1 | Set to true by the service consumer to indicate that the local MBMS is activated. Set to false or omitted otherwise.

(NOTE) | | + +NOTE: These attributes are mutually exclusive. Either one of them may be present. + +## 7.4.1.4.2.16 Type: MbsResAct + +**Table 7.4.1.4.2.16-1: Definition of type MbsResAct** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbs5gSessionId | MbsSessionId | M | 1 | Contains the identifier of the MBS session to be activated. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features.

This attribute shall be present only if feature negotiation needs to take place. | | + +## 7.4.1.4.2.17 Type: MbsResDeact + +**Table 7.4.1.4.2.17-1: Definition of type MbsResDeact** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbs5gSessionId | MbsSessionId | M | 1 | Contains the identifier of the MBS session to be deactivated. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features.

This attribute shall be present only if feature negotiation needs to take place. | | + +## 7.4.1.4.2.18 Type: BdtPolConfig + +Table 7.4.1.4.2.18-1: Definition of type BdtPolConfig + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valServId | string | M | 1 | Identifies a VAL Service. | | +| valGroupId | string | C | 0..1 | Identifies a group of UEs.
(NOTE) | | +| valUels | array(string) | C | 1..N | Represents a List of VAL UEs whose BDT policy is provided.
(NOTE) | | +| dataVolUe | UsageThreshold | O | 0..1 | Represents the Data volume per UE. | | +| desiredTimeWindow | TimeWindow | O | 0..1 | Represents the desired time window for BDT. | | +| grantTimeWindow | TimeWindow | C | 0..1 | Represents the granted time window by the 3GPP network for BDT.
This attribute may be present only in the responses. | | +| geoArea | GeoArea | O | 0..1 | Represents the desired geographical area for BDT. | | +| policyGuidance | FFS | O | 0..N | Represents a list of policy guidance. | | +| bdtPolRefl | string | C | 0..1 | Identifies a BDT policy reference identifier.
This attribute may be present only in the responses. | | +| notifUri | Uri | M | 1 | Identifies the destination notification URI where the NRM notification shall be sent to. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of optional features.

This attribute shall be present only if feature negotiation needs to take place. | | + +NOTE: Either one of the "valGroupId" or "valUels" attribute shall be present. + +Editor's Note: complete definition of the attribute "policyGuidance" is FFS. + +## 7.4.1.4.2.19 Type: GeoArea + +Table 7.4.1.4.2.19-1: Definition of type GeoArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------|---|-------------|------------------------------------------------|---------------| +| geographicalAreas | array(GeographicArea) | O | 1..N | Represents a list of Geographical area. | | +| civicAddress | array(CivicAddresses) | O | 1..N | Represents a list of Civic address of an area. | | + +## 7.4.1.4.2.20 Type: BdtNotification + +**Table 7.4.1.4.2.20-1: Definition of type BdtNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | Uri | M | 1 | The BDT policy configuration resource Uri to which this notification is related. | | +| bdTConfigId | string | M | 0..1 | Identifies the BDT policy configuration to which the notification is related. | | +| grantTimeWindow | TimeWindow | C | 0..1 | Represents the updated time window granted by the 3GPP network for BDT.

This attribute shall be present only if the "bdTPolicyRemoveInd" attribute value is not present, or preset and set to "false". | | +| bdTPolicyRemoveInd | boolean | O | 0..1 | Indicates whether the BDT policy at the 3GPP network corresponding to the BDT policy reference identifier has been removed.

When present, it shall be set as follows:
- "true": The BDT policy was removed by the 3GPP network.
- "false": the BDT policy was not removed at the 3GPP network.
- Default value when omitted is "false". | | + +## 7.4.1.4.3 Simple data types and enumerations + +## 7.4.1.4.3.0 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 7.4.1.4.3.0A Simple data types + +The simple data types defined in table 7.4.1.4.3.0A-1 shall be supported. + +**Table 7.4.1.4.3.0A-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-------------|-----------------|---------------------------------------------------------------------------------------------------------|---------------| +| EpsMbmsInfo | Bytes | Represents the EPS MBMS bearer information encoded as specified in clause 6.4.7 of 3GPP TS 29.468 [23]. | | + +## 7.4.1.4.3.1 Enumeration: ServiceAnnouncementMode + +**Table 7.4.1.4.3.1-1: Enumeration ServiceAnnouncementMode** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------|---------------| +| NRM | NRM server performs the service announcement. | | +| VAL | VAL server performs the service announcement. | | + +## 7.4.1.4.3.2 Enumeration: DeliveryMode + +**Table 7.4.1.4.3.2-1: Enumeration DeliveryMode** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------|---------------| +| UNICAST | Indicates Unicast delivery. | | +| MULTICAST | Indicates EPS MBMS Multicast delivery. | | +| MBS_MULTICAST | Indicates 5GS MBS Multicast delivery. | | +| MBS_BROADCAST | Indicates 5GS MBS Broadcast delivery. | | + +## 7.4.1.4.3.4 Enumeration: NetSysIndicator + +**Table 7.4.1.4.3.4-1: Enumeration NetSysIndicator** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------|---------------| +| 5GS | Indicates that the network system is 5GS. | | +| EPS | Indicates that the network system is EPS. | | +| 5GS_AND_EPS | Indicates that the network system is both 5GS and EPS. | | + +## 7.4.1.4.3.5 Enumeration: NrmEvent + +**Table 7.4.1.4.3.5-1: Enumeration NrmEvent** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| UP_DELIVERY_MODE | User Plane delivery mode. | | + +## 7.4.1.5 Error Handling + +## 7.4.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.4.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_NetworkResourceAdaptation API. + +## 7.4.1.5.3 Application Errors + +The application errors defined for SS\_NetworkResourceAdaptation API are listed in table 7.4.1.5.3-1. + +**Table 7.4.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.4.1.6 Feature negotiation + +**Table 7.4.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | The testing of notification connection is supported according to clause 6.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | LocalMBMS | Indicate the support of local MBMS transmission. | + +## 7.4.2 SS\_NetworkResourceMonitoring API + +### 7.4.2.1 API URI + +The SS\_NetworkResourceMonitoring service shall use the SS\_NetworkResourceMonitoring API. + +The request URIs used in HTTP requests from the VAL server towards the NRM server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-nrm". +- The shall be "v1". +- The shall be set as described in clause 7.4.2.2 + +### 7.4.2.2 Resources + +#### 7.4.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.4.2.2.1-1 depicts the resource URIs structure for the SS\_NetworkResourceMonitoring API. + +![Diagram showing the resource URI structure for the SS_NetworkResourceMonitoring API. It starts with {apiRoot}/ss-nrm/, which branches to /subscriptions, which in turn branches to /.](889982a45a70fa2e605a553842ce8952_img.jpg) + +{apiRoot}/ss-nrm/ + +``` + +graph TD + Root["{apiRoot}/ss-nrm/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/"] + +``` + +Diagram showing the resource URI structure for the SS\_NetworkResourceMonitoring API. It starts with {apiRoot}/ss-nrm/, which branches to /subscriptions, which in turn branches to /. + +**Figure 7.4.2.2.1-1: Resource URI structure of the SS\_NetworkResourceMonitoring API** + +Table 7.4.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.4.2.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|---------------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Unicast Monitoring Subscriptions | /subscriptions | POST | Create individual unicast monitoring subscription resource or obtain unicast QoS monitoring data for VAL UEs, VAL Group, or VAL Streams. | +| Individual Unicast Monitoring Subscription | /subscriptions/{subscriptionId} | DELETE | Remove an existing individual unicast monitoring subscription resource according to the subscriptionId. | +| | | GET | Read an existing individual unicast monitoring subscription resource according to the subscriptionId. | +| | | PUT | Update an individual unicast monitoring subscription identified by the subscriptionId. | +| | | PATCH | Modify an individual unicast monitoring subscription identified by the subscriptionId. | + +#### 7.4.2.2.2 Resource: Unicast Monitoring Subscriptions + +##### 7.4.2.2.2.1 Description + +##### 7.4.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-nrm//subscriptions + +This resource shall support the resource URI variables defined in table 7.4.2.2.2.2-1. + +**Table 7.4.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|---------------------| +| apiRoot | string | See clause 7.4.2.1. | + +##### 7.4.2.2.2.3 Resource Standard Methods + +###### 7.4.2.2.2.3.1 POST + +This method enables a VAL Server to request the creation of a unicast QoS monitoring subscription at the NRM server. This method shall support the URI query parameters specified in table 7.4.2.2.2.3.1-1. + +**Table 7.4.2.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.2.2.2.3.1-2 and the response data structures and response codes specified in table 7.4.2.2.2.3.1-3. + +**Table 7.4.2.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------| +| MonitoringSubscription | M | 1 | | + +**Table 7.4.2.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitoringSubscription | M | 1 | 201 Created | The requested individual monitoring subscription resource is successfully created and a representation of the created resource is returned in the response body. | +| MonitoringReport | M | 1 | 200 OK | The requested unicast QoS monitoring data is returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] shall also apply. | | | | | + +**Table 7.4.2.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-nrm//subscriptions/{subscriptionId} | + +#### 7.4.2.2.2.4 Resource Custom Operations + +None. + +#### 7.4.2.2.3 Resource: Individual Unicast Monitoring Subscription + +##### 7.4.2.2.3.1 Description + +##### 7.4.2.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-nrm//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in table 7.4.2.2.3.2-1. + +**Table 7.4.2.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|--------------------------------------------------------------------------------------| +| apiRoot | string | See clause 7.4.2.1. | +| subscriptionId | string | Represents the identifier of an individual unicast monitoring subscription resource. | + +##### 7.4.2.2.3.3 Resource Standard Methods + +###### 7.4.2.2.3.3.1 DELETE + +This operation deletes the Individual Unicast Monitoring Subscription resource. This method shall support the URI query parameters specified in table 7.4.2.2.3.3.1-1. + +**Table 7.4.2.2.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.2.2.3.3.1-2 and the response data structures and response codes specified in table 7.4.2.2.3.3.1-3. + +**Table 7.4.2.2.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.2.2.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The Individual Unicast Monitoring Subscription resource matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.2.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NRM server. | + +**Table 7.4.2.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NRM server. | + +#### 7.4.2.2.3.3.2 GET + +This operation reads the individual unicast monitoring subscription resource. This method shall support the URI query parameters specified in table 7.4.2.2.3.3.2-1. + +**Table 7.4.2.2.3.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.4.2.2.3.3.2-2 and the response data structures and response codes specified in table 7.4.2.2.3.3.2-3. + +**Table 7.4.2.2.3.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.4.2.2.3.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitoringSubscription | M | 1 | 200 OK | The requested individual unicast monitoring subscription is returned. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NRM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.122 [3] shall also apply. + +**Table 7.4.2.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NRM server. | + +**Table 7.4.2.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative NRM server. | + +#### 7.4.2.2.3.3.3 PUT + +This operation updates the "Individual Unicast Monitoring Subscription". This method shall support the URI query parameters specified in table 7.4.2.2.3.3.3-1. + +**Table 7.4.2.2.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.2.2.3.3.3-2 and the response data structures and response codes specified in table 7.4.2.2.3.3.3-3. + +**Table 7.4.2.2.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitoringSubscription | M | 1 | Updated details of the unicast QoS monitoring subscription.

The target identifiers, i.e., the "valUelds", "valGroupId", and "valStreamIds" attributes shall not be changed in the MonitoringSubscription data structure. | + +**Table 7.4.2.2.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitoringSubscription | M | 1 | 200 OK | The subscription is updated successfully, and the updated subscription information returned in the response. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative location management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.2.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +**Table 7.4.2.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative location management server. | + +#### 7.4.2.2.3.3.4 PATCH + +This operation modifies the "Individual Unicast Monitoring Subscription". This method shall support the URI query parameters specified in table 7.4.2.2.3.3.4-1. + +**Table 7.4.2.2.3.3.4-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.2.2.3.3.4-2 and the response data structures and response codes specified in table 7.4.2.2.3.3.4-3. + +**Table 7.4.2.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| MonitoringSubscriptionPatch | M | 1 | Contains the modifications to be applied to the individual unicast QoS monitoring subscription resource. | + +**Table 7.4.2.2.3.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| MonitoringSubscription | M | 1 | 200 OK | Individual unicast QoS monitoring subscription resource is modified successfully and representation of the modified individual unicast QoS monitoring subscription resource is returned. | +| n/a | | | 307
Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308
Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.2.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.4.2.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +## 7.4.2.3 Notifications + +### 7.4.2.3.1 General + +**Table 7.4.2.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------|--------------|---------------------------------|--------------------------------------------------------------------------------------------------------| +| Individual Unicast Monitoring Notification | {notifUri} | POST | Notify on updates of the individual monitoring resource according to the requested reporting settings. | + +### 7.4.2.3.2 Individual Unicast Monitoring Notification + +#### 7.4.2.3.2.1 Description + +#### 7.4.2.3.2.2 Notification definition + +Callback URI: {notifUri} + +This method shall support the URI query parameters specified in table 7.4.2.3.2.2-1. + +**Table 7.4.2.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.4.2.3.2.2-2 and the response data structures and response codes specified in table 7.4.2.3.2.2-3. + +**Table 7.4.2.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|------------------------------------------| +| MonitoringReport | M | 1 | Represents the reported monitoring data. | + +**Table 7.4.2.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The notification is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative VAL server where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.4.2.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +**Table 7.4.2.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative VAL server towards which the notification should be redirected. | + +## 7.4.2.4 Data Model + +### 7.4.2.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API + +Table 7.4.2.4.1-1 specifies the data types defined specifically for the SS\_NetworkResourceMonitoring API service. + +**Table 7.4.2.4.1-1: SS\_NetworkResourceMonitoring API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FailureReport | 7.4.2.4.2.9 | Represents the failure report indicating the VAL UE(s) or VAL Stream ID(s) for which the NRM server failed to obtain the requested data. | | +| FailureReason | 7.4.2.4.3.3 | Represents the failure reason. | | +| MeasurementData | 7.4.2.4.2.3 | Presents the aggregated measurement data. | | +| MeasurementDataType | 7.4.2.4.3.1 | Indicates the requested measurement data type. | | +| MeasurementPeriod | 7.4.2.4.2.4 | Indicates the measurement time period. | | +| MeasurementRequirements | 7.4.2.4.2.6 | Indicates the measurement requirements. | | +| MonitoringReport | 7.4.2.4.2.2 | Indicates the monitoring report for VAL UEs list, VAL Group, or VAL Stream. | | +| MonitoringSubscription | 7.4.2.4.2.7 | The monitoring subscription request. | | +| MonitoringSubscriptionPatch | 7.4.2.4.2.11 | Represents the monitoring subscription modification request. | UpdateSupport | +| ReportingRequirements | 7.4.2.4.2.5 | Indicates the requested requirements of reporting. | | +| ReportingThreshold | 7.4.2.4.2.10 | Indicates a requested reporting threshold. | | +| TerminationMode | 7.4.2.4.3.2 | Indicates the termination mode. | | +| ThresholdHandlingMode | 7.4.2.4.3.4 | Indicates the multi-parameter threshold handling mode. | | + +Table 7.4.2.4.1-2 specifies data types re-used by the SS\_NetworkResourceMonitoring API service. + +**Table 7.4.2.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------|---------------------|--------------------------------------------------------------------------------------------------------|---------------| +| AverWindow | 3GPP TS 29.571 [21] | Used to represent an aggregation window. | | +| BitRate | 3GPP TS 29.571 [21] | Used to represent a bit rate measurement value. | | +| DateTime | 3GPP TS 29.571 [21] | Used to represent a date and time. | | +| DurationSec | 3GPP TS 29.571 [21] | Used to represent a measurement timestamp and measurement start time. | | +| MatchingDirection | 3GPP TS 29.520 [33] | Used to indicate a threshold matching direction. | | +| NotificationMethod | 3GPP TS 29.508 [32] | Used to indicate the reporting mode. | | +| PacketLossRate | 3GPP TS 29.571 [21] | Used to represent a packet loss rate measurement value. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the supported optional features of the API. | | +| Uinteger | 3GPP TS 29.571 [21] | Used to represent integer attributes within MeasurementData and ReportingRequirements data structures. | | +| Uri | 3GPP TS 29.571 [21] | Used to indicate the notification URI. | | +| ValTargetUe | clause 7.3.1.4.2.3 | Used to identify either a VAL User ID or a VAL UE ID. | | +| WebsockNotifConfig | 3GPP TS 29.122 [3] | Used to indicate the configuration parameters to set up notification delivery over Websocket protocol. | | + +#### 7.4.2.4.2 Structured data types + +##### 7.4.2.4.2.1 Introduction + +##### 7.4.2.4.2.2 Type: MonitoringReport + +**Table 7.4.2.4.2.2-1: Definition of type MonitoringReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valUeIds | array(ValTargetUe) | C | 1..N | List of VAL UEs whose measurement data is provided (NOTE). | | +| valGroupId | string | C | 0..1 | The group ID used for the VAL group for which measurement data is provided (NOTE). | | +| valStreamIds | array(string) | C | 1..N | List of VAL stream IDs whose measurement data (NOTE). | | +| measData | MeasurementData | M | 1 | The aggregated measurement data. | | +| timestamp | DateTime | M | 1 | The timestamp of the measurement. | | +| failureRep | array(FailureReport) | C | 1..N | The failure report from the NRM server indicating the VAL UE(s) or VAL Stream ID(s) whose measurement data is not obtained successfully and is not provided in the monitoring report.

This attribute shall be provided by the NRM server when the requested measurement data is not obtained successfully for all the requested VAL UE(s) or VAL Stream ID(s). | | + +NOTE: Only one of these attributes shall be provided. + +##### 7.4.2.4.2.3 Type: MeasurementData + +**Table 7.4.2.4.2.3-1: Definition of type MeasurementData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------|---|-------------|----------------------------------------------------------|---------------| +| dlDelay | UInteger | O | 0..1 | The downlink packet delay in milliseconds (NOTE). | | +| ulDelay | UInteger | O | 0..1 | The uplink packet delay in milliseconds (NOTE). | | +| rtDelay | UInteger | O | 0..1 | The round trip packet delay in milliseconds (NOTE). | | +| avgPlr | PacketLossRate | O | 0..1 | The average packet loss rate (NOTE). | | +| avgDataRate | BitRate | O | 0..1 | The average data rate (NOTE). | | +| maxDataRate | BitRate | O | 0..1 | The maximum data rate (NOTE). | | +| avrDITrafficVol | UInteger | O | 0..1 | The average traffic volume for downlink in bytes (NOTE). | | +| avrUITrafficVol | UInteger | O | 0..1 | The average traffic volume for uplink in bytes (NOTE). | | + +NOTE: At least one of the measurement indexes shall be provided. + +##### 7.4.2.4.2.4 Type: MeasurementPeriod + +**Table 7.4.2.4.2.4-1: Definition of type MeasurementPeriod** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------|---------------| +| measStartTime | DateTime | M | 1 | Indicate the starting time for the measurement. | | +| measDuration | DurationSec | M | 1 | Indicate the duration for the measurement starting from the measStartTime. | | + +## 7.4.2.4.2.5 + +## Type: ReportingRequirements + +**Table 7.4.2.4.2.5-1: Definition of type ReportingRequirements** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reportingMode | NotificationMethod | M | 1 | The indication of the requested reporting option: one-time, periodic or event-triggered (i.e. "ON_EVENT_DETECTION")

This attribute may be set to the value "ONE_TIME" only if the "immRep" attribute is provided and set to "true".. | | +| reportingPeriod | DurationSec | C | 0..1 | Identifies the reporting time interval for the periodic reporting. (NOTE 1). | | +| reportingThrs | array(ReportingThreshold) | C | 1..N | Identifies reporting threshold corresponding to the measurement index(es). (NOTE 2). | | +| immRep | boolean | O | 0..1 | It indicates immediate reporting. When included and set to true, it indicates that immediate reporting of the subscribed event(s) is requested. | | +| repTerminMode | TerminationMode | O | 0..1 | The indication of the requested reporting termination mode: time-triggered, event-triggered (number of reports reached), event-triggered (threshold reached) or user-triggered.

If absent, user-triggered reporting is used as the default termination mode. | | +| expirationTimer | DurationSec | C | 0..1 | Identifies the reporting time interval for the time triggered termination mode. (NOTE 3). | | +| maxNumRep | UInteger | C | 0..1 | Indicates the maximum number of reports (number of reports reached). (NOTE 4). | | +| termThr | MeasurementData | C | 0..1 | Indicates the reporting termination threshold(s) corresponding to the measurement index(ex). (NOTE 5, NOTE 6, NOTE 7). | | +| termThrMode | ThresholdHandlingMode | C | 0..1 | Indicates the multi-parameter threshold handling for the event-triggered threshold reached reporting termination.

(NOTE 8). | | + +NOTE 1: The "reportingPeriod" attribute shall be present only when the "reportingMode" attribute is set to "PERIODIC". + +NOTE 2: The "reportingThr" attribute shall be present only when the "reportingMode" attribute is set to "ON\_EVENT\_DETECTION". + +NOTE 3: The "expirationTimer" attribute shall be present only if the "repTerminMode" attribute is present and set to "TIME\_TRIGGERED". + +NOTE 4: The "maxNumRep" attribute shall be present only if the "repTerminMode" attribute is present and set to "EVENT\_TRIGGERED\_NUM\_REPORTS\_REACHED". + +NOTE 5: The "termThr" attributes shall be present only when the "repTerminMode" attribute is present and set to "EVENT\_TRIGGERED\_MEAS\_THR\_REACHED". + +NOTE 6: The event-triggered reporting termination condition for the "dlDelay", "ulDelay", "rtDelay" and "avgPlr" attributes within the MeasurementData data structure is met when the measured value is greater than or equal to the given threshold. + +NOTE 7: The event-triggered reporting termination condition for the "avgDataRate", "maxDataRate", "avrDITrafficVol" and "avrUITrafficVol" attributes within the MeasurementData data structure is met when the measured value is less than or equal to the given threshold. + +NOTE 8: The "termThrMode" attribute shall be present only when the "repTerminMode" attribute is present and set to "EVENT\_TRIGGERED\_MEAS\_THR\_REACHED" and the "termThr" contains more than one threshold. + +## 7.4.2.4.2.6 Type: MeasurementRequirements + +Table 7.4.2.4.2.6-1: Definition of type MeasurementRequirements + +| Name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| measDataTypes | array(MeasurementDataType) | M | 1..N | Indicates the required types of measurement data.

At least one measurement data type shall be present in the array structure. | | +| measAggrGranWnd | AverWindow | O | 0..1 | It indicates the aggregation granularity window for the measured data (NOTE 1).

The aggregation granularity window shall not exceed the duration of the measurement time period defined in the "measPeriod" attribute. | | +| measPeriod | MeasurementPeriod | O | 0..1 | It indicates the required measurement time period (NOTE 2). | | + +NOTE 1: If absent, 1 minute shall be used as default setting. + +NOTE 2: If absent, current time and 5 minutes duration shall be used as default setting. + +## 7.4.2.4.2.7 Type: MonitoringSubscription + +Table 7.4.2.4.2.7-1: Definition of type MonitoringSubscription + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| valUelds | array(ValTargetUe) | C | 1..N | List of VAL UEs which measurement data reporting is requested (NOTE 1). | | +| valGroupId | string | C | 0..1 | The group ID used for the VAL group for which measurement data reporting is requested (NOTE 1). | | +| valStreamIds | array(string) | C | 1..N | List of VAL streams for which measurement data reporting is requested (NOTE 1). | | +| measReqs | MeasurementRequirements | O | 0..1 | It indicates the measurement requirements (NOTE 2). | | +| reportReqs | ReportingRequirements | O | 0..1 | It indicates the requested requirements of reporting (NOTE 3). | | +| notifUri | Uri | C | 0..1 | It indicates the URI where the notification should be delivered to. The notifUri attribute shall be presented for subscription without immediate report. | | +| monRep | MonitoringReport | C | 0..1 | Contains the unicast QoS monitoring data reporting.

The NRM server shall provide this attribute when immediate reporting is requested and the requested data is available. | | +| reqTestNotif | boolean | O | 0..1 | Set to true to request the VAL server to send a test notification as defined in clause 6.6. Set to false or omitted otherwise. | Notification_test_event | +| wsNotifCfg | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.6. | Notification_websocket | +| suppFeat | SupportedFeatures | C | 0..1 | This parameter shall be supplied by VAL server in the POST request that request the creation of an individual measurement resource and shall be supplied in the reply of corresponding request. | | + +NOTE 1: Only one of these attributes shall be provided. + +NOTE 2: If absent, the default values shall be used. + +NOTE 3: If absent, the default event triggered reporting is used. + +7.4.2.4.2.8 Void + +7.4.2.4.2.9 Type: FailureReport + +**Table 7.4.2.4.2.9-1: Definition of type FailureReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valUelds | array(ValTargetUe) | C | 1..N | List of VAL UE(s) whose measurement data is not obtained successfully and is not provided (NOTE).

The VAL UE(s) may be member(s) of the VAL group identified by the "valGroupId" attribute in the MonitoringReport data structure. | | +| valStreamIds | array(string) | C | 1..N | List of VAL stream ID(s) whose measurement data is not obtained successfully and is not provided (NOTE). | | +| failureReason | FailureReason | M | 1 | Identifies the failure reason. | | +| measDataType | MeasurementDataType | C | 0..1 | The indication of the measurement data type that is not obtained successfully and is not provided in the monitoring report.

This attribute shall be provided if the failure reason does not apply to all the requested measurement data types. | | + +NOTE: Only one of these attributes shall be provided. + +7.4.2.4.2.10 Type: ReportingThreshold + +**Table 7.4.2.4.2.10-1: Definition of type ReportingThreshold** + +| Name | Data type | P | Cardinality | Description | Applicability | +|---------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| measThrValues | MeasurementData | M | 1 | Indicates the value(s) for the measurement threshold index(es). | | +| thrDirection | MatchingDirection | M | 1 | Indicates the threshold matching direction for the measurement threshold index(es) provided in the "measThrValues" attribute. | | + +7.4.2.4.2.11 Type: MonitoringSubscriptionPatch + +**Table 7.4.2.4.2.11-1: Definition of type MonitoringSubscriptionPatch** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------------|-------------------------|---|-------------|------------------------------------------------------------------|---------------| +| measReqs | MeasurementRequirements | O | 0..1 | Indicates the measurement requirements. | | +| reportReqs | ReportingRequirements | O | 0..1 | Indicates the reporting requirements. | | +| notifUri | Uri | O | 0..1 | Indicates the URI where the notification should be delivered to. | | + +#### 7.4.2.4.3 Simple data types and enumerations + +##### 7.4.2.4.3.1 Enumeration: MeasurementDataType + +**Table 7.4.2.4.3.1-1: Enumeration MeasurementDataType** + +| Enumeration value | Description | Applicability | +|-----------------------|----------------------------------------------------------------------------------|---------------| +| DL_DELAY | The indication for requesting the downlink packet delay data type. | | +| UL_DELAY | The indication for requesting the uplink packet delay data type. | | +| RT_DELAY | The indication for requesting the round trip packet delay data type. | | +| AVG_PLR | The indication for requesting the average packet loss rate data type. | | +| AVG_DATA_RATE | The indication for requesting the average data rate data type. | | +| MAX_DATA_RATE | The indication for requesting the maximum data rate data type. | | +| AVG_DL_TRAFFIC_VOLUME | The indication for requesting the average traffic volume for downlink data type. | | +| AVG_UL_TRAFFIC_VOLUME | The indication for requesting the average traffic volume for uplink data type. | | + +##### 7.4.2.4.3.2 Enumeration: TerminationMode + +**Table 7.4.2.4.3.2-1: Enumeration TerminationMode** + +| Enumeration value | Description | Applicability | +|-------------------------------------|---------------------------------------------------------------------------|---------------| +| TIME_TRIGGERED | The time-triggered termination mode. | | +| EVENT_TRIGGERED_NUM_REPORTS_REACHED | The event-triggered termination number of reports reached mode. | | +| EVENT_TRIGGERED_MEAS_THR_REACHED | The event-triggered termination measurement index threshold reached mode. | | +| USER_TRIGGERED | The user-triggered termination mode. | | + +##### 7.4.2.4.3.3 Enumeration: FailureReason + +**Table 7.4.2.4.3.3-1: Enumeration FailureReason** + +| Enumeration value | Description | Applicability | +|--------------------|--------------------------------------|---------------| +| USER_NOT_FOUND | The user is not found. | | +| STREAM_NOT_FOUND | The stream is not found. | | +| DATA_NOT_AVAILABLE | The requested data is not available. | | +| OTHER_REASON | Other reason (unspecified). | | + +##### 7.4.2.4.3.4 Enumeration: ThresholdHandlingMode + +**Table 7.4.2.4.3.4-1: Enumeration ThresholdHandlingMode** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------|---------------| +| ALL_REACHED | The decision criterion is met when all the provided thresholds are reached. | | +| ANY_REACHED | The decision criterion is met when any of the provided threshold(s) is reached. | | + +## 7.4.2.5 Error Handling + +### 7.4.2.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +### 7.4.2.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_NetworkResourceMonitoring API. + +### 7.4.2.5.3 Application Errors + +The application errors defined for SS\_NetworkResourceMonitoring API are listed in table 7.4.2.5.3-1. + +**Table 7.4.2.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 7.4.2.6 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.4.2.6-1 lists the supported features for SS\_NetworkResourceMonitoring API. + +**Table 7.4.2.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | The testing of notification connection is supported according to clause 6.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | UpdateSupport | Indicates the support of the Update_Unicast_QoS_Monitoring_Subscription service operation. This feature enables the support of both HTTP PUT and HTTP PATCH methods for the SS_NetworkResourceMonitoring API. | + +# 7.5 Event APIs + +## 7.5.1 SS\_Events API + +### 7.5.1.1 API URI + +The SS\_Events service shall use the SS\_Events API. + +The request URIs use in HTTP requests from the VAL server towards the SEAL server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-events". +- The shall be "v1". +- The shall be set as described in clause 7.5.1.2. + +## 7.5.1.2 Resources + +### 7.5.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.5.1.2.1-1 depicts the resource URIs structure for the SS\_Events API. + +![Diagram showing the hierarchical structure of resource URIs for the SS_Events API. The root URI is {apiRoot}/ss-events/, which branches into /subscriptions, which further branches into /{subscriptionId}.](9c12d7993e786817c8c569e6f2d5a0a9_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-events/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of resource URIs for the SS\_Events API. The root URI is {apiRoot}/ss-events/, which branches into /subscriptions, which further branches into /{subscriptionId}. + +**Figure 7.5.1.2.1-1: Resource URI structure of the SS\_Events API** + +Table 7.5.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.5.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------| +| SEAL Events Subscriptions | /subscriptions | POST | Creates a new individual SEAL Event Subscription. | +| Individual SEAL Events Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an individual SEAL Event Subscription identified by the subscriptionId. | +| | | PATCH | Modifies an individual SEAL Event subscription identified by the subscriptionId. | +| | | PUT | Updates an individual SEAL Event subscription identified by the subscriptionId. | + +### 7.5.1.2.2 Resource: SEAL Events Subscriptions + +#### 7.5.1.2.2.1 Description + +The SEAL Events Subscriptions represents all event subscriptions on the SEAL server. + +#### 7.5.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-events//subscriptions + +This resource shall support the resource URI variables defined in the table 7.5.1.2.2.2-1. + +**Table 7.5.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +### 7.5.1.2.2.3 Resource Standard Methods + +#### 7.5.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in the table 7.5.1.2.2.3.1-1. + +**Table 7.5.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.5.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.5.1.2.2.3.1-3. + +**Table 7.5.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------| +| SEALEventSubscription | M | 1 | Create a new individual SEAL Events Subscription resource. | + +**Table 7.5.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| SEALEventSubscription | M | 1 | 201
Created | SEAL Events Subscription resource created successfully.
The URI of the created resource shall be returned in the "Location" HTTP header | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.5.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-events//subscriptions/{subscriptionId} | + +### 7.5.1.2.2.4 Resource Custom Operations + +None. + +## 7.5.1.2.3 Resource: Individual SEAL Events Subscription + +### 7.5.1.2.3.1 Description + +The Individual SEAL Events Subscription resource represents an individual event subscription of a VAL server. + +### 7.5.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-events//subscriptions/{subscriptionId} + +This resource shall support the resource URI variables defined in the table 7.5.1.2.3.2-1. + +**Table 7.5.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|----------------|-----------|----------------------------------------------| +| apiRoot | string | See clause 6.5 | +| subscriptionId | string | Identifies an Individual Events Subscription | + +#### 7.5.1.2.3.3 Resource Standard Methods + +##### 7.5.1.2.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 7.5.1.2.3.3.1-1. + +**Table 7.5.1.2.3.3.1-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.5.1.2.3.3.1-2 and the response data structures and response codes specified in table 7.5.1.2.3.3.1-3. + +**Table 7.5.1.2.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.5.1.2.3.3.1-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual SEAL Events Subscription matching the subscriptionId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.5.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.5.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +### 7.5.1.2.3.3.2 PATCH + +This method shall support the URI query parameters specified in table 7.5.1.2.3.3.2-1. + +**Table 7.5.1.2.3.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.5.1.2.3.3.2-2 and the response data structures and response codes specified in table 7.5.1.2.3.3.2-3. + +**Table 7.5.1.2.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|-----------------------------------------------------------------------------------| +| SEALEventSubscriptionPatch | M | 1 | Contains the modifications to be applied to the SEAL Event subscription resource. | + +**Table 7.5.1.2.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SEALEventSubscription | M | 1 | 200 OK | SEAL Events Subscription resource is modified successfully and representation of the modified SEAL Event subscription is returned. | +| n/a | | | 204 No Content | The SEAL Events Subscription is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.5.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.5.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +### 7.5.1.2.3.3.3 PUT + +This method requests fully replacement of an existing Individual SEAL Events Subscription at the SEAL server. The request shall not update the values of the "subscriberId", "requestTestNotification" (if previously provisioned), "websocketNotifConfig" (if previously provisioned) and/or "suppFeat" attributes within the SEALEventSubscription data type. This method shall support the URI query parameters specified in table 7.5.1.2.3.3.3-1. + +**Table 7.5.1.2.3.3.3-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.5.1.2.3.3.3-2 and the response data structures and response codes specified in table 7.5.1.2.3.3.3-3. + +**Table 7.5.1.2.3.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------------| +| SEALEventSubscription | M | 1 | Contains the SEAL Event subscription to be updated. | + +**Table 7.5.1.2.3.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SEALEventSubscription | M | 1 | 200 OK | SEAL Event Subscription resource is updated successfully and representation of the modified SEAL Event subscription is returned. | +| n/a | | | 204 No Content | The SEAL Events Subscription is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.5.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.5.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +#### 7.5.1.2.3.4 Resource Custom Operations + +None. + +### 7.5.1.3 Notifications + +#### 7.5.1.3.1 General + +The delivery of notifications shall conform to clause 6.6. + +**Table 7.5.1.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------|---------------------------|---------------------------------|-------------------------------------| +| SEAL Event Notification | {notificationDestination} | POST | Notifies subscriber of a SEAL Event | + +### 7.5.1.3.2 SEAL Event Notification + +#### 7.5.1.3.2.1 Description + +SEAL Event Notification is used by the SEAL server notify a VAL server of an Event. The VAL server shall be subscribed to such SEAL Event Notifications via the Individual SEAL Events Subscription Resource. + +#### 7.5.1.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the VAL server during the subscription to the event. + +Callback URI: **{notificationDestination}** + +This method shall support the URI query parameters specified in table 7.5.1.3.2.2-1. + +**Table 7.5.1.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.5.1.3.2.2-2 and the response data structures and response codes specified in table 7.5.1.3.2.2-3. + +**Table 7.5.1.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------| +| SEALEventNotification | M | 1 | Notification information of a SEAL Event | + +**Table 7.5.1.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The receipt of the Notification is acknowledged. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative notification destination where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.5.1.3.2.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +**Table 7.5.1.3.2.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing the end point of an alternative notification destination towards which the notification should be redirected. | + +## 7.5.1.4 Data Model + +### 7.5.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.5.1.4.1-1 specifies the data types defined specifically for the SS\_Events API service. + +**Table 7.5.1.4.1-1: SS\_Events API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| EventSubscription | 7.5.1.4.2.4 | Represents the subscription to a single SEAL event. | | +| PartialEventSubscFailRep | 7.5.1.4.2.23 | Represents the partial failure report during the subscription creation. | PartialFailureSupport | +| IdentityFilter | 7.5.1.4.2.7 | Represents a filter of VAL User / UE identities belonging to a VAL service. | | +| LMInformation | 7.5.1.4.2.8 | The location information for a VAL User ID or a VAL UE ID. | | +| LocationAreaMonReport | 7.5.1.4.2.20 | Represents the event report to notify the VAL UEs moving in or moving out from a given location. | | +| LocationDevMonReport | 7.5.1.4.2.15 | Represents the event report to notify the VAL UE/User's location deviation from a given location. | | +| LocationInfoCriteria | 7.5.1.4.2.18 | Represents the location information to be monitored.
It includes the geographic location information or a reference UE along with the application defined proximity range from the reference UE. | | +| LocDevNotification | 7.5.1.4.3.4 | Enumeration of location deviation notification reports. | | +| MessageFilter | 7.5.1.4.2.9 | The message filter information applicable to member VAL UEs or Users of the VAL group in the group change notification. | | +| MonitorEvents | 7.5.1.4.2.11 | Represents the details of the monitoring and analytics events. | NRM_EventMonitor | +| MonitorEventsReport | 7.5.1.4.2.12 | Represents the monitoring and analytics events information related to VAL UE or User. | NRM_EventMonitor | +| MonitorFilter | 7.5.1.4.2.10 | Represents the filter information VAL User or UEs and the related events to be monitored. | NRM_EventMonitor | +| MonitorLocationInterestFilter | 7.5.1.4.2.14 | Filter information to subscribe for monitoring the VAL UE/User location in a given area of interest. | | +| MonLocAreaInterestFltr | 7.5.1.4.2.17 | Filter information to subscribe for location area monitoring information for a given area of interest. | | +| MonLocTriggerEvent | 7.5.1.4.3.5 | Identifies the triggering event in the location area monitor filtering. | | +| MoveInOutUEDetails | 7.5.1.4.2.21 | Represents the list of UEs either moved into the location area or moved out of the location area. | | +| ReferenceUEDetail | 7.5.1.4.2.19 | Represents the reference UE details | | +| SEALEvent | 7.5.1.4.3.3 | Represents the type of SEAL events that can be subscribed. | | +| SEALEventDetail | 7.5.1.4.2.5 | Represents the SEAL event detail. | | +| SEALEventNotification | 7.5.1.4.2.3 | Represents an individual SEAL Event Subscription Notification. | | +| SEALEventSubscription | 7.5.1.4.2.2 | Represents an individual SEAL Event Subscription resource. | | +| SEALEventSubscriptionPatch | 7.5.1.4.2.22 | Represents the parameters to request the modification of a SEAL Event subscription resource. | SubscUpdate | +| TempGroupInfo | 7.5.1.4.2.16 | Represents the created temporary VAL group information. | GM_TempGroup | +| VALGroupFilter | 7.5.1.4.2.6 | Represents a filter of VAL group identifiers belonging to a VAL service. | | +| ValidityConditions | 7.5.1.4.2.13 | Represents the temporal and/or spatial conditions applied for the events to be monitored. | NRM_EventMonitor | + +Table 7.5.1.4.1-2 specifies data types re-used by the SS\_Events API service: + +**Table 7.5.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| AnalyticsEvent | 3GPP TS 29.522 [28] | Analytics event in NWDAF. | NRM_EventMonitor | +| DateTime | 3GPP TS 29.571 [21] | Used to indicate a timestamp. | | +| DurationSec | 3GPP TS 29.571 [21] | Used to indicate the notification interval in the location monitoring filter. | | +| Float | 3GPP TS 29.571 [21] | Used to represent the fractional part of the proximity range in the reference UE details. | | +| GeographicArea | 3GPP TS 29.572 [31] | Identifies the geographical information of the user(s). | | +| LocationArea5G | 3GPP TS 29.122 [3] | User location area when the UE is attached to 5G. | NRM_EventMonitor | +| LocationInfo | 3GPP TS 29.122 [3] | Location information | | +| LocationQoS | 3GPP TS 29.572 [31] | Identifies QoS requested by VAL server. | LM_LocationInfoChange_Extension 1 | +| MonitoringType | 3GPP TS 29.122 [3] | Monitoring event type in 3GPP system core network. | NRM_EventMonitor | +| ProfileDoc | Clause 7.3.1.4.2.2 | Used to send VAL User or VAL UE profile information as part of event detail in the event notification. | | +| ReportingInformation | 3GPP TS 29.523 [20] | Used to indicate the reporting requirement, only the following information are applicable for SEAL:
- immRep
- notifMethod
- maxReportNbr
- monDur
- repPeriod | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [3] | Used to define the time frame for message filters. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.5.1.6-1. | | +| TestNotification | 3GPP TS 29.122 [3] | Following differences apply:
- The SCEF is the SEAL server; and
- The SCS/AS is the subscribing VAL server. | | +| TimeWindow | 3GPP TS 29.122 [3] | Time window identified by a start time and a stop time. | NRM_EventMonitor | +| Uinteger | 3GPP TS 29.571 [21] | Used to represent maximum number of messages in MessageFilter data type. | | +| Uri | 3GPP TS 29.122 [3] | Used to indicate a notification URI. | | +| VALGroupDocument | Clause 7.2.1.4.2.2 | Used to send VAL group document as part of event detail in the | | + +| | | | | +|--------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------|--| +| | | event notification. | | +| ValTargetUe | 7.3.1.4.2.3 | Used to identify a VAL user ID or a VAL UE ID. | | +| WebsockNotifConfig | 3GPP TS 29.122 [3] | Following differences apply:
- The SCEF is the CAPIF core function; and
- The SCS/AS is the Subscribing functional entity. | | + +#### 7.5.1.4.2 Structured data types + +##### 7.5.1.4.2.1 Introduction + +##### 7.5.1.4.2.2 SEALEventSubscription + +**Table 7.5.1.4.2.2-1: Definition of type SEALEventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| subscriberId | string | M | 1 | String identifying the subscriber of the event. | | +| eventSubs | array(EventSubscription) | M | 1..N | Subscribed events. | | +| eventReq | ReportingInformation | M | 1 | Represents the reporting requirements of the event subscription. | | +| notificationDestination | Uri | M | 1 | URI where the notification should be delivered to. | | +| requestTestNotification | boolean | O | 0..1 | Set to true by Subscriber to request the SEAL server to send a test notification as defined in clause 6.6. Set to false or omitted otherwise. | Notification_test_event | +| websocketNotifConfig | WebsockNotifConfig | O | 0..1 | Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 6.6. | Notification_websocket | +| eventDetails | array(SEALEventDetail) | C | 1..N | Detailed information of individual Events. Shall only be present in the response from the server if the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute is set to true, and the reports are available. | | +| suppFeat | Supported Features | O | 0..1 | Used to negotiate the supported optional features of the API as described in clause 6.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +##### 7.5.1.4.2.3 SEALEventNotification + +**Table 7.5.1.4.2.3-1: Definition of type SEALEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Identifier of the subscription resource to which the notification is related – SEAL resource identifier | | +| eventDetails | array(SEALEventDetail) | M | 1..N | Detailed notifications of individual Events. | | + +## 7.5.1.4.2.4 + +## EventSubscription + +Table 7.5.1.4.2.4-1: Definition of type EventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| eventId | SEALEvent | M | 1 | Subscribed event | | +| valGroups | array(VALGroupFilter) | C | 1..N | Each element of the array represents the VAL group identifier(s) of a VAL service that the subscriber wants to know in the interested event.
This parameter shall be present only if the event subscribed is "GM_GROUP_INFO_CHANGE". | GM_GroupInfoChange | +| Identities | array(IdentityFilter) | C | 1..N | Each element of the array represents the VAL User / UE IDs of a VAL service that the event subscriber wants to know in the interested event.
This parameter shall be present only if the event subscribed is "CM_USER_PROFILE_CHANGE" or "LM_LOCATION_INFO_CHANGE".
(NOTE) | CM_UserProfileChange,
LM_LocationInfoChange | +| monFltr | array(MonitorFilter) | C | 1..N | Each element of the array represents the event monitoring request details that the subscriber wishes to monitor the events related to a set of VAL UEs, VAL group and/or VAL service.
This parameter shall be present only if the event subscribed is "NRM_MONITOR_UE_USER_EVENTS" | NRM_EventMonitor | +| areaInt | array(MonitorLocationInterestFilter) | C | 1..N | Each element represent the list of VAL User / UE IDs and the area of interest information for which the subscriber wishes to monitor the location deviation of the VAL User / UEs.
This parameter shall be present only if the subscribed event is "LM_LOCATION_DEVIATION_MONITOR". | LM_LocationDeviation | +| locAreaMon | array(MonLocAreaInterestFltr) | C | 1..N | Each element represent the location area monitoring details that the subscriber wishes to monitor for the VAL UEs moving in or moving out of the provided location area.
This parameter shall be present only if the subscribed event is "LM_LOCATION_AREA_MONITOR". | LM_LocationAreaMonitor | +| partialFailRep | PartialEventSubscFailRep | C | 0..1 | The partial failure report from the SEAL server indicating the target identifier(s) whose event subscription is not created successfully.

This attribute shall be provided only if the PartialFailureSupport feature is supported and the event subscription is not created successfully for all requested target identifier(s). | PartialFailureSupport | + +NOTE: The "valSvcId" attribute within IdentityFilter is not applicable for the event "LM\_LOCATION\_INFO\_CHANGE". + +## 7.5.1.4.2.5 SEALEventDetail + +Table 7.5.1.4.2.5-1: Definition of type SEALEventDetail + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| eventId | SEALEvent | M | 1 | Event that is notified | | +| lmInfos | array(LMInformation) | C | 1..N | The location information for the interested VAL User IDs or VAL UE IDs. This parameter shall be present only if the event in event notification is "LM_LOCATION_INFO_CHANGE". | LM_LocationInfoChange | +| valGroupDocuments | array(VALGroupDocument) | C | 1..N | Newly created VAL group documents or the VAL groups documents with modified membership and configuration information. This parameter shall be present only if the event in event notification is "GM_GROUP_INFO_CHANGE" or "GM_GROUP_CREATE". | GM_GroupInfoChange, GM_GroupCreate | +| profileDocs | array(ProfileDoc) | C | 1..N | Updated profile information associated with VAL Users or VAL UEs. This parameter shall be present only if the event in event notification is "CM_USER_PROFILE_CHANGE". | CM_UserProfileChange | +| msgFiltrs | array(MessageFilter) | C | 1..N | The message filters applicable to various member VAL User or UEs of the VAL group. This parameter may be present only if the event in the even notification is "GM_GROUP_INFO_CHANGE" | GM_MessageFilter | +| monRep | array(MonitorEvents Report) | C | 1..N | The events report with details of the events related to VAL UE(s). This parameter shall be present only if the event in the event notification is "NRM_MONITOR_UE_USER_EVENTS" | NRM_EventMonitor | +| locAdhr | array(LocationDevMonReport) | C | 1..N | The location deviation information for the interested VAL User IDs or VAL UE IDs in a given location. This parameter shall be present only if the event in event notification is "LM_LOCATION_DEVIATION_MONITOR". | LM_LocationDeviation | +| tempGroupInfo | TempGroupInfo | C | 0..1 | Contains the created temporary VAL group information.

This attribute shall be present only if the "eventId" attribute is set to the value "GM_TEMP_GROUP_FORMATION". | GM_TempGroup | +| locAreaMonRep | array(LocationAreaMonReport) | C | 1..N | The location area monitoring information of the given area of interest. This parameter shall be present only if the event in event notification is "LM_LOCATION_AREA_MONITOR". | LM_LocationAreaMonitor or | + +## 7.5.1.4.2.6 VALGroupFilter + +Table 7.5.1.4.2.6-1: Definition of type VALGroupFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| valSvcId | string | O | 0..1 | Identity of the VAL Service that the subscriber is interested in. | | +| valGrpIds | array(string) | M | 1..N | VAL Group identifiers that the event subscriber wants to know in the interested event. | | + +## 7.5.1.4.2.7 IdentityFilter + +Table 7.5.1.4.2.7-1: Definition of type IdentityFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| valSvcId | string | O | 0..1 | Identity of the VAL Service that the subscriber is interested in. | | +| valTgtUes | array(ValTargetUe) | C | 1..N | VAL User IDs or VAL UE IDs that the event subscriber wants to know in the interested event. This parameter shall be present if the event subscribed is "CM_USER_PROFILE_CHANGE" or "LM_LOCATION_INFO_CHANGE". | | +| suppLoc | boolean | O | 0..1 | Indication to request for supplementary location information of the VAL UE IDs.

Set to true by Subscriber to request the SEAL server to send supplementary location information from the 3GPP core network. Set to false or omitted otherwise.

This parameter may be present if the event subscribed is "LM_LOCATION_INFO_CHANGE". | LM_SuppLoc | +| locQoS | LocationQoS | O | 0..1 | Indicates the expected location QoS requirement for which the location information is requested.

This parameter may be present if the event subscribed is "LM_LOCATION_INFO_CHANGE". | LM_LocationInfoChange_Extension1 | + +## 7.5.1.4.2.8 LMInformation + +Table 7.5.1.4.2.8-1: Definition of type LMInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| valTgtUe | ValTargetUe | M | 1 | VAL User ID or UE ID that the event subscriber wants to know in the interested event. | | +| locInfo | LocationInfo | M | 1 | The location information associated with the valTgtUe. | | +| timeStamp | DateTime | O | 0..1 | Timestamp of the location report | | +| valSvcId | string | O | 0..1 | The VAL service ID of the VAL application for which the location information is subscribed. | | + +## 7.5.1.4.2.9 MessageFilter + +Table 7.5.1.4.2.9-1: Definition of type MessageFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| reqUe | ValTargetUe | M | 1 | Identity of the VAL User ID or UE ID that the message filter information is related to. | | +| tgtUe | array(ValTargetUe) | O | 1..N | List of VAL USER or UE IDs whose messages will be sent to the VAL User or UE in reqUe attribute. | | +| maxMsgs | UInteger | O | 0..1 | Total number of messages allowed to be sent to the VAL User or UE in the given time frame in the filter. | | +| scheds | array(ScheduledCommunicationTime) | O | 1..N | Time frame associated to the total number of messages in mxMsgs attribute. | | +| msgTypes | array(string) | O | 1..N | List of message types be sent to VAL UE. | | + +## 7.5.1.4.2.10 MonitorFilter + +Table 7.5.1.4.2.10-1: Definition of type MonitorFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| idnts | array(ValTargetUe) | C | 1..N | Identities of the VAL Users or UEs whose events monitoring is requested. (NOTE 1) | | +| valSvcId | string | O | 0..1 | Identity of the VAL service. | | +| valGrpId | string | C | 0..1 | Identity of the VAL group of the target UEs whose events monitoring is requested. (NOTE 1) | | +| profId | string | C | 0..1 | The monitoring profile ID identifying a list of monitoring and/or analytics events. (NOTE 2) | | +| valCnds | array(ValueConditions) | O | 1..N | The temporal and/or spatial conditions applied for the events to be considered as valid. | | +| evntDets | array(MonitorEvents) | C | 1..N | List of monitoring and/or analytics events that the VAL server is interested in. (NOTE 2) | | + +NOTE 1: Either VAL users/UEs or a VAL group identifying VAL UEs shall be present. + +NOTE 2: Either event details or monitoring profile ID shall be present in the subscription request. The monitoring profile ID shall present in the subscription response when event details are provided in the subscription request. + +## 7.5.1.4.2.11 MonitorEvents + +Table 7.5.1.4.2.11-1: Definition of type MonitorEvents + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|----------------------------------------------|---------------| +| cnEvnts | array(MonitoringType) | O | 1..N | List of monitoring events related to VAL UE. | | +| anlEvnts | array(AnalyticsEvent) | O | 1..N | List of analytics events related to VAL UE. | | + +## 7.5.1.4.2.12 MonitorEventsReport + +**Table 7.5.1.4.2.12-1: Definition of type MonitorEventsReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|------------------------------------------------------------|---------------| +| tgtUe | ValTargetUe | M | 1 | VAL UE for which the events are related. | | +| evnts | array(MonitorEvents) | M | 1..N | List of monitoring and analytics events related to VAL UE. | | + +## 7.5.1.4.2.13 ValidityConditions + +**Table 7.5.1.4.2.13-1: Definition of type ValidityConditions** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------|---------------| +| locArea | LocationArea5G | O | 0..1 | Spatial validity conditions. | | +| tmWdws | array(TimeWindow) | O | 1..N | Time window validity conditions | | + +## 7.5.1.4.2.14 MonitorLocationInterestFilter + +**Table 7.5.1.4.2.14-1: Definition of type MonitorLocationInterestFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------|---------------| +| tgtUes | array(ValTargetUe) | M | 1..N | List of VAL User(s) or UE ID(s) for which location monitoring is requested for the given location information. | | +| locInt | LocationInfo | C | 0..1 | Location information where the VAL server wishes to monitor the target VAL UE(s) location deviation.
(NOTE) | | +| valSvCld | string | C | 0..1 | Identifier of the VAL service area where the VAL server wishes to monitor the target VAL UE(s) location deviation.
(NOTE) | ValSrvArea | +| notInt | DurationSec | M | 1 | Periodic time interval in which the LM server needs to notify the VAL UE's location information. | | + +NOTE: If the "ValSrvArea" feature is supported, then one of "locInt" or "valSvCld" attributes shall be provided; otherwise the "locInt" attribute shall be provided. + +## 7.5.1.4.2.15 LocationDevMonReport + +**Table 7.5.1.4.2.15-1: Definition of type LocationDevMonReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| tgtUes | array(ValTargetUe) | M | 1..N | VAL User ID(s) or UE ID(s) to which the report is related. | | +| locInfo | LocationInfo | M | 1 | The location information associated with the valTgtUe. | | +| notifType | LocDevNotification | M | 1 | Notification about the deviation of the VAL UE(s) in "valTgtUe" attribute to the location in "locInfo" attribute. | | + +## 7.5.1.4.2.16 TempGroupInfo + +**Table 7.5.1.4.2.16-1: Definition of type TempGroupInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valGrpIds | array(string) | M | 1..N | Contains a list of the identifiers of the VAL groups constituting the created temporary VAL group. | | +| tempValGrpId | string | M | 1 | Contains the identifier of the created temporary VAL group. | | +| valServIds | array(string) | O | 1..N | Contains a list of the identifiers of the VAL services for which communications are to be enabled on the created temporary VAL group. | | + +## 7.5.1.4.2.17 MonLocAreaInterestFltr + +**Table 7.5.1.4.2.17-1: Definition of type MonLocAreaInterestFltr** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------|---------------| +| locInfoCri | LocationInfoCriteria | M | 1 | Location area information where the VAL server wishes to monitor the VAL UE(s) moving in or moving out | | +| trigEvents | array(MonLocTriggerEvent) | O | 1..N | Identifies the triggering events when to send the notification. | | + +## 7.5.1.4.2.18 LocationInfoCriteria + +**Table 7.5.1.4.2.18-1: Definition of type LocationInfoCriteria** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------|---------------| +| geoArea | GeographicArea | C | 0..1 | Geographic location information where the VAL server wishes to monitor the VAL UE(s) moving in or moving out. | | +| valSvcAreaId | string | C | 0..1 | Identifier of the VAL service area. | ValSrvArea | +| refUe | ReferenceUEDetail | C | 0..1 | Reference UE details with proximity range where the VAL server wishes to monitor the VAL UE(s) moving in or moving out. | | + +NOTE: Either "geoArea" or "refUe" shall be provided. + +Editor's note: The definition and presence condition of "valSvcAreaId" attribute and its update in OpenAPI file is FFS. + +## 7.5.1.4.2.19 ReferenceUEDetail + +**Table 7.5.1.4.2.19-1: Definition of type ReferenceUEDetail** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valTgtUe | ValTargetUe | M | 1 | VAL User ID or UE ID that the event subscriber wants to know in the interested event. | | +| proxRange | UInteger | M | 1 | Proximity range of the area around the VAL target UE in meters. This attribute represents the integer part of the proximity range value. | | +| proxRangeFrac | Float | O | 0..1 | The fractional part of the proximity range value in meters. The minimum value of this attribute is 0. The maximum value of this attribute is 1. | | + +## 7.5.1.4.2.20 LocationAreaMonReport + +**Table 7.5.1.4.2.20-1: Definition of type LocationAreaMonReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| curPreUEs | array(ValTargetUe) | O | 1..N | List of the identities of all VAL UEs who are currently present in the given location area. | | +| moveInOutUEs | MoveInOutUEDetails | O | 0..1 | List of UEs either moved in to the location area or moved out of the location area. | | +| trigEvnt | MonLocTriggerEvent | O | 0..1 | Event that triggered the sending of the notification. | | + +NOTE: For first notification report "curPreUEs" shall be provided, for next notification report either "curPreUEs" or "moveInOutUEs" shall be present. + +## 7.5.1.4.2.21 MoveInOutUEDetails + +**Table 7.5.1.4.2.21-1: Definition of type MoveInOutUEDetails** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|---------------| +| moveInUEs | array(ValTargetUe) | O | 1..N | List of the identities of the VAL UEs who moved in to the given location area since previous notification. | | +| moveOutUEs | array(ValTargetUe) | O | 1..N | List of the identities of the VAL UEs who moved out of the given location area since previous notification. | | + +## 7.5.1.4.2.22 SEALEventSubscriptionPatch + +**Table 7.5.1.4.2.22-1: Definition of type SEALEventSubscriptionPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|--------------------------|---|-------------|------------------------------------------------------------------|---------------| +| eventSubs | array(EventSubscription) | O | 1..N | Subscribed events. | | +| eventReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. | | +| notificationDestination | Uri | O | 0..1 | URI where the notification should be delivered to. | | + +## 7.5.1.4.2.23 PartialEventSubscFailRep + +**Table 7.5.1.4.2.23-1: Definition of type PartialEventSubscFailRep** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valTgtUes | array(ValTargetUe) | O | 1..N | List of VAL user(s) / VAL UE(s) whose identifier(s) is not found.

This attribute may be present only if the subscribed event is "CM_USER_PROFILE_CHANGE", "LM_LOCATION_INFO_CHANGE", "NRM_MONITOR_UE_USER_EVENTS", or "LM_LOCATION_DEVIATION_MONITOR". | | +| valGrplds | array(string) | O | 1..N | List of VAL group(s) whose identifier(s) is not found.

This attribute may be present only if the subscribed event is "GM_GROUP_INFO_CHANGE". | | + +NOTE: Either the "valTgtUes" attribute or the "valGrplds" attribute shall be present. + +## 7.5.1.4.3 Simple data types and enumerations + +## 7.5.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 7.5.1.4.3.2 Simple data types + +None. + +## 7.5.1.4.3.3 Enumeration: SEALEvent + +**Table 7.5.1.4.3.3-1: Enumeration SEALEvent** + +| Enumeration value | Description | Applicability | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------| +| LM_LOCATION_INFO_CHANGE | Events related to the location information of VAL Users or VAL UEs from the Location Management Server. | LM_LocationInfoChange | +| GM_GROUP_INFO_CHANGE | Events related to the modification of VAL group membership and configuration information from the Group Management Server. | GM_GroupInfoChange | +| CM_USER_PROFILE_CHANGE | Events related to update of user profile information from the Configuration Management Server. | CM_UserProfileChange | +| GM_GROUP_CREATE | Events related to creation of new VAL groups from the Group Management Server. | GM_GroupCreate | +| NRM_MONITOR_UE_USER_EVENTS | Monitoring and analytic events related to VAL UEs, users or VAL group from the Network Resource Management Server. | NRM_EventMonitor | +| LM_LOCATION_DEVIATION_MONITOR | Events from Location Management Server, related to the deviation of the VAL User(s) / UE(s) location from an area of interest. | LM_LocationDeviation | +| GM_TEMP_GROUP_FORMATION | Events related to the formation of new temporary VAL groups from the Group Management Server. | GM_TempGroup | +| LM_LOCATION_AREA_MONITOR | Events from Location Management Server, related to the list of UEs moving in or moving out of the specific location. | LM_LocationAreaMonitor | + +## 7.5.1.4.3.4 Enumeration: LocDevNotification + +**Table 7.5.1.4.3.4-1: Enumeration LocDevNotification** + +| Enumeration value | Description | Applicability | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| NOTIFY_MISMATCH_LOCATION | This value indicates that the location information of the VAL UE(s) from the SEAL LM client and the core network are not matching. | | +| NOTIFY_ABSENCE | This value indicates that the current location information of the VAL UE(s) is deviating from the VAL server's area of interest. | | +| NOTIFY_PRESENCE | This value indicates that the current location information of the VAL UE(s) is within the VAL server's area of interest. | | + +## 7.5.1.4.3.5 Enumeration: MonLocTriggerEvent + +**Table 7.5.1.4.3.5-1: Enumeration MonLocTriggerEvent** + +| Enumeration value | Description | Applicability | +|--------------------|-----------------------------------------------------------------------------------------------------|---------------| +| DISTANCE_TRAVELLED | Trigger event for the location area monitoring based on the distance travelled by the reference UE. | | + +## 7.5.1.5 Error Handling + +## 7.5.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.5.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_Events API. + +## 7.5.1.5.3 Application Errors + +The application errors defined for SS\_Events API are listed in table 7.5.1.5.3-1. + +**Table 7.5.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +**Editor's note:** The application errors for the SS\_Events API are FFS. + +## 7.5.1.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.5.1.6-1 lists the supported features for SS\_Events API. + +**Table 7.5.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Notification_test_event | Testing of notification connection is supported according to clause 6.6. | +| 2 | Notification_websocket | The delivery of notifications over Websocket is supported according to clause 6.6. This feature requires that the Notification_test_event feature is also supported. | +| 3 | LM_LocationInfoChange | This feature supports the location information change event. | +| 4 | GM_GroupInfoChange | This feature supports the group information change event. | +| 5 | CM_UserProfileChange | This feature supports the user profile change event. | +| 6 | GM_GroupCreate | This feature supports the group creation event. | +| 7 | GM_MessageFilter | This feature supports the message filter information in group information change event. | +| 8 | NRM_EventMonitor | This feature supports the monitoring of events related to VAL UEs or Users. | +| 9 | LM_LocationDeviation | This feature supports the monitoring of VAL UE / User's deviation from a given area of interest. | +| 10 | GM_TempGroup | This feature supports the functionality of temporary VAL group formation within a VAL system. | +| 11 | LM_LocationAreaMonitor | This feature supports the monitoring of VAL UEs which are moving in or moving out from a given area of interest. | +| 12 | SubscUpdate | Indicates the support for updating an SEAL event subscription resource. | +| 13 | LM_SuppLoc | This feature indicates the support of supplementary location information.

This feature requires the support of the LM_LocationInfoChange feature. | +| 14 | enNB1 | This feature indicates the support of enhancements to this application layer API in Rel-18. | +| 15 | PartialFailureSupport | Indicates the support of the partial failure cases during a SEAL event subscription creation/update. | +| 16 | ValSrvArea | This feature indicates the support of VAL service area ID functionality as part of the phase-3 of the enhancements to the SEAL framework.

The following functionalities are supported:
- Support the usage of the VAL service area identifier to identify a VAL service area. | +| 17 | LM_LocationInfoChange_Extension 1 | This feature indicates the support of the enhancement to location information change event as part of the 5G-enabled fused location service capability exposure.

The following functionalities are supported:
- Support location information requests with expected location QoS requirements.

This feature requires the support of the LM_LocationInfoChange feature. | + +## 7.6 Key management APIs + +### 7.6.1 SS\_KeyInfoRetrieval API + +#### 7.6.1.1 API URI + +The request URI used in each HTTP request from the VAL server towards the Key management server shall have the structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-kir". + +- The shall be "v1". +- The shall be set as described in clause 7.6.1.2. + +## 7.6.1.2 Resources + +### 7.6.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.6.1.2.1-1 depicts the resource URIs structure for the SS\_KeyInfoRetrieval API. + +![Diagram showing the hierarchical structure of the Resource URI for the SS_KeyInfoRetrieval API. The root is {apiRoot}/ss-kir/, which branches to /key-records, which in turn branches to /{keyRecordId}.](bc41ad2c9e0c15b7e0564466eb61621f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-kir/"] --> KeyRecords["/key-records"] + KeyRecords --> KeyRecordId["/{keyRecordId}"] + +``` + +Diagram showing the hierarchical structure of the Resource URI for the SS\_KeyInfoRetrieval API. The root is {apiRoot}/ss-kir/, which branches to /key-records, which in turn branches to /{keyRecordId}. + +**Figure 7.6.1.2.1-1: Resource URI structure of the SS\_KeyInfoRetrieval API** + +Table 7.6.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.6.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------|--------------|---------------------------------|---------------------------------------------------------------------------------------------| +| Key records | /key-records | GET | Retrieve key management information uniquely applicable to VAL service, VAL user or VAL UE. | + +### 7.6.1.2.2 Resource: Key Records + +#### 7.6.1.2.2.1 Description + +The Key Records resource represents the key management information of all VAL services that are created at a given key management server. + +#### 7.6.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-kir//key-records + +This resource shall support the resource URI variables defined in the table 7.6.1.2.2.2-1. + +**Table 7.6.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +## 7.6.1.2.2.3 Resource Standard Methods + +## 7.6.1.2.2.3.1 GET + +This operation retrieves VAL service key management information satisfying the filter criteria. This method shall support the URI query parameters specified in table 7.6.1.2.2.3.1-1. + +**Table 7.6.1.2.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------| +| val-tgt-ue | ValTargetUe | O | 0..1 | Identifying a VAL user or a VAL UE. | +| val-service-id | string | M | 1 | String identifying a VAL service. | + +This method shall support the request data structures specified in table 7.6.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.6.1.2.2.3.1 -3. + +**Table 7.6.1.2.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.6.1.2.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ValKeyInfo | M | 1 | 200 OK | Key management information specific to VAL service, VAL user or VAL UE. This response shall include key management information matching the query parameters provided in the request. | +| n/a | | | 307 Temporary Redirect | Temporary redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative key management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection, during resource retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative key management server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.6.1.2.2.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative key management server. | + +**Table 7.6.1.2.2.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative key management server. | + +#### 7.6.1.2.2.4 Resource Custom Operations + +None. + +#### 7.6.1.3 Notifications + +None. + +#### 7.6.1.4 Data Model + +##### 7.6.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.6.1.4.1-1 specifies the data types defined specifically for the SS\_KeyInfoRetrieval API service. + +**Table 7.6.1.4.1-1: SS\_KeyInfoRetrieval API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------|-----------------|----------------------------------------------------------------------------|---------------| +| ValKeyInfo | 7.6.1.4.2.3 | Key management information associated with VAL server, VAL user or VAL UE. | | + +Table 7.6.1.4.1-2 specifies data types re-used by the SS\_KeyInfoRetrieval API service. + +**Table 7.6.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------|--------------------|---------------------------------------------------------------------------------------|---------------| +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to identify a VAL User ID or VAL UE ID applicable to key management information. | | + +##### 7.6.1.4.2 Structured Data Types + +###### 7.6.1.4.2.1 Introduction + +###### 7.6.1.4.2.2 ValKeyInfo + +**Table 7.6.1.4.2.3-1: Definition of type ValKeyInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------|---------------| +| userUri | Uri | M | 1 | URI of the user for which the response is intended. | | +| skmsId | string | O | 0..1 | String identifying the SEAL key management server, sending the response. | | +| valService | string | M | 1 | String identifying the VAL service. This attribute shall be same as in the HTTP GET request. | | +| valTgtUe | ValTargetUe | O | 0..1 | String identifying a VAL user or VAL UE. This value depends on the value that was in the HTTP GET request. | | +| keyInfo | string | M | 1 | Key management information uniquely applicable to the requested VAL service, VAL user or VAL UE or VAL client. | | + +### 7.6.1.4.3 Simple data types and enumerations + +None. + +### 7.6.1.5 Error Handling + +#### 7.6.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +#### 7.6.1.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_KeyInfoRetrieval API. + +#### 7.6.1.5.3 Application Errors + +The application errors defined for SS\_KeyInfoRetrieval API are listed in table 7.6.1.5.3-1. + +**Table 7.6.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.6.1.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.6.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 7.7 Network slice capability Enablement APIs + +### 7.7.1 SS\_NetworkSliceAdaptation API + +#### 7.7.1.1 API URI + +The request URI used in each HTTP request from the VAL server towards the NSCE server shall have the structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-nsa". +- The shall be "v1". +- The shall be set as described in clause 7.7.1.3. + +#### 7.7.1.2 Resources + +There are no resources defined for this API in this release of the specification. + +### 7.7.1.3 Custom Operations without associated resources + +#### 7.7.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.7.1.3.1-1 depicts the resource URIs structure for the SS\_NetworkSliceAdaptation API. + +![Diagram showing the URI structure for the SS_NetworkSliceAdaptation API. The root path is {apiRoot}/ss-nsa/. A dashed box labeled /request is connected to the root path by a line, indicating it is a sub-path.](9fd6e7ee2ef576eea5eb455b7ee80ed6_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-nsa/"] --- Request["/request"] + style Request stroke-dasharray: 5 5 + +``` + +Diagram showing the URI structure for the SS\_NetworkSliceAdaptation API. The root path is {apiRoot}/ss-nsa/. A dashed box labeled /request is connected to the root path by a line, indicating it is a sub-path. + +**Figure 7.7.1.3.1-1: Custom operation URI structure of the SS\_NetworkSliceAdaptation API** + +Table 7.7.1.3.1-1 provides an overview of the custom operation and applicable HTTP methods. + +**Table 7.7.1.3.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|---------------------------------------| +| Request | /request | POST | Request the network slice adaptation. | + +#### 7.7.1.3.2 Operation: Request + +##### 7.7.1.3.2.1 Description + +The custom operation allows a VAL server to request network slice adaptation to the NSCE server. + +##### 7.7.1.3.2.2 Operation Definition + +This operation shall support the request and response data structures and response code specified in table 7.7.1.3.2.2-1 and table 7.7.1.3.2.2-2. + +**Table 7.7.1.3.2.2-1: Data structures supported by the POST Request Body for this operation** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------| +| NwSliceAdptInfo | M | 1 | Parameters to request network slice adaptation. | + +**Table 7.7.1.3.2.2-2: Data structures supported by the POST Response Body for this operation** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The success of the network slice adaptation with the underlying network. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI representing an alternative NSCE server to which the request should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI representing an alternative NSCE server to which the request should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] also apply. + +**Table 7.7.1.3.2.2-3: Headers supported by 307 Response Code for this operation** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing an alternative NSCE server to which the request should be redirected. | + +**Table 7.7.1.3.2.2-4: Headers supported by 308 Response Code for this operation** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI representing an alternative NSCE server to which the request should be redirected. | + +## 7.7.1.4 Notifications + +None. + +## 7.7.1.5 Data Model + +### 7.7.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.7.1.5.1-1 specifies the data types defined specifically for the SS\_NetworkSliceAdaptation API service. + +**Table 7.7.1.5.1-1: SS\_NetworkSliceAdaptation API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------|-----------------|------------------------------------------------------------------------------------------------------------|---------------| +| NwSliceAdptInfo | 7.7.1.5.2.3 | Represents the information associated with requested network slice adaptation with the underlying network. | | + +Table 7.7.6.1.4.1-2 specifies data types re-used by the NetworkSliceAdaptation API service. + +**Table 7.7.1.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------------|---------------------------------------------------------------|---------------| +| Dnn | 3GPP TS 29.571 [21]
1 | Used to Identify a DNN. | | +| Snssai | 3GPP TS 29.571 [21]
1 | Used to Identify the S-NSSAI. | | +| SupportedFeatures | 3GPP TS 29.571 [21]
1 | Used to negotiate the applicability of the optional features. | | + +NOTE: Properties marked with a feature as defined in clause 5.14.6 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [4]. If no feature is indicated, the related property applies for all the features. + +## 7.7.1.5.2 Structured Data Types + +### 7.7.1.5.2.1 Introduction + +### 7.7.1.5.2.2 Type: NwSliceAdptInfo + +**Table 7.7.1.5.2.2-1: Definition of type NwSliceAdptInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valServiceId | string | M | 1 | The VAL service ID of the VAL application for which the network slice adaptation may corresponds to. | | +| valTgtUeIds | array(string) | M | 1..N | List of the VAL UE IDs within the VAL service for which the slice adaptation request corresponds. | | +| snssai | Snssai | O | 0..1 | Indication of the new S-NSSAI which is requested. | | +| dnn | Dnn | O | 0..1 | Indication of the new DNN which is requested. | | +| suppFeat | Supported Features | O | 0..1 | This parameter shall be supplied by VAL server in the POST request that requests the network slice adaptation and shall be supplied in the reply of corresponding request. | | + +NOTE: Properties marked with a feature as defined in clause 7.7.1.7 are applicable as described in clause 5.2.7 of 3GPP TS 29.122 [3]. If no feature is indicated, the related property applies for all the features. + +## 7.7.1.5.3 Simple data types and enumerations + +None. + +## 7.7.1.6 Error Handling + +### 7.7.1.6.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +### 7.7.1.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_NetworkSliceAdaptation API. + +### 7.7.1.6.3 Application Errors + +The application errors defined for SS\_NetworkSliceAdaptation API are listed in table 7.7.1.6.3-1. + +**Table 7.7.1.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.7.1.7 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.7.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 7.8 Identity management APIs + +### 7.8.1 SS\_IdmParameterProvisioning API + +#### 7.8.1.1 API URI + +The SS\_IdmParameterProvisioning service shall use the SS\_IdmParameterProvisioning API. + +The request URIs used in HTTP requests from the VAL server towards the Identity management server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-ipp". +- The shall be "v1". +- The shall be set as described in clause 7.8.1.2. + +#### 7.8.1.2 Resources + +##### 7.8.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.8.1.2.1-1 depicts the resource URIs structure for the SS\_IdmParameterProvisioning API. + +![Diagram showing the hierarchical structure of Resource URIs for the SS_IdmParameterProvisioning API. The root URI is {apiRoot}/ss-ipp/. It branches to /configurations, which further branches to /{confId}.](741c2d8e08326c0614ebad35520ce985_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-ipp/"] --> Configurations["/configurations"] + Configurations --> ConfId["/{confId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the SS\_IdmParameterProvisioning API. The root URI is {apiRoot}/ss-ipp/. It branches to /configurations, which further branches to /{confId}. + +**Figure 7.8.1.2.1-1: Resource URI structure of the SS\_IdmParameterProvisioning API** + +Table 7.8.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.8.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------|--------------------------|---------------------------------|-------------------------------------------------------------------------| +| VAL Services Configurations | /configurations | POST | Provision VAL services configuration. | +| | | GET | Retrieve VAL services configurations according to the query parameters. | +| Individual VAL Services Configuration | /configurations/{confld} | GET | Retrieve an existing individual VAL services configuration resource. | +| | | PUT | Update an individual VAL services configuration. | +| | | PATCH | Partially update an individual VAL services configuration. | +| | | DELETE | Deletes an individual VAL services configuration. | + +### 7.8.1.2.2 Resource: VAL Services Configurations + +#### 7.8.1.2.2.1 Description + +The VAL Services Configurations resource represents all the VAL services configurations that are provisioned at the IM Server. + +#### 7.8.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-ipp//configurations + +This resource shall support the resource URI variables defined in the table 7.8.1.2.2.2-1. + +**Table 7.8.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.8.1.2.2.3 Resource Standard Methods + +##### 7.8.1.2.2.3.1 POST + +This method shall support the URI query parameters specified in table 7.8.1.2.2.3.1-1. + +**Table 7.8.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.8.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.8.1.2.2.3.1-3. + +**Table 7.8.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|----------------------------------------------------------------------| +| VALServicesConfig | M | 1 | Details of the VAL services configurations that needs to be created, | + +**Table 7.8.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALServicesConfig | O | 0..1 | 201 Created | Successful case. The requested VAL services configuration are successfully created.

The URI of the created resource shall be returned in the "Location" HTTP header. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.8.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure:
{apiRoot}/ss-ipp//configurations/{valSvcConfId} | + +#### 7.8.1.2.2.3.2 GET + +This operation retrieves the VAL services configurations satisfying filter criteria. This method shall support the URI query parameters specified in table 7.8.1.2.2.3.2-1. + +**Table 7.8.1.2.2.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------|---------------|---|-------------|----------------------------------------------------------------------------------------| +| val-server-id | string | O | 0..1 | String identifying the VAL server. | +| config-ids | array(string) | O | 1..N | List of identifiers identifying the "Individual VAL Services Configuration" resources. | + +This method shall support the request data structures specified in table 7.8.1.2.2.3.2-2 and the response data structures and response codes specified in table 7.8.1.2.2.3.2-3. + +**Table 7.8.1.2.2.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.8.1.2.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(VALServiceSConfig) | M | 0..N | 200 OK | List of VAL services configurations matching the query parameters provided in the request. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. | | | | | + +**Table 7.8.1.2.2.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +**Table 7.8.1.2.2.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +#### 7.8.1.2.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 7.8.1.2.3 Resource: Individual VAL Services Configuration + +##### 7.8.1.2.3.1 Description + +The "Individual VAL Services Configuration" resource represents an individual VAL services configuration that is provisioned at a given IM server. + +##### 7.8.1.2.3.2 Resource Definition + +Resource URI: {apiRoot}/ss-ipp//configurations/{confId} + +This resource shall support the resource URI variables defined in the table 7.8.1.2.3.2-1. + +**Table 7.8.1.2.3.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|---------------------------------------------------------------| +| apiRoot | string | See clause 6.5 | +| confId | string | Represents an individual VAL services configuration resource. | + +##### 7.8.1.2.3.3 Resource Standard Methods + +###### 7.8.1.2.3.3.1 GET + +This operation retrieves an "Individual VAL Services Configuration" resource. This method shall support the URI query parameters specified in table 7.8.1.2.3.3.1-1. + +**Table 7.8.1.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 7.8.1.2.3.3.1-2 and the response data structures and response codes specified in table 7.8.1.2.3.3.1-3. + +**Table 7.8.1.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.8.1.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALServicesConfig | M | 1 | 200 OK | The VAL services configuration resource. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.8.1.2.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +**Table 7.8.1.2.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +#### 7.8.1.2.3.3.2 PUT + +This operation updates the VAL service configuration information. This method shall support the URI query parameters specified in table 7.8.1.2.3.3.2-1. + +**Table 7.8.1.2.3.3.2-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.8.1.2.3.3.2-2 and the response data structures and response codes specified in table 7.8.1.2.3.3.2-3. + +**Table 7.8.1.2.3.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-------------------------------------------------------------------| +| VALServicesConfig | M | 1 | Represents the updated details of the VAL services configuration. | + +**Table 7.8.1.2.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALServicesConfig | M | 1 | 200 OK | The VAL services configuration updated successfully and the updated VAL services configuration returned in the response. | +| n/a | | | 204 No Content | The VAL services configuration updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.8.1.2.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +**Table 7.8.1.2.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +#### 7.8.1.2.3.3.3 PATCH + +This method shall support the URI query parameters specified in table 7.8.1.2.3.3.3-1. + +**Table 7.8.1.2.3.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.8.1.2.3.3.3-2 and the response data structures and response codes specified in table 7.8.1.2.3.3.3-3. + +**Table 7.8.1.2.3.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------| +| VALServicesConfigPatch | M | 1 | Represents the requested modifications to be applied to the Individual VAL Services Configuration resource. | + +**Table 7.8.1.2.3.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| VALServicesConfig | M | 1 | 200 OK | Individual VAL Services Configuration resource is modified successfully and representation of the modified VAL Services Configuration resource is returned. | +| n/a | | | 204 No Content | The Individual VAL Services Configuration resource is updated successfully. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SEAL server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.8.1.2.3.3.3-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +**Table 7.8.1.2.3.3.3-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative SEAL server. | + +#### 7.8.1.2.3.3.4 DELETE + +This operation deletes the VAL services configuration. This method shall support the URI query parameters specified in table 7.8.1.2.3.3.4-1. + +**Table 7.2.1.2.3.3.4-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.8.1.2.3.3.4-2 and the response data structures and response codes specified in table 7.8.1.2.3.3.4-3. + +**Table 7.8.1.2.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.8.1.2.3.3.4-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The individual VAL service configuration matching the conflId is deleted. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative IM server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [3] also apply. + +**Table 7.8.1.2.3.3.4-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +**Table 7.8.1.2.3.3.4-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located in an alternative IM server. | + +#### 7.8.1.2.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +#### 7.8.1.3 Custom operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +#### 7.8.1.4 Notifications + +There are no notifications defined for this API in this release of the specification. + +#### 7.8.1.5 Data Model + +##### 7.8.1.5.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. Table 7.8.1.5.1-1 specifies the data types defined specifically for the SS\_IdmParameterProvisioning API service. + +**Table 7.8.1.5.1-1: SS\_IdmParameterProvisioning API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------|-----------------|-------------------------------------------------------------------------------------------|---------------| +| VALServicesConfig | 7.8.1.5.2.2 | Represents details of the VAL server services configuration information. | | +| VALServicesParams | 7.8.1.5.2.3 | Represent details of the VAL services configuration information. | | +| VALServicesConfigPatch | 7.8.1.5.2.4 | Represent details of the partial update of VAL server services configuration information. | | + +Table 7.8.1.5.1-2 specifies data types re-used by the SS\_IdmParameterProvisioning API service. + +**Table 7.8.1.5.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|-------------------------------------------------------------------------------------------|---------------| +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of optional features defined in table 7.8.1.6-1. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID, that are provisioned for a VAL service. | | + +#### 7.8.1.5.2 Structured data types + +##### 7.8.1.5.2.1 Introduction + +##### 7.8.1.5.2.2 Type: VALServicesConfig + +**Table 7.8.1.5.2.2-1: Definition of type VALServicesConfig** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| valSvcConf | array(VALServiceParams) | M | 1..N | List of VAL services and the VAL services specific information. | | +| valServerId | string | M | 1 | Identity of the VAL server (VAL server ID) as per TS 23.434 [2] that has provisioned the VAL services configuration information. | | +| suppFeat | Supported Features | O | 0..1 | Used to negotiate the supported optional features of the API as described in clause 6.8.
This attribute shall be provided in the HTTP POST request and in the response of successful resource creation. | | + +##### 7.8.1.5.2.3 Type: VALServiceParams + +**Table 7.8.1.5.2.3-1: Definition of type VALServiceParams** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| valServiceId | string | M | 1 | Identifier of the VAL service whose information is provisioned. | | +| idList | array(ValTargetUe) | M | 1..N | List of VAL User IDs or VAL UE IDs, which are provisioned for the VAL service identified by valServiceId. | | + +7.8.1.5.2.4 Type: VALServicesConfigPatch + +**Table 7.8.1.5.2.4-1: Definition of type VALServicesConfigPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-----------------------------------------------------------------|---------------| +| valSvcConf | array(VALServiceParams) | O | 1..N | List of VAL services and the VAL services specific information. | | + +7.8.1.5.3 Simple data types and enumerations + +None. + +7.8.1.6 Error Handling + +7.8.1.6.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +7.8.1.6.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the SS\_IDMParameterProvisioning API. + +7.8.1.6.3 Application Errors + +The application errors defined for SS\_IDMParameterProvisioning API are listed in table 7.8.1.5.3-1. + +**Table 7.8.1.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +7.8.1.7 Feature negotiation + +General feature negotiation procedures are defined in clause 6.8. + +**Table 7.8.1.7-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 7.9 Data Delivery APIs + +SEALDD APIs are defined in 3GPP TS 29.548 [35]. + +## 7.10 Application data analytics enablement service configuration APIs + +### 7.10.1 SS\_ADAE\_VALPerformanceAnalytics API + +#### 7.10.1.1 API URI + +The SS\_ADAE\_VALPerformanceAnalytics service shall use the SS\_ADAE\_VALPerformanceAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-pa". +- The shall be "v1". +- The shall be set as described in clause 7.10.1.2. + +**Editor's Note:** Definitions of service operations descriptions for this API is FFS. + +**Editor's Note:** The OpenAPI for this API is FFS. + +#### 7.10.1.2 Resources + +##### 7.10.1.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.1.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_VALPerformanceAnalytics API. + +![Diagram showing the hierarchical structure of the Resource URI for the SS_ADAE_VALPerformanceAnalytics API. The root URI is {apiRoot}/ss-adae-pa/. It branches to /application-performance, which further branches to /{appPerfId}.](856d74cd46a3f383d2ffd19352028610_img.jpg) + +``` +graph TD; A["{apiRoot}/ss-adae-pa/"] --> B["/application-performance"]; B --> C["/{appPerfId}"]; +``` + +Diagram showing the hierarchical structure of the Resource URI for the SS\_ADAE\_VALPerformanceAnalytics API. The root URI is {apiRoot}/ss-adae-pa/. It branches to /application-performance, which further branches to /{appPerfId}. + +**Figure 7.10.1.2.1-1: Resource URI structure of the SS\_ADAE\_VALPerformanceAnalytics API** + +Table 7.10.1.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.1.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|-------------------------------------------------------|--------------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------| +| Application performance event subscription | /application-performance | POST | Subscription to the event of:
- VAL performance analytics; or
- VAL performance data collection | +| Individual application performance event subscription | /application-performance/{appPerfId} | GET | Request the retrieval of an existing "Individual subscription to the event of the application performance analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the application performance analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the application performance analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the application performance analytics" resource. | + +Editor's Note: Definitions of GET, PUT, PATCH, DELETE methods are FFS. + +#### 7.10.1.2.2 Resource: Application performance event subscription + +##### 7.10.1.2.2.1 Description + +The application performance event subscription to the event of the VAL performance analytics or the event of the VAL performance historic data logs. + +##### 7.10.1.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-pa//application-performance + +This resource shall support the resource URI variables defined in the table 7.10.1.2.2.2-1. + +**Table 7.10.1.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +##### 7.10.1.2.2.3 Resource Standard Methods + +###### 7.10.1.2.2.3.1 POST + +This method to subscribe to the event of the VAL performance analytics and shall support the URI query parameters specified in table 7.10.1.2.2.3.1-1. + +**Table 7.10.1.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.1.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.1.2.2.3.1-3. + +**Table 7.10.1.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AppPerfSubs | M | 1 | Subscription to the event of:
- VAL performance analytics; or
- VAL performance data collection. | + +**Table 7.10.1.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------| +| AppPerfSubs | | | 201 (Created) | Subscription to the VAL performance analytics or the VAL performance historic logs is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.1.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-pa//application-performance | + +#### 7.10.1.2.2.4 Resource Custom Operations + +None. + +### 7.10.1.3 Notifications + +#### 7.10.1.3.1 General + +**Table 7.10.1.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------------|-------------------|---------------------------------|------------------------------------------------------------------------------------------| +| Application performance event notification | {notificationUri} | POST | Notification on:
- VAL performance analytics; or
- VAL performance data collection | + +#### 7.10.1.3.2 Application performance event notification + +##### 7.10.1.3.2.1 Description + +Application performance event notification is to notify on the event of the VAL performance analytics or the event of the VAL performance historic logs. + +##### 7.10.1.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {**notificationUri**} + +This method shall support the URI query parameters specified in table 7.10.1.3.2.2-1. + +**Table 7.10.1.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the VAL performance analytics or the VAL performance historic logs, this method shall support the request data structures specified in table 7.10.1.3.2.2-2 and the response data structures and response codes specified in table 7.10.1.3.2.2-3. + +**Table 7.10.1.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------------------------------------------------------| +| AppPerfNotif | M | 1 | Notification on:
- VAL performance analytics; or
- VAL performance data collection. | + +**Table 7.10.1.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|--------------------------------------------------------------------------------------------------------| +| n/a | | | 204 (No Content) | Notification for the VAL performance analytics event or VAL performance historic data log is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.1.4 Data Model + +### 7.10.1.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.1.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_VALPerformanceAnalytics API service. + +**Table 7.10.1.4.1-1 SS\_ADAE\_VALPerformanceAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-----------------|-----------------|---------------------------------------------------------------------------------------------------|---------------| +| AppPerfSubs | 7.10.1.4.2.2 | Subscription to the VAL application performance analytics | | +| AppPerfNotif | 7.10.1.4.2.3 | Notification information of the application performance analytics. | | +| ProdProfileInfo | 7.10.1.4.2.4 | Information about the data producer's support data collection and its access to the produced data | | +| DataCollectReq | 7.10.1.4.2.5 | Data Collection requirements | | +| AnalyticsType | 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| DataType | 7.10.1.4.3.4 | Type of data for the event of the VAL application performance historic logs. | | +| ProducerType | 7.10.1.4.3.5 | Type of the data producer. | | +| ProducerData | 7.10.1.4.3.6 | Type of the data produced by the data producer. | | +| ProducerRole | 7.10.1.4.3.7 | The role of the data producer. | | +| DataAbstraction | 7.10.1.4.3.8 | The level of data abstraction | | + +Table 7.10.1.4.1-2 specifies data types re-used by the SS\_ADAE\_VALPerformanceAnalytics API service: + +**Table 7.10.1.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|-----------------------------------------------------------------------|----------------------| +| Accuracy | 3GPP TS 29.122 [3] | Represent the desired level of accuracy of the requested information. | | +| BitRate | 3GPP TS 29.571 [21] | Represents a bit rate measurement value. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| DateTime | 3GPP TS 29.571 [21] | Used to represent a date and time. | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | +| ReportingRequirements | 7.4.2.4.2.5 | Indicates the requested requirements of reporting. | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [3] | Used to define the time frame for message filters. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID. | | + +#### 7.10.1.4.2 Structured data types + +##### 7.10.1.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 7.10.1.4.2.2 + +Type: AppPerfSubs + +**Table 7.10.1.4.2.2-1: Definition of type AppPerfSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | C | 0..1 | Identity the type of the VAL application performance analytics. (NOTE 1) | | +| valServiceId | string | C | 0..1 | The identifier of the VAL service, to which the performance analytics subscription is applied. (NOTE 1) | | +| dataCollectReq | DataCollectReqs | C | 0..1 | Requirements for data collection. (NOTE 2) | | +| valUeIds | array(ValTargetUe) | O | 1..N | A list of identities of one or more VAL UEs, whose performance analytics or performance data collection, are subscribed to. | | +| valServerId | string | O | 0..1 | If the consumer is different from the VAL server, this identifier represents the VAL server, to which the VAL performance analytics subscription or VAL performance data collection subscription, is applied. | | +| dataProdProfile | ProdProfileInfo | O | 0..1 | Characteristics of the data producer to be used. (NOTE 3) | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the VAL performance analytics if the VAL performance analytics is prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the VAL performance analytics subscription or the VAL performance data collection subscription, is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start time and end time, to which the VAL performance analytics subscription or the VAL performance data collection subscription, is applied. | | +| dataProdIds | array(string) | O | 1..N | In case of the VAL performance data collection subscription, if the request for the data collection is routed via A-DCCF, the list of data producer IDs is needed. | | + +NOTE 1: This attribute is mandatory if the subscription is to the event of the VAL performance analytics. This attribute is not used if the subscription is to the event of the VAL performance data collection. + +NOTE 2: This attribute is mandatory if the subscription is to the event of the VAL performance data collection. This attribute is not used if the subscription is to the event of the VAL performance analytics. + +NOTE 3: This attribute is applicable for the both cases when the subscription is to the event of the VAL performance analytics or to the event of the VAL performance data collection. + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.1.4.2.3 Type: AppPerfNotif + +**Table 7.10.1.4.2.5-1: Definition of type AppPerfNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataOutput | array(string) | M | 1..N | Predicted or expected change or sustainability of the VAL performance for a VAL server or a VAL session. (NOTE) | | +| valServerId | string | M | 1 | Identity of the VAL server, the data collection is related to, in the case of the notification is on the VAL performance data collection. | | +| valUeIds | array(ValTargetUe) | O | 1..N | A list of identities of one or more VAL UEs, the data collection is related to, in the case of the notification is on the VAL performance data collection. | | +| dataType | DataType | O | 0..1 | Identity the type of the of the VAL performance analytics or the VAL performance historic logs | | +| analyticsId | string | O | 0..1 | To identify the analytics for the data collection which may be VAL server performance analytics or VAL session performance analytics, in the case of the notification is on the VAL performance data collection. | | +| confidence-level | ConfidenceLevel | O | 0..1 | Provides accuracy level if the VAL performance analytics is prediction. | | + +NOTE: This attribute is applicable for the both cases when the notification is on the event of the VAL performance analytics or on the event of the VAL performance data collection. + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.1.4.2.4 Type: ProdProfileInfo + +This type implements the capability of the data producer for the data production to support data collection for data analytics services. + +**Table 7.10.1.4.2.6-1: Definition of type ProdProfileInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| prodId | string | M | 1 | Identity of the data producer | | +| prodType | ProducerType | M | 1 | Type of the data producer. | | +| dataType | ProducerData | M | 1 | Type of information that can be provided by the data producer. | | +| prodRole | ProducerRole | O | 0..1 | Role of the data producer. | | +| origProdIds | array(string) | O | 1..N | Identifies the identity of the original data producer if the prod-role is not set to the value "ORIGINAL_PRODUCER" or "GENERATING_ENTITY".
If the type of the data producer is that value of "A_DCCF", this attribute is a list of identities of data producers. | | +| dataFresh | integer | O | 0..1 | It is set to the duration of the time elapsed time after the data generated if the producer-role does not have the value "ORIGINAL_PRODUCER" or "GENERATING_ENTITY". | | +| producerCap | ProducerCap | O | 0..1 | Represents data producer capability. | | + +## 7.10.1.4.2.5 Type: DataCollectReqs + +**Table 7.10.1.4.2.7-1: Definition of type DataCollectReqs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|--------------------------------------------------|---------------| +| dataFormat | string | M | 1 | Format of the data | | +| reporting | ReportingRequirement | M | 1 | Frequency of reporting | | +| abstractedData | DataAbstraction | O | 0..1 | Level of abstracted values for data | | +| accuracy | Accuracy | O | 0..1 | Desired level of accuracy of the requested data. | | + +Editor's Note: Whether this data type is needed to be moved to SS\_AADRF\_Data\_Collection API is FFS. + +## 7.10.1.4.2.6 Type: ProducerCap + +**Table 7.10.1.4.2.8-1: Definition of type ProducerCap** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|------------------------------------------------|---------------| +| durationTime | DateTime | O | 0..1 | Duration time that the data can be stored | | +| anonymization | boolean | O | 0..1 | True if anonymization is supported, else false | | +| dataRate | BitRate | O | 0..1 | Rate of data generation; | | +| schedule | ScheduledCommunicationTime | O | 0..1 | Represents scheduling | | + +Editor's Note: Whether this data type is needed to be moved to SS\_AADRF\_Data\_Collection API is FFS. + +## 7.10.1.4.3 Simple data types and enumerations + +## 7.10.1.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +## 7.10.1.4.3.2 Simple data types + +None. + +## 7.10.1.4.3.3 Enumeration: AnalyticsType + +**Table 7.10.1.4.3.3-1: Enumeration AnalyticsType** + +| Enumeration value | Description | Applicability | +|----------------------|--------------------------------------------------------------------------------------|---------------| +| ANALYTICS_ONLINE | The event for the VAL application performance analytics is for online analytics. | | +| ANALYTICS_OFFLINE | The event for the VAL application performance analytics is for offline analytics. | | +| ANALYTICS_ML_ENABLED | The event for the VAL application performance analytics is for ML-enabled analytics. | | +| ANALYTICS_PREDICTIVE | The event for the VAL application performance analytics is for predictive analytics. | | +| ANALYTICS_STATISTICS | The event for the VAL application performance analytics is for statistics analytics. | | + +## 7.10.1.4.3.4 Enumeration: DataType + +**Table 7.10.1.4.3.4-1: Enumeration DataType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| UE_DATA | The event for the VAL application performance data is for UE data. | | +| NETWORK_DATA | The event for the VAL application performance data is for network data. | | +| APPLICATION_DATA | The event for the VAL application performance data is for application data. | | +| EDGE_DATA | The event for the VAL application performance data is for edge data. | | +| GRANULARITY_LEVEL | The event for the VAL application performance data is for granularity level. | | +| REAL_TIME | The event for the VAL application performance data is for real time data. | | +| NON_REAL_TIME | The event for the VAL application performance data is for non real time data. | | + +## 7.10.1.4.3.5 Enumeration: ProducerType + +**Table 7.10.1.4.3.5-1: Enumeration ProducerType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------|---------------| +| ADAE_CLIENT | The data producer is ADAE client. | | +| A_DCCF | The data producer is A-DDCF. | | +| VAL_SERVER | The data producer is VAL server. | | +| SEAL_SERVER | The data producer is SEAL server. | | +| SEAL_CLIENT | The data producer is SEAL client. | | +| EES | The data producer is EES. | | +| EAS | The data producer is EAS. | | + +## 7.10.1.4.3.6 Enumeration: ProducerData + +**Table 7.10.1.4.3.6-1: Enumeration ProducerData** + +| Enumeration value | Description | Applicability | +|-------------------------|----------------------------------------------------------------|---------------| +| PERFORMANCE_INDICATOR | The data type of the data producer is performance indicator. | | +| REPRODUCER_USAGE_DATA | The data type of the data producer is reproducer usage data. | | +| SERVER_LOAD_DATA | The data type of the data producer is server load data. | | +| APPLICATION_PERFORMANCE | The data type of the data producer is application performance. | | +| EDGE_LOAD | The data type of the data producer is edge load. | | + +## 7.10.1.4.3.7 Enumeration: ProducerRole + +**Table 7.10.1.4.3.7-1: Enumeration ProducerRole** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------|---------------| +| GENERATING_ENTITY | The role of the data producer is generating entity. | | +| ORIGINAL_PRODUCER | The role of the data producer is original producer. | | +| RESPOSITORY | The role of the data producer is repository. | | + +#### 7.10.1.4.3.8 Enumeration: DataAbstraction + +**Table 7.10.1.4.3.8-1: Enumeration DataAbstraction** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------|---------------| +| HIGH | The data abstraction is high. | | +| MEDIUM | The data abstraction is medium. | | +| LOW | The data abstraction is low. | | + +#### 7.10.1.5 Error Handling + +##### 7.10.1.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +##### 7.10.1.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_VALPerformanceAnalytics API. + +##### 7.10.1.5.3 Application Errors + +The application errors defined for SS\_ADAE\_VALPerformanceAnalytics API are listed in table 7.10.1.5.3-1. + +**Table 7.10.1.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +#### 7.10.1.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.1.6-1 lists the supported features for SS\_ADAE\_VALPerformanceAnalytics API. + +**Table 7.10.1.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +### 7.10.2 SS\_ADAE\_SlicePerformanceAnalytics + +#### 7.10.2.1 API URI + +The SS\_ADAE\_SlicePerformanceAnalytics service shall use the SS\_ADAE\_SlicePerformanceAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-sspa". +- The shall be "v1". +- The shall be set as described in clause 7.10.2.2. + +Editor's Note: Definitions of service operations descriptions for this API is FFS. + +Editor's Note: The OpenAPI for this API is FFS. + +### 7.10.2.2 Resources + +#### 7.10.2.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.2.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_SlicePerformanceAnalytics API. + +![A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/ss-adae-sspa/, which branches to /slice-specific-application-performance, which in turn branches to /{ssAppPerfId}.](ed8597fae2e67db43518ae8bc46b6908_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-adae-sspa/"] --> Mid["/slice-specific-application-performance"] + Mid --> End["/{ssAppPerfId}"] + +``` + +A hierarchical diagram showing the resource URI structure. The root is {apiRoot}/ss-adae-sspa/, which branches to /slice-specific-application-performance, which in turn branches to /{ssAppPerfId}. + +Figure 7.10.2.2.1-1: Resource URI structure of the SS\_ADAE\_SlicePerformanceAnalytics API + +Table 7.10.2.2.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 7.10.2.2.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method | Description | +|----------------------------------------------------------------------|-------------------------------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Slice specific application performance event subscription | /slice-specific-application-performance | POST | Subscription to the event of the slice-specific application performance analytics. | +| Individual slice specific application performance event subscription | /slice-specific-application-performance/{ssAppPerfId} | GET | Request the retrieval of an existing "Individual subscription to the event of the slice-specific application performance analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the slice-specific application performance analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the slice-specific application performance analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the slice-specific application performance analytics" resource. | + +Editor's Note: Definitions of GET, PUT, PATCH, DELETE methods are FFS. + +## 7.10.2.2.2 Resource: Slice-specific application performance event subscription + +### 7.10.2.2.2.1 Description + +The slice-specific application performance event subscription to the event of the slice-specific application performance analytics. + +### 7.10.2.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-sspa//slice-specific-application-performance + +This resource shall support the resource URI variables defined in the table 7.10.2.2.2.2-1. + +**Table 7.10.2.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +### 7.10.2.2.2.3 Resource Standard Methods + +#### 7.10.2.2.2.3.1 POST + +This method to subscribe to the event of the slice-specific application performance analytics and shall support the URI query parameters specified in table 7.10.2.2.2.3.1-1. + +**Table 7.10.2.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.2.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.2.2.2.3.1-3. + +**Table 7.10.2.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------------------------| +| SliceAppPerfSubs | M | 1 | Subscription to the slice-specific application performance analytics event. | + +**Table 7.10.2.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------| +| SliceAppPerfSubs | | | 201 (Created) | Subscription to the slice-specific application performance analytics is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.2.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-sspa//slice-specific-application-performance | + +### 7.10.2.2.2.4 Resource Custom Operations + +None. + +### 7.10.2.3 Notifications + +#### 7.10.2.3.1 General + +**Table 7.10.2.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------------|-------------------|---------------------------------|----------------------------------------------------------------------| +| Slice-specific application performance event notification | {notificationUri} | POST | Notification on the slice-specific application performance analytics | + +#### 7.10.2.3.2 Slice-specific application performance event notification + +##### 7.10.2.3.2.1 Description + +Slice-specific application performance event notification is to notify on the event of the slice-specific application performance analytics. + +##### 7.10.2.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 7.10.2.3.2.2-1. + +**Table 7.10.2.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the slice-specific application performance analytics, this method shall support the request data structures specified in table 7.10.2.3.2.2-2 and the response data structures and response codes specified in table 7.10.2.3.2.2-3. + +**Table 7.10.2.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|-----------------------------------------------------------------------------------| +| SliceAppPerfNotif | M | 1 | Notification information of the slice-specific application performance analytics. | + +**Table 7.10.2.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|------------------------------------------------------------------------------------------| +| SliceAppPerfNotif | | | 204 (No Content) | Notification for the slice-specific application performance analytics event is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +### 7.10.2.4 Data Model + +#### 7.10.2.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.2.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_SlicePerformanceAnalytics API service. + +**Table 7.10.2.4.1-1 SS\_ADAE\_SlicePerformanceAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------------|-----------------|-----------------------------------------------------------------------------------|---------------| +| SliceAppPerfSubs | 7.10.2.4.2.2 | Subscription to the slice-specific application performance analytics | | +| SliceAppPerfNotif | 7.10.2.4.2.3 | Notification information of the slice specific application performance analytics. | | + +Table 7.10.2.4.1-2 specifies data types re-used by the SS\_ADAE\_SlicePerformanceAnalytics API service: + +**Table 7.10.2.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------|---------------------|-------------------------------------------------------------------------------|---------------| +| AnalyticsType | Clause 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| Dnn | 3GPP TS 29.571 [21] | Used to Identify a DNN. | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | +| Snsai | 3GPP TS 29.571 [21] | Used to Identify the S-NSSAI. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID. | | + +## 7.10.2.4.2 Structured data types + +### 7.10.2.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 7.10.2.4.2.2 Type: SliceAppPerfSubs + +**Table 7.10.2.4.2.2-1: Definition of type SliceAppPerfSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | M | 1 | Identity the type of the slice-specific application performance analytics | | +| sliceId | Snsai | M | 1 | The identifier of the slice or slice instance, to which the performance analytics subscription is applied. | | +| dnn | Dnn | O | 0..1 | Associated DNN. | | +| valUeIds | array(ValTarget Ue) | O | 1..N | A list of identities of one or more VAL Ues, whose slice-specific performance analytics are subscribed to. | | +| valServerId | string | O | 0..1 | If the consumer is different from the VAL server, this identifier represents the VAL server, to which the slice-specific performance analytics subscription is applied. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the slice-specific performance analytics if the slice-specific performance analytics is prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the slice specific application performance analytics subscription is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start time and end time, to which the slice-specific application performance analytics subscription is applied. | | + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.2.4.2.3 Type: SliceAppPerfNotif + +**Table 7.10.2.4.2.3-1: Definition of type SliceAppPerfNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsOutput | array(string) | M | 1..N | Predicted or expected change or sustainability of the slice-specific performance for a VAL server or a VAL session. | | +| analyticsType | AnalyticsType | O | 0..1 | Identity the type of the slice-specific application performance analytics | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Provides accuracy level if the slice-specific performance analytics is prediction. | | + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.2.5 Error Handling + +## 7.10.2.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.10.2.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_SlicePerformanceAnalytics API. + +### 7.10.2.5.3 Application Errors + +The application errors defined for SS\_ADAE\_SlicePerformanceAnalytics API are listed in table 7.10.2.5.3-1. + +**Table 7.10.2.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.10.2.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.2.6-1 lists the supported features for SS\_ADAE\_SlicePerformanceAnalytics API. + +**Table 7.10.2.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 7.10.3 SS\_ADAE\_Ue2UePerformanceAnalytics + +### 7.10.3.1 API URI + +The SS\_ADAE\_Ue2UePerformanceAnalytics service shall use the SS\_ADAE\_Ue2UePerformanceAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-u2upa". +- The shall be "v1". +- The shall be set as described in clause 7.10.3.2. + +**Editor's Note:** Definitions of service operations descriptions for this API is FFS. + +**Editor's Note:** The OpenAPI for this API is FFS. + +### 7.10.3.2 Resources + +#### 7.10.3.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.3.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_Ue2UePerformanceAnalytics API. + +![Diagram showing the hierarchical structure of the Resource URI. The root is {apiRoot}/ss-adae-uapa/, which branches to /ue2ue-session-performance, which in turn branches to /{u2uPerfId}.](728a02fe4a04e7f91835147194997cd4_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-adae-uapa/"] --> Mid["/ue2ue-session-performance"] + Mid --> End["/{u2uPerfId}"] + +``` + +Diagram showing the hierarchical structure of the Resource URI. The root is {apiRoot}/ss-adae-uapa/, which branches to /ue2ue-session-performance, which in turn branches to /{u2uPerfId}. + +**Figure 7.10.3.2.1-1: Resource URI structure of the SS\_ADAE\_Ue2UePerformanceAnalytics API** + +Table 7.10.3.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.3.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|------------------------------------------------------------|----------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| UE-to-UE session performance event subscription | /ue2ue-session-performance | POST | Subscription to the event of the UE-to-UE session performance analytics | +| Individual UE-to-UE session performance event subscription | /ue2ue-session-performance/{u2uPerfId} | GET | Request the retrieval of an existing "Individual subscription to the event of the UE-to-UE session performance analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the UE-to-UE session performance analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the UE-to-UE session performance analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the UE-to-UE session performance analytics" resource. | + +**Editor's Note: Definitions of GET, PUT, PATCH, DELETE methods are FFS.** + +### 7.10.3.2.2 Resource: UE-to-UE session performance event subscription + +#### 7.10.3.2.2.1 Description + +The UE-to-UE session performance event subscription to the event of the UE-to-UE session performance analytics. + +#### 7.10.3.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-uapa//ue2ue-session-performance + +This resource shall support the resource URI variables defined in the table 7.10.3.2.2.2-1. + +**Table 7.10.3.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +## 7.10.3.2.2.3 Resource Standard Methods + +## 7.10.3.2.2.3.1 POST + +This method to subscribe to the event of the UE-to-UE session performance analytics and shall support the URI query parameters specified in table 7.10.3.2.2.3.1-1. + +**Table 7.10.3.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.3.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.3.2.2.3.1-3. + +**Table 7.10.3.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------------------| +| U2UPerfSubs | M | 1 | Subscription to the UE-to-UE session performance analytics event. | + +**Table 7.10.3.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------| +| U2UPerfSubs | | | 201 (Created) | Subscription to the UE-to-UE session performance analytics is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.3.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-uupa//ue2ue-session-performance | + +## 7.10.3.2.2.4 Resource Custom Operations + +None. + +## 7.10.3.3 Notifications + +## 7.10.3.3.1 General + +**Table 7.10.3.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-------------------------------------------------|-------------------|---------------------------------|------------------------------------------------------------| +| UE-to-UE session performance event notification | {notificationUri} | POST | Notification on the UE-to-UE session performance analytics | + +### 7.10.3.3.2 UE-to-UE session performance event notification + +#### 7.10.3.3.2.1 Description + +UE-to-UE session performance event notification is to notify on the event of the UE-to-UE session performance analytics. + +#### 7.10.3.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 7.10.3.3.2.2-1. + +**Table 7.10.3.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the UE-to-UE session performance analytics, this method shall support the request data structures specified in table 7.10.3.3.2.2-2 and the response data structures and response codes specified in table 7.10.3.3.2.2-3. + +**Table 7.10.3.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------------------------------------| +| U2UPerfNotif | M | 1 | Notification information of the UE-to-UE session performance analytics. | + +**Table 7.10.3.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|------------------------------------------------------------------------------------------------------------------------------|-------------|------------------|--------------------------------------------------------------------------------| +| U2UPerfNotif | | | 204 (No Content) | Notification for the UE-to-UE session performance analytics event is accepted. | +| NOTE: | The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | + +### 7.10.3.4 Data Model + +#### 7.10.3.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.3.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_Ue2UePerformanceAnalytics API service. + +**Table 7.10.3.4.1-1 SS\_ADAE\_Ue2UePerformanceAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------|-----------------|-------------------------------------------------------------------------|---------------| +| U2UPerfSubs | 7.10.3.4.2.2 | Subscription to the UE-to-UE session performance analytics | | +| U2UPerfNotif | 7.10.3.4.2.3 | Notification information of the UE-to-UE session performance analytics. | | + +Table 7.10.3.4.1-2 specifies data types re-used by the SS\_ADAE\_Ue2UePerformanceAnalytics API service: + +**Table 7.10.3.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------|---------------------|-------------------------------------------------------------------------------|---------------| +| AnalyticsType | Clause 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Used to indicate either VAL User ID or VAL UE ID. | | + +#### 7.10.3.4.2 Structured data types + +##### 7.10.3.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 7.10.3.4.2.2 Type: U2UPerfSubs + +**Table 7.10.3.4.2.2-1: Definition of type U2UPerfSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | M | 1 | Identity the type of the UE-to-UE session performance analytics | | +| valUeIds | array(ValTargetUe) | O | 1..N | A list of identities of one or more VAL UEs, whose UE-to-UE session analytics are subscribed to. | | +| valServerId | string | O | 0..1 | If the consumer is different from the VAL server, this identifier represents the VAL server, to which the UE-to-UE session analytics subscription is applied. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the UE-to-UE session analytics if the UE-to-UE session performance analytics is for prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the UE-to-UE session performance analytics subscription is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start time and end time, to which the UE-to-UE session performance analytics subscription is applied. | | + +Editor's Note: Detailed definitions for data types are FFS. + +##### 7.10.3.4.2.3 Type: Ue2UePerfNotif + +**Table 7.10.3.4.2.3-1: Definition of type U2UPerfNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------|---------------| +| analyticsOutput | array(string) | M | 1..N | UE-to-UE session performance analytics for prediction or statistics depending on the type. | | +| analyticsType | AnalyticsType | O | 0..1 | Identity the type of the UE-to-UE session performance analytics | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Provides accuracy level if the UE-to-UE performance analytics is prediction. | | + +Editor's Note: Detailed definitions for data types are FFS. + +### 7.10.3.5 Error Handling + +#### 7.10.3.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +#### 7.10.3.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_Ue2UePerformanceAnalytics API. + +#### 7.10.3.5.3 Application Errors + +The application errors defined for SS\_ADAE\_Ue2UePerformanceAnalytics API are listed in table 7.10.3.5.3-1. + +**Table 7.10.3.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.10.3.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.3.6-1 lists the supported features for SS\_ADAE\_Ue2UePerformanceAnalytics API. + +**Table 7.10.3.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 7.10.4 SS\_ADAE\_LocationAccuracyAnalytics + +### 7.10.4.1 API URI + +The SS\_ADAE\_LocationAccuracyAnalytics service shall use the SS\_ADAE\_LocationAccuracyAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-laa". +- The shall be "v1". +- The shall be set as described in clause 7.10.4.2. + +**Editor's Note:** Definitions of service operations descriptions for this API is FFS. + +**Editor's Note:** The OpenAPI for this API is FFS. + +### 7.10.4.2 Resources + +#### 7.10.4.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.4.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_LocationAccuracyAnalytics API. + +![Diagram showing the hierarchical structure of the Resource URI. The root is {apiRoot}/ss-adae-laa/, which branches to /location-accuracy, which further branches to /{locAcclD}.](e002d1b87dc447584fd9829eac949a12_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-adae-laa/"] --> LocAcc["/location-accuracy"] + LocAcc --> LocAcclD["/{locAcclD}"] + +``` + +Diagram showing the hierarchical structure of the Resource URI. The root is {apiRoot}/ss-adae-laa/, which branches to /location-accuracy, which further branches to /{locAcclD}. + +**Figure 7.10.4.2.1-1: Resource URI structure of the SS\_ADAE\_LocationAccuracyAnalytics API** + +Table 7.10.4.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.4.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|-------------------------------------------------|--------------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| Location accuracy event subscription | /location-accuracy | POST | Subscription to the event of the location accuracy performance analytics | +| Individual location accuracy event subscription | /location-accuracy /{locAcclD} | GET | Request the retrieval of an existing "Individual subscription to the event of the location accuracy analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the location accuracy analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the location accuracy analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the location accuracy analytics" resource. | + +**Editor's Note:** Definitions of GET, PUT, PATCH, DELETE methods are FFS. + +#### 7.10.4.2.2 Resource: Location accuracy event subscription + +##### 7.10.4.2.2.1 Description + +Location accuracy event subscription to the event of the location accuracy analytics. + +##### 7.10.4.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-laa//location-accuracy + +This resource shall support the resource URI variables defined in the table 7.10.4.2.2.2-1. + +**Table 7.10.4.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +## 7.10.4.2.2.3 Resource Standard Methods + +## 7.10.4.2.2.3.1 POST + +This method to subscribe to the event of the location accuracy analytics and shall support the URI query parameters specified in table 7.10.4.2.2.3.1-1. + +**Table 7.10.4.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.4.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.4.2.2.3.1-3. + +**Table 7.10.4.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|--------------------------------------------------------| +| LocAccurSubs | M | 1 | Subscription to the location accuracy analytics event. | + +**Table 7.10.4.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------| +| LocAccurSubs | | | 201 (Created) | Subscription to the location accuracy analytics is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.4.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-laa//location-accuracy | + +## 7.10.4.2.2.4 Resource Custom Operations + +None. + +## 7.10.4.3 Notifications + +## 7.10.4.3.1 General + +**Table 7.10.4.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|-------------------|---------------------------------|-------------------------------------------------| +| Location accuracy event notification | {notificationUri} | POST | Notification on the location accuracy analytics | + +### 7.10.4.3.2 Location accuracy event notification + +#### 7.10.4.3.2.1 Description + +Location accuracy event notification is to notify on the event of the location accuracy analytics. + +#### 7.10.4.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 7.10.4.3.2.2-1. + +**Table 7.10.4.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the location accuracy analytics, this method shall support the request data structures specified in table 7.10.4.3.2.2-2 and the response data structures and response codes specified in table 7.10.4.3.2.2-3. + +**Table 7.10.4.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------| +| LocAccurNotif | M | 1 | Notification information of the location accuracy analytics. | + +**Table 7.10.4.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|---------------------------------------------------------------------| +| n/a | | | 204 (No Content) | Notification for the location accuracy analytics event is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +### 7.10.4.4 Data Model + +#### 7.10.4.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.4.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_LocationAccuracyAnalytics API service. + +**Table 7.10.4.4.1-1\_SS\_ADAE\_LocationAccuracyAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------|-----------------|-------------------------------------------------------------------|---------------| +| LocAccurSubs | 7.10.4.4.2.2 | Subscription to the location accuracy analytics event | | +| LocAccurNotif | 7.10.4.4.2.3 | Notification information of the location accuracy analytics event | | + +Table 7.10.4.4.1-2 specifies data types re-used by the SS\_ADAE\_LocationAccuracyAnalytics API service: + +**Table 7.10.4.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------|---------------------|--------------------------------------------------------------------------------|---------------| +| Accuracy | 3GPP TS 29.122 [3] | Represent the desired level of accuracy of the requested location information. | | +| AnalyticsType | Clause 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | +| UeMobility | 3GPP TS 29.520 [33] | Represents UE Mobility and route information | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Indicate either VAL User ID or VAL UE ID. | | + +#### 7.10.4.4.2 Structured data types + +##### 7.10.4.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 7.10.4.4.2.2 Type: LocAccurSubs + +**Table 7.10.4.4.2.2-1: Definition of type LocAccurSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | M | 1 | Identity the type of the location accuracy analytics | | +| valUesIds | array(ValTargetUe) | M | 1..N | A list of identities of one or more VAL UEs, whose location accuracy analytics are subscribed to. | | +| accuracy | Accuracy | M | 1 | Represents the desired level of accuracy of the requested location information. | | +| valServiceId | string | O | 0..1 | The identifier of the VAL service for which location accuracy analytics is requested. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the location analytics analytics if the location accuracy analytics is for prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the location accuracy analytics subscription is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start and the end time, to which the location accuracy analytics subscription is applied. | | +| ueMobs | array(UeMobility) | O | 1..N | Mobility and route information on the one or more target VAL UE. | | + +**Editor's Note:** Detailed definitions for data types are FFS. + +## 7.10.4.4.2.3 Type: LocAccurNotif + +**Table 7.10.4.4.2.3-1: Definition of type LocAccurNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| analyticsOutputs | array(string) | M | 1..N | Location accuracy analytics for prediction or statistics depending on the type. | | +| analyticsType | AnalyticsType | O | 0..1 | Identity the type of the location accuracy analytics | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Provides accuracy level if the location accuracy analytics is prediction. | | + +**Editor's Note:** Detailed definitions for data types are FFS. + +## 7.10.4.5 Error Handling + +## 7.10.4.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.10.4.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_LocationAccuracyAnalytics API. + +## 7.10.4.5.3 Application Errors + +The application errors defined for SS\_ADAE\_LocationAccuracyAnalytics API are listed in table 7.10.4.5.3-1. + +**Table 7.10.4.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 7.10.4.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.4.6-1 lists the supported features for SS\_ADAE\_LocationAccuracyAnalytics API. + +**Table 7.10.4.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 7.10.5 SS\_ADAE\_ServiceApiAnalytics + +## 7.10.5.1 API URI + +The SS\_ADAE\_ServiceApiAnalytics service shall use the SS\_ADAE\_ServiceApiAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-sa". +- The shall be "v1". + +- The shall be set as described in clause 7.10.5.2. + +Editor's Note: Definitions of service operations descriptions for this API is FFS. + +Editor's Note: The OpenAPI for this API is FFS. + +## 7.10.5.2 Resources + +### 7.10.5.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.5.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_ServiceApiAnalytics API. + +![Diagram showing the hierarchical structure of Resource URIs for the SS_ADAE_ServiceApiAnalytics API. The root URI is {apiRoot}/ss-adae-sa/. It branches to /service-api, which further branches to /{srvApiId}.](8c01a58cf16e04fe66144b4f6a4e9cd4_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-adae-sa/"] --> ServiceApi["/service-api"] + ServiceApi --> SrvApiId["/{srvApiId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the SS\_ADAE\_ServiceApiAnalytics API. The root URI is {apiRoot}/ss-adae-sa/. It branches to /service-api, which further branches to /{srvApiId}. + +**Figure 7.10.5.2.1-1: Resource URI structure of the SS\_ADAE\_ServiceApiAnalytics API** + +Table 7.10.5.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.5.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|-------------------------------------------|-------------------------|-------------|-----------------------------------------------------------------------------------------------------------------------| +| Service API event subscription | /service-api | POST | Subscription to the event of the service API analytics | +| Individual service API event subscription | /service-api/{srvApiId} | GET | Request the retrieval of an existing "Individual subscription to the event of the service API analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the service API analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the service API analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the service API analytics" resource. | + +Editor's Note: Definitions of GET, PUT, PATCH, DELETE methods are FFS. + +### 7.10.5.2.2 Resource: Service API event subscription + +#### 7.10.5.2.2.1 Description + +Service API event subscription to the event of the service API analytics. + +#### 7.10.5.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-sa//service-api + +This resource shall support the resource URI variables defined in the table 7.10.5.2.2.2-1. + +**Table 7.10.5.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.10.5.2.2.3 Resource Standard Methods + +##### 7.10.5.2.2.3.1 POST + +This method to subscribe to the event of the service API analytics and shall support the URI query parameters specified in table 7.10.5.2.2.3.1-1. + +**Table 7.10.5.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.5.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.5.2.2.3.1-3. + +**Table 7.10.5.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|--------------------------------------------------| +| SrvApiSubs | M | 1 | Subscription to the service API analytics event. | + +**Table 7.10.5.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------| +| SrvApiSubs | | | 201 (Created) | Subscription to the service API analytics is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.5.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-sa//service-api | + +#### 7.10.5.2.2.4 Resource Custom Operations + +None. + +## 7.10.5.3 Notifications + +### 7.10.5.3.1 General + +**Table 7.10.5.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|-------------------|---------------------------------|-------------------------------------------| +| Service API event notification | {notificationUri} | POST | Notification on the service API analytics | + +### 7.10.5.3.2 Service API event notification + +#### 7.10.5.3.2.1 Description + +Service API event notification is to notify on the event of the service API analytics. + +#### 7.10.5.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 7.10.5.3.2.2-1. + +**Table 7.10.5.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the service API analytics, this method shall support the request data structures specified in table 7.10.5.3.2.2-2 and the response data structures and response codes specified in table 7.10.5.3.2.2-3. + +**Table 7.10.5.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|--------------------------------------------------------| +| SrvApiNotif | M | 1 | Notification information of the service API analytics. | + +**Table 7.10.5.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|---------------------------------------------------------------| +| n/a | | | 204 (No Content) | Notification for the service API analytics event is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.5.4 Data Model + +### 7.10.5.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.5.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_ServiceApiAnalytics API service. + +**Table 7.10.5.4.1-1\_SS\_ADAE\_ServiceApiAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------|-----------------|--------------------------------------------------------------|---------------| +| SrvApiSubs | 7.10.5.4.2.2 | Subscription to the service API analytics event | | +| SrvApiNotif | 7.10.5.4.2.3 | Notification information of the service API analytics event. | | +| SrvApiIdType | 7.10.5.4.3.3 | Type of service API | | + +Table 7.10.5.4.1-2 specifies data types re-used by the SS\_ADAE\_ServiceApiAnalytics API service: + +**Table 7.10.5.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------|--------------------|--------------------------------------------------|---------------| +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | + +## 7.10.5.4.2 Structured data types + +### 7.10.5.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 7.10.5.4.2.2 Type: SrvApiSubs + +**Table 7.10.5.4.2.2-1: Definition of type SrvApiSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------|---------------| +| serviceApiId | SrvApiIdType | M | 1 | The identifier for the service API | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the service API analytics subscription is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start and the end time, to which the service API analytics subscription is applied. | | + +*Editor's Note: Detailed definitions for data types are FFS.* + +### 7.10.5.4.2.3 Type: SrvApiNotif + +**Table 7.10.5.4.2.3-1: Definition of type SrvApiNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| serviceApiId | SrvApiIdType | M | 1 | The identifier for the service API | | +| analyticsOutputs | array(string) | M | 1..N | Service API analytics for prediction or statistics depending on the type. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the service API analytics subscription is applied. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Provides accuracy level if the service API analytics is prediction. | | + +*Editor's Note: Detailed definitions for data types are FFS.* + +### 7.10.5.4.3 Simple data types and enumerations + +#### 7.10.5.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +#### 7.10.5.4.3.2 Simple data types + +None. + +#### 7.10.5.4.3.3 Enumeration: SrvApIdType + +**Table 7.10.5.4.3.3-1: Enumeration SrvApIdType** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------|---------------| +| SERVICE_API_NAME | The identity of the service API is the service API name. | | +| SERVICE_API_TYPE | The identity of the service API is the service API type. | | + +### 7.10.5.5 Error Handling + +#### 7.10.5.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +#### 7.10.5.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_ServiceApiAnalytics API. + +#### 7.10.5.5.3 Application Errors + +The application errors defined for SS\_ADAE\_ServiceApiAnalytics API are listed in table 7.10.5.5.3-1. + +**Table 7.10.5.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.10.5.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.5.6-1 lists the supported features for SS\_ADAE\_ServiceApiAnalytics API. + +**Table 7.10.5.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 7.10.6 SS\_ADAE\_SliceUsagePatternAnalytics + +### 7.10.6.1 API URI + +The SS\_ADAE\_SliceUsagePatternAnalytics service shall use the SS\_ADAE\_SliceUsagePatternAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-sup". +- The shall be "v1". +- The shall be set as described in clause 7.10.6.2. + +**Editor's Note:** Definitions of service operations descriptions for this API is FFS. + +**Editor's Note:** The OpenAPI for this API is FFS. + +### 7.10.6.2 Resources + +#### 7.10.6.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.6.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_SliceUsagePatternAnalytics API. + +![Diagram showing the resource URI structure for the SS_ADAE_SliceUsagePatternAnalytics API. The root URI is {apiRoot}/ss-adae-sup/. It branches into /slice-usage-pattern, which further branches into /{sliceUseId} and /GetStatLog. The /GetStatLog box has a dashed border.](98d0322515464572a78f3e4ee94105ed_img.jpg) + +``` +graph TD; Root["{apiRoot}/ss-adae-sup/"] --- SliceUsagePattern["/slice-usage-pattern"]; SliceUsagePattern --- SliceUseId["/{sliceUseId}"]; SliceUsagePattern --- GetStatLog["/GetStatLog"]; style GetStatLog stroke-dasharray: 5 5; +``` + +Diagram showing the resource URI structure for the SS\_ADAE\_SliceUsagePatternAnalytics API. The root URI is {apiRoot}/ss-adae-sup/. It branches into /slice-usage-pattern, which further branches into /{sliceUseId} and /GetStatLog. The /GetStatLog box has a dashed border. + +**Figure 7.10.6.2.1-1: Resource URI structure of the SS\_ADAE\_SliceUsagePatternAnalytics API** + +Table 7.10.6.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.6.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|---------------------------------------------------|-----------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------| +| Slice usage pattern event subscription | /slice-usage-pattern/ | POST | Subscription to the event of the slice usage pattern analytics | +| Individual slice usage pattern event subscription | /slice-usage-pattern/{sliceUseId} | GET | Request the retrieval of an existing "Individual subscription to the event of the slice usage pattern analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the slice usage pattern analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the slice usage pattern analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the slice usage pattern analytics" resource. | + +Editor's Note: Definitions of GET, PUT, PATCH, DELETE methods are FFS. + +#### 7.10.6.2.2 Resource: Slice usage pattern event subscription + +##### 7.10.6.2.2.1 Description + +Slice usage pattern event subscription to the event of the slice usage pattern analytics. + +##### 7.10.6.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-sup//slice-usage-pattern + +This resource shall support the resource URI variables defined in the table 7.10.6.2.2.2-1. + +**Table 7.10.6.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +##### 7.10.6.2.2.3 Resource Standard Methods + +###### 7.10.6.2.2.3.1 POST + +This method to subscribe to the event of the slice usage pattern analytics and shall support the URI query parameters specified in table 7.10.6.2.2.3.1-1. + +**Table 7.10.6.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.6.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.6.2.2.3.1-3. + +**Table 7.10.6.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------------------------------| +| SUPSubs | M | 1 | Subscription to the slice usage pattern analytics event. | + +**Table 7.10.6.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------| +| SUPSubs | | | 201 (Created) | Subscription to the slice usage pattern analytics is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.6.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-sup//slice-usage-pattern | + +## 7.10.6.2.2.4 Resource Custom Operations + +## 7.10.6.2.2.4.1 Overview + +**Table 7.10.6.2.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|---------------------------------|--------------------|-------------------------------------------| +| GetStatLog | /slice-usage-pattern/GetStatLog | POST | Retrieves the slice usage statistics data | + +## 7.10.6.2.2.4.2 Operation: POST + +This method retrieves the slice usage statistics data and shall support the URI query parameters specified in table 7.10.6.2.2.4.2-1. + +**Table 7.10.6.2.2.4.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.6.2.2.4.2-2 and the response data structures and response codes specified in table 7.10.6.2.2.4.2-3. + +**Table 7.10.6.2.2.4.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------------------------------------------| +| SUSLogReq | M | 1 | Retrieval of to the slice usage statistics data | + +**Table 7.10.6.2.2.4.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| SUSLogResp | | | 200 (OK) | The retrieval of the slice usage statistics data is successful and returned in the response. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.6.3 Notifications + +### 7.10.6.3.1 General + +**Table 7.10.6.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------|-------------------|---------------------------------|---------------------------------------------------| +| Slice usage pattern event notification | {notificationUri} | POST | Notification on the slice usage pattern analytics | + +### 7.10.6.3.2 Slice usage pattern event notification + +#### 7.10.6.3.2.1 Description + +Slice usage pattern event notification is to notify on the event of the slice usage pattern analytics. + +#### 7.10.6.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {**notificationUri**} + +This method shall support the URI query parameters specified in table 7.10.6.3.2.2-1. + +**Table 7.10.6.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the slice usage pattern analytics, this method shall support the request data structures specified in table 7.10.6.3.2.2-2 and the response data structures and response codes specified in table 7.10.6.3.2.2-3. + +**Table 7.10.6.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------------------| +| SUPNotif | M | 1 | Notification information of the slice usage pattern analytics | + +**Table 7.10.6.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|-----------------------------------------------------------------------| +| n/a | | | 204 (No Content) | Notification for the slice usage pattern analytics event is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.6.4 Data Model + +### 7.10.6.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.6.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_SliceUsagePatternAnalytics API service. + +**Table 7.10.6.4.1-1 SS\_ADAE\_SliceUsagePatternAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------|-----------------|----------------------------------------------------------------------|---------------| +| SUPSubs | 7.10.6.4.2.2 | Subscription to the slice usage pattern analytics event | | +| SUPNotif | 7.10.6.4.2.3 | Notification information of the slice usage pattern analytics event. | | +| SUSLogReq | 7.10.6.4.2.4 | Retrieval request of the slice usage statistics data | | +| SUSLogResp | 7.10.6.4.2.5 | Retrieval response of the slice usage statistics data | | + +Table 7.10.6.4.1-2 specifies data types re-used by the SS\_ADAE\_SliceUsagePatternAnalytics API service: + +**Table 7.10.6.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------|---------------------|-------------------------------------------------------------------------------|---------------| +| AnalyticsType | Clause 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| Dnn | 3GPP TS 29.571 [21] | Identifies a DNN. | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | +| LocationArea | 3GPP TS 29.122 [3] | Represents location information. | | +| Snssai | 3GPP TS 29.571 [21] | Identifies the S-NSSAI. | | +| ValTargetUe | Clause 7.3.1.4.2.3 | Indicate either VAL User ID or VAL UE ID. | | + +### 7.10.6.4.2 Structured data types + +#### 7.10.6.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 7.10.6.4.2.2 Type: SUPAnalyticsSubs + +**Table 7.10.6.4.2.2-1: Definition of type SUPSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | M | 1 | Identity of the type of the slice usage pattern analytics | | +| sliceId | Snssai | M | 1 | Identity of the network slice | | +| dnn | Dnn | O | 0..1 | Associated target DNN | | +| sliceReq | NetworkSliceType | O | 0..1 | Identity the the required slice type | | +| valUeIds | array(ValTargetUe) | O | 1..N | A list of identities of one or more VAL UEs, whose slice usage patterns are subscribed to. | | +| valServerId | string | O | 0..1 | If the consumer is different from the VAL server, this identifier represents the VAL server, to which the slice usage pattern analytics subscription is applied. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the slice usage pattern analytics if the slice usage pattern analytics is prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the slice usage pattern analytics subscription is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start and the end time, to which the slice usage pattern analytics subscription is applied. | | +| historicTimeInt | DurationSec | O | 0..1 | The historic time interval as the start and the end time, to which the slice usage pattern analytics subscription is applied. | | + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.6.4.2.3 Type: SUPNotif + +**Table 7.10.6.4.2.3-1: Definition of type SUPNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| analyticsOutputs | array(string) | M | 1..N | Slice usage pattern analytics for prediction or statistics depending on the type. | | + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.6.4.2.4 Type: SUSLogReq + +**Table 7.10.6.4.2.4-1: Definition of type SUSLogReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------|---------------| +| dataId | string | M | 1 | Identity of the slice usage statistics data which is to be collected. | | +| valServiceId | string | M | 1 | The identifier of the VAL service, for which the request applies. | | +| sliceId | Snssai | M | 1 | Identity of the network slice, for which the slice usage statistics data is collected. | | +| dnn | Dnn | O | 0..1 | Associated DNN, for which the request applies. | | +| valUeIds | array(ValTargetUe) | O | 0..N | A list of identities of one or more VAL UEs, for which the request applies. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the slice usage statistics data applies. | | +| timeInterval | DurationSec | M | 1 | The time interval as the start and the end time, to which the slice usage statistics data applies. | | + +Editor's Note: Detailed definitions for data types are FFS. + +#### 7.10.6.4.2.5 Type: SUSLogResp + +**Table 7.10.6.4.2.5-1: Definition of type SUSLogResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------|---------------| +| dataOutputs | array(string) | M | 1..N | Reported data | | +| sliceId | Snsai | M | 1 | Represents identity of the network slice. | | + +Editor's Note: Detailed definitions for data types are FFS. + +#### 7.10.6.4.3 Simple data types and enumerations + +##### 7.10.6.4.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 7.10.6.4.3.2 Simple data types + +None. + +##### 7.10.6.4.3.3 Enumeration: NetworkSliceType + +**Table 7.10.6.4.3.3-1: Enumeration NetworkSliceType** + +| Enumeration value | Description | Applicability | +|---------------------|----------------------------------------------------------------------------------|---------------| +| NETWORK_SLICE_EMBB | Slice suitable for the handling of 5G enhanced Mobile Broadband. | | +| NETWORK_SLICE_URLLC | Slice suitable for the handling of ultra-reliable low latency communications. | | +| NETWORK_SLICE_MIoT | Slice suitable for the handling of massive IoT. | | +| NETWORK_SLICE_V2X | Slice suitable for the handling of V2X services. | | +| NETWORK_SLICE_HMTC | Slice suitable for the handling of High-Performance Machine-Type Communications. | | + +#### 7.10.6.5 Error Handling + +##### 7.10.6.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +##### 7.10.6.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_SliceUsagePatternAnalytics API. + +##### 7.10.6.5.3 Application Errors + +The application errors defined for SS\_ADAE\_SliceUsagePatternAnalytics API are listed in table 7.10.6.5.3-1. + +**Table 7.10.6.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +### 7.10.6.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.6.6-1 lists the supported features for SS\_ADAE\_SliceUsagePatternAnalytics API. + +**Table 7.10.6.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 7.10.7 SS\_ADAE\_EdgeLoadAnalytics + +### 7.10.7.1 API URI + +The SS\_ADAE\_EdgeLoadAnalytics service shall use the SS\_ADAE\_EdgeLoadAnalytics API. + +The request URIs used in HTTP requests from the VAL server towards the ADAE server shall have the Resource URI structure as defined in clause 6.5 with the following clarifications: + +- The shall be "ss-adae-el". +- The shall be "v1". +- The shall be set as described in clause 7.10.7.2. + +**Editor's Note:** Definitions of service operations descriptions for this API is FFS. + +**Editor's Note:** The OpenAPI for this API is FFS. + +### 7.10.7.2 Resources + +#### 7.10.7.2.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.10.7.2.1-1 depicts the resource URIs structure for the SS\_ADAE\_EdgeLoadAnalytics API. + +![Diagram showing the resource URI structure of the SS_ADAE_EdgeLoadAnalytics API. The root URI is {apiRoot}/ss-adae-el/. It branches into /edge-load. From /edge-load, it further branches into /{edgeLdId} and /GetLog.](daa086b264328b888e9d54b9bbad081e_img.jpg) + +``` + +graph TD + Root["{apiRoot}/ss-adae-el/"] --> EdgeLoad["/edge-load"] + EdgeLoad --> EdgeLdId["/{edgeLdId}"] + EdgeLoad --> GetLog["/GetLog"] + +``` + +Diagram showing the resource URI structure of the SS\_ADAE\_EdgeLoadAnalytics API. The root URI is {apiRoot}/ss-adae-el/. It branches into /edge-load. From /edge-load, it further branches into /{edgeLdId} and /GetLog. + +**Figure 7.10.7.2.1-1: Resource URI structure of the SS\_ADAE\_EdgeLoadAnalytics API** + +Table 7.10.7.2.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.10.7.2.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|-----------------------------------------|-----------------------|-------------|---------------------------------------------------------------------------------------------------------------------| +| Edge load event subscription | /edge-load/ | POST | Subscription to the event of the edge load analytics and the edge load historic data collection | +| Individual edge load event subscription | /edge-load/{edgeLdId} | GET | Request the retrieval of an existing "Individual subscription to the event of the edge load analytics" resource. | +| | | PUT | Request the update of an existing "Individual subscription to the event of the edge load analytics" resource. | +| | | PATCH | Request the modification of an existing "Individual subscription to the event of the edge load analytics" resource. | +| | | DELETE | Request the deletion of an existing "Individual subscription to the event of the edge load analytics" resource. | + +**Editor's Note:** Detailed definitions for data types are FFS. + +## 7.10.7.2.2 Resource: Edge load event subscription + +### 7.10.7.2.2.1 Description + +Edge load event subscription to the event of the slice usage pattern analytics. + +### 7.10.7.2.2.2 Resource Definition + +Resource URI: {apiRoot}/ss-adae-el//edge-load + +This resource shall support the resource URI variables defined in the table 7.10.7.2.2.2-1. + +**Table 7.10.7.2.2.2-1: Resource URI variables for this resource** + +| Name | Data Type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 6.5 | + +#### 7.10.7.2.2.3 Resource Standard Methods + +##### 7.10.7.2.2.3.1 POST + +This method to subscribe to the event of the edge load analytics or the edge load historic data collection and shall support the URI query parameters specified in table 7.10.7.2.2.3.1-1. + +**Table 7.10.7.2.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.7.2.2.3.1-2 and the response data structures and response codes specified in table 7.10.7.2.2.3.1-3. + +**Table 7.10.7.2.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-----------------------------------------------------------------------------------------------------| +| EdgeSubs | M | 1 | Subscription to the event of:
- edge load analytics; or
- edge load historic data collection. | + +**Table 7.10.7.2.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| EdgeSubs | | | 201 (Created) | Subscription to the edge load analytics or to the edge load historic data collection is created. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +**Table 7.10.7.2.2.3.1-4: Headers supported by the 201 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/ss-adae-pa//application-performance | + +#### 7.10.7.2.2.4 Resource Custom Operations + +##### 7.10.7.2.2.4.1 Overview + +**Table 7.10.7.2.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|----------------------------------------| +| GetLog | /edge-load/GetLog | POST | Retrieves the edge load analytics data | + +##### 7.10.7.2.2.4.2 Operation: POST + +This method retrieves the edge load analytics data and shall support the URI query parameters specified in table 7.10.7.2.2.4.2-1. + +**Table 7.10.7.2.2.4.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 7.10.7.2.2.4.2-2 and the response data structures and response codes specified in table 7.10.7.2.2.4.2-3. + +**Table 7.10.7.2.2.4.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------|---|-------------|----------------------------------------------| +| EdgeLogReq | M | 1 | Retrieval of to the edge load analytics data | + +**Table 7.10.7.2.2.4.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------| +| EdgeLogResp | | | 200 (OK) | The retrieval of the edge load analytics data is successful and returned in the response. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.7.3 Notifications + +### 7.10.7.3.1 General + +**Table 7.10.7.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------|-------------------|---------------------------------|------------------------------------------------------------------------------------------------| +| Edge load event notification | {notificationUri} | POST | Notification on the event of the edge load analytics or the edge load historic data collection | + +### 7.10.7.3.2 Edge load event notification + +#### 7.10.7.3.2.1 Description + +Edge load event notification is to notify on the event of the edge load analytics or the edge load historic data collection. + +#### 7.10.7.3.2.2 Notification definition + +The POST method shall be used for the event notification and the callback URI shall be the one provided by the consumer during the subscription to the event. + +Callback URI: {**notificationUri**} + +This method shall support the URI query parameters specified in table 7.10.7.3.2.2-1. + +**Table 7.10.7.3.2.2-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +If the notification is on the edge load analytics and the edge load historic data collection, this method shall support the request data structures specified in table 7.10.7.3.2.2-2 and the response data structures and response codes specified in table 7.10.7.3.2.2-3. + +**Table 7.10.7.3.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------------------------------------------------------------| +| EdgeNotif | M | 1 | Notification on:
- edge load analytics; or
- edge load historic data collection. | + +**Table 7.10.7.3.2.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|-------------------------------------------------------------------------------------------------------| +| n/a | | | 204 (No Content) | Notification for the edge load analytics event or the edge load historic data collection is accepted. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [22] shall also apply. | | | | | + +## 7.10.7.4 Data Model + +### 7.10.7.4.1 General + +This clause specifies the application data model supported by the API. Data types listed in clause 6.2 apply to this API. + +Table 7.10.7.4.1-1 specifies the data types defined specifically for the SS\_ADAE\_EdgeLoadAnalytics API service. + +**Table 7.10.7.4.1-1\_SS\_ADAE\_EdgeLoadAnalytics API specific Data Types** + +| Data type | Section defined | Description | Applicability | +|-------------|-----------------|------------------------------------------------------------|---------------| +| EdgeSubs | 7.10.7.4.2.2 | Subscription to the edge load analytics event | | +| EdgeNotif | 7.10.7.4.2.3 | Notification information of the edge load analytics event. | | +| EdgeLogReq | 7.10.7.4.2.4 | Retrieval request of the edge load analytics data | | +| EdgeLogResp | 7.10.7.4.2.5 | Retrieval response of the edge load analytics data | | + +Table 7.10.7.4.1-2 specifies data types re-used by the SS\_ADAE\_EdgeLoadAnalytics API service: + +**Table 7.10.7.4.1-2: Re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------|---------------------|-------------------------------------------------------------------------------|---------------| +| AnalyticsType | Clause 7.10.1.4.3.3 | Type of analytics for the event of the VAL application performance analytics. | | +| ConfidenceLevel | 3GPP TS 29.122 [3] | Presents confidence level | | +| DataCollectReqs | Clause 7.10.1.4.2.7 | Represents requirements for data collection. | | +| DataProdProfileInfo | Clause 7.10.1.4.2.6 | Presents characteristics of the data producer. | | +| Dnn | 3GPP TS 29.571 [21] | Identifies a DNN. | | +| DurationSec | 3GPP TS 29.122 [3] | Represents a period of time in units of seconds. | | + +#### 7.10.7.4.2 Structured data types + +##### 7.10.7.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 7.10.7.4.2.2 Type: EdgeSubs + +**Table 7.10.7.4.2.2-1: Definition of type EdgeSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | C | 0..1 | Identity of the type of the edge load analytics (NOTE 1) | | +| dataCollectionReq | DataCollectReqs | C | 0..1 | The requirements for edge load data collection subscription (NOTE 2) | | +| destinationEasId | string | O | 0..1 | Identifier for the destination EAS, for which the edge load analytics subscription or the edge load data collection subscription, is requested. (NOTE 3) | | +| destinationEesId | string | O | 0..1 | Identifier for the destination EES, for which the edge load analytics subscription or the edge load data collection subscription, is requested. (NOTE 3) | | +| dnn | Dnn | O | 0..1 | Target DNN, for which the edge load analytics subscription or the edge load data collection subscription, is requested. (NOTE 3) | | +| dataProdIds | array(string) | O | 1..N | In case of or the edge load data collection subscription if the request for the data collection is routed via A-DCCF, the list of data producer IDs is needed. | | +| dataProdProfile | DataProdProfileInfo | O | 0..1 | Characteristics of the data producer to be used when subscribing to edge load analytics or the edge load data collection. | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the edge load analytics if the edge load analytics or the edge load data collection, is prediction. | | +| area | LocationArea | O | 0..1 | The geographical or service area, to which the edge load analytics subscription or the edge load data collection subscription, is applied. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start and the end time, to which the edge load analytics subscription or the edge load data collection, applies. | | + +NOTE 1: This attribute is mandatory if the subscription is to the event of the edge load analytics. This attribute is not used if the subscription is to the event of the edge load data collection. + +NOTE 2: This attribute is mandatory if the subscription is to the event of the edge load data collection. This attribute is not used if the subscription is to the event of the edge load analytics. + +NOTE 3: At least one of these attributes shall be present. + +**Editor's Note: Detailed definitions for data types are FFS.** + +## 7.10.7.4.2.3 Type: EdgeNotif + +Table 7.10.7.4.2.3-1: Definition of type EdgeNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| analyticsOutputs | array(string) | M | 1..N | Edge load analytics or edge load data collection for prediction or statistics depending on the type. | | +| analyticsType | AnalyticsType | C | 0..1 | Identity of the type of the edge load analytics or the type of the edge load data collection. (NOTE 1) | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | In case of notification on the edge load analytics, it provides accuracy level if the edge load analytics is prediction. | | +| destinationEasId | string | O | 0..1 | Identifier for the destination EAS, for which the edge load data collection applies. (NOTE 2) | | +| destinationEesId | string | O | 0..1 | Identifier for the destination EES, for which the edge load data collection applies. (NOTE 2) | | +| dnn | Dnn | O | 0..1 | Target DNN for for which the edge load data collection applies. (NOTE 2) | | + +NOTE 1: This attribute is optional if the notification is on the event of the edge load analytics and is optional if notification is on the event of the edge load data collection. + +NOTE 2: At least one of these attributes shall be present. + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.7.4.2.4 Type: EdgeLogReq + +Table 7.10.7.4.2.6-1: Definition of type EdgeLogReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------|---------------| +| analyticsType | AnalyticsType | M | 1 | Identity of the type of the edge load analytics | | +| destinationEasId | string | O | 0..1 | Identifier for the destination EAS, for which the edge load data analytics is requested. (NOTE) | | +| destinationEesId | string | O | 0..1 | Identifier for the destination EES, for which the edge load data analytics is requested. (NOTE) | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Defines the accuracy level for the edge load data analytics if the edge load data analytics is prediction. | | +| timeInterval | DurationSec | O | 0..1 | The time interval as the start and the end time, to which the edge load data analytics applies. | | + +NOTE: At least one of these attributes shall be present. + +Editor's Note: Detailed definitions for data types are FFS. + +## 7.10.7.4.2.5 Type: EdgeLogResp + +**Table 7.10.7.4.2.7-1: Definition of type EdgeLogResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|------------------------------------------------------------------------------|---------------| +| analyticsOutput | array(string) | M | 1..N | Edge load data analytics for prediction or statistics depending on the type. | | +| analyticsType | AnalyticsType | O | 0..1 | Identity of the type of the edge load data analytics | | +| confidenceLevel | ConfidenceLevel | O | 0..1 | Provides accuracy level if the edge load analytics is prediction. | | + +**Editor's Note:** Detailed definitions for data types are FFS. + +## 7.10.7.5 Error Handling + +## 7.10.7.5.1 General + +HTTP error handling shall be supported as specified in clause 6.7. + +In addition, the requirements in the following clauses shall apply. + +## 7.10.7.5.2 Protocol Errors + +In this release of the specification, there are no additional protocol errors applicable for the SS\_ADAE\_EdgeLoadAnalytics API. + +## 7.10.7.5.3 Application Errors + +The application errors defined for SS\_ADAE\_EdgeLoadAnalytics API are listed in table 7.10.7.5.3-1. + +**Table 7.10.7.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|-------------------|------------------|-------------|---------------| +| | | | | + +## 7.10.7.6 Feature Negotiation + +General feature negotiation procedures are defined in clause 6.8. Table 7.10.7.6-1 lists the supported features for SS\_ADAE\_EdgeLoadPatternAnalytics API. + +**Table 7.10.7.6-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +|----------------|--------------|-------------| + +## 8 Using Common API Framework + +### 8.1 General + +When CAPIF is used with a SEAL service, the SEAL server shall support the following as defined in 3GPP TS 29.222 [16]: + +- the API exposing function and related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and related APIs over CAPIF-4/4e reference point; + +- the API management function and related APIs over CAPIF-5/5e reference point; and +- at least one of the security methods for authentication and authorization, and related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [17], where the CAPIF core function and API provider domain functions are co-located, the interactions between the CAPIF core function and API provider domain functions may be independent of CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with a SEAL service, the SEAL server shall register all the features for northbound APIs in the CAPIF Core Function. + +## 8.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the SEAL server, the VAL server as API invoker shall negotiate the security method (PKI, TLS-PSK or OAUTH2) with CAPIF core function and ensure the SEAL server has enough credential to authenticate the VAL server (see 3GPP TS 29.222 [16], clause 5.6.2.2 and clause 6.2.2.2). + +If PKI or TLS-PSK is used as the selected security method between the VAL server and the SEAL server, upon API invocation, the SEAL server shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [16], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [18], the access to the SEAL APIs may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [19]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [16]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth2 is used as the selected security method between the VAL server and the SEAL server, the VAL server, prior to consuming services offered by the SEAL APIs, shall obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [16], clause 5.6.2.3.2. + +The SEAL APIs do not define any scopes for OAuth2 authorization. It is the SEAL server responsibility to check whether the VAL server is authorized to use an API based on the "token". Once the SEAL server verifies the "token", it shall check whether the SEAL server identifier in the "token" matches its own published identifier, and whether the API name in the "token" matches its own published API name. If those checks are passed, the VAL server has full authority to access any resource or operation for the invoked API + +NOTE 2: For aforementioned security methods, the SEAL server needs to apply admission control according to access control policies after performing the authorization checks. + +--- + +## 9 Security + +### 9.1 General + +The security aspects of SEAL reference points are specified in 3GPP TS 33.434 [26]. + +### 9.2 SEAL-S security + +As specified in clause 5.1.1.8 of 3GPP TS 33.434 [26], the protection of SEAL-S reference point shall be supported according to NDS/IP as specified in 3GPP TS 33.210 [25]. + +When CAPIF is not used, then TLS and OAuth 2.0 shall be supported as described in clause 5.1.1.8 of 3GPP TS 33.434 [26]. When TLS is used, mutual authentication based on client and server certificates shall be performed between the SEAL server and VAL server using TLS. After the authentication, the SEAL server determines whether the VAL server is authorized to send requests to the SEAL server. The SEAL server shall authorize the requests from VAL server using OAuth-based authorization mechanism. + +When CAPIF is used, the security mechanisms described in clause 8.2 shall be applied. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This annex is based on the OpenAPI Specification [15] and provides corresponding representations of all APIs defined in the present specification in YAML format. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API. + +NOTE: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification file contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5B of the 3GPP TR 21.900 [24] and clause 5.3.1 of the 3GPP TS 29.501 [14] for further information). + +## A.2 SS\_LocationReporting API + +``` +openapi: 3.0.0 + +info: + title: SS_LocationReporting + description: | + API for SEAL Location Reporting Configuration. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.2.0-alpha.2" + +externalDocs: + description: > + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-lr/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /trigger-configurations: + post: + description: Creates a new location reporting configuration. + operationId: CreateLocReportingConfig + tags: + - SEAL Location Reporting Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReportConfiguration' + responses: + '201': + description: Location reporting configuration resource is created successfully. + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/LocationReportConfiguration' +headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + NotifyLocationTriggerEvent: + '{ $request.body#/notifUri }': + post: + summary: Notify on location event. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReport' +responses: + '204': + description: The notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/trigger-configurations/{configurationId}: + get: + description: Retrieves an individual SEAL location reporting configuration information. + operationId: RetrieveLocReportingConfig + tags: + - Individual SEAL Location Reporting Configuration (Document) + parameters: + - name: configurationId + +``` + +``` +in: path +description: String identifying an individual configuration resource. +required: true +schema: + type: string +responses: + '200': + description: The location reporting configuration information. + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReportConfiguration' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + description: Updates an individual SEAL location reporting configuration. + operationId: UpdateLocReportingConfig + tags: + - Individual SEAL Location Reporting Configuration (Document) + parameters: + - name: configurationId + in: path + description: String identifying an individual configuration resource. + required: true + schema: + type: string + requestBody: + description: Configuration information to be updated in location management server. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReportConfiguration' + responses: + '200': + description: The configuration is updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReportConfiguration' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +``` + +``` + + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + description: Deletes an individual SEAL location reporting configuration. + operationId: DeleteLocReportingConfig + tags: + - Individual SEAL Location Reporting Configuration (Document) + parameters: + - name: configurationId + in: path + description: String identifying an individual configuration resource. + required: true + schema: + type: string + responses: + '204': + description: The individual configuration matching configurationId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + description: Modify an existing SEAL Location Reporting Configuration. + operationId: ModifyLocReportingConfig + tags: + - Individual SEAL Location Reporting Configuration (Document) + parameters: + - name: configurationId + in: path + description: Identifier of an individual SEAL location reporting configuration. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/LocationReportConfigurationPatch' + responses: + '200': + description: > + The individual SEAL location reporting configuration is modified successfully and + a representation of the updated SEAL location reporting configuration is returned + in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/LocationReportConfiguration' + '204': + description: > + No Content. The individual SEAL location reporting configuration is + modified successfully. + '307': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + LocationReportConfiguration: + description: Represents the location reporting configuration information. + type: object + properties: + valServerId: + type: string + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + immRep: + type: boolean + monDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + accuracy: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + valSvcAreaIds: + type: array + minItems: 1 + items: + type: string + description: > + Represents the VAL service area ID(s). + triggCriteria: + $ref: '#/components/schemas/TriggeringCriteria' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + report: + $ref: '#/components/schemas/LocationReport' + required: + - valServerId + - valTgtUe + + LocationReportConfigurationPatch: + description: Represents the location reporting configuration information patch. + type: object + properties: + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + monDur: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + accuracy: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy' + valSvcAreaIds: + type: array + minItems: 1 + items: + type: string + description: > + Represents the VAL service area ID(s). + triggCriteria: + $ref: '#/components/schemas/TriggeringCriteria' + +TriggeringCriteria: + description: Represents the location reporting triggering criteria. + type: object + properties: + reportingMode: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + repPer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + locChgCond: + $ref: '#/components/schemas/LocChangeCond' + ioInd: + $ref: '#/components/schemas/InsideOutsideInd' + repSchedules: + type: array + minItems: 1 + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime' + description: > + Indicates the requested reporting schedule, e.g., day(s) of the week + and/or time period(s) for the location reporting. + required: + - reportingMode + +LocationReport: + description: Represents the location trigger report. + type: object + properties: + subscriptionId: + type: string + description: Represents the subscription ID. + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - subscriptionId + - valTgtUe + - locInfo + +# Simple data types and Enumerations +InsideOutsideInd: + anyOf: + - type: string + enum: + - INSIDE + - OUTSIDE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Represents a desired condition of the location reporting, + e.g., inside or outside the given area. + Possible values are: + - INSIDE: Indicates that the reporting shall occur when the UE is inside the given location. + - OUTSIDE: Indicates that the reporting shall occur when the UE is outside the given + location. + +``` + +``` + +LocChangeCond: + anyOf: + - type: string + enum: + - CELL + - NODEB + - TA_RA + - WLAN_AN + - CIVIC_ADDR + - GPS + - SAI + - ECGI + - RAT + - VAL_SERVICE_AREA + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. + description: | + Represents a desired condition of the requested location change. + Possible values are: + - CELL: The condition is cell change. + - NODEB: The condition is eNodeB or gNodeB change. + - TA_RA: The condition is TA or RA change. + - WLAN_AN: The condition is WLAN access network change (e.g., SSID or BSSID change). + - CIVIC_ADDR: The condition is civic address change. + - GPS: The condition is GPS coordinate change. + - SAI: The condition is SAI change.. + - ECGI: The condition is ECGI change. + - RAT: The condition is RAT change. + - VAL_SERVICE_AREA: The condition is VAL service area change. + +``` + +## A.3 SS\_GroupManagement API + +openapi: 3.0.0 + +``` + +info: + title: SS_GroupManagement + description: | + API for SEAL Group management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.2.0-alpha.1" + +``` + +``` + +externalDocs: + description: > + 3GPP TS 29.549 V18.1.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: [] + +``` + +``` + +servers: + - url: '{apiRoot}/ss-gm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +``` + +``` + +paths: + /group-documents: + post: + description: Creates a new VAL group document. + operationId: CreateValGroupDoc + tags: + - VAL Group Documents (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + +``` + +``` +responses: + '201': + description: VAL group created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +get: + description: Retrieves VAL group documents satisfying filter criteria + operationId: RetrieveValGroupDocs + tags: + - VAL Group Documents (Collection) + parameters: + - name: val-group-id + in: query + description: String identifying the VAL group. + schema: + type: string + - name: val-service-id + in: query + description: String identifying the Val service. + schema: + type: string + responses: + '200': + description: List of VAL group documents matching the query parameters in the request. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VALGroupDocument' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/group-documents/{groupDocId}: + get: + description: Retrieves VAL group information satisfying filter criteria. + operationId: RetrieveIndValGroupDoc + tags: + - Individual VAL Group Document (Document) + parameters: + - name: groupDocId + in: path + description: String identifying an individual VAL group document resource. + required: true + schema: + type: string + - name: group-members + in: query + description: > + When set to true indicates the group management server to send the members + list information of the VAL group. + schema: + type: boolean + - name: group-configuration + in: query + description: > + When set to true indicates the group management server to send the group + configuration information of the VAL group. + schema: + type: boolean + responses: + '200': + description: > + The VAL group information based on the request from the VAL server. Includes + VAL group members list if group-members flag is set to true in the request, + VAL group configuration information if the group-configuration flag is set to + true in the request, VAL group identifier, whole VAL group document resource + if both group-members and group-configuration flags are omitted/set to false + in the request. + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + description: Updates an individual VAL group document. + operationId: UpdateIndValGroupDoc + tags: + - Individual VAL Group Document (Document) + parameters: + - name: groupDocId + in: path + description: String identifying an individual VAL group document resource +``` + +``` + required: true + schema: + type: string + requestBody: + description: VAL group document to be updated in Group management server. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + responses: + '200': + description: VAL group document updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + description: Deletes a VAL Group. + operationId: DeleteIndValGroupDoc + tags: + - Individual VAL Group Document (Document) + parameters: + - name: groupDocId + in: path + description: String identifying an individual VAL group document resource. + required: true + schema: + type: string + responses: + '204': + description: The individual VAL group matching groupDocId was deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +``` + +``` + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +patch: + description: Modify an existing VAL Group document. + operationId: ModifyIndValGroupDoc + tags: + - Individual VAL Group Document (Document) + parameters: + - name: groupDocId + in: path + description: Identifier of an individual VAL group document. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/VALGroupDocumentPatch' + responses: + '200': + description: > + The individual VAL Group document is modified successfully and a + representation of the updated VAL Group document is returned in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/VALGroupDocument' + '204': + description: No Content. The individual VAL group document is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + VALGroupDocument: + description: Represents details of the VAL group document information. + type: object + properties: + valGroupId: + type: string + description: The VAL group identity. + grpDesc: + type: string + description: The text description of the VAL group. +``` + +``` + +members: + type: array + description: The list of VAL User IDs or VAL UE IDs, which are members of the VAL group. + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 +valGrpConf: + type: string + description: Configuration data for the VAL group. +valServiceIds: + type: array + description: The list of VAL services enabled on the group. + items: + type: string + minItems: 1 +valSvcInf: + type: string + description: VAL service specific information. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' +locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' +addLocInfo: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' +valSvcAreaId: + type: string + description: Identity of the VAL service area. +extGrpId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' +com5GLanType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' +required: +- valGroupId + +VALGroupDocumentPatch: + description: Represents details of the partial update of VAL group document information. + type: object + properties: + grpDesc: + type: string + description: The text description of the VAL group. + members: + type: array + description: The list of VAL User IDs or VAL UE IDs, which are members of the VAL group. + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + valGrpConf: + type: string + description: Configuration data for the VAL group. + valServiceIds: + type: array + description: The list of VAL services enabled on the group. + items: + type: string + minItems: 1 + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + addLocInfo: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + valSvcAreaId: + type: string + description: Identity of the VAL service area. + extGrpId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + com5GLanType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + +``` + +## A.4 SS\_UserProfileRetrieval API + +openapi: 3.0.0 + +info: + +``` + +title: SS_UserProfileRetrieval +description: | + API for SEAL User Profile Retrieval. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +version: "1.2.0-alpha.1" + +externalDocs: + description: > + 3GPP TS 29.549 V18.0.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-upr/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /val-services: + get: + description: Retrieve VAL User or VAL UE profile information. + operationId: RetrieveValUserProfile + tags: + - VAL Services + parameters: + - name: val-service-id + in: query + description: String identifying an individual VAL service + required: false + schema: + type: string + - name: val-tgt-ue + in: query + description: Identifying a VAL target UE. + required: true + schema: + $ref: '#/components/schemas/ValTargetUe' + responses: + '200': + description: The Profile information of the VAL User or VAL UE. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ProfileDoc' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + +``` + +``` + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ProfileDoc: + description: Represents the profile information associated with a VAL user ID or a VAL UE ID. + type: object + properties: + profileInformation: + type: string + description: Profile information associated with the valUserId or valUeId. + valTgtUe: + $ref: '#/components/schemas/ValTargetUe' + required: + - profileInformation + - valTgtUe + + ValTargetUe: + description: Represents the information identifying a VAL user ID or a VAL UE ID. + type: object + properties: + valUserId: + type: string + description: Unique identifier of a VAL user. + valUeId: + type: string + description: Unique identifier of a VAL UE. + oneOf: + - required: [valUserId] + - required: [valUeId] + +``` + +## A.5 SS\_NetworkResourceAdaptation API + +``` + +openapi: 3.0.0 +info: + version: 1.2.0-alpha.4 + title: SS_NetworkResourceAdaptation + description: | + SS Network Resource Adaptation Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.549 V18.4.0; Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-nra/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +paths: + /multicast-subscriptions: + post: + summary: Creates a new Individual Multicast Subscription resource + operationId: CreateMulticastSubscription + tags: + - Multicast Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + +``` + +``` + + schema: + $ref: '#/components/schemas/MulticastSubscription' +responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/MulticastSubscription' + headers: + Location: + description: > + Contains the URI of the created individual multicast subscription resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + UserPlaneNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserPlaneNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/multicast-subscriptions/{multiSubId}: + +``` + +``` +get: + summary: "Reads an existing Individual Multicast Subscription" + operationId: GetMulticastSubscription + tags: + - Individual Multicast Subscription (Document) + parameters: + - name: multiSubId + in: path + description: Multicast Subscription ID + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/MulticastSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: "Delete an existing Individual Multicast Subscription" + operationId: DeleteMulticastSubscription + tags: + - Individual Multicast Subscription (Document) + parameters: + - name: multiSubId + in: path + description: Multicast Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/mbs-resources: +``` + +``` +post: + summary: Request the creation of a new MBS Resource. + operationId: CreateMBSResource + tags: + - MBS Resources (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResourceReq' + responses: + '201': + description: > + Created. Successfull case. The requested MBS resource is successfully created and a + representation of the created Individual MBS Resource resource is returned in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResourceResp' + headers: + Location: + description: > + Contains the URI of the created Individual MBS Resource resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + UserPlaneNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserPlaneNotification' + responses: + '204': + description: No Content. The notification was successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/mbs-resources/{mbsResId}: + parameters: + - name: mbsResId + in: path + description: Represents the identifier of the Individual MBS Resource resource. + required: true + schema: + type: string + + get: + summary: Request the retrieval of an existing Individual MBS Resource. + operationId: GetIndivMBSResource + tags: + - Individual MBS Resource (Document) + responses: + '200': + description: > + OK. Successful case. A representation of the requested Individual MBS Resource resource + is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + put: + summary: Request the update of an existing Individual MBS Resource. + operationId: UpdateIndivMBSResource + tags: + - Individual MBS Resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + responses: + '200': + description: > + OK. Successful case. The targeted Individual MBS Resource resource is successfully + updated and a representation of the updated resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + +``` + +``` + + '204': + description: > + No Content. Successful case. The targeted Individual MBS Resource resource is + successfully updated and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Request the modification of an existing Individual MBS Resource. + operationId: ModifyIndivMBSResource + tags: + - Individual MBS Resource (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MBSResourcePatch' + responses: + '200': + description: > + OK. Successful case. The targeted Individual MBS Resource resource is successfully + modified and a representation of the updated resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MBSResource' + '204': + description: > + No Content. Successful case. The targeted Individual MBS Resource resource is + successfully modified and no content is returned in the response body. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Request the deletion of an existing Individual MBS Resource. + operationId: DeleteIndivMBSResource + tags: + - Individual MBS Resource (Document) + responses: + '204': + description: > + +``` + +``` +No Content. Successful case. The targeted Individual MBS Resource resource is +successfully deleted. +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/mbs-resources/{mbsResId}/activate: +parameters: +- name: mbsResId + in: path + description: Represents the identifier of the Individual MBS Resource resource. + required: true + schema: + type: string + +post: +summary: Request the activation of an existing MBS Resource. +operationId: ActivateMBSResource +tags: +- Individual MBS Resource (Document) +requestBody: +required: true +content: +application/json: +schema: + $ref: '#/components/schemas/MbsResAct' +responses: +'200': +description: > +OK. The activation request is successfully received and processed. +content: +application/json: +schema: + $ref: '#/components/schemas/MbsResAct' +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` +/mbs-resources/{mbsResId}/deactivate: + parameters: + - name: mbsResId + in: path + description: Represents the identifier of the Individual MBS Resource resource. + required: true + schema: + type: string + + post: + summary: Request the deactivation of an existing MBS Resource. + operationId: DeactivateMBSResource + tags: + - Individual MBS Resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MbsResDeact' + responses: + '200': + description: > + OK. The deactivation request is successfully received and processed. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsResDeact' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/unicast-subscriptions: + post: + summary: Creates a new Individual Unicast Subscription resource + operationId: CreateUnicastSubscription + tags: + - Unicast Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnicastSubscription' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UnicastSubscription' + headers: + Location: + description: > + Contains the URI of the created individual unicast subscription resource. +``` + +``` + + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + UserPlaneNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserPlaneNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/unicast-subscriptions/{uniSubId}: + get: + summary: "Reads an existing Individual Unicast Subscription" + operationId: GetUnicastSubscription + tags: + - Individual Unicast Subscription (Document) + parameters: + - name: uniSubId + in: path + description: Unicast Subscription ID + required: true + schema: + type: string + responses: + +``` + +``` +'200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/UnicastSubscription' +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: "Delete an existing Individual Unicast Subscription" + operationId: DeleteUnicastSubscription + tags: + - Individual Unicast Subscription (Document) + parameters: + - name: uniSubId + in: path + description: Unicast Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/tsc-stream-availability: + get: + summary: Discover the TSC stream availability information. + operationId: GetTscStreamAvailability + tags: + - TSC stream availability discovery + parameters: + - name: stream-specs + in: query + description: > + The MAC address(es) of the source DS-TT port(s) and the destination DS-TT port(s). + required: true + schema: + type: array + items: +``` + +``` + + $ref: '#/components/schemas/StreamSpecification' + minItems: 1 + responses: + '200': + description: OK. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TscStreamAvailability' + minItems: 0 + '204': + description: No Content. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/tsc-streams: + get: + summary: Retrieval of TSC stream data. + operationId: GetTscStream + tags: + - TSC stream retrieval + parameters: + - name: val-stream-ids + in: query + description: Retrieval of TSC Stream data, identified by the VAL Stream ID(s). + required: false + schema: + type: array + items: + type: string + minItems: 1 + responses: + '200': + description: OK (successful query of TSC stream resource) + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TscStreamData' + minItems: 1 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + +``` + +``` +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +/tsc-streams/{valStreamId}: + get: + summary: "Reads an existing Individual TSC stream data information" + operationId: GetTscStreamData + tags: + - Individual TSC Stream Retrieval + parameters: + - name: valStreamId + in: path + description: The VAL Stream ID identifies the TSC stream. + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/TscStreamData' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + put: + summary: Create a TSC stream identified by a VAL stream identifier. + operationId: PutTscStream + tags: + - TSC stream creation + description: Create an individual TSC stream identified by VAL Stream ID. + parameters: + - name: valStreamId + in: path + description: VAL stream identifier + required: true + schema: + type: string + requestBody: + description: TSC stream creation request data from the VAL server to the NRM server. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TscStreamData' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/TscStreamData' + headers: +``` + +``` + Location: + description: Contains the URI of the created individual TSC stream resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +delete: + summary: "Delete an existing Individual TSC stream" + operationId: DeleteTscStream + tags: + - Individual TSC Stream Deletion + parameters: + - name: valStreamId + in: path + description: The VAL Stream ID identifies the TSC stream. + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/bdt-policy-configs: + post: + summary: Creates a new Individual BDT Policy Configuration + operationId: CreateBDTPolicyConfig + tags: + - BDT Policy Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' + responses: + '201': + description: Success +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' +headers: + Location: + description: > + Contains the URI of the created individual BDT Policy configuration resource. + required: true + schema: + type: string +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +callbacks: + BdtNotification: + "{$request.body#/notifUri}": + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/bdt-policy-configs/{bdtPolConfigId}: + parameters: + - name: bdtPolConfigId + in: path + description: Represents the identifier of the Individual BDT Policy Configuration. + +``` + +``` + required: true + schema: + type: string + +get: + summary: Reads an existing Individual BDT Policy Configuration + operationId: GetBDTPolicyConfig + tags: + - Individual BDT Policy Configuration(Document)Config + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolConfig' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Delete an existing Individual BDT policy Configuration + operationId: DeleteBDTPolicyConfig + tags: + - Individual BDT Policy Configuration (Document) + responses: + '204': + description: No Content. Resource was successfully deleted + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: +``` + +``` + +MulticastSubscription: + description: Represents a multicast subscription. + type: object + properties: + valGroupId: + type: string + anncMode: + $ref: '#/components/schemas/ServiceAnnouncementMode' + multiQosReq: + type: string + locArea: + $ref: 'TS29122_GMDviaMBMSbyMB2.yaml#/components/schemas/MbmsLocArea' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tmgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + localMbmsInfo: + $ref: 'TS29486_VAE_FileDistribution.yaml#/components/schemas/LocalMbmsInfo' + localMbmsActInd: + type: boolean + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqTestNotif: + type: boolean + wsNotifCfg: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + upIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + upIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + upPortNum: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + radioFreqs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + minItems: 1 + required: + - valGroupId + - anncMode + - multiQosReq + - notifUri + +UnicastSubscription: + description: Represents a unicast subscription. + type: object + properties: + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + uniQosReq: + type: string + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqTestNotif: + type: boolean + wsNotifCfg: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valTgtUe + - notifUri + +UserPlaneNotification: + description: Represents a notification on User Plane events. + type: object + properties: + notifId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + eventNotifs: + type: array + items: + $ref: '#/components/schemas/NrmEventNotification' + minItems: 1 + +``` + +``` +required: + - notifId + - eventNotifs + +NrmEventNotification: + description: Represents a notification on an individual User Plane event. + type: object + properties: + event: + $ref: '#/components/schemas/NrmEvent' + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + deliveryMode: + $ref: '#/components/schemas/DeliveryMode' + streamIds: + type: array + items: + type: string + minItems: 1 + required: + - event + - ts + +TscStreamAvailability: + description: > + TSC stream availability information includes the stream specification and list of traffic + specifications. This response shall include stream specification matching one of the query + parameters provided in the request. + type: object + properties: + streamSpec: + $ref: '#/components/schemas/StreamSpecification' + trafficSpecs: + type: array + items: + $ref: '#/components/schemas/TrafficSpecification' + minItems: 1 + required: + - streamSpec + - trafficSpecs + +StreamSpecification: + description: > + Stream specification includes MAC addresses of the source and destination DS-TT ports. + type: object + properties: + srcMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dstMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + required: + - srcMacAddr + - dstMacAddr + +TrafficSpecification: + description: > + The traffic classe supported by the DS-TTs and available end-to-end maximum latency value. + type: object + properties: + trafficClass: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + e2eMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - trafficClass + - e2eMaxLatency + +TscStreamData: + description: TSC stream data information. + type: object + properties: + streamSpec: + $ref: '#/components/schemas/StreamSpecification' + trafficSpecInfo: + $ref: '#/components/schemas/TrafficSpecInformation' + required: + - streamSpec + - trafficSpecInfo +``` + +``` +TrafficSpecInformation: + description: > + The traffic classe supported by the DS-TTs and available end-to-end latency + value and Priority Code Point (PCP) value. + type: object + properties: + pcpValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxFramInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec' + maxFramSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxIntFrames: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + maxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + required: + - pcpValue + - maxFramInt + - maxFramSize + - maxIntFrames + - maxLatency + +MBSResourceReq: + description: Represents the parameters to request the creation of an MBS Resource. + type: object + properties: + mbsResource: + $ref: '#/components/schemas/MBSResource' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsResource + +MBSResource: + description: Represents an MBS Resource. + type: object + properties: + valGroupId: + type: string + valUeIdsList: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + servAnmtMode: + $ref: '#/components/schemas/ServiceAnnouncementMode' + mbsResServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + mbsResServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + netSysInd: + $ref: '#/components/schemas/NetSysIndicator' + localMbmsInfo: + $ref: 'TS29486_VAE_FileDistribution.yaml#/components/schemas/LocalMbmsInfo' + localMbmsActInd: + type: boolean + mbsResRespInfo: + $ref: '#/components/schemas/MBSResourceRespInfo' + oneOf: + - required: [valGroupId] + - required: [valUeIdsList] + not: + - required: [localMbmsInfo, localMbmsActInd] + required: + - servAnmtMode + - mbsResServInfo + - notifUri + +MBSResourceRespInfo: + description: Represents NRM Server side information related to the MBS Resource. + type: object + properties: + mbs5gSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' +``` + +``` + mbmsBearerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + upIpv4Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + upIpv6Addr: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + upPortNum: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Port' + mbs5GInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSession' + epsMbmsInfo: + $ref: '#/components/schemas/EpsMbmsInfo' + anyOf: + - required: [upIpv4Addr] + - required: [upIpv6Addr] + +MBSResourceResp: + description: Represents a response to an MBS Resource creation/modification request. + type: object + properties: + mbsResource: + $ref: '#/components/schemas/MBSResource' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsResource + +MBSResourcePatch: + description: Represents the parameters to request the modification of an MBS Resource. + type: object + properties: + mbsResServInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceInfo' + mbsResServiceArea: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalMbsServiceArea' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + localMbmsInfo: + $ref: 'TS29486_VAE_FileDistribution.yaml#/components/schemas/LocalMbmsInfo' + localMbmsActInd: + type: boolean + mbsResRespInfo: + $ref: '#/components/schemas/MBSResourceRespInfo' + anyOf: + - required: [mbsResServInfo] + - required: [mbsResServiceArea] + - required: [localMbmsInfo] + not: + - required: [localMbmsInfo, localMbmsActInd] + +MbsResAct: + description: Represents the parameters related to the activation of the MBS Resource. + type: object + properties: + mbs5gSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbs5gSessionId + +MbsResDeact: + description: Represents the parameters related to the deactivation of the MBS Resource. + type: object + properties: + mbs5gSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbs5gSessionId + +BdtPolConfig: + description: Represents the parameters related to the BDT Policy configuration. + type: object + properties: + valServId: +``` + +``` + + type: string + valGroupId: + type: string + valUeIds: + type: array + items: + type: string + minItems: 1 + dataVolUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + desiredTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + grantTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + geoArea: + $ref: '#/components/schemas/GeoArea' + bdtPolRefId: + type: string + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oneOf: + - required: [valGroupId] + - required: [valUeIds] + required: + - valServId + - notifUri + +``` + +``` + +GeoArea: + description: Represents a Geographical area. + type: object + properties: + geographicAreas: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + description: Represents a list of Geographical area. + civicAddresses: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + description: Represents a list of Civic address of an area. + +``` + +``` + +BdtNotification: + description: Represents a notification on update related to BDT Policy configuration resource. + type: object + properties: + notifId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + bdtConfigId: + type: string + grantTimeWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + bdtPolicyRemoveInd: + type: boolean + default: false + required: + - notifId + - bdtConfigId + +``` + +#### # Simple data types and Enumerations + +``` + +EpsMbmsInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +``` + +``` + +ServiceAnnouncementMode: + anyOf: + - type: string + enum: + - NRM + - VAL + - type: string + +``` + +``` + description: > + 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. + description: | + Indicates the service announcement mode. + Possible values are: + - NRM: NRM server performs the service announcement. + - VAL: VAL server performs the service announcement. + + DeliveryMode: + anyOf: + - type: string + enum: + - UNICAST + - MULTICAST + - MBS_MULTICAST + - MBS_BROADCAST + - type: string + description: > + 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. + description: | + Indicates the user plane delivery mode. + Possible values are: + - UNICAST: Indicates Unicast delivery. + - MULTICAST: Indicates EPS MBMS Multicast delivery. + - MBS_MULTICAST: Indicates 5GS MBS Multicast delivery. + - MBS_BROADCAST: Indicates 5GS MBS Broadcast delivery. + + NrmEvent: + anyOf: + - type: string + enum: + - UP_DELIVERY_MODE + - type: string + description: > + 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. + description: | + Indicates the NRM event. + Possible values are: + - UP_DELIVERY_MODE: User Plane delivery mode. + + NetSysIndicator: + anyOf: + - type: string + enum: + - 5GS + - EPS + - 5GS_AND_EPS + - type: string + description: > + 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. + description: | + Represents the network system indicator, i.e. 5GS, EPS or both. + Possible values are: + - 5GS: Indicates that the network system is 5GS. + - EPS: Indicates that the network system is EPS. + - 5GS_AND_EPS: Indicates that the network system is 5GS and EPS. +``` + +--- + +## A.6 SS\_Events API + +openapi: 3.0.0 + +``` +info: + title: SS_Events + description: | + API for SEAL Events management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.2.0-alpha.3" +``` + +``` + +externalDocs: + description: > + 3GPP TS 29.549 V18.3.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/ss-events/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /subscriptions: + post: + description: Creates a new individual SEAL Event Subscription. + operationId: CreateSealEventSubsc + tags: + - SEAL Events Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventSubscription' + callbacks: + notificationDestination: + '{request.body#/notificationDestination}': + post: + requestBody: # contents of the callback message + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventNotification' + responses: + '204': + description: No Content (successful notification) + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + /subscriptions/{id}: + get: + responses: + '201': + description: SEAL Events subscription resource created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventSubscription' + headers: + Location: + +``` + +``` + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionId}: + delete: + description: Deletes an individual SEAL Event Subscription. + operationId: DeleteIndSealEventSubsc + tags: + - Individual SEAL Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual Events Subscription + required: true + schema: + type: string + responses: + '204': + description: > + The individual SEAL Events Subscription matching the subscriptionId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + patch: + description: Modify an existing SEAL Event Subscription. + operationId: ModifyIndSealEventSubsc + tags: + - Individual SEAL Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual Events Subscription + required: true + schema: + type: string + requestBody: + required: true +``` + +``` + +content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SEALEventSubscriptionPatch' +responses: + '200': + description: > + The definition SEAL event subscription is modified successfully and + a representation of the updated service API is returned in the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventSubscription' + '204': + description: No Content. The SEAL Event Subscription is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +put: + description: Replace an existing SEAL event subscription. + operationId: UpdateIndSealEventSubsc + tags: + - Individual SEAL Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Identifier of an individual Events Subscription + required: true + schema: + type: string + requestBody: + description: Individual SEAL events subscription to be replaced. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventSubscription' + responses: + '200': + description: SEAL Event subscription updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SEALEventSubscription' + '204': + description: No Content. Individual SEAL event subscription was updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + SEALEventSubscription: + description: Represents an individual SEAL Event Subscription resource. + type: object + properties: + subscriberId: + type: string + description: String identifying the subscriber of the event. + eventSubs: + type: array + items: + $ref: '#/components/schemas/EventSubscription' + minItems: 1 + description: Subscribed events. + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + requestTestNotification: + type: boolean + description: > + Set to true by Subscriber to request the SEAL server to send a test notification. + Set to false or omitted otherwise. + websocketNotifConfig: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + eventDetails: + type: array + items: + $ref: '#/components/schemas/SEALEventDetail' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - subscriberId + - eventSubs + - eventReq + - notificationDestination + + SEALEventSubscriptionPatch: + description: Represents the partial update of individual SEAL Event Subscription resource. + type: object + properties: + eventSubs: + type: array + items: + $ref: '#/components/schemas/EventSubscription' + minItems: 1 + description: Subscribed events. + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationDestination: +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +SEALEventNotification: + description: Represents notification information of a SEAL Event. + type: object + properties: + subscriptionId: + type: string + description: Identifier of the subscription resource. + eventDetails: + type: array + items: + $ref: '#/components/schemas/SEALEventDetail' + minItems: 1 + description: Detailed notifications of individual events. + required: + - subscriptionId + - eventDetails + +EventSubscription: + description: Represents the subscription to a single SEAL event. + type: object + properties: + eventId: + $ref: '#/components/schemas/SEALEvent' + valGroups: + type: array + items: + $ref: '#/components/schemas/VALGroupFilter' + minItems: 1 + description: > + Each element of the array represents the VAL group identifier(s) of a VAL service + that the subscriber wants to know in the interested event. + identities: + type: array + items: + $ref: '#/components/schemas/IdentityFilter' + minItems: 1 + description: > + Each element of the array represents the VAL User / UE IDs of a VAL service + that the event subscriber wants to know in the interested event. + monFltr: + type: array + items: + $ref: '#/components/schemas/MonitorFilter' + minItems: 1 + description: > + List of event monitoring details that the subscriber wishes to mmonitor the VAL UEs, + VAL group and/or VAL service. + areaInt: + type: array + items: + $ref: '#/components/schemas/MonitorLocationInterestFilter' + minItems: 1 + description: > + Represents the list of VAL User / UE IDs and the area of interest information + which the subscriber wishes to monitor the location deviation of VAL User / UEs. + locAreaMon: + type: array + items: + $ref: '#/components/schemas/MonLocAreaInterestFltr' + minItems: 1 + description: > + Each element represents the location area monitoring details to monitor the + VA UEs moving in and out of the provided location area. + partialFailRep: + $ref: '#/components/schemas/PartialEventSubscFailRep' + required: + - eventId + +SEALEventDetail: + description: Represents the SEAL event details. + type: object + properties: + eventId: + $ref: '#/components/schemas/SEALEvent' + lmInfos: + type: array +``` + +``` + items: + $ref: '#/components/schemas/LMInformation' + minItems: 1 + valGroupDocuments: + type: array + items: + $ref: 'TS29549_SS_GroupManagement.yaml#/components/schemas/VALGroupDocument' + minItems: 1 + description: > + The VAL groups documents with modified membership and configuration information. + profileDocs: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ProfileDoc' + minItems: 1 + description: Updated profile information associated with VAL Users or VAL UEs. + msgFltrs: + type: array + items: + $ref: '#/components/schemas/MessageFilter' + minItems: 1 + description: > + The message filter information for various member VAL User or UEs of the VAL group. + monRep: + type: array + items: + $ref: '#/components/schemas/MonitorEventsReport' + minItems: 1 + description: The events reports with details of the events related to the VAL UE(s). + locAdhr: + type: array + items: + $ref: '#/components/schemas/LocationDevMonReport' + minItems: 1 + description: > + The location deviation information for the interested VAL User ID or UE IDs + in a given location. + tempGroupInfo: + $ref: '#/components/schemas/TempGroupInfo' + locAreaMonRep: + type: array + items: + $ref: '#/components/schemas/LocationAreaMonReport' + minItems: 1 + description: The location area monitoring of the given area of interest. + required: + - eventId + + VALGroupFilter: + description: Represents a filter of VAL group identifiers belonging to a VAL service. + type: object + properties: + valSvcId: + type: string + description: Identity of the VAL service + valGrpIds: + type: array + items: + type: string + minItems: 1 + description: > + VAL group identifiers that event subscriber wants to know in the interested event. + required: + - valGrpIds + + IdentityFilter: + description: Represents a filter of VAL User / UE identities belonging to a VAL service. + type: object + properties: + valSvcId: + type: string + description: Identity of the VAL service + valTgtUes: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: > +``` + +``` + VAL User IDs or VAL UE IDs that the event subscriber wants to know + in the interested event. + suppLoc: + type: boolean + description: Set to true by Subscriber to request the supplementary location information. + locQoS: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS' + + LMInformation: + description: Represents the location information for a VAL User ID or a VAL UE ID. + type: object + properties: + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + valSvcId: + type: string + description: Identity of the VAL service + required: + - locInfo + - valTgtUe + + MessageFilter: + description: Represents the message filters applicable to a VAL User ID or VAL UE ID. + type: object + properties: + reqUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + tgtUe: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: List of VAL User or UE IDs whose message to be sent. + maxMsgs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + scheds: + type: array + items: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + minItems: 1 + description: Time frame associated with total number of messages. + msgTypes: + type: array + items: + type: string + minItems: 1 + description: List of message types to be sent to VAL UE. + required: + - reqUe + + MonitorFilter: + description: Represents the event monitoring filters applicable to a VAL User ID or VAL UE ID. + type: object + properties: + idnts: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: List of VAL User or UE IDs whose events monitoring is requested. + valSvcId: + type: string + description: Identity of the VAL service. + valGrpId: + type: string + description: Identity of the group of the target UEs. + profId: + type: string + description: The monitoring profile ID identifying a list of monitoring, analytics events. + valCnds: + type: array + items: + $ref: '#/components/schemas/ValidityConditions' + minItems: 1 +``` + +``` + description: The temporal,spatial conditions for the events to be considered valid. + evntDets: + type: array + items: + $ref: '#/components/schemas/MonitorEvents' + minItems: 1 + description: List of monitoring, analytics events to be monitored. + +MonitorEvents: + description: List of event types to be monitored in the context of events monitoring service. + type: object + properties: + cnEvnts: + type: array + items: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/MonitoringType' + minItems: 1 + description: List of monitoring events related to VAL UE. + anlEvnts: + type: array + items: + $ref: 'TS29522_AnalyticsExposure.yaml#/components/schemas/AnalyticsEvent' + minItems: 1 + description: List of analytics events related to VAL UE. + +MonitorEventsReport: + description: List of monitoring and/or analytics events related to VAL UE. + type: object + properties: + tgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + evnts: + type: array + items: + $ref: '#/components/schemas/MonitorEvents' + minItems: 1 + description: List of monitoring and analytics events related to VAL UE. + required: + - tgtUe + - evnts + +ValidityConditions: + description: List of monitoring and/or analytics events related to VAL UE. + type: object + properties: + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + tmWdws: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: Time window validity conditions. + +MonitorLocationInterestFilter: + description: Represents the location monitoring filter information. + type: object + properties: + tgtUes: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: List of VAL Users or UE IDs for which location monitoring is requested. + locInt: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + valSvcId: + description: Identifier of the VAL service area to monitor the location deviation. + type: string + notInt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - tgtUes + - notInt + oneOf: + - required: [locInt] + - required: [valSrvId] +``` + +``` +LocationDevMonReport: + description: Location deviation monitoring report. + type: object + properties: + tgtUes: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: List of VAL Users or UE IDs for which report is related to. + locInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + notifType: + $ref: '#/components/schemas/LocDevNotification' + required: + - tgtUes + - locInfo + - notifType + +TempGroupInfo: + description: Represents the created temporary VAL group information. + type: object + properties: + valGrpIds: + type: array + items: + type: string + minItems: 1 + tempValGrpId: + type: string + valServIds: + type: array + items: + type: string + minItems: 1 + required: + - valGrpIds + - tempValGrpId + +MonLocAreaInterestFltr: + description: Filter information indicate the area of interest and triggering events. + type: object + properties: + locInfoCri: + $ref: '#/components/schemas/LocationInfoCriteria' + trigEvnts: + type: array + items: + $ref: '#/components/schemas/MonLocTriggerEvent' + minItems: 1 + description: Triggering events when to send information. + required: + - locInfoCri + +LocationInfoCriteria: + description: > + Geographic location and reference UE details, where the UEs moving in and out + to be monitored. + type: object + properties: + geoArea: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + refUe: + $ref: '#/components/schemas/ReferenceUEDetail' + oneOf: + - required: [geoArea] + - required: [refUe] + +ReferenceUEDetail: + description: Reference UE details, where the UEs moving in and out to be monitored. + type: object + properties: + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + proxRange: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + proxRangeFrac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +``` + +``` + +required: + - valTgtUe + - proxRange + +LocationAreaMonReport: + description: Event report to notify the VAL UEs moving in or out from a given location. + type: object + properties: + curPreUEs: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: List of identities of all VAL UEs present in the given location area. + moveInOutUEs: + $ref: '#/components/schemas/MoveInOutUEDetails' + trigEvnt: + $ref: '#/components/schemas/MonLocTriggerEvent' + +MoveInOutUEDetails: + description: List of UEs moved in and out. + type: object + properties: + moveInUEs: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: > + List of identities of VAL UEs who moved in to given location area + since previous notification. + moveOutUEs: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: > + List of identities of VAL UEs who moved out of the given location area + since previous notification. + +PartialEventSubscFailRep: + description: Represents the partial failure report during the subscription creation or update. + type: object + properties: + valTgtUes: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + description: > + List of VAL user(s) / VAL UE(s) whose identifier(s) is not found. + valGrpIds: + type: array + items: + type: string + minItems: 1 + description: > + List of VAL group(s) whose identifier(s) is not found. + oneOf: + - required: [valTgtUes] + - required: [valGrpIds] + +``` + +#### # Simple data types and Enumerations + +``` + +SEALEvent: + anyOf: + - type: string + enum: + - LM_LOCATION_INFO_CHANGE + - GM_GROUP_INFO_CHANGE + - CM_USER_PROFILE_CHANGE + - GM_GROUP_CREATE + - NRM_MONITOR_UE_USER_EVENTS + - LM_LOCATION_DEVIATION_MONITOR + - GM_TEMP_GROUP_FORMATION + - LM_LOCATION_AREA_MONITOR + - type: string + description: > + +``` + +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. + +description: | + Represents the type of SEAL events that can be subscribed. + Possible values are: + - LM\_LOCATION\_INFO\_CHANGE: Events related to the location information of VAL Users or VAL UEs from the Location Management Server. + - GM\_GROUP\_INFO\_CHANGE: Events related to the modification of VAL group membership and configuration information from the Group Management Server. + - CM\_USER\_PROFILE\_CHANGE: Events related to update of user profile information from the Configuration Management Server. + - GM\_GROUP\_CREATE: Events related to creation of new VAL groups from the Group Management Server. + - NRM\_MONITOR\_UE\_USER\_EVENTS: Monitoring and analytic events related to VAL UEs, users or VAL group, from the Network Resource Management Server. + - LM\_LOCATION\_DEVIATION\_MONITOR: Events from Location Management server, related to the deviation of the VAL User(s) / UE(s) location from an area of interest. + - GM\_TEMP\_GROUP\_FORMATION: Events related to the formation of new temporary VAL groups from the Group Management Server. + - LM\_LOCATION\_AREA\_MONITOR: Events from Location Management server, related to the list of UEs moving in or moving out of the specific location. + +LocDevNotification: + +anyOf: + - type: string + enum: + - NOTIFY\_MISMATCH\_LOCATION + - NOTIFY\_ABSENCE + - NOTIFY\_PRESENCE + - type: string + description: > + 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. + description: | + Possible values are: + Enumeration of location deviation notification reports. + - NOTIFY\_MISMATCH\_LOCATION: This value indicates that the location information of the VAL UE(s) from the SEAL LM client and the core network are not matching. + - NOTIFY\_ABSENCE: This value indicates that the current location information of the VAL UE(s) is deviating from the VAL server's area of interest. + - NOTIFY\_PRESENCE: This value indicates that the current location information of the VAL UE(s) is within the VAL server's area of interest. + +MonLocTriggerEvent: + +anyOf: + - type: string + enum: + - DISTANCE\_TRAVELLED + - type: string + description: > + 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. + description: | + Identifies the triggering event in the location area monitor filtering. + Possible values are: + - DISTANCE\_TRAVELLED: This value indicates the trigger event for the location area monitoring based on the distance travelled by the reference UE. + +## A.7 SS\_KeyInfoRetrieval API + +openapi: 3.0.0 + +info: + title: SS\_KeyInfoRetrieval + description: | + API for SEAL Key Information Retrieval. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.1.1" + +externalDocs: + description: > + +3GPP TS 29.549 V17.6.0 Service Enabler Architecture Layer for Verticals (SEAL); +Application Programming Interface (API) specification; Stage 3. +url: [https://www.3gpp.org/ftp/Specs/archive/29\\_series/29.549/](https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/) + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/ss-kir/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /key-records: + get: + description: Retrieve key management information specific to VAL service. + operationId: RetrieveKeyMgmtInfo + tags: + - Key Records (Collection) + parameters: + - name: val-service-id + in: query + description: String identifying an individual VAL service + required: true + schema: + type: string + - name: val-tgt-ue + in: query + description: Identifying a VAL target. + required: false + schema: + \$ref: 'TS29549\_SS\_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + responses: + '200': + description: The key management information of the VAL service, VAL User or VAL UE. + content: + application/json: + schema: + \$ref: '#/components/schemas/ValKeyInfo' + '307': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/307' + '308': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/308' + '400': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/400' + '401': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/401' + '403': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/403' + '404': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/404' + '406': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/406' + '429': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/429' + '500': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/500' + '503': + \$ref: 'TS29122\_CommonData.yaml#/components/responses/503' + default: + \$ref: 'TS29122\_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ValKeyInfo: + description: > + Represents key management information associated with VAL server, VAL user or VAL UE. + +``` + +type: object +properties: + userUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + skmsId: + type: string + description: String identifying the key management server. + valService: + type: string + description: Unique identifier of a VAL Service. + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + keyInfo: + type: string + description: Key management information specific to VAL service, VAL User or VAL UE. +required: +- userUri +- valService +- keyInfo + +``` + +## A.8 SS\_LocationAreaInfoRetrieval API + +openapi: 3.0.0 + +``` + +info: + title: SS_LocationAreaInfoRetrieval + description: | + API for SEAL Location Area Info Retrieval. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.1.0-alpha.2" + +externalDocs: + description: > + 3GPP TS 29.549 V18.3.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: +- {} +- oAuth2ClientCredentials: [] + +servers: +- url: '{apiRoot}/ss-lair/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /location-retrievals: + get: + description: > + Retrieve the UE(s) information in an application defined proximity range of a location. + operationId: RetrieveUeLocInfo + tags: + - Location Information (Collection) + parameters: + - name: location-info + in: query + description: Location information around which the UE(s) information is requested. + required: true + schema: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + - name: val-svc-area-id + in: query + description: > + The val service area identifier around which which the UE(s) information is requested. + schema: + type: string + - name: range + in: query + description: > + The range information over which the UE(s) information is required, + expressed in meters. + +``` + +``` + + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + responses: + '200': + description: > + The UE(s) information in an application defined proximity range of a location. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29549_SS_Events.yaml#/components/schemas/LMInformation' + minItems: 0 + description: > + The UE(s) information in an application defined proximity range of a location. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +``` + +## A.9 SS\_NetworkSliceAdaptation API + +openapi: 3.0.0 + +``` + +info: + title: SS_NetworkSliceAdaptation + description: | + API for SEAL Network Slice Adaptation. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.1.0-alpha.1" + +externalDocs: + description: > + 3GPP TS 29.549 V18.0.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-nsa/v1' + variables: + apiRoot: + default: https://example.com + +``` + +``` +description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /request: + post: + summary: request the network slice adaptation. + operationId: RequestNetworkSliceAdaptation + tags: + - Network Slice Adaptation Request + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwSliceAdptInfo' + responses: + '204': + description: No Content. The requested network slice adaptation is successfully processed. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + NwSliceAdptInfo: + description: > + Represents the information associated with requested network slice adaptation + with the underlying network. + type: object + properties: + valServiceId: + type: string + valTgtUeIds: + type: array + items: + type: string + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valServiceId + - valTgtUeIds +``` + +## A.10 SS\_NetworkResourceMonitoring API + +``` +openapi: 3.0.0 +info: + title: SS_NetworkResourceMonitoring + description: | + API for SEAL Network Resource Monitoring. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.1.0-alpha.2" +externalDocs: + description: > + 3GPP TS 29.549 V18.1.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ +security: + - {} + - oAuth2ClientCredentials: [] +servers: + - url: '{apiRoot}/ss-nrm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 +paths: + /subscriptions: + post: + summary: Create individual unicast monitoring subscription resource or obtain unicast QoS +monitoring data for VAL UEs, VAL Group, or VAL Streams. + operationId: SubscribeUnicastMonitoring + tags: + - Unicast Monitoring Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + responses: + '201': + description: > + The requested individual monitoring subscription resource is successfully created + and a representation of the created resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + headers: + Location: + description: Contains the URI of the newly created individual monitoring resource. + required: true + schema: + type: string + '200': + description: The requested unicast QoS monitoring data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringReport' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +``` + +``` + + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + NotifyUnicastMonitoringData: + '{ $request.body#/notifUri }': + post: + summary: Notify on updates of the individual monitoring resource according to the requested reporting settings. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringReport' + responses: + '204': + description: The notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + /subscriptions/{subscriptionId}: + delete: + summary: Remove an existing individual unicast monitoring subscription resource according to the subscriptionId. + operationId: UnsubscribeUnicastMonitoring + tags: + - Individual Unicast Monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of an individual unicast monitoring subscription resource. + required: true + schema: + type: string + responses: + '204': + description: > + The Individual Unicast Monitoring Subscription resource matching the subscriptionId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '429': + +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +get: + summary: Read an existing individual unicast monitoring subscription resource according to the +subscriptionId. + operationId: ReadUnicastMonitoringSubscription + tags: + - Individual Unicast Monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of an individual unicast monitoring subscription resource. + required: true + schema: + type: string + responses: + '200': + description: The requested individual unicast monitoring subscription returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: > + Update an individual unicast monitoring subscription identified by the subscriptionId. + operationId: UpdateUnicastMonitoring + tags: + - Individual Unicast Monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of an individual unicast monitoring subscription resource. + required: true + schema: + type: string + requestBody: + description: Updated details of the unicast QoS monitoring subscription. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + responses: + '200': + description: > + The subscription is updated successfully, and the updated subscription + information returned in the response. + content: +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: > + Modify an individual unicast monitoring subscription identified + by the subscriptionId. + operationId: ModifyUnicastMonitoring + tags: + - Individual Unicast Monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: > + Represents the identifier of an individual unicast monitoring subscription resource. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/MonitoringSubscriptionPatch' + responses: + '200': + description: > + Individual individual unicast QoS monitoring subscription resource is modified + successfully and representation of the modified individual unicast QoS monitoring + subscription resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MonitoringSubscription' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': +``` + +``` + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + MonitoringReport: + description: Indicates the monitoring information for VAL UEs list, VAL Group, or VAL Stream. + type: object + properties: + valUeIds: + type: array + minItems: 1 + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + description: List of VAL UEs whose QoS monitoring data is requested. + valGroupId: + type: string + description: The VAL Group Id which QoS monitoring data is requested. + valStreamIds: + type: array + minItems: 1 + items: + type: string + description: List of VAL streams for which QoS monitoring data is requested. + measData: + $ref: '#/components/schemas/MeasurementData' + failureRep: + type: array + items: + $ref: '#/components/schemas/FailureReport' + description: > + The failure report indicating the VAL UE(s) or VAL Stream ID(s) whose measurement + data is not obtained successfully. + timestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - measData + - timestamp + oneOf: + - required: [valUeIds] + - required: [valGroupId] + - required: [valStreamIds] + +MeasurementData: + description: Presents the aggregated measurement data. + type: object + properties: + dlDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ulDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + rtDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avgPlr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + avgDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxDataRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + avrDlTrafficVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avrUlTrafficVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +``` + +``` +anyOf: + - required: [dlDelay] + - required: [ulDelay] + - required: [rtDelay] + - required: [avgPlr] + - required: [avgDataRate] + - required: [maxDataRate] + - required: [avrDlTrafficVol] + - required: [avrUlTrafficVol] + +MeasurementPeriod: + description: > + Indicates the measurement time period. + type: object + properties: + measStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + measDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - measStartTime + - measDuration + +ReportingRequirements: + description: Indicates the requested frequency of reporting. + type: object + properties: + reportingMode: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/NotificationMethod' + reportingPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + reportingThrs: + type: array + items: + $ref: '#/components/schemas/ReportingThreshold' + minItems: 1 + immRep: + type: boolean + repTerminMode: + $ref: '#/components/schemas/TerminationMode' + expirationTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + maxNumRep: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + termThr: + $ref: '#/components/schemas/MeasurementData' + termThrMode: + $ref: '#/components/schemas/ThresholdHandlingMode' + required: + - reportingMode + +FailureReport: + description: > + Represents the failure report indicating the VAL UE(s) or VAL Stream ID(s) + for which the NRM server failed to obtain the requested data. + type: object + properties: + valUeIds: + type: array + minItems: 1 + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + description: > + List of VAL UE(s) whose measurement data is not obtained successfully. + valStreamIds: + type: array + minItems: 1 + items: + type: string + description: > + List of VAL stream ID(s) whose measurement data is not obtained successfully. + failureReason: + $ref: '#/components/schemas/FailureReason' + measDataType: + $ref: '#/components/schemas/MeasurementDataType' + required: + - measDataType +``` + +``` +MeasurementRequirements: + description: Indicates the measurement requirements. + type: object + properties: + measDataTypes: + type: array + items: + $ref: '#/components/schemas/MeasurementDataType' + minItems: 1 + description: Indicates the required the QoS measurement data types. + measAggrGranWnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + measPeriod: + $ref: '#/components/schemas/MeasurementPeriod' + required: + - measDataTypes + +MonitoringSubscription: + description: The unicast monitoring subscription request. + type: object + properties: + valUeIds: + description: List of VAL UEs whose QoS monitoring data is requested. + type: array + minItems: 1 + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + valGroupId: + type: string + description: The VAL Group Id which QoS monitoring data is requested. + valStreamIds: + type: array + minItems: 1 + items: + type: string + description: List of VAL streams for which QoS monitoring data is requested. + measReqs: + $ref: '#/components/schemas/MeasurementRequirements' + monRep: + $ref: '#/components/schemas/MonitoringReport' + reportReqs: + $ref: '#/components/schemas/ReportingRequirements' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqTestNotif: + type: boolean + wsNotifCfg: + $ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + oneOf: + - required: [valUeIds] + - required: [valGroupId] + - required: [valStreamIds] + +ReportingThreshold: + description: > + Indicates the requested reporting termination threshold for the measurement index(es). + type: object + properties: + measThrValues: + $ref: '#/components/schemas/MeasurementData' + thrDirection: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MatchingDirection' + required: + - measThrValues + - thrDirection + +MonitoringSubscriptionPatch: + description: Represents the monitoring subscription modification request. + type: object + properties: + measReqs: + $ref: '#/components/schemas/MeasurementRequirements' + reportReqs: + $ref: '#/components/schemas/ReportingRequirements' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +``` + +## # Simple data types and Enumerations + +## MeasurementDataType: + +anyOf: + +- type: string +enum: + - DL\_DELAY + - UL\_DELAY + - RT\_DELAY + - AVG\_PLR + - AVG\_DATA\_RATE + - MAX\_DATA\_RATE + - AVG\_DL\_TRAFFIC\_VOLUME + - AVG\_UL\_TRAFFIC\_VOLUME +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Indicates the requested measurement data type. +Possible values are: + +- DL\_DELAY: Downlink packet delay. +- UL\_DELAY: Uplink packet delay. +- RT\_DELAY: Round trip packet delay. +- AVG\_PLR: Average packet loss rate. +- AVG\_DATA\_RATE: Average data rate. +- MAX\_DATA\_RATE: Maximum data rate. +- AVG\_DL\_TRAFFIC\_VOLUME: Average downlink traffic volume. +- AVG\_UL\_TRAFFIC\_VOLUME: Average uplink traffic volume. + +## TerminationMode: + +anyOf: + +- type: string +enum: + - TIME\_TRIGGERED + - EVENT\_TRIGGERED\_NUM\_REPORTS\_REACHED + - EVENT\_TRIGGERED\_MEAS\_THR\_REACHED + - USER\_TRIGGERED +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Indicates the termination mode. +Possible values are: + +- TIME\_TRIGGERED: Time-triggered termination mode. +- EVENT\_TRIGGERED\_NUM\_REPORTS\_REACHED: Event-triggered termination number of reports reached mode. +- EVENT\_TRIGGERED\_MEAS\_THR\_REACHED: The event-triggered termination measurement index threshold reached mode. +- USER\_TRIGGERED: User-triggered termination mode. + +## FailureReason: + +anyOf: + +- type: string +enum: + - USER\_NOT\_FOUND + - STREAM\_NOT\_FOUND + - DATA\_NOT\_AVAILABLE + - OTHER\_REASON +- type: string +description: > +This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API. + +description: | +Represents the failure reason. +Possible values are: + +- USER\_NOT\_FOUND: The user is not found. +- STREAM\_NOT\_FOUND: The stream is not found. +- DATA\_NOT\_AVAILABLE: The requested data is not available. +- OTHER\_REASON: Other reason (unspecified). + +## ThresholdHandlingMode: + +anyOf: + +- type: string + +``` + +enum: + - ALL_REACHED + - ANY_REACHED +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. +description: | + Indicates the multi-parameter threshold handling mode. + Possible values are: + - ALL_REACHED: The decision criterion is met when all the provided thresholds are reached. + - ANY_REACHED: The decision criterion is met when any of the provided threshold(s) + is reached. + +``` + +## A.11 SS\_VALServiceData API + +openapi: 3.0.0 + +``` + +info: + title: SS_VALServiceData + description: | + API for VAL Service Data. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.0.0-alpha.1" + +externalDocs: + description: > + 3GPP TS 29.549 V18.2.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-vsd/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /val-servdata: + get: + summary: Retrieve the VAL service data. + operationId: RetrieveValServiceData + tags: + - VAL Service Data Sets + parameters: + - name: val-tgt-ues + in: query + description: Identifying the list of the target VAL UE(s) or VAL user(s). + required: false + schema: + type: array + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + - name: val-service-ids + in: query + description: Identifying the list of the target VAL service(s). + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feats + in: query + description: To filter irrelevant responses related to unsupported features. + required: false + schema: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Represents the requested VAL service data. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServDataResp' + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + + components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + + schemas: + ValServDataResp: + description: Represents the container for the requested VAL service data. + type: object + properties: + valServData: + type: array + items: + $ref: '#/components/schemas/ValServiceData' + minItems: 1 + suppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ValServiceData: + description: > + Represents the VAL service data associated with VAL user ID(s)/VAL UE ID(s) + and/or VAL service ID(s). + type: object + properties: + valTgtUe: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + valServIds: + type: array + items: + type: string + minItems: 1 + description: > + List of the VAL services associated with the VAL user or a VAL UE defined + in the "valTgtUe" attribute. + valServSpecInfo: + type: string + description: Contains the VAL service specific information. + required: + - valTgtUe + - valServIds +``` + +## A.12 SS\_VALServiceAreaConfiguration API + +``` +openapi: 3.0.0 + +info: + title: SS_VALServiceAreaConfiguration + description: | + API for SEAL VAL Service Area Configuration Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.0.0-alpha.2" + +externalDocs: + description: > + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-vsac/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /areas: + get: + summary: Obtain the VAL service area(s) according to the provided filtering criteria. + operationId: ObtainValServiceAreas + tags: + - VAL Service Areas (Collection) + parameters: + - name: val-svc-area-ids + in: query + description: Represents the requested VAL service areas. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feats + in: query + description: To filter irrelevant responses related to unsupported features. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The requested VAL service areas information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaData' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +``` + +``` +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/areas/configure: + post: + summary: Configure VAL service area(s). + operationId: ConfigureValServiceAreas + tags: + - Configure + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaReq' + responses: + '200': + description: > + Successful case. The identifier(s) of the configured VAL service area(s) information are + Returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaResp' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/areas/update: + post: + summary: Update existing VAL service area(s). + operationId: UpdateValServiceAreas + tags: + - Update + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaReq' + responses: + '200': + description: > + Successful case. The identifier(s) of the updated VAL service area(s) information are + returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaResp' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +``` + +``` + + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/areas/delete: + post: + summary: Delete existing VAL service area(s). + operationId: DeleteValServiceAreas + tags: + - Delete + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaReq' + responses: + '200': + description: > + Successful case. The identifier(s) of the deleted VAL service area(s) information are + returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaResp' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscriptions: + post: + summary: Create individual VAL service area change event(s) subscription. + operationId: SubscribeChangeEvents + tags: + - VAL Service Area Change Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + responses: + '201': + description: > + The requested individual VAL service area change event(s) subscription + resource is successfully created and a representation of the created + resource is returned in the response body. + content: + +``` + +``` + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + callbacks: + NotifyValServiceAreaChange: + '{$request.body#/notifUri}': + post: + summary: Notify on changes of the VAL service area(s) according to the requested +reporting settings. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaNotif' + responses: + '204': + description: The notification is successfully received. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/subscription/{subscriptionId}: + parameters: + - name: subscriptionId + in: path + description: > +``` + +``` + Represents the identifier of an individual VAL service area change event(s) + subscription resource. + required: true + schema: + type: string + +get: + summary: Read an existing individual unicast monitoring subscription resource according to the + subscriptionId. + operationId: ReadValServiceAreaChange + tags: + - Individual VAL Service Area Change Subscription (Document) + responses: + '200': + description: > + The requested individual VAL service area change event(s) subscription is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + summary: Update individual VAL service area change event(s) subscription. + operationId: UpdateIndValServAreaChangeSubsc + tags: + - Individual VAL Service Area Change Subscription (Document) + requestBody: + description: Updated details of the unicast VAL service area change event(s) subscription. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + responses: + '200': + description: > + The subscription is updated successfully, and the updated subscription + information returned in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '204': + description: No Content. The subscription is updated successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +``` + +``` +'411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' +'413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' +'415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify the individual VAL service area change event(s) subscription. + operationId: ModifyIndValServAreaChangeSubsc + tags: + - Individual VAL Service Area Change Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubscPatch' + responses: + '200': + description: > + The individual VAL service area change event(s) subscription is + modified successfully, and the representation of the modified resource + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ValServiceAreaSubsc' + '204': + description: No Content. The subscription is modified successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + summary: Remove the existing individual VAL service area change event(s) subscription resource + according to the subscriptionId. + operationId: UnsubscribeValServiceAreaChange + tags: + - Individual VAL Service Area Change Subscription (Document) + responses: + '204': + description: > + The individual VAL service area change event(s) subscription resource + matching the subscriptionId is deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +``` + +``` +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + ValServiceArea: + description: Represents the VAL service area. + type: object + properties: + valSvcAreaId: + $ref: '#/components/schemas/ValSvcAreaId' + locations: + description: Represents the locations associated with the VAL service area. + minItems: 1 + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + required: + - valSvcAreaId + - locations + + ValServiceAreaReq: + description: Represents the VAL service area configuration/update/delete request. + type: object + properties: + valSvcAreas: + description: Represents the VAL service area(s). + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceArea' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valSvcAreas + + ValServiceAreaData: + description: Represents the VAL service area retrieval information. + type: object + properties: + valSvcAreas: + description: Represents the requested VAL service area(s). + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceArea' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ValServiceAreaResp: + description: Represents the VAL service area configuration/update/delete response. + type: object + properties: + valSvcAreaIds: + description: Represents the identifier(s) of the successfully handled VAL service area(s). + minItems: 1 + items: +``` + +``` + + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valSvcAreaIds + +ValServiceAreaSubscPatch: + description: Represents the VAL service area change event(s) modification request. + type: object + properties: + events: + type: array + description: Represents the subscribed VAL service area change event(s). + items: + $ref: '#/components/schemas/ValServiceAreaEventType' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subscDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +ValSvcAreaId: + type: string + description: > + Represents the VAL Service Area identifier encoded as a string and generated + either based on VAL Server ID or using the Universally Unique Identifier (UUID) + version 4 as described in IETF RFC 4122. + +ValServiceAreaSubsc: + description: Represents the VAL service area change event(s) subscription. + type: object + properties: + events: + description: Represents the subscribed VAL service area change event(s). + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceAreaEventType' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + subscDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - notifUri + +ValServiceAreaEventType: + description: Represents the VAL service area change event type. + type: object + properties: + event: + $ref: '#/components/schemas/ValServiceAreaEvent' + valSvcAreaIds: + description: Represents the VAL service area ID(s) associated with the event. + minItems: 1 + items: + type: string + required: + - event + - valSvcAreaIds + +ValServiceAreaNotif: + description: Represents the VAL service area change event(s) notification. + type: object + properties: + valSvcAreaConts: + description: Represents the VAL service area change event(s) content. + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceAreaEventInfo' + required: + - valSvcAreaConts + +ValServiceAreaEventInfo: + description: Represents the VAL service area change event(s) content. + type: object + properties: + +``` + +``` +event: + $ref: '#/components/schemas/ValServiceAreaEvent' +valSvcAreas: + description: Represents the VAL service area(s) associated with the event. + minItems: 1 + items: + $ref: '#/components/schemas/ValServiceArea' +valSvcAreaIds: + description: Represents the VAL service area(s) associated with the event. + minItems: 1 + items: + type: string +required: +- event +``` + +#### # Simple data types and Enumerations + +``` +ValServiceAreaEvent: +anyOf: +- type: string + enum: + - UPDATE + - DELETE +- type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration and is not used to encode + content defined in the present version of this API. +description: | + Represents the VAL service area change event. + Possible values are: + - UPDATE: Indicates that the VAL service area change event is VAL service area update. + - DELETE: Indicates that the VAL service area change event is VAL service area delete. +``` + +## A.13 SS\_IdmParameterProvisioning API + +``` +openapi: 3.0.0 + +info: + title: SS_IdmParameterProvisioning + description: | + API for SEAL Identity management. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + version: "1.0.0-alpha.1" + +externalDocs: + description: > + 3GPP TS 29.549 V18.4.0 Service Enabler Architecture Layer for Verticals (SEAL); + Application Programming Interface (API) specification; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/ + +security: + - {} + - oAuth2ClientCredentials: [] + +servers: + - url: '{apiRoot}/ss-ipp/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549 + +paths: + /configurations: + post: + description: Provisions VAL Services configuration information. + operationId: CreateValServiceConf + tags: + - VAL Services Configurations (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + responses: + '201': + description: VAL services configuration created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + headers: + Location: + description: Contains the URI of the newly created resource. + required: true + schema: + type: string + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +``` + +``` + + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +get: + description: Retrieves VAL services configuration satisfying filter criteria + operationId: RetrieveValServiceConf + tags: + - VAL Services Configurations (Collection) + parameters: + - name: val-server-id + in: query + description: String identifying the VAL server. + required: false + schema: + type: string + - name: config-ids + in: query + description: Identifying the list of the val services configuration resources. + required: false + schema: + type: array + items: + type: string + minItems: 1 + responses: + '200': + description: List of VAL services configurations matching the query parameters in the +request. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/VALServicesConfig' + minItems: 0 + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +/configurations/{confId}: +get: + description: Retrieves Individual VAL services configuration information. + operationId: RetrieveIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL services configuration resource. + required: true + schema: + type: string + responses: + '200': + description: The whole Individual VAL services configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + +``` + +``` +'307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' +'308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' +'400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'406': + $ref: 'TS29122_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +put: + description: Updates an individual VAL services configuration resource. + operationId: UpdateIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL services configuration resource + required: true + schema: + type: string + requestBody: + description: VAL services configuration to be updated in IM server. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + responses: + '200': + description: VAL services configuration updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + '204': + description: No Content + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' +``` + +``` +patch: + description: Modify an existing VAL services configuration. + operationId: ModifyIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: Identifier of an individual VAL services configuration resource. + required: true + schema: + type: string + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/VALServicesConfigPatch' + responses: + '200': + description: > + The individual VAL services configuration resource is modified successfully and a + representation of the updated VAL services configuration resource is returned in + the request body. + content: + application/json: + schema: + $ref: '#/components/schemas/VALServicesConfig' + '204': + description: No Content. The individual VAL services configuration is modified +successfully. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29122_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29122_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29122_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29122_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +delete: + description: Deletes a VAL Services Configuration. + operationId: DeleteIndValServicesConf + tags: + - Individual VAL Services Configuration (Document) + parameters: + - name: confId + in: path + description: String identifying an individual VAL Service Configuration resource. + required: true + schema: + type: string + responses: + '204': + description: The individual VAL services configuration matching confId was deleted. + '307': + $ref: 'TS29122_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29122_CommonData.yaml#/components/responses/308' + '400': +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/responses/400' +'401': + $ref: 'TS29122_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29122_CommonData.yaml#/components/responses/403' +'404': + $ref: 'TS29122_CommonData.yaml#/components/responses/404' +'429': + $ref: 'TS29122_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29122_CommonData.yaml#/components/responses/500' +'503': + $ref: 'TS29122_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29122_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + VALServicesConfig: + description: Represents details of the VAL services configuration information. + type: object + properties: + valServerId: + type: string + description: The Identifier of the VAL server provisioning the VAL services configuration. + valSvcConf: + type: array + description: The list of VAL service parameters provisioned. + items: + $ref: '#/components/schemas/VALServiceParams' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - valServerId + - valSvcConf + + VALServiceParams: + description: Represents details of VAL service parameters information. + type: object + properties: + valServiceId: + type: string + description: The identifier of the VAL service. + idList: + type: array + description: The list of VAL User IDs or VAL UE IDs provisioned to the VAL service. + items: + $ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe' + minItems: 1 + required: + - valServiceId + - idList + + VALServicesConfigPatch: + description: Represents details of the partial update of VAL service configuration information. + type: object + properties: + valSvcConf: + type: array + description: The list of VAL service parameters provisioned. + items: + $ref: '#/components/schemas/VALServiceParams' + minItems: 1 +``` + +--- + +## Annex B (normative): SEAL NRM server support integration with TSN + +When the SEAL Network Resource Management (NRM) server act as a TSN AF, the NRM server shall support integration with TSN including 5GS Bridge information reporting as defined in clause 14.3.8.2 of 3GPP TS 23.434 [2] and 5GS Bridge configuration as defined in clause 14.3.8.3 of 3GPP TS 23.434 [2]. + +The 5GS integration with TSN only support fully-centralized model as defined in IEEE Std 802.1Qcc-2018 [29], the NRM server acts as a TSN AF as defined in clause 14.2.2.2 of 3GPP TS 23.434 [2], shall support the TSN bridge information report as defined in clause 14.3.2.29 of 3GPP TS 23.434 [2], TSN bridge information confirmation as defined in clause 14.3.2.30 of 3GPP TS 23.434 [2], TSN bridge configuration request as defined in clause 14.3.2.31 of 3GPP TS 23.434 [2] and TSN bridge configuration response as defined in clause 14.3.2.32 of 3GPP TS 23.434 [2]. TSN CNC (as defined in IEEE 802.1Qcc [29]) via the NRM-S reference point configures the TSN flows in the 5GS. As a TSN AF, the SEAL NRM server shall interact with the 5GS PCF over the N5 reference point to configure the 5G QoS and TSCAI parameters in 5GS as defined in clause 14.2.2.24 of 3GPP TS 29.514 [30]. + +--- + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | CT3#106 | | | | | TS skeleton for Services Enabler Architecture Layer for Verticals Application Programming Interface specification. | 0.0.0 | +| 2019-10 | CT3#106 | C3-194418 | | | | Inclusion of TS skeleton document with clauses reflecting SEAL service APIs, agreed in the meeting CT3#106: C3-194418 | 0.1.0 | +| 2019-10 | CT3#106 | C3-194314 | | | | Inclusion of documents agreed in CT3#106: C3-194297, C3-194298, C3-194299, C3-194300 | 0.2.0 | +| 2019-11 | CT3#107 | C3-195307 | | | | Inclusion of documents agreed in CT3#107: C3-195157, C3-195260, C3-195441, C3-195262, C3-195263, C3-195264, C3-195185 | 0.3.0 | +| 2019-12 | CT#86 | CP-193176 | | | | Sent to plenary for Information | 1.0.0 | +| 2020-03 | CT3#108e | | | | | Inclusion of documents agreed in CT3#108-e meeting: C3-201346, C3-201347, C3-201348, C3-201349, C3-201350, C3-201456, C3-201457, C3-201351, C3-201352, C3-201271 | 1.1.0 | +| 2020-04 | CT3#109e | C3-202444 | | | | Inclusion of documents agreed in CT3#109e meeting: C3-202241, C3-202275, C3-202334, C3-202335, C3-202336, C3-202337, C3-202338, C3-202339, C3-202340, C3-202341, C3-202342, C3-202343, C3-202481 | 1.2.0 | +| 2020-06 | CT3#110e | C3-203459 | | | | Inclusion of documents agreed in CT3#110e meeting: C3-203233, C3-203317, C3-203409, C3-203411, C3-203412, C3-203413, C3-203414, C3-203415, C3-203416, C3-203417, C3-203418, C3-203419, C3-203530, C3-203587, C3-203634 | 1.3.0 | +| 2020-06 | CT#88e | CP-201209 | | | | TS sent to plenary for approval | 2.0.0 | +| 2020-06 | CT#88e | CP-201334 | | | | Implementation errors fixed. TS sent to plenary for approval | 2.0.1 | +| 2020-06 | CT#88e | CP-201334 | | | | TS approved by plenary | 16.0.0 | +| 2020-09 | CT#89e | CP-202074 | 0001 | | F | Correct apiVersion notation | 16.1.0 | +| 2020-09 | CT#89e | CP-202074 | 0002 | 1 | F | Corrections to API and Event names | 16.1.0 | +| 2020-09 | CT#89e | CP-202074 | 0003 | | F | Correct Identity filter in Events API | 16.1.0 | +| 2020-09 | CT#89e | CP-202087 | 0004 | 1 | F | SS_KeyInfoRetrieval API correction | 16.1.0 | +| 2020-09 | CT#89e | CP-202074 | 0005 | | F | Key Management API description | 16.1.0 | +| 2020-09 | CT#89e | CP-202074 | 0006 | 1 | F | UnicastSubscription attribute presence correction | 16.1.0 | +| 2020-09 | CT#89e | CP-202084 | 0009 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0010 | 1 | F | Essential corrections and alignments | 16.2.0 | +| 2020-12 | CT#90e | CP-203142 | 0011 | 1 | F | Immediate reporting | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0012 | 1 | F | Storage of YAML files in 3GPP Forge | 16.2.0 | +| 2020-12 | CT#90e | CP-203142 | 0013 | 1 | F | SEAL Group configuration corrections | 16.2.0 | +| 2020-12 | CT#90e | CP-203152 | 0014 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.2.0 | +| 2021-03 | CT#91e | CP-210221 | 0015 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0016 | 1 | F | Corrections to HTTP custom headers handling for Northbound APIs | 17.0.0 | +| 2021-03 | CT#91e | CP-210220 | 0017 | | F | OpenAPI reference | 17.0.0 | +| 2021-03 | CT#91e | CP-210240 | 0018 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2021-06 | CT#92e | CP-211238 | 0019 | 1 | F | Correction of invalid characters in OpenAPI specification files | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0022 | 1 | F | 204 No Content during modification procedure on SS_GroupManagement API | 17.1.0 | +| 2021-06 | CT#92e | CP-211241 | 0023 | 1 | F | Support redirection for SEAL APIs | 17.1.0 | +| 2021-06 | CT#92e | CP-211235 | 0025 | | A | Notification URI | 17.1.0 | +| 2021-06 | CT#92e | CP-211240 | 0026 | | F | 204 No Content for resource modification in SS_LocationReporting API | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0027 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212214 | 0028 | | F | Resource URI correction on SEAL APIs | 17.2.0 | +| 2021-09 | CT#93e | CP-212207 | 0029 | 1 | B | Support 5G CN external group information for SEAL groups | 17.2.0 | +| 2021-09 | CT#93e | CP-212207 | 0030 | 1 | B | Message filters for SEAL groups | 17.2.0 | +| 2021-09 | CT#93e | CP-212223 | 0031 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-12 | CT#94e | CP-213232 | 0032 | 1 | B | Support local MBMS | 17.3.0 | +| 2021-12 | CT#94e | CP-213232 | 0033 | 1 | B | Support Tracking UE and obtaining dynamic UE information | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0034 | 1 | B | Group Management enhancement for 5G-VN groups | 17.3.0 | +| 2021-12 | CT#94e | CP-213250 | 0035 | 4 | B | eSEAL Events Monitoring service | 17.3.0 | +| 2021-12 | CT#94e | CP-213220 | 0036 | | B | Alignment with SA3 supported TLS profiles | 17.3.0 | +| 2021-12 | CT#94e | CP-213254 | 0037 | 2 | B | Network slice capability management API for SEAL | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0038 | 1 | B | eSEAL location deviation service | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0039 | 1 | B | Introduce TSC related service operations | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0041 | 1 | B | Support Create_TSC_Stream service operation | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0042 | 1 | B | Support Delete_TSC_Stream service operation | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0045 | 2 | B | Create_TSC_Stream data model and OpenAPI | 17.3.0 | +| 2021-12 | CT#94e | CP-213231 | 0046 | | B | Delete_TSC_Stream OpenAPI definition | 17.3.0 | +| 2021-12 | CT#94e | CP-213236 | 0052 | 1 | D | Editorial corrections for tables, figures, clauses, headers and references | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0054 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-03 | CT#95e | CP-220205 | 0040 | 4 | B | Support Discover_TSC_Stream_Availability service operation | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220205 | 0043 | 4 | B | Resource structure to support TSC related service operations | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0044 | 4 | B | Discover_TSC_Stream_Availability data model and OpenAPI | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0055 | 2 | B | Obtain service operation in SS_NetworkResourceMonitoring | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0056 | 2 | B | SS_NetworkResourceMonitoring API support | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0057 | 2 | B | SS_NetworkResourceMonitoring OpenAPI implementation | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0058 | 1 | B | Support integration with TSN | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0059 | | F | Terminology replacement of NSCM with NSCE | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0060 | 1 | B | Location deviation service and Open API | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0061 | 2 | B | SS_LocationAreaMonitoring API | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0062 | | B | Location report timestamp support | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0063 | | B | Add VAL service specific information | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0065 | 1 | B | SS_NetworkResourceMonitoring API definition and Subscribe/Unsubscribe/Notify service operations | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0066 | | B | Supporting temporary group formation within a VAL system | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0067 | 1 | B | Subscription update for SS_Events API | 17.4.0 | +| 2022-03 | CT#95e | CP-220205 | 0068 | 1 | B | Clarification on location based group for SS_GroupManagement API | 17.4.0 | +| 2022-03 | CT#95e | CP-220204 | 0070 | 1 | B | Support PATCH for update of Individual SEAL Location Reporting Configuration resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220204 | 0071 | | B | Support PATCH for update of Individual VAL group document resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0072 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221140 | 0073 | 1 | F | Tags and OperationId support in the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0074 | 1 | F | Dimension of QoS parameters in the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0075 | 2 | F | Clarifications of reporting, reporting termination, and subscription termination in SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0076 | 1 | F | The "Requestor identity" attributes removal in Release 17 APIs | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0077 | 1 | F | Resolving EN for the Subscribe service operation in the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0078 | | F | The corrections of naming in the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0079 | 1 | F | NO-REF_SIBLINGS error correction | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0080 | 2 | F | SEAL-S security update for Release-17 | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0082 | 3 | F | Partial success support in the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0083 | 1 | B | Supplementary location information to verticals | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0084 | | F | Resolution of the Editor's note for Network slice capability Enablement API. | 17.5.0 | +| 2022-06 | CT#96 | CP-221140 | 0085 | 1 | F | Correction of arrays cardinality in the SS_NetworkResourceMonitoring OpenAPI file | 17.5.0 | +| 2022-06 | CT#96 | CP-221156 | 0087 | | A | SEAL-S security update | 17.5.0 | +| 2022-06 | CT#96 | CP-221148 | 0088 | 1 | F | Resource URI overview and apiVersion placeholder | 17.5.0 | +| 2022-06 | CT#96 | CP-221148 | 0089 | 1 | F | OpenAPI long descriptions | 17.5.0 | +| 2022-06 | CT#96 | CP-221156 | 0091 | | A | Correcting the ValTargetUe data type name in two occurrences | 17.5.0 | +| 2022-06 | CT#96 | CP-221260 | 0092 | 2 | F | Organizing and correcting the data model of the SS_NetworkResourceMonitoring API | 17.5.0 | +| 2022-06 | CT#96 | CP-221151 | 0093 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222108 | 0094 | 2 | F | Modification of data type for Network slice capability Enablement API | 17.6.0 | +| 2022-09 | CT#97e | CP-222181 | 0095 | 1 | F | Termination of reporting related updates | 17.6.0 | +| 2022-09 | CT#97e | CP-222118 | 0096 | 1 | F | Tags and OperationId support in the SS_Events API | 17.6.0 | +| 2022-09 | CT#97e | CP-222118 | 0097 | 1 | F | Tags and OperationId support in the SS_GroupManagement API | 17.6.0 | +| 2022-09 | CT#97e | CP-222118 | 0098 | 1 | F | Tags and OperationId support in the SS_KeyInfoRetrieval API | 17.6.0 | +| 2022-09 | CT#97e | CP-222118 | 0099 | 1 | F | Tags and OperationId support in the SS_LocationAreaInfoRetrieval API | 17.6.0 | +| 2022-09 | CT#97e | CP-222117 | 0100 | | F | Tags and OperationId support in the SS_NetworkSliceAdaptation API | 17.6.0 | +| 2022-09 | CT#97e | CP-222117 | 0101 | | F | Tags and OperationId support in the SS_UserProfileRetrieval API | 17.6.0 | +| 2022-09 | CT#97e | CP-222118 | 0102 | 1 | F | Tags and OperationId support in the SS_LocationReporting API | 17.6.0 | +| 2022-09 | CT#97e | CP-222108 | 0103 | 1 | F | Path correction in the SS_LocationAreaInfoRetrieval OpenAPI file | 17.6.0 | +| 2022-09 | CT#97e | CP-222182 | 0104 | 1 | F | "Error handling" clause: alignment with other NBI and 5GS APIs | 17.6.0 | +| 2022-09 | CT#97e | CP-222108 | 0105 | | F | Correction of the SS_NetworkResourceAdaptation API naming | 17.6.0 | +| 2022-09 | CT#97e | CP-222108 | 0106 | 1 | F | Correction in error cases in the SS_NetworkResourceMonitoring API | 17.6.0 | +| 2022-09 | CT#97e | CP-222117 | 0107 | | F | Correction of the LocationInfo data type spelling in the SS_LocationAreaInfoRetrieval API | 17.6.0 | +| 2022-09 | CT#97e | CP-222117 | 0108 | | F | Correction of the "SubscriptionId" resource URI variable name | 17.6.0 | +| 2022-09 | CT#97e | CP-222108 | 0109 | | F | Correction of the note for LocationInfoCriteria data type in SS_Events API | 17.6.0 | +| 2022-09 | CT#97e | CP-222108 | 0110 | 1 | F | Correction of the "proxRange" attribute within the ReferenceUEDetail structure in SS_Events API | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222108 | 0111 | 1 | F | Correction in the validation criteria for the Update_Trigger_Location_Reporting service operation in the SS_LocationReporting API | 17.6.0 | +| 2022-09 | CT#97e | CP-222117 | 0112 | | F | Definitions of HTTP "406 Not Acceptable" response | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0113 | | F | SS_GroupManagement API: delete operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0114 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223193 | 0119 | 1 | A | Correction of the presence and cardinality of the "suppFeat" attribute within the MulticastSubscription data structure in the SS_NetworkResourceAdaptation API | 17.7.0 | +| 2022-12 | CT#98e | CP-223185 | 0116 | 1 | F | Correction of the tables for the re-used and API-specific data structures in the SEAL APIs | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0117 | 1 | F | Correction the enumerations in the SS_NetworkResourceMonitoring API | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0118 | | F | Correction of the descriptions in the OpenAPI files of the SEAL APIs | 18.0.0 | +| 2022-12 | CT#98e | CP-223194 | 0120 | 1 | B | Update_Unicast_QoS_Monitoring service operation for the SS_NetworkResourceMonitoring API | 18.0.0 | +| 2022-12 | CT#98e | CP-223194 | 0121 | 1 | B | PATCH and PUT methods for the SS_NetworkResourceMonitoring API | 18.0.0 | +| 2022-12 | CT#98e | CP-223194 | 0122 | 1 | B | OpenAPI implementation for the Update_Unicast_QoS_Monitoring_Subscription service operation in the SS_NetworkResourceMonitoring API | 18.0.0 | +| 2022-12 | CT#98e | CP-223194 | 0123 | 1 | B | Interaction with CM server in the Create_Group service operation of the SS_GroupManagement API | 18.0.0 | +| 2022-12 | CT#98e | CP-223185 | 0124 | | F | Cardinality for data types of SS_Events API | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0127 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230157 | 0128 | 1 | B | Updates on location reporting | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0129 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0132 | 1 | F | Essential correction of the Create_Group service operation in the SS_GroupManagement API | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0134 | 1 | B | Partial failure support in the SS_Events API | 18.1.0 | +| 2023-03 | CT#99 | CP-230157 | 0137 | 1 | F | Correction of the websocket procedures in the SS_Events API | 18.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0138 | | D | Correction of the references for the WebsockNotifConfig and reqTestNotif | 18.1.0 | +| 2023-03 | CT#99 | CP-230168 | 0139 | 1 | B | VAL Service area – Location Area Monitoring | 18.1.0 | +| 2023-03 | CT#99 | CP-230168 | 0140 | 1 | B | VAL Service area – Location based group | 18.1.0 | +| 2023-03 | CT#99 | CP-230168 | 0142 | 1 | B | SS_IdmParameterProvisioning API description | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0143 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231146 | 0141 | 2 | B | SS_VALServiceAreaConfiguration service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231175 | 0144 | 2 | B | Introduce a new attribute to support location QoS | 18.2.0 | +| 2023-06 | CT#100 | CP-231185 | 0145 | | B | Definition of SEALDD related functionalities | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0146 | 1 | B | Definition of the service description part of the MBS resource management service operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0147 | 1 | B | Definition of the API resources part of the MBS resource management service operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0148 | | B | Definition of the API notifications part of the MBS resource management service operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231329 | 0149 | 4 | B | Definition of the API data model part of the MBS resource management service operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231330 | 0150 | 4 | B | Definition of the OpenAPI description part of the MBS resource management service operations | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0151 | 1 | F | Correction of the error handling in the SS_GroupManagement API | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0152 | 1 | B | Definition of the SS_VALServiceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0153 | 1 | B | Implementation of the SS_VALServiceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0154 | 1 | B | OpenAPI file for the SS_VALServiceData API | 18.2.0 | +| 2023-06 | CT#100 | CP-231139 | 0156 | 1 | F | Support of Network slice capability management | 18.2.0 | +| 2023-06 | CT#100 | CP-231203 | 0157 | 2 | B | VAL service area support in the SS_LocationReporting API | 18.2.0 | +| 2023-06 | CT#100 | CP-231188 | 0158 | 1 | B | Support of ADAES | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0159 | 1 | B | SS_VALServiceAreaConfiguration service API implementation | 18.2.0 | +| 2023-06 | CT#100 | CP-231204 | 0160 | 2 | B | SS_VALServiceAreaConfiguration service API implementation of the OpenAPI file | 18.2.0 | +| 2023-06 | CT#100 | CP-231175 | 0161 | 1 | B | Improvement of the Subscribe_Location_Monitoring service operation in the SS_LocationMonitoring API | 18.2.0 | +| 2023-06 | CT#100 | CP-231146 | 0162 | 1 | B | SS_IdmParameterProvisioning API service description and data model | 18.2.0 | +| 2023-06 | CT#100 | CP-231175 | 0163 | 1 | B | Support of obtaining location information from a 3rd party LMS | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0164 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232100 | 0165 | 1 | B | Defining the Activate_MBS_Resource service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232100 | 0166 | 1 | B | Defining the Deactivate_MBS_Resource service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232125 | 0167 | | F | Complete the list of SEAL service APIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232116 | 0169 | 1 | A | Corrections of the attribute name and missed clause | 18.3.0 | +| 2023-09 | CT#101 | CP-232100 | 0171 | 1 | B | Improvement of the Create_TSC_Stream service operation for the time synchronization capabilities | 18.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232100 | 0172 | 1 | F | IDM Parameter provisioning correction | 18.3.0 | +| 2023-09 | CT#101 | CP-232100 | 0173 | 1 | B | LocationAreaInfoRetrieval - VAL service area identifier | 18.3.0 | +| 2023-09 | CT#101 | CP-232100 | 0174 | 1 | B | SS_LocationMonitoring - VAL service area identifier | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0175 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233231 | 0176 | | F | Further progressing the definition of MBS resources management | 18.4.0 | +| 2023-12 | CT#102 | CP-233205 | 0177 | 3 | B | Subscribe/Notify service operation implementation in the SS_VALServiceAreaConfiguration API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0178 | 1 | B | Subscribe/Notify service operation OpenAPI implementation in the SS_VALServiceAreaConfiguration API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0179 | 1 | B | Subscribe/Notify service operation procedures in the SS_VALServiceAreaConfiguration API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0180 | 1 | B | Triggering criteria in the SS_LocationReporting API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0181 | 1 | B | Improvement of the Delete_TSC_Stream service operation for the time synchronization capabilities | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0182 | 1 | B | VAL service area feature name update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0184 | 1 | B | VAL application performance API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0186 | 1 | B | Slice-specific application performance API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0187 | 1 | B | UE-to-UE session performance API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0188 | 1 | B | Location accuracy API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0189 | 1 | B | Service API API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0190 | 1 | B | Slice Usage Pattern API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0191 | 1 | B | Edge Load API | 18.4.0 | +| 2023-12 | CT#102 | CP-233259 | 0192 | 1 | B | Updates to the MBS resources related service descriptions | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0194 | | B | BDT_Configuration_request API support with description update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0196 | 1 | B | BDT_Configuration_request API support with resources and data model update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0197 | 1 | B | BDT_Negotiation_notification support with description update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0198 | 1 | B | BDT_Negotiation_Notification support with Notification message and data model update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0199 | 1 | B | BDT_Configuration_request API support with open API update | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0200 | 1 | B | Rename the feature name for 5GFLS and remove ENs | 18.4.0 | +| 2023-12 | CT#102 | CP-233285 | 0201 | 1 | F | EN resolution for the VAL service area location representation | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0202 | 1 | F | EN resolution for the VAL service area ID representation | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0203 | 1 | B | Update subscription service operation implementation in the SS_VALServiceAreaConfiguration API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0205 | 1 | B | Update subscription service operation implementation in the SS_VALServiceAreaConfiguration OpenAPI file | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0206 | 1 | B | Update subscription service operation in the SS_VALServiceAreaConfiguration API | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0207 | 1 | B | Notification service operation in the SS_LocationReporting API | 18.4.0 | +| 2023-12 | CT#102 | CP-233138 | 0208 | 2 | B | SS_IdmParameterProvisioning API Other CRUD operations | 18.4.0 | +| 2023-12 | CT#102 | CP-233243 | 0209 | 1 | B | Further progressing the definition of MBS resources management | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0210 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29571/raw.md b/gsma/29_series/29571/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..5bffea184d40165731489e6835e331ff0dde6161 --- /dev/null +++ b/gsma/29_series/29571/raw.md @@ -0,0 +1,11161 @@ + + +# 3GPP TS 29.571 V18.4.0 (2023-12) + +*Technical Specification* + +**3rd Generation Partnership Project; +Technical Specification Group Core Network and Terminals; +5G System; Common Data Types for Service Based Interfaces; +Stage 3 +(Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller black text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'P' has a red signal wave icon at its base. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps, black font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +# **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|---------------------------------------------------------------------------|----| +| Foreword..... | 9 | +| 1 Scope..... | 10 | +| 2 References..... | 10 | +| 3 Definitions and abbreviations..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Abbreviations..... | 12 | +| 4 Overview..... | 13 | +| 5 Common Data Types..... | 13 | +| 5.1 Introduction..... | 13 | +| 5.2 Data Types for Generic Usage..... | 13 | +| 5.2.1 Introduction..... | 13 | +| 5.2.1A Re-used Data Types..... | 13 | +| 5.2.2 Simple Data Types..... | 14 | +| 5.2.3 Enumerations..... | 19 | +| 5.2.3.1 Enumeration: PatchOperation..... | 19 | +| 5.2.3.2 Enumeration: UriScheme..... | 19 | +| 5.2.3.3 Enumeration: ChangeType..... | 20 | +| 5.2.3.4 Enumeration: HttpMethod..... | 23 | +| 5.2.3.5 Enumeration: NullValue..... | 23 | +| 5.2.3.6 Enumeration: MatchingOperator..... | 23 | +| 5.2.4 Structured Data Types..... | 24 | +| 5.2.4.1 Type: ProblemDetails..... | 24 | +| 5.2.4.2 Type: Link..... | 25 | +| 5.2.4.3 Type: PatchItem..... | 25 | +| 5.2.4.4 Type: LinksValueSchema..... | 25 | +| 5.2.4.5 Type: SelfLink..... | 25 | +| 5.2.4.6 Type: InvalidParam..... | 26 | +| 5.2.4.7 Type: LinkRm..... | 26 | +| 5.2.4.8 Type: ChangeItem..... | 27 | +| 5.2.4.9 Type: NotifyItem..... | 27 | +| 5.2.4.10 Type: ComplexQuery..... | 28 | +| 5.2.4.11 Type: Cnf..... | 28 | +| 5.2.4.12 Type: Dnf..... | 28 | +| 5.2.4.13 Type: CnfUnit..... | 28 | +| 5.2.4.14 Type: DnfUnit..... | 28 | +| 5.2.4.15 Type: Atom..... | 29 | +| 5.2.4.16 Void..... | 29 | +| 5.2.4.17 Type: PatchResult..... | 29 | +| 5.2.4.18 Type: ReportItem..... | 29 | +| 5.2.4.19 Type: HalTemplate..... | 30 | +| 5.2.4.20 Type: Property..... | 30 | +| 5.2.4.21 Type: RedirectResponse..... | 30 | +| 5.2.4.22 Type: TunnelAddress..... | 31 | +| 5.2.4.23 Type: FqdnPatternMatchingRule..... | 31 | +| 5.2.4.24 Type: StringMatchingRule..... | 31 | +| 5.2.4.25 Type: StringMatchingCondition..... | 32 | +| 5.2.4.26 Type: Ipv4AddressRange..... | 32 | +| 5.2.4.27 Type: Ipv6AddressRange..... | 32 | +| 5.2.4.28 Type: Ipv6PrefixRange..... | 32 | +| 5.3 Data Types related to Subscription, Identification and Numbering..... | 32 | +| 5.3.1 Introduction..... | 32 | +| 5.3.2 Simple Data Types..... | 33 | +| 5.3.3 Enumerations..... | 37 | +| 5.3.3.1 Enumeration: GroupServiceId..... | 37 | +| 5.3.4 Structured Data Types..... | 38 | + +| | | | +|----------|------------------------------------------------|----| +| 5.3.4.1 | Type: Guami..... | 38 | +| 5.3.4.2 | Type: NetworkId..... | 38 | +| 5.3.4.3 | Type: GuamiRm..... | 38 | +| 5.4 | Data Types related to 5G Network..... | 38 | +| 5.4.1 | Introduction..... | 38 | +| 5.4.2 | Simple Data Types..... | 38 | +| 5.4.3 | Enumerations..... | 45 | +| 5.4.3.1 | Enumeration: AccessType..... | 45 | +| 5.4.3.2 | Enumeration: RatType..... | 45 | +| 5.4.3.3 | Enumeration: PduSessionType..... | 45 | +| 5.4.3.4 | Enumeration: UpIntegrity..... | 46 | +| 5.4.3.5 | Enumeration: UpConfidentiality..... | 46 | +| 5.4.3.6 | Enumeration: SscMode..... | 46 | +| 5.4.3.7 | Enumeration: DnaiChangeType..... | 46 | +| 5.4.3.8 | Enumeration: RestrictionType..... | 47 | +| 5.4.3.9 | Enumeration: CoreNetworkType..... | 47 | +| 5.4.3.10 | Enumeration: AccessTypeRm..... | 47 | +| 5.4.3.11 | Enumeration: RatTypeRm..... | 47 | +| 5.4.3.12 | Enumeration: PduSessionTypeRm..... | 47 | +| 5.4.3.13 | Enumeration: UpIntegrityRm..... | 47 | +| 5.4.3.14 | Enumeration: UpConfidentialityRm..... | 47 | +| 5.4.3.15 | Enumeration: SscModeRm..... | 47 | +| 5.4.3.17 | Enumeration: DnaiChangeTypeRm..... | 48 | +| 5.4.3.18 | Enumeration: RestrictionTypeRm..... | 48 | +| 5.4.3.19 | Enumeration: CoreNetworkType..... | 48 | +| 5.4.3.20 | Enumeration: PresenceState..... | 48 | +| 5.4.3.21 | Enumeration: StationaryIndication..... | 48 | +| 5.4.3.22 | Enumeration: StationaryIndicationRm..... | 48 | +| 5.4.3.23 | Enumeration: ScheduledCommunicationType..... | 48 | +| 5.4.3.24 | Enumeration: ScheduledCommunicationTypeRm..... | 48 | +| 5.4.3.25 | Enumeration: TrafficProfile..... | 49 | +| 5.4.3.26 | Enumeration: TrafficProfileRm..... | 49 | +| 5.4.3.27 | Enumeration: LcsServiceAuth..... | 49 | +| 5.4.3.28 | Enumeration: UeAuth..... | 49 | +| 5.4.3.29 | Enumeration: DIDataDeliveryStatus..... | 50 | +| 5.4.3.30 | Enumeration: DIDataDeliveryStatusRm..... | 50 | +| 5.4.3.31 | Void..... | 50 | +| 5.4.3.32 | Enumeration: AuthStatus..... | 50 | +| 5.4.3.33 | Enumeration: LineType..... | 50 | +| 5.4.3.34 | Enumeration: LineTypeRm..... | 50 | +| 5.4.3.35 | Void..... | 51 | +| 5.4.3.36 | Void..... | 51 | +| 5.4.3.37 | Enumeration: NotificationFlag..... | 51 | +| 5.4.3.38 | Enumeration: TransportProtocol..... | 51 | +| 5.4.3.39 | Enumeration: SatelliteBackhaulCategory..... | 51 | +| 5.4.3.40 | Enumeration: SatelliteBackhaulCategoryRm..... | 51 | +| 5.4.3.41 | Enumeration: BufferedNotificationsAction..... | 52 | +| 5.4.3.42 | Enumeration: SubscriptionAction..... | 52 | +| 5.4.3.43 | Enumeration: SnssaiStatus..... | 52 | +| 5.4.3.44 | Enumeration: TerminationIndication..... | 52 | +| 5.4.4 | Structured Data Types..... | 53 | +| 5.4.4.1 | Type: SubscribedDefaultQos..... | 53 | +| 5.4.4.2 | Type: Snssai..... | 53 | +| 5.4.4.3 | Type: PlmnId..... | 54 | +| 5.4.4.4 | Type: Tai..... | 54 | +| 5.4.4.5 | Type: Ecgi..... | 54 | +| 5.4.4.6 | Type: Ncgi..... | 55 | +| 5.4.4.7 | Type: UserLocation..... | 55 | +| 5.4.4.8 | Type: EutraLocation..... | 56 | +| 5.4.4.9 | Type: NrLocation..... | 57 | +| 5.4.4.10 | Type: N3gaLocation..... | 58 | + +| | | | +|----------|-------------------------------------------|----| +| 5.4.4.11 | Type: UpSecurity..... | 60 | +| 5.4.4.12 | Type: NgApCause..... | 60 | +| 5.4.4.13 | Type: BackupAmfInfo..... | 61 | +| 5.4.4.14 | Type: RefToBinaryData..... | 61 | +| 5.4.4.15 | Type: RouteToLocation..... | 61 | +| 5.4.4.16 | Type: RouteInformation..... | 61 | +| 5.4.4.17 | Type: Area..... | 62 | +| 5.4.4.18 | Type: ServiceAreaRestriction..... | 62 | +| 5.4.4.19 | Type: PlmnIdRm..... | 62 | +| 5.4.4.20 | Type: TaiRm..... | 62 | +| 5.4.4.21 | Type: EcgiRm..... | 62 | +| 5.4.4.22 | Type: NcgiRm..... | 62 | +| 5.4.4.23 | Type: EutraLocationRm..... | 62 | +| 5.4.4.24 | Type: NrLocationRm..... | 63 | +| 5.4.4.25 | Type: UpSecurityRm..... | 63 | +| 5.4.4.26 | Type: RefToBinaryDataRm..... | 63 | +| 5.4.4.27 | Type: PresenceInfo..... | 64 | +| 5.4.4.28 | Type: GlobalRanNodeId..... | 65 | +| 5.4.4.29 | Type: GnId..... | 66 | +| 5.4.4.30 | Type: PresenceInfoRm..... | 66 | +| 5.4.4.31 | Void..... | 66 | +| 5.4.4.32 | Type: AtsssCapability..... | 67 | +| 5.4.4.33 | Type: PlmnIdNid..... | 67 | +| 5.4.4.34 | Type: PlmnIdNidRm..... | 67 | +| 5.4.4.35 | Type: SmallDataRateStatus..... | 68 | +| 5.4.4.36 | Type: HfcNodeId..... | 68 | +| 5.4.4.37 | Type: HfcNodeIdRm..... | 68 | +| 5.4.4.38 | Type: WirelineArea..... | 69 | +| 5.4.4.39 | Type: WirelineServiceAreaRestriction..... | 69 | +| 5.4.4.40 | Type: ApnRateStatus..... | 70 | +| 5.4.4.41 | Type: ScheduledCommunicationTime..... | 70 | +| 5.4.4.42 | Type: ScheduledCommunicationTimeRm..... | 70 | +| 5.4.4.43 | Type: BatteryIndication..... | 71 | +| 5.4.4.44 | Type: BatteryIndicationRm..... | 71 | +| 5.4.4.45 | Type: AcsInfo..... | 71 | +| 5.4.4.46 | Type: AcsInfoRm..... | 71 | +| 5.4.4.47 | Type: NrV2xAuth..... | 71 | +| 5.4.4.48 | Type: LteV2xAuth..... | 72 | +| 5.4.4.49 | Type: Pc5QoSPara..... | 72 | +| 5.4.4.50 | Type: Pc5QosFlowItem..... | 72 | +| 5.4.4.51 | Type: Pc5FlowBitRates..... | 72 | +| 5.4.4.52 | Type: UtraLocation..... | 73 | +| 5.4.4.53 | Type: GeraLocation..... | 74 | +| 5.4.4.54 | Type: CellGlobalId..... | 74 | +| 5.4.4.55 | Type: ServiceAreaId..... | 75 | +| 5.4.4.56 | Type: LocationAreaId..... | 75 | +| 5.4.4.57 | Type: RoutingAreaId..... | 75 | +| 5.4.4.58 | Type: DddTrafficDescriptor..... | 75 | +| 5.4.4.59 | Type: MoExpDataCounter..... | 75 | +| 5.4.4.60 | Type: NssaaStatus..... | 76 | +| 5.4.4.61 | Type: NssaaStatusRm..... | 76 | +| 5.4.4.62 | Type: TnapiId..... | 76 | +| 5.4.4.63 | Type: TnapiIdRm..... | 76 | +| 5.4.4.64 | Type: TwapId..... | 77 | +| 5.4.4.65 | Type: TwapIdRm..... | 77 | +| 5.4.4.66 | Type: SnssaiExtension..... | 77 | +| 5.4.4.67 | Type: SdRange..... | 77 | +| 5.4.4.68 | Type: ProseServiceAuth..... | 78 | +| 5.4.4.69 | Type: EcsServerAddr..... | 78 | +| 5.4.4.70 | Type: EcsServerAddrRm..... | 79 | +| 5.4.4.71 | Type: IpAddr..... | 79 | + +| | | | +|----------|---------------------------------------------------------------------------------|-----| +| 5.4.4.72 | Type: SACInfo..... | 80 | +| 5.4.4.73 | Type: SACEventStatus..... | 83 | +| 5.4.4.74 | Type: SpatialValidityCond..... | 83 | +| 5.4.4.75 | Type: SpatialValidityCondRm..... | 83 | +| 5.4.4.76 | Type: ServerAddressingInfo..... | 83 | +| 5.4.4.77 | Type PcfUeCallbackInfo..... | 84 | +| 5.4.4.78 | Type PduSessionInfo..... | 84 | +| 5.4.4.79 | Type EasIpReplacementInfo..... | 84 | +| 5.4.4.80 | Type EasServerAddress..... | 84 | +| 5.4.4.81 | Type RoamingRestrictions..... | 85 | +| 5.4.4.82 | Type: GeoServiceArea..... | 85 | +| 5.4.4.83 | Type: MutingExceptionInstructions..... | 85 | +| 5.4.4.84 | Type: MutingNotificationsSettings..... | 85 | +| 5.4.4.85 | Type: VplmnOffloadingInfo..... | 86 | +| 5.4.4.86 | Type: PartiallyAllowedSnssai..... | 86 | +| 5.4.4.87 | Type: VarRepPeriod..... | 87 | +| 5.4.4.88 | Type: RangingSIPosAuth..... | 87 | +| 5.4.4.89 | Type: NrA2xAuth..... | 87 | +| 5.4.4.90 | Type: LteA2xAuth..... | 87 | +| 5.4.4.91 | Type: SliceUsageControlInfo..... | 88 | +| 5.4.4.92 | Type: CombGciAndHfcNIids..... | 88 | +| 5.4.4.93 | Type: SnssaiDnnItem..... | 88 | +| 5.4.4.94 | Type: NtnTailInfo..... | 88 | +| 5.4.5 | Data types describing alternative data types or combinations of data types..... | 89 | +| 5.4.5.1 | Type: ExtSnssai..... | 89 | +| 5.4.5.2 | Type: SnssaiReplaceInfo..... | 89 | +| 5.5 | Data Types related to 5G QoS..... | 89 | +| 5.5.1 | Introduction..... | 89 | +| 5.5.2 | Simple Data Types..... | 90 | +| 5.5.3 | Enumerations..... | 94 | +| 5.5.3.1 | Enumeration: PreemptionCapability..... | 94 | +| 5.5.3.2 | Enumeration: PreemptionVulnerability..... | 94 | +| 5.5.3.3 | Enumeration: ReflectiveQosAttribute..... | 94 | +| 5.5.3.4 | Void..... | 95 | +| 5.5.3.5 | Enumeration: NotificationControl..... | 95 | +| 5.5.3.6 | Enumeration: QosResourceType..... | 95 | +| 5.5.3.7 | Enumeration: PreemptionCapabilityRm..... | 95 | +| 5.5.3.8 | Enumeration: PreemptionVulnerabilityRm..... | 95 | +| 5.5.3.9 | Enumeration: ReflectiveQosAttributeRm..... | 95 | +| 5.5.3.10 | Enumeration: NotificationControlRm..... | 95 | +| 5.5.3.11 | Enumeration: QosResourceTypeRm..... | 96 | +| 5.5.3.12 | Enumeration: AdditionalQosFlowInfo..... | 96 | +| 5.5.3.13 | Enumeration: PartitioningCriteria..... | 96 | +| 5.5.3.14 | Enumeration: PartitioningCriteriaRm..... | 96 | +| 5.5.3.15 | Enumeration: PduSetHandlingInfo..... | 96 | +| 5.5.3.16 | Enumeration: MediaTransportProto..... | 96 | +| 5.5.3.17 | Enumeration: RtpHeaderExtType..... | 97 | +| 5.5.3.18 | Enumeration: RtpPayloadFormat..... | 97 | +| 5.5.4 | Structured Data Types..... | 97 | +| 5.5.4.1 | Type: Arp..... | 97 | +| 5.5.4.2 | Type: Ambr..... | 97 | +| 5.5.4.3 | Type: Dynamic5Qi..... | 98 | +| 5.5.4.4 | Type: NonDynamic5Qi..... | 99 | +| 5.5.4.5 | Type: ArpRm..... | 99 | +| 5.5.4.6 | Type: AmbrRm..... | 99 | +| 5.5.4.7 | Void..... | 99 | +| 5.5.4.8 | Void..... | 100 | +| 5.5.4.9 | Type: SliceMbr..... | 100 | +| 5.5.4.10 | Type: SliceMbrRm..... | 100 | +| 5.5.4.11 | Type: PduSetQosPara..... | 100 | +| 5.5.4.12 | Type: PduSetQosParaRm..... | 100 | + +| | | | +|----------|-----------------------------------------------------------|-----| +| 5.5.4.13 | Type ProtocolDescription..... | 101 | +| 5.5.4.14 | Type RtpHeaderExtInfo..... | 102 | +| 5.5.4.15 | Type RtpPayloadInfo..... | 102 | +| 5.6 | Data Types related to 5G Trace..... | 102 | +| 5.6.1 | Introduction..... | 102 | +| 5.6.2 | Simple Data Types..... | 103 | +| 5.6.3 | Enumerations..... | 103 | +| 5.6.3.1 | Enumeration: TraceDepth..... | 103 | +| 5.6.3.2 | Enumeration: TraceDepthRm..... | 103 | +| 5.6.3.3 | Enumeration: JobType..... | 104 | +| 5.6.3.4 | Enumeration: ReportTypeMdt..... | 104 | +| 5.6.3.5 | Enumeration: MeasurementLteForMdt..... | 104 | +| 5.6.3.6 | Enumeration: MeasurementNrForMdt..... | 104 | +| 5.6.3.7 | Enumeration: SensorMeasurement..... | 105 | +| 5.6.3.8 | Enumeration: ReportingTrigger..... | 105 | +| 5.6.3.9 | Enumeration: ReportIntervalMdt..... | 105 | +| 5.6.3.10 | Enumeration: ReportAmountMdt..... | 106 | +| 5.6.3.11 | Enumeration: EventForMdt..... | 106 | +| 5.6.3.12 | Enumeration: LoggingIntervalMdt..... | 106 | +| 5.6.3.13 | Enumeration: LoggingDurationMdt..... | 107 | +| 5.6.3.14 | Enumeration: PositioningMethodMdt..... | 107 | +| 5.6.3.15 | Enumeration: CollectionPeriodRmmLteMdt..... | 107 | +| 5.6.3.16 | Enumeration: MeasurementPeriodLteMdt..... | 108 | +| 5.6.3.17 | Enumeration: ReportIntervalNrMdt..... | 108 | +| 5.6.3.18 | Enumeration: LoggingIntervalNrMdt..... | 108 | +| 5.6.3.19 | Enumeration: CollectionPeriodRmmNrMdt..... | 109 | +| 5.6.3.20 | Enumeration: LoggingDurationNrMdt..... | 109 | +| 5.6.3.21 | Enumeration: QoeServiceType..... | 109 | +| 5.6.3.22 | Enumeration: AvailableRanVisibleQoeMetric..... | 110 | +| 5.6.4 | Structured Data Types..... | 111 | +| 5.6.4.1 | Type: TraceData..... | 111 | +| 5.6.4.2 | Type: MdtConfiguration..... | 114 | +| 5.6.4.3 | Type: AreaScope..... | 117 | +| 5.6.4.4 | Type: TacInfo..... | 118 | +| 5.6.4.5 | Type: MbsfnArea..... | 118 | +| 5.6.4.6 | Type: InterFreqTargetInfo..... | 118 | +| 5.6.4.7 | Type: QmcConfigInfo..... | 119 | +| 5.6.4.8 | Type: QmcAreaScope..... | 120 | +| 5.6.4.9 | Type: QoeTarget..... | 120 | +| 5.7 | Data Types related to 5G Operator Determined Barring..... | 120 | +| 5.7.1 | Introduction..... | 120 | +| 5.7.2 | Simple Data Types..... | 120 | +| 5.7.3 | Enumerations..... | 120 | +| 5.7.3.1 | Enumeration: RoamingOdb..... | 120 | +| 5.7.3.2 | Enumeration: OdbPacketServices..... | 121 | +| 5.7.4 | Structured Data Types..... | 121 | +| 5.7.4.1 | Type: OdbData..... | 121 | +| 5.8 | Data Types related to Charging..... | 121 | +| 5.8.1 | Introduction..... | 121 | +| 5.8.2 | Simple Data Types..... | 121 | +| 5.8.3 | Enumerations..... | 122 | +| 5.8.4 | Structured Data Types..... | 122 | +| 5.8.4.1 | Type: SecondaryRatUsageReport..... | 122 | +| 5.8.4.2 | Type: QoSFlowUsageReport..... | 123 | +| 5.8.4.3 | Type: SecondaryRatUsageInfo..... | 123 | +| 5.8.4.4 | Type: VolumeTimedReport..... | 123 | +| 5.9 | Data Types related to MBS..... | 123 | +| 5.9.1 | Introduction..... | 123 | +| 5.9.2 | Simple Data Types..... | 123 | +| 5.9.3 | Enumerations..... | 124 | +| 5.9.3.1 | Enumeration: MbsServiceType..... | 124 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------------|------------| +| 5.9.3.2 | Enumeration: MbsSessionActivityStatus..... | 124 | +| 5.9.3.3 | Enumeration: MbsSessionEventType..... | 125 | +| 5.9.3.4 | Enumeration: BroadcastDeliveryStatus..... | 125 | +| 5.9.4 | Structured Data Types..... | 125 | +| 5.9.4.1 | Type: MbsSessionId..... | 125 | +| 5.9.4.2 | Type: Tmgi..... | 125 | +| 5.9.4.3 | Type: Ssm..... | 126 | +| 5.9.4.4 | Type: MbsServiceArea..... | 126 | +| 5.9.4.5 | Type: NegiTai..... | 126 | +| 5.9.4.6 | Type: MbsSession..... | 127 | +| 5.9.4.7 | Type: MbsSessionSubscription..... | 131 | +| 5.9.4.8 | Type: MbsSessionEventReportList..... | 131 | +| 5.9.4.9 | Type: MbsSessionEvent..... | 132 | +| 5.9.4.10 | Type: MbsSessionEventReport..... | 132 | +| 5.9.4.11 | Type: ExternalMbsServiceArea..... | 132 | +| 5.9.4.12 | Type: MbsSecurityContext..... | 132 | +| 5.9.4.13 | Type: MbsKeyInfo..... | 133 | +| 5.9.4.14 | Type: IngressTunAddrInfo..... | 133 | +| 5.9.4.15 | Type: MbsServiceAreaInfo..... | 134 | +| 5.9.4.16 | Type: MbsServiceInfo..... | 134 | +| 5.9.4.17 | Type: MbsMediaComp..... | 134 | +| 5.9.4.18 | Type: MbsMediaCompRm..... | 134 | +| 5.9.4.19 | Type: MbsQoSReq..... | 135 | +| 5.9.4.20 | Type: MbsMediaInfo..... | 135 | +| 5.9.4.21 | Data types describing alternative data types or combinations of data types..... | 135 | +| 5.9.4.21.1 | Type: AssociatedSessionId..... | 135 | +| 5.10 | Data Types related to Time Synchronization..... | 135 | +| 5.10.1 | Introduction..... | 135 | +| 5.10.2 | Simple Data Types..... | 135 | +| 5.10.3 | Enumerations..... | 136 | +| 5.10.3.1 | Enumeration: SynchronizationState..... | 136 | +| 5.10.3.2 | Enumeration: TimeSource..... | 136 | +| 5.10.3.3 | Enumeration: ClockQualityDetailLevel..... | 136 | +| 5.10.4 | Structured Data Types..... | 136 | +| 5.10.4.1 | Type: ClockQualityAcceptanceCriterion..... | 136 | +| 5.10.4.2 | Type: ClockQuality..... | 137 | +| 5.11 | Data Types related to IMS SBA..... | 137 | +| 5.11.1 | Introduction..... | 137 | +| 5.11.2 | Simple Data Types..... | 137 | +| 5.11.3 | Enumerations..... | 137 | +| 5.11.3.1 | Enumeration: MediaResourceType..... | 137 | +| 5.11.3.2 | Enumeration: MediaProxy..... | 138 | +| 5.11.3.3 | Enumeration: SecuritySetup..... | 138 | +| 5.11.4 | Structured Data Types..... | 139 | +| 5.11.4.1 | Type: DcEndpoint..... | 139 | +| 5.11.4.2 | Type: DcStream..... | 140 | +| 5.11.4.3 | Type: ReplaceHttpUrl..... | 140 | +| 5.11.4.4 | Type: Endpoint..... | 141 | +| Annex A (normative): | OpenAPI specification..... | 141 | +| A.1 | General..... | 141 | +| A.2 | Data related to Common Data Types..... | 141 | +| Annex B (informative): | Change history..... | 223 | + +## Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +--- + +## 1 Scope + +The present document specifies the stage 3 protocol and data model for common data types that are used or may be expected to be used by multiple Service Based Interface APIs supported by the same or different Network Function(s). + +The Principles and Guidelines for Services Definition are specified in 3GPP TS 29.501 [2]. + +--- + +## 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [3] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [4] IETF RFC 1166: "Internet Numbers". +- [5] IETF RFC 5952: "A recommendation for IPv6 address text representation". +- [6] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [7] 3GPP TS 23.003: "Numbering, addressing and identification". +- [8] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [9] IETF RFC 9457: "Problem Details for HTTP APIs". +- [10] IETF RFC 3339: "Date and Time on the Internet: Timestamps". +- [11] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP) ". +- [12] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [13] 3GPP TS 24.007: "Mobile radio interface signalling layer 3; General aspects". +- [14] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [15] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". + +- [16] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [17] IETF RFC 7042: "IANA Considerations and IETF Protocol and Documentation Usage for IEEE 802 Parameters". +- [18] IETF RFC 6733: "Diameter Base Protocol". +- [19] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [20] 3GPP TS 24.501: "Non-Access-Stratum (NAS) Protocol for 5G System (5GS); Stage 3". +- [21] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [22] Void. +- [23] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)". +- [24] ITU-T Recommendation Q.763 (1999): "Specifications of Signalling System No.7; Formats and codes". +- [25] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [26] 3GPP TS 23.015: "Technical Realization of Operator Determined Barring". +- [27] 3GPP TR 21.900: "Technical Specification Group working methods". +- [28] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [29] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [30] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [31] IEEE Std 802.11-2012: "IEEE Standard for Information technology - Telecommunications and information exchange between systems - Local and metropolitan area networks - Specific requirements - Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications". +- [32] CableLabs WR-TR-5WWC-ARCH: "5G Wireless Wireline Converged Core Architecture". +- [33] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access; Stage 2". +- [34] BBF TR-069: "CPE WAN Management Protocol". +- [35] BBF TR-369: "User Services Platform (USP)". +- [36] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [37] BBF TR-470: "5G Wireless Wireline Convergence Architecture". +- [38] IEEE "Guidelines for Use of Extended Unique Identifier (EUI), Organizationally Unique Identifier (OUI), and Company ID (CID)", +- [39] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". +- [40] IETF RFC 5580: "Carrying Location Objects in RADIUS and Diameter". +- [41] BBF TR-456: "AGF Functional Requirements". +- [42] 3GPP TS 38.331: "NR; Radio Resource Control (RRC); Protocol specification". +- [43] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". + +- [44] ECMA-262: "ECMAScript® Language Specification", . +- [45] 3GPP TS 33.246: "Security of Multimedia Broadcast/Multicast Service (MBMS)". +- [46] 3GPP TS 33.501: "Security architecture and procedures for 5G system; Stage 2". +- [47] IETF RFC 7542: "The Network Access Identifier". +- [48] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [49] 3GPP TS 23.558: "Architecture for enabling Edge Applications (EA)". +- [50] 3GPP TS 33.503: "Security Aspects of Proximity based Services (ProSe) in the 5G System (5GS)". +- [51] IEEE Std 1588: "IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems", Edition 2019. +- [52] 3GPP TS 29.573: "5G System: Public Land Mobile Network (PLMN) Interconnection; Stage 3". +- [53] IETF RFC 8122: "Connection-Oriented Media Transport over the Transport Layer Security (TLS) Protocol in the Session Description Protocol (SDP)". +- [54] IETF RFC 8842: "Session Description Protocol (SDP) Offer/Answer Considerations for Datagram Transport Layer Security (DTLS) and Transport Layer Security (TLS)". +- [55] IETF RFC 8841: "Session Description Protocol (SDP) Offer/Answer Procedures for Stream Control Transmission Protocol (SCTP) over Datagram Transport Layer Security (DTLS) Transport". +- [56] 3GPP TS 28.405: "Telecommunication management; Quality of Experience (QoE) measurement collection; Control and configuration". +- [57] 3GPP TS 24.554: " Proximity-services (ProSe) in 5G System (5GS) protocol aspects; Stage 3". +- [58] 3GPP TS 32.255: "Charging management; 5G data connectivity domain charging; stage 2". +- [59] 3GPP TS 26.522: "5G Real-time Media Transport Protocol Configurations". +- [60] IETF RFC 8285: "A General Mechanism for RTP Header Extensions". + +--- + +## 3 Definitions and abbreviations + +### 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +### 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-----|-----------------| +| 5GC | 5G Core Network | +|-----|-----------------| + +| | | +|-------|----------------------------------------------------------| +| DNAI | Data Network Access Identifier | +| EUI | Extended Unique Identifier | +| GEO | Geosynchronous Orbit | +| GPSI | Generic Public Subscription Identifier | +| GUAMI | Globally Unique AMF Identifier | +| HFC | Hybrid Fiber Coax | +| LEO | Low Earth Orbit | +| MEO | Medium Earth Orbit | +| N5GC | Non-5G Capable | +| NSSAA | Network Slice- Specific Authentication and Authorization | +| PEI | Permanent Equipment Identifier | +| SBI | Service Based Interface | +| SUPI | Subscription Permanent Identifier | +| UAV | Uncrewed Aerial Vehicle | + +--- + +## 4 Overview + +For the different 5GC SBI API, data types shall be defined. Data types identified as common data types shall be defined in this Technical specification and should be referenced from individual 5GC SBI API specifications. + +Data types applicable or intended to be applicable to several 5GC SBI API specifications should be interpreted as common data types. + +--- + +## 5 Common Data Types + +### 5.1 Introduction + +In the following clauses, common data types for the following areas are defined: + +- Data types for generic usage; +- Data types for Subscription, Identification and Numbering; +- Data types related to 5G Network; +- Data types related to 5G QoS; +- Data types related to 5G Trace; +- Data types related to 5G ODBs. + +### 5.2 Data Types for Generic Usage + +#### 5.2.1 Introduction + +This clause defines common data types for generic usage. + +##### 5.2.1A Re-used Data Types + +This clause specifies the re-used data types from other specifications. + +**Table 5.2.1A-1: Re-used Data Types** + +| Data Type | Reference | Comments | +|------------------|---------------------|-----------------| +| NFType | 3GPP TS 29.510 [29] | | +| ServiceName | 3GPP TS 29.510 [29] | | +| DataSetId | 3GPP TS 29.510 [29] | | +| PlmnSnssai | 3GPP TS 29.510 [29] | | +| GeographicArea | 3GPP TS 29.572 [43] | | +| CivicAddress | 3GPP TS 29.572 [43] | | + +## 5.2.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.2.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Binary | string | String with format "binary" as defined in OpenAPI Specification [3] | +| BinaryRm | string | This data type is defined in the same way as the "Binary" data type, but with the OpenAPI "nullable: true" property. | +| Bytes | string | String with format "byte" as defined in OpenAPI Specification [3], i.e, base64-encoded characters, | +| BytesRm | string | This data type is defined in the same way as the "Bytes" data type, but with the OpenAPI "nullable: true" property. | +| Date | string | String with format "date" as defined in OpenAPI Specification [3] | +| DateRm | string | This data type is defined in the same way as the "Date" data type, but with the OpenAPI "nullable: true" property. | +| DateTime | string | String with format "date-time" as defined in OpenAPI Specification [3] | +| DateTimeRm | string | This data type is defined in the same way as the "DateTime" data type, but with the OpenAPI "nullable: true" property. | +| DiameterIdentity | Fqdn | String containing a Diameter Identity (FQDN), according to clause 4.3 of IETF RFC 6733 [18].
DiameterIdentity is defined as a simple data type because Fqdn is also a simple data type (string). | +| DiameterIdentityRm | FqdnRm | This data type is defined in the same way as the "DiameterIdentity" data type, but with the OpenAPI "nullable: true" property.
DiameterIdentityRm is defined as a simple data type because FqdnRm is also a simple data type (either a string or null). | +| Double | number | Number with format "double" as defined in OpenAPI Specification [3] | +| DoubleRm | number | This data type is defined in the same way as the "Double" data type, but with the OpenAPI "nullable: true" property. | +| DurationSec | integer | Unsigned integer identifying a period of time in units of seconds. | +| DurationSecRm | integer | This data type is defined in the same way as the "DurationSec" data type, but with the OpenAPI "nullable: true" property. | +| Float | number | Number with format "float" as defined in OpenAPI Specification [3] | +| FloatRm | number | This data type is defined in the same way as the "Float" data type, but with the OpenAPI "nullable: true" property. | +| Uint16 | integer | Integer where the allowed values correspond to the value range of an unsigned 16-bit integer, i.e. 0 to 65535.
Minimum = 0. Maximum = 65535. | +| Uint16Rm | integer | This data type is defined in the same way as the "Uint16" data type, but with the OpenAPI "nullable: true" property. | +| Int32 | integer | Integer with format "int32" as defined in OpenAPI Specification [3] | +| Int32Rm | integer | This data type is defined in the same way as the "Int32" data type, but with the OpenAPI "nullable: true" property. | +| Int64 | integer | Integer with format "int64" as defined in OpenAPI Specification [3] | +| Int64Rm | integer | This data type is defined in the same way as the "Int64" data type, but with the OpenAPI "nullable: true" property. | +| Ipv4Addr | string | String identifying a IPv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [4].
Pattern: '^([0-9]{1,3}[0-9]{1,3}[0-9]{1,3}[0-9]{1,3})\$' | +| Ipv4AddrRm | string | This data type is defined in the same way as the "Ipv4Addr" data type, but with the OpenAPI "nullable: true" property. | +| Ipv4AddrMask | string | String identifying a IPv4 address mask formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [4].
Pattern: '^([0-9]{1,3}[0-9]{1,3}[0-9]{1,3}[0-9]{1,3})\$' | +| Ipv4AddrMaskRm | string | This data type is defined in the same way as the "Ipv4AddrMask" data type, but with the OpenAPI "nullable: true" property. | +| Ipv6Addr | string | String identifying an IPv6 address formatted according to clause 4 of IETF RFC 5952 [5]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 [5] shall not be used.
Pattern: '^([0-9a-f]{1,4}:){3}[0-9a-f]{1,4}\$' | + +| | | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | {0,3}}):}{0,6}(:(0? ([1-9a-f][0-9a-f]{0,3})))\$'
and
Pattern: '^((([^\:]+\:){7}([^\:]+)) ((([^\:]+\:)*[^\:]+\:)?::((([^\:]+\:)*[^\:]+\:)?)))\$' | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ipv6AddrRm | string | This data type is defined in the same way as the "Ipv6Addr" data type, but with the OpenAPI "nullable: true" property. | +| Ipv6Prefix | string | String identifying an IPv6 address prefix formatted according to clause 4 of IETF RFC 5952 [5]. Ipv6Prefix data type may contain an individual /128 IPv6 address.
Pattern: '^((:(0? ([1-9a-f][0-9a-f]{0,3}))) :(0? ([1-9a-f][0-9a-f]{0,3}))) :(0,6) :(0? ([1-9a-f][0-9a-f]{0,3}))) V([0-9]{1,2})([0-9]{1,2})([0-9]{1,2})([0-9]{1,2}))\$'
and
Pattern: '^((([^-:]+:){7}([^-:]+)) ((([^-:]+:)*[^-:]+)?::([^-:]+:)*[^-:]+)?))(V.+)\$' | +| Ipv6PrefixRm | string | This data type is defined in the same way as the "Ipv6Prefix" data type, but with the OpenAPI "nullable: true" property. | +| MacAddr48 | string | String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of IETF RFC 7042 [17].
Pattern: '^([0-9a-fA-F]{2})(-[0-9a-fA-F]{2}){5}\$' | +| MacAddr48Rm | string | This data type is defined in the same way as the "MacAddr48" data type, but with the OpenAPI "nullable: true" property. | +| SupportedFeatures | string | A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500 [25].
The string shall contain a bitmask indicating supported features in hexadecimal representation:
Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported. | +| UInteger | integer | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.
Minimum = 0. | +| UIntegerRm | integer | This data type is defined in the same way as the "UInteger" data type, but with the OpenAPI "nullable: true" property. | +| Uint32 | integer | Integer where the allowed values correspond to the value range of an unsigned 32-bit integer, i.e. 0 to (2 32 )-1.
Minimum = 0. Maximum = 4294967295. | +| Uint32Rm | integer | This data type is defined in the same way as the "Uint32" data type, but with the OpenAPI "nullable: true" property. | +| Uint64 | integer | Integer where the allowed values correspond to the value range of an unsigned 64-bit integer, i.e. 0 to (2 64 )-1.
Minimum = 0. Maximum = 18446744073709551615. | +| Uint64Rm | integer | This data type is defined in the same way as the "Uint64" data type, but with the OpenAPI "nullable: true" property. | +| Uri | string | String providing an URI formatted according to IETF RFC 3986 [6].
If the URI fields intended to convey generic data (e.g., in the value part of a query parameter, or in the URI path segments) contain reserved characters, these reserved characters shall be percent-encoded as defined in clause 5.2.10.2 of 3GPP TS 29.500 [25]. | +| UriRm | string | This data type is defined in the same way as the "Uri" data type, but with the OpenAPI "nullable: true" property. | +| VarUeld | string | String represents the SUPI or GPSI.
Pattern: '^^(imsi-[0-9]{5,15} nai-\.+[msisdn-[0-9]{5,15} extid-[^@]+\@[^\@]+\+ gci-\.+[gli-\.]+\+)\$' | +| VarUeldRm | string | This data type is defined in the same way as the "VarUeld" data type, but with the OpenAPI "nullable: true" property. | +| TimeZone | string | String with format "" optionally appended by "", where:

- shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as | + +| | | | +|-------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | |

defined in clause 5.6 of IETF RFC 3339 [10];

- <daylightSavingTime> shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

Example: "-08:00+1" (for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time).

| +| TimeZoneRm | string | This data type is defined in the same way as the "TimeZone" data type, but with the OpenAPI "nullable: true" property. | +| StnSr | string | String representing the STN-SR as defined in clause 18.6 of 3GPP TS 23.003 [7]. | +| StnSrRm | string | This data type is defined in the same way as the "StnSr" data type, but with the OpenAPI "nullable: true" property. | +| CMsisdn | string | String representing the C-MSISDN as defined in clause 18.7 of 3GPP TS 23.003 [7].
Pattern: "[0-9]{5,15}\$". | +| CMsisdnRm | string | This data type is defined in the same way as the "CMsisdn" data type, but with the OpenAPI "nullable: true" property. | +| DayOfWeek | integer | Integer between and including 1 and 7 denoting a weekday. "1" shall indicate "Monday", and the subsequent weekdays shall be indicated with the next higher numbers. "7" shall indicate "Sunday". | +| TimeOfDay | string | String with format "partial-time" or "full-time" as defined in clause 5.6 of IETF RFC 3339 [10].
Examples: "20:15:00", "20:15:00-08:00" (for 8 hours behind UTC). | +| EmptyObject | object | Empty JSON object: { }
It is defined with the keyword: "additionalProperties: false". | +| Fqdn | string | Fully Qualified Domain Name

Pattern: '^[0-9A-Za-z]{1,63}(.[0-9A-Za-z]{1,63})+\$'

minLength: 4
maxLength: 253 | +| FqdnRm | string | This data type is defined in the same way as the "Fqdn" data type, but it also allows the null value. | + +**Table 5.2.2-2: Reused OpenAPI data types** + +| Type Name | Description | +|-----------|------------------------------------------------------------------------------------------------------------------------------| +| boolean | As defined in OpenAPI Specification [3] | +| integer | As defined in OpenAPI Specification [3] | +| number | As defined in OpenAPI Specification [3] | +| string | As defined in OpenAPI Specification [3] | +| object | As defined in OpenAPI Specification [3] | +| array | As defined in OpenAPI Specification [3] | +| NOTE | Data types defined in OpenAPI Specification [3] do not follow the UpperCamel convention for data types in 3GPP TS 29.501 [2] | + +**Table 5.2.2-3: Meaning of a Hexadecimal Character in SupportedFeatures Type** + +| Character | Feature n+3 supported | Feature n+2 supported | Feature n+1 supported | Feature n supported | +|-----------|-----------------------|-----------------------|-----------------------|---------------------| +| "0" | no | no | no | no | +| "1" | no | no | no | yes | +| "2" | no | no | yes | no | +| "3" | no | no | yes | yes | +| "4" | no | yes | no | no | +| "5" | no | yes | no | yes | +| "6" | no | yes | yes | no | +| "7" | no | yes | yes | yes | +| "8" | yes | no | no | no | +| "9" | yes | no | no | yes | +| "A" | yes | no | yes | no | +| "B" | yes | no | yes | yes | +| "C" | yes | yes | no | no | +| "D" | yes | yes | no | yes | +| "E" | yes | yes | yes | no | +| "F" | yes | yes | yes | yes | + +NOTE 1 "n" shall be $i \cdot 4 + 1$ , where "i" is zero or a natural number, i.e. permissible values of "n" are 1, 5, 9, ... + +NOTE 2 In this table if a feature is not defined, it shall also be indicated with value "no". + +For example, if only the first feature defined in the feature list is set to 1, the corresponding SupportedFeatures attribute would have a hexadecimal character value of "1", or a string of hexadecimal characters with value of "001" (any amount of 0's to the left of the 1 would result into an equivalent feature list). If we have 32 features defined, and only the last feature in a feature list is set to 1, the corresponding SupportedFeatures attribute would have a string of hexadecimal characters with value of "80000000"(see the description of the SupportedFeatures encoding in Table 5.2.2-1). + +## 5.2.3 Enumerations + +### 5.2.3.1 Enumeration: PatchOperation + +**Table 5.2.3.1-1: Enumeration PatchOperation** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------| +| "add" | Add operation as defined in IETF RFC 6902 [14]. | +| "copy" | Copy operation as defined in IETF RFC 6902 [14]. | +| "move" | Move operation as defined in IETF RFC 6902 [14]. | +| "remove" | Remove operation as defined in IETF RFC 6902 [14]. | +| "replace" | Replace operation as defined in IETF RFC 6902 [14]. | +| "test" | Test operation as defined in IETF RFC 6902 [14]. | + +### 5.2.3.2 Enumeration: UriScheme + +**Table 5.2.3.2-1: Enumeration UriScheme** + +| Enumeration value | Description | +|-------------------|------------------| +| "http" | HTTP URI scheme | +| "https" | HTTPS URI scheme | + +### 5.2.3.3 Enumeration: ChangeType + +**Table 5.2.3.3-1: Enumeration ChangeType** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ADD" |

This value indicates new attribute has been added to the resource. The "ADD" operation performs one of the following functions, depending upon what the target location references:

  • -If the target location specifies an array index, a new value is inserted into the array at the specified index.
  • -If the target location specifies an object member that does not already exist, a new member is added to the object.
  • -If the target location specifies an object member that does exist, that member's value is replaced.

The operation object shall contain a "value" member whose content specifies the value to be added. For example:

{ "op": "ADD", "path": "/a/b/c", "value": [ "foo", "bar" ] }

When the operation is applied, the target location shall reference one of:

  • -The root of the target document - whereupon the specified value becomes the entire content of the target document.
  • -A member to add to an existing object - whereupon the supplied value is added to that object at the indicated location. If the member already exists, it is replaced by the specified value.
  • -An element to add to an existing array - whereupon the supplied value is added to the array at the indicated location. Any elements at or above the specified index are shifted one position to the right. The specified index shall not be greater than the number of elements in the array. If the "-" character is used to index the end of the array (see IETF RFC 6901 [12]), this has the effect of appending the value to the array.

Because this operation is designed to add to existing objects and arrays, its target location will often not exist. Although the pointer's error handling algorithm will thus be invoked, this specification defines the error handling behavior for "ADD" pointers to ignore that error and add the value as specified.

However, the object itself or an array containing it does need to exist, and it remains an error for that not to be the case. For example, an "ADD" with a target location of "/a/b" starting with this document:

{ "a": { "foo": 1 } }

is not an error, because "a" exists, and "b" will be added to its value. It is an error in this document:

{ "q": { "bar": 2 } }

because "a" does not exist.

| +| "MOVE" |

This value indicates existing attribute has been moved to a different path in the resource. The "MOVE" operation removes the value at a specified location and adds it to the target location.

The operation object shall contain a "from" member, which is a string containing a JSON Pointer value that references the location in the target document to move the value from.

The "from" location shall exist for the operation to be successful.

For example:

| + +| | | +|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| |

{ "op": "MOVE", "from": "/a/b/c", "path": "/a/b/d" }

This operation is functionally identical to a "REMOVE" operation on the "from" location, followed immediately by an "ADD" operation at the target location with the value that was just removed.

The "from" location shall not be a proper prefix of the "path" location; i.e., a location cannot be moved into one of its children.

| +| "REMOVE" |

This value indicates existing attribute has been deleted from the resource.

The "REMOVE" operation removes the value at the target location.

The target location shall exist for the operation to be successful.

For example:

{ "op": "REMOVE", "path": "/a/b/c" }

If removing an element from an array, any elements above the specified index are shifted one position to the left.

| +| "REPLACE" |

This value indicates existing attribute has been updated with new value.

The "REPLACE" operation replaces the value at the target location with a new value. The operation object shall contain a "value" member whose content specifies the replacement value.

The target location shall exist for the operation to be successful.

For example:

{ "op": "REPLACE", "path": "/a/b/c", "value": 42 }

This operation is functionally identical to a "REMOVE" operation for a value, followed immediately by an "ADD" operation at the same location with the replacement value.

| + +### 5.2.3.4 Enumeration: HttpMethod + +**Table 5.2.3.4-1: Enumeration HttpMethod** + +| Enumeration value | Description | +|-------------------|----------------------| +| "GET" | HTTP GET method. | +| "POST" | HTTP POST method. | +| "PUT" | HTTP PUT method. | +| "DELETE" | HTTP DELETE method. | +| "PATCH" | HTTP PATCH method. | +| "OPTIONS" | HTTP OPTIONS method. | +| "HEAD" | HTTP HEAD method. | +| "CONNECT" | HTTP CONNECT method. | +| "TRACE" | HTTP TRACE method. | + +### 5.2.3.5 Enumeration: NullValue + +**Table 5.2.3.5-1: Enumeration NullValue** + +| Enumeration value | Description | +|-------------------|-------------------| +| null | JSON's null value | + +### 5.2.3.6 Enumeration: MatchingOperator + +**Table 5.2.3.6-1: Enumeration MatchingOperator** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FULL_MATCH | Indicates a full match between the string against which the matching applies and the provided matching string. | | +| MATCH_ALL | Indicate a match for any string | | +| STARTS_WITH | Indicates a match when the string against which the matching applies starts with the provided matching string (e.g. the string "smartmeter-01.company.com" matches the matching string "smartmeter-"). | | +| NOT_START_WITH | Indicates a match when the string against which the matching applies does not start with the provided matching string (e.g. the string "smartmeter-01.company.com" matches the matching string "metersmart-"). | | +| ENDS_WITH | Indicates a match when the string against which the matching applies ends with the matching string (e.g. the string "somehost.company.com" matches the matching string "company.com"). | | +| NOT_END_WITH | Indicates a match when the string against which the matching applies does not end with the matching string (e.g. the string "somehost.company.com" matches the matching string "company.se"). | | +| CONTAINS | Indicates a match when the string against which the matching applies contains the matching string (e.g. the string "media.news.com" matches the matching string "media"). | | +| NOT_CONTAIN | Indicates a match when the string against which the matching applies does not contain the matching string (e.g. the string "media.news.com" matches the matching string "aidem"). | | + +## 5.2.4 Structured Data Types + +### 5.2.4.1 Type: ProblemDetails + +**Table 5.2.4.1-1: Definition of type ProblemDetails** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| type | Uri | O | 0..1 | A URI reference according to IETF RFC 3986 [6] that identifies the problem type. | +| title | string | O | 0..1 | A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem. | +| status | integer | O | 0..1 | The HTTP status code for this occurrence of the problem. | +| detail | string | O | 0..1 | A human-readable explanation specific to this occurrence of the problem. | +| instance | Uri | O | 0..1 | A URI reference that identifies the specific occurrence of the problem. | +| cause | string | C | 0..1 | A machine-readable application error cause specific to this occurrence of the problem
This IE should be present and provide application-related error information, if available. | +| invalidParams | array(InvalidParam) | O | 1..N | Description of invalid parameters, for a request rejected due to invalid parameters. | +| supportedFeatures | SupportedFeatures | C | 0..1 | Features supported by the NF Service Producer.

This IE shall be present when rejecting a request due to an unsupported query parameter, if at least one feature is defined for the corresponding service in the version of the specification that the NF Service Producer implements (see clause 5.2.9 of 3GPP TS 29.500 [25]).

When present, this IE shall indicate the features supported by the NF Service Producer; if the NF Service Producer supports no features, this IE shall be set to the character "0". | +| accessTokenError | AccessTokenErr | C | 0..1 | This IE should be present if an SCP request to get an access token was rejected by the NRF. When present, it should contain the Access Token Error content received from the NRF. | +| accessTokenRequest | AccessTokenReq | O | 0..1 | This IE may be present if an SCP request to get an access token was rejected by the NRF. When present, it shall contain the Access Token Request that was sent by the SCP. | +| nrflId | Fqdn | O | 0..1 | This IE may be present if an SCP request to get an access token was rejected by the NRF. When present, it shall contain the Identity (i.e. FQDN) of the NRF that rejected the access token request. | +| supportedApiVersions | array(string) | O | 1..N | This IE may be present if the SCP did not find NF service producers matching the MAJOR API version of the incoming service request and MAJOR API version(s) are known to be supported by NF service producers for the corresponding service. When present, it shall contain MAJOR API version(s) known to be supported by NF service producers for the corresponding service.
The API version shall be encoded as the apiVersionInUri defined in NFServiceVersion defined in 3GPP TS 29.510 [29] (e.g. "v1"). | + +NOTE 1: See IETF RFC 9457 [9] for detailed information and guidance for each attribute, and 3GPP TS 29.501 [2] for guidelines on error handling support by 5GC SBI APIs. +NOTE 2: Additional attributes may be defined per API. + +### 5.2.4.2 Type: Link + +**Table 5.2.4.2-1: Definition of type link** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------| +| href | Uri | M | 1 | It contains the URI of the linked resource. | + +### 5.2.4.3 Type PatchItem + +**Table 5.2.4.3-1: Definition of type PatchItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | PatchOperation | M | 1 | This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource. | | +| path | string | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [12]) that references a location of a resource on which the patch operation shall be performed. | | +| from | string | C | 0..1 | This IE indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.
It shall be present if the patch operation is "move" or "copy". | | +| value | Any type | C | 0..1 | This IE indicates a new value for the resource specified in the path attribute.
It shall be present if the patch operation is "add", "replace" or "test".
The data type of this attribute shall be the same as the type of the resource on which the patch operation shall be performed. The null value shall be allowed. | | + +### 5.2.4.4 Type: LinksValueSchema + +**Table 5.2.4.4-1: Definition of type LinksValueSchema as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|-------------|-------------|----------------| +| array(Link) | 1..N | Array of links | +| Link | 1 | link | + +### 5.2.4.5 Type: SelfLink + +**Table 5.2.4.5-1: Definition of type SelfLink** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------| +| self | Link | M | 1 | It contains the URI of the linked resource. | + +## 5.2.4.6 Type: InvalidParam + +**Table 5.2.4.6-1: Definition of type InvalidParam** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| param | string | M | 1 |

If the invalid parameter is an attribute in a JSON body, this IE shall contain the attribute's name and shall be encoded as a JSON Pointer.

If the invalid parameter is an HTTP header, this IE shall be formatted as the concatenation of the string "header: " plus the name of such header.

If the invalid parameter is a query parameter, this IE shall be formatted as the concatenation of the string "query: " plus the name of such query parameter.

If the invalid parameter is a variable part in the path of a resource URI, this IE shall contain the name of the variable, including the symbols "{" and "}" used in OpenAPI specification as the notation to represent variable path segments.

| +| reason | string | O | 0..1 |

A human-readable reason, e.g. "must be a positive integer".

In cases involving failed operations in a PATCH request, the reason string should identify the operation that failed using the operation's array index to assist in correlation of the invalid parameter with the failed operation, e.g. " Replacement value invalid for attribute [failed operation index: 4]".

| + +## 5.2.4.7 Type: LinkRm + +This data type is defined in the same way as the "Link" data type, but with the OpenAPI "nullable: true" property. + +## 5.2.4.8 Type ChangeItem + +**Table 5.2.4.8-1: Definition of type ChangeItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| op | ChangeType | M | 1 | This IE indicates the operation to be performed on the resource. | | +| path | string | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [12]) that references a target location within the resource on which the change has been applied.
(See Note) | | +| from | string | C | 0..1 | This IE indicates the path of the source JSON element (according to JSON Pointer syntax) being moved or copied to the location indicated by the "path" attribute.
It shall be present if the "op" attribute is of value "MOVE". | | +| origValue | Any type | O | 0..1 | This IE indicates the original value at the target location within the resource specified in the path attribute. This attribute only applies when the "op" attribute is of value "REMOVE", "REPLACE" or "MOVE"
Based on the use case, this attribute may be included. | | +| newValue | Any type | C | 0..1 | This IE indicates a new value at the target location within the resource specified in the path attribute.
It shall be present if the "op" attribute is of value "ADD", "REPLACE".
The data type of this attribute shall be the same as the type of the resource on which the change has happened.
The null value shall be allowed. | | +| NOTE: As described in IETF RFC 6901 [12], the value "" (empty JSON string) is the JSON Pointer expression to represent "the whole JSON document"; therefore, when the attribute "path" takes value "" and attribute "op" takes values "ADD" or "REMOVE", this shall be interpreted as the creation or deletion respectively of the resource to which this "ChangeItem" refers to. | | | | | | + +## 5.2.4.9 Type NotifyItem + +**Table 5.2.4.9-1: Definition of type NotifyItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| resourceId | Uri | M | 1 | This IE contains the URI of the resource which has been changed. | | +| changes | array(ChangeItem) | M | 1..N | This IE contains the changes which have been applied on the resource identified by the resourceId attribute.
See NOTE. | | +| NOTE: There may be more than one way to express a given modification of a resource's representation. E.g. removing one attribute from an object can be done by
a) a change item with op set to "REMOVE" and path pointing to the attribute to be removed, or
b) a change item with op set to "REPLACE" and path pointing to the object, and a newValue of the object i.e. without the attribute that has been removed.
It is up to sending nodes decision to select one of the available ways to express the modification and the receiving node shall support all possible ways. | | | | | | + +### 5.2.4.10 Type: ComplexQuery + +**Table 5.2.4.10-1: Definition of type ComplexQuery as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|-----------|-------------|---------------------------| +| Cnf | 1 | A conjunctive normal form | +| Dnf | 1 | A disjunctive normal form | + +The ComplexQuery data type is either a conjunctive normal form or a disjunctive normal form. The attribute names "cnfUnits" and "dnfUnits" (see clause 5.2.4.11 and clause 5.2.4.12) serve as discriminator. + +### 5.2.4.11 Type: Cnf + +**Table 5.2.4.11-1: Definition of type Cnf** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| cnfUnits | array(CnfUnit) | M | 1..N | During the processing of cnfUnits attribute, all the members in the array shall be interpreted as logically concatenated with logical "AND". | | + +### 5.2.4.12 Type: Dnf + +**Table 5.2.4.12-1: Definition of type Dnf** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnfUnits | array(DnfUnit) | M | 1..N | During the processing of dnfUnits attribute, all the members in the array shall be interpreted as logically concatenated with logical "OR". | | + +### 5.2.4.13 Type: CnfUnit + +**Table 5.2.4.13-1: Definition of type CnfUnit** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| cnfUnit | array(Atom) | M | 1..N | During the processing of cnfUnit attribute, all the members in the array shall be interpreted as logically concatenated with logical "OR". | | + +### 5.2.4.14 Type: DnfUnit + +**Table 5.2.4.14-1: Definition of type DnfUnit** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnfUnit | array(Atom) | M | 1..N | During the processing of dnfUnit attribute, all the members in the array shall be interpreted as logically concatenated with logical "AND". | | + +## 5.2.4.15 Type: Atom + +Table 5.2.4.15-1: Definition of type Atom + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| attr | string | M | 1 | This attribute contains the name of a defined query parameter. | | +| value | any type | M | 1 | This attribute contains the value of the query parameter as indicated by attr attribute. | | +| negative | boolean | O | 0..1 | This attribute indicates whether the negative condition applies for the query condition. | | + +## 5.2.4.16 Void + +## 5.2.4.17 Type: PatchResult + +Table 5.2.4.17-1: Definition of type PatchResult + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|---------------| +| report | array(ReportItem) | M | 1..N | The execution report contains an array of report items. Each report item indicates one failed modification. | | + +## 5.2.4.18 Type: ReportItem + +Table 5.2.4.18-1: Definition of type ReportItem + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| path | string | M | 1 | This attribute contains a JSON pointer value (as defined in IETF RFC 6901 [12]) that references a location of a resource to which the modification is subject. | | +| reason | string | O | 0..1 | A human-readable reason providing details on the reported modification failure.
The reason string should identify the operation that failed using the operation's array index to assist in correlation of the invalid parameter with the failed operation, e.g. "Replacement value invalid for attribute [failed operation index: 4]". | | + +## 5.2.4.19 Type: HalTemplate + +**Table 5.2.4.19-1: Definition of type HalTemplate** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| title | string | O | 0..1 | A human-readable string that can be used to identify this template. | +| method | HttpMethod | M | 1 | The HTTP method that should be applied for the corresponding link. If the value is not understood, the value shall be treated as an HTTP GET. | +| contentType | string | O | 0..1 | The media type that should be used for the corresponding request. If the attribute is missing, or contains an unrecognized value, the client should act as if the contentType is set to "application/json". | +| properties | array(Property) | O | 1..N | The properties that should be included in the body of the corresponding request. If the contentType attribute is set to "application/json", then this attribute describes the attributes of the JSON object of the body. | + +## 5.2.4.20 Type: Property + +**Table 5.2.4.20-1: Definition of type Property** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------| +| name | string | M | 1 | The name of the property. | +| required | boolean | O | 0..1 | Indicates whether the property is required:
- true: required
- false(default): not required | +| regex | string | O | 0..1 | A regular expression string to be applied to the value of the property. | +| value | string | O | 0..1 | The property value. When present, it shall be a valid JSON string. | + +## 5.2.4.21 Type: RedirectResponse + +**Table 5.2.4.21-1: Definition of type RedirectResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cause | string | C | 0..1 | A machine-readable cause string, specific to this occurrence of the redirection.
If the redirection is initiated by an SCP towards another SCP, this IE shall be present and set to "SCP_REDIRECT" (see clause 6.10.9 of 3GPP TS 29.500 [25]).
If the redirection is initiated by an SEPP towards another SEPP over an non N32 interface, this IE shall be present and set to "SEPP_REDIRECT" (see clause 6.10.9 of 3GPP TS 29.500 [25] and clause 6.1.8 of 3GPP TS 29.573 [52]). | +| targetScp | Uri | O | 0..1 | ApiRoot of the SCP towards which an HTTP request is redirected (see clause 6.10.9 of 3GPP TS 29.500 [25]). | +| targetSepp | Uri | O | 0..1 | ApiRoot of the SEPP towards which an non N32 interface HTTP request is redirected (see clause 6.10.9 of 3GPP TS 29.500 [25]) and clause 6.1.8 of 3GPP TS 29.573 [52]). | + +### 5.2.4.22 Type: TunnelAddress + +**Table 5.2.4.22-1: Definition of type TunnelAddress** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------|---------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | IPv4 address
(NOTE) | | +| Ipv6Addr | Ipv6Addr | C | 0..1 | IPv6 address
(NOTE) | | +| portNumber | Uinteger | M | 1 | UDP Port | | + +NOTE: At least one of these IEs shall be present. + +### 5.2.4.23 Type: FqdnPatternMatchingRule + +**Table 5.2.4.23-1: Definition of type FqdnPatternMatchingRule** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| regex | string | C | 0..1 | One FQDN pattern, defined as a regular expression according to the ECMA-262 dialect [44].

(NOTE) | +| stringMatchingRule | StringMatchingRule | C | 0..1 | One FQDN pattern, described as a string match rule.

(NOTE) | + +NOTE: When provisioning an FQDN pattern, the StringMatchingRule shall be preferred over regular expression and used whenever possible (i.e. if the pattern can be described by a string matching rule) to optimize the matching process and reduce the processing load, since the use of regular expressions can be more computing intensive than using string matching rule. Either the regex or the stringMatchingRule shall be present. + +EXAMPLE 1: A FQDN pattern described by a string matching rule matching all FQDNs with "smartmeter-{factoryID}.company.com" where "{factoryID}" can be any string + JSON: {"stringMatchingRule": {stringMatchingConditions:[{"matchingString": "smartmeter-","matchingOperator": "STARTS\_WITH","matchingString": ".company.com","matchingOperator": "ENDS\_WITH"]}} + +EXAMPLE 2: A FQDN pattern described by a regular expression matching all FQDNs with "smartmeter-{factoryID}.company.com" where "{factoryID}" can be any string. + JSON: {"regex": "^smartmeter-.+\.company\.com\$"} + +### 5.2.4.24 Type: StringMatchingRule + +**Table 5.2.4.24-1: Definition of type StringMatchingRule** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------| +| stringMatchingConditions | array(StringMatchingCondition) | M | 1..N | Contains a list of conditions which shall be evaluated for string matching. | + +NOTE: The conditions in the stringMatchingConditions array shall be evaluated as "and" logical relationship. + +### 5.2.4.25 Type: StringMatchingCondition + +**Table 5.2.4.25-1: Definition of type StringMatchingCondition** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| matchingString | string | C | 0..1 | This IE shall be present to identify the string against which the matching is performed except when the matchingOperator is MATCH_ALL. | +| matchingOperator | MatchingOperator | M | 1 | Identifies the matching operation. | + +### 5.2.4.26 Type: Ipv4AddressRange + +**Table 5.2.4.26-1: Definition of type IPv4AddressRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------| +| start | Ipv4Addr | M | 1 | First value identifying the start of an IPv4 address range | +| end | Ipv4Addr | M | 1 | Last value identifying the end of an IPv4 address range | + +### 5.2.4.27 Type: Ipv6AddressRange + +**Table 5.2.4.27-1: Definition of type IPv6AddressRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------| +| start | Ipv6Addr | M | 1 | First value identifying the start of an IPv6 address range | +| end | Ipv6Addr | M | 1 | Last value identifying the end of an IPv6 address range | + +### 5.2.4.28 Type: Ipv6PrefixRange + +**Table 5.2.4.29-1: Definition of type IPv6PrefixRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|-----------------------------------------------------------| +| start | Ipv6Prefix | M | 1 | First value identifying the start of an Ipv6 prefix range | +| end | Ipv6Prefix | M | 1 | Last value identifying the end of an Ipv6 prefix range | +| NOTE: | When Ipv6PrefixRange is used to identify a range of Ipv6 addresses served by certain NF (e.g. BSF), the range of Ipv6 addresses identified by the Ipv6PrefixRange shall include the entire Ipv6 addresses represented by the "start" and "end" Ipv6 prefixes. For example, if the "start" attribute is set to "240e:006a:0000:0000::/32" and the "end" attribute is set to "250e:006a:0000:0000::/32", the Ipv6PrefixRange identifies all the Ipv6 addresses from the start Ipv6 address "240e:006a:0000:0000::/32" to the end Ipv6 address "250e:006a:ffff:ffff:ffff:ffff:ffff:ffff/32". | | | | + +## 5.3 Data Types related to Subscription, Identification and Numbering + +### 5.3.1 Introduction + +This clause defines common data types related to subscription, identification and numbering information. + +## 5.3.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.3.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|-------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Dnn | string | String representing a Data Network as defined in clause 9A of 3GPP TS 23.003 [7]; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 [7] clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3"). See NOTE 2.

As specified for APNs in 3GPP TS 23.003 [7], clause 9.1, DNNs shall be handled as case-insensitive strings. | +| DnnRm | string | This data type is defined in the same way as the "Dnn" data type, but with the OpenAPI "nullable: true" property. | +| WildcardDnn | string | String representing the Wildcard DNN. It shall contain the string "*".
Pattern: '^[*]\$' | +| WildcardDnnRm | string | This data type is defined in the same way as the "WildcardDnn" data type, but with the OpenAPI "nullable: true" property. | +| Gpsi | string | String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows:
-External Identifier: "extid-", where shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 [7] that describes an External Identifier.
-MSISDN: "msisdn-", where shall be formatted according to clause 3.3 of 3GPP TS 23.003 [7] that describes an MSISDN.
Pattern: '^(msisdn-[0-9]{5,15} extid-.+@.+[.]+)\$' | +| GpsiRm | string | This data type is defined in the same way as the "Gpsi" data type, but with the OpenAPI "nullable: true" property. | +| GroupId | string | String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003 [7]. For 5G related service, the GroupServiceId shall identify the specific service for which the IMSI-Group-Id is used, as specified in clause 5.3.3.1.

Pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]{1,10})\$'. | +| GroupIdRm | string | This data type is defined in the same way as the "GroupId" data type, but with the OpenAPI "nullable: true" property. | +| ExternalGroupId | string | String identifying External Group Identifier that identifies a group made up of one or more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP TS 23.003 [7].

Pattern: "^extgroupid-[^@]+@[^@]+\$" | +| ExternalGroupIdRm | string | This data type is defined in the same way as the "ExternalGroupId" data type, but with the OpenAPI "nullable: true" property. | +| Pei | string | String representing a Permanent Equipment Identifier that may contain:
  • - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003 [7];
  • - a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS 23.316 [30].
  • - an IEEE Extended Unique Identifier (EUI-64), for UEs not supporting any 3GPP access technologies, as defined in IEEE "Guidelines for Use of Extended Unique Identifier (EUI), Organizationally Unique Identifier (OUI), and Company ID (CID)" [38].

Pattern: '^(imei-[0-9]{15} imeisv-[0-9]{16} mac((-[0-9a-fA-F]{2}){6})(-untrusted)? eui((-[0-9a-fA-F]{2}){8}) .+)\$'. See NOTE 1. | + +| | | | +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Examples:
imei-012345678901234
imeisv-0123456789012345
mac-00-00-5E-00-53-00
mac-00-00-5E-00-53-00-untrusted
eui-AC-DE-48-23-45-67-01-9F | +|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|------------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PeiRm | string | This data type is defined in the same way as the "Pei" data type, but with the OpenAPI "nullable: true" property. | +| Supi | string | String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003 [7].
It shall be formatted as follows:
  • - for an IMSI "imsi-<imsi>", where <imsi> shall be formatted according to clause 2.2 of 3GPP TS 23.003 [7] that describes an IMSI.
  • - for a network specific identifier "nai-<nai>", where <nai> shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 [7] that describes an NAI.
  • - for a GCI: "gci-<gci>", where <gci> shall be formatted according to clause 28.15.2 of 3GPP TS 23.003 [7].
  • - for a GLI: "gli-<gli>", where <gli> shall be formatted according to clause 28.16.2 of 3GPP TS 23.003 [7].
To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [2].
Pattern: '^(imsi-[0-9]{5,15} nai-.+ gci-.+ gli-.+ .)\$'
(NOTE 1). | +| SupiRm | string | This data type is defined in the same way as the "Supi" data type, but with the OpenAPI "nullable: true" property. | +| NfInstanceId | string | String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122 [15]. The hexadecimal letters should be formatted as lower-case characters by the sender, and they shall be handled as case-insensitive by the receiver.
Example:
"4ace9d34-2c69-4f99-92d5-a73a3fe8e23b"
(NOTE 3) | +| AmfId | string | String identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003 [7].
It is encoded as a string of 6 hexadecimal characters (i.e., 24 bits).
Pattern: '^[A-Fa-f0-9]{6}\$' | +| AmfRegionId | string | String identifying the AMF Region ID (8 bits), as specified in clause 2.10.1 of 3GPP TS 23.003 [7].
It is encoded as a string of 2 hexadecimal characters (i.e. 8 bits).
Pattern: '^[A-Fa-f0-9]{2}\$' | +| AmfSetId | string | String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003 [7].
It is encoded as a string of 3 hexadecimal characters where the first character is limited to values 0 to 3 (i.e. 10 bits).
Pattern: '^[0-3][A-Fa-f0-9]{2}\$' | +| RfspIndex | integer | Unsigned integer representing the "Subscriber Profile ID for RAT/Frequency Priority" as specified in 3GPP TS 36.413 [16].
Minimum = 1. Maximum = 256. | +| RfspIndexRm | integer | This data type is defined in the same way as the "RfspIndex" data type, but with the OpenAPI "nullable: true" property. | +| NfGroupId | string | Identifier of a group of NFs | +| MtcProviderInformation | string | String uniquely identifying MTC provider information. | +| CagId | string | String containing a Closed Access Group Identifier.
Pattern: '^[A-Fa-f0-9]{8}\$' | +| SupiOrSuci | string | String identifying a SUPI or a SUCI.
Pattern: '^(imsi-[0-9]{5,15} nai-.+ gli-.+ gci-.+ suci-[0-9]{3}-[0-9]{2,3}[1-7]-.+)-[0-9]{1,4}-[0-0-.* [a-fA-F1-9]-[1-9][1-9][0-9][1-0- | + +| | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | 9{2}2[0-4][0-9]{25}[0-5]-[a-fA-F0-9]{+}).+)\$" | +| Imsi | string | String identifying an IMSI
Pattern: ^[0-9]{5,15}\$ | +| ApplicationlayerId | string | String identifying an application layer ID. The format of the application layer ID parameter is same as the Application layer ID defined in clause 11.3.4 of 3GPP TS 24.554 [57]. | +| NsacSai | string | String that uniquely identifies the NSAC Service Area Identifier.
Reserved value(s):
"ENTIRE_PLMN", it indicates the NSACF serves the entire PLMN. | +| NOTE 1: The encoding of 3GPP defined identifiers (e.g. IMSI, NAI, IMEI, GCI, GLI) shall be prefixed with its corresponding prefix (e.g. 'imsi-', 'nai-', 'imei-', 'gci-', 'gli-'). | | | +| NOTE 2: Whether the Dnn data type contains just the DNN Network Identifier, or the Network Identifier plus the Operator Identifier, shall be documented in each API where this data type is used. | | | +| NOTE 3: NFs shall be able to receive a NF Instance Id in any UUID format. | | | + +### 5.3.3 Enumerations + +#### 5.3.3.1 Enumeration: GroupServiceId + +The enumeration GroupServiceId is a part of IMSI-Group-Id (see clause 19.9 of 3GPP TS 23.003 [7]) and indicates the specific service for which the IMSI-Group-Id is used. Values greater than 1000 are reserved for home operator specific use. IMSI-Group-IDs with a Group-Service-Id in this range shall not be sent outside the HPLMN unless roaming agreements allow so. + +**Table 5.3.3.1-1: Enumeration GroupServiceId** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------------| +| 1 | Group specific NAS level congestion control | +| 2 | Group specific Monitoring of Number of UEs present in a geographical area | +| 3 | Group specific for 5G LAN-type service | + +### 5.3.4 Structured Data Types + +#### 5.3.4.1 Type: Guami + +**Table 5.3.4.1-1: Definition of type Guami** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------| +| plmnId | PlmnIdNid | M | 1 | PLMN Identity and Network Identity | +| amfId | AmfId | M | 1 | AMF Identity | + +#### 5.3.4.2 Type: NetworkId + +**Table 5.3.4.2-1: Definition of type NetworkId** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------|-----------|---|-------------|---------------------| +| mcc | Mcc | C | 0..1 | Mobile Country Code | +| mnc | Mnc | C | 0..1 | Mobile Network Code | +| NOTE: At least one MNC or MCC shall be included. | | | | | + +#### 5.3.4.3 Type: GuamiRm + +This data type is defined in the same way as the "Guami" data type, but with the OpenAPI "nullable: true" property. + +### 5.4 Data Types related to 5G Network + +#### 5.4.1 Introduction + +This clause defines common data types related to 5G Network (other than related to 5G QoS). + +#### 5.4.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.4.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|-----------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ApplicationId | string | String providing an application identifier. | +| ApplicationIdRm | string | This data type is defined in the same way as the "ApplicationId" data type, but with the OpenAPI "nullable: true" property. | +| PduSessionId | integer | Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007 [13]. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network (NOTE). | +| Mcc | string | Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 [11].

Pattern: '[0-9]{3}\$' | +| MccRm | string | This data type is defined in the same way as the "Mcc" data type, but with the OpenAPI "nullable: true" property. | +| Mnc | string | Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 [11].

Pattern: '[0-9]{2,3}\$' | +| MncRm | string | This data type is defined in the same way as the "Mnc" data type, but with the OpenAPI "nullable: true" property. | +| Tac | string | 2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TAC shall appear first in the string, and the character representing the 4 least significant bit of the TAC shall appear last in the string.

Examples:
A legacy TAC 0x4305 shall be encoded as "4305".
An extended TAC 0x63F84B shall be encoded as "63F84B" | +| TacRm | string | This data type is defined in the same way as the "Tac" data type, but with the OpenAPI "nullable: true" property. | +| EutraCellId | string | 28-bit string identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.

Pattern: '[A-Fa-f0-9]{7}\$'

Example:
An E-UTRA Cell Id 0x5BD6007 shall be encoded as "5BD6007". | +| EutraCellIdRm | string | This data type is defined in the same way as the "EutraCellId" data type, but with the OpenAPI "nullable: true" property. | +| NrCellId | string | 36-bit string identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.

Pattern: '[A-Fa-f0-9]{9}\$'

Example:
An NR Cell Id 0x225BD6007 shall be encoded as "225BD6007". | +| NrCellIdRm | string | This data type is defined in the same way as the "NrCellId" data type, but with the OpenAPI "nullable: true" property. | +| Dnai | string | DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501 [8]. | +| DnaiRm | string | This data type is defined in the same way as the "Dnai" data type, but with the OpenAPI "nullable: true" property. | + +| | | | +|------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5GMmCause | UInteger | This represents the 5GMM cause code values as specified in 3GPP TS 24.501 [20]. | +| AreaCodeRm | string | This data type is defined in the same way as the "AreaCode" data type, but with the OpenAPI "nullable: true" property. | +| AmfName | Fqdn | FQDN (Fully Qualified Domain Name) of the AMF as defined in clause 28.3.2.5 of 3GPP TS 23.003 [7]. | +| AreaCode | string | Values are operator specific. | +| N3IwfId | string | This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.
Pattern: '[A-Fa-f0-9]+\$'

Example:
The N3IWF Id 0x5BD6 shall be encoded as "5BD6". | +| WAgfId | string | This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID shall appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID shall appear last in the string.
Pattern: '[A-Fa-f0-9]+\$'

Example:
The W-AGF Id 0x5BD6 shall be encoded as "5BD6". | +| TngfId | string | This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID shall appear first in the string, and the character representing the 4 least significant bit of the TNGF ID shall appear last in the string.
Pattern: '[A-Fa-f0-9]+\$'

Example:
The TNGF Id 0x5BD6 shall be encoded as "5BD6". | +| NgeNbId | string | This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413 [11].

The string shall be formatted with following pattern:
Pattern: '^('MacroNGeNB-[A-Fa-f0-9]{5}
LMacroNGeNB-[A-Fa-f0-9]{6}
SMacroNGeNB-[A-Fa-f0-9]{5})\$'

The value of the ng-eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the ng-eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) shall appear last in the string.

Examples:
" SMacroNGeNB-34B89" indicates a Short Macro NG-eNB ID with value 0x34B89. | +| Nid | string | This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 [7] and 3GPP TS 23.501 [8] clause 5.30.2.1).
Pattern: '[A-Fa-f0-9]{11}\$' | + +| | | | +|----------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NidRm | string | This data type is defined in the same way as the "Nid" data type, but with the OpenAPI "nullable: true" property. | +| NfSetId | string |

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]), formatted as the following string:

"set<Set ID>.<nftype>set.5gc.mnc<MNC>.mcc<MCC>", or
"set<SetID>.<NFType>set.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"

with

<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)

<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '[0-9]{3}\$'

<NFType> encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 [29] but with lower case characters

<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.
Pattern: '^[A-Za-z0-9-]*[A-Za-z0-9]\$'

Examples:
"setxyz.smfset.5gc.mnc012.mcc345"
"set12.pcfset.5gc.mnc012.mcc345"

| +| NfServiceSetId | string |

NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]) formatted as the following string:

"set<Set ID>.sn<Service Name>.nfi<NF Instance ID>.5gc.mnc<MNC>.mcc<MCC>">", or
"set<SetID>.sn<ServiceName>.nfi<NFInstanceId>.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"

with

<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)

<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '[0-9]{3}\$'

<NID> encoded as defined in clause 5.4.2 ("Nid" data type definition)

<NFInstanceId> encoded as defined in clause 5.3.2

<ServiceName> encoded as defined in 3GPP TS 29.510 [29]

<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.
Pattern: '^[A-Za-z0-9-]*[A-Za-z0-9]\$'

Examples:
"setxyz.snsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"
"set2.snpcf-smpolicycontrol.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"

| + +| | | | +|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PlmnAssiUeRadioCapId | Bytes | String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of 3GPP TS 24.501 [20] (starting from octet 1). | +| ManAssiUeRadioCapId | Bytes | String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of 3GPP TS 24.501 [20] (starting from octet 1). | +| TypeAllocationCode | string | Type Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the 15-digit IMEI and 16-digit IMEISV codes. See clause 6.2 of 3GPP TS 23.003 [7].

Pattern: '[0-9]{8}\$' | +| HfcNId | string | This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WVC-ARCH [32]. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters. | +| HfcNIdRm | string | This data type is defined in the same way as the "HfcNId" data type, but with the OpenAPI "nullable: true" property. | +| ENBId | string | This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413 [16].

The string shall be formatted with following pattern:
Pattern: '^('MacroeNB-[A-Fa-f0-9]{5} LMacroeNB-[A-Fa-f0-9]{6} SMacroeNB-[A-Fa-f0-9]{5} HomeeNB-[A-Fa-f0-9]{7})\$'

The value of the eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) shall appear last in the string.

Examples:
"SMacroeNB-34B89" indicates a Short Macro eNB ID with value 0x34B89. | +| Gli | Bytes | Global Line Identifier uniquely identifying the line connecting the 5G-BRG or FN-BRG to the 5GS. See clause 28.16.3 of 3GPP TS 23.003 [7].

This shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the GLI value (up to 150 bytes) encoded as specified in BBF WT-470 [37]. | +| Gci | string | Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003 [7].

This shall be encoded as a string per clause 28.15.4 of 3GPP TS 23.003 [7], and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 [47] for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WVC-ARCH [32]. | +| NsSrg | string | String representing Network Slice Simultaneous Registration Group (see clause 5.15.12 of 3GPP TS 23.501 [8]) | +| NsSrgRm | string | This data type is defined in the same way as the "NsSrg" data type, but with the OpenAPI "nullable: true" property. | +| RelayServiceCode | integer | Relay Service Code to identify a connectivity service provided by the UE-to-Network relay or the UE-to-UE relay. | + +| | | | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Integer type as defined in OpenAPI Specification [3], with value range from 0 to 16777215 (decimal).
Minimum = 0. Maximum = 16777215. | +| 5GPrukId | string | Prose Remote User Key ID over Control Plane

A string carrying the CP-PRUK ID of the the 5G ProSe Remote UE or the 5G ProSe End UE as specified in 3GPP TS 33.503 [50].

The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003 [7].

pattern: " ^ rid[0-9]{1,4}.pid[0-9a-fA-F]+\+@prose-cp.5gc.mnc[0-9]{2,3}.mcc[0-9]{3}.3gppnetwork.org\$" | +| NsagId | integer | Containing a Network Slice AS Group ID, see 3GPP TS 38.413 [11].
Values between 0 and 255 are allowed for this data type in this release. | +| NsagIdRm | integer | This data type is defined in the same way as the "NsagId" data type, but with the OpenAPI "nullable: true" property. | +| GeoSatelliteId | string | Unique identifier of a GEO satellite. See e.g. clause 5.43.2 in 3GPP TS 23.501 [2]. | +| OffloadIdentifier | string | Offload identifier uniquely identifying a VPLMN offloading policy information instance of the HPLMN.

It shall comprise the PLMN ID of the HPLMN providing the VPLMN offloading policy and a unique identifier of the VPLMN offloading policy instance in the HPLMN.

The PLMN ID shall be composed of three digits "mcc" followed by "." and two or three digits "mnc" and shall match the following pattern: '[0-9]{3}-[0-9]{2,3}'

The unique identifier shall match the following pattern: '[A-Fa-f0-9]{8}'

It may further contain the version number (between 0 and 99) of the VPLMN offloading policy instance in the HPLMN. A VPLMN Specific Offloading Information provided by the H-SMF with a higher version number will overwrite the one with lower version number. When present, the version number shall match the following pattern: '-v[0-9]{1,2}'

Pattern: ' ^ [0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{8}(-v[0-9]{1,2}){0,1}\$'

Examples (with and without a version number):

"262-01-00A17C01-v3"

"302-720-00A17C01" | +| NOTE: | For a PDN connection established via MME, the PDU Session ID value is set to 64 plus the EPS bearer ID of the default EPS bearer of the PDN connection; for a PDN connection established via ePDG, the PDU Session ID value is set to 80 plus the EPS bearer ID of the default EPS bearer of the PDN connection. | | + +## 5.4.3 Enumerations + +### 5.4.3.1 Enumeration: AccessType + +**Table 5.4.3.1-1: Enumeration AccessType** + +| Enumeration value | Description | +|-------------------|-----------------| +| "3GPP_ACCESS" | 3GPP access | +| "NON_3GPP_ACCESS" | Non-3GPP access | + +### 5.4.3.2 Enumeration: RatType + +**Table 5.4.3.2-1: Enumeration RatType** + +| Enumeration value | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| +| "NR" | New Radio | +| "EUTRA" | (WB) Evolved Universal Terrestrial Radio Access | +| "WLAN" | Untrusted Wireless LAN (IEEE 802.11) access | +| "VIRTUAL" | Virtual (see NOTE 1) | +| "NBIOT" | NB IoT | +| "WIREFLINE" | Wireline access | +| "WIREFLINE_CABLE" | Wireline Cable access | +| "WIREFLINE_BBF" | Wireline BBF access | +| "LTE-M" | LTE-M (see NOTE 2) | +| "NR_U" | New Radio in unlicensed bands | +| "EUTRA_U" | (WB) Evolved Universal Terrestrial Radio Access in unlicensed bands | +| "TRUSTED_N3GA" | Trusted Non-3GPP access | +| "TRUSTED_WLAN" | Trusted Wireless LAN (IEEE 802.11) access | +| "UTRA" | UMTS Terrestrial Radio Access | +| "GERA" | GSM EDGE Radio Access Network | +| "NR_LEO" | NR (LEO) satellite access type | +| "NR_MEO" | NR (MEO) satellite access type | +| "NR_GEO" | NR (GEO) satellite access type | +| "NR_OTHER_SAT" | NR (OTHERSAT) satellite access type | +| "NR_REDCAP" | NR RedCap access type (see NOTE 3) | +| "WB_E_UTRAN_LEO" | WB-E-UTRAN (LEO) satellite access type | +| "WB_E_UTRAN_MEO" | WB-E-UTRAN (MEO) satellite access type | +| "WB_E_UTRAN_GEO" | WB-E-UTRAN (GEO) satellite access type | +| "WB_E_UTRAN_OTHERSAT" | WB-E-UTRAN (OTHERSAT) satellite access type | +| "NB_IOT_LEO" | NB-IoT (LEO) satellite access type | +| "NB_IOT_MEO" | NB-IoT (MEO) satellite access type | +| "NB_IOT_GEO" | NB-IoT (GEO) satellite access type | +| "NB_IOT_OTHERSAT" | NB-IoT (OTHERSAT) satellite access type | +| "LTE_M_LEO" | LTE-M (LEO) satellite access type | +| "LTE_M_MEO" | LTE-M (MEO) satellite access type | +| "LTE_M_GEO" | LTE-M (GEO) satellite access type | +| "LTE_M_OTHERSAT" | LTE-M (OTHERSAT) satellite access type | +| NOTE 1: Virtual shall be used if the N3IWF does not know the access technology used for an untrusted non-3GPP access. | | +| NOTE 2: This RAT type value is used only in the Core Network; it shall be used when a Category M UE using E-UTRA has provided a Category M indication to the NG-RAN. | | +| NOTE 3: This RAT type value is used only in the Core Network; it shall be used only for an UE using NR with reduced radio capability provided to the NG-RAN. | | + +### 5.4.3.3 Enumeration: PduSessionType + +The enumeration PduSessionType indicates the type of a PDU session. It shall comply with the provisions defined in table 5.4.3.3-1. + +**Table 5.4.3.3-1: Enumeration PduSessionType** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------| +| "IPv4" | IPv4 | +| "IPv6" | IPv6 | +| "IPv4V6" | IPv4v6 (see clause 5.8.2.2.1 of 3GPP TS 23.501 [8]) | +| "UNSTRUCTURED" | Unstructured | +| "ETHERNET" | Ethernet | + +#### 5.4.3.4 Enumeration: UpIntegrity + +The enumeration UpIntegrity indicates whether UP integrity protection is required, preferred or not needed for all the traffic on the PDU Session. It shall comply with the provisions defined in table 5.4.3.4-1. + +**Table 5.4.3.4-1: Enumeration UpIntegrity** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------| +| "REQUIRED" | UP integrity protection shall apply for all the traffic on the PDU Session. | +| "PREFERRED" | UP integrity protection should apply for all the traffic on the PDU Session. | +| "NOT_NEEDED" | UP integrity protection shall not apply on the PDU Session. | + +#### 5.4.3.5 Enumeration: UpConfidentiality + +The enumeration UpConfidentiality indicates whether UP confidentiality protection is required, preferred or not needed for all the traffic on the PDU Session. It shall comply with the provisions defined in table 5.4.3.5-1. + +**Table 5.4.3.5-1: Enumeration UpConfidentiality** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------| +| "REQUIRED" | UP confidentiality protection shall apply for all the traffic on the PDU Session. | +| "PREFERRED" | UP confidentiality protection should apply for all the traffic on the PDU Session. | +| "NOT_NEEDED" | UP confidentiality protection shall not apply on the PDU Session. | + +#### 5.4.3.6 Enumeration: SscMode + +The enumeration SscMode represents the service and session continuity mode. + +**Table 5.4.3.6-1: Enumeration SscMode** + +| Enumeration value | Description | +|-------------------|------------------------| +| "SSC_MODE_1" | see 3GPP TS 23.501 [8] | +| "SSC_MODE_2" | see 3GPP TS 23.501 [8] | +| "SSC_MODE_3" | see 3GPP TS 23.501 [8] | + +#### 5.4.3.7 Enumeration: DnaiChangeType + +The enumeration DnaiChangeType represents the type of a DNAI change. A NF service consumer may subscribe to "EARLY", "LATE" or "EARLY\_LATE" types of DNAI change. The types of observed DNAI change the SMF may notify are "EARLY" or "LATE". The DnaiChangeType data type shall comply with the provisions defined in table 5.4.3.7-1. + +**Table 5.4.3.7-1: Enumeration DnaiChangeType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| EARLY | Early notification of UP path reconfiguration. | | +| EARLY_LATE | Early and late notification of UP path reconfiguration.
This value shall only be present in the subscription to the DNAI change event. | | +| LATE | Late notification of UP path reconfiguration. | | + +#### 5.4.3.8 Enumeration: RestrictionType + +**Table 5.4.3.8-1: Enumeration RestrictionType** + +| Enumeration value | Description | +|---------------------|--------------------------------------------------| +| "ALLOWED AREAS" | This value indicates that areas are allowed. | +| "NOT_ALLOWED AREAS" | This value indicates that areas are not allowed. | + +#### 5.4.3.9 Enumeration: CoreNetworkType + +**Table 5.4.3.9-1: Enumeration CoreNetworkType** + +| Enumeration value | Description | +|-------------------|---------------------| +| "5GC" | 5G Core | +| "EPC" | Evolved Packet Core | + +#### 5.4.3.10 Enumeration: AccessTypeRm + +This enumeration is defined in the same way as the "AccessType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.11 Enumeration: RatTypeRm + +This enumeration is defined in the same way as the "RatType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.12 Enumeration: PduSessionTypeRm + +This enumeration is defined in the same way as the "PduSessionType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.13 Enumeration: UpIntegrityRm + +This enumeration is defined in the same way as the "UpIntegrity" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.14 Enumeration: UpConfidentialityRm + +This enumeration is defined in the same way as the "UpConfidentiality" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.15 Enumeration: SscModeRm + +This data type is defined in the same way as the "SscMode" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.17 Enumeration: DnaiChangeTypeRm + +This data type is defined in the same way as the "DnaiChangeType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.18 Enumeration: RestrictionTypeRm + +This data type is defined in the same way as the "RestrictionType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.19 Enumeration: CoreNetworkType + +This data type is defined in the same way as the "CoreNetworkType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.20 Enumeration: PresenceState + +**Table 5.4.3.20-1: Enumeration PresenceState** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------| +| "IN_AREA" | Indicates that the UE is inside or enters the presence reporting area. | +| "OUT_OF_AREA" | Indicates that the UE is outside or leaves the presence reporting area. | +| "UNKNOWN" | Indicates it is unknown whether the UE is in the presence reporting area or not. | +| "INACTIVE" | Indicates that the presence reporting area is inactive in the serving node. | + +#### 5.4.3.21 Enumeration: StationaryIndication + +**Table 5.4.3.21-1: Enumeration StationaryIndication** + +| Enumeration value | Description | +|-------------------|---------------------------------| +| "STATIONARY" | Identifies the UE is stationary | +| "MOBILE" | Identifies the UE is mobile | + +#### 5.4.3.22 Enumeration: StationaryIndicationRm + +This enumeration is defined in the same way as the "StationaryIndication" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.23 Enumeration: ScheduledCommunicationType + +**Table 5.4.3.23-1: Enumeration ScheduledCommunicationType** + +| Enumeration value | Description | +|-------------------|----------------| +| "DOWNLINK_ONLY" | Downlink only | +| "UPLINK_ONLY" | Uplink only | +| "BIDIRECTIONAL" | Bi-directional | + +#### 5.4.3.24 Enumeration: ScheduledCommunicationTypeRm + +This enumeration is defined in the same way as the "ScheduledCommunicationType" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.25 Enumeration: TrafficProfile + +**Table 5.4.3.25-1: Enumeration TrafficProfile** + +| Enumeration value | Description | +|-----------------------|------------------------------------------------------------------------------------------------------------| +| "SINGLE_TRANS_UL" | Uplink single packet transmission. | +| "SINGLE_TRANS_DL" | Downlink single packet transmission. | +| "DUAL_TRANS_UL_FIRST" | Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission. | +| "DUAL_TRANS_DL_FIRST" | Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission. | +| "MULTI_TRANS" | Multiple packet transmission. | + +#### 5.4.3.26 Enumeration: TrafficProfileRm + +This enumeration is defined in the same way as the "TrafficProfile" enumeration, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.27 Enumeration: LcsServiceAuth + +**Table 5.4.3.27-1: Enumeration LcsServiceAuth** + +| Enumeration value | Description | +|-----------------------------------------|-----------------------------------------------------------------------------------------| +| "LOCATION_ALLOWED_WITH_NOTIFICATION" | Location allowed with notification | +| "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" | Location allowed without notification | +| "LOCATION_ALLOWED_WITHOUT_RESPONSE" | Location with notification and privacy verification; location allowed if no response | +| "LOCATION_RESTRICTED_WITHOUT_RESPONSE" | Location with notification and privacy verification; location restricted if no response | +| "NOTIFICATION_ONLY" | Notification only | +| "NOTIFICATION_AND_VERIFICATION_ONLY" | Notification and privacy verification only | + +#### 5.4.3.28 Enumeration: UeAuth + +**Table 5.4.3.28-1: Enumeration UeAuth** + +| Enumeration value | Description | +|-------------------|------------------------------------------| +| "AUTHORIZED" | Indicates that the UE is authorized. | +| "NOT_AUTHORIZED" | Indicates that the UE is not authorized. | + +### 5.4.3.29 Enumeration: DIDataDeliveryStatus + +**Table 5.4.3.29-1: Enumeration DddStatus** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "BUFFERED" | The first downlink data is buffered with extended buffering matching the source of the downlink traffic. | +| "TRANSMITTED" | The first downlink data matching the source of the downlink traffic is transmitted after previous buffering or discarding of corresponding packet(s) because the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE. | +| "DISCARDED" | The first downlink data matching the source of the downlink traffic is discarded because the Extended Buffering time, as determined by the SMF, expires or the amount of downlink data to be buffered is exceeded. | + +### 5.4.3.30 Enumeration: DIDataDeliveryStatusRm + +This enumeration is defined in the same way as the "DIDataDeliveryStatus" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.4.3.31 Void + +### 5.4.3.32 Enumeration: AuthStatus + +**Table 5.4.3.32-1: Enumeration AuthStatus** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------| +| "EAP_SUCCESS" | The NSSAA status is EAP-Success. | +| "EAP_FAILURE" | The NSSAA status is EAP-Failure. | +| "PENDING" | The NSSAA status is Pending, i.e. the NSSAA procedure is ongoing. | + +### 5.4.3.33 Enumeration: LineType + +**Table 5.4.3.33-1: Enumeration LineType** + +| Enumeration value | Description | +|-------------------|-------------| +| "DSL" | DSL line | +| "PON" | PON line | + +### 5.4.3.34 Enumeration: LineTypeRm + +This enumeration is defined in the same way as the "LineType" enumeration, but with the OpenAPI "nullable: true" property. + +5.4.3.35 Void + +5.4.3.36 Void + +5.4.3.37 Enumeration: NotificationFlag + +**Table 5.4.3.37-1: Enumeration NotificationFlag** + +| Enumeration value | Description | Applicability | +|-----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|---------------| +| ACTIVATE | The event notification is activated. | | +| DEACTIVATE | The event notification is deactivated and shall be muted. The available event(s) shall be stored. | | +| RETRIEVAL | The event notification shall be sent to the NF service consumer(s), after that, is muted again.
(See NOTE) | | +| NOTE: The value "RETRIEVAL" shall not be provided during the creating subscription procedure. | | | + +5.4.3.38 Enumeration: TransportProtocol + +**Table 5.4.3.38-1: Enumeration TransportProtocol** + +| Enumeration value | Description | +|-------------------|-------------------------------| +| "UDP" | User Datagram Protocol | +| "TCP" | Transmission Control Protocol | + +5.4.3.39 Enumeration: SatelliteBackhaulCategory + +**Table 5.4.3.39-1: Enumeration SatelliteBackhaulCategory** + +| Enumeration value | Description | +|---------------------|-----------------------------------------------------------------------------------------------------------------| +| "GEO" | Indicates Geostationary satellite backhaul category. | +| "MEO" | Indicates Medium Earth Orbit satellite backhaul category. | +| "LEO" | Indicates Low Earth Orbit satellite backhaul category. | +| "OTHER_SAT" | Indicates other satellite backhaul category. | +| "DYNAMIC_GEO" | Indicates dynamic Geostationary satellite backhaul category. | +| "DYNAMIC_MEO" | Indicates dynamic Medium Earth Orbit satellite backhaul category. | +| "DYNAMIC_LEO" | Indicates dynamic Low Earth Orbit satellite backhaul category. | +| "DYNAMIC_OTHER_SAT" | Indicates dynamic other satellite backhaul category. | +| "NON_SATELLITE" | Indicates non satellite backhaul. (NOTE) | +| NOTE: | This value indicates that there is no longer any satellite backhaul towards the 5G AN currently serving the UE. | + +5.4.3.40 Enumeration: SatelliteBackhaulCategoryRm + +This data type is defined in the same way as the "SatelliteBackhaulCategory" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.3.41 Enumeration: BufferedNotificationsAction + +**Table 5.4.3.41-1: Enumeration BufferedNotificationsAction** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| "SEND_ALL" | The NF Service Producer should send all the reports of the stored events to the NF service consumer. | +| "DISCARD_ALL" | The NF Service Producer should discard all the reports of the stored events for the NF service consumer. | +| "DROP_OLD" | The NF Service Producer should drop the old reports of the stored events for the NF service consumer when new event reports need to be stored. | + +#### 5.4.3.42 Enumeration: SubscriptionAction + +**Table 5.4.3.42-1: Enumeration SubscriptionAction** + +| Enumeration value | Description | +|---------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| "CLOSE" | The subscription to the event notification should be terminated if an exception occurs at the NF Service Producer. | +| "CONTINUE_WITH_MUTING" | The subscription to the event notification should be continued with muting if an exception occurs at the NF Service Producer. | +| "CONTINUE_WITHOUT_MUTING" | The subscription to the event notification should be continued without muting if an exception occurs at the NF Service Producer. | + +#### 5.4.3.43 Enumeration: SnssaiStatus + +**Table 5.4.3.43-1: Enumeration SnssaiStatus** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------| +| "AVAILABLE" | This value is used when the S-NSSAI becomes available. | +| "UNAVAILABLE" | This value is used when the S-NSSAI becomes unavailable. | + +#### 5.4.3.44 Enumeration: TerminationIndication + +**Table 5.4.3.44-1: Enumeration TerminationIndication** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| "NEW_UES_TERMINATION" | It indicates that Network Slice Replacement is terminated for new UEs. | +| "ALL_UES_TERMINATION" | It indicates that Network Slice Replacement is terminated for all UEs and PDU sessions shall move back from the alternative S-NSSAI to the S-NSSAI. | + +## 5.4.4 Structured Data Types + +### 5.4.4.1 Type: SubscribedDefaultQos + +**Table 5.4.4.1-1: Definition of type SubscribedDefaultQos** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5qi | 5Qi | M | 1 | Default 5G QoS identifier see 3GPP TS 23.501 [8] clause 5.7.2.7. | +| arp | Arp | M | 1 | Default Allocation and Retention Priority see 3GPP TS23.501 [8] clause 5.7.2.7. | +| priorityLevel | 5QiPriorityLevel | O | 0..1 | Defines the 5QI Priority Level. When present, it contains the 5QI Priority Level value that overrides the standardized or pre-configured value as described in 3GPP TS 23.501 [8]. | + +### 5.4.4.2 Type: Snssai + +**Table 5.4.4.2-1: Definition of type Snssai** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sst | UInteger | M | 1 | Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services.
Values 0 to 127 correspond to the standardized SST range. Values 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003 [7].
Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501 [8]. | +| sd | string | O | 0..1 | 3-octet string, representing the Slice Differentiator, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the SD shall appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string.

This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE shall be absent if no SD value is associated with the SST.

Pattern: '[A-Fa-f0-9]{6}\$' | + +When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd", and shall match the following pattern: + +^[0-9]{1,3}([0-9]{0,3})?-[A-Fa-f0-9]{6}\$ + +Example 1: "255-19CDE0" + +Example 2: "29" + +#### 5.4.4.3 Type: PlmnId + +**Table 5.4.4.3-1: Definition of type PlmnId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------| +| mcc | Mcc | M | 1 | Mobile Country Code | +| mnc | Mnc | M | 1 | Mobile Network Code | + +When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc", and shall match the following pattern: + +^[0-9]{3}-[0-9]{2,3}\$ + +Example 1: "262-01" + +Example 2: "302-720" + +#### 5.4.4.4 Type: Tai + +**Table 5.4.4.4-1: Definition of type Tai** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| tac | Tac | M | 1 | Tracking Area Code | +| nid | Nid | O | 0..1 | Network Identifier, shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the TA belongs to. | + +NOTE: The "nid" attribute is used to convey the Network Identifier (NID) of the SNPN as part of the "Tai" JSON object data type definition; this is a protocol aspect that does not imply any change on the system-wide definition of the TAI, as described in 3GPP 23.003 [7]. + +#### 5.4.4.5 Type: Ecgi + +**Table 5.4.4.5-1: Definition of type Ecgi** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|----------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| eutraCellId | EutraCellId | M | 1 | E-UTRA Cell Identity | +| nid | Nid | O | 0..1 | Network Identifier | + +NOTE: The "nid" attribute is used to convey the Network Identifier (NID) of the SNPN as part of the "Ecgi" JSON object data type definition; this is a protocol aspect that does not imply any change on the system-wide definition of the ECGI, as described in 3GPP 23.003 [7]. + +## 5.4.4.6 Type: Ncgi + +**Table 5.4.4.6-1: Definition of type Ncgi** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| nrCellId | NrCellId | M | 1 | NR Cell Identity | +| nid | Nid | C | 0..1 | Network Identifier, shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the NR cell belongs to. | + +NOTE: The "nid" attribute is used to convey the Network Identifier (NID) of the SNPN as part of the "Ncgi" JSON object data type definition; this is a protocol aspect that does not imply any change on the system-wide definition of the NCGI, as described in 3GPP 23.003 [7]. + +## 5.4.4.7 Type: UserLocation + +**Table 5.4.4.7-1: Definition of type UserLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|-------------------------------------------| +| eutraLocation | EutraLocation | C | 0..1 | E-UTRA user location (see NOTE). | +| nrLocation | NrLocation | C | 0..1 | NR user location (see NOTE). | +| n3gaLocation | N3gaLocation | C | 0..1 | Non-3GPP access user location (see NOTE). | +| utraLocation | UtraLocation | C | 0..1 | UTRAN access user location (see NOTE). | +| geraLocation | GeraLocation | C | 0..1 | GERAN access user location (see NOTE). | + +NOTE: At least one of eutraLocation, nrLocation, n3gaLocation, utraLocation and geraLocation shall be present. Several of them may be present. + +## 5.4.4.8 Type: EutraLocation + +Table 5.4.4.8-1: Definition of type EutraLocation + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tai | Tai | M | 1 | Tracking Area Identity.
The TAC of the TAI shall be set to one reserved value (e.g. 0x0000, see clause 19.4.2.3 of 3GPP TS 23.003 [7]) if the TAI information is not available. | +| ignoreTai | boolean | O | 0..1 | This flag when present shall indicate that the Tai shall be ignored.
When present, it shall be set as follows:
- true: tai shall be ignored.
- false (default): tai shall not be ignored. | +| ecgi | Ecgi | M | 1 | E-UTRA Cell Identity | +| ignoreEcgi | boolean | O | 0..1 | This flag when present shall indicate that the Ecgi shall be ignored.
When present, it shall be set as follows:
- true: ecgi shall be ignored.
- false (default): ecgi shall not be ignored. | +| ageOfLocationInformation | integer | O | 0 1 | The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See 3GPP TS 29.002 [21] clause 17.7.8. | +| ueLocationTimestamp | DateTime | O | 0..1 | The value represents the UTC time when the UeLocation information was acquired. | +| geographicalInformation | string | O | 0..1 | Refer to geographical Information.
See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F; | +| geodeticInformation | string | O | 0..1 | Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F. | +| globalNgenbld | GlobalRanNodeId | O | 0..1 | It indicates the global identity of the ng-eNodeB in which the UE is currently located.
See 3GPP TS 38.413 [11] clause 9.3.1.8. | +| globalENbld | GlobalRanNodeId | O | 0..1 | It indicates the global identity of the eNodeB in which the UE is currently located.
See 3GPP TS 36.413 [16] clause 9.2.1.37. | +| NOTE: Either the "globalNgenbld" attribute or the "globalENbld" attribute shall be included in the "EutraLocation" data type. | | | | | + +#### 5.4.4.9 Type: NrLocation + +**Table 5.4.4.9-1: Definition of type NrLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tai | Tai | M | 1 | Tracking Area Identity | +| ncgi | Ncgi | M | 1 | NR Cell Identity | +| ignoreNcgi | boolean | O | 0..1 | This flag when present shall indicate that the Ncgi shall be ignored.
When present, it shall be set as follows:
- true: ncgi shall be ignored.
- false (default): ncgi shall not be ignored. | +| ageOfLocationInformation | integer | O | 0..1 | The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the gNB when the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See 3GPP TS 29.002 [21] clause 17.7.8. | +| ueLocationTimestamp | DateTime | O | 0..1 | The value represents the UTC time when the UeLocation information was acquired. | +| geographicalInformation | string | O | 0..1 | Refer to geographical Information.
See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F; | +| geodeticInformation | string | O | 0..1 | Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F. | +| globalGnbId | GlobalRanNodeId | O | 0..1 | It indicates the global identity of the gNodeB in which the UE is currently located.
See 3GPP TS 38.413 [11] clause 9.3.1.6. | +| ntnTailInfo | NtnTailInfo | O | 0..1 | Contains NR NTN TAI Information.
When present, the tai attribute shall be ignored, see clause 9.3.3.53 of 3GPP TS 38.413 [11]. | + +#### 5.4.4.10 Type: N3gaLocation + +**Table 5.4.4.10-1: Definition of type N3gaLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n3gppTai | Tai | C | 0..1 | This IE shall be present over the 3GPP PLMN internal interfaces, but it shall not be present over the N5 interface. When present, it shall contain the TAI reported by the N3IWF, TNGF or W-AGF for the non-3GPP access. | +| n3lwflId | string | C | 0..1 | This IE shall contain the N3IWF identifier received over NGAP and shall be encoded as a string of hexadecimal characters. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.

Pattern: '[A-Fa-f0-9j+\$]'

Example:
The N3IWF Id 0x5BD6 shall be encoded as "5BD6".

It shall be present over the 3GPP PLMN internal interfaces if the UE is accessing the 5GC via an untrusted non-3GPP access, but shall not be present over the N5 interface. | +| uelpv4Addr | Ipv4Addr | C | 0..1 | UE/N5CW device local IPv4 address (used to reach the N3IWF, TNGF or TWIF).
The uelIPv4Addr or the uelIPv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available. | +| uelpv6Addr | Ipv6Addr | C | 0..1 | UE/N5CW device local IPv6 address (used to reach the N3IWF, TNGF or TWIF).
The uelIPv4Addr or the uelIPv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available. | +| portNumber | UInteger | C | 0..1 | UDP or TCP source port number. It shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and NAT is detected. | +| protocol | TransportProtocol | O | 0..1 | This IE may be present if portNumber is present.

When present, this IE shall indicate the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access and NAT is detected.

The absence of this IE indicates that the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access is not specified, i.e. could be UDP or TCP. | +| tnapld | Tnapld | C | 0..1 | This IE shall contain the TNAP Identifier, see clause 5.6.2 of 3GPP TS 23.501 [8]. | +| twapld | Twapld | C | 0..1 | In the scenario of accessing 5GC from N5CW device, this IE shall contain the TWAP Identifier, see clause 4.2.8.5.3 of 3GPP TS 23.501 [8].
In the scenario of interworking between ePDG/EPC and 5GS, this IE shall contain the WLAN location information, see clause 4.5.7.2.8 of 3GPP TS 23.402 [48]. | +| hfcNodeId | HfcNodeId | C | 0..1 | This IE shall contain the HFC Node Identifier received over NGAP. It shall be present for a 5G-CRG/FN-CRG accessing the 5GC via wireline access network, and for a AUN3 device connected behind the 5G-CRG (see clause 7.2.8.1 of 3GPP TS 23.316 [30]). | +| gli | Gli | C | 0..1 | This IE shall contain the Global Line Identifier. It shall be present for a 5G-BRG/FN-BRG accessing | + +| | | | | | +|----------------|----------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | the 5GC via wireline access network, and for a AUN3 device connected behind a 5G-BRG. | +| w5gbanLineType | LineType | O | 0..1 | This IE may be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network. When present, it shall indicate the type of the wireline (DSL or PON). | +| gci | Gci | C | 0..1 | This IE shall contain the Global Cable Identifier. It shall be present for the N5GC device accessing the 5GC via wireline access network(see clause 4.10a of 3GPP TS 23.316 [30]), and for a AUN3 device connected behind the 5G-CRG (see clause 7.2.8.1 of 3GPP TS 23.316 [30]). | + +#### 5.4.4.11 Type: UpSecurity + +**Table 5.4.4.11-1: Definition of type UpSecurity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| upIntegr | UpIntegrity | M | 1 | This IE shall indicate whether UP integrity protection is required, preferred or not needed for all the traffic on the PDU Session. | +| upConfid | UpConfidentiality | M | 1 | This IE shall indicate whether UP confidentiality protection is required, preferred or not needed for all the traffic on the PDU Session. | + +#### 5.4.4.12 Type: NgApCause + +**Table 5.4.4.12-1: Definition of type NgApCause** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| group | UInteger | M | 1 | This IE shall indicate the group of the NGAP cause. The value of this IE shall equal to the ASN.1 value of the specified NGAP cause group.

NGAP supports following cause groups defined as separate enumerations, as specified in clause 9.4.5 of 3GPP TS 38.413 [11], with following values:

0 – radioNetwork
1 – transport
2 – nas
3 – protocol
4 – misc | +| value | UInteger | M | 1 | This IE shall carry the NG AP cause value in specific cause group identified by the "group" attribute, as specified in clause 9.4.5 of 3GPP TS 38.413 [11]. | + +## 5.4.4.13 Type: BackupAmfInfo + +Table 5.4.4.13-1: Definition of type BackupAmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| backupAmf | AmfName | M | 1 | This IE shall contain the AMF name of the backup AMF that can serve the specific GUAMI(s) supported by the primary AMF (see clause 5.21.2.3 of 3GPP TS 23.501 [8]). | +| guamiList | array(Guami) | C | 1..N | If present, this IE shall contain the list of GUAMI(s) (supported by the primary AMF) which the backup AMF can serve.

If this IE is absent, it indicates that the backup AMF can serve all the GUAMI(s) supported by the primary AMF. | + +## 5.4.4.14 Type: RefToBinaryData + +Table 5.4.4.14-1: Definition of type RefToBinaryData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| contentId | string | M | 1 | This IE shall contain the value of the Content-ID header of the referenced binary body part. | + +## 5.4.4.15 Type RouteToLocation + +Table 5.4.4.15-1: Definition of type RouteToLocation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------------------------| +| dnai | Dnai | M | 1 | Identifies the location of the application. | +| routeInfo | RouteInformation | C | 0..1 | Includes the traffic routing information. | +| routeProfId | string | C | 0..1 | Identifies the routing profile Id. | +| NOTE: | At least one of the "routeInfo" attribute and the "routeProfId" attribute shall be included in the "RouteToLocation" data type.. | | | | + +## 5.4.4.16 Type RouteInformation + +Table 5.4.4.16-1: Definition of type RouteInformation + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------------------------------------------------------------------------------------------------------------|---|-------------|--------------------------------------------------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | Ipv4address of the tunnel end point in the data network. | +| ipv6Addr | Ipv6Addr | C | 0..1 | Ipv6 address of the tunnel end point in the data network. | +| portNumber | Uinteger | M | 1 | UDP port number of the tunnel end point in the data network. | +| NOTE: | At least one of the "ipv4Addr" attribute and the "ipv6Addr" attribute shall be included in the "RouteInformation" data type. | | | | + +## 5.4.4.17 Type: Area + +Table 5.4.4.17-1: Definition of type Area + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------| +| tacs | array(Tac) | C | 1..N | List of TACs; shall be present if and only if areaCode is absent. | +| areaCode | AreaCode | C | 0..1 | Area Code; shall be present if and only if tacs is absent. | + +#### 5.4.4.18 Type: ServiceAreaRestriction + +**Table 5.4.4.18-1: Definition of type ServiceAreaRestriction** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|-----------------|---|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| restrictionType | RestrictionType | C | 0..1 | string
"ALLOWED_AREAS" or
"NOT_ALLOWED_AREAS"
shall be present if and only if the areas attribute is present | +| areas | array(Area) | O | 0..N
(NOTE) | A list of Areas.
These areas are:
- allowed areas if RestrictionType is
"ALLOWED_AREAS"
- not allowed areas if RestrictionType is
"NOT_ALLOWED_AREAS" | +| maxNumOfTAs | Uinteger | C | 0..1 | Maximum number of allowed tracking areas for use
when restrictionType indicates
"ALLOWED_AREAS".
This attribute shall be absent when attribute
"restrictionType" takes the value
"NOT_ALLOWED_AREAS". | +| maxNumOfTAsForNotAllowedAreas | Uinteger | C | 0..1 | Maximum number of allowed tracking areas for use
when restrictionType indicates
"NOT_ALLOWED_AREAS".
This attribute shall be absent when attribute
"restrictionType" takes the value
"ALLOWED_AREAS". | + +NOTE: The empty array is used when service is allowed/restricted nowhere. + +#### 5.4.4.19 Type: PlmnIdRm + +This data type is defined in the same way as the "PlmnId" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.20 Type: TaiRm + +This data type is defined in the same way as the "Tai" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.21 Type: EcgiRm + +This data type is defined in the same way as the "Ecgi" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.22 Type: NcgiRm + +This data type is defined in the same way as the "Ncgi" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.23 Type: EutraLocationRm + +This data type is defined in the same way as the "EutraLocation" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.24 Type: NrLocationRm + +This data type is defined in the same way as the "NrLocation" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.25 Type: UpSecurityRm + +This data type is defined in the same way as the "UpSecurity" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.26 Type: RefToBinaryDataRm + +This data type is defined in the same way as the "RefToBinaryData" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.27 Type: PresenceInfo + +**Table 5.4.4.27-1: Definition of type PresenceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| prald | string | C | 0..1 |

Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003 [7]). This IE shall be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas.

When present, it shall be encoded as a string representing an integer in the following ranges:
0 to 8 388 607 for UE-dedicated PRA
8 388 608 to 16 777 215 for Core Network predefined PRA.

Examples:
PRA ID 123 is encoded as "123"
PRA ID 11 238 660 is encoded as "11238660"

| +| additionalPrald | string | C | 0..1 |

This IE may be present if the prald IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas.

When present, this IE shall contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the prald IE.

| +| presenceState | PresenceState | C | 0..1 |

Indicates whether the UE is inside or outside of the area of interest (e.g presence reporting area or the LADN area), or if the presence reporting area is inactive in the serving node. (NOTE)

| +| trackingAreaList | array(Tai) | C | 1..N |

Represents the list of tracking areas that constitutes the area. This IE shall be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI.

| +| ecgiList | array(Ecgi) | C | 1..N |

Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of EUTRAN cell Ids.

| +| ncgiList | array(Ncgi) | C | 1..N |

Represents the list of NR cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NR cell Ids.

| +| globalRanNodeIdList | array(GlobalRanNodeId) | C | 1..N |

Represents the list of NG RAN node identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NG RAN node identifiers.

| +| globalENbIdList | array(GlobalRanNodeId) | C | 1..N |

Represents the list of eNodeB identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of eNodeB identifiers.

| +|

NOTE: If the additionalPrald IE is present, this IE shall state the presence information of the UE for the individual PRA identified by the additionalPrald IE; If the additionalPrald IE is not present, this IE shall state the presence information of the UE for the PRA identified by the prald IE.

| | | | | + +## 5.4.4.28 Type: GlobalRanNodeId + +Table 5.4.4.28-1: Definition of type GlobalRanNodeId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | Indicates the identity of the PLMN that the RAN node belongs to. | +| n3lwflId | N3lwflId | C | 0..1 | This IE shall be included if the AN node represents a N3IWF. When present, this IE shall contain the identifier of the N3IWF.
(NOTE 1). | +| gNbld | GNbld | C | 0..1 | This IE shall be included if the RAN Node Id represents a gNB. When present, this IE shall contain the identifier of the gNB. (NOTE 1). | +| ngeNbld | NgeNbld | C | 0..1 | This IE shall be included if the RAN Node Id represents a NG-eNB. When present, this IE shall contain the identifier of an NG-eNB.
(NOTE 1). | +| wagflId | WAgflId | C | 0..1 | This IE shall be included if the AN node represents a W-AGF. When present, this IE shall contain the identifier of the W-AGF.
(NOTE 1). | +| tnfgflId | TngflId | C | 0..1 | This IE shall be included if the AN node represents a TNGF. When present, this IE shall contain the identifier of the TNGF.
(NOTE 1). | +| nid | Nid | O | 0..1 | Network Identifier shall be present in case of SNPn, PlmnId together with Nid indicates the identity of the SNPn to which the RanNode belongs to. | +| eNbld | ENbld | C | 0..1 | This IE shall be included if the RAN Node Id represents an eNB. When present, this IE shall contain the identifier of an eNB.
(NOTE 1, NOTE 2). | + +NOTE 1: One of the six attributes n3lwflId, gNbld, ngeNbld, wagflId, tnfgflId, eNbld shall be present. + +NOTE 2: For UEs with 5GS subscription but without 5G NAS support, eNbld is used on N7 instead of n3lwflId, gNbld, ngeNbld. + +## 5.4.4.29 Type: GNbId + +Table 5.4.4.29-1: Definition of type GNbId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bitLength | integer | M | 1 | Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32 | +| gNBValue | string | M | 1 |

This represents the identifier of the gNB.

The string shall be formatted with following pattern: '^[A-Fa-f0-9]{6,8}\$'

The value of the gNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID shall appear first in the string, and the character representing the 4 least significant bit of the gNB ID shall appear last in the string.

Examples:
A 30 bit value "382A3F47" indicates a gNB ID with value 0x382A3F47
A 22 bit value "2A3F47" indicates a gNB ID with value 0x2A3F47

| + +## 5.4.4.30 Type: PresenceInfoRm + +This data type is defined in the same way as the "PresenceInfo" data type, but with the OpenAPI "nullable: true" property. + +## 5.4.4.31 Void + +## 5.4.4.32 Type: AtsssCapability + +Table 5.4.4.32-1: Definition of type AtsssCapability + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| atsssLL | boolean | C | 0..1 |

Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501 [8]).

true: Supported
false (default): Not Supported

| +| mptcp | boolean | C | 0..1 |

Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501 [8]).

true: Supported
false (default): Not Supported

| +| rttWithoutPmf | boolean | C | 0..1 |

This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501 [8]).

If this attribute is present and set to true, the mptcp attribute shall also be present and set to true.

true: Supported
false (default): Not Supported.

| + +### 5.4.4.33 Type: PlmnIdNid + +**Table 5.4.4.33-1: Definition of type PlmnIdNid** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mcc | Mcc | M | 1 | Mobile Country Code | +| mnc | Mnc | M | 1 | Mobile Network Code | +| nid | Nid | C | 0..1 | Network Identity; Shall be present if PlmnIdNid identifies an SNPN (see clauses 5.30.2.3, 5.30.2.9, 6.3.4, and 6.3.8 in 3GPP TS 23.501 [2]). Otherwise, this attribute shall be absent. | + +When PlmnIdNid needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc" followed by "-" and 11 digits "nid", and shall match the following pattern: + +^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{11}\$ + +Example 1: "262-01-000007ed9d5" + +Example 2: "302-720-000007ed9d5" + +### 5.4.4.34 Type: PlmnIdNidRm + +This data type is defined in the same way as the "PlmnIdNid" data type, but with the OpenAPI "nullable: true" property. + +### 5.4.4.35 Type: SmallDataRateStatus + +**Table 5.4.4.35-1: Definition of type SmallDataRateStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| remainPacketsUI | integer | C | 0..1 | This IE shall be included if available. When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]). | +| remainPacketsDI | integer | C | 0..1 | This IE shall be included if available. When present it shall contain the number of packets the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]). | +| validityTime | DateTime | C | 0..1 | This IE shall be included if available. When present, it shall indicate the period of time during which the small data rate control status will remain valid (see clause 5.31.14.3 of 3GPP TS 23.501 [8]). | +| remainExReportsUI | integer | C | 0..1 | This IE shall be included if available. When present, it shall indicate number of additional exception reports the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]). | +| remainExReportsDI | integer | C | 0..1 | This IE shall be included if available. When present, it shall indicate number of additional exception reports the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]). | + +## 5.4.4.36 Type: HfcNodeId + +Table 5.4.4.36-1: Definition of type HfcNodeId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------|---------------| +| hfcNId | HfcNId | M | 1 | HFC Node Id. | | + +## 5.4.4.37 Type: HfcNodeIdRm + +This data type is defined in the same way as the "HfcNodeId" data type, but with the OpenAPI "nullable: true" property. + +## 5.4.4.38 Type: WirelineArea + +Table 5.4.4.38-1: Definition of type WirelineArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| globalLineIds | array(Gli) | C | 1..N | List of Global Line Identifiers, for a 5G-BRG or an AUN3 device behind 5G-BRG accessing the 5GC via wireline access network. | | +| hfcNIds | array(HfcNId) | C | 1..N | List of HFC Node Ids, for a 5G-CRG/FN-CRG is accessing the 5GC via wireline access network. | | +| areaCodeB | AreaCode | C | 0..1 | Area Code for 5G-BRG or an AUN3 device behind 5G-BRG accessing via wireline access network | | +| areaCodeC | AreaCode | C | 0..1 | Area Code for 5G-CRG/FN-CRG is accessing via wireline access network | | +| combGciAndHfcNIds | array(CombGciAndHfcNIds) | C | 1..N | List of combinations of GCI and HFC Node ID, for a 5G-CRG or an AUN3 device behind the 5G-CRG accessing the 5GC via wireline access network. | | + +NOTE: One and only one of the "globalLineIds", "hfcNIds", "areaCodeB", "areaCodeC" and "combGciAndHfcNIds" attributes shall be included in a WirelineArea data structure. + +## 5.4.4.39 Type: WirelineServiceAreaRestriction + +Table 5.4.4.39-1: Definition of type WirelineServiceAreaRestriction + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| restrictionType | RestrictionType | C | 0..1 | string
"ALLOWED_AREAS" or
"NOT_ALLOWED_AREAS"
(NOTE 1) | +| areas | array(WirelineArea) | C | 0..N | A list of Areas.
These areas are:
- allowed areas if RestrictionType is "ALLOWED_AREAS"
- not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS"
(NOTE 1) (NOTE 2) | + +NOTE 1: The "restrictionType" attribute and the "areas" attribute shall be either both present or absent. +NOTE 2: The empty array is used when service is allowed/restricted nowhere. + +#### 5.4.4.40 Type: ApnRateStatus + +**Table 5.4.4.40-1: Definition of type ApnRateStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| remainPacketsUI | integer | C | 0..1 | This IE shall be included if available.
When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in 3GPP TS 23.401 [33]). | +| remainPacketsDI | integer | C | 0..1 | This IE shall be included if available.
When present, it shall contain the number of packets, which the UE is allowed to send downlink for the given time unit period of time and for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]). | +| validityTime | DateTime | C | 0..1 | This IE shall be included if available.
When present, it shall indicate the period of time during which the APN rate control status will remain valid. | +| remainExReportsUI | integer | C | 0..1 | This IE shall be included if available.
When present, it shall indicate the number of additional exception reports the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]). | +| remainExReportsDI | integer | C | 0..1 | This IE shall be included if available.
When present, it shall indicate the number of additional exception reports the AF is allowed to send downlink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]). | + +#### 5.4.4.41 Type: ScheduledCommunicationTime + +**Table 5.4.4.41-1: Definition of type ScheduledCommunicationTime** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------| +| daysOfWeek | array(DayOfWeek) | O | 1..6 | Identifies the day(s) of the week. If absent, it indicates every day of the week. | +| timeOfDayStart | TimeOfDay | O | 0..1 | Identifies the start time of the day. | +| timeOfDayEnd | TimeOfDay | O | 0..1 | Identifies the end time of the day. | + +#### 5.4.4.42 Type: ScheduledCommunicationTimeRm + +This data type is defined in the same way as the "ScheduledCommunicationTime" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.43 Type: BatteryIndication + +**Table 5.4.4.43-1: Definition of type BatteryIndication** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| batteryInd | boolean | O | 0..1 | When present, this IE shall indicate whether the UE is battery powered or not.
true: the UE is battery powered;
false or absent: the UE is not battery powered. | +| replaceableInd | boolean | O | 0..1 | When present, this IE shall indicate whether the battery of the UE is replaceable or not.
true: the battery of the UE is replaceable;
false or absent: the battery of the UE is not replaceable. | +| rechargeableInd | boolean | O | 0..1 | When present, this IE shall indicate whether the battery of the UE is rechargeable or not.
true: the battery of UE is rechargeable;
false or absent: the battery of the UE is not rechargeable. | +| NOTE: Parameters "replaceableInd" and "rechargeableInd" are only included if the value of Parameter "batteryInd" is true. | | | | | + +#### 5.4.4.44 Type: BatteryIndicationRm + +This data type is defined in the same way as the "BatteryIndication" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.45 Type: AcsInfo + +**Table 5.4.4.45-1: Definition of type AcsInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| acsUrl | Uri | O | 0..1 | This IE may contain the URL of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE) | +| acslpv4Addr | lpv4Addr | O | 0..1 | This IE may contain the IPv4 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE) | +| acslpv6Addr | lpv6Addr | O | 0..1 | This IE may contain the IPv6 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE) | +| NOTE: At least one of acsUrl, acslpv4Addr, acslpv6Addr shall be included. | | | | | + +#### 5.4.4.46 Type: AcsInfoRm + +This data type is defined in the same way as the "AcsInfo" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.47 Type: NrV2xAuth + +**Table 5.4.4.47-1: Definition of type NrV2xAuth** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------| +| vehicleUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE. | +| pedestrianUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE. | + +## 5.4.4.48 Type: LteV2xAuth + +Table 5.4.4.48-1: Definition of type LteV2xAuth + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------| +| vehicleUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE. | +| pedestrianUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE. | + +## 5.4.4.49 Type: Pc5QoSPara + +Table 5.4.4.49-1: Definition of type Pc5QoSPara + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pc5QosFlowList | array(Pc5QosFlowItem) | M | 1..N | This IE shall contain the set of PC5 flow(s). | +| pc5LinkAmbr | BitRate | C | 0..1 | This IE shall be present if available. When present, it shall represent the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows (see clause 5.4.2.3 of 3GPP TS 23.287 [36]). | + +## 5.4.4.50 Type: Pc5QosFlowItem + +Table 5.4.4.50-1: Definition of type Pc5QosFlowItem + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| pqi | 5Qi | M | 1 | PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [36]). | +| pc5FlowBitRates | Pc5FlowBitRates | C | 0..1 | This IE shall be present if available. When present, it shall represent the PC5 Flow Bit Rates (see clause 5.4.2.2 of 3GPP TS 23.287 [36]). | +| range | Uinteger | C | 0..1 | This IE shall be present if available. When present, it shall represent the Range in the unit of meters (see clause 5.4.2.4 of 3GPP TS 23.287 [36]). | + +## 5.4.4.51 Type: Pc5FlowBitRates + +Table 5.4.4.51-1: Definition of type Pc5FlowBitRates + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| guaFbr | BitRate | C | 0..1 | This IE shall be present if available. When present, it shall contain the guaranteed Bit Rate for the PC5 QoS flow. | +| maxFbr | BitRate | C | 0..1 | This IE shall be present if available. When present, it shall contain the maximum Bit Rate for the PC5 QoS flow. | + +## 5.4.4.52 Type: UltraLocation + +Table 5.4.4.52-1: Definition of type UltraLocation + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cgi | CellGlobalId | O | 0..1 | Cell Global Identification. See 3GPP TS 23.003 [7], clause 4.3.1 (NOTE 1) | +| sai | ServiceAreaId | O | 0..1 | Service Area Identifier. See 3GPP TS 23.003 [7], clause 12.5 (NOTE 1) | +| lai | LocationAreaId | O | 0..1 | Location area identification. See 3GPP TS 23.003 [7], clause 4.1 (NOTE 1) | +| rai | RoutingAreaId | O | 0..1 | Routing Area Identification. See 3GPP TS 23.003 [7], clause 4.2 | +| ageOfLocationInformation | integer | O | 0 1 | The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 [21] clause 17.7.8. | +| ueLocationTimestamp | DateTime | O | 0..1 | The value represents the UTC time when the UeLocation information was acquired. | +| geographicalInformation | string | O | 0..1 | Refer to geographical Information. See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used. Allowed characters are 0-9 and A-F; | +| geodeticInformation | string | O | 0..1 | Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used. Allowed characters are 0-9 and A-F. | + +NOTE 1: Exactly one of cgi, sai or lai shall be present. + +## 5.4.4.53 Type: GeraLocation + +Table 5.4.4.53-1: Definition of type GeraLocation + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locationNumber | string | O | 0..1 | Location number within the PLMN. See 3GPP TS 23.003 [7], clause 4.5. | +| cgi | CellGlobalId | O | 0..1 | Cell Global Identification. See 3GPP TS 23.003 [7], clause 4.3.1 (NOTE 1) | +| rai | RoutingAreaId | O | 0..1 | Routing Area Identification. See 3GPP TS 23.003 [7], clause 4.2 (NOTE 1) | +| sai | ServiceAreaId | O | 0..1 | Service Area Identifier. See 3GPP TS 23.003 [7], clause 12.5 (NOTE 1) | +| lai | LocationAreaId | O | 0..1 | Location Area identification. See 3GPP TS 23.003 [7], clause 4.1 (NOTE 1) | +| vlrNumber | string | O | 0..1 | VLR number. See 3GPP TS 23.003 [7] clause 5.1. | +| mscNumber | string | O | 0..1 | MSC number. See 3GPP TS 23.003 [7] clause 5.1. | +| ageOfLocationInformation | integer | O | 0..1 | The value represents the elapsed time in minutes since the last network contact of the mobile station. Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode. Any other value than "0" indicates that the location information is the last known one. See 3GPP TS 29.002 [21] clause 17.7.8. | +| ueLocationTimestamp | DateTime | O | 0..1 | The value represents the UTC time when the UeLocation information was acquired. | +| geographicalInformation | string | O | 0..1 | Refer to geographical Information. See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used. Allowed characters are 0-9 and A-F; | +| geodeticInformation | string | O | 0..1 | Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used. Allowed characters are 0-9 and A-F. | + +NOTE 1: Exactly one of cgi, rai, sai or lai shall be present. + +## 5.4.4.54 Type: CellGlobalId + +Table 5.4.4.54-1: Definition of type CellGlobalId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| lac | string | M | 1 | Location Area Code
Pattern: '[A-Fa-f0-9]{4}\$' | +| cellId | string | M | 1 | Cell Identity
Pattern: '[A-Fa-f0-9]{4}\$' | + +## 5.4.4.55 Type: ServiceAreaId + +Table 5.4.4.55-1: Definition of type ServiceAreaId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| lac | string | M | 1 | Location Area Code
Pattern: '[A-Fa-f0-9]{4}\$' | +| sac | string | M | 1 | Service Area Code
Pattern: '[A-Fa-f0-9]{4}\$' | + +## 5.4.4.56 Type: LocationAreaId + +Table 5.4.4.56-1: Definition of type LocationAreaId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| lac | string | M | 1 | Location Area Code
Pattern: '[A-Fa-f0-9]{4}\$' | + +## 5.4.4.57 Type: RoutingAreaId + +Table 5.4.4.57-1: Definition of type RoutingAreaId + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN Identity | +| lac | string | M | 1 | Location Area Code
Pattern: '[A-Fa-f0-9]{4}\$' | +| rac | string | M | 1 | Routing Area Code
Pattern: '[A-Fa-f0-9]{2}\$' | + +## 5.4.4.58 Type: DddTrafficDescriptor + +Table 5.4.4.58-1: Definition of type DddTrafficDescriptor + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|----------------------------------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | Ipv4 address of the source of downlink data. | +| ipv6Addr | Ipv6Addr | C | 0..1 | Ipv6 address of the source of downlink data. | +| portNumber | UInteger | O | 0..1 | Port number of the source of downlink data. | +| macAddr | MacAddr48 | C | 0..1 | Source MAC address. | +| NOTE: Either IP address (at least one of the "ipv4Addr" attribute or the "ipv6Addr" attribute) or MAC address (the "macAddr" attribute) shall be included. | | | | | + +## 5.4.4.59 Type: MoExpDataCounter + +Table 5.4.4.59-1: Definition of type MoExpDataCounter + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------| +| counter | integer | M | 1 | Unsigned integer identifying the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501 [8]. | +| timeStamp | DateTime | O | 0..1 | UTC time indicating the time at which the counter value increased from 0 to 1. | + +#### 5.4.4.60 Type: NssaaStatus + +**Table 5.4.4.60-1: Definition of type NssaaStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------| +| snssai | Snssai | M | 1 | Subscribed S-NSSAI | +| status | AuthStatus | M | 1 | This flag when present shall indicate the NSSAA status of the related Snssai. | + +#### 5.4.4.61 Type: NssaaStatusRm + +This data type is defined in the same way as the "NssaaStatus" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.62 Type: TnapiId + +**Table 5.4.4.62-1: Definition of type TnapiId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ssld | string | C | 0..1 | This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31]. | +| bssld | string | C | 0..1 | This IE shall be present if available. When present, it shall contain the BSSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31]. | +| civicAddress | Bytes | C | 0..1 | This IE shall be present if available. When present, it shall contain the civic address information of the TNAP to which the UE is attached, including the Location-Information Attribute and / or Location-Data Attribute as defined in IETF RFC 5580 [40]. | + +#### 5.4.4.63 Type: TnapiIdRm + +This data type is defined in the same way as the "TnapiId" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.64 Type: TwapiId + +**Table 5.4.4.64-1: Definition of type TwapiId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ssld | string | M | 1 | This IE shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31]. | +| bssld | string | C | 0..1 | This IE shall be present if available. When present, it shall contain the BSSID of the access point to which the UE is attached, for trusted WLAN access, see IEEE Std 802.11-2012 [31]. | +| civicAddress | Bytes | C | 0..1 | This IE shall be present if available. When present, it shall contain the civic address information of the TWAP to which the UE is attached, for trusted WLAN access. This IE shall include the Location-Information Attribute and / or Location-Data Attribute as defined in IETF RFC 5580 [40]. | + +#### 5.4.4.65 Type: TwapIdRm + +This data type is defined in the same way as the "TwapId" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.66 Type: SnssaiExtension + +**Table 5.4.4.66-1: Definition of type SnssaiExtension** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sdRanges | array(SdRange) | C | 1..N | When present, it shall contain the range(s) of Slice Differentiator values supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type (see clause 5.4.4.2). | +| wildcardSd | boolean | C | 0..1 | When present, it shall be set to true, to indicate that all SD values are supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type (see clause 5.4.4.2). | + +NOTE 1: sdRanges and wildcardSd shall not be present simultaneously. +NOTE 2: An SdRange may include the value "FFFFFF"; similarly, if wildcardSd is set to true, the SD value "FFFFFF" is one of the supported values. In both cases the SST without associated SD is one of the supported SNSSAIs, as the value "FFFFFF" indicates "no SD value associated with the SST" (see 3GPP TS 23.003 [7]). + +#### 5.4.4.67 Type: SdRange + +**Table 5.4.4.67-1: Definition of type SdRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | M | 1 | First value identifying the start of an SD range.

This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2. | +| end | string | M | 1 | Last value identifying the end of an SD range.

This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2. | + +EXAMPLE: SD range from 023400 to 023499 (hexadecimal) +JSON: { "start": "023400", "end": "023499" } + +## 5.4.4.68 Type: ProseServiceAuth + +Table 5.4.4.68-1: Definition of type ProseServiceAuth + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| proseDirectDiscoveryAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Discovery. | +| proseDirectCommunicationAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Communication. | +| proseL2RelayAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 UE-to-Network Relay. | +| proseL3RelayAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-Network Relay. | +| proseL2RemoteAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 Remote UE. | +| proseL3RemoteAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 Remote UE. | +| proseMultipathComL2RemoteAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use multi-path communication via direct Uu path and via 5G ProSe Layer-2 UE-to-Network Relay as a 5G ProSe Layer-2 Remote UE. | +| proseL2UeRelayAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 UE-to-UE Relay. | +| proseL3UeRelayAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-UE Relay. | +| proseL2EndAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 End UE. | +| proseL3EndAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 End UE. | + +## 5.4.4.69 Type: EcsServerAddr + +Table 5.4.4.69-1: Definition of type EcsServerAddr + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------| +| ecsFqdnList | array(Fqdn) | C | 1..N | This IE shall be included if available. When present, it shall contain the list of FQDN(s) of Edge Configuration Server(s). | +| ecsIpAddressList | array(IpAddr) | C | 1..N | This IE shall be included if available. When present, it shall contain the list of IP Address(es) of Edge Configuration Server(s). | +| ecsUriList | array(Uri) | C | 1..N | This IE shall be included if available. When present, it shall contain the list of URI(s) of the Edge Configuration Server(s). | +| ecsProviderId | string | C | 0..1 | This IE shall be included if available. When present, it shall contain the identifier of the Edge Configuration Server Provider. | + +#### 5.4.4.70 Type: EcsServerAddrRm + +This data type is defined in the same way as the "EcsServerAddr" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.71 Type: IpAddr + +**Table 5.4.4.71-1: Definition of type IpAddr** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------|------------|---|-------------|--------------------------------------------------| +| ipv4Addr | Ipv4Addr | C | 0..1 | When present, it shall contain the IPv4 address. | +| ipv6Addr | Ipv6Addr | C | 0..1 | When present, it shall contain the IPv6 address. | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | When present, it shall contain the IPv6 Prefix. | +| NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present. | | | | | + +## 5.4.4.72 Type: SACInfo + +**Table 5.4.4.72-1: Definition of type SACInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| numericValNumUes | integer | C | 0..1 |

This attribute may be present in the following cases:

  • - to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;
  • - to report the network slice status for the current number of registered UEs.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of registered UEs expressed in a numerical value.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.

For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was previously configured in the form of a numerical value, this attribute shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.

| +| numericValNumPduSess | integer | C | 0..1 |

This attribute may be present in the following cases:

  • - to configure the monitoring threshold for the reporting of the number established PDU session for a network slice identified by an S-NSSAI;
  • - to report the network slice status for the number of established PDU sessions.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of established PDU sessions expressed in a numerical value.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.

For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured in the form of a numerical value,, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.

| +| percValueNumUes | integer | C | 0..1 |

This attribute may be present in the following cases:

  • - to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;
  • - to report the network slice status for the number of registered UEs .

When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of registered UEs expressed in percentage format.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed as a percentage. For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was

| + +| | | | | | +|--------------------------|---------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | previously configured as a percentage, this attribute shall contain the current number of registered UEs in the concerned network slice expressed as a percentage.

Minimum = 0. Maximum = 100. | +| percValueNumPduSessions | integer | C | 0..1 | This IE may be present in the following cases:
- to configure the monitoring threshold for the reporting of the number of established PDU sessions for a network slice identified by an S-NSSAI;
- to report the network slice status for the number of established PDU sessions.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of established PDU sessions expressed in percentage format.

When used to report the status of an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.
For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured as a percentage, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.

Minimum = 0. Maximum = 100. | +| uesWithPduSessionI
nd | boolean | C | 0..1 | This IE may be present if the numericValNumUes IE or the percValueNumUes IE is present, when reporting the network slice status for an S-NSSAI.

When present, it shall be set as follows:
- True: the numericValNumUes and percValueNumUes report the number of UEs with at least one PDU session/PDN connection.

- False (default): the numericValNumUes and percValueNumUes report the current number of registered UEs. | + +#### 5.4.4.73 Type: SACEventStatus + +**Table 5.4.4.73-1: Definition of type SACEventStatus** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reachedNumUes | SACInfo | O | 0..1 | Contains a confirmation that the requested threshold for the number of registered UEs in the concerned network slice was reached, when threshold based reporting is used, or the current number of registered UEs in the concerned network slice, when periodic reporting / immediate reporting is used. | +| reachedNumPduSessions | SACInfo | O | 0..1 | Contains a confirmation that the requested threshold for the number of established PDU session in the concerned network slice was reached, when threshold based reporting is used, or the current number of established PDU sessions in the concerned network slice, when periodic reporting / immediate reporting is used. | + +#### 5.4.4.74 Type: SpatialValidityCond + +**Table 5.4.4.74-1: Definition of type SpatialValidityCond** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| trackingAreaList | array(Tai) | C | 1..N | This IE shall be included if available. When present, it shall contain the list of tracking areas identities. | +| countries | array(Mcc) | O | 1..N | When present, it shall contain the list of Mobile Country Codes. | +| geographicalServiceArea | GeoServiceArea | O | 0..1 | Geographical Service Area; see 3GPP TS 23.558 [49] clause 7.3.3.3 | + +#### 5.4.4.75 Type: SpatialValidityCondRm + +This data type is defined in the same way as the "SpatialValidityCond" data type, but with the OpenAPI "nullable: true" property. + +#### 5.4.4.76 Type: ServerAddressingInfo + +**Table 5.4.4.76 -1: Definition of type ServerAddressingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------| +| ipv4Addresses | array(Ipv4Addr) | C | 1..N | IPv4 address(es) of the server (NOTE). | +| ipv6Addresses | array(Ipv6Addr) | C | 1..N | IPv6 address(es) of the server (NOTE). | +| fqdnList | array(Fqdn) | C | 1..N | List of FQDNs (Fully Qualified Domain Names) of the server (NOTE). | + +NOTE: At least one of the addressing parameters (ipv4addresses, ipv6addresses or fqdnList) shall be included in the ServerAddressingInfo; all addressing parameters in this data type shall be understood as referring to a same sever. + +#### 5.4.4.77 Type PcfUeCallbackInfo + +**Table 5.4.4.77-1: Definition of type PcfUeCallbackInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| callbackUri | Uri | M | 1 | This IE shall contain the Callback URI on the PCF for a UE to receive the SM Policy Association Establishment and Termination Event Notifications from the PCF for a PDU session. | | +| bindingInfo | string | O | 0..1 | This IE shall be present, if available.

When present, this IE shall contain the Binding indications of the Callback URI on the PCF for a UE indicated by callbackUri IE and set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [25], without the header name. | | + +### 5.4.4.78 Type PduSessionInfo + +**Table 5.4.4.78-1: Definition of type PduSessionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | This IE shall indicate the S-NSSAI in the serving PLMN of a PDU session. | | +| dnn | Dnn | M | 1 | This IE shall Indicate the DNN of a PDU session.

If DNN replacement if applicable for the PDU session, this IE shall indicate the DNN of the PDU session after DNN replacement. | | + +### 5.4.4.79 Type EaslpReplacementInfo + +**Table 5.4.4.79-1: Definition of type EaslpReplacementInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| source | EasServerAddress | M | 1 | Address of the source EAS, i.e., address that shall be used for the traffic on the N3 side of the UPF(s). | | +| target | EasServerAddress | M | 1 | Address of the target EAS, i.e., address that shall be used for the traffic on the N6 side of the UPF(s). | | + +### 5.4.4.80 Type EasServerAddress + +**Table 5.4.4.80-1: Definition of type EasServerAddress** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------|---------------| +| ip | lpAddr | M | 1 | IP address information. | | +| port | Uinteger | M | 1 | IP port number. | | + +### 5.4.4.81 Type RoamingRestrictions + +**Table 5.4.4.81-1: Definition of type RoamingRestrictions** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------|---------------| +| accessAllowed | boolean | C | 0..1 | Indicates if access is allowed to a given serving network, e.g. a PLMN (MCC, MNC) or an SNPN (MCC, MNC, NID). NOTE | | +| NOTE: The actual query determines if the 'accessAllowed' attribute refers to an SNPN or to a PLMN. | | | | | | + +### 5.4.4.82 Type: GeoServiceArea + +**Table 5.4.4.82-1: Definition of type GeoServiceArea** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------------|---|-------------|---------------------------------------------------------------------| +| geographicAreaList | array(Geographic Area) | O | 1..N | Identifies a list of geographic area specified by different shapes. | +| civicAddressList | array(CivicAddress) | O | 1..N | Identifies a list of civic address. | + +#### 5.4.4.83 Type: MutingExceptionInstructions + +**Table 5.4.4.83-1: Definition of type MutingExceptionInstructions** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bufferedNotifs | BufferedNotificationsAction | O | 0..1 | When present, it shall indicate the action required by the NF Service Consumer to the NF Service Producer on the buffered notifications if an exception occurs while the event is muted. | +| subscription | SubscriptionAction | O | 0..1 | When present, it shall indicate the action required by the NF Service Consumer to the NF Service Producer on the subscription if an exception occurs while the event is muted. | + +#### 5.4.4.84 Type: MutingNotificationsSettings + +**Table 5.4.4.84-1: Definition of type MutingNotificationsSettings** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-------------|---|-------------|---------------------------------------------------------------------------------------| +| maxNoOfNotif | integer | O | 0..1 | Maximum number of notifications that can be stored by the Event producer NF. | +| durationBufferedNotif | DurationSec | O | 0..1 | Maximum duration during which notifications can be buffered by the Event producer NF. | + +## 5.4.4.85 Type: VplmnOffloadingInfo + +Table 5.4.4.85-1: Definition of type VplmnOffloadingInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| offloadIdentifier | OffloadIdentifier | O | 0..1 | Offload Identifier uniquely identifying the VPLMN Offloading information provided by the HPLMN. | +| vplmnId | PlmnId | O | 0..1 | V-PLMN ID. When absent, the PLMN ID of the PLMN serving the UE shall be assumed. | +| allowedTraffic | boolean | O | 0..1 | When present, this IE shall be set as follows:
- true (default): the VplmnOffloadingInfo describes the traffic allowed to be offloaded
- false: the VplmnOffloadingInfo describes the traffic disallowed to be offloaded | +| ipv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN | +| ipv4AddrMasks | array(Ipv4AddrMask) | O | 1..N | List of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN, whereby each range of IPv4 addresses corresponds to the IPv4 addresses of an IPv4 subnet defined by an IPv4 address and subnet mask. | +| ipv6AddressRanges | array(Ipv6AddressRange) | O | 1..N | List of ranges of IPv6 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN | +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of IPv6 prefixes allowed (or disallowed) to be routed to the local part of DN in the VPLMN | +| fqdnList | array(Fqdn) | O | 1..N | List of FQDNs allowed (or disallowed) to be routed to the local part of DN in the VPLMN | +| fqdnPatterns | array(FqdnPatternMatchingRule) | O | 1..N | List of FQDN patterns of FQDNs allowed (or disallowed) to be routed to the local part of DN in the VPLMN | +| sessionDIAmbr | BitRate | O | 0..1 | Authorized DL Session AMBR for Offloading, i.e. DL Aggregate Maximum Bit Rate for the Non-GBR QoS Flows of the PDU Session authorized for offloading to the local part of DN in VPLMN. | + +NOTE: If none of the ipv4AddressRanges, ipv4AddrMasks, ipv6AddressRanges, ipv6PrefixRanges, fqdnList and fqdnPatterns IEs is present, all the traffic of the PDU session is allowed to be routed to the local part of DN in the VPLMN. At least one of these IEs shall be present when the allowedTraffic IE is set to false. + +## 5.4.4.86 Type: PartiallyAllowedSnssai + +Table 5.4.4.86-1: Definition of type PartiallyAllowedSnssai + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| snssai | Snssai | M | 1 | This IE shall indicate the S-NSSAI that is partially allowed in the Registration Area. | +| allowedTaiList | array(Tai) | M | 1..N | This IE shall contain the list of TAI(s) in the Registration Area where the indicated S-NSSAI is allowed. | + +#### 5.4.4.87 Type: VarRepPeriod + +**Table 5.4.4.87-1: Definition of type VarRepPeriod** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| repPeriod | DurationSec | M | 1 | This IE describes the period time for the variable event reports. | +| percValueNfLoad | UInteger | C | 0..1 | This IE shall be present if the variable reporting periodicity is based on the load of NF service producer (see 3GPP TS 23.502 [28], clause 4.15.1). When present, this IE indicates the load percentage of NF service producer, within the range 0 to 100. | + +NOTE: The reporting periodicity is changed depending on the load of NF service producer, if the load of NF service producer is equal or greater than several values in array of VarRepPeriod, the repPeriod related to the highest value of nfLoad shall be applied. + +#### 5.4.4.88 Type: RangingSIPosAuth + +**Table 5.4.4.88-1: Definition of type RangingSIPosAuth** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| rgSIPosTargetAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as Target UE. | +| rgSIPosSIRefAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as SL Reference UE. | +| rgSIPosLocAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as Located UE. | +| rgSIPosClientAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as SL Positioning Client UE. | +| rgSIPosServerAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as SL Positioning Server UE. | + +#### 5.4.4.89 Type: NrA2xAuth + +**Table 5.4.4.89-1: Definition of type NrA2xAuth** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| uavUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as UAV UE. | + +#### 5.4.4.90 Type: LteA2xAuth + +**Table 5.4.4.90-1: Definition of type LteA2xAuth** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| uavUeAuth | UeAuth | C | 0..1 | This IE shall be present if available. When present, it shall indicate whether the UE is authorized as UAV UE. | + +## 5.4.4.91 Type: SliceUsageControlInfo + +Table 5.4.4.91-1: Definition of type SliceUsageControlInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------|-------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | Snssai | M | 1 | S-NSSAI | +| deregInactTimer | DurationSec | C | 0..1 | Identifies the slice deregistration inactivity timer for the Network Slice identified by the sNssai IE (see 3GPP TS 23.501 [8], clause 5.15.15.3)
(NOTE) | +| sessInactTimer | DurationSec | C | 0..1 | Identifies the slice PDU Session inactivity timer for the Network Slice identified by the sNssai IE (see 3GPP TS 23.501 [8], clause 5.15.15.3)
(NOTE) | +| NOTE: At least deregInactTimer or sessInactTimer shall be present. | | | | | + +## 5.4.4.92 Type: CombGciAndHfcNids + +Table 5.4.4.92-1: Definition of type CombGciAndHfcNids + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| globalCableId | Gci | C | 0..1 | Global Cable Identifier, for an AUN3 device behind 5G-CRG accessing the 5GC via wireline access network. | | +| hfcNId | HfcNId | C | 0..1 | HFC Node Id, for an AUN3 device behind 5G-CRG accessing the 5GC via wireline access network. | | + +## 5.4.4.93 Type: SnssaiDnnItem + +Table 5.4.4.93-1: Definition of type SnssaiDnnItem + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|-------------|------------------| +| sNssaiList | array(ExtSnssai) | C | 1..N | List of S-NSSAIs | +| dnnList | array(Dnn) | C | 1..N | List of DNNs | +| NOTE: At least one of the snssaiList and dnnList IEs shall be present.
If the dnnList IE is absent, this indicates that all DNNs of the provided S-NSSAIs are considered.
If the sNssaiList IE is absent, this indicates that all S-NSSAIs of the provided DNNs are considered.
If both IEs are present, this indicates that the provided DNNs for the provided S-NSSAIs are considered. | | | | | + +## 5.4.4.94 Type: NtnTailInfo + +Table 5.4.4.94-1: Definition of type NtnTailInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|--------------------------------------------------------------------------------| +| plmnId | PlmnIdNid | M | 1 | UE's serving PLMN Identity | +| tacList | array(Tac) | M | 1..N | TAC list received from satellite NG-RAN without the forbidden TAs for the UE | +| derivedTac | Tac | O | 0..1 | This attribute may be present if Derived TAC is received from satellite NG-RAN | + +## 5.4.5 Data types describing alternative data types or combinations of data types + +### 5.4.5.1 Type: ExtSnssai + +**Table 5.4.5.1-1: Definition of type ExtSnssai as a list of to be combined data types** + +| Data type | Cardinality | Description | +|-----------------|-------------|-----------------------------------------------------------------------| +| Snssai | 1 | Common data type defined in clause 5.4.4.2. | +| SnssaiExtension | 1 | Extensions to the Snssai common data type defined in clause 5.4.4.66. | + +NOTE: The sdRanges and wildcardSd attributes shall be exclusive from each other. If one of these attributes is present, the sd attribute shall also be present and it shall contain one Slice Differentiator value within the range of SD (if the sdRanges attribute is present) or with any value (if the wildcardSd attribute is present). + +### 5.4.5.2 Type: SnssaiReplaceInfo + +**Table 5.4.5.2-1: Definition of type SnssaiReplaceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssai | Snssai | M | 1 | Indicates the impacted S-NSSAI. | +| status | SnssaiStatus | C | 0..1 | It shall be present, if the status of the S-NSSAI indicated in the snssai IE changes.
When present, it indicates the availability status of the S-NSSAI indicated in the snssai IE. | +| altSnssai | Snssai | C | 0..1 | It shall be present, if the alternative S-NSSAI is requested to replace the S-NSSAI indicated in snssai IE.
When present, this IE shall indicate the alternative S-NSSAI NSSAI to the impacted S-NSSAI indicated by the "snssai" attribute.

In the case of roaming it shall indicate:
- the alternative VPLMN S-NSSAI for replacement of the impacted VPLMN S-NSSAI, when the snssai IE contains a VPLMN S-NSSAI; or

- the alternative HPLMN S-NSSAI for replacement of the impacted HPLMN S-NSSAI, when the snssai IE contains an HPLMN S-NSSAI. | +| nsReplTerminInd | TerminationIndication | C | 0..1 | This IE shall be present for a notification of termination of Network Slice Replacement. | +| plmnId | PlmnId | C | 0..1 | This IE shall be present in roaming scenarios, if the impacted S-NSSAI indicated by the snssai IE is an HPLMN S-NSSAI. It may be present otherwise. When present, it shall indicate the PLMN ID of the impacted S-NSSAI (and alternative S-NSSAI). | + +## 5.5 Data Types related to 5G QoS + +### 5.5.1 Introduction + +This clause defines common data types related to 5G QoS. + +## 5.5.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.5.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|--------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Qfi | integer | Unsigned integer identifying a QoS flow, within the range 0 to 63. | +| QfiRm | integer | This data type is defined in the same way as the "Qfi" data type, but with the OpenAPI "nullable: true" property. | +| 5Qi | integer | Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501 [8]), within the range 0 to 255. | +| 5QiRm | integer | This data type is defined in the same way as the "5Qi" data type, but with the OpenAPI "nullable: true" property. | +| BitRate | string | String representing a bit rate that shall be formatted as follows:

Pattern: '^\\d+(\\.\\d+)? (bps Kbps Mbps Gbps Tbps)\$'

(NOTE)

Examples:
"125 Mbps", "0.125 Gbps", "125000 Kbps" | +| BitRateRm | string | This data type is defined in the same way as the "BitRate" data type, but with the OpenAPI "nullable: true" property. | +| PacketRate | string | String representing a packet rate, i.e. packets per second, that shall be formatted as follows:

Pattern: '^\\d+(\\.\\d+)? (pps kpps Mpps Gpps Tpps)\$'

(NOTE)

Examples:
"125 Mpps", "0.125 Gpps", "125000 kpps" | +| PacketRateRm | string | This data type is defined in the same way as the "PacketRate" data type, but with the OpenAPI "nullable: true" property. | +| TrafficVolume | string | String representing a traffic volume measured in bytes that shall be formatted as follows:

Pattern: '^\\d+(\\.\\d+)? (B kB MB GB TB)\$'

(NOTE)

Examples:
"125 MB", "0.125 GB", "125000 kB" | +| TrafficVolumeRm | string | This data type is defined in the same way as the "TrafficVolume" data type, but with the OpenAPI "nullable: true" property. | +| ArpPriorityLevel | integer | Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501 [8]), within the range 1 to 15. Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 15 as the lowest priority. | +| ArpPriorityLevelRm | integer | This data type is defined in the same way as the "ArpPriorityLevel" data type, but with the OpenAPI "nullable: true" property. | +| 5QiPriorityLevel | integer | Unsigned integer indicating the 5Qi Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501 [8]), within the range 1 to 127. Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 127 as the lowest priority. | +| 5QiPriorityLevelRm | integer | This data type is defined in the same way as the "5QiPriorityLevel" data type, but with the OpenAPI "nullable: true" property. | +| PacketDelBudget | integer | Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8])), expressed in milliseconds.
Minimum = 1. | +| PacketDelBudgetRm | integer | This data type is defined in the same way as the "PacketDelBudget" data type, but with the OpenAPI "nullable: true" property. | +| PacketErrRate | string | String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501 [8]), expressed as a "scalar x 10-k" | + +| | | | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | where the scalar and the exponent k are each encoded as one decimal digit.
Pattern: '^[0-9]E-[0-9]\$'
Examples:
Packer Error Rate $4 \times 10^{-6}$ shall be encoded as "4E-6".
Packer Error Rate $10^{-2}$ shall be encoded as "1E-2". | +|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | +|-----------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PacketErrRateRm | string | This data type is defined in the same way as the "PacketErrRate" data type, but with the OpenAPI "nullable: true" property. | +| PacketLossRate | integer | Unsigned integer indicating Packet Loss Rate (see clauses 5.7.2.8 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in tenth of percent.
Minimum = 0. Maximum = 1000. | +| PacketLossRateRm | integer | This data type is defined in the same way as the "PacketLossRate" data type, but with the OpenAPI "nullable: true" property. | +| AverWindow | integer | Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in milliseconds.
Minimum = 1. Maximum = 4095. Default = 2000.. | +| AverWindowRm | integer | This data type is defined in the same way as the "AverWindow" data type, but with the OpenAPI "nullable: true" property. | +| MaxDataBurstVol | integer | Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.
Minimum = 1. Maximum = 4095. | +| MaxDataBurstVolRm | integer | This data type is defined in the same way as the "MaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property. | +| SamplingRatio | integer | Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502 [28]), expressed in percent.
Minimum = 1. Maximum = 100 | +| SamplingRatioRM | integer | This data type is defined in the same way as the "SamplingRatio" data type, but with the OpenAPI "nullable: true" property. | +| RgWirelineCharacteristics | Bytes | RG Level Wireline Access Characteristics (see BBF TR-456 [41] and BBF TR-470 [37]). It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64 encoded characters, representing the RG-Level Wireline Access Characteristics encoded as specified in clause 7.5 of BBF TR-470 [37]. | +| RgWirelineCharacteristicsRm | Bytes | This data type is defined in the same way as the "RgWirelineCharacteristics" data type, but with the OpenAPI "nullable: true" property. | +| ExtMaxDataBurstVol | integer | Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.
Minimum = 4096. Maximum = 2000000. | +| ExtMaxDataBurstVolRm | integer | This data type is defined in the same way as the "ExtMaxDataBurstVol" data type, but with the OpenAPI "nullable: true" property. | +| ExtPacketDelBudget | integer | Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in 0.01 milliseconds.
Minimum = 1. | +| ExtPacketDelBudgetRm | integer | This data type is defined in the same way as the "ExtPacketDelBudget" data type, but with the OpenAPI "nullable: true" property. | +| Metadata | string | This datatype contains information that is transparently passed to UPF and the UPF provides it to the service functions in N6-LAN.

When present, this IE shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the Metadata. | +| PduSetDelayBudget | integer | Unsigned integer indicating PDU Set Delay Budget (PSDB) (see clause 5.7.7.2 of 3GPP TS 23.501 [8]), expressed in 0.01 milliseconds.
Minimum = 1. | +| PduSetDelayBudgetRm | integer | This data type is defined in the same way as the "PduSetDelayBudget" data type, but with the OpenAPI "nullable: true" property. | +| PduSetErrRate | string | String representing PDU Set Error Rate (PSER) (see clause 5.7.7.3 3GPP TS 23.501 [8]), expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit. | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Pattern: '^[0-9]E-[0-9]\$'
Examples:
PDU Set Error Rate $4 \times 10^{-6}$ shall be encoded as "4E-6".
PDU Set Error Rate $10^{-2}$ shall be encoded as "1E-2". | +| PduSetErrRateRm | string | This data type is defined in the same way as the "PduSetErrRate" data type, but with the OpenAPI "nullable: true" property. | +| NOTE: The prefixes used for bit rate unit "bps", packet rate unit "pps" and traffic volume in byte unit "B" shall be taken as $\times 1000$ multipliers and were meant to follow the standard symbols from "The International System of Units" ( https://www.bipm.org/en/measurement-units/si-prefixes ). However, even when the standard symbol for $10^3$ multiplier is "k", in the present specification it has been defined as "K", and has been kept as such due to backwards-compatibility with earlier versions of this specification. | | | + +## 5.5.3 Enumerations + +### 5.5.3.1 Enumeration: PreemptionCapability + +The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501 [8]. It shall comply with the provisions defined in table 5.5.3.1-1. + +**Table 5.5.3.1-1: Enumeration PreemptionCapability** + +| Enumeration value | Description | +|-------------------|--------------------------------| +| "NOT_PREEMPT" | Shall not trigger pre-emption. | +| "MAY_PREEMPT" | May trigger pre-emption. | + +### 5.5.3.2 Enumeration: PreemptionVulnerability + +The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501 [8]. It shall comply with the provisions defined in table 5.5.3.2-1. + +**Table 5.5.3.2-1: Enumeration PreemptionVulnerability** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "NOT_PREEMPTABLE" | Shall not be pre-empted. | +| "PREEMPTABLE" | May be pre-empted. | + +### 5.5.3.3 Enumeration: ReflectiveQosAttribute + +The enumeration ReflectiveQosAttribute indicates whether certain traffic of the QoS flow may be subject to Reflective QoS (see clause 5.7.2.3 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.3-1. + +**Table 5.5.3.3-1: Enumeration ReflectiveQosAttribute** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------------------| +| "RQOS" | Certain traffic of the QoS flow may be subject to Reflective QoS. | +| "NO_RQOS" | Traffic of the QoS flow is not subject to Reflective QoS. | + +### 5.5.3.4 Void + +### 5.5.3.5 Enumeration: NotificationControl + +The enumeration NotificationControl indicates whether notifications are requested from the RAN when the GFBR can no longer (or again) be fulfilled for a QoS Flow during the lifetime of the QoS Flow (see clause 5.7.2.4 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.5-1. + +**Table 5.5.3.5-1: Enumeration NotificationControl** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------| +| "REQUESTED" | Notifications are requested from the RAN. | +| "NOT_REQUESTED" | Notifications are not requested from the RAN. | + +### 5.5.3.6 Enumeration: QosResourceType + +The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.6-1. + +**Table 5.5.3.6-1: Enumeration QosResourceType** + +| Enumeration value | Description | +|--------------------|----------------------------------| +| "NON_GBR" | Non-GBR QoS Flow. | +| "NON_CRITICAL_GBR" | Non-delay critical GBR QoS flow. | +| "CRITICAL_GBR" | Delay critical GBR QoS flow. | + +### 5.5.3.7 Enumeration: PreemptionCapabilityRm + +This enumeration is defined in the same way as the "PreemptionCapability" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.8 Enumeration: PreemptionVulnerabilityRm + +This enumeration is defined in the same way as the "PreemptionVulnerability" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.9 Enumeration: ReflectiveQosAttributeRm + +This enumeration is defined in the same way as the "ReflectiveQosAttribute" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.10 Enumeration: NotificationControlRm + +This enumeration is defined in the same way as the "NotificationControl" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.11 Enumeration: QosResourceTypeRm + +This enumeration is defined in the same way as the "QosResourceType" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.12 Enumeration: AdditionalQosFlowInfo + +The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause 9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table 5.5.3.12-1. + +**Table 5.5.3.12-1: Enumeration AdditionalQosFlowInfo** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------------------------------------------------------------------| +| "MORE_LIKELY" | Traffic for the QoS flow is likely to appear more often than traffic for other flows established for the PDU session. | + +### 5.5.3.13 Enumeration: PartitioningCriteria + +The enumeration PartitioningCriteria indicates criteria for grouping the UEs (see clause 4.15.1 of 3GPP TS 23.502 [28]). It shall comply with the provisions defined in table 5.5.3.13-1. + +**Table 5.5.3.13-1: Enumeration PartitioningCriteria** + +| Enumeration value | Description | +|-------------------|----------------------| +| "TAC" | Type Allocation Code | +| "SUBPLMN" | Subscriber PLMN ID | +| "GEOAREA" | Geographical area | +| "SNSSAI" | S-NSSAI | +| "DNN" | DNN | + +### 5.5.3.14 Enumeration: PartitioningCriteriaRm + +This enumeration is defined in the same way as the "PartitioningCriteria" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.5.3.15 Enumeration: PduSetHandlingInfo + +The enumeration PduSetHandlingInfo indicates whether all PDUs of the PDU Set are needed for the usage of the PDU Set by the application layer in the receiver side. It shall comply with the provisions defined in table 5.5.3.15-1. + +**Table 5.5.3.15-1: Enumeration PduSetHandlingInfo** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------| +| "ALL_PDUS_NEEDED" | All PDUs of the PDU Set are needed. | +| "ALL_PDUS_NOT_NEEDED" | All PDUs of the PDU Set are not needed. | + +### 5.5.3.16 Enumeration: MediaTransportProto + +**Table 5.5.3.16-1: Enumeration MediaTransportProto** + +| Enumeration value | Description | +|-------------------|-------------------------------------| +| "RTP" | Real-time Transport Protocol | +| "SRTP" | Secure Real-time Transport Protocol | + +### 5.5.3.17 Enumeration: RtpHeaderExtType + +**Table 5.5.3.17-1: Enumeration RtpHeaderExtType** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------| +| "PDU_SET_MARKING" | RTP Header Extension for PDU Set Marking (see clause 4.4.2 of 3GPP TS 26.522 [59]) | + +Editor's note: It is FFS whether to standardize additional enumeration value. + +### 5.5.3.18 Enumeration: RtpPayloadFormat + +**Table 5.5.3.18-1: Enumeration RtpPayloadFormat** + +| Enumeration value | Description | +|-------------------|-----------------------------------------| +| "H264" | RTP payload format for H.264/AVC codec | +| "H265" | RTP payload format for H.265/HEVC codec | + +## 5.5.4 Structured Data Types + +### 5.5.4.1 Type: Arp + +**Table 5.5.4.1-1: Definition of type Arp** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| priorityLevel | ArpPriorityLevel | M | 1 | Defines the relative importance of a resource request. | +| preemptCap | PreemptionCapability | M | 1 | Defines whether a service data flow may get resources that were already assigned to another service data flow with a lower priority level. | +| preemptVuln | PreemptionVulnerability | M | 1 | Defines whether a service data flow may lose the resources assigned to it in order to admit a service data flow with higher priority level. | + +### 5.5.4.2 Type: Ambr + +**Table 5.5.4.2-1: Definition of type Ambr** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------| +| uplink | BitRate | M | 1 | AMBR for uplink | +| downlink | BitRate | M | 1 | AMBR for downlink | + +### 5.5.4.3 Type: Dynamic5Qi + +**Table 5.5.4.3-1: Definition of type Dynamic5Qi** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resourceType | QosResourceType | M | 1 | Defines the 5QI resource type. See clause 5.5.3.6. | | +| priorityLevel | 5QiPriorityLevel | M | 1 | Defines the 5QI Priority Level. See clause 5.5.2. | | +| packetDelayBudget | PacketDelBudget | M | 1 | Defines the packet delay budget. See clause 5.5.2.
See NOTE 3. | | +| packetErrRate | PacketErrRate | M | 1 | Defines the packet error rate. See clause 5.5.2. | | +| averWindow | AverWindow | C | 0..1 | Defines the averaging window. See clause 5.5.2.
This IE shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. | | +| maxDataBurstVol | MaxDataBurstVol | C | 0..1 | Defines the maximum data burst volume. See clause 5.5.2.
See NOTE 1, NOTE 2.
This IE shall be present for a Delay Critical GBR QoS flow. | | +| extMaxDataBurstVol | ExtMaxDataBurstVol | C | 0..1 | Defines the maximum data burst volume. See clause 5.5.2.
See NOTE 1, NOTE 2. | | +| extPacketDelBudget | ExtPacketDelBudget | O | 0..1 | Defines the packet delay budget. See clause 5.5.2.
See NOTE 3. | | +| cnPacketDelayBudgetDI | ExtPacketDelBudget | O | 0..1 | Defines the Core Network Packet Delay Budget for downlink. See clause 5.5.2. | | +| cnPacketDelayBudgetUI | ExtPacketDelBudget | O | 0..1 | Defines the Core Network Packet Delay Budget for uplink. See clause 5.5.2. | | + +NOTE 1: Unless specified otherwise in an API: if the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted and the extMaxDataBurstVol IE shall be omitted. If the maximum data burst volume value to be transmitted is greater than 4095 Bytes, the maxDataBurstVol IE shall be set to 4095 Bytes and, if ExtMaxDataBurstVol data type is supported by the sender, the extMaxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted. + +NOTE 2: Unless specified otherwise in an API: if both the maxDataBurstVol IE and the extMaxDataBurstVol IE are received, the value in the extMaxDataBurstVol IE shall be used if the receiver supports ExtMaxDataBurstVol data type, otherwise the value in the maxDataBurstVol IE shall be used. + +NOTE 3: Unless specified otherwise in an API: if both the packetDelayBudget IE and the extPacketDelBudget IE are received, the value in the extPacketDelBudget IE shall be used if the receiver supports ExtPacketDelBudget data type, otherwise the value in the packetDelayBudget IE shall be used. + +### 5.5.4.4 Type: NonDynamic5Qi + +**Table 5.5.4.4-1: Definition of type NonDynamic5Qi** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| priorityLevel | 5QiPriorityLevel | O | 0..1 | Defines the 5Qi Priority Level. See clause 5.5.2.
When present, it contains the 5Qi Priority Level value that overrides the standardized or pre-configured value. | | +| averWindow | AverWindow | O | 0..1 | Defines the averaging window. See clause 5.5.2.
This IE may be present for a GBR QoS flow or a Delay Critical GBR QoS flow. When present, it contains the Averaging Window that overrides the standardized or pre-configured value. | | +| maxDataBurstVol | MaxDataBurstVol | O | 0..1 | Defines the maximum data burst volume. See clause 5.5.2.
This IE may be present for a Delay Critical GBR QoS flow. When present, it contains the Maximum Data Burst Volume value that overrides the standardized or pre-configured value. See NOTE 1, NOTE 2. | | +| extMaxDataBurstVol | ExtMaxDataBurstVol | C | 0..1 | Defines the maximum data burst volume. See clause 5.5.2.
This IE may be present for a Delay Critical GBR QoS flow. When present, it contains the Maximum Data Burst Volume value that overrides the standardized or pre-configured value. See NOTE 1, NOTE 2. | | +| cnPacketDelayBudgetDI | ExtPacketDelayBudget | O | 0..1 | Defines the Core Network Packet Delay Budget for downlink. See clause 5.5.2. | | +| cnPacketDelayBudgetUI | ExtPacketDelayBudget | O | 0..1 | Defines the Core Network Packet Delay Budget for uplink. See clause 5.5.2. | | + +NOTE 1: Unless specified otherwise in an API: if the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted and the extMaxDataBurstVol IE shall be omitted. If the maximum data burst volume value to be transmitted is greater than 4095 Bytes, the maxDataBurstVol IE shall be set to 4095 Bytes and, if ExtMaxDataBurstVol data type is supported by the sender, the extMaxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted. + +NOTE 2: Unless specified otherwise in an API: if both the maxDataBurstVol IE and the extMaxDataBurstVol IE are received, the value in the extMaxDataBurstVol IE shall be used if the receiver supports ExtMaxDataBurstVol data type, otherwise the value in the maxDataBurstVol IE shall be used. + +### 5.5.4.5 Type: ArpRm + +This data type is defined in the same way as the "Arp" data type, but with the OpenAPI "nullable: true" property. + +### 5.5.4.6 Type: AmbrRm + +This data type is defined in the same way as the "Ambr" data type, but with the OpenAPI "nullable: true" property. + +### 5.5.4.7 Void + +## 5.5.4.8 Void + +## 5.5.4.9 Type: SliceMbr + +**Table 5.5.4.9-1: Definition of type SliceMbr** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------| +| uplink | BitRate | M | 1 | MBR for uplink | +| downlink | BitRate | M | 1 | MBR for downlink | + +## 5.5.4.10 Type: SliceMbrRm + +This data type is defined in the same way as the "SliceMbr" data type, but with the OpenAPI "nullable: true" property. + +## 5.5.4.11 Type: PduSetQosPara + +**Table 5.5.4.11-1: Definition of type PduSetQosPara** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSetDelayBudget | PduSetDelayBudget | O | 0..1 | Indicates the PDU Set Delay Budget. | | +| pduSetErrRate | PduSetErrRate | O | 0..1 | Indicates the PDU Set Error Rate. | | +| pduSetHandlingInfo | PduSetHandlingInfo | O | 0..1 | Indicates whether all PDUs of the PDU Set are needed for the usage of the PDU Set by the application layer in the receiver side. | | + +**Editor's Note:** The definition of these new data types need further checking and alignment with RAN3. + +## 5.5.4.12 Type: PduSetQosParaRm + +This data type is defined in the same way as the "PduSetQosPara" data type, but with the OpenAPI "nullable: true" property. + +### 5.5.4.13 Type ProtocolDescription + +**Table 5.5.4.13-1: Definition of type ProtocolDescription** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| transportProto | MediaTransportProto | O | 0..1 | When present, this IE shall indicate the transport protocol used by the media flow. | +| rtpHeaderExtInfo | RtpHeaderExtInfo | C | 0..1 | This IE shall be present if RTP or SRTP is used and the RTP payload packets contains a RTP Header Extension that can be used for PDU Set identification and/or End of Data Burst marking.

When present, this IE shall contain information on the RTP header extension that can be used for PDU Set identification and/or End of Data Burst marking.
(NOTE 1) | +| rtpPayloadInfoList | array(RtpPayloadInfo) | O | 1..N | When present, it shall contain RTP Payload information for the RTP stream, which can be used to derive the PDU Set information and/or End of Data Burst marking.
(NOTE 1) (NOTE 2) | + +NOTE 1: If the rtpPayloadInfoList is present and contains one or more Payload Type values, the UPF may only parse the RTP packets with an RTP header containing any of these Payload Type value(s). Otherwise, if the rtpPayloadInfoList is absent or does not contain any Payload Type value, the UPF should parseall the RTP packets of the media flow and use either the RTP Header Extension if included, or the Payload format to derive the PDU set information (see clause A.2 of 3GPP TS 26.522 [59]). + +NOTE 2: In this release of the specification, the rtpPayloadInfoList contains only one RtpPayloadInfo element. + +NOTE 3: Vendor/operator specific attributes may be supported as defined in clause 6.6.3 of 3GPP TS 29.500 [25]. + +EXAMPLE 1: For a media flow using RTP transport with: + +- the RTP Header Extension for PDU Set Marking (see clause 4.4.2 of 3GPP TS 26.522 [59]); +- the RTP header extension Id "3"; +- RTP packets with different PTs, where packets with PT 96 contain the RTP Header Extension, + +the Protocol Description is set to: + +``` +{ "transportProto": "RTP", "rtpHeaderExtInfo": { "rtpHeaderExtType": "PDU_SET_MARKING", "rtpHeaderExtId": 3 }, "rtpPayloadInfoList": [{ "rtpPayloadTypeList": [ 96 ]}] } +``` + +EXAMPLE 2: For a media flow using RTP transport: + +- not using any RTP Header Extension for PDU Set identification; +- H.265 payload format with Payload Types 96 and 97 (see clause A.2.3 (RTP with HEVC payload format) of 3GPP TS 26.522 [59]); + +the Protocol Description is set to: + +``` +{ "transportProto": "RTP", "rtpPayloadInfoList": [{ "rtpPayloadFormat": "H265", "rtpPayloadTypeList": [96, 97]}] } +``` + +### 5.5.4.14 Type RtpHeaderExtInfo + +**Table 5.5.4.14-1: Definition of type RtpHeaderExtInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| rtpHeaderExtType | RtpHeaderExtType | C | 0..1 | This IE shall be present if RTP or SRTP is used and the RTP payload packets contains a RTP Header Extension that can be used for PDU Set identification and/or End of Data Burst marking.

When present, it shall indicate the RTP header extension type. | +| rtpHeaderExtId | integer | C | 0..1 | Integer between and including 1 and 255.

This IE shall be present if the rtpHeaderExtType IE is present.

When present, the rtpHeaderExtId shall be set to the Id of the RTP header extension identified by the rtpHeaderExtType IE, as defined in RFC 8285 [60]. | + +NOTE: Vendor/operator specific attributes may be supported as defined in clause 6.6.3 of 3GPP TS 29.500 [25]. + +### 5.5.4.15 Type RtpPayloadInfo + +**Table 5.5.4.15-1: Definition of type RtpPayloadInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| rtpPayloadTypeList | array(integer) | C | 1..N | Integer between and including 1 and 127.

This IE shall be present when the rtpPayloadFormat is present, otherwise it may be present.

When present, this IE shall contain the list of Payload Type (PT) values in the RTP header of RTP packets the UPF may parse to derive the PDU Set Information.
(NOTE) | +| rtpPayloadFormat | RtpPayloadFormat | O | 0..1 | This IE may be present when the media flow does not use any RTP Header Extension for PDU Set identification.

When present, it shall indicate the RTP Payload format as defined in 3GPP TS 26.522 [59].
(NOTE) | + +NOTE: The rtpPayloadType(s) shall correspond to the RTP Payload Format if the rtpPayloadFormat is present. + +## 5.6 Data Types related to 5G Trace + +### 5.6.1 Introduction + +This clause defines common data types related to 5G Trace. + +## 5.6.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.6.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PhysCellId | integer | integer value identifying the physical cell identity (PCI), as definition of "PhysCellId" IE in clause 6.3.2 of 3GPP TS 38.331 [42].

Minimum = 0. Maximum = 1007. | +| ArfcnValueNR | integer | Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster, as definition of "ARFCN-ValueNR" IE in clause 6.3.2 of 3GPP TS 38.331 [42].

Minimum = 0. Maximum = 3279165. | +| QoeReference | string | String containing MCC (3 digits), MNC (2 or 3 digits) and QMC ID (3 octets, encoded as 6 hexadecimal digits). Each value is separated by the "-" character.

See 3GPP TS 28.405 [56], clause 5.2.

Pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}\$' | +| MdtAlignmentInfo | string | String containing:
- Trace Reference: MCC (3 digits), MNC (2 or 3 digits), Trace ID (3 octets, encoded as 6 hexadecimal digits)
- Trace Recording Session Reference (2 octets, encoded as 4 hexadecimal digits).
Each value is separated by the "-" character.

See 3GPP TS 28.405 [56], clause 5.13.

Pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}-[A-Fa-f0-9]{4}\$' | + +## 5.6.3 Enumerations + +### 5.6.3.1 Enumeration: TraceDepth + +The enumeration TraceDepth defines how detailed information should be recorded in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.1-1. + +**Table 5.6.3.1-1: Enumeration TraceDepth** + +| Enumeration value | Description | +|-------------------------------|-------------------------------------------| +| "MINIMUM" | Minimum | +| "MEDIUM" | Medium | +| "MAXIMUM" | Maximum | +| "MINIMUM_WO_VENDOR_EXTENSION" | Minimum without vendor specific extension | +| "MEDIUM_WO_VENDOR_EXTENSION" | Medium without vendor specific extension | +| "MAXIMUM_WO_VENDOR_EXTENSION" | Maximum without vendor specific extension | + +### 5.6.3.2 Enumeration: TraceDepthRm + +This enumeration is defined in the same way as the "TraceDepth" enumeration, but with the OpenAPI "nullable: true" property. + +### 5.6.3.3 Enumeration: JobType + +The enumeration JobType defines Job Type in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.3-1. + +**Table 5.6.3.3-1: Enumeration JobType** + +| Enumeration value | Description | +|---------------------------|-------------------------| +| "IMMEDIATE_MDT_ONLY" | Immediate MDT only | +| "LOGGED_MDT_ONLY" | Logged MDT only | +| "TRACE_ONLY" | Trace only | +| "IMMEDIATE_MDT_AND_TRACE" | Immediate MDT and Trace | +| "RLF_REPORTS_ONLY" | RLF reports only | +| "RCEF_REPORTS_ONLY" | RCEF reports only | +| "LOGGED_MBSFN_MDT" | Logged MBSFN MDT | + +### 5.6.3.4 Enumeration: ReportTypeMdt + +The enumeration ReportTypeMdt defines Report Type for logged MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.4-1. + +**Table 5.6.3.4-1: Enumeration ReportTypeMdt** + +| Enumeration value | Description | +|-------------------|-----------------| +| "PERIODICAL" | Periodical | +| "EVENT_TRIGGERED" | Event triggered | + +### 5.6.3.5 Enumeration: MeasurementLteForMdt + +The enumeration MeasurementLteForMdt defines Measurements used for MDT in LTE in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.5-1. + +**Table 5.6.3.5-1: Enumeration MeasurementLteForMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "M1" | M1 | +| "M2" | M2 | +| "M3" | M3 | +| "M4_DL" | M4 for DL | +| "M4_UL" | M4 for UL | +| "M5_DL" | M5 for DL | +| "M5_UL" | M5 for UL | +| "M6_DL" | M6 for DL | +| "M6_UL" | M6 for UL | +| "M7_DL" | M7 for DL | +| "M7_UL" | M7 for UL | +| "M8" | M8 | +| "M9" | M9 | + +### 5.6.3.6 Enumeration: MeasurementNrForMdt + +The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.6-1. + +**Table 5.6.3.6-1: Enumeration MeasurementNrForMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "M1" | M1 | +| "M2" | M2 | +| "M3" | M3 | +| "M4_DL" | M4 for DL | +| "M4_UL" | M4 for UL | +| "M5_DL" | M5 for DL | +| "M5_UL" | M5 for UL | +| "M6_DL" | M6 for DL | +| "M6_UL" | M6 for UL | +| "M7_DL" | M7 for DL | +| "M7_UL" | M7 for UL | +| "M8" | M8 | +| "M9" | M9 | + +### 5.6.3.7 Enumeration: SensorMeasurement + +The enumeration SensorMeasurement defines sensor measurement type for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.7-1. + +**Table 5.6.3.7-1: Enumeration SensorMeasurement** + +| Enumeration value | Description | +|-----------------------|---------------------| +| "BAROMETRIC_PRESSURE" | Barometric pressure | +| "UE_SPEED" | UE speed | +| "UE_ORIENTATION" | UE orientation | + +### 5.6.3.8 Enumeration: ReportingTrigger + +The enumeration ReportingTrigger defines Reporting Triggers for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.8-1. + +**Table 5.6.3.8-1: Enumeration ReportingTrigger** + +| Enumeration value | Description | +|--------------------------|--------------------------------------------| +| "PERIODICAL" | Periodical | +| "EVENT_A2" | Event A2 for LTE and NR | +| "EVENT_A2_PERIODIC" | A2 event triggered periodic for LTE and NR | +| "ALL_RRM_EVENT_TRIGGERS" | All configured RRM event triggers for LTE | + +### 5.6.3.9 Enumeration: ReportIntervalMdt + +The enumeration ReportIntervalMdt defines Report Interval for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.9-1. + +**Table 5.6.3.9-1: Enumeration ReportIntervalMdt** + +| Enumeration value | Description | +|-------------------|-------------------| +| "120" | 120 ms | +| "240" | 240 ms | +| "480" | 480 ms | +| "640" | 640 ms | +| "1024" | 1024 ms | +| "2048" | 2048 ms | +| "5120" | 5120 ms | +| "10240" | 10240ms | +| "60000" | 1 min=60000 ms | +| "360000" | 6 min=360000 ms | +| "720000" | 12 min=720000 ms | +| "1800000" | 30 min=1800000 ms | +| "3600000" | 60 min=3600000 ms | + +### 5.6.3.10 Enumeration: ReportAmountMdt + +The enumeration ReportAmountMdt defines Report Amount for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.10-1. + +**Table 5.6.3.10-1: Enumeration ReportAmountMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "1" | 1 | +| "2" | 2 | +| "4" | 4 | +| "8" | 8 | +| "16" | 16 | +| "32" | 32 | +| "64" | 64 | +| "infinity" | Infinity | + +### 5.6.3.11 Enumeration: EventForMdt + +The enumeration EventForMdt defines events triggered measurement for logged MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.11-1. + +**Table 5.6.3.11-1: Enumeration EventForMdt** + +| Enumeration value | Description | +|-------------------|-----------------| +| "OUT_OF_COVERAGE" | Out of coverage | +| "A2_EVENT" | A2 event | + +### 5.6.3.12 Enumeration: LoggingIntervalMdt + +The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.12-1. + +**Table 5.6.3.12-1: Enumeration LoggingIntervalMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "128" | 1280 ms | +| "256" | 2560 ms | +| "512" | 5120 ms | +| "1024" | 10240 ms | +| "2048" | 20480 ms | +| "3072" | 30720 ms | +| "4096" | 40960 ms | +| "6144" | 61440 ms | + +### 5.6.3.13 Enumeration: LoggingDurationMdt + +The enumeration LoggingDurationMdt defines Logging Duration for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.13-1. + +**Table 5.6.3.13-1: Enumeration LoggingDurationMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "600" | 600 sec | +| "1200" | 1200 sec | +| "2400" | 2400 sec | +| "3600" | 3600 sec | +| "5400" | 5400 sec | +| "7200" | 7200 sec | + +### 5.6.3.14 Enumeration: PositioningMethodMdt + +The enumeration PositioningMethodMdt defines Positioning Method for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.14-1. + +**Table 5.6.3.14-1: Enumeration PositioningMethodMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "GNSS" | GNSS | +| "E_CELL_ID" | E-Cell ID | + +### 5.6.3.15 Enumeration: CollectionPeriodRmmLteMdt + +The enumeration CollectionPeriodRmmLteMdt defines Collection period for RRM measurements LTE for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.15-1. + +**Table 5.6.3.15-1: Enumeration CollectionPeriodRmmLteMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "1024" | 1024 ms | +| "1280" | 1280 ms | +| "2048" | 2048 ms | +| "2560" | 2560 ms | +| "5120" | 5120 ms | +| "10240" | 10240 ms | +| "60000" | 1 min | + +### 5.6.3.16 Enumeration: MeasurementPeriodLteMdt + +The enumeration MeasurementPeriodLteMdt defines Measurement period LTE for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.16-1. + +**Table 5.6.3.16-1: Enumeration MeasurementPeriodLteMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "1024" | 1024 ms | +| "1280" | 1280 ms | +| "2048" | 2048 ms | +| "2560" | 2560 ms | +| "5120" | 5120 ms | +| "10240" | 10240 ms | +| "60000" | 1 min | + +### 5.6.3.17 Enumeration: ReportIntervalNrMdt + +The enumeration ReportIntervalNrMdt defines Report Interval in NR for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.17-1. + +**Table 5.6.3.17-1: Enumeration ReportIntervalNrMdt** + +| Enumeration value | Description | +|-------------------|-------------------| +| "120" | 120 ms | +| "240" | 240 ms | +| "480" | 480 ms | +| "640" | 640 ms | +| "1024" | 1024 ms | +| "2048" | 2048 ms | +| "5120" | 5120 ms | +| "10240" | 10240ms | +| "20480" | 20480ms | +| "40960" | 40960ms | +| "60000" | 1 min=60000 ms | +| "360000" | 6 min=360000 ms | +| "720000" | 12 min=720000 ms | +| "1800000" | 30 min=1800000 ms | +| "3600000" | 60 min=3600000 ms | + +### 5.6.3.18 Enumeration: LoggingIntervalNrMdt + +The enumeration LoggingIntervalNrMdt defines Logging Interval in NR for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.18-1. + +**Table 5.6.3.18-1: Enumeration LoggingIntervalNrMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "1280" | 1280 ms | +| "2560" | 2560 ms | +| "5120" | 5120 ms | +| "10240" | 10240 ms | +| "20480" | 20480 ms | +| "30720" | 30720 ms | +| "40960" | 40960 ms | +| "61440" | 61440 ms | +| "320" | 320 ms | +| "640" | 640 ms | +| "infinity" | Infinity | + +### 5.6.3.19 Enumeration: CollectionPeriodRmmNrMdt + +The enumeration CollectionPeriodRmmNrMdt defines Collection period for RRM measurements NR for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.19-1. + +**Table 5.6.3.19-1: Enumeration CollectionPeriodRmmNrMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "1024" | 1024 ms | +| "2048" | 2048 ms | +| "5120" | 5120 ms | +| "10240" | 10240 ms | +| "60000" | 1 min | + +### 5.6.3.20 Enumeration: LoggingDurationNrMdt + +The enumeration LoggingDurationMdt defines Logging Duration in NR for MDT in the trace. See 3GPP TS 32.422 [19] for further description of the values. It shall comply with the provisions defined in table 5.6.3.20-1. + +**Table 5.6.3.20-1: Enumeration LoggingDurationNrMdt** + +| Enumeration value | Description | +|-------------------|-------------| +| "600" | 600 sec | +| "1200" | 1200 sec | +| "2400" | 2400 sec | +| "3600" | 3600 sec | +| "5400" | 5400 sec | +| "7200" | 7200 sec | + +### 5.6.3.21 Enumeration: QoeServiceType + +The enumeration QoeServiceType indicates the kind of service that shall be recorded for QMC. It shall comply with the provisions defined in Table 5.6.3.21-1. + +**Table 5.6.3.21-1: Enumeration QoeServiceType** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "DASH" | Dynamic Adaptive Streaming over HTTP | +| "MTSI" | Multimedia Telephony Service for IMS | +| "VR" | Virtual Reality | + +### 5.6.3.22 Enumeration: AvailableRanVisibleQoeMetric + +The enumeration AvailableRanVisibleQoeMetric indicates different available RAN-visible QoE metrics to the gNB. It shall comply with the provisions defined in Table 5.6.3.22-1. + +**Table 5.6.3.22-1: Enumeration AvailableRanVisibleQoeMetric** + +| Enumeration value | Description | +|-------------------------------------------|---------------------------------------| +| "APPLICATION_LAYER_BUFFER_LEVEL_LIST
" | See 3GPP TS 28.405 [56], clause 5.12. | +| "PLAYOUT_DELAY_FOR_MEDIA_STARTUP" | See 3GPP TS 28.405 [56], clause 5.12. | + +## 5.6.4 Structured Data Types + +### 5.6.4.1 Type: TraceData + +**Table 5.6.4.1-1: Definition of type TraceData** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| traceRef | string | M | 1 |

Trace Reference (see 3GPP TS 32.422 [19]).

It shall be encoded as the concatenation of MCC, MNC and Trace ID as follows:
<MCC><MNC>-<Trace ID>

The Trace ID shall be encoded as a 3 octet string in hexadecimal representation. Each character in the Trace ID string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Trace ID shall appear first in the string, and the character representing the 4 least significant bit of the Trace ID shall appear last in the string.

Pattern: '[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}\$'

| +| traceDepth | TraceDepth | M | 1 | Trace Depth (see 3GPP TS 32.422 [19]). | +| neTypeList | string | M | 1 |

List of NE Types (see 3GPP TS 32.422 [19]).

It shall be encoded as an octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits shall appear first in the string, and the character representing the 4 least significant bit shall appear last in the string.

Octets shall be coded according to 3GPP TS 32.422 [19].

Pattern: '[A-Fa-f0-9]+\$'

| +| eventList | string | M | 1 |

Triggering events (see 3GPP TS 32.422 [19]).

It shall be encoded as an octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits shall appear first in the string, and the character representing the 4 least significant bit shall appear last in the string.

Octets shall be coded according to 3GPP TS 32.422 [19].

Pattern: '[A-Fa-f0-9]+\$'

| +| collectionEntityIpv4Addr | Ipv4Addr | C | 0..1 |

IPv4 Address of the Trace Collection Entity (see 3GPP TS 32.422 [19]).

At least one of the collectionEntityIpv4Addr or collectionEntityIpv6Addr attributes shall be present.

| +| collectionEntityIpv6Addr | Ipv6Addr | C | 0..1 |

IPv6 Address of the Trace Collection Entity (see 3GPP TS 32.422 [19]).

At least one of the collectionEntityIpv4Addr or collectionEntityIpv6Addr attributes shall be present.

| +| interfaceList | string | O | 0..1 |

List of Interfaces (see 3GPP TS 32.422 [19]).

It shall be encoded as an octet string in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits shall appear first in the string, and the character representing the 4 least significant bit shall appear last in the string.

| + +| | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

Octets shall be coded according to 3GPP TS 32.422 [19].

If this attribute is not present, all the interfaces applicable to the list of NE types indicated in the neTypeList attribute should be traced.

Pattern: '^[A-Fa-f0-9]+\$'

| +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 5.6.4.2 Type: MdtConfiguration + +**Table 5.6.4.2-1: Definition of type MdtConfiguration** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| jobType | JobType | M | 1 | This IE shall indicate the Job type for MDT, see 3GPP TS 32.422 [19]. | +| reportType | ReportTypeMdt | C | 0..1 | This IE shall be present for logged MDT. When present, this IE shall indicate the report type for logged MDT, see 3GPP TS 32.422 [19]. | +| areaScope | AreaScope | O | 0..1 | When present, this IE shall contain the area in Cells or Tracking Areas where the MDT data collection shall take place, see 3GPP TS 32.422 [19]. | +| measurementLteList | array(MeasurementLteForMdt) | C | 1..N | This IE shall be present if the Job type is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall contain a list of the measurements that shall be collected for LTE. | +| measurementNrList | array(MeasurementNrForMdt) | C | 1..N | This IE shall be present if the Job type is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall contain a list of the measurements that shall be collected for NR. | +| sensorMeasurementList | array(SensorMeasurement) | O | 1..N | When present, this IE shall include a list of the sensor measurements to be collected for UE if they are available. | +| reportingTriggerList | array(ReportingTrigger) | C | 1..N | This IE shall be present if MeasurementList is configured for UE side measurements (such as M1 measurement in LTE) and the jobType is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall contain a list of the reporting triggers. For LTE and NR, this IE shall not have the combination of periodical, event based and event based periodic reporting at the same time. | +| reportInterval | ReportIntervalMdt | C | 0..1 | This IE shall be present if the reportingTriggerList is configured for Periodic UE side measurements (such as M1 measurement in LTE) and the jobType is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in LTE. | +| reportIntervalNr | ReportIntervalNrMdt | C | 0..1 | This IE shall be present if the reportingTriggerList is configured for Periodic UE side measurements (such as M1 measurement in NR) and the jobType is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in NR. | +| reportAmount | ReportAmountMdt | C | 0..1 | This IE shall be present if the reportingTriggerList is configured for Periodic UE side measurements (such as M1 measurement in LTE) and the jobType is configured for Immediate MDT or combined Immediate MDT and Trace. When present, this IE shall indicate the number of measurement reports that shall be taken for periodical reporting while UE is in connected. | +| eventThresholdRsrp | integer | C | 0..1 | This IE shall be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting and the job type parameter is configured for Immediate MDT or combined Immediate MDT and Trace in LTE. When present, this IE shall indicate the Event Threshold for RSRP, and the value shall be between 0-97. | +| eventThresholdRsrpNr | integer | C | 0..1 | This IE shall be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting and the job type parameter is configured for Immediate MDT or | + +| | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | combined Immediate MDT and Trace in NR.
When present, this IE shall indicate the Event
Threshold for RSRP, and the value shall be between
0-127. | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--------------------------|-----------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventThresholdRsrq | integer | C | 0..1 | This IE shall be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting and the job type parameter is configured for Immediate MDT or combined Immediate MDT and Trace in LTE. When present, this IE shall indicate the Event Threshold for RSRQ, and the value shall be between 0-34. | +| eventThresholdRsrq Nr | integer | C | 0..1 | This IE shall be present if the report trigger parameter is configured for A2 event reporting or A2 event triggered periodic reporting and the job type parameter is configured for Immediate MDT or combined Immediate MDT and Trace in NR. When present, this IE shall indicate the Event Threshold for RSRQ, and the value shall be between 0-127. | +| eventList | array(EventFormMdt) | C | 1..N | This IE shall be present for event triggered measurement in the case of logged MDT. When present, this IE shall contain a list of events triggered measurement in NR. | +| loggingInterval | LoggingIntervalMdt | C | 0..1 | This IE shall be present if the job type is configured for Logged MDT or Logged MBSFN MDT in LTE. When present, this IE shall contain the periodicity for logging MDT measurement results for periodic downlink pilot strength measurement in LTE when UE is in Idle. | +| loggingIntervalNr | LoggingIntervalNrMdt | C | 0..1 | This IE shall be present if the job type is configured for Logged MDT or Logged MBSFN MDT in NR. When present, this IE shall contain the periodicity for logging MDT measurement results for periodic downlink pilot strength measurement in NR when UE is in Idle. | +| loggingDuration | LoggingDurationMdt | O | 0..1 | This IE shall be present if the job type parameter is configured for Logged MDT or Logged MBSFN MDT. When present, this IE shall indicate the validity time of MDT logged configuration for IDLE in LTE | +| loggingDurationNr | LoggingDurationNrMdt | O | 0..1 | This IE shall be present if the job type parameter is configured for Logged MDT or Logged MBSFN MDT. When present, this IE shall indicate the validity time of MDT logged configuration for IDLE in NR. | +| positioningMethod | PositioningMethodMdt | O | 0..1 | This IE may be present if the job type is set to Immediate MDT or Immediate MDT and Trace. When present, it shall indicate the positioning method that shall be used for the MDT job. For LTE the value "GNSS" may be selected only if the M1 measurement is selected in measurementList. | +| addPositioningMethodList | array(PositioningMethodMdt) | O | 1..N | This IE may be present if positioningMethod is present.

When present, it shall indicate a list of the additional positioning methods that shall be used for the MDT job.

For LTE, the value "GNSS" may be selected only if the M1 measurement is selected in measurementList. | +| collectionPeriodRmm Lte | CollectionPeriodRmmLteMdt | C | 0..1 | This IE shall be present if the job type is set to Immediate MDT or Immediate MDT and Trace and any of the "M2" or "M3" is contained in measurementList attribute in LTE. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements. The same collection period should be used for all such measurements that are requested in the same MDT or combined Trace and MDT job. | + +| | | | | | +|-----------------------|----------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| collectionPeriodRmmNr | CollectionPeriodRmmNrMdt | C | 0..1 | This IE shall be present if the job type is set to Immediate MDT or Immediate MDT and Trace and any of the "M4" or "M5" is contained in measurementList attribute in NR.

When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements. The same collection period should be used for all such measurements that are requested in the same MDT or combined Trace and MDT job. | +| measurementPeriodLte | MeasurementPeriodLteMdt | C | 0..1 | This IE shall be present if the job type is set to Immediate MDT or Immediate MDT and Trace and either the value "M4_DL" or "M4_UL" or "M5_DL" or "M5_UL" is contained in measurementList attribute in LTE.

When present, it shall contain the collection period that should be used for the Data Volume and Scheduled IP Throughput measurements made by the eNB. The same measurement period should be used for the UL and DL. | +| mdtAllowedPlmnIdList | array(PlmnId) | O | 1..N | When present, this IE shall contain the PLMNs where measurement collection, status indication and log reporting is allowed. E.g. the UE performs these actions for Logged MDT when the RPLMN is part of this set of PLMNs.
Maximum of 16 PLMNs can be contained. | +| mbsfnAreaList | array(MbsfnArea) | O | 1..N | When present, this IE shall contain MBSFN Area(s) for MBSFN measurement logging.
Maximum of 8 MBSFN area(s) can be contained.
This parameter is applicable only if the job type is Logged MBSFN MDT and for eUTRAN only. | +| interFreqTargetList | array(InterFreqTargetInfo) | O | 1..8 | When present, this IE shall indicate Inter Frequency Target(s) for which the UE is requested to perform measurement logging. | + +#### 5.6.4.3 Type: AreaScope + +**Table 5.6.4.3-1: Definition of type AreaScope** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| eutraCellIdList | array(EutraCellId) | O | 1..N | When present, this IE shall contain a list of the E-UTRAN Cell Identifications where the MDT data collection shall take place. | +| nrCellIdList | array(NrCellId) | O | 1..N | When present, this IE shall contain a list of the NR Cell Identities where the MDT data collection shall take place. | +| tacList | array(Tac) | O | 1..N | When present, this IE shall contain a list of the tracking area codes where the MDT data collection shall take place. | +| tacInfoPerPlmn | map(TacInfo) | O | 1..N | A map (list of key-value pairs where PlmnId converted to string serves as key; see clause 5.4.4.3) of TacInfo | + +#### 5.6.4.4 Type: TacInfo + +**Table 5.6.4.4-1: Definition of type TacInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|----------------------------------------------------------| +| tacList | array(Tac) | M | 1..N | This IE shall contain a list of the tracking area codes. | + +### 5.6.4.5 Type: MbsfnArea + +**Table 5.6.4.5-1: Definition of type MbsfnArea** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| mbsfnAreaId | integer | O | 0..1 | This IE shall contain the MBSFN Area ID.
The range of the value is from 0 to 255, see 3GPP TS 36.331 [39]. | +| carrierFrequency | integer | O | 0..1 | When present, this IE shall contain the Carrier Frequency (EARFCN).
The range of the value is from 0 to 262143, see 3GPP TS 36.331 [39]. | +| NOTE | If both mbsfnAreaId and carrierFrequency values are present, a specific MBSFN area is indicated. If carrierFrequency is present, but mbsfnAreaId is absent, all MBSFN areas on that carrier frequency are indicated. If both mbsfnAreaId and carrierFrequency are absent, any MBSFN area is indicated. | | | | + +### 5.6.4.6 Type: InterFreqTargetInfo + +**Table 5.6.4.6-1: Definition of type InterFreqTargetInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dlCarrierFreq | ArfcnValueNr | M | 1 | This IE shall indicate the value of frequency for download for measurement logging. | +| cellIdList | array(PhysCellId) | O | 1..32 | When present, this IE shall contain a list of the physical cell identities where the UE is requested to perform measurement logging for the indicated frequency.

If absent, the UE shall perform measurement logging on all physical cells. | + +## 5.6.4.7 Type: QmcConfigInfo + +Table 5.6.4.7-1: Definition of type QmcConfigInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| qoeReference | QoeReference | M | 1 | This IE contains the Quality of Experience (QoE) Reference. See 3GPP TS 28.405 [56], clause 5.2. | +| serviceType | QoeServiceType | O | 0..1 | This IE contains the Service Type of QoE measurements. See 3GPP TS 28.405 [56], clause 5.8. | +| sliceScope | array(Snssai) | O | 1..N | This IE contains a list of S-NSSAIs. See 3GPP TS 28.405 [56], clause 5.9. | +| areaScope | QmcAreaScope | O | 0..1 | This IE contains the area in Cells or Tracking Areas where the QMC data collection shall take place. See 3GPP TS 28.405 [56], clause 5.4. | +| qoeCollectionEntityAddress | IpAddr | O | 0..1 | This IE contains the IP address (IPv4 or IPv6) of the entity to which the QMC records shall be transferred. See 3GPP TS 28.405 [56], clause 5.1. | +| qoeTarget | QoeTarget | O | 0..1 | This parameter specifies the target object (individual UE) for the QMC in case of signalling based QMC. The qoeTarget parameter shall be able to carry an IMSI or a SUPI. See 3GPP TS 28.405 [56], clause 5.10. | +| mdtAlignmentInfo | MdtAlignmentInfo | O | 0..1 | This parameter indicates the MDT measurements with which alignment of QoE measurement is required. It contains the Trace Reference and Trace Recording Session Reference. See 3GPP TS 28.405 [56], clause 5.13. | +| availableRanVisibleQoeMetrics | array(AvailableRanVisibleQoeMetric) | O | 1..N | A list of RAN-visible QoE metrics configured by gNB to collect all or some of the available RAN visible QoE metrics, where the indication of metric availability is indicated by UDM. | +| containerForAppLayerMeasConfig | Bytes | O | 0..1 | This parameter contains application layer measurement configuration. See 3GPP TS 28.405 [56], clause 5.5. | +| mbsCommunicationServiceType | MbsServiceType | O | 0..1 | This parameter indicates for which type of MBS communication service the QoE measurement configuration pertains to (i.e. "MULTICAST", "BROADCAST"). | + +#### 5.6.4.8 Type: QmcAreaScope + +**Table 5.6.4.8-1: Definition of type QmcAreaScope** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| nrCellIdList | array(NrCellId) | O | 1..N | When present, this IE shall contain a list of the NR Cell Identities where the QMC shall take place. | +| tacList | array(Tac) | O | 1..N | When present, this IE shall contain a list of the tracking area codes where the QMC shall take place. | +| taiList | array(Tai) | O | 1..N | When present, this IE shall contain a list of the TAls where the QMC shall take place. | +| plmnList | array(Plmn) | O | 1..N | When present, this IE shall contain a list of the PLMNs where the QMC shall take place. | + +#### 5.6.4.9 Type: QoeTarget + +**Table 5.6.4.9-1: Definition of type QoeTarget** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------| +| supi | Supi | O | 0..1 | When present, this IE shall contain the SUPI of the target object (individual UE) for the QMC in case of signalling based QMC. | +| imsi | Imsi | O | 0..1 | When present, this IE shall contain the IMSI of the target object (individual UE) for the QMC in case of signalling based QMC. | + +### 5.7 Data Types related to 5G Operator Determined Barring + +#### 5.7.1 Introduction + +This clause defines common data types related to 5G Operator Determined Barring. + +#### 5.7.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.7.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| | | | + +#### 5.7.3 Enumerations + +##### 5.7.3.1 Enumeration: RoamingOdb + +The enumeration RoamingOdb defines the Barring of Roaming as. See 3GPP TS 23.015 [26] for further description. It shall comply with the provisions defined in table 5.7.3.1-1. + +**Table 5.7.3.1-1: Enumeration RoamingOdb** + +| Enumeration value | Description | +|-----------------------------|--------------------------------------------------| +| "OUTSIDE_HOME_PLMN" | Barring of roaming outside the home PLMN | +| "OUTSIDE_HOME_PLMN_COUNTRY" | Barring of roaming outside the home PLMN country | + +### 5.7.3.2 Enumeration: OdbPacketServices + +The enumeration OdbPacketServices defines the Barring of Packet Oriented Services. See 3GPP TS 23.015 [26] for further description. It shall comply with the provisions defined in table 5.7.3.2-1. + +**Table 5.7.3.2-1: Enumeration OdbPacketServices** + +| Enumeration value | Description | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------| +| "ALL_PACKET_SERVICES" | Barring of all Packet Oriented Services | +| "ROAMER_ACCESS_HPLMN_AP" | Barring of Packet Oriented Services from access points that are within the HPLMN whilst the subscriber is roaming in a VPLMN | +| "ROAMER_ACCESS_VPLMN_AP" | Barring of Packet Oriented Services from access points that are within the roamed to VPLMN. | + +## 5.7.4 Structured Data Types + +### 5.7.4.1 Type: OdbData + +**Table 5.7.4.1-1: Definition of type OdbData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-----------------------------------------------| +| roamingOdb | RoamingOdb | O | 0..1 | Barring of Roaming (see 3GPP TS 23.015 [26]). | + +## 5.8 Data Types related to Charging + +### 5.8.1 Introduction + +This clause defines common data types related to Charging. + +### 5.8.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.8.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ChargingId | Uint32 | Charging identifier allowing correlation of charging information (NOTE) | +| SmfChargingId | string |

String based Charging ID as specified in 3GPP TS 32.255 [58].

The String based Charging ID shall include a Uint32 base charging identifier (decimal encoded value within the values range: 0 to 4294967295 included) as the first segment, which shall be unique within the SMF assigning the Charging ID.

The String based Charging ID shall include the NF Instance ID (UUID format) of the SMF that assigned the Charging ID, as the second segment.

Pattern: '^(0 ([1-9]{1}[0-9]{0,9}))\.smf-([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\$'

Example:

Base Charging ID:
"9387"

SMF NF Instance ID:
"4947a69a-f61b-4bc1-b9da-47c9c5d14b64"

String based Charging ID:
"9387.smf-4947a69a-f61b-4bc1-b9da-47c9c5d14b64"

| +| ApplicationChargingId | string | Application provided charging identifier allowing correlation of charging information. | +| RatingGroup | Uint32 | Identifier of a Rating Group | +| ServiceId | Uint32 | Identifier of a Service | +| NOTE: This data type is deprecated and shall not be used by any new API definition. To ensure the uniqueness of the charging identifier, the SmfChargingId data type shall be used for new attributes defined in APIs carrying a charging identifier. | | | + +## 5.8.3 Enumerations + +## 5.8.4 Structured Data Types + +### 5.8.4.1 Type: SecondaryRatUsageReport + +**Table 5.8.4.1-1: Definition of type SecondaryRatUsageReport** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------------------|---|-------------|----------------------| +| secondaryRatType | RatType | M | 1 | Secondary RAT type | +| qosFlowsUsageData | array(QosFlowUsageReport) | M | 1..N | QoS flows usage data | + +### 5.8.4.2 Type: QoSFlowUsageReport + +**Table 5.8.4.2-1: Definition of type QoSFlowUsageReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------| +| qfi | Qfi | M | 1 | QoS Flow Indicator | +| startTimeStamp | DateTime | M | 1 | UTC time indicating the start time of the collection period of the included usage data for DL and UL. | +| endTimeStamp | DateTime | M | 1 | UTC time indicating the end time of the collection period of the included usage data for DL and UL. | +| downlinkVolume | Int64 | M | 1 | Data usage for DL, encoding a number of octets | +| uplinkVolume | Int64 | M | 1 | Data usage for UL, encoding a number of octets | + +### 5.8.4.3 Type: SecondaryRatUsageInfo + +**Table 5.8.4.3-1: Definition of type SecondaryRatUsageInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------------|---|-------------|------------------------| +| secondaryRatType | RatType | M | 1 | Secondary RAT type | +| qosFlowsUsageData | array(QoSFlowUsageReport) | O | 1..N | QoS flows usage data | +| pduSessionUsageData | array(VolumeTimedReport) | O | 1..N | PDU session usage data | + +### 5.8.4.4 Type: VolumeTimedReport + +**Table 5.8.4.4-1: Definition of type VolumeTimedReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------| +| startTimeStamp | DateTime | M | 1 | UTC time indicating the start time of the collection period of the included usage data for DL and UL. | +| endTimeStamp | DateTime | M | 1 | UTC time indicating the end time of the collection period of the included usage data for DL and UL. | +| downlinkVolume | Int64 | M | 1 | Data usage for DL, encoding a number of octets | +| uplinkVolume | Int64 | M | 1 | Data usage for UL, encoding a number of octets | + +## 5.9 Data Types related to MBS + +### 5.9.1 Introduction + +This clause defines common data types related to MBS. + +### 5.9.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.9.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|---------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AreaSessionId | Uint16 | Area Session Identifier used for MBS session with location dependent content.
When present, the Area Session ID together with the TMGI uniquely identifies the MBS session in a specific MBS service area. | +| AreaSessionPolicyId | Uint16 | Area Session Policy ID used for MBS session with location dependent content. | +| MbsFsaId | string | MBS Frequency Selection Area ID, for a broadcast MBS session

The value of the MbsFsaId shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the MBS FSA Id shall appear first in the string, and the character representing the 4 least significant bit of the MBS FSA Id shall appear last in the string.

Pattern: '^[A-Fa-f0-9]{6}\$' | + +## 5.9.3 Enumerations + +### 5.9.3.1 Enumeration: MbsServiceType + +The enumeration MbsServiceType indicates the type of MBS session. It shall comply with the provisions defined in Table 5.9.3.1-1. + +**Table 5.9.3.1-1: Enumeration MbsServiceType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------|---------------| +| "MULTICAST" | Multicast MBS session | | +| "BROADCAST" | Broadcast MBS session | | + +### 5.9.3.2 Enumeration: MbsSessionActivityStatus + +The enumeration MbsSessionActivityStatus indicates the MBS session's activity status. It shall comply with the provisions defined in Table 5.9.3.2-1. + +**Table 5.9.3.2-1: Enumeration MbsSessionActivityStatus** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| "ACTIVE" | Active MBS session | | +| "INACTIVE" | Inactive MBS session | | + +### 5.9.3.3 Enumeration: MbsSessionEventType + +**Table 5.9.3.3-1: Enumeration MbsSessionEventType** + +| Enumeration value | Description | Applicability | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| "MBS_REL_TMGI_EXPIRY" | Subscription to be notified or notification request about the MBS session release due to TMGI expiry. | | +| "BROADCAST_DELIVERY_STATUS" | Subscription to be notified or notification request about the MBS session broadcast delivery status. | | +| "INGRESS_TUNNEL_ADD_CHANGE" | Subscription to be notified or notification request about change of the Ingress Tunnel Address, when using unicast transport over N6mb/Nmb9. | | + +### 5.9.3.4 Enumeration: BroadcastDeliveryStatus + +**Table 5.9.3.4-1: Enumeration BroadcastDeliveryStatus** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------|---------------| +| "STARTED" | The MBS session has been started. | | +| "TERMINATED" | The MBS session has been terminated. | | + +## 5.9.4 Structured Data Types + +### 5.9.4.1 Type: MbsSessionId + +**Table 5.9.4.1-1: Definition of type MbsSessionId** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------| +| tmgi | Tmgi | C | 0..1 | TMGI identifying the MBS session (NOTE) | +| ssm | Ssm | C | 0..1 | Source specific IP multicast address identifying the MBS session (NOTE) | +| nid | Nid | O | 0..1 | Network Identity used together with the TMGI to identify an MBS session in an SNPN | + +NOTE: At least one of the tmgi IE and ssm IE shall be present. + +### 5.9.4.2 Type: Tmgi + +**Table 5.9.4.2-1: Definition of type Tmgi** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsServiceId | string | M | 1 | MBS Service ID consisting of a 6-digit fixed-length hexadecimal number between 000000 and FFFFFF.

Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the MBS Service ID shall appear first in the string, and the character representing the 4 least significant bit of the MBS Service ID shall appear last in the string.

Pattern: '[A-Fa-f0-9]{6}\$' | +| plmnId | PlmnId | M | 1 | PLMN ID | + +### 5.9.4.3 Type: Ssm + +**Table 5.9.4.3-1: Definition of type Ssm** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| sourceIpAddr | IpAddr | M | 1 | IP unicast address used as source address in IP packets for identifying the source of the multicast service (e.g. AF/AS). | +| destIpAddr | IpAddr | M | 1 | IP multicast address used as destination address in related IP packets for identifying the multicast service associated with the source. | + +#### 5.9.4.4 Type: MbsServiceArea + +**Table 5.9.4.4-1: Definition of type MbsServiceArea** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|--------------------------------------------------------| +| ncgiList | array(NcgiTai) | C | 1..N | List of NR cell ids with their pertaining TAIs (NOTE). | +| tailList | array(Tai) | C | 1..N | List of tracking area Ids (NOTE). | + +NOTE: The MBS Service Area consists of the union of the cells in the tracking areas listed in the tailList IE and the cells listed in the ncgiList IE. At least one of the ncgiList IE and tailList IE shall be present. + +#### 5.9.4.5 Type: NcgiTai + +**Table 5.9.4.5-1: Definition of type NcgiTai** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------| +| tai | Tai | M | 1 | TAI of the cells in cellList (NOTE) | +| cellList | array(Ncgi) | M | 1..N | List of NR cell ids | + +NOTE: The NcgiTai consists of the list of cells listed in the cellList IE. These cells pertain to the TAI indicated in the tai IE. The TAI may be used e.g. to discover and select an AMF that serves NG-RAN nodes supporting the corresponding cells. + +#### 5.9.4.6 Type: MbsSession + +**Table 5.9.4.6-1: Definition of type MbsSession** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | C | 0..1 | MBS session identifier (TMGI and/or SSM, and NID for an SNPN)
(NOTE 1) | +| tmgiAllocReq | boolean | C | 0..1 | TMGI allocation request indication.
This IE shall be present if the mbsSessionId IE is absent. This IE may also be present if the mbsSessionId IE is present and it does not contain a TMGI.
When present, it shall be set as follows:
- true: a TMGI is requested to be allocated
- false (default): no TMGI is requested to be allocated
Write-Only: true
(NOTE 1) | +| tmgi | Tmgi | C | 0..1 | This IE shall be present in an MBS session creation response if the tmgiAllocReq IE was present and set to "true" in the MBS session creation request.
When present, it shall indicate the TMGI allocated to the MBS session.
Read-Only: true | +| expirationTime | DateTime | C | 0..1 | This IE shall be present in an MBS session creation response if the tmgiAllocReq IE was present and set to "true" in the in the MBS session creation request.
When present, it shall indicate the expiration time for the TMGI allocated to the MBS session.
Read-Only: true | +| serviceType | MbsServiceType | M | 1 | MBS Service Type (either multicast or broadcast service)
Write-Only: true | +| locationDependent | boolean | C | 0..1 | Location dependent MBS session indication.
This IE shall be present and set to true for a Location dependent MBS session. It may be present otherwise.
When present, it shall be set as follows:
- true: this is a Location dependent MBS session
- false (default): this is not a Location dependent MBS session | +| areaSessionId | AreaSessionId | C | 0..1 | This IE shall be present in a successful response to a request to create an instance of a Location dependent MBS session i.e. when the "locationDependent" attribute is present and set to "true" in the MBS session creation request.
When present, it shall contain the Area Session ID assigned by the MB-SMF to the location dependent MBS session instance in the MBS Service Area.
Read-Only: true | +| ingressTunAddrReq | boolean | O | 0..1 | Ingress transport address request indication (for unicast transport over N6mb/Nmb9).
When present, it shall be set as follows:
- true: an ingress transport address is requested
- false (default): no request
Write-Only: true | +| ingressTunAddr | array(TunnelAddress) | C | 1..N | Ingress tunnel address (UDP/IP tunnel).
This IE shall be present in an MBS session creation response if the ingressTunAddrReq IE was present and set to "true" in the corresponding MBS session creation request.
When present, it shall indicate the allocated ingress | + +| | | | | | +|--|--|--|--|----------------------------------------------------| +| | | | | tunnel address(es).
Read-Only: true
(NOTE 2) | +|--|--|--|--|----------------------------------------------------| + +| | | | | | +|-------------------|--------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ssm | Ssm | C | 0..1 | Source specific IP multicast address

This IE shall be present if multicast transport applies over N6mb and the MBS session is not identified by the SSM, e.g. for a location-dependent MBS session with multicast transport over N6mb.

Write-Only: true | +| mbsServiceArea | MbsServiceArea | O | 0..1 | Contains the MBS Service Area

This attribute shall be present only for a location dependent MBS session or a local MBS session.

Write-Only: true | +| extMbsServiceArea | ExternalMbsServiceArea | O | 0..1 | Contains the MBS service area.

This attribute shall be present only for a location dependent MBS session or a local MBS session.

This IE may be present only over the N33 interface; it shall not be present over other interfaces. When present, it shall indicate the MBS Service Area information which shall either be geographical area information or civic address information.

Write-Only: true | +| redMbsServArea | MbsServiceArea | C | 0..1 | This attribute shall be present if the requested MBS service area is not entirely contained within the service area of a single MB-SMF.

When present, it shall contain the reduced MBS Service Area in which the MBS session has been created.

Read-Only: true
(NOTE 3) | +| extRedMbsServArea | ExternalMbsServiceArea | C | 0..1 | This attribute shall be present if the requested MBS service area is not entirely contained within the service area of a single MB-SMF. This IE may be present only over the N33 interface; it shall not be present over other interfaces.

When present, it shall contain the reduced MBS Service Area in which the MBS session has been created, which shall either be geographical area information or civic address information.

Read-Only: true
(NOTE 3) | +| dnn | Dnn | O | 0..1 | Represents the DNN
Write-Only: true | +| snssai | Snssai | O | 0..1 | Represents the S-NSSAI
Write-Only: true | +| activationTime | DateTime | O | 0..1 | Represents the MBS session start time. This attribute is deprecated and replaced by the "startTime" attribute. | +| startTime | DateTime | O | 0..1 | Represents the MBS session start time. | +| terminationTime | DateTime | O | 0..1 | Represents the MBS session termination time. | +| mbsServInfo | MbsServiceInfo | O | 0..1 | Contains the MBS Service Information for the MBS session. | +| mbsSessionSubsc | MbsSessionSubscription | O | 0..1 | Contains the parameters to request the creation of a subscription to one or more MBS session status event(s). | +| activityStatus | MbsSessionActivityStatus | O | 0..1 | Contains the session activity status (active or inactive).

This IE may be provided if the "serviceType" attribute indicates a multicast MBS session. | +| anyUeInd | boolean | O | 0..1 | Indication that any UE may join the MBS session. | + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | This IE may be provided if the "serviceType" attribute indicates a multicast MBS session. When present, it shall be set as follows:
- true: any UE may join the MBS session

- false (default): the MBS session is not open to any UE

Write-Only: true | +| mbsFsaldList | array(MbsFsald) | O | 1..N | List of MBS Frequency Selection Area Identifiers, for a broadcast MBS session.

This attribute may be present if the "serviceType" attribute indicates a broadcast MBS session. | +| associatedSessionId | AssociatedSessionId | O | 0..1 | Associated Session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content. | +| NOTE 1: At least one of the mbsSessionId IE and tmgiAllocReq IE shall be present. Both may be present if the mbsSessionId IE does not contain a TMGI (i.e. if it only contains a SSM). | | | | | +| NOTE 2: In a scenario where an MB-UPF covers a small service area (i.e. a list of TAs that is a subset of the MBS service area), the MB-SMF needs to find other MB-UPF(s) to cover the whole MBS service area for the MBS session. In such scenarios, multiple ingress addresses of all MB-UPFs need to be allocated for an MBS session. These multiple ingress tunnel addresses are used to receive the same copy of the MBS session data from the AF/MBSTF. In such scenarios, the MBS service area served by an MB-UPF shall be larger than the MBS service area served by an AMF (set), i.e. an AMF in an AMF set shall receive only one MBS Session Information Request Transfer for an MBS session in the MBS Session Context Create/Update Request message. | | | | | +| NOTE 3: These attributes are sent on different interfaces. Accordingly, they are mutually exclusive. | | | | | + +### 5.9.4.7 Type: MbsSessionSubscription + +**Table 5.9.4.7-1: Definition of type MbsSessionSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | C | 0..1 | Identifier of the MBS Session for which the subscription is created.
This IE shall be present, except for an MBS session subscription request that is sent within an MBS session creation request. | +| areaSessionId | AreaSessionId | C | 0..1 | Area Session ID, for a location dependent MBS session, identifying the part of the MBS session in an MBS service area for which the subscription is created.
It shall be present for a location dependent MBS session, except for an MBS session subscription request that is sent within an MBS session creation request | +| eventList | array(MbsSessionEvent) | M | 1..N | List of MBS session events subscribed | +| notifyUri | Uri | M | 1 | URI where the NF service consumer requests to receive MBS session notifications.
Write-Only: true | +| notifyCorrelationId | string | O | 0..1 | Notification Correlation ID
Write-Only: true | +| expiryTime | DateTime | O | 0..1 | When present in an MBS Session subscription creation request, it shall indicate the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications.

When present in a subscription response, it shall indicate the expiry time after which the subscription becomes invalid. | +| nfInstanceId | NfInstanceId | C | 0..1 | NF Instance ID of the NF Service Consumer
This IE shall be present if available.
Write-Only: true | +| mbsSessionSubscUri | Uri | C | 0..1 | This IE shall be present in the response to an MBS session creation request that includes a subscription to events about the MBS session and the subscription was created successfully. When present, it shall contain the URI of the individual subscription resource.

Read-Only: true
(NOTE) | + +NOTE: When an MBS session status subscription is created separately (i.e. after) an MBS session creation, the Location header returned in the MBS session status subscription creation response contains the URI of the created subscription. + +### 5.9.4.8 Type: MbsSessionEventReportList + +**Table 5.9.4.8-1: Definition of type MbsSessionEventReportList** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| eventReportList | array(MbsSessionEventReport) | M | 1..N | List of MBS session events to report | +| notifyCorrelationId | string | C | 0..1 | Notification Correlation ID.
This IE shall be present if a Notification Correlation ID is available in the subscription. | + +#### 5.9.4.9 Type: MbsSessionEvent + +**Table 5.9.4.9-1: Definition of type MbsSessionEvent** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|------------------------|---------------| +| eventType | MbsSessionEventType | M | 1 | MBS session event type | | + +#### 5.9.4.10 Type: MbsSessionEventReport + +**Table 5.9.4.10-1: Definition of type MbsSessionEventReport** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| eventType | MbsSessionEventType | M | 1 | MBS session event type | | +| timeStamp | DateTime | C | 0..1 | This IE shall contain the time at which the event is generated. This IE should be present, if available. | | +| ingressTunAddrInfo | IngressTunAddrInfo | C | 0..1 | This IE shall be present if the eventType IE indicates "INGRESS_TUNNEL_ADD_CHANGE". | | +| broadcastDelStatus | BroadcastDeliveryStatus | C | 0..1 | This IE shall be present if the eventType IE indicates "BROADCAST_DELIVERY_STATUS". | | + +#### 5.9.4.11 Type: ExternalMbsServiceArea + +**Table 5.9.4.11-1: Definition of type ExternalMbsServiceArea** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------------|---|-------------|---------------------------------------------------------------------| +| geographicAreaList | array(GeographicArea) | C | 1..N | Identifies a list of geographic area specified by different shapes. | +| civicAddressList | array(CivicAddress) | C | 1..N | Identifies a list of civic address. | + +NOTE: Either the geographicAreaList IE or the civicAddressList IE shall be present. + +#### 5.9.4.12 Type: MbsSecurityContext + +**Table 5.9.4.12-1: Definition of type MbsSecurityContext** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| keyList | map(MbsKeyInfo) | M | 1..N | One or more MSK/MTK(s) and associated IDs. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters | + +### 5.9.4.13 Type: MbsKeyInfo + +**Table 5.9.4.13-1: Definition of type MbsKeyInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| keyDomainId | Bytes | M | 1 | Key Domain ID = MCC MNC as defined in 3GPP TS 33.246 [45]. (NOTE)

It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the Key Domain ID (encoded in 3 bytes). | +| mskID | Bytes | M | 1 | MSK ID as defined in 3GPP TS 33.246 [45].

It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MSK ID (encoded in 4 bytes). | +| msk | Bytes | C | 0..1 | MSK as defined in 3GPP TS 33.246 [45].

The IE shall not be present when MBSTF requests updated MSK from MBSF after, e.g. lifetime expiry. Shall be present otherwise.

When present, it shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MSK (encoded in 16 bytes). | +| mskLifetime | DateTime | O | 0..1 | MSK Lifetime as defined in 3GPP TS 33.501 [46]. | +| mtkID | Bytes | C | 0..1 | MTK ID as defined in 3GPP TS 33.246 [45]. Shall be present if available.

It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MTK ID (encoded in 2 bytes). | +| mtk | Bytes | C | 0..1 | MTK as defined in 3GPP TS 33.246 [45]. Shall be present if available.

It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MTK (encoded in 16 bytes). | + +NOTE: For a multicast MBS session in a SNPN, the Key Domain ID for the MBS session should be encoded using MCC and MNC, in this case, it may not be unique. + +### 5.9.4.14 Type: IngressTunAddrInfo + +**Table 5.9.4.14-1: Definition of type IngressTunAddrInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ingressTunAddr | array(TunnelAddresses) | M | 1..N | Ingress Tunnel Address(es) to use to send MBS session data over N6mb/Nmb9 and that replace any earlier provided Ingress Tunnel Address(es). | | + +### 5.9.4.15 Type: MbsServiceAreaInfo + +**Table 5.9.4.15-1: Definition of type MbsServiceAreaInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------| +| areaSessionId | AreaSessionId | M | 1 | Area Session Identifier used for MBS session with location dependent content. | +| mbsServiceArea | MbsServiceArea | M | 1 | MBS Service Area for MBS session with location dependent content. | + +### 5.9.4.16 Type: MbsServiceInfo + +**Table 5.9.4.16-1: Definition of type MbsServiceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsMediaComps | map(MbsMediaCompRm) | M | 1..N | Contains the information of one or several media component(s).
The key of the map is the "medCompN" attribute of the corresponding MbsMediaCompRm data structure provided as a map entry. | +| mbsSdfResPrio | ReservPriority | O | 0..1 | Indicates the reservation priority of the MBS service data flow(s) identified by the "mbsMediaComps" attribute. | +| afAppId | AfAppId | O | 0..1 | Contains the AF application identifier. | +| mbsSessionAmbr | BitRate | O | 0..1 | Contains the required MBS Session-AMBR. | + +### 5.9.4.17 Type: MbsMediaComp + +**Table 5.9.4.17-1: Definition of type MbsMediaComp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsMedCompNum | integer | M | 1 | Contains the ordinal number of the MBS media component. | | +| mbsFlowDescs | array(FlowDescription) | O | 1..N | Contains the flow description for the MBS Downlink IP flow(s). | | +| mbsSdfResPrio | ReservPriority | O | 0..1 | Indicates the reservation priority for the MBS service data flow(s) identified by the "mbsFlowDescs" attribute.
(NOTE 2) | | +| mbsMediaInfo | MbsMediaInfo | O | 0..1 | Indicates the MBS media information.
(NOTE 1) | | +| qosRef | string | O | 0..1 | Contains the identifier to pre-defined MBS QoS.
(NOTE 1) | | +| mbsQoSReq | MbsQoSReq | O | 0..1 | Contains the MBS QoS requirements.
(NOTE 1) | | + +NOTE 1: Only one of these attributes may be present. +NOTE 2: When present, the value of this attribute shall apply for the MBS service data flow(s) identified by this MBS Media Component. It shall take precedence over the value of the same attribute within the parent MbsServiceInfo data structure. + +### 5.9.4.18 Type: MbsMediaCompRm + +This data type is defined in the same way as the MbsMediaComp data type defined in clause 5.9.4.17, but with the OpenAPI "nullable: true" property. + +### 5.9.4.19 Type: MbsQoSReq + +**Table 5.9.4.19-1: Definition of type MbsQoSReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qi | 5Qi | M | 1 | Represents the required 5QI. | | +| guarBitRate | BitRate | O | 0..1 | Contain the required 5GS guaranteed bit rate. | | +| maxBitRate | BitRate | O | 0..1 | Contain the required 5GS maximum bit rate. | | +| averWindow | AverWindow | C | 0..1 | Indicates the averaging window.

This attribute shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow. | | +| reqMbsArp | Arp | O | 0..1 | Indicates the requested allocation and retention priority. | | + +### 5.9.4.20 Type: MbsMediaInfo + +**Table 5.9.4.20-1: Definition of type MbsMediaInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------|---------------| +| mbsMedType | MediaType | O | 0..1 | Indicates the MBS media type. | | +| maxReqMbsBwDI | BitRate | O | 0..1 | Contains the Maximum requested bandwidth. | | +| minReqMbsBwDI | BitRate | O | 0..1 | Contains the Minimum requested bandwidth. | | +| codecs | array(CodecData) | O | 1..2 | Indicates the codec data. | | + +### 5.9.4.21 Data types describing alternative data types or combinations of data types + +#### 5.9.4.21.1 Type: AssociatedSessionId + +**5.9.6.21.1-1: Definition of type AssociatedSessionId as a list of non-exclusive alternative data types** + +| Data type | Cardinality | Description | +|-----------|-------------|------------------------------------------| +| Ssm | 1 | AssociatedSessionId encoded as an SSM. | +| string | 1 | AssociatedSessionId encoded as a string. | + +## 5.10 Data Types related to Time Synchronization + +### 5.10.1 Introduction + +This clause defines common data types related to Time Synchronization. + +### 5.10.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.10.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|-----------|-----------------|-------------| +| n/a | | | + +## 5.10.3 Enumerations + +### 5.10.3.1 Enumeration: SynchronizationState + +**Table 5.10.3.1-1: Enumeration SynchronizationState** + +| Enumeration value | Description | +|-------------------|----------------------------------| +| "LOCKED" | Locked, see 3GPP TS 23.501 [2] | +| "HOLDOVER" | Holdover, see 3GPP TS 23.501 [2] | +| "FREERUN" | Freerun, see 3GPP TS 23.501 [2] | + +### 5.10.3.2 Enumeration: TimeSource + +**Table 5.10.3.2-1: Enumeration TimeSource** + +| Enumeration value | Description | +|---------------------|-------------------------------------------| +| "SYNC_E" | SyncE, see 3GPP TS 23.501 [2] | +| "PTP" | PTP, see 3GPP TS 23.501 [2] | +| "GNSS" | GNSS, see 3GPP TS 23.501 [2] | +| "ATOMIC_CLOCK" | atomic clock, see 3GPP TS 23.501 [2] | +| "TERRESTRIAL_RADIO" | terrestrial radio, see 3GPP TS 23.501 [2] | +| "SERIAL_TIME_CODE" | serial time code, see 3GPP TS 23.501 [2] | +| "NTP" | NTP, see 3GPP TS 23.501 [2] | +| "HAND_SET" | hand_set, see 3GPP TS 23.501 [2] | +| "OTHER" | other, see 3GPP TS 23.501 [2] | + +### 5.10.3.3 Enumeration: ClockQualityDetailLevel + +**Table 5.10.3.3-1: Enumeration ClockQualityDetailLevel** + +| Enumeration value | Description | +|-------------------------|------------------------------------------------------------------| +| "CLOCK_QUALITY_METRICS" | Clock Quality Metrics are to be provided to the UE | +| "ACCEPT_INDICATION" | Acceptable/not acceptable indication is to be provided to the UE | + +## 5.10.4 Structured Data Types + +### 5.10.4.1 Type: ClockQualityAcceptanceCriterion + +**Table 5.10.4.1-1: Definition of type ClockQualityAcceptanceCriterion** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| synchronizationState | SynchronizationState | O | 0..1 | Indicates the state of the node synchronization, represented by the values "LOCKED", "HOLDOVER", or "FREERUN" | +| clockQuality | ClockQuality | O | 0..1 | Clock Quality | +| parentTimeSource | TimeSource | O | 0..1 | Parent Time Source. | + +### 5.10.4.2 Type: ClockQuality + +**Table 5.10.4.2-1: Definition of type ClockQuality** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|----------------------------------------------------------------------| +| traceabilityToGnss | boolean | O | 0..1 | true indicates yes
false indicates no" | +| traceabilityToUtc | boolean | O | 0..1 | true indicates yes
false indicates no | +| frequencyStability | Uint16 | O | 0..1 | see 3GPP TS 23.501 [2] | +| clockAccuracy | string | O | 0..1 | string of two hexadecimal digits; see table 5 of IEEE Std 1588 [51]. | + +## 5.11 Data Types related to IMS SBA + +### 5.11.1 Introduction + +This clause defines common data types related to IMS SBA. + +### 5.11.2 Simple Data Types + +This clause specifies common simple data types. + +**Table 5.11.2-1: Simple Data Types** + +| Type Name | Type Definition | Description | +|----------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SessionId | string | Session ID is used for IMS session identification.
When present, the Session ID uniquely identifies the IMS session in a specific IMS service area.
This IE contains the information in the Call-ID header which is the typical header of SIP message. | +| MediaId | string | Media ID uniquely identifies one media flow within an IMS session. | +| MaxMessageSize | integer | The attribute can be associated with an "m=" line to indicate the maximum SCTP user message size (indicated in bytes) that an SCTP endpoint is willing to receive on the SCTP association associated with the "m=" line. Different attribute values can be used in each direction.

The MaxMessageSize is specified in IETF RFC 8841 [55]. | + +### 5.11.3 Enumerations + +#### 5.11.3.1 Enumeration: MediaResourceType + +The enumeration MediaResourceType indicates the type of media resource. It shall comply with the provisions defined in Table 5.11.3.1-1. + +**Table 5.11.3.1-1: Enumeration MediaResourceType** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------|---------------| +| "DC" | Data Channel. | | +| "AR" | Augmented Reality. | | +| "AUDIO" | Audio | | +| "VIDEO" | Video | | + +### 5.11.3.2 Enumeration: MediaProxy + +The enumeration MediaProxy represents the media proxy configuration applicable to the media flow. It shall comply with the provisions defined in Table 5.11.3.2-1. + +**Table 5.11.3.2-1: Enumeration MediaProxy** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------|---------------| +| "HTTP" | Represents the media proxy configuration is HTTP. | | +| "UDP" | Represents the media proxy configuration is UDP. | | + +### 5.11.3.3 Enumeration: SecuritySetup + +The enumeration SecuritySetup represents the security setup of the DTLS connection. It shall comply with the provisions defined in Table 5.11.3.3-1. + +**Table 5.11.3.3-1: Enumeration SecuritySetup** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------------------------------|---------------| +| "ACTIVE" | Represents the endpoint will initiate an outgoing connection. | | +| "PASSIVE" | Represents the endpoint will accept an incoming connection. | | +| "ACTPASS" | Represents the endpoint is willing to accept an incoming connection or to initiate an outgoing connection. | | + +## 5.11.4 Structured Data Types + +### 5.11.4.1 Type: DcEndpoint + +**Table 5.11.4.1-1: Definition of type DcEndpoint** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sctpPort | integer | M | 1 |

Represent the local or remote port for the Data Channel.

The SctpPort is formatted as the pattern defined in IETF RFC 8841 [55]. Minimum = 0. Maximum = 65535.

| +| fingerprint | string | O | 0..1 |

Represents the local or remote certificate fingerprint for the DTLS association.

The fingerprint is formatted as the pattern defined in IETF RFC 8122 [53].

Pattern: '^(SHA-1 SHA-224 SHA-256 SHA-384 SHA-512 MD5 MD2 TOKEN)\s[0-9A-F]{2}(:[0-9A-F]{2})+'

For example:
'SHA-1
4A:AD:B9:B1:3F:82:18:3B:54:02:12:DF:3E:5D:49:6B:
19:E5:7C:AB'.

| +| tlsId | string | O | 0..1 |

Represents the local or remote TLS ID for the media stream.

The TlsId is formatted as the pattern defined in IETF RFC 8842 [54].

Pattern: '[A-Fa-f0-9+/_-]{20,255}\$'

For example:
'abc3de65cdddef001be82'.

| + +### 5.11.4.2 Type: DcStream + +**Table 5.11.4.2-1: Definition of type DcStream** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| streamId | integer | M | 1 | Identifies the data channel stream.

The value range of the stream id is an unsigned 16-bit integer, i.e. 0 to 65535.
Minimum = 0. Maximum = 65535.

The 0-999 is used for Bootstrap Data Channel. The 1000-65535 is used for Application Data Channel. | +| subprotocol | string | O | 0..1 | Represents the subprotocol of the SCTP stream. It defaults to "http" if the mediaId represents bootstrap data channel.
(NOTE) | +| order | boolean | O | 0..1 | Represents the stream is ordered or not, "true" for ordered delivery and "false" for unordered delivery.
(NOTE) | +| maxRetry | integer | O | 0..1 | Represents the maximal number of the times a message will be retransmitted.
Default value: 0
(NOTE) | +| maxTime | integer | O | 0..1 | Represents the maximal lifetime in milliseconds after which a message will no longer be transmitted or retransmitted.
Default value: 0.
(NOTE) | +| priority | integer | O | 0..1 | Represents the priority of data channel relative to other data channels.
Default value: 256.
(NOTE) | +| appBindingInfo | string | C | 0..1 | Represents the application binding information of the Data Channel.
It shall be contained if the mediaId represents the application data channel. | + +NOTE: The IE cannot be changed once the media has been established. + +### 5.11.4.3 Type: ReplaceHttpUrl + +**Table 5.11.4.3-1: Definition of type ReplaceHttpUrl** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| replaceHttpUrl | Uri | M | 1 | Represents the replacement HTTP URL per stream ID allocated by the application layer for the specific IMS subscriber when requesting the application list (e.g., graphical user interface) via the MDC1 interface. | +| streamId | integer | M | 1 | Represents the stream ID that the replaceHttpUrl apply to.
The value range of the stream id is an unsigned 16-bit integer, i.e. 0 to 65535.
Minimum = 0. Maximum = 65535.

This attribute can only set to 0 or 100 here for Bootstrap Data Channel. | + +#### 5.11.4.4 Type: Endpoint + +**Table 5.11.4.4-1: Definition of type Endpoint** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------|---------------| +| ip | IpAddr | M | 1 | Represents the IP address of the endpoint. | | +| transport | TransportProtocol | M | 1 | Represents the transport protocol. | | +| portNumber | Uinteger | M | 1 | Represents the TCP or UDP port number of the endpoint. | | + +--- + +## Annex A (normative): OpenAPI specification + +### A.1 General + +This Annex specifies the formal definition of common data types. It consists of an OpenAPI 3.0.0 specification, in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository, that uses the GitLab software version control system (see 3GPP TS 29.501 [2] clause 5.3.1 and 3GPP TR 21.900 [27] clause 5B) + +--- + +### A.2 Data related to Common Data Types + +``` +openapi: 3.0.0 + +info: + version: '1.5.0-alpha.5' + + title: 'Common Data Types' + description: | + Common Data Types for Service Based Interfaces. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.4.0 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/' + +paths: {} +components: + schemas: +``` + +``` +# +# Common Data Types for Generic usage definitions as defined in clause 5.2 +# +# +# COMMON SIMPLE DATA TYPES +# +Binary: + format: binary + type: string + description: string with format 'binary' as defined in OpenAPI. + +BinaryRm: + format: binary + type: string + nullable: true + description: "string with format 'binary' as defined in OpenAPI OpenAPI with 'nullable: true' property." + +Bytes: + format: byte + type: string + description: string with format 'bytes' as defined in OpenAPI + +BytesRm: + format: byte + type: string + nullable: true + description: > + string with format 'bytes' as defined in OpenAPI OpenAPI with 'nullable: true' property. + +Date: + format: date + type: string + description: string with format 'date' as defined in OpenAPI. + +DateRm: + format: date + type: string + nullable: true + description: > + string with format 'date' as defined in OpenAPI OpenAPI with 'nullable: true' property. + +DateTime: + format: date-time + type: string + description: string with format 'date-time' as defined in OpenAPI. + +DateTimeRm: + format: date-time + type: string + nullable: true + description: > + string with format 'date-time' as defined in OpenAPI with 'nullable:true' property. + +DiameterIdentity: + $ref: '#/components/schemas/Fqdn' + +DiameterIdentityRm: + $ref: '#/components/schemas/FqdnRm' + +Double: + format: double + type: number + description: string with format 'double' as defined in OpenAPI + +DoubleRm: + format: double + type: number + nullable: true + description: > + string with format 'double' as defined in OpenAPI with 'nullable: true' property. + +DurationSec: + type: integer + description: indicating a time in seconds. + +DurationSecRm: +``` + +``` + +type: integer +nullable: true +description: "indicating a time in seconds with OpenAPI defined 'nullable: true' property." + +Float: + format: float + type: number + description: string with format 'float' as defined in OpenAPI. + +FloatRm: + format: float + type: number + nullable: true + description: > + string with format 'float' as defined in OpenAPI with the OpenAPI defined + 'nullable: true' property. + +Int32: + format: int32 + type: integer + description: string with format 'int32' as defined in OpenAPI. + +Int32Rm: + format: int32 + type: integer + nullable: true + description: > + string with format 'int32' as defined in OpenAPI with the OpenAPI defined + 'nullable: true' property. + +Int64: + type: integer + format: int64 + description: string with format 'int64' as defined in OpenAPI. + +Int64Rm: + format: int64 + type: integer + nullable: true + description: > + string with format 'int64' as defined in OpenAPI with the OpenAPI defined + 'nullable: true' property. + +Ipv4Addr: + type: string + pattern: '^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$)' + example: '198.51.100.1' + description: > + String identifying a IPv4 address formatted in the 'dotted decimal' notation + as defined in RFC 1166. + +Ipv4AddrRm: + type: string + pattern: '^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$)' + example: '198.51.100.1' + nullable: true + description: > + String identifying a IPv4 address formatted in the 'dotted decimal' notation + as defined in RFC 1166 with the OpenAPI defined 'nullable: true' property. + +Ipv4AddrMask: + type: string + pattern: '^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\s/([0-9]|[1-2][0-9]|3[0-2]))$)' + example: '198.51.0.0/16' + description: > + "String identifying a IPv4 address mask formatted in the 'dotted decimal' notation + as defined in RFC 1166." + +Ipv4AddrMaskRm: + type: string + pattern: '^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\s/([0-9]|[1-2][0-9]|3[0-2]))$)' + example: '198.51.0.0/16' + nullable: true + description: > + +``` + +String identifying a IPv4 address mask formatted in the 'dotted decimal' notation as defined in RFC 1166 with the OpenAPI defined 'nullable: true' property. + +``` + +Ipv6Addr: + type: string + allOf: + - pattern: '^((:(|0?|[1-9a-f][0-9a-f]{0,3})):|((0?|[1-9a-f][0-9a-f]{0,3})):|{0,6}:(|0?|[1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([:]+){7}([:]+)|((([:]+):)*[:]+)?:|(([:]+):)*[:]+)?:))$' + example: '2001:db8:85a3::8a2e:370:7334' + description: > + String identifying an IPv6 address formatted according to clause 4 of RFC5952. + The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used. + +``` + +``` + +Ipv6AddrRm: + type: string + allOf: + - pattern: '^((:(|0?|[1-9a-f][0-9a-f]{0,3})):|((0?|[1-9a-f][0-9a-f]{0,3})):|{0,6}:(|0?|[1-9a-f][0-9a-f]{0,3})))$' + - pattern: '^((([:]+){7}([:]+)|((([:]+):)*[:]+)?:|(([:]+):)*[:]+)?:))$' + example: '2001:db8:85a3::8a2e:370:7334' + nullable: true + description: > + String identifying an IPv6 address formatted according to clause 4 of RFC5952 with the OpenAPI 'nullable: true' property. + The mixed IPv4 IPv6 notation according to clause 5 of RFC5952 shall not be used. + +``` + +``` + +Ipv6Prefix: + type: string + allOf: + - pattern: '^((:(|0?|[1-9a-f][0-9a-f]{0,3})):|((0?|[1-9a-f][0-9a-f]{0,3})):|{0,6}:(|0?|[1-9a-f][0-9a-f]{0,3})))|(/([0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}))$' + - pattern: '^((([:]+){7}([:]+)|((([:]+):)*[:]+)?:|(([:]+):)*[:]+)?:))|(/.+)$' + example: '2001:db8:abcd:12::0/64' + description: > + String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952. + IPv6Prefix data type may contain an individual /128 IPv6 address. + +``` + +``` + +Ipv6PrefixRm: + type: string + allOf: + - pattern: '^((:(|0?|[1-9a-f][0-9a-f]{0,3})):|((0?|[1-9a-f][0-9a-f]{0,3})):|{0,6}:(|0?|[1-9a-f][0-9a-f]{0,3})))|(/([0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}|[0-9]{1,2}|[1-9]{1,2}))$' + - pattern: '^((([:]+){7}([:]+)|((([:]+):)*[:]+)?:|(([:]+):)*[:]+)?:))|(/.+)$' + nullable: true + description: > + String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952 with the OpenAPI 'nullable: true' property. IPv6Prefix data type may contain an individual /128 IPv6 address. + +``` + +``` + +MacAddr48: + type: string + pattern: '^([0-9a-fA-F]{2})((-)[0-9a-fA-F]{2}){5})$' + description: > + String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042. + +``` + +``` + +MacAddr48Rm: + type: string + pattern: '^([0-9a-fA-F]{2})((-)[0-9a-fA-F]{2}){5})$' + nullable: true + description: > + "String identifying a MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of RFC 7042 with the OpenAPI 'nullable: true' property." + +``` + +``` + +SupportedFeatures: + type: string + pattern: '^[A-Fa-f0-9]*$' + description: > + A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by + +``` + +characters that are not present in the string are not supported. + +UInteger: +type: integer +minimum: 0 +description: Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. + +UIntegerRm: +type: integer +minimum: 0 +description: > +Unsigned Integer, i.e. only value 0 and integers above 0 are permissible with +the OpenAPI 'nullable: true' property. +nullable: true + +Uint16: +type: integer +minimum: 0 +maximum: 65535 +description: > +Integer where the allowed values correspond to the value range of an +unsigned 16-bit integer. + +Uint16Rm: +type: integer +minimum: 0 +maximum: 65535 +nullable: true +description: > +Integer where the allowed values correspond to the value range of an unsigned +16-bit integer with the OpenAPI 'nullable: true' property. + +Uint32: +type: integer +minimum: 0 +maximum: 4294967295 #(2^32)-1 +description: > +Integer where the allowed values correspond to the value range of an unsigned +32-bit integer. + +Uint32Rm: +format: int32 +type: integer +minimum: 0 +maximum: 4294967295 #(2^32)-1 +nullable: true +description: > +Integer where the allowed values correspond to the value range of an unsigned +32-bit integer with the OpenAPI 'nullable: true' property. + +Uint64: +type: integer +minimum: 0 +maximum: 18446744073709551615 #(2^64)-1 +description: > +Integer where the allowed values correspond to the value range of an +unsigned 64-bit integer. + +Uint64Rm: +type: integer +minimum: 0 +maximum: 18446744073709551615 #(2^64)-1 +nullable: true +description: > +Integer where the allowed values correspond to the value range of an unsigned +16-bit integer with the OpenAPI 'nullable: true' property. + +Uri: +type: string +description: String providing an URI formatted according to RFC 3986. + +UriRm: +type: string +nullable: true +description: > +String providing an URI formatted according to RFC 3986 with the OpenAPI +'nullable: true' property. + +``` + +VarUeId: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^\+]+\+|gci-.+|gli-.+|\+.)$' + description: String represents the SUPI or GPSI + +VarUeIdRm: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^\+]+\+|gci-.+|gli-.+|\+.)$' + nullable: true + description: "String represents the SUPI or GPSI with the OpenAPI 'nullable: true' property." + +TimeZone: + type: string + example: '-08:00+1' + description: | + String with format "time-numoffset" optionally appended by "daylightSavingTime", where + - "time-numoffset" shall represent the time zone adjusted for daylight saving time and be + encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; + - "daylightSavingTime" shall represent the adjustment that has been made and shall be + encoded as "+1" or "+2" for a +1 or +2 hours adjustment. + + The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time. + +TimeZoneRm: + type: string + nullable: true + description: | + "String with format 'time-numoffset' optionally appended by '', where + - 'time-numoffset' shall represent the time zone adjusted for daylight saving time and be + encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339; + - 'daylightSavingTime' shall represent the adjustment that has been made and shall be + encoded as '+1' or '+2' for a +1 or +2 hours adjustment. + + But with the OpenAPI 'nullable: true' property." + +StnSr: + type: string + description: String representing the STN-SR as defined in clause 18.6 of 3GPP TS 23.003. + +StnSrRm: + type: string + nullable: true + description: > + String representing the STN-SR as defined in clause 18.6 of 3GPP TS 23.003 + with the OpenAPI 'nullable: true' property. + +CMsisdn: + type: string + pattern: '^[0-9]{5,15}$' + description: String representing the C-MSISDN as defined in clause 18.7 of 3GPP TS 23.003. + +CMsisdnRm: + type: string + pattern: '^[0-9]{5,15}$' + nullable: true + description: > + String representing the C-MSISDN as defined in clause 18.7 of 3GPP TS 23.003 with + the OpenAPI 'nullable: true' property. + +DayOfWeek: + type: integer + minimum: 1 + maximum: 7 + description: > + integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, + and the subsequent weekdays shall be indicated with the next higher numbers. + 7 shall indicate Sunday. + +TimeOfDay: + type: string + description: > + String with format partial-time or full-time as defined in clause 5.6 of IETF RFC 3339. + Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). + +EmptyObject: + description: Empty JSON object { }, it is defined with the keyword additionalProperties false + type: object + additionalProperties: false + +``` + +``` +Fqdn: + description: Fully Qualified Domain Name + type: string + pattern: '^(?:[0-9A-Za-z]([0-9A-Za-z]{0,61}[0-9A-Za-z])?\.)+[A-Za-z]{2,63}\.?$' + minLength: 4 + maxLength: 253 + +FqdnRm: + description: Fully Qualified Domain Name, but it also allows the null value + anyOf: + - $ref: '#/components/schemas/Fqdn' + - $ref: '#/components/schemas/NullValue' + +# +# COMMON ENUMERATED DATA TYPES +# + +PatchOperation: + anyOf: + - type: string + enum: + - add + - copy + - move + - remove + - replace + - test + - type: string + description: Operations as defined in IETF RFC 6902. + +UriScheme: + anyOf: + - type: string + enum: + - http + - https + - type: string + description: HTTP and HTTPS URI scheme. + +ChangeType: + anyOf: + - type: string + enum: + - ADD + - MOVE + - REMOVE + - REPLACE + - type: string + description: Indicates the type of change to be performed. + +HttpMethod: + anyOf: + - type: string + enum: + - GET + - POST + - PUT + - DELETE + - PATCH + - OPTIONS + - HEAD + - CONNECT + - TRACE + - type: string + description: HTTP methodes. + +NullValue: + enum: + - null + description: JSON's null value. + +MatchingOperator: + anyOf: + - type: string + enum: + - FULL_MATCH +``` + +``` + - MATCH_ALL + - STARTS_WITH + - NOT_START_WITH + - ENDS_WITH + - NOT_END_WITH + - CONTAINS + - NOT_CONTAIN + - type: string + description: the matching operation. + +# +# COMMON STRUCTURED DATA TYPES +# + +ProblemDetails: + description: Provides additional information in an error response. + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + status: + type: integer + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem. + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + description: > + A machine-readable application error cause specific to this occurrence of the problem. + This IE should be present and provide application-related error information, if + available. + invalidParams: + type: array + items: + $ref: '#/components/schemas/InvalidParam' + minItems: 1 + supportedFeatures: + $ref: '#/components/schemas/SupportedFeatures' + accessTokenError: + $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenErr' + accessTokenRequest: + $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenReq' + nrfId: + $ref: '#/components/schemas/Fqdn' + supportedApiVersions: + type: array + items: + type: string + minItems: 1 + +Link: + type: object + properties: + href: + $ref: '#/components/schemas/Uri' + description: It contains the URI of the linked resource. + +LinkRm: + type: object + properties: + href: + $ref: '#/components/schemas/Uri' + nullable: true + description: > + It contains the URI of the linked resource with the OpenAPI 'nullable: true' property. + +PatchItem: + type: object + properties: + op: + $ref: '#/components/schemas/PatchOperation' + path: + type: string + description: > +``` + +``` + contains a JSON pointer value (as defined in IETF RFC 6901) that references + a location of a resource on which the patch operation shall be performed. + from: + type: string + description: > + indicates the path of the source JSON element (according to JSON Pointer syntax) + being moved or copied to the location indicated by the "path" attribute. + value: {} + required: + - op + - path + description: it contains information on data to be changed. + +LinksValueSchema: + oneOf: + - type: array + items: + $ref: '#/components/schemas/Link' + minItems: 1 + - $ref: '#/components/schemas/Link' + description: A list of mutually exclusive alternatives of 1 or more links. + +SelfLink: + type: object + properties: + self: + $ref: '#/components/schemas/Link' + required: + - self + description: It contains the URI of the linked resource. + +InvalidParam: + type: object + properties: + param: + type: string + description: > + If the invalid parameter is an attribute in a JSON body, this IE shall contain the + attribute's name and shall be encoded as a JSON Pointer. If the invalid parameter is + an HTTP header, this IE shall be formatted as the concatenation of the string "header " + plus the name of such header. If the invalid parameter is a query parameter, this IE + shall be formatted as the concatenation of the string "query " plus the name of such + query parameter. If the invalid parameter is a variable part in the path of a resource + URI, this IE shall contain the name of the variable, including the symbols "{ " and "}" + used in OpenAPI specification as the notation to represent variable path segments. + reason: + type: string + description: > + A human-readable reason, e.g. "must be a positive integer". In cases involving failed + operations in a PATCH request, the reason string should identify the operation that + failed using the operation's array index to assist in correlation of the invalid + parameter with the failed operation, e.g." Replacement value invalid for attribute + (failed operation index= 4)" + required: + - param + description: It contains an invalid parameter and a related description. + +ChangeItem: + type: object + properties: + op: + $ref: '#/components/schemas/ChangeType' + path: + type: string + description: > + contains a JSON pointer value (as defined in IETF RFC 6901) that references a target + location within the resource on which the change has been applied. + from: + type: string + description: > + indicates the path of the source JSON element (according to JSON Pointer syntax) + being moved or copied to the location indicated by the "path" attribute. It shall + be present if the "op" attribute is of value "MOVE". + origValue: {} + newValue: {} + required: + - op + - path +``` + +description: It contains data which need to be changed. + +NotifyItem: +type: object +required: +- resourceId +- changes +properties: +resourceId: +\$ref: '#/components/schemas/Uri' +changes: +type: array +items: +\$ref: '#/components/schemas/ChangeItem' +minItems: 1 +description: Indicates changes on a resource. + +ComplexQuery: +oneOf: +- \$ref: '#/components/schemas/Cnf' +- \$ref: '#/components/schemas/Dnf' +description: > +The ComplexQuery data type is either a conjunctive normal form or a disjunctive normal form. +The attribute names "cnfUnits" and "dnfUnits" (see clause 5.2.4.11 and clause 5.2.4.12) +serve as discriminator. + +Cnf: +type: object +required: +- cnfUnits +properties: +cnfUnits: +type: array +items: +\$ref: '#/components/schemas/CnfUnit' +minItems: 1 +description: A conjunctive normal form + +Dnf: +type: object +required: +- dnfUnits +properties: +dnfUnits: +type: array +items: +\$ref: '#/components/schemas/DnfUnit' +minItems: 1 +description: A disjunctive normal form. + +CnfUnit: +type: object +required: +- cnfUnit +properties: +cnfUnit: +type: array +items: +\$ref: '#/components/schemas/Atom' +minItems: 1 +description: > +During the processing of cnfUnits attribute, all the members in the array shall be +interpreted as logically concatenated with logical "AND". + +DnfUnit: +type: object +required: +- dnfUnit +properties: +dnfUnit: +type: array +items: +\$ref: '#/components/schemas/Atom' +minItems: 1 +description: > +During the processing of dnfUnits attribute, all the members in the array shall be +interpreted as logically concatenated with logical "OR". + +Atom: +description: contains a search parameter and its positive or negative content. +type: object +required: +- attr +- value +properties: +attr: +type: string +description: contains the name of a defined query parameter. +value: {} +negative: +type: boolean +description: indicates whether the negative condition applies for the query condition. + +PatchResult: +description: The execution report result on failed modification. +type: object +required: +- report +properties: +report: +type: array +items: +\$ref: '#/components/schemas/ReportItem' +minItems: 1 +description: > +The execution report contains an array of report items. Each report item indicates one failed modification. + +ReportItem: +type: object +required: +- path +properties: +path: +type: string +description: > +Contains a JSON pointer value (as defined in IETF RFC 6901) that references a location of a resource to which the modification is subject. +reason: +type: string +description: > +A human-readable reason providing details on the reported modification failure. +The reason string should identify the operation that failed using the operation's array index to assist in correlation of the invalid parameter with the failed operation, e.g. "Replacement value invalid for attribute (failed operation index= 4)". +description: indicates performed modifications. + +HalTemplate: +description: > +Hypertext Application Language (HAL) template contains the extended 3GPP hypermedia format. +type: object +required: +- method +properties: +title: +type: string +description: A human-readable string that can be used to identify this template +method: +\$ref: '#/components/schemas/HttpMethod' +contentType: +type: string +description: > +The media type that should be used for the corresponding request. If the attribute is missing, or contains an unrecognized value, the client should act as if the contentType is set to "application/json". +properties: +type: array +items: +\$ref: '#/components/schemas/Property' +minItems: 1 +description: > +The properties that should be included in the body of the corresponding request. +If the contentType attribute is set to "application/json", then this attribute describes the attributes of the JSON object of the body. + +Property: + +``` +description: > + If the contentType attribute is set to "application/json", then this attribute describes + the attributes of the JSON object of the body. +type: object +required: +- name +properties: + name: + type: string + description: The name of the property + required: + type: boolean + description: > + Indicates whether the property is required - true= required - + false(default)= not required. + regex: + type: string + description: A regular expression string to be applied to the value of the property. + value: + type: string + description: The property value. When present, it shall be a valid JSON string. + +RedirectResponse: +description: > + The response shall include a Location header field containing a different URI + (pointing to a different URI of an other service instance), or the same URI if a request + is redirected to the same target resource via a different SCP. +type: object +properties: + cause: + type: string + targetScp: + $ref: '#/components/schemas/Uri' + targetSepp: + $ref: '#/components/schemas/Uri' + +TunnelAddress: +description: Tunnel address +type: object +properties: + ipv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + portNumber: + $ref: '#/components/schemas/Uinteger' +required: +- portNumber +anyOf: +- required: [ ipv4Addr ] +- required: [ ipv6Addr ] + +FqdnPatternMatchingRule: +description: a matching rule for a FQDN pattern +type: object +oneOf: +- required: [ regex ] +- required: [ stringMatchingRule ] +properties: + regex: + type: string + stringMatchingRule: + $ref: '#/components/schemas/StringMatchingRule' + +StringMatchingRule: +description: A list of conditions for string matching +type: object +properties: + stringMatchingConditions: + type: array + items: + $ref: '#/components/schemas/StringMatchingCondition' + minItems: 1 + +StringMatchingCondition: +description: A String with Matching Operator +``` + +``` +type: object +properties: + matchingString: + type: string + matchingOperator: + $ref: '#/components/schemas/MatchingOperator' +required: + - matchingOperator + +Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: '#/components/schemas/Ipv4Addr' + end: + $ref: '#/components/schemas/Ipv4Addr' + required: + - start + - end + +Ipv6AddressRange: + description: Range of IPv6 addresses + type: object + properties: + start: + $ref: '#/components/schemas/Ipv6Addr' + end: + $ref: '#/components/schemas/Ipv6Addr' + required: + - start + - end + +Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: '#/components/schemas/Ipv6Prefix' + end: + $ref: '#/components/schemas/Ipv6Prefix' + required: + - start + - end + +# +# Data Types related to Subscription, Identification and Numbering as defined in clause 5.3 +# + +# +# SIMPLE DATA TYPES +# + +Dnn: + type: string + description: > + String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; + it shall contain either a DNN Network Identifier, or a full DNN with both the Network + Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. + It shall be coded as string in which the labels are separated by dots + (e.g. "Label1.Label2.Label3"). +DnnRm: + type: string + nullable: true + description: > + String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; + it shall contain either a DNN Network Identifier, or a full DNN with both the + Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 + and 9.1.2. It shall be coded as string in which the labels are separated by dots + (e.g. "Label1.Label2.Label3") with the OpenAPI 'nullable: true' property. + +WildcardDnn: + type: string + pattern: '^[^*]+$' + description: String representing the Wildcard DNN. It shall contain the string "*". + +WildcardDnnRm: + type: string +``` + +``` + + pattern: '^[*]$' + nullable: true + description: > + String representing the Wildcard DNN. It shall contain the string '*' but with the + OpenAPI 'nullable: true' property. + +Gpsi: + type: string + pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+\.+)$' + description: > + String identifying a Gpsi shall contain either an External Id or an MSISDN. + It shall be formatted as follows -External Identifier= "extid-'extid'", where 'extid' + shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an + External Identifier. + +GpsiRm: + type: string + pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+\.+)$' + nullable: true + description: > + String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be + formatted as follows -External Identifier= 'extid-'extid', where 'extid' shall be formatted + according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier with the + OpenAPI 'nullable: true' property. + +GroupId: + type: string + pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' + description: > + String identifying a group of devices network internal globally unique ID which identifies + a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003. + +GroupIdRm: + type: string + pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' + nullable: true + description: > + String identifying a group of devices network internal globally unique ID which + identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003 with the + OpenAPI 'nullable: true' property. + +ExternalGroupId: + type: string + pattern: '^extgroupid-[^@]+@[^@]+$' + description: > + String identifying External Group Identifier that identifies a group made up of one or + more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of 3GPP + TS 23.003. + +ExternalGroupIdRm: + type: string + pattern: '^extgroupid-[^@]+@[^@]+$' + nullable: true + description: > + String identifying External Group Identifier that identifies a group made up of one or + more subscriptions associated to a group of IMSIs, as specified in clause 19.7.3 of + 3GPP TS 23.003 with the OpenAPI 'nullable: true' property. + +Pei: + type: string + pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' + description: > + String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, + as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via + wireline access, with an indication that this address cannot be trusted for regulatory + purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as + specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or + imeisv-0123456789012345. + +PeiRm: + type: string + pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' + nullable: true + description: > + This data type is defined in the same way as the 'Pei' data type but with + the OpenAPI 'nullable: true' property. + +``` + +Supi: +type: string +pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)\$' +description: | +String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows + +- for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI. +- for a network specific identifier "nai-", where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI. +- for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003. +- for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. + +SupiRm: +type: string +pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)\$' +nullable: true +description: > +This data type is defined in the same way as the 'Supi' data type, but with the OpenAPI 'nullable: true' property. + +NfInstanceId: +type: string +format: uuid +description: > +String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. + +AmfId: +type: string +pattern: '^[A-Fa-f0-9]{6}\$' +description: > +String identifying the AMF ID composed of AMF Region ID (8 bits), AMF Set ID (10 bits) and AMF Pointer (6 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 6 hexadecimal characters (i.e., 24 bits). + +AmfRegionId: +type: string +pattern: '^[A-Fa-f0-9]{2}\$' +description: > +String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 3 hexadecimal characters where the first character is limited to values 0 to 3 (i.e. 10 bits) + +AmfSetId: +type: string +pattern: '^[0-3][A-Fa-f0-9]{2}\$' +description: > +String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003. It is encoded as a string of 3 hexadecimal characters where the first character is limited to values 0 to 3 (i.e. 10 bits). + +RfspIndex: +type: integer +minimum: 1 +maximum: 256 +description: > +Unsigned integer representing the "Subscriber Profile ID for RAT/Frequency Priority" as specified in 3GPP TS 36.413. + +RfspIndexRm: +type: integer +minimum: 1 +maximum: 256 +nullable: true +description: > +Unsigned integer representing the 'Subscriber Profile ID for RAT/Frequency Priority' as specified in 3GPP TS 36.413 with the OpenAPI 'nullable: true' property. + +NfGroupId: +type: string +description: Identifier of a group of NFs. + +``` + +MtcProviderInformation: + type: string + description: String uniquely identifying MTC provider information. + +CagId: + type: string + pattern: '^[A-Fa-f0-9]{8}$' + description: String containing a Closed Access Group Identifier. + +SupiOrSuci: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.*|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+))$' + description: String identifying a SUPI or a SUCI. + +Imsi: + description: String identifying an IMSI + type: string + pattern: '^[0-9]{5,15}$' + +ApplicationlayerId: + type: string + description: > + String identifying an UE with application layer ID. The format of the application + layer ID parameter is same as the Application layer ID defined in clause 11.3.4 of + 3GPP TS 24.554. + +NsacSai: + type: string + description: > + String identifying the Network Slice Admission Control Service Area Identifier. + +# +# ENUMERATED DATA TYPES +# + +GroupServiceId: + anyOf: + - type: integer + enum: + - 1 + - 2 + - 3 + - type: integer + description: > + This integer provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: | + Possible values are: + - 1: Group specific NAS level congestion control + - 2: Group specific Monitoring of Number of UEs present in a geographical area + - 3: Group specific Group specific for 5G LAN Type service + +# +# STRUCTURED DATA TYPES +# + +Guami: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnIdNid' + amfId: + $ref: '#/components/schemas/AmfId' + required: + - plmnId + - amfId + description: Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity. + +GuamiRm: + anyOf: + - $ref: '#/components/schemas/Guami' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'Guami' data type, but with the OpenAPI + 'nullable: true' property. + +``` + +``` +NetworkId: + type: object + properties: + mnc: + $ref: '#/components/schemas/Mnc' + mcc: + $ref: '#/components/schemas/Mcc' + description: contains PLMN and Network identity. + +# +# Data Types related to 5G Network as defined in clause 5.4 +# + +# +# SIMPLE DATA TYPES +# + +ApplicationId: + type: string + description: String providing an application identifier. +ApplicationIdRm: + type: string + nullable: true + description: > + String providing an application identifier with the OpenAPI 'nullable: true' property. + +PduSessionId: + type: integer + minimum: 0 + maximum: 255 + description: > + Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in + clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the + Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID + within the reserved range is only visible in the Core Network. + +Mcc: + type: string + pattern: '^\\d{3}$' + description: > + Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 + of 3GPP TS 38.413. + +MccRm: + type: string + pattern: '^\\d{3}$' + nullable: true + description: > + Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of + 3GPP TS 38.413 with the OpenAPI 'nullable: true' property. + +Mnc: + type: string + pattern: '^\\d{2,3}$' + description: Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in +clause 9.3.3.5 of 3GPP TS 38.413. + +MncRm: + type: string + pattern: '^\\d{2,3}$' + nullable: true + description: > + Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause + 9.3.3.5 of 3GPP TS 38.413 with the OpenAPI 'nullable: true' property. + +Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + description: > + 2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10 + of 3GPP TS 38.413, in hexadecimal representation. Each character in the string shall + take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The + most significant character representing the 4 most significant bits of the TAC shall + appear first in the string, and the character representing the 4 least significant bit + of the TAC shall appear last in the string. + +TacRm: +``` + +``` +type: string +pattern: '^(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' +nullable: true +description: > + This data type is defined in the same way as the 'Tac' data type, but with the + OpenAPI 'nullable: true' property. + +EutraCellId: +type: string +pattern: '^[A-Fa-f0-9]{7}$' +description: > + 28-bit string identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of + 3GPP TS 38.413, in hexadecimal representation. Each character in the string shall take a + value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most + significant character representing the 4 most significant bits of the Cell Id shall appear + first in the string, and the character representing the 4 least significant bit of the + Cell Id shall appear last in the string. + +EutraCellIdRm: +type: string +pattern: '^[A-Fa-f0-9]{7}$' +nullable: true +description: > + This data type is defined in the same way as the 'EutraCellId' data type, but with + the OpenAPI 'nullable: true' property. + +NrCellId: +type: string +pattern: '^[A-Fa-f0-9]{9}$' +description: > + 36-bit string identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413, + in hexadecimal representation. Each character in the string shall take a value of "0" to + "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character + representing the 4 most significant bits of the Cell Id shall appear first in the string, + and the character representing the 4 least significant bit of the Cell Id shall appear last + in the string. + +NrCellIdRm: +type: string +pattern: '^[A-Fa-f0-9]{9}$' +nullable: true +description: > + This data type is defined in the same way as the 'NrCellId' data type, but with the + OpenAPI 'nullable: true' property. + +Dnai: +type: string +description: DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501. + +DnaiRm: +type: string +nullable: true +description: > + This data type is defined in the same way as the 'Dnai' data type, but with the + OpenAPI 'nullable: true' property. + +5GMmCause: +$ref: '#/components/schemas/UInteger' + +AmfName: +$ref: '#/components/schemas/Fqdn' + +AreaCode: +type: string +description: Values are operator specific. + +AreaCodeRm: +type: string +nullable: true +description: > + This data type is defined in the same way as the 'AreaCode' data type, but with the + OpenAPI 'nullable: true' property. + +N3IwfId: +type: string +pattern: '^[A-Fa-f0-9]+$' +description: > + This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of +``` + +3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string. + +WAgfId: +type: string +pattern: '^[A-Fa-f0-9]+\$' +description: > +This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID shall appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID shall appear last in the string. + +TngfId: +type: string +pattern: '^[A-Fa-f0-9]+\$' +description: > +This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID shall appear first in the string, and the character representing the 4 least significant bit of the TNGF ID shall appear last in the string. + +NgeNbId: +type: string +pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})\$' +description: > +This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413. The value of the ng-eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the ng-eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) shall appear last in the string. + +example: SMacroNGeNB-34B89 + +Nid: +type: string +pattern: '^[A-Fa-f0-9]{11}\$' +description: > +This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 and 3GPP TS 23.501 clause 5.30.2.1). + +NidRm: +type: string +pattern: '^[A-Fa-f0-9]{11}\$' +nullable: true +description: > +This data type is defined in the same way as the 'Nid' data type, but with the OpenAPI 'nullable: true' property." + +NfSetId: +type: string +description: > +NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string +"set.set.5gc.mnc.mcc", or +"set.set.5gc.nid.mnc.mcc" with + encoded as defined in clause 5.4.2 ("Mcc" data type definition) + encoding the Mobile Network Code part of the PLMN, comprising 3 digits. +If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}\$' + encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit. + +NfServiceSetId: +type: string +description: > +NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003) formatted as the following + +``` + +string "set.sn.nfi.5gc.mnc.mcc", or +"set.sn.nfi.5gc.nid.mnc.mcc" with + encoded as defined in clause 5.4.2 ("Mcc" data type definition) + encoding the Mobile Network Code part of the PLMN, comprising 3 digits. + If there are only 2 significant digits in the MNC, one "0" digit shall be inserted + at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' + encoded as defined in clause 5.4.2 ("Nid" data type definition) + encoded as defined in clause 5.3.2 + encoded as defined in 3GPP TS 29.510 + encoded as a string of characters consisting of alphabetic + characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end + with either an alphabetic character or a digit. + +``` + +PlmnAssiUeRadioCapId: + +\$ref: '#/components/schemas/Bytes' + +ManAssiUeRadioCapId: + +\$ref: '#/components/schemas/Bytes' + +TypeAllocationCode: + +type: string + +pattern: '^[0-9]{8}\$' + +description: > + +Type Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the 15-digit IMEI and 16-digit IMEISV codes. See clause 6.2 of 3GPP TS 23.003. + +HfcNId: + +type: string + +maxLength: 6 + +description: > + +This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters. + +HfcNIdRm: + +type: string + +maxLength: 6 + +nullable: true + +description: > + +This data type is defined in the same way as the 'HfcNId' data type, but with the OpenAPI 'nullable: true' property. + +ENbId: + +type: string + +pattern: '^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})\$' + +description: > + +This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413. The string shall be formatted with the following pattern '^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})\$'. The value of the eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) shall appear last in the string. + +GLI: + +\$ref: '#/components/schemas/Bytes' + +Gci: + +type: string + +description: > + +Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003. This shall be encoded as a string per clause 28.15.4 of 3GPP TS 23.003, and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH. + +NsSrcg: + +type: string + +description: > + +String providing a Network Slice Simultaneous Registration Group. See clause 5.15.12 of 3GPP TS 23.501 + +NsSrcgRm: + +type: string + +nullable: true + +``` + +description: > + String providing a Network Slice Simultaneous Registration Group with the OpenAPI + "nullable: true" property. See clause 5.15.12 of 3GPP TS 23.501 + +RelayServiceCode: + type: integer + minimum: 0 + maximum: 16777215 + description: > + Relay Service Code to identify a connectivity service provided by the UE-to-Network relay or + the UE-to-UE relay. + +5GPrukId: + type: string + description: > + A string carrying the CP-PRUK ID of the 5G ProSe Remote UE or the 5G ProSe End UE. + The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003. + pattern: '^rid[0-9]{1,4}.pid[0-9a-fA-F]+\@prose-cp\.5gc\.mnc[0-9]{2,3}\.mcc[0-9]{3}\.3gppnetwork\.org$' + +NsagId: + type: integer + description: > + The Network Slice AS Group ID, see 3GPP TS 38.413 + +NsagIdRm: + type: integer + nullable: true + description: > + This data type is defined in the same way as the "NsagId" data type, but with the OpenAPI + "nullable: true" property + +GeoSatelliteId: + type: string + description: > + A string carrying the GEO Satellite ID. + +OffloadIdentifier: + type: string + description: > + Offload identifier uniquely identifying a VPLMN offloading policy information instance + pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{8}(-v[0-9]{1,2}){0,1}$' + +# +# ENUMERATED DATA TYPES +# + +AccessType: + type: string + enum: + - 3GPP_ACCESS + - NON_3GPP_ACCESS + description: Indicates whether the access is via 3GPP or via non-3GPP. + +AccessTypeRm: + anyOf: + - $ref: '#/components/schemas/AccessType' + - $ref: '#/components/schemas/NullValue' + description: > + Indicates whether the access is via 3GPP or via non-3GPP but with the OpenAPI + 'nullable: true' property. + +RatType: + anyOf: + - type: string + enum: + - NR + - EUTRA + - WLAN + - VIRTUAL + - NB-IOT + - WIREFRAME + - WIREFRAME_CABLE + - WIREFRAME_BBF + - LTE-M + - NR_U + - EUTRA_U + +``` + +``` + - TRUSTED_N3GA + - TRUSTED_WLAN + - UTRA + - GERA + - NR_LEO + - NR_MEO + - NR_GEO + - NR_OTHER_SAT + - NR_REDCAP + - WB_E_UTRAN_LEO + - WB_E_UTRAN_MEO + - WB_E_UTRAN_GEO + - WB_E_UTRAN_OTHERSAT + - NB_IOT_LEO + - NB_IOT_MEO + - NB_IOT_GEO + - NB_IOT_OTHERSAT + - LTE_M_LEO + - LTE_M_MEO + - LTE_M_GEO + - LTE_M_OTHERSAT + - type: string + description: Indicates the radio access used. + +RatTypeRm: + anyOf: + - $ref: '#/components/schemas/RatType' + - $ref: '#/components/schemas/NullValue' + description: > + Provides information about the radio access but with the OpenAPI 'nullable: true' property. + +PduSessionType: + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - UNSTRUCTURED + - ETHERNET + - type: string + description: > + PduSessionType indicates the type of a PDU session. It shall comply with the provisions + defined in table 5.4.3.3-1. + +PduSessionTypeRm: + anyOf: + - $ref: '#/components/schemas/PduSessionType' + - $ref: '#/components/schemas/NullValue' + description: > + PduSessionType indicates the type of a PDU session. It shall comply with the provisions + defined in table 5.4.3.3-1 but with the OpenAPI "nullable: true" property. + +UpIntegrity: + anyOf: + - type: string + enum: + - REQUIRED + - PREFERRED + - NOT_NEEDED + - type: string + description: > + indicates whether UP integrity protection is required, preferred or not needed for all + the traffic on the PDU Session. It shall comply with the provisions defined in + table 5.4.3.4-1. + +UpIntegrityRm: + anyOf: + - $ref: '#/components/schemas/UpIntegrity' + - $ref: '#/components/schemas/NullValue' + description: > + indicates whether UP integrity protection is required, preferred or not needed for all + the traffic on the PDU Session. It shall comply with the provisions defined in + table 5.4.3.4-1. + +UpConfidentiality: + anyOf: + - type: string +``` + +``` +enum: + - REQUIRED + - PREFERRED + - NOT_NEEDED +- type: string +description: > + indicates whether UP confidentiality protection is required, preferred or not needed for + all the traffic on the PDU Session. It shall comply with the provisions defined in + table 5.4.3.5-1. + +UpConfidentialityRm: +anyOf: + - $ref: '#/components/schemas/UpConfidentiality' + - $ref: '#/components/schemas/NullValue' +description: > + indicates whether UP integrity protection is required, preferred or not needed for all the + traffic on the PDU Session. It shall comply with the provisions defined in table 5.4.3.4-1, + but with the OpenAPI 'nullable: true' property. + +SscMode: +anyOf: + - type: string + enum: + - SSC_MODE_1 + - SSC_MODE_2 + - SSC_MODE_3 + - type: string +description: > + represents the service and session continuity mode It shall comply with the provisions + defined in table 5.4.3.6-1. + +SscModeRm: +anyOf: + - $ref: '#/components/schemas/SscMode' + - $ref: '#/components/schemas/NullValue' +description: > + represents the service and session continuity mode It shall comply with the provisions + defined in table 5.4.3.6-1 but with the OpenAPI 'nullable: true' property. + +DnaiChangeType: +anyOf: + - type: string + enum: + - EARLY + - EARLY_LATE + - LATE + - type: string +description: > + 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. + +description: | + Possible values are: + - EARLY: Early notification of UP path reconfiguration. + - EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall + only be present in the subscription to the DNAI change event. + - LATE: Late notification of UP path reconfiguration. + +DnaiChangeTypeRm: +anyOf: + - $ref: '#/components/schemas/DnaiChangeType' + - $ref: '#/components/schemas/NullValue' +description: > + It can take the values as specified for DnaiChangeType but with the OpenAPI + 'nullable: true' property. + +RestrictionType: +anyOf: + - type: string + enum: + - ALLOWED_AREAS + - NOT_ALLOWED_AREAS + - type: string +description: It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS. + +RestrictionTypeRm: +anyOf: + - $ref: '#/components/schemas/RestrictionType' +``` + +``` + - $ref: '#/components/schemas/NullValue' + description: > + It contains the restriction type ALLOWED_AREAS or NOT_ALLOWED_AREAS but with the + OpenAPI 'nullable: true' property. + +CoreNetworkType: + anyOf: + - type: string + enum: + - 5GC + - EPC + - type: string + description: It contains the Core Network type 5GC or EPC. + +CoreNetworkTypeRm: + anyOf: + - $ref: '#/components/schemas/CoreNetworkType' + - $ref: '#/components/schemas/NullValue' + description: > + It contains the Core Network type 5GC or EPC but with the OpenAPI + 'nullable: true' property. + +PresenceState: + anyOf: + - type: string + enum: + - IN_AREA + - OUT_OF_AREA + - UNKNOWN + - INACTIVE + - type: string + description: | + Possible values are: + -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. + -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area + -UNKNOWN: Indicates it is unknown whether the UE is in the presence reporting area or not + -INACTIVE: Indicates that the presence reporting area is inactive in the serving node. + +StationaryIndication: + anyOf: + - type: string + enum: + - STATIONARY + - MOBILE + - type: string + description: > + 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. + description: | + Possible values are: + - STATIONARY: Identifies the UE is stationary + - MOBILE: Identifies the UE is mobile + +StationaryIndicationRm: + anyOf: + - $ref: '#/components/schemas/StationaryIndication' + - $ref: '#/components/schemas/NullValue' + description: > + This enumeration is defined in the same way as the 'StationaryIndication' enumeration, + but with the OpenAPI 'nullable: true' property." + +ScheduledCommunicationType: + anyOf: + - type: string + enum: + - DOWNLINK_ONLY + - UPLINK_ONLY + - BIDIRECTIONAL + - type: string + description: | + Possible values are: + -DOWNLINK_ONLY: Downlink only + -UPLINK_ONLY: Uplink only + -BIDIRECTIONAL: Bi-directional + +ScheduledCommunicationTypeRm: + anyOf: +``` + +``` +- $ref: '#/components/schemas/ScheduledCommunicationType' +- $ref: '#/components/schemas/NullValue' +description: > + This enumeration is defined in the same way as the 'ScheduledCommunicationType' + enumeration, but with the OpenAPI 'nullable: true' property." + +TrafficProfile: +anyOf: +- type: string + enum: + - SINGLE_TRANS_UL + - SINGLE_TRANS_DL + - DUAL_TRANS_UL_FIRST + - DUAL_TRANS_DL_FIRST + - MULTI_TRANS +- type: string + description: > + 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. + +description: | + Possible values are: + - SINGLE_TRANS_UL: Uplink single packet transmission. + - SINGLE_TRANS_DL: Downlink single packet transmission. + - DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission + with subsequent downlink packet transmission. + - DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission + with subsequent uplink packet transmission. + +TrafficProfileRm: +anyOf: +- $ref: '#/components/schemas/TrafficProfile' +- $ref: '#/components/schemas/NullValue' +description: > + This enumeration is defined in the same way as the 'TrafficProfile' enumeration, but + with the OpenAPI 'nullable: true' property. + +LcsServiceAuth: +anyOf: +- type: string + enum: + - "LOCATION_ALLOWED_WITH_NOTIFICATION" + - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" + - "LOCATION_ALLOWED_WITHOUT_RESPONSE" + - "LOCATION_RESTRICTED_WITHOUT_RESPONSE" + - "NOTIFICATION_ONLY" + - "NOTIFICATION_AND_VERIFICATION_ONLY" +- type: string + description: > + 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. +description: | + Possible values are: + - "LOCATION_ALLOWED_WITH_NOTIFICATION": Location allowed with notification + - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION": Location allowed without notification + - "LOCATION_ALLOWED_WITHOUT_RESPONSE": Location with notification and privacy + verification; location allowed if no response + - "LOCATION_RESTRICTED_WITHOUT_RESPONSE": Location with notification and privacy + verification; location restricted if no response + - "NOTIFICATION_ONLY": Notification only + - "NOTIFICATION_AND_VERIFICATION_ONLY": Notification and privacy verification only + +UeAuth: +anyOf: +- type: string + enum: + - AUTHORIZED + - NOT_AUTHORIZED +- type: string + description: | + Possible values are: + - AUTHORIZED: Indicates that the UE is authorized. + - NOT_AUTHORIZED: Indicates that the UE is not authorized. + +DlDataDeliveryStatus: +anyOf: +- type: string +``` + +``` +enum: + - BUFFERED + - TRANSMITTED + - DISCARDED +- type: string +description: > + 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. +description: | + Possible values are: + - BUFFERED: The first downlink data is buffered with extended buffering matching the + source of the downlink traffic. + - TRANSMITTED: The first downlink data matching the source of the downlink traffic is + transmitted after previous buffering or discarding of corresponding packet(s) because + the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE. + - DISCARDED: The first downlink data matching the source of the downlink traffic is + discarded because the Extended Buffering time, as determined by the SMF, expires or + the amount of downlink data to be buffered is exceeded. + +DlDataDeliveryStatusRm: +anyOf: + - $ref: '#/components/schemas/DlDataDeliveryStatus' + - $ref: '#/components/schemas/NullValue' +description: > + This data type is defined in the same way as the ' DlDataDeliveryStatus ' data type, + but with the OpenAPI 'nullable: true' property. + +AuthStatus: +anyOf: + - type: string + enum: + - EAP_SUCCESS + - EAP_FAILURE + - PENDING + - type: string + description: > + 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. + +description: | + Possible values are: + - "EAP_SUCCESS": The NSSAA status is EAP-Success. + - "EAP_FAILURE": The NSSAA status is EAP-Failure. + - "PENDING": The NSSAA status is Pending. + +LineType: +anyOf: + - type: string + enum: + - DSL + - PON + - type: string + description: > + 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. + +description: | + Possible values are: + - DSL: Identifies a DSL line + - PON: Identifies a PON line + +LineTypeRm: +anyOf: + - $ref: '#/components/schemas/LineType' + - $ref: '#/components/schemas/NullValue' +description: > + This data type is defined in the same way as the 'LineType' data type, but with the + OpenAPI 'nullable: true' property. + +NotificationFlag: +anyOf: + - type: string + enum: + - ACTIVATE +``` + +- DEACTIVATE +- RETRIEVAL + +- type: string +description: > +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. + +description: | +Possible values are: +- ACTIVATE: The event notification is activated. +- DEACTIVATE: The event notification is deactivated and shall be muted. The available event(s) shall be stored. +- RETRIEVAL: The event notification shall be sent to the NF service consumer(s), after that, is muted again. + +TransportProtocol: +anyOf: +- type: string +enum: +- UDP +- TCP + +- type: string +description: > +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. + +description: | +Possible values are: +- UDP: User Datagram Protocol. +- TCP: Transmission Control Protocol. + +SatelliteBackhaulCategory: +anyOf: +- type: string +enum: +- GEO +- MEO +- LEO +- OTHER\_SAT +- DYNAMIC\_GEO +- DYNAMIC\_MEO +- DYNAMIC\_LEO +- DYNAMIC\_OTHER\_SAT +- NON\_SATELLITE + +- type: string +description: Indicates the satellite backhaul used. + +SatelliteBackhaulCategoryRm: +anyOf: +- \$ref: '#/components/schemas/SatelliteBackhaulCategory' +- \$ref: '#/components/schemas/NullValue' + +description: > +Provides information about the satellite backhaul but with the OpenAPI 'nullable: true' property. + +BufferedNotificationsAction: +anyOf: +- type: string +enum: +- SEND\_ALL +- DISCARD\_ALL +- DROP\_OLD + +- type: string +description: > +Indicates the required action by the event producer NF on the buffered Notifications. + +SubscriptionAction: +anyOf: +- type: string +enum: +- CLOSE +- CONTINUE\_WITH\_MUTING +- CONTINUE\_WITHOUT\_MUTING + +- type: string + +``` + +description: > + Indicates the required action by the event producer NF on the event subscription if an + exception occurs while the event is muted. + +SnssaiStatus: + anyOf: + - type: string + enum: + - AVAILABLE + - UNAVAILABLE + - type: string + description: Indicates the S-NSSAI availability. + +TerminationIndication: + description: Indicates the termination of Network Slice Replacement. + anyOf: + - type: string + enum: + - NEW_UES_TERMINATION + - ALL_UES_TERMINATION + - type: string + +# +# STRUCTURED DATA TYPES +# + +SubscribedDefaultQos: + type: object + required: + - 5qi + - arp + properties: + 5qi: + $ref: '#/components/schemas/5Qi' + arp: + $ref: '#/components/schemas/Arp' + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + description: Provides the subscribed 5QI and the ARP, it may contain the priority level. + +Snssai: + type: object + properties: + sst: + type: integer + minimum: 0 + maximum: 255 + description: > + Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. + It indicates the expected Network Slice behaviour in terms of features and services. + Values 0 to 127 correspond to the standardized SST range. Values 128 to 255 correspond + to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003. + Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501. + + sd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + description: > + 3-octet string, representing the Slice Differentiator, in hexadecimal representation. + Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" + and shall represent 4 bits. The most significant character representing the 4 most + significant bits of the SD shall appear first in the string, and the character + representing the 4 least significant bit of the SD shall appear last in the string. + This is an optional parameter that complements the Slice/Service type(s) to allow to + differentiate amongst multiple Network Slices of the same Slice/Service type. This IE + shall be absent if no SD value is associated with the SST. + description: > + When Snssai needs to be converted to string (e.g. when used in maps as key), the string + shall + be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits + "sd". + + required: + - sst + +PlmnId: + type: object + properties: + +``` + +``` + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + description: > + When PlmnId needs to be converted to string (e.g. when used in maps as key), the string + shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc". + + required: + - mcc + - mnc + PlmnIdRm: + anyOf: + - $ref: '#/components/schemas/PlmnId' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'PlmnId' data type, but with the + OpenAPI 'nullable: true' property. + + Tai: + description: Contains the tracking area identity as described in 3GPP 23.003 + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + tac: + $ref: '#/components/schemas/Tac' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - tac + + TaiRm: + anyOf: + - $ref: '#/components/schemas/Tai' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'Tai' data type, but with the OpenAPI + 'nullable: true' property. + + Ecgi: + description: Contains the ECGI (E-UTRAN Cell Global Identity), as described in 3GPP 23.003 + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + eutraCellId: + $ref: '#/components/schemas/EutraCellId' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - eutraCellId + + EcgiRm: + anyOf: + - $ref: '#/components/schemas/Ecgi' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'Ecgi' data type, but with the + OpenAPI 'nullable: true' property. + + Ncgi: + description: Contains the NCGI (NR Cell Global Identity), as described in 3GPP 23.003 + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + nrCellId: + $ref: '#/components/schemas/NrCellId' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - nrCellId + + NcgiRm: +``` + +``` + +anyOf: + - $ref: '#/components/schemas/Ncgi' + - $ref: '#/components/schemas/NullValue' +description: > + This data type is defined in the same way as the 'Ncgi' data type, but with the + OpenAPI 'nullable: true' property. + +UserLocation: +type: object +properties: + eutraLocation: + $ref: '#/components/schemas/EutraLocation' + nrLocation: + $ref: '#/components/schemas/NrLocation' + n3gaLocation: + $ref: '#/components/schemas/N3gaLocation' + utraLocation: + $ref: '#/components/schemas/UtraLocation' + geraLocation: + $ref: '#/components/schemas/GeraLocation' +description: > + At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several + of them may be present. + +EutraLocation: +description: Contains the E-UTRA user location. +type: object +properties: + tai: + $ref: '#/components/schemas/Tai' + ignoreTai: + type: boolean + default: false + ecgi: + $ref: '#/components/schemas/Ecgi' + ignoreEcgi: + type: boolean + default: false + description: > + This flag when present shall indicate that the Ecgi shall be ignored + When present, it shall be set as follows: + - true: ecgi shall be ignored. + - false (default): ecgi shall not be ignored. + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + description: > + The value represents the elapsed time in minutes since the last network contact of the + mobile station. Value "0" indicates that the location information was obtained after a + successful paging procedure for Active Location Retrieval when the UE is in idle mode + or after a successful NG-RAN location reporting procedure with the eNB when the UE is + in connected mode. Any other value than "0" indicates that the location information is + the last known one. See 3GPP TS 29.002 clause 17.7.8. + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + description: > + Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the + description of an ellipsoid point with uncertainty circle is allowed to be used. + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + description: > + Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] + clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle + is allowed to be used. + globalNgenbId: + $ref: '#/components/schemas/GlobalRanNodeId' + + globalENbId: + $ref: '#/components/schemas/GlobalRanNodeId' +required: + - tai + - ecgi + +``` + +``` + +EutraLocationRm: + anyOf: + - $ref: '#/components/schemas/EutraLocation' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'EutraLocation' data type, but with + the OpenAPI 'nullable: true' property. + +NrLocation: + description: Contains the NR user location. + type: object + properties: + tai: + $ref: '#/components/schemas/Tai' + ncgi: + $ref: '#/components/schemas/Ncgi' + ignoreNcgi: + type: boolean + default: false + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + description: > + The value represents the elapsed time in minutes since the last network contact of the +mobile + station. Value "0" indicates that the location information was obtained after a + successful paging procedure for Active Location Retrieval when the UE is in idle mode + or after a successful NG-RAN location reporting procedure with the eNB when the UE is + in connected mode. Any other value than "0" indicates that the location information is + the last known one. See 3GPP TS 29.002 clause 17.7.8. + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + description: > + Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the description + of an ellipsoid point with uncertainty circle is allowed to be used. + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + description: > + Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) [24] clause + 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed + to be used. + globalGnbId: + $ref: '#/components/schemas/GlobalRanNodeId' + ntnTaiInfo: + $ref: '#/components/schemas/NtnTaiInfo' + required: + - tai + - ncgi + +NrLocationRm: + anyOf: + - $ref: '#/components/schemas/NrLocation' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'NrLocation' data type, but with the + OpenAPI 'nullable: true' property." + +N3gaLocation: + description: Contains the Non-3GPP access user location. + type: object + properties: + n3gppTai: + $ref: '#/components/schemas/Tai' + n3iwfId: + type: string + pattern: '^[A-Fa-f0-9]+\s$' + description: > + This IE shall contain the N3IWF identifier received over NGAP and shall be encoded as a + string of hexadecimal characters. Each character in the string shall take a value of "0" + to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant + character representing the 4 most significant bits of the N3IWF ID shall appear first in + the string, and the character representing the 4 least significant bit of the N3IWF ID + shall appear last in the string. + +``` + +``` +ueIpv4Addr: + $ref: '#/components/schemas/Ipv4Addr' +ueIpv6Addr: + $ref: '#/components/schemas/Ipv6Addr' +portNumber: + $ref: '#/components/schemas/Uinteger' +protocol: + $ref: '#/components/schemas/TransportProtocol' +tnapId: + $ref: '#/components/schemas/TnapId' +twapId: + $ref: '#/components/schemas/TwapId' +hfcNodeId: + $ref: '#/components/schemas/HfcNodeId' +gli: + $ref: '#/components/schemas/Gli' +w5gbnLineType: + $ref: '#/components/schemas/LineType' +gci: + $ref: '#/components/schemas/Gci' + +UpSecurity: + description: Contains Userplain security information. + type: object + properties: + upIntegr: + $ref: '#/components/schemas/UpIntegrity' + upConfid: + $ref: '#/components/schemas/UpConfidentiality' + required: + - upIntegr + - upConfid + +UpSecurityRm: + anyOf: + - $ref: '#/components/schemas/UpSecurity' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'UpSecurity' data type, but with the + OpenAPI 'nullable: true' property. + +NgApCause: + description: Represents the NGAP cause. + type: object + properties: + group: + $ref: '#/components/schemas/Uinteger' + value: + $ref: '#/components/schemas/Uinteger' + required: + - group + - value + +BackupAmfInfo: + description: Provides details of the Backup AMF. + type: object + properties: + backupAmf: + $ref: '#/components/schemas/AmfName' + guamiList: + type: array + items: + $ref: '#/components/schemas/Guami' + minItems: 1 + description: > + If present, this IE shall contain the list of GUAMI(s) (supported by the AMF) for + which the backupAmf IE applies. + required: + - backupAmf + +RefToBinaryData: + description: This parameter provides information about the referenced binary body data. + type: object + properties: + contentId: + type: string + description: > +``` + +``` + This IE shall contain the value of the Content-ID header of the referenced binary + body part. + required: + - contentId + +RefToBinaryDataRm: + anyOf: + - $ref: '#/components/schemas/RefToBinaryData' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the ' RefToBinaryData ' data type, + but with the OpenAPI 'nullable: true' property. + +RouteToLocation: + type: object + properties: + dnai: + $ref: '#/components/schemas/Dnai' + routeInfo: + $ref: '#/components/schemas/RouteInformation' + routeProfId: + type: string + nullable: true + description: Identifies the routing profile Id. + required: + - dnai + anyOf: + - required: [ routeInfo ] + - required: [ routeProfId ] + nullable: true + description: > + At least one of the "routeInfo" attribute and the "routeProfId" attribute shall be included + in the "RouteToLocation" data type. + +RouteInformation: + type: object + properties: + ipv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + portNumber: + $ref: '#/components/schemas/Uinteger' + required: + - portNumber + nullable: true + description: > + At least one of the "ipv4Addr" attribute and the "ipv6Addr" attribute shall be included in + the "RouteInformation" data type. + +Area: + description: Provides area information. + type: object + oneOf: + - required: + - tacs + - required: + - areaCode + properties: + tacs: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + areaCode: + $ref: '#/components/schemas/AreaCode' + +ServiceAreaRestriction: + description: Provides information about allowed or not allowed areas. + type: object + properties: + restrictionType: + $ref: '#/components/schemas/RestrictionType' + areas: + type: array + items: + $ref: '#/components/schemas/Area' + maxNumOfTAs: +``` + +``` + + $ref: '#/components/schemas/Uinteger' + maxNumOfTAsForNotAllowedAreas: + $ref: '#/components/schemas/Uinteger' + allOf: + # + # 1st condition: restrictionType and areas attributes shall be either both absent + # or both present + # + - oneOf: + - not: + - required: [ restrictionType ] + - required: [ areas ] + # + # 2nd condition: if restrictionType takes value NOT_ALLOWED_AREAS, + # then maxNumOfTAs shall be absent + # + - anyOf: + - not: + - required: [ restrictionType ] + - properties: + - restrictionType: + - type: string + - enum: [ NOT_ALLOWED_AREAS ] + - not: + - required: [ maxNumOfTAs ] + # + # 3rd condition: if restrictionType takes value ALLOWED_AREAS, + # then maxNumOfTAsForNotAllowedAreas shall be absent + # + - anyOf: + - not: + - required: [ restrictionType ] + - properties: + - restrictionType: + - type: string + - enum: [ ALLOWED_AREAS ] + - not: + - required: [ maxNumOfTAsForNotAllowedAreas ] + +PresenceInfo: + type: object + properties: + praId: + type: string + description: > + Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP + TS 23.003. This IE shall be present if the Area of Interest subscribed or reported is + a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas. + When present, it shall be encoded as a string representing an integer in the following + ranges: + 0 to 8 388 607 for UE-dedicated PRA + 8 388 608 to 16 777 215 for Core Network predefined PRA + Examples: + PRA ID 123 is encoded as "123" + PRA ID 11 238 660 is encoded as "11238660" + + additionalPraId: + type: string + description: > + This IE may be present if the praId IE is present and if it contains a PRA identifier + referring to a set of Core Network predefined Presence Reporting Areas. When present, + this IE shall contain a PRA Identifier of an individual PRA within the Set of Core + Network predefined Presence Reporting Areas indicated by the praId IE. + + presenceState: + $ref: '#/components/schemas/PresenceState' + trackingAreaList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + description: > + Represents the list of tracking areas that constitutes the area. This IE shall be + present if the subscription or the event report is for tracking UE presence in the + tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI. + + ecgiList: + type: array + +``` + +``` +items: + $ref: '#/components/schemas/Ecgi' +minItems: 1 +description: > + Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall + be present if the Area of Interest subscribed is a list of EUTRAN cell Ids. + +ncgiList: +type: array +items: + $ref: '#/components/schemas/Ncgi' +minItems: 1 +description: > + Represents the list of NR cell Ids that constitutes the area. This IE shall be + present if the Area of Interest subscribed is a list of NR cell Ids. + +globalRanNodeIdList: +type: array +items: + $ref: '#/components/schemas/GlobalRanNodeId' +minItems: 1 +description: > + Represents the list of NG RAN node identifiers that constitutes the area. This IE shall + be present if the Area of Interest subscribed is a list of NG RAN node identifiers. + +globaleNbIdList: +type: array +items: + $ref: '#/components/schemas/GlobalRanNodeId' +minItems: 1 +description: > + Represents the list of eNodeB identifiers that constitutes the area. This IE shall be + present if the Area of Interest subscribed is a list of eNodeB identifiers. + +description: > + If the additionalPraid IE is present, this IE shall state the presence information of the + UE for the individual PRA identified by the additionalPraid IE; If the additionalPraid IE + is not present, this IE shall state the presence information of the UE for the PRA + identified by the praid IE. + +PresenceInfoRm: +type: object +properties: + praid: + type: string + description: | + Represents an identifier of the Presence Reporting Area (see clause 28.10 of + 3GPP TS 23.003. This IE shall be present if the Area of Interest subscribed or + reported is a Presence Reporting Area or a Set of Core Network predefined Presence + Reporting Areas. When present, it shall be encoded as a string representing an integer + in the following ranges: + - 0 to 8 388 607 for UE-dedicated PRA + - 8 388 608 to 16 777 215 for Core Network predefined PRA + Examples: + PRA ID 123 is encoded as "123" + PRA ID 11 238 660 is encoded as "11238660" + + additionalPraid: + type: string + description: > + This IE may be present if the praid IE is present and if it contains a PRA identifier + referring to a set of Core Network predefined Presence Reporting Areas. + When present, this IE shall contain a PRA Identifier of an individual PRA within the Set + of Core Network predefined Presence Reporting Areas indicated by the praid IE. + +presenceState: +$ref: '#/components/schemas/PresenceState' + +trackingAreaList: +type: array +items: + $ref: '#/components/schemas/Tai' +minItems: 0 +description: > + Represents the list of tracking areas that constitutes the area. This IE shall be + present if the subscription or the event report is for tracking UE presence in the + tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI. + +ecgiList: +type: array +items: + $ref: '#/components/schemas/Ecgi' +``` + +``` + + minItems: 0 + description: > + Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall be + present if the Area of Interest subscribed is a list of EUTRAN cell Ids. +ncgiList: + type: array + items: + $ref: '#/components/schemas/Ncgi' + minItems: 0 + description: > + Represents the list of NR cell Ids that constitutes the area. This IE shall be present + if the Area of Interest subscribed is a list of NR cell Ids. +globalRanNodeIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + description: > + Represents the list of NG RAN node identifiers that constitutes the area. This IE shall +be + present if the Area of Interest subscribed is a list of NG RAN node identifiers. +globaleNbIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + minItems: 1 + description: > + Represents the list of eNodeB identifiers that constitutes the area. This IE shall be +present + if the Area of Interest subscribed is a list of eNodeB identifiers. +nullable: true +description: > +This data type is defined in the same way as the 'PresenceInfo' data type, but with the +OpenAPI 'nullable: true' property. If the additionalPraid IE is present, this IE shall +state + the presence information of the UE for the individual PRA identified by the additionalPraid + IE; If the additionalPraid IE is not present, this IE shall state the presence information + of the UE for the PRA identified by the praid IE. + +GlobalRanNodeId: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + n3IwfId: + $ref: '#/components/schemas/N3IwfId' + gNbId: + $ref: '#/components/schemas/GNbId' + ngeNbId: + $ref: '#/components/schemas/NgeNbId' + wagfId: + $ref: '#/components/schemas/WAgfId' + tngfId: + $ref: '#/components/schemas/TngfId' + nid: + $ref: '#/components/schemas/Nid' + eNbId: + $ref: '#/components/schemas/ENbId' + oneOf: + - required: [ n3IwfId ] + - required: [ gNbId ] + - required: [ ngeNbId ] + - required: [ wagfId ] + - required: [ tngfId ] + - required: [ eNbId ] + description: > + One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present. + required: + - plmnId +GNbId: + description: Provides the G-NB identifier. + type: object + properties: + bitLength: + type: integer + minimum: 22 + maximum: 32 + description: > + Unsigned integer representing the bit length of the gNB ID as defined in clause + +``` + +9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32. + +gNBValue: +type: string +pattern: '^[A-Fa-f0-9]{6,8}\$' +description: > +This represents the identifier of the gNB. The value of the gNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID shall appear first in the string, and the character representing the 4 least significant bit of the gNB ID shall appear last in the string. + +required: +- bitLength +- gNBValue + +AtsssCapability: +description: > +Contains Capability to support procedures related to Access Traffic Steering, Switching, Splitting. +type: object +properties: +atsssLL: +type: boolean +default: false +description: > +Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501). +true: Supported +false (default): Not Supported +mptcp: +type: boolean +default: false +description: > +Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501) +true: Supported +false (default): Not Supported +rttWithoutPmf: +type: boolean +default: false +description: > +This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501) +true: Supported +false (default): Not Supported + +PlmnIdNid: +description: > +Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN. +type: object +required: +- mcc +- mnc +properties: +mcc: +\$ref: '#/components/schemas/Mcc' +mnc: +\$ref: '#/components/schemas/Mnc' +nid: +\$ref: '#/components/schemas/Nid' + +PlmnIdNidRm: +anyOf: +- \$ref: '#/components/schemas/PlmnIdNid' +- \$ref: '#/components/schemas/NullValue' +description: > +This data type is defined in the same way as the 'PlmnIdNid' data type, but with the OpenAPI 'nullable: true' property. + +SmallDataRateStatus: +description: It indicates theSmall Data Rate Control Status +type: object +properties: +remainPacketsUl: +type: integer +minimum: 0 +description: > + +When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS + +23.501. + +    remainPacketsDl: +         type: integer +         minimum: 0 +         description: > +             When present it shall contain the number of packets the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS + +23.501. + +    validityTime: +         \$ref: '#/components/schemas/DateTime' +     remainExReportsUl: +         type: integer +         minimum: 0 +         description: > +             When present, it shall indicate number of additional exception reports the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501. +     remainExReportsDl: +         type: integer +         minimum: 0 +         description: > +             When present, it shall indicate number of additional exception reports the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 in 3GPP TS 23.501 + +HfcNodeId: + description: REpresents the HFC Node Identifier received over NGAP. + type: object + required: + - hfcNId + properties: + hfcNId: +     \$ref: '#/components/schemas/HfcNId' + +HfcNodeIdRm: + anyOf: + - \$ref: '#/components/schemas/HfcNodeId' + - \$ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'HfcNodeId' data type, but with the OpenAPI 'nullable: true' property. + +WirelineArea: + type: object + properties: + globallineIds: +     type: array +     items: +         \$ref: '#/components/schemas/Gli' +     minItems: 1 + hfcNIds: +     type: array +     items: +         \$ref: '#/components/schemas/HfcNId' +     minItems: 1 + areaCodeB: +     \$ref: '#/components/schemas/AreaCode' + areaCodeC: +     \$ref: '#/components/schemas/AreaCode' + combGciAndHfcNIds: +     type: array +     items: +         \$ref: '#/components/schemas/CombGciAndHfcNIds' +     minItems: 1 + description: > + One and only one of the "globLineIds", "hfcNIds", "areaCodeB", and "areaCodeC" and combGciAndHfcNIds attributes shall be included in a WirelineArea data structure + +WirelineServiceAreaRestriction: + type: object + properties: + restrictionType: +     \$ref: '#/components/schemas/RestrictionType' + areas: +     type: array +     items: + +``` +$ref: '#/components/schemas/WirelineArea' +description: > + The "restrictionType" attribute and the "areas" attribute shall be either both present + or absent. The empty array of areas is used when service is allowed/restricted nowhere. + +ApnRateStatus: +description: Contains the APN rate control status e.g. of the AMF. +type: object +properties: + remainPacketsUl: + type: integer + minimum: 0 + description: > + When present, it shall contain the number of packets the UE is allowed to send uplink + in the given time unit for the given APN (all PDN connections of the UE to this APN + see clause 4.7.7.3 in 3GPP TS 23.401. + remainPacketsDl: + type: integer + minimum: 0 + description: > + When present, it shall contain the number of packets the UE is allowed to send uplink + in the given time unit for the given APN (all PDN connections of the UE to this APN + see clause 4.7.7.3 in 3GPP TS 23.401. + validityTime: + $ref: '#/components/schemas/DateTime' + remainExReportsUl: + type: integer + minimum: 0 + description: > + When present, it shall indicate the number of additional exception reports the UE is + allowed to send uplink in the given time unit for the given APN (all PDN connections of +the UE to this APN, + see clause 4.7.7.3 in 3GPP TS 23.401. + remainExReportsDl: + type: integer + minimum: 0 + description: > + When present, it shall indicate the number of additional exception reports the AF is + allowed to send downlink in the given time unit for the given APN (all PDN connections + of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401. + +ScheduledCommunicationTime: +description: Identifies time and day of the week when the UE is available for communication. +type: object +properties: + daysOfWeek: + type: array + items: + $ref: '#/components/schemas/DayOfWeek' + minItems: 1 + maxItems: 6 + description: > + Identifies the day(s) of the week. If absent, it indicates every day of the week. + timeOfDayStart: + $ref: '#/components/schemas/TimeOfDay' + timeOfDayEnd: + $ref: '#/components/schemas/TimeOfDay' + +ScheduledCommunicationTimeRm: +anyOf: +- $ref: '#/components/schemas/ScheduledCommunicationTime' +- $ref: '#/components/schemas/NullValue' +description: > + This data type is defined in the same way as the 'ScheduledCommunicationTime' data type, + but with the OpenAPI 'nullable: true' property. + +BatteryIndication: +type: object +properties: + batteryInd: + type: boolean + description: > + This IE shall indicate whether the UE is battery powered or not. + true: the UE is battery powered; + false or absent: the UE is not battery powered + replaceableInd: + type: boolean + description: > +``` + +``` +This IE shall indicate whether the battery of the UE is replaceable or not. +true: the battery of the UE is replaceable; +false or absent: the battery of the UE is not replaceable. +rechargeableInd: + type: boolean + description: > + This IE shall indicate whether the battery of the UE is rechargeable or not. + true: the battery of UE is rechargeable; + false or absent: the battery of the UE is not rechargeable. +description: > + Parameters "replaceableInd" and "rechargeableInd" are only included if the value of + Parameter "batteryInd" is true. + +BatteryIndicationRm: + anyOf: + - $ref: '#/components/schemas/BatteryIndication' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'BatteryIndication' data type, but + with the OpenAPI 'nullable: true' property. + +AcsInfo: + description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369 + type: object + properties: + acsUrl: + $ref: '#/components/schemas/Uri' + acsIpv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + acsIpv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + +AcsInfoRm: + anyOf: + - $ref: '#/components/schemas/AcsInfo' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'AcsInfo' data type, but with the + OpenAPI 'nullable: true' property. + +NrV2xAuth: + description: Contains NR V2X services authorized information. + type: object + properties: + vehicleUeAuth: + $ref: '#/components/schemas/UeAuth' + pedestrianUeAuth: + $ref: '#/components/schemas/UeAuth' + +LteV2xAuth: + description: Contains LTE V2X services authorized information. + type: object + properties: + vehicleUeAuth: + $ref: '#/components/schemas/UeAuth' + pedestrianUeAuth: + $ref: '#/components/schemas/UeAuth' + +Pc5QoSPara: + description: Contains policy data on the PC5 QoS parameters. + type: object + required: + - pc5QoSFlowList + properties: + pc5QoSFlowList: + type: array + items: + $ref: '#/components/schemas/Pc5QoSFlowItem' + pc5LinkAmbr: + $ref: '#/components/schemas/BitRate' + +Pc5QoSFlowItem: + description: Contains a PC5 QoS flow. + type: object + required: + - pqi + properties: + pqi: +``` + +``` +$ref: '#/components/schemas/5Qi' + +pc5FlowBitRates: + $ref: '#/components/schemas/Pc5FlowBitRates' +range: + $ref: '#/components/schemas/UInteger' + +Pc5FlowBitRates: + description: it shall represent the PC5 Flow Bit Rates + type: object + properties: + guaFbr: + $ref: '#/components/schemas/BitRate' + maxFbr: + $ref: '#/components/schemas/BitRate' + +UtraLocation: + type: object + oneOf: + - required: + - cgi + - required: + - sai + - required: + - rai + description: Exactly one of cgi, sai or lai shall be present. + properties: + cgi: + $ref: '#/components/schemas/CellGlobalId' + sai: + $ref: '#/components/schemas/ServiceAreaId' + lai: + $ref: '#/components/schemas/LocationAreaId' + rai: + $ref: '#/components/schemas/RoutingAreaId' + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + description: > + The value represents the elapsed time in minutes since the last network contact of the + mobile station. Value "0" indicates that the location information was obtained after a + successful paging procedure for Active Location Retrieval when the UE is in idle mode + or after a successful location reporting procedure the UE is in connected mode. Any + other value than "0" indicates that the location information is the last known one. + See 3GPP TS 29.002 clause 17.7.8. + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + description: > + Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the + description of an ellipsoid point with uncertainty circle is allowed to be used. + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + description: > + Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause + 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed + to be used. + +GeraLocation: + type: object + oneOf: + - required: + - cgi + - required: + - sai + - required: + - lai + - required: + - rai + description: Exactly one of cgi, sai or lai shall be present. + properties: + locationNumber: + type: string + description: Location number within the PLMN. See 3GPP TS 23.003, clause 4.5. +``` + +``` +cgi: + $ref: '#/components/schemas/CellGlobalId' +rai: + $ref: '#/components/schemas/RoutingAreaId' +sai: + $ref: '#/components/schemas/ServiceAreaId' +lai: + $ref: '#/components/schemas/LocationAreaId' +vlrNumber: + type: string + description: VLR number. See 3GPP TS 23.003 clause 5.1. +mscNumber: + type: string + description: MSC number. See 3GPP TS 23.003 clause 5.1. +ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + description: > + The value represents the elapsed time in minutes since the last network contact of the + mobile station. Value "0" indicates that the location information was obtained after a + successful paging procedure for Active Location Retrieval when the UE is in idle mode + or after a successful location reporting procedure the UE is in connected mode. Any + other value than "0" indicates that the location information is the last known one. + See 3GPP TS 29.002 clause 17.7.8. +ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' +geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + description: > + Refer to geographical Information. See 3GPP TS 23.032 clause 7.3.2. Only the + description of an ellipsoid point with uncertainty circle is allowed to be used. +geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + description: > + Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause 3.88.2. + Only the description of an ellipsoid point with uncertainty circle is allowed to be + used. + +CellGlobalId: + description: Contains a Cell Global Identification as defined in 3GPP TS 23.003, clause 4.3.1. + type: object + required: + - plmnId + - lac + - cellId + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + cellId: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + +ServiceAreaId: + description: Contains a Service Area Identifier as defined in 3GPP TS 23.003, clause 12.5. + type: object + required: + - plmnId + - lac + - sac + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + description: Location Area Code. + sac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + description: Service Area Code. + +LocationAreaId: +``` + +``` +description: Contains a Location area identification as defined in 3GPP TS 23.003, clause 4.1. +type: object +required: +- plmnId +- lac +properties: +plmnId: + $ref: '#/components/schemas/PlmnId' + +lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + description: Location Area Code. + +RoutingAreaId: +description: Contains a Routing Area Identification as defined in 3GPP TS 23.003, clause 4.2. +type: object +required: +- plmnId +- lac +- rac +properties: +plmnId: + $ref: '#/components/schemas/PlmnId' +lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + description: Location Area Code +rac: + type: string + pattern: '^[A-Fa-f0-9]{2}$' + description: Routing Area Code + +DddTrafficDescriptor: +description: Contains a Traffic Descriptor. +type: object +properties: +ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' +portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +macAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + +MoExpDataCounter: +description: Contain the MO Exception Data Counter. +type: object +required: +- counter +properties: +counter: + type: integer + description: > + Unsigned integer identifying the MO Exception Data Counter, as specified in clause + 5.31.14.3 of 3GPP TS 23.501. +timeStamp: + $ref: '#/components/schemas/DateTime' + +NssaaStatus: +description: contains the Subscribed S-NSSAI subject to NSSAA procedure and the status. +type: object +required: +- snssai +- status +properties: +snssai: + $ref: '#/components/schemas/Snssai' +status: + $ref: '#/components/schemas/AuthStatus' + +NssaaStatusRm: +anyOf: +- $ref: '#/components/schemas/NssaaStatus' +- $ref: '#/components/schemas/NullValue' +description: > + This data type is defined in the same way as the 'NssaaStatus' data type, but with +``` + +the OpenAPI 'nullable: true' property. + +TnapId: +description: Contain the TNAP Identifier see clause 5.6.2 of 3GPP TS 23.501. +type: object +properties: +  ssid: +    type: string +    description: > +      This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access network. When present, it shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012. + +  bssid: +    type: string +    description: > +      When present, it shall contain the BSSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012. + +  civicAddress: +    \$ref: '#/components/schemas/Bytes' + +TnapIdRm: +anyOf: +  - \$ref: '#/components/schemas/TnapId' +  - \$ref: '#/components/schemas/NullValue' +description: > +This data type is defined in the same way as the 'TnapId' data type, but with the OpenAPI 'nullable: true' property. + +TwapId: +description: > +  Contain the TWAP Identifier as defined in clause 4.2.8.5.3 of 3GPP TS 23.501 +  or the WLAN location information as defined in clause 4.5.7.2.8 of 3GPP TS 23.402. +type: object +required: +  - ssid +properties: +  ssid: +    type: string +    description: > +      This IE shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012. + +  bssid: +    type: string +    description: > +      When present, it shall contain the BSSID of the access point to which the UE is attached, for trusted WLAN access, see IEEE Std 802.11-2012. + +  civicAddress: +    \$ref: '#/components/schemas/Bytes' + +TwapIdRm: +anyOf: +  - \$ref: '#/components/schemas/TwapId' +  - \$ref: '#/components/schemas/NullValue' +description: > +This data type is defined in the same way as the 'TwapId' data type, but with the OpenAPI 'nullable: true' property. + +SnssaiExtension: +description: > +  Extensions to the Snssai data type, sdRanges and wildcardSd shall not be present simultaneously +type: object +not: +  required: +    - sdRanges +    - wildcardSd +properties: +  sdRanges: +    description: > +      When present, it shall contain the range(s) of Slice Differentiator values supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type +    type: array +    items: +      \$ref: '#/components/schemas/SdRange' + +``` + minItems: 1 + wildcardSd: + description: > + When present, it shall be set to true, to indicate that all SD values are supported for + the Slice/Service Type value indicated in the sst attribute of the Snssai data type. + type: boolean + enum: + - true + +SdRange: + description: A range of SDs (Slice Differentiators) + type: object + properties: + start: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + description: > + First value identifying the start of an SD range. This string shall be formatted as + specified for the sd attribute of the Snssai data type in clause 5.4.4.2. + end: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + description: > + Last value identifying the end of an SD range. This string shall be formatted as + specified for the sd attribute of the Snssai data type in clause 5.4.4.2. + +ProseServiceAuth: + description: > + Indicates whether the UE is authorized to use related services. + type: object + properties: + proseDirectDiscoveryAuth: + $ref: '#/components/schemas/UeAuth' + proseDirectCommunicationAuth: + $ref: '#/components/schemas/UeAuth' + proseL2RelayAuth: + $ref: '#/components/schemas/UeAuth' + proseL3RelayAuth: + $ref: '#/components/schemas/UeAuth' + proseL2RemoteAuth: + $ref: '#/components/schemas/UeAuth' + proseL3RemoteAuth: + $ref: '#/components/schemas/UeAuth' + proseMultipathComL2RemoteAuth: + $ref: '#/components/schemas/UeAuth' + proseL2UeRelayAuth: + $ref: '#/components/schemas/UeAuth' + proseL3UeRelayAuth: + $ref: '#/components/schemas/UeAuth' + proseL2EndAuth: + $ref: '#/components/schemas/UeAuth' + proseL3EndAuth: + $ref: '#/components/schemas/UeAuth' + +EcsServerAddr: + description: > + Contains the Edge Configuration Server Address Configuration Information as defined in + clause 5.2.3.6.1 of 3GPP TS 23.502. + type: object + properties: + ecsFqdnList: + type: array + items: + $ref: '#/components/schemas/Fqdn' + minItems: 1 + ecsIpAddressList: + type: array + items: + $ref: '#/components/schemas/IpAddr' + minItems: 1 + ecsUriList: + type: array + items: + $ref: '#/components/schemas/Uri' + minItems: 1 + ecsProviderId: + type: string +``` + +``` +EcsServerAddrRm: + anyOf: + - $ref: '#/components/schemas/EcsServerAddr' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the ' EcsServerAddr ' data type, but with + the OpenAPI 'nullable: true' property. + +IpAddr: + description: Contains an IP adresse. + type: object + oneOf: + - required: + - ipv4Addr + - required: + - ipv6Addr + - required: + - ipv6Prefix + properties: + ipv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: '#/components/schemas/Ipv6Prefix' + +SACInfo: + description: > + Represents threshold(s) to control the triggering of network slice reporting notifications + or the information contained in the network slice reporting notification. + type: object + properties: + numericValNumUes: + type: integer + numericValNumPduSess: + type: integer + percValueNumUes: + type: integer + minimum: 0 + maximum: 100 + percValueNumPduSess: + type: integer + minimum: 0 + maximum: 100 + uesWithPduSessionInd: + type: boolean + default: false + +SACEventStatus: + description: > + Contains the network slice status information in terms of the current number of UEs + registered with a network slice, the current number of PDU Sessions established on a + network slice or both. + type: object + properties: + reachedNumUes: + $ref: '#/components/schemas/SACInfo' + reachedNumPduSess: + $ref: '#/components/schemas/SACInfo' + +SpatialValidityCond: + description: Contains the Spatial Validity Condition. + type: object + properties: + trackingAreaList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + countries: + type: array + items: + $ref: '#/components/schemas/Mcc' + minItems: 1 + geographicalServiceArea: + $ref: '#/components/schemas/GeoServiceArea' + +SpatialValidityCondRm: +``` + +``` +description: Contains the Spatial Validity Condition or the null value. +anyOf: +- $ref: '#/components/schemas/SpatialValidityCond' +- $ref: '#/components/schemas/NullValue' + +ServerAddressingInfo: +description: Contains addressing information (IP addresses and/or FQDNs) of a server. +type: object +anyOf: +- required: +- ipv4Addresses +- required: +- ipv6Addresses +- required: +- fqdnList +properties: + ipv4Addresses: + type: array + items: + $ref: '#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: '#/components/schemas/Ipv6Addr' + minItems: 1 + fqdnList: + type: array + items: + $ref: '#/components/schemas/Fqdn' + minItems: 1 + +PcfUeCallbackInfo: +description: > + Contains the PCF for the UE information necessary for the PCF for the PDU session to send + SM Policy Association Establishment and Termination events. +type: object +properties: + callbackUri: + $ref: '#/components/schemas/Uri' + bindingInfo: + type: string + nullable: true + required: + - callbackUri + +PduSessionInfo: +description: indicates the DNN and S-NSSAI combination of a PDU session. +type: object +properties: + snssai: + $ref: '#/components/schemas/Snssai' + dnn: + $ref: '#/components/schemas/Dnn' + required: + - dnn + - snssai + +EasIpReplacementInfo: +description: Contains EAS IP replacement information for a Source and a Target EAS. +type: object +properties: + source: + $ref: '#/components/schemas/EasServerAddress' + target: + $ref: '#/components/schemas/EasServerAddress' + required: + - source + - target + +EasServerAddress: +description: Represents the IP address and port of an EAS server. +type: object +properties: + ip: + $ref: '#/components/schemas/IpAddr' + port: + $ref: '#/components/schemas/Uinteger' +``` + +``` +required: + - ip + - port + +RoamingRestrictions: + description: > + Indicates if access is allowed to a given serving network, e.g. a PLMN (MCC, MNC) or an + SNPN (MCC, MNC, NID). + type: object + properties: + accessAllowed: + type: boolean + +GeoServiceArea: + description: List of geographic area or list of civic address info + type: object + properties: + geographicAreaList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + civicAddressList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + +MutingExceptionInstructions: + description: > + Indicates to an Event producer NF instructions for the subscription and stored events when + an exception (e.g. full buffer) occurs at the Event producer NF while the event is muted. + type: object + properties: + bufferedNotifs: + $ref: '#/components/schemas/BufferedNotificationsAction' + subscription: + $ref: '#/components/schemas/SubscriptionAction' + +MutingNotificationsSettings: + description: > + Indicates the Event producer NF settings to the Event consumer NF + type: object + properties: + maxNoOfNotif: + type: integer + durationBufferedNotif: + $ref: '#/components/schemas/DurationSec' + +CombGciAndHfcNIDs: + type: object + properties: + globalCableId: + $ref: '#/components/schemas/Gci' + hfcNId: + $ref: '#/components/schemas/HfcNId' + +VplmnOffloadingInfo: + description: VPLMN Specific Offloading Information + type: object + properties: + offloadIdentifier: + $ref: '#/components/schemas/OffloadIdentifier' + vplmnId: + $ref: '#/components/schemas/PlmnId' + allowedTraffic: + type: boolean + default: true + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv4AddrMasks: + type: array + items: + $ref: '#/components/schemas/Ipv4AddrMask' +``` + +``` + minItems: 1 + ipv6AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + fqdnList: + type: array + items: + $ref: '#/components/schemas/Fqdn' + minItems: 1 + fqdnPatterns: + type: array + items: + $ref: '#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + sessionDIAmbr: + $ref: '#/components/schemas/BitRate' + +PartiallyAllowedSnssai: + description: > + Indicates a S-NSSAI that is partially allowed in the Registration Area. + type: object + properties: + snssai: + $ref: '#/components/schemas/SNSSAI' + allowedTaiList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + required: + - snssai + - allowedTaiList + +VarRepPeriod: + description: > + Indicates the Variable reporting periodicity for event reporting + type: object + properties: + repPeriod: + $ref: '#/components/schemas/DurationSec' + percValueNfLoad: + allOf: + - $ref: '#/components/schemas/UInteger' + minimum: 0 + maximum: 100 + required: + - repPeriod + +RangingSlPosAuth: + description: > + Indicates whether the UE is authorized to use related services. + type: object + properties: + rgSlPosTargetAuth: + $ref: '#/components/schemas/UeAuth' + rgSlPosSlRefAuth: + $ref: '#/components/schemas/UeAuth' + rgSlPosLocAuth: + $ref: '#/components/schemas/UeAuth' + rgSlPosClientAuth: + $ref: '#/components/schemas/UeAuth' + rgSlPosServerAuth: + $ref: '#/components/schemas/UeAuth' + +NrA2xAuth: + description: Contains NR A2X services authorized information. + type: object + properties: + uavUeAuth: +``` + +``` + + $ref: '#/components/schemas/UeAuth' + + LteA2xAuth: + description: Contains LTE A2X services authorized information. + type: object + properties: + uavUeAuth: + $ref: '#/components/schemas/UeAuth' + + SliceUsageControlInfo: + description: The network slice usage control related information + type: object + required: + - sNSSAI + properties: + sNSSAI: + $ref: '#/components/schemas/SNSSAI' + deregInactTimer: + $ref: '#/components/schemas/DurationSec' + sessInactTimer: + $ref: '#/components/schemas/DurationSec' + anyOf: + - required: [ deregInactTimer ] + - required: [ sessInactTimer ] + + SNSSAIDnnItem: + description: Combination of S-NSSAIs and DNNs + type: object + properties: + sNSSAIList: + type: array + items: + $ref: '#/components/schemas/ExtSNSSAI' + minItems: 1 + dnnList: + type: array + items: + $ref: '#/components/schemas/Dnn' + minItems: 1 + anyOf: + - required: [ sNSSAIList ] + - required: [ dnnList ] + + NtnTaiInfo: + type: object + required: + - plmnId + - tacList + properties: + plmnId: + $ref: '#/components/schemas/PlmnIdNid' + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + derivedTac: + $ref: '#/components/schemas/Tac' + +# +# Data types describing alternative data types or combinations of data types +# + + ExtSNSSAI: + allOf: + - $ref: '#/components/schemas/SNSSAI' + - $ref: '#/components/schemas/SNSSAIExtension' + description: > + The sdRanges and wildcardSd attributes shall be exclusive from each other. If one of these + attributes is present, the sd attribute shall also be present and it shall contain one + Slice + Differentiator value within the range of SD (if the sdRanges attribute is present) or with + any value (if the wildcardSd attribute is present). + + SNSSAIReplaceInfo: + description: Indicates the status of an S-NSSAI and an alternative S-NSSAI optionally. + type: object + +``` + +``` +properties: + snssai: + $ref: '#/components/schemas/Snssai' + status: + $ref: '#/components/schemas/SnssaiStatus' + altSnssai: + $ref: '#/components/schemas/Snssai' + nsReplTerminInd: + $ref: '#/components/schemas/TerminationIndication' + plmnId: + $ref: '#/components/schemas/PlmnId' + required: + - snssai + +# +# Data Types related to 5G QoS as defined in clause 5.5 +# + +# +# SIMPLE DATA TYPES +# +# + +Qfi: + type: integer + minimum: 0 + maximum: 63 + description: Unsigned integer identifying a QoS flow, within the range 0 to 63. + +QfiRm: + type: integer + minimum: 0 + maximum: 63 + nullable: true + description: > + This data type is defined in the same way as the 'Qfi' data type, but with the + OpenAPI 'nullable: true' property. + +5Qi: + type: integer + minimum: 0 + maximum: 255 + description: > + Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501, + within the range 0 to 255. + +5QiRm: + type: integer + minimum: 0 + maximum: 255 + nullable: true + description: > + This data type is defined in the same way as the '5QiPriorityLevel' data type, but with + the OpenAPI 'nullable: true' property. " + +BitRate: + type: string + pattern: '^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' + description: > + String representing a bit rate; the prefixes follow the standard symbols from The + International + System of Units, and represent x1000 multipliers, with the exception that prefix "K" is + used to represent the standard symbol "k". + +BitRateRm: + type: string + pattern: '^\\d+(\\.\\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' + nullable: true + description: > + This data type is defined in the same way as the 'BitRate' data type, but with the OpenAPI + 'nullable: true' property. + +PacketRate: + type: string + pattern: '^\\d+(\\.\\d+)? (pps|kpps|Mpps|Gpps|Tpps)$' + description: > + String representing a packet rate, i.e., packet per second; the prefixes follow the symbols + from The International System of Units, and represent x1000 multipliers. +``` + +``` +PacketRateRm: + type: string + pattern: '^\\d+(\\.\\d+)? (pps|kpps|Mpps|Gpps|Tpps)$' + nullable: true + description: > + This data type is defined in the same way as the 'PacketRate' data type, but with the + OpenAPI 'nullable: true' property. + +TrafficVolume: + type: string + pattern: '^\\d+(\\.\\d+)? (B|kB|MB|GB|TB)$' + description: > + String representing a Traffic Volume measured in bytes; the prefixes follow the symbols + from The International System of Units, and represent x1000 multipliers. + +TrafficVolumeRm: + type: string + pattern: '^\\d+(\\.\\d+)? (B|kB|MB|GB|TB)$' + nullable: true + description: > + This data type is defined in the same way as the 'TrafficVolume' data type, but with the + OpenAPI 'nullable: true' property. + +ArpPriorityLevelRm: + type: integer + minimum: 1 + maximum: 15 + nullable: true + description: > + This data type is defined in the same way as the 'ArpPriorityLevel' data type, but with + the OpenAPI 'nullable: true' property. + +ArpPriorityLevel: + type: integer + minimum: 1 + maximum: 15 + nullable: true + description: > + nullable true shall not be used for this attribute. Unsigned integer indicating the ARP + Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501, within the range 1 to 15. Values are + ordered in decreasing order of priority, i.e. with 1 as the highest priority and 15 as + the lowest priority. + +5QiPriorityLevel: + type: integer + minimum: 1 + maximum: 127 + description: > + Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP + TS 23.501, within the range 1 to 127. Values are ordered in decreasing order of priority, + i.e. with 1 as the highest priority and 127 as the lowest priority. + +5QiPriorityLevelRm: + type: integer + minimum: 1 + maximum: 127 + nullable: true + description: > + This data type is defined in the same way as the '5QiPriorityLevel' data type, but with + the OpenAPI 'nullable: true' property. + +PacketDelBudget: + type: integer + minimum: 1 + description: > + Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP + TS 23.501), expressed in milliseconds. + +PacketDelBudgetRm: + type: integer + minimum: 1 + nullable: true + description: > + This data type is defined in the same way as the 'PacketDelBudget' data type, but with + the OpenAPI 'nullable: true' property. + +PacketErrRate: +``` + +``` +type: string +pattern: '^([0-9]E-[0-9])$' +description: > + String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501, + expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as + one decimal digit. + +PacketErrRateRm: +type: string +pattern: '^([0-9]E-[0-9])$' +nullable: true +description: > + This data type is defined in the same way as the 'PacketErrRate' data type, but with + the OpenAPI 'nullable: true' property. + +PacketLossRate: +type: integer +minimum: 0 +maximum: 1000 +description: > + Unsigned integer indicating Packet Loss Rate (see clauses 5.7.2.8 and 5.7.4 of 3GPP + TS 23.501), expressed in tenth of percent. + +PacketLossRateRm: +type: integer +minimum: 0 +maximum: 1000 +nullable: true +description: > + This data type is defined in the same way as the 'PacketLossRate' data type, but with + the OpenAPI 'nullable: true' property. + +AverWindow: +type: integer +minimum: 1 +maximum: 4095 +default: 2000 +description: Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of +3GPP TS 23.501), expressed in milliseconds. + +AverWindowRm: +type: integer +maximum: 4095 +default: 2000 +minimum: 1 +nullable: true +description: > + This data type is defined in the same way as the 'AverWindow' data type, but with + the OpenAPI 'nullable: true' property. + +MaxDataBurstVol: +type: integer +minimum: 1 +maximum: 4095 +description: > + Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of + 3GPP TS 23.501), expressed in Bytes. + +MaxDataBurstVolRm: +type: integer +minimum: 1 +maximum: 4095 +nullable: true +description: > + This data type is defined in the same way as the 'MaxDataBurstVol' data type, but with + the OpenAPI 'nullable: true' property. + +SamplingRatio: +type: integer +minimum: 1 +maximum: 100 +description: > + Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502), + expressed in percent. + +SamplingRatioRm: +type: integer +minimum: 1 +``` + +``` + maximum: 100 + nullable: true + description: > + This data type is defined in the same way as the 'SamplingRatio' data type, but with the + OpenAPI 'nullable: true' property. +# +RgWirelineCharacteristics: + $ref: '#/components/schemas/Bytes' + +RgWirelineCharacteristicsRm: + anyOf: + - $ref: '#/components/schemas/RgWirelineCharacteristics' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'RgWirelineCharacteristics' data type, + but with the OpenAPI 'nullable: true' property. + +ExtMaxDataBurstVol: + type: integer + minimum: 4096 + maximum: 2000000 + description: > + Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of + 3GPP TS 23.501), expressed in Bytes. + +ExtMaxDataBurstVolRm: + type: integer + minimum: 4096 + maximum: 2000000 + nullable: true + description: > + This data type is defined in the same way as the 'ExtMaxDataBurstVol' data type, but + with the OpenAPI 'nullable: true' property. + +ExtPacketDelBudget: + type: integer + minimum: 1 + description: > + Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP + TS 23.501 [8]), expressed in 0.01 milliseconds. + +ExtPacketDelBudgetRm: + type: integer + minimum: 1 + nullable: true + description: > + This data type is defined in the same way as the 'ExtPacketDelBudget' data type, but + with the OpenAPI 'nullable: true' property. " + +Metadata: + format: byte + type: string + nullable: true + description: > + A String which is transparently passed to the UPF to be applied for traffic to SFC. + +PduSetDelayBudget: + type: integer + minimum: 1 + description: > + Unsigned integer indicating PDU Set Delay Budget (PSDB) (see clause 5.7.7.2 of 3GPP + TS 23.501), expressed in 0.01 milliseconds. + +PduSetDelayBudgetRm: + type: integer + minimum: 1 + nullable: true + description: > + This data type is defined in the same way as the 'PduSetDelayBudget' data type, but with + the OpenAPI 'nullable: true' property. + +PduSetErrRate: + type: string + pattern: '^([0-9]E-[0-9])$' + description: > + String representing PDU Set Error Rate (PSER) (see clause 5.7.7.3 3GPP TS 23.501 [8]) where + the scalar and the exponent k are each encoded as one decimal digit. +``` + +``` +PduSetErrRateRm: + type: string + pattern: '^[0-9]E-[0-9]E$' + nullable: true + description: > + This data type is defined in the same way as the 'PduSetErrRate' data type, but with the + OpenAPI 'nullable: true' property. +``` + +``` +# +# ENUMERATED DATA TYPES +# +``` + +``` +PreemptionCapability: + anyOf: + - type: string + enum: + - NOT_PREEMPT + - MAY_PREEMPT + - type: string + description: > + The enumeration PreemptionCapability indicates the pre-emption capability of a request on + other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It shall comply with the provisions + defined in table 5.5.3.1-1. +``` + +``` +PreemptionCapabilityRm: + anyOf: + - $ref: '#/components/schemas/PreemptionCapability' + - $ref: '#/components/schemas/NullValue' + description: > + This enumeration is defined in the same way as the 'PreemptionCapability' enumeration, + but with the OpenAPI 'nullable: true' property. +``` + +``` +PreemptionVulnerability: + anyOf: + - type: string + enum: + - NOT_PREEMPTABLE + - PREEMPTABLE + - type: string + description: > + The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS + flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501. It shall + comply with the provisions defined in table 5.5.3.2-1 +``` + +``` +PreemptionVulnerabilityRm: + anyOf: + - $ref: '#/components/schemas/PreemptionVulnerability' + - $ref: '#/components/schemas/NullValue' + description: > + This enumeration is defined in the same way as the 'PreemptionVulnerability' enumeration, + but with the OpenAPI 'nullable: true' property." +``` + +``` +ReflectiveQoSAttribute: + anyOf: + - type: string + enum: + - RQOS + - NO_RQOS + - type: string + description: > + The enumeration ReflectiveQoSAttribute indicates whether certain traffic of the QoS flow may + be subject to Reflective QoS (see clause 5.7.2.3 of 3GPP TS 23.501). It shall comply with + the provisions defined in table 5.5.3.3-1. +``` + +``` +ReflectiveQoSAttributeRm: + anyOf: + - $ref: '#/components/schemas/ReflectiveQoSAttribute' + - $ref: '#/components/schemas/NullValue' + description: > + This enumeration is defined in the same way as the 'ReflectiveQoSAttribute' enumeration, + but with the OpenAPI 'nullable: true' property. " +``` + +``` +NotificationControl: + anyOf: + - type: string + enum: + - REQUESTED + - NOT_REQUESTED + - type: string +``` + +description: > +The enumeration NotificationControl indicates whether notifications are requested from the RAN when the GFBR can no longer (or again) be fulfilled for a QoS Flow during the lifetime of the QoS Flow (see clause 5.7.2.4 of 3GPP TS 23.501). +It shall comply with the provisions defined in table 5.5.3.5-1. + +NotificationControlRm: +anyOf: +- \$ref: '#/components/schemas/NotificationControl' +- \$ref: '#/components/schemas/NullValue' +description: > +This enumeration is defined in the same way as the 'NotificationControl' enumeration, but with the OpenAPI 'nullable: true' property. + +QosResourceType: +anyOf: +- type: string +enum: +- NON\_GBR +- NON\_CRITICAL\_GBR +- CRITICAL\_GBR +- type: string +description: > +The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501). It shall comply with the provisions defined in table 5.5.3.6-1. + +QosResourceTypeRm: +anyOf: +- \$ref: '#/components/schemas/QosResourceType' +- \$ref: '#/components/schemas/NullValue' +description: > +This enumeration is defined in the same way as the 'QosResourceType' enumeration, but with the OpenAPI 'nullable: true' property. " + +AdditionalQosFlowInfo: +anyOf: +- anyOf: +- type: string +enum: +- MORE\_LIKELY +- type: string +- \$ref: '#/components/schemas/NullValue' +description: > +The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause 9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table 5.5.3.12-1. + +PartitioningCriteria: +anyOf: +- type: string +enum: +- TAC +- SUBPLMN +- GEOAREA +- SNSSAI +- DNN +- type: string +description: > +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. +description: | +Possible values are: +- "TAC": Type Allocation Code +- "SUBPLMN": Subscriber PLMN ID +- "GEOAREA": Geographical area, i.e. list(s) of TAI(s) +- "SNSSAI": S-NSSAI +- "DNN": DNN + +PartitioningCriteriaRm: +anyOf: +- \$ref: '#/components/schemas/PartitioningCriteria' +- \$ref: '#/components/schemas/NullValue' +description: > +This data type is defined in the same way as the 'PartitioningCriteria' data type, but with the OpenAPI 'nullable: true' property. + +``` +PduSetHandlingInfo: + anyOf: + - type: string + enum: + - ALL_PDUS_NEEDED + - ALL_PDUS_NOT_NEEDED + - type: string + description: > + 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. + description: | + Possible values are: + - "ALL_PDUS_NEEDED": All PDUs of the PDU Set are needed + - "ALL_PDUS_NOT_NEEDED": All PDUs of the PDU Set are not needed + +MediaTransportProto: + anyOf: + - type: string + enum: + - RTP + - SRTP + - type: string + description: > + The enumeration MediaTransportProto indicates the transport protocol used for a media flow. + +RtpHeaderExtType: + anyOf: + - type: string + enum: + - PDU_SET_MARKING + - type: string + description: > + The enumeration indicates the type of Rtp Header Extension type + +RtpPayloadFormat: + anyOf: + - type: string + enum: + - H264 + - H265 + - type: string + description: > + The enumeration RtpPayloadFormat indicates the RTP Payload format + +# +# +# STRUCTURED DATA TYPES +# + +Arp: + description: Contains Allocation and Retention Priority information. + type: object + properties: + priorityLevel: + $ref: '#/components/schemas/ArpPriorityLevel' + preemptCap: + $ref: '#/components/schemas/PreemptionCapability' + preemptVuln: + $ref: '#/components/schemas/PreemptionVulnerability' + required: + - priorityLevel + - preemptCap + - preemptVuln + +Ambr: + description: Contains the maximum aggregated uplink and downlink bit rates. + type: object + properties: + uplink: + $ref: '#/components/schemas/BitRate' + downlink: + $ref: '#/components/schemas/BitRate' + required: + - uplink + - downlink +``` + +``` + +Dynamic5Qi: + description: > + It indicates the QoS Characteristics for a Non-standardised or not pre-configured 5QI + for downlink and uplink. + type: object + properties: + resourceType: + $ref: '#/components/schemas/QosResourceType' + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + packetDelayBudget: + $ref: '#/components/schemas/PacketDelBudget' + packetErrRate: + $ref: '#/components/schemas/PacketErrRate' + averWindow: + $ref: '#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: '#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: '#/components/schemas/ExtMaxDataBurstVol' + extPacketDelBudget: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetDl: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetUl: + $ref: '#/components/schemas/ExtPacketDelBudget' + required: + - resourceType + - priorityLevel + - packetDelayBudget + - packetErrRate + +NonDynamic5Qi: + description: > + It indicates the QoS Characteristics for a standardized or pre-configured 5QI for downlink + and uplink. + type: object + properties: + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + averWindow: + $ref: '#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: '#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: '#/components/schemas/ExtMaxDataBurstVol' + cnPacketDelayBudgetDl: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetUl: + $ref: '#/components/schemas/ExtPacketDelBudget' + minProperties: 0 + +ArpRm: + anyOf: + - $ref: '#/components/schemas/Arp' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'Arp' data type, but with the + OpenAPI 'nullable: true' property. + +AmbrRm: + anyOf: + - $ref: '#/components/schemas/Ambr' + - $ref: '#/components/schemas/NullValue' + description: > + This data type is defined in the same way as the 'Ambr' data type, but with the + OpenAPI 'nullable: true' property." + +SliceMbr: + description: MBR related to slice + type: object + properties: + uplink: + $ref: '#/components/schemas/BitRate' + downlink: + $ref: '#/components/schemas/BitRate' + required: + - uplink + +``` + +``` +- downlink + +SliceMbrRm: + description: "SliceMbr with nullable: true" + + anyOf: + - $ref: '#/components/schemas/SliceMbr' + - $ref: '#/components/schemas/NullValue' + +PduSetQosPara: + description: Represents the PDU Set level QoS parameters. + type: object + properties: + pduSetDelayBudget: + $ref: '#/components/schemas/PduSetDelayBudget' + pduSetErrRate: + $ref: '#/components/schemas/PduSetErrRate' + pduSetHandlingInfo: + $ref: '#/components/schemas/PduSetHandlingInfo' +# + +PduSetQosParaRm: + description: "PduSetQosPara with nullable: true" + anyOf: + - $ref: '#/components/schemas/PduSetQosPara' + - $ref: '#/components/schemas/NullValue' + +ProtocolDescription: + description: ProtocolDescription contains information to derive PDU set information. + type: object + properties: + transportProto: + $ref: '#/components/schemas/MediaTransportProto' + rtpHeaderExtInfo: + $ref: '#/components/schemas/RtpHeaderExtInfo' + rtpPayloadInfoList: + type: array + items: + $ref: '#/components/schemas/RtpPayloadInfo' + minItems: 1 + +RtpHeaderExtInfo: + description: RTP Header Extension information + type: object + properties: + rtpHeaderExtType: + $ref: '#/components/schemas/RtpHeaderExtType' + rtpHeaderExtId: + type: integer + minimum: 1 + maximum: 255 + +RtpPayloadInfo: + description: RtpPayloadInfo contains Rtp payload type and format. + type: object + properties: + rtpPayloadTypeList: + type: array + items: + type: integer + minimum: 1 + maximum: 127 + minItems: 1 + rtpPayloadFormat: + $ref: '#/components/schemas/RtpPayloadFormat' + +# +# Data Types related to 5G Trace as defined in clause 5.6 +# + +# +# SIMPLE DATA TYPES +# + +PhysCellId: + type: integer + minimum: 0 +``` + +maximum: 1007 +description: > +Integer value identifying the physical cell identity (PCI), as definition of "PhysCellId" IE in clause 6.3.2 of 3GPP TS 38.331. + +ArfcnValueNR: +type: integer +minimum: 0 +maximum: 3279165 +description: > +Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster, as definition of "ARFCN-ValueNR" IE in clause 6.3.2 of 3GPP TS 38.331. + +QoeReference: +description: > +String containing MCC (3 digits), MNC (2 or 3 digits) and QMC ID (3 octets, encoded as 6 hexadecimal digits). +type: string +pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}\$' + +MdtAlignmentInfo: +description: | +String containing: +- Trace Reference: MCC (3 digits), MNC (2 or 3 digits), Trace ID (3 octets, encoded as 6 hexadecimal digits) +- Trace Recording Session Reference (2 octets, encoded as 4 hexadecimal digits) +format: string +pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{6}-[A-Fa-f0-9]{4}\$' + +# +# +# Enumerations +# + +TraceDepth: +anyOf: +- type: string +enum: +- MINIMUM +- MEDIUM +- MAXIMUM +- MINIMUM\_WO\_VENDOR\_EXTENSION +- MEDIUM\_WO\_VENDOR\_EXTENSION +- MAXIMUM\_WO\_VENDOR\_EXTENSION +- type: string +description: > +The enumeration TraceDepth defines how detailed information should be recorded in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.1-1 + +TraceDepthRm: +anyOf: +- \$ref: '#/components/schemas/TraceDepth' +- \$ref: '#/components/schemas/NullValue' +description: > +This enumeration is defined in the same way as the 'TraceDepth' enumeration, but with the OpenAPI 'nullable: true' property. + +JobType: +anyOf: +- type: string +enum: +- IMMEDIATE\_MDT\_ONLY +- LOGGED\_MDT\_ONLY +- TRACE\_ONLY +- IMMEDIATE\_MDT\_AND\_TRACE +- RLF\_REPORTS\_ONLY +- RCEF\_REPORTS\_ONLY +- LOGGED\_MBSFN\_MDT +- type: string +description: > +The enumeration JobType defines Job Type in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.3-1. + +ReportTypeMdt: +anyOf: +- type: string + +``` +enum: + - PERIODICAL + - EVENT_TRIGGERED +- type: string +description: > + The enumeration ReportTypeMdt defines Report Type for logged MDT in the trace. See 3GPP TS + 32.422 for further description of the values. It shall comply with the provisions defined + in table 5.6.3.4-1. + +MeasurementLteForMdt: + anyOf: + - type: string + enum: + - M1 + - M2 + - M3 + - M4_DL + - M4_UL + - M5_DL + - M5_UL + - M6_DL + - M6_UL + - M7_DL + - M7_UL + - M8 + - M9 + - type: string +description: > + The enumeration MeasurementLteForMdt defines Measurements used for MDT in LTE in the trace. + See 3GPP TS 32.422 for further description of the values. It shall comply with the + provisions defined in table 5.6.3.5-1. + +MeasurementNrForMdt: + anyOf: + - type: string + enum: + - M1 + - M2 + - M3 + - M4_DL + - M4_UL + - M5_DL + - M5_UL + - M6_DL + - M6_UL + - M7_DL + - M7_UL + - M8 + - M9 + - type: string +description: > + The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace. + See 3GPP TS 32.422 for further description of the values. It shall comply with the + provisions defined in table 5.6.3.6-1. + +SensorMeasurement: + anyOf: + - type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + - type: string +description: > + The enumeration SensorMeasurement defines sensor measurement type for MDT in the trace. + See 3GPP TS 32.422 for further description of the values. It shall comply with the + provisions defined in table 5.6.3.7-1. + +ReportingTrigger: + anyOf: + - type: string + enum: + - PERIODICAL + - EVENT_A2 + - EVENT_A2_PERIODIC + - ALL_RRM_EVENT_TRIGGERS + - type: string +description: > +``` + +The enumeration ReportingTrigger defines Reporting Triggers for MDT in the trace. See 3GPP TS 32.42] for further description of the values. It shall comply with the provisions defined in table 5.6.3.8-1. + +``` +ReportIntervalMdt: + anyOf: + - type: string + enum: + - 120 + - 240 + - 480 + - 640 + - 1024 + - 2048 + - 5120 + - 10240 + - 60000 + - 360000 + - 720000 + - 1800000 + - 3600000 + - type: string + description: > + The enumeration ReportIntervalMdt defines Report Interval for MDT in the trace. See 3GPP + TS 32.422 for further description of the values. It shall comply with + the provisions defined in table 5.6.3.9-1. +``` + +``` +ReportAmountMdt: + anyOf: + - type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - infinity + - type: string + description: > + The enumeration ReportAmountMdt defines Report Amount for MDT in the trace. See 3GPP + TS 32.422 for further description of the values. It shall comply with the provisions + defined in table 5.6.3.10-1. +``` + +``` +EventForMdt: + anyOf: + - type: string + enum: + - OUT_OF_COVERAG + - A2_EVENT + - type: string + description: > + The enumeration EventForMdt defines events triggered measurement for logged MDT in the + trace. See 3GPP TS 32.422 for further description of the values. It shall comply with + the provisions defined in table 5.6.3.11-1 +``` + +``` +LoggingIntervalMdt: + anyOf: + - type: string + enum: + - 128 + - 256 + - 512 + - 1024 + - 2048 + - 3072 + - 4096 + - 6144 + - type: string + description: > + The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP + TS 32.422 for further description of the values. It shall comply with the provisions + defined in table 5.6.3.12-1. +``` + +``` +LoggingDurationMdt: + anyOf: + - type: string +``` + +``` +enum: + - 600 + - 1200 + - 2400 + - 3600 + - 5400 + - 7200 +- type: string +description: > + The enumeration LoggingIntervalMdt defines Logging Interval for MDT in the trace. See 3GPP + TS 32.422 for further description of the values. It shall comply with the provisions + defined in table 5.6.3.12-1. + +PositioningMethodMdt: +anyOf: +- type: string + enum: + - GNSS + - E_CELL_ID +- type: string +description: > + The enumeration LoggingDurationMdt defines Logging Duration for MDT in the trace. See 3GPP + TS 32.422 for further description of the values. It shall comply with the provisions + defined in table 5.6.3.13-1. + +CollectionPeriodRmmLteMdt: +anyOf: +- type: string + enum: + - 1024 + - 1280 + - 2048 + - 2560 + - 5120 + - 10240 + - 60000 +- type: string +description: > + The enumeration CollectionPeriodRmmLteMdt defines Collection period for RRM measurements + LTE for MDT in the trace. See 3GPP TS 32.422 for further description of the values. + It shall comply with the provisions defined in table 5.6.3.15-1. + +MeasurementPeriodLteMdt: +anyOf: +- type: string + enum: + - 1024 + - 1280 + - 2048 + - 2560 + - 5120 + - 10240 + - 60000 +- type: string +description: > + The enumeration MeasurementPeriodLteMdt defines Measurement period LTE for MDT in the + trace. See 3GPP TS 32.422 for further description of the values. It shall comply + with the provisions defined in table 5.6.3.16-1. + +ReportIntervalNrMdt: +anyOf: +- type: string + enum: + - 120 + - 240 + - 480 + - 640 + - 1024 + - 2048 + - 5120 + - 10240 + - 20480 + - 40960 + - 60000 + - 360000 + - 720000 + - 1800000 + - 3600000 +``` + +- type: string + +description: > + +The enumeration ReportIntervalNrMdt defines Report Interval in NR for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.17-1. + +LoggingIntervalNrMdt: + +anyOf: + +- type: string + +enum: + +- 128 +- 256 +- 512 +- 1024 +- 2048 +- 3072 +- 4096 +- 6144 +- 320 +- 640 +- infinity + +- type: string + +description: > + +The enumeration LoggingIntervalNrMdt defines Logging Interval in NR for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.18-1. + +CollectionPeriodRmmNrMdt: + +anyOf: + +- type: string + +enum: + +- 1024 +- 2048 +- 5120 +- 10240 +- 60000 + +- type: string + +description: > + +The enumeration CollectionPeriodRmmNrMdt defines Collection period for RRM measurements NR for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.19-1 + +LoggingDurationNrMdt: + +anyOf: + +- type: string + +enum: + +- 600 +- 1200 +- 2400 +- 3600 +- 5400 +- 7200 + +- type: string + +description: > + +The enumeration LoggingDurationMdt defines Logging Duration in NR for MDT in the trace. See 3GPP TS 32.422 for further description of the values. It shall comply with the provisions defined in table 5.6.3.20-1. + +QoeServiceType: + +description: > + +The enumeration QoeServiceType indicates the kind of service that shall be recorded for QMC. It shall comply with the provisions defined in TS 29.571, table 5.6.3.21-1. + +anyOf: + +- type: string + +enum: + +- DASH +- MTSI +- VR + +- type: string + +description: > + +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. + +AvailableRanVisibleQoeMetric: + +description: > + +The enumeration AvailableRanVisibleQoeMetric indicates different available RAN-visible QoE metrics to the gNB. It shall comply with the provisions defined in TS 29.571, table 5.6.3.22-1. + +``` + +anyOf: +- type: string + enum: + - APPLICATION_LAYER_BUFFER_LEVEL_LIST + - PLAYOUT_DELAY_FOR_MEDIA_STARTUP +- type: string + description: > + 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. + +``` + +``` + +# +# STRUCTURED DATA TYPES +# + +``` + +``` + +TraceData: + description: contains Trace control and configuration parameters. + +``` + +``` + + type: object + nullable: true + properties: + +``` + +``` + + traceRef: + +``` + +``` + + type: string + +``` + +``` + + pattern: '^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$' + +``` + +``` + + description: > + +``` + +``` + + Trace Reference (see 3GPP TS 32.422). It shall be encoded as the concatenation of MCC, + MNC and Trace ID as follows: 'MCC' + +``` + +``` + + List of NE Types (see 3GPP TS 32.422). It shall be encoded as an octet string in + hexadecimal representation. + +``` + +``` + + Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" + and shall represent 4 bits. + +``` + +``` + + The most significant character representing the 4 most significant bits shall appear + first in the string, and the character representing the + +``` + +``` + + 4 least significant bit shall appear last in the string. Octets shall be coded + according to 3GPP TS 32.422. + +``` + +``` + + eventList: + +``` + +``` + + type: string + +``` + +``` + + pattern: '^[A-Fa-f0-9]+$' + +``` + +``` + + description: > + +``` + +``` + + Triggering events (see 3GPP TS 32.422). It shall be encoded as an octet string in + hexadecimal representation. Each character in the string shall take a value of "0" + to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. + +``` + +``` + + The most significant character representing the 4 most significant bits shall appear + first in the string, and the character representing the 4 least significant bit shall + appear last in the string. Octets shall be coded according to 3GPP TS 32.422. + +``` + +``` + + collectionEntityIpv4Addr: + +``` + +``` + + $ref: '#/components/schemas/Ipv4Addr' + +``` + +``` + + collectionEntityIpv6Addr: + +``` + +``` + + $ref: '#/components/schemas/Ipv6Addr' + +``` + +``` + + interfaceList: + +``` + +``` + + type: string + +``` + +``` + + pattern: '^[A-Fa-f0-9]+$' + +``` + +``` + + description: > + +``` + +``` + + List of Interfaces (see 3GPP TS 32.422). It shall be encoded as an octet string in + hexadecimal representation. + +``` + +``` + + Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" + and shall represent 4 bits. The most significant character representing the 4 most + significant bits shall appear first in the string, and the character representing the + +``` + +``` + + 4 least significant bit shall appear last in the string. Octets shall be coded + according to 3GPP TS 32.422. If this attribute is not present, all the interfaces + applicable to the list of NE types indicated in the neTypeList attribute should + be traced. + +``` + +``` + + required: + +``` + +- traceRef +- traceDepth +- neTypeList + +``` +- eventList + +MdtConfiguration: + description: contains contain MDT configuration data. + type: object + required: + - jobType + properties: + jobType: + $ref: '#/components/schemas/JobType' + reportType: + $ref: '#/components/schemas/ReportTypeMdt' + areaScope: + $ref: '#/components/schemas/AreaScope' + measurementLteList: + type: array + items: + $ref: '#/components/schemas/MeasurementLteForMdt' + measurementNrList: + type: array + items: + $ref: '#/components/schemas/MeasurementNrForMdt' + minItems: 1 + sensorMeasurementList: + type: array + items: + $ref: '#/components/schemas/SensorMeasurement' + minItems: 1 + reportingTriggerList: + type: array + items: + $ref: '#/components/schemas/ReportingTrigger' + minItems: 1 + reportInterval: + $ref: '#/components/schemas/ReportIntervalMdt' + reportIntervalNr: + $ref: '#/components/schemas/ReportIntervalNrMdt' + reportAmount: + $ref: '#/components/schemas/ReportAmountMdt' + eventThresholdRsrp: + type: integer + minimum: 0 + maximum: 97 + description: > + This IE shall be present if the report trigger parameter is configured for A2 event + reporting or A2 event triggered periodic reporting and the job type parameter is + configured for Immediate MDT or combined Immediate MDT and Trace in LTE. + When present, this IE shall indicate the Event Threshold for RSRP, and the value shall + be between 0-97. + eventThresholdRsrpNr: + type: integer + minimum: 0 + maximum: 127 + description: > + This IE shall be present if the report trigger parameter is configured for A2 event + reporting or A2 event triggered periodic reporting and the job type parameter is + configured for Immediate MDT or combined Immediate MDT + and Trace in NR. When present, + this IE shall indicate the Event Threshold for RSRP, and the value shall be + between 0-127. + eventThresholdRsrq: + type: integer + minimum: 0 + maximum: 34 + description: > + This IE shall be present if the report trigger parameter is configured for A2 event + reporting or A2 event triggered periodic reporting and the job type parameter is + configured for Immediate MDT or combined Immediate MDT and Trace in LTE.When present, + this IE shall indicate the Event Threshold for RSRQ, and the value shall be + between 0-34. + eventThresholdRsqrqNr: + type: integer + minimum: 0 + maximum: 127 + description: > + This IE shall be present if the report trigger parameter is configured for A2 event + reporting or A2 event triggered periodic reporting and the job type parameter is +``` + +``` + + configured for Immediate MDT or combined Immediate MDT and Trace in NR. When present, + this IE shall indicate the Event Threshold for RSRQ, and the value shall be + between 0-127. + eventList: + type: array + items: + $ref: '#/components/schemas/EventForMdt' + minItems: 1 + loggingInterval: + $ref: '#/components/schemas/LoggingIntervalMdt' + loggingIntervalNr: + $ref: '#/components/schemas/LoggingIntervalNrMdt' + loggingDuration: + $ref: '#/components/schemas/LoggingDurationMdt' + loggingDurationNr: + $ref: '#/components/schemas/LoggingDurationNrMdt' + positioningMethod: + $ref: '#/components/schemas/PositioningMethodMdt' + addPositioningMethodList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodMdt' + minItems: 1 + collectionPeriodRmmLte: + $ref: '#/components/schemas/CollectionPeriodRmmLteMdt' + collectionPeriodRmmNr: + $ref: '#/components/schemas/CollectionPeriodRmmNrMdt' + measurementPeriodLte: + $ref: '#/components/schemas/MeasurementPeriodLteMdt' + mdtAllowedPlmnIdList: + type: array + items: + $ref: '#/components/schemas/PlmnId' + minItems: 1 + maxItems: 16 + mbsfnAreaList: + type: array + items: + $ref: '#/components/schemas/MbsfnArea' + minItems: 1 + maxItems: 8 + interFreqTargetList: + type: array + items: + $ref: '#/components/schemas/InterFreqTargetInfo' + minItems: 1 + maxItems: 8 + +AreaScope: + description: Contain the area based on Cells or Tracking Areas. + type: object + properties: + eutraCellIdList: + type: array + items: + $ref: '#/components/schemas/EutraCellId' + minItems: 1 + nrCellIdList: + type: array + items: + $ref: '#/components/schemas/NrCellId' + minItems: 1 + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + tacInfoPerPlmn: + type: object + additionalProperties: + $ref: '#/components/schemas/TacInfo' + minProperties: 1 + description: > + A map (list of key-value pairs) where PlmnId converted to a string serves as key + +TacInfo: + description: contains tracking area information (tracking area codes). + type: object + +``` + +``` + required: + - tacList + properties: + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + + MbsfnArea: + description: Contains an MBFSN area information. + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 0 + maximum: 255 + description: This IE shall contain the MBFSN Area ID. + carrierFrequency: + type: integer + minimum: 0 + maximum: 262143 + description: When present, this IE shall contain the Carrier Frequency (EARFCN). + + InterFreqTargetInfo: + description: Indicates the Inter Frequency Target information. + required: + - dlCarrierFreq + type: object + properties: + dlCarrierFreq: + $ref: '#/components/schemas/ArfcnValueNR' + cellIdList: + type: array + items: + $ref: '#/components/schemas/PhysCellId' + minItems: 1 + maxItems: 32 + description: > + When present, this IE shall contain a list of the physical cell identities where the + UE is requested to perform measurement logging for the indicated frequency. + + QmcConfigInfo: + description: > + It contains the configuration information for signaling-based activation of the + Quality of Experience (QoE) Measurements Collection (QMC) functionality. + type: object + required: + - qoeReference + properties: + qoeReference: + $ref: '#/components/schemas/QoeReference' + serviceType: + $ref: '#/components/schemas/QoeServiceType' + sliceScope: + type: array + items: + $ref: '#/components/schemas/Snssai' + minItems: 1 + areaScope: + $ref: '#/components/schemas/QmcAreaScope' + qoeCollectionEntityAddress: + $ref: '#/components/schemas/IpAddress' + qoeTarget: + $ref: '#/components/schemas/QoeTarget' + mdtAlignmentInfo: + $ref: '#/components/schemas/MdtAlignmentInfo' + availableRanVisibleQoeMetrics: + type: array + items: + $ref: '#/components/schemas/AvailableRanVisibleQoeMetric' + minItems: 1 + containerForAppLayerMeasConfig: + $ref: '#/components/schemas/Bytes' + mbsCommunicationServiceType: + $ref: '#/components/schemas/MbsServiceType' +``` + +``` +QmcAreaScope: + description: > + This IE contains the area in Cells or Tracking Areas where the QMC data collection + shall take place. + type: object + properties: + nrCellIdList: + type: array + items: + $ref: '#/components/schemas/NrCellId' + minItems: 1 + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + taiList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + plmnList: + type: array + items: + $ref: '#/components/schemas/PlmnId' + minItems: 1 + +QoeTarget: + description: > + This parameter specifies the target object (individual UE) for the QMC in case of + signalling based QMC. It shall be able to carry an IMSI or a SUPI. + type: object + properties: + supi: + $ref: '#/components/schemas/Supi' + imsi: + $ref: '#/components/schemas/Imsi' +``` + +# Data Types related to 5G ODB as defined in clause 5.7 + +``` +# +# SIMPLE DATA TYPES +# +# Enumerations +# +RoamingOdb: + anyOf: + - type: string + enum: + - OUTSIDE_HOME_PLMN + - OUTSIDE_HOME_PLMN_COUNTRY + - type: string + description: > + The enumeration RoamingOdb defines the Barring of Roaming as. See 3GPP TS 23.015 for further + description. It shall comply with the provisions defined in table 5.7.3.1-1. + +OdbPacketServices: + anyOf: + - anyOf: + - type: string + enum: + - ALL_PACKET_SERVICES + - ROAMER_ACCESS_HPLMN_AP + - ROAMER_ACCESS_VPLMN_AP + - type: string + - $ref: '#/components/schemas/NullValue' + description: > + The enumeration OdbPacketServices defines the Barring of Packet Oriented Services. + See 3GPP TS 23.015 for further description. It shall comply with the provisions defined + in table 5.7.3.2-1 + +# +# STRUCTURED DATA TYPES +# +``` + +``` +OdbData: + description: Contains information regarding operator determined barring. + type: object + properties: + roamingOdb: + $ref: '#/components/schemas/RoamingOdb' + +# +# Data Types related to Charging as defined in clause 5.8 +# + +# +# SIMPLE DATA TYPES +# +# + +ChargingId: + deprecated: true + type: integer + minimum: 0 + maximum: 4294967295 #(2^32)-1 + description: > + Integer where the allowed values correspond to the value range of an unsigned 32-bit + integer. + +SmfChargingId: + description: String based Charging ID + type: string + pattern: '^([0-9]{1}[0-9]{0,9})\.smf-([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$' + +ApplicationChargingId: + type: string + description: > + Application provided charging identifier allowing correlation of charging information. + +RatingGroup: + $ref: '#/components/schemas/Uint32' + +ServiceId: + $ref: '#/components/schemas/Uint32' + +# +# Enumerations +# + +# +# STRUCTURED DATA TYPES +# + +SecondaryRatUsageReport: + description: Secondary RAT Usage Report to report usage data for a secondary RAT for QoS + flows. + type: object + properties: + secondaryRatType: + $ref: '#/components/schemas/RatType' + qosFlowsUsageData: + type: array + items: + $ref: '#/components/schemas/QosFlowUsageReport' + minItems: 1 + required: + - secondaryRatType + - qosFlowsUsageData + +QosFlowUsageReport: + description: Contains QoS flows usage data information. + type: object + properties: + qfi: + $ref: '#/components/schemas/Qfi' + startTimestamp: + $ref: '#/components/schemas/DateTime' + endTimestamp: + $ref: '#/components/schemas/DateTime' + downlinkVolume: + $ref: '#/components/schemas/Int64' +``` + +``` + uplinkVolume: + $ref: '#/components/schemas/Int64' + required: + - qfi + - startTimestamp + - endTimestamp + - downlinkVolume + - uplinkVolume + +SecondaryRatUsageInfo: + description: > + Secondary RAT Usage Information to report usage data for a secondary RAT for QoS flows + and/or the whole PDU session. + type: object + properties: + secondaryRatType: + $ref: '#/components/schemas/RatType' + qosFlowsUsageData: + type: array + items: + $ref: '#/components/schemas/QosFlowUsageReport' + minItems: 1 + pduSessionUsageData: + type: array + items: + $ref: '#/components/schemas/VolumeTimedReport' + minItems: 1 + required: + - secondaryRatType + +VolumeTimedReport: + description: Contains Usage data information. + type: object + properties: + startTimestamp: + $ref: '#/components/schemas/DateTime' + endTimestamp: + $ref: '#/components/schemas/DateTime' + downlinkVolume: + $ref: '#/components/schemas/Int64' + uplinkVolume: + $ref: '#/components/schemas/Int64' + required: + - startTimestamp + - endTimestamp + - downlinkVolume + - uplinkVolume + +# Data Types related to MBS as defined in clause 5.9 +# + +# +# SIMPLE DATA TYPES +# +# + +AreaSessionId: + $ref: '#/components/schemas/Uint16' + +AreaSessionPolicyId: + $ref: '#/components/schemas/Uint16' + +MbsFsaId: + description: MBS Frequency Selection Area Identifier + type: string + pattern: '^[A-Fa-f0-9]{6}$' + +# +# Enumerations +# +# + +MbsServiceType: + description: Indicates the MBS service type of an MBS session + anyOf: + - type: string +``` + +``` +enum: + - MULTICAST + - BROADCAST +- type: string + +MbsSessionActivityStatus: + description: Indicates the MBS session's activity status + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + +MbsSessionEventType: + description: MBS Session Event Type + anyOf: + - type: string + enum: + - MBS_REL_TMGI_EXPIRY + - BROADCAST_DELIVERY_STATUS + - INGRESS_TUNNEL_ADD_CHANGE + - type: string + +BroadcastDeliveryStatus: + description: Broadcast MBS Session's Delivery Status + anyOf: + - type: string + enum: + - STARTED + - TERMINATED + - type: string + +# +# STRUCTURED DATA TYPES +# + +MbsSessionId: + description: MBS Session Identifier + type: object + properties: + tmgi: + $ref: '#/components/schemas/Tmgi' + ssm: + $ref: '#/components/schemas/Ssm' + nid: + $ref: '#/components/schemas/Nid' + anyOf: + - required: [ tmgi ] + - required: [ ssm ] + +Tmgi: + description: Temporary Mobile Group Identity + type: object + properties: + mbsServiceId: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + description: MBS Service ID + plmnId: + $ref: '#/components/schemas/PlmnId' + required: + - mbsServiceId + - plmnId + +Ssm: + description: Source specific IP multicast address + type: object + properties: + sourceIpAddr: + $ref: '#/components/schemas/IpAddr' + destIpAddr: + $ref: '#/components/schemas/IpAddr' + required: + - sourceIpAddr + - destIpAddr + +MbsServiceArea: + description: MBS Service Area +``` + +``` +type: object +properties: + ncgiList: + type: array + items: + $ref: '#/components/schemas/NcgiTai' + minItems: 1 + description: List of NR cell Ids + taiList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + description: List of tracking area Ids + anyOf: + - required: [ ncgiList ] + - required: [ taiList ] + +NcgiTai: + description: List of NR cell ids, with their pertaining TAIs + type: object + properties: + tai: + $ref: '#/components/schemas/Tai' + cellList: + type: array + items: + $ref: '#/components/schemas/Ncgi' + minItems: 1 + description: List of List of NR cell ids + required: + - tai + - cellList + +MbsSession: + description: Individual MBS session + type: object + properties: + mbsSessionId: + $ref: '#/components/schemas/MbsSessionId' + tmgiAllocReq: + type: boolean + default: false + writeOnly: true + tmgi: + allOf: + - $ref: '#/components/schemas/Tmgi' + readOnly: true + expirationTime: + allOf: + - $ref: '#/components/schemas/DateTime' + readOnly: true + serviceType: + allOf: + - $ref: '#/components/schemas/MbsServiceType' + writeOnly: true + locationDependent: + type: boolean + default: false + areaSessionId: + allOf: + - $ref: '#/components/schemas/AreaSessionId' + readOnly: true + ingressTunAddrReq: + type: boolean + default: false + writeOnly: true + ingressTunAddr: + type: array + items: + $ref: '#/components/schemas/TunnelAddress' + minItems: 1 + readOnly: true + ssm: + allOf: + - $ref: '#/components/schemas/Ssm' + writeOnly: true + mbsServiceArea: +``` + +``` + + allOf: + - $ref: '#/components/schemas/MbsServiceArea' + writeOnly: true + extMbsServiceArea: + allOf: + - $ref: '#/components/schemas/ExternalMbsServiceArea' + writeOnly: true + redMbsServArea: + $ref: '#/components/schemas/MbsServiceArea' + readOnly: true + extRedMbsServArea: + $ref: '#/components/schemas/ExternalMbsServiceArea' + readOnly: true + dnn: + allOf: + - $ref: '#/components/schemas/Dnn' + writeOnly: true + snssai: + allOf: + - $ref: '#/components/schemas/SNSSAI' + writeOnly: true + activationTime: + deprecated: true + format: date-time + type: string + startTime: + $ref: '#/components/schemas/DateTime' + terminationTime: + $ref: '#/components/schemas/DateTime' + mbsServInfo: + $ref: '#/components/schemas/MbsServiceInfo' + mbsSessionSubsc: + $ref: '#/components/schemas/MbsSessionSubscription' + activityStatus: + $ref: '#/components/schemas/MbsSessionActivityStatus' + anyUeInd: + type: boolean + default: false + writeOnly: true + mbsFsaIdList: + type: array + items: + $ref: '#/components/schemas/MbsFsaId' + minItems: 1 + associatedSessionId: + $ref: '#/components/schemas/AssociatedSessionId' + required: + - serviceType + anyOf: + - required: [ mbsSessionId ] + - required: [ tmgiAllocReq ] + not: + required: [redMbsServArea, extRedMbsServArea] + +MbsSessionSubscription: + description: MBS session subscription + type: object + properties: + mbsSessionId: + $ref: '#/components/schemas/MbsSessionId' + areaSessionId: + $ref: '#/components/schemas/AreaSessionId' + eventList: + type: array + items: + $ref: '#/components/schemas/MbsSessionEvent' + minItems: 1 + notifyUri: + $ref: '#/components/schemas/Uri' + notifyCorrelationId: + type: string + expiryTime: + $ref: '#/components/schemas/DateTime' + nfcInstanceId: + $ref: '#/components/schemas/NfInstanceId' + mbsSessionSubscUri: + allOf: + +``` + +``` + - $ref: '#/components/schemas/Uri' + readOnly: true + required: + - eventList + - notifyUri + +MbsSessionEventReportList: + description: MBS session event report list + type: object + properties: + eventReportList: + type: array + items: + $ref: '#/components/schemas/MbsSessionEventReport' + minItems: 1 + notifyCorrelationId: + type: string + required: + - eventReportList + +MbsSessionEvent: + description: MBS session event + type: object + properties: + eventType: + $ref: '#/components/schemas/MbsSessionEventType' + required: + - eventType + +MbsSessionEventReport: + description: MBS session event report + type: object + properties: + eventType: + $ref: '#/components/schemas/MbsSessionEventType' + timeStamp: + $ref: '#/components/schemas/DateTime' + ingressTunAddrInfo: + $ref: '#/components/schemas/IngressTunAddrInfo' + broadcastDelStatus: + $ref: '#/components/schemas/BroadcastDeliveryStatus' + required: + - eventType + +ExternalMbsServiceArea: + description: List of geographic area or list of civic address info for MBS Service Area + type: object + properties: + geographicAreaList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + minItems: 1 + civicAddressList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress' + minItems: 1 + oneOf: + - required: [ geographicAreaList ] + - required: [ civicAddressList ] + +MbsSecurityContext: + description: MBS security context consisting of MSK/MTK(s) and associated IDs + type: object + properties: + keyList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key of MbsSecurityContext + type: object + additionalProperties: + $ref: '#/components/schemas/MbsKeyInfo' + minProperties: 1 + required: + - keyList +``` + +``` +MbsKeyInfo: + description: MBS Security Key Data Structure + type: object + properties: + keyDomainId: + $ref: '#/components/schemas/Bytes' + mskId: + $ref: '#/components/schemas/Bytes' + msk: + $ref: '#/components/schemas/Bytes' + mskLifetime: + $ref: '#/components/schemas/DateTime' + mtkId: + $ref: '#/components/schemas/Bytes' + mtk: + $ref: '#/components/schemas/Bytes' + required: + - keyDomainId + - mskId + +IngressTunAddrInfo: + description: Ingress Tunnel Address Information + type: object + properties: + ingressTunAddr: + type: array + items: + $ref: '#/components/schemas/TunnelAddress' + minItems: 1 + required: + - ingressTunAddr + +MbsServiceAreaInfo: + description: MBS Service Area Information for location dependent MBS session + type: object + properties: + areaSessionId: + $ref: '#/components/schemas/AreaSessionId' + mbsServiceArea: + $ref: '#/components/schemas/MbsServiceArea' + required: + - areaSessionId + - mbsService_area + +MbsServiceInfo: + description: Represent MBS Service Information. + type: object + properties: + mbsMediaComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MbsMediaCompRm' + minProperties: 1 + mbsSdfResPrio: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ReservPriority' + afAppId: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AfAppId' + mbsSessionAmbr: + $ref: '#/components/schemas/BitRate' + required: + - mbsMediaComps + +MbsMediaComp: + description: Represents an MBS Media Component. + type: object + properties: + mbsMedCompNum: + type: integer + mbsFlowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + mbsSdfResPrio: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ReservPriority' + mbsMediaInfo: +``` + +``` + $ref: '#/components/schemas/MbsMediaInfo' + qosRef: + type: string + mbsQoSReq: + $ref: '#/components/schemas/MbsQoSReq' + required: + - mbsMedCompNum + +MbsMediaCompRm: + description: > + This data type is defined in the same way as the MbsMediaComp data type, but with the + OpenAPI nullable property set to true. + anyOf: + - $ref: '#/components/schemas/MbsMediaComp' + - $ref: '#/components/schemas/NullValue' + +MbsQoSReq: + description: Represent MBS QoS requirements. + type: object + properties: + 5qi: + $ref: '#/components/schemas/5Qi' + guarBitRate: + $ref: '#/components/schemas/BitRate' + maxBitRate: + $ref: '#/components/schemas/BitRate' + averWindow: + $ref: '#/components/schemas/AverWindow' + reqMbsArp: + $ref: '#/components/schemas/Arp' + required: + - 5qi + +MbsMediaInfo: + description: Represent MBS Media Information. + type: object + properties: + mbsMedType: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MediaType' + maxReqMbsBwDl: + $ref: '#/components/schemas/BitRate' + minReqMbsBwDl: + $ref: '#/components/schemas/BitRate' + codecs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + +AssociatedSessionId: + description: an associated Session Id used in MOON + anyOf: + - $ref: '#/components/schemas/Ssm' + - type: string + +# Data Types related to Time Synchronization as defined in clause 5.10 +# + +# +# SIMPLE DATA TYPES +# +# + +# +# Enumerations +# +# + +SynchronizationState: + description: Indicates the Synchronization State. + anyOf: + - type: string + enum: + - LOCKED +``` + +- HOLDOVER +- FREERUN +- type: string +description: > +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. + +TimeSource: +description: Indicates the Time Source. +anyOf: + +- type: string +enum: +- SYNC\_E +- PTP +- GNSS +- ATOMIC\_CLOCK +- TERRESTRIAL\_RADIO +- SERIAL\_TIME\_CODE +- NTP +- HAND\_SET +- OTHER +- type: string +description: > +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. + +ClockQualityDetailLevel: +description: Indicates the Clock Quality Detail Level. +anyOf: + +- type: string +enum: +- CLOCK\_QUALITY\_METRICS +- ACCEPT\_INDICATION +- type: string +description: > +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. + +# +# STRUCTURED DATA TYPES +# + +ClockQualityAcceptanceCriterion: +description: Contains a Clock Quality Acceptance Criterion. +type: object +properties: +synchronizationState: +\$ref: '#/components/schemas/SynchronizationState' +clockQuality: +\$ref: '#/components/schemas/ClockQuality' +parentTimeSource: +\$ref: '#/components/schemas/TimeSource' + +ClockQuality: +description: Contains Clock Quality. +type: object +properties: +traceabilityToGnss: +type: boolean +traceabilityToUtc: +type: boolean +frequencyStability: +\$ref: '#/components/schemas/Uint16' +clockAccuracy: +type: string +pattern: '^[A-Fa-f0-9]{2}\$' + +# Data Types related to IMS SBA as defined in clause 5.11 +# + +# +# SIMPLE DATA TYPES +# + +``` + +# + +SessionId: + description: IMS Session Identifier + type: string + +MediaId: + description: IMS Media Flow Identifier + type: string + +MaxMessageSize: + description: Maximum SCTP user message size + type: integer + maximum: 64 + default: 64 + +# +# Enumerations +# +# +MediaResourceType: + description: Indicates the Media Resource type + anyOf: + - type: string + enum: + - DC + - AR + - AUDIO + - VIDEO + - type: string + +MediaProxy: + description: Media Proxy Configuration applicable to the media flow + anyOf: + - type: string + enum: + - HTTP + - UDP + - type: string + +SecuritySetup: + description: security setup of the DTLS connection + anyOf: + - type: string + enum: + - ACTIVE + - PASSIVE + - ACTPASS + - type: string + +# STRUCTURED DATA TYPES +# +DcEndPoint: + description: Endpoint for Data Channel + type: object + properties: + sctpPort: + type: integer + maximum: 65535 + minimum: 0 + description: Local or remote port for Data Channel + fingerprint: + type: string + pattern: '(SHA-1|SHA-224|SHA-256|SHA-384|SHA-512|MD5|MD2|TOKEN)\s[0-9A-F]{2}(:[0-9A-F] +{2})+' + description: local or remote certificate fingerprint for the DTLS association + tlsId: + type: string + pattern: '^[A-Fa-f0-9+/_-]{20,255}$' + description: local or remote TLS ID for the media stream + +DcStream: + description: Data Channel mapping and configuration information + type: object + properties: + streamId: + type: integer + +``` + +``` + maximum: 65535 + default: 0 + description: Stream identifier for Data Channel + subprotocol: + type: string + pattern: '^[A-Fa-f0-9]{20}$' + description: Subprotocol of the SCTP stream + order: + type: boolean + maxRetry: + type: integer + default: 0 + description: maximal number of the times a message will be retransmitted + maxTime: + type: integer + default: 0 + description: maximal lifetime in milliseconds after which a message will no longer be +transmitted or retransmitted + priority: + type: integer + default: 256 + description: priority of data channel relative to other data channels + appBindingInfo: + type: string + description: application binding information of the Data Channel. + +ReplaceHttpUrl: + description: replacement HTTP URL per stream + type: object + properties: + replaceHttpUrl: + $ref: '#/components/schemas/Uri' + streamId: + type: integer + maximum: 65535 + default: 0 + description: Stream identifier for Data Channel + +Endpoint: + description: Represents the IP endpoint. + type: object + required: + - ip + - transport + - portNumber + properties: + ip: + $ref: '#/components/schemas/IpAddr' + transport: + $ref: '#/components/schemas/TransportProtocol' + portNumber: + $ref: '#/components/schemas/UInteger' + +# +# HTTP responses +# + +responses: + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + 3gpp-Sbi-Target-Nf-Id: + description: 'Identifier of target NF (service) instance towards which the request is +redirected' + schema: + type: string +``` + +``` +'308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + 3gpp-Sbi-Target-Nf-Id: + description: > + 'Identifier of target NF (service) instance towards which the request is redirected' + schema: + type: string +'400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'405': + description: Method Not Allowed +'408': + description: Request Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'406': + description: 406 Not Acceptable +'409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'410': + description: Gone + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'411': + description: Length Required + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'412': + description: Precondition Failed + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'413': + description: Content Too Large + content: +``` + +``` + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'414': + description: URI Too Long + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'429': + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'501': + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'502': + description: Bad Gateway + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +'504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' +default: + description: Generic Error +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | CT4#80 | C4-175048 | | | | Initial Draft. | 0.1.0 | +| 2017-10 | CT4#80 | C4-175400 | | | | Skeleton and scope | 0.2.0 | +| 2017-12 | CT4#81 | C4-176442 | | | | After CT4#81 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181395 | | | | After CT4#82 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182440 | | | | After CT4#83 | 0.5.0 | +| 2018-04 | CT4#84 | C4-183521 | | | | After CT4#84 | 0.6.0 | +| 2018-05 | CT4#85 | C4-184635 | | | | After CT4#85 | 0.7.0 | +| 2018-06 | CT#80 | CP-181110 | | | | Presented for information and approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182065 | 0001 | | F | ProblemDetails | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0002 | | F | Structure of Amfld | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0012 | | B | DNAI change notification type | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0015 | | F | RatType | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0017 | | B | Definition of DNAI | 15.1.0 | +| 2018-09 | CT#81 | CP-182068 | 0008 | 1 | B | Add support for 5G Trace | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0010 | 1 | F | OpenAPI Corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0013 | 1 | B | Structure of ECGI and NCGI | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0007 | 1 | F | Averaging Window | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0020 | 1 | F | sd pattern | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0021 | 1 | F | Correction of the title of clauses 5.2.4.4 _LinksValueSchema and 5.2.4.5 _SelfLink | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0023 | | F | NAI format in 5G System | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0031 | | F | GroupId Definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0009 | 1 | F | Removal of systematic references to the "format" keyword in data type definitions | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0033 | | F | Naming Conventions | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0027 | 1 | F | 5GMMCause and NGAP Cause | 15.1.0 | +| 2018-09 | CT#81 | CP-182173 | 0006 | 3 | F | BackUp AMF Info | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0035 | | F | URI Scheme | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0024 | 2 | F | Cleanup of the specification | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0025 | 1 | F | Correction to Regular Expression Pattern of GPSI | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0005 | 4 | F | Common data types: NonDynamic5qi and Dynamic5qi | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0028 | 1 | F | Common data type used in both TS 29.505 and TS 29.519 | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0029 | 1 | B | n6 Traffic Routing Information data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0019 | 4 | F | DefaultQoSInformation | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0034 | 1 | F | Update of N3gaLocation data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0016 | 3 | F | Mobility Restriction | 15.1.0 | +| 2018-09 | CT#81 | CP-182042 | 0030 | 3 | F | Adding "nullable" property to OpenAPI definitions of data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182174 | 0026 | 3 | F | Presence Reporting Area | 15.1.0 | +| 2018-09 | CT#81 | CP-182011 | 0032 | 4 | F | Adding age of location, geographic information and other missing ones in the UserLocation type | 15.1.0 | +| 2018-09 | CT#81 | CP-182183 | 0036 | 1 | B | Common data type for data change notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182065 | 0037 | | F | API version number update | 15.1.0 | +| 2018-12 | CT#82 | CP-183024 | 0040 | | F | Application ID | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0049 | | F | Corrections to PDU Session Id, PDU Session Type and SupportedFeatures | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0038 | 1 | F | Area definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0047 | 1 | F | DNN | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0044 | 1 | F | Update of missing status code 429 in TS 29.571 | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0057 | 1 | F | 29571 CR cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0045 | 2 | F | The ARP in Default QoS | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0058 | 1 | F | Snsai pattern | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0039 | 1 | F | GroupId pattern | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0059 | | F | Adding of HTTP status code "406 Not Acceptable" | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0041 | 1 | F | VarUeld definition | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0061 | | F | ProblemDetails for 501 | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0063 | | F | ChangeItem alignment | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0046 | 2 | F | Regular Expression Patterns | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0048 | 3 | F | Alignments with NGAP | 15.2.0 | +| 2018-12 | CT#82 | CP-183168 | 0065 | 1 | F | Secondary RAT usage data reporting | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0060 | 1 | F | Data types associated with Subscribed and Authorized Default QoS for Default QoS Flow | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0042 | 3 | F | Alignment of pattern for data types with "nullable" property | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0062 | 1 | F | NF Group Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0053 | 2 | F | data type for complex query expression | 15.2.0 | +| 2018-12 | CT#82 | CP-183161 | 0064 | 2 | F | NgRanIdentifier and PresenceInfo | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0068 | | F | Addition of HTTP status code "412 Precondition Failed" | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0051 | 3 | F | Introduction of Barring of Roaming in 5GC | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0066 | 1 | F | Service Area Restriction | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183024 | 0067 | 1 | F | Charging related types | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0070 | | F | Correction of the reference for the SupportedFeatures Data Type | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0072 | 1 | F | Update open API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183024 | 0073 | | F | ExternalDoc update | 15.2.0 | +| 2019-03 | CT#83 | CP-190029 | 0075 | 3 | F | Corrections on subscribed Priority | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0076 | 1 | F | AmfRegionId and AmfSetId | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0077 | 2 | F | Supported features | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0078 | 2 | F | Corrections on n3iwf Id | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0079 | 2 | F | Corrections on the encoding of bit string | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0081 | 2 | F | Corrections on Type RouteToLocation | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0082 | 1 | F | ODB correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190029 | 0083 | | F | 3GPP TS 29.571 API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191041 | 0077 | 3 | F | CR not implemented – Supported Features | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0084 | 1 | F | Service Area Restriction | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0087 | 1 | F | Changeltem Indicating Complete Resource Creation or Removal | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0089 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0090 | 1 | F | Clarifcaiton on Universal Matching Pattern Schema | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0086 | 2 | F | Correct the discription of 5qi in SubscribedDefaultQos | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0097 | | F | AreaCode | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0094 | 1 | F | Required attributes in NotifyItem | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0095 | 1 | F | Regular Expression Pattern of DiameterIdentity | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0096 | 1 | F | Secondary RAT Usage reporting at PDU session level | 15.4.0 | +| 2019-06 | CT#84 | CP-191041 | 0099 | 2 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CT#84 | CP-191048 | 0100 | 1 | B | 3GPP TS 29.571 API version update | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0093 | | B | Definition of MTC provider Information | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0098 | 1 | B | Extend value of RAT Type to add NBLOT | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0088 | 3 | B | Common Data Type for ATSSS Capability | 16.0.0 | +| 2019-06 | CT#84 | CP-191052 | 0085 | 1 | B | Addition of Event Reporting Information Parameters for network data analytics | 16.0.0 | +| 2019-06 | CT#84 | CP-191055 | 0091 | 2 | B | NF discovery factors | 16.0.0 | +| 2019-09 | CT#85 | CP-192194 | 0102 | 3 | B | NF Set and NF Service Set | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0103 | | B | PlmnId | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0104 | 1 | B | Closed Access Group | 16.1.0 | +| 2019-09 | CT#85 | CP-192028 | 0113 | 2 | B | Network Identifier for SNPn | 16.1.0 | +| 2019-09 | CT#85 | CP-192211 | 0105 | 2 | B | Common Data Type for 5G SRVCC | 16.1.0 | +| 2019-09 | CT#85 | CP-192115 | 0107 | 1 | A | PRA ID encoding | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0108 | 1 | F | DNN Format correction | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0111 | 2 | B | PatchResult data type | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0116 | 3 | F | Extended PDU Session ID used in Core Network | 16.1.0 | +| 2019-09 | CT#85 | CP-192195 | 0121 | 2 | B | Small Data Rate Control Status | 16.1.0 | +| 2019-09 | CT#85 | CP-192130 | 0122 | 2 | B | Updates for 5WWC with HFC wireline access | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0124 | | F | 3GPP TS 29.571 API version update | 16.1.0 | +| 2019-09 | CT#85 | CP-192210 | 0125 | | F | Correction and alignment of Sampling Ratio | 16.1.0 | +| 2019-12 | CT#86 | CP-193032 | 0130 | | A | N3IWF ID encoding | 16.2.0 | +| 2019-12 | CT#86 | CP-193032 | 0138 | | A | Correction to GNbld | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0126 | 1 | B | Format of NF (Service) Set ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0142 | 1 | F | MAC Address as PEI format | 16.2.0 | +| 2019-12 | CT#86 | CP-193050 | 0143 | 1 | F | Alternative 1 for global uniqueness of universally managed NID - simple data types correction | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0135 | 2 | B | Definition of TNAP ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0131 | 1 | B | HAL-forms data type | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0127 | 3 | B | Delegated Discovery Parameters Conveyance in HTTP/2 headers | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0149 | | B | LTE-M RAT Type | 16.2.0 | +| 2019-12 | CT#86 | CP-193062 | 0148 | 1 | B | Common Data Type for RACS | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0161 | 1 | B | DNN Network Identifier and Operator Identifier | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0114 | 5 | B | Increasing the maximum MDBV value | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0160 | 1 | A | Wildcard DNN | 16.2.0 | +| 2019-12 | CT#86 | CP-193032 | 0163 | 1 | A | Correction to charging identifiers | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0156 | 2 | F | TAI and CGI in UserLocation | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0158 | 2 | B | Definition of HFC node Id and User Location information for HFC | 16.2.0 | +| 2019-12 | CT#86 | CP-193225 | 0159 | 3 | B | Wireline Service Area Restrictions | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0144 | 1 | B | Defining new data type for the Rate Control | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193049 | 0153 | 1 | B | Expected UE Behaviour parameters | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0150 | 2 | B | Adding support for NR and E-UTRA accessing through unlicensed bands | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0152 | 3 | B | PRA for LTE UE | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0154 | 3 | B | ACS information | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0136 | 4 | B | QoS for wireline access network | 16.2.0 | +| 2019-12 | CT#86 | CP-193046 | 0165 | | B | IPv4AddrMask | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0145 | 1 | B | InvalidParam Data Type | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0167 | | F | API version and External doc update | 16.2.0 | +| 2020-03 | CT#87E | CP-200032 | 0168 | 1 | C | NID | 16.3.0 | +| 2020-03 | CT#87E | CP-200020 | 0170 | 1 | F | Enumerations and "nullable" keyword | 16.3.0 | +| 2020-03 | CT#87E | CP-200032 | 0176 | 1 | F | CAG-ID size | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0172 | 2 | B | New RAT Type values for Non-3GPP accesses | 16.3.0 | +| 2020-03 | CT#87E | CP-200033 | 0180 | | B | External Group Identifier | 16.3.0 | +| 2020-03 | CT#87E | CP-200031 | 0182 | | B | Remove Unused MaPduCapability Data Type | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0185 | | B | HFC NODE ID | 16.3.0 | +| 2020-03 | CT#87E | CP-200133 | 0190 | 1 | B | CS/PS location | 16.3.0 | +| 2020-03 | CT#87E | CP-200018 | 0192 | | B | LCS service authorization | 16.3.0 | +| 2020-03 | CT#87E | CP-200033 | 0175 | 2 | F | Status type definition | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0194 | | B | SupiOrSuci | 16.3.0 | +| 2020-03 | CT#87E | CP-200020 | 0191 | 1 | F | Pattern of Ipv4AddrMask | 16.3.0 | +| 2020-03 | CT#87E | CP-200267 | 0183 | 3 | B | Common data types for V2X service | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0173 | 4 | B | User Location for wireliness and trusted non-3GPP accesses | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0174 | 3 | B | PEI for 5G-RG/FN-RG and for UEs not supporting any 3GPP access technologies | 16.3.0 | +| 2020-03 | CT#87E | CP-200035 | 0189 | 1 | B | SUPI definition for 5G-RG and FN-RG | 16.3.0 | +| 2020-03 | CT#87E | CP-200021 | 0188 | 1 | B | Remove the common data type Software Version Number | 16.3.0 | +| 2020-03 | CT#87E | CP-200181 | 0179 | 4 | B | Downlink data delivery status | 16.3.0 | +| 2020-03 | CT#87E | CP-200033 | 0181 | 2 | B | MO Exception Data Counter | 16.3.0 | +| 2020-03 | CT#87E | CP-200052 | 0195 | | F | API version and External doc update | 16.3.0 | +| 2020-06 | CT#88E | CP-201030 | 0198 | | F | HTTP redirection for indirect communication | 16.4.0 | +| 2020-06 | CT#88E | CP-201066 | 0201 | 1 | F | Clarification of NF Instance ID encoding | 16.4.0 | +| 2020-06 | CT#88E | CP-201067 | 0196 | 1 | B | MDT Configuration data for 5G g | 16.4.0 | +| 2020-06 | CT#88E | CP-201047 | 0202 | 1 | B | Authentication and Authorization status | 16.4.0 | +| 2020-06 | CT#88E | CP-201048 | 0203 | 1 | F | User Location of TWAP ID or TNAP ID | 16.4.0 | +| 2020-06 | CT#88E | CP-201034 | 0199 | 3 | F | Slice Differentiator Ranges and Wildcard | 16.4.0 | +| 2020-06 | CT#88E | CP-201048 | 0197 | 1 | F | User Location for W-5GBAN | 16.4.0 | +| 2020-06 | CT#88E | CP-201066 | 0205 | 1 | F | Correction on unsigned integer types | 16.4.0 | +| 2020-06 | CT#88E | CP-201045 | 0207 | 1 | F | Nid shall be present in data types of Tai/Ncgi/GlobalRanNodId in case of SNPn | 16.4.0 | +| 2020-06 | CT#88E | CP-201045 | 0206 | 2 | F | Identify for AMF in SNPn | 16.4.0 | +| 2020-06 | CT#88E | CP-201032 | 0208 | 1 | F | Revising the defination of LcsServiceAuth data type | 16.4.0 | +| 2020-06 | CT#88E | CP-201048 | 0209 | 1 | F | Extend GlobalRanNodId to Support W-AGF and TNGF | 16.4.0 | +| 2020-06 | CT#88E | CP-201034 | 0210 | 1 | F | Nullvalue and "nullable" keyword | 16.4.0 | +| 2020-06 | CT#88E | CP-201034 | 0222 | 1 | F | Editorial corrections | 16.4.0 | +| 2020-06 | CT#88E | CP-201034 | 0223 | 1 | F | Correct the data type in Pc5QosFlowItem | 16.4.0 | +| 2020-06 | CT#88E | CP-201034 | 0212 | 1 | F | NotifyItem | 16.4.0 | +| 2020-06 | CT#88E | CP-201044 | 0214 | 3 | B | UPF Supports RTT Measurements without PMF | 16.4.0 | +| 2020-06 | CT#88E | CP-201045 | 0227 | | F | Clarifications to TAI / ECGI / NCGI for SNPns | 16.4.0 | +| 2020-06 | CT#88E | | | | | Aligning "MO Exception data" handling with stage 2 - Data types | 16.4.0 | +| | | CP-201046 | 0225 | 1 | F | | | +| 2020-06 | CT#88E | CP-201048 | 0218 | 1 | F | Removal of RG-TMBR | 16.4.0 | +| 2020-06 | CT#88E | CP-201048 | 0219 | 1 | F | Update the RAT type definition | 16.4.0 | +| 2020-06 | CT#88E | CP-201048 | 0217 | 1 | F | Reference for RgWirelineCharacteristics | 16.4.0 | +| 2020-06 | CT#88E | CP-201066 | 0220 | | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88E | CP-201066 | 0221 | | F | Binary IE Encoding | 16.4.0 | +| 2020-06 | CT#88E | CP-201066 | 0226 | 1 | F | Correcting wrong reference | 16.4.0 | +| 2020-06 | CT#88E | CP-201073 | 0228 | | F | API version and External doc update | 16.4.0 | +| 2020-09 | CT#89E | CP-202107 | 0236 | 1 | F | Dynamic CN PDB | 16.5.0 | +| 2020-09 | CT#89E | CP-202100 | 0232 | 1 | F | Error corrections | 16.5.0 | +| 2020-09 | CT#89E | CP-202100 | 0234 | 1 | F | Additional PRA ID | 16.5.0 | +| 2020-09 | CT#89E | CP-202103 | 0233 | 1 | F | N5GC Location | 16.5.0 | +| 2020-09 | CT#89E | CP-202506 | 0231 | 1 | F | Ncgi typo correction | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89E | CP-202109 | 0229 | 1 | F | Adding missing Reference to SUPI definition | 16.5.0 | +| 2020-09 | CT#89E | CP-202096 | 0237 | | F | Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90E | CP-203035 | 0239 | | F | Removal of the reference to ETSI forge | 16.6.0 | +| 2020-12 | CT#90E | CP-203031 | 0240 | | F | Correction for implementation error 29.571 | 16.6.0 | +| 2020-12 | CT#90E | CP-203031 | 0243 | | F | Incomplete references and wrong table header | 16.6.0 | +| 2020-12 | CT#90E | CP-203039 | 0245 | | F | Alignment with TR-456 / TR-470 (BBF technical specifications) | 16.6.0 | +| 2020-12 | CT#90E | CP-203048 | 0241 | 1 | F | ssid typo in yaml | 16.6.0 | +| 2020-12 | CT#90E | CP-203031 | 0246 | 1 | F | MDT LTE Measurements | 16.6.0 | +| 2020-12 | CT#90E | CP-203068 | 0247 | 2 | F | MDT Parameters for NR | 16.6.0 | +| 2020-12 | CT#90E | CP-203036 | 0248 | | F | Rel-16 API version and External doc update | 16.6.0 | +| 2020-12 | CT#90E | CP-203061 | 0238 | 1 | F | Clarification to IPv6Prefix type | 17.0.0 | +| 2021-03 | CT#91E | CP-210037 | 0255 | | A | Error handling when the SCP fails to obtain an access token | 17.1.0 | +| 2021-03 | CT#91E | CP-210047 | 0254 | | A | NF Set ID and NF Service Set ID Definition for SNPN | 17.1.0 | +| 2021-03 | CT#91E | CP-210058 | 0256 | 1 | A | Corrections on MDT parameters | 17.1.0 | +| 2021-03 | CT#91E | CP-210034 | 0257 | 1 | F | OpenAPI Reference and description field for map data types | 17.1.0 | +| 2021-03 | CT#91E | CP-210021 | 0257 | 1 | F | ProblemDetails content in responses to PATCH requests | 17.1.0 | +| 2021-03 | CT#91E | CP-210021 | 0260 | | F | 29.571 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92E | CP-211027 | 0265 | | B | Non-3GPP TAI | 17.2.0 | +| 2021-06 | CT#92E | CP-211080 | 0267 | | A | TAI in EutraLocation | 17.2.0 | +| 2021-06 | CT#92E | CP-211036 | 0272 | 1 | B | Support of Mute Reporting | 17.2.0 | +| 2021-06 | CT#92E | CP-211059 | 0273 | 1 | A | RedirectResponse data type definition | 17.2.0 | +| 2021-06 | CT#92E | CP-211040 | 0258 | | B | Support for satellite access RAT types | 17.2.0 | +| 2021-06 | CT#92E | CP-211039 | 0268 | 2 | B | Add ProseServiceAuth | 17.2.0 | +| 2021-06 | CT#92E | CP-211036 | 0271 | 2 | B | Common Partitioning criteria added | 17.2.0 | +| 2021-06 | CT#92E | CP-211028 | 0262 | 1 | F | ChangelItem operation definition | 17.2.0 | +| 2021-06 | CT#92E | CP-211031 | 0269 | 1 | B | CS Address Information | 17.2.0 | +| 2021-06 | CT#92E | CP-211102 | 0274 | 1 | F | Remove double definition and cleanup of the OpenAPI part | 17.2.0 | +| 2021-06 | CT#92E | CP-211103 | 0278 | 1 | F | Additions of description in OpenAPI | 17.2.0 | +| 2021-06 | CT#92E | CP-211060 | 0280 | | A | Essential Correction to GeralLocation, LAC/RAC/SAC and Cell ID data types | 17.2.0 | +| 2021-06 | CT#92E | CP-211028 | 0281 | | B | EmptyObject definition | 17.2.0 | +| 2021-06 | CT#92E | CP-211048 | 0283 | 1 | B | Extention of userLocationInfo attribute to support GERAN/UTRAN access | 17.2.0 | +| 2021-06 | CT#92E | CP-211031 | 0284 | 1 | B | New NSAC related data types | 17.2.0 | +| 2021-06 | CT#92E | CP-211030 | 0277 | 1 | B | Definition of UE-slice-MBR | 17.2.0 | +| 2021-06 | CT#92E | CP-211034 | 0275 | | F | Home Network Identifier for SNPN | 17.2.0 | +| 2021-06 | CT#92E | CP-211050 | 0285 | | F | 29.571 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93E | CP-212054 | 0287 | 1 | F | Adding missing descriptions | 17.3.0 | +| 2021-09 | CT#93E | CP-212030 | 0289 | 2 | B | Clarification to SACInfo | 17.3.0 | +| 2021-09 | CT#93E | CP-212031 | 0290 | | B | Spatial Validity Condition | 17.3.0 | +| 2021-09 | CT#93E | CP-212035 | 0291 | 1 | B | Common Data Types for MBS | 17.3.0 | +| 2021-09 | CT#93E | CP-212030 | 0292 | | B | NSSRG value | 17.3.0 | +| 2021-09 | CT#93E | CP-212079 | 0295 | 2 | A | UE Transport Protocol Indication for N3GPP Location | 17.3.0 | +| 2021-09 | CT#93E | CP-212035 | 0296 | | B | ProseServiceAuth | 17.3.0 | +| 2021-09 | CT#93E | CP-212059 | 0298 | | F | 29.571 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94E | CP-213100 | 0302 | 1 | B | Provisioning Server Information | 17.4.0 | +| 2021-12 | CT#94E | CP-213097 | 0303 | 1 | B | Additional common data types for MBS | 17.4.0 | +| 2021-12 | CT#94E | CP-213097 | 0304 | 1 | B | NCGI list of MBS Service Area | 17.4.0 | +| 2021-12 | CT#94E | CP-213097 | 0305 | | B | Missing 502 response and description property in common data types for MBS | 17.4.0 | +| 2021-12 | CT#94E | CP-213199 | 0308 | 2 | F | Remove Siblings of \$ref attributes in OpenAPI | 17.4.0 | +| 2021-12 | CT#94E | CP-213108 | 0309 | | B | Common Data Types for SM Policy Association Establishment/Termination Events | 17.4.0 | +| 2021-12 | CT#94E | CP-213103 | 0310 | 1 | B | Update the RAT Type to support NR RedCap | 17.4.0 | +| 2021-12 | CT#94E | CP-213093 | 0311 | | F | Correction of Spatial Validity Condition | 17.4.0 | +| 2021-12 | CT#94E | CP-213124 | 0315 | | F | Extention of userLocationInfo attribute to support GERAN/UTRAN access | 17.4.0 | +| 2021-12 | CT#94E | CP-213092 | 0316 | | F | Immediate Report | 17.4.0 | +| 2021-12 | CT#94E | CP-213088 | 0319 | | A | SEPP Redirection | 17.4.0 | +| 2021-12 | CT#94E | CP-213137 | 0317 | | B | Adding EAS IP replacement information | 17.4.0 | +| 2021-12 | CT#94E | CP-213111 | 0312 | 1 | B | Common Data Type for Satellite Backhaul Category | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94E | CP-213088 | 0313 | 1 | A | SnssaiExtension data type definition | 17.4.0 | +| 2021-12 | CT#94E | CP-213121 | 0320 | | F | 29.571 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95E | CP-220047 | 0323 | 4 | F | SNPN impacts - new common type RoamingRestrictions | 17.5.0 | +| 2022-03 | CT#95E | CP-220023 | 0325 | | F | BitRate Units | 17.5.0 | +| 2022-03 | CT#95E | CP-220024 | 0326 | 2 | F | Fqdn data type definition | 17.5.0 | +| 2022-03 | CT#95E | CP-220023 | 0327 | | F | PatchItem definition | 17.5.0 | +| 2022-03 | CT#95E | CP-220306 | 0328 | 4 | F | PVS Info | 17.5.0 | +| 2022-03 | CT#95E | CP-220030 | 0329 | 1 | F | SACInfo in periodic notificatio | 17.5.0 | +| 2022-03 | CT#95E | CP-220025 | 0330 | 1 | F | Alignment of desription fields | 17.5.0 | +| 2022-03 | CT#95E | CP-220079 | 0332 | | A | Correction to wrong CR implementation | 17.5.0 | +| 2022-03 | CT#95E | CP-220035 | 0334 | 1 | F | MbsSession data type for MBS session creation response | 17.5.0 | +| 2022-03 | CT#95E | CP-220125 | 0335 | 2 | F | MBS Session Status subscriptions and notifications | 17.5.0 | +| 2022-03 | CT#95E | CP-220035 | 0336 | | B | Extensions for Location dependent MBS session | 17.5.0 | +| 2022-03 | CT#95E | CP-220035 | 0337 | 1 | F | MbsServiceArea data type extension | 17.5.0 | +| 2022-03 | CT#95E | CP-220025 | 0338 | 1 | F | Clarifications to the SupportedFeatures Type encoding | 17.5.0 | +| 2022-03 | CT#95E | CP-220066 | 0340 | | F | 29.571 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221024 | 0342 | 4 | F | MBS Security Context (MSK/MTK) Definitions | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0343 | 2 | F | Relay Service Code | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0344 | | F | MBS Frequency Selection Area Identifier | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0346 | | F | MBS Service Area Information for Location dependent MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-22103 | 0347 | | F | Broadcast Delivery Status event | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0348 | 1 | F | Ingress Tunnel Address Change Status Event | 17.6.0 | +| 2022-06 | CT#96 | CP-221036 | 0349 | | F | SUCI Regular Expression Pattern | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0350 | 4 | F | Applying the agreed formatting to the 'description' fields in A.2 | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0351 | | F | BitRate | 17.6.0 | +| 2022-06 | CT#96 | CP-221045 | 0352 | | F | Obsolete ChargingId Data Type | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0353 | 3 | F | Correction to the 'ingressTunAddr' type | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0354 | 3 | F | MNC Encoding in NfSetId and NfServiceSetId | 17.6.0 | +| 2022-06 | CT#96 | CP-221055 | 0355 | 5 | B | NSAG ID | 17.6.0 | +| 2022-06 | CT#96 | CP-221071 | 0361 | | F | Incomplete CR implementation for RouteToLocation | 17.6.0 | +| 2022-06 | CT#96 | CP-221034 | 0362 | 1 | B | FQDN Pattern Matching Rule | 17.6.0 | +| 2022-06 | CT#96 | CP-221051 | 0365 | | F | 29.571 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222031 | 0366 | 1 | F | Defining the MBS Service Requirements | 17.7.0 | +| 2022-09 | CT#97 | CP-222029 | 0368 | 1 | F | Spatial Validity Condition | 17.7.0 | +| 2022-09 | CT#97 | CP-222048 | 0369 | 1 | F | WLAN location information for interworking between ePDG connected to EPC and 5GS | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0370 | | F | PlmnIdNid conversion to string (e.g. when used in maps as key) | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0371 | 1 | F | Clarification on GUAMI List in BackupAmfInfo | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0372 | 1 | F | Clarification for the keyDomainId with SNPN | 17.7.0 | +| 2022-09 | CT#97 | CP-222214 | 0373 | 2 | F | 5GPRUK ID Common Data Type | 17.7.0 | +| 2022-09 | CT#97 | CP-222069 | 0375 | | F | Missing Reference RFC 7542 | 17.7.0 | +| 2022-09 | CT#97 | CP-222229 | 0376 | 1 | F | Correction of ECS Configuration Information | 17.7.0 | +| 2022-09 | CT#97 | CP-222031 | 0377 | 1 | F | Updates and corrections to the common MBS data model | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0378 | | F | 29.571 Rel-17 API version and External doc update | 17.7.0 | +| 2022-12 | CT#98 | CP-223036 | 0382 | | F | Corrections to MBS data types | 17.8.0 | +| 2022-12 | CT#98 | CP-223054 | 0384 | 2 | F | 5GPRUK Name Alignment | 17.8.0 | +| 2022-12 | CT#98 | CP-223066 | 0392 | | F | 29.571 Rel-17 API version and External doc update | 17.8.0 | +| 2022-12 | CT#98 | CP-223052 | 0380 | 1 | F | Clarificaiton on Usage of RedCap RAT Type | 18.0.0 | +| 2022-12 | CT#98 | CP-223029 | 0383 | 2 | F | Extending the problem details with supported API versions | 18.0.0 | +| 2022-12 | CT#98 | CP-223040 | 0385 | | F | Remove Uint16 and Uint16Rm | 18.0.0 | +| 2022-12 | CT#98 | CP-223040 | 0386 | 1 | F | Misspellings of array | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0391 | | F | 29.571 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230080 | 0396 | | A | PduSessionInfo | 18.1.0 | +| 2023-03 | CT#99 | CP-230033 | 0398 | | B | PLMN list in Spatial Validity Condition | 18.1.0 | +| 2023-03 | CT#99 | CP-230029 | 0407 | | F | Lower case of UUIDs in URIs | 18.1.0 | +| 2023-03 | CT#99 | CP-230036 | 0399 | 1 | B | Add associated session ID for MOCN | 18.1.0 | +| 2023-03 | CT#99 | CP-230041 | 0397 | 1 | B | Adding GEO satellite ID type | 18.1.0 | +| 2023-03 | CT#99 | CP-230041 | 0409 | 1 | B | Support of dynamic Satellite backhaul category | 18.1.0 | +| 2023-03 | CT#99 | CP-230081 | 0405 | 1 | A | Update ProseServiceAuth to support the authorization of UE-to-Network relay | 18.1.0 | +| 2023-03 | CT#99 | CP-230044 | 0401 | 2 | B | Metadata for Service Function Chain | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2023-03 | CT#99 | CP-230046 | 0402 | 1 | B | Manage Event Muting Impact on NFp | 18.1.0 | +| 2023-03 | CT#99 | CP-230049 | 0394 | 3 | F | Correcting \$ref in the MbsSession data type | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0410 | | F | 29.571 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231025 | 0412 | | F | SnsaiExtension | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 0415 | | B | Remove PLMN Ids in the Spatial Condition | 18.2.0 | +| 2023-06 | CT#100 | CP-231035 | 0416 | 1 | B | Packet Rate and Traffic Volume | 18.2.0 | +| 2023-06 | CT#100 | CP-231033 | 0413 | 2 | B | VPLMN Specific Offloading Information | 18.2.0 | +| 2023-06 | CT#100 | CP-231042 | 0422 | 2 | F | Support of multi-path transmission | 18.2.0 | +| 2023-06 | CT#100 | CP-231027 | 0419 | 1 | B | Correction on readonly definition | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 0417 | 2 | B | Support of Alternative S-NSSAI | 18.2.0 | +| 2023-06 | CT#100 | CP-231057 | 0420 | 1 | F | Support of PDU Set QoS Parameters | 18.2.0 | +| 2023-06 | CT#100 | CP-231048 | 0423 | 1 | B | Partially Allowed NSSAI | 18.2.0 | +| 2023-06 | CT#100 | CP-231028 | 0424 | | F | Correction of the interger data type | 18.2.0 | +| 2023-06 | CT#100 | CP-231047 | 0426 | 2 | B | Variable reporting periodicity | 18.2.0 | +| 2023-06 | CT#100 | CP-231042 | 0428 | | F | Update on Update on U2U relay capabilities and subscription | 18.2.0 | +| 2023-06 | CT#100 | CP-231052 | 0429 | 2 | B | Ranging Sidelink Positioning Subscription data | 18.2.0 | +| 2023-06 | CT#100 | CP-231069 | 0432 | 2 | F | Update on the format of NflnstanceId | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0434 | | F | 29.571 Rel-18 API version and External doc update | 18.2.0 | +| 2023-09 | CT#101 | CP-232040 | 0436 | | C | Common Time Sync Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0440 | 1 | F | Optionality of status attribute in SnsaiReplaceInfo | 18.3.0 | +| 2023-09 | CT#101 | CP-232054 | 0441 | 1 | B | PDU Set Integrated Handling Information | 18.3.0 | +| 2023-09 | CT#101 | CP-232065 | 0443 | 1 | F | Correct data type name MbsMediaComp | 18.3.0 | +| 2023-09 | CT#101 | CP-232037 | 0444 | 1 | B | Addition of flag within the SACInfo to indicate if the number of UEs reported are the ones with at least one PDU session/PDN connection | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0445 | 2 | B | Addition of the roaming requirements and Network Slice Replacement termination indication in SnsaiReplaceInfo | 18.3.0 | +| 2023-09 | CT#101 | CP-232045 | 0447 | 2 | B | Add CommonData to support IMS DC | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0448 | 2 | B | QoE Parameters | 18.3.0 | +| 2023-09 | CT#101 | CP-232046 | 0449 | | B | Common data types for A2X service | 18.3.0 | +| 2023-09 | CT#101 | CP-232057 | 0450 | 1 | F | Resolve EN for Multi-Path Transmission Term | 18.3.0 | +| 2023-09 | CT#101 | CP-232036 | 0452 | | B | Authorized Session-AMBR for Offloading | 18.3.0 | +| 2023-09 | CT#101 | CP-232058 | 0456 | 1 | F | RedirectResponse Update | 18.3.0 | +| 2023-09 | CT#101 | CP-232049 | 0457 | 2 | B | Update common data for Ranging Sidelink Positioning | 18.3.0 | +| 2023-09 | CT#101 | CP-232043 | 0458 | 1 | B | Slice usage control information | 18.3.0 | +| 2023-09 | CT#101 | CP-232156 | 0459 | 3 | F | Add on Group-Service-Id | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0460 | | F | 29.571 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233050 | 0465 | | B | Resolve Editor's note | 18.4.0 | +| 2023-12 | CT#102 | CP-233028 | 0462 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233064 | 0471 | 2 | B | Definition of NSAC Service Area. | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0463 | 1 | B | VPLMN offloading policy information | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0468 | 1 | F | String based Charging Id Support | 18.4.0 | +| 2023-12 | CT#102 | CP-233048 | 0464 | 1 | B | Update the DcStream to add application binding information | 18.4.0 | +| 2023-12 | CT#102 | CP-233055 | 0466 | 1 | F | Enhancement to support UE-to-UE relay | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0472 | | F | Time Source | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0474 | 1 | F | Reserved characters in JSON attributes defined as URI | 18.4.0 | +| 2023-12 | CT#102 | CP-233063 | 0477 | 1 | A | Area Session Policy ID | 18.4.0 | +| 2023-12 | CT#102 | CP-233063 | 0479 | 1 | A | MBS Service Area not contained within the MB-SMF service area | 18.4.0 | +| 2023-12 | CT#102 | CP-233054 | 0480 | | B | User Location Information of AUN3 device | 18.4.0 | +| 2023-12 | CT#102 | CP-233067 | 0482 | 2 | A | Preventing NR to LTE NTN mobility for users without LTE NTN subscription | 18.4.0 | +| 2023-12 | CT#102 | CP-233053 | 0483 | 5 | B | Protocol Description | 18.4.0 | +| 2023-12 | CT#102 | CP-233048 | 0484 | 1 | B | Add the Endpoint data type as common data for IMS SBA | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0486 | 1 | F | Case insensitive handling of DNN | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0487 | | F | Corrections on MbsKeyInfo and MbsQoSReq data types | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0488 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0489 | 3 | B | Extend nrLocation to include NR NTN TAI information | 18.4.0 | +| 2023-12 | CT#102 | CP-233038 | 0490 | 1 | F | Correction of attribute Ipv6AddressRanges | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0491 | | B | Addition of MBS parameters for QMC | 18.4.0 | +| 2023-12 | CT#102 | CP-233054 | 0492 | 1 | B | Service restriction of AUN3 device access 5GC via W-5GAN | 18.4.0 | +| 2023-12 | CT#102 | CP-233056 | 0493 | | F | Addition of missing descriptions of data types | 18.4.0 | +| 2023-12 | CT#102 | CP-233063 | 0495 | 2 | A | Correction of the external MBS Service Area descriptiona | 18.4.0 | +| 2023-12 | CT#102 | CP-233041 | 0497 | | F | New data type to represent a combination of S-NSSAI(s) and/or DNN(s) | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0498 | | F | 29.571 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/gsma/29_series/29576/raw.md b/gsma/29_series/29576/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4814e91752cb638a0e74d8d627377b09cfbbf84d --- /dev/null +++ b/gsma/29_series/29576/raw.md @@ -0,0 +1,1991 @@ + + +# 3GPP TS 29.576 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Messaging Framework Adaptor Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis + +Valbonne - FRANCE + +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members + +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners + +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|-------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| Introduction ..... | 7 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Services offered by the MFAF..... | 9 | +| 4.1 Introduction ..... | 9 | +| 4.2 Nmfaf_3daDataManagement Service ..... | 10 | +| 4.2.1 Service Description ..... | 10 | +| 4.2.1.1 Overview..... | 10 | +| 4.2.1.2 Service Architecture ..... | 10 | +| 4.2.1.3 Network Functions..... | 11 | +| 4.2.1.3.1 Messaging Framework Adaptor Function (MFAF) ..... | 11 | +| 4.2.1.3.2 NF Service Consumers..... | 11 | +| 4.2.2 Service Operations..... | 12 | +| 4.2.2.1 Introduction..... | 12 | +| 4.2.2.2 Nmfaf_3daDataManagement_Configure service operation ..... | 12 | +| 4.2.2.2.1 General ..... | 12 | +| 4.2.2.2.2 Initial configuration for mapping data or analytics..... | 12 | +| 4.2.2.2.3 Update the configuration of existing individual mapping data or analytics ..... | 13 | +| 4.2.2.3 Nmfaf_3daDataManagement_Deconfigure service operation ..... | 14 | +| 4.2.2.3.1 General ..... | 14 | +| 4.2.2.3.2 Stop mapping data or analytics ..... | 14 | +| 4.3 Nmfaf_3caDataManagement Service ..... | 15 | +| 4.3.1 Service Description ..... | 15 | +| 4.3.1.1 Overview..... | 15 | +| 4.3.1.2 Service Architecture ..... | 15 | +| 4.3.1.3 Network Functions..... | 16 | +| 4.3.1.3.1 Messaging Framework Adaptor Function (MFAF) ..... | 16 | +| 4.3.1.3.2 NF Service Consumers..... | 16 | +| 4.3.2 Service Operations..... | 16 | +| 4.3.2.1 Introduction..... | 16 | +| 4.3.2.2 Nmfaf_3caDataManagement_Fetch service operation..... | 17 | +| 4.3.2.2.1 General ..... | 17 | +| 4.3.2.2.2 Retrieve data or analytics from the MFAF..... | 17 | +| 4.3.2.2A Nmfaf_3caDataManagement_Subscribe service operation..... | 17 | +| 4.3.2.3 Nmfaf_3caDataManagement_Notify service operation ..... | 17 | +| 4.3.2.3.1 General ..... | 17 | +| 4.3.2.3.2 Notification about the subscribed data or analytics ..... | 18 | +| 5 API Definitions ..... | 19 | +| 5.1 Nmfaf_3daDataManagement Service API..... | 19 | +| 5.1.1 Introduction ..... | 19 | +| 5.1.2 Usage of HTTP..... | 19 | +| 5.1.2.1 General..... | 19 | +| 5.1.2.2 HTTP standard headers..... | 19 | +| 5.1.2.2.1 General ..... | 19 | +| 5.1.2.2.2 Content type ..... | 19 | +| 5.1.2.3 HTTP custom headers..... | 19 | +| 5.1.3 Resources..... | 20 | +| 5.1.3.1 Overview..... | 20 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 5.1.3.2 | Resource: MFAF Configurations..... | 20 | +| 5.1.3.2.1 | Description ..... | 20 | +| 5.1.3.2.2 | Resource Definition..... | 20 | +| 5.1.3.2.3 | Resource Standard Methods..... | 21 | +| 5.1.3.2.3.1 | POST ..... | 21 | +| 5.1.3.2.4 | Resource Custom Operations..... | 21 | +| 5.1.3.3 | Resource: Individual MFAF Configuration..... | 21 | +| 5.1.3.3.1 | Description ..... | 21 | +| 5.1.3.3.2 | Resource Definition..... | 21 | +| 5.1.3.3.3 | Resource Standard Methods..... | 22 | +| 5.1.3.3.3.1 | PUT..... | 22 | +| 5.1.3.3.3.2 | DELETE ..... | 23 | +| 5.1.4 | Custom Operations without associated resources ..... | 24 | +| 5.1.5 | Notifications ..... | 24 | +| 5.1.6 | Data Model ..... | 24 | +| 5.1.6.1 | General..... | 24 | +| 5.1.6.2 | Structured data types..... | 24 | +| 5.1.6.2.1 | Introduction ..... | 24 | +| 5.1.6.2.2 | Type: MfafConfiguration ..... | 25 | +| 5.1.6.2.3 | Type: MessageConfiguration ..... | 25 | +| 5.1.6.2.4 | Type: MfafNotiInfo..... | 26 | +| 5.1.6.3 | Simple data types and enumerations..... | 26 | +| 5.1.6.3.1 | Introduction ..... | 26 | +| 5.1.6.3.2 | Simple data types ..... | 26 | +| 5.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 26 | +| 5.1.6.5 | Binary data..... | 26 | +| 5.1.7 | Error Handling ..... | 26 | +| 5.1.7.1 | General..... | 26 | +| 5.1.7.2 | Protocol Errors ..... | 26 | +| 5.1.7.3 | Application Errors..... | 26 | +| 5.1.8 | Feature negotiation ..... | 27 | +| 5.1.9 | Security..... | 27 | +| 5.2 | Nmfaf_3caDataManagement Service API..... | 27 | +| 5.2.1 | Introduction ..... | 27 | +| 5.2.2 | Usage of HTTP..... | 28 | +| 5.2.2.1 | General..... | 28 | +| 5.2.2.2 | HTTP standard headers..... | 28 | +| 5.2.2.2.1 | General ..... | 28 | +| 5.2.2.2.2 | Content type ..... | 28 | +| 5.2.2.3 | HTTP custom headers..... | 28 | +| 5.2.3 | Resources..... | 28 | +| 5.2.4 | Custom Operations without associated resources ..... | 28 | +| 5.2.5 | Notifications ..... | 28 | +| 5.2.5.1 | General..... | 28 | +| 5.2.5.2 | MFAF Notification ..... | 29 | +| 5.2.5.2.1 | Description ..... | 29 | +| 5.2.5.2.2 | Target URI..... | 29 | +| 5.2.5.2.3 | Standard Methods..... | 29 | +| 5.2.5.2.3.1 | POST ..... | 29 | +| 5.2.5.3 | Fetch Notification ..... | 30 | +| 5.2.5.3.1 | Description ..... | 30 | +| 5.2.5.3.2 | Target URI..... | 30 | +| 5.2.5.3.3 | Standard Methods..... | 31 | +| 5.2.5.3.3.1 | POST ..... | 31 | +| 5.2.6 | Data Model ..... | 32 | +| 5.2.6.1 | General..... | 32 | +| 5.2.6.2 | Structured data types..... | 33 | +| 5.2.6.2.1 | Introduction ..... | 33 | +| 5.2.6.2.2 | Type: NmfafDataRetrievalNotification..... | 33 | +| 5.2.6.2.3 | Type: FetchInstruction ..... | 33 | +| 5.2.6.2.4 | Type: NmfafDataAnaNotification..... | 33 | +| 5.2.6.3 | Simple data types and enumerations..... | 34 | + +| | | | +|---------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 5.2.6.3.1 | Introduction ..... | 34 | +| 5.2.6.3.2 | Simple data types ..... | 34 | +| 5.2.6.4 | Data types describing alternative data types or combinations of data types ..... | 34 | +| 5.2.6.5 | Binary data ..... | 34 | +| 5.2.7 | Error Handling ..... | 34 | +| 5.2.7.1 | General ..... | 34 | +| 5.2.7.2 | Protocol Errors ..... | 34 | +| 5.2.7.3 | Application Errors ..... | 34 | +| 5.2.8 | Feature negotiation ..... | 34 | +| 5.2.9 | Security ..... | 34 | +| Annex A (normative): OpenAPI specification ..... | | 36 | +| A.1 | General ..... | 36 | +| A.2 | Nmfaf_3daDataManagement API ..... | 36 | +| A.3 | Nmfaf_3caDataManagement API ..... | 39 | +| Annex B (informative): Change history ..... | | 43 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- Introduction + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the MFAF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the MFAF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. The stage 2 definition and procedures of Messaging Framework Adaptation are contained in 3GPP TS 23.288 [14] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI 3.0.0 Specification", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services" +- [15] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". +- [16] Void. +- [17] Void. +- [18] Void. + +- [19] Void. +- [20] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [21] Void. +- [22] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [23] 3GPP TS 29.575: "5G System; 5G System; Analytics Data Repository Services; Stage 3". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|-----------------------------------------| +| AF | Application Function | +| AMF | Access and Mobility Management Function | +| DCCF | Data Collection Coordination Function | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NRF | Network Repository Function | +| NSSF | Network Slice Selection Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| SMF | Session Management Function | +| UDM | Unified Data Management | + +# --- 4 Services offered by the MFAF + +## 4.1 Introduction + +The Messaging Framework Adaptor Services are used for the Messaging Framework Adaptor Function (MFAF) to enable the 5GS to interact with the messaging framework using Nmfaf services. The MFAF offers to other NFs the following services: + +- Nmfaf\_3daDataManagement; and +- Nmfaf\_3caDataManagement. + +**Table 4.1-1: Service provided by MFAF** + +| Service Name | Description | Service Operations | Operation Semantics | Example Consumer(s) | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---------------------|-------------------------------------| +| Nmfaf_3daDataManagement | 3GPP DCCF Adaptor (3DA) Data Management Service enables the DCCF to convey to the messaging framework, information about the data the messaging framework will receive from a Data Source, formatting and processing instructions and the Data Consumer and notification endpoints. | Configure | Request / Response | DCCF, NWDAF | +| | | Deconfigure | Request / Response | DCCF, NWDAF | +| Nmfaf_3caDataManagement | 3GPP Consumer Adaptor (3CA) Data Management Service delivers data to each Data Consumer or notification endpoint after formatting and processing of data received by the messaging framework. | Notify | Subscribe / Notify | NWDAF, PCF, NSSF, AMF, SMF, NEF, AF | +| | | Fetch | Request / Response | NWDAF, PCF, NSSF, AMF, SMF, NEF, AF | + +NOTE: The services correspond to the Nmfaf\_3caDataManagement service and Nmfaf\_3daDataManagement service as defined in 3GPP TS 23.288 [14]. + +Table 4.1-2 summarizes the corresponding APIs defined for this specification. + +**Table 4.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|-------------------------|--------|---------------------------------|------------------------------|-------------------------|------------------------------------------| +| Nmfaf_3daDataManagement | 4.2 | API for Nmfaf_3daDataManagement | Nmfaf_3daDataManagement.yaml | nmfaf_3dadatamanagement | Annex A.2
Nmfaf_3daDataManagement API | +| Nmfaf_3caDataManagement | 4.3 | API for Nmfaf_3caDataManagement | Nmfaf_3caDataManagement.yaml | nmfaf_3cadatamanagement | Annex A.3
Nmfaf_3caDataManagement API | + +## 4.2 Nmfaf\_3daDataManagement Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Nmfaf\_3daDataManagement service as defined in 3GPP TS 23.288 [14], is provided by the Messaging Framework Adaptor Function (MFAF). + +This service: + +- allows NF consumers to configure or reconfigure the MFAF to map data or analytics received by the MFAF to out-bound notification endpoints; and +- allows NF consumers to reconfigure the MFAF to stop mapping data or analytics received by the MFAF to out-bound notification endpoints. + +#### 4.2.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. + +The Nmfaf\_3daDataManagement service is part of the Nmfaf service-based interface exhibited by the Messaging Framework Adaptor Function (MFAF). + +Known consumer of the Nmfaf\_3daDataManagement service is: + +- Data Collection Coordination Function (DCCF) + +![Figure 4.2.1.2-1: Reference Architecture for the Nmfaf_3daDataManagement Service; SBI representation](5e92d9e8e9ce204e405bff2367f88176_img.jpg) + +This diagram illustrates the Service Based Interface (SBI) representation of the reference architecture. At the top, a rectangular box labeled 'MFAF' contains an oval labeled 'Nmfaf'. A vertical line descends from the 'Nmfaf' oval, labeled 'Nmfaf\_3daDataManagement'. This line then splits into two parallel vertical lines that lead to two separate rectangular boxes at the bottom, labeled 'DCCF' and 'NWDAF' respectively. + +Figure 4.2.1.2-1: Reference Architecture for the Nmfaf\_3daDataManagement Service; SBI representation + +**Figure 4.2.1.2-1: Reference Architecture for the Nmfaf\_3daDataManagement Service; SBI representation** + +![Figure 4.2.1.2-2: Reference Architecture for the Nmfaf_3daDataManagement Service; reference point representation](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +This diagram illustrates the reference point representation of the reference architecture. At the top is a rectangular box labeled 'MFAF'. Two vertical lines descend from the bottom of this box to two separate rectangular boxes at the bottom, labeled 'DCCF' and 'NWDAF'. Each vertical line has a small horizontal tick mark near the bottom box, indicating a reference point. + +Figure 4.2.1.2-2: Reference Architecture for the Nmfaf\_3daDataManagement Service; reference point representation + +**Figure 4.2.1.2-2: Reference Architecture for the Nmfaf\_3daDataManagement Service; reference point representation** + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Messaging Framework Adaptor Function (MFAF) + +The Messaging Framework Adaptor Function (MFAF) provides the functionality to allow NF consumers to configure or reconfigure the behaviour of mapping data or analytics received by the MFAF to out-bound notification endpoints. + +##### 4.2.1.3.2 NF Service Consumers + +The Data Collection Coordination Function (DCCF) and the NWDAF support: + +- configuring the MFAF to map data or analytics received by the MFAF to out-bound notification endpoints and to format and process the out-bound data or analytics; and +- reconfiguring the MFAF to stop the sending of data to consumers. + +### 4.2.2 Service Operations + +#### 4.2.2.1 Introduction + +**Table 4.2.2.1-1: Operations of the Nmfaf\_3daDataManagement Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| Nmfaf_3daDataManagement_Configure | This service operation is used by an NF to configure or reconfigure the MFAF to map data or analytics received by the MFAF to out-bound notification endpoints and to format and process the outbound data or analytics | NF service consumer (DCCF) | +| Nmfaf_3daDataManagement_Deconfigure | This service operation is used by an NF to stop mapping data or analytics received by the MFAF to one or more outbound notification endpoints. | NF service consumer (DCCF) | + +#### 4.2.2.2 Nmfaf\_3daDataManagement\_Configure service operation + +##### 4.2.2.2.1 General + +The Nmfaf\_3daDataManagement\_Configure service operation is used by an NF service consumer to configure or update the configuration of the MFAF for mapping data or analytics received by the MFAF to out-bound notification endpoints, and formatting and processing the out-bound data or analytics. + +##### 4.2.2.2.2 Initial configuration for mapping data or analytics + +Figure 4.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. DCCF) sends a request to the MFAF to request the configuration of mapping data or analytics (as shown in 3GPP TS 23.288 [14]). + +![Sequence diagram showing the interaction between an NF service consumer and the MFAF. The NF service consumer sends a POST request to the MFAF, and the MFAF responds with a 201 Created status.](5a95b187de0044da69b7322e04761b86_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant MFAF as MFAF + Note left of NF: + Note right of MFAF: + NF->>MFAF: 1. POST .../configurations + MFAF-->>NF: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and the MFAF. The NF service consumer sends a POST request to the MFAF, and the MFAF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: NF service consumer create the configuration** + +The NF service consumer shall invoke the Nmfaf\_3daDataManagement\_Configure service operation to create the configuration(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nmfaf-3dadatamanagement//configurations" as Resource URI representing the "MFAF Configurations", as shown in figure 4.2.2.2.2-1, step 1, to create a configuration for an "Individual MFAF Configuration" according to the information in message body. The MfafConfiguration data structure provided in the request body + +shall include: + +- a description of the configurations as "messageConfigurations" attribute that, for each configuration, the MessageConfiguration data type shall include + - 1) a notification URI of Data Consumer or Analytics Consumer or other endpoint where to receive the requested mapping data or analytics as "notificationURI" attribute; and + - 2)- if the configuration is used for mapping analytics or data collection, a Notification Correlation ID for the Data or Analytics Consumer (or other endpoint) as "correId" attribute; + +and may include: + +- 1) the formatting instructions as "formatStruct" attribute; +- 2) the processing instructions as "procIntruct" attribute or "multiProcInstructs" attribute if the "MultiProcessingInstruction" feature is supported; +- 3) the MFAF notification information to identify the Event Notifications received from the NWDAF or Data Source NF (e.g. AMF, SMF), which can be sent to the consumer or other notification endpoints, as "mfafNotiInfo" attribute; +- 4) NF instance identifier of the ADRF as "adrId" attribute; and +- x) the notification endpoints within the "notifEndpoints" attribute, if the "DataAnaCollect" feature is supported. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nmfaf-3datamanagement//configurations" as Resource URI and MfafConfiguration data structure as request body, the MFAF shall: + +- create a new configuration; +- assign a transaction reference id; +- if no MFAF notification information has been provided in the request, determine the MFAF notification information and add it to the configuration that is created and will be returned to the NF service consumer; +- store the configuration. + +If the MFAF created an "Individual MFAF Configuration" resource, the MFAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.2.2.2.2-1, step 2. + +If an error occurs when processing the HTTP POST request, the MFAF shall send an HTTP error response as specified in clause 5.1.7. + +##### 4.2.2.2.3 Update the configuration of existing individual mapping data or analytics + +Figure 4.2.2.2.3-1 shows a scenario where the NF service consumer sends a request to the MFAF to update the configuration of mapping data or analytics (as shown in 3GPP TS 23.288 [14]) + +![Sequence diagram showing the interaction between an NF service consumer and an MFAF to update a configuration. The consumer sends a PUT request to the MFAF. The MFAF responds with either a 200 OK or a 204 No Content.](2e399449b7f62d40167a65ca88888917_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant MFAF + Note right of NF service consumer: 1. PUT .../configurations/{transRefId} + NF service consumer->>MFAF: Request + Note right of MFAF: 2a. "200 OK" or + Note right of MFAF: 2b. "204 No Content" + MFAF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and an MFAF to update a configuration. The consumer sends a PUT request to the MFAF. The MFAF responds with either a 200 OK or a 204 No Content. + +**Figure 4.2.2.2.3-1: NF service consumer updates configuration** + +The NF service consumer shall invoke the Nmfaf\_3daDataManagement\_Configure service operation to update the configuration(s). The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nmfaf-3datamanagement//configurations/{transRefId}" as Resource URI representing the "Individual MFAF Configuration", as shown in figure 4.2.2.2.3-1, step 1, to update the subscription for an "Individual MFAF Configuration" resource identified by the {transRefId}. The MfafConfiguration data structure provided in the request body shall include: + +- a description of the configurations as "messageConfigurations" attribute that, for each configuration, the MfafConfiguration data structure provided in the request body shall include the same contents as described in 4.2.2.2.2. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nmfaf-3datamanagement//configurations/{transRefId}" as Resource URI and MfafConfiguration data structure as request body, the MFAF shall: + +- update the configuration of corresponding transaction reference Id; and +- store the configuration. + +If the MFAF successfully processed and accepted the received HTTP PUT request, the MFAF shall update an "Individual MFAF Configuration" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated configuration, as shown in figure 4.2.2.2.3-1, step 2a. or +- b) HTTP "204 No Content" status code, as shown in figure 4.2.2.2.3-1, step 2b. + +If an error occurs when processing the HTTP PUT request, the MFAF shall send an HTTP error response as specified in clause 5.1.7. + +If the MFAF determines the received HTTP PUT request needs to be redirected, the MFAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 4.2.2.3 Nmfaf\_3daDataManagement\_Deconfigure service operation + +##### 4.2.2.3.1 General + +The Nmfaf\_3daDataManagement\_Deconfigure service operation is used by an NF service consumer to stop mapping data or analytics received by the MFAF to one or more out-bound notification endpoints. + +##### 4.2.2.3.2 Stop mapping data or analytics + +Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the MFAF to update the configuration to stop mapping data or analytics (as shown in 3GPP TS 23.288 [14]) + +![Sequence diagram showing the interaction between an NF service consumer and the MFAF. Step 1: The consumer sends a DELETE request to the MFAF. Step 2: The MFAF responds with a 204 No Content status code.](a6cf7c02a60c336e0934b5ea40e35b49_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant MFAF + Note left of NF service consumer: + Note right of MFAF: + NF service consumer->>MFAF: 1. DELETE .../configurations/{transRefId} + MFAF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the interaction between an NF service consumer and the MFAF. Step 1: The consumer sends a DELETE request to the MFAF. Step 2: The MFAF responds with a 204 No Content status code. + +Figure 4.2.2.3.2-1: NF service consumer stops mapping data or analytics + +The NF service consumer shall invoke the Nmfaf\_3daDataManagement\_Deconfigure service operation to stop the MFAF to map data or analytics. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nmfaf-3datamanagement//configurations/{transRefId}" as Resource URI, where {transRefId} represents the "Individual MFAF Configuration" to be deleted, as shown in figure 4.2.2.3.2-1, step 1. + +Upon the reception of an HTTP DELETE request and if the MFAF successfully processed and accepted the received HTTP DELETE request from the NF service consumer, the MFAF shall acknowledge the request by sending a "204 No + +Content" response to the NF service consumer, as shown in figure 4.2.2.3.2-1, step 2. Further, the MFAF shall remove the individual resource linked to the delete request. + +If errors occur when processing the HTTP DELETE request, the MFAF shall send an HTTP error response as specified in clause 5.1.7. + +If the MFAF determines the received HTTP DELETE request needs to be redirected, the MFAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +## 4.3 Nmfaf\_3caDataManagement Service + +### 4.3.1 Service Description + +#### 4.3.1.1 Overview + +The Nmfaf\_3caDataManagement service as defined in 3GPP TS 23.288 [14], is provided by the Messaging Framework Adaptor Function (MFAF). + +This service: + +- allows NF consumers to collect the data or analytics from the MFAF. + +#### 4.3.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture is defined in 3GPP TS 23.288 [14]. + +The Nmfaf\_3caDataManagement service is part of the Nmfaf service-based interface exhibited by the Messaging Framework Adaptor Function (MFAF). + +Known consumers of the Nmfaf\_3caDataManagement service are: + +- Network Data Analytics Function (NWDAF) +- Policy Control Function (PCF) +- Network Slice Selection Function (NSSF) +- Access and Mobility Management Function (AMF) +- Session Management Function (SMF) +- Network Exposure Function (NEF) +- Application Function (AF) + +![Reference Architecture for the Nmfaf_3caDataManagement Service; SBI representation](9e1c95ee7eb045977f18f011f49520c7_img.jpg) + +The diagram illustrates the service architecture for the Nmfaf\_3caDataManagement service. At the top, a rectangular box labeled 'MFAF' contains an oval labeled 'Nmfaf'. A vertical line descends from the 'Nmfaf' oval to a horizontal line labeled 'Nmfaf\_3caDataManagement'. From this horizontal line, seven vertical lines descend to a row of seven rectangular boxes, each representing a network function (NF) consumer. These boxes are labeled from left to right: 'NWDAF', 'PCF', 'NSSF', 'AMF', 'SMF', 'NEF', and 'AF'. + +Reference Architecture for the Nmfaf\_3caDataManagement Service; SBI representation + +**Figure 4.3.1.2-1: Reference Architecture for the Nmfaf\_3caDataManagement Service; SBI representation** + +![Reference Architecture for the Nmfaf_3caDataManagement Service. The diagram shows a central box labeled 'MFAF' at the top, with seven lines branching down to seven separate boxes arranged horizontally below it. These boxes are labeled from left to right: 'NWD AF', 'PCF', 'NSSF', 'AMF', 'SMF', 'NEF', and 'AF'.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` + +graph TD + MFAF[MFAF] --> NWD[NWD AF] + MFAF --> PCF[PCF] + MFAF --> NSSF[NSSF] + MFAF --> AMF[AMF] + MFAF --> SMF[SMF] + MFAF --> NEF[NEF] + MFAF --> AF[AF] + +``` + +Reference Architecture for the Nmfaf\_3caDataManagement Service. The diagram shows a central box labeled 'MFAF' at the top, with seven lines branching down to seven separate boxes arranged horizontally below it. These boxes are labeled from left to right: 'NWD AF', 'PCF', 'NSSF', 'AMF', 'SMF', 'NEF', and 'AF'. + +**Figure 4.3.1.2-2: Reference Architecture for the Nmfaf\_3caDataManagement Service; reference point representation** + +#### 4.3.1.3 Network Functions + +##### 4.3.1.3.1 Messaging Framework Adaptor Function (MFAF) + +The Messaging Framework Adaptor Function (MFAF) provides the functionality to supply data or analytics, or an indication of availability of data or analytics to notification endpoints configured in Nmfaf\_3caDataManagement service as described in clause 4.2.1. + +##### 4.3.1.3.2 NF Service Consumers + +The NWD AF, PCF, NSSF, AMF, SMF, NEF, and AF: + +- supports retrieving data or analytics from the MFAF. + +The MFAF: + +- supports providing data or analytics or notification of availability of data or analytics to notification endpoints. + +### 4.3.2 Service Operations + +#### 4.3.2.1 Introduction + +**Table 4.3.2.1-1: Operations of the Nmfaf\_3caDataManagement Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------| +| Nmfaf_3caDataManagement_Fetch | This service operation is used by an NF to retrieve stored data or analytics from the MFAF. | NF service consumer (NWD AF, PCF, NSSF, AMF, SMF, NEF and AF) | +| Nmfaf_3caDataManagement_Subscribe | This is a pseudo operation, the actual subscription is created via Nmfaf_3daDataManagement Service. (NOTE) | | +| Nmfaf_3caDataManagement_Notify | This service operation is used by an NF with either data or analytics to provide data or analytics or notification of availability of data or analytics to notification endpoints. | MFAF | + +NOTE: In the current release OpenAPI 3.0.0 is adopted, with OpenAPI 3.0.0 it is not possible to document a stand-alone callback operation, thus the Notify operation has to be defined in combination with a Subscribe operation. + +NOTE: Nmfaf\_3caDataManagement\_Subscribe service operation is not used by any NF service consumers in this release. + +#### 4.3.2.2 Nmfaf\_3caDataManagement\_Fetch service operation + +##### 4.3.2.2.1 General + +The Nmfaf\_3caDataManagement\_Fetch service operation allows consumer to retrieve data or analytics from the MFAF as indicated by Nmfaf\_3caDataManagement\_Notify Fetch Instruction. + +##### 4.3.2.2.2 Retrieve data or analytics from the MFAF + +Figure 4.3.2.2.2-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the MFAF to retrieve the data or analytics as indicated by Nmfaf\_3caDataManagement\_Notify Fetch Instruction. + +![Sequence diagram showing the interaction between an NF service consumer and an MFAF. The consumer sends a POST {fetchUri} request to the MFAF, and the MFAF responds with a 200 OK.](43837b056625d3d6ce615e4c02f163bb_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant MFAF + Note left of NF service consumer: + NF service consumer->>MFAF: 1. POST {fetchUri} + Note right of MFAF: + MFAF-->>NF service consumer: 2. 200 OK + Note left of NF service consumer: +``` + +Sequence diagram showing the interaction between an NF service consumer and an MFAF. The consumer sends a POST {fetchUri} request to the MFAF, and the MFAF responds with a 200 OK. + +**Figure 4.3.2.2.2-1: NF service consumer retrieve data or analytics from the MFAF** + +The NF service consumer shall invoke the Nmfaf\_3caDataManagement\_Fetch service operation to retrieve stored data or analytics. The NF service consumer shall send an HTTP POST request to the URI "{fetchUri}" which was previously provided by the MFAF within a FetchInstruction data structure in an MFAF notification, as shown in figure 4.3.2.2.2-1, step 1, to fetch data or analytics from the MFAF. + +The request body shall include fetch correlation identifiers, which were also previously provided by the MFAF in the "fetchCorrIds" attribute within a FetchInstruction data structure in an MFAF notification. + +Upon the reception of the HTTP POST request, the MFAF shall: + +- find the data or analytics according to the requested parameters. + +If the requested data is found, the MFAF shall respond with "200 OK" status code with the message body containing the NmfafDataAnaNotification data structure. The NmfafDataAnaNotification data structure in the response body shall include one of the following: + +- information about network data analytics function events that occurred in the "anaNotifications" attribute; +- data collected from data sources (e.g. SMF, NEF) in the "dataNotif" attribute. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.2.7. + +If the MFAF determines the received HTTP POST request needs to be redirected, the MFAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +#### 4.3.2.2A Nmfaf\_3caDataManagement\_Subscribe service operation + +This is a pseudo operation, the MFAF does not actually provide Subscribe service operation through Nmfaf\_3caDataManagement service. The actual subscription is created via Nmfaf\_3caDataManagement Service. + +#### 4.3.2.3 Nmfaf\_3caDataManagement\_Notify service operation + +##### 4.3.2.3.1 General + +The Nmfaf\_3caDataManagement\_Notify service operation provides data or analytics or notification of availability of data or analytics to notification endpoints. + +##### 4.3.2.3.2 Notification about the subscribed data or analytics + +Figure 4.3.2.3.2-1 shows a scenario where the MFAF sends a request to the NF service consumer to notify it about data or analytics or fetch instructions. + +The subscription corresponding to the notification is created by the service consumer via Nmfaf\_3daDataManagement Service Operation. + +![Sequence diagram showing the notification process between the NF service consumer and the MFAF.](8592a32c2fdf17c1e562f0ba6b7e8e1a_img.jpg) + +``` +sequenceDiagram + participant MFAF + participant NF_service_consumer as NF service consumer + Note right of MFAF: 1. POST {notificationURI} + MFAF->>NF_service_consumer: + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer->>MFAF: +``` + +The diagram illustrates a sequence of two messages between the MFAF and the NF service consumer. The first message, labeled '1. POST {notificationURI}', is sent from the MFAF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the MFAF. + +Sequence diagram showing the notification process between the NF service consumer and the MFAF. + +**Figure 4.3.2.3.2-1: MFAF notifies the NF service consumer about subscribed data or analytics or fetch instructions** + +The MFAF shall invoke the Nmfaf\_3caDataManagement\_Notify service operation to notify about subscribed data or analytics, or notification about the availability of data or analytics. The MFAF shall send an HTTP POST request to the "{notificationURI}" received in the subscription (see clause 5.2.5 for the definition of this notificationURI), as shown in figure 4.3.2.3.2-1, step 1. The NmfafDataRetrievalNotification data structure provided in the request body shall include: + +- notification correlation Id within the "correlId" attribute; +- and shall include one of the following: +- fetch instructions indicate whether the data or analytics are to be fetched by the Consumer in the "fetchInstruction" attribute; + - information about the MFAF data or analytics in the "dataAnaNotif" attribute, which contains one of the following: + - information about network data analytics function events that occurred in the "anaNotifications" attribute; + - data collected from data sources (e.g. SMF, NEF) in the "dataNotif" attribute. + +Upon the reception of an HTTP POST request with "{notificationURI}" as Resource URI and NmfafDataRetrievalNotification data structure as request body, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall: + +- store the notification; +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.2.7. + +If the NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +After the successful processing of the HTTP POST request, if the MFAF requests the NF service consumer to retrieve the data or analytics with the "fetchInstruct" attribute, the NF service consumer may invoke the Nmfaf\_3caDataManagement\_Fetch service operation to retrieve the notified data or analytics as defined in clause 4.3.2.2. + +# 5 API Definitions + +## 5.1 Nmfaf\_3daDataManagement Service API + +### 5.1.1 Introduction + +The Nmfaf\_3daDataManagement Service shall use the Nmfaf\_3daDataManagement API. + +The API URI of the Nmfaf\_3daDataManagement API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmfaf-3dadatamanagement". +- The shall be "v1". +- The shall be set as described in clause 5.1.3. + +### 5.1.2 Usage of HTTP + +#### 5.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmfaf\_3daDataManagement API is contained in Annex A. + +#### 5.1.2.2 HTTP standard headers + +##### 5.1.2.2.1 General + +See clause 5.1.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.1.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 5.1.3 Resources + +#### 5.1.3.1 Overview + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.1.3.1-1 depicts the resource URIs structure for the Nmfaf\_3daDataManagement API. + +![Diagram showing the hierarchical structure of resource URIs for the Nmfaf_3daDataManagement API. The root is {apiRoot}/nmfaf_3dadatamanagement/. A line branches down to a box containing /configurations. From this box, another line branches down to a box containing /{transRefId}.](e636d7ccca0ad14c6b95201404324823_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nmfaf_3dadatamanagement/"] --> Configs["/configurations"] + Configs --> TransRefId["/{transRefId}"] + +``` + +Diagram showing the hierarchical structure of resource URIs for the Nmfaf\_3daDataManagement API. The root is {apiRoot}/nmfaf\_3dadatamanagement/. A line branches down to a box containing /configurations. From this box, another line branches down to a box containing /{transRefId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nmfaf\_3daDataManagement API** + +Table 5.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.1.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------| +| MFAF Configurations | /configurations | POST | Creates a new individual MFAF Configuration resource. | +| Individual MFAF Configuration | /configurations/{transRefId} | PUT | Modifies an existing Individual MFAF Configuration subresource. | +| | | DELETE | Deletes an Individual MFAF Configuration identified by subresource {transRefId}. | + +#### 5.1.3.2 Resource: MFAF Configurations + +##### 5.1.3.2.1 Description + +The MFAF Configurations resource represents all configuration to the Nmfaf\_3daDataManagement Service at a given MFAF. The resource allows an NF service consumer to create a new Individual MFAF Configuration resource. + +##### 5.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nmfaf-3dadatamanagement//configurations + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.2.2-1. + +**Table 5.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +##### 5.1.3.2.3 Resource Standard Methods + +###### 5.1.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.2.3.1-1. + +**Table 5.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.2.3.1-2 and the response data structures and response codes specified in table 5.1.3.2.3.1-3. + +**Table 5.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------| +| MfafConfiguration | M | 1 | Create a new Individual MFAF Configuration resource. | + +**Table 5.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------| +| MfafConfiguration | M | 1 | 201
Created | The creation of an Individual MFAF Configuration resource is confirmed and a representation of that resource is returned. | +| NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +**Table 5.1.3.2.3.1-4: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmfaf-3dadatamanagement//configurations/{transRefId} | + +##### 5.1.3.2.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.3 Resource: Individual MFAF Configuration + +##### 5.1.3.2.1 Description + +The Individual MFAF Configurations resource represents an individual configuration created in the MFAF and associated with transaction reference Id. + +##### 5.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nmfaf-3dadatamanagement//configurations/{transRefId} + +The shall be set as described in clause 5.1.1. + +This resource shall support the resource URI variables defined in table 5.1.3.3.2-1. + +**Table 5.1.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|-------------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1 | +| transReflId | string | Unique identifier of the individual MFAF Configurations resource. | + +##### 5.1.3.3.3 Resource Standard Methods + +###### 5.1.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.1.3.3.3.1-1. + +**Table 5.1.3.3.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.1-2 and the response data structures and response codes specified in table 5.1.3.3.3.1-3. + +**Table 5.1.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|---------------------------------| +| MfafConfiguration | M | 1 | The updated MFAF Configuration. | + +**Table 5.1.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------| +| MfafConfiguration | M | 1 | 200 OK | The update of an Individual MFAF Configuration resource is confirmed and a representation of that resource is returned. | +| n/a | | | 204 No Content | Successful case: The Individual MFAF Configuration resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource modification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.1-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MFAF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.1-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MFAF (service) instance towards which the request is redirected. | + +###### 5.1.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.3.3.2-1. + +**Table 5.1.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.1.3.3.3.2-2 and the response data structures and response codes specified in table 5.1.3.3.3.2-3. + +**Table 5.1.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case: The Individual MFAF Configuration resource matching the transRefId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during resource deletion
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during resource deletion
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.1.3.3.3.2-4: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MFAF (service) instance towards which the request is redirected. | + +**Table 5.1.3.3.3.2-5: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI of the resource located in an alternative NF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target MFAF (service) instance towards which the request is redirected. | + +### 5.1.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.1.5 Notifications + +None in this release of the specification. + +### 5.1.6 Data Model + +#### 5.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.1.6.1-1 specifies the data types defined for the Nmfaf\_3daDataManagement service based interface protocol. + +**Table 5.1.6.1-1: Nmfaf\_3daDataManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|----------------------------------------|---------------| +| MfafConfiguration | 5.1.6.2.2 | The description of MFAF configuration | | +| MessageConfiguration | 5.1.6.2.3 | The description of the configurations. | | +| MfafNotifInfo | 5.1.6.2.4 | The MFAF notification information. | | + +Table 5.1.6.1-2 specifies data types re-used by the Nmfaf\_3daDataManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmfaf\_3daDataManagement service based interface. + +**Table 5.1.6.1-2: Nmfaf\_3daDataManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-----------------------|---------------------|----------------------------------------------------------------------------------------|----------------| +| FormattingInstruction | 3GPP TS 29.574 [15] | Contains data or analytics formatting Instructions. | | +| NotifyEndpoint | 3GPP TS 29.574 [15] | The information of notification endpoint. | DataAnaCollect | +| ProcessingInstruction | 3GPP TS 29.574 [15] | Contains instructions related to the processing | | +| SupportedFeatures | 3GPP TS 29.571 [22] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| Uri | 3GPP TS 29.571 [22] | URI. | | + +#### 5.1.6.2 Structured data types + +##### 5.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.1.6.2.2 Type: MfafConfiguration + +Table 5.1.6.2.2-1: Definition of type MfafConfiguration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|------------------------------|---|-------------|--------------------------------------------------------------|---------------| +| messageConfigurations | array(Message Configuration) | M | 1..N | The configuration of the MFAF for mapping data or analytics. | | + +##### 5.1.6.2.3 Type: MessageConfiguration + +Table 5.1.6.2.3-1: Definition of type MessageConfiguration + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| correlId | string | M | 1 | If the configuration is used for mapping analytics or data collection, representing the Analytics Consumer Notification Correlation ID or Data Consumer Notification Correlation ID. | | +| formatInstruct | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event notifications. | | +| mfafNotifInfo | MfafNotifInfo | C | 0..1 | The MFAF notification information. It shall be provided in a response message if it had not been provided in the respective request message. | | +| notificationURI | Uri | M | 1 | The notification URI of Data Consumer or Analytics Consumer or other endpoint where to receive the requested mapping data or analytics | | +| notifEndpoints | array(NotifyEndpoint) | O | 1..N | The additional information of notification target address and correlation identifier. | DataAnaCollect | +| procInstruct | ProcessingInstruction | O | 0..1 | Processing instructions to be used for sending event notifications. (NOTE 1) | | +| multiProcInstructs | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications. (NOTE 1) | MultiProcessingInstruction | +| adrId | NfInstanceId | O | 0..1 | NF instance identifier of the ADRF in which data and analytics can be stored. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.1.8. (NOTE 2) | | + +NOTE 1: The "multiProcInstructs" attribute shall be used instead of the "procInstruct" attribute when the "MultiProcessingInstruction" feature is supported. + +NOTE 2 It shall be present in the POST request if at least one feature defined in clause 5.1.8 is supported, and it shall be present in the POST response if the NF service consumer includes the "suppFeat" attribute in the POST request. + +##### 5.1.6.2.4 Type: MfafNotifInfo + +Table 5.1.6.2.4-1: Definition of type MfafNotifInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------|---------------| +| mfafNotifUri | Uri | M | 1 | The notification URI of MFAF Notification Target Address. | | +| mfafCorreId | string | M | 1 | The MFAF Notification Correlation ID | | + +#### 5.1.6.3 Simple data types and enumerations + +##### 5.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 5.1.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +Table 5.1.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.1.6.4 Data types describing alternative data types or combinations of data types + +None in current specification. + +#### 5.1.6.5 Binary data + +None in current specification. + +### 5.1.7 Error Handling + +#### 5.1.7.1 General + +For the Nmfaf\_3daDataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.1.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.1.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmfaf\_3daDataManagement API. + +#### 5.1.7.2 Protocol Errors + +No specific procedures for the Nmfaf\_3daDataManagement service are specified. + +#### 5.1.7.3 Application Errors + +The application errors defined for the Nmfaf\_3daDataManagement service are listed in Table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nmfaf\_3daDataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|-----------------------------------------------------------------------------------| +| 1 | MultiProcessingInstruction | Indicates the support of multiple processing instructions. | +| 2 | DataAnaCollect | This feature indicates support for the enhancement of data and analytics process. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmfaf\_3daDataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmfaf\_3daDataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmfaf\_3daDataManagement service. + +The Nmfaf\_3daDataManagement API defines a single scope "nmfaf\_3dadatamanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.2 Nmfaf\_3caDataManagement Service API + +### 5.2.1 Introduction + +The Nmfaf\_3caDataManagement Service shall use the Nmfaf\_3caDataManagement API. + +The API URI of the Nmfaf\_3caDataManagement API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmfaf-3cadatamanagement". +- The shall be "v1". +- The shall be set as described in clause 5.2.3. + +### 5.2.2 Usage of HTTP + +#### 5.2.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmfaf\_3caDataManagement API is contained in Annex A. + +#### 5.2.2.2 HTTP standard headers + +##### 5.2.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 5.2.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 5.2.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be applicable. + +### 5.2.3 Resources + +There are no resources defined for this API in this release of the specification. + +### 5.2.4 Custom Operations without associated resources + +There are no custom operations without associated resources defined for this API in this release of the specification. + +### 5.2.5 Notifications + +#### 5.2.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 5.2.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|---------------------------------|---------------------------------------------------| +| MFAF Notification | {notificationURI}
(NOTE) | POST | Report one or several observed data or analytics. | +| Fetch Notification | {fetchUri} | POST | Fetch one or several notified data or analytics. | +| NOTE: The notificationURI is not provided by NF service consumer via Nmfaf-3caDataManagement API, it is provided via Nmfaf-3daDataManagement API during the configuration for mapping data or analytics. | | | | + +#### 5.2.5.2 MFAF Notification + +##### 5.2.5.2.1 Description + +The MFAF Notification is used by the MFAF to provide data or analytics or notification of availability of data or analytics to notification endpoints. + +##### 5.2.5.2.2 Target URI + +The Callback URI "{notificationURI}" shall be used with the callback URI variables defined in table 5.2.5.2.2-1. + +**Table 5.2.5.2.2-1: Callback URI variables** + +| Name | Definition | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationURI | The notification URI of Data Consumer or Analytics Consumer or other endpoint where to receive the requested data or analytics. The notificationURI is not provided by NF service consumer via Nmfaf-3caDataManagement API, it is provided via Nmfaf-3daDataManagement API during the configuration for mapping data or analytics. | + +##### 5.2.5.2.3 Standard Methods + +###### 5.2.5.2.3.1 POST + +This method shall support the request data structures specified in table 5.2.5.2.3.1-1 and the response data structures and response codes specified in table 5.2.5.2.3.1-2. + +**Table 5.2.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| NmfafDataRetrievalNotification | M | 1 | The data or analytics or notification of availability of data or analytics to notification endpoints. | + +**Table 5.2.5.2.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------| +| n/a | | | 204 No Content | The MFAF notification is treated successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the retrieval notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the retrieval notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.5.2.3.1-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +**Table 5.2.5.2.3.1-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification is redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +#### 5.2.5.3 Fetch Notification + +##### 5.2.5.3.1 Description + +The Fetch Notification is used by the NF service consumer to retrieve data or analytics from the MFAF. + +##### 5.2.5.3.2 Target URI + +The Callback URI "{fetchUri}" shall be used with the callback URI variables defined in table 5.2.5.3.2-1. + +**Table 5.2.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fetchUri | Uri | Fetch Uri as assigned during the procedure of notification about the subscribed data or analytics within the FetchInstruction data type (see table 5.2.6.2.3-1). | + +##### 5.2.5.3.3 Standard Methods + +###### 5.2.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.5.3.3.1-1. + +**Table 5.2.5.3.3.1-1: URI query parameters supported by the POST method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 5.2.5.3.3.1-2 and the response data structures and response codes specified in table 5.2.5.3.3.1-3. + +**Table 5.2.5.3.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-----------------------------------------------| +| array(string) | M | 1..N | Indicate the fetch correlation identifier(s). | + +**Table 5.2.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------| +| NmfaDataAnaNotification | M | 1 | 200 OK | The stored data or analytics related to the fetch correlation identifier(s). | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection, during the retrieval notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection, during the retrieval notification.
(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +**Table 5.2.5.3.3.1-4: Headers supported by the by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +**Table 5.2.5.3.3.1-5: Headers supported by the 308 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | Contains an alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

For the case where the notification is redirected to the same target via a different SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF service consumer (service) instance towards which the notification request is redirected. | + +### 5.2.6 Data Model + +#### 5.2.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.2.6.1-1 specifies the data types defined for the Nmfaf\_3caDataManagement service based interface protocol. + +**Table 5.2.6.1-1: Nmfaf\_3caDataManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------------|----------------|-------------------------------------------------------------------------------------------------------|---------------| +| FetchInstruction | 5.2.6.2.3 | The fetch instruction indicates whether the data or analytics are to be fetched by the Consumer. | | +| NmfafDataAnaNotification | 5.2.6.2.4 | MFAF data or analytics. | | +| NmfafDataRetrievalNotification | 5.2.6.2.2 | The data or analytics or notification of availability of data or analytics to notification endpoints. | | + +Table 5.2.6.1-2 specifies data types re-used by the Nmfaf\_3caDataManagement service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmfaf\_3caDataManagement service based interface. + +**Table 5.2.6.1-2: Nmfaf\_3caDataManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|--------------------------------------|---------------------|-------------------------------------------------------------------------------------|---------------| +| DataNotification | 3GPP TS 29.575 [23] | Represents a data subscription notification of one of various possible data sources | | +| DateTime | 3GPP TS 29.571 [22] | Identifies a specific time. | | +| NnwdafEventsSubscriptionNotification | 3GPP TS 29.520 [20] | Represents an NWDAF analytics subscription notification. | | +| Uri | 3GPP TS 29.571 [22] | URI. | | + +#### 5.2.6.2 Structured data types + +##### 5.2.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 5.2.6.2.2 Type: NmfaDataRetrievalNotification + +**Table 5.2.6.2.2-1: Definition of type NmfaDataRetrievalNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| correlId | string | M | 1 | Represents the Analytics Consumer Notification Correlation ID or Data Consumer Notification Correlation ID. It shall be set to the same value as the "correlId" attribute of MessageConfiguration data type. | | +| dataAnaNotif | NmfaDataAnaNotification | C | 0..1 | Represents notifications of analytics and data. (NOTE) | | +| fetchInstruction | FetchInstruction | C | 0..1 | The fetch instruction indicate whether the data or analytics are to be fetched by the Consumer. (NOTE) | | + +NOTE: Exactly one of the "dataAnaNotif" and "fetchInstruction" shall be included. + +##### 5.2.6.2.3 Type: FetchInstruction + +**Table 5.2.6.2.3-1: Definition of type FetchInstruction** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| fetchUri | Uri | M | 1 | The target address used by a data or analytics consumer to fetch the data or analytics. | | +| fetchCorrIds | array(string) | M | 1..N | The fetch correlation identifier(s) of the MFAF Data or Analytics | | +| expiry | DateTime | O | 0..1 | Indicates an expiration time, i.e. a deadline to fetch the data. | | + +##### 5.2.6.2.4 Type: NmfaDataAnaNotification + +**Table 5.2.6.2.4-1: Definition of type NmfaDataAnaNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------------------------|---|-------------|--------------------------------------------------------|---------------| +| anaNotifications | array(NnwdafeventsSubscriptionNotification) | C | 1..N | List of analytics subscription notifications. (NOTE 1) | | +| dataNotif | DataNotification | C | 0..1 | Data subscription notification. (NOTE 1) | | + +NOTE 1: Exactly one of these attributes shall be provided. +NOTE 2: If the MFAF has received the notifications from another source without a timestamp, then the MFAF adds itself a timestamp based on the time it received the notification in "timeStampGen" attribute contained in dataNotification attribute within the EventNotification data type in the NnwdafeventsSubscriptionNotification data type. + +#### 5.2.6.3 Simple data types and enumerations + +##### 5.2.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 5.2.6.3.2 Simple data types + +None in this release of the specification. + +#### 5.2.6.4 Data types describing alternative data types or combinations of data types + +None in this release of the specification. + +#### 5.2.6.5 Binary data + +None in this release of the specification. + +### 5.2.7 Error Handling + +#### 5.2.7.1 General + +For the Nmfa\_3caDataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nmfa\_3caDataManagement API. + +#### 5.2.7.2 Protocol Errors + +No specific procedures for the Nmfa\_3caDataManagement service are specified. + +#### 5.2.7.3 Application Errors + +The application errors defined for the Nmfa\_3caDataManagement service are listed in Table 5.2.7.3-1. + +**Table 5.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 5.2.8 Feature negotiation + +The optional features in table 5.2.8-1 are defined for the Nmfa\_3caDataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 5.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 5.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nmfa\_3caDataManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the + +"Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nmfaf\_3caDataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nmfaf\_3caDataManagement service. + +The Nmfaf\_3caDataManagement API defines a single scope "nmfaf\_3cadatamanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI 3.0.0 specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see 3GPP TS 29.501 [5] clause 5.3.1 and 3GPP TR 21.900 [7] clause 5B). + +## A.2 Nmfa\_3daDataManagement API + +``` +openapi: 3.0.0 +info: + version: 1.1.0-alpha.2 + title: Nmfa_3daDataManagement + description: | + MFAF 3GPP DCCF Adaptor (3DA) Data Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + externalDocs: + description: 3GPP TS 29.576 V18.1.0; 5G System; Messaging Framework Adaptor Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/' +servers: +- url: '{apiRoot}/nmfaf-3dadatamanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. +security: +- oAuth2ClientCredentials: +- nmfaf-3dadatamanagement +- {} +paths: + /configurations: + post: + summary: Creates a new Individual MFAF Configuration resource. + operationId: CreateMFAFConfiguration + tags: + - MFAF Configuration(Collection) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MfafConfiguration' + required: true + description: > + Contains the information for the creation of a new Individual MFAF + Configuration resource. + responses: + '201': + description: Successful creation of new Individual MFAF Configuration resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nmfaf-3dadatamanagement/{apiVersion}/configurations/{transRefId} +``` + +``` + + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/MfafConfiguration' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/configurations/{transRefId}: + put: + summary: Updates an existing Individual MFAF Configuration resource. + operationId: UpdateMFAFConfiguration + tags: + - Individual MFAF Configuration (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MfafConfiguration' + parameters: + - name: transRefId + in: path + description: Unique identifier of the individual MFAF Configurations resource. + required: true + schema: + type: string + responses: + '200': + description: The updated MFAF Configuration resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MfafConfiguration' + '204': + description: The Individual MFAF Configuration resource was modified successfully. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes an existing Individual MFAF Configuration resource. + operationId: DeleteMFAFConfiguration + tags: + - Individual MFAF Configuration (Document) + parameters: + - name: transRefId + in: path + description: Unique identifier of the individual MFAF Configurations resource. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual MFAF Configuration resource matching + the transRefId was deleted. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmfaf-3dadatamanagement: Access to the nmfaf-3dadatamanagement API +schemas: + MfafConfiguration: + description: Represents an Individual MFAF Configuration. + type: object + required: + - messageConfigurations + properties: + messageConfigurations: + type: array + items: + $ref: '#/components/schemas/MessageConfiguration' + minItems: 1 + description: The configuration of the MFAF for mapping data or analytics. + MessageConfiguration: + description: Represents the message configuration. + type: object + required: + - notificationURI + - correId +``` + +``` + +properties: + correId: + type: string + description: > + If the configuration is used for mapping analytics or data collection, + representing the Analytics Consumer Notification Correlation ID or + Data Consumer Notification Correlation ID. + formatInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction' + mmafNotiInfo: + $ref: '#/components/schemas/MmafNotiInfo' + notificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifEndpoints: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifyEndpoint' + minItems: 1 + description: The information of notification endpoints. + procInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' + multiProcInstructs: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +MmafNotiInfo: + description: > + The MFAF notification information. It shall be provided in a response message + if it had not been provided in the respective request message. + type: object + required: + - mmafNotifUri + - mmafCorreId + properties: + mmafNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mmafCorreId: + type: string + +``` + +## A.3 Nmmaf\_3caDataManagement API + +openapi: 3.0.0 + +``` + +info: + version: 1.1.0-alpha.2 + title: Nmmaf_3caDataManagement + description: | + MFAF 3GPP Consumer Adaptor (3CA) Data Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.576 V18.2.0; 5G System; Messaging Framework Adaptor Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/' + +servers: + - url: '{apiRoot}/nmmaf-3cadatamanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - oAuth2ClientCredentials: + - nmmaf-3cadatamanagement + - {} + +paths: + /mfaf-data-analytics: + +``` + +``` +post: +# This is a pseudo operation, clients shall NOT invoke this method! +requestBody: + required: true + content: + application/json: + # Unspecified schema for the JSON body, since this is used by neither the NF service +consumer nor the MFAF. + schema: {} +responses: + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + Notification: + '{notificationURI}': + # The URI in {notificationURI} is obtained out of band by the MFAF, i.e. it is provided via +the Nmmaf-3daDataManagement API during the configuration for mapping data or analytics. +post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NmmafDataRetrievalNotification' + responses: + '204': + description: The receipt of the Notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + Fetch: + '{request.body#/fetchInstruction/fetchUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: string + minItems: 1 + description: Indicate the fetch correlation identifier. + responses: + '200': + description: Expected response to a valid request. + content: + application/json: + schema: + $ref: '#/components/schemas/NmmafDataAnaNotification' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' +``` + +``` + + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmfaf-3cadatamanagement: Access to the nmfaf-3cadatamanagement API + +schemas: + NmfafDataRetrievalNotification: + description: > + Represents the data or analytics or notification of availability of data or analytics + to notification endpoints. + type: object + required: + - correId + oneOf: + - required: [dataAnaNotif] + - required: [fetchInstruction] + properties: + correId: + type: string + description: > + Represents the Analytics Consumer Notification Correlation ID + or Data Consumer Notification Correlation ID. It shall be set to the same + value as the "correId" attribute of MessageConfiguration data type. + dataAnaNotif: + $ref: '#/components/schemas/NmfafDataAnaNotification' + fetchInstruction: + $ref: '#/components/schemas/FetchInstruction' + +FetchInstruction: + description: > + The fetch instructions indicate whether the data or analytics are to be fetched by the + consumer. + type: object + required: + - fetchUri + - fetchCorrIds + properties: + fetchUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + fetchCorrIds: + type: array + items: + type: string + minItems: 1 + description: The fetch correlation identifier(s) of the MFAF Data or Analytics. + +``` + +``` + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +NmfaDataAnaNotification: + description: MFAF data or analytics. + type: object + oneOf: + - required: [anaNotifications] + - required: [dataNotif] + properties: + anaNotifications: + type: array + items: + $ref: + 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscriptionNotification' + minItems: 1 + description: List of analytics subscription notifications. + dataNotif: + $ref: 'TS29575_NadrF_DataManagement.yaml#/components/schemas/DataNotification' +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2021-06 | CT3#116e | | | | | TS skeleton of Messaging Framework Adaptor Services specification | 0.0.0 | | +| 2021-06 | CT3#116e | C3-213502 | | | | Inclusion of documents agreed in CT3#116e C3-213377. | 0.1.0 | | +| 2021-08 | CT3#117e | C3-214580 | | | | Inclusion of documents agreed in CT3#117e C3-214479, C3-214358, C3-214359, C3-214360, C3-214361, C3-214362, C3-214363 and C3-214480. | 0.2.0 | | +| 2021-11 | CT3#119e | C3-216522 | | | | Inclusion of documents agreed in CT3#119e C3-216422, C3-216423, C3-216441, C3-216465, C3-216467. | 0.3.0 | | +| 2022-01 | CT3#119bis-e | C3-220455 | | | | Inclusion of documents agreed in CT3#119bis-e C3-220294, C3-220464, C3-220319, C3-220504, C3-220321, C3-220505. | 0.4.0 | | +| 2022-02 | CT3#120e | C3-221516 | | | | Inclusion of documents agreed in CT3#120e C3-221289, C3-221299, C3-221424, C3-221602, C3-221603, C3-221604, C3-221605. | 0.5.0 | | +| 2022-03 | CT#95e | CP-220161 | | | | Presentation to TSG CT for approval | 1.0.0 | | +| 2022-03 | CT#95e | CP-220161 | | | | Approved by TSG CT | 17.0.0 | | +| 2022-06 | CT#96 | CP-221132 | 0001 | 1 | F | Adding 3XX and error response handling support for MFAF services | 17.1.0 | | +| 2022-06 | CT#96 | CP-221132 | 0002 | 1 | F | Corrections in the MFAF 3caDataManagement API | 17.1.0 | | +| 2022-06 | CT#96 | CP-221129 | 0003 | | F | Correct the Cardinality and Presence of some attributes | 17.1.0 | | +| 2022-06 | CT#96 | CP-221132 | 0004 | 1 | B | Support carrying ADRF ID in Nmfaf_3daDataManagement_Configure service operation | 17.1.0 | | +| 2022-06 | CT#96 | CP-221129 | 0005 | | F | Nmfaf_3daDataManagement API corrections | 17.1.0 | | +| 2022-06 | CT#96 | CP-221131 | 0006 | 1 | F | Nmfaf_3caDataManagement API corrections | 17.1.0 | | +| 2022-06 | CT#96 | CP-221130 | 0007 | | F | Handling of the redirection responses | 17.1.0 | | +| 2022-06 | CT#96 | CP-221134 | 0009 | 2 | F | Correction on DataNotification type | 17.1.0 | | +| 2022-06 | CT#96 | CP-221133 | 0011 | | F | Removing UDM from the list of MFAF service consumers | 17.1.0 | | +| 2022-06 | CT#96 | CP-221135 | 0012 | 1 | F | Update inputs of Nmfaf_3caDataManagement_Notify service | 17.1.0 | | +| 2022-06 | CT#96 | CP-221134 | 0014 | | F | Correction to MFAF notification information | 17.1.0 | | +| 2022-06 | CT#96 | CP-221134 | 0015 | | F | add CEF and OAM as consumers of Ndcf_DataManagement Service | 17.1.0 | | +| 2022-06 | CT#96 | CP-221134 | 0016 | | F | update of Abbreviations | 17.1.0 | | +| 2022-06 | CT#96 | CP-221155 | 0018 | 1 | F | Update the apiVersion placeholder | 17.1.0 | | +| 2022-06 | CT#96 | CP-221152 | 0019 | | F | Update of info and externalDocs fields | 17.1.0 | | +| 2022-09 | CT#97e | CP-222104 | 0021 | 2 | F | Add expiry attribute to the fetch instructions | 17.2.0 | | +| 2022-09 | CT#97e | CP-222104 | 0022 | 1 | F | Corrections related to callback functions in MFAF | 17.2.0 | | +| 2022-09 | CT#97e | CP-222104 | 0023 | 1 | F | Add NWDAF hosting DCCF as consumer of the Nmfaf_3daDataManagement service | 17.2.0 | | +| 2022-09 | CT#97e | CP-222101 | 0024 | | F | Clean up References | 17.2.0 | | +| 2022-09 | CT#97e | CP-222101 | 0025 | | F | Corrections related to NmfafDataRetrievalNotification data type | 17.2.0 | | +| 2022-09 | CT#97e | CP-222101 | 0026 | | F | Corrections to Fetch Notification | 17.2.0 | | +| 2022-09 | CT#97e | CP-222102 | 0028 | 1 | F | Miscellaneous corrections | 17.2.0 | | +| 2022-09 | CT#97e | CP-222101 | 0029 | | F | Corrections to NF service consumer | 17.2.0 | | +| 2022-09 | CT#97e | CP-222121 | 0030 | | F | Update of info and externalDocs fields | 17.2.0 | | +| 2022-12 | CT#98e | CP-223172 | 0034 | | F | Correcting procedure description for dataNotif attribute | 17.3.0 | | +| 2022-12 | CT#98e | CP-223172 | 0036 | | F | Corrections to data type in POST header | 17.3.0 | | +| 2022-12 | CT#98e | CP-223237 | 0037 | 1 | F | The time stamp of data and analytics notification | 17.3.0 | | +| 2022-12 | CT#98e | CP-223188 | 0041 | | F | Update of info and externalDocs fields | 17.3.0 | | +| 2022-12 | CT#98e | CP-223191 | 0031 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | | +| 2022-12 | CT#98e | CP-223176 | 0035 | 1 | F | Correction of data type of procInstr | 18.0.0 | | +| 2022-12 | CT#98e | CP-223190 | 0040 | | F | Update of info and externalDocs fields | 18.0.0 | | +| 2023-03 | CT#99 | CP-230149 | 0042 | 1 | F | Handling of fetch Instruction | 18.1.0 | | +| 2023-03 | CT#99 | CP-230148 | 0044 | | B | Support of multiple notification endpoints | 18.1.0 | | +| 2023-03 | CT#99 | CP-230162 | 0045 | | F | Update of info and externalDocs fields | 18.1.0 | | +| 2023-06 | CT#100 | CP-231131 | 0046 | 1 | F | Corrections to the dummy POST based operation of the Nmfaf_3caDataManagement API | 18.2.0 | | +| 2023-06 | CT#100 | CP-231132 | 0047 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | | +| 2023-06 | CT#100 | CP-231142 | 0048 | | F | Update of info and externalDocs fields | 18.2.0 | | +| 2023-12 | CT#102 | CP-233229 | 0049 | 1 | F | IETF RFC 7540, RFC 7807 obsoleted by RFC 9113 and RFC 9457 respectively | 18.3.0 | | \ No newline at end of file diff --git a/gsma/29_series/29578/raw.md b/gsma/29_series/29578/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ba6143a0bb99b9bd77f999818b143db97e69e3ce --- /dev/null +++ b/gsma/29_series/29578/raw.md @@ -0,0 +1,702 @@ + + +# 3GPP TS 29.578 V18.1.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Mobile Number Portability Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized font with a red signal wave icon below the 'G', and the text 'A GLOBAL INITIATIVE' underneath. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + + + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, symbols and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Symbols..... | 9 | +| 3.3 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Services offered by the MNPF..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 Nmpf_NPStatus Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Get..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 MNPF Status information retrieval ..... | 10 | +| 6 API Definitions ..... | 11 | +| 6.1 Nmpf_NPStatus Service API ..... | 11 | +| 6.1.1 Introduction ..... | 11 | +| 6.1.2 Usage of HTTP..... | 11 | +| 6.1.2.1 General..... | 11 | +| 6.1.2.2 HTTP standard headers..... | 12 | +| 6.1.2.2.1 General ..... | 12 | +| 6.1.2.2.2 Content type ..... | 12 | +| 6.1.2.3 HTTP custom headers..... | 12 | +| 6.1.3 Resources..... | 12 | +| 6.1.3.1 Overview..... | 12 | +| 6.1.3.2 Resource: NPstatus ..... | 13 | +| 6.1.3.2.1 Description ..... | 13 | +| 6.1.3.2.2 Resource Definition..... | 13 | +| 6.1.3.2.3 Resource Standard Methods..... | 13 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 14 | +| 6.1.6.1 General..... | 14 | +| 6.1.6.2 Structured data types..... | 14 | +| 6.1.6.2.1 Introduction ..... | 14 | +| 6.1.6.2.2 Type: NpStatusInfo ..... | 14 | +| 6.1.6.3 Simple data types and enumerations..... | 14 | +| 6.1.6.3.1 Introduction ..... | 14 | +| 6.1.6.3.2 Simple data types ..... | 14 | +| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 15 | +| 6.1.6.5 Binary data..... | 15 | +| 6.1.7 Error Handling..... | 15 | +| 6.1.7.1 General..... | 15 | +| 6.1.7.2 Protocol Errors..... | 15 | +| 6.1.7.3 Application Errors..... | 15 | +| 6.1.8 Feature negotiation ..... | 15 | +| 6.1.9 Security..... | 15 | + +**Annex A (normative): OpenAPI specification ..... 16** +A.1 General..... 16 +A.2 Nmnpf\_NPStatus API..... 16 +**Annex B (informative): Withdrawn API versions ..... 17** +B.1 General..... 17 +B.2 Nmnpf\_NPstatus API..... 17 +**Annex C (informative): Change history..... 19** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document specifies the stage 3 protocol and data model for the Nnmpf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the MNPF. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +Stage 2 requirements for the Nnmpf services are specified in 3GPP TS 23.540 [14]. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.540: " Technical realization of Service Based Short Message Service; Stage 2". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Nmnpf:** Service-based interface exhibited by the MNPF server + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +            + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------| +| MNPF | Mobile Number Portability Function | +|------|------------------------------------| + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the MNPF offers services to the SMS-GMSC, NRF and SCP via the Nmnpf service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.540 [14]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the MNPF. + +![Reference model diagram for MNPF showing NRF, SMS-GMSC, and SCP connected to the MNPF via the Nmnpf interface.](2a0f333f04f8e672bebf288c511c1db5_img.jpg) + +The diagram illustrates the reference model for the MNPF. On the left, three functional blocks are shown: NRF, SMS-GMSC, and SCP. Each block is connected to a central interface point labeled 'Nmnpf' via a line representing a service based interface. The connections are labeled SM14 (NRF to Nmnpf), SM12 (SMS-GMSC to Nmnpf), and SM13 (SCP to Nmnpf). The 'Nmnpf' interface is represented by a circle on the left side of a large green rectangular block labeled 'MNPF'. + +Reference model diagram for MNPF showing NRF, SMS-GMSC, and SCP connected to the MNPF via the Nmnpf interface. + +**Figure 4.1-1: Reference model – MNPF** + +The functionalities supported by the MNPF are listed in clause 6.7 of 3GPP TS 23.540 [14]. + +# 5 Services offered by the MNPF + +## 5.1 Introduction + +The MNPF offers the following services via the Nmnpf interface: + +- Nmnpf\_NPStatus Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|----------------|--------|----------------------------------------|-----------------------------|----------------|-------| +| Nmnpf_NPStatus | 6.1 | MNPF Number portability Status Service | TS29578_Nmnpf_NPStatus.yaml | nmnpf-npstatus | A.2 | + +## 5.2 Nmnpf\_NPStatus Service + +### 5.2.1 Service Description + +See 3GPP TS 23.540 [14] clause 6.7.1. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nmnpf\_NPStatus service the following service operations are defined: + +- Get + +The Nmnpf\_NPStatus Service is used by Consumer NFs (SMS-GMSC, NRF, SCP) to retrieve the UE's subscription network by means of the Get service operation. + +#### 5.2.2.2 Get + +##### 5.2.2.2.1 General + +This clause provides a general description of the Get service operation. + +##### 5.2.2.2.2 MNPF Status information retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF service consumer (e.g. SMS-GMSC, NRF, SCP) sends a request to the MNPF to receive the UE's Subscription Network (see also clause 5.1.7.2, clause 5.1.7.3 and clause 5.1.7.4 of 3GPP TS 23.540 [14]). The request contains the UE's identity (/{}gpsi{}). + +![Sequence diagram showing the interaction between an NF service consumer and an MNPF to request a UE's NP status. The consumer sends a GET request to the MNPF. The MNPF responds with either a 200 OK (NpStatusInfo) or a 404 Not Found.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant MNPF + Note left of NF service consumer: Requesting a UE's NP status + NF service consumer->>MNPF: 1. GET .../{gpsi} + MNPF-->>NF service consumer: 2a. 200 OK (NpStatusInfo) + MNPF-->>NF service consumer: 2b. 404 Not Found + +``` + +Sequence diagram showing the interaction between an NF service consumer and an MNPF to request a UE's NP status. The consumer sends a GET request to the MNPF. The MNPF responds with either a 200 OK (NpStatusInfo) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: Requesting a UE's NP statusI** + +1. The NF service consumer (e.g. SMS-GMSC, NRF, SCP) sends a GET request to the resource representing the UE's number portability status. +- 2a. On success, the MNPF responds with "200 OK" with the message body containing the UE's Number Portability Status Information. +- 2b. If there is no valid information for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element). + +On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body. + +# 6 API Definitions + +## 6.1 Nmnpf\_NPStatus Service API + +### 6.1.1 Introduction + +The Nmnpf\_NPStatus service shall use the Nmnpf\_NPStatus API. + +The API URI of the Nmnpf\_NPStatus API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "nmnpf-npstatus". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Nmnpf\_NPStatus API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Nmnpf\_NPStatus API. + +![Diagram showing the resource URI structure for the Nmnpf_NPStatus API. The root path is {apiRoot}/nmnpf_npstatus/{apiVersion}. A line branches from this root to a box containing the relative path /{gpsi}.](e787e02d9214556476d95941bda1d350_img.jpg) + +``` + + {apiRoot}/nmnpf_npstatus/{apiVersion} + | + +--> /{gpsi} + +``` + +Diagram showing the resource URI structure for the Nmnpf\_NPStatus API. The root path is {apiRoot}/nmnpf\_npstatus/{apiVersion}. A line branches from this root to a box containing the relative path /{gpsi}. + +**Figure 6.1.3.1-1: Resource URI structure of the Nmnpf\_NPStatus API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|------------------------------------| +| NPstatus | /{gpsi} | GET | Retrieve the NP status of the GPSI | +| | | | | + +#### 6.1.3.2 Resource: NPstatus + +##### 6.1.3.2.1 Description + +This resource represents the Number Portability status for a GPSI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nmnpf-npstatus//{gpsI} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| gpsI | Gpsi | See 3GPP TS 29.571 [15]; the only valid format is MSISDN | + +##### 6.1.3.2.3 Resource Standard Methods + +###### 6.1.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1. + +**Table 6.1.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| n/a | | | | | | + +This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and response codes specified in table 6.1.3.2.3.1-3. + +**Table 6.1.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| NpStatusInfo | M | 1 | 200 OK | Upon success, the response body contains the Number Portability Status information. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- GPSI NOT_FOUND | +| NOTE: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.1.4 Custom Operations without associated resources + +None. + +### 6.1.5 Notifications + +None. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Nmnpf\_NPStatus service based interface protocol. + +**Table 6.1.6.1-1: Nmnpf\_NPStatus specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------|----------------|---------------------------------------|---------------| +| NpStatusInfo | 6.1.6.2.2 | Number Portability Status Information | | + +Table 6.1.6.1-2 specifies data types re-used by the Nmnpf\_NPStatus service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nmnpf\_NPStatus service based interface. + +**Table 6.1.6.1-2: Nmnpf\_NPStatus re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|----------------------------------------|---------------| +| Gpsi | 3GPP TS 29.571 [15] | General Public Subscription Identifier | | +| ProblemDetails | 3GPP TS 29.571 [15] | Error description | | +| PlmnId | 3GPP TS 29.571 [15] | PLMN Identity | | + +#### 6.1.6.2 Structured data types + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: NpStatusInfo + +**Table 6.1.6.2.2-1: Definition of type NpStatusInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------|---|-------------|-------------------------------------------|---------------| +| subscriptionNetwork | PlmnId | M | 1 | Identifies the GPSI's subscriptionNetwork | | +| tbc | | | | | | + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +None. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnmpf\_NPStatus API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Nnmpf\_NPStatus API. + +#### 6.1.7.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnmpf\_NPStatus service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnmpf\_NPStatus API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Nnmpf\_NPStatus API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Nnmpf\_NPStatus API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Nnmpf\_NPStatus service. + +The Nnmpf\_NPStatus API defines a single scope "nnmpf-npstatus" for the entire service, and it does not define any additional scopes at resource or operation level. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Nmnpf\_NPStatus API + +``` +openapi: 3.0.0 +info: + title: 'Nmnpf_NPStatus' + version: '1.1.0-alpha.1' + description: | + Nmnpf Number Portability Status Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.578 V18.0.0; Mobile Number Portability Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.578/ +servers: + - url: '{apiRoot}/nmnpf-npstatus/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nmnpf-npstatus +paths: + /{gpsi}: + get: + summary: Retrieves the Number Portability status of the UE + operationId: GetNumberPortabilityStatus + tags: + - Number Portability Status (Document) + parameters: + - name: gpsi + in: path + description: GPSI of the UE + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NpStatusInfo' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' +``` + +``` +'401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' +'403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' +'404': + description: GPSI Not Found + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +'502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + description: Unexpected error + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nmnpf-npstatus: Access to the nmnpf-npstatus API + schemas: + +# COMPLEX TYPES: + + NpStatusInfo: + description: Contains the Subscription Network + type: object + required: + - subscriptionNetwork + properties: + subscriptionNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + +# SIMPLE TYPES: + +# ENUMS: +``` + +# --- Annex B (informative): Withdrawn API versions + +## B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## --- B.2 Nmnpf\_NPstatus API + +The API versions listed in table B.2-1 are withdrawn for the Nmnpf\_NPStatus API. + +**Table B.2-1: Withdrawn API versions of the Nmnpf\_NPStatus service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|------|-----|--------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Re v | Cat | Subject/Comment | New version | +| 2022-02 | CT4#108e | C4-221536 | | | | Initial draft | 0.1.0 | +| 2022-04 | CT4#109e | C4-222270 | | | | Pseudo-CR on SCP and NRF supported | 0.2.0 | +| 2022-05 | CT4#110e | C4-223092 | | | | Pseudo-CR on MNPF name | 0.3.0 | +| 2022-05 | CT4#110e | C4-223093 | | | | Pseudo-CR on Document Clean Up | 0.3.0 | +| 2022-05 | CT4#110e | C4-223354 | | | | Pseudo-CR on Remove the apiVersion placeholder from the resource URI variables table | 0.3.0 | +| 2022-06 | CT#96 | CP-221079 | | | | TS presented for information and approval | 1.0.0 | +| 2022-06 | CT#96 | CP-221079 | | | | TS approved at CT#95 | 17.0.0 | +| 2022-09 | CT#97e | CP-222027 | 0003 | | F | Alignment on the service name used with template | 17.1.0 | +| 2022-09 | CT#97e | CP-222027 | 0004 | 1 | F | Update the reference model | 17.1.0 | +| 2022-12 | CT#98e | CP-223027 | 0006 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0007 | | F | 29.578 Rel-18 API version and External doc update | 18.0.0 | +| 2023-12 | CT#102 | CP-233028 | 0008 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 | +| 2023-12 | CT#102 | CP-233029 | 0009 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 | \ No newline at end of file diff --git a/gsma/29_series/29579/raw.md b/gsma/29_series/29579/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..77e130946d4bf80b042d61b178700739b5eeb9d2 --- /dev/null +++ b/gsma/29_series/29579/raw.md @@ -0,0 +1,878 @@ + + +# 3GPP TS 29.579 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Interworking MSC For Short Message Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G' and the word 'ADVANCED' in smaller letters to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. The 'G' has a red signal wave icon below it. + +3GPP logo + +A GLOBAL INITIATIVE + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +--- + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the SMS-IWMSC..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Niwmsc_SMService Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 MoForwardSm ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 SBI-based MO SM transfer..... | 9 | +| 6 API Definitions ..... | 10 | +| 6.1 Niwmsc_SMService Service API ..... | 10 | +| 6.1.1 Introduction ..... | 10 | +| 6.1.2 Usage of HTTP..... | 10 | +| 6.1.2.1 General..... | 10 | +| 6.1.2.2 HTTP standard headers..... | 10 | +| 6.1.2.2.1 General ..... | 10 | +| 6.1.2.2.2 Content type ..... | 10 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.2.4 HTTP multipart messages..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: MoSmInfo..... | 12 | +| 6.1.3.2.1 Description ..... | 12 | +| 6.1.3.2.2 Resource Definition..... | 12 | +| 6.1.3.2.3 Resource Standard Methods..... | 12 | +| 6.1.3.2.4 Resource Custom Operations..... | 13 | +| 6.1.4 Custom Operations without associated resources ..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.6 Data Model ..... | 15 | +| 6.1.6.1 General..... | 15 | +| 6.1.6.2 Structured data types..... | 15 | +| 6.1.6.3 Simple data types and enumerations..... | 16 | +| 6.1.6.3.1 Introduction ..... | 16 | +| 6.1.6.3.2 Simple data types ..... | 16 | +| 6.1.6.4 Data types describing alternative data types or combinations of data types ..... | 16 | +| 6.1.6.5 Binary data..... | 16 | +| 6.1.6.5.1 Binary Data Types..... | 16 | +| 6.1.6.5.2 SMS Payload Information..... | 16 | +| 6.1.7 Error Handling..... | 16 | +| 6.1.7.1 General..... | 16 | +| 6.1.7.2 Protocol Errors ..... | 16 | +| 6.1.7.3 Application Errors..... | 16 | +| 6.1.8 Feature negotiation ..... | 17 | +| 6.1.9 Security..... | 17 | +| 6.1.10 HTTP redirection..... | 17 | + +**Annex A (normative): OpenAPI specification ..... 18** +A.1 General..... 18 +A.2 Niwmsc\_SMService API..... 18 +**Annex B (informative): Withdrawn API versions ..... 20** +B.1 General..... 20 +B.2 Niwmsc\_SMService API..... 20 +**Annex C (informative): Change history..... 21** + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# 1 Scope + +The present document specifies the stage 3 protocol and data model for the Niwmsc Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SMS-IWMSC. + +The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5]. + +Stage 2 requirements for the Niwmsc services are specified in 3GPP TS 23.540 [14]. + +# 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [6] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [9] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [10] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [11] IETF RFC 9113: "HTTP/2". +- [12] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 23.540: "Technical realization of Service Based Short Message Service; Stage 2". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)". +- [17] 3GPP TS 29.577: "5G System; IP Short Message Gateway and SMS Router For Short Message Service; Stage 3". +- [18] 3GPP TS 24.011: " Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". + +# 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +**Niwmsc:** Service-based interface exhibited by the SMS-IWMSC + +## 3.2 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +| | | +|-------|---------------------------------| +| SM MO | Short Message Mobile Originated | +|-------|---------------------------------| + +# 4 Overview + +## 4.1 Introduction + +The SMS-IWMSC offers services to the SMSF via the Niwmsc service based interface (see 3GPP TS 23.501 [2], 3GPP TS 23.502 [3], and 3GPP TS 23.540 [14]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the SMS-IWMSC. + +![Reference model diagram showing SMSF connected to SMS-IWMSC via SM10 interface and Niwmsc service-based interface.](18f841ac4f2ef28f34a026f1bdc5af9a_img.jpg) + +The diagram illustrates the reference model for the SMS-IWMSC. On the left, a white rectangular box is labeled 'SMSF'. A horizontal line, representing the SM10 interface, connects this box to a green rectangular box on the right labeled 'SMS-IWMSC'. The connection point on the SMS-IWMSC side is marked with a small circle and labeled 'Niwmsc', indicating the service-based interface. + +Reference model diagram showing SMSF connected to SMS-IWMSC via SM10 interface and Niwmsc service-based interface. + +**Figure 4.1-1: Reference model – SMS-IWMSC** + +The functionalities supported by the SMS-IWMSC are listed in clause 6.3 of 3GPP TS 23.540 [14]. + +# 5 Services offered by the SMS-IWMSC + +## 5.1 Introduction + +The SMS-IWMSC offers the following services via the Niwmsc interface: + +- Niwmsc\_SMService Service + +Table 5.1-1 summarizes the corresponding APIs defined for this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|------------------|--------|---------------------------------|-------------------------------|-------------------|-------| +| Niwmsc_SMService | 6.1 | SMS-IWMSC short message service | TS29579_Niwmsc_SMService.yaml | niwmsc-smbservice | A.2 | + +## 5.2 Niwmsc\_SMService Service + +### 5.2.1 Service Description + +See 3GPP TS 23.540 [14] clause 6.3.1 + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Niwmsc\_SMService service the following service operations are defined: + +- MoForwardSm + +The Niwmsc\_SMService Service is used by Consumer NFs (SMSF) to transfer MO short message by means of the MoForwardSm service operation. + +#### 5.2.2.2 MoForwardSm + +##### 5.2.2.2.1 General + +This clause provides a general description of the MoForwardSm service operation. + +##### 5.2.2.2.2 SBI-based MO SM transfer + +The MoForwardSm service operation shall be used to transmit uplink SMS message via SMS-IWMSC. + +It is used in the following procedures: + +- Successful Mobile Originated short message transfer via SMS-IWMSC (see clause 5.2.2 of 3GPP TS 23.540 [14]). +- Unsuccessful Mobile Originated short message transfer via SMS-IWMSC (see clause 5.2.3 of 3GPP TS 23.540 [14]). + +The NF Service Consumer (e.g. SMSF) shall transmit uplink SMS message to the SMS-IWMSC by using the HTTP POST method as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing SBI-based MO SM transfer between NF Service Consumer and SMS-IWMSC.](97a08abb8a43f3f8c6ce347199cd909a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMS-IWMSC + Note right of NF Service Consumer: (SMS Data) + NF Service Consumer->>SMS-IWMSC: 1. POST ../mo-sm-info/{supi}/sendsms + SMS-IWMSC-->>NF Service Consumer: 2a. 200 OK (Delivery Report) + SMS-IWMSC-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +The diagram illustrates the interaction between an NF Service Consumer and an SMS-IWMSC. The consumer sends a POST request (step 1) to the SMS-IWMSC, including SMS data. The SMS-IWMSC responds with either a 200 OK (Delivery Report) (step 2a) or a 4xx/5xx (ProblemDetails) or 3xx (step 2b). + +Sequence diagram showing SBI-based MO SM transfer between NF Service Consumer and SMS-IWMSC. + +**Figure 5.2.2.2.2.1-1: SBI-based MO SM transfer** + +1. The NF Service Consumer shall send a POST request to the resource representing the UE's Mobile Originated Short Message Information resource (i.e. .../mo-sm-info/{supi}/sendsmss) of the SMS-IWMSC. The content of the POST request shall contain the SMS message to be sent. +- 2a. On success, "200 OK" shall be returned with "SmsDeliveryData" object contains the MO SMS Delivery Report in the response body. +- 2b. On failure, or redirection, one of the HTTP status code listed in Table 6.1.3.2.4.2.2-2 shall be returned. + +# --- 6 API Definitions + +## 6.1 Niwmsc\_SMService Service API + +### 6.1.1 Introduction + +The Niwmsc\_SMService shall use the Niwmsc\_SMService API. + +The API URI of the Niwmsc\_SMService API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5]. +- The shall be "niwmsc-smbservice". +- The shall be "v1". +- The shall be set as described in clause 6.1.3. + +### 6.1.2 Usage of HTTP + +#### 6.1.2.1 General + +HTTP/2, IETF RFC 9113 [11], shall be used as specified in clause 5 of 3GPP TS 29.500 [4]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4]. + +The OpenAPI [6] specification of HTTP messages and content bodies for the Niwmsc\_SMService API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [4] for the usage of HTTP standard headers. + +##### 6.1.2.2.2 Content type + +JSON, IETF RFC 8259 [12], shall be used as content type of the HTTP bodies specified in the present specification as specified in clause 5.4 of 3GPP TS 29.500 [4]. The use of the JSON format shall be signalled by the content type "application/json". + +"Problem Details" JSON object shall be used to indicate additional details of the error in a HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [13]. + +Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising: + +- one JSON body part with the "application/json" content type; and +- one binary body part with 3gpp vendor specific content subtypes. + +The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported. + +**Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes** + +| content subtype | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| vnd.3gpp.sms | Binary encoded payload, encoding SMS payload, as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [17]. | +| NOTE: | Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. SMS payload) without having to rely on metadata in the JSON content. | + +See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +The mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [4] shall be supported, and the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [4] may be supported. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque SMS payload (e.g. SMS message, CP Ack, etc.), in the following service operations (and HTTP messages): + +- MoForwardSm service operation; + +HTTP multipart messages shall include one JSON body part and one binary body part comprising content of SMS payload content (see clause 6.1.6.5). + +The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of the multipart message. The "Start" parameter does not need to be included. + +The multipart message shall include a "type" parameter (see IETF RFC 2387 [18]) specifying the media type of the root body part, i.e. "application/json". + +NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a multipart/related message, see IETF RFC 2387 [18]. The default root is the first body within the multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the first body part in the message. + +A binary body part shall include a Content-ID header (see IETF RFC 2045 [19]), and the JSON body part shall make a reference to the binary body part using the Content-ID header field. + +Examples of multipart/related messages can be found in Annex B. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.1.3.1-1 depicts the resource URIs structure for the Niwmse\_SMSService API. + +![Diagram showing the hierarchical structure of the Niwmsc_SMSService API URI. The root is {apiRoot}/niwmsc_smbservice/. It branches to /mo-sm-info, which branches to /{supi}, which branches to /send sms (dashed box).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +{apiRoot}/niwmsc\_smbservice/ + +``` + +graph TD + Root["{apiRoot}/niwmsc_smbservice/"] --> MoSmInfo["/mo-sm-info"] + MoSmInfo --> Supi["/{supi}"] + Supi --> SendSms["/send sms"] + style SendSms stroke-dasharray: 5 5 + +``` + +Diagram showing the hierarchical structure of the Niwmsc\_SMSService API URI. The root is {apiRoot}/niwmsc\_smbservice/. It branches to /mo-sm-info, which branches to /{supi}, which branches to /send sms (dashed box). + +**Figure 6.1.3.1-1: Resource URI structure of the Niwmsc\_SMSService API** + +Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.1.3.1-1: Resources and methods overview** + +| Resource purpose/name | Resource URI (relative path after API URI) | HTTP method or custom operation | Description (service operation) | +|-----------------------|--------------------------------------------|---------------------------------|---------------------------------| +| SMSService | /mo-sm-info/{supi}/send sms | send sms (POST) | MO short message transfer | +| | | | | +| | | | | +| | | | | +| | | | | + +#### 6.1.3.2 Resource: MoSmInfo + +##### 6.1.3.2.1 Description + +This resource represents the collection of Mobile Originated Short Message Information in SMS-IWMSC. + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}///mo-sm-info{supi} + +This resource shall support the resource URI variables defined in table 6.1.3.2.2-1. + +**Table 6.1.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 6.1.1 | +| supi | Supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: See pattern of type Supi in 3GPP TS 29.571 [15] | + +##### 6.1.3.2.3 Resource Standard Methods + +No HTTP method has been defined for the Mobile Originated Short Message Information collection resource. + +##### 6.1.3.2.4 Resource Custom Operations + +###### 6.1.3.2.4.1 Overview + +**Table 6.1.3.2.4.1-1: Custom operations** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|-----------------------------|--------------------|-----------------------------------------------------| +| sendsms | /mo-sm-infos/{supi}/sendsms | POST | Send MO SMS message or the related Delivery Report. | + +###### 6.1.3.2.4.2 Operation: sendsms + +###### 6.1.3.2.4.2.1 Description + +This custom operation is used for NF Service Consumers to send SMS message in uplink direction. + +###### 6.1.3.2.4.2.2 Operation Definition + +This custom operation is used to send a SMS payload to an UE's Mobile Originated Short Message Information resource in the SMS-IWMSC. + +This operation shall support the request data structures specified in table 6.1.3.2.4.2.2-1 and the response data structure and response codes specified in table 6.1.3.2.4.2.2-2. + +**Table 6.1.3.2.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------| +| SmsData | M | 1 | Representation of the MO SMS message to be sent. | + +**Table 6.1.3.2.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmsDeliveryData | M | 1 | 200 OK | This case represents the successful of sending SMS message in uplink direction, with necessary response data on the received delivery report. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 400 Bad Request | This case represents an unsuccessful delivery of SMS message.
The "cause" attribute may be used to indicate one of the following application errors:
  • - SMS_PAYLOAD_MISSING, if the expected SMS payload content is missing;
  • - SMS_PAYLOAD_ERROR, if error exists in the SMS payload content.
| +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents an unsuccessful delivery of SMS message.
The "cause" attribute may be used to indicate one of the following application errors:
  • - UNKNOWN_SERVICE_CENTRE_ADDRESS, if the SMS-SC was unknown;
  • - SERVICE_CENTRE_CONGESTION, if the SMS-SC was in congestion;
  • - USER_NOT_SERVICE_CENTER, if the user didn't belongs to the SMS-SC;
  • - FACILITY_NOT_SUPPORTED, if the facility not supported;
  • - INVALID_SME_ADDRESS, if the SME address is invalid..
| +| ProblemDetails | O | 0..1 | 504 Gateway Timeout | This case represents an unsuccessful delivery of SMS message.
The "cause" attribute may be used to indicate one of the following application errors:
  • - UNREACHABLE_SMS_SC, if the response is timeout.
| + +NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 6.1.3.2.4.2.2-3: Headers supported by the 307 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMS-IWMSC or SMS-IWMSC (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +**Table 6.1.3.2.4.2.2-4: Headers supported by the 308 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | An alternative URI of the resource located on an alternative service instance within the same SMS-IWMSC or SMS-IWMSC (service) set.
For the case, when a request is redirected to the same target resource via a different SCP, see clause 6.10.9.1 in 3GPP TS 29.500 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the request is redirected | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined. + +### 6.1.5 Notifications + +In this release of this specification, no notification procedures are defined. + +### 6.1.6 Data Model + +#### 6.1.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.1.6.1-1 specifies the data types defined for the Niwmsc\_SMSService service based interface protocol. + +**Table 6.1.6.1-1: Niwmsc\_SMSService specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-----------|----------------|-------------|---------------| +| N/A | | | | + +Table 6.1.6.1-2 specifies data types re-used by the Niwmsc\_SMSService service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Niwmsc\_SMSService service based interface. + +**Table 6.1.6.1-2: Niwmsc\_SMSService re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [15] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | | +| Supi | 3GPP TS 29.571 [15] | Subscription Permanent Identifier | | +| RefToBinaryData | 3GPP TS 29.571 [15] | Information for indicating the binary content of SMS payload. | | +| Ipv4Addr | 3GPP TS 29.571 [15] | IPv4 address | | +| Ipv6Addr | 3GPP TS 29.571 [15] | IPv6 address | | +| SupportedFeatures | 3GPP TS 29.571 [15] | Supported Features | | +| SmsData | 3GPP TS 29.577 [17] | Information within request message invoking MoForwardSm service operation, for delivering MO SMS. | | +| SmsDeliveryData | 3GPP TS 29.571 [17] | Information within response message invoking MoForwardSm service operation, for delivering MO SMS Delivery Report. | | + +#### 6.1.6.2 Structured data types + +In this release of this specification, no structure to be used in resource representations is defined. + +#### 6.1.6.3 Simple data types and enumerations + +##### 6.1.6.3.1 Introduction + +This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. + +##### 6.1.6.3.2 Simple data types + +The simple data types defined in table 6.1.6.3.2-1 shall be supported. + +**Table 6.1.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| N/A | | | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +None. + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Binary Data Types + +**Table 6.1.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|-------------------------|----------------|--------------| +| SMS Payload Information | 6.1.6.4.2 | vnd.3gpp.sms | + +##### 6.1.6.5.2 SMS Payload Information + +SMS Payload Information shall encode a SMS payload as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [18], using the vnd.3gpp.sms content-type. + +SMS Payload Information may encode e.g. the following content: + +- CP-DATA, CP-ACK, CP-ERROR as specified in 3GPP TS 23.040 [16] and 3GPP TS 24.011 [18]. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Niwmsc\_SMService API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [5]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [4] shall be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP method in table 5.2.7.1-1 of 3GPP TS 29.500 [4]. + +In addition, the requirements in the following clauses are applicable for the Niwmsc\_SMService API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Niwmsc\_SMService service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Niwmsc\_SMService service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|---------------------|-----------------------------------------------------------------------------------------| +| SMS_PAYLOAD_MISSING | 400 Bad Request | The expected SMS payload content is missing. | +| SMS_PAYLOAD_ERROR | 400 Bad Request | Errors exist in the format of SMS payload. | +| SERVICE_CENTRE_CONGESTION | 403 Forbidden | The delivery of the MO short message failed because SMS-SC was in congestion. | +| USER_NOT_SERVICE_CENTER | 403 Forbidden | The delivery of the short message failed because the user didn't belongs to the SMS-SC. | +| FACILITY_NOT_SUPPORTED | 403 Forbidden | The delivery of the MO short message failed because of facility not supported. | +| INVALID_SME_ADDRESS | 403 Forbidden | The delivery of the MO short message failed because the SME address is invalid. | +| UNREACHABLE_SMS_SC | 504 Gateway Timeout | The delivery of the MO short message failed because the response is timeout. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Niwmsc\_SMService API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| N/A | | | + +### 6.1.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the Niwmsc\_SMService API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [9]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [10]) plays the role of the authorization server. + +If OAuth2 is used, an NF Service Consumer, prior to consuming services offered by the Niwmsc\_SMService API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [10], clause 5.4.2.2. + +NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Niwmsc\_SMService service. + +The Niwmsc\_SMService API defines a single scope "niwmsc-smbservice" for the entire service, and it does not define any additional scopes at resource or operation level. + +### 6.1.10 HTTP redirection + +An HTTP request may be redirected to a different SMS-IWMSC service instance, within the same SMS-IWMSC or a different SMS-IWMSC of an SMS-IWMSC set, e.g. when an SMS-IWMSC service instance is part of an SMS-IWMSC (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different SMS-IWMSC producer instance will return the NF Instance ID of the new SMS-IWMSC producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4]. + +If an SMS-IWMSC within an SMS-IWMSC set redirects a service request to a different SMS-IWMSC of the set using a 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMS-IWMSC towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4]. + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the API(s) defined in the present specification. It consists of OpenAPI specifications in YAML format. + +This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods within the API(s). + +NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the specification also apply. + +Informative copies of the OpenAPI specification files contained in this 3GPP Technical Specification are available on a Git-based repository that uses the GitLab software version control system (see clause 5.3.1 of 3GPP TS 29.501 [5] and clause 5B of 3GPP TR 21.900 [7]). + +## A.2 Niwmsc\_SMService API + +``` +openapi: 3.0.0 +info: + title: 'Niwmsc_SMService' + version: '1.1.0-alpha.2' + description: | + SMS-IWMSC Short Message Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.579 V18.1.0; 5G System; SMS Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.579/ + +servers: + - url: '{apiRoot}/niwmsc-smsservice/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - oAuth2ClientCredentials: + - niwmsc-smsservice + - {} + +paths: + /mo-sm-infos/{supi}/sendsms: + post: + summary: Send SMS payload for a given UE + operationId: SendSMS + tags: + - Send MO SMS message and the delivery report + parameters: + - name: supi + in: path + required: true + description: Subscription Permanent Identifier (SUPI) + schema: + type: string + requestBody: + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/SmsData' + binaryPayload: +``` + +``` + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryPayload: + contentType: application/vnd.3gpp.sms + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: sending delivery report + content: + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/SmsDeliveryData' + binaryPayload: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryPayload: + contentType: application/vnd.3gpp.sms + headers: + Content-Id: + schema: + type: string + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + niwmsc-smbservice: Access to the niwmsc-smbservice API + +schemas: + + SmsData: + description: > +``` + +``` + + Information within request message invoking MoForwardSm service operation, + for delivering MO SMS. +type: object +required: + - smsPayload +properties: + smsPayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + +SmsDeliveryData: + description: > + Information within response message invoking MoForwardSm service operation, + for delivering MO SMS Delivery Report. + type: object + required: + - smsPayload + properties: + smsPayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + +# COMPLEX TYPES: + +# SIMPLE TYPES: + +# ENUMS: + +``` + +# --- Annex B (informative): Withdrawn API versions + +## B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. 3GPP TS 29.501 [5] clause 4.3.1.6 describes the withdrawal of API versions. + +## --- B.2 Niwmsc\_SMService API + +The API versions listed in table B.2-1 are withdrawn for the Niwmsc\_SMService API. + +**Table B.2-1: Withdrawn API versions of the Niwmsc\_SMService service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2022-04 | CT4#109e | C4-222331 | | | | C4-222331 as basis | 0.1.0 | +| 2022-04 | CT4#109e | C4-222343 | | | | Implementation of C4-222343 in CT4#109e | 0.2.0 | +| 2022-05 | CT4#110e | C4-223452 | | | | Implementation of C4-223219 and C4-223224 in CT4#110e | 0.3.0 | +| 2022-06 | CT#96 | CP-221080 | | | | TS presented for information and approval | 1.0.0 | +| 2022-06 | CT#96 | CP-221080 | | | | TS approved at CT#95 | 17.0.0 | +| 2022-09 | CT#97e | CP-222027 | 0002 | - | B | Add 3xx for the service operation | 17.1.0 | +| 2022-09 | CT#97e | CP-222027 | 0003 | - | F | Alignment on the service name used with template | 17.1.0 | +| 2022-09 | CT#97e | CP-222027 | 0004 | - | F | Corrections on the table name and NOTE | 17.1.0 | +| 2022-09 | CT#97e | CP-222027 | 0005 | - | F | Update on the content type for OpenAPI | 17.1.0 | +| 2022-09 | CT#97e | CP-222027 | 0006 | 1 | F | Update on the reference model | 17.1.0 | +| 2022-09 | CT#97e | CP-222058 | 0007 | - | F | 29.579 Rel-17 API version and External doc update | 17.1.0 | +| 2022-12 | CT#98e | CP-223028 | 0008 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0009 | - | F | 29.579 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99e | CP-230073 | 0012 | - | A | Rel-18 Niwmsc SMService API HTTP code correction | 18.0.1 | +| 2023-03 | CT#99e | CP-230071 | 0014 | - | F | 29.579 Rel-18 API version and External doc update | 18.0.1 | +| 2023-03 | CT#99e | CP-230321 | 0015 | - | F | 29.579 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#99e | CP-231026 | 0013 | 3 | F | Location header description | 18.2.0 | +| 2023-12 | CT#102 | CP-233027 | 0017 | - | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233028 | 0016 | 1 | F | HTTP RFCs update in TS 29.579 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0018 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | \ No newline at end of file diff --git a/gsma/29_series/29641/raw.md b/gsma/29_series/29641/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..39e2afb77b5ba33a20b2fff76947b698fe349eb7 --- /dev/null +++ b/gsma/29_series/29641/raw.md @@ -0,0 +1,204 @@ + + +# 3GPP TS 29.641 V18.1.0 (2023-06) + +*Technical Report* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 3GPP registry for Service Names and Port Numbers (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller text to the right. + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, black, stylized font. Below the 'P' is a red signal wave icon. Underneath the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +## --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# --- Contents + +| | | +|------------------------------------------------------------------------------|----------| +| Foreword ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions of terms, symbols and abbreviations..... | 5 | +| 3.1 Terms..... | 5 | +| 3.2 Void..... | 6 | +| 3.3 Void..... | 6 | +| 4 3GPP procedures for Service Name and Port Number registry management ..... | 6 | +| 4.1 General Principles ..... | 6 | +| 4.2 3GPP allocated Service Name and Port Number registry..... | 6 | +| 5 Port Number Database ..... | 6 | +| Annex A (informative): Change history..... | 7 | + +# Foreword + +This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document defines 3GPP procedures for Service Name and Port Number registry management. These procedures should be followed by 3GPP WGs when requesting new port numbers for the 3GPP allocated port number solution#6, which is specified in clause 4.4 of the 3GPP TR 29.941 [2]. + +The present document also maintains a database of the 3GPP allocated port numbers. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TR 29.941: "Study on Port Number Allocation Alternatives for New 3GPP Interfaces". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +3.2 Void + +3.3 Void + +# --- 4 3GPP procedures for Service Name and Port Number registry management + +## 4.1 General Principles + +3GPP CT4 is responsible for the management and maintenance of service name and port number registry from the sub-range of 101 ports from 65400 to 65500. This sub-range belongs to the Dynamic/Private Port range [49152 - 65535] and IANA does not assign port numbers from this range. + +Clause 4.4 in 3GPP TR 29.941 [2] specifies solution#6 for 3GPP allocated port numbers. Solution#6 requires 3GPP CT4 to maintain the 3GPP allocated port number repository. + +## 4.2 3GPP allocated Service Name and Port Number registry + +This clause specifies 3GPP procedure for the port number allocation based on the solution#6 (see clause 4.4 in 3GPP TR 29.941 [2]). + +1. If a 3GPP working group decides to utilize 3GPP allocated port number solution#6, the working group shall send an LS request to 3GPP CT4. CT4 accepts the request if it addresses the following matters (checklist): + - a. The request should be for a protocol, which is supported by intra-domain interface(s). + - b. The request should indicate that the request cannot meet IANA/IETF requirements for the port number allocation (see Annex C in 3GPP TR 29.941 [2]). + - c. The request should indicate that solution#6 is preferable and selected after evaluating other solutions specified in 3GPP TR 29.941 [2]. +2. LS request to 3GPP CT4 shall also contain the following information: + - a. The service name, e.g. x2-ctrl. + - b. Applicable transport protocol(s). + - c. Short description, e.g. X2-CP. + - d. A statement that the new port number will be used across intra-domain interface between nodes and . + - e. Work Item Code (WIC) used by the request sender (both the abbreviation and the numerical value). +3. 3GPP CT4 shall inform the 3GPP WG that has requested new port number allocation and also may inform other, relevant 3GPP WGs about the decision. 3GPP CT4 creates respective CR. If CT plenary approves the CR, then the assigned port number will be added to the Table 5-1 (see clause 5). + +# --- 5 Port Number Database + +Table 5-1 represents 3GPP allocated service name and port number registry of 101 ports from 65400 to 65500. 3GPP CT4 maintains the repository. + +Table 5-1: Service Name/port number assigned by 3GPP + +| Service Name | Port Number | Transport Protocol | Description | Inter/Intra interface between entities | Requesting WG | Registration Date | +|--------------|-------------|--------------------|--------------|----------------------------------------------------|---------------|-------------------| +| SLMP | 65400 | UDP | SLM-C-CP | Inter SLM-C hosted UEs | CT1 | 2023-06 (CT#100) | +| MSGin5GMD | 65401 | UDP | MSGin5GMD-UP | Inter MSGin5G Client to MSGin5G Server (MSGin5G-1) | CT1 | 2023-06 (CT#100) | + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|----------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2022-01 | CT4#107e-bis | C4-220265 | | | | Skeleton | 0.0.0 | +| 2022-01 | CT4#107e-bis | C4-220458 | | | | Following tdocs are implemented: C4-220287, C4-220288 and C4-220289. | 0.1.0 | +| 2022-02 | CT4#108e | C4-221587 | | | | Spec number was assigned. | 0.2.0 | +| 2022-03 | CT#95e | CP-220103 | | | | TS presented for information and approval | 1.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96 | CP-221026 | 0001 | - | D | Editorial corrections | 17.1.0 | +| 2022-09 | CT#97e | CP-222033 | 0002 | - | F | Correcting references | 17.2.0 | +| 2023-03 | CT#99 | CP-230058 | 0003 | 1 | B | Allocating new port number | 18.0.0 | +| 2023-06 | CT#100 | CP-231062 | 0004 | - | B | New UDP port number for the SLMP | 18.1.0 | +| 2023-06 | CT#100 | CP-231062 | 0005 | 3 | B | New port number for MSGin5G service | 18.1.0 | \ No newline at end of file diff --git a/gsma/29_series/29831/raw.md b/gsma/29_series/29831/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c38509533e9164b65d915af87694b61a541156ef --- /dev/null +++ b/gsma/29_series/29831/raw.md @@ -0,0 +1,1438 @@ + + +# 3GPP TR 29.831 V18.0.0 (2023-09) + +*Technical Report* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Study on NRF API enhancements to avoid signalling and storing of redundant data (Release 18)** + +![5G ADVANCED logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' with a green signal wave icon above the 'G', and the word 'ADVANCED' in smaller letters to the right. + +5G ADVANCED logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a bold, stylized font. The 'G' has a red signal wave icon below it. Below the logo, the text 'A GLOBAL INITIATIVE' is written in a smaller, all-caps font. + +3GPP logo + +The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and Reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices. + +## **3GPP** + +--- + +Postal address + +--- + +3GPP support office address + +--- + +650 Route des Lucioles - Sophia Antipolis +Valbonne - FRANCE +Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16 + +Internet + +--- + + + +# --- **Copyright Notification** --- + +No part may be reproduced except as authorized by written permission. +The copyright and the foregoing restriction extend to reproduction in all media. + +© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). +All rights reserved. + +UMTS™ is a Trade Mark of ETSI registered for the benefit of its members +3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners +GSM® and the GSM logo are registered and owned by the GSM Association + +# Contents + +| | | +|----------------------------------------------------------------------------------------------------|----| +| Foreword ..... | 5 | +| 1 Scope..... | 6 | +| 2 References..... | 6 | +| 3 Definitions of terms, symbols and abbreviations..... | 6 | +| 3.1 Terms..... | 6 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Baseline..... | 7 | +| 4.1 General ..... | 7 | +| 4.2 Data Storage Overhead..... | 7 | +| 4.3 Signalling Overhead..... | 7 | +| 4.4 Processing Overhead..... | 7 | +| 5 Key Issues ..... | 8 | +| 5.1 Key Issue #1: Avoid Duplicate Configuration, Storage and Transmission of Shareable Data..... | 8 | +| 5.1.1 Description of the use case ..... | 8 | +| 5.1.2 Key issue definition..... | 8 | +| 5.2 Key Issue #2: Signaling overhead of NF discovery responses between PLMNs ..... | 9 | +| 5.2.1 Description of the use case ..... | 9 | +| 5.2.2 Key Issue definition..... | 9 | +| 6 Solutions..... | 9 | +| 6.1 Solution#1: Avoid Duplicate Configuration and Transmission of Shareable Data ..... | 9 | +| 6.1.1 Description ..... | 9 | +| 6.1.2 Impacts on services, entities and interfaces..... | 11 | +| 6.1.3 Pros ..... | 11 | +| 6.1.4 Cons..... | 11 | +| 6.2 Solution#2: Support of NF (Service) Set Profiles ..... | 11 | +| 6.2.1 Description ..... | 11 | +| 6.2.1.1 General..... | 11 | +| 6.2.1.2 NFManagement API Resources..... | 12 | +| 6.2.1.3 NF-Instance Registration ..... | 13 | +| 6.2.1.4 NF Discovery..... | 15 | +| 6.2.1.4.1 Alternative 1 ..... | 15 | +| 6.2.1.4.2 Alternative 2 ..... | 16 | +| 6.2.1.5 NF Set profile subscription ..... | 18 | +| 6.2.1.6 NF Set profile modification / deletion ..... | 19 | +| 6.2.2 Impacts on services, entities and interfaces..... | 20 | +| 6.3 Solution #3: Download Large Volume Data from NRF ..... | 20 | +| 6.3.1 Description ..... | 20 | +| 6.3.2 Impacts on services, entities and interfaces..... | 21 | +| 6.3.3 Pros ..... | 21 | +| 6.3.4 Cons..... | 21 | +| 6.4 Solution #4: Enhancement of inter NRF interaction to optimize shareable data transmission..... | 21 | +| 6.4.1 Description ..... | 21 | +| 6.4.2 Impacts on services, entities and interfaces..... | 22 | +| 6.4.3 Pros ..... | 23 | +| 6.4.4 Cons..... | 23 | +| 6.5 Solution #5: Optimization of shareable data transmission for NF set level shared data..... | 23 | +| 6.5.1 Description ..... | 23 | +| 6.5.2 Impacts on services, entities and interfaces..... | 24 | +| 6.5.3 Pros ..... | 24 | +| 6.5.4 Cons..... | 24 | +| 6.6 Solution #6: NRF Policy Control on Information Exposure for different PLMNs..... | 24 | +| 6.6.1 Description ..... | 24 | + +| | | | +|-------------------------------|---------------------------------------------------------------------------------|-----------| +| 6.6.2 | Impacts on services, entities and interfaces..... | 25 | +| 6.6.3 | Pros ..... | 26 | +| 6.6.4 | Cons..... | 26 | +| 6.7 | Solution#7: List of Shareable Profile Items ..... | 26 | +| 6.7.1 | Description ..... | 26 | +| 6.7.2 | Impacts on services, entities and interfaces..... | 27 | +| 6.7.3 | Pros ..... | 27 | +| 6.7.4 | Cons..... | 27 | +| 6.8 | Solution #8: Single Subscription of NF Profile Change from an NF Set ..... | 27 | +| 6.8.1 | Description ..... | 27 | +| 6.8.2 | Impacts on services, entities and interfaces..... | 28 | +| 6.8.3 | Pros ..... | 28 | +| 6.8.4 | Cons..... | 28 | +| 6.9 | Solution #9: Single NF Profile Change Notification to an NF Set ..... | 28 | +| 6.9.1 | Description ..... | 28 | +| 6.9.2 | Impacts on services, entities and interfaces..... | 29 | +| 6.9.3 | Pros ..... | 29 | +| 6.9.4 | Cons..... | 29 | +| 6.10 | Solution #10: Simplifying the NF service discovery response of inter-PLMN ..... | 29 | +| 6.10.1 | Description ..... | 29 | +| 6.10.2 | Impacts on services, entities and interfaces..... | 30 | +| 6.10.3 | Pros ..... | 31 | +| 6.10.4 | Cons..... | 31 | +| 6.11 | Solution 11: Avoid large configuration of UE Routing Indicator..... | 31 | +| 6.11.1 | Description ..... | 31 | +| 6.11.2 | Impacts on services, entities and interfaces..... | 31 | +| 6.11.3 | Pros ..... | 31 | +| 6.11.4 | Cons..... | 31 | +| 6.12 | Solution #12: Support for NF Set level shared data..... | 32 | +| 6.12.1 | Description ..... | 32 | +| 6.12.2 | Impacts on services, entities and interfaces..... | 34 | +| 6.12.3 | Pros ..... | 34 | +| 6.12.4 | Cons..... | 34 | +| 7 | Evaluations..... | 34 | +| 7.1 | Evaluation of Solutions for Key Issue#1..... | 34 | +| 7.1.1 | Synchronization of Shareable Data ..... | 34 | +| 7.1.1.1 | Configured Shareable Data..... | 34 | +| 7.1.1.2 | Discovered Shareable Data..... | 35 | +| 7.1.1.3 | Change of Shareable Data..... | 35 | +| 7.1.2 | Storage requirements ..... | 35 | +| 7.1.2.1 | Storage of configured data..... | 35 | +| 7.1.2.2 | Storage of discovered data..... | 35 | +| 7.1.3 | Discovery procedure..... | 36 | +| 7.1.4 | Which data should be shareable?..... | 36 | +| 7.1.5 | New NF services operations ..... | 36 | +| 7.1.6 | Applicability Scope ..... | 36 | +| 7.1.7 | Backward compatibility..... | 37 | +| 7.1.8 | Comparison..... | 37 | +| 7.2 | Evaluation of Solutions for Key Issue#2..... | 38 | +| 8 | Conclusions..... | 39 | +| 8.1 | Conclusion of Solutions for Key Issue#1..... | 39 | +| 8.2 | Conclusion of Solutions for Key Issue#2..... | 39 | +| Annex A (informative): | Change history..... | 40 | + +# Foreword + +This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP). + +The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version x.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 or greater indicates TSG approved document under change control. +- y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. +- z the third digit is incremented when editorial only changes have been incorporated in the document. + +In the present document, modal verbs have the following meanings: + +- shall** indicates a mandatory requirement to do something +- shall not** indicates an interdiction (prohibition) to do something + +The constructions "shall" and "shall not" are confined to the context of normative provisions, and do not appear in Technical Reports. + +The constructions "must" and "must not" are not used as substitutes for "shall" and "shall not". Their use is avoided insofar as possible, and they are not used in a normative context except in a direct citation from an external, referenced, non-3GPP document, or so as to maintain continuity of style when extending or modifying the provisions of such a referenced document. + +- should** indicates a recommendation to do something +- should not** indicates a recommendation not to do something +- may** indicates permission to do something +- need not** indicates permission not to do something + +The construction "may not" is ambiguous and is not used in normative elements. The unambiguous constructions "might not" or "shall not" are used instead, depending upon the meaning intended. + +- can** indicates that something is possible +- cannot** indicates that something is impossible + +The constructions "can" and "cannot" are not substitutes for "may" and "need not". + +- will** indicates that something is certain or expected to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- will not** indicates that something is certain or expected not to happen as a result of action taken by an agency the behaviour of which is outside the scope of the present document +- might** indicates a likelihood that something will happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +**might not** indicates a likelihood that something will not happen as a result of action taken by some agency the behaviour of which is outside the scope of the present document + +In addition: + +**is** (or any other verb in the indicative mood) indicates a statement of fact + +**is not** (or any other negative verb in the indicative mood) indicates a statement of fact + +The constructions "is" and "is not" do not indicate requirements. + +# --- 1 Scope + +The present document identifies deficiencies of the NRF APIs as specified in 3GPP TS 29.510 [2] and studies potential optimization solutions. The document will focus on the following aspects: + +- avoid data storage overhead in the NRF due to many NFs (especially NFs from the same NF set) registering with identical information, +- avoid signalling overhead (both in terms of payload size and number of HTTP requests) due to discovery responses containing lots of duplicate information and due to the number of data change notification sent when duplicated data are changed one by one. +- avoid processing overhead (both at NRF and its consumers) resulting e.g. from signalling overhead. + +# --- 2 References + +The following documents contain provisions which, through reference in this text, constitute provisions of the present document. + +- References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. +- For a specific reference, subsequent revisions do not apply. +- For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*. + +[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". + +[2] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". + +[3] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". + +# --- 3 Definitions of terms, symbols and abbreviations + +## 3.1 Terms + +For the purposes of the present document, the terms given in 3GPP TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in 3GPP TR 21.905 [1]. + +void + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +void + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TR 21.905 [1]. + +void + +# --- 4 Baseline + +## 4.1 General + +In order to assist mobile network's needs of service governance (e.g. topology selection, signalling routing), the NRF API system is designed to support mechanisms including service registration, discovery, subscription, and notification. However, in current NRF framework, duplicated network-level attribute values and UE ranges are separately maintained between different NFs, and transmissions of full NF profiles are repeatedly performed, resulting in overhead of data storage, signalling, and processing. See Section 4.2, 4.3, and 4.4 for details. + +## 4.2 Data Storage Overhead + +Firstly, in the mobile network, to achieve load balancing and high availability, it is common that multiple NFs serving the same geographical region (e.g., NFs within a same NF Set) are assigned by O&M with identical network-level service attribute values (e.g. TAI-list, DNN). In this case, the NFs' registration to a same NRF introduces redundant storage of many partially or fully duplicated NF profiles. + +Secondly, current NRF API system maintains UE identifier ranges in NFs, although the attribute of the ranges is a global concept rather than per-NF's. In large-scale network, the attribute can contain millions of UEs and achieve several million bytes, resulting in NFs' storage overhead. Moreover, when these NFs perform registration, multiple copies of the same ranges will occur simultaneously in the NRF's storage. + +## 4.3 Signalling Overhead + +Data size is the first reason for signalling overhead. The current NRF API system supports only single-layer query view. During registration, discovery and notification processes, full NF profiles with huge size have to be submitted or retrieved at one time. Take signalling routing in some large-scale network as an example, huge full information is provided, containing millions of UE ranges, leading to huge-size (typically several million bytes) frame overhead. Moreover, as stated in Section 4.2, these huge NF profiles can contain a lot of duplicated data, which further makes the overhead unnecessary. + +Transmission range and frequency is another two reasons for signalling overhead. In current NRF framework, even the tiny change of a subscribed network element can trigger large-scale notifications. To distribute the full NF profile to all related subscribers simultaneously, the NRF can easily trigger a push storm and become a performance bottleneck. + +## 4.4 Processing Overhead + +The receiving, parsing, and handling of redundant information as stated in Section 4.2 and 4.3 apparently increase processing overhead. Moreover, when network elements are pulled up in batches and concurrent registration or discovery happens, the intensive transmission of many full NF profiles will make not only the NRF but also NFs suffer from performance fluctuations. + +# 5 Key Issues + +## 5.1 Key Issue #1: Avoid Duplicate Configuration, Storage and Transmission of Shareable Data + +### 5.1.1 Description of the use case + +In existing NF profile stored in the NRF, operator may configure same data part of the NF profile with same value to multiple NFs, as per network management requirement. + +For example, multiple NFs (e.g. AUSF/UDM/PCF/BSF/CHF) may be configured to serve same range of UEs and thus be configured with same UE identifier ranges (e.g. SUPI/GPSI/External ID ranges) in each NF profile. These UE identifier ranges configured in the NF profile may have large volume, and operator needs to configure such large volume data to those indicated multiple NFs (e.g. same type of NFs in a NF Set, or even different type of NFs). + +As another example, NFs of an NF set share typically a significant set of common data. Common information include the authorization parameters (“allowedxxx parameters”), the served PLMN or SNPN, the supported S-NSSAIs, SCP information, part or all of NF specific data such as amfInfo (e.g. list of TAIs), udminfo (e.g. subscriber identity ranges), smfinfinfo (e.g. all S-NSSAIs/DNNs configuration supported by the SMF set). + +Such duplicate data (e.g. UE identifier ranges or NF instance profiles) introduces complexity to the NRF API and OAM system (e.g. to manage the configuring, updating, and downloading of duplicate data (e.g. UE identifier ranges or NF instance profiles). Meanwhile, this duplicate data (e.g. UE identifier ranges or NF instance profiles) reduces the signaling efficiency of NRF API, especially when the duplicate data (e.g. UE identifier ranges or NF instance profiles) have large volume e.g. upper to x million octets. + +### 5.1.2 Key issue definition + +This key issue will study the following aspects: + +- Which data part in the NF profile can be organized as shared data and used by multiple NFs and whether such categorization needs to be standardized? +- How to configure/register shared data (e.g. UE identifier ranges) in the NRF so that multiple NF profiles can share the same data (e.g. UE identifier ranges) and avoid duplicate storage/configuration/registration; +- How to optimize download of shared data (e.g. UE identifier ranges) to the requesting NF during NF discovery procedure or NF profile change notification procedure; +- How to handle the download shared data (e.g. UE identifier ranges) with large data volume, e.g. upper to x million octets (extremely upper to 16 million octets exceeding the maximum data size of JSON object). +- How to leverage the NF (Service) Set concept to avoid duplicate configuration and storage of NF profiles within the NFs belonging to the same NF set, and to avoid duplicate transmission of NF profiles for NFs belonging to the same NF set. +- How the shared data can be obtained by the NRF in case the shared data corresponding to the shared-data ID is not available in the NRF. +- How to avoid sending multiple NF profile change notifications from/to NF-Instances which may or may not be within an NF-Set, when a common configuration parameter changes in the NF-Profile. + +## 5.2 Key Issue #2: Signaling overhead of NF discovery responses between PLMNs + +### 5.2.1 Description of the use case + +In the NF discovery response, NRF will return the NF profiles matching the search criteria indicated by the query parameters of the discovery request, e.g. all the list of ranges of SUPIs whose profile data is available in the UDM instance, etc. + +Take SUPI as an example. + +The AMF carries SUPI as one of the main query parameters in the NF discovery request, and initiates NF discovery to the NRF to obtain the information of the UDMs where the SUPI profile is stored. If the query parameters match successfully, the NRF will return the correct UDMs, and will carry all the list of ranges of SUPIs whose profile data is available in the UDM instance. That results in large response messages, even exceeding 2 million octets in some network deployments. + +The AMF completely stores the data in the response message in the cache, therefore other SUPIs can be searched locally in the subsequent service discovery procedure, avoiding excessive signaling interaction with the NRF. + +However, if the AMF and NRF belong to different PLMNs, the ranges of SUPIs in the cache of AMF might not work. Because there are relatively few users of different SUPI accessing the network from different PLMN. Additionally, the storage costs of saving NF profiles of PLMNs around the world would be high. + +In another scenario, when AMF in VPLMN queries SMF in HPLMN, NRF will include all “taiList” and “taiRangeList” served by the H-SMF in the NF discovery response message. However, these TAIIs are useless for the AMF in VPLMN. + +Consequently, these large response messages between different PLMNs might cause unnecessary signaling overhead and data storage overhead. + +It's recommended considering how to simplify these numerous parameters in NF discovery response of roaming scenarios, e.g., plmnList, sNssais, perPlmnSnsaiList, nsiList, supiRanges, gpsiRanges, routingIndicators, externalGroupIdentifiersRanges, internalGroupIdentifiersRanges, sucilInfos, taiList, taiRangeList, dnnList, etc. + +### 5.2.2 Key Issue definition + +This key issue will study the following aspects: + +- Which parameters of NF discovery responses between PLMNs can be simplified and how to simplify them. +- How the NRF processes requests from different PLMNs differently, e.g. AMF of some PLMNs might need the whole supiRanges UDM served. +- How the NF processes simplified response from NRF. + +# --- 6 Solutions + +## 6.1 Solution#1: Avoid Duplicate Configuration and Transmission of Shareable Data + +### 6.1.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Duplicate configuration may exist in various data types (e.g. UE identifier ranges) among different NF (or NF service) profiles. Possible shareable data in NF (or NF service) profile are listed in clause 6.7. + +**Editor's Note:** It is FFS that whether and which data types need to be defined as standardized shared data types. + +To avoid duplicate configuration and transmission of shareable data (e.g. UE identifier ranges), the shareable data can be organized as shared data which is separately stored outside of the NF profile. One NF profile using the shared data (e.g. UE identifier ranges) should carry a reference (i.e. shared data identifier) pointing to that shared data. An NF may be associated with multiple shared data with different types, thus multiple instance of shared data identifiers may be registered in one NF profile. + +The following enhancements to data structure of the NRF API are proposed: + +- Define individual data structures for each type of shared data; + - For example, define a SharedIdRanges data structure, which carries the identifier of the SharedIdRanges and a list of IMSI/MSISDN/SUPI/GPSI/External-Group-ID/Internal-Group-ID ranges, etc; +- Define a SharedDataIdentifier data type as identifier of each type of shared data; + - For example, the SharedIdRanges data structure includes an "sharedDataId" attribute of type SharedDataIdentifier, to indicate the unique identifier of that SharedIdRanges; +- Add attribute in the NF profile to refer to the separately stored shared data; + - For example, add "sharedDataReferences" attribute in the NFProfile of an NF to contain a list of shared data identifiers to multiple types of shared data, and within the "sharedDataReferences" container a "sharedIdRangeRef" attribute refers to one SharedIdRanges. Or, add one attribute "sharedIdRangeRef" directly in the AusfInfo/UdmInfo/PcfInfo/BsfInfo/ChfInfo/etc. to indicate the reference to a SharedIdRanges; + +The following enhancements to resource tree of the NRF API are proposed: + +- Define individual resources in the resource tree of the NRF API, to provide creation/update/deletion/retrieval operation to each type of shared data; + - For example, a separate resource "/shared-id-ranges" is defined to represent the collection of SharedIdRanges. A POST operation to the "/shared-id-ranges" resource will create an instance of SharedIdRanges. A GET operation to the "/shared-id-ranges/{sharedDataRef}" will retrieve the content of the SharedIdRanges identified by the {sharedDataRef}. +- A parent resource "/shared-data" may be used to umbrella all kinds of shared data types. In this case, the resource "/shared-data/shared-id-ranges" represents the collection of SharedIdRanges. + +To configure the shared data in the NRF, the following methods should be used: + +- An operator should arrange those shareable data (e.g. UE identifier ranges) to shared data in well-organized manner, and register those shared data to the NRF; + - The registration of shared data to the NRF may be done by the operator management system, or by an operator granted NF (e.g. a special UDR). In the latter case, the granted NF invokes POST method to the resource representing the collection of that type of shared data (e.g. to the resource "/shared-id-ranges") to register the shared data. +- An NF can register a reference (i.e. the shared data identifier) to one shared data in its own NF profile, if the NF is configured to share some data with other NFs and is aware of the shared data identifier. Multiple shared data identifiers may be registered in the NF profile to refer to different type of shared data; + +To download NF profiles with shared data from the NRF, the following methods should be used: + +- A request NF should indicate its support for the SharedData feature to the NRF, in the NF discovery procedure or subscription to NF profile change notification. +- During NF discovery or NF profile change notification procedure, the NRF and the request NF behaves as the following: + - For a request NF supporting the SharedData feature, the NRF only indicates the shared data identifier(s) referring to the shared data (e.g. shared data identifier to a SharedIdRanges) in the NF profile, when sending NF profile to the request NF. + +- For a request NF not supporting SharedData feature, the NRF shall translate the shared data identifier included in the NF profile to the content of existing attributes in the NF profile, when sending NF profile to the request NF. +- When receiving NF profile with shared data identifier(s), the request NF shall separately invoke GET operation to the NRF resource representing the shared data to retrieval the shared data, if not yet get the shared data. + +### 6.1.2 Impacts on services, entities and interfaces + +NRF: + +- extend the existing NRF API to separately organize the shared data, and provide individual operations to the resource representing the shared UE identifier ranges. + +NF: + +- invoke separate retrieval to the resource representing the shared data, after receiving NF profile indicating a reference to the shared data from the NRF. + +### 6.1.3 Pros + +This solution provides an efficient way to configure the shared data to multiple NF profiles, and avoid duplicate transmission of same data configured in multiple NF profiles. + +### 6.1.4 Cons + +The NRF needs to differentiate the handling to a request NF supporting or not supporting SharedData feature. + +## 6.2 Solution#2: Support of NF (Service) Set Profiles + +### 6.2.1 Description + +#### 6.2.1.1 General + +This solution is to address Key Issue #1 with a focus on leveraging the NF (Service) Set concept to avoid duplicate configuration, storage and transmission of NF profiles for NFs belonging to the same NF set. + +This solution proposes optional optimizations to the Nnrf\_NFManagement and Nnrf\_NFDiscovery APIs to be controlled by a new feature "NF Set Profile Support". + +Consumers of the Nnrf\_NFManagement service should discover the NRF's support of the new feature "NF Set Profile Support" using the HTTP OPTION method as already defined in 3GPP TS 29.510 [2] clause 5.2.2.2.2. + +Consumers of the Nnrf\_NFDiscovery service shall indicate in discovery request messages whether they support the new feature "NF Set Profile Support". + +This solution proposes two alternative options with regard to NF Set profile provisioning at the NRF: + +- A) NF Set profiles are registered at the NRF by any NF instance that belongs to the corresponding NF set. +- B) NF Set profiles are configured at the NRF by OAM. + +It is a PLMN operator choice to deploy option A) or B). + +This solution proposes two alternatives with regard to NF discovery: + +- 1) The NF Set profile is conveyed from NRF to the consumer within the discovery response message that conveys NF instance profiles which contain the corresponding NF Set Profile ID. +- 2) The NF Set profile is separately retrieved by the NRF consumer when needed. + +#### 6.2.1.2 NFManagement API Resources + +This solution proposes to extend the NFManagement API with new resources "nf-set" allowing NF consumers to retrieve (applicable only for alternative 2, see clause 6.2.1.1) NF Profile Set information from the NRF. In addition (only for option A, see clause 6.2.1.1) the new resource "nf-set" allows NF consumers (i.e. NF instances belonging to an NF Set) to register NF Set profile information (i.e. profile information common to all NF instances belonging to the set) at the NRF using the PUT method. Modification of the resource's representation using PATCH and deletion of the resource using DELETE will also be supported. + +Proposed modifications to the URI structure of the NFManagement API are shown in red in figure 6.2.1.2-1: + +![Diagram showing the URI structure of the NFManagement API. The root is {apiRoot}/nnrf-nfm/v1. It branches into three main resources: /nf-instances, /nf-sets, and /subscriptions. /nf-instances has a sub-resource /{nfInstanceID}. /nf-sets has a sub-resource /{nfSetID}. /subscriptions has a sub-resource /{subscriptionID}.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnrf-nfm/v1"] --- NFInstances["/nf-instances"]; Root --- NFSets["/nf-sets"]; Root --- Subscriptions["/subscriptions"]; NFInstances --- NFInstanceID["/{nfInstanceID}"]; NFSets --- NFSetID["/{nfSetID}"]; Subscriptions --- SubscriptionID["/{subscriptionID}"]; +``` + +Diagram showing the URI structure of the NFManagement API. The root is {apiRoot}/nnrf-nfm/v1. It branches into three main resources: /nf-instances, /nf-sets, and /subscriptions. /nf-instances has a sub-resource /{nfInstanceID}. /nf-sets has a sub-resource /{nfSetID}. /subscriptions has a sub-resource /{subscriptionID}. + +**Figure 6.2.1.2-1** + +Proposed modifications to the Resource and Methods overview are shown in red in table 6.2.1.2-1: + +Table 6.2.1.2-1 + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| nf-instances (Store) | /nf-instances | GET | Read a collection of NF Instances. | +| | | OPTIONS | Discover the communication options supported by the NRF for this resource. | +| nf-instance (Document) | /nf-instances/{nfInstanceID} | GET | Read the profile of a given NF Instance. | +| | | PUT | Register in NRF a new NF Instance, or replace the profile of an existing NF Instance, by providing an NF profile. | +| | | PATCH | Modify the NF profile of an existing NF Instance. | +| | | DELETE | Deregister from NRF a given NF Instance. | +| nf-set (Document) | /nf-sets/{nfSetID} | GET only for alternative 2 | Read the profile of a given NF Set. | +| | | PUT only for option A | Register in NRF a new NF Set, or replace the profile of an existing NF Set, by providing an NF set profile. | +| | | PATCH only for option A | Modify the NF set profile of an existing NF Set. | +| | | DELETE only for option A | Deregister from NRF a given NF Set. | +| subscriptions (Collection) | /subscriptions | POST | Creates a new subscription in NRF to newly registered NF Instances. | +| subscription (Document) | /subscriptions/{subscriptionID} | PATCH | Updates an existing subscription in NRF. | +| | | DELETE | Deletes an existing subscription from NRF. | +| Notification Callback | {nfStatusNotificationUri} | POST | Notify about newly created NF Instances, or about changes of the profile of a given NF Instance. | + +#### 6.2.1.3 NF-Instance Registration + +For option A, the NF-Set profile can be registered (is so needed) by any NF instance from the NF Set during NF-Instance registration as shown in figure 6.2.1.3-1. (It is assumed that all NF instances belonging to the same NF Set share some common data e.g. using UDSF. The NF-Set profile would be part of these common data.) + +For option B, NF-Set profiles are configured at the NRF by OAM and need not be conveyed from the registering NF instance to the NRF. + +![Sequence diagram illustrating the registration of an NF instance to an NRF. The diagram shows two lifelines: 'NF Set 1' (containing 'NF instance n' and 'NF instance 1') and 'NRF'. The sequence of messages is: 1. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-1 specific attributes) from NF instance 1 to NRF; 2. 400 Bad Request (Problem details: missing NF Set Profile) from NRF to NF instance 1; 3. PUT .../nf-sets/{nfSetID} (NF Set Profile) from NF instance 1 to NRF; 4. 201 Created (NF Set Profile) from NRF to NF instance 1; 5. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance specific attributes) from NF instance n to NRF; 6. 201 Created (NF Profile) from NRF to NF instance n; 7. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-n specific attributes) from NF instance n to NRF; 8. 201 Created (NF Profile) from NRF to NF instance n.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant NF_Set_1 as NF Set 1 + participant NRF + Note right of NF_Set_1: NF instance n | NF instance 1 + NF_Set_1->>NRF: 1. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-1 specific attributes) + NRF-->>NF_Set_1: 2. 400 Bad Request (Problem details: missing NF Set Profile) + NF_Set_1->>NRF: 3. PUT .../nf-sets/{nfSetID} (NF Set Profile) + NRF-->>NF_Set_1: 4. 201 Created (NF Set Profile) + NF_Set_1->>NRF: 5. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance specific attributes) + NRF-->>NF_Set_1: 6. 201 Created (NF Profile) + NF_Set_1->>NRF: 7. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-n specific attributes) + NRF-->>NF_Set_1: 8. 201 Created (NF Profile) + +``` + +Sequence diagram illustrating the registration of an NF instance to an NRF. The diagram shows two lifelines: 'NF Set 1' (containing 'NF instance n' and 'NF instance 1') and 'NRF'. The sequence of messages is: 1. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-1 specific attributes) from NF instance 1 to NRF; 2. 400 Bad Request (Problem details: missing NF Set Profile) from NRF to NF instance 1; 3. PUT .../nf-sets/{nfSetID} (NF Set Profile) from NF instance 1 to NRF; 4. 201 Created (NF Set Profile) from NRF to NF instance 1; 5. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance specific attributes) from NF instance n to NRF; 6. 201 Created (NF Profile) from NRF to NF instance n; 7. PUT .../nf-instances/{NFInstanceID} (nfSetId, only NF instance-n specific attributes) from NF instance n to NRF; 8. 201 Created (NF Profile) from NRF to NF instance n. + +Figure 6.2.1.3-1 + +1. NF instance of a particular NF set sends a PUT request to register the NF instance profile at the NRF by creating a resource with a URI representing the NF Instance ID. The variable `nfInstanceID` represents the identifier of the registering NF instance. The registering NF instance registers only its NF Set ID and NF instance specific attributes, and not the entire NFSet profile. +2. On receipt of PUT request, if the NRF determines that there is no corresponding NF Set profile already registered (option A) or configured (option B) for the NF Set ID in the NRF, it replies with an error message 400 Bad Request (Problem details: missing NF Set Profile). +3. However, this step and also steps 3, 4 and 5 are skipped if on receipt of PUT request in step 1, NRF determines that there is already a registered or configured NF Set profile for the NF Set ID of the registering NF instance, e.g. in case another NF instance belonging to the same NF set already registered to the NRF or the NF set profile was configured by OAM at the NRF i.e. as per the steps explained in 3 and 4. +4. In case NF instance receives error message in step 2, with details 'missing NF Set Profile', for option A: NF instance sends a PUT request to the NRF to register the NF Set Profile, by creating a resource representing the NF set profile with a URI identifying the NF set id e.g. `.../nf-sets/{nfSetID}` (NF Set Profile). For example, this may be the case if this is the first NF instance in this NF set registering to the NRF. for option B: NF instance reports an error to OAM, and the NF instance should retry registration with its full NF instance profile, i.e. not making use of the "NF Set Profile Support" feature. +5. On success, NRF replies with "201 Created". The payload body of the PUT response contains the representation of the created resource (NF set profile) and the "Location" header contains the URI of the created resource. + +Same as 1. + +6. On success, NRF replies with "201 Created". The payload body of the PUT response contains the representation of the created resource (NF profile) and the "Location" header contains the URI of the created resource. +7. Other NF instance(s) of the particular NF set sends a PUT request to register its NF instance, as defined in step 1. +8. On success, in response to the above step 7, NF instance(s) of the particular NF set receives NRF replies with "201 Created". + +#### 6.2.1.4 NF Discovery + +##### 6.2.1.4.1 Alternative 1 + +NF service consumer indicates "Set Profile support" in the NF discovery request in order for NRF to provide optimal response, including the NF Set profile. Figure 6.2.1.4.1-1 shows an example call flow. + +![Sequence diagram showing NF Discovery Request by NRF consumer supporting NF Set Profile. The diagram illustrates the interaction between an NRF consumer and an NRF. Step 1: The NRF consumer sends a GET request to /nf-instances with query parameters including Set Profile Support indication. Step 2: The NRF determines that NF instances 1..n from the NF set 1 match the request, have registered using the Set Profile Support feature, and that the NRF consumer supports the Set Profile Support feature. Step 3: The NRF returns a 200 OK response containing profiles for NF instances 1..n and the NF Set 1 profile.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` +sequenceDiagram + participant NRF_consumer as NRF consumer + participant NRF + Note right of NRF: 2. NRF determines that + - NF instances 1..n from the NF set 1 match the request + - NF instances 1..n have registered using the Set Profile Support feature + - The NRF consumer supports the Set Profile Support feature + NRF_consumer->>NRF: 1. GET .../nf-instances ? + NRF-->>NRF_consumer: 3. 200 OK (NF instance 1 Profile containing nfSetID=1 and only NF instance 1-specific attributes, ... NF instance n Profile containing nfSetID=1 and only NF instance n-specific attributes, NF Set 1 Profile containing attributes common to NF instances 1..n) +``` + +Sequence diagram showing NF Discovery Request by NRF consumer supporting NF Set Profile. The diagram illustrates the interaction between an NRF consumer and an NRF. Step 1: The NRF consumer sends a GET request to /nf-instances with query parameters including Set Profile Support indication. Step 2: The NRF determines that NF instances 1..n from the NF set 1 match the request, have registered using the Set Profile Support feature, and that the NRF consumer supports the Set Profile Support feature. Step 3: The NRF returns a 200 OK response containing profiles for NF instances 1..n and the NF Set 1 profile. + +Figure 6.2.1.4.1-1: NF Discovery Request by NF Service Consumer supporting NF Set Profile + +1. The NF Service Consumer sends GET request to the resource URI "nf-instances" collection resource. The input filter criteria for the discovery request are included in query parameters. It provides "Set Profile Support" indicating to the NRF that it supports the "NF Set Profile Support" feature. +2. Based on the received input of "NF Set Profile Support", the NRF determines that the NF service consumer supports NF set profiles and that requested NFInstance(s) belong to a particular NF Set e.g. NF Set 1. +3. On success, "200 OK" is returned. In its response, the NRF includes an array of NF Profile objects, that satisfy the search filter criteria e.g., all NF Instances offering a certain NF Service name, and additionally includes the NF Set Profile data. NRF does not provide NF Set profile attributes in each of the NF Instance Profile, but instead it indicates NF Set ID in each NF Instance profile. + +##### 6.2.1.4.2 Alternative 2 + +NF service consumer indicates "Set Profile support" in the NF discovery request in order for NRF to provide optimal response, but not including the NF Set profile. + +Figure 6.2.1.4.2-1 shows an example call flow, where the NRF does not return the NF Set Profile data in the NF Discovery Response. If the NF consumer does not already have the NF Set Profile corresponding to the NF Set ID indicated in the returned NF profiles, the NF service consumer separately requests to get it from NRF. + +![Sequence diagram showing NF Discovery Request by NF Service Consumer supporting NF Set Profile (variant).](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NRF consumer + participant NRF + Note right of NRF: 2. NRF determines that +- NF instances 1..n from the NF set 1 match the request +- NF instances 1..n have registered using the Set Profile Support feature +- The NRF consumer supports the Set Profile Support feature + NRF consumer->>NRF: 1. GET .../nf-instances ? + NRF-->>NRF consumer: 3. 200 OK (NF instance 1 Profile containing nfSetID=1 and only NF instance 1-specific attributes, +... +NF instance n Profile containing nfSetID=1 and only NF instance n-specific attributes,) + Note left of NRF consumer: 4. NRF consumer determines that it has no stored information about NF Set 1 + NRF consumer-->>NRF: 5. GET .../nf-sets/{NF Set 1 ID} + NRF-->>NRF consumer: 6. 200 OK (NF Set 1 Profile) + +``` + +The sequence diagram illustrates the interaction between an NRF consumer and an NRF. The process begins with the NRF consumer sending a GET request to `.../nf-instances` with query parameters including a Set Profile Support indication. The NRF responds with a 200 OK, containing profiles for NF instances 1 to n, each with `nfSetID=1` and instance-specific attributes. Before processing this response, the NRF consumer determines it has no stored information about NF Set 1. It then sends a GET request to `.../nf-sets/{NF Set 1 ID}`, and the NRF returns a 200 OK with the NF Set 1 Profile. + +Sequence diagram showing NF Discovery Request by NF Service Consumer supporting NF Set Profile (variant). + +**Figure 6.2.1.4.2-1: NF Discovery Request by NF Service Consumer supporting NF Set Profile (variant)** + +1. Same as in Figure 6.2.1.4.1-1. +2. Same as in Figure 6.2.1.4.1-1. +3. On success, "200 OK" is returned. In its response, the NRF includes an array of NF Profile objects, that satisfy the search filter criteria e.g., all NF Instances offering a certain NF Service name. NRF does not provide NF Set profile attributes in each of the NF Instance Profile, but instead it indicates NF Set ID in each NF Instance profile. Here (i.e. in this alternative approach) the NRF does not return the NF set profile (as it might already be available to the NRF consumer from previous requests). +4. On receipt of NRF response in step 3, NF Service consumer determines that it does not already have any stored information about NF Set 1 ID. +5. NF Service consumer sends a request to get NF Set profile corresponding to NF Set 1 ID. As a further optimization retrieval of the NF Set profile and subscription to profile change notifications may be done with a single request (POST). +6. On success, "200 OK" is returned, along with NF Set 1 profile + +#### 6.2.1.5 NF Set profile subscription + +After having received the NF Set profile (see step 3 in figure 6.2.1.4-1 or step 6 in figure 6.2.1.4-2) the NF service consumer may want to subscribe to NF Set Profile Change Notifications, see figure 6.2.1.5-1. + +![Sequence diagram for NF Set profile subscription](9cd90f495b95ad2116ff780248c26d95_img.jpg) + +``` +sequenceDiagram + participant NRF consumer + participant NRF + Note right of NRF: 2. NRF stores the subscription + NRF consumer->>NRF: 1. POST .../subscriptions (SubscriptionData including nf-set ID) + NRF-->>NRF consumer: 3. 201 Created SubscriptionData +``` + +The diagram illustrates a sequence of interactions between an NRF consumer and an NRF. The sequence starts with the NRF consumer sending a POST request to the NRF for subscriptions, including SubscriptionData with an nf-set ID. The NRF then stores the subscription, indicated by a note. Finally, the NRF returns a 201 Created SubscriptionData response to the consumer. + +Sequence diagram for NF Set profile subscription + +**figure 6.2.1.5-1** + +1. NF Service Consumer subscribes by sending a POST request to the resource URI representing the "subscriptions" collection resource, with subscription data identifying the NF status changes to be notified, e.g. identifying the need to notify NF status changes affecting the NF service producers of a given NF set. +2. On receipt of the request with NF Set profile support indication in step 1, NRF determines that NF service consumer supports NF set profiles and stores the subscription (including the indication that the subscribing NF supports NF set profiles). +3. On success, "201 Created" is returned to the NF Consumer. + +Note: NF Set Profile retrieval and subscription to change notifications can be optimized using a single request message (POST). See clause 6.2.1.4 step 5. + +#### 6.2.1.6 NF Set profile modification / deletion + +Figure 6.2.1.6-1 describes the procedure to modify/delete the NF set profile of NF instances already registered in the NRF (only applicable for option A, see clause 6.2.1.1). Modification is done by providing the updated NF set profile to the NRF. The update operation may apply to the whole NF set profile i.e. complete replacement of the existing profile by a new profile using PUT, or it may apply only to a subset of the parameters of the NF set profile i.e. including adding/deleting/replacing attributes of the registered NF set profile using PATCH. Deletion is done by using DELETE. + +The procedure in figure 6.2.1.6-1 also enables the NRF to notify subscribed NF consumers supporting NF Set profiles of changes (modification or deletion) done to an NF set profile (applicable to both options A and B). + +![Sequence diagram for NF Set profile modification/deletion](a734898ce18e972938949637c32a34f4_img.jpg) + +``` +sequenceDiagram + participant NF_Set_1 as NF Set 1 + subgraph NF_Set_1 + direction LR + NF_instance_n[NF instance n] + NF_instance_1[NF instance 1] + end + participant NRF + participant NRF_consumer as NRF consumer + + Note right of NRF: 3. NRF determines that notifications need to be sent to subscribing consumers + + NF_Set_1->>NRF: 1. PATCH or PUT or DELETE (changes to NF Set 1 profile) + NRF-->>NF_Set_1: 2. 200 OK / 204 No Content + NRF->>NRF_consumer: 4. POST .../{callback URI}(changes to NF Set Profile 1) + NRF_consumer-->>NRF: 5. 204 No Content +``` + +The diagram illustrates the interaction for NF Set profile modification or deletion. It starts with an 'NF Set 1' box containing 'NF instance n' and 'NF instance 1'. An arrow labeled '1. PATCH or PUT or DELETE (changes to NF Set 1 profile)' goes from this box to an 'NRF' box. A return arrow labeled '2. 200 OK / 204 No Content' goes from 'NRF' back to 'NF Set 1'. Below 'NF Set 1' is an 'NRF consumer' box. A box labeled '3. NRF determines that notifications need to be sent to subscribing consumers' is shown next to the 'NRF' lifeline. An arrow labeled '4. POST .../{callback URI}(changes to NF Set Profile 1)' goes from the 'NRF' to the 'NRF consumer'. A return arrow labeled '5. 204 No Content' goes from the 'NRF consumer' back to the 'NRF'. + +Sequence diagram for NF Set profile modification/deletion + +figure 6.2.1.6-1 + +1. A NF instance from Set 1 performs an update / deletion of the NF Set Profile by sending a PATCH or PUT or DELETE request to the resource URI representing the NF set profile. For update, it provides the changes corresponding to the NF Set Profile. +2. On success, "200 OK" or "204 No Content" is returned. +3. Triggered by steps 1-2 (for option A) or by OAM provisioning (for option B) the NRF determines that it needs to send NFStatusNotify to subscribed NF Service Consumer(s) as shown in figure 6.2.1.5-1. + +4. NRF sends NFStatusNotify to subscribed NF Service Consumer(s) (see clause 6.2.1.5) with changes to NF set profile data with update attributes / delete indication. + +### 6.2.2 Impacts on services, entities and interfaces + +NRF: + +- Extend the Nnrf\_NFManagement and Nnrf\_NFDiscovery APIs with the new feature "NF Set Profile Support" +- Support a new resource "nf-set" and offer methods to NRF consumers to read and subscribe (only alternative 2), and (only option A) to register, modify, and delete the new resource. +- Support sending of change notifications to consumers having subscribed +- Mediate between supporting NF consumers registering (and modifying) NF SET profiles and non supporting NF consumers discovering (and subscribing) registered profiles. + +NRF consumer: + +- Support the new feature when consuming Nnrf\_NFManagement or Nnrf\_NFDiscovery services +- Register /Update / Delete NF Set Profile at the NRF when needed (only option A). +- Retrieve and subscribe to NF Set profiles + +OAM procedures: + +- Configuration impacts to enable provisioning of NF Set profiles at NF instances. +- Configuration impacts to enable provisioning of NF Set profiles at the NRF (option B only). + +## 6.3 Solution #3: Download Large Volume Data from NRF + +### 6.3.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Some special sub-item in the NF profile may be configured with a huge content list. A typical example is the IMSI/SUPI list configured in the AUSF/UDM profiles. If the IMSI/SUPI list cannot be easily organized as reduced IMSI/SUPI range list, the size of the whole list may occupy a large volume of storage and may reaches or even exceeds the maximum size of JSON object (see clause 6.2 of 3GPP TS 29.501). It is the operator's responsibility to determine what content size is regarded as large volume based on its policy. + +A possible way to solve this issue is to use pagination mechanism for downloading such NF profile sub-item with huge content list. Currently, the pagination mechanism has already been introduced in TS29.510 to retrieve part of the entire NF profiles from one type of NF instances (see clause 6.1.3.2.3). Similar mechanism can be utilized to retrieve a specific sub-item (e.g. IMSI/SUPI range list) of a NF profile, if that NF profile sub-item has large volume of content. + +To support the pagination downloading mechanism for NF profile sub-items, following enhancements shall be considered: + +- 1) When sending NF Discovery request to the NRF, the requesting NF shall: + - (a) indicate its support of paginated data retrieval feature; +- 2) On receiving NF Discovery request from an NF, the NRF shall: + - (a) check if the requesting NF supports paginated data retrieval feature; + - (b) check if at least one NF profile sub-item has large volume of content, perform (c)-(d); + - (c) keep the detected NF profile sub-item with empty content; + +- (d) indicate a special pagination reference for retrieving the content of the NF profile sub-item; + - For example, the NRF includes a paginatedDataReference IE in the NF profile. Within the paginatedDataReference IE, it carries: (a) the original resource URI of the NF profile sub-item, (b) a special paginated-data-retrieval URL used to retrieve one page of data of that NF profile inner item, (c) total pages of the NF profile sub-item, (d) page size; + - An example of the paginated-data-retrieval URL: +`{apiRoot}/nnrf-nfm/v1/paginated-data-retrieval/{nf-instance-id}/{nf-profile-sub-item}` +- 3) On receiving NF Discovery response from the NRF, the requesting NF shall: + - (a) store the NF profile returned by the NRF; + - (b) check if pagination reference is present in the response, perform bullet (c)-(d); + - (c) initiate an separate HTTP GET to the paginated-data-retrieval URL, indicating the target page number; + - An example of HTTP GET request: +`GET {apiRoot}/nnrf-nfm/v1/paginated-data-retrieval/{nf-instance-id}/{nf-profile-sub-item}?page-number=1;` + - (d) continue (h) to retrieve all pages from the NRF, and assemble all pages to get the entire content of the indicated NF profile sub-item. + +### 6.3.2 Impacts on services, entities and interfaces + +NRF: + +- extend the existing NRF API to support paginated data retrieval. + +NF: + +- indicate its support of paginated data retrieval feature to the NRF; +- invoke paginated data retrieval to the indicated paginated-data-retrieval URL to retrieve one page of content of a specific NF profile sub-item. + +### 6.3.3 Pros + +This solution provides an efficient way to download one piece of content of an NF profile sub-item, in the case that the NF profile sub-item has large volume of content. + +### 6.3.4 Cons + +The NRF needs to differentiate the handling to a requesting NF supporting or not supporting paginated data retrieval feature. + +## 6.4 Solution #4: Enhancement of inter NRF interaction to optimize shareable data transmission + +### 6.4.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Duplicate configuration may exist in various data types (e.g. UE identifier ranges) among different NF (or NF service) profiles. Possible shareable data in NF (or NF service) profile are listed in clause 6.7. + +**Editor's Note:** It is FFS that whether and which data types need to be defined as standardized shared data types. + +To avoid repeat transmission of shareable data within the NF profile, it is proposed to classify these shareable data as different set of shared data, identified by shared-data ID, in the same way adopted in subscription data retrieval. Within the NRF interaction related procedures (e.g. NF registration, NF discovery), the shared-data ID will be provided instead of shared data. + +As NRF is deployed in a hierarchical architecture, e.g. PLMN level, shared-slice level, and slice-specific level, to configure the shared data on lower level NRF might be not suitable for the fact that NFs may register its profile in one of multiple NRF instances, and to configure the shared data on all NRF instances as global unique information might cause a waste of storage resource. In this solution, it is proposed to configure the shared on a higher level NRF instance, and the corresponding NRF instance which stores this shared data will be provided simultaneously together with the shared-data ID when needed. + +The procedure of shared-data ID provisioning would be as below: + +- The mapping correlation between shared-data ID and the corresponding shared data is provisioned on a higher level NRF instance. +- Besides, for the NF instances which holds these shared data, the shared-data ID and the NRF instance ID which maintains the mapping correlation is provisioned during the initialization process. + +The procedure of NF registration procedure would be as below: + +- The NF registers its NF profile to the NRF, in which the NF profile contains one or more shared-data ID(s) and the NRF instance ID which maintains the shared data corresponds to the shared-data ID. +- If the NRF determines that the shared data corresponds to the shared-data ID is not available yet, it initiates the retrieval of shared data towards the NRF instance identified by the NRF instance ID of the shared-data ID. +- The NRF which receives the NF registration request needs to subscribe on the change notification of shared data towards the NRF instance which maintains the shared data. + +The procedure of NF discovery procedure would be as below: + +- Upon receiving the NF discovery request from a request NF which indicates its support for SharedData feature, the NRF can respond to the request NF with the NF profile which includes the shared-data ID and the corresponding NRF instance ID which maintains the related shared data. +- Upon receiving the NF discovery request from a request NF which does not indicate its support for SharedData feature, the NRF shall translate the shared-data ID within the NF profile into the corresponding shared data, and respond the NF profile to the request NF. +- When the request NF receives NF profile contains shared-data ID, and the corresponding shared data is not available yet, it initiates the retrieval and subscription of shared data towards the NRF instance identified by the NRF instance ID of the shared-data ID, or alternatively, towards the current NRF instance. + +As an alternative, if the shared-data ID is unique at PLMN granularity, the mapping between the shared-data ID and corresponding NRF instance ID can be registered outside of the NF profile, and the NRF doesn't need to provide the NRF instance ID corresponding to the shared-data ID, as the request NF can request and subscribe to the shared data by providing the uniquely assigned shared-data ID. + +### 6.4.2 Impacts on services, entities and interfaces + +NRF: + +- retrieves the shared-data corresponds to the received shared-data ID from the NRF instance identified by the NRF instance ID. +- responds the shared data according to the supported feature of the request NF. + +NF: + +- registers its NF profile to the NRF, which may include shared-data ID and the corresponding NRF instance ID. +- retrieves the shared-data corresponds to the received shared-data ID from the NRF instance identified by the NRF instance ID or from the current NRF instance. + +### 6.4.3 Pros + +This solution provided an efficient way to optimize the signalling load during NRF interaction, and allows the shared data being provisioned in a distributed way. + +### 6.4.4 Cons + +Shared-data ID is tightly bound to the corresponding NRF instance ID which maintains the shared data, and needs to be transmitted together. + +## 6.5 Solution #5: Optimization of shareable data transmission for NF set level shared data + +### 6.5.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Duplicate configuration may exist in various data types (e.g. UE identifier ranges) among different NF (or NF service) profiles. Possible shareable data in NF (or NF service) profile are listed in clause 6.7. + +**Editor's Note:** It is FFS that whether and which data types need to be defined as standardized shared data types. + +According to the definition in TS 23.501[3], NF Set is a group of interchangeable NF instances of the same type, supporting the same services and the same network slice(s), and can have access to the same context data even geographically distributed. Under this precondition, it can be assumed that NF profile of different NF instances within the same NF set tend to converge, and would only differ with some NF instance specific data types, e.g. address info, serving area. To optimize the transmission of shared data for an NF set, it is proposed that the NRF can fetch the shared data from the register NF upon receiving the NF set level shared data. + +For set level shared data transmission, most of the data type within the NF profile can be identified as a one or more shared-data ID(s), and the shared-data ID can be provided together with the NF Set ID to the NRF during the NF registration procedure, and further to the request NF by the NRF during the NF discovery procedure. + +The procedure of shared-data ID provisioning would be as below: + +- The mapping correlation between shared-data ID(s) and the corresponding shared data is provisioned on all the NF instances within the same NF Set. + +The procedure of NF registration procedure would be as below: + +- The NF registers its NF profile to the NRF, in which the NF profile contains one or more shared-data ID(s), the shared-data ID can uniquely identify the shared data stored within any of the NF instance in the same NF set. +- In case that the NRF determines that the shared data corresponds to the shared-data ID is not available yet, it initiates the retrieval and subscription of shared data towards the register NF by providing the shared-data ID. + +The procedure of NF discovery procedure would be as below: + +- Upon receiving the NF discovery request from a request NF which indicates its support for SharedData feature, the NRF can respond to the request NF the target NF profile(s). In case that the target NF(s) includes NF one or more NF instance(s) within the same NF set, the mapping between shared-data ID and the corresponding shared data will be provided within the response message. +- Upon receiving the NF discovery request from a request NF which does not indicate its support for SharedData feature, the NRF shall translate the shared-data ID within the NF profile into the corresponding shared data, and respond the NF profile to the request NF. +- When the request NF receives NF profile contains shared-data ID, it initiates the subscription of shared data change event towards the current NRF instance, or alternatively, the NRF creates the subscription in an implicitly way and notifies when shared data change event occurs. + +When the NF which is subscribed by the NRF on shared data change event deregisters from the NRF, the NRF can select another NF instance within the same NF set and subscribe on the shared data change event to the NF instance. + +### 6.5.2 Impacts on services, entities and interfaces + +NRF: + +- retrieves the shared-data corresponds to the received shared-data ID from the register NF when needed. +- responds the shared data according to the supported feature of the request NF. +- subscribe and re-subscribe on shared data change event to the register NF or other NF instance within the same NF Set. + +NF: + +- registers its NF profile to the NRF, which may include shared-data ID, and support to handle the shared data retrieval and subscription of shared data change event initiated by the NRF. +- receives the shared-data ID and the corresponding shared data within the NF discovery procedure. + +### 6.5.3 Pros + +This solution introduced shared data mechanism for the NF instances within the same NF Set, to avoid the repeated transmission of the shared data related to these NF instances. + +### 6.5.4 Cons + +This solution is designed for NF set level, and may be inefficient for NF instances from different NF set scenario. + +## 6.6 Solution #6: NRF Policy Control on Information Exposure for different PLMNs + +### 6.6.1 Description + +The solution is to address the Key Issue #2: Signaling overhead of NF discovery responses between PLMNs. + +The NRF may be configured by means of OAM with sets of policy rules per PLMN or per groups of PLMNs (e.g. one policy rule set for all foreign PLMNs, one policy rule set for equivalent PLMNs,...). These rules define what parameters of a registered NF profile can be exposed to the PLMN. Also these rules can define the way how to modify/reduce registered profile parameters for exposure to the PLMN in order to reduce the message length and required storage capacity at the consumer. + +The PLMN specific rules may take additional information into account (e.g. the NF type of the registered NF) when deciding to remove parameters from the discovery response message. + +The policy rules shall be limited to cases where impacts to NF consumers are avoided, i.e. NF consumers need not be aware of the fact that NF profiles in the discovery response message have been modified/reduced. + +E.g.: If the registered SmfInfo contains a list of TAIs or TAI ranges, the policy rule for all foreign PLMNs could require to remove TAIs and TAI ranges from SMF discovery responses sent to a foreign PLMN. + +The PLMN-specific policy rules shall apply to NF discovery response messages and to profile change notification messages. + +Figure 6.6.1-1 shows an example flow. + +![Sequence diagram illustrating the interaction between PLMN X (NFc/NRFc) and PLMN A (OAM, NRF, NFp) for policy rule configuration and NF profile management.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant PLMN_X as PLMN X +NFc/NRFc + subgraph PLMN_A + participant OAM + participant NRF + participant NFp + end + OAM->>NRF: 1. configure policy rules for PLMN X + NRF-->>OAM: 2. ack + NFp->>NRF: 3. register NF profile + NRF-->>NFp: 4. ack + PLMN_X->>NRF: 5. Discovery request + Note right of NRF: 6. Apply PLMN X specific policy rules to registered profile + NRF-->>PLMN_X: 7. Discovery response (NF profile with policy rules applied) + PLMN_X->>NRF: 8. Subscribe + NRF-->>PLMN_X: 9. ack + NFp->>NRF: 10. modify NF profile + NRF-->>NFp: 11. ack + Note right of NRF: 12. Apply PLMN X specific policy rules to modified profile + NRF-->>PLMN_X: 13. Notify + PLMN_X-->>NRF: 14. ack + +``` + +Sequence diagram illustrating the interaction between PLMN X (NFc/NRFc) and PLMN A (OAM, NRF, NFp) for policy rule configuration and NF profile management. + +Figure 6.6.1-1 + +- 1-2. PLMN X -specific policy rules are configured at the NRF. +- 3-4. NF producer registers its profile at the NRF. +5. NRF receives a discovery request from PLMN X. +6. NRF applies the configured policy rules for PLMN X to the registered NF profile. +7. NRF sends a discovery response containing the registered NF profile with PLMN X -specific policy rules applied. +- 8-9. NRF receives a subscribe request from PLMN X. +- 10-11. NF producer modifies its NF profile +12. NRF applies the configured policy rules for PLMN X to the modified NF profile. +- 13-14. If the modified profile with policy rules applied differs from the original profile with policy rules applied: NRF notifies the consumer. + +### 6.6.2 Impacts on services, entities and interfaces + +OAM: + +- Configure the NRF with policy rules per PLMN. + +NRF: + +- Apply configured policy rules to NF discovery response messages and profile change notification messages. + +NF consumer: + +- None. + +### 6.6.3 Pros + +This solution provides an efficient way to shorten NF Discovery response messages and Profile change notification messages sent to different PLMNs. Also the amount of Profile change notification messages will be reduced. + +NF consumers are not impacted. + +### 6.6.4 Cons + +Depending on the complexity of OAM configured policy rules, additional NRF storage and processing resources to store and apply the rules are needed. However, as inter-PLMN discovery traffic represents a rather low contribution to the overall NF discovery traffic, the need for additional processing resources may be limited. + +## 6.7 Solution#7: List of Shareable Profile Items + +### 6.7.1 Description + +This solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. Specially, this solution lists those NF profile items which are possibly shared among different NF (or NF service) profiles which may belong to same or different NF set. + +Table 6.7.1-1 lists NF profile items that might be shared by multiple NFs (or NF services), either across different NF sets or within same NF set. + +**Table 6.7.1-1: Possible shareable NF profile items** + +| # | Shareable NF profile items | Shared by NFs across different NF sets | Shared by NFs within same NF set | +|----|------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|----------------------------------| +| 01 | List of supported PLMN (e.g. allowed PLMNs) | O (Optionally shared) | M (Mandatorily shared) | +| 02 | List of supported features | O | M | +| 03 | UE identifier ranges (e.g. SUPI ranges, GPSI ranges, IMSI ranges, IMEI ranges, MSISDN ranges, external/internal group identifier ranges, etc.) | O | M | +| 04 | Routing indicator, SUCI info (e.g. configured in AusfInfo); | O | M | +| 05 | List of supported serving area (e.g. TAI list or TAI range list) | O | M | +| 06 | List of supported NF services | O | M | +| 07 | List of allowed NF types | O | M | +| 08 | List of allowed NF domains | O | M | +| 09 | List of supported S-NSSAI | O | M | + +| | | | | +|----|--------------------------------------------------|-----|---| +| 10 | List of supported DNN | O | M | +| 11 | List of supported DNAI | O | M | +| 12 | NF/NFS FQDN (used for intra-PLMN or inter-PLMN) | N/A | O | +| 13 | Service endpoint info (HTTP scheme, port number) | O | O | +| 14 | List of locality | O | O | +| 15 | List of serving scope | O | O | +| 16 | List of SCP domain | O | O | +| 17 | List of default notification callback URL | N/A | O | + +If above sharable profile items are shared by NFs within the same NF set, solution #2 provides candidate methods to configure and store the shared NF set profile without need of definitions for new data type for shareable profile items. + +If above shareable profile items are shared by NFs not belonging to the same NF Set, new data types for those shareable data might be defined. For example, a variant type might be defined as a container to carry different shareable profile items, with an enumeration attribute (e.g. contentType) indicating the exact type of inner profile item. + +### 6.7.2 Impacts on services, entities and interfaces + +NRF, NF: + +- May need to support new data types defined for shareable data. + +### 6.7.3 Pros + +If a common variant data type is defined for various shareable data, it is no need to define separate data types for each shareable profile items. + +### 6.7.4 Cons + +No special cons foreseen. + +## 6.8 Solution #8: Single Subscription of NF Profile Change from an NF Set + +### 6.8.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Multiple NFs in an NF Set may subscribe the NF profile changes of the same NF. As per existing procedure, the NRF creates individual subscription for each requesting NF. Once the NF profile of the target NF changes, the NRF sends separate notifications to each NF that previously subscribed the NF profile change notification. This mechanism can be simply implemented but it creates unnecessary notifications towards NFs within an NF Set. + +However, as NFs within an NF Set may share the runtime context (e.g. cached NF profiles, subscriptions to NF profile changes, etc.) by the assistance of UDSF, it is possible for those NFs to only create one instance of subscription for the indicated purpose in the NRF. + +The following enhancements can be considered for this solution: + +- 1) When one NF wants to subscribe NF profile change for a specific NF, the requesting NF shall first check if such subscription context exists in the UDSF: + - 1.1) if exist, it means such subscription to the NRF has already been created by another NF in the NF Set, thus it is no need to trigger duplicate subscription to the NRF. The requesting NF may register itself to the subscription context in the UDSF so as to be notified later. + - 1.2) if not exist, the requesting NF sends subscription request to the NRF, and stores the subscription context (e.g. subscribed NF Instance ID, requesting NF ID, etc.) in the UDSF. +- 2) When detecting NF profile changes for a specific NF, the NRF initiates NF profile change notification to the NF(s) that subscribed the event, without any special enhancement to the notification procedure. +- 3) On receiving NF profile change notification from the NRF, the receiving NF shall store the updated NF profile of the indicated NF in the UDSF. Implementation specific method may be used by the UDSF to make other NFs in the NF Set be aware of the updated NF profile. + +### 6.8.2 Impacts on services, entities and interfaces + +NF: + +- Enhancements to NF internal logic to avoid sending duplicate subscriptions to the NRF to subscribe NF profile change for a specific NF; + +NRF: + +- No special enhancement. + +### 6.8.3 Pros + +This solution doesn't require any enhancement to the NRF interface and NRF logic. + +### 6.8.4 Cons + +This solution relies on the NF internal enhancement and implementation of UDSF, and may not always be available. The complexity of UDSF implementation may further decrease the usability of the solution. + +## 6.9 Solution #9: Single NF Profile Change Notification to an NF Set + +### 6.9.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Multiple NFs in an NF Set may subscribe the NF profile changes of the same NF. As per existing procedure, the NRF creates individual subscription for each requesting NF. Once the NF profile of the target NF changes, the NRF sends separate notifications to each NF that previously subscribed the NF profile change notification. This mechanism can be simply implemented but it creates unnecessary notifications towards NFs within an NF Set. + +However, it is possible for the NRF to aggregate separate subscriptions to NF profile change of a specific NF from multiple NFs within an NF Set, and thus only sends one instance of NF profile change notification to multiple NFs within an NF Set. + +The following enhancements can be considered for the solution: + +- 1) When one NF subscribes NF profile change of a specific NF to the NRF, the requesting NF shall indicate its support of sharing NF profile change notification within NF Set in the request message; + - certain methods (if available) might be used by the requesting NF to avoid sending duplicate NF profile change subscription to the NRF, e.g. as addressed by solution #8; + +- 2) On receiving subscription to a specific NF profile, the NRF shall: + - 2.1) check if the requesting NF supports sharing NF profile change notification within NF Set; + - if the requesting NF does not have the expected capability, the NRF handles the subscription request as per existing procedure; + - if the requesting NF has the expected capability, continue step 2.2); + - 2.2) check if the NF profile change subscription for a specific NF Set exists in the NRF; + - if not exist, create the subscription at per NF Set level, and store the following information in the subscription context: NF Instance ID of the subscribed NF, NF Set ID, NF Instance ID of the requesting NF, callback URI of the requesting NF; + - if exist, store the following information in the existing subscription context: NF Instance ID of the requesting NF, callback URI of the requesting NF. +- 3) When NF profile change of a specific NF is detected, the NRF shall: + - 3.1) check if the stored NF profile change subscription is at NF Set level, i.e. multiple NFs in an NF Set have subscribed the NF profile change notification: + - if not, handle the NF profile change notification as per existing procedure; + - if yes, continue step 3.2); + - 3.2) handle the NF profile change notification at NF set level, i.e. select one target NF from the requesting NFs belonging to same NF Set (i.e. from the request NF list stored in the subscription context), and send NF profile change notification to that selected NF; +- 4) When one NF receives NF profile change notification from the NRF, it shall store the updated NF profile, and synchronize the received NF profile update with other NFs in the same NF Set. + +### 6.9.2 Impacts on services, entities and interfaces + +NF: + +- indicate the support of sharing NF profile change notification within NF Set to the NRF; + +NRF: + +- enhance the NRF interface and logic, so as to detect the subscription from an NF with support of sharing NF profile change notification within NF Set and handle the subscription and notification accordingly. + +### 6.9.3 Pros + +With the enhancement, the NF profile change notifications to multiple NFs within an NF Set are reduced. + +### 6.9.4 Cons + +The NRF needs to differentiate the handling to a requesting NF with or with support of sharing NF profile change notification within NF Set. + +## 6.10 Solution #10: Simplifying the NF service discovery response of inter-PLMN + +### 6.10.1 Description + +The solution is to address the Key Issue #2: Signaling Overhead of NF Discovery Responses between PLMNs. + +According to the definition in 3GPP TS 29.510 [2], NRF returns all value of attributes of array or map type in NF Profile in NF discovery response, however, in most inter-PLMN scenarios, NF consumer does not need to obtain all attribute values. For example, all the list of ranges of SUPIs whose profile data is available in the UDM instance is stored in the supiRanges of the NF profile, and NF consumers in other PLMNs need only a few of them. + +Consequently, in this solution, the inter-PLMN NF discovery response message will only contain value that match the NF discovery request parameters, not all value. NF consumer could process the simplified response as normal without any additional change, as the matched values fully meet its requirements in this service procedure. Furthermore, NF consumer could process the simplified response more appropriately with identifying it. + +To support the solution, following enhancements shall be considered: + +![Sequence diagram illustrating the inter-PLMN NF service discovery procedure with partial information. The diagram shows three lifelines: NF Service Consumer, NRF1, and NRF2. The sequence of messages is: 1. GET .../nf-instances? from NF Service Consumer to NRF1. 2. GET .../nf-instances? from NRF1 to NRF2. 3. A note on NRF2 indicates 'The NRF simplify NF profiles in the response.' 4. 200 OK(simplified NF instance Profiles, indication) from NRF2 back to NF Service Consumer.](6470d350326789d5306eabcb76533951_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF1 + participant NRF2 + Note right of NRF2: 3. The NRF simplify NF profiles in the response. + NF Service Consumer->>NRF1: 1. GET .../nf-instances? + NRF1->>NRF2: 2. GET .../nf-instances? + NRF2-->>NF Service Consumer: 4. 200 OK(simplified NF instance Profiles, indication) + +``` + +Sequence diagram illustrating the inter-PLMN NF service discovery procedure with partial information. The diagram shows three lifelines: NF Service Consumer, NRF1, and NRF2. The sequence of messages is: 1. GET .../nf-instances? from NF Service Consumer to NRF1. 2. GET .../nf-instances? from NRF1 to NRF2. 3. A note on NRF2 indicates 'The NRF simplify NF profiles in the response.' 4. 200 OK(simplified NF instance Profiles, indication) from NRF2 back to NF Service Consumer. + +**Figure 6.10.1.1: inter-PLMN NF service discovery procedure with partial information** + +- 1) The NF service consumer sends the NF discovery request to the NRF when query fail in the cache; +- 2) The intermediate NRF (NRF1) forwards the NF discovery request to the NRF in home network (NRF2); +- 3) On receiving NF Discovery request, the target NRF only returns the value matching the query parameters in the response, and carried an indication. + +An example of simplifying response message: + +The supiRanges value of the NF1 profile registered on NRF is: + +``` + +[{"start": "123456789040000", "end": "123456789049999"}, +{"start": "123456789050000", "end": "123456789059999"}, +{"start": "123456789060000", "end": "123456789069999"} + +``` + +In the NF discovery request from NF2, the value of the query parameter SUPI is “123456789041234”, and other query parameters also match NF1. Then NF discovery response returned to NF2 contains only “{"start": "123456789040000", "end": "123456789049999"}”. + +- 4) On receiving NF Discovery response from the NRF the consumer could cache it as normal. Provided that the consumer could handle the indication that indicates a simplified response, it could process the response more appropriately, e.g., updating values of the response to cache and not deleting other values of same NF producer already exist in cache, so as to cache more useful data and saving more signaling overhead. + +### 6.10.2 Impacts on services, entities and interfaces + +NRF: + +- Simplify the NF discovery response message. + +NF: + +- Process the simplified NF discovery response message. + +### 6.10.3 Pros + +This solution introduces a simplification mechanism for inter-PLMN NF discovery response, to avoid the unnecessary signalling overhead and data storage overhead in inter-PLMN scenario. + +### 6.10.4 Cons + +The number of inter-PLMN NF discovery messages might increase a little. + +## 6.11 Solution 11: Avoid large configuration of UE Routing Indicator + +### 6.11.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +Several NF types, such as UDM, AUSF, AAnF..., may contain in their NFProfile info a (potentially very large) set of Routing Indicators (RID). When a candidate NF instance of any of those types needs to be discovered by a consumer, it includes the UE RID in the NRF Discovery request, so the NRF returns only those NF instances containing such RID in their profiles. + +This is a quite similar scenario to the discovery of candidate producer instances based on SUPI, and the problem of provisioning a large set of SUPI ranges in the NF Profile of the NF instances themselves. For this problem, the approach of configuring the mapping between SUPI and NF Group ID was addressed by moving the configuration of SUPI ranges and NF Group IDs to the NRF and letting the NRF to obtain the NF Group ID for a given SUPI received in the discovery request and include the NF instances of the corresponding NF Group ID in the discovery response. + +If the NRF has no stored configuration mapping identity sets/ranges to NF Group ID locally, the NRF can retrieve the NF Group ID corresponding to a specific subscriber identifier from the UDR using the Nudr\_GroupIDmap\_Query service operation. + +A similar approach can be proposed for the RIDs: the configuration of mapping between RID and NF Group ID can be moved out from the producer NFProfile (and NRF), and can be done at the NRF either based on local configuration or by interacting with UDR. It should be noted that all NF instances deployed in the same NF Group will define support for the same list of Routing Indicators and multiple Routing Indicators can be supported within the same NF Group. + +### 6.11.2 Impacts on services, entities and interfaces + +NRF: + +- add logic to determine the NF Group ID for a given RID, either based on local configuration or by interacting with UDR. + +UDR: + +- enhance the Nudr\_GroupIDmap API to support receiving the RID as input for the mapping. + +### 6.11.3 Pros + +This solution provides a very simple enhancements to relieve the configuration of large sets of RID in NF producers' NFProfile and lowering the size of these profiles. + +### 6.11.4 Cons + +None identified. + +## 6.12 Solution #12: Support for NF Set level shared data + +### 6.12.1 Description + +The solution is to address the Key Issue #1: Avoid Duplicate Configuration and Transmission of Shareable Data. + +According to the definition in TS 23.501[3], NF Set is a group of interchangeable NF instances of the same type, supporting the same services and the same network slice(s), and can have access to the same context data even geographically distributed. Under this precondition, it can be assumed that NF profiles of different NF instances within the same NF Set tend to converge, and would only differ with some NF instance specific data types, e.g. address info, NF Instance info, etc. + +To optimize the storage and transmission of shared data for an NF Set, the following issues needs to be addressed in this solution: + +- a) How the NRF receives the shared data for a specific NF Set. +- b) How the NRF can be notified of the updated shared data for the NF Set. +- c) How the NF discovery procedure can be optimized to avoid the transmission of multiple copies of shared data for the NF Set. + +Evaluation of Issue a) and issue b) heavily depends on the endpoint in which the shared data is provisioned, e.g. the NF instances, or the NRF. If the shared data for the NF Set is provisioned only in the NF instance, the mapping information between NF Set ID and corresponding shared data in the NRF needs to be maintained by the NF instance(s), thus implicit and explicit subscription may be involved as specified in Option A of Solution #2 and Solution #5 respectively, which may cause complicated interaction between NRF and NF instance to guarantee the consistency of the shared data for the NF Set. + +In consideration of the fact that the NF instances of the same NF Set is usually served by a specific NRF instance or specific pair of NRF instances, it would be much easier to enable the direct provisioning and updating of shared data for the NF Set by the OAM. In this case, transmission of shared data for the NF Set is not needed during the NF registration procedure. + +For issue c), either one step or two step retrieval can be adopted to avoid the transmission of shared data for the NF Set. As the NF discovery is triggered to discovery the target NF instance or target set of NF instance(s), it means the NF Consumer have no NF profile context for the NF Producer within the NF Set, not to mention the shared data for the NF Set, one step retrieval is proposed to be adopted to avoid additional interaction. + +Similar with the updating on URI structure of the NFManagement API in Solution #2, resource nf-sets is proposed to be managed independent of the NF profile within the resource nf-instances. As the resource nf-sets is provisioned and updated by the OAM directly, only HTTP GET method triggered by NF Consumer or other NRF instance is needed for this resource. + +![Resource Structure for Nnrf_NFManagement service diagram](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +graph TD + apiRoot["{apiRoot}/nnrf-nfm/v1"] --- nfInstances["/nf-instances"] + apiRoot --- nfSets["/nf-sets"] + apiRoot --- subscriptions["/subscriptions"] + nfInstances --- nfInstanceID["/{nfInstanceID}"] + nfSets --- nfSetID["/{nfSetID}"] + subscriptions --- subscriptionID["/{subscriptionID}"] + +``` + +The diagram illustrates the resource structure for the Nnrf\_NFManagement service. It starts with the root path {apiRoot}/nnrf-nfm/v1, which branches into three main resource paths: /nf-instances, /nf-sets, and /subscriptions. Each of these paths further branches into a specific resource ID path: /{nfInstanceID} for /nf-instances, /{nfSetID} for /nf-sets, and /{subscriptionID} for /subscriptions. + +Resource Structure for Nnrf\_NFManagement service diagram + +**Figure 6.12.1.2-1 Resource Structure for Nnrf\_NFManagement service** + +The procedure of shared data for NF Set provisioning and updating would be as below: + +- The mapping correlation between NF Set ID and the corresponding shared data for the NF Set is provisioned and updated by the OAM, based on the serving relationship between NRF instance(s) and NF Set(s), which is outside the 3GPP scope. + +NOTE 1: OAM is responsible for the provisioning of shared data for the NF Set into the corresponding NRF instance(s) which serves the NF Set. + +The procedure of NF registration procedure would be as below: + +- The NF registers its NF profile to the NRF, which contains the NF Set ID it belongs to. As the shared data for the NF Set is already provisioned in the NRF, no shared data is to be contained within the registered NF profile. +- Upon receiving the NF registration request, the NRF correlates the registered NF instance with the stored nf-sets by using NF Set ID. + +The procedure of NF discovery procedure would be as below: + +- Upon receiving the NF discovery request from a requester NF which indicates its support for NFSetSharedData feature, the NRF responds to the requester NF the registered NF profile(s) of the target NF instance(s), together with the shared data for the NF Set(s) corresponding to the target NF instance(s). +- Upon receiving the NF discovery request from a requester NF which does not indicate its support for NFSetSharedData feature, the NRF merges the registered NF profile with the shared data of the NF Set for each target NF instance, and respond the merged NF profile(s) to the requester NF. +- When the requester NF receives the additional shared data for the NF Set(s), it correlates the shared data for the NF Set(s) with the received NF profile(s), and regards the shared data for the NF Set applicable for every NF instance of the NF Set when interacting with the NF Producer. It initiates the subscription of change event for the shared data of NF Set(s) and NF profile(s) towards the NRF respectively if not triggered yet. + +NOTE 2: OAM is responsible for avoiding duplicate provisioning for a specific attribute in both NF profile registered by the NF Producer and the shared data for the NF Set. + +### 6.12.2 Impacts on services, entities and interfaces + +NRF: + +- Correlates the registered NF profile and stored shared data for the corresponding NF Set, and responds the NF profile and shared data for the NF set to the requester NF in a proper way, based on the supported feature of the requester NF. + +NF Producer: + +- registers its NF profile to the NRF, which includes NF Set ID it belongs to, while shared data for the NF set is not included. + +NF Consumer: + +- receives the NF profile for the target NF instance(s) and the corresponding shared data for the NF Set, regards the shared data for the NF Set applicable for each NF instance within the NF Set. + +### 6.12.3 Pros + +No complicated explicit and implicit coordination for shared data of the NF set is needed between NF Producer and the NRF. + +### 6.12.4 Cons + +This solution is designed for NF Set level, and may be inefficient for NF instances from different NF Set scenario. + +# --- 7 Evaluations + +## 7.1 Evaluation of Solutions for Key Issue#1 + +### 7.1.1 Synchronization of Shareable Data + +#### 7.1.1.1 Configured Shareable Data + +NF configuration data (configured by means of OAM at the NF/NF set) have an impact on the NF's profile data stored at the NRF. Profile data stored at the NRF are either statically configured by means of OAM (in sync with the data configured at the NF/NF set), or dynamically registered by the NF (avoiding synchronization issues). + +Similarly for shared configuration data and their IDs, which are configured by means of OAM at all sharing NFs/NF sets: The corresponding shared data / set profile and IDs needs to be stored at the NRF. + +Solution #1 allows data sharing among NFs of different types or of same type from different sets. This adds the need for synchronized configuration. In addition, solution #1 proposes to configure shared data and their IDs at all NRFs, adding even more complexity to ensure overall synchronized configuration. + +The synchronization issue between NRFs is addressed by solution #4 which proposes a higher level NRF to store the shared data, at the cost of higher NRF to NRF traffic, to retrieve the shared data when needed. + +Similarly, solution #1 proposes as an option to sync NRFs by means of an operator granted NF (e.g. special UDR). + +Still synchronization between NFs, between NF sets and between NF and NRF remains an issue adding complexity to network configuration. + +Solution #2 (option A) and solution #5 propose to configure/provision shareable data (NF set profiles) and their IDs (NF set ID) at a single place (the NF set), avoiding all kinds of synchronization issues. + +Solution #2 (option B) proposes to configure/provision shareable data (NF set profiles) and their IDs (NF set IDs) at two places (a single NRF set and a single NF set) allowing to minimize synchronization issues. + +Solution #8 and #9 proposes similar way to avoid duplicate subscription and change notification, via the UDSF and NRF determination. However, the basis of the solution might be inaccurate, as the NF will only determine to trigger the + +subscription when no shared data can be found locally, thus no duplication subscription will be received by the NRF, and the NRF does not need to avoid duplicate notification to the NFs within the same NF set. + +Solution #11 proposes to delegate the configuration of a certain type of shareable data (Routing Indicators) to the NRF or UDR and let the NRF find out the mapping between RID and NF Group ID based on local configuration or via an existing API with the UDR. This approach is quite similar to the existing mechanism for handling SUPI ranges, and in that sense, it does not bring any additional issue related to configuration, discovery or change of such shareable data, compared to the existing mechanism already in place for mapping between SUPI and NF Group ID. + +Solution #12 proposes to configure the shared data in NRF(s) which serves the NF Set, thus no synchronization on update of shared data is required between NF(s) and NRF(s). + +#### 7.1.1.2 Discovered Shareable Data + +Once shareable data have been discovered by NFs during the NF discovery procedure, the data are subject to change. Solutions #1, #2 and #5 propose similar subscribe/notify mechanisms ensuring that discovered shared data are kept in sync. + +#### 7.1.1.3 Change of Shareable Data + +When the shareable data is configured in NF instance or NRF, the operator may update the correlation between shared-data ID with shareable data. The NRF should be aware of the change event. + +**Editor's note:** The solution evaluation for Change of Shareable Data is FFS. + +### 7.1.2 Storage requirements + +#### 7.1.2.1 Storage of configured data + +Storing/configuring multiple copies of the same configured data (i.e. redundant data) at an NF is an issue addressed by solutions #1, #2, #4 and #5. However, storing requirements for a single copy of shared data differ. It is beneficial to store/configure shared data at a single place in the network. + +Solution #1 proposes to configure/store shared data at all or multiple NRFs /NRF set in the PLMN. + +Solution #4 proposes to configure/store shared data at a single higher level NRF /NRF set. + +Solution #2 option A proposes to configure/store shared data (NF set profiles) at a single NF set. + +Solution #2 option B proposes to configure/store shared data (NF set profiles) at a single NRF/NRF set. + +Solution #5 proposes to configure/store shared data at a single NF set. + +Solution #8 and #9 proposes to configure/store shared data at a single NF set. + +Solution #11 proposes to configure Routing Indicator to NF Group ID mapping at the NRF or in the UDR, rather than at the NFProfile of the producer (UDM, AUSF, AAnF). + +Solution #12 proposes to configure shared data within the NRF(s) serving the NF set. + +#### 7.1.2.2 Storage of discovered data + +Storing multiple copies of the same discovered data (i.e. redundant data) at an NF is an issue addressed by solutions #1, #2, #5, #8, #9 and #12. All solutions propose the same principle, i.e. store the discovered shared data only once and use the IDs as a pointer to the shared data. + +Similar solution is also proposed in solution #4, by identify the discovered shared data using shared-data IDs together with the corresponding higher level NRF instance ID. + +### 7.1.3 Discovery procedure + +Solutions #1, #2, #4 and #5 propose optimizations, differing with regard to discovery response message length and number of message roundtrips. + +Solution #1, alternative 2 of solution #2, solution #4 and solution #12 propose an additional roundtrip to retrieve shared data from the NRF if a shared data ID (or set profile ID) was received while the corresponding shared data (or set profile) has not yet been received. This additional message roundtrip occurs only when the shared data is not cached. + +Solutions #5 and alternative 1 of solution #2 propose to always include (a single copy of) the shared data in the discovery response message, so to avoid an (potentially seldom occurring) additional roundtrip at the cost of (an always) increased message length. + +With solution #3 the response message length is reduced at the cost of more roundtrips. + +Solutions #8 and #9 propose optimizations for NF profile change subscription and notification that simplify the discovery of shared data. + +Solution #11 does not imply any change on the discovery procedure by consumers of the NRF Discovery service. + +### 7.1.4 Which data should be shareable? + +Standardizing the exact list of data that may be shareable comes with the drawback that for any extension in future releases the decision (and specification) needs to be taken whether or not the extended data is worth being shareable. + +Solution #1 currently has an editor's note indication that this aspect is ffs. + +Solution #5 has the same issue as #1 (although not explicitly stated). + +Solution #2 avoids the need to address the issue as the NF set profile would be of the same type as the NF profile. + +Solution #7 listed the data which can be shared in the NF profile items. + +Solution #11 is restricted to the Routing Indicator data set, as shareable data. + +### 7.1.5 New NF services operations + +It is beneficial to extend existing service operations rather than defining new service operations. + +Solution #5 proposes that the NRF retrieves (and subscribes to) shared data from the NF during the NF registration procedure. The registering NF can be of any type. Consequently, any NF of any type must offer a new service allowing the NRF to retrieve and subscribe to shared data. + +Solution #2 option A avoids new service operations by re-using and extending the Nnrf\_NFManagement service operations (NFRegister, NFUpdate, NFDeregister) allowing any NF to push (register) its set profile to the NRF, modify it at the NRF and delete it from the NRF. While it is not mentioned how the NRF can determine whether the NF Set profile is not contained due to this feature or some error cases, as no shared-data-ID is provided to the NRF in the NFRegister request. + +Solution #3 avoids new service operations by re-using and extending the Nnrf\_NFDiscovery service operation (NFDiscover) allowing pagination of discovery responses. + +Solution #11 does not require any modification on the interaction between the producer and the NRF. + +### 7.1.6 Applicability Scope + +Solutions #2, #12 and #5 restrict sharing of data to NF sets and does not address sharing of data that may be common to NFs (of same or different type) from different sets. + +Solution #3 is restricted to NF instance level. + +Solution #1 has no restriction, i.e. it is applicable on PLMN level. + +Solution #4 can be applicable on PLMN level or level NRF instance level. + +Solution #11 is restricted to the Routing Indicator data set, as shareable data, and therefore it is restricted to the producer NF types that make use of such data. + +### 7.1.7 Backward compatibility + +All solutions except Solution #11 require feature support indications to ensure backward compatibility with no-supporting legacy NFs. + +Solution #11 does not require any modification on the interaction between the producer and the NRF, and it simply implies that the producer will no longer include the list of supported Routing Indicators in its NFProfile. + +### 7.1.8 Comparison + +Detailed comparison of the solutions can be listed as below: + +| | Solution #1 | Solution #2 | Solution #3 | Solution #4 | Solution #5 | Solution #6 | +|--------------------------------------|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|------------------------------------------------------------| +| Synchronization of Shareable Data | Synchronized configuration in all NFs and all NRFs is required | OptionA: no synchronized configuration between NFs and NRFs required
Option B: synchronized configuration between NF sets and NRF(set) required | N/A | Synchronized configuration in all NFs and higher level NRF is required | no synchronized configuration between NFs and NRFs required | Avoid duplicate subscription change notification via UDSF. | +| Support for change of shareable data | FFS | FFS | FFS | FFS | FFS | FFS | +| Storage requirements | Shared data are stored/configured in all/multiple NFs and NRFs | Option A: Shared set profile is stored/configured at the NF set only
Option B: Shared set profile is stored/configured at the NF set and at singleNRF | N/A | Shared data are stored/ configured in all/multiple NFs and in a higher level NRF | Shared data are stored/configured at the NF set only | Shared data stored/config at a single NRF | +| Discovery procedure | One additional message roundtrip only when shared data are not cached | Alternative 1: No additional Roundtrip at the cost of higher message size
Alternative 2: One additional message roundtrip only when shared data are not cached | Response message length is reduced at the cost of more message roundtrips | One additional message roundtrip only when shared data are not cached | No additional Roundtrip at the cost of higher message size | No additional Roundtrip at the cost of higher message size | +| Which data should be shareable? | ffs | No need to standardize | N/A | N/A | ffs | N/A | +| New NF service operations | Not required | Not required | Not required | Not required | All NFs must provide a shared data retrieval service operation to be consumed by the NRF | Not required | +| Applicability scope | PLMN level | NF Set level | NF Instance Level | NRF level or PLMN level | NF Set level | NF Set level | +| Backward Compatibility | By including Shared Data support indication | By including Set profile Support Indication | By indicating support of paginated data retrieval feature | By indicating support for sharedData feature | By indicating support for sharedData feature | Not required | + +## 7.2 Evaluation of Solutions for Key Issue#2 + +Solution for Key issue#2 aim to address the signalling overhead of NF Discovery Responses between PLMNs. + +Solution #10 reduce the signalling overhead of NF discovery response by only containing value that match the NF discovery request parameters in the response. Solution #10 might increase the number of NF discovery message, however, the overall overhead of NF discovery procedure between PLMNs will be optimized. + +Solution #6 would shorten NF discovery response messages by removing certain parameters from the message, and operators need to determine which parameters can be removed without affecting services. + +Solution #10 reduce values of parameters of array or map type in NF discovery response, while solution #6 reduce unnecessary parameters. And they could be applicable to different scenarios. + +Solution #10 could apply on most parameters of array or map type, while solution #6 might be applicable to a few scenarios and hard to define the rules for reducing which kind of parameters. + +# --- 8 Conclusions + +## 8.1 Conclusion of Solutions for Key Issue#1 + +The following principles are concluded for key issue #1: + +1. For backwards compatibility, the selected solution shall make use of the supported feature negotiation mechanism. +2. For forward compatibility, the selected solution shall try to avoid the need to standardize, which data are shareable. +3. Whether new NF services are needed will be decided during normative work. +4. The selected solution shall allow to take advantage of the NF set concept, by defining NF Set profiles. NF set profiles may contain one or more shared data IDs pointing to PLMN-level shared data. +5. The selected solution shall allow to use shared-data concept across NFs not belonging to an NF-Set. +6. The selected solution should avoid the need for shared data configuration at multiple NFs within the network. The solutions of both OAM based and OAM-less solution will be further worked on during normative phase of work. +7. The NRF should optionally allow other NFs to register (and modify and delete) those NfSetProfiles/Shared Data at the NRF the other NFs may make use of. The details are ffs during normative work. +8. The NRF shall allow other NFs to retrieve (and subscribe to) NfSetProfiles/Shared Data +9. The selected solution shall ensure that a change of NfSetProfile/Shared Data is propagated between NF set and NRF set involving only one NF instance from the NF set and only one NRF instance from the NRF set. +10. The selected solution shall allow to avoid the need of including large lists of UE Routing Indicators in NF profiles registered at the NRF, e.g. by NRF configuration or by interaction with the UDR. + +## 8.2 Conclusion of Solutions for Key Issue#2 + +Based on the evaluation of solutions for key issue#2, it is recommended to adapt solution #10 as basis for normative work. With solution#10, NF discovery response messages could be greatly simplified in most scenarios of inter PLMN by reducing values of parameters of array or map type in the messages, while these parameters cannot not be removed from the messages. + +The new indication added to NF discovery response is optional, and NF consumer could either ignore it without any impact, or do extension processing with it. It is FFS what the impact of the new indication in NF discovery response on NF consumer, and whether it is necessary. + +# Annex A (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|----|-----|-----|-------------------------------------------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2022-08 | CT4#111e | C4-224138 | | | | Skeleton | | 0.1.0 | +| 2022-08 | CT4#111e | C4-224206 | | | | Pseudo-CR on Scope | | 0.1.0 | +| 2022-08 | CT4#111e | C4-224454 | | | | Key Issue for Avoiding Duplicate Configuration and Transmission of Shareable Data | | 0.1.0 | +| 2022-08 | CT4#111e | C4-224455 | | | | Solution for Avoiding Duplicate Configuration and Transmission of Shareable Data | | 0.1.0 | +| 2022-11 | CT4#113 | C4-225327 | | | | New KI on Signaling overhead of NF discovery responses between different PLMNs | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225517 | | | | Solution for Support of NF (Service) Set Profiles | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225520 | | | | Updates to Solution #1 | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225521 | | | | Solution for Downloading Large Volume Data within NF Profile | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225549 | | | | Update of Key Issue #1 on Support of NF (Service) Set Profiles | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225557 | | | | Updates on Key Issue #1 for FS_NRFe | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225558 | | | | New Solution for Key Issue #1 of FS_NRFe with enhanced inter NRF interaction | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225560 | | | | New Solution for Key Issue #1 of FS_NRFe to support set level shared data | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225561 | | | | Updates on Baseline | | 0.2.0 | +| 2022-11 | CT4#113 | C4-225573 | | | | Updates to Key Issue #1 | | 0.2.0 | +| 2023-03 | CT4#114 | C4-230669 | | | | NRF Policy Control on Information Exposure for different PLMNs | | 0.3.0 | +| 2023-03 | CT4#114 | C4-230656 | | | | Evaluation of Solutions | | 0.3.0 | +| 2023-03 | CT4#114 | C4-230518 | | | | List of Shareable Data Types | | 0.3.0 | +| 2023-03 | CT4#114 | C4-230521 | | | | Solution for NF Profile Change Notification to NFs in an NF Set | | 0.3.0 | +| 2023-03 | CT4#114 | C4-230657 | | | | New Solution on KI#2 of simplifying the NF service discovery response of inter-PLMN | | 0.3.0 | +| 2023-04 | CT4#115e | C4-231098 | | | | Update of Solution #6 | | 0.4.0 | +| 2023-04 | CT4#115e | C4-231365 | | | | Solution Evaluation for Key Issue #1 | | 0.4.0 | +| 2023-05 | CT4#116 | C4-232264 | | | | Solution Update for Solution #5 of FS_NRFe | | 0.5.0 | +| 2023-05 | CT4#116 | C4-232536 | | | | Solution Update for Solution #10 of FS_NRFe | | 0.5.0 | +| 2023-05 | CT4#116 | C4-232634 | | | | Evaluation for Key Issue #1 of FS_NRFe | | 0.5.0 | +| 2023-05 | CT4#116 | C4-232635 | | | | Solution Evaluation for Key Issue #1 of FS_NRFe | | 0.5.0 | +| 2023-06 | CT#100 | CP-231023 | | | | Presented for information | | 1.0.0 | +| 2023-09 | CT4#117 | C4-233046 | | | | Clean Up | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233122 | | | | Completing the Comparison Table for Key Issue #1 | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233272 | | | | Storage of RID ranges in UDR | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233374 | | | | New Solution for Key Issue #1 of FS_NRFe to support set level shared data | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233778 | | | | Conclusion for Key Issue #2 of FS_NRFe | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233847 | | | | Solution Evaluation for Key Issue #1 of FS_NRFe | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233878 | | | | Solution Evaluation for Key Issue #2 of FS_NRFe | | 1.1.0 | +| 2023-09 | CT4#117 | C4-233886 | | | | Conclusion for KI#1 | | 1.1.0 | +| 2023-09 | CT#101 | CP-232023 | | | | TR Presented for approval | | 2.0.0 | +| 2023-09 | CT#101 | | | | | TR Approved | | 18.0.0 | \ No newline at end of file diff --git a/gsma/37_series/37145-2/04c2b0e015697b9fd54da23916a850d6_img.jpg b/gsma/37_series/37145-2/04c2b0e015697b9fd54da23916a850d6_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a4af453837d84d399a7e0ccacdaf5fd8f03aca9c --- /dev/null +++ b/gsma/37_series/37145-2/04c2b0e015697b9fd54da23916a850d6_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:db43dfe5e431bd3ca986714b8ea687dcaaa2d18ab66310e0ee8a62c1188fa4bb +size 26574 diff --git a/gsma/37_series/37145-2/07b81106e8525814c458f262000c54a9_img.jpg b/gsma/37_series/37145-2/07b81106e8525814c458f262000c54a9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..be1e7235e18ea26f040331de7e1700079175a787 --- /dev/null +++ b/gsma/37_series/37145-2/07b81106e8525814c458f262000c54a9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c9ef0ff67e305192db1f3f2105adbf66dc86a04c5615d08daeb44c98bbfdb70b +size 21951 diff --git a/gsma/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg b/gsma/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8ecc655e26c927d0c0185369f291fac987422232 --- /dev/null +++ b/gsma/37_series/37145-2/09955ff8214ffb6947951fc0f60eb6ab_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0242c4d2e51b54075192df233a01e544d58cde981c16c56519212a1106ed85d1 +size 44836 diff --git a/gsma/37_series/37145-2/315bdbeafb39026e19b77c26b19d9d1f_img.jpg b/gsma/37_series/37145-2/315bdbeafb39026e19b77c26b19d9d1f_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fff8aa9430035577ec3297e17b87c98b7e34e094 --- /dev/null +++ b/gsma/37_series/37145-2/315bdbeafb39026e19b77c26b19d9d1f_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c892d52c065247b715455eeab9e1472ad7b57e3fd58feef9085d56b4a4c5bfc +size 47637 diff --git a/gsma/37_series/37145-2/36cc7cc6626dc09bfcc888a4f8e2e9e4_img.jpg b/gsma/37_series/37145-2/36cc7cc6626dc09bfcc888a4f8e2e9e4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..187fd4cc502ca5aa33679a22f6a601ad994b3bdc --- /dev/null +++ b/gsma/37_series/37145-2/36cc7cc6626dc09bfcc888a4f8e2e9e4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8547b013d6cbdccb1ed0e47b413dff76a745587561b0d51ad4cd9b767b5e4384 +size 71576 diff --git a/gsma/37_series/37145-2/3c8ed97dd81b363f7919bb50f8410baa_img.jpg b/gsma/37_series/37145-2/3c8ed97dd81b363f7919bb50f8410baa_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..390c0dc7821780de144fccbaf8e1f579b53643e2 --- /dev/null +++ b/gsma/37_series/37145-2/3c8ed97dd81b363f7919bb50f8410baa_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0da76a37b80833fdd200e204ed5e9bf8e114dd897327f53f4a753f0a7bc89ca7 +size 44991 diff --git a/gsma/37_series/37145-2/51923f79574a4c945d05c5ad3ff8dda5_img.jpg b/gsma/37_series/37145-2/51923f79574a4c945d05c5ad3ff8dda5_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..00d0eb1acc8ab69e1e158780db7a26992e16be83 --- /dev/null +++ b/gsma/37_series/37145-2/51923f79574a4c945d05c5ad3ff8dda5_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7498d9329ced800555cad56a6d8d43ec36ad9cd987d80957f5f2bcee9f790642 +size 28571 diff --git a/gsma/37_series/37145-2/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/gsma/37_series/37145-2/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8bfa19a3924bea77884784716fed1fab2bd789ec --- /dev/null +++ b/gsma/37_series/37145-2/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a42531e878a9547fcce2d08f472ff3e0a57fff4cfba77c3b6ab40618e0f96ab +size 9575 diff --git a/gsma/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg b/gsma/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..dd76f74980f10f14e616759707026262c63ab84e --- /dev/null +++ b/gsma/37_series/37145-2/71440aab73c3d21521dba3a413e3a7ca_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6b17dc87a9d3f6933b3e8a82ed2b46a041631973b52071030b29ae9a8c6e9823 +size 49299 diff --git a/gsma/37_series/37145-2/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg b/gsma/37_series/37145-2/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0c0e476d0fd09dbee66bb1e1eb9149fbf9db622b --- /dev/null +++ b/gsma/37_series/37145-2/78ff716475b2f65bf01c3a4d02d89fc4_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bf33209ca4e7b86b5c34294316ac63e4e9960aae0b4662bebf616d6cd139e0fe +size 59834 diff --git a/gsma/37_series/37145-2/854a7aa42ede8d319880a076c262338e_img.jpg b/gsma/37_series/37145-2/854a7aa42ede8d319880a076c262338e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4607e9246e571e4e4b84fa326af4241fd71f3ca8 --- /dev/null +++ b/gsma/37_series/37145-2/854a7aa42ede8d319880a076c262338e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:02be06b6bcedf588daee2505ecba1d3be68d33a4016c2a4141e9027e1745e46d +size 23631 diff --git a/gsma/37_series/37145-2/87661c01f79c13b3ea49e7d3e9782c48_img.jpg b/gsma/37_series/37145-2/87661c01f79c13b3ea49e7d3e9782c48_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a30eea1e708e712d59335fc7cffa8037fe025db6 --- /dev/null +++ b/gsma/37_series/37145-2/87661c01f79c13b3ea49e7d3e9782c48_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3d57e5c994825d57bf40412ef8bd5435ee73bb2b0d17dfd48d236ec35eaf2e5d +size 70204 diff --git a/gsma/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg b/gsma/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71c7b09fdebdbc95050278cf077425c4f13fc0a8 --- /dev/null +++ b/gsma/37_series/37145-2/8b6f7b51bc160aa80e286e818baa7998_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:903b934bf4d0bdf36913e9c2ce146ef4e0c760cfe26f675a397120fa2e1e7072 +size 89022 diff --git a/gsma/37_series/37145-2/8be5d9cba2614c3e06e06525a14c5a3b_img.jpg b/gsma/37_series/37145-2/8be5d9cba2614c3e06e06525a14c5a3b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..5ef4bfbc5aa9444274eab1de72297772cb2797ed --- /dev/null +++ b/gsma/37_series/37145-2/8be5d9cba2614c3e06e06525a14c5a3b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6a62a2e5f57d9d222455a4df6a7b486299f3678d6643af485becde3669c0e297 +size 76320 diff --git a/gsma/37_series/37145-2/8bffff22941e018add90bd8d04b6798c_img.jpg b/gsma/37_series/37145-2/8bffff22941e018add90bd8d04b6798c_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6f7d4380afec69adc61e3cf50fd71e0a8653a5ef --- /dev/null +++ b/gsma/37_series/37145-2/8bffff22941e018add90bd8d04b6798c_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e334063c83140384fe32c878198a86c6a5023540103604c4a7a9a918e25a1b1a +size 75908 diff --git a/gsma/37_series/37145-2/acb90ab4b1096f13fbf453251ca3ffd2_img.jpg b/gsma/37_series/37145-2/acb90ab4b1096f13fbf453251ca3ffd2_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..749946e9c9b70f0e4e21d0ba695f839b20255328 --- /dev/null +++ b/gsma/37_series/37145-2/acb90ab4b1096f13fbf453251ca3ffd2_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8684ed1962819315e4ece6a1971d45fa24059e5bf92c182d1715246a638227b2 +size 77706 diff --git a/gsma/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg b/gsma/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fdb6606b7bde7b42c86bc15effeb1133ee2fbc8a --- /dev/null +++ b/gsma/37_series/37145-2/b664da64b7121b86310de02c98642405_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:075ab62b9135a775d5ba0156e7ac016a138c258bcf84d521f22eb92d82af36a3 +size 80824 diff --git a/gsma/37_series/37145-2/b81d1613e285a9353171cdc5ef97a1f0_img.jpg b/gsma/37_series/37145-2/b81d1613e285a9353171cdc5ef97a1f0_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ef06b9715f095464f650ea98352e4e4f28c35e8 --- /dev/null +++ b/gsma/37_series/37145-2/b81d1613e285a9353171cdc5ef97a1f0_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f39656ad2511540903c1e615e9ed41a8c4add365209692af9e4500f7a430761 +size 41510 diff --git a/gsma/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg b/gsma/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..89b859a0f70069f4e8b305567ea5c43c90fb02c0 --- /dev/null +++ b/gsma/37_series/37145-2/c0e1c8d37f9cd96595cb6370b1b5a8c7_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f9b57cd175b7cbfb5af9641f8b6dad37a3bbdb847e0b2afcd38d749e3fa73a94 +size 73930 diff --git a/gsma/37_series/37145-2/dc5554f3d97c390f2e7467a86598b98e_img.jpg b/gsma/37_series/37145-2/dc5554f3d97c390f2e7467a86598b98e_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..4612bf5f2fc784b5128e41a4f1cbdc3591b9f2b6 --- /dev/null +++ b/gsma/37_series/37145-2/dc5554f3d97c390f2e7467a86598b98e_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:36592ec741d39dacbeb45ebf3dad56a5f0d12a050df39a2c02231c28e167196a +size 71112 diff --git a/gsma/37_series/37145-2/e9baf350bd23410e8a6df8dc5c68c16b_img.jpg b/gsma/37_series/37145-2/e9baf350bd23410e8a6df8dc5c68c16b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2ee92b383ef3de4408b265b2917f3e6452a588f3 --- /dev/null +++ b/gsma/37_series/37145-2/e9baf350bd23410e8a6df8dc5c68c16b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f523b45c1d74368eb37abcb8fa9fbcc61822685eee3fcd31696be093949112a8 +size 21359 diff --git a/gsma/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg b/gsma/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d99b87c91f1de40ce08a23b46bd3bef7c5a40ca0 --- /dev/null +++ b/gsma/37_series/37145-2/eb03559a4d92ea9ebd63ea9be663c50a_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7ed8fa7c9b275b45a00686a8d871a3503af1e53eb7b8f0c407519174ec6805c7 +size 60520 diff --git a/gsma/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg b/gsma/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..763f0f50a4e8245a2241f5ea112ff404690d49e3 --- /dev/null +++ b/gsma/37_series/37145-2/eb450c92214e8409c1e0f0846e30d876_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa785b3518171b563fbabfd86117b5293686ba2841065d484e785653deb77c0e +size 46325 diff --git a/gsma/37_series/37145-2/ef0ac4e673da0e46509a5c1eccc68c34_img.jpg b/gsma/37_series/37145-2/ef0ac4e673da0e46509a5c1eccc68c34_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ff70db164f87c49ed72c0250df56911e4c0917d1 --- /dev/null +++ b/gsma/37_series/37145-2/ef0ac4e673da0e46509a5c1eccc68c34_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c94d9a2c5059e378d63d63025be5c231fe3238870e429f7db234c6bac87de509 +size 57800 diff --git a/gsma/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg b/gsma/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..55f99daeab42d83b893950be9a24b6bf43e913c1 --- /dev/null +++ b/gsma/37_series/37145-2/fcc757566216206ceddbd6c775e8db02_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:81919c02cd2dbc02b1f37493ef8701159c1597bc2f5c1e18d3032637d05615bf +size 57552 diff --git a/gsma/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg b/gsma/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c606610cbdc8c5ef6b11fac4f0eb35dc9fdf361 --- /dev/null +++ b/gsma/37_series/37145-2/febfdd6a7182116484c126105b53fdaf_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5a10cb58a658356d306c610d9d089d47fe2b8d02e92f67db0c1a2cc73125701 +size 82965 diff --git a/gsma/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/gsma/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..7c96de11c2e607cb141727c7a695baee984487f0 --- /dev/null +++ b/gsma/37_series/37213/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d804e3b74a3eb21d99f5733a7e0652936b16309f2924a96ae56ad800408879a +size 9635 diff --git a/gsma/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg b/gsma/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0ad8a42d305eb60ae0eae79213fe27530a56f816 --- /dev/null +++ b/gsma/37_series/37213/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71b955a746a3029595390f481df96d57e030c236f73a499985b542a63c61430f +size 7171 diff --git a/gsma/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg b/gsma/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..bc2dbe00b246a30ef9703ca2a9cccd16a90ea06f --- /dev/null +++ b/gsma/37_series/37480/5e92d9e8e9ce204e405bff2367f88176_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25176f7e0d8e54371246869d9f270587ddcccf5ab9da16e96a04ac49a65c5622 +size 22147 diff --git a/gsma/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/gsma/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..917c8de2f1986e8b73026afb0f29c045a2e899b6 --- /dev/null +++ b/gsma/37_series/37480/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2be5b5f8dc82b0ea46ce50f842a11e07152f697d75bb810f05723033b786ecfa +size 9581 diff --git a/gsma/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg b/gsma/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0d413d15cf046d46ac9b31cb3f5865ccc79639cb --- /dev/null +++ b/gsma/37_series/37480/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe03788647836c455985efd56c7805682d17e6975c29327d2fd6939a118f306e +size 8100 diff --git a/gsma/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/gsma/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..623b362cd02782b508a807030a378c0f620b9781 --- /dev/null +++ b/gsma/37_series/37877/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:317a36aa8274171a8ae2e15d647a9a2bcb36cb49fc408ed3c964eeae7d1a83af +size 9335 diff --git a/gsma/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg b/gsma/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..36c0b88af2dfdd519eab63f5dd43aee5eb8cef3c --- /dev/null +++ b/gsma/37_series/37877/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99a64ea3b7d5fbafbc4f7b6a07b346fa3ecc07479ea08dc72e5cc6da2a4aa3ca +size 5690 diff --git a/gsma/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg b/gsma/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ab63acb2ed4f50412ba51bdf756acb9daf8de042 --- /dev/null +++ b/gsma/37_series/37878/5fb340ad68b0c71df0b56698b137e35b_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:55fa5eecc6566f0f7f11bf9bf30066970efc60dca8652960fe5841000fa6ff5e +size 10046 diff --git a/gsma/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg b/gsma/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg new file mode 100644 index 0000000000000000000000000000000000000000..965ead69cef12ba2d673705207be944ccbc76ea3 --- /dev/null +++ b/gsma/37_series/37878/64662465bba247703fdec49c8f3309f9_img.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:87026c58388ccc3d09dd7e519808db9ff59a6e8274f091363cf84f74d5584f58 +size 5678 diff --git a/original/22261-ic0.docx b/original/22261-ic0.docx new file mode 100644 index 0000000000000000000000000000000000000000..8e908214777b11bb284eca6632ca198f20e5c677 --- /dev/null +++ b/original/22261-ic0.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4c6f6694b5dc4816afe99ef532b19b394590bafe8e0a91e6ad96af8e841fd4c1 +size 1302519 diff --git a/original/23288-i40.docx b/original/23288-i40.docx new file mode 100644 index 0000000000000000000000000000000000000000..4215044c6719f8518354277cadc8bbe3b80d429b --- /dev/null +++ b/original/23288-i40.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d776b7294d85a40e79e382226e0eed1f28e41b33c7f4b265a57f5bf38910c7d1 +size 6805536 diff --git a/original/23436-i20.docx b/original/23436-i20.docx new file mode 100644 index 0000000000000000000000000000000000000000..cbff71c165db3555d11f9b784b4a42d0a7d72935 --- /dev/null +++ b/original/23436-i20.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aeaf712e22e03eac875a5fada827c2053d62c703e5600a9f42f3c6e604b2d972 +size 898720 diff --git a/original/23700-97-i10.docx b/original/23700-97-i10.docx new file mode 100644 index 0000000000000000000000000000000000000000..faed419d94ea07c21557f8df9db74a221b79b57b --- /dev/null +++ b/original/23700-97-i10.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9ab90ed189f4ee32fb50f5192da1504392e5a02c44363cc2140528061fc7c0e0 +size 739349 diff --git a/original/24257-i20.docx b/original/24257-i20.docx new file mode 100644 index 0000000000000000000000000000000000000000..9275cc7b55409f6dcae26a314c56d60bdbf98e64 --- /dev/null +++ b/original/24257-i20.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3ad4885477c25a0f84fd2f74e4ed7940eb0fa316ab156aae71fa1816b862fd1f +size 110272 diff --git a/original/29558-i40.docx b/original/29558-i40.docx new file mode 100644 index 0000000000000000000000000000000000000000..10c72ea7b6dd9d62c89df6f590a0b2b496225a1b --- /dev/null +++ b/original/29558-i40.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0727b79210c994febe02ca3c13c7d23c6e4e530908f8004344a737cacb34871a +size 935672 diff --git a/original/33898-i01.docx b/original/33898-i01.docx new file mode 100644 index 0000000000000000000000000000000000000000..fef623c2b79102e71e52ba1f45bf0c682c40e9f5 --- /dev/null +++ b/original/33898-i01.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c5d48177e3b47eff05eca028291f9012c902e47c3cd165e12a86e8229efaddd +size 175880 diff --git a/original/36304-i00.docx b/original/36304-i00.docx new file mode 100644 index 0000000000000000000000000000000000000000..ff76412d3aeb3a551382b779a3a1155dd8025ba3 --- /dev/null +++ b/original/36304-i00.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e463ba32a20ed03812c1c5c51166127e1908d2dc4b10b073c8e20dcaedd759a +size 361433 diff --git a/original/36305-i00.docx b/original/36305-i00.docx new file mode 100644 index 0000000000000000000000000000000000000000..4dfbed0c3dfe6e5a158a66a24be2a74799cae6ac --- /dev/null +++ b/original/36305-i00.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de9cd0b1f3b5ed47327fe86d321e96cf68e1863b4444ccb0113cdd42928909b4 +size 1929380 diff --git a/original/38101-5-i40.docx b/original/38101-5-i40.docx new file mode 100644 index 0000000000000000000000000000000000000000..e47722cf3b2b25e9af52ff2d2437d4ada505b2c1 --- /dev/null +++ b/original/38101-5-i40.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e2b172c2db445bb052c2dc2049121505a74b99aebc92a060a9ab619c3c3bf22 +size 366444 diff --git a/original/38741-i00.docx b/original/38741-i00.docx new file mode 100644 index 0000000000000000000000000000000000000000..21e0f170b9e5120e58c36dc47dc86bdd7986e334 --- /dev/null +++ b/original/38741-i00.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de6256fcfc82e6bcaebd7fbe80218d336da3ba1c985f21b24936490eab92a612 +size 3341354 diff --git a/original/38865-i00.docx b/original/38865-i00.docx new file mode 100644 index 0000000000000000000000000000000000000000..6948cc6b07a74b05289f55777f9d461ba22327e1 --- /dev/null +++ b/original/38865-i00.docx @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3404a3255d4f85ebe79f4d26a4fde054f260baab242558ebcd7ec7b901cc411f +size 242914